Merge pull request #5047 from gooddata/xsh-997-pdf-export-config-adju…

…stments feat: pdf export function adjustments to support pdf options
gooddata · Jun 21, 2024 · 1ac2429 · 1ac2429
2 parents 713a62d + cc7e8ed
commit 1ac2429
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 5 deletions.
diff --git a/.../changes/@gooddata/sdk-ui-all/xsh-997-pdf-export-config-adjustments_2024-06-21-14-34.json b/.../changes/@gooddata/sdk-ui-all/xsh-997-pdf-export-config-adjustments_2024-06-21-14-34.json
@@ -0,0 +1,10 @@
+{
+    "changes": [
+        {
+            "packageName": "@gooddata/sdk-ui-all",
+            "comment": "Adjusted export function to support pdf options.",
+            "type": "none"
+        }
+    ],
+    "packageName": "@gooddata/sdk-ui-all"
+}
diff --git a/libs/sdk-backend-spi/api/sdk-backend-spi.api.md b/libs/sdk-backend-spi/api/sdk-backend-spi.api.md
@@ -612,8 +612,9 @@ export type IExportDefinitionsQueryResult = IPagedResource<IExportDefinition>;
 
 // @public
 export interface IExportPdfConfig {
-    // (undocumented)
-    orientation: "portrait" | "landscape";
+    pdfPageSize?: string;
+    pdfTopLeftContent?: string;
+    pdfTopRightContent?: string;
 }
 
 // @public

diff --git a/libs/sdk-backend-spi/src/workspace/execution/export.ts b/libs/sdk-backend-spi/src/workspace/execution/export.ts
@@ -45,7 +45,12 @@ export interface IExportConfig {
  * @public
  */
 export interface IExportPdfConfig {
-    orientation: "portrait" | "landscape";
+    /** Page size and orientation (e.g. 'a4 landscape'). */
+    pdfPageSize?: string;
+    /** PDF top left header content. */
+    pdfTopLeftContent?: string;
+    /** PDF top right header content. */
+    pdfTopRightContent?: string;
 }
 
 /**

diff --git a/libs/sdk-backend-tiger/src/backend/workspace/execution/executionResult.ts b/libs/sdk-backend-tiger/src/backend/workspace/execution/executionResult.ts
@@ -7,6 +7,7 @@ import {
     ActionsApiGetTabularExportRequest,
     TabularExportRequest,
     TabularExportRequestFormatEnum,
+    Settings,
 } from "@gooddata/api-client-tiger";
 import {
     IDataView,
@@ -208,11 +209,18 @@ export class TigerExecutionResult implements IExecutionResult {
             ? TabularExportRequestFormatEnum[uppercaseFormat]
             : TabularExportRequestFormatEnum.CSV;
 
-        const settings = {
+        const settings: Settings = {
             ...(format === TabularExportRequestFormatEnum.XLSX
                 ? { mergeHeaders: Boolean(options.mergeHeaders), showFilters: Boolean(options.showFilters) }
                 : {}),
-            ...(format === TabularExportRequestFormatEnum.PDF ? options.pdfConfiguration : {}),
+            ...(format === TabularExportRequestFormatEnum.PDF
+                ? {
+                      showFilters: Boolean(options.showFilters),
+                      pdfPageSize: options.pdfConfiguration?.pdfPageSize,
+                      pdfTopLeftContent: options.pdfConfiguration?.pdfTopLeftContent,
+                      pdfTopRightContent: options.pdfConfiguration?.pdfTopRightContent,
+                  }
+                : {}),
         };
 
         const payload: TabularExportRequest = {