@api-client/core 0.9.24 → 0.10.0

package/build/esm/src/models/ResponseRedirect.d.ts

@@ -0,0 +1,71 @@
+import { IHttpResponse, HttpResponse } from './HttpResponse.js';
+import { IRequestTime, RequestTime } from './RequestTime.js';
+import { ResponseRedirect as LegacyRedirect } from './legacy/request/ArcResponse.js';
+export declare const Kind = "Core#HttpResponseRedirect";
+/**
+ * An information about a redirect
+ */
+export interface IResponseRedirect {
+    kind: typeof Kind;
+    /**
+     * Redirection response
+     */
+    response: IHttpResponse;
+    /**
+     * Redirection timings, if available.
+     */
+    timings?: IRequestTime;
+    /**
+     * The timestamp when the request was started (before the connection is made)
+     */
+    startTime: number;
+    /**
+     * The timestamp of when the response ended.
+     */
+    endTime: number;
+    /**
+     * The URL the request was redirected to
+     */
+    url: string;
+}
+export declare class ResponseRedirect {
+    kind: typeof Kind;
+    /**
+     * Redirection response
+     */
+    response?: HttpResponse;
+    /**
+     * Redirection timings, if available.
+     */
+    timings?: RequestTime;
+    /**
+     * The timestamp when the request was started (before the connection is made)
+     */
+    startTime: number;
+    /**
+     * The timestamp of when the response ended.
+     */
+    endTime: number;
+    /**
+     * The URL the request was redirected to
+     */
+    url: string;
+    /**
+     * Creates a redirect object from basic values.
+     * @param url The redirect URL
+     * @param response The response object created by the transport
+     * @param startTime The time when the request started
+     * @param endTime The time when the request ended
+     */
+    static fromValues(url: string, response: IHttpResponse, startTime?: number, endTime?: number): ResponseRedirect;
+    static fromLegacy(redirect: LegacyRedirect): Promise<ResponseRedirect>;
+    /**
+     * @param input The redirect definition used to restore the state.
+     */
+    constructor(input?: string | IResponseRedirect);
+    /**
+     * Creates a new redirect clearing anything that is so far defined.
+     */
+    new(init: IResponseRedirect): void;
+    toJSON(): IResponseRedirect;
+}

package/build/esm/src/models/ResponseRedirect.js

@@ -0,0 +1,125 @@
+import { HttpResponse } from './HttpResponse.js';
+import { RequestTime } from './RequestTime.js';
+import { ResponseKind } from './kinds.js';
+export const Kind = 'Core#HttpResponseRedirect';
+export class ResponseRedirect {
+    kind = Kind;
+    /**
+     * Redirection response
+     */
+    response;
+    /**
+     * Redirection timings, if available.
+     */
+    timings;
+    /**
+     * The timestamp when the request was started (before the connection is made)
+     */
+    startTime = 0;
+    /**
+     * The timestamp of when the response ended.
+     */
+    endTime = 0;
+    /**
+     * The URL the request was redirected to
+     */
+    url = '';
+    /**
+     * Creates a redirect object from basic values.
+     * @param url The redirect URL
+     * @param response The response object created by the transport
+     * @param startTime The time when the request started
+     * @param endTime The time when the request ended
+     */
+    static fromValues(url, response, startTime = 0, endTime = 0) {
+        return new ResponseRedirect({
+            kind: Kind,
+            url,
+            startTime,
+            endTime,
+            response,
+        });
+    }
+    static async fromLegacy(redirect) {
+        const init = {
+            kind: Kind,
+            endTime: redirect.endTime || 0,
+            startTime: redirect.startTime || 0,
+            url: redirect.url || '',
+            response: {
+                kind: ResponseKind,
+                status: 0,
+            },
+        };
+        if (redirect.response) {
+            const response = await HttpResponse.fromLegacy(redirect.response);
+            init.response = response.toJSON();
+        }
+        if (redirect.timings) {
+            init.timings = new RequestTime(redirect.timings).toJSON();
+        }
+        return new ResponseRedirect(init);
+    }
+    /**
+     * @param input The redirect 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: Kind,
+                endTime: 0,
+                startTime: 0,
+                url: '',
+                response: {
+                    kind: ResponseKind,
+                    status: 0,
+                },
+            };
+        }
+        this.new(init);
+    }
+    /**
+     * Creates a new redirect clearing anything that is so far defined.
+     */
+    new(init) {
+        const { response, timings, startTime = 0, endTime = 0, url = '', kind = Kind } = init;
+        this.kind = kind;
+        this.startTime = startTime;
+        this.endTime = endTime;
+        this.url = url;
+        this.response = new HttpResponse(response);
+        if (timings) {
+            this.timings = new RequestTime(timings);
+        }
+        else {
+            this.timings = undefined;
+        }
+    }
+    toJSON() {
+        const result = {
+            kind: this.kind,
+            startTime: this.startTime,
+            endTime: this.endTime,
+            url: this.url,
+            response: {
+                kind: ResponseKind,
+                status: 0,
+            },
+        };
+        if (this.response) {
+            result.response = this.response.toJSON();
+        }
+        if (this.timings) {
+            result.timings = this.timings.toJSON();
+        }
+        return result;
+    }
+}
+//# sourceMappingURL=ResponseRedirect.js.map

package/build/esm/src/models/ResponseRedirect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResponseRedirect.js","sourceRoot":"","sources":["../../../../src/models/ResponseRedirect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAgB,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE7D,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,MAAM,CAAC,MAAM,IAAI,GAAG,2BAA2B,CAAC;AA8BhD,MAAM,OAAO,gBAAgB;IAC3B,IAAI,GAAgB,IAAI,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAgB;IACxB;;OAEG;IACH,OAAO,CAAe;IACtB;;OAEG;IACH,SAAS,GAAG,CAAC,CAAC;IACd;;OAEG;IACH,OAAO,GAAG,CAAC,CAAC;IACZ;;OAEG;IACH,GAAG,GAAG,EAAE,CAAC;IAET;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,GAAW,EAAE,QAAuB,EAAE,SAAS,GAAG,CAAC,EAAE,OAAO,GAAG,CAAC;QAChF,OAAO,IAAI,gBAAgB,CAAC;YAC1B,IAAI,EAAE,IAAI;YACV,GAAG;YACH,SAAS;YACT,OAAO;YACP,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,QAAwB;QAC9C,MAAM,IAAI,GAAsB;YAC9B,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC;YAC9B,SAAS,EAAE,QAAQ,CAAC,SAAS,IAAI,CAAC;YAClC,GAAG,EAAE,QAAQ,CAAC,GAAG,IAAI,EAAE;YACvB,QAAQ,EAAE;gBACR,IAAI,EAAE,YAAY;gBAClB,MAAM,EAAE,CAAC;aACV;SACF,CAAC;QACF,IAAI,QAAQ,CAAC,QAAQ,EAAE;YACrB,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAClE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;SACnC;QACD,IAAI,QAAQ,CAAC,OAAO,EAAE;YACpB,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;SAC3D;QACD,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,YAAY,KAAgC;QAC1C,IAAI,IAAuB,CAAC;QAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SAC1B;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YACpC,IAAI,GAAG,KAAK,CAAC;SACd;aAAM;YACL,IAAI,GAAG;gBACL,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,CAAC;gBACV,SAAS,EAAE,CAAC;gBACZ,GAAG,EAAE,EAAE;gBACP,QAAQ,EAAE;oBACR,IAAI,EAAE,YAAY;oBAClB,MAAM,EAAE,CAAC;iBACV;aACF,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,IAAuB;QACzB,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,GAAC,CAAC,EAAE,OAAO,GAAC,CAAC,EAAE,GAAG,GAAC,EAAE,EAAE,IAAI,GAAC,IAAI,EAAE,GAAG,IAAI,CAAC;QAC9E,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC3C,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;SACzC;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;SAC1B;IACH,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAsB;YAChC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,QAAQ,EAAE;gBACR,IAAI,EAAE,YAAY;gBAClB,MAAM,EAAE,CAAC;aACO;SACnB,CAAC;QACF,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;SAC1C;QACD,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;SACxC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/build/esm/src/models/SentRequest.d.ts

@@ -0,0 +1,60 @@
+import { IHttpRequest, HttpRequest, IBaseHttpRequest } from './HttpRequest.js';
+import { TransportRequest as LegacyTransportRequest } from './legacy/request/ArcRequest.js';
+export interface IBaseSentRequest extends IBaseHttpRequest {
+    /**
+     * The HTTP message sent to the server (full message).
+     * Some HTTP clients may not give this information.
+     */
+    httpMessage?: string;
+    /**
+     * The timestamp when the request was started (before the connection is made)
+     */
+    startTime: number;
+    /**
+     * The timestamp of when the response ended.
+     * This is always set when the response is ready. May not be set when the request is ongoing.
+     */
+    endTime?: number;
+}
+/**
+ * An interface describing a request made by the HTTP transport.
+ * Each transport used by API Client must return this structure in the response event.
+ * This is not a replacement for the editor request that also has to be returned.
+ *
+ * Another difference is that this headers contains a final list of headers sent to the
+ * server, including default headers, content-length, authorization, and so on.
+ */
+export interface ISentRequest extends IHttpRequest, IBaseSentRequest {
+}
+/**
+ * A class that describes a request that has been sent by the transport library
+ * to the remote machine. It contains the base HTTP request properties plus
+ * the sent message and start and end time.
+ */
+export declare class SentRequest extends HttpRequest {
+    /**
+     * The HTTP message sent to the server (full message).
+     * Some HTTP clients may not give this information.
+     */
+    httpMessage?: string;
+    /**
+     * The timestamp when the request was started (before the connection is made)
+     */
+    startTime: number;
+    /**
+     * The timestamp of when the response ended.
+     * When `0` then the requests is still being transported.
+     */
+    endTime: number;
+    static fromBaseValues(values: IBaseSentRequest): SentRequest;
+    static fromLegacy(input: LegacyTransportRequest): Promise<SentRequest>;
+    /**
+     * @param input The request definition used to restore the state.
+     */
+    constructor(input?: string | ISentRequest);
+    /**
+     * Creates a new sent request clearing anything that is so far defined.
+     */
+    new(init: ISentRequest): void;
+    toJSON(): ISentRequest;
+}

package/build/esm/src/models/SentRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SentRequest.js","sourceRoot":"","sources":["../../../../src/models/SentRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,WAAW,EAAE,IAAI,EAAoB,MAAM,kBAAkB,CAAC;AAErF,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AA8B7E;;;;GAIG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;OAGG;IACH,WAAW,CAAU;IACrB;;OAEG;IACH,SAAS,GAAG,CAAC,CAAC;IACd;;;OAGG;IACH,OAAO,GAAG,CAAC,CAAC;IAEZ,MAAM,CAAU,cAAc,CAAC,MAAwB;QACrD,OAAO,IAAI,WAAW,CAAC;YACrB,GAAG,MAAM;YACT,IAAI,EAAE,IAAI;SACX,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,KAA6B;QACnD,MAAM,IAAI,GAAiB;YACzB,IAAI,EAAE,IAAI;YACV,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,EAAE;YACpB,SAAS,EAAE,KAAK,CAAC,SAAS,IAAI,CAAC;SAChC,CAAC;QACF,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EAAE;YACrC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;SAC9B;QACD,IAAI,KAAK,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;SAC9B;QACD,IAAI,KAAK,CAAC,WAAW,EAAE;YACrB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;SACtC;QACD,IAAI,KAAK,CAAC,MAAM,EAAE;YAChB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;SAC5B;QACD,IAAI,KAAK,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,GAAG,MAAM,iBAAiB,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;SACjE;QACD,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,YAAY,KAA2B;QACrC,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,IAAkB,CAAC;QACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SAC1B;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YACpC,IAAI,GAAG,KAAK,CAAC;SACd;aAAM;YACL,IAAI,GAAG;gBACL,IAAI,EAAE,IAAI;gBACV,GAAG,EAAE,EAAE;gBACP,SAAS,EAAE,CAAC;aACb,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED;;OAEG;IACM,GAAG,CAAC,IAAkB;QAC7B,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChB,MAAM,EAAE,WAAW,EAAE,SAAS,GAAC,CAAC,EAAE,OAAO,GAAC,CAAC,EAAE,GAAG,IAAI,CAAC;QACrD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEQ,MAAM;QACb,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,EAAkB,CAAC;QAC/C,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACvC,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC/B,OAAO,OAAO,CAAC;IACjB,CAAC;CACF"}

package/build/esm/src/models/SerializableError.d.ts

@@ -0,0 +1,31 @@
+interface IErrorOptions {
+    cause?: Error;
+}
+export interface ISerializedError {
+    message: string;
+    stack?: string;
+    code?: string | number;
+    [key: PropertyKey]: any;
+}
+/**
+ * An error that serializes!
+ * It is a copy of the normal definition of an error but allows
+ * to serialize the value via the toJSON() function and restore previous values
+ * with the `new()` function.
+ */
+export declare class SerializableError {
+    message: string;
+    code?: number | string;
+    private stackValue?;
+    get stack(): string | undefined;
+    get name(): string;
+    constructor();
+    constructor(error: Error);
+    constructor(message: string);
+    constructor(message: string, options: IErrorOptions);
+    constructor(message: string, code?: number | string);
+    new(values: ISerializedError): void;
+    toJSON(): ISerializedError;
+    toString(): string;
+}
+export {};

package/build/esm/src/models/SerializableError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SerializableError.js","sourceRoot":"","sources":["../../../../src/models/SerializableError.ts"],"names":[],"mappings":"AAWA;;;;;GAKG;AACH,MAAM,OAAO,iBAAiB;IAC5B,OAAO,CAAS;IAChB,IAAI,CAAmB;IACf,UAAU,CAAU;IAC5B,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAQD,YAAY,OAAwB,EAAE,UAA2C,EAAE;QACjF,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;SACxB;aAAM,IAAI,OAAO,EAAE;YAClB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC;SACjC;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;SACnB;QACD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC9D,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;SACrB;aAAM,IAAI,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE;YAC/C,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;SACvC;IACH,CAAC;IAED,GAAG,CAAC,MAAwB;QAC1B,IAAI,MAAM,CAAC,OAAO,EAAE;YAClB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;SAC/B;QACD,IAAI,MAAM,CAAC,KAAK,EAAE;YAChB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC;SAChC;QACD,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE;YACpC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;SACzB;IACH,CAAC;IAED,MAAM;QACJ,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAClD,MAAM,MAAM,GAAqB;YAC/B,OAAO;SACR,CAAC;QACF,IAAI,KAAK,EAAE;YACT,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;SACtB;QACD,IAAI,IAAI,IAAI,IAAI,KAAK,CAAC,EAAE;YACtB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;SACpB;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF"}

package/build/esm/src/models/SerializablePayload.d.ts

@@ -0,0 +1,54 @@
+import { Payload, DeserializedPayload } from '../lib/transformers/PayloadSerializer.js';
+export interface SerializablePayloadOptions {
+    /**
+     * The mime type of the payload, if any.
+     * This is a helper information that **should** be put
+     * while providing the payload. It is the value of the
+     * `content-type` header to be used with the body if one is missing.
+     *
+     * Note, this is only used when the headers field does not
+     * include the `content-type` value.
+     */
+    mime?: string;
+}
+export interface ISerializablePayload {
+    /**
+     * The serialized payload message.
+     */
+    payload?: Payload;
+    /**
+     * Optional meta of the payload
+     */
+    payloadOptions?: SerializablePayloadOptions;
+}
+export declare class SerializablePayload implements ISerializablePayload {
+    payload?: Payload;
+    payloadOptions?: SerializablePayloadOptions;
+    /**
+     * The payload in its original format.
+     * May not be populated when the `getPayload()` was not yet read.
+     */
+    protected _sourcePayload: unknown;
+    /**
+     * 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.
+     */
+    writePayload(message: unknown, mime?: string): Promise<void>;
+    /**
+     * Reads the payload as its original format.
+     * It uses the `PayloadSerializer` to process the data.
+     */
+    readPayload(): Promise<DeserializedPayload>;
+    /**
+     * 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.
+     */
+    readPayloadAsString(): Promise<string | undefined>;
+    toJSON(): ISerializablePayload;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"SerializablePayload.js","sourceRoot":"","sources":["../../../../src/models/SerializablePayload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAgC,MAAM,0CAA0C,CAAC;AAC3G,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AA2B3C,MAAM,OAAO,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,iBAAiB,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,iBAAiB,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,SAAS,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"}

package/build/esm/src/models/Server.d.ts

@@ -0,0 +1,88 @@
+import { IProperty, Property } from './Property.js';
+export declare const Kind = "Core#Server";
+export interface IServer {
+    kind: typeof 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: string;
+    /**
+     * Usually included in the `uri`. When the `uri` is missing a protocol this is then used.
+     */
+    protocol?: string;
+    /**
+     * The base path for the server. It starts with the `/`.
+     * When set, it is appended to the `uri` value.
+     */
+    basePath?: string;
+    /**
+     * Optional description of the server.
+     */
+    description?: string;
+}
+export declare class Server {
+    kind: string;
+    /**
+     * 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: string;
+    /**
+     * Usually included in the `uri`. When the `uri` is missing a protocol
+     * this is then used.
+     */
+    protocol?: string;
+    /**
+     * The base path for the server. It starts with the `/`.
+     * When set, it is appended to the `uri` value.
+     */
+    basePath?: string;
+    /**
+     * Optional description of the server.
+     */
+    description?: string;
+    /**
+     * Creates a server definition from a base URI.
+     */
+    static fromUri(uri: string): Server;
+    /**
+     * @param input The server definition used to restore the state.
+     */
+    constructor(input?: string | IServer);
+    /**
+     * 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: IServer): void;
+    /**
+     * Checks whether the input is a definition of a server.
+     */
+    static isServer(input: unknown): boolean;
+    toJSON(): IServer;
+    /**
+     * Constructs the final URI from the server configuration.
+     *
+     * @param variables When set it evaluates the generated URI against these variables
+     */
+    readUri(variables?: (IProperty | Property)[]): string;
+    /**
+     * 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.
+     */
+    protected evaluateUri(uri: string, variables: (IProperty | Property)[]): string;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"Server.js","sourceRoot":"","sources":["../../../../src/models/Server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,QAAQ,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAE5D,MAAM,CAAC,MAAM,IAAI,GAAG,aAAa,CAAC;AA4BlC,MAAM,OAAO,MAAM;IACjB,IAAI,GAAG,IAAI,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,IAAI;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,IAAI;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,IAAI,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,IAAI,EAAE;YACrE,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAY;YACtB,IAAI,EAAE,IAAI;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,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACtC,MAAM,GAAG,IAAI,WAAW,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"}

package/build/esm/src/models/Space.d.ts

@@ -0,0 +1,25 @@
+import { File, IFile } from "./store/File.js";
+export declare const 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.
+ *
+ * This has the same properties as a file stored in a filesystem and as such is represented.
+ */
+export interface ISpace extends IFile {
+    kind: typeof Kind;
+}
+/**
+ * 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.
+ */
+export declare class Space extends File {
+    kind: string;
+    static fromName(name: string, owner?: string): Space;
+    constructor(input?: string | ISpace);
+    new(init: ISpace): void;
+    static isProject(input: unknown): boolean;
+    toJSON(): ISpace;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"Space.js","sourceRoot":"","sources":["../../../../src/models/Space.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAChC,OAAO,EAAE,YAAY,EAAE,IAAI,EAAS,MAAM,iBAAiB,CAAC;AAE5D,MAAM,CAAC,MAAM,IAAI,GAAG,YAAY,CAAC;AAajC;;;;GAIG;AACH,MAAM,OAAO,KAAM,SAAQ,IAAI;IACpB,IAAI,GAAG,IAAI,CAAC;IAErB,MAAM,CAAU,QAAQ,CAAC,IAAY,EAAE,KAAK,GAAG,YAAY;QACzD,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,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,IAAI;gBACV,GAAG,EAAE,EAAE,EAAE;gBACT,KAAK,EAAE,EAAE;gBACT,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;gBACjC,KAAK,EAAE,YAAY;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,IAAI,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,KAAc;QAC7B,MAAM,KAAK,GAAG,KAAe,CAAC;QAC9B,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,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,IAAI;SACX,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/build/esm/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/esm/src/models/Thing.js

@@ -0,0 +1,103 @@
+import { ThingKind } from "./kinds.js";
+export class Thing {
+    kind = 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: 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: 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 = 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 === ThingKind) {
+            return true;
+        }
+        return false;
+    }
+    toJSON() {
+        const result = {
+            kind: 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;
+    }
+}
+//# sourceMappingURL=Thing.js.map