@api-client/core 0.5.2 → 0.5.5

package/build/src/models/store/File.d.ts

@@ -1,6 +1,22 @@
 import { IPermission } from './Permission.js';
+import { IModification } from './Modification.js';
+import { IDeletion } from './Deletion.js';
+import { IUser } from './User.js';
+import { IThing, Thing } from '../Thing.js';
 export declare const DefaultOwner = "default";
 export interface IStoredFile {
+    /**
+     * The kind of the File
+     */
+    kind: string;
+    /**
+     * The identifier of the entity
+     */
+    key: string;
+    /**
+     * The projects's meta info.
+     */
+    info: IThing;
     /**
      * The list of parents of the object. It is an ordered list of parents
      * from the top (first element) to the lowest parent in the tree (last element).
@@ -21,17 +37,22 @@ export interface IStoredFile {
      */
     deleted?: boolean;
     /**
-     * The timestamp of when the file was deleted.
-     */
-    deletedTime?: number;
-    /**
-     * The id of the user that has deleted the file.
+     * The information about the delete information.
+     * Always set when the `delete` is true.
      */
-    deletingUser?: string;
+    deletedInfo?: IDeletion;
     /**
      * The owner of this object. The id of the User object.
      */
     owner: string;
+    /**
+     * The last modification made to this file.
+     */
+    lastModified: IModification;
+    /**
+     * An arbitrary list of labels applied to the file.
+     */
+    labels?: string[];
 }
 /**
  * An interface describing an object in the data store that
@@ -50,6 +71,18 @@ export interface IFile extends IStoredFile {
     permissions: IPermission[];
 }
 export declare class StoredFile {
+    /**
+     * The kind of the File
+     */
+    kind: string;
+    /**
+     * The identifier of the entity
+     */
+    key: string;
+    /**
+     * The name of the environment.
+     */
+    info: Thing;
     /**
      * The list of parents of the object. It is an ordered list of parents
      * from the top (first element) to the lowest parent in the tree (last element).
@@ -70,20 +103,50 @@ export declare class StoredFile {
      */
     deleted?: boolean;
     /**
-     * The timestamp of when the file was deleted.
+     * The information about the delete information.
+     * Always set when the `delete` is true.
      */
-    deletedTime?: number;
-    /**
-     * The id of the user that has deleted the file.
-     */
-    deletingUser?: string;
+    deletedInfo?: IDeletion;
     /**
      * The owner of this space. The id of the User object.
      * Set to `default` when there are no users in the system (no authentication).
      */
     owner: string;
+    /**
+     * The last modification made to this file.
+     */
+    lastModified: IModification;
+    /**
+     * An arbitrary list of labels applied to the file.
+     */
+    labels?: string[];
     new(init: IStoredFile): void;
     toJSON(): IStoredFile;
+    /**
+     * Updates the "lastModified" value.
+     * A helper method for a common task.
+     *
+     * @param user The user that modifies the entity.
+     */
+    setLastModified(user: IUser): void;
+    /**
+     * Adds a label to the list of labels.
+     *
+     * It makes sure the value is a valid, non-empty string and the `labels` array is set.
+     *
+     * It does nothing when the label already exists.
+     *
+     * @param label The label to set.
+     */
+    addLabel(label: string): void;
+    /**
+     * Marks the entity as deleted.
+     *
+     * A helper method for a common task.
+     *
+     * @param user The user that deletes the entity.
+     */
+    setDeleted(user: IUser): void;
 }
 export declare class File extends StoredFile {
     /**

package/build/src/models/store/File.js

@@ -1,5 +1,20 @@
+import { Kind as UserKind } from './User.js';
+import { Thing } from '../Thing.js';
+import v4 from '../../lib/uuid.js';
 export const DefaultOwner = 'default';
 export class StoredFile {
+    /**
+     * The kind of the File
+     */
+    kind = '';
+    /**
+     * The identifier of the entity
+     */
+    key = '';
+    /**
+     * The name of the environment.
+     */
+    info = Thing.fromName('');
     /**
      * The list of parents of the object. It is an ordered list of parents
      * from the top (first element) to the lowest parent in the tree (last element).
@@ -20,52 +35,138 @@ export class StoredFile {
      */
     deleted;
     /**
-     * The timestamp of when the file was deleted.
+     * The information about the delete information.
+     * Always set when the `delete` is true.
      */
-    deletedTime;
-    /**
-     * The id of the user that has deleted the file.
-     */
-    deletingUser;
+    deletedInfo;
     /**
      * The owner of this space. The id of the User object.
      * Set to `default` when there are no users in the system (no authentication).
      */
-    owner = '';
+    owner = DefaultOwner;
+    /**
+     * The last modification made to this file.
+     */
+    lastModified = { user: '', time: 0, byMe: false };
+    /**
+     * An arbitrary list of labels applied to the file.
+     */
+    labels;
     new(init) {
-        const { parents = [], permissionIds = [], deleted, deletedTime, deletingUser, owner = DefaultOwner } = init;
+        const { key = v4(), info, kind, parents = [], permissionIds = [], deleted, deletedInfo, owner = DefaultOwner, lastModified, labels } = init;
+        this.key = key;
+        this.kind = kind;
+        if (info) {
+            this.info = new Thing(info);
+        }
+        else {
+            this.info = Thing.fromName('');
+        }
         this.parents = parents;
         this.permissionIds = permissionIds;
         this.owner = owner;
+        this.lastModified = lastModified ? { ...lastModified } : { user: '', time: 0, byMe: false };
         if (typeof deleted === 'boolean') {
             this.deleted = deleted;
-            this.deletedTime = deletedTime;
-            this.deletingUser = deletingUser;
+            this.deletedInfo = deletedInfo ? { ...deletedInfo } : undefined;
         }
         else {
             this.deleted = undefined;
-            this.deletedTime = undefined;
-            this.deletingUser = undefined;
+            this.deletedInfo = undefined;
+        }
+        if (Array.isArray(labels)) {
+            this.labels = labels;
+        }
+        else {
+            this.labels = undefined;
         }
     }
     toJSON() {
         const { owner = DefaultOwner } = this;
         const result = {
+            key: this.key,
+            kind: this.kind,
+            info: this.info.toJSON(),
             parents: this.parents,
             permissionIds: this.permissionIds,
+            lastModified: this.lastModified,
             owner,
         };
-        if (typeof this.deleted === 'boolean') {
+        if (this.deleted) {
             result.deleted = this.deleted;
-            if (this.deletedTime) {
-                result.deletedTime = this.deletedTime;
-            }
-            if (this.deletingUser) {
-                result.deletingUser = this.deletingUser;
-            }
+            result.deletedInfo = this.deletedInfo;
+        }
+        if (Array.isArray(this.labels)) {
+            result.labels = this.labels;
         }
         return result;
     }
+    /**
+     * Updates the "lastModified" value.
+     * A helper method for a common task.
+     *
+     * @param user The user that modifies the entity.
+     */
+    setLastModified(user) {
+        if (!user) {
+            throw new Error(`The user is required.`);
+        }
+        if (user.kind !== UserKind) {
+            throw new Error(`Invalid value for the user when setting "lastModified".`);
+        }
+        this.lastModified = {
+            byMe: false,
+            time: Date.now(),
+            user: user.key,
+            name: user.name,
+        };
+    }
+    /**
+     * Adds a label to the list of labels.
+     *
+     * It makes sure the value is a valid, non-empty string and the `labels` array is set.
+     *
+     * It does nothing when the label already exists.
+     *
+     * @param label The label to set.
+     */
+    addLabel(label) {
+        if (typeof label !== 'string') {
+            throw new Error(`The label must be a string.`);
+        }
+        if (!label.trim()) {
+            throw new Error(`The label is required.`);
+        }
+        if (!Array.isArray(this.labels)) {
+            this.labels = [];
+        }
+        if (this.labels.includes(label)) {
+            return;
+        }
+        this.labels.push(label);
+    }
+    /**
+     * Marks the entity as deleted.
+     *
+     * A helper method for a common task.
+     *
+     * @param user The user that deletes the entity.
+     */
+    setDeleted(user) {
+        if (!user) {
+            throw new Error(`The user is required.`);
+        }
+        if (user.kind !== UserKind) {
+            throw new Error(`Invalid value for the user when setting "lastModified".`);
+        }
+        this.deleted = true;
+        this.deletedInfo = {
+            byMe: false,
+            time: Date.now(),
+            user: user.key,
+            name: user.name,
+        };
+    }
 }
 export class File extends StoredFile {
     /**

package/build/src/models/store/File.js.map

@@ -1 +1 @@
-{"version":3,"file":"File.js","sourceRoot":"","sources":["../../../../src/models/store/File.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,YAAY,GAAG,SAAS,CAAC;AAqDtC,MAAM,OAAO,UAAU;IACrB;;;;;;OAMG;IACH,OAAO,GAAa,EAAE,CAAC;IACvB;;;;;OAKG;IACH,aAAa,GAAa,EAAE,CAAC;IAC7B;;OAEG;IACH,OAAO,CAAW;IAClB;;OAEG;IACH,WAAW,CAAU;IACrB;;OAEG;IACH,YAAY,CAAU;IACtB;;;OAGG;IACH,KAAK,GAAG,EAAE,CAAC;IAEX,GAAG,CAAC,IAAiB;QACnB,MAAM,EAAE,OAAO,GAAC,EAAE,EAAE,aAAa,GAAC,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,KAAK,GAAG,YAAY,EAAE,GAAG,IAAI,CAAC;QACxG,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,OAAO,OAAO,KAAK,SAAS,EAAE;YAChC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;YAC/B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;SAClC;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;YACzB,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;YAC7B,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;SAC/B;IACH,CAAC;IAED,MAAM;QACJ,MAAM,EAAE,KAAK,GAAG,YAAY,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,MAAM,GAAgB;YAC1B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK;SACN,CAAC;QACF,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE;YACrC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YAE9B,IAAI,IAAI,CAAC,WAAW,EAAE;gBACpB,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;aACvC;YACD,IAAI,IAAI,CAAC,YAAY,EAAE;gBACrB,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;aACzC;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED,MAAM,OAAO,IAAK,SAAQ,UAAU;IAClC;;;;;OAKG;IACH,WAAW,GAAkB,EAAE,CAAC;IAEhC,GAAG,CAAC,IAAW;QACb,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChB,MAAM,EAAE,WAAW,GAAC,EAAE,EAAE,GAAG,IAAI,CAAC;QAChC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAU;YACpB,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}
+{"version":3,"file":"File.js","sourceRoot":"","sources":["../../../../src/models/store/File.ts"],"names":[],"mappings":"AAGA,OAAO,EAAS,IAAI,IAAI,QAAQ,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAU,KAAK,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEnC,MAAM,CAAC,MAAM,YAAY,GAAG,SAAS,CAAC;AAsEtC,MAAM,OAAO,UAAU;IACrB;;OAEG;IACH,IAAI,GAAG,EAAE,CAAC;IACV;;OAEG;IACH,GAAG,GAAG,EAAE,CAAC;IACT;;OAEG;IACH,IAAI,GAAU,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACjC;;;;;;OAMG;IACH,OAAO,GAAa,EAAE,CAAC;IACvB;;;;;OAKG;IACH,aAAa,GAAa,EAAE,CAAC;IAC7B;;OAEG;IACH,OAAO,CAAW;IAClB;;;OAGG;IACH,WAAW,CAAa;IACxB;;;OAGG;IACH,KAAK,GAAG,YAAY,CAAC;IACrB;;OAEG;IACH,YAAY,GAAkB,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IACjE;;OAEG;IACH,MAAM,CAAY;IAElB,GAAG,CAAC,IAAiB;QACnB,MAAM,EAAE,GAAG,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,GAAC,EAAE,EAAE,aAAa,GAAC,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,GAAG,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACxI,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;SAC7B;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;SAChC;QACD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAC5F,IAAI,OAAO,OAAO,KAAK,SAAS,EAAE;YAChC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SACjE;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;YACzB,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;SAC9B;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACtB;aAAM;YACL,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;SACzB;IACH,CAAC;IAED,MAAM;QACJ,MAAM,EAAE,KAAK,GAAG,YAAY,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,MAAM,GAAgB;YAC1B,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACxB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,KAAK;SACN,CAAC;QACF,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YAC9B,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;SACvC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YAC9B,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;SAC7B;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,IAAW;QACzB,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;SAC1C;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;SAC5E;QACD,IAAI,CAAC,YAAY,GAAG;YAClB,IAAI,EAAE,KAAK;YACX,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;YAChB,IAAI,EAAE,IAAI,CAAC,GAAG;YACd,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,KAAa;QACpB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;SAChD;QACD,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;SAC3C;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YAC/B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;SAClB;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YAC/B,OAAO;SACR;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,IAAW;QACpB,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;SAC1C;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;SAC5E;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,WAAW,GAAG;YACjB,IAAI,EAAE,KAAK;YACX,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;YAChB,IAAI,EAAE,IAAI,CAAC,GAAG;YACd,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,IAAK,SAAQ,UAAU;IAClC;;;;;OAKG;IACH,WAAW,GAAkB,EAAE,CAAC;IAEhC,GAAG,CAAC,IAAW;QACb,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChB,MAAM,EAAE,WAAW,GAAC,EAAE,EAAE,GAAG,IAAI,CAAC;QAChC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAU;YACpB,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/build/src/models/store/Modification.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Information about a modification of a File.
+ */
+export interface IModification {
+    /**
+     * The key of the user modifying the record.
+     */
+    user: string;
+    /**
+     * User name modifying the record. May not be set when there's no actual user.
+     */
+    name?: string;
+    /**
+     * Whether the modification was performed by the requesting the data user.
+     *
+     * Note for store implementers, this field should not be stored and populated every time the
+     * record is requested.
+     */
+    byMe: boolean;
+    /**
+     * A timestamp when the object was modified.
+     */
+    time: number;
+}

package/build/src/models/store/Modification.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Modification.js.map

package/build/src/models/store/Modification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Modification.js","sourceRoot":"","sources":["../../../../src/models/store/Modification.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,50 @@
+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 declare class ApiError {
+    get name(): string;
+    code: number;
+    message: string;
+    detail?: string;
+    constructor(message: string, code: number);
+    constructor(init: IApiError);
+    toJSON(): IApiError;
+    toString(): string;
+}
+export interface ISdkError extends ISerializedError {
+    /**
+     * The raw response from the server.
+     */
+    response?: string;
+    /**
+     * Optional detailed message returned by the server.
+     */
+    detail?: string;
+}
+export declare class SdkError extends SerializableError {
+    /**
+     * The raw response from the server.
+     */
+    response?: string;
+    /**
+     * Optional detailed message returned by the server.
+     */
+    detail?: string;
+    toJSON(): ISdkError;
+}

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

@@ -0,0 +1,63 @@
+import { SerializableError } from '../../models/SerializableError.js';
+export class ApiError {
+    get name() {
+        return 'ApiError';
+    }
+    code;
+    message;
+    detail;
+    constructor(messageOrInit, code) {
+        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() {
+        const { message, code, detail } = this;
+        const result = {
+            error: true,
+            message,
+            code,
+        };
+        if (detail) {
+            result.detail = detail;
+        }
+        return result;
+    }
+    toString() {
+        return this.message;
+    }
+}
+export class SdkError extends SerializableError {
+    /**
+     * The raw response from the server.
+     */
+    response;
+    /**
+     * Optional detailed message returned by the server.
+     */
+    detail;
+    toJSON() {
+        const result = super.toJSON();
+        if (this.response) {
+            result.response = this.response;
+        }
+        if (this.detail) {
+            result.detail = this.detail;
+        }
+        return result;
+    }
+}
+//# sourceMappingURL=Errors.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Errors.js","sourceRoot":"","sources":["../../../../src/runtime/store/Errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAoB,MAAM,mCAAmC,CAAC;AAqBxF,MAAM,OAAO,QAAQ;IACnB,IAAI,IAAI;QACN,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,IAAI,CAAS;IACb,OAAO,CAAS;IAChB,MAAM,CAAU;IAKhB,YAAY,aAAiC,EAAE,IAAa;QAC1D,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;YACrC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;gBAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;aAClB;iBAAM;gBACL,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;aACf;YACD,IAAI,CAAC,OAAO,GAAG,aAAa,CAAC;SAC9B;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;YACrC,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC;YAC/B,IAAI,aAAa,CAAC,MAAM,EAAE;gBACxB,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC;aACpC;SACF;IACH,CAAC;IAED,MAAM;QACJ,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACvC,MAAM,MAAM,GAAc;YACxB,KAAK,EAAE,IAAI;YACX,OAAO;YACP,IAAI;SACL,CAAC;QACF,IAAI,MAAM,EAAE;YACV,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;SACxB;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AAaD,MAAM,OAAO,QAAS,SAAQ,iBAAiB;IAC7C;;OAEG;IACH,QAAQ,CAAU;IAClB;;OAEG;IACH,MAAM,CAAU;IAEhB,MAAM;QACJ,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAC9B,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;SACjC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;SAC7B;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

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

@@ -0,0 +1,94 @@
+import WebSocketNode from 'ws';
+import { JsonPatch } from 'json8-patch';
+import { SdkBase, ISdkRequestOptions } from './SdkBase.js';
+import { IListOptions, IListResponse } from '../../models/Backend.js';
+import { AccessOperation } from '../../models/store/Permission.js';
+import { IUser } from '../../models/store/User.js';
+import { IFile } from '../../models/store/File.js';
+import { Kind as ProjectKind } from '../../models/Project.js';
+import { Kind as WorkspaceKind } from '../../models/Workspace.js';
+import { IHttpProject } from '../../models/HttpProject.js';
+export interface IFileCreateOptions {
+    /**
+     * Optional parent file id.
+     * When set it creates a file under this parent.
+     */
+    parent?: string;
+}
+export declare class FilesSdk extends SdkBase {
+    /**
+     * Lists files (spaces, projects, etc) in the store.
+     *
+     * @param kinds the list of kinds to list. Spaces are always included.
+     * @param options Optional query options.
+     * @param request Optional request options.
+     */
+    list(kinds: (typeof ProjectKind | typeof WorkspaceKind)[], options?: IListOptions, request?: ISdkRequestOptions): Promise<IListResponse<IFile>>;
+    /**
+     * Creates a file in the store.
+     *
+     * @param file The definition of a file that extends the IFile interface or one of the supported by the server schemas.
+     * @param request Optional request options.
+     * @returns The key of the creates file.
+     */
+    create(file: IFile | IHttpProject, opts?: IFileCreateOptions, request?: ISdkRequestOptions): Promise<string>;
+    /**
+     * Reads file metadata from the store.
+     *
+     * @param key The file key
+     * @param request Optional request options.
+     * @returns THe file metadata
+     */
+    read(key: string, media: false, request?: ISdkRequestOptions): Promise<IFile>;
+    /**
+     * Reads file contents from the store.
+     *
+     * @param key The file key
+     * @param request Optional request options.
+     * @returns THe file contents
+     */
+    read(key: string, media: true, request?: ISdkRequestOptions): Promise<unknown>;
+    /**
+     * Patches file's meta in the store.
+     *
+     * @param key The file key
+     * @param value The patch to apply.
+     * @param request Optional request options.
+     */
+    patch(key: string, value: JsonPatch, media: false, request?: ISdkRequestOptions): Promise<JsonPatch>;
+    /**
+     * Patches file's content in the store.
+     *
+     * @param key The file key
+     * @param value The patch to apply.
+     * @param request Optional request options.
+     */
+    patch(key: string, value: JsonPatch, media: true, request?: ISdkRequestOptions): Promise<JsonPatch>;
+    /**
+     * Deletes the file in the store.
+     *
+     * @param key The key of the file to delete.
+     * @param request Optional request options.
+     */
+    delete(key: string, request?: ISdkRequestOptions): Promise<void>;
+    /**
+     * Updates the sharing options of the file.
+     *
+     * @param key The file key
+     * @param value The patch operation on the file's ACL
+     * @param request Optional request options.
+     */
+    patchUsers(key: string, value: AccessOperation[], request?: ISdkRequestOptions): Promise<void>;
+    /**
+     * Lists uses having access to the file.
+     *
+     * @param key The file key
+     * @param request Optional request options.
+     */
+    listUsers(key: string, request?: ISdkRequestOptions): Promise<IListResponse<IUser>>;
+    /**
+     * Creates a WS client that listens to the files events.
+     * @param request Optional request options.
+     */
+    observeFiles(request?: ISdkRequestOptions): Promise<WebSocketNode | WebSocket>;
+}