@datapos/datapos-shared 0.3.362 → 0.3.364

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.
@@ -1,6 +1,7 @@
1
1
  import { ComponentConfig } from '..';
2
2
  import { ConnectorConfig } from '.';
3
- export interface ConnectionAuthorizationConfig {
3
+ /** Connection authorisation configuration. */
4
+ interface ConnectionAuthorisationConfig {
4
5
  accessToken: string;
5
6
  accountId: string;
6
7
  expiresAt: number;
@@ -10,13 +11,15 @@ export interface ConnectionAuthorizationConfig {
10
11
  tokenType: string;
11
12
  uid: string;
12
13
  }
13
- export interface ConnectionConfig extends ComponentConfig {
14
- authorisation: Record<string, ConnectionAuthorizationConfig>;
14
+ /** Connection configuration. */
15
+ interface ConnectionConfig extends ComponentConfig {
16
+ authorisation: Record<string, ConnectionAuthorisationConfig>;
15
17
  connectorConfig: ConnectorConfig;
16
18
  lastVerifiedAt: number;
17
19
  notation?: string;
18
20
  }
19
- export interface ConnectionNodeConfig {
21
+ /** Connection node configuration. */
22
+ interface ConnectionNodeConfig {
20
23
  childCount?: number;
21
24
  columnsConfigs?: ConnectionColumnConfig[];
22
25
  extension?: string;
@@ -32,15 +35,16 @@ export interface ConnectionNodeConfig {
32
35
  size?: number;
33
36
  typeId: ConnectionNodeTypeId;
34
37
  }
35
- export type ConnectionNodeTypeId = 'folder' | 'object';
36
- export interface ConnectionDescription {
38
+ type ConnectionNodeTypeId = 'folder' | 'object';
39
+ /** Connection description. */
40
+ interface ConnectionDescription {
37
41
  objects: {
38
42
  id: string;
39
43
  label: Record<string, string>;
40
44
  columns: ConnectionColumnConfig[];
41
45
  }[];
42
46
  }
43
- export interface ConnectionColumnConfig {
47
+ interface ConnectionColumnConfig {
44
48
  invalidValueCount?: number;
45
49
  invalidValues?: string[];
46
50
  isIgnored?: boolean;
@@ -60,13 +64,11 @@ export interface ConnectionColumnConfig {
60
64
  validValues?: Record<string, string>;
61
65
  voidValueCount?: number;
62
66
  }
63
- export interface DPAFileSystemFileHandle {
67
+ interface DPAFileSystemFileHandle {
64
68
  readonly kind: 'file';
65
69
  getFile(): Promise<File>;
66
70
  }
67
- export type StorageTypeId = 'binary' | 'boolean' | 'byte' | 'date' | 'dateTime' | 'dateTimeOffset' | 'decimal' | 'double' | 'int8' | 'int16' | 'int32' | 'int64' | 'object' | 'single' | 'string' | 'time' | 'unknown';
68
- export type UsageTypeId = 'boolean' | 'decimalNumber' | 'moment' | 'momentDate' | 'momentTime' | 'string' | 'unknown' | 'wholeNumber';
69
- export interface Encoding {
70
- id: string;
71
- confidenceLevel?: number;
72
- }
71
+ type StorageTypeId = 'binary' | 'boolean' | 'byte' | 'date' | 'dateTime' | 'dateTimeOffset' | 'decimal' | 'double' | 'int8' | 'int16' | 'int32' | 'int64' | 'object' | 'single' | 'string' | 'time' | 'unknown';
72
+ type UsageTypeId = 'boolean' | 'decimalNumber' | 'moment' | 'momentDate' | 'momentTime' | 'string' | 'unknown' | 'wholeNumber';
73
+ /** Exports. */
74
+ export type { ConnectionConfig, ConnectionDescription, ConnectionNodeConfig };
@@ -17,7 +17,7 @@ type ConnectorLocalisedConfig = Omit<ConnectorConfig, 'label' | 'description'> &
17
17
  };
18
18
  /** Connector runtime interface. */
19
19
  interface Connector extends Component {
20
- abortController?: AbortController;
20
+ abortController: AbortController | undefined;
21
21
  readonly config: ConnectorConfig;
22
22
  readonly connectionConfig: ConnectionConfig;
23
23
  readonly toolConfigs: ToolConfig[];
@@ -150,6 +150,7 @@ export interface ConnectorCallbackData {
150
150
  typeId: string;
151
151
  properties: Record<string, unknown>;
152
152
  }
153
- /** Exports */
153
+ /** Exports. */
154
+ export type { ConnectionConfig, ConnectionNodeConfig } from './connection';
154
155
  export type { Connector, ConnectorConfig, ConnectorLocalisedConfig };
155
156
  export { connectorConfigSchema } from './connectorConfig.schema';
@@ -77,7 +77,7 @@ declare function normalizeToError(value: unknown): Error;
77
77
  * - Messages are normalized to end with punctuation.
78
78
  */
79
79
  declare function serialiseError(error?: unknown): SerialisedError[];
80
- /** Exports */
80
+ /** Exports. */
81
81
  export type { SerialisedError };
82
82
  export { ApplicationError, APIError, EngineError, FetchError, OperationalError, VueHandledError, WindowHandledRuntimeError, WindowHandledPromiseRejectionError };
83
83
  export { buildFetchError, concatenateSerialisedErrorMessages, normalizeToError, serialiseError };
@@ -11,7 +11,7 @@ export { componentConfigSchema } from './component';
11
11
  /** Interfaces/Types Component - Connector */
12
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
13
  /** Interfaces/Types - Connection */
14
- export type { ConnectionAuthorizationConfig, ConnectionColumnConfig, ConnectionConfig, ConnectionNodeConfig, DPAFileSystemFileHandle, Encoding, StorageTypeId, UsageTypeId } from './component/connector/connection';
14
+ export type { ConnectionConfig, ConnectionNodeConfig } from './component/connector/connection';
15
15
  /** Schemas - Connector */
16
16
  export { connectorConfigSchema } from './component/connector/connectorConfig.schema';
17
17
  /** Interfaces/Types - Context. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@datapos/datapos-shared",
3
- "version": "0.3.362",
3
+ "version": "0.3.364",
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>",