@api-client/ui 0.0.15 → 0.0.17

package/build/src/amf/store/mixins/AmfStoreDomEventsMixin.d.ts

@@ -0,0 +1,38 @@
+export declare const eventHandler: unique symbol;
+type Constructor<T = object> = new (...args: any[]) => T;
+/**
+ * This mixin adds events listeners for DOM events related to the AMF store.
+ * It does not provide implementations for the functions called by each handler.
+ * This to be mixed in with an instance of the `AmfStoreService`.
+ *
+ * The implementation by default listens on the `window` object.
+ * Set `eventsTarget` property to listen to the events on a specific node.
+ *
+ * @mixin
+ */
+export interface AmfStoreDomEventsMixinInterface {
+    [eventHandler](e: CustomEvent): void;
+    /**
+     * Listens for the store DOM events.
+     */
+    listen(node?: EventTarget): void;
+    /**
+     * Removes store's DOM events.
+     */
+    unlisten(node?: EventTarget): void;
+}
+/**
+ * This mixin adds events listeners for DOM events related to the AMF store.
+ * It does not provide implementations for the functions called by each handler.
+ * This to be mixed in with an instance of the `AmfStoreService`.
+ *
+ * The implementation by default listens on the `window` object.
+ * Set `eventsTarget` property to listen to the events on a specific node.
+ *
+ * @TODO: Add event listeners after removing the events target listener.
+ *
+ * @mixin
+ */
+export declare const AmfStoreDomEventsMixin: <T extends Constructor<any>>(superClass: T) => Constructor<AmfStoreDomEventsMixinInterface> & T;
+export {};
+//# sourceMappingURL=AmfStoreDomEventsMixin.d.ts.map

package/build/src/amf/store/mixins/AmfStoreDomEventsMixin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AmfStoreDomEventsMixin.d.ts","sourceRoot":"","sources":["../../../../../src/amf/store/mixins/AmfStoreDomEventsMixin.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,YAAY,eAAyB,CAAA;AA0BlD,KAAK,WAAW,CAAC,CAAC,GAAG,MAAM,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;AAExD;;;;;;;;;GASG;AACH,MAAM,WAAW,+BAA+B;IAC9C,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;IACpC;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;IAEhC;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;CACnC;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,GAChC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,cAAc,CAAC,KAAG,WAAW,CAAC,+BAA+B,CAAC,GAAG,CA+D7F,CAAA"}

package/build/src/amf/store/mixins/AmfStoreDomEventsMixin.js

@@ -0,0 +1,99 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { dedupeMixin } from '@open-wc/dedupe-mixin';
+import { EventTypes } from '../../../events/amf/EventTypes.js';
+export const eventHandler = Symbol('eventHandler');
+const eventsMap = {
+    [EventTypes.Api.summary]: { target: 'apiSummary' },
+    [EventTypes.Api.protocols]: { target: 'apiProtocols' },
+    [EventTypes.Api.version]: { target: 'apiVersion' },
+    [EventTypes.Api.documentMeta]: { target: 'documentMeta' },
+    [EventTypes.Endpoint.get]: { target: 'getEndpoint', args: ['id'] },
+    [EventTypes.Endpoint.byPath]: { target: 'getEndpointByPath', args: ['id'] },
+    [EventTypes.Endpoint.list]: { target: 'listEndpointsWithOperations' },
+    [EventTypes.Operation.get]: { target: 'getOperation', args: ['id', 'parent'] },
+    [EventTypes.Operation.getParent]: { target: 'getOperationParent', args: ['id'] },
+    [EventTypes.Server.query]: { target: 'queryServers', passDetail: true },
+    [EventTypes.Documentation.list]: { target: 'listDocumentations' },
+    [EventTypes.Documentation.get]: { args: ['id'], target: 'getDocumentation' },
+    [EventTypes.Security.get]: { args: ['id'], target: 'getSecurityScheme' },
+    [EventTypes.Security.getRequirement]: { args: ['id'], target: 'getSecurityRequirement' },
+    [EventTypes.Security.list]: { target: 'listSecurity' },
+    [EventTypes.Request.get]: { args: ['id'], target: 'getRequest' },
+    [EventTypes.Response.get]: { args: ['id'], target: 'getResponse' },
+    [EventTypes.Payload.get]: { args: ['id'], target: 'getPayload' },
+    [EventTypes.Type.list]: { target: 'listTypes' },
+    [EventTypes.Type.get]: { args: ['id'], target: 'getType' },
+};
+/**
+ * This mixin adds events listeners for DOM events related to the AMF store.
+ * It does not provide implementations for the functions called by each handler.
+ * This to be mixed in with an instance of the `AmfStoreService`.
+ *
+ * The implementation by default listens on the `window` object.
+ * Set `eventsTarget` property to listen to the events on a specific node.
+ *
+ * @TODO: Add event listeners after removing the events target listener.
+ *
+ * @mixin
+ */
+export const AmfStoreDomEventsMixin = dedupeMixin((superClass) => {
+    class AmfStoreDomEventsMixinClass extends superClass {
+        /**
+         * @param args Base class arguments
+         */
+        constructor(...args) {
+            super(...args);
+            this[eventHandler] = this[eventHandler].bind(this);
+        }
+        /**
+         * Listens for the store DOM events.
+         */
+        listen(node = window) {
+            Object.keys(eventsMap).forEach((type) => node.addEventListener(type, this[eventHandler]));
+        }
+        /**
+         * Removes store's DOM events.
+         */
+        unlisten(node = window) {
+            Object.keys(eventsMap).forEach((type) => node.removeEventListener(type, this[eventHandler]));
+        }
+        _attachListeners(node) {
+            super._attachListeners(node);
+            this.listen(node);
+        }
+        _detachListeners(node) {
+            super._detachListeners(node);
+            this.unlisten(node);
+        }
+        [eventHandler](e) {
+            if (e.defaultPrevented) {
+                return;
+            }
+            e.preventDefault();
+            const info = eventsMap[e.type];
+            if (!info) {
+                // eslint-disable-next-line no-console
+                console.warn(`Incorrectly handled event ${e.type}`);
+                return;
+            }
+            const { args, target, passDetail } = info;
+            if (passDetail) {
+                const cp = { ...(e.detail || {}) };
+                e.detail.result = this[target](cp);
+            }
+            else if (!Array.isArray(args) || !args.length) {
+                e.detail.result = this[target]();
+            }
+            else {
+                const params = [];
+                args.forEach((n) => {
+                    const value = info.eventProperties ? e[n] : e.detail[n];
+                    params.push(value);
+                });
+                e.detail.result = this[target](...params);
+            }
+        }
+    }
+    return AmfStoreDomEventsMixinClass;
+});
+//# sourceMappingURL=AmfStoreDomEventsMixin.js.map

package/build/src/amf/store/mixins/AmfStoreDomEventsMixin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AmfStoreDomEventsMixin.js","sourceRoot":"","sources":["../../../../../src/amf/store/mixins/AmfStoreDomEventsMixin.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAE9D,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,cAAc,CAAC,CAAA;AAElD,MAAM,SAAS,GACb;IACE,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE;IAClD,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE;IACtD,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE;IAClD,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE;IACzD,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE;IAClE,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE;IAC3E,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,6BAA6B,EAAE;IACrE,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE;IAC9E,CAAC,UAAU,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE;IAChF,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,IAAI,EAAE;IACvE,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,oBAAoB,EAAE;IACjE,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE;IAC5E,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,mBAAmB,EAAE;IACxE,CAAC,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,wBAAwB,EAAE;IACxF,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE;IACtD,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE;IAChE,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE;IAClE,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE;IAChE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE;IAC/C,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE;CAC3D,CAAA;AA2BH;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,WAAW,CAC/C,CAA6B,UAAa,EAAoD,EAAE;IAC9F,MAAM,2BAA4B,SAAQ,UAAU;QAClD;;WAEG;QACH,YAAY,GAAG,IAAW;YACxB,KAAK,CAAC,GAAG,IAAI,CAAC,CAAA;YACd,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACpD,CAAC;QAED;;WAEG;QACH,MAAM,CAAC,OAAoB,MAAM;YAC/B,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAkB,CAAC,CAAC,CAAA;QAC5G,CAAC;QAED;;WAEG;QACH,QAAQ,CAAC,OAAoB,MAAM;YACjC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAkB,CAAC,CAAC,CAAA;QAC/G,CAAC;QAED,gBAAgB,CAAC,IAAiB;YAChC,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;YAC5B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QACnB,CAAC;QAED,gBAAgB,CAAC,IAAiB;YAChC,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;YAC5B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QACrB,CAAC;QAED,CAAC,YAAY,CAAC,CAAC,CAAc;YAC3B,IAAI,CAAC,CAAC,gBAAgB,EAAE,CAAC;gBACvB,OAAM;YACR,CAAC;YACD,CAAC,CAAC,cAAc,EAAE,CAAA;YAClB,MAAM,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;YAC9B,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,sCAAsC;gBACtC,OAAO,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;gBACnD,OAAM;YACR,CAAC;YACD,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;YACzC,IAAI,UAAU,EAAE,CAAC;gBACf,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,CAAA;gBAClC,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAA;YACpC,CAAC;iBAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBAChD,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,CAAA;YAClC,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,GAAU,EAAE,CAAA;gBACxB,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;oBACjB,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAE,CAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;oBAChE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;gBACpB,CAAC,CAAC,CAAA;gBACF,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,CAAA;YAC3C,CAAC;QACH,CAAC;KACF;IACD,OAAO,2BAA+E,CAAA;AACxF,CAAC,CACF,CAAA","sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { dedupeMixin } from '@open-wc/dedupe-mixin'\nimport { EventTypes } from '../../../events/amf/EventTypes.js'\n\nexport const eventHandler = Symbol('eventHandler')\n\nconst eventsMap: Record<string, { target: string; args?: string[]; eventProperties?: boolean; passDetail?: boolean }> =\n  {\n    [EventTypes.Api.summary]: { target: 'apiSummary' },\n    [EventTypes.Api.protocols]: { target: 'apiProtocols' },\n    [EventTypes.Api.version]: { target: 'apiVersion' },\n    [EventTypes.Api.documentMeta]: { target: 'documentMeta' },\n    [EventTypes.Endpoint.get]: { target: 'getEndpoint', args: ['id'] },\n    [EventTypes.Endpoint.byPath]: { target: 'getEndpointByPath', args: ['id'] },\n    [EventTypes.Endpoint.list]: { target: 'listEndpointsWithOperations' },\n    [EventTypes.Operation.get]: { target: 'getOperation', args: ['id', 'parent'] },\n    [EventTypes.Operation.getParent]: { target: 'getOperationParent', args: ['id'] },\n    [EventTypes.Server.query]: { target: 'queryServers', passDetail: true },\n    [EventTypes.Documentation.list]: { target: 'listDocumentations' },\n    [EventTypes.Documentation.get]: { args: ['id'], target: 'getDocumentation' },\n    [EventTypes.Security.get]: { args: ['id'], target: 'getSecurityScheme' },\n    [EventTypes.Security.getRequirement]: { args: ['id'], target: 'getSecurityRequirement' },\n    [EventTypes.Security.list]: { target: 'listSecurity' },\n    [EventTypes.Request.get]: { args: ['id'], target: 'getRequest' },\n    [EventTypes.Response.get]: { args: ['id'], target: 'getResponse' },\n    [EventTypes.Payload.get]: { args: ['id'], target: 'getPayload' },\n    [EventTypes.Type.list]: { target: 'listTypes' },\n    [EventTypes.Type.get]: { args: ['id'], target: 'getType' },\n  }\n\ntype Constructor<T = object> = new (...args: any[]) => T\n\n/**\n * This mixin adds events listeners for DOM events related to the AMF store.\n * It does not provide implementations for the functions called by each handler.\n * This to be mixed in with an instance of the `AmfStoreService`.\n *\n * The implementation by default listens on the `window` object.\n * Set `eventsTarget` property to listen to the events on a specific node.\n *\n * @mixin\n */\nexport interface AmfStoreDomEventsMixinInterface {\n  [eventHandler](e: CustomEvent): void\n  /**\n   * Listens for the store DOM events.\n   */\n  listen(node?: EventTarget): void\n\n  /**\n   * Removes store's DOM events.\n   */\n  unlisten(node?: EventTarget): void\n}\n\n/**\n * This mixin adds events listeners for DOM events related to the AMF store.\n * It does not provide implementations for the functions called by each handler.\n * This to be mixed in with an instance of the `AmfStoreService`.\n *\n * The implementation by default listens on the `window` object.\n * Set `eventsTarget` property to listen to the events on a specific node.\n *\n * @TODO: Add event listeners after removing the events target listener.\n *\n * @mixin\n */\nexport const AmfStoreDomEventsMixin = dedupeMixin(\n  <T extends Constructor<any>>(superClass: T): Constructor<AmfStoreDomEventsMixinInterface> & T => {\n    class AmfStoreDomEventsMixinClass extends superClass {\n      /**\n       * @param args Base class arguments\n       */\n      constructor(...args: any[]) {\n        super(...args)\n        this[eventHandler] = this[eventHandler].bind(this)\n      }\n\n      /**\n       * Listens for the store DOM events.\n       */\n      listen(node: EventTarget = window): void {\n        Object.keys(eventsMap).forEach((type) => node.addEventListener(type, this[eventHandler] as EventListener))\n      }\n\n      /**\n       * Removes store's DOM events.\n       */\n      unlisten(node: EventTarget = window): void {\n        Object.keys(eventsMap).forEach((type) => node.removeEventListener(type, this[eventHandler] as EventListener))\n      }\n\n      _attachListeners(node: EventTarget): void {\n        super._attachListeners(node)\n        this.listen(node)\n      }\n\n      _detachListeners(node: EventTarget): void {\n        super._detachListeners(node)\n        this.unlisten(node)\n      }\n\n      [eventHandler](e: CustomEvent): void {\n        if (e.defaultPrevented) {\n          return\n        }\n        e.preventDefault()\n        const info = eventsMap[e.type]\n        if (!info) {\n          // eslint-disable-next-line no-console\n          console.warn(`Incorrectly handled event ${e.type}`)\n          return\n        }\n        const { args, target, passDetail } = info\n        if (passDetail) {\n          const cp = { ...(e.detail || {}) }\n          e.detail.result = this[target](cp)\n        } else if (!Array.isArray(args) || !args.length) {\n          e.detail.result = this[target]()\n        } else {\n          const params: any[] = []\n          args.forEach((n) => {\n            const value = info.eventProperties ? (e as any)[n] : e.detail[n]\n            params.push(value)\n          })\n          e.detail.result = this[target](...params)\n        }\n      }\n    }\n    return AmfStoreDomEventsMixinClass as Constructor<AmfStoreDomEventsMixinInterface> & T\n  }\n)\n"]}

package/build/src/amf/types.d.ts

@@ -0,0 +1,319 @@
+import type { ApiDefinitions, AmfShapes } from '@api-client/core/browser.js';
+export interface PopulationInfo {
+    annotationName: string;
+    annotationValue: string;
+    fieldValue: string;
+}
+export interface OperationParameter {
+    /**
+     * Works with the `allowDisableParams` configuration. By default
+     * a parameter is always enabled regardless of this value.
+     * When the `allowDisableParams` is set it uses this value to ignore some parameters (even the required ones).
+     */
+    enabled?: boolean;
+    /**
+     * The parameter definition transformed from the AMF graph model.
+     * This is set for path, query, and header parameters.
+     */
+    parameter: ApiDefinitions.IApiParameter;
+    /**
+     * The schema associated with the parameter. Determines the shape of the user input control.
+     */
+    schema?: AmfShapes.IShapeUnion;
+    /**
+     * Link to `parameter.id`.
+     */
+    paramId: string;
+    /**
+     * Link to `schema.id`.
+     */
+    schemaId?: string;
+    /**
+     * The value of the binding. Determines where the control should be rendered (parameters or headers).
+     */
+    binding: string;
+    /**
+     * A property set to determine from where the object came from. Used internally in the code.
+     */
+    source: string;
+}
+export interface SecuritySelectorListItem {
+    types: (string | undefined)[];
+    labels: (string | undefined)[];
+    security: ApiDefinitions.IApiSecurityRequirement;
+}
+export interface ParameterRenderOptions {
+    /**
+     * When set it overrides the parameter's / schema's required property
+     * and renders the input as required.
+     * This also forces the renderer to force example value when default is not present.
+     */
+    required?: boolean;
+}
+export interface ShapeTemplateOptions extends ParameterRenderOptions {
+    nillable?: boolean;
+    arrayItem?: boolean;
+    index?: number;
+    value?: unknown;
+}
+export interface ComputeBaseUriOptions {
+    /**
+     * The API base URI to use. When not set it computes the base URI from the `server` and `protocols`.
+     */
+    baseUri?: string;
+    /**
+     * When set it uses the server to determine the base URI.
+     * When the `baseUri` is set this value is ignored.
+     * When both are missing then the URL computations ignores the base URI part and reads the path only.
+     */
+    server?: ApiDefinitions.IApiServer;
+    /**
+     * The endpoint definition used to compute path of the URL.
+     * When not set it ignores the path part.
+     */
+    endpoint?: ApiDefinitions.IApiEndPoint;
+    /**
+     * The protocols to use with the computation of the URL.
+     * When the server has no protocol (http or https) defined on the base URI
+     * then these protocols will be used.
+     * If in both cases this is missing then the protocol is not included.
+     * Note, it adds the protocol only when the base URI is defined (from the server).
+     */
+    protocols?: string[];
+    /**
+     * The API version. When set it replaces the `{version}` URI template with the value.
+     */
+    version?: string;
+    /**
+     * When set is forces setting an HTTP protocol (http:) when protocol information is missing in the API spec.
+     */
+    forceHttpProtocol?: boolean;
+}
+export declare interface SelectionInfo {
+    /**
+     * Type of the detected selection
+     */
+    type: string;
+    /**
+     * The normalized value to be used by API editors
+     */
+    value: string;
+}
+export declare interface UpdateServersOptions {
+    /**
+     * The selected node type where servers should be fetched
+     */
+    type?: string;
+    /**
+     * The selected node ID where servers should be fetched
+     */
+    id?: string;
+    /**
+     * Optional endpoint id the method id belongs to
+     */
+    endpointId?: string;
+}
+/**
+ * The selected type
+ *
+ * - `server`: server from the AMF model
+ * - `custom`: custom base URI value (entered by the user)
+ * - `extra`: an application controlled server value selected by the user.
+ */
+export type ServerType = 'server' | 'custom' | 'extra';
+export type SelectionType = 'summary' | 'resource' | 'operation' | 'schema' | 'security' | 'documentation';
+/**
+ * API navigation layout options.
+ *
+ * - tree - creates a tree structure from the endpoints list
+ * - natural - behavior consistent with the previous version of the navigation.
+ *             Creates a tree structure based on the previous endpoints.
+ * - natural-sort - as `natural` but endpoints are sorted by name.
+ * - off (or none) - just like in the API spec.
+ */
+export type NavigationLayout = 'tree' | 'natural' | 'natural-sort' | 'off';
+export interface SelectableMenuItem {
+    /**
+     * Whether the item is a selected menu item.
+     */
+    selected?: boolean;
+    /**
+     * Whether the item has secondary selection.
+     * This happens when a "passive" selection has been applied to the item.
+     */
+    secondarySelected?: boolean;
+}
+export interface EditableMenuItem {
+    /**
+     * When set the name editor for the item is enabled.
+     */
+    nameEditor?: boolean;
+}
+export interface ApiEndPointListItem {
+    /**
+     * The domain id of the endpoint.
+     * It may be undefined when the endpoint is created "abstract" endpoint vor the visualization.
+     */
+    id?: string;
+    path: string;
+    name?: string;
+}
+export interface ApiEndPointWithOperationsListItem extends ApiEndPointListItem {
+    operations: ApiOperationListItem[];
+}
+export interface ApiOperationListItem {
+    id: string;
+    method: string;
+    name?: string;
+}
+export interface ApiEndpointsTreeItem extends ApiEndPointWithOperationsListItem {
+    label: string | undefined;
+    indent: number;
+    hasShortPath?: boolean;
+    hasChildren?: boolean;
+}
+export interface ApiSecuritySchemeListItem {
+    id: string;
+    types: string[];
+    type: string;
+    name?: string;
+    displayName?: string;
+}
+export declare interface ApiNodeShapeListItem {
+    id: string;
+    name?: string;
+    displayName?: string;
+}
+export declare interface EndpointItem extends ApiEndpointsTreeItem, SelectableMenuItem, EditableMenuItem {
+    operations: OperationItem[];
+}
+export declare interface OperationItem extends ApiOperationListItem, SelectableMenuItem, EditableMenuItem {
+}
+export declare interface NodeShapeItem extends ApiNodeShapeListItem, SelectableMenuItem, EditableMenuItem {
+}
+export declare interface SecurityItem extends ApiSecuritySchemeListItem, SelectableMenuItem {
+}
+export declare interface DocumentationItem extends ApiDefinitions.IApiDocumentation, SelectableMenuItem, EditableMenuItem {
+}
+export declare type SchemaAddType = 'scalar' | 'object' | 'file' | 'array' | 'union';
+export declare interface TargetModel {
+    documentation?: DocumentationItem[];
+    types?: NodeShapeItem[];
+    securitySchemes?: SecurityItem[];
+    endpoints?: EndpointItem[];
+    _typeIds?: string[];
+    _basePaths?: string[];
+}
+export declare interface SchemaExample extends AmfShapes.IApiDataExample {
+    /**
+     * The value to render as the example value.
+     */
+    renderValue?: string;
+    label?: string;
+}
+export declare interface ShapeRenderOptions {
+    /**
+     * All selected unions in the current view.
+     * When the processor encounter an union it checks this array
+     * to pick the selected union.
+     * When the selected union cannot be determined it picks the first union.
+     */
+    selectedUnions?: string[];
+    /**
+     * Whether to include optional fields into the schema.
+     * @default false
+     */
+    renderOptional?: boolean;
+    /**
+     * When set it uses the data mocking library to generate the values
+     * when examples and default are not set.
+     */
+    renderMocked?: boolean;
+    /**
+     * The library **always** uses default values in the schema.
+     * When a default value is not set by default it inserts an empty value for
+     * the given data type ('', false, null, random date). When this is set
+     * it includes examples in the generated value.
+     */
+    renderExamples?: boolean;
+}
+export interface MonacoSchema {
+    uri: string;
+    schema: MonacoProperty;
+    fileMatch?: string[];
+}
+export interface MonacoProperty {
+    $id?: string;
+    title: string;
+    type: string;
+    description?: string;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+}
+export interface MonacoScalarProperty extends MonacoProperty {
+    default?: string;
+    pattern?: string;
+    format?: string;
+    exclusiveMaximum?: boolean;
+    exclusiveMinimum?: boolean;
+    maxLength?: number;
+    minLength?: number;
+    minimum?: number;
+    maximum?: number;
+    multipleOf?: number;
+    enum?: string[];
+}
+export interface MonacoObjectProperty extends MonacoProperty {
+    properties: Record<string, MonacoProperty>;
+    required: string[];
+    additionalProperties?: boolean;
+    minProperties?: number;
+    maxProperties?: number;
+}
+export interface MonacoArrayProperty extends MonacoProperty {
+    additionalItems?: boolean;
+    items: {
+        anyOf: MonacoProperty[];
+    };
+    uniqueItems?: boolean;
+    minItems?: number;
+    maxItems?: number;
+    required: string[];
+}
+export interface ApiSchemaReadOptions {
+    /**
+     * Whether the value should be read only when the required property is set.
+     */
+    requiredOnly?: boolean;
+    /**
+     * Whether to read the examples to generate the value.
+     */
+    fromExamples?: boolean;
+}
+export interface DocumentMeta {
+    /**
+     * True when the loaded document represent an API (in an opposite to a fragment or a partial model).
+     */
+    isApi: boolean;
+    /**
+     * Whether the loaded document represent an Async API.
+     */
+    isAsync: boolean;
+    /**
+     * Whether the loaded document represent a RAML fragment / OAS reference.
+     */
+    isFragment: boolean;
+    /**
+     * A special type of fragment that is a RAML library.
+     */
+    isLibrary: boolean;
+    /**
+     * The list of types of the loaded document.
+     */
+    types: string[];
+    /**
+     * The domain id of the `encodes` property.
+     */
+    encodesId?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/src/amf/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/amf/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAA;AAE5E,MAAM,WAAW,cAAc;IAC7B,cAAc,EAAE,MAAM,CAAA;IACtB,eAAe,EAAE,MAAM,CAAA;IACvB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,SAAS,EAAE,cAAc,CAAC,aAAa,CAAA;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,CAAC,WAAW,CAAA;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAA;IAC7B,MAAM,EAAE,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAA;IAC9B,QAAQ,EAAE,cAAc,CAAC,uBAAuB,CAAA;CACjD;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,WAAW,oBAAqB,SAAQ,sBAAsB;IAClE,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC,UAAU,CAAA;IAClC;;;OAGG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC,YAAY,CAAA;IACtC;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B;AAWD,MAAM,CAAC,OAAO,WAAW,aAAa;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,CAAC,OAAO,WAAW,oBAAoB;IAC3C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAA;AACtD,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,UAAU,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,GAAG,eAAe,CAAA;AAC1G;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,KAAK,CAAA;AAE1E,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,iCAAkC,SAAQ,mBAAmB;IAC5E,UAAU,EAAE,oBAAoB,EAAE,CAAA;CACnC;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,oBAAqB,SAAQ,iCAAiC;IAC7E,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,oBAAoB;IAC3C,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,YAAa,SAAQ,oBAAoB,EAAE,kBAAkB,EAAE,gBAAgB;IACtG,UAAU,EAAE,aAAa,EAAE,CAAA;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,aAAc,SAAQ,oBAAoB,EAAE,kBAAkB,EAAE,gBAAgB;CAAG;AAC5G,MAAM,CAAC,OAAO,WAAW,aAAc,SAAQ,oBAAoB,EAAE,kBAAkB,EAAE,gBAAgB;CAAG;AAC5G,MAAM,CAAC,OAAO,WAAW,YAAa,SAAQ,yBAAyB,EAAE,kBAAkB;CAAG;AAC9F,MAAM,CAAC,OAAO,WAAW,iBACvB,SAAQ,cAAc,CAAC,iBAAiB,EACtC,kBAAkB,EAClB,gBAAgB;CAAG;AACvB,MAAM,CAAC,OAAO,MAAM,aAAa,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAA;AAEpF,MAAM,CAAC,OAAO,WAAW,WAAW;IAClC,aAAa,CAAC,EAAE,iBAAiB,EAAE,CAAA;IACnC,KAAK,CAAC,EAAE,aAAa,EAAE,CAAA;IACvB,eAAe,CAAC,EAAE,YAAY,EAAE,CAAA;IAChC,SAAS,CAAC,EAAE,YAAY,EAAE,CAAA;IAC1B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,aAAc,SAAQ,SAAS,CAAC,eAAe;IACtE;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,CAAC,OAAO,WAAW,kBAAkB;IACzC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAA;IACzB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,cAAc,CAAA;IACtB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC1C,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,mBAAoB,SAAQ,cAAc;IACzD,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,KAAK,EAAE;QACL,KAAK,EAAE,cAAc,EAAE,CAAA;KACxB,CAAA;IACD,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAA;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,EAAE,OAAO,CAAA;IACd;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,CAAA;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB"}

package/build/src/amf/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/amf/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ApiDefinitions, AmfShapes } from '@api-client/core/browser.js'\n\nexport interface PopulationInfo {\n  annotationName: string\n  annotationValue: string\n  fieldValue: string\n}\n\nexport interface OperationParameter {\n  /**\n   * Works with the `allowDisableParams` configuration. By default\n   * a parameter is always enabled regardless of this value.\n   * When the `allowDisableParams` is set it uses this value to ignore some parameters (even the required ones).\n   */\n  enabled?: boolean\n  /**\n   * The parameter definition transformed from the AMF graph model.\n   * This is set for path, query, and header parameters.\n   */\n  parameter: ApiDefinitions.IApiParameter\n  /**\n   * The schema associated with the parameter. Determines the shape of the user input control.\n   */\n  schema?: AmfShapes.IShapeUnion\n  /**\n   * Link to `parameter.id`.\n   */\n  paramId: string\n  /**\n   * Link to `schema.id`.\n   */\n  schemaId?: string\n  /**\n   * The value of the binding. Determines where the control should be rendered (parameters or headers).\n   */\n  binding: string\n  /**\n   * A property set to determine from where the object came from. Used internally in the code.\n   */\n  source: string\n}\n\nexport interface SecuritySelectorListItem {\n  types: (string | undefined)[]\n  labels: (string | undefined)[]\n  security: ApiDefinitions.IApiSecurityRequirement\n}\n\nexport interface ParameterRenderOptions {\n  /**\n   * When set it overrides the parameter's / schema's required property\n   * and renders the input as required.\n   * This also forces the renderer to force example value when default is not present.\n   */\n  required?: boolean\n}\n\nexport interface ShapeTemplateOptions extends ParameterRenderOptions {\n  nillable?: boolean\n  arrayItem?: boolean\n  index?: number\n  value?: unknown\n}\n\nexport interface ComputeBaseUriOptions {\n  /**\n   * The API base URI to use. When not set it computes the base URI from the `server` and `protocols`.\n   */\n  baseUri?: string\n  /**\n   * When set it uses the server to determine the base URI.\n   * When the `baseUri` is set this value is ignored.\n   * When both are missing then the URL computations ignores the base URI part and reads the path only.\n   */\n  server?: ApiDefinitions.IApiServer\n  /**\n   * The endpoint definition used to compute path of the URL.\n   * When not set it ignores the path part.\n   */\n  endpoint?: ApiDefinitions.IApiEndPoint\n  /**\n   * The protocols to use with the computation of the URL.\n   * When the server has no protocol (http or https) defined on the base URI\n   * then these protocols will be used.\n   * If in both cases this is missing then the protocol is not included.\n   * Note, it adds the protocol only when the base URI is defined (from the server).\n   */\n  protocols?: string[]\n  /**\n   * The API version. When set it replaces the `{version}` URI template with the value.\n   */\n  version?: string\n  /**\n   * When set is forces setting an HTTP protocol (http:) when protocol information is missing in the API spec.\n   */\n  forceHttpProtocol?: boolean\n}\n\n// export interface OperationParameter {\n//   parameter: ApiDefinitions.IApiParameter;\n//   schema?: ApiShapeUnion;\n//   paramId: string;\n//   schemaId?: string;\n//   binding: string;\n//   source: string;\n// }\n\nexport declare interface SelectionInfo {\n  /**\n   * Type of the detected selection\n   */\n  type: string\n  /**\n   * The normalized value to be used by API editors\n   */\n  value: string\n}\n\nexport declare interface UpdateServersOptions {\n  /**\n   * The selected node type where servers should be fetched\n   */\n  type?: string\n  /**\n   * The selected node ID where servers should be fetched\n   */\n  id?: string\n  /**\n   * Optional endpoint id the method id belongs to\n   */\n  endpointId?: string\n}\n\n/**\n * The selected type\n *\n * - `server`: server from the AMF model\n * - `custom`: custom base URI value (entered by the user)\n * - `extra`: an application controlled server value selected by the user.\n */\nexport type ServerType = 'server' | 'custom' | 'extra'\nexport type SelectionType = 'summary' | 'resource' | 'operation' | 'schema' | 'security' | 'documentation'\n/**\n * API navigation layout options.\n *\n * - tree - creates a tree structure from the endpoints list\n * - natural - behavior consistent with the previous version of the navigation.\n *             Creates a tree structure based on the previous endpoints.\n * - natural-sort - as `natural` but endpoints are sorted by name.\n * - off (or none) - just like in the API spec.\n */\nexport type NavigationLayout = 'tree' | 'natural' | 'natural-sort' | 'off'\n\nexport interface SelectableMenuItem {\n  /**\n   * Whether the item is a selected menu item.\n   */\n  selected?: boolean\n  /**\n   * Whether the item has secondary selection.\n   * This happens when a \"passive\" selection has been applied to the item.\n   */\n  secondarySelected?: boolean\n}\n\nexport interface EditableMenuItem {\n  /**\n   * When set the name editor for the item is enabled.\n   */\n  nameEditor?: boolean\n}\n\nexport interface ApiEndPointListItem {\n  /**\n   * The domain id of the endpoint.\n   * It may be undefined when the endpoint is created \"abstract\" endpoint vor the visualization.\n   */\n  id?: string\n  path: string\n  name?: string\n}\n\nexport interface ApiEndPointWithOperationsListItem extends ApiEndPointListItem {\n  operations: ApiOperationListItem[]\n}\n\nexport interface ApiOperationListItem {\n  id: string\n  method: string\n  name?: string\n}\n\nexport interface ApiEndpointsTreeItem extends ApiEndPointWithOperationsListItem {\n  label: string | undefined\n  indent: number\n  hasShortPath?: boolean\n  hasChildren?: boolean\n}\n\nexport interface ApiSecuritySchemeListItem {\n  id: string\n  types: string[]\n  type: string\n  name?: string\n  displayName?: string\n}\n\nexport declare interface ApiNodeShapeListItem {\n  id: string\n  name?: string\n  displayName?: string\n}\n\nexport declare interface EndpointItem extends ApiEndpointsTreeItem, SelectableMenuItem, EditableMenuItem {\n  operations: OperationItem[]\n}\n\nexport declare interface OperationItem extends ApiOperationListItem, SelectableMenuItem, EditableMenuItem {}\nexport declare interface NodeShapeItem extends ApiNodeShapeListItem, SelectableMenuItem, EditableMenuItem {}\nexport declare interface SecurityItem extends ApiSecuritySchemeListItem, SelectableMenuItem {}\nexport declare interface DocumentationItem\n  extends ApiDefinitions.IApiDocumentation,\n    SelectableMenuItem,\n    EditableMenuItem {}\nexport declare type SchemaAddType = 'scalar' | 'object' | 'file' | 'array' | 'union'\n\nexport declare interface TargetModel {\n  documentation?: DocumentationItem[]\n  types?: NodeShapeItem[]\n  securitySchemes?: SecurityItem[]\n  endpoints?: EndpointItem[]\n  _typeIds?: string[]\n  _basePaths?: string[]\n}\n\nexport declare interface SchemaExample extends AmfShapes.IApiDataExample {\n  /**\n   * The value to render as the example value.\n   */\n  renderValue?: string\n  label?: string\n}\n\nexport declare interface ShapeRenderOptions {\n  /**\n   * All selected unions in the current view.\n   * When the processor encounter an union it checks this array\n   * to pick the selected union.\n   * When the selected union cannot be determined it picks the first union.\n   */\n  selectedUnions?: string[]\n  /**\n   * Whether to include optional fields into the schema.\n   * @default false\n   */\n  renderOptional?: boolean\n  /**\n   * When set it uses the data mocking library to generate the values\n   * when examples and default are not set.\n   */\n  renderMocked?: boolean\n  /**\n   * The library **always** uses default values in the schema.\n   * When a default value is not set by default it inserts an empty value for\n   * the given data type ('', false, null, random date). When this is set\n   * it includes examples in the generated value.\n   */\n  renderExamples?: boolean\n}\n\nexport interface MonacoSchema {\n  uri: string\n  schema: MonacoProperty\n  fileMatch?: string[]\n}\n\nexport interface MonacoProperty {\n  $id?: string\n  title: string\n  type: string\n  description?: string\n  readOnly?: boolean\n  writeOnly?: boolean\n}\n\nexport interface MonacoScalarProperty extends MonacoProperty {\n  default?: string\n  pattern?: string\n  format?: string\n  exclusiveMaximum?: boolean\n  exclusiveMinimum?: boolean\n  maxLength?: number\n  minLength?: number\n  minimum?: number\n  maximum?: number\n  multipleOf?: number\n  enum?: string[]\n}\n\nexport interface MonacoObjectProperty extends MonacoProperty {\n  properties: Record<string, MonacoProperty>\n  required: string[]\n  additionalProperties?: boolean\n  minProperties?: number\n  maxProperties?: number\n}\n\nexport interface MonacoArrayProperty extends MonacoProperty {\n  additionalItems?: boolean\n  items: {\n    anyOf: MonacoProperty[]\n  }\n  uniqueItems?: boolean\n  minItems?: number\n  maxItems?: number\n  required: string[]\n}\n\nexport interface ApiSchemaReadOptions {\n  /**\n   * Whether the value should be read only when the required property is set.\n   */\n  requiredOnly?: boolean\n  /**\n   * Whether to read the examples to generate the value.\n   */\n  fromExamples?: boolean\n}\n\nexport interface DocumentMeta {\n  /**\n   * True when the loaded document represent an API (in an opposite to a fragment or a partial model).\n   */\n  isApi: boolean\n  /**\n   * Whether the loaded document represent an Async API.\n   */\n  isAsync: boolean\n  /**\n   * Whether the loaded document represent a RAML fragment / OAS reference.\n   */\n  isFragment: boolean\n  /**\n   * A special type of fragment that is a RAML library.\n   */\n  isLibrary: boolean\n  /**\n   * The list of types of the loaded document.\n   */\n  types: string[]\n  /**\n   * The domain id of the `encodes` property.\n   */\n  encodesId?: string\n}\n"]}

package/build/src/apps/activities/ApiActivity.d.ts

@@ -0,0 +1,21 @@
+import { Activity } from '../../core/Activity.js';
+import type { Intent } from '../../core/ActivityManager.js';
+import type UserService from '../services/UserService.js';
+import type OrganizationService from '../services/OrganizationService.js';
+import type ConfigurationService from '../services/ConfigurationService.js';
+import type SdkService from '../services/SdkService.js';
+import type TransmitService from '../services/TransmitService.js';
+import type LoggingService from '../services/LoggingService.js';
+export interface ApiServices {
+    user: UserService;
+    org: OrganizationService;
+    sdk: SdkService;
+    config: ConfigurationService;
+    transmit: TransmitService;
+    logger: LoggingService;
+}
+export default class ApiActivity extends Activity {
+    services: ApiServices;
+    onCreate(intent?: Intent): Promise<void>;
+}
+//# sourceMappingURL=ApiActivity.d.ts.map

package/build/src/apps/activities/ApiActivity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiActivity.d.ts","sourceRoot":"","sources":["../../../../src/apps/activities/ApiActivity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,KAAK,WAAW,MAAM,4BAA4B,CAAA;AACzD,OAAO,KAAK,mBAAmB,MAAM,oCAAoC,CAAA;AACzE,OAAO,KAAK,oBAAoB,MAAM,qCAAqC,CAAA;AAC3E,OAAO,KAAK,UAAU,MAAM,2BAA2B,CAAA;AACvD,OAAO,KAAK,eAAe,MAAM,gCAAgC,CAAA;AACjE,OAAO,KAAK,cAAc,MAAM,+BAA+B,CAAA;AAG/D,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,WAAW,CAAA;IACjB,GAAG,EAAE,mBAAmB,CAAA;IACxB,GAAG,EAAE,UAAU,CAAA;IACf,MAAM,EAAE,oBAAoB,CAAA;IAC5B,QAAQ,EAAE,eAAe,CAAA;IACzB,MAAM,EAAE,cAAc,CAAA;CACvB;AAED,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,QAAQ;IAC/C,QAAQ,EAAG,WAAW,CAAA;IAEP,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiBxD"}

package/build/src/apps/activities/ApiActivity.js

@@ -0,0 +1,23 @@
+import { Activity } from '../../core/Activity.js';
+import services from '../api_service.js';
+export default class ApiActivity extends Activity {
+    services;
+    async onCreate(intent) {
+        const user = await services.get('user');
+        const org = await services.get('org');
+        const sdk = await services.get('sdk');
+        const config = await services.get('config');
+        const transmit = await services.get('transmit');
+        const logger = await services.get('logger');
+        this.services = {
+            user,
+            org,
+            config,
+            sdk,
+            transmit,
+            logger,
+        };
+        await super.onCreate(intent);
+    }
+}
+//# sourceMappingURL=ApiActivity.js.map

package/build/src/apps/activities/ApiActivity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiActivity.js","sourceRoot":"","sources":["../../../../src/apps/activities/ApiActivity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAQjD,OAAO,QAAQ,MAAM,mBAAmB,CAAA;AAWxC,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,QAAQ;IAC/C,QAAQ,CAAc;IAEb,KAAK,CAAC,QAAQ,CAAC,MAAe;QACrC,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QACvC,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QACrC,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QACrC,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC3C,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QAC/C,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC3C,IAAI,CAAC,QAAQ,GAAG;YACd,IAAI;YACJ,GAAG;YACH,MAAM;YACN,GAAG;YACH,QAAQ;YACR,MAAM;SACP,CAAA;QACD,MAAM,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IAC9B,CAAC;CACF","sourcesContent":["import { Activity } from '../../core/Activity.js'\nimport type { Intent } from '../../core/ActivityManager.js'\nimport type UserService from '../services/UserService.js'\nimport type OrganizationService from '../services/OrganizationService.js'\nimport type ConfigurationService from '../services/ConfigurationService.js'\nimport type SdkService from '../services/SdkService.js'\nimport type TransmitService from '../services/TransmitService.js'\nimport type LoggingService from '../services/LoggingService.js'\nimport services from '../api_service.js'\n\nexport interface ApiServices {\n  user: UserService\n  org: OrganizationService\n  sdk: SdkService\n  config: ConfigurationService\n  transmit: TransmitService\n  logger: LoggingService\n}\n\nexport default class ApiActivity extends Activity {\n  services!: ApiServices\n\n  override async onCreate(intent?: Intent): Promise<void> {\n    const user = await services.get('user')\n    const org = await services.get('org')\n    const sdk = await services.get('sdk')\n    const config = await services.get('config')\n    const transmit = await services.get('transmit')\n    const logger = await services.get('logger')\n    this.services = {\n      user,\n      org,\n      config,\n      sdk,\n      transmit,\n      logger,\n    }\n    await super.onCreate(intent)\n  }\n}\n"]}

package/build/src/apps/activities/AppStartActivity.d.ts

@@ -0,0 +1,61 @@
+import type { TemplateResult, nothing } from 'lit';
+import type { IUser } from '@api-client/core/browser.js';
+import ApiActivity from './ApiActivity.js';
+import { Intent } from '../../core/ActivityManager.js';
+export interface AppStartIntentData {
+    /**
+     * When defined it will run the activity described here.
+     * Otherwise it will just exist the process.
+     */
+    main?: string;
+    /**
+     * Whether the setup is allowed.
+     * Outside the application main screen the initial setup may not
+     * be allowed and therefore the user should see an appropriate screen.
+     */
+    allowSetup?: boolean;
+}
+/**
+ * The activity that configures the application and sets up:
+ * - The user
+ * - The organization
+ *
+ * Here's the ideal flow
+ *
+ * - The application puts on the stack the target activity but it is in the stopped state.
+ * - The current Activity stack is [`<target activity>`]
+ * - The application starts the `StartActivity`.
+ * - The current Activity stack is [`<target activity>`, StartActivity]
+ * - The `StartActivity` checks for the user.
+ *   - If the user is not logged in, the `StartActivity` starts the `LoginActivity`
+ *   - The current Activity stack is [`<target activity>`, StartActivity, LoginActivity]
+ *   - When the LoginActivity finishes, the onResume() here is called, we continue the flow.
+ *   - The current Activity stack is [`<target activity>`, StartActivity]
+ * - The `StartActivity` checks for the user.
+ * - If there are no orgs:
+ *   - The `StartActivity` starts the `OrganizationSetupActivity`
+ *   - The current Activity stack is [`<target activity>`, StartActivity, OrganizationSetupActivity]
+ *   - When the OrganizationSetupActivity finishes, the onResume() here is called, we continue the flow.
+ *   - The current Activity stack is [`<target activity>`, StartActivity]
+ * - If there is no org selected:
+ *   - The `StartActivity` starts the `OrganizationSelectionActivity`
+ *   - The current Activity stack is [`<target activity>`, StartActivity, OrganizationSelectionActivity]
+ *   - When the OrganizationSelectionActivity finishes, the onResume() here is called, we continue the flow.
+ *   - The current Activity stack is [`<target activity>`, StartActivity]
+ * - If there is an error:
+ *   - The `StartActivity` starts the `GeneralErrorActivity`
+ *   - The StartActivity finishes.
+ *   - The current Activity stack is [`<target activity>`, GeneralErrorActivity]
+ * - Otherwise, this activity finishes
+ * - The current Activity stack is [`<target activity>`]
+ */
+export default class AppStartActivity extends ApiActivity {
+    static action: string;
+    user?: IUser | null;
+    intent?: Intent;
+    onCreate(intent?: Intent): Promise<void>;
+    onResume(): Promise<void>;
+    private finalize;
+    render(): TemplateResult | typeof nothing;
+}
+//# sourceMappingURL=AppStartActivity.d.ts.map

package/build/src/apps/activities/AppStartActivity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppStartActivity.d.ts","sourceRoot":"","sources":["../../../../src/apps/activities/AppStartActivity.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,KAAK,CAAA;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAA;AAKxD,OAAO,WAAW,MAAM,kBAAkB,CAAA;AAE1C,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAA;AAGtD,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,WAAW;IACvD,OAAgB,MAAM,SAAY;IAElC,IAAI,CAAC,EAAE,KAAK,GAAG,IAAI,CAAA;IAEnB,MAAM,CAAC,EAAE,MAAM,CAAA;IAEA,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOxC,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;YAoC1B,QAAQ;IAUb,MAAM,IAAI,cAAc,GAAG,OAAO,OAAO;CAGnD"}