@dpuse/dpuse-shared 0.3.599 → 0.3.601

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.
@@ -23,7 +23,6 @@ var h = r({
23
23
  ]), _ = a([
24
24
  "abortOperation",
25
25
  "auditObjectContent",
26
- "authenticateConnection",
27
26
  "createObject",
28
27
  "describeConnection",
29
28
  "dropObject",
@@ -5,7 +5,7 @@
5
5
  * of connector manifests and capability discovery at runtime.
6
6
  */
7
7
  /** Operation names a connector may support. */
8
- declare const connectorOperationNameSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", undefined>, import('valibot').LiteralSchema<"auditObjectContent", undefined>, import('valibot').LiteralSchema<"authenticateConnection", undefined>, import('valibot').LiteralSchema<"createObject", undefined>, import('valibot').LiteralSchema<"describeConnection", undefined>, import('valibot').LiteralSchema<"dropObject", undefined>, import('valibot').LiteralSchema<"findObject", 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>;
8
+ declare const connectorOperationNameSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", undefined>, import('valibot').LiteralSchema<"auditObjectContent", undefined>, import('valibot').LiteralSchema<"createObject", undefined>, import('valibot').LiteralSchema<"describeConnection", undefined>, import('valibot').LiteralSchema<"dropObject", undefined>, import('valibot').LiteralSchema<"findObject", 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>;
9
9
  /** Connector data pipeline usage identifiers. */
10
10
  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>;
11
11
  /**
@@ -41,7 +41,7 @@ declare const connectorConfigSchema: import('valibot').ObjectSchema<{
41
41
  readonly maxConnectionCount: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
42
42
  readonly params: import('valibot').OptionalSchema<import('valibot').ArraySchema<import('valibot').RecordSchema<import('valibot').StringSchema<undefined>, import('valibot').StringSchema<undefined>, undefined>, undefined>, undefined>;
43
43
  }, undefined>, undefined>;
44
- readonly operations: import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", undefined>, import('valibot').LiteralSchema<"auditObjectContent", undefined>, import('valibot').LiteralSchema<"authenticateConnection", undefined>, import('valibot').LiteralSchema<"createObject", undefined>, import('valibot').LiteralSchema<"describeConnection", undefined>, import('valibot').LiteralSchema<"dropObject", undefined>, import('valibot').LiteralSchema<"findObject", 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>, undefined>;
44
+ readonly operations: import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", undefined>, import('valibot').LiteralSchema<"auditObjectContent", undefined>, import('valibot').LiteralSchema<"createObject", undefined>, import('valibot').LiteralSchema<"describeConnection", undefined>, import('valibot').LiteralSchema<"dropObject", undefined>, import('valibot').LiteralSchema<"findObject", 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>, undefined>;
45
45
  readonly usageId: 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>;
46
46
  readonly vendorAccountURL: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
47
47
  readonly vendorDocumentationURL: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
@@ -4,14 +4,13 @@ import { ToolConfig } from '../tool';
4
4
  import { ConnectionDescriptionConfig, ConnectionNodeConfig } from './connection';
5
5
  import { connectorCategoryConfigSchema, connectorConfigSchema, connectorOperationNameSchema, connectorUsageIdSchema } from './connectorConfig.schema';
6
6
  import { ContentAuditConfig, ParsingRecord, PreviewConfig, ValueDelimiterId } from '../dataView';
7
- import { EngineOperationOptions, EngineUtilities } from '../../engine';
7
+ import { EngineConnectorActionOptions, EngineUtilities } from '../../engine';
8
8
  export interface ConnectorInterface extends Component {
9
9
  abortController: AbortController | undefined;
10
10
  readonly config: ConnectorConfig;
11
11
  readonly toolConfigs: ToolConfig[];
12
12
  abortOperation?(): void;
13
13
  auditObjectContent?(options: AuditObjectContentOptions, chunk: (rowCount: number) => void): Promise<AuditObjectContentResult>;
14
- authenticateConnection?(accountId: string, windowCenterX: number, windowCenterY: number): Window | undefined;
15
14
  createObject?(options: CreateObjectOptions): Promise<void>;
16
15
  describeConnection?(options: DescribeConnectionOptions): Promise<DescribeConnectionResult>;
17
16
  dropObject?(options: DropObjectOptions): Promise<void>;
@@ -43,7 +42,7 @@ type ConnectorLocalisedConfig = Omit<ConnectorConfig, 'label' | 'description'> &
43
42
  /**
44
43
  * Audit object content options and result.
45
44
  */
46
- interface AuditObjectContentOptions1 extends EngineOperationOptions {
45
+ interface AuditObjectContentOptions1 extends EngineConnectorActionOptions {
47
46
  chunkSize: number | undefined;
48
47
  encodingId: string;
49
48
  path: string;
@@ -58,7 +57,7 @@ interface AuditObjectContentResult1 {
58
57
  /**
59
58
  * Audit object content options.
60
59
  */
61
- interface AuditObjectContentOptions extends EngineOperationOptions {
60
+ interface AuditObjectContentOptions extends EngineConnectorActionOptions {
62
61
  chunkSize: number | undefined;
63
62
  encodingId: string;
64
63
  parsingToolName: string | undefined;
@@ -76,27 +75,27 @@ interface AuditObjectContentResult {
76
75
  /**
77
76
  * Create object options.
78
77
  */
79
- interface CreateObjectOptions extends EngineOperationOptions {
78
+ interface CreateObjectOptions extends EngineConnectorActionOptions {
80
79
  path: string;
81
80
  structure: string;
82
81
  }
83
82
  /**
84
83
  * Describe connection options and result.
85
84
  */
86
- type DescribeConnectionOptions = EngineOperationOptions;
85
+ type DescribeConnectionOptions = EngineConnectorActionOptions;
87
86
  interface DescribeConnectionResult {
88
87
  descriptionConfig: ConnectionDescriptionConfig;
89
88
  }
90
89
  /**
91
90
  * Drop object options.
92
91
  */
93
- interface DropObjectOptions extends EngineOperationOptions {
92
+ interface DropObjectOptions extends EngineConnectorActionOptions {
94
93
  path: string;
95
94
  }
96
95
  /**
97
96
  * Find object options and result.
98
97
  */
99
- interface FindObjectOptions extends EngineOperationOptions {
98
+ interface FindObjectOptions extends EngineConnectorActionOptions {
100
99
  storeId: string | undefined;
101
100
  nodeId: string;
102
101
  }
@@ -106,14 +105,14 @@ interface FindObjectResult {
106
105
  /**
107
106
  * Get readable stream options.
108
107
  */
109
- interface GetReadableStreamOptions extends EngineOperationOptions {
108
+ interface GetReadableStreamOptions extends EngineConnectorActionOptions {
110
109
  id: string;
111
110
  path: string;
112
111
  }
113
112
  /**
114
113
  * Get record options and result.
115
114
  */
116
- interface GetRecordOptions extends EngineOperationOptions {
115
+ interface GetRecordOptions extends EngineConnectorActionOptions {
117
116
  id: string;
118
117
  path: string;
119
118
  }
@@ -123,7 +122,7 @@ interface GetRecordResult {
123
122
  /**
124
123
  * List nodes options and result.
125
124
  */
126
- interface ListNodesOptions extends EngineOperationOptions {
125
+ interface ListNodesOptions extends EngineConnectorActionOptions {
127
126
  folderPath: string;
128
127
  limit?: number;
129
128
  offset?: number;
@@ -138,7 +137,7 @@ interface ListNodesResult {
138
137
  /**
139
138
  * Preview object options.
140
139
  */
141
- interface PreviewObjectOptions extends EngineOperationOptions {
140
+ interface PreviewObjectOptions extends EngineConnectorActionOptions {
142
141
  chunkSize: number | undefined;
143
142
  extension: string | undefined;
144
143
  path: string;
@@ -146,14 +145,14 @@ interface PreviewObjectOptions extends EngineOperationOptions {
146
145
  /**
147
146
  * Remove records options.
148
147
  */
149
- interface RemoveRecordsOptions extends EngineOperationOptions {
148
+ interface RemoveRecordsOptions extends EngineConnectorActionOptions {
150
149
  keys: string[];
151
150
  path: string;
152
151
  }
153
152
  /**
154
153
  * Retrieve chunks options.
155
154
  */
156
- interface RetrieveChunksOptions extends EngineOperationOptions {
155
+ interface RetrieveChunksOptions extends EngineConnectorActionOptions {
157
156
  chunkSize: number | undefined;
158
157
  encodingId: string;
159
158
  path: string;
@@ -162,7 +161,7 @@ interface RetrieveChunksOptions extends EngineOperationOptions {
162
161
  /**
163
162
  * Retrieve records options and summary.
164
163
  */
165
- interface RetrieveRecordsOptions extends EngineOperationOptions {
164
+ interface RetrieveRecordsOptions extends EngineConnectorActionOptions {
166
165
  chunkSize: number | undefined;
167
166
  encodingId: string;
168
167
  path: string;
@@ -198,7 +197,7 @@ interface RetrieveRecordsSummary {
198
197
  /**
199
198
  * Upsert records options.
200
199
  */
201
- interface UpsertRecordsOptions extends EngineOperationOptions {
200
+ interface UpsertRecordsOptions extends EngineConnectorActionOptions {
202
201
  records: Record<string, unknown>[];
203
202
  path: string;
204
203
  }
@@ -7,7 +7,6 @@ export interface Context extends Component {
7
7
  readonly config: ContextConfig;
8
8
  list?(context: Context, options?: ContextListOptions): Promise<ContextListResult>;
9
9
  }
10
- export type ContextOperationOptions = object;
11
10
  export type ContextListOptions = object;
12
11
  export interface ContextListResult {
13
12
  models: ContextModelGroupConfig[];
@@ -1,58 +1,41 @@
1
1
  import { ConnectionConfig } from '../component/connector/connection';
2
+ import { ContextConfig } from '../component/context';
2
3
  import { EncodingTypeConfig } from '../encoding';
3
4
  import { ModuleConfig } from '../component/module';
4
5
  import { ObjectColumnConfig } from '../component/connector';
5
6
  import { ToolConfig } from '../component/tool';
6
- import { ContextConfig, ContextOperationOptions } from '../component/context';
7
7
  import { InferenceRecord, InferenceSummary, ParsingRecord } from '../component/dataView';
8
- /**
9
- * Engine runtime interface.
10
- */
11
- interface EngineRuntimeInterface {
8
+ export interface EngineRuntime {
12
9
  getEncodingTypeConfigs: (localeId: string) => EncodingTypeConfig[];
13
- invokeWorker(errorEventCallback: (errorEvent: ErrorEvent) => void): EngineWorkerInterface;
10
+ invokeWorker(errorEventCallback: (errorEvent: ErrorEvent) => void): EngineWorker;
14
11
  }
15
- /**
16
- * Engine operation options.
17
- */
18
- interface EngineOperationOptions {
19
- accountId?: string;
20
- appCheckToken?: string;
21
- sessionAccessToken?: string;
12
+ export interface EngineWorker {
13
+ initialise: (options: EngineInitialiseOptions) => Promise<void>;
14
+ processRequest: (id: string, config: ConnectionConfig | ContextConfig, options: EngineConnectorActionOptions | EngineContextActionOptions, callback?: (callbackData: EngineCallbackData) => void) => Promise<unknown>;
22
15
  }
23
- /**
24
- * Engine worker interface.
25
- */
26
- interface EngineWorkerInterface {
27
- initialise: (options: EngineWorkerInitialiseOptions) => Promise<void>;
28
- processRequest: (id: string, config: ConnectionConfig | ContextConfig, options: EngineOperationOptions | ContextOperationOptions, callback?: (callbackData: EngineCallbackData) => void) => Promise<unknown>;
29
- }
30
- /**
31
- * Engine worker initialise options.
32
- */
33
- interface EngineWorkerInitialiseOptions {
16
+ export interface EngineConfig extends ModuleConfig {
17
+ typeId: 'engine';
18
+ }
19
+ export interface EngineInitialiseOptions {
34
20
  connectorStorageURLPrefix: string;
35
21
  toolConfigs: ToolConfig[];
36
22
  }
37
- /**
38
- * Engine configuration.
39
- */
40
- interface EngineConfig extends ModuleConfig {
41
- typeId: 'engine';
23
+ export interface EngineConnectorActionOptions {
24
+ accountId?: string;
25
+ appCheckToken?: string;
26
+ sessionAccessToken?: string;
27
+ }
28
+ export interface EngineContextActionOptions {
29
+ accountId?: string;
30
+ appCheckToken?: string;
31
+ sessionAccessToken?: string;
42
32
  }
43
- /**
44
- * Engine callback data.
45
- */
46
- interface EngineCallbackData {
33
+ export interface EngineCallbackData {
47
34
  typeId: string;
48
35
  properties: Record<string, unknown>;
49
36
  }
50
- /**
51
- * Engine utilities.
52
- */
53
- interface EngineUtilities {
37
+ export interface EngineUtilities {
54
38
  hasReadableStreamTransferSupport(): boolean;
55
39
  inferValues: (parsedRecord: ParsingRecord, columnConfigs: ObjectColumnConfig[], leadingRecord: boolean) => InferenceRecord;
56
40
  inferDataTypes: (parsedRecords: ParsingRecord[]) => InferenceSummary;
57
41
  }
58
- export type { EngineCallbackData, EngineConfig, EngineOperationOptions, EngineRuntimeInterface, EngineUtilities, EngineWorkerInitialiseOptions, EngineWorkerInterface };
@@ -15,12 +15,6 @@ ContextModelEntityEventLocalisedConfig, ContextModelEntityPrimaryMeasureConfig,
15
15
  ContextModelEntityPrimaryMeasureLocalisedConfig } from './component/context';
16
16
  /** Interfaces/Types - Context model secondary measure. */
17
17
  export type { ContextModelSecondaryMeasureGroupConfig, ContextModelSecondaryMeasureGroupLocalisedConfig, ContextModelSecondaryMeasureConfig, ContextModelSecondaryMeasureLocalisedConfig } from './component/context';
18
- /** Interfaces/Types - Context Operator Settings */
19
- export interface ContextOperationOptions {
20
- accountId?: string;
21
- appCheckToken?: string;
22
- sessionAccessToken?: string;
23
- }
24
18
  /** Interfaces/Types - Dimension. */
25
19
  export type { DimensionConfig, DimensionLocalisedConfig } from './component/dimension';
26
20
  /** Interfaces/Types - Event query. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dpuse/dpuse-shared",
3
- "version": "0.3.599",
3
+ "version": "0.3.601",
4
4
  "description": "Common constants, types and utilities used across all DPUse projects.",
5
5
  "license": "MIT",
6
6
  "author": "Jonathan Terrell <terrell.jm@gmail.com>",