@harbortouch/skytab-analytics-report-utils 0.4.3 → 0.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/columns/index.d.ts +1 -1
  2. package/dist/index.cjs +30 -5
  3. package/dist/index.js +30 -5
  4. package/package.json +1 -1
package/dist/columns/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export type ReportColumnKey = 'fifteenMinInterval' | 'adjustedTips' | 'advantageProgram' | 'amex' | 'amexReturns' | 'attachRate' | 'autoGratuity' | 'averageGrossPrice' | 'bankFees' | 'batchAmount' | 'batchDate' | 'batchNumber' | 'clockInTime' | 'clockOutTime' | 'country' | 'customerName' | 'date' | 'dateClose' | 'daypart' | 'debit' | 'debitReturns' | 'declaredTips' | 'department' | 'depositCurrency' | 'depositDate' | 'discountAmount' | 'discountCount' | 'discover' | 'discoverReturns' | 'ebt' | 'ebtReturns' | 'employeeId' | 'employeeJob' | 'employeeName' | 'exemptTaxes' | 'grandTotal' | 'grossCashSales' | 'grossCashTips' | 'grossCreditCardTips' | 'grossCreditSales' | 'grossSales' | 'grossTips' | 'guestCount' | 'guestsVarLw' | 'guestsVarLwPct' | 'guestsVarLy' | 'guestsVarLyPct' | 'hour' | 'hoursWorked' | 'inclusiveTax' | 'itemName' | 'itemPrice' | 'locationCity' | 'locationMid' | 'locationName' | 'locationState' | 'mastercard' | 'mcReturns' | 'modifierName' | 'modifierPrice' | 'modifierQuantity' | 'netSales' | 'netTaxCollected' | 'netTips' | 'numberOfGuests' | 'orderType' | 'paymentType' | 'payrollId' | 'quantity' | 'referenceNumber' | 'refundAmount' | 'refundedTaxAmount' | 'revenueCenter' | 'revenueClass' | 'salesVarLw' | 'salesVarLwPct' | 'salesVarLy' | 'salesVarLyPct' | 'salesMixByPct' | 'salesPerGuest' | 'salesPerGuestLw' | 'salesPerGuestLy' | 'scheduledShiftEnd' | 'scheduledShiftStart' | 'settlementBatchDate' | 'shiftDurationHrs' | 'subtotal' | 'taxCollected' | 'taxName' | 'taxRate' | 'taxableSales' | 'ticketClosed' | 'ticketFee' | 'ticketNumber' | 'ticketOpen' | 'ticketTotal' | 'timeOpenMins' | 'tipPct' | 'tipReduction' | 'tipShare' | 'tips' | 'tipsPerHour' | 'totalCollected' | 'totalItemSales' | 'totalModifierSales' | 'totalReturns' | 'totalSales' | 'totalTips' | 'transactionDate' | 'transactionType' | 'untaxedSales' | 'visa' | 'visaReturns' | 'paymentsCount' | 'paymentsAmount' | 'paymentsTotal';
1
+ export type ReportColumnKey = 'fifteenMinInterval' | 'adjustedTips' | 'advantageProgram' | 'amex' | 'amexReturns' | 'attachRate' | 'autoGratuity' | 'averageGrossPrice' | 'bankFees' | 'batchAmount' | 'batchDate' | 'batchNumber' | 'clockInTime' | 'clockOutTime' | 'country' | 'customerName' | 'date' | 'dateClose' | 'daypart' | 'debit' | 'debitReturns' | 'declaredTips' | 'department' | 'depositCurrency' | 'depositDate' | 'discountAmount' | 'discountCount' | 'discover' | 'discoverReturns' | 'ebt' | 'ebtReturns' | 'employeeId' | 'employeeJob' | 'employeeName' | 'exemptTaxes' | 'grandTotal' | 'grossCashSales' | 'grossCashTips' | 'grossCreditCardTips' | 'grossCreditSales' | 'grossSales' | 'grossTips' | 'guestCount' | 'guestsVarLw' | 'guestsVarLwPct' | 'guestsVarLy' | 'guestsVarLyPct' | 'hour' | 'hoursWorked' | 'inclusiveTax' | 'itemName' | 'itemPrice' | 'locationCity' | 'locationMid' | 'locationName' | 'locationState' | 'mastercard' | 'mcReturns' | 'modifierName' | 'modifierPrice' | 'modifierQuantity' | 'netSales' | 'netTaxCollected' | 'netTips' | 'numberOfGuests' | 'orderType' | 'paymentType' | 'payrollId' | 'quantity' | 'referenceNumber' | 'refundAmount' | 'refundedTaxAmount' | 'revenueCenter' | 'revenueClass' | 'salesVarLw' | 'salesVarLwPct' | 'salesVarLy' | 'salesVarLyPct' | 'salesMixByPct' | 'salesPerGuest' | 'salesPerGuestLw' | 'salesPerGuestLy' | 'scheduledShiftEnd' | 'scheduledShiftStart' | 'settlementBatchDate' | 'shiftDurationHrs' | 'subtotal' | 'taxCollected' | 'taxName' | 'taxRate' | 'taxableSales' | 'ticketClosed' | 'ticketFee' | 'ticketNumber' | 'ticketOpen' | 'ticketTotal' | 'timeOpenMins' | 'tipPct' | 'tipReduction' | 'tipShare' | 'tips' | 'tipsPerHour' | 'totalCollected' | 'totalItemSales' | 'totalModifierSales' | 'totalReturns' | 'totalSales' | 'totalTips' | 'transactionDate' | 'transactionType' | 'untaxedSales' | 'visa' | 'visaReturns' | 'paymentsCount' | 'paymentsAmount' | 'paymentsTotal' | 'refundVoidDescription' | 'refundVoidCount' | 'refundVoidAmount' | 'refundVoidPctSales' | 'discountName';
2
2
  export interface ColumnMetadata {
3
3
  titleKey: string;
4
4
  shortTitleKey: string;
package/dist/index.cjs CHANGED
@@ -643,6 +643,31 @@ var COLUMN_REGISTRY = {
643
643
  titleKey: "common.report-col.payments-total",
644
644
  shortTitleKey: "common.report-col.payments-total.short",
645
645
  infoTextKey: "common.report-col.payments-total.info"
646
+ },
647
+ refundVoidDescription: {
648
+ titleKey: "common.report-col.refund-void-description",
649
+ shortTitleKey: "common.report-col.refund-void-description.short",
650
+ infoTextKey: "common.report-col.refund-void-description.info"
651
+ },
652
+ refundVoidCount: {
653
+ titleKey: "common.report-col.refund-void-count",
654
+ shortTitleKey: "common.report-col.refund-void-count.short",
655
+ infoTextKey: "common.report-col.refund-void-count.info"
656
+ },
657
+ refundVoidAmount: {
658
+ titleKey: "common.report-col.refund-void-amount",
659
+ shortTitleKey: "common.report-col.refund-void-amount.short",
660
+ infoTextKey: "common.report-col.refund-void-amount.info"
661
+ },
662
+ refundVoidPctSales: {
663
+ titleKey: "common.report-col.refund-void-pct-sales",
664
+ shortTitleKey: "common.report-col.refund-void-pct-sales.short",
665
+ infoTextKey: "common.report-col.refund-void-pct-sales.info"
666
+ },
667
+ discountName: {
668
+ titleKey: "common.report-col.discount-name",
669
+ shortTitleKey: "common.report-col.discount-name.short",
670
+ infoTextKey: "common.report-col.discount-name.info"
646
671
  }
647
672
  };
648
673
  function getColumnMetadata(key) {
@@ -1230,7 +1255,7 @@ var dailySalesPaymentsConfig = {
1230
1255
  // src/reports/dailySalesDiscounts.ts
1231
1256
  var FIRST_COLUMN_WIDTH6 = 240;
1232
1257
  var FIELDS9 = {
1233
- discountName: { type: "string", size: FIRST_COLUMN_WIDTH6 },
1258
+ discountName: { type: "string", columnKey: "discountName", size: FIRST_COLUMN_WIDTH6 },
1234
1259
  discountsCount: { type: "number", columnKey: "discountCount", footerCalculation: { type: "sum" } },
1235
1260
  discountsAmount: { type: "money", columnKey: "discountAmount", footerCalculation: { type: "sum" } }
1236
1261
  };
@@ -1248,10 +1273,10 @@ var dailySalesDiscountsConfig = {
1248
1273
  // src/reports/dailySalesRefundsVoids.ts
1249
1274
  var FIRST_COLUMN_WIDTH7 = 240;
1250
1275
  var FIELDS10 = {
1251
- description: { type: "string", size: FIRST_COLUMN_WIDTH7 },
1252
- count: { type: "number", footerCalculation: { type: "sum" } },
1253
- amount: { type: "money", footerCalculation: { type: "sum" } },
1254
- pctSales: { type: "percent", footerCalculation: { type: "sum" } }
1276
+ description: { type: "string", columnKey: "refundVoidDescription", size: FIRST_COLUMN_WIDTH7 },
1277
+ count: { type: "number", columnKey: "refundVoidCount", footerCalculation: { type: "sum" } },
1278
+ amount: { type: "money", columnKey: "refundVoidAmount", footerCalculation: { type: "sum" } },
1279
+ pctSales: { type: "percent", columnKey: "refundVoidPctSales", footerCalculation: { type: "sum" } }
1255
1280
  };
1256
1281
  var DAILY_SALES_REFUNDS_VOIDS_AVAILABLE_COLUMNS = [
1257
1282
  "count",
package/dist/index.js CHANGED
@@ -579,6 +579,31 @@ var COLUMN_REGISTRY = {
579
579
  titleKey: "common.report-col.payments-total",
580
580
  shortTitleKey: "common.report-col.payments-total.short",
581
581
  infoTextKey: "common.report-col.payments-total.info"
582
+ },
583
+ refundVoidDescription: {
584
+ titleKey: "common.report-col.refund-void-description",
585
+ shortTitleKey: "common.report-col.refund-void-description.short",
586
+ infoTextKey: "common.report-col.refund-void-description.info"
587
+ },
588
+ refundVoidCount: {
589
+ titleKey: "common.report-col.refund-void-count",
590
+ shortTitleKey: "common.report-col.refund-void-count.short",
591
+ infoTextKey: "common.report-col.refund-void-count.info"
592
+ },
593
+ refundVoidAmount: {
594
+ titleKey: "common.report-col.refund-void-amount",
595
+ shortTitleKey: "common.report-col.refund-void-amount.short",
596
+ infoTextKey: "common.report-col.refund-void-amount.info"
597
+ },
598
+ refundVoidPctSales: {
599
+ titleKey: "common.report-col.refund-void-pct-sales",
600
+ shortTitleKey: "common.report-col.refund-void-pct-sales.short",
601
+ infoTextKey: "common.report-col.refund-void-pct-sales.info"
602
+ },
603
+ discountName: {
604
+ titleKey: "common.report-col.discount-name",
605
+ shortTitleKey: "common.report-col.discount-name.short",
606
+ infoTextKey: "common.report-col.discount-name.info"
582
607
  }
583
608
  };
584
609
  function getColumnMetadata(key) {
@@ -1166,7 +1191,7 @@ var dailySalesPaymentsConfig = {
1166
1191
  // src/reports/dailySalesDiscounts.ts
1167
1192
  var FIRST_COLUMN_WIDTH6 = 240;
1168
1193
  var FIELDS9 = {
1169
- discountName: { type: "string", size: FIRST_COLUMN_WIDTH6 },
1194
+ discountName: { type: "string", columnKey: "discountName", size: FIRST_COLUMN_WIDTH6 },
1170
1195
  discountsCount: { type: "number", columnKey: "discountCount", footerCalculation: { type: "sum" } },
1171
1196
  discountsAmount: { type: "money", columnKey: "discountAmount", footerCalculation: { type: "sum" } }
1172
1197
  };
@@ -1184,10 +1209,10 @@ var dailySalesDiscountsConfig = {
1184
1209
  // src/reports/dailySalesRefundsVoids.ts
1185
1210
  var FIRST_COLUMN_WIDTH7 = 240;
1186
1211
  var FIELDS10 = {
1187
- description: { type: "string", size: FIRST_COLUMN_WIDTH7 },
1188
- count: { type: "number", footerCalculation: { type: "sum" } },
1189
- amount: { type: "money", footerCalculation: { type: "sum" } },
1190
- pctSales: { type: "percent", footerCalculation: { type: "sum" } }
1212
+ description: { type: "string", columnKey: "refundVoidDescription", size: FIRST_COLUMN_WIDTH7 },
1213
+ count: { type: "number", columnKey: "refundVoidCount", footerCalculation: { type: "sum" } },
1214
+ amount: { type: "money", columnKey: "refundVoidAmount", footerCalculation: { type: "sum" } },
1215
+ pctSales: { type: "percent", columnKey: "refundVoidPctSales", footerCalculation: { type: "sum" } }
1191
1216
  };
1192
1217
  var DAILY_SALES_REFUNDS_VOIDS_AVAILABLE_COLUMNS = [
1193
1218
  "count",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@harbortouch/skytab-analytics-report-utils",
3
- "version": "0.4.3",
3
+ "version": "0.4.4",
4
4
  "description": "Centralized report column presentation configuration for SkyTab Analytics",
5
5
  "engines": {
6
6
  "node": ">=22.6.0",