@farm.js/ai 0.1.0-beta.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Farm.js Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,11 @@
+# @farm.js/ai
+
+Farm.js AI route helpers
+
+Farm.js is currently in beta.
+
+```bash
+npm install @farm.js/ai@beta
+```
+
+See the [Farm.js repository](https://github.com/farming-labs/farm.js) for documentation, examples, and support.

package/dist/index.d.ts

@@ -0,0 +1,62 @@
+import { convertToModelMessages, streamText, type LanguageModel, type UIMessage, type UIMessageStreamOptions } from "ai";
+type AIStreamTextFunction = typeof streamText;
+type AIConvertToModelMessagesFunction = typeof convertToModelMessages;
+type AIStreamTextInput = Parameters<AIStreamTextFunction>[0];
+type AIConvertToModelMessagesOptions = NonNullable<Parameters<AIConvertToModelMessagesFunction>[1]>;
+export interface AIChatRequestBody<TMessage = Omit<UIMessage, "id">> {
+    messages: TMessage[];
+    [key: string]: unknown;
+}
+export interface AIChatValidationIssue {
+    path: readonly (string | number)[];
+    code: string;
+    message: string;
+}
+export type AIChatStreamTextOptions = Partial<Omit<AIStreamTextInput, "model" | "messages" | "prompt">>;
+export type AIChatResponseOptions = ResponseInit & UIMessageStreamOptions<UIMessage> & {
+    consumeSseStream?: (options: {
+        stream: ReadableStream<string>;
+    }) => PromiseLike<void> | void;
+};
+export interface AIChatPrepareContext<TBody extends AIChatRequestBody = AIChatRequestBody> {
+    request: Request;
+    body: TBody;
+    messages: unknown[];
+    modelMessages: Awaited<ReturnType<AIConvertToModelMessagesFunction>>;
+}
+export interface AIChatRouteOptions<TBody extends AIChatRequestBody = AIChatRequestBody> {
+    model: LanguageModel;
+    system?: AIStreamTextInput["system"];
+    instructions?: AIStreamTextInput["instructions"];
+    streamText?: AIStreamTextFunction;
+    convertToModelMessages?: AIConvertToModelMessagesFunction;
+    convertToModelMessagesOptions?: AIConvertToModelMessagesOptions;
+    options?: AIChatStreamTextOptions;
+    responseOptions?: AIChatResponseOptions | ((context: AIChatPrepareContext<TBody>) => AIChatResponseOptions | Promise<AIChatResponseOptions>);
+    selectMessages?: (body: TBody, request: Request) => unknown[];
+    prepare?: (context: AIChatPrepareContext<TBody>) => AIChatStreamTextOptions | Promise<AIChatStreamTextOptions>;
+}
+type AIChatRequestBodySchema = {
+    parse(value: unknown): AIChatRequestBody;
+    safeParse(value: unknown): {
+        success: true;
+        data: AIChatRequestBody;
+    } | {
+        success: false;
+        error: {
+            issues: AIChatValidationIssue[];
+        };
+    };
+};
+export declare const aiChatRequestBodySchema: AIChatRequestBodySchema;
+/**
+ * Create a Vercel AI SDK chat route for Farm's Next-style app/api convention.
+ *
+ * // src/app/api/chat/route.ts
+ * export const POST = aiChatRoute({ model: "openai/gpt-4o-mini" });
+ */
+export declare function aiChatRoute<TBody extends AIChatRequestBody = AIChatRequestBody>(input: AIChatRouteOptions<TBody>): import("@farm.js/core").FarmTypedEndpoint<AIChatRequestBody<Omit<UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>, "id">>, unknown, Response>;
+export declare const createAIChatRoute: typeof aiChatRoute;
+export declare const defineAIChatRoute: typeof aiChatRoute;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,sBAAsB,EACtB,UAAU,EACV,KAAK,aAAa,EAClB,KAAK,SAAS,EACd,KAAK,sBAAsB,EAC5B,MAAM,IAAI,CAAC;AAEZ,KAAK,oBAAoB,GAAG,OAAO,UAAU,CAAC;AAC9C,KAAK,gCAAgC,GAAG,OAAO,sBAAsB,CAAC;AACtE,KAAK,iBAAiB,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7D,KAAK,+BAA+B,GAAG,WAAW,CAAC,UAAU,CAAC,gCAAgC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpG,MAAM,WAAW,iBAAiB,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC;IACjE,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAC3C,IAAI,CAAC,iBAAiB,EAAE,OAAO,GAAG,UAAU,GAAG,QAAQ,CAAC,CACzD,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAC9C,sBAAsB,CAAC,SAAS,CAAC,GAAG;IAClC,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,CAAA;KAAE,KAAK,WAAW,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CAC9F,CAAC;AAEJ,MAAM,WAAW,oBAAoB,CAAC,KAAK,SAAS,iBAAiB,GAAG,iBAAiB;IACvF,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,KAAK,CAAC;IACZ,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,aAAa,EAAE,OAAO,CAAC,UAAU,CAAC,gCAAgC,CAAC,CAAC,CAAC;CACtE;AAED,MAAM,WAAW,kBAAkB,CAAC,KAAK,SAAS,iBAAiB,GAAG,iBAAiB;IACrF,KAAK,EAAE,aAAa,CAAC;IACrB,MAAM,CAAC,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACrC,YAAY,CAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC,CAAC;IACjD,UAAU,CAAC,EAAE,oBAAoB,CAAC;IAClC,sBAAsB,CAAC,EAAE,gCAAgC,CAAC;IAC1D,6BAA6B,CAAC,EAAE,+BAA+B,CAAC;IAChE,OAAO,CAAC,EAAE,uBAAuB,CAAC;IAClC,eAAe,CAAC,EACZ,qBAAqB,GACrB,CAAC,CACC,OAAO,EAAE,oBAAoB,CAAC,KAAK,CAAC,KACjC,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC;IACjE,cAAc,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,KAAK,OAAO,EAAE,CAAC;IAC9D,OAAO,CAAC,EAAE,CACR,OAAO,EAAE,oBAAoB,CAAC,KAAK,CAAC,KACjC,uBAAuB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;CACjE;AAED,KAAK,uBAAuB,GAAG;IAC7B,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,iBAAiB,CAAC;IACzC,SAAS,CAAC,KAAK,EAAE,OAAO,GACpB;QACE,OAAO,EAAE,IAAI,CAAC;QACd,IAAI,EAAE,iBAAiB,CAAC;KACzB,GACD;QACE,OAAO,EAAE,KAAK,CAAC;QACf,KAAK,EAAE;YACL,MAAM,EAAE,qBAAqB,EAAE,CAAC;SACjC,CAAC;KACH,CAAC;CACP,CAAC;AAEF,eAAO,MAAM,uBAAuB,EAAE,uBAsBrC,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,SAAS,iBAAiB,GAAG,iBAAiB,EAC7E,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC,mKAWjC;AAED,eAAO,MAAM,iBAAiB,oBAAc,CAAC;AAC7C,eAAO,MAAM,iBAAiB,oBAAc,CAAC"}

package/dist/index.js

@@ -0,0 +1,191 @@
+import { createEndpoint } from "@farm.js/core";
+import { convertToModelMessages, streamText, } from "ai";
+export const aiChatRequestBodySchema = {
+    parse(value) {
+        const validation = validateAIChatRequestBody(value);
+        if (!validation.success) {
+            throw createAIChatValidationError(validation.issues);
+        }
+        return validation.data;
+    },
+    safeParse(value) {
+        const validation = validateAIChatRequestBody(value);
+        if (validation.success) {
+            return validation;
+        }
+        return {
+            success: false,
+            error: {
+                issues: validation.issues,
+            },
+        };
+    },
+};
+/**
+ * Create a Vercel AI SDK chat route for Farm's Next-style app/api convention.
+ *
+ * // src/app/api/chat/route.ts
+ * export const POST = aiChatRoute({ model: "openai/gpt-4o-mini" });
+ */
+export function aiChatRoute(input) {
+    return createEndpoint({
+        method: "POST",
+        body: aiChatRequestBodySchema,
+    }, async (context) => {
+        return createAIChatResponse(input, context.request, context.body);
+    });
+}
+export const createAIChatRoute = aiChatRoute;
+export const defineAIChatRoute = aiChatRoute;
+async function createAIChatResponse(input, request, bodyInput) {
+    const bodyValidation = validateAIChatRequestBody(bodyInput ?? (await readJsonBody(request)));
+    if (!bodyValidation.success) {
+        return createAIChatValidationResponse(bodyValidation.issues);
+    }
+    const body = bodyValidation.data;
+    const messages = input.selectMessages?.(body, request) ?? body.messages;
+    if (!Array.isArray(messages)) {
+        return createAIChatValidationResponse([
+            {
+                path: ["messages"],
+                code: "invalid_type",
+                message: "Expected selected messages to be an array.",
+            },
+        ]);
+    }
+    const convertMessages = input.convertToModelMessages ?? convertToModelMessages;
+    const modelMessages = await convertMessages(messages, {
+        ...input.convertToModelMessagesOptions,
+        tools: input.convertToModelMessagesOptions?.tools ?? input.options?.tools,
+    });
+    const prepareContext = {
+        request,
+        body,
+        messages,
+        modelMessages,
+    };
+    const preparedOptions = await input.prepare?.(prepareContext);
+    const streamInput = {
+        ...input.options,
+        system: input.system ?? input.options?.system,
+        instructions: input.instructions ?? input.options?.instructions,
+        ...preparedOptions,
+        model: input.model,
+        messages: modelMessages,
+    };
+    const responseOptions = typeof input.responseOptions === "function"
+        ? await input.responseOptions(prepareContext)
+        : input.responseOptions;
+    const stream = (input.streamText ?? streamText)(streamInput);
+    return stream.toUIMessageStreamResponse(responseOptions);
+}
+async function readJsonBody(request) {
+    try {
+        const text = await request.clone().text();
+        if (text.trim().length === 0) {
+            return undefined;
+        }
+        return JSON.parse(text);
+    }
+    catch {
+        return undefined;
+    }
+}
+function validateAIChatRequestBody(value) {
+    if (!isRecord(value)) {
+        return {
+            success: false,
+            issues: [
+                {
+                    path: [],
+                    code: "invalid_type",
+                    message: "Expected AI chat request body to be an object.",
+                },
+            ],
+        };
+    }
+    const messages = value.messages;
+    if (!Array.isArray(messages)) {
+        return {
+            success: false,
+            issues: [
+                {
+                    path: ["messages"],
+                    code: "invalid_type",
+                    message: "Expected messages to be an array.",
+                },
+            ],
+        };
+    }
+    const issues = [];
+    if (messages.length === 0) {
+        issues.push({
+            path: ["messages"],
+            code: "too_small",
+            message: "Expected at least one message.",
+        });
+    }
+    for (const [messageIndex, message] of messages.entries()) {
+        if (!isRecord(message)) {
+            issues.push({
+                path: ["messages", messageIndex],
+                code: "invalid_type",
+                message: "Expected message to be an object.",
+            });
+            continue;
+        }
+        if (!isAIMessageRole(message.role)) {
+            issues.push({
+                path: ["messages", messageIndex, "role"],
+                code: "invalid_enum_value",
+                message: "Expected message role to be system, user, or assistant.",
+            });
+        }
+        if (!Array.isArray(message.parts)) {
+            issues.push({
+                path: ["messages", messageIndex, "parts"],
+                code: "invalid_type",
+                message: "Expected message parts to be an array.",
+            });
+            continue;
+        }
+        for (const [partIndex, part] of message.parts.entries()) {
+            if (!isRecord(part) || typeof part.type !== "string") {
+                issues.push({
+                    path: ["messages", messageIndex, "parts", partIndex],
+                    code: "invalid_type",
+                    message: "Expected message part to be an object with a string type.",
+                });
+            }
+        }
+    }
+    if (issues.length > 0) {
+        return {
+            success: false,
+            issues,
+        };
+    }
+    return {
+        success: true,
+        data: value,
+    };
+}
+function createAIChatValidationResponse(issues) {
+    return Response.json({
+        error: "AI chat request body validation failed",
+        issues,
+    }, {
+        status: 400,
+    });
+}
+function createAIChatValidationError(issues) {
+    const error = new Error("AI chat request body validation failed");
+    error.issues = issues;
+    return error;
+}
+function isAIMessageRole(value) {
+    return value === "system" || value === "user" || value === "assistant";
+}
+function isRecord(value) {
+    return !!value && typeof value === "object" && !Array.isArray(value);
+}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@farm.js/ai",
+  "version": "0.1.0-beta.0",
+  "description": "Farm.js AI route helpers",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/farming-labs/farm.js",
+    "directory": "packages/farm-ai"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "ai": "^7.0.11",
+    "@farm.js/core": "0.1.0-beta.0"
+  },
+  "scripts": {
+    "build": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\" && tsc",
+    "dev": "tsc --watch",
+    "type-check": "tsc --noEmit",
+    "test": "echo 'No tests in this package'"
+  }
+}