@api-client/core 0.9.24 → 0.10.0

package/build/cjs/src/models/SerializablePayload.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SerializablePayload = void 0;
+const PayloadSerializer_js_1 = require("../lib/transformers/PayloadSerializer.js");
+const Platform_js_1 = require("../Platform.js");
+class SerializablePayload {
+    payload;
+    payloadOptions;
+    /**
+     * The payload in its original format.
+     * May not be populated when the `getPayload()` was not yet read.
+     */
+    _sourcePayload;
+    /**
+     * Sets the payload on the request.
+     * This transforms the source `message` to its serialized form using the `PayloadSerializer`.
+     *
+     * @param message The payload value
+     * @param mime The payload mime type. This is optional and sets the `payloadOptions.mime` value when set.
+     */
+    async writePayload(message, mime) {
+        this._sourcePayload = message;
+        this.payload = await PayloadSerializer_js_1.PayloadSerializer.serialize(message);
+        if (mime) {
+            if (!this.payloadOptions) {
+                this.payloadOptions = {};
+            }
+            this.payloadOptions.mime = mime;
+        }
+    }
+    /**
+     * Reads the payload as its original format.
+     * It uses the `PayloadSerializer` to process the data.
+     */
+    async readPayload() {
+        if (!this._sourcePayload) {
+            this._sourcePayload = await PayloadSerializer_js_1.PayloadSerializer.deserialize(this.payload);
+        }
+        return this._sourcePayload;
+    }
+    /**
+     * Reads the payload as string, when it is possible.
+     * This method assumes that the payload is a string regardless on the format of the data
+     * (Buffer, ArrayBuffer, ...) and returns a string representation of the payload.
+     *
+     * @returns The string value of the payload of undefined if unable to process.
+     */
+    async readPayloadAsString() {
+        const { payload } = this;
+        if (!payload) {
+            return undefined;
+        }
+        if (typeof payload === 'string') {
+            return payload;
+        }
+        if (payload.type === 'string') {
+            return payload.data;
+        }
+        if (['blob', 'file', 'formdata'].includes(payload.type)) {
+            // should this return a string from the blob?
+            return undefined;
+        }
+        const body = await this.readPayload();
+        if (Platform_js_1.hasBuffer && body instanceof Buffer) {
+            return body.toString();
+        }
+        const dataView = new DataView(body);
+        const decoder = new TextDecoder();
+        return decoder.decode(dataView);
+    }
+    toJSON() {
+        const result = {};
+        if (this.payload) {
+            result.payload = this.payload;
+        }
+        if (this.payloadOptions) {
+            result.payloadOptions = { ...this.payloadOptions };
+        }
+        return result;
+    }
+}
+exports.SerializablePayload = SerializablePayload;
+//# sourceMappingURL=SerializablePayload.js.map

package/build/cjs/src/models/SerializablePayload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SerializablePayload.js","sourceRoot":"","sources":["../../../../src/models/SerializablePayload.ts"],"names":[],"mappings":";;;AAAA,mFAA2G;AAC3G,gDAA2C;AA2B3C,MAAa,mBAAmB;IAC9B,OAAO,CAAW;IAElB,cAAc,CAA8B;IAE5C;;;OAGG;IACO,cAAc,CAAU;IAElC;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAAC,OAAgB,EAAE,IAAa;QAChD,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,wCAAiB,CAAC,SAAS,CAAC,OAA8B,CAAC,CAAC;QACjF,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;gBACxB,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;aAC1B;YACD,IAAI,CAAC,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC;SACjC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QACf,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YACxB,IAAI,CAAC,cAAc,GAAG,MAAM,wCAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACzE;QACD,OAAO,IAAI,CAAC,cAAqC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,mBAAmB;QACvB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,OAAO,OAAO,CAAC;SAChB;QACD,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC7B,OAAO,OAAO,CAAC,IAAc,CAAC;SAC/B;QACD,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvD,6CAA6C;YAC7C,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QACtC,IAAI,uBAAS,IAAI,IAAI,YAAY,MAAM,EAAE;YACvC,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;SACxB;QACD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAmB,CAAC,CAAC;QACnD,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QAClC,OAAO,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAyB,EAAE,CAAC;QACxC,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;SAC/B;QACD,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,MAAM,CAAC,cAAc,GAAG,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;SACpD;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAjFD,kDAiFC"}

package/build/cjs/src/models/Server.js

@@ -0,0 +1,155 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Server = exports.Kind = void 0;
+const Property_js_1 = require("./Property.js");
+const UriTemplate_js_1 = require("../lib/parsers/UriTemplate.js");
+exports.Kind = 'Core#Server';
+class Server {
+    kind = exports.Kind;
+    /**
+     * The base URI of the server.
+     *
+     * Note, the URL can contain URI templates (e.g. `http://{host}.api.com/v1`)
+     * In this case the variable is replaced with the system or project variables.
+     *
+     * For simplicity, the `uri` can be the full base URI with protocol, host, and the `basePath`
+     */
+    uri = '';
+    /**
+     * Usually included in the `uri`. When the `uri` is missing a protocol
+     * this is then used.
+     */
+    protocol;
+    /**
+     * The base path for the server. It starts with the `/`.
+     * When set, it is appended to the `uri` value.
+     */
+    basePath;
+    /**
+     * Optional description of the server.
+     */
+    description;
+    /**
+     * Creates a server definition from a base URI.
+     */
+    static fromUri(uri) {
+        const srv = new Server({
+            kind: exports.Kind,
+            uri,
+        });
+        return srv;
+    }
+    /**
+     * @param input The server definition used to restore the state.
+     */
+    constructor(input) {
+        let init;
+        if (typeof input === 'string') {
+            init = JSON.parse(input);
+        }
+        else if (typeof input === 'object') {
+            init = input;
+        }
+        else {
+            init = {
+                kind: exports.Kind,
+                uri: '',
+            };
+        }
+        this.new(init);
+    }
+    /**
+     * Creates a new server clearing anything that is so far defined.
+     *
+     * Note, this throws an error when the server is not a server.
+     */
+    new(init) {
+        if (!Server.isServer(init)) {
+            throw new Error(`Not a server.`);
+        }
+        const { uri, description, protocol, basePath } = init;
+        this.kind = exports.Kind;
+        this.uri = uri;
+        this.description = description;
+        this.protocol = protocol;
+        this.basePath = basePath;
+    }
+    /**
+     * Checks whether the input is a definition of a server.
+     */
+    static isServer(input) {
+        const typed = input;
+        if (!input || typeof typed.uri === 'undefined' || typed.kind !== exports.Kind) {
+            return false;
+        }
+        return true;
+    }
+    toJSON() {
+        const result = {
+            kind: exports.Kind,
+            uri: this.uri,
+        };
+        if (this.description) {
+            result.description = this.description;
+        }
+        if (this.protocol) {
+            result.protocol = this.protocol;
+        }
+        if (this.basePath) {
+            result.basePath = this.basePath;
+        }
+        return result;
+    }
+    /**
+     * Constructs the final URI from the server configuration.
+     *
+     * @param variables When set it evaluates the generated URI against these variables
+     */
+    readUri(variables) {
+        const { uri, protocol, basePath } = this;
+        let result = '';
+        if (!uri) {
+            return result;
+        }
+        let tmp = uri;
+        if (protocol && !uri.includes('://')) {
+            tmp = `${protocol}//${uri}`;
+        }
+        result = tmp;
+        if (basePath) {
+            if (result.endsWith('/')) {
+                result = result.substring(0, result.length - 1);
+            }
+            result += basePath.startsWith('/') ? basePath : `/${basePath}`;
+        }
+        if (variables) {
+            return this.evaluateUri(result, variables);
+        }
+        return result;
+    }
+    /**
+     * Evaluates the URI against the variables.
+     *
+     * Note, this doesn't throw errors. When error occurs it returns the input string.
+     *
+     * @param uri The URI to process
+     * @param variables The list of variables to use
+     * @returns Expanded URI.
+     */
+    evaluateUri(uri, variables) {
+        if (!variables || !variables.length) {
+            return uri;
+        }
+        let result = uri;
+        try {
+            const map = Property_js_1.Property.toMap(variables);
+            result = new UriTemplate_js_1.UriTemplate(uri).expand(map, { ignoreMissing: true });
+        }
+        catch (e) {
+            // 
+        }
+        return result;
+    }
+}
+exports.Server = Server;
+//# sourceMappingURL=Server.js.map

package/build/cjs/src/models/Server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Server.js","sourceRoot":"","sources":["../../../../src/models/Server.ts"],"names":[],"mappings":";;;AAAA,+CAAoD;AACpD,kEAA4D;AAE/C,QAAA,IAAI,GAAG,aAAa,CAAC;AA4BlC,MAAa,MAAM;IACjB,IAAI,GAAG,YAAI,CAAC;IACZ;;;;;;;OAOG;IACH,GAAG,GAAG,EAAE,CAAC;IACT;;;OAGG;IACH,QAAQ,CAAU;IAClB;;;OAGG;IACH,QAAQ,CAAU;IAClB;;OAEG;IACH,WAAW,CAAU;IAErB;;OAEG;IACH,MAAM,CAAC,OAAO,CAAC,GAAW;QACxB,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC;YACrB,IAAI,EAAE,YAAI;YACV,GAAG;SACJ,CAAC,CAAC;QACH,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;OAEG;IACH,YAAY,KAAsB;QAChC,IAAI,IAAa,CAAC;QAClB,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,YAAI;gBACV,GAAG,EAAE,EAAE;aACR,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,IAAa;QACf,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;SAClC;QACD,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACtD,IAAI,CAAC,IAAI,GAAG,YAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAc;QAC5B,MAAM,KAAK,GAAG,KAAgB,CAAC;QAC/B,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,CAAC,GAAG,KAAK,WAAW,IAAI,KAAK,CAAC,IAAI,KAAK,YAAI,EAAE;YACrE,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAY;YACtB,IAAI,EAAE,YAAI;YACV,GAAG,EAAE,IAAI,CAAC,GAAG;SACd,CAAC;QACF,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;SACvC;QACD,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;SACjC;QACD,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;SACjC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,SAAoC;QAC1C,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACzC,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,GAAG,EAAE;YACR,OAAO,MAAM,CAAC;SACf;QAED,IAAI,GAAG,GAAG,GAAG,CAAC;QACd,IAAI,QAAQ,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YACpC,GAAG,GAAG,GAAG,QAAQ,KAAK,GAAG,EAAE,CAAC;SAC7B;QACD,MAAM,GAAG,GAAG,CAAC;QACb,IAAI,QAAQ,EAAE;YACZ,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBACxB,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;aACjD;YACD,MAAM,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAA;SAC/D;QACD,IAAI,SAAS,EAAE;YACb,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;SAC5C;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACO,WAAW,CAAC,GAAW,EAAE,SAAmC;QACpE,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE;YACnC,OAAO,GAAG,CAAC;SACZ;QACD,IAAI,MAAM,GAAG,GAAG,CAAC;QACjB,IAAI;YACF,MAAM,GAAG,GAAG,sBAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACtC,MAAM,GAAG,IAAI,4BAAW,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;SACpE;QAAC,OAAO,CAAC,EAAE;YACV,GAAG;SACJ;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAvJD,wBAuJC"}

package/build/cjs/src/models/Space.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Space = exports.Kind = void 0;
+const Thing_js_1 = require("./Thing.js");
+const uuid_js_1 = __importDefault(require("../lib/uuid.js"));
+const File_js_1 = require("./store/File.js");
+exports.Kind = 'Core#Space';
+/**
+ * The definition of a space (or workspace).
+ * A space is the parent container keeping all the data the user sees in the application.
+ * By changing space the user has completely different set of data.
+ */
+class Space extends File_js_1.File {
+    kind = exports.Kind;
+    static fromName(name, owner = File_js_1.DefaultOwner) {
+        return super.fromName(name, '', owner, exports.Kind);
+    }
+    constructor(input) {
+        super();
+        let init;
+        if (typeof input === 'string') {
+            init = JSON.parse(input);
+        }
+        else if (typeof input === 'object') {
+            init = input;
+        }
+        else {
+            init = {
+                kind: exports.Kind,
+                key: (0, uuid_js_1.default)(),
+                space: '',
+                info: Thing_js_1.Thing.fromName('').toJSON(),
+                owner: File_js_1.DefaultOwner,
+                parents: [],
+                permissionIds: [],
+                permissions: [],
+                lastModified: { user: '', time: 0, byMe: false },
+            };
+        }
+        this.new(init);
+    }
+    new(init) {
+        if (!Space.isProject(init)) {
+            throw new Error(`Not a project file.`);
+        }
+        super.new(init);
+        this.kind = exports.Kind;
+    }
+    static isProject(input) {
+        const typed = input;
+        if (!input || typed.kind !== exports.Kind) {
+            return false;
+        }
+        return true;
+    }
+    toJSON() {
+        const result = {
+            ...super.toJSON(),
+            kind: exports.Kind,
+        };
+        return result;
+    }
+}
+exports.Space = Space;
+//# sourceMappingURL=Space.js.map

package/build/cjs/src/models/Space.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Space.js","sourceRoot":"","sources":["../../../../src/models/Space.ts"],"names":[],"mappings":";;;;;;AAAA,yCAAmC;AACnC,6DAAgC;AAChC,6CAA4D;AAE/C,QAAA,IAAI,GAAG,YAAY,CAAC;AAajC;;;;GAIG;AACH,MAAa,KAAM,SAAQ,cAAI;IACpB,IAAI,GAAG,YAAI,CAAC;IAErB,MAAM,CAAU,QAAQ,CAAC,IAAY,EAAE,KAAK,GAAG,sBAAY;QACzD,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,YAAI,CAAU,CAAC;IACxD,CAAC;IAED,YAAY,KAAuB;QACjC,KAAK,EAAE,CAAC;QACR,IAAI,IAAY,CAAC;QACjB,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,YAAI;gBACV,GAAG,EAAE,IAAA,iBAAE,GAAE;gBACT,KAAK,EAAE,EAAE;gBACT,IAAI,EAAE,gBAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;gBACjC,KAAK,EAAE,sBAAY;gBACnB,OAAO,EAAE,EAAE;gBACX,aAAa,EAAE,EAAE;gBACjB,WAAW,EAAE,EAAE;gBACf,YAAY,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE;aACjD,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAEQ,GAAG,CAAC,IAAY;QACvB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SACxC;QACD,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChB,IAAI,CAAC,IAAI,GAAG,YAAI,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,KAAc;QAC7B,MAAM,KAAK,GAAG,KAAe,CAAC;QAC9B,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,YAAI,EAAE;YACjC,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEQ,MAAM;QACb,MAAM,MAAM,GAAW;YACrB,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,YAAI;SACX,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AArDD,sBAqDC"}

package/build/cjs/src/models/Thing.d.ts

@@ -0,0 +1,73 @@
+import { ThingKind } from "./kinds.js";
+/**
+ * An interface describing a base metadata of a thing.
+ */
+export declare interface IThing {
+    /**
+     * The data kind. The application ignores the input with an unknown `kind`, unless it can be determined from the context.
+     */
+    kind?: typeof ThingKind;
+    /**
+     * The name of the thing.
+     */
+    name?: string;
+    /**
+     * Optional value to overwrite the `name` in the UI.
+     * The primary descriptive field is the `name`. The display name is only used in the presentation of the data.
+     */
+    displayName?: string;
+    /**
+     * The description of the thing.
+     */
+    description?: string;
+    /**
+     * The version number of the thing.
+     */
+    version?: string;
+}
+export declare class Thing {
+    kind: string;
+    /**
+     * The name of the thing.
+     */
+    name?: string;
+    /**
+     * Optional value to overwrite the `name` in the UI.
+     * The primary descriptive field is the `name`. The display name is only used in the presentation of the data.
+     */
+    displayName?: string;
+    /**
+     * The description of the thing.
+     */
+    description?: string;
+    /**
+     * The version number of the thing.
+     */
+    version?: string;
+    /**
+     * Returns one in this order:
+     * - displayName
+     * - name
+     * - 'Unnamed object'
+     */
+    get renderLabel(): string;
+    /**
+     * Creates a basic description from a name.
+     */
+    static fromName(name: string): Thing;
+    /**
+     * @param input The thing definition used to restore the state.
+     */
+    constructor(input?: string | IThing);
+    /**
+     * Creates a new thing clearing anything that is so far defined.
+     *
+     * Note, this throws an error when the server is not a thing.
+     */
+    new(init: IThing): void;
+    /**
+     * Checks whether the input is a definition of a server.
+     */
+    static isThing(input: unknown): boolean;
+    toJSON(): IThing;
+}

package/build/cjs/src/models/Thing.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Thing = void 0;
+const kinds_js_1 = require("./kinds.js");
+class Thing {
+    kind = kinds_js_1.ThingKind;
+    /**
+     * The name of the thing.
+     */
+    name;
+    /**
+     * Optional value to overwrite the `name` in the UI.
+     * The primary descriptive field is the `name`. The display name is only used in the presentation of the data.
+     */
+    displayName;
+    /**
+     * The description of the thing.
+     */
+    description;
+    /**
+     * The version number of the thing.
+     */
+    version;
+    /**
+     * Returns one in this order:
+     * - displayName
+     * - name
+     * - 'Unnamed object'
+     */
+    get renderLabel() {
+        return this.displayName || this.name || 'Unnamed object';
+    }
+    /**
+     * Creates a basic description from a name.
+     */
+    static fromName(name) {
+        const thing = new Thing({
+            name,
+            kind: kinds_js_1.ThingKind,
+        });
+        return thing;
+    }
+    /**
+     * @param input The thing definition used to restore the state.
+     */
+    constructor(input) {
+        let init;
+        if (typeof input === 'string') {
+            init = JSON.parse(input);
+        }
+        else if (typeof input === 'object') {
+            init = input;
+        }
+        else {
+            init = {
+                kind: kinds_js_1.ThingKind,
+            };
+        }
+        this.new(init);
+    }
+    /**
+     * Creates a new thing clearing anything that is so far defined.
+     *
+     * Note, this throws an error when the server is not a thing.
+     */
+    new(init) {
+        if (!Thing.isThing(init)) {
+            throw new Error(`Not a thing.`);
+        }
+        const { description, name, version, displayName } = init;
+        this.kind = kinds_js_1.ThingKind;
+        this.name = name;
+        this.displayName = displayName;
+        this.description = description;
+        this.version = version;
+    }
+    /**
+     * Checks whether the input is a definition of a server.
+     */
+    static isThing(input) {
+        const typed = input;
+        if (input && typed.kind === kinds_js_1.ThingKind) {
+            return true;
+        }
+        return false;
+    }
+    toJSON() {
+        const result = {
+            kind: kinds_js_1.ThingKind,
+        };
+        if (typeof this.name === 'string') {
+            result.name = this.name;
+        }
+        if (typeof this.displayName === 'string') {
+            result.displayName = this.displayName;
+        }
+        if (this.description) {
+            result.description = this.description;
+        }
+        if (this.version) {
+            result.version = this.version;
+        }
+        return result;
+    }
+}
+exports.Thing = Thing;
+//# sourceMappingURL=Thing.js.map

package/build/cjs/src/models/Thing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Thing.js","sourceRoot":"","sources":["../../../../src/models/Thing.ts"],"names":[],"mappings":";;;AAAA,yCAAuC;AA6BvC,MAAa,KAAK;IAChB,IAAI,GAAG,oBAAS,CAAC;IACjB;;OAEG;IACH,IAAI,CAAU;IACd;;;OAGG;IACH,WAAW,CAAU;IACrB;;OAEG;IACH,WAAW,CAAU;IACrB;;OAEG;IACH,OAAO,CAAU;IAEjB;;;;;OAKG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,IAAI,IAAI,gBAAgB,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAY;QAC1B,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC;YACtB,IAAI;YACJ,IAAI,EAAE,oBAAS;SAChB,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACH,YAAY,KAAuB;QACjC,IAAI,IAAY,CAAC;QACjB,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,oBAAS;aAChB,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,IAAY;QACd,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACxB,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;SACjC;QACD,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QACzD,IAAI,CAAC,IAAI,GAAG,oBAAS,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,OAAO,CAAC,KAAc;QAC3B,MAAM,KAAK,GAAG,KAAe,CAAC;QAC9B,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,oBAAS,EAAE;YACrC,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAW;YACrB,IAAI,EAAE,oBAAS;SAChB,CAAC;QACF,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE;YACjC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;SACzB;QACD,IAAI,OAAO,IAAI,CAAC,WAAW,KAAK,QAAQ,EAAE;YACxC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;SACvC;QACD,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;SACvC;QACD,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;SAC/B;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAxGD,sBAwGC"}

package/build/cjs/src/models/TrashEntry.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TrashEntry.js.map

package/build/cjs/src/models/TrashEntry.js.map

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

package/build/cjs/src/models/Url.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Url = void 0;
+/**
+ * An object representing an URL stored in the data store.
+ * This is an URL used to make a request.
+ */
+class Url {
+    /**
+     * A number of times the URL was used
+     */
+    cnt = 0;
+    /**
+     * Last use timestamp.
+     */
+    time = Date.now();
+    /**
+     * The request URL stored in the history. This is also the store key.
+     */
+    key = '';
+    /**
+     * A timestamp of the midnight that corresponds to the `time` property.
+     */
+    midnight;
+    /**
+     * @param input The URL definition used to restore the state.
+     */
+    constructor(input) {
+        let init;
+        if (typeof input === 'string') {
+            init = JSON.parse(input);
+        }
+        else if (typeof input === 'object') {
+            init = input;
+        }
+        else {
+            init = {
+                cnt: 0,
+                time: Date.now(),
+                key: '',
+            };
+        }
+        this.new(init);
+    }
+    /**
+     * Creates a new URL clearing anything that is so far defined.
+     */
+    new(init) {
+        const { key = '', cnt = 0, time = Date.now(), midnight } = init;
+        this.key = key;
+        this.cnt = cnt;
+        this.time = time;
+        if (midnight) {
+            this.midnight = midnight;
+        }
+        else {
+            const d = new Date(this.time);
+            d.setHours(0, 0, 0, 0);
+            this.midnight = d.getTime();
+        }
+    }
+    toJSON() {
+        const result = {
+            key: this.key,
+            cnt: this.cnt,
+            time: this.time,
+            midnight: this.midnight,
+        };
+        return result;
+    }
+}
+exports.Url = Url;
+//# sourceMappingURL=Url.js.map

package/build/cjs/src/models/Url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Url.js","sourceRoot":"","sources":["../../../../src/models/Url.ts"],"names":[],"mappings":";;;AAoBA;;;GAGG;AACH,MAAa,GAAG;IACd;;OAEG;IACH,GAAG,GAAG,CAAC,CAAC;IACR;;OAEG;IACH,IAAI,GAAW,IAAI,CAAC,GAAG,EAAE,CAAC;IAC1B;;OAEG;IACH,GAAG,GAAG,EAAE,CAAC;IACT;;OAEG;IACH,QAAQ,CAAU;IAElB;;OAEG;IACH,YAAY,KAAoB;QAC9B,IAAI,IAAU,CAAC;QACf,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,GAAG,EAAE,CAAC;gBACN,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;gBAChB,GAAG,EAAE,EAAE;aACR,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,IAAU;QACZ,MAAM,EAAE,GAAG,GAAG,EAAE,EAAE,GAAG,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAChE,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,QAAQ,EAAE;YACZ,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;aAAM;YACL,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;YACtB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;SAC7B;IACH,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAS;YACnB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA/DD,kBA+DC"}