@gooddata/sdk-model 11.64.0-alpha.1 → 11.64.0-alpha.3

package/esm/customApplicationSettings/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Setting that an application stores in a workspace.
+ *
+ * @alpha
+ */
+export interface ICustomApplicationSetting {
+    id: string;
+    /**
+     * Name of the application that owns the setting.
+     */
+    applicationName: string;
+    /**
+     * Content of the setting. The application defines its structure.
+     */
+    content: {
+        [key: string]: unknown;
+    };
+}
+//# sourceMappingURL=index.d.ts.map

package/esm/customApplicationSettings/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/customApplicationSettings/index.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC"}

package/esm/customApplicationSettings/index.js

@@ -0,0 +1,2 @@
+// (C) 2026 GoodData Corporation
+export {};

package/esm/dataFilter/index.d.ts

@@ -12,6 +12,7 @@ export interface IWorkspaceDataFilter {
     id: string;
     ref: ObjRef;
     title?: string;
+    description?: string;
     columnName?: string;
     settings: IWorkspaceDataFilterSetting[];
     isInherited: boolean;
@@ -28,9 +29,25 @@ export interface IWorkspaceDataFilterSetting {
     id: string;
     ref: ObjRef;
     title?: string;
+    description?: string;
     filterValues: string[];
     isInherited: boolean;
 }
+/**
+ * Entity that contains data necessary to create a new Workspace Data Filter setting
+ *
+ * @alpha
+ */
+export interface IWorkspaceDataFilterSettingDefinition {
+    /**
+     * Identifier of the new setting. A random identifier is used when it is not set.
+     */
+    id?: string;
+    dataFilter: ObjRef;
+    title?: string;
+    description?: string;
+    filterValues: string[];
+}
 /**
  * Entity that contains data necessary to create a new Workspace Data Filter
  *
@@ -39,6 +56,7 @@ export interface IWorkspaceDataFilterSetting {
 export interface IWorkspaceDataFilterDefinition {
     id?: string;
     title: string;
+    description?: string;
     columnName: string;
 }
 /**

package/esm/dataFilter/index.d.ts.map

@@ -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"}
+{"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"}

package/esm/dataSources/files.d.ts

@@ -0,0 +1,278 @@
+/**
+ * Format of a file stored in a data source that keeps its data in files.
+ *
+ * @alpha
+ */
+export type DataSourceFileType = "CSV" | "SAV";
+/**
+ * File stored in a data source that keeps its data in files, for example a CSV data source.
+ *
+ * @alpha
+ */
+export interface IDataSourceFile {
+    name: string;
+    /**
+     * Size of the file in bytes.
+     */
+    size: number;
+    /**
+     * Date and time of the last change, as an ISO-8601 string.
+     */
+    modifiedAt: string;
+    type: DataSourceFileType;
+}
+/**
+ * Type of a CSV column that the backend uses when it converts the CSV data.
+ *
+ * @alpha
+ */
+export interface ICsvColumnType {
+    name?: string;
+    type?: string;
+    nullable?: boolean;
+}
+/**
+ * Options that control how the backend converts values of CSV columns.
+ *
+ * @alpha
+ */
+export interface ICsvConvertOptions {
+    autoDictEncode?: boolean;
+    autoDictMaxCardinality?: number;
+    checkUtf8?: boolean;
+    columnTypes?: ICsvColumnType[];
+    decimalPoint?: string;
+    falseValues?: string[];
+    includeColumns?: string[];
+    includeMissingColumns?: boolean;
+    nullValues?: string[];
+    quotedStringsCanBeNull?: boolean;
+    stringsCanBeNull?: boolean;
+    timestampParsers?: string[];
+    trueValues?: string[];
+}
+/**
+ * Options that control how the backend parses a CSV file.
+ *
+ * @alpha
+ */
+export interface ICsvParseOptions {
+    delimiter?: string;
+    doubleQuote?: boolean;
+    /**
+     * Escape character, or `false` when the file does not use escaping.
+     */
+    escapeChar?: string | false;
+    ignoreEmptyLines?: boolean;
+    newlinesInValues?: boolean;
+    /**
+     * Quote character, or `false` when the file does not use quoting.
+     */
+    quoteChar?: string | false;
+}
+/**
+ * Options that control how the backend reads a CSV file.
+ *
+ * @alpha
+ */
+export interface ICsvReadOptions {
+    autoGenerateColumnNames?: boolean;
+    blockSize?: number;
+    columnNames?: string[];
+    encoding?: string;
+    skipRows?: number;
+    skipRowsAfterNames?: number;
+    useThreads?: boolean;
+}
+/**
+ * Options that the backend uses to read, parse and convert a CSV file.
+ *
+ * @alpha
+ */
+export interface ICsvFileConfig {
+    convertOptions?: ICsvConvertOptions;
+    parseOptions?: ICsvParseOptions;
+    readOptions?: ICsvReadOptions;
+}
+/**
+ * Request to analyze a CSV file that is uploaded to the staging area.
+ *
+ * @alpha
+ */
+export interface ICsvAnalysisRequest {
+    /**
+     * Location of the uploaded file, as returned by the upload.
+     */
+    location: string;
+    config?: {
+        delimiters?: string[];
+        headerDetectMaxRows?: number;
+        /**
+         * Number of header rows. When not set, the backend detects the header.
+         */
+        headerRowCount?: number;
+        /**
+         * Number of rows to return in the preview data.
+         */
+        resultRows?: number;
+    };
+}
+/**
+ * Column of an analyzed CSV file.
+ *
+ * @alpha
+ */
+export interface ICsvAnalysisColumn {
+    name: string;
+    /**
+     * Data type that the backend detected for the column.
+     */
+    type: string;
+    detectedDateFormats?: string[];
+}
+/**
+ * Result of a CSV file analysis.
+ *
+ * @alpha
+ */
+export interface ICsvAnalysis {
+    location: string;
+    columns: ICsvAnalysisColumn[];
+    /**
+     * Options that the backend detected for the file. Use them to import the file.
+     */
+    config?: ICsvFileConfig;
+    /**
+     * First rows of the file.
+     */
+    previewData: unknown[][];
+}
+/**
+ * Table to create from a CSV file that is uploaded to the staging area.
+ *
+ * @alpha
+ */
+export interface ICsvImportTable {
+    /**
+     * Name of the table in the data source.
+     */
+    name: string;
+    source: {
+        /**
+         * Location of the uploaded file, as returned by the upload.
+         */
+        location: string;
+        config: ICsvFileConfig & {
+            /**
+             * Date format of each date column, by column name.
+             */
+            columnDateFormats?: Record<string, string>;
+        };
+    };
+}
+/**
+ * Table that the backend created or updated from a CSV file.
+ *
+ * @alpha
+ */
+export interface ICsvImportResult {
+    name: string;
+    version: number;
+}
+/**
+ * Options that the backend used when it imported a CSV file into a data source.
+ *
+ * @alpha
+ */
+export interface ICsvFileManifest {
+    /**
+     * Name of the file in the data source.
+     */
+    name: string;
+    version: number;
+    readMethod?: string;
+    readOptions?: ICsvReadOptions;
+    parseOptions?: ICsvParseOptions;
+    convertOptions?: ICsvConvertOptions;
+    /**
+     * Date format of each date column, by column name.
+     */
+    columnDateFormats?: Record<string, string>;
+}
+/**
+ * SPSS (.sav) file in the staging area to analyze.
+ *
+ * @alpha
+ */
+export interface ISavAnalysisRequest {
+    /**
+     * Location of the uploaded file, as returned by the upload.
+     */
+    location: string;
+    config?: {
+        /**
+         * Number of rows in the preview data.
+         */
+        resultRows?: number;
+    };
+}
+/**
+ * Label of one value of an SPSS column.
+ *
+ * @alpha
+ */
+export interface ISavValueLabel {
+    value: unknown;
+    label: string;
+}
+/**
+ * Column of an analyzed SPSS (.sav) file.
+ *
+ * @alpha
+ */
+export interface ISavAnalysisColumn {
+    name: string;
+    /**
+     * Arrow type name of the column, for example "float64" or "date32[day]".
+     */
+    type: string;
+    label?: string;
+    valueLabels?: ISavValueLabel[];
+}
+/**
+ * Result of the analysis of an SPSS (.sav) file.
+ *
+ * @alpha
+ */
+export interface ISavAnalysis {
+    location: string;
+    columns: ISavAnalysisColumn[];
+    previewData: unknown[][];
+}
+/**
+ * Table to create or update from an SPSS (.sav) file.
+ *
+ * @alpha
+ */
+export interface ISavImportTable {
+    /**
+     * Name of the table in the data source.
+     */
+    name: string;
+    source: {
+        /**
+         * Location of the uploaded file, as returned by the upload.
+         */
+        location: string;
+    };
+}
+/**
+ * Table that the backend created or updated from an SPSS (.sav) file.
+ *
+ * @alpha
+ */
+export interface ISavImportResult {
+    name: string;
+    version: number;
+}
+//# sourceMappingURL=files.d.ts.map

package/esm/dataSources/files.d.ts.map

@@ -0,0 +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"}

package/esm/dataSources/files.js

@@ -0,0 +1,2 @@
+// (C) 2026 GoodData Corporation
+export {};

package/esm/dataSources/index.d.ts

@@ -11,4 +11,202 @@ export interface IDataSourceIdentifierDescriptor {
     schema: string;
     type: DataSourceType;
 }
+/**
+ * Permission of the current user to a data source.
+ *
+ * @alpha
+ */
+export type DataSourceUserPermission = "MANAGE" | "USE";
+/**
+ * Strategy that the backend uses to cache results of a data source.
+ *
+ * @alpha
+ */
+export type DataSourceCacheStrategy = "ALWAYS" | "NEVER";
+/**
+ * Determines how the backend interprets date and time values of a data source.
+ *
+ * @alpha
+ */
+export type DataSourceDateTimeSemantics = "LOCAL" | "UTC";
+/**
+ * Method that the backend uses to authenticate to a data source.
+ *
+ * @alpha
+ */
+export type DataSourceAuthenticationType = "USERNAME_PASSWORD" | "TOKEN" | "KEY_PAIR" | "CLIENT_SECRET" | "OIDC_PASSTHROUGH";
+/**
+ * Additional connection parameter of a data source.
+ *
+ * @alpha
+ */
+export interface IDataSourceParameter {
+    name: string;
+    value: string;
+}
+/**
+ * Cached results of the data source never expire on their own.
+ *
+ * @alpha
+ */
+export interface IDataSourceIndefiniteCacheRetention {
+    type: "INDEFINITE";
+}
+/**
+ * Cached results of the data source expire according to a cron schedule.
+ *
+ * @alpha
+ */
+export interface IDataSourceScheduleCacheRetention {
+    type: "SCHEDULE";
+    schedule: {
+        cron: string;
+        timezone?: string | null;
+    };
+}
+/**
+ * Cached results of the data source expire when the validity period elapses.
+ *
+ * @alpha
+ */
+export interface IDataSourceValidityPeriodCacheRetention {
+    type: "VALIDITY_PERIOD";
+    /**
+     * ISO-8601 duration, for example `PT1H`.
+     */
+    validityPeriod: string;
+}
+/**
+ * Determines when the cached results of a data source expire. Narrow it by the `type` property.
+ *
+ * @alpha
+ */
+export type DataSourceCacheRetention = IDataSourceIndefiniteCacheRetention | IDataSourceScheduleCacheRetention | IDataSourceValidityPeriodCacheRetention;
+/**
+ * Data source with its connection details. Secrets, such as passwords or tokens, are never included.
+ *
+ * @alpha
+ */
+export interface IDataSourceDescriptor extends IDataSourceIdentifierDescriptor {
+    username?: string;
+    clientId?: string;
+    url?: string | null;
+    permissions?: DataSourceUserPermission[];
+    parameters?: IDataSourceParameter[] | null;
+    decodedParameters?: IDataSourceParameter[] | null;
+    cacheStrategy?: DataSourceCacheStrategy | null;
+    cacheRetention?: DataSourceCacheRetention | null;
+    authenticationType?: DataSourceAuthenticationType | null;
+    dateTimeSemantics?: DataSourceDateTimeSemantics | null;
+    /**
+     * Identifier of the data source that the backend uses instead of this one.
+     */
+    alternativeDataSourceId?: string | null;
+    disableStatistics?: boolean | null;
+    /**
+     * Skip the audience check of JWT tokens in the OIDC authentication.
+     */
+    ignoreJwtAud?: boolean | null;
+}
+/**
+ * Full definition of a data source used to create it or to replace it.
+ *
+ * @alpha
+ */
+export interface IDataSourceDefinition {
+    id: string;
+    name: string;
+    schema: string;
+    type: DataSourceType;
+    url?: string;
+    username?: string;
+    password?: string;
+    token?: string;
+    parameters?: IDataSourceParameter[];
+    cacheStrategy?: DataSourceCacheStrategy;
+    /**
+     * Use `null` to remove the cache retention policy of the data source.
+     */
+    cacheRetention?: DataSourceCacheRetention | null;
+    privateKey?: string;
+    privateKeyPassphrase?: string;
+    clientId?: string;
+    clientSecret?: string;
+    dateTimeSemantics?: DataSourceDateTimeSemantics | null;
+    authenticationType?: DataSourceAuthenticationType | null;
+    /**
+     * Identifier of the data source that the backend uses instead of this one.
+     */
+    alternativeDataSourceId?: string | null;
+    disableStatistics?: boolean | null;
+    /**
+     * Skip the audience check of JWT tokens in the OIDC authentication.
+     */
+    ignoreJwtAud?: boolean | null;
+}
+/**
+ * Partial update of a data source. Properties that are `undefined` keep their current value.
+ * Use `null` to remove a value.
+ *
+ * @alpha
+ */
+export interface IDataSourcePatch {
+    id: string;
+    name?: string;
+    schema?: string;
+    type?: DataSourceType;
+    url?: string | null;
+    username?: string | null;
+    password?: string | null;
+    token?: string | null;
+    parameters?: IDataSourceParameter[] | null;
+    cacheStrategy?: DataSourceCacheStrategy | null;
+    cacheRetention?: DataSourceCacheRetention | null;
+    privateKey?: string | null;
+    privateKeyPassphrase?: string | null;
+    clientId?: string | null;
+    clientSecret?: string | null;
+    dateTimeSemantics?: DataSourceDateTimeSemantics | null;
+    authenticationType?: DataSourceAuthenticationType | null;
+    /**
+     * Identifier of the data source that the backend uses instead of this one.
+     */
+    alternativeDataSourceId?: string | null;
+    disableStatistics?: boolean | null;
+    /**
+     * Skip the audience check of JWT tokens in the OIDC authentication.
+     */
+    ignoreJwtAud?: boolean | null;
+}
+/**
+ * Connection details of a data source to test, before or after the data source is saved.
+ *
+ * @alpha
+ */
+export interface IDataSourceConnectionTest {
+    type: DataSourceType;
+    url: string;
+    schema: string;
+    username?: string;
+    password?: string;
+    token?: string;
+    parameters?: IDataSourceParameter[];
+    privateKey?: string;
+    privateKeyPassphrase?: string;
+    clientId?: string;
+    clientSecret?: string;
+    authenticationType?: DataSourceAuthenticationType | null;
+}
+/**
+ * Result of a data source connection test.
+ *
+ * @alpha
+ */
+export interface IDataSourceConnectionTestResult {
+    successful: boolean;
+    /**
+     * Reason of the failure, when the test is not successful.
+     */
+    error?: string;
+}
 //# sourceMappingURL=index.d.ts.map

package/esm/dataSources/index.d.ts.map

@@ -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"}
+{"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"}