@hazeljs/guardrails 0.7.9 → 0.8.1

package/README.md

@@ -95,7 +95,10 @@ import { GuardrailsService, GuardrailInput, GuardrailOutput } from '@hazeljs/gua
 
 @Controller({ path: '/chat' })
 export class ChatController {
-  constructor(private aiService: AIService, private guardrailsService: GuardrailsService) {}
+  constructor(
+    private aiService: AIService,
+    private guardrailsService: GuardrailsService
+  ) {}
 
   @GuardrailInput()
   @GuardrailOutput()
@@ -113,24 +116,21 @@ When both `GuardrailsModule` and `AgentModule` are imported, tool input and outp
 
 ```typescript
 @HazelModule({
-  imports: [
-    GuardrailsModule.forRoot(),
-    AgentModule.forRoot(),
-  ],
+  imports: [GuardrailsModule.forRoot(), AgentModule.forRoot()],
 })
 export class AppModule {}
 ```
 
 ## Configuration
 
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `piiEntities` | `PIIEntityType[]` | `['email','phone','ssn','credit_card']` | Entities to detect/redact |
-| `redactPIIByDefault` | `boolean` | `false` | Redact PII in input by default |
-| `blockInjectionByDefault` | `boolean` | `true` | Block prompt injection by default |
-| `blockToxicityByDefault` | `boolean` | `true` | Block toxic content by default |
-| `injectionBlocklist` | `string[]` | — | Custom injection patterns |
-| `toxicityBlocklist` | `string[]` | — | Custom toxicity keywords |
+| Option                    | Type              | Default                                 | Description                       |
+| ------------------------- | ----------------- | --------------------------------------- | --------------------------------- |
+| `piiEntities`             | `PIIEntityType[]` | `['email','phone','ssn','credit_card']` | Entities to detect/redact         |
+| `redactPIIByDefault`      | `boolean`         | `false`                                 | Redact PII in input by default    |
+| `blockInjectionByDefault` | `boolean`         | `true`                                  | Block prompt injection by default |
+| `blockToxicityByDefault`  | `boolean`         | `true`                                  | Block toxic content by default    |
+| `injectionBlocklist`      | `string[]`        | —                                       | Custom injection patterns         |
+| `toxicityBlocklist`       | `string[]`        | —                                       | Custom toxicity keywords          |
 
 ## API
 

package/dist/checks/hallucination.check.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Heuristic hallucination / grounding check — compares answer tokens to context.
+ * For production, combine with LLM-as-judge or @hazeljs/eval.
+ */
+export interface HallucinationCheckResult {
+    grounded: boolean;
+    overlapRatio: number;
+    suspiciousPhrases: string[];
+}
+/**
+ * Returns true when answer appears supported by context (token overlap + hedge detection).
+ */
+export declare function checkHallucinationHeuristic(answer: string, context: string): HallucinationCheckResult;
+//# sourceMappingURL=hallucination.check.d.ts.map

package/dist/checks/hallucination.check.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hallucination.check.d.ts","sourceRoot":"","sources":["../../src/checks/hallucination.check.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B;AAID;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,GACd,wBAAwB,CAe1B"}

package/dist/checks/hallucination.check.js

@@ -0,0 +1,35 @@
+"use strict";
+/**
+ * Heuristic hallucination / grounding check — compares answer tokens to context.
+ * For production, combine with LLM-as-judge or @hazeljs/eval.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkHallucinationHeuristic = checkHallucinationHeuristic;
+const HEDGE_WORDS = ['might', 'maybe', 'possibly', 'could be', 'i think', "i'm not sure"];
+/**
+ * Returns true when answer appears supported by context (token overlap + hedge detection).
+ */
+function checkHallucinationHeuristic(answer, context) {
+    const a = tokenize(answer);
+    const c = new Set(tokenize(context));
+    if (a.length === 0) {
+        return { grounded: true, overlapRatio: 1, suspiciousPhrases: [] };
+    }
+    let hit = 0;
+    for (const w of a) {
+        if (c.has(w))
+            hit++;
+    }
+    const overlapRatio = hit / a.length;
+    const lower = answer.toLowerCase();
+    const suspiciousPhrases = HEDGE_WORDS.filter((h) => lower.includes(h));
+    const grounded = overlapRatio >= 0.15 && suspiciousPhrases.length < 3;
+    return { grounded, overlapRatio, suspiciousPhrases };
+}
+function tokenize(s) {
+    return s
+        .toLowerCase()
+        .replace(/[^\p{L}\p{N}\s]/gu, ' ')
+        .split(/\s+/)
+        .filter((w) => w.length > 2);
+}

package/dist/index.d.ts

@@ -11,4 +11,9 @@ export { GuardrailViolationError } from './errors/guardrail-violation.error';
 export type { GuardrailInputOptions, GuardrailOutputOptions, GuardrailResult, GuardrailsModuleOptions, PIIEntityType, } from './guardrails.types';
 export type { GuardrailPipeOptions } from './pipes/guardrail.pipe';
 export type { GuardrailInterceptorOptions } from './interceptors/guardrail.interceptor';
+export { checkHallucinationHeuristic } from './checks/hallucination.check';
+export type { HallucinationCheckResult } from './checks/hallucination.check';
+export { detectPII, redactPII } from './checks/pii.check';
+export { checkPromptInjection } from './checks/injection.check';
+export { checkToxicity } from './checks/toxicity.check';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACnG,OAAO,EACL,eAAe,EACf,0BAA0B,GAC3B,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAE7E,YAAY,EACV,qBAAqB,EACrB,sBAAsB,EACtB,eAAe,EACf,uBAAuB,EACvB,aAAa,GACd,MAAM,oBAAoB,CAAC;AAE5B,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,YAAY,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACnG,OAAO,EACL,eAAe,EACf,0BAA0B,GAC3B,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAE7E,YAAY,EACV,qBAAqB,EACrB,sBAAsB,EACtB,eAAe,EACf,uBAAuB,EACvB,aAAa,GACd,MAAM,oBAAoB,CAAC;AAE5B,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,YAAY,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC;AAExF,OAAO,EAAE,2BAA2B,EAAE,MAAM,8BAA8B,CAAC;AAC3E,YAAY,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/index.js

@@ -3,7 +3,7 @@
  * @hazeljs/guardrails - Content safety, PII handling, and output validation
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GuardrailViolationError = exports.getGuardrailOutputMetadata = exports.GuardrailOutput = exports.getGuardrailInputMetadata = exports.GuardrailInput = exports.GuardrailInterceptor = exports.GuardrailPipe = exports.GuardrailsService = exports.GUARDRAILS_SERVICE_TOKEN = exports.GuardrailsModule = void 0;
+exports.checkToxicity = exports.checkPromptInjection = exports.redactPII = exports.detectPII = exports.checkHallucinationHeuristic = exports.GuardrailViolationError = exports.getGuardrailOutputMetadata = exports.GuardrailOutput = exports.getGuardrailInputMetadata = exports.GuardrailInput = exports.GuardrailInterceptor = exports.GuardrailPipe = exports.GuardrailsService = exports.GUARDRAILS_SERVICE_TOKEN = exports.GuardrailsModule = void 0;
 var guardrails_module_1 = require("./guardrails.module");
 Object.defineProperty(exports, "GuardrailsModule", { enumerable: true, get: function () { return guardrails_module_1.GuardrailsModule; } });
 Object.defineProperty(exports, "GUARDRAILS_SERVICE_TOKEN", { enumerable: true, get: function () { return guardrails_module_1.GUARDRAILS_SERVICE_TOKEN; } });
@@ -21,3 +21,12 @@ Object.defineProperty(exports, "GuardrailOutput", { enumerable: true, get: funct
 Object.defineProperty(exports, "getGuardrailOutputMetadata", { enumerable: true, get: function () { return guardrail_output_decorator_1.getGuardrailOutputMetadata; } });
 var guardrail_violation_error_1 = require("./errors/guardrail-violation.error");
 Object.defineProperty(exports, "GuardrailViolationError", { enumerable: true, get: function () { return guardrail_violation_error_1.GuardrailViolationError; } });
+var hallucination_check_1 = require("./checks/hallucination.check");
+Object.defineProperty(exports, "checkHallucinationHeuristic", { enumerable: true, get: function () { return hallucination_check_1.checkHallucinationHeuristic; } });
+var pii_check_1 = require("./checks/pii.check");
+Object.defineProperty(exports, "detectPII", { enumerable: true, get: function () { return pii_check_1.detectPII; } });
+Object.defineProperty(exports, "redactPII", { enumerable: true, get: function () { return pii_check_1.redactPII; } });
+var injection_check_1 = require("./checks/injection.check");
+Object.defineProperty(exports, "checkPromptInjection", { enumerable: true, get: function () { return injection_check_1.checkPromptInjection; } });
+var toxicity_check_1 = require("./checks/toxicity.check");
+Object.defineProperty(exports, "checkToxicity", { enumerable: true, get: function () { return toxicity_check_1.checkToxicity; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hazeljs/guardrails",
-  "version": "0.7.9",
+  "version": "0.8.1",
   "description": "Content safety, PII handling, and output validation for HazelJS AI applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -53,5 +53,5 @@
   "peerDependencies": {
     "@hazeljs/core": ">=0.2.0-beta.0"
   },
-  "gitHead": "28c21c509aeca3bf2d0878fbee737d906b654c67"
+  "gitHead": "8b7685d1250c4622f25d83992f58e13a59bb3dba"
 }