@harbortouch/skytab-analytics-report-utils 0.36.0 → 0.38.0

package/dist/index.cjs

@@ -62,6 +62,7 @@ __export(index_exports, {
   isNumericType: () => isNumericType,
   itemTaxConfig: () => itemTaxConfig,
   modifierMixConfig: () => modifierMixConfig,
+  payrollConfig: () => payrollConfig,
   productMixConfig: () => productMixConfig,
   resolveTranslate: () => resolveTranslate,
   salesByItemDetailConfig: () => salesByItemDetailConfig,
@@ -150,9 +151,52 @@ var FIELDS2 = {
   },
   salesAmountNetLastWeek: { type: "money" },
   salesAmountNetLastYear: { type: "money" },
-  salesAmountGross: { type: "money" },
+  salesAmountGross: { type: "money", columnKey: "grossSales" },
   salesAmountGrossLastWeek: { type: "money" },
   salesAmountGrossLastYear: { type: "money" },
+  grossVarLW: { type: "money", columnKey: "salesVarLw" },
+  grossVarLY: { type: "money", columnKey: "salesVarLy" },
+  grossVarLWPct: {
+    type: "percent",
+    columnKey: "salesVarLwPct",
+    footerCalculation: {
+      type: "variancePercent",
+      numeratorField: "grossVarLW",
+      denominatorField: "salesAmountGross"
+    }
+  },
+  grossVarLYPct: {
+    type: "percent",
+    columnKey: "salesVarLyPct",
+    footerCalculation: {
+      type: "variancePercent",
+      numeratorField: "grossVarLY",
+      denominatorField: "salesAmountGross"
+    }
+  },
+  taxesAmount: { type: "money", columnKey: "taxCollected" },
+  taxesAmountLastWeek: { type: "money" },
+  taxesAmountLastYear: { type: "money" },
+  taxesVarLW: { type: "money", columnKey: "salesVarLw" },
+  taxesVarLY: { type: "money", columnKey: "salesVarLy" },
+  taxesVarLWPct: {
+    type: "percent",
+    columnKey: "salesVarLwPct",
+    footerCalculation: {
+      type: "variancePercent",
+      numeratorField: "taxesVarLW",
+      denominatorField: "taxesAmount"
+    }
+  },
+  taxesVarLYPct: {
+    type: "percent",
+    columnKey: "salesVarLyPct",
+    footerCalculation: {
+      type: "variancePercent",
+      numeratorField: "taxesVarLY",
+      denominatorField: "taxesAmount"
+    }
+  },
   ticketsCount: { type: "number" },
   ticketsCountLastWeek: { type: "number" },
   ticketsCountLastYear: { type: "number" },
@@ -214,11 +258,25 @@ var FIELDS2 = {
 var COLUMN_GROUPS = [
   {
     id: "sales",
-    headerTranslationKey: "table.groups.sales",
+    headerTranslationKey: "table.groups.net-sales",
     baseFields: ["salesAmountNet"],
     lastWeekFields: ["salesVarLW", "salesVarLWPct"],
     lastYearFields: ["salesVarLY", "salesVarLYPct"]
   },
+  {
+    id: "grossSales",
+    headerTranslationKey: "table.groups.gross-sales",
+    baseFields: ["salesAmountGross"],
+    lastWeekFields: ["grossVarLW", "grossVarLWPct"],
+    lastYearFields: ["grossVarLY", "grossVarLYPct"]
+  },
+  {
+    id: "taxes",
+    headerTranslationKey: "table.groups.taxes",
+    baseFields: ["taxesAmount"],
+    lastWeekFields: ["taxesVarLW", "taxesVarLWPct"],
+    lastYearFields: ["taxesVarLY", "taxesVarLYPct"]
+  },
   {
     id: "guests",
     headerTranslationKey: "table.groups.guests",
@@ -240,6 +298,16 @@ var SALES_SUMMARY_DEFAULT_VISIBLE_COLUMNS = [
   "salesVarLWPct",
   "salesVarLY",
   "salesVarLYPct",
+  "salesAmountGross",
+  "grossVarLW",
+  "grossVarLWPct",
+  "grossVarLY",
+  "grossVarLYPct",
+  "taxesAmount",
+  "taxesVarLW",
+  "taxesVarLWPct",
+  "taxesVarLY",
+  "taxesVarLYPct",
   "guestsCount",
   "guestsVarLW",
   "guestsVarLWPct",
@@ -1051,6 +1119,33 @@ var enUS = {
   "common.report-col.type": false,
   "common.report-col.type.short": false,
   "common.report-col.type.info": false,
+  "common.report-col.paid-normal-hours": false,
+  "common.report-col.paid-normal-hours.short": false,
+  "common.report-col.paid-normal-hours.info": false,
+  "common.report-col.normal-pay": false,
+  "common.report-col.normal-pay.short": false,
+  "common.report-col.normal-pay.info": false,
+  "common.report-col.overtime-pay": false,
+  "common.report-col.overtime-pay.short": false,
+  "common.report-col.overtime-pay.info": false,
+  "common.report-col.double-overtime-pay": false,
+  "common.report-col.double-overtime-pay.short": false,
+  "common.report-col.double-overtime-pay.info": false,
+  "common.report-col.gratuity": false,
+  "common.report-col.gratuity.short": false,
+  "common.report-col.gratuity.info": false,
+  "common.report-col.tip-paid-status": false,
+  "common.report-col.tip-paid-status.short": false,
+  "common.report-col.tip-paid-status.info": false,
+  "common.report-col.total-payments": false,
+  "common.report-col.total-payments.short": false,
+  "common.report-col.total-payments.info": false,
+  "common.report-col.minimum-wage-adjustment": false,
+  "common.report-col.minimum-wage-adjustment.short": false,
+  "common.report-col.minimum-wage-adjustment.info": false,
+  "common.report-col.total-pay": false,
+  "common.report-col.total-pay.short": false,
+  "common.report-col.total-pay.info": false,
   "common.report-section.revenue-class": false,
   "common.report-section.payments": false,
   "common.report-section.cash": false,
@@ -1095,6 +1190,8 @@ var enUS = {
   "table.total": false,
   "table.groups.sales": false,
   "table.groups.net-sales": false,
+  "table.groups.taxes": false,
+  "table.groups.gross-sales": false,
   "table.groups.guests": false,
   "table.groups.sales-per-guest": false,
   "employee-timecard.status.active": false,
@@ -1546,6 +1643,33 @@ var enUS2 = {
   "common.report-col.type": false,
   "common.report-col.type.short": false,
   "common.report-col.type.info": false,
+  "common.report-col.paid-normal-hours": false,
+  "common.report-col.paid-normal-hours.short": false,
+  "common.report-col.paid-normal-hours.info": false,
+  "common.report-col.normal-pay": false,
+  "common.report-col.normal-pay.short": false,
+  "common.report-col.normal-pay.info": false,
+  "common.report-col.overtime-pay": false,
+  "common.report-col.overtime-pay.short": false,
+  "common.report-col.overtime-pay.info": false,
+  "common.report-col.double-overtime-pay": false,
+  "common.report-col.double-overtime-pay.short": false,
+  "common.report-col.double-overtime-pay.info": false,
+  "common.report-col.gratuity": false,
+  "common.report-col.gratuity.short": false,
+  "common.report-col.gratuity.info": false,
+  "common.report-col.tip-paid-status": false,
+  "common.report-col.tip-paid-status.short": false,
+  "common.report-col.tip-paid-status.info": false,
+  "common.report-col.total-payments": false,
+  "common.report-col.total-payments.short": false,
+  "common.report-col.total-payments.info": false,
+  "common.report-col.minimum-wage-adjustment": false,
+  "common.report-col.minimum-wage-adjustment.short": false,
+  "common.report-col.minimum-wage-adjustment.info": false,
+  "common.report-col.total-pay": false,
+  "common.report-col.total-pay.short": false,
+  "common.report-col.total-pay.info": false,
   "common.report-section.revenue-class": false,
   "common.report-section.payments": false,
   "common.report-section.cash": false,
@@ -1590,6 +1714,8 @@ var enUS2 = {
   "table.total": false,
   "table.groups.sales": false,
   "table.groups.net-sales": false,
+  "table.groups.taxes": false,
+  "table.groups.gross-sales": false,
   "table.groups.guests": false,
   "table.groups.sales-per-guest": false,
   "employee-timecard.status.active": false,
@@ -2041,6 +2167,33 @@ var enUS3 = {
   "common.report-col.type": "Type",
   "common.report-col.type.short": "Type",
   "common.report-col.type.info": " ",
+  "common.report-col.paid-normal-hours": "Paid Normal Hours",
+  "common.report-col.paid-normal-hours.short": "Norm Hrs",
+  "common.report-col.paid-normal-hours.info": "Total regular hours paid for the period",
+  "common.report-col.normal-pay": "Normal Pay",
+  "common.report-col.normal-pay.short": "Norm Pay",
+  "common.report-col.normal-pay.info": "Wages earned for regular hours worked",
+  "common.report-col.overtime-pay": "Overtime Pay",
+  "common.report-col.overtime-pay.short": "OT Pay",
+  "common.report-col.overtime-pay.info": "Wages earned for overtime hours worked",
+  "common.report-col.double-overtime-pay": "Double Overtime Pay",
+  "common.report-col.double-overtime-pay.short": "DT Pay",
+  "common.report-col.double-overtime-pay.info": "Wages earned for double-overtime hours worked",
+  "common.report-col.gratuity": "Gratuity",
+  "common.report-col.gratuity.short": "Gratuity",
+  "common.report-col.gratuity.info": "Gratuity amounts included in the payroll period",
+  "common.report-col.tip-paid-status": "Tip Paid Status",
+  "common.report-col.tip-paid-status.short": "Tip Status",
+  "common.report-col.tip-paid-status.info": "Indicates whether tips were paid out daily or deferred to payroll",
+  "common.report-col.total-payments": "Total Payments",
+  "common.report-col.total-payments.short": "Total Pmts",
+  "common.report-col.total-payments.info": "Total payments collected for the payroll period",
+  "common.report-col.minimum-wage-adjustment": "Minimum Wage Adjustment",
+  "common.report-col.minimum-wage-adjustment.short": "Min Wage Adj",
+  "common.report-col.minimum-wage-adjustment.info": "Adjustment applied to meet minimum wage requirements",
+  "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-section.revenue-class": "Sales by Revenue Class",
   "common.report-section.payments": "Payments",
   "common.report-section.cash": "Expected Closeout Cash",
@@ -2085,8 +2238,10 @@ var enUS3 = {
   "table.total": "Total",
   "table.groups.sales": "Sales",
   "table.groups.net-sales": "Net Sales",
+  "table.groups.taxes": "Tax",
+  "table.groups.gross-sales": "Gross Sales",
   "table.groups.guests": "Guests",
-  "table.groups.sales-per-guest": "Sales / Guest",
+  "table.groups.sales-per-guest": "Sales/Guest",
   "employee-timecard.status.active": "Active",
   "employee-timecard.status.inactive": "Inactive",
   "employee-timecard.job.break-suffix": " * break"
@@ -2312,8 +2467,68 @@ var tipCashoutReconciliationConfig = {
   hasFooter: true
 };
 
-// src/reports/dailySales/dailySales.ts
+// src/reports/payroll.ts
 var FIELDS11 = {
+  groupById: { type: "string" },
+  groupByName: { type: "string" },
+  rowType: { type: "string" },
+  locationName: { type: "string", size: 220, columnKey: "locationName" },
+  employeeName: { type: "string", size: 220, columnKey: "employeeName" },
+  empId: {
+    type: "string",
+    size: 160,
+    columnKey: "employeeId",
+    footerCalculation: { type: "label", label: "table.total" }
+  },
+  payrollId: { type: "string", size: 160, columnKey: "payrollId" },
+  jobName: { type: "string", size: 160, columnKey: "employeeJob" },
+  paidNormalHours: { type: "number", columnKey: "paidNormalHours", footerCalculation: { type: "sum" } },
+  normalPay: { type: "money", columnKey: "normalPay", footerCalculation: { type: "sum" } },
+  overtimePay: { type: "money", columnKey: "overtimePay", footerCalculation: { type: "sum" } },
+  doubleOvertimePay: { type: "money", columnKey: "doubleOvertimePay", footerCalculation: { type: "sum" } },
+  grossTips: { type: "money", columnKey: "grossTips", footerCalculation: { type: "sum" } },
+  gratuity: { type: "money", columnKey: "gratuity", footerCalculation: { type: "sum" } },
+  totalTips: { type: "money", columnKey: "totalTips", footerCalculation: { type: "sum" } },
+  tipReduction: { type: "money", columnKey: "tipReduction", footerCalculation: { type: "sum" } },
+  tipShare: { type: "money", columnKey: "tipShare", footerCalculation: { type: "sum" } },
+  netTips: { type: "money", columnKey: "netTips", footerCalculation: { type: "sum" } },
+  declaredTips: { type: "money", columnKey: "declaredTips", footerCalculation: { type: "sum" } },
+  tipPaidStatus: { type: "string", size: 160, columnKey: "tipPaidStatus" },
+  totalPayments: { type: "money", columnKey: "totalPayments", footerCalculation: { type: "sum" } },
+  minimumWageAdjustment: { type: "money", columnKey: "minimumWageAdjustment", footerCalculation: { type: "sum" } },
+  totalPay: { type: "money", columnKey: "totalPay", footerCalculation: { type: "sum" } }
+};
+var VISIBLE_COLUMNS3 = [
+  "employeeName",
+  "payrollId",
+  "locationName",
+  "jobName",
+  "paidNormalHours",
+  "normalPay",
+  "overtimePay",
+  "doubleOvertimePay",
+  "grossTips",
+  "gratuity",
+  "totalTips",
+  "tipReduction",
+  "tipShare",
+  "netTips",
+  "declaredTips",
+  "tipPaidStatus",
+  "totalPayments",
+  "minimumWageAdjustment",
+  "totalPay"
+];
+var AVAILABLE_COLUMNS3 = ["groupById", "groupByName", "rowType", "empId", ...VISIBLE_COLUMNS3];
+var payrollConfig = {
+  fields: FIELDS11,
+  availableColumns: AVAILABLE_COLUMNS3,
+  defaultVisibleColumns: VISIBLE_COLUMNS3,
+  hasFooter: true
+};
+
+// src/reports/dailySales/dailySales.ts
+var FIELDS12 = {
   groupById: { type: "string" },
   groupByName: {
     type: "string",
@@ -2338,7 +2553,7 @@ var DAILY_SALES_AVAILABLE_COLUMNS = [
   "salesMixPct"
 ];
 var dailySalesConfig = {
-  fields: FIELDS11,
+  fields: FIELDS12,
   availableColumns: DAILY_SALES_AVAILABLE_COLUMNS,
   defaultVisibleColumns: DAILY_SALES_AVAILABLE_COLUMNS,
   hasFooter: true,
@@ -2348,7 +2563,7 @@ var dailySalesConfig = {
 };
 
 // src/reports/dailySales/dailySalesCache.ts
-var FIELDS12 = {
+var FIELDS13 = {
   name: {
     type: "string",
     columnKey: "type",
@@ -2358,7 +2573,7 @@ var FIELDS12 = {
   amount: { type: "money", columnKey: "paymentsAmount", footerCalculation: { type: "sum" } }
 };
 var dailySalesCacheConfig = {
-  fields: FIELDS12,
+  fields: FIELDS13,
   availableColumns: ["name", "amount"],
   defaultVisibleColumns: ["name", "amount"],
   hasFooter: true,
@@ -2367,7 +2582,7 @@ var dailySalesCacheConfig = {
 };
 
 // src/reports/dailySales/dailySalesDiscounts.ts
-var FIELDS13 = {
+var FIELDS14 = {
   discountName: {
     type: "string",
     columnKey: "discountName",
@@ -2385,7 +2600,7 @@ var DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS = [
   "discountsAmount"
 ];
 var dailySalesDiscountsConfig = {
-  fields: FIELDS13,
+  fields: FIELDS14,
   availableColumns: DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS,
   defaultVisibleColumns: DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS,
   hasFooter: true,
@@ -2394,7 +2609,7 @@ var dailySalesDiscountsConfig = {
 };
 
 // src/reports/dailySales/dailySalesPayments.ts
-var FIELDS14 = {
+var FIELDS15 = {
   paymentTypeName: {
     type: "string",
     size: FIRST_COLUMN_WIDTH,
@@ -2414,7 +2629,7 @@ var DAILY_SALES_PAYMENTS_AVAILABLE_COLUMNS = [
   "totalSales"
 ];
 var dailySalesPaymentsConfig = {
-  fields: FIELDS14,
+  fields: FIELDS15,
   availableColumns: DAILY_SALES_PAYMENTS_AVAILABLE_COLUMNS,
   defaultVisibleColumns: DAILY_SALES_PAYMENTS_AVAILABLE_COLUMNS,
   hasFooter: true,
@@ -2423,7 +2638,7 @@ var dailySalesPaymentsConfig = {
 };
 
 // src/reports/dailySales/dailySalesRefundsVoids.ts
-var FIELDS15 = {
+var FIELDS16 = {
   description: {
     type: "string",
     columnKey: "refundVoidDescription",
@@ -2441,7 +2656,7 @@ var DAILY_SALES_REFUNDS_VOIDS_AVAILABLE_COLUMNS = [
   "pctSales"
 ];
 var dailySalesRefundsVoidsConfig = {
-  fields: FIELDS15,
+  fields: FIELDS16,
   availableColumns: DAILY_SALES_REFUNDS_VOIDS_AVAILABLE_COLUMNS,
   defaultVisibleColumns: DAILY_SALES_REFUNDS_VOIDS_AVAILABLE_COLUMNS,
   hasFooter: true,
@@ -2450,7 +2665,7 @@ var dailySalesRefundsVoidsConfig = {
 };
 
 // src/reports/dailySales/dailySalesTaxes.ts
-var FIELDS16 = {
+var FIELDS17 = {
   taxName: {
     type: "string",
     columnKey: "taxName",
@@ -2468,7 +2683,7 @@ var DAILY_SALES_TAXES_AVAILABLE_COLUMNS = [
   "exemptSales"
 ];
 var dailySalesTaxesConfig = {
-  fields: FIELDS16,
+  fields: FIELDS17,
   availableColumns: DAILY_SALES_TAXES_AVAILABLE_COLUMNS,
   defaultVisibleColumns: DAILY_SALES_TAXES_AVAILABLE_COLUMNS,
   hasFooter: true,
@@ -2477,7 +2692,7 @@ var dailySalesTaxesConfig = {
 };
 
 // src/reports/dailySales/dailySalesTrendsDayPart.ts
-var FIELDS17 = {
+var FIELDS18 = {
   groupById: { type: "string" },
   groupByName: {
     type: "string",
@@ -2516,7 +2731,7 @@ var DAILY_SALES_TRENDS_AVAILABLE_COLUMNS = [
   "salesAmountNet"
 ];
 var dailySalesTrendsDayPartConfig = {
-  fields: FIELDS17,
+  fields: FIELDS18,
   availableColumns: DAILY_SALES_TRENDS_AVAILABLE_COLUMNS,
   defaultVisibleColumns: DAILY_SALES_TRENDS_AVAILABLE_COLUMNS,
   hasFooter: true,
@@ -2525,7 +2740,7 @@ var dailySalesTrendsDayPartConfig = {
 };
 
 // src/reports/dailySales/dailySalesTrendsOrderType.ts
-var FIELDS18 = {
+var FIELDS19 = {
   groupById: { type: "string" },
   groupByName: {
     columnKey: "orderType",
@@ -2564,7 +2779,7 @@ var DAILY_SALES_TRENDS_AVAILABLE_COLUMNS2 = [
   "salesAmountNet"
 ];
 var dailySalesTrendsOrderTypeConfig = {
-  fields: FIELDS18,
+  fields: FIELDS19,
   availableColumns: DAILY_SALES_TRENDS_AVAILABLE_COLUMNS2,
   defaultVisibleColumns: DAILY_SALES_TRENDS_AVAILABLE_COLUMNS2,
   hasFooter: true,
@@ -2583,6 +2798,7 @@ var Report = {
   EMPLOYEE_TIMECARD: "employee-timecard",
   EMPLOYEE_TIP: "employee-tip",
   TIP_CASHOUT_RECONCILIATION: "tip-cashout-reconciliation",
+  PAYROLL: "payroll",
   SALES_BY_ITEM: "sales-by-item",
   DAILY_SALES: "daily-sales",
   DAILY_SALES_LIVE: "daily-sales-live"
@@ -2607,6 +2823,7 @@ var REPORT_CONFIG_MAP = {
   "employee-timecard": employeeTimecardConfig,
   "employee-tip": employeeTipConfig,
   "tip-cashout-reconciliation": tipCashoutReconciliationConfig,
+  payroll: payrollConfig,
   "sales-by-item": salesByItemDetailConfig,
   "daily-sales": DAILY_SALES_SECTION_CONFIGS,
   "daily-sales-live": DAILY_SALES_SECTION_CONFIGS
@@ -2621,6 +2838,7 @@ var REPORT_DEFAULT_NAME_MAP = {
   "employee-timecard": "Employee Timecard",
   "employee-tip": "Employee Tip",
   "tip-cashout-reconciliation": "Tip & Cashout Reconciliation",
+  payroll: "Payroll",
   "sales-by-item": "Sales by Item",
   "daily-sales": "Daily Sales",
   "daily-sales-live": "Daily Sales Live"
@@ -3389,6 +3607,51 @@ var COLUMN_REGISTRY = {
     titleKey: "common.report-col.type",
     shortTitleKey: "common.report-col.type.short",
     infoTextKey: "common.report-col.type.info"
+  },
+  paidNormalHours: {
+    titleKey: "common.report-col.paid-normal-hours",
+    shortTitleKey: "common.report-col.paid-normal-hours.short",
+    infoTextKey: "common.report-col.paid-normal-hours.info"
+  },
+  normalPay: {
+    titleKey: "common.report-col.normal-pay",
+    shortTitleKey: "common.report-col.normal-pay.short",
+    infoTextKey: "common.report-col.normal-pay.info"
+  },
+  overtimePay: {
+    titleKey: "common.report-col.overtime-pay",
+    shortTitleKey: "common.report-col.overtime-pay.short",
+    infoTextKey: "common.report-col.overtime-pay.info"
+  },
+  doubleOvertimePay: {
+    titleKey: "common.report-col.double-overtime-pay",
+    shortTitleKey: "common.report-col.double-overtime-pay.short",
+    infoTextKey: "common.report-col.double-overtime-pay.info"
+  },
+  gratuity: {
+    titleKey: "common.report-col.gratuity",
+    shortTitleKey: "common.report-col.gratuity.short",
+    infoTextKey: "common.report-col.gratuity.info"
+  },
+  tipPaidStatus: {
+    titleKey: "common.report-col.tip-paid-status",
+    shortTitleKey: "common.report-col.tip-paid-status.short",
+    infoTextKey: "common.report-col.tip-paid-status.info"
+  },
+  totalPayments: {
+    titleKey: "common.report-col.total-payments",
+    shortTitleKey: "common.report-col.total-payments.short",
+    infoTextKey: "common.report-col.total-payments.info"
+  },
+  minimumWageAdjustment: {
+    titleKey: "common.report-col.minimum-wage-adjustment",
+    shortTitleKey: "common.report-col.minimum-wage-adjustment.short",
+    infoTextKey: "common.report-col.minimum-wage-adjustment.info"
+  },
+  totalPay: {
+    titleKey: "common.report-col.total-pay",
+    shortTitleKey: "common.report-col.total-pay.short",
+    infoTextKey: "common.report-col.total-pay.info"
   }
 };
 function getColumnMetadata(key) {
@@ -3396,6 +3659,9 @@ function getColumnMetadata(key) {
 }
 function getColumnExportHeaderLabel(colTitle, groupTitle) {
   if (groupTitle) {
+    if (groupTitle === colTitle) {
+      return colTitle;
+    }
     return `${groupTitle}: ${colTitle}`;
   }
   return colTitle;
@@ -3844,6 +4110,7 @@ var formatFieldValue = (value, type, localeOptions, fullRecord, fieldConfig = DE
   isNumericType,
   itemTaxConfig,
   modifierMixConfig,
+  payrollConfig,
   productMixConfig,
   resolveTranslate,
   salesByItemDetailConfig,