@api-client/core 0.5.3 → 0.5.6

package/json8-patch.d.ts

@@ -1,270 +0,0 @@
-declare module "json8-patch" {
-  export interface BaseOperation {
-      path: string;
-  }
-
-  export interface AddOperation extends BaseOperation {
-      op: "add";
-      value: any;
-  }
-
-  export interface RemoveOperation extends BaseOperation {
-      op: "remove";
-  }
-
-  /**
-   * The JSON patch replace operation
-   */
-  export interface ReplaceOperation extends BaseOperation {
-      op: "replace";
-      value: any;
-  }
-
-  /**
-   * The JSON patch move operation
-   */
-  export interface MoveOperation extends BaseOperation {
-      op: "move";
-      from: any;
-  }
-
-  /**
-   * The JSON patch copy operation.
-   */
-  export interface CopyOperation extends BaseOperation {
-      op: "copy";
-      from: any;
-  }
-
-  /**
-   * The JSON patch test operation
-   */
-  export interface TestOperation extends BaseOperation {
-      op: "test";
-      value: any;
-  }
-
-  /**
-   * All possible JSON patch operations
-   */
-  export type JsonPatchOperation = AddOperation | RemoveOperation | ReplaceOperation | MoveOperation | CopyOperation | TestOperation;
-
-  /**
-   * A JSON patch as specified in RFC 6902
-   */
-  export type JsonPatch = JsonPatchOperation[];
-
-  export interface ApplyResult<T> {
-      doc: T;
-  }
-
-  export interface ApplyResultWithRevert<T> extends ApplyResult<T> {
-      revert: JsonPatch;
-  }
-
-  export type PatchResult<T> = ApplyResult<T>;
-  export type PatchResultWithRevert<T> = ApplyResultWithRevert<T>;
-
-  /**
-   * The operation is atomic, if any of the patch operation fails, the document will be restored to its original state and an error will be thrown.
-   * @param doc The document to apply the patch operation to
-   * @param patch The patch operations
-   * @param options With `{reversible: false}` it will not return an additional value in the form of a `revert` property.
-   * @returns An object with a doc property because per specification a patch can replace the original root document.
-   */
-  export function apply<T>(doc: T, patch: JsonPatch, options?: { reversible: false }): ApplyResult<T>;
-  /**
-   * The operation is atomic, if any of the patch operation fails, the document will be restored to its original state and an error will be thrown.
-   * @param doc The document to apply the patch operation to
-   * @param patch The patch operations
-   * @param options With `{reversible: true}` it will return an additional value in the form of a `revert` property.
-   * @returns An object with a doc property because per specification a patch can replace the original root document.
-   */
-  export function apply<T>(doc: T, patch: JsonPatch, options?: { reversible: true }): ApplyResultWithRevert<T>;
-  /**
-   * Alias for the `apply()` method.
-   */
-  export function patch<T>(doc: T, patch: JsonPatch, options?: { reversible: false }): PatchResult<T>;
-  /**
-   * Alias for the `apply()` method.
-   */
-  export function patch<T>(doc: T, patch: JsonPatch, options?: { reversible: true }): PatchResultWithRevert<T>;
-  /**
-   * ```javascript
-   * ooPatch.diff(true, false);
-   * // [{"op": "replace", "path": "", "value": "false"}]
-   *
-   * ooPatch.diff([], []);
-   * // []
-   *
-   * ooPatch.diff({}, { foo: "bar" });
-   * // [{"op": "add", "path": "/foo", "value": "bar"}]
-   * ```
-   *
-   * @returns A diff in the form of a JSON Patch for 2 JSON values.
-   */
-  export function diff(doc1: unknown, doc2: unknown): JsonPatch;
-  /**
-   * If the patch or apply method is called with a third argument `{reversible: true}` it will return an additional value in the form of a revert property.
-   *
-   * The revert object can be used to revert a patch on a document.
-   *
-   * ```javascript
-   * // apply the patch with the reversible option
-   * var applyResult = ooPatch.apply(doc, patch, { reversible: true });
-   * doc = applyResult.doc;
-   *
-   * // revert the patch
-   * doc = ooPatch.revert(doc, applyResult.revert).doc;
-   * // doc is strictly identical to the original
-   * ```
-   *
-   * See also the `buildRevertPatch()` function which offers more flexibility.
-   */
-  export function revert<T>(doc: T, revertPatch: JsonPatch): ApplyResult<T>;
-  /**
-   * This method only check for JSON Patch semantic.
-   *
-   * ```javascript
-   * ooPatch.valid({})  // false
-   * ooPatch.valid([{}] // false
-   * ooPatch.valid([{op: "foo", path: null, value: undefined}]) // false
-   * ooPatch.valid([{op: "add", path: "/foo"}]) // false
-   *
-   * ooPatch.valid([]) // true
-   * ooPatch.valid([{op: "add", path: "/foo", value: "bar"}]) // true
-   * ```
-   *
-   * @returns `true` if the patch is valid, `false` otherwise.
-   */
-  export function valid(patch: JsonPatch): boolean;
-  /**
-   * Builds a valid JSON Patch from the result of a reversible `apply` operation.
-   * You can then use this patch with `apply()` method to revert a previously applied patch.
-   *
-   * Because `buildRevertPatch` + `apply` offers more flexibility over `revert` it is preferred.
-   *
-   * - use pack/unpack with the result of `buildRevertPatch` making it ideal for storage or transport
-   * - reverse a revert (and so on...) with `{reversible: true}`
-   * - `diff` between reverts
-   * - merge multiple reverts into one
-   * - rebase reverts
-   *
-   * @param revert The revert value from the `apply()` or `patch()` method with `{reversible: true}`
-   * @returns JSON Patch
-   */
-  export function buildRevertPatch(revert: JsonPatch): JsonPatch;
-
-  export interface OperationResult<T> {
-      /**
-       * The patched document
-       */
-      doc: T;
-      /**
-       * The previous/replaced value if any
-       */
-      previous?: T;
-      idx?: number;
-  }
-
-  /**
-   * Add the value to the specified JSON Pointer location.
-   * @param doc JSON document to set the value to
-   * @param path JSON Pointer string or tokens path
-   * @param value The value to add
-   */
-  export function add<T>(doc: T, path: string | string[], value: unknown): OperationResult<T>;
-  /**
-   * Copy the value at the specified JSON Pointer location to another location.
-   *
-   * @param doc JSON document to copy the value from and to
-   * @param path JSON Pointer string or tokens path
-   * @param dest JSON Pointer string destination of the value
-   */
-  export function copy<T>(doc: T, path: string | string[], dest: string): OperationResult<T>;
-  /**
-   * Moves the value at the specified JSON Pointer location to another location.
-   *
-   * @param doc JSON document to move the value from and to
-   * @param path JSON Pointer string or tokens path
-   * @param dest JSON Pointer string destination of the value
-   */
-  export function move<T>(doc: T, path: string | string[], dest: string): OperationResult<T>;
-  /**
-   * Removes the value at the JSON Pointer location.
-   *
-   * @param doc JSON document to search into
-   * @param path JSON Pointer string or tokens patch
-   */
-  export function remove<T>(doc: T, path: string | string[]): OperationResult<T>;
-  /**
-   * Replaces the value at the JSON Pointer location
-   *
-   * @param doc JSON document
-   * @param path JSON Pointer string or tokens patch
-   * @param value JSON object to replace with
-   */
-  export function replace<T>(doc: T, path: string | string[], value: unknown): OperationResult<T>;
-  /**
-   * Tests that the value at the specified JSON Pointer location is equal to the specified value.
-   *
-   * @param doc JSON document
-   * @param path JSON Pointer string or tokens patch
-   * @param value The value to compare with
-   */
-  export function test<T>(doc: T, path: string | string[], value: unknown): OperationResult<T>;
-  /**
-   * Get the value at the JSON Pointer location.
-   *
-   * @param doc JSON document
-   * @param path JSON Pointer string or tokens patch
-   * @returns The value at the JSON Pointer location
-   */
-  export function get(doc: unknown, path: string | string[]): unknown;
-  /**
-   * Checks if the document has the property at the specified JSON Pointer location.
-   *
-   * @param doc JSON document
-   * @param path JSON Pointer string or tokens path
-   */
-  export function has(doc: unknown, path: string | string[]): boolean;
-  /**
-   * Per specification patches are pretty verbose. JSON8 provides the `pack()` and the `unpack()` methods
-   * to reduce the size of patches and save memory / space / bandwidth.
-   *
-   * ```javascript
-   * var patch = [
-   *   { op: "add", path: "/a/b/c", value: ["foo", "bar"] },
-   *   { op: "remove", path: "/a/b/c" },
-   *   { op: "replace", path: "/a/b/c", value: 42 },
-   *   { op: "move", from: "/a/b/c", path: "/a/b/d" },
-   *   { op: "copy", from: "/a/b/c", path: "/a/b/e" },
-   *   { op: "test", path: "/a/b/c", value: "foo" },
-   * ];
-   *
-   * var packed = ooPatch.pack(patch);
-   *
-   * // [
-   * //   [0, "/a/b/c", ["foo", "bar"]],
-   * //   [1, "/a/b/c"],
-   * //   [2, "/a/b/c", 42],
-   * //   [3, "/a/b/d", "/a/b/c"],
-   * //   [4, "/a/b/e", "/a/b/c"],
-   * //   [5, "/a/b/c", "foo"]
-   * // ]
-   * ```
-   */
-  export function pack(patch: JsonPatch): any[];
-  /**
-   * Reverses the `pack()` on a patch.
-   *
-   * @param packed Previously packed values.
-   * @returns Restored patch value.
-   */
-  export function unpack(packed: any[]): JsonPatch;
-  /**
-   * Concatenates multiple patches into one.
-   */
-  export function concat(...patches: JsonPatch): JsonPatch;
-
-}

package/src/runtime/store/ProjectsSdk.ts

@@ -1,147 +0,0 @@
-import { JsonPatch } from 'json8-patch';
-import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, E_RESPONSE_LOCATION } from './SdkBase.js';
-import { RouteBuilder } from './RouteBuilder.js';
-import { IListOptions, IListResponse } from '../../models/Backend.js';
-import { HttpProject, IHttpProject, Kind as HttpProjectKind } from '../../models/HttpProject.js';
-
-export class ProjectsSdk extends SdkBase {
-  /**
-   * Creates a project in a user space.
-   * 
-   * @param space The user space key
-   * @param project THe project to create
-   * @returns The key of the created project.
-   */
-  async create(space: string, project: IHttpProject | HttpProject): Promise<string> {
-    const { token } = this.sdk;
-    const url = this.sdk.getUrl(RouteBuilder.spaceProjects(space));
-    const body = JSON.stringify(project);
-    const result = await this.sdk.http.post(url.toString(), { token, body });
-    this.inspectCommonStatusCodes(result.status);
-    const E_PREFIX = 'Unable to create a project. ';
-    if (result.status !== 204) {
-      this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
-    }
-    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 a project definition from the store.
-   * @param space The user space key
-   * @param project The project key
-   * @returns The definition of the project.
-   */
-  async read(space: string, project: string): Promise<IHttpProject> {
-    const { token } = this.sdk;
-    const url = this.sdk.getUrl(RouteBuilder.spaceProject(space, project));
-    const result = await this.sdk.http.get(url.toString(), { token });
-    this.inspectCommonStatusCodes(result.status);
-    const E_PREFIX = 'Unable to read a project. ';
-    if (result.status !== 200) {
-      this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
-    }
-    if (!result.body) {
-      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
-    }
-    let data: IHttpProject;
-    try {
-      data = JSON.parse(result.body);
-    } catch (e) {
-      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
-    }
-    if (data.kind !== HttpProjectKind) {
-      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
-    }
-    return data;
-  }
-
-  /**
-   * Lists projects in the space
-   * 
-   * @param space The user space key
-   * @param options Optional query options.
-   */
-  async list(space: string, options?: IListOptions): Promise<IListResponse> {
-    const { token } = this.sdk;
-    const url = this.sdk.getUrl(RouteBuilder.spaceProjects(space));
-    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 projects. ';
-    if (result.status !== 200) {
-      this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
-    }
-    if (!result.body) {
-      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
-    }
-    let data: IListResponse;
-    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;
-  }
-
-  /**
-   * Deletes a project form the store.
-   * 
-   * @param space The key of the parent space.
-   * @param project The key of the project to delete.
-   */
-  async delete(space: string, project: string): Promise<void> {
-    const { token } = this.sdk;
-    const url = this.sdk.getUrl(RouteBuilder.spaceProject(space, project));
-    const result = await this.sdk.http.delete(url.toString(), { token });
-    this.inspectCommonStatusCodes(result.status);
-    const E_PREFIX = 'Unable to delete a project. ';
-    if (result.status !== 204) {
-      this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
-    }
-  }
-
-  /**
-   * Patches a project in the store.
-   * @param space The key of the parent user space
-   * @param project The key of project to patch.
-   * @param value The JSON patch to be processed.
-   * @returns The JSON patch to revert the change using the `json8-patch` library
-   */
-  async patch(space: string, project: string, value: JsonPatch): Promise<JsonPatch> {
-    const { token } = this.sdk;
-    const url = this.sdk.getUrl(RouteBuilder.spaceProject(space, project));
-    const body = JSON.stringify(value);
-    const result = await this.sdk.http.patch(url.toString(), { token, body });
-    this.inspectCommonStatusCodes(result.status);
-    const E_PREFIX = 'Unable to patch a project. ';
-    if (result.status !== 200) {
-      this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
-    }
-    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 JsonPatch;
-  }
-}

package/src/runtime/store/SpacesSdk.ts

@@ -1,209 +0,0 @@
-import { JsonPatch } from 'json8-patch';
-import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, E_RESPONSE_LOCATION } from './SdkBase.js';
-import { RouteBuilder } from './RouteBuilder.js';
-import { IListOptions, IListResponse } from '../../models/Backend.js';
-import { IWorkspace, Workspace, Kind as WorkspaceKind } from '../../models/Workspace.js';
-import { AccessOperation } from '../../models/store/Permission.js';
-import WebSocketNode from 'ws';
-
-export interface ISpaceCreateOptions {
-  /**
-   * Optional parent space id.
-   * When set it creates a space under this parent.
-   */
-  parent?: string;
-}
-
-export class SpacesSdk extends SdkBase {
-  /**
-   * Lists spaces in the store.
-   * @param options Optional query options.
-   */
-  async list(options?: IListOptions): Promise<IListResponse> {
-    const { token } = this.sdk;
-    const url = this.sdk.getUrl(RouteBuilder.spaces());
-    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 spaces. ';
-    if (result.status !== 200) {
-      this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
-    }
-    if (!result.body) {
-      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
-    }
-    let data: IListResponse;
-    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 workspace in the store.
-   * @param space The workspace definition.
-   * @returns The key of the creates space.
-   */
-  async create(space: IWorkspace | Workspace, opts: ISpaceCreateOptions = {}): Promise<string> {
-    const { token } = this.sdk;
-    const path = opts.parent ? RouteBuilder.space(opts.parent) : RouteBuilder.spaces();
-    const url = this.sdk.getUrl(path);
-    const body = JSON.stringify(space);
-    const result = await this.sdk.http.post(url.toString(), { token, body });
-    this.inspectCommonStatusCodes(result.status);
-    const E_PREFIX = 'Unable to create a user space. ';
-    if (result.status !== 204) {
-      this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
-    }
-    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 a user space definition from the store.
-   * @param key The user space key
-   * @returns The definition of the user space.
-   */
-  async read(key: string): Promise<IWorkspace> {
-    const { token } = this.sdk;
-    const url = this.sdk.getUrl(RouteBuilder.space(key));
-    const result = await this.sdk.http.get(url.toString(), { token });
-    this.inspectCommonStatusCodes(result.status);
-    const E_PREFIX = 'Unable to read a user space. ';
-    if (result.status !== 200) {
-      this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
-    }
-    if (!result.body) {
-      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
-    }
-    let data: IWorkspace;
-    try {
-      data = JSON.parse(result.body);
-    } catch (e) {
-      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
-    }
-    if (data.kind !== WorkspaceKind) {
-      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
-    }
-    return data;
-  }
-
-  /**
-   * Patches a user space in the store.
-   * @param key The key of the user space to patch
-   * @param value The JSON patch to be processed.
-   * @returns The JSON patch to revert the change using the `json8-patch` library
-   */
-  async patch(key: string, value: JsonPatch): Promise<JsonPatch> {
-    const { token } = this.sdk;
-    const url = this.sdk.getUrl(RouteBuilder.space(key));
-    const body = JSON.stringify(value);
-    const result = await this.sdk.http.patch(url.toString(), { token, body });
-    this.inspectCommonStatusCodes(result.status);
-    const E_PREFIX = 'Unable to patch a user space. ';
-    if (result.status !== 200) {
-      this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
-    }
-    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 JsonPatch;
-  }
-
-  /**
-   * Deletes the space in the store.
-   * 
-   * @param key The key of the space to delete.
-   */
-  async delete(key: string): Promise<void> {
-    const { token } = this.sdk;
-    const url = this.sdk.getUrl(RouteBuilder.space(key));
-    const result = await this.sdk.http.delete(url.toString(), { token });
-    this.inspectCommonStatusCodes(result.status);
-    const E_PREFIX = 'Unable to delete a user space. ';
-    if (result.status !== 204) {
-      this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
-    }
-  }
-
-  /**
-   * Updates the sharing options of the space.
-   * 
-   * @param key The user space key
-   * @param value The patch operation on the space's ACL
-   */
-  async patchUsers(key: string, value: AccessOperation[]): Promise<void> {
-    const { token } = this.sdk;
-    const url = this.sdk.getUrl(RouteBuilder.spaceUsers(key));
-    const body = JSON.stringify(value);
-    const result = await this.sdk.http.patch(url.toString(), { token, body });
-    this.inspectCommonStatusCodes(result.status);
-    const E_PREFIX = 'Unable to patch a user space. ';
-    if (result.status !== 204) {
-      this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
-    }
-  }
-
-  /**
-   * Lists uses having access to the user space.
-   * 
-   * @param key The user space key
-   */
-  async listUsers(key: string): Promise<IListResponse> {
-    const { token } = this.sdk;
-    const url = this.sdk.getUrl(RouteBuilder.spaceUsers(key));
-    const result = await this.sdk.http.get(url.toString(), { token });
-    this.inspectCommonStatusCodes(result.status);
-    const E_PREFIX = 'Unable to list users in the space. ';
-    if (result.status !== 200) {
-      this.logInvalidResponse(result);
-      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
-    }
-    if (!result.body) {
-      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
-    }
-    let data: IListResponse;
-    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 spaces events.
-   */
-  async observeSpaces(): Promise<WebSocketNode | WebSocket> {
-    const { token } = this.sdk;
-    const url = this.sdk.getUrl(RouteBuilder.spaces());
-    return this.sdk.ws.createAndConnect(url.toString(), token);
-  }
-}