@api-client/core 0.9.25 → 0.10.1

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

@@ -0,0 +1,165 @@
+import { IProperty } from './Property.js';
+import { IMultipartBody, ISafePayload } from '../lib/transformers/PayloadSerializer.js';
+import { RequestUiMeta as LegacyRequestUiMeta } from './legacy/request/ArcRequest.js';
+export declare const Kind = "Core#RequestUiMeta";
+/**
+ * URL editor meta data.
+ */
+export interface IUrlMeta {
+    /**
+     * The model generated for the URL parameters.
+     */
+    model?: IProperty[];
+    /**
+     * The query params delimiter. By default it is `&`.
+     */
+    delimiter?: string;
+}
+/**
+ * Headers editor meta data.
+ */
+export interface IHeadersMeta {
+    /**
+     * The model generated for the headers editor.
+     */
+    model?: IProperty[];
+    /**
+     * Whether the source editor is opened.
+     */
+    source?: boolean;
+}
+export interface IAuthMeta {
+    /**
+     * The index of the selected authorization method.
+     */
+    selected?: number;
+}
+export interface IResponseUiMeta {
+    /**
+     * The list of activated panels in the response view.
+     */
+    activePanels?: string[];
+    /**
+     * The name of the selected response panel.
+     */
+    selectedPanel?: string;
+}
+/**
+ * The body editor may produce multiple view models
+ * for the UI. Each editor can store it's data in here
+ * to restore it after opening a request,
+ */
+export interface IBodyMetaModel {
+    /**
+     * The id of the editor. Each editor in API Client has own id.
+     */
+    type: string;
+    /**
+     * Generated view model.
+     */
+    viewModel: (IProperty | ISafePayload | IMultipartBody | IRawBody | IUrlEncodedBodyMeta)[];
+}
+export interface IUrlEncodedBodyMeta {
+    /**
+     * Whether the body should be automatically encoded before sending the value.
+     */
+    autoEncode?: boolean;
+    /**
+     * The model generated for the body editor.
+     */
+    model?: IProperty[];
+}
+/**
+ * Body editor meta data.
+ */
+export interface IBodyMeta {
+    /**
+     * The model generated for the body editor.
+     */
+    model?: IBodyMetaModel[];
+    /**
+     * The selected editor
+     */
+    selected?: string;
+}
+export interface IRawBody {
+    /**
+     * The last used body value.
+     */
+    value: string;
+    /**
+     * True when the generator was used to build the value
+     */
+    isGenerator?: boolean;
+    /**
+     * The schema for the generator. Work in progress.
+     */
+    generatorSchema?: unknown;
+}
+/**
+ * UI configuration for the request.
+ */
+export interface IRequestUiMeta {
+    kind?: typeof Kind;
+    /**
+     * Body editor metadata.
+     */
+    body?: IBodyMeta;
+    /**
+     * URL editor metadata.
+     */
+    url?: IUrlMeta;
+    /**
+     * Headers editor metadata.
+     */
+    headers?: IHeadersMeta;
+    /**
+     * Authorization editor meta.
+     */
+    authorization?: IAuthMeta;
+    /**
+     * The currently selected editor in the request editor UI.
+     */
+    selectedEditor?: string;
+    /**
+     * Optional configuration of the response view
+     */
+    response?: IResponseUiMeta;
+}
+export declare class RequestUiMeta {
+    kind: string;
+    /**
+     * Body editor metadata.
+     */
+    body?: IBodyMeta;
+    /**
+     * URL editor metadata.
+     */
+    url?: IUrlMeta;
+    /**
+     * Headers editor metadata.
+     */
+    headers?: IHeadersMeta;
+    /**
+     * Authorization editor meta.
+     */
+    authorization?: IAuthMeta;
+    /**
+     * The currently selected editor in the request editor UI.
+     */
+    selectedEditor?: string;
+    /**
+     * Optional configuration of the response view
+     */
+    response?: IResponseUiMeta;
+    static fromLegacy(old: LegacyRequestUiMeta): RequestUiMeta;
+    /**
+     * @param input The project item definition used to restore the state.
+     */
+    constructor(input?: string | IRequestUiMeta);
+    /**
+     * Creates a new object clearing anything that is so far defined.
+     */
+    new(init: IRequestUiMeta): void;
+    toJSON(): IRequestUiMeta;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"RequestUiMeta.js","sourceRoot":"","sources":["../../../../src/models/RequestUiMeta.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,QAAQ,EAAE,MAAM,eAAe,CAAC;AAIpD,MAAM,CAAC,MAAM,IAAI,GAAG,oBAAoB,CAAC;AAuIzC,MAAM,OAAO,aAAa;IACxB,IAAI,GAAG,IAAI,CAAC;IACZ;;OAEG;IACH,IAAI,CAAa;IACjB;;OAEG;IACH,GAAG,CAAY;IACf;;OAEG;IACH,OAAO,CAAgB;IACvB;;OAEG;IACH,aAAa,CAAa;IAC1B;;OAEG;IACH,cAAc,CAAU;IACxB;;OAEG;IACH,QAAQ,CAAmB;IAE3B,MAAM,CAAC,UAAU,CAAC,GAAwB;QACxC,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC;QAC5D,MAAM,IAAI,GAAmB;YAC3B,aAAa;YACb,IAAI;YACJ,QAAQ;SACT,CAAC;QACF,IAAI,GAAG,EAAE;YACP,MAAM,OAAO,GAAa,EAAE,CAAC;YAC7B,IAAI,GAAG,CAAC,SAAS,EAAE;gBACjB,OAAO,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;aACnC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE;gBAChD,OAAO,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;aACtE;YACD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC;SACpB;QACD,IAAI,OAAO,EAAE;YACX,MAAM,UAAU,GAAiB,EAAE,CAAC;YACpC,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE;gBACvC,UAAU,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;aACpC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE;gBACxD,UAAU,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;aAC7E;YACD,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC;SACvB;QACD,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,YAAY,KAA+B;QACzC,IAAI,IAAoB,CAAC;QACzB,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,EAAE,CAAC;SACX;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,IAAoB;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACpB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;IAChC,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAmB;YAC7B,IAAI,EAAE,IAAI;SACX,CAAC;QACF,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;SACzB;QACD,IAAI,IAAI,CAAC,GAAG,EAAE;YACZ,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;SACvB;QACD,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;SAC/B;QACD,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;SAC3C;QACD,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;SACjC;QACD,IAAI,OAAO,IAAI,CAAC,cAAc,KAAK,QAAQ,EAAE;YAC3C,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;SAC7C;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

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

@@ -0,0 +1,32 @@
+export declare const Kind = "Core#ResponseSize";
+export interface IRequestsSize {
+    kind?: typeof Kind;
+    /**
+     * The size of the request in bytes
+     */
+    request: number;
+    /**
+     * The size of the response in bytes
+     */
+    response: number;
+}
+export declare class RequestsSize {
+    kind: string;
+    /**
+     * The size of the request in bytes
+     */
+    request: number;
+    /**
+     * The size of the response in bytes
+     */
+    response: number;
+    /**
+     * @param input The response size definition used to restore the state.
+     */
+    constructor(input?: string | IRequestsSize);
+    /**
+     * Creates a new response size clearing anything that is so far defined.
+     */
+    new(init: IRequestsSize): void;
+    toJSON(): IRequestsSize;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"RequestsSize.js","sourceRoot":"","sources":["../../../../src/models/RequestsSize.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG,mBAAmB,CAAC;AAcxC,MAAM,OAAO,YAAY;IACvB,IAAI,GAAG,IAAI,CAAC;IACZ;;OAEG;IACH,OAAO,GAAG,CAAC,CAAC;IACZ;;OAEG;IACH,QAAQ,GAAG,CAAC,CAAC;IAEb;;OAEG;IACH,YAAY,KAA4B;QACtC,IAAI,IAAmB,CAAC;QACxB,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,QAAQ,EAAE,CAAC;aACZ,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,IAAmB;QACrB,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAkB;YAC5B,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

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

@@ -0,0 +1,60 @@
+import { IHttpResponse, HttpResponse } from './HttpResponse.js';
+import { IRequestTime, RequestTime } from './RequestTime.js';
+import { IResponseAuthorization, ResponseAuthorization } from './ResponseAuthorization.js';
+import { Response as LegacyResponse } from './legacy/request/ArcResponse.js';
+/**
+ * An HTTP response object.
+ */
+export interface IResponse extends IHttpResponse {
+    /**
+     * The request timings.
+     * Some HTTP clients may not give this information.
+     */
+    timings?: IRequestTime;
+    /**
+     * The total loading time (from sending the request to receive the last byte)
+     */
+    loadingTime: number;
+    /**
+     * The authentication request from the server.
+     */
+    auth?: IResponseAuthorization;
+}
+export declare class Response extends HttpResponse {
+    /**
+     * The request timings.
+     * Some HTTP clients may not give this information.
+     */
+    timings?: RequestTime;
+    /**
+     * The total loading time (from sending the request to receive the last byte)
+     */
+    loadingTime: number;
+    /**
+     * The authentication request from the server.
+     */
+    auth?: ResponseAuthorization;
+    static fromValues(status: number, statusText?: string, headers?: string): Response;
+    static fromLegacy(input: LegacyResponse): Promise<Response>;
+    /**
+     * @param input The response definition used to restore the state.
+     */
+    constructor(input?: string | IResponse);
+    /**
+     * Creates a new response clearing anything that is so far defined.
+     */
+    new(init: IResponse): void;
+    toJSON(): IResponse;
+    /**
+     * Checks whether the object (JSON Object) is an Error response.
+     */
+    static isErrorResponse(input: unknown): boolean;
+    /**
+     * Creates the RequestTime object from the passed object.
+     */
+    setTimings(timings: IRequestTime): void;
+    /**
+     * Sets the authorization data on the response.
+     */
+    setAuth(auth: IResponseAuthorization): void;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"Response.js","sourceRoot":"","sources":["../../../../src/models/Response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAgB,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAA0B,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAG3F,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAC7E,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAqB9C,MAAM,OAAO,QAAS,SAAQ,YAAY;IACxC;;;OAGG;IACH,OAAO,CAAe;IACtB;;OAEG;IACH,WAAW,GAAG,CAAC,CAAC;IAChB;;OAEG;IACH,IAAI,CAAyB;IAE7B,MAAM,CAAU,UAAU,CAAC,MAAc,EAAE,UAAmB,EAAE,OAAgB;QAC9E,OAAO,IAAI,QAAQ,CAAC;YAClB,IAAI,EAAE,gBAAgB;YACtB,MAAM;YACN,UAAU;YACV,OAAO;YACP,WAAW,EAAE,CAAC;SACf,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,UAAU,CAAC,KAAqB;QACpD,MAAM,IAAI,GAAc;YACtB,IAAI,EAAE,gBAAgB;YACtB,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC;YACzB,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,CAAC;SACpC,CAAC;QACF,IAAI,KAAK,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;SAC9B;QACD,IAAI,KAAK,CAAC,UAAU,EAAE;YACpB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;SACpC;QACD,IAAI,KAAK,CAAC,OAAO,EAAE;YACjB,MAAM,IAAI,GAAG,UAAU,CAAC,yBAAyB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACjE,IAAI,IAAI,EAAE;gBACR,IAAI,CAAC,OAAO,GAAG,MAAM,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;aACxD;SACF;aAAM,IAAI,KAAK,CAAC,IAAI,EAAE;YACrB,IAAI,CAAC,OAAO,GAAG;gBACb,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,KAAK,CAAC,IAAI;aACjB,CAAC;SACH;aAAM,IAAI,KAAK,CAAC,SAAS,EAAE;YAC1B,IAAI,CAAC,OAAO,GAAG;gBACb,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,KAAK,CAAC,SAAS;aACtB,CAAC;SACH;QACD,IAAI,KAAK,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;SACxD;QACD,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,YAAY,KAAwB;QAClC,KAAK,EAAE,CAAC;QACR,IAAI,IAAe,CAAC;QACpB,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,gBAAgB;gBACtB,MAAM,EAAE,CAAC;gBACT,WAAW,EAAE,CAAC;aACf,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED;;OAEG;IACM,GAAG,CAAC,IAAe;QAC1B,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChB,MAAM,EAAE,WAAW,GAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAC9C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;SACzC;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;SAC1B;QACD,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC;SAC7C;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;SACvB;IACH,CAAC;IAEQ,MAAM;QACb,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,EAAe,CAAC;QAC7C,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACxC,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;SAC1C;QACD,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;SACpC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,eAAe,CAAC,KAAc;QACnC,MAAM,KAAK,GAAG,KAAuB,CAAC;QACtC,IAAI,KAAK,CAAC,KAAK,EAAE;YACf,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,OAAqB;QAC9B,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,IAA4B;QAClC,IAAI,CAAC,IAAI,GAAG,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC;CACF"}

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

@@ -0,0 +1,54 @@
+export declare const Kind = "Core#ResponseAuthorization";
+export interface IResponseAuthorization {
+    kind: typeof Kind;
+    /**
+     * The requested by the authorization server authentication method
+     */
+    method: string;
+    /**
+     * The current state if the authorization process. This is used by NTLM authorization helper.
+     */
+    state?: number;
+    /**
+     * The headers association with the response.
+     */
+    headers?: string;
+    /**
+     * When returned by the server, the value of the challenge.
+     */
+    challengeHeader?: string;
+}
+export declare class ResponseAuthorization {
+    kind: string;
+    /**
+     * The requested by the authorization server authentication method
+     */
+    method: string;
+    /**
+     * The current state if the authorization process. This is used by NTLM authorization helper.
+     */
+    state?: number;
+    /**
+     * The headers association with the response.
+     */
+    headers?: string;
+    /**
+     * When returned by the server, the value of the challenge.
+     */
+    challengeHeader?: string;
+    /**
+     * @param input The response authorization definition used to restore the state.
+     */
+    constructor(input?: string | IResponseAuthorization);
+    /**
+     * Creates a new response authorization clearing anything that is so far defined.
+     *
+     * Note, this throws an error when the object is not a response authorization.
+     */
+    new(init: IResponseAuthorization): void;
+    /**
+     * Checks whether the input is a definition of a response authorization.
+     */
+    static isResponseAuthorization(input: unknown): boolean;
+    toJSON(): IResponseAuthorization;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"ResponseAuthorization.js","sourceRoot":"","sources":["../../../../src/models/ResponseAuthorization.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG,4BAA4B,CAAC;AAsBjD,MAAM,OAAO,qBAAqB;IAChC,IAAI,GAAG,IAAI,CAAC;IACZ;;OAEG;IACH,MAAM,GAAG,SAAS,CAAC;IACnB;;OAEG;IACH,KAAK,CAAU;IACf;;OAEG;IACH,OAAO,CAAU;IACjB;;OAEG;IACH,eAAe,CAAU;IAEzB;;OAEG;IACH,YAAY,KAAqC;QAC/C,IAAI,IAA4B,CAAC;QACjC,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,MAAM,EAAE,SAAS;aAClB,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,IAA4B;QAC9B,IAAI,CAAC,qBAAqB,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE;YACxD,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;SAClD;QACD,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC;QACzD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,uBAAuB,CAAC,KAAc;QAC3C,MAAM,KAAK,GAAG,KAA+B,CAAC;QAC9C,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YAC3B,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAA2B;YACrC,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC;QACF,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE;YAClC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;SAC3B;QACD,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;SAC/B;QACD,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;SAC/C;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

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.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;
+}