@datapos/datapos-shared 0.3.138 → 0.3.140

package/README.md

@@ -15,7 +15,9 @@ npm install @datapos/datapos-shared
 
 ## Declarations
 
-### Component Types
+### Components
+
+#### Component Types
 
 | Item                                  | Notes                                                        |
 | ------------------------------------- | ------------------------------------------------------------ |
@@ -26,14 +28,14 @@ npm install @datapos/datapos-shared
 | ComponentTypeId                       |                                                              |
 | StatusColorId                         |                                                              |
 
-### Connector and Connection Types
+#### Connector and Connection Types
 
 | 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 Types
 
 | Item                                        | Notes                                                                 |
 | ------------------------------------------- | --------------------------------------------------------------------- |
@@ -70,14 +72,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 |                                                                                                            |
 | 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 |                                                                                                            |
 | 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.                             |
-| test               | alt+ctrl+shift+t | NOT implemented.                                                                                           |
-| updateDependencies | alt+ctrl+shift+u | Install the latest version of outdated Data Positioning packages.                                          |
+| test               | alt+ctrl+shift+t | ❌ Not implemented.                                                                                        |
+| updateDependencies | alt+ctrl+shift+l | Install the latest version of all Data Positioning dependencies.                                           |
 
 ## Compliance
 

package/dist/datapos-shared.es.js

@@ -1,4 +1,4 @@
-const R = 0, L = (e) => e, F = () => Date.now(), _ = {
+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" } },
@@ -17,21 +17,21 @@ 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 M() {
   function e(t, a, r) {
     r.textContent = "Cytoscape.js diagram goes here...";
   }
   return { render: e };
 }
-function O() {
+function U() {
   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() {
+const v = "https://cdn.jsdelivr.net/npm/highcharts@11.4.3/es-modules/masters/", x = "highcharts";
+let b, T = !1;
+function j() {
   async function e(n, s, u, h) {
     await r();
     const l = [];
@@ -45,7 +45,7 @@ function M() {
       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 };
+    return { chart: m, resize: () => m.reflow(), vendorId: x };
   }
   async function t(n, s, u, h) {
     await Promise.all([r(), o()]);
@@ -60,7 +60,7 @@ function M() {
       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 };
+    return { chart: m, resize: () => m.reflow(), vendorId: x };
   }
   async function a(n, s, u, h) {
     await Promise.all([r(), o()]);
@@ -76,7 +76,7 @@ function M() {
       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 };
+    return { chart: c, resize: () => c.reflow(), vendorId: x };
   }
   async function r() {
     if (b) return;
@@ -90,8 +90,8 @@ function M() {
     );
   }
   async function o() {
-    if (w) return;
-    await import(`${v}highcharts-more.src.js`), w = !0;
+    if (T) return;
+    await import(`${v}highcharts-more.src.js`), T = !0;
   }
   return { renderCartesianChart: e, renderPolarChart: t, renderRangeChart: a };
 }
@@ -106,17 +106,17 @@ class p extends I {
     super(t, a, r), this.name = "ApplicationError";
   }
 }
-class U extends p {
+class B extends p {
   constructor(t, a, r) {
     super(t, a, r), this.name = "APIError";
   }
 }
-class B extends p {
+class H extends p {
   constructor(t, a, r) {
     super(t, a, r), this.name = "EngineError";
   }
 }
-class T extends p {
+class w extends p {
   body;
   constructor(t, a, r, o) {
     super(t, a, o), this.name = "FetchError", this.body = r;
@@ -129,29 +129,29 @@ class S extends p {
     super(t, a, n), this.name = "VueHandledError", this.info = r, this.componentName = o;
   }
 }
-class j extends p {
+class P extends p {
   constructor(t, a, r) {
     super(t, a, r), this.name = "WindowHandledRuntimeError";
   }
 }
-class H extends p {
+class W extends p {
   constructor(t, a, r) {
     super(t, a, r), this.name = "WindowHandledPromiseRejectionError";
   }
 }
-class W extends I {
+class z extends I {
   constructor(t, a, r) {
     super(t, a, r), this.name = "OperationalError";
   }
 }
-async function z(e, t, a) {
+async function V(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);
+  return new w(r, a, o);
 }
-function P(e) {
+function X(e) {
   return e.map((t) => t.message).join(" ");
 }
-function V(e, t = "Unknown error.") {
+function G(e, t = "Unknown error.") {
   if (e instanceof Error) return e;
   if (typeof e == "string") return new Error(e);
   try {
@@ -160,13 +160,13 @@ function V(e, t = "Unknown error.") {
     return new Error(t);
   }
 }
-function X(e) {
+function J(e) {
   const t = /* @__PURE__ */ new Set(), a = [];
   let r = e;
   for (; r && !t.has(r); ) {
     t.add(r);
     let o;
-    if (r instanceof T)
+    if (r instanceof w)
       o = { body: r.body, locator: r.locator, message: r.message, name: r.name, stack: r.stack }, r = r.cause;
     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;
@@ -180,7 +180,7 @@ function X(e) {
   }
   return a;
 }
-const D = "en-US", y = {}, G = (e) => {
+const D = "en-US", y = {}, K = (e) => {
   switch (e) {
     case "Edm.Binary":
       return "unknown";
@@ -219,12 +219,12 @@ const D = "en-US", y = {}, G = (e) => {
     default:
       return "unknown";
   }
-}, J = (e) => {
+}, q = (e) => {
   if (e) {
     const t = e.lastIndexOf("/"), a = e.lastIndexOf(".", t > -1 ? t : e.length);
     return a > -1 ? e.substring(0, a) : e;
   }
-}, K = (e) => {
+}, Q = (e) => {
   if (e) {
     const t = e.lastIndexOf(".");
     if (t > -1) return e.substring(t + 1);
@@ -241,7 +241,7 @@ const D = "en-US", y = {}, G = (e) => {
     style: "decimal",
     useGrouping: !0
   }), y[o] = n), n.format(e);
-}, q = (e) => e == null ? "" : e < 1e3 ? x(e) : e < 1e6 ? `${i(e / 1e3, 2, 0)}K` : e < 1e9 ? `${i(e / 1e6, 2, 0)}M` : e < 1e12 ? `${i(e / 1e9, 2, 0)}B` : `${i(e / 1e12, 2, 0)}T`, Q = (e) => e == null ? "" : e === 1 ? "1 byte" : e < 1024 ? `${x(e)} bytes` : e < 1048576 ? `${i(e / 1024, 2, 0)} KB` : e < 1073741824 ? `${i(e / 1048576, 2, 0)} MB` : e < 1099511627776 ? `${i(e / 1073741824, 2, 0)} GB` : `${i(e / 1099511627776, 2, 0)} TB`, Y = (e) => e == null ? "" : e < 1e3 ? `${x(e)} ms` : e === 1e3 ? `${x(e)} sec` : e < 6e4 ? `${i(e / 1e3, 2, 0)} secs` : e === 6e4 ? "1 min" : e < 36e5 ? `${i(e / 6e4, 2, 0)} mins` : e === 36e5 ? "1 hr" : e < 864e5 ? `${i(e / 36e5, 2, 0)} hrs` : e === 864e5 ? "1 day" : `${i(e / 864e5, 2, 0)} days`, x = (e, t = D) => {
+}, Y = (e) => e == null ? "" : e < 1e3 ? E(e) : e < 1e6 ? `${i(e / 1e3, 2, 0)}K` : e < 1e9 ? `${i(e / 1e6, 2, 0)}M` : e < 1e12 ? `${i(e / 1e9, 2, 0)}B` : `${i(e / 1e12, 2, 0)}T`, Z = (e) => e == null ? "" : e === 1 ? "1 byte" : e < 1024 ? `${E(e)} bytes` : e < 1048576 ? `${i(e / 1024, 2, 0)} KB` : e < 1073741824 ? `${i(e / 1048576, 2, 0)} MB` : e < 1099511627776 ? `${i(e / 1073741824, 2, 0)} GB` : `${i(e / 1099511627776, 2, 0)} TB`, ee = (e) => e == null ? "" : e < 1e3 ? `${E(e)} ms` : e === 1e3 ? `${E(e)} sec` : e < 6e4 ? `${i(e / 1e3, 2, 0)} secs` : e === 6e4 ? "1 min" : e < 36e5 ? `${i(e / 6e4, 2, 0)} mins` : e === 36e5 ? "1 hr" : e < 864e5 ? `${i(e / 36e5, 2, 0)} hrs` : e === 864e5 ? "1 day" : `${i(e / 864e5, 2, 0)} days`, E = (e, t = D) => {
   if (e == null) return "";
   const a = `${t}decimal0.0`;
   let r = y[a];
@@ -253,7 +253,7 @@ const D = "en-US", y = {}, G = (e) => {
     style: "decimal",
     useGrouping: !0
   }), y[a] = r), r.format(e);
-}, Z = (e) => {
+}, re = (e) => {
   switch (e) {
     case "csv":
       return "text/csv";
@@ -267,7 +267,7 @@ const D = "en-US", y = {}, G = (e) => {
     default:
       return "application/octet-stream";
   }
-}, A = [
+}, N = [
   { id: "dtv", label: { "en-gb": "Delimited Text" } },
   { id: "e/e", label: { "en-gb": "Entity/Event" } },
   { id: "jsonArray", label: { "en-gb": "JSON Array" } },
@@ -275,22 +275,22 @@ const D = "en-US", y = {}, G = (e) => {
   { id: "xls", label: { "en-gb": "XLS" } },
   { id: "xlsx", label: { "en-gb": "XLSX" } },
   { id: "xml", label: { "en-gb": "XML" } }
-], ee = (e = d) => {
+], te = (e = d) => {
   const t = [];
-  for (const a of A) t.push({ ...a, label: a.label[e] || a.label[d] || a.id });
+  for (const a of N) t.push({ ...a, label: a.label[e] || a.label[d] || a.id });
   return t;
-}, N = [
+}, R = [
   { id: `
 `, label: { "en-gb": "Newline" } },
   { id: "\r", label: { "en-gb": "Carriage Return" } },
   { id: `\r
 `, label: { "en-gb": "Carriage Return/Newline" } }
-], re = (e = d) => {
+], ae = (e = d) => {
   const t = [];
-  for (const a of N)
+  for (const a of R)
     t.push({ ...a, label: a.label[e] || a.label[d] || a.id });
   return t;
-}, $ = [
+}, A = [
   { id: ":", label: { "en-gb": "Colon" } },
   { id: ",", label: { "en-gb": "Comma" } },
   { id: "!", label: { "en-gb": "Exclamation Mark" } },
@@ -302,12 +302,12 @@ const D = "en-US", y = {}, G = (e) => {
   { id: "_", label: { "en-gb": "Underscore" } },
   { id: "0x1F", label: { "en-gb": "Unit Separator" } },
   { id: "|", label: { "en-gb": "Vertical Bar" } }
-], te = (e = d) => {
+], ne = (e = d) => {
   const t = [];
-  for (const a of $)
+  for (const a of A)
     t.push({ ...a, label: a.label[e] || a.label[d] || a.id });
   return t;
-}, C = [
+}, O = [
   { id: "alpha", color: "red", label: { "en-gb": "alpha" } },
   { id: "beta", color: "amber", label: { "en-gb": "beta" } },
   { id: "generalAvailability", color: "green", label: { "en-gb": "" } },
@@ -317,42 +317,44 @@ const D = "en-US", y = {}, G = (e) => {
   { id: "releaseCandidate", color: "green", label: { "en-gb": "release-candidate" } },
   { id: "unavailable", color: "other", label: { "en-gb": "unavailable" } },
   { id: "underReview", color: "other", label: { "en-gb": "under-review" } }
-], ae = (e, t = d) => {
-  const a = C.find((r) => r.id === e);
+], oe = (e, t = d) => {
+  const a = O.find((r) => r.id === e);
   return a ? { ...a, label: a.label[t] || a.label[d] || e } : { id: e, color: "other", label: e };
 }, d = "en-gb";
 export {
-  U as APIError,
+  B as APIError,
   p as ApplicationError,
+  C as CONNECTOR_DESTINATION_OPERATIONS,
+  $ as CONNECTOR_SOURCE_OPERATIONS,
   d as DEFAULT_LOCALE_CODE,
-  R as DefaultTimestamp,
-  B as EngineError,
-  T as FetchError,
-  W as OperationalError,
+  _ as DefaultTimestamp,
+  H as EngineError,
+  w as FetchError,
+  z as OperationalError,
   S as VueError,
-  H as WindowPromiseRejectionError,
-  j as WindowRuntimeError,
-  z as buildFetchError,
-  P as concatenateSerialisedErrorMessages,
+  W as WindowPromiseRejectionError,
+  P as WindowRuntimeError,
+  V as buildFetchError,
+  X as concatenateSerialisedErrorMessages,
   L as convertMillisecondsToTimestamp,
-  G as convertODataTypeIdToUsageTypeId,
-  K as extractExtensionFromPath,
-  J as extractNameFromPath,
+  K as convertODataTypeIdToUsageTypeId,
+  Q as extractExtensionFromPath,
+  q as extractNameFromPath,
   i as formatNumberAsDecimalNumber,
-  Y as formatNumberAsDuration,
-  q as formatNumberAsSize,
-  Q as formatNumberAsStorageSize,
-  x as formatNumberAsWholeNumber,
-  ae as getComponentStatus,
+  ee as formatNumberAsDuration,
+  Y as formatNumberAsSize,
+  Z as formatNumberAsStorageSize,
+  E as formatNumberAsWholeNumber,
+  oe as getComponentStatus,
   F as getCurrentTimestamp,
-  ee as getDataFormats,
-  re as getRecordDelimiters,
-  te as getValueDelimiters,
-  Z as lookupMimeTypeForExtension,
-  V as normalizeToError,
-  _ as presentationViewTypeMap,
-  X as serialiseError,
-  k as useCytoscapeJS,
-  O as useDataTable,
-  M as useHighcharts
+  te as getDataFormats,
+  ae as getRecordDelimiters,
+  ne as getValueDelimiters,
+  re as lookupMimeTypeForExtension,
+  G as normalizeToError,
+  k as presentationViewTypeMap,
+  J as serialiseError,
+  M as useCytoscapeJS,
+  U as useDataTable,
+  j as useHighcharts
 };

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

@@ -4,7 +4,14 @@
 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 type { AppModuleConfig, ConnectorModuleConfig, EngineModuleConfig, InformerModuleConfig, PresenterModuleConfig } from './module';
+export type { ModuleConfig } from './module';
+export type { AppModuleConfig } from './module';
+export type { ConnectorModuleConfig, ConnectorModuleOperation, ConnectorModuleUsageId } from './module';
+export type { ContextModuleConfig, ContextModuleOperation } from './module';
+export type { EngineModuleConfig } from './module';
+export type { InformerModuleConfig, InformerModuleOperation } from './module';
+export type { PresenterModuleConfig, PresenterModuleOperation } from './module';
+export { CONNECTOR_DESTINATION_OPERATIONS, CONNECTOR_SOURCE_OPERATIONS } from './module';
 export type { ComponentConfig, ComponentRef, ComponentStatus, ComponentStatusId, ComponentTypeId } from './component';
 export type { AuditContentResult, AuditContentSettings } from './component/connector';
 export type { Connector, ConnectorCallbackData, ConnectorConfig, ConnectorImplementation, ConnectorOperationSettings, ConnectorLocalisedConfig, ConnectorTools } from './component/connector';

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

@@ -1,6 +1,6 @@
 import { ContextModelGroupConfig } from '../component/context';
 import { LocalisedString } from '../index';
-interface ModuleConfig {
+export interface ModuleConfig {
     id: string;
     label: Partial<LocalisedString>;
     description: Partial<LocalisedString>;

package/package.json

@@ -2,8 +2,8 @@
     "name": "@datapos/datapos-shared",
     "license": "MIT",
     "private": false,
-    "version": "0.3.138",
     "type": "module",
+    "version": "0.3.140",
     "files": [
         "dist"
     ],
@@ -34,7 +34,6 @@
         "npm-check-updates": "^19.1.2",
         "prettier": "^3.6.2",
         "retire": "^5.3.0",
-        "type-fest": "^5.2.0",
         "typescript": "^5.9.3",
         "vite": "^7.2.1",
         "vite-plugin-dts": "^4.5.4"
@@ -45,13 +44,12 @@
         "bumpVersion": "node -e \"import('@datapos/datapos-development').then(m => m.bumpVersion())\"",
         "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/",
+        "format": "prettier --write src/",
+        "lint": "eslint .",
         "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()\"",
         "test": "echo \"***** TEST SCRIPT NOT IMPLEMENTED. *****\"",
-        "updateDependencies": "npm run updateOperations",
-        "updateOperations": "npm install -D @datapos/datapos-development@latest"
+        "updateDependencies": "npm install -D @datapos/datapos-development@latest"
     }
 }