@node-llm/core 1.14.1 → 1.15.1

package/dist/middlewares/SchemaSelfCorrection.d.ts

@@ -0,0 +1,26 @@
+import { Middleware, MiddlewareContext, RequestDirective } from "../types/Middleware.js";
+import { ChatResponseString } from "../chat/ChatResponse.js";
+import { ToolCall } from "../chat/Tool.js";
+export interface SchemaSelfCorrectionOptions {
+    /**
+     * Maximum number of correction attempts.
+     * Default is 2.
+     */
+    maxRetries?: number;
+}
+/**
+ * Middleware that automatically detects schema validation errors in structured outputs
+ * and re-prompts the model with specific feedback.
+ */
+export declare class SchemaSelfCorrectionMiddleware implements Middleware {
+    readonly name = "SchemaSelfCorrection";
+    private readonly maxRetries;
+    constructor(options?: SchemaSelfCorrectionOptions);
+    onResponse(ctx: MiddlewareContext, result: ChatResponseString): Promise<RequestDirective>;
+    onToolCallError(ctx: MiddlewareContext, toolCall: ToolCall, error: unknown): Promise<"CONTINUE" | "STOP" | "RETRY">;
+}
+/**
+ * Factory function for creating the self-correction middleware.
+ */
+export declare function SchemaSelfCorrection(options?: SchemaSelfCorrectionOptions): SchemaSelfCorrectionMiddleware;
+//# sourceMappingURL=SchemaSelfCorrection.d.ts.map

package/dist/middlewares/SchemaSelfCorrection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaSelfCorrection.d.ts","sourceRoot":"","sources":["../../src/middlewares/SchemaSelfCorrection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAG3C,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,qBAAa,8BAA+B,YAAW,UAAU;IAC/D,SAAgB,IAAI,0BAA0B;IAC9C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;gBAExB,OAAO,GAAE,2BAAgC;IAI/C,UAAU,CAAC,GAAG,EAAE,iBAAiB,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA+CzF,eAAe,CACnB,GAAG,EAAE,iBAAiB,EACtB,QAAQ,EAAE,QAAQ,EAClB,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC;CAwB1C;AACD;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,GAAE,2BAAgC,GACxC,8BAA8B,CAEhC"}

package/dist/middlewares/SchemaSelfCorrection.js

@@ -0,0 +1,70 @@
+import { logger } from "../utils/logger.js";
+/**
+ * Middleware that automatically detects schema validation errors in structured outputs
+ * and re-prompts the model with specific feedback.
+ */
+export class SchemaSelfCorrectionMiddleware {
+    name = "SchemaSelfCorrection";
+    maxRetries;
+    constructor(options = {}) {
+        this.maxRetries = options.maxRetries ?? 2;
+    }
+    async onResponse(ctx, result) {
+        // Only apply if a schema was provided
+        if (!ctx.options?.schema) {
+            return "CONTINUE";
+        }
+        // Check if valid
+        if (result.isValid) {
+            return "CONTINUE";
+        }
+        // It's invalid. Get the error.
+        const error = result.validationError;
+        if (!error) {
+            return "CONTINUE";
+        }
+        // Keep track of correction rounds in context state
+        const currentRounds = ctx.state.correctionRounds || 0;
+        if (currentRounds < this.maxRetries) {
+            ctx.state.correctionRounds = currentRounds + 1;
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            logger.warn(`[SchemaSelfCorrection] Validation failed for ${ctx.provider}/${ctx.model}. ` +
+                `Round ${currentRounds + 1}/${this.maxRetries}. Error: ${errorMessage}`);
+            // Return RETRY directive with feedback
+            return {
+                action: "RETRY",
+                message: `Your previous response did not match the required JSON schema. 
+Validation Error: ${errorMessage}
+
+Please correct your output to strictly follow the schema and provided types.`
+            };
+        }
+        // If we reached max retries, we just continue (or the user will get the validation error when calling .data)
+        logger.error(`[SchemaSelfCorrection] Max retries (${this.maxRetries}) reached for ${ctx.provider}/${ctx.model}.`);
+        return "CONTINUE";
+    }
+    async onToolCallError(ctx, toolCall, error) {
+        // Check if it's a validation error (ZodError)
+        if (error && typeof error === "object" && "name" in error && error.name === "ZodError") {
+            const currentRounds = ctx.state.correctionRounds || 0;
+            if (currentRounds < this.maxRetries) {
+                ctx.state.correctionRounds = currentRounds + 1;
+                logger.warn(`[SchemaSelfCorrection] Tool validation failed for '${toolCall.function.name}'. ` +
+                    `Round ${currentRounds + 1}/${this.maxRetries}.`);
+                // We return CONTINUE here because Chat.ts already handles pushing the error to history
+                // BUT we could potentially change the error message to be more helpful!
+                // However, Chat.ts currently just takes the error.message.
+                // If we want to override the message, we'd need onToolCallError to return a descriptive RETRY or similar.
+                // Currently Chat.ts's onToolCallError only returns "CONTINUE" | "STOP" | "RETRY".
+                return "CONTINUE";
+            }
+        }
+        return "CONTINUE";
+    }
+}
+/**
+ * Factory function for creating the self-correction middleware.
+ */
+export function SchemaSelfCorrection(options = {}) {
+    return new SchemaSelfCorrectionMiddleware(options);
+}

package/dist/middlewares/UsageLoggerMiddleware.d.ts

@@ -1,4 +1,4 @@
-import { Middleware, MiddlewareContext } from "../types/Middleware.js";
+import { Middleware, MiddlewareContext, RequestDirective } from "../types/Middleware.js";
 import { ChatResponseString } from "../chat/ChatResponse.js";
 export interface UsageLoggerOptions {
     /**
@@ -17,6 +17,10 @@ export declare class UsageLoggerMiddleware implements Middleware {
     private options;
     readonly name = "UsageLogger";
     constructor(options?: UsageLoggerOptions);
-    onResponse(ctx: MiddlewareContext, result: ChatResponseString): Promise<void>;
+    onResponse(ctx: MiddlewareContext, result: ChatResponseString): Promise<RequestDirective>;
 }
+/**
+ * Factory function for creating the usage logger middleware.
+ */
+export declare function UsageLogger(options?: UsageLoggerOptions): UsageLoggerMiddleware;
 //# sourceMappingURL=UsageLoggerMiddleware.d.ts.map

package/dist/middlewares/UsageLoggerMiddleware.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UsageLoggerMiddleware.d.ts","sourceRoot":"","sources":["../../src/middlewares/UsageLoggerMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAG7D,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC;IAC9C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,qBAAa,qBAAsB,YAAW,UAAU;IAG1C,OAAO,CAAC,OAAO;IAF3B,SAAgB,IAAI,iBAAiB;gBAEjB,OAAO,GAAE,kBAAuB;IAE9C,UAAU,CAAC,GAAG,EAAE,iBAAiB,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;CAsBpF"}
+{"version":3,"file":"UsageLoggerMiddleware.d.ts","sourceRoot":"","sources":["../../src/middlewares/UsageLoggerMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAG7D,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC;IAC9C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,qBAAa,qBAAsB,YAAW,UAAU;IAG1C,OAAO,CAAC,OAAO;IAF3B,SAAgB,IAAI,iBAAiB;gBAEjB,OAAO,GAAE,kBAAuB;IAE9C,UAAU,CAAC,GAAG,EAAE,iBAAiB,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAsBhG;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,OAAO,GAAE,kBAAuB,GAAG,qBAAqB,CAEnF"}

package/dist/middlewares/UsageLoggerMiddleware.js

@@ -28,3 +28,9 @@ export class UsageLoggerMiddleware {
         logFn(message, data);
     }
 }
+/**
+ * Factory function for creating the usage logger middleware.
+ */
+export function UsageLogger(options = {}) {
+    return new UsageLoggerMiddleware(options);
+}

package/dist/middlewares/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./UsageLoggerMiddleware.js";
 export * from "./CostGuardMiddleware.js";
 export * from "./PIIMaskMiddleware.js";
+export * from "./SchemaSelfCorrection.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/middlewares/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/middlewares/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/middlewares/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC"}

package/dist/middlewares/index.js

@@ -1,3 +1,4 @@
 export * from "./UsageLoggerMiddleware.js";
 export * from "./CostGuardMiddleware.js";
 export * from "./PIIMaskMiddleware.js";
+export * from "./SchemaSelfCorrection.js";