@harbortouch/skytab-analytics-report-utils 0.4.7 → 0.4.8
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.
- package/dist/columns/index.d.ts +1 -1
- package/dist/index.cjs +8 -3
- package/dist/index.js +8 -3
- 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' | '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' | 'status';
|
|
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' | '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
|
export interface ColumnMetadata {
|
|
3
3
|
titleKey: string;
|
|
4
4
|
shortTitleKey: string;
|
package/dist/index.cjs
CHANGED
|
@@ -508,6 +508,11 @@ var COLUMN_REGISTRY = {
|
|
|
508
508
|
shortTitleKey: "common.report-col.shift-duration-hrs.short",
|
|
509
509
|
infoTextKey: "common.report-col.shift-duration-hrs.info"
|
|
510
510
|
},
|
|
511
|
+
salePaymentType: {
|
|
512
|
+
titleKey: "common.report-col.sale-payment-type",
|
|
513
|
+
shortTitleKey: "common.report-col.sale-payment-type.short",
|
|
514
|
+
infoTextKey: "common.report-col.sale-payment-type.info"
|
|
515
|
+
},
|
|
511
516
|
status: {
|
|
512
517
|
titleKey: "common.report-col.status",
|
|
513
518
|
shortTitleKey: "common.report-col.status.short",
|
|
@@ -1082,7 +1087,7 @@ var FIELDS4 = {
|
|
|
1082
1087
|
discountsAmount: { type: "money", columnKey: "discountAmount" },
|
|
1083
1088
|
inclusiveTaxesAmount: { type: "money", columnKey: "inclusiveTax" },
|
|
1084
1089
|
salesAmountNet: { type: "money", columnKey: "netSales" },
|
|
1085
|
-
itemsQuantity: { type: "
|
|
1090
|
+
itemsQuantity: { type: "fixedNumber", columnKey: "quantity" },
|
|
1086
1091
|
avgPrice: {
|
|
1087
1092
|
type: "fixedNumber",
|
|
1088
1093
|
columnKey: "averageGrossPrice",
|
|
@@ -1502,7 +1507,7 @@ var employeeTimecardConfig = {
|
|
|
1502
1507
|
|
|
1503
1508
|
// src/reports/salesByItemDetail.ts
|
|
1504
1509
|
var FIELDS13 = {
|
|
1505
|
-
businessDate: { type: "
|
|
1510
|
+
businessDate: { type: "date", columnKey: "date", filteringAvailable: false },
|
|
1506
1511
|
ticketClosedAt: { type: "string", columnKey: "ticketClosed", filteringAvailable: false },
|
|
1507
1512
|
hourId: { type: "number", columnKey: "hour", filteringAvailable: false },
|
|
1508
1513
|
daypartName: { type: "string", columnKey: "daypart", filteringAvailable: false },
|
|
@@ -1518,7 +1523,7 @@ var FIELDS13 = {
|
|
|
1518
1523
|
guestsCount: { type: "number", columnKey: "guestCount" },
|
|
1519
1524
|
employeeName: { type: "string", columnKey: "employeeName", filteringAvailable: false },
|
|
1520
1525
|
orderTypeName: { type: "string", columnKey: "orderType", filteringAvailable: false },
|
|
1521
|
-
salesType: { type: "string", columnKey: "
|
|
1526
|
+
salesType: { type: "string", columnKey: "salePaymentType", filteringAvailable: false },
|
|
1522
1527
|
itemPrice: { type: "money", columnKey: "itemPrice" }
|
|
1523
1528
|
};
|
|
1524
1529
|
var SALES_BY_ITEM_DETAIL_AVAILABLE_COLUMNS = [
|
package/dist/index.js
CHANGED
|
@@ -435,6 +435,11 @@ var COLUMN_REGISTRY = {
|
|
|
435
435
|
shortTitleKey: "common.report-col.shift-duration-hrs.short",
|
|
436
436
|
infoTextKey: "common.report-col.shift-duration-hrs.info"
|
|
437
437
|
},
|
|
438
|
+
salePaymentType: {
|
|
439
|
+
titleKey: "common.report-col.sale-payment-type",
|
|
440
|
+
shortTitleKey: "common.report-col.sale-payment-type.short",
|
|
441
|
+
infoTextKey: "common.report-col.sale-payment-type.info"
|
|
442
|
+
},
|
|
438
443
|
status: {
|
|
439
444
|
titleKey: "common.report-col.status",
|
|
440
445
|
shortTitleKey: "common.report-col.status.short",
|
|
@@ -1009,7 +1014,7 @@ var FIELDS4 = {
|
|
|
1009
1014
|
discountsAmount: { type: "money", columnKey: "discountAmount" },
|
|
1010
1015
|
inclusiveTaxesAmount: { type: "money", columnKey: "inclusiveTax" },
|
|
1011
1016
|
salesAmountNet: { type: "money", columnKey: "netSales" },
|
|
1012
|
-
itemsQuantity: { type: "
|
|
1017
|
+
itemsQuantity: { type: "fixedNumber", columnKey: "quantity" },
|
|
1013
1018
|
avgPrice: {
|
|
1014
1019
|
type: "fixedNumber",
|
|
1015
1020
|
columnKey: "averageGrossPrice",
|
|
@@ -1429,7 +1434,7 @@ var employeeTimecardConfig = {
|
|
|
1429
1434
|
|
|
1430
1435
|
// src/reports/salesByItemDetail.ts
|
|
1431
1436
|
var FIELDS13 = {
|
|
1432
|
-
businessDate: { type: "
|
|
1437
|
+
businessDate: { type: "date", columnKey: "date", filteringAvailable: false },
|
|
1433
1438
|
ticketClosedAt: { type: "string", columnKey: "ticketClosed", filteringAvailable: false },
|
|
1434
1439
|
hourId: { type: "number", columnKey: "hour", filteringAvailable: false },
|
|
1435
1440
|
daypartName: { type: "string", columnKey: "daypart", filteringAvailable: false },
|
|
@@ -1445,7 +1450,7 @@ var FIELDS13 = {
|
|
|
1445
1450
|
guestsCount: { type: "number", columnKey: "guestCount" },
|
|
1446
1451
|
employeeName: { type: "string", columnKey: "employeeName", filteringAvailable: false },
|
|
1447
1452
|
orderTypeName: { type: "string", columnKey: "orderType", filteringAvailable: false },
|
|
1448
|
-
salesType: { type: "string", columnKey: "
|
|
1453
|
+
salesType: { type: "string", columnKey: "salePaymentType", filteringAvailable: false },
|
|
1449
1454
|
itemPrice: { type: "money", columnKey: "itemPrice" }
|
|
1450
1455
|
};
|
|
1451
1456
|
var SALES_BY_ITEM_DETAIL_AVAILABLE_COLUMNS = [
|