@lightdash/common 0.1407.2 → 0.1408.0

package/dist/pivotTable/pivotQueryResults.d.ts

@@ -15,5 +15,14 @@ type PivotQueryResultsArgs = {
     getFieldLabel: FieldLabelFunction;
 };
 export declare const pivotQueryResults: ({ pivotConfig, metricQuery, rows, options, getField, getFieldLabel, }: PivotQueryResultsArgs) => PivotData;
-export declare const pivotResultsAsCsv: (pivotConfig: PivotConfig, rows: ResultRow[], itemMap: ItemsMap, metricQuery: MetricQuery, customLabels: Record<string, string> | undefined, onlyRaw: boolean, maxColumnLimit: number) => string[][];
+export declare const pivotResultsAsCsv: ({ pivotConfig, rows, itemMap, metricQuery, customLabels, onlyRaw, maxColumnLimit, undefinedCharacter, }: {
+    pivotConfig: PivotConfig;
+    rows: ResultRow[];
+    itemMap: ItemsMap;
+    metricQuery: MetricQuery;
+    customLabels: Record<string, string> | undefined;
+    onlyRaw: boolean;
+    maxColumnLimit: number;
+    undefinedCharacter?: string | undefined;
+}) => string[][];
 export {};

package/dist/pivotTable/pivotQueryResults.js

@@ -502,7 +502,7 @@ const pivotQueryResults = ({ pivotConfig, metricQuery, rows, options, getField,
     return combinedRetrofit(pivotData, getField, getFieldLabel);
 };
 exports.pivotQueryResults = pivotQueryResults;
-const pivotResultsAsCsv = (pivotConfig, rows, itemMap, metricQuery, customLabels, onlyRaw, maxColumnLimit) => {
+const pivotResultsAsCsv = ({ pivotConfig, rows, itemMap, metricQuery, customLabels, onlyRaw, maxColumnLimit, undefinedCharacter = '', }) => {
     const getFieldLabel = (fieldId) => {
         const customLabel = customLabels?.[fieldId];
         if (customLabel !== undefined)
@@ -526,7 +526,7 @@ const pivotResultsAsCsv = (pivotConfig, rows, itemMap, metricQuery, customLabels
             ? header.value[formatField]
             : getFieldLabel(header.fieldId));
         const fields = pivotedResults.titleFields[i];
-        const fieldLabels = fields.map((field) => field ? getFieldLabel(field.fieldId) : '-');
+        const fieldLabels = fields.map((field) => field ? getFieldLabel(field.fieldId) : undefinedCharacter);
         acc[i] = [...fieldLabels, ...values];
         return acc;
     }, [[]]);
@@ -536,7 +536,8 @@ const pivotResultsAsCsv = (pivotConfig, rows, itemMap, metricQuery, customLabels
         // Fields that return `null` don't appear in the pivot table
         // If there are no index fields, we need to add an empty string to the beginning of the row
         const noIndexPrefix = hasIndex ? [] : [''];
-        const formattedRows = fieldIds.map((fieldId) => row[fieldId]?.value?.[formatField] || '-');
+        const formattedRows = fieldIds.map((fieldId) => row[fieldId]?.value?.[formatField] ||
+            undefinedCharacter);
         return [...noIndexPrefix, ...formattedRows];
     });
     return [...headers, ...pivotedRows];

package/dist/types/gdrive.d.ts

@@ -1,4 +1,5 @@
 import { type MetricQueryResponse } from './metricQuery';
+import { type PivotConfig } from './pivot';
 export type ApiGdriveAccessTokenResponse = {
     status: 'ok';
     results: string;
@@ -14,6 +15,7 @@ export type UploadMetricGsheet = {
     columnOrder: string[];
     customLabels?: CustomLabel;
     hiddenFields?: string[];
+    pivotConfig?: PivotConfig;
 };
 export type UploadMetricGsheetPayload = UploadMetricGsheet & {
     userUuid: string;

package/dist/types/pivot.d.ts

@@ -1,5 +1,6 @@
 import { type FieldType } from './field';
 import { type ResultRow, type ResultValue } from './results';
+import { type CreateSavedChartVersion } from './savedCharts';
 export type PivotConfig = {
     pivotDimensions: string[];
     metricsAsRows: boolean;
@@ -60,4 +61,5 @@ export type PivotData = {
         pivotColumnInfo: PivotColumn[];
     };
 };
+export declare const getPivotConfig: (savedChart: CreateSavedChartVersion) => PivotConfig | undefined;
 export {};

package/dist/types/pivot.js

@@ -1,2 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPivotConfig = void 0;
+const savedCharts_1 = require("./savedCharts");
+const getPivotConfig = (savedChart) => savedChart.chartConfig.type === savedCharts_1.ChartType.TABLE &&
+    savedChart.pivotConfig !== undefined
+    ? {
+        pivotDimensions: savedChart.pivotConfig.columns,
+        metricsAsRows: false,
+        hiddenMetricFieldIds: (0, savedCharts_1.getHiddenTableFields)(savedChart.chartConfig),
+        columnOrder: savedChart.tableConfig.columnOrder,
+    }
+    : undefined;
+exports.getPivotConfig = getPivotConfig;

package/dist/utils/api.d.ts

@@ -1,3 +1,4 @@
 import { RequestMethod } from '../types/api';
 export declare const LightdashRequestMethodHeader = "Lightdash-Request-Method";
+export declare const LightdashVersionHeader = "Lightdash-Version";
 export declare const getRequestMethod: (headerValue: string | undefined) => RequestMethod;

package/dist/utils/api.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRequestMethod = exports.LightdashRequestMethodHeader = void 0;
+exports.getRequestMethod = exports.LightdashVersionHeader = exports.LightdashRequestMethodHeader = void 0;
 const api_1 = require("../types/api");
 exports.LightdashRequestMethodHeader = 'Lightdash-Request-Method';
+exports.LightdashVersionHeader = 'Lightdash-Version';
 const getRequestMethod = (headerValue) => (0, api_1.isRequestMethod)(headerValue) ? headerValue : api_1.RequestMethod.UNKNOWN;
 exports.getRequestMethod = getRequestMethod;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lightdash/common",
-    "version": "0.1407.2",
+    "version": "0.1408.0",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "files": [