@gooddata/sdk-model 11.64.0-alpha.0 → 11.64.0-alpha.2
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/esm/apiTokens/index.d.ts +20 -0
- package/esm/apiTokens/index.d.ts.map +1 -0
- package/esm/apiTokens/index.js +2 -0
- package/esm/cspDirectives/index.d.ts +16 -0
- package/esm/cspDirectives/index.d.ts.map +1 -0
- package/esm/cspDirectives/index.js +2 -0
- package/esm/dataFilter/index.d.ts +18 -0
- package/esm/dataFilter/index.d.ts.map +1 -1
- package/esm/dataSources/files.d.ts +278 -0
- package/esm/dataSources/files.d.ts.map +1 -0
- package/esm/dataSources/files.js +2 -0
- package/esm/dataSources/index.d.ts +198 -0
- package/esm/dataSources/index.d.ts.map +1 -1
- package/esm/genAI/clarifyingQuestions.d.ts +38 -0
- package/esm/genAI/clarifyingQuestions.d.ts.map +1 -1
- package/esm/index.d.ts +8 -4
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +1 -0
- package/esm/organization/index.d.ts +43 -0
- package/esm/organization/index.d.ts.map +1 -1
- package/esm/publisher/v2/imageSource.d.ts +39 -0
- package/esm/publisher/v2/imageSource.d.ts.map +1 -0
- package/esm/publisher/v2/imageSource.js +43 -0
- package/esm/sdk-model.d.ts +696 -0
- package/esm/settings/settings.d.ts +6 -0
- package/esm/settings/settings.d.ts.map +1 -1
- package/package.json +3 -3
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* API token of a user.
|
|
3
|
+
*
|
|
4
|
+
* @alpha
|
|
5
|
+
*/
|
|
6
|
+
export interface IApiToken {
|
|
7
|
+
id: string;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* API token returned right after it is created.
|
|
11
|
+
*
|
|
12
|
+
* @remarks
|
|
13
|
+
* The backend returns the secret only once, at creation time.
|
|
14
|
+
*
|
|
15
|
+
* @alpha
|
|
16
|
+
*/
|
|
17
|
+
export interface IApiTokenWithSecret extends IApiToken {
|
|
18
|
+
bearerToken: string;
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/apiTokens/index.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACtB,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAoB,SAAQ,SAAS;IAClD,WAAW,EAAE,MAAM,CAAC;CACvB"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Content Security Policy directive of the organization.
|
|
3
|
+
*
|
|
4
|
+
* @alpha
|
|
5
|
+
*/
|
|
6
|
+
export interface ICspDirective {
|
|
7
|
+
/**
|
|
8
|
+
* Name of the directive, for example `script-src` or `img-src`.
|
|
9
|
+
*/
|
|
10
|
+
id: string;
|
|
11
|
+
/**
|
|
12
|
+
* Sources allowed by the directive, for example `'self'`, `https://example.com` or `*.example.com`.
|
|
13
|
+
*/
|
|
14
|
+
sources: string[];
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cspDirectives/index.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;CACrB"}
|
|
@@ -12,6 +12,7 @@ export interface IWorkspaceDataFilter {
|
|
|
12
12
|
id: string;
|
|
13
13
|
ref: ObjRef;
|
|
14
14
|
title?: string;
|
|
15
|
+
description?: string;
|
|
15
16
|
columnName?: string;
|
|
16
17
|
settings: IWorkspaceDataFilterSetting[];
|
|
17
18
|
isInherited: boolean;
|
|
@@ -28,9 +29,25 @@ export interface IWorkspaceDataFilterSetting {
|
|
|
28
29
|
id: string;
|
|
29
30
|
ref: ObjRef;
|
|
30
31
|
title?: string;
|
|
32
|
+
description?: string;
|
|
31
33
|
filterValues: string[];
|
|
32
34
|
isInherited: boolean;
|
|
33
35
|
}
|
|
36
|
+
/**
|
|
37
|
+
* Entity that contains data necessary to create a new Workspace Data Filter setting
|
|
38
|
+
*
|
|
39
|
+
* @alpha
|
|
40
|
+
*/
|
|
41
|
+
export interface IWorkspaceDataFilterSettingDefinition {
|
|
42
|
+
/**
|
|
43
|
+
* Identifier of the new setting. A random identifier is used when it is not set.
|
|
44
|
+
*/
|
|
45
|
+
id?: string;
|
|
46
|
+
dataFilter: ObjRef;
|
|
47
|
+
title?: string;
|
|
48
|
+
description?: string;
|
|
49
|
+
filterValues: string[];
|
|
50
|
+
}
|
|
34
51
|
/**
|
|
35
52
|
* Entity that contains data necessary to create a new Workspace Data Filter
|
|
36
53
|
*
|
|
@@ -39,6 +56,7 @@ export interface IWorkspaceDataFilterSetting {
|
|
|
39
56
|
export interface IWorkspaceDataFilterDefinition {
|
|
40
57
|
id?: string;
|
|
41
58
|
title: string;
|
|
59
|
+
description?: string;
|
|
42
60
|
columnName: string;
|
|
43
61
|
}
|
|
44
62
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/dataFilter/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE/D;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,2BAA2B,EAAE,CAAC;IACxC,WAAW,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC3C,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,mBAAmB;IACxD,QAAQ,EAAE,KAAK,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC7D,QAAQ,EAAE,UAAU,CAAC;CACxB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG,oBAAoB,CAAC;AAEpE;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM,IAAI,eAAe,CAElF;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM,IAAI,oBAAoB,CAE5F;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC1C,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,6BAA6B;IAC5E;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA+B,SAAQ,6BAA6B;IACjF;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,yBAAyB,GAAG,8BAA8B,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/dataFilter/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE/D;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,2BAA2B,EAAE,CAAC;IACxC,WAAW,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,qCAAqC;IAClD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC3C,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,mBAAmB;IACxD,QAAQ,EAAE,KAAK,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC7D,QAAQ,EAAE,UAAU,CAAC;CACxB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG,oBAAoB,CAAC;AAEpE;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM,IAAI,eAAe,CAElF;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM,IAAI,oBAAoB,CAE5F;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC1C,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,6BAA6B;IAC5E;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA+B,SAAQ,6BAA6B;IACjF;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,yBAAyB,GAAG,8BAA8B,CAAC"}
|
|
@@ -0,0 +1,278 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Format of a file stored in a data source that keeps its data in files.
|
|
3
|
+
*
|
|
4
|
+
* @alpha
|
|
5
|
+
*/
|
|
6
|
+
export type DataSourceFileType = "CSV" | "SAV";
|
|
7
|
+
/**
|
|
8
|
+
* File stored in a data source that keeps its data in files, for example a CSV data source.
|
|
9
|
+
*
|
|
10
|
+
* @alpha
|
|
11
|
+
*/
|
|
12
|
+
export interface IDataSourceFile {
|
|
13
|
+
name: string;
|
|
14
|
+
/**
|
|
15
|
+
* Size of the file in bytes.
|
|
16
|
+
*/
|
|
17
|
+
size: number;
|
|
18
|
+
/**
|
|
19
|
+
* Date and time of the last change, as an ISO-8601 string.
|
|
20
|
+
*/
|
|
21
|
+
modifiedAt: string;
|
|
22
|
+
type: DataSourceFileType;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Type of a CSV column that the backend uses when it converts the CSV data.
|
|
26
|
+
*
|
|
27
|
+
* @alpha
|
|
28
|
+
*/
|
|
29
|
+
export interface ICsvColumnType {
|
|
30
|
+
name?: string;
|
|
31
|
+
type?: string;
|
|
32
|
+
nullable?: boolean;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Options that control how the backend converts values of CSV columns.
|
|
36
|
+
*
|
|
37
|
+
* @alpha
|
|
38
|
+
*/
|
|
39
|
+
export interface ICsvConvertOptions {
|
|
40
|
+
autoDictEncode?: boolean;
|
|
41
|
+
autoDictMaxCardinality?: number;
|
|
42
|
+
checkUtf8?: boolean;
|
|
43
|
+
columnTypes?: ICsvColumnType[];
|
|
44
|
+
decimalPoint?: string;
|
|
45
|
+
falseValues?: string[];
|
|
46
|
+
includeColumns?: string[];
|
|
47
|
+
includeMissingColumns?: boolean;
|
|
48
|
+
nullValues?: string[];
|
|
49
|
+
quotedStringsCanBeNull?: boolean;
|
|
50
|
+
stringsCanBeNull?: boolean;
|
|
51
|
+
timestampParsers?: string[];
|
|
52
|
+
trueValues?: string[];
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Options that control how the backend parses a CSV file.
|
|
56
|
+
*
|
|
57
|
+
* @alpha
|
|
58
|
+
*/
|
|
59
|
+
export interface ICsvParseOptions {
|
|
60
|
+
delimiter?: string;
|
|
61
|
+
doubleQuote?: boolean;
|
|
62
|
+
/**
|
|
63
|
+
* Escape character, or `false` when the file does not use escaping.
|
|
64
|
+
*/
|
|
65
|
+
escapeChar?: string | false;
|
|
66
|
+
ignoreEmptyLines?: boolean;
|
|
67
|
+
newlinesInValues?: boolean;
|
|
68
|
+
/**
|
|
69
|
+
* Quote character, or `false` when the file does not use quoting.
|
|
70
|
+
*/
|
|
71
|
+
quoteChar?: string | false;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Options that control how the backend reads a CSV file.
|
|
75
|
+
*
|
|
76
|
+
* @alpha
|
|
77
|
+
*/
|
|
78
|
+
export interface ICsvReadOptions {
|
|
79
|
+
autoGenerateColumnNames?: boolean;
|
|
80
|
+
blockSize?: number;
|
|
81
|
+
columnNames?: string[];
|
|
82
|
+
encoding?: string;
|
|
83
|
+
skipRows?: number;
|
|
84
|
+
skipRowsAfterNames?: number;
|
|
85
|
+
useThreads?: boolean;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Options that the backend uses to read, parse and convert a CSV file.
|
|
89
|
+
*
|
|
90
|
+
* @alpha
|
|
91
|
+
*/
|
|
92
|
+
export interface ICsvFileConfig {
|
|
93
|
+
convertOptions?: ICsvConvertOptions;
|
|
94
|
+
parseOptions?: ICsvParseOptions;
|
|
95
|
+
readOptions?: ICsvReadOptions;
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* Request to analyze a CSV file that is uploaded to the staging area.
|
|
99
|
+
*
|
|
100
|
+
* @alpha
|
|
101
|
+
*/
|
|
102
|
+
export interface ICsvAnalysisRequest {
|
|
103
|
+
/**
|
|
104
|
+
* Location of the uploaded file, as returned by the upload.
|
|
105
|
+
*/
|
|
106
|
+
location: string;
|
|
107
|
+
config?: {
|
|
108
|
+
delimiters?: string[];
|
|
109
|
+
headerDetectMaxRows?: number;
|
|
110
|
+
/**
|
|
111
|
+
* Number of header rows. When not set, the backend detects the header.
|
|
112
|
+
*/
|
|
113
|
+
headerRowCount?: number;
|
|
114
|
+
/**
|
|
115
|
+
* Number of rows to return in the preview data.
|
|
116
|
+
*/
|
|
117
|
+
resultRows?: number;
|
|
118
|
+
};
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* Column of an analyzed CSV file.
|
|
122
|
+
*
|
|
123
|
+
* @alpha
|
|
124
|
+
*/
|
|
125
|
+
export interface ICsvAnalysisColumn {
|
|
126
|
+
name: string;
|
|
127
|
+
/**
|
|
128
|
+
* Data type that the backend detected for the column.
|
|
129
|
+
*/
|
|
130
|
+
type: string;
|
|
131
|
+
detectedDateFormats?: string[];
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Result of a CSV file analysis.
|
|
135
|
+
*
|
|
136
|
+
* @alpha
|
|
137
|
+
*/
|
|
138
|
+
export interface ICsvAnalysis {
|
|
139
|
+
location: string;
|
|
140
|
+
columns: ICsvAnalysisColumn[];
|
|
141
|
+
/**
|
|
142
|
+
* Options that the backend detected for the file. Use them to import the file.
|
|
143
|
+
*/
|
|
144
|
+
config?: ICsvFileConfig;
|
|
145
|
+
/**
|
|
146
|
+
* First rows of the file.
|
|
147
|
+
*/
|
|
148
|
+
previewData: unknown[][];
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* Table to create from a CSV file that is uploaded to the staging area.
|
|
152
|
+
*
|
|
153
|
+
* @alpha
|
|
154
|
+
*/
|
|
155
|
+
export interface ICsvImportTable {
|
|
156
|
+
/**
|
|
157
|
+
* Name of the table in the data source.
|
|
158
|
+
*/
|
|
159
|
+
name: string;
|
|
160
|
+
source: {
|
|
161
|
+
/**
|
|
162
|
+
* Location of the uploaded file, as returned by the upload.
|
|
163
|
+
*/
|
|
164
|
+
location: string;
|
|
165
|
+
config: ICsvFileConfig & {
|
|
166
|
+
/**
|
|
167
|
+
* Date format of each date column, by column name.
|
|
168
|
+
*/
|
|
169
|
+
columnDateFormats?: Record<string, string>;
|
|
170
|
+
};
|
|
171
|
+
};
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Table that the backend created or updated from a CSV file.
|
|
175
|
+
*
|
|
176
|
+
* @alpha
|
|
177
|
+
*/
|
|
178
|
+
export interface ICsvImportResult {
|
|
179
|
+
name: string;
|
|
180
|
+
version: number;
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* Options that the backend used when it imported a CSV file into a data source.
|
|
184
|
+
*
|
|
185
|
+
* @alpha
|
|
186
|
+
*/
|
|
187
|
+
export interface ICsvFileManifest {
|
|
188
|
+
/**
|
|
189
|
+
* Name of the file in the data source.
|
|
190
|
+
*/
|
|
191
|
+
name: string;
|
|
192
|
+
version: number;
|
|
193
|
+
readMethod?: string;
|
|
194
|
+
readOptions?: ICsvReadOptions;
|
|
195
|
+
parseOptions?: ICsvParseOptions;
|
|
196
|
+
convertOptions?: ICsvConvertOptions;
|
|
197
|
+
/**
|
|
198
|
+
* Date format of each date column, by column name.
|
|
199
|
+
*/
|
|
200
|
+
columnDateFormats?: Record<string, string>;
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* SPSS (.sav) file in the staging area to analyze.
|
|
204
|
+
*
|
|
205
|
+
* @alpha
|
|
206
|
+
*/
|
|
207
|
+
export interface ISavAnalysisRequest {
|
|
208
|
+
/**
|
|
209
|
+
* Location of the uploaded file, as returned by the upload.
|
|
210
|
+
*/
|
|
211
|
+
location: string;
|
|
212
|
+
config?: {
|
|
213
|
+
/**
|
|
214
|
+
* Number of rows in the preview data.
|
|
215
|
+
*/
|
|
216
|
+
resultRows?: number;
|
|
217
|
+
};
|
|
218
|
+
}
|
|
219
|
+
/**
|
|
220
|
+
* Label of one value of an SPSS column.
|
|
221
|
+
*
|
|
222
|
+
* @alpha
|
|
223
|
+
*/
|
|
224
|
+
export interface ISavValueLabel {
|
|
225
|
+
value: unknown;
|
|
226
|
+
label: string;
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* Column of an analyzed SPSS (.sav) file.
|
|
230
|
+
*
|
|
231
|
+
* @alpha
|
|
232
|
+
*/
|
|
233
|
+
export interface ISavAnalysisColumn {
|
|
234
|
+
name: string;
|
|
235
|
+
/**
|
|
236
|
+
* Arrow type name of the column, for example "float64" or "date32[day]".
|
|
237
|
+
*/
|
|
238
|
+
type: string;
|
|
239
|
+
label?: string;
|
|
240
|
+
valueLabels?: ISavValueLabel[];
|
|
241
|
+
}
|
|
242
|
+
/**
|
|
243
|
+
* Result of the analysis of an SPSS (.sav) file.
|
|
244
|
+
*
|
|
245
|
+
* @alpha
|
|
246
|
+
*/
|
|
247
|
+
export interface ISavAnalysis {
|
|
248
|
+
location: string;
|
|
249
|
+
columns: ISavAnalysisColumn[];
|
|
250
|
+
previewData: unknown[][];
|
|
251
|
+
}
|
|
252
|
+
/**
|
|
253
|
+
* Table to create or update from an SPSS (.sav) file.
|
|
254
|
+
*
|
|
255
|
+
* @alpha
|
|
256
|
+
*/
|
|
257
|
+
export interface ISavImportTable {
|
|
258
|
+
/**
|
|
259
|
+
* Name of the table in the data source.
|
|
260
|
+
*/
|
|
261
|
+
name: string;
|
|
262
|
+
source: {
|
|
263
|
+
/**
|
|
264
|
+
* Location of the uploaded file, as returned by the upload.
|
|
265
|
+
*/
|
|
266
|
+
location: string;
|
|
267
|
+
};
|
|
268
|
+
}
|
|
269
|
+
/**
|
|
270
|
+
* Table that the backend created or updated from an SPSS (.sav) file.
|
|
271
|
+
*
|
|
272
|
+
* @alpha
|
|
273
|
+
*/
|
|
274
|
+
export interface ISavImportResult {
|
|
275
|
+
name: string;
|
|
276
|
+
version: number;
|
|
277
|
+
}
|
|
278
|
+
//# sourceMappingURL=files.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../src/dataSources/files.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,KAAK,CAAC;AAE/C;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,kBAAkB,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,cAAc,EAAE,CAAC;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC5B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACpC,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,WAAW,CAAC,EAAE,eAAe,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE;QACL,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;QACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB;;OAEG;IACH,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QACJ;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,cAAc,GAAG;YACrB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SAC9C,CAAC;KACL,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9C;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE;QACL;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,cAAc,EAAE,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC9B,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QACJ;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KACpB,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACnB"}
|
|
@@ -11,4 +11,202 @@ export interface IDataSourceIdentifierDescriptor {
|
|
|
11
11
|
schema: string;
|
|
12
12
|
type: DataSourceType;
|
|
13
13
|
}
|
|
14
|
+
/**
|
|
15
|
+
* Permission of the current user to a data source.
|
|
16
|
+
*
|
|
17
|
+
* @alpha
|
|
18
|
+
*/
|
|
19
|
+
export type DataSourceUserPermission = "MANAGE" | "USE";
|
|
20
|
+
/**
|
|
21
|
+
* Strategy that the backend uses to cache results of a data source.
|
|
22
|
+
*
|
|
23
|
+
* @alpha
|
|
24
|
+
*/
|
|
25
|
+
export type DataSourceCacheStrategy = "ALWAYS" | "NEVER";
|
|
26
|
+
/**
|
|
27
|
+
* Determines how the backend interprets date and time values of a data source.
|
|
28
|
+
*
|
|
29
|
+
* @alpha
|
|
30
|
+
*/
|
|
31
|
+
export type DataSourceDateTimeSemantics = "LOCAL" | "UTC";
|
|
32
|
+
/**
|
|
33
|
+
* Method that the backend uses to authenticate to a data source.
|
|
34
|
+
*
|
|
35
|
+
* @alpha
|
|
36
|
+
*/
|
|
37
|
+
export type DataSourceAuthenticationType = "USERNAME_PASSWORD" | "TOKEN" | "KEY_PAIR" | "CLIENT_SECRET" | "OIDC_PASSTHROUGH";
|
|
38
|
+
/**
|
|
39
|
+
* Additional connection parameter of a data source.
|
|
40
|
+
*
|
|
41
|
+
* @alpha
|
|
42
|
+
*/
|
|
43
|
+
export interface IDataSourceParameter {
|
|
44
|
+
name: string;
|
|
45
|
+
value: string;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Cached results of the data source never expire on their own.
|
|
49
|
+
*
|
|
50
|
+
* @alpha
|
|
51
|
+
*/
|
|
52
|
+
export interface IDataSourceIndefiniteCacheRetention {
|
|
53
|
+
type: "INDEFINITE";
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Cached results of the data source expire according to a cron schedule.
|
|
57
|
+
*
|
|
58
|
+
* @alpha
|
|
59
|
+
*/
|
|
60
|
+
export interface IDataSourceScheduleCacheRetention {
|
|
61
|
+
type: "SCHEDULE";
|
|
62
|
+
schedule: {
|
|
63
|
+
cron: string;
|
|
64
|
+
timezone?: string | null;
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Cached results of the data source expire when the validity period elapses.
|
|
69
|
+
*
|
|
70
|
+
* @alpha
|
|
71
|
+
*/
|
|
72
|
+
export interface IDataSourceValidityPeriodCacheRetention {
|
|
73
|
+
type: "VALIDITY_PERIOD";
|
|
74
|
+
/**
|
|
75
|
+
* ISO-8601 duration, for example `PT1H`.
|
|
76
|
+
*/
|
|
77
|
+
validityPeriod: string;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Determines when the cached results of a data source expire. Narrow it by the `type` property.
|
|
81
|
+
*
|
|
82
|
+
* @alpha
|
|
83
|
+
*/
|
|
84
|
+
export type DataSourceCacheRetention = IDataSourceIndefiniteCacheRetention | IDataSourceScheduleCacheRetention | IDataSourceValidityPeriodCacheRetention;
|
|
85
|
+
/**
|
|
86
|
+
* Data source with its connection details. Secrets, such as passwords or tokens, are never included.
|
|
87
|
+
*
|
|
88
|
+
* @alpha
|
|
89
|
+
*/
|
|
90
|
+
export interface IDataSourceDescriptor extends IDataSourceIdentifierDescriptor {
|
|
91
|
+
username?: string;
|
|
92
|
+
clientId?: string;
|
|
93
|
+
url?: string | null;
|
|
94
|
+
permissions?: DataSourceUserPermission[];
|
|
95
|
+
parameters?: IDataSourceParameter[] | null;
|
|
96
|
+
decodedParameters?: IDataSourceParameter[] | null;
|
|
97
|
+
cacheStrategy?: DataSourceCacheStrategy | null;
|
|
98
|
+
cacheRetention?: DataSourceCacheRetention | null;
|
|
99
|
+
authenticationType?: DataSourceAuthenticationType | null;
|
|
100
|
+
dateTimeSemantics?: DataSourceDateTimeSemantics | null;
|
|
101
|
+
/**
|
|
102
|
+
* Identifier of the data source that the backend uses instead of this one.
|
|
103
|
+
*/
|
|
104
|
+
alternativeDataSourceId?: string | null;
|
|
105
|
+
disableStatistics?: boolean | null;
|
|
106
|
+
/**
|
|
107
|
+
* Skip the audience check of JWT tokens in the OIDC authentication.
|
|
108
|
+
*/
|
|
109
|
+
ignoreJwtAud?: boolean | null;
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Full definition of a data source used to create it or to replace it.
|
|
113
|
+
*
|
|
114
|
+
* @alpha
|
|
115
|
+
*/
|
|
116
|
+
export interface IDataSourceDefinition {
|
|
117
|
+
id: string;
|
|
118
|
+
name: string;
|
|
119
|
+
schema: string;
|
|
120
|
+
type: DataSourceType;
|
|
121
|
+
url?: string;
|
|
122
|
+
username?: string;
|
|
123
|
+
password?: string;
|
|
124
|
+
token?: string;
|
|
125
|
+
parameters?: IDataSourceParameter[];
|
|
126
|
+
cacheStrategy?: DataSourceCacheStrategy;
|
|
127
|
+
/**
|
|
128
|
+
* Use `null` to remove the cache retention policy of the data source.
|
|
129
|
+
*/
|
|
130
|
+
cacheRetention?: DataSourceCacheRetention | null;
|
|
131
|
+
privateKey?: string;
|
|
132
|
+
privateKeyPassphrase?: string;
|
|
133
|
+
clientId?: string;
|
|
134
|
+
clientSecret?: string;
|
|
135
|
+
dateTimeSemantics?: DataSourceDateTimeSemantics | null;
|
|
136
|
+
authenticationType?: DataSourceAuthenticationType | null;
|
|
137
|
+
/**
|
|
138
|
+
* Identifier of the data source that the backend uses instead of this one.
|
|
139
|
+
*/
|
|
140
|
+
alternativeDataSourceId?: string | null;
|
|
141
|
+
disableStatistics?: boolean | null;
|
|
142
|
+
/**
|
|
143
|
+
* Skip the audience check of JWT tokens in the OIDC authentication.
|
|
144
|
+
*/
|
|
145
|
+
ignoreJwtAud?: boolean | null;
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* Partial update of a data source. Properties that are `undefined` keep their current value.
|
|
149
|
+
* Use `null` to remove a value.
|
|
150
|
+
*
|
|
151
|
+
* @alpha
|
|
152
|
+
*/
|
|
153
|
+
export interface IDataSourcePatch {
|
|
154
|
+
id: string;
|
|
155
|
+
name?: string;
|
|
156
|
+
schema?: string;
|
|
157
|
+
type?: DataSourceType;
|
|
158
|
+
url?: string | null;
|
|
159
|
+
username?: string | null;
|
|
160
|
+
password?: string | null;
|
|
161
|
+
token?: string | null;
|
|
162
|
+
parameters?: IDataSourceParameter[] | null;
|
|
163
|
+
cacheStrategy?: DataSourceCacheStrategy | null;
|
|
164
|
+
cacheRetention?: DataSourceCacheRetention | null;
|
|
165
|
+
privateKey?: string | null;
|
|
166
|
+
privateKeyPassphrase?: string | null;
|
|
167
|
+
clientId?: string | null;
|
|
168
|
+
clientSecret?: string | null;
|
|
169
|
+
dateTimeSemantics?: DataSourceDateTimeSemantics | null;
|
|
170
|
+
authenticationType?: DataSourceAuthenticationType | null;
|
|
171
|
+
/**
|
|
172
|
+
* Identifier of the data source that the backend uses instead of this one.
|
|
173
|
+
*/
|
|
174
|
+
alternativeDataSourceId?: string | null;
|
|
175
|
+
disableStatistics?: boolean | null;
|
|
176
|
+
/**
|
|
177
|
+
* Skip the audience check of JWT tokens in the OIDC authentication.
|
|
178
|
+
*/
|
|
179
|
+
ignoreJwtAud?: boolean | null;
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* Connection details of a data source to test, before or after the data source is saved.
|
|
183
|
+
*
|
|
184
|
+
* @alpha
|
|
185
|
+
*/
|
|
186
|
+
export interface IDataSourceConnectionTest {
|
|
187
|
+
type: DataSourceType;
|
|
188
|
+
url: string;
|
|
189
|
+
schema: string;
|
|
190
|
+
username?: string;
|
|
191
|
+
password?: string;
|
|
192
|
+
token?: string;
|
|
193
|
+
parameters?: IDataSourceParameter[];
|
|
194
|
+
privateKey?: string;
|
|
195
|
+
privateKeyPassphrase?: string;
|
|
196
|
+
clientId?: string;
|
|
197
|
+
clientSecret?: string;
|
|
198
|
+
authenticationType?: DataSourceAuthenticationType | null;
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
* Result of a data source connection test.
|
|
202
|
+
*
|
|
203
|
+
* @alpha
|
|
204
|
+
*/
|
|
205
|
+
export interface IDataSourceConnectionTestResult {
|
|
206
|
+
successful: boolean;
|
|
207
|
+
/**
|
|
208
|
+
* Reason of the failure, when the test is not successful.
|
|
209
|
+
*/
|
|
210
|
+
error?: string;
|
|
211
|
+
}
|
|
14
212
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/dataSources/index.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,cAAc,GACpB,YAAY,GACZ,UAAU,GACV,SAAS,GACT,WAAW,GACX,KAAK,GACL,UAAU,GACV,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,SAAS,GACT,OAAO,GACP,SAAS,GACT,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,aAAa,GACb,YAAY,GACZ,SAAS,GACT,aAAa,GACb,aAAa,GACb,OAAO,GACP,OAAO,CAAC;AAEd;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC5C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,cAAc,CAAC;CACxB"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/dataSources/index.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,cAAc,GACpB,YAAY,GACZ,UAAU,GACV,SAAS,GACT,WAAW,GACX,KAAK,GACL,UAAU,GACV,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,SAAS,GACT,OAAO,GACP,SAAS,GACT,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,aAAa,GACb,YAAY,GACZ,SAAS,GACT,aAAa,GACb,aAAa,GACb,OAAO,GACP,OAAO,CAAC;AAEd;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC5C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,cAAc,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,QAAQ,GAAG,KAAK,CAAC;AAExD;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEzD;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,GAAG,KAAK,CAAC;AAE1D;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAClC,mBAAmB,GACnB,OAAO,GACP,UAAU,GACV,eAAe,GACf,kBAAkB,CAAC;AAEzB;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,mCAAmC;IAChD,IAAI,EAAE,YAAY,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,iCAAiC;IAC9C,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,uCAAuC;IACpD,IAAI,EAAE,iBAAiB,CAAC;IACxB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAC9B,mCAAmC,GACnC,iCAAiC,GACjC,uCAAuC,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,+BAA+B;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,WAAW,CAAC,EAAE,wBAAwB,EAAE,CAAC;IACzC,UAAU,CAAC,EAAE,oBAAoB,EAAE,GAAG,IAAI,CAAC;IAC3C,iBAAiB,CAAC,EAAE,oBAAoB,EAAE,GAAG,IAAI,CAAC;IAClD,aAAa,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAC/C,cAAc,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IACjD,kBAAkB,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IACzD,iBAAiB,CAAC,EAAE,2BAA2B,GAAG,IAAI,CAAC;IACvD;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,iBAAiB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACnC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,cAAc,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACpC,aAAa,CAAC,EAAE,uBAAuB,CAAC;IACxC;;OAEG;IACH,cAAc,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IACjD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,2BAA2B,GAAG,IAAI,CAAC;IACvD,kBAAkB,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IACzD;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,iBAAiB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACnC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,CAAC,EAAE,oBAAoB,EAAE,GAAG,IAAI,CAAC;IAC3C,aAAa,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAC/C,cAAc,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IACjD,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,iBAAiB,CAAC,EAAE,2BAA2B,GAAG,IAAI,CAAC;IACvD,kBAAkB,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IACzD;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,iBAAiB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACnC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC,IAAI,EAAE,cAAc,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;CAC5D;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC5C,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB"}
|
|
@@ -13,6 +13,44 @@ export interface IGenAiClarifyingQuestion {
|
|
|
13
13
|
*/
|
|
14
14
|
text: string;
|
|
15
15
|
}
|
|
16
|
+
/**
|
|
17
|
+
* @alpha
|
|
18
|
+
*
|
|
19
|
+
* Represents an answer to a clarifying question for an AI chat response.
|
|
20
|
+
*/
|
|
21
|
+
export interface IGenAiClarifyingAnswer {
|
|
22
|
+
/**
|
|
23
|
+
* Selected answer definition.
|
|
24
|
+
*/
|
|
25
|
+
answer: IGenAiClarifyingAnswerItem;
|
|
26
|
+
/**
|
|
27
|
+
* Zero-based index of the question.
|
|
28
|
+
*/
|
|
29
|
+
questionIndex: number;
|
|
30
|
+
/**
|
|
31
|
+
* Text of the question as presented to the user.
|
|
32
|
+
*/
|
|
33
|
+
questionText: string;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* @alpha
|
|
37
|
+
*
|
|
38
|
+
* Represents a selected option for a clarifying answer.
|
|
39
|
+
*/
|
|
40
|
+
export interface IGenAiClarifyingAnswerItem {
|
|
41
|
+
/**
|
|
42
|
+
* Zero-based index of the selected option.
|
|
43
|
+
*/
|
|
44
|
+
optionIndex: number;
|
|
45
|
+
/**
|
|
46
|
+
* Text of the selected option as presented to the user.
|
|
47
|
+
*/
|
|
48
|
+
optionText: string;
|
|
49
|
+
/**
|
|
50
|
+
* Type of the answer.
|
|
51
|
+
*/
|
|
52
|
+
type: "singleChoice";
|
|
53
|
+
}
|
|
16
54
|
/**
|
|
17
55
|
* @alpha
|
|
18
56
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"clarifyingQuestions.d.ts","sourceRoot":"","sources":["../../src/genAI/clarifyingQuestions.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,OAAO,EAAE,yBAAyB,CAAC;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAC7C;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IACzC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CAChB"}
|
|
1
|
+
{"version":3,"file":"clarifyingQuestions.d.ts","sourceRoot":"","sources":["../../src/genAI/clarifyingQuestions.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,OAAO,EAAE,yBAAyB,CAAC;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,MAAM,EAAE,0BAA0B,CAAC;IACnC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACvC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAC7C;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IACzC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CAChB"}
|