@datapos/datapos-shared 0.3.419 → 0.3.421

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

@@ -18,7 +18,7 @@ interface ConnectorInterface extends Component {
     getReadableStream?(connector: ConnectorInterface, options: GetReadableStreamOptions): Promise<ReadableStream<Uint8Array>>;
     getRecord?(connector: ConnectorInterface, options: GetRecordOptions): Promise<GetRecordResult>;
     listNodes?(connector: ConnectorInterface, options: ListNodesOptions): Promise<ListNodesResult>;
-    previewObject?(connector: ConnectorInterface, options: PreviewObjectOptions): Promise<PreviewObjectResult>;
+    previewObject?(engine: EngineInterface, connector: ConnectorInterface, options: PreviewObjectOptions): Promise<PreviewObjectResult>;
     removeRecords?(connector: ConnectorInterface, options: RemoveRecordsOptions): Promise<void>;
     retrieveChunks?(connector: ConnectorInterface, options: RetrieveChunksOptions, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: () => void): Promise<void>;
     retrieveRecords?(connector: ConnectorInterface, options: RetrieveRecordsOptions, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: (result: RetrieveRecordsSummary) => void): Promise<void>;

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

@@ -5,10 +5,10 @@ import { ModuleConfig } from '../module';
 import { Component, ComponentConfig, ComponentReference } from '..';
 export interface Context extends Component {
     readonly config: ContextConfig;
-    list?(settings?: ContextListSettings): Promise<ContextListResult>;
+    list?(context: Context, options?: ContextListOptions): Promise<ContextListResult>;
 }
 export type ContextOperationOptions = object;
-export type ContextListSettings = object;
+export type ContextListOptions = object;
 export interface ContextListResult {
     models: ContextModelGroupConfig[];
 }

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

@@ -1,9 +1,9 @@
 import { ConnectionConfig } from '../component/connector/connection';
-import { ConnectorOperationOptions } from '../component/connector';
+import { ConnectorOperationOptions, PreviewObjectOptions } from '../component/connector';
 import { ModuleConfig } from '../component/module';
 import { ToolConfig } from '../component/tool';
 import { ContextCallbackData, ContextConfig, ContextOperationOptions } from '../component/context';
-import { DataViewContentAuditConfig, EncodingConfig, ValueDelimiterId } from '../component/dataView';
+import { DataViewContentAuditConfig, DataViewPreviewConfig, EncodingConfig, ValueDelimiterId } from '../component/dataView';
 /** Engine runtime interface. */
 interface EngineRuntimeInterface {
     getEncodingConfigs: (localeId: string) => EncodingConfig[];
@@ -21,6 +21,14 @@ interface EngineWorkerInitialiseOptions {
     connectorStorageURLPrefix: string;
     toolConfigs: ToolConfig[];
 }
+/** Engine interface. */
+interface EngineInterface {
+    previewObject(engine: EngineInterface, connectionConfig: ConnectionConfig, options: PreviewObjectOptions): Promise<{
+        error: unknown;
+    } | {
+        result: DataViewPreviewConfig;
+    }>;
+}
 /** Engine configuration. */
 interface EngineConfig extends ModuleConfig {
     typeId: 'engine';
@@ -48,4 +56,4 @@ interface TestSettings {
     readable: ReadableStream<Uint8Array>;
 }
 /** Exports. */
-export type { AuditObjectContentOptions, AuditObjectContentResult, ConnectorCallbackData, EngineConfig, EngineRuntimeInterface, EngineWorkerInitialiseOptions, EngineWorkerInterface, TestSettings };
+export type { AuditObjectContentOptions, AuditObjectContentResult, ConnectorCallbackData, EngineConfig, EngineInterface, EngineRuntimeInterface, EngineWorkerInitialiseOptions, EngineWorkerInterface, TestSettings };

package/package.json

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