@quantum-hub/qhubctl 2.2.2-next.1 → 2.2.3-next.1

package/README.md

@@ -114,10 +114,12 @@ npm test                    # run tests + lint
 npm run test:coverage       # run tests with lcov coverage report
 ```
 
-### Lint
+### Lint and format
 
 ```bash
-npm run lint
+npm run lint          # eslint + prettier --check
+npm run lint:code:fix # eslint --fix
+npm run format        # prettier --write
 ```
 
 ### Generate docs

package/dist/commands/compress.d.ts

@@ -1,2 +1,2 @@
-import { Command } from 'commander';
+import { Command } from "commander";
 export declare const compressCommand: Command;

package/dist/commands/compress.js

@@ -1,32 +1,32 @@
-import { Command } from 'commander';
-import fs from 'fs-extra';
-import path from 'node:path';
-import { zipProjectFolder } from '../lib/up/zip.js';
-import { enforceRequiredFiles } from '../lib/up/required-files.js';
-import { QHUBIGNORE_HELP } from '../lib/up/qhubignore-help.js';
-import { error, spinner, stdout } from '../lib/output.js';
+import { Command } from "commander";
+import fs from "fs-extra";
+import path from "node:path";
+import { zipProjectFolder } from "../lib/up/zip.js";
+import { enforceRequiredFiles } from "../lib/up/required-files.js";
+import { QHUBIGNORE_HELP } from "../lib/up/qhubignore-help.js";
+import { error, spinner, stdout } from "../lib/output.js";
 const EXAMPLES = `
 Examples:
   $ qhubctl compress`;
-export const compressCommand = new Command('compress')
+export const compressCommand = new Command("compress")
     .description(`Compresses the current project and creates a ZIP file. ${QHUBIGNORE_HELP}`)
-    .addHelpText('after', EXAMPLES)
+    .addHelpText("after", EXAMPLES)
     .action(async () => {
-    const spin = spinner('Compressing project');
+    const spin = spinner("Compressing project");
     const targetDirectory = process.cwd();
-    const targetFilename = 'service.zip';
-    const targetFilePath = path.join(targetDirectory, '/', targetFilename);
+    const targetFilename = "service.zip";
+    const targetFilePath = path.join(targetDirectory, "/", targetFilename);
     try {
         await enforceRequiredFiles(targetDirectory);
     }
     catch (err) {
-        spin.fail('Compression aborted');
+        spin.fail("Compression aborted");
         error(err.message);
     }
     if (fs.existsSync(targetFilePath)) {
         fs.unlinkSync(targetFilePath);
     }
-    await zipProjectFolder('./', targetDirectory, targetFilename);
-    spin.succeed('Project compressed');
+    await zipProjectFolder("./", targetDirectory, targetFilename);
+    spin.succeed("Project compressed");
     stdout(`\nFile created at: ${targetFilePath}`);
 });

package/dist/commands/datapool-upload.d.ts

@@ -1,2 +1,2 @@
-import { Command } from 'commander';
+import { Command } from "commander";
 export declare const datapoolUploadCommand: Command;

package/dist/commands/datapool-upload.js

@@ -1,10 +1,10 @@
-import { input, select } from '@inquirer/prompts';
-import { Command } from 'commander';
-import fs from 'node:fs';
-import path from 'node:path';
-import { spinner, stdout } from '../lib/output.js';
-import { requireAuth } from '../model/command.js';
-import { HubPlatformClient, HubPlatformError } from '@quantum-hub/qhub-api/platform';
+import { input, select } from "@inquirer/prompts";
+import { Command } from "commander";
+import fs from "node:fs";
+import path from "node:path";
+import { spinner, stdout } from "../lib/output.js";
+import { requireAuth } from "../model/command.js";
+import { HubPlatformClient, HubPlatformError } from "@quantum-hub/qhub-api/platform";
 function extractError(err) {
     const bodyObj = err.body;
     if (bodyObj.errorMessage)
@@ -33,11 +33,11 @@ function printHttpSpecificError(datapoolId, statusCode, errorMessage) {
 function handleUploadError(err, datapoolId) {
     if (err instanceof HubPlatformError) {
         const statusCode = err.statusCode ?? 500;
-        let errorMessage = 'Unknown API error occurred';
+        let errorMessage = "Unknown API error occurred";
         if (err.body) {
-            if (typeof err.body === 'string')
+            if (typeof err.body === "string")
                 errorMessage = err.body;
-            else if (typeof err.body === 'object')
+            else if (typeof err.body === "object")
                 errorMessage = extractError(err);
             else if (err.message)
                 errorMessage = err.message;
@@ -45,7 +45,7 @@ function handleUploadError(err, datapoolId) {
         else if (err.message) {
             errorMessage = err.message;
         }
-        printHttpSpecificError(datapoolId || 'unknown', statusCode, errorMessage);
+        printHttpSpecificError(datapoolId || "unknown", statusCode, errorMessage);
     }
     const msg = err instanceof Error ? err.message : String(err);
     throw new Error(`Unexpected Error: ${msg}`);
@@ -54,26 +54,26 @@ async function promptForDatapoolAction(client) {
     try {
         const dataPools = await client.dataPools.getDataPools();
         if (dataPools.length === 0) {
-            stdout('No data pools found. Creating a new one...');
-            return 'create';
+            stdout("No data pools found. Creating a new one...");
+            return "create";
         }
         return await select({
-            message: 'What would you like to do?',
+            message: "What would you like to do?",
             choices: [
-                { name: 'Create a new data pool', value: 'create' },
-                { name: 'Select an existing data pool', value: 'select' },
+                { name: "Create a new data pool", value: "create" },
+                { name: "Select an existing data pool", value: "select" },
             ],
-            default: 'create',
+            default: "create",
         });
     }
     catch {
-        return 'create';
+        return "create";
     }
 }
 async function createDatapool(client, suggestedName) {
     try {
         const name = await input({
-            message: 'Enter a name for the new data pool:',
+            message: "Enter a name for the new data pool:",
             default: `Data Pool for ${suggestedName}`,
         });
         const datapool = await client.dataPools.createDataPool({ name });
@@ -82,7 +82,7 @@ async function createDatapool(client, suggestedName) {
     }
     catch (err) {
         if (err instanceof HubPlatformError) {
-            const errorMessage = err.body || err.message || 'Unknown API error occurred';
+            const errorMessage = err.body || err.message || "Unknown API error occurred";
             throw new Error(`Failed to create data pool (HTTP ${err.statusCode}): ${JSON.stringify(errorMessage)}`, { cause: err });
         }
         const msg = err instanceof Error ? err.message : String(err);
@@ -93,10 +93,10 @@ async function selectExistingDatapool(client) {
     try {
         const dataPools = await client.dataPools.getDataPools();
         if (dataPools.length === 0) {
-            stdout('No existing data pools found. Creating a new one...');
-            return createDatapool(client, 'upload');
+            stdout("No existing data pools found. Creating a new one...");
+            return createDatapool(client, "upload");
         }
-        stdout('\nAvailable data pools:');
+        stdout("\nAvailable data pools:");
         dataPools.forEach((pool, index) => {
             stdout(`${index + 1}. ${pool.name} (${pool.id})`);
         });
@@ -110,14 +110,14 @@ async function selectExistingDatapool(client) {
         return selection;
     }
     catch {
-        throw new Error('Failed to retrieve data pools');
+        throw new Error("Failed to retrieve data pools");
     }
 }
 async function ensureDatapoolExists(client, datapoolId, filePaths) {
     if (!datapoolId) {
-        stdout('No data pool ID provided. You can create a new data pool or select an existing one.');
+        stdout("No data pool ID provided. You can create a new data pool or select an existing one.");
         const action = await promptForDatapoolAction(client);
-        return action === 'create'
+        return action === "create"
             ? createDatapool(client, filePaths[0])
             : selectExistingDatapool(client);
     }
@@ -129,7 +129,7 @@ async function ensureDatapoolExists(client, datapoolId, filePaths) {
         if (err instanceof HubPlatformError && err.statusCode === 404) {
             stdout(`Data pool ${datapoolId} not found. Would you like to create a new data pool instead?`);
             const action = await promptForDatapoolAction(client);
-            return action === 'create'
+            return action === "create"
                 ? createDatapool(client, filePaths[0])
                 : selectExistingDatapool(client);
         }
@@ -141,11 +141,11 @@ Examples:
   $ qhubctl datapool upload --file ./data/dataset.csv
   $ qhubctl datapool upload --file ./data/dataset.csv --file ./data/metadata.json
   $ qhubctl datapool upload -f ./data/dataset.csv -f ./data/metadata.json --datapool-id 550e8400-e29b-41d4-a716-446655440000`;
-export const datapoolUploadCommand = new Command('upload')
-    .description('Upload files to a data pool')
-    .requiredOption('-f, --file <value...>', 'Path to a file to upload (can be specified multiple times)')
-    .option('-d, --datapool-id <value>', 'ID of the data pool to upload the files to (optional - will prompt to create a new one if not provided)')
-    .addHelpText('after', EXAMPLES)
+export const datapoolUploadCommand = new Command("upload")
+    .description("Upload files to a data pool")
+    .requiredOption("-f, --file <value...>", "Path to a file to upload (can be specified multiple times)")
+    .option("-d, --datapool-id <value>", "ID of the data pool to upload the files to (optional - will prompt to create a new one if not provided)")
+    .addHelpText("after", EXAMPLES)
     .action(async (opts) => {
     const userConfig = await requireAuth();
     const baseUrl = userConfig.endpoint?.basePath
@@ -156,7 +156,7 @@ export const datapoolUploadCommand = new Command('upload')
     const client = new HubPlatformClient({
         baseUrl,
         apiKey,
-        headers: { 'X-OrganizationId': organizationId },
+        headers: { "X-OrganizationId": organizationId },
     });
     const filePaths = opts.file;
     for (const filePath of filePaths) {
@@ -176,12 +176,12 @@ export const datapoolUploadCommand = new Command('upload')
         try {
             const fileStream = fs.createReadStream(filePath);
             const result = await client.dataPools.addDataPoolFile(datapoolId, { file: fileStream });
-            spin.succeed('\u2713');
+            spin.succeed("\u2713");
             stdout(`Successfully uploaded ${fileName} to data pool ${datapoolId}`);
             stdout(`File ID: ${result.id}`);
         }
         catch (err) {
-            spin.fail('\u2717');
+            spin.fail("\u2717");
             handleUploadError(err, datapoolId);
         }
     }

package/dist/commands/get-context.d.ts

@@ -1,2 +1,2 @@
-import { Command } from 'commander';
+import { Command } from "commander";
 export declare const getContextCommand: Command;

package/dist/commands/get-context.js

@@ -1,11 +1,11 @@
-import { Command } from 'commander';
-import { requireAuth } from '../model/command.js';
+import { Command } from "commander";
+import { requireAuth } from "../model/command.js";
 const EXAMPLES = `
 Examples:
   $ qhubctl get-context`;
-export const getContextCommand = new Command('get-context')
-    .description('Get the current context, i.e., the personal or organization account you are currently working with.')
-    .addHelpText('after', EXAMPLES)
+export const getContextCommand = new Command("get-context")
+    .description("Get the current context, i.e., the personal or organization account you are currently working with.")
+    .addHelpText("after", EXAMPLES)
     .action(async () => {
     // requireAuth prints "Current context: ..." as a side-effect
     await requireAuth();

package/dist/commands/init.d.ts

@@ -1,2 +1,2 @@
-import { Command } from 'commander';
+import { Command } from "commander";
 export declare const initCommand: Command;

package/dist/commands/init.js

@@ -1,40 +1,44 @@
-import { Command } from 'commander';
-import fs from 'fs-extra';
-import path from 'node:path';
-import { DEFAULT_STARTER, promptUserInput, resolveServiceDirectory } from '../lib/init-user-input.js';
-import { randomName } from '../lib/random-name.js';
-import { cloneRepository } from '../lib/repository.js';
-import { error, stdout } from '../lib/output.js';
-import { Runtime } from '../model/managed-service-config.js';
-import { writeServiceConfig } from '../service/service-config-service.js';
+import { Command } from "commander";
+import fs from "fs-extra";
+import path from "node:path";
+import { DEFAULT_STARTER, promptUserInput, resolveServiceDirectory, } from "../lib/init-user-input.js";
+import { randomName } from "../lib/random-name.js";
+import { cloneRepository } from "../lib/repository.js";
+import { error, stdout } from "../lib/output.js";
+import { Runtime } from "../model/managed-service-config.js";
+import { writeServiceConfig } from "../service/service-config-service.js";
 const EXAMPLES = `
 Examples:
   $ qhubctl init
   $ qhubctl init --non-interactive`;
-export const initCommand = new Command('init')
-    .description('Bootstrap project to create a service.')
-    .option('--name <value>', 'The name of the service')
-    .option('--non-interactive', 'Run it in non-interactive mode', false)
-    .addHelpText('after', EXAMPLES)
+export const initCommand = new Command("init")
+    .description("Bootstrap project to create a service.")
+    .option("--name <value>", "The name of the service")
+    .option("--non-interactive", "Run it in non-interactive mode", false)
+    .addHelpText("after", EXAMPLES)
     .action(async (opts) => {
     const nonInteractive = opts.nonInteractive;
     let name = opts.name ?? randomName();
-    const input = nonInteractive ? {
-        cpu: 1,
-        descriptionFile: 'README.md',
-        gpu: undefined,
-        memory: 1,
-        name: name,
-        starter: DEFAULT_STARTER,
-    } : await promptUserInput(name);
+    const input = nonInteractive
+        ? {
+            cpu: 1,
+            descriptionFile: "README.md",
+            gpu: undefined,
+            memory: 1,
+            name: name,
+            starter: DEFAULT_STARTER,
+        }
+        : await promptUserInput(name);
     name = input.name || name;
-    const targetDirectory = input.starter ? path.join(process.cwd(), name) : path.join(process.cwd());
+    const targetDirectory = input.starter
+        ? path.join(process.cwd(), name)
+        : path.join(process.cwd());
     if (input.starter && fs.existsSync(targetDirectory)) {
         error(`Destination ${targetDirectory} already exists. Please choose another name.`);
     }
     const serviceConfig = {
         name,
-        descriptionFile: input.descriptionFile ?? 'README.md',
+        descriptionFile: input.descriptionFile ?? "README.md",
         resources: {
             cpu: input.cpu,
             memory: input.memory,
@@ -53,12 +57,12 @@ export const initCommand = new Command('init')
     }
     const serviceDirectory = resolveServiceDirectory(targetDirectory, input.starter);
     writeServiceConfig(serviceDirectory, serviceConfig);
-    stdout('\u{1F389} Initialized project. Happy hacking!');
+    stdout("\u{1F389} Initialized project. Happy hacking!");
     if (input.starter) {
-        stdout('\n Next steps:');
+        stdout("\n Next steps:");
         stdout(`  \u{2022} cd ${name}`);
-        stdout('  \u{2022} qhubctl up   (deploys your code as a service to Kipu Quantum Hub)');
-        stdout('  \u{2022} qhubctl run  (executes your service using the data from the input directory)');
+        stdout("  \u{2022} qhubctl up   (deploys your code as a service to Kipu Quantum Hub)");
+        stdout("  \u{2022} qhubctl run  (executes your service using the data from the input directory)");
     }
-    stdout('');
+    stdout("");
 });

package/dist/commands/list-contexts.d.ts

@@ -1,2 +1,2 @@
-import { Command } from 'commander';
+import { Command } from "commander";
 export declare const listContextsCommand: Command;

package/dist/commands/list-contexts.js

@@ -1,26 +1,34 @@
-import { Command } from 'commander';
-import Table from 'tty-table';
-import { spinner, stdout } from '../lib/output.js';
-import { requireAuth } from '../model/command.js';
-import QuantumHubService from '../service/quantum-hub-service.js';
+import { Command } from "commander";
+import Table from "tty-table";
+import { spinner, stdout } from "../lib/output.js";
+import { requireAuth } from "../model/command.js";
+import QuantumHubService from "../service/quantum-hub-service.js";
 const EXAMPLES = `
 Examples:
   $ qhubctl list-contexts`;
-export const listContextsCommand = new Command('list-contexts')
-    .description('Retrieves the available contexts, i.e., the personal or organizational accounts available to you to work with.')
-    .addHelpText('after', EXAMPLES)
+export const listContextsCommand = new Command("list-contexts")
+    .description("Retrieves the available contexts, i.e., the personal or organizational accounts available to you to work with.")
+    .addHelpText("after", EXAMPLES)
     .action(async () => {
     const userConfig = await requireAuth();
     const quantumHubService = new QuantumHubService(userConfig);
-    const spin = spinner('Loading available contexts');
+    const spin = spinner("Loading available contexts");
     const accounts = await quantumHubService.getAccounts();
-    spin.succeed('Contexts loaded');
-    const tableData = accounts
-        .map(account => ({ displayName: account.displayName ?? '', id: account.id ?? '', isOrganization: account.isOrganization ?? false }));
+    spin.succeed("Contexts loaded");
+    const tableData = accounts.map((account) => ({
+        displayName: account.displayName ?? "",
+        id: account.id ?? "",
+        isOrganization: account.isOrganization ?? false,
+    }));
     const header = [
         { value: "displayName", alias: "Name", align: "left" },
         { value: "id", alias: "ID", align: "left" },
-        { value: "isOrganization", alias: "Account", width: 14, formatter: (value) => value ? "Organization" : "Personal" },
+        {
+            value: "isOrganization",
+            alias: "Account",
+            width: 14,
+            formatter: (value) => (value ? "Organization" : "Personal"),
+        },
     ];
     const t = Table(header, tableData);
     stdout(t.render());

package/dist/commands/login.d.ts

@@ -1,2 +1,2 @@
-import { Command } from 'commander';
+import { Command } from "commander";
 export declare const loginCommand: Command;

package/dist/commands/login.js

@@ -1,27 +1,27 @@
-import { password } from '@inquirer/prompts';
-import { Command } from 'commander';
-import { spinner } from '../lib/output.js';
-import { configDir, getUserConfig, showBasePathRevertNotice, showCustomBasePathWarning } from '../model/command.js';
-import { AuthType, defaultBasePath, hasCustomBasePath, resolveEndpoint } from '../model/user-config.js';
-import AuthService from '../service/auth-service.js';
-import { writeUserConfig } from '../service/user-config-service.js';
+import { password } from "@inquirer/prompts";
+import { Command } from "commander";
+import { spinner } from "../lib/output.js";
+import { configDir, getUserConfig, showBasePathRevertNotice, showCustomBasePathWarning, } from "../model/command.js";
+import { AuthType, defaultBasePath, hasCustomBasePath, resolveEndpoint, } from "../model/user-config.js";
+import AuthService from "../service/auth-service.js";
+import { writeUserConfig } from "../service/user-config-service.js";
 const EXAMPLES = `
 Examples:
   $ qhubctl login -t <personal access token>
   $ qhubctl login -t <personal access token> --base-path ${defaultBasePath}`;
-export const loginCommand = new Command('login')
-    .description('Login with your credentials')
-    .option('-t, --token <value>', 'Your personal access token')
-    .option('--base-path <value>', 'Custom base path for authentication (development)')
-    .addHelpText('after', EXAMPLES)
+export const loginCommand = new Command("login")
+    .description("Login with your credentials")
+    .option("-t, --token <value>", "Your personal access token")
+    .option("--base-path <value>", "Custom base path for authentication (development)")
+    .addHelpText("after", EXAMPLES)
     .action(async (opts) => {
     let { token } = opts;
     const { basePath } = opts;
     if (!token) {
-        token = await password({ message: 'Enter or paste your personal access token?', mask: true });
+        token = await password({ message: "Enter or paste your personal access token?", mask: true });
     }
     if (!token) {
-        throw new Error('Invalid credentials. Please try again.');
+        throw new Error("Invalid credentials. Please try again.");
     }
     const userConfig = getUserConfig();
     const endpoint = resolveEndpoint(userConfig, basePath);
@@ -29,7 +29,7 @@ export const loginCommand = new Command('login')
     if (basePath) {
         showCustomBasePathWarning();
     }
-    const spin = spinner('Login...');
+    const spin = spinner("Login...");
     const user = await new AuthService({ ...userConfig, endpoint }).authenticate(token);
     const newUserConfig = {
         ...userConfig,
@@ -45,7 +45,7 @@ export const loginCommand = new Command('login')
         endpoint,
     };
     writeUserConfig(configDir, newUserConfig);
-    spin.succeed('Login successful');
+    spin.succeed("Login successful");
     if (revertingToDefault) {
         showBasePathRevertNotice();
     }

package/dist/commands/logout.d.ts

@@ -1,2 +1,2 @@
-import { Command } from 'commander';
+import { Command } from "commander";
 export declare const logoutCommand: Command;

package/dist/commands/logout.js

@@ -1,25 +1,25 @@
-import { Command } from 'commander';
-import { spinner } from '../lib/output.js';
-import { configDir, getUserConfig, showBasePathRevertNotice } from '../model/command.js';
-import { hasCustomBasePath } from '../model/user-config.js';
-import { writeUserConfig } from '../service/user-config-service.js';
+import { Command } from "commander";
+import { spinner } from "../lib/output.js";
+import { configDir, getUserConfig, showBasePathRevertNotice } from "../model/command.js";
+import { hasCustomBasePath } from "../model/user-config.js";
+import { writeUserConfig } from "../service/user-config-service.js";
 const EXAMPLES = `
 Examples:
   $ qhubctl logout`;
-export const logoutCommand = new Command('logout')
-    .description('Logout')
-    .addHelpText('after', EXAMPLES)
+export const logoutCommand = new Command("logout")
+    .description("Logout")
+    .addHelpText("after", EXAMPLES)
     .action(async () => {
     const userConfig = getUserConfig();
     const revertingToDefault = hasCustomBasePath(userConfig);
-    const spin = spinner('Logout');
+    const spin = spinner("Logout");
     writeUserConfig(configDir, {
         ...userConfig,
         auth: undefined,
         context: undefined,
         endpoint: undefined,
     });
-    spin.succeed('Logout successful');
+    spin.succeed("Logout successful");
     if (revertingToDefault) {
         showBasePathRevertNotice();
     }

package/dist/commands/openapi.d.ts

@@ -1,2 +1,2 @@
-import { Command } from 'commander';
+import { Command } from "commander";
 export declare const openapiCommand: Command;