refactor: prepare packages for publishing (#45)

Fixes #29

Introducing Rslib 
Commenting out documentation entry points temporarily (I need to
experiment with this in a follow-up)
Moved vision tools to file, from folder, to simplify structure 
Added missing fields to package.json and fixed typos in some other
places
Tested and tried this setup in Cali, a different project of mine

.gitignore

@@ -175,4 +175,4 @@ dist
 .DS_Store
 
 last-run-id.txt
-context-*.json
+context-*.json

example/src/ecommerce_product_description.ts

@@ -5,7 +5,7 @@
 import { agent } from '@dead-simple-ai-agent/framework/agent'
 import { teamwork } from '@dead-simple-ai-agent/framework/teamwork'
 import { workflow } from '@dead-simple-ai-agent/framework/workflow'
-import { visionTool } from '@dead-simple-ai-agent/tools'
+import { visionTool } from '@dead-simple-ai-agent/tools/vision'
 
 const techExpert = agent({
   role: 'Technical expert',

package.json

@@ -27,7 +27,5 @@
   "trustedDependencies": [
     "core-js"
   ],
-  "dependencies": {
-    "nanoid": "^5.0.9"
-  }
+  "version": "0.0.1"
 }

packages/framework/README.md

@@ -0,0 +1,3 @@
+@dead-simple-ai-agent/framework
+====
+

packages/framework/package.json

@@ -1,20 +1,47 @@
 {
   "name": "@dead-simple-ai-agent/framework",
-  "version": "0.0.1",
   "description": "A dead simple AI agent framework",
   "author": "Mike Grabowski <[email protected]>",
+  "contributors": [
+    "Piotr Karwatka <[email protected]>"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "bun run clean && bun run build:lib && bun run build:types",
+    "build:lib": "rslib build",
+    "build:types": "tsc --emitDeclarationOnly --declaration --outdir dist/types"
+  },
   "exports": {
     "./*": {
-      "bun": "./src/*.ts"
-    },
-    "./models/*": {
-      "bun": "./src/models/*.ts"
+      "bun": "./src/*.ts",
+      "types": "./dist/types/*.d.ts",
+      "require": "./dist/*.cjs",
+      "import": "./dist/*.js"
     }
   },
   "type": "module",
   "dependencies": {
     "dedent": "^1.5.3",
     "openai": "^4.76.0",
     "zod": "^3.23.8"
-  }
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/callstackincubator/ai-agent-framework.git"
+  },
+  "keywords": [
+    "ai",
+    "ai agents",
+    "ai tools"
+  ],
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "version": "0.0.1"
 }

packages/framework/rslib.config.ts

@@ -0,0 +1,39 @@
+import { defineConfig } from '@rslib/core'
+
+const entry = {
+  agent: './src/agent.ts',
+  models: './src/models.ts',
+  teamwork: './src/teamwork.ts',
+  telemetry: './src/telemetry.ts',
+  tool: './src/tool.ts',
+  workflow: './src/workflow.ts',
+}
+
+export default defineConfig({
+  lib: [
+    {
+      source: {
+        entry,
+      },
+      format: 'esm',
+      bundle: false,
+      output: {
+        distPath: {
+          root: 'dist',
+        },
+      },
+    },
+    {
+      source: {
+        entry,
+      },
+      format: 'cjs',
+      bundle: false,
+      output: {
+        distPath: {
+          root: 'dist',
+        },
+      },
+    },
+  ],
+})

packages/framework/src/agent.ts

@@ -1,4 +1,4 @@
-import { openai, Provider } from './models/openai.js'
+import { openai, Provider } from './models.js'
 import { Tool } from './tool.js'
 import { RequiredOptionals } from './types.js'
 

packages/framework/src/models/openai.ts → packages/framework/src/models.ts

@@ -1,7 +1,7 @@
 import OpenAI, { ClientOptions } from 'openai'
 import { ChatCompletionCreateParamsNonStreaming } from 'openai/resources/index.mjs'
 
-import { RequiredOptionals } from '../types.js'
+import { RequiredOptionals } from './types.js'
 
 type OpenAIOptions = {
   model?: string

packages/framework/src/supervisor/finalizeWorkflow.ts

@@ -2,7 +2,7 @@ import s from 'dedent'
 import { zodResponseFormat } from 'openai/helpers/zod.mjs'
 import { z } from 'zod'
 
-import { Provider } from '../models/openai.js'
+import { Provider } from '../models.js'
 import { Message } from '../types.js'
 
 export async function finalizeWorkflow(provider: Provider, messages: Message[]): Promise<string> {

packages/framework/src/supervisor/nextTask.ts

@@ -2,7 +2,7 @@ import s from 'dedent'
 import { zodResponseFormat } from 'openai/helpers/zod.mjs'
 import { z } from 'zod'
 
-import { Provider } from '../models/openai.js'
+import { Provider } from '../models.js'
 import { Message } from '../types.js'
 
 export async function nextTask(provider: Provider, history: Message[]): Promise<string | null> {

packages/framework/src/supervisor/selectAgent.ts

@@ -3,7 +3,7 @@ import { zodResponseFormat } from 'openai/helpers/zod.mjs'
 import { z } from 'zod'
 
 import { Agent } from '../agent.js'
-import { Provider } from '../models/openai.js'
+import { Provider } from '../models.js'
 import { Message } from '../types.js'
 
 export async function selectAgent(

packages/framework/src/tool.ts

@@ -1,6 +1,6 @@
 import z, { ZodTypeAny } from 'zod'
 
-import { Provider } from './models/openai.js'
+import { Provider } from './models.js'
 import { Message } from './types.js'
 
 export type Tool<P extends ZodTypeAny = any> = {

packages/framework/src/workflow.ts

@@ -3,7 +3,7 @@ import { randomUUID } from 'node:crypto'
 import s from 'dedent'
 
 import { Agent } from './agent.js'
-import { openai, Provider } from './models/openai.js'
+import { openai, Provider } from './models.js'
 import { noop, Telemetry } from './telemetry.js'
 import { Message } from './types.js'
 

packages/framework/tsconfig.json

@@ -1,3 +1,4 @@
 {
-  "extends": "../../tsconfig.json"
+  "extends": "../../tsconfig.json",
+  "include": ["./src"]
 }

packages/tools/README.md

@@ -0,0 +1,3 @@
+@dead-simple-ai-agent/tools
+====
+

packages/tools/package.json

@@ -1,20 +1,43 @@
 {
   "name": "@dead-simple-ai-agent/tools",
-  "version": "0.0.1",
   "description": "A dead simple AI agent tools",
   "author": "Piotr Karwatka <[email protected]>",
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "bun run clean && bun run build:lib && bun run build:types",
+    "build:lib": "rslib build",
+    "build:types": "tsc --emitDeclarationOnly --declaration --outdir dist/types"
+  },
   "exports": {
-    ".": {
-      "bun": "./src/index.ts"
-    },
-    "./tools": {
-      "bun": "./src/index.ts"
+    "./*": {
+      "bun": "./src/*.ts",
+      "types": "./dist/types/*.d.ts",
+      "require": "./dist/*.cjs",
+      "import": "./dist/*.js"
     }
   },
   "type": "module",
   "dependencies": {
-    "dedent": "^1.5.3",
-    "openai": "^4.76.0",
+    "@dead-simple-ai-agent/framework": "0.0.1",
     "zod": "^3.23.8"
-  }
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/callstackincubator/ai-agent-framework.git"
+  },
+  "keywords": [
+    "ai",
+    "ai agents",
+    "ai tools"
+  ],
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "version": "0.0.1"
 }

packages/tools/rslib.config.ts

@@ -0,0 +1,34 @@
+import { defineConfig } from '@rslib/core'
+
+const entry = {
+  vision: './src/vision.ts',
+}
+
+export default defineConfig({
+  lib: [
+    {
+      source: {
+        entry,
+      },
+      format: 'esm',
+      bundle: false,
+      output: {
+        distPath: {
+          root: 'dist',
+        },
+      },
+    },
+    {
+      source: {
+        entry,
+      },
+      format: 'cjs',
+      bundle: false,
+      output: {
+        distPath: {
+          root: 'dist',
+        },
+      },
+    },
+  ],
+})

packages/tools/src/vision/index.ts → packages/tools/src/vision.ts

@@ -1,7 +1,4 @@
-/**
- * Example borrowed from CrewAI.
- */
-import { Provider } from '@dead-simple-ai-agent/framework/models/openai'
+import { Provider } from '@dead-simple-ai-agent/framework/models'
 import { tool } from '@dead-simple-ai-agent/framework/tool'
 import * as fs from 'fs'
 import { z } from 'zod'
@@ -48,15 +45,11 @@ const runWebHostedImages = async (provider: Provider, imagePathUrl: string): Pro
 }
 
 export const visionTool = tool({
-  description: 'Tool for analyzing and OCR the pitures',
+  description: 'Tool for analyzing and OCR the pictures',
   parameters: z.object({
     imagePathUrl: z.string().describe('The image path or URL'),
   }),
   execute: ({ imagePathUrl }, { provider }) => {
-    if (!imagePathUrl) {
-      throw new Error('Image Path or URL is required.')
-    }
-
     if (imagePathUrl.startsWith('http')) {
       return runWebHostedImages(provider, imagePathUrl)
     } else {

packages/tools/tsconfig.json

@@ -1,3 +1,4 @@
 {
-  "extends": "../../tsconfig.json"
+  "extends": "../../tsconfig.json",
+  "include": ["./src"]
 }

website/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dead-simple-ai-agent/website",
-  "version": "1.0.0",
   "private": true,
+  "type": "module",
   "scripts": {
     "dev": "rspress dev",
     "build": "rspress build",

website/rspress.config.ts

@@ -1,11 +1,11 @@
 import * as path from 'node:path'
 
-import { pluginTypeDoc } from '@rspress/plugin-typedoc'
 import { defineConfig } from 'rspress/config'
+// import { pluginTypeDoc } from '@rspress/plugin-typedoc'
 
 export default defineConfig({
   root: path.join(__dirname, 'docs'),
-  title: 'My Site',
+  title: 'Dead Simple AI Agent',
   icon: '/rspress-icon.png',
   logo: {
     light: '/rspress-light-logo.png',
@@ -16,20 +16,20 @@ export default defineConfig({
       {
         icon: 'github',
         mode: 'link',
-        content: 'https://github.com/web-infra-dev/rspress',
+        content: 'https://github.com/callstackincubator/ai-agent-framework',
       },
     ],
   },
   plugins: [
-    pluginTypeDoc({
-      entryPoints: [
-        path.join(__dirname, '../packages/framework/src/agent.ts'),
-        path.join(__dirname, '../packages/framework/src/teamwork.ts'),
-        path.join(__dirname, '../packages/framework/src/tool.ts'),
-        path.join(__dirname, '../packages/framework/src/workflow.ts'),
-        path.join(__dirname, '../packages/framework/src/models/openai.ts'),
-        path.join(__dirname, '../packages/framework/src/telemetry.ts'),
-      ],
-    }),
+    // pluginTypeDoc({
+    //   entryPoints: [
+    //     path.join(__dirname, '../packages/framework/src/agent.ts'),
+    //     path.join(__dirname, '../packages/framework/src/teamwork.ts'),
+    //     path.join(__dirname, '../packages/framework/src/tool.ts'),
+    //     path.join(__dirname, '../packages/framework/src/workflow.ts'),
+    //     path.join(__dirname, '../packages/framework/src/models/openai.ts'),
+    //     path.join(__dirname, '../packages/framework/src/telemetry.ts'),
+    //   ],
+    // }),
   ],
 })