@stackframe/stack-shared 2.8.2 → 2.8.5

package/dist/config/schema.d.ts

@@ -0,0 +1,721 @@
+import * as yup from "yup";
+import { DeepMerge } from "../utils/objects";
+import { PrettifyType } from "../utils/types";
+import { NormalizesTo } from "./format";
+export declare const configLevels: readonly ["project", "branch", "environment", "organization"];
+export type ConfigLevel = typeof configLevels[number];
+/**
+ * All fields that can be overridden at this level.
+ */
+export declare const projectConfigSchema: yup.ObjectSchema<{}, yup.AnyObject, {}, "">;
+export declare const branchConfigSchema: yup.ObjectSchema<{} & {
+    rbac: {
+        permissions?: Record<string, {
+            description?: string | undefined;
+            scope?: "project" | "team" | undefined;
+            containedPermissionIds?: Record<string, true | undefined> | undefined;
+        } | undefined> | undefined;
+        defaultPermissions?: {
+            teamCreator?: Record<string, true | undefined> | undefined;
+            teamMember?: Record<string, true | undefined> | undefined;
+            signUp?: Record<string, true | undefined> | undefined;
+        } | undefined;
+    } | undefined;
+    teams: {
+        createPersonalTeamOnSignUp?: boolean | undefined;
+        allowClientTeamCreation?: boolean | undefined;
+    } | undefined;
+    users: {
+        allowClientUserDeletion?: boolean | undefined;
+    } | undefined;
+    apiKeys: {
+        enabled?: {
+            user?: boolean | undefined;
+            team?: boolean | undefined;
+        } | undefined;
+    } | undefined;
+    domains: {
+        allowLocalhost?: boolean | undefined;
+    } | undefined;
+    auth: {
+        password?: {
+            allowSignIn?: boolean | undefined;
+        } | undefined;
+        allowSignUp?: boolean | undefined;
+        otp?: {
+            allowSignIn?: boolean | undefined;
+        } | undefined;
+        passkey?: {
+            allowSignIn?: boolean | undefined;
+        } | undefined;
+        oauth?: {
+            accountMergeStrategy?: "link_method" | "raise_error" | "allow_duplicates" | undefined;
+            providers?: Record<string, {
+                type?: "apple" | "x" | "google" | "github" | "microsoft" | "spotify" | "facebook" | "discord" | "gitlab" | "bitbucket" | "linkedin" | undefined;
+                allowSignIn?: boolean | undefined;
+                allowConnectedAccounts?: boolean | undefined;
+            }> | undefined;
+        } | undefined;
+    } | undefined;
+    emails: {};
+}, yup.AnyObject, {
+    rbac: {
+        permissions: undefined;
+        defaultPermissions: {
+            teamCreator: undefined;
+            teamMember: undefined;
+            signUp: undefined;
+        };
+    };
+    teams: {
+        createPersonalTeamOnSignUp: undefined;
+        allowClientTeamCreation: undefined;
+    };
+    users: {
+        allowClientUserDeletion: undefined;
+    };
+    apiKeys: {
+        enabled: {
+            team: undefined;
+            user: undefined;
+        };
+    };
+    domains: {
+        allowLocalhost: undefined;
+    };
+    auth: {
+        allowSignUp: undefined;
+        password: {
+            allowSignIn: undefined;
+        };
+        otp: {
+            allowSignIn: undefined;
+        };
+        passkey: {
+            allowSignIn: undefined;
+        };
+        oauth: {
+            accountMergeStrategy: undefined;
+            providers: undefined;
+        };
+    };
+    emails: {};
+}, "">;
+export declare const environmentConfigSchema: yup.ObjectSchema<{
+    rbac: {
+        permissions?: Record<string, {
+            description?: string | undefined;
+            scope?: "project" | "team" | undefined;
+            containedPermissionIds?: Record<string, true | undefined> | undefined;
+        } | undefined> | undefined;
+        defaultPermissions?: {
+            teamCreator?: Record<string, true | undefined> | undefined;
+            teamMember?: Record<string, true | undefined> | undefined;
+            signUp?: Record<string, true | undefined> | undefined;
+        } | undefined;
+    } | undefined;
+    teams: {
+        createPersonalTeamOnSignUp?: boolean | undefined;
+        allowClientTeamCreation?: boolean | undefined;
+    } | undefined;
+    users: {
+        allowClientUserDeletion?: boolean | undefined;
+    } | undefined;
+    apiKeys: {
+        enabled?: {
+            user?: boolean | undefined;
+            team?: boolean | undefined;
+        } | undefined;
+    } | undefined;
+    domains: (Omit<{
+        allowLocalhost?: boolean | undefined;
+    }, "trustedDomains"> & {
+        trustedDomains?: Record<string, {
+            baseUrl?: string | undefined;
+            handlerPath?: string | undefined;
+        }> | undefined;
+    }) | undefined;
+    auth: (Omit<{
+        password?: {
+            allowSignIn?: boolean | undefined;
+        } | undefined;
+        allowSignUp?: boolean | undefined;
+        otp?: {
+            allowSignIn?: boolean | undefined;
+        } | undefined;
+        passkey?: {
+            allowSignIn?: boolean | undefined;
+        } | undefined;
+        oauth?: {
+            accountMergeStrategy?: "link_method" | "raise_error" | "allow_duplicates" | undefined;
+            providers?: Record<string, {
+                type?: "apple" | "x" | "google" | "github" | "microsoft" | "spotify" | "facebook" | "discord" | "gitlab" | "bitbucket" | "linkedin" | undefined;
+                allowSignIn?: boolean | undefined;
+                allowConnectedAccounts?: boolean | undefined;
+            }> | undefined;
+        } | undefined;
+    }, "oauth"> & {
+        oauth?: (Omit<{
+            accountMergeStrategy?: "link_method" | "raise_error" | "allow_duplicates" | undefined;
+            providers?: Record<string, {
+                type?: "apple" | "x" | "google" | "github" | "microsoft" | "spotify" | "facebook" | "discord" | "gitlab" | "bitbucket" | "linkedin" | undefined;
+                allowSignIn?: boolean | undefined;
+                allowConnectedAccounts?: boolean | undefined;
+            }> | undefined;
+        }, never> & {
+            providers?: Record<string, {
+                type?: "apple" | "x" | "google" | "github" | "microsoft" | "spotify" | "facebook" | "discord" | "gitlab" | "bitbucket" | "linkedin" | undefined;
+                clientId?: string | undefined;
+                clientSecret?: string | undefined;
+                allowSignIn?: boolean | undefined;
+                allowConnectedAccounts?: boolean | undefined;
+                isShared?: boolean | undefined;
+                facebookConfigId?: string | undefined;
+                microsoftTenantId?: string | undefined;
+            }> | undefined;
+        }) | undefined;
+    }) | undefined;
+    emails: Omit<{}, never> & {
+        server: {
+            host?: string | undefined;
+            port?: number | undefined;
+            username?: string | undefined;
+            password?: string | undefined;
+            isShared?: boolean | undefined;
+            senderName?: string | undefined;
+            senderEmail?: string | undefined;
+        };
+    };
+} & {
+    auth: (Omit<{
+        password?: {
+            allowSignIn?: boolean | undefined;
+        } | undefined;
+        allowSignUp?: boolean | undefined;
+        otp?: {
+            allowSignIn?: boolean | undefined;
+        } | undefined;
+        passkey?: {
+            allowSignIn?: boolean | undefined;
+        } | undefined;
+        oauth?: {
+            accountMergeStrategy?: "link_method" | "raise_error" | "allow_duplicates" | undefined;
+            providers?: Record<string, {
+                type?: "apple" | "x" | "google" | "github" | "microsoft" | "spotify" | "facebook" | "discord" | "gitlab" | "bitbucket" | "linkedin" | undefined;
+                allowSignIn?: boolean | undefined;
+                allowConnectedAccounts?: boolean | undefined;
+            }> | undefined;
+        } | undefined;
+    }, "oauth"> & {
+        oauth?: (Omit<{
+            accountMergeStrategy?: "link_method" | "raise_error" | "allow_duplicates" | undefined;
+            providers?: Record<string, {
+                type?: "apple" | "x" | "google" | "github" | "microsoft" | "spotify" | "facebook" | "discord" | "gitlab" | "bitbucket" | "linkedin" | undefined;
+                allowSignIn?: boolean | undefined;
+                allowConnectedAccounts?: boolean | undefined;
+            }> | undefined;
+        }, never> & {
+            providers?: Record<string, {
+                type?: "apple" | "x" | "google" | "github" | "microsoft" | "spotify" | "facebook" | "discord" | "gitlab" | "bitbucket" | "linkedin" | undefined;
+                clientId?: string | undefined;
+                clientSecret?: string | undefined;
+                allowSignIn?: boolean | undefined;
+                allowConnectedAccounts?: boolean | undefined;
+                isShared?: boolean | undefined;
+                facebookConfigId?: string | undefined;
+                microsoftTenantId?: string | undefined;
+            }> | undefined;
+        }) | undefined;
+    }) | undefined;
+    emails: Omit<{}, never> & {
+        server: {
+            host?: string | undefined;
+            port?: number | undefined;
+            username?: string | undefined;
+            password?: string | undefined;
+            isShared?: boolean | undefined;
+            senderName?: string | undefined;
+            senderEmail?: string | undefined;
+        };
+    };
+    domains: (Omit<{
+        allowLocalhost?: boolean | undefined;
+    }, "trustedDomains"> & {
+        trustedDomains?: Record<string, {
+            baseUrl?: string | undefined;
+            handlerPath?: string | undefined;
+        }> | undefined;
+    }) | undefined;
+}, yup.AnyObject, {
+    rbac: {
+        permissions: undefined;
+        defaultPermissions: {
+            teamCreator: undefined;
+            teamMember: undefined;
+            signUp: undefined;
+        };
+    };
+    teams: {
+        createPersonalTeamOnSignUp: undefined;
+        allowClientTeamCreation: undefined;
+    };
+    users: {
+        allowClientUserDeletion: undefined;
+    };
+    apiKeys: {
+        enabled: {
+            team: undefined;
+            user: undefined;
+        };
+    };
+    domains: {
+        rbac: {
+            permissions: undefined;
+            defaultPermissions: {
+                teamCreator: undefined;
+                teamMember: undefined;
+                signUp: undefined;
+            };
+        };
+        teams: {
+            createPersonalTeamOnSignUp: undefined;
+            allowClientTeamCreation: undefined;
+        };
+        users: {
+            allowClientUserDeletion: undefined;
+        };
+        apiKeys: {
+            enabled: {
+                team: undefined;
+                user: undefined;
+            };
+        };
+        domains: {
+            allowLocalhost: undefined;
+        };
+        auth: {
+            allowSignUp: undefined;
+            password: {
+                allowSignIn: undefined;
+            };
+            otp: {
+                allowSignIn: undefined;
+            };
+            passkey: {
+                allowSignIn: undefined;
+            };
+            oauth: {
+                accountMergeStrategy: undefined;
+                providers: undefined;
+            };
+        };
+        emails: {};
+    };
+    auth: {
+        rbac: {
+            permissions: undefined;
+            defaultPermissions: {
+                teamCreator: undefined;
+                teamMember: undefined;
+                signUp: undefined;
+            };
+        };
+        teams: {
+            createPersonalTeamOnSignUp: undefined;
+            allowClientTeamCreation: undefined;
+        };
+        users: {
+            allowClientUserDeletion: undefined;
+        };
+        apiKeys: {
+            enabled: {
+                team: undefined;
+                user: undefined;
+            };
+        };
+        domains: {
+            allowLocalhost: undefined;
+        };
+        auth: {
+            allowSignUp: undefined;
+            password: {
+                allowSignIn: undefined;
+            };
+            otp: {
+                allowSignIn: undefined;
+            };
+            passkey: {
+                allowSignIn: undefined;
+            };
+            oauth: {
+                accountMergeStrategy: undefined;
+                providers: undefined;
+            };
+        };
+        emails: {};
+    };
+    emails: {
+        rbac: {
+            permissions: undefined;
+            defaultPermissions: {
+                teamCreator: undefined;
+                teamMember: undefined;
+                signUp: undefined;
+            };
+        };
+        teams: {
+            createPersonalTeamOnSignUp: undefined;
+            allowClientTeamCreation: undefined;
+        };
+        users: {
+            allowClientUserDeletion: undefined;
+        };
+        apiKeys: {
+            enabled: {
+                team: undefined;
+                user: undefined;
+            };
+        };
+        domains: {
+            allowLocalhost: undefined;
+        };
+        auth: {
+            allowSignUp: undefined;
+            password: {
+                allowSignIn: undefined;
+            };
+            otp: {
+                allowSignIn: undefined;
+            };
+            passkey: {
+                allowSignIn: undefined;
+            };
+            oauth: {
+                accountMergeStrategy: undefined;
+                providers: undefined;
+            };
+        };
+        emails: {};
+    };
+}, "">;
+export declare const organizationConfigSchema: yup.ObjectSchema<{
+    rbac: {
+        permissions?: Record<string, {
+            description?: string | undefined;
+            scope?: "project" | "team" | undefined;
+            containedPermissionIds?: Record<string, true | undefined> | undefined;
+        } | undefined> | undefined;
+        defaultPermissions?: {
+            teamCreator?: Record<string, true | undefined> | undefined;
+            teamMember?: Record<string, true | undefined> | undefined;
+            signUp?: Record<string, true | undefined> | undefined;
+        } | undefined;
+    } | undefined;
+    teams: {
+        createPersonalTeamOnSignUp?: boolean | undefined;
+        allowClientTeamCreation?: boolean | undefined;
+    } | undefined;
+    users: {
+        allowClientUserDeletion?: boolean | undefined;
+    } | undefined;
+    apiKeys: {
+        enabled?: {
+            user?: boolean | undefined;
+            team?: boolean | undefined;
+        } | undefined;
+    } | undefined;
+    domains: (Omit<{
+        allowLocalhost?: boolean | undefined;
+    }, "trustedDomains"> & {
+        trustedDomains?: Record<string, {
+            baseUrl?: string | undefined;
+            handlerPath?: string | undefined;
+        }> | undefined;
+    }) | undefined;
+    auth: (Omit<{
+        password?: {
+            allowSignIn?: boolean | undefined;
+        } | undefined;
+        allowSignUp?: boolean | undefined;
+        otp?: {
+            allowSignIn?: boolean | undefined;
+        } | undefined;
+        passkey?: {
+            allowSignIn?: boolean | undefined;
+        } | undefined;
+        oauth?: {
+            accountMergeStrategy?: "link_method" | "raise_error" | "allow_duplicates" | undefined;
+            providers?: Record<string, {
+                type?: "apple" | "x" | "google" | "github" | "microsoft" | "spotify" | "facebook" | "discord" | "gitlab" | "bitbucket" | "linkedin" | undefined;
+                allowSignIn?: boolean | undefined;
+                allowConnectedAccounts?: boolean | undefined;
+            }> | undefined;
+        } | undefined;
+    }, "oauth"> & {
+        oauth?: (Omit<{
+            accountMergeStrategy?: "link_method" | "raise_error" | "allow_duplicates" | undefined;
+            providers?: Record<string, {
+                type?: "apple" | "x" | "google" | "github" | "microsoft" | "spotify" | "facebook" | "discord" | "gitlab" | "bitbucket" | "linkedin" | undefined;
+                allowSignIn?: boolean | undefined;
+                allowConnectedAccounts?: boolean | undefined;
+            }> | undefined;
+        }, never> & {
+            providers?: Record<string, {
+                type?: "apple" | "x" | "google" | "github" | "microsoft" | "spotify" | "facebook" | "discord" | "gitlab" | "bitbucket" | "linkedin" | undefined;
+                clientId?: string | undefined;
+                clientSecret?: string | undefined;
+                allowSignIn?: boolean | undefined;
+                allowConnectedAccounts?: boolean | undefined;
+                isShared?: boolean | undefined;
+                facebookConfigId?: string | undefined;
+                microsoftTenantId?: string | undefined;
+            }> | undefined;
+        }) | undefined;
+    }) | undefined;
+    emails: Omit<{}, never> & {
+        server: {
+            host?: string | undefined;
+            port?: number | undefined;
+            username?: string | undefined;
+            password?: string | undefined;
+            isShared?: boolean | undefined;
+            senderName?: string | undefined;
+            senderEmail?: string | undefined;
+        };
+    };
+} & {}, yup.AnyObject, {
+    rbac: {
+        permissions: undefined;
+        defaultPermissions: {
+            teamCreator: undefined;
+            teamMember: undefined;
+            signUp: undefined;
+        };
+    };
+    teams: {
+        createPersonalTeamOnSignUp: undefined;
+        allowClientTeamCreation: undefined;
+    };
+    users: {
+        allowClientUserDeletion: undefined;
+    };
+    apiKeys: {
+        enabled: {
+            team: undefined;
+            user: undefined;
+        };
+    };
+    domains: {
+        rbac: {
+            permissions: undefined;
+            defaultPermissions: {
+                teamCreator: undefined;
+                teamMember: undefined;
+                signUp: undefined;
+            };
+        };
+        teams: {
+            createPersonalTeamOnSignUp: undefined;
+            allowClientTeamCreation: undefined;
+        };
+        users: {
+            allowClientUserDeletion: undefined;
+        };
+        apiKeys: {
+            enabled: {
+                team: undefined;
+                user: undefined;
+            };
+        };
+        domains: {
+            allowLocalhost: undefined;
+        };
+        auth: {
+            allowSignUp: undefined;
+            password: {
+                allowSignIn: undefined;
+            };
+            otp: {
+                allowSignIn: undefined;
+            };
+            passkey: {
+                allowSignIn: undefined;
+            };
+            oauth: {
+                accountMergeStrategy: undefined;
+                providers: undefined;
+            };
+        };
+        emails: {};
+    };
+    auth: {
+        rbac: {
+            permissions: undefined;
+            defaultPermissions: {
+                teamCreator: undefined;
+                teamMember: undefined;
+                signUp: undefined;
+            };
+        };
+        teams: {
+            createPersonalTeamOnSignUp: undefined;
+            allowClientTeamCreation: undefined;
+        };
+        users: {
+            allowClientUserDeletion: undefined;
+        };
+        apiKeys: {
+            enabled: {
+                team: undefined;
+                user: undefined;
+            };
+        };
+        domains: {
+            allowLocalhost: undefined;
+        };
+        auth: {
+            allowSignUp: undefined;
+            password: {
+                allowSignIn: undefined;
+            };
+            otp: {
+                allowSignIn: undefined;
+            };
+            passkey: {
+                allowSignIn: undefined;
+            };
+            oauth: {
+                accountMergeStrategy: undefined;
+                providers: undefined;
+            };
+        };
+        emails: {};
+    };
+    emails: {
+        rbac: {
+            permissions: undefined;
+            defaultPermissions: {
+                teamCreator: undefined;
+                teamMember: undefined;
+                signUp: undefined;
+            };
+        };
+        teams: {
+            createPersonalTeamOnSignUp: undefined;
+            allowClientTeamCreation: undefined;
+        };
+        users: {
+            allowClientUserDeletion: undefined;
+        };
+        apiKeys: {
+            enabled: {
+                team: undefined;
+                user: undefined;
+            };
+        };
+        domains: {
+            allowLocalhost: undefined;
+        };
+        auth: {
+            allowSignUp: undefined;
+            password: {
+                allowSignIn: undefined;
+            };
+            otp: {
+                allowSignIn: undefined;
+            };
+            passkey: {
+                allowSignIn: undefined;
+            };
+            oauth: {
+                accountMergeStrategy: undefined;
+                providers: undefined;
+            };
+        };
+        emails: {};
+    };
+}, "">;
+export declare const projectConfigDefaults: {};
+export declare const branchConfigDefaults: {};
+export declare const environmentConfigDefaults: {};
+export declare const organizationConfigDefaults: {
+    rbac: {
+        permissions: (key: string) => {};
+        defaultPermissions: {
+            teamCreator: {};
+            teamMember: {};
+            signUp: {};
+        };
+    };
+    apiKeys: {
+        enabled: {
+            team: false;
+            user: false;
+        };
+    };
+    teams: {
+        createPersonalTeamOnSignUp: false;
+        allowClientTeamCreation: false;
+    };
+    users: {
+        allowClientUserDeletion: false;
+    };
+    domains: {
+        allowLocalhost: false;
+        trustedDomains: (key: string) => {
+            handlerPath: string;
+        };
+    };
+    auth: {
+        allowSignUp: true;
+        password: {
+            allowSignIn: false;
+        };
+        otp: {
+            allowSignIn: false;
+        };
+        passkey: {
+            allowSignIn: false;
+        };
+        oauth: {
+            accountMergeStrategy: "link_method";
+            providers: (key: string) => {
+                allowSignIn: false;
+                allowConnectedAccounts: false;
+            };
+        };
+    };
+    emails: {
+        server: {
+            isShared: true;
+        };
+    };
+};
+export type DeepReplaceAllowFunctionsForObjects<T> = T extends object ? {
+    [K in keyof T]: DeepReplaceAllowFunctionsForObjects<T[K]>;
+} | ((arg: keyof T) => DeepReplaceAllowFunctionsForObjects<T[keyof T]>) : T;
+export type DeepReplaceFunctionsWithObjects<T> = T extends (arg: infer K extends string) => infer R ? DeepReplaceFunctionsWithObjects<Record<K, R>> : (T extends object ? {
+    [K in keyof T]: DeepReplaceFunctionsWithObjects<T[K]>;
+} : T);
+export type ApplyDefaults<D extends object | ((key: string) => unknown), C extends object> = DeepMerge<DeepReplaceFunctionsWithObjects<D>, C>;
+export declare function applyDefaults<D extends object | ((key: string) => unknown), C extends object>(defaults: D, config: C): ApplyDefaults<D, C>;
+export type ProjectConfigNormalizedOverride = yup.InferType<typeof projectConfigSchema>;
+export type BranchConfigNormalizedOverride = yup.InferType<typeof branchConfigSchema>;
+export type EnvironmentConfigNormalizedOverride = yup.InferType<typeof environmentConfigSchema>;
+export type OrganizationConfigNormalizedOverride = yup.InferType<typeof organizationConfigSchema>;
+export type ProjectConfigStrippedNormalizedOverride = Omit<ProjectConfigNormalizedOverride, keyof BranchConfigNormalizedOverride | keyof EnvironmentConfigNormalizedOverride | keyof OrganizationConfigNormalizedOverride>;
+export type BranchConfigStrippedNormalizedOverride = Omit<BranchConfigNormalizedOverride, keyof EnvironmentConfigNormalizedOverride | keyof OrganizationConfigNormalizedOverride>;
+export type EnvironmentConfigStrippedNormalizedOverride = Omit<EnvironmentConfigNormalizedOverride, keyof OrganizationConfigNormalizedOverride>;
+export type OrganizationConfigStrippedNormalizedOverride = OrganizationConfigNormalizedOverride;
+export type ProjectConfigOverride = NormalizesTo<ProjectConfigNormalizedOverride>;
+export type BranchConfigOverride = NormalizesTo<BranchConfigNormalizedOverride>;
+export type EnvironmentConfigOverride = NormalizesTo<EnvironmentConfigNormalizedOverride>;
+export type OrganizationConfigOverride = NormalizesTo<OrganizationConfigNormalizedOverride>;
+export type ProjectIncompleteConfig = ProjectConfigNormalizedOverride;
+export type BranchIncompleteConfig = ProjectIncompleteConfig & BranchConfigNormalizedOverride;
+export type EnvironmentIncompleteConfig = BranchIncompleteConfig & EnvironmentConfigNormalizedOverride;
+export type OrganizationIncompleteConfig = EnvironmentIncompleteConfig & OrganizationConfigNormalizedOverride;
+export type ProjectRenderedConfig = PrettifyType<ApplyDefaults<typeof projectConfigDefaults, ProjectConfigStrippedNormalizedOverride>>;
+export type BranchRenderedConfig = PrettifyType<ProjectRenderedConfig & ApplyDefaults<typeof branchConfigDefaults, BranchConfigStrippedNormalizedOverride>>;
+export type EnvironmentRenderedConfig = PrettifyType<BranchRenderedConfig & ApplyDefaults<typeof environmentConfigDefaults, EnvironmentConfigStrippedNormalizedOverride>>;
+export type OrganizationRenderedConfig = PrettifyType<EnvironmentRenderedConfig & ApplyDefaults<typeof organizationConfigDefaults, OrganizationConfigStrippedNormalizedOverride>>;