@datapos/datapos-shared 0.3.316 → 0.3.319
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.
- package/README.md +1 -2
- package/dist/datapos-shared.es.js +357 -330
- package/dist/types/src/component/componentConfig.schema.d.ts +22 -17
- package/dist/types/src/component/connector/connection.d.ts +5 -6
- package/dist/types/src/component/connector/connectorConfig.schema.d.ts +6 -6
- package/dist/types/src/component/connector/index.d.ts +10 -12
- package/dist/types/src/component/context/contextConfig.schema.d.ts +5 -5
- package/dist/types/src/component/context/index.d.ts +12 -12
- package/dist/types/src/component/dataView/OLD_ContentAuditColumn.d.ts +2 -2
- package/dist/types/src/component/dataView/index.d.ts +9 -11
- package/dist/types/src/component/index.d.ts +5 -5
- package/dist/types/src/component/presenter/index.d.ts +3 -3
- package/dist/types/src/component/presenter/presentation.d.ts +3 -3
- package/dist/types/src/component/presenter/presenterConfig.schema.d.ts +3 -3
- package/dist/types/src/engine/index.d.ts +4 -4
- package/dist/types/src/index.d.ts +36 -14
- package/package.json +4 -3
- package/dist/types/src/timestamp.d.ts +0 -4
|
@@ -1,4 +1,8 @@
|
|
|
1
|
-
|
|
1
|
+
import { LiteralSchema, UnionSchema } from 'valibot';
|
|
2
|
+
type LiteralUnionSchema<T extends readonly string[]> = UnionSchema<{
|
|
3
|
+
[K in keyof T]: LiteralSchema<T[K], undefined>;
|
|
4
|
+
}, undefined>;
|
|
5
|
+
export declare const literalUnion: <const T extends readonly string[]>(values: T) => LiteralUnionSchema<T>;
|
|
2
6
|
export declare const localisedStringSchema: import('valibot').ObjectSchema<{
|
|
3
7
|
readonly 'en-au': import('valibot').StringSchema<undefined>;
|
|
4
8
|
readonly 'en-gb': import('valibot').StringSchema<undefined>;
|
|
@@ -11,13 +15,13 @@ export declare const partialLocalisedStringSchema: import('valibot').ObjectSchem
|
|
|
11
15
|
readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
|
|
12
16
|
readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
|
|
13
17
|
}, undefined>;
|
|
14
|
-
export declare const statusColorIdSchema:
|
|
15
|
-
export declare const componentStatusIdSchema:
|
|
16
|
-
export declare const componentTypeIdSchema:
|
|
17
|
-
export declare const moduleTypeIdSchema:
|
|
18
|
+
export declare const statusColorIdSchema: LiteralUnionSchema<readonly ["amber", "green", "red", "other"]>;
|
|
19
|
+
export declare const componentStatusIdSchema: LiteralUnionSchema<readonly ["alpha", "beta", "generalAvailability", "notApplicable", "preAlpha", "proposed", "releaseCandidate", "unavailable", "underReview"]>;
|
|
20
|
+
export declare const componentTypeIdSchema: LiteralUnionSchema<readonly ["app", "connector", "connectorConnection", "context", "contextModelGroup", "contextModel", "contextModelDimensionGroup", "contextModelDimension", "contextModelDimensionHierarchy", "contextModelEntityGroup", "contextModelEntity", "contextModelEntityDataItem", "contextModelEntityEvent", "contextModelEntityPrimaryMeasure", "contextModelSecondaryMeasureGroup", "contextModelSecondaryMeasure", "dataView", "dimension", "engine", "eventQuery", "presenter", "presenterPresentation", "tool"]>;
|
|
21
|
+
export declare const moduleTypeIdSchema: LiteralUnionSchema<readonly ["app", "engine", "connector", "context", "presenter", "tool"]>;
|
|
18
22
|
export declare const componentStatusSchema: import('valibot').ObjectSchema<{
|
|
19
23
|
readonly id: import('valibot').StringSchema<undefined>;
|
|
20
|
-
readonly color:
|
|
24
|
+
readonly color: LiteralUnionSchema<readonly ["amber", "green", "red", "other"]>;
|
|
21
25
|
readonly label: import('valibot').StringSchema<undefined>;
|
|
22
26
|
}, undefined>;
|
|
23
27
|
export declare const componentConfigCoreFields: {
|
|
@@ -40,13 +44,13 @@ export declare const componentConfigCoreFields: {
|
|
|
40
44
|
readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
|
|
41
45
|
readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
|
|
42
46
|
readonly id: import('valibot').StringSchema<undefined>;
|
|
43
|
-
readonly color:
|
|
47
|
+
readonly color: LiteralUnionSchema<readonly ["amber", "green", "red", "other"]>;
|
|
44
48
|
readonly label: import('valibot').StringSchema<undefined>;
|
|
45
49
|
}, undefined>, undefined>;
|
|
46
|
-
readonly statusId:
|
|
50
|
+
readonly statusId: LiteralUnionSchema<readonly ["alpha", "beta", "generalAvailability", "notApplicable", "preAlpha", "proposed", "releaseCandidate", "unavailable", "underReview"]>;
|
|
47
51
|
};
|
|
48
52
|
export declare const componentConfigSchema: import('valibot').ObjectSchema<{
|
|
49
|
-
readonly typeId:
|
|
53
|
+
readonly typeId: LiteralUnionSchema<readonly ["app", "connector", "connectorConnection", "context", "contextModelGroup", "contextModel", "contextModelDimensionGroup", "contextModelDimension", "contextModelDimensionHierarchy", "contextModelEntityGroup", "contextModelEntity", "contextModelEntityDataItem", "contextModelEntityEvent", "contextModelEntityPrimaryMeasure", "contextModelSecondaryMeasureGroup", "contextModelSecondaryMeasure", "dataView", "dimension", "engine", "eventQuery", "presenter", "presenterPresentation", "tool"]>;
|
|
50
54
|
readonly id: import('valibot').StringSchema<undefined>;
|
|
51
55
|
readonly label: import('valibot').ObjectSchema<{
|
|
52
56
|
readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
|
|
@@ -66,10 +70,10 @@ export declare const componentConfigSchema: import('valibot').ObjectSchema<{
|
|
|
66
70
|
readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
|
|
67
71
|
readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
|
|
68
72
|
readonly id: import('valibot').StringSchema<undefined>;
|
|
69
|
-
readonly color:
|
|
73
|
+
readonly color: LiteralUnionSchema<readonly ["amber", "green", "red", "other"]>;
|
|
70
74
|
readonly label: import('valibot').StringSchema<undefined>;
|
|
71
75
|
}, undefined>, undefined>;
|
|
72
|
-
readonly statusId:
|
|
76
|
+
readonly statusId: LiteralUnionSchema<readonly ["alpha", "beta", "generalAvailability", "notApplicable", "preAlpha", "proposed", "releaseCandidate", "unavailable", "underReview"]>;
|
|
73
77
|
}, undefined>;
|
|
74
78
|
export declare const moduleConfigCoreFields: {
|
|
75
79
|
readonly version: import('valibot').StringSchema<undefined>;
|
|
@@ -92,13 +96,13 @@ export declare const moduleConfigCoreFields: {
|
|
|
92
96
|
readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
|
|
93
97
|
readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
|
|
94
98
|
readonly id: import('valibot').StringSchema<undefined>;
|
|
95
|
-
readonly color:
|
|
99
|
+
readonly color: LiteralUnionSchema<readonly ["amber", "green", "red", "other"]>;
|
|
96
100
|
readonly label: import('valibot').StringSchema<undefined>;
|
|
97
101
|
}, undefined>, undefined>;
|
|
98
|
-
readonly statusId:
|
|
102
|
+
readonly statusId: LiteralUnionSchema<readonly ["alpha", "beta", "generalAvailability", "notApplicable", "preAlpha", "proposed", "releaseCandidate", "unavailable", "underReview"]>;
|
|
99
103
|
};
|
|
100
104
|
export declare const moduleConfigSchema: import('valibot').ObjectSchema<{
|
|
101
|
-
readonly typeId:
|
|
105
|
+
readonly typeId: LiteralUnionSchema<readonly ["app", "engine", "connector", "context", "presenter", "tool"]>;
|
|
102
106
|
readonly version: import('valibot').StringSchema<undefined>;
|
|
103
107
|
readonly id: import('valibot').StringSchema<undefined>;
|
|
104
108
|
readonly label: import('valibot').ObjectSchema<{
|
|
@@ -119,12 +123,12 @@ export declare const moduleConfigSchema: import('valibot').ObjectSchema<{
|
|
|
119
123
|
readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
|
|
120
124
|
readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
|
|
121
125
|
readonly id: import('valibot').StringSchema<undefined>;
|
|
122
|
-
readonly color:
|
|
126
|
+
readonly color: LiteralUnionSchema<readonly ["amber", "green", "red", "other"]>;
|
|
123
127
|
readonly label: import('valibot').StringSchema<undefined>;
|
|
124
128
|
}, undefined>, undefined>;
|
|
125
|
-
readonly statusId:
|
|
129
|
+
readonly statusId: LiteralUnionSchema<readonly ["alpha", "beta", "generalAvailability", "notApplicable", "preAlpha", "proposed", "releaseCandidate", "unavailable", "underReview"]>;
|
|
126
130
|
}, undefined>;
|
|
127
|
-
export declare const
|
|
131
|
+
export declare const componentReferenceSchema: import('valibot').ObjectSchema<{
|
|
128
132
|
readonly id: import('valibot').StringSchema<undefined>;
|
|
129
133
|
readonly label: import('valibot').ObjectSchema<{
|
|
130
134
|
readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
|
|
@@ -143,3 +147,4 @@ export declare const componentRefSchema: import('valibot').ObjectSchema<{
|
|
|
143
147
|
readonly order: import('valibot').NumberSchema<undefined>;
|
|
144
148
|
readonly path: import('valibot').StringSchema<undefined>;
|
|
145
149
|
}, undefined>;
|
|
150
|
+
export {};
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
import { ComponentConfig } from '..';
|
|
2
2
|
import { ConnectorConfig } from '.';
|
|
3
|
-
import { Timestamp } from '../../timestamp';
|
|
4
3
|
export interface ConnectionAuthorizationConfig {
|
|
5
4
|
accessToken: string;
|
|
6
5
|
accountId: string;
|
|
7
|
-
expiresAt:
|
|
6
|
+
expiresAt: number;
|
|
8
7
|
expiresIn: number;
|
|
9
8
|
refreshToken: string;
|
|
10
9
|
scope: string;
|
|
@@ -14,7 +13,7 @@ export interface ConnectionAuthorizationConfig {
|
|
|
14
13
|
export interface ConnectionConfig extends ComponentConfig {
|
|
15
14
|
authorisation: Record<string, ConnectionAuthorizationConfig>;
|
|
16
15
|
connectorConfig: ConnectorConfig;
|
|
17
|
-
lastVerifiedAt:
|
|
16
|
+
lastVerifiedAt: number;
|
|
18
17
|
notation?: string;
|
|
19
18
|
}
|
|
20
19
|
export interface ConnectionNodeConfig {
|
|
@@ -27,7 +26,7 @@ export interface ConnectionNodeConfig {
|
|
|
27
26
|
nodeDisplayHeight?: number;
|
|
28
27
|
nodes?: ConnectionNodeConfig[];
|
|
29
28
|
label: string;
|
|
30
|
-
lastModifiedAt?:
|
|
29
|
+
lastModifiedAt?: number;
|
|
31
30
|
mimeType?: string;
|
|
32
31
|
name: string;
|
|
33
32
|
size?: number;
|
|
@@ -61,10 +60,10 @@ export interface ConnectionColumnConfig {
|
|
|
61
60
|
validValues?: Record<string, string>;
|
|
62
61
|
voidValueCount?: number;
|
|
63
62
|
}
|
|
64
|
-
export
|
|
63
|
+
export interface DPAFileSystemFileHandle {
|
|
65
64
|
readonly kind: 'file';
|
|
66
65
|
getFile(): Promise<File>;
|
|
67
|
-
}
|
|
66
|
+
}
|
|
68
67
|
export type StorageTypeId = 'binary' | 'boolean' | 'byte' | 'date' | 'dateTime' | 'dateTimeOffset' | 'decimal' | 'double' | 'int8' | 'int16' | 'int32' | 'int64' | 'object' | 'single' | 'string' | 'time' | 'unknown';
|
|
69
68
|
export type UsageTypeId = 'boolean' | 'decimalNumber' | 'moment' | 'momentDate' | 'momentTime' | 'string' | 'unknown' | 'wholeNumber';
|
|
70
69
|
export interface Encoding {
|
|
@@ -4,9 +4,9 @@ export declare const connectorConfigSchema: import('valibot').ObjectSchema<{
|
|
|
4
4
|
readonly id: import('valibot').StringSchema<undefined>;
|
|
5
5
|
readonly label: import('valibot').StringSchema<undefined>;
|
|
6
6
|
}, undefined>, undefined>;
|
|
7
|
-
readonly categoryId: import('valibot').UnionSchema<import('valibot').LiteralSchema<
|
|
7
|
+
readonly categoryId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"application", undefined>, import('valibot').LiteralSchema<"curatedDataset", undefined>, import('valibot').LiteralSchema<"database", undefined>, import('valibot').LiteralSchema<"fileStore", undefined>], undefined>;
|
|
8
8
|
readonly implementations: import('valibot').RecordSchema<import('valibot').StringSchema<undefined>, import('valibot').ObjectSchema<{
|
|
9
|
-
readonly authMethodId: import('valibot').UnionSchema<import('valibot').LiteralSchema<
|
|
9
|
+
readonly authMethodId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"apiKey", undefined>, import('valibot').LiteralSchema<"disabled", undefined>, import('valibot').LiteralSchema<"oAuth2", undefined>, import('valibot').LiteralSchema<"none", undefined>], undefined>;
|
|
10
10
|
readonly activeConnectionCount: import('valibot').OptionalSchema<import('valibot').NumberSchema<undefined>, undefined>;
|
|
11
11
|
readonly canDescribe: import('valibot').OptionalSchema<import('valibot').BooleanSchema<undefined>, undefined>;
|
|
12
12
|
readonly id: import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
|
|
@@ -19,8 +19,8 @@ export declare const connectorConfigSchema: import('valibot').ObjectSchema<{
|
|
|
19
19
|
readonly maxConnectionCount: import('valibot').OptionalSchema<import('valibot').NumberSchema<undefined>, undefined>;
|
|
20
20
|
readonly params: import('valibot').OptionalSchema<import('valibot').ArraySchema<import('valibot').RecordSchema<import('valibot').StringSchema<undefined>, import('valibot').StringSchema<undefined>, undefined>, undefined>, undefined>;
|
|
21
21
|
}, undefined>, undefined>;
|
|
22
|
-
readonly operations: import('valibot').ArraySchema<import('valibot').UnionSchema<import('valibot').LiteralSchema<
|
|
23
|
-
readonly usageId: import('valibot').UnionSchema<import('valibot').LiteralSchema<
|
|
22
|
+
readonly operations: import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", 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<"getRecord", undefined>, import('valibot').LiteralSchema<"listNodes", undefined>, import('valibot').LiteralSchema<"previewObject", undefined>, import('valibot').LiteralSchema<"removeRecords", undefined>, import('valibot').LiteralSchema<"retrieveRecords", undefined>, import('valibot').LiteralSchema<"upsertRecords", undefined>], undefined>, undefined>;
|
|
23
|
+
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>;
|
|
24
24
|
readonly vendorAccountURL: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
|
|
25
25
|
readonly vendorDocumentationURL: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
|
|
26
26
|
readonly vendorHomeURL: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
|
|
@@ -44,8 +44,8 @@ export declare const connectorConfigSchema: import('valibot').ObjectSchema<{
|
|
|
44
44
|
readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
|
|
45
45
|
readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
|
|
46
46
|
readonly id: import('valibot').StringSchema<undefined>;
|
|
47
|
-
readonly color: import('valibot').UnionSchema<import('valibot').LiteralSchema<
|
|
47
|
+
readonly color: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"amber", undefined>, import('valibot').LiteralSchema<"green", undefined>, import('valibot').LiteralSchema<"red", undefined>, import('valibot').LiteralSchema<"other", undefined>], undefined>;
|
|
48
48
|
readonly label: import('valibot').StringSchema<undefined>;
|
|
49
49
|
}, undefined>, undefined>;
|
|
50
|
-
readonly statusId: import('valibot').UnionSchema<import('valibot').LiteralSchema<
|
|
50
|
+
readonly statusId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"alpha", undefined>, import('valibot').LiteralSchema<"beta", undefined>, import('valibot').LiteralSchema<"generalAvailability", undefined>, import('valibot').LiteralSchema<"notApplicable", undefined>, import('valibot').LiteralSchema<"preAlpha", undefined>, import('valibot').LiteralSchema<"proposed", undefined>, import('valibot').LiteralSchema<"releaseCandidate", undefined>, import('valibot').LiteralSchema<"unavailable", undefined>, import('valibot').LiteralSchema<"underReview", undefined>], undefined>;
|
|
51
51
|
}, undefined>;
|
|
@@ -3,10 +3,10 @@ import { parse as dateFnsParse } from 'date-fns';
|
|
|
3
3
|
import { InferOutput } from 'valibot';
|
|
4
4
|
import { nanoid } from 'nanoid';
|
|
5
5
|
import { connectorConfigSchema } from './connectorConfig.schema';
|
|
6
|
+
import { LocalisedString } from '../../index';
|
|
6
7
|
import { buildFetchError, OperationalError } from '../../errors';
|
|
7
8
|
import { Component, ModuleConfig } from '..';
|
|
8
9
|
import { ConnectionConfig, ConnectionDescription, ConnectionNodeConfig } from './connection';
|
|
9
|
-
import { convertMillisecondsToTimestamp, LocalisedString } from '../../index';
|
|
10
10
|
import { DataViewContentAuditConfig, ValueDelimiterId } from '../dataView';
|
|
11
11
|
import { extractExtensionFromPath, extractNameFromPath, lookupMimeTypeForExtension } from '../../utilities';
|
|
12
12
|
type ConnectorModuleCategoryId = 'application' | 'curatedDataset' | 'database' | 'fileStore';
|
|
@@ -15,7 +15,7 @@ export type ConnectorUsageId = 'bidirectional' | 'destination' | 'source' | 'unk
|
|
|
15
15
|
export declare const CONNECTOR_DESTINATION_OPERATIONS: string[];
|
|
16
16
|
export declare const CONNECTOR_SOURCE_OPERATIONS: string[];
|
|
17
17
|
export interface Connector extends Component {
|
|
18
|
-
abortController?: AbortController
|
|
18
|
+
abortController?: AbortController;
|
|
19
19
|
readonly config: ConnectorConfig;
|
|
20
20
|
readonly connectionConfig: ConnectionConfig;
|
|
21
21
|
readonly tools: ConnectorTools;
|
|
@@ -32,7 +32,6 @@ export interface Connector extends Component {
|
|
|
32
32
|
retrieveRecords?(connector: Connector, settings: RetrieveSettings, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: (result: RetrieveSummary) => void): Promise<void>;
|
|
33
33
|
upsertRecords?(connector: Connector, settings: UpsertSettings): Promise<void>;
|
|
34
34
|
}
|
|
35
|
-
export { connectorConfigSchema };
|
|
36
35
|
export type ConnectorConfig = InferOutput<typeof connectorConfigSchema>;
|
|
37
36
|
export interface ConnectorConfig1 extends ModuleConfig {
|
|
38
37
|
category: ConnectorCategory | null;
|
|
@@ -49,7 +48,7 @@ export type ConnectorLocalisedConfig = Omit<ConnectorConfig, 'label' | 'descript
|
|
|
49
48
|
label: string;
|
|
50
49
|
description: string;
|
|
51
50
|
};
|
|
52
|
-
export
|
|
51
|
+
export interface ConnectorImplementation {
|
|
53
52
|
activeConnectionCount?: number;
|
|
54
53
|
canDescribe?: boolean;
|
|
55
54
|
id?: string;
|
|
@@ -57,12 +56,11 @@ export type ConnectorImplementation = {
|
|
|
57
56
|
label?: LocalisedString;
|
|
58
57
|
maxConnectionCount?: number;
|
|
59
58
|
params?: Record<string, string>[];
|
|
60
|
-
}
|
|
61
|
-
export
|
|
59
|
+
}
|
|
60
|
+
export interface ConnectorTools {
|
|
62
61
|
csvParse: typeof csvParse;
|
|
63
62
|
dataPos: {
|
|
64
63
|
buildFetchError: typeof buildFetchError;
|
|
65
|
-
convertMillisecondsToTimestamp: typeof convertMillisecondsToTimestamp;
|
|
66
64
|
extractExtensionFromPath: typeof extractExtensionFromPath;
|
|
67
65
|
extractNameFromPath: typeof extractNameFromPath;
|
|
68
66
|
lookupMimeTypeForExtension: typeof lookupMimeTypeForExtension;
|
|
@@ -72,7 +70,7 @@ export type ConnectorTools = {
|
|
|
72
70
|
parse: typeof dateFnsParse;
|
|
73
71
|
};
|
|
74
72
|
nanoid: typeof nanoid;
|
|
75
|
-
}
|
|
73
|
+
}
|
|
76
74
|
export interface InitialiseSettings {
|
|
77
75
|
connectorStorageURLPrefix: string;
|
|
78
76
|
}
|
|
@@ -95,8 +93,7 @@ export interface CreateSettings extends ConnectorOperationSettings {
|
|
|
95
93
|
path: string;
|
|
96
94
|
structure: string;
|
|
97
95
|
}
|
|
98
|
-
|
|
99
|
-
}
|
|
96
|
+
type DescribeSettings = ConnectorOperationSettings;
|
|
100
97
|
interface DescribeResult {
|
|
101
98
|
description: ConnectionDescription;
|
|
102
99
|
}
|
|
@@ -167,7 +164,8 @@ export interface ConnectorCallbackData {
|
|
|
167
164
|
typeId: string;
|
|
168
165
|
properties: Record<string, unknown>;
|
|
169
166
|
}
|
|
170
|
-
|
|
167
|
+
interface ConnectorCategory {
|
|
171
168
|
id: string;
|
|
172
169
|
label: string;
|
|
173
|
-
}
|
|
170
|
+
}
|
|
171
|
+
export { connectorConfigSchema } from './connectorConfig.schema';
|
|
@@ -41,12 +41,12 @@ export declare const contextConfigSchema: import('valibot').ObjectSchema<{
|
|
|
41
41
|
readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
|
|
42
42
|
readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
|
|
43
43
|
readonly id: import('valibot').StringSchema<undefined>;
|
|
44
|
-
readonly color: import('valibot').UnionSchema<import('valibot').LiteralSchema<
|
|
44
|
+
readonly color: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"amber", undefined>, import('valibot').LiteralSchema<"green", undefined>, import('valibot').LiteralSchema<"red", undefined>, import('valibot').LiteralSchema<"other", undefined>], undefined>;
|
|
45
45
|
readonly label: import('valibot').StringSchema<undefined>;
|
|
46
46
|
}, undefined>, undefined>;
|
|
47
|
-
readonly statusId: import('valibot').UnionSchema<import('valibot').LiteralSchema<
|
|
47
|
+
readonly statusId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"alpha", undefined>, import('valibot').LiteralSchema<"beta", undefined>, import('valibot').LiteralSchema<"generalAvailability", undefined>, import('valibot').LiteralSchema<"notApplicable", undefined>, import('valibot').LiteralSchema<"preAlpha", undefined>, import('valibot').LiteralSchema<"proposed", undefined>, import('valibot').LiteralSchema<"releaseCandidate", undefined>, import('valibot').LiteralSchema<"unavailable", undefined>, import('valibot').LiteralSchema<"underReview", undefined>], undefined>;
|
|
48
48
|
}, undefined>, undefined>;
|
|
49
|
-
readonly operations: import('valibot').ArraySchema<import('valibot').UnionSchema<import('valibot').LiteralSchema<
|
|
49
|
+
readonly operations: import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"list", undefined>], undefined>, undefined>;
|
|
50
50
|
readonly version: import('valibot').StringSchema<undefined>;
|
|
51
51
|
readonly id: import('valibot').StringSchema<undefined>;
|
|
52
52
|
readonly label: import('valibot').ObjectSchema<{
|
|
@@ -67,8 +67,8 @@ export declare const contextConfigSchema: import('valibot').ObjectSchema<{
|
|
|
67
67
|
readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
|
|
68
68
|
readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
|
|
69
69
|
readonly id: import('valibot').StringSchema<undefined>;
|
|
70
|
-
readonly color: import('valibot').UnionSchema<import('valibot').LiteralSchema<
|
|
70
|
+
readonly color: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"amber", undefined>, import('valibot').LiteralSchema<"green", undefined>, import('valibot').LiteralSchema<"red", undefined>, import('valibot').LiteralSchema<"other", undefined>], undefined>;
|
|
71
71
|
readonly label: import('valibot').StringSchema<undefined>;
|
|
72
72
|
}, undefined>, undefined>;
|
|
73
|
-
readonly statusId: import('valibot').UnionSchema<import('valibot').LiteralSchema<
|
|
73
|
+
readonly statusId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"alpha", undefined>, import('valibot').LiteralSchema<"beta", undefined>, import('valibot').LiteralSchema<"generalAvailability", undefined>, import('valibot').LiteralSchema<"notApplicable", undefined>, import('valibot').LiteralSchema<"preAlpha", undefined>, import('valibot').LiteralSchema<"proposed", undefined>, import('valibot').LiteralSchema<"releaseCandidate", undefined>, import('valibot').LiteralSchema<"unavailable", undefined>, import('valibot').LiteralSchema<"underReview", undefined>], undefined>;
|
|
74
74
|
}, undefined>;
|
|
@@ -1,21 +1,20 @@
|
|
|
1
1
|
import { InferOutput } from 'valibot';
|
|
2
2
|
import { contextConfigSchema } from './contextConfig.schema';
|
|
3
3
|
import { LocalisedString } from '../../index';
|
|
4
|
-
import { Component, ComponentConfig,
|
|
4
|
+
import { Component, ComponentConfig, ComponentReference, ModuleConfig } from '..';
|
|
5
5
|
export interface Context extends Component {
|
|
6
6
|
readonly config: ContextConfig;
|
|
7
7
|
list(settings?: ContextListSettings): Promise<ContextListResult>;
|
|
8
8
|
}
|
|
9
|
-
export type ContextOperationSettings =
|
|
10
|
-
export type ContextListSettings =
|
|
11
|
-
export
|
|
9
|
+
export type ContextOperationSettings = object;
|
|
10
|
+
export type ContextListSettings = object;
|
|
11
|
+
export interface ContextListResult {
|
|
12
12
|
models: ContextModelGroupConfig[];
|
|
13
|
-
}
|
|
14
|
-
export
|
|
13
|
+
}
|
|
14
|
+
export interface ContextCallbackData {
|
|
15
15
|
typeId: string;
|
|
16
16
|
properties: Record<string, unknown>;
|
|
17
|
-
}
|
|
18
|
-
export { contextConfigSchema };
|
|
17
|
+
}
|
|
19
18
|
export type ContextConfig = InferOutput<typeof contextConfigSchema>;
|
|
20
19
|
export interface ContextConfig1 extends ModuleConfig {
|
|
21
20
|
models: ContextModelGroupConfig[];
|
|
@@ -28,7 +27,7 @@ export type ContextLocalisedConfig = Omit<ContextConfig, 'label' | 'description'
|
|
|
28
27
|
description: string;
|
|
29
28
|
};
|
|
30
29
|
export interface ContextModelGroupConfig extends ComponentConfig {
|
|
31
|
-
modelRefs:
|
|
30
|
+
modelRefs: ComponentReference[];
|
|
32
31
|
order: number;
|
|
33
32
|
}
|
|
34
33
|
export type ContextModelGroupLocalisedConfig = Omit<ContextModelGroupConfig, 'label' | 'description'> & {
|
|
@@ -49,7 +48,7 @@ export interface ContextModelDimensionGroupConfig {
|
|
|
49
48
|
id: string;
|
|
50
49
|
label: Partial<LocalisedString>;
|
|
51
50
|
description: Partial<LocalisedString>;
|
|
52
|
-
dimensionRefs:
|
|
51
|
+
dimensionRefs: ComponentReference[];
|
|
53
52
|
}
|
|
54
53
|
export type ContextModelDimensionGroupLocalisedConfig = Omit<ContextModelDimensionGroupConfig, 'label' | 'description'> & {
|
|
55
54
|
label: string;
|
|
@@ -76,7 +75,7 @@ export interface ContextModelEntityGroupConfig {
|
|
|
76
75
|
id: string;
|
|
77
76
|
label: Partial<LocalisedString>;
|
|
78
77
|
description?: Record<string, unknown>;
|
|
79
|
-
entityRefs:
|
|
78
|
+
entityRefs: ComponentReference[];
|
|
80
79
|
}
|
|
81
80
|
export type ContextModelEntityGroupLocalisedConfig = Omit<ContextModelEntityGroupConfig, 'label' | 'description'> & {
|
|
82
81
|
label: string;
|
|
@@ -123,7 +122,7 @@ export interface ContextModelSecondaryMeasureGroupConfig {
|
|
|
123
122
|
id: string;
|
|
124
123
|
label: Partial<LocalisedString>;
|
|
125
124
|
description?: Record<string, unknown>;
|
|
126
|
-
secondaryMeasureRefs:
|
|
125
|
+
secondaryMeasureRefs: ComponentReference[];
|
|
127
126
|
}
|
|
128
127
|
export type ContextModelSecondaryMeasureGroupLocalisedConfig = Omit<ContextModelSecondaryMeasureGroupConfig, 'label' | 'description'> & {
|
|
129
128
|
label: string;
|
|
@@ -137,3 +136,4 @@ export type ContextModelSecondaryMeasureLocalisedConfig = Omit<ContextModelSecon
|
|
|
137
136
|
label: string;
|
|
138
137
|
description: string;
|
|
139
138
|
};
|
|
139
|
+
export { contextConfigSchema } from './contextConfig.schema';
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { PreviewColumn } from './OLD_PreviewColumn';
|
|
2
|
-
export
|
|
2
|
+
export interface ParsedValue {
|
|
3
3
|
isValid: boolean;
|
|
4
4
|
value: bigint | boolean | number | string | null;
|
|
5
|
-
}
|
|
5
|
+
}
|
|
6
6
|
export declare class ContentAuditColumn extends PreviewColumn {
|
|
7
7
|
doCountIndividualValidValues: boolean;
|
|
8
8
|
doCountPatterns: boolean;
|
|
@@ -1,8 +1,6 @@
|
|
|
1
|
-
import { Timestamp } from '../../timestamp';
|
|
2
1
|
import { Component, ComponentConfig } from '..';
|
|
3
2
|
import { ConnectionColumnConfig, ConnectionNodeConfig } from '../connector/connection';
|
|
4
|
-
export
|
|
5
|
-
}
|
|
3
|
+
export type DataView = Component;
|
|
6
4
|
export interface DataViewConfig extends ComponentConfig {
|
|
7
5
|
connectionId?: string;
|
|
8
6
|
connectionNodeConfig?: ConnectionNodeConfig;
|
|
@@ -15,7 +13,7 @@ export type DataViewLocalisedConfig = Omit<DataViewConfig, 'label' | 'descriptio
|
|
|
15
13
|
description: string;
|
|
16
14
|
};
|
|
17
15
|
export interface DataViewContentAuditConfig {
|
|
18
|
-
asAt:
|
|
16
|
+
asAt: number;
|
|
19
17
|
columns: ConnectionColumnConfig[];
|
|
20
18
|
commentLineCount: number;
|
|
21
19
|
emptyLineCount: number;
|
|
@@ -25,7 +23,7 @@ export interface DataViewContentAuditConfig {
|
|
|
25
23
|
recordCount: number;
|
|
26
24
|
}
|
|
27
25
|
export interface DataViewPreviewConfig {
|
|
28
|
-
asAt:
|
|
26
|
+
asAt: number;
|
|
29
27
|
columnConfigs: ConnectionColumnConfig[];
|
|
30
28
|
dataFormatId: DataFormatId;
|
|
31
29
|
duration: number;
|
|
@@ -52,22 +50,22 @@ export interface EncodingConfig {
|
|
|
52
50
|
isDetectable: boolean;
|
|
53
51
|
isDecodable: boolean;
|
|
54
52
|
}
|
|
55
|
-
|
|
53
|
+
interface DataFormat {
|
|
56
54
|
id: string;
|
|
57
55
|
label: string;
|
|
58
|
-
}
|
|
56
|
+
}
|
|
59
57
|
export declare const getDataFormat: (id: string, localeId?: import('../../index').LocaleCode) => DataFormat;
|
|
60
58
|
export declare const getDataFormats: (localeId?: import('../../index').LocaleCode) => DataFormat[];
|
|
61
|
-
|
|
59
|
+
interface RecordDelimiter {
|
|
62
60
|
id: string;
|
|
63
61
|
label: string;
|
|
64
|
-
}
|
|
62
|
+
}
|
|
65
63
|
export declare const getRecordDelimiter: (id: string, localeId?: import('../../index').LocaleCode) => RecordDelimiter;
|
|
66
64
|
export declare const getRecordDelimiters: (localeId?: import('../../index').LocaleCode) => RecordDelimiter[];
|
|
67
|
-
|
|
65
|
+
interface ValueDelimiter {
|
|
68
66
|
id: string;
|
|
69
67
|
label: string;
|
|
70
|
-
}
|
|
68
|
+
}
|
|
71
69
|
export declare const getValueDelimiter: (id: string, localeId?: import('../../index').LocaleCode) => ValueDelimiter;
|
|
72
70
|
export declare const getValueDelimiters: (localeId?: import('../../index').LocaleCode) => ValueDelimiter[];
|
|
73
71
|
export type ParsedValue = bigint | boolean | number | string | null;
|
|
@@ -4,7 +4,6 @@ import { LocaleCode, LocalisedString, StatusColorId } from '../index';
|
|
|
4
4
|
export interface Component {
|
|
5
5
|
readonly config: ComponentConfig;
|
|
6
6
|
}
|
|
7
|
-
export { componentConfigSchema };
|
|
8
7
|
export type ComponentConfig = InferOutput<typeof componentConfigSchema>;
|
|
9
8
|
export interface ComponentConfig1 {
|
|
10
9
|
id: string;
|
|
@@ -18,7 +17,7 @@ export interface ComponentConfig1 {
|
|
|
18
17
|
statusId: ComponentStatusId;
|
|
19
18
|
typeId: ComponentTypeId;
|
|
20
19
|
}
|
|
21
|
-
export
|
|
20
|
+
export interface ComponentReference {
|
|
22
21
|
id: string;
|
|
23
22
|
label: Partial<LocalisedString>;
|
|
24
23
|
description: Partial<LocalisedString>;
|
|
@@ -26,12 +25,12 @@ export type ComponentRef = {
|
|
|
26
25
|
iconDark: string | null;
|
|
27
26
|
order: number;
|
|
28
27
|
path: string;
|
|
29
|
-
}
|
|
30
|
-
export
|
|
28
|
+
}
|
|
29
|
+
export interface ComponentStatus {
|
|
31
30
|
id: string;
|
|
32
31
|
color: StatusColorId;
|
|
33
32
|
label: string;
|
|
34
|
-
}
|
|
33
|
+
}
|
|
35
34
|
export type ComponentStatusId = 'alpha' | 'beta' | 'generalAvailability' | 'notApplicable' | 'preAlpha' | 'proposed' | 'releaseCandidate' | 'unavailable' | 'underReview';
|
|
36
35
|
export declare const getComponentStatus: (id: string, localeId?: LocaleCode) => ComponentStatus;
|
|
37
36
|
export type ComponentTypeId = 'app' | 'connector' | 'connectorConnection' | 'context' | 'contextModelGroup' | 'contextModel' | 'contextModelDimensionGroup' | 'contextModelDimension' | 'contextModelDimensionHierarchy' | 'contextModelEntityGroup' | 'contextModelEntity' | 'contextModelEntityDataItem' | 'contextModelEntityEvent' | 'contextModelEntityPrimaryMeasure' | 'contextModelSecondaryMeasureGroup' | 'contextModelSecondaryMeasure' | 'dataView' | 'dimension' | 'engine' | 'eventQuery' | 'presenter' | 'presenterPresentation' | 'tool';
|
|
@@ -40,3 +39,4 @@ export interface ModuleConfig extends ComponentConfig {
|
|
|
40
39
|
version: string;
|
|
41
40
|
}
|
|
42
41
|
export type ModuleTypeId = 'app' | 'engine' | 'connector' | 'context' | 'presenter' | 'tool';
|
|
42
|
+
export { componentConfigSchema } from './componentConfig.schema';
|
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
import { Component,
|
|
1
|
+
import { Component, ComponentReference, ModuleConfig } from '..';
|
|
2
2
|
/**
|
|
3
3
|
* Presenter composables, constants, errors, types/interfaces and utilities.
|
|
4
4
|
*/
|
|
5
5
|
export { presenterConfigSchema } from './presenterConfig.schema';
|
|
6
6
|
export interface Presenter extends Component {
|
|
7
7
|
readonly config: PresenterConfig;
|
|
8
|
-
list():
|
|
8
|
+
list(): ComponentReference[];
|
|
9
9
|
render(presentationPath: string, renderTo: HTMLElement, data?: unknown): Promise<void>;
|
|
10
10
|
setColorMode(colorModeId: string): void;
|
|
11
11
|
}
|
|
12
12
|
export interface PresenterConfig extends ModuleConfig {
|
|
13
|
-
presentations:
|
|
13
|
+
presentations: ComponentReference[];
|
|
14
14
|
operations: PresenterOperation[];
|
|
15
15
|
typeId: 'presenter';
|
|
16
16
|
}
|
|
@@ -1,16 +1,15 @@
|
|
|
1
1
|
import { InferOutput } from 'valibot';
|
|
2
2
|
import { ComponentConfig } from '..';
|
|
3
3
|
import { presenterConfigSchema } from './presenterConfig.schema';
|
|
4
|
-
export { presenterConfigSchema };
|
|
5
4
|
export type PresentationConfig = InferOutput<typeof presenterConfigSchema>;
|
|
6
5
|
export interface PresentationConfig1 extends ComponentConfig {
|
|
7
6
|
content: string;
|
|
8
7
|
order: number;
|
|
9
8
|
}
|
|
10
|
-
export
|
|
9
|
+
export interface PresentationVisualConfig {
|
|
11
10
|
content: PresentationVisualContentConfig;
|
|
12
11
|
views: PresentationVisualViewConfig[];
|
|
13
|
-
}
|
|
12
|
+
}
|
|
14
13
|
export interface PresentationVisualContentConfig {
|
|
15
14
|
title?: {
|
|
16
15
|
text: string;
|
|
@@ -75,3 +74,4 @@ export interface PresentationView {
|
|
|
75
74
|
resize: () => void;
|
|
76
75
|
vendorId: string;
|
|
77
76
|
}
|
|
77
|
+
export { presenterConfigSchema } from './presenterConfig.schema';
|
|
@@ -19,7 +19,7 @@ export declare const presenterConfigSchema: import('valibot').ObjectSchema<{
|
|
|
19
19
|
readonly order: import('valibot').NumberSchema<undefined>;
|
|
20
20
|
readonly path: import('valibot').StringSchema<undefined>;
|
|
21
21
|
}, undefined>, undefined>;
|
|
22
|
-
readonly operations: import('valibot').ArraySchema<import('valibot').UnionSchema<import('valibot').LiteralSchema<
|
|
22
|
+
readonly operations: import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"list", undefined>, import('valibot').LiteralSchema<"render", undefined>, import('valibot').LiteralSchema<"setColorMode", undefined>], undefined>, undefined>;
|
|
23
23
|
readonly version: import('valibot').StringSchema<undefined>;
|
|
24
24
|
readonly id: import('valibot').StringSchema<undefined>;
|
|
25
25
|
readonly label: import('valibot').ObjectSchema<{
|
|
@@ -40,8 +40,8 @@ export declare const presenterConfigSchema: import('valibot').ObjectSchema<{
|
|
|
40
40
|
readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
|
|
41
41
|
readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
|
|
42
42
|
readonly id: import('valibot').StringSchema<undefined>;
|
|
43
|
-
readonly color: import('valibot').UnionSchema<import('valibot').LiteralSchema<
|
|
43
|
+
readonly color: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"amber", undefined>, import('valibot').LiteralSchema<"green", undefined>, import('valibot').LiteralSchema<"red", undefined>, import('valibot').LiteralSchema<"other", undefined>], undefined>;
|
|
44
44
|
readonly label: import('valibot').StringSchema<undefined>;
|
|
45
45
|
}, undefined>, undefined>;
|
|
46
|
-
readonly statusId: import('valibot').UnionSchema<import('valibot').LiteralSchema<
|
|
46
|
+
readonly statusId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"alpha", undefined>, import('valibot').LiteralSchema<"beta", undefined>, import('valibot').LiteralSchema<"generalAvailability", undefined>, import('valibot').LiteralSchema<"notApplicable", undefined>, import('valibot').LiteralSchema<"preAlpha", undefined>, import('valibot').LiteralSchema<"proposed", undefined>, import('valibot').LiteralSchema<"releaseCandidate", undefined>, import('valibot').LiteralSchema<"unavailable", undefined>, import('valibot').LiteralSchema<"underReview", undefined>], undefined>;
|
|
47
47
|
}, undefined>;
|
|
@@ -7,18 +7,18 @@ export interface EngineConfig extends ModuleConfig {
|
|
|
7
7
|
typeId: 'engine';
|
|
8
8
|
}
|
|
9
9
|
type InitialiseEngine = (settings: InitialiseSettings) => Promise<void>;
|
|
10
|
-
type ProcessConnectorRequest = (id: string, connectionConfig: ConnectionConfig, settings: ConnectorOperationSettings, callback?: (
|
|
10
|
+
type ProcessConnectorRequest = (id: string, connectionConfig: ConnectionConfig, settings: ConnectorOperationSettings, callback?: (callbackData: ContextCallbackData) => void) => Promise<ConnectorInterfaceResult>;
|
|
11
11
|
export type ConnectorInterfaceResult = AuditContentResult | DataViewPreviewConfig | ListResult | RetrieveResult;
|
|
12
|
-
type ProcessContextRequest = (id: string, contextConfig: ContextConfig, settings: ContextOperationSettings, callback?: (
|
|
12
|
+
type ProcessContextRequest = (id: string, contextConfig: ContextConfig, settings: ContextOperationSettings, callback?: (callbackData: ConnectorCallbackData) => void) => Promise<ContextInterfaceResult>;
|
|
13
13
|
export type ContextInterfaceResult = AuditContentResult | DataViewPreviewConfig | ListResult | RetrieveResult;
|
|
14
14
|
type ProcessTestRequest = (settings: TestSettings) => Promise<Record<string, unknown>>;
|
|
15
|
-
export
|
|
15
|
+
export interface TestSettings {
|
|
16
16
|
action?: string;
|
|
17
17
|
delimiter?: string;
|
|
18
18
|
forceFallback?: boolean;
|
|
19
19
|
hasHeaders?: boolean;
|
|
20
20
|
readable: ReadableStream<Uint8Array>;
|
|
21
|
-
}
|
|
21
|
+
}
|
|
22
22
|
export interface Engine extends Component {
|
|
23
23
|
getEncodingConfigs: (localeId: string) => EncodingConfig[];
|
|
24
24
|
invokeWorker(errorEventCallback: (errorEvent: ErrorEvent) => void): EngineWorker;
|