@datapos/datapos-shared 0.3.366 → 0.3.368

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 (2) hide show
  1. package/dist/types/src/component/connector/index.d.ts +32 -27
  2. package/package.json +1 -1
package/dist/types/src/component/connector/index.d.ts CHANGED
@@ -36,97 +36,101 @@ interface Connector extends Component {
36
36
  retrieveRecords?(connector: Connector, settings: RetrieveRecordsSettings, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: (result: RetrieveRecordsSummary) => void): Promise<void>;
37
37
  upsertRecords?(connector: Connector, settings: UpsertSettings): Promise<void>;
38
38
  }
39
- export interface InitialiseSettings {
39
+ interface InitialiseSettings {
40
40
  connectorStorageURLPrefix: string;
41
+ toolConfigs: ToolConfig[];
41
42
  }
42
- export interface ConnectorOperationSettings {
43
+ interface ConnectorOperationSettings {
43
44
  accountId?: string;
44
45
  appCheckToken?: string;
45
46
  sessionAccessToken?: string;
46
47
  }
47
- export interface AuditContentSettings extends ConnectorOperationSettings {
48
+ interface AuditContentSettings extends ConnectorOperationSettings {
48
49
  chunkSize?: number;
49
50
  encodingId: string;
50
51
  path: string;
51
52
  valueDelimiterId: ValueDelimiterId;
52
53
  }
53
- export interface AuditContentResult {
54
+ interface AuditContentResult {
54
55
  contentAuditConfig: DataViewContentAuditConfig;
55
56
  }
56
- export interface CreateSettings extends ConnectorOperationSettings {
57
+ interface CreateSettings extends ConnectorOperationSettings {
57
58
  accountId?: string;
58
59
  path: string;
59
60
  structure: string;
60
61
  }
61
- export type DescribeSettings = ConnectorOperationSettings;
62
- export interface DescribeResult {
62
+ type DescribeSettings = ConnectorOperationSettings;
63
+ interface DescribeResult {
63
64
  description: ConnectionDescription;
64
65
  }
65
- export interface DropSettings extends ConnectorOperationSettings {
66
+ interface DropSettings extends ConnectorOperationSettings {
66
67
  path: string;
67
68
  }
68
- export interface FindSettings extends ConnectorOperationSettings {
69
+ interface FindSettings extends ConnectorOperationSettings {
69
70
  containerName?: string;
70
71
  objectName: string;
71
72
  }
72
- export interface FindResult {
73
+ interface FindResult {
73
74
  folderPath?: string;
74
75
  }
75
- export interface GetReadableStreamSettings extends ConnectorOperationSettings {
76
+ interface GetReadableStreamSettings extends ConnectorOperationSettings {
76
77
  id: string;
77
78
  path: string;
78
79
  }
79
- export interface GetReadableStreamResult {
80
+ interface GetReadableStreamResult {
80
81
  readable?: ReadableStream<unknown>;
81
82
  }
82
- export interface GetRecordSettings extends ConnectorOperationSettings {
83
+ interface GetRecordSettings extends ConnectorOperationSettings {
83
84
  id: string;
84
85
  path: string;
85
86
  }
86
- export interface GetRecordResult {
87
+ interface GetRecordResult {
87
88
  record?: string[] | Record<string, unknown>;
88
89
  }
89
- export interface ListSettings extends ConnectorOperationSettings {
90
+ interface ListSettings extends ConnectorOperationSettings {
90
91
  folderPath: string;
91
92
  limit?: number;
92
93
  offset?: number;
93
94
  totalCount?: number;
94
95
  }
95
- export interface ListResult {
96
+ interface ListResult {
96
97
  cursor: string | number | undefined;
97
98
  connectionNodeConfigs: ConnectionNodeConfig[];
98
99
  isMore: boolean;
99
100
  totalCount: number;
100
101
  }
101
- export interface PreviewSettings extends ConnectorOperationSettings {
102
+ interface PreviewSettings extends ConnectorOperationSettings {
102
103
  chunkSize?: number;
103
104
  extension?: string;
104
105
  path: string;
105
106
  }
106
- export interface PreviewResult {
107
+ interface PreviewResult {
107
108
  data: Record<string, unknown>[] | Uint8Array;
108
109
  typeId: 'jsonArray' | 'uint8Array';
109
110
  }
110
- export interface RemoveSettings extends ConnectorOperationSettings {
111
+ interface RemoveSettings extends ConnectorOperationSettings {
111
112
  keys: string[];
112
113
  path: string;
113
114
  }
114
- export interface RetrieveChunksSettings extends ConnectorOperationSettings {
115
+ interface RetrieveChunksSettings extends ConnectorOperationSettings {
115
116
  chunkSize?: number;
116
117
  encodingId: string;
117
118
  path: string;
118
119
  valueDelimiterId: ValueDelimiterId;
119
120
  }
120
- export interface RetrieveRecordsSettings extends ConnectorOperationSettings {
121
+ interface RetrieveRecordsSettings extends ConnectorOperationSettings {
121
122
  chunkSize?: number;
122
123
  encodingId: string;
123
124
  path: string;
124
125
  valueDelimiterId: ValueDelimiterId;
125
126
  }
126
- export interface RetrieveRecordsResult {
127
+ interface RetrieveChunksResult {
127
128
  records: (string[] | Record<string, unknown>)[];
128
129
  }
129
- export interface RetrieveChunksSummary {
130
+ interface RetrieveRecordsResult {
131
+ records: (string[] | Record<string, unknown>)[];
132
+ }
133
+ interface RetrieveChunksSummary {
130
134
  byteCount: number;
131
135
  commentLineCount: number;
132
136
  emptyLineCount: number;
@@ -134,7 +138,7 @@ export interface RetrieveChunksSummary {
134
138
  lineCount: number;
135
139
  recordCount: number;
136
140
  }
137
- export interface RetrieveRecordsSummary {
141
+ interface RetrieveRecordsSummary {
138
142
  byteCount: number;
139
143
  commentLineCount: number;
140
144
  emptyLineCount: number;
@@ -142,15 +146,16 @@ export interface RetrieveRecordsSummary {
142
146
  lineCount: number;
143
147
  recordCount: number;
144
148
  }
145
- export interface UpsertSettings extends ConnectorOperationSettings {
149
+ interface UpsertSettings extends ConnectorOperationSettings {
146
150
  records: Record<string, unknown>[];
147
151
  path: string;
148
152
  }
149
- export interface ConnectorCallbackData {
153
+ interface ConnectorCallbackData {
150
154
  typeId: string;
151
155
  properties: Record<string, unknown>;
152
156
  }
153
157
  /** Exports. */
154
158
  export type { ConnectionConfig, ConnectionNodeConfig } from './connection';
155
- export type { Connector, ConnectorConfig, ConnectorLocalisedConfig };
159
+ export type { Connector, ConnectorCallbackData, ConnectorConfig, ConnectorLocalisedConfig };
160
+ 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 };
156
161
  export { connectorConfigSchema } from './connectorConfig.schema';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@datapos/datapos-shared",
3
- "version": "0.3.366",
3
+ "version": "0.3.368",
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>",