@api-client/core 0.4.0 → 0.4.3

package/src/runtime/store/BackendSdk.ts

@@ -0,0 +1,25 @@
+import { SdkBase } from './SdkBase.js';
+import { RouteBuilder } from './RouteBuilder.js';
+import { IBackendInfo } from '../../models/Backend.js';
+
+export class BackendSdk extends SdkBase {
+  /**
+   * @returns Client information about the store configuration.
+   */
+  async getInfo(): Promise<IBackendInfo> {
+    const url = this.sdk.getUrl(RouteBuilder.backend());
+    const result = await this.sdk.http.get(url.toString());
+    this.inspectCommonStatusCodes(result.status);
+    if (result.status !== 200) {
+      throw new Error(`Invalid store response. Expected 200 status and ${result.status} received.`);
+    }
+    const body = result.body as string;
+    let data;
+    try {
+      data = JSON.parse(body);
+    } catch (e) {
+      throw new Error(`The server returned invalid response. Unable to read store status.`);
+    }
+    return data as IBackendInfo;
+  }
+}

package/src/runtime/store/HistorySdk.ts

@@ -0,0 +1,157 @@
+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 { IListResponse, HistoryListOptions } from '../../models/Backend.js';
+import { IHttpHistory, IHttpHistoryBulkAdd, Kind as HttpHistoryKind } from '../../models/HttpHistory.js';
+
+export class HistorySdk extends SdkBase {
+  /**
+   * Creates a history object.
+   * A history object can be created per app (type = app) or a store's space/[project/[request]].
+   * 
+   * The user can always read their own history. If the history is created for a space/project then 
+   * history records are shared as any other object in the space.
+   * 
+   * Note, history objects cannot be updated. They can only be created or deleted.
+   * 
+   * @param history The history to create
+   * @returns The key of the created history.
+   */
+  async create(history: IHttpHistory): Promise<string> {
+    const { token } = this.sdk;
+    const url = this.sdk.getUrl(RouteBuilder.history());
+    const body = JSON.stringify(history);
+    const result = await this.sdk.http.post(url.toString(), { token, body });
+    this.inspectCommonStatusCodes(result.status);
+    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}`);
+    }
+    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;
+  }
+
+  /**
+   * Creates a multiple history objects in a batch operation.
+   * 
+   * @param info The bulk create info object.
+   */
+  async createBulk(info: IHttpHistoryBulkAdd): Promise<string[]> {
+    const { token } = this.sdk;
+    const url = this.sdk.getUrl(RouteBuilder.historyBatchCreate());
+    const body = JSON.stringify(info);
+    const result = await this.sdk.http.post(url.toString(), { token, body });
+    this.inspectCommonStatusCodes(result.status);
+    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}`);
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
+    }
+    let data: string[];
+    try {
+      data = JSON.parse(result.body);
+    } catch (e) {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
+    }
+    return data;
+  }
+
+  /**
+   * Lists the history.
+   * 
+   * @param options Optional query options.
+   */
+  async list(options: HistoryListOptions): Promise<IListResponse> {
+    const { token } = this.sdk;
+    const url = this.sdk.getUrl(RouteBuilder.history());
+    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 history. ';
+    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 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.
+   */
+  delete(key: string): 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.
+   */
+  delete(keys: string[]): Promise<void>;
+  /**
+   * Deletes a history or a list of history objects from the store.
+   * @param key A key or a list of keys.
+   */
+  async delete(key: string | string[]): Promise<void> {
+    const { token } = this.sdk;
+    const isArray = Array.isArray(key);
+    const path = isArray ? RouteBuilder.historyBatchDelete() : RouteBuilder.historyItem(key);
+    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 });
+    this.inspectCommonStatusCodes(result.status);
+    const E_PREFIX = 'Unable to delete history. ';
+    if (result.status !== 204) {
+      this.logInvalidResponse(result);
+      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
+    }
+  }
+
+  /**
+   * Reads a history definition from the store.
+   * @param key The history key
+   * @returns The history object
+   */
+  async read(key: string): Promise<IHttpHistory> {
+    const { token } = this.sdk;
+    const url = this.sdk.getUrl(RouteBuilder.historyItem(key));
+    const result = await this.sdk.http.get(url.toString(), { token });
+    this.inspectCommonStatusCodes(result.status);
+    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}`);
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
+    }
+    let data: IHttpHistory;
+    try {
+      data = JSON.parse(result.body);
+    } catch (e) {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
+    }
+    if (data.kind !== HttpHistoryKind) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
+    }
+    return data;
+  }
+}

package/src/runtime/store/Http.ts

@@ -0,0 +1,18 @@
+import { SdkBase, IStoreRequestOptions, IStoreResponse } from './SdkBase.js';
+
+export abstract class Http extends SdkBase {
+  /**
+   * Performs the GET request.
+   * 
+   * @param url The request URL
+   * @param opts The request options
+   * @returns The response info.
+   */
+  abstract get(url: string, opts?: IStoreRequestOptions): Promise<IStoreResponse>;
+
+  abstract post(url: string, opts?: IStoreRequestOptions): Promise<IStoreResponse>;
+
+  abstract patch(url: string, opts?: IStoreRequestOptions): Promise<IStoreResponse>;
+
+  abstract delete(url: string, opts?: IStoreRequestOptions): Promise<IStoreResponse>;
+}

package/src/runtime/store/HttpNode.ts

@@ -0,0 +1,100 @@
+import http from 'http';
+import https from 'https';
+import { Headers } from '../../lib/headers/Headers.js';
+import { Http } from './Http.js';
+import { IStoreRequestOptions, IStoreResponse } from './SdkBase.js';
+
+export class HttpNode extends Http {
+  /**
+   * Performs the GET request.
+   * 
+   * @param url The request URL
+   * @param opts The request options
+   * @returns The response info.
+   */
+  async get(url: string, opts: IStoreRequestOptions = {}): Promise<IStoreResponse> {
+    const result = await this._get(url, opts);
+    if ([301, 302, 308, 307].includes(result.status)) {
+      const loc = result.headers.get('location');
+      if (!loc) {
+        throw new Error('Expected redirection but no "location" header.')
+      }
+      const newUrl = new URL(loc, url);
+      return this.get(newUrl.toString(), opts);
+    }
+    return result;
+  }
+
+  private _get(url: string, opts: IStoreRequestOptions = {}): Promise<IStoreResponse> {
+    return new Promise((resolve, reject) => {
+      const { method='GET', headers={}, token = this.sdk.token } = opts;
+      if (token) {
+        headers.authorization = `Bearer ${token}`;
+      }
+      const isSsl = url.startsWith('https:');
+      const lib = isSsl ? https : http;
+      // console.log(`${method} ${url}`);
+      const request = lib.request(url, {
+        method,
+        headers,
+        rejectUnauthorized: false,
+      });
+      request.on('response', (response) => {
+        const ro: IStoreResponse = {
+          status: response.statusCode as number,
+          headers: new Headers(response.headers),
+          body: '',
+        };
+        response.on('data', (chunk) => {
+          ro.body += chunk;
+        });
+        response.on('end', () => resolve(ro));
+      });
+      request.on('error', (error) => reject(error));
+      request.end();
+    });
+  }
+
+  post(url: string, opts: IStoreRequestOptions = {}): Promise<IStoreResponse> {
+    return new Promise((resolve, reject) => {
+      const { method='POST', headers={}, token = this.sdk.token } = opts;
+      if (token) {
+        headers.authorization = `Bearer ${token}`;
+      }
+      const isSsl = url.startsWith('https:');
+      const lib = isSsl ? https : http;
+      const request = lib.request(url, {
+        method,
+        headers,
+      });
+      request.on('response', (response) => {
+        const ro: IStoreResponse = {
+          status: response.statusCode as number,
+          headers: new Headers(response.headers),
+          body: '',
+        };
+        response.on('data', (chunk) => {
+          ro.body += chunk;
+        });
+        response.on('end', () => resolve(ro));
+      });
+      request.on('error', (error) => reject(error));
+      if (opts.body) {
+        request.write(opts.body);
+      }
+      request.end();
+    });
+  }
+
+  patch(url: string, opts: IStoreRequestOptions = {}): Promise<IStoreResponse> {
+    const options = { ...opts };
+    options.method = 'PATCH';
+    return this.post(url, options);
+  }
+
+  delete(url: string, opts: IStoreRequestOptions = {}): Promise<IStoreResponse> {
+    const options = { ...opts };
+    options.method = 'DELETE';
+    return this.post(url, options);
+  }
+}

package/src/runtime/store/HttpWeb.ts

@@ -0,0 +1,89 @@
+import { Http } from './Http.js';
+import { IStoreRequestOptions, IStoreResponse } from './SdkBase.js';
+import { Headers } from '../../lib/headers/Headers.js';
+
+export class HttpWeb extends Http {
+  /**
+   * Performs the GET request.
+   * 
+   * @param url The request URL
+   * @param opts The request options
+   * @returns The response info.
+   */
+  async get(url: string, opts: IStoreRequestOptions = {}): Promise<IStoreResponse> {
+    const { method='GET', headers={}, token = this.sdk.token } = opts;
+    if (token) {
+      headers.authorization = `Bearer ${token}`;
+    }
+    // eslint-disable-next-line no-undef
+    const init: RequestInit = {
+      method,
+      headers,
+      redirect: 'follow',
+    };
+    const response = await fetch(url, init);
+    let body: string | undefined;
+    try {
+      body = await response.text();
+    } catch (e) {
+      // ...
+    }
+
+    const responseHeaders = new Headers();
+    response.headers.forEach((value: string, key: string) => {
+      responseHeaders.append(key, value);
+    });
+
+    const result: IStoreResponse = {
+      status: response.status,
+      headers: responseHeaders,
+      body,
+    };
+    return result;
+  }
+
+  async post(url: string, opts: IStoreRequestOptions = {}): Promise<IStoreResponse> {
+    const { method='POST', headers={}, token = this.sdk.token } = opts;
+    if (token) {
+      headers.authorization = `Bearer ${token}`;
+    }
+    // eslint-disable-next-line no-undef
+    const init: RequestInit = {
+      method,
+      headers,
+      redirect: 'follow',
+    };
+    if (opts.body) {
+      init.body = opts.body.toString();
+    }
+    const response = await fetch(url, init);
+    let body: string | undefined;
+    try {
+      body = await response.text();
+    } catch (e) {
+      // ...
+    }
+
+    const responseHeaders = new Headers();
+    response.headers.forEach((value: string, key: string) => {
+      responseHeaders.append(key, value);
+    });
+
+    const result: IStoreResponse = {
+      status: response.status,
+      headers: responseHeaders,
+      body,
+    };
+    return result;
+  }
+
+  patch(url: string, opts: IStoreRequestOptions = {}): Promise<IStoreResponse> {
+    const options: IStoreRequestOptions = { ...opts, method: 'PATCH' };
+    return this.post(url, options);
+  }
+
+  delete(url: string, opts: IStoreRequestOptions = {}): Promise<IStoreResponse> {
+    const options: IStoreRequestOptions = { ...opts, method: 'DELETE' };
+    return this.post(url, options);
+  }
+}

package/src/runtime/store/ProjectsSdk.ts

@@ -0,0 +1,147 @@
+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/RouteBuilder.ts

@@ -0,0 +1,89 @@
+/**
+ * A helper class to make sure routes user and reported by this service are consistent.
+ */
+export class RouteBuilder {
+  /**
+   * @returns The path to the /spaces route.
+   */
+  static spaces(): string {
+    return '/spaces';
+  }
+
+  /**
+   * @returns The path to the /spaces/[id] route.
+   */
+  static space(key: string): string {
+    return `/spaces/${key}`;
+  }
+
+  /**
+   * @returns The path to the /spaces/[id]/users route.
+   */
+  static spaceUsers(key: string): string {
+    return `/spaces/${key}/users`;
+  }
+
+  /**
+   * @returns The path to the /spaces/[id]/projects 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`;
+  }
+
+  /**
+   * @returns The path to the /backend route.
+   */
+  static backend(): string {
+    return '/store';
+  }
+
+  static sessions(): string {
+    return '/sessions'
+  }
+
+  static sessionRenew(): string {
+    return '/sessions/renew'
+  }
+
+  static usersMe(): string {
+    return '/users/me'
+  }
+
+  static users(): string {
+    return '/users'
+  }
+
+  static user(key: string): string {
+    return `/users/${key}`
+  }
+
+  static history(): string {
+    return `/history`;
+  }
+
+  static historyBatchCreate(): string {
+    return `/history/batch/create`;
+  }
+
+  static historyBatchDelete(): string {
+    return `/history/batch/delete`;
+  }
+
+  static historyItem(key: string): string {
+    return `/history/${key}`;
+  }
+}