anonyma 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +457 -0
- package/LICENSE +21 -0
- package/README.md +605 -0
- package/dist/crypto.cjs +142 -0
- package/dist/crypto.cjs.map +1 -0
- package/dist/crypto.d.cts +51 -0
- package/dist/crypto.d.ts +51 -0
- package/dist/crypto.js +139 -0
- package/dist/crypto.js.map +1 -0
- package/dist/detectors/index.cjs +1487 -0
- package/dist/detectors/index.cjs.map +1 -0
- package/dist/detectors/index.d.cts +754 -0
- package/dist/detectors/index.d.ts +754 -0
- package/dist/detectors/index.js +1451 -0
- package/dist/detectors/index.js.map +1 -0
- package/dist/index.cjs +2877 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +772 -0
- package/dist/index.d.ts +772 -0
- package/dist/index.js +2850 -0
- package/dist/index.js.map +1 -0
- package/dist/schemas.cjs +361 -0
- package/dist/schemas.cjs.map +1 -0
- package/dist/schemas.d.cts +1031 -0
- package/dist/schemas.d.ts +1031 -0
- package/dist/schemas.js +341 -0
- package/dist/schemas.js.map +1 -0
- package/dist/stream.cjs +2315 -0
- package/dist/stream.cjs.map +1 -0
- package/dist/stream.d.cts +76 -0
- package/dist/stream.d.ts +76 -0
- package/dist/stream.js +2311 -0
- package/dist/stream.js.map +1 -0
- package/dist/types-D-9HzVuy.d.cts +553 -0
- package/dist/types-D-9HzVuy.d.ts +553 -0
- package/dist/validators.cjs +186 -0
- package/dist/validators.cjs.map +1 -0
- package/dist/validators.d.cts +136 -0
- package/dist/validators.d.ts +136 -0
- package/dist/validators.js +176 -0
- package/dist/validators.js.map +1 -0
- package/package.json +158 -0
package/dist/schemas.cjs
ADDED
|
@@ -0,0 +1,361 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var zod = require('zod');
|
|
4
|
+
|
|
5
|
+
// src/schemas.ts
|
|
6
|
+
var PiiCategorySchema = zod.z.enum([
|
|
7
|
+
"email",
|
|
8
|
+
"phone",
|
|
9
|
+
"ssn",
|
|
10
|
+
"credit-card",
|
|
11
|
+
"ipv4",
|
|
12
|
+
"ipv6",
|
|
13
|
+
"url",
|
|
14
|
+
"iban",
|
|
15
|
+
"date-of-birth",
|
|
16
|
+
"name",
|
|
17
|
+
"address",
|
|
18
|
+
"passport",
|
|
19
|
+
"drivers-license",
|
|
20
|
+
"national-id",
|
|
21
|
+
"bank-account",
|
|
22
|
+
"cryptocurrency",
|
|
23
|
+
"tax-id",
|
|
24
|
+
"medical-record",
|
|
25
|
+
"health-insurance",
|
|
26
|
+
"prescription",
|
|
27
|
+
"api-key",
|
|
28
|
+
"social-media",
|
|
29
|
+
"vin",
|
|
30
|
+
"license-plate",
|
|
31
|
+
"tracking-number",
|
|
32
|
+
"case-number",
|
|
33
|
+
"company-registration"
|
|
34
|
+
]);
|
|
35
|
+
var MaskOptionsSchema = zod.z.object({
|
|
36
|
+
strategy: zod.z.literal("mask"),
|
|
37
|
+
maskChar: zod.z.string().length(1, "maskChar must be exactly one character").default("*").optional(),
|
|
38
|
+
keepLeading: zod.z.number().int().nonnegative().default(0).optional(),
|
|
39
|
+
keepTrailing: zod.z.number().int().nonnegative().default(0).optional()
|
|
40
|
+
});
|
|
41
|
+
var RedactOptionsSchema = zod.z.object({
|
|
42
|
+
strategy: zod.z.literal("redact"),
|
|
43
|
+
label: zod.z.string().min(1, "label must not be empty").default("[REDACTED]").optional()
|
|
44
|
+
});
|
|
45
|
+
var PseudonymizeOptionsSchema = zod.z.object({
|
|
46
|
+
strategy: zod.z.literal("pseudonymize"),
|
|
47
|
+
seed: zod.z.string().optional(),
|
|
48
|
+
prefix: zod.z.string().regex(/^\S+$/, "prefix must not contain whitespace").default("id_").optional()
|
|
49
|
+
});
|
|
50
|
+
var HashOptionsSchema = zod.z.object({
|
|
51
|
+
strategy: zod.z.literal("hash"),
|
|
52
|
+
truncate: zod.z.number().int().min(1).max(64).default(16).optional(),
|
|
53
|
+
pepper: zod.z.string().optional()
|
|
54
|
+
});
|
|
55
|
+
var GeneralizeOptionsSchema = zod.z.object({
|
|
56
|
+
strategy: zod.z.literal("generalize"),
|
|
57
|
+
bucketSize: zod.z.number().int().positive().default(10).optional()
|
|
58
|
+
});
|
|
59
|
+
var StrategyOptionsSchema = zod.z.discriminatedUnion("strategy", [
|
|
60
|
+
MaskOptionsSchema,
|
|
61
|
+
RedactOptionsSchema,
|
|
62
|
+
PseudonymizeOptionsSchema,
|
|
63
|
+
HashOptionsSchema,
|
|
64
|
+
GeneralizeOptionsSchema
|
|
65
|
+
]);
|
|
66
|
+
var PiiMatchSchema = zod.z.object({
|
|
67
|
+
category: PiiCategorySchema,
|
|
68
|
+
value: zod.z.string(),
|
|
69
|
+
start: zod.z.number().int().nonnegative(),
|
|
70
|
+
end: zod.z.number().int().positive(),
|
|
71
|
+
confidence: zod.z.number().min(0).max(1)
|
|
72
|
+
});
|
|
73
|
+
var AnonymizeResultSchema = zod.z.object({
|
|
74
|
+
text: zod.z.string(),
|
|
75
|
+
matches: zod.z.array(PiiMatchSchema)
|
|
76
|
+
});
|
|
77
|
+
var AnonymizationRuleSchema = zod.z.object({
|
|
78
|
+
category: PiiCategorySchema,
|
|
79
|
+
strategy: StrategyOptionsSchema
|
|
80
|
+
});
|
|
81
|
+
var CustomPatternSchema = zod.z.object({
|
|
82
|
+
pattern: zod.z.instanceof(RegExp, { message: "pattern must be a RegExp instance" }),
|
|
83
|
+
category: zod.z.string().min(1).optional(),
|
|
84
|
+
confidence: zod.z.number().min(0).max(1).optional(),
|
|
85
|
+
label: zod.z.string().min(1, "label must not be empty").optional()
|
|
86
|
+
});
|
|
87
|
+
var AnonymizeOptionsSchema = zod.z.object({
|
|
88
|
+
rules: zod.z.array(AnonymizationRuleSchema).optional(),
|
|
89
|
+
defaultStrategy: StrategyOptionsSchema.optional(),
|
|
90
|
+
includeMatches: zod.z.boolean().default(false).optional(),
|
|
91
|
+
customPatterns: zod.z.array(CustomPatternSchema).optional(),
|
|
92
|
+
globalReplacement: zod.z.string().min(1, "globalReplacement must not be empty").optional(),
|
|
93
|
+
consistentTokens: zod.z.boolean().default(false).optional(),
|
|
94
|
+
aggressive: zod.z.boolean().default(false).optional(),
|
|
95
|
+
enabledCategories: zod.z.record(PiiCategorySchema, zod.z.boolean()).optional()
|
|
96
|
+
});
|
|
97
|
+
var FieldRuleSchema = zod.z.object({
|
|
98
|
+
strategy: StrategyOptionsSchema
|
|
99
|
+
});
|
|
100
|
+
var FieldRuleMapSchema = zod.z.record(zod.z.string(), FieldRuleSchema);
|
|
101
|
+
var ANONYMIZE_TOOL_DEFINITION = {
|
|
102
|
+
name: "anonymize",
|
|
103
|
+
description: "Detect and anonymize PII (personally identifiable information) in a text string. Returns the anonymized text and, optionally, a list of detected PII matches.",
|
|
104
|
+
parameters: {
|
|
105
|
+
type: "object",
|
|
106
|
+
properties: {
|
|
107
|
+
text: {
|
|
108
|
+
type: "string",
|
|
109
|
+
description: "The input text to anonymize."
|
|
110
|
+
},
|
|
111
|
+
defaultStrategy: {
|
|
112
|
+
type: "object",
|
|
113
|
+
description: "The anonymization strategy to apply to all detected PII. Defaults to `{ strategy: 'redact' }`.",
|
|
114
|
+
properties: {
|
|
115
|
+
strategy: {
|
|
116
|
+
type: "string",
|
|
117
|
+
enum: ["mask", "redact", "pseudonymize", "hash", "generalize"]
|
|
118
|
+
}
|
|
119
|
+
},
|
|
120
|
+
required: ["strategy"]
|
|
121
|
+
},
|
|
122
|
+
includeMatches: {
|
|
123
|
+
type: "boolean",
|
|
124
|
+
description: "When true, include detected PII matches in the response."
|
|
125
|
+
},
|
|
126
|
+
globalReplacement: {
|
|
127
|
+
type: "string",
|
|
128
|
+
description: "When set, every detected PII entity is replaced with this exact string, overriding per-category rules and defaultStrategy."
|
|
129
|
+
},
|
|
130
|
+
consistentTokens: {
|
|
131
|
+
type: "boolean",
|
|
132
|
+
description: "When true, identical PII values receive the same token (e.g. EMAIL_1) across the entire call. Different values get different tokens."
|
|
133
|
+
},
|
|
134
|
+
aggressive: {
|
|
135
|
+
type: "boolean",
|
|
136
|
+
description: "When true, detectors use expanded, more permissive patterns to catch obfuscated PII at the cost of higher false-positive rates."
|
|
137
|
+
}
|
|
138
|
+
},
|
|
139
|
+
required: ["text"]
|
|
140
|
+
}
|
|
141
|
+
};
|
|
142
|
+
var DETECT_TOOL_DEFINITION = {
|
|
143
|
+
name: "detect",
|
|
144
|
+
description: "Detect all PII (email, phone, SSN, credit card, IP, URL, IBAN, date-of-birth, name) in a text string without modifying it. Returns a list of matches.",
|
|
145
|
+
parameters: {
|
|
146
|
+
type: "object",
|
|
147
|
+
properties: {
|
|
148
|
+
text: {
|
|
149
|
+
type: "string",
|
|
150
|
+
description: "The input text to scan for PII."
|
|
151
|
+
},
|
|
152
|
+
categories: {
|
|
153
|
+
type: "array",
|
|
154
|
+
description: "Optional subset of PII categories to detect. Defaults to all supported categories.",
|
|
155
|
+
items: {
|
|
156
|
+
type: "string",
|
|
157
|
+
enum: [
|
|
158
|
+
"email",
|
|
159
|
+
"phone",
|
|
160
|
+
"ssn",
|
|
161
|
+
"credit-card",
|
|
162
|
+
"ipv4",
|
|
163
|
+
"ipv6",
|
|
164
|
+
"url",
|
|
165
|
+
"iban",
|
|
166
|
+
"date-of-birth",
|
|
167
|
+
"name"
|
|
168
|
+
]
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
},
|
|
172
|
+
required: ["text"]
|
|
173
|
+
}
|
|
174
|
+
};
|
|
175
|
+
var HAS_PII_TOOL_DEFINITION = {
|
|
176
|
+
name: "hasPII",
|
|
177
|
+
description: "Check whether a text string contains any detectable PII without redacting it. Returns true/false. Uses early-exit optimisation \u2014 stops scanning after the first match.",
|
|
178
|
+
parameters: {
|
|
179
|
+
type: "object",
|
|
180
|
+
properties: {
|
|
181
|
+
text: {
|
|
182
|
+
type: "string",
|
|
183
|
+
description: "The input text to check for PII."
|
|
184
|
+
},
|
|
185
|
+
categories: {
|
|
186
|
+
type: "array",
|
|
187
|
+
description: "Optional subset of PII categories to check. Defaults to all.",
|
|
188
|
+
items: {
|
|
189
|
+
type: "string",
|
|
190
|
+
enum: [
|
|
191
|
+
"email",
|
|
192
|
+
"phone",
|
|
193
|
+
"ssn",
|
|
194
|
+
"credit-card",
|
|
195
|
+
"ipv4",
|
|
196
|
+
"ipv6",
|
|
197
|
+
"url",
|
|
198
|
+
"iban",
|
|
199
|
+
"date-of-birth",
|
|
200
|
+
"name"
|
|
201
|
+
]
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
},
|
|
205
|
+
required: ["text"]
|
|
206
|
+
}
|
|
207
|
+
};
|
|
208
|
+
var ANONYMIZE_OBJECT_TOOL_DEFINITION = {
|
|
209
|
+
name: "anonymizeObject",
|
|
210
|
+
description: "Recursively anonymize all string values found in a JSON-serializable object tree. Returns a deep clone with PII replaced. Arrays, nested objects, and mixed structures are all handled. Non-string primitives pass through unchanged.",
|
|
211
|
+
parameters: {
|
|
212
|
+
type: "object",
|
|
213
|
+
properties: {
|
|
214
|
+
obj: {
|
|
215
|
+
type: "object",
|
|
216
|
+
description: "The JSON-serializable object to anonymize."
|
|
217
|
+
},
|
|
218
|
+
options: {
|
|
219
|
+
type: "object",
|
|
220
|
+
description: "Optional anonymization configuration (same as anonymize() options).",
|
|
221
|
+
properties: {
|
|
222
|
+
globalReplacement: {
|
|
223
|
+
type: "string",
|
|
224
|
+
description: "Replace all PII with this exact string."
|
|
225
|
+
},
|
|
226
|
+
consistentTokens: {
|
|
227
|
+
type: "boolean",
|
|
228
|
+
description: "Same PII value \u2192 same token across the entire object."
|
|
229
|
+
},
|
|
230
|
+
aggressive: {
|
|
231
|
+
type: "boolean",
|
|
232
|
+
description: "Enable more permissive detection patterns."
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
}
|
|
236
|
+
},
|
|
237
|
+
required: ["obj"]
|
|
238
|
+
}
|
|
239
|
+
};
|
|
240
|
+
var ANONYMA_MANIFEST = {
|
|
241
|
+
name: "anonyma",
|
|
242
|
+
version: "1.0.0",
|
|
243
|
+
description: "TypeScript-first PII detection & anonymization \u2014 26 built-in detectors (email, SSN, IBAN, passport, credit card, and more), 8 strategies (mask, redact, hash, AES-256 encrypt, tokenize, pseudonymize, generalize, synthesize), 6 compliance presets (GDPR, HIPAA, CCPA, PCI-DSS, SOX, FERPA), reversible tokenization, LLM/AI pipeline helpers, WHATWG streaming, batch processing, checksum validators, and optional Zod/MCP schemas. Zero runtime dependencies.",
|
|
244
|
+
capabilities: {
|
|
245
|
+
detect: {
|
|
246
|
+
description: "Detect PII in free text without modifying it.",
|
|
247
|
+
supportedCategories: [
|
|
248
|
+
"email",
|
|
249
|
+
"phone",
|
|
250
|
+
"ssn",
|
|
251
|
+
"credit-card",
|
|
252
|
+
"ipv4",
|
|
253
|
+
"ipv6",
|
|
254
|
+
"url",
|
|
255
|
+
"iban",
|
|
256
|
+
"date-of-birth",
|
|
257
|
+
"name",
|
|
258
|
+
"address",
|
|
259
|
+
"passport",
|
|
260
|
+
"drivers-license",
|
|
261
|
+
"national-id",
|
|
262
|
+
"bank-account",
|
|
263
|
+
"cryptocurrency",
|
|
264
|
+
"tax-id",
|
|
265
|
+
"medical-record",
|
|
266
|
+
"health-insurance",
|
|
267
|
+
"prescription",
|
|
268
|
+
"api-key",
|
|
269
|
+
"social-media",
|
|
270
|
+
"vin",
|
|
271
|
+
"license-plate",
|
|
272
|
+
"tracking-number",
|
|
273
|
+
"case-number",
|
|
274
|
+
"company-registration"
|
|
275
|
+
],
|
|
276
|
+
notes: {
|
|
277
|
+
name: "Name detection is heuristic \u2014 only catches names preceded by greeting keywords (e.g. 'Dear Alice'). Not an NLP-based named-entity recogniser."
|
|
278
|
+
},
|
|
279
|
+
returns: "Array of PiiMatch objects with category, value, position, and confidence."
|
|
280
|
+
},
|
|
281
|
+
hasPII: {
|
|
282
|
+
description: "Return true/false indicating whether a string contains detectable PII. Uses early-exit optimisation for performance.",
|
|
283
|
+
returns: "boolean"
|
|
284
|
+
},
|
|
285
|
+
anonymize: {
|
|
286
|
+
description: "Detect and replace PII in free text using a configurable strategy.",
|
|
287
|
+
strategies: {
|
|
288
|
+
mask: "Replace characters with a mask char, keeping optional leading/trailing chars.",
|
|
289
|
+
redact: "Replace the entire value with a label such as [REDACTED].",
|
|
290
|
+
pseudonymize: "Replace with a deterministic pseudonym (requires seed for reproducibility).",
|
|
291
|
+
hash: "Replace with a one-way SHA-256 hash (requires Node.js \u2265 18).",
|
|
292
|
+
generalize: "Replace a numeric value with a bucket range (e.g. 27 \u2192 20-29).",
|
|
293
|
+
tokenize: "Replace with a reversible opaque token ([CATEGORY_NNNN]) for LLM pipelines.",
|
|
294
|
+
encrypt: "Replace with AES-GCM ciphertext (requires Node.js \u2265 18 + passphrase/key).",
|
|
295
|
+
synthesize: "Replace with structurally-valid synthetic data (format-preserving)."
|
|
296
|
+
},
|
|
297
|
+
options: {
|
|
298
|
+
globalReplacement: "Override ALL strategy outputs with a single replacement string.",
|
|
299
|
+
consistentTokens: "Same PII value \u2192 same token (EMAIL_1, PHONE_2, etc.) within a call.",
|
|
300
|
+
aggressive: "Use expanded, more permissive regex patterns to catch obfuscated PII.",
|
|
301
|
+
enabledCategories: "Convenience boolean map for enabling/disabling categories.",
|
|
302
|
+
customPatterns: "Ad-hoc regex patterns merged into the detection pipeline.",
|
|
303
|
+
customDetectors: "Override built-in detectors on a per-category basis.",
|
|
304
|
+
preset: "Apply a compliance preset (gdpr | hipaa | ccpa | pci-dss | sox | ferpa).",
|
|
305
|
+
allowlist: "String values that should never be anonymized even when detected as PII.",
|
|
306
|
+
confidenceThreshold: "Minimum confidence score (0-1) for a match to be anonymized."
|
|
307
|
+
},
|
|
308
|
+
returns: "AnonymizeResult { text: string; matches: PiiMatch[] }"
|
|
309
|
+
},
|
|
310
|
+
tokenize: {
|
|
311
|
+
description: "Replace PII with reversible opaque tokens. Use detokenize() to restore.",
|
|
312
|
+
returns: "TokenizeResult { text: string; mapping: Map<string, string> }"
|
|
313
|
+
},
|
|
314
|
+
anonymizeObject: {
|
|
315
|
+
description: "Recursively anonymize all string values in a JSON-serializable object tree. Deep-clones the input \u2014 no mutation. Detects circular references.",
|
|
316
|
+
returns: "A new object of the same shape with all string PII anonymized."
|
|
317
|
+
},
|
|
318
|
+
anonymizeRecord: {
|
|
319
|
+
description: "Anonymize specific fields in a JSON object using dot-notation paths.",
|
|
320
|
+
returns: "A new object with the specified fields anonymized."
|
|
321
|
+
},
|
|
322
|
+
batch: {
|
|
323
|
+
description: "anonymizeBatch / tokenizeBatch / detectBatch \u2014 process arrays of text. Per-item errors are collected without aborting the rest of the batch.",
|
|
324
|
+
returns: "BatchResult<T>[] where ok/error per item is available."
|
|
325
|
+
},
|
|
326
|
+
presets: {
|
|
327
|
+
description: "GDPR, HIPAA, CCPA, PCI-DSS, SOX, FERPA compliance presets.",
|
|
328
|
+
available: ["gdpr", "hipaa", "ccpa", "pci-dss", "sox", "ferpa"]
|
|
329
|
+
}
|
|
330
|
+
},
|
|
331
|
+
toolDefinitions: {
|
|
332
|
+
openai: [
|
|
333
|
+
ANONYMIZE_TOOL_DEFINITION,
|
|
334
|
+
DETECT_TOOL_DEFINITION,
|
|
335
|
+
HAS_PII_TOOL_DEFINITION,
|
|
336
|
+
ANONYMIZE_OBJECT_TOOL_DEFINITION
|
|
337
|
+
]
|
|
338
|
+
}
|
|
339
|
+
};
|
|
340
|
+
|
|
341
|
+
exports.ANONYMA_MANIFEST = ANONYMA_MANIFEST;
|
|
342
|
+
exports.ANONYMIZE_OBJECT_TOOL_DEFINITION = ANONYMIZE_OBJECT_TOOL_DEFINITION;
|
|
343
|
+
exports.ANONYMIZE_TOOL_DEFINITION = ANONYMIZE_TOOL_DEFINITION;
|
|
344
|
+
exports.AnonymizationRuleSchema = AnonymizationRuleSchema;
|
|
345
|
+
exports.AnonymizeOptionsSchema = AnonymizeOptionsSchema;
|
|
346
|
+
exports.AnonymizeResultSchema = AnonymizeResultSchema;
|
|
347
|
+
exports.CustomPatternSchema = CustomPatternSchema;
|
|
348
|
+
exports.DETECT_TOOL_DEFINITION = DETECT_TOOL_DEFINITION;
|
|
349
|
+
exports.FieldRuleMapSchema = FieldRuleMapSchema;
|
|
350
|
+
exports.FieldRuleSchema = FieldRuleSchema;
|
|
351
|
+
exports.GeneralizeOptionsSchema = GeneralizeOptionsSchema;
|
|
352
|
+
exports.HAS_PII_TOOL_DEFINITION = HAS_PII_TOOL_DEFINITION;
|
|
353
|
+
exports.HashOptionsSchema = HashOptionsSchema;
|
|
354
|
+
exports.MaskOptionsSchema = MaskOptionsSchema;
|
|
355
|
+
exports.PiiCategorySchema = PiiCategorySchema;
|
|
356
|
+
exports.PiiMatchSchema = PiiMatchSchema;
|
|
357
|
+
exports.PseudonymizeOptionsSchema = PseudonymizeOptionsSchema;
|
|
358
|
+
exports.RedactOptionsSchema = RedactOptionsSchema;
|
|
359
|
+
exports.StrategyOptionsSchema = StrategyOptionsSchema;
|
|
360
|
+
//# sourceMappingURL=schemas.cjs.map
|
|
361
|
+
//# sourceMappingURL=schemas.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/schemas.ts"],"names":["z"],"mappings":";;;;;AAoCO,IAAM,iBAAA,GAAoBA,MAAE,IAAA,CAAK;AAAA,EACtC,OAAA;AAAA,EACA,OAAA;AAAA,EACA,KAAA;AAAA,EACA,aAAA;AAAA,EACA,MAAA;AAAA,EACA,MAAA;AAAA,EACA,KAAA;AAAA,EACA,MAAA;AAAA,EACA,eAAA;AAAA,EACA,MAAA;AAAA,EACA,SAAA;AAAA,EACA,UAAA;AAAA,EACA,iBAAA;AAAA,EACA,aAAA;AAAA,EACA,cAAA;AAAA,EACA,gBAAA;AAAA,EACA,QAAA;AAAA,EACA,gBAAA;AAAA,EACA,kBAAA;AAAA,EACA,cAAA;AAAA,EACA,SAAA;AAAA,EACA,cAAA;AAAA,EACA,KAAA;AAAA,EACA,eAAA;AAAA,EACA,iBAAA;AAAA,EACA,aAAA;AAAA,EACA;AACF,CAAC;AAKM,IAAM,iBAAA,GAAoBA,MAAE,MAAA,CAAO;AAAA,EACxC,QAAA,EAAUA,KAAA,CAAE,OAAA,CAAQ,MAAM,CAAA;AAAA,EAC1B,QAAA,EAAUA,KAAA,CACP,MAAA,EAAO,CACP,MAAA,CAAO,CAAA,EAAG,wCAAwC,CAAA,CAClD,OAAA,CAAQ,GAAG,CAAA,CACX,QAAA,EAAS;AAAA,EACZ,WAAA,EAAaA,KAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI,CAAE,WAAA,EAAY,CAAE,OAAA,CAAQ,CAAC,CAAA,CAAE,QAAA,EAAS;AAAA,EAChE,YAAA,EAAcA,KAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI,CAAE,WAAA,EAAY,CAAE,OAAA,CAAQ,CAAC,CAAA,CAAE,QAAA;AAC1D,CAAC;AAKM,IAAM,mBAAA,GAAsBA,MAAE,MAAA,CAAO;AAAA,EAC1C,QAAA,EAAUA,KAAA,CAAE,OAAA,CAAQ,QAAQ,CAAA;AAAA,EAC5B,KAAA,EAAOA,KAAA,CAAE,MAAA,EAAO,CAAE,GAAA,CAAI,CAAA,EAAG,yBAAyB,CAAA,CAAE,OAAA,CAAQ,YAAY,CAAA,CAAE,QAAA;AAC5E,CAAC;AAKM,IAAM,yBAAA,GAA4BA,MAAE,MAAA,CAAO;AAAA,EAChD,QAAA,EAAUA,KAAA,CAAE,OAAA,CAAQ,cAAc,CAAA;AAAA,EAClC,IAAA,EAAMA,KAAA,CAAE,MAAA,EAAO,CAAE,QAAA,EAAS;AAAA,EAC1B,MAAA,EAAQA,KAAA,CAAE,MAAA,EAAO,CAAE,KAAA,CAAM,OAAA,EAAS,oCAAoC,CAAA,CAAE,OAAA,CAAQ,KAAK,CAAA,CAAE,QAAA;AACzF,CAAC;AAKM,IAAM,iBAAA,GAAoBA,MAAE,MAAA,CAAO;AAAA,EACxC,QAAA,EAAUA,KAAA,CAAE,OAAA,CAAQ,MAAM,CAAA;AAAA,EAC1B,QAAA,EAAUA,KAAA,CAAE,MAAA,EAAO,CAAE,KAAI,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,IAAI,EAAE,CAAA,CAAE,OAAA,CAAQ,EAAE,EAAE,QAAA,EAAS;AAAA,EAC/D,MAAA,EAAQA,KAAA,CAAE,MAAA,EAAO,CAAE,QAAA;AACrB,CAAC;AAKM,IAAM,uBAAA,GAA0BA,MAAE,MAAA,CAAO;AAAA,EAC9C,QAAA,EAAUA,KAAA,CAAE,OAAA,CAAQ,YAAY,CAAA;AAAA,EAChC,UAAA,EAAYA,KAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI,CAAE,QAAA,EAAS,CAAE,OAAA,CAAQ,EAAE,CAAA,CAAE,QAAA;AACtD,CAAC;AAKM,IAAM,qBAAA,GAAwBA,KAAA,CAAE,kBAAA,CAAmB,UAAA,EAAY;AAAA,EACpE,iBAAA;AAAA,EACA,mBAAA;AAAA,EACA,yBAAA;AAAA,EACA,iBAAA;AAAA,EACA;AACF,CAAC;AASM,IAAM,cAAA,GAAiBA,MAAE,MAAA,CAAO;AAAA,EACrC,QAAA,EAAU,iBAAA;AAAA,EACV,KAAA,EAAOA,MAAE,MAAA,EAAO;AAAA,EAChB,OAAOA,KAAA,CAAE,MAAA,EAAO,CAAE,GAAA,GAAM,WAAA,EAAY;AAAA,EACpC,KAAKA,KAAA,CAAE,MAAA,EAAO,CAAE,GAAA,GAAM,QAAA,EAAS;AAAA,EAC/B,UAAA,EAAYA,MAAE,MAAA,EAAO,CAAE,IAAI,CAAC,CAAA,CAAE,IAAI,CAAC;AACrC,CAAC;AAKM,IAAM,qBAAA,GAAwBA,MAAE,MAAA,CAAO;AAAA,EAC5C,IAAA,EAAMA,MAAE,MAAA,EAAO;AAAA,EACf,OAAA,EAASA,KAAA,CAAE,KAAA,CAAM,cAAc;AACjC,CAAC;AASM,IAAM,uBAAA,GAA0BA,MAAE,MAAA,CAAO;AAAA,EAC9C,QAAA,EAAU,iBAAA;AAAA,EACV,QAAA,EAAU;AACZ,CAAC;AAKM,IAAM,mBAAA,GAAsBA,MAAE,MAAA,CAAO;AAAA,EAC1C,SAASA,KAAA,CAAE,UAAA,CAAW,QAAQ,EAAE,OAAA,EAAS,qCAAqC,CAAA;AAAA,EAC9E,UAAUA,KAAA,CAAE,MAAA,GAAS,GAAA,CAAI,CAAC,EAAE,QAAA,EAAS;AAAA,EACrC,UAAA,EAAYA,KAAA,CAAE,MAAA,EAAO,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,QAAA,EAAS;AAAA,EAC9C,KAAA,EAAOA,MAAE,MAAA,EAAO,CAAE,IAAI,CAAA,EAAG,yBAAyB,EAAE,QAAA;AACtD,CAAC;AAKM,IAAM,sBAAA,GAAyBA,MAAE,MAAA,CAAO;AAAA,EAC7C,KAAA,EAAOA,KAAA,CAAE,KAAA,CAAM,uBAAuB,EAAE,QAAA,EAAS;AAAA,EACjD,eAAA,EAAiB,sBAAsB,QAAA,EAAS;AAAA,EAChD,gBAAgBA,KAAA,CAAE,OAAA,GAAU,OAAA,CAAQ,KAAK,EAAE,QAAA,EAAS;AAAA,EACpD,cAAA,EAAgBA,KAAA,CAAE,KAAA,CAAM,mBAAmB,EAAE,QAAA,EAAS;AAAA,EACtD,iBAAA,EAAmBA,MAAE,MAAA,EAAO,CAAE,IAAI,CAAA,EAAG,qCAAqC,EAAE,QAAA,EAAS;AAAA,EACrF,kBAAkBA,KAAA,CAAE,OAAA,GAAU,OAAA,CAAQ,KAAK,EAAE,QAAA,EAAS;AAAA,EACtD,YAAYA,KAAA,CAAE,OAAA,GAAU,OAAA,CAAQ,KAAK,EAAE,QAAA,EAAS;AAAA,EAChD,iBAAA,EAAmBA,MAAE,MAAA,CAAO,iBAAA,EAAmBA,MAAE,OAAA,EAAS,EAAE,QAAA;AAC9D,CAAC;AASM,IAAM,eAAA,GAAkBA,MAAE,MAAA,CAAO;AAAA,EACtC,QAAA,EAAU;AACZ,CAAC;AAKM,IAAM,qBAAqBA,KAAA,CAAE,MAAA,CAAOA,KAAA,CAAE,MAAA,IAAU,eAAe;AAiD/D,IAAM,yBAAA,GAAsD;AAAA,EACjE,IAAA,EAAM,WAAA;AAAA,EACN,WAAA,EACE,+JAAA;AAAA,EAEF,UAAA,EAAY;AAAA,IACV,IAAA,EAAM,QAAA;AAAA,IACN,UAAA,EAAY;AAAA,MACV,IAAA,EAAM;AAAA,QACJ,IAAA,EAAM,QAAA;AAAA,QACN,WAAA,EAAa;AAAA,OACf;AAAA,MACA,eAAA,EAAiB;AAAA,QACf,IAAA,EAAM,QAAA;AAAA,QACN,WAAA,EACE,gGAAA;AAAA,QAEF,UAAA,EAAY;AAAA,UACV,QAAA,EAAU;AAAA,YACR,IAAA,EAAM,QAAA;AAAA,YACN,MAAM,CAAC,MAAA,EAAQ,QAAA,EAAU,cAAA,EAAgB,QAAQ,YAAY;AAAA;AAC/D,SACF;AAAA,QACA,QAAA,EAAU,CAAC,UAAU;AAAA,OACvB;AAAA,MACA,cAAA,EAAgB;AAAA,QACd,IAAA,EAAM,SAAA;AAAA,QACN,WAAA,EAAa;AAAA,OACf;AAAA,MACA,iBAAA,EAAmB;AAAA,QACjB,IAAA,EAAM,QAAA;AAAA,QACN,WAAA,EACE;AAAA,OAEJ;AAAA,MACA,gBAAA,EAAkB;AAAA,QAChB,IAAA,EAAM,SAAA;AAAA,QACN,WAAA,EACE;AAAA,OAEJ;AAAA,MACA,UAAA,EAAY;AAAA,QACV,IAAA,EAAM,SAAA;AAAA,QACN,WAAA,EACE;AAAA;AAEJ,KACF;AAAA,IACA,QAAA,EAAU,CAAC,MAAM;AAAA;AAErB;AAKO,IAAM,sBAAA,GAAmD;AAAA,EAC9D,IAAA,EAAM,QAAA;AAAA,EACN,WAAA,EACE,uJAAA;AAAA,EAEF,UAAA,EAAY;AAAA,IACV,IAAA,EAAM,QAAA;AAAA,IACN,UAAA,EAAY;AAAA,MACV,IAAA,EAAM;AAAA,QACJ,IAAA,EAAM,QAAA;AAAA,QACN,WAAA,EAAa;AAAA,OACf;AAAA,MACA,UAAA,EAAY;AAAA,QACV,IAAA,EAAM,OAAA;AAAA,QACN,WAAA,EACE,oFAAA;AAAA,QAEF,KAAA,EAAO;AAAA,UACL,IAAA,EAAM,QAAA;AAAA,UACN,IAAA,EAAM;AAAA,YACJ,OAAA;AAAA,YACA,OAAA;AAAA,YACA,KAAA;AAAA,YACA,aAAA;AAAA,YACA,MAAA;AAAA,YACA,MAAA;AAAA,YACA,KAAA;AAAA,YACA,MAAA;AAAA,YACA,eAAA;AAAA,YACA;AAAA;AACF;AACF;AACF,KACF;AAAA,IACA,QAAA,EAAU,CAAC,MAAM;AAAA;AAErB;AAeO,IAAM,uBAAA,GAAoD;AAAA,EAC/D,IAAA,EAAM,QAAA;AAAA,EACN,WAAA,EACE,6KAAA;AAAA,EAEF,UAAA,EAAY;AAAA,IACV,IAAA,EAAM,QAAA;AAAA,IACN,UAAA,EAAY;AAAA,MACV,IAAA,EAAM;AAAA,QACJ,IAAA,EAAM,QAAA;AAAA,QACN,WAAA,EAAa;AAAA,OACf;AAAA,MACA,UAAA,EAAY;AAAA,QACV,IAAA,EAAM,OAAA;AAAA,QACN,WAAA,EAAa,8DAAA;AAAA,QACb,KAAA,EAAO;AAAA,UACL,IAAA,EAAM,QAAA;AAAA,UACN,IAAA,EAAM;AAAA,YACJ,OAAA;AAAA,YACA,OAAA;AAAA,YACA,KAAA;AAAA,YACA,aAAA;AAAA,YACA,MAAA;AAAA,YACA,MAAA;AAAA,YACA,KAAA;AAAA,YACA,MAAA;AAAA,YACA,eAAA;AAAA,YACA;AAAA;AACF;AACF;AACF,KACF;AAAA,IACA,QAAA,EAAU,CAAC,MAAM;AAAA;AAErB;AAUO,IAAM,gCAAA,GAA6D;AAAA,EACxE,IAAA,EAAM,iBAAA;AAAA,EACN,WAAA,EACE,uOAAA;AAAA,EAGF,UAAA,EAAY;AAAA,IACV,IAAA,EAAM,QAAA;AAAA,IACN,UAAA,EAAY;AAAA,MACV,GAAA,EAAK;AAAA,QACH,IAAA,EAAM,QAAA;AAAA,QACN,WAAA,EAAa;AAAA,OACf;AAAA,MACA,OAAA,EAAS;AAAA,QACP,IAAA,EAAM,QAAA;AAAA,QACN,WAAA,EAAa,qEAAA;AAAA,QACb,UAAA,EAAY;AAAA,UACV,iBAAA,EAAmB;AAAA,YACjB,IAAA,EAAM,QAAA;AAAA,YACN,WAAA,EAAa;AAAA,WACf;AAAA,UACA,gBAAA,EAAkB;AAAA,YAChB,IAAA,EAAM,SAAA;AAAA,YACN,WAAA,EAAa;AAAA,WACf;AAAA,UACA,UAAA,EAAY;AAAA,YACV,IAAA,EAAM,SAAA;AAAA,YACN,WAAA,EAAa;AAAA;AACf;AACF;AACF,KACF;AAAA,IACA,QAAA,EAAU,CAAC,KAAK;AAAA;AAEpB;AAkBO,IAAM,gBAAA,GAAmB;AAAA,EAC9B,IAAA,EAAM,SAAA;AAAA,EACN,OAAA,EAAS,OAAA;AAAA,EACT,WAAA,EACE,ycAAA;AAAA,EACF,YAAA,EAAc;AAAA,IACZ,MAAA,EAAQ;AAAA,MACN,WAAA,EAAa,+CAAA;AAAA,MACb,mBAAA,EAAqB;AAAA,QACnB,OAAA;AAAA,QAAS,OAAA;AAAA,QAAS,KAAA;AAAA,QAAO,aAAA;AAAA,QAAe,MAAA;AAAA,QAAQ,MAAA;AAAA,QAAQ,KAAA;AAAA,QACxD,MAAA;AAAA,QAAQ,eAAA;AAAA,QAAiB,MAAA;AAAA,QAAQ,SAAA;AAAA,QAAW,UAAA;AAAA,QAAY,iBAAA;AAAA,QACxD,aAAA;AAAA,QAAe,cAAA;AAAA,QAAgB,gBAAA;AAAA,QAAkB,QAAA;AAAA,QAAU,gBAAA;AAAA,QAC3D,kBAAA;AAAA,QAAoB,cAAA;AAAA,QAAgB,SAAA;AAAA,QAAW,cAAA;AAAA,QAAgB,KAAA;AAAA,QAC/D,eAAA;AAAA,QAAiB,iBAAA;AAAA,QAAmB,aAAA;AAAA,QAAe;AAAA,OACrD;AAAA,MACA,KAAA,EAAO;AAAA,QACL,IAAA,EACE;AAAA,OAEJ;AAAA,MACA,OAAA,EAAS;AAAA,KACX;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,WAAA,EACE,sHAAA;AAAA,MAEF,OAAA,EAAS;AAAA,KACX;AAAA,IACA,SAAA,EAAW;AAAA,MACT,WAAA,EAAa,oEAAA;AAAA,MACb,UAAA,EAAY;AAAA,QACV,IAAA,EAAM,+EAAA;AAAA,QACN,MAAA,EAAQ,2DAAA;AAAA,QACR,YAAA,EACE,6EAAA;AAAA,QACF,IAAA,EAAM,mEAAA;AAAA,QACN,UAAA,EAAY,qEAAA;AAAA,QACZ,QAAA,EAAU,6EAAA;AAAA,QACV,OAAA,EAAS,gFAAA;AAAA,QACT,UAAA,EAAY;AAAA,OACd;AAAA,MACA,OAAA,EAAS;AAAA,QACP,iBAAA,EAAmB,iEAAA;AAAA,QACnB,gBAAA,EACE,0EAAA;AAAA,QACF,UAAA,EACE,uEAAA;AAAA,QACF,iBAAA,EAAmB,4DAAA;AAAA,QACnB,cAAA,EAAgB,2DAAA;AAAA,QAChB,eAAA,EAAiB,sDAAA;AAAA,QACjB,MAAA,EAAQ,0EAAA;AAAA,QACR,SAAA,EAAW,0EAAA;AAAA,QACX,mBAAA,EAAqB;AAAA,OACvB;AAAA,MACA,OAAA,EAAS;AAAA,KACX;AAAA,IACA,QAAA,EAAU;AAAA,MACR,WAAA,EACE,yEAAA;AAAA,MACF,OAAA,EAAS;AAAA,KACX;AAAA,IACA,eAAA,EAAiB;AAAA,MACf,WAAA,EACE,oJAAA;AAAA,MAEF,OAAA,EAAS;AAAA,KACX;AAAA,IACA,eAAA,EAAiB;AAAA,MACf,WAAA,EAAa,sEAAA;AAAA,MACb,OAAA,EAAS;AAAA,KACX;AAAA,IACA,KAAA,EAAO;AAAA,MACL,WAAA,EACE,mJAAA;AAAA,MAEF,OAAA,EAAS;AAAA,KACX;AAAA,IACA,OAAA,EAAS;AAAA,MACP,WAAA,EAAa,4DAAA;AAAA,MACb,WAAW,CAAC,MAAA,EAAQ,SAAS,MAAA,EAAQ,SAAA,EAAW,OAAO,OAAO;AAAA;AAChE,GACF;AAAA,EACA,eAAA,EAAiB;AAAA,IACf,MAAA,EAAQ;AAAA,MACN,yBAAA;AAAA,MACA,sBAAA;AAAA,MACA,uBAAA;AAAA,MACA;AAAA;AACF;AAEJ","file":"schemas.cjs","sourcesContent":["/**\n * @module schemas\n * @description Optional Zod schemas and JSON Schema definitions for anonyma's\n * public API surface. Import from `\"anonyma/schemas\"`.\n *\n * These schemas enable:\n * - Runtime input validation\n * - OpenAI / Anthropic function-calling definitions\n * - MCP (Model Context Protocol) tool definitions\n * - Automatic form generation\n *\n * @example\n * ```ts\n * import { AnonymizeOptionsSchema, toJsonSchema } from \"anonyma/schemas\";\n *\n * // Validate at runtime:\n * const opts = AnonymizeOptionsSchema.parse(unknownInput);\n *\n * // Obtain JSON Schema for an AI tool definition:\n * const jsonSchema = toJsonSchema(AnonymizeOptionsSchema);\n * ```\n *\n * @remarks\n * This module requires `zod` to be installed (`peerDependency`).\n * Import it only when you need runtime validation or AI schema generation.\n */\n\nimport { z } from \"zod\";\n\n// ---------------------------------------------------------------------------\n// Category & strategy schemas\n// ---------------------------------------------------------------------------\n\n/**\n * Zod schema for the {@link PiiCategory} union.\n */\nexport const PiiCategorySchema = z.enum([\n \"email\",\n \"phone\",\n \"ssn\",\n \"credit-card\",\n \"ipv4\",\n \"ipv6\",\n \"url\",\n \"iban\",\n \"date-of-birth\",\n \"name\",\n \"address\",\n \"passport\",\n \"drivers-license\",\n \"national-id\",\n \"bank-account\",\n \"cryptocurrency\",\n \"tax-id\",\n \"medical-record\",\n \"health-insurance\",\n \"prescription\",\n \"api-key\",\n \"social-media\",\n \"vin\",\n \"license-plate\",\n \"tracking-number\",\n \"case-number\",\n \"company-registration\",\n]);\n\n/**\n * Zod schema for {@link MaskOptions}.\n */\nexport const MaskOptionsSchema = z.object({\n strategy: z.literal(\"mask\"),\n maskChar: z\n .string()\n .length(1, \"maskChar must be exactly one character\")\n .default(\"*\")\n .optional(),\n keepLeading: z.number().int().nonnegative().default(0).optional(),\n keepTrailing: z.number().int().nonnegative().default(0).optional(),\n});\n\n/**\n * Zod schema for {@link RedactOptions}.\n */\nexport const RedactOptionsSchema = z.object({\n strategy: z.literal(\"redact\"),\n label: z.string().min(1, \"label must not be empty\").default(\"[REDACTED]\").optional(),\n});\n\n/**\n * Zod schema for {@link PseudonymizeOptions}.\n */\nexport const PseudonymizeOptionsSchema = z.object({\n strategy: z.literal(\"pseudonymize\"),\n seed: z.string().optional(),\n prefix: z.string().regex(/^\\S+$/, \"prefix must not contain whitespace\").default(\"id_\").optional(),\n});\n\n/**\n * Zod schema for {@link HashOptions}.\n */\nexport const HashOptionsSchema = z.object({\n strategy: z.literal(\"hash\"),\n truncate: z.number().int().min(1).max(64).default(16).optional(),\n pepper: z.string().optional(),\n});\n\n/**\n * Zod schema for {@link GeneralizeOptions}.\n */\nexport const GeneralizeOptionsSchema = z.object({\n strategy: z.literal(\"generalize\"),\n bucketSize: z.number().int().positive().default(10).optional(),\n});\n\n/**\n * Discriminated union schema for {@link StrategyOptions}.\n */\nexport const StrategyOptionsSchema = z.discriminatedUnion(\"strategy\", [\n MaskOptionsSchema,\n RedactOptionsSchema,\n PseudonymizeOptionsSchema,\n HashOptionsSchema,\n GeneralizeOptionsSchema,\n]);\n\n// ---------------------------------------------------------------------------\n// Match & result schemas\n// ---------------------------------------------------------------------------\n\n/**\n * Zod schema for {@link PiiMatch}.\n */\nexport const PiiMatchSchema = z.object({\n category: PiiCategorySchema,\n value: z.string(),\n start: z.number().int().nonnegative(),\n end: z.number().int().positive(),\n confidence: z.number().min(0).max(1),\n});\n\n/**\n * Zod schema for {@link AnonymizeResult}.\n */\nexport const AnonymizeResultSchema = z.object({\n text: z.string(),\n matches: z.array(PiiMatchSchema),\n});\n\n// ---------------------------------------------------------------------------\n// Anonymize options schema\n// ---------------------------------------------------------------------------\n\n/**\n * Zod schema for a single {@link AnonymizationRule}.\n */\nexport const AnonymizationRuleSchema = z.object({\n category: PiiCategorySchema,\n strategy: StrategyOptionsSchema,\n});\n\n/**\n * Zod schema for a {@link CustomPattern}.\n */\nexport const CustomPatternSchema = z.object({\n pattern: z.instanceof(RegExp, { message: \"pattern must be a RegExp instance\" }),\n category: z.string().min(1).optional(),\n confidence: z.number().min(0).max(1).optional(),\n label: z.string().min(1, \"label must not be empty\").optional(),\n});\n\n/**\n * Zod schema for {@link AnonymizeOptions}.\n */\nexport const AnonymizeOptionsSchema = z.object({\n rules: z.array(AnonymizationRuleSchema).optional(),\n defaultStrategy: StrategyOptionsSchema.optional(),\n includeMatches: z.boolean().default(false).optional(),\n customPatterns: z.array(CustomPatternSchema).optional(),\n globalReplacement: z.string().min(1, \"globalReplacement must not be empty\").optional(),\n consistentTokens: z.boolean().default(false).optional(),\n aggressive: z.boolean().default(false).optional(),\n enabledCategories: z.record(PiiCategorySchema, z.boolean()).optional(),\n});\n\n// ---------------------------------------------------------------------------\n// Field-level anonymization schema\n// ---------------------------------------------------------------------------\n\n/**\n * Zod schema for a single field rule.\n */\nexport const FieldRuleSchema = z.object({\n strategy: StrategyOptionsSchema,\n});\n\n/**\n * Zod schema for a {@link FieldRuleMap}.\n */\nexport const FieldRuleMapSchema = z.record(z.string(), FieldRuleSchema);\n\n// ---------------------------------------------------------------------------\n// JSON Schema / OpenAI function-calling definitions\n// ---------------------------------------------------------------------------\n\n/**\n * A minimal JSON Schema representation extracted from a Zod schema.\n * Suitable for use in OpenAI function definitions, MCP tool definitions, etc.\n */\nexport interface JsonSchemaDefinition {\n readonly type: string;\n readonly description?: string;\n readonly properties?: Record<string, JsonSchemaDefinition>;\n readonly items?: JsonSchemaDefinition;\n readonly enum?: readonly string[];\n readonly required?: readonly string[];\n readonly anyOf?: readonly JsonSchemaDefinition[];\n readonly default?: unknown;\n}\n\n/**\n * OpenAI-compatible function definition shape.\n */\nexport interface OpenAiFunctionDefinition {\n readonly name: string;\n readonly description: string;\n readonly parameters: {\n readonly type: \"object\";\n readonly properties: Record<string, JsonSchemaDefinition>;\n readonly required?: readonly string[];\n };\n}\n\n/**\n * Pre-built OpenAI / MCP tool definition for the `anonymize` function.\n *\n * @example\n * ```ts\n * import { ANONYMIZE_TOOL_DEFINITION } from \"anonyma/schemas\";\n *\n * // Pass directly to OpenAI client tools array:\n * const response = await openai.chat.completions.create({\n * model: \"gpt-4o\",\n * tools: [{ type: \"function\", function: ANONYMIZE_TOOL_DEFINITION }],\n * messages: [...],\n * });\n * ```\n */\nexport const ANONYMIZE_TOOL_DEFINITION: OpenAiFunctionDefinition = {\n name: \"anonymize\",\n description:\n \"Detect and anonymize PII (personally identifiable information) in a text string. \" +\n \"Returns the anonymized text and, optionally, a list of detected PII matches.\",\n parameters: {\n type: \"object\",\n properties: {\n text: {\n type: \"string\",\n description: \"The input text to anonymize.\",\n },\n defaultStrategy: {\n type: \"object\",\n description:\n \"The anonymization strategy to apply to all detected PII. \" +\n \"Defaults to `{ strategy: 'redact' }`.\",\n properties: {\n strategy: {\n type: \"string\",\n enum: [\"mask\", \"redact\", \"pseudonymize\", \"hash\", \"generalize\"] as const,\n },\n },\n required: [\"strategy\"],\n },\n includeMatches: {\n type: \"boolean\",\n description: \"When true, include detected PII matches in the response.\",\n },\n globalReplacement: {\n type: \"string\",\n description:\n \"When set, every detected PII entity is replaced with this exact string, \" +\n \"overriding per-category rules and defaultStrategy.\",\n },\n consistentTokens: {\n type: \"boolean\",\n description:\n \"When true, identical PII values receive the same token (e.g. EMAIL_1) \" +\n \"across the entire call. Different values get different tokens.\",\n },\n aggressive: {\n type: \"boolean\",\n description:\n \"When true, detectors use expanded, more permissive patterns to catch \" +\n \"obfuscated PII at the cost of higher false-positive rates.\",\n },\n },\n required: [\"text\"],\n },\n};\n\n/**\n * Pre-built OpenAI / MCP tool definition for the `detect` function.\n */\nexport const DETECT_TOOL_DEFINITION: OpenAiFunctionDefinition = {\n name: \"detect\",\n description:\n \"Detect all PII (email, phone, SSN, credit card, IP, URL, IBAN, date-of-birth, name) \" +\n \"in a text string without modifying it. Returns a list of matches.\",\n parameters: {\n type: \"object\",\n properties: {\n text: {\n type: \"string\",\n description: \"The input text to scan for PII.\",\n },\n categories: {\n type: \"array\",\n description:\n \"Optional subset of PII categories to detect. \" +\n \"Defaults to all supported categories.\",\n items: {\n type: \"string\",\n enum: [\n \"email\",\n \"phone\",\n \"ssn\",\n \"credit-card\",\n \"ipv4\",\n \"ipv6\",\n \"url\",\n \"iban\",\n \"date-of-birth\",\n \"name\",\n ] as const,\n },\n },\n },\n required: [\"text\"],\n },\n};\n\n/**\n * Pre-built OpenAI / MCP tool definition for the `hasPII` function.\n *\n * @example\n * ```ts\n * import { HAS_PII_TOOL_DEFINITION } from \"anonyma/schemas\";\n *\n * const response = await openai.chat.completions.create({\n * tools: [{ type: \"function\", function: HAS_PII_TOOL_DEFINITION }],\n * messages: [...],\n * });\n * ```\n */\nexport const HAS_PII_TOOL_DEFINITION: OpenAiFunctionDefinition = {\n name: \"hasPII\",\n description:\n \"Check whether a text string contains any detectable PII without redacting it. \" +\n \"Returns true/false. Uses early-exit optimisation — stops scanning after the first match.\",\n parameters: {\n type: \"object\",\n properties: {\n text: {\n type: \"string\",\n description: \"The input text to check for PII.\",\n },\n categories: {\n type: \"array\",\n description: \"Optional subset of PII categories to check. Defaults to all.\",\n items: {\n type: \"string\",\n enum: [\n \"email\",\n \"phone\",\n \"ssn\",\n \"credit-card\",\n \"ipv4\",\n \"ipv6\",\n \"url\",\n \"iban\",\n \"date-of-birth\",\n \"name\",\n ] as const,\n },\n },\n },\n required: [\"text\"],\n },\n};\n\n/**\n * Pre-built OpenAI / MCP tool definition for the `anonymizeObject` function.\n *\n * @example\n * ```ts\n * import { ANONYMIZE_OBJECT_TOOL_DEFINITION } from \"anonyma/schemas\";\n * ```\n */\nexport const ANONYMIZE_OBJECT_TOOL_DEFINITION: OpenAiFunctionDefinition = {\n name: \"anonymizeObject\",\n description:\n \"Recursively anonymize all string values found in a JSON-serializable object tree. \" +\n \"Returns a deep clone with PII replaced. Arrays, nested objects, and mixed structures \" +\n \"are all handled. Non-string primitives pass through unchanged.\",\n parameters: {\n type: \"object\",\n properties: {\n obj: {\n type: \"object\",\n description: \"The JSON-serializable object to anonymize.\",\n },\n options: {\n type: \"object\",\n description: \"Optional anonymization configuration (same as anonymize() options).\",\n properties: {\n globalReplacement: {\n type: \"string\",\n description: \"Replace all PII with this exact string.\",\n },\n consistentTokens: {\n type: \"boolean\",\n description: \"Same PII value → same token across the entire object.\",\n },\n aggressive: {\n type: \"boolean\",\n description: \"Enable more permissive detection patterns.\",\n },\n },\n },\n },\n required: [\"obj\"],\n },\n};\n\n// ---------------------------------------------------------------------------\n// AI-readable capability manifest\n// ---------------------------------------------------------------------------\n\n/**\n * Machine-readable manifest describing anonyma's capabilities.\n * Useful for AI agents that need to discover and reason about available tools.\n *\n * @example\n * ```ts\n * import { ANONYMA_MANIFEST } from \"anonyma/schemas\";\n *\n * // Provide to an AI agent as system context:\n * const systemPrompt = `You have access to the following data privacy tool:\\n\\n${JSON.stringify(ANONYMA_MANIFEST, null, 2)}`;\n * ```\n */\nexport const ANONYMA_MANIFEST = {\n name: \"anonyma\",\n version: \"1.0.0\",\n description:\n \"TypeScript-first PII detection & anonymization — 26 built-in detectors (email, SSN, IBAN, passport, credit card, and more), 8 strategies (mask, redact, hash, AES-256 encrypt, tokenize, pseudonymize, generalize, synthesize), 6 compliance presets (GDPR, HIPAA, CCPA, PCI-DSS, SOX, FERPA), reversible tokenization, LLM/AI pipeline helpers, WHATWG streaming, batch processing, checksum validators, and optional Zod/MCP schemas. Zero runtime dependencies.\",\n capabilities: {\n detect: {\n description: \"Detect PII in free text without modifying it.\",\n supportedCategories: [\n \"email\", \"phone\", \"ssn\", \"credit-card\", \"ipv4\", \"ipv6\", \"url\",\n \"iban\", \"date-of-birth\", \"name\", \"address\", \"passport\", \"drivers-license\",\n \"national-id\", \"bank-account\", \"cryptocurrency\", \"tax-id\", \"medical-record\",\n \"health-insurance\", \"prescription\", \"api-key\", \"social-media\", \"vin\",\n \"license-plate\", \"tracking-number\", \"case-number\", \"company-registration\",\n ],\n notes: {\n name:\n \"Name detection is heuristic — only catches names preceded by greeting keywords \" +\n \"(e.g. 'Dear Alice'). Not an NLP-based named-entity recogniser.\",\n },\n returns: \"Array of PiiMatch objects with category, value, position, and confidence.\",\n },\n hasPII: {\n description:\n \"Return true/false indicating whether a string contains detectable PII. \" +\n \"Uses early-exit optimisation for performance.\",\n returns: \"boolean\",\n },\n anonymize: {\n description: \"Detect and replace PII in free text using a configurable strategy.\",\n strategies: {\n mask: \"Replace characters with a mask char, keeping optional leading/trailing chars.\",\n redact: \"Replace the entire value with a label such as [REDACTED].\",\n pseudonymize:\n \"Replace with a deterministic pseudonym (requires seed for reproducibility).\",\n hash: \"Replace with a one-way SHA-256 hash (requires Node.js ≥ 18).\",\n generalize: \"Replace a numeric value with a bucket range (e.g. 27 → 20-29).\",\n tokenize: \"Replace with a reversible opaque token ([CATEGORY_NNNN]) for LLM pipelines.\",\n encrypt: \"Replace with AES-GCM ciphertext (requires Node.js ≥ 18 + passphrase/key).\",\n synthesize: \"Replace with structurally-valid synthetic data (format-preserving).\",\n },\n options: {\n globalReplacement: \"Override ALL strategy outputs with a single replacement string.\",\n consistentTokens:\n \"Same PII value → same token (EMAIL_1, PHONE_2, etc.) within a call.\",\n aggressive:\n \"Use expanded, more permissive regex patterns to catch obfuscated PII.\",\n enabledCategories: \"Convenience boolean map for enabling/disabling categories.\",\n customPatterns: \"Ad-hoc regex patterns merged into the detection pipeline.\",\n customDetectors: \"Override built-in detectors on a per-category basis.\",\n preset: \"Apply a compliance preset (gdpr | hipaa | ccpa | pci-dss | sox | ferpa).\",\n allowlist: \"String values that should never be anonymized even when detected as PII.\",\n confidenceThreshold: \"Minimum confidence score (0-1) for a match to be anonymized.\",\n },\n returns: \"AnonymizeResult { text: string; matches: PiiMatch[] }\",\n },\n tokenize: {\n description:\n \"Replace PII with reversible opaque tokens. Use detokenize() to restore.\",\n returns: \"TokenizeResult { text: string; mapping: Map<string, string> }\",\n },\n anonymizeObject: {\n description:\n \"Recursively anonymize all string values in a JSON-serializable object tree. \" +\n \"Deep-clones the input — no mutation. Detects circular references.\",\n returns: \"A new object of the same shape with all string PII anonymized.\",\n },\n anonymizeRecord: {\n description: \"Anonymize specific fields in a JSON object using dot-notation paths.\",\n returns: \"A new object with the specified fields anonymized.\",\n },\n batch: {\n description:\n \"anonymizeBatch / tokenizeBatch / detectBatch — process arrays of text. \" +\n \"Per-item errors are collected without aborting the rest of the batch.\",\n returns: \"BatchResult<T>[] where ok/error per item is available.\",\n },\n presets: {\n description: \"GDPR, HIPAA, CCPA, PCI-DSS, SOX, FERPA compliance presets.\",\n available: [\"gdpr\", \"hipaa\", \"ccpa\", \"pci-dss\", \"sox\", \"ferpa\"],\n },\n },\n toolDefinitions: {\n openai: [\n ANONYMIZE_TOOL_DEFINITION,\n DETECT_TOOL_DEFINITION,\n HAS_PII_TOOL_DEFINITION,\n ANONYMIZE_OBJECT_TOOL_DEFINITION,\n ],\n },\n} as const;\n\n// ---------------------------------------------------------------------------\n// Inferred TypeScript types from Zod schemas\n// ---------------------------------------------------------------------------\n\nexport type PiiCategoryInput = z.infer<typeof PiiCategorySchema>;\nexport type StrategyOptionsInput = z.infer<typeof StrategyOptionsSchema>;\nexport type AnonymizeOptionsInput = z.infer<typeof AnonymizeOptionsSchema>;\nexport type AnonymizationRuleInput = z.infer<typeof AnonymizationRuleSchema>;\nexport type CustomPatternInput = z.infer<typeof CustomPatternSchema>;\nexport type PiiMatchOutput = z.infer<typeof PiiMatchSchema>;\nexport type AnonymizeResultOutput = z.infer<typeof AnonymizeResultSchema>;\nexport type FieldRuleInput = z.infer<typeof FieldRuleSchema>;\nexport type FieldRuleMapInput = z.infer<typeof FieldRuleMapSchema>;\n"]}
|