Skip to content
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

chore(backend): Expose AuthObject type #3844

Conversation

kduprey
Copy link
Contributor

@kduprey kduprey commented Jul 30, 2024

Description

This PR moves the AuthObjectDebugData, AuthObjectDebug, SignedInAuthObject, SignedOutAuthObject, and AuthObject type definitions in favour of exporting from @clerk/types. This is to enable clients to easily access this object type across our JavaScript SDKs.

https://linear.app/clerk/issue/SDK-1894/export-authobject-as-requested-by-client-in-clerktypes-package

Checklist

  • npm test runs as expected.
  • npm run 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:

Copy link

changeset-bot bot commented Jul 30, 2024

🦋 Changeset detected

Latest commit: 91995d6

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

This PR includes changesets to release 9 packages
Name Type
@clerk/backend Patch
@clerk/clerk-sdk-node Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/nextjs Patch
@clerk/astro Patch
@clerk/remix Patch
@clerk/tanstack-start Patch
@clerk/testing Patch

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

@kduprey kduprey requested a review from LekoArts July 31, 2024 14:29
@clerk-cookie clerk-cookie removed the types label Aug 6, 2024
Copy link
Member

@LekoArts LekoArts left a comment

Choose a reason for hiding this comment

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

image

@LekoArts LekoArts changed the title feat(types): Migrate AuthObject type from backend to types chore(backend): Expose AuthObject type Aug 6, 2024
@LekoArts LekoArts enabled auto-merge (squash) August 6, 2024 09:23
Copy link
Contributor

@dimkl dimkl left a comment

Choose a reason for hiding this comment

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

☁️ I think that this kind of change should be a minor since we are adding a new export.

SignedOutAuthObject,
AuthObject,
} from './tokens/authObjects';
export type { SignedInAuthObjectOptions, SignedInAuthObject, SignedOutAuthObject } from './tokens/authObjects';
Copy link
Contributor

Choose a reason for hiding this comment

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

🔧 This change will break existing application importing from /internal. Even though they should not use it, should we keep it and add a deprecation warning to remove it later?
cc: @nikosdouvlis

@LekoArts LekoArts merged commit d7bf0f8 into main Aug 6, 2024
19 checks passed
@LekoArts LekoArts deleted the kenton/sdk-1894-export-authobject-as-requested-by-client-in-clerktypes branch August 6, 2024 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants