@empathyco/x-components 6.0.0-alpha.222 → 6.0.0-alpha.224

package/js/plugins/devtools/devtools.plugin.js

@@ -1,32 +0,0 @@
-import { setupDevtoolsPlugin } from '@vue/devtools-api';
-import { setupTimelinePlugin } from './timeline.devtools.js';
-import { setupWiringDevtools } from './wiring.devtools.js';
-
-/**
- * Setups a plugin for the Vue's devtools adding:
- * - {@link XEvent}s timeline. Every event is recorded in time, and its payload and metadata can be
- * inspected.
- * - Wiring inspector. Events and its wires can be viewed and disabled.
- *
- * @param app - The Vue application instance the devtools should track.
- * @beta
- */
-function setupDevtools(app) {
-    setupDevtoolsPlugin({
-        id: 'x-components-devtools-plugin',
-        label: 'X Components',
-        packageName: '@empathyco/x-components',
-        homepage: 'https://empathy.co',
-        enableEarlyProxy: true,
-        // eslint-disable-next-line ts/no-unsafe-assignment
-        app,
-    }, api => {
-        if (api) {
-            setupTimelinePlugin(api);
-            setupWiringDevtools(api);
-        }
-    });
-}
-
-export { setupDevtools };
-//# sourceMappingURL=devtools.plugin.js.map

package/js/plugins/devtools/devtools.plugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"devtools.plugin.js","sources":["../../../../src/plugins/devtools/devtools.plugin.ts"],"sourcesContent":["import type { App } from '@vue/devtools-api'\nimport { setupDevtoolsPlugin } from '@vue/devtools-api'\nimport { setupTimelinePlugin } from './timeline.devtools'\nimport { setupWiringDevtools } from './wiring.devtools'\n\n/**\n * Setups a plugin for the Vue's devtools adding:\n * - {@link XEvent}s timeline. Every event is recorded in time, and its payload and metadata can be\n * inspected.\n * - Wiring inspector. Events and its wires can be viewed and disabled.\n *\n * @param app - The Vue application instance the devtools should track.\n * @beta\n */\nexport function setupDevtools(app: App): void {\n  setupDevtoolsPlugin(\n    {\n      id: 'x-components-devtools-plugin',\n      label: 'X Components',\n      packageName: '@empathyco/x-components',\n      homepage: 'https://empathy.co',\n      enableEarlyProxy: true,\n      // eslint-disable-next-line ts/no-unsafe-assignment\n      app,\n    },\n    api => {\n      if (api) {\n        setupTimelinePlugin(api)\n        setupWiringDevtools(api)\n      }\n    },\n  )\n}\n"],"names":[],"mappings":";;;;AAKA;;;;;;;;AAQG;AACG,SAAU,aAAa,CAAC,GAAQ,EAAA;AACpC,IAAA,mBAAmB,CACjB;AACE,QAAA,EAAE,EAAE,8BAA8B;AAClC,QAAA,KAAK,EAAE,cAAc;AACrB,QAAA,WAAW,EAAE,yBAAyB;AACtC,QAAA,QAAQ,EAAE,oBAAoB;AAC9B,QAAA,gBAAgB,EAAE,IAAI;;QAEtB,GAAG;KACJ,EACD,GAAG,IAAG;QACJ,IAAI,GAAG,EAAE;YACP,mBAAmB,CAAC,GAAG,CAAC;YACxB,mBAAmB,CAAC,GAAG,CAAC;QAC1B;AACF,IAAA,CAAC,CACF;AACH;;;;"}

package/js/plugins/devtools/timeline.devtools.js

@@ -1,109 +0,0 @@
-import { hslToHex } from './colors.utils.js';
-
-/**
- * Contains the devtools API.
- */
-let devtoolsAPI;
-/**
- * List of all the configured timeline layers for {@link XEvent}s.
- */
-const timelineLayers = [
-    {
-        id: 'x-components-all-events',
-        regex: /^$/,
-        label: 'X events',
-    },
-    {
-        id: 'x-components-module-registered-events',
-        regex: /^ModuleRegistered$/,
-        label: 'X registered modules',
-    },
-    {
-        id: 'x-components-user-events',
-        regex: /^User/,
-        label: 'X user events',
-    },
-    {
-        id: 'x-components-request-events',
-        regex: /Request(?:Changed|Updated)$/,
-        label: 'X request events',
-    },
-    {
-        id: 'x-components-status-change-events',
-        regex: /Changed$/,
-        label: 'X status change events',
-    },
-    {
-        id: 'x-components-miscellanea-events',
-        regex: /.*/,
-        label: 'X miscellanea events',
-    },
-];
-/** Set containing the different layer ids. */
-const layerIds = new Set(timelineLayers.map(layer => layer.id));
-/**
- * Retrieves the timeline layer that an {@link XEvent} belongs to.
- *
- * @param event - The {@link XEvent} to retrieve its layer id.
- * @returns The layer id for the {@link XEvent}.
- */
-function getTimelineLayer(event) {
-    return timelineLayers.find(layer => layer.regex.test(event)).id;
-}
-/**
- * Configures Vue's devtools timeline with new rows for {@link XEvent}s.
- *
- * @param api - Vue's devtools API.
- * @internal
- */
-function setupTimelinePlugin(api) {
-    devtoolsAPI = api;
-    timelineLayers.forEach(layer => api.addTimelineLayer({
-        id: layer.id,
-        label: layer.label,
-        color: hslToHex(329, 100, 50),
-    }));
-    api.on.inspectTimelineEvent(payload => {
-        if (layerIds.has(payload.layerId)) {
-            const component = payload.event.data.metadata.component;
-            if (component) {
-                api.highlightElement(component);
-            }
-        }
-    });
-}
-/**
- * Sends the emission of an {@link XEvent} to the devtools.
- *
- * @param event - The emitted {@link XEvent}.
- * @param value - An object containing both the event payload and its metadata.
- * @internal
- */
-function logDevtoolsXEvent(event, value) {
-    // eslint-disable-next-line node/prefer-global/process
-    if (process.env.NODE_ENV !== 'production' && devtoolsAPI) {
-        const timelineEvent = {
-            title: event,
-            data: {
-                ...value,
-                metadata: {
-                    ...value.metadata,
-                    // FIX-ME: copying metadata.component as it is defined as a non-enumerable property.
-                    component: value.metadata.component,
-                },
-            },
-            time: devtoolsAPI.now(),
-        };
-        devtoolsAPI.addTimelineEvent({
-            event: timelineEvent,
-            layerId: getTimelineLayer(event),
-        });
-        devtoolsAPI.addTimelineEvent({
-            event: timelineEvent,
-            layerId: 'x-components-all-events',
-        });
-    }
-}
-
-export { logDevtoolsXEvent, setupTimelinePlugin };
-//# sourceMappingURL=timeline.devtools.js.map

package/js/plugins/devtools/timeline.devtools.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"timeline.devtools.js","sources":["../../../../src/plugins/devtools/timeline.devtools.ts"],"sourcesContent":["import type { Dictionary } from '@empathyco/x-utils'\nimport type { DevtoolsPluginApi } from '@vue/devtools-api'\nimport type { XEvent, XEventPayload } from '../../wiring/events.types'\nimport type { WirePayload } from '../../wiring/wiring.types'\nimport { hslToHex } from './colors.utils'\n\n/**\n * Contains the devtools API.\n */\nlet devtoolsAPI: DevtoolsPluginApi<Dictionary> | undefined\n\n/**\n * List of all the configured timeline layers for {@link XEvent}s.\n */\nconst timelineLayers = [\n  {\n    id: 'x-components-all-events',\n    regex: /^$/,\n    label: 'X events',\n  },\n  {\n    id: 'x-components-module-registered-events',\n    regex: /^ModuleRegistered$/,\n    label: 'X registered modules',\n  },\n  {\n    id: 'x-components-user-events',\n    regex: /^User/,\n    label: 'X user events',\n  },\n\n  {\n    id: 'x-components-request-events',\n    regex: /Request(?:Changed|Updated)$/,\n    label: 'X request events',\n  },\n  {\n    id: 'x-components-status-change-events',\n    regex: /Changed$/,\n    label: 'X status change events',\n  },\n  {\n    id: 'x-components-miscellanea-events',\n    regex: /.*/,\n    label: 'X miscellanea events',\n  },\n]\n\n/** Set containing the different layer ids. */\nconst layerIds = new Set(timelineLayers.map(layer => layer.id))\n\n/**\n * Retrieves the timeline layer that an {@link XEvent} belongs to.\n *\n * @param event - The {@link XEvent} to retrieve its layer id.\n * @returns The layer id for the {@link XEvent}.\n */\nfunction getTimelineLayer(event: XEvent): string {\n  return timelineLayers.find(layer => layer.regex.test(event))!.id\n}\n\n/**\n * Configures Vue's devtools timeline with new rows for {@link XEvent}s.\n *\n * @param api - Vue's devtools API.\n * @internal\n */\nexport function setupTimelinePlugin(api: DevtoolsPluginApi<Dictionary>): void {\n  devtoolsAPI = api\n  timelineLayers.forEach(layer =>\n    api.addTimelineLayer({\n      id: layer.id,\n      label: layer.label,\n      color: hslToHex(329, 100, 50),\n    }),\n  )\n  api.on.inspectTimelineEvent(payload => {\n    if (layerIds.has(payload.layerId)) {\n      const component = (<WirePayload<unknown>>payload.event.data).metadata.component\n      if (component) {\n        api.highlightElement(component)\n      }\n    }\n  })\n}\n\n/**\n * Sends the emission of an {@link XEvent} to the devtools.\n *\n * @param event - The emitted {@link XEvent}.\n * @param value - An object containing both the event payload and its metadata.\n * @internal\n */\nexport function logDevtoolsXEvent<Event extends XEvent>(\n  event: Event,\n  value: WirePayload<XEventPayload<Event>>,\n): void {\n  // eslint-disable-next-line node/prefer-global/process\n  if (process.env.NODE_ENV !== 'production' && devtoolsAPI) {\n    const timelineEvent = {\n      title: event,\n      data: {\n        ...value,\n        metadata: {\n          ...value.metadata,\n          // FIX-ME: copying metadata.component as it is defined as a non-enumerable property.\n          component: value.metadata.component,\n        },\n      },\n      time: devtoolsAPI.now(),\n    }\n    devtoolsAPI.addTimelineEvent({\n      event: timelineEvent,\n      layerId: getTimelineLayer(event),\n    })\n    devtoolsAPI.addTimelineEvent({\n      event: timelineEvent,\n      layerId: 'x-components-all-events',\n    })\n  }\n}\n"],"names":[],"mappings":";;AAMA;;AAEG;AACH,IAAI,WAAsD;AAE1D;;AAEG;AACH,MAAM,cAAc,GAAG;AACrB,IAAA;AACE,QAAA,EAAE,EAAE,yBAAyB;AAC7B,QAAA,KAAK,EAAE,IAAI;AACX,QAAA,KAAK,EAAE,UAAU;AAClB,KAAA;AACD,IAAA;AACE,QAAA,EAAE,EAAE,uCAAuC;AAC3C,QAAA,KAAK,EAAE,oBAAoB;AAC3B,QAAA,KAAK,EAAE,sBAAsB;AAC9B,KAAA;AACD,IAAA;AACE,QAAA,EAAE,EAAE,0BAA0B;AAC9B,QAAA,KAAK,EAAE,OAAO;AACd,QAAA,KAAK,EAAE,eAAe;AACvB,KAAA;AAED,IAAA;AACE,QAAA,EAAE,EAAE,6BAA6B;AACjC,QAAA,KAAK,EAAE,6BAA6B;AACpC,QAAA,KAAK,EAAE,kBAAkB;AAC1B,KAAA;AACD,IAAA;AACE,QAAA,EAAE,EAAE,mCAAmC;AACvC,QAAA,KAAK,EAAE,UAAU;AACjB,QAAA,KAAK,EAAE,wBAAwB;AAChC,KAAA;AACD,IAAA;AACE,QAAA,EAAE,EAAE,iCAAiC;AACrC,QAAA,KAAK,EAAE,IAAI;AACX,QAAA,KAAK,EAAE,sBAAsB;AAC9B,KAAA;CACF;AAED;AACA,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC;AAE/D;;;;;AAKG;AACH,SAAS,gBAAgB,CAAC,KAAa,EAAA;AACrC,IAAA,OAAO,cAAc,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAE,CAAC,EAAE;AAClE;AAEA;;;;;AAKG;AACG,SAAU,mBAAmB,CAAC,GAAkC,EAAA;IACpE,WAAW,GAAG,GAAG;IACjB,cAAc,CAAC,OAAO,CAAC,KAAK,IAC1B,GAAG,CAAC,gBAAgB,CAAC;QACnB,EAAE,EAAE,KAAK,CAAC,EAAE;QACZ,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,KAAK,EAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;AAC9B,KAAA,CAAC,CACH;AACD,IAAA,GAAG,CAAC,EAAE,CAAC,oBAAoB,CAAC,OAAO,IAAG;QACpC,IAAI,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACjC,MAAM,SAAS,GAA0B,OAAO,CAAC,KAAK,CAAC,IAAK,CAAC,QAAQ,CAAC,SAAS;YAC/E,IAAI,SAAS,EAAE;AACb,gBAAA,GAAG,CAAC,gBAAgB,CAAC,SAAS,CAAC;YACjC;QACF;AACF,IAAA,CAAC,CAAC;AACJ;AAEA;;;;;;AAMG;AACG,SAAU,iBAAiB,CAC/B,KAAY,EACZ,KAAwC,EAAA;;IAGxC,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,IAAI,WAAW,EAAE;AACxD,QAAA,MAAM,aAAa,GAAG;AACpB,YAAA,KAAK,EAAE,KAAK;AACZ,YAAA,IAAI,EAAE;AACJ,gBAAA,GAAG,KAAK;AACR,gBAAA,QAAQ,EAAE;oBACR,GAAG,KAAK,CAAC,QAAQ;;AAEjB,oBAAA,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,SAAS;AACpC,iBAAA;AACF,aAAA;AACD,YAAA,IAAI,EAAE,WAAW,CAAC,GAAG,EAAE;SACxB;QACD,WAAW,CAAC,gBAAgB,CAAC;AAC3B,YAAA,KAAK,EAAE,aAAa;AACpB,YAAA,OAAO,EAAE,gBAAgB,CAAC,KAAK,CAAC;AACjC,SAAA,CAAC;QACF,WAAW,CAAC,gBAAgB,CAAC;AAC3B,YAAA,KAAK,EAAE,aAAa;AACpB,YAAA,OAAO,EAAE,yBAAyB;AACnC,SAAA,CAAC;IACJ;AACF;;;;"}

package/js/plugins/devtools/wiring.devtools.js

@@ -1,122 +0,0 @@
-import { forEach, reduce } from '@empathyco/x-utils';
-import { filter } from '../../wiring/wires.operators.js';
-import { moduleColors, hslToHex } from './colors.utils.js';
-
-/** The full list of wiring nodes for the inspector. */
-const wiringNodes = {};
-/**
- * Record of the wires enabled/disabled status.
- */
-const wiresStatus = {};
-/**
- * Creates tags given a node representing a wire.
- *
- * @param node - The inspector node representing a {@link Wire}.
- * @param node.tags - tags node.
- * @param node.id - id node.
- * @returns A list of tags for the given node.
- */
-function createWireTags({ tags = [], id }) {
-    const newTags = [...tags];
-    if (!wiresStatus[id]) {
-        newTags.push({
-            label: 'disabled',
-            backgroundColor: hslToHex(0, 88, 30),
-            textColor: hslToHex(0, 84, 90),
-        });
-    }
-    return newTags;
-}
-/**
- * Setups an inspector in Vue's devtools to show the wiring.
- *
- * @param api - Vue's devtools API.
- * @internal
- */
-function setupWiringDevtools(api) {
-    const inspectorId = 'wiring-inspector';
-    api.addInspector({
-        id: inspectorId,
-        label: 'X-Components Wiring',
-    });
-    api.on.getInspectorTree(payload => {
-        if (payload.inspectorId !== inspectorId) {
-            return;
-        }
-        const query = payload.filter.toLowerCase();
-        payload.rootNodes = reduce(wiringNodes, (nodes, event, eventWires) => {
-            const wiresNodes = 
-            /* If there is no active search, or the event name includes the query, we include all the
-              available wires. */
-            !query || event.toLowerCase().includes(query)
-                ? eventWires
-                : eventWires.filter(node => node.label.toLowerCase().includes(payload.filter.toLowerCase()));
-            if (wiresNodes.length) {
-                nodes.push({
-                    id: event,
-                    label: event,
-                    children: wiresNodes.map(wireNode => ({
-                        ...wireNode,
-                        tags: createWireTags(wireNode),
-                    })),
-                });
-            }
-            return nodes;
-        }, []);
-    });
-    api.on.getInspectorState(payload => {
-        if (payload.inspectorId !== inspectorId) {
-            return;
-        }
-        payload.state = {
-            status: [
-                {
-                    key: 'enabled',
-                    value: wiresStatus[payload.nodeId],
-                    editable: true,
-                },
-            ],
-        };
-    });
-    api.on.editInspectorState(payload => {
-        if (payload.inspectorId === inspectorId) {
-            // eslint-disable-next-line ts/no-unsafe-assignment
-            wiresStatus[payload.nodeId] = payload.state.value;
-            api.sendInspectorTree(inspectorId);
-        }
-    });
-}
-/**
- * Sends the module wiring to Vue's devtools inspector. Additionally, it modifies each wire, adding
- * a filter function to let it be enabled/disabled from the devtools.
- *
- * @param module - The module name this wiring belongs too.
- * @param wiring - The wiring to save.
- * @internal
- */
-function sendWiringToDevtools(module, wiring) {
-    // eslint-disable-next-line node/prefer-global/process
-    if (process.env.NODE_ENV !== 'production') {
-        forEach(wiring, (event, wires) => {
-            const eventWiring = wiringNodes[event] ?? (wiringNodes[event] = []);
-            forEach(wires, (wireName, wire) => {
-                const id = `${module}-${event}-${wireName}`;
-                wiresStatus[id] = true;
-                wires[wireName] = filter(wire, () => wiresStatus[id]);
-                eventWiring.push({
-                    id,
-                    label: wireName,
-                    tags: [
-                        {
-                            label: module,
-                            ...moduleColors[module],
-                        },
-                    ],
-                });
-            });
-        });
-    }
-}
-
-export { sendWiringToDevtools, setupWiringDevtools };
-//# sourceMappingURL=wiring.devtools.js.map

package/js/plugins/devtools/wiring.devtools.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"wiring.devtools.js","sources":["../../../../src/plugins/devtools/wiring.devtools.ts"],"sourcesContent":["import type { Dictionary } from '@empathyco/x-utils'\nimport type { CustomInspectorNode, DevtoolsPluginApi, InspectorNodeTag } from '@vue/devtools-api'\nimport type { XEvent } from '../../wiring/events.types'\nimport type { AnyWire, Wiring } from '../../wiring/wiring.types'\nimport type { XModuleName } from '../../x-modules/x-modules.types'\nimport { forEach, reduce } from '@empathyco/x-utils'\nimport { filter } from '../../wiring/wires.operators'\nimport { hslToHex, moduleColors } from './colors.utils'\n\n/** The full list of wiring nodes for the inspector. */\nconst wiringNodes: Partial<Record<XEvent, CustomInspectorNode[]>> = {}\n/**\n * Record of the wires enabled/disabled status.\n */\nconst wiresStatus: Record<string, boolean> = {}\n\n/**\n * Creates tags given a node representing a wire.\n *\n * @param node - The inspector node representing a {@link Wire}.\n * @param node.tags - tags node.\n * @param node.id - id node.\n * @returns A list of tags for the given node.\n */\nfunction createWireTags({ tags = [], id }: CustomInspectorNode): InspectorNodeTag[] {\n  const newTags: InspectorNodeTag[] = [...tags]\n  if (!wiresStatus[id]) {\n    newTags.push({\n      label: 'disabled',\n      backgroundColor: hslToHex(0, 88, 30),\n      textColor: hslToHex(0, 84, 90),\n    })\n  }\n  return newTags\n}\n\n/**\n * Setups an inspector in Vue's devtools to show the wiring.\n *\n * @param api - Vue's devtools API.\n * @internal\n */\nexport function setupWiringDevtools(api: DevtoolsPluginApi<Dictionary<unknown>>): void {\n  const inspectorId = 'wiring-inspector'\n  api.addInspector({\n    id: inspectorId,\n    label: 'X-Components Wiring',\n  })\n  api.on.getInspectorTree(payload => {\n    if (payload.inspectorId !== inspectorId) {\n      return\n    }\n    const query = payload.filter.toLowerCase()\n    payload.rootNodes = reduce(\n      wiringNodes,\n      (nodes, event, eventWires) => {\n        const wiresNodes =\n          /* If there is no active search, or the event name includes the query, we include all the\n            available wires. */\n          !query || event.toLowerCase().includes(query)\n            ? eventWires\n            : eventWires.filter(node =>\n                node.label.toLowerCase().includes(payload.filter.toLowerCase()),\n              )\n        if (wiresNodes.length) {\n          nodes.push({\n            id: event,\n            label: event,\n            children: wiresNodes.map(wireNode => ({\n              ...wireNode,\n              tags: createWireTags(wireNode),\n            })),\n          })\n        }\n        return nodes\n      },\n      <CustomInspectorNode[]>[],\n    )\n  })\n\n  api.on.getInspectorState(payload => {\n    if (payload.inspectorId !== inspectorId) {\n      return\n    }\n    payload.state = {\n      status: [\n        {\n          key: 'enabled',\n          value: wiresStatus[payload.nodeId],\n          editable: true,\n        },\n      ],\n    }\n  })\n\n  api.on.editInspectorState(payload => {\n    if (payload.inspectorId === inspectorId) {\n      // eslint-disable-next-line ts/no-unsafe-assignment\n      wiresStatus[payload.nodeId] = payload.state.value\n      api.sendInspectorTree(inspectorId)\n    }\n  })\n}\n\n/**\n * Sends the module wiring to Vue's devtools inspector. Additionally, it modifies each wire, adding\n * a filter function to let it be enabled/disabled from the devtools.\n *\n * @param module - The module name this wiring belongs too.\n * @param wiring - The wiring to save.\n * @internal\n */\nexport function sendWiringToDevtools(module: XModuleName, wiring: Partial<Wiring>): void {\n  // eslint-disable-next-line node/prefer-global/process\n  if (process.env.NODE_ENV !== 'production') {\n    forEach(wiring, (event, wires: Dictionary<AnyWire>) => {\n      const eventWiring = wiringNodes[event] ?? (wiringNodes[event] = [])\n      forEach(wires, (wireName, wire) => {\n        const id = `${module}-${event}-${wireName}`\n        wiresStatus[id] = true\n        wires[wireName] = filter(wire, () => wiresStatus[id])\n        eventWiring.push({\n          id,\n          label: wireName,\n          tags: [\n            {\n              label: module,\n              ...moduleColors[module],\n            },\n          ],\n        })\n      })\n    })\n  }\n}\n"],"names":[],"mappings":";;;;AASA;AACA,MAAM,WAAW,GAAmD,EAAE;AACtE;;AAEG;AACH,MAAM,WAAW,GAA4B,EAAE;AAE/C;;;;;;;AAOG;AACH,SAAS,cAAc,CAAC,EAAE,IAAI,GAAG,EAAE,EAAE,EAAE,EAAuB,EAAA;AAC5D,IAAA,MAAM,OAAO,GAAuB,CAAC,GAAG,IAAI,CAAC;AAC7C,IAAA,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE;QACpB,OAAO,CAAC,IAAI,CAAC;AACX,YAAA,KAAK,EAAE,UAAU;YACjB,eAAe,EAAE,QAAQ,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;YACpC,SAAS,EAAE,QAAQ,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;AAC/B,SAAA,CAAC;IACJ;AACA,IAAA,OAAO,OAAO;AAChB;AAEA;;;;;AAKG;AACG,SAAU,mBAAmB,CAAC,GAA2C,EAAA;IAC7E,MAAM,WAAW,GAAG,kBAAkB;IACtC,GAAG,CAAC,YAAY,CAAC;AACf,QAAA,EAAE,EAAE,WAAW;AACf,QAAA,KAAK,EAAE,qBAAqB;AAC7B,KAAA,CAAC;AACF,IAAA,GAAG,CAAC,EAAE,CAAC,gBAAgB,CAAC,OAAO,IAAG;AAChC,QAAA,IAAI,OAAO,CAAC,WAAW,KAAK,WAAW,EAAE;YACvC;QACF;QACA,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE;AAC1C,QAAA,OAAO,CAAC,SAAS,GAAG,MAAM,CACxB,WAAW,EACX,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,KAAI;AAC3B,YAAA,MAAM,UAAU;AACd;AACqB;YACrB,CAAC,KAAK,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,KAAK;AAC1C,kBAAE;kBACA,UAAU,CAAC,MAAM,CAAC,IAAI,IACpB,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAChE;AACP,YAAA,IAAI,UAAU,CAAC,MAAM,EAAE;gBACrB,KAAK,CAAC,IAAI,CAAC;AACT,oBAAA,EAAE,EAAE,KAAK;AACT,oBAAA,KAAK,EAAE,KAAK;oBACZ,QAAQ,EAAE,UAAU,CAAC,GAAG,CAAC,QAAQ,KAAK;AACpC,wBAAA,GAAG,QAAQ;AACX,wBAAA,IAAI,EAAE,cAAc,CAAC,QAAQ,CAAC;AAC/B,qBAAA,CAAC,CAAC;AACJ,iBAAA,CAAC;YACJ;AACA,YAAA,OAAO,KAAK;QACd,CAAC,EACsB,EAAE,CAC1B;AACH,IAAA,CAAC,CAAC;AAEF,IAAA,GAAG,CAAC,EAAE,CAAC,iBAAiB,CAAC,OAAO,IAAG;AACjC,QAAA,IAAI,OAAO,CAAC,WAAW,KAAK,WAAW,EAAE;YACvC;QACF;QACA,OAAO,CAAC,KAAK,GAAG;AACd,YAAA,MAAM,EAAE;AACN,gBAAA;AACE,oBAAA,GAAG,EAAE,SAAS;AACd,oBAAA,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;AAClC,oBAAA,QAAQ,EAAE,IAAI;AACf,iBAAA;AACF,aAAA;SACF;AACH,IAAA,CAAC,CAAC;AAEF,IAAA,GAAG,CAAC,EAAE,CAAC,kBAAkB,CAAC,OAAO,IAAG;AAClC,QAAA,IAAI,OAAO,CAAC,WAAW,KAAK,WAAW,EAAE;;YAEvC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK;AACjD,YAAA,GAAG,CAAC,iBAAiB,CAAC,WAAW,CAAC;QACpC;AACF,IAAA,CAAC,CAAC;AACJ;AAEA;;;;;;;AAOG;AACG,SAAU,oBAAoB,CAAC,MAAmB,EAAE,MAAuB,EAAA;;IAE/E,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE;QACzC,OAAO,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,KAA0B,KAAI;AACpD,YAAA,MAAM,WAAW,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,WAAW,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACnE,OAAO,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,IAAI,KAAI;gBAChC,MAAM,EAAE,GAAG,CAAA,EAAG,MAAM,IAAI,KAAK,CAAA,CAAA,EAAI,QAAQ,CAAA,CAAE;AAC3C,gBAAA,WAAW,CAAC,EAAE,CAAC,GAAG,IAAI;AACtB,gBAAA,KAAK,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,MAAM,WAAW,CAAC,EAAE,CAAC,CAAC;gBACrD,WAAW,CAAC,IAAI,CAAC;oBACf,EAAE;AACF,oBAAA,KAAK,EAAE,QAAQ;AACf,oBAAA,IAAI,EAAE;AACJ,wBAAA;AACE,4BAAA,KAAK,EAAE,MAAM;4BACb,GAAG,YAAY,CAAC,MAAM,CAAC;AACxB,yBAAA;AACF,qBAAA;AACF,iBAAA,CAAC;AACJ,YAAA,CAAC,CAAC;AACJ,QAAA,CAAC,CAAC;IACJ;AACF;;;;"}

package/js/x-bus/x-priority-queue/x-priority-queue.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"x-priority-queue.js","sources":["../../../../src/x-bus/x-priority-queue/x-priority-queue.ts"],"sourcesContent":["import type { Dictionary } from '@empathyco/x-utils'\nimport type {\n  NumberComparatorFn,\n  XPriorityQueue,\n  XPriorityQueueNode,\n} from './x-priority-queue.types'\n\n/**\n * Default {@link XPriorityQueueNode} implementation.\n *\n * @public\n */\nexport class BaseXPriorityQueueNode<\n  SomeRecord extends Dictionary,\n  SomeData extends Dictionary,\n> implements XPriorityQueueNode<SomeRecord, SomeData> {\n  public readonly key: keyof SomeRecord\n  public readonly priority: number\n  public readonly data: SomeData\n\n  public constructor(key: keyof SomeRecord, priority: number, data = {} as SomeData) {\n    this.key = key\n    this.priority = priority\n    this.data = data\n  }\n\n  /**\n   * Returns a string representation of this object. The string representation consists of: its\n   * priority, enclosed in square brackets (`[]`), followed by its key, an arrow `(->)` and the\n   * data converted to a string using JSON.stringify.\n   *\n   * @example\n   * ```\n   * [10] 1 -> { replaceable: false, randomKey: randomValue }\n   * ```\n   *\n   * @returns A string representation of this object.\n   *\n   * @public\n   */\n  toString(): string {\n    return `[${this.priority}] ${String(this.key)} -> ${JSON.stringify(this.data)}`\n  }\n}\n\n/**.\n * Default {@link XPriorityQueue} implementation.\n *\n * Method         big-O\n * ---------------------------\n * - push         O(n)\n * - pop          O(1)\n * - peek         O(1)\n * - at           O(1)\n *\n * @public\n */\nexport class BaseXPriorityQueue<\n  SomeRecord extends Dictionary,\n  SomeData extends Dictionary = Dictionary,\n> implements XPriorityQueue<SomeRecord, SomeData> {\n  /**\n   * The list of stored {@link XPriorityQueueNode | nodes}.\n   *\n   * @internal\n   */\n  protected nodes: XPriorityQueueNode<SomeRecord, SomeData>[] = []\n\n  /**\n   * The comparator function to use for sorting.\n   *\n   * @internal\n   */\n  protected comparatorFn: NumberComparatorFn\n\n  /**\n   * Creates a new {@link XPriorityQueue}.\n   *\n   * @param comparatorFn - Comparator - the comparator that will be used to order this queue.\n   * By default, the elements will be sorted in descending order (an element with priority 1 will\n   * be higher in the queue than another with priority 0).\n   */\n  public constructor(comparatorFn: NumberComparatorFn = (a: number, b: number) => a < b) {\n    this.comparatorFn = comparatorFn\n  }\n\n  /**\n   * The `keys` property of a {@link XPriorityQueue} represents the keys of that queue. The value is\n   * an array of the parametrized `Key` type.\n   *\n   * @returns The list of keys.\n   */\n  public get keys(): (keyof SomeRecord)[] {\n    return this.nodes.map(({ key }) => key)\n  }\n\n  /**.\n   * See {@link XPriorityQueue.push}.\n   *\n   * @remarks\n   * If the optional data has a 'replaceable: true' and a similar key is already in the queue,\n   * the previous key will be removed and the new one will be inserted to the queue at the\n   * correct position based on its new priority.\n   *\n   * @param key - The key to insert.\n   * @param priority - The priority to order the element in the queue.\n   * @param data - The extra data associated to a key and priority pair.\n   */\n  push(key: keyof SomeRecord, priority: number, data?: SomeData): void {\n    const node = new BaseXPriorityQueueNode<SomeRecord, SomeData>(key, priority, data)\n\n    if (this.isEmpty()) {\n      this.nodes.push(node)\n    } else {\n      this.pushAndSort(node)\n    }\n  }\n\n  /**\n   * Inserts the node into the queue in the correct position based on the comparator function.\n   *\n   * @param newNode - The node to be inserted.\n   *\n   * @internal\n   */\n  private pushAndSort(newNode: XPriorityQueueNode<SomeRecord, SomeData>): void {\n    const replaceableIndex = this.nodes.findIndex(node => node.key === newNode.key)\n\n    if (replaceableIndex > -1 && this.nodes[replaceableIndex].data.replaceable) {\n      this.nodes.splice(replaceableIndex, 1)\n    }\n\n    const insertAtIndex = this.nodes.findIndex(node =>\n      this.comparatorFn(node.priority, newNode.priority),\n    )\n\n    if (insertAtIndex === -1) {\n      this.nodes.push(newNode)\n    } else {\n      this.nodes.splice(insertAtIndex, 0, newNode)\n    }\n  }\n\n  /**\n   * See {@link XPriorityQueue.pop}.\n   *\n   * @returns The head {@link XPriorityQueueNode | node} of the queue or undefined if it is empty.\n   */\n  pop(): XPriorityQueueNode<SomeRecord, SomeData> | undefined {\n    return this.nodes.shift()\n  }\n\n  /**\n   * Retrieves, but does not remove, the head {@link XPriorityQueueNode | node} of the queue.\n   *\n   * @returns The head {@link XPriorityQueueNode | node} of the queue.\n   */\n  peek(): XPriorityQueueNode<SomeRecord, SomeData> | undefined {\n    return this.nodes[0]\n  }\n\n  /**\n   * Retrieves the {@link XPriorityQueueNode | node} at a given position.\n   *\n   * @param index - The position to look at.\n   *\n   * @returns The {@link XPriorityQueueNode | node} at the passed position in the queue.\n   */\n  at(index: number): XPriorityQueueNode<SomeRecord, SomeData> | undefined {\n    return this.nodes[index]\n  }\n\n  /**\n   * Removes all the {@link XPriorityQueueNode | nodes} from the queue.\n   */\n  clear(): void {\n    this.nodes.length = 0\n  }\n\n  /**\n   * Checks if the queue is empty.\n   *\n   * @returns True if the queue is empty, false otherwise.\n   */\n  isEmpty(): boolean {\n    return this.nodes.length === 0\n  }\n\n  /**\n   * Retrieves the number of {@link XPriorityQueueNode | nodes} stored in the queue.\n   *\n   * @returns The number of {@link XPriorityQueueNode | nodes} stored in the queue.\n   */\n  size(): number {\n    return this.nodes.length\n  }\n\n  /**\n   * Returns a string representation of this collection. The string representation consists of a\n   * list of the queue {@link XPriorityQueueNode | nodes} split in multiple lines, one for each\n   * one. Nodes are converted to strings as by toString().\n   *\n   * @example\n   * ```\n   * [10] 1 -> { replaceable: false, a: 'b' }\n   * [20] 2 -> { replaceable: false }\n   * [30] 3 -> { replaceable: false, c: 1 }\n   * ```\n   *\n   * @returns A string representation of the queue.\n   */\n  toString(): string {\n    return this.nodes.reduce((output, node) => output.concat(node.toString(), '\\n'), '')\n  }\n}\n"],"names":[],"mappings":"AAOA;;;;AAIG;MACU,sBAAsB,CAAA;AAQjC,IAAA,WAAA,CAAmB,GAAqB,EAAE,QAAgB,EAAE,OAAO,EAAc,EAAA;AAC/E,QAAA,IAAI,CAAC,GAAG,GAAG,GAAG;AACd,QAAA,IAAI,CAAC,QAAQ,GAAG,QAAQ;AACxB,QAAA,IAAI,CAAC,IAAI,GAAG,IAAI;IAClB;AAEA;;;;;;;;;;;;;AAaG;IACH,QAAQ,GAAA;QACN,OAAO,CAAA,CAAA,EAAI,IAAI,CAAC,QAAQ,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA,IAAA,EAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,CAAE;IACjF;AACD;AAED;;;;;;;;;;;AAWG;MACU,kBAAkB,CAAA;AAkB7B;;;;;;AAMG;IACH,WAAA,CAAmB,YAAA,GAAmC,CAAC,CAAS,EAAE,CAAS,KAAK,CAAC,GAAG,CAAC,EAAA;AArBrF;;;;AAIG;QACO,IAAA,CAAA,KAAK,GAA+C,EAAE;AAiB9D,QAAA,IAAI,CAAC,YAAY,GAAG,YAAY;IAClC;AAEA;;;;;AAKG;AACH,IAAA,IAAW,IAAI,GAAA;AACb,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;IACzC;AAEA;;;;;;;;;;;AAWG;AACH,IAAA,IAAI,CAAC,GAAqB,EAAE,QAAgB,EAAE,IAAe,EAAA;QAC3D,MAAM,IAAI,GAAG,IAAI,sBAAsB,CAAuB,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC;AAElF,QAAA,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE;AAClB,YAAA,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;QACvB;aAAO;AACL,YAAA,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QACxB;IACF;AAEA;;;;;;AAMG;AACK,IAAA,WAAW,CAAC,OAAiD,EAAA;QACnE,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC;AAE/E,QAAA,IAAI,gBAAgB,GAAG,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE;YAC1E,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACxC;QAEA,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,IAC7C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CACnD;AAED,QAAA,IAAI,aAAa,KAAK,EAAE,EAAE;AACxB,YAAA,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;QAC1B;aAAO;YACL,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,EAAE,OAAO,CAAC;QAC9C;IACF;AAEA;;;;AAIG;IACH,GAAG,GAAA;AACD,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE;IAC3B;AAEA;;;;AAIG;IACH,IAAI,GAAA;AACF,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACtB;AAEA;;;;;;AAMG;AACH,IAAA,EAAE,CAAC,KAAa,EAAA;AACd,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;IAC1B;AAEA;;AAEG;IACH,KAAK,GAAA;AACH,QAAA,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;IACvB;AAEA;;;;AAIG;IACH,OAAO,GAAA;AACL,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;IAChC;AAEA;;;;AAIG;IACH,IAAI,GAAA;AACF,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM;IAC1B;AAEA;;;;;;;;;;;;;AAaG;IACH,QAAQ,GAAA;QACN,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;IACtF;AACD;;;;"}

package/js/x-installer/x-installer/x-installer.js

@@ -1,285 +0,0 @@
-import { isFunction, forEach } from '@empathyco/x-utils';
-import { reactive, createApp } from 'vue';
-import { bus } from '../../plugins/x-bus.js';
-import { XPlugin } from '../../plugins/x-plugin.js';
-import { BaseXAPI } from '../api/base-api.js';
-
-/**
- * The purpose of this class is to offer a quick way to initialize the XComponents in a setup
- * project. It allows to receive all the options in {@link InstallXOptions} which is an extension
- * of {@link XPluginOptions} with all the options for the plugin and some options more.
- *
- * This class does multiple things:
- * 1. Install the {@link XPlugin} with the {@link XPluginOptions}.
- * 2. Creates the public {@link XAPI} and add it to global window.
- * 3. Creates the Vue Application for the customer project.
- *
- * The steps 2 & 3 are optional and depends on the options passed in {@link InstallXOptions}.
- *
- * @example The way to use this class is the next:
- *    1. Create the installer passing in the {@link InstallXOptions}. This only save the options:
- *
- * ```
- *        const installer = new XInstaller(installXOptions)
- * ```
- *
- *    2. Initialize passing the {@link SnippetConfig}. This installs the plugin and creates the App.
- *       There are 3 different ways to do this:
- *
- *        2.1 Using the created installer:
- *
- * ```
- *            installer.init(snippetConfig)
- * ```
- *
- *        2.2 If the API option is enabled (`createAPI` is `true` in {@link InstallXOptions}, or
- *            is not present as the default value is `true`) then this init step can be done with
- *            the Public API:
- *
- * ```
- *            window.InterfaceX.init(snippetConfig)
- * ```
- *
- *        2.3 When the script of the project build is loaded it searches for a global `initX`
- *            variable that the customer must have in their website. This variable can be a
- *            function that returns the {@link SnippetConfig} or an object that contains the
- *            {@link SnippetConfig} itself:
- *
- * ```
- *            window.initX = function() {
- *                 return {
- *                   instance,
- *                   env,
- *                   scope,
- *                   lang,
- *                   uiLang,
- *                   currency,
- *                   consent,
- *                   documentDirection
- *                 };
- *              };
- * ```
- *
- * ```
- *            window.initX = {
- *                 instance,
- *                 env,
- *                 scope,
- *                 lang,
- *                 uiLang,
- *                 currency,
- *                 consent,
- *                 documentDirection
- *               };
- * ```
- *
- * @public
- */
-class XInstaller {
-    /**
-     * Receives the {@link InstallXOptions} and merges it with the default fallback options. Also
-     * creates the public {@link XAPI}.
-     *
-     * @remarks Auto initializes the Vue application if window.initX is defined as a function or
-     * object specifying the {@link SnippetConfig | snippet config}.
-     *
-     *
-     * @param options - The {@link InstallXOptions}.
-     *
-     * @public
-     */
-    constructor(options) {
-        this.options = options;
-        this.createAPI();
-    }
-    /**
-     * Creates the public {@link XAPI} using the `api` option from {@link InstallXOptions}. If this
-     * `api` option is not passed, then a default {@link BaseXAPI} is created. To disable the API
-     * creation the value `false` must be passed in the `api` option.
-     *
-     * @internal
-     */
-    createAPI() {
-        const { api } = this.options;
-        if (api !== false) {
-            this.api = api ?? new BaseXAPI();
-            // eslint-disable-next-line ts/no-misused-promises
-            this.api.setInitCallback(this.init.bind(this));
-            this.api.setSnippetConfigCallback(this.updateSnippetConfig.bind(this));
-            this.api.setSnippetConfigGetter(this.getSnippetConfig.bind(this));
-            window.InterfaceX = this.api;
-        }
-    }
-    /**
-     * Retrieves the {@link SnippetConfig | snippet config} it is defined in the window.initX.
-     *
-     * @returns The snippet config if it is defined or undefined otherwise.
-     *
-     * @internal
-     */
-    retrieveSnippetConfig() {
-        if (typeof window.initX === 'function') {
-            return window.initX();
-        }
-        else if (typeof window.initX === 'object') {
-            return window.initX;
-        }
-    }
-    async init(snippetConfig = this.retrieveSnippetConfig()) {
-        if (snippetConfig) {
-            this.snippetConfig = reactive(this.normaliseSnippetConfig(snippetConfig));
-            this.createApp();
-            const bus = this.createBus();
-            const pluginOptions = this.getPluginOptions();
-            const plugin = this.installPlugin(pluginOptions, bus);
-            await this.installExtraPlugins(bus);
-            this.api?.setBus(bus);
-            this.app.mount(this.getMountingTarget(this.options.domElement));
-            return {
-                api: this.api,
-                app: this.app,
-                bus,
-                plugin,
-            };
-        }
-        return Promise.resolve();
-    }
-    /**
-     * Creates the {@link XPluginOptions} object.
-     *
-     * @returns The {@link XPluginOptions} object.
-     *
-     * @internal
-     */
-    getPluginOptions() {
-        const { adapter, store, initialXModules, xModules, __PRIVATE__xModules } = this.options;
-        return {
-            adapter,
-            store,
-            xModules,
-            initialXModules,
-            __PRIVATE__xModules,
-        };
-    }
-    /**
-     * This method returns the bus instance to be used in the {@link XPlugin} and in the {@link XAPI}.
-     * It returns the `bus` parameter in the {@link InstallXOptions} or if not provided, then
-     * creates a new instance of {@link @empathyco/x-bus#XPriorityBus | bus}.
-     *
-     * @returns XBus - The bus instance.
-     *
-     * @internal
-     */
-    createBus() {
-        return this.options.bus ?? bus;
-    }
-    /**
-     * Creates and install the Vue Plugin. If `plugin` parameter is passed in the
-     * {@link InstallXOptions}, then it is used. If not, then a new instance of {@link XPlugin} is
-     * created and installed.
-     *
-     * @param pluginOptions - The {@link XPluginOptions} to passed as parameter to the install method
-     * of the plugin.
-     * @param bus - The XBus to be used to create the XPlugin.
-     *
-     * @returns Plugin<XPluginOption> - The plugin instance.
-     * @internal
-     */
-    installPlugin(pluginOptions, bus) {
-        const plugin = this.options.plugin ?? new XPlugin(bus);
-        this.app.use(plugin, pluginOptions);
-        return plugin;
-    }
-    /**
-     * Runs the installExtraPlugins callback defined in the {@link InstallXOptions}
-     * to allow the user to install more plugins to the App.
-     *
-     * @param bus - The events bus used in the application.
-     * @returns An empty promise.
-     * @internal
-     */
-    async installExtraPlugins(bus) {
-        return Promise.resolve(this.options.installExtraPlugins?.({ app: this.app, snippet: this.snippetConfig, bus }));
-    }
-    /**
-     * In the case that the `rootComponent` parameter is present in the {@link InstallXOptions},
-     * then a new Vue application is created using that component as root.
-     *
-     * @internal
-     */
-    createApp() {
-        if (this.options.rootComponent !== undefined) {
-            this.app = createApp(this.options.rootComponent);
-            this.app.provide('snippetConfig', this.snippetConfig);
-            this.options.onCreateApp?.(this.app);
-        }
-    }
-    /**
-     * Transforms the snippet configuration.
-     * - If `lang` is provided and `uiLang` is not, it sets `uiLang=lang`.
-     *
-     * @param snippetConfig - The snippet config to normalise.
-     * @returns The normalised version of the given snippet config.
-     * @internal
-     */
-    normaliseSnippetConfig(snippetConfig) {
-        if (snippetConfig.lang) {
-            snippetConfig.uiLang ?? (snippetConfig.uiLang = snippetConfig.lang);
-        }
-        return snippetConfig;
-    }
-    /**
-     * It returns the HTML element to mount the Vue Application. If the `domElement` parameter in
-     * the {@link InstallXOptions} is an Element or an element selector, then this will be used.
-     * The `domElement` can also be a function with the {@link SnippetConfig} as parameter which
-     * returns an Element or element selector to use.
-     * If it is not present, a new <div> Element is created and appended to the body.
-     *
-     * @param domElement - {@link InstallXOptions.domElement} Element, ShadowRoot, string or function
-     * used to mount the Vue Application.
-     *
-     * @returns The Element or ShadowRoot to use as mounting target for the Vue Application.
-     * @internal
-     */
-    getMountingTarget(domElement) {
-        if (isFunction(domElement)) {
-            domElement = domElement(this.snippetConfig);
-        }
-        if (typeof domElement === 'string') {
-            const target = document.querySelector(domElement);
-            if (!target) {
-                throw new Error(`XComponents app couldn't be mounted: Element "${domElement}" couldn't be found`);
-            }
-            return target;
-        }
-        return domElement ?? document.body.appendChild(document.createElement('div'));
-    }
-    /**
-     * It updates all the provided properties from the current snippet config.
-     *
-     * @param newSnippetConfig - All the properties to be updated in the {@link SnippetConfig}.
-     *
-     * @internal
-     */
-    updateSnippetConfig(newSnippetConfig) {
-        if (!this.snippetConfig) {
-            return;
-        }
-        forEach(this.normaliseSnippetConfig(newSnippetConfig), (name, value) => {
-            this.snippetConfig[name] = value;
-        });
-    }
-    /**
-     * Getter for the snippet config object.
-     *
-     * @returns The {@link NormalisedSnippetConfig | snippetConfig} object.
-     *
-     * @public
-     */
-    getSnippetConfig() {
-        return this.snippetConfig;
-    }
-}
-
-export { XInstaller };
-//# sourceMappingURL=x-installer.js.map

package/js/x-installer/x-installer/x-installer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"x-installer.js","sources":["../../../../src/x-installer/x-installer/x-installer.ts"],"sourcesContent":["import type { App, Plugin } from 'vue'\nimport type { XPluginOptions } from '../../plugins/x-plugin.types'\nimport type { WireMetadata, XEventsTypes } from '../../wiring/index'\nimport type { XBus } from '../../x-bus'\nimport type { NormalisedSnippetConfig, SnippetConfig, XAPI } from '../api/api.types'\nimport type { InitWrapper, InstallXOptions } from './types'\nimport { forEach, isFunction } from '@empathyco/x-utils'\nimport { createApp, reactive } from 'vue'\nimport { bus } from '../../plugins/x-bus'\nimport { XPlugin } from '../../plugins/x-plugin'\nimport { BaseXAPI } from '../api/base-api'\n\ndeclare global {\n  interface Window {\n    InterfaceX?: XAPI\n    initX?: (() => SnippetConfig) | SnippetConfig\n  }\n}\n\n/**\n * The purpose of this class is to offer a quick way to initialize the XComponents in a setup\n * project. It allows to receive all the options in {@link InstallXOptions} which is an extension\n * of {@link XPluginOptions} with all the options for the plugin and some options more.\n *\n * This class does multiple things:\n * 1. Install the {@link XPlugin} with the {@link XPluginOptions}.\n * 2. Creates the public {@link XAPI} and add it to global window.\n * 3. Creates the Vue Application for the customer project.\n *\n * The steps 2 & 3 are optional and depends on the options passed in {@link InstallXOptions}.\n *\n * @example The way to use this class is the next:\n *    1. Create the installer passing in the {@link InstallXOptions}. This only save the options:\n *\n * ```\n *        const installer = new XInstaller(installXOptions)\n * ```\n *\n *    2. Initialize passing the {@link SnippetConfig}. This installs the plugin and creates the App.\n *       There are 3 different ways to do this:\n *\n *        2.1 Using the created installer:\n *\n * ```\n *            installer.init(snippetConfig)\n * ```\n *\n *        2.2 If the API option is enabled (`createAPI` is `true` in {@link InstallXOptions}, or\n *            is not present as the default value is `true`) then this init step can be done with\n *            the Public API:\n *\n * ```\n *            window.InterfaceX.init(snippetConfig)\n * ```\n *\n *        2.3 When the script of the project build is loaded it searches for a global `initX`\n *            variable that the customer must have in their website. This variable can be a\n *            function that returns the {@link SnippetConfig} or an object that contains the\n *            {@link SnippetConfig} itself:\n *\n * ```\n *            window.initX = function() {\n *                 return {\n *                   instance,\n *                   env,\n *                   scope,\n *                   lang,\n *                   uiLang,\n *                   currency,\n *                   consent,\n *                   documentDirection\n *                 };\n *              };\n * ```\n *\n * ```\n *            window.initX = {\n *                 instance,\n *                 env,\n *                 scope,\n *                 lang,\n *                 uiLang,\n *                 currency,\n *                 consent,\n *                 documentDirection\n *               };\n * ```\n *\n * @public\n */\nexport class XInstaller {\n  private app!: App\n  private api?: XAPI\n\n  /**\n   * The configuration coming from the snippet {@link SnippetConfig}.\n   *\n   * @internal\n   */\n  protected snippetConfig?: NormalisedSnippetConfig\n\n  /**\n   * Receives the {@link InstallXOptions} and merges it with the default fallback options. Also\n   * creates the public {@link XAPI}.\n   *\n   * @remarks Auto initializes the Vue application if window.initX is defined as a function or\n   * object specifying the {@link SnippetConfig | snippet config}.\n   *\n   *\n   * @param options - The {@link InstallXOptions}.\n   *\n   * @public\n   */\n  public constructor(protected readonly options: InstallXOptions) {\n    this.createAPI()\n  }\n\n  /**\n   * Creates the public {@link XAPI} using the `api` option from {@link InstallXOptions}. If this\n   * `api` option is not passed, then a default {@link BaseXAPI} is created. To disable the API\n   * creation the value `false` must be passed in the `api` option.\n   *\n   * @internal\n   */\n  protected createAPI(): void {\n    const { api } = this.options\n    if (api !== false) {\n      this.api = api ?? new BaseXAPI()\n      // eslint-disable-next-line ts/no-misused-promises\n      this.api.setInitCallback(this.init.bind(this))\n      this.api.setSnippetConfigCallback(this.updateSnippetConfig.bind(this))\n      this.api.setSnippetConfigGetter(this.getSnippetConfig.bind(this))\n      window.InterfaceX = this.api\n    }\n  }\n\n  /**\n   * Retrieves the {@link SnippetConfig | snippet config} it is defined in the window.initX.\n   *\n   * @returns The snippet config if it is defined or undefined otherwise.\n   *\n   * @internal\n   */\n  private retrieveSnippetConfig(): SnippetConfig | undefined {\n    if (typeof window.initX === 'function') {\n      return window.initX()\n    } else if (typeof window.initX === 'object') {\n      return window.initX\n    }\n  }\n\n  /**\n   * Receives the {@link SnippetConfig | snippet config} or retrieves it from window.initX and\n   * installs the plugin and initializes the Vue application.\n   *\n   * @param snippetConfig - The {@link SnippetConfig} that receives from snippet integration.\n   *\n   * @returns If {@link SnippetConfig | snippet config} is passed or configured in window.initX,\n   * returns an object with the {@link XAPI}, the XBus, the {@link XPlugin}\n   * and the Vue application instance. Else, a rejected promise is returned.\n   *\n   * @public\n   */\n  init(snippetConfig: SnippetConfig): Promise<InitWrapper>\n  init(): Promise<InitWrapper | void>\n  async init(snippetConfig = this.retrieveSnippetConfig()): Promise<InitWrapper | void> {\n    if (snippetConfig) {\n      this.snippetConfig = reactive(this.normaliseSnippetConfig(snippetConfig))\n      this.createApp()\n      const bus = this.createBus()\n      const pluginOptions = this.getPluginOptions()\n      const plugin = this.installPlugin(pluginOptions, bus)\n      await this.installExtraPlugins(bus)\n      this.api?.setBus(bus)\n      this.app.mount(this.getMountingTarget(this.options.domElement))\n\n      return {\n        api: this.api,\n        app: this.app,\n        bus,\n        plugin,\n      }\n    }\n\n    return Promise.resolve()\n  }\n\n  /**\n   * Creates the {@link XPluginOptions} object.\n   *\n   * @returns The {@link XPluginOptions} object.\n   *\n   * @internal\n   */\n  protected getPluginOptions(): XPluginOptions {\n    const { adapter, store, initialXModules, xModules, __PRIVATE__xModules } = this.options\n    return {\n      adapter,\n      store,\n      xModules,\n      initialXModules,\n      __PRIVATE__xModules,\n    }\n  }\n\n  /**\n   * This method returns the bus instance to be used in the {@link XPlugin} and in the {@link XAPI}.\n   * It returns the `bus` parameter in the {@link InstallXOptions} or if not provided, then\n   * creates a new instance of {@link @empathyco/x-bus#XPriorityBus | bus}.\n   *\n   * @returns XBus - The bus instance.\n   *\n   * @internal\n   */\n  protected createBus(): XBus<XEventsTypes, WireMetadata> {\n    return this.options.bus ?? bus\n  }\n\n  /**\n   * Creates and install the Vue Plugin. If `plugin` parameter is passed in the\n   * {@link InstallXOptions}, then it is used. If not, then a new instance of {@link XPlugin} is\n   * created and installed.\n   *\n   * @param pluginOptions - The {@link XPluginOptions} to passed as parameter to the install method\n   * of the plugin.\n   * @param bus - The XBus to be used to create the XPlugin.\n   *\n   * @returns Plugin<XPluginOption> - The plugin instance.\n   * @internal\n   */\n  protected installPlugin(\n    pluginOptions: XPluginOptions,\n    bus: XBus<XEventsTypes, WireMetadata>,\n  ): Plugin<XPluginOptions> {\n    const plugin = this.options.plugin ?? new XPlugin(bus)\n    this.app.use(plugin, pluginOptions)\n    return plugin\n  }\n\n  /**\n   * Runs the installExtraPlugins callback defined in the {@link InstallXOptions}\n   * to allow the user to install more plugins to the App.\n   *\n   * @param bus - The events bus used in the application.\n   * @returns An empty promise.\n   * @internal\n   */\n  protected async installExtraPlugins(bus: XBus<XEventsTypes, WireMetadata>): Promise<void> {\n    return Promise.resolve(\n      this.options.installExtraPlugins?.({ app: this.app, snippet: this.snippetConfig!, bus }),\n    )\n  }\n\n  /**\n   * In the case that the `rootComponent` parameter is present in the {@link InstallXOptions},\n   * then a new Vue application is created using that component as root.\n   *\n   * @internal\n   */\n  protected createApp(): void {\n    if (this.options.rootComponent !== undefined) {\n      this.app = createApp(this.options.rootComponent)\n      this.app.provide('snippetConfig', this.snippetConfig)\n      this.options.onCreateApp?.(this.app)\n    }\n  }\n\n  protected normaliseSnippetConfig(snippetConfig: SnippetConfig): NormalisedSnippetConfig\n  protected normaliseSnippetConfig(snippetConfig: Partial<SnippetConfig>): Partial<SnippetConfig>\n  /**\n   * Transforms the snippet configuration.\n   * - If `lang` is provided and `uiLang` is not, it sets `uiLang=lang`.\n   *\n   * @param snippetConfig - The snippet config to normalise.\n   * @returns The normalised version of the given snippet config.\n   * @internal\n   */\n  protected normaliseSnippetConfig(\n    snippetConfig: SnippetConfig | Partial<SnippetConfig>,\n  ): NormalisedSnippetConfig | Partial<SnippetConfig> {\n    if (snippetConfig.lang) {\n      snippetConfig.uiLang ??= snippetConfig.lang\n    }\n    return snippetConfig\n  }\n\n  /**\n   * It returns the HTML element to mount the Vue Application. If the `domElement` parameter in\n   * the {@link InstallXOptions} is an Element or an element selector, then this will be used.\n   * The `domElement` can also be a function with the {@link SnippetConfig} as parameter which\n   * returns an Element or element selector to use.\n   * If it is not present, a new <div> Element is created and appended to the body.\n   *\n   * @param domElement - {@link InstallXOptions.domElement} Element, ShadowRoot, string or function\n   * used to mount the Vue Application.\n   *\n   * @returns The Element or ShadowRoot to use as mounting target for the Vue Application.\n   * @internal\n   */\n  protected getMountingTarget(domElement?: InstallXOptions['domElement']): Element | ShadowRoot {\n    if (isFunction(domElement)) {\n      domElement = domElement(this.snippetConfig!)\n    }\n    if (typeof domElement === 'string') {\n      const target = document.querySelector(domElement)\n      if (!target) {\n        throw new Error(\n          `XComponents app couldn't be mounted: Element \"${domElement}\" couldn't be found`,\n        )\n      }\n      return target\n    }\n    return domElement ?? document.body.appendChild(document.createElement('div'))\n  }\n\n  /**\n   * It updates all the provided properties from the current snippet config.\n   *\n   * @param newSnippetConfig - All the properties to be updated in the {@link SnippetConfig}.\n   *\n   * @internal\n   */\n  protected updateSnippetConfig(newSnippetConfig: Partial<SnippetConfig>): void {\n    if (!this.snippetConfig) {\n      return\n    }\n    forEach(this.normaliseSnippetConfig(newSnippetConfig), (name, value) => {\n      this.snippetConfig![name] = value\n    })\n  }\n\n  /**\n   * Getter for the snippet config object.\n   *\n   * @returns The {@link NormalisedSnippetConfig | snippetConfig} object.\n   *\n   * @public\n   */\n  protected getSnippetConfig(): NormalisedSnippetConfig {\n    return this.snippetConfig!\n  }\n}\n"],"names":[],"mappings":";;;;;;AAmBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsEG;MACU,UAAU,CAAA;AAWrB;;;;;;;;;;;AAWG;AACH,IAAA,WAAA,CAAsC,OAAwB,EAAA;QAAxB,IAAA,CAAA,OAAO,GAAP,OAAO;QAC3C,IAAI,CAAC,SAAS,EAAE;IAClB;AAEA;;;;;;AAMG;IACO,SAAS,GAAA;AACjB,QAAA,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO;AAC5B,QAAA,IAAI,GAAG,KAAK,KAAK,EAAE;YACjB,IAAI,CAAC,GAAG,GAAG,GAAG,IAAI,IAAI,QAAQ,EAAE;;AAEhC,YAAA,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9C,YAAA,IAAI,CAAC,GAAG,CAAC,wBAAwB,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACtE,YAAA,IAAI,CAAC,GAAG,CAAC,sBAAsB,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjE,YAAA,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG;QAC9B;IACF;AAEA;;;;;;AAMG;IACK,qBAAqB,GAAA;AAC3B,QAAA,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,UAAU,EAAE;AACtC,YAAA,OAAO,MAAM,CAAC,KAAK,EAAE;QACvB;AAAO,aAAA,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE;YAC3C,OAAO,MAAM,CAAC,KAAK;QACrB;IACF;IAgBA,MAAM,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,qBAAqB,EAAE,EAAA;QACrD,IAAI,aAAa,EAAE;AACjB,YAAA,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC,IAAI,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;YACzE,IAAI,CAAC,SAAS,EAAE;AAChB,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,EAAE;AAC5B,YAAA,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,EAAE;YAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,GAAG,CAAC;AACrD,YAAA,MAAM,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC;AACnC,YAAA,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC;AACrB,YAAA,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAE/D,OAAO;gBACL,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,GAAG;gBACH,MAAM;aACP;QACH;AAEA,QAAA,OAAO,OAAO,CAAC,OAAO,EAAE;IAC1B;AAEA;;;;;;AAMG;IACO,gBAAgB,GAAA;AACxB,QAAA,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAC,OAAO;QACvF,OAAO;YACL,OAAO;YACP,KAAK;YACL,QAAQ;YACR,eAAe;YACf,mBAAmB;SACpB;IACH;AAEA;;;;;;;;AAQG;IACO,SAAS,GAAA;AACjB,QAAA,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG;IAChC;AAEA;;;;;;;;;;;AAWG;IACO,aAAa,CACrB,aAA6B,EAC7B,GAAqC,EAAA;AAErC,QAAA,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;QACtD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC;AACnC,QAAA,OAAO,MAAM;IACf;AAEA;;;;;;;AAOG;IACO,MAAM,mBAAmB,CAAC,GAAqC,EAAA;AACvE,QAAA,OAAO,OAAO,CAAC,OAAO,CACpB,IAAI,CAAC,OAAO,CAAC,mBAAmB,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,aAAc,EAAE,GAAG,EAAE,CAAC,CACzF;IACH;AAEA;;;;;AAKG;IACO,SAAS,GAAA;QACjB,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE;YAC5C,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;YAChD,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,aAAa,CAAC;YACrD,IAAI,CAAC,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC;QACtC;IACF;AAIA;;;;;;;AAOG;AACO,IAAA,sBAAsB,CAC9B,aAAqD,EAAA;AAErD,QAAA,IAAI,aAAa,CAAC,IAAI,EAAE;YACtB,aAAa,CAAC,MAAM,KAApB,aAAa,CAAC,MAAM,GAAK,aAAa,CAAC,IAAI,CAAA;QAC7C;AACA,QAAA,OAAO,aAAa;IACtB;AAEA;;;;;;;;;;;;AAYG;AACO,IAAA,iBAAiB,CAAC,UAA0C,EAAA;AACpE,QAAA,IAAI,UAAU,CAAC,UAAU,CAAC,EAAE;AAC1B,YAAA,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,aAAc,CAAC;QAC9C;AACA,QAAA,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAClC,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC;YACjD,IAAI,CAAC,MAAM,EAAE;AACX,gBAAA,MAAM,IAAI,KAAK,CACb,iDAAiD,UAAU,CAAA,mBAAA,CAAqB,CACjF;YACH;AACA,YAAA,OAAO,MAAM;QACf;AACA,QAAA,OAAO,UAAU,IAAI,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC/E;AAEA;;;;;;AAMG;AACO,IAAA,mBAAmB,CAAC,gBAAwC,EAAA;AACpE,QAAA,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB;QACF;AACA,QAAA,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,KAAI;AACrE,YAAA,IAAI,CAAC,aAAc,CAAC,IAAI,CAAC,GAAG,KAAK;AACnC,QAAA,CAAC,CAAC;IACJ;AAEA;;;;;;AAMG;IACO,gBAAgB,GAAA;QACxB,OAAO,IAAI,CAAC,aAAc;IAC5B;AACD;;;;"}