@opensecret/react 1.3.8 → 1.4.1

package/dist/index.d.ts

@@ -47,6 +47,9 @@ declare namespace api {
         requestAccountDeletion,
         confirmAccountDeletion,
         fetchModels,
+        createApiKey,
+        listApiKeys,
+        deleteApiKey,
         uploadDocument,
         checkDocumentStatus,
         uploadDocumentWithPolling,
@@ -71,6 +74,9 @@ declare namespace api {
         DocumentUploadRequest,
         DocumentResponse,
         DocumentUploadInitResponse,
+        ApiKey,
+        ApiKeyCreateResponse,
+        ApiKeyListResponse,
         DocumentStatusRequest,
         DocumentStatusResponse
     }
@@ -124,6 +130,17 @@ export declare interface ApiEndpoint {
     context: ApiContext;
 }
 
+export declare type ApiKey = {
+    name: string;
+    created_at: string;
+};
+
+export declare type ApiKeyCreateResponse = ApiKey & {
+    key: string;
+};
+
+export declare type ApiKeyListResponse = ApiKey[];
+
 /**
  * Response from initiating Apple OAuth authentication
  * @property auth_url - The Apple authorization URL to redirect the user to
@@ -280,12 +297,40 @@ declare function confirmPlatformPasswordReset(email: string, alphanumericCode: s
 
 declare function convertGuestToEmailAccount(email: string, password: string, name?: string | null): Promise<void>;
 
+/**
+ * Creates a new API key for the authenticated user
+ * @param name - A descriptive name for the API key
+ * @returns A promise resolving to the API key details with the key value (only shown once)
+ * @throws {Error} If:
+ * - The user is not authenticated
+ * - The name is invalid
+ * - The request fails
+ *
+ * @description
+ * IMPORTANT: The `key` field is only returned once during creation and cannot be retrieved again.
+ * The SDK consumer should prompt users to save the key immediately.
+ *
+ * Example usage:
+ * ```typescript
+ * const apiKey = await createApiKey("Production Key");
+ * console.log(apiKey.key); // UUID format: 550e8400-e29b-41d4-a716-446655440000
+ * // Save this key securely - it won't be shown again!
+ * ```
+ */
+export declare function createApiKey(name: string): Promise<ApiKeyCreateResponse>;
+
+export declare function createCustomFetch(options?: CustomFetchOptions): (url: RequestInfo, init?: RequestInit) => Promise<Response>;
+
 declare function createOrganization(name: string): Promise<Organization>;
 
 declare function createProject(orgId: string, name: string, description?: string): Promise<Project>;
 
 declare function createProjectSecret(orgId: string, projectId: string, keyName: string, secret: string): Promise<ProjectSecret>;
 
+export declare interface CustomFetchOptions {
+    apiKey?: string;
+}
+
 /**
  * Decrypts data that was previously encrypted with the user's key
  * @param encryptedData - Base64-encoded encrypted data string
@@ -330,6 +375,29 @@ declare type DecryptDataRequest = {
     };
 };
 
+/**
+ * Deletes an API key by its name
+ * @param name - The name of the API key to delete
+ * @returns A promise resolving to void
+ * @throws {Error} If:
+ * - The user is not authenticated
+ * - The API key with this name is not found
+ * - The user doesn't own the API key
+ * - The request fails
+ *
+ * @description
+ * Permanently deletes an API key. This action cannot be undone.
+ * Any requests using the deleted key will immediately fail with 401 Unauthorized.
+ * Names are unique per user, so this uniquely identifies the key to delete.
+ *
+ * Example usage:
+ * ```typescript
+ * await deleteApiKey("Production Key");
+ * console.log("API key deleted successfully");
+ * ```
+ */
+export declare function deleteApiKey(name: string): Promise<void>;
+
 declare function deleteOrganization(orgId: string): Promise<void>;
 
 declare function deleteOrganizationInvite(orgId: string, inviteCode: string): Promise<{
@@ -447,13 +515,14 @@ declare function fetchLogout(refresh_token: string): Promise<void>;
 
 /**
  * Fetches available AI models from the OpenAI-compatible API
+ * @param apiKey - Optional API key to use instead of JWT token
  * @returns A promise resolving to an array of Model objects
  * @throws {Error} If:
- * - The user is not authenticated
+ * - The user is not authenticated (no JWT token or API key)
  * - The request fails
  * - The response format is invalid
  */
-declare function fetchModels(): Promise<Model[]>;
+declare function fetchModels(apiKey?: string): Promise<Model[]>;
 
 /**
  * Fetches the private key as a mnemonic phrase with optional derivation paths
@@ -676,6 +745,30 @@ export declare type KVListItem = {
     updated_at: number;
 };
 
+/**
+ * Lists all API keys for the authenticated user
+ * @returns A promise resolving to an object containing an array of API key metadata (without the actual keys)
+ * @throws {Error} If:
+ * - The user is not authenticated
+ * - The request fails
+ *
+ * @description
+ * Returns metadata about all API keys associated with the user's account.
+ * Note that the actual key values are never returned - they are only shown once during creation.
+ * The keys are sorted by created_at in descending order (newest first).
+ *
+ * Example usage:
+ * ```typescript
+ * const response = await listApiKeys();
+ * response.keys.forEach(key => {
+ *   console.log(`${key.name} created at ${key.created_at}`);
+ * });
+ * ```
+ */
+export declare function listApiKeys(): Promise<{
+    keys: ApiKeyListResponse;
+}>;
+
 declare function listOrganizationInvites(orgId: string): Promise<OrganizationInvite[]>;
 
 declare function listOrganizationMembers(orgId: string): Promise<OrganizationMember[]>;
@@ -733,6 +826,16 @@ export declare type OpenSecretContextType = {
      * A UUID that identifies which project/tenant this instance belongs to.
      */
     clientId: string;
+    /**
+     * Optional API key for OpenAI endpoints.
+     * When set, this will be used instead of JWT for /v1/* endpoints.
+     */
+    apiKey?: string;
+    /**
+     * Sets the API key to use for OpenAI endpoints.
+     * @param key - The API key (UUID format) or undefined to clear
+     */
+    setApiKey: (key: string | undefined) => void;
     /**
      * Authenticates a user with email and password.
      *
@@ -1252,6 +1355,37 @@ export declare type OpenSecretContextType = {
         maxAttempts?: number;
         onProgress?: (status: string, progress?: number) => void;
     }) => Promise<DocumentResponse>;
+    /**
+     * Creates a new API key for the authenticated user
+     * @param name - A descriptive name for the API key
+     * @returns A promise resolving to the API key details with the key value (only shown once)
+     * @throws {Error} If the user is not authenticated or the request fails
+     *
+     * IMPORTANT: The `key` field is only returned once during creation and cannot be retrieved again.
+     * The SDK consumer should prompt users to save the key immediately.
+     */
+    createApiKey: typeof api.createApiKey;
+    /**
+     * Lists all API keys for the authenticated user
+     * @returns A promise resolving to an object containing an array of API key metadata (without the actual keys)
+     * @throws {Error} If the user is not authenticated or the request fails
+     *
+     * Returns metadata about all API keys associated with the user's account.
+     * Note that the actual key values are never returned - they are only shown once during creation.
+     * The keys are sorted by created_at in descending order (newest first).
+     */
+    listApiKeys: typeof api.listApiKeys;
+    /**
+     * Deletes an API key by its name
+     * @param name - The name of the API key to delete
+     * @returns A promise that resolves when the key is deleted
+     * @throws {Error} If the user is not authenticated or the API key is not found
+     *
+     * Permanently deletes an API key. This action cannot be undone.
+     * Any requests using the deleted key will immediately fail with 401 Unauthorized.
+     * Names are unique per user, so this uniquely identifies the key to delete.
+     */
+    deleteApiKey: typeof api.deleteApiKey;
 };
 
 /**