@api-client/core 0.9.10 → 0.9.12

package/src/runtime/store/TrashSdk.ts

@@ -1,6 +1,19 @@
-import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, ISdkRequestOptions } from './SdkBase.js';
+import { 
+  SdkBase, 
+  E_RESPONSE_STATUS, 
+  E_RESPONSE_NO_VALUE, 
+  E_INVALID_JSON, 
+  E_RESPONSE_UNKNOWN, 
+  ISdkRequestOptions 
+} from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
-import { ContextChangeRecord, ContextListResult, ContextSpaceListOptions } from '../../events/BaseEvents.js';
+import { 
+  ContextChangeRecord, 
+  ContextDeleteRecord, 
+  ContextListResult, 
+  ContextSpaceListOptions, 
+  IBulkOperationResult 
+} from '../../events/BaseEvents.js';
 import { SdkError } from './Errors.js';
 import { IFile } from '../../models/store/File.js';
 import { TrashEntry, TrashEntryCreate } from '../../models/TrashEntry.js';
@@ -80,24 +93,26 @@ export class TrashSdk extends SdkBase {
   }
 
   /**
-   * Removes a trash entry permanently from the store.
+   * Permanently deletes a file.
+   * 
    * @param key The key of the deleted object
    */
   async delete(key: string, request: ISdkRequestOptions = {}): Promise<void> {
-    const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.trashItem(key));
-    const result = await this.sdk.http.delete(url.toString(), { token });
-    this.inspectCommonStatusCodes(result);
-    const E_PREFIX = 'Unable to delete the trash entry. ';
-    if (result.status !== 204) {
-      this.logInvalidResponse(result);
-      let e = this.createGenericSdkError(result.body)
-      if (!e) {
-        e = new SdkError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.status);
-        e.response = result.body;
-      }
-      throw e;
-    }
+    return this.genericDelete(url, key, request);
+  }
+
+  /**
+   * Permanently deletes a number of files in a batch operation.
+   * 
+   * @param keys The list of trash entry keys to delete.
+   * @param request Optional request options.
+   * @returns The list of delete records.
+   */
+  async batchDelete(keys: string[], request: ISdkRequestOptions = {}): Promise<IBulkOperationResult<ContextDeleteRecord>> {
+    const path = RouteBuilder.trashBatchDelete();
+    const url = this.sdk.getUrl(path);
+    return this.genericBatchDelete(url, keys, request);
   }
 
   /**
@@ -107,12 +122,12 @@ export class TrashSdk extends SdkBase {
    * @param key The key of the file to restore
    */
   async restore(key: string, request: ISdkRequestOptions = {}): Promise<ContextChangeRecord<IFile>> {
-    const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.trashRestore(key));
+    const token = request.token || this.sdk.token;
     const result = await this.sdk.http.put(url.toString(), { token });
     this.inspectCommonStatusCodes(result);
     const E_PREFIX = 'Unable to restore from trash. ';
-    if (result.status !== 204) {
+    if (result.status !== 200) {
       this.logInvalidResponse(result);
       let e = this.createGenericSdkError(result.body)
       if (!e) {
@@ -136,6 +151,36 @@ export class TrashSdk extends SdkBase {
     return data;
   }
 
+  async batchRestore(keys: string[], request: ISdkRequestOptions = {}): Promise<IBulkOperationResult<ContextChangeRecord<IFile>>> {
+    const url = this.sdk.getUrl(RouteBuilder.trashBatchRestore());
+    const token = request.token || this.sdk.token;
+    const result = await this.sdk.http.post(url.toString(), { token, body: JSON.stringify(keys) });
+    this.inspectCommonStatusCodes(result);
+    const E_PREFIX = 'Unable to restore from trash. ';
+    if (result.status !== 200) {
+      this.logInvalidResponse(result);
+      let e = this.createGenericSdkError(result.body)
+      if (!e) {
+        e = new SdkError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.status);
+        e.response = result.body;
+      }
+      throw e;
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
+    }
+    let data: IBulkOperationResult<ContextChangeRecord<IFile>>;
+    try {
+      data = JSON.parse(result.body);
+    } catch (e) {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
+    }
+    if (!Array.isArray(data.items)) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
+    }
+    return data;
+  }
+
   /**
    * Empties the trash for the given space.
    * @param space The space key to remove trash for.

package/src/runtime/store/interfaces/Trash.ts

@@ -1,5 +1,5 @@
 import { IFile } from "../../../models/store/File.js";
-import { ContextChangeRecord, ContextListResult, ContextSpaceListOptions } from "../../../events/BaseEvents.js";
+import { ContextChangeRecord, ContextDeleteRecord, ContextListResult, ContextSpaceListOptions, IBulkOperationResult } from "../../../events/BaseEvents.js";
 import { TrashEntry, TrashEntryCreate } from "../../../models/TrashEntry.js";
 
 /**
@@ -22,18 +22,33 @@ export interface Trash {
   list(options: ContextSpaceListOptions): Promise<ContextListResult<TrashEntry>>;
 
   /**
-   * Removes a trash entry permanently from the store.
+   * Permanently deletes a file.
+   * 
    * @param key The key of the deleted object
    */
-  delete(key: string): Promise<void>;
+  delete(key: string): Promise<ContextDeleteRecord>;
+
+  /**
+   * Permanently deletes a number of files in a batch operation.
+   * 
+   * @param keys The list of trash entry keys to delete.
+   */
+  batchDelete(keys: string[]): Promise<IBulkOperationResult<ContextDeleteRecord>>;
+  
   /**
-   * Restores a file from the trash.
-   * It deletes a trash entry and updates the `file` object.
+   * Restores trash entries permanently from the store.
    * 
    * @param key The key of the file to restore
    */
   restore(key: string): Promise<ContextChangeRecord<IFile>>;
 
+  /**
+   * Restores multiple files in a batch operation.
+   * 
+   * @param keys The lit of trash keys to restore.
+   */
+  batchRestore(keys: string[]): Promise<IBulkOperationResult<ContextChangeRecord<IFile>>>;
+
   /**
    * Empties the trash for the given space.
    * @param space The space key to remove trash for.