@api-client/core 0.5.3 → 0.5.6

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

@@ -1,15 +1,18 @@
 /// <reference types="node" />
 import { Headers } from '../../lib/headers/Headers.js';
 import { Sdk } from './Sdk.js';
-export interface IStoreRequestOptions {
-    method?: 'GET' | 'POST' | 'PATCH' | 'DELETE';
-    headers?: Record<string, string>;
-    body?: string | Buffer;
+import { SdkError, IApiError } from './Errors.js';
+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;
@@ -41,5 +44,12 @@ export declare 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;
+    /**
+     * 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;
+    protected createGenericSdkError(body?: string): SdkError | undefined;
 }

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

@@ -1,3 +1,4 @@
+import { SdkError } from './Errors.js';
 export const E_INVALID_JSON = 'The response is not a valid JSON.';
 export const E_RESPONSE_NO_VALUE = 'The response has no value.';
 export const E_RESPONSE_STATUS = 'Invalid response status: ';
@@ -9,6 +10,9 @@ export class SdkBase {
         this.sdk = sdk;
     }
     logInvalidResponse(response) {
+        if (this.sdk.silent) {
+            return;
+        }
         if (response.body) {
             try {
                 const data = JSON.parse(response.body);
@@ -25,16 +29,62 @@ export class SdkBase {
      * Throws unified message for a common error status codes.
      * It handles 404, 403, and 401 status codes.
      */
-    inspectCommonStatusCodes(status) {
+    inspectCommonStatusCodes(status, body) {
         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;
+     */
+    readErrorResponse(body) {
+        if (!body) {
+            return undefined;
+        }
+        let data;
+        try {
+            data = JSON.parse(body);
+        }
+        catch (e) {
+            return undefined;
+        }
+        if (data.error && data.message) {
+            return data;
+        }
+        return undefined;
+    }
+    createGenericSdkError(body) {
+        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;
     }
 }
 //# sourceMappingURL=SdkBase.js.map

package/build/src/runtime/store/SdkBase.js.map

@@ -1 +1 @@
-{"version":3,"file":"SdkBase.js","sourceRoot":"","sources":["../../../../src/runtime/store/SdkBase.ts"],"names":[],"mappings":"AAiCA,MAAM,CAAC,MAAM,cAAc,GAAG,mCAAmC,CAAC;AAClE,MAAM,CAAC,MAAM,mBAAmB,GAAG,4BAA4B,CAAC;AAChE,MAAM,CAAC,MAAM,iBAAiB,GAAG,2BAA2B,CAAC;AAC7D,MAAM,CAAC,MAAM,kBAAkB,GAAG,kCAAkC,CAAC;AACrE,MAAM,CAAC,MAAM,mBAAmB,GAAG,wCAAwC,CAAC;AAG5E,MAAM,OAAO,OAAO;IACC;IAAnB,YAAmB,GAAQ;QAAR,QAAG,GAAH,GAAG,CAAK;IAAG,CAAC;IAErB,kBAAkB,CAAC,QAAwB;QACnD,IAAI,QAAQ,CAAC,IAAI,EAAE;YACjB,IAAI;gBACF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACvC,IAAI,IAAI,CAAC,OAAO,EAAE;oBAChB,OAAO,CAAC,IAAI,CAAC,oBAAoB,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;iBAClD;aACF;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI;aACL;SACF;IACH,CAAC;IAED;;;OAGG;IACO,wBAAwB,CAAC,MAAc;QAC/C,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;SAC/B;QACD,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;SACzD;QACD,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;SACpC;IACH,CAAC;CACF"}
+{"version":3,"file":"SdkBase.js","sourceRoot":"","sources":["../../../../src/runtime/store/SdkBase.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAa,MAAM,aAAa,CAAC;AAmClD,MAAM,CAAC,MAAM,cAAc,GAAG,mCAAmC,CAAC;AAClE,MAAM,CAAC,MAAM,mBAAmB,GAAG,4BAA4B,CAAC;AAChE,MAAM,CAAC,MAAM,iBAAiB,GAAG,2BAA2B,CAAC;AAC7D,MAAM,CAAC,MAAM,kBAAkB,GAAG,kCAAkC,CAAC;AACrE,MAAM,CAAC,MAAM,mBAAmB,GAAG,wCAAwC,CAAC;AAG5E,MAAM,OAAO,OAAO;IACC;IAAnB,YAAmB,GAAQ;QAAR,QAAG,GAAH,GAAG,CAAK;IAAG,CAAC;IAErB,kBAAkB,CAAC,QAAwB;QACnD,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE;YACnB,OAAO;SACR;QACD,IAAI,QAAQ,CAAC,IAAI,EAAE;YACjB,IAAI;gBACF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACvC,IAAI,IAAI,CAAC,OAAO,EAAE;oBAChB,OAAO,CAAC,IAAI,CAAC,oBAAoB,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;iBAClD;aACF;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI;aACL;SACF;IACH,CAAC;IAED;;;OAGG;IACO,wBAAwB,CAAC,MAAc,EAAE,IAAa;QAC9D,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAA;YACxC,IAAI,CAAC,CAAC,EAAE;gBACN,CAAC,GAAG,IAAI,QAAQ,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;gBACpC,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC;aACnB;YACD,MAAM,CAAC,CAAC;SACT;QACD,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAA;YACxC,IAAI,CAAC,CAAC,EAAE;gBACN,CAAC,GAAG,IAAI,QAAQ,CAAC,sCAAsC,EAAE,GAAG,CAAC,CAAC;gBAC9D,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC;aACnB;YACD,MAAM,CAAC,CAAC;SACT;QACD,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAA;YACxC,IAAI,CAAC,CAAC,EAAE;gBACN,CAAC,GAAG,IAAI,QAAQ,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;gBACzC,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC;aACnB;YACD,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAED;;;;OAIG;IACO,iBAAiB,CAAC,IAAa;QACvC,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,IAAS,CAAC;QACd,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SACzB;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE;YAC9B,OAAO,IAAiB,CAAC;SAC1B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAES,qBAAqB,CAAC,IAAa;QAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,CAAC,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACvB,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC;QAClB,OAAO,CAAC,CAAC;IACX,CAAC;CACF"}

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

@@ -1,9 +1,15 @@
-import { SdkBase } from './SdkBase.js';
+import { SdkBase, ISdkRequestOptions } from './SdkBase.js';
 import { IListOptions, IListResponse } from '../../models/Backend.js';
+import { Kind as ProjectKind } from '../../models/Project.js';
+import { Kind as WorkspaceKind } from '../../models/Workspace.js';
+import { IFile } from '../../models/store/File.js';
 export declare class SharedSdk extends SdkBase {
     /**
      * Lists shared with the user spaces.
+     *
+     * @param kinds the list of kinds to list. Spaces are always included.
      * @param options Optional query options.
+     * @param request Optional request options.
      */
-    list(options?: IListOptions): Promise<IListResponse>;
+    list(kinds: (typeof ProjectKind | typeof WorkspaceKind)[], options?: IListOptions, request?: ISdkRequestOptions): Promise<IListResponse<IFile>>;
 }

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

@@ -1,33 +1,47 @@
 import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
+import { SdkError } from './Errors.js';
 export class SharedSdk extends SdkBase {
     /**
      * Lists shared with the user spaces.
+     *
+     * @param kinds the list of kinds to list. Spaces are always included.
      * @param options Optional query options.
+     * @param request Optional request options.
      */
-    async list(options) {
-        const { token } = this.sdk;
-        const url = this.sdk.getUrl(RouteBuilder.sharedSpaces());
+    async list(kinds, options, request = {}) {
+        const token = request.token || this.sdk.token;
+        const url = this.sdk.getUrl(RouteBuilder.shared());
         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);
+        this.inspectCommonStatusCodes(result.status, result.body);
         const E_PREFIX = 'Unable to list spaces. ';
         if (result.status !== 200) {
             this.logInvalidResponse(result);
-            throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
+            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}`);
+            throw new SdkError(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, 0);
         }
         let data;
         try {
             data = JSON.parse(result.body);
         }
         catch (e) {
-            throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
+            const err = new SdkError(`${E_PREFIX}${E_INVALID_JSON}.`, 0);
+            err.response = result.body;
+            throw err;
         }
         if (!Array.isArray(data.data)) {
-            throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
+            const err = new SdkError(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`, 0);
+            err.response = result.body;
+            throw err;
         }
         return data;
     }

package/build/src/runtime/store/SharedSdk.js.map

@@ -1 +1 @@
-{"version":3,"file":"SharedSdk.js","sourceRoot":"","sources":["../../../../src/runtime/store/SharedSdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACnH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGjD,MAAM,OAAO,SAAU,SAAQ,OAAO;IACpC;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAC,OAAsB;QAC/B,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACzC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,yBAAyB,CAAC;QAC3C,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;SACpE;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,CAAC,CAAC;SACtD;QACD,IAAI,IAAmB,CAAC;QACxB,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,cAAc,GAAG,CAAC,CAAC;SAClD;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,kBAAkB,GAAG,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
+{"version":3,"file":"SharedSdk.js","sourceRoot":"","sources":["../../../../src/runtime/store/SharedSdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,cAAc,EAAE,kBAAkB,EAAsB,MAAM,cAAc,CAAC;AACvI,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAKjD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,MAAM,OAAO,SAAU,SAAQ,OAAO;IACpC;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CAAC,KAAoD,EAAE,OAAsB,EAAE,UAA8B,EAAE;QACvH,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACzC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;QACvD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,yBAAyB,CAAC;QAC3C,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC/C,IAAI,CAAC,CAAC,EAAE;gBACN,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBACnF,CAAC,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;aAC1B;YACD,MAAM,CAAC,CAAC;SACT;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YAChB,MAAM,IAAI,QAAQ,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,EAAE,CAAC,CAAC,CAAC;SAC5D;QACD,IAAI,IAA0B,CAAC;QAC/B,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,GAAG,QAAQ,GAAG,cAAc,GAAG,EAAE,CAAC,CAAC,CAAC;YAC7D,GAAG,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;YAC3B,MAAM,GAAG,CAAC;SACX;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC7B,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,GAAG,QAAQ,GAAG,kBAAkB,GAAG,EAAE,CAAC,CAAC,CAAC;YACjE,GAAG,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;YAC3B,MAAM,GAAG,CAAC;SACX;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

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

@@ -2,7 +2,7 @@ import { Sdk } from './Sdk.js';
 import { Http } from './Http.js';
 import { WsClient } from './WsClient.js';
 export { IStoreTokenInfo, IStoreResponse, IStoreRequestOptions } from './SdkBase.js';
-export { ISpaceCreateOptions } from './SpacesSdk.js';
+export { IFileCreateOptions as ISpaceCreateOptions } from './FilesSdk.js';
 /**
  * NodeJS API for API Client's net-store module.
  */

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

@@ -2,7 +2,7 @@ import { Sdk } from './Sdk.js';
 import { Http } from './Http.js';
 import { WsClient } from './WsClient.js';
 export { IStoreTokenInfo, IStoreResponse, IStoreRequestOptions } from './SdkBase.js';
-export { ISpaceCreateOptions } from './SpacesSdk.js';
+export { IFileCreateOptions as ISpaceCreateOptions } from './FilesSdk.js';
 /**
  * NodeJS API for API Client's net-store module.
  */

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

@@ -1,18 +1,24 @@
-import { SdkBase } from './SdkBase.js';
+import { SdkBase, ISdkRequestOptions } from './SdkBase.js';
 import { IListOptions, IListResponse } from '../../models/Backend.js';
 import { IUser } from '../../models/store/User.js';
 export declare class UsersSdk extends SdkBase {
-    me(): Promise<IUser>;
+    /**
+     * Reads the current user.
+     * @param request Optional request options.
+     */
+    me(request?: ISdkRequestOptions): Promise<IUser>;
     /**
      * Lists users in the store
      *
      * @param options Optional query options.
+     * @param request Optional request options.
      */
-    list(options?: IListOptions): Promise<IListResponse>;
+    list(options?: IListOptions, request?: ISdkRequestOptions): Promise<IListResponse<IUser>>;
     /**
      * Reads a user information from the store.
      * @param key The user key.
+     * @param request Optional request options.
      * @returns The user object
      */
-    read(key: string): Promise<IUser>;
+    read(key: string, request?: ISdkRequestOptions): Promise<IUser>;
 }

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

@@ -1,8 +1,12 @@
 import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
 export class UsersSdk extends SdkBase {
-    async me() {
-        const { token } = this.sdk;
+    /**
+     * Reads the current user.
+     * @param request Optional request options.
+     */
+    async me(request = {}) {
+        const token = request.token || this.sdk.token;
         const url = this.sdk.getUrl(RouteBuilder.usersMe());
         const result = await this.sdk.http.get(url.toString(), { token });
         this.inspectCommonStatusCodes(result.status);
@@ -30,9 +34,10 @@ export class UsersSdk extends SdkBase {
      * Lists users in the store
      *
      * @param options Optional query options.
+     * @param request Optional request options.
      */
-    async list(options) {
-        const { token } = this.sdk;
+    async list(options, request = {}) {
+        const token = request.token || this.sdk.token;
         const url = this.sdk.getUrl(RouteBuilder.users());
         this.sdk.appendListOptions(url, options);
         const result = await this.sdk.http.get(url.toString(), { token });
@@ -60,10 +65,11 @@ export class UsersSdk extends SdkBase {
     /**
      * Reads a user information from the store.
      * @param key The user key.
+     * @param request Optional request options.
      * @returns The user object
      */
-    async read(key) {
-        const { token } = this.sdk;
+    async read(key, request = {}) {
+        const token = request.token || this.sdk.token;
         const url = this.sdk.getUrl(RouteBuilder.user(key));
         const result = await this.sdk.http.get(url.toString(), { token });
         this.inspectCommonStatusCodes(result.status);

package/build/src/runtime/store/UsersSdk.js.map

@@ -1 +1 @@
-{"version":3,"file":"UsersSdk.js","sourceRoot":"","sources":["../../../../src/runtime/store/UsersSdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACnH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAIjD,MAAM,OAAO,QAAS,SAAQ,OAAO;IACnC,KAAK,CAAC,EAAE;QACN,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,yBAAyB,CAAC;QAC3C,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;SACpE;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,CAAC,CAAC;SACtD;QACD,IAAI,IAAW,CAAC;QAChB,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,cAAc,GAAG,CAAC,CAAC;SAClD;QACD,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,kBAAkB,GAAG,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,OAAsB;QAC/B,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC,CAAC;QAClD,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACzC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,2BAA2B,CAAC;QAC7C,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;SACpE;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,CAAC,CAAC;SACtD;QACD,IAAI,IAAmB,CAAC;QACxB,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,cAAc,GAAG,CAAC,CAAC;SAClD;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,kBAAkB,GAAG,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,GAAW;QACpB,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,gCAAgC,CAAC;QAClD,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;SACpE;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,CAAC,CAAC;SACtD;QACD,IAAI,IAAW,CAAC;QAChB,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,cAAc,GAAG,CAAC,CAAC;SAClD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
+{"version":3,"file":"UsersSdk.js","sourceRoot":"","sources":["../../../../src/runtime/store/UsersSdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,cAAc,EAAE,kBAAkB,EAAsB,MAAM,cAAc,CAAC;AACvI,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAIjD,MAAM,OAAO,QAAS,SAAQ,OAAO;IACnC;;;OAGG;IACH,KAAK,CAAC,EAAE,CAAC,UAA8B,EAAE;QACvC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,yBAAyB,CAAC;QAC3C,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;SACpE;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,CAAC,CAAC;SACtD;QACD,IAAI,IAAW,CAAC;QAChB,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,cAAc,GAAG,CAAC,CAAC;SAClD;QACD,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,kBAAkB,GAAG,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,OAAsB,EAAE,UAA8B,EAAE;QACjE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC,CAAC;QAClD,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACzC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,2BAA2B,CAAC;QAC7C,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;SACpE;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,CAAC,CAAC;SACtD;QACD,IAAI,IAA0B,CAAC;QAC/B,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,cAAc,GAAG,CAAC,CAAC;SAClD;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,kBAAkB,GAAG,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,GAAW,EAAE,UAA8B,EAAE;QACtD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,gCAAgC,CAAC;QAClD,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;SACpE;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,CAAC,CAAC;SACtD;QACD,IAAI,IAAW,CAAC;QAChB,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,cAAc,GAAG,CAAC,CAAC;SAClD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.5.3",
+  "version": "0.5.6",
   "license": "Apache-2.0",
   "main": "build/index.js",
   "module": "build/index.js",
@@ -31,13 +31,12 @@
     "@types/cors": "^2.8.12",
     "@types/express-ntlm": "^2.3.3",
     "@types/fs-extra": "^9.0.13",
-    "@types/json8-patch": "^1.0.0",
     "@types/mocha": "^9.0.0",
     "@types/node": "^17.0.18",
     "@types/sinon": "^10.0.11",
     "@typescript-eslint/eslint-plugin": "^5.12.0",
     "@typescript-eslint/parser": "^5.12.0",
-    "@web/dev-server-esbuild": "^0.2.16",
+    "@web/dev-server-esbuild": "^0.3.0",
     "@web/test-runner": "^0.13.21",
     "@web/test-runner-playwright": "^0.8.8",
     "chai": "^4.3.4",
@@ -83,13 +82,13 @@
     ]
   },
   "dependencies": {
+    "@api-client/json": "^0.1.0",
     "@metrichor/jmespath": "^0.3.1",
     "@pawel-up/data-mock": "^0.2.0",
     "@pawel-up/jexl": "^3.0.0",
     "@xmldom/xmldom": "^0.8.1",
     "console-table-printer": "^2.10.0",
     "form-data": "^4.0.0",
-    "json8-patch": "^1.0.6",
     "ws": "^8.5.0",
     "xpath": "^0.0.32"
   },

package/src/models/Backend.ts

@@ -61,7 +61,7 @@ export interface IBackendEvent extends IBackendMessage {
    * Note, `updated` is when the entire object must be revalidated in the opposite
    * to `patch` where the patch should be applied to the object.
    */
-  operation: 'created' | 'updated' | 'patch' | 'deleted' | 'access-granted' | 'access-removed';
+  operation: 'created' | 'patch' | 'deleted' | 'access-granted' | 'access-removed';
   /**
    * The kind of data that has been changed.
    */
@@ -70,6 +70,10 @@ export interface IBackendEvent extends IBackendMessage {
    * For update events it is the key of the updated object.
    */
   id?: string;
+  /**
+   * When relevant, the parent of the changed object.
+   */
+  parent?: string;
 }
 
 export interface IListResponse<T = unknown> {
@@ -151,11 +155,6 @@ export interface IHistorySpaceListOptions extends IListOptions {
  */
 export interface IHistoryProjectListOptions extends IListOptions {
   type: 'project';
-  /**
-   * The id of the space containing the project.
-   * The access to the history records for the project is tested against the user space.
-   */
-  space: string;
   /**
    * The id of the project.
    */
@@ -173,10 +172,9 @@ export interface IHistoryProjectListOptions extends IListOptions {
 export interface IHistoryRequestListOptions extends IListOptions {
   type: 'request';
   /**
-   * The id of the space containing the project that contains the request.
-   * The access to the history records for the request is tested against the user space.
+   * The id of the project that contains the request.
    */
-  space: string;
+  project: string;
   /**
    * The id of the request.
    */

package/src/models/HttpHistory.ts

@@ -14,11 +14,11 @@ export interface IHttpHistory {
    */
   key?: string;
   /**
-   * Optional user space id. Must be set when the originating request belongs to a user space.
+   * Optional user space id. When set the history will become available to all space users.
    */
   space?: string;
   /**
-   * Optional project id. Must be set when the originating request belongs to a user space.
+   * Optional project id. When set the history will become available to all project users.
    */
   project?: string;
   /**

package/src/models/Project.ts

@@ -82,7 +82,7 @@ export class Project extends File {
    * Note, this throws an error when the environment is not a space. 
    */
   new(init: IProject): void {
-    if (!Project.isWorkspace(init)) {
+    if (!Project.isProject(init)) {
       throw new Error(`Not a space.`);
     }
     super.new(init);
@@ -92,7 +92,7 @@ export class Project extends File {
   /**
    * Checks whether the input is a definition of an user space.
    */
-  static isWorkspace(input: unknown): boolean {
+  static isProject(input: unknown): boolean {
     const typed = input as IProject;
     if (!input || typed.kind !== Kind) {
       return false;

package/src/models/RevisionInfo.ts

@@ -4,7 +4,7 @@ export const Kind = 'Core#Revision';
 
 /**
  * The definition of a patch revision.
- * The revision is created with the `json8-patch` library.
+ * The revision is created with the `@api-client/json` library.
  */
 export interface IRevisionInfo {
   /**
@@ -33,7 +33,7 @@ export interface IRevisionInfo {
    */
   deleted?: boolean;
   /**
-   * The `json8-patch` revisions object used to restore the previous state.
+   * The `@api-client/json` revisions object used to restore the previous state.
    */
   patch: any[];
   /**

package/src/models/SerializableError.ts

@@ -6,6 +6,7 @@ export interface ISerializedError {
   message: string;
   stack?: string;
   code?: string | number;
+  [key: PropertyKey]: any;
 }
 
 /**

package/src/models/store/File.ts

@@ -138,10 +138,10 @@ export class StoredFile {
     this.parents = parents;
     this.permissionIds = permissionIds;
     this.owner = owner;
-    this.lastModified = lastModified || { user: '', time: 0, byMe: false };
+    this.lastModified = lastModified ? { ...lastModified } : { user: '', time: 0, byMe: false };
     if (typeof deleted === 'boolean') {
       this.deleted = deleted;
-      this.deletedInfo = deletedInfo;
+      this.deletedInfo = deletedInfo ? { ...deletedInfo } : undefined;
     } else {
       this.deleted = undefined;
       this.deletedInfo = undefined;

package/src/runtime/store/Errors.ts

@@ -0,0 +1,100 @@
+import { SerializableError, ISerializedError } from '../../models/SerializableError.js';
+
+export interface IApiError {
+  /**
+   * Indicates the response is an error.
+   */
+  error: boolean;
+  /**
+   * The same as the status code but returned with the body.
+   */
+  code: number;
+  /**
+   * The human-readable error message
+   */
+  message: string;
+  /**
+   * The detailed message about the error, if any.
+   */
+  detail?: string;
+}
+
+export class ApiError {
+  get name(): string {
+    return 'ApiError';
+  }
+
+  code: number;
+  message: string;
+  detail?: string;
+
+  constructor(message: string, code: number);
+  constructor(init: IApiError);
+
+  constructor(messageOrInit: string | IApiError, code?: number) {
+    if (typeof messageOrInit === 'string') {
+      if (typeof code === 'number') {
+        this.code = code;
+      } else {
+        this.code = 0;
+      }
+      this.message = messageOrInit;
+    } else {
+      this.message = messageOrInit.message;
+      this.code = messageOrInit.code;
+      if (messageOrInit.detail) {
+        this.detail = messageOrInit.detail;
+      }
+    }
+  }
+
+  toJSON(): IApiError {
+    const { message, code, detail } = this;
+    const result: IApiError = {
+      error: true,
+      message,
+      code,
+    };
+    if (detail) {
+      result.detail = detail;
+    }
+    return result;
+  }
+
+  toString(): string {
+    return this.message;
+  }
+}
+
+export interface ISdkError extends ISerializedError {
+  /**
+   * The raw response from the server.
+   */
+  response?: string;
+  /**
+   * Optional detailed message returned by the server.
+   */
+  detail?: string;
+}
+
+export class SdkError extends SerializableError {
+  /**
+   * The raw response from the server.
+   */
+  response?: string;
+  /**
+   * Optional detailed message returned by the server.
+   */
+  detail?: string;
+
+  toJSON(): ISdkError {
+    const result = super.toJSON();
+    if (this.response) {
+      result.response = this.response;
+    }
+    if (this.detail) {
+      result.detail = this.detail;
+    }
+    return result;
+  }
+}