@harbortouch/skytab-analytics-report-utils 0.41.14 → 0.42.1

package/dist/exporters/exportBuilder.d.cts

@@ -1,4 +1,4 @@
-import { R as ReportType, A as AnalyticsField } from '../report-CbS_hnrr.cjs';
+import { R as ReportType, A as AnalyticsField } from '../report-D307oJxt.cjs';
 import { E as ExportFilter, R as ReportMetadata, a as ExportSection } from '../types-D3IyO__4.cjs';
 
 declare function resolveRawFiltersToExportFilters(rawFilters: Record<string, (string | number)[] | undefined>, locale: string, reportType?: ReportType): ExportFilter[];
@@ -13,16 +13,22 @@ interface ReportLocation {
     countryCode: string;
     merchantId: string;
 }
-interface ReportParameters {
+/** Report options shared by exports, saved reports and subscriptions (everything except the date range). */
+interface ReportOptions {
+    groupBy?: AnalyticsField;
+    secondGroupBy?: AnalyticsField;
+    sortBy?: string;
+    order?: string;
+    cols?: string[];
+    viewMode?: 'detail' | 'summary';
     compareToLastWeek?: boolean;
     compareToLastYear?: boolean;
-    cols?: string[];
-    secondGroupBy?: AnalyticsField;
+    showZeroAmounts?: boolean;
+    showNonSales?: boolean;
+}
+interface ReportParameters extends ReportOptions {
     startDate: string | Date;
     endDate: string | Date;
-    groupBy?: AnalyticsField;
-    showZeroAmounts?: boolean;
-    order?: string;
 }
 type ReportData = SingleReportData | Record<string, SingleReportData>;
 type SingleReportData = Record<string, unknown>[];
@@ -52,4 +58,4 @@ declare class ExportBuilder {
     getContent(reportData: ReportData, parameters: ReportParameters, name: string | undefined, metadata: ReportMetadata, appliedFilters?: ExportFilter[]): ExportSection[];
 }
 
-export { ExportBuilder, ExportFilter, type ReportData, type ReportDocumentSection, type ReportLocation, ReportMetadata, type ReportParameters, ReportType, type SingleReportData, resolveRawFiltersToExportFilters };
+export { ExportBuilder, ExportFilter, type ReportData, type ReportDocumentSection, type ReportLocation, ReportMetadata, type ReportOptions, type ReportParameters, ReportType, type SingleReportData, resolveRawFiltersToExportFilters };

package/dist/exporters/exportBuilder.d.ts

@@ -1,4 +1,4 @@
-import { R as ReportType, A as AnalyticsField } from '../report-CbS_hnrr.js';
+import { R as ReportType, A as AnalyticsField } from '../report-D307oJxt.js';
 import { E as ExportFilter, R as ReportMetadata, a as ExportSection } from '../types-D3IyO__4.js';
 
 declare function resolveRawFiltersToExportFilters(rawFilters: Record<string, (string | number)[] | undefined>, locale: string, reportType?: ReportType): ExportFilter[];
@@ -13,16 +13,22 @@ interface ReportLocation {
     countryCode: string;
     merchantId: string;
 }
-interface ReportParameters {
+/** Report options shared by exports, saved reports and subscriptions (everything except the date range). */
+interface ReportOptions {
+    groupBy?: AnalyticsField;
+    secondGroupBy?: AnalyticsField;
+    sortBy?: string;
+    order?: string;
+    cols?: string[];
+    viewMode?: 'detail' | 'summary';
     compareToLastWeek?: boolean;
     compareToLastYear?: boolean;
-    cols?: string[];
-    secondGroupBy?: AnalyticsField;
+    showZeroAmounts?: boolean;
+    showNonSales?: boolean;
+}
+interface ReportParameters extends ReportOptions {
     startDate: string | Date;
     endDate: string | Date;
-    groupBy?: AnalyticsField;
-    showZeroAmounts?: boolean;
-    order?: string;
 }
 type ReportData = SingleReportData | Record<string, SingleReportData>;
 type SingleReportData = Record<string, unknown>[];
@@ -52,4 +58,4 @@ declare class ExportBuilder {
     getContent(reportData: ReportData, parameters: ReportParameters, name: string | undefined, metadata: ReportMetadata, appliedFilters?: ExportFilter[]): ExportSection[];
 }
 
-export { ExportBuilder, ExportFilter, type ReportData, type ReportDocumentSection, type ReportLocation, ReportMetadata, type ReportParameters, ReportType, type SingleReportData, resolveRawFiltersToExportFilters };
+export { ExportBuilder, ExportFilter, type ReportData, type ReportDocumentSection, type ReportLocation, ReportMetadata, type ReportOptions, type ReportParameters, ReportType, type SingleReportData, resolveRawFiltersToExportFilters };

package/dist/exporters/exportBuilder.js

@@ -8,7 +8,7 @@ import {
   getReportFormattingLocaleOptions,
   getReportName,
   resolveTranslate
-} from "../chunk-LOMK2QOF.js";
+} from "../chunk-KLJKY4F3.js";
 
 // src/utils/filter-resolver.ts
 var ANALYTICS_FIELDS = /* @__PURE__ */ new Set([
@@ -229,7 +229,7 @@ var ExportBuilder = class {
     }
     return format(date, "yyyy-MM-dd");
   }
-  buildReportMetadataFilters(parameters, name, meta) {
+  buildReportMetadataFilters(configs, parameters, name, meta) {
     const locationNames = this.locations.map((l) => l.name).join(", ");
     const period = `${this.formatMaybeDate(parameters.startDate)} - ${this.formatMaybeDate(parameters.endDate)}`;
     const filters = [
@@ -267,6 +267,28 @@ var ExportBuilder = class {
         value: this.translate("common.labels.yes")
       });
     }
+    const { order, sortBy } = parameters;
+    if (order && sortBy) {
+      const sortConfig = configs.find((c) => sortBy in c.fields) ?? configs[0];
+      const resolvedLabel = this.getColumnHeader(sortBy, sortConfig, parameters);
+      const direction = order === "asc" ? this.translate("common.sort-direction.ascending") : this.translate("common.sort-direction.descending");
+      filters.push({
+        label: this.translate("components.form.field.ordering"),
+        value: `${resolvedLabel} (${direction})`
+      });
+    }
+    if (parameters.viewMode) {
+      filters.push({
+        label: this.translate("components.form.field.view-mode"),
+        value: parameters.viewMode === "detail" ? this.translate("components.filter.view-mode.detail") : this.translate("components.filter.view-mode.summary")
+      });
+    }
+    if (parameters.showNonSales) {
+      filters.push({
+        label: this.translate("components.form.field.show-non-sales"),
+        value: parameters.showNonSales ? this.translate("common.labels.yes") : this.translate("common.labels.no")
+      });
+    }
     if (meta.generatedAt) {
       const formatted = new Intl.DateTimeFormat(this.locale, {
         year: "numeric",
@@ -290,7 +312,12 @@ var ExportBuilder = class {
       throw new Error("Missing report config");
     }
     const resolvedName = name ?? getReportName(this.reportType);
-    const metadataFilters = this.buildReportMetadataFilters(parameters, resolvedName, metadata);
+    const metadataFilters = this.buildReportMetadataFilters(
+      Array.isArray(rawConfig) ? rawConfig : [rawConfig],
+      parameters,
+      resolvedName,
+      metadata
+    );
     const metaData = {
       [""]: metadataFilters,
       [this.translate("scheduled-reports.applied-filters")]: appliedFilters ?? this.translate("common.labels.none")