@gusto/embedded-react-sdk 0.56.7-rc.1 → 0.57.0

package/dist/contexts/ObservabilityProvider/sanitization.js

@@ -1,4 +1,4 @@
-const o = [
+const d = [
   { pattern: /\b\d{3}-\d{2}-\d{4}\b/g, replacement: "[SSN-REDACTED]" },
   { pattern: /\b\d{9}\b/g, replacement: "[SSN-REDACTED]" },
   {
@@ -9,7 +9,7 @@ const o = [
   { pattern: /\(\d{3}\)\s*\d{3}[-.\s]?\d{4}/g, replacement: "[PHONE-REDACTED]" },
   { pattern: /\b\d{4}[-\s]?\d{4}[-\s]?\d{4}[-\s]?\d{4}\b/g, replacement: "[CC-REDACTED]" },
   { pattern: /\b[A-Za-z0-9_-]{32,}\b/g, replacement: "[TOKEN-REDACTED]" }
-], E = [
+], _ = [
   "password",
   "token",
   "apiKey",
@@ -26,70 +26,121 @@ const o = [
   "routingNumber",
   "routing_number",
   "accountNumber",
-  "account_number"
-];
-function d(e) {
-  let t = e;
-  for (const { pattern: n, replacement: r } of o)
-    t = t.replace(n, r);
-  return t;
+  "account_number",
+  "dateOfBirth",
+  "date_of_birth",
+  "birthDate",
+  "birth_date",
+  "birthday",
+  "firstName",
+  "first_name",
+  "lastName",
+  "last_name",
+  "middleName",
+  "middle_name",
+  "fullName",
+  "full_name",
+  "employeeName",
+  "employee_name",
+  "signatureText",
+  "signature_text",
+  "retirementLoanIdentifier",
+  "retirement_loan_identifier",
+  "phone",
+  "zipCode",
+  "zip_code",
+  "postalCode",
+  "postal_code",
+  "preparerCity",
+  "preparer_city",
+  "preparerZip",
+  "preparer_zip",
+  "preparer2City",
+  "preparer2_city",
+  "preparer2Zip",
+  "preparer2_zip",
+  "preparer3City",
+  "preparer3_city",
+  "preparer3Zip",
+  "preparer3_zip",
+  "preparer4City",
+  "preparer4_city",
+  "preparer4Zip",
+  "preparer4_zip",
+  "address",
+  "street1",
+  "street_1",
+  "street2",
+  "street_2",
+  "caseNumber",
+  "case_number",
+  "orderNumber",
+  "order_number",
+  "remittanceNumber",
+  "remittance_number",
+  "documentNumber",
+  "document_number"
+], E = /* @__PURE__ */ new Set(["ein", "dob", "zip", "city"]);
+function s(e) {
+  let r = e;
+  for (const { pattern: t, replacement: i } of d)
+    r = r.replace(t, i);
+  return r;
 }
-function s(e, t = []) {
+function p(e, r = []) {
   if (e == null)
     return e;
   if (typeof e == "string")
-    return d(e);
+    return s(e);
   if (typeof e == "number" || typeof e == "boolean")
     return e;
   if (Array.isArray(e))
-    return e.map((n) => s(n, t));
+    return e.map((t) => p(t, r));
   if (typeof e == "object") {
-    const n = {}, r = [...E, ...t];
-    for (const [a, c] of Object.entries(e)) {
-      if (r.some((u) => a.toLowerCase().includes(u.toLowerCase()))) {
-        n[a] = "[REDACTED]";
+    const t = {}, i = [..._, ...r];
+    for (const [a, n] of Object.entries(e)) {
+      const c = a.toLowerCase();
+      if (E.has(c) || i.some((o) => c.includes(o.toLowerCase()))) {
+        t[a] = "[REDACTED]";
         continue;
       }
-      n[a] = s(c, t);
+      t[a] = p(n, r);
     }
-    return n;
+    return t;
   }
   return e;
 }
-function p(e, t = {}) {
-  const {
-    enabled: n = !0,
-    includeRawError: r = !1,
-    customErrorSanitizer: a,
-    additionalSensitiveFields: c = []
-  } = t;
-  if (a)
-    return a(e);
-  if (!n)
-    return r ? e : { ...e, raw: void 0 };
-  const u = e.fieldErrors.map((i) => ({
-    ...i,
-    message: d(i.message),
-    metadata: i.metadata ? s(i.metadata, c) : void 0
-  }));
-  return {
+function u(e, { enabled: r = !0, includeRawError: t = !1, additionalSensitiveFields: i = [] }) {
+  const a = t ? e.raw : void 0;
+  return r ? {
     ...e,
-    message: d(e.message),
-    fieldErrors: u,
-    raw: r ? e.raw : void 0
-  };
+    message: s(e.message),
+    fieldErrors: e.fieldErrors.map((n) => ({
+      ...n,
+      message: s(n.message),
+      metadata: n.metadata ? p(n.metadata, i) : void 0
+    })),
+    raw: a
+  } : { ...e, raw: a };
 }
-function l(e, t = {}) {
-  const { enabled: n = !0, customMetricSanitizer: r, additionalSensitiveFields: a = [] } = t;
-  return r ? r(e) : n ? {
+function m(e, { enabled: r = !0, additionalSensitiveFields: t = [] }) {
+  return r ? {
     ...e,
-    tags: e.tags ? s(e.tags, a) : void 0
+    tags: e.tags ? p(e.tags, t) : void 0
   } : e;
 }
+function l(e, r = {}) {
+  const t = u(e, r);
+  return r.customErrorSanitizer ? u(r.customErrorSanitizer(t), r) : t;
+}
+function b(e, r = {}) {
+  const t = m(e, r);
+  return r.customMetricSanitizer ? m(r.customMetricSanitizer(t), r) : t;
+}
 export {
-  p as sanitizeError,
-  l as sanitizeMetric,
-  s as sanitizeObject,
-  d as sanitizeString
+  l as sanitizeError,
+  b as sanitizeMetric,
+  p as sanitizeObject,
+  s as sanitizeString
 };
 //# sourceMappingURL=sanitization.js.map

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\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;"}
+{"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  'dateOfBirth',\n  'date_of_birth',\n  'birthDate',\n  'birth_date',\n  'birthday',\n  'firstName',\n  'first_name',\n  'lastName',\n  'last_name',\n  'middleName',\n  'middle_name',\n  'fullName',\n  'full_name',\n  'employeeName',\n  'employee_name',\n  'signatureText',\n  'signature_text',\n  'retirementLoanIdentifier',\n  'retirement_loan_identifier',\n  'phone',\n  'zipCode',\n  'zip_code',\n  'postalCode',\n  'postal_code',\n  'preparerCity',\n  'preparer_city',\n  'preparerZip',\n  'preparer_zip',\n  'preparer2City',\n  'preparer2_city',\n  'preparer2Zip',\n  'preparer2_zip',\n  'preparer3City',\n  'preparer3_city',\n  'preparer3Zip',\n  'preparer3_zip',\n  'preparer4City',\n  'preparer4_city',\n  'preparer4Zip',\n  'preparer4_zip',\n  'address',\n  'street1',\n  'street_1',\n  'street2',\n  'street_2',\n  'caseNumber',\n  'case_number',\n  'orderNumber',\n  'order_number',\n  'remittanceNumber',\n  'remittance_number',\n  'documentNumber',\n  'document_number',\n]\n\nconst EXACT_SENSITIVE_FIELD_NAMES = new Set(['ein', 'dob', 'zip', 'city'])\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]`. Short names\n * (`ein`, `dob`, `zip`, `city`) match the whole key, case-insensitively. 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      const lowerKey = key.toLowerCase()\n      if (\n        EXACT_SENSITIVE_FIELD_NAMES.has(lowerKey) ||\n        allSensitiveFields.some(field => lowerKey.includes(field.toLowerCase()))\n      ) {\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\nfunction redactError(\n  error: ObservabilityError,\n  { enabled = true, includeRawError = false, additionalSensitiveFields = [] }: SanitizationConfig,\n): ObservabilityError {\n  const raw = includeRawError ? error.raw : undefined\n\n  if (!enabled) {\n    return { ...error, raw }\n  }\n\n  return {\n    ...error,\n    message: sanitizeString(error.message),\n    fieldErrors: error.fieldErrors.map(fieldError => ({\n      ...fieldError,\n      message: sanitizeString(fieldError.message),\n      metadata: fieldError.metadata\n        ? (sanitizeObject(fieldError.metadata, additionalSensitiveFields) as Record<\n            string,\n            unknown\n          >)\n        : undefined,\n    })),\n    raw,\n  }\n}\n\nfunction redactMetric(\n  metric: ObservabilityMetric,\n  { enabled = true, additionalSensitiveFields = [] }: SanitizationConfig,\n): ObservabilityMetric {\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\n/**\n * Redacts error messages and field-error metadata before and after a custom sanitizer runs.\n *\n * @remarks\n * `enabled: false` skips redaction. Independently, `raw` is excluded before and after the\n * custom sanitizer unless `includeRawError: true`. Opted-in `raw` is passed through unchanged.\n * Other error properties are preserved without redaction.\n *\n * @internal\n */\nexport function sanitizeError(\n  error: ObservabilityError,\n  config: SanitizationConfig = {},\n): ObservabilityError {\n  const sanitized = redactError(error, config)\n  return config.customErrorSanitizer\n    ? redactError(config.customErrorSanitizer(sanitized), config)\n    : sanitized\n}\n\n/**\n * Redacts metric tags before and after a custom sanitizer runs, unless `enabled: false`.\n *\n * @remarks\n * Other metric properties are preserved without redaction.\n *\n * @internal\n */\nexport function sanitizeMetric(\n  metric: ObservabilityMetric,\n  config: SanitizationConfig = {},\n): ObservabilityMetric {\n  const sanitized = redactMetric(metric, config)\n  return config.customMetricSanitizer\n    ? redactMetric(config.customMetricSanitizer(sanitized), config)\n    : sanitized\n}\n"],"names":["PII_PATTERNS","SENSITIVE_FIELD_NAMES","EXACT_SENSITIVE_FIELD_NAMES","sanitizeString","value","sanitized","pattern","replacement","sanitizeObject","obj","additionalSensitiveFields","item","allSensitiveFields","key","lowerKey","field","redactError","error","enabled","includeRawError","raw","fieldError","redactMetric","metric","sanitizeError","config","sanitizeMetric"],"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;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;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;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;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAEMC,wBAAkC,IAAI,CAAC,OAAO,OAAO,OAAO,MAAM,CAAC;AASlE,SAASC,EAAeC,GAAuB;AACpD,MAAIC,IAAYD;AAEhB,aAAW,EAAE,SAAAE,GAAS,aAAAC,EAAA,KAAiBP;AACrC,IAAAK,IAAYA,EAAU,QAAQC,GAASC,CAAW;AAGpD,SAAOF;AACT;AAiBO,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,GAAGX,GAAuB,GAAGS,CAAyB;AAElF,eAAW,CAACG,GAAKT,CAAK,KAAK,OAAO,QAAQK,CAAG,GAAG;AAC9C,YAAMK,IAAWD,EAAI,YAAA;AACrB,UACEX,EAA4B,IAAIY,CAAQ,KACxCF,EAAmB,KAAK,CAAAG,MAASD,EAAS,SAASC,EAAM,YAAA,CAAa,CAAC,GACvE;AACA,QAAAV,EAAUQ,CAAG,IAAI;AACjB;AAAA,MACF;AAEA,MAAAR,EAAUQ,CAAG,IAAIL,EAAeJ,GAAOM,CAAyB;AAAA,IAClE;AAEA,WAAOL;AAAA,EACT;AAEA,SAAOI;AACT;AAEA,SAASO,EACPC,GACA,EAAE,SAAAC,IAAU,IAAM,iBAAAC,IAAkB,IAAO,2BAAAT,IAA4B,CAAA,KACnD;AACpB,QAAMU,IAAMD,IAAkBF,EAAM,MAAM;AAE1C,SAAKC,IAIE;AAAA,IACL,GAAGD;AAAA,IACH,SAASd,EAAec,EAAM,OAAO;AAAA,IACrC,aAAaA,EAAM,YAAY,IAAI,CAAAI,OAAe;AAAA,MAChD,GAAGA;AAAA,MACH,SAASlB,EAAekB,EAAW,OAAO;AAAA,MAC1C,UAAUA,EAAW,WAChBb,EAAea,EAAW,UAAUX,CAAyB,IAI9D;AAAA,IAAA,EACJ;AAAA,IACF,KAAAU;AAAA,EAAA,IAhBO,EAAE,GAAGH,GAAO,KAAAG,EAAA;AAkBvB;AAEA,SAASE,EACPC,GACA,EAAE,SAAAL,IAAU,IAAM,2BAAAR,IAA4B,CAAA,KACzB;AACrB,SAAKQ,IAIE;AAAA,IACL,GAAGK;AAAA,IACH,MAAMA,EAAO,OACRf,EAAee,EAAO,MAAMb,CAAyB,IACtD;AAAA,EAAA,IAPGa;AASX;AAYO,SAASC,EACdP,GACAQ,IAA6B,IACT;AACpB,QAAMpB,IAAYW,EAAYC,GAAOQ,CAAM;AAC3C,SAAOA,EAAO,uBACVT,EAAYS,EAAO,qBAAqBpB,CAAS,GAAGoB,CAAM,IAC1DpB;AACN;AAUO,SAASqB,EACdH,GACAE,IAA6B,IACR;AACrB,QAAMpB,IAAYiB,EAAaC,GAAQE,CAAM;AAC7C,SAAOA,EAAO,wBACVH,EAAaG,EAAO,sBAAsBpB,CAAS,GAAGoB,CAAM,IAC5DpB;AACN;"}

package/dist/package.json.js

@@ -1,4 +1,4 @@
-const e = "@gusto/embedded-react-sdk", o = "0.56.7";
+const e = "@gusto/embedded-react-sdk", o = "0.57.0";
 export {
   e as name,
   o as version

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

@@ -12,7 +12,8 @@ export declare function sanitizeString(value: string): string;
  *
  * @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
+ * entry in `additionalSensitiveFields` have their values replaced with `[REDACTED]`. Short names
+ * (`ein`, `dob`, `zip`, `city`) match the whole key, case-insensitively. String
  * values are passed through {@link sanitizeString} so PII patterns inside them are also redacted.
  * Numbers, booleans, `null`, and `undefined` pass through unchanged.
  *
@@ -23,32 +24,22 @@ export declare function sanitizeString(value: string): string;
  */
 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.
+ * Redacts error messages and field-error metadata before and after a custom sanitizer runs.
  *
  * @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.
+ * `enabled: false` skips redaction. Independently, `raw` is excluded before and after the
+ * custom sanitizer unless `includeRawError: true`. Opted-in `raw` is passed through unchanged.
+ * Other error properties are preserved without redaction.
  *
- * @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.
+ * Redacts metric tags before and after a custom sanitizer runs, unless `enabled: false`.
  *
  * @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.
+ * Other metric properties are preserved without redaction.
  *
- * @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/src/contexts/ObservabilityProvider/useSanitizedObservability.test.d.ts

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

package/dist/src/types/observability.d.ts

@@ -47,37 +47,76 @@ export interface ObservabilityMetric {
     timestamp: number;
 }
 /**
- * Configuration for sanitizing error and metric data before it reaches observability hooks.
+ * Configures redaction and raw-error inclusion for observability callbacks.
  *
  * @remarks
- * Sanitization runs by default to prevent PII leakage. When enabled, the SDK
- * pattern-redacts SSNs, emails, phone numbers, credit card numbers, and API
- * tokens from messages and tags, and removes values for fields with sensitive
- * names (`password`, `ssn`, `bankAccount`, etc.) from metadata. The `raw`
- * error object is excluded unless `includeRawError` is set to `true`.
+ * By default, the SDK redacts recognized string patterns in error `message` and
+ * `fieldErrors[].message`, and recursively redacts sensitive keys and recognized string
+ * patterns in `fieldErrors[].metadata` and metric `tags`. Sensitive keys include credentials,
+ * financial identifiers, personal names, birth dates, addresses, and document identifiers.
+ * Values are replaced with placeholders; keys are retained. Other properties are not redacted.
+ *
+ * Pattern and key matching do not detect every sensitive value. Free-text names and addresses,
+ * for example, may remain in messages. Select which fields to forward in your callbacks and
+ * use additional sensitive keys or custom sanitizers for further processing.
+ *
+ * Processing order is SDK redaction/raw exclusion, custom sanitizer, SDK redaction/raw
+ * exclusion again, then the observability callback. Custom functions receive processed input
+ * and their output follows the same configuration. `enabled` controls redaction independently
+ * of `includeRawError`; opted-in raw errors pass through without redaction.
+ *
+ * This configuration applies only to observability callbacks. It does not sanitize form-hook
+ * errors, component events, request hooks, or data added by your monitoring integration.
  *
  * @public
  */
 export interface SanitizationConfig {
     /**
-     * Whether to sanitize error data. Default: true
+     * Whether to redact recognized sensitive values in messages, field-error metadata, and
+     * metric tags. Default: true.
+     *
+     * @remarks
+     * When `false`, built-in and additional-sensitive-key redaction is skipped before and after
+     * custom sanitizers. Custom sanitizers still run. Raw errors remain excluded unless
+     * `includeRawError` is `true`.
      */
     enabled?: boolean;
     /**
-     * Whether to include the raw error object on SDKError. Default: false
-     * WARNING: Raw errors may contain sensitive data from form inputs or API responses
+     * Whether to include the original error as `raw` in observability errors. Default: false.
+     *
+     * @remarks
+     * When `false`, `raw` is set to `undefined` before and after a custom error sanitizer,
+     * regardless of `enabled`. When `true`, `raw` passes through without redaction and can
+     * contain form inputs, API response bodies, and request headers, including credentials.
      */
     includeRawError?: boolean;
     /**
-     * Custom sanitization function for errors
+     * Transforms an error between applications of the configured SDK processing.
+     *
+     * @remarks
+     * Receives an error after configured redaction and raw exclusion. The SDK processes the
+     * returned `message`, `fieldErrors[].message`, `fieldErrors[].metadata`, and `raw` again
+     * according to `enabled`, `includeRawError`, and `additionalSensitiveFields`. Other properties
+     * are preserved without redaction. Return an error of the same type; messages may be replaced
+     * and metadata omitted for additional control over emitted data.
      */
     customErrorSanitizer?: (error: ObservabilityError) => ObservabilityError;
     /**
-     * Custom sanitization function for metrics
+     * Transforms a metric between applications of the configured SDK redaction.
+     *
+     * @remarks
+     * Receives a metric after configured tag redaction. Returned `tags` are redacted again,
+     * including keys added by your function. Both passes honor `enabled` and
+     * `additionalSensitiveFields`. Other properties are preserved without redaction.
      */
     customMetricSanitizer?: (metric: ObservabilityMetric) => ObservabilityMetric;
     /**
-     * Additional field names to treat as sensitive (case-insensitive)
+     * Additional sensitive keys in field-error metadata and metric tags.
+     *
+     * @remarks
+     * Uses case-insensitive substring matching in nested objects and arrays, before and after
+     * custom sanitizers when redaction is enabled. Matching values are replaced with `[REDACTED]`.
+     * Does not match field-error paths, message text, or properties outside metadata and tags.
      */
     additionalSensitiveFields?: string[];
 }
@@ -87,8 +126,10 @@ export interface SanitizationConfig {
  * @remarks
  * Pass an instance to {@link GustoProvider} via `config.observability` to forward
  * errors to services like Sentry or Datadog and to capture performance metrics
- * for form submissions and component loading. Sanitization is applied before
- * the hooks are invoked; see {@link SanitizationConfig}.
+ * for form submissions and component loading. Recognized sensitive values are redacted and
+ * raw errors excluded by default before callbacks run; see {@link SanitizationConfig}.
+ * Select which payload fields to forward. This processing does not detect every PII value
+ * or cover data independently collected by your monitoring tool.
  *
  * @public
  * @group Observability
@@ -96,11 +137,11 @@ export interface SanitizationConfig {
  * @example
  * ```tsx
  * import * as Sentry from '@sentry/react'
- * import { GustoProvider, type ObservabilityHook } from '@gusto/embedded-react-sdk'
+ * import type { ObservabilityHook } from '@gusto/embedded-react-sdk'
  *
- * const observability: ObservabilityHook = {
+ * export const observability: ObservabilityHook = {
  *   onError: error => {
- *     Sentry.captureException(error.raw ?? new Error(error.message), {
+ *     Sentry.captureException(new Error(error.message), {
  *       level: error.category === 'validation_error' ? 'warning' : 'error',
  *       tags: {
  *         error_category: error.category,
@@ -114,9 +155,7 @@ export interface SanitizationConfig {
  *   },
  * }
  *
- * <GustoProvider config={{ baseUrl: '/api/', observability }}>
- *   <YourApp />
- * </GustoProvider>
+ * // Pass observability to GustoProvider through config.observability.
  * ```
  */
 export interface ObservabilityHook {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gusto/embedded-react-sdk",
-  "version": "0.56.7-rc.1",
+  "version": "0.57.0",
   "homepage": "https://github.com/Gusto/embedded-react-sdk",
   "bugs": {
     "url": "https://github.com/Gusto/embedded-react-sdk/issues"
@@ -102,7 +102,7 @@
     "@microsoft/api-extractor": "^7.59.1",
     "@playwright/test": "^1.64.0",
     "@release-it/conventional-changelog": "^12.0.2",
-    "@storybook/addon-a11y": "^10.6.0",
+    "@storybook/addon-a11y": "^10.6.1",
     "@storybook/addon-docs": "^10.6.0",
     "@storybook/addon-onboarding": "^10.6.1",
     "@storybook/react-vite": "^10.6.0",
@@ -123,7 +123,7 @@
     "@vitejs/plugin-react-swc": "^4.3.3",
     "@vitest/coverage-v8": "^5.0.0",
     "ajv": "^8.20.0",
-    "axe-core": "^4.13.0",
+    "axe-core": "^4.14.0",
     "cspell": "^10.3.6",
     "dotenv": "^18.0.3",
     "eslint": "^9.39.5",
@@ -143,7 +143,7 @@
     "json-schema-to-typescript": "^16.0.0",
     "lint-staged": "^17.5.1",
     "markdownlint-cli2": "^0.23.3",
-    "msw": "^2.15.0",
+    "msw": "^3.0.3",
     "npm-run-all": "^4.1.5",
     "pixelmatch": "^7.2.0",
     "pngjs": "^7.0.0",
@@ -159,10 +159,10 @@
     "ts-morph": "^28.0.0",
     "tsx": "^4.23.15",
     "typescript-eslint": "^8.70.1",
-    "vite": "^6.4.3",
+    "vite": "^6.4.4",
     "vite-plugin-checker": "^0.14.5",
     "vite-plugin-circular-dependency": "^0.6.0",
-    "vite-plugin-dts": "^5.1.1",
+    "vite-plugin-dts": "^5.1.2",
     "vite-plugin-externalize-deps": "^0.10.0",
     "vite-plugin-stylelint": "^6.3.0",
     "vite-plugin-svgr": "^5.2.0",