@silmaril-security/sdk 0.7.7 → 0.7.9

package/dist/index.js

@@ -14,6 +14,19 @@ var __export = (target, all) => {
 };
 
 // src/exceptions.ts
+function isReviewCompatibilityError(error) {
+  if (typeof error !== "object" && typeof error !== "function" || error === null) {
+    return false;
+  }
+  try {
+    return Object.getOwnPropertyDescriptor(
+      error,
+      REVIEW_COMPATIBILITY_ERROR_BRAND
+    )?.value === true;
+  } catch {
+    return false;
+  }
+}
 function parseErrorBody(body) {
   try {
     const parsed = JSON.parse(body);
@@ -30,7 +43,7 @@ function parseErrorBody(body) {
     return { details: void 0, error: void 0, apiMessage: void 0 };
   }
 }
-var MAX_PROMPT_DISPLAY_LEN, FirewallBlockedException, PromptBlockedException, SilmarilApiError;
+var MAX_PROMPT_DISPLAY_LEN, FirewallBlockedException, PromptBlockedException, REVIEW_COMPATIBILITY_ERROR_BRAND, ReviewCompatibilityError, SilmarilApiError;
 var init_exceptions = __esm({
   "src/exceptions.ts"() {
     "use strict";
@@ -66,6 +79,27 @@ var init_exceptions = __esm({
       }
     };
     PromptBlockedException = FirewallBlockedException;
+    REVIEW_COMPATIBILITY_ERROR_BRAND = /* @__PURE__ */ Symbol.for(
+      "@silmaril-security/sdk/ReviewCompatibilityError"
+    );
+    ReviewCompatibilityError = class _ReviewCompatibilityError extends Error {
+      requestedReview;
+      acknowledgedReview;
+      constructor(requestedReview, acknowledgedReview) {
+        const detail = acknowledgedReview === void 0 ? "the response omitted its acknowledgement" : "the response acknowledgement did not match";
+        super(`Silmaril review compatibility error: ${detail} for requested ${requestedReview} review`);
+        this.name = "ReviewCompatibilityError";
+        this.requestedReview = requestedReview;
+        this.acknowledgedReview = acknowledgedReview;
+        Object.defineProperty(this, REVIEW_COMPATIBILITY_ERROR_BRAND, {
+          value: true,
+          enumerable: false,
+          configurable: false,
+          writable: false
+        });
+        Object.setPrototypeOf(this, _ReviewCompatibilityError.prototype);
+      }
+    };
     SilmarilApiError = class _SilmarilApiError extends Error {
       status;
       statusText;
@@ -174,6 +208,19 @@ var init_hooks = __esm({
   }
 });
 
+// src/modes.ts
+function validateMode(value) {
+  if (value === void 0 || value === "shadow" || value === "warn" || value === "block") {
+    return value;
+  }
+  throw new Error("Firewall: mode must be shadow, warn, or block");
+}
+var init_modes = __esm({
+  "src/modes.ts"() {
+    "use strict";
+  }
+});
+
 // src/utils/extract.ts
 function extractTextFromPrompts(prompts) {
   return prompts.map((p) => p.trim()).filter((p) => p.length > 0).join("\n");
@@ -257,7 +304,7 @@ async function createLangChainHandler(firewall, options = {}) {
   const logger = options.logger ?? ((message, error) => {
     console.warn(`silmaril.firewall: ${message}`, error);
   });
-  const requestedMode = options.mode ?? (options.shadowMode === void 0 ? firewall.mode : options.shadowMode ? "shadow" : "block");
+  const requestedMode = validateMode(options.mode) ?? (options.shadowMode === void 0 ? firewall.mode : options.shadowMode ? "shadow" : "block");
   const onClassify = options.onClassify;
   const fireOnClassify = (event) => {
     if (!onClassify) {
@@ -282,6 +329,9 @@ async function createLangChainHandler(firewall, options = {}) {
         ...toolName !== void 0 ? { toolName } : {}
       });
     } catch (err) {
+      if (isReviewCompatibilityError(err)) {
+        throw err;
+      }
       if (!failOpen) {
         throw err;
       }
@@ -413,6 +463,7 @@ var init_langchain = __esm({
     "use strict";
     init_exceptions();
     init_hooks();
+    init_modes();
     init_extract();
     USER_ROLES = /* @__PURE__ */ new Set(["human", "user"]);
   }
@@ -424,6 +475,7 @@ import { randomUUID } from "crypto";
 // src/adapters/vercel.ts
 init_exceptions();
 init_hooks();
+init_modes();
 function stringifyToolValue(value) {
   if (value === null || value === void 0) {
     return "";
@@ -499,7 +551,7 @@ function findLastUserMessage(messages) {
 function createMiddleware(firewall, options = {}) {
   const scanInput = options.scanInput ?? true;
   const scanOutput = options.scanOutput ?? false;
-  const requestedMode = options.mode ?? (options.shadowMode === void 0 ? firewall.mode : options.shadowMode ? "shadow" : "block");
+  const requestedMode = validateMode(options.mode) ?? (options.shadowMode === void 0 ? firewall.mode : options.shadowMode ? "shadow" : "block");
   const classifyOrBlock = async (text, hook, context = { toolName: void 0, toolCallId: void 0 }) => {
     if (!text.trim()) {
       return;
@@ -644,6 +696,7 @@ function createMiddleware(firewall, options = {}) {
 
 // src/firewall.ts
 init_exceptions();
+init_modes();
 
 // src/outcomes.ts
 var Outcome = {
@@ -766,12 +819,32 @@ function sanitizeText(text) {
 }
 
 // src/firewall.ts
-var SDK_VERSION = "0.7.7";
+var SDK_VERSION = "0.7.9";
 var DEFAULT_TIMEOUT_MS = 1e4;
 var DEFAULT_MAX_RETRIES = 5;
 var MAX_BACKOFF_SECONDS = 30;
 var MAX_ERROR_BODY_BYTES = 1 << 16;
 var MAX_TIMEOUT_MS = 2147483647;
+function validateReview(value, name) {
+  if (value === void 0) {
+    return void 0;
+  }
+  if (value !== "standard" && value !== "deep") {
+    throw new Error(`Firewall: ${name} must be standard or deep`);
+  }
+  return value;
+}
+function resolveReview(perCallReview, clientReview) {
+  return perCallReview === void 0 ? clientReview : validateReview(perCallReview, "review");
+}
+function verifyReviewAcknowledgement(acknowledgedReview, requestedReview) {
+  if (requestedReview !== void 0 && acknowledgedReview !== requestedReview) {
+    throw new ReviewCompatibilityError(requestedReview, acknowledgedReview);
+  }
+}
+function reviewAcknowledgementFromResponse(response) {
+  return isRecord2(response) ? response.review : void 0;
+}
 function resolveMode(value, requestedMode) {
   let responseMode;
   if (value === "shadow" || value === "warn" || value === "block") {
@@ -784,7 +857,7 @@ function resolveMode(value, requestedMode) {
 function legacyMode(shadowMode) {
   return shadowMode === void 0 ? void 0 : shadowMode ? "shadow" : "block";
 }
-function blockResultFromResponse(data, requestedMode) {
+function blockResultFromResponse(data, requestedMode, requestedReview) {
   if (data.prediction !== "BENIGN" && data.prediction !== "MALICIOUS") {
     throw new Error("Firewall: response prediction must be BENIGN or MALICIOUS");
   }
@@ -793,6 +866,9 @@ function blockResultFromResponse(data, requestedMode) {
     score: Number(data.score),
     threshold: Number(data.threshold)
   };
+  if (requestedReview !== void 0) {
+    result.review = requestedReview;
+  }
   const mode = resolveMode(data.mode, requestedMode);
   if (mode !== void 0) {
     result.mode = mode;
@@ -1067,6 +1143,7 @@ var Firewall = class {
   timeoutMs;
   shadowMode;
   mode;
+  review;
   headers;
   constructor(options) {
     if (!options.apiKey) {
@@ -1086,7 +1163,8 @@ var Firewall = class {
         `Firewall: timeoutMs must be at most ${MAX_TIMEOUT_MS} ms, got ${this.timeoutMs}`
       );
     }
-    this.mode = options.mode ?? legacyMode(options.shadowMode);
+    this.mode = validateMode(options.mode) ?? legacyMode(options.shadowMode);
+    this.review = validateReview(options.review, "review");
     this.shadowMode = this.mode === "shadow";
     this.headers = Object.freeze({
       "x-api-key": this.apiKey,
@@ -1125,10 +1203,14 @@ var Firewall = class {
     const payload = {
       texts: texts.map((text) => sanitizeText(text))
     };
-    const requestedMode = options.mode ?? this.mode;
+    const requestedMode = validateMode(options.mode) ?? this.mode;
+    const requestedReview = resolveReview(options.review, this.review);
     if (requestedMode !== void 0) {
       payload.mode = requestedMode;
     }
+    if (requestedReview !== void 0) {
+      payload.review = requestedReview;
+    }
     if (options.hooks && options.hooks.length > 0) {
       payload.hooks = options.hooks.map((h) => String(h));
     }
@@ -1148,6 +1230,7 @@ var Firewall = class {
       );
     }
     const data = await this.postWithRetry(payload, options.signal);
+    verifyReviewAcknowledgement(reviewAcknowledgementFromResponse(data), requestedReview);
     if (!Array.isArray(data.predictions)) {
       throw new Error("Firewall: response predictions must be an array");
     }
@@ -1156,7 +1239,9 @@ var Firewall = class {
         `Firewall: response predictions length ${data.predictions.length} does not match submitted texts length ${payload.texts.length}`
       );
     }
-    return data.predictions.map((p) => blockResultFromResponse(p, requestedMode));
+    return data.predictions.map(
+      (p) => blockResultFromResponse(p, requestedMode, requestedReview)
+    );
   }
   asLangChainHandler(options = {}) {
     return Promise.resolve().then(() => (init_langchain(), langchain_exports)).then(
@@ -1205,10 +1290,14 @@ var Firewall = class {
   }
   async classifySingle(text, options, metadataInfo) {
     const payload = { text };
-    const requestedMode = options.mode ?? this.mode;
+    const requestedMode = validateMode(options.mode) ?? this.mode;
+    const requestedReview = resolveReview(options.review, this.review);
     if (requestedMode !== void 0) {
       payload.mode = requestedMode;
     }
+    if (requestedReview !== void 0) {
+      payload.review = requestedReview;
+    }
     if (options.hook !== void 0) {
       payload.hook = options.hook;
     }
@@ -1223,7 +1312,8 @@ var Firewall = class {
       ...options.governance === void 0 ? {} : { governance: options.governance }
     });
     const data = await this.postWithRetry(payload, options.signal);
-    return blockResultFromResponse(data, requestedMode);
+    verifyReviewAcknowledgement(reviewAcknowledgementFromResponse(data), requestedReview);
+    return blockResultFromResponse(data, requestedMode, requestedReview);
   }
 };
 
@@ -1246,6 +1336,7 @@ export {
   Outcome,
   PRIMARY_OUTCOMES,
   PromptBlockedException,
+  ReviewCompatibilityError,
   SilmarilApiError,
   isHarmfulOutcome,
   isPrimaryOutcome,