@datapos/datapos-shared 0.3.454 → 0.3.455

package/dist/datapos-shared-component.es.js

@@ -1,4 +1,4 @@
-import { D as a } from "./locale-DR89RW6v.js";
+import { D as a } from "./locale-DTTQsZic.js";
 import { c as s } from "./componentConfig.schema-DInGC5Y6.js";
 const n = [
   { id: "alpha", color: "red", labels: { "en-gb": "alpha" } },

package/dist/datapos-shared-connector.es.js

@@ -1,4 +1,4 @@
-import { D as s } from "./locale-DR89RW6v.js";
+import { D as s } from "./locale-DTTQsZic.js";
 import { l as n, o as i, n as a, b as d, r as b, d as p, s as e, e as o, f as l, g as C, h as g, p as u } from "./componentConfig.schema-DInGC5Y6.js";
 import { m as h } from "./moduleConfig.schema-BJfbCrO6.js";
 const S = n(["apiKey", "disabled", "oAuth2", "none"]), f = i({

package/dist/datapos-shared-dataview.es.js

@@ -1,8 +1,8 @@
-const e = (l) => new Map(Object.entries(l));
-e({ "en-gb": "Delimited Text" }), e({ "en-gb": "Entity/Event" }), e({ "en-gb": "JSON" }), e({ "en-gb": "SPSS" }), e({ "en-gb": "XLS" }), e({ "en-gb": "XLSX" }), e({ "en-gb": "XML" });
+import { c as e } from "./locale-DTTQsZic.js";
+e({ "en-gb": "Data Positioning Events" }), e({ "en-gb": "Delimited Text" }), e({ "en-gb": "JSON" }), e({ "en-gb": "SPSS" }), e({ "en-gb": "XLSX" }), e({ "en-gb": "XML" });
 e({ "en-gb": "Newline" }), e({ "en-gb": "Carriage Return" }), e({ "en-gb": "Carriage Return/Newline" });
 e({ "en-gb": "Colon" }), e({ "en-gb": "Comma" }), e({ "en-gb": "Exclamation Mark" }), e({ "en-gb": "Record Separator" }), e({ "en-gb": "Semicolon" }), e({ "en-gb": "Space" }), e({ "en-gb": "Tab" }), e({ "en-gb": "Underscore" }), e({ "en-gb": "Unit Separator" }), e({ "en-gb": "Vertical Bar" });
-const b = [",", ";", "	", "|", " ", ":", "_", "!", "0x1F", "0x1E"];
+const a = [",", ";", "	", "|", " ", ":", "_", "!", "0x1F", "0x1E"];
 export {
-  b as ORDERED_VALUE_DELIMITER_IDS
+  a as ORDERED_VALUE_DELIMITER_IDS
 };

package/dist/locale-DTTQsZic.js

@@ -0,0 +1,5 @@
+const a = "en-gb", t = (e) => new Map(Object.entries(e));
+export {
+  a as D,
+  t as c
+};

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

@@ -4,7 +4,7 @@ import { EngineUtilities } from '../../engine';
 import { ToolConfig } from '../tool';
 import { ConnectionDescription, ConnectionNodeConfig } from './connection';
 import { connectorCategoryConfigSchema, connectorConfigSchema, connectorOperationNameSchema, connectorUsageIdSchema } from './connectorConfig.schema';
-import { DataViewPreviewConfig, ValueDelimiterId } from '../dataView';
+import { DataViewPreviewConfig, RecordValueDelimiterId } from '../dataView';
 /**
  * Connector interface and constructor.
  */
@@ -178,7 +178,7 @@ interface RetrieveChunksOptions extends ConnectorOperationOptions {
     chunkSize?: number;
     encodingId: string;
     path: string;
-    valueDelimiterId: ValueDelimiterId;
+    valueDelimiterId: RecordValueDelimiterId;
 }
 /**
  * Retrieve records options and summary.
@@ -187,7 +187,7 @@ interface RetrieveRecordsOptions extends ConnectorOperationOptions {
     chunkSize?: number;
     encodingId: string;
     path: string;
-    valueDelimiterId: ValueDelimiterId;
+    valueDelimiterId: RecordValueDelimiterId;
 }
 interface RetrieveRecordsSummary {
     /**

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

@@ -1,6 +1,10 @@
 import { FileTypeResult } from 'file-type';
-import { ComponentConfig } from '..';
+import { Component, ComponentConfig } from '..';
 import { ConnectionColumnConfig, ConnectionNodeConfig, UsageTypeId } from '../connector/connection';
+/**
+ * Data view interface.
+ */
+type DataViewInterface = Component;
 /**
  * Data view configuration.
  */
@@ -12,36 +16,43 @@ interface DataViewConfig extends ComponentConfig {
     relationshipsAuditConfig?: DataViewRelationshipsAuditConfig;
 }
 /**
- * Data view content audit configuration.
+ * Data view localised configuration.
  */
-interface DataViewContentAuditConfig {
-    asAt: number;
-    columns: ConnectionColumnConfig[];
-    commentLineCount: number;
-    emptyLineCount: number;
-    invalidFieldLengthCount: number;
-    duration: number;
-    lineCount: number;
-    recordCount: number;
-}
+type DataViewLocalisedConfig = Omit<DataViewConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
 /**
  * Data view preview configuration.
  */
 interface DataViewPreviewConfig {
     asAt: number;
     columnConfigs: ConnectionColumnConfig[];
-    dataFormatId: DataFormatId | undefined;
+    dataFormatId: ObjectDataFormatId | undefined;
     duration: number;
     encodingConfidenceLevel: number | undefined;
     encodingId: string | undefined;
     errorMessage?: string;
     fileType: FileTypeResult | undefined;
     hasHeaders: boolean | undefined;
-    recordDelimiterId?: RecordDelimiterId;
+    recordDelimiterId?: ObjectRecordDelimiterId;
     records: ParseResult[][];
     size: number;
     text: string;
-    valueDelimiterId?: ValueDelimiterId;
+    valueDelimiterId?: RecordValueDelimiterId;
+}
+/**
+ * Data view content audit configuration.
+ */
+interface DataViewContentAuditConfig {
+    asAt: number;
+    columns: ConnectionColumnConfig[];
+    commentLineCount: number;
+    emptyLineCount: number;
+    invalidFieldLengthCount: number;
+    duration: number;
+    lineCount: number;
+    recordCount: number;
 }
 /**
  * Data view relationships audit configuration.
@@ -49,7 +60,13 @@ interface DataViewPreviewConfig {
 interface DataViewRelationshipsAuditConfig {
     placeholder?: string;
 }
-declare const ORDERED_VALUE_DELIMITER_IDS: ValueDelimiterId[];
+type ObjectDataFormatId = 'dpe' | 'dtv' | 'json' | 'spss' | 'xlsx' | 'xml';
+type ObjectRecordDelimiterId = '\n' | '\r' | '\r\n';
+type RecordValueDelimiterId = '' | ':' | ',' | '!' | '0x1E' | ';' | ' ' | '\t' | '_' | '0x1F' | '|';
+/**
+ *
+ */
+declare const ORDERED_VALUE_DELIMITER_IDS: RecordValueDelimiterId[];
 /**
  * Parsed value.
  */
@@ -63,14 +80,14 @@ interface ParseResult {
     parsedValue: ParsedValue;
     usageTypeId: UsageTypeId;
 }
-type DataFormatId = 'dtv' | 'e/e' | 'json' | 'spss' | 'xls' | 'xlsx' | 'xml';
-type RecordDelimiterId = '\n' | '\r' | '\r\n';
-type ValueDelimiterId = '' | ':' | ',' | '!' | '0x1E' | ';' | ' ' | '\t' | '_' | '0x1F' | '|';
-type DataTypeId = 'boolean' | 'numeric' | 'string' | 'temporal';
-type NumericTypeId = 'bigint' | 'integer' | 'decimal';
-type NumericUnitsId = 'currency' | 'percentage' | 'plain';
-type StringTypeId = 'email' | 'ipv4' | 'ipv6' | 'ulid' | 'uuid' | 'url' | 'plain';
-type TemporalTypeId = 'date' | 'dateTime' | 'time';
+type ValueDataTypeId = 'boolean' | 'numeric' | 'string' | 'temporal';
+type ValueNumericTypeId = 'bigint' | 'integer' | 'decimal';
+type ValueNumericUnitsId = 'currency' | 'percentage' | 'plain';
+type ValueStringTypeId = 'email' | 'ipv4' | 'ipv6' | 'ulid' | 'uuid' | 'url' | 'plain';
+type ValueTemporalTypeId = 'date' | 'dateTime' | 'time';
 export { ORDERED_VALUE_DELIMITER_IDS };
-export type { DataFormatId, DataViewContentAuditConfig, DataViewConfig, DataViewPreviewConfig, ParseResult, RecordDelimiterId, ValueDelimiterId };
-export type { DataTypeId, NumericTypeId, NumericUnitsId, StringTypeId, TemporalTypeId };
+export type { DataViewInterface, DataViewConfig, DataViewLocalisedConfig };
+export type { DataViewContentAuditConfig, DataViewPreviewConfig };
+export type { ParseResult };
+export type { ObjectDataFormatId, ObjectRecordDelimiterId, RecordValueDelimiterId };
+export type { ValueDataTypeId, ValueNumericTypeId, ValueNumericUnitsId, ValueStringTypeId, ValueTemporalTypeId };

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

@@ -4,7 +4,7 @@ import { ModuleConfig } from '../component/module';
 import { ToolConfig } from '../component/tool';
 import { ConnectionColumnConfig, ConnectorOperationOptions } from '../component/connector';
 import { ContextConfig, ContextOperationOptions } from '../component/context';
-import { DataViewContentAuditConfig, ParseResult, ValueDelimiterId } from '../component/dataView';
+import { DataViewContentAuditConfig, ParseResult, RecordValueDelimiterId } from '../component/dataView';
 /**
  * Engine runtime interface.
  */
@@ -26,15 +26,6 @@ interface EngineWorkerInitialiseOptions {
     connectorStorageURLPrefix: string;
     toolConfigs: ToolConfig[];
 }
-/**
- * Engine shared.
- */
-interface EngineUtilities {
-    parseRecord: (columnConfigs: ConnectionColumnConfig[], record: {
-        value: string | null | undefined;
-        isQuoted: boolean;
-    }[], isPreview: boolean) => ParseResult[];
-}
 /**
  * Engine configuration.
  */
@@ -48,6 +39,15 @@ interface EngineCallbackData {
     typeId: string;
     properties: Record<string, unknown>;
 }
+/**
+ * Engine utilities.
+ */
+interface EngineUtilities {
+    parseRecord: (columnConfigs: ConnectionColumnConfig[], record: {
+        value: string | null | undefined;
+        isQuoted: boolean;
+    }[], isPreview: boolean) => ParseResult[];
+}
 /**
  * Audit object content options and result.
  */
@@ -55,7 +55,7 @@ interface AuditObjectContentOptions extends ConnectorOperationOptions {
     chunkSize: number | undefined;
     encodingId: string;
     path: string;
-    valueDelimiterId: ValueDelimiterId;
+    valueDelimiterId: RecordValueDelimiterId;
 }
 interface AuditObjectContentResult {
     contentAuditConfig: DataViewContentAuditConfig;

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

@@ -1,12 +1,26 @@
 /**
  * Locale constants and type declarations.
  */
-/** Constants */
 declare const DEFAULT_LOCALE_CODE: LocaleCode;
-/** Locale codes. */
+/**
+ * Locale codes.
+ */
 type LocaleCode = 'en-au' | 'en-gb' | 'en-us' | 'es-es';
-/** Localised string. */
+/**
+ * Localised string.
+ */
 type LocalisedString = Record<LocaleCode, string>;
-/** Exports. */
-export { DEFAULT_LOCALE_CODE };
-export type { LocaleCode, LocalisedString };
+/**
+ *
+ */
+type LocaleLabelMap = ReadonlyMap<string, string>;
+/**
+ *
+ */
+declare const createLabelMap: (labels: Record<string, string>) => LocaleLabelMap;
+/**
+ *
+ */
+declare const resolveLabel: (labels: LocaleLabelMap, localeId: string, fallbackLocaleId?: "en-gb") => string | undefined;
+export { createLabelMap, DEFAULT_LOCALE_CODE, resolveLabel };
+export type { LocaleCode, LocaleLabelMap, LocalisedString };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@datapos/datapos-shared",
-    "version": "0.3.454",
+    "version": "0.3.455",
     "description": "A library containing common constants, types and utilities used across all Data Positioning projects.",
     "license": "MIT",
     "author": "Jonathan Terrell <terrell.jm@gmail.com>",

package/dist/locale-DR89RW6v.js

@@ -1,4 +0,0 @@
-const D = "en-gb";
-export {
-  D
-};