@quantum-hub/qhubctl 1.1.5 → 1.3.0

package/dist/commands/compress/index.js

@@ -1,25 +0,0 @@
-import { ux } from '@oclif/core';
-import fs from 'fs-extra';
-import path from 'node:path';
-import { zipProjectFolder } from '../../lib/up/zip.js';
-import { AbstractCommand } from '../../model/command.js';
-export default class Compress extends AbstractCommand {
-    static description = `Compresses the current project and creates a ZIP file. Use the '.dockerignore' file to exclude files and directories from the ZIP file.`;
-    static examples = [
-        '$ qhubctl compress',
-    ];
-    async run() {
-        ux.action.start('Compressing project');
-        const targetDirectory = process.cwd();
-        const targetFilename = 'service.zip';
-        const targetFilePath = path.join(targetDirectory, '/', targetFilename);
-        // remove the file if it already exists
-        if (fs.existsSync(targetFilePath)) {
-            fs.unlinkSync(targetFilePath);
-        }
-        await zipProjectFolder('./', targetDirectory, targetFilename);
-        ux.action.stop('Succeeded.');
-        ux.stdout(`\nFile created at: ${targetFilePath}`);
-        this.exit();
-    }
-}

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

@@ -1,23 +0,0 @@
-import { AuthenticatedCommand } from '../../model/command.js';
-import { HubPlatformClient } from "@quantum-hub/qhub-api/platform";
-export default class DatapoolUpload extends AuthenticatedCommand {
-    static readonly description = "Upload files to a data pool";
-    static readonly examples: string[];
-    static readonly flags: {
-        file: import("@oclif/core/interfaces").OptionFlag<string[], import("@oclif/core/interfaces").CustomOptions>;
-        'datapool-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    hubPlatformClient: HubPlatformClient;
-    init(): Promise<void>;
-    run(): Promise<void>;
-    private ensureFilesExist;
-    private ensureDatapoolExists;
-    private createOrSelectDataPool;
-    private promptForDatapoolAction;
-    private selectExistingDatapool;
-    private createDatapool;
-    private uploadToDatapool;
-    private handleError;
-    private extractError;
-    private printHttpSpecificError;
-}

package/dist/commands/datapool/upload.js

@@ -1,260 +0,0 @@
-import { input, select } from '@inquirer/prompts';
-import { Flags, ux } from '@oclif/core';
-import fs from 'node:fs';
-import path from 'node:path';
-import { AuthenticatedCommand } from '../../model/command.js';
-import { HubPlatformClient, HubPlatformError } from "@quantum-hub/qhub-api/platform";
-export default class DatapoolUpload extends AuthenticatedCommand {
-    static description = 'Upload files to a data pool';
-    static 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',
-    ];
-    static flags = {
-        file: Flags.string({
-            char: 'f',
-            description: 'Path to a file to upload (can be specified multiple times)',
-            required: true,
-            multiple: true,
-        }),
-        'datapool-id': Flags.string({
-            char: 'd',
-            description: 'ID of the data pool to upload the files to (optional - will prompt to create a new one if not provided)',
-            required: false,
-        }),
-    };
-    hubPlatformClient;
-    async init() {
-        await this.parse(DatapoolUpload);
-        await super.init();
-        // Initialize the new Quantum Hub API client with proper configuration
-        // The new SDK expects the full base path including /qc-catalog
-        const baseUrl = this.userConfig.endpoint?.basePath
-            ? `${this.userConfig.endpoint.basePath}/qc-catalog`
-            : undefined; // Will use the default environment if no custom endpoint is set
-        const apiKey = this.userConfig.auth?.value;
-        this.hubPlatformClient = new HubPlatformClient({
-            baseUrl: baseUrl,
-            apiKey: apiKey,
-            organizationId: this.userConfig.context?.isOrganization ? this.userConfig.context.id : undefined,
-        });
-    }
-    async run() {
-        const { flags } = await this.parse(DatapoolUpload);
-        const filePaths = flags.file;
-        let datapoolId = flags['datapool-id'];
-        this.ensureFilesExist(filePaths);
-        // Handle datapool ID - check if exists or prompt to create
-        datapoolId = await this.ensureDatapoolExists(datapoolId, filePaths);
-        for (const filePath of filePaths) {
-            const fileName = path.basename(filePath);
-            ux.action.start(`Uploading ${fileName} to data pool ${datapoolId}`);
-            await this.uploadToDatapool(datapoolId, filePath);
-        }
-    }
-    ensureFilesExist(filePaths) {
-        // Validate files exist
-        for (const filePath of filePaths) {
-            if (!fs.existsSync(filePath)) {
-                this.error(`File not found: ${filePath}`);
-            }
-            // Check if file is readable
-            try {
-                fs.accessSync(filePath, fs.constants.R_OK);
-            }
-            catch {
-                this.error(`Cannot read file: ${filePath}`);
-            }
-        }
-    }
-    async ensureDatapoolExists(datapoolId, filePaths) {
-        // If no datapool ID provided, prompt to create or select one
-        if (!datapoolId) {
-            this.log('No data pool ID provided. You can create a new data pool or select an existing one.');
-            return await this.createOrSelectDataPool(filePaths);
-        }
-        // If datapool ID provided, check if it exists
-        try {
-            await this.hubPlatformClient.dataPools.getDataPool({ "id": datapoolId });
-            return datapoolId;
-        }
-        catch (error) {
-            if (error instanceof HubPlatformError && error.statusCode === 404) {
-                this.log(`Data pool ${datapoolId} not found. Would you like to create a new data pool instead?`);
-                return await this.createOrSelectDataPool(filePaths);
-            }
-            this.handleError(error, datapoolId);
-            throw error;
-        }
-    }
-    async createOrSelectDataPool(filePaths) {
-        const action = await this.promptForDatapoolAction();
-        if (action === 'create') {
-            const newDatapoolId = await this.createDatapool(filePaths[0]);
-            if (!newDatapoolId) {
-                this.error('Failed to create datapool');
-            }
-            return newDatapoolId;
-        }
-        else {
-            // List and select existing datapool
-            return await this.selectExistingDatapool();
-        }
-    }
-    async promptForDatapoolAction() {
-        // First, check if there are any existing DataPools
-        try {
-            const dataPools = await this.hubPlatformClient.dataPools.getDataPools();
-            if (dataPools.length === 0) {
-                this.log('No data pools found. Creating a new one...');
-                return 'create';
-            }
-            // Offer choice between creating new or selecting existing using select prompt
-            return await select({
-                message: 'What would you like to do?',
-                choices: [
-                    { name: 'Create a new data pool', value: 'create' },
-                    { name: 'Select an existing data pool', value: 'select' }
-                ],
-                default: 'create'
-            });
-        }
-        catch {
-            // If we can't list datapools, default to creating
-            return 'create';
-        }
-    }
-    async selectExistingDatapool() {
-        try {
-            const dataPools = await this.hubPlatformClient.dataPools.getDataPools();
-            if (dataPools.length === 0) {
-                this.log('No existing data pools found. Creating a new one...');
-                const newDatapoolId = await this.createDatapool('upload');
-                if (!newDatapoolId) {
-                    this.error('Failed to create datapool');
-                }
-                return newDatapoolId;
-            }
-            this.log('\nAvailable data pools:');
-            dataPools.forEach((pool, index) => {
-                this.log(`${index + 1}. ${pool.name} (${pool.id})`);
-            });
-            const selection = await input({
-                message: `Select a data pool (1-${dataPools.length}) or enter the ID directly:`,
-            });
-            // Check if it's a number (index selection)
-            const index = parseInt(selection, 10);
-            if (!isNaN(index) && index >= 1 && index <= dataPools.length) {
-                return dataPools[index - 1].id;
-            }
-            // Assume it's a direct ID
-            return selection;
-        }
-        catch {
-            this.error('Failed to retrieve data pools');
-        }
-    }
-    async createDatapool(suggestedName) {
-        try {
-            const name = await input({
-                message: 'Enter a name for the new data pool:',
-                default: `Data Pool for ${suggestedName}`,
-            });
-            const datapool = await this.hubPlatformClient.dataPools.createDataPool({
-                name,
-            });
-            this.log(`✓ Created new data pool: ${datapool.name} (${datapool.id})`);
-            return datapool.id;
-        }
-        catch (error) {
-            if (error instanceof HubPlatformError) {
-                const errorMessage = error.body || error.message || 'Unknown API error occurred';
-                this.error(`Failed to create data pool (HTTP ${error.statusCode}): ${JSON.stringify(errorMessage)}`);
-            }
-            else {
-                const errorMessage = error instanceof Error ? error.message : String(error);
-                this.error(`Failed to create data pool: ${errorMessage}`);
-            }
-        }
-    }
-    async uploadToDatapool(datapoolId, filePath) {
-        const fileName = path.basename(filePath);
-        try {
-            const fileStream = fs.createReadStream(filePath);
-            const result = await this.hubPlatformClient.dataPools.addDataPoolFile({ "id": datapoolId, file: fileStream });
-            ux.action.stop('✓');
-            this.log(`Successfully uploaded ${fileName} to data pool ${datapoolId}`);
-            this.log(`File ID: ${result.id}`);
-        }
-        catch (error) {
-            this.handleError(error, datapoolId);
-        }
-    }
-    handleError(error, datapoolId) {
-        ux.action.stop('✗');
-        if (error instanceof HubPlatformError) {
-            const statusCode = error.statusCode ?? 500; // Default to 500 if statusCode is not set
-            let errorMessage = 'Unknown API error occurred';
-            if (error.body) {
-                if (typeof error.body === 'string') {
-                    errorMessage = error.body;
-                }
-                else if (typeof error.body === 'object') {
-                    errorMessage = this.extractError(error);
-                }
-                else if (error.message) {
-                    errorMessage = error.message;
-                }
-            }
-            else if (error.message) {
-                errorMessage = error.message;
-            }
-            this.printHttpSpecificError(datapoolId || 'unknown', statusCode, errorMessage);
-            return error;
-        }
-        else {
-            const errorMessage = error instanceof Error ? error.message : String(error);
-            this.error(`Unexpected Error: ${errorMessage}`);
-        }
-    }
-    extractError(error) {
-        const bodyObj = error.body;
-        if (bodyObj.errorMessage) {
-            return bodyObj.errorMessage;
-        }
-        else if (bodyObj.detail) {
-            return bodyObj.detail;
-        }
-        else if (bodyObj.message) {
-            return bodyObj.message;
-        }
-        else {
-            return JSON.stringify(error.body);
-        }
-    }
-    printHttpSpecificError(datapoolId, statusCode, errorMessage) {
-        // Provide specific error messages based on status code
-        if (statusCode === 404) {
-            throw new Error(`Data pool not found: ${datapoolId}`);
-        }
-        else if (statusCode === 403) {
-            throw new Error(`Access denied. You don't have permission to upload to data pool: ${datapoolId}`);
-        }
-        else if (statusCode === 400) {
-            throw new Error(`Bad request. Please check the data pool ID and file format. Details: ${errorMessage}`);
-        }
-        else if (statusCode === 401) {
-            throw new Error(`Authentication failed. Please login again using 'qhubctl login'`);
-        }
-        else if (statusCode === 413) {
-            throw new Error(`File too large. The file exceeds the maximum allowed size for data pool uploads`);
-        }
-        else if (statusCode === 415) {
-            throw new Error(`Unsupported file type. Please check if the file format is supported`);
-        }
-        else {
-            throw new Error(`Failed to upload file (HTTP ${statusCode}): ${errorMessage}`);
-        }
-    }
-}

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

@@ -1,6 +0,0 @@
-import { AuthenticatedCommand } from '../../model/command.js';
-export default class GetContext extends AuthenticatedCommand {
-    static description: string;
-    static examples: string[];
-    run(): Promise<void>;
-}

package/dist/commands/get-context/index.js

@@ -1,10 +0,0 @@
-import { AuthenticatedCommand } from '../../model/command.js';
-export default class GetContext extends AuthenticatedCommand {
-    static description = 'Get the current context, i.e., the personal or organization account you are currently working with.';
-    static examples = [
-        '$ qhubctl get-context',
-    ];
-    async run() {
-        // printing the current context is done by parent 'init' method
-    }
-}

package/dist/commands/init/index.d.ts

@@ -1,10 +0,0 @@
-import { AbstractCommand } from '../../model/command.js';
-export default class Init extends AbstractCommand {
-    static description: string;
-    static examples: string[];
-    static flags: {
-        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        'non-interactive': import("@oclif/core/interfaces").BooleanFlag<boolean>;
-    };
-    run(): Promise<void>;
-}

package/dist/commands/init/index.js

@@ -1,75 +0,0 @@
-import { Flags, ux } from '@oclif/core';
-import fs from 'fs-extra';
-import path from 'node:path';
-import { DEFAULT_STARTER, promptUserInput } from '../../lib/init-user-input.js';
-import { randomName } from '../../lib/random-name.js';
-import { downloadRepository, extractStarter } from '../../lib/repository.js';
-import { AbstractCommand } from '../../model/command.js';
-import { Runtime } from '../../model/managed-service-config.js';
-import { writeServiceConfig } from '../../service/service-config-service.js';
-export default class Init extends AbstractCommand {
-    static description = 'Bootstrap project to create a service.';
-    static examples = [
-        '$ qhubctl init',
-    ];
-    static flags = {
-        name: Flags.string({ description: 'The name of the service', required: false }),
-        'non-interactive': Flags.boolean({
-            description: 'Run it in non-interactive mode',
-            required: false,
-        }),
-    };
-    async run() {
-        const { flags } = await this.parse(Init);
-        const nonInteractive = flags['non-interactive'];
-        let name = flags.name ?? randomName();
-        const input = nonInteractive ? {
-            cpu: 1,
-            descriptionFile: 'README.md',
-            gpu: undefined,
-            memory: 1,
-            name: name,
-            starter: DEFAULT_STARTER,
-        } : await promptUserInput(name);
-        name = input.name || name;
-        // use current directory if no template is selected
-        const targetDirectory = input.starter ? path.join(process.cwd(), name) : path.join(process.cwd());
-        // exit if the target directory already exists (only if a starter is selected)
-        if (input.starter && fs.existsSync(targetDirectory)) {
-            ux.error(`Destination ${targetDirectory} already exists. Please choose another name.`);
-        }
-        const serviceConfig = {
-            name,
-            descriptionFile: input.descriptionFile ?? 'README.md',
-            resources: {
-                cpu: input.cpu,
-                memory: input.memory,
-            },
-            runtime: input.starter ? input.starter.runtime : Runtime.PYTHON_TEMPLATE,
-        };
-        if (input.gpu) {
-            serviceConfig.resources.gpu = {
-                count: 1,
-                type: input.gpu,
-            };
-        }
-        // make sure the target directory exists if a starter is selected
-        if (input.starter) {
-            fs.mkdirSync(targetDirectory);
-        }
-        writeServiceConfig(targetDirectory, serviceConfig);
-        if (input.starter) {
-            const zip = await downloadRepository(input.starter.url);
-            const starterName = path.basename(input.starter.url, '.zip');
-            extractStarter(zip, starterName, targetDirectory);
-        }
-        ux.stdout('\u{1F389} Initialized project. Happy hacking!');
-        if (input.starter) {
-            ux.stdout('\n Next steps:');
-            ux.stdout(`  \u{2022} cd ${name}`);
-            ux.stdout('  \u{2022} qhubctl up   (deploys your code as a service to Kipu Quantum Hub)');
-            ux.stdout('  \u{2022} qhubclt run  (executes your service using the data from the input directory)');
-        }
-        ux.stdout('');
-    }
-}

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

@@ -1,9 +0,0 @@
-import { AuthenticatedCommand } from '../../model/command.js';
-import QuantumHubService from '../../service/quantum-hub-service.js';
-export default class ListContexts extends AuthenticatedCommand {
-    static description: string;
-    static examples: string[];
-    quantumHubService: QuantumHubService;
-    init(): Promise<void>;
-    run(): Promise<void>;
-}

package/dist/commands/list-contexts/index.js

@@ -1,30 +0,0 @@
-import { ux } from '@oclif/core';
-import Table from 'tty-table';
-import { AuthenticatedCommand } from '../../model/command.js';
-import QuantumHubService from '../../service/quantum-hub-service.js';
-export default class ListContexts extends AuthenticatedCommand {
-    static description = 'Retrieves the available contexts, i.e., the personal or organizational accounts available to you to work with.';
-    static examples = [
-        '$ qhubctl list-contexts',
-    ];
-    quantumHubService;
-    async init() {
-        await super.init();
-        this.quantumHubService = new QuantumHubService(this, this.config, this.userConfig);
-    }
-    async run() {
-        ux.action.start('Loading available contexts');
-        const accounts = await this.quantumHubService.getAccounts();
-        ux.action.stop('Done');
-        const tableData = accounts
-            .map(account => ({ displayName: account.displayName, id: account.id, isOrganization: account.isOrganization }));
-        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" },
-        ];
-        const t = Table(header, tableData);
-        ux.stdout(t.render());
-        ux.stdout();
-    }
-}

package/dist/commands/login/index.d.ts

@@ -1,10 +0,0 @@
-import { AbstractCommand } from '../../model/command.js';
-export default class Login extends AbstractCommand {
-    static description: string;
-    static examples: string[];
-    static flags: {
-        token: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        'base-path': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    run(): Promise<void>;
-}

package/dist/commands/login/index.js

@@ -1,62 +0,0 @@
-import { password } from '@inquirer/prompts';
-import { Flags, ux } from '@oclif/core';
-import { AbstractCommand } from '../../model/command.js';
-import { AuthType, defaultBasePath } from '../../model/user-config.js';
-import AuthService from '../../service/auth-service.js';
-import { writeUserConfig } from '../../service/user-config-service.js';
-export default class Login extends AbstractCommand {
-    static description = 'Login with your credentials';
-    static examples = [
-        '$ qhubctl login -t <personal access token>',
-        `$ qhubctl login -t <personal access token> --base-path ${defaultBasePath}`,
-    ];
-    static flags = {
-        token: Flags.string({ char: 't', description: 'Your personal access token', required: false }),
-        'base-path': Flags.string({ description: 'Custom base path for authentication (development)', required: false }),
-    };
-    async run() {
-        const { flags } = await this.parse(Login);
-        let { token } = flags;
-        const { 'base-path': basePath } = flags;
-        if (!token) {
-            token = await password({ message: 'Enter or paste your personal access token?', mask: true });
-        }
-        if (!token) {
-            throw new Error('Invalid credentials. Please try again.');
-        }
-        // Show warning if custom base path is provided
-        if (basePath) {
-            this.showCustomBasePathWarning();
-        }
-        ux.action.start('Login');
-        // Create temporary config with custom basePath for authentication
-        const tempUserConfig = basePath ? {
-            ...this.userConfig,
-            endpoint: {
-                basePath,
-                defaultHeaders: this.userConfig.endpoint?.defaultHeaders || {}
-            }
-        } : this.userConfig;
-        const user = await new AuthService(tempUserConfig).authenticate(token);
-        const userConfig = {
-            ...this.userConfig,
-            auth: {
-                type: AuthType.API_KEY,
-                value: token,
-            },
-            context: {
-                id: user.id,
-                displayName: `${user.firstname} ${user.lastname}`,
-                isOrganization: false,
-            },
-            ...(basePath && {
-                endpoint: {
-                    basePath,
-                    defaultHeaders: this.userConfig.endpoint?.defaultHeaders || {}
-                }
-            })
-        };
-        writeUserConfig(this.config.configDir, userConfig);
-        ux.action.stop('successful');
-    }
-}

package/dist/commands/logout/index.d.ts

@@ -1,6 +0,0 @@
-import { AbstractCommand } from '../../model/command.js';
-export default class Logout extends AbstractCommand {
-    static description: string;
-    static examples: string[];
-    run(): Promise<void>;
-}

package/dist/commands/logout/index.js

@@ -1,18 +0,0 @@
-import { ux } from '@oclif/core';
-import { AbstractCommand } from '../../model/command.js';
-import { writeUserConfig } from '../../service/user-config-service.js';
-export default class Logout extends AbstractCommand {
-    static description = 'Logout';
-    static examples = [
-        '$ qhubctl logout',
-    ];
-    async run() {
-        ux.action.start('Logout');
-        writeUserConfig(this.config.configDir, {
-            ...this.userConfig,
-            auth: undefined,
-            context: undefined,
-        });
-        ux.action.stop('successful');
-    }
-}

package/dist/commands/openapi/index.d.ts

@@ -1,26 +0,0 @@
-import { AbstractCommand } from '../../model/command.js';
-export default class Openapi extends AbstractCommand {
-    static readonly description: string;
-    static readonly examples: string[];
-    static readonly flags: {
-        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        file: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        format: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        entrypoint: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        package: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        method: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    run(): Promise<void>;
-    private getErrorMessage;
-    private isErrorWithMessage;
-    private checkDeprecatedFiles;
-    private determineOutputPath;
-    private generateFromCode;
-    private validateCommandResult;
-    private formatPythonError;
-    private fetchDefaultTemplate;
-    private displaySuccess;
-    private isProjectSupported;
-    private showRuntimeNotSupportedWarning;
-    private showConfigurationHelp;
-}