@api-client/core 0.8.22 → 0.9.0

package/src/runtime/store/CertificatesSdk.ts

@@ -0,0 +1,231 @@
+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, ContextDeleteRecord, ContextListResult, ContextSpaceListOptions, IBulkOperationResult } from '../../events/BaseEvents.js';
+import { HttpCertificate } from '../../models/ClientCertificate.js';
+import { SdkError } from './Errors.js';
+
+export class CertificatesSdk extends SdkBase {
+  /**
+   * Inserts a certificate to the store
+   * 
+   * @param value The value to insert.
+   * @param space The parent space of the certificate.
+   */
+  async add(value: HttpCertificate, space: string, request: ISdkRequestOptions = {}): Promise<ContextChangeRecord<HttpCertificate>> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.certificates());
+    url.searchParams.set('space', space);
+    const body = JSON.stringify(value);
+    const result = await this.sdk.http.post(url.toString(), { token, body });
+    this.inspectCommonStatusCodes(result.status);
+    const E_PREFIX = 'Unable to create a certificate. ';
+    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: ContextChangeRecord<HttpCertificate>;
+    try {
+      data = JSON.parse(result.body);
+    } catch (e) {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
+    }
+    if (!data.key) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
+    }
+    return data;
+  }
+
+  /**
+   * Adds certificates in a bulk operation.
+   * @param value The lits of certificates to add.
+   * @param space The parent workspace
+   * @returns The list of inserted certificates. `undefined` when there was an error inserting a certificate.
+   */
+  async addBulk(values: HttpCertificate[], space: string, request: ISdkRequestOptions = {}): Promise<IBulkOperationResult<ContextChangeRecord<HttpCertificate>>> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.certificateBatchCreate());
+    url.searchParams.set('space', space);
+    const body = JSON.stringify(values);
+    const result = await this.sdk.http.post(url.toString(), { token, body });
+    this.inspectCommonStatusCodes(result.status);
+    const E_PREFIX = 'Unable to create a bulk certificates. ';
+    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<HttpCertificate>>;
+    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;
+  }
+
+  /**
+   * @param key The key of the certificate to read.
+   */
+  async read(key: string, request: ISdkRequestOptions = {}): Promise<HttpCertificate> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.certificate(key));
+    const result = await this.sdk.http.get(url.toString(), { token });
+    this.inspectCommonStatusCodes(result.status);
+    const E_PREFIX = 'Unable to read a certificate. ';
+    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: HttpCertificate;
+    try {
+      data = JSON.parse(result.body);
+    } catch (e) {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
+    }
+    if (!data.kind) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
+    }
+    return data;
+  }
+
+  /**
+   * Lists certificate entires.
+   * 
+   * @param space The parent space of the certificate.
+   * @param options The list query options.
+   */
+  async list(options?: ContextSpaceListOptions, request: ISdkRequestOptions = {}): Promise<ContextListResult<HttpCertificate>> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.certificates());
+    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 certificates. ';
+    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<HttpCertificate>;
+    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;
+  }
+
+  /**
+   * Marks the certificate as deleted.
+   * 
+   * @param key The key of the certificate to delete.
+   */
+  async delete(key: string, request: ISdkRequestOptions = {}): Promise<void> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.certificate(key));
+    const result = await this.sdk.http.delete(url.toString(), { token });
+    this.inspectCommonStatusCodes(result.status, result.body);
+    const E_PREFIX = 'Unable to delete the certificate. ';
+    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;
+    }
+  }
+
+  /**
+   * Removed certificates in a bulk operation.
+   * @param keys The list of certificate keys to delete.
+   */
+  async deleteBulk(keys: string[], request: ISdkRequestOptions = {}): Promise<IBulkOperationResult<ContextDeleteRecord>> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.certificateBatchDelete());
+    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 !== 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<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;
+  }
+
+  /**
+   * Removes all certificates from the store for the given workspace.
+   * @param space The parent workspace key
+   */
+  async empty(space: string, request: ISdkRequestOptions = {}): Promise<void> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.certificatesEmpty(space));
+    const result = await this.sdk.http.delete(url.toString(), { token });
+    this.inspectCommonStatusCodes(result.status, result.body);
+    const E_PREFIX = 'Unable to delete the certificate. ';
+    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/FilesSdk.ts

@@ -1,13 +1,13 @@
 import WebSocketNode from 'ws';
-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 { IListOptions, IListResponse, IPatchInfo, IPatchRevision, IAccessPatchInfo } from '../../models/store/Backend.js';
 import { IUser } from '../../models/store/User.js';
-import { IFile } from '../../models/store/File.js';
+import { FileBreadcrumb, IFile } from '../../models/store/File.js';
 import { Kind as ProjectKind } from '../../models/Project.js';
-import { Kind as WorkspaceKind } from '../../models/Workspace.js';
+import { Kind as FolderKind } from '../../models/Folder.js';
 import { Kind as DataNamespaceKind } from '../../models/data/DataNamespace.js';
 import { SdkError } from './Errors.js';
+import { ContextListResult, IPatchInfo, IPatchRevision, IAccessPatchInfo, ContextSpaceListOptions, ContextChangeRecord, IBulkOperationResult } from '../../events/BaseEvents.js';
 
 export interface IMetaCreateOptions {
   /**
@@ -29,7 +29,7 @@ export interface IFileCreateOptions extends IMetaCreateOptions, IMediaCreateOpti
 
 }
 
-export type ListFileKind = typeof ProjectKind | typeof WorkspaceKind | typeof DataNamespaceKind;
+export type ListFileKind = typeof ProjectKind | typeof FolderKind | typeof DataNamespaceKind;
 
 /**
  * In the store, the file is represented by the meta and the media.
@@ -45,7 +45,7 @@ export class FilesSdk 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.files());
     this.sdk.appendListOptions(url, options);
@@ -67,7 +67,7 @@ export class FilesSdk extends SdkBase {
     if (!result.body) {
       throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
     }
-    let data: IListResponse<IFile>;
+    let data: ContextListResult<IFile>;
     try {
       data = JSON.parse(result.body);
     } catch (e) {
@@ -88,10 +88,10 @@ export class FilesSdk extends SdkBase {
    * @param request Optional request details
    * @returns The id of the created file meta.
    */
-  async create(meta: IFile, contents: unknown, opts: IFileCreateOptions = {}, request: ISdkRequestOptions = {}): Promise<string> {
-    const id = await this.createMeta(meta, opts, request);
-    await this.createMedia(contents, id, opts, request);
-    return id;
+  async create(meta: IFile, contents: unknown, space: string, opts: IFileCreateOptions = {}, request: ISdkRequestOptions = {}): Promise<ContextChangeRecord<IFile>> {
+    const result = await this.createMeta(meta, space, opts, request);
+    await this.createMedia(contents, result.key, opts, request);
+    return result;
   }
 
   /**
@@ -102,10 +102,10 @@ export class FilesSdk extends SdkBase {
    * @param request Optional request options.
    * @returns The key of the creates file.
    */
-  async createMeta(file: IFile, opts: IMetaCreateOptions = {}, request: ISdkRequestOptions = {}): Promise<string> {
+  async createMeta(file: IFile, space: string, opts: IMetaCreateOptions = {}, request: ISdkRequestOptions = {}): Promise<ContextChangeRecord<IFile>> {
     const token = request.token || this.sdk.token;
-    const path = RouteBuilder.files();
-    const url = this.sdk.getUrl(path);
+    const url = this.sdk.getUrl(RouteBuilder.files());
+    url.searchParams.set('space', space);
     if (opts.parent) {
       url.searchParams.set('parent', opts.parent);
     }
@@ -119,7 +119,7 @@ export class FilesSdk extends SdkBase {
     });
     this.inspectCommonStatusCodes(result.status, result.body);
     const E_PREFIX = 'Unable to create a file. ';
-    if (result.status !== 204) {
+    if (result.status !== 200) {
       this.logInvalidResponse(result);
       let e = this.createGenericSdkError(result.body)
       if (!e) {
@@ -128,12 +128,20 @@ export class FilesSdk extends SdkBase {
       }
       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<IFile>;
+    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;
   }
 
   /**
@@ -184,6 +192,7 @@ export class FilesSdk extends SdkBase {
    * @returns THe file metadata
    */
   read(key: string, media: false, request?: ISdkRequestOptions): Promise<IFile>;
+
   /**
    * Reads file contents from the store.
    * 
@@ -226,8 +235,10 @@ export class FilesSdk extends SdkBase {
     } catch (e) {
       throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
     }
-    if (!data.kind) {
-      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
+    if (!media) {
+      if (!data.kind) {
+        throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
+      }
     }
     return data;
   }
@@ -239,7 +250,7 @@ export class FilesSdk extends SdkBase {
    * in that place. It also inserts `undefined` in place of a file that doesn't exist.
    * @param request Optional request options.
    */
-  async readBulk(keys: string[], request: ISdkRequestOptions = {}): Promise<IListResponse<IFile|undefined>> {
+  async readBulk(keys: string[], request: ISdkRequestOptions = {}): Promise<IBulkOperationResult<IFile>> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.filesBatch());
     const body = JSON.stringify(keys);
@@ -258,7 +269,7 @@ export class FilesSdk extends SdkBase {
     if (!result.body) {
       throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
     }
-    let data: IListResponse<IFile | undefined>;
+    let data: IBulkOperationResult<IFile>;
     try {
       data = JSON.parse(result.body);
     } catch (e) {
@@ -384,7 +395,7 @@ export class FilesSdk extends SdkBase {
    * @param key The file key
    * @param request Optional request options.
    */
-  async listUsers(key: string, request: ISdkRequestOptions = {}): Promise<IListResponse<IUser>> {
+  async listUsers(key: string, request: ISdkRequestOptions = {}): Promise<ContextListResult<IUser>> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.fileUsers(key));
     const result = await this.sdk.http.get(url.toString(), { token });
@@ -402,7 +413,7 @@ export class FilesSdk extends SdkBase {
     if (!result.body) {
       throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
     }
-    let data: IListResponse<IUser>;
+    let data: ContextListResult<IUser>;
     try {
       data = JSON.parse(result.body);
     } catch (e) {
@@ -439,4 +450,38 @@ export class FilesSdk extends SdkBase {
     }
     return this.sdk.ws.createAndConnect(url.toString(), token);
   }
+
+  /**
+   * Lists breadcrumbs to the file.
+   * @param key The lowest file in the hierarchy
+   */
+  async breadcrumbs(key: string, request: ISdkRequestOptions = {}): Promise<ContextListResult<FileBreadcrumb>> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.fileBreadcrumbs(key));
+    const result = await this.sdk.http.get(url.toString(), { token });
+    this.inspectCommonStatusCodes(result.status, result.body);
+    const E_PREFIX = 'Unable to read 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<FileBreadcrumb>;
+    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;
+  }
 }