@stackframe/stack-shared 2.7.0 → 2.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/dist/interface/crud/current-user.d.ts +3 -3
- package/dist/interface/crud/current-user.js +2 -3
- package/dist/interface/crud/projects.js +27 -9
- package/dist/known-errors.d.ts +0 -15
- package/dist/known-errors.js +1 -33
- package/dist/schema-fields.d.ts +3 -1
- package/dist/schema-fields.js +13 -4
- package/dist/utils/objects.d.ts +0 -2
- package/dist/utils/objects.js +0 -19
- package/dist/utils/strings.d.ts +0 -2
- package/dist/utils/strings.js +0 -10
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { CrudTypeOf } from "../../crud";
|
|
2
2
|
export declare const currentUserCrud: import("../../crud").CrudSchemaFromOptions<{
|
|
3
|
-
clientReadSchema: import("yup").ObjectSchema<
|
|
3
|
+
clientReadSchema: import("yup").ObjectSchema<{
|
|
4
4
|
primary_email: string | null;
|
|
5
5
|
id: string;
|
|
6
6
|
display_name: string | null;
|
|
@@ -28,7 +28,7 @@ export declare const currentUserCrud: import("../../crud").CrudSchemaFromOptions
|
|
|
28
28
|
display_name: string;
|
|
29
29
|
profile_image_url: string | null;
|
|
30
30
|
} | null;
|
|
31
|
-
}
|
|
31
|
+
}, import("yup").AnyObject, {
|
|
32
32
|
id: undefined;
|
|
33
33
|
primary_email: undefined;
|
|
34
34
|
primary_email_verified: undefined;
|
|
@@ -87,7 +87,7 @@ export declare const currentUserCrud: import("../../crud").CrudSchemaFromOptions
|
|
|
87
87
|
}[];
|
|
88
88
|
auth_with_email: boolean;
|
|
89
89
|
requires_totp_mfa: boolean;
|
|
90
|
-
}
|
|
90
|
+
}, import("yup").AnyObject, {
|
|
91
91
|
id: undefined;
|
|
92
92
|
primary_email: undefined;
|
|
93
93
|
primary_email_verified: undefined;
|
|
@@ -30,9 +30,8 @@ const clientReadSchema = usersCrudServerReadSchema.pick([
|
|
|
30
30
|
"passkey_auth_enabled",
|
|
31
31
|
]).concat(yupObject({
|
|
32
32
|
selected_team: teamsCrudClientReadSchema.nullable().defined(),
|
|
33
|
-
})).
|
|
34
|
-
|
|
35
|
-
const serverReadSchema = usersCrudServerReadSchema.nullable().defined();
|
|
33
|
+
})).defined();
|
|
34
|
+
const serverReadSchema = usersCrudServerReadSchema.defined();
|
|
36
35
|
const clientDeleteSchema = usersCrudServerDeleteSchema;
|
|
37
36
|
export const currentUserCrud = createCrud({
|
|
38
37
|
clientReadSchema,
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { createCrud } from "../../crud";
|
|
2
2
|
import * as schemaFields from "../../schema-fields";
|
|
3
|
-
import { yupArray,
|
|
3
|
+
import { yupArray, yupObject, yupString } from "../../schema-fields";
|
|
4
4
|
const teamPermissionSchema = yupObject({
|
|
5
5
|
id: yupString().defined(),
|
|
6
6
|
}).defined();
|
|
@@ -8,8 +8,14 @@ const oauthProviderSchema = yupObject({
|
|
|
8
8
|
id: schemaFields.oauthIdSchema.defined(),
|
|
9
9
|
enabled: schemaFields.oauthEnabledSchema.defined(),
|
|
10
10
|
type: schemaFields.oauthTypeSchema.defined(),
|
|
11
|
-
client_id:
|
|
12
|
-
|
|
11
|
+
client_id: schemaFields.yupDefinedAndNonEmptyWhen(schemaFields.oauthClientIdSchema, {
|
|
12
|
+
type: 'standard',
|
|
13
|
+
enabled: true,
|
|
14
|
+
}),
|
|
15
|
+
client_secret: schemaFields.yupDefinedAndNonEmptyWhen(schemaFields.oauthClientSecretSchema, {
|
|
16
|
+
type: 'standard',
|
|
17
|
+
enabled: true,
|
|
18
|
+
}),
|
|
13
19
|
// extra params
|
|
14
20
|
facebook_config_id: schemaFields.oauthFacebookConfigIdSchema.optional(),
|
|
15
21
|
microsoft_tenant_id: schemaFields.oauthMicrosoftTenantIdSchema.optional(),
|
|
@@ -19,12 +25,24 @@ const enabledOAuthProviderSchema = yupObject({
|
|
|
19
25
|
});
|
|
20
26
|
export const emailConfigSchema = yupObject({
|
|
21
27
|
type: schemaFields.emailTypeSchema.defined(),
|
|
22
|
-
host:
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
+
host: schemaFields.yupDefinedAndNonEmptyWhen(schemaFields.emailHostSchema, {
|
|
29
|
+
type: 'standard',
|
|
30
|
+
}),
|
|
31
|
+
port: schemaFields.yupDefinedWhen(schemaFields.emailPortSchema, {
|
|
32
|
+
type: 'standard',
|
|
33
|
+
}),
|
|
34
|
+
username: schemaFields.yupDefinedAndNonEmptyWhen(schemaFields.emailUsernameSchema, {
|
|
35
|
+
type: 'standard',
|
|
36
|
+
}),
|
|
37
|
+
password: schemaFields.yupDefinedAndNonEmptyWhen(schemaFields.emailPasswordSchema, {
|
|
38
|
+
type: 'standard',
|
|
39
|
+
}),
|
|
40
|
+
sender_name: schemaFields.yupDefinedAndNonEmptyWhen(schemaFields.emailSenderNameSchema, {
|
|
41
|
+
type: 'standard',
|
|
42
|
+
}),
|
|
43
|
+
sender_email: schemaFields.yupDefinedAndNonEmptyWhen(schemaFields.emailSenderEmailSchema, {
|
|
44
|
+
type: 'standard',
|
|
45
|
+
}),
|
|
28
46
|
});
|
|
29
47
|
const domainSchema = yupObject({
|
|
30
48
|
domain: schemaFields.projectTrustedDomainSchema.defined(),
|
package/dist/known-errors.d.ts
CHANGED
|
@@ -66,21 +66,6 @@ export declare const KnownErrors: {
|
|
|
66
66
|
} & KnownErrorBrand<"INVALID_PROJECT_AUTHENTICATION">, [statusCode: number, humanReadableMessage: string, details?: Json | undefined]> & {
|
|
67
67
|
errorCode: "INVALID_PROJECT_AUTHENTICATION";
|
|
68
68
|
};
|
|
69
|
-
ProjectKeyWithoutRequestType: KnownErrorConstructor<KnownError & KnownErrorBrand<"PROJECT_AUTHENTICATION_ERROR"> & {
|
|
70
|
-
constructorArgs: [statusCode: number, humanReadableMessage: string, details?: Json | undefined];
|
|
71
|
-
} & KnownErrorBrand<"INVALID_PROJECT_AUTHENTICATION"> & KnownErrorBrand<"PROJECT_KEY_WITHOUT_REQUEST_TYPE">, []> & {
|
|
72
|
-
errorCode: "PROJECT_KEY_WITHOUT_REQUEST_TYPE";
|
|
73
|
-
};
|
|
74
|
-
InvalidRequestType: KnownErrorConstructor<KnownError & KnownErrorBrand<"PROJECT_AUTHENTICATION_ERROR"> & {
|
|
75
|
-
constructorArgs: [statusCode: number, humanReadableMessage: string, details?: Json | undefined];
|
|
76
|
-
} & KnownErrorBrand<"INVALID_PROJECT_AUTHENTICATION"> & KnownErrorBrand<"INVALID_REQUEST_TYPE">, [requestType: string]> & {
|
|
77
|
-
errorCode: "INVALID_REQUEST_TYPE";
|
|
78
|
-
};
|
|
79
|
-
RequestTypeWithoutProjectId: KnownErrorConstructor<KnownError & KnownErrorBrand<"PROJECT_AUTHENTICATION_ERROR"> & {
|
|
80
|
-
constructorArgs: [statusCode: number, humanReadableMessage: string, details?: Json | undefined];
|
|
81
|
-
} & KnownErrorBrand<"INVALID_PROJECT_AUTHENTICATION"> & KnownErrorBrand<"REQUEST_TYPE_WITHOUT_PROJECT_ID">, [requestType: "client" | "server" | "admin"]> & {
|
|
82
|
-
errorCode: "REQUEST_TYPE_WITHOUT_PROJECT_ID";
|
|
83
|
-
};
|
|
84
69
|
ProjectKeyWithoutAccessType: KnownErrorConstructor<KnownError & KnownErrorBrand<"PROJECT_AUTHENTICATION_ERROR"> & {
|
|
85
70
|
constructorArgs: [statusCode: number, humanReadableMessage: string, details?: Json | undefined];
|
|
86
71
|
} & KnownErrorBrand<"INVALID_PROJECT_AUTHENTICATION"> & KnownErrorBrand<"PROJECT_KEY_WITHOUT_ACCESS_TYPE">, []> & {
|
package/dist/known-errors.js
CHANGED
|
@@ -105,35 +105,6 @@ const AllOverloadsFailed = createKnownErrorConstructor(KnownError, "ALL_OVERLOAD
|
|
|
105
105
|
]);
|
|
106
106
|
const ProjectAuthenticationError = createKnownErrorConstructor(KnownError, "PROJECT_AUTHENTICATION_ERROR", "inherit", "inherit");
|
|
107
107
|
const InvalidProjectAuthentication = createKnownErrorConstructor(ProjectAuthenticationError, "INVALID_PROJECT_AUTHENTICATION", "inherit", "inherit");
|
|
108
|
-
// TODO next-release: delete deprecated error type
|
|
109
|
-
/**
|
|
110
|
-
* @deprecated Use ProjectKeyWithoutAccessType instead
|
|
111
|
-
*/
|
|
112
|
-
const ProjectKeyWithoutRequestType = createKnownErrorConstructor(InvalidProjectAuthentication, "PROJECT_KEY_WITHOUT_REQUEST_TYPE", () => [
|
|
113
|
-
400,
|
|
114
|
-
"Either an API key or an admin access token was provided, but the x-stack-access-type header is missing. Set it to 'client', 'server', or 'admin' as appropriate.",
|
|
115
|
-
], () => []);
|
|
116
|
-
// TODO next-release: delete deprecated error type
|
|
117
|
-
/**
|
|
118
|
-
* @deprecated Use InvalidAccessType instead
|
|
119
|
-
*/
|
|
120
|
-
const InvalidRequestType = createKnownErrorConstructor(InvalidProjectAuthentication, "INVALID_REQUEST_TYPE", (requestType) => [
|
|
121
|
-
400,
|
|
122
|
-
`The x-stack-access-type header must be 'client', 'server', or 'admin', but was '${requestType}'.`,
|
|
123
|
-
], (json) => [
|
|
124
|
-
json?.requestType ?? throwErr("requestType not found in InvalidRequestType details"),
|
|
125
|
-
]);
|
|
126
|
-
// TODO next-release: delete deprecated error type
|
|
127
|
-
/**
|
|
128
|
-
* @deprecated Use AccessTypeWithoutProjectId instead
|
|
129
|
-
*/
|
|
130
|
-
const RequestTypeWithoutProjectId = createKnownErrorConstructor(InvalidProjectAuthentication, "REQUEST_TYPE_WITHOUT_PROJECT_ID", (requestType) => [
|
|
131
|
-
400,
|
|
132
|
-
`The x-stack-access-type header was '${requestType}', but the x-stack-project-id header was not provided.`,
|
|
133
|
-
{
|
|
134
|
-
request_type: requestType,
|
|
135
|
-
},
|
|
136
|
-
], (json) => [json.request_type]);
|
|
137
108
|
const ProjectKeyWithoutAccessType = createKnownErrorConstructor(InvalidProjectAuthentication, "PROJECT_KEY_WITHOUT_ACCESS_TYPE", () => [
|
|
138
109
|
400,
|
|
139
110
|
"Either an API key or an admin access token was provided, but the x-stack-access-type header is missing. Set it to 'client', 'server', or 'admin' as appropriate.",
|
|
@@ -288,7 +259,7 @@ const ProviderRejected = createKnownErrorConstructor(RefreshTokenError, "PROVIDE
|
|
|
288
259
|
], () => []);
|
|
289
260
|
const UserEmailAlreadyExists = createKnownErrorConstructor(KnownError, "USER_EMAIL_ALREADY_EXISTS", () => [
|
|
290
261
|
400,
|
|
291
|
-
"User already exists.",
|
|
262
|
+
"User email already exists.",
|
|
292
263
|
], () => []);
|
|
293
264
|
const CannotGetOwnUserWithoutUser = createKnownErrorConstructor(KnownError, "CANNOT_GET_OWN_USER_WITHOUT_USER", () => [
|
|
294
265
|
400,
|
|
@@ -570,9 +541,6 @@ export const KnownErrors = {
|
|
|
570
541
|
AllOverloadsFailed,
|
|
571
542
|
ProjectAuthenticationError,
|
|
572
543
|
InvalidProjectAuthentication,
|
|
573
|
-
ProjectKeyWithoutRequestType,
|
|
574
|
-
InvalidRequestType,
|
|
575
|
-
RequestTypeWithoutProjectId,
|
|
576
544
|
ProjectKeyWithoutAccessType,
|
|
577
545
|
InvalidAccessType,
|
|
578
546
|
AccessTypeWithoutProjectId,
|
package/dist/schema-fields.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ import * as yup from "yup";
|
|
|
2
2
|
declare module "yup" {
|
|
3
3
|
interface StringSchema<TType, TContext, TDefault, TFlags> {
|
|
4
4
|
nonEmpty(message?: string): StringSchema<TType, TContext, TDefault, TFlags>;
|
|
5
|
+
empty(): StringSchema<TType, TContext, TDefault, TFlags>;
|
|
5
6
|
}
|
|
6
7
|
}
|
|
7
8
|
export declare function yupValidate<S extends yup.ISchema<any>>(schema: S, obj: unknown, options?: yup.ValidateOptions & {
|
|
@@ -149,5 +150,6 @@ export declare const contactChannelIsVerifiedSchema: yup.BooleanSchema<boolean |
|
|
|
149
150
|
export declare const contactChannelIsPrimarySchema: yup.BooleanSchema<boolean | undefined, yup.AnyObject, undefined, "">;
|
|
150
151
|
export declare const basicAuthorizationHeaderSchema: yup.StringSchema<string | undefined, yup.AnyObject, undefined, "">;
|
|
151
152
|
export declare const neonAuthorizationHeaderSchema: yup.StringSchema<string | undefined, yup.AnyObject, undefined, "">;
|
|
152
|
-
export declare function yupDefinedWhen<S extends yup.AnyObject>(schema: S,
|
|
153
|
+
export declare function yupDefinedWhen<S extends yup.AnyObject>(schema: S, triggers: Record<string, any>): S;
|
|
154
|
+
export declare function yupDefinedAndNonEmptyWhen<S extends yup.StringSchema>(schema: S, triggers: Record<string, any>): S;
|
|
153
155
|
export {};
|
package/dist/schema-fields.js
CHANGED
|
@@ -9,7 +9,7 @@ import { isValidUrl } from "./utils/urls";
|
|
|
9
9
|
import { isUuid } from "./utils/uuids";
|
|
10
10
|
// eslint-disable-next-line no-restricted-syntax
|
|
11
11
|
yup.addMethod(yup.string, "nonEmpty", function (message) {
|
|
12
|
-
return this.test("non-empty", message ??
|
|
12
|
+
return this.test("non-empty", message ?? (({ path }) => `${path} must not be empty`), (value) => {
|
|
13
13
|
return value !== "";
|
|
14
14
|
});
|
|
15
15
|
});
|
|
@@ -371,10 +371,19 @@ export const neonAuthorizationHeaderSchema = basicAuthorizationHeaderSchema.test
|
|
|
371
371
|
return false;
|
|
372
372
|
});
|
|
373
373
|
// Utils
|
|
374
|
-
export function yupDefinedWhen(schema,
|
|
375
|
-
|
|
376
|
-
|
|
374
|
+
export function yupDefinedWhen(schema, triggers) {
|
|
375
|
+
const entries = Object.entries(triggers);
|
|
376
|
+
return schema.when(entries.map(([key]) => key), {
|
|
377
|
+
is: (...values) => entries.every(([key, value], index) => value === values[index]),
|
|
377
378
|
then: (schema) => schema.defined(),
|
|
378
379
|
otherwise: (schema) => schema.optional()
|
|
379
380
|
});
|
|
380
381
|
}
|
|
382
|
+
export function yupDefinedAndNonEmptyWhen(schema, triggers) {
|
|
383
|
+
const entries = Object.entries(triggers);
|
|
384
|
+
return schema.when(entries.map(([key]) => key), {
|
|
385
|
+
is: (...values) => entries.every(([key, value], index) => value === values[index]),
|
|
386
|
+
then: (schema) => schema.defined().nonEmpty(),
|
|
387
|
+
otherwise: (schema) => schema.optional()
|
|
388
|
+
});
|
|
389
|
+
}
|
package/dist/utils/objects.d.ts
CHANGED
|
@@ -10,8 +10,6 @@ export declare function deepPlainEquals<T>(obj1: T, obj2: unknown, options?: {
|
|
|
10
10
|
ignoreUndefinedValues?: boolean;
|
|
11
11
|
}): obj2 is T;
|
|
12
12
|
export declare function deepPlainClone<T>(obj: T): T;
|
|
13
|
-
export declare function deepPlainSnakeCaseToCamelCase(snakeCaseObj: any): any;
|
|
14
|
-
export declare function deepPlainCamelCaseToSnakeCase(camelCaseObj: any): any;
|
|
15
13
|
export declare function typedEntries<T extends {}>(obj: T): [keyof T, T[keyof T]][];
|
|
16
14
|
export declare function typedFromEntries<K extends PropertyKey, V>(entries: [K, V][]): Record<K, V>;
|
|
17
15
|
export declare function typedKeys<T extends {}>(obj: T): (keyof T)[];
|
package/dist/utils/objects.js
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { StackAssertionError } from "./errors";
|
|
2
|
-
import { camelCaseToSnakeCase, snakeCaseToCamelCase } from "./strings";
|
|
3
2
|
/**
|
|
4
3
|
* Assumes both objects are primitives, arrays, or non-function plain objects, and compares them deeply.
|
|
5
4
|
*
|
|
@@ -57,24 +56,6 @@ export function deepPlainClone(obj) {
|
|
|
57
56
|
return obj.map(deepPlainClone);
|
|
58
57
|
return Object.fromEntries(Object.entries(obj).map(([k, v]) => [k, deepPlainClone(v)]));
|
|
59
58
|
}
|
|
60
|
-
export function deepPlainSnakeCaseToCamelCase(snakeCaseObj) {
|
|
61
|
-
if (typeof snakeCaseObj === 'function')
|
|
62
|
-
throw new StackAssertionError("deepPlainSnakeCaseToCamelCase does not support functions");
|
|
63
|
-
if (typeof snakeCaseObj !== 'object' || !snakeCaseObj)
|
|
64
|
-
return snakeCaseObj;
|
|
65
|
-
if (Array.isArray(snakeCaseObj))
|
|
66
|
-
return snakeCaseObj.map(o => deepPlainSnakeCaseToCamelCase(o));
|
|
67
|
-
return Object.fromEntries(Object.entries(snakeCaseObj).map(([k, v]) => [snakeCaseToCamelCase(k), deepPlainSnakeCaseToCamelCase(v)]));
|
|
68
|
-
}
|
|
69
|
-
export function deepPlainCamelCaseToSnakeCase(camelCaseObj) {
|
|
70
|
-
if (typeof camelCaseObj === 'function')
|
|
71
|
-
throw new StackAssertionError("deepPlainCamelCaseToSnakeCase does not support functions");
|
|
72
|
-
if (typeof camelCaseObj !== 'object' || !camelCaseObj)
|
|
73
|
-
return camelCaseObj;
|
|
74
|
-
if (Array.isArray(camelCaseObj))
|
|
75
|
-
return camelCaseObj.map(o => deepPlainCamelCaseToSnakeCase(o));
|
|
76
|
-
return Object.fromEntries(Object.entries(camelCaseObj).map(([k, v]) => [camelCaseToSnakeCase(k), deepPlainCamelCaseToSnakeCase(v)]));
|
|
77
|
-
}
|
|
78
59
|
export function typedEntries(obj) {
|
|
79
60
|
return Object.entries(obj);
|
|
80
61
|
}
|
package/dist/utils/strings.d.ts
CHANGED
|
@@ -41,8 +41,6 @@ export declare function deindent(code: string): string;
|
|
|
41
41
|
export declare function deindent(strings: TemplateStringsArray | readonly string[], ...values: any[]): string;
|
|
42
42
|
export declare function extractScopes(scope: string, removeDuplicates?: boolean): string[];
|
|
43
43
|
export declare function mergeScopeStrings(...scopes: string[]): string;
|
|
44
|
-
export declare function snakeCaseToCamelCase(snakeCase: string): string;
|
|
45
|
-
export declare function camelCaseToSnakeCase(camelCase: string): string;
|
|
46
44
|
export type Nicifiable = {
|
|
47
45
|
getNicifiableKeys?(): PropertyKey[];
|
|
48
46
|
getNicifiedObjectExtraLines?(): string[];
|
package/dist/utils/strings.js
CHANGED
|
@@ -105,16 +105,6 @@ export function mergeScopeStrings(...scopes) {
|
|
|
105
105
|
const allScope = scopes.map((s) => extractScopes(s)).flat().join(" ");
|
|
106
106
|
return extractScopes(allScope).join(" ");
|
|
107
107
|
}
|
|
108
|
-
export function snakeCaseToCamelCase(snakeCase) {
|
|
109
|
-
if (snakeCase.match(/[A-Z]/))
|
|
110
|
-
return snakeCase; // TODO next-release: this is a hack for fixing the email templates, remove this after v2 migration
|
|
111
|
-
return snakeCase.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase());
|
|
112
|
-
}
|
|
113
|
-
export function camelCaseToSnakeCase(camelCase) {
|
|
114
|
-
if (camelCase.match(/_/))
|
|
115
|
-
return camelCase; // TODO next-release: this is a hack for fixing the email templates, remove this after v2 migration
|
|
116
|
-
return camelCase.replace(/[A-Z]/g, (letter) => `_${letter.toLowerCase()}`);
|
|
117
|
-
}
|
|
118
108
|
/**
|
|
119
109
|
* Some classes have different constructor names in different environments (eg. `Headers` is sometimes called `_Headers`,
|
|
120
110
|
* so we create an object of overrides to handle these cases.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stackframe/stack-shared",
|
|
3
|
-
"version": "2.7.
|
|
3
|
+
"version": "2.7.1",
|
|
4
4
|
"main": "./dist/index.js",
|
|
5
5
|
"types": "./dist/index.d.ts",
|
|
6
6
|
"files": [
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
"oauth4webapi": "^2.10.3",
|
|
52
52
|
"semver": "^7.6.3",
|
|
53
53
|
"uuid": "^9.0.1",
|
|
54
|
-
"@stackframe/stack-sc": "2.7.
|
|
54
|
+
"@stackframe/stack-sc": "2.7.1"
|
|
55
55
|
},
|
|
56
56
|
"devDependencies": {
|
|
57
57
|
"@sentry/nextjs": "^8.40.0",
|