@3e/sqa-common 6.24.0-2 → 6.24.0-4

package/index.d.ts

@@ -35,6 +35,8 @@ import {
   PacoViewParameters,
   Parameter,
   ShortLDTypeValue,
+  SaveDataArguments,
+  ViewExportFormat
 } from './types'
 
 /**
@@ -524,6 +526,8 @@ declare module '@3e/sqa-common' {
      *
      * @param visualization - The visualization to be saved in a .csv format
      * @param filename - the name of the csv.zip file to be downloaded
+     * @param format - the format of the file to be downloaded. Default is *text/csv*
+     * @param compression - the compression used for export. Default is "zip"
      *
      * @throws An error in case the provided parameters were incorrect. Wrap the
      * request inside a `try-catch` block
@@ -531,7 +535,16 @@ declare module '@3e/sqa-common' {
     createSaveDataJob(
       visualization: Visualization,
       filename: string,
-    ): Promise<string>
+      format?: ViewExportFormat,
+      compression?: "none" | "zip"): Promise<string>
+
+    /**
+     * Extract arguments to create a `save_data` job for a view
+     * @param view - the view to save data for
+     * @param filename - the name of the export file. Defaults to the view title
+     */
+    viewToSaveDataArguments(view: SQView): Promise<SaveDataArguments>
+    viewToSaveDataArguments(view: SQView, filename: string): Promise<SaveDataArguments>
 
     /**
      * Used for polling the SQA API for the job status.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@3e/sqa-common",
-  "version": "6.24.0-2",
+  "version": "6.24.0-4",
   "description": "SynaptiQ utilities package",
   "main": "sqa_common.js",
   "dependencies": {