Skip to content

refactor(api)!: rename accountAlias option to connectionName#1

Merged
BlackHole1 merged 1 commit into
mainfrom
rename
Jun 16, 2026
Merged

refactor(api)!: rename accountAlias option to connectionName#1
BlackHole1 merged 1 commit into
mainfrom
rename

Conversation

@BlackHole1

Copy link
Copy Markdown
Member

Rename the public accountAlias option to connectionName to better reflect that it selects a named connection, aligning the SDK surface with the product's terminology.

The wire protocol is intentionally untouched: the outgoing header x-oo-connector-alias, the gateway response field alias, and the connection_alias_conflict error code all stay the same, so this is a pure SDK-surface rename with no behavioral change.

camelCase is used to stay consistent with the other option fields (apiKey, baseUrl, organization).

BREAKING CHANGE: the accountAlias field on ClientConfig, CallOptions, ScopeOptions, and ConnectedApp is renamed to connectionName.

Rename the public `accountAlias` option to `connectionName` to better
reflect that it selects a named connection, aligning the SDK surface
with the product's terminology.

The wire protocol is intentionally untouched: the outgoing header
`x-oo-connector-alias`, the gateway response field `alias`, and the
`connection_alias_conflict` error code all stay the same, so this is
a pure SDK-surface rename with no behavioral change.

camelCase is used to stay consistent with the other option fields
(`apiKey`, `baseUrl`, `organization`).

BREAKING CHANGE: the `accountAlias` field on ClientConfig, CallOptions,
ScopeOptions, and ConnectedApp is renamed to `connectionName`.

Signed-off-by: Kevin Cui <bh@bugs.cc>
@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b08f1bd1-9c26-499e-8060-31141e9a9b4e

📥 Commits

Reviewing files that changed from the base of the PR and between 846d6a3 and c86b377.

📒 Files selected for processing (11)
  • README.md
  • examples/README.md
  • examples/apps.ts
  • examples/scoping-and-options.ts
  • fixtures/consumer/no-b/index.test-d.ts
  • fixtures/resolution/consumer.ts
  • src/connector.ts
  • src/types.ts
  • test/apps.test.ts
  • test/proxy-catalog.test.ts
  • test/selectors.test.ts

Summary by CodeRabbit

  • Breaking Changes

    • Renamed the connector-alias field from accountAlias to connectionName across configuration options, per-call options, and connected app identifiers. Update existing code to use the new field name.
  • Documentation

    • Updated documentation and examples to reflect the new field naming convention.

Walkthrough

The pull request renames the connection-selector field accountAlias to connectionName uniformly across the SDK. Public interfaces ClientConfig, CallOptions, ScopeOptions, and ConnectedApp in src/types.ts are updated. src/connector.ts updates the internal resolved config shapes, the #resolveCall precedence chain, the #buildSpec header mapping (the x-oo-connector-alias gateway header key itself is unchanged), using() scope merging, #sourceConfig cloning, and the apps.list() field mapping. Tests in selectors.test.ts, proxy-catalog.test.ts, and apps.test.ts plus type-level fixtures are updated to match. Example files and both README.md documents are revised accordingly.

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title follows the required format with type and scope, clearly summarizing the main change of renaming accountAlias to connectionName.
Description check ✅ Passed The description is directly related to the changeset, explaining the rationale for the rename and outlining the breaking change impact.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch rename

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown

Caution

Failed to replace (edit) comment. This is likely due to insufficient permissions or the comment being deleted.

Error details
{"name":"HttpError","status":500,"request":{"method":"PATCH","url":"https://api.github.com/repos/oomol-lab/connector-sdk/issues/comments/4716192887","headers":{"accept":"application/vnd.github.v3+json","user-agent":"octokit.js/0.0.0-development octokit-core.js/7.0.6 Node.js/24","authorization":"token [REDACTED]","content-type":"application/json; charset=utf-8"},"body":{"body":"<!-- This is an auto-generated comment: summarize by coderabbit.ai -->\n<!-- review_stack_entry_start -->\n\n[![Review Change Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/oomol-lab/connector-sdk/pull/1?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack)\n\n<!-- review_stack_entry_end -->\n<!-- This is an auto-generated comment: review in progress by coderabbit.ai -->\n\n> [!NOTE]\n> Currently processing new changes in this PR. This may take a few minutes, please wait...\n> \n> <details>\n> <summary>⚙️ Run configuration</summary>\n> \n> **Configuration used**: Organization UI\n> \n> **Review profile**: CHILL\n> \n> **Plan**: Pro\n> \n> **Run ID**: `b08f1bd1-9c26-499e-8060-31141e9a9b4e`\n> \n> </details>\n> \n> <details>\n> <summary>📥 Commits</summary>\n> \n> Reviewing files that changed from the base of the PR and between 846d6a3c4ce656f119a23f2b20581d153de3bcb7 and c86b377bf2ab51acc7ca115d3a43a3a923045bc9.\n> \n> </details>\n> \n> <details>\n> <summary>📒 Files selected for processing (11)</summary>\n> \n> * `README.md`\n> * `examples/README.md`\n> * `examples/apps.ts`\n> * `examples/scoping-and-options.ts`\n> * `fixtures/consumer/no-b/index.test-d.ts`\n> * `fixtures/resolution/consumer.ts`\n> * `src/connector.ts`\n> * `src/types.ts`\n> * `test/apps.test.ts`\n> * `test/proxy-catalog.test.ts`\n> * `test/selectors.test.ts`\n> \n> </details>\n> \n> \n\n<!-- end of auto-generated comment: review in progress by coderabbit.ai -->\n\n<!-- finishing_touch_checkbox_start -->\n\n<details>\n<summary>✨ Finishing Touches</summary>\n\n<details>\n<summary>✨ Simplify code</summary>\n\n- [ ] <!-- {\"checkboxId\": \"f120d606-b0e2-4b7d-8316-181794555b43\", \"radioGroupId\": \"simplify-output-choice-group-unknown_comment_id\"} -->   Create PR with simplified code\n- [ ] <!-- {\"checkboxId\": \"9a4e3077-58f6-4eba-b7ee-62e936ea00ea\", \"radioGroupId\": \"simplify-output-choice-group-unknown_comment_id\"} -->   Commit simplified code in branch `rename`\n\n</details>\n\n</details>\n\n<!-- finishing_touch_checkbox_end -->\n<!-- tips_start -->\n\n---\n\n\n\n\n<sub>Comment `@coderabbitai help` to get the list of available commands and usage tips.</sub>\n\n<!-- tips_end -->"},"request":{"retryCount":3,"signal":{},"retries":3,"retryAfter":16}}}

@BlackHole1 BlackHole1 merged commit 859a832 into main Jun 16, 2026
1 of 2 checks passed
@BlackHole1 BlackHole1 deleted the rename branch June 16, 2026 07:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant