@stackframe/stack-shared 2.5.3 → 2.5.5

package/dist/interface/crud/projects.d.ts

@@ -0,0 +1,458 @@
+import { CrudTypeOf } from "../../crud";
+export declare const projectsCrudServerReadSchema: import("yup").ObjectSchema<{
+    id: string;
+    display_name: string;
+    description: string;
+    created_at_millis: number;
+    user_count: number;
+    is_production_mode: NonNullable<boolean | undefined>;
+    config: {
+        id: string;
+        allow_localhost: NonNullable<boolean | undefined>;
+        credential_enabled: NonNullable<boolean | undefined>;
+        magic_link_enabled: NonNullable<boolean | undefined>;
+        oauth_providers: {
+            client_id?: string | undefined;
+            client_secret?: string | undefined;
+            type: NonNullable<"shared" | "standard" | undefined>;
+            id: NonNullable<"google" | "github" | "facebook" | "microsoft" | "spotify" | undefined>;
+            enabled: NonNullable<boolean | undefined>;
+        }[];
+        enabled_oauth_providers: {
+            id: NonNullable<"google" | "github" | "facebook" | "microsoft" | "spotify" | undefined>;
+        }[];
+        domains: {
+            domain: string;
+            handler_path: string;
+        }[];
+        email_config: {
+            host?: string | undefined;
+            port?: number | undefined;
+            username?: string | undefined;
+            password?: string | undefined;
+            sender_name?: string | undefined;
+            sender_email?: string | undefined;
+            type: NonNullable<"shared" | "standard" | undefined>;
+        };
+        create_team_on_sign_up: NonNullable<boolean | undefined>;
+        team_creator_default_permissions: {
+            id: string;
+        }[];
+        team_member_default_permissions: {
+            id: string;
+        }[];
+    };
+}, import("yup").AnyObject, {
+    id: undefined;
+    display_name: undefined;
+    description: undefined;
+    created_at_millis: undefined;
+    user_count: undefined;
+    is_production_mode: undefined;
+    config: {
+        id: undefined;
+        allow_localhost: undefined;
+        credential_enabled: undefined;
+        magic_link_enabled: undefined;
+        oauth_providers: undefined;
+        enabled_oauth_providers: undefined;
+        domains: undefined;
+        email_config: {
+            type: undefined;
+            host: undefined;
+            port: undefined;
+            username: undefined;
+            password: undefined;
+            sender_name: undefined;
+            sender_email: undefined;
+        };
+        create_team_on_sign_up: undefined;
+        team_creator_default_permissions: undefined;
+        team_member_default_permissions: undefined;
+    };
+}, "">;
+export declare const projectsCrudClientReadSchema: import("yup").ObjectSchema<{
+    id: string;
+    display_name: string;
+    config: {
+        credential_enabled: NonNullable<boolean | undefined>;
+        magic_link_enabled: NonNullable<boolean | undefined>;
+        enabled_oauth_providers: {
+            id: NonNullable<"google" | "github" | "facebook" | "microsoft" | "spotify" | undefined>;
+        }[];
+    };
+}, import("yup").AnyObject, {
+    id: undefined;
+    display_name: undefined;
+    config: {
+        credential_enabled: undefined;
+        magic_link_enabled: undefined;
+        enabled_oauth_providers: undefined;
+    };
+}, "">;
+export declare const projectsCrudServerUpdateSchema: import("yup").ObjectSchema<{
+    display_name: string | undefined;
+    description: string | null | undefined;
+    is_production_mode: boolean | undefined;
+    config: {
+        allow_localhost?: boolean | undefined;
+        credential_enabled?: boolean | undefined;
+        magic_link_enabled?: boolean | undefined;
+        oauth_providers?: {
+            client_id?: string | undefined;
+            client_secret?: string | undefined;
+            type: NonNullable<"shared" | "standard" | undefined>;
+            id: NonNullable<"google" | "github" | "facebook" | "microsoft" | "spotify" | undefined>;
+            enabled: NonNullable<boolean | undefined>;
+        }[] | undefined;
+        domains?: {
+            domain: string;
+            handler_path: string;
+        }[] | undefined;
+        email_config?: {
+            host?: string | undefined;
+            port?: number | undefined;
+            username?: string | undefined;
+            password?: string | undefined;
+            sender_name?: string | undefined;
+            sender_email?: string | undefined;
+            type: NonNullable<"shared" | "standard" | undefined>;
+        } | undefined;
+        create_team_on_sign_up?: boolean | undefined;
+        team_creator_default_permissions?: {
+            id: string;
+        }[] | undefined;
+        team_member_default_permissions?: {
+            id: string;
+        }[] | undefined;
+    } | undefined;
+}, import("yup").AnyObject, {
+    display_name: undefined;
+    description: undefined;
+    is_production_mode: undefined;
+    config: undefined;
+}, "">;
+export declare const projectsCrudServerCreateSchema: import("yup").ObjectSchema<{
+    display_name: string;
+    description: string | null | undefined;
+    is_production_mode: boolean | undefined;
+    config: {
+        allow_localhost?: boolean | undefined;
+        credential_enabled?: boolean | undefined;
+        magic_link_enabled?: boolean | undefined;
+        oauth_providers?: {
+            client_id?: string | undefined;
+            client_secret?: string | undefined;
+            type: NonNullable<"shared" | "standard" | undefined>;
+            id: NonNullable<"google" | "github" | "facebook" | "microsoft" | "spotify" | undefined>;
+            enabled: NonNullable<boolean | undefined>;
+        }[] | undefined;
+        domains?: {
+            domain: string;
+            handler_path: string;
+        }[] | undefined;
+        email_config?: {
+            host?: string | undefined;
+            port?: number | undefined;
+            username?: string | undefined;
+            password?: string | undefined;
+            sender_name?: string | undefined;
+            sender_email?: string | undefined;
+            type: NonNullable<"shared" | "standard" | undefined>;
+        } | undefined;
+        create_team_on_sign_up?: boolean | undefined;
+        team_creator_default_permissions?: {
+            id: string;
+        }[] | undefined;
+        team_member_default_permissions?: {
+            id: string;
+        }[] | undefined;
+    } | undefined;
+} & {
+    display_name: string;
+}, import("yup").AnyObject, {
+    display_name: undefined;
+    description: undefined;
+    is_production_mode: undefined;
+    config: undefined;
+}, "">;
+export declare const projectsCrud: import("../../crud").CrudSchemaFromOptions<{
+    clientReadSchema: import("yup").ObjectSchema<{
+        id: string;
+        display_name: string;
+        config: {
+            credential_enabled: NonNullable<boolean | undefined>;
+            magic_link_enabled: NonNullable<boolean | undefined>;
+            enabled_oauth_providers: {
+                id: NonNullable<"google" | "github" | "facebook" | "microsoft" | "spotify" | undefined>;
+            }[];
+        };
+    }, import("yup").AnyObject, {
+        id: undefined;
+        display_name: undefined;
+        config: {
+            credential_enabled: undefined;
+            magic_link_enabled: undefined;
+            enabled_oauth_providers: undefined;
+        };
+    }, "">;
+    serverReadSchema: import("yup").ObjectSchema<{
+        id: string;
+        display_name: string;
+        description: string;
+        created_at_millis: number;
+        user_count: number;
+        is_production_mode: NonNullable<boolean | undefined>;
+        config: {
+            id: string;
+            allow_localhost: NonNullable<boolean | undefined>;
+            credential_enabled: NonNullable<boolean | undefined>;
+            magic_link_enabled: NonNullable<boolean | undefined>;
+            oauth_providers: {
+                client_id?: string | undefined;
+                client_secret?: string | undefined;
+                type: NonNullable<"shared" | "standard" | undefined>;
+                id: NonNullable<"google" | "github" | "facebook" | "microsoft" | "spotify" | undefined>;
+                enabled: NonNullable<boolean | undefined>;
+            }[];
+            enabled_oauth_providers: {
+                id: NonNullable<"google" | "github" | "facebook" | "microsoft" | "spotify" | undefined>;
+            }[];
+            domains: {
+                domain: string;
+                handler_path: string;
+            }[];
+            email_config: {
+                host?: string | undefined;
+                port?: number | undefined;
+                username?: string | undefined;
+                password?: string | undefined;
+                sender_name?: string | undefined;
+                sender_email?: string | undefined;
+                type: NonNullable<"shared" | "standard" | undefined>;
+            };
+            create_team_on_sign_up: NonNullable<boolean | undefined>;
+            team_creator_default_permissions: {
+                id: string;
+            }[];
+            team_member_default_permissions: {
+                id: string;
+            }[];
+        };
+    }, import("yup").AnyObject, {
+        id: undefined;
+        display_name: undefined;
+        description: undefined;
+        created_at_millis: undefined;
+        user_count: undefined;
+        is_production_mode: undefined;
+        config: {
+            id: undefined;
+            allow_localhost: undefined;
+            credential_enabled: undefined;
+            magic_link_enabled: undefined;
+            oauth_providers: undefined;
+            enabled_oauth_providers: undefined;
+            domains: undefined;
+            email_config: {
+                type: undefined;
+                host: undefined;
+                port: undefined;
+                username: undefined;
+                password: undefined;
+                sender_name: undefined;
+                sender_email: undefined;
+            };
+            create_team_on_sign_up: undefined;
+            team_creator_default_permissions: undefined;
+            team_member_default_permissions: undefined;
+        };
+    }, "">;
+    serverUpdateSchema: import("yup").ObjectSchema<{
+        display_name: string | undefined;
+        description: string | null | undefined;
+        is_production_mode: boolean | undefined;
+        config: {
+            allow_localhost?: boolean | undefined;
+            credential_enabled?: boolean | undefined;
+            magic_link_enabled?: boolean | undefined;
+            oauth_providers?: {
+                client_id?: string | undefined;
+                client_secret?: string | undefined;
+                type: NonNullable<"shared" | "standard" | undefined>;
+                id: NonNullable<"google" | "github" | "facebook" | "microsoft" | "spotify" | undefined>;
+                enabled: NonNullable<boolean | undefined>;
+            }[] | undefined;
+            domains?: {
+                domain: string;
+                handler_path: string;
+            }[] | undefined;
+            email_config?: {
+                host?: string | undefined;
+                port?: number | undefined;
+                username?: string | undefined;
+                password?: string | undefined;
+                sender_name?: string | undefined;
+                sender_email?: string | undefined;
+                type: NonNullable<"shared" | "standard" | undefined>;
+            } | undefined;
+            create_team_on_sign_up?: boolean | undefined;
+            team_creator_default_permissions?: {
+                id: string;
+            }[] | undefined;
+            team_member_default_permissions?: {
+                id: string;
+            }[] | undefined;
+        } | undefined;
+    }, import("yup").AnyObject, {
+        display_name: undefined;
+        description: undefined;
+        is_production_mode: undefined;
+        config: undefined;
+    }, "">;
+    docs: {
+        clientRead: {
+            summary: string;
+            description: string;
+            tags: string[];
+        };
+        serverRead: {
+            summary: string;
+            description: string;
+            tags: string[];
+        };
+        serverUpdate: {
+            summary: string;
+            description: string;
+            tags: string[];
+        };
+    };
+}>;
+export type ProjectsCrud = CrudTypeOf<typeof projectsCrud>;
+export declare const internalProjectsCrud: import("../../crud").CrudSchemaFromOptions<{
+    clientReadSchema: import("yup").ObjectSchema<{
+        id: string;
+        display_name: string;
+        description: string;
+        created_at_millis: number;
+        user_count: number;
+        is_production_mode: NonNullable<boolean | undefined>;
+        config: {
+            id: string;
+            allow_localhost: NonNullable<boolean | undefined>;
+            credential_enabled: NonNullable<boolean | undefined>;
+            magic_link_enabled: NonNullable<boolean | undefined>;
+            oauth_providers: {
+                client_id?: string | undefined;
+                client_secret?: string | undefined;
+                type: NonNullable<"shared" | "standard" | undefined>;
+                id: NonNullable<"google" | "github" | "facebook" | "microsoft" | "spotify" | undefined>;
+                enabled: NonNullable<boolean | undefined>;
+            }[];
+            enabled_oauth_providers: {
+                id: NonNullable<"google" | "github" | "facebook" | "microsoft" | "spotify" | undefined>;
+            }[];
+            domains: {
+                domain: string;
+                handler_path: string;
+            }[];
+            email_config: {
+                host?: string | undefined;
+                port?: number | undefined;
+                username?: string | undefined;
+                password?: string | undefined;
+                sender_name?: string | undefined;
+                sender_email?: string | undefined;
+                type: NonNullable<"shared" | "standard" | undefined>;
+            };
+            create_team_on_sign_up: NonNullable<boolean | undefined>;
+            team_creator_default_permissions: {
+                id: string;
+            }[];
+            team_member_default_permissions: {
+                id: string;
+            }[];
+        };
+    }, import("yup").AnyObject, {
+        id: undefined;
+        display_name: undefined;
+        description: undefined;
+        created_at_millis: undefined;
+        user_count: undefined;
+        is_production_mode: undefined;
+        config: {
+            id: undefined;
+            allow_localhost: undefined;
+            credential_enabled: undefined;
+            magic_link_enabled: undefined;
+            oauth_providers: undefined;
+            enabled_oauth_providers: undefined;
+            domains: undefined;
+            email_config: {
+                type: undefined;
+                host: undefined;
+                port: undefined;
+                username: undefined;
+                password: undefined;
+                sender_name: undefined;
+                sender_email: undefined;
+            };
+            create_team_on_sign_up: undefined;
+            team_creator_default_permissions: undefined;
+            team_member_default_permissions: undefined;
+        };
+    }, "">;
+    clientCreateSchema: import("yup").ObjectSchema<{
+        display_name: string;
+        description: string | null | undefined;
+        is_production_mode: boolean | undefined;
+        config: {
+            allow_localhost?: boolean | undefined;
+            credential_enabled?: boolean | undefined;
+            magic_link_enabled?: boolean | undefined;
+            oauth_providers?: {
+                client_id?: string | undefined;
+                client_secret?: string | undefined;
+                type: NonNullable<"shared" | "standard" | undefined>;
+                id: NonNullable<"google" | "github" | "facebook" | "microsoft" | "spotify" | undefined>;
+                enabled: NonNullable<boolean | undefined>;
+            }[] | undefined;
+            domains?: {
+                domain: string;
+                handler_path: string;
+            }[] | undefined;
+            email_config?: {
+                host?: string | undefined;
+                port?: number | undefined;
+                username?: string | undefined;
+                password?: string | undefined;
+                sender_name?: string | undefined;
+                sender_email?: string | undefined;
+                type: NonNullable<"shared" | "standard" | undefined>;
+            } | undefined;
+            create_team_on_sign_up?: boolean | undefined;
+            team_creator_default_permissions?: {
+                id: string;
+            }[] | undefined;
+            team_member_default_permissions?: {
+                id: string;
+            }[] | undefined;
+        } | undefined;
+    } & {
+        display_name: string;
+    }, import("yup").AnyObject, {
+        display_name: undefined;
+        description: undefined;
+        is_production_mode: undefined;
+        config: undefined;
+    }, "">;
+    docs: {
+        clientList: {
+            hidden: true;
+        };
+        clientCreate: {
+            hidden: true;
+        };
+    };
+}>;
+export type InternalProjectsCrud = CrudTypeOf<typeof internalProjectsCrud>;

package/dist/interface/crud/projects.js

@@ -0,0 +1,112 @@
+import { createCrud } from "../../crud";
+import * as schemaFields from "../../schema-fields";
+import { yupArray, yupObject, yupRequiredWhen, yupString } from "../../schema-fields";
+const teamPermissionSchema = yupObject({
+    id: yupString().required(),
+}).required();
+const oauthProviderSchema = yupObject({
+    id: schemaFields.oauthIdSchema.required(),
+    enabled: schemaFields.oauthEnabledSchema.required(),
+    type: schemaFields.oauthTypeSchema.required(),
+    client_id: yupRequiredWhen(schemaFields.oauthClientIdSchema, 'type', 'standard'),
+    client_secret: yupRequiredWhen(schemaFields.oauthClientSecretSchema, 'type', 'standard'),
+});
+const enabledOAuthProviderSchema = yupObject({
+    id: schemaFields.oauthIdSchema.required(),
+});
+const emailConfigSchema = yupObject({
+    type: schemaFields.emailTypeSchema.required(),
+    host: yupRequiredWhen(schemaFields.emailHostSchema, 'type', 'standard'),
+    port: yupRequiredWhen(schemaFields.emailPortSchema, 'type', 'standard'),
+    username: yupRequiredWhen(schemaFields.emailUsernameSchema, 'type', 'standard'),
+    password: yupRequiredWhen(schemaFields.emailPasswordSchema, 'type', 'standard'),
+    sender_name: yupRequiredWhen(schemaFields.emailSenderNameSchema, 'type', 'standard'),
+    sender_email: yupRequiredWhen(schemaFields.emailSenderEmailSchema, 'type', 'standard'),
+});
+const domainSchema = yupObject({
+    domain: schemaFields.domainSchema.required(),
+    handler_path: schemaFields.handlerPathSchema.required(),
+});
+export const projectsCrudServerReadSchema = yupObject({
+    id: schemaFields.projectIdSchema.required(),
+    display_name: schemaFields.projectDisplayNameSchema.required(),
+    description: schemaFields.projectDescriptionSchema.nonNullable().defined(),
+    created_at_millis: schemaFields.projectCreatedAtMillisSchema.required(),
+    user_count: schemaFields.projectUserCountSchema.required(),
+    is_production_mode: schemaFields.projectIsProductionModeSchema.required(),
+    config: yupObject({
+        id: schemaFields.projectConfigIdSchema.required(),
+        allow_localhost: schemaFields.projectAllowLocalhostSchema.required(),
+        credential_enabled: schemaFields.projectCredentialEnabledSchema.required(),
+        magic_link_enabled: schemaFields.projectMagicLinkEnabledSchema.required(),
+        oauth_providers: yupArray(oauthProviderSchema.required()).required(),
+        enabled_oauth_providers: yupArray(enabledOAuthProviderSchema.required()).required(),
+        domains: yupArray(domainSchema.required()).required(),
+        email_config: emailConfigSchema.required(),
+        create_team_on_sign_up: schemaFields.projectCreateTeamOnSignUpSchema.required(),
+        team_creator_default_permissions: yupArray(teamPermissionSchema.required()).required(),
+        team_member_default_permissions: yupArray(teamPermissionSchema.required()).required(),
+    }).required(),
+}).required();
+export const projectsCrudClientReadSchema = yupObject({
+    id: schemaFields.projectIdSchema.required(),
+    display_name: schemaFields.projectDisplayNameSchema.required(),
+    config: yupObject({
+        credential_enabled: schemaFields.projectCredentialEnabledSchema.required(),
+        magic_link_enabled: schemaFields.projectMagicLinkEnabledSchema.required(),
+        enabled_oauth_providers: yupArray(enabledOAuthProviderSchema.required()).required(),
+    }).required(),
+}).required();
+export const projectsCrudServerUpdateSchema = yupObject({
+    display_name: schemaFields.projectDisplayNameSchema.optional(),
+    description: schemaFields.projectDescriptionSchema.optional(),
+    is_production_mode: schemaFields.projectIsProductionModeSchema.optional(),
+    config: yupObject({
+        credential_enabled: schemaFields.projectCredentialEnabledSchema.optional(),
+        magic_link_enabled: schemaFields.projectMagicLinkEnabledSchema.optional(),
+        allow_localhost: schemaFields.projectAllowLocalhostSchema.optional(),
+        email_config: emailConfigSchema.optional().default(undefined),
+        domains: yupArray(domainSchema.required()).optional().default(undefined),
+        oauth_providers: yupArray(oauthProviderSchema.required()).optional().default(undefined),
+        create_team_on_sign_up: schemaFields.projectCreateTeamOnSignUpSchema.optional(),
+        team_creator_default_permissions: yupArray(teamPermissionSchema.required()).optional(),
+        team_member_default_permissions: yupArray(teamPermissionSchema.required()).optional(),
+    }).optional().default(undefined),
+}).required();
+export const projectsCrudServerCreateSchema = projectsCrudServerUpdateSchema.concat(yupObject({
+    display_name: schemaFields.projectDisplayNameSchema.required(),
+}).required());
+export const projectsCrud = createCrud({
+    clientReadSchema: projectsCrudClientReadSchema,
+    serverReadSchema: projectsCrudServerReadSchema,
+    serverUpdateSchema: projectsCrudServerUpdateSchema,
+    docs: {
+        clientRead: {
+            summary: 'Get the current project',
+            description: 'Get the current project information including display name, oauth providers and authentication methods. Useful for display the available login options to the user.',
+            tags: ['Projects'],
+        },
+        serverRead: {
+            summary: 'Get the current project',
+            description: 'Get the current project information and configuration including display name, oauth providers, email configuration, etc.',
+            tags: ['Projects'],
+        },
+        serverUpdate: {
+            summary: 'Update the current project',
+            description: 'Update the current project information and configuration including display name, oauth providers, email configuration, etc.',
+            tags: ['Projects'],
+        },
+    },
+});
+export const internalProjectsCrud = createCrud({
+    clientReadSchema: projectsCrudServerReadSchema,
+    clientCreateSchema: projectsCrudServerCreateSchema,
+    docs: {
+        clientList: {
+            hidden: true,
+        },
+        clientCreate: {
+            hidden: true,
+        },
+    },
+});

package/dist/interface/crud/team-memberships.d.ts

@@ -0,0 +1,22 @@
+import { CrudTypeOf } from "../../crud";
+export declare const teamMembershipsCrudServerReadSchema: import("yup").ObjectSchema<{}, import("yup").AnyObject, {}, "">;
+export declare const teamMembershipsCrudServerCreateSchema: import("yup").ObjectSchema<{}, import("yup").AnyObject, {}, "">;
+export declare const teamMembershipsCrudServerDeleteSchema: import("yup").MixedSchema<{} | undefined, import("yup").AnyObject, undefined, "">;
+export declare const teamMembershipsCrud: import("../../crud").CrudSchemaFromOptions<{
+    serverReadSchema: import("yup").ObjectSchema<{}, import("yup").AnyObject, {}, "">;
+    serverCreateSchema: import("yup").ObjectSchema<{}, import("yup").AnyObject, {}, "">;
+    serverDeleteSchema: import("yup").MixedSchema<{} | undefined, import("yup").AnyObject, undefined, "">;
+    docs: {
+        serverCreate: {
+            summary: string;
+            description: string;
+            tags: string[];
+        };
+        serverDelete: {
+            summary: string;
+            description: string;
+            tags: string[];
+        };
+    };
+}>;
+export type TeamMembershipsCrud = CrudTypeOf<typeof teamMembershipsCrud>;

package/dist/interface/crud/team-memberships.js

@@ -0,0 +1,22 @@
+import { createCrud } from "../../crud";
+import { yupMixed, yupObject } from "../../schema-fields";
+export const teamMembershipsCrudServerReadSchema = yupObject({}).required();
+export const teamMembershipsCrudServerCreateSchema = yupObject({}).required();
+export const teamMembershipsCrudServerDeleteSchema = yupMixed();
+export const teamMembershipsCrud = createCrud({
+    serverReadSchema: teamMembershipsCrudServerReadSchema,
+    serverCreateSchema: teamMembershipsCrudServerCreateSchema,
+    serverDeleteSchema: teamMembershipsCrudServerDeleteSchema,
+    docs: {
+        serverCreate: {
+            summary: "Add a user to a team",
+            description: "",
+            tags: ["Teams"],
+        },
+        serverDelete: {
+            summary: "Remove a user from a team",
+            description: "",
+            tags: ["Teams"],
+        },
+    },
+});