@api-client/core 0.4.0 → 0.4.1

package/src/runtime/store/UsersSdk.ts

@@ -0,0 +1,89 @@
+import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN } from './SdkBase.js';
+import { RouteBuilder } from './RouteBuilder.js';
+import { IListOptions, IListResponse } from '../../models/Backend.js';
+import { IUser } from '../../models/User.js';
+
+export class UsersSdk extends SdkBase {
+  async me(): Promise<IUser> {
+    const { token } = this.sdk;
+    const url = this.sdk.getUrl(RouteBuilder.usersMe());
+    const result = await this.sdk.http.get(url.toString(), { token });
+    this.inspectCommonStatusCodes(result.status);
+    const E_PREFIX = 'Unable to read a user. ';
+    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: IUser;
+    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;
+  }
+
+  /**
+   * Lists users in the store
+   * 
+   * @param options Optional query options.
+   */
+  async list(options?: IListOptions): Promise<IListResponse> {
+    const { token } = this.sdk;
+    const url = this.sdk.getUrl(RouteBuilder.users());
+    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;
+  }
+
+  /**
+   * Reads a user information from the store.
+   * @param key The user key.
+   * @returns The user object
+   */
+  async read(key: string): Promise<IUser> {
+    const { token } = this.sdk;
+    const url = this.sdk.getUrl(RouteBuilder.user(key));
+    const result = await this.sdk.http.get(url.toString(), { token });
+    this.inspectCommonStatusCodes(result.status);
+    const E_PREFIX = 'Unable to read the user info. ';
+    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: IUser;
+    try {
+      data = JSON.parse(result.body);
+    } catch (e) {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
+    }
+    return data;
+  }
+}

package/src/runtime/store/WsClient.ts

@@ -0,0 +1,28 @@
+import WebSocketNode from 'ws';
+import { SdkBase } from './SdkBase.js';
+
+export abstract class WsClient extends SdkBase {
+  /**
+   * Creates a WS client with optional token
+   * @param addr The ws:// address
+   * @param token Optional token to add.
+   */
+  abstract getClient(addr: string, token?: string): WebSocket | WebSocketNode;
+
+  /**
+   * Connect to the WS server
+   * 
+   * @param client The client to wait for connection.
+   */
+  abstract connect(client: WebSocket | WebSocketNode): Promise<void>;
+
+  /**
+   * Disconnects from the WS server.
+   */
+  abstract disconnect(client: WebSocket | WebSocketNode): Promise<void>;
+
+  /**
+   * The combination of `getClient()` and `connect()`.
+   */
+  abstract createAndConnect(addr: string, token?: string): Promise<WebSocket | WebSocketNode>;
+}

package/src/runtime/store/WsClientNode.ts

@@ -0,0 +1,68 @@
+import WebSocket from 'ws';
+import { WsClient } from './WsClient.js';
+
+export class WsClientNode extends WsClient {
+  /**
+   * Creates a WS client with optional token
+   * @param addr The ws:// address
+   * @param token Optional token to add.
+   */
+  getClient(addr: string, token = this.sdk.token): WebSocket {
+    let url = addr;
+    if (token) {
+      url += url.includes('?') ? '&' : '?';
+      url += 'token=';
+      url += token;
+    }
+    if (url.startsWith('http:')) {
+      url = `ws:${url.substring(5)}`;
+    } else if (url.startsWith('https:')) {
+      url = `wss:${url.substring(6)}`;
+    }
+    return new WebSocket(url);
+  }
+
+  /**
+   * Connect to the WS server
+   * 
+   * @param client The client to wait for connection.
+   */
+  connect(client: WebSocket): Promise<void> {
+    return new Promise((resolve, reject) => {
+      client.once('open', () => {
+        client.removeAllListeners('error');
+        resolve();
+      });
+      client.once('error', (err) => {
+        client.removeAllListeners('open');
+        reject(err);
+      });
+    });
+  }
+
+  /**
+   * Disconnects from the WS server.
+   */
+  disconnect(client: WebSocket): Promise<void> {
+    return new Promise((resolve, reject) => {
+      client.once('close', () => {
+        client.removeAllListeners('error');
+        resolve();
+      });
+      client.once('error', (err) => {
+        client.removeAllListeners('close');
+        reject(err);
+      });
+      client.close();
+    });
+  }
+
+  /**
+   * The combination of `getClient()` and `connect()`.
+   */
+  async createAndConnect(addr: string, token?: string): Promise<WebSocket> {
+    const client = this.getClient(addr, token);
+    await this.connect(client);
+    return client;
+  }
+}

package/src/runtime/store/WsClientWeb.ts

@@ -0,0 +1,75 @@
+import { WsClient } from './WsClient.js';
+
+export class WsClientWeb extends WsClient {
+  /**
+   * Creates a WS client with optional token
+   * @param addr The ws:// address
+   * @param token Optional token to add.
+   */
+  getClient(addr: string, token = this.sdk.token): WebSocket {
+    let url = addr;
+    if (token) {
+      url += url.includes('?') ? '&' : '?';
+      url += 'token=';
+      url += token;
+    }
+    if (url.startsWith('http:')) {
+      url = `ws:${url.substring(5)}`;
+    } else if (url.startsWith('https:')) {
+      url = `wss:${url.substring(6)}`;
+    }
+    return new WebSocket(url);
+  }
+
+  /**
+   * Connect to the WS server
+   * 
+   * @param client The client to wait for connection.
+   */
+  connect(client: WebSocket): Promise<void> {
+    return new Promise((resolve, reject) => {
+      function opened(): void {
+        client.removeEventListener('open', opened);
+        client.removeEventListener('error', errored);
+        resolve();
+      }
+      function errored(): void {
+        client.removeEventListener('open', opened);
+        client.removeEventListener('error', errored);
+        reject(new Error(`Unable to connect to: ${client.url}`));
+      }
+      client.addEventListener('open', opened);
+      client.addEventListener('error', errored);
+    });
+  }
+
+  /**
+   * Disconnects from the WS server.
+   */
+  disconnect(client: WebSocket): Promise<void> {
+    return new Promise((resolve, reject) => {
+      function closed(): void {
+        client.removeEventListener('close', closed);
+        client.removeEventListener('error', errored);
+        resolve();
+      }
+      function errored(): void {
+        client.removeEventListener('close', closed);
+        client.removeEventListener('error', errored);
+        reject(new Error(`Unable to connect to: ${client.url}`));
+      }
+      client.addEventListener('close', closed);
+      client.addEventListener('error', errored);
+      client.close();
+    });
+  }
+
+  /**
+   * The combination of `getClient()` and `connect()`.
+   */
+  async createAndConnect(addr: string, token?: string): Promise<WebSocket> {
+    const client = this.getClient(addr, token);
+    await this.connect(client);
+    return client;
+  }
+}

package/build/src/models/HistoryIndex.d.ts

@@ -1,45 +0,0 @@
-export declare const Kind = "Core#HistoryIndex";
-/**
- * An object that is stored in API Client's internal store to build history navigation.
- * It does not contain all the history data. Just the ones that are presented in the UI.
- */
-export interface IHistoryIndex {
-    kind: typeof Kind;
-    /**
-     * Timestamp when the request was last updated.
-     */
-    updated: number;
-    /**
-     * A timestamp of the midnight when the request object was updated
-     */
-    midnight: number;
-    /**
-     * The request URL
-     */
-    url: string;
-    /**
-     * HTTP method name
-     */
-    method: string;
-}
-export declare class HistoryIndex {
-    /**
-     * Timestamp when the request was last updated.
-     */
-    updated: number;
-    /**
-     * A timestamp of the midnight when the request object was updated
-     */
-    midnight: number;
-    /**
-     * The request URL
-     */
-    url: string;
-    /**
-     * HTTP method name
-     */
-    method: string;
-    constructor(input?: string | IHistoryIndex);
-    new(init: IHistoryIndex): void;
-    toJSON(): IHistoryIndex;
-}

package/build/src/models/HistoryIndex.js

@@ -1,56 +0,0 @@
-export const Kind = 'Core#HistoryIndex';
-export class HistoryIndex {
-    /**
-     * Timestamp when the request was last updated.
-     */
-    updated = 0;
-    /**
-     * A timestamp of the midnight when the request object was updated
-     */
-    midnight = 0;
-    /**
-     * The request URL
-     */
-    url = '';
-    /**
-     * HTTP method name
-     */
-    method = 'GET';
-    constructor(input) {
-        let init;
-        if (typeof input === 'string') {
-            init = JSON.parse(input);
-        }
-        else if (typeof input === 'object') {
-            init = input;
-        }
-        else {
-            init = {
-                kind: Kind,
-                updated: 0,
-                midnight: 0,
-                url: '',
-                method: 'GET',
-            };
-        }
-        this.new(init);
-    }
-    new(init) {
-        const { updated = 0, midnight = 0, url = '', method = 'GET' } = init;
-        this.updated = updated;
-        this.midnight = midnight;
-        this.url = url;
-        this.method = method;
-    }
-    toJSON() {
-        const result = {
-            kind: Kind,
-            updated: this.updated,
-            midnight: this.midnight,
-            url: this.url,
-            method: this.method,
-        };
-        return result;
-    }
-}
-//# sourceMappingURL=HistoryIndex.js.map

package/build/src/models/HistoryIndex.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"HistoryIndex.js","sourceRoot":"","sources":["../../../src/models/HistoryIndex.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG,mBAAmB,CAAC;AA0BxC,MAAM,OAAO,YAAY;IACvB;;OAEG;IACH,OAAO,GAAG,CAAC,CAAC;IACZ;;OAEG;IACH,QAAQ,GAAG,CAAC,CAAC;IACb;;OAEG;IACH,GAAG,GAAG,EAAE,CAAC;IACT;;OAEG;IACH,MAAM,GAAG,KAAK,CAAC;IAEf,YAAY,KAA4B;QACtC,IAAI,IAAmB,CAAC;QACxB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SAC1B;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YACpC,IAAI,GAAG,KAAK,CAAC;SACd;aAAM;YACL,IAAI,GAAG;gBACL,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,CAAC;gBACV,QAAQ,EAAE,CAAC;gBACX,GAAG,EAAE,EAAE;gBACP,MAAM,EAAE,KAAK;aACd,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,GAAG,CAAC,IAAmB;QACrB,MAAM,EAAE,OAAO,GAAC,CAAC,EAAE,QAAQ,GAAC,CAAC,EAAE,GAAG,GAAC,EAAE,EAAE,MAAM,GAAC,KAAK,EAAE,GAAG,IAAI,CAAC;QAC7D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAkB;YAC5B,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/build/src/runtime/store/StoreSdk.d.ts

@@ -1,279 +0,0 @@
-/// <reference types="node" />
-import http from 'http';
-import WebSocket from 'ws';
-import { URL } from 'url';
-import { JsonPatch } from 'json8-patch';
-import { IBackendInfo, IListOptions, IListResponse } from '../../models/Backend.js';
-import { IWorkspace, IUserWorkspace, Workspace } from '../../models/Workspace.js';
-import { UserAccessOperation, IUser } from '../../models/User.js';
-import { HttpProject, IHttpProject } from '../../models/HttpProject.js';
-export interface IStoreRequestOptions {
-    method?: 'GET' | 'POST' | 'PATCH' | 'DELETE';
-    headers?: Record<string, string>;
-    body?: string | Buffer;
-    /**
-     * Adds the token to the headers.
-     */
-    token?: string;
-}
-export interface IStoreResponse {
-    status: number;
-    headers: http.IncomingHttpHeaders;
-    body?: string;
-}
-export interface IStoreTokenInfo {
-    /**
-     * The token to use.
-     */
-    token: string;
-    /**
-     * The timestamp when the token expires.
-     * Note, clients may have a different date than the store.
-     *
-     * May not be set when the token does not expire.
-     */
-    expires?: number;
-}
-declare const baseUriSymbol: unique symbol;
-/**
- * NodeJS API for API Client's net-store module.
- */
-export declare class StoreSdk {
-    basePath?: string | undefined;
-    /**
-     * The token to use with requests. Can be overwritten with each API call.
-     */
-    token?: string;
-    /**
-     * The user authentication features.
-     */
-    auth: AuthSdk;
-    /**
-     * The store information features
-     */
-    store: BackendSdk;
-    /**
-     * The user spaces features.
-     */
-    space: SpacesSdk;
-    /**
-     * The user projects features.
-     */
-    project: ProjectsSdk;
-    /**
-     * Reads user information.
-     */
-    user: UsersSdk;
-    /**
-     * The HTTP(S) requests.
-     */
-    http: HttpClient;
-    /**
-     * The web socket requests.
-     */
-    ws: WsClient;
-    [baseUriSymbol]: string;
-    /**
-     * @returns The base URI to the store.
-     */
-    get baseUri(): string;
-    /**
-     * @param value The base URI to the store.
-     */
-    set baseUri(value: string);
-    /**
-     * @param baseUri The base URI to the store.
-     * @param basePath The base path (the router prefix) for the server.
-     */
-    constructor(baseUri: string, basePath?: string | undefined);
-    /**
-     * Creates a full URL for a path.
-     * This adds the server's base path and the passed path to the configured base URL.
-     * @param path The path to the endpoint, without the base path.
-     */
-    getUrl(path?: string): URL;
-    /**
-     * Appends list options to the query parameters.
-     * @param url The URL object to the API endpoint
-     * @param options The list options, if any
-     */
-    appendListOptions(url: URL, options?: IListOptions): void;
-}
-declare class SdkBase {
-    sdk: StoreSdk;
-    constructor(sdk: StoreSdk);
-    protected logInvalidResponse(response: IStoreResponse): void;
-    /**
-     * Throws unified message for a common error status codes.
-     * It handles 404, 403, and 401 status codes.
-     */
-    protected inspectCommonStatusCodes(status: number): void;
-}
-declare class AuthSdk extends SdkBase {
-    protected getExpires(headers: http.IncomingHttpHeaders): number | undefined;
-    /**
-     * Creates unauthenticated session in the backend.
-     * @returns The JWT for unauthenticated user.
-     */
-    createSession(): Promise<IStoreTokenInfo>;
-    /**
-     * Initializes the authentication session.
-     * @param token The unauthenticated session JWT. Required when not set on the class.
-     * @returns The location of the authorization endpoint.
-     */
-    createAuthSession(token?: string, loginPath?: string): Promise<string>;
-    /**
-     * Listens to the first message coming to the client from the auth endpoint.
-     * @param authPath The authorization path returned by the server info or 401 response.
-     * @param token Optional token to use.
-     */
-    listenAuth(authPath: string, token?: string): Promise<void>;
-    /**
-     * Renews authenticated token to a new one when the token expires.
-     * @param token Optional token to use.
-     * @returns
-     */
-    renewToken(token?: string | undefined): Promise<IStoreTokenInfo>;
-}
-declare class BackendSdk extends SdkBase {
-    /**
-     * @returns Client information about the store configuration.
-     */
-    getInfo(): Promise<IBackendInfo>;
-}
-declare class SpacesSdk extends SdkBase {
-    /**
-     * Lists spaces in the store.
-     * @param options Optional query options.
-     */
-    list(options?: IListOptions): Promise<IListResponse>;
-    /**
-     * Creates a workspace in the store.
-     * @param space The workspace definition.
-     * @returns The key of the creates space.
-     */
-    create(space: IWorkspace | Workspace): Promise<string>;
-    /**
-     * Reads a user space definition from the store.
-     * @param key The user space key
-     * @returns The definition of the user space.
-     */
-    read(key: string): Promise<IUserWorkspace>;
-    /**
-     * 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
-     */
-    patch(key: string, value: JsonPatch): Promise<JsonPatch>;
-    /**
-     * Deletes the space in the store.
-     *
-     * @param key The key of the space to delete.
-     */
-    delete(key: string): Promise<void>;
-    /**
-     * Updates the sharing options of the space.
-     *
-     * @param key The user space key
-     * @param value The patch operation on the space's ACL
-     */
-    patchUsers(key: string, value: UserAccessOperation[]): Promise<void>;
-    /**
-     * Lists uses having access to the user space.
-     *
-     * @param key The user space key
-     */
-    listUsers(key: string): Promise<IListResponse>;
-}
-declare class HttpClient extends SdkBase {
-    /**
-     * Performs the GET request.
-     *
-     * @param url The request URL
-     * @param opts The request options
-     * @returns The response info.
-     */
-    get(url: string, opts?: IStoreRequestOptions): Promise<IStoreResponse>;
-    private _get;
-    post(url: string, opts?: IStoreRequestOptions): Promise<IStoreResponse>;
-    patch(url: string, opts?: IStoreRequestOptions): Promise<IStoreResponse>;
-    delete(url: string, opts?: IStoreRequestOptions): Promise<IStoreResponse>;
-}
-declare class WsClient extends SdkBase {
-    /**
-     * Creates a WS client with optional token
-     * @param addr The ws:// address
-     * @param token Optional token to add.
-     */
-    getClient(addr: string, token?: string | undefined): WebSocket;
-    /**
-     * Connect to the WS server
-     *
-     * @param client The client to wait for connection.
-     */
-    connect(client: WebSocket): Promise<void>;
-    /**
-     * Disconnects from the WS server.
-     */
-    disconnect(client: WebSocket): Promise<void>;
-    /**
-     * The combination of `getClient()` and `connect()`.
-     */
-    createAndConnect(addr: string, token?: string): Promise<WebSocket>;
-}
-declare class ProjectsSdk extends SdkBase {
-    /**
-     * Creates a project in a user space.
-     *
-     * @param key The user space key
-     * @param project THe project to create
-     * @returns The key of the created project.
-     */
-    create(key: string, project: IHttpProject | HttpProject): Promise<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.
-     */
-    read(space: string, project: string): Promise<IHttpProject>;
-    /**
-     * Lists projects in the space
-     *
-     * @param space The user space key
-     * @param options Optional query options.
-     */
-    list(space: string, options?: IListOptions): Promise<IListResponse>;
-    /**
-     * Deletes a project form the store.
-     *
-     * @param space The key of the parent space.
-     * @param project The key of the project to delete.
-     */
-    delete(space: string, project: string): Promise<void>;
-    /**
-     * 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
-     */
-    patch(space: string, project: string, value: JsonPatch): Promise<JsonPatch>;
-}
-declare class UsersSdk extends SdkBase {
-    me(): Promise<IUser>;
-    /**
-     * Lists users in the store
-     *
-     * @param options Optional query options.
-     */
-    list(options?: IListOptions): Promise<IListResponse>;
-    /**
-     * Reads a user information from the store.
-     * @param key The user key.
-     * @returns The user object
-     */
-    read(key: string): Promise<IUser>;
-}
-export {};