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

package/dist/index.cjs

@@ -51,6 +51,7 @@ __export(index_exports, {
   TICKET_LIVE_DEFAULT_VISIBLE_COLUMNS: () => TICKET_LIVE_DEFAULT_VISIBLE_COLUMNS,
   TICKET_SUMMARY_AVAILABLE_COLUMNS: () => TICKET_SUMMARY_AVAILABLE_COLUMNS,
   TICKET_SUMMARY_DEFAULT_VISIBLE_COLUMNS: () => TICKET_SUMMARY_DEFAULT_VISIBLE_COLUMNS,
+  calculateFieldTotal: () => calculateFieldTotal,
   calculateReportTotals: () => calculateReportTotals,
   dailySalesConfig: () => dailySalesConfig,
   dailySalesDiscountsConfig: () => dailySalesDiscountsConfig,
@@ -98,18 +99,18 @@ var FIELDS = {
     type: "percent",
     columnKey: "salesVarLwPct",
     footerCalculation: {
-      type: "percentChange",
-      numeratorField: "salesAmountNet",
-      denominatorField: "salesAmountNetLastWeek"
+      type: "variancePercent",
+      numeratorField: "salesVarLW",
+      denominatorField: "salesAmountNet"
     }
   },
   salesVarLYPct: {
     type: "percent",
     columnKey: "salesVarLyPct",
     footerCalculation: {
-      type: "percentChange",
-      numeratorField: "salesAmountNet",
-      denominatorField: "salesAmountNetLastYear"
+      type: "variancePercent",
+      numeratorField: "salesVarLY",
+      denominatorField: "salesAmountNet"
     }
   },
   salesAmountNetLastWeek: { type: "money" },
@@ -127,18 +128,18 @@ var FIELDS = {
     type: "percent",
     columnKey: "guestsVarLwPct",
     footerCalculation: {
-      type: "percentChange",
-      numeratorField: "guestsCount",
-      denominatorField: "guestsCountLastWeek"
+      type: "variancePercent",
+      numeratorField: "guestsVarLW",
+      denominatorField: "guestsCount"
     }
   },
   guestsVarLYPct: {
     type: "percent",
     columnKey: "guestsVarLyPct",
     footerCalculation: {
-      type: "percentChange",
-      numeratorField: "guestsCount",
-      denominatorField: "guestsCountLastYear"
+      type: "variancePercent",
+      numeratorField: "guestsVarLY",
+      denominatorField: "guestsCount"
     }
   },
   guestsCountLastWeek: { type: "number" },
@@ -156,18 +157,22 @@ var FIELDS = {
     type: "money",
     columnKey: "salesPerGuestLw",
     footerCalculation: {
-      type: "average",
-      numeratorField: "salesAmountNetLastWeek",
-      denominatorField: "guestsCountLastWeek"
+      type: "quotientOfDifferences",
+      numeratorField: "salesAmountNet",
+      numeratorAdjustField: "salesVarLW",
+      denominatorField: "guestsCount",
+      denominatorAdjustField: "guestsVarLW"
     }
   },
   salesPerGuestLY: {
     type: "money",
     columnKey: "salesPerGuestLy",
     footerCalculation: {
-      type: "average",
-      numeratorField: "salesAmountNetLastYear",
-      denominatorField: "guestsCountLastYear"
+      type: "quotientOfDifferences",
+      numeratorField: "salesAmountNet",
+      numeratorAdjustField: "salesVarLY",
+      denominatorField: "guestsCount",
+      denominatorAdjustField: "guestsVarLY"
     }
   }
 };
@@ -509,7 +514,16 @@ var FIELDS6 = {
   orderTypeName: { type: "string", columnKey: "orderType", filteringAvailable: false },
   taxName: { type: "string", columnKey: "taxName", filteringAvailable: false },
   taxValue: { type: "money", columnKey: "taxableSales" },
-  taxRate: { type: "number", columnKey: "taxRate" },
+  taxRate: {
+    type: "conditional",
+    columnKey: "taxRate",
+    conditionalConfiguration: {
+      conditionalField: "taxIsFlat",
+      conditionalFormat: (field) => {
+        return field ? "money" : "percent";
+      }
+    }
+  },
   recordsCount: { type: "number", columnKey: "quantity" },
   taxableSales: { type: "money", columnKey: "taxableSales" },
   totalCollected: { type: "money", columnKey: "totalCollected" },
@@ -1515,65 +1529,54 @@ function isNumericType(type) {
 }
 
 // src/totals.ts
-function calculateReportTotals(data, fieldConfig, opts) {
-  const rows = data;
-  const { labelField, label } = opts;
-  const fieldsToSum = /* @__PURE__ */ new Set();
-  const derivedFields = [];
-  for (const [field, config] of Object.entries(fieldConfig)) {
-    const { type, columnKey, footerCalculation: calc } = config;
-    if (!type || type === "string" || type === "date" || type === "time" || type === "boolean") {
-      continue;
-    }
-    if (calc?.type === "none") {
-    } else if (!calc || calc.type === "sum") {
-      if (columnKey || calc?.type === "sum") {
-        fieldsToSum.add(field);
-      }
-    } else {
-      derivedFields.push({ field, calc });
-      if (calc.numeratorField) {
-        fieldsToSum.add(calc.numeratorField);
-      }
-      if (calc.denominatorField) {
-        fieldsToSum.add(calc.denominatorField);
-      }
-    }
+var sumField = (rows, field) => rows.reduce((acc, row) => acc + (row[field] ?? 0), 0);
+var calculateFieldTotal = (rows, field, config) => {
+  const { type } = config;
+  if (!type || type === "string" || type === "date" || type === "time" || type === "boolean" || type === "conditional") {
+    return null;
   }
-  const sums = {};
-  for (const field of fieldsToSum) {
-    sums[field] = rows.reduce((acc, row) => acc + (row[field] ?? 0), 0);
+  const calc = config.footerCalculation;
+  if (calc?.type === "none") {
+    return 0;
   }
-  const derived = {};
-  for (const { field, calc } of derivedFields) {
-    const num = sums[calc.numeratorField ?? ""] ?? 0;
-    const den = sums[calc.denominatorField ?? ""] ?? 0;
-    if (calc.type === "percentChange") {
-      derived[field] = den ? (num - den) / den : 0;
-    } else if (calc.type === "average") {
-      derived[field] = den > 0 ? num / den : 0;
-    }
+  if (!calc || calc.type === "sum") {
+    return config.columnKey || calc?.type === "sum" ? sumField(rows, field) : 0;
+  }
+  const { numeratorField, denominatorField } = calc;
+  if (!numeratorField || !denominatorField) {
+    return 0;
+  }
+  const num = sumField(rows, numeratorField);
+  const den = sumField(rows, denominatorField);
+  if (calc.type === "percentChange") {
+    return den ? (num - den) / den : 0;
+  }
+  if (calc.type === "variancePercent") {
+    const prior = den - num;
+    return prior ? num / prior : 0;
+  }
+  if (calc.type === "average") {
+    return den > 0 ? num / den : 0;
+  }
+  if (calc.type === "quotientOfDifferences") {
+    const { numeratorAdjustField, denominatorAdjustField } = calc;
+    const numAdj = numeratorAdjustField ? sumField(rows, numeratorAdjustField) : 0;
+    const denAdj = denominatorAdjustField ? sumField(rows, denominatorAdjustField) : 0;
+    const effectiveDen = den - denAdj;
+    return effectiveDen !== 0 ? (num - numAdj) / effectiveDen : 0;
   }
+  return 0;
+};
+var calculateReportTotals = (data, fieldConfig, opts) => {
+  const { labelField, label } = opts;
   const result = {};
   for (const [field, config] of Object.entries(fieldConfig)) {
-    const { type } = config;
-    if (!type || type === "string" || type === "date" || type === "time") {
-      result[field] = "";
-    } else if (type === "boolean") {
-      result[field] = false;
-    } else {
-      result[field] = 0;
-    }
+    const total = calculateFieldTotal(data, field, config);
+    result[field] = total ?? "";
   }
   result[labelField] = label;
-  for (const [field, value] of Object.entries(sums)) {
-    result[field] = value;
-  }
-  for (const [field, value] of Object.entries(derived)) {
-    result[field] = value;
-  }
   return result;
-}
+};
 
 // src/reports/dailySalesRefundsVoids.ts
 var FIRST_COLUMN_WIDTH8 = 240;
@@ -1720,9 +1723,18 @@ var getReportFormattingLocaleOptions = (locations) => {
     ).values()
   );
 };
-var formatFieldValue = (value, type, localeOptions) => {
+var DEFAULT_FIELD_CONFIG = { type: "string" };
+var formatFieldValue = (value, type, localeOptions, fullRecord, fieldConfig = DEFAULT_FIELD_CONFIG) => {
   const { currency, locale } = localeOptions;
   switch (type) {
+    case "conditional": {
+      if (!fullRecord) {
+        return formatString(value);
+      }
+      const conditionalConfig = fieldConfig.conditionalConfiguration;
+      const configType = conditionalConfig.conditionalFormat(fullRecord[conditionalConfig.conditionalField]);
+      return formatFieldValue(value, configType, localeOptions, fullRecord, fieldConfig);
+    }
     case "string":
       return formatString(value);
     case "money":
@@ -1777,6 +1789,7 @@ var formatFieldValue = (value, type, localeOptions) => {
   TICKET_LIVE_DEFAULT_VISIBLE_COLUMNS,
   TICKET_SUMMARY_AVAILABLE_COLUMNS,
   TICKET_SUMMARY_DEFAULT_VISIBLE_COLUMNS,
+  calculateFieldTotal,
   calculateReportTotals,
   dailySalesConfig,
   dailySalesDiscountsConfig,

package/dist/index.d.cts

@@ -1179,22 +1179,34 @@ declare function getColumnMetadata(key: ReportColumnKey): {
 };
 declare function getColumnExportHeaderLabel(colTitle: string, groupTitle: string | null): string;
 
-type FieldType = 'string' | 'money' | 'percent' | 'number' | 'fixedNumber' | 'date' | 'time' | 'boolean';
+type FieldType = 'string' | 'money' | 'percent' | 'number' | 'fixedNumber' | 'date' | 'time' | 'boolean' | 'conditional';
 type ColumnAlignment = 'left' | 'right';
-type FooterCalculationType = 'sum' | 'percentChange' | 'average' | 'none';
+type FooterCalculationType = 'sum' | 'percentChange' | 'variancePercent' | 'average' | 'quotientOfDifferences' | 'none';
 interface FooterCalculation<TField = string> {
     type: FooterCalculationType;
     numeratorField?: TField;
+    numeratorAdjustField?: string;
     denominatorField?: TField;
+    denominatorAdjustField?: string;
 }
-interface ColumnPresentationConfig<TField = string> {
+interface ConditionalConfiguration<TField = string> {
+    conditionalField: TField;
+    conditionalFormat: (value: unknown) => Exclude<FieldType, 'conditional'>;
+}
+interface BaseColumnPresentationConfig<TField = string> {
     columnKey?: ReportColumnKey;
-    type: FieldType;
     size?: number;
     enableSorting?: boolean;
     filteringAvailable?: boolean;
     footerCalculation?: FooterCalculation<TField>;
 }
+type ColumnPresentationConfig<TField = string> = (BaseColumnPresentationConfig<TField> & {
+    type: Exclude<FieldType, 'conditional'>;
+    conditionalConfiguration?: never;
+}) | (BaseColumnPresentationConfig<TField> & {
+    type: 'conditional';
+    conditionalConfiguration: ConditionalConfiguration<TField>;
+});
 interface ColumnGroupConfig {
     id: string;
     headerTranslationKey: string;
@@ -1232,7 +1244,8 @@ interface CalculateReportTotalsOptions {
     labelField: string;
     label: string;
 }
-declare function calculateReportTotals<T>(data: T[], fieldConfig: Record<string, ColumnPresentationConfig>, opts: CalculateReportTotalsOptions): T;
+declare const calculateFieldTotal: <T>(rows: T[], field: keyof T, config: ColumnPresentationConfig) => number | null;
+declare const 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[];
@@ -1342,6 +1355,6 @@ declare const getReportFormattingLocaleOptions: (locations: {
     countryCode: string;
     language: string;
 }[]) => LocaleOption[];
-declare const formatFieldValue: (value: unknown, type: FieldType, localeOptions: LocaleOption) => string;
+declare const formatFieldValue: (value: unknown, type: FieldType, localeOptions: LocaleOption, fullRecord: Record<string, unknown> | null | undefined, fieldConfig?: ColumnPresentationConfig) => 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 };
+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, calculateFieldTotal, 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 };

package/dist/index.d.ts

@@ -1179,22 +1179,34 @@ declare function getColumnMetadata(key: ReportColumnKey): {
 };
 declare function getColumnExportHeaderLabel(colTitle: string, groupTitle: string | null): string;
 
-type FieldType = 'string' | 'money' | 'percent' | 'number' | 'fixedNumber' | 'date' | 'time' | 'boolean';
+type FieldType = 'string' | 'money' | 'percent' | 'number' | 'fixedNumber' | 'date' | 'time' | 'boolean' | 'conditional';
 type ColumnAlignment = 'left' | 'right';
-type FooterCalculationType = 'sum' | 'percentChange' | 'average' | 'none';
+type FooterCalculationType = 'sum' | 'percentChange' | 'variancePercent' | 'average' | 'quotientOfDifferences' | 'none';
 interface FooterCalculation<TField = string> {
     type: FooterCalculationType;
     numeratorField?: TField;
+    numeratorAdjustField?: string;
     denominatorField?: TField;
+    denominatorAdjustField?: string;
 }
-interface ColumnPresentationConfig<TField = string> {
+interface ConditionalConfiguration<TField = string> {
+    conditionalField: TField;
+    conditionalFormat: (value: unknown) => Exclude<FieldType, 'conditional'>;
+}
+interface BaseColumnPresentationConfig<TField = string> {
     columnKey?: ReportColumnKey;
-    type: FieldType;
     size?: number;
     enableSorting?: boolean;
     filteringAvailable?: boolean;
     footerCalculation?: FooterCalculation<TField>;
 }
+type ColumnPresentationConfig<TField = string> = (BaseColumnPresentationConfig<TField> & {
+    type: Exclude<FieldType, 'conditional'>;
+    conditionalConfiguration?: never;
+}) | (BaseColumnPresentationConfig<TField> & {
+    type: 'conditional';
+    conditionalConfiguration: ConditionalConfiguration<TField>;
+});
 interface ColumnGroupConfig {
     id: string;
     headerTranslationKey: string;
@@ -1232,7 +1244,8 @@ interface CalculateReportTotalsOptions {
     labelField: string;
     label: string;
 }
-declare function calculateReportTotals<T>(data: T[], fieldConfig: Record<string, ColumnPresentationConfig>, opts: CalculateReportTotalsOptions): T;
+declare const calculateFieldTotal: <T>(rows: T[], field: keyof T, config: ColumnPresentationConfig) => number | null;
+declare const 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[];
@@ -1342,6 +1355,6 @@ declare const getReportFormattingLocaleOptions: (locations: {
     countryCode: string;
     language: string;
 }[]) => LocaleOption[];
-declare const formatFieldValue: (value: unknown, type: FieldType, localeOptions: LocaleOption) => string;
+declare const formatFieldValue: (value: unknown, type: FieldType, localeOptions: LocaleOption, fullRecord: Record<string, unknown> | null | undefined, fieldConfig?: ColumnPresentationConfig) => 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 };
+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, calculateFieldTotal, 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 };

package/dist/index.js

@@ -10,18 +10,18 @@ var FIELDS = {
     type: "percent",
     columnKey: "salesVarLwPct",
     footerCalculation: {
-      type: "percentChange",
-      numeratorField: "salesAmountNet",
-      denominatorField: "salesAmountNetLastWeek"
+      type: "variancePercent",
+      numeratorField: "salesVarLW",
+      denominatorField: "salesAmountNet"
     }
   },
   salesVarLYPct: {
     type: "percent",
     columnKey: "salesVarLyPct",
     footerCalculation: {
-      type: "percentChange",
-      numeratorField: "salesAmountNet",
-      denominatorField: "salesAmountNetLastYear"
+      type: "variancePercent",
+      numeratorField: "salesVarLY",
+      denominatorField: "salesAmountNet"
     }
   },
   salesAmountNetLastWeek: { type: "money" },
@@ -39,18 +39,18 @@ var FIELDS = {
     type: "percent",
     columnKey: "guestsVarLwPct",
     footerCalculation: {
-      type: "percentChange",
-      numeratorField: "guestsCount",
-      denominatorField: "guestsCountLastWeek"
+      type: "variancePercent",
+      numeratorField: "guestsVarLW",
+      denominatorField: "guestsCount"
     }
   },
   guestsVarLYPct: {
     type: "percent",
     columnKey: "guestsVarLyPct",
     footerCalculation: {
-      type: "percentChange",
-      numeratorField: "guestsCount",
-      denominatorField: "guestsCountLastYear"
+      type: "variancePercent",
+      numeratorField: "guestsVarLY",
+      denominatorField: "guestsCount"
     }
   },
   guestsCountLastWeek: { type: "number" },
@@ -68,18 +68,22 @@ var FIELDS = {
     type: "money",
     columnKey: "salesPerGuestLw",
     footerCalculation: {
-      type: "average",
-      numeratorField: "salesAmountNetLastWeek",
-      denominatorField: "guestsCountLastWeek"
+      type: "quotientOfDifferences",
+      numeratorField: "salesAmountNet",
+      numeratorAdjustField: "salesVarLW",
+      denominatorField: "guestsCount",
+      denominatorAdjustField: "guestsVarLW"
     }
   },
   salesPerGuestLY: {
     type: "money",
     columnKey: "salesPerGuestLy",
     footerCalculation: {
-      type: "average",
-      numeratorField: "salesAmountNetLastYear",
-      denominatorField: "guestsCountLastYear"
+      type: "quotientOfDifferences",
+      numeratorField: "salesAmountNet",
+      numeratorAdjustField: "salesVarLY",
+      denominatorField: "guestsCount",
+      denominatorAdjustField: "guestsVarLY"
     }
   }
 };
@@ -421,7 +425,16 @@ var FIELDS6 = {
   orderTypeName: { type: "string", columnKey: "orderType", filteringAvailable: false },
   taxName: { type: "string", columnKey: "taxName", filteringAvailable: false },
   taxValue: { type: "money", columnKey: "taxableSales" },
-  taxRate: { type: "number", columnKey: "taxRate" },
+  taxRate: {
+    type: "conditional",
+    columnKey: "taxRate",
+    conditionalConfiguration: {
+      conditionalField: "taxIsFlat",
+      conditionalFormat: (field) => {
+        return field ? "money" : "percent";
+      }
+    }
+  },
   recordsCount: { type: "number", columnKey: "quantity" },
   taxableSales: { type: "money", columnKey: "taxableSales" },
   totalCollected: { type: "money", columnKey: "totalCollected" },
@@ -1427,65 +1440,54 @@ function isNumericType(type) {
 }
 
 // src/totals.ts
-function calculateReportTotals(data, fieldConfig, opts) {
-  const rows = data;
-  const { labelField, label } = opts;
-  const fieldsToSum = /* @__PURE__ */ new Set();
-  const derivedFields = [];
-  for (const [field, config] of Object.entries(fieldConfig)) {
-    const { type, columnKey, footerCalculation: calc } = config;
-    if (!type || type === "string" || type === "date" || type === "time" || type === "boolean") {
-      continue;
-    }
-    if (calc?.type === "none") {
-    } else if (!calc || calc.type === "sum") {
-      if (columnKey || calc?.type === "sum") {
-        fieldsToSum.add(field);
-      }
-    } else {
-      derivedFields.push({ field, calc });
-      if (calc.numeratorField) {
-        fieldsToSum.add(calc.numeratorField);
-      }
-      if (calc.denominatorField) {
-        fieldsToSum.add(calc.denominatorField);
-      }
-    }
+var sumField = (rows, field) => rows.reduce((acc, row) => acc + (row[field] ?? 0), 0);
+var calculateFieldTotal = (rows, field, config) => {
+  const { type } = config;
+  if (!type || type === "string" || type === "date" || type === "time" || type === "boolean" || type === "conditional") {
+    return null;
   }
-  const sums = {};
-  for (const field of fieldsToSum) {
-    sums[field] = rows.reduce((acc, row) => acc + (row[field] ?? 0), 0);
+  const calc = config.footerCalculation;
+  if (calc?.type === "none") {
+    return 0;
   }
-  const derived = {};
-  for (const { field, calc } of derivedFields) {
-    const num = sums[calc.numeratorField ?? ""] ?? 0;
-    const den = sums[calc.denominatorField ?? ""] ?? 0;
-    if (calc.type === "percentChange") {
-      derived[field] = den ? (num - den) / den : 0;
-    } else if (calc.type === "average") {
-      derived[field] = den > 0 ? num / den : 0;
-    }
+  if (!calc || calc.type === "sum") {
+    return config.columnKey || calc?.type === "sum" ? sumField(rows, field) : 0;
+  }
+  const { numeratorField, denominatorField } = calc;
+  if (!numeratorField || !denominatorField) {
+    return 0;
+  }
+  const num = sumField(rows, numeratorField);
+  const den = sumField(rows, denominatorField);
+  if (calc.type === "percentChange") {
+    return den ? (num - den) / den : 0;
+  }
+  if (calc.type === "variancePercent") {
+    const prior = den - num;
+    return prior ? num / prior : 0;
+  }
+  if (calc.type === "average") {
+    return den > 0 ? num / den : 0;
+  }
+  if (calc.type === "quotientOfDifferences") {
+    const { numeratorAdjustField, denominatorAdjustField } = calc;
+    const numAdj = numeratorAdjustField ? sumField(rows, numeratorAdjustField) : 0;
+    const denAdj = denominatorAdjustField ? sumField(rows, denominatorAdjustField) : 0;
+    const effectiveDen = den - denAdj;
+    return effectiveDen !== 0 ? (num - numAdj) / effectiveDen : 0;
   }
+  return 0;
+};
+var calculateReportTotals = (data, fieldConfig, opts) => {
+  const { labelField, label } = opts;
   const result = {};
   for (const [field, config] of Object.entries(fieldConfig)) {
-    const { type } = config;
-    if (!type || type === "string" || type === "date" || type === "time") {
-      result[field] = "";
-    } else if (type === "boolean") {
-      result[field] = false;
-    } else {
-      result[field] = 0;
-    }
+    const total = calculateFieldTotal(data, field, config);
+    result[field] = total ?? "";
   }
   result[labelField] = label;
-  for (const [field, value] of Object.entries(sums)) {
-    result[field] = value;
-  }
-  for (const [field, value] of Object.entries(derived)) {
-    result[field] = value;
-  }
   return result;
-}
+};
 
 // src/reports/dailySalesRefundsVoids.ts
 var FIRST_COLUMN_WIDTH8 = 240;
@@ -1632,9 +1634,18 @@ var getReportFormattingLocaleOptions = (locations) => {
     ).values()
   );
 };
-var formatFieldValue = (value, type, localeOptions) => {
+var DEFAULT_FIELD_CONFIG = { type: "string" };
+var formatFieldValue = (value, type, localeOptions, fullRecord, fieldConfig = DEFAULT_FIELD_CONFIG) => {
   const { currency, locale } = localeOptions;
   switch (type) {
+    case "conditional": {
+      if (!fullRecord) {
+        return formatString(value);
+      }
+      const conditionalConfig = fieldConfig.conditionalConfiguration;
+      const configType = conditionalConfig.conditionalFormat(fullRecord[conditionalConfig.conditionalField]);
+      return formatFieldValue(value, configType, localeOptions, fullRecord, fieldConfig);
+    }
     case "string":
       return formatString(value);
     case "money":
@@ -1688,6 +1699,7 @@ export {
   TICKET_LIVE_DEFAULT_VISIBLE_COLUMNS,
   TICKET_SUMMARY_AVAILABLE_COLUMNS,
   TICKET_SUMMARY_DEFAULT_VISIBLE_COLUMNS,
+  calculateFieldTotal,
   calculateReportTotals,
   dailySalesConfig,
   dailySalesDiscountsConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@harbortouch/skytab-analytics-report-utils",
-	"version": "0.8.2",
+	"version": "0.10.0",
 	"description": "Centralized report column presentation configuration for SkyTab Analytics",
 	"engines": {
 		"node": ">=22.6.0",
@@ -22,7 +22,7 @@
 	"type": "module",
 	"scripts": {
 		"build": "tsup",
-		"dev": "tsup --watch",
+		"dev": "tsup --watch --no-clean",
 		"lint:js": "eslint src",
 		"lint:js:fix": "eslint src --fix",
 		"lint:types": "tsc --noEmit",