@harbortouch/skytab-analytics-report-utils 0.8.1 → 0.8.2

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 (5) hide show
  1. package/dist/index.cjs +13 -6
  2. package/dist/index.d.cts +18 -9
  3. package/dist/index.d.ts +18 -9
  4. package/dist/index.js +13 -6
  5. package/package.json +1 -1
package/dist/index.cjs CHANGED
@@ -658,11 +658,13 @@ var dailySalesPaymentsConfig = {
658
658
  var FIRST_COLUMN_WIDTH6 = 240;
659
659
  var FIELDS9 = {
660
660
  discountName: { type: "string", columnKey: "discountName", size: FIRST_COLUMN_WIDTH6 },
661
- discountsCount: { type: "number", columnKey: "discountCount", footerCalculation: { type: "sum" } },
661
+ ticketCount: { type: "number", columnKey: "ticketCount", footerCalculation: { type: "sum" } },
662
+ itemCount: { type: "number", columnKey: "itemCount", footerCalculation: { type: "sum" } },
662
663
  discountsAmount: { type: "money", columnKey: "discountAmount", footerCalculation: { type: "sum" } }
663
664
  };
664
665
  var DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS = [
665
- "discountsCount",
666
+ "ticketCount",
667
+ "itemCount",
666
668
  "discountsAmount"
667
669
  ];
668
670
  var DAILY_SALES_DISCOUNTS_DEFAULT_VISIBLE_COLUMNS = DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS;
@@ -970,10 +972,15 @@ var COLUMN_REGISTRY = {
970
972
  shortTitleKey: "common.report-col.discount-amount.short",
971
973
  infoTextKey: "common.report-col.discount-amount.info"
972
974
  },
973
- discountCount: {
974
- titleKey: "common.report-col.discount-count",
975
- shortTitleKey: "common.report-col.discount-count.short",
976
- infoTextKey: "common.report-col.discount-count.info"
975
+ ticketCount: {
976
+ titleKey: "common.report-col.ticket-count",
977
+ shortTitleKey: "common.report-col.ticket-count.short",
978
+ infoTextKey: "common.report-col.ticket-count.info"
979
+ },
980
+ itemCount: {
981
+ titleKey: "common.report-col.item-count",
982
+ shortTitleKey: "common.report-col.item-count.short",
983
+ infoTextKey: "common.report-col.item-count.info"
977
984
  },
978
985
  discover: {
979
986
  titleKey: "common.report-col.discover",
package/dist/index.d.cts CHANGED
@@ -1,4 +1,4 @@
1
- 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' | 'locationId' | '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' | 'tickets' | 'guests' | 'ticketAverage' | 'guestAverage' | 'net' | 'salePaymentType' | 'status';
1
+ 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' | 'ticketCount' | 'itemCount' | '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' | 'locationId' | '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' | 'tickets' | 'guests' | 'ticketAverage' | 'guestAverage' | 'net' | 'salePaymentType' | 'status';
2
2
  interface ColumnMetadata {
3
3
  titleKey: string;
4
4
  shortTitleKey: string;
@@ -135,10 +135,15 @@ declare const COLUMN_REGISTRY: {
135
135
  readonly shortTitleKey: "common.report-col.discount-amount.short";
136
136
  readonly infoTextKey: "common.report-col.discount-amount.info";
137
137
  };
138
- readonly discountCount: {
139
- readonly titleKey: "common.report-col.discount-count";
140
- readonly shortTitleKey: "common.report-col.discount-count.short";
141
- readonly infoTextKey: "common.report-col.discount-count.info";
138
+ readonly ticketCount: {
139
+ readonly titleKey: "common.report-col.ticket-count";
140
+ readonly shortTitleKey: "common.report-col.ticket-count.short";
141
+ readonly infoTextKey: "common.report-col.ticket-count.info";
142
+ };
143
+ readonly itemCount: {
144
+ readonly titleKey: "common.report-col.item-count";
145
+ readonly shortTitleKey: "common.report-col.item-count.short";
146
+ readonly infoTextKey: "common.report-col.item-count.info";
142
147
  };
143
148
  readonly discover: {
144
149
  readonly titleKey: "common.report-col.discover";
@@ -756,9 +761,13 @@ declare function getColumnMetadata(key: ReportColumnKey): {
756
761
  readonly shortTitleKey: "common.report-col.discount-amount.short";
757
762
  readonly infoTextKey: "common.report-col.discount-amount.info";
758
763
  } | {
759
- readonly titleKey: "common.report-col.discount-count";
760
- readonly shortTitleKey: "common.report-col.discount-count.short";
761
- readonly infoTextKey: "common.report-col.discount-count.info";
764
+ readonly titleKey: "common.report-col.ticket-count";
765
+ readonly shortTitleKey: "common.report-col.ticket-count.short";
766
+ readonly infoTextKey: "common.report-col.ticket-count.info";
767
+ } | {
768
+ readonly titleKey: "common.report-col.item-count";
769
+ readonly shortTitleKey: "common.report-col.item-count.short";
770
+ readonly infoTextKey: "common.report-col.item-count.info";
762
771
  } | {
763
772
  readonly titleKey: "common.report-col.discover";
764
773
  readonly shortTitleKey: "common.report-col.discover.short";
@@ -1269,7 +1278,7 @@ declare const DAILY_SALES_PAYMENTS_AVAILABLE_COLUMNS: DailySalesPaymentsField[];
1269
1278
  declare const DAILY_SALES_PAYMENTS_DEFAULT_VISIBLE_COLUMNS: DailySalesPaymentsField[];
1270
1279
  declare const dailySalesPaymentsConfig: ReportConfig<DailySalesPaymentsField>;
1271
1280
 
1272
- type DailySalesDiscountsField = 'discountName' | 'discountsCount' | 'discountsAmount';
1281
+ type DailySalesDiscountsField = 'discountName' | 'ticketCount' | 'itemCount' | 'discountsAmount';
1273
1282
  declare const DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS: DailySalesDiscountsField[];
1274
1283
  declare const DAILY_SALES_DISCOUNTS_DEFAULT_VISIBLE_COLUMNS: DailySalesDiscountsField[];
1275
1284
  declare const dailySalesDiscountsConfig: ReportConfig<DailySalesDiscountsField>;
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- 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' | 'locationId' | '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' | 'tickets' | 'guests' | 'ticketAverage' | 'guestAverage' | 'net' | 'salePaymentType' | 'status';
1
+ 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' | 'ticketCount' | 'itemCount' | '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' | 'locationId' | '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' | 'tickets' | 'guests' | 'ticketAverage' | 'guestAverage' | 'net' | 'salePaymentType' | 'status';
2
2
  interface ColumnMetadata {
3
3
  titleKey: string;
4
4
  shortTitleKey: string;
@@ -135,10 +135,15 @@ declare const COLUMN_REGISTRY: {
135
135
  readonly shortTitleKey: "common.report-col.discount-amount.short";
136
136
  readonly infoTextKey: "common.report-col.discount-amount.info";
137
137
  };
138
- readonly discountCount: {
139
- readonly titleKey: "common.report-col.discount-count";
140
- readonly shortTitleKey: "common.report-col.discount-count.short";
141
- readonly infoTextKey: "common.report-col.discount-count.info";
138
+ readonly ticketCount: {
139
+ readonly titleKey: "common.report-col.ticket-count";
140
+ readonly shortTitleKey: "common.report-col.ticket-count.short";
141
+ readonly infoTextKey: "common.report-col.ticket-count.info";
142
+ };
143
+ readonly itemCount: {
144
+ readonly titleKey: "common.report-col.item-count";
145
+ readonly shortTitleKey: "common.report-col.item-count.short";
146
+ readonly infoTextKey: "common.report-col.item-count.info";
142
147
  };
143
148
  readonly discover: {
144
149
  readonly titleKey: "common.report-col.discover";
@@ -756,9 +761,13 @@ declare function getColumnMetadata(key: ReportColumnKey): {
756
761
  readonly shortTitleKey: "common.report-col.discount-amount.short";
757
762
  readonly infoTextKey: "common.report-col.discount-amount.info";
758
763
  } | {
759
- readonly titleKey: "common.report-col.discount-count";
760
- readonly shortTitleKey: "common.report-col.discount-count.short";
761
- readonly infoTextKey: "common.report-col.discount-count.info";
764
+ readonly titleKey: "common.report-col.ticket-count";
765
+ readonly shortTitleKey: "common.report-col.ticket-count.short";
766
+ readonly infoTextKey: "common.report-col.ticket-count.info";
767
+ } | {
768
+ readonly titleKey: "common.report-col.item-count";
769
+ readonly shortTitleKey: "common.report-col.item-count.short";
770
+ readonly infoTextKey: "common.report-col.item-count.info";
762
771
  } | {
763
772
  readonly titleKey: "common.report-col.discover";
764
773
  readonly shortTitleKey: "common.report-col.discover.short";
@@ -1269,7 +1278,7 @@ declare const DAILY_SALES_PAYMENTS_AVAILABLE_COLUMNS: DailySalesPaymentsField[];
1269
1278
  declare const DAILY_SALES_PAYMENTS_DEFAULT_VISIBLE_COLUMNS: DailySalesPaymentsField[];
1270
1279
  declare const dailySalesPaymentsConfig: ReportConfig<DailySalesPaymentsField>;
1271
1280
 
1272
- type DailySalesDiscountsField = 'discountName' | 'discountsCount' | 'discountsAmount';
1281
+ type DailySalesDiscountsField = 'discountName' | 'ticketCount' | 'itemCount' | 'discountsAmount';
1273
1282
  declare const DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS: DailySalesDiscountsField[];
1274
1283
  declare const DAILY_SALES_DISCOUNTS_DEFAULT_VISIBLE_COLUMNS: DailySalesDiscountsField[];
1275
1284
  declare const dailySalesDiscountsConfig: ReportConfig<DailySalesDiscountsField>;
package/dist/index.js CHANGED
@@ -570,11 +570,13 @@ var dailySalesPaymentsConfig = {
570
570
  var FIRST_COLUMN_WIDTH6 = 240;
571
571
  var FIELDS9 = {
572
572
  discountName: { type: "string", columnKey: "discountName", size: FIRST_COLUMN_WIDTH6 },
573
- discountsCount: { type: "number", columnKey: "discountCount", footerCalculation: { type: "sum" } },
573
+ ticketCount: { type: "number", columnKey: "ticketCount", footerCalculation: { type: "sum" } },
574
+ itemCount: { type: "number", columnKey: "itemCount", footerCalculation: { type: "sum" } },
574
575
  discountsAmount: { type: "money", columnKey: "discountAmount", footerCalculation: { type: "sum" } }
575
576
  };
576
577
  var DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS = [
577
- "discountsCount",
578
+ "ticketCount",
579
+ "itemCount",
578
580
  "discountsAmount"
579
581
  ];
580
582
  var DAILY_SALES_DISCOUNTS_DEFAULT_VISIBLE_COLUMNS = DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS;
@@ -882,10 +884,15 @@ var COLUMN_REGISTRY = {
882
884
  shortTitleKey: "common.report-col.discount-amount.short",
883
885
  infoTextKey: "common.report-col.discount-amount.info"
884
886
  },
885
- discountCount: {
886
- titleKey: "common.report-col.discount-count",
887
- shortTitleKey: "common.report-col.discount-count.short",
888
- infoTextKey: "common.report-col.discount-count.info"
887
+ ticketCount: {
888
+ titleKey: "common.report-col.ticket-count",
889
+ shortTitleKey: "common.report-col.ticket-count.short",
890
+ infoTextKey: "common.report-col.ticket-count.info"
891
+ },
892
+ itemCount: {
893
+ titleKey: "common.report-col.item-count",
894
+ shortTitleKey: "common.report-col.item-count.short",
895
+ infoTextKey: "common.report-col.item-count.info"
889
896
  },
890
897
  discover: {
891
898
  titleKey: "common.report-col.discover",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@harbortouch/skytab-analytics-report-utils",
3
- "version": "0.8.1",
3
+ "version": "0.8.2",
4
4
  "description": "Centralized report column presentation configuration for SkyTab Analytics",
5
5
  "engines": {
6
6
  "node": ">=22.6.0",