@asterai/cli 0.3.1 → 0.4.0

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @asterai/cli
 $ asterai COMMAND
 running command...
 $ asterai (--version)
-@asterai/cli/0.3.1 linux-x64 node-v20.12.2
+@asterai/cli/0.4.0 linux-x64 node-v20.12.2
 $ asterai --help [COMMAND]
 USAGE
   $ asterai COMMAND
@@ -37,6 +37,7 @@ USAGE
 * [`asterai deploy [INPUT]`](#asterai-deploy-input)
 * [`asterai help [COMMAND]`](#asterai-help-command)
 * [`asterai init [OUTDIR]`](#asterai-init-outdir)
+* [`asterai query`](#asterai-query)
 
 ## `asterai auth KEY`
 
@@ -53,7 +54,7 @@ EXAMPLES
   $ asterai auth
 ```
 
-_See code: [src/commands/auth.ts](https://github.com/asterai-io/asterai-sdk/blob/v0.3.1/src/commands/auth.ts)_
+_See code: [src/commands/auth.ts](https://github.com/asterai-io/asterai-sdk/blob/v0.4.0/src/commands/auth.ts)_
 
 ## `asterai build [INPUT]`
 
@@ -73,7 +74,7 @@ EXAMPLES
   $ asterai build
 ```
 
-_See code: [src/commands/build.ts](https://github.com/asterai-io/asterai-sdk/blob/v0.3.1/src/commands/build.ts)_
+_See code: [src/commands/build.ts](https://github.com/asterai-io/asterai-sdk/blob/v0.4.0/src/commands/build.ts)_
 
 ## `asterai codegen`
 
@@ -97,7 +98,7 @@ EXAMPLES
   $ asterai codegen
 ```
 
-_See code: [src/commands/codegen.ts](https://github.com/asterai-io/asterai-sdk/blob/v0.3.1/src/commands/codegen.ts)_
+_See code: [src/commands/codegen.ts](https://github.com/asterai-io/asterai-sdk/blob/v0.4.0/src/commands/codegen.ts)_
 
 ## `asterai deploy [INPUT]`
 
@@ -120,7 +121,7 @@ EXAMPLES
   $ asterai deploy --app 66a46b12-b1a7-4b72-a64a-0e4fe21902b6
 ```
 
-_See code: [src/commands/deploy.ts](https://github.com/asterai-io/asterai-sdk/blob/v0.3.1/src/commands/deploy.ts)_
+_See code: [src/commands/deploy.ts](https://github.com/asterai-io/asterai-sdk/blob/v0.4.0/src/commands/deploy.ts)_
 
 ## `asterai help [COMMAND]`
 
@@ -157,5 +158,28 @@ EXAMPLES
   $ asterai init project-name
 ```
 
-_See code: [src/commands/init.ts](https://github.com/asterai-io/asterai-sdk/blob/v0.3.1/src/commands/init.ts)_
+_See code: [src/commands/init.ts](https://github.com/asterai-io/asterai-sdk/blob/v0.4.0/src/commands/init.ts)_
+
+## `asterai query`
+
+query an asterai app interactively
+
+```
+USAGE
+  $ asterai query -a <value> -k <value> [-s] [-e <value>]
+
+FLAGS
+  -a, --app=<value>       (required)
+  -e, --endpoint=<value>  [default: https://api.asterai.io]
+  -k, --key=<value>       (required) app query key
+  -s, --staging
+
+DESCRIPTION
+  query an asterai app interactively
+
+EXAMPLES
+  $ asterai query
+```
+
+_See code: [src/commands/query.ts](https://github.com/asterai-io/asterai-sdk/blob/v0.4.0/src/commands/query.ts)_
 <!-- commandsstop -->

package/dist/commands/codegen.js

@@ -60,9 +60,9 @@ export const codegen = (flags) => {
     if (flags.appId && flags.language) {
         return generateClientTypings(outDir, flags.language, flags.appId, flags.staging ?? false);
     }
-    return generateAssemblyScriptPluginTypings(outDir, baseDir, manifestPath);
+    return generateAssemblyScriptPluginTypings(flags, baseDir);
 };
-const generateAssemblyScriptPluginTypings = async (outDir, baseDir, manifestPath) => {
+const generateAssemblyScriptPluginTypings = async (flags, baseDir) => {
     const absoluteAsProtoGenPath = path.join(baseDir, AS_PROTO_GEN_PATH);
     try {
         execSync("protoc --version");
@@ -77,7 +77,7 @@ const generateAssemblyScriptPluginTypings = async (outDir, baseDir, manifestPath
         execSync("protoc " +
             `--plugin='protoc-gen-as=${absoluteAsProtoGenPath}' ` +
             `--experimental_allow_proto3_optional ` +
-            `--as_out='./${outDir}' ./${manifestPath}`);
+            `--as_out='./${flags.outputDir}' ./${flags.manifest}`);
     }
     catch (e) {
         console.error("Failed to generate protobuf types:", e);
@@ -96,32 +96,43 @@ const deleteOldGeneratedFiles = (outDir) => {
 };
 const generateClientTypings = async (outDir, language, appId, shouldUseStaging) => {
     const manifestsResponse = await downloadEnabledPluginsManifests(appId, shouldUseStaging);
-    fs.writeFileSync(path.join(outDir, "manifests.json"), JSON.stringify(manifestsResponse, null, 2));
-    console.log("manifests.json generated successfully.");
+    const asteraiProto = await fetchAsteraiProto();
+    const aggregatedManifest = aggregateManifests(manifestsResponse.manifests, asteraiProto);
+    const appPrefix = `app.${appId}`;
+    fs.writeFileSync(path.join(outDir, `${appPrefix}.proto`), aggregatedManifest.content);
     if (language === "ts") {
-        const aggregatedManifestPath = aggregateManifests(manifestsResponse.manifests);
+        console.log("generating TypeScript typings for plugin manifest...");
+        const jsOutput = `${appPrefix}.js`;
+        const dTsOutput = `${appPrefix}.d.ts`;
         execSync(`
-      npx -p protobufjs-cli pbjs -t static --no-service ${aggregatedManifestPath} -o ${path.join(outDir, "plugins.asterai.js")}
+      npx -p protobufjs-cli pbjs -t static --no-service ${aggregatedManifest.filePath} -o ${path.join(outDir, jsOutput)}
     `);
         execSync(`
-      npx -p protobufjs-cli pbts -o ${path.join(outDir, "plugins.asterai.d.ts")} ${path.join(outDir, "plugins.asterai.js")}
+      npx -p protobufjs-cli pbts -o ${path.join(outDir, dTsOutput)} ${path.join(outDir, jsOutput)}
     `);
-        fs.unlinkSync(aggregatedManifestPath);
+        fs.unlinkSync(aggregatedManifest.filePath);
         console.log("Typings generated successfully.");
     }
+    console.log("done.");
 };
-const aggregateManifests = (manifests) => {
-    let aggregatedManifest = `
-  syntax = 'proto3';
-  \n
-`;
+const fetchAsteraiProto = () => {
+    // TODO: fetch this from the local file system instead.
+    return axios
+        .get("https://unpkg.com/@asterai/sdk@latest/protobuf/asterai.proto")
+        .then(r => r.data);
+};
+const aggregateManifests = (manifests, asteraiProto) => {
+    let aggregatedManifest = `${asteraiProto}\n`;
     const osTmpDir = os.tmpdir();
     const aggregatedManifestPath = path.join(osTmpDir, "plugins.asterai.proto");
     for (const manifest of manifests) {
         aggregatedManifest += `${manifest.proto}\n`;
     }
     fs.writeFileSync(aggregatedManifestPath, aggregatedManifest);
-    return aggregatedManifestPath;
+    return {
+        content: aggregatedManifest,
+        filePath: aggregatedManifestPath,
+    };
 };
 const downloadEnabledPluginsManifests = async (appId, shouldUseStaging) => {
     const baseUrl = shouldUseStaging

package/dist/commands/query.d.ts

@@ -0,0 +1,13 @@
+import { Command } from "@oclif/core";
+export default class Query extends Command {
+    static args: {};
+    static description: string;
+    static examples: string[];
+    static flags: {
+        app: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        key: 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>;
+        endpoint: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/query.js

@@ -0,0 +1,93 @@
+import { Flags, Command } from "@oclif/core";
+import readline from "node:readline";
+import { AsteraiClient } from "@asterai/client";
+import { v4 as uuidv4 } from "uuid";
+const ANSI_COLORS = {
+    reset: "\x1b[0m",
+    bold: "\u001b[1m",
+};
+const USER_PREFIX = `${ANSI_COLORS.bold}user: ${ANSI_COLORS.reset}`;
+const ASSISTANT_PREFIX = `${ANSI_COLORS.bold}assistant: ${ANSI_COLORS.reset}`;
+const PRODUCTION_BASE_URL = "https://api.asterai.io";
+const STAGING_BASE_URL = "https://staging.api.asterai.io";
+export default class Query extends Command {
+    static args = {};
+    static description = "query an asterai app interactively";
+    static examples = [`<%= config.bin %> <%= command.id %>`];
+    static flags = {
+        app: Flags.string({
+            char: "a",
+            required: true,
+        }),
+        key: Flags.string({
+            char: "k",
+            required: true,
+            description: "app query key",
+        }),
+        staging: Flags.boolean({
+            char: "s",
+        }),
+        endpoint: Flags.string({
+            char: "e",
+            default: PRODUCTION_BASE_URL,
+        }),
+    };
+    async run() {
+        console.clear();
+        const { flags } = await this.parse(Query);
+        let output = "";
+        const addToOutput = (v) => {
+            output += v;
+        };
+        const apiBaseUrl = flags.staging ? STAGING_BASE_URL : flags.endpoint;
+        const client = new AsteraiClient({
+            appId: flags.app,
+            queryKey: flags.key,
+            apiBaseUrl,
+        });
+        const conversationId = uuidv4();
+        // Configure STDIN for when raw mode is enabled.
+        process.stdin.setEncoding("utf8");
+        process.stdin.on("data", key => {
+            if (key.toString() === "\u0003") {
+                process.stdout.write("\n");
+                process.exit();
+            }
+        });
+        const getUserInput = async () => {
+            addToOutput(USER_PREFIX);
+            const rl = readline.createInterface({
+                input: process.stdin,
+                output: process.stdout,
+            });
+            const input = await new Promise(resolve => rl.question(USER_PREFIX, i => resolve(i)));
+            rl.close();
+            // Enable raw mode to prevent STDIN from echoing in STDOUT.
+            process.stdin.setRawMode(true);
+            addToOutput(`${input}\r\n${ASSISTANT_PREFIX}`);
+            console.clear();
+            process.stdout.write(output);
+            const query = {
+                query: input,
+                conversationId,
+            };
+            const response = await client.query(query);
+            response.onToken(token => {
+                addToOutput(token);
+                process.stdout.write(token);
+            });
+            return new Promise(resolve => {
+                response.onEnd(() => {
+                    addToOutput("\n");
+                    process.stdout.write("\n");
+                    // Disable raw mode to prepare for next user input.
+                    process.stdin.setRawMode(false);
+                    resolve(undefined);
+                });
+            });
+        };
+        while (true) {
+            await getUserInput();
+        }
+    }
+}

package/oclif.manifest.json

@@ -223,7 +223,62 @@
         "commands",
         "init.js"
       ]
+    },
+    "query": {
+      "aliases": [],
+      "args": {},
+      "description": "query an asterai app interactively",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "app": {
+          "char": "a",
+          "name": "app",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "key": {
+          "char": "k",
+          "description": "app query key",
+          "name": "key",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "staging": {
+          "char": "s",
+          "name": "staging",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "endpoint": {
+          "char": "e",
+          "name": "endpoint",
+          "default": "https://api.asterai.io",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "query",
+      "pluginAlias": "@asterai/cli",
+      "pluginName": "@asterai/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "query.js"
+      ]
     }
   },
-  "version": "0.3.1"
+  "version": "0.4.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@asterai/cli",
   "description": "CLI for building and deploying asterai plugins",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "author": "asterai <support@asterai.io>",
   "repository": "asterai-io/asterai-sdk",
   "homepage": "https://github.com/asterai-io/asterai-sdk",
@@ -51,6 +51,7 @@
   "types": "dist/index.d.ts",
   "dependencies": {
     "@asterai/as-proto-gen": "^1.4.1",
+    "@asterai/client": "^0.1.1",
     "@oclif/core": "^3",
     "@oclif/plugin-help": "^6",
     "@oclif/plugin-plugins": "^5",
@@ -59,7 +60,8 @@
     "form-data": "^4.0.0",
     "mustache": "^4.2.0",
     "protobufjs": "^7.4.0",
-    "protobufjs-cli": "^1.1.3"
+    "protobufjs-cli": "^1.1.3",
+    "uuid": "^11.0.2"
   },
   "devDependencies": {
     "@oclif/prettier-config": "^0.2.1",