Skip to content

Commit 26254f0

Browse files
authored
chore(shared): Remove top-level exports (#6940)
1 parent c605f19 commit 26254f0

File tree

5 files changed

+11
-85
lines changed

5 files changed

+11
-85
lines changed

.changeset/twenty-rockets-stop.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@clerk/shared': major
3+
---
4+
5+
Removing deprecated top-level exports from @clerk/shared

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

Lines changed: 0 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -141,51 +141,9 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
141141
"types/user-organization-invitation-resource.mdx",
142142
"types/user-resource.mdx",
143143
"types/without.mdx",
144-
"shared/api-url-from-publishable-key.mdx",
145-
"shared/build-clerk-js-script-attributes.mdx",
146-
"shared/build-publishable-key.mdx",
147-
"shared/camel-to-snake.mdx",
148-
"shared/clerk-js-script-url.mdx",
149-
"shared/clerk-runtime-error.mdx",
150-
"shared/create-dev-or-staging-url-cache.mdx",
151-
"shared/create-path-matcher.mdx",
152-
"shared/deep-camel-to-snake.mdx",
153-
"shared/deep-snake-to-camel.mdx",
154-
"shared/deprecated-object-property.mdx",
155-
"shared/derive-state.mdx",
156-
"shared/extract-dev-browser-jwt-from-url.mdx",
157-
"shared/fast-deep-merge-and-replace.mdx",
158-
"shared/get-clerk-js-major-version-or-tag.mdx",
159-
"shared/get-cookie-suffix.mdx",
160-
"shared/get-env-variable.mdx",
161-
"shared/get-non-undefined-values.mdx",
162-
"shared/get-script-url.mdx",
163-
"shared/get-suffixed-cookie-name.mdx",
164-
"shared/icon-image-url.mdx",
165-
"shared/in-browser.mdx",
166-
"shared/is-browser-online.mdx",
167-
"shared/is-clerk-runtime-error.mdx",
168-
"shared/is-development-from-publishable-key.mdx",
169-
"shared/is-development-from-secret-key.mdx",
170-
"shared/is-ipv4-address.mdx",
171-
"shared/is-production-from-publishable-key.mdx",
172-
"shared/is-production-from-secret-key.mdx",
173-
"shared/is-publishable-key.mdx",
174-
"shared/is-staging.mdx",
175-
"shared/is-truthy.mdx",
176-
"shared/is-valid-browser-online.mdx",
177-
"shared/is-valid-browser.mdx",
178-
"shared/isomorphic-atob.mdx",
179-
"shared/load-clerk-js-script.mdx",
180144
"shared/pages-or-infinite-options.mdx",
181145
"shared/paginated-hook-config.mdx",
182146
"shared/paginated-resources.mdx",
183-
"shared/parse-publishable-key.mdx",
184-
"shared/read-json-file.mdx",
185-
"shared/set-clerk-js-loading-error-package-name.mdx",
186-
"shared/snake-to-camel.mdx",
187-
"shared/titleize.mdx",
188-
"shared/to-sentence.mdx",
189147
"shared/use-clerk.mdx",
190148
"shared/use-organization-list-params.mdx",
191149
"shared/use-organization-list-return.mdx",
@@ -197,8 +155,6 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
197155
"shared/use-session-list.mdx",
198156
"shared/use-session.mdx",
199157
"shared/use-user.mdx",
200-
"shared/user-agent-is-robot.mdx",
201-
"shared/version-selector.mdx",
202158
"react/api-keys.mdx",
203159
"react/checkout-button-props.mdx",
204160
"react/checkout-button.mdx",

packages/elements/src/internals/errors/index.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
// eslint-disable-next-line no-restricted-imports
2-
import type { MetamaskError } from '@clerk/shared';
1+
import type { MetamaskError } from '@clerk/shared/error';
32
import type { ClerkAPIError } from '@clerk/types';
43

54
export abstract class ClerkElementsErrorBase extends Error {

packages/shared/src/index.ts

Lines changed: 4 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,5 @@
1-
/** The following files are not exported on purpose:
2-
* - cookie.ts
3-
* - globs.ts
4-
*
5-
* The following folders are also not exported on purpose:
6-
* - react
7-
*
8-
* People should always use @clerk/shared/<name> instead
9-
*/
1+
throw new Error(
2+
'Do not import from the top-level of @clerk/shared directly. Import from specific subpaths like @clerk/shared/react or @clerk/shared/authorization instead.',
3+
);
104

11-
export * from './utils';
12-
13-
export { apiUrlFromPublishableKey } from './apiUrlFromPublishableKey';
14-
export * from './browser';
15-
export * from './color';
16-
export * from './constants';
17-
export * from './date';
18-
export * from './deprecated';
19-
export { deriveState } from './deriveState';
20-
export * from './error';
21-
export * from './file';
22-
export { isomorphicAtob } from './isomorphicAtob';
23-
export { isomorphicBtoa } from './isomorphicBtoa';
24-
export * from './keys';
25-
export * from './loadClerkJsScript';
26-
export { loadScript } from './loadScript';
27-
export { LocalStorageBroadcastChannel } from './localStorageBroadcastChannel';
28-
export * from './poller';
29-
export * from './proxy';
30-
export * from './underscore';
31-
export * from './url';
32-
export { versionSelector } from './versionSelector';
33-
export * from './object';
34-
export * from './logger';
35-
export { createWorkerTimers } from './workerTimers';
36-
export { DEV_BROWSER_JWT_KEY, extractDevBrowserJWTFromURL, setDevBrowserJWTInURL } from './devBrowser';
37-
export { getEnvVariable } from './getEnvVariable';
38-
export * from './pathMatcher';
39-
export * from './netlifyCacheHandler';
5+
export {};

packages/shared/src/react/hooks/useCheckout.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import type {
66
} from '@clerk/types';
77
import { useMemo, useSyncExternalStore } from 'react';
88

9-
import type { ClerkAPIResponseError } from '../..';
9+
import type { ClerkAPIResponseError } from '../../error';
1010
import type { __experimental_CheckoutProvider } from '../contexts';
1111
import { useCheckoutContext } from '../contexts';
1212
import { useClerk } from './useClerk';

0 commit comments

Comments
 (0)