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

package/dist/{columns/index.d.ts → index.d.cts}

@@ -1,10 +1,10 @@
-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';
-export interface ColumnMetadata {
+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';
+interface ColumnMetadata {
     titleKey: string;
     shortTitleKey: string;
     infoTextKey: string;
 }
-export declare const COLUMN_REGISTRY: {
+declare const COLUMN_REGISTRY: {
     readonly fifteenMinInterval: {
         readonly titleKey: "common.report-col.fifteen-min-interval";
         readonly shortTitleKey: "common.report-col.fifteen-min-interval.short";
@@ -651,7 +651,7 @@ export declare const COLUMN_REGISTRY: {
         readonly infoTextKey: "common.report-col.net.info";
     };
 };
-export declare function getColumnMetadata(key: ReportColumnKey): {
+declare function getColumnMetadata(key: ReportColumnKey): {
     readonly titleKey: "common.report-col.fifteen-min-interval";
     readonly shortTitleKey: "common.report-col.fifteen-min-interval.short";
     readonly infoTextKey: "common.report-col.fifteen-min-interval.info";
@@ -1168,4 +1168,171 @@ export declare function getColumnMetadata(key: ReportColumnKey): {
     readonly shortTitleKey: "common.report-col.net.short";
     readonly infoTextKey: "common.report-col.net.info";
 };
-export declare function getColumnExportHeaderLabel(colTitle: string, groupTitle: string | null): string;
+declare function getColumnExportHeaderLabel(colTitle: string, groupTitle: string | null): string;
+
+type FieldType = 'string' | 'money' | 'percent' | 'number' | 'fixedNumber' | 'date' | 'time' | 'boolean';
+type ColumnAlignment = 'left' | 'right';
+type FooterCalculationType = 'sum' | 'percentChange' | 'average' | 'none';
+interface FooterCalculation<TField = string> {
+    type: FooterCalculationType;
+    numeratorField?: TField;
+    denominatorField?: TField;
+}
+interface ColumnPresentationConfig<TField = string> {
+    columnKey?: ReportColumnKey;
+    type: FieldType;
+    size?: number;
+    enableSorting?: boolean;
+    filteringAvailable?: boolean;
+    footerCalculation?: FooterCalculation<TField>;
+}
+interface ColumnGroupConfig {
+    id: string;
+    headerTranslationKey: string;
+    baseFields: string[];
+    lastWeekFields?: string[];
+    lastYearFields?: string[];
+}
+interface ReportConfig<TField extends string = string> {
+    fields: Record<TField, ColumnPresentationConfig<TField>>;
+    availableColumns: TField[];
+    defaultVisibleColumns: TField[];
+    columnGroups?: ColumnGroupConfig[];
+}
+
+declare const Report: {
+    readonly TICKET_LIVE: "ticket-live";
+    readonly TICKET_ANALYTICS: "ticket-analytics";
+    readonly SALES_SUMMARY: "sales-summary";
+    readonly PRODUCT_MIX: "product-mix";
+    readonly MODIFIER_MIX: "modifier-mix";
+    readonly ITEM_TAX: "item-tax";
+    readonly EMPLOYEE_TIMECARD: "employee-timecard";
+    readonly EMPLOYEE_TIP: "employee-tip";
+    readonly SALES_BY_ITEM: "sales-by-item";
+    readonly DAILY_SALES: "daily-sales";
+    readonly DAILY_SALES_LIVE: "daily-sales-live";
+};
+type ReportType = (typeof Report)[keyof typeof Report];
+declare const getReportConfig: (reportType: ReportType) => ReportConfig<string> | null;
+
+declare function getColumnAlignment(type?: FieldType): ColumnAlignment;
+declare function isNumericType(type?: FieldType): boolean;
+
+interface CalculateReportTotalsOptions {
+    labelField: string;
+    label: string;
+}
+declare function calculateReportTotals<T>(data: T[], fieldConfig: Record<string, ColumnPresentationConfig>, opts: CalculateReportTotalsOptions): T;
+
+type SalesSummaryField = 'groupById' | 'groupByName' | 'salesAmountNet' | 'salesVarLW' | 'salesVarLY' | 'salesVarLWPct' | 'salesVarLYPct' | 'salesAmountNetLastWeek' | 'salesAmountNetLastYear' | 'salesAmountGross' | 'salesAmountGrossLastWeek' | 'salesAmountGrossLastYear' | 'ticketsCount' | 'ticketsCountLastWeek' | 'ticketsCountLastYear' | 'guestsCount' | 'guestsVarLW' | 'guestsVarLY' | 'guestsVarLWPct' | 'guestsVarLYPct' | 'guestsCountLastWeek' | 'guestsCountLastYear' | 'salesPerGuestTY' | 'salesPerGuestLW' | 'salesPerGuestLY';
+declare const SALES_SUMMARY_AVAILABLE_COLUMNS: SalesSummaryField[];
+declare const SALES_SUMMARY_DEFAULT_VISIBLE_COLUMNS: SalesSummaryField[];
+declare const salesSummaryConfig: ReportConfig<SalesSummaryField>;
+
+type TicketSummaryField = 'ticketId' | 'locationId' | 'orderName' | 'revenueCenterName' | 'daypartName' | 'inclusiveTaxesAmount' | 'locationName' | 'orderNumber' | 'businessDate' | 'ticketOpenedAt' | 'ticketClosedAt' | 'ticketTime' | 'ticketSubtotal' | 'discountsAmount' | 'surchargesAmount' | 'taxesAmount' | 'ticketGrandTotal' | 'gratuitiesAmount' | 'tipAmount' | 'paymentsAmount' | 'paymentTypeName' | 'guestsCount' | 'employeeName' | 'orderTypeName';
+declare const TICKET_SUMMARY_AVAILABLE_COLUMNS: TicketSummaryField[];
+declare const TICKET_SUMMARY_DEFAULT_VISIBLE_COLUMNS: TicketSummaryField[];
+declare const ticketSummaryConfig: ReportConfig<TicketSummaryField>;
+
+type TicketLiveField = 'locationName' | 'orderNumber' | 'dateOpen' | 'timeOpen' | 'dateClose' | 'timeClose' | 'durationMinutes' | 'subtotal' | 'discountTotal' | 'surchargeTotal' | 'taxTotal' | 'grandTotal' | 'gratuityTotal' | 'totalTips' | 'paymentsReceived' | 'paymentTypeName' | 'guestCount' | 'customerName' | 'employeeName' | 'orderType';
+declare const TICKET_LIVE_AVAILABLE_COLUMNS: TicketLiveField[];
+declare const TICKET_LIVE_DEFAULT_VISIBLE_COLUMNS: TicketLiveField[];
+declare const ticketLiveConfig: ReportConfig<TicketLiveField>;
+
+type ProductMixField = 'groupById' | 'groupByName' | 'salesAmountGross' | 'discountsAmount' | 'inclusiveTaxesAmount' | 'salesAmountNet' | 'itemsQuantity' | 'avgPrice' | 'salesMixPct';
+declare const PRODUCT_MIX_AVAILABLE_COLUMNS: ProductMixField[];
+declare const PRODUCT_MIX_DEFAULT_VISIBLE_COLUMNS: ProductMixField[];
+declare const PRODUCT_MIX_CHART_FIELDS: ProductMixField[];
+declare const productMixConfig: ReportConfig<ProductMixField>;
+
+type ModifierMixField = 'groupById' | 'groupByName' | 'groupById2' | 'groupByName2' | 'modifiersSales' | 'modifiersQuantity' | 'itemsQuantity' | 'avgGross' | 'attachRate' | 'modifiersSalesComp' | 'modifiersQuantityComp' | 'itemsQuantityComp' | 'attachRateComp' | 'modifiersSalesVar' | 'modifiersSalesVarPct' | 'modifiersQuantityVar' | 'modifiersQuantityVarPct' | 'attachRateVar' | 'attachRateVarPct';
+declare const MODIFIER_MIX_AVAILABLE_COLUMNS: ModifierMixField[];
+declare const MODIFIER_MIX_DEFAULT_VISIBLE_COLUMNS: ModifierMixField[];
+declare const modifierMixConfig: ReportConfig<ModifierMixField>;
+
+type ItemTaxField = 'locationId' | 'taxIsFlat' | 'merchantId' | 'locationName' | 'locationCity' | 'locationState' | 'itemName' | 'itemPrice' | 'departmentName' | 'revenueClassName' | 'orderTypeName' | 'taxName' | 'taxValue' | 'taxRate' | 'recordsCount' | 'taxableSales' | 'totalCollected' | 'itemTax' | 'taxCollected';
+declare const ITEM_TAX_AVAILABLE_COLUMNS: ItemTaxField[];
+declare const ITEM_TAX_DEFAULT_VISIBLE_COLUMNS: ItemTaxField[];
+declare const itemTaxConfig: ReportConfig<ItemTaxField>;
+
+type DailySalesField = 'groupById' | 'groupByName' | 'itemsQuantity' | 'salesAmountGross' | 'discountsAmount' | 'inclusiveTaxesAmount' | 'salesAmountNet' | 'salesMixPct' | 'avgPrice' | 'ticketsCount' | 'guestsCount' | 'ticketAverage' | 'guestAverage' | 'ticketAvg' | 'guestAvg';
+declare const DAILY_SALES_AVAILABLE_COLUMNS: DailySalesField[];
+declare const DAILY_SALES_BY_GROUP_AVAILABLE_COLUMNS: DailySalesField[];
+declare const DAILY_SALES_DEFAULT_VISIBLE_COLUMNS: DailySalesField[];
+declare const dailySalesConfig: ReportConfig<DailySalesField>;
+declare const DAILY_SALES_TRENDS_AVAILABLE_COLUMNS: DailySalesField[];
+declare const dailySalesTrendsConfig: ReportConfig<DailySalesField>;
+
+type DailySalesPaymentsField = 'paymentTypeName' | 'paymentsCount' | 'paymentsAmount' | 'tipsAmount' | 'totalSales';
+declare const DAILY_SALES_PAYMENTS_AVAILABLE_COLUMNS: DailySalesPaymentsField[];
+declare const DAILY_SALES_PAYMENTS_DEFAULT_VISIBLE_COLUMNS: DailySalesPaymentsField[];
+declare const dailySalesPaymentsConfig: ReportConfig<DailySalesPaymentsField>;
+
+type DailySalesDiscountsField = 'discountName' | 'discountsCount' | 'discountsAmount';
+declare const DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS: DailySalesDiscountsField[];
+declare const DAILY_SALES_DISCOUNTS_DEFAULT_VISIBLE_COLUMNS: DailySalesDiscountsField[];
+declare const dailySalesDiscountsConfig: ReportConfig<DailySalesDiscountsField>;
+
+type DailySalesRefundsVoidsField = 'description' | 'count' | 'amount' | 'pctSales';
+declare const DAILY_SALES_REFUNDS_VOIDS_AVAILABLE_COLUMNS: DailySalesRefundsVoidsField[];
+declare const DAILY_SALES_REFUNDS_VOIDS_DEFAULT_VISIBLE_COLUMNS: DailySalesRefundsVoidsField[];
+declare const dailySalesRefundsVoidsConfig: ReportConfig<DailySalesRefundsVoidsField>;
+
+type DailySalesTaxesField = 'taxName' | 'taxableSales' | 'taxesAmount' | 'exemptSales';
+declare const DAILY_SALES_TAXES_AVAILABLE_COLUMNS: DailySalesTaxesField[];
+declare const DAILY_SALES_TAXES_DEFAULT_VISIBLE_COLUMNS: DailySalesTaxesField[];
+declare const dailySalesTaxesConfig: ReportConfig<DailySalesTaxesField>;
+
+type EmployeeTimecardField = 'locationId' | 'locationName' | 'businessDate' | 'employeeName' | 'isActive' | 'lookup' | 'payrollCode' | 'jobName' | 'isBreak' | 'startTime' | 'endTime' | 'shiftHours';
+declare const EMPLOYEE_TIMECARD_AVAILABLE_COLUMNS: EmployeeTimecardField[];
+declare const EMPLOYEE_TIMECARD_DEFAULT_VISIBLE_COLUMNS: EmployeeTimecardField[];
+declare const employeeTimecardConfig: ReportConfig<EmployeeTimecardField>;
+
+type SalesByItemDetailField = 'businessDate' | 'ticketClosedAt' | 'hourId' | 'daypartName' | 'locationId' | 'locationName' | 'departmentName' | 'itemName' | 'revenueCenterName' | 'revenueClassName' | 'salesAmountGross' | 'itemsQuantity' | 'transactionId' | 'guestsCount' | 'employeeName' | 'orderTypeName' | 'salesType' | 'itemPrice';
+declare const SALES_BY_ITEM_DETAIL_AVAILABLE_COLUMNS: SalesByItemDetailField[];
+declare const SALES_BY_ITEM_DETAIL_DEFAULT_VISIBLE_COLUMNS: SalesByItemDetailField[];
+declare const salesByItemDetailConfig: ReportConfig<SalesByItemDetailField>;
+
+type TimeFormat = '00:00' | '00:00:00' | '00:00-24H';
+interface LocaleOption {
+    currency: string;
+    locale: string;
+}
+interface FormatDateOptions {
+    locale?: string;
+    timeZone?: string;
+    format?: TimeFormat;
+}
+interface FormatTimeOptions {
+    locale?: string;
+    timeZone?: string;
+    format: TimeFormat;
+}
+interface FormatMoneyOptions {
+    locale?: string;
+    currency?: string;
+    decimals?: number;
+}
+interface FormatNumberOptions {
+    locale?: string;
+    decimals?: number;
+}
+declare const formatDate: (date: Date, options?: FormatDateOptions) => string;
+declare const formatTime: (date: Date | string | number, options: FormatTimeOptions) => string;
+declare const formatMoney: (amount: number, options?: FormatMoneyOptions) => string;
+declare const formatPercent: (value: number, decimals?: number) => string;
+declare const formatInteger: (value: number) => string;
+declare const formatFixedNumber: (value: number, decimals?: number) => string;
+declare const formatString: (value: unknown) => string;
+declare const getNumberToFormat: (value: unknown) => number;
+declare const getDateToFormat: (value?: unknown) => Date | null;
+declare const formatMoneyWithoutSymbol: (amount: number, options?: FormatNumberOptions) => string;
+declare const getReportFormattingLocaleOptions: (locations: {
+    currency: string;
+    countryCode: string;
+    language: string;
+}[]) => LocaleOption[];
+declare const formatFieldValue: (value: unknown, type: FieldType, localeOptions: LocaleOption) => string;
+
+export { COLUMN_REGISTRY, type CalculateReportTotalsOptions, type ColumnAlignment, type ColumnGroupConfig, type ColumnMetadata, type ColumnPresentationConfig, DAILY_SALES_AVAILABLE_COLUMNS, DAILY_SALES_BY_GROUP_AVAILABLE_COLUMNS, DAILY_SALES_DEFAULT_VISIBLE_COLUMNS, DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS, DAILY_SALES_DISCOUNTS_DEFAULT_VISIBLE_COLUMNS, DAILY_SALES_PAYMENTS_AVAILABLE_COLUMNS, DAILY_SALES_PAYMENTS_DEFAULT_VISIBLE_COLUMNS, DAILY_SALES_REFUNDS_VOIDS_AVAILABLE_COLUMNS, DAILY_SALES_REFUNDS_VOIDS_DEFAULT_VISIBLE_COLUMNS, DAILY_SALES_TAXES_AVAILABLE_COLUMNS, DAILY_SALES_TAXES_DEFAULT_VISIBLE_COLUMNS, DAILY_SALES_TRENDS_AVAILABLE_COLUMNS, EMPLOYEE_TIMECARD_AVAILABLE_COLUMNS, EMPLOYEE_TIMECARD_DEFAULT_VISIBLE_COLUMNS, type FieldType, type FooterCalculation, type FooterCalculationType, type FormatDateOptions, type FormatMoneyOptions, type FormatNumberOptions, type FormatTimeOptions, ITEM_TAX_AVAILABLE_COLUMNS, ITEM_TAX_DEFAULT_VISIBLE_COLUMNS, type LocaleOption, MODIFIER_MIX_AVAILABLE_COLUMNS, MODIFIER_MIX_DEFAULT_VISIBLE_COLUMNS, PRODUCT_MIX_AVAILABLE_COLUMNS, PRODUCT_MIX_CHART_FIELDS, PRODUCT_MIX_DEFAULT_VISIBLE_COLUMNS, Report, type ReportColumnKey, type ReportConfig, type ReportType, SALES_BY_ITEM_DETAIL_AVAILABLE_COLUMNS, SALES_BY_ITEM_DETAIL_DEFAULT_VISIBLE_COLUMNS, SALES_SUMMARY_AVAILABLE_COLUMNS, SALES_SUMMARY_DEFAULT_VISIBLE_COLUMNS, TICKET_LIVE_AVAILABLE_COLUMNS, TICKET_LIVE_DEFAULT_VISIBLE_COLUMNS, TICKET_SUMMARY_AVAILABLE_COLUMNS, TICKET_SUMMARY_DEFAULT_VISIBLE_COLUMNS, type TimeFormat, calculateReportTotals, dailySalesConfig, dailySalesDiscountsConfig, dailySalesPaymentsConfig, dailySalesRefundsVoidsConfig, dailySalesTaxesConfig, dailySalesTrendsConfig, employeeTimecardConfig, formatDate, formatFieldValue, formatFixedNumber, formatInteger, formatMoney, formatMoneyWithoutSymbol, formatPercent, formatString, formatTime, getColumnAlignment, getColumnExportHeaderLabel, getColumnMetadata, getDateToFormat, getNumberToFormat, getReportConfig, getReportFormattingLocaleOptions, isNumericType, itemTaxConfig, modifierMixConfig, productMixConfig, salesByItemDetailConfig, salesSummaryConfig, ticketLiveConfig, ticketSummaryConfig };