@api-client/core 0.9.24 → 0.10.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"Thing.js","sourceRoot":"","sources":["../../../../src/models/Thing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AA6BvC,MAAM,OAAO,KAAK;IAChB,IAAI,GAAG,SAAS,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,SAAS;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,SAAS;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,SAAS,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,SAAS,EAAE;YACrC,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAW;YACrB,IAAI,EAAE,SAAS;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"}

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

@@ -0,0 +1,46 @@
+import { IDeletion } from "./store/Deletion.js";
+export interface TrashEntryCreate {
+    /**
+     * The store key of the object that has been deleted.
+     */
+    file: string;
+    /**
+     * The kind of the delete object.
+     */
+    kind: string;
+    /**
+     * The name of the deleted object.
+     *
+     * If the object does not have a name then it shouldn't be here.
+     */
+    name: string;
+}
+/**
+ * The trash entry object capabilities for the current user.
+ * Note, this information has no effect on the backend and only tells the client application
+ * what operations on the file are permitted.
+ */
+export interface TrashCapabilities {
+    /**
+     * Whether the current user can restore the file.
+     */
+    canRestore: boolean;
+    /**
+     * Whether the current user can permanently delete the file.
+     */
+    canDelete: boolean;
+}
+export interface TrashEntry extends TrashEntryCreate {
+    /**
+     * The key of the trash entry.
+     */
+    key: string;
+    /**
+     * The delete info.
+     */
+    info: IDeletion;
+    /**
+     * Trash entry capabilities for the user.
+     */
+    capabilities: TrashCapabilities;
+}

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

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

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

@@ -0,0 +1,49 @@
+export interface IUrl {
+    /**
+     * A number of times the URL was used
+     */
+    cnt: number;
+    /**
+     * Last use timestamp.
+     */
+    time: number;
+    /**
+     * The request URL stored in the history. This is also the store key.
+     */
+    key: string;
+    /**
+     * A timestamp of the midnight that corresponds to the `time` property.
+     */
+    midnight?: number;
+}
+/**
+ * An object representing an URL stored in the data store.
+ * This is an URL used to make a request.
+ */
+export declare class Url {
+    /**
+     * A number of times the URL was used
+     */
+    cnt: number;
+    /**
+     * Last use timestamp.
+     */
+    time: number;
+    /**
+     * The request URL stored in the history. This is also the store key.
+     */
+    key: string;
+    /**
+     * A timestamp of the midnight that corresponds to the `time` property.
+     */
+    midnight?: number;
+    /**
+     * @param input The URL definition used to restore the state.
+     */
+    constructor(input: string | IUrl);
+    /**
+     * Creates a new URL clearing anything that is so far defined.
+     */
+    new(init: IUrl): void;
+    toJSON(): IUrl;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"Url.js","sourceRoot":"","sources":["../../../../src/models/Url.ts"],"names":[],"mappings":"AAoBA;;;GAGG;AACH,MAAM,OAAO,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"}

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

@@ -0,0 +1,119 @@
+export declare const Kind = "Core#WebApi";
+/**
+ * @deprecated This was used in the old version of ARC.
+ */
+export interface ILegacyRestApi {
+    /**
+     * The ID of the index item that this entry refers to.
+     */
+    indexId: string;
+    /**
+     * Version name of the API
+     */
+    version: string;
+    /**
+     * API data model. It is the output of the AMF parser run on the API.
+     */
+    data: string;
+    /**
+     * The AMF parser version used to parse this document.
+     */
+    amfVersion?: string;
+}
+export interface IWebApi {
+    kind: typeof Kind;
+    /**
+     * The ID of the index item that this entry refers to.
+     */
+    indexId: string;
+    /**
+     * Version name of the API
+     */
+    version: string;
+    /**
+     * API data model. It is the output of the AMF parser run on the API.
+     * This is left for compatibility.
+     * @deprecated This was used in the old version of ARC. v18 uses the `path` with the location of the API project.
+     */
+    data?: string;
+    /**
+     * The AMF parser version used to parse this document.
+     * This is left for compatibility.
+     * @deprecated This was used in the old version of ARC. v18 does not use this information.
+     */
+    amfVersion?: string;
+    /**
+     * The location of the API project. This can be any URI to get the sources of the API project.
+     */
+    path: string;
+    /**
+     * Optional information to point to the API's main file.
+     */
+    main?: string;
+    /**
+     * The API format's media type.
+     */
+    mime?: string;
+    /**
+     * The API vendor. E.g. RAML 1.0, OAS 3.0, ASYNC 2.0, ...
+     */
+    vendor?: string;
+}
+export declare class WebApi {
+    kind: string;
+    /**
+     * The ID of the index item that this entry refers to.
+     */
+    indexId: string;
+    /**
+     * Version name of the API
+     */
+    version: string;
+    /**
+     * API data model. It is the output of the AMF parser run on the API.
+     * This is left for compatibility.
+     * @deprecated This was used in the old version of ARC. v18 uses the `path` with the location of the API project.
+     */
+    data?: string;
+    /**
+     * The AMF parser version used to parse this document.
+     * This is left for compatibility.
+     * @deprecated This was used in the old version of ARC. v18 does not use this information.
+     */
+    amfVersion?: string;
+    /**
+     * The location of the API project. This can be any URI to get the sources of the API project.
+     */
+    path: string;
+    /**
+     * Optional information to point to the API's main file.
+     */
+    main?: string;
+    /**
+     * The API format's media type.
+     */
+    mime?: string;
+    /**
+     * The API vendor. E.g. RAML 1.0, OAS 3.0, ASYNC 2.0, ...
+     */
+    vendor?: string;
+    /**
+     * Checks whether the object represents a legacy way of storing the web API data.
+     */
+    get isLegacy(): boolean;
+    /**
+     * Checks whether the object is the legacy schema for web API (formally known as RestAPI)
+     */
+    static isLegacy(api: unknown): boolean;
+    static fromLegacy(api: ILegacyRestApi): WebApi;
+    /**
+     * Creates an identifier of this web API object.
+     * @param indexId The id of the corresponding index item. This is usually the base URI of the API.
+     * @param version The version name of this web API.
+     * @returns The unique and reversible identifier of this web API.
+     */
+    static createId(indexId: string, version: string): string;
+    constructor(input?: string | IWebApi);
+    new(init: IWebApi): void;
+    toJSON(): IWebApi;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"WebApi.js","sourceRoot":"","sources":["../../../../src/models/WebApi.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG,aAAa,CAAC;AAgElC,MAAM,OAAO,MAAM;IACjB,IAAI,GAAG,IAAI,CAAC;IACZ;;OAEG;IACH,OAAO,GAAG,EAAE,CAAC;IACb;;OAEG;IACH,OAAO,GAAG,EAAE,CAAC;IACb;;;;OAIG;IACH,IAAI,CAAU;IACd;;;;OAIG;IACH,UAAU,CAAU;IACpB;;OAEG;IACH,IAAI,GAAG,EAAE,CAAC;IACV;;OAEG;IACH,IAAI,CAAU;IACd;;OAEG;IACH,IAAI,CAAU;IACd;;OAEG;IACH,MAAM,CAAU;IAEhB;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,GAAY;QAC1B,MAAM,MAAM,GAAG,GAAqB,CAAC;QACrC,IAAI,MAAM,CAAC,IAAI,EAAE;YACf,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,GAAmB;QACnC,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC;QACnD,MAAM,IAAI,GAAY;YACpB,IAAI,EAAE,IAAI;YACV,OAAO;YACP,IAAI,EAAE,EAAE;YACR,OAAO;SACR,CAAC;QACF,IAAI,UAAU,EAAE;YACd,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;SAC9B;QACD,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;SAClB;QACD,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,OAAe,EAAE,OAAe;QAC9C,OAAO,GAAG,OAAO,IAAI,OAAO,EAAE,CAAC;IACjC,CAAC;IAED,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,OAAO,EAAE,EAAE;gBACX,IAAI,EAAE,EAAE;gBACR,OAAO,EAAE,EAAE;aACZ,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,GAAG,CAAC,IAAa;QACf,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAC9E,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;SACxB;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;SACnB;QACD,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;SACxB;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;SACnB;QACD,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;SAClB;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;SACvB;QACD,IAAI,UAAU,EAAE;YACd,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;SAC9B;aAAM;YACL,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;SAC7B;QACD,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;SAClB;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;SAChB;QACD,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;SAClB;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,SAAS,CAAA;SACtB;QACD,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;SAClB;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;SAClB;QACD,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACtB;aAAM;YACL,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;SACzB;IACH,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAY;YACtB,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;QACF,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;SACzB;QACD,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;SACrC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;SACzB;QACD,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;SACzB;QACD,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;SAC7B;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

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

@@ -0,0 +1,70 @@
+export declare const Kind = "Core#WebApiIndex";
+/**
+ * @deprecated This was used in the old version of ARC.
+ */
+export interface ILegacyWebApiIndex {
+    /**
+     * API title
+     */
+    title: string;
+    /**
+     * API media type
+     * @deprecated This has been renamed to `vendor`.
+     */
+    type: string;
+    /**
+     * API order on the list
+     */
+    order: number;
+    /**
+     * List of version names stored with this API.
+     */
+    versions: string[];
+    /**
+     * The latest added version name.
+     */
+    latest: string;
+}
+export interface IWebApiIndex {
+    kind: typeof Kind;
+    /**
+     * API title
+     */
+    title: string;
+    /**
+     * List of version names stored with this API.
+     */
+    versions: string[];
+    /**
+     * The latest added version name.
+     */
+    latest: string;
+    /**
+     * The API vendor. E.g. RAML 1.0, OAS 3.0, ASYNC 2.0, ...
+     */
+    vendor: string;
+}
+export declare class WebApiIndex {
+    kind: string;
+    /**
+     * API title
+     */
+    title: string;
+    /**
+     * List of version names stored with this API.
+     */
+    versions: string[];
+    /**
+     * The latest added version name.
+     */
+    latest: string;
+    /**
+     * The API vendor. E.g. RAML 1.0, OAS 3.0, ASYNC 2.0, ...
+     */
+    vendor: string;
+    static isLegacy(api: unknown): boolean;
+    static fromLegacy(api: ILegacyWebApiIndex): WebApiIndex;
+    constructor(input?: string | IWebApiIndex);
+    new(init: IWebApiIndex): void;
+    toJSON(): IWebApiIndex;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"WebApiIndex.js","sourceRoot":"","sources":["../../../../src/models/WebApiIndex.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG,kBAAkB,CAAC;AAiDvC,MAAM,OAAO,WAAW;IACtB,IAAI,GAAG,IAAI,CAAC;IACZ;;OAEG;IACH,KAAK,GAAG,EAAE,CAAC;IACX;;OAEG;IACH,QAAQ,GAAa,EAAE,CAAC;IACxB;;OAEG;IACH,MAAM,GAAG,EAAE,CAAC;IACZ;;OAEG;IACH,MAAM,GAAG,EAAE,CAAC;IAEZ,MAAM,CAAC,QAAQ,CAAC,GAAY;QAC1B,MAAM,MAAM,GAAG,GAAyB,CAAC;QACzC,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,GAAuB;QACvC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,GAAC,EAAE,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;QACjD,MAAM,IAAI,GAAiB;YACzB,IAAI,EAAE,IAAI;YACV,KAAK;YACL,QAAQ;YACR,MAAM;YACN,MAAM,EAAE,IAAI;SACb,CAAC;QACF,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,YAAY,KAA2B;QACrC,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,MAAM,EAAE,EAAE;gBACV,KAAK,EAAE,EAAE;gBACT,MAAM,EAAE,EAAE;gBACV,QAAQ,EAAE,EAAE;aACb,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,GAAG,CAAC,IAAkB;QACpB,MAAM,EAAE,MAAM,GAAC,EAAE,EAAE,KAAK,GAAC,EAAE,EAAE,MAAM,GAAC,EAAE,EAAE,QAAQ,GAAC,EAAE,EAAE,GAAG,IAAI,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAiB;YAC3B,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/build/esm/src/models/data/Bindings.d.ts

@@ -0,0 +1,161 @@
+import { IApiXmlSerializer } from "../../amf/definitions/Shapes.js";
+/**
+ * A general schema definition for a property. This is propagated to all bindings (when they support these properties).
+ */
+export interface IPropertySchema {
+    /**
+     * The enum values for the property.
+     * They are always encoded as strings. The actual type is defined in the `dataType` property.
+     */
+    enum?: string[];
+    /**
+     * The default value for the property.
+     * This is always encoded as a string. The actual type is defined in the `dataType` property.
+     */
+    defaultValue?: string;
+    /**
+     * The example values for the property.
+     * They are always encoded as strings. The actual type is defined in the `dataType` property.
+     */
+    examples?: string[];
+}
+/**
+ * Binding for web API schema types (RAML, OAS)
+ *
+ * Data type translation (type to dataType)
+ *
+ * - `string` -> `string` with appropriate format
+ * - `number` -> `number` data type with format `float`, `double`, or none format for OAS
+ * - `integer` -> `integer` data type with `int32`, `int64`, or none format for OAS
+ * - `nil` -> `nullable` property on OAS or `nil` type in RAML
+ * - `boolean` -> `boolean` (both the same)
+ * - `date` ->
+ * - `any` -> `any` in RAML, `{}` shorthand in OAS
+ *
+ *
+ *
+ * The `binary` type
+ *
+ * OAS
+ *
+ * `http://www.w3.org/2001/XMLSchema#byte` For a file
+ * `http://www.w3.org/2001/XMLSchema#base64Binary` for base 64
+ *
+ * RAML
+ *
+ * Has it's own AMF shape: FileShape.
+ *
+ * The `data` type
+ *
+ * OAS
+ *
+ * `http://www.w3.org/2001/XMLSchema#date` for a `date`
+ * `http://www.w3.org/2001/XMLSchema#dateTime` for a `datetime` and `time`.
+ * Note, OAS has no concept of `time` do we add `time` as the `format which is a custom thing.
+ *
+ * RAML
+ *
+ * `http://www.w3.org/2001/XMLSchema#date` for a `date` (raml's date-only)
+ * `http://a.ml/vocabularies/shapes#dateTimeOnly` for a `time` (raml's time-only)
+ * `http://www.w3.org/2001/XMLSchema#dateTime` for a `datetime` (raml's datetime) + format
+ *
+ * Note, we won't support RAML's `datetime-only`.
+ */
+export interface IPropertyWebBindings {
+    /**
+     * When set it overrides the `name` of the property.
+     */
+    name?: string;
+    /**
+     * The data type of the property consistent with AMF's data types.
+     */
+    dataType?: string;
+    /**
+     * The XML encoding instructions.
+     */
+    xml?: IApiXmlSerializer;
+    /**
+     * Only valid for the `file` property type.
+     * The list of file mime types.
+     */
+    fileTypes?: string[];
+    /**
+     * The patter to use wit a string scalar
+     */
+    pattern?: string;
+    /**
+     * Minimum length of a string scalar or a file type.
+     */
+    minLength?: number;
+    /**
+     * Maximum length of a string scalar or a file type.
+     */
+    maxLength?: number;
+    /**
+     * Minimum value for a number scalar.
+     */
+    minimum?: number;
+    /**
+     * Maximum value for a number scalar.
+     */
+    maximum?: number;
+    /**
+     * The multiplier value for a number scalar.
+     */
+    multipleOf?: number;
+    /**
+     * When `false`: value ≥ minimum.
+     * When `true`: value > minimum.
+     */
+    exclusiveMinimum?: boolean;
+    /**
+     * When `false`: value ≤ maximum.
+     * When `true`: value < minimum.
+     */
+    exclusiveMaximum?: boolean;
+    format?: 'float' | 'double' | 'int32' | 'int64' | 'date' | 'date-time' | 'password' | 'binary' | 'byte' | 'email' | 'uuid' | 'uri' | 'hostname' | 'ipv4' | 'ipv6' | string | 'rfc3339' | 'rfc2616';
+}
+/**
+ * Binding to the protocol buffer.
+ *
+ * Data type translation (type to dataType)
+ *
+ * - `string` -> `string`
+ * - `number` -> `double`, `float`
+ * - `integer` -> `int32`, `int64`, `uint32`, `uint64`, `sint32`, `sint64`, `fixed32`, `fixed64`, `sfixed32`, `sfixed64`
+ * - `nil` -> No translation.
+ * - `boolean` -> `boolean`
+ * - `date` -> No translation, we allow string or number (date string or a timestamp with a combination with format but this is not standard for ProtoBuf)
+ * - `any` -> No translation, the user has to pick any of the data formats.
+ * - `binary` -> `bytes`
+ */
+export interface IPropertyProtobufBindings {
+    /**
+     * The field number in a protocol buffer message
+     */
+    field?: number;
+    /**
+     * Whether this property (field) is reserved
+     */
+    reserved?: boolean;
+    /**
+     * The data type of the property consistent with AMF's data types.
+     */
+    dataType?: string;
+}
+export interface IPropertyBindings {
+    /**
+     * The type of the bindings
+     *
+     * - Protocol buffers: `protobuf`
+     * - RAML or OAS - `web`
+     */
+    type: 'protobuf' | 'web';
+    /**
+     * The definition of the bindings.
+     * The bindings tells how to translated the DataProperty to a specific format.
+     * For example, it allows to define the `dataType` and `format` for RAML / OAS (via the AMF shapes)
+     * or the field number for protocol buffer.
+     */
+    schema: IPropertyProtobufBindings | IPropertyWebBindings;
+}

package/build/esm/src/models/data/Bindings.js.map

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