@harbortouch/skytab-analytics-report-utils 0.19.1 → 0.20.0

package/dist/exporters/exportBuilder.d.cts

@@ -0,0 +1,56 @@
+import { R as ReportType, A as AnalyticsField } from '../report-BOL9p86o.cjs';
+import { E as ExportTable, a as ExportFilter } from '../types-BzLsgnfc.cjs';
+
+interface ReportDocumentSection {
+    sheetName: string;
+    table?: ExportTable;
+    filters?: ExportFilter[];
+}
+interface ReportLocation {
+    id: number;
+    name: string;
+    timezone: string;
+    language: string;
+    currency: string;
+    countryCode: string;
+    merchantId: string;
+}
+interface ReportParameters {
+    compareToLastWeek?: boolean;
+    compareToLastYear?: boolean;
+    cols?: string[];
+    secondGroupBy?: AnalyticsField;
+    startDate: string | Date;
+    endDate: string | Date;
+    groupBy?: AnalyticsField;
+    order?: string;
+}
+type ReportData = SingleReportData | Record<string, SingleReportData>;
+type SingleReportData = Record<string, unknown>[];
+declare class ExportBuilder {
+    private readonly reportType;
+    private readonly locations;
+    private readonly locale;
+    constructor(reportType: ReportType, locations: ReportLocation[], locale: string);
+    private getFormattingConfig;
+    private getConfig;
+    private getConfigSectionName;
+    private translate;
+    private buildColumnPrefix;
+    private sortAndPrependPrefix;
+    private resolveColumns;
+    private getColumnHeader;
+    private resolveColumnsAndHeaders;
+    private formatField;
+    private formatRow;
+    private resolveLabelField;
+    private buildTotalsRow;
+    private getExtraFooterRows;
+    private renderTableContent;
+    private getDataForConfig;
+    private formatMaybeDate;
+    private buildMetadata;
+    getContent(reportData: ReportData, parameters: ReportParameters, name: string): ReportDocumentSection[];
+}
+
+export { ExportBuilder, type ReportData, type ReportDocumentSection, type ReportLocation, type ReportParameters, type SingleReportData };

package/dist/exporters/exportBuilder.d.ts

@@ -0,0 +1,56 @@
+import { R as ReportType, A as AnalyticsField } from '../report-BOL9p86o.js';
+import { E as ExportTable, a as ExportFilter } from '../types-BzLsgnfc.js';
+
+interface ReportDocumentSection {
+    sheetName: string;
+    table?: ExportTable;
+    filters?: ExportFilter[];
+}
+interface ReportLocation {
+    id: number;
+    name: string;
+    timezone: string;
+    language: string;
+    currency: string;
+    countryCode: string;
+    merchantId: string;
+}
+interface ReportParameters {
+    compareToLastWeek?: boolean;
+    compareToLastYear?: boolean;
+    cols?: string[];
+    secondGroupBy?: AnalyticsField;
+    startDate: string | Date;
+    endDate: string | Date;
+    groupBy?: AnalyticsField;
+    order?: string;
+}
+type ReportData = SingleReportData | Record<string, SingleReportData>;
+type SingleReportData = Record<string, unknown>[];
+declare class ExportBuilder {
+    private readonly reportType;
+    private readonly locations;
+    private readonly locale;
+    constructor(reportType: ReportType, locations: ReportLocation[], locale: string);
+    private getFormattingConfig;
+    private getConfig;
+    private getConfigSectionName;
+    private translate;
+    private buildColumnPrefix;
+    private sortAndPrependPrefix;
+    private resolveColumns;
+    private getColumnHeader;
+    private resolveColumnsAndHeaders;
+    private formatField;
+    private formatRow;
+    private resolveLabelField;
+    private buildTotalsRow;
+    private getExtraFooterRows;
+    private renderTableContent;
+    private getDataForConfig;
+    private formatMaybeDate;
+    private buildMetadata;
+    getContent(reportData: ReportData, parameters: ReportParameters, name: string): ReportDocumentSection[];
+}
+
+export { ExportBuilder, type ReportData, type ReportDocumentSection, type ReportLocation, type ReportParameters, type SingleReportData };

package/dist/exporters/exportBuilder.js

@@ -0,0 +1,246 @@
+import {
+  calculateReportTotals,
+  en_US_default,
+  formatFieldValue,
+  getColumnExportHeaderLabel,
+  getColumnMetadata,
+  getReportConfig,
+  getReportFormattingLocaleOptions,
+  resolveTranslate
+} from "../chunk-7NXZJEGU.js";
+
+// src/exporters/exportBuilder.ts
+import { format, isValid, parseISO } from "date-fns";
+var ExportBuilder = class {
+  constructor(reportType, locations, locale) {
+    this.reportType = reportType;
+    this.locations = locations;
+    this.locale = locale;
+  }
+  getFormattingConfig() {
+    const configs = getReportFormattingLocaleOptions(this.locations);
+    return configs[0];
+  }
+  getConfig() {
+    return getReportConfig(this.reportType);
+  }
+  getConfigSectionName(config) {
+    return config.sectionName ? this.translate(config.sectionName) : "Unknown section";
+  }
+  translate(messageKey) {
+    return resolveTranslate(messageKey, this.locale);
+  }
+  buildColumnPrefix(config, parameters) {
+    const prefix = [];
+    if ("groupByName" in config.fields) {
+      prefix.push("groupByName");
+    }
+    if (parameters.secondGroupBy && "groupByName2" in config.fields) {
+      prefix.push("groupByName2");
+    }
+    return prefix;
+  }
+  sortAndPrependPrefix(config, parameters, collected) {
+    const orderMap = new Map(config.availableColumns.map((col, i) => [col, i]));
+    const sorted = [...collected].sort((a, b) => (orderMap.get(a) ?? Infinity) - (orderMap.get(b) ?? Infinity));
+    return [...this.buildColumnPrefix(config, parameters), ...sorted];
+  }
+  resolveColumns(config, parameters) {
+    const selectedGroupIds = Array.isArray(parameters.cols) ? parameters.cols : null;
+    const compareToLastWeek = parameters.compareToLastWeek === true;
+    const compareToLastYear = parameters.compareToLastYear === true;
+    if (selectedGroupIds !== null && selectedGroupIds.length === 0) {
+      return this.buildColumnPrefix(config, parameters);
+    }
+    if (selectedGroupIds?.length && config.columnGroups?.length) {
+      const collected = [];
+      for (const groupId of selectedGroupIds) {
+        const group = config.columnGroups.find((g) => g.id === groupId);
+        if (!group) {
+          continue;
+        }
+        collected.push(...group.baseFields);
+        if (compareToLastWeek && group.lastWeekFields) {
+          collected.push(...group.lastWeekFields);
+        }
+        if (compareToLastYear && group.lastYearFields) {
+          collected.push(...group.lastYearFields);
+        }
+      }
+      return this.sortAndPrependPrefix(config, parameters, collected);
+    }
+    if (!selectedGroupIds && config.columnGroups?.length && (compareToLastWeek || compareToLastYear)) {
+      const collected = [];
+      for (const col of config.defaultVisibleColumns) {
+        collected.push(col);
+        const group = config.columnGroups.find((g) => g.baseFields.includes(col));
+        if (group) {
+          if (compareToLastWeek && group.lastWeekFields) {
+            collected.push(...group.lastWeekFields);
+          }
+          if (compareToLastYear && group.lastYearFields) {
+            collected.push(...group.lastYearFields);
+          }
+        }
+      }
+      return this.sortAndPrependPrefix(config, parameters, collected);
+    }
+    const metricCols = selectedGroupIds?.length ? config.availableColumns.filter((c) => selectedGroupIds.includes(c)) : config.defaultVisibleColumns;
+    return [...this.buildColumnPrefix(config, parameters), ...metricCols];
+  }
+  getColumnHeader(fieldName, config) {
+    const columnKey = config.fields[fieldName]?.columnKey;
+    const titleKey = columnKey ? getColumnMetadata(columnKey)?.shortTitleKey : void 0;
+    const colHeader = titleKey ? this.translate(titleKey) : fieldName.replace(/([A-Z])/g, " $1").replace(/^./, (c) => c.toUpperCase()).trim();
+    const group = config.columnGroups?.find(
+      (g) => g.baseFields.includes(fieldName) || (g.lastWeekFields?.includes(fieldName) ?? false) || (g.lastYearFields?.includes(fieldName) ?? false)
+    );
+    return group ? getColumnExportHeaderLabel(colHeader, this.translate(group.headerTranslationKey)) : colHeader;
+  }
+  resolveColumnsAndHeaders(parameters, config) {
+    const columns = this.resolveColumns(config, parameters);
+    const headers = columns.map((col) => {
+      if (col === "groupByName2" && parameters.secondGroupBy) {
+        return this.translate(`analytics.field.${parameters.secondGroupBy}`);
+      }
+      return this.getColumnHeader(col, config);
+    });
+    const columnTypes = columns.map((col) => config.fields[col]);
+    return { columns, headers, columnTypes };
+  }
+  formatField(value, config, localeOption, fullRecord) {
+    if (!config || value === void 0 || value === null) {
+      return "";
+    }
+    const formatted = formatFieldValue(value, config.type, localeOption, fullRecord, config);
+    return typeof formatted === "string" && formatted in en_US_default ? this.translate(formatted) : formatted;
+  }
+  formatRow(raw, columns, columnTypes, localeConfig, fullRecord) {
+    const formatted = {};
+    columns.forEach((col, i) => {
+      formatted[col] = this.formatField(raw[col], columnTypes[i], localeConfig, fullRecord);
+    });
+    return formatted;
+  }
+  resolveLabelField(config, columns) {
+    if ("groupByName" in config.fields) {
+      return "groupByName";
+    }
+    const firstStringCol = columns.find((col) => {
+      const field = config.fields[col];
+      return field?.type === "string" && !field.footerCalculation;
+    });
+    return firstStringCol ?? columns[0] ?? "groupByName";
+  }
+  buildTotalsRow(data, config, columns) {
+    if (data.length === 0) {
+      return null;
+    }
+    const labelField = this.resolveLabelField(config, columns);
+    const label = config.totalsLabel ? this.translate(config.totalsLabel) : this.translate("table.total");
+    return calculateReportTotals(data, config.fields, { labelField, label });
+  }
+  getExtraFooterRows(data, config, sectionData, columns) {
+    if (config.extraFooterRowsKey) {
+      if (!Array.isArray(data)) {
+        const rows = data[config.extraFooterRowsKey];
+        if (Array.isArray(rows)) {
+          return rows;
+        }
+      }
+    }
+    if (config.extraFooterFields?.length && sectionData.length > 0) {
+      const labelField = this.resolveLabelField(config, columns);
+      const totals = calculateReportTotals(sectionData, config.fields, {
+        labelField,
+        label: this.translate("table.total")
+      });
+      const row = { [labelField]: totals[labelField] };
+      for (const field of config.extraFooterFields) {
+        row[field] = totals[field];
+      }
+      return [row];
+    }
+    return [];
+  }
+  renderTableContent(config, reportData, parameters) {
+    const localeConfig = this.getFormattingConfig();
+    const data = this.getDataForConfig(reportData, config);
+    const { columns, headers, columnTypes } = this.resolveColumnsAndHeaders(parameters, config);
+    const tableColumns = columns.map((col, i) => ({ header: headers[i], key: col }));
+    const rows = data.filter((row) => typeof row === "object" && row !== null).map((row) => this.formatRow(row, columns, columnTypes, localeConfig, row));
+    if (config.hasFooter) {
+      const totalsRow = this.buildTotalsRow(data, config, columns);
+      if (totalsRow) {
+        rows.push(this.formatRow(totalsRow, columns, columnTypes, localeConfig, null));
+      }
+    }
+    for (const extraRow of this.getExtraFooterRows(reportData, config, data, columns)) {
+      rows.push(this.formatRow(extraRow, columns, columnTypes, localeConfig, extraRow));
+    }
+    return { table: { columns: tableColumns, rows } };
+  }
+  getDataForConfig(data, config) {
+    if (Array.isArray(data)) {
+      return data;
+    }
+    return config.dataAccessKey ? data[config.dataAccessKey] ?? [] : [];
+  }
+  formatMaybeDate(value) {
+    const date = typeof value === "string" ? parseISO(value) : value;
+    if (!isValid(date)) {
+      return "";
+    }
+    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)}`
+    ]);
+    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(", ")]);
+    }
+    if (parameters.compareToLastWeek === true) {
+      rows.push([this.translate("components.form.field.last-week"), this.translate("common.labels.yes")]);
+    }
+    if (parameters.compareToLastYear === true) {
+      rows.push([this.translate("components.form.field.last-year"), this.translate("common.labels.yes")]);
+    }
+    return rows;
+  }
+  getContent(reportData, parameters, name) {
+    const rawConfig = this.getConfig();
+    if (!rawConfig) {
+      throw new Error("Missing report config");
+    }
+    let sections;
+    if (Array.isArray(rawConfig)) {
+      sections = rawConfig.map((config) => ({
+        sheetName: this.getConfigSectionName(config),
+        ...this.renderTableContent(config, reportData, parameters)
+      }));
+    } else {
+      const metadata = this.buildMetadata(parameters);
+      sections = [
+        {
+          sheetName: name,
+          filters: metadata.map(([label, value]) => ({ label, value })),
+          ...this.renderTableContent(rawConfig, reportData, parameters)
+        }
+      ];
+    }
+    return sections;
+  }
+};
+export {
+  ExportBuilder
+};

package/dist/index.cjs

@@ -901,8 +901,7 @@ var Report = {
   EMPLOYEE_TIP: "employee-tip",
   SALES_BY_ITEM: "sales-by-item",
   DAILY_SALES: "daily-sales",
-  DAILY_SALES_LIVE: "daily-sales-live",
-  DAILY_SALES_TRENDS: "daily-sales-trends"
+  DAILY_SALES_LIVE: "daily-sales-live"
 };
 var DAILY_SALES_SECTION_CONFIGS = [
   dailySalesConfig,
@@ -925,8 +924,7 @@ var REPORT_CONFIG_MAP = {
   "employee-tip": employeeTipConfig,
   "sales-by-item": salesByItemDetailConfig,
   "daily-sales": DAILY_SALES_SECTION_CONFIGS,
-  "daily-sales-live": DAILY_SALES_SECTION_CONFIGS,
-  "daily-sales-trends": null
+  "daily-sales-live": DAILY_SALES_SECTION_CONFIGS
 };
 var REPORT_DEFAULT_NAME_MAP = {
   "sales-summary": "Sales",
@@ -939,8 +937,7 @@ var REPORT_DEFAULT_NAME_MAP = {
   "employee-tip": "Employee Tip",
   "sales-by-item": "Sales by Item",
   "daily-sales": "Daily Sales",
-  "daily-sales-live": "Daily Sales Live",
-  "daily-sales-trends": "Daily Sales Trends"
+  "daily-sales-live": "Daily Sales Live"
 };
 var getReportConfig = (reportType) => REPORT_CONFIG_MAP[reportType];
 var getReportExportFileName = ({
@@ -2333,7 +2330,53 @@ var enUS = {
   "common.report-col.gross-credit-card-tips.info": false,
   "common.report-col.type": false,
   "common.report-col.type.short": false,
-  "common.report-col.type.info": false
+  "common.report-col.type.info": false,
+  "common.report-section.revenue-class": false,
+  "common.report-section.payments": false,
+  "common.report-section.cash": false,
+  "common.report-section.taxes": false,
+  "common.report-section.refunds-voids": false,
+  "common.report-section.discounts": false,
+  "common.report-section.sales-by-day-part": false,
+  "common.report-section.sales-by-order-type": false,
+  "common.report-section.cash-row.cash-payments": false,
+  "common.report-section.cash-row.paid-in-outs": false,
+  "common.report-section.cash-row.gratuities-paid-out": false,
+  "common.report-section.cash-row.cc-tips-paid-out": false,
+  "common.report-section.trends-footer.total-sales": false,
+  "common.report-section.rev-class-footer.tax-total": false,
+  "common.report-section.rev-class-footer.gratuities": false,
+  "common.report-section.rev-class-footer.balance-payments": false,
+  "common.report-section.rev-class-footer.gift-card-sales": false,
+  "common.report-section.rev-class-footer.non-sales-revenue": false,
+  "common.report-section.rev-class-footer.total-accountable": false,
+  "scheduled-reports.period": 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,
+  // Analytic fields
+  "analytics.field.location_id": false,
+  "analytics.field.order_type_id": false,
+  "analytics.field.revenue_center_id": false,
+  "analytics.field.revenue_center_id.all": false,
+  "analytics.field.hour_id": false,
+  "analytics.field.daypart_id": false,
+  "analytics.field.timeslot_id": false,
+  "analytics.field.employee_id": false,
+  "analytics.field.payroll_id": false,
+  "analytics.field.intraday_period_group": false,
+  "analytics.field.item_id": false,
+  "analytics.field.department_id": false,
+  "analytics.field.revenue_class_id": false,
+  "analytics.field.modifier_id": false,
+  // Common labels
+  "table.total": false,
+  "table.groups.sales": false,
+  "table.groups.net-sales": false,
+  "table.groups.guests": false,
+  "table.groups.sales-per-guest": false
 };
 var en_GB_default = enUS;
 
@@ -2773,7 +2816,53 @@ var enUS2 = {
   "common.report-col.gross-credit-card-tips.info": false,
   "common.report-col.type": false,
   "common.report-col.type.short": false,
-  "common.report-col.type.info": false
+  "common.report-col.type.info": false,
+  "common.report-section.revenue-class": false,
+  "common.report-section.payments": false,
+  "common.report-section.cash": false,
+  "common.report-section.taxes": false,
+  "common.report-section.refunds-voids": false,
+  "common.report-section.discounts": false,
+  "common.report-section.sales-by-day-part": false,
+  "common.report-section.sales-by-order-type": false,
+  "common.report-section.cash-row.cash-payments": false,
+  "common.report-section.cash-row.paid-in-outs": false,
+  "common.report-section.cash-row.gratuities-paid-out": false,
+  "common.report-section.cash-row.cc-tips-paid-out": false,
+  "common.report-section.trends-footer.total-sales": false,
+  "common.report-section.rev-class-footer.tax-total": false,
+  "common.report-section.rev-class-footer.gratuities": false,
+  "common.report-section.rev-class-footer.balance-payments": false,
+  "common.report-section.rev-class-footer.gift-card-sales": false,
+  "common.report-section.rev-class-footer.non-sales-revenue": false,
+  "common.report-section.rev-class-footer.total-accountable": false,
+  "scheduled-reports.period": 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,
+  // Analytic fields
+  "analytics.field.location_id": false,
+  "analytics.field.order_type_id": false,
+  "analytics.field.revenue_center_id": false,
+  "analytics.field.revenue_center_id.all": false,
+  "analytics.field.hour_id": false,
+  "analytics.field.daypart_id": false,
+  "analytics.field.timeslot_id": false,
+  "analytics.field.employee_id": false,
+  "analytics.field.payroll_id": false,
+  "analytics.field.intraday_period_group": false,
+  "analytics.field.item_id": false,
+  "analytics.field.department_id": false,
+  "analytics.field.revenue_class_id": false,
+  "analytics.field.modifier_id": false,
+  // Common labels
+  "table.total": false,
+  "table.groups.sales": false,
+  "table.groups.net-sales": false,
+  "table.groups.guests": false,
+  "table.groups.sales-per-guest": false
 };
 var es_ES_default = enUS2;
 
@@ -3213,7 +3302,53 @@ var enUS3 = {
   "common.report-col.gross-credit-card-tips.info": "Gross credit card tips before any deductions or redistribution",
   "common.report-col.type": "Type",
   "common.report-col.type.short": "Type",
-  "common.report-col.type.info": " "
+  "common.report-col.type.info": " ",
+  "common.report-section.revenue-class": "Revenue Class",
+  "common.report-section.payments": "Payments",
+  "common.report-section.cash": "Expected Closeout Cash",
+  "common.report-section.taxes": "Taxes",
+  "common.report-section.refunds-voids": "Refunds & Voids",
+  "common.report-section.discounts": "Discounts",
+  "common.report-section.sales-by-day-part": "Sales by Day Part",
+  "common.report-section.sales-by-order-type": "Sales by Order Type",
+  "common.report-section.cash-row.cash-payments": "Cash Payments",
+  "common.report-section.cash-row.paid-in-outs": "Paid-In/Outs",
+  "common.report-section.cash-row.gratuities-paid-out": "Gratuities Paid Out",
+  "common.report-section.cash-row.cc-tips-paid-out": "CC Tips Paid Out",
+  "common.report-section.trends-footer.total-sales": "Total Sales",
+  "common.report-section.rev-class-footer.tax-total": "Tax Total",
+  "common.report-section.rev-class-footer.gratuities": "Gratuities",
+  "common.report-section.rev-class-footer.balance-payments": "Balance Payments",
+  "common.report-section.rev-class-footer.gift-card-sales": "Gift Card Sales",
+  "common.report-section.rev-class-footer.non-sales-revenue": "Non-Sales Revenue",
+  "common.report-section.rev-class-footer.total-accountable": "Total Accountable",
+  "scheduled-reports.period": "Period",
+  "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",
+  // Analytic fields
+  "analytics.field.location_id": "Location",
+  "analytics.field.order_type_id": "Order Types",
+  "analytics.field.revenue_center_id": "Revenue Centers",
+  "analytics.field.revenue_center_id.all": "All Revenue Centers",
+  "analytics.field.hour_id": "Hours",
+  "analytics.field.daypart_id": "Day Parts",
+  "analytics.field.timeslot_id": "15 Mins",
+  "analytics.field.employee_id": "Employees",
+  "analytics.field.payroll_id": "Payroll IDs",
+  "analytics.field.intraday_period_group": "Day Parts",
+  "analytics.field.item_id": "Item",
+  "analytics.field.department_id": "Department",
+  "analytics.field.revenue_class_id": "Revenue Class",
+  "analytics.field.modifier_id": "Modifier",
+  // Common labels
+  "table.total": "Total",
+  "table.groups.sales": "Sales",
+  "table.groups.net-sales": "Net Sales",
+  "table.groups.guests": "Guests",
+  "table.groups.sales-per-guest": "Sales / Guest"
 };
 var en_US_default = enUS3;