feat(shared,types): Migrate @clerk/types to @clerk/shared/types

.changeset/deprecate-clerk-types.md

@@ -0,0 +1,44 @@
+---
+'@clerk/types': minor
+'@clerk/shared': minor
+'@clerk/astro': patch
+'@clerk/backend': patch
+'@clerk/chrome-extension': patch
+'@clerk/clerk-js': patch
+'@clerk/elements': patch
+'@clerk/themes': patch
+'@clerk/vue': patch
+---
+
+Deprecate `@clerk/types` in favor of `@clerk/shared/types`
+
+The `@clerk/types` package is now deprecated. All type definitions have been consolidated and moved to `@clerk/shared/types` to improve consistency across the Clerk ecosystem.
+
+**Backward Compatibility:**
+
+The `@clerk/types` package will remain available and will continue to re-export all types from `@clerk/shared/types` to ensure backward compatibility. Existing applications will continue to work without any immediate breaking changes. However, we strongly recommend migrating to `@clerk/shared/types` as new type definitions and updates will only be added to `@clerk/shared/types` starting with the next major release.
+
+**Migration Steps:**
+
+Please update your imports from `@clerk/types` to `@clerk/shared/types`:
+
+```typescript
+// Before
+import type { ClerkResource, UserResource } from '@clerk/types';
+
+// After
+import type { ClerkResource, UserResource } from '@clerk/shared/types';
+```
+
+**What Changed:**
+
+All type definitions including:
+- Resource types (User, Organization, Session, etc.)
+- API response types
+- Configuration types  
+- Authentication types
+- Error types
+- And all other shared types
+
+Have been moved from `packages/types/src` to `packages/shared/src/types` and are now exported via `@clerk/shared/types`.
+

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ concurrency:
 jobs:
   # Check triggering actor permissions to prevent PRs from forks accessing secrets by default, preventing them from exfiltrating secrets for malicious purposes
   check-permissions:
-    runs-on: 'blacksmith-8vcpu-ubuntu-2204'
+    runs-on: "blacksmith-8vcpu-ubuntu-2204"
     defaults:
       run:
         shell: bash
@@ -48,7 +48,7 @@ jobs:
     needs: [check-permissions]
     if: ${{ github.event_name != 'pull_request' || github.event.pull_request.draft == false }}
     name: Formatting | Dedupe | Changeset
-    runs-on: 'blacksmith-8vcpu-ubuntu-2204'
+    runs-on: "blacksmith-8vcpu-ubuntu-2204"
     defaults:
       run:
         shell: bash
@@ -89,7 +89,7 @@ jobs:
     needs: [check-permissions]
     if: ${{ github.event_name != 'pull_request' || github.event.pull_request.draft == false }}
     name: Build Packages
-    runs-on: 'blacksmith-8vcpu-ubuntu-2204'
+    runs-on: "blacksmith-8vcpu-ubuntu-2204"
     permissions:
       contents: read
     defaults:
@@ -135,7 +135,7 @@ jobs:
     permissions:
       contents: read
       actions: write # needed for actions/upload-artifact
-    runs-on: 'blacksmith-8vcpu-ubuntu-2204'
+    runs-on: "blacksmith-8vcpu-ubuntu-2204"
     defaults:
       run:
         shell: bash
@@ -195,7 +195,7 @@ jobs:
     permissions:
       contents: read
       actions: write # needed for actions/upload-artifact
-    runs-on: 'blacksmith-8vcpu-ubuntu-2204'
+    runs-on: "blacksmith-8vcpu-ubuntu-2204"
     defaults:
       run:
         shell: bash
@@ -208,10 +208,8 @@ jobs:
       fail-fast: true
       matrix:
         include:
-          - node-version: 18
-            test-filter: '--filter=@clerk/astro --filter=@clerk/backend --filter=@clerk/express --filter=@clerk/nextjs --filter=@clerk/clerk-react --filter=@clerk/shared --filter=@clerk/remix --filter=@clerk/tanstack-react-start --filter=@clerk/elements --filter=@clerk/vue --filter=@clerk/nuxt --filter=@clerk/clerk-expo'
           - node-version: 22
-            test-filter: '**'
+            test-filter: "**"
 
     steps:
       - name: Checkout Repo
@@ -268,7 +266,7 @@ jobs:
     permissions:
       contents: read
       actions: write # needed for actions/upload-artifact
-    runs-on: 'blacksmith-8vcpu-ubuntu-2204'
+    runs-on: "blacksmith-8vcpu-ubuntu-2204"
     defaults:
       run:
         shell: bash
@@ -277,37 +275,36 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        test-name:
-          [
-            'generic',
-            'express',
-            'quickstart',
-            'ap-flows',
-            'elements',
-            'localhost',
-            'sessions',
-            'sessions:staging',
-            'handshake',
-            'handshake:staging',
-            'astro',
-            'expo-web',
-            'tanstack-react-start',
+        test-name: [
+            "generic",
+            "express",
+            "quickstart",
+            "ap-flows",
+            "elements",
+            "localhost",
+            "sessions",
+            "sessions:staging",
+            "handshake",
+            "handshake:staging",
+            "astro",
+            "expo-web",
+            "tanstack-react-start",
             # 'tanstack-react-router',
-            'vue',
-            'nuxt',
-            'react-router',
-            'billing',
-            'machine',
-            'custom',
+            "vue",
+            "nuxt",
+            "react-router",
+            "billing",
+            "machine",
+            "custom",
           ]
-        test-project: ['chrome']
+        test-project: ["chrome"]
         include:
-          - test-name: 'nextjs'
-            test-project: 'chrome'
-            next-version: '14'
-          - test-name: 'nextjs'
-            test-project: 'chrome'
-            next-version: '15'
+          - test-name: "nextjs"
+            test-project: "chrome"
+            next-version: "14"
+          - test-name: "nextjs"
+            test-project: "chrome"
+            next-version: "15"
 
     steps:
       - name: Checkout Repo
@@ -329,7 +326,7 @@ jobs:
         id: task-status
         env:
           E2E_APP_CLERK_JS_DIR: ${{runner.temp}}
-          E2E_CLERK_VERSION: 'latest'
+          E2E_CLERK_VERSION: "latest"
           E2E_NEXTJS_VERSION: ${{ matrix.next-version }}
           E2E_PROJECT: ${{ matrix.test-project }}
           INTEGRATION_INSTANCE_KEYS: ${{ secrets.INTEGRATION_INSTANCE_KEYS }}
@@ -374,8 +371,8 @@ jobs:
         if: ${{ steps.task-status.outputs.affected == '1' }}
         uses: actions/github-script@v7
         env:
-          INTEGRATION_CERTS: '${{secrets.INTEGRATION_CERTS}}'
-          INTEGRATION_ROOT_CA: '${{secrets.INTEGRATION_ROOT_CA}}'
+          INTEGRATION_CERTS: "${{secrets.INTEGRATION_CERTS}}"
+          INTEGRATION_ROOT_CA: "${{secrets.INTEGRATION_ROOT_CA}}"
         with:
           script: |
             const fs = require('fs');
@@ -400,7 +397,7 @@ jobs:
         run: pnpm turbo test:integration:${{ matrix.test-name }} $TURBO_ARGS
         env:
           E2E_APP_CLERK_JS_DIR: ${{runner.temp}}
-          E2E_CLERK_VERSION: 'latest'
+          E2E_CLERK_VERSION: "latest"
           E2E_NEXTJS_VERSION: ${{ matrix.next-version }}
           E2E_PROJECT: ${{ matrix.test-project }}
           E2E_CLERK_ENCRYPTION_KEY: ${{ matrix.clerk-encryption-key }}
@@ -420,7 +417,7 @@ jobs:
     name: Publish with pkg-pr-new
     if: ${{ github.event_name != 'pull_request' || github.event.pull_request.draft == false }}
     needs: [check-permissions, build-packages]
-    runs-on: 'blacksmith-8vcpu-ubuntu-2204'
+    runs-on: "blacksmith-8vcpu-ubuntu-2204"
     defaults:
       run:
         shell: bash

.typedoc/__tests__/file-structure.test.ts

@@ -36,7 +36,6 @@ describe('Typedoc output', () => {
         "clerk-react",
         "nextjs",
         "shared",
-        "types",
       ]
     `);
   });

eslint.config.mjs

@@ -120,6 +120,7 @@ export default tseslint.config([
       'packages/backend/src/runtime/**/*',
       'packages/clerk-js/rspack.config.js',
       'packages/shared/src/compiled/path-to-regexp/index.js',
+      'packages/shared/tsdown.config.mjs',
     ],
   },
   {

integration/README.md

@@ -368,7 +368,6 @@ Assuming you have a `react-parcel` template defined in `integration/templates`,
    ```
 
    Here's what each thing is doing:
-
    - `setName`: Set internal name
    - `useTemplate`: Define which template inside `integration/templates` to use
    - `setEnvFormatter`: Define how environment variables should be formatted. The first argument accepts `'public'` and `'private'`. Inside [`envs.ts`](./presets/envs.ts) the environment variables you can use through [`withEnv`](#environment-configs) are defined. Since different frameworks require environment variables to be in different formats (e.g. Next.js wants public env vars to be prefixed with `NEXT_PUBLIC_`) you can use this formatter to change that.

integration/templates/expo-web/metro.config.js

@@ -19,6 +19,10 @@ const getClerkExpoPath = () => {
     return clerkExpoPath.replace('file:', '');
   }
 
+  if (clerkExpoPath?.startsWith('link:')) {
+    return clerkExpoPath.replace('link:', '');
+  }
+
   return undefined;
 };
 

integration/tests/custom-flows/sign-in.test.ts

@@ -1,10 +1,11 @@
-import { expect, test } from '@playwright/test';
 import { parsePublishableKey } from '@clerk/shared/keys';
 import { clerkSetup } from '@clerk/testing/playwright';
+import { expect, test } from '@playwright/test';
 
 import type { Application } from '../../models/application';
 import { appConfigs } from '../../presets';
-import { createTestUtils, FakeUser } from '../../testUtils';
+import type { FakeUser } from '../../testUtils';
+import { createTestUtils } from '../../testUtils';
 
 test.describe('Custom Flows Sign In @custom', () => {
   test.describe.configure({ mode: 'parallel' });

integration/tests/custom-flows/sign-up.test.ts

@@ -1,10 +1,11 @@
-import { expect, test } from '@playwright/test';
 import { parsePublishableKey } from '@clerk/shared/keys';
 import { clerkSetup } from '@clerk/testing/playwright';
+import { expect, test } from '@playwright/test';
 
 import type { Application } from '../../models/application';
 import { appConfigs } from '../../presets';
-import { createTestUtils, FakeUser } from '../../testUtils';
+import type { FakeUser } from '../../testUtils';
+import { createTestUtils } from '../../testUtils';
 
 test.describe('Custom Flows Sign Up @custom', () => {
   test.describe.configure({ mode: 'parallel' });

package.json

@@ -135,9 +135,11 @@
     "react": "catalog:react",
     "react-dom": "catalog:react",
     "rimraf": "6.0.1",
+    "rolldown": "catalog:repo",
     "statuses": "^1.5.0",
     "tree-kill": "^1.2.2",
     "ts-jest": "29.2.5",
+    "tsdown": "catalog:repo",
     "tsup": "catalog:repo",
     "turbo": "^2.5.4",
     "turbo-ignore": "^2.5.4",
@@ -164,10 +166,9 @@
     ],
     "overrides": {
       "jest": "29.7.0",
-      "jest-snapshot-prettier": "npm:prettier@^3.5.3"
-    },
-    "patchedDependencies": {
-      "yalc@1.0.0-pre.53": "patches/yalc@1.0.0-pre.53.patch"
+      "jest-snapshot-prettier": "npm:prettier@^3.5.3",
+      "react": "catalog:react",
+      "react-dom": "catalog:react"
     }
   }
 }

packages/agent-toolkit/src/langchain/adapter.ts

@@ -8,9 +8,11 @@ import type { SdkAdapter } from '../lib/types';
  * For more details, take a look at the LangChain docs https://js.langchain.com/docs/how_to/custom_tools
  */
 export const adapter: SdkAdapter<StructuredTool> = (clerkClient, context, clerkTool) => {
-  return tool(clerkTool.bindExecute(clerkClient, context), {
+  const executeFn = clerkTool.bindExecute(clerkClient, context as any) as any;
+  const toolConfig = {
     name: clerkTool.name,
     description: clerkTool.description,
     schema: clerkTool.parameters,
-  });
+  } as any;
+  return tool(executeFn, toolConfig) as StructuredTool;
 };

packages/astro/src/stores/external.ts

@@ -1,5 +1,6 @@
 import { deriveState } from '@clerk/shared/deriveState';
 import { eventMethodCalled } from '@clerk/shared/telemetry';
+import type { SignedInSessionResource } from '@clerk/types';
 import { batched, computed, onMount, type Store } from 'nanostores';
 
 import { $clerk, $csrState, $initialState } from './internal';
@@ -51,7 +52,7 @@ export const $userStore = computed([$authStore], auth => auth.user);
  * @example
  * $sessionStore.subscribe((session) => console.log(session.id))
  */
-export const $sessionStore = computed([$authStore], auth => auth.session);
+export const $sessionStore = computed([$authStore], auth => auth.session as SignedInSessionResource | null | undefined);
 
 /**
  * A client side store that is populated after clerk-js has loaded.

packages/backend/src/util/shared.ts

@@ -1,13 +1,13 @@
-export { addClerkPrefix, getScriptUrl, getClerkJsMajorVersionOrTag } from '@clerk/shared/url';
-export { retry } from '@clerk/shared/retry';
+export { deprecated, deprecatedProperty } from '@clerk/shared/deprecated';
 export {
+  getCookieSuffix,
+  getSuffixedCookieName,
   isDevelopmentFromSecretKey,
   isProductionFromSecretKey,
   parsePublishableKey,
-  getCookieSuffix,
-  getSuffixedCookieName,
 } from '@clerk/shared/keys';
-export { deprecated, deprecatedProperty } from '@clerk/shared/deprecated';
+export { retry } from '@clerk/shared/retry';
+export { addClerkPrefix, getClerkJsMajorVersionOrTag, getScriptUrl } from '@clerk/shared/url';
 
 import { buildErrorThrower } from '@clerk/shared/error';
 import { createDevOrStagingUrlCache } from '@clerk/shared/keys';

packages/chrome-extension/README.md

@@ -69,7 +69,6 @@ Please see the latest extension [authentication support matrix](https://clerk.co
     1. [**Base configuration**:](/packages/chrome-extension/docs/manifest.md#base-configuration) Use this if you plan to only use Clerk in the context of the extension.
     2. [**Session sync configuration**:](/packages/chrome-extension/docs/manifest.md#sync-host-configuration) Use this if you plan to share authentication with a website in the same browser.
 6.  **Add Clerk to your app:** Though not required, we generally suggest using Plasmo for browser extension development. This will enforce common standards across your extension as well as allow for easier integration with other browsers in the future.
-
     1. [**Via `ClerkProvider`:**](/packages/chrome-extension/docs/clerk-provider.md) This is the general approach to all extensions. From here you'll be able to support extension-only authentication as well as sharing authentication with a website in the same browser.
     2. [**Via service workers**:](/packages/chrome-extension/docs/service-workers.md) If you also require the use of background service workers, this will allow you to access the Clerk client from the extension context.
 

packages/chrome-extension/tsconfig.json

@@ -9,8 +9,8 @@
     "strict": true,
     "forceConsistentCasingInFileNames": true,
     "noFallthroughCasesInSwitch": true,
-    "module": "esnext",
-    "moduleResolution": "node",
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
     "resolveJsonModule": true,
     "isolatedModules": true,
     "jsx": "react-jsx",

packages/clerk-js/bundlewatch.config.json

@@ -1,13 +1,13 @@
 {
   "files": [
-    { "path": "./dist/clerk.js", "maxSize": "821KB" },
+    { "path": "./dist/clerk.js", "maxSize": "840KB" },
     { "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
     { "path": "./dist/clerk.channel.browser.js", "maxSize": "81KB" },
     { "path": "./dist/clerk.legacy.browser.js", "maxSize": "123KB" },
     { "path": "./dist/clerk.headless*.js", "maxSize": "63KB" },
     { "path": "./dist/ui-common*.js", "maxSize": "117.1KB" },
     { "path": "./dist/ui-common*.legacy.*.js", "maxSize": "120KB" },
-    { "path": "./dist/vendors*.js", "maxSize": "45KB" },
+    { "path": "./dist/vendors*.js", "maxSize": "47KB" },
     { "path": "./dist/coinbase*.js", "maxSize": "38KB" },
     { "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
     { "path": "./dist/createorganization*.js", "maxSize": "5KB" },

packages/clerk-js/package.json

@@ -63,7 +63,6 @@
     "@base-org/account": "2.0.1",
     "@clerk/localizations": "workspace:^",
     "@clerk/shared": "workspace:^",
-    "@clerk/types": "workspace:^",
     "@coinbase/wallet-sdk": "4.3.0",
     "@emotion/cache": "11.11.0",
     "@emotion/react": "11.11.1",