@harbortouch/skytab-analytics-report-utils 0.6.2 → 0.7.1

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

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

package/dist/formatting.d.ts

@@ -0,0 +1,37 @@
+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 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?: FormatMoneyOptions) => 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

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

package/dist/index.cjs

@@ -59,10 +59,22 @@ __export(index_exports, {
   dailySalesTaxesConfig: () => dailySalesTaxesConfig,
   dailySalesTrendsConfig: () => dailySalesTrendsConfig,
   employeeTimecardConfig: () => employeeTimecardConfig,
+  formatDate: () => formatDate,
+  formatFieldValue: () => formatFieldValue,
+  formatFixedNumber: () => formatFixedNumber,
+  formatInteger: () => formatInteger,
+  formatMoney: () => formatMoney,
+  formatMoneyWithoutSymbol: () => formatMoneyWithoutSymbol,
+  formatPercent: () => formatPercent,
+  formatString: () => formatString,
+  formatTime: () => formatTime,
   getColumnAlignment: () => getColumnAlignment,
   getColumnExportHeaderLabel: () => getColumnExportHeaderLabel,
   getColumnMetadata: () => getColumnMetadata,
+  getDateToFormat: () => getDateToFormat,
+  getNumberToFormat: () => getNumberToFormat,
   getReportConfig: () => getReportConfig,
+  getReportFormattingLocaleOptions: () => getReportFormattingLocaleOptions,
   isNumericType: () => isNumericType,
   itemTaxConfig: () => itemTaxConfig,
   modifierMixConfig: () => modifierMixConfig,
@@ -1587,6 +1599,112 @@ var dailySalesTaxesConfig = {
   availableColumns: DAILY_SALES_TAXES_AVAILABLE_COLUMNS,
   defaultVisibleColumns: DAILY_SALES_TAXES_DEFAULT_VISIBLE_COLUMNS
 };
+
+// src/formatting.ts
+var formatDate = (date, options = {}) => {
+  const { locale = "en-US", timeZone = "UTC" } = options;
+  const d = new Date(date);
+  return new Intl.DateTimeFormat(locale, {
+    dateStyle: "short",
+    timeZone
+  }).format(d);
+};
+var formatTime = (date, options) => {
+  const { locale = "en-US", timeZone = "UTC", format } = options;
+  const d = new Date(date);
+  if (format === "00:00") {
+    return new Intl.DateTimeFormat(locale, {
+      hour: "2-digit",
+      minute: "2-digit",
+      timeZone
+    }).format(d);
+  }
+  if (format === "00:00-24H") {
+    return new Intl.DateTimeFormat(locale, {
+      hour: "2-digit",
+      minute: "2-digit",
+      hour12: false,
+      hourCycle: "h23",
+      timeZone
+    }).format(d);
+  }
+  return new Intl.DateTimeFormat(locale, {
+    hour: "2-digit",
+    minute: "2-digit",
+    second: "2-digit",
+    timeZone
+  }).format(d);
+};
+var formatMoney = (amount, options = {}) => {
+  const { locale = "en-US", currency = "USD", decimals = 2 } = options;
+  return new Intl.NumberFormat(locale, {
+    style: "currency",
+    currency,
+    minimumFractionDigits: decimals,
+    maximumFractionDigits: decimals
+  }).format(amount);
+};
+var formatPercent = (value, decimals = 2) => `${value.toFixed(decimals)}%`;
+var formatInteger = (value) => Math.round(value).toString();
+var formatFixedNumber = (value, decimals = 2) => value.toFixed(decimals);
+var formatString = (value) => {
+  return value == null ? "" : typeof value === "string" ? value : typeof value === "number" || typeof value === "boolean" ? String(value) : "";
+};
+var getNumberToFormat = (value) => typeof value === "number" ? value : 0;
+var getDateToFormat = (value) => {
+  if (value instanceof Date) {
+    return isNaN(value.getTime()) ? null : value;
+  }
+  if (typeof value === "string" || typeof value === "number") {
+    const d = new Date(value);
+    return isNaN(d.getTime()) ? null : d;
+  }
+  return null;
+};
+var formatMoneyWithoutSymbol = (amount, options = {}) => {
+  const { locale = "en-US", decimals = 2 } = options;
+  return new Intl.NumberFormat(locale, {
+    minimumFractionDigits: decimals,
+    maximumFractionDigits: decimals
+  }).format(amount);
+};
+var getReportFormattingLocaleOptions = (locations) => {
+  if (locations.length === 0) {
+    return [{ currency: "USD", locale: "en-US" }];
+  }
+  return Array.from(
+    new Map(
+      locations.map((loc) => ({
+        currency: loc.currency,
+        locale: `${loc.language ?? "en"}-${loc.countryCode}`
+      })).map((item) => [`${item.currency}-${item.locale}`, item])
+    ).values()
+  );
+};
+var formatFieldValue = (value, type, localeOptions) => {
+  const { currency, locale } = localeOptions;
+  switch (type) {
+    case "string":
+      return formatString(value);
+    case "money":
+      return formatMoney(getNumberToFormat(value), { currency, locale });
+    case "percent":
+      return formatPercent(getNumberToFormat(value) * 100);
+    case "fixedNumber":
+      return formatFixedNumber(getNumberToFormat(value));
+    case "date": {
+      const d = getDateToFormat(value);
+      return d ? formatDate(d, { locale }) : "";
+    }
+    case "time": {
+      const d = getDateToFormat(value);
+      return d ? formatTime(d, { locale, format: "00:00:00" }) : "";
+    }
+    case "number":
+    default:
+      return String(getNumberToFormat(value));
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   COLUMN_REGISTRY,
@@ -1628,10 +1746,22 @@ var dailySalesTaxesConfig = {
   dailySalesTaxesConfig,
   dailySalesTrendsConfig,
   employeeTimecardConfig,
+  formatDate,
+  formatFieldValue,
+  formatFixedNumber,
+  formatInteger,
+  formatMoney,
+  formatMoneyWithoutSymbol,
+  formatPercent,
+  formatString,
+  formatTime,
   getColumnAlignment,
   getColumnExportHeaderLabel,
   getColumnMetadata,
+  getDateToFormat,
+  getNumberToFormat,
   getReportConfig,
+  getReportFormattingLocaleOptions,
   isNumericType,
   itemTaxConfig,
   modifierMixConfig,

package/dist/index.d.ts

@@ -17,3 +17,5 @@ export { dailySalesRefundsVoidsConfig, DAILY_SALES_REFUNDS_VOIDS_AVAILABLE_COLUM
 export { dailySalesTaxesConfig, DAILY_SALES_TAXES_AVAILABLE_COLUMNS, DAILY_SALES_TAXES_DEFAULT_VISIBLE_COLUMNS, } from './reports/dailySalesTaxes';
 export { employeeTimecardConfig, EMPLOYEE_TIMECARD_AVAILABLE_COLUMNS, EMPLOYEE_TIMECARD_DEFAULT_VISIBLE_COLUMNS, } from './reports/employeeTimecard';
 export { salesByItemDetailConfig, SALES_BY_ITEM_DETAIL_AVAILABLE_COLUMNS, SALES_BY_ITEM_DETAIL_DEFAULT_VISIBLE_COLUMNS, } from './reports/salesByItemDetail';
+export type { FormatDateOptions, FormatTimeOptions, FormatMoneyOptions, LocaleOption, TimeFormat } from './formatting';
+export { formatDate, formatTime, formatMoney, formatPercent, formatInteger, formatFixedNumber, formatString, getNumberToFormat, getDateToFormat, getReportFormattingLocaleOptions, formatMoneyWithoutSymbol, formatFieldValue, } from './formatting';

package/dist/index.js

@@ -1511,6 +1511,112 @@ var dailySalesTaxesConfig = {
   availableColumns: DAILY_SALES_TAXES_AVAILABLE_COLUMNS,
   defaultVisibleColumns: DAILY_SALES_TAXES_DEFAULT_VISIBLE_COLUMNS
 };
+
+// src/formatting.ts
+var formatDate = (date, options = {}) => {
+  const { locale = "en-US", timeZone = "UTC" } = options;
+  const d = new Date(date);
+  return new Intl.DateTimeFormat(locale, {
+    dateStyle: "short",
+    timeZone
+  }).format(d);
+};
+var formatTime = (date, options) => {
+  const { locale = "en-US", timeZone = "UTC", format } = options;
+  const d = new Date(date);
+  if (format === "00:00") {
+    return new Intl.DateTimeFormat(locale, {
+      hour: "2-digit",
+      minute: "2-digit",
+      timeZone
+    }).format(d);
+  }
+  if (format === "00:00-24H") {
+    return new Intl.DateTimeFormat(locale, {
+      hour: "2-digit",
+      minute: "2-digit",
+      hour12: false,
+      hourCycle: "h23",
+      timeZone
+    }).format(d);
+  }
+  return new Intl.DateTimeFormat(locale, {
+    hour: "2-digit",
+    minute: "2-digit",
+    second: "2-digit",
+    timeZone
+  }).format(d);
+};
+var formatMoney = (amount, options = {}) => {
+  const { locale = "en-US", currency = "USD", decimals = 2 } = options;
+  return new Intl.NumberFormat(locale, {
+    style: "currency",
+    currency,
+    minimumFractionDigits: decimals,
+    maximumFractionDigits: decimals
+  }).format(amount);
+};
+var formatPercent = (value, decimals = 2) => `${value.toFixed(decimals)}%`;
+var formatInteger = (value) => Math.round(value).toString();
+var formatFixedNumber = (value, decimals = 2) => value.toFixed(decimals);
+var formatString = (value) => {
+  return value == null ? "" : typeof value === "string" ? value : typeof value === "number" || typeof value === "boolean" ? String(value) : "";
+};
+var getNumberToFormat = (value) => typeof value === "number" ? value : 0;
+var getDateToFormat = (value) => {
+  if (value instanceof Date) {
+    return isNaN(value.getTime()) ? null : value;
+  }
+  if (typeof value === "string" || typeof value === "number") {
+    const d = new Date(value);
+    return isNaN(d.getTime()) ? null : d;
+  }
+  return null;
+};
+var formatMoneyWithoutSymbol = (amount, options = {}) => {
+  const { locale = "en-US", decimals = 2 } = options;
+  return new Intl.NumberFormat(locale, {
+    minimumFractionDigits: decimals,
+    maximumFractionDigits: decimals
+  }).format(amount);
+};
+var getReportFormattingLocaleOptions = (locations) => {
+  if (locations.length === 0) {
+    return [{ currency: "USD", locale: "en-US" }];
+  }
+  return Array.from(
+    new Map(
+      locations.map((loc) => ({
+        currency: loc.currency,
+        locale: `${loc.language ?? "en"}-${loc.countryCode}`
+      })).map((item) => [`${item.currency}-${item.locale}`, item])
+    ).values()
+  );
+};
+var formatFieldValue = (value, type, localeOptions) => {
+  const { currency, locale } = localeOptions;
+  switch (type) {
+    case "string":
+      return formatString(value);
+    case "money":
+      return formatMoney(getNumberToFormat(value), { currency, locale });
+    case "percent":
+      return formatPercent(getNumberToFormat(value) * 100);
+    case "fixedNumber":
+      return formatFixedNumber(getNumberToFormat(value));
+    case "date": {
+      const d = getDateToFormat(value);
+      return d ? formatDate(d, { locale }) : "";
+    }
+    case "time": {
+      const d = getDateToFormat(value);
+      return d ? formatTime(d, { locale, format: "00:00:00" }) : "";
+    }
+    case "number":
+    default:
+      return String(getNumberToFormat(value));
+  }
+};
 export {
   COLUMN_REGISTRY,
   DAILY_SALES_AVAILABLE_COLUMNS,
@@ -1551,10 +1657,22 @@ export {
   dailySalesTaxesConfig,
   dailySalesTrendsConfig,
   employeeTimecardConfig,
+  formatDate,
+  formatFieldValue,
+  formatFixedNumber,
+  formatInteger,
+  formatMoney,
+  formatMoneyWithoutSymbol,
+  formatPercent,
+  formatString,
+  formatTime,
   getColumnAlignment,
   getColumnExportHeaderLabel,
   getColumnMetadata,
+  getDateToFormat,
+  getNumberToFormat,
   getReportConfig,
+  getReportFormattingLocaleOptions,
   isNumericType,
   itemTaxConfig,
   modifierMixConfig,

package/dist/totals.test.d.ts

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@harbortouch/skytab-analytics-report-utils",
-	"version": "0.6.2",
+	"version": "0.7.1",
 	"description": "Centralized report column presentation configuration for SkyTab Analytics",
 	"engines": {
 		"node": ">=22.6.0",
@@ -26,6 +26,7 @@
 		"lint:js": "eslint src",
 		"lint:js:fix": "eslint src --fix",
 		"lint:types": "tsc --noEmit",
+		"test": "vitest run",
 		"typecheck": "tsc --noEmit",
 		"prepare": "husky"
 	},
@@ -41,7 +42,8 @@
 		"pretty-quick": "^4.2.2",
 		"tsup": "^8.0.0",
 		"typescript": "^5.9.3",
-		"typescript-eslint": "^8.53.1"
+		"typescript-eslint": "^8.53.1",
+		"vitest": "^4.1.5"
 	},
 	"packageManager": "pnpm@10.24.0+sha512.01ff8ae71b4419903b65c60fb2dc9d34cf8bb6e06d03bde112ef38f7a34d6904c424ba66bea5cdcf12890230bf39f9580473140ed9c946fef328b6e5238a345a"
 }