@stackframe/stack-shared 2.5.13 → 2.5.15

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @stackframe/stack-shared
 
+## 2.5.15
+
+### Patch Changes
+
+- Webhooks
+- Updated dependencies
+  - @stackframe/stack-sc@2.5.15
+
+## 2.5.14
+
+### Patch Changes
+
+- @stackframe/stack-sc@2.5.14
+
 ## 2.5.13
 
 ### Patch Changes

package/dist/interface/adminInterface.d.ts

@@ -2,6 +2,7 @@ import { InternalSession } from "../sessions";
 import { ApiKeysCrud } from "./crud/api-keys";
 import { EmailTemplateCrud, EmailTemplateType } from "./crud/email-templates";
 import { ProjectsCrud } from "./crud/projects";
+import { SvixTokenCrud } from "./crud/svix-token";
 import { TeamPermissionDefinitionsCrud } from "./crud/team-permissions";
 import { ServerAuthApplicationOptions, StackServerInterface } from "./serverInterface";
 export type AdminAuthApplicationOptions = ServerAuthApplicationOptions & ({
@@ -43,4 +44,5 @@ export declare class StackAdminInterface extends StackServerInterface {
     createPermissionDefinition(data: TeamPermissionDefinitionsCrud['Admin']['Create']): Promise<TeamPermissionDefinitionsCrud['Admin']['Read']>;
     updatePermissionDefinition(permissionId: string, data: TeamPermissionDefinitionsCrud['Admin']['Update']): Promise<TeamPermissionDefinitionsCrud['Admin']['Read']>;
     deletePermissionDefinition(permissionId: string): Promise<void>;
+    getSvixToken(): Promise<SvixTokenCrud["Admin"]["Read"]>;
 }

package/dist/interface/adminInterface.js

@@ -105,4 +105,14 @@ export class StackAdminInterface extends StackServerInterface {
     async deletePermissionDefinition(permissionId) {
         await this.sendAdminRequest(`/team-permission-definitions/${permissionId}`, { method: "DELETE" }, null);
     }
+    async getSvixToken() {
+        const response = await this.sendAdminRequest("/webhooks/svix-token", {
+            method: "POST",
+            headers: {
+                "content-type": "application/json",
+            },
+            body: JSON.stringify({}),
+        }, null);
+        return await response.json();
+    }
 }

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

@@ -20,5 +20,10 @@ export declare const connectedAccountAccessTokenCrud: import("../../crud").CrudS
     }, import("yup").AnyObject, {
         scope: undefined;
     }, "">;
+    docs: {
+        clientCreate: {
+            hidden: true;
+        };
+    };
 }>;
 export type ConnectedAccountAccessTokenCrud = CrudTypeOf<typeof connectedAccountAccessTokenCrud>;

package/dist/interface/crud/oauth.js

@@ -9,4 +9,9 @@ export const connectedAccountAccessTokenCreateSchema = yupObject({
 export const connectedAccountAccessTokenCrud = createCrud({
     clientReadSchema: connectedAccountAccessTokenReadSchema,
     clientCreateSchema: connectedAccountAccessTokenCreateSchema,
+    docs: {
+        clientCreate: {
+            hidden: true,
+        }
+    },
 });

package/dist/interface/crud/svix-token.d.ts

@@ -0,0 +1,21 @@
+import { CrudTypeOf } from "../../crud";
+export declare const svixTokenAdminReadSchema: import("yup").ObjectSchema<{
+    token: string;
+}, import("yup").AnyObject, {
+    token: undefined;
+}, "">;
+export declare const svixTokenAdminCreateSchema: import("yup").ObjectSchema<{}, import("yup").AnyObject, {}, "">;
+export declare const svixTokenCrud: import("../../crud").CrudSchemaFromOptions<{
+    adminReadSchema: import("yup").ObjectSchema<{
+        token: string;
+    }, import("yup").AnyObject, {
+        token: undefined;
+    }, "">;
+    adminCreateSchema: import("yup").ObjectSchema<{}, import("yup").AnyObject, {}, "">;
+    docs: {
+        adminCreate: {
+            hidden: true;
+        };
+    };
+}>;
+export type SvixTokenCrud = CrudTypeOf<typeof svixTokenCrud>;

package/dist/interface/crud/svix-token.js

@@ -0,0 +1,15 @@
+import { createCrud } from "../../crud";
+import { yupObject, yupString } from "../../schema-fields";
+export const svixTokenAdminReadSchema = yupObject({
+    token: yupString().required(),
+}).required();
+export const svixTokenAdminCreateSchema = yupObject({}).required();
+export const svixTokenCrud = createCrud({
+    adminReadSchema: svixTokenAdminReadSchema,
+    adminCreateSchema: svixTokenAdminCreateSchema,
+    docs: {
+        adminCreate: {
+            hidden: true,
+        },
+    }
+});

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

@@ -12,6 +12,11 @@ export declare const teamMembershipsCrud: import("../../crud").CrudSchemaFromOpt
             description: string;
             tags: string[];
         };
+        clientDelete: {
+            summary: string;
+            description: string;
+            tags: string[];
+        };
         serverDelete: {
             summary: string;
             description: string;

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

@@ -15,6 +15,11 @@ export const teamMembershipsCrud = createCrud({
             description: "",
             tags: ["Teams"],
         },
+        clientDelete: {
+            summary: "Remove a user from a team",
+            description: "All the users are allowed to remove themselves from a team (`user_id=me`). Only the users who have the `$remove_members` permission are allowed to remove other users from a team. `team_id` is must an ID of a team that the user is a member of.",
+            tags: ["Teams"],
+        },
         serverDelete: {
             summary: "Remove a user from a team",
             description: "",

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

@@ -126,6 +126,16 @@ export declare const teamsCrud: import("../../crud").CrudSchemaFromOptions<{
             description: string;
             tags: string[];
         };
+        clientUpdate: {
+            summary: string;
+            description: string;
+            tags: string[];
+        };
+        clientDelete: {
+            summary: string;
+            description: string;
+            tags: string[];
+        };
         serverCreate: {
             summary: string;
             description: string;
@@ -154,3 +164,56 @@ export declare const teamsCrud: import("../../crud").CrudSchemaFromOptions<{
     };
 }>;
 export type TeamsCrud = CrudTypeOf<typeof teamsCrud>;
+export declare const teamCreatedWebhookEvent: {
+    type: string;
+    schema: import("yup").ObjectSchema<{
+        id: string;
+        display_name: string;
+        profile_image_url: string | null;
+    } & {
+        created_at_millis: number;
+    }, import("yup").AnyObject, {
+        id: undefined;
+        display_name: undefined;
+        profile_image_url: undefined;
+        created_at_millis: undefined;
+    }, "">;
+    metadata: {
+        summary: string;
+        description: string;
+        tags: string[];
+    };
+};
+export declare const teamUpdatedWebhookEvent: {
+    type: string;
+    schema: import("yup").ObjectSchema<{
+        id: string;
+        display_name: string;
+        profile_image_url: string | null;
+    } & {
+        created_at_millis: number;
+    }, import("yup").AnyObject, {
+        id: undefined;
+        display_name: undefined;
+        profile_image_url: undefined;
+        created_at_millis: undefined;
+    }, "">;
+    metadata: {
+        summary: string;
+        description: string;
+        tags: string[];
+    };
+};
+export declare const teamDeletedWebhookEvent: {
+    type: string;
+    schema: import("yup").ObjectSchema<{
+        id: string;
+    }, import("yup").AnyObject, {
+        id: undefined;
+    }, "">;
+    metadata: {
+        summary: string;
+        description: string;
+        tags: string[];
+    };
+};

package/dist/interface/crud/teams.js

@@ -1,6 +1,6 @@
 import { createCrud } from "../../crud";
 import * as fieldSchema from "../../schema-fields";
-import { yupMixed, yupObject } from "../../schema-fields";
+import { yupObject } from "../../schema-fields";
 // Read
 export const teamsCrudClientReadSchema = yupObject({
     id: fieldSchema.teamIdSchema.required(),
@@ -24,7 +24,7 @@ export const teamsCrudServerCreateSchema = teamsCrudServerUpdateSchema.concat(yu
     display_name: fieldSchema.teamDisplayNameSchema.required(),
 }).required());
 // Delete
-export const teamsCrudClientDeleteSchema = yupMixed();
+export const teamsCrudClientDeleteSchema = fieldSchema.yupMixed();
 export const teamsCrudServerDeleteSchema = teamsCrudClientDeleteSchema;
 export const teamsCrud = createCrud({
     // Client
@@ -53,6 +53,16 @@ export const teamsCrud = createCrud({
             description: "Get a team that the current user is a member of.",
             tags: ["Teams"],
         },
+        clientUpdate: {
+            summary: "Update a team",
+            description: "Update the team information. Only allowed if the current user is a member of the team and has the `$update_team` permission.",
+            tags: ["Teams"],
+        },
+        clientDelete: {
+            summary: "Delete a team",
+            description: "Delete a team. Only allowed if the current user is a member of the team and has the `$delete_team` permission.",
+            tags: ["Teams"],
+        },
         serverCreate: {
             summary: "Create a team",
             description: "Create a new team and optionally add the current user as a member.",
@@ -80,3 +90,33 @@ export const teamsCrud = createCrud({
         },
     },
 });
+export const teamCreatedWebhookEvent = {
+    type: "team.created",
+    schema: teamsCrud.server.readSchema,
+    metadata: {
+        summary: "Team Created",
+        description: "This event is triggered when a team is created.",
+        tags: ["Teams"],
+    },
+};
+export const teamUpdatedWebhookEvent = {
+    type: "team.updated",
+    schema: teamsCrud.server.readSchema,
+    metadata: {
+        summary: "Team Updated",
+        description: "This event is triggered when a team is updated.",
+        tags: ["Teams"],
+    },
+};
+const webhookTeamDeletedSchema = fieldSchema.yupObject({
+    id: fieldSchema.userIdSchema.required(),
+}).required();
+export const teamDeletedWebhookEvent = {
+    type: "team.deleted",
+    schema: webhookTeamDeletedSchema,
+    metadata: {
+        summary: "Team Deleted",
+        description: "This event is triggered when a team is deleted.",
+        tags: ["Teams"],
+    },
+};

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

@@ -215,3 +215,118 @@ export declare const usersCrud: import("../../crud").CrudSchemaFromOptions<{
     };
 }>;
 export type UsersCrud = CrudTypeOf<typeof usersCrud>;
+export declare const userCreatedWebhookEvent: {
+    type: string;
+    schema: import("yup").ObjectSchema<{
+        id: string;
+        primary_email: string | null;
+        primary_email_verified: NonNullable<boolean | undefined>;
+        display_name: string | null;
+        selected_team: {
+            id: string;
+            created_at_millis: number;
+            display_name: string;
+            profile_image_url: string | null;
+        } | 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: {
+            email?: string | null | undefined;
+            id: string;
+            account_id: string;
+        }[];
+        client_metadata: {} | null;
+        server_metadata: {} | null;
+    }, import("yup").AnyObject, {
+        id: undefined;
+        primary_email: undefined;
+        primary_email_verified: undefined;
+        display_name: undefined;
+        selected_team: {
+            id: undefined;
+            display_name: undefined;
+            profile_image_url: undefined;
+            created_at_millis: 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;
+    }, "">;
+    metadata: {
+        summary: string;
+        description: string;
+        tags: string[];
+    };
+};
+export declare const userUpdatedWebhookEvent: {
+    type: string;
+    schema: import("yup").ObjectSchema<{
+        id: string;
+        primary_email: string | null;
+        primary_email_verified: NonNullable<boolean | undefined>;
+        display_name: string | null;
+        selected_team: {
+            id: string;
+            created_at_millis: number;
+            display_name: string;
+            profile_image_url: string | null;
+        } | 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: {
+            email?: string | null | undefined;
+            id: string;
+            account_id: string;
+        }[];
+        client_metadata: {} | null;
+        server_metadata: {} | null;
+    }, import("yup").AnyObject, {
+        id: undefined;
+        primary_email: undefined;
+        primary_email_verified: undefined;
+        display_name: undefined;
+        selected_team: {
+            id: undefined;
+            display_name: undefined;
+            profile_image_url: undefined;
+            created_at_millis: 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;
+    }, "">;
+    metadata: {
+        summary: string;
+        description: string;
+        tags: string[];
+    };
+};
+export declare const userDeletedWebhookEvent: {
+    type: string;
+    schema: import("yup").ObjectSchema<{
+        id: string;
+    }, import("yup").AnyObject, {
+        id: undefined;
+    }, "">;
+    metadata: {
+        summary: string;
+        description: string;
+        tags: string[];
+    };
+};

package/dist/interface/crud/users.js

@@ -72,3 +72,33 @@ export const usersCrud = createCrud({
         },
     },
 });
+export const userCreatedWebhookEvent = {
+    type: "user.created",
+    schema: usersCrud.server.readSchema,
+    metadata: {
+        summary: "User Created",
+        description: "This event is triggered when a user is created.",
+        tags: ["Users"],
+    },
+};
+export const userUpdatedWebhookEvent = {
+    type: "user.updated",
+    schema: usersCrud.server.readSchema,
+    metadata: {
+        summary: "User Updated",
+        description: "This event is triggered when a user is updated.",
+        tags: ["Users"],
+    },
+};
+const webhookUserDeletedSchema = fieldSchema.yupObject({
+    id: fieldSchema.userIdSchema.required(),
+}).required();
+export const userDeletedWebhookEvent = {
+    type: "user.deleted",
+    schema: webhookUserDeletedSchema,
+    metadata: {
+        summary: "User Deleted",
+        description: "This event is triggered when a user is deleted.",
+        tags: ["Users"],
+    },
+};

package/dist/interface/webhooks.d.ts

@@ -0,0 +1,173 @@
+import * as yup from "yup";
+export type WebhookEvent<S extends yup.Schema> = {
+    type: string;
+    schema: S;
+    metadata: {
+        summary: string;
+        description: string;
+        tags?: string[];
+    };
+};
+export declare const webhookEvents: readonly [{
+    type: string;
+    schema: yup.ObjectSchema<{
+        id: string;
+        primary_email: string | null;
+        primary_email_verified: NonNullable<boolean | undefined>;
+        display_name: string | null;
+        selected_team: {
+            id: string;
+            created_at_millis: number;
+            display_name: string;
+            profile_image_url: string | null;
+        } | 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: {
+            email?: string | null | undefined;
+            id: string;
+            account_id: string;
+        }[];
+        client_metadata: {} | null;
+        server_metadata: {} | null;
+    }, yup.AnyObject, {
+        id: undefined;
+        primary_email: undefined;
+        primary_email_verified: undefined;
+        display_name: undefined;
+        selected_team: {
+            id: undefined;
+            display_name: undefined;
+            profile_image_url: undefined;
+            created_at_millis: 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;
+    }, "">;
+    metadata: {
+        summary: string;
+        description: string;
+        tags: string[];
+    };
+}, {
+    type: string;
+    schema: yup.ObjectSchema<{
+        id: string;
+        primary_email: string | null;
+        primary_email_verified: NonNullable<boolean | undefined>;
+        display_name: string | null;
+        selected_team: {
+            id: string;
+            created_at_millis: number;
+            display_name: string;
+            profile_image_url: string | null;
+        } | 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: {
+            email?: string | null | undefined;
+            id: string;
+            account_id: string;
+        }[];
+        client_metadata: {} | null;
+        server_metadata: {} | null;
+    }, yup.AnyObject, {
+        id: undefined;
+        primary_email: undefined;
+        primary_email_verified: undefined;
+        display_name: undefined;
+        selected_team: {
+            id: undefined;
+            display_name: undefined;
+            profile_image_url: undefined;
+            created_at_millis: 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;
+    }, "">;
+    metadata: {
+        summary: string;
+        description: string;
+        tags: string[];
+    };
+}, {
+    type: string;
+    schema: yup.ObjectSchema<{
+        id: string;
+    }, yup.AnyObject, {
+        id: undefined;
+    }, "">;
+    metadata: {
+        summary: string;
+        description: string;
+        tags: string[];
+    };
+}, {
+    type: string;
+    schema: yup.ObjectSchema<{
+        id: string;
+        display_name: string;
+        profile_image_url: string | null;
+    } & {
+        created_at_millis: number;
+    }, yup.AnyObject, {
+        id: undefined;
+        display_name: undefined;
+        profile_image_url: undefined;
+        created_at_millis: undefined;
+    }, "">;
+    metadata: {
+        summary: string;
+        description: string;
+        tags: string[];
+    };
+}, {
+    type: string;
+    schema: yup.ObjectSchema<{
+        id: string;
+        display_name: string;
+        profile_image_url: string | null;
+    } & {
+        created_at_millis: number;
+    }, yup.AnyObject, {
+        id: undefined;
+        display_name: undefined;
+        profile_image_url: undefined;
+        created_at_millis: undefined;
+    }, "">;
+    metadata: {
+        summary: string;
+        description: string;
+        tags: string[];
+    };
+}, {
+    type: string;
+    schema: yup.ObjectSchema<{
+        id: string;
+    }, yup.AnyObject, {
+        id: undefined;
+    }, "">;
+    metadata: {
+        summary: string;
+        description: string;
+        tags: string[];
+    };
+}];

package/dist/interface/webhooks.js

@@ -0,0 +1,10 @@
+import { teamCreatedWebhookEvent, teamDeletedWebhookEvent, teamUpdatedWebhookEvent } from "./crud/teams";
+import { userCreatedWebhookEvent, userDeletedWebhookEvent, userUpdatedWebhookEvent } from "./crud/users";
+export const webhookEvents = [
+    userCreatedWebhookEvent,
+    userUpdatedWebhookEvent,
+    userDeletedWebhookEvent,
+    teamCreatedWebhookEvent,
+    teamUpdatedWebhookEvent,
+    teamDeletedWebhookEvent,
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackframe/stack-shared",
-  "version": "2.5.13",
+  "version": "2.5.15",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -36,7 +36,7 @@
     "jose": "^5.2.2",
     "oauth4webapi": "^2.10.3",
     "uuid": "^9.0.1",
-    "@stackframe/stack-sc": "2.5.13"
+    "@stackframe/stack-sc": "2.5.15"
   },
   "devDependencies": {
     "rimraf": "^5.0.5",