@harbortouch/skytab-analytics-report-utils 0.38.1 → 0.40.0

package/dist/exporters/excel/index.d.cts

@@ -1,5 +1,5 @@
-import { E as ExportSection } from '../../types-BPT5hjCR.cjs';
-export { a as XlsxFilter, b as XlsxTable, c as XlsxTableColumn } from '../../types-BPT5hjCR.cjs';
+import { a as ExportSection } from '../../types-MalWTEdo.cjs';
+export { E as XlsxFilter, b as XlsxTable, c as XlsxTableColumn } from '../../types-MalWTEdo.cjs';
 
 declare class ExcelExporter {
     generate(content: {

package/dist/exporters/excel/index.d.ts

@@ -1,5 +1,5 @@
-import { E as ExportSection } from '../../types-BPT5hjCR.js';
-export { a as XlsxFilter, b as XlsxTable, c as XlsxTableColumn } from '../../types-BPT5hjCR.js';
+import { a as ExportSection } from '../../types-MalWTEdo.js';
+export { E as XlsxFilter, b as XlsxTable, c as XlsxTableColumn } from '../../types-MalWTEdo.js';
 
 declare class ExcelExporter {
     generate(content: {

package/dist/exporters/exportBuilder.cjs

@@ -494,6 +494,9 @@ var enUS = {
   "common.report-col.total-pay": "Total Pay",
   "common.report-col.total-pay.short": "Total Pay",
   "common.report-col.total-pay.info": "Total compensation including wages, overtime, and adjustments",
+  "common.report-col.table-name": "Table Name",
+  "common.report-col.table-name.short": "Table Name",
+  "common.report-col.table-name.info": "Table Name if assigned",
   "common.report-section.revenue-class": "Sales by Revenue Class",
   "common.report-section.payments": "Payments",
   "common.report-section.cash": "Expected Closeout Cash",
@@ -513,12 +516,16 @@ var enUS = {
   "common.report-section.rev-class-footer.non-sales-revenue": "Non-Sales Revenue",
   "common.report-section.rev-class-footer.house-account": "House Account",
   "common.report-section.rev-class-footer.total-accountable": "Total Accountable",
+  "scheduled-reports.report-name": "Report",
   "scheduled-reports.period": "Period",
+  "scheduled-reports.generated-at": "Generated at",
+  "scheduled-reports.generated-by": "Generated by",
   "components.form.field.group-by": "Group By",
   "components.form.field.last-week": "Compare to Last Week",
   "components.form.field.last-year": "Compare to Last Year",
   "common.labels.locations": "Locations",
   "common.labels.yes": "Yes",
+  "common.labels.unassigned": "Unassigned",
   // Analytic fields
   "analytics.field.location_id": "Location",
   "analytics.field.order_type_id": "Order Types",
@@ -1018,6 +1025,9 @@ var enUS2 = {
   "common.report-col.total-pay": false,
   "common.report-col.total-pay.short": false,
   "common.report-col.total-pay.info": false,
+  "common.report-col.table-name": false,
+  "common.report-col.table-name.short": false,
+  "common.report-col.table-name.info": false,
   "common.report-section.revenue-class": false,
   "common.report-section.payments": false,
   "common.report-section.cash": false,
@@ -1037,12 +1047,16 @@ var enUS2 = {
   "common.report-section.rev-class-footer.non-sales-revenue": false,
   "common.report-section.rev-class-footer.house-account": false,
   "common.report-section.rev-class-footer.total-accountable": false,
+  "scheduled-reports.report-name": false,
   "scheduled-reports.period": false,
+  "scheduled-reports.generated-at": false,
+  "scheduled-reports.generated-by": false,
   "components.form.field.group-by": false,
   "components.form.field.last-week": false,
   "components.form.field.last-year": false,
   "common.labels.locations": false,
   "common.labels.yes": false,
+  "common.labels.unassigned": false,
   // Analytic fields
   "analytics.field.location_id": false,
   "analytics.field.order_type_id": false,
@@ -1542,6 +1556,9 @@ var enUS3 = {
   "common.report-col.total-pay": false,
   "common.report-col.total-pay.short": false,
   "common.report-col.total-pay.info": false,
+  "common.report-col.table-name": false,
+  "common.report-col.table-name.short": false,
+  "common.report-col.table-name.info": false,
   "common.report-section.revenue-class": false,
   "common.report-section.payments": false,
   "common.report-section.cash": false,
@@ -1561,12 +1578,16 @@ var enUS3 = {
   "common.report-section.rev-class-footer.non-sales-revenue": false,
   "common.report-section.rev-class-footer.house-account": false,
   "common.report-section.rev-class-footer.total-accountable": false,
+  "scheduled-reports.report-name": false,
   "scheduled-reports.period": false,
+  "scheduled-reports.generated-at": false,
+  "scheduled-reports.generated-by": false,
   "components.form.field.group-by": false,
   "components.form.field.last-week": false,
   "components.form.field.last-year": false,
   "common.labels.locations": false,
   "common.labels.yes": false,
+  "common.labels.unassigned": false,
   // Analytic fields
   "analytics.field.location_id": false,
   "analytics.field.order_type_id": false,
@@ -2089,7 +2110,18 @@ var FIELDS3 = {
     filteringAvailable: false
   },
   employeeName: { type: "string", columnKey: "employeeName", filteringAvailable: false },
-  orderTypeName: { type: "string", columnKey: "orderType", filteringAvailable: false }
+  orderTypeName: { type: "string", columnKey: "orderType", filteringAvailable: false },
+  tableName: {
+    type: "custom",
+    columnKey: "tableName",
+    enableSorting: false,
+    filteringAvailable: false,
+    customConfiguration: {
+      customFormat: (value, _full, locale) => {
+        return typeof value === "string" && value !== "" ? value : resolveTranslate("common.labels.unassigned", locale);
+      }
+    }
+  }
 };
 var TICKET_SUMMARY_VISIBLE_COLUMNS = [
   "locationName",
@@ -2108,7 +2140,8 @@ var TICKET_SUMMARY_VISIBLE_COLUMNS = [
   "paymentTypeName",
   "guestsCount",
   "employeeName",
-  "orderTypeName"
+  "orderTypeName",
+  "tableName"
 ];
 var TICKET_SUMMARY_AVAILABLE_COLUMNS = ["orderNumber", ...TICKET_SUMMARY_VISIBLE_COLUMNS];
 var ticketSummaryConfig = {
@@ -2147,7 +2180,18 @@ var FIELDS4 = {
   },
   customerName: { type: "string", columnKey: "customerName" },
   employeeName: { type: "string", columnKey: "employeeName" },
-  orderType: { type: "string", columnKey: "orderType" }
+  orderType: { type: "string", columnKey: "orderType" },
+  tableName: {
+    type: "custom",
+    columnKey: "tableName",
+    enableSorting: false,
+    filteringAvailable: false,
+    customConfiguration: {
+      customFormat: (value, _full, locale) => {
+        return typeof value === "string" && value !== "" ? value : resolveTranslate("common.labels.unassigned", locale);
+      }
+    }
+  }
 };
 var TICKET_LIVE_VISIBLE_COLUMNS = [
   "locationName",
@@ -2166,7 +2210,8 @@ var TICKET_LIVE_VISIBLE_COLUMNS = [
   "paymentTypeName",
   "guestCount",
   "employeeName",
-  "orderType"
+  "orderType",
+  "tableName"
 ];
 var TICKET_LIVE_AVAILABLE_COLUMNS = ["orderNumber", ...TICKET_LIVE_VISIBLE_COLUMNS];
 var ticketLiveConfig = {
@@ -3697,6 +3742,11 @@ var COLUMN_REGISTRY = {
     titleKey: "common.report-col.total-pay",
     shortTitleKey: "common.report-col.total-pay.short",
     infoTextKey: "common.report-col.total-pay.info"
+  },
+  tableName: {
+    titleKey: "common.report-col.table-name",
+    shortTitleKey: "common.report-col.table-name.short",
+    infoTextKey: "common.report-col.table-name.info"
   }
 };
 function getColumnMetadata(key) {
@@ -3918,50 +3968,71 @@ var ExportBuilder = class {
     }
     return (0, import_date_fns.format)(date, "yyyy-MM-dd");
   }
-  buildMetadata(parameters) {
-    const rows = [];
-    rows.push([
-      this.translate("scheduled-reports.period"),
-      `${this.formatMaybeDate(parameters.startDate)} - ${this.formatMaybeDate(parameters.endDate)}`
-    ]);
+  buildReportMetadataFilters(parameters, name, meta) {
+    const locationNames = this.locations.map((l) => l.name).join(", ");
+    const period = `${this.formatMaybeDate(parameters.startDate)} - ${this.formatMaybeDate(parameters.endDate)}`;
+    const filters = [
+      { label: this.translate("scheduled-reports.report-name"), value: name },
+      { label: this.translate("common.labels.locations"), value: locationNames },
+      { label: this.translate("scheduled-reports.period"), value: period }
+    ];
     if (parameters.groupBy) {
-      rows.push([
-        this.translate("components.form.field.group-by"),
-        this.translate(`analytics.field.${parameters.groupBy}`)
-      ]);
-    }
-    const locationNames = this.locations.map((l) => l.name);
-    if (locationNames.length > 0) {
-      rows.push([this.translate("common.labels.locations"), locationNames.join(", ")]);
+      filters.push({
+        label: this.translate("components.form.field.group-by"),
+        value: this.translate(`analytics.field.${parameters.groupBy}`)
+      });
     }
     if (parameters.compareToLastWeek === true) {
-      rows.push([this.translate("components.form.field.last-week"), this.translate("common.labels.yes")]);
+      filters.push({
+        label: this.translate("components.form.field.last-week"),
+        value: this.translate("common.labels.yes")
+      });
     }
     if (parameters.compareToLastYear === true) {
-      rows.push([this.translate("components.form.field.last-year"), this.translate("common.labels.yes")]);
+      filters.push({
+        label: this.translate("components.form.field.last-year"),
+        value: this.translate("common.labels.yes")
+      });
+    }
+    if (meta.generatedAt) {
+      const formatted = new Intl.DateTimeFormat(this.locale, {
+        year: "numeric",
+        month: "short",
+        day: "numeric",
+        hour: "numeric",
+        minute: "2-digit",
+        timeZoneName: "short"
+      }).format(meta.generatedAt);
+      filters.push({ label: this.translate("scheduled-reports.generated-at"), value: formatted });
+    }
+    if (meta.generatedBy.email) {
+      filters.push({ label: this.translate("scheduled-reports.generated-by"), value: meta.generatedBy.email });
     }
-    return rows;
+    return filters.filter(({ value }) => value !== "");
   }
-  getContent(reportData, parameters, name) {
+  getContent(reportData, parameters, name, metadata, appliedFilters) {
     const rawConfig = this.getConfig();
     if (!rawConfig) {
       throw new Error("Missing report config");
     }
+    const metadataFilters = this.buildReportMetadataFilters(parameters, name, metadata);
+    const resolvedAppliedFilters = appliedFilters ?? [];
     let sections;
     if (Array.isArray(rawConfig)) {
       const sectionParameters = { ...parameters, cols: void 0 };
-      sections = rawConfig.map((config) => {
-        return {
+      sections = [
+        { title: name, filters: metadataFilters, appliedFilters: resolvedAppliedFilters },
+        ...rawConfig.map((config) => ({
           title: this.getConfigSectionName(config),
           ...this.renderTableContent(config, reportData, sectionParameters)
-        };
-      });
+        }))
+      ];
     } else {
-      const metadata = this.buildMetadata(parameters);
       sections = [
         {
           title: name,
-          filters: metadata.map(([label, value]) => ({ label, value })),
+          filters: metadataFilters,
+          appliedFilters: resolvedAppliedFilters,
           ...this.renderTableContent(rawConfig, reportData, parameters)
         }
       ];

package/dist/exporters/exportBuilder.d.cts

@@ -1,5 +1,5 @@
-import { R as ReportType, A as AnalyticsField } from '../report-ZRoya9wR.cjs';
-import { E as ExportSection } from '../types-BPT5hjCR.cjs';
+import { R as ReportType, A as AnalyticsField } from '../report-BNVH_1-b.cjs';
+import { R as ReportMetadata, E as ExportFilter, a as ExportSection } from '../types-MalWTEdo.cjs';
 
 type ReportDocumentSection = ExportSection;
 interface ReportLocation {
@@ -45,8 +45,8 @@ declare class ExportBuilder {
     private renderTableContent;
     private getDataForConfig;
     private formatMaybeDate;
-    private buildMetadata;
-    getContent(reportData: ReportData, parameters: ReportParameters, name: string): ExportSection[];
+    private buildReportMetadataFilters;
+    getContent(reportData: ReportData, parameters: ReportParameters, name: string, metadata: ReportMetadata, appliedFilters?: ExportFilter[]): ExportSection[];
 }
 
-export { ExportBuilder, type ReportData, type ReportDocumentSection, type ReportLocation, type ReportParameters, type SingleReportData };
+export { ExportBuilder, type ReportData, type ReportDocumentSection, type ReportLocation, ReportMetadata, type ReportParameters, ReportType, type SingleReportData };

package/dist/exporters/exportBuilder.d.ts

@@ -1,5 +1,5 @@
-import { R as ReportType, A as AnalyticsField } from '../report-ZRoya9wR.js';
-import { E as ExportSection } from '../types-BPT5hjCR.js';
+import { R as ReportType, A as AnalyticsField } from '../report-BNVH_1-b.js';
+import { R as ReportMetadata, E as ExportFilter, a as ExportSection } from '../types-MalWTEdo.js';
 
 type ReportDocumentSection = ExportSection;
 interface ReportLocation {
@@ -45,8 +45,8 @@ declare class ExportBuilder {
     private renderTableContent;
     private getDataForConfig;
     private formatMaybeDate;
-    private buildMetadata;
-    getContent(reportData: ReportData, parameters: ReportParameters, name: string): ExportSection[];
+    private buildReportMetadataFilters;
+    getContent(reportData: ReportData, parameters: ReportParameters, name: string, metadata: ReportMetadata, appliedFilters?: ExportFilter[]): ExportSection[];
 }
 
-export { ExportBuilder, type ReportData, type ReportDocumentSection, type ReportLocation, type ReportParameters, type SingleReportData };
+export { ExportBuilder, type ReportData, type ReportDocumentSection, type ReportLocation, ReportMetadata, type ReportParameters, ReportType, type SingleReportData };

package/dist/exporters/exportBuilder.js

@@ -7,7 +7,7 @@ import {
   getReportConfig,
   getReportFormattingLocaleOptions,
   resolveTranslate
-} from "../chunk-MFOOIOP4.js";
+} from "../chunk-HKSLZ6DJ.js";
 
 // src/exporters/exportBuilder.ts
 import { format, isValid, parseISO } from "date-fns";
@@ -158,50 +158,71 @@ var ExportBuilder = class {
     }
     return format(date, "yyyy-MM-dd");
   }
-  buildMetadata(parameters) {
-    const rows = [];
-    rows.push([
-      this.translate("scheduled-reports.period"),
-      `${this.formatMaybeDate(parameters.startDate)} - ${this.formatMaybeDate(parameters.endDate)}`
-    ]);
+  buildReportMetadataFilters(parameters, name, meta) {
+    const locationNames = this.locations.map((l) => l.name).join(", ");
+    const period = `${this.formatMaybeDate(parameters.startDate)} - ${this.formatMaybeDate(parameters.endDate)}`;
+    const filters = [
+      { label: this.translate("scheduled-reports.report-name"), value: name },
+      { label: this.translate("common.labels.locations"), value: locationNames },
+      { label: this.translate("scheduled-reports.period"), value: period }
+    ];
     if (parameters.groupBy) {
-      rows.push([
-        this.translate("components.form.field.group-by"),
-        this.translate(`analytics.field.${parameters.groupBy}`)
-      ]);
-    }
-    const locationNames = this.locations.map((l) => l.name);
-    if (locationNames.length > 0) {
-      rows.push([this.translate("common.labels.locations"), locationNames.join(", ")]);
+      filters.push({
+        label: this.translate("components.form.field.group-by"),
+        value: this.translate(`analytics.field.${parameters.groupBy}`)
+      });
     }
     if (parameters.compareToLastWeek === true) {
-      rows.push([this.translate("components.form.field.last-week"), this.translate("common.labels.yes")]);
+      filters.push({
+        label: this.translate("components.form.field.last-week"),
+        value: this.translate("common.labels.yes")
+      });
     }
     if (parameters.compareToLastYear === true) {
-      rows.push([this.translate("components.form.field.last-year"), this.translate("common.labels.yes")]);
+      filters.push({
+        label: this.translate("components.form.field.last-year"),
+        value: this.translate("common.labels.yes")
+      });
+    }
+    if (meta.generatedAt) {
+      const formatted = new Intl.DateTimeFormat(this.locale, {
+        year: "numeric",
+        month: "short",
+        day: "numeric",
+        hour: "numeric",
+        minute: "2-digit",
+        timeZoneName: "short"
+      }).format(meta.generatedAt);
+      filters.push({ label: this.translate("scheduled-reports.generated-at"), value: formatted });
     }
-    return rows;
+    if (meta.generatedBy.email) {
+      filters.push({ label: this.translate("scheduled-reports.generated-by"), value: meta.generatedBy.email });
+    }
+    return filters.filter(({ value }) => value !== "");
   }
-  getContent(reportData, parameters, name) {
+  getContent(reportData, parameters, name, metadata, appliedFilters) {
     const rawConfig = this.getConfig();
     if (!rawConfig) {
       throw new Error("Missing report config");
     }
+    const metadataFilters = this.buildReportMetadataFilters(parameters, name, metadata);
+    const resolvedAppliedFilters = appliedFilters ?? [];
     let sections;
     if (Array.isArray(rawConfig)) {
       const sectionParameters = { ...parameters, cols: void 0 };
-      sections = rawConfig.map((config) => {
-        return {
+      sections = [
+        { title: name, filters: metadataFilters, appliedFilters: resolvedAppliedFilters },
+        ...rawConfig.map((config) => ({
           title: this.getConfigSectionName(config),
           ...this.renderTableContent(config, reportData, sectionParameters)
-        };
-      });
+        }))
+      ];
     } else {
-      const metadata = this.buildMetadata(parameters);
       sections = [
         {
           title: name,
-          filters: metadata.map(([label, value]) => ({ label, value })),
+          filters: metadataFilters,
+          appliedFilters: resolvedAppliedFilters,
           ...this.renderTableContent(rawConfig, reportData, parameters)
         }
       ];