@gusto/embedded-react-sdk 0.46.2 → 0.47.0

package/dist/contexts/LocaleProvider/useLocale.d.ts

@@ -1,10 +1,49 @@
+/**
+ * Locale and currency settings supplied to {@link LocaleProvider}.
+ *
+ * @remarks
+ * `locale` is a BCP 47 language tag (defaults to `en-US`) used for `Intl` formatting and the
+ * rendered wrapper's `lang` attribute. `currency` is an ISO 4217 currency code (defaults to
+ * `USD`) consumed by currency-aware inputs.
+ *
+ * @internal
+ */
 export interface LocaleProps {
     locale?: string;
     currency?: string;
 }
+/**
+ * React context backing {@link useLocale} and {@link useLocaleDateFormatter}.
+ *
+ * @internal
+ */
 export declare const LocaleContext: import('react').Context<LocaleProps | null>;
+/**
+ * Returns the active locale and currency from the surrounding {@link LocaleProvider}.
+ *
+ * @returns An object with `locale` (defaulting to `en-US`) and `currency` (defaulting to `USD`).
+ * @throws An `Error` when called outside a {@link LocaleProvider}.
+ * @internal
+ *
+ * @example
+ * ```tsx
+ * import { useLocale } from '@gusto/embedded-react-sdk'
+ *
+ * function Amount({ value }: { value: number }) {
+ *   const { locale, currency } = useLocale()
+ *   return <span>{new Intl.NumberFormat(locale, { style: 'currency', currency }).format(value)}</span>
+ * }
+ * ```
+ */
 export declare const useLocale: () => {
     locale: string;
     currency: string;
 };
+/**
+ * Returns an `Intl.DateTimeFormat` configured with the active locale and a long-month, numeric-year, two-digit-day style.
+ *
+ * @returns An `Intl.DateTimeFormat` instance bound to the provider's locale (or `en-US` if unset).
+ * @throws An `Error` when called outside a {@link LocaleProvider}.
+ * @internal
+ */
 export declare const useLocaleDateFormatter: () => Intl.DateTimeFormat;

package/dist/contexts/LocaleProvider/useLocale.js.map

@@ -1 +1 @@
-{"version":3,"file":"useLocale.js","sources":["../../../src/contexts/LocaleProvider/useLocale.ts"],"sourcesContent":["import { createContext, useContext } from 'react'\n\nexport interface LocaleProps {\n  locale?: string\n  currency?: string\n}\n\nexport const LocaleContext = createContext<LocaleProps | null>(null)\n\nexport const useLocale = () => {\n  const values = useContext(LocaleContext)\n  if (!values) {\n    throw new Error('useLocal used outside provider')\n  }\n  return {\n    locale: values.locale ?? 'en-US',\n    currency: values.currency ?? 'USD',\n  }\n}\nexport const useLocaleDateFormatter = () => {\n  const values = useContext(LocaleContext)\n  if (!values) {\n    throw new Error('useLocaleDateFormatter used outside provider')\n  }\n  return new Intl.DateTimeFormat(values.locale ?? 'en-US', {\n    year: 'numeric',\n    month: 'long',\n    day: '2-digit',\n  })\n}\n"],"names":["LocaleContext","createContext","useLocale","values","useContext","useLocaleDateFormatter"],"mappings":";AAOO,MAAMA,IAAgBC,EAAkC,IAAI,GAEtDC,IAAY,MAAM;AAC7B,QAAMC,IAASC,EAAWJ,CAAa;AACvC,MAAI,CAACG;AACH,UAAM,IAAI,MAAM,gCAAgC;AAElD,SAAO;AAAA,IACL,QAAQA,EAAO,UAAU;AAAA,IACzB,UAAUA,EAAO,YAAY;AAAA,EAAA;AAEjC,GACaE,IAAyB,MAAM;AAC1C,QAAMF,IAASC,EAAWJ,CAAa;AACvC,MAAI,CAACG;AACH,UAAM,IAAI,MAAM,8CAA8C;AAEhE,SAAO,IAAI,KAAK,eAAeA,EAAO,UAAU,SAAS;AAAA,IACvD,MAAM;AAAA,IACN,OAAO;AAAA,IACP,KAAK;AAAA,EAAA,CACN;AACH;"}
+{"version":3,"file":"useLocale.js","sources":["../../../src/contexts/LocaleProvider/useLocale.ts"],"sourcesContent":["import { createContext, useContext } from 'react'\n\n/**\n * Locale and currency settings supplied to {@link LocaleProvider}.\n *\n * @remarks\n * `locale` is a BCP 47 language tag (defaults to `en-US`) used for `Intl` formatting and the\n * rendered wrapper's `lang` attribute. `currency` is an ISO 4217 currency code (defaults to\n * `USD`) consumed by currency-aware inputs.\n *\n * @internal\n */\nexport interface LocaleProps {\n  locale?: string\n  currency?: string\n}\n\n/**\n * React context backing {@link useLocale} and {@link useLocaleDateFormatter}.\n *\n * @internal\n */\nexport const LocaleContext = createContext<LocaleProps | null>(null)\n\n/**\n * Returns the active locale and currency from the surrounding {@link LocaleProvider}.\n *\n * @returns An object with `locale` (defaulting to `en-US`) and `currency` (defaulting to `USD`).\n * @throws An `Error` when called outside a {@link LocaleProvider}.\n * @internal\n *\n * @example\n * ```tsx\n * import { useLocale } from '@gusto/embedded-react-sdk'\n *\n * function Amount({ value }: { value: number }) {\n *   const { locale, currency } = useLocale()\n *   return <span>{new Intl.NumberFormat(locale, { style: 'currency', currency }).format(value)}</span>\n * }\n * ```\n */\nexport const useLocale = () => {\n  const values = useContext(LocaleContext)\n  if (!values) {\n    throw new Error('useLocal used outside provider')\n  }\n  return {\n    locale: values.locale ?? 'en-US',\n    currency: values.currency ?? 'USD',\n  }\n}\n/**\n * Returns an `Intl.DateTimeFormat` configured with the active locale and a long-month, numeric-year, two-digit-day style.\n *\n * @returns An `Intl.DateTimeFormat` instance bound to the provider's locale (or `en-US` if unset).\n * @throws An `Error` when called outside a {@link LocaleProvider}.\n * @internal\n */\nexport const useLocaleDateFormatter = () => {\n  const values = useContext(LocaleContext)\n  if (!values) {\n    throw new Error('useLocaleDateFormatter used outside provider')\n  }\n  return new Intl.DateTimeFormat(values.locale ?? 'en-US', {\n    year: 'numeric',\n    month: 'long',\n    day: '2-digit',\n  })\n}\n"],"names":["LocaleContext","createContext","useLocale","values","useContext","useLocaleDateFormatter"],"mappings":";AAsBO,MAAMA,IAAgBC,EAAkC,IAAI,GAmBtDC,IAAY,MAAM;AAC7B,QAAMC,IAASC,EAAWJ,CAAa;AACvC,MAAI,CAACG;AACH,UAAM,IAAI,MAAM,gCAAgC;AAElD,SAAO;AAAA,IACL,QAAQA,EAAO,UAAU;AAAA,IACzB,UAAUA,EAAO,YAAY;AAAA,EAAA;AAEjC,GAQaE,IAAyB,MAAM;AAC1C,QAAMF,IAASC,EAAWJ,CAAa;AACvC,MAAI,CAACG;AACH,UAAM,IAAI,MAAM,8CAA8C;AAEhE,SAAO,IAAI,KAAK,eAAeA,EAAO,UAAU,SAAS;AAAA,IACvD,MAAM;AAAA,IACN,OAAO;AAAA,IACP,KAAK;AAAA,EAAA,CACN;AACH;"}

package/dist/contexts/ObservabilityProvider/ObservabilityContext.d.ts

@@ -1,5 +1,16 @@
 import { ObservabilityHook } from '../../types/observability';
+/**
+ * Value provided by the SDK's observability context, exposing the configured observability hook to descendants.
+ *
+ * @internal
+ */
 export interface ObservabilityContextValue {
+    /** The partner-supplied observability hook, or `undefined` if none was configured. */
     observability: ObservabilityHook | undefined;
 }
+/**
+ * React context that carries the partner-supplied observability hook through the SDK provider tree.
+ *
+ * @internal
+ */
 export declare const ObservabilityContext: import('react').Context<ObservabilityContextValue | undefined>;

package/dist/contexts/ObservabilityProvider/ObservabilityContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"ObservabilityContext.js","sources":["../../../src/contexts/ObservabilityProvider/ObservabilityContext.ts"],"sourcesContent":["import { createContext } from 'react'\nimport type { ObservabilityHook } from '@/types/observability'\n\nexport interface ObservabilityContextValue {\n  observability: ObservabilityHook | undefined\n}\n\nexport const ObservabilityContext = createContext<ObservabilityContextValue | undefined>(undefined)\n"],"names":["ObservabilityContext","createContext"],"mappings":";AAOO,MAAMA,IAAuBC,EAAqD,MAAS;"}
+{"version":3,"file":"ObservabilityContext.js","sources":["../../../src/contexts/ObservabilityProvider/ObservabilityContext.ts"],"sourcesContent":["import { createContext } from 'react'\nimport type { ObservabilityHook } from '@/types/observability'\n\n/**\n * Value provided by the SDK's observability context, exposing the configured observability hook to descendants.\n *\n * @internal\n */\nexport interface ObservabilityContextValue {\n  /** The partner-supplied observability hook, or `undefined` if none was configured. */\n  observability: ObservabilityHook | undefined\n}\n\n/**\n * React context that carries the partner-supplied observability hook through the SDK provider tree.\n *\n * @internal\n */\nexport const ObservabilityContext = createContext<ObservabilityContextValue | undefined>(undefined)\n"],"names":["ObservabilityContext","createContext"],"mappings":";AAkBO,MAAMA,IAAuBC,EAAqD,MAAS;"}

package/dist/contexts/ObservabilityProvider/ObservabilityProvider.d.ts

@@ -1,7 +1,24 @@
 import { ReactNode } from 'react';
 import { ObservabilityHook } from '../../types/observability';
+/**
+ * Props for {@link ObservabilityProvider}.
+ *
+ * @internal
+ */
 export interface ObservabilityProviderProps {
     children: ReactNode;
     observability?: ObservabilityHook;
 }
-export declare const ObservabilityProvider: ({ children, observability }: ObservabilityProviderProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * Makes a partner-supplied observability hook available to SDK components for error and metric reporting.
+ *
+ * @remarks
+ * Typically mounted by `GustoProvider` when the `observability` config option is set. Errors and metrics
+ * emitted by SDK components are routed through {@link useObservability}, which applies PII sanitization
+ * before invoking the partner's `onError` and `onMetric` callbacks.
+ *
+ * @param props - {@link ObservabilityProviderProps} containing the children and optional observability hook.
+ * @returns The provider element wrapping `children` with the observability context.
+ * @internal
+ */
+export declare const ObservabilityProvider: ({ children, observability }: ObservabilityProviderProps) => import("react").JSX.Element;

package/dist/contexts/ObservabilityProvider/ObservabilityProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"ObservabilityProvider.js","sources":["../../../src/contexts/ObservabilityProvider/ObservabilityProvider.tsx"],"sourcesContent":["import type { ReactNode } from 'react'\nimport { useMemo } from 'react'\nimport { ObservabilityContext } from './ObservabilityContext'\nimport type { ObservabilityHook } from '@/types/observability'\n\nexport interface ObservabilityProviderProps {\n  children: ReactNode\n  observability?: ObservabilityHook\n}\n\nexport const ObservabilityProvider = ({ children, observability }: ObservabilityProviderProps) => {\n  const value = useMemo(() => ({ observability }), [observability])\n\n  return <ObservabilityContext.Provider value={value}>{children}</ObservabilityContext.Provider>\n}\n"],"names":["ObservabilityProvider","children","observability","value","useMemo","jsx","ObservabilityContext"],"mappings":";;;AAUO,MAAMA,IAAwB,CAAC,EAAE,UAAAC,GAAU,eAAAC,QAAgD;AAChG,QAAMC,IAAQC,EAAQ,OAAO,EAAE,eAAAF,MAAkB,CAACA,CAAa,CAAC;AAEhE,SAAO,gBAAAG,EAACC,EAAqB,UAArB,EAA8B,OAAAH,GAAe,UAAAF,EAAA,CAAS;AAChE;"}
+{"version":3,"file":"ObservabilityProvider.js","sources":["../../../src/contexts/ObservabilityProvider/ObservabilityProvider.tsx"],"sourcesContent":["import type { ReactNode } from 'react'\nimport { useMemo } from 'react'\nimport { ObservabilityContext } from './ObservabilityContext'\nimport type { ObservabilityHook } from '@/types/observability'\n\n/**\n * Props for {@link ObservabilityProvider}.\n *\n * @internal\n */\nexport interface ObservabilityProviderProps {\n  children: ReactNode\n  observability?: ObservabilityHook\n}\n\n/**\n * Makes a partner-supplied observability hook available to SDK components for error and metric reporting.\n *\n * @remarks\n * Typically mounted by `GustoProvider` when the `observability` config option is set. Errors and metrics\n * emitted by SDK components are routed through {@link useObservability}, which applies PII sanitization\n * before invoking the partner's `onError` and `onMetric` callbacks.\n *\n * @param props - {@link ObservabilityProviderProps} containing the children and optional observability hook.\n * @returns The provider element wrapping `children` with the observability context.\n * @internal\n */\nexport const ObservabilityProvider = ({ children, observability }: ObservabilityProviderProps) => {\n  const value = useMemo(() => ({ observability }), [observability])\n\n  return <ObservabilityContext.Provider value={value}>{children}</ObservabilityContext.Provider>\n}\n"],"names":["ObservabilityProvider","children","observability","value","useMemo","jsx","ObservabilityContext"],"mappings":";;;AA2BO,MAAMA,IAAwB,CAAC,EAAE,UAAAC,GAAU,eAAAC,QAAgD;AAChG,QAAMC,IAAQC,EAAQ,OAAO,EAAE,eAAAF,MAAkB,CAACA,CAAa,CAAC;AAEhE,SAAO,gBAAAG,EAACC,EAAqB,UAArB,EAA8B,OAAAH,GAAe,UAAAF,EAAA,CAAS;AAChE;"}

package/dist/contexts/ObservabilityProvider/index.d.ts

@@ -1,5 +1,5 @@
 import "./types/i18next.d.ts"
 export { ObservabilityProvider } from './ObservabilityProvider';
 export { useObservability } from './useObservability';
-export { normalizeToSDKError } from '../../types/sdkError';
 export type { ObservabilityProviderProps } from './ObservabilityProvider';
+export type { ObservabilityContextValue } from './ObservabilityContext';

package/dist/contexts/ObservabilityProvider/sanitization.d.ts

@@ -1,5 +1,54 @@
 import { ObservabilityError, ObservabilityMetric, SanitizationConfig } from '../../types/observability';
+/**
+ * Replaces PII patterns (SSN, email, phone, credit card, long tokens) in a string with redacted placeholders.
+ *
+ * @param value - The string to scan and redact.
+ * @returns The input with each matched pattern replaced by a `[TYPE-REDACTED]` placeholder.
+ * @internal
+ */
 export declare function sanitizeString(value: string): string;
+/**
+ * Recursively walks a value, redacting sensitive object keys and PII patterns in nested strings.
+ *
+ * @remarks
+ * Keys whose names match (case-insensitively contain) any built-in sensitive field name or any
+ * entry in `additionalSensitiveFields` have their values replaced with `[REDACTED]`. String
+ * values are passed through {@link sanitizeString} so PII patterns inside them are also redacted.
+ * Numbers, booleans, `null`, and `undefined` pass through unchanged.
+ *
+ * @param obj - The value to sanitize. May be any JSON-shaped structure.
+ * @param additionalSensitiveFields - Extra field names to treat as sensitive (case-insensitive substring match).
+ * @returns A new value of the same shape with sensitive fields and PII patterns redacted.
+ * @internal
+ */
 export declare function sanitizeObject(obj: unknown, additionalSensitiveFields?: string[]): unknown;
+/**
+ * Returns a copy of an observability error with PII redacted from messages and field-error metadata.
+ *
+ * @remarks
+ * If `config.customErrorSanitizer` is provided, it is invoked and its result returned directly.
+ * When sanitization is disabled, the error passes through unchanged except that `raw` is stripped
+ * unless `includeRawError` is true. When enabled, `message` and each `fieldErrors[].message` run
+ * through {@link sanitizeString}, and each `fieldErrors[].metadata` runs through {@link sanitizeObject}
+ * with `additionalSensitiveFields` applied.
+ *
+ * @param error - The error reported by SDK error boundaries or form submissions.
+ * @param config - Optional sanitization configuration; defaults to enabled with `raw` stripped.
+ * @returns The sanitized error suitable for forwarding to a partner observability hook.
+ * @internal
+ */
 export declare function sanitizeError(error: ObservabilityError, config?: SanitizationConfig): ObservabilityError;
+/**
+ * Returns a copy of an observability metric with sensitive values redacted from its tags.
+ *
+ * @remarks
+ * If `config.customMetricSanitizer` is provided, it is invoked and its result returned directly.
+ * When sanitization is disabled, the metric passes through unchanged. Otherwise the `tags` record
+ * is run through {@link sanitizeObject} with `additionalSensitiveFields` applied.
+ *
+ * @param metric - The metric reported by SDK component instrumentation.
+ * @param config - Optional sanitization configuration; defaults to enabled.
+ * @returns The sanitized metric suitable for forwarding to a partner observability hook.
+ * @internal
+ */
 export declare function sanitizeMetric(metric: ObservabilityMetric, config?: SanitizationConfig): ObservabilityMetric;

package/dist/contexts/ObservabilityProvider/sanitization.js.map

@@ -1 +1 @@
-{"version":3,"file":"sanitization.js","sources":["../../../src/contexts/ObservabilityProvider/sanitization.ts"],"sourcesContent":["import type {\n  ObservabilityError,\n  ObservabilityMetric,\n  SanitizationConfig,\n} from '@/types/observability'\n\nconst PII_PATTERNS = [\n  { pattern: /\\b\\d{3}-\\d{2}-\\d{4}\\b/g, replacement: '[SSN-REDACTED]' },\n  { pattern: /\\b\\d{9}\\b/g, replacement: '[SSN-REDACTED]' },\n  {\n    pattern: /\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Z|a-z]{2,}\\b/g,\n    replacement: '[EMAIL-REDACTED]',\n  },\n  { pattern: /\\b\\d{3}[-.\\s]?\\d{3}[-.\\s]?\\d{4}\\b/g, replacement: '[PHONE-REDACTED]' },\n  { pattern: /\\(\\d{3}\\)\\s*\\d{3}[-.\\s]?\\d{4}/g, replacement: '[PHONE-REDACTED]' },\n  { pattern: /\\b\\d{4}[-\\s]?\\d{4}[-\\s]?\\d{4}[-\\s]?\\d{4}\\b/g, replacement: '[CC-REDACTED]' },\n  { pattern: /\\b[A-Za-z0-9_-]{32,}\\b/g, replacement: '[TOKEN-REDACTED]' },\n]\n\nconst SENSITIVE_FIELD_NAMES = [\n  'password',\n  'token',\n  'apiKey',\n  'api_key',\n  'secret',\n  'ssn',\n  'social_security_number',\n  'creditCard',\n  'credit_card',\n  'cvv',\n  'pin',\n  'bankAccount',\n  'bank_account',\n  'routingNumber',\n  'routing_number',\n  'accountNumber',\n  'account_number',\n]\n\nexport function sanitizeString(value: string): string {\n  let sanitized = value\n\n  for (const { pattern, replacement } of PII_PATTERNS) {\n    sanitized = sanitized.replace(pattern, replacement)\n  }\n\n  return sanitized\n}\n\nexport function sanitizeObject(obj: unknown, additionalSensitiveFields: string[] = []): unknown {\n  if (obj === null || obj === undefined) {\n    return obj\n  }\n\n  if (typeof obj === 'string') {\n    return sanitizeString(obj)\n  }\n\n  if (typeof obj === 'number' || typeof obj === 'boolean') {\n    return obj\n  }\n\n  if (Array.isArray(obj)) {\n    return obj.map(item => sanitizeObject(item, additionalSensitiveFields))\n  }\n\n  if (typeof obj === 'object') {\n    const sanitized: Record<string, unknown> = {}\n\n    const allSensitiveFields = [...SENSITIVE_FIELD_NAMES, ...additionalSensitiveFields]\n\n    for (const [key, value] of Object.entries(obj)) {\n      if (allSensitiveFields.some(field => key.toLowerCase().includes(field.toLowerCase()))) {\n        sanitized[key] = '[REDACTED]'\n        continue\n      }\n\n      sanitized[key] = sanitizeObject(value, additionalSensitiveFields)\n    }\n\n    return sanitized\n  }\n\n  return obj\n}\n\nexport function sanitizeError(\n  error: ObservabilityError,\n  config: SanitizationConfig = {},\n): ObservabilityError {\n  const {\n    enabled = true,\n    includeRawError = false,\n    customErrorSanitizer,\n    additionalSensitiveFields = [],\n  } = config\n\n  if (customErrorSanitizer) {\n    return customErrorSanitizer(error)\n  }\n\n  if (!enabled) {\n    return includeRawError ? error : { ...error, raw: undefined }\n  }\n\n  const sanitizedFieldErrors = error.fieldErrors.map(fe => ({\n    ...fe,\n    message: sanitizeString(fe.message),\n    metadata: fe.metadata\n      ? (sanitizeObject(fe.metadata, additionalSensitiveFields) as Record<string, unknown>)\n      : undefined,\n  }))\n\n  return {\n    ...error,\n    message: sanitizeString(error.message),\n    fieldErrors: sanitizedFieldErrors,\n    raw: includeRawError ? error.raw : undefined,\n  }\n}\n\nexport function sanitizeMetric(\n  metric: ObservabilityMetric,\n  config: SanitizationConfig = {},\n): ObservabilityMetric {\n  const { enabled = true, customMetricSanitizer, additionalSensitiveFields = [] } = config\n\n  if (customMetricSanitizer) {\n    return customMetricSanitizer(metric)\n  }\n\n  if (!enabled) {\n    return metric\n  }\n\n  return {\n    ...metric,\n    tags: metric.tags\n      ? (sanitizeObject(metric.tags, additionalSensitiveFields) as Record<string, string>)\n      : undefined,\n  }\n}\n"],"names":["PII_PATTERNS","SENSITIVE_FIELD_NAMES","sanitizeString","value","sanitized","pattern","replacement","sanitizeObject","obj","additionalSensitiveFields","item","allSensitiveFields","key","field","sanitizeError","error","config","enabled","includeRawError","customErrorSanitizer","sanitizedFieldErrors","fe","sanitizeMetric","metric","customMetricSanitizer"],"mappings":"AAMA,MAAMA,IAAe;AAAA,EACnB,EAAE,SAAS,0BAA0B,aAAa,iBAAA;AAAA,EAClD,EAAE,SAAS,cAAc,aAAa,iBAAA;AAAA,EACtC;AAAA,IACE,SAAS;AAAA,IACT,aAAa;AAAA,EAAA;AAAA,EAEf,EAAE,SAAS,sCAAsC,aAAa,mBAAA;AAAA,EAC9D,EAAE,SAAS,kCAAkC,aAAa,mBAAA;AAAA,EAC1D,EAAE,SAAS,+CAA+C,aAAa,gBAAA;AAAA,EACvE,EAAE,SAAS,2BAA2B,aAAa,mBAAA;AACrD,GAEMC,IAAwB;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEO,SAASC,EAAeC,GAAuB;AACpD,MAAIC,IAAYD;AAEhB,aAAW,EAAE,SAAAE,GAAS,aAAAC,EAAA,KAAiBN;AACrC,IAAAI,IAAYA,EAAU,QAAQC,GAASC,CAAW;AAGpD,SAAOF;AACT;AAEO,SAASG,EAAeC,GAAcC,IAAsC,IAAa;AAC9F,MAAID,KAAQ;AACV,WAAOA;AAGT,MAAI,OAAOA,KAAQ;AACjB,WAAON,EAAeM,CAAG;AAG3B,MAAI,OAAOA,KAAQ,YAAY,OAAOA,KAAQ;AAC5C,WAAOA;AAGT,MAAI,MAAM,QAAQA,CAAG;AACnB,WAAOA,EAAI,IAAI,CAAAE,MAAQH,EAAeG,GAAMD,CAAyB,CAAC;AAGxE,MAAI,OAAOD,KAAQ,UAAU;AAC3B,UAAMJ,IAAqC,CAAA,GAErCO,IAAqB,CAAC,GAAGV,GAAuB,GAAGQ,CAAyB;AAElF,eAAW,CAACG,GAAKT,CAAK,KAAK,OAAO,QAAQK,CAAG,GAAG;AAC9C,UAAIG,EAAmB,KAAK,CAAAE,MAASD,EAAI,YAAA,EAAc,SAASC,EAAM,YAAA,CAAa,CAAC,GAAG;AACrF,QAAAT,EAAUQ,CAAG,IAAI;AACjB;AAAA,MACF;AAEA,MAAAR,EAAUQ,CAAG,IAAIL,EAAeJ,GAAOM,CAAyB;AAAA,IAClE;AAEA,WAAOL;AAAA,EACT;AAEA,SAAOI;AACT;AAEO,SAASM,EACdC,GACAC,IAA6B,IACT;AACpB,QAAM;AAAA,IACJ,SAAAC,IAAU;AAAA,IACV,iBAAAC,IAAkB;AAAA,IAClB,sBAAAC;AAAA,IACA,2BAAAV,IAA4B,CAAA;AAAA,EAAC,IAC3BO;AAEJ,MAAIG;AACF,WAAOA,EAAqBJ,CAAK;AAGnC,MAAI,CAACE;AACH,WAAOC,IAAkBH,IAAQ,EAAE,GAAGA,GAAO,KAAK,OAAA;AAGpD,QAAMK,IAAuBL,EAAM,YAAY,IAAI,CAAAM,OAAO;AAAA,IACxD,GAAGA;AAAA,IACH,SAASnB,EAAemB,EAAG,OAAO;AAAA,IAClC,UAAUA,EAAG,WACRd,EAAec,EAAG,UAAUZ,CAAyB,IACtD;AAAA,EAAA,EACJ;AAEF,SAAO;AAAA,IACL,GAAGM;AAAA,IACH,SAASb,EAAea,EAAM,OAAO;AAAA,IACrC,aAAaK;AAAA,IACb,KAAKF,IAAkBH,EAAM,MAAM;AAAA,EAAA;AAEvC;AAEO,SAASO,EACdC,GACAP,IAA6B,IACR;AACrB,QAAM,EAAE,SAAAC,IAAU,IAAM,uBAAAO,GAAuB,2BAAAf,IAA4B,CAAA,MAAOO;AAElF,SAAIQ,IACKA,EAAsBD,CAAM,IAGhCN,IAIE;AAAA,IACL,GAAGM;AAAA,IACH,MAAMA,EAAO,OACRhB,EAAegB,EAAO,MAAMd,CAAyB,IACtD;AAAA,EAAA,IAPGc;AASX;"}
+{"version":3,"file":"sanitization.js","sources":["../../../src/contexts/ObservabilityProvider/sanitization.ts"],"sourcesContent":["import type {\n  ObservabilityError,\n  ObservabilityMetric,\n  SanitizationConfig,\n} from '@/types/observability'\n\nconst PII_PATTERNS = [\n  { pattern: /\\b\\d{3}-\\d{2}-\\d{4}\\b/g, replacement: '[SSN-REDACTED]' },\n  { pattern: /\\b\\d{9}\\b/g, replacement: '[SSN-REDACTED]' },\n  {\n    pattern: /\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Z|a-z]{2,}\\b/g,\n    replacement: '[EMAIL-REDACTED]',\n  },\n  { pattern: /\\b\\d{3}[-.\\s]?\\d{3}[-.\\s]?\\d{4}\\b/g, replacement: '[PHONE-REDACTED]' },\n  { pattern: /\\(\\d{3}\\)\\s*\\d{3}[-.\\s]?\\d{4}/g, replacement: '[PHONE-REDACTED]' },\n  { pattern: /\\b\\d{4}[-\\s]?\\d{4}[-\\s]?\\d{4}[-\\s]?\\d{4}\\b/g, replacement: '[CC-REDACTED]' },\n  { pattern: /\\b[A-Za-z0-9_-]{32,}\\b/g, replacement: '[TOKEN-REDACTED]' },\n]\n\nconst SENSITIVE_FIELD_NAMES = [\n  'password',\n  'token',\n  'apiKey',\n  'api_key',\n  'secret',\n  'ssn',\n  'social_security_number',\n  'creditCard',\n  'credit_card',\n  'cvv',\n  'pin',\n  'bankAccount',\n  'bank_account',\n  'routingNumber',\n  'routing_number',\n  'accountNumber',\n  'account_number',\n]\n\n/**\n * Replaces PII patterns (SSN, email, phone, credit card, long tokens) in a string with redacted placeholders.\n *\n * @param value - The string to scan and redact.\n * @returns The input with each matched pattern replaced by a `[TYPE-REDACTED]` placeholder.\n * @internal\n */\nexport function sanitizeString(value: string): string {\n  let sanitized = value\n\n  for (const { pattern, replacement } of PII_PATTERNS) {\n    sanitized = sanitized.replace(pattern, replacement)\n  }\n\n  return sanitized\n}\n\n/**\n * Recursively walks a value, redacting sensitive object keys and PII patterns in nested strings.\n *\n * @remarks\n * Keys whose names match (case-insensitively contain) any built-in sensitive field name or any\n * entry in `additionalSensitiveFields` have their values replaced with `[REDACTED]`. String\n * values are passed through {@link sanitizeString} so PII patterns inside them are also redacted.\n * Numbers, booleans, `null`, and `undefined` pass through unchanged.\n *\n * @param obj - The value to sanitize. May be any JSON-shaped structure.\n * @param additionalSensitiveFields - Extra field names to treat as sensitive (case-insensitive substring match).\n * @returns A new value of the same shape with sensitive fields and PII patterns redacted.\n * @internal\n */\nexport function sanitizeObject(obj: unknown, additionalSensitiveFields: string[] = []): unknown {\n  if (obj === null || obj === undefined) {\n    return obj\n  }\n\n  if (typeof obj === 'string') {\n    return sanitizeString(obj)\n  }\n\n  if (typeof obj === 'number' || typeof obj === 'boolean') {\n    return obj\n  }\n\n  if (Array.isArray(obj)) {\n    return obj.map(item => sanitizeObject(item, additionalSensitiveFields))\n  }\n\n  if (typeof obj === 'object') {\n    const sanitized: Record<string, unknown> = {}\n\n    const allSensitiveFields = [...SENSITIVE_FIELD_NAMES, ...additionalSensitiveFields]\n\n    for (const [key, value] of Object.entries(obj)) {\n      if (allSensitiveFields.some(field => key.toLowerCase().includes(field.toLowerCase()))) {\n        sanitized[key] = '[REDACTED]'\n        continue\n      }\n\n      sanitized[key] = sanitizeObject(value, additionalSensitiveFields)\n    }\n\n    return sanitized\n  }\n\n  return obj\n}\n\n/**\n * Returns a copy of an observability error with PII redacted from messages and field-error metadata.\n *\n * @remarks\n * If `config.customErrorSanitizer` is provided, it is invoked and its result returned directly.\n * When sanitization is disabled, the error passes through unchanged except that `raw` is stripped\n * unless `includeRawError` is true. When enabled, `message` and each `fieldErrors[].message` run\n * through {@link sanitizeString}, and each `fieldErrors[].metadata` runs through {@link sanitizeObject}\n * with `additionalSensitiveFields` applied.\n *\n * @param error - The error reported by SDK error boundaries or form submissions.\n * @param config - Optional sanitization configuration; defaults to enabled with `raw` stripped.\n * @returns The sanitized error suitable for forwarding to a partner observability hook.\n * @internal\n */\nexport function sanitizeError(\n  error: ObservabilityError,\n  config: SanitizationConfig = {},\n): ObservabilityError {\n  const {\n    enabled = true,\n    includeRawError = false,\n    customErrorSanitizer,\n    additionalSensitiveFields = [],\n  } = config\n\n  if (customErrorSanitizer) {\n    return customErrorSanitizer(error)\n  }\n\n  if (!enabled) {\n    return includeRawError ? error : { ...error, raw: undefined }\n  }\n\n  const sanitizedFieldErrors = error.fieldErrors.map(fe => ({\n    ...fe,\n    message: sanitizeString(fe.message),\n    metadata: fe.metadata\n      ? (sanitizeObject(fe.metadata, additionalSensitiveFields) as Record<string, unknown>)\n      : undefined,\n  }))\n\n  return {\n    ...error,\n    message: sanitizeString(error.message),\n    fieldErrors: sanitizedFieldErrors,\n    raw: includeRawError ? error.raw : undefined,\n  }\n}\n\n/**\n * Returns a copy of an observability metric with sensitive values redacted from its tags.\n *\n * @remarks\n * If `config.customMetricSanitizer` is provided, it is invoked and its result returned directly.\n * When sanitization is disabled, the metric passes through unchanged. Otherwise the `tags` record\n * is run through {@link sanitizeObject} with `additionalSensitiveFields` applied.\n *\n * @param metric - The metric reported by SDK component instrumentation.\n * @param config - Optional sanitization configuration; defaults to enabled.\n * @returns The sanitized metric suitable for forwarding to a partner observability hook.\n * @internal\n */\nexport function sanitizeMetric(\n  metric: ObservabilityMetric,\n  config: SanitizationConfig = {},\n): ObservabilityMetric {\n  const { enabled = true, customMetricSanitizer, additionalSensitiveFields = [] } = config\n\n  if (customMetricSanitizer) {\n    return customMetricSanitizer(metric)\n  }\n\n  if (!enabled) {\n    return metric\n  }\n\n  return {\n    ...metric,\n    tags: metric.tags\n      ? (sanitizeObject(metric.tags, additionalSensitiveFields) as Record<string, string>)\n      : undefined,\n  }\n}\n"],"names":["PII_PATTERNS","SENSITIVE_FIELD_NAMES","sanitizeString","value","sanitized","pattern","replacement","sanitizeObject","obj","additionalSensitiveFields","item","allSensitiveFields","key","field","sanitizeError","error","config","enabled","includeRawError","customErrorSanitizer","sanitizedFieldErrors","fe","sanitizeMetric","metric","customMetricSanitizer"],"mappings":"AAMA,MAAMA,IAAe;AAAA,EACnB,EAAE,SAAS,0BAA0B,aAAa,iBAAA;AAAA,EAClD,EAAE,SAAS,cAAc,aAAa,iBAAA;AAAA,EACtC;AAAA,IACE,SAAS;AAAA,IACT,aAAa;AAAA,EAAA;AAAA,EAEf,EAAE,SAAS,sCAAsC,aAAa,mBAAA;AAAA,EAC9D,EAAE,SAAS,kCAAkC,aAAa,mBAAA;AAAA,EAC1D,EAAE,SAAS,+CAA+C,aAAa,gBAAA;AAAA,EACvE,EAAE,SAAS,2BAA2B,aAAa,mBAAA;AACrD,GAEMC,IAAwB;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AASO,SAASC,EAAeC,GAAuB;AACpD,MAAIC,IAAYD;AAEhB,aAAW,EAAE,SAAAE,GAAS,aAAAC,EAAA,KAAiBN;AACrC,IAAAI,IAAYA,EAAU,QAAQC,GAASC,CAAW;AAGpD,SAAOF;AACT;AAgBO,SAASG,EAAeC,GAAcC,IAAsC,IAAa;AAC9F,MAAID,KAAQ;AACV,WAAOA;AAGT,MAAI,OAAOA,KAAQ;AACjB,WAAON,EAAeM,CAAG;AAG3B,MAAI,OAAOA,KAAQ,YAAY,OAAOA,KAAQ;AAC5C,WAAOA;AAGT,MAAI,MAAM,QAAQA,CAAG;AACnB,WAAOA,EAAI,IAAI,CAAAE,MAAQH,EAAeG,GAAMD,CAAyB,CAAC;AAGxE,MAAI,OAAOD,KAAQ,UAAU;AAC3B,UAAMJ,IAAqC,CAAA,GAErCO,IAAqB,CAAC,GAAGV,GAAuB,GAAGQ,CAAyB;AAElF,eAAW,CAACG,GAAKT,CAAK,KAAK,OAAO,QAAQK,CAAG,GAAG;AAC9C,UAAIG,EAAmB,KAAK,CAAAE,MAASD,EAAI,YAAA,EAAc,SAASC,EAAM,YAAA,CAAa,CAAC,GAAG;AACrF,QAAAT,EAAUQ,CAAG,IAAI;AACjB;AAAA,MACF;AAEA,MAAAR,EAAUQ,CAAG,IAAIL,EAAeJ,GAAOM,CAAyB;AAAA,IAClE;AAEA,WAAOL;AAAA,EACT;AAEA,SAAOI;AACT;AAiBO,SAASM,EACdC,GACAC,IAA6B,IACT;AACpB,QAAM;AAAA,IACJ,SAAAC,IAAU;AAAA,IACV,iBAAAC,IAAkB;AAAA,IAClB,sBAAAC;AAAA,IACA,2BAAAV,IAA4B,CAAA;AAAA,EAAC,IAC3BO;AAEJ,MAAIG;AACF,WAAOA,EAAqBJ,CAAK;AAGnC,MAAI,CAACE;AACH,WAAOC,IAAkBH,IAAQ,EAAE,GAAGA,GAAO,KAAK,OAAA;AAGpD,QAAMK,IAAuBL,EAAM,YAAY,IAAI,CAAAM,OAAO;AAAA,IACxD,GAAGA;AAAA,IACH,SAASnB,EAAemB,EAAG,OAAO;AAAA,IAClC,UAAUA,EAAG,WACRd,EAAec,EAAG,UAAUZ,CAAyB,IACtD;AAAA,EAAA,EACJ;AAEF,SAAO;AAAA,IACL,GAAGM;AAAA,IACH,SAASb,EAAea,EAAM,OAAO;AAAA,IACrC,aAAaK;AAAA,IACb,KAAKF,IAAkBH,EAAM,MAAM;AAAA,EAAA;AAEvC;AAeO,SAASO,EACdC,GACAP,IAA6B,IACR;AACrB,QAAM,EAAE,SAAAC,IAAU,IAAM,uBAAAO,GAAuB,2BAAAf,IAA4B,CAAA,MAAOO;AAElF,SAAIQ,IACKA,EAAsBD,CAAM,IAGhCN,IAIE;AAAA,IACL,GAAGM;AAAA,IACH,MAAMA,EAAO,OACRhB,EAAegB,EAAO,MAAMd,CAAyB,IACtD;AAAA,EAAA,IAPGc;AASX;"}

package/dist/contexts/ObservabilityProvider/useObservability.d.ts

@@ -1,2 +1,16 @@
 import { ObservabilityContextValue } from './ObservabilityContext';
+/**
+ * Returns the partner-supplied observability hook with PII sanitization applied to its callbacks.
+ *
+ * @remarks
+ * SDK components call this hook to report errors and metrics. Each `onError` and `onMetric`
+ * payload is run through the configured sanitization (PII pattern redaction plus sensitive-field
+ * removal) before being passed to the partner's hook, so partner-side telemetry never receives
+ * raw form values or other sensitive data unless explicitly opted in via `sanitization` config.
+ * When no {@link ObservabilityProvider} is present, `observability` is `undefined` and reports
+ * are dropped.
+ *
+ * @returns A context value whose `observability` is either the sanitized hook or `undefined`.
+ * @internal
+ */
 export declare const useObservability: () => ObservabilityContextValue;

package/dist/contexts/ObservabilityProvider/useObservability.js.map

@@ -1 +1 @@
-{"version":3,"file":"useObservability.js","sources":["../../../src/contexts/ObservabilityProvider/useObservability.ts"],"sourcesContent":["import { useContext } from 'react'\nimport { ObservabilityContext } from './ObservabilityContext'\nimport type { ObservabilityContextValue } from './ObservabilityContext'\nimport { useSanitizedObservability } from './useSanitizedObservability'\n\nexport const useObservability = (): ObservabilityContextValue => {\n  const context = useContext(ObservabilityContext)\n  const sanitizedObservability = useSanitizedObservability(context?.observability)\n\n  if (context === undefined) {\n    return { observability: undefined }\n  }\n\n  return { observability: sanitizedObservability }\n}\n"],"names":["useObservability","context","useContext","ObservabilityContext","sanitizedObservability","useSanitizedObservability"],"mappings":";;;AAKO,MAAMA,IAAmB,MAAiC;AAC/D,QAAMC,IAAUC,EAAWC,CAAoB,GACzCC,IAAyBC,EAA0BJ,GAAS,aAAa;AAE/E,SAAIA,MAAY,SACP,EAAE,eAAe,OAAA,IAGnB,EAAE,eAAeG,EAAA;AAC1B;"}
+{"version":3,"file":"useObservability.js","sources":["../../../src/contexts/ObservabilityProvider/useObservability.ts"],"sourcesContent":["import { useContext } from 'react'\nimport { ObservabilityContext } from './ObservabilityContext'\nimport type { ObservabilityContextValue } from './ObservabilityContext'\nimport { useSanitizedObservability } from './useSanitizedObservability'\n\n/**\n * Returns the partner-supplied observability hook with PII sanitization applied to its callbacks.\n *\n * @remarks\n * SDK components call this hook to report errors and metrics. Each `onError` and `onMetric`\n * payload is run through the configured sanitization (PII pattern redaction plus sensitive-field\n * removal) before being passed to the partner's hook, so partner-side telemetry never receives\n * raw form values or other sensitive data unless explicitly opted in via `sanitization` config.\n * When no {@link ObservabilityProvider} is present, `observability` is `undefined` and reports\n * are dropped.\n *\n * @returns A context value whose `observability` is either the sanitized hook or `undefined`.\n * @internal\n */\nexport const useObservability = (): ObservabilityContextValue => {\n  const context = useContext(ObservabilityContext)\n  const sanitizedObservability = useSanitizedObservability(context?.observability)\n\n  if (context === undefined) {\n    return { observability: undefined }\n  }\n\n  return { observability: sanitizedObservability }\n}\n"],"names":["useObservability","context","useContext","ObservabilityContext","sanitizedObservability","useSanitizedObservability"],"mappings":";;;AAmBO,MAAMA,IAAmB,MAAiC;AAC/D,QAAMC,IAAUC,EAAWC,CAAoB,GACzCC,IAAyBC,EAA0BJ,GAAS,aAAa;AAE/E,SAAIA,MAAY,SACP,EAAE,eAAe,OAAA,IAGnB,EAAE,eAAeG,EAAA;AAC1B;"}

package/dist/contexts/ObservabilityProvider/useSanitizedObservability.d.ts

@@ -1,4 +1,18 @@
 import { ObservabilityError, ObservabilityMetric, ObservabilityHook } from '../../types/observability';
+/**
+ * Wraps an observability hook so its `onError` and `onMetric` callbacks receive sanitized payloads.
+ *
+ * @remarks
+ * Returns `undefined` when no observability hook is configured. Otherwise returns an object with
+ * memoized `onError` / `onMetric` callbacks that route through {@link sanitizeError} and
+ * {@link sanitizeMetric} using the hook's `sanitization` config. Each wrapped callback is only
+ * present when the underlying hook defines its counterpart, so partners can opt into error
+ * tracking, metric tracking, or both independently.
+ *
+ * @param observability - The partner-supplied observability hook, if any.
+ * @returns A wrapped hook with sanitizing callbacks, or `undefined` when no hook is supplied.
+ * @internal
+ */
 export declare function useSanitizedObservability(observability?: ObservabilityHook): {
     onError: ((error: ObservabilityError) => void) | undefined;
     onMetric: ((metric: ObservabilityMetric) => void) | undefined;

package/dist/contexts/ObservabilityProvider/useSanitizedObservability.js.map

@@ -1 +1 @@
-{"version":3,"file":"useSanitizedObservability.js","sources":["../../../src/contexts/ObservabilityProvider/useSanitizedObservability.ts"],"sourcesContent":["import { useCallback } from 'react'\nimport { sanitizeError, sanitizeMetric } from './sanitization'\nimport type {\n  ObservabilityError,\n  ObservabilityMetric,\n  ObservabilityHook,\n} from '@/types/observability'\n\nexport function useSanitizedObservability(observability?: ObservabilityHook) {\n  const sanitizationConfig = observability?.sanitization\n\n  const onError = useCallback(\n    (error: ObservabilityError) => {\n      if (!observability?.onError) return\n\n      const sanitized = sanitizeError(error, sanitizationConfig)\n      observability.onError(sanitized)\n    },\n    [observability, sanitizationConfig],\n  )\n\n  const onMetric = useCallback(\n    (metric: ObservabilityMetric) => {\n      if (!observability?.onMetric) return\n\n      const sanitized = sanitizeMetric(metric, sanitizationConfig)\n      observability.onMetric(sanitized)\n    },\n    [observability, sanitizationConfig],\n  )\n\n  if (!observability) {\n    return undefined\n  }\n\n  return {\n    onError: observability.onError ? onError : undefined,\n    onMetric: observability.onMetric ? onMetric : undefined,\n  }\n}\n"],"names":["useSanitizedObservability","observability","sanitizationConfig","onError","useCallback","error","sanitized","sanitizeError","onMetric","metric","sanitizeMetric"],"mappings":";;AAQO,SAASA,EAA0BC,GAAmC;AAC3E,QAAMC,IAAqBD,GAAe,cAEpCE,IAAUC;AAAA,IACd,CAACC,MAA8B;AAC7B,UAAI,CAACJ,GAAe,QAAS;AAE7B,YAAMK,IAAYC,EAAcF,GAAOH,CAAkB;AACzD,MAAAD,EAAc,QAAQK,CAAS;AAAA,IACjC;AAAA,IACA,CAACL,GAAeC,CAAkB;AAAA,EAAA,GAG9BM,IAAWJ;AAAA,IACf,CAACK,MAAgC;AAC/B,UAAI,CAACR,GAAe,SAAU;AAE9B,YAAMK,IAAYI,EAAeD,GAAQP,CAAkB;AAC3D,MAAAD,EAAc,SAASK,CAAS;AAAA,IAClC;AAAA,IACA,CAACL,GAAeC,CAAkB;AAAA,EAAA;AAGpC,MAAKD;AAIL,WAAO;AAAA,MACL,SAASA,EAAc,UAAUE,IAAU;AAAA,MAC3C,UAAUF,EAAc,WAAWO,IAAW;AAAA,IAAA;AAElD;"}
+{"version":3,"file":"useSanitizedObservability.js","sources":["../../../src/contexts/ObservabilityProvider/useSanitizedObservability.ts"],"sourcesContent":["import { useCallback } from 'react'\nimport { sanitizeError, sanitizeMetric } from './sanitization'\nimport type {\n  ObservabilityError,\n  ObservabilityMetric,\n  ObservabilityHook,\n} from '@/types/observability'\n\n/**\n * Wraps an observability hook so its `onError` and `onMetric` callbacks receive sanitized payloads.\n *\n * @remarks\n * Returns `undefined` when no observability hook is configured. Otherwise returns an object with\n * memoized `onError` / `onMetric` callbacks that route through {@link sanitizeError} and\n * {@link sanitizeMetric} using the hook's `sanitization` config. Each wrapped callback is only\n * present when the underlying hook defines its counterpart, so partners can opt into error\n * tracking, metric tracking, or both independently.\n *\n * @param observability - The partner-supplied observability hook, if any.\n * @returns A wrapped hook with sanitizing callbacks, or `undefined` when no hook is supplied.\n * @internal\n */\nexport function useSanitizedObservability(observability?: ObservabilityHook) {\n  const sanitizationConfig = observability?.sanitization\n\n  const onError = useCallback(\n    (error: ObservabilityError) => {\n      if (!observability?.onError) return\n\n      const sanitized = sanitizeError(error, sanitizationConfig)\n      observability.onError(sanitized)\n    },\n    [observability, sanitizationConfig],\n  )\n\n  const onMetric = useCallback(\n    (metric: ObservabilityMetric) => {\n      if (!observability?.onMetric) return\n\n      const sanitized = sanitizeMetric(metric, sanitizationConfig)\n      observability.onMetric(sanitized)\n    },\n    [observability, sanitizationConfig],\n  )\n\n  if (!observability) {\n    return undefined\n  }\n\n  return {\n    onError: observability.onError ? onError : undefined,\n    onMetric: observability.onMetric ? onMetric : undefined,\n  }\n}\n"],"names":["useSanitizedObservability","observability","sanitizationConfig","onError","useCallback","error","sanitized","sanitizeError","onMetric","metric","sanitizeMetric"],"mappings":";;AAsBO,SAASA,EAA0BC,GAAmC;AAC3E,QAAMC,IAAqBD,GAAe,cAEpCE,IAAUC;AAAA,IACd,CAACC,MAA8B;AAC7B,UAAI,CAACJ,GAAe,QAAS;AAE7B,YAAMK,IAAYC,EAAcF,GAAOH,CAAkB;AACzD,MAAAD,EAAc,QAAQK,CAAS;AAAA,IACjC;AAAA,IACA,CAACL,GAAeC,CAAkB;AAAA,EAAA,GAG9BM,IAAWJ;AAAA,IACf,CAACK,MAAgC;AAC/B,UAAI,CAACR,GAAe,SAAU;AAE9B,YAAMK,IAAYI,EAAeD,GAAQP,CAAkB;AAC3D,MAAAD,EAAc,SAASK,CAAS;AAAA,IAClC;AAAA,IACA,CAACL,GAAeC,CAAkB;AAAA,EAAA;AAGpC,MAAKD;AAIL,WAAO;AAAA,MACL,SAASA,EAAc,UAAUE,IAAU;AAAA,MAC3C,UAAUF,EAAc,WAAWO,IAAW;AAAA,IAAA;AAElD;"}

package/dist/contexts/ThemeProvider/test-utils.d.ts

@@ -1,4 +1,4 @@
 import { default as React } from 'react';
 export declare const AllTheProviders: ({ children }: {
     children: React.ReactNode;
-}) => import("react/jsx-runtime").JSX.Element;
+}) => React.JSX.Element;

package/dist/contexts/index.d.ts

@@ -8,4 +8,4 @@ export type { ApiProviderProps } from './ApiProvider/ApiProvider';
 export type { ComponentsContextType } from './ComponentAdapter/useComponentContext';
 export * from './ComponentAdapter/componentAdapterTypes';
 export { ObservabilityProvider, useObservability } from './ObservabilityProvider';
-export type { ObservabilityProviderProps } from './ObservabilityProvider';
+export type { ObservabilityProviderProps, ObservabilityContextValue } from './ObservabilityProvider';

package/dist/helpers/LRUCache.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Least-recently-used cache keyed by string with thunk values producing translation tables.
+ *
+ * @remarks Backs the i18n translation cache so loaded language bundles can be evicted in
+ * insertion-recency order once the configured capacity is reached. Reading or writing a key
+ * promotes it to the most-recently-used position.
+ *
+ * @internal
+ */
 export declare class LRUCache {
     capacity: number;
     map: Map<string, () => Record<string, string>>;

package/dist/helpers/LRUCache.js.map

@@ -1 +1 @@
-{"version":3,"file":"LRUCache.js","sources":["../../src/helpers/LRUCache.ts"],"sourcesContent":["export class LRUCache {\n  capacity: number\n  map: Map<string, () => Record<string, string>>\n\n  constructor(capacity: number) {\n    this.capacity = capacity\n    this.map = new Map()\n  }\n\n  get(key: string): (() => Record<string, string>) | null {\n    const value = this.map.get(key)\n    if (value === undefined) return null\n\n    // Small hack to re-order keys: we remove the requested key and place it at the end\n    this.map.delete(key)\n    this.map.set(key, value)\n\n    return value\n  }\n\n  put(key: string, value: () => Record<string, string>): void {\n    // remove last element to avoid overflow, only if it does not have\n    // the inserted key is a new key\n    if (this.map.size >= this.capacity && !this.map.has(key)) {\n      const firstKey = this.map.keys().next().value as string\n      this.map.delete(firstKey)\n    }\n\n    // Small hack to re-order keys: we remove the requested key and place it at the end\n    this.map.delete(key)\n    this.map.set(key, value)\n  }\n}\n"],"names":["LRUCache","capacity","key","value","firstKey"],"mappings":"AAAO,MAAMA,EAAS;AAAA,EACpB;AAAA,EACA;AAAA,EAEA,YAAYC,GAAkB;AAC5B,SAAK,WAAWA,GAChB,KAAK,0BAAU,IAAA;AAAA,EACjB;AAAA,EAEA,IAAIC,GAAoD;AACtD,UAAMC,IAAQ,KAAK,IAAI,IAAID,CAAG;AAC9B,WAAIC,MAAU,SAAkB,QAGhC,KAAK,IAAI,OAAOD,CAAG,GACnB,KAAK,IAAI,IAAIA,GAAKC,CAAK,GAEhBA;AAAA,EACT;AAAA,EAEA,IAAID,GAAaC,GAA2C;AAG1D,QAAI,KAAK,IAAI,QAAQ,KAAK,YAAY,CAAC,KAAK,IAAI,IAAID,CAAG,GAAG;AACxD,YAAME,IAAW,KAAK,IAAI,KAAA,EAAO,OAAO;AACxC,WAAK,IAAI,OAAOA,CAAQ;AAAA,IAC1B;AAGA,SAAK,IAAI,OAAOF,CAAG,GACnB,KAAK,IAAI,IAAIA,GAAKC,CAAK;AAAA,EACzB;AACF;"}
+{"version":3,"file":"LRUCache.js","sources":["../../src/helpers/LRUCache.ts"],"sourcesContent":["/**\n * Least-recently-used cache keyed by string with thunk values producing translation tables.\n *\n * @remarks Backs the i18n translation cache so loaded language bundles can be evicted in\n * insertion-recency order once the configured capacity is reached. Reading or writing a key\n * promotes it to the most-recently-used position.\n *\n * @internal\n */\nexport class LRUCache {\n  capacity: number\n  map: Map<string, () => Record<string, string>>\n\n  constructor(capacity: number) {\n    this.capacity = capacity\n    this.map = new Map()\n  }\n\n  get(key: string): (() => Record<string, string>) | null {\n    const value = this.map.get(key)\n    if (value === undefined) return null\n\n    // Small hack to re-order keys: we remove the requested key and place it at the end\n    this.map.delete(key)\n    this.map.set(key, value)\n\n    return value\n  }\n\n  put(key: string, value: () => Record<string, string>): void {\n    // remove last element to avoid overflow, only if it does not have\n    // the inserted key is a new key\n    if (this.map.size >= this.capacity && !this.map.has(key)) {\n      const firstKey = this.map.keys().next().value as string\n      this.map.delete(firstKey)\n    }\n\n    // Small hack to re-order keys: we remove the requested key and place it at the end\n    this.map.delete(key)\n    this.map.set(key, value)\n  }\n}\n"],"names":["LRUCache","capacity","key","value","firstKey"],"mappings":"AASO,MAAMA,EAAS;AAAA,EACpB;AAAA,EACA;AAAA,EAEA,YAAYC,GAAkB;AAC5B,SAAK,WAAWA,GAChB,KAAK,0BAAU,IAAA;AAAA,EACjB;AAAA,EAEA,IAAIC,GAAoD;AACtD,UAAMC,IAAQ,KAAK,IAAI,IAAID,CAAG;AAC9B,WAAIC,MAAU,SAAkB,QAGhC,KAAK,IAAI,OAAOD,CAAG,GACnB,KAAK,IAAI,IAAIA,GAAKC,CAAK,GAEhBA;AAAA,EACT;AAAA,EAEA,IAAID,GAAaC,GAA2C;AAG1D,QAAI,KAAK,IAAI,QAAQ,KAAK,YAAY,CAAC,KAAK,IAAI,IAAID,CAAG,GAAG;AACxD,YAAME,IAAW,KAAK,IAAI,KAAA,EAAO,OAAO;AACxC,WAAK,IAAI,OAAOA,CAAQ;AAAA,IAC1B;AAGA,SAAK,IAAI,OAAOF,CAAG,GACnB,KAAK,IAAI,IAAIA,GAAKC,CAAK;AAAA,EACzB;AACF;"}

package/dist/helpers/apiErrorToList.d.ts

@@ -1,7 +1,23 @@
-import { EntityErrorObject } from '@gusto/embedded-api/models/components/entityerrorobject';
-/**Traverses errorList and finds items with message properties */
+import { EntityErrorObject } from '@gusto/embedded-api-v-2025-11-15/models/components/entityerrorobject';
+/**
+ * Renders each error in the list that carries a `message` as a `<span>` keyed by `errorKey`.
+ *
+ * @param errorList - Flat list of entity errors returned by the API.
+ * @returns React nodes for messaged entries; entries without a message yield `null`.
+ * @internal
+ */
 export declare const renderErrorList: (errorList: Array<EntityErrorObject>) => React.ReactNode[];
-/**Recuresively parses error list and constructs an array of objects containing attribute value error messages associated with form fields. Nested errors construct '.' separated keys
- * metadata.state is a special case for state taxes validation errors
+/**
+ * Recursively flattens a nested API error tree into a list keyed for form-field display.
+ *
+ * @remarks Builds dot-separated `errorKey` paths from nested errors and converts each segment
+ * from snake_case to camelCase so the resulting keys match react-hook-form field names.
+ * `metadata.key` is used as the path segment for nested errors when present; `metadata.state`
+ * is a special case for state-tax validation errors, falling back to the node's own `errorKey`.
+ *
+ * @param error - The root entity error to flatten.
+ * @param parentKey - Accumulated dot-path prefix used during recursion. Omit at the top level.
+ * @returns A flat list of `{ errorKey, message, category }` entries ready to bind to form fields.
+ * @internal
  */
 export declare const getFieldErrors: (error: EntityErrorObject, parentKey?: string) => Array<EntityErrorObject>;

package/dist/helpers/apiErrorToList.js.map

@@ -1 +1 @@
-{"version":3,"file":"apiErrorToList.js","sources":["../../src/helpers/apiErrorToList.tsx"],"sourcesContent":["import type { EntityErrorObject } from '@gusto/embedded-api/models/components/entityerrorobject'\nimport { snakeCaseToCamelCase } from './formattedStrings'\n\n/**Traverses errorList and finds items with message properties */\nexport const renderErrorList = (errorList: Array<EntityErrorObject>): React.ReactNode[] => {\n  return errorList.map(errorFromList => {\n    if (errorFromList.message) {\n      return <span key={errorFromList.errorKey}>{errorFromList.message}</span>\n    }\n    return null\n  })\n}\n/**Recuresively parses error list and constructs an array of objects containing attribute value error messages associated with form fields. Nested errors construct '.' separated keys\n * metadata.state is a special case for state taxes validation errors\n */\nexport const getFieldErrors = (\n  error: EntityErrorObject,\n  parentKey?: string,\n): Array<EntityErrorObject> => {\n  const keyPrefix = parentKey ? parentKey + '.' : ''\n  if (error.category === 'invalid_attribute_value' || error.category === 'invalid_operation') {\n    return [\n      {\n        errorKey: snakeCaseToCamelCase(keyPrefix + error.errorKey),\n        message: error.message ?? '',\n        category: error.category,\n      },\n    ]\n  }\n  if (error.category === 'nested_errors' && error.errors !== undefined) {\n    //TODO: clean this up once Metadata type is fixed in openapi spec\n    let keySuffix = ''\n    //@ts-expect-error: Metadata in speakeasy is incorrectly typed\n    if (error.metadata?.key && typeof error.metadata.key === 'string') {\n      //@ts-expect-error: Metadata in speakeasy is incorrectly typed\n      keySuffix = error.metadata.key as string\n      //@ts-expect-error: Metadata in speakeasy is incorrectly typed\n    } else if (error.metadata?.state && typeof error.metadata.state === 'string') {\n      //@ts-expect-error: Metadata in speakeasy is incorrectly typed\n      keySuffix = error.metadata.state as string\n    } else if (error.errorKey) {\n      keySuffix = error.errorKey\n    }\n    return error.errors.flatMap(err => getFieldErrors(err, keyPrefix + keySuffix))\n  }\n  if (error.message) {\n    return [\n      {\n        errorKey: snakeCaseToCamelCase(keyPrefix + error.errorKey),\n        message: error.message,\n        category: error.category,\n      },\n    ]\n  }\n  return []\n}\n"],"names":["renderErrorList","errorList","errorFromList","jsx","getFieldErrors","error","parentKey","keyPrefix","snakeCaseToCamelCase","keySuffix","err"],"mappings":";;AAIO,MAAMA,IAAkB,CAACC,MACvBA,EAAU,IAAI,CAAAC,MACfA,EAAc,UACT,gBAAAC,EAAC,QAAA,EAAmC,UAAAD,EAAc,QAAA,GAAvCA,EAAc,QAAiC,IAE5D,IACR,GAKUE,IAAiB,CAC5BC,GACAC,MAC6B;AAC7B,QAAMC,IAAYD,IAAYA,IAAY,MAAM;AAChD,MAAID,EAAM,aAAa,6BAA6BA,EAAM,aAAa;AACrE,WAAO;AAAA,MACL;AAAA,QACE,UAAUG,EAAqBD,IAAYF,EAAM,QAAQ;AAAA,QACzD,SAASA,EAAM,WAAW;AAAA,QAC1B,UAAUA,EAAM;AAAA,MAAA;AAAA,IAClB;AAGJ,MAAIA,EAAM,aAAa,mBAAmBA,EAAM,WAAW,QAAW;AAEpE,QAAII,IAAY;AAEhB,WAAIJ,EAAM,UAAU,OAAO,OAAOA,EAAM,SAAS,OAAQ,WAEvDI,IAAYJ,EAAM,SAAS,MAElBA,EAAM,UAAU,SAAS,OAAOA,EAAM,SAAS,SAAU,WAElEI,IAAYJ,EAAM,SAAS,QAClBA,EAAM,aACfI,IAAYJ,EAAM,WAEbA,EAAM,OAAO,QAAQ,CAAAK,MAAON,EAAeM,GAAKH,IAAYE,CAAS,CAAC;AAAA,EAC/E;AACA,SAAIJ,EAAM,UACD;AAAA,IACL;AAAA,MACE,UAAUG,EAAqBD,IAAYF,EAAM,QAAQ;AAAA,MACzD,SAASA,EAAM;AAAA,MACf,UAAUA,EAAM;AAAA,IAAA;AAAA,EAClB,IAGG,CAAA;AACT;"}
+{"version":3,"file":"apiErrorToList.js","sources":["../../src/helpers/apiErrorToList.tsx"],"sourcesContent":["import type { EntityErrorObject } from '@gusto/embedded-api-v-2025-11-15/models/components/entityerrorobject'\nimport { snakeCaseToCamelCase } from './formattedStrings'\n\n/**\n * Renders each error in the list that carries a `message` as a `<span>` keyed by `errorKey`.\n *\n * @param errorList - Flat list of entity errors returned by the API.\n * @returns React nodes for messaged entries; entries without a message yield `null`.\n * @internal\n */\nexport const renderErrorList = (errorList: Array<EntityErrorObject>): React.ReactNode[] => {\n  return errorList.map(errorFromList => {\n    if (errorFromList.message) {\n      return <span key={errorFromList.errorKey}>{errorFromList.message}</span>\n    }\n    return null\n  })\n}\n/**\n * Recursively flattens a nested API error tree into a list keyed for form-field display.\n *\n * @remarks Builds dot-separated `errorKey` paths from nested errors and converts each segment\n * from snake_case to camelCase so the resulting keys match react-hook-form field names.\n * `metadata.key` is used as the path segment for nested errors when present; `metadata.state`\n * is a special case for state-tax validation errors, falling back to the node's own `errorKey`.\n *\n * @param error - The root entity error to flatten.\n * @param parentKey - Accumulated dot-path prefix used during recursion. Omit at the top level.\n * @returns A flat list of `{ errorKey, message, category }` entries ready to bind to form fields.\n * @internal\n */\nexport const getFieldErrors = (\n  error: EntityErrorObject,\n  parentKey?: string,\n): Array<EntityErrorObject> => {\n  const keyPrefix = parentKey ? parentKey + '.' : ''\n  if (error.category === 'invalid_attribute_value' || error.category === 'invalid_operation') {\n    return [\n      {\n        errorKey: snakeCaseToCamelCase(keyPrefix + error.errorKey),\n        message: error.message ?? '',\n        category: error.category,\n      },\n    ]\n  }\n  if (error.category === 'nested_errors' && error.errors !== undefined) {\n    //TODO: clean this up once Metadata type is fixed in openapi spec\n    let keySuffix = ''\n    //@ts-expect-error: Metadata in speakeasy is incorrectly typed\n    if (error.metadata?.key && typeof error.metadata.key === 'string') {\n      //@ts-expect-error: Metadata in speakeasy is incorrectly typed\n      keySuffix = error.metadata.key as string\n      //@ts-expect-error: Metadata in speakeasy is incorrectly typed\n    } else if (error.metadata?.state && typeof error.metadata.state === 'string') {\n      //@ts-expect-error: Metadata in speakeasy is incorrectly typed\n      keySuffix = error.metadata.state as string\n    } else if (error.errorKey) {\n      keySuffix = error.errorKey\n    }\n    return error.errors.flatMap(err => getFieldErrors(err, keyPrefix + keySuffix))\n  }\n  if (error.message) {\n    return [\n      {\n        errorKey: snakeCaseToCamelCase(keyPrefix + error.errorKey),\n        message: error.message,\n        category: error.category,\n      },\n    ]\n  }\n  return []\n}\n"],"names":["renderErrorList","errorList","errorFromList","jsx","getFieldErrors","error","parentKey","keyPrefix","snakeCaseToCamelCase","keySuffix","err"],"mappings":";;AAUO,MAAMA,IAAkB,CAACC,MACvBA,EAAU,IAAI,CAAAC,MACfA,EAAc,UACT,gBAAAC,EAAC,QAAA,EAAmC,UAAAD,EAAc,QAAA,GAAvCA,EAAc,QAAiC,IAE5D,IACR,GAeUE,IAAiB,CAC5BC,GACAC,MAC6B;AAC7B,QAAMC,IAAYD,IAAYA,IAAY,MAAM;AAChD,MAAID,EAAM,aAAa,6BAA6BA,EAAM,aAAa;AACrE,WAAO;AAAA,MACL;AAAA,QACE,UAAUG,EAAqBD,IAAYF,EAAM,QAAQ;AAAA,QACzD,SAASA,EAAM,WAAW;AAAA,QAC1B,UAAUA,EAAM;AAAA,MAAA;AAAA,IAClB;AAGJ,MAAIA,EAAM,aAAa,mBAAmBA,EAAM,WAAW,QAAW;AAEpE,QAAII,IAAY;AAEhB,WAAIJ,EAAM,UAAU,OAAO,OAAOA,EAAM,SAAS,OAAQ,WAEvDI,IAAYJ,EAAM,SAAS,MAElBA,EAAM,UAAU,SAAS,OAAOA,EAAM,SAAS,SAAU,WAElEI,IAAYJ,EAAM,SAAS,QAClBA,EAAM,aACfI,IAAYJ,EAAM,WAEbA,EAAM,OAAO,QAAQ,CAAAK,MAAON,EAAeM,GAAKH,IAAYE,CAAS,CAAC;AAAA,EAC/E;AACA,SAAIJ,EAAM,UACD;AAAA,IACL;AAAA,MACE,UAAUG,EAAqBD,IAAYF,EAAM,QAAQ;AAAA,MACzD,SAASA,EAAM;AAAA,MACf,UAAUA,EAAM;AAAA,IAAA;AAAA,EAClB,IAGG,CAAA;AACT;"}

package/dist/helpers/applyMissingDefaults.d.ts

@@ -1,5 +1,14 @@
 /**
- * Applies default values only to properties that are undefined in the source object.
- * This is more efficient than object spread as it only sets values that are actually missing.
+ * Returns a copy of `rawProps` with `defaults` filled in only where the source value is `undefined`.
+ *
+ * @remarks Cheaper than `{ ...defaults, ...rawProps }` because it copies the source once and only
+ * writes the keys that are actually missing. Properties explicitly set to `null` or `false` are
+ * preserved as-is.
+ *
+ * @typeParam T - Shape of the props object.
+ * @param rawProps - Caller-supplied props; values set here always win.
+ * @param defaults - Fallback values applied only when the corresponding `rawProps` value is `undefined`.
+ * @returns A new object combining `rawProps` with defaults filled in for missing keys.
+ * @internal
  */
 export declare function applyMissingDefaults<T>(rawProps: T, defaults: Partial<T>): T;

package/dist/helpers/applyMissingDefaults.js.map

@@ -1 +1 @@
-{"version":3,"file":"applyMissingDefaults.js","sources":["../../src/helpers/applyMissingDefaults.ts"],"sourcesContent":["/**\n * Applies default values only to properties that are undefined in the source object.\n * This is more efficient than object spread as it only sets values that are actually missing.\n */\nexport function applyMissingDefaults<T>(rawProps: T, defaults: Partial<T>): T {\n  const result = { ...rawProps }\n\n  for (const key in defaults) {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    if ((rawProps as any)[key] === undefined && defaults[key] !== undefined) {\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      ;(result as any)[key] = defaults[key]\n    }\n  }\n\n  return result\n}\n"],"names":["applyMissingDefaults","rawProps","defaults","result","key"],"mappings":"AAIO,SAASA,EAAwBC,GAAaC,GAAyB;AAC5E,QAAMC,IAAS,EAAE,GAAGF,EAAA;AAEpB,aAAWG,KAAOF;AAEhB,IAAKD,EAAiBG,CAAG,MAAM,UAAaF,EAASE,CAAG,MAAM,WAE1DD,EAAeC,CAAG,IAAIF,EAASE,CAAG;AAIxC,SAAOD;AACT;"}
+{"version":3,"file":"applyMissingDefaults.js","sources":["../../src/helpers/applyMissingDefaults.ts"],"sourcesContent":["/**\n * Returns a copy of `rawProps` with `defaults` filled in only where the source value is `undefined`.\n *\n * @remarks Cheaper than `{ ...defaults, ...rawProps }` because it copies the source once and only\n * writes the keys that are actually missing. Properties explicitly set to `null` or `false` are\n * preserved as-is.\n *\n * @typeParam T - Shape of the props object.\n * @param rawProps - Caller-supplied props; values set here always win.\n * @param defaults - Fallback values applied only when the corresponding `rawProps` value is `undefined`.\n * @returns A new object combining `rawProps` with defaults filled in for missing keys.\n * @internal\n */\nexport function applyMissingDefaults<T>(rawProps: T, defaults: Partial<T>): T {\n  const result = { ...rawProps }\n\n  for (const key in defaults) {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    if ((rawProps as any)[key] === undefined && defaults[key] !== undefined) {\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      ;(result as any)[key] = defaults[key]\n    }\n  }\n\n  return result\n}\n"],"names":["applyMissingDefaults","rawProps","defaults","result","key"],"mappings":"AAaO,SAASA,EAAwBC,GAAaC,GAAyB;AAC5E,QAAMC,IAAS,EAAE,GAAGF,EAAA;AAEpB,aAAWG,KAAOF;AAEhB,IAAKD,EAAiBG,CAAG,MAAM,UAAaF,EAASE,CAAG,MAAM,WAE1DD,EAAeC,CAAG,IAAIF,EAASE,CAAG;AAIxC,SAAOD;AACT;"}

package/dist/helpers/breadcrumbHelpers.d.ts

@@ -9,50 +9,91 @@ type WithHeader = {
 /**
  * Builds a complete breadcrumb trail map from a hierarchical node structure.
  *
- * Takes a tree structure of breadcrumb nodes and generates a map where each state
- * has its complete breadcrumb trail from root to that state. This is useful for
- * initializing breadcrumb navigation in state machines or multi-step flows.
+ * @remarks Walks each node's `parent` pointer to assemble a root-to-state trail, producing
+ * one entry per state. Use it to seed breadcrumb navigation when initializing a state
+ * machine or multi-step flow.
+ *
+ * @param nodes - Map of state names to breadcrumb nodes, each carrying an `item` and an
+ * optional `parent` state key.
+ * @returns A map from state name to its ordered breadcrumb trail.
+ * @internal
  */
 export declare const buildBreadcrumbs: (nodes: BreadcrumbNodes) => BreadcrumbTrail;
 /**
  * Resolves template variables in breadcrumb labels using values from a context object.
  *
- * Supports Handlebars-style template syntax ({{variableName}}) for dynamic breadcrumb labels.
- * Variables enclosed in double braces are replaced with their corresponding values from the context.
- * Non-template strings are returned as-is.
+ * @remarks Supports Handlebars-style `{{variableName}}` syntax. Values enclosed in double
+ * braces are replaced with the corresponding key on `context`; missing keys resolve to an
+ * empty string. Strings without a template token are returned unchanged.
+ *
+ * @param variables - Map of variable names to either a literal or a `{{key}}` template.
+ * Pass `undefined` to skip resolution.
+ * @param context - Source values referenced by template tokens.
+ * @returns A map of variable names to resolved values, or an empty object when `variables`
+ * is `undefined`.
+ * @internal
  */
 export declare const resolveBreadcrumbVariables: (variables: Record<string, string> | undefined, context: Record<string, unknown>) => Record<string, unknown>;
 /**
- * Merges `patch` fields into the existing breadcrumbs header on a context,
- * preserving the existing trails and CTA. If the context has no breadcrumbs
- * header, a fresh one is created. Useful when a transition needs to flip
- * breadcrumbs visibility (`currentBreadcrumbId`) without rebuilding any
- * trails.
+ * Merges `patch` fields into the existing breadcrumbs header on a context.
+ *
+ * @remarks Preserves existing trails and CTA; if the context has no breadcrumbs header
+ * a fresh one is created. Use this when a transition needs to flip breadcrumb visibility
+ * (for example `currentBreadcrumbId`) without rebuilding any trails.
+ *
+ * @typeParam T - Context shape carrying an optional `header` of the discriminated union.
+ * @param context - The context whose breadcrumbs header should be patched.
+ * @param patch - Partial breadcrumbs-header fields to merge in. The `type` discriminator
+ * cannot be overridden.
+ * @returns A new context with the patched breadcrumbs header.
+ * @internal
  */
 export declare const patchBreadcrumbsHeader: <T extends WithHeader>(context: T, patch: Partial<Omit<BreadcrumbsHeader, "type">>) => T & {
     header: BreadcrumbsHeader;
 };
 /**
- * Removes a breadcrumb from all trails in the context's breadcrumbs header.
- * Use this in state machine reducers to hide a step entirely (e.g. after
- * payroll submission).
+ * Removes a breadcrumb from every trail in the context's breadcrumbs header.
+ *
+ * @remarks Use in state machine reducers to hide a step entirely, for example after
+ * payroll submission when the step should no longer appear in any trail.
+ *
+ * @typeParam T - Context shape carrying an optional `header` of the discriminated union.
+ * @param breadcrumbId - Id of the breadcrumb to strip from every trail.
+ * @param context - The context whose breadcrumbs header should be updated.
+ * @returns A new context with the breadcrumb removed from all trails.
+ * @internal
  */
 export declare const hideBreadcrumb: <T extends WithHeader>(breadcrumbId: string, context: T) => T;
 /**
- * Marks a breadcrumb as non-navigable across all trails in the context's
- * breadcrumbs header. Use this in state machine reducers to disable backward
- * navigation to a specific step.
+ * Marks a breadcrumb as non-navigable across every trail in the context's breadcrumbs header.
+ *
+ * @remarks Use in state machine reducers to disable backward navigation to a specific step
+ * while still showing it in the trail.
+ *
+ * @typeParam T - Context shape carrying an optional `header` of the discriminated union.
+ * @param breadcrumbId - Id of the breadcrumb to mark `isNavigable: false`.
+ * @param context - The context whose breadcrumbs header should be updated.
+ * @returns A new context with the breadcrumb locked in every trail.
+ * @internal
  */
 export declare const lockBreadcrumb: <T extends WithHeader>(breadcrumbId: string, context: T) => T;
 /**
- * Updates the breadcrumb trail for a specific state with resolved variables
- * and switches the active breadcrumb to that state.
- *
- * This function is typically used in state machine transitions to update
- * breadcrumb navigation when moving between states. It preserves all existing
- * breadcrumb trails for other states and only updates the trail for the
- * specified state by resolving any template variables for that state's
- * breadcrumb. The resulting context's header is always of type `'breadcrumbs'`.
+ * Updates the breadcrumb trail for a specific state with resolved variables and switches
+ * the active breadcrumb to that state.
+ *
+ * @remarks Typically called from state machine transitions to update breadcrumb navigation
+ * when moving between states. Existing trails for other states are preserved; only the trail
+ * for `stateName` is rewritten with `variables` resolved against the context. The resulting
+ * context's header is always of type `'breadcrumbs'`.
+ *
+ * @typeParam T - Context shape carrying an optional `header` of the discriminated union.
+ * @param stateName - The state whose breadcrumb trail should be updated and made active.
+ * @param context - The context whose breadcrumbs header should be updated.
+ * @param variables - Optional template variables to resolve against the context for each
+ * breadcrumb in the target state's trail.
+ * @returns A new context with the trail for `stateName` updated and `currentBreadcrumbId`
+ * set to `stateName`.
+ * @internal
  */
 export declare const updateBreadcrumbs: <T extends WithHeader>(stateName: string, context: T, variables?: Record<string, string>) => T & {
     header: BreadcrumbsHeader;

package/dist/helpers/breadcrumbHelpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"breadcrumbHelpers.js","sources":["../../src/helpers/breadcrumbHelpers.ts"],"sourcesContent":["import type {\n  BreadcrumbNode,\n  BreadcrumbNodes,\n  BreadcrumbTrail,\n  FlowBreadcrumb,\n} from '@/components/Common/FlowBreadcrumbs/FlowBreadcrumbsTypes'\nimport type { FlowHeaderConfig } from '@/components/Flow/useFlow'\n\ntype BreadcrumbsHeader = Extract<FlowHeaderConfig, { type: 'breadcrumbs' }>\n\ntype WithHeader = { header?: FlowHeaderConfig | null }\n\n/**\n * Returns the existing breadcrumbs header from a context, defaulting to a\n * blank breadcrumbs config when the header is missing or of a different\n * variant. Helpers below use this so callers don't need to manually narrow\n * the discriminated `header` union before mutating breadcrumb data.\n */\nconst getBreadcrumbsHeader = (header: FlowHeaderConfig | null | undefined): BreadcrumbsHeader => {\n  if (header?.type === 'breadcrumbs') return header\n  return { type: 'breadcrumbs' }\n}\n\n/**\n * Builds a complete breadcrumb trail map from a hierarchical node structure.\n *\n * Takes a tree structure of breadcrumb nodes and generates a map where each state\n * has its complete breadcrumb trail from root to that state. This is useful for\n * initializing breadcrumb navigation in state machines or multi-step flows.\n */\nexport const buildBreadcrumbs = (nodes: BreadcrumbNodes): BreadcrumbTrail => {\n  const map: Record<string, FlowBreadcrumb[]> = {}\n\n  for (const [state, node] of Object.entries(nodes)) {\n    const trail: FlowBreadcrumb[] = []\n    let current: BreadcrumbNode | null = node\n\n    while (current) {\n      trail.unshift(current.item)\n      const parentKey: string | null = current.parent\n      current = parentKey ? (nodes[parentKey] ?? null) : null\n    }\n\n    map[state] = trail\n  }\n\n  return map\n}\n\n/**\n * Resolves template variables in breadcrumb labels using values from a context object.\n *\n * Supports Handlebars-style template syntax ({{variableName}}) for dynamic breadcrumb labels.\n * Variables enclosed in double braces are replaced with their corresponding values from the context.\n * Non-template strings are returned as-is.\n */\nexport const resolveBreadcrumbVariables = (\n  variables: Record<string, string> | undefined,\n  context: Record<string, unknown>,\n): Record<string, unknown> => {\n  if (!variables) {\n    return {}\n  }\n\n  const resolved: Record<string, unknown> = {}\n  for (const [key, value] of Object.entries(variables)) {\n    const match = value.match(/{{(.*?)}}/)\n    if (match?.[1]) {\n      const ctxKey = match[1].trim()\n      resolved[key] = context[ctxKey] ?? ''\n    } else {\n      resolved[key] = value\n    }\n  }\n  return resolved\n}\n\n/**\n * Merges `patch` fields into the existing breadcrumbs header on a context,\n * preserving the existing trails and CTA. If the context has no breadcrumbs\n * header, a fresh one is created. Useful when a transition needs to flip\n * breadcrumbs visibility (`currentBreadcrumbId`) without rebuilding any\n * trails.\n */\nexport const patchBreadcrumbsHeader = <T extends WithHeader>(\n  context: T,\n  patch: Partial<Omit<BreadcrumbsHeader, 'type'>>,\n): T & { header: BreadcrumbsHeader } => {\n  const existing = getBreadcrumbsHeader(context.header)\n  return { ...context, header: { ...existing, ...patch } }\n}\n\n/**\n * Removes a breadcrumb from all trails in the context's breadcrumbs header.\n * Use this in state machine reducers to hide a step entirely (e.g. after\n * payroll submission).\n */\nexport const hideBreadcrumb = <T extends WithHeader>(breadcrumbId: string, context: T): T => {\n  const breadcrumbsHeader = getBreadcrumbsHeader(context.header)\n  const allBreadcrumbs = breadcrumbsHeader.breadcrumbs ?? {}\n  const updatedBreadcrumbs = Object.fromEntries(\n    Object.entries(allBreadcrumbs).map(([stateKey, trail]) => [\n      stateKey,\n      trail.filter(b => b.id !== breadcrumbId),\n    ]),\n  )\n  return {\n    ...context,\n    header: { ...breadcrumbsHeader, breadcrumbs: updatedBreadcrumbs },\n  }\n}\n\n/**\n * Marks a breadcrumb as non-navigable across all trails in the context's\n * breadcrumbs header. Use this in state machine reducers to disable backward\n * navigation to a specific step.\n */\nexport const lockBreadcrumb = <T extends WithHeader>(breadcrumbId: string, context: T): T => {\n  const breadcrumbsHeader = getBreadcrumbsHeader(context.header)\n  const allBreadcrumbs = breadcrumbsHeader.breadcrumbs ?? {}\n  const updatedBreadcrumbs = Object.fromEntries(\n    Object.entries(allBreadcrumbs).map(([stateKey, trail]) => [\n      stateKey,\n      trail.map(b => (b.id === breadcrumbId ? { ...b, isNavigable: false } : b)),\n    ]),\n  )\n  return {\n    ...context,\n    header: { ...breadcrumbsHeader, breadcrumbs: updatedBreadcrumbs },\n  }\n}\n\n/**\n * Updates the breadcrumb trail for a specific state with resolved variables\n * and switches the active breadcrumb to that state.\n *\n * This function is typically used in state machine transitions to update\n * breadcrumb navigation when moving between states. It preserves all existing\n * breadcrumb trails for other states and only updates the trail for the\n * specified state by resolving any template variables for that state's\n * breadcrumb. The resulting context's header is always of type `'breadcrumbs'`.\n */\nexport const updateBreadcrumbs = <T extends WithHeader>(\n  stateName: string,\n  context: T,\n  variables?: Record<string, string>,\n): T & { header: BreadcrumbsHeader } => {\n  const breadcrumbsHeader = getBreadcrumbsHeader(context.header)\n  const allBreadcrumbs = breadcrumbsHeader.breadcrumbs ?? {}\n  const trail = allBreadcrumbs[stateName] ?? []\n  const resolvedTrail = trail.map(breadcrumb => ({\n    ...breadcrumb,\n    variables: resolveBreadcrumbVariables(variables, context as Record<string, unknown>),\n  }))\n  return {\n    ...context,\n    header: {\n      ...breadcrumbsHeader,\n      breadcrumbs: {\n        ...allBreadcrumbs,\n        [stateName]: resolvedTrail,\n      },\n      currentBreadcrumbId: stateName,\n    },\n  }\n}\n"],"names":["getBreadcrumbsHeader","header","buildBreadcrumbs","nodes","map","state","node","trail","current","parentKey","resolveBreadcrumbVariables","variables","context","resolved","key","value","match","ctxKey","patchBreadcrumbsHeader","patch","existing","hideBreadcrumb","breadcrumbId","breadcrumbsHeader","allBreadcrumbs","updatedBreadcrumbs","stateKey","b","updateBreadcrumbs","stateName","resolvedTrail","breadcrumb"],"mappings":"AAkBA,MAAMA,IAAuB,CAACC,MACxBA,GAAQ,SAAS,gBAAsBA,IACpC,EAAE,MAAM,cAAA,GAUJC,IAAmB,CAACC,MAA4C;AAC3E,QAAMC,IAAwC,CAAA;AAE9C,aAAW,CAACC,GAAOC,CAAI,KAAK,OAAO,QAAQH,CAAK,GAAG;AACjD,UAAMI,IAA0B,CAAA;AAChC,QAAIC,IAAiCF;AAErC,WAAOE,KAAS;AACd,MAAAD,EAAM,QAAQC,EAAQ,IAAI;AAC1B,YAAMC,IAA2BD,EAAQ;AACzC,MAAAA,IAAUC,IAAaN,EAAMM,CAAS,KAAK,OAAQ;AAAA,IACrD;AAEA,IAAAL,EAAIC,CAAK,IAAIE;AAAA,EACf;AAEA,SAAOH;AACT,GASaM,IAA6B,CACxCC,GACAC,MAC4B;AAC5B,MAAI,CAACD;AACH,WAAO,CAAA;AAGT,QAAME,IAAoC,CAAA;AAC1C,aAAW,CAACC,GAAKC,CAAK,KAAK,OAAO,QAAQJ,CAAS,GAAG;AACpD,UAAMK,IAAQD,EAAM,MAAM,WAAW;AACrC,QAAIC,IAAQ,CAAC,GAAG;AACd,YAAMC,IAASD,EAAM,CAAC,EAAE,KAAA;AACxB,MAAAH,EAASC,CAAG,IAAIF,EAAQK,CAAM,KAAK;AAAA,IACrC;AACE,MAAAJ,EAASC,CAAG,IAAIC;AAAA,EAEpB;AACA,SAAOF;AACT,GASaK,IAAyB,CACpCN,GACAO,MACsC;AACtC,QAAMC,IAAWpB,EAAqBY,EAAQ,MAAM;AACpD,SAAO,EAAE,GAAGA,GAAS,QAAQ,EAAE,GAAGQ,GAAU,GAAGD,IAAM;AACvD,GAOaE,IAAiB,CAAuBC,GAAsBV,MAAkB;AAC3F,QAAMW,IAAoBvB,EAAqBY,EAAQ,MAAM,GACvDY,IAAiBD,EAAkB,eAAe,CAAA,GAClDE,IAAqB,OAAO;AAAA,IAChC,OAAO,QAAQD,CAAc,EAAE,IAAI,CAAC,CAACE,GAAUnB,CAAK,MAAM;AAAA,MACxDmB;AAAA,MACAnB,EAAM,OAAO,CAAAoB,MAAKA,EAAE,OAAOL,CAAY;AAAA,IAAA,CACxC;AAAA,EAAA;AAEH,SAAO;AAAA,IACL,GAAGV;AAAA,IACH,QAAQ,EAAE,GAAGW,GAAmB,aAAaE,EAAA;AAAA,EAAmB;AAEpE,GAgCaG,IAAoB,CAC/BC,GACAjB,GACAD,MACsC;AACtC,QAAMY,IAAoBvB,EAAqBY,EAAQ,MAAM,GACvDY,IAAiBD,EAAkB,eAAe,CAAA,GAElDO,KADQN,EAAeK,CAAS,KAAK,CAAA,GACf,IAAI,CAAAE,OAAe;AAAA,IAC7C,GAAGA;AAAA,IACH,WAAWrB,EAA2BC,GAAWC,CAAkC;AAAA,EAAA,EACnF;AACF,SAAO;AAAA,IACL,GAAGA;AAAA,IACH,QAAQ;AAAA,MACN,GAAGW;AAAA,MACH,aAAa;AAAA,QACX,GAAGC;AAAA,QACH,CAACK,CAAS,GAAGC;AAAA,MAAA;AAAA,MAEf,qBAAqBD;AAAA,IAAA;AAAA,EACvB;AAEJ;"}
+{"version":3,"file":"breadcrumbHelpers.js","sources":["../../src/helpers/breadcrumbHelpers.ts"],"sourcesContent":["import type {\n  BreadcrumbNode,\n  BreadcrumbNodes,\n  BreadcrumbTrail,\n  FlowBreadcrumb,\n} from '@/components/Common/FlowBreadcrumbs/FlowBreadcrumbsTypes'\nimport type { FlowHeaderConfig } from '@/components/Flow/useFlow'\n\ntype BreadcrumbsHeader = Extract<FlowHeaderConfig, { type: 'breadcrumbs' }>\n\ntype WithHeader = { header?: FlowHeaderConfig | null }\n\n/**\n * Returns the existing breadcrumbs header from a context, defaulting to a\n * blank breadcrumbs config when the header is missing or of a different\n * variant. Helpers below use this so callers don't need to manually narrow\n * the discriminated `header` union before mutating breadcrumb data.\n */\nconst getBreadcrumbsHeader = (header: FlowHeaderConfig | null | undefined): BreadcrumbsHeader => {\n  if (header?.type === 'breadcrumbs') return header\n  return { type: 'breadcrumbs' }\n}\n\n/**\n * Builds a complete breadcrumb trail map from a hierarchical node structure.\n *\n * @remarks Walks each node's `parent` pointer to assemble a root-to-state trail, producing\n * one entry per state. Use it to seed breadcrumb navigation when initializing a state\n * machine or multi-step flow.\n *\n * @param nodes - Map of state names to breadcrumb nodes, each carrying an `item` and an\n * optional `parent` state key.\n * @returns A map from state name to its ordered breadcrumb trail.\n * @internal\n */\nexport const buildBreadcrumbs = (nodes: BreadcrumbNodes): BreadcrumbTrail => {\n  const map: Record<string, FlowBreadcrumb[]> = {}\n\n  for (const [state, node] of Object.entries(nodes)) {\n    const trail: FlowBreadcrumb[] = []\n    let current: BreadcrumbNode | null = node\n\n    while (current) {\n      trail.unshift(current.item)\n      const parentKey: string | null = current.parent\n      current = parentKey ? (nodes[parentKey] ?? null) : null\n    }\n\n    map[state] = trail\n  }\n\n  return map\n}\n\n/**\n * Resolves template variables in breadcrumb labels using values from a context object.\n *\n * @remarks Supports Handlebars-style `{{variableName}}` syntax. Values enclosed in double\n * braces are replaced with the corresponding key on `context`; missing keys resolve to an\n * empty string. Strings without a template token are returned unchanged.\n *\n * @param variables - Map of variable names to either a literal or a `{{key}}` template.\n * Pass `undefined` to skip resolution.\n * @param context - Source values referenced by template tokens.\n * @returns A map of variable names to resolved values, or an empty object when `variables`\n * is `undefined`.\n * @internal\n */\nexport const resolveBreadcrumbVariables = (\n  variables: Record<string, string> | undefined,\n  context: Record<string, unknown>,\n): Record<string, unknown> => {\n  if (!variables) {\n    return {}\n  }\n\n  const resolved: Record<string, unknown> = {}\n  for (const [key, value] of Object.entries(variables)) {\n    const match = value.match(/{{(.*?)}}/)\n    if (match?.[1]) {\n      const ctxKey = match[1].trim()\n      resolved[key] = context[ctxKey] ?? ''\n    } else {\n      resolved[key] = value\n    }\n  }\n  return resolved\n}\n\n/**\n * Merges `patch` fields into the existing breadcrumbs header on a context.\n *\n * @remarks Preserves existing trails and CTA; if the context has no breadcrumbs header\n * a fresh one is created. Use this when a transition needs to flip breadcrumb visibility\n * (for example `currentBreadcrumbId`) without rebuilding any trails.\n *\n * @typeParam T - Context shape carrying an optional `header` of the discriminated union.\n * @param context - The context whose breadcrumbs header should be patched.\n * @param patch - Partial breadcrumbs-header fields to merge in. The `type` discriminator\n * cannot be overridden.\n * @returns A new context with the patched breadcrumbs header.\n * @internal\n */\nexport const patchBreadcrumbsHeader = <T extends WithHeader>(\n  context: T,\n  patch: Partial<Omit<BreadcrumbsHeader, 'type'>>,\n): T & { header: BreadcrumbsHeader } => {\n  const existing = getBreadcrumbsHeader(context.header)\n  return { ...context, header: { ...existing, ...patch } }\n}\n\n/**\n * Removes a breadcrumb from every trail in the context's breadcrumbs header.\n *\n * @remarks Use in state machine reducers to hide a step entirely, for example after\n * payroll submission when the step should no longer appear in any trail.\n *\n * @typeParam T - Context shape carrying an optional `header` of the discriminated union.\n * @param breadcrumbId - Id of the breadcrumb to strip from every trail.\n * @param context - The context whose breadcrumbs header should be updated.\n * @returns A new context with the breadcrumb removed from all trails.\n * @internal\n */\nexport const hideBreadcrumb = <T extends WithHeader>(breadcrumbId: string, context: T): T => {\n  const breadcrumbsHeader = getBreadcrumbsHeader(context.header)\n  const allBreadcrumbs = breadcrumbsHeader.breadcrumbs ?? {}\n  const updatedBreadcrumbs = Object.fromEntries(\n    Object.entries(allBreadcrumbs).map(([stateKey, trail]) => [\n      stateKey,\n      trail.filter(b => b.id !== breadcrumbId),\n    ]),\n  )\n  return {\n    ...context,\n    header: { ...breadcrumbsHeader, breadcrumbs: updatedBreadcrumbs },\n  }\n}\n\n/**\n * Marks a breadcrumb as non-navigable across every trail in the context's breadcrumbs header.\n *\n * @remarks Use in state machine reducers to disable backward navigation to a specific step\n * while still showing it in the trail.\n *\n * @typeParam T - Context shape carrying an optional `header` of the discriminated union.\n * @param breadcrumbId - Id of the breadcrumb to mark `isNavigable: false`.\n * @param context - The context whose breadcrumbs header should be updated.\n * @returns A new context with the breadcrumb locked in every trail.\n * @internal\n */\nexport const lockBreadcrumb = <T extends WithHeader>(breadcrumbId: string, context: T): T => {\n  const breadcrumbsHeader = getBreadcrumbsHeader(context.header)\n  const allBreadcrumbs = breadcrumbsHeader.breadcrumbs ?? {}\n  const updatedBreadcrumbs = Object.fromEntries(\n    Object.entries(allBreadcrumbs).map(([stateKey, trail]) => [\n      stateKey,\n      trail.map(b => (b.id === breadcrumbId ? { ...b, isNavigable: false } : b)),\n    ]),\n  )\n  return {\n    ...context,\n    header: { ...breadcrumbsHeader, breadcrumbs: updatedBreadcrumbs },\n  }\n}\n\n/**\n * Updates the breadcrumb trail for a specific state with resolved variables and switches\n * the active breadcrumb to that state.\n *\n * @remarks Typically called from state machine transitions to update breadcrumb navigation\n * when moving between states. Existing trails for other states are preserved; only the trail\n * for `stateName` is rewritten with `variables` resolved against the context. The resulting\n * context's header is always of type `'breadcrumbs'`.\n *\n * @typeParam T - Context shape carrying an optional `header` of the discriminated union.\n * @param stateName - The state whose breadcrumb trail should be updated and made active.\n * @param context - The context whose breadcrumbs header should be updated.\n * @param variables - Optional template variables to resolve against the context for each\n * breadcrumb in the target state's trail.\n * @returns A new context with the trail for `stateName` updated and `currentBreadcrumbId`\n * set to `stateName`.\n * @internal\n */\nexport const updateBreadcrumbs = <T extends WithHeader>(\n  stateName: string,\n  context: T,\n  variables?: Record<string, string>,\n): T & { header: BreadcrumbsHeader } => {\n  const breadcrumbsHeader = getBreadcrumbsHeader(context.header)\n  const allBreadcrumbs = breadcrumbsHeader.breadcrumbs ?? {}\n  const trail = allBreadcrumbs[stateName] ?? []\n  const resolvedTrail = trail.map(breadcrumb => ({\n    ...breadcrumb,\n    variables: resolveBreadcrumbVariables(variables, context as Record<string, unknown>),\n  }))\n  return {\n    ...context,\n    header: {\n      ...breadcrumbsHeader,\n      breadcrumbs: {\n        ...allBreadcrumbs,\n        [stateName]: resolvedTrail,\n      },\n      currentBreadcrumbId: stateName,\n    },\n  }\n}\n"],"names":["getBreadcrumbsHeader","header","buildBreadcrumbs","nodes","map","state","node","trail","current","parentKey","resolveBreadcrumbVariables","variables","context","resolved","key","value","match","ctxKey","patchBreadcrumbsHeader","patch","existing","hideBreadcrumb","breadcrumbId","breadcrumbsHeader","allBreadcrumbs","updatedBreadcrumbs","stateKey","b","updateBreadcrumbs","stateName","resolvedTrail","breadcrumb"],"mappings":"AAkBA,MAAMA,IAAuB,CAACC,MACxBA,GAAQ,SAAS,gBAAsBA,IACpC,EAAE,MAAM,cAAA,GAeJC,IAAmB,CAACC,MAA4C;AAC3E,QAAMC,IAAwC,CAAA;AAE9C,aAAW,CAACC,GAAOC,CAAI,KAAK,OAAO,QAAQH,CAAK,GAAG;AACjD,UAAMI,IAA0B,CAAA;AAChC,QAAIC,IAAiCF;AAErC,WAAOE,KAAS;AACd,MAAAD,EAAM,QAAQC,EAAQ,IAAI;AAC1B,YAAMC,IAA2BD,EAAQ;AACzC,MAAAA,IAAUC,IAAaN,EAAMM,CAAS,KAAK,OAAQ;AAAA,IACrD;AAEA,IAAAL,EAAIC,CAAK,IAAIE;AAAA,EACf;AAEA,SAAOH;AACT,GAgBaM,IAA6B,CACxCC,GACAC,MAC4B;AAC5B,MAAI,CAACD;AACH,WAAO,CAAA;AAGT,QAAME,IAAoC,CAAA;AAC1C,aAAW,CAACC,GAAKC,CAAK,KAAK,OAAO,QAAQJ,CAAS,GAAG;AACpD,UAAMK,IAAQD,EAAM,MAAM,WAAW;AACrC,QAAIC,IAAQ,CAAC,GAAG;AACd,YAAMC,IAASD,EAAM,CAAC,EAAE,KAAA;AACxB,MAAAH,EAASC,CAAG,IAAIF,EAAQK,CAAM,KAAK;AAAA,IACrC;AACE,MAAAJ,EAASC,CAAG,IAAIC;AAAA,EAEpB;AACA,SAAOF;AACT,GAgBaK,IAAyB,CACpCN,GACAO,MACsC;AACtC,QAAMC,IAAWpB,EAAqBY,EAAQ,MAAM;AACpD,SAAO,EAAE,GAAGA,GAAS,QAAQ,EAAE,GAAGQ,GAAU,GAAGD,IAAM;AACvD,GAcaE,IAAiB,CAAuBC,GAAsBV,MAAkB;AAC3F,QAAMW,IAAoBvB,EAAqBY,EAAQ,MAAM,GACvDY,IAAiBD,EAAkB,eAAe,CAAA,GAClDE,IAAqB,OAAO;AAAA,IAChC,OAAO,QAAQD,CAAc,EAAE,IAAI,CAAC,CAACE,GAAUnB,CAAK,MAAM;AAAA,MACxDmB;AAAA,MACAnB,EAAM,OAAO,CAAAoB,MAAKA,EAAE,OAAOL,CAAY;AAAA,IAAA,CACxC;AAAA,EAAA;AAEH,SAAO;AAAA,IACL,GAAGV;AAAA,IACH,QAAQ,EAAE,GAAGW,GAAmB,aAAaE,EAAA;AAAA,EAAmB;AAEpE,GA+CaG,IAAoB,CAC/BC,GACAjB,GACAD,MACsC;AACtC,QAAMY,IAAoBvB,EAAqBY,EAAQ,MAAM,GACvDY,IAAiBD,EAAkB,eAAe,CAAA,GAElDO,KADQN,EAAeK,CAAS,KAAK,CAAA,GACf,IAAI,CAAAE,OAAe;AAAA,IAC7C,GAAGA;AAAA,IACH,WAAWrB,EAA2BC,GAAWC,CAAkC;AAAA,EAAA,EACnF;AACF,SAAO;AAAA,IACL,GAAGA;AAAA,IACH,QAAQ;AAAA,MACN,GAAGW;AAAA,MACH,aAAa;AAAA,QACX,GAAGC;AAAA,QACH,CAACK,CAAS,GAAGC;AAAA,MAAA;AAAA,MAEf,qBAAqBD;AAAA,IAAA;AAAA,EACvB;AAEJ;"}

package/dist/helpers/currencyHelpers.d.ts

@@ -1,2 +1,16 @@
+/**
+ * Converts a dollar amount to whole cents, rounding to the nearest cent.
+ *
+ * @param dollars - Amount in dollars, or `null` to pass through.
+ * @returns The amount in cents, or `null` if the input was `null`.
+ * @internal
+ */
 export declare const dollarsToCents: (dollars: number | null) => number | null;
+/**
+ * Converts a cents amount to dollars without rounding.
+ *
+ * @param cents - Amount in cents, or `null` to pass through.
+ * @returns The amount in dollars as a floating-point number, or `null` if the input was `null`.
+ * @internal
+ */
 export declare const centsToDollars: (cents: number | null) => number | null;

package/dist/helpers/currencyHelpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"currencyHelpers.js","sources":["../../src/helpers/currencyHelpers.ts"],"sourcesContent":["export const dollarsToCents = (dollars: number | null): number | null => {\n  if (dollars === null) return null\n  return Math.round(dollars * 100)\n}\n\nexport const centsToDollars = (cents: number | null): number | null => {\n  if (cents === null) return null\n  return cents / 100\n}\n"],"names":["dollarsToCents","dollars","centsToDollars","cents"],"mappings":"AAAO,MAAMA,IAAiB,CAACC,MACzBA,MAAY,OAAa,OACtB,KAAK,MAAMA,IAAU,GAAG,GAGpBC,IAAiB,CAACC,MACzBA,MAAU,OAAa,OACpBA,IAAQ;"}
+{"version":3,"file":"currencyHelpers.js","sources":["../../src/helpers/currencyHelpers.ts"],"sourcesContent":["/**\n * Converts a dollar amount to whole cents, rounding to the nearest cent.\n *\n * @param dollars - Amount in dollars, or `null` to pass through.\n * @returns The amount in cents, or `null` if the input was `null`.\n * @internal\n */\nexport const dollarsToCents = (dollars: number | null): number | null => {\n  if (dollars === null) return null\n  return Math.round(dollars * 100)\n}\n\n/**\n * Converts a cents amount to dollars without rounding.\n *\n * @param cents - Amount in cents, or `null` to pass through.\n * @returns The amount in dollars as a floating-point number, or `null` if the input was `null`.\n * @internal\n */\nexport const centsToDollars = (cents: number | null): number | null => {\n  if (cents === null) return null\n  return cents / 100\n}\n"],"names":["dollarsToCents","dollars","centsToDollars","cents"],"mappings":"AAOO,MAAMA,IAAiB,CAACC,MACzBA,MAAY,OAAa,OACtB,KAAK,MAAMA,IAAU,GAAG,GAUpBC,IAAiB,CAACC,MACzBA,MAAU,OAAa,OACpBA,IAAQ;"}