chore(commands): move command to separate modules (#30)

Signed-off-by: Tomas Pilar <tomas.pilar@ibm.com>

.eslintrc.yml

@@ -14,3 +14,10 @@ rules:
   "import/order":
     - error
     - newlines-between: always
+  "import/extensions":
+    - error
+    - ignorePackages
+    - js: always
+  "quote-props":
+    - error
+    - consistent

.prettierrc.yml

@@ -0,0 +1 @@
+quoteProps: "consistent"

src/commands/config/default.js

@@ -0,0 +1,55 @@
+import { stdin, stdout } from "node:process";
+import { createInterface } from "node:readline";
+import { promisify } from "node:util";
+
+import { DEFAULT_ENDPOINT } from "../../utils/constants.js";
+import { mergeConfig } from "../../utils/config.js";
+
+export const defaultCommandDefinition = [
+  "$0",
+  "Modify configuration",
+  {},
+  async (args) => {
+    const rl = createInterface({
+      input: stdin,
+      output: stdout,
+    });
+    const question = promisify(rl.question).bind(rl);
+    rl.on("close", () => {
+      console.log();
+    });
+
+    const config = {
+      configuration: {},
+      credentials: {},
+    };
+    if (args.profile) {
+      config.configuration.profiles = { [args.profile]: {} };
+      config.credentials.profiles = { [args.profile]: {} };
+    }
+
+    const endpoint = await question(
+      `Endpoint (${
+        args.endpoint ?? process.env.GENAI_ENDPOINT ?? DEFAULT_ENDPOINT
+      }): `
+    );
+    if (endpoint) {
+      if (args.profile) {
+        config.configuration.profiles[args.profile].endpoint = endpoint;
+      } else {
+        config.configuration.endpoint = endpoint;
+      }
+    }
+    const apiKey = await question(`API Key (${args.apiKey ?? "none"}): `);
+    if (apiKey) {
+      if (args.profile) {
+        config.credentials.profiles[args.profile].apiKey = apiKey;
+      } else {
+        config.credentials.apiKey = apiKey;
+      }
+    }
+
+    rl.close();
+    mergeConfig(config);
+  },
+];

src/commands/config/index.js

@@ -0,0 +1,15 @@
+import { defaultCommandDefinition } from "./default.js";
+import { profilesCommandDefinition } from "./profiles.js";
+import { removeCommandDefinition } from "./remove.js";
+import { showCommandDefinition } from "./show.js";
+
+export const configCommandDefinition = [
+  "config",
+  "Manage CLI configuration",
+  (yargs) =>
+    yargs
+      .command(...defaultCommandDefinition)
+      .command(...showCommandDefinition)
+      .command(...profilesCommandDefinition)
+      .command(...removeCommandDefinition),
+];

src/commands/config/profiles.js

@@ -0,0 +1,13 @@
+import { allProfiles } from "../../utils/config.js";
+
+export const profilesCommandDefinition = [
+  "profiles",
+  "List configuration profiles",
+  {},
+  () => {
+    const profiles = allProfiles();
+    profiles.forEach((profile) => {
+      console.log(profile);
+    });
+  },
+];

src/commands/config/remove.js

@@ -0,0 +1,10 @@
+import { deleteProfileConfig } from "../../utils/config.js";
+
+export const removeCommandDefinition = [
+  "remove",
+  "Remove configuration",
+  {},
+  (args) => {
+    deleteProfileConfig(args.profile);
+  },
+];

src/commands/config/show.js

@@ -0,0 +1,12 @@
+import { loadProfileConfig } from "../../utils/config.js";
+import { prettyPrint } from "../../utils/print.js";
+
+export const showCommandDefinition = [
+  "show",
+  "Show configuration",
+  {},
+  (args) => {
+    const config = loadProfileConfig(args.profile);
+    prettyPrint(config);
+  },
+];

src/commands/files/delete.js

@@ -0,0 +1,12 @@
+export const deleteCommandDefinition = [
+  "delete <id>",
+  "Delete a file",
+  (yargs) =>
+    yargs.positional("id", {
+      type: "string",
+      description: "Identifier of the file to be deleted",
+    }),
+  async (args) => {
+    await args.client.file({ id: args.id }, { delete: true });
+  },
+];

src/commands/files/download.js

@@ -0,0 +1,35 @@
+import { stdout } from "node:process";
+import { createWriteStream } from "node:fs";
+import { pipeline } from "node:stream/promises";
+
+import { groupOptions } from "../../utils/yargs.js";
+
+export const downloadCommandDefinition = [
+  "download <id>",
+  "Download a file",
+  (yargs) =>
+    yargs
+      .positional("id", {
+        type: "string",
+        description: "Identifier of the file to download",
+      })
+      .options(
+        groupOptions({
+          output: {
+            alias: "o",
+            describe: "Filepath to write the file to",
+            type: "string",
+            normalize: true,
+            requiresArg: true,
+            coerce: (output) => createWriteStream(output),
+          },
+        })
+      ),
+  async (args) => {
+    const { download } = await args.client.file({
+      id: args.id,
+    });
+    const readable = await download();
+    await pipeline(readable, args.output ?? stdout);
+  },
+];

src/commands/files/index.js

@@ -0,0 +1,21 @@
+import { clientMiddleware } from "../../middleware/client.js";
+
+import { deleteCommandDefinition } from "./delete.js";
+import { downloadCommandDefinition } from "./download.js";
+import { infoCommandDefinition } from "./info.js";
+import { listCommandDefinition } from "./list.js";
+import { uploadCommandDefinition } from "./upload.js";
+
+export const filesCommandDefinition = [
+  "files",
+  "Upload and manage files",
+  (yargs) =>
+    yargs
+      .middleware(clientMiddleware)
+      .command(...listCommandDefinition)
+      .command(...infoCommandDefinition)
+      .command(...uploadCommandDefinition)
+      .command(...downloadCommandDefinition)
+      .command(...deleteCommandDefinition)
+      .demandCommand(1, 1, "Please choose a command"),
+];

src/commands/files/info.js

@@ -0,0 +1,17 @@
+import { prettyPrint } from "../../utils/print.js";
+
+export const infoCommandDefinition = [
+  "info <id>",
+  "Show detailed information about a file",
+  (yargs) =>
+    yargs.positional("id", {
+      type: "string",
+      description: "Identifier of the file",
+    }),
+  async (args) => {
+    const { id, file_name, purpose, created_at } = await args.client.file({
+      id: args.id,
+    });
+    prettyPrint({ id, name: file_name, purpose, created_at });
+  },
+];

src/commands/files/list.js

@@ -0,0 +1,24 @@
+import { FilePurposeSchema } from "@ibm-generative-ai/node-sdk";
+
+import { groupOptions } from "../../utils/yargs.js";
+
+export const listCommandDefinition = [
+  "list",
+  "List all files",
+  groupOptions({
+    purpose: {
+      alias: "p",
+      type: "array",
+      description: "Filter listed by purpose",
+      requiresArg: true,
+      choices: FilePurposeSchema.options,
+    },
+  }),
+  async (args) => {
+    for await (const file of args.client.files()) {
+      if (!args.purpose || args.purpose.includes(file.purpose)) {
+        console.log(`${file.id} (${file.file_name})`);
+      }
+    }
+  },
+];

src/commands/files/upload.js

@@ -0,0 +1,44 @@
+import { createReadStream } from "node:fs";
+import path from "node:path";
+
+import { FilePurposeSchema } from "@ibm-generative-ai/node-sdk";
+
+import { groupOptions } from "../../utils/yargs.js";
+import { prettyPrint } from "../../utils/print.js";
+
+export const uploadCommandDefinition = [
+  "upload <file>",
+  "Upload a file",
+  (yargs) =>
+    yargs
+      .positional("file", {
+        type: "string",
+        describe: "Filepath to the file to be uploaded",
+        normalize: true,
+      })
+      .options(
+        groupOptions({
+          purpose: {
+            alias: "p",
+            description: "Purpose of the file",
+            requiresArg: true,
+            demandOption: true,
+            choices: FilePurposeSchema.options,
+          },
+          name: {
+            alias: "n",
+            type: "string",
+            description: "Name of the file",
+            requiresArg: true,
+          },
+        })
+      ),
+  async (args) => {
+    const { id, file_name, purpose, created_at } = await args.client.file({
+      purpose: args.purpose,
+      filename: args.name ?? path.parse(args.file).base,
+      file: createReadStream(args.file),
+    });
+    prettyPrint({ id, name: file_name, purpose, created_at });
+  },
+];

src/commands/generate/config.js

@@ -0,0 +1,94 @@
+import isEmpty from "lodash/isEmpty.js";
+import merge from "lodash/merge.js";
+
+import { pickDefined } from "../../utils/common.js";
+import { prettyPrint } from "../../utils/print.js";
+import { groupOptions } from "../../utils/yargs.js";
+
+export const configCommandDefinition = [
+  "config",
+  "Read and modify generate configuration",
+  (yargs) =>
+    yargs
+      .options(
+        groupOptions(
+          {
+            "input-text": {
+              type: "boolean",
+              description: "Include input text",
+            },
+            "generated-tokens": {
+              type: "boolean",
+              description: "Include the list of individual generated tokens",
+            },
+            "input-tokens": {
+              type: "boolean",
+              description: "Include the list of input tokens",
+            },
+            "token-logprobs": {
+              type: "boolean",
+              description: "Include logprob for each token",
+            },
+            "token-ranks": {
+              type: "boolean",
+              description: "Include rank of each returned token",
+            },
+            "top-n-tokens": {
+              type: "number",
+              requiresArg: true,
+              nargs: 1,
+              description:
+                "Include top n candidate tokens at the position of each returned token",
+            },
+          },
+          "Configuration:"
+        )
+      )
+      .middleware((args) => {
+        const return_options = pickDefined({
+          input_text: args.inputText,
+          generated_tokens: args.generatedTokens,
+          input_tokens: args.inputTokens,
+          token_logprobs: args.tokenLogprobs,
+          input_ranks: args.tokenRanks,
+          top_n_tokens: args.topNTokens,
+        });
+        args.parameters = !isEmpty(return_options)
+          ? merge({}, args.parameters, { return_options })
+          : args.parameters;
+      })
+      .options(
+        groupOptions({
+          reset: {
+            describe: "Reset the config",
+            type: "boolean",
+          },
+          replace: {
+            describe: "Replace the entire config",
+            type: "boolean",
+            conflicts: "reset",
+          },
+        })
+      ),
+  async (args) => {
+    const hasInput = args.model || args.parameters;
+
+    const output = hasInput
+      ? await args.client.generateConfig(
+          {
+            model_id: args.model,
+            parameters: args.parameters,
+          },
+          {
+            strategy: args.replace ? "replace" : "merge",
+            timeout: args.timeout,
+          }
+        )
+      : await args.client.generateConfig({
+          reset: args.reset,
+          timeout: args.timeout,
+        });
+
+    prettyPrint(output);
+  },
+];