From 1ee0cf11f4adfebe5f040b5c8f46e1cb808dc456 Mon Sep 17 00:00:00 2001 From: Dimitris Klouvas Date: Thu, 14 Dec 2023 22:38:38 +0200 Subject: [PATCH] chore(backend): Drop api/resources from exports --- .changeset/silver-weeks-roll.md | 45 +++++++++++++++++++ .../backend/src/__tests__/exports.test.ts | 27 +---------- packages/backend/src/index.ts | 2 +- .../__snapshots__/exports.test.ts.snap | 22 --------- 4 files changed, 47 insertions(+), 49 deletions(-) create mode 100644 .changeset/silver-weeks-roll.md diff --git a/.changeset/silver-weeks-roll.md b/.changeset/silver-weeks-roll.md new file mode 100644 index 00000000000..9c438f3e08c --- /dev/null +++ b/.changeset/silver-weeks-roll.md @@ -0,0 +1,45 @@ +--- +'gatsby-plugin-clerk': major +'@clerk/clerk-sdk-node': major +'@clerk/backend': major +'@clerk/fastify': major +'@clerk/nextjs': major +'@clerk/remix': major +--- + + +Changes in exports of `@clerk/backend`: +- Drop the following internal exports from the top-level api: + ```typescript + // Before + import { + AllowlistIdentifier, + Client, + DeletedObject, + Email, + EmailAddress, + ExternalAccount, + IdentificationLink, + Invitation, + OauthAccessToken, + ObjectType, + Organization, + OrganizationInvitation, + OrganizationMembership, + OrganizationMembershipPublicUserData, + PhoneNumber, + RedirectUrl, + SMSMessage, + Session, + SignInToken, + Token, + User, + Verification } from '@clerk/backend'; + // After : no alternative since there is no need to use those classes + ``` + Dropping those exports results in also dropping the exports from `gatsby-plugin-clerk`, `@clerk/clerk-sdk-node`, `@clerk/backend`, `@clerk/fastify`, `@clerk/nextjs`, `@clerk/remix` packages. +- Keep those 3 resource related type exports + ```typescript + import type { Organization, Session, User, WebhookEvent, + WebhookEventType } from '@clerk/backend' + ``` diff --git a/packages/backend/src/__tests__/exports.test.ts b/packages/backend/src/__tests__/exports.test.ts index 218ca170fe9..44aaa2935d7 100644 --- a/packages/backend/src/__tests__/exports.test.ts +++ b/packages/backend/src/__tests__/exports.test.ts @@ -10,32 +10,7 @@ export default (QUnit: QUnit) => { module('public exports', () => { test('should not include a breaking change', assert => { - const exportedApiKeys = [ - 'AllowlistIdentifier', - 'Client', - 'DeletedObject', - 'Email', - 'EmailAddress', - 'ExternalAccount', - 'IdentificationLink', - 'Invitation', - 'OauthAccessToken', - 'ObjectType', - 'Organization', - 'OrganizationInvitation', - 'OrganizationMembership', - 'OrganizationMembershipPublicUserData', - 'PhoneNumber', - 'RedirectUrl', - 'SMSMessage', - 'Session', - 'SignInToken', - 'Token', - 'User', - 'Verification', - 'createClerkClient', - 'verifyToken', - ]; + const exportedApiKeys = ['createClerkClient', 'verifyToken']; assert.deepEqual(Object.keys(publicExports).sort(), exportedApiKeys); }); }); diff --git a/packages/backend/src/index.ts b/packages/backend/src/index.ts index 6247e2ae826..ea277052e8c 100644 --- a/packages/backend/src/index.ts +++ b/packages/backend/src/index.ts @@ -7,7 +7,7 @@ import { createBackendApiClient } from './api'; import type { CreateAuthenticateRequestOptions } from './tokens/factory'; import { createAuthenticateRequest } from './tokens/factory'; -export * from './api/resources'; +export type { Organization, Session, User, WebhookEvent, WebhookEventType } from './api/resources'; export type { VerifyTokenOptions } from './tokens/verify'; export { verifyToken } from './tokens/verify'; diff --git a/packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap b/packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap index fc8b0ee9659..aa792c20c1f 100644 --- a/packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap +++ b/packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap @@ -2,30 +2,8 @@ exports[`module exports should not change unless explicitly set 1`] = ` [ - "AllowlistIdentifier", "ClerkExpressRequireAuth", "ClerkExpressWithAuth", - "Client", - "DeletedObject", - "Email", - "EmailAddress", - "ExternalAccount", - "IdentificationLink", - "Invitation", - "OauthAccessToken", - "ObjectType", - "Organization", - "OrganizationInvitation", - "OrganizationMembership", - "OrganizationMembershipPublicUserData", - "PhoneNumber", - "RedirectUrl", - "SMSMessage", - "Session", - "SignInToken", - "Token", - "User", - "Verification", "clerkClient", "createClerkClient", "createClerkExpressRequireAuth",