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

package/dist/index.js

@@ -570,11 +570,13 @@ var dailySalesPaymentsConfig = {
 var FIRST_COLUMN_WIDTH6 = 240;
 var FIELDS9 = {
   discountName: { type: "string", columnKey: "discountName", size: FIRST_COLUMN_WIDTH6 },
-  discountsCount: { type: "number", columnKey: "discountCount", footerCalculation: { type: "sum" } },
+  ticketCount: { type: "number", columnKey: "ticketCount", footerCalculation: { type: "sum" } },
+  itemCount: { type: "number", columnKey: "itemCount", footerCalculation: { type: "sum" } },
   discountsAmount: { type: "money", columnKey: "discountAmount", footerCalculation: { type: "sum" } }
 };
 var DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS = [
-  "discountsCount",
+  "ticketCount",
+  "itemCount",
   "discountsAmount"
 ];
 var DAILY_SALES_DISCOUNTS_DEFAULT_VISIBLE_COLUMNS = DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS;
@@ -882,10 +884,15 @@ var COLUMN_REGISTRY = {
     shortTitleKey: "common.report-col.discount-amount.short",
     infoTextKey: "common.report-col.discount-amount.info"
   },
-  discountCount: {
-    titleKey: "common.report-col.discount-count",
-    shortTitleKey: "common.report-col.discount-count.short",
-    infoTextKey: "common.report-col.discount-count.info"
+  ticketCount: {
+    titleKey: "common.report-col.ticket-count",
+    shortTitleKey: "common.report-col.ticket-count.short",
+    infoTextKey: "common.report-col.ticket-count.info"
+  },
+  itemCount: {
+    titleKey: "common.report-col.item-count",
+    shortTitleKey: "common.report-col.item-count.short",
+    infoTextKey: "common.report-col.item-count.info"
   },
   discover: {
     titleKey: "common.report-col.discover",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@harbortouch/skytab-analytics-report-utils",
-	"version": "0.8.0",
+	"version": "0.8.2",
 	"description": "Centralized report column presentation configuration for SkyTab Analytics",
 	"engines": {
 		"node": ">=22.6.0",
@@ -21,7 +21,7 @@
 	],
 	"type": "module",
 	"scripts": {
-		"build": "tsup && tsc -p tsconfig.build.json",
+		"build": "tsup",
 		"dev": "tsup --watch",
 		"lint:js": "eslint src",
 		"lint:js:fix": "eslint src --fix",

package/dist/columns/columns.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/formatting.d.ts

@@ -1,41 +0,0 @@
-import type { FieldType } from './types';
-export type TimeFormat = '00:00' | '00:00:00' | '00:00-24H';
-export interface LocaleOption {
-    currency: string;
-    locale: string;
-}
-export interface FormatDateOptions {
-    locale?: string;
-    timeZone?: string;
-    format?: TimeFormat;
-}
-export interface FormatTimeOptions {
-    locale?: string;
-    timeZone?: string;
-    format: TimeFormat;
-}
-export interface FormatMoneyOptions {
-    locale?: string;
-    currency?: string;
-    decimals?: number;
-}
-export interface FormatNumberOptions {
-    locale?: string;
-    decimals?: number;
-}
-export declare const formatDate: (date: Date, options?: FormatDateOptions) => string;
-export declare const formatTime: (date: Date | string | number, options: FormatTimeOptions) => string;
-export declare const formatMoney: (amount: number, options?: FormatMoneyOptions) => string;
-export declare const formatPercent: (value: number, decimals?: number) => string;
-export declare const formatInteger: (value: number) => string;
-export declare const formatFixedNumber: (value: number, decimals?: number) => string;
-export declare const formatString: (value: unknown) => string;
-export declare const getNumberToFormat: (value: unknown) => number;
-export declare const getDateToFormat: (value?: unknown) => Date | null;
-export declare const formatMoneyWithoutSymbol: (amount: number, options?: FormatNumberOptions) => string;
-export declare const getReportFormattingLocaleOptions: (locations: {
-    currency: string;
-    countryCode: string;
-    language: string;
-}[]) => LocaleOption[];
-export declare const formatFieldValue: (value: unknown, type: FieldType, localeOptions: LocaleOption) => string;

package/dist/formatting.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/report.d.ts

@@ -1,16 +0,0 @@
-import type { ReportConfig } from './types';
-export 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";
-};
-export type ReportType = (typeof Report)[keyof typeof Report];
-export declare const getReportConfig: (reportType: ReportType) => ReportConfig<string> | null;

package/dist/reports/dailySales.d.ts

@@ -1,9 +0,0 @@
-import { type ReportConfig } from '../types';
-type DailySalesField = 'groupById' | 'groupByName' | 'itemsQuantity' | 'salesAmountGross' | 'discountsAmount' | 'inclusiveTaxesAmount' | 'salesAmountNet' | 'salesMixPct' | 'avgPrice' | 'ticketsCount' | 'guestsCount' | 'ticketAverage' | 'guestAverage' | 'ticketAvg' | 'guestAvg';
-export declare const DAILY_SALES_AVAILABLE_COLUMNS: DailySalesField[];
-export declare const DAILY_SALES_BY_GROUP_AVAILABLE_COLUMNS: DailySalesField[];
-export declare const DAILY_SALES_DEFAULT_VISIBLE_COLUMNS: DailySalesField[];
-export declare const dailySalesConfig: ReportConfig<DailySalesField>;
-export declare const DAILY_SALES_TRENDS_AVAILABLE_COLUMNS: DailySalesField[];
-export declare const dailySalesTrendsConfig: ReportConfig<DailySalesField>;
-export {};

package/dist/reports/dailySalesDiscounts.d.ts

@@ -1,6 +0,0 @@
-import { type ReportConfig } from '../types';
-type DailySalesDiscountsField = 'discountName' | 'discountsCount' | 'discountsAmount';
-export declare const DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS: DailySalesDiscountsField[];
-export declare const DAILY_SALES_DISCOUNTS_DEFAULT_VISIBLE_COLUMNS: DailySalesDiscountsField[];
-export declare const dailySalesDiscountsConfig: ReportConfig<DailySalesDiscountsField>;
-export {};

package/dist/reports/dailySalesPayments.d.ts

@@ -1,6 +0,0 @@
-import { type ReportConfig } from '../types';
-type DailySalesPaymentsField = 'paymentTypeName' | 'paymentsCount' | 'paymentsAmount' | 'tipsAmount' | 'totalSales';
-export declare const DAILY_SALES_PAYMENTS_AVAILABLE_COLUMNS: DailySalesPaymentsField[];
-export declare const DAILY_SALES_PAYMENTS_DEFAULT_VISIBLE_COLUMNS: DailySalesPaymentsField[];
-export declare const dailySalesPaymentsConfig: ReportConfig<DailySalesPaymentsField>;
-export {};

package/dist/reports/dailySalesRefundsVoids.d.ts

@@ -1,6 +0,0 @@
-import { type ReportConfig } from '../types';
-type DailySalesRefundsVoidsField = 'description' | 'count' | 'amount' | 'pctSales';
-export declare const DAILY_SALES_REFUNDS_VOIDS_AVAILABLE_COLUMNS: DailySalesRefundsVoidsField[];
-export declare const DAILY_SALES_REFUNDS_VOIDS_DEFAULT_VISIBLE_COLUMNS: DailySalesRefundsVoidsField[];
-export declare const dailySalesRefundsVoidsConfig: ReportConfig<DailySalesRefundsVoidsField>;
-export {};

package/dist/reports/dailySalesTaxes.d.ts

@@ -1,6 +0,0 @@
-import { type ReportConfig } from '../types';
-type DailySalesTaxesField = 'taxName' | 'taxableSales' | 'taxesAmount' | 'exemptSales';
-export declare const DAILY_SALES_TAXES_AVAILABLE_COLUMNS: DailySalesTaxesField[];
-export declare const DAILY_SALES_TAXES_DEFAULT_VISIBLE_COLUMNS: DailySalesTaxesField[];
-export declare const dailySalesTaxesConfig: ReportConfig<DailySalesTaxesField>;
-export {};

package/dist/reports/employeeTimecard.d.ts

@@ -1,6 +0,0 @@
-import { type ReportConfig } from '../types';
-type EmployeeTimecardField = 'locationId' | 'locationName' | 'businessDate' | 'employeeName' | 'isActive' | 'lookup' | 'payrollCode' | 'jobName' | 'isBreak' | 'startTime' | 'endTime' | 'shiftHours';
-export declare const EMPLOYEE_TIMECARD_AVAILABLE_COLUMNS: EmployeeTimecardField[];
-export declare const EMPLOYEE_TIMECARD_DEFAULT_VISIBLE_COLUMNS: EmployeeTimecardField[];
-export declare const employeeTimecardConfig: ReportConfig<EmployeeTimecardField>;
-export {};

package/dist/reports/index.d.ts

@@ -1,10 +0,0 @@
-export { salesSummaryConfig, SALES_SUMMARY_AVAILABLE_COLUMNS, SALES_SUMMARY_DEFAULT_VISIBLE_COLUMNS, } from './salesSummary';
-export { ticketSummaryConfig, TICKET_SUMMARY_AVAILABLE_COLUMNS, TICKET_SUMMARY_DEFAULT_VISIBLE_COLUMNS, } from './ticketSummary';
-export { ticketLiveConfig, TICKET_LIVE_AVAILABLE_COLUMNS, TICKET_LIVE_DEFAULT_VISIBLE_COLUMNS } from './ticketLive';
-export { productMixConfig, PRODUCT_MIX_AVAILABLE_COLUMNS, PRODUCT_MIX_DEFAULT_VISIBLE_COLUMNS, PRODUCT_MIX_CHART_FIELDS, } from './productMix';
-export { modifierMixConfig, MODIFIER_MIX_AVAILABLE_COLUMNS, MODIFIER_MIX_DEFAULT_VISIBLE_COLUMNS } from './modifierMix';
-export { itemTaxConfig, ITEM_TAX_AVAILABLE_COLUMNS, ITEM_TAX_DEFAULT_VISIBLE_COLUMNS } from './itemTax';
-export { dailySalesConfig, dailySalesTrendsConfig, DAILY_SALES_AVAILABLE_COLUMNS, DAILY_SALES_DEFAULT_VISIBLE_COLUMNS, DAILY_SALES_BY_GROUP_AVAILABLE_COLUMNS, DAILY_SALES_TRENDS_AVAILABLE_COLUMNS, } from './dailySales';
-export { dailySalesPaymentsConfig, DAILY_SALES_PAYMENTS_AVAILABLE_COLUMNS, DAILY_SALES_PAYMENTS_DEFAULT_VISIBLE_COLUMNS, } from './dailySalesPayments';
-export { dailySalesDiscountsConfig, DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS, DAILY_SALES_DISCOUNTS_DEFAULT_VISIBLE_COLUMNS, } from './dailySalesDiscounts';
-export { employeeTimecardConfig, EMPLOYEE_TIMECARD_AVAILABLE_COLUMNS, EMPLOYEE_TIMECARD_DEFAULT_VISIBLE_COLUMNS, } from './employeeTimecard';

package/dist/reports/itemTax.d.ts

@@ -1,6 +0,0 @@
-import { type ReportConfig } from '../types';
-type ItemTaxField = 'locationId' | 'taxIsFlat' | 'merchantId' | 'locationName' | 'locationCity' | 'locationState' | 'itemName' | 'itemPrice' | 'departmentName' | 'revenueClassName' | 'orderTypeName' | 'taxName' | 'taxValue' | 'taxRate' | 'recordsCount' | 'taxableSales' | 'totalCollected' | 'itemTax' | 'taxCollected';
-export declare const ITEM_TAX_AVAILABLE_COLUMNS: ItemTaxField[];
-export declare const ITEM_TAX_DEFAULT_VISIBLE_COLUMNS: ItemTaxField[];
-export declare const itemTaxConfig: ReportConfig<ItemTaxField>;
-export {};

package/dist/reports/modifierMix.d.ts

@@ -1,6 +0,0 @@
-import { type ReportConfig } from '../types';
-type ModifierMixField = 'groupById' | 'groupByName' | 'groupById2' | 'groupByName2' | 'modifiersSales' | 'modifiersQuantity' | 'itemsQuantity' | 'avgGross' | 'attachRate' | 'modifiersSalesComp' | 'modifiersQuantityComp' | 'itemsQuantityComp' | 'attachRateComp' | 'modifiersSalesVar' | 'modifiersSalesVarPct' | 'modifiersQuantityVar' | 'modifiersQuantityVarPct' | 'attachRateVar' | 'attachRateVarPct';
-export declare const MODIFIER_MIX_AVAILABLE_COLUMNS: ModifierMixField[];
-export declare const MODIFIER_MIX_DEFAULT_VISIBLE_COLUMNS: ModifierMixField[];
-export declare const modifierMixConfig: ReportConfig<ModifierMixField>;
-export {};

package/dist/reports/productMix.d.ts

@@ -1,7 +0,0 @@
-import { type ReportConfig } from '../types';
-type ProductMixField = 'groupById' | 'groupByName' | 'salesAmountGross' | 'discountsAmount' | 'inclusiveTaxesAmount' | 'salesAmountNet' | 'itemsQuantity' | 'avgPrice' | 'salesMixPct';
-export declare const PRODUCT_MIX_AVAILABLE_COLUMNS: ProductMixField[];
-export declare const PRODUCT_MIX_DEFAULT_VISIBLE_COLUMNS: ProductMixField[];
-export declare const PRODUCT_MIX_CHART_FIELDS: ProductMixField[];
-export declare const productMixConfig: ReportConfig<ProductMixField>;
-export {};

package/dist/reports/salesByItemDetail.d.ts

@@ -1,6 +0,0 @@
-import { type ReportConfig } from '../types';
-type SalesByItemDetailField = 'businessDate' | 'ticketClosedAt' | 'hourId' | 'daypartName' | 'locationId' | 'locationName' | 'departmentName' | 'itemName' | 'revenueCenterName' | 'revenueClassName' | 'salesAmountGross' | 'itemsQuantity' | 'transactionId' | 'guestsCount' | 'employeeName' | 'orderTypeName' | 'salesType' | 'itemPrice';
-export declare const SALES_BY_ITEM_DETAIL_AVAILABLE_COLUMNS: SalesByItemDetailField[];
-export declare const SALES_BY_ITEM_DETAIL_DEFAULT_VISIBLE_COLUMNS: SalesByItemDetailField[];
-export declare const salesByItemDetailConfig: ReportConfig<SalesByItemDetailField>;
-export {};

package/dist/reports/salesSummary.d.ts

@@ -1,6 +0,0 @@
-import { type ReportConfig } from '../types';
-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';
-export declare const SALES_SUMMARY_AVAILABLE_COLUMNS: SalesSummaryField[];
-export declare const SALES_SUMMARY_DEFAULT_VISIBLE_COLUMNS: SalesSummaryField[];
-export declare const salesSummaryConfig: ReportConfig<SalesSummaryField>;
-export {};

package/dist/reports/ticketLive.d.ts

@@ -1,6 +0,0 @@
-import { type ReportConfig } from '../types';
-type TicketLiveField = 'locationName' | 'orderNumber' | 'dateOpen' | 'timeOpen' | 'dateClose' | 'timeClose' | 'durationMinutes' | 'subtotal' | 'discountTotal' | 'surchargeTotal' | 'taxTotal' | 'grandTotal' | 'gratuityTotal' | 'totalTips' | 'paymentsReceived' | 'paymentTypeName' | 'guestCount' | 'customerName' | 'employeeName' | 'orderType';
-export declare const TICKET_LIVE_AVAILABLE_COLUMNS: TicketLiveField[];
-export declare const TICKET_LIVE_DEFAULT_VISIBLE_COLUMNS: TicketLiveField[];
-export declare const ticketLiveConfig: ReportConfig<TicketLiveField>;
-export {};

package/dist/reports/ticketSummary.d.ts

@@ -1,6 +0,0 @@
-import { type ReportConfig } from '../types';
-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';
-export declare const TICKET_SUMMARY_AVAILABLE_COLUMNS: TicketSummaryField[];
-export declare const TICKET_SUMMARY_DEFAULT_VISIBLE_COLUMNS: TicketSummaryField[];
-export declare const ticketSummaryConfig: ReportConfig<TicketSummaryField>;
-export {};

package/dist/totals.d.ts

@@ -1,6 +0,0 @@
-import { type ColumnPresentationConfig } from './types';
-export interface CalculateReportTotalsOptions {
-    labelField: string;
-    label: string;
-}
-export declare function calculateReportTotals<T>(data: T[], fieldConfig: Record<string, ColumnPresentationConfig>, opts: CalculateReportTotalsOptions): T;

package/dist/totals.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types.d.ts

@@ -1,30 +0,0 @@
-import { type ReportColumnKey } from './columns';
-export type FieldType = 'string' | 'money' | 'percent' | 'number' | 'fixedNumber' | 'date' | 'time' | 'boolean';
-export type ColumnAlignment = 'left' | 'right';
-export type FooterCalculationType = 'sum' | 'percentChange' | 'average' | 'none';
-export interface FooterCalculation<TField = string> {
-    type: FooterCalculationType;
-    numeratorField?: TField;
-    denominatorField?: TField;
-}
-export interface ColumnPresentationConfig<TField = string> {
-    columnKey?: ReportColumnKey;
-    type: FieldType;
-    size?: number;
-    enableSorting?: boolean;
-    filteringAvailable?: boolean;
-    footerCalculation?: FooterCalculation<TField>;
-}
-export interface ColumnGroupConfig {
-    id: string;
-    headerTranslationKey: string;
-    baseFields: string[];
-    lastWeekFields?: string[];
-    lastYearFields?: string[];
-}
-export interface ReportConfig<TField extends string = string> {
-    fields: Record<TField, ColumnPresentationConfig<TField>>;
-    availableColumns: TField[];
-    defaultVisibleColumns: TField[];
-    columnGroups?: ColumnGroupConfig[];
-}

package/dist/utils/alignment.d.ts

@@ -1,3 +0,0 @@
-import { type ColumnAlignment, type FieldType } from '../types';
-export declare function getColumnAlignment(type?: FieldType): ColumnAlignment;
-export declare function isNumericType(type?: FieldType): boolean;

package/dist/utils/alignment.test.d.ts

@@ -1 +0,0 @@
-export {};