@agentscope-ai/agentscope 0.0.2

package/src/tool/write.ts

@@ -0,0 +1,57 @@
+import * as fs from 'fs';
+import * as path from 'path';
+
+import { z } from 'zod';
+
+/**
+ * Tool for writing files to the local filesystem.
+ * Creates parent directories as needed and overwrites existing files.
+ *
+ * @returns A Tool object for writing files, with a call method that performs the write operation.
+ */
+export function Write() {
+    return {
+        name: 'Write',
+        description: `Writes a file to the local filesystem.
+
+Usage:
+- This tool will overwrite the existing file if there is one at the provided path.
+- If this is an existing file, you MUST use the Read tool first to read the file's contents. This tool will fail if you did not read the file first.
+- ALWAYS prefer editing existing files in the codebase. NEVER write new files unless explicitly required.
+- NEVER proactively create documentation files (*.md) or README files. Only create documentation files if explicitly requested by the User.
+- Only use emojis if the user explicitly requests it. Avoid writing emojis to files unless asked.`,
+        inputSchema: z.object({
+            file_path: z
+                .string()
+                .describe(
+                    'The absolute path to the file to write (must be absolute, not relative)'
+                ),
+            content: z.string().describe('The content to write to the file'),
+        }),
+        requireUserConfirm: true,
+
+        /**
+         * Writes content to a file, creating parent directories if necessary.
+         *
+         * @param root0 - The parameters object
+         * @param root0.file_path - Absolute path to the file to write
+         * @param root0.content - The content to write to the file
+         * @returns A success message including the number of lines written
+         * @throws If the path is not absolute
+         */
+        call({ file_path, content }: { file_path: string; content: string }): string {
+            if (!path.isAbsolute(file_path)) {
+                throw new Error(`file_path must be an absolute path, got: ${file_path}`);
+            }
+
+            const dir = path.dirname(file_path);
+            if (!fs.existsSync(dir)) {
+                fs.mkdirSync(dir, { recursive: true });
+            }
+
+            fs.writeFileSync(file_path, content, 'utf-8');
+            const lineCount = content.split('\n').length;
+            return `The file ${file_path} has been written successfully (${lineCount} lines).`;
+        },
+    };
+}

package/src/type/index.ts

@@ -0,0 +1,52 @@
+import { ToolResponse } from '../tool';
+
+export type JSONSerializableObject =
+    | string
+    | number
+    | boolean
+    | null
+    | JSONSerializableObject[]
+    | { [key: string]: JSONSerializableObject };
+
+export type ToolName = string;
+export type ToolChoice = 'auto' | 'none' | 'required' | ToolName;
+
+export interface ToolInputSchema {
+    type: 'object';
+    properties?: Record<string, object>;
+    required?: string[];
+    [key: string]: unknown;
+}
+
+export interface ToolSchema {
+    type: 'function';
+    function: {
+        name: string;
+        description: string;
+        parameters: ToolInputSchema;
+    };
+}
+
+/**
+ * Defines the possible function types for a tool function:
+ * - Synchronous: string
+ * - Asynchronous: Promise<string>
+ * - Synchronous Generator: Generator<string>
+ * - Asynchronous Generator: AsyncGenerator<string>
+ * - Synchronous: ToolResponse
+ * - Asynchronous: Promise<ToolResponse>
+ * - Synchronous Generator: Generator<ToolResponse>
+ * - Asynchronous Generator: AsyncGenerator<ToolResponse>
+ */
+export type ToolFunction = (
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    input: any
+) =>
+    | string
+    | Promise<string>
+    | Generator<string>
+    | AsyncGenerator<string>
+    | ToolResponse
+    | Promise<ToolResponse>
+    | Generator<ToolResponse>
+    | AsyncGenerator<ToolResponse>;

package/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+    "extends": "./tsconfig.json",
+    "exclude": ["packages/agentscope/**/*.test.ts", "../../node_modules"]
+}

package/tsconfig.cjs.json

@@ -0,0 +1,11 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "module": "commonjs",
+        "moduleResolution": "node",
+        "outDir": "dist/cjs",
+        "declaration": true,
+        "declarationDir": "dist/types"
+    },
+    "exclude": ["**/*.test.ts", "node_modules"]
+}

package/tsconfig.esm.json

@@ -0,0 +1,10 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "module": "es2022",
+        "moduleResolution": "node16",
+        "outDir": "dist/esm",
+        "declaration": false
+    },
+    "exclude": ["**/*.test.ts", "node_modules"]
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+    "compilerOptions": {
+        "target": "es2022",
+        "module": "commonjs",
+        "esModuleInterop": true,
+        "forceConsistentCasingInFileNames": true,
+        "strict": true,
+        "skipLibCheck": true,
+        "outDir": "dist",
+        "declaration": true
+    },
+    "include": ["src/**/*", "tsup.config.ts"],
+    "exclude": ["node_modules", "dist"]
+}

package/tsup.config.ts

@@ -0,0 +1,20 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig({
+    entry: {
+        'message/index': 'src/message/index.ts',
+        'model/index': 'src/model/index.ts',
+        'tool/index': 'src/tool/index.ts',
+        'agent/index': 'src/agent/index.ts',
+        'formatter/index': 'src/formatter/index.ts',
+        'event/index': 'src/event/index.ts',
+        'mcp/index': 'src/mcp/index.ts',
+        'storage/index': 'src/storage/index.ts',
+    },
+    format: ['cjs', 'esm'],
+    dts: true,
+    splitting: false,
+    clean: true,
+    outDir: 'dist',
+    sourcemap: true,
+});

package/typedoc.json

@@ -0,0 +1,52 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "entryPoints": [
+        "src/agent/index.ts",
+        "src/event/index.ts",
+        "src/formatter/index.ts",
+        "src/mcp/index.ts",
+        "src/message/index.ts",
+        "src/model/index.ts",
+        "src/storage/index.ts",
+        "src/tool/index.ts"
+    ],
+    "entryPointStrategy": "expand",
+    "out": "../../docs/api-reference/generated",
+    "plugin": ["typedoc-plugin-markdown"],
+    "readme": "none",
+    "hideGenerator": true,
+    "excludePrivate": true,
+    "excludeProtected": true,
+    "excludeInternal": true,
+    "excludeExternals": true,
+    "skipErrorChecking": true,
+    "sort": ["source-order"],
+    "kindSortOrder": ["Interface", "Class", "Function", "TypeAlias", "Variable"],
+    "categorizeByGroup": true,
+    "categoryOrder": [
+        "Agent",
+        "Model",
+        "Tool",
+        "Event",
+        "Message",
+        "Storage",
+        "MCP",
+        "Formatter",
+        "*"
+    ],
+    "groupOrder": ["Classes", "Interfaces", "Type Aliases", "Functions", "*"],
+    "outputFileStrategy": "modules",
+    "flattenOutputFiles": false,
+    "useCodeBlocks": true,
+    "expandObjects": true,
+    "parametersFormat": "table",
+    "propertiesFormat": "table",
+    "enumMembersFormat": "table",
+    "typeDeclarationFormat": "table",
+    "excludeNotDocumented": false,
+    "hideBreadcrumbs": true,
+    "hidePageTitle": true,
+    "hidePageHeader": true,
+    "disableSources": true,
+    "customCss": "../../docs/assets/api.css"
+}