@flink-app/flink 2.0.0-alpha.55 → 2.0.0-alpha.56

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @flink-app/flink
 
+## 2.0.0-alpha.56
+
+### Patch Changes
+
+-   Zod 3.x compat
+-   0203256: fix: add Zod 3.x compatibility for tool schema generation
+
+    Tools now work with both Zod 3.25+ and Zod 4.x. The `ToolExecutor` will use:
+
+    -   Zod 4's built-in `z.toJSONSchema()` if available
+    -   `zod-to-json-schema` package for Zod 3.x compatibility (fallback)
+
+    This allows apps to use their preferred Zod version without upgrading to 4.x.
+
+    **Changes:**
+
+    -   Improved `fallbackSchema()` to use `zod-to-json-schema` instead of returning empty schema
+    -   Added Zod as peer dependency (>=3.25.0 <5.0.0) for version flexibility
+    -   Better error handling and logging for schema generation failures
+
+    **Migration:** No action needed - fully backward compatible.
+
 ## 2.0.0-alpha.55
 
 ### Minor Changes

package/dist/src/ai/ToolExecutor.d.ts

@@ -9,7 +9,8 @@ export declare class ToolExecutor<Ctx extends FlinkContext> {
     execute(input: any, user?: any, userPermissions?: string[]): Promise<ToolResult<any>>;
     getToolSchema(): FlinkToolSchema;
     /**
-     * Fallback schema generation if toJSONSchema is not available
+     * Fallback schema generation for Zod 3.x compatibility
+     * Uses zod-to-json-schema package which supports both Zod 3.x and 4.x
      */
     private fallbackSchema;
     /**

package/dist/src/ai/ToolExecutor.js

@@ -35,6 +35,17 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ToolExecutor = void 0;
 var FlinkLog_1 = require("../FlinkLog");
@@ -123,7 +134,7 @@ var ToolExecutor = /** @class */ (function () {
         });
     };
     ToolExecutor.prototype.getToolSchema = function () {
-        // Use Zod 4's built-in z.toJSONSchema()
+        // Use Zod 4's built-in z.toJSONSchema() if available, otherwise use zod-to-json-schema (Zod 3.x support)
         var zodSchema = this.toolProps.inputSchema;
         var z = require("zod");
         return {
@@ -133,16 +144,28 @@ var ToolExecutor = /** @class */ (function () {
         };
     };
     /**
-     * Fallback schema generation if toJSONSchema is not available
+     * Fallback schema generation for Zod 3.x compatibility
+     * Uses zod-to-json-schema package which supports both Zod 3.x and 4.x
      */
     ToolExecutor.prototype.fallbackSchema = function (zodSchema) {
-        // Try to use _def to extract basic schema info
-        FlinkLog_1.log.warn("Tool ".concat(this.toolProps.id, ": z.toJSONSchema() not available, using fallback schema generation"));
-        return {
-            type: "object",
-            properties: {},
-            required: [],
-        };
+        try {
+            // Use zod-to-json-schema for Zod 3.x compatibility
+            var zodToJsonSchema = require("zod-to-json-schema").zodToJsonSchema;
+            var jsonSchema = zodToJsonSchema(zodSchema, { target: "openApi3" });
+            // Remove top-level $schema field that zod-to-json-schema adds (not needed for tool schemas)
+            var _a = jsonSchema, $schema = _a.$schema, schemaWithoutMeta = __rest(_a, ["$schema"]);
+            FlinkLog_1.log.debug("Tool ".concat(this.toolProps.id, ": Using zod-to-json-schema for Zod 3.x compatibility"));
+            return schemaWithoutMeta;
+        }
+        catch (err) {
+            FlinkLog_1.log.error("Tool ".concat(this.toolProps.id, ": Failed to generate JSON Schema from Zod schema:"), err.message);
+            // Last resort fallback - return minimal valid schema
+            return {
+                type: "object",
+                properties: {},
+                required: [],
+            };
+        }
     };
     /**
      * Get tool result for AI consumption

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flink-app/flink",
-  "version": "2.0.0-alpha.55",
+  "version": "2.0.0-alpha.56",
   "description": "Typescript only framework for creating REST-like APIs on top of Express and mongodb",
   "types": "dist/src/index.d.ts",
   "main": "dist/src/index.js",
@@ -68,7 +68,8 @@
     "ts-node": "^10.9.2"
   },
   "peerDependencies": {
-    "mongodb": ">=3.7.0 <7.0.0"
+    "mongodb": ">=3.7.0 <7.0.0",
+    "zod": ">=3.25.0 <5.0.0"
   },
   "gitHead": "4243e3b3cd6d4e1ca001a61baa8436bf2bbe4113",
   "scripts": {

package/spec/mock-project/dist/src/ai/ToolExecutor.js

@@ -35,6 +35,17 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ToolExecutor = void 0;
 var FlinkLog_1 = require("../FlinkLog");
@@ -123,7 +134,7 @@ var ToolExecutor = /** @class */ (function () {
         });
     };
     ToolExecutor.prototype.getToolSchema = function () {
-        // Use Zod 4's built-in z.toJSONSchema()
+        // Use Zod 4's built-in z.toJSONSchema() if available, otherwise use zod-to-json-schema (Zod 3.x support)
         var zodSchema = this.toolProps.inputSchema;
         var z = require("zod");
         return {
@@ -133,16 +144,28 @@ var ToolExecutor = /** @class */ (function () {
         };
     };
     /**
-     * Fallback schema generation if toJSONSchema is not available
+     * Fallback schema generation for Zod 3.x compatibility
+     * Uses zod-to-json-schema package which supports both Zod 3.x and 4.x
      */
     ToolExecutor.prototype.fallbackSchema = function (zodSchema) {
-        // Try to use _def to extract basic schema info
-        FlinkLog_1.log.warn("Tool ".concat(this.toolProps.id, ": z.toJSONSchema() not available, using fallback schema generation"));
-        return {
-            type: "object",
-            properties: {},
-            required: [],
-        };
+        try {
+            // Use zod-to-json-schema for Zod 3.x compatibility
+            var zodToJsonSchema = require("zod-to-json-schema").zodToJsonSchema;
+            var jsonSchema = zodToJsonSchema(zodSchema, { target: "openApi3" });
+            // Remove top-level $schema field that zod-to-json-schema adds (not needed for tool schemas)
+            var _a = jsonSchema, $schema = _a.$schema, schemaWithoutMeta = __rest(_a, ["$schema"]);
+            FlinkLog_1.log.debug("Tool ".concat(this.toolProps.id, ": Using zod-to-json-schema for Zod 3.x compatibility"));
+            return schemaWithoutMeta;
+        }
+        catch (err) {
+            FlinkLog_1.log.error("Tool ".concat(this.toolProps.id, ": Failed to generate JSON Schema from Zod schema:"), err.message);
+            // Last resort fallback - return minimal valid schema
+            return {
+                type: "object",
+                properties: {},
+                required: [],
+            };
+        }
     };
     /**
      * Get tool result for AI consumption

package/src/ai/ToolExecutor.ts

@@ -83,7 +83,7 @@ export class ToolExecutor<Ctx extends FlinkContext> {
     }
 
     getToolSchema(): FlinkToolSchema {
-        // Use Zod 4's built-in z.toJSONSchema()
+        // Use Zod 4's built-in z.toJSONSchema() if available, otherwise use zod-to-json-schema (Zod 3.x support)
         const zodSchema = this.toolProps.inputSchema;
         const z = require("zod") as any;
 
@@ -95,16 +95,29 @@ export class ToolExecutor<Ctx extends FlinkContext> {
     }
 
     /**
-     * Fallback schema generation if toJSONSchema is not available
+     * Fallback schema generation for Zod 3.x compatibility
+     * Uses zod-to-json-schema package which supports both Zod 3.x and 4.x
      */
     private fallbackSchema(zodSchema: any): any {
-        // Try to use _def to extract basic schema info
-        log.warn(`Tool ${this.toolProps.id}: z.toJSONSchema() not available, using fallback schema generation`);
-        return {
-            type: "object",
-            properties: {},
-            required: [],
-        };
+        try {
+            // Use zod-to-json-schema for Zod 3.x compatibility
+            const { zodToJsonSchema } = require("zod-to-json-schema");
+            const jsonSchema = zodToJsonSchema(zodSchema, { target: "openApi3" });
+
+            // Remove top-level $schema field that zod-to-json-schema adds (not needed for tool schemas)
+            const { $schema, ...schemaWithoutMeta } = jsonSchema as any;
+
+            log.debug(`Tool ${this.toolProps.id}: Using zod-to-json-schema for Zod 3.x compatibility`);
+            return schemaWithoutMeta;
+        } catch (err: any) {
+            log.error(`Tool ${this.toolProps.id}: Failed to generate JSON Schema from Zod schema:`, err.message);
+            // Last resort fallback - return minimal valid schema
+            return {
+                type: "object",
+                properties: {},
+                required: [],
+            };
+        }
     }
 
     /**