@dpuse/dpuse-shared 1.0.211 → 1.0.213

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.
@@ -2,7 +2,7 @@
2
2
  * Defines the configuration metadata for a connector. Used for validation
3
3
  * of connector manifests and capability discovery at runtime.
4
4
  */
5
- export declare const connectorActionNameSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", undefined>, import('valibot').LiteralSchema<"auditObjectContent", undefined>, import('valibot').LiteralSchema<"closeStore", undefined>, import('valibot').LiteralSchema<"createObject", undefined>, import('valibot').LiteralSchema<"describeConnection", undefined>, import('valibot').LiteralSchema<"dropObject", undefined>, import('valibot').LiteralSchema<"findObject", undefined>, import('valibot').LiteralSchema<"getInfo", undefined>, import('valibot').LiteralSchema<"getReadableStream", undefined>, import('valibot').LiteralSchema<"getRecord", undefined>, import('valibot').LiteralSchema<"listNodes", undefined>, import('valibot').LiteralSchema<"loadObjectRecords", undefined>, import('valibot').LiteralSchema<"openStore", undefined>, import('valibot').LiteralSchema<"previewObject", undefined>, import('valibot').LiteralSchema<"queryRecords", undefined>, import('valibot').LiteralSchema<"removeRecords", undefined>, import('valibot').LiteralSchema<"retrieveRecords", undefined>, import('valibot').LiteralSchema<"upsertRecords", undefined>], undefined>;
5
+ export declare const connectorActionNameSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"auditObjectContent", undefined>, import('valibot').LiteralSchema<"closeStore", undefined>, import('valibot').LiteralSchema<"createObject", undefined>, import('valibot').LiteralSchema<"describeConnection", undefined>, import('valibot').LiteralSchema<"dropObject", undefined>, import('valibot').LiteralSchema<"findObject", undefined>, import('valibot').LiteralSchema<"getInfo", undefined>, import('valibot').LiteralSchema<"getReadableStream", undefined>, import('valibot').LiteralSchema<"getRecord", undefined>, import('valibot').LiteralSchema<"listNodes", undefined>, import('valibot').LiteralSchema<"loadObjectRecords", undefined>, import('valibot').LiteralSchema<"openStore", undefined>, import('valibot').LiteralSchema<"previewObject", undefined>, import('valibot').LiteralSchema<"queryRecords", undefined>, import('valibot').LiteralSchema<"removeRecords", undefined>, import('valibot').LiteralSchema<"retrieveRecords", undefined>, import('valibot').LiteralSchema<"upsertRecords", undefined>], undefined>;
6
6
  export declare const connectorCategoryConfigSchema: import('valibot').StrictObjectSchema<{
7
7
  readonly label: import('valibot').StrictObjectSchema<{
8
8
  readonly en: import('valibot').StringSchema<undefined>;
@@ -25,7 +25,7 @@ export declare const connectorUsageConfigSchema: import('valibot').StrictObjectS
25
25
  }, undefined>;
26
26
  export declare const connectorConfigSchema: import('valibot').StrictObjectSchema<{
27
27
  readonly typeId: import('valibot').LiteralSchema<"connector", undefined>;
28
- readonly actionNames: import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", undefined>, import('valibot').LiteralSchema<"auditObjectContent", undefined>, import('valibot').LiteralSchema<"closeStore", undefined>, import('valibot').LiteralSchema<"createObject", undefined>, import('valibot').LiteralSchema<"describeConnection", undefined>, import('valibot').LiteralSchema<"dropObject", undefined>, import('valibot').LiteralSchema<"findObject", undefined>, import('valibot').LiteralSchema<"getInfo", undefined>, import('valibot').LiteralSchema<"getReadableStream", undefined>, import('valibot').LiteralSchema<"getRecord", undefined>, import('valibot').LiteralSchema<"listNodes", undefined>, import('valibot').LiteralSchema<"loadObjectRecords", undefined>, import('valibot').LiteralSchema<"openStore", undefined>, import('valibot').LiteralSchema<"previewObject", undefined>, import('valibot').LiteralSchema<"queryRecords", undefined>, import('valibot').LiteralSchema<"removeRecords", undefined>, import('valibot').LiteralSchema<"retrieveRecords", undefined>, import('valibot').LiteralSchema<"upsertRecords", undefined>], undefined>, undefined>;
28
+ readonly actionNames: import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"auditObjectContent", undefined>, import('valibot').LiteralSchema<"closeStore", undefined>, import('valibot').LiteralSchema<"createObject", undefined>, import('valibot').LiteralSchema<"describeConnection", undefined>, import('valibot').LiteralSchema<"dropObject", undefined>, import('valibot').LiteralSchema<"findObject", undefined>, import('valibot').LiteralSchema<"getInfo", undefined>, import('valibot').LiteralSchema<"getReadableStream", undefined>, import('valibot').LiteralSchema<"getRecord", undefined>, import('valibot').LiteralSchema<"listNodes", undefined>, import('valibot').LiteralSchema<"loadObjectRecords", undefined>, import('valibot').LiteralSchema<"openStore", undefined>, import('valibot').LiteralSchema<"previewObject", undefined>, import('valibot').LiteralSchema<"queryRecords", undefined>, import('valibot').LiteralSchema<"removeRecords", undefined>, import('valibot').LiteralSchema<"retrieveRecords", undefined>, import('valibot').LiteralSchema<"upsertRecords", undefined>], undefined>, undefined>;
29
29
  readonly category: import('valibot').NullableSchema<import('valibot').StrictObjectSchema<{
30
30
  readonly label: import('valibot').StrictObjectSchema<{
31
31
  readonly en: import('valibot').StringSchema<undefined>;
@@ -8,7 +8,6 @@ import { ConnectionConfig, ConnectionDescriptionConfig, ConnectionNodeConfig, Ob
8
8
  import { connectorActionNameSchema, connectorCategoryConfigSchema, connectorConfigSchema, connectorItemTypeConfigSchema, connectorItemTypeIdSchema, connectorUsageConfigSchema, connectorUsageIdSchema } from './connectorConfig.schema';
9
9
  export { connectorConfigSchema } from './connectorConfig.schema';
10
10
  export interface ConnectorInterface {
11
- abortOperation?(): void;
12
11
  auditObjectContent?(options: AuditObjectContentOptions, chunk: (recordCount: number, byteCount: number) => void): Promise<AuditObjectContentResult>;
13
12
  closeStore?(options: CloseStoreOptions): Promise<void>;
14
13
  createObject?(options: CreateObjectOptions): Promise<void>;
@@ -157,6 +156,7 @@ export interface PreviewObjectResult {
157
156
  }
158
157
  export interface QueryRecordsOptions extends EngineConnectorActionOptions {
159
158
  aggregates: QueryAggregate[];
159
+ columnConfigs: ObjectColumnConfig[];
160
160
  filters: QueryFilter[];
161
161
  groupColumnIndexes: number[];
162
162
  limit: number;
@@ -202,16 +202,10 @@ export interface RetrieveRecordsOptions extends EngineConnectorActionOptions {
202
202
  encodingId: string | undefined;
203
203
  parserId: string | undefined;
204
204
  path: string;
205
- range?: RecordRange | undefined;
206
205
  valueDelimiterId: ValueDelimiterId | undefined;
207
206
  }
208
- export interface RecordRange {
209
- limit: number;
210
- offset: number;
211
- }
212
207
  export interface RetrieveRecordsSummary {
213
208
  recordCount: number;
214
- totalCount?: number | undefined;
215
209
  }
216
210
  export type RecordRetrievalTypeId = 'parsingRecordArray' | 'storeRecordArray';
217
211
  export type RetrieveRecordsChunk = ParsedRecordsChunk | {
@@ -228,7 +222,9 @@ export interface UpsertRecordsOptions extends EngineConnectorActionOptions {
228
222
  }
229
223
  export type ConnectorUsageId = InferOutput<typeof connectorUsageIdSchema>;
230
224
  export { auditObjectContentWithParser, buildPreviewObjectResult, retrieveRecordsWithParser } from './objectParsing';
225
+ export { resolveStorePath } from './storePath';
231
226
  export { convertStoreRecordToParsedRecord, convertStoreValueToText } from './storeValues';
227
+ export { acquireWebLock } from './webLock';
232
228
  export { readTableSchema } from './tableSchema';
233
229
  export declare function determineConnectorUsageId(actionNames: ConnectorActionName[]): ConnectorUsageId;
234
230
  export declare const constructConnectorCategoryConfig: (id: string, localeId?: import('../../../locale').LocaleId) => LocalisedConfig<ConnectorCategoryConfig>;
@@ -0,0 +1,4 @@
1
+ export declare function resolveStorePath(path: string): {
2
+ databaseName: string | undefined;
3
+ tableName: string;
4
+ };
@@ -0,0 +1 @@
1
+ export declare function acquireWebLock(name: string): Promise<(() => void) | undefined>;
@@ -25,7 +25,9 @@ export interface EngineAuthActionOptions {
25
25
  export interface EngineConnectorActionOptions {
26
26
  accountId?: string;
27
27
  appCheckToken?: string;
28
+ requestId?: string;
28
29
  sessionAccessToken?: string;
30
+ signal?: AbortSignal | undefined;
29
31
  }
30
32
  export interface EngineContextActionOptions {
31
33
  accountId?: string;
@@ -39,3 +41,4 @@ export interface EngineCallbackData {
39
41
  export interface EngineConfig extends ModuleConfig {
40
42
  typeId: 'engine';
41
43
  }
44
+ export declare function resolveRequestSignal(options: Pick<EngineConnectorActionOptions, 'signal'>): AbortSignal;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dpuse/dpuse-shared",
3
- "version": "1.0.211",
3
+ "version": "1.0.213",
4
4
  "private": false,
5
5
  "description": "Common constants, types and utilities used across DPUse projects.",
6
6
  "license": "MIT",