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

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.
@@ -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' | 'ticketCount' | 'itemCount' | 'discover' | 'discoverReturns' | 'ebt' | 'ebtReturns' | 'employeeId' | 'employeeJob' | 'employeeName' | 'exemptTaxes' | 'exemptSales' | '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' | 'type' | 'status' | 'lastModified' | 'discountCount' | 'itemQuantity' | 'modifierQuantityComp' | 'itemQuantityComp' | 'attachRateComp' | 'totalModifierSalesVar' | 'totalModifierSalesVarPct' | 'modifierQuantityVar' | 'modifierQuantityVarPct' | 'attachRateVar' | 'attachRateVarPct' | 'totalModifierSalesComp';
1
+ type ReportColumnKey = 'fifteenMinInterval' | 'adjustedTips' | 'advantageProgram' | 'amex' | 'amexReturns' | 'attachRate' | 'autoGratuity' | 'averageGrossPrice' | 'bankFees' | 'batchAmount' | 'batchDate' | 'batchNumber' | 'cashCollected' | 'clockInTime' | 'clockOutTime' | 'country' | 'customerName' | 'date' | 'dateClose' | 'daypart' | 'debit' | 'debitReturns' | 'declaredTips' | 'department' | 'depositCurrency' | 'depositDate' | 'discountAmount' | 'ticketCount' | 'itemCount' | 'discover' | 'discoverReturns' | 'ebt' | 'ebtReturns' | 'employeeId' | 'employeeJob' | 'employeeName' | 'exemptTaxes' | 'exemptSales' | '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' | 'tipShareContributed' | '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' | 'type' | 'status' | 'lastModified' | 'discountCount' | 'itemQuantity' | 'modifierQuantityComp' | 'itemQuantityComp' | 'attachRateComp' | 'totalModifierSalesVar' | 'totalModifierSalesVarPct' | 'modifierQuantityVar' | 'modifierQuantityVarPct' | 'attachRateVar' | 'attachRateVarPct' | 'totalModifierSalesComp';
2
2
  declare const COLUMN_REGISTRY: {
3
3
  readonly fifteenMinInterval: {
4
4
  readonly titleKey: "common.report-col.fifteen-min-interval";
@@ -60,6 +60,11 @@ declare const COLUMN_REGISTRY: {
60
60
  readonly shortTitleKey: "common.report-col.batch-number.short";
61
61
  readonly infoTextKey: "common.report-col.batch-number.info";
62
62
  };
63
+ readonly cashCollected: {
64
+ readonly titleKey: "common.report-col.cash-collected";
65
+ readonly shortTitleKey: "common.report-col.cash-collected.short";
66
+ readonly infoTextKey: "common.report-col.cash-collected.info";
67
+ };
63
68
  readonly clockInTime: {
64
69
  readonly titleKey: "common.report-col.clock-in-time";
65
70
  readonly shortTitleKey: "common.report-col.clock-in-time.short";
@@ -540,6 +545,11 @@ declare const COLUMN_REGISTRY: {
540
545
  readonly shortTitleKey: "common.report-col.tip-share.short";
541
546
  readonly infoTextKey: "common.report-col.tip-share.info";
542
547
  };
548
+ readonly tipShareContributed: {
549
+ readonly titleKey: "common.report-col.tip-share-contributed";
550
+ readonly shortTitleKey: "common.report-col.tip-share-contributed.short";
551
+ readonly infoTextKey: "common.report-col.tip-share-contributed.info";
552
+ };
543
553
  readonly tips: {
544
554
  readonly titleKey: "common.report-col.tips";
545
555
  readonly shortTitleKey: "common.report-col.tips.short";
@@ -770,6 +780,9 @@ declare const enUS: {
770
780
  readonly 'common.report-col.batch-number': "Batch Number";
771
781
  readonly 'common.report-col.batch-number.short': "Batch No";
772
782
  readonly 'common.report-col.batch-number.info': "The system-generated number used to track this batch of transactions";
783
+ readonly 'common.report-col.cash-collected': "Cash Collected";
784
+ readonly 'common.report-col.cash-collected.short': "Cash Collected";
785
+ readonly 'common.report-col.cash-collected.info': "Total cash collected by the employee";
773
786
  readonly 'common.report-col.clock-in-time': "Clock-In Time";
774
787
  readonly 'common.report-col.clock-in-time.short': "In Time";
775
788
  readonly 'common.report-col.clock-in-time.info': "Actual time the employee clocked in";
@@ -1079,6 +1092,9 @@ declare const enUS: {
1079
1092
  readonly 'common.report-col.tip-share': "Tip Share";
1080
1093
  readonly 'common.report-col.tip-share.short': "Tip Share";
1081
1094
  readonly 'common.report-col.tip-share.info': "Tips distributed to other employees";
1095
+ readonly 'common.report-col.tip-share-contributed': "Tip Share Contributed";
1096
+ readonly 'common.report-col.tip-share-contributed.short': "Tip Share Contrib";
1097
+ readonly 'common.report-col.tip-share-contributed.info': "Tips contributed by this employee to the tip share pool";
1082
1098
  readonly 'common.report-col.tips': "Tips";
1083
1099
  readonly 'common.report-col.tips.short': "Tips";
1084
1100
  readonly 'common.report-col.tips.info': "Total tips received for the ticket";
@@ -1283,6 +1299,7 @@ declare const Report: {
1283
1299
  readonly ITEM_TAX: "item-tax";
1284
1300
  readonly EMPLOYEE_TIMECARD: "employee-timecard";
1285
1301
  readonly EMPLOYEE_TIP: "employee-tip";
1302
+ readonly TIP_CASHOUT_RECONCILIATION: "tip-cashout-reconciliation";
1286
1303
  readonly SALES_BY_ITEM: "sales-by-item";
1287
1304
  readonly DAILY_SALES: "daily-sales";
1288
1305
  readonly DAILY_SALES_LIVE: "daily-sales-live";
@@ -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' | 'ticketCount' | 'itemCount' | 'discover' | 'discoverReturns' | 'ebt' | 'ebtReturns' | 'employeeId' | 'employeeJob' | 'employeeName' | 'exemptTaxes' | 'exemptSales' | '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' | 'type' | 'status' | 'lastModified' | 'discountCount' | 'itemQuantity' | 'modifierQuantityComp' | 'itemQuantityComp' | 'attachRateComp' | 'totalModifierSalesVar' | 'totalModifierSalesVarPct' | 'modifierQuantityVar' | 'modifierQuantityVarPct' | 'attachRateVar' | 'attachRateVarPct' | 'totalModifierSalesComp';
1
+ type ReportColumnKey = 'fifteenMinInterval' | 'adjustedTips' | 'advantageProgram' | 'amex' | 'amexReturns' | 'attachRate' | 'autoGratuity' | 'averageGrossPrice' | 'bankFees' | 'batchAmount' | 'batchDate' | 'batchNumber' | 'cashCollected' | 'clockInTime' | 'clockOutTime' | 'country' | 'customerName' | 'date' | 'dateClose' | 'daypart' | 'debit' | 'debitReturns' | 'declaredTips' | 'department' | 'depositCurrency' | 'depositDate' | 'discountAmount' | 'ticketCount' | 'itemCount' | 'discover' | 'discoverReturns' | 'ebt' | 'ebtReturns' | 'employeeId' | 'employeeJob' | 'employeeName' | 'exemptTaxes' | 'exemptSales' | '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' | 'tipShareContributed' | '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' | 'type' | 'status' | 'lastModified' | 'discountCount' | 'itemQuantity' | 'modifierQuantityComp' | 'itemQuantityComp' | 'attachRateComp' | 'totalModifierSalesVar' | 'totalModifierSalesVarPct' | 'modifierQuantityVar' | 'modifierQuantityVarPct' | 'attachRateVar' | 'attachRateVarPct' | 'totalModifierSalesComp';
2
2
  declare const COLUMN_REGISTRY: {
3
3
  readonly fifteenMinInterval: {
4
4
  readonly titleKey: "common.report-col.fifteen-min-interval";
@@ -60,6 +60,11 @@ declare const COLUMN_REGISTRY: {
60
60
  readonly shortTitleKey: "common.report-col.batch-number.short";
61
61
  readonly infoTextKey: "common.report-col.batch-number.info";
62
62
  };
63
+ readonly cashCollected: {
64
+ readonly titleKey: "common.report-col.cash-collected";
65
+ readonly shortTitleKey: "common.report-col.cash-collected.short";
66
+ readonly infoTextKey: "common.report-col.cash-collected.info";
67
+ };
63
68
  readonly clockInTime: {
64
69
  readonly titleKey: "common.report-col.clock-in-time";
65
70
  readonly shortTitleKey: "common.report-col.clock-in-time.short";
@@ -540,6 +545,11 @@ declare const COLUMN_REGISTRY: {
540
545
  readonly shortTitleKey: "common.report-col.tip-share.short";
541
546
  readonly infoTextKey: "common.report-col.tip-share.info";
542
547
  };
548
+ readonly tipShareContributed: {
549
+ readonly titleKey: "common.report-col.tip-share-contributed";
550
+ readonly shortTitleKey: "common.report-col.tip-share-contributed.short";
551
+ readonly infoTextKey: "common.report-col.tip-share-contributed.info";
552
+ };
543
553
  readonly tips: {
544
554
  readonly titleKey: "common.report-col.tips";
545
555
  readonly shortTitleKey: "common.report-col.tips.short";
@@ -770,6 +780,9 @@ declare const enUS: {
770
780
  readonly 'common.report-col.batch-number': "Batch Number";
771
781
  readonly 'common.report-col.batch-number.short': "Batch No";
772
782
  readonly 'common.report-col.batch-number.info': "The system-generated number used to track this batch of transactions";
783
+ readonly 'common.report-col.cash-collected': "Cash Collected";
784
+ readonly 'common.report-col.cash-collected.short': "Cash Collected";
785
+ readonly 'common.report-col.cash-collected.info': "Total cash collected by the employee";
773
786
  readonly 'common.report-col.clock-in-time': "Clock-In Time";
774
787
  readonly 'common.report-col.clock-in-time.short': "In Time";
775
788
  readonly 'common.report-col.clock-in-time.info': "Actual time the employee clocked in";
@@ -1079,6 +1092,9 @@ declare const enUS: {
1079
1092
  readonly 'common.report-col.tip-share': "Tip Share";
1080
1093
  readonly 'common.report-col.tip-share.short': "Tip Share";
1081
1094
  readonly 'common.report-col.tip-share.info': "Tips distributed to other employees";
1095
+ readonly 'common.report-col.tip-share-contributed': "Tip Share Contributed";
1096
+ readonly 'common.report-col.tip-share-contributed.short': "Tip Share Contrib";
1097
+ readonly 'common.report-col.tip-share-contributed.info': "Tips contributed by this employee to the tip share pool";
1082
1098
  readonly 'common.report-col.tips': "Tips";
1083
1099
  readonly 'common.report-col.tips.short': "Tips";
1084
1100
  readonly 'common.report-col.tips.info': "Total tips received for the ticket";
@@ -1283,6 +1299,7 @@ declare const Report: {
1283
1299
  readonly ITEM_TAX: "item-tax";
1284
1300
  readonly EMPLOYEE_TIMECARD: "employee-timecard";
1285
1301
  readonly EMPLOYEE_TIP: "employee-tip";
1302
+ readonly TIP_CASHOUT_RECONCILIATION: "tip-cashout-reconciliation";
1286
1303
  readonly SALES_BY_ITEM: "sales-by-item";
1287
1304
  readonly DAILY_SALES: "daily-sales";
1288
1305
  readonly DAILY_SALES_LIVE: "daily-sales-live";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@harbortouch/skytab-analytics-report-utils",
3
- "version": "0.28.0",
3
+ "version": "0.29.0",
4
4
  "description": "Centralized report column presentation configuration for SkyTab Analytics",
5
5
  "engines": {
6
6
  "node": ">=22.6.0",