@api-client/core 0.5.3 → 0.5.6

package/src/runtime/store/FilesSdk.ts

@@ -0,0 +1,302 @@
+import WebSocketNode from 'ws';
+import { Patch } from '@api-client/json';
+import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, E_RESPONSE_LOCATION, ISdkRequestOptions } from './SdkBase.js';
+import { RouteBuilder } from './RouteBuilder.js';
+import { IListOptions, IListResponse } from '../../models/Backend.js';
+import { AccessOperation } from '../../models/store/Permission.js';
+import { IUser } from '../../models/store/User.js';
+import { IFile } from '../../models/store/File.js';
+import { Kind as ProjectKind } from '../../models/Project.js';
+import { Kind as WorkspaceKind } from '../../models/Workspace.js';
+import { IHttpProject } from '../../models/HttpProject.js';
+import { SdkError } from './Errors.js';
+
+export interface IFileCreateOptions {
+  /**
+   * Optional parent file id.
+   * When set it creates a file under this parent.
+   */
+  parent?: string;
+}
+
+export class FilesSdk extends SdkBase {
+  /**
+   * Lists files (spaces, projects, etc) in the store.
+   * 
+   * @param kinds the list of kinds to list. Spaces are always included.
+   * @param options Optional query options.
+   * @param request Optional request options.
+   */
+  async list(kinds: (typeof ProjectKind | typeof WorkspaceKind)[], options?: IListOptions, request: ISdkRequestOptions = {}): Promise<IListResponse<IFile>> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.files());
+    this.sdk.appendListOptions(url, options);
+    kinds.forEach(k => url.searchParams.append('kind', k));
+    const result = await this.sdk.http.get(url.toString(), { token });
+    this.inspectCommonStatusCodes(result.status, result.body);
+    const E_PREFIX = 'Unable to list files. ';
+    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: IListResponse<IFile>;
+    try {
+      data = JSON.parse(result.body);
+    } catch (e) {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
+    }
+    if (!Array.isArray(data.data)) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
+    }
+    return data;
+  }
+
+  /**
+   * Creates a file in the store.
+   * 
+   * @param file The definition of a file that extends the IFile interface or one of the supported by the server schemas.
+   * @param request Optional request options.
+   * @returns The key of the creates file.
+   */
+  async create(file: IFile | IHttpProject, opts: IFileCreateOptions = {}, request: ISdkRequestOptions = {}): Promise<string> {
+    const token = request.token || this.sdk.token;
+    const path = opts.parent ? RouteBuilder.file(opts.parent) : RouteBuilder.files();
+    const url = this.sdk.getUrl(path);
+    const body = JSON.stringify(file);
+    const result = await this.sdk.http.post(url.toString(), { token, body });
+    this.inspectCommonStatusCodes(result.status, result.body);
+    const E_PREFIX = 'Unable to create a file. ';
+    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;
+    }
+    const location = result.headers.get('location');
+    if (!location) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_LOCATION}`);
+    }
+    const id = location.split('/').pop();
+    return id as string;
+  }
+
+  /**
+   * Reads file metadata from the store.
+   * 
+   * @param key The file key
+   * @param request Optional request options.
+   * @returns THe file metadata
+   */
+  read(key: string, media: false, request?: ISdkRequestOptions): Promise<IFile>;
+  /**
+   * Reads file contents from the store.
+   * 
+   * @param key The file key
+   * @param request Optional request options.
+   * @returns THe file contents
+   */
+  read(key: string, media: true, request?: ISdkRequestOptions): Promise<unknown>;
+
+  /**
+   * Reads a user file definition from the store.
+   * @param key The file key
+   * @param media When true it reads file contents rather than metadata.
+   * @param request Optional request options.
+   */
+  async read(key: string, media?: boolean, request: ISdkRequestOptions = {}): Promise<IFile | unknown> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.file(key));
+    if (media) {
+      url.searchParams.set('alt', 'media');
+    }
+    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: IFile;
+    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;
+  }
+
+  /**
+   * Patches file's meta in the store.
+   * 
+   * @param key The file key
+   * @param value The patch to apply.
+   * @param request Optional request options.
+   */
+  patch(key: string, value: Patch.JsonPatch, media: false, request?: ISdkRequestOptions): Promise<Patch.JsonPatch>;
+
+  /**
+   * Patches file's content in the store.
+   * 
+   * @param key The file key
+   * @param value The patch to apply.
+   * @param request Optional request options.
+   */
+  patch(key: string, value: Patch.JsonPatch, media: true, request?: ISdkRequestOptions): Promise<Patch.JsonPatch>;
+
+  /**
+   * Patches a file in the store.
+   * @param key The key of the file to patch
+   * @param value The JSON patch to be processed.
+   * @param request Optional request options.
+   * @returns The JSON patch to revert the change using the `@api-client/json` library
+   */
+  async patch(key: string, value: Patch.JsonPatch, media?: boolean, request: ISdkRequestOptions = {}): Promise<Patch.JsonPatch> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.file(key));
+    if (media) {
+      url.searchParams.set('alt', 'media');
+    }
+    const body = JSON.stringify(value);
+    const result = await this.sdk.http.patch(url.toString(), { token, body });
+    this.inspectCommonStatusCodes(result.status, result.body);
+    const E_PREFIX = 'Unable to patch 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: any;
+    try {
+      data = JSON.parse(result.body);
+    } catch (e) {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
+    }
+    if (!data.revert) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
+    }
+    return data.revert as Patch.JsonPatch;
+  }
+
+  /**
+   * Deletes the file in the store.
+   * 
+   * @param key The key of the file to delete.
+   * @param request Optional request options.
+   */
+  async delete(key: string, request: ISdkRequestOptions = {}): Promise<void> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.file(key));
+    const result = await this.sdk.http.delete(url.toString(), { token });
+    this.inspectCommonStatusCodes(result.status, result.body);
+    const E_PREFIX = 'Unable to delete a file. ';
+    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;
+    }
+  }
+
+  /**
+   * Updates the sharing options of the file.
+   * 
+   * @param key The file key
+   * @param value The patch operation on the file's ACL
+   * @param request Optional request options.
+   */
+  async patchUsers(key: string, value: AccessOperation[], request: ISdkRequestOptions = {}): Promise<void> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.fileUsers(key));
+    const body = JSON.stringify(value);
+    const result = await this.sdk.http.patch(url.toString(), { token, body });
+    this.inspectCommonStatusCodes(result.status, result.body);
+    const E_PREFIX = 'Unable to patch a file. ';
+    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;
+    }
+  }
+
+  /**
+   * Lists uses having access to the file.
+   * 
+   * @param key The file key
+   * @param request Optional request options.
+   */
+  async listUsers(key: string, request: ISdkRequestOptions = {}): Promise<IListResponse<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 });
+    this.inspectCommonStatusCodes(result.status, result.body);
+    const E_PREFIX = 'Unable to list users in the 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: IListResponse<IUser>;
+    try {
+      data = JSON.parse(result.body);
+    } catch (e) {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
+    }
+    if (!Array.isArray(data.data)) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
+    }
+    return data;
+  }
+
+  /**
+   * Creates a WS client that listens to the files events.
+   * @param request Optional request options.
+   */
+  async observeFiles(request: ISdkRequestOptions = {}): Promise<WebSocketNode | WebSocket> {
+    const token = request.token || this.sdk.token;
+    const url = this.sdk.getUrl(RouteBuilder.files());
+    return this.sdk.ws.createAndConnect(url.toString(), token);
+  }
+}

package/src/runtime/store/HistorySdk.ts

@@ -1,6 +1,6 @@
-import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, E_RESPONSE_LOCATION } from './SdkBase.js';
+import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, E_RESPONSE_LOCATION, ISdkRequestOptions } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
-import { IListResponse, HistoryListOptions } from '../../models/Backend.js';
+import { IListResponse, HistoryListOptions, IHistoryRequestListOptions } from '../../models/Backend.js';
 import { IHttpHistory, IHttpHistoryBulkAdd, Kind as HttpHistoryKind } from '../../models/HttpHistory.js';
 
 export class HistorySdk extends SdkBase {
@@ -14,10 +14,11 @@ export class HistorySdk extends SdkBase {
    * Note, history objects cannot be updated. They can only be created or deleted.
    * 
    * @param history The history to create
+   * @param request Optional request options.
    * @returns The key of the created history.
    */
-  async create(history: IHttpHistory): Promise<string> {
-    const { token } = this.sdk;
+  async create(history: IHttpHistory, request: ISdkRequestOptions = {}): Promise<string> {
+    const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.history());
     const body = JSON.stringify(history);
     const result = await this.sdk.http.post(url.toString(), { token, body });
@@ -39,9 +40,10 @@ export class HistorySdk extends SdkBase {
    * Creates a multiple history objects in a batch operation.
    * 
    * @param info The bulk create info object.
+   * @param request Optional request options.
    */
-  async createBulk(info: IHttpHistoryBulkAdd): Promise<string[]> {
-    const { token } = this.sdk;
+  async createBulk(info: IHttpHistoryBulkAdd, request: ISdkRequestOptions = {}): Promise<string[]> {
+    const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.historyBatchCreate());
     const body = JSON.stringify(info);
     const result = await this.sdk.http.post(url.toString(), { token, body });
@@ -56,7 +58,7 @@ export class HistorySdk extends SdkBase {
     }
     let data: string[];
     try {
-      data = JSON.parse(result.body);
+      data = JSON.parse(result.body).data;
     } catch (e) {
       throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
     }
@@ -67,11 +69,12 @@ export class HistorySdk extends SdkBase {
    * Lists the history.
    * 
    * @param options Optional query options.
+   * @param request Optional request options.
    */
-  async list(options: HistoryListOptions): Promise<IListResponse> {
-    const { token } = this.sdk;
+  async list(options: HistoryListOptions, request: ISdkRequestOptions = {}): Promise<IListResponse<IHttpHistory>> {
+    const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.history());
-    this.sdk.appendListOptions(url, options);
+    this.appendHistoryListParameters(url, options);
     const result = await this.sdk.http.get(url.toString(), { token });
     this.inspectCommonStatusCodes(result.status);
     const E_PREFIX = 'Unable to list history. ';
@@ -82,7 +85,7 @@ export class HistorySdk extends SdkBase {
     if (!result.body) {
       throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
     }
-    let data: IListResponse;
+    let data: IListResponse<IHttpHistory>;
     try {
       data = JSON.parse(result.body);
     } catch (e) {
@@ -94,24 +97,45 @@ export class HistorySdk extends SdkBase {
     return data;
   }
 
+  appendHistoryListParameters(url: URL, options: HistoryListOptions): void {
+    this.sdk.appendListOptions(url, options);
+    const { searchParams } = url;
+    if (options.type) {
+      searchParams.set('type', options.type);
+    }
+    const projectOptions = options as IHistoryRequestListOptions;
+    if (projectOptions.id) {
+      searchParams.set('id', projectOptions.id);
+    }
+    if (projectOptions.user) {
+      searchParams.set('user', 'true');
+    }
+    if (projectOptions.project) {
+      searchParams.set('project', projectOptions.project);
+    }
+  }
+
   /**
    * Deletes a history object form the store.
    * 
    * @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): Promise<void>;
+  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[]): Promise<void>;
+  delete(keys: string[], request?: ISdkRequestOptions): Promise<void>;
   /**
    * Deletes a history or a list of history objects from the store.
    * @param key A key or a list of keys.
+   * @param request Optional request options.
    */
-  async delete(key: string | string[]): Promise<void> {
-    const { token } = this.sdk;
+  async delete(key: string | string[], request: ISdkRequestOptions = {}): Promise<void> {
+    const token = request.token || this.sdk.token;
     const isArray = Array.isArray(key);
     const path = isArray ? RouteBuilder.historyBatchDelete() : RouteBuilder.historyItem(key);
     const url = this.sdk.getUrl(path);
@@ -128,10 +152,11 @@ export class HistorySdk extends SdkBase {
   /**
    * Reads a history definition from the store.
    * @param key The history key
+   * @param request Optional request options.
    * @returns The history object
    */
-  async read(key: string): Promise<IHttpHistory> {
-    const { token } = this.sdk;
+  async read(key: string, request: ISdkRequestOptions = {}): Promise<IHttpHistory> {
+    const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.historyItem(key));
     const result = await this.sdk.http.get(url.toString(), { token });
     this.inspectCommonStatusCodes(result.status);

package/src/runtime/store/RouteBuilder.ts

@@ -3,45 +3,31 @@
  */
 export class RouteBuilder {
   /**
-   * @returns The path to the /spaces route.
+   * @returns The path to the /files route.
    */
-  static spaces(): string {
-    return '/spaces';
+  static files(): string {
+    return '/files';
   }
 
   /**
-   * @returns The path to the /spaces/[id] route.
+   * @returns The path to the /files/[id] route.
    */
-  static space(key: string): string {
-    return `/spaces/${key}`;
+  static file(key: string): string {
+    return `/files/${key}`;
   }
 
   /**
-   * @returns The path to the /spaces/[id]/users route.
+   * @returns The path to the /files/[id]/users route.
    */
-  static spaceUsers(key: string): string {
-    return `/spaces/${key}/users`;
+  static fileUsers(key: string): string {
+    return `/files/${key}/users`;
   }
 
   /**
-   * @returns The path to the /spaces/[id]/projects route.
+   * @returns The path to the /file/[id]/revisions route.
    */
-  static spaceProjects(key: string): string {
-    return `/spaces/${key}/projects`;
-  }
-
-  /**
-   * @returns The path to the /spaces/[id]/projects/[id] route.
-   */
-  static spaceProject(space: string, project: string): string {
-    return `/spaces/${space}/projects/${project}`;
-  }
-
-  /**
-   * @returns The path to the /spaces/[id]/projects/[id]/revisions route.
-   */
-  static projectRevisions(space: string, project: string): string {
-    return `/spaces/${space}/projects/${project}/revisions`;
+  static fileRevisions(file: string): string {
+    return `/file/${file}/revisions`;
   }
 
   /**
@@ -87,7 +73,7 @@ export class RouteBuilder {
     return `/history/${key}`;
   }
 
-  static sharedSpaces(): string {
-    return '/shared/spaces';
+  static shared(): string {
+    return '/shared';
   }
 }

package/src/runtime/store/Sdk.ts

@@ -3,8 +3,7 @@ import { Http } from './Http.js';
 import { WsClient } from './WsClient.js';
 import { AuthSdk } from './AuthSdk.js';
 import { BackendSdk } from './BackendSdk.js';
-import { SpacesSdk } from './SpacesSdk.js';
-import { ProjectsSdk } from './ProjectsSdk.js';
+import { FilesSdk } from './FilesSdk.js';
 import { UsersSdk } from './UsersSdk.js';
 import { HistorySdk } from './HistorySdk.js';
 import { SharedSdk } from './SharedSdk.js';
@@ -30,11 +29,7 @@ export abstract class Sdk {
   /**
    * The user spaces features.
    */
-  space = new SpacesSdk(this);
-  /**
-   * The user projects features.
-   */
-  project = new ProjectsSdk(this);
+  file = new FilesSdk(this);
   /**
    * Reads user information.
    */
@@ -56,6 +51,11 @@ export abstract class Sdk {
    */
   shared = new SharedSdk(this);
 
+  /**
+   * When set it limits log output to minimum.
+   */
+  silent = false;
+
 
   [baseUriSymbol] = '';
 

package/src/runtime/store/SdkBase.ts

@@ -1,16 +1,20 @@
 import { Headers } from '../../lib/headers/Headers.js';
 import { Sdk } from './Sdk.js';
+import { SdkError, IApiError } from './Errors.js';
 
-export interface IStoreRequestOptions {
-  method?: 'GET' | 'POST' | 'PATCH' | 'DELETE';
-  headers?: Record<string, string>,
-  body?: string | Buffer;
+export interface ISdkRequestOptions {
   /**
-   * Adds the token to the headers.
+   * Uses the provided token for authentication.
    */
   token?: string;
 }
 
+export interface IStoreRequestOptions extends ISdkRequestOptions {
+  method?: 'GET' | 'POST' | 'PATCH' | 'DELETE';
+  headers?: Record<string, string>,
+  body?: string | Buffer;
+}
+
 export interface IStoreResponse {
   status: number;
   headers: Headers;
@@ -42,6 +46,9 @@ export class SdkBase {
   constructor(public sdk: Sdk) {}
 
   protected logInvalidResponse(response: IStoreResponse): void {
+    if (this.sdk.silent) {
+      return;
+    }
     if (response.body) {
       try {
         const data = JSON.parse(response.body);
@@ -58,15 +65,62 @@ export class SdkBase {
    * Throws unified message for a common error status codes.
    * It handles 404, 403, and 401 status codes.
    */
-  protected inspectCommonStatusCodes(status: number): void {
+  protected inspectCommonStatusCodes(status: number, body?: string): void {
     if (status === 404) {
-      throw new Error(`Not found.`);
+      let e = this.createGenericSdkError(body)
+      if (!e) {
+        e = new SdkError(`Not found.`, 400);
+        e.response = body;
+      }
+      throw e;
     }
     if (status === 403) {
-      throw new Error(`You have no access to this resource.`);
+      let e = this.createGenericSdkError(body)
+      if (!e) {
+        e = new SdkError(`You have no access to this resource.`, 403);
+        e.response = body;
+      }
+      throw e;
     }
     if (status === 401) {
-      throw new Error(`Not authorized.`);
+      let e = this.createGenericSdkError(body)
+      if (!e) {
+        e = new SdkError(`Not authorized.`, 401);
+        e.response = body;
+      }
+      throw e;
+    }
+  }
+
+  /**
+   * Reads the response as ApiError
+   * @param body The message returned by the store.
+   * @returns The error schema or undefined when not an error;
+   */
+  protected readErrorResponse(body?: string): IApiError | undefined {
+    if (!body) {
+      return undefined;
+    }
+    let data: any;
+    try {
+      data = JSON.parse(body);
+    } catch (e) {
+      return undefined;
+    }
+    if (data.error && data.message) {
+      return data as IApiError;
+    }
+    return undefined;
+  }
+
+  protected createGenericSdkError(body?: string): SdkError | undefined {
+    const info = this.readErrorResponse(body);
+    if (!info) {
+      return undefined;
     }
+    const e = new SdkError(info.message, info.code);
+    e.detail = info.detail;
+    e.response = body;
+    return e;
   }
 }