@api-client/core 0.8.21 → 0.9.0

package/src/runtime/store/HistorySdk.ts

@@ -1,7 +1,8 @@
-import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, E_RESPONSE_LOCATION, 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 { IListResponse, HistoryListOptions, IHistoryRequestListOptions } from '../../models/store/Backend.js';
 import { IHttpHistory, IHttpHistoryBulkAdd, Kind as HttpHistoryKind } from '../../models/HttpHistory.js';
+import { ContextChangeRecord, ContextDeleteRecord, ContextListResult, HistoryListOptions, IBulkOperationResult, IHistoryRequestListOptions } from '../../events/BaseEvents.js';
+import { SdkError } from './Errors.js';
 
 export class HistorySdk extends SdkBase {
   /**
@@ -17,7 +18,7 @@ export class HistorySdk extends SdkBase {
    * @param request Optional request options.
    * @returns The key of the created history.
    */
-  async create(history: IHttpHistory, request: ISdkRequestOptions = {}): Promise<string> {
+  async add(history: IHttpHistory, request: ISdkRequestOptions = {}): Promise<ContextChangeRecord<IHttpHistory>> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.history());
     const body = JSON.stringify(history);
@@ -26,14 +27,26 @@ export class HistorySdk extends SdkBase {
     const E_PREFIX = 'Unable to create a history. ';
     if (result.status !== 200) {
       this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
+      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;
     }
-    const location = result.headers.get('location');
-    if (!location) {
-      throw new Error(`${E_PREFIX}${E_RESPONSE_LOCATION}`);
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
+    }
+    let data: ContextChangeRecord<IHttpHistory>;
+    try {
+      data = JSON.parse(result.body);
+    } catch (e) {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
     }
-    const id = location.split('/').pop();
-    return id as string;
+    if (!data.key) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
+    }
+    return data;
   }
 
   /**
@@ -42,7 +55,7 @@ export class HistorySdk extends SdkBase {
    * @param info The bulk create info object.
    * @param request Optional request options.
    */
-  async createBulk(info: IHttpHistoryBulkAdd, request: ISdkRequestOptions = {}): Promise<string[]> {
+  async createBulk(info: IHttpHistoryBulkAdd, request: ISdkRequestOptions = {}): Promise<IBulkOperationResult<ContextChangeRecord<IHttpHistory>>> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.historyBatchCreate());
     const body = JSON.stringify(info);
@@ -51,17 +64,25 @@ export class HistorySdk extends SdkBase {
     const E_PREFIX = 'Unable to create a bulk history. ';
     if (result.status !== 200) {
       this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
+      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: string[];
+    let data: IBulkOperationResult<ContextChangeRecord<IHttpHistory>>;
     try {
       data = JSON.parse(result.body).items;
     } catch (e) {
       throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
     }
+    if (!data.items) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
+    }
     return data;
   }
 
@@ -71,7 +92,7 @@ export class HistorySdk extends SdkBase {
    * @param options Optional query options.
    * @param request Optional request options.
    */
-  async list(options: HistoryListOptions, request: ISdkRequestOptions = {}): Promise<IListResponse<IHttpHistory>> {
+  async list(options: HistoryListOptions, request: ISdkRequestOptions = {}): Promise<ContextListResult<IHttpHistory>> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.history());
     this.appendHistoryListParameters(url, options);
@@ -80,12 +101,17 @@ export class HistorySdk extends SdkBase {
     const E_PREFIX = 'Unable to list history. ';
     if (result.status !== 200) {
       this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
+      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: IListResponse<IHttpHistory>;
+    let data: ContextListResult<IHttpHistory>;
     try {
       data = JSON.parse(result.body);
     } catch (e) {
@@ -100,6 +126,7 @@ export class HistorySdk extends SdkBase {
   appendHistoryListParameters(url: URL, options: HistoryListOptions): void {
     this.sdk.appendListOptions(url, options);
     const { searchParams } = url;
+    searchParams.set('space', options.space);
     if (options.type) {
       searchParams.set('type', options.type);
     }
@@ -121,32 +148,61 @@ export class HistorySdk extends SdkBase {
    * @param key The key returned by the store when created the history. Also available via the `key` property on the history object.
    * @param request Optional request options.
    */
-  delete(key: string, request?: ISdkRequestOptions): Promise<void>;
-  /**
-   * Deletes a list of history objects in a batch operation.
-   * 
-   * @param keys The keys returned by the store when created the history. Also available via the `key` property on the history object.
-   * @param request Optional request options.
-   */
-  delete(keys: string[], request?: ISdkRequestOptions): Promise<void>;
+  async delete(key: string, request: ISdkRequestOptions = {}): Promise<void> {
+    const token = request.token || this.sdk.token;
+    const path =  RouteBuilder.historyItem(key);
+    const url = this.sdk.getUrl(path);
+
+    const result = await this.sdk.http.post(url.toString(), { token });
+    this.inspectCommonStatusCodes(result.status);
+    const E_PREFIX = 'Unable to delete history. ';
+    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;
+    }
+  }
+
   /**
-   * Deletes a history or a list of history objects from the store.
-   * @param key A key or a list of keys.
+   * Deletes history in a bulk operation.
+   * @param keys The list of keys of history objects to delete.
    * @param request Optional request options.
+   * @returns The list of delete records.
    */
-  async delete(key: string | string[], request: ISdkRequestOptions = {}): Promise<void> {
+  async deleteBulk(keys: string[], request: ISdkRequestOptions = {}): Promise<IBulkOperationResult<ContextDeleteRecord>> {
     const token = request.token || this.sdk.token;
-    const isArray = Array.isArray(key);
-    const path = isArray ? RouteBuilder.historyBatchDelete() : RouteBuilder.historyItem(key);
+    const path = RouteBuilder.historyBatchDelete();
     const url = this.sdk.getUrl(path);
-
-    const result = isArray ? await this.sdk.http.post(url.toString(), { token, body: JSON.stringify(key) }) : await this.sdk.http.delete(url.toString(), { token });
+    const result = await this.sdk.http.post(url.toString(), { token, body: JSON.stringify(keys) });
     this.inspectCommonStatusCodes(result.status);
     const E_PREFIX = 'Unable to delete history. ';
-    if (result.status !== 204) {
+    if (result.status !== 200) {
       this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
+      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<ContextDeleteRecord>;
+    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;
   }
 
   /**
@@ -163,7 +219,12 @@ export class HistorySdk extends SdkBase {
     const E_PREFIX = 'Unable to read a history. ';
     if (result.status !== 200) {
       this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
+      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}`);
@@ -179,4 +240,55 @@ export class HistorySdk extends SdkBase {
     }
     return data;
   }
+
+  async clearSpace(spaceKey: string, request: ISdkRequestOptions = {}): Promise<void> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.historyClear('space', spaceKey));
+    const result = await this.sdk.http.delete(url.toString(), { token });
+    this.inspectCommonStatusCodes(result.status, result.body);
+    const E_PREFIX = 'Unable to clear history for the space. ';
+    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;
+    }
+  }
+
+  async clearProject(projectKey: string, request: ISdkRequestOptions = {}): Promise<void> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.historyClear('project', projectKey));
+    const result = await this.sdk.http.delete(url.toString(), { token });
+    this.inspectCommonStatusCodes(result.status, result.body);
+    const E_PREFIX = 'Unable to clear history for the project. ';
+    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;
+    }
+  }
+
+  async clearRequest(projectKey: string, requestKey: string, request: ISdkRequestOptions = {}): Promise<void> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.historyClear('request', projectKey, requestKey));
+    const result = await this.sdk.http.delete(url.toString(), { token });
+    this.inspectCommonStatusCodes(result.status, result.body);
+    const E_PREFIX = 'Unable to clear history for the request. ';
+    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;
+    }
+  }
 }

package/src/runtime/store/RevisionsSdk.ts

@@ -0,0 +1,44 @@
+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 { ContextListResult, ContextSpaceListOptions } from '../../events/BaseEvents.js';
+import { SdkError } from './Errors.js';
+import { IRevision } from '../../models/store/Revision.js';
+
+export class RevisionsSdk extends SdkBase {
+  /**
+   * Lists revisions for a single file.
+   * 
+   * @param key The id of the file to lists revisions for.
+   * @param options The list query options
+   */
+  async list(key: string, options: ContextSpaceListOptions, request: ISdkRequestOptions = {}): Promise<ContextListResult<IRevision>> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.fileRevisions(key));
+    this.sdk.appendListOptions(url, options);
+    const result = await this.sdk.http.get(url.toString(), { token });
+    this.inspectCommonStatusCodes(result.status);
+    const E_PREFIX = 'Unable to list revisions for a file. ';
+    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: ContextListResult<IRevision>;
+    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;
+  }
+}

package/src/runtime/store/RouteBuilder.ts

@@ -2,6 +2,14 @@
  * A helper class to make sure routes user and reported by this service are consistent.
  */
 export class RouteBuilder {
+  static spaces(): string {
+    return '/spaces';
+  }
+
+  static space(key: string): string {
+    return `/spaces/${key}`;
+  }
+
   /**
    * @returns The path to the /files route.
    */
@@ -37,6 +45,13 @@ export class RouteBuilder {
     return `/file/${file}/revisions`;
   }
 
+  /**
+   * @returns The path to the /file/[id]/revisions route.
+   */
+  static fileBreadcrumbs(file: string): string {
+    return `/file/${file}/breadcrumbs`;
+  }
+
   /**
    * @returns The path to the /backend route.
    */
@@ -80,94 +95,47 @@ export class RouteBuilder {
     return `/history/${key}`;
   }
 
-  static shared(): string {
-    return '/shared';
-  }
-
-  static app(appId: string): string {
-    return `/app/${appId}`;
-  }
-
-  // GET
-  static appQuery(appId: string): string {
-    return `${this.app(appId)}/query`;
+  static historyClear(type: 'space' | 'project' | 'request', ...key: string[]): string {
+    return `/history/clear/${type}/${key.join('/')}`;
   }
 
-  // GET
-  static appQueryRequests(appId: string): string {
-    return `${this.app(appId)}/query/requests`;
-  }
-
-  // GET
-  static appQueryProjects(appId: string): string {
-    return `${this.app(appId)}/query/projects`;
-  }
-
-  // GET, POST
-  static appRequests(appId: string): string {
-    return `${this.app(appId)}/requests`;
-  }
-
-  // GET, DELETE
-  static appRequestItem(appId: string, key: string): string {
-    return `${this.appRequests(appId)}/${key}`;
-  }
-
-  static appRequestsBatch(appId: string): string {
-    return `${this.appRequests(appId)}/batch`;
-  }
-
-  // POST
-  static appRequestsBatchCreate(appId: string): string {
-    return `${this.appRequestsBatch(appId)}/create`;
-  }
-
-  // POST
-  static appRequestsBatchRead(appId: string): string {
-    return `${this.appRequestsBatch(appId)}/read`;
+  static shared(): string {
+    return '/shared';
   }
 
-  // POST
-  static appRequestsBatchDelete(appId: string): string {
-    return `${this.appRequestsBatch(appId)}/delete`;
+  static certificates(): string {
+    return '/certificates';
   }
 
-  // POST
-  static appRequestsBatchUndelete(appId: string): string {
-    return `${this.appRequestsBatch(appId)}/undelete`;
+  static certificate(key: string): string {
+    return `/certificates/${key}`;
   }
 
-  // POST, GET
-  static appProjects(appId: string): string {
-    return `${this.app(appId)}/projects`;
+  static certificatesEmpty(key: string): string {
+    return `/certificates/empty/${key}`;
   }
 
-  // GET, DELETE
-  static appProjectItem(appId: string, key: string): string {
-    return `${this.appProjects(appId)}/${key}`;
+  static certificateBatchCreate(): string {
+    return `/certificate/batch/create`;
   }
 
-  static appProjectsBatch(appId: string): string {
-    return `${this.appProjects(appId)}/batch`;
+  static certificateBatchDelete(): string {
+    return `/certificate/batch/delete`;
   }
 
-  // POST
-  static appProjectsBatchCreate(appId: string): string {
-    return `${this.appProjectsBatch(appId)}/create`;
+  static trash(): string {
+    return `/trash`
   }
 
-  // POST
-  static appProjectsBatchRead(appId: string): string {
-    return `${this.appProjectsBatch(appId)}/read`;
+  static trashItem(key: string): string {
+    return `/trash/${key}`
   }
 
-  // POST
-  static appProjectsBatchDelete(appId: string): string {
-    return `${this.appProjectsBatch(appId)}/delete`;
+  static trashEmpty(space: string): string {
+    return `/trash/empty/${space}`
   }
 
-  // POST
-  static appProjectsBatchUndelete(appId: string): string {
-    return `${this.appProjectsBatch(appId)}/undelete`;
+  static trashRestore(fileKey: string): string {
+    return `/trash/restore/${fileKey}`
   }
 }

package/src/runtime/store/Sdk.ts

@@ -1,4 +1,3 @@
-import { IListOptions } from '../../models/store/Backend.js';
 import { Http } from './Http.js';
 import { WsClient } from './WsClient.js';
 import { AuthSdk } from './AuthSdk.js';
@@ -7,7 +6,11 @@ import { FilesSdk } from './FilesSdk.js';
 import { UsersSdk } from './UsersSdk.js';
 import { HistorySdk } from './HistorySdk.js';
 import { SharedSdk } from './SharedSdk.js';
-import { AppSdk } from './AppSdk.js';
+import { ContextListOptions, ContextSpaceListOptions } from '../../events/BaseEvents.js';
+import { CertificatesSdk } from './CertificatesSdk.js';
+import { RevisionsSdk } from './RevisionsSdk.js';
+import { SpacesSdk } from './SpacesSdk.js';
+import { TrashSdk } from './TrashSdk.js';
 
 const baseUriSymbol = Symbol('baseUri');
 
@@ -52,10 +55,13 @@ export abstract class Sdk {
    */
   shared = new SharedSdk(this);
 
-  /**
-   * HTTP Client app specific SDK.
-   */
-  app = new AppSdk(this);
+  certificates = new CertificatesSdk(this);
+
+  revisions = new RevisionsSdk(this);
+
+  spaces = new SpacesSdk(this);
+
+  trash = new TrashSdk(this);
 
   /**
    * When set it limits log output to minimum.
@@ -121,7 +127,7 @@ export abstract class Sdk {
    * @param url The URL object to the API endpoint
    * @param options The list options, if any
    */
-  appendListOptions(url: URL, options: IListOptions = {}): void {
+  appendListOptions(url: URL, options: ContextListOptions = {}): void {
     const { searchParams } = url;
     if (options.cursor) {
       searchParams.set('cursor', options.cursor);
@@ -143,6 +149,10 @@ export abstract class Sdk {
       if (options.since) {
         searchParams.set('since', String(options.since));
       }
+      const typed = options as ContextSpaceListOptions;
+      if (typed.space) {
+        searchParams.set('space', typed.space);
+      }
     }
   }
 }

package/src/runtime/store/SdkBase.ts

@@ -102,7 +102,7 @@ export class SdkBase {
     if (!body) {
       return undefined;
     }
-    let data: any;
+    let data: IApiError;
     try {
       data = JSON.parse(body);
     } catch (e) {

package/src/runtime/store/SharedSdk.ts

@@ -1,9 +1,9 @@
 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 { IListOptions, IListResponse } from '../../models/store/Backend.js';
 import { IFile } from '../../models/store/File.js';
 import { SdkError } from './Errors.js';
 import { ListFileKind } from './FilesSdk.js';
+import { ContextListResult, ContextSpaceListOptions } from '../../events/BaseEvents.js';
 
 export class SharedSdk extends SdkBase {
   /**
@@ -13,7 +13,7 @@ export class SharedSdk extends SdkBase {
    * @param options Optional query options.
    * @param request Optional request options.
    */
-  async list(kinds?: ListFileKind[], options?: IListOptions, request: ISdkRequestOptions = {}): Promise<IListResponse<IFile>> {
+  async list(kinds?: ListFileKind[], options?: ContextSpaceListOptions, request: ISdkRequestOptions = {}): Promise<ContextListResult<IFile>> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.shared());
     this.sdk.appendListOptions(url, options);
@@ -35,7 +35,7 @@ export class SharedSdk extends SdkBase {
     if (!result.body) {
       throw new SdkError(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, 0);
     }
-    let data: IListResponse<IFile>;
+    let data: ContextListResult<IFile>;
     try {
       data = JSON.parse(result.body);
     } catch (e) {