@datapos/datapos-shared 0.3.403 → 0.3.405

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

@@ -1,14 +1,16 @@
 import { InferOutput } from 'valibot';
 import { Component } from '..';
-import { connectorConfigSchema } from './connectorConfig.schema';
 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'> & {
@@ -29,8 +31,8 @@ interface ConnectorInterface extends Component {
     findObject?(connector: ConnectorInterface, settings: FindObjectFolderPathSettings): Promise<string | null>;
     getReadableStream?(connector: ConnectorInterface, settings: GetReadableStreamSettings): Promise<ReadableStream<Uint8Array<ArrayBuffer>>>;
     getRecord?(connector: ConnectorInterface, settings: GetRecordSettings): Promise<GetRecordResult>;
-    listNodes?(connector: ConnectorInterface, settings: ListSettings): Promise<ListResult>;
-    previewObject?(connector: ConnectorInterface, settings: PreviewSettings): Promise<PreviewResult>;
+    listNodes?(connector: ConnectorInterface, settings: ListNodesSettings): Promise<ListNodesResult>;
+    previewObject?(connector: ConnectorInterface, settings: PreviewObjectSettings): Promise<PreviewObjectResult>;
     removeRecords?(connector: ConnectorInterface, settings: RemoveSettings): Promise<void>;
     retrieveChunks?(connector: ConnectorInterface, settings: RetrieveChunksSettings, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: (result: RetrieveChunksSummary) => void): Promise<void>;
     retrieveRecords?(connector: ConnectorInterface, settings: RetrieveRecordsSettings, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: (result: RetrieveRecordsSummary) => void): Promise<void>;
@@ -42,7 +44,7 @@ interface ConnectorOperationSettings {
     appCheckToken?: string;
     sessionAccessToken?: string;
 }
-/** Get find object folder path settings. */
+/** Find object folder path settings. */
 interface FindObjectFolderPathSettings extends ConnectorOperationSettings {
     containerName: string | undefined;
     nodeId: string;
@@ -52,6 +54,47 @@ interface GetReadableStreamSettings extends ConnectorOperationSettings {
     id: string;
     path: string;
 }
+/** List nodes result. */
+interface ListNodesResult {
+    cursor: string | number | undefined;
+    connectionNodeConfigs: ConnectionNodeConfig[];
+    isMore: boolean;
+    totalCount: number;
+}
+/** List nodes settings. */
+interface ListNodesSettings extends ConnectorOperationSettings {
+    folderPath: string;
+    limit?: number;
+    offset?: number;
+    totalCount?: number;
+}
+/** Preview object result. */
+interface PreviewObjectResult {
+    data: Record<string, unknown>[] | Uint8Array;
+    typeId: 'jsonArray' | 'uint8Array';
+}
+/** Preview object settings. */
+interface PreviewObjectSettings extends ConnectorOperationSettings {
+    chunkSize?: number;
+    extension?: string;
+    path: string;
+}
+/** Retrieve records summary. */
+interface RetrieveRecordsSummary {
+    byteCount: number;
+    commentLineCount: number;
+    emptyLineCount: number;
+    invalidFieldLengthCount: number;
+    lineCount: number;
+    recordCount: number;
+}
+/** Retrieve records settings. */
+interface RetrieveRecordsSettings extends ConnectorOperationSettings {
+    chunkSize?: number;
+    encodingId: string;
+    path: string;
+    valueDelimiterId: ValueDelimiterId;
+}
 interface CreateSettings extends ConnectorOperationSettings {
     accountId?: string;
     path: string;
@@ -71,27 +114,6 @@ interface GetRecordSettings extends ConnectorOperationSettings {
 interface GetRecordResult {
     record?: string[] | Record<string, unknown>;
 }
-interface ListSettings extends ConnectorOperationSettings {
-    folderPath: string;
-    limit?: number;
-    offset?: number;
-    totalCount?: number;
-}
-interface ListResult {
-    cursor: string | number | undefined;
-    connectionNodeConfigs: ConnectionNodeConfig[];
-    isMore: boolean;
-    totalCount: number;
-}
-interface PreviewSettings extends ConnectorOperationSettings {
-    chunkSize?: number;
-    extension?: string;
-    path: string;
-}
-interface PreviewResult {
-    data: Record<string, unknown>[] | Uint8Array;
-    typeId: 'jsonArray' | 'uint8Array';
-}
 interface RemoveSettings extends ConnectorOperationSettings {
     keys: string[];
     path: string;
@@ -110,33 +132,15 @@ interface RetrieveChunksSummary {
     lineCount: number;
     recordCount: number;
 }
-interface RetrieveRecordsSettings extends ConnectorOperationSettings {
-    chunkSize?: number;
-    encodingId: string;
-    path: string;
-    valueDelimiterId: ValueDelimiterId;
-}
-interface RetrieveRecordsSummary {
-    byteCount: number;
-    commentLineCount: number;
-    emptyLineCount: number;
-    invalidFieldLengthCount: number;
-    lineCount: number;
-    recordCount: number;
-}
 interface UpsertSettings extends ConnectorOperationSettings {
     records: Record<string, unknown>[];
     path: string;
 }
 /** Types/Interfaces/Operations - Connector category. */
-interface ConnectorCategory {
-    id: string;
-    label: string;
-}
+type ConnectorCategory = InferOutput<typeof connectorCategorySchema>;
 declare const getConnectorCategory: (id: string, localeId?: import('../../index').LocaleCode) => ConnectorCategory;
 /** Exports. */
 export { getConnectorCategory };
 export type { ConnectionColumnConfig, ConnectionConfig, ConnectionNodeConfig, Encoding, UsageTypeId } from './connection';
-export type { ConnectorConfig, ConnectorInterface, ConnectorLocalisedConfig, ConnectorOperationSettings };
-export type { CreateSettings, DropSettings, FindObjectFolderPathSettings, GetReadableStreamSettings, GetRecordResult, GetRecordSettings, ListResult, ListSettings, PreviewResult, PreviewSettings, RemoveSettings, RetrieveChunksSettings, RetrieveChunksSummary, RetrieveRecordsSettings, RetrieveRecordsSummary, UpsertSettings };
+export type { ConnectorConfig, ConnectorInterface, ConnectorLocalisedConfig, ConnectorOperationName, ConnectorOperationSettings, ConnectorUsageId, CreateSettings, DropSettings, FindObjectFolderPathSettings, GetReadableStreamSettings, GetRecordResult, GetRecordSettings, ListNodesResult, ListNodesSettings, PreviewObjectResult, PreviewObjectSettings, RemoveSettings, RetrieveChunksSettings, RetrieveChunksSummary, RetrieveRecordsSettings, RetrieveRecordsSummary, UpsertSettings };
 export { connectorConfigSchema } from './connectorConfig.schema';

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

@@ -1,14 +1,20 @@
 import { ConnectionConfig } from '../component/connector/connection';
+import { ConnectorOperationSettings } from '../component/connector';
+import { ModuleConfig } from '../component/module';
 import { ToolConfig } from '../component/tool';
-import { ConnectorOperationSettings, ListResult, RetrieveRecordsResult } from '../component/connector';
 import { ContextCallbackData, ContextConfig, ContextOperationSettings } from '../component/context';
-import { DataViewContentAuditConfig, DataViewPreviewConfig, EncodingConfig, ValueDelimiterId } from '../component/dataView';
+import { DataViewContentAuditConfig, EncodingConfig, ValueDelimiterId } from '../component/dataView';
+/** Engine configuration. */
+interface EngineConfig extends ModuleConfig {
+    typeId: 'engine';
+}
+/** Engine initialise settings. */
 interface EngineInitialiseSettings {
     connectorStorageURLPrefix: string;
     toolConfigs: ToolConfig[];
 }
 type InitialiseEngine = (settings: EngineInitialiseSettings) => Promise<void>;
-type ProcessConnectorRequest = (id: string, connectionConfig: ConnectionConfig, settings: ConnectorOperationSettings, callback?: (callbackData: ContextCallbackData) => void) => Promise<ConnectorInterfaceResult>;
+type ProcessConnectorRequest = (id: string, connectionConfig: ConnectionConfig, settings: ConnectorOperationSettings, callback?: (callbackData: ContextCallbackData) => void) => Promise<unknown>;
 interface AuditContentSettings extends ConnectorOperationSettings {
     chunkSize?: number;
     encodingId: string;
@@ -18,14 +24,12 @@ interface AuditContentSettings extends ConnectorOperationSettings {
 interface AuditContentResult {
     contentAuditConfig: DataViewContentAuditConfig;
 }
-type ConnectorInterfaceResult = AuditContentResult | DataViewPreviewConfig | ListResult | RetrieveRecordsResult;
 /** Connector callback data. */
 interface ConnectorCallbackData {
     typeId: string;
     properties: Record<string, unknown>;
 }
-type ProcessContextRequest = (id: string, contextConfig: ContextConfig, settings: ContextOperationSettings, callback?: (callbackData: ConnectorCallbackData) => void) => Promise<ContextInterfaceResult>;
-type ContextInterfaceResult = AuditContentResult | DataViewPreviewConfig | ListResult | RetrieveRecordsResult;
+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;
@@ -45,4 +49,4 @@ interface EngineWorker {
     processTestRequest: ProcessTestRequest;
 }
 /** Exports. */
-export type { AuditContentSettings, AuditContentResult, ConnectorCallbackData, ConnectorInterfaceResult, ContextInterfaceResult, EngineInterface, EngineWorker, EngineInitialiseSettings, TestSettings };
+export type { AuditContentSettings, AuditContentResult, ConnectorCallbackData, EngineConfig, EngineInterface, EngineWorker, EngineInitialiseSettings, TestSettings };

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

@@ -4,11 +4,6 @@
 /** Interfaces/Types */
 export type LocaleCode = 'en-au' | 'en-gb' | 'en-us' | 'es-es';
 export type LocalisedString = Record<LocaleCode, string>;
-/** Interfaces/Types - Component */
-/** Schemas - Component */
-export { componentConfigSchema } from './component';
-/** Schemas - Connector  */
-export { connectorConfigSchema } from './component/connector/connectorConfig.schema';
 /** Interfaces/Types - Context. */
 export { contextConfigSchema } from './component/context';
 export type { Context, ContextConfig, ContextLocalisedConfig, ContextListSettings, ContextListResult, ContextOperation, ContextCallbackData } from './component/context';
@@ -34,11 +29,6 @@ export type { DataFormatId, EncodingConfig, RecordDelimiterId, ValueDelimiterId
 export type { DataViewConfig, DataViewContentAuditConfig, DataViewLocalisedConfig, DataViewPreviewConfig, DataViewRelationshipsAuditConfig, ParsedValue } from './component/dataView';
 /** Interfaces/Types - Dimension. */
 export type { DimensionConfig, DimensionLocalisedConfig } from './component/dimension';
-/** Interfaces/Types - Engine. */
-/** Interfaces/Types */
-export type { SerialisedError } from './errors';
-/** Errors */
-/** Utilities */
 /** Interfaces/Types - Event query. */
 export type { EventQueryConfig, EventQueryLocalisedConfig } from './component/eventQuery';
 /** Interfaces/Types */

package/package.json

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