langchain 1.0.4 → 1.0.5

package/dist/agents/middleware/pii.d.cts

@@ -0,0 +1,216 @@
+import { createMiddleware } from "../middleware.cjs";
+import { InferInteropZodInput } from "@langchain/core/utils/types";
+import { z } from "zod/v3";
+
+//#region src/agents/middleware/pii.d.ts
+
+/**
+ * Represents a detected PII match in content
+ */
+interface PIIMatch {
+  /**
+   * The matched text
+   */
+  text: string;
+  /**
+   * The start index of the match
+   */
+  start: number;
+  /**
+   * The end index of the match
+   */
+  end: number;
+}
+/**
+ * Error thrown when PII is detected and strategy is 'block'
+ */
+declare class PIIDetectionError extends Error {
+  readonly piiType: string;
+  readonly matches: PIIMatch[];
+  constructor(piiType: string, matches: PIIMatch[]);
+}
+/**
+ * Strategy for handling detected PII
+ */
+type PIIStrategy = "block" | "redact" | "mask" | "hash";
+/**
+ * Built-in PII types
+ */
+type BuiltInPIIType = "email" | "credit_card" | "ip" | "mac_address" | "url";
+/**
+ * Custom detector function that takes content and returns matches
+ */
+type PIIDetector = (content: string) => PIIMatch[];
+type Detector = PIIDetector | RegExp | string;
+/**
+ * Configuration for a redaction rule
+ */
+interface RedactionRuleConfig {
+  /**
+   * Type of PII to detect (built-in or custom name)
+   */
+  piiType: BuiltInPIIType | string;
+  /**
+   * Strategy for handling detected PII
+   */
+  strategy: PIIStrategy;
+  /**
+   * Custom detector function or regex pattern string
+   */
+  detector?: Detector;
+}
+/**
+ * Resolved redaction rule with a concrete detector function
+ */
+interface ResolvedRedactionRule {
+  piiType: string;
+  strategy: PIIStrategy;
+  detector: PIIDetector;
+}
+/**
+ * Detect email addresses in content
+ */
+declare function detectEmail(content: string): PIIMatch[];
+/**
+ * Detect credit card numbers in content (validated with Luhn algorithm)
+ */
+declare function detectCreditCard(content: string): PIIMatch[];
+/**
+ * Detect IP addresses in content (validated)
+ */
+declare function detectIP(content: string): PIIMatch[];
+/**
+ * Detect MAC addresses in content
+ */
+declare function detectMacAddress(content: string): PIIMatch[];
+/**
+ * Detect URLs in content
+ */
+declare function detectUrl(content: string): PIIMatch[];
+/**
+ * Resolve a redaction rule to a concrete detector function
+ */
+declare function resolveRedactionRule(config: RedactionRuleConfig): ResolvedRedactionRule;
+/**
+ * Apply strategy to content based on matches
+ */
+declare function applyStrategy(content: string, matches: PIIMatch[], strategy: PIIStrategy, piiType: string): string;
+/**
+ * Configuration schema for PII middleware
+ */
+declare const contextSchema: z.ZodObject<{
+  /**
+   * Whether to check user messages before model call
+   */
+  applyToInput: z.ZodOptional<z.ZodBoolean>;
+  /**
+   * Whether to check AI messages after model call
+   */
+  applyToOutput: z.ZodOptional<z.ZodBoolean>;
+  /**
+   * Whether to check tool result messages after tool execution
+   */
+  applyToToolResults: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+  applyToInput?: boolean | undefined;
+  applyToOutput?: boolean | undefined;
+  applyToToolResults?: boolean | undefined;
+}, {
+  applyToInput?: boolean | undefined;
+  applyToOutput?: boolean | undefined;
+  applyToToolResults?: boolean | undefined;
+}>;
+type PIIMiddlewareConfig = InferInteropZodInput<typeof contextSchema>;
+/**
+ * Creates a middleware that detects and handles personally identifiable information (PII)
+ * in conversations.
+ *
+ * This middleware detects common PII types and applies configurable strategies to handle them.
+ * It can detect emails, credit cards, IP addresses, MAC addresses, and URLs in both user input
+ * and agent output.
+ *
+ * Built-in PII types:
+ * - `email`: Email addresses
+ * - `credit_card`: Credit card numbers (validated with Luhn algorithm)
+ * - `ip`: IP addresses (validated)
+ * - `mac_address`: MAC addresses
+ * - `url`: URLs (both `http`/`https` and bare URLs)
+ *
+ * Strategies:
+ * - `block`: Raise an exception when PII is detected
+ * - `redact`: Replace PII with `[REDACTED_TYPE]` placeholders
+ * - `mask`: Partially mask PII (e.g., `****-****-****-1234` for credit card)
+ * - `hash`: Replace PII with deterministic hash (e.g., `<email_hash:a1b2c3d4>`)
+ *
+ * Strategy Selection Guide:
+ * | Strategy | Preserves Identity? | Best For                                |
+ * | -------- | ------------------- | --------------------------------------- |
+ * | `block`  | N/A                 | Avoid PII completely                    |
+ * | `redact` | No                  | General compliance, log sanitization    |
+ * | `mask`   | No                  | Human readability, customer service UIs |
+ * | `hash`   | Yes (pseudonymous)  | Analytics, debugging                    |
+ *
+ * @param piiType - Type of PII to detect. Can be a built-in type (`email`, `credit_card`, `ip`, `mac_address`, `url`) or a custom type name.
+ * @param options - Configuration options
+ * @param options.strategy - How to handle detected PII. Defaults to `"redact"`.
+ * @param options.detector - Custom detector function or regex pattern string. If not provided, uses built-in detector for the `piiType`.
+ * @param options.applyToInput - Whether to check user messages before model call. Defaults to `true`.
+ * @param options.applyToOutput - Whether to check AI messages after model call. Defaults to `false`.
+ * @param options.applyToToolResults - Whether to check tool result messages after tool execution. Defaults to `false`.
+ *
+ * @returns Middleware instance for use with `createAgent`
+ *
+ * @throws {PIIDetectionError} When PII is detected and strategy is `'block'`
+ * @throws {Error} If `piiType` is not built-in and no detector is provided
+ *
+ * @example Basic usage
+ * ```typescript
+ * import { piiMiddleware } from "langchain";
+ * import { createAgent } from "langchain";
+ *
+ * // Redact all emails in user input
+ * const agent = createAgent({
+ *   model: "openai:gpt-4",
+ *   middleware: [
+ *     piiMiddleware("email", { strategy: "redact" }),
+ *   ],
+ * });
+ * ```
+ *
+ * @example Different strategies for different PII types
+ * ```typescript
+ * const agent = createAgent({
+ *   model: "openai:gpt-4o",
+ *   middleware: [
+ *     piiMiddleware("credit_card", { strategy: "mask" }),
+ *     piiMiddleware("url", { strategy: "redact" }),
+ *     piiMiddleware("ip", { strategy: "hash" }),
+ *   ],
+ * });
+ * ```
+ *
+ * @example Custom PII type with regex
+ * ```typescript
+ * const agent = createAgent({
+ *   model: "openai:gpt-4",
+ *   middleware: [
+ *     piiMiddleware("api_key", {
+ *       detector: "sk-[a-zA-Z0-9]{32}",
+ *       strategy: "block",
+ *     }),
+ *   ],
+ * });
+ * ```
+ *
+ * @public
+ */
+declare function piiMiddleware(piiType: BuiltInPIIType | string, options?: {
+  strategy?: PIIStrategy;
+  detector?: Detector;
+  applyToInput?: boolean;
+  applyToOutput?: boolean;
+  applyToToolResults?: boolean;
+}): ReturnType<typeof createMiddleware>;
+//#endregion
+export { BuiltInPIIType, PIIDetectionError, PIIDetector, PIIMatch, PIIMiddlewareConfig, PIIStrategy, RedactionRuleConfig, ResolvedRedactionRule, applyStrategy, detectCreditCard, detectEmail, detectIP, detectMacAddress, detectUrl, piiMiddleware, resolveRedactionRule };
+//# sourceMappingURL=pii.d.cts.map

package/dist/agents/middleware/pii.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pii.d.cts","names":["z","InferInteropZodInput","createMiddleware","PIIMatch","PIIDetectionError","Error","PIIStrategy","BuiltInPIIType","PIIDetector","Detector","RegExp","RedactionRuleConfig","ResolvedRedactionRule","detectEmail","detectCreditCard","detectIP","detectMacAddress","detectUrl","resolveRedactionRule","applyStrategy","contextSchema","ZodBoolean","ZodOptional","ZodTypeAny","ZodObject","PIIMiddlewareConfig","piiMiddleware","ReturnType"],"sources":["../../../src/agents/middleware/pii.d.ts"],"sourcesContent":["import { z } from \"zod/v3\";\nimport type { InferInteropZodInput } from \"@langchain/core/utils/types\";\nimport { createMiddleware } from \"../middleware.js\";\n/**\n * Represents a detected PII match in content\n */\nexport interface PIIMatch {\n    /**\n     * The matched text\n     */\n    text: string;\n    /**\n     * The start index of the match\n     */\n    start: number;\n    /**\n     * The end index of the match\n     */\n    end: number;\n}\n/**\n * Error thrown when PII is detected and strategy is 'block'\n */\nexport declare class PIIDetectionError extends Error {\n    readonly piiType: string;\n    readonly matches: PIIMatch[];\n    constructor(piiType: string, matches: PIIMatch[]);\n}\n/**\n * Strategy for handling detected PII\n */\nexport type PIIStrategy = \"block\" | \"redact\" | \"mask\" | \"hash\";\n/**\n * Built-in PII types\n */\nexport type BuiltInPIIType = \"email\" | \"credit_card\" | \"ip\" | \"mac_address\" | \"url\";\n/**\n * Custom detector function that takes content and returns matches\n */\nexport type PIIDetector = (content: string) => PIIMatch[];\nexport type Detector = PIIDetector | RegExp | string;\n/**\n * Configuration for a redaction rule\n */\nexport interface RedactionRuleConfig {\n    /**\n     * Type of PII to detect (built-in or custom name)\n     */\n    piiType: BuiltInPIIType | string;\n    /**\n     * Strategy for handling detected PII\n     */\n    strategy: PIIStrategy;\n    /**\n     * Custom detector function or regex pattern string\n     */\n    detector?: Detector;\n}\n/**\n * Resolved redaction rule with a concrete detector function\n */\nexport interface ResolvedRedactionRule {\n    piiType: string;\n    strategy: PIIStrategy;\n    detector: PIIDetector;\n}\n/**\n * Detect email addresses in content\n */\nexport declare function detectEmail(content: string): PIIMatch[];\n/**\n * Detect credit card numbers in content (validated with Luhn algorithm)\n */\nexport declare function detectCreditCard(content: string): PIIMatch[];\n/**\n * Detect IP addresses in content (validated)\n */\nexport declare function detectIP(content: string): PIIMatch[];\n/**\n * Detect MAC addresses in content\n */\nexport declare function detectMacAddress(content: string): PIIMatch[];\n/**\n * Detect URLs in content\n */\nexport declare function detectUrl(content: string): PIIMatch[];\n/**\n * Resolve a redaction rule to a concrete detector function\n */\nexport declare function resolveRedactionRule(config: RedactionRuleConfig): ResolvedRedactionRule;\n/**\n * Apply strategy to content based on matches\n */\nexport declare function applyStrategy(content: string, matches: PIIMatch[], strategy: PIIStrategy, piiType: string): string;\n/**\n * Configuration schema for PII middleware\n */\ndeclare const contextSchema: z.ZodObject<{\n    /**\n     * Whether to check user messages before model call\n     */\n    applyToInput: z.ZodOptional<z.ZodBoolean>;\n    /**\n     * Whether to check AI messages after model call\n     */\n    applyToOutput: z.ZodOptional<z.ZodBoolean>;\n    /**\n     * Whether to check tool result messages after tool execution\n     */\n    applyToToolResults: z.ZodOptional<z.ZodBoolean>;\n}, \"strip\", z.ZodTypeAny, {\n    applyToInput?: boolean | undefined;\n    applyToOutput?: boolean | undefined;\n    applyToToolResults?: boolean | undefined;\n}, {\n    applyToInput?: boolean | undefined;\n    applyToOutput?: boolean | undefined;\n    applyToToolResults?: boolean | undefined;\n}>;\nexport type PIIMiddlewareConfig = InferInteropZodInput<typeof contextSchema>;\n/**\n * Creates a middleware that detects and handles personally identifiable information (PII)\n * in conversations.\n *\n * This middleware detects common PII types and applies configurable strategies to handle them.\n * It can detect emails, credit cards, IP addresses, MAC addresses, and URLs in both user input\n * and agent output.\n *\n * Built-in PII types:\n * - `email`: Email addresses\n * - `credit_card`: Credit card numbers (validated with Luhn algorithm)\n * - `ip`: IP addresses (validated)\n * - `mac_address`: MAC addresses\n * - `url`: URLs (both `http`/`https` and bare URLs)\n *\n * Strategies:\n * - `block`: Raise an exception when PII is detected\n * - `redact`: Replace PII with `[REDACTED_TYPE]` placeholders\n * - `mask`: Partially mask PII (e.g., `****-****-****-1234` for credit card)\n * - `hash`: Replace PII with deterministic hash (e.g., `<email_hash:a1b2c3d4>`)\n *\n * Strategy Selection Guide:\n * | Strategy | Preserves Identity? | Best For                                |\n * | -------- | ------------------- | --------------------------------------- |\n * | `block`  | N/A                 | Avoid PII completely                    |\n * | `redact` | No                  | General compliance, log sanitization    |\n * | `mask`   | No                  | Human readability, customer service UIs |\n * | `hash`   | Yes (pseudonymous)  | Analytics, debugging                    |\n *\n * @param piiType - Type of PII to detect. Can be a built-in type (`email`, `credit_card`, `ip`, `mac_address`, `url`) or a custom type name.\n * @param options - Configuration options\n * @param options.strategy - How to handle detected PII. Defaults to `\"redact\"`.\n * @param options.detector - Custom detector function or regex pattern string. If not provided, uses built-in detector for the `piiType`.\n * @param options.applyToInput - Whether to check user messages before model call. Defaults to `true`.\n * @param options.applyToOutput - Whether to check AI messages after model call. Defaults to `false`.\n * @param options.applyToToolResults - Whether to check tool result messages after tool execution. Defaults to `false`.\n *\n * @returns Middleware instance for use with `createAgent`\n *\n * @throws {PIIDetectionError} When PII is detected and strategy is `'block'`\n * @throws {Error} If `piiType` is not built-in and no detector is provided\n *\n * @example Basic usage\n * ```typescript\n * import { piiMiddleware } from \"langchain\";\n * import { createAgent } from \"langchain\";\n *\n * // Redact all emails in user input\n * const agent = createAgent({\n *   model: \"openai:gpt-4\",\n *   middleware: [\n *     piiMiddleware(\"email\", { strategy: \"redact\" }),\n *   ],\n * });\n * ```\n *\n * @example Different strategies for different PII types\n * ```typescript\n * const agent = createAgent({\n *   model: \"openai:gpt-4o\",\n *   middleware: [\n *     piiMiddleware(\"credit_card\", { strategy: \"mask\" }),\n *     piiMiddleware(\"url\", { strategy: \"redact\" }),\n *     piiMiddleware(\"ip\", { strategy: \"hash\" }),\n *   ],\n * });\n * ```\n *\n * @example Custom PII type with regex\n * ```typescript\n * const agent = createAgent({\n *   model: \"openai:gpt-4\",\n *   middleware: [\n *     piiMiddleware(\"api_key\", {\n *       detector: \"sk-[a-zA-Z0-9]{32}\",\n *       strategy: \"block\",\n *     }),\n *   ],\n * });\n * ```\n *\n * @public\n */\nexport declare function piiMiddleware(piiType: BuiltInPIIType | string, options?: {\n    strategy?: PIIStrategy;\n    detector?: Detector;\n    applyToInput?: boolean;\n    applyToOutput?: boolean;\n    applyToToolResults?: boolean;\n}): ReturnType<typeof createMiddleware>;\nexport {};\n"],"mappings":";;;;;;;;AAMA;AAiBqBI,UAjBJD,QAAAA,CAiBqB;EAAA;;;EAGY,IAHHE,EAAAA,MAAAA;EAAK;AAQpD;AAIA;EAIYG,KAAAA,EAAAA,MAAAA;EACAC;;;EAAsB,GAAGC,EAAAA,MAAAA;AAAM;AAI3C;;;AAQcJ,cA7BOF,iBAAAA,SAA0BC,KAAAA,CA6BjCC;EAAW,SAIVG,OAAAA,EAAAA,MAAAA;EAAQ,SAAA,OAAA,EA/BDN,QA+BC,EAAA;EAKNS,WAAAA,CAAAA,OAAAA,EAAAA,MAAqB,EAAA,OAAA,EAnCIT,QAmCJ,EAAA;;;;AAGb;AAKDU,KAtCZP,WAAAA,GAsCuB,OAAmBH,GAAAA,QAAQ,GAAA,MAAA,GAAA,MAAA;AAI9D;AAIA;AAIA;AAIwBc,KAlDZV,cAAAA,GAkDwCJ,OAAQ,GAAA,aAAA,GAAA,IAAA,GAAA,aAAA,GAAA,KAAA;AAI5D;;;AAA2ES,KAlD/DJ,WAAAA,GAkD+DI,CAAAA,OAAAA,EAAAA,MAAAA,EAAAA,GAlD5BT,QAkD4BS,EAAAA;AAAqB,KAjDpFH,QAAAA,GAAWD,WAiDyE,GAjD3DE,MAiD2D,GAAA,MAAA;AAIhG;;;AAAsFJ,UAjDrEK,mBAAAA,CAiDqEL;EAAW;AAA2B;;EAyB1H,OAjBgCe,EArDrBd,cAqDqBc,GAAAA,MAAAA;EAAU;;;EAIZ,QAIQA,EAzD1Bf,WAyD0Be;EAAU;;;EAZV,QAAA,CAAA,EAzCzBZ,QAyCyB;AAsBxC;;;;AAAsD,UA1DrCG,qBAAAA,CA0DqC;EAoF9Bc,OAAAA,EAAAA,MAAAA;EAAa,QAAA,EA5IvBpB,WA4IuB;EAAA,QAAUC,EA3IjCC,WA2IiCD;;;;;AAMjC,iBA5IUM,WAAAA,CA4IV,OAAA,EAAA,MAAA,CAAA,EA5IwCV,QA4IxC,EAAA;;;;iBAxIUW,gBAAAA,mBAAmCX;;;;iBAInCY,QAAAA,mBAA2BZ;;;;iBAI3Ba,gBAAAA,mBAAmCb;;;;iBAInCc,SAAAA,mBAA4Bd;;;;iBAI5Be,oBAAAA,SAA6BP,sBAAsBC;;;;iBAInDO,aAAAA,2BAAwChB,sBAAsBG;;;;cAIxEc,eAAepB,CAAAA,CAAEwB;;;;gBAIbxB,CAAAA,CAAEsB,YAAYtB,CAAAA,CAAEqB;;;;iBAIfrB,CAAAA,CAAEsB,YAAYtB,CAAAA,CAAEqB;;;;sBAIXrB,CAAAA,CAAEsB,YAAYtB,CAAAA,CAAEqB;YAC5BrB,CAAAA,CAAEuB;;;;;;;;;KASFE,mBAAAA,GAAsBxB,4BAA4BmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoFtCM,aAAAA,UAAuBnB;aAChCD;aACAG;;;;IAIXkB,kBAAkBzB"}

package/dist/agents/middleware/pii.d.ts

@@ -0,0 +1,216 @@
+import { createMiddleware } from "../middleware.js";
+import { z } from "zod/v3";
+import { InferInteropZodInput } from "@langchain/core/utils/types";
+
+//#region src/agents/middleware/pii.d.ts
+
+/**
+ * Represents a detected PII match in content
+ */
+interface PIIMatch {
+  /**
+   * The matched text
+   */
+  text: string;
+  /**
+   * The start index of the match
+   */
+  start: number;
+  /**
+   * The end index of the match
+   */
+  end: number;
+}
+/**
+ * Error thrown when PII is detected and strategy is 'block'
+ */
+declare class PIIDetectionError extends Error {
+  readonly piiType: string;
+  readonly matches: PIIMatch[];
+  constructor(piiType: string, matches: PIIMatch[]);
+}
+/**
+ * Strategy for handling detected PII
+ */
+type PIIStrategy = "block" | "redact" | "mask" | "hash";
+/**
+ * Built-in PII types
+ */
+type BuiltInPIIType = "email" | "credit_card" | "ip" | "mac_address" | "url";
+/**
+ * Custom detector function that takes content and returns matches
+ */
+type PIIDetector = (content: string) => PIIMatch[];
+type Detector = PIIDetector | RegExp | string;
+/**
+ * Configuration for a redaction rule
+ */
+interface RedactionRuleConfig {
+  /**
+   * Type of PII to detect (built-in or custom name)
+   */
+  piiType: BuiltInPIIType | string;
+  /**
+   * Strategy for handling detected PII
+   */
+  strategy: PIIStrategy;
+  /**
+   * Custom detector function or regex pattern string
+   */
+  detector?: Detector;
+}
+/**
+ * Resolved redaction rule with a concrete detector function
+ */
+interface ResolvedRedactionRule {
+  piiType: string;
+  strategy: PIIStrategy;
+  detector: PIIDetector;
+}
+/**
+ * Detect email addresses in content
+ */
+declare function detectEmail(content: string): PIIMatch[];
+/**
+ * Detect credit card numbers in content (validated with Luhn algorithm)
+ */
+declare function detectCreditCard(content: string): PIIMatch[];
+/**
+ * Detect IP addresses in content (validated)
+ */
+declare function detectIP(content: string): PIIMatch[];
+/**
+ * Detect MAC addresses in content
+ */
+declare function detectMacAddress(content: string): PIIMatch[];
+/**
+ * Detect URLs in content
+ */
+declare function detectUrl(content: string): PIIMatch[];
+/**
+ * Resolve a redaction rule to a concrete detector function
+ */
+declare function resolveRedactionRule(config: RedactionRuleConfig): ResolvedRedactionRule;
+/**
+ * Apply strategy to content based on matches
+ */
+declare function applyStrategy(content: string, matches: PIIMatch[], strategy: PIIStrategy, piiType: string): string;
+/**
+ * Configuration schema for PII middleware
+ */
+declare const contextSchema: z.ZodObject<{
+  /**
+   * Whether to check user messages before model call
+   */
+  applyToInput: z.ZodOptional<z.ZodBoolean>;
+  /**
+   * Whether to check AI messages after model call
+   */
+  applyToOutput: z.ZodOptional<z.ZodBoolean>;
+  /**
+   * Whether to check tool result messages after tool execution
+   */
+  applyToToolResults: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+  applyToInput?: boolean | undefined;
+  applyToOutput?: boolean | undefined;
+  applyToToolResults?: boolean | undefined;
+}, {
+  applyToInput?: boolean | undefined;
+  applyToOutput?: boolean | undefined;
+  applyToToolResults?: boolean | undefined;
+}>;
+type PIIMiddlewareConfig = InferInteropZodInput<typeof contextSchema>;
+/**
+ * Creates a middleware that detects and handles personally identifiable information (PII)
+ * in conversations.
+ *
+ * This middleware detects common PII types and applies configurable strategies to handle them.
+ * It can detect emails, credit cards, IP addresses, MAC addresses, and URLs in both user input
+ * and agent output.
+ *
+ * Built-in PII types:
+ * - `email`: Email addresses
+ * - `credit_card`: Credit card numbers (validated with Luhn algorithm)
+ * - `ip`: IP addresses (validated)
+ * - `mac_address`: MAC addresses
+ * - `url`: URLs (both `http`/`https` and bare URLs)
+ *
+ * Strategies:
+ * - `block`: Raise an exception when PII is detected
+ * - `redact`: Replace PII with `[REDACTED_TYPE]` placeholders
+ * - `mask`: Partially mask PII (e.g., `****-****-****-1234` for credit card)
+ * - `hash`: Replace PII with deterministic hash (e.g., `<email_hash:a1b2c3d4>`)
+ *
+ * Strategy Selection Guide:
+ * | Strategy | Preserves Identity? | Best For                                |
+ * | -------- | ------------------- | --------------------------------------- |
+ * | `block`  | N/A                 | Avoid PII completely                    |
+ * | `redact` | No                  | General compliance, log sanitization    |
+ * | `mask`   | No                  | Human readability, customer service UIs |
+ * | `hash`   | Yes (pseudonymous)  | Analytics, debugging                    |
+ *
+ * @param piiType - Type of PII to detect. Can be a built-in type (`email`, `credit_card`, `ip`, `mac_address`, `url`) or a custom type name.
+ * @param options - Configuration options
+ * @param options.strategy - How to handle detected PII. Defaults to `"redact"`.
+ * @param options.detector - Custom detector function or regex pattern string. If not provided, uses built-in detector for the `piiType`.
+ * @param options.applyToInput - Whether to check user messages before model call. Defaults to `true`.
+ * @param options.applyToOutput - Whether to check AI messages after model call. Defaults to `false`.
+ * @param options.applyToToolResults - Whether to check tool result messages after tool execution. Defaults to `false`.
+ *
+ * @returns Middleware instance for use with `createAgent`
+ *
+ * @throws {PIIDetectionError} When PII is detected and strategy is `'block'`
+ * @throws {Error} If `piiType` is not built-in and no detector is provided
+ *
+ * @example Basic usage
+ * ```typescript
+ * import { piiMiddleware } from "langchain";
+ * import { createAgent } from "langchain";
+ *
+ * // Redact all emails in user input
+ * const agent = createAgent({
+ *   model: "openai:gpt-4",
+ *   middleware: [
+ *     piiMiddleware("email", { strategy: "redact" }),
+ *   ],
+ * });
+ * ```
+ *
+ * @example Different strategies for different PII types
+ * ```typescript
+ * const agent = createAgent({
+ *   model: "openai:gpt-4o",
+ *   middleware: [
+ *     piiMiddleware("credit_card", { strategy: "mask" }),
+ *     piiMiddleware("url", { strategy: "redact" }),
+ *     piiMiddleware("ip", { strategy: "hash" }),
+ *   ],
+ * });
+ * ```
+ *
+ * @example Custom PII type with regex
+ * ```typescript
+ * const agent = createAgent({
+ *   model: "openai:gpt-4",
+ *   middleware: [
+ *     piiMiddleware("api_key", {
+ *       detector: "sk-[a-zA-Z0-9]{32}",
+ *       strategy: "block",
+ *     }),
+ *   ],
+ * });
+ * ```
+ *
+ * @public
+ */
+declare function piiMiddleware(piiType: BuiltInPIIType | string, options?: {
+  strategy?: PIIStrategy;
+  detector?: Detector;
+  applyToInput?: boolean;
+  applyToOutput?: boolean;
+  applyToToolResults?: boolean;
+}): ReturnType<typeof createMiddleware>;
+//#endregion
+export { BuiltInPIIType, PIIDetectionError, PIIDetector, PIIMatch, PIIMiddlewareConfig, PIIStrategy, RedactionRuleConfig, ResolvedRedactionRule, applyStrategy, detectCreditCard, detectEmail, detectIP, detectMacAddress, detectUrl, piiMiddleware, resolveRedactionRule };
+//# sourceMappingURL=pii.d.ts.map

package/dist/agents/middleware/pii.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pii.d.ts","names":["z","InferInteropZodInput","createMiddleware","PIIMatch","PIIDetectionError","Error","PIIStrategy","BuiltInPIIType","PIIDetector","Detector","RegExp","RedactionRuleConfig","ResolvedRedactionRule","detectEmail","detectCreditCard","detectIP","detectMacAddress","detectUrl","resolveRedactionRule","applyStrategy","contextSchema","ZodBoolean","ZodOptional","ZodTypeAny","ZodObject","PIIMiddlewareConfig","piiMiddleware","ReturnType"],"sources":["../../../src/agents/middleware/pii.d.ts"],"sourcesContent":["import { z } from \"zod/v3\";\nimport type { InferInteropZodInput } from \"@langchain/core/utils/types\";\nimport { createMiddleware } from \"../middleware.js\";\n/**\n * Represents a detected PII match in content\n */\nexport interface PIIMatch {\n    /**\n     * The matched text\n     */\n    text: string;\n    /**\n     * The start index of the match\n     */\n    start: number;\n    /**\n     * The end index of the match\n     */\n    end: number;\n}\n/**\n * Error thrown when PII is detected and strategy is 'block'\n */\nexport declare class PIIDetectionError extends Error {\n    readonly piiType: string;\n    readonly matches: PIIMatch[];\n    constructor(piiType: string, matches: PIIMatch[]);\n}\n/**\n * Strategy for handling detected PII\n */\nexport type PIIStrategy = \"block\" | \"redact\" | \"mask\" | \"hash\";\n/**\n * Built-in PII types\n */\nexport type BuiltInPIIType = \"email\" | \"credit_card\" | \"ip\" | \"mac_address\" | \"url\";\n/**\n * Custom detector function that takes content and returns matches\n */\nexport type PIIDetector = (content: string) => PIIMatch[];\nexport type Detector = PIIDetector | RegExp | string;\n/**\n * Configuration for a redaction rule\n */\nexport interface RedactionRuleConfig {\n    /**\n     * Type of PII to detect (built-in or custom name)\n     */\n    piiType: BuiltInPIIType | string;\n    /**\n     * Strategy for handling detected PII\n     */\n    strategy: PIIStrategy;\n    /**\n     * Custom detector function or regex pattern string\n     */\n    detector?: Detector;\n}\n/**\n * Resolved redaction rule with a concrete detector function\n */\nexport interface ResolvedRedactionRule {\n    piiType: string;\n    strategy: PIIStrategy;\n    detector: PIIDetector;\n}\n/**\n * Detect email addresses in content\n */\nexport declare function detectEmail(content: string): PIIMatch[];\n/**\n * Detect credit card numbers in content (validated with Luhn algorithm)\n */\nexport declare function detectCreditCard(content: string): PIIMatch[];\n/**\n * Detect IP addresses in content (validated)\n */\nexport declare function detectIP(content: string): PIIMatch[];\n/**\n * Detect MAC addresses in content\n */\nexport declare function detectMacAddress(content: string): PIIMatch[];\n/**\n * Detect URLs in content\n */\nexport declare function detectUrl(content: string): PIIMatch[];\n/**\n * Resolve a redaction rule to a concrete detector function\n */\nexport declare function resolveRedactionRule(config: RedactionRuleConfig): ResolvedRedactionRule;\n/**\n * Apply strategy to content based on matches\n */\nexport declare function applyStrategy(content: string, matches: PIIMatch[], strategy: PIIStrategy, piiType: string): string;\n/**\n * Configuration schema for PII middleware\n */\ndeclare const contextSchema: z.ZodObject<{\n    /**\n     * Whether to check user messages before model call\n     */\n    applyToInput: z.ZodOptional<z.ZodBoolean>;\n    /**\n     * Whether to check AI messages after model call\n     */\n    applyToOutput: z.ZodOptional<z.ZodBoolean>;\n    /**\n     * Whether to check tool result messages after tool execution\n     */\n    applyToToolResults: z.ZodOptional<z.ZodBoolean>;\n}, \"strip\", z.ZodTypeAny, {\n    applyToInput?: boolean | undefined;\n    applyToOutput?: boolean | undefined;\n    applyToToolResults?: boolean | undefined;\n}, {\n    applyToInput?: boolean | undefined;\n    applyToOutput?: boolean | undefined;\n    applyToToolResults?: boolean | undefined;\n}>;\nexport type PIIMiddlewareConfig = InferInteropZodInput<typeof contextSchema>;\n/**\n * Creates a middleware that detects and handles personally identifiable information (PII)\n * in conversations.\n *\n * This middleware detects common PII types and applies configurable strategies to handle them.\n * It can detect emails, credit cards, IP addresses, MAC addresses, and URLs in both user input\n * and agent output.\n *\n * Built-in PII types:\n * - `email`: Email addresses\n * - `credit_card`: Credit card numbers (validated with Luhn algorithm)\n * - `ip`: IP addresses (validated)\n * - `mac_address`: MAC addresses\n * - `url`: URLs (both `http`/`https` and bare URLs)\n *\n * Strategies:\n * - `block`: Raise an exception when PII is detected\n * - `redact`: Replace PII with `[REDACTED_TYPE]` placeholders\n * - `mask`: Partially mask PII (e.g., `****-****-****-1234` for credit card)\n * - `hash`: Replace PII with deterministic hash (e.g., `<email_hash:a1b2c3d4>`)\n *\n * Strategy Selection Guide:\n * | Strategy | Preserves Identity? | Best For                                |\n * | -------- | ------------------- | --------------------------------------- |\n * | `block`  | N/A                 | Avoid PII completely                    |\n * | `redact` | No                  | General compliance, log sanitization    |\n * | `mask`   | No                  | Human readability, customer service UIs |\n * | `hash`   | Yes (pseudonymous)  | Analytics, debugging                    |\n *\n * @param piiType - Type of PII to detect. Can be a built-in type (`email`, `credit_card`, `ip`, `mac_address`, `url`) or a custom type name.\n * @param options - Configuration options\n * @param options.strategy - How to handle detected PII. Defaults to `\"redact\"`.\n * @param options.detector - Custom detector function or regex pattern string. If not provided, uses built-in detector for the `piiType`.\n * @param options.applyToInput - Whether to check user messages before model call. Defaults to `true`.\n * @param options.applyToOutput - Whether to check AI messages after model call. Defaults to `false`.\n * @param options.applyToToolResults - Whether to check tool result messages after tool execution. Defaults to `false`.\n *\n * @returns Middleware instance for use with `createAgent`\n *\n * @throws {PIIDetectionError} When PII is detected and strategy is `'block'`\n * @throws {Error} If `piiType` is not built-in and no detector is provided\n *\n * @example Basic usage\n * ```typescript\n * import { piiMiddleware } from \"langchain\";\n * import { createAgent } from \"langchain\";\n *\n * // Redact all emails in user input\n * const agent = createAgent({\n *   model: \"openai:gpt-4\",\n *   middleware: [\n *     piiMiddleware(\"email\", { strategy: \"redact\" }),\n *   ],\n * });\n * ```\n *\n * @example Different strategies for different PII types\n * ```typescript\n * const agent = createAgent({\n *   model: \"openai:gpt-4o\",\n *   middleware: [\n *     piiMiddleware(\"credit_card\", { strategy: \"mask\" }),\n *     piiMiddleware(\"url\", { strategy: \"redact\" }),\n *     piiMiddleware(\"ip\", { strategy: \"hash\" }),\n *   ],\n * });\n * ```\n *\n * @example Custom PII type with regex\n * ```typescript\n * const agent = createAgent({\n *   model: \"openai:gpt-4\",\n *   middleware: [\n *     piiMiddleware(\"api_key\", {\n *       detector: \"sk-[a-zA-Z0-9]{32}\",\n *       strategy: \"block\",\n *     }),\n *   ],\n * });\n * ```\n *\n * @public\n */\nexport declare function piiMiddleware(piiType: BuiltInPIIType | string, options?: {\n    strategy?: PIIStrategy;\n    detector?: Detector;\n    applyToInput?: boolean;\n    applyToOutput?: boolean;\n    applyToToolResults?: boolean;\n}): ReturnType<typeof createMiddleware>;\nexport {};\n"],"mappings":";;;;;;;;AAMA;AAiBqBI,UAjBJD,QAAAA,CAiBqB;EAAA;;;EAGY,IAHHE,EAAAA,MAAAA;EAAK;AAQpD;AAIA;EAIYG,KAAAA,EAAAA,MAAAA;EACAC;;;EAAsB,GAAGC,EAAAA,MAAAA;AAAM;AAI3C;;;AAQcJ,cA7BOF,iBAAAA,SAA0BC,KAAAA,CA6BjCC;EAAW,SAIVG,OAAAA,EAAAA,MAAAA;EAAQ,SAAA,OAAA,EA/BDN,QA+BC,EAAA;EAKNS,WAAAA,CAAAA,OAAAA,EAAAA,MAAqB,EAAA,OAAA,EAnCIT,QAmCJ,EAAA;;;;AAGb;AAKDU,KAtCZP,WAAAA,GAsCuB,OAAmBH,GAAAA,QAAQ,GAAA,MAAA,GAAA,MAAA;AAI9D;AAIA;AAIA;AAIwBc,KAlDZV,cAAAA,GAkDwCJ,OAAQ,GAAA,aAAA,GAAA,IAAA,GAAA,aAAA,GAAA,KAAA;AAI5D;;;AAA2ES,KAlD/DJ,WAAAA,GAkD+DI,CAAAA,OAAAA,EAAAA,MAAAA,EAAAA,GAlD5BT,QAkD4BS,EAAAA;AAAqB,KAjDpFH,QAAAA,GAAWD,WAiDyE,GAjD3DE,MAiD2D,GAAA,MAAA;AAIhG;;;AAAsFJ,UAjDrEK,mBAAAA,CAiDqEL;EAAW;AAA2B;;EAyB1H,OAjBgCe,EArDrBd,cAqDqBc,GAAAA,MAAAA;EAAU;;;EAIZ,QAIQA,EAzD1Bf,WAyD0Be;EAAU;;;EAZV,QAAA,CAAA,EAzCzBZ,QAyCyB;AAsBxC;;;;AAAsD,UA1DrCG,qBAAAA,CA0DqC;EAoF9Bc,OAAAA,EAAAA,MAAAA;EAAa,QAAA,EA5IvBpB,WA4IuB;EAAA,QAAUC,EA3IjCC,WA2IiCD;;;;;AAMjC,iBA5IUM,WAAAA,CA4IV,OAAA,EAAA,MAAA,CAAA,EA5IwCV,QA4IxC,EAAA;;;;iBAxIUW,gBAAAA,mBAAmCX;;;;iBAInCY,QAAAA,mBAA2BZ;;;;iBAI3Ba,gBAAAA,mBAAmCb;;;;iBAInCc,SAAAA,mBAA4Bd;;;;iBAI5Be,oBAAAA,SAA6BP,sBAAsBC;;;;iBAInDO,aAAAA,2BAAwChB,sBAAsBG;;;;cAIxEc,eAAepB,CAAAA,CAAEwB;;;;gBAIbxB,CAAAA,CAAEsB,YAAYtB,CAAAA,CAAEqB;;;;iBAIfrB,CAAAA,CAAEsB,YAAYtB,CAAAA,CAAEqB;;;;sBAIXrB,CAAAA,CAAEsB,YAAYtB,CAAAA,CAAEqB;YAC5BrB,CAAAA,CAAEuB;;;;;;;;;KASFE,mBAAAA,GAAsBxB,4BAA4BmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoFtCM,aAAAA,UAAuBnB;aAChCD;aACAG;;;;IAIXkB,kBAAkBzB"}