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

package/dist/{report-DOgRgflg.d.ts → report-ZRoya9wR.d.ts}

@@ -1,4 +1,4 @@
-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';
+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' | 'paidNormalHours' | 'normalPay' | 'overtimePay' | 'doubleOvertimePay' | 'gratuity' | 'tipPaidStatus' | 'totalPayments' | 'minimumWageAdjustment' | 'totalPay';
 declare const COLUMN_REGISTRY: {
     readonly fifteenMinInterval: {
         readonly titleKey: "common.report-col.fifteen-min-interval";
@@ -735,6 +735,51 @@ declare const COLUMN_REGISTRY: {
         readonly shortTitleKey: "common.report-col.type.short";
         readonly infoTextKey: "common.report-col.type.info";
     };
+    readonly paidNormalHours: {
+        readonly titleKey: "common.report-col.paid-normal-hours";
+        readonly shortTitleKey: "common.report-col.paid-normal-hours.short";
+        readonly infoTextKey: "common.report-col.paid-normal-hours.info";
+    };
+    readonly normalPay: {
+        readonly titleKey: "common.report-col.normal-pay";
+        readonly shortTitleKey: "common.report-col.normal-pay.short";
+        readonly infoTextKey: "common.report-col.normal-pay.info";
+    };
+    readonly overtimePay: {
+        readonly titleKey: "common.report-col.overtime-pay";
+        readonly shortTitleKey: "common.report-col.overtime-pay.short";
+        readonly infoTextKey: "common.report-col.overtime-pay.info";
+    };
+    readonly doubleOvertimePay: {
+        readonly titleKey: "common.report-col.double-overtime-pay";
+        readonly shortTitleKey: "common.report-col.double-overtime-pay.short";
+        readonly infoTextKey: "common.report-col.double-overtime-pay.info";
+    };
+    readonly gratuity: {
+        readonly titleKey: "common.report-col.gratuity";
+        readonly shortTitleKey: "common.report-col.gratuity.short";
+        readonly infoTextKey: "common.report-col.gratuity.info";
+    };
+    readonly tipPaidStatus: {
+        readonly titleKey: "common.report-col.tip-paid-status";
+        readonly shortTitleKey: "common.report-col.tip-paid-status.short";
+        readonly infoTextKey: "common.report-col.tip-paid-status.info";
+    };
+    readonly totalPayments: {
+        readonly titleKey: "common.report-col.total-payments";
+        readonly shortTitleKey: "common.report-col.total-payments.short";
+        readonly infoTextKey: "common.report-col.total-payments.info";
+    };
+    readonly minimumWageAdjustment: {
+        readonly titleKey: "common.report-col.minimum-wage-adjustment";
+        readonly shortTitleKey: "common.report-col.minimum-wage-adjustment.short";
+        readonly infoTextKey: "common.report-col.minimum-wage-adjustment.info";
+    };
+    readonly totalPay: {
+        readonly titleKey: "common.report-col.total-pay";
+        readonly shortTitleKey: "common.report-col.total-pay.short";
+        readonly infoTextKey: "common.report-col.total-pay.info";
+    };
 };
 type ColumnMetadata = (typeof COLUMN_REGISTRY)[ReportColumnKey];
 type ColumnMessageKey = ColumnMetadata['titleKey'] | ColumnMetadata['shortTitleKey'] | Extract<ColumnMetadata, {
@@ -1185,6 +1230,33 @@ declare const enUS: {
     readonly 'common.report-col.type': "Type";
     readonly 'common.report-col.type.short': "Type";
     readonly 'common.report-col.type.info': " ";
+    readonly 'common.report-col.paid-normal-hours': "Paid Normal Hours";
+    readonly 'common.report-col.paid-normal-hours.short': "Norm Hrs";
+    readonly 'common.report-col.paid-normal-hours.info': "Total regular hours paid for the period";
+    readonly 'common.report-col.normal-pay': "Normal Pay";
+    readonly 'common.report-col.normal-pay.short': "Norm Pay";
+    readonly 'common.report-col.normal-pay.info': "Wages earned for regular hours worked";
+    readonly 'common.report-col.overtime-pay': "Overtime Pay";
+    readonly 'common.report-col.overtime-pay.short': "OT Pay";
+    readonly 'common.report-col.overtime-pay.info': "Wages earned for overtime hours worked";
+    readonly 'common.report-col.double-overtime-pay': "Double Overtime Pay";
+    readonly 'common.report-col.double-overtime-pay.short': "DT Pay";
+    readonly 'common.report-col.double-overtime-pay.info': "Wages earned for double-overtime hours worked";
+    readonly 'common.report-col.gratuity': "Gratuity";
+    readonly 'common.report-col.gratuity.short': "Gratuity";
+    readonly 'common.report-col.gratuity.info': "Gratuity amounts included in the payroll period";
+    readonly 'common.report-col.tip-paid-status': "Tip Paid Status";
+    readonly 'common.report-col.tip-paid-status.short': "Tip Status";
+    readonly 'common.report-col.tip-paid-status.info': "Indicates whether tips were paid out daily or deferred to payroll";
+    readonly 'common.report-col.total-payments': "Total Payments";
+    readonly 'common.report-col.total-payments.short': "Total Pmts";
+    readonly 'common.report-col.total-payments.info': "Total payments collected for the payroll period";
+    readonly 'common.report-col.minimum-wage-adjustment': "Minimum Wage Adjustment";
+    readonly 'common.report-col.minimum-wage-adjustment.short': "Min Wage Adj";
+    readonly 'common.report-col.minimum-wage-adjustment.info': "Adjustment applied to meet minimum wage requirements";
+    readonly 'common.report-col.total-pay': "Total Pay";
+    readonly 'common.report-col.total-pay.short': "Total Pay";
+    readonly 'common.report-col.total-pay.info': "Total compensation including wages, overtime, and adjustments";
     readonly 'common.report-section.revenue-class': "Sales by Revenue Class";
     readonly 'common.report-section.payments': "Payments";
     readonly 'common.report-section.cash': "Expected Closeout Cash";
@@ -1227,8 +1299,10 @@ declare const enUS: {
     readonly 'table.total': "Total";
     readonly 'table.groups.sales': "Sales";
     readonly 'table.groups.net-sales': "Net Sales";
+    readonly 'table.groups.taxes': "Tax";
+    readonly 'table.groups.gross-sales': "Gross Sales";
     readonly 'table.groups.guests': "Guests";
-    readonly 'table.groups.sales-per-guest': "Sales / Guest";
+    readonly 'table.groups.sales-per-guest': "Sales/Guest";
     readonly 'employee-timecard.status.active': "Active";
     readonly 'employee-timecard.status.inactive': "Inactive";
     readonly 'employee-timecard.job.break-suffix': " * break";
@@ -1280,18 +1354,18 @@ type ColumnPresentationConfig<TField = string> = (BaseColumnPresentationConfig<T
     customConfiguration: CustomConfiguration;
     conditionalConfiguration?: never;
 });
-interface ColumnGroupConfig {
+interface ColumnGroupConfig<TField extends string = string> {
     id: string;
     headerTranslationKey: MessageKey;
-    baseFields: string[];
-    lastWeekFields?: string[];
-    lastYearFields?: string[];
+    baseFields: TField[];
+    lastWeekFields?: TField[];
+    lastYearFields?: TField[];
 }
 interface ReportConfig<TField extends string = string> {
     fields: Record<TField, ColumnPresentationConfig<TField>>;
     availableColumns: TField[];
     defaultVisibleColumns: TField[];
-    columnGroups?: ColumnGroupConfig[];
+    columnGroups?: ColumnGroupConfig<TField>[];
     chartFields?: TField[];
     hasFooter: boolean;
     dataAccessKey?: string;
@@ -1311,6 +1385,7 @@ declare const Report: {
     readonly EMPLOYEE_TIMECARD: "employee-timecard";
     readonly EMPLOYEE_TIP: "employee-tip";
     readonly TIP_CASHOUT_RECONCILIATION: "tip-cashout-reconciliation";
+    readonly PAYROLL: "payroll";
     readonly SALES_BY_ITEM: "sales-by-item";
     readonly DAILY_SALES: "daily-sales";
     readonly DAILY_SALES_LIVE: "daily-sales-live";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@harbortouch/skytab-analytics-report-utils",
-	"version": "0.36.0",
+	"version": "0.38.0",
 	"description": "Centralized report column presentation configuration for SkyTab Analytics",
 	"engines": {
 		"node": ">=22.6.0",