@opensecret/react 1.5.1 → 1.5.3

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2024 OpenSecret
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/index.d.ts

@@ -43,6 +43,7 @@ declare namespace api {
         fetchUser,
         fetchPut,
         fetchDelete,
+        fetchDeleteAllKV,
         fetchGet,
         fetchList,
         fetchLogout,
@@ -86,6 +87,7 @@ declare namespace api {
         updateConversation,
         deleteConversation,
         deleteConversations,
+        batchDeleteConversations,
         addConversationItems,
         listConversationItems,
         listConversations,
@@ -137,6 +139,9 @@ declare namespace api {
         ConversationsListResponse,
         ConversationDeleteResponse,
         ConversationsDeleteResponse,
+        BatchDeleteConversationsRequest,
+        BatchDeleteItemResult,
+        BatchDeleteConversationsResponse,
         ResponsesCancelResponse,
         ResponsesDeleteResponse,
         ResponsesCreateRequest,
@@ -279,6 +284,51 @@ declare function authenticate(attestationDocumentBase64: string, trustedRootCert
 
 declare const AWS_ROOT_CERT_DER: Uint8Array;
 
+/**
+ * Batch deletes multiple conversations by their IDs
+ * @param ids - Array of conversation UUIDs to delete
+ * @returns A promise resolving to per-item deletion results
+ * @throws {Error} If:
+ * - The user is not authenticated
+ * - The request fails
+ *
+ * @description
+ * This function deletes multiple conversations in a single request.
+ * Returns per-item results so callers can handle partial failures.
+ *
+ * @example
+ * ```typescript
+ * const result = await batchDeleteConversations([
+ *   "550e8400-e29b-41d4-a716-446655440000",
+ *   "550e8400-e29b-41d4-a716-446655440001"
+ * ]);
+ * for (const item of result.data) {
+ *   if (item.deleted) {
+ *     console.log(`Conversation ${item.id} deleted`);
+ *   } else {
+ *     console.log(`Failed to delete ${item.id}: ${item.error}`);
+ *   }
+ * }
+ * ```
+ */
+declare function batchDeleteConversations(ids: string[]): Promise<BatchDeleteConversationsResponse>;
+
+export declare type BatchDeleteConversationsRequest = {
+    ids: string[];
+};
+
+export declare type BatchDeleteConversationsResponse = {
+    object: "list";
+    data: BatchDeleteItemResult[];
+};
+
+export declare type BatchDeleteItemResult = {
+    id: string;
+    object: "conversation.deleted";
+    deleted: boolean;
+    error?: "not_found" | "delete_failed";
+};
+
 /**
  * Cancels an in-progress response
  * @param responseId - The UUID of the response to cancel
@@ -821,6 +871,8 @@ declare function fetchAttestationDocument(nonce: string, explicitApiUrl?: string
 
 declare function fetchDelete(key: string): Promise<void>;
 
+declare function fetchDeleteAllKV(): Promise<void>;
+
 declare function fetchGet(key: string): Promise<string | undefined>;
 
 declare function fetchGuestLogin(id: string, password: string, client_id: string): Promise<LoginResponse>;
@@ -1521,6 +1573,12 @@ export declare type OpenSecretContextType = {
      * - Propagates any server-side errors directly
      */
     del: typeof api.fetchDelete;
+    /**
+     * Deletes all key-value pairs from the user's storage
+     * @returns A promise resolving when the deletion is complete
+     * @throws {Error} If the deletion fails
+     */
+    delAll: typeof api.fetchDeleteAllKV;
     verifyEmail: typeof api.verifyEmail;
     requestNewVerificationCode: typeof api.requestNewVerificationCode;
     requestNewVerificationEmail: typeof api.requestNewVerificationCode;
@@ -2045,6 +2103,12 @@ export declare type OpenSecretContextType = {
      * @returns A promise resolving to deletion confirmation
      */
     deleteConversations: typeof api.deleteConversations;
+    /**
+     * Batch deletes multiple conversations by their IDs
+     * @param ids - Array of conversation UUIDs to delete
+     * @returns A promise resolving to per-item deletion results
+     */
+    batchDeleteConversations: typeof api.batchDeleteConversations;
     /**
      * Creates a new instruction
      * @param request - The instruction creation parameters