@harbortouch/skytab-analytics-report-utils 0.2.0

package/dist/reports/index.d.ts

@@ -0,0 +1,6 @@
+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';

package/dist/reports/itemTax.d.ts

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,7 @@
+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/salesSummary.d.ts

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,6 @@
+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

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

package/dist/types.d.ts

@@ -0,0 +1,30 @@
+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 {
+    type: FooterCalculationType;
+    numeratorField?: string;
+    denominatorField?: string;
+}
+export interface ColumnPresentationConfig {
+    columnKey?: ReportColumnKey;
+    type?: FieldType;
+    size?: number;
+    enableSorting?: boolean;
+    filteringAvailable?: boolean;
+    footerCalculation?: FooterCalculation;
+}
+export interface ColumnGroupConfig {
+    id: string;
+    headerTranslationKey: string;
+    baseFields: string[];
+    lastWeekFields?: string[];
+    lastYearFields?: string[];
+}
+export interface ReportConfig<TField extends string = string> {
+    fields: Record<TField, ColumnPresentationConfig>;
+    availableColumns: TField[];
+    defaultVisibleColumns: TField[];
+    columnGroups?: ColumnGroupConfig[];
+}

package/dist/utils/alignment.d.ts

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

package/package.json

@@ -0,0 +1,47 @@
+{
+	"name": "@harbortouch/skytab-analytics-report-utils",
+	"version": "0.2.0",
+	"description": "Centralized report column presentation configuration for SkyTab Analytics",
+	"engines": {
+		"node": ">=22.6.0",
+		"pnpm": ">=9.0.0"
+	},
+	"main": "dist/index.cjs",
+	"module": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js",
+			"require": "./dist/index.cjs"
+		}
+	},
+	"files": [
+		"dist"
+	],
+	"type": "module",
+	"scripts": {
+		"build": "tsup && tsc -p tsconfig.build.json",
+		"dev": "tsup --watch",
+		"lint:js": "eslint src",
+		"lint:js:fix": "eslint src --fix",
+		"lint:types": "tsc --noEmit",
+		"typecheck": "tsc --noEmit",
+		"prepare": "husky"
+	},
+	"devDependencies": {
+		"eslint": "^9.39.2",
+		"eslint-config-prettier": "^10.1.8",
+		"eslint-import-resolver-typescript": "^4.2.2",
+		"eslint-plugin-import": "^2.32.0",
+		"eslint-plugin-prettier": "^5.5.5",
+		"globals": "^17.0.0",
+		"husky": "^9.1.7",
+		"prettier": "^3.8.0",
+		"pretty-quick": "^4.2.2",
+		"tsup": "^8.0.0",
+		"typescript": "^5.9.3",
+		"typescript-eslint": "^8.53.1"
+	},
+	"packageManager": "pnpm@10.24.0+sha512.01ff8ae71b4419903b65c60fb2dc9d34cf8bb6e06d03bde112ef38f7a34d6904c424ba66bea5cdcf12890230bf39f9580473140ed9c946fef328b6e5238a345a"
+}