Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .changeset/nasty-ties-invite.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'gatsby-plugin-clerk': patch
'@clerk/clerk-js': patch
'@clerk/chrome-extension': patch
'@clerk/fastify': patch
'@clerk/nextjs': patch
'@clerk/clerk-react': patch
'@clerk/remix': patch
'@clerk/types': patch
'@clerk/clerk-expo': patch
---

Introduce a new property on the core Clerk singleton, `sdkMetadata`. This will be populated by each host SDK. This metadata will be used to make logging and debugging easier.
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ yarn-error.log
testem.log
/typings
**/coverage/**
*.tsbuildinfo

# System Files
.DS_Store
Expand Down
9 changes: 9 additions & 0 deletions packages/chrome-extension/jest.config.js
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { name, version } = require('./package.json');

module.exports = {
displayName: 'clerk-js',
injectGlobals: true,
Expand All@@ -13,4 +16,10 @@ module.exports = {

testRegex: ['/src/.*.test.[jt]sx?$'],
testPathIgnorePatterns: ['/node_modules/'],

globals: {
__DEV__: true,
PACKAGE_NAME: name,
PACKAGE_VERSION: version,
},
};
5 changes: 5 additions & 0 deletions packages/chrome-extension/src/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import type { TokenCache } from './cache';
import { ChromeStorageCache } from './cache';
import { buildClerk } from './singleton';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({
packageName: '@clerk/chrome-extension',
});
Expand Down
7 changes: 7 additions & 0 deletions packages/chrome-extension/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
const __DEV__: boolean;
}
7 changes: 7 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import type {
PublishableKey,
RedirectOptions,
Resources,
SDKMetadata,
SetActiveParams,
SignInProps,
SignInRedirectOptions,
Expand DownExpand Up@@ -144,7 +145,13 @@ const defaultOptions: ClerkOptions = {

export default class Clerk implements ClerkInterface {
public static mountComponentRenderer?: MountComponentRenderer;

public static version: string = __PKG_VERSION__;
public static sdkMetadata: SDKMetadata = {
name: __PKG_NAME__,
version: __PKG_VERSION__,
};

public client?: ClientResource;
public session?: ActiveSessionResource | null;
public organization?: OrganizationResource | null;
Expand Down
7 changes: 5 additions & 2 deletions packages/expo/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,11 @@
"dist"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/expo/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
5 changes: 5 additions & 0 deletions packages/expo/src/singleton.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,11 @@ import type { HeadlessBrowserClerk } from '@clerk/clerk-react';

import type { TokenCache } from './cache';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

const KEY = '__clerk_client_jwt';

export let clerk: HeadlessBrowserClerk;
Expand Down
22 changes: 0 additions & 22 deletions packages/expo/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/expo/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/expo/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should extend this from a root/base tsconfig.json

But that's for another PR

"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/expo/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
7 changes: 7 additions & 0 deletions packages/fastify/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import { defineConfig } from 'tsup';

import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isProd = overrideOptions.env?.NODE_ENV === 'production';

Expand All@@ -11,5 +13,10 @@ export default defineConfig(overrideOptions => {
sourcemap: true,
format: ['cjs', 'esm'],
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
__DEV__: `${!isProd}`,
},
};
});
7 changes: 5 additions & 2 deletions packages/gatsby-plugin-clerk/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,11 @@
"api.d.ts"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",
"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/GatsbyClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import {
import { navigate } from 'gatsby';
import React from 'react';

const SDK_METADATA = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({ packageName: 'gatsby-plugin-clerk' });

export type GatsbyClerkProviderProps = {
Expand All@@ -22,6 +27,7 @@ export function ClerkProvider({ children, ...rest }: GatsbyClerkProviderProps) {
<ReactClerkProvider
navigate={to => navigate(to)}
initialState={__clerk_ssr_state || {}}
sdkMetadata={SDK_METADATA}
{...restProps}
>
{__clerk_ssr_interstitial_html ? (
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
26 changes: 0 additions & 26 deletions packages/gatsby-plugin-clerk/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/gatsby-plugin-clerk/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/gatsby-plugin-clerk/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",
"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/gatsby-plugin-clerk/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
3 changes: 3 additions & 0 deletions packages/nextjs/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ declare global {
}

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;

namespace NodeJS {
interface ProcessEnv {
NEXT_PUBLIC_CLERK_FRONTEND_API: string | undefined;
Expand Down
4 changes: 4 additions & 0 deletions packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,5 +15,9 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
afterSignUpUrl: props.afterSignUpUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL || '',
sdkMetadata: {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
},
};
};
2 changes: 2 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

For SDKs that use ClerkProvider, this is how we are passing through and setting the metadata. SDKs that access Clerk directly assign it themselves.


if (global.Clerk?.loaded || global.Clerk?.isReady()) {
return this.hydrateClerkJS(global.Clerk);
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .changeset/nasty-ties-invite.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'gatsby-plugin-clerk': patch
'@clerk/clerk-js': patch
'@clerk/chrome-extension': patch
'@clerk/fastify': patch
'@clerk/nextjs': patch
'@clerk/clerk-react': patch
'@clerk/remix': patch
'@clerk/types': patch
'@clerk/clerk-expo': patch
---

Introduce a new property on the core Clerk singleton, `sdkMetadata`. This will be populated by each host SDK. This metadata will be used to make logging and debugging easier.
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ yarn-error.log
testem.log
/typings
**/coverage/**
*.tsbuildinfo

# System Files
.DS_Store
Expand Down
9 changes: 9 additions & 0 deletions packages/chrome-extension/jest.config.js
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { name, version } = require('./package.json');

module.exports = {
displayName: 'clerk-js',
injectGlobals: true,
Expand All@@ -13,4 +16,10 @@ module.exports = {

testRegex: ['/src/.*.test.[jt]sx?$'],
testPathIgnorePatterns: ['/node_modules/'],

globals: {
__DEV__: true,
PACKAGE_NAME: name,
PACKAGE_VERSION: version,
},
};
5 changes: 5 additions & 0 deletions packages/chrome-extension/src/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import type { TokenCache } from './cache';
import { ChromeStorageCache } from './cache';
import { buildClerk } from './singleton';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({
packageName: '@clerk/chrome-extension',
});
Expand Down
7 changes: 7 additions & 0 deletions packages/chrome-extension/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
const __DEV__: boolean;
}
7 changes: 7 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import type {
PublishableKey,
RedirectOptions,
Resources,
SDKMetadata,
SetActiveParams,
SignInProps,
SignInRedirectOptions,
Expand DownExpand Up@@ -144,7 +145,13 @@ const defaultOptions: ClerkOptions = {

export default class Clerk implements ClerkInterface {
public static mountComponentRenderer?: MountComponentRenderer;

public static version: string = __PKG_VERSION__;
public static sdkMetadata: SDKMetadata = {
name: __PKG_NAME__,
version: __PKG_VERSION__,
};

public client?: ClientResource;
public session?: ActiveSessionResource | null;
public organization?: OrganizationResource | null;
Expand Down
7 changes: 5 additions & 2 deletions packages/expo/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,11 @@
"dist"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/expo/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
5 changes: 5 additions & 0 deletions packages/expo/src/singleton.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,11 @@ import type { HeadlessBrowserClerk } from '@clerk/clerk-react';

import type { TokenCache } from './cache';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

const KEY = '__clerk_client_jwt';

export let clerk: HeadlessBrowserClerk;
Expand Down
22 changes: 0 additions & 22 deletions packages/expo/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/expo/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/expo/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should extend this from a root/base tsconfig.json

But that's for another PR

"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/expo/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
7 changes: 7 additions & 0 deletions packages/fastify/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import { defineConfig } from 'tsup';

import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isProd = overrideOptions.env?.NODE_ENV === 'production';

Expand All@@ -11,5 +13,10 @@ export default defineConfig(overrideOptions => {
sourcemap: true,
format: ['cjs', 'esm'],
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
__DEV__: `${!isProd}`,
},
};
});
7 changes: 5 additions & 2 deletions packages/gatsby-plugin-clerk/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,11 @@
"api.d.ts"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",
"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/GatsbyClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import {
import { navigate } from 'gatsby';
import React from 'react';

const SDK_METADATA = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({ packageName: 'gatsby-plugin-clerk' });

export type GatsbyClerkProviderProps = {
Expand All@@ -22,6 +27,7 @@ export function ClerkProvider({ children, ...rest }: GatsbyClerkProviderProps) {
<ReactClerkProvider
navigate={to => navigate(to)}
initialState={__clerk_ssr_state || {}}
sdkMetadata={SDK_METADATA}
{...restProps}
>
{__clerk_ssr_interstitial_html ? (
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
26 changes: 0 additions & 26 deletions packages/gatsby-plugin-clerk/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/gatsby-plugin-clerk/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/gatsby-plugin-clerk/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",
"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/gatsby-plugin-clerk/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
3 changes: 3 additions & 0 deletions packages/nextjs/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ declare global {
}

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;

namespace NodeJS {
interface ProcessEnv {
NEXT_PUBLIC_CLERK_FRONTEND_API: string | undefined;
Expand Down
4 changes: 4 additions & 0 deletions packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,5 +15,9 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
afterSignUpUrl: props.afterSignUpUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL || '',
sdkMetadata: {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
},
};
};
2 changes: 2 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

For SDKs that use ClerkProvider, this is how we are passing through and setting the metadata. SDKs that access Clerk directly assign it themselves.


if (global.Clerk?.loaded || global.Clerk?.isReady()) {
return this.hydrateClerkJS(global.Clerk);
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .changeset/nasty-ties-invite.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'gatsby-plugin-clerk': patch
'@clerk/clerk-js': patch
'@clerk/chrome-extension': patch
'@clerk/fastify': patch
'@clerk/nextjs': patch
'@clerk/clerk-react': patch
'@clerk/remix': patch
'@clerk/types': patch
'@clerk/clerk-expo': patch
---

Introduce a new property on the core Clerk singleton, `sdkMetadata`. This will be populated by each host SDK. This metadata will be used to make logging and debugging easier.
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ yarn-error.log
testem.log
/typings
**/coverage/**
*.tsbuildinfo

# System Files
.DS_Store
Expand Down
9 changes: 9 additions & 0 deletions packages/chrome-extension/jest.config.js
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { name, version } = require('./package.json');

module.exports = {
displayName: 'clerk-js',
injectGlobals: true,
Expand All@@ -13,4 +16,10 @@ module.exports = {

testRegex: ['/src/.*.test.[jt]sx?$'],
testPathIgnorePatterns: ['/node_modules/'],

globals: {
__DEV__: true,
PACKAGE_NAME: name,
PACKAGE_VERSION: version,
},
};
5 changes: 5 additions & 0 deletions packages/chrome-extension/src/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import type { TokenCache } from './cache';
import { ChromeStorageCache } from './cache';
import { buildClerk } from './singleton';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({
packageName: '@clerk/chrome-extension',
});
Expand Down
7 changes: 7 additions & 0 deletions packages/chrome-extension/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
const __DEV__: boolean;
}
7 changes: 7 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import type {
PublishableKey,
RedirectOptions,
Resources,
SDKMetadata,
SetActiveParams,
SignInProps,
SignInRedirectOptions,
Expand DownExpand Up@@ -144,7 +145,13 @@ const defaultOptions: ClerkOptions = {

export default class Clerk implements ClerkInterface {
public static mountComponentRenderer?: MountComponentRenderer;

public static version: string = __PKG_VERSION__;
public static sdkMetadata: SDKMetadata = {
name: __PKG_NAME__,
version: __PKG_VERSION__,
};

public client?: ClientResource;
public session?: ActiveSessionResource | null;
public organization?: OrganizationResource | null;
Expand Down
7 changes: 5 additions & 2 deletions packages/expo/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,11 @@
"dist"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/expo/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
5 changes: 5 additions & 0 deletions packages/expo/src/singleton.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,11 @@ import type { HeadlessBrowserClerk } from '@clerk/clerk-react';

import type { TokenCache } from './cache';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

const KEY = '__clerk_client_jwt';

export let clerk: HeadlessBrowserClerk;
Expand Down
22 changes: 0 additions & 22 deletions packages/expo/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/expo/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/expo/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should extend this from a root/base tsconfig.json

But that's for another PR

"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/expo/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
7 changes: 7 additions & 0 deletions packages/fastify/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import { defineConfig } from 'tsup';

import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isProd = overrideOptions.env?.NODE_ENV === 'production';

Expand All@@ -11,5 +13,10 @@ export default defineConfig(overrideOptions => {
sourcemap: true,
format: ['cjs', 'esm'],
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
__DEV__: `${!isProd}`,
},
};
});
7 changes: 5 additions & 2 deletions packages/gatsby-plugin-clerk/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,11 @@
"api.d.ts"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",
"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/GatsbyClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import {
import { navigate } from 'gatsby';
import React from 'react';

const SDK_METADATA = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({ packageName: 'gatsby-plugin-clerk' });

export type GatsbyClerkProviderProps = {
Expand All@@ -22,6 +27,7 @@ export function ClerkProvider({ children, ...rest }: GatsbyClerkProviderProps) {
<ReactClerkProvider
navigate={to => navigate(to)}
initialState={__clerk_ssr_state || {}}
sdkMetadata={SDK_METADATA}
{...restProps}
>
{__clerk_ssr_interstitial_html ? (
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
26 changes: 0 additions & 26 deletions packages/gatsby-plugin-clerk/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/gatsby-plugin-clerk/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/gatsby-plugin-clerk/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",
"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/gatsby-plugin-clerk/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
3 changes: 3 additions & 0 deletions packages/nextjs/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ declare global {
}

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;

namespace NodeJS {
interface ProcessEnv {
NEXT_PUBLIC_CLERK_FRONTEND_API: string | undefined;
Expand Down
4 changes: 4 additions & 0 deletions packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,5 +15,9 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
afterSignUpUrl: props.afterSignUpUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL || '',
sdkMetadata: {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
},
};
};
2 changes: 2 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

For SDKs that use ClerkProvider, this is how we are passing through and setting the metadata. SDKs that access Clerk directly assign it themselves.


if (global.Clerk?.loaded || global.Clerk?.isReady()) {
return this.hydrateClerkJS(global.Clerk);
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .changeset/nasty-ties-invite.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'gatsby-plugin-clerk': patch
'@clerk/clerk-js': patch
'@clerk/chrome-extension': patch
'@clerk/fastify': patch
'@clerk/nextjs': patch
'@clerk/clerk-react': patch
'@clerk/remix': patch
'@clerk/types': patch
'@clerk/clerk-expo': patch
---

Introduce a new property on the core Clerk singleton, `sdkMetadata`. This will be populated by each host SDK. This metadata will be used to make logging and debugging easier.
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ yarn-error.log
testem.log
/typings
**/coverage/**
*.tsbuildinfo

# System Files
.DS_Store
Expand Down
9 changes: 9 additions & 0 deletions packages/chrome-extension/jest.config.js
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { name, version } = require('./package.json');

module.exports = {
displayName: 'clerk-js',
injectGlobals: true,
Expand All@@ -13,4 +16,10 @@ module.exports = {

testRegex: ['/src/.*.test.[jt]sx?$'],
testPathIgnorePatterns: ['/node_modules/'],

globals: {
__DEV__: true,
PACKAGE_NAME: name,
PACKAGE_VERSION: version,
},
};
5 changes: 5 additions & 0 deletions packages/chrome-extension/src/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import type { TokenCache } from './cache';
import { ChromeStorageCache } from './cache';
import { buildClerk } from './singleton';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({
packageName: '@clerk/chrome-extension',
});
Expand Down
7 changes: 7 additions & 0 deletions packages/chrome-extension/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
const __DEV__: boolean;
}
7 changes: 7 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import type {
PublishableKey,
RedirectOptions,
Resources,
SDKMetadata,
SetActiveParams,
SignInProps,
SignInRedirectOptions,
Expand DownExpand Up@@ -144,7 +145,13 @@ const defaultOptions: ClerkOptions = {

export default class Clerk implements ClerkInterface {
public static mountComponentRenderer?: MountComponentRenderer;

public static version: string = __PKG_VERSION__;
public static sdkMetadata: SDKMetadata = {
name: __PKG_NAME__,
version: __PKG_VERSION__,
};

public client?: ClientResource;
public session?: ActiveSessionResource | null;
public organization?: OrganizationResource | null;
Expand Down
7 changes: 5 additions & 2 deletions packages/expo/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,11 @@
"dist"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/expo/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
5 changes: 5 additions & 0 deletions packages/expo/src/singleton.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,11 @@ import type { HeadlessBrowserClerk } from '@clerk/clerk-react';

import type { TokenCache } from './cache';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

const KEY = '__clerk_client_jwt';

export let clerk: HeadlessBrowserClerk;
Expand Down
22 changes: 0 additions & 22 deletions packages/expo/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/expo/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/expo/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should extend this from a root/base tsconfig.json

But that's for another PR

"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/expo/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
7 changes: 7 additions & 0 deletions packages/fastify/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import { defineConfig } from 'tsup';

import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isProd = overrideOptions.env?.NODE_ENV === 'production';

Expand All@@ -11,5 +13,10 @@ export default defineConfig(overrideOptions => {
sourcemap: true,
format: ['cjs', 'esm'],
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
__DEV__: `${!isProd}`,
},
};
});
7 changes: 5 additions & 2 deletions packages/gatsby-plugin-clerk/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,11 @@
"api.d.ts"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",
"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/GatsbyClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import {
import { navigate } from 'gatsby';
import React from 'react';

const SDK_METADATA = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({ packageName: 'gatsby-plugin-clerk' });

export type GatsbyClerkProviderProps = {
Expand All@@ -22,6 +27,7 @@ export function ClerkProvider({ children, ...rest }: GatsbyClerkProviderProps) {
<ReactClerkProvider
navigate={to => navigate(to)}
initialState={__clerk_ssr_state || {}}
sdkMetadata={SDK_METADATA}
{...restProps}
>
{__clerk_ssr_interstitial_html ? (
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
26 changes: 0 additions & 26 deletions packages/gatsby-plugin-clerk/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/gatsby-plugin-clerk/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/gatsby-plugin-clerk/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",
"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/gatsby-plugin-clerk/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
3 changes: 3 additions & 0 deletions packages/nextjs/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ declare global {
}

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;

namespace NodeJS {
interface ProcessEnv {
NEXT_PUBLIC_CLERK_FRONTEND_API: string | undefined;
Expand Down
4 changes: 4 additions & 0 deletions packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,5 +15,9 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
afterSignUpUrl: props.afterSignUpUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL || '',
sdkMetadata: {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
},
};
};
2 changes: 2 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

For SDKs that use ClerkProvider, this is how we are passing through and setting the metadata. SDKs that access Clerk directly assign it themselves.


if (global.Clerk?.loaded || global.Clerk?.isReady()) {
return this.hydrateClerkJS(global.Clerk);
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .changeset/nasty-ties-invite.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'gatsby-plugin-clerk': patch
'@clerk/clerk-js': patch
'@clerk/chrome-extension': patch
'@clerk/fastify': patch
'@clerk/nextjs': patch
'@clerk/clerk-react': patch
'@clerk/remix': patch
'@clerk/types': patch
'@clerk/clerk-expo': patch
---

Introduce a new property on the core Clerk singleton, `sdkMetadata`. This will be populated by each host SDK. This metadata will be used to make logging and debugging easier.
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ yarn-error.log
testem.log
/typings
**/coverage/**
*.tsbuildinfo

# System Files
.DS_Store
Expand Down
9 changes: 9 additions & 0 deletions packages/chrome-extension/jest.config.js
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { name, version } = require('./package.json');

module.exports = {
displayName: 'clerk-js',
injectGlobals: true,
Expand All@@ -13,4 +16,10 @@ module.exports = {

testRegex: ['/src/.*.test.[jt]sx?$'],
testPathIgnorePatterns: ['/node_modules/'],

globals: {
__DEV__: true,
PACKAGE_NAME: name,
PACKAGE_VERSION: version,
},
};
5 changes: 5 additions & 0 deletions packages/chrome-extension/src/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import type { TokenCache } from './cache';
import { ChromeStorageCache } from './cache';
import { buildClerk } from './singleton';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({
packageName: '@clerk/chrome-extension',
});
Expand Down
7 changes: 7 additions & 0 deletions packages/chrome-extension/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
const __DEV__: boolean;
}
7 changes: 7 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import type {
PublishableKey,
RedirectOptions,
Resources,
SDKMetadata,
SetActiveParams,
SignInProps,
SignInRedirectOptions,
Expand DownExpand Up@@ -144,7 +145,13 @@ const defaultOptions: ClerkOptions = {

export default class Clerk implements ClerkInterface {
public static mountComponentRenderer?: MountComponentRenderer;

public static version: string = __PKG_VERSION__;
public static sdkMetadata: SDKMetadata = {
name: __PKG_NAME__,
version: __PKG_VERSION__,
};

public client?: ClientResource;
public session?: ActiveSessionResource | null;
public organization?: OrganizationResource | null;
Expand Down
7 changes: 5 additions & 2 deletions packages/expo/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,11 @@
"dist"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/expo/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
5 changes: 5 additions & 0 deletions packages/expo/src/singleton.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,11 @@ import type { HeadlessBrowserClerk } from '@clerk/clerk-react';

import type { TokenCache } from './cache';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

const KEY = '__clerk_client_jwt';

export let clerk: HeadlessBrowserClerk;
Expand Down
22 changes: 0 additions & 22 deletions packages/expo/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/expo/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/expo/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should extend this from a root/base tsconfig.json

But that's for another PR

"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/expo/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
7 changes: 7 additions & 0 deletions packages/fastify/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import { defineConfig } from 'tsup';

import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isProd = overrideOptions.env?.NODE_ENV === 'production';

Expand All@@ -11,5 +13,10 @@ export default defineConfig(overrideOptions => {
sourcemap: true,
format: ['cjs', 'esm'],
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
__DEV__: `${!isProd}`,
},
};
});
7 changes: 5 additions & 2 deletions packages/gatsby-plugin-clerk/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,11 @@
"api.d.ts"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",
"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/GatsbyClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import {
import { navigate } from 'gatsby';
import React from 'react';

const SDK_METADATA = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({ packageName: 'gatsby-plugin-clerk' });

export type GatsbyClerkProviderProps = {
Expand All@@ -22,6 +27,7 @@ export function ClerkProvider({ children, ...rest }: GatsbyClerkProviderProps) {
<ReactClerkProvider
navigate={to => navigate(to)}
initialState={__clerk_ssr_state || {}}
sdkMetadata={SDK_METADATA}
{...restProps}
>
{__clerk_ssr_interstitial_html ? (
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
26 changes: 0 additions & 26 deletions packages/gatsby-plugin-clerk/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/gatsby-plugin-clerk/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/gatsby-plugin-clerk/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",
"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/gatsby-plugin-clerk/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
3 changes: 3 additions & 0 deletions packages/nextjs/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ declare global {
}

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;

namespace NodeJS {
interface ProcessEnv {
NEXT_PUBLIC_CLERK_FRONTEND_API: string | undefined;
Expand Down
4 changes: 4 additions & 0 deletions packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,5 +15,9 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
afterSignUpUrl: props.afterSignUpUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL || '',
sdkMetadata: {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
},
};
};
2 changes: 2 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

For SDKs that use ClerkProvider, this is how we are passing through and setting the metadata. SDKs that access Clerk directly assign it themselves.


if (global.Clerk?.loaded || global.Clerk?.isReady()) {
return this.hydrateClerkJS(global.Clerk);
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .changeset/nasty-ties-invite.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'gatsby-plugin-clerk': patch
'@clerk/clerk-js': patch
'@clerk/chrome-extension': patch
'@clerk/fastify': patch
'@clerk/nextjs': patch
'@clerk/clerk-react': patch
'@clerk/remix': patch
'@clerk/types': patch
'@clerk/clerk-expo': patch
---

Introduce a new property on the core Clerk singleton, `sdkMetadata`. This will be populated by each host SDK. This metadata will be used to make logging and debugging easier.
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ yarn-error.log
testem.log
/typings
**/coverage/**
*.tsbuildinfo

# System Files
.DS_Store
Expand Down
9 changes: 9 additions & 0 deletions packages/chrome-extension/jest.config.js
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { name, version } = require('./package.json');

module.exports = {
displayName: 'clerk-js',
injectGlobals: true,
Expand All@@ -13,4 +16,10 @@ module.exports = {

testRegex: ['/src/.*.test.[jt]sx?$'],
testPathIgnorePatterns: ['/node_modules/'],

globals: {
__DEV__: true,
PACKAGE_NAME: name,
PACKAGE_VERSION: version,
},
};
5 changes: 5 additions & 0 deletions packages/chrome-extension/src/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import type { TokenCache } from './cache';
import { ChromeStorageCache } from './cache';
import { buildClerk } from './singleton';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({
packageName: '@clerk/chrome-extension',
});
Expand Down
7 changes: 7 additions & 0 deletions packages/chrome-extension/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
const __DEV__: boolean;
}
7 changes: 7 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import type {
PublishableKey,
RedirectOptions,
Resources,
SDKMetadata,
SetActiveParams,
SignInProps,
SignInRedirectOptions,
Expand DownExpand Up@@ -144,7 +145,13 @@ const defaultOptions: ClerkOptions = {

export default class Clerk implements ClerkInterface {
public static mountComponentRenderer?: MountComponentRenderer;

public static version: string = __PKG_VERSION__;
public static sdkMetadata: SDKMetadata = {
name: __PKG_NAME__,
version: __PKG_VERSION__,
};

public client?: ClientResource;
public session?: ActiveSessionResource | null;
public organization?: OrganizationResource | null;
Expand Down
7 changes: 5 additions & 2 deletions packages/expo/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,11 @@
"dist"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/expo/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
5 changes: 5 additions & 0 deletions packages/expo/src/singleton.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,11 @@ import type { HeadlessBrowserClerk } from '@clerk/clerk-react';

import type { TokenCache } from './cache';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

const KEY = '__clerk_client_jwt';

export let clerk: HeadlessBrowserClerk;
Expand Down
22 changes: 0 additions & 22 deletions packages/expo/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/expo/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/expo/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should extend this from a root/base tsconfig.json

But that's for another PR

"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/expo/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
7 changes: 7 additions & 0 deletions packages/fastify/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import { defineConfig } from 'tsup';

import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isProd = overrideOptions.env?.NODE_ENV === 'production';

Expand All@@ -11,5 +13,10 @@ export default defineConfig(overrideOptions => {
sourcemap: true,
format: ['cjs', 'esm'],
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
__DEV__: `${!isProd}`,
},
};
});
7 changes: 5 additions & 2 deletions packages/gatsby-plugin-clerk/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,11 @@
"api.d.ts"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",
"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/GatsbyClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import {
import { navigate } from 'gatsby';
import React from 'react';

const SDK_METADATA = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({ packageName: 'gatsby-plugin-clerk' });

export type GatsbyClerkProviderProps = {
Expand All@@ -22,6 +27,7 @@ export function ClerkProvider({ children, ...rest }: GatsbyClerkProviderProps) {
<ReactClerkProvider
navigate={to => navigate(to)}
initialState={__clerk_ssr_state || {}}
sdkMetadata={SDK_METADATA}
{...restProps}
>
{__clerk_ssr_interstitial_html ? (
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
26 changes: 0 additions & 26 deletions packages/gatsby-plugin-clerk/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/gatsby-plugin-clerk/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/gatsby-plugin-clerk/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",
"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/gatsby-plugin-clerk/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
3 changes: 3 additions & 0 deletions packages/nextjs/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ declare global {
}

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;

namespace NodeJS {
interface ProcessEnv {
NEXT_PUBLIC_CLERK_FRONTEND_API: string | undefined;
Expand Down
4 changes: 4 additions & 0 deletions packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,5 +15,9 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
afterSignUpUrl: props.afterSignUpUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL || '',
sdkMetadata: {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
},
};
};
2 changes: 2 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

For SDKs that use ClerkProvider, this is how we are passing through and setting the metadata. SDKs that access Clerk directly assign it themselves.


if (global.Clerk?.loaded || global.Clerk?.isReady()) {
return this.hydrateClerkJS(global.Clerk);
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .changeset/nasty-ties-invite.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'gatsby-plugin-clerk': patch
'@clerk/clerk-js': patch
'@clerk/chrome-extension': patch
'@clerk/fastify': patch
'@clerk/nextjs': patch
'@clerk/clerk-react': patch
'@clerk/remix': patch
'@clerk/types': patch
'@clerk/clerk-expo': patch
---

Introduce a new property on the core Clerk singleton, `sdkMetadata`. This will be populated by each host SDK. This metadata will be used to make logging and debugging easier.
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ yarn-error.log
testem.log
/typings
**/coverage/**
*.tsbuildinfo

# System Files
.DS_Store
Expand Down
9 changes: 9 additions & 0 deletions packages/chrome-extension/jest.config.js
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { name, version } = require('./package.json');

module.exports = {
displayName: 'clerk-js',
injectGlobals: true,
Expand All@@ -13,4 +16,10 @@ module.exports = {

testRegex: ['/src/.*.test.[jt]sx?$'],
testPathIgnorePatterns: ['/node_modules/'],

globals: {
__DEV__: true,
PACKAGE_NAME: name,
PACKAGE_VERSION: version,
},
};
5 changes: 5 additions & 0 deletions packages/chrome-extension/src/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import type { TokenCache } from './cache';
import { ChromeStorageCache } from './cache';
import { buildClerk } from './singleton';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({
packageName: '@clerk/chrome-extension',
});
Expand Down
7 changes: 7 additions & 0 deletions packages/chrome-extension/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
const __DEV__: boolean;
}
7 changes: 7 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import type {
PublishableKey,
RedirectOptions,
Resources,
SDKMetadata,
SetActiveParams,
SignInProps,
SignInRedirectOptions,
Expand DownExpand Up@@ -144,7 +145,13 @@ const defaultOptions: ClerkOptions = {

export default class Clerk implements ClerkInterface {
public static mountComponentRenderer?: MountComponentRenderer;

public static version: string = __PKG_VERSION__;
public static sdkMetadata: SDKMetadata = {
name: __PKG_NAME__,
version: __PKG_VERSION__,
};

public client?: ClientResource;
public session?: ActiveSessionResource | null;
public organization?: OrganizationResource | null;
Expand Down
7 changes: 5 additions & 2 deletions packages/expo/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,11 @@
"dist"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/expo/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
5 changes: 5 additions & 0 deletions packages/expo/src/singleton.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,11 @@ import type { HeadlessBrowserClerk } from '@clerk/clerk-react';

import type { TokenCache } from './cache';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

const KEY = '__clerk_client_jwt';

export let clerk: HeadlessBrowserClerk;
Expand Down
22 changes: 0 additions & 22 deletions packages/expo/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/expo/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/expo/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should extend this from a root/base tsconfig.json

But that's for another PR

"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/expo/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
7 changes: 7 additions & 0 deletions packages/fastify/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import { defineConfig } from 'tsup';

import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isProd = overrideOptions.env?.NODE_ENV === 'production';

Expand All@@ -11,5 +13,10 @@ export default defineConfig(overrideOptions => {
sourcemap: true,
format: ['cjs', 'esm'],
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
__DEV__: `${!isProd}`,
},
};
});
7 changes: 5 additions & 2 deletions packages/gatsby-plugin-clerk/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,11 @@
"api.d.ts"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",
"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/GatsbyClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import {
import { navigate } from 'gatsby';
import React from 'react';

const SDK_METADATA = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({ packageName: 'gatsby-plugin-clerk' });

export type GatsbyClerkProviderProps = {
Expand All@@ -22,6 +27,7 @@ export function ClerkProvider({ children, ...rest }: GatsbyClerkProviderProps) {
<ReactClerkProvider
navigate={to => navigate(to)}
initialState={__clerk_ssr_state || {}}
sdkMetadata={SDK_METADATA}
{...restProps}
>
{__clerk_ssr_interstitial_html ? (
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
26 changes: 0 additions & 26 deletions packages/gatsby-plugin-clerk/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/gatsby-plugin-clerk/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/gatsby-plugin-clerk/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",
"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/gatsby-plugin-clerk/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
3 changes: 3 additions & 0 deletions packages/nextjs/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ declare global {
}

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;

namespace NodeJS {
interface ProcessEnv {
NEXT_PUBLIC_CLERK_FRONTEND_API: string | undefined;
Expand Down
4 changes: 4 additions & 0 deletions packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,5 +15,9 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
afterSignUpUrl: props.afterSignUpUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL || '',
sdkMetadata: {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
},
};
};
2 changes: 2 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

For SDKs that use ClerkProvider, this is how we are passing through and setting the metadata. SDKs that access Clerk directly assign it themselves.


if (global.Clerk?.loaded || global.Clerk?.isReady()) {
return this.hydrateClerkJS(global.Clerk);
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .changeset/nasty-ties-invite.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'gatsby-plugin-clerk': patch
'@clerk/clerk-js': patch
'@clerk/chrome-extension': patch
'@clerk/fastify': patch
'@clerk/nextjs': patch
'@clerk/clerk-react': patch
'@clerk/remix': patch
'@clerk/types': patch
'@clerk/clerk-expo': patch
---

Introduce a new property on the core Clerk singleton, `sdkMetadata`. This will be populated by each host SDK. This metadata will be used to make logging and debugging easier.
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ yarn-error.log
testem.log
/typings
**/coverage/**
*.tsbuildinfo

# System Files
.DS_Store
Expand Down
9 changes: 9 additions & 0 deletions packages/chrome-extension/jest.config.js
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { name, version } = require('./package.json');

module.exports = {
displayName: 'clerk-js',
injectGlobals: true,
Expand All@@ -13,4 +16,10 @@ module.exports = {

testRegex: ['/src/.*.test.[jt]sx?$'],
testPathIgnorePatterns: ['/node_modules/'],

globals: {
__DEV__: true,
PACKAGE_NAME: name,
PACKAGE_VERSION: version,
},
};
5 changes: 5 additions & 0 deletions packages/chrome-extension/src/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import type { TokenCache } from './cache';
import { ChromeStorageCache } from './cache';
import { buildClerk } from './singleton';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({
packageName: '@clerk/chrome-extension',
});
Expand Down
7 changes: 7 additions & 0 deletions packages/chrome-extension/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
const __DEV__: boolean;
}
7 changes: 7 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ import type {
PublishableKey,
RedirectOptions,
Resources,
SDKMetadata,
SetActiveParams,
SignInProps,
SignInRedirectOptions,
Expand DownExpand Up@@ -144,7 +145,13 @@ const defaultOptions: ClerkOptions = {

export default class Clerk implements ClerkInterface {
public static mountComponentRenderer?: MountComponentRenderer;

public static version: string = __PKG_VERSION__;
public static sdkMetadata: SDKMetadata = {
name: __PKG_NAME__,
version: __PKG_VERSION__,
};

public client?: ClientResource;
public session?: ActiveSessionResource | null;
public organization?: OrganizationResource | null;
Expand Down
7 changes: 5 additions & 2 deletions packages/expo/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,8 +21,11 @@
"dist"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/expo/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
5 changes: 5 additions & 0 deletions packages/expo/src/singleton.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,11 @@ import type { HeadlessBrowserClerk } from '@clerk/clerk-react';

import type { TokenCache } from './cache';

Clerk.sdkMetadata = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

const KEY = '__clerk_client_jwt';

export let clerk: HeadlessBrowserClerk;
Expand Down
22 changes: 0 additions & 22 deletions packages/expo/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/expo/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/expo/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should extend this from a root/base tsconfig.json

But that's for another PR

"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/expo/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
7 changes: 7 additions & 0 deletions packages/fastify/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import { defineConfig } from 'tsup';

import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isProd = overrideOptions.env?.NODE_ENV === 'production';

Expand All@@ -11,5 +13,10 @@ export default defineConfig(overrideOptions => {
sourcemap: true,
format: ['cjs', 'esm'],
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
__DEV__: `${!isProd}`,
},
};
});
7 changes: 5 additions & 2 deletions packages/gatsby-plugin-clerk/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,11 @@
"api.d.ts"
],
"scripts": {
"build": "tsc -p tsconfig.build.json",
"dev": "tsc -p tsconfig.build.json --watch",
"build": "tsup",
"dev": "tsup --watch",
"dev:publish": "npm run dev -- --env.publish",
"build:declarations": "tsc -p tsconfig.declarations.json",
"publish:local": "npx yalc push --replace --sig",
"clean": "rimraf ./dist",
"lint": "eslint src/"
},
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/GatsbyClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,11 @@ import {
import { navigate } from 'gatsby';
import React from 'react';

const SDK_METADATA = {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
};

__internal__setErrorThrowerOptions({ packageName: 'gatsby-plugin-clerk' });

export type GatsbyClerkProviderProps = {
Expand All@@ -22,6 +27,7 @@ export function ClerkProvider({ children, ...rest }: GatsbyClerkProviderProps) {
<ReactClerkProvider
navigate={to => navigate(to)}
initialState={__clerk_ssr_state || {}}
sdkMetadata={SDK_METADATA}
{...restProps}
>
{__clerk_ssr_interstitial_html ? (
Expand Down
6 changes: 6 additions & 0 deletions packages/gatsby-plugin-clerk/src/globals.d.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
export {};

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;
}
26 changes: 0 additions & 26 deletions packages/gatsby-plugin-clerk/tsconfig.build.json

This file was deleted.

12 changes: 12 additions & 0 deletions packages/gatsby-plugin-clerk/tsconfig.declarations.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"skipLibCheck": true,
"noEmit": false,
"declaration": true,
"emitDeclarationOnly": true,
"declarationMap": true,
"sourceMap": false,
"declarationDir": "./dist"
}
}
24 changes: 22 additions & 2 deletions packages/gatsby-plugin-clerk/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
{
"extends": "./tsconfig.build.json",
"compilerOptions": {
"outDir": "dist",
"baseUrl": ".",
"lib": ["es6", "dom"],
"jsx": "react",
"module": "commonjs",
"moduleResolution": "node",
"importHelpers": true,
"declaration": true,
"declarationMap": false,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"sourceMap": false,
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"allowJs": true,
"target": "ES2019",
"noEmitOnError": false,
"incremental": true
}
},
"include": ["src"]
}
30 changes: 30 additions & 0 deletions packages/gatsby-plugin-clerk/tsup.config.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import type { Options } from 'tsup';
import { defineConfig } from 'tsup';

import { runAfterLast } from '../../scripts/utils';
import { version as clerkJsVersion } from '../clerk-js/package.json';
import { name, version } from './package.json';

export default defineConfig(overrideOptions => {
const isWatch = !!overrideOptions.watch;
const shouldPublish = !!overrideOptions.env?.publish;

const options: Options = {
format: 'cjs',
outDir: './dist',
entry: ['./src/**/*.{ts,tsx,js,jsx}'],
bundle: false,
clean: true,
minify: false,
sourcemap: true,
legacyOutput: true,
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
JS_PACKAGE_VERSION: `"${clerkJsVersion}"`,
__DEV__: `${isWatch}`,
},
};

return runAfterLast(['npm run build:declarations', shouldPublish && 'npm run publish:local'])(options);
});
3 changes: 3 additions & 0 deletions packages/nextjs/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ declare global {
}

declare global {
const PACKAGE_NAME: string;
const PACKAGE_VERSION: string;

namespace NodeJS {
interface ProcessEnv {
NEXT_PUBLIC_CLERK_FRONTEND_API: string | undefined;
Expand Down
4 changes: 4 additions & 0 deletions packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,5 +15,9 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
afterSignUpUrl: props.afterSignUpUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL || '',
sdkMetadata: {
name: PACKAGE_NAME,
version: PACKAGE_VERSION,
},
};
};
2 changes: 2 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 };

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

For SDKs that use ClerkProvider, this is how we are passing through and setting the metadata. SDKs that access Clerk directly assign it themselves.


if (global.Clerk?.loaded || global.Clerk?.isReady()) {
return this.hydrateClerkJS(global.Clerk);
}
Expand Down
Loading