@datapos/datapos-shared 0.3.413 → 0.3.415

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

@@ -4,41 +4,30 @@
  * Defines the configuration metadata for a connector. Used for validation
  * of connector manifests and capability discovery at runtime.
  */
-/** Authentication method identifiers supported by a connector implementation. */
-export declare const connectorAuthMethodIdSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"apiKey", undefined>, import('valibot').LiteralSchema<"disabled", undefined>, import('valibot').LiteralSchema<"oAuth2", undefined>, import('valibot').LiteralSchema<"none", undefined>], undefined>;
-/** A connector implementation variant. A single connector may expose multiple
- * implementations differing by auth method, limits, or vendor-specific behavior.
- */
-export declare const connectorImplementationSchema: import('valibot').ObjectSchema<{
-    readonly authMethodId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"apiKey", undefined>, import('valibot').LiteralSchema<"disabled", undefined>, import('valibot').LiteralSchema<"oAuth2", undefined>, import('valibot').LiteralSchema<"none", undefined>], undefined>;
-    readonly activeConnectionCount: import('valibot').OptionalSchema<import('valibot').NumberSchema<undefined>, undefined>;
-    readonly canDescribe: import('valibot').OptionalSchema<import('valibot').BooleanSchema<undefined>, undefined>;
-    readonly id: import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
-    readonly label: import('valibot').OptionalSchema<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>, undefined>;
-    readonly maxConnectionCount: import('valibot').OptionalSchema<import('valibot').NumberSchema<undefined>, undefined>;
-    readonly params: import('valibot').OptionalSchema<import('valibot').ArraySchema<import('valibot').RecordSchema<import('valibot').StringSchema<undefined>, import('valibot').StringSchema<undefined>, undefined>, undefined>, undefined>;
-}, undefined>;
-/** Category identifiers used for grouping and filtering connectors. */
-export declare const connectorCategoryIdSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"application", undefined>, import('valibot').LiteralSchema<"curatedDataset", undefined>, import('valibot').LiteralSchema<"database", undefined>, import('valibot').LiteralSchema<"fileStore", undefined>], undefined>;
 /** Operation names a connector may support. */
-export 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>;
+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. */
-export 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>;
-export declare const connectorCategorySchema: import('valibot').ObjectSchema<{
+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').StringSchema<undefined>;
+    readonly label: 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>;
 }, undefined>;
 /** Top-level connector configuration object. */
-export declare const connectorConfigSchema: import('valibot').ObjectSchema<{
+declare const connectorConfigSchema: import('valibot').ObjectSchema<{
     readonly typeId: import('valibot').LiteralSchema<"connector", undefined>;
     readonly category: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
         readonly id: import('valibot').StringSchema<undefined>;
-        readonly label: import('valibot').StringSchema<undefined>;
+        readonly label: 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>;
     }, undefined>, undefined>;
     readonly categoryId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"application", undefined>, import('valibot').LiteralSchema<"curatedDataset", undefined>, import('valibot').LiteralSchema<"database", undefined>, import('valibot').LiteralSchema<"fileStore", undefined>], undefined>;
     readonly implementations: import('valibot').RecordSchema<import('valibot').StringSchema<undefined>, import('valibot').ObjectSchema<{
@@ -85,3 +74,5 @@ export 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

@@ -3,20 +3,7 @@ import { Component } from '..';
 import { ToolConfig } from '../tool';
 import { ValueDelimiterId } from '../dataView';
 import { ConnectionConfig, ConnectionDescription, ConnectionNodeConfig } from './connection';
-import { connectorCategorySchema, connectorConfigSchema, connectorOperationNameSchema, connectorUsageIdSchema } from './connectorConfig.schema';
-/** Authentication method identifiers supported by a connector implementation. */
-/** Connector implementation. */
-/** Category identifiers used for grouping and filtering connectors. */
-/** Operation names a connector may support. */
-type ConnectorOperationName = InferOutput<typeof connectorOperationNameSchema>;
-/** Connector data pipeline usage identifiers. */
-type ConnectorUsageId = InferOutput<typeof connectorUsageIdSchema>;
-/** Connector configuration. */
-type ConnectorConfig = InferOutput<typeof connectorConfigSchema>;
-type ConnectorLocalisedConfig = Omit<ConnectorConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
+import { connectorCategoryConfigSchema, connectorConfigSchema, connectorOperationNameSchema, connectorUsageIdSchema } from './connectorConfig.schema';
 /** Connector runtime interface. */
 interface ConnectorInterface extends Component {
     abortController: AbortController | undefined;
@@ -38,6 +25,16 @@ interface ConnectorInterface extends Component {
     retrieveRecords?(connector: ConnectorInterface, options: RetrieveRecordsOptions, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: (result: RetrieveRecordsSummary) => void): Promise<void>;
     upsertRecords?(connector: ConnectorInterface, options: UpsertRecordsOptions): Promise<void>;
 }
+/** Operation names a connector may support. */
+type ConnectorOperationName = InferOutput<typeof connectorOperationNameSchema>;
+/** Connector data pipeline usage identifiers. */
+type ConnectorUsageId = InferOutput<typeof connectorUsageIdSchema>;
+/** Connector configuration. */
+type ConnectorConfig = InferOutput<typeof connectorConfigSchema>;
+type ConnectorLocalisedConfig = Omit<ConnectorConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
 /** Connector operation options. */
 interface ConnectorOperationOptions {
     accountId?: string;
@@ -131,11 +128,15 @@ interface UpsertRecordsOptions extends ConnectorOperationOptions {
     records: Record<string, unknown>[];
     path: string;
 }
-/** Types/Interfaces/Operations - Connector category. */
-type ConnectorCategory = InferOutput<typeof connectorCategorySchema>;
-declare const getConnectorCategory: (id: string, localeId?: import('../../index').LocaleCode) => ConnectorCategory;
+/** Connector category configuration. */
+type ConnectorCategoryConfig = InferOutput<typeof connectorCategoryConfigSchema>;
+type ConnectorCategoryLocalisedConfig = Omit<ConnectorCategoryConfig, 'label'> & {
+    label: string;
+};
+/** Construct connector category configuration. */
+declare const constructConnectorCategoryConfig: (id: string, localeId?: import('../../locale').LocaleCode) => ConnectorCategoryLocalisedConfig;
 /** Exports. */
 export { connectorConfigSchema } from './connectorConfig.schema';
-export { getConnectorCategory };
+export { constructConnectorCategoryConfig };
 export type { ConnectionColumnConfig, ConnectionConfig, ConnectionNodeConfig, Encoding, UsageTypeId } from './connection';
 export type { ConnectorConfig, ConnectorInterface, ConnectorLocalisedConfig, ConnectorOperationName, ConnectorOperationOptions, ConnectorUsageId, CreateObjectOptions, DropObjectOptions, FindObjectFolderPathOptions, GetReadableStreamOptions, GetRecordResult, GetRecordOptions, ListNodesResult, ListNodesOptions, PreviewObjectResult, PreviewObjectOptions, RemoveRecordsOptions, RetrieveChunksOptions, RetrieveRecordsOptions, RetrieveRecordsSummary, UpsertRecordsOptions };

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

@@ -1,13 +1,13 @@
 import { InferOutput } from 'valibot';
 import { contextConfigSchema } from './contextConfig.schema';
-import { LocalisedString } from '../../index';
+import { LocalisedString } from '../../locale';
 import { ModuleConfig } from '../module';
 import { Component, ComponentConfig, ComponentReference } from '..';
 export interface Context extends Component {
     readonly config: ContextConfig;
     list(settings?: ContextListSettings): Promise<ContextListResult>;
 }
-export type ContextOperationSettings = object;
+export type ContextOperationOptions = object;
 export type ContextListSettings = object;
 export interface ContextListResult {
     models: ContextModelGroupConfig[];

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

@@ -54,20 +54,20 @@ interface 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('../../locale').LocaleCode) => DataFormat;
+export declare const getDataFormats: (localeId?: import('../../locale').LocaleCode) => DataFormat[];
 interface 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('../../locale').LocaleCode) => RecordDelimiter;
+export declare const getRecordDelimiters: (localeId?: import('../../locale').LocaleCode) => RecordDelimiter[];
 interface 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('../../locale').LocaleCode) => ValueDelimiter;
+export declare const getValueDelimiters: (localeId?: import('../../locale').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/component/index.d.ts

@@ -1,15 +1,16 @@
 import { InferOutput } from 'valibot';
-import { componentConfigSchema, componentStatusSchema } from './componentConfig.schema';
-import { LocaleCode } from '../index';
+import { componentConfigSchema, componentReferenceSchema, componentStatusSchema } from './componentConfig.schema';
+import { LocaleCode } from '../locale';
 /** Component. */
 interface Component {
     readonly config: ComponentConfig;
 }
 type ComponentConfig = InferOutput<typeof componentConfigSchema>;
+type ComponentReference = InferOutput<typeof componentReferenceSchema>;
 type ComponentStatus = InferOutput<typeof componentStatusSchema>;
 declare function getComponentStatus(id: string, localeId?: LocaleCode): ComponentStatus;
 /** Exports */
 export { getComponentStatus };
 export { componentConfigSchema } from './componentConfig.schema';
-export type { Component, ComponentConfig };
+export type { Component, ComponentConfig, ComponentReference };
 export type { ModuleConfig, ModuleTypeId } from './module';

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

@@ -2,35 +2,44 @@ import { ConnectionConfig } from '../component/connector/connection';
 import { ConnectorOperationOptions } from '../component/connector';
 import { ModuleConfig } from '../component/module';
 import { ToolConfig } from '../component/tool';
-import { ContextCallbackData, ContextConfig, ContextOperationSettings } from '../component/context';
+import { ContextCallbackData, ContextConfig, ContextOperationOptions } from '../component/context';
 import { DataViewContentAuditConfig, EncodingConfig, ValueDelimiterId } from '../component/dataView';
+/** Engine runtime interface. */
+interface EngineRuntimeInterface {
+    getEncodingConfigs: (localeId: string) => EncodingConfig[];
+    invokeWorker(errorEventCallback: (errorEvent: ErrorEvent) => void): EngineWorkerInterface;
+}
+/** Engine worker interface. */
+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>;
+    processTestRequest: (settings: TestSettings) => Promise<Record<string, unknown>>;
+}
+/** Engine worker initialise options. */
+interface EngineWorkerInitialiseOptions {
+    connectorStorageURLPrefix: string;
+    toolConfigs: ToolConfig[];
+}
 /** Engine configuration. */
 interface EngineConfig extends ModuleConfig {
     typeId: 'engine';
 }
-/** Engine initialise settings. */
-interface EngineInitialiseSettings {
-    connectorStorageURLPrefix: string;
-    toolConfigs: ToolConfig[];
+/** Connector callback data. */
+interface ConnectorCallbackData {
+    typeId: string;
+    properties: Record<string, unknown>;
 }
-type InitialiseEngine = (settings: EngineInitialiseSettings) => Promise<void>;
-type ProcessConnectorRequest = (id: string, connectionConfig: ConnectionConfig, settings: ConnectorOperationOptions, callback?: (callbackData: ContextCallbackData) => void) => Promise<unknown>;
-interface AuditContentSettings extends ConnectorOperationOptions {
+/** Audit object content options and result. */
+interface AuditObjectContentOptions extends ConnectorOperationOptions {
     chunkSize?: number;
     encodingId: string;
     path: string;
     valueDelimiterId: ValueDelimiterId;
 }
-interface AuditContentResult {
+interface AuditObjectContentResult {
     contentAuditConfig: DataViewContentAuditConfig;
 }
-/** Connector callback data. */
-interface ConnectorCallbackData {
-    typeId: string;
-    properties: Record<string, unknown>;
-}
-type ProcessContextRequest = (id: string, contextConfig: ContextConfig, settings: ContextOperationSettings, callback?: (callbackData: ConnectorCallbackData) => void) => Promise<unknown>;
-type ProcessTestRequest = (settings: TestSettings) => Promise<Record<string, unknown>>;
 interface TestSettings {
     action?: string;
     delimiter?: string;
@@ -38,15 +47,5 @@ interface TestSettings {
     hasHeaders?: boolean;
     readable: ReadableStream<Uint8Array>;
 }
-interface EngineInterface {
-    getEncodingConfigs: (localeId: string) => EncodingConfig[];
-    invokeWorker(errorEventCallback: (errorEvent: ErrorEvent) => void): EngineWorker;
-}
-interface EngineWorker {
-    initialise: InitialiseEngine;
-    processConnectorRequest: ProcessConnectorRequest;
-    processContextRequest: ProcessContextRequest;
-    processTestRequest: ProcessTestRequest;
-}
 /** Exports. */
-export type { AuditContentSettings, AuditContentResult, ConnectorCallbackData, EngineConfig, EngineInterface, EngineWorker, EngineInitialiseSettings, TestSettings };
+export type { AuditObjectContentOptions, AuditObjectContentResult, ConnectorCallbackData, EngineConfig, EngineRuntimeInterface, EngineWorkerInitialiseOptions, EngineWorkerInterface, TestSettings };

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

@@ -1,5 +1,5 @@
 /**
- * Error classes and utilities.
+ * Error constants, type declarations, classes, runtime utilities and local helpers.
  */
 /** Serializable representation of an error and its cause chain.
  * Used for logging, reporting, and transport across process or network boundaries.

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

@@ -2,8 +2,6 @@
  * Shared composables, constants, errors, interfaces, schemas, types and utilities.
  */
 /** Interfaces/Types */
-export type LocaleCode = 'en-au' | 'en-gb' | 'en-us' | 'es-es';
-export type LocalisedString = Record<LocaleCode, string>;
 /** Interfaces/Types - Context. */
 export { contextConfigSchema } from './component/context';
 export type { Context, ContextConfig, ContextLocalisedConfig, ContextListSettings, ContextListResult, ContextOperation, ContextCallbackData } from './component/context';
@@ -41,6 +39,5 @@ export type { PresentationCategoryId, PresentationCartesianTypeId, PresentationP
 export { type CytoscapeJSView, useCytoscapeJS } from './composables/useCytoscapeJS';
 export { useDataTable } from './composables/useDataTable';
 /** Constants */
-export declare const DEFAULT_LOCALE_CODE: LocaleCode;
 /** Utilities */
 export { getDataFormats, getRecordDelimiters, getValueDelimiters } from './component/dataView';

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

@@ -0,0 +1,12 @@
+/**
+ * Locale constants and type declarations.
+ */
+/** Constants */
+declare const DEFAULT_LOCALE_CODE: LocaleCode;
+/** Locale codes. */
+type LocaleCode = 'en-au' | 'en-gb' | 'en-us' | 'es-es';
+/** Localised string. */
+type LocalisedString = Record<LocaleCode, string>;
+/** Exports. */
+export { DEFAULT_LOCALE_CODE };
+export type { LocaleCode, LocalisedString };

package/package.json

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