@dpuse/dpuse-shared 0.3.600 → 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.
@@ -4,7 +4,7 @@ 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;
@@ -42,7 +42,7 @@ type ConnectorLocalisedConfig = Omit<ConnectorConfig, 'label' | 'description'> &
42
42
  /**
43
43
  * Audit object content options and result.
44
44
  */
45
- interface AuditObjectContentOptions1 extends EngineOperationOptions {
45
+ interface AuditObjectContentOptions1 extends EngineConnectorActionOptions {
46
46
  chunkSize: number | undefined;
47
47
  encodingId: string;
48
48
  path: string;
@@ -57,7 +57,7 @@ interface AuditObjectContentResult1 {
57
57
  /**
58
58
  * Audit object content options.
59
59
  */
60
- interface AuditObjectContentOptions extends EngineOperationOptions {
60
+ interface AuditObjectContentOptions extends EngineConnectorActionOptions {
61
61
  chunkSize: number | undefined;
62
62
  encodingId: string;
63
63
  parsingToolName: string | undefined;
@@ -75,27 +75,27 @@ interface AuditObjectContentResult {
75
75
  /**
76
76
  * Create object options.
77
77
  */
78
- interface CreateObjectOptions extends EngineOperationOptions {
78
+ interface CreateObjectOptions extends EngineConnectorActionOptions {
79
79
  path: string;
80
80
  structure: string;
81
81
  }
82
82
  /**
83
83
  * Describe connection options and result.
84
84
  */
85
- type DescribeConnectionOptions = EngineOperationOptions;
85
+ type DescribeConnectionOptions = EngineConnectorActionOptions;
86
86
  interface DescribeConnectionResult {
87
87
  descriptionConfig: ConnectionDescriptionConfig;
88
88
  }
89
89
  /**
90
90
  * Drop object options.
91
91
  */
92
- interface DropObjectOptions extends EngineOperationOptions {
92
+ interface DropObjectOptions extends EngineConnectorActionOptions {
93
93
  path: string;
94
94
  }
95
95
  /**
96
96
  * Find object options and result.
97
97
  */
98
- interface FindObjectOptions extends EngineOperationOptions {
98
+ interface FindObjectOptions extends EngineConnectorActionOptions {
99
99
  storeId: string | undefined;
100
100
  nodeId: string;
101
101
  }
@@ -105,14 +105,14 @@ interface FindObjectResult {
105
105
  /**
106
106
  * Get readable stream options.
107
107
  */
108
- interface GetReadableStreamOptions extends EngineOperationOptions {
108
+ interface GetReadableStreamOptions extends EngineConnectorActionOptions {
109
109
  id: string;
110
110
  path: string;
111
111
  }
112
112
  /**
113
113
  * Get record options and result.
114
114
  */
115
- interface GetRecordOptions extends EngineOperationOptions {
115
+ interface GetRecordOptions extends EngineConnectorActionOptions {
116
116
  id: string;
117
117
  path: string;
118
118
  }
@@ -122,7 +122,7 @@ interface GetRecordResult {
122
122
  /**
123
123
  * List nodes options and result.
124
124
  */
125
- interface ListNodesOptions extends EngineOperationOptions {
125
+ interface ListNodesOptions extends EngineConnectorActionOptions {
126
126
  folderPath: string;
127
127
  limit?: number;
128
128
  offset?: number;
@@ -137,7 +137,7 @@ interface ListNodesResult {
137
137
  /**
138
138
  * Preview object options.
139
139
  */
140
- interface PreviewObjectOptions extends EngineOperationOptions {
140
+ interface PreviewObjectOptions extends EngineConnectorActionOptions {
141
141
  chunkSize: number | undefined;
142
142
  extension: string | undefined;
143
143
  path: string;
@@ -145,14 +145,14 @@ interface PreviewObjectOptions extends EngineOperationOptions {
145
145
  /**
146
146
  * Remove records options.
147
147
  */
148
- interface RemoveRecordsOptions extends EngineOperationOptions {
148
+ interface RemoveRecordsOptions extends EngineConnectorActionOptions {
149
149
  keys: string[];
150
150
  path: string;
151
151
  }
152
152
  /**
153
153
  * Retrieve chunks options.
154
154
  */
155
- interface RetrieveChunksOptions extends EngineOperationOptions {
155
+ interface RetrieveChunksOptions extends EngineConnectorActionOptions {
156
156
  chunkSize: number | undefined;
157
157
  encodingId: string;
158
158
  path: string;
@@ -161,7 +161,7 @@ interface RetrieveChunksOptions extends EngineOperationOptions {
161
161
  /**
162
162
  * Retrieve records options and summary.
163
163
  */
164
- interface RetrieveRecordsOptions extends EngineOperationOptions {
164
+ interface RetrieveRecordsOptions extends EngineConnectorActionOptions {
165
165
  chunkSize: number | undefined;
166
166
  encodingId: string;
167
167
  path: string;
@@ -197,7 +197,7 @@ interface RetrieveRecordsSummary {
197
197
  /**
198
198
  * Upsert records options.
199
199
  */
200
- interface UpsertRecordsOptions extends EngineOperationOptions {
200
+ interface UpsertRecordsOptions extends EngineConnectorActionOptions {
201
201
  records: Record<string, unknown>[];
202
202
  path: string;
203
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,9 +1,9 @@
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
8
  export interface EngineRuntime {
9
9
  getEncodingTypeConfigs: (localeId: string) => EncodingTypeConfig[];
@@ -11,7 +11,7 @@ export interface EngineRuntime {
11
11
  }
12
12
  export interface EngineWorker {
13
13
  initialise: (options: EngineInitialiseOptions) => Promise<void>;
14
- processRequest: (id: string, config: ConnectionConfig | ContextConfig, options: EngineOperationOptions | ContextOperationOptions, callback?: (callbackData: EngineCallbackData) => void) => Promise<unknown>;
14
+ processRequest: (id: string, config: ConnectionConfig | ContextConfig, options: EngineConnectorActionOptions | EngineContextActionOptions, callback?: (callbackData: EngineCallbackData) => void) => Promise<unknown>;
15
15
  }
16
16
  export interface EngineConfig extends ModuleConfig {
17
17
  typeId: 'engine';
@@ -20,7 +20,12 @@ export interface EngineInitialiseOptions {
20
20
  connectorStorageURLPrefix: string;
21
21
  toolConfigs: ToolConfig[];
22
22
  }
23
- export interface EngineOperationOptions {
23
+ export interface EngineConnectorActionOptions {
24
+ accountId?: string;
25
+ appCheckToken?: string;
26
+ sessionAccessToken?: string;
27
+ }
28
+ export interface EngineContextActionOptions {
24
29
  accountId?: string;
25
30
  appCheckToken?: string;
26
31
  sessionAccessToken?: string;
@@ -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.600",
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>",