@clerk/testing 2.0.0-snapshot.v07d9254 → 2.0.0-snapshot.v20251203203405

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerk/testing",
-  "version": "2.0.0-snapshot.v07d9254",
+  "version": "2.0.0-snapshot.v20251203203405",
   "description": "Utilities to help you create E2E test suites for apps using Clerk",
   "keywords": [
     "auth",
@@ -9,6 +9,7 @@
     "session",
     "jwt",
     "playwright",
+    "cypress",
     "testing",
     "e2e"
   ],
@@ -27,48 +28,76 @@
   "exports": {
     "./playwright": {
       "import": {
-        "types": "./dist/types/index.d.ts",
-        "default": "./dist/esm/index.js"
+        "types": "./dist/types/playwright/index.d.ts",
+        "default": "./dist/playwright/index.mjs"
       },
       "require": {
-        "types": "./dist/types/index.d.ts",
-        "default": "./dist/index.js"
+        "types": "./dist/types/playwright/index.d.ts",
+        "default": "./dist/playwright/index.js"
+      }
+    },
+    "./playwright/unstable": {
+      "import": {
+        "types": "./dist/types/playwright/unstable/index.d.ts",
+        "default": "./dist/playwright/unstable/index.mjs"
+      },
+      "require": {
+        "types": "./dist/types/playwright/unstable/index.d.ts",
+        "default": "./dist/playwright/unstable/index.js"
+      }
+    },
+    "./cypress": {
+      "import": {
+        "types": "./dist/types/cypress/index.d.ts",
+        "default": "./dist/cypress/index.mjs"
+      },
+      "require": {
+        "types": "./dist/types/cypress/index.d.ts",
+        "default": "./dist/cypress/index.js"
       }
     }
   },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/types/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "playwright",
+    "cypress"
   ],
-  "scripts": {
-    "build": "tsup --env.NODE_ENV production",
-    "clean": "rimraf ./dist",
-    "dev": "tsup --watch",
-    "lint": "eslint src/"
-  },
   "dependencies": {
-    "@clerk/shared": "2.0.0",
-    "@clerk/types": "4.1.0-snapshot.v07d9254",
-    "dotenv": "16.4.5"
+    "dotenv": "17.2.2",
+    "@clerk/backend": "^3.0.0-snapshot.v20251203203405",
+    "@clerk/shared": "^4.0.0-snapshot.v20251203203405"
   },
   "devDependencies": {
-    "@playwright/test": "^1.43.1",
-    "@types/node": "^18.17.0",
-    "eslint-config-custom": "*",
-    "tsup": "*",
-    "typescript": "*"
+    "@playwright/test": "^1.56.1",
+    "cypress": "^14.5.4"
   },
   "peerDependencies": {
-    "@playwright/test": "^1"
+    "@playwright/test": "^1",
+    "cypress": "^13 || ^14"
   },
   "peerDependenciesMeta": {
     "@playwright/test": {
       "optional": true
+    },
+    "cypress": {
+      "optional": true
     }
   },
   "engines": {
-    "node": ">=18.17.0"
+    "node": ">=20.9.0"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build": "tsup --env.NODE_ENV production",
+    "clean": "rimraf ./dist",
+    "dev": "tsup --watch",
+    "format": "node ../../scripts/format-package.mjs",
+    "format:check": "node ../../scripts/format-package.mjs --check",
+    "lint": "eslint src"
   }
-}
+}

package/playwright/package.json

@@ -0,0 +1,5 @@
+{
+  "main": "../dist/playwright/index.js",
+  "module": "../dist/playwright/index.mjs",
+  "types": "../dist/types/playwright/index.d.ts"
+}

package/dist/esm/index.js

@@ -1,2 +0,0 @@
-import{isProductionFromSecretKey as c,parsePublishableKey as a}from"@clerk/shared/keys";import _ from"dotenv";var l="https://api.clerk.com/v1/testing_tokens",K=async r=>{let p=n=>{r?.debug&&console.log(`Clerk: ${n}`)};p("Setting up Clerk..."),_.config({path:[".env.local",".env"]});let o=r?.publishableKey||process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY||process.env.VITE_CLERK_PUBLISHABLE_KEY||process.env.CLERK_PUBLISHABLE_KEY||process.env.GATSBY_CLERK_PUBLISHABLE_KEY||process.env.REACT_APP_CLERK_PUBLISHABLE_KEY||process.env.EXPO_PUBLIC_CLERK_PUBLISHABLE_KEY,e=process.env.CLERK_SECRET_KEY,t=process.env.CLERK_TESTING_TOKEN;if(!o)throw new Error("You need to set the CLERK_PUBLISHABLE_KEY environment variable.");if(!e&&!t)throw new Error("You need to set the CLERK_SECRET_KEY or the CLERK_TESTING_KEY environment variable.");if(e&&!t){if(c(e))throw new Error("You are using a secret key from a production instance, but this helper only works for development instances.");let n={method:"POST",headers:{Authorization:`Bearer ${e}`,"Content-Type":"application/json"}};p("Fetching testing token from Clerk Backend API...");let s=process.env.CLERK_API_URL,E=s?`${s}/v1/testing_tokens`:l;await fetch(E,n).then(i=>i.json()).then(i=>{t=i.token}).catch(i=>{throw new Error("Failed to fetch testing token from Clerk API. Error: "+i)})}process.env.CLERK_FAPI=r?.frontendApiUrl||a(o)?.frontendApi,process.env.CLERK_TESTING_TOKEN=t};var L="__clerk_testing_token",T=async({page:r,options:p})=>{let o=p?.frontendApiUrl||process.env.CLERK_FAPI;if(!o)throw new Error("The Frontend API URL is required to bypass bot protection.");let e=`https://${o}/v1/**/*`;await r.route(e,(t,n)=>{let s=new URL(n.url()),E=process.env.CLERK_TESTING_TOKEN;E&&s.searchParams.set(L,E),t.continue({url:s.toString()})})};export{K as clerkSetup,T as setupClerkTestingToken};
-//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/playwright/setup.ts","../../src/playwright/setupClerkTestingToken.ts"],"sourcesContent":["import { isProductionFromSecretKey, parsePublishableKey } from '@clerk/shared/keys';\nimport dotenv from 'dotenv';\n\ntype ClerkSetupParams = {\n  /*\n   * The publishable key for your Clerk dev instance.\n   * If not provided, the library will look for the key in the following environment variables:\n   * - NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY\n   * - VITE_CLERK_PUBLISHABLE_KEY\n   * - CLERK_PUBLISHABLE_KEY\n   * - GATSBY_CLERK_PUBLISHABLE_KEY\n   * - REACT_APP_CLERK_PUBLISHABLE_KEY\n   * - EXPO_PUBLIC_CLERK_PUBLISHABLE_KEY\n   */\n  publishableKey?: string;\n  /*\n   * The frontend API URL for your Clerk dev instance, without the protocol.\n   * If provided, it overrides the Frontend API URL parsed from the publishable key.\n   * Example: 'relieved-chamois-66.clerk.accounts.dev'\n   */\n  frontendApiUrl?: string;\n  /*\n   * Enable debug mode.\n   */\n  debug?: boolean;\n};\n\nconst TESTING_TOKEN_API_URL = 'https://api.clerk.com/v1/testing_tokens';\n\n/**\n * Sets up Clerk for testing by fetching the testing token from the Clerk Backend API.\n *\n * @param options.publishableKey - The publishable key for your Clerk dev instance.\n * @param options.frontendApiUrl - The frontend API URL for your Clerk dev instance, without the protocol. It overrides the Frontend API URL parsed from the publishable key.\n * @param options.debug - Enable debug logs.\n * @returns A promise that resolves when Clerk is set up.\n *\n * @throws An error if the publishable key or the secret key is not provided.\n * @throws An error if the secret key is from a production instance.\n * @throws An error if the testing token cannot be fetched from the Clerk Backend API.\n */\nexport const clerkSetup = async (options?: ClerkSetupParams) => {\n  const log = (msg: string) => {\n    if (options?.debug) {\n      console.log(`Clerk: ${msg}`);\n    }\n  };\n\n  log('Setting up Clerk...');\n  dotenv.config({ path: ['.env.local', '.env'] });\n\n  const publishableKey =\n    options?.publishableKey ||\n    process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY ||\n    process.env.VITE_CLERK_PUBLISHABLE_KEY ||\n    process.env.CLERK_PUBLISHABLE_KEY ||\n    process.env.GATSBY_CLERK_PUBLISHABLE_KEY ||\n    process.env.REACT_APP_CLERK_PUBLISHABLE_KEY ||\n    process.env.EXPO_PUBLIC_CLERK_PUBLISHABLE_KEY;\n\n  const secretKey = process.env.CLERK_SECRET_KEY;\n  let testingToken = process.env.CLERK_TESTING_TOKEN;\n\n  if (!publishableKey) {\n    throw new Error('You need to set the CLERK_PUBLISHABLE_KEY environment variable.');\n  }\n\n  if (!secretKey && !testingToken) {\n    throw new Error('You need to set the CLERK_SECRET_KEY or the CLERK_TESTING_KEY environment variable.');\n  }\n\n  if (secretKey && !testingToken) {\n    if (isProductionFromSecretKey(secretKey)) {\n      throw new Error(\n        'You are using a secret key from a production instance, but this helper only works for development instances.',\n      );\n    }\n\n    const options = {\n      method: 'POST',\n      headers: {\n        Authorization: `Bearer ${secretKey}`,\n        'Content-Type': 'application/json',\n      },\n    };\n\n    log('Fetching testing token from Clerk Backend API...');\n\n    const apiUrl = process.env.CLERK_API_URL;\n    const testingTokenApiUrl = apiUrl ? `${apiUrl}/v1/testing_tokens` : TESTING_TOKEN_API_URL;\n\n    await fetch(testingTokenApiUrl, options)\n      .then(response => {\n        return response.json();\n      })\n      .then(data => {\n        testingToken = data.token;\n      })\n      .catch(reason => {\n        throw new Error('Failed to fetch testing token from Clerk API. Error: ' + reason);\n      });\n  }\n\n  process.env.CLERK_FAPI = options?.frontendApiUrl || parsePublishableKey(publishableKey)?.frontendApi;\n  process.env.CLERK_TESTING_TOKEN = testingToken;\n};\n","import type { Page } from '@playwright/test';\n\ntype BypassBotProtectionParams = {\n  page: Page;\n  options?: {\n    /*\n     * The frontend API URL for your Clerk dev instance, without the protocol.\n     * If provided, it overrides the Frontend API URL parsed from the publishable key.\n     * Example: 'relieved-chamois-66.clerk.accounts.dev'\n     */\n    frontendApiUrl?: string;\n  };\n};\n\nconst TESTING_TOKEN_PARAM = '__clerk_testing_token';\n\n/**\n * Bypasses bot protection by appending the testing token in the Frontend API requests.\n *\n * @param params.page - The Playwright page object.\n * @param params.options.frontendApiUrl - The frontend API URL for your Clerk dev instance, without the protocol.\n * @returns A promise that resolves when the bot protection bypass is set up.\n * @throws An error if the Frontend API URL is not provided.\n * @example\n * ```ts\n * import { setupClerkTestingToken } from '@clerk/testing/playwright';\n *\n * test('should bypass bot protection', async ({ page }) => {\n *    await setupClerkTestingToken({ page });\n *    await page.goto('https://your-app.com');\n *    // Continue with your test...\n *  });\n * ```\n *\n */\nexport const setupClerkTestingToken = async ({ page, options }: BypassBotProtectionParams) => {\n  const fapiUrl = options?.frontendApiUrl || process.env.CLERK_FAPI;\n  if (!fapiUrl) {\n    throw new Error('The Frontend API URL is required to bypass bot protection.');\n  }\n  const apiUrl = `https://${fapiUrl}/v1/**/*`;\n\n  await page.route(apiUrl, (route, request) => {\n    const originalUrl = new URL(request.url());\n    const testingToken = process.env.CLERK_TESTING_TOKEN;\n\n    if (testingToken) {\n      originalUrl.searchParams.set(TESTING_TOKEN_PARAM, testingToken);\n    }\n\n    route.continue({\n      url: originalUrl.toString(),\n    });\n  });\n};\n"],"mappings":"AAAA,OAAS,6BAAAA,EAA2B,uBAAAC,MAA2B,qBAC/D,OAAOC,MAAY,SA0BnB,IAAMC,EAAwB,0CAcjBC,EAAa,MAAOC,GAA+B,CAC9D,IAAMC,EAAOC,GAAgB,CACvBF,GAAS,OACX,QAAQ,IAAI,UAAUE,CAAG,EAAE,CAE/B,EAEAD,EAAI,qBAAqB,EACzBJ,EAAO,OAAO,CAAE,KAAM,CAAC,aAAc,MAAM,CAAE,CAAC,EAE9C,IAAMM,EACJH,GAAS,gBACT,QAAQ,IAAI,mCACZ,QAAQ,IAAI,4BACZ,QAAQ,IAAI,uBACZ,QAAQ,IAAI,8BACZ,QAAQ,IAAI,iCACZ,QAAQ,IAAI,kCAERI,EAAY,QAAQ,IAAI,iBAC1BC,EAAe,QAAQ,IAAI,oBAE/B,GAAI,CAACF,EACH,MAAM,IAAI,MAAM,iEAAiE,EAGnF,GAAI,CAACC,GAAa,CAACC,EACjB,MAAM,IAAI,MAAM,qFAAqF,EAGvG,GAAID,GAAa,CAACC,EAAc,CAC9B,GAAIV,EAA0BS,CAAS,EACrC,MAAM,IAAI,MACR,8GACF,EAGF,IAAMJ,EAAU,CACd,OAAQ,OACR,QAAS,CACP,cAAe,UAAUI,CAAS,GAClC,eAAgB,kBAClB,CACF,EAEAH,EAAI,kDAAkD,EAEtD,IAAMK,EAAS,QAAQ,IAAI,cACrBC,EAAqBD,EAAS,GAAGA,CAAM,qBAAuBR,EAEpE,MAAM,MAAMS,EAAoBP,CAAO,EACpC,KAAKQ,GACGA,EAAS,KAAK,CACtB,EACA,KAAKC,GAAQ,CACZJ,EAAeI,EAAK,KACtB,CAAC,EACA,MAAMC,GAAU,CACf,MAAM,IAAI,MAAM,wDAA0DA,CAAM,CAClF,CAAC,CACL,CAEA,QAAQ,IAAI,WAAaV,GAAS,gBAAkBJ,EAAoBO,CAAc,GAAG,YACzF,QAAQ,IAAI,oBAAsBE,CACpC,EC3FA,IAAMM,EAAsB,wBAqBfC,EAAyB,MAAO,CAAE,KAAAC,EAAM,QAAAC,CAAQ,IAAiC,CAC5F,IAAMC,EAAUD,GAAS,gBAAkB,QAAQ,IAAI,WACvD,GAAI,CAACC,EACH,MAAM,IAAI,MAAM,4DAA4D,EAE9E,IAAMC,EAAS,WAAWD,CAAO,WAEjC,MAAMF,EAAK,MAAMG,EAAQ,CAACC,EAAOC,IAAY,CAC3C,IAAMC,EAAc,IAAI,IAAID,EAAQ,IAAI,CAAC,EACnCE,EAAe,QAAQ,IAAI,oBAE7BA,GACFD,EAAY,aAAa,IAAIR,EAAqBS,CAAY,EAGhEH,EAAM,SAAS,CACb,IAAKE,EAAY,SAAS,CAC5B,CAAC,CACH,CAAC,CACH","names":["isProductionFromSecretKey","parsePublishableKey","dotenv","TESTING_TOKEN_API_URL","clerkSetup","options","log","msg","publishableKey","secretKey","testingToken","apiUrl","testingTokenApiUrl","response","data","reason","TESTING_TOKEN_PARAM","setupClerkTestingToken","page","options","fapiUrl","apiUrl","route","request","originalUrl","testingToken"]}

package/dist/types/setup.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../../src/playwright/setup.ts"],"names":[],"mappings":"AAGA,KAAK,gBAAgB,GAAG;IAWtB,cAAc,CAAC,EAAE,MAAM,CAAC;IAMxB,cAAc,CAAC,EAAE,MAAM,CAAC;IAIxB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAIF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,aAAoB,gBAAgB,kBAgE1D,CAAC"}

package/dist/types/setupClerkTestingToken.d.ts

@@ -1,29 +0,0 @@
-import type { Page } from '@playwright/test';
-type BypassBotProtectionParams = {
-    page: Page;
-    options?: {
-        frontendApiUrl?: string;
-    };
-};
-/**
- * Bypasses bot protection by appending the testing token in the Frontend API requests.
- *
- * @param params.page - The Playwright page object.
- * @param params.options.frontendApiUrl - The frontend API URL for your Clerk dev instance, without the protocol.
- * @returns A promise that resolves when the bot protection bypass is set up.
- * @throws An error if the Frontend API URL is not provided.
- * @example
- * ```ts
- * import { setupClerkTestingToken } from '@clerk/testing/playwright';
- *
- * test('should bypass bot protection', async ({ page }) => {
- *    await setupClerkTestingToken({ page });
- *    await page.goto('https://your-app.com');
- *    // Continue with your test...
- *  });
- * ```
- *
- */
-export declare const setupClerkTestingToken: ({ page, options }: BypassBotProtectionParams) => Promise<void>;
-export {};
-//# sourceMappingURL=setupClerkTestingToken.d.ts.map

package/dist/types/setupClerkTestingToken.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"setupClerkTestingToken.d.ts","sourceRoot":"","sources":["../../src/playwright/setupClerkTestingToken.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7C,KAAK,yBAAyB,GAAG;IAC/B,IAAI,EAAE,IAAI,CAAC;IACX,OAAO,CAAC,EAAE;QAMR,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB,CAAC;CACH,CAAC;AAIF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,sBAAsB,sBAA6B,yBAAyB,kBAmBxF,CAAC"}