@datapos/datapos-shared 0.3.384 → 0.3.386

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/datapos-shared-engine.es.js +1 -0
  2. package/dist/types/src/component/connector/index.d.ts +1 -5
  3. package/dist/types/src/engine/index.d.ts +13 -15
  4. package/dist/types/src/index.d.ts +0 -3
  5. package/package.json +6 -2
package/dist/datapos-shared-engine.es.js ADDED
@@ -0,0 +1 @@
1
+
package/dist/types/src/component/connector/index.d.ts CHANGED
@@ -44,10 +44,6 @@ interface GetReadableStreamSettings extends ConnectorOperationSettings {
44
44
  id: string;
45
45
  path: string;
46
46
  }
47
- interface InitialiseSettings {
48
- connectorStorageURLPrefix: string;
49
- toolConfigs: ToolConfig[];
50
- }
51
47
  interface ConnectorOperationSettings {
52
48
  accountId?: string;
53
49
  appCheckToken?: string;
@@ -158,5 +154,5 @@ interface ConnectorCallbackData {
158
154
  /** Exports. */
159
155
  export type { ConnectionColumnConfig, ConnectionConfig, ConnectionNodeConfig, Encoding, UsageTypeId } from './connection';
160
156
  export type { Connector, ConnectorCallbackData, ConnectorConfig, ConnectorLocalisedConfig, ConnectorOperationSettings };
161
- export type { AuditContentResult, AuditContentSettings, CreateSettings, DropSettings, FindResult, FindSettings, GetReadableStreamResult, GetReadableStreamSettings, GetRecordResult, GetRecordSettings, InitialiseSettings, ListResult, ListSettings, PreviewResult, PreviewSettings, RemoveSettings, RetrieveChunksResult, RetrieveChunksSettings, RetrieveChunksSummary, RetrieveRecordsResult, RetrieveRecordsSettings, RetrieveRecordsSummary, UpsertSettings };
157
+ export type { AuditContentResult, AuditContentSettings, CreateSettings, DropSettings, FindResult, FindSettings, GetReadableStreamResult, GetReadableStreamSettings, GetRecordResult, GetRecordSettings, ListResult, ListSettings, PreviewResult, PreviewSettings, RemoveSettings, RetrieveChunksResult, RetrieveChunksSettings, RetrieveChunksSummary, RetrieveRecordsResult, RetrieveRecordsSettings, RetrieveRecordsSummary, UpsertSettings };
162
158
  export { connectorConfigSchema } from './connectorConfig.schema';
package/dist/types/src/engine/index.d.ts CHANGED
@@ -1,32 +1,30 @@
1
1
  import { ConnectionConfig } from '../component/connector/connection';
2
- import { AuditContentResult, ConnectorCallbackData, ConnectorOperationSettings, InitialiseSettings, ListResult, RetrieveRecordsResult } from '../component/connector';
3
- import { Component, ModuleConfig } from '../component';
2
+ import { ToolConfig } from '../component/tool';
3
+ import { AuditContentResult, ConnectorCallbackData, ConnectorOperationSettings, ListResult, RetrieveRecordsResult } from '../component/connector';
4
4
  import { ContextCallbackData, ContextConfig, ContextOperationSettings } from '../component/context';
5
- import { DataViewPreviewConfig, EncodingConfig } from '../component/dataView';
6
- export interface EngineConfig extends ModuleConfig {
7
- typeId: 'engine';
5
+ import { DataViewPreviewConfig } from '../component/dataView';
6
+ interface EngineInitialiseSettings {
7
+ connectorStorageURLPrefix: string;
8
+ toolConfigs: ToolConfig[];
8
9
  }
9
- type InitialiseEngine = (settings: InitialiseSettings) => Promise<void>;
10
+ type InitialiseEngine = (settings: EngineInitialiseSettings) => Promise<void>;
10
11
  type ProcessConnectorRequest = (id: string, connectionConfig: ConnectionConfig, settings: ConnectorOperationSettings, callback?: (callbackData: ContextCallbackData) => void) => Promise<ConnectorInterfaceResult>;
11
- export type ConnectorInterfaceResult = AuditContentResult | DataViewPreviewConfig | ListResult | RetrieveRecordsResult;
12
+ type ConnectorInterfaceResult = AuditContentResult | DataViewPreviewConfig | ListResult | RetrieveRecordsResult;
12
13
  type ProcessContextRequest = (id: string, contextConfig: ContextConfig, settings: ContextOperationSettings, callback?: (callbackData: ConnectorCallbackData) => void) => Promise<ContextInterfaceResult>;
13
- export type ContextInterfaceResult = AuditContentResult | DataViewPreviewConfig | ListResult | RetrieveRecordsResult;
14
+ type ContextInterfaceResult = AuditContentResult | DataViewPreviewConfig | ListResult | RetrieveRecordsResult;
14
15
  type ProcessTestRequest = (settings: TestSettings) => Promise<Record<string, unknown>>;
15
- export interface TestSettings {
16
+ interface TestSettings {
16
17
  action?: string;
17
18
  delimiter?: string;
18
19
  forceFallback?: boolean;
19
20
  hasHeaders?: boolean;
20
21
  readable: ReadableStream<Uint8Array>;
21
22
  }
22
- export interface Engine extends Component {
23
- getEncodingConfigs: (localeId: string) => EncodingConfig[];
24
- invokeWorker(errorEventCallback: (errorEvent: ErrorEvent) => void): EngineWorker;
25
- }
26
- export interface EngineWorker {
23
+ interface EngineWorker {
27
24
  initialise: InitialiseEngine;
28
25
  processConnectorRequest: ProcessConnectorRequest;
29
26
  processContextRequest: ProcessContextRequest;
30
27
  processTestRequest: ProcessTestRequest;
31
28
  }
32
- export {};
29
+ /** Exports. */
30
+ export type { EngineWorker, EngineInitialiseSettings };
package/dist/types/src/index.d.ts CHANGED
@@ -8,8 +8,6 @@ export type LocalisedString = Record<LocaleCode, string>;
8
8
  export type { ComponentConfig, ComponentReference, ComponentStatus, ComponentStatusId, ComponentTypeId, ModuleConfig, ModuleTypeId, ComponentStatusColorId } from './component';
9
9
  /** Schemas - Component */
10
10
  export { componentConfigSchema } from './component';
11
- /** Interfaces/Types Component - Connector */
12
- export type { AuditContentResult, AuditContentSettings, Connector, ConnectorCallbackData, ConnectorConfig, ConnectorLocalisedConfig, ConnectorOperationSettings, CreateSettings, DropSettings, FindResult, FindSettings, GetReadableStreamResult, GetReadableStreamSettings, GetRecordResult, GetRecordSettings, InitialiseSettings, ListResult, ListSettings, PreviewResult, PreviewSettings, RemoveSettings, RetrieveChunksSettings, RetrieveChunksSummary, RetrieveRecordsResult, RetrieveRecordsSettings, RetrieveRecordsSummary, UpsertSettings } from './component/connector';
13
11
  /** Schemas - Connector */
14
12
  export { connectorConfigSchema } from './component/connector/connectorConfig.schema';
15
13
  /** Interfaces/Types - Context. */
@@ -38,7 +36,6 @@ export type { DataViewConfig, DataViewContentAuditConfig, DataViewLocalisedConfi
38
36
  /** Interfaces/Types - Dimension. */
39
37
  export type { DimensionConfig, DimensionLocalisedConfig } from './component/dimension';
40
38
  /** Interfaces/Types - Engine. */
41
- export type { ConnectorInterfaceResult, ContextInterfaceResult, Engine, EngineConfig, EngineWorker, TestSettings } from './engine';
42
39
  /** Interfaces/Types */
43
40
  export type { SerialisedError } from './errors';
44
41
  /** Errors */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@datapos/datapos-shared",
3
- "version": "0.3.384",
3
+ "version": "0.3.386",
4
4
  "description": "A library containing common constants, types and utilities used across all Data Positioning projects.",
5
5
  "license": "MIT",
6
6
  "author": "Jonathan Terrell <terrell.jm@gmail.com>",
@@ -25,10 +25,14 @@
25
25
  "import": "./dist/datapos-shared-connector.es.js",
26
26
  "types": "./dist/types/src/component/connector/index.d.ts"
27
27
  },
28
- "./component/tools": {
28
+ "./component/tool": {
29
29
  "import": "./dist/datapos-shared-tools.es.js",
30
30
  "types": "./dist/types/src/component/tool/index.d.ts"
31
31
  },
32
+ "./engine": {
33
+ "import": "./dist/datapos-shared-engine.es.js",
34
+ "types": "./dist/types/src/engine/index.d.ts"
35
+ },
32
36
  "./errors": {
33
37
  "import": "./dist/datapos-shared-errors.es.js",
34
38
  "types": "./dist/types/src/errors/index.d.ts"