guardrail-plug-sdk 1.0.2 → 1.0.3

package/dist/Guardrail.d.ts

@@ -18,4 +18,13 @@ export declare class Guardrail {
      */
     chat(request: SDKChatRequest): Promise<SDKChatResponse>;
 }
+/**
+ * Wraps an OpenAI client instance so its chat completions are automatically
+ * audited and secured by the Guardrail Middleware Gateway.
+ */
+export declare function wrapOpenAI(openaiClient: any, options: GuardrailOptions): any;
+/**
+ * Express Middleware to intercept, scan, and secure incoming chatbot routes.
+ */
+export declare function guardrailExpress(options: GuardrailOptions): (req: any, res: any, next: any) => Promise<any>;
 //# sourceMappingURL=Guardrail.d.ts.map

package/dist/Guardrail.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Guardrail.d.ts","sourceRoot":"","sources":["../src/Guardrail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7D,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;IAC5D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,qBAAa,SAAS;IACpB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,eAAe,CAAS;gBAEpB,OAAO,EAAE,gBAAgB;IAYrC;;OAEG;IACG,IAAI,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;CA8B9D"}
+{"version":3,"file":"Guardrail.d.ts","sourceRoot":"","sources":["../src/Guardrail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7D,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;IAC5D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,qBAAa,SAAS;IACpB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,eAAe,CAAS;gBAEpB,OAAO,EAAE,gBAAgB;IAYrC;;OAEG;IACG,IAAI,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;CA+B9D;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,YAAY,EAAE,GAAG,EAAE,OAAO,EAAE,gBAAgB,OAkCtE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,IAG1C,KAAK,GAAG,EAAE,KAAK,GAAG,EAAE,MAAM,GAAG,kBA+B5C"}

package/dist/Guardrail.js

@@ -32,7 +32,8 @@ export class Guardrail {
                     provider: request.provider || this.provider,
                     model: request.model || this.model,
                     applicationName: request.applicationName || this.applicationName,
-                    metadata: request.metadata || {}
+                    metadata: request.metadata || {},
+                    groundingSource: request.groundingSource || 'kb'
                 })
             });
             if (!response.ok) {
@@ -47,4 +48,74 @@ export class Guardrail {
         }
     }
 }
+/**
+ * Wraps an OpenAI client instance so its chat completions are automatically
+ * audited and secured by the Guardrail Middleware Gateway.
+ */
+export function wrapOpenAI(openaiClient, options) {
+    const guardrail = new Guardrail(options);
+    if (openaiClient?.chat?.completions) {
+        const originalCreate = openaiClient.chat.completions.create.bind(openaiClient.chat.completions);
+        openaiClient.chat.completions.create = async function (params, requestOptions) {
+            const res = await guardrail.chat({
+                messages: params.messages,
+                model: params.model || options.model,
+                provider: 'openai',
+                applicationName: options.applicationName,
+                metadata: { originalParams: params }
+            });
+            return {
+                id: res.auditId,
+                object: 'chat.completion',
+                created: Math.floor(Date.now() / 1000),
+                model: params.model,
+                choices: [{
+                        index: 0,
+                        message: { role: 'assistant', content: res.text },
+                        finish_reason: res.decision === 'BLOCKED' ? 'content_filter' : 'stop'
+                    }],
+                usage: {
+                    prompt_tokens: res.metrics?.tokenUsage?.promptTokens || 0,
+                    completion_tokens: res.metrics?.tokenUsage?.completionTokens || 0,
+                    total_tokens: res.metrics?.tokenUsage?.totalTokens || 0
+                }
+            };
+        };
+    }
+    return openaiClient;
+}
+/**
+ * Express Middleware to intercept, scan, and secure incoming chatbot routes.
+ */
+export function guardrailExpress(options) {
+    const guardrail = new Guardrail(options);
+    return async (req, res, next) => {
+        try {
+            const messages = req.body.messages;
+            if (!messages || !Array.isArray(messages)) {
+                return next();
+            }
+            const auditRes = await guardrail.chat({
+                messages,
+                userId: req.body.userId || 'express_user',
+                sessionId: req.body.sessionId || 'express_session',
+                groundingSource: req.body.groundingSource || 'kb'
+            });
+            req.guardrail = auditRes;
+            if (auditRes.decision === 'BLOCKED') {
+                return res.status(400).json({
+                    error: 'Blocked by Guardrail Security Policy',
+                    explanation: auditRes.policyExplanation,
+                    fallbackText: auditRes.text,
+                    auditId: auditRes.auditId
+                });
+            }
+            next();
+        }
+        catch (err) {
+            console.error('[Guardrail Middleware] Audit scan failed:', err.message);
+            next();
+        }
+    };
+}
 //# sourceMappingURL=Guardrail.js.map

package/dist/Guardrail.js.map

@@ -1 +1 @@
-{"version":3,"file":"Guardrail.js","sourceRoot":"","sources":["../src/Guardrail.ts"],"names":[],"mappings":"AAUA,MAAM,OAAO,SAAS;IACZ,QAAQ,CAAS;IACjB,MAAM,CAAS;IACf,QAAQ,CAAS;IACjB,KAAK,CAAS;IACd,eAAe,CAAS;IAEhC,YAAY,OAAyB;QACnC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,uBAAuB,CAAC;QAC5D,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC;QAC7C,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,aAAa,CAAC;QAC5C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,iBAAiB,CAAC;QAEpE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,OAAuB;QAChC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,QAAQ,WAAW,EAAE;gBACxD,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;oBAClC,eAAe,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;iBACzC;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,UAAU;oBACpC,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,aAAa;oBAC7C,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ;oBAC3C,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK;oBAClC,eAAe,EAAE,OAAO,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe;oBAChE,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;iBACjC,CAAC;aACH,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACxC,MAAM,IAAI,KAAK,CAAC,+BAA+B,QAAQ,CAAC,MAAM,MAAM,SAAS,EAAE,CAAC,CAAC;YACnF,CAAC;YAED,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAqB,CAAC;QAClD,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,OAAO,CAAC,KAAK,CAAC,sCAAsC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YACnE,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"Guardrail.js","sourceRoot":"","sources":["../src/Guardrail.ts"],"names":[],"mappings":"AAUA,MAAM,OAAO,SAAS;IACZ,QAAQ,CAAS;IACjB,MAAM,CAAS;IACf,QAAQ,CAAS;IACjB,KAAK,CAAS;IACd,eAAe,CAAS;IAEhC,YAAY,OAAyB;QACnC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,uBAAuB,CAAC;QAC5D,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC;QAC7C,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,aAAa,CAAC;QAC5C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,iBAAiB,CAAC;QAEpE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,OAAuB;QAChC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,QAAQ,WAAW,EAAE;gBACxD,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;oBAClC,eAAe,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;iBACzC;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,UAAU;oBACpC,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,aAAa;oBAC7C,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ;oBAC3C,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK;oBAClC,eAAe,EAAE,OAAO,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe;oBAChE,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;oBAChC,eAAe,EAAE,OAAO,CAAC,eAAe,IAAI,IAAI;iBACjD,CAAC;aACH,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACxC,MAAM,IAAI,KAAK,CAAC,+BAA+B,QAAQ,CAAC,MAAM,MAAM,SAAS,EAAE,CAAC,CAAC;YACnF,CAAC;YAED,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAqB,CAAC;QAClD,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,OAAO,CAAC,KAAK,CAAC,sCAAsC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YACnE,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,YAAiB,EAAE,OAAyB;IACrE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC;IAEzC,IAAI,YAAY,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;QACpC,MAAM,cAAc,GAAG,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAEhG,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,KAAK,WAAU,MAAW,EAAE,cAAoB;YACrF,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC;gBAC/B,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK;gBACpC,QAAQ,EAAE,QAAQ;gBAClB,eAAe,EAAE,OAAO,CAAC,eAAe;gBACxC,QAAQ,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE;aACrC,CAAC,CAAC;YAEH,OAAO;gBACL,EAAE,EAAE,GAAG,CAAC,OAAO;gBACf,MAAM,EAAE,iBAAiB;gBACzB,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;gBACtC,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,OAAO,EAAE,CAAC;wBACR,KAAK,EAAE,CAAC;wBACR,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,CAAC,IAAI,EAAE;wBACjD,aAAa,EAAE,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM;qBACtE,CAAC;gBACF,KAAK,EAAE;oBACL,aAAa,EAAE,GAAG,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,IAAI,CAAC;oBACzD,iBAAiB,EAAE,GAAG,CAAC,OAAO,EAAE,UAAU,EAAE,gBAAgB,IAAI,CAAC;oBACjE,YAAY,EAAE,GAAG,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,IAAI,CAAC;iBACxD;aACF,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAyB;IACxD,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC;IAEzC,OAAO,KAAK,EAAE,GAAQ,EAAE,GAAQ,EAAE,IAAS,EAAE,EAAE;QAC7C,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC;YACnC,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC1C,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC;gBACpC,QAAQ;gBACR,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,cAAc;gBACzC,SAAS,EAAE,GAAG,CAAC,IAAI,CAAC,SAAS,IAAI,iBAAiB;gBAClD,eAAe,EAAE,GAAG,CAAC,IAAI,CAAC,eAAe,IAAI,IAAI;aAClD,CAAC,CAAC;YAEH,GAAG,CAAC,SAAS,GAAG,QAAQ,CAAC;YAEzB,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;gBACpC,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,KAAK,EAAE,sCAAsC;oBAC7C,WAAW,EAAE,QAAQ,CAAC,iBAAiB;oBACvC,YAAY,EAAE,QAAQ,CAAC,IAAI;oBAC3B,OAAO,EAAE,QAAQ,CAAC,OAAO;iBAC1B,CAAC,CAAC;YACL,CAAC;YAED,IAAI,EAAE,CAAC;QACT,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,OAAO,CAAC,KAAK,CAAC,2CAA2C,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YACxE,IAAI,EAAE,CAAC;QACT,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "guardrail-plug-sdk",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A plug-and-play AI Auditing & Hallucination Detection SDK. Intercepts LLM inputs/outputs, verifies factual grounding against your knowledge base, and blocks or flags unverified responses.",
   "type": "module",
   "main": "dist/index.js",

package/src/Guardrail.ts

@@ -45,7 +45,8 @@ export class Guardrail {
           provider: request.provider || this.provider,
           model: request.model || this.model,
           applicationName: request.applicationName || this.applicationName,
-          metadata: request.metadata || {}
+          metadata: request.metadata || {},
+          groundingSource: request.groundingSource || 'kb'
         })
       });
 
@@ -61,3 +62,82 @@ export class Guardrail {
     }
   }
 }
+
+/**
+ * Wraps an OpenAI client instance so its chat completions are automatically
+ * audited and secured by the Guardrail Middleware Gateway.
+ */
+export function wrapOpenAI(openaiClient: any, options: GuardrailOptions) {
+  const guardrail = new Guardrail(options);
+  
+  if (openaiClient?.chat?.completions) {
+    const originalCreate = openaiClient.chat.completions.create.bind(openaiClient.chat.completions);
+    
+    openaiClient.chat.completions.create = async function(params: any, requestOptions?: any) {
+      const res = await guardrail.chat({
+        messages: params.messages,
+        model: params.model || options.model,
+        provider: 'openai',
+        applicationName: options.applicationName,
+        metadata: { originalParams: params }
+      });
+
+      return {
+        id: res.auditId,
+        object: 'chat.completion',
+        created: Math.floor(Date.now() / 1000),
+        model: params.model,
+        choices: [{
+          index: 0,
+          message: { role: 'assistant', content: res.text },
+          finish_reason: res.decision === 'BLOCKED' ? 'content_filter' : 'stop'
+        }],
+        usage: {
+          prompt_tokens: res.metrics?.tokenUsage?.promptTokens || 0,
+          completion_tokens: res.metrics?.tokenUsage?.completionTokens || 0,
+          total_tokens: res.metrics?.tokenUsage?.totalTokens || 0
+        }
+      };
+    };
+  }
+  return openaiClient;
+}
+
+/**
+ * Express Middleware to intercept, scan, and secure incoming chatbot routes.
+ */
+export function guardrailExpress(options: GuardrailOptions) {
+  const guardrail = new Guardrail(options);
+  
+  return async (req: any, res: any, next: any) => {
+    try {
+      const messages = req.body.messages;
+      if (!messages || !Array.isArray(messages)) {
+        return next();
+      }
+      
+      const auditRes = await guardrail.chat({
+        messages,
+        userId: req.body.userId || 'express_user',
+        sessionId: req.body.sessionId || 'express_session',
+        groundingSource: req.body.groundingSource || 'kb'
+      });
+      
+      req.guardrail = auditRes;
+      
+      if (auditRes.decision === 'BLOCKED') {
+        return res.status(400).json({
+          error: 'Blocked by Guardrail Security Policy',
+          explanation: auditRes.policyExplanation,
+          fallbackText: auditRes.text,
+          auditId: auditRes.auditId
+        });
+      }
+      
+      next();
+    } catch (err: any) {
+      console.error('[Guardrail Middleware] Audit scan failed:', err.message);
+      next();
+    }
+  };
+}