@datapos/datapos-shared 0.3.452 → 0.3.454

package/dist/types/src/component/componentConfig.schema.d.ts

@@ -1,28 +1,55 @@
 import { LiteralSchema, UnionSchema } from 'valibot';
+/**
+ *
+ */
 type LiteralUnionSchema<T extends readonly string[]> = UnionSchema<{
     [K in keyof T]: LiteralSchema<T[K], undefined>;
 }, undefined>;
+/**
+ *
+ */
 declare const literalUnion: <const T extends readonly string[]>(values: T) => LiteralUnionSchema<T>;
+/**
+ *
+ */
 declare const localisedStringSchema: import('valibot').ObjectSchema<{
     readonly 'en-au': import('valibot').StringSchema<undefined>;
     readonly 'en-gb': import('valibot').StringSchema<undefined>;
     readonly 'en-us': import('valibot').StringSchema<undefined>;
     readonly 'es-es': import('valibot').StringSchema<undefined>;
 }, undefined>;
+/**
+ *
+ */
 declare const partialLocalisedStringSchema: import('valibot').ObjectSchema<{
     readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
     readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
     readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
     readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
 }, undefined>;
+/**
+ *
+ */
 declare const componentStatusColorIdSchema: LiteralUnionSchema<readonly ["amber", "green", "red", "other"]>;
+/**
+ *
+ */
 declare const componentStatusIdSchema: LiteralUnionSchema<readonly ["alpha", "beta", "generalAvailability", "notApplicable", "preAlpha", "proposed", "releaseCandidate", "unavailable", "underReview"]>;
+/**
+ *
+ */
 declare const componentTypeIdSchema: LiteralUnionSchema<readonly ["app", "connector", "connectorConnection", "context", "contextModelGroup", "contextModel", "contextModelDimensionGroup", "contextModelDimension", "contextModelDimensionHierarchy", "contextModelEntityGroup", "contextModelEntity", "contextModelEntityDataItem", "contextModelEntityEvent", "contextModelEntityPrimaryMeasure", "contextModelSecondaryMeasureGroup", "contextModelSecondaryMeasure", "dataView", "dimension", "engine", "eventQuery", "presenter", "presenterPresentation", "tool"]>;
+/**
+ *
+ */
 declare const componentStatusSchema: import('valibot').ObjectSchema<{
     readonly id: import('valibot').StringSchema<undefined>;
     readonly color: LiteralUnionSchema<readonly ["amber", "green", "red", "other"]>;
     readonly label: import('valibot').StringSchema<undefined>;
 }, undefined>;
+/**
+ *
+ */
 declare const componentConfigCoreFields: {
     readonly id: import('valibot').StringSchema<undefined>;
     readonly label: import('valibot').ObjectSchema<{
@@ -48,6 +75,9 @@ declare const componentConfigCoreFields: {
     }, undefined>, undefined>;
     readonly statusId: LiteralUnionSchema<readonly ["alpha", "beta", "generalAvailability", "notApplicable", "preAlpha", "proposed", "releaseCandidate", "unavailable", "underReview"]>;
 };
+/**
+ *
+ */
 declare const componentConfigSchema: import('valibot').ObjectSchema<{
     readonly typeId: LiteralUnionSchema<readonly ["app", "connector", "connectorConnection", "context", "contextModelGroup", "contextModel", "contextModelDimensionGroup", "contextModelDimension", "contextModelDimensionHierarchy", "contextModelEntityGroup", "contextModelEntity", "contextModelEntityDataItem", "contextModelEntityEvent", "contextModelEntityPrimaryMeasure", "contextModelSecondaryMeasureGroup", "contextModelSecondaryMeasure", "dataView", "dimension", "engine", "eventQuery", "presenter", "presenterPresentation", "tool"]>;
     readonly id: import('valibot').StringSchema<undefined>;
@@ -74,6 +104,9 @@ declare const componentConfigSchema: import('valibot').ObjectSchema<{
     }, undefined>, undefined>;
     readonly statusId: LiteralUnionSchema<readonly ["alpha", "beta", "generalAvailability", "notApplicable", "preAlpha", "proposed", "releaseCandidate", "unavailable", "underReview"]>;
 }, undefined>;
+/**
+ *
+ */
 declare const componentReferenceSchema: import('valibot').ObjectSchema<{
     readonly id: import('valibot').StringSchema<undefined>;
     readonly label: import('valibot').ObjectSchema<{
@@ -93,5 +126,4 @@ declare const componentReferenceSchema: import('valibot').ObjectSchema<{
     readonly order: import('valibot').NumberSchema<undefined>;
     readonly path: import('valibot').StringSchema<undefined>;
 }, undefined>;
-/** Exports. */
 export { componentConfigCoreFields, componentConfigSchema, componentReferenceSchema, componentStatusColorIdSchema, componentStatusIdSchema, componentStatusSchema, componentTypeIdSchema, literalUnion, localisedStringSchema, partialLocalisedStringSchema };

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

@@ -1,5 +1,12 @@
 import { ComponentConfig } from '..';
 import { ConnectorConfig } from '.';
+/** Connection configuration. */
+interface ConnectionConfig extends ComponentConfig {
+    authorisation: Record<string, ConnectionAuthorisationConfig>;
+    connectorConfig: ConnectorConfig;
+    lastVerifiedAt: number;
+    notation?: string;
+}
 /** Connection authorisation configuration. */
 interface ConnectionAuthorisationConfig {
     accessToken: string;
@@ -11,13 +18,6 @@ interface ConnectionAuthorisationConfig {
     tokenType: string;
     uid: string;
 }
-/** Connection configuration. */
-interface ConnectionConfig extends ComponentConfig {
-    authorisation: Record<string, ConnectionAuthorisationConfig>;
-    connectorConfig: ConnectorConfig;
-    lastVerifiedAt: number;
-    notation?: string;
-}
 /** Connection node configuration. */
 interface ConnectionNodeConfig {
     childCount?: number;

package/dist/types/src/component/connector/connectorConfig.schema.d.ts

@@ -8,6 +8,9 @@
 declare const connectorOperationNameSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", undefined>, import('valibot').LiteralSchema<"authenticateConnection", undefined>, import('valibot').LiteralSchema<"createObject", undefined>, import('valibot').LiteralSchema<"describeConnection", undefined>, import('valibot').LiteralSchema<"dropObject", undefined>, import('valibot').LiteralSchema<"findObjectFolderPath", undefined>, import('valibot').LiteralSchema<"getReadableStream", undefined>, import('valibot').LiteralSchema<"getRecord", undefined>, import('valibot').LiteralSchema<"listNodes", undefined>, import('valibot').LiteralSchema<"previewObject", undefined>, import('valibot').LiteralSchema<"removeRecords", undefined>, import('valibot').LiteralSchema<"retrieveChunks", undefined>, import('valibot').LiteralSchema<"retrieveRecords", undefined>, import('valibot').LiteralSchema<"upsertRecords", undefined>], undefined>;
 /** Connector data pipeline usage identifiers. */
 declare const connectorUsageIdSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"bidirectional", undefined>, import('valibot').LiteralSchema<"destination", undefined>, import('valibot').LiteralSchema<"source", undefined>, import('valibot').LiteralSchema<"unknown", undefined>], undefined>;
+/**
+ *
+ */
 declare const connectorCategoryConfigSchema: import('valibot').ObjectSchema<{
     readonly id: import('valibot').StringSchema<undefined>;
     readonly label: import('valibot').ObjectSchema<{
@@ -74,5 +77,4 @@ declare const connectorConfigSchema: import('valibot').ObjectSchema<{
     }, undefined>, undefined>;
     readonly statusId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"alpha", undefined>, import('valibot').LiteralSchema<"beta", undefined>, import('valibot').LiteralSchema<"generalAvailability", undefined>, import('valibot').LiteralSchema<"notApplicable", undefined>, import('valibot').LiteralSchema<"preAlpha", undefined>, import('valibot').LiteralSchema<"proposed", undefined>, import('valibot').LiteralSchema<"releaseCandidate", undefined>, import('valibot').LiteralSchema<"unavailable", undefined>, import('valibot').LiteralSchema<"underReview", undefined>], undefined>;
 }, undefined>;
-/** Exports. */
 export { connectorCategoryConfigSchema, connectorConfigSchema, connectorOperationNameSchema, connectorUsageIdSchema };

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

@@ -12,21 +12,66 @@ interface ConnectorInterface extends Component {
     abortController: AbortController | undefined;
     readonly config: ConnectorConfig;
     readonly toolConfigs: ToolConfig[];
+    /**
+     * Abort the active long running operation.
+     */
     abortOperation?(connector: ConnectorInterface): void;
+    /**
+     * Authenticate a specified connection.
+     */
     authenticateConnection?(accountId: string, windowCenterX: number, windowCenterY: number): Window;
+    /**
+     * Create an object for a specified connection.
+     */
     createObject?(connector: ConnectorInterface, options: CreateObjectOptions): Promise<void>;
+    /**
+     * Describe a specified connection.
+     */
     describeConnection?(connector: ConnectorInterface, options: DescribeConnectionOptions): Promise<DescribeConnectionResult>;
+    /**
+     * Drop (delete) an object for a specified connection.
+     */
     dropObject?(connector: ConnectorInterface, options: DropObjectOptions): Promise<void>;
+    /**
+     * Find an object for a specified connection.
+     */
     findObject?(connector: ConnectorInterface, options: FindObjectFolderPathOptions): Promise<string | null>;
+    /**
+     * Get a reader that can retrieve all records from an object for a specified connection.
+     */
     getReadableStream?(connector: ConnectorInterface, options: GetReadableStreamOptions): Promise<ReadableStream<Uint8Array>>;
+    /**
+     * Get a record for an object for a specified connection.
+     */
     getRecord?(connector: ConnectorInterface, options: GetRecordOptions): Promise<GetRecordResult>;
+    /**
+     * List nodes in a folder for a specified connection.
+     */
     listNodes?(connector: ConnectorInterface, options: ListNodesOptions): Promise<ListNodesResult>;
+    /**
+     * Preview an object for a specified connection.
+     */
     previewObject?(connector: ConnectorInterface, options: PreviewObjectOptions): Promise<DataViewPreviewConfig>;
+    /**
+     * Remove one or more records from an object for a specified connection.
+     */
     removeRecords?(connector: ConnectorInterface, options: RemoveRecordsOptions): Promise<void>;
+    /**
+     * Retrieve all chunks from an object for a specified connection.
+     */
     retrieveChunks?(connector: ConnectorInterface, options: RetrieveChunksOptions, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: () => void): Promise<void>;
+    /**
+     * Retrieve all records from an object for a specified connection.
+     */
     retrieveRecords?(connector: ConnectorInterface, options: RetrieveRecordsOptions, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: (result: RetrieveRecordsSummary) => void): Promise<void>;
+    /**
+     * Upsert one or more records into an object for a specified connection.
+     */
     upsertRecords?(connector: ConnectorInterface, options: UpsertRecordsOptions): Promise<void>;
 }
+/**
+ *
+ */
 type ConnectorConstructor = new (EngineUtilities: EngineUtilities, toolConfigs: ToolConfig[]) => ConnectorInterface;
 /**
  * Operation names a connector may support.
@@ -145,11 +190,30 @@ interface RetrieveRecordsOptions extends ConnectorOperationOptions {
     valueDelimiterId: ValueDelimiterId;
 }
 interface RetrieveRecordsSummary {
+    /**
+     * Number of processed bytes.
+     */
     byteCount: number;
+    /**
+     * Count the number of lines being fully commented.
+     */
     commentLineCount: number;
+    /**
+     * Count the number of processed empty lines; work only with the skip_empty_lines option or an error will be thrown
+     * if an empty line is found.
+     */
     emptyLineCount: number;
+    /**
+     * Number of lines encountered in the source dataset, start at 1 for the first line.
+     */
     lineCount: number;
+    /**
+     * Number of non uniform records when relax_column_count is true.
+     */
     nonUniformRecordCount: number;
+    /**
+     * Count the number of processed records.
+     */
     recordCount: number;
 }
 /**

package/dist/types/src/component/context/contextConfig.schema.d.ts

@@ -1,5 +1,5 @@
 /**
- * Context schema (drafted by Copilot).
+ * Context schema.
  */
 export declare const contextConfigSchema: import('valibot').ObjectSchema<{
     readonly typeId: import('valibot').LiteralSchema<"context", undefined>;

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

@@ -12,10 +12,6 @@ export type ContextListOptions = object;
 export interface ContextListResult {
     models: ContextModelGroupConfig[];
 }
-export interface ContextCallbackData {
-    typeId: string;
-    properties: Record<string, unknown>;
-}
 export type ContextConfig = InferOutput<typeof contextConfigSchema>;
 export interface ContextConfig1 extends ModuleConfig {
     models: ContextModelGroupConfig[];

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

@@ -38,10 +38,7 @@ interface DataViewPreviewConfig {
     fileType: FileTypeResult | undefined;
     hasHeaders: boolean | undefined;
     recordDelimiterId?: RecordDelimiterId;
-    records: {
-        isValid: boolean;
-        value: ParsedValue | undefined;
-    }[][];
+    records: ParseResult[][];
     size: number;
     text: string;
     valueDelimiterId?: ValueDelimiterId;
@@ -69,5 +66,11 @@ interface ParseResult {
 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';
 export { ORDERED_VALUE_DELIMITER_IDS };
-export type { DataFormatId, DataViewContentAuditConfig, DataViewConfig, DataViewPreviewConfig, ParseResult, ParsedValue, RecordDelimiterId, ValueDelimiterId };
+export type { DataFormatId, DataViewContentAuditConfig, DataViewConfig, DataViewPreviewConfig, ParseResult, RecordDelimiterId, ValueDelimiterId };
+export type { DataTypeId, NumericTypeId, NumericUnitsId, StringTypeId, TemporalTypeId };

package/dist/types/src/component/moduleConfig.schema.d.ts

@@ -1,9 +1,13 @@
 /**
  * Module configuration schema.
  */
-/** */
+/**
+ *
+ */
 declare const moduleTypeIdSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"app", undefined>, import('valibot').LiteralSchema<"engine", undefined>, import('valibot').LiteralSchema<"connector", undefined>, import('valibot').LiteralSchema<"context", undefined>, import('valibot').LiteralSchema<"presenter", undefined>, import('valibot').LiteralSchema<"tool", undefined>], undefined>;
-/** */
+/**
+ *
+ */
 declare const moduleConfigCoreFields: {
     readonly version: import('valibot').StringSchema<undefined>;
     readonly id: import('valibot').StringSchema<undefined>;
@@ -30,7 +34,9 @@ declare const moduleConfigCoreFields: {
     }, undefined>, undefined>;
     readonly statusId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"alpha", undefined>, import('valibot').LiteralSchema<"beta", undefined>, import('valibot').LiteralSchema<"generalAvailability", undefined>, import('valibot').LiteralSchema<"notApplicable", undefined>, import('valibot').LiteralSchema<"preAlpha", undefined>, import('valibot').LiteralSchema<"proposed", undefined>, import('valibot').LiteralSchema<"releaseCandidate", undefined>, import('valibot').LiteralSchema<"unavailable", undefined>, import('valibot').LiteralSchema<"underReview", undefined>], undefined>;
 };
-/** */
+/**
+ *
+ */
 declare const moduleConfigSchema: import('valibot').ObjectSchema<{
     readonly typeId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"app", undefined>, import('valibot').LiteralSchema<"engine", undefined>, import('valibot').LiteralSchema<"connector", undefined>, import('valibot').LiteralSchema<"context", undefined>, import('valibot').LiteralSchema<"presenter", undefined>, import('valibot').LiteralSchema<"tool", undefined>], undefined>;
     readonly version: import('valibot').StringSchema<undefined>;
@@ -58,5 +64,4 @@ declare const moduleConfigSchema: import('valibot').ObjectSchema<{
     }, undefined>, undefined>;
     readonly statusId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"alpha", undefined>, import('valibot').LiteralSchema<"beta", undefined>, import('valibot').LiteralSchema<"generalAvailability", undefined>, import('valibot').LiteralSchema<"notApplicable", undefined>, import('valibot').LiteralSchema<"preAlpha", undefined>, import('valibot').LiteralSchema<"proposed", undefined>, import('valibot').LiteralSchema<"releaseCandidate", undefined>, import('valibot').LiteralSchema<"unavailable", undefined>, import('valibot').LiteralSchema<"underReview", undefined>], undefined>;
 }, undefined>;
-/** Exports. */
 export { moduleConfigCoreFields, moduleConfigSchema, moduleTypeIdSchema };

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

@@ -3,7 +3,7 @@ import { EncodingTypeConfig } from '../encoding';
 import { ModuleConfig } from '../component/module';
 import { ToolConfig } from '../component/tool';
 import { ConnectionColumnConfig, ConnectorOperationOptions } from '../component/connector';
-import { ContextCallbackData, ContextConfig, ContextOperationOptions } from '../component/context';
+import { ContextConfig, ContextOperationOptions } from '../component/context';
 import { DataViewContentAuditConfig, ParseResult, ValueDelimiterId } from '../component/dataView';
 /**
  * Engine runtime interface.
@@ -17,8 +17,8 @@ interface EngineRuntimeInterface {
  */
 interface EngineWorkerInterface {
     initialise: (options: EngineWorkerInitialiseOptions) => Promise<void>;
-    processConnectorRequest: (id: string, connectionConfig: ConnectionConfig, options: ConnectorOperationOptions, callback?: (callbackData: ConnectorCallbackData) => void) => Promise<unknown>;
-    processContextRequest: (id: string, contextConfig: ContextConfig, options: ContextOperationOptions, callback?: (callbackData: ContextCallbackData) => void) => Promise<unknown>;
+    processConnectorRequest: (id: string, connectionConfig: ConnectionConfig, options: ConnectorOperationOptions, callback?: (callbackData: EngineCallbackData) => void) => Promise<unknown>;
+    processContextRequest: (id: string, contextConfig: ContextConfig, options: ContextOperationOptions, callback?: (callbackData: EngineCallbackData) => void) => Promise<unknown>;
     processTestRequest: (settings: TestSettings) => Promise<Record<string, unknown>>;
 }
 /** Engine worker initialise options. */
@@ -42,9 +42,9 @@ interface EngineConfig extends ModuleConfig {
     typeId: 'engine';
 }
 /**
- * Connector callback data.
+ * Engine callback data.
  */
-interface ConnectorCallbackData {
+interface EngineCallbackData {
     typeId: string;
     properties: Record<string, unknown>;
 }
@@ -67,4 +67,4 @@ interface TestSettings {
     hasHeaders?: boolean;
     readable: ReadableStream<Uint8Array>;
 }
-export type { AuditObjectContentOptions, AuditObjectContentResult, ConnectorCallbackData, EngineConfig, EngineRuntimeInterface, EngineUtilities, EngineWorkerInitialiseOptions, EngineWorkerInterface, TestSettings };
+export type { AuditObjectContentOptions, AuditObjectContentResult, EngineCallbackData, EngineConfig, EngineRuntimeInterface, EngineUtilities, EngineWorkerInitialiseOptions, EngineWorkerInterface, TestSettings };

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

@@ -3,7 +3,7 @@
  */
 /** Interfaces/Types - Context. */
 export { contextConfigSchema } from './component/context';
-export type { Context, ContextConfig, ContextLocalisedConfig, ContextListOptions, ContextListResult, ContextOperation, ContextCallbackData } from './component/context';
+export type { Context, ContextConfig, ContextLocalisedConfig, ContextListOptions, ContextListResult, ContextOperation } from './component/context';
 /** Interfaces/Types - Context model. */
 export type { ContextModelGroupConfig, ContextModelGroupLocalisedConfig, ContextModelConfig, ContextModelLocalisedConfig } from './component/context';
 /** Interfaces/Types - Context model dimension. */

package/package.json

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