chore(backend): Drop deserialize from top-level export

clerk · Dec 15, 2023 · d225d56 · d225d56
1 parent 077642b
commit d225d56
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 3 deletions.
diff --git a/.changeset/fifty-snakes-accept.md b/.changeset/fifty-snakes-accept.md
@@ -0,0 +1,12 @@
+---
+'@clerk/clerk-sdk-node': major
+---
+
+Internal top-level BAPI resources was dropped to resolve some issues with our type resolution and also make our exposed API cleaner.
+```typescript
+// Before
+import { users } from "@clerk/clerk-sdk-node"
+// After
+import { clerkClient } from "@clerk/clerk-sdk-node"
+clerkClient.users
+```
diff --git a/.changeset/tasty-terms-fly.md b/.changeset/tasty-terms-fly.md
@@ -0,0 +1,23 @@
+---
+'@clerk/clerk-sdk-node': major
+'@clerk/backend': major
+'@clerk/nextjs': major
+---
+
+Changes in `@clerk/backend` exports:
+- Drop Internal `deserialize` helper
+- Introduce `/errors` subpath export, eg:
+    ```typescript
+    import { 
+        TokenVerificationError,
+        TokenVerificationErrorAction,
+        TokenVerificationErrorCode,
+        TokenVerificationErrorReason } from '@clerk/backend/errors';
+    ```
+- Drop errors from top-level export
+    ```typescript
+    // Before
+    import { TokenVerificationError, TokenVerificationErrorReason } from '@clerk/backend';
+    // After
+    import { TokenVerificationError, TokenVerificationErrorReason } from '@clerk/backend/errors';
+    ```
diff --git a/packages/backend/src/__tests__/exports.test.ts b/packages/backend/src/__tests__/exports.test.ts
@@ -39,7 +39,6 @@ export default (QUnit: QUnit) => {
         'createIsomorphicRequest',
         'debugRequestState',
         'decodeJwt',
-        'deserialize',
         'hasValidSignature',
         'makeAuthObjectSerializable',
         'prunePrivateMetadata',

diff --git a/packages/backend/src/api/resources/index.ts b/packages/backend/src/api/resources/index.ts
@@ -1,7 +1,6 @@
 export * from './AllowlistIdentifier';
 export * from './Client';
 export * from './DeletedObject';
-export * from './Deserializer';
 export * from './Email';
 export * from './EmailAddress';
 

diff --git a/packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap b/packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap
@@ -37,7 +37,6 @@ exports[`module exports should not change unless explicitly set 1`] = `
   "createIsomorphicRequest",
   "debugRequestState",
   "decodeJwt",
-  "deserialize",
   "hasValidSignature",
   "makeAuthObjectSerializable",
   "prunePrivateMetadata",