@do-kit/agents 0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 友人A
+
+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,32 @@
+# @do-kit/agents
+
+Lightweight utilities and helpers maintained in the `agents` package.
+
+Install
+
+```bash
+pnpm add @do-kit/agents
+```
+
+Usage
+
+```ts
+import { createAugmentResponseFromRequest } from '@do-kit/agents';
+
+// The request body may reference an external provider like `deepseek`.
+// You do NOT need to install `@ai-sdk/deepseek` unless you want to use it locally.
+const body = {
+  provider: 'deepseek',
+  model: 'deepseek-chat',
+  messages: [{ role: 'user', content: 'Hello' }],
+};
+
+const response = await createAugmentResponseFromRequest(body);
+// `response` is a UI-compatible stream response
+```
+
+Development
+
+```bash
+pnpm -w -F @do-kit/agents build
+```

package/dist/cjs/index.js

@@ -0,0 +1,102 @@
+'use strict';
+
+var ai = require('ai');
+require('@ai-sdk/deepseek');
+
+const version$1 = "0.2.0";
+
+const version = version$1;
+
+function injectDocumentStateMessages(messages) {
+  return messages.flatMap((message) => {
+    if (message.role === "user" && message.metadata?.documentState) {
+      const documentState = message.metadata.documentState;
+      return [
+        {
+          role: "assistant",
+          id: `assistant-document-state-${message.id}`,
+          parts: [
+            ...documentState.selection ? [
+              {
+                type: "text",
+                text: `This is the latest state of the selection (ignore previous selections, you MUST issue operations against this latest version of the selection): ${JSON.stringify(
+                  documentState.selectedBlocks
+                )}`
+              },
+              {
+                type: "text",
+                text: JSON.stringify(documentState.selectedBlocks)
+              },
+              {
+                type: "text",
+                text: `This is the latest state of the entire document (INCLUDING the selected text),
+you can use this to find the selected text to understand the context (but you MUST NOT issue operations against this document, you MUST issue operations against the selection): ${JSON.stringify(
+                  documentState.blocks
+                )}`
+              },
+              {
+                type: "text",
+                text: JSON.stringify(documentState.blocks)
+              }
+            ] : [
+              {
+                type: "text",
+                text: `There is no active selection. This is the latest state of the document (ignore previous documents, you MUST issue operations against this latest version of the document).
+The cursor is BETWEEN two blocks as indicated by cursor: true.
+${documentState.isEmptyDocument ? `Because the document is empty, YOU MUST first update the empty block before adding new blocks.` : "Prefer updating existing blocks over removing and adding (but this also depends on the user's question)."}`
+              },
+              {
+                type: "text",
+                text: JSON.stringify(documentState.blocks)
+              }
+            ]
+          ]
+        },
+        message
+      ];
+    }
+    return [message];
+  });
+}
+function toolDefinitionsToToolSet(toolDefinitions) {
+  return Object.fromEntries(
+    Object.entries(toolDefinitions).map(([name, definition]) => [
+      name,
+      ai.tool({
+        ...definition,
+        inputSchema: ai.jsonSchema(definition.inputSchema),
+        outputSchema: ai.jsonSchema(definition.outputSchema)
+      })
+    ])
+  );
+}
+const systemPrompt = `
+You're manipulating a text document using HTML blocks.
+Make sure to follow the json schema provided. When referencing ids they MUST be EXACTLY the same (including the trailing $).
+List items are 1 block with 1 list item each, so block content \`<ul><li>item1</li></ul>\` is valid, but \`<ul><li>item1</li><li>item2</li></ul>\` is invalid. We'll merge them automatically.
+For code blocks, you can use the \`data-language\` attribute on a <code> block (wrapped with <pre>) to specify the language.
+
+If the user requests updates to the document, use the "applyDocumentOperations" tool to update the document.
+---
+IF there is no selection active in the latest state, first, determine what part of the document the user is talking about. You SHOULD probably take cursor info into account if needed.
+  EXAMPLE: if user says "below" (without pointing to a specific part of the document) he / she probably indicates the block(s) after the cursor.
+  EXAMPLE: If you want to insert content AT the cursor position (UNLESS indicated otherwise by the user), then you need \`referenceId\` to point to the block before the cursor with position \`after\` (or block below and \`before\`
+---
+`;
+
+const augmentAgent = ({
+  model,
+  messages,
+  toolDefinitions
+}) => {
+  return ai.streamText({
+    model,
+    system: systemPrompt,
+    messages: ai.convertToModelMessages(injectDocumentStateMessages(messages)),
+    tools: toolDefinitionsToToolSet(toolDefinitions),
+    toolChoice: "required"
+  });
+};
+
+exports.augmentAgent = augmentAgent;
+exports.version = version;

package/dist/esm/index.mjs

@@ -0,0 +1,99 @@
+import { tool, jsonSchema, streamText, convertToModelMessages } from 'ai';
+import '@ai-sdk/deepseek';
+
+const version$1 = "0.2.0";
+
+const version = version$1;
+
+function injectDocumentStateMessages(messages) {
+  return messages.flatMap((message) => {
+    if (message.role === "user" && message.metadata?.documentState) {
+      const documentState = message.metadata.documentState;
+      return [
+        {
+          role: "assistant",
+          id: `assistant-document-state-${message.id}`,
+          parts: [
+            ...documentState.selection ? [
+              {
+                type: "text",
+                text: `This is the latest state of the selection (ignore previous selections, you MUST issue operations against this latest version of the selection): ${JSON.stringify(
+                  documentState.selectedBlocks
+                )}`
+              },
+              {
+                type: "text",
+                text: JSON.stringify(documentState.selectedBlocks)
+              },
+              {
+                type: "text",
+                text: `This is the latest state of the entire document (INCLUDING the selected text),
+you can use this to find the selected text to understand the context (but you MUST NOT issue operations against this document, you MUST issue operations against the selection): ${JSON.stringify(
+                  documentState.blocks
+                )}`
+              },
+              {
+                type: "text",
+                text: JSON.stringify(documentState.blocks)
+              }
+            ] : [
+              {
+                type: "text",
+                text: `There is no active selection. This is the latest state of the document (ignore previous documents, you MUST issue operations against this latest version of the document).
+The cursor is BETWEEN two blocks as indicated by cursor: true.
+${documentState.isEmptyDocument ? `Because the document is empty, YOU MUST first update the empty block before adding new blocks.` : "Prefer updating existing blocks over removing and adding (but this also depends on the user's question)."}`
+              },
+              {
+                type: "text",
+                text: JSON.stringify(documentState.blocks)
+              }
+            ]
+          ]
+        },
+        message
+      ];
+    }
+    return [message];
+  });
+}
+function toolDefinitionsToToolSet(toolDefinitions) {
+  return Object.fromEntries(
+    Object.entries(toolDefinitions).map(([name, definition]) => [
+      name,
+      tool({
+        ...definition,
+        inputSchema: jsonSchema(definition.inputSchema),
+        outputSchema: jsonSchema(definition.outputSchema)
+      })
+    ])
+  );
+}
+const systemPrompt = `
+You're manipulating a text document using HTML blocks.
+Make sure to follow the json schema provided. When referencing ids they MUST be EXACTLY the same (including the trailing $).
+List items are 1 block with 1 list item each, so block content \`<ul><li>item1</li></ul>\` is valid, but \`<ul><li>item1</li><li>item2</li></ul>\` is invalid. We'll merge them automatically.
+For code blocks, you can use the \`data-language\` attribute on a <code> block (wrapped with <pre>) to specify the language.
+
+If the user requests updates to the document, use the "applyDocumentOperations" tool to update the document.
+---
+IF there is no selection active in the latest state, first, determine what part of the document the user is talking about. You SHOULD probably take cursor info into account if needed.
+  EXAMPLE: if user says "below" (without pointing to a specific part of the document) he / she probably indicates the block(s) after the cursor.
+  EXAMPLE: If you want to insert content AT the cursor position (UNLESS indicated otherwise by the user), then you need \`referenceId\` to point to the block before the cursor with position \`after\` (or block below and \`before\`
+---
+`;
+
+const augmentAgent = ({
+  model,
+  messages,
+  toolDefinitions
+}) => {
+  return streamText({
+    model,
+    system: systemPrompt,
+    messages: convertToModelMessages(injectDocumentStateMessages(messages)),
+    tools: toolDefinitionsToToolSet(toolDefinitions),
+    toolChoice: "required"
+  });
+};
+
+export { augmentAgent, version };

package/dist/types/index.d.ts

@@ -0,0 +1,13 @@
+import { streamText } from 'ai';
+
+declare const version: string;
+
+type AugmentOptions = {
+    model: any;
+    messages: any[];
+    toolDefinitions?: Record<string, any>;
+};
+type CreateAugmentAgentResult = ReturnType<typeof streamText>;
+declare const augmentAgent: ({ model, messages, toolDefinitions, }: AugmentOptions) => CreateAugmentAgentResult;
+
+export { augmentAgent, version };

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@do-kit/agents",
+  "description": "@do-kit agents library",
+  "version": "0.2.1",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.mjs",
+  "types": "dist/types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@rollup/plugin-json": "^6.1.0",
+    "rollup": "^4.34.7",
+    "rollup-plugin-dts": "^6.1.1",
+    "rollup-plugin-esbuild": "6.2.1",
+    "vitest": "^4.0.7",
+    "@do-kit/typescript-config": "0.2.0"
+  },
+  "scripts": {
+    "dev": "rollup -c rollup.config.mjs -w",
+    "build": "rimraf dist && rollup -c rollup.config.mjs",
+    "clean": "rimraf .turbo node_modules dist",
+    "test": "vitest run --color",
+    "test:cov": "vitest run --color --coverage"
+  }
+}