feat(sdks): Add sdkMetadata to Clerk singleton, populate it for each SDK #1857
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
馃 Changeset detectedLatest commit: e5fedd6 The changes in this PR will be included in the next version bump. This PR includes changesets to release 12 packages
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 |
clerk-cookie
added
types
nextjs
react
remix
fastify
expo
chrome-extension
gatsby
labels
BRKalow
commented
Oct 11, 2023
| @@ -198,6 +198,8 @@ export default class IsomorphicClerk { | |||
| await global.Clerk.load(this.options); | |||
| } | |||
|
|
|||
| global.Clerk.sdkMetadata = this.options.sdkMetadata ?? { name: PACKAGE_NAME, version: PACKAGE_VERSION }; | |||
There was a problem hiding this comment.
For SDKs that use ClerkProvider, this is how we are passing through and setting the metadata. SDKs that access Clerk directly assign it themselves.
BRKalow
commented
Oct 11, 2023
LekoArts
reviewed
Oct 11, 2023
| "build": "tsup", | ||
| "dev": "tsup --watch", | ||
| "dev:publish": "npm run dev -- --env.publish", | ||
| "build:declarations": "tsc -p tsconfig.declarations.json", |
There was a problem hiding this comment.
I know that we do this in the other packages but IMO we should just use tsup to also output the types and not use TSC
But that can happen in another PR
LekoArts
reviewed
Oct 11, 2023
| "compilerOptions": { | ||
| "outDir": "dist", |
There was a problem hiding this comment.
We should extend this from a root/base tsconfig.json
But that's for another PR
LekoArts
approved these changes
Oct 11, 2023
dimkl
reviewed
Oct 11, 2023
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds a new static property to the Clerk singleton,
sdkMetadata, and populates it for each host SDK. We'll use this data to make it easier to understand what host SDK is initializingClerk.As part of adding this to each SDK, I also introduced
tsupto the remaining packages that weren't already using it. This allows us to define thePACKAGE_NAMEandPACKAGE_VERSIONconstants at build time:remixgatsby-plugin-clerkexpoNote that there's definitely an opportunity to consolidate some of our package tooling, but I'm deferring that work for now.
Checklist
npm testruns as expected.npm run buildruns as expected.Type of change
Packages affected
@clerk/clerk-js@clerk/clerk-react@clerk/nextjs@clerk/remix@clerk/types@clerk/themes@clerk/localizations@clerk/clerk-expo@clerk/backend@clerk/clerk-sdk-node@clerk/shared@clerk/fastify@clerk/chrome-extensiongatsby-plugin-clerkbuild/tooling/chore