@stackframe/stack-shared 2.5.0 → 2.5.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @stackframe/stack-shared
 
+## 2.5.1
+
+### Patch Changes
+
+- New backend endpoints
+  - @stackframe/stack-sc@2.5.1
+
 ## 2.5.0
 
 ### Minor Changes

package/dist/crud.d.ts

@@ -1,20 +1,37 @@
 import * as yup from 'yup';
 import { NullishCoalesce } from './utils/types';
+export type AccessType = "client" | "server" | "admin";
 export type CrudOperation = "create" | "read" | "update" | "delete";
+export type AccessTypeXCrudOperation = `${AccessType}${Capitalize<CrudOperation>}`;
 declare module 'yup' {
     interface CustomSchemaMetadata {
-        openapi?: {
+        openapiField?: {
             description?: string;
             exampleValue?: any;
-            hide?: boolean;
+            hidden?: boolean;
         };
     }
 }
+type ShownEndpointDocumentation = {
+    summary: string;
+    description: string;
+    tags?: string[];
+};
+export type EndpointDocumentation = ({
+    hidden: true;
+} & Partial<ShownEndpointDocumentation>) | ({
+    hidden?: boolean;
+} & ShownEndpointDocumentation);
 type InnerCrudSchema<CreateSchema extends yup.Schema<any> | undefined = yup.Schema<any> | undefined, ReadSchema extends yup.Schema<any> | undefined = yup.Schema<any> | undefined, UpdateSchema extends yup.Schema<any> | undefined = yup.Schema<any> | undefined, DeleteSchema extends yup.Schema<any> | undefined = yup.Schema<any> | undefined> = {
     createSchema: CreateSchema;
+    createDocs: EndpointDocumentation | undefined;
     readSchema: ReadSchema;
+    readDocs: EndpointDocumentation | undefined;
+    listDocs: EndpointDocumentation | undefined;
     updateSchema: UpdateSchema;
+    updateDocs: EndpointDocumentation | undefined;
     deleteSchema: DeleteSchema;
+    deleteDocs: EndpointDocumentation | undefined;
 };
 export type CrudSchema<ClientSchema extends InnerCrudSchema = InnerCrudSchema, ServerSchema extends InnerCrudSchema = InnerCrudSchema, AdminSchema extends InnerCrudSchema = InnerCrudSchema> = {
     client: ClientSchema;
@@ -26,18 +43,7 @@ export type CrudSchema<ClientSchema extends InnerCrudSchema = InnerCrudSchema, S
     hasDelete: boolean;
 };
 export type CrudSchemaCreationOptions = {
-    clientCreateSchema?: yup.Schema<any>;
-    clientReadSchema?: yup.Schema<any>;
-    clientUpdateSchema?: yup.Schema<any>;
-    clientDeleteSchema?: yup.Schema<any>;
-    serverCreateSchema?: yup.Schema<any>;
-    serverReadSchema?: yup.Schema<any>;
-    serverUpdateSchema?: yup.Schema<any>;
-    serverDeleteSchema?: yup.Schema<any>;
-    adminCreateSchema?: yup.Schema<any>;
-    adminReadSchema?: yup.Schema<any>;
-    adminUpdateSchema?: yup.Schema<any>;
-    adminDeleteSchema?: yup.Schema<any>;
+    [K in AccessTypeXCrudOperation as `${K}Schema`]?: yup.Schema<any>;
 };
 type FillInOptionalsPrepareStep<O extends CrudSchemaCreationOptions> = {
     [K in keyof Required<CrudSchemaCreationOptions>]: K extends keyof O ? O[K] : undefined;
@@ -73,5 +79,10 @@ export type CrudTypeOf<S extends CrudSchema> = {
     Server: InnerCrudTypeOf<S['server']>;
     Admin: InnerCrudTypeOf<S['admin']>;
 };
-export declare function createCrud<O extends CrudSchemaCreationOptions>(options: O): CrudSchemaFromOptions<O>;
+type CrudDocsCreationOptions<SO extends CrudSchemaCreationOptions> = {
+    [X in AccessTypeXCrudOperation as (X extends `${infer A}Read` ? X | `${A}List` : X)]?: EndpointDocumentation;
+};
+export declare function createCrud<SO extends CrudSchemaCreationOptions>(options: SO & {
+    docs?: CrudDocsCreationOptions<SO>;
+}): CrudSchemaFromOptions<SO>;
 export {};

package/dist/crud.js

@@ -1,16 +1,27 @@
 import { filterUndefined } from './utils/objects';
 export function createCrud(options) {
+    const docs = options.docs ?? {};
     const client = {
         createSchema: options.clientCreateSchema,
+        createDocs: docs.clientCreate,
         readSchema: options.clientReadSchema,
+        readDocs: docs.clientRead,
+        listDocs: docs.clientList,
         updateSchema: options.clientUpdateSchema,
+        updateDocs: docs.clientUpdate,
         deleteSchema: options.clientDeleteSchema,
+        deleteDocs: docs.clientDelete,
     };
     const serverOverrides = filterUndefined({
         createSchema: options.serverCreateSchema,
+        createDocs: docs.serverCreate,
         readSchema: options.serverReadSchema,
+        readDocs: docs.serverRead,
+        listDocs: docs.serverList,
         updateSchema: options.serverUpdateSchema,
+        updateDocs: docs.serverUpdate,
         deleteSchema: options.serverDeleteSchema,
+        deleteDocs: docs.serverDelete,
     });
     const server = {
         ...client,
@@ -18,9 +29,14 @@ export function createCrud(options) {
     };
     const adminOverrides = filterUndefined({
         createSchema: options.adminCreateSchema,
+        createDocs: docs.adminCreate,
         readSchema: options.adminReadSchema,
+        readDocs: docs.adminRead,
+        listDocs: docs.adminList,
         updateSchema: options.adminUpdateSchema,
+        updateDocs: docs.adminUpdate,
         deleteSchema: options.adminDeleteSchema,
+        deleteDocs: docs.adminDelete,
     });
     const admin = {
         ...server,

package/dist/interface/clientInterface.d.ts

@@ -160,13 +160,13 @@ export declare class StackClientInterface {
         password: string;
     } | {
         onlyVerifyCode: boolean;
-    })): Promise<KnownErrors["PasswordResetError"] | undefined>;
+    })): Promise<KnownErrors["VerificationCodeError"] | undefined>;
     updatePassword(options: {
         oldPassword: string;
         newPassword: string;
     }, session: InternalSession): Promise<KnownErrors["PasswordMismatch"] | KnownErrors["PasswordRequirementsNotMet"] | undefined>;
-    verifyPasswordResetCode(code: string): Promise<KnownErrors["PasswordResetCodeError"] | undefined>;
-    verifyEmail(code: string): Promise<KnownErrors["EmailVerificationError"] | undefined>;
+    verifyPasswordResetCode(code: string): Promise<KnownErrors["VerificationCodeError"] | undefined>;
+    verifyEmail(code: string): Promise<KnownErrors["VerificationCodeError"] | undefined>;
     signInWithCredential(email: string, password: string, session: InternalSession): Promise<KnownErrors["EmailPasswordMismatch"] | {
         accessToken: string;
         refreshToken: string;
@@ -175,7 +175,7 @@ export declare class StackClientInterface {
         accessToken: string;
         refreshToken: string;
     }>;
-    signInWithMagicLink(code: string, session: InternalSession): Promise<KnownErrors["MagicLinkError"] | {
+    signInWithMagicLink(code: string, session: InternalSession): Promise<KnownErrors["VerificationCodeError"] | {
         newUser: boolean;
         accessToken: string;
         refreshToken: string;

package/dist/interface/clientInterface.js

@@ -292,7 +292,7 @@ export class StackClientInterface {
                 "Content-Type": "application/json"
             },
             body: JSON.stringify(options),
-        }, null, [KnownErrors.PasswordResetError]);
+        }, null, [KnownErrors.VerificationCodeError]);
         if (res.status === "error") {
             return res.error;
         }
@@ -311,7 +311,7 @@ export class StackClientInterface {
     }
     async verifyPasswordResetCode(code) {
         const res = await this.resetPassword({ code, onlyVerifyCode: true });
-        if (res && !(res instanceof KnownErrors.PasswordResetCodeError)) {
+        if (res && !(res instanceof KnownErrors.VerificationCodeError)) {
             throw res;
         }
         return res;
@@ -325,7 +325,7 @@ export class StackClientInterface {
             body: JSON.stringify({
                 code,
             }),
-        }, null, [KnownErrors.EmailVerificationError]);
+        }, null, [KnownErrors.VerificationCodeError]);
         if (res.status === "error") {
             return res.error;
         }
@@ -380,7 +380,7 @@ export class StackClientInterface {
             body: JSON.stringify({
                 code,
             }),
-        }, null, [KnownErrors.MagicLinkError]);
+        }, null, [KnownErrors.VerificationCodeError]);
         if (res.status === "error") {
             return res.error;
         }

package/dist/interface/crud/current-user.d.ts

@@ -1,97 +1,110 @@
 import { CrudTypeOf } from "../../crud";
-import * as yup from "yup";
 export declare const currentUserCrud: import("../../crud").CrudSchemaFromOptions<{
-    clientReadSchema: yup.ObjectSchema<{
-        projectId: string;
-        displayName: string | null;
+    clientReadSchema: import("yup").ObjectSchema<{
+        project_id: string;
         id: string;
-        clientMetadata: {} | null;
-        primaryEmail: string | null;
-        primaryEmailVerified: NonNullable<boolean | undefined>;
-        selectedTeamId: string | null;
-        selectedTeam: {} | null;
-        profileImageUrl: string | null;
-        signedUpAtMillis: number;
-        authMethod: NonNullable<"credential" | "oauth" | undefined>;
-        hasPassword: NonNullable<boolean | undefined>;
-        authWithEmail: NonNullable<boolean | undefined>;
-        oauthProviders: string[];
-    } | null, yup.AnyObject, {
-        projectId: undefined;
+        display_name: string | null;
+        client_metadata: {} | null;
+        primary_email: string | null;
+        primary_email_verified: NonNullable<boolean | undefined>;
+        selected_team_id: string | null;
+        selected_team: {} | 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[];
+    } | null, import("yup").AnyObject, {
+        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;
     }, "">;
-    serverReadSchema: yup.ObjectSchema<{
-        projectId: string;
+    serverReadSchema: import("yup").ObjectSchema<{
+        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;
-    } | null, yup.AnyObject, {
-        projectId: undefined;
+        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;
+    } | null, import("yup").AnyObject, {
+        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;
     }, "">;
-    clientUpdateSchema: yup.ObjectSchema<{
-        displayName: string | undefined;
-        clientMetadata: {} | null | undefined;
-        selectedTeamId: string | null | undefined;
-    }, yup.AnyObject, {
-        displayName: undefined;
-        clientMetadata: undefined;
-        serverMetadata: undefined;
-        primaryEmail: undefined;
-        primaryEmailVerified: undefined;
-        selectedTeamId: undefined;
+    clientUpdateSchema: import("yup").ObjectSchema<{
+        display_name: string | null | undefined;
+        client_metadata: {} | null | undefined;
+        selected_team_id: string | null | undefined;
+    }, import("yup").AnyObject, {
+        display_name: undefined;
+        client_metadata: undefined;
+        server_metadata: undefined;
+        primary_email: undefined;
+        primary_email_verified: undefined;
+        selected_team_id: undefined;
     }, "">;
-    serverUpdateSchema: yup.ObjectSchema<{
-        displayName: string | undefined;
-        clientMetadata: {} | null | undefined;
-        serverMetadata: {} | null | undefined;
-        primaryEmail: string | null | undefined;
-        primaryEmailVerified: boolean | undefined;
-        selectedTeamId: string | null | undefined;
-    }, yup.AnyObject, {
-        displayName: undefined;
-        clientMetadata: undefined;
-        serverMetadata: undefined;
-        primaryEmail: undefined;
-        primaryEmailVerified: undefined;
-        selectedTeamId: undefined;
+    serverUpdateSchema: import("yup").ObjectSchema<{
+        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;
+    }, import("yup").AnyObject, {
+        display_name: undefined;
+        client_metadata: undefined;
+        server_metadata: undefined;
+        primary_email: undefined;
+        primary_email_verified: undefined;
+        selected_team_id: undefined;
     }, "">;
+    serverDeleteSchema: import("yup").MixedSchema<{} | undefined, import("yup").AnyObject, undefined, "">;
+    docs: {
+        clientRead: {
+            summary: string;
+            description: string;
+            tags: string[];
+        };
+        clientUpdate: {
+            summary: string;
+            description: string;
+            tags: string[];
+        };
+        clientDelete: {
+            summary: string;
+            description: string;
+            tags: string[];
+        };
+    };
 }>;
 export type CurrentUserCrud = CrudTypeOf<typeof currentUserCrud>;

package/dist/interface/crud/current-user.js

@@ -1,31 +1,49 @@
 import { createCrud } from "../../crud";
-import { usersCrudServerReadSchema, usersCrudServerUpdateSchema } from "./users";
+import { usersCrudServerReadSchema, usersCrudServerUpdateSchema, usersCrudServerDeleteSchema } from "./users";
 const clientUpdateSchema = usersCrudServerUpdateSchema.pick([
-    "displayName",
-    "clientMetadata",
-    "selectedTeamId",
+    "display_name",
+    "client_metadata",
+    "selected_team_id",
 ]).required();
 const serverUpdateSchema = usersCrudServerUpdateSchema;
 const clientReadSchema = usersCrudServerReadSchema.pick([
-    "projectId",
+    "project_id",
     "id",
-    "primaryEmail",
-    "primaryEmailVerified",
-    "displayName",
-    "clientMetadata",
-    "profileImageUrl",
-    "signedUpAtMillis",
-    "authMethod",
-    "hasPassword",
-    "authWithEmail",
-    "oauthProviders",
-    "selectedTeamId",
-    "selectedTeam",
+    "primary_email",
+    "primary_email_verified",
+    "display_name",
+    "client_metadata",
+    "profile_image_url",
+    "signed_up_at_millis",
+    "has_password",
+    "auth_with_email",
+    "oauth_providers",
+    "selected_team_id",
+    "selected_team",
 ]).nullable().defined();
 const serverReadSchema = usersCrudServerReadSchema.nullable().defined();
+const serverDeleteSchema = usersCrudServerDeleteSchema;
 export const currentUserCrud = createCrud({
     clientReadSchema,
     serverReadSchema,
     clientUpdateSchema,
     serverUpdateSchema,
+    serverDeleteSchema,
+    docs: {
+        clientRead: {
+            summary: 'Get current user',
+            description: 'Gets the currently authenticated user.',
+            tags: ['Users'],
+        },
+        clientUpdate: {
+            summary: 'Update current user',
+            description: 'Updates the currently authenticated user. Only the values provided will be updated.',
+            tags: ['Users'],
+        },
+        clientDelete: {
+            summary: 'Delete current user',
+            description: 'Deletes the currently authenticated user. Use this with caution.',
+            tags: ['Users'],
+        },
+    },
 });

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

@@ -1,9 +1,9 @@
 import { CrudTypeOf } from "../../crud";
 import * as yup from "yup";
 export declare const accessTokenReadSchema: yup.ObjectSchema<{
-    accessToken: string;
+    access_token: string;
 }, yup.AnyObject, {
-    accessToken: undefined;
+    access_token: undefined;
 }, "">;
 export declare const accessTokenCreateSchema: yup.ObjectSchema<{
     scope: string | undefined;
@@ -12,9 +12,9 @@ export declare const accessTokenCreateSchema: yup.ObjectSchema<{
 }, "">;
 export declare const accessTokenCrud: import("../../crud").CrudSchemaFromOptions<{
     clientReadSchema: yup.ObjectSchema<{
-        accessToken: string;
+        access_token: string;
     }, yup.AnyObject, {
-        accessToken: undefined;
+        access_token: undefined;
     }, "">;
     clientCreateSchema: yup.ObjectSchema<{
         scope: string | undefined;

package/dist/interface/crud/oauth.js

@@ -1,7 +1,7 @@
 import { createCrud } from "../../crud";
 import * as yup from "yup";
 export const accessTokenReadSchema = yup.object({
-    accessToken: yup.string().required(),
+    access_token: yup.string().required(),
 }).required();
 export const accessTokenCreateSchema = yup.object({
     scope: yup.string().optional(),