@datapos/datapos-shared 0.3.103 → 0.3.110

package/dist/datapos-shared.es.js

@@ -17,6 +17,84 @@ const R = 0, L = (e) => e, F = () => Date.now(), _ = {
   streamgraph: { categoryId: "streamgraph", label: { "en-gb": "Streamgraph" }, options: {} },
   values: { categoryId: "values", label: { "en-gb": "Values" }, options: {} }
 };
+function k() {
+  function e(t, a, r) {
+    r.textContent = "Cytoscape.js diagram goes here...";
+  }
+  return { render: e };
+}
+function O() {
+  function e(t, a, r) {
+    r.textContent = "values table goes here...";
+  }
+  return { render: e };
+}
+const v = "https://cdn.jsdelivr.net/npm/highcharts@11.4.3/es-modules/masters/", E = "highcharts";
+let b, w = !1;
+function M() {
+  async function e(n, s, u, h) {
+    await r();
+    const l = [];
+    for (const c of s.data.measures)
+      l.push({ type: n.options.highchartsType, name: c.name, data: c.data });
+    const g = {
+      chart: { type: n.options.highchartsType },
+      plotOptions: { series: { borderColor: "#333" } },
+      series: l,
+      title: { text: s.title.text },
+      xAxis: { categories: s.data.categoryLabels },
+      yAxis: { title: { text: s.data.name } }
+    }, m = b.chart(u, g, h);
+    return { chart: m, resize: () => m.reflow(), vendorId: E };
+  }
+  async function t(n, s, u, h) {
+    await Promise.all([r(), o()]);
+    const l = [];
+    for (const c of s.data.measures)
+      l.push({ type: n.options.highchartsType, name: c.name, data: c.data });
+    const g = {
+      chart: { polar: !0 },
+      plotOptions: { series: { borderColor: "#333" } },
+      series: l,
+      title: { text: s.title.text },
+      xAxis: { categories: s.data.categoryLabels },
+      yAxis: { title: { text: s.data.name } }
+    }, m = b.chart(u, g, h);
+    return { chart: m, resize: () => m.reflow(), vendorId: E };
+  }
+  async function a(n, s, u, h) {
+    await Promise.all([r(), o()]);
+    const l = [], g = [];
+    for (let f = 0; f < s.data.measures[0].data.length; f++)
+      g.push([s.data.measures[0].data[f][0], s.data.measures[1].data[f][0]]);
+    l.push({ type: n.options.highchartsType, name: "Unknown", data: g });
+    const m = {
+      chart: { type: n.options.highchartsType, inverted: n.options.inverted },
+      plotOptions: { series: { borderColor: "#333" } },
+      series: l,
+      title: { text: s.title.text },
+      xAxis: { categories: s.data.categoryLabels },
+      yAxis: { title: { text: s.data.name } }
+    }, c = b.chart(u, m, h);
+    return { chart: c, resize: () => c.reflow(), vendorId: E };
+  }
+  async function r() {
+    if (b) return;
+    const n = "https://cdn.jsdelivr.net/npm/highcharts@11.4.3/es-modules/masters/", s = `${n}highcharts.src.js`, u = `${n}modules/accessibility.src.js`;
+    b = (await import(
+      /* @vite-ignore */
+      s
+    )).default, await import(
+      /* @vite-ignore */
+      u
+    );
+  }
+  async function o() {
+    if (w) return;
+    await import(`${v}highcharts-more.src.js`), w = !0;
+  }
+  return { renderCartesianChart: e, renderPolarChart: t, renderRangeChart: a };
+}
 class I extends Error {
   locator;
   constructor(t, a, r) {
@@ -28,12 +106,12 @@ class p extends I {
     super(t, a, r), this.name = "ApplicationError";
   }
 }
-class k extends p {
+class U extends p {
   constructor(t, a, r) {
     super(t, a, r), this.name = "APIError";
   }
 }
-class O extends p {
+class B extends p {
   constructor(t, a, r) {
     super(t, a, r), this.name = "EngineError";
   }
@@ -44,36 +122,36 @@ class T extends p {
     super(t, a, o), this.name = "FetchError", this.body = r;
   }
 }
-class v extends p {
+class S extends p {
   componentName;
   info;
   constructor(t, a, r, o, n) {
     super(t, a, n), this.name = "VueHandledError", this.info = r, this.componentName = o;
   }
 }
-class M extends p {
+class j extends p {
   constructor(t, a, r) {
     super(t, a, r), this.name = "WindowHandledRuntimeError";
   }
 }
-class U extends p {
+class H extends p {
   constructor(t, a, r) {
     super(t, a, r), this.name = "WindowHandledPromiseRejectionError";
   }
 }
-class B extends I {
+class W extends I {
   constructor(t, a, r) {
     super(t, a, r), this.name = "OperationalError";
   }
 }
-async function j(e, t, a) {
+async function z(e, t, a) {
   const r = `${t} Response status '${e.status}${e.statusText ? ` - ${e.statusText}` : ""}' received.`, o = await e.text();
   return new T(r, a, o);
 }
-function H(e) {
+function P(e) {
   return e.map((t) => t.message).join(" ");
 }
-function W(e, t = "Unknown error.") {
+function V(e, t = "Unknown error.") {
   if (e instanceof Error) return e;
   if (typeof e == "string") return new Error(e);
   try {
@@ -82,7 +160,7 @@ function W(e, t = "Unknown error.") {
     return new Error(t);
   }
 }
-function z(e) {
+function X(e) {
   const t = /* @__PURE__ */ new Set(), a = [];
   let r = e;
   for (; r && !t.has(r); ) {
@@ -90,7 +168,7 @@ function z(e) {
     let o;
     if (r instanceof T)
       o = { body: r.body, locator: r.locator, message: r.message, name: r.name, stack: r.stack }, r = r.cause;
-    else if (r instanceof v)
+    else if (r instanceof S)
       o = { componentName: r.componentName, info: r.info, locator: r.locator, message: r.message, name: r.name, stack: r.stack }, r = r.cause;
     else if (r instanceof I)
       o = { locator: r.locator, message: r.message, name: r.name, stack: r.stack }, r = r.cause;
@@ -102,84 +180,6 @@ function z(e) {
   }
   return a;
 }
-function P() {
-  function e(t, a, r) {
-    r.textContent = "Cytoscape.js diagram goes here...";
-  }
-  return { render: e };
-}
-function V() {
-  function e(t, a, r) {
-    r.textContent = "values table goes here...";
-  }
-  return { render: e };
-}
-const S = "https://cdn.jsdelivr.net/npm/highcharts@11.4.3/es-modules/masters/", E = "highcharts";
-let b, w = !1;
-function X() {
-  async function e(n, s, u, h) {
-    await r();
-    const l = [];
-    for (const c of s.data.measures)
-      l.push({ type: n.options.highchartsType, name: c.name, data: c.data });
-    const g = {
-      chart: { type: n.options.highchartsType },
-      plotOptions: { series: { borderColor: "#333" } },
-      series: l,
-      title: { text: s.title.text },
-      xAxis: { categories: s.data.categoryLabels },
-      yAxis: { title: { text: s.data.name } }
-    }, m = b.chart(u, g, h);
-    return { chart: m, resize: () => m.reflow(), vendorId: E };
-  }
-  async function t(n, s, u, h) {
-    await Promise.all([r(), o()]);
-    const l = [];
-    for (const c of s.data.measures)
-      l.push({ type: n.options.highchartsType, name: c.name, data: c.data });
-    const g = {
-      chart: { polar: !0 },
-      plotOptions: { series: { borderColor: "#333" } },
-      series: l,
-      title: { text: s.title.text },
-      xAxis: { categories: s.data.categoryLabels },
-      yAxis: { title: { text: s.data.name } }
-    }, m = b.chart(u, g, h);
-    return { chart: m, resize: () => m.reflow(), vendorId: E };
-  }
-  async function a(n, s, u, h) {
-    await Promise.all([r(), o()]);
-    const l = [], g = [];
-    for (let f = 0; f < s.data.measures[0].data.length; f++)
-      g.push([s.data.measures[0].data[f][0], s.data.measures[1].data[f][0]]);
-    l.push({ type: n.options.highchartsType, name: "Unknown", data: g });
-    const m = {
-      chart: { type: n.options.highchartsType, inverted: n.options.inverted },
-      plotOptions: { series: { borderColor: "#333" } },
-      series: l,
-      title: { text: s.title.text },
-      xAxis: { categories: s.data.categoryLabels },
-      yAxis: { title: { text: s.data.name } }
-    }, c = b.chart(u, m, h);
-    return { chart: c, resize: () => c.reflow(), vendorId: E };
-  }
-  async function r() {
-    if (b) return;
-    const n = "https://cdn.jsdelivr.net/npm/highcharts@11.4.3/es-modules/masters/", s = `${n}highcharts.src.js`, u = `${n}modules/accessibility.src.js`;
-    b = (await import(
-      /* @vite-ignore */
-      s
-    )).default, await import(
-      /* @vite-ignore */
-      u
-    );
-  }
-  async function o() {
-    if (w) return;
-    await import(`${S}highcharts-more.src.js`), w = !0;
-  }
-  return { renderCartesianChart: e, renderPolarChart: t, renderRangeChart: a };
-}
 const D = "en-US", y = {}, G = (e) => {
   switch (e) {
     case "Edm.Binary":
@@ -322,18 +322,18 @@ const D = "en-US", y = {}, G = (e) => {
   return a ? { ...a, label: a.label[t] || a.label[d] || e } : { id: e, color: "other", label: e };
 }, d = "en-gb";
 export {
-  k as APIError,
+  U as APIError,
   p as ApplicationError,
   d as DEFAULT_LOCALE_CODE,
   R as DefaultTimestamp,
-  O as EngineError,
+  B as EngineError,
   T as FetchError,
-  B as OperationalError,
-  v as VueError,
-  U as WindowPromiseRejectionError,
-  M as WindowRuntimeError,
-  j as buildFetchError,
-  H as concatenateSerialisedErrorMessages,
+  W as OperationalError,
+  S as VueError,
+  H as WindowPromiseRejectionError,
+  j as WindowRuntimeError,
+  z as buildFetchError,
+  P as concatenateSerialisedErrorMessages,
   L as convertMillisecondsToTimestamp,
   G as convertODataTypeIdToUsageTypeId,
   K as extractExtensionFromPath,
@@ -349,10 +349,10 @@ export {
   re as getRecordDelimiters,
   te as getValueDelimiters,
   Z as lookupMimeTypeForExtension,
-  W as normalizeToError,
+  V as normalizeToError,
   _ as presentationViewTypeMap,
-  z as serialiseError,
-  P as useCytoscapeJS,
-  V as useDataTable,
-  X as useHighcharts
+  X as serialiseError,
+  k as useCytoscapeJS,
+  O as useDataTable,
+  M as useHighcharts
 };

package/dist/types/src/{connection.d.ts → component/connector/connection.d.ts}

@@ -1,6 +1,6 @@
-import { ComponentConfig } from './component';
-import { ConnectorConfig } from './connector';
-import { Timestamp } from './timestamp';
+import { ComponentConfig } from '..';
+import { ConnectorConfig } from '.';
+import { Timestamp } from '../../timestamp';
 export interface ConnectionAuthorizationConfig {
     accessToken: string;
     accountId: string;

package/dist/types/src/{connector.d.ts → component/connector/index.d.ts}

@@ -1,12 +1,12 @@
 import { parse as csvParse } from 'csv-parse/browser/esm';
 import { parse as dateFnsParse } from 'date-fns';
 import { nanoid } from 'nanoid';
-import { ComponentConfig } from './component';
-import { buildFetchError, OperationalError } from './errors';
+import { ComponentConfig } from '..';
+import { buildFetchError, OperationalError } from '../../errors';
 import { ConnectionConfig, ConnectionDescription, ConnectionNodeConfig } from './connection';
-import { convertMillisecondsToTimestamp, LocalisedString } from './index';
-import { DataViewContentAuditConfig, ValueDelimiterId } from './dataView';
-import { extractExtensionFromPath, extractNameFromPath, lookupMimeTypeForExtension } from './utilities';
+import { convertMillisecondsToTimestamp, LocalisedString } from '../../index';
+import { DataViewContentAuditConfig, ValueDelimiterId } from '../dataView';
+import { extractExtensionFromPath, extractNameFromPath, lookupMimeTypeForExtension } from '../../utilities';
 export interface Connector {
     abortController?: AbortController | undefined;
     readonly config: ConnectorConfig;

package/dist/types/src/component/context/index.d.ts

@@ -0,0 +1,131 @@
+import { ComponentConfig, ComponentRef } from '..';
+export interface Context {
+    readonly config: ContextConfig;
+    list(settings?: ContextListSettings): Promise<ContextListResult>;
+}
+export type ContextListSettings = {};
+export type ContextListResult = {
+    models: ContextModelGroupConfig[];
+};
+export type ContextCallbackData = {
+    typeId: string;
+    properties: Record<string, unknown>;
+};
+export interface ContextConfig extends ComponentConfig {
+    models: ContextModelGroupConfig[];
+    version: string;
+}
+export type ContextLocalisedConfig = Omit<ContextConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
+export interface ContextModelGroupConfig extends ComponentConfig {
+    modelRefs: ComponentRef[];
+    order: number;
+}
+export type ContextModelGroupLocalisedConfig = Omit<ContextModelGroupConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
+export interface ContextModelConfig extends ComponentConfig {
+    diagramURL?: string;
+    dimension: ContextModelDimensionGroupConfig[];
+    entities: ContextModelEntityGroupConfig[];
+    secondaryMeasures: ContextModelSecondaryMeasureGroupConfig[];
+}
+export type ContextModelLocalisedConfig = Omit<ContextModelConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
+export interface ContextModelDimensionGroupConfig {
+    id: string;
+    label: Record<string, string>;
+    description?: Record<string, unknown>;
+    dimensionRefs: ComponentRef[];
+}
+export type ContextModelDimensionGroupLocalisedConfig = Omit<ContextModelDimensionGroupConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
+export interface ContextModelDimensionConfig {
+    id: string;
+    label: Record<string, string>;
+    hierarchies: ContextModelDimensionHierarchyConfig[];
+}
+export type ContextModelDimensionLocalisedConfig = Omit<ContextModelDimensionConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
+export interface ContextModelDimensionHierarchyConfig {
+    id: string;
+    label: Record<string, string>;
+}
+export type ContextModelDimensionHierarchyLocalisedConfig = Omit<ContextModelDimensionHierarchyConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
+export interface ContextModelEntityGroupConfig {
+    id: string;
+    label: Record<string, string>;
+    description?: Record<string, unknown>;
+    entityRefs: ComponentRef[];
+}
+export type ContextModelEntityGroupLocalisedConfig = Omit<ContextModelEntityGroupConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
+export interface ContextModelEntityConfig {
+    id: string;
+    label: Record<string, string>;
+    labelPlural: Record<string, string>;
+    dataItems: ContextModelEntityDataItemConfig[];
+    events: ContextModelEntityEventConfig[];
+    primaryMeasures: ContextModelEntityPrimaryMeasureConfig[];
+}
+export type ContextModelEntityLocalisedConfig = Omit<ContextModelEntityConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
+export interface ContextModelEntityDataItemConfig {
+    id: string;
+    label: Record<string, string>;
+}
+export type ContextModelEntityDataItemLocalisedConfig = Omit<ContextModelEntityDataItemConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
+export interface ContextModelEntityEventConfig {
+    id: string;
+    labelAction: Record<string, string>;
+    labelState: Record<string, string>;
+}
+export type ContextModelEntityEventLocalisedConfig = Omit<ContextModelEntityEventConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
+export interface ContextModelEntityPrimaryMeasureConfig {
+    id: string;
+    label: Record<string, string>;
+}
+export type ContextModelEntityPrimaryMeasureLocalisedConfig = Omit<ContextModelEntityPrimaryMeasureConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
+export interface ContextModelSecondaryMeasureGroupConfig {
+    id: string;
+    label: Record<string, string>;
+    description?: Record<string, unknown>;
+    secondaryMeasureRefs: ComponentRef[];
+}
+export type ContextModelSecondaryMeasureGroupLocalisedConfig = Omit<ContextModelSecondaryMeasureGroupConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
+export interface ContextModelSecondaryMeasureConfig {
+    id: string;
+    label: Record<string, string>;
+}
+export type ContextModelSecondaryMeasureLocalisedConfig = Omit<ContextModelSecondaryMeasureConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};

package/dist/types/src/{dataView.d.ts → component/dataView/index.d.ts}

@@ -1,6 +1,6 @@
-import { ComponentConfig } from './component';
-import { Timestamp } from './timestamp';
-import { ConnectionColumnConfig, ConnectionNodeConfig } from './connection';
+import { ComponentConfig } from '..';
+import { Timestamp } from '../../timestamp';
+import { ConnectionColumnConfig, ConnectionNodeConfig } from '../../connection';
 export interface DataViewConfig extends ComponentConfig {
     connectionId?: string;
     connectionNodeConfig?: ConnectionNodeConfig;
@@ -54,20 +54,20 @@ type DataFormat = {
     id: string;
     label: string;
 };
-export declare const getDataFormat: (id: string, localeId?: import('./index').LocaleCode) => DataFormat;
-export declare const getDataFormats: (localeId?: import('./index').LocaleCode) => DataFormat[];
+export declare const getDataFormat: (id: string, localeId?: import('../../index').LocaleCode) => DataFormat;
+export declare const getDataFormats: (localeId?: import('../../index').LocaleCode) => DataFormat[];
 type RecordDelimiter = {
     id: string;
     label: string;
 };
-export declare const getRecordDelimiter: (id: string, localeId?: import('./index').LocaleCode) => RecordDelimiter;
-export declare const getRecordDelimiters: (localeId?: import('./index').LocaleCode) => RecordDelimiter[];
+export declare const getRecordDelimiter: (id: string, localeId?: import('../../index').LocaleCode) => RecordDelimiter;
+export declare const getRecordDelimiters: (localeId?: import('../../index').LocaleCode) => RecordDelimiter[];
 type ValueDelimiter = {
     id: string;
     label: string;
 };
-export declare const getValueDelimiter: (id: string, localeId?: import('./index').LocaleCode) => ValueDelimiter;
-export declare const getValueDelimiters: (localeId?: import('./index').LocaleCode) => ValueDelimiter[];
+export declare const getValueDelimiter: (id: string, localeId?: import('../../index').LocaleCode) => ValueDelimiter;
+export declare const getValueDelimiters: (localeId?: import('../../index').LocaleCode) => ValueDelimiter[];
 export type ParsedValue = bigint | boolean | number | string | null;
 export type DataFormatId = 'dtv' | 'e/e' | 'jsonArray' | 'spss' | 'xls' | 'xlsx' | 'xml';
 export type RecordDelimiterId = '\n' | '\r' | '\r\n';

package/dist/types/src/{dimension.d.ts → component/dimension/index.d.ts}

@@ -1,4 +1,4 @@
-import { ComponentConfig } from './component';
+import { ComponentConfig } from '..';
 export interface DimensionConfig extends ComponentConfig {
     placeholder?: string;
 }

package/dist/types/src/{eventQuery.d.ts → component/eventQuery/index.d.ts}

@@ -1,4 +1,4 @@
-import { ComponentConfig } from './component';
+import { ComponentConfig } from '..';
 export interface EventQueryConfig extends ComponentConfig {
     placeholder?: string;
 }

package/dist/types/src/{component.d.ts → component/index.d.ts}

@@ -1,5 +1,5 @@
-import { Timestamp } from './timestamp';
-import { LocaleCode, LocalisedString, StatusColorId } from './index';
+import { Timestamp } from '../timestamp';
+import { LocaleCode, LocalisedString, StatusColorId } from '../index';
 export interface ComponentConfig {
     id: string;
     label: Partial<LocalisedString>;
@@ -12,13 +12,14 @@ export interface ComponentConfig {
     statusId: ComponentStatusId;
     typeId: ComponentTypeId;
 }
-export interface ComponentRef {
+export type ComponentTypeId = 'connector' | 'connectorConnection' | 'context' | 'contextModelGroup' | 'contextModel' | 'contextModelDimensionGroup' | 'contextModelDimension' | 'contextModelDimensionHierarchy' | 'contextModelEntityGroup' | 'contextModelEntity' | 'contextModelEntityDataItem' | 'contextModelEntityEvent' | 'contextModelEntityPrimaryMeasure' | 'contextModelSecondaryMeasureGroup' | 'contextModelSecondaryMeasure' | 'dataView' | 'dimension' | 'eventQuery' | 'presenter' | 'presenterPresentation' | 'informer' | 'informerDocument';
+export type ComponentRef = {
     id: string;
     label: Partial<LocalisedString>;
     description: Partial<LocalisedString>;
     order: number;
     path: string;
-}
+};
 export type ComponentStatus = {
     id: string;
     color: StatusColorId;
@@ -26,4 +27,3 @@ export type ComponentStatus = {
 };
 export type ComponentStatusId = 'alpha' | 'beta' | 'generalAvailability' | 'notApplicable' | 'preAlpha' | 'proposed' | 'releaseCandidate' | 'unavailable' | 'underReview';
 export declare const getComponentStatus: (id: string, localeId?: LocaleCode) => ComponentStatus;
-export type ComponentTypeId = 'app' | 'engine' | 'connector' | 'connectorConnection' | 'context' | 'contextModelGroup' | 'contextModel' | 'contextModelDimensionGroup' | 'contextModelDimension' | 'contextModelDimensionHierarchy' | 'contextModelEntityGroup' | 'contextModelEntity' | 'contextModelEntityDataItems' | 'contextModelEntityEvent' | 'contextModelEntityPrimaryMeasure' | 'contextModelSecondaryMeasureGroup' | 'contextModelSecondaryMeasure' | 'contextModelPresentationGroup' | 'contextModelPresentation' | 'dataView' | 'dimension' | 'eventQuery' | 'presenter' | 'presenterPresentation' | 'informer' | 'informerDocument';

package/dist/types/src/{recipe.d.ts → component/informer/recipe.d.ts}

@@ -1,4 +1,4 @@
-import { ComponentConfig } from './component';
+import { ComponentConfig } from '..';
 export interface Recipe {
     readonly config: RecipeConfig;
     list(path: string): RecipeItemConfig[];

package/dist/types/src/{tutorial.d.ts → component/informer/tutorial.d.ts}

@@ -1,4 +1,4 @@
-import { ComponentConfig } from './component';
+import { ComponentConfig } from '..';
 export interface TutorialConfig extends ComponentConfig {
     placeholder?: string;
 }

package/dist/types/src/{presenter.d.ts → component/presenter/index.d.ts}

@@ -1,5 +1,5 @@
 import { default as markdownIt } from 'markdown-it';
-import { ComponentConfig, ComponentRef } from './component';
+import { ComponentConfig, ComponentRef } from '..';
 export interface Presenter {
     readonly config: PresenterConfig;
     readonly tools: PresenterTools;
@@ -21,10 +21,6 @@ export interface PresentationConfig extends ComponentConfig {
     content: string;
     order: number;
 }
-export interface PresentationView {
-    resize: () => void;
-    vendorId: string;
-}
 export type PresentationVisualConfig = {
     content: PresentationVisualContentConfig;
     views: PresentationVisualViewConfig[];
@@ -119,4 +115,8 @@ export type PresentationVisualValuesViewType = {
     label: Record<string, string>;
     options: {};
 };
+export interface PresentationView {
+    resize: () => void;
+    vendorId: string;
+}
 export declare const presentationViewTypeMap: Record<string, PresentationVisualViewType>;

package/dist/types/src/engine.d.ts

@@ -1,7 +1,7 @@
-import { ConnectionConfig } from './connection';
-import { AuditContentResult, ConnectorCallbackData, ConnectorOperationSettings, InitialiseSettings, ListResult, RetrieveResult } from './connector';
-import { ContextCallbackData, ContextConfig, ContextOperationSettings } from './context';
-import { DataViewPreviewConfig, EncodingConfig } from './dataView';
+import { ConnectionConfig } from './component/connector/connection';
+import { AuditContentResult, ConnectorCallbackData, ConnectorOperationSettings, InitialiseSettings, ListResult, RetrieveResult } from './component/connector';
+import { ContextCallbackData, ContextConfig, ContextOperationSettings } from './component/context';
+import { DataViewPreviewConfig, EncodingConfig } from './component/dataView';
 type InitialiseEngine = (settings: InitialiseSettings) => Promise<void>;
 type ProcessConnectorRequest = (id: string, connectionConfig: ConnectionConfig, settings: ConnectorOperationSettings, callback?: ((callbackData: ContextCallbackData) => void) | undefined) => Promise<ContextInterfaceResult>;
 export type ContextInterfaceResult = AuditContentResult | DataViewPreviewConfig | ListResult | RetrieveResult;

package/dist/types/src/index.d.ts

@@ -1,50 +1,59 @@
+/**
+ * Shared composables, constants, interfaces, errors, types and utilities.
+ */
 export type LocaleCode = 'en-au' | 'en-gb' | 'en-us' | 'es-es';
 export type LocalisedString = Record<LocaleCode, string>;
 export type StatusColorId = 'amber' | 'green' | 'red' | 'other';
-export declare const DEFAULT_LOCALE_CODE: LocaleCode;
-export { DefaultTimestamp } from './timestamp';
-export { presentationViewTypeMap } from './presenter';
+export type { AppModuleConfig, ConnectorModuleConfig, EngineModuleConfig, InformerModuleConfig, PresenterModuleConfig } from './module';
 export type { ComponentConfig, ComponentRef, ComponentStatus, ComponentStatusId, ComponentTypeId } from './component';
-export type { AuditContentResult, AuditContentSettings } from './connector';
-export type { Connector, ConnectorCallbackData, ConnectorConfig, ConnectorImplementation, ConnectorOperationSettings, ConnectorLocalisedConfig, ConnectorTools } from './connector';
-export type { CreateSettings } from './connector';
-export type { DropSettings } from './connector';
-export type { FindResult, FindSettings } from './connector';
-export type { GetResult, GetSettings } from './connector';
-export type { InitialiseSettings } from './connector';
-export type { ListResult, ListSettings } from './connector';
-export type { PreviewResult, PreviewSettings } from './connector';
-export type { RemoveSettings } from './connector';
-export type { RetrieveResult, RetrieveSettings, RetrieveSummary } from './connector';
-export type { UpsertSettings } from './connector';
-export type { ConnectionAuthorizationConfig, ConnectionColumnConfig, ConnectionConfig, ConnectionNodeConfig } from './connection';
-export type { DPAFileSystemFileHandle, Encoding, StorageTypeId, UsageTypeId } from './connection';
-export type { Context, ContextConfig, ContextFocusConfig, ContextFocusConfigListResult, ContextFocusConfigListSettings, ContextModelConfig, ContextDimensionConfig, ContextDimensionGroupConfig, ContextEntityCharacteristicConfig, ContextEntityGroupConfig, ContextEntityComputationConfig, ContextSecondaryMeasureGroupConfig, ContextViewGroupConfig, ContextFocusLocalisedConfig } from './context';
-export type { ContextEntityConfig, ContextEntityEventConfig, ContextHierarchyConfig, ContextViewConfig, Event } from './context';
-export type { DataFormatId, EncodingConfig, RecordDelimiterId, ValueDelimiterId } from './dataView';
-export type { DataViewConfig, DataViewContentAuditConfig, DataViewLocalisedConfig, DataViewPreviewConfig, DataViewRelationshipsAuditConfig, ParsedValue } from './dataView';
-export type { DimensionConfig, DimensionLocalisedConfig } from './dimension';
+export type { AuditContentResult, AuditContentSettings } from './component/connector';
+export type { Connector, ConnectorCallbackData, ConnectorConfig, ConnectorImplementation, ConnectorOperationSettings, ConnectorLocalisedConfig, ConnectorTools } from './component/connector';
+export type { CreateSettings } from './component/connector';
+export type { DropSettings } from './component/connector';
+export type { FindResult, FindSettings } from './component/connector';
+export type { GetResult, GetSettings } from './component/connector';
+export type { InitialiseSettings } from './component/connector';
+export type { ListResult, ListSettings } from './component/connector';
+export type { PreviewResult, PreviewSettings } from './component/connector';
+export type { RemoveSettings } from './component/connector';
+export type { RetrieveResult, RetrieveSettings, RetrieveSummary } from './component/connector';
+export type { UpsertSettings } from './component/connector';
+export type { ConnectionAuthorizationConfig, ConnectionColumnConfig, ConnectionConfig, ConnectionNodeConfig } from './component/connector/connection';
+export type { DPAFileSystemFileHandle, Encoding, StorageTypeId, UsageTypeId } from './component/connector/connection';
+export type { Context, ContextConfig, ContextLocalisedConfig, ContextListSettings, ContextListResult, ContextModelGroupConfig, ContextModelGroupLocalisedConfig, ContextModelConfig, ContextModelLocalisedConfig, ContextModelDimensionGroupConfig, ContextModelDimensionGroupLocalisedConfig, ContextModelDimensionConfig, ContextModelDimensionLocalisedConfig, ContextModelDimensionHierarchyConfig, ContextModelDimensionHierarchyLocalisedConfig, ContextModelEntityGroupConfig, ContextModelEntityGroupLocalisedConfig, ContextModelEntityConfig, ContextModelEntityLocalisedConfig, ContextModelEntityDataItemConfig, // Data items.
+ContextModelEntityDataItemLocalisedConfig, ContextModelEntityEventConfig, // Events.
+ContextModelEntityEventLocalisedConfig, ContextModelEntityPrimaryMeasureConfig, // Primary measures.
+ContextModelEntityPrimaryMeasureLocalisedConfig, ContextModelSecondaryMeasureGroupConfig, ContextModelSecondaryMeasureGroupLocalisedConfig, ContextModelSecondaryMeasureConfig, ContextModelSecondaryMeasureLocalisedConfig } from './component/context';
+export type { DataFormatId, EncodingConfig, RecordDelimiterId, ValueDelimiterId } from './component/dataView';
+export type { DataViewConfig, DataViewContentAuditConfig, DataViewLocalisedConfig, DataViewPreviewConfig, DataViewRelationshipsAuditConfig, ParsedValue } from './component/dataView';
+export type { DimensionConfig, DimensionLocalisedConfig } from './component/dimension';
 export type { ConnectorInterfaceResult, ContextInterfaceResult, Engine, EngineWorker } from './engine';
 export type { SerialisedError } from './errors';
-export type { EventQueryConfig, EventQueryLocalisedConfig } from './eventQuery';
-export type { Presenter, PresenterConfig, PresenterLocalisedConfig, PresenterTools } from './presenter';
-export type { PresentationConfig, PresentationView } from './presenter';
-export type { PresentationVisualConfig, PresentationVisualContentConfig, PresentationVisualViewConfig, PresentationVisualCartesianViewConfig, PresentationVisualChordDiagramViewConfig, PresentationVisualPolarViewConfig, PresentationVisualRangeViewConfig, PresentationVisualSankeyDiagramViewConfig, PresentationVisualStreamgraphViewConfig, PresentationVisualValuesViewConfig } from './presenter';
-export type { PresentationVisualViewType, PresentationVisualCartesianViewType, PresentationVisualChordViewType, PresentationVisualPolarViewType, PresentationVisualRangeViewType, PresentationVisualSankeyDiagramViewType, PresentationVisualStreamgraphViewType, PresentationVisualValuesViewType } from './presenter';
-export type { Recipe, RecipeConfig, RecipeLocalisedConfig } from './recipe';
-export type { ServiceData } from './service';
-export type { StateConfig } from './state';
+export type { EventQueryConfig, EventQueryLocalisedConfig } from './component/eventQuery';
+export type { Presenter, PresenterConfig, PresenterLocalisedConfig, PresenterTools } from './component/presenter';
+export type { PresentationConfig, PresentationView } from './component/presenter';
+export type { PresentationVisualConfig, PresentationVisualContentConfig, PresentationVisualViewConfig, PresentationVisualCartesianViewConfig, PresentationVisualChordDiagramViewConfig, PresentationVisualPolarViewConfig, PresentationVisualRangeViewConfig, PresentationVisualSankeyDiagramViewConfig, PresentationVisualStreamgraphViewConfig, PresentationVisualValuesViewConfig } from './component/presenter';
+export type { PresentationVisualViewType, PresentationVisualCartesianViewType, PresentationVisualChordViewType, PresentationVisualPolarViewType, PresentationVisualRangeViewType, PresentationVisualSankeyDiagramViewType, PresentationVisualStreamgraphViewType, PresentationVisualValuesViewType } from './component/presenter';
+export type { Recipe, RecipeConfig, RecipeLocalisedConfig } from './component/informer/recipe';
+export interface ContextOperationSettings {
+    accountId?: string;
+    appCheckToken?: string;
+    sessionAccessToken?: string;
+}
 export type { Timestamp } from './timestamp';
-export type { TutorialConfig } from './tutorial';
-export { APIError, ApplicationError, EngineError, FetchError, OperationalError, VueError, WindowRuntimeError, WindowPromiseRejectionError } from './errors';
+export type { TutorialConfig } from './component/informer/tutorial';
+export declare const DEFAULT_LOCALE_CODE: LocaleCode;
+export { DefaultTimestamp } from './timestamp';
+export { presentationViewTypeMap } from './component/presenter';
 export { type CytoscapeJSView, useCytoscapeJS } from './composables/useCytoscapeJS';
 export { useDataTable } from './composables/useDataTable';
 export { type HighchartsView, useHighcharts } from './composables/useHighcharts';
+export { APIError, ApplicationError, EngineError, FetchError, OperationalError, VueError, WindowRuntimeError, WindowPromiseRejectionError } from './errors';
 export { buildFetchError, concatenateSerialisedErrorMessages, normalizeToError, serialiseError } from './errors';
 export { convertMillisecondsToTimestamp, getCurrentTimestamp } from './timestamp';
 export { convertODataTypeIdToUsageTypeId } from './utilities';
 export { extractExtensionFromPath, extractNameFromPath } from './utilities';
 export { formatNumberAsDecimalNumber, formatNumberAsDuration, formatNumberAsSize, formatNumberAsStorageSize, formatNumberAsWholeNumber } from './utilities';
-export { getDataFormats, getRecordDelimiters, getValueDelimiters } from './dataView';
+export { getDataFormats, getRecordDelimiters, getValueDelimiters } from './component/dataView';
 export { getComponentStatus } from './component';
 export { lookupMimeTypeForExtension } from './utilities';

package/dist/types/src/module.d.ts

@@ -0,0 +1,49 @@
+import { ContextModelGroupConfig } from './component/context';
+import { LocalisedString } from './index';
+interface ModuleConfig {
+    id: string;
+    label: Partial<LocalisedString>;
+    description: Partial<LocalisedString>;
+    statusId: unknown;
+    typeId: ModuleTypeId;
+    version: string;
+}
+type ModuleTypeId = 'app' | 'engine' | 'connector' | 'context' | 'presenter' | 'informer';
+export interface AppModuleConfig extends ModuleConfig {
+    typeId: 'app';
+}
+export interface EngineModuleConfig extends ModuleConfig {
+    typeId: 'engine';
+}
+export interface ConnectorModuleConfig extends ModuleConfig {
+    categoryId: ConnectorModuleCategoryId;
+    implementations: Record<string, unknown>;
+    icon: string;
+    iconDark: string;
+    interfaces: ConnectorModuleInterface[];
+    typeId: 'connector';
+    usageId: ConnectorModuleUsageId;
+    vendorAccountURL?: string;
+    vendorDocumentationURL?: string;
+    vendorHomeURL?: string;
+}
+type ConnectorModuleCategoryId = 'application' | 'curatedDataset' | 'database' | 'fileStore';
+type ConnectorModuleInterface = 'abortOperation' | 'authenticateConnection' | 'createObject' | 'describeConnection' | 'dropObject' | 'findObject' | 'getRecord' | 'listNodes' | 'previewObject' | 'removeRecords' | 'retrieveRecords' | 'upsertRecords';
+type ConnectorModuleUsageId = 'bidirectional' | 'destination' | 'source';
+export interface ContextModuleConfig extends ModuleConfig {
+    interfaces: ContextModuleInterface[];
+    models: ContextModelGroupConfig[];
+    typeId: 'context';
+}
+type ContextModuleInterface = 'list';
+export interface InformerModuleConfig extends ModuleConfig {
+    interfaces: InformerModuleInterface[];
+    typeId: 'informer';
+}
+type InformerModuleInterface = 'list' | 'render';
+export interface PresenterModuleConfig extends ModuleConfig {
+    interfaces: PresenterModuleInterface[];
+    typeId: 'presenter';
+}
+type PresenterModuleInterface = 'list' | 'render';
+export {};

package/package.json

@@ -2,7 +2,7 @@
     "name": "@datapos/datapos-shared",
     "license": "MIT",
     "private": false,
-    "version": "0.3.103",
+    "version": "0.3.110",
     "type": "module",
     "files": [
         "dist"
@@ -45,7 +45,7 @@
         "check": "npm outdated; npm-check-updates -i && retire",
         "document": "license-report --only=prod,peer > LICENSES.json && license-report-check --source ./LICENSES.json --allowed 'MIT' --allowed 'n/a' --allowed 'Apache-2.0' --output=table",
         "format": "prettier --write *.ts",
-        "lint": "eslint src/**/*.ts",
+        "lint": "eslint src/",
         "publishToNPM": "npm publish --access public",
         "release": "npm run syncWithGitHub && npm run build && npm run publishToNPM",
         "syncWithGitHub": "npm run bumpVersion && node -e \"require('@datapos/datapos-development').syncWithGitHub()\"",

package/dist/types/src/context.d.ts

@@ -1,106 +0,0 @@
-import { ComponentConfig, ComponentRef } from './component';
-export interface Context {
-    readonly config: ContextConfig;
-    listFocuses(settings?: ContextFocusConfigListSettings): Promise<ContextFocusConfigListResult>;
-}
-export interface ContextCallbackData {
-    typeId: string;
-    properties: Record<string, unknown>;
-}
-export interface ContextConfig extends ComponentConfig {
-    focuses: ContextFocusConfig[];
-    version: string;
-}
-export interface ContextFocusConfig extends ComponentConfig {
-    modelRefs: ComponentRef[];
-    order: number;
-}
-export type ContextFocusLocalisedConfig = Omit<ContextFocusConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
-export interface ContextOperationSettings {
-    accountId?: string;
-    appCheckToken?: string;
-    sessionAccessToken?: string;
-}
-export interface ContextModelConfig extends ComponentConfig {
-    diagramURL?: string;
-    dimensionGroupConfigs: ContextDimensionGroupConfig[];
-    entityGroupConfigs: ContextEntityGroupConfig[];
-    secondaryMeasureGroupConfigs: ContextSecondaryMeasureGroupConfig[];
-    viewGroupConfigs: ContextViewGroupConfig[];
-}
-export interface ContextDimensionGroupConfig {
-    id: string;
-    label: Record<string, string>;
-    description?: Record<string, unknown>;
-    dimensionRefs: ComponentRef[];
-}
-export interface ContextEntityGroupConfig {
-    id: string;
-    label: Record<string, string>;
-    description?: Record<string, unknown>;
-    entityRefs: ComponentRef[];
-}
-export interface ContextSecondaryMeasureGroupConfig {
-    id: string;
-    label: Record<string, string>;
-    description?: Record<string, unknown>;
-    secondaryMeasureRefs: ComponentRef[];
-}
-export interface ContextViewGroupConfig {
-    id: string;
-    label: Record<string, string>;
-    description?: Record<string, unknown>;
-    viewRefs: ComponentRef[];
-}
-export interface ContextDimensionConfig {
-    id: string;
-    label: Record<string, string>;
-    hierarchies: ContextHierarchyConfig[];
-}
-export interface ContextHierarchyConfig {
-    id: string;
-    label: Record<string, string>;
-}
-export interface ContextEntityConfig {
-    id: string;
-    label: Record<string, string>;
-    labelPlural: Record<string, string>;
-    characteristics: ContextEntityCharacteristicConfig[];
-    computations: ContextEntityComputationConfig[];
-    events: ContextEntityEventConfig[];
-}
-export interface ContextEntityCharacteristicConfig {
-    id: string;
-    label: Record<string, string>;
-}
-export interface ContextEntityComputationConfig {
-    id: string;
-    label: Record<string, string>;
-}
-export interface ContextEntityEventConfig {
-    id: string;
-    labelAction: Record<string, string>;
-    labelState: Record<string, string>;
-}
-export interface ContextSecondaryMeasureConfig {
-    id: string;
-    label: Record<string, string>;
-}
-export interface ContextViewConfig {
-    id: string;
-    label: Record<string, string>;
-}
-export interface ContextFocusConfigListResult {
-    focusConfigs: ContextFocusConfig[];
-}
-export interface ContextFocusConfigListSettings {
-}
-export interface Event {
-    id?: number;
-    entityId: string;
-    effDate: number;
-    typeId: string;
-}

package/dist/types/src/service.d.ts

@@ -1,10 +0,0 @@
-export interface ServiceData {
-    label: string;
-    monitorEvents: {
-        [vendorId: string]: {
-            [locationId: string]: {
-                [regionId: string]: [number, number];
-            };
-        };
-    };
-}

package/dist/types/src/state.d.ts

@@ -1,5 +0,0 @@
-import { ComponentConfig } from './component';
-export interface StateConfig {
-    id: string;
-    data: ComponentConfig;
-}