Skip to content

Commit ee57f21

Browse files
nikosdouvlisnikosdouvlis
authored
fix(remix,nextjs,clerk-react): Export EmailLinkErrorCode from /errors (clerk#2732)
1 parent 3c97708 commit ee57f21

File tree

17 files changed

+147
-93
lines changed

17 files changed

+147
-93
lines changed

‎.changeset/hungry-bottles-flow.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
'@clerk/nextjs': patch
3+
'@clerk/clerk-react': patch
4+
'@clerk/remix': patch
5+
---
6+
7+
Export `EmailLinkErrorCode` from `/errors` module

‎.changeset/light-buckets-check.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@clerk/remix': patch
3+
---
4+
5+
Introduce `/errors` module. This path exports all error-related APIs such as `isClerkAPIResponseError`, `isEmailLinkError`, `isKnownError`, `isMetamaskError`, `EmailLinkErrorCode`

‎packages/nextjs/src/client-boundary/hooks.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,10 @@ export {
1313
useUser,
1414
} from '@clerk/clerk-react';
1515

16-
export { isClerkAPIResponseError, isEmailLinkError, isKnownError, isMetamaskError } from '@clerk/clerk-react/errors';
16+
export {
17+
isClerkAPIResponseError,
18+
isEmailLinkError,
19+
isKnownError,
20+
isMetamaskError,
21+
EmailLinkErrorCode,
22+
} from '@clerk/clerk-react/errors';

‎packages/nextjs/src/errors.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
export { isClerkAPIResponseError, isEmailLinkError, isKnownError, isMetamaskError } from './client-boundary/hooks';
1+
export {
2+
isClerkAPIResponseError,
3+
isEmailLinkError,
4+
isKnownError,
5+
isMetamaskError,
6+
EmailLinkErrorCode,
7+
} from './client-boundary/hooks';

‎packages/react/src/errors.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
export { isClerkAPIResponseError, isEmailLinkError, isKnownError, isMetamaskError } from '@clerk/shared/error';
1+
export {
2+
isClerkAPIResponseError,
3+
isEmailLinkError,
4+
isKnownError,
5+
isMetamaskError,
6+
EmailLinkErrorCode,
7+
} from '@clerk/shared/error';

‎packages/remix/api.server/package.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"main": "../dist/api/index.js",
3+
"types": "../dist/api/index.d.ts"
4+
}

‎packages/remix/errors/package.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"main": "../dist/errors.js",
3+
"types": "../dist/errors.d.ts"
4+
}

‎packages/remix/package.json

+4
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@
3636
"./api.server": {
3737
"types": "./dist/api/index.d.ts",
3838
"default": "./dist/api/index.js"
39+
},
40+
"./errors": {
41+
"types": "./dist/errors.d.ts",
42+
"default": "./dist/errors.js"
3943
}
4044
},
4145
"main": "dist/index.js",

‎packages/remix/src/errors.ts

+7-84
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,7 @@
1-
const createErrorMessage = (msg: string) => {
2-
return `🔒 Clerk: ${msg.trim()}
3-
4-
For more info, check out the docs: https://clerk.com/docs,
5-
or come say hi in our discord server: https://clerk.com/discord
6-
7-
`;
8-
};
9-
10-
const ssrExample = `Use 'rootAuthLoader' as your root loader. Then, simply wrap the App component with ClerkApp and make it the default export.
11-
Example:
12-
13-
import { ClerkApp } from '@clerk/remix';
14-
import { rootAuthLoader } from '@clerk/remix/ssr.server';
15-
16-
export const loader: LoaderFunction = args => rootAuthLoader(args)
17-
18-
function App() {
19-
return (
20-
<html lang='en'>
21-
...
22-
</html>
23-
);
24-
}
25-
26-
export default ClerkApp(App, { publishableKey: '...' });
27-
`;
28-
29-
export const invalidClerkStatePropError = createErrorMessage(`
30-
You're trying to pass an invalid object in "<ClerkProvider clerkState={...}>".
31-
32-
${ssrExample}
33-
`);
34-
35-
export const noClerkStateError = createErrorMessage(`
36-
Looks like you didn't pass 'clerkState' to "<ClerkProvider clerkState={...}>".
37-
38-
${ssrExample}
39-
`);
40-
41-
export const noLoaderArgsPassedInGetAuth = createErrorMessage(`
42-
You're calling 'getAuth()' from a loader, without providing the loader args object.
43-
Example:
44-
45-
export const loader: LoaderFunction = async (args) => {
46-
const { sessionId } = await getAuth(args);
47-
...
48-
};
49-
`);
50-
51-
export const invalidRootLoaderCallbackReturn = createErrorMessage(`
52-
You're returning an invalid response from the 'rootAuthLoader' called from the loader in root.tsx.
53-
You can only return plain objects, responses created using the Remix 'json()' and 'redirect()' helpers,
54-
custom redirect 'Response' instances (status codes in the range of 300 to 400),
55-
or custom json 'Response' instances (containing a body that is a valid json string).
56-
If you want to return a primitive value or an array, you can always wrap the response with an object.
57-
58-
Example:
59-
60-
export const loader: LoaderFunction = args => rootAuthLoader(args, ({ auth }) => {
61-
const { userId } = auth;
62-
const posts: Post[] = database.getPostsByUserId(userId);
63-
64-
return json({ data: posts })
65-
// or
66-
return new Response(JSON.stringify({ data: posts }), { headers: { 'Content-Type': 'application/json' } });
67-
// or
68-
return { data: posts };
69-
})
70-
`);
71-
72-
export const noSecretKeyError = createErrorMessage(`
73-
A secretKey must be provided in order to use SSR and the exports from @clerk/remix/api.');
74-
If your runtime supports environment variables, you can add a CLERK_SECRET_KEY variable to your config.
75-
Otherwise, you can pass a secretKey parameter to rootAuthLoader or getAuth.
76-
`);
77-
78-
export const satelliteAndMissingProxyUrlAndDomain = createErrorMessage(
79-
`Missing domain and proxyUrl. A satellite application needs to specify a domain or a proxyUrl`,
80-
);
81-
82-
export const satelliteAndMissingSignInUrl = createErrorMessage(`
83-
Invalid signInUrl. A satellite application requires a signInUrl for development instances.
84-
Check if signInUrl is missing from your configuration or if it is not an absolute URL.`);
1+
export {
2+
isClerkAPIResponseError,
3+
isEmailLinkError,
4+
isKnownError,
5+
isMetamaskError,
6+
EmailLinkErrorCode,
7+
} from '@clerk/clerk-react/errors';

‎packages/remix/src/ssr/getAuth.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { stripPrivateDataFromObject } from '@clerk/backend/internal';
22

3-
import { noLoaderArgsPassedInGetAuth } from '../errors';
3+
import { noLoaderArgsPassedInGetAuth } from '../utils/errors';
44
import { authenticateRequest } from './authenticateRequest';
55
import { loadOptions } from './loadOptions';
66
import type { GetAuthReturn, LoaderFunctionArgs, RootAuthLoaderOptions } from './types';

‎packages/remix/src/ssr/loadOptions.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ import { isDevelopmentFromSecretKey } from '@clerk/shared/keys';
55
import { isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared/proxy';
66
import { isTruthy } from '@clerk/shared/underscore';
77

8-
import { noSecretKeyError, satelliteAndMissingProxyUrlAndDomain, satelliteAndMissingSignInUrl } from '../errors';
9-
import { getEnvVariable } from '../utils';
8+
import { noSecretKeyError, satelliteAndMissingProxyUrlAndDomain, satelliteAndMissingSignInUrl } from '../utils/errors';
9+
import { getEnvVariable } from '../utils/utils';
1010
import type { LoaderFunctionArgs, RootAuthLoaderOptions } from './types';
1111

1212
export const loadOptions = (args: LoaderFunctionArgs, overrides: RootAuthLoaderOptions = {}) => {

‎packages/remix/src/ssr/rootAuthLoader.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { decorateObjectWithResources } from '@clerk/backend/internal';
22
import type { defer } from '@remix-run/server-runtime';
33
import { isDeferredData } from '@remix-run/server-runtime/dist/responses';
44

5-
import { invalidRootLoaderCallbackReturn } from '../errors';
5+
import { invalidRootLoaderCallbackReturn } from '../utils/errors';
66
import { authenticateRequest } from './authenticateRequest';
77
import { loadOptions } from './loadOptions';
88
import type { LoaderFunctionArgs, LoaderFunctionReturn, RootAuthLoaderCallback, RootAuthLoaderOptions } from './types';

‎packages/remix/src/ssr/utils.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import type { AppLoadContext, defer } from '@remix-run/server-runtime';
55
import { json } from '@remix-run/server-runtime';
66
import cookie from 'cookie';
77

8-
import { getEnvVariable } from '../utils';
8+
import { getEnvVariable } from '../utils/utils';
99

1010
export function isResponse(value: any): value is Response {
1111
return (

‎packages/remix/src/utils/errors.ts

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
const createErrorMessage = (msg: string) => {
2+
return `🔒 Clerk: ${msg.trim()}
3+
4+
For more info, check out the docs: https://clerk.com/docs,
5+
or come say hi in our discord server: https://clerk.com/discord
6+
7+
`;
8+
};
9+
10+
const ssrExample = `Use 'rootAuthLoader' as your root loader. Then, simply wrap the App component with ClerkApp and make it the default export.
11+
Example:
12+
13+
import { ClerkApp } from '@clerk/remix';
14+
import { rootAuthLoader } from '@clerk/remix/ssr.server';
15+
16+
export const loader: LoaderFunction = args => rootAuthLoader(args)
17+
18+
function App() {
19+
return (
20+
<html lang='en'>
21+
...
22+
</html>
23+
);
24+
}
25+
26+
export default ClerkApp(App, { publishableKey: '...' });
27+
`;
28+
29+
export const invalidClerkStatePropError = createErrorMessage(`
30+
You're trying to pass an invalid object in "<ClerkProvider clerkState={...}>".
31+
32+
${ssrExample}
33+
`);
34+
35+
export const noClerkStateError = createErrorMessage(`
36+
Looks like you didn't pass 'clerkState' to "<ClerkProvider clerkState={...}>".
37+
38+
${ssrExample}
39+
`);
40+
41+
export const noLoaderArgsPassedInGetAuth = createErrorMessage(`
42+
You're calling 'getAuth()' from a loader, without providing the loader args object.
43+
Example:
44+
45+
export const loader: LoaderFunction = async (args) => {
46+
const { sessionId } = await getAuth(args);
47+
...
48+
};
49+
`);
50+
51+
export const invalidRootLoaderCallbackReturn = createErrorMessage(`
52+
You're returning an invalid response from the 'rootAuthLoader' called from the loader in root.tsx.
53+
You can only return plain objects, responses created using the Remix 'json()' and 'redirect()' helpers,
54+
custom redirect 'Response' instances (status codes in the range of 300 to 400),
55+
or custom json 'Response' instances (containing a body that is a valid json string).
56+
If you want to return a primitive value or an array, you can always wrap the response with an object.
57+
58+
Example:
59+
60+
export const loader: LoaderFunction = args => rootAuthLoader(args, ({ auth }) => {
61+
const { userId } = auth;
62+
const posts: Post[] = database.getPostsByUserId(userId);
63+
64+
return json({ data: posts })
65+
// or
66+
return new Response(JSON.stringify({ data: posts }), { headers: { 'Content-Type': 'application/json' } });
67+
// or
68+
return { data: posts };
69+
})
70+
`);
71+
72+
export const noSecretKeyError = createErrorMessage(`
73+
A secretKey must be provided in order to use SSR and the exports from @clerk/remix/api.');
74+
If your runtime supports environment variables, you can add a CLERK_SECRET_KEY variable to your config.
75+
Otherwise, you can pass a secretKey parameter to rootAuthLoader or getAuth.
76+
`);
77+
78+
export const satelliteAndMissingProxyUrlAndDomain = createErrorMessage(
79+
`Missing domain and proxyUrl. A satellite application needs to specify a domain or a proxyUrl`,
80+
);
81+
82+
export const satelliteAndMissingSignInUrl = createErrorMessage(`
83+
Invalid signInUrl. A satellite application requires a signInUrl for development instances.
84+
Check if signInUrl is missing from your configuration or if it is not an absolute URL.`);

‎packages/remix/src/utils/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export * from './utils';

‎packages/remix/src/utils.ts ‎packages/remix/src/utils/utils.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import type { AppLoadContext } from '@remix-run/server-runtime';
22

3-
import type { ClerkState } from './client/types';
3+
import type { ClerkState } from '../client/types';
44
import { invalidClerkStatePropError, noClerkStateError } from './errors';
55

66
export function warnForSsr(val: ClerkState | undefined) {

‎packages/remix/ssr.server/package.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"main": "../dist/ssr/index.js",
3+
"types": "../dist/ssr/index.d.ts"
4+
}

0 commit comments

Comments
 (0)