@ogcio/o11y-sdk-react 0.2.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [0.4.0](https://github.com/ogcio/o11y/compare/@ogcio/o11y-sdk-react@v0.3.0...@ogcio/o11y-sdk-react@v0.4.0) (2025-09-02)
+
+
+### Features
+
+* o11y react-sdk IP pii redaction AB[#30758](https://github.com/ogcio/o11y/issues/30758) ([#196](https://github.com/ogcio/o11y/issues/196)) ([d6bb83f](https://github.com/ogcio/o11y/commit/d6bb83fa425ffdf3fb023ec62caeef070995d07a))
+
+
+### Miscellaneous Chores
+
+* **deps:** bump the root-deps group across 1 directory with 16 updates ([#193](https://github.com/ogcio/o11y/issues/193)) ([c523565](https://github.com/ogcio/o11y/commit/c523565a6ba7f327473e8d93afc7d532ac220457))
+* **deps:** bump the root-deps group across 3 directories with 34 updates ([#188](https://github.com/ogcio/o11y/issues/188)) ([c0059f3](https://github.com/ogcio/o11y/commit/c0059f33cbb5c39cf6df0f4640604796dbbd3f57))
+
+## [0.3.0](https://github.com/ogcio/o11y/compare/@ogcio/o11y-sdk-react@v0.2.0...@ogcio/o11y-sdk-react@v0.3.0) (2025-07-31)
+
+
+### Features
+
+* **sdk-react:** pii detection ([#180](https://github.com/ogcio/o11y/issues/180)) ([57ddf2f](https://github.com/ogcio/o11y/commit/57ddf2f4792207e62ea6bf9ea797bc652942db06))
+* update AWS secrets manager connection AB[#29565](https://github.com/ogcio/o11y/issues/29565) ([#166](https://github.com/ogcio/o11y/issues/166)) ([962c03d](https://github.com/ogcio/o11y/commit/962c03de2da4060a81aa603c355f3d60cafe3c30))
+
 ## [0.2.0](https://github.com/ogcio/o11y/compare/@ogcio/o11y-sdk-react@v0.1.0-beta.7...@ogcio/o11y-sdk-react@v0.2.0) (2025-06-24)
 
 

package/dist/lib/index.d.ts

@@ -33,6 +33,21 @@ export interface FaroSDKConfig extends SDKConfig {
      * @example http://localhost:9000
      */
     corsTraceHeaders?: string;
+    /**
+     * Enable/Disable PII detection for GDPR data
+     */
+    detection?: {
+        /**
+         * Redact email addresses
+         * @default true
+         */
+        email?: boolean;
+        /**
+         * Redact ip addresses
+         * @default true
+         */
+        ip?: boolean;
+    };
 }
 export type SDKCollectorMode = "single" | "batch";
 export type SDKLogLevel = "NONE" | "ERROR" | "WARN" | "INFO" | "DEBUG" | "VERBOSE" | "ALL";

package/dist/lib/instrumentation.faro.d.ts

@@ -1,3 +1,3 @@
-import type { FaroSDKConfig } from "./index.js";
 import { type Faro } from "@grafana/faro-react";
+import type { FaroSDKConfig } from "./index.js";
 export default function buildFaroInstrumentation(config?: FaroSDKConfig): Faro | undefined;

package/dist/lib/instrumentation.faro.js

@@ -1,10 +1,12 @@
 import { ErrorsInstrumentation, getWebInstrumentations, initializeFaro, WebVitalsInstrumentation, } from "@grafana/faro-react";
+import { TracingInstrumentation } from "@grafana/faro-web-tracing";
 import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";
 import { W3CTraceContextPropagator } from "@opentelemetry/core";
+import { DocumentLoadInstrumentation } from "@opentelemetry/instrumentation-document-load";
 import { FetchInstrumentation } from "@opentelemetry/instrumentation-fetch";
 import { UserInteractionInstrumentation } from "@opentelemetry/instrumentation-user-interaction";
-import { DocumentLoadInstrumentation } from "@opentelemetry/instrumentation-document-load";
-import { TracingInstrumentation } from "@grafana/faro-web-tracing";
+import { _beforeSend } from "./internals/hooks.js";
+import { redactors, } from "./internals/redaction/redactors/index.js";
 export default function buildFaroInstrumentation(config) {
     if (!config) {
         console.warn("observability config not set. Skipping Faro OpenTelemetry instrumentation.");
@@ -18,6 +20,11 @@ export default function buildFaroInstrumentation(config) {
         console.error("collectorUrl does not use a valid format. Skipping Faro OpenTelemetry instrumentation.");
         return;
     }
+    const redactorsChain = Object.entries(redactors)
+        .filter(([key]) => {
+        return config.detection?.[key] !== false;
+    })
+        .map(([_, value]) => value);
     try {
         diag.setLogger(new DiagConsoleLogger(), config.diagLogLevel
             ? DiagLogLevel[config.diagLogLevel]
@@ -30,6 +37,7 @@ export default function buildFaroInstrumentation(config) {
             batching: {
                 enabled: !(config.collectorMode === "single"),
             },
+            beforeSend: _beforeSend(redactorsChain),
             instrumentations: [
                 ...getWebInstrumentations({
                     captureConsole: true,

package/dist/lib/internals/hooks.d.ts

@@ -0,0 +1,3 @@
+import { APIEvent, TransportItem } from "@grafana/faro-web-sdk";
+import { Redactor } from "./redaction/redactors/index.js";
+export declare const _beforeSend: (redactors: Redactor[]) => (item: TransportItem<APIEvent>) => TransportItem<APIEvent> | null;

package/dist/lib/internals/hooks.js

@@ -0,0 +1,34 @@
+import { _cleanStringPII } from "./redaction/pii-detection.js";
+function _cleanObjectPII(data, type, redactors) {
+    if (!data) {
+        return;
+    }
+    if (Array.isArray(data)) {
+        data.forEach((item, index) => {
+            if (typeof item === "string") {
+                data[index] = _cleanStringPII(data[index], type, redactors);
+                return;
+            }
+            if (typeof item === "object") {
+                _cleanObjectPII(item, type, redactors);
+            }
+        });
+    }
+    if (typeof data === "object") {
+        for (const key in data) {
+            if (typeof data[key] === "string") {
+                data[key] = _cleanStringPII(data[key], type, redactors);
+            }
+            if (typeof data[key] === "object") {
+                _cleanObjectPII(data[key], type, redactors);
+            }
+        }
+    }
+}
+export const _beforeSend = (redactors) => (item) => {
+    if (redactors.length === 0) {
+        return item;
+    }
+    _cleanObjectPII(item, item.type, redactors);
+    return item;
+};

package/dist/lib/internals/redaction/pii-detection.d.ts

@@ -0,0 +1,19 @@
+import { TransportItemType } from "@grafana/faro-web-sdk";
+import { Redactor } from "./redactors/index.js";
+/**
+ * Cleans a string by redacting configured PIIs and emitting metrics for redacted values.
+ *
+ * If the string is URL-encoded, it will be decoded before redaction.
+ * Metrics are emitted for:
+ * - each domain found in redacted email addresses.
+ * - IPv4|IPv6 addresses redacted.
+ *
+ * @template T
+ *
+ * @param {string} value - The input value to sanitize.
+ * @param {"trace" | "log"} source - The source context of the input, used in metrics.
+ * @param {Redactor[]} redactors - The string processors containing the redaction logic.
+ *
+ * @returns {T} The cleaned string with any configured PII replaced by `[REDACTED PII_TYPE]`.
+ */
+export declare function _cleanStringPII(value: string, source: TransportItemType, redactors: Redactor[]): string;

package/dist/lib/internals/redaction/pii-detection.js

@@ -0,0 +1,39 @@
+/**
+ * Checks whether a string contains URI-encoded components.
+ *
+ * @param {string} value - The string to inspect.
+ * @returns {boolean} `true` if the string is encoded, `false` otherwise.
+ */
+function _containsEncodedComponents(value) {
+    try {
+        return decodeURI(value) !== decodeURIComponent(value);
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Cleans a string by redacting configured PIIs and emitting metrics for redacted values.
+ *
+ * If the string is URL-encoded, it will be decoded before redaction.
+ * Metrics are emitted for:
+ * - each domain found in redacted email addresses.
+ * - IPv4|IPv6 addresses redacted.
+ *
+ * @template T
+ *
+ * @param {string} value - The input value to sanitize.
+ * @param {"trace" | "log"} source - The source context of the input, used in metrics.
+ * @param {Redactor[]} redactors - The string processors containing the redaction logic.
+ *
+ * @returns {T} The cleaned string with any configured PII replaced by `[REDACTED PII_TYPE]`.
+ */
+export function _cleanStringPII(value, source, redactors) {
+    let kind = "string";
+    let decodedValue = value;
+    if (_containsEncodedComponents(value)) {
+        decodedValue = decodeURIComponent(value);
+        kind = "url";
+    }
+    return redactors.reduce((redactedValue, currentRedactor) => currentRedactor(redactedValue, source, kind), decodedValue);
+}

package/dist/lib/internals/redaction/redactors/email.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Redacts provided input and collects metadata metrics about redacted email domains,
+ * data source and kind.
+ *
+ * @param {string} value The input string potentially containing email addresses.
+ * @returns {string} the redacted value
+ */
+export declare const emailRedactor: (value: string, source: string, kind: string) => string;

package/dist/lib/internals/redaction/redactors/email.js

@@ -0,0 +1,55 @@
+import { faro } from "@grafana/faro-web-sdk";
+const EMAIL_REGEX = /[\p{L}\p{N}._%+-]+@((?:[\p{L}\p{N}-]+\.)+[\p{L}]{2,})/giu;
+/**
+ * Redacts all email addresses in the input string and collects metadata.
+ *
+ * @param {string} value The input string potentially containing email addresses.
+ * @returns {{
+ *   redacted: string,
+ *   count: number,
+ *   domains: Record<string, number>
+ * }}
+ *
+ * An object containing:
+ *   - `redacted`: the string with email addresses replaced by `[REDACTED EMAIL]`
+ *   - `count`: total number of email addresses redacted
+ *   - `domains`: a map of domain names to the number of times they were redacted
+ */
+function _redactEmails(value) {
+    let count = 0;
+    const domains = {};
+    const redacted = value.replace(EMAIL_REGEX, (_, domain) => {
+        count++;
+        domains[domain] = (domains[domain] || 0) + 1;
+        return "[REDACTED EMAIL]";
+    });
+    return { redacted, count, domains };
+}
+/**
+ * Redacts provided input and collects metadata metrics about redacted email domains,
+ * data source and kind.
+ *
+ * @param {string} value The input string potentially containing email addresses.
+ * @returns {string} the redacted value
+ */
+export const emailRedactor = (value, source, kind) => {
+    const { redacted, count, domains } = _redactEmails(value);
+    if (count > 0) {
+        for (const [domain, domainCount] of Object.entries(domains)) {
+            faro.api.pushMeasurement({
+                type: "faro_o11y_pii_redaction",
+                values: {
+                    redacted: domainCount,
+                },
+            }, {
+                context: {
+                    pii_type: "email",
+                    redaction_source: source,
+                    pii_email_domain: domain,
+                    pii_format: kind,
+                },
+            });
+        }
+    }
+    return redacted;
+};

package/dist/lib/internals/redaction/redactors/index.d.ts

@@ -0,0 +1,4 @@
+import { type FaroSDKConfig } from "../../../index.js";
+export type Redactor = (value: string, source: string, kind: string) => string;
+export type RedactorKeys = keyof NonNullable<FaroSDKConfig["detection"]>;
+export declare const redactors: Record<RedactorKeys, Redactor>;

package/dist/lib/internals/redaction/redactors/index.js

@@ -0,0 +1,6 @@
+import { emailRedactor } from "./email.js";
+import { ipRedactor } from "./ip.js";
+export const redactors = {
+    email: emailRedactor,
+    ip: ipRedactor,
+};

package/dist/lib/internals/redaction/redactors/ip.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Redacts provided input and collects metadata metrics about redacted IPs,
+ * data source and kind.
+ *
+ * @param {string} value The input string potentially containing IP addresses.
+ * @param {string} source The source of the attribute being redacted (log, span, metric).
+ * @param {string} kind The type of the data structure containing the PII
+ * @returns {string} the redacted value
+ */
+export declare const ipRedactor: (value: string, source: string, kind: string) => string;

package/dist/lib/internals/redaction/redactors/ip.js

@@ -0,0 +1,61 @@
+import { faro } from "@grafana/faro-web-sdk";
+// Generous IP address matchers (might match some invalid addresses like 192.168.01.1)
+const IPV4_REGEX = /(?<!\d)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}(?!\d)/gi;
+const IPV6_REGEX = /(?<![0-9a-f:])((?:[0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(?:[0-9A-Fa-f]{1,4}:){1,7}:|:(?::[0-9A-Fa-f]{1,4}){1,7}|(?:[0-9A-Fa-f]{1,4}:){1,6}:[0-9A-Fa-f]{1,4}|(?:[0-9A-Fa-f]{1,4}:){1,5}(?::[0-9A-Fa-f]{1,4}){1,2}|(?:[0-9A-Fa-f]{1,4}:){1,4}(?::[0-9A-Fa-f]{1,4}){1,3}|(?:[0-9A-Fa-f]{1,4}:){1,3}(?::[0-9A-Fa-f]{1,4}){1,4}|(?:[0-9A-Fa-f]{1,4}:){1,2}(?::[0-9A-Fa-f]{1,4}){1,5}|[0-9A-Fa-f]{1,4}:(?::[0-9A-Fa-f]{1,4}){1,6}|:(?::[0-9A-Fa-f]{1,4}){1,7}:?|(?:[0-9A-Fa-f]{1,4}:){1,4}:(?:25[0-5]|2[0-4]\d|1\d\d|\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|1\d\d|\d{1,2})){3})(?![0-9a-f:])/gi;
+/**
+ * Redacts all ip addresses in the input string and collects metadata.
+ *
+ * @param {string} value The input string potentially containing ip addresses.
+ * @returns {{
+ *   redacted: string,
+ *   count: number,
+ *   domains: Record<string, number>
+ * }}
+ *
+ * An object containing:
+ *   - `redacted`: the string with IP addresses replaced by `[REDACTED IPV*]`
+ *   - `counters`: total number of addresses redacted by IPv* type
+ *   - `domains`: a map of domain names to the number of times they were redacted
+ */
+function _redactIps(value) {
+    const counters = {};
+    const redacted = value
+        .replace(IPV4_REGEX, () => {
+        counters["IPv4"] = (counters["IPv4"] || 0) + 1;
+        return "[REDACTED IPV4]";
+    })
+        .replace(IPV6_REGEX, () => {
+        counters["IPv4"] = (counters["IPv4"] || 0) + 1;
+        return "[REDACTED IPV6]";
+    });
+    return { redacted, counters };
+}
+/**
+ * Redacts provided input and collects metadata metrics about redacted IPs,
+ * data source and kind.
+ *
+ * @param {string} value The input string potentially containing IP addresses.
+ * @param {string} source The source of the attribute being redacted (log, span, metric).
+ * @param {string} kind The type of the data structure containing the PII
+ * @returns {string} the redacted value
+ */
+export const ipRedactor = (value, source, kind) => {
+    const { redacted, counters } = _redactIps(value);
+    Object.entries(counters).forEach(([type, counter]) => {
+        if (counter > 0) {
+            faro.api.pushMeasurement({
+                type: "faro_o11y_pii_redaction",
+                values: {
+                    redacted: counter,
+                },
+            }, {
+                context: {
+                    pii_type: type,
+                    redaction_source: source,
+                    pii_format: kind,
+                },
+            });
+        }
+    });
+    return redacted;
+};

package/dist/vitest.config.js

@@ -3,7 +3,7 @@ export default defineConfig({
     test: {
         globals: true,
         watch: false,
-        include: ["**/test/*.test.ts"],
+        include: ["**/*.test.ts"],
         exclude: ["**/fixtures/**", "**/dist/**"],
         poolOptions: {
             threads: {

package/lib/index.ts

@@ -34,6 +34,21 @@ export interface FaroSDKConfig extends SDKConfig {
    * @example http://localhost:9000
    */
   corsTraceHeaders?: string;
+  /**
+   * Enable/Disable PII detection for GDPR data
+   */
+  detection?: {
+    /**
+     * Redact email addresses
+     * @default true
+     */
+    email?: boolean;
+    /**
+     * Redact ip addresses
+     * @default true
+     */
+    ip?: boolean;
+  };
 }
 
 export type SDKCollectorMode = "single" | "batch";

package/lib/instrumentation.faro.ts

@@ -1,4 +1,3 @@
-import type { FaroSDKConfig } from "./index.js";
 import {
   ErrorsInstrumentation,
   getWebInstrumentations,
@@ -6,12 +5,18 @@ import {
   WebVitalsInstrumentation,
   type Faro,
 } from "@grafana/faro-react";
+import { TracingInstrumentation } from "@grafana/faro-web-tracing";
 import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";
 import { W3CTraceContextPropagator } from "@opentelemetry/core";
+import { DocumentLoadInstrumentation } from "@opentelemetry/instrumentation-document-load";
 import { FetchInstrumentation } from "@opentelemetry/instrumentation-fetch";
 import { UserInteractionInstrumentation } from "@opentelemetry/instrumentation-user-interaction";
-import { DocumentLoadInstrumentation } from "@opentelemetry/instrumentation-document-load";
-import { TracingInstrumentation } from "@grafana/faro-web-tracing";
+import type { FaroSDKConfig } from "./index.js";
+import { _beforeSend } from "./internals/hooks.js";
+import {
+  RedactorKeys,
+  redactors,
+} from "./internals/redaction/redactors/index.js";
 
 export default function buildFaroInstrumentation(
   config?: FaroSDKConfig,
@@ -37,6 +42,11 @@ export default function buildFaroInstrumentation(
     return;
   }
 
+  const redactorsChain = Object.entries(redactors)
+    .filter(([key]) => {
+      return config.detection?.[key as RedactorKeys] !== false;
+    })
+    .map(([_, value]) => value);
   try {
     diag.setLogger(
       new DiagConsoleLogger(),
@@ -53,11 +63,11 @@ export default function buildFaroInstrumentation(
       batching: {
         enabled: !(config.collectorMode === "single"),
       },
+      beforeSend: _beforeSend(redactorsChain),
       instrumentations: [
         ...getWebInstrumentations({
           captureConsole: true,
         }),
-
         new ErrorsInstrumentation(),
         new WebVitalsInstrumentation(),
         new TracingInstrumentation({

package/lib/internals/hooks.ts

@@ -0,0 +1,55 @@
+import {
+  APIEvent,
+  TransportItem,
+  TransportItemType,
+} from "@grafana/faro-web-sdk";
+import { _cleanStringPII } from "./redaction/pii-detection.js";
+import { Redactor } from "./redaction/redactors/index.js";
+
+function _cleanObjectPII<
+  T extends string | Record<string, unknown> | unknown[] | unknown,
+>(data: T, type: TransportItemType, redactors: Redactor[]): void {
+  if (!data) {
+    return;
+  }
+
+  if (Array.isArray(data)) {
+    data.forEach((item, index) => {
+      if (typeof item === "string") {
+        data[index] = _cleanStringPII(data[index], type, redactors);
+        return;
+      }
+
+      if (typeof item === "object") {
+        _cleanObjectPII<T>(item, type, redactors);
+      }
+    });
+  }
+
+  if (typeof data === "object") {
+    for (const key in data) {
+      if (typeof data[key] === "string") {
+        data[key] = _cleanStringPII(
+          data[key],
+          type,
+          redactors,
+        ) as (typeof data)[typeof key];
+      }
+
+      if (typeof data[key] === "object") {
+        _cleanObjectPII(data[key], type, redactors);
+      }
+    }
+  }
+}
+
+export const _beforeSend =
+  (redactors: Redactor[]) =>
+  (item: TransportItem<APIEvent>): TransportItem<APIEvent> | null => {
+    if (redactors.length === 0) {
+      return item;
+    }
+
+    _cleanObjectPII(item, item.type, redactors);
+    return item;
+  };

package/lib/internals/redaction/pii-detection.ts

@@ -0,0 +1,52 @@
+import { TransportItemType } from "@grafana/faro-web-sdk";
+import { Redactor } from "./redactors/index.js";
+
+/**
+ * Checks whether a string contains URI-encoded components.
+ *
+ * @param {string} value - The string to inspect.
+ * @returns {boolean} `true` if the string is encoded, `false` otherwise.
+ */
+function _containsEncodedComponents(value: string) {
+  try {
+    return decodeURI(value) !== decodeURIComponent(value);
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * Cleans a string by redacting configured PIIs and emitting metrics for redacted values.
+ *
+ * If the string is URL-encoded, it will be decoded before redaction.
+ * Metrics are emitted for:
+ * - each domain found in redacted email addresses.
+ * - IPv4|IPv6 addresses redacted.
+ *
+ * @template T
+ *
+ * @param {string} value - The input value to sanitize.
+ * @param {"trace" | "log"} source - The source context of the input, used in metrics.
+ * @param {Redactor[]} redactors - The string processors containing the redaction logic.
+ *
+ * @returns {T} The cleaned string with any configured PII replaced by `[REDACTED PII_TYPE]`.
+ */
+export function _cleanStringPII(
+  value: string,
+  source: TransportItemType,
+  redactors: Redactor[],
+): string {
+  let kind: "string" | "url" = "string";
+  let decodedValue = value;
+
+  if (_containsEncodedComponents(value)) {
+    decodedValue = decodeURIComponent(value);
+    kind = "url";
+  }
+
+  return redactors.reduce(
+    (redactedValue: string, currentRedactor): string =>
+      currentRedactor(redactedValue, source, kind),
+    decodedValue,
+  );
+}

package/lib/internals/redaction/redactors/email.ts

@@ -0,0 +1,68 @@
+import { faro } from "@grafana/faro-web-sdk";
+
+const EMAIL_REGEX = /[\p{L}\p{N}._%+-]+@((?:[\p{L}\p{N}-]+\.)+[\p{L}]{2,})/giu;
+
+/**
+ * Redacts all email addresses in the input string and collects metadata.
+ *
+ * @param {string} value The input string potentially containing email addresses.
+ * @returns {{
+ *   redacted: string,
+ *   count: number,
+ *   domains: Record<string, number>
+ * }}
+ *
+ * An object containing:
+ *   - `redacted`: the string with email addresses replaced by `[REDACTED EMAIL]`
+ *   - `count`: total number of email addresses redacted
+ *   - `domains`: a map of domain names to the number of times they were redacted
+ */
+function _redactEmails(value: string): {
+  redacted: string;
+  count: number;
+  domains: Record<string, number>;
+} {
+  let count = 0;
+  const domains: Record<string, number> = {};
+
+  const redacted = value.replace(EMAIL_REGEX, (_, domain) => {
+    count++;
+    domains[domain] = (domains[domain] || 0) + 1;
+    return "[REDACTED EMAIL]";
+  });
+
+  return { redacted, count, domains };
+}
+
+/**
+ * Redacts provided input and collects metadata metrics about redacted email domains,
+ * data source and kind.
+ *
+ * @param {string} value The input string potentially containing email addresses.
+ * @returns {string} the redacted value
+ */
+export const emailRedactor = (value: string, source: string, kind: string) => {
+  const { redacted, count, domains } = _redactEmails(value);
+
+  if (count > 0) {
+    for (const [domain, domainCount] of Object.entries(domains)) {
+      faro.api.pushMeasurement(
+        {
+          type: "faro_o11y_pii_redaction",
+          values: {
+            redacted: domainCount,
+          },
+        },
+        {
+          context: {
+            pii_type: "email",
+            redaction_source: source,
+            pii_email_domain: domain,
+            pii_format: kind,
+          },
+        },
+      );
+    }
+  }
+  return redacted;
+};

package/lib/internals/redaction/redactors/index.ts

@@ -0,0 +1,12 @@
+import { type FaroSDKConfig } from "../../../index.js";
+import { emailRedactor } from "./email.js";
+import { ipRedactor } from "./ip.js";
+
+export type Redactor = (value: string, source: string, kind: string) => string;
+
+export type RedactorKeys = keyof NonNullable<FaroSDKConfig["detection"]>;
+
+export const redactors: Record<RedactorKeys, Redactor> = {
+  email: emailRedactor,
+  ip: ipRedactor,
+};