@api-client/core 0.3.1 → 0.3.4

package/build/src/runtime/store/StoreSdk.js

@@ -1,54 +1,196 @@
 import http from 'http';
 import https from 'https';
 import WebSocket from 'ws';
+import { URL } from 'url';
+const E_INVALID_JSON = 'The response is not a valid JSON.';
+const E_RESPONSE_NO_VALUE = 'The response has no value.';
+const E_RESPONSE_STATUS = 'Invalid response status: ';
+const E_RESPONSE_UNKNOWN = 'The response has unknown format.';
+const E_RESPONSE_LOCATION = 'The response has no "location" header.';
+const baseUriSymbol = Symbol('baseUri');
 /**
  * NodeJS API for API Client's net-store module.
  */
 export class StoreSdk {
-    baseUri;
     basePath;
     /**
      * The token to use with requests. Can be overwritten with each API call.
      */
     token;
+    /**
+     * The user authentication features.
+     */
+    auth = new AuthSdk(this);
+    /**
+     * The store information features
+     */
+    store = new BackendSdk(this);
+    /**
+     * The user spaces features.
+     */
+    space = new SpacesSdk(this);
+    /**
+     * The user projects features.
+     */
+    project = new ProjectsSdk(this);
+    /**
+     * Reads user information.
+     */
+    user = new UsersSdk(this);
+    /**
+     * The HTTP(S) requests.
+     */
+    http = new HttpClient(this);
+    /**
+     * The web socket requests.
+     */
+    ws = new WsClient(this);
+    [baseUriSymbol] = '';
+    /**
+     * @returns The base URI to the store.
+     */
+    get baseUri() {
+        return this[baseUriSymbol];
+    }
+    /**
+     * @param value The base URI to the store.
+     */
+    set baseUri(value) {
+        if (!value) {
+            throw new Error(`Invalid value for the baseUri`);
+        }
+        let url;
+        try {
+            url = new URL(value);
+        }
+        catch (e) {
+            throw new Error(`Invalid baseUri: Not an URL`);
+        }
+        this[baseUriSymbol] = url.origin;
+        const { pathname } = url;
+        if (pathname && pathname !== '/') {
+            this.basePath = pathname;
+        }
+        else {
+            this.basePath = undefined;
+        }
+    }
     /**
      * @param baseUri The base URI to the store.
      * @param basePath The base path (the router prefix) for the server.
      */
     constructor(baseUri, basePath) {
-        this.baseUri = baseUri;
         this.basePath = basePath;
+        this.baseUri = baseUri;
     }
     /**
-     * @returns Client information about the store configuration.
+     * 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.
      */
-    async getInfo() {
-        const { baseUri } = this;
-        const url = `${baseUri}/store`;
-        const result = await this.get(url);
-        if (result.status !== 200) {
-            throw new Error(`Invalid store response. Expected 200 status and ${result.status} received.`);
+    getUrl(path = '/') {
+        const { baseUri, basePath = '' } = this;
+        let userPath = path;
+        if (basePath && userPath.startsWith(basePath)) {
+            userPath = userPath.substring(basePath.length);
         }
-        const body = result.body;
-        let data;
-        try {
-            data = JSON.parse(body);
+        return new URL(`${basePath}${userPath}`, baseUri);
+    }
+    /**
+     * 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, options = {}) {
+        const { searchParams } = url;
+        if (options.cursor) {
+            searchParams.set('cursor', options.cursor);
         }
-        catch (e) {
-            throw new Error(`The server returned invalid response. Unable to read store status.`);
+        else {
+            if (typeof options.limit === 'number') {
+                searchParams.set('limit', String(options.limit));
+            }
+            if (options.query) {
+                searchParams.set('query', options.query);
+            }
+            if (Array.isArray(options.queryField)) {
+                options.queryField.forEach((field) => {
+                    searchParams.append('queryField', field);
+                });
+            }
+        }
+    }
+}
+class SdkBase {
+    sdk;
+    constructor(sdk) {
+        this.sdk = sdk;
+    }
+    logInvalidResponse(response) {
+        if (response.body) {
+            try {
+                const data = JSON.parse(response.body);
+                if (data.message) {
+                    console.warn(`[Store message]: ${data.message}`);
+                }
+            }
+            catch (e) {
+                // .
+            }
         }
-        return data;
+    }
+    /**
+     * Throws unified message for a common error status codes.
+     * It handles 404, 403, and 401 status codes.
+     */
+    inspectCommonStatusCodes(status) {
+        if (status === 404) {
+            throw new Error(`Not found.`);
+        }
+        if (status === 403) {
+            throw new Error(`You have no access to this resource.`);
+        }
+        if (status === 401) {
+            throw new Error(`Not authorized.`);
+        }
+    }
+}
+class AuthSdk extends SdkBase {
+    getExpires(headers) {
+        if (!headers.expires) {
+            return undefined;
+        }
+        const d = new Date(headers.expires);
+        const time = d.getTime();
+        if (Number.isNaN(time)) {
+            console.warn(`Invalid session response: the expires header cannot be parsed.`);
+            return undefined;
+        }
+        return time;
     }
     /**
      * Creates unauthenticated session in the backend.
      * @returns The JWT for unauthenticated user.
      */
     async createSession() {
-        const { baseUri } = this;
-        const url = `${baseUri}/sessions`;
+        const url = this.sdk.getUrl('/sessions');
         // console.log('Create session: ', url);
-        const result = await this.post(url);
-        return result.body;
+        const result = await this.sdk.http.post(url.toString());
+        this.inspectCommonStatusCodes(result.status);
+        if (result.status !== 200) {
+            throw new Error(`Unable to create the session. Invalid response status: ${result.status}`);
+        }
+        if (!result.body) {
+            throw new Error(`Unable to create the session. Response has no token.`);
+        }
+        const info = {
+            token: result.body,
+        };
+        const expires = this.getExpires(result.headers);
+        if (expires) {
+            info.expires = expires;
+        }
+        return info;
     }
     /**
      * Initializes the authentication session.
@@ -56,17 +198,238 @@ export class StoreSdk {
      * @returns The location of the authorization endpoint.
      */
     async createAuthSession(token, loginPath = '/auth/login') {
-        const { baseUri } = this;
-        const url = `${baseUri}${loginPath}`;
-        const result = await this.post(url, {
-            token,
-        });
+        const url = this.sdk.getUrl(loginPath);
+        const result = await this.sdk.http.post(url.toString(), { token });
+        this.inspectCommonStatusCodes(result.status);
         const loc = result.headers.location;
         if (!loc) {
             throw new Error(`The location header not returned by the server.`);
         }
         return loc;
     }
+    /**
+     * 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.
+     */
+    async listenAuth(authPath, token) {
+        const url = this.sdk.getUrl(authPath);
+        const client = await this.sdk.ws.createAndConnect(url.toString(), token);
+        return new Promise((resolve, reject) => {
+            client.on('message', (data) => {
+                const message = JSON.parse(data.toString());
+                this.sdk.ws.disconnect(client)
+                    .then(() => {
+                    if (message.status === 'OK') {
+                        resolve();
+                    }
+                    else {
+                        reject(new Error(message.message || 'Unknown error'));
+                    }
+                }).catch(cause => reject(cause));
+            });
+        });
+    }
+    /**
+     * Renews authenticated token to a new one when the token expires.
+     * @param token Optional token to use.
+     * @returns
+     */
+    async renewToken(token = this.sdk.token) {
+        const authPath = '/sessions/renew';
+        const url = this.sdk.getUrl(authPath);
+        const result = await this.sdk.http.post(url.toString(), { token });
+        this.inspectCommonStatusCodes(result.status);
+        if (result.status !== 200) {
+            throw new Error(`Unable to renew the token. Invalid response status: ${result.status}`);
+        }
+        if (!result.body) {
+            throw new Error(`Unable to create the session. Response has no token.`);
+        }
+        const info = {
+            token: result.body,
+        };
+        const expires = this.getExpires(result.headers);
+        if (expires) {
+            info.expires = expires;
+        }
+        return info;
+    }
+}
+class BackendSdk extends SdkBase {
+    /**
+     * @returns Client information about the store configuration.
+     */
+    async getInfo() {
+        const url = this.sdk.getUrl('/store');
+        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;
+        let data;
+        try {
+            data = JSON.parse(body);
+        }
+        catch (e) {
+            throw new Error(`The server returned invalid response. Unable to read store status.`);
+        }
+        return data;
+    }
+}
+class SpacesSdk extends SdkBase {
+    /**
+     * Lists spaces in the store.
+     * @param options Optional query options.
+     */
+    async list(options) {
+        const { token } = this.sdk;
+        const url = this.sdk.getUrl('/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;
+        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) {
+        const { token } = this.sdk;
+        const url = this.sdk.getUrl('/spaces');
+        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;
+        if (!location) {
+            throw new Error(`${E_PREFIX}${E_RESPONSE_LOCATION}`);
+        }
+        const id = location.split('/').pop();
+        return id;
+    }
+    /**
+     * Reads a user space definition from the store.
+     * @param key The user space key
+     * @returns The definition of the user space.
+     */
+    async read(key) {
+        const { token } = this.sdk;
+        const url = this.sdk.getUrl(`/spaces/${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;
+        try {
+            data = JSON.parse(result.body);
+        }
+        catch (e) {
+            throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
+        }
+        if (data.kind !== 'ARC#Space') {
+            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, value) {
+        const { token } = this.sdk;
+        const url = this.sdk.getUrl(`/spaces/${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;
+        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;
+    }
+    /**
+     * Deletes the space in the store.
+     *
+     * @param key The key of the space to delete.
+     */
+    async delete(key) {
+        const { token } = this.sdk;
+        const url = this.sdk.getUrl(`/spaces/${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, value) {
+        const { token } = this.sdk;
+        const url = this.sdk.getUrl(`/spaces/${key}/users`);
+        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}`);
+        }
+    }
+}
+class HttpClient extends SdkBase {
     /**
      * Performs the GET request.
      *
@@ -88,7 +451,7 @@ export class StoreSdk {
     }
     _get(url, opts = {}) {
         return new Promise((resolve, reject) => {
-            const { method = 'GET', headers = {}, token = this.token } = opts;
+            const { method = 'GET', headers = {}, token = this.sdk.token } = opts;
             if (token) {
                 headers.authorization = `Bearer ${token}`;
             }
@@ -117,7 +480,7 @@ export class StoreSdk {
     }
     post(url, opts = {}) {
         return new Promise((resolve, reject) => {
-            const { method = 'POST', headers = {}, token = this.token } = opts;
+            const { method = 'POST', headers = {}, token = this.sdk.token } = opts;
             if (token) {
                 headers.authorization = `Bearer ${token}`;
             }
@@ -155,36 +518,14 @@ export class StoreSdk {
         options.method = 'DELETE';
         return this.post(url, options);
     }
-    /**
-     * 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.
-     */
-    async listenAuth(authPath, token) {
-        const { baseUri, basePath = '' } = this;
-        const authUrl = new URL(`${basePath}${authPath}`, baseUri);
-        const client = await this.createAndConnect(authUrl.toString(), token);
-        return new Promise((resolve, reject) => {
-            client.on('message', (data) => {
-                const message = JSON.parse(data.toString());
-                this.disconnect(client)
-                    .then(() => {
-                    if (message.status === 'OK') {
-                        resolve();
-                    }
-                    else {
-                        reject(new Error(message.message || 'Unknown error'));
-                    }
-                }).catch(cause => reject(cause));
-            });
-        });
-    }
+}
+class WsClient extends SdkBase {
     /**
      * Creates a WS client with optional token
      * @param addr The ws:// address
      * @param token Optional token to add.
      */
-    getWsClient(addr, token = this.token) {
+    getClient(addr, token = this.sdk.token) {
         let url = addr;
         if (token) {
             url += url.includes('?') ? '&' : '?';
@@ -236,9 +577,207 @@ export class StoreSdk {
      * The combination of `getClient()` and `connect()`.
      */
     async createAndConnect(addr, token) {
-        const client = this.getWsClient(addr, token);
+        const client = this.getClient(addr, token);
         await this.connect(client);
         return client;
     }
 }
+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.
+     */
+    async create(key, project) {
+        const { token } = this.sdk;
+        const url = this.sdk.getUrl(`/spaces/${key}/projects`);
+        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;
+        if (!location) {
+            throw new Error(`${E_PREFIX}${E_RESPONSE_LOCATION}`);
+        }
+        const id = location.split('/').pop();
+        return id;
+    }
+    /**
+     * 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, project) {
+        const { token } = this.sdk;
+        const url = this.sdk.getUrl(`/spaces/${space}/projects/${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;
+        try {
+            data = JSON.parse(result.body);
+        }
+        catch (e) {
+            throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
+        }
+        if (data.kind !== 'ARC#HttpProject') {
+            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, options) {
+        const { token } = this.sdk;
+        const url = this.sdk.getUrl(`/spaces/${space}/projects`);
+        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;
+        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, project) {
+        const { token } = this.sdk;
+        const url = this.sdk.getUrl(`/spaces/${space}/projects/${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, project, value) {
+        const { token } = this.sdk;
+        const url = this.sdk.getUrl(`/spaces/${space}/projects/${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;
+        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;
+    }
+}
+class UsersSdk extends SdkBase {
+    async me() {
+        const { token } = this.sdk;
+        const url = this.sdk.getUrl(`/users/me`);
+        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;
+        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) {
+        const { token } = this.sdk;
+        const url = this.sdk.getUrl(`/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;
+        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;
+    }
+}
 //# sourceMappingURL=StoreSdk.js.map