@gooddata/sdk-backend-spi 10.5.0-alpha.11 → 10.5.0-alpha.13

package/esm/sdk-backend-spi.d.ts

@@ -1752,7 +1752,7 @@ export declare type IExplainResult = {
 };
 
 /**
- * Configuration for exports of results into XLSX or CSV.
+ * Configuration for exports of results into tabular formats.
  *
  * @public
  */
@@ -1771,19 +1771,30 @@ export declare interface IExportConfig {
      */
     mergeHeaders?: boolean;
     /**
-     * Applicable for XLSX format; specifies filters to include as comments / metadata in
+     * Applicable for XLSX, and PDF format; specifies filters to include as comments / metadata in
      * the Excel sheet.
      *
      * @remarks
      * Filters provided here are purely to paint a better context for the
-     * person looking at the XLSX file. They serve no other purpose and are merely serialized
-     * into the XLSX in a human readable form.
+     * person looking at the exported file. They serve no other purpose and are merely serialized
+     * in the export in a human-readable form.
+     * The visualizationObjectId has to be provided to make this work for PDF format.
      */
     showFilters?: boolean;
     /**
-     *  Applicable for PDF format; specifies configuration for PDF export.
+     * Applicable for PDF format; specifies configuration for PDF export.
      */
     pdfConfiguration?: IExportPdfConfig;
+    /**
+     * Visualization object identifier. Used to ensure the export result is generated based on
+     * existing visualization in the PDF document. (PDF only)
+     */
+    visualizationObjectId?: string;
+    /**
+     * Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied
+     * when visualizationObject is given. (PDF only)
+     */
+    visualizationObjectCustomFilters?: Array<IFilter>;
 }
 
 /**

package/esm/workspace/execution/export.d.ts

@@ -1,5 +1,6 @@
+import { IFilter } from "@gooddata/sdk-model";
 /**
- * Configuration for exports of results into XLSX or CSV.
+ * Configuration for exports of results into tabular formats.
  *
  * @public
  */
@@ -18,19 +19,30 @@ export interface IExportConfig {
      */
     mergeHeaders?: boolean;
     /**
-     * Applicable for XLSX format; specifies filters to include as comments / metadata in
+     * Applicable for XLSX, and PDF format; specifies filters to include as comments / metadata in
      * the Excel sheet.
      *
      * @remarks
      * Filters provided here are purely to paint a better context for the
-     * person looking at the XLSX file. They serve no other purpose and are merely serialized
-     * into the XLSX in a human readable form.
+     * person looking at the exported file. They serve no other purpose and are merely serialized
+     * in the export in a human-readable form.
+     * The visualizationObjectId has to be provided to make this work for PDF format.
      */
     showFilters?: boolean;
     /**
-     *  Applicable for PDF format; specifies configuration for PDF export.
+     * Applicable for PDF format; specifies configuration for PDF export.
      */
     pdfConfiguration?: IExportPdfConfig;
+    /**
+     * Visualization object identifier. Used to ensure the export result is generated based on
+     * existing visualization in the PDF document. (PDF only)
+     */
+    visualizationObjectId?: string;
+    /**
+     * Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied
+     * when visualizationObject is given. (PDF only)
+     */
+    visualizationObjectCustomFilters?: Array<IFilter>;
 }
 /**
  * Configuration for PDF export.

package/esm/workspace/execution/export.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../../../src/workspace/execution/export.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAExC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,oCAAoC;IACpC,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC1B,qDAAqD;IACrD,GAAG,EAAE,MAAM,CAAC;IACZ,kEAAkE;IAClE,SAAS,EAAE,MAAM,CAAC;IAClB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB"}
+{"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../../../src/workspace/execution/export.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAExC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,gCAAgC,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CACrD;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,oCAAoC;IACpC,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC1B,qDAAqD;IACrD,GAAG,EAAE,MAAM,CAAC;IACZ,kEAAkE;IAClE,SAAS,EAAE,MAAM,CAAC;IAClB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-backend-spi",
-  "version": "10.5.0-alpha.11",
+  "version": "10.5.0-alpha.13",
   "author": "GoodData",
   "description": "GoodData Backend SPI abstraction interfaces",
   "repository": {
@@ -24,7 +24,7 @@
     "lodash": "^4.17.21",
     "ts-invariant": "^0.7.5",
     "tslib": "^2.5.0",
-    "@gooddata/sdk-model": "10.5.0-alpha.11"
+    "@gooddata/sdk-model": "10.5.0-alpha.13"
   },
   "devDependencies": {
     "@gooddata/eslint-config": "^4.1.0",