Skip to content

Commit 26a5cc5

Browse files
desiprisgdesiprisg
committed
chore(repo): Move error helpers to shared package
1 parent 6682eaa commit 26a5cc5

File tree

12 files changed

+142
-109
lines changed

12 files changed

+142
-109
lines changed

‎.changeset/beige-tips-divide.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
'@clerk/nextjs': minor
3+
'@clerk/shared': minor
4+
'@clerk/clerk-react': minor
5+
'@clerk/clerk-expo': minor
6+
---
7+
8+
Export error helpers from the shared package to the framework specific packages

‎packages/clerk-js/src/core/resources/Error.ts

+12-89
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,12 @@
1-
import type { ClerkAPIError, ClerkAPIErrorJSON } from '@clerk/types';
2-
3-
interface ClerkAPIResponseOptions {
4-
data: ClerkAPIErrorJSON[];
5-
status: number;
6-
}
7-
8-
// For a comprehensive Metamask error list, please see
9-
// https://docs.metamask.io/guide/ethereum-provider.html#errors
10-
export interface MetamaskError extends Error {
11-
code: 4001 | 32602 | 32603;
12-
message: string;
13-
data?: unknown;
14-
}
15-
16-
export function isKnownError(error: any) {
17-
return isClerkAPIResponseError(error) || isMetamaskError(error);
18-
}
19-
20-
export function isClerkAPIResponseError(err: any): err is ClerkAPIResponseError {
21-
return 'clerkError' in err;
22-
}
23-
24-
export function isMetamaskError(err: any): err is MetamaskError {
25-
return 'code' in err && [4001, 32602, 32603].includes(err.code) && 'message' in err;
26-
}
27-
28-
export function parseErrors(data: ClerkAPIErrorJSON[] = []): ClerkAPIError[] {
29-
return data.length > 0 ? data.map(parseError) : [];
30-
}
31-
32-
export function parseError(error: ClerkAPIErrorJSON): ClerkAPIError {
33-
return {
34-
code: error.code,
35-
message: error.message,
36-
longMessage: error.long_message,
37-
meta: {
38-
paramName: error?.meta?.param_name,
39-
sessionId: error?.meta?.session_id,
40-
emailAddresses: error?.meta?.email_addresses,
41-
},
42-
};
43-
}
44-
45-
export class ClerkAPIResponseError extends Error {
46-
clerkError: true;
47-
48-
status: number;
49-
message: string;
50-
51-
errors: ClerkAPIError[];
52-
53-
constructor(message: string, { data, status }: ClerkAPIResponseOptions) {
54-
super(message);
55-
56-
Object.setPrototypeOf(this, ClerkAPIResponseError.prototype);
57-
58-
this.status = status;
59-
this.message = message;
60-
this.clerkError = true;
61-
this.errors = parseErrors(data);
62-
}
63-
64-
public toString = () => {
65-
return `[${this.name}]\nMessage:${this.message}\nStatus:${this.status}\nSerialized errors: ${this.errors.map(e =>
66-
JSON.stringify(e),
67-
)}`;
68-
};
69-
}
70-
71-
export class MagicLinkError extends Error {
72-
code: string;
73-
74-
constructor(code: string) {
75-
super(code);
76-
this.code = code;
77-
Object.setPrototypeOf(this, MagicLinkError.prototype);
78-
}
79-
}
80-
// Check if the error is a MagicLinkError.
81-
82-
export function isMagicLinkError(err: Error): err is MagicLinkError {
83-
return err instanceof MagicLinkError;
84-
}
85-
86-
export const MagicLinkErrorCode = {
87-
Expired: 'expired',
88-
Failed: 'failed',
89-
};
1+
export {
2+
isKnownError,
3+
isMagicLinkError,
4+
isMetamaskError,
5+
isClerkAPIResponseError,
6+
MagicLinkErrorCode,
7+
parseError,
8+
parseErrors,
9+
MagicLinkError,
10+
ClerkAPIResponseError,
11+
} from '@clerk/shared';
12+
export type { MetamaskError } from '@clerk/shared';

‎packages/clerk-js/src/ui/common/EmailLinkVerify.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1+
import { isMagicLinkError, MagicLinkErrorCode } from '@clerk/shared';
12
import React from 'react';
23

3-
import { isMagicLinkError, MagicLinkErrorCode } from '../../core/resources/Error';
44
import type { VerificationStatus } from '../../utils/getClerkQueryParam';
55
import { completeSignUpFlow } from '../components/SignUp/util';
66
import { useCoreClerk, useCoreSignUp } from '../contexts';

‎packages/clerk-js/src/ui/common/__tests__/verification.test.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
import { ClerkAPIResponseError } from '../../../core/resources/Error';
1+
import { ClerkAPIResponseError } from '@clerk/shared';
2+
23
import { isVerificationExpiredError, VerificationErrorMessage, verificationErrorMessage } from '../verification';
34

45
describe('verification utils', () => {

‎packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1+
import { ClerkAPIResponseError } from '@clerk/shared';
12
import type { MembershipRole, OrganizationResource } from '@clerk/types';
23
import React from 'react';
34

4-
import { ClerkAPIResponseError } from '../../../core/resources/Error';
55
import { Flex, Text } from '../../customizables';
66
import {
77
Alert,

‎packages/expo/src/index.ts

+3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ export {
2121
WithSession,
2222
withUser,
2323
WithUser,
24+
isClerkAPIResponseError,
2425
isMagicLinkError,
26+
isMetamaskError,
27+
isKnownError,
2528
MagicLinkErrorCode,
2629
} from '@clerk/clerk-react';
2730

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

+7-1
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,10 @@ export {
2222

2323
export type { WithUserProp, WithSessionProp, WithClerkProp } from '@clerk/clerk-react';
2424

25-
export { isMagicLinkError, MagicLinkErrorCode } from '@clerk/clerk-react';
25+
export {
26+
isClerkAPIResponseError,
27+
MagicLinkErrorCode,
28+
isKnownError,
29+
isMetamaskError,
30+
isMagicLinkError,
31+
} from '@clerk/clerk-react';

‎packages/nextjs/src/index.ts

+8-2
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,6 @@ export {
4747
useOrganizationList,
4848
useOrganizations,
4949
useMagicLink,
50-
MagicLinkErrorCode,
51-
isMagicLinkError,
5250
withUser,
5351
withSession,
5452
withClerk,
@@ -59,6 +57,14 @@ export {
5957

6058
export type { WithUserProp, WithSessionProp, WithClerkProp } from './client-boundary/hooks';
6159

60+
export {
61+
isClerkAPIResponseError,
62+
isMagicLinkError,
63+
isMetamaskError,
64+
isKnownError,
65+
MagicLinkErrorCode,
66+
} from '@clerk/clerk-react';
67+
6268
/**
6369
* Conditionally export components that exhibit different behavior
6470
* when used in /app vs /pages.

‎packages/react/src/errors.ts

+8-13
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
export {
2+
isMagicLinkError,
3+
MagicLinkErrorCode,
4+
isClerkAPIResponseError,
5+
isKnownError,
6+
isMetamaskError,
7+
} from '@clerk/shared';
8+
19
export const noFrontendApiError = 'Clerk: You must add the frontendApi prop to your <ClerkProvider>';
210

311
export const noClerkProviderError = 'Clerk: You must wrap your application in a <ClerkProvider> component.';
@@ -16,19 +24,6 @@ export const hocChildrenNotAFunctionError = 'Clerk: Child of WithClerk must be a
1624
export const multipleChildrenInButtonComponent = (name: string) =>
1725
`Clerk: You've passed multiple children components to <${name}/>. You can only pass a single child component or text.`;
1826

19-
export const MagicLinkErrorCode = {
20-
Expired: 'expired',
21-
Failed: 'failed',
22-
};
23-
24-
type MagicLinkError = {
25-
code: 'expired' | 'failed';
26-
};
27-
28-
export function isMagicLinkError(err: any): err is MagicLinkError {
29-
return !!err && (err.code === MagicLinkErrorCode.Expired || err.code === MagicLinkErrorCode.Failed);
30-
}
31-
3227
export const invalidStateError =
3328
'Invalid state. Feel free to submit a bug or reach out to support here: https://clerk.com/support';
3429

‎packages/react/src/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ export type {
1212
WithSessionProp,
1313
IsomorphicClerkOptions,
1414
} from './types';
15-
export { isMagicLinkError, MagicLinkErrorCode } from './errors';
15+
export { MagicLinkErrorCode, isClerkAPIResponseError, isKnownError, isMetamaskError, isMagicLinkError } from './errors';
1616
export { useMagicLink } from './hooks/useMagicLink';

‎packages/shared/src/errors/Error.ts

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
import type { ClerkAPIError, ClerkAPIErrorJSON } from '@clerk/types';
2+
3+
interface ClerkAPIResponseOptions {
4+
data: ClerkAPIErrorJSON[];
5+
status: number;
6+
}
7+
8+
// For a comprehensive Metamask error list, please see
9+
// https://docs.metamask.io/guide/ethereum-provider.html#errors
10+
export interface MetamaskError extends Error {
11+
code: 4001 | 32602 | 32603;
12+
message: string;
13+
data?: unknown;
14+
}
15+
16+
export function isKnownError(error: any) {
17+
return isClerkAPIResponseError(error) || isMetamaskError(error);
18+
}
19+
20+
export function isClerkAPIResponseError(err: any): err is ClerkAPIResponseError {
21+
return 'clerkError' in err;
22+
}
23+
24+
export function isMetamaskError(err: any): err is MetamaskError {
25+
return 'code' in err && [4001, 32602, 32603].includes(err.code) && 'message' in err;
26+
}
27+
28+
export function parseErrors(data: ClerkAPIErrorJSON[] = []): ClerkAPIError[] {
29+
return data.length > 0 ? data.map(parseError) : [];
30+
}
31+
32+
export function parseError(error: ClerkAPIErrorJSON): ClerkAPIError {
33+
return {
34+
code: error.code,
35+
message: error.message,
36+
longMessage: error.long_message,
37+
meta: {
38+
paramName: error?.meta?.param_name,
39+
sessionId: error?.meta?.session_id,
40+
emailAddresses: error?.meta?.email_addresses,
41+
},
42+
};
43+
}
44+
45+
export class ClerkAPIResponseError extends Error {
46+
clerkError: true;
47+
48+
status: number;
49+
message: string;
50+
51+
errors: ClerkAPIError[];
52+
53+
constructor(message: string, { data, status }: ClerkAPIResponseOptions) {
54+
super(message);
55+
56+
Object.setPrototypeOf(this, ClerkAPIResponseError.prototype);
57+
58+
this.status = status;
59+
this.message = message;
60+
this.clerkError = true;
61+
this.errors = parseErrors(data);
62+
}
63+
64+
public toString = () => {
65+
return `[${this.name}]\nMessage:${this.message}\nStatus:${this.status}\nSerialized errors: ${this.errors.map(e =>
66+
JSON.stringify(e),
67+
)}`;
68+
};
69+
}
70+
71+
export class MagicLinkError extends Error {
72+
code: string;
73+
74+
constructor(code: string) {
75+
super(code);
76+
this.code = code;
77+
Object.setPrototypeOf(this, MagicLinkError.prototype);
78+
}
79+
}
80+
// Check if the error is a MagicLinkError.
81+
82+
export function isMagicLinkError(err: Error): err is MagicLinkError {
83+
return err instanceof MagicLinkError;
84+
}
85+
86+
export const MagicLinkErrorCode = {
87+
Expired: 'expired',
88+
Failed: 'failed',
89+
};

‎packages/shared/src/index.ts

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
export { buildErrorThrower } from './errors/thrower';
55
export type { ErrorThrower, ErrorThrowerOptions } from './errors/thrower';
66

7+
export * from './errors/Error';
8+
79
/**
810
* Utils
911
*/

0 commit comments

Comments
 (0)