@asterai/cli 0.4.0 → 0.6.0

package/init/rust/src/lib.rs

@@ -0,0 +1,16 @@
+use crate::bindings::asterai::host::api;
+use crate::bindings::exports::your_username::greeter::greeter::Guest;
+
+#[allow(warnings)]
+mod bindings;
+
+struct Component;
+
+impl Guest for Component {
+    fn greet(name: String) {
+        let greeting = format!("hello {name}");
+        api::send_response_to_agent(&greeting);
+    }
+}
+
+bindings::export!(Component with_types_in bindings);

package/init/typescript/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "plugin",
+  "version": "0.1.0",
+  "description": "",
+  "author": "",
+  "license": "UNLICENSED",
+  "type": "module",
+  "scripts": {
+    "auth": "asterai auth",
+    "gen:pkg": "mkdirp build && asterai pkg -o build/package.wasm -w build/package.wit",
+    "gen:types": "jco guest-types build/package.wit -n plugin -o generated/",
+    "compile": "tsc",
+    "componentize": "jco componentize build/plugin.js -w build/package.wit -n plugin -o build/plugin.wasm",
+    "build": "run-s gen:pkg gen:types compile componentize",
+    "deploy": "asterai deploy"
+  },
+  "devDependencies": {
+    "@asterai/cli": "latest",
+    "@asterai/sdk": "latest",
+    "@bytecodealliance/jco": "^1.9.1",
+    "@types/node": "^22.13.4",
+    "mkdirp": "^3.0.1",
+    "npm-run-all": "^4.1.5",
+    "typescript": "^5.7.3"
+  }
+}

package/init/typescript/plugin.ts

@@ -0,0 +1,11 @@
+import { BinaryOperationInput } from "./generated/plugin";
+import * as asterai from "asterai:host/api@0.1.0";
+
+export const add = (input: BinaryOperationInput): number => {
+  const result = input.a + input.b;
+  // Send the calculation result to the agent.
+  asterai.sendResponseToAgent(`the result is ${result}`);
+  // This result is not seen by the agent, but it can be consumed by
+  // other plugins calling this function.
+  return result;
+};

package/init/typescript/plugin.wit

@@ -0,0 +1,12 @@
+package example:math@0.1.0;
+
+world plugin {
+  import asterai:host/api@0.1.0;
+
+  export add: func(input: binary-operation-input) -> s32;
+
+  record binary-operation-input {
+    a: f64,
+    b: f64,
+  }
+}

package/init/typescript/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "include": ["./**/*.ts"],
+  "compilerOptions": {
+    "outDir": "build",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "paths": {
+      "asterai:host/api@0.1.0": ["./generated/interfaces/asterai-host-api.d.ts"]
+    }
+  }
+}

package/oclif.manifest.json

@@ -28,24 +28,49 @@
         "auth.js"
       ]
     },
-    "build": {
+    "deploy": {
       "aliases": [],
-      "args": {
-        "input": {
-          "default": "plugin.ts",
-          "name": "input"
-        }
-      },
-      "description": "compiles the plugin",
+      "args": {},
+      "description": "uploads a plugin to asterai",
       "examples": [
-        "<%= config.bin %> <%= command.id %>"
+        "<%= config.bin %> <%= command.id %> --app 66a46b12-b1a7-4b72-a64a-0e4fe21902b6"
       ],
       "flags": {
-        "manifest": {
-          "char": "m",
-          "description": "manifest path",
-          "name": "manifest",
-          "default": "plugin.asterai.proto",
+        "agent": {
+          "char": "a",
+          "description": "agent ID to immediately activate this plugin for",
+          "name": "agent",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "endpoint": {
+          "char": "e",
+          "name": "endpoint",
+          "default": "https://api.asterai.io",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "staging": {
+          "char": "s",
+          "name": "staging",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "plugin": {
+          "description": "plugin WASM path",
+          "name": "plugin",
+          "default": "plugin.wasm",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "pkg": {
+          "description": "package WASM path",
+          "name": "pkg",
+          "default": "package.wasm",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -53,7 +78,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "build",
+      "id": "deploy",
       "pluginAlias": "@asterai/cli",
       "pluginName": "@asterai/cli",
       "pluginType": "core",
@@ -63,66 +88,38 @@
       "relativePath": [
         "dist",
         "commands",
-        "build.js"
+        "deploy.js"
       ]
     },
-    "codegen": {
+    "init": {
       "aliases": [],
-      "args": {},
-      "description": "Generate code from the plugin manifest",
+      "args": {
+        "outDir": {
+          "default": "plugin",
+          "name": "outDir"
+        }
+      },
+      "description": "Initialise a new plugin project",
       "examples": [
-        "<%= config.bin %> <%= command.id %>"
+        "<%= config.bin %> <%= command.id %> project-name"
       ],
       "flags": {
-        "manifest": {
-          "char": "m",
-          "description": "manifest path",
-          "name": "manifest",
-          "default": "plugin.asterai.proto",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "outputDir": {
-          "char": "o",
-          "description": "output directory",
-          "name": "outputDir",
-          "default": "generated",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "appId": {
-          "char": "a",
-          "description": "app id",
-          "name": "appId",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "language": {
-          "char": "l",
-          "description": "language of generated typings",
-          "name": "language",
-          "required": false,
-          "default": "js",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+        "typescript": {
+          "description": "init a the plugin project in typescript",
+          "name": "typescript",
+          "allowNo": false,
+          "type": "boolean"
         },
-        "staging": {
-          "char": "s",
-          "description": "use staging endpoint",
-          "name": "staging",
-          "required": false,
+        "rust": {
+          "description": "init a the plugin project in rust",
+          "name": "rust",
           "allowNo": false,
           "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "codegen",
+      "id": "init",
       "pluginAlias": "@asterai/cli",
       "pluginName": "@asterai/cli",
       "pluginType": "core",
@@ -132,36 +129,37 @@
       "relativePath": [
         "dist",
         "commands",
-        "codegen.js"
+        "init.js"
       ]
     },
-    "deploy": {
+    "pkg": {
       "aliases": [],
       "args": {
         "input": {
-          "default": "plugin.ts",
+          "default": "plugin.wit",
+          "description": "path to the plugin's WIT file",
           "name": "input"
         }
       },
-      "description": "compiles and uploads the plugin to asterai",
+      "description": "bundles the WIT into a binary WASM package",
       "examples": [
-        "<%= config.bin %> <%= command.id %> --app 66a46b12-b1a7-4b72-a64a-0e4fe21902b6"
+        "<%= config.bin %> <%= command.id %>"
       ],
       "flags": {
-        "app": {
-          "char": "a",
-          "description": "app ID to immediately configure this plugin with",
-          "name": "app",
-          "required": true,
+        "output": {
+          "char": "o",
+          "description": "output file name for the binary WASM package",
+          "name": "output",
+          "default": "package.wasm",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "manifest": {
-          "char": "m",
-          "description": "manifest path",
-          "name": "manifest",
-          "default": "plugin.asterai.proto",
+        "wit": {
+          "char": "w",
+          "description": "output package converted to the WIT format",
+          "name": "wit",
+          "default": "package.wit",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -169,21 +167,15 @@
         "endpoint": {
           "char": "e",
           "name": "endpoint",
-          "default": "https://api.asterai.io/app/plugin",
+          "default": "https://api.asterai.io",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
-        },
-        "staging": {
-          "char": "s",
-          "name": "staging",
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "deploy",
+      "id": "pkg",
       "pluginAlias": "@asterai/cli",
       "pluginName": "@asterai/cli",
       "pluginType": "core",
@@ -193,35 +185,7 @@
       "relativePath": [
         "dist",
         "commands",
-        "deploy.js"
-      ]
-    },
-    "init": {
-      "aliases": [],
-      "args": {
-        "outDir": {
-          "default": "plugin",
-          "name": "outDir"
-        }
-      },
-      "description": "Initialise a new plugin project",
-      "examples": [
-        "<%= config.bin %> <%= command.id %> project-name"
-      ],
-      "flags": {},
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "init",
-      "pluginAlias": "@asterai/cli",
-      "pluginName": "@asterai/cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "init.js"
+        "pkg.js"
       ]
     },
     "query": {
@@ -280,5 +244,5 @@
       ]
     }
   },
-  "version": "0.4.0"
+  "version": "0.6.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@asterai/cli",
   "description": "CLI for building and deploying asterai plugins",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "author": "asterai <support@asterai.io>",
   "repository": "asterai-io/asterai-sdk",
   "homepage": "https://github.com/asterai-io/asterai-sdk",
@@ -36,7 +36,9 @@
     "/bin",
     "/dist",
     "/oclif.manifest.json",
-    "/asterai-init-plugin"
+    "/init",
+    "!/init/rust/target",
+    "!/init/rust/Cargo.lock"
   ],
   "oclif": {
     "bin": "asterai",

package/asterai-init-plugin/package.json

@@ -1,23 +0,0 @@
-{
-  "name": "plugin",
-  "version": "1.0.0",
-  "description": "",
-  "author": "asterai",
-  "license": "MIT",
-  "scripts": {
-    "auth": "asterai auth",
-    "codegen": "asterai codegen",
-    "build": "asterai build",
-    "deploy": "asterai deploy"
-  },
-  "type": "module",
-  "devDependencies": {
-    "@asterai/cli": "latest",
-    "@asterai/sdk": "latest",
-    "@asterai/as-proto": "latest",
-    "@asterai/as-proto-gen": "latest"
-  },
-  "peerDependencies": {
-    "assemblyscript": "0.27.27"
-  }
-}

package/asterai-init-plugin/plugin.asterai.proto

@@ -1,22 +0,0 @@
-syntax = "proto3";
-import "node_modules/@asterai/sdk/protobuf/asterai.proto";
-
-service Math {
-  rpc processQuery(PluginContext) returns (ProcessQueryOutput);
-  rpc add(BinaryOperationInput) returns (CalculationOutput);
-  rpc mul(BinaryOperationInput) returns (CalculationOutput);
-  rpc div(BinaryOperationInput) returns (CalculationOutput);
-  rpc pow(BinaryOperationInput) returns (CalculationOutput);
-}
-
-message ProcessQueryOutput {}
-
-message BinaryOperationInput {
-  PluginContext context = 1;
-  double a = 2;
-  double b = 3;
-}
-
-message CalculationOutput {
-  string system_message = 1;
-}

package/asterai-init-plugin/plugin.ts

@@ -1,35 +0,0 @@
-import { BinaryOperationInput } from "./generated/BinaryOperationInput";
-import { CalculationOutput } from "./generated/CalculationOutput";
-import { PluginContext } from "./generated/PluginContext";
-import { ProcessQueryOutput } from "./generated/ProcessQueryOutput";
-import { Log } from "@asterai/sdk";
-
-export function processQuery(input: PluginContext): ProcessQueryOutput {
-  Log.info(`math plugin received a query: ${input.query.content}`);
-  // This doesn't return any data, but protobuf requires functions
-  // to always have one input and one output exactly to ensure
-  // backward compatibility.
-  return new ProcessQueryOutput();
-}
-
-export function add(input: BinaryOperationInput): CalculationOutput {
-  const result = input.a + input.b;
-  // CalculationOutput returns a system message.
-  // The `system_message` field is sent to the LLM.
-  return new CalculationOutput(`the result is ${result}`);
-}
-
-export function mul(input: BinaryOperationInput): CalculationOutput {
-  const result = input.a * input.b;
-  return new CalculationOutput(`the result is ${result}`);
-}
-
-export function div(input: BinaryOperationInput): CalculationOutput {
-  const result = input.a / input.b;
-  return new CalculationOutput(`the result is ${result}`);
-}
-
-export function pow(input: BinaryOperationInput): CalculationOutput {
-  const result = input.a ** input.b;
-  return new CalculationOutput(`the result is ${result}`);
-}

package/asterai-init-plugin/tsconfig.json

@@ -1,4 +0,0 @@
-{
-  "extends": "assemblyscript/std/assembly.json",
-  "include": ["./**/*.ts"]
-}

package/dist/commands/build.d.ts

@@ -1,23 +0,0 @@
-import { Command } from "@oclif/core";
-export type BuildArgs = {
-    input: string;
-};
-export type BuildFlags = {
-    manifest: string;
-};
-export type BuildOutput = {
-    outputFile: string;
-    manifestPath: string;
-};
-export default class Build extends Command {
-    static args: {
-        input: import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
-    };
-    static description: string;
-    static examples: string[];
-    static flags: {
-        manifest: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-    };
-    run(): Promise<void>;
-}
-export declare const build: (args: BuildArgs, flags: BuildFlags) => Promise<BuildOutput>;

package/dist/commands/build.js

@@ -1,139 +0,0 @@
-import { Args, Command, Flags } from "@oclif/core";
-import path from "path";
-import fs from "fs";
-import { compile } from "../compile.js";
-import Mustache from "mustache";
-import protobuf from "protobufjs";
-import { mergeProtoImports } from "./deploy.js";
-export default class Build extends Command {
-    static args = {
-        input: Args.string({
-            default: "plugin.ts",
-        }),
-    };
-    static description = "compiles the plugin";
-    static examples = [`<%= config.bin %> <%= command.id %>`];
-    static flags = {
-        manifest: Flags.string({
-            char: "m",
-            description: "manifest path",
-            default: "plugin.asterai.proto",
-        }),
-    };
-    async run() {
-        const { args, flags } = await this.parse(Build);
-        await build(args, flags);
-    }
-}
-export const build = async (args, flags) => {
-    const manifestPath = path.resolve(flags.manifest);
-    const inputFile = path.resolve(args.input);
-    if (!fs.existsSync(inputFile)) {
-        throw new Error(`input file not found (${args.input})`);
-    }
-    const inputFileName = path.parse(inputFile).name;
-    const baseDir = path.dirname(manifestPath);
-    const outDir = path.join(baseDir, "build");
-    const outputFile = path.join(outDir, `${inputFileName}.wasm`);
-    const libsDir = path.join(baseDir, "node_modules");
-    if (!fs.existsSync(libsDir)) {
-        throw new Error("no node_modules found in the plugin directory");
-    }
-    const proto = fs.readFileSync(manifestPath, { encoding: "utf8" });
-    const functionDescriptors = getPluginFunctionDescriptors(proto, manifestPath);
-    const inputFileContent = fs.readFileSync(inputFile, { encoding: "utf8" });
-    assertPluginCodeHasAllFunctionsFromManifest(inputFileContent, functionDescriptors);
-    const entryPointCode = generateEntryPointCode(functionDescriptors);
-    const mergedPluginCode = mergeInputPluginCodeWithEntrypoint(inputFileContent, entryPointCode);
-    const mergedTempFilePath = writeMergedPluginCodeTempFile(mergedPluginCode, path.parse(inputFile).dir, inputFileName);
-    const globalFile = path.join(libsDir, "@asterai/sdk/global.ts");
-    const options = {
-        inputFiles: [mergedTempFilePath, globalFile],
-        baseDir,
-        outputFile,
-        libs: libsDir,
-    };
-    try {
-        await compile(options);
-    }
-    finally {
-        fs.unlinkSync(mergedTempFilePath);
-    }
-    return {
-        manifestPath,
-        outputFile,
-    };
-};
-const getPluginFunctionDescriptors = (proto, protoPath) => {
-    const protoMerged = mergeProtoImports(proto, protoPath, false, false);
-    const result = protobuf.parse(protoMerged);
-    const namespace = result.root.resolveAll();
-    const objects = namespace.nestedArray;
-    const serviceObject = objects.find(o => o.methods !== undefined);
-    if (!serviceObject) {
-        throw new Error("no service found in plugin manifest");
-    }
-    const service = serviceObject;
-    return service.methodsArray.map(m => ({
-        functionName: m.name,
-        inputType: m.requestType,
-        outputType: m.responseType,
-    }));
-};
-const generateEntryPointCode = (functionDescriptors) => {
-    const importsCode = `
-    import { Protobuf } from "@asterai/as-proto/assembly";
-    import { readBufferFromPtr, writeBufferToPr } from "@asterai/sdk/buffer";
-  `;
-    let code = "\n// generated plugin entry points\n\n";
-    for (const functionDescriptor of functionDescriptors) {
-        const template = `
-      export function {{func}}_entry_point(ptr: u32): u32 {
-        const inputBuffer = readBufferFromPtr(ptr);
-        const input = Protobuf.decode<{{inpt}}>(
-          inputBuffer,
-          {{inpt}}.decode,
-        );
-        const output = {{func}}(input);
-        const outputBuffer = Protobuf.encode<{{outp}}>(
-          output,
-          {{outp}}.encode,
-        );
-        return writeBufferToPr(outputBuffer);
-      }
-    `;
-        const view = {
-            func: functionDescriptor.functionName,
-            inpt: functionDescriptor.inputType,
-            outp: functionDescriptor.outputType,
-        };
-        const functionEntryPoint = Mustache.render(template, view);
-        code = `${code}\n${functionEntryPoint}`;
-    }
-    return {
-        importsCode,
-        entryPointsCode: code,
-    };
-};
-const mergeInputPluginCodeWithEntrypoint = (pluginCode, entryPoint) => `${entryPoint.importsCode}\n${pluginCode}\n${entryPoint.entryPointsCode}`;
-const writeMergedPluginCodeTempFile = (source, inputFileDir, inputFileName) => {
-    const tempFileName = `.entrypoint.${inputFileName}.ts`;
-    const tempFilePath = path.join(inputFileDir, tempFileName);
-    fs.writeFileSync(tempFilePath, source, { encoding: "utf8" });
-    return tempFilePath;
-};
-/**
- * Throw an error if the plugin WASM source is missing a function from
- * the manifest.
- * The only purpose of this function is to let the user know about
- * the issue in a direct way.
- */
-const assertPluginCodeHasAllFunctionsFromManifest = (source, functionDescriptors) => {
-    for (const functionDescriptor of functionDescriptors) {
-        const includesFunction = source.includes(`function ${functionDescriptor.functionName}`);
-        if (!includesFunction) {
-            throw new Error(`function "${functionDescriptor.functionName}" was defined in plugin ` +
-                "manifest (.proto file) but is missing from plugin code");
-        }
-    }
-};

package/dist/commands/codegen.d.ts

@@ -1,22 +0,0 @@
-import { Command } from "@oclif/core";
-export type CodegenFlags = {
-    manifest: string;
-    outputDir: string;
-    appId?: string;
-    language?: string;
-    staging?: boolean;
-};
-export default class Codegen extends Command {
-    static args: {};
-    static description: string;
-    static examples: string[];
-    static flags: {
-        manifest: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        outputDir: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        appId: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        language: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        staging: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
-    };
-    run(): Promise<void>;
-}
-export declare const codegen: (flags: CodegenFlags) => Promise<void>;