Skip to content

feat(backend): Generated Backend API Client #5530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

tmilewski
Copy link
Member

Description

In an effort to spit out many of the changes in other PRs, etc. This PR contains the (largely) generated version of the Backend API Client.

It will have no effect over existing packages/builds/etc.

As-is, it is intentionally excluded from PNPM Workspaces and isn't referenced by any other packages. This will be added back in in subsequent PRs as it makes sense.

This is simply to make follow-on updates/reviews/etc easier in the future.

ECO-558

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@tmilewski tmilewski requested review from a team April 3, 2025 21:29
@tmilewski tmilewski self-assigned this Apr 3, 2025
Copy link

changeset-bot bot commented Apr 3, 2025

🦋 Changeset detected

Latest commit: 19fa67d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Apr 3, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
clerk-js-sandbox ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 4, 2025 3:45pm

@@ -116,6 +116,7 @@ export default tseslint.config([
'vitest.workspace.mjs',
// package specific ignores
'packages/astro/src/astro-components/**/*.ts',
'packages/backend-api-client/**/*',
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Intentionally excluded from Prettier and ESLint as the code is generated and makes future reviews impossible.

}
}

export class AfterError implements AfterErrorHook {
Copy link
Member Author

@tmilewski tmilewski Apr 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Custom BeforeRequest and AfterError hooks to customized request headers and error responses.


return {
...remappedObj,
get primaryEmailAddress() {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Custom getters to better align with our existing API resources

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This specific file has been ignored during generation. We'll need to keep this in mind when regenerating in the future.

@@ -1,5 +1,6 @@
packages:
- 'packages/*'
- '!packages/backend-api-client'
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Omit from PNPM Workspace (for the time being)

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