@harbortouch/skytab-analytics-report-utils 0.27.0 → 0.29.0

package/dist/{chunk-OJQZXKA5.js → chunk-GZPEIIJK.js}

@@ -681,10 +681,56 @@ var employeeTipConfig = {
   hasFooter: true
 };
 
-// src/reports/dailySales/dailySales.ts
+// src/reports/tipCashoutReconciliation.ts
 var FIELDS10 = {
   groupById: { type: "string" },
-  groupByName: { type: "string", size: FIRST_COLUMN_WIDTH, footerCalculation: { type: "label", label: "table.total" } },
+  groupByName: {
+    type: "string",
+    size: FIRST_COLUMN_WIDTH,
+    footerCalculation: { type: "label", label: "table.total" }
+  },
+  locationName: { type: "string", size: 220, columnKey: "locationName" },
+  employeeName: { type: "string", size: 220, columnKey: "employeeName" },
+  empId: { type: "string", size: 160, columnKey: "employeeId" },
+  payrollId: { type: "string", size: 160, columnKey: "payrollId" },
+  netSales: { type: "money", columnKey: "netSales", footerCalculation: { type: "sum" } },
+  cashCollected: { type: "money", columnKey: "cashCollected", footerCalculation: { type: "sum" } },
+  grossTips: { type: "money", columnKey: "grossTips", footerCalculation: { type: "sum" } },
+  autoGratuity: { type: "money", columnKey: "autoGratuity", footerCalculation: { type: "sum" } },
+  tipReduction: { type: "money", columnKey: "tipReduction", footerCalculation: { type: "sum" } },
+  tipShareContributed: { type: "money", columnKey: "tipShareContributed", footerCalculation: { type: "sum" } },
+  declaredTips: { type: "money", columnKey: "declaredTips", footerCalculation: { type: "sum" } }
+};
+var VISIBLE_COLUMNS2 = [
+  "groupByName",
+  "locationName",
+  "employeeName",
+  "payrollId",
+  "netSales",
+  "cashCollected",
+  "grossTips",
+  "autoGratuity",
+  "tipReduction",
+  "tipShareContributed",
+  "declaredTips"
+];
+var AVAILABLE_COLUMNS2 = ["groupById", "empId", ...VISIBLE_COLUMNS2];
+var tipCashoutReconciliationConfig = {
+  fields: FIELDS10,
+  availableColumns: AVAILABLE_COLUMNS2,
+  defaultVisibleColumns: VISIBLE_COLUMNS2,
+  hasFooter: true
+};
+
+// src/reports/dailySales/dailySales.ts
+var FIELDS11 = {
+  groupById: { type: "string" },
+  groupByName: {
+    type: "string",
+    size: FIRST_COLUMN_WIDTH,
+    columnKey: "revenueClass",
+    footerCalculation: { type: "label", label: "table.total" }
+  },
   itemsQuantity: { type: "number", columnKey: "quantity" },
   salesAmountGross: { type: "money", columnKey: "grossSales" },
   discountsAmount: { type: "money", columnKey: "discountAmount" },
@@ -702,7 +748,7 @@ var DAILY_SALES_AVAILABLE_COLUMNS = [
   "salesMixPct"
 ];
 var dailySalesConfig = {
-  fields: FIELDS10,
+  fields: FIELDS11,
   availableColumns: DAILY_SALES_AVAILABLE_COLUMNS,
   defaultVisibleColumns: DAILY_SALES_AVAILABLE_COLUMNS,
   hasFooter: true,
@@ -712,7 +758,7 @@ var dailySalesConfig = {
 };
 
 // src/reports/dailySales/dailySalesCache.ts
-var FIELDS11 = {
+var FIELDS12 = {
   name: {
     type: "string",
     columnKey: "type",
@@ -722,7 +768,7 @@ var FIELDS11 = {
   amount: { type: "money", columnKey: "paymentsAmount", footerCalculation: { type: "sum" } }
 };
 var dailySalesCacheConfig = {
-  fields: FIELDS11,
+  fields: FIELDS12,
   availableColumns: ["name", "amount"],
   defaultVisibleColumns: ["name", "amount"],
   hasFooter: true,
@@ -731,7 +777,7 @@ var dailySalesCacheConfig = {
 };
 
 // src/reports/dailySales/dailySalesDiscounts.ts
-var FIELDS12 = {
+var FIELDS13 = {
   discountName: {
     type: "string",
     columnKey: "discountName",
@@ -749,7 +795,7 @@ var DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS = [
   "discountsAmount"
 ];
 var dailySalesDiscountsConfig = {
-  fields: FIELDS12,
+  fields: FIELDS13,
   availableColumns: DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS,
   defaultVisibleColumns: DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS,
   hasFooter: true,
@@ -758,7 +804,7 @@ var dailySalesDiscountsConfig = {
 };
 
 // src/reports/dailySales/dailySalesPayments.ts
-var FIELDS13 = {
+var FIELDS14 = {
   paymentTypeName: {
     type: "string",
     size: FIRST_COLUMN_WIDTH,
@@ -778,7 +824,7 @@ var DAILY_SALES_PAYMENTS_AVAILABLE_COLUMNS = [
   "totalSales"
 ];
 var dailySalesPaymentsConfig = {
-  fields: FIELDS13,
+  fields: FIELDS14,
   availableColumns: DAILY_SALES_PAYMENTS_AVAILABLE_COLUMNS,
   defaultVisibleColumns: DAILY_SALES_PAYMENTS_AVAILABLE_COLUMNS,
   hasFooter: true,
@@ -787,7 +833,7 @@ var dailySalesPaymentsConfig = {
 };
 
 // src/reports/dailySales/dailySalesRefundsVoids.ts
-var FIELDS14 = {
+var FIELDS15 = {
   description: {
     type: "string",
     columnKey: "refundVoidDescription",
@@ -805,7 +851,7 @@ var DAILY_SALES_REFUNDS_VOIDS_AVAILABLE_COLUMNS = [
   "pctSales"
 ];
 var dailySalesRefundsVoidsConfig = {
-  fields: FIELDS14,
+  fields: FIELDS15,
   availableColumns: DAILY_SALES_REFUNDS_VOIDS_AVAILABLE_COLUMNS,
   defaultVisibleColumns: DAILY_SALES_REFUNDS_VOIDS_AVAILABLE_COLUMNS,
   hasFooter: true,
@@ -814,7 +860,7 @@ var dailySalesRefundsVoidsConfig = {
 };
 
 // src/reports/dailySales/dailySalesTaxes.ts
-var FIELDS15 = {
+var FIELDS16 = {
   taxName: {
     type: "string",
     columnKey: "taxName",
@@ -832,7 +878,7 @@ var DAILY_SALES_TAXES_AVAILABLE_COLUMNS = [
   "exemptSales"
 ];
 var dailySalesTaxesConfig = {
-  fields: FIELDS15,
+  fields: FIELDS16,
   availableColumns: DAILY_SALES_TAXES_AVAILABLE_COLUMNS,
   defaultVisibleColumns: DAILY_SALES_TAXES_AVAILABLE_COLUMNS,
   hasFooter: true,
@@ -840,11 +886,12 @@ var dailySalesTaxesConfig = {
   sectionName: "common.report-section.taxes"
 };
 
-// src/reports/dailySales/dailySalesTrends.ts
-var FIELDS16 = {
+// src/reports/dailySales/dailySalesTrendsDayPart.ts
+var FIELDS17 = {
   groupById: { type: "string" },
   groupByName: {
     type: "string",
+    columnKey: "daypart",
     size: FIRST_COLUMN_WIDTH,
     footerCalculation: { type: "label", label: "common.report-section.trends-footer.total-sales" }
   },
@@ -878,8 +925,8 @@ var DAILY_SALES_TRENDS_AVAILABLE_COLUMNS = [
   "guestAvg",
   "salesAmountNet"
 ];
-var dailySalesTrendsConfig = {
-  fields: FIELDS16,
+var dailySalesTrendsDayPartConfig = {
+  fields: FIELDS17,
   availableColumns: DAILY_SALES_TRENDS_AVAILABLE_COLUMNS,
   defaultVisibleColumns: DAILY_SALES_TRENDS_AVAILABLE_COLUMNS,
   hasFooter: true,
@@ -887,10 +934,50 @@ var dailySalesTrendsConfig = {
   sectionName: "common.report-section.sales-by-day-part",
   extraFooterFields: ["salesAmountNet"]
 };
+
+// src/reports/dailySales/dailySalesTrendsOrderType.ts
+var FIELDS18 = {
+  groupById: { type: "string" },
+  groupByName: {
+    columnKey: "orderType",
+    type: "string",
+    size: FIRST_COLUMN_WIDTH,
+    footerCalculation: { type: "label", label: "common.report-section.trends-footer.total-sales" }
+  },
+  salesAmountNet: { type: "money", columnKey: "netSales" },
+  ticketsCount: { type: "number", columnKey: "tickets" },
+  guestsCount: { type: "number", columnKey: "guests" },
+  ticketAvg: {
+    type: "money",
+    columnKey: "ticketAverage",
+    footerCalculation: {
+      type: "average",
+      numeratorField: "salesAmountNet",
+      denominatorField: "ticketsCount"
+    }
+  },
+  guestAvg: {
+    type: "money",
+    columnKey: "guestAverage",
+    footerCalculation: {
+      type: "average",
+      numeratorField: "salesAmountNet",
+      denominatorField: "guestsCount"
+    }
+  }
+};
+var DAILY_SALES_TRENDS_AVAILABLE_COLUMNS2 = [
+  "groupByName",
+  "ticketsCount",
+  "guestsCount",
+  "ticketAvg",
+  "guestAvg",
+  "salesAmountNet"
+];
 var dailySalesTrendsOrderTypeConfig = {
-  fields: FIELDS16,
-  availableColumns: DAILY_SALES_TRENDS_AVAILABLE_COLUMNS,
-  defaultVisibleColumns: DAILY_SALES_TRENDS_AVAILABLE_COLUMNS,
+  fields: FIELDS18,
+  availableColumns: DAILY_SALES_TRENDS_AVAILABLE_COLUMNS2,
+  defaultVisibleColumns: DAILY_SALES_TRENDS_AVAILABLE_COLUMNS2,
   hasFooter: true,
   dataAccessKey: "trendsByOrderType",
   sectionName: "common.report-section.sales-by-order-type",
@@ -907,6 +994,7 @@ var Report = {
   ITEM_TAX: "item-tax",
   EMPLOYEE_TIMECARD: "employee-timecard",
   EMPLOYEE_TIP: "employee-tip",
+  TIP_CASHOUT_RECONCILIATION: "tip-cashout-reconciliation",
   SALES_BY_ITEM: "sales-by-item",
   DAILY_SALES: "daily-sales",
   DAILY_SALES_LIVE: "daily-sales-live"
@@ -918,7 +1006,7 @@ var DAILY_SALES_SECTION_CONFIGS = [
   dailySalesTaxesConfig,
   dailySalesRefundsVoidsConfig,
   dailySalesDiscountsConfig,
-  dailySalesTrendsConfig,
+  dailySalesTrendsDayPartConfig,
   dailySalesTrendsOrderTypeConfig
 ];
 var REPORT_CONFIG_MAP = {
@@ -930,6 +1018,7 @@ var REPORT_CONFIG_MAP = {
   "item-tax": itemTaxConfig,
   "employee-timecard": employeeTimecardConfig,
   "employee-tip": employeeTipConfig,
+  "tip-cashout-reconciliation": tipCashoutReconciliationConfig,
   "sales-by-item": salesByItemDetailConfig,
   "daily-sales": DAILY_SALES_SECTION_CONFIGS,
   "daily-sales-live": DAILY_SALES_SECTION_CONFIGS
@@ -943,6 +1032,7 @@ var REPORT_DEFAULT_NAME_MAP = {
   "item-tax": "Sales Tax by Item",
   "employee-timecard": "Employee Timecard",
   "employee-tip": "Employee Tip",
+  "tip-cashout-reconciliation": "Tip & Cashout Reconciliation",
   "sales-by-item": "Sales by Item",
   "daily-sales": "Daily Sales",
   "daily-sales-live": "Daily Sales Live"
@@ -1027,6 +1117,11 @@ var COLUMN_REGISTRY = {
     shortTitleKey: "common.report-col.batch-number.short",
     infoTextKey: "common.report-col.batch-number.info"
   },
+  cashCollected: {
+    titleKey: "common.report-col.cash-collected",
+    shortTitleKey: "common.report-col.cash-collected.short",
+    infoTextKey: "common.report-col.cash-collected.info"
+  },
   clockInTime: {
     titleKey: "common.report-col.clock-in-time",
     shortTitleKey: "common.report-col.clock-in-time.short",
@@ -1507,6 +1602,11 @@ var COLUMN_REGISTRY = {
     shortTitleKey: "common.report-col.tip-share.short",
     infoTextKey: "common.report-col.tip-share.info"
   },
+  tipShareContributed: {
+    titleKey: "common.report-col.tip-share-contributed",
+    shortTitleKey: "common.report-col.tip-share-contributed.short",
+    infoTextKey: "common.report-col.tip-share-contributed.info"
+  },
   tips: {
     titleKey: "common.report-col.tips",
     shortTitleKey: "common.report-col.tips.short",
@@ -1798,6 +1898,9 @@ var enUS = {
   "common.report-col.batch-number": false,
   "common.report-col.batch-number.short": false,
   "common.report-col.batch-number.info": false,
+  "common.report-col.cash-collected": false,
+  "common.report-col.cash-collected.short": false,
+  "common.report-col.cash-collected.info": false,
   "common.report-col.clock-in-time": false,
   "common.report-col.clock-in-time.short": false,
   "common.report-col.clock-in-time.info": false,
@@ -2107,6 +2210,9 @@ var enUS = {
   "common.report-col.tip-share": false,
   "common.report-col.tip-share.short": false,
   "common.report-col.tip-share.info": false,
+  "common.report-col.tip-share-contributed": false,
+  "common.report-col.tip-share-contributed.short": false,
+  "common.report-col.tip-share-contributed.info": false,
   "common.report-col.tips": false,
   "common.report-col.tips.short": false,
   "common.report-col.tips.info": false,
@@ -2285,6 +2391,9 @@ var enUS2 = {
   "common.report-col.batch-number": false,
   "common.report-col.batch-number.short": false,
   "common.report-col.batch-number.info": false,
+  "common.report-col.cash-collected": false,
+  "common.report-col.cash-collected.short": false,
+  "common.report-col.cash-collected.info": false,
   "common.report-col.clock-in-time": false,
   "common.report-col.clock-in-time.short": false,
   "common.report-col.clock-in-time.info": false,
@@ -2594,6 +2703,9 @@ var enUS2 = {
   "common.report-col.tip-share": false,
   "common.report-col.tip-share.short": false,
   "common.report-col.tip-share.info": false,
+  "common.report-col.tip-share-contributed": false,
+  "common.report-col.tip-share-contributed.short": false,
+  "common.report-col.tip-share-contributed.info": false,
   "common.report-col.tips": false,
   "common.report-col.tips.short": false,
   "common.report-col.tips.info": false,
@@ -2772,6 +2884,9 @@ var enUS3 = {
   "common.report-col.batch-number": "Batch Number",
   "common.report-col.batch-number.short": "Batch No",
   "common.report-col.batch-number.info": "The system-generated number used to track this batch of transactions",
+  "common.report-col.cash-collected": "Cash Collected",
+  "common.report-col.cash-collected.short": "Cash Collected",
+  "common.report-col.cash-collected.info": "Total cash collected by the employee",
   "common.report-col.clock-in-time": "Clock-In Time",
   "common.report-col.clock-in-time.short": "In Time",
   "common.report-col.clock-in-time.info": "Actual time the employee clocked in",
@@ -3081,6 +3196,9 @@ var enUS3 = {
   "common.report-col.tip-share": "Tip Share",
   "common.report-col.tip-share.short": "Tip Share",
   "common.report-col.tip-share.info": "Tips distributed to other employees",
+  "common.report-col.tip-share-contributed": "Tip Share Contributed",
+  "common.report-col.tip-share-contributed.short": "Tip Share Contrib",
+  "common.report-col.tip-share-contributed.info": "Tips contributed by this employee to the tip share pool",
   "common.report-col.tips": "Tips",
   "common.report-col.tips.short": "Tips",
   "common.report-col.tips.info": "Total tips received for the ticket",
@@ -3171,11 +3289,11 @@ var enUS3 = {
   "common.report-col.type": "Type",
   "common.report-col.type.short": "Type",
   "common.report-col.type.info": " ",
-  "common.report-section.revenue-class": "Revenue Class",
+  "common.report-section.revenue-class": "Sales by 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.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",
@@ -3397,13 +3515,14 @@ export {
   itemTaxConfig,
   employeeTimecardConfig,
   employeeTipConfig,
+  tipCashoutReconciliationConfig,
   dailySalesConfig,
   dailySalesCacheConfig,
   dailySalesDiscountsConfig,
   dailySalesPaymentsConfig,
   dailySalesRefundsVoidsConfig,
   dailySalesTaxesConfig,
-  dailySalesTrendsConfig,
+  dailySalesTrendsDayPartConfig,
   dailySalesTrendsOrderTypeConfig,
   Report,
   getReportConfig,

package/dist/exporters/excel/index.cjs

@@ -52,8 +52,8 @@ var ExcelExporter = class {
   async generate(content) {
     const workbook = new import_exceljs.default.Workbook();
     const usedNames = /* @__PURE__ */ new Set();
-    for (const section of content.sections) {
-      let sheetName = section.sheetName.slice(0, 31);
+    for (const [sectionIndex, section] of content.sections.entries()) {
+      let sheetName = (section.title || `Sheet${sectionIndex + 1}`).slice(0, 31);
       if (usedNames.has(sheetName.toLowerCase())) {
         let suffix = 2;
         let candidate = `${sheetName.slice(0, 28)}_${suffix}`;

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

@@ -1,15 +1,10 @@
-import { E as ExportTable, a as ExportFilter } from '../../types-BzLsgnfc.cjs';
-export { b as XlsxTableColumn } from '../../types-BzLsgnfc.cjs';
+import { E as ExportSection } from '../../types-BPT5hjCR.cjs';
+export { a as XlsxFilter, b as XlsxTable, c as XlsxTableColumn } from '../../types-BPT5hjCR.cjs';
 
-interface XlsxDocumentSection {
-    sheetName: string;
-    table?: ExportTable;
-    filters?: ExportFilter[];
-}
 declare class ExcelExporter {
     generate(content: {
-        sections: XlsxDocumentSection[];
+        sections: ExportSection[];
     }): Promise<Buffer>;
 }
 
-export { ExcelExporter, type XlsxDocumentSection, ExportFilter as XlsxFilter, ExportTable as XlsxTable };
+export { ExcelExporter, ExportSection as XlsxSection };

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

@@ -1,15 +1,10 @@
-import { E as ExportTable, a as ExportFilter } from '../../types-BzLsgnfc.js';
-export { b as XlsxTableColumn } from '../../types-BzLsgnfc.js';
+import { E as ExportSection } from '../../types-BPT5hjCR.js';
+export { a as XlsxFilter, b as XlsxTable, c as XlsxTableColumn } from '../../types-BPT5hjCR.js';
 
-interface XlsxDocumentSection {
-    sheetName: string;
-    table?: ExportTable;
-    filters?: ExportFilter[];
-}
 declare class ExcelExporter {
     generate(content: {
-        sections: XlsxDocumentSection[];
+        sections: ExportSection[];
     }): Promise<Buffer>;
 }
 
-export { ExcelExporter, type XlsxDocumentSection, ExportFilter as XlsxFilter, ExportTable as XlsxTable };
+export { ExcelExporter, ExportSection as XlsxSection };

package/dist/exporters/excel/index.js

@@ -18,8 +18,8 @@ var ExcelExporter = class {
   async generate(content) {
     const workbook = new ExcelJS.Workbook();
     const usedNames = /* @__PURE__ */ new Set();
-    for (const section of content.sections) {
-      let sheetName = section.sheetName.slice(0, 31);
+    for (const [sectionIndex, section] of content.sections.entries()) {
+      let sheetName = (section.title || `Sheet${sectionIndex + 1}`).slice(0, 31);
       if (usedNames.has(sheetName.toLowerCase())) {
         let suffix = 2;
         let candidate = `${sheetName.slice(0, 28)}_${suffix}`;