@datapos/datapos-shared 0.3.152 → 0.3.156

package/README.md

@@ -31,39 +31,78 @@ registry=https://registry.npmjs.org/
 
 ## Declarations
 
+This package provides composables, constants, errors, types/interfaces and utilities used by Data Positioning modules.
+
+### Modules
+
+The Data Positioning solution consists of the following modules. All modules, except `App`, extend the base type `Module`.
+
+| Type      | Dynamic | Notes                                                           |
+| --------- | :-----: | --------------------------------------------------------------- |
+| App       |         | Implements the data positioning web application.                |
+| Engine    |   ✔    | Implements the data positioning engine.                         |
+| Connector |   ✔    | Implements a connector which handles one or more connections.   |
+| Context   |   ✔    | Implements a context which defines one or more models.          |
+| Informer  |   ✔    | Implements an informer which renders one or more documents.     |
+| Presenter |   ✔    | Implements a presenter which renders one or more presentations. |
+
 ### Components
 
-#### Component Types
+Each module implements a set of components. All module component types extend the base component types.
 
-| Item                                  | Notes                                                        |
-| ------------------------------------- | ------------------------------------------------------------ |
-| [Component Types](./src/component.ts) | The Component type serves as a base type for all components. |
-| ComponentRef                          |                                                              |
-| ComponentStatus                       |                                                              |
-| ComponentStatusId                     |                                                              |
-| ComponentTypeId                       |                                                              |
-| StatusColorId                         |                                                              |
+| Types                           | Notes                                                        |
+| ------------------------------- | ------------------------------------------------------------ |
+| [Component](./src/component.ts) | The Component type serves as a base type for all components. |
+| ComponentRef                    |                                                              |
+| ComponentStatus                 |                                                              |
+| ComponentStatusId               |                                                              |
+| ComponentTypeId                 |                                                              |
+| StatusColorId                   |                                                              |
 
-#### Connector and Connection Types
+#### Connector Module Components
 
 | Item                                    | Notes                                                             |
 | --------------------------------------- | ----------------------------------------------------------------- |
 | [Connector Types](./src/connector.ts)   | Connector types. The Connector type extends the Component type.   |
 | [Connection Types](./src/connection.ts) | Connection types. The Connection type extends the Component type. |
 
-#### Context Types
+#### Context Module Components
+
+| Item                                     | Notes                                                               |
+| ---------------------------------------- | ------------------------------------------------------------------- |
+| [Context Types](./src/context.ts)        | Context types. The Context type extends the Component type.         |
+| [Data View Types](./src/dataView.ts)     | DataView types. The DataView type extends the Component type.       |
+| [Dimension Types](./src/dimension.ts)    | Dimension types. The Dimension type extends the Component type.     |
+| [Engine Types](./src/dimension.ts)       | Engine types.                                                       |
+| [Event Query Types](./src/eventQuery.ts) | Event Query types. The Event Query type extends the Component type. |
+
+#### Engine Module Components
+
+| Item                               | Notes         |
+| ---------------------------------- | ------------- |
+| [Engine Types](./src/dimension.ts) | Engine types. |
+
+#### Informer Module Components
 
 | Item                                        | Notes                                                                 |
 | ------------------------------------------- | --------------------------------------------------------------------- |
-| [Context Types](./src/context.ts)           | Context types. The Context type extends the Component type.           |
-| [Data View Types](./src/dataView.ts)        | DataView types. The DataView type extends the Component type.         |
-| [Dimension Types](./src/dimension.ts)       | Dimension types. The Dimension type extends the Component type.       |
-| [Engine Types](./src/dimension.ts)          | Engine types.                                                         |
-| [Event Query Types](./src/eventQuery.ts)    | Event Query types. The Event Query type extends the Component type.   |
 | [Presenter Types](./src/presenter.ts)       | Presenter types. The Presenter type extends the Component type.       |
 | [Presentation Types](./src/presentation.ts) | Presentation types. The Presentation type extends the Component type. |
-| [Informer Types](./src/informer.ts)         | Informer types. The Informer type extends the Component type.         |
-| [Recipe Types](./src/recipe.ts)             | Recipe types. The Recipe type extends the Component type.             |
+
+#### Presenter Module Components
+
+| Item                                | Notes                                                         |
+| ----------------------------------- | ------------------------------------------------------------- |
+| [Informer Types](./src/informer.ts) | Informer types. The Informer type extends the Component type. |
+| [Recipe Types](./src/recipe.ts)     | Recipe types. The Recipe type extends the Component type.     |
+
+### Composables
+
+### Constants
+
+### Errors
+
+### Utilities
 
 ## Usage
 
@@ -88,17 +127,17 @@ For detailed implementation, see the `scripts` section in the `package.json` fil
 | ------------------ | ---------------- | ---------------------------------------------------------------------------------------------------------- |
 | audit              | alt+ctrl+shift+a | Audit the project's dependencies for known security vulnerabilities.                                       |
 | build              | alt+ctrl+shift+b | Build the package using Vite.                                                                              |
-| build...Config     |                  |                                                                                                            |
-| bumpVersion        | alt+ctrl+shift+v |                                                                                                            |
+| bump:version       | alt+ctrl+shift+v | Increment patch version number.                                                                            |
 | check              | alt+ctrl+shift+c | List outdated dependencies and run retire scanner.                                                         |
 | document           | alt+ctrl+shift+d | Identify licenses of the project's production and peer dependencies. See [LICENSES.json](./LICENSES.json). |
 | format             | alt+ctrl+shift+f | Enforce formatting style rules.                                                                            |
 | lint               | alt+ctrl+shift+l | Check the code for errors and enforce coding style rules.                                                  |
-| publishToNPM       | alt+ctrl+shift+p |                                                                                                            |
+| publish:toNPM      | alt+ctrl+shift+p | Publish the package to npm.                                                                                |
 | release            | alt+ctrl+shift+r | Bump version, synchronise local repository with the main GitHub repository, build and publish to npm.      |
-| syncWithGitHub     | alt+ctrl+shift+s | Bump version and synchronise local repository with the main GitHub repository.                             |
+| send:deployNotice  | alt+ctrl+shift+n | ❌ Not implemented.                                                                                        |
+| sync:withGitHub    | alt+ctrl+shift+s | Bump version and synchronise local repository with the main GitHub repository.                             |
 | test               | alt+ctrl+shift+t | ❌ Not implemented.                                                                                        |
-| updateDependencies | alt+ctrl+shift+l | Install the latest version of all Data Positioning dependencies.                                           |
+| update:dataPosDeps | alt+ctrl+shift+l | Install the latest version of all Data Positioning dependencies.                                           |
 
 ## Compliance
 

package/dist/datapos-development.es.js

@@ -1,29 +1,11 @@
-const C = ["createObject", "dropObject", "removeRecords", "upsertRecords"], $ = ["findObject", "getRecord", "listNodes", "previewObject", "retrieveRecords"], _ = 0, L = (e) => e, F = () => Date.now(), k = {
-  cartesian_areaLine: { categoryId: "cartesian", typeId: "areaLine", label: { "en-gb": "Area Line" }, options: { highchartsType: "area" } },
-  cartesian_areaSpline: { categoryId: "cartesian", typeId: "areaSpline", label: { "en-gb": "Area Spline" }, options: { highchartsType: "area" } },
-  cartesian_bar: { categoryId: "cartesian", typeId: "bar", label: { "en-gb": "Bar" }, options: { highchartsType: "bar" } },
-  cartesian_column: { categoryId: "cartesian", typeId: "column", label: { "en-gb": "Column" }, options: { highchartsType: "column" } },
-  cartesian_line: { categoryId: "cartesian", typeId: "line", label: { "en-gb": "Line" }, options: { highchartsType: "line" } },
-  cartesian_pyramid: { categoryId: "cartesian", typeId: "line", label: { "en-gb": "Pyramid" }, options: { highchartsType: "line" } },
-  cartesian_spline: { categoryId: "cartesian", typeId: "line", label: { "en-gb": "Spline" }, options: { highchartsType: "line" } },
-  chordDiagram: { categoryId: "chordDiagram", label: { "en-gb": "Chord Diagram" }, options: {} },
-  polar_area: { categoryId: "polar", typeId: "area", label: { "en-gb": "Radar (Area)" }, options: { highchartsType: "area" } },
-  polar_column: { categoryId: "polar", typeId: "column", label: { "en-gb": "Radar (Column)" }, options: { highchartsType: "column" } },
-  polar_line: { categoryId: "polar", typeId: "line", label: { "en-gb": "Radar (Line)" }, options: { highchartsType: "line" } },
-  range_area: { categoryId: "range", typeId: "area", label: { "en-gb": "Range (Area)" }, options: { highchartsType: "arearange" } },
-  range_bar: { categoryId: "range", typeId: "bar", label: { "en-gb": "Range (Bar)" }, options: { highchartsType: "columnrange", inverted: !0 } },
-  range_column: { categoryId: "range", typeId: "column", label: { "en-gb": "Range (Column)" }, options: { highchartsType: "columnrange" } },
-  sankeyDiagram: { categoryId: "sankeyDiagram", label: { "en-gb": "Sankey Diagram" }, options: {} },
-  streamgraph: { categoryId: "streamgraph", label: { "en-gb": "Streamgraph" }, options: {} },
-  values: { categoryId: "values", label: { "en-gb": "Values" }, options: {} }
-};
-function M() {
+const C = ["createObject", "dropObject", "removeRecords", "upsertRecords"], $ = ["findObject", "getRecord", "listNodes", "previewObject", "retrieveRecords"];
+function _() {
   function e(t, a, r) {
     r.textContent = "Cytoscape.js diagram goes here...";
   }
   return { render: e };
 }
-function U() {
+function L() {
   function e(t, a, r) {
     r.textContent = "values table goes here...";
   }
@@ -31,7 +13,7 @@ function U() {
 }
 const v = "https://cdn.jsdelivr.net/npm/highcharts@11.4.3/es-modules/masters/", x = "highcharts";
 let b, T = !1;
-function j() {
+function F() {
   async function e(n, s, u, h) {
     await r();
     const l = [];
@@ -95,6 +77,25 @@ function j() {
   }
   return { renderCartesianChart: e, renderPolarChart: t, renderRangeChart: a };
 }
+const k = 0, M = (e) => e, U = () => Date.now(), j = {
+  cartesian_areaLine: { categoryId: "cartesian", typeId: "areaLine", label: { "en-gb": "Area Line" }, options: { highchartsType: "area" } },
+  cartesian_areaSpline: { categoryId: "cartesian", typeId: "areaSpline", label: { "en-gb": "Area Spline" }, options: { highchartsType: "area" } },
+  cartesian_bar: { categoryId: "cartesian", typeId: "bar", label: { "en-gb": "Bar" }, options: { highchartsType: "bar" } },
+  cartesian_column: { categoryId: "cartesian", typeId: "column", label: { "en-gb": "Column" }, options: { highchartsType: "column" } },
+  cartesian_line: { categoryId: "cartesian", typeId: "line", label: { "en-gb": "Line" }, options: { highchartsType: "line" } },
+  cartesian_pyramid: { categoryId: "cartesian", typeId: "line", label: { "en-gb": "Pyramid" }, options: { highchartsType: "line" } },
+  cartesian_spline: { categoryId: "cartesian", typeId: "line", label: { "en-gb": "Spline" }, options: { highchartsType: "line" } },
+  chordDiagram: { categoryId: "chordDiagram", label: { "en-gb": "Chord Diagram" }, options: {} },
+  polar_area: { categoryId: "polar", typeId: "area", label: { "en-gb": "Radar (Area)" }, options: { highchartsType: "area" } },
+  polar_column: { categoryId: "polar", typeId: "column", label: { "en-gb": "Radar (Column)" }, options: { highchartsType: "column" } },
+  polar_line: { categoryId: "polar", typeId: "line", label: { "en-gb": "Radar (Line)" }, options: { highchartsType: "line" } },
+  range_area: { categoryId: "range", typeId: "area", label: { "en-gb": "Range (Area)" }, options: { highchartsType: "arearange" } },
+  range_bar: { categoryId: "range", typeId: "bar", label: { "en-gb": "Range (Bar)" }, options: { highchartsType: "columnrange", inverted: !0 } },
+  range_column: { categoryId: "range", typeId: "column", label: { "en-gb": "Range (Column)" }, options: { highchartsType: "columnrange" } },
+  sankeyDiagram: { categoryId: "sankeyDiagram", label: { "en-gb": "Sankey Diagram" }, options: {} },
+  streamgraph: { categoryId: "streamgraph", label: { "en-gb": "Streamgraph" }, options: {} },
+  values: { categoryId: "values", label: { "en-gb": "Values" }, options: {} }
+};
 class I extends Error {
   locator;
   constructor(t, a, r) {
@@ -327,7 +328,7 @@ export {
   C as CONNECTOR_DESTINATION_OPERATIONS,
   $ as CONNECTOR_SOURCE_OPERATIONS,
   d as DEFAULT_LOCALE_CODE,
-  _ as DefaultTimestamp,
+  k as DefaultTimestamp,
   H as EngineError,
   w as FetchError,
   z as OperationalError,
@@ -336,7 +337,7 @@ export {
   P as WindowRuntimeError,
   V as buildFetchError,
   X as concatenateSerialisedErrorMessages,
-  L as convertMillisecondsToTimestamp,
+  M as convertMillisecondsToTimestamp,
   K as convertODataTypeIdToUsageTypeId,
   Q as extractExtensionFromPath,
   q as extractNameFromPath,
@@ -346,15 +347,15 @@ export {
   Z as formatNumberAsStorageSize,
   E as formatNumberAsWholeNumber,
   oe as getComponentStatus,
-  F as getCurrentTimestamp,
+  U as getCurrentTimestamp,
   te as getDataFormats,
   ae as getRecordDelimiters,
   ne as getValueDelimiters,
   re as lookupMimeTypeForExtension,
   G as normalizeToError,
-  k as presentationViewTypeMap,
+  j as presentationViewTypeMap,
   J as serialiseError,
-  M as useCytoscapeJS,
-  U as useDataTable,
-  j as useHighcharts
+  _ as useCytoscapeJS,
+  L as useDataTable,
+  F as useHighcharts
 };

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

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

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

@@ -1,5 +1,6 @@
-import { ComponentConfig, ComponentRef } from '..';
-export interface Context {
+import { Module } from '../../module';
+import { Component, ComponentConfig, ComponentRef } from '..';
+export interface Context extends Module, Component {
     readonly config: ContextConfig;
     list(settings?: ContextListSettings): Promise<ContextListResult>;
 }

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

@@ -1,6 +1,8 @@
-import { ComponentConfig } from '..';
 import { Timestamp } from '../../timestamp';
-import { ConnectionColumnConfig, ConnectionNodeConfig } from '../../connection';
+import { Component, ComponentConfig } from '..';
+import { ConnectionColumnConfig, ConnectionNodeConfig } from '../connector/connection';
+export interface DataView extends Component {
+}
 export interface DataViewConfig extends ComponentConfig {
     connectionId?: string;
     connectionNodeConfig?: ConnectionNodeConfig;

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

@@ -1,5 +1,8 @@
 import { Timestamp } from '../timestamp';
 import { LocaleCode, LocalisedString, StatusColorId } from '../index';
+export interface Component {
+    readonly config: ComponentConfig;
+}
 export interface ComponentConfig {
     id: string;
     label: Partial<LocalisedString>;

package/dist/types/src/component/informer/document.d.ts

@@ -0,0 +1,3 @@
+/**
+ * Document composables, constants, types/interfaces, errors and utilities..
+ */

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

@@ -0,0 +1,19 @@
+import { default as markdownIt } from 'markdown-it';
+import { Module } from '../../module';
+import { Component, ComponentConfig, ComponentRef } from '..';
+export interface Informer extends Module, Component {
+    readonly config: InformerConfig;
+    readonly tools: InformerTools;
+    list(): ComponentRef[];
+    render(informerPath: string, renderTo: HTMLElement, data?: unknown): Promise<void>;
+}
+export interface InformerConfig extends ComponentConfig {
+    version: string;
+}
+export type InformerLocalisedConfig = Omit<InformerConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
+export type InformerTools = {
+    markdownIt: typeof markdownIt;
+};

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

@@ -1,6 +1,7 @@
 import { default as markdownIt } from 'markdown-it';
-import { ComponentConfig, ComponentRef } from '..';
-export interface Presenter {
+import { Module } from '../../module';
+import { Component, ComponentConfig, ComponentRef } from '..';
+export interface Presenter extends Module, Component {
     readonly config: PresenterConfig;
     readonly tools: PresenterTools;
     list(): ComponentRef[];
@@ -17,106 +18,3 @@ export type PresenterLocalisedConfig = Omit<PresenterConfig, 'label' | 'descript
 export type PresenterTools = {
     markdownIt: typeof markdownIt;
 };
-export interface PresentationConfig extends ComponentConfig {
-    content: string;
-    order: number;
-}
-export type PresentationVisualConfig = {
-    content: PresentationVisualContentConfig;
-    views: PresentationVisualViewConfig[];
-};
-export type PresentationVisualContentConfig = {
-    title: {
-        text: string;
-    };
-    data: {
-        name: string;
-        categoryLabels: string[];
-        measures: {
-            id: string;
-            name: string;
-            data?: number[][];
-        }[];
-    };
-};
-export interface PresentationVisualViewConfig {
-    categoryId: 'cartesian' | 'chordDiagram' | 'polar' | 'range' | 'sankeyDiagram' | 'streamgraph' | 'values';
-    default?: boolean;
-}
-export interface PresentationVisualCartesianViewConfig extends PresentationVisualViewConfig {
-    categoryId: 'cartesian';
-    typeId: 'areaLine' | 'areaSpline' | 'bar' | 'column' | 'line' | 'pyramid' | 'spline';
-}
-export interface PresentationVisualChordDiagramViewConfig extends PresentationVisualViewConfig {
-    categoryId: 'chordDiagram';
-}
-export interface PresentationVisualPolarViewConfig extends PresentationVisualViewConfig {
-    categoryId: 'polar';
-    typeId: 'area' | 'column' | 'line';
-}
-export interface PresentationVisualRangeViewConfig extends PresentationVisualViewConfig {
-    categoryId: 'range';
-    typeId: 'area' | 'bar' | 'column';
-}
-export interface PresentationVisualSankeyDiagramViewConfig extends PresentationVisualViewConfig {
-    categoryId: 'sankeyDiagram';
-}
-export interface PresentationVisualStreamgraphViewConfig extends PresentationVisualViewConfig {
-    categoryId: 'streamgraph';
-}
-export interface PresentationVisualValuesViewConfig extends PresentationVisualViewConfig {
-    categoryId: 'values';
-}
-export type PresentationVisualViewType = PresentationVisualCartesianViewType | PresentationVisualChordViewType | PresentationVisualPolarViewType | PresentationVisualRangeViewType | PresentationVisualSankeyDiagramViewType | PresentationVisualStreamgraphViewType | PresentationVisualValuesViewType;
-export type PresentationVisualCartesianViewType = {
-    categoryId: 'cartesian';
-    typeId: 'areaLine' | 'areaSpline' | 'bar' | 'column' | 'line' | 'pyramid' | 'spline';
-    label: Record<string, string>;
-    options: {
-        highchartsType: 'area' | 'bar' | 'column' | 'line';
-        inverted?: boolean;
-    };
-};
-export type PresentationVisualChordViewType = {
-    categoryId: 'chordDiagram';
-    label: Record<string, string>;
-    options: {};
-};
-export type PresentationVisualPolarViewType = {
-    categoryId: 'polar';
-    typeId: 'area' | 'column' | 'line';
-    label: Record<string, string>;
-    options: {
-        highchartsType: 'area' | 'column' | 'line';
-        inverted?: boolean;
-    };
-};
-export type PresentationVisualRangeViewType = {
-    categoryId: 'range';
-    typeId: 'area' | 'bar' | 'column';
-    label: Record<string, string>;
-    options: {
-        highchartsType: 'arearange' | 'columnrange';
-        inverted?: boolean;
-    };
-};
-export type PresentationVisualSankeyDiagramViewType = {
-    categoryId: 'sankeyDiagram';
-    label: Record<string, string>;
-    options: {};
-};
-export type PresentationVisualStreamgraphViewType = {
-    categoryId: 'streamgraph';
-    label: Record<string, string>;
-    options: {};
-};
-export type PresentationVisualValuesViewType = {
-    categoryId: 'values';
-    label: Record<string, string>;
-    options: {};
-};
-export interface PresentationView {
-    resize: () => void;
-    vendorId: string;
-}
-export declare const presentationViewTypeMap: Record<string, PresentationVisualViewType>;

package/dist/types/src/component/presenter/presentation.d.ts

@@ -0,0 +1,104 @@
+import { ComponentConfig } from '..';
+export interface PresentationConfig extends ComponentConfig {
+    content: string;
+    order: number;
+}
+export type PresentationVisualConfig = {
+    content: PresentationVisualContentConfig;
+    views: PresentationVisualViewConfig[];
+};
+export type PresentationVisualContentConfig = {
+    title: {
+        text: string;
+    };
+    data: {
+        name: string;
+        categoryLabels: string[];
+        measures: {
+            id: string;
+            name: string;
+            data?: number[][];
+        }[];
+    };
+};
+export interface PresentationVisualViewConfig {
+    categoryId: 'cartesian' | 'chordDiagram' | 'polar' | 'range' | 'sankeyDiagram' | 'streamgraph' | 'values';
+    default?: boolean;
+}
+export interface PresentationVisualCartesianViewConfig extends PresentationVisualViewConfig {
+    categoryId: 'cartesian';
+    typeId: 'areaLine' | 'areaSpline' | 'bar' | 'column' | 'line' | 'pyramid' | 'spline';
+}
+export interface PresentationVisualChordDiagramViewConfig extends PresentationVisualViewConfig {
+    categoryId: 'chordDiagram';
+}
+export interface PresentationVisualPolarViewConfig extends PresentationVisualViewConfig {
+    categoryId: 'polar';
+    typeId: 'area' | 'column' | 'line';
+}
+export interface PresentationVisualRangeViewConfig extends PresentationVisualViewConfig {
+    categoryId: 'range';
+    typeId: 'area' | 'bar' | 'column';
+}
+export interface PresentationVisualSankeyDiagramViewConfig extends PresentationVisualViewConfig {
+    categoryId: 'sankeyDiagram';
+}
+export interface PresentationVisualStreamgraphViewConfig extends PresentationVisualViewConfig {
+    categoryId: 'streamgraph';
+}
+export interface PresentationVisualValuesViewConfig extends PresentationVisualViewConfig {
+    categoryId: 'values';
+}
+export type PresentationVisualViewType = PresentationVisualCartesianViewType | PresentationVisualChordViewType | PresentationVisualPolarViewType | PresentationVisualRangeViewType | PresentationVisualSankeyDiagramViewType | PresentationVisualStreamgraphViewType | PresentationVisualValuesViewType;
+export type PresentationVisualCartesianViewType = {
+    categoryId: 'cartesian';
+    typeId: 'areaLine' | 'areaSpline' | 'bar' | 'column' | 'line' | 'pyramid' | 'spline';
+    label: Record<string, string>;
+    options: {
+        highchartsType: 'area' | 'bar' | 'column' | 'line';
+        inverted?: boolean;
+    };
+};
+export type PresentationVisualChordViewType = {
+    categoryId: 'chordDiagram';
+    label: Record<string, string>;
+    options: {};
+};
+export type PresentationVisualPolarViewType = {
+    categoryId: 'polar';
+    typeId: 'area' | 'column' | 'line';
+    label: Record<string, string>;
+    options: {
+        highchartsType: 'area' | 'column' | 'line';
+        inverted?: boolean;
+    };
+};
+export type PresentationVisualRangeViewType = {
+    categoryId: 'range';
+    typeId: 'area' | 'bar' | 'column';
+    label: Record<string, string>;
+    options: {
+        highchartsType: 'arearange' | 'columnrange';
+        inverted?: boolean;
+    };
+};
+export type PresentationVisualSankeyDiagramViewType = {
+    categoryId: 'sankeyDiagram';
+    label: Record<string, string>;
+    options: {};
+};
+export type PresentationVisualStreamgraphViewType = {
+    categoryId: 'streamgraph';
+    label: Record<string, string>;
+    options: {};
+};
+export type PresentationVisualValuesViewType = {
+    categoryId: 'values';
+    label: Record<string, string>;
+    options: {};
+};
+export interface PresentationView {
+    resize: () => void;
+    vendorId: string;
+}
+export declare const presentationViewTypeMap: Record<string, PresentationVisualViewType>;

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

@@ -1,4 +1,5 @@
 import { ConnectionConfig } from '../component/connector/connection';
+import { Module } from '../module';
 import { AuditContentResult, ConnectorCallbackData, ConnectorOperationSettings, InitialiseSettings, ListResult, RetrieveResult } from '../component/connector';
 import { ContextCallbackData, ContextConfig, ContextOperationSettings } from '../component/context';
 import { DataViewPreviewConfig, EncodingConfig } from '../component/dataView';
@@ -7,7 +8,7 @@ type ProcessConnectorRequest = (id: string, connectionConfig: ConnectionConfig,
 export type ContextInterfaceResult = AuditContentResult | DataViewPreviewConfig | ListResult | RetrieveResult;
 type ProcessContextRequest = (id: string, contextConfig: ContextConfig, settings: ContextOperationSettings, callback?: ((callbackData: ConnectorCallbackData) => void) | undefined) => Promise<ConnectorInterfaceResult>;
 export type ConnectorInterfaceResult = AuditContentResult | DataViewPreviewConfig | ListResult | RetrieveResult;
-export interface Engine {
+export interface Engine extends Module {
     getEncodingConfigs: (localeId: string) => EncodingConfig[];
     invokeWorker(errorEventCallback: (errorEvent: ErrorEvent) => void): EngineWorker;
 }

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

@@ -1,5 +1,5 @@
 /**
- * Shared composables, constants, interfaces, errors, types and utilities.
+ * Shared composables, constants, types/interfaces, errors and utilities.
  */
 export type LocaleCode = 'en-au' | 'en-gb' | 'en-us' | 'es-es';
 export type LocalisedString = Record<LocaleCode, string>;
@@ -27,40 +27,43 @@ export type { RetrieveResult, RetrieveSettings, RetrieveSummary } from './compon
 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.
+export type { Context, ContextConfig, ContextLocalisedConfig, ContextListSettings, ContextListResult } from './component/context';
+export type { ContextModelGroupConfig, ContextModelGroupLocalisedConfig, ContextModelConfig, ContextModelLocalisedConfig } from './component/context';
+export type { ContextModelDimensionGroupConfig, ContextModelDimensionGroupLocalisedConfig, ContextModelDimensionConfig, ContextModelDimensionLocalisedConfig, ContextModelDimensionHierarchyConfig, ContextModelDimensionHierarchyLocalisedConfig } from './component/context';
+export type { ContextModelEntityGroupConfig, ContextModelEntityGroupLocalisedConfig, ContextModelEntityConfig, ContextModelEntityLocalisedConfig, ContextModelEntityDataItemConfig, // Data items.
 ContextModelEntityDataItemLocalisedConfig, ContextModelEntityEventConfig, // Events.
 ContextModelEntityEventLocalisedConfig, ContextModelEntityPrimaryMeasureConfig, // Primary measures.
-ContextModelEntityPrimaryMeasureLocalisedConfig, ContextModelSecondaryMeasureGroupConfig, ContextModelSecondaryMeasureGroupLocalisedConfig, ContextModelSecondaryMeasureConfig, ContextModelSecondaryMeasureLocalisedConfig } from './component/context';
+ContextModelEntityPrimaryMeasureLocalisedConfig } from './component/context';
+export type { 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 './component/eventQuery';
+export type { Informer, InformerConfig, InformerLocalisedConfig, InformerTools } from './component/informer';
 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 type { PresentationConfig, PresentationView } from './component/presenter/presentation';
+export type { PresentationVisualConfig, PresentationVisualContentConfig, PresentationVisualViewConfig, PresentationVisualCartesianViewConfig, PresentationVisualChordDiagramViewConfig, PresentationVisualPolarViewConfig, PresentationVisualRangeViewConfig, PresentationVisualSankeyDiagramViewConfig, PresentationVisualStreamgraphViewConfig, PresentationVisualValuesViewConfig } from './component/presenter/presentation';
+export type { PresentationVisualViewType, PresentationVisualCartesianViewType, PresentationVisualChordViewType, PresentationVisualPolarViewType, PresentationVisualRangeViewType, PresentationVisualSankeyDiagramViewType, PresentationVisualStreamgraphViewType, PresentationVisualValuesViewType } from './component/presenter/presentation';
 export interface ContextOperationSettings {
     accountId?: string;
     appCheckToken?: string;
     sessionAccessToken?: string;
 }
 export type { Timestamp } from './timestamp';
-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 declare const DEFAULT_LOCALE_CODE: LocaleCode;
+export { DefaultTimestamp } from './timestamp';
+export { presentationViewTypeMap } from './component/presenter/presentation';
 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 './appUtilities';
-export { extractExtensionFromPath, extractNameFromPath } from './appUtilities';
-export { formatNumberAsDecimalNumber, formatNumberAsDuration, formatNumberAsSize, formatNumberAsStorageSize, formatNumberAsWholeNumber } from './appUtilities';
+export { convertODataTypeIdToUsageTypeId } from './utilities';
+export { extractExtensionFromPath, extractNameFromPath } from './utilities';
+export { formatNumberAsDecimalNumber, formatNumberAsDuration, formatNumberAsSize, formatNumberAsStorageSize, formatNumberAsWholeNumber } from './utilities';
 export { getDataFormats, getRecordDelimiters, getValueDelimiters } from './component/dataView';
 export { getComponentStatus } from './component';
-export { lookupMimeTypeForExtension } from './appUtilities';
+export { lookupMimeTypeForExtension } from './utilities';

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

@@ -1,5 +1,7 @@
 import { ContextModelGroupConfig } from '../component/context';
 import { LocalisedString } from '../index';
+export interface Module {
+}
 export interface ModuleConfig {
     id: string;
     label: Partial<LocalisedString>;
@@ -8,7 +10,7 @@ export interface ModuleConfig {
     typeId: ModuleTypeId;
     version: string;
 }
-type ModuleTypeId = 'app' | 'engine' | 'connector' | 'context' | 'presenter' | 'informer';
+type ModuleTypeId = 'app' | 'engine' | 'connector' | 'context' | 'informer' | 'presenter';
 export interface AppModuleConfig extends ModuleConfig {
     typeId: 'app';
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@datapos/datapos-shared",
-    "version": "0.3.152",
+    "version": "0.3.156",
     "description": "A TypeScript library containing common declarations and utilities used across other Data Positioning repositories.",
     "license": "MIT",
     "private": false,
@@ -25,7 +25,7 @@
         "dist"
     ],
     "devDependencies": {
-        "@datapos/datapos-development": "^0.3.63",
+        "@datapos/datapos-development": "^0.3.64",
         "@types/markdown-it": "^14.1.2",
         "@types/node": "^24.10.0",
         "@typescript-eslint/eslint-plugin": "^8.46.3",