@stackframe/stack-shared 2.8.2 → 2.8.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @stackframe/stack-shared
 
+## 2.8.3
+
+### Patch Changes
+
+- Various changes
+
 ## 2.8.2
 
 ### Patch Changes

package/dist/interface/adminInterface.d.ts

@@ -1,7 +1,7 @@
 import { InternalSession } from "../sessions";
-import { ApiKeysCrud } from "./crud/api-keys";
 import { EmailTemplateCrud, EmailTemplateType } from "./crud/email-templates";
 import { InternalEmailsCrud } from "./crud/emails";
+import { InternalApiKeysCrud } from "./crud/internal-api-keys";
 import { ProjectPermissionDefinitionsCrud } from "./crud/project-permissions";
 import { ProjectsCrud } from "./crud/projects";
 import { SvixTokenCrud } from "./crud/svix-token";
@@ -12,14 +12,14 @@ export type AdminAuthApplicationOptions = ServerAuthApplicationOptions & ({
 } | {
     projectOwnerSession: InternalSession;
 });
-export type ApiKeyCreateCrudRequest = {
+export type InternalApiKeyCreateCrudRequest = {
     has_publishable_client_key: boolean;
     has_secret_server_key: boolean;
     has_super_secret_admin_key: boolean;
     expires_at_millis: number;
     description: string;
 };
-export type ApiKeyCreateCrudResponse = ApiKeysCrud["Admin"]["Read"] & {
+export type InternalApiKeyCreateCrudResponse = InternalApiKeysCrud["Admin"]["Read"] & {
     publishable_client_key?: string;
     secret_server_key?: string;
     super_secret_admin_key?: string;
@@ -35,10 +35,10 @@ export declare class StackAdminInterface extends StackServerInterface {
     }>;
     getProject(): Promise<ProjectsCrud["Admin"]["Read"]>;
     updateProject(update: ProjectsCrud["Admin"]["Update"]): Promise<ProjectsCrud["Admin"]["Read"]>;
-    createApiKey(options: ApiKeyCreateCrudRequest): Promise<ApiKeyCreateCrudResponse>;
-    listApiKeys(): Promise<ApiKeysCrud["Admin"]["Read"][]>;
-    revokeApiKeyById(id: string): Promise<void>;
-    getApiKey(id: string, session: InternalSession): Promise<ApiKeysCrud["Admin"]["Read"]>;
+    createInternalApiKey(options: InternalApiKeyCreateCrudRequest): Promise<InternalApiKeyCreateCrudResponse>;
+    listInternalApiKeys(): Promise<InternalApiKeysCrud["Admin"]["Read"][]>;
+    revokeInternalApiKeyById(id: string): Promise<void>;
+    getInternalApiKey(id: string, session: InternalSession): Promise<InternalApiKeysCrud["Admin"]["Read"]>;
     listEmailTemplates(): Promise<EmailTemplateCrud['Admin']['Read'][]>;
     updateEmailTemplate(type: EmailTemplateType, data: EmailTemplateCrud['Admin']['Update']): Promise<EmailTemplateCrud['Admin']['Read']>;
     resetEmailTemplate(type: EmailTemplateType): Promise<void>;

package/dist/interface/adminInterface.js

@@ -29,7 +29,7 @@ export class StackAdminInterface extends StackServerInterface {
         }, null);
         return await response.json();
     }
-    async createApiKey(options) {
+    async createInternalApiKey(options) {
         const response = await this.sendAdminRequest("/internal/api-keys", {
             method: "POST",
             headers: {
@@ -39,12 +39,12 @@ export class StackAdminInterface extends StackServerInterface {
         }, null);
         return await response.json();
     }
-    async listApiKeys() {
+    async listInternalApiKeys() {
         const response = await this.sendAdminRequest("/internal/api-keys", {}, null);
         const result = await response.json();
         return result.items;
     }
-    async revokeApiKeyById(id) {
+    async revokeInternalApiKeyById(id) {
         await this.sendAdminRequest(`/internal/api-keys/${id}`, {
             method: "PATCH",
             headers: {
@@ -55,7 +55,7 @@ export class StackAdminInterface extends StackServerInterface {
             }),
         }, null);
     }
-    async getApiKey(id, session) {
+    async getInternalApiKey(id, session) {
         const response = await this.sendAdminRequest(`/internal/api-keys/${id}`, {}, session);
         return await response.json();
     }

package/dist/interface/clientInterface.d.ts

@@ -1,3 +1,4 @@
+import * as yup from 'yup';
 import { KnownErrors } from '../known-errors';
 import { AccessToken, InternalSession, RefreshToken } from '../sessions';
 import { ReadonlyJson } from '../utils/json';
@@ -6,6 +7,7 @@ import { Result } from "../utils/results";
 import { ContactChannelsCrud } from './crud/contact-channels';
 import { CurrentUserCrud } from './crud/current-user';
 import { ConnectedAccountAccessTokenCrud } from './crud/oauth';
+import { TeamApiKeysCrud, UserApiKeysCrud, teamApiKeysCreateInputSchema, teamApiKeysCreateOutputSchema, userApiKeysCreateInputSchema, userApiKeysCreateOutputSchema } from './crud/project-api-keys';
 import { ProjectPermissionsCrud } from './crud/project-permissions';
 import { InternalProjectsCrud, ProjectsCrud } from './crud/projects';
 import { SessionsCrud } from './crud/sessions';
@@ -208,4 +210,44 @@ export declare class StackClientInterface {
     listClientContactChannels(session: InternalSession): Promise<ContactChannelsCrud['Client']['Read'][]>;
     sendCurrentUserContactChannelVerificationEmail(contactChannelId: string, callbackUrl: string, session: InternalSession): Promise<Result<undefined, KnownErrors["EmailAlreadyVerified"]>>;
     cliLogin(loginCode: string, refreshToken: string, session: InternalSession): Promise<Result<undefined, KnownErrors["SchemaError"]>>;
+    private _getApiKeyRequestInfo;
+    listProjectApiKeys(options: {
+        user_id: string;
+    }, session: InternalSession | null, requestType: "client" | "server" | "admin"): Promise<UserApiKeysCrud['Client']['Read'][]>;
+    listProjectApiKeys(options: {
+        team_id: string;
+    }, session: InternalSession | null, requestType: "client" | "server" | "admin"): Promise<TeamApiKeysCrud['Client']['Read'][]>;
+    listProjectApiKeys(options: {
+        user_id: string;
+    } | {
+        team_id: string;
+    }, session: InternalSession | null, requestType: "client" | "server" | "admin"): Promise<(UserApiKeysCrud['Client']['Read'] | TeamApiKeysCrud['Client']['Read'])[]>;
+    createProjectApiKey(data: yup.InferType<typeof userApiKeysCreateInputSchema>, session: InternalSession | null, requestType: "client" | "server" | "admin"): Promise<yup.InferType<typeof userApiKeysCreateOutputSchema>>;
+    createProjectApiKey(data: yup.InferType<typeof teamApiKeysCreateInputSchema>, session: InternalSession | null, requestType: "client" | "server" | "admin"): Promise<yup.InferType<typeof teamApiKeysCreateOutputSchema>>;
+    createProjectApiKey(data: yup.InferType<typeof userApiKeysCreateInputSchema> | yup.InferType<typeof teamApiKeysCreateInputSchema>, session: InternalSession | null, requestType: "client" | "server" | "admin"): Promise<yup.InferType<typeof userApiKeysCreateOutputSchema> | yup.InferType<typeof teamApiKeysCreateOutputSchema>>;
+    getProjectApiKey(options: {
+        user_id: string | null;
+    }, keyId: string, session: InternalSession | null, requestType: "client" | "server" | "admin"): Promise<UserApiKeysCrud['Client']['Read']>;
+    getProjectApiKey(options: {
+        team_id: string;
+    }, keyId: string, session: InternalSession | null, requestType: "client" | "server" | "admin"): Promise<TeamApiKeysCrud['Client']['Read']>;
+    getProjectApiKey(options: {
+        user_id: string | null;
+    } | {
+        team_id: string;
+    }, keyId: string, session: InternalSession | null, requestType: "client" | "server" | "admin"): Promise<UserApiKeysCrud['Client']['Read'] | TeamApiKeysCrud['Client']['Read']>;
+    updateProjectApiKey(options: {
+        user_id: string;
+    }, keyId: string, data: UserApiKeysCrud['Client']['Update'], session: InternalSession | null, requestType: "client" | "server" | "admin"): Promise<UserApiKeysCrud['Client']['Read']>;
+    updateProjectApiKey(options: {
+        team_id: string;
+    }, keyId: string, data: TeamApiKeysCrud['Client']['Update'], session: InternalSession | null, requestType: "client" | "server" | "admin"): Promise<TeamApiKeysCrud['Client']['Read']>;
+    updateProjectApiKey(options: {
+        user_id: string;
+    } | {
+        team_id: string;
+    }, keyId: string, data: UserApiKeysCrud['Client']['Update'] | TeamApiKeysCrud['Client']['Update'], session: InternalSession | null, requestType: "client" | "server" | "admin"): Promise<UserApiKeysCrud['Client']['Read'] | TeamApiKeysCrud['Client']['Read']>;
+    checkProjectApiKey(type: "user", apiKey: string, session: InternalSession | null, requestType: "client" | "server" | "admin"): Promise<UserApiKeysCrud['Client']['Read'] | null>;
+    checkProjectApiKey(type: "team", apiKey: string, session: InternalSession | null, requestType: "client" | "server" | "admin"): Promise<TeamApiKeysCrud['Client']['Read'] | null>;
+    checkProjectApiKey(type: "user" | "team", apiKey: string, session: InternalSession | null, requestType: "client" | "server" | "admin"): Promise<UserApiKeysCrud['Client']['Read'] | TeamApiKeysCrud['Client']['Read'] | null>;
 }

package/dist/interface/clientInterface.js

@@ -5,7 +5,7 @@ import { generateSecureRandomString } from '../utils/crypto';
 import { StackAssertionError, throwErr } from '../utils/errors';
 import { globalVar } from '../utils/globals';
 import { HTTP_METHODS } from '../utils/http';
-import { filterUndefined } from '../utils/objects';
+import { filterUndefined, filterUndefinedOrNull } from '../utils/objects';
 import { wait } from '../utils/promises';
 import { Result } from "../utils/results";
 import { deindent } from '../utils/strings';
@@ -173,7 +173,7 @@ export class StackClientInterface {
         }
         const params = {
             /**
-             * This fetch may be cross-origin, in which case we don't want to send cookies of the
+             * This fetch may be cross-origin, in which case we don't want to send cookies of the
              * original origin (this is the default behavior of `credentials`).
              *
              * To help debugging, also omit cookies on same-origin, so we don't accidentally
@@ -942,4 +942,68 @@ export class StackClientInterface {
         }
         return Result.ok(undefined);
     }
+    async _getApiKeyRequestInfo(options) {
+        if ("user_id" in options && "team_id" in options) {
+            throw new StackAssertionError("Cannot specify both user_id and team_id in _getApiKeyRequestInfo");
+        }
+        return {
+            endpoint: "team_id" in options ? "/team-api-keys" : "/user-api-keys",
+            queryParams: new URLSearchParams(filterUndefinedOrNull(options)),
+        };
+    }
+    async listProjectApiKeys(options, session, requestType) {
+        const sendRequest = (requestType === "client" ? this.sendClientRequest : this.sendServerRequest).bind(this);
+        const { endpoint, queryParams } = await this._getApiKeyRequestInfo(options);
+        const response = await sendRequest(`${endpoint}?${queryParams.toString()}`, {
+            method: "GET",
+        }, session, requestType);
+        const json = await response.json();
+        return json.items;
+    }
+    async createProjectApiKey(data, session, requestType) {
+        const sendRequest = (requestType === "client" ? this.sendClientRequest : this.sendServerRequest).bind(this);
+        const { endpoint } = await this._getApiKeyRequestInfo(data);
+        const response = await sendRequest(`${endpoint}`, {
+            method: "POST",
+            headers: {
+                "content-type": "application/json",
+            },
+            body: JSON.stringify(data),
+        }, session, requestType);
+        return await response.json();
+    }
+    async getProjectApiKey(options, keyId, session, requestType) {
+        const sendRequest = (requestType === "client" ? this.sendClientRequest : this.sendServerRequest).bind(this);
+        const { endpoint, queryParams } = await this._getApiKeyRequestInfo(options);
+        const response = await sendRequest(`${endpoint}/${keyId}?${queryParams.toString()}`, {
+            method: "GET",
+        }, session, requestType);
+        return await response.json();
+    }
+    async updateProjectApiKey(options, keyId, data, session, requestType) {
+        const sendRequest = (requestType === "client" ? this.sendClientRequest : this.sendServerRequest).bind(this);
+        const { endpoint, queryParams } = await this._getApiKeyRequestInfo(options);
+        const response = await sendRequest(`${endpoint}/${keyId}?${queryParams.toString()}`, {
+            method: "PATCH",
+            headers: {
+                "content-type": "application/json",
+            },
+            body: JSON.stringify(data),
+        }, session, requestType);
+        return await response.json();
+    }
+    async checkProjectApiKey(type, apiKey, session, requestType) {
+        const sendRequest = (requestType === "client" ? this.sendClientRequestAndCatchKnownError : this.sendServerRequestAndCatchKnownError).bind(this);
+        const result = await sendRequest(`/${type}-api-keys/check`, {
+            method: "POST",
+            headers: {
+                "content-type": "application/json",
+            },
+            body: JSON.stringify({ api_key: apiKey }),
+        }, session, [KnownErrors.ApiKeyNotValid]);
+        if (result.status === "error") {
+            return null;
+        }
+        return await result.data.json();
+    }
 }

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

@@ -68,8 +68,8 @@ export declare const currentUserCrud: import("../../crud").CrudSchemaFromOptions
             client_read_only_metadata?: {} | null | undefined;
             server_metadata?: {} | null | undefined;
             id: string;
-            created_at_millis: number;
             display_name: string;
+            created_at_millis: number;
             profile_image_url: string | null;
         } | null;
         selected_team_id: string | null;

package/dist/interface/crud/{api-keys.d.ts → internal-api-keys.d.ts}

@@ -1,5 +1,5 @@
 import { CrudTypeOf } from "../../crud";
-export declare const apiKeysCreateInputSchema: import("yup").ObjectSchema<{
+export declare const internalApiKeysCreateInputSchema: import("yup").ObjectSchema<{
     description: string;
     expires_at_millis: number;
     has_publishable_client_key: boolean;
@@ -12,7 +12,7 @@ export declare const apiKeysCreateInputSchema: import("yup").ObjectSchema<{
     has_secret_server_key: undefined;
     has_super_secret_admin_key: undefined;
 }, "">;
-export declare const apiKeysCreateOutputSchema: import("yup").ObjectSchema<{
+export declare const internalApiKeysCreateOutputSchema: import("yup").ObjectSchema<{
     id: string;
     description: string;
     expires_at_millis: number;
@@ -32,7 +32,7 @@ export declare const apiKeysCreateOutputSchema: import("yup").ObjectSchema<{
     secret_server_key: undefined;
     super_secret_admin_key: undefined;
 }, "">;
-export declare const apiKeysCrudAdminObfuscatedReadSchema: import("yup").ObjectSchema<{
+export declare const internalApiKeysCrudAdminObfuscatedReadSchema: import("yup").ObjectSchema<{
     id: string;
     description: string;
     expires_at_millis: number;
@@ -64,15 +64,15 @@ export declare const apiKeysCrudAdminObfuscatedReadSchema: import("yup").ObjectS
         last_four: undefined;
     };
 }, "">;
-export declare const apiKeysCrudAdminUpdateSchema: import("yup").ObjectSchema<{
+export declare const internalApiKeysCrudAdminUpdateSchema: import("yup").ObjectSchema<{
     description: string | undefined;
     revoked: boolean | undefined;
 }, import("yup").AnyObject, {
     description: undefined;
     revoked: undefined;
 }, "">;
-export declare const apiKeysCrudAdminDeleteSchema: import("yup").MixedSchema<{} | undefined, import("yup").AnyObject, undefined, "">;
-export declare const apiKeysCrud: import("../../crud").CrudSchemaFromOptions<{
+export declare const internalApiKeysCrudAdminDeleteSchema: import("yup").MixedSchema<{} | undefined, import("yup").AnyObject, undefined, "">;
+export declare const internalApiKeysCrud: import("../../crud").CrudSchemaFromOptions<{
     adminReadSchema: import("yup").ObjectSchema<{
         id: string;
         description: string;
@@ -131,4 +131,4 @@ export declare const apiKeysCrud: import("../../crud").CrudSchemaFromOptions<{
         };
     };
 }>;
-export type ApiKeysCrud = CrudTypeOf<typeof apiKeysCrud>;
+export type InternalApiKeysCrud = CrudTypeOf<typeof internalApiKeysCrud>;

package/dist/interface/crud/{api-keys.js → internal-api-keys.js}

@@ -1,6 +1,6 @@
 import { createCrud } from "../../crud";
 import { yupBoolean, yupMixed, yupNumber, yupObject, yupString } from "../../schema-fields";
-const baseApiKeysReadSchema = yupObject({
+const baseInternalApiKeysReadSchema = yupObject({
     id: yupString().defined(),
     description: yupString().defined(),
     expires_at_millis: yupNumber().defined(),
@@ -8,20 +8,20 @@ const baseApiKeysReadSchema = yupObject({
     created_at_millis: yupNumber().defined(),
 });
 // Used for the result of the create endpoint
-export const apiKeysCreateInputSchema = yupObject({
+export const internalApiKeysCreateInputSchema = yupObject({
     description: yupString().defined(),
     expires_at_millis: yupNumber().defined(),
     has_publishable_client_key: yupBoolean().defined(),
     has_secret_server_key: yupBoolean().defined(),
     has_super_secret_admin_key: yupBoolean().defined(),
 });
-export const apiKeysCreateOutputSchema = baseApiKeysReadSchema.concat(yupObject({
+export const internalApiKeysCreateOutputSchema = baseInternalApiKeysReadSchema.concat(yupObject({
     publishable_client_key: yupString().optional(),
     secret_server_key: yupString().optional(),
     super_secret_admin_key: yupString().optional(),
 }).defined());
 // Used for list, read and update endpoints after the initial creation
-export const apiKeysCrudAdminObfuscatedReadSchema = baseApiKeysReadSchema.concat(yupObject({
+export const internalApiKeysCrudAdminObfuscatedReadSchema = baseInternalApiKeysReadSchema.concat(yupObject({
     publishable_client_key: yupObject({
         last_four: yupString().defined(),
     }).optional(),
@@ -32,15 +32,15 @@ export const apiKeysCrudAdminObfuscatedReadSchema = baseApiKeysReadSchema.concat
         last_four: yupString().defined(),
     }).optional(),
 }));
-export const apiKeysCrudAdminUpdateSchema = yupObject({
+export const internalApiKeysCrudAdminUpdateSchema = yupObject({
     description: yupString().optional(),
     revoked: yupBoolean().oneOf([true]).optional(),
 }).defined();
-export const apiKeysCrudAdminDeleteSchema = yupMixed();
-export const apiKeysCrud = createCrud({
-    adminReadSchema: apiKeysCrudAdminObfuscatedReadSchema,
-    adminUpdateSchema: apiKeysCrudAdminUpdateSchema,
-    adminDeleteSchema: apiKeysCrudAdminDeleteSchema,
+export const internalApiKeysCrudAdminDeleteSchema = yupMixed();
+export const internalApiKeysCrud = createCrud({
+    adminReadSchema: internalApiKeysCrudAdminObfuscatedReadSchema,
+    adminUpdateSchema: internalApiKeysCrudAdminUpdateSchema,
+    adminDeleteSchema: internalApiKeysCrudAdminDeleteSchema,
     docs: {
         adminList: {
             hidden: true,

package/dist/interface/crud/project-api-keys.d.ts

@@ -0,0 +1,188 @@
+import * as yup from "yup";
+import { CrudTypeOf } from "../../crud";
+export declare const userApiKeysCrud: import("../../crud").CrudSchemaFromOptions<{
+    clientReadSchema: yup.ObjectSchema<{
+        id: string;
+        description: string;
+        expires_at_millis: number | undefined;
+        manually_revoked_at_millis: number | undefined;
+        created_at_millis: number;
+        is_public: boolean;
+        value: {
+            last_four: string;
+        };
+        type: "user";
+        user_id: string;
+    }, yup.AnyObject, {
+        id: undefined;
+        description: undefined;
+        expires_at_millis: undefined;
+        manually_revoked_at_millis: undefined;
+        created_at_millis: undefined;
+        is_public: undefined;
+        value: {
+            last_four: undefined;
+        };
+        type: undefined;
+        user_id: undefined;
+    }, "">;
+    clientUpdateSchema: yup.ObjectSchema<{
+        description: string | undefined;
+        revoked: boolean | undefined;
+    }, yup.AnyObject, {
+        description: undefined;
+        revoked: undefined;
+    }, "">;
+    docs: {
+        clientCreate: {
+            description: string;
+            displayName: string;
+            summary: string;
+        };
+        clientList: {
+            description: string;
+            displayName: string;
+            summary: string;
+        };
+        clientRead: {
+            description: string;
+            displayName: string;
+            summary: string;
+        };
+        clientUpdate: {
+            description: string;
+            displayName: string;
+            summary: string;
+        };
+        serverDelete: {
+            description: string;
+            displayName: string;
+            summary: string;
+        };
+    };
+}>, userApiKeysCreateInputSchema: yup.ObjectSchema<{
+    description: string;
+    expires_at_millis: number | null;
+    is_public: boolean | undefined;
+    user_id: string;
+}, yup.AnyObject, {
+    description: undefined;
+    expires_at_millis: undefined;
+    is_public: undefined;
+    user_id: undefined;
+}, "">, userApiKeysCreateOutputSchema: yup.ObjectSchema<{
+    type: "user";
+    user_id: string;
+    description: string;
+    id: string;
+    created_at_millis: number;
+    expires_at_millis: number | undefined;
+    manually_revoked_at_millis: number | undefined;
+    is_public: boolean;
+} & {
+    value: string;
+}, yup.AnyObject, {
+    id: undefined;
+    description: undefined;
+    expires_at_millis: undefined;
+    manually_revoked_at_millis: undefined;
+    created_at_millis: undefined;
+    is_public: undefined;
+    value: undefined;
+    type: undefined;
+    user_id: undefined;
+}, "">;
+export type UserApiKeysCrud = CrudTypeOf<typeof userApiKeysCrud>;
+export declare const teamApiKeysCrud: import("../../crud").CrudSchemaFromOptions<{
+    clientReadSchema: yup.ObjectSchema<{
+        id: string;
+        description: string;
+        expires_at_millis: number | undefined;
+        manually_revoked_at_millis: number | undefined;
+        created_at_millis: number;
+        is_public: boolean;
+        value: {
+            last_four: string;
+        };
+        type: "team";
+        team_id: string;
+    }, yup.AnyObject, {
+        id: undefined;
+        description: undefined;
+        expires_at_millis: undefined;
+        manually_revoked_at_millis: undefined;
+        created_at_millis: undefined;
+        is_public: undefined;
+        value: {
+            last_four: undefined;
+        };
+        type: undefined;
+        team_id: undefined;
+    }, "">;
+    clientUpdateSchema: yup.ObjectSchema<{
+        description: string | undefined;
+        revoked: boolean | undefined;
+    }, yup.AnyObject, {
+        description: undefined;
+        revoked: undefined;
+    }, "">;
+    docs: {
+        clientCreate: {
+            description: string;
+            displayName: string;
+            summary: string;
+        };
+        clientList: {
+            description: string;
+            displayName: string;
+            summary: string;
+        };
+        clientRead: {
+            description: string;
+            displayName: string;
+            summary: string;
+        };
+        clientUpdate: {
+            description: string;
+            displayName: string;
+            summary: string;
+        };
+        serverDelete: {
+            description: string;
+            displayName: string;
+            summary: string;
+        };
+    };
+}>, teamApiKeysCreateInputSchema: yup.ObjectSchema<{
+    description: string;
+    expires_at_millis: number | null;
+    is_public: boolean | undefined;
+    team_id: string;
+}, yup.AnyObject, {
+    description: undefined;
+    expires_at_millis: undefined;
+    is_public: undefined;
+    team_id: undefined;
+}, "">, teamApiKeysCreateOutputSchema: yup.ObjectSchema<{
+    type: "team";
+    team_id: string;
+    description: string;
+    id: string;
+    created_at_millis: number;
+    expires_at_millis: number | undefined;
+    manually_revoked_at_millis: number | undefined;
+    is_public: boolean;
+} & {
+    value: string;
+}, yup.AnyObject, {
+    id: undefined;
+    description: undefined;
+    expires_at_millis: undefined;
+    manually_revoked_at_millis: undefined;
+    created_at_millis: undefined;
+    is_public: undefined;
+    value: undefined;
+    type: undefined;
+    team_id: undefined;
+}, "">;
+export type TeamApiKeysCrud = CrudTypeOf<typeof teamApiKeysCrud>;

package/dist/interface/crud/project-api-keys.js

@@ -0,0 +1,76 @@
+import { createCrud } from "../../crud";
+import { userIdOrMeSchema, yupBoolean, yupNumber, yupObject, yupString } from "../../schema-fields";
+import { typedFromEntries } from "../../utils/objects";
+function createApiKeyCrud(type, idFieldName, idSchema) {
+    const projectApiKeysReadSchema = yupObject({
+        id: yupString().defined(),
+        description: yupString().defined(),
+        expires_at_millis: yupNumber().optional(),
+        manually_revoked_at_millis: yupNumber().optional(),
+        created_at_millis: yupNumber().defined(),
+        is_public: yupBoolean().defined(),
+        value: yupObject({
+            last_four: yupString().defined(),
+        }).defined(),
+        type: yupString().oneOf([type]).defined(),
+        ...typedFromEntries([[idFieldName, idSchema]]),
+    });
+    const projectApiKeysUpdateSchema = yupObject({
+        description: yupString().optional(),
+        revoked: yupBoolean().oneOf([true]).optional(),
+    }).defined();
+    const projectApiKeysCrud = createCrud({
+        clientReadSchema: projectApiKeysReadSchema,
+        clientUpdateSchema: projectApiKeysUpdateSchema,
+        docs: {
+            clientCreate: {
+                description: "Create a new API key",
+                displayName: "Create API Key",
+                summary: "Create API key",
+            },
+            clientList: {
+                description: "List all API keys for the project",
+                displayName: "List API Keys",
+                summary: "List API keys",
+            },
+            clientRead: {
+                description: "Get details of a specific API key",
+                displayName: "Get API Key",
+                summary: "Get API key details",
+            },
+            clientUpdate: {
+                description: "Update an API key",
+                displayName: "Update API Key",
+                summary: "Update API key",
+            },
+            serverDelete: {
+                description: "Delete an API key",
+                displayName: "Delete API Key",
+                summary: "Delete API key",
+            },
+        },
+    });
+    // Used for the result of the create endpoint
+    const projectApiKeysCreateInputSchema = yupObject({
+        description: yupString().defined(),
+        expires_at_millis: yupNumber().nullable().defined(),
+        is_public: yupBoolean().optional(),
+        /*
+        prefix: yupString().optional().nonEmpty().test("prefix", "Prefix must contain only alphanumeric characters and underscores", (value) => {
+          if (!value) return true;
+          return /^[a-zA-Z0-9_]+$/.test(value);
+        }),
+        */
+        ...typedFromEntries([[idFieldName, idSchema]]),
+    });
+    const projectApiKeysCreateOutputSchema = projectApiKeysReadSchema.omit(["value"]).concat(yupObject({
+        value: yupString().defined(),
+    }));
+    return {
+        crud: projectApiKeysCrud,
+        createInputSchema: projectApiKeysCreateInputSchema,
+        createOutputSchema: projectApiKeysCreateOutputSchema,
+    };
+}
+export const { crud: userApiKeysCrud, createInputSchema: userApiKeysCreateInputSchema, createOutputSchema: userApiKeysCreateOutputSchema, } = createApiKeyCrud("user", "user_id", userIdOrMeSchema.defined());
+export const { crud: teamApiKeysCrud, createInputSchema: teamApiKeysCreateInputSchema, createOutputSchema: teamApiKeysCreateOutputSchema, } = createApiKeyCrud("team", "team_id", yupString().defined());