@datapos/datapos-shared 0.3.414 → 0.3.416

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

@@ -1,9 +1,9 @@
-async function c(e, o) {
-  const n = `datapos-tool-${o}`, t = e.find((s) => s.id === n);
+async function a(e, o) {
+  const n = `datapos-tool-${o}`, t = e.find((r) => r.id === n);
   if (!t) throw new Error(`Connector could not load unknown tool '${o}'.`);
   const l = await import(`https://engine-eu.datapos.app/tools/${o}_v${t.version}/${n}.es.js`);
   return new l.Tool();
 }
 export {
-  c as loadTool
+  a as loadTool
 };

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

@@ -4,7 +4,7 @@ import { ToolConfig } from '../tool';
 import { ValueDelimiterId } from '../dataView';
 import { ConnectionConfig, ConnectionDescription, ConnectionNodeConfig } from './connection';
 import { connectorCategoryConfigSchema, connectorConfigSchema, connectorOperationNameSchema, connectorUsageIdSchema } from './connectorConfig.schema';
-/** Connector runtime interface. */
+/** Connector runtime interface ans constructor. */
 interface ConnectorInterface extends Component {
     abortController: AbortController | undefined;
     readonly config: ConnectorConfig;
@@ -25,6 +25,8 @@ 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>;
 }
+/** Class constructor that builds a ConnectorInterface. */
+type ConnectorConstructor = new (config: ConnectorConfig, toolConfigs: ToolConfig[]) => ConnectorInterface;
 /** Operation names a connector may support. */
 type ConnectorOperationName = InferOutput<typeof connectorOperationNameSchema>;
 /** Connector data pipeline usage identifiers. */
@@ -139,4 +141,4 @@ declare const constructConnectorCategoryConfig: (id: string, localeId?: import('
 export { connectorConfigSchema } from './connectorConfig.schema';
 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 };
+export type { ConnectorConfig, ConnectorConstructor, 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

@@ -7,7 +7,7 @@ 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/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/package.json

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