@stackframe/stack-shared 2.5.0 → 2.5.1

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

@@ -1,102 +1,166 @@
 import { CrudTypeOf } from "../../crud";
 import * as yup from "yup";
 export declare const usersCrudServerUpdateSchema: yup.ObjectSchema<{
-    displayName: string | undefined;
-    clientMetadata: {} | null | undefined;
-    serverMetadata: {} | null | undefined;
-    primaryEmail: string | null | undefined;
-    primaryEmailVerified: boolean | undefined;
-    selectedTeamId: string | null | undefined;
+    display_name: string | null | undefined;
+    client_metadata: {} | null | undefined;
+    server_metadata: {} | null | undefined;
+    primary_email: string | null | undefined;
+    primary_email_verified: boolean | undefined;
+    selected_team_id: string | null | undefined;
 }, yup.AnyObject, {
-    displayName: undefined;
-    clientMetadata: undefined;
-    serverMetadata: undefined;
-    primaryEmail: undefined;
-    primaryEmailVerified: undefined;
-    selectedTeamId: undefined;
+    display_name: undefined;
+    client_metadata: undefined;
+    server_metadata: undefined;
+    primary_email: undefined;
+    primary_email_verified: undefined;
+    selected_team_id: undefined;
 }, "">;
 export declare const usersCrudServerReadSchema: yup.ObjectSchema<{
-    projectId: string;
+    project_id: string;
     id: string;
-    primaryEmail: string | null;
-    primaryEmailVerified: NonNullable<boolean | undefined>;
-    displayName: string | null;
-    selectedTeam: {} | null;
-    selectedTeamId: string | null;
-    profileImageUrl: string | null;
-    signedUpAtMillis: number;
-    authMethod: NonNullable<"credential" | "oauth" | undefined>;
-    hasPassword: NonNullable<boolean | undefined>;
-    authWithEmail: NonNullable<boolean | undefined>;
-    oauthProviders: string[];
-    clientMetadata: {} | null;
-    serverMetadata: {} | null;
+    primary_email: string | null;
+    primary_email_verified: NonNullable<boolean | undefined>;
+    display_name: string | null;
+    selected_team: {} | null;
+    selected_team_id: string | null;
+    profile_image_url: string | null;
+    signed_up_at_millis: number;
+    has_password: NonNullable<boolean | undefined>;
+    auth_with_email: NonNullable<boolean | undefined>;
+    oauth_providers: string[];
+    client_metadata: {} | null;
+    server_metadata: {} | null;
 }, yup.AnyObject, {
-    projectId: undefined;
+    project_id: undefined;
     id: undefined;
-    primaryEmail: undefined;
-    primaryEmailVerified: undefined;
-    displayName: undefined;
-    selectedTeam: undefined;
-    selectedTeamId: undefined;
-    profileImageUrl: undefined;
-    signedUpAtMillis: undefined;
-    authMethod: undefined;
-    hasPassword: undefined;
-    authWithEmail: undefined;
-    oauthProviders: undefined;
-    clientMetadata: undefined;
-    serverMetadata: undefined;
+    primary_email: undefined;
+    primary_email_verified: undefined;
+    display_name: undefined;
+    selected_team: undefined;
+    selected_team_id: undefined;
+    profile_image_url: undefined;
+    signed_up_at_millis: undefined;
+    has_password: undefined;
+    auth_with_email: undefined;
+    oauth_providers: undefined;
+    client_metadata: undefined;
+    server_metadata: undefined;
 }, "">;
+export declare const usersCrudServerCreateSchema: yup.ObjectSchema<{
+    display_name: string | null | undefined;
+    client_metadata: {} | null | undefined;
+    server_metadata: {} | null | undefined;
+    primary_email: string;
+    primary_email_verified: NonNullable<boolean | undefined>;
+    selected_team_id: string | null | undefined;
+} & {
+    primary_email: string;
+    primary_email_verified: NonNullable<boolean | undefined>;
+    auth_with_email: NonNullable<boolean | undefined>;
+}, yup.AnyObject, {
+    display_name: undefined;
+    client_metadata: undefined;
+    server_metadata: undefined;
+    primary_email: undefined;
+    primary_email_verified: undefined;
+    selected_team_id: undefined;
+    auth_with_email: undefined;
+}, "">;
+export declare const usersCrudServerDeleteSchema: yup.MixedSchema<{} | undefined, yup.AnyObject, undefined, "">;
 export declare const usersCrud: import("../../crud").CrudSchemaFromOptions<{
     serverReadSchema: yup.ObjectSchema<{
-        projectId: string;
+        project_id: string;
         id: string;
-        primaryEmail: string | null;
-        primaryEmailVerified: NonNullable<boolean | undefined>;
-        displayName: string | null;
-        selectedTeam: {} | null;
-        selectedTeamId: string | null;
-        profileImageUrl: string | null;
-        signedUpAtMillis: number;
-        authMethod: NonNullable<"credential" | "oauth" | undefined>;
-        hasPassword: NonNullable<boolean | undefined>;
-        authWithEmail: NonNullable<boolean | undefined>;
-        oauthProviders: string[];
-        clientMetadata: {} | null;
-        serverMetadata: {} | null;
+        primary_email: string | null;
+        primary_email_verified: NonNullable<boolean | undefined>;
+        display_name: string | null;
+        selected_team: {} | null;
+        selected_team_id: string | null;
+        profile_image_url: string | null;
+        signed_up_at_millis: number;
+        has_password: NonNullable<boolean | undefined>;
+        auth_with_email: NonNullable<boolean | undefined>;
+        oauth_providers: string[];
+        client_metadata: {} | null;
+        server_metadata: {} | null;
     }, yup.AnyObject, {
-        projectId: undefined;
+        project_id: undefined;
         id: undefined;
-        primaryEmail: undefined;
-        primaryEmailVerified: undefined;
-        displayName: undefined;
-        selectedTeam: undefined;
-        selectedTeamId: undefined;
-        profileImageUrl: undefined;
-        signedUpAtMillis: undefined;
-        authMethod: undefined;
-        hasPassword: undefined;
-        authWithEmail: undefined;
-        oauthProviders: undefined;
-        clientMetadata: undefined;
-        serverMetadata: undefined;
+        primary_email: undefined;
+        primary_email_verified: undefined;
+        display_name: undefined;
+        selected_team: undefined;
+        selected_team_id: undefined;
+        profile_image_url: undefined;
+        signed_up_at_millis: undefined;
+        has_password: undefined;
+        auth_with_email: undefined;
+        oauth_providers: undefined;
+        client_metadata: undefined;
+        server_metadata: undefined;
     }, "">;
     serverUpdateSchema: yup.ObjectSchema<{
-        displayName: string | undefined;
-        clientMetadata: {} | null | undefined;
-        serverMetadata: {} | null | undefined;
-        primaryEmail: string | null | undefined;
-        primaryEmailVerified: boolean | undefined;
-        selectedTeamId: string | null | undefined;
+        display_name: string | null | undefined;
+        client_metadata: {} | null | undefined;
+        server_metadata: {} | null | undefined;
+        primary_email: string | null | undefined;
+        primary_email_verified: boolean | undefined;
+        selected_team_id: string | null | undefined;
+    }, yup.AnyObject, {
+        display_name: undefined;
+        client_metadata: undefined;
+        server_metadata: undefined;
+        primary_email: undefined;
+        primary_email_verified: undefined;
+        selected_team_id: undefined;
+    }, "">;
+    serverCreateSchema: yup.ObjectSchema<{
+        display_name: string | null | undefined;
+        client_metadata: {} | null | undefined;
+        server_metadata: {} | null | undefined;
+        primary_email: string;
+        primary_email_verified: NonNullable<boolean | undefined>;
+        selected_team_id: string | null | undefined;
+    } & {
+        primary_email: string;
+        primary_email_verified: NonNullable<boolean | undefined>;
+        auth_with_email: NonNullable<boolean | undefined>;
     }, yup.AnyObject, {
-        displayName: undefined;
-        clientMetadata: undefined;
-        serverMetadata: undefined;
-        primaryEmail: undefined;
-        primaryEmailVerified: undefined;
-        selectedTeamId: undefined;
+        display_name: undefined;
+        client_metadata: undefined;
+        server_metadata: undefined;
+        primary_email: undefined;
+        primary_email_verified: undefined;
+        selected_team_id: undefined;
+        auth_with_email: undefined;
     }, "">;
     serverDeleteSchema: yup.MixedSchema<{} | undefined, yup.AnyObject, undefined, "">;
+    docs: {
+        serverCreate: {
+            tags: string[];
+            summary: string;
+            description: string;
+        };
+        serverRead: {
+            tags: string[];
+            summary: string;
+            description: string;
+        };
+        serverUpdate: {
+            tags: string[];
+            summary: string;
+            description: string;
+        };
+        serverDelete: {
+            tags: string[];
+            summary: string;
+            description: string;
+        };
+        serverList: {
+            tags: string[];
+            summary: string;
+            description: string;
+        };
+    };
 }>;
 export type UsersCrud = CrudTypeOf<typeof usersCrud>;

package/dist/interface/crud/users.js

@@ -1,35 +1,67 @@
 import { createCrud } from "../../crud";
 import * as yup from "yup";
-import * as fieldSchema from "./fields";
+import * as fieldSchema from "../../schema-fields";
 export const usersCrudServerUpdateSchema = yup.object({
-    displayName: fieldSchema.userDisplayNameSchema.optional(),
-    clientMetadata: fieldSchema.userClientMetadataSchema.optional(),
-    serverMetadata: fieldSchema.userServerMetadataSchema.optional(),
-    primaryEmail: fieldSchema.primaryEmailSchema.nullable().optional(),
-    primaryEmailVerified: fieldSchema.primaryEmailVerifiedSchema.optional(),
-    selectedTeamId: fieldSchema.selectedTeamIdSchema.nullable().optional(),
+    display_name: fieldSchema.userDisplayNameSchema.optional(),
+    client_metadata: fieldSchema.userClientMetadataSchema.optional(),
+    server_metadata: fieldSchema.userServerMetadataSchema.optional(),
+    primary_email: fieldSchema.primaryEmailSchema.nullable().optional(),
+    primary_email_verified: fieldSchema.primaryEmailVerifiedSchema.optional(),
+    selected_team_id: fieldSchema.selectedTeamIdSchema.nullable().optional(),
 }).required();
 export const usersCrudServerReadSchema = yup.object({
-    projectId: fieldSchema.projectIdSchema.required(),
-    id: fieldSchema.userIdSchema.required(),
-    primaryEmail: fieldSchema.primaryEmailSchema.nullable().defined(),
-    primaryEmailVerified: fieldSchema.primaryEmailVerifiedSchema.required(),
-    displayName: fieldSchema.userDisplayNameSchema.nullable().defined(),
+    project_id: fieldSchema.projectIdSchema.required(),
+    id: fieldSchema.userIdResponseSchema.required(),
+    primary_email: fieldSchema.primaryEmailSchema.nullable().defined(),
+    primary_email_verified: fieldSchema.primaryEmailVerifiedSchema.required(),
+    display_name: fieldSchema.userDisplayNameSchema.nullable().defined(),
     // TODO give this one the type of an actual team
-    selectedTeam: yup.mixed().nullable().defined(),
-    selectedTeamId: fieldSchema.selectedTeamIdSchema.nullable().defined(),
-    profileImageUrl: fieldSchema.profileImageUrlSchema.nullable().defined(),
-    signedUpAtMillis: fieldSchema.signedUpAtMillisSchema.required(),
-    authMethod: yup.string().oneOf(["credential", "oauth"]).required().meta({ openapi: { hide: true } }), // not used anymore, for backwards compatibility
-    hasPassword: yup.boolean().required().meta({ openapi: { description: 'Whether the user has a password', exampleValue: true } }),
-    authWithEmail: yup.boolean().required().meta({ openapi: { description: 'Whether the user can authenticate with their primary e-mail. If set to true, the user can log-in with credentials and/or magic link, if enabled in the project settings.', exampleValue: true } }),
-    oauthProviders: yup.array(yup.string().required()).required().meta({ openapi: { description: 'All the OAuth providers connected to this account', exampleValue: ['google', 'github'] } }),
-    clientMetadata: fieldSchema.userClientMetadataSchema,
-    serverMetadata: fieldSchema.userServerMetadataSchema,
+    selected_team: yup.mixed().nullable().defined(),
+    selected_team_id: fieldSchema.selectedTeamIdSchema.nullable().defined(),
+    profile_image_url: fieldSchema.profileImageUrlSchema.nullable().defined(),
+    signed_up_at_millis: fieldSchema.signedUpAtMillisSchema.required(),
+    has_password: yup.boolean().required().meta({ openapiField: { description: 'Whether the user has a password associated with their account', exampleValue: true } }),
+    auth_with_email: yup.boolean().required().meta({ openapiField: { description: 'Whether the user can authenticate with their primary e-mail. If set to true, the user can log-in with credentials and/or magic link, if enabled in the project settings.', exampleValue: true } }),
+    oauth_providers: yup.array(yup.string().required()).required().meta({ openapiField: { description: 'All the OAuth providers connected to this account', exampleValue: ['google', 'github'] } }),
+    client_metadata: fieldSchema.userClientMetadataSchema,
+    server_metadata: fieldSchema.userServerMetadataSchema,
 }).required();
-const serverDeleteSchema = yup.mixed();
+export const usersCrudServerCreateSchema = usersCrudServerUpdateSchema.concat(yup.object({
+    primary_email: fieldSchema.primaryEmailSchema.required(),
+    primary_email_verified: fieldSchema.primaryEmailVerifiedSchema.required(),
+    auth_with_email: yup.boolean().oneOf([true]).required().meta({ openapiField: { description: 'Must always be set to true.', exampleValue: true } }),
+}).required());
+export const usersCrudServerDeleteSchema = yup.mixed();
 export const usersCrud = createCrud({
     serverReadSchema: usersCrudServerReadSchema,
     serverUpdateSchema: usersCrudServerUpdateSchema,
-    serverDeleteSchema: serverDeleteSchema,
+    serverCreateSchema: usersCrudServerCreateSchema,
+    serverDeleteSchema: usersCrudServerDeleteSchema,
+    docs: {
+        serverCreate: {
+            tags: ["Users"],
+            summary: 'Create user',
+            description: 'Creates a new user. E-mail authentication is always enabled, and no password is set, meaning the only way to authenticate the newly created user is through magic link.',
+        },
+        serverRead: {
+            tags: ["Users"],
+            summary: 'Get user',
+            description: 'Gets a user by user ID.',
+        },
+        serverUpdate: {
+            tags: ["Users"],
+            summary: 'Update user',
+            description: 'Updates a user. Only the values provided will be updated.',
+        },
+        serverDelete: {
+            tags: ["Users"],
+            summary: 'Delete user',
+            description: 'Deletes a user. Use this with caution.',
+        },
+        serverList: {
+            tags: ["Users"],
+            summary: 'List users',
+            description: 'Lists all the users in the project.',
+        },
+    },
 });