@flink-app/test-utils 1.0.0 → 2.0.0-alpha.100

package/dist/ai/mockTool.d.ts

@@ -0,0 +1,64 @@
+import { z } from "zod";
+import type { FlinkTool, FlinkToolProps } from "@flink-app/flink/ai";
+export interface MockToolConfig<Input, Output> {
+    name: string;
+    description?: string;
+    inputSchema: z.ZodType<Input>;
+    outputSchema?: z.ZodType<Output>;
+    response?: Output;
+    error?: {
+        error: string;
+        code?: string;
+    };
+    fn?: FlinkTool<any, Input, Output>;
+    permissions?: FlinkToolProps["permissions"];
+}
+export interface MockToolInvocation<Input> {
+    input: Input;
+    user?: any;
+}
+export interface MockToolResult<Input, Output> {
+    props: FlinkToolProps;
+    fn: FlinkTool<any, Input, Output>;
+    invocations: MockToolInvocation<Input>[];
+    getLastInvocation(): MockToolInvocation<Input> | undefined;
+    reset(): void;
+}
+/**
+ * Creates a mock tool with tracking and canned responses
+ *
+ * Features:
+ * - Simple canned responses
+ * - Error simulation
+ * - Custom function support
+ * - Automatic invocation tracking
+ * - Validation helpers
+ *
+ * @example
+ * // Simple canned response
+ * const weatherTool = mockTool({
+ *   name: "get_weather",
+ *   inputSchema: z.object({ city: z.string() }),
+ *   response: { temperature: 22, conditions: "sunny" }
+ * });
+ *
+ * @example
+ * // Custom function with tracking
+ * const calculatorTool = mockTool({
+ *   name: "calculate",
+ *   inputSchema: z.object({ a: z.number(), b: z.number() }),
+ *   fn: async ({ input }) => ({
+ *     success: true,
+ *     data: { result: input.a + input.b }
+ *   })
+ * });
+ *
+ * @example
+ * // Error simulation
+ * const failingTool = mockTool({
+ *   name: "fail",
+ *   inputSchema: z.object({}),
+ *   error: { error: "Tool failed", code: "MOCK_ERROR" }
+ * });
+ */
+export declare function mockTool<Input = any, Output = any>(config: MockToolConfig<Input, Output>): MockToolResult<Input, Output>;

package/dist/ai/mockTool.js

@@ -0,0 +1,133 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockTool = mockTool;
+/**
+ * Creates a mock tool with tracking and canned responses
+ *
+ * Features:
+ * - Simple canned responses
+ * - Error simulation
+ * - Custom function support
+ * - Automatic invocation tracking
+ * - Validation helpers
+ *
+ * @example
+ * // Simple canned response
+ * const weatherTool = mockTool({
+ *   name: "get_weather",
+ *   inputSchema: z.object({ city: z.string() }),
+ *   response: { temperature: 22, conditions: "sunny" }
+ * });
+ *
+ * @example
+ * // Custom function with tracking
+ * const calculatorTool = mockTool({
+ *   name: "calculate",
+ *   inputSchema: z.object({ a: z.number(), b: z.number() }),
+ *   fn: async ({ input }) => ({
+ *     success: true,
+ *     data: { result: input.a + input.b }
+ *   })
+ * });
+ *
+ * @example
+ * // Error simulation
+ * const failingTool = mockTool({
+ *   name: "fail",
+ *   inputSchema: z.object({}),
+ *   error: { error: "Tool failed", code: "MOCK_ERROR" }
+ * });
+ */
+function mockTool(config) {
+    var _this = this;
+    var invocations = [];
+    // Create the tool props
+    var props = {
+        id: config.name,
+        description: config.description || "Mock tool: ".concat(config.name),
+        inputSchema: config.inputSchema,
+        outputSchema: config.outputSchema,
+        permissions: config.permissions,
+    };
+    // Create the tool function with invocation tracking
+    var fn = function (_a) { return __awaiter(_this, [_a], void 0, function (_b) {
+        var input = _b.input, ctx = _b.ctx, user = _b.user;
+        return __generator(this, function (_c) {
+            // Track invocation
+            invocations.push({ input: input, user: user });
+            // If custom function provided, use it
+            if (config.fn) {
+                return [2 /*return*/, config.fn({ input: input, ctx: ctx, user: user })];
+            }
+            // If error configured, return error
+            if (config.error) {
+                return [2 /*return*/, {
+                        success: false,
+                        error: config.error.error,
+                        code: config.error.code,
+                    }];
+            }
+            // If response configured, return success with data
+            if (config.response !== undefined) {
+                return [2 /*return*/, {
+                        success: true,
+                        data: config.response,
+                    }];
+            }
+            // Default: return empty success
+            return [2 /*return*/, {
+                    success: true,
+                    data: {},
+                }];
+        });
+    }); };
+    var getLastInvocation = function () {
+        return invocations[invocations.length - 1];
+    };
+    var reset = function () {
+        invocations.length = 0;
+    };
+    return {
+        props: props,
+        fn: fn,
+        invocations: invocations,
+        getLastInvocation: getLastInvocation,
+        reset: reset,
+    };
+}

package/dist/http.d.ts

@@ -1,4 +1,4 @@
-import { FlinkApp, FlinkResponse } from "@flink-app/flink";
+import { FlinkApp, FlinkContext, FlinkResponse } from "@flink-app/flink";
 export type HttpOpts = {
     /***
      * Optional query string
@@ -26,7 +26,7 @@ export type HttpOpts = {
  * Initializes test flink app.
  * Must be invoked prior to using test HTTP methods.
  */
-export declare function init(_app: FlinkApp<any>, host?: string): void;
+export declare function init<C extends FlinkContext<any>>(_app: FlinkApp<C>, host?: string): void;
 export declare function get<Res = any>(path: string, opts?: HttpOpts): Promise<FlinkResponse<Res>>;
 export declare function post<Req = any, Res = any>(path: string, body: Req, opts?: HttpOpts): Promise<FlinkResponse<Res>>;
 export declare function put<Req = any, Res = any>(path: string, body: Req, opts?: HttpOpts): Promise<FlinkResponse<Res>>;

package/dist/index.d.ts

@@ -1,2 +1,4 @@
 export * from "./http";
 export * from "./mocks";
+export * from "./ai";
+export * from "./requestContext";

package/dist/index.js

@@ -16,3 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./http"), exports);
 __exportStar(require("./mocks"), exports);
+__exportStar(require("./ai"), exports);
+__exportStar(require("./requestContext"), exports);

package/dist/mocks.d.ts

@@ -1,4 +1,4 @@
-import { FlinkAuthPlugin, FlinkRequest } from "@flink-app/flink";
+import { FlinkAuthPlugin, FlinkContext, FlinkRequest } from "@flink-app/flink";
 interface TestFlinkRequest<T, P, Q> extends Omit<Partial<FlinkRequest<T, P, Q>>, "body" | "params" | "query"> {
     body?: T;
     params?: P;
@@ -17,4 +17,17 @@ export declare function mockReq<T, P, Q>(req?: TestFlinkRequest<T, P, Q>): Flink
  * @returns
  */
 export declare function noOpAuthPlugin(): FlinkAuthPlugin;
+/**
+ * Creates a mock FlinkContext with only the parts you need.
+ * Useful for testing services with mocked dependencies.
+ *
+ * @example
+ * ```typescript
+ * const carService = new CarService();
+ * carService.ctx = mockCtx<AppCtx>({
+ *     repos: { carRepo: mockCarRepo },
+ * });
+ * ```
+ */
+export declare function mockCtx<C extends FlinkContext>(partial?: Partial<C>): C;
 export {};

package/dist/mocks.js

@@ -49,6 +49,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mockReq = mockReq;
 exports.noOpAuthPlugin = noOpAuthPlugin;
+exports.mockCtx = mockCtx;
 /**
  * Creates a mocked FlinkRequest object where only essential properties are required.
  * Will convert req body to JSON to ensure the body is a plain object.
@@ -81,3 +82,19 @@ function noOpAuthPlugin() {
         }); }); },
     };
 }
+/**
+ * Creates a mock FlinkContext with only the parts you need.
+ * Useful for testing services with mocked dependencies.
+ *
+ * @example
+ * ```typescript
+ * const carService = new CarService();
+ * carService.ctx = mockCtx<AppCtx>({
+ *     repos: { carRepo: mockCarRepo },
+ * });
+ * ```
+ */
+function mockCtx(partial) {
+    if (partial === void 0) { partial = {}; }
+    return __assign({ repos: {}, plugins: {} }, partial);
+}

package/dist/requestContext.d.ts

@@ -0,0 +1,22 @@
+import { RequestContext } from '@flink-app/flink';
+/**
+ * Create a mock request context for testing
+ */
+export declare function createMockRequestContext(overrides?: Partial<RequestContext>): RequestContext;
+/**
+ * Execute a function within a mocked request context
+ * Useful for testing tools and agents that use AsyncLocalStorage
+ *
+ * @example
+ * const result = await withRequestContext(
+ *     { user: { id: '123', username: 'test' }, reqId: 'req-123' },
+ *     async () => {
+ *         return await someTool.execute({ carId: 'car-1' });
+ *     }
+ * );
+ */
+export declare function withRequestContext<T>(context: Partial<RequestContext>, fn: () => T | Promise<T>): Promise<T>;
+/**
+ * Create a test user with common properties
+ */
+export declare function createMockUser(overrides?: any): any;

package/dist/requestContext.js

@@ -0,0 +1,86 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMockRequestContext = createMockRequestContext;
+exports.withRequestContext = withRequestContext;
+exports.createMockUser = createMockUser;
+var flink_1 = require("@flink-app/flink");
+/**
+ * Create a mock request context for testing
+ */
+function createMockRequestContext(overrides) {
+    return __assign({ reqId: "test-req-" + Math.random().toString(36).substring(7), timestamp: Date.now() }, overrides);
+}
+/**
+ * Execute a function within a mocked request context
+ * Useful for testing tools and agents that use AsyncLocalStorage
+ *
+ * @example
+ * const result = await withRequestContext(
+ *     { user: { id: '123', username: 'test' }, reqId: 'req-123' },
+ *     async () => {
+ *         return await someTool.execute({ carId: 'car-1' });
+ *     }
+ * );
+ */
+function withRequestContext(context, fn) {
+    return __awaiter(this, void 0, void 0, function () {
+        var fullContext;
+        return __generator(this, function (_a) {
+            fullContext = createMockRequestContext(context);
+            return [2 /*return*/, flink_1.requestContext.run(fullContext, fn)];
+        });
+    });
+}
+/**
+ * Create a test user with common properties
+ */
+function createMockUser(overrides) {
+    return __assign({ id: "user-" + Math.random().toString(36).substring(7), username: "testuser", email: "test@example.com" }, overrides);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flink-app/test-utils",
-  "version": "1.0.0",
+  "version": "2.0.0-alpha.100",
   "description": "Test utils for Flink",
   "author": "joel@frost.se",
   "license": "MIT",
@@ -11,20 +11,24 @@
   },
   "dependencies": {
     "got": "^9.6.0",
-    "qs": "^6.7.0"
+    "qs": "^6.7.0",
+    "zod": "^4.3.6"
   },
   "devDependencies": {
     "@types/got": "^9.6.12",
+    "@types/jasmine": "^3.7.1",
     "@types/node": "22.13.10",
     "@types/qs": "^6.9.7",
+    "jasmine": "^3.10.0",
+    "jasmine-ts": "^0.3.3",
     "ts-node": "^10.9.2",
     "tsc-watch": "^4.2.9",
-    "@flink-app/flink": "1.0.0"
+    "@flink-app/flink": "2.0.0-alpha.100"
   },
   "gitHead": "4243e3b3cd6d4e1ca001a61baa8436bf2bbe4113",
   "scripts": {
-    "test": "echo \"Error: no test specified\"",
-    "build": "tsc",
+    "test": "jasmine-ts --config=./spec/support/jasmine.json",
+    "build": "tsc --project tsconfig.dist.json",
     "watch": "tsc-watch",
     "clean": "rimraf dist .flink"
   }