@nest-yalc-2/sentinel 2.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.
Files changed (48) hide show
  1. package/LICENSE +661 -0
  2. package/README.md +84 -0
  3. package/package.json +35 -0
  4. package/src/__tests__/sentinel.spec.ts +91 -0
  5. package/src/algorithms/ai-guardrails.d.ts +18 -0
  6. package/src/algorithms/ai-guardrails.js +57 -0
  7. package/src/algorithms/ai-guardrails.js.map +1 -0
  8. package/src/algorithms/ai-guardrails.ts +72 -0
  9. package/src/algorithms/lsass-guard.d.ts +15 -0
  10. package/src/algorithms/lsass-guard.js +24 -0
  11. package/src/algorithms/lsass-guard.js.map +1 -0
  12. package/src/algorithms/lsass-guard.ts +43 -0
  13. package/src/algorithms/markov-sequence.d.ts +11 -0
  14. package/src/algorithms/markov-sequence.js +44 -0
  15. package/src/algorithms/markov-sequence.js.map +1 -0
  16. package/src/algorithms/markov-sequence.ts +64 -0
  17. package/src/algorithms/polymorphic-routes.d.ts +18 -0
  18. package/src/algorithms/polymorphic-routes.js +56 -0
  19. package/src/algorithms/polymorphic-routes.js.map +1 -0
  20. package/src/algorithms/polymorphic-routes.ts +89 -0
  21. package/src/algorithms/rag-groundedness.d.ts +9 -0
  22. package/src/algorithms/rag-groundedness.js +55 -0
  23. package/src/algorithms/rag-groundedness.js.map +1 -0
  24. package/src/algorithms/rag-groundedness.ts +80 -0
  25. package/src/algorithms/sbom-verifier.d.ts +19 -0
  26. package/src/algorithms/sbom-verifier.js +44 -0
  27. package/src/algorithms/sbom-verifier.js.map +1 -0
  28. package/src/algorithms/sbom-verifier.ts +65 -0
  29. package/src/algorithms/shannon-entropy.d.ts +8 -0
  30. package/src/algorithms/shannon-entropy.js +31 -0
  31. package/src/algorithms/shannon-entropy.js.map +1 -0
  32. package/src/algorithms/shannon-entropy.ts +46 -0
  33. package/src/index.d.ts +10 -0
  34. package/src/index.js +14 -0
  35. package/src/index.js.map +1 -0
  36. package/src/index.ts +15 -0
  37. package/src/sentinel.guard.d.ts +4 -0
  38. package/src/sentinel.guard.js +28 -0
  39. package/src/sentinel.guard.js.map +1 -0
  40. package/src/sentinel.guard.ts +34 -0
  41. package/src/sentinel.interceptor.d.ts +7 -0
  42. package/src/sentinel.interceptor.js +31 -0
  43. package/src/sentinel.interceptor.js.map +1 -0
  44. package/src/sentinel.interceptor.ts +38 -0
  45. package/src/sentinel.module.d.ts +9 -0
  46. package/src/sentinel.module.js +28 -0
  47. package/src/sentinel.module.js.map +1 -0
  48. package/src/sentinel.module.ts +30 -0
@@ -0,0 +1,38 @@
1
+ /**
2
+ * # NestJS Ferrox-Node RAG Groundedness & Response Interceptor (`sentinel.interceptor.ts`)
3
+ * Evaluates LLM generated response groundedness against retrieved context
4
+ */
5
+
6
+ import { Injectable, NestInterceptor, ExecutionContext, CallHandler, BadGatewayException } from '@nestjs/common';
7
+ import { Observable } from 'rxjs';
8
+ import { map } from 'rxjs/operators';
9
+ import { RagHallucinationGroundednessEngine } from './algorithms/rag-groundedness.js';
10
+
11
+ @Injectable()
12
+ export class RagGroundednessInterceptor implements NestInterceptor {
13
+ constructor(private readonly minGroundednessScore: number = 0.70) {}
14
+
15
+ intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
16
+ const request = context.switchToHttp().getRequest();
17
+ const retrievedContexts: string[] = request.ragContexts || [];
18
+
19
+ return next.handle().pipe(
20
+ map((response) => {
21
+ if (typeof response === 'string' && retrievedContexts.length > 0) {
22
+ const assessment = RagHallucinationGroundednessEngine.evaluateGroundedness(
23
+ response,
24
+ retrievedContexts,
25
+ this.minGroundednessScore
26
+ );
27
+
28
+ if (!assessment.isGrounded) {
29
+ throw new BadGatewayException(
30
+ `[FerroxSentinel] LLM response failed groundedness check (Score: ${assessment.groundednessScore.toFixed(2)} < ${this.minGroundednessScore})`
31
+ );
32
+ }
33
+ }
34
+ return response;
35
+ })
36
+ );
37
+ }
38
+ }
@@ -0,0 +1,9 @@
1
+ import { DynamicModule } from '@nestjs/common';
2
+ export interface SentinelModuleOptions {
3
+ enablePromptSanitizer?: boolean;
4
+ enableEntropyCheck?: boolean;
5
+ minGroundednessScore?: number;
6
+ }
7
+ export declare class FerroxSentinelModule {
8
+ static register(options?: SentinelModuleOptions): DynamicModule;
9
+ }
@@ -0,0 +1,28 @@
1
+ "use strict";
2
+ var FerroxSentinelModule_1;
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.FerroxSentinelModule = void 0;
5
+ const tslib_1 = require("tslib");
6
+ const common_1 = require("@nestjs/common");
7
+ const sentinel_guard_js_1 = require("./sentinel.guard.js");
8
+ const sentinel_interceptor_js_1 = require("./sentinel.interceptor.js");
9
+ let FerroxSentinelModule = FerroxSentinelModule_1 = class FerroxSentinelModule {
10
+ static register(options = {}) {
11
+ return {
12
+ module: FerroxSentinelModule_1,
13
+ providers: [
14
+ sentinel_guard_js_1.FerroxSentinelGuard,
15
+ {
16
+ provide: sentinel_interceptor_js_1.RagGroundednessInterceptor,
17
+ useValue: new sentinel_interceptor_js_1.RagGroundednessInterceptor(options.minGroundednessScore ?? 0.70),
18
+ },
19
+ ],
20
+ exports: [sentinel_guard_js_1.FerroxSentinelGuard, sentinel_interceptor_js_1.RagGroundednessInterceptor],
21
+ };
22
+ }
23
+ };
24
+ exports.FerroxSentinelModule = FerroxSentinelModule;
25
+ exports.FerroxSentinelModule = FerroxSentinelModule = FerroxSentinelModule_1 = tslib_1.__decorate([
26
+ (0, common_1.Module)({})
27
+ ], FerroxSentinelModule);
28
+ //# sourceMappingURL=sentinel.module.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sentinel.module.js","sourceRoot":"","sources":["sentinel.module.ts"],"names":[],"mappings":";;;;;AAIA,2CAAuD;AACvD,2DAA0D;AAC1D,uEAAuE;AAShE,IAAM,oBAAoB,4BAA1B,MAAM,oBAAoB;IAC/B,MAAM,CAAC,QAAQ,CAAC,UAAiC,EAAE;QACjD,OAAO;YACL,MAAM,EAAE,sBAAoB;YAC5B,SAAS,EAAE;gBACT,uCAAmB;gBACnB;oBACE,OAAO,EAAE,oDAA0B;oBACnC,QAAQ,EAAE,IAAI,oDAA0B,CAAC,OAAO,CAAC,oBAAoB,IAAI,IAAI,CAAC;iBAC/E;aACF;YACD,OAAO,EAAE,CAAC,uCAAmB,EAAE,oDAA0B,CAAC;SAC3D,CAAC;IACJ,CAAC;CACF,CAAA;AAdY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,oBAAoB,CAchC"}
@@ -0,0 +1,30 @@
1
+ /**
2
+ * # NestJS Ferrox-Node Sentinel Module (`sentinel.module.ts`)
3
+ */
4
+
5
+ import { Module, DynamicModule } from '@nestjs/common';
6
+ import { FerroxSentinelGuard } from './sentinel.guard.js';
7
+ import { RagGroundednessInterceptor } from './sentinel.interceptor.js';
8
+
9
+ export interface SentinelModuleOptions {
10
+ enablePromptSanitizer?: boolean;
11
+ enableEntropyCheck?: boolean;
12
+ minGroundednessScore?: number;
13
+ }
14
+
15
+ @Module({})
16
+ export class FerroxSentinelModule {
17
+ static register(options: SentinelModuleOptions = {}): DynamicModule {
18
+ return {
19
+ module: FerroxSentinelModule,
20
+ providers: [
21
+ FerroxSentinelGuard,
22
+ {
23
+ provide: RagGroundednessInterceptor,
24
+ useValue: new RagGroundednessInterceptor(options.minGroundednessScore ?? 0.70),
25
+ },
26
+ ],
27
+ exports: [FerroxSentinelGuard, RagGroundednessInterceptor],
28
+ };
29
+ }
30
+ }