@datapos/datapos-development 0.3.177 → 0.3.178
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.
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
interface ComponentStatus {
|
|
2
|
+
id: string;
|
|
3
|
+
color: StatusColorId;
|
|
4
|
+
label: string;
|
|
5
|
+
}
|
|
6
|
+
type ComponentStatusId = 'alpha' | 'beta' | 'generalAvailability' | 'notApplicable' | 'preAlpha' | 'proposed' | 'releaseCandidate' | 'unavailable' | 'underReview';
|
|
7
|
+
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';
|
|
8
|
+
type LocaleCode = 'en-au' | 'en-gb' | 'en-us' | 'es-es';
|
|
9
|
+
type LocalisedString = Record<LocaleCode, string>;
|
|
10
|
+
type StatusColorId = 'amber' | 'green' | 'red' | 'other';
|
|
11
|
+
interface ComponentConfig {
|
|
12
|
+
id: string;
|
|
13
|
+
label: Partial<LocalisedString>;
|
|
14
|
+
description: Partial<LocalisedString>;
|
|
15
|
+
firstCreatedAt?: number;
|
|
16
|
+
icon?: string;
|
|
17
|
+
iconDark?: string;
|
|
18
|
+
lastUpdatedAt?: number;
|
|
19
|
+
status?: ComponentStatus;
|
|
20
|
+
statusId: ComponentStatusId;
|
|
21
|
+
typeId: ComponentTypeId;
|
|
22
|
+
}
|
|
23
|
+
interface ModuleConfig extends ComponentConfig {
|
|
24
|
+
typeId: ModuleTypeId;
|
|
25
|
+
version: string;
|
|
26
|
+
}
|
|
27
|
+
type ModuleTypeId = 'app' | 'engine' | 'connector' | 'context' | 'presenter' | 'tool';
|
|
28
|
+
interface ConnectorCategory {
|
|
29
|
+
id: string;
|
|
30
|
+
label: string;
|
|
31
|
+
}
|
|
32
|
+
export interface ConnectorImplementation {
|
|
33
|
+
activeConnectionCount?: number;
|
|
34
|
+
canDescribe?: boolean;
|
|
35
|
+
id?: string;
|
|
36
|
+
authMethodId: 'apiKey' | 'disabled' | 'oAuth2' | 'none';
|
|
37
|
+
label?: LocalisedString;
|
|
38
|
+
maxConnectionCount?: number;
|
|
39
|
+
params?: Record<string, string>[];
|
|
40
|
+
}
|
|
41
|
+
type ConnectorModuleCategoryId = 'application' | 'curatedDataset' | 'database' | 'fileStore';
|
|
42
|
+
type ConnectorOperation = 'abortOperation' | 'authenticateConnection' | 'createObject' | 'describeConnection' | 'dropObject' | 'findObject' | 'getRecord' | 'listNodes' | 'previewObject' | 'removeRecords' | 'retrieveRecords' | 'upsertRecords';
|
|
43
|
+
type ConnectorUsageId = 'bidirectional' | 'destination' | 'source' | 'unknown';
|
|
44
|
+
export interface ConnectorConfig extends ModuleConfig {
|
|
45
|
+
category?: ConnectorCategory;
|
|
46
|
+
categoryId: ConnectorModuleCategoryId;
|
|
47
|
+
implementations: Record<string, ConnectorImplementation>;
|
|
48
|
+
operations: ConnectorOperation[];
|
|
49
|
+
typeId: 'connector';
|
|
50
|
+
usageId: ConnectorUsageId;
|
|
51
|
+
vendorAccountURL?: string;
|
|
52
|
+
vendorDocumentationURL?: string;
|
|
53
|
+
vendorHomeURL?: string;
|
|
54
|
+
}
|
|
55
|
+
export {};
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
export declare const connectorImplementationSchema: z.ZodObject<{
|
|
3
|
+
activeConnectionCount: z.ZodOptional<z.ZodNumber>;
|
|
4
|
+
canDescribe: z.ZodOptional<z.ZodBoolean>;
|
|
5
|
+
id: z.ZodOptional<z.ZodString>;
|
|
6
|
+
authMethodId: z.ZodUnion<readonly [z.ZodLiteral<"apiKey">, z.ZodLiteral<"disabled">, z.ZodLiteral<"oAuth2">, z.ZodLiteral<"none">]>;
|
|
7
|
+
label: z.ZodOptional<z.ZodRecord<z.ZodUnion<readonly [z.ZodLiteral<"en-au">, z.ZodLiteral<"en-gb">, z.ZodLiteral<"en-us">, z.ZodLiteral<"es-es">]>, z.ZodString>>;
|
|
8
|
+
maxConnectionCount: z.ZodOptional<z.ZodNumber>;
|
|
9
|
+
params: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
10
|
+
}, z.core.$strip>;
|
|
11
|
+
export declare const connectorConfigSchema: z.ZodObject<{
|
|
12
|
+
id: z.ZodString;
|
|
13
|
+
label: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
14
|
+
description: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
15
|
+
firstCreatedAt: z.ZodOptional<z.ZodNumber>;
|
|
16
|
+
icon: z.ZodOptional<z.ZodString>;
|
|
17
|
+
iconDark: z.ZodOptional<z.ZodString>;
|
|
18
|
+
lastUpdatedAt: z.ZodOptional<z.ZodNumber>;
|
|
19
|
+
status: z.ZodOptional<z.ZodObject<{
|
|
20
|
+
id: z.ZodString;
|
|
21
|
+
color: z.ZodUnion<readonly [z.ZodLiteral<"amber">, z.ZodLiteral<"green">, z.ZodLiteral<"red">, z.ZodLiteral<"other">]>;
|
|
22
|
+
label: z.ZodString;
|
|
23
|
+
}, z.core.$strip>>;
|
|
24
|
+
statusId: z.ZodUnion<readonly [z.ZodLiteral<"alpha">, z.ZodLiteral<"beta">, z.ZodLiteral<"generalAvailability">, z.ZodLiteral<"notApplicable">, z.ZodLiteral<"preAlpha">, z.ZodLiteral<"proposed">, z.ZodLiteral<"releaseCandidate">, z.ZodLiteral<"unavailable">, z.ZodLiteral<"underReview">]>;
|
|
25
|
+
version: z.ZodString;
|
|
26
|
+
category: z.ZodOptional<z.ZodObject<{
|
|
27
|
+
id: z.ZodString;
|
|
28
|
+
label: z.ZodString;
|
|
29
|
+
}, z.core.$strip>>;
|
|
30
|
+
categoryId: z.ZodUnion<readonly [z.ZodLiteral<"application">, z.ZodLiteral<"curatedDataset">, z.ZodLiteral<"database">, z.ZodLiteral<"fileStore">]>;
|
|
31
|
+
implementations: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
32
|
+
activeConnectionCount: z.ZodOptional<z.ZodNumber>;
|
|
33
|
+
canDescribe: z.ZodOptional<z.ZodBoolean>;
|
|
34
|
+
id: z.ZodOptional<z.ZodString>;
|
|
35
|
+
authMethodId: z.ZodUnion<readonly [z.ZodLiteral<"apiKey">, z.ZodLiteral<"disabled">, z.ZodLiteral<"oAuth2">, z.ZodLiteral<"none">]>;
|
|
36
|
+
label: z.ZodOptional<z.ZodRecord<z.ZodUnion<readonly [z.ZodLiteral<"en-au">, z.ZodLiteral<"en-gb">, z.ZodLiteral<"en-us">, z.ZodLiteral<"es-es">]>, z.ZodString>>;
|
|
37
|
+
maxConnectionCount: z.ZodOptional<z.ZodNumber>;
|
|
38
|
+
params: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
39
|
+
}, z.core.$strip>>;
|
|
40
|
+
operations: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"abortOperation">, z.ZodLiteral<"authenticateConnection">, z.ZodLiteral<"createObject">, z.ZodLiteral<"describeConnection">, z.ZodLiteral<"dropObject">, z.ZodLiteral<"findObject">, z.ZodLiteral<"getRecord">, z.ZodLiteral<"listNodes">, z.ZodLiteral<"previewObject">, z.ZodLiteral<"removeRecords">, z.ZodLiteral<"retrieveRecords">, z.ZodLiteral<"upsertRecords">]>>;
|
|
41
|
+
typeId: z.ZodLiteral<"connector">;
|
|
42
|
+
usageId: z.ZodUnion<readonly [z.ZodLiteral<"bidirectional">, z.ZodLiteral<"destination">, z.ZodLiteral<"source">, z.ZodLiteral<"unknown">]>;
|
|
43
|
+
vendorAccountURL: z.ZodOptional<z.ZodString>;
|
|
44
|
+
vendorDocumentationURL: z.ZodOptional<z.ZodString>;
|
|
45
|
+
vendorHomeURL: z.ZodOptional<z.ZodString>;
|
|
46
|
+
}, z.core.$strip>;
|
package/package.json
CHANGED