@dpuse/dpuse-shared 0.3.593

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 (39) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +137 -0
  3. package/README.pdf +0 -0
  4. package/dist/componentConfig.schema-Csigo0y4.js +449 -0
  5. package/dist/dpuse-shared-component.es.js +68 -0
  6. package/dist/dpuse-shared-connector.es.js +90 -0
  7. package/dist/dpuse-shared-dataview.es.js +16 -0
  8. package/dist/dpuse-shared-encoding.es.js +356 -0
  9. package/dist/dpuse-shared-engine.es.js +0 -0
  10. package/dist/dpuse-shared-errors.es.js +181 -0
  11. package/dist/dpuse-shared-locale.es.js +8 -0
  12. package/dist/dpuse-shared-tools.es.js +8 -0
  13. package/dist/dpuse-shared-utilities.es.js +79 -0
  14. package/dist/dpuse-shared.es.js +25 -0
  15. package/dist/moduleConfig.schema-WvtAJjAG.js +19 -0
  16. package/dist/types/src/component/componentConfig.schema.d.ts +129 -0
  17. package/dist/types/src/component/connector/connection.d.ts +92 -0
  18. package/dist/types/src/component/connector/connectorConfig.schema.d.ts +80 -0
  19. package/dist/types/src/component/connector/index.d.ts +219 -0
  20. package/dist/types/src/component/context/contextConfig.schema.d.ts +77 -0
  21. package/dist/types/src/component/context/index.d.ts +136 -0
  22. package/dist/types/src/component/dataView/index.d.ts +215 -0
  23. package/dist/types/src/component/dimension/index.d.ts +8 -0
  24. package/dist/types/src/component/eventQuery/index.d.ts +8 -0
  25. package/dist/types/src/component/index.d.ts +15 -0
  26. package/dist/types/src/component/module.d.ts +7 -0
  27. package/dist/types/src/component/moduleConfig.schema.d.ts +67 -0
  28. package/dist/types/src/component/presenter/index.d.ts +22 -0
  29. package/dist/types/src/component/presenter/presentation.d.ts +77 -0
  30. package/dist/types/src/component/presenter/presenterConfig.schema.d.ts +50 -0
  31. package/dist/types/src/component/tool/index.d.ts +13 -0
  32. package/dist/types/src/encoding/index.d.ts +26 -0
  33. package/dist/types/src/engine/index.d.ts +58 -0
  34. package/dist/types/src/errors/index.d.ts +37 -0
  35. package/dist/types/src/index.d.ts +34 -0
  36. package/dist/types/src/locale/index.d.ts +26 -0
  37. package/dist/types/src/utilities/index.d.ts +12 -0
  38. package/dist/types/vite.config.d.ts +5 -0
  39. package/package.json +120 -0
@@ -0,0 +1,77 @@
1
+ /**
2
+ * Context schema.
3
+ */
4
+ export declare const contextConfigSchema: import('valibot').ObjectSchema<{
5
+ readonly typeId: import('valibot').LiteralSchema<"context", undefined>;
6
+ readonly models: import('valibot').ArraySchema<import('valibot').ObjectSchema<{
7
+ readonly typeId: import('valibot').LiteralSchema<"contextModelGroup", undefined>;
8
+ readonly modelRefs: import('valibot').ArraySchema<import('valibot').ObjectSchema<{
9
+ readonly id: import('valibot').StringSchema<undefined>;
10
+ readonly label: import('valibot').ObjectSchema<{
11
+ readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
12
+ readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
13
+ readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
14
+ readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
15
+ }, undefined>;
16
+ readonly description: import('valibot').ObjectSchema<{
17
+ readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
18
+ readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
19
+ readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
20
+ readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
21
+ }, undefined>;
22
+ readonly icon: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
23
+ readonly iconDark: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
24
+ readonly order: import('valibot').NumberSchema<undefined>;
25
+ readonly path: import('valibot').StringSchema<undefined>;
26
+ }, undefined>, undefined>;
27
+ readonly order: import('valibot').NumberSchema<undefined>;
28
+ readonly id: import('valibot').StringSchema<undefined>;
29
+ readonly label: import('valibot').ObjectSchema<{
30
+ readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
31
+ readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
32
+ readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
33
+ readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
34
+ }, undefined>;
35
+ readonly description: import('valibot').ObjectSchema<{
36
+ readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
37
+ readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
38
+ readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
39
+ readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
40
+ }, undefined>;
41
+ readonly firstCreatedAt: import('valibot').OptionalSchema<import('valibot').NumberSchema<undefined>, undefined>;
42
+ readonly icon: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
43
+ readonly iconDark: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
44
+ readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
45
+ readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
46
+ readonly id: import('valibot').StringSchema<undefined>;
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
+ readonly label: import('valibot').StringSchema<undefined>;
49
+ }, undefined>, undefined>;
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
+ }, undefined>, undefined>;
52
+ readonly operations: import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"list", undefined>], undefined>, undefined>;
53
+ readonly version: import('valibot').StringSchema<undefined>;
54
+ readonly id: import('valibot').StringSchema<undefined>;
55
+ readonly label: import('valibot').ObjectSchema<{
56
+ readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
57
+ readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
58
+ readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
59
+ readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
60
+ }, undefined>;
61
+ readonly description: import('valibot').ObjectSchema<{
62
+ readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
63
+ readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
64
+ readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
65
+ readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
66
+ }, undefined>;
67
+ readonly firstCreatedAt: import('valibot').OptionalSchema<import('valibot').NumberSchema<undefined>, undefined>;
68
+ readonly icon: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
69
+ readonly iconDark: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
70
+ readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
71
+ readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
72
+ readonly id: import('valibot').StringSchema<undefined>;
73
+ 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>;
74
+ readonly label: import('valibot').StringSchema<undefined>;
75
+ }, undefined>, undefined>;
76
+ 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>;
77
+ }, undefined>;
@@ -0,0 +1,136 @@
1
+ import { InferOutput } from 'valibot';
2
+ import { contextConfigSchema } from './contextConfig.schema';
3
+ import { LocalisedString } from '../../locale';
4
+ import { ModuleConfig } from '../module';
5
+ import { Component, ComponentConfig, ComponentReference } from '..';
6
+ export interface Context extends Component {
7
+ readonly config: ContextConfig;
8
+ list?(context: Context, options?: ContextListOptions): Promise<ContextListResult>;
9
+ }
10
+ export type ContextOperationOptions = object;
11
+ export type ContextListOptions = object;
12
+ export interface ContextListResult {
13
+ models: ContextModelGroupConfig[];
14
+ }
15
+ export type ContextConfig = InferOutput<typeof contextConfigSchema>;
16
+ export interface ContextConfig1 extends ModuleConfig {
17
+ models: ContextModelGroupConfig[];
18
+ operations: ContextOperation[];
19
+ typeId: 'context';
20
+ }
21
+ export type ContextOperation = 'list';
22
+ export type ContextLocalisedConfig = Omit<ContextConfig, 'label' | 'description'> & {
23
+ label: string;
24
+ description: string;
25
+ };
26
+ export interface ContextModelGroupConfig extends ComponentConfig {
27
+ modelRefs: ComponentReference[];
28
+ order: number;
29
+ }
30
+ export type ContextModelGroupLocalisedConfig = Omit<ContextModelGroupConfig, 'label' | 'description'> & {
31
+ label: string;
32
+ description: string;
33
+ };
34
+ export interface ContextModelConfig extends ComponentConfig {
35
+ diagramURL?: string;
36
+ dimension: ContextModelDimensionGroupConfig[];
37
+ entities: ContextModelEntityGroupConfig[];
38
+ secondaryMeasures: ContextModelSecondaryMeasureGroupConfig[];
39
+ }
40
+ export type ContextModelLocalisedConfig = Omit<ContextModelConfig, 'label' | 'description'> & {
41
+ label: string;
42
+ description: string;
43
+ };
44
+ export interface ContextModelDimensionGroupConfig {
45
+ id: string;
46
+ label: Partial<LocalisedString>;
47
+ description: Partial<LocalisedString>;
48
+ dimensionRefs: ComponentReference[];
49
+ }
50
+ export type ContextModelDimensionGroupLocalisedConfig = Omit<ContextModelDimensionGroupConfig, 'label' | 'description'> & {
51
+ label: string;
52
+ description: string;
53
+ };
54
+ export interface ContextModelDimensionConfig {
55
+ id: string;
56
+ label: Partial<LocalisedString>;
57
+ hierarchies: ContextModelDimensionHierarchyConfig[];
58
+ }
59
+ export type ContextModelDimensionLocalisedConfig = Omit<ContextModelDimensionConfig, 'label' | 'description'> & {
60
+ label: string;
61
+ description: string;
62
+ };
63
+ export interface ContextModelDimensionHierarchyConfig {
64
+ id: string;
65
+ label: Partial<LocalisedString>;
66
+ }
67
+ export type ContextModelDimensionHierarchyLocalisedConfig = Omit<ContextModelDimensionHierarchyConfig, 'label' | 'description'> & {
68
+ label: string;
69
+ description: string;
70
+ };
71
+ export interface ContextModelEntityGroupConfig {
72
+ id: string;
73
+ label: Partial<LocalisedString>;
74
+ description?: Record<string, unknown>;
75
+ entityRefs: ComponentReference[];
76
+ }
77
+ export type ContextModelEntityGroupLocalisedConfig = Omit<ContextModelEntityGroupConfig, 'label' | 'description'> & {
78
+ label: string;
79
+ description: string;
80
+ };
81
+ export interface ContextModelEntityConfig {
82
+ id: string;
83
+ label: Partial<LocalisedString>;
84
+ labelPlural: Partial<LocalisedString>;
85
+ dataItems: ContextModelEntityDataItemConfig[];
86
+ events: ContextModelEntityEventConfig[];
87
+ primaryMeasures: ContextModelEntityPrimaryMeasureConfig[];
88
+ }
89
+ export type ContextModelEntityLocalisedConfig = Omit<ContextModelEntityConfig, 'label' | 'description'> & {
90
+ label: string;
91
+ description: string;
92
+ };
93
+ export interface ContextModelEntityDataItemConfig {
94
+ id: string;
95
+ label: Partial<LocalisedString>;
96
+ }
97
+ export type ContextModelEntityDataItemLocalisedConfig = Omit<ContextModelEntityDataItemConfig, 'label' | 'description'> & {
98
+ label: string;
99
+ description: string;
100
+ };
101
+ export interface ContextModelEntityEventConfig {
102
+ id: string;
103
+ labelAction: Record<string, string>;
104
+ labelState: Record<string, string>;
105
+ }
106
+ export type ContextModelEntityEventLocalisedConfig = Omit<ContextModelEntityEventConfig, 'label' | 'description'> & {
107
+ label: string;
108
+ description: string;
109
+ };
110
+ export interface ContextModelEntityPrimaryMeasureConfig {
111
+ id: string;
112
+ label: Partial<LocalisedString>;
113
+ }
114
+ export type ContextModelEntityPrimaryMeasureLocalisedConfig = Omit<ContextModelEntityPrimaryMeasureConfig, 'label' | 'description'> & {
115
+ label: string;
116
+ description: string;
117
+ };
118
+ export interface ContextModelSecondaryMeasureGroupConfig {
119
+ id: string;
120
+ label: Partial<LocalisedString>;
121
+ description?: Record<string, unknown>;
122
+ secondaryMeasureRefs: ComponentReference[];
123
+ }
124
+ export type ContextModelSecondaryMeasureGroupLocalisedConfig = Omit<ContextModelSecondaryMeasureGroupConfig, 'label' | 'description'> & {
125
+ label: string;
126
+ description: string;
127
+ };
128
+ export interface ContextModelSecondaryMeasureConfig {
129
+ id: string;
130
+ label: Partial<LocalisedString>;
131
+ }
132
+ export type ContextModelSecondaryMeasureLocalisedConfig = Omit<ContextModelSecondaryMeasureConfig, 'label' | 'description'> & {
133
+ label: string;
134
+ description: string;
135
+ };
136
+ export { contextConfigSchema } from './contextConfig.schema';
@@ -0,0 +1,215 @@
1
+ import { FileTypeResult } from 'file-type';
2
+ import { Component, ComponentConfig } from '..';
3
+ import { ConnectionNodeConfig, ObjectColumnConfig } from '../connector/connection';
4
+ /**
5
+ * Data view interface.
6
+ */
7
+ type DataViewInterface = Component;
8
+ /**
9
+ * Data view configuration.
10
+ */
11
+ interface DataViewConfig extends ComponentConfig {
12
+ connectionId: string | undefined;
13
+ connectionNodeConfig: ConnectionNodeConfig | undefined;
14
+ previewConfig: PreviewConfig | undefined;
15
+ contentAuditConfig: ContentAuditConfig | undefined;
16
+ relationshipsAuditConfig: RelationshipsAuditConfig | undefined;
17
+ }
18
+ /**
19
+ * Data view localised configuration.
20
+ */
21
+ type DataViewLocalisedConfig = Omit<DataViewConfig, 'label' | 'description'> & {
22
+ label: string;
23
+ description: string;
24
+ };
25
+ /**
26
+ * Data view preview configuration.
27
+ */
28
+ interface PreviewConfig {
29
+ asAt: number;
30
+ commentMarkId?: string | undefined;
31
+ commentMarkOtherCharSeq?: string | undefined;
32
+ columnConfigs: ObjectColumnConfig[];
33
+ dataFormatId: DataFormatId;
34
+ duration: number;
35
+ encodingConfidenceLevel: number | undefined;
36
+ encodingId: string | undefined;
37
+ errorMessage?: string | undefined;
38
+ fileType: FileTypeResult | undefined;
39
+ hasHeaders: boolean | undefined;
40
+ inferenceRecords: InferenceRecord[];
41
+ linesToSkipAtStart?: number | undefined;
42
+ parsedRecords: ParsingRecord[];
43
+ quoteEscapeChar?: string | undefined;
44
+ quoteMarkId?: string | undefined;
45
+ quoteMarkOtherCharSeq?: string | undefined;
46
+ recordDelimiterId: RecordDelimiterId | undefined;
47
+ recordDelimiterOtherCharSeq?: string | undefined;
48
+ size: number | undefined;
49
+ skipEmptyLines?: boolean | undefined;
50
+ skipLinesWithEmptyValues?: boolean | undefined;
51
+ skipLinesWithErrors?: boolean | undefined;
52
+ text: string | undefined;
53
+ valueDelimiterId: ValueDelimiterId | undefined;
54
+ valueDelimiterOtherCharSeq?: string | undefined;
55
+ valueTrimMethodId?: ValueTrimMethodId | undefined;
56
+ }
57
+ /**
58
+ *
59
+ */
60
+ type ValueTrimMethodId = 'both' | 'left' | 'right' | 'none';
61
+ /**
62
+ * Data view content audit configuration.
63
+ */
64
+ interface ContentAuditConfig {
65
+ asAt: number;
66
+ columns: ObjectColumnConfig[];
67
+ commentLineCount: number;
68
+ emptyLineCount: number;
69
+ invalidFieldLengthCount: number;
70
+ duration: number;
71
+ lineCount: number;
72
+ recordCount: number;
73
+ }
74
+ /**
75
+ * Data view relationships audit configuration.
76
+ */
77
+ interface RelationshipsAuditConfig {
78
+ placeholder: string;
79
+ }
80
+ /**
81
+ *
82
+ */
83
+ type DataFormatId = 'dpe' | 'dtv' | 'json' | 'spss' | 'xlsx' | 'xml' | 'unknown';
84
+ /**
85
+ *
86
+ */
87
+ type RecordDelimiterId = '\n' | '\r' | '\r\n';
88
+ /**
89
+ *
90
+ */
91
+ type ValueDelimiterId = '' | ':' | ',' | '!' | '0x1E' | ';' | ' ' | '\t' | '_' | '0x1F' | '|';
92
+ /**
93
+ *
94
+ */
95
+ declare const ORDERED_VALUE_DELIMITER_IDS: ValueDelimiterId[];
96
+ /**
97
+ *
98
+ */
99
+ type ParsingRecord = ParsingResult[];
100
+ /**
101
+ *
102
+ */
103
+ interface ParsingResult {
104
+ value: string | null;
105
+ valueWasQuoted: boolean;
106
+ }
107
+ type DataTypeId = 'boolean' | 'numeric' | 'string' | 'temporal' | 'unknown';
108
+ type DataSubtypeId = NumericSubtypeId | StringSubtypeId | TemporalSubtypeId;
109
+ type NumericSubtypeId = 'bigint' | 'integer' | 'decimal';
110
+ type NumericSignId = 'negative' | 'zero' | 'positive';
111
+ type NumericUnitsId = 'currency' | 'percentage' | 'plain';
112
+ type StringSubtypeId = 'email' | 'ipv4' | 'ipv6' | 'ulid' | 'uuid' | 'url' | 'plain';
113
+ type TemporalSubtypeId = 'date' | 'dateTime' | 'time';
114
+ /**
115
+ *
116
+ */
117
+ interface InferenceSummary {
118
+ columnConfigs: ObjectColumnConfig[];
119
+ hasHeaderRow: boolean;
120
+ typedRecords: InferenceRecord[];
121
+ }
122
+ /**
123
+ *
124
+ */
125
+ type InferenceRecord = InferenceResult[];
126
+ /**
127
+ *
128
+ */
129
+ type InferenceResult = BooleanInferenceResult | NumericInferenceResult | StringInferenceResult | TemporalInferenceResult | UnknownInferenceResult;
130
+ /**
131
+ * Boolean inference result.
132
+ */
133
+ interface BooleanInferenceResult {
134
+ dataTypeId: 'boolean';
135
+ dataSubtypeId: undefined;
136
+ inputValue: string;
137
+ inputValueWasQuoted: boolean;
138
+ inferredValue: boolean;
139
+ }
140
+ /**
141
+ *
142
+ */
143
+ type NumericInferenceResult = BigIntInferenceResult | NumberInferenceResult;
144
+ /**
145
+ *
146
+ */
147
+ interface BigIntInferenceResult {
148
+ dataTypeId: 'numeric';
149
+ dataSubtypeId: 'bigint';
150
+ format: string;
151
+ inputValue: string;
152
+ inputValueWasQuoted: boolean;
153
+ inferredValue: bigint;
154
+ currencySymbolId: string | undefined;
155
+ decimalPlaces: number;
156
+ signId: NumericSignId;
157
+ unitsId: NumericUnitsId;
158
+ }
159
+ /**
160
+ *
161
+ */
162
+ interface NumberInferenceResult {
163
+ dataTypeId: 'numeric';
164
+ dataSubtypeId: 'integer' | 'decimal';
165
+ format: string;
166
+ inputValue: string;
167
+ inputValueWasQuoted: boolean;
168
+ inferredValue: number;
169
+ currencySymbolId: string | undefined;
170
+ decimalPlaces: number;
171
+ signId: NumericSignId;
172
+ unitsId: NumericUnitsId;
173
+ }
174
+ /**
175
+ * String inference result.
176
+ */
177
+ interface StringInferenceResult {
178
+ dataTypeId: 'string';
179
+ dataSubtypeId: StringSubtypeId;
180
+ format: string;
181
+ inputValue: string;
182
+ inputValueWasQuoted: boolean;
183
+ inferredValue: string;
184
+ }
185
+ /**
186
+ *
187
+ */
188
+ interface TemporalInferenceResult {
189
+ dataTypeId: 'temporal';
190
+ dataSubtypeId: TemporalSubtypeId;
191
+ format: string;
192
+ inputValue: string;
193
+ inputValueWasQuoted: boolean;
194
+ inferredValue: Date;
195
+ }
196
+ /**
197
+ *
198
+ */
199
+ interface UnknownInferenceResult {
200
+ dataTypeId: 'unknown';
201
+ dataSubtypeId: undefined;
202
+ inputValue: string | null;
203
+ inputValueWasQuoted: boolean;
204
+ inferredValue: null;
205
+ }
206
+ export { ORDERED_VALUE_DELIMITER_IDS };
207
+ export type { DataViewInterface, DataViewConfig, DataViewLocalisedConfig, PreviewConfig, ContentAuditConfig, RelationshipsAuditConfig, DataFormatId, RecordDelimiterId, ValueDelimiterId, ParsingRecord, ParsingResult, DataTypeId, // Data type.
208
+ DataSubtypeId, NumericSubtypeId, // Numeric subtype and characteristics.
209
+ NumericSignId, NumericUnitsId, StringSubtypeId, // String subtype.
210
+ TemporalSubtypeId, // Temporal subtype.
211
+ InferenceSummary, InferenceRecord, InferenceResult, BooleanInferenceResult, // Boolean.
212
+ NumericInferenceResult, // Numeric.
213
+ BigIntInferenceResult, NumberInferenceResult, StringInferenceResult, // String.
214
+ TemporalInferenceResult, // Temporal.
215
+ UnknownInferenceResult };
@@ -0,0 +1,8 @@
1
+ import { ComponentConfig } from '..';
2
+ export interface DimensionConfig extends ComponentConfig {
3
+ placeholder?: string;
4
+ }
5
+ export type DimensionLocalisedConfig = Omit<DimensionConfig, 'label' | 'description'> & {
6
+ label: string;
7
+ description: string;
8
+ };
@@ -0,0 +1,8 @@
1
+ import { ComponentConfig } from '..';
2
+ export interface EventQueryConfig extends ComponentConfig {
3
+ placeholder?: string;
4
+ }
5
+ export type EventQueryLocalisedConfig = Omit<EventQueryConfig, 'label' | 'description'> & {
6
+ label: string;
7
+ description: string;
8
+ };
@@ -0,0 +1,15 @@
1
+ import { InferOutput } from 'valibot';
2
+ import { componentConfigSchema, componentReferenceSchema, componentStatusSchema } from './componentConfig.schema';
3
+ import { LocaleCode } from '../locale';
4
+ /** Component. */
5
+ interface Component {
6
+ readonly config: ComponentConfig;
7
+ }
8
+ type ComponentConfig = InferOutput<typeof componentConfigSchema>;
9
+ type ComponentReference = InferOutput<typeof componentReferenceSchema>;
10
+ type ComponentStatus = InferOutput<typeof componentStatusSchema>;
11
+ declare function getComponentStatus(id: string, localeId?: LocaleCode): ComponentStatus;
12
+ export { getComponentStatus };
13
+ export { componentConfigSchema } from './componentConfig.schema';
14
+ export type { Component, ComponentConfig, ComponentReference };
15
+ export type { ModuleConfig, ModuleTypeId } from './module';
@@ -0,0 +1,7 @@
1
+ import { InferOutput } from 'valibot';
2
+ import { moduleConfigSchema, moduleTypeIdSchema } from './moduleConfig.schema';
3
+ /** Module configuration. */
4
+ type ModuleConfig = InferOutput<typeof moduleConfigSchema>;
5
+ /** Module type identifier. */
6
+ type ModuleTypeId = InferOutput<typeof moduleTypeIdSchema>;
7
+ export type { ModuleConfig, ModuleTypeId };
@@ -0,0 +1,67 @@
1
+ /**
2
+ * Module configuration schema.
3
+ */
4
+ /**
5
+ *
6
+ */
7
+ declare const moduleTypeIdSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"app", undefined>, import('valibot').LiteralSchema<"engine", undefined>, import('valibot').LiteralSchema<"connector", undefined>, import('valibot').LiteralSchema<"context", undefined>, import('valibot').LiteralSchema<"presenter", undefined>, import('valibot').LiteralSchema<"tool", undefined>], undefined>;
8
+ /**
9
+ *
10
+ */
11
+ declare const moduleConfigCoreFields: {
12
+ readonly version: import('valibot').StringSchema<undefined>;
13
+ readonly id: import('valibot').StringSchema<undefined>;
14
+ readonly label: import('valibot').ObjectSchema<{
15
+ readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
16
+ readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
17
+ readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
18
+ readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
19
+ }, undefined>;
20
+ readonly description: import('valibot').ObjectSchema<{
21
+ readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
22
+ readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
23
+ readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
24
+ readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
25
+ }, undefined>;
26
+ readonly firstCreatedAt: import('valibot').OptionalSchema<import('valibot').NumberSchema<undefined>, undefined>;
27
+ readonly icon: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
28
+ readonly iconDark: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
29
+ readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
30
+ readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
31
+ readonly id: import('valibot').StringSchema<undefined>;
32
+ 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>;
33
+ readonly label: import('valibot').StringSchema<undefined>;
34
+ }, undefined>, undefined>;
35
+ 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>;
36
+ };
37
+ /**
38
+ *
39
+ */
40
+ declare const moduleConfigSchema: import('valibot').ObjectSchema<{
41
+ readonly typeId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"app", undefined>, import('valibot').LiteralSchema<"engine", undefined>, import('valibot').LiteralSchema<"connector", undefined>, import('valibot').LiteralSchema<"context", undefined>, import('valibot').LiteralSchema<"presenter", undefined>, import('valibot').LiteralSchema<"tool", undefined>], undefined>;
42
+ readonly version: import('valibot').StringSchema<undefined>;
43
+ readonly id: import('valibot').StringSchema<undefined>;
44
+ readonly label: import('valibot').ObjectSchema<{
45
+ readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
46
+ readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
47
+ readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
48
+ readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
49
+ }, undefined>;
50
+ readonly description: import('valibot').ObjectSchema<{
51
+ readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
52
+ readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
53
+ readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
54
+ readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
55
+ }, undefined>;
56
+ readonly firstCreatedAt: import('valibot').OptionalSchema<import('valibot').NumberSchema<undefined>, undefined>;
57
+ readonly icon: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
58
+ readonly iconDark: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
59
+ readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
60
+ readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
61
+ readonly id: import('valibot').StringSchema<undefined>;
62
+ 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>;
63
+ readonly label: import('valibot').StringSchema<undefined>;
64
+ }, undefined>, undefined>;
65
+ 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>;
66
+ }, undefined>;
67
+ export { moduleConfigCoreFields, moduleConfigSchema, moduleTypeIdSchema };
@@ -0,0 +1,22 @@
1
+ import { ModuleConfig } from '../module';
2
+ import { Component, ComponentReference } from '..';
3
+ /**
4
+ * Presenter composables, constants, errors, types/interfaces and utilities.
5
+ */
6
+ export { presenterConfigSchema } from './presenterConfig.schema';
7
+ export interface Presenter extends Component {
8
+ readonly config: PresenterConfig;
9
+ list(): ComponentReference[];
10
+ render(presentationPath: string, renderTo: HTMLElement, data?: unknown): Promise<void>;
11
+ setColorMode(colorModeId: string): void;
12
+ }
13
+ export interface PresenterConfig extends ModuleConfig {
14
+ presentations: ComponentReference[];
15
+ operations: PresenterOperation[];
16
+ typeId: 'presenter';
17
+ }
18
+ export type PresenterOperation = 'list' | 'render' | 'setColorMode';
19
+ export type PresenterLocalisedConfig = Omit<PresenterConfig, 'label' | 'description'> & {
20
+ label: string;
21
+ description: string;
22
+ };
@@ -0,0 +1,77 @@
1
+ import { InferOutput } from 'valibot';
2
+ import { ComponentConfig } from '..';
3
+ import { presenterConfigSchema } from './presenterConfig.schema';
4
+ export type PresentationConfig = InferOutput<typeof presenterConfigSchema>;
5
+ export interface PresentationConfig1 extends ComponentConfig {
6
+ content: string;
7
+ order: number;
8
+ }
9
+ export interface PresentationVisualConfig {
10
+ content: PresentationVisualContentConfig;
11
+ views: PresentationVisualViewConfig[];
12
+ }
13
+ export interface PresentationVisualContentConfig {
14
+ title?: {
15
+ text: string;
16
+ };
17
+ data: {
18
+ label?: {
19
+ text: string;
20
+ };
21
+ dimension: {
22
+ label?: {
23
+ text: string;
24
+ };
25
+ values: {
26
+ label?: {
27
+ text: string;
28
+ };
29
+ }[];
30
+ };
31
+ measures: {
32
+ id: string;
33
+ name: string;
34
+ values: number[][];
35
+ }[];
36
+ };
37
+ }
38
+ export interface PresentationVisualViewConfig {
39
+ categoryId: PresentationCategoryId;
40
+ default?: boolean;
41
+ }
42
+ export type PresentationCategoryId = 'cartesianChart' | 'chordDiagram' | 'periodFlowBoundariesChart' | 'polarChart' | 'rangeChart' | 'sankeyDiagram' | 'streamGraph' | 'valueTable';
43
+ export interface PresentationVisualCartesianChartViewConfig extends PresentationVisualViewConfig {
44
+ categoryId: 'cartesianChart';
45
+ typeId: PresentationCartesianTypeId;
46
+ }
47
+ export type PresentationCartesianTypeId = 'areaLine' | 'areaSpline' | 'bar' | 'column' | 'line' | 'spline';
48
+ export interface PresentationVisualChordDiagramViewConfig extends PresentationVisualViewConfig {
49
+ categoryId: 'chordDiagram';
50
+ }
51
+ export interface PresentationVisualPeriodFlowBoundariesChartViewConfig extends PresentationVisualViewConfig {
52
+ categoryId: 'periodFlowBoundariesChart';
53
+ }
54
+ export interface PresentationVisualPolarChartViewConfig extends PresentationVisualViewConfig {
55
+ categoryId: 'polarChart';
56
+ typeId: PresentationPolarTypeId;
57
+ }
58
+ export type PresentationPolarTypeId = 'areaLine' | 'areaRange' | 'areaSpline' | 'column' | 'columnRange' | 'line' | 'spline';
59
+ export interface PresentationVisualRangeChartViewConfig extends PresentationVisualViewConfig {
60
+ categoryId: 'rangeChart';
61
+ typeId: PresentationRangeTypeId;
62
+ }
63
+ export type PresentationRangeTypeId = 'areaLine' | 'areaSpline' | 'bar' | 'column';
64
+ export interface PresentationVisualSankeyDiagramViewConfig extends PresentationVisualViewConfig {
65
+ categoryId: 'sankeyDiagram';
66
+ }
67
+ export interface PresentationVisualStreamGraphViewConfig extends PresentationVisualViewConfig {
68
+ categoryId: 'streamGraph';
69
+ }
70
+ export interface PresentationVisualValueTableViewConfig extends PresentationVisualViewConfig {
71
+ categoryId: 'valueTable';
72
+ }
73
+ export interface PresentationView {
74
+ resize: () => void;
75
+ vendorId: string;
76
+ }
77
+ export { presenterConfigSchema } from './presenterConfig.schema';