@quantum-hub/qhubctl 1.9.0 → 1.11.0

package/README.md

@@ -85,16 +85,19 @@ node dist/main.js login --base-path https://api.hub.34.90.225.20.nip.io -t <pers
 
 ### Debug output
 
-Set `DEBUG=*` to print all debug output:
+Set `DEBUG=1` to print all debug output:
 
 ```bash
-DEBUG=* node dist/main.js <command>
+DEBUG=1 node dist/main.js <command>
+
+# or
+DEBUG=1 qhubctl <command>
 ```
 
 On Windows, set the variable separately:
 
 ```cmd
-set DEBUG=*
+set DEBUG=1
 node dist\main.js <command>
 ```
 
@@ -120,38 +123,6 @@ npm run build
 npm run docs:generate
 ```
 
-## Regenerating the API client
-
-The generated clients in `src/client/` are produced from the platform OpenAPI specs using [openapi-generator-cli](https://github.com/OpenAPITools/openapi-generator-cli).
-
-```bash
-npm install -g @openapitools/openapi-generator-cli
-```
-
-Against production:
-
-```bash
-openapi-generator-cli generate -g typescript-fetch \
-  -i https://api.hub.kipu-quantum.com/qc-catalog/docs \
-  -o src/client/kqh
-
-openapi-generator-cli generate -g typescript-fetch \
-  -i https://api.hub.kipu-quantum.com/user-service/docs \
-  -o src/client/users
-```
-
-Against staging:
-
-```bash
-openapi-generator-cli generate -g typescript-fetch \
-  -i https://api.hub.34.90.225.20.nip.io/qc-catalog/docs \
-  -o src/client/kqh
-
-openapi-generator-cli generate -g typescript-fetch \
-  -i https://api.hub.34.90.225.20.nip.io/user-service/docs \
-  -o src/client/users
-```
-
 ## License
 
 [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) | Copyright 2026-now Kipu Quantum GmbH

package/dist/commands/datapool-upload.js

@@ -122,7 +122,7 @@ async function ensureDatapoolExists(client, datapoolId, filePaths) {
             : selectExistingDatapool(client);
     }
     try {
-        await client.dataPools.getDataPool({ id: datapoolId });
+        await client.dataPools.getDataPool(datapoolId);
         return datapoolId;
     }
     catch (err) {
@@ -153,7 +153,11 @@ export const datapoolUploadCommand = new Command('upload')
         : undefined;
     const apiKey = userConfig.auth?.value;
     const organizationId = userConfig.context?.isOrganization ? userConfig.context.id : undefined;
-    const client = new HubPlatformClient({ baseUrl, apiKey, organizationId });
+    const client = new HubPlatformClient({
+        baseUrl,
+        apiKey,
+        headers: { 'X-OrganizationId': organizationId },
+    });
     const filePaths = opts.file;
     for (const filePath of filePaths) {
         if (!fs.existsSync(filePath))
@@ -171,7 +175,7 @@ export const datapoolUploadCommand = new Command('upload')
         const spin = spinner(`Uploading ${fileName} to data pool ${datapoolId}`);
         try {
             const fileStream = fs.createReadStream(filePath);
-            const result = await client.dataPools.addDataPoolFile({ id: datapoolId, file: fileStream });
+            const result = await client.dataPools.addDataPoolFile(datapoolId, { file: fileStream });
             spin.succeed('\u2713');
             stdout(`Successfully uploaded ${fileName} to data pool ${datapoolId}`);
             stdout(`File ID: ${result.id}`);

package/dist/commands/init.js

@@ -7,34 +7,13 @@ 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 { getUserConfig } from '../model/command.js';
-/**
- * Environment variable name for providing a personal access token.
- * This can be used as an alternative to the `login` command for CI/CD scenarios.
- */
-const ENV_PERSONAL_ACCESS_TOKEN = 'KQH_PERSONAL_ACCESS_TOKEN';
-/**
- * Gets the API key with the following priority:
- * 1. CLI parameter (if provided)
- * 2. KQH_PERSONAL_ACCESS_TOKEN environment variable
- * 3. Stored config (from `login` command)
- */
-function getApiKey(tokenParam) {
-    if (tokenParam) {
-        return tokenParam;
-    }
-    const userConfig = getUserConfig();
-    return process.env[ENV_PERSONAL_ACCESS_TOKEN] ?? userConfig.auth?.value;
-}
 const EXAMPLES = `
 Examples:
   $ qhubctl init
-  $ qhubctl init --token <personal access token>
-  $ qhubctl init --non-interactive --token <personal access token>`;
+  $ 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('-t, --token <value>', 'Personal access token for authentication')
     .option('--non-interactive', 'Run it in non-interactive mode', false)
     .addHelpText('after', EXAMPLES)
     .action(async (opts) => {
@@ -73,11 +52,7 @@ export const initCommand = new Command('init')
     }
     writeServiceConfig(targetDirectory, serviceConfig);
     if (input.starter) {
-        const apiKey = getApiKey(opts.token);
-        if (!apiKey) {
-            error(`Starter templates require authentication. Provide a token via --token, use the "login" command, or set the ${ENV_PERSONAL_ACCESS_TOKEN} environment variable.`);
-        }
-        await cloneRepository(input.starter.url, targetDirectory, apiKey);
+        await cloneRepository(input.starter.url, targetDirectory);
     }
     stdout('\u{1F389} Initialized project. Happy hacking!');
     if (input.starter) {

package/dist/commands/list-contexts.js

@@ -16,7 +16,7 @@ export const listContextsCommand = new Command('list-contexts')
     const accounts = await quantumHubService.getAccounts();
     spin.succeed('Contexts loaded');
     const tableData = accounts
-        .map(account => ({ displayName: account.displayName, id: account.id, isOrganization: account.isOrganization }));
+        .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" },

package/dist/commands/services-build-status.js

@@ -42,7 +42,7 @@ export const servicesBuildStatusCommand = new Command('build-status')
     const spin = spinner('Loading build status');
     let buildJob;
     try {
-        buildJob = await quantumHubService.getBuildJobByServiceId(serviceId);
+        buildJob = await quantumHubService.getBuildJob(serviceId);
     }
     catch (err) {
         spin.fail('Failed to load build status');

package/dist/commands/set-context.js

@@ -6,7 +6,7 @@ import QuantumHubService from '../service/quantum-hub-service.js';
 import { writeUserConfig } from '../service/user-config-service.js';
 function getPromptOptions(accounts) {
     return accounts.map(account => ({
-        name: account.isOrganization ? `${account.displayName} (Organization)` : account.displayName,
+        name: account.isOrganization ? `${account.displayName} (Organization)` : (account.displayName ?? account.id ?? ''),
         value: account,
     }));
 }
@@ -46,7 +46,11 @@ export const setContextCommand = new Command('set-context')
     }
     writeUserConfig(configDir, {
         ...userConfig,
-        context: selectedContext,
+        context: {
+            id: selectedContext.id,
+            displayName: selectedContext.displayName,
+            isOrganization: selectedContext.isOrganization ?? false,
+        },
     });
     stdout(`Switched to context "${selectedContext?.displayName}".`);
 });

package/dist/commands/up.js

@@ -3,7 +3,7 @@ import { Command } from 'commander';
 import { waitUntil } from 'async-wait-until';
 import fs from 'node:fs';
 import path from 'node:path';
-import { BuildJobDtoStatusEnum, BuildJobDtoStepEnum, ValidationResultStateEnum } from '../client/kqh/index.js';
+import { HubPlatform } from '@quantum-hub/qhub-api/platform';
 import { streamToBlob } from '../lib/stream-to-blob.js';
 import { getDescriptionText } from '../lib/up/get-description.js';
 import { zipProjectFolder } from '../lib/up/zip.js';
@@ -24,20 +24,20 @@ async function getOpenapi() {
         return streamToBlob(openapi);
     return undefined;
 }
-async function buildServiceJob(qhubService, service, serviceDefinition, silentMode) {
+async function buildServiceJob(qhubService, service, silentMode) {
     let buildJob;
     let spin;
     let currentStep;
     try {
         await waitUntil(async () => {
-            buildJob = await qhubService.getBuildJob(service, serviceDefinition);
+            buildJob = await qhubService.getBuildJob(service.id);
             if (!silentMode) {
                 if (buildJob.step !== currentStep) {
-                    if (buildJob.step === BuildJobDtoStepEnum.BuildImage) {
+                    if (buildJob.step === HubPlatform.BuildJobDto.Step.BuildImage) {
                         if (!spin)
                             spin = spinner('Building Image (1/2)');
                     }
-                    else if (buildJob.step === BuildJobDtoStepEnum.PushImage) {
+                    else if (buildJob.step === HubPlatform.BuildJobDto.Step.PushImage) {
                         if (spin) {
                             spin.succeed();
                             spin = undefined;
@@ -47,7 +47,7 @@ async function buildServiceJob(qhubService, service, serviceDefinition, silentMo
                     currentStep = buildJob.step;
                 }
             }
-            return buildJob.status === BuildJobDtoStatusEnum.Success || buildJob.status === BuildJobDtoStatusEnum.Failure;
+            return buildJob.status === HubPlatform.BuildJobDto.Status.Success || buildJob.status === HubPlatform.BuildJobDto.Status.Failure;
         }, {
             intervalBetweenAttempts: 5000,
             timeout: silentMode ? 60 * 60 * 1000 : 20 * 60 * 1000,
@@ -58,7 +58,7 @@ async function buildServiceJob(qhubService, service, serviceDefinition, silentMo
         throw new Error('Error while waiting for the build job to finish: ' + err);
     }
     if (spin) {
-        if (buildJob?.status === BuildJobDtoStatusEnum.Success)
+        if (buildJob?.status === HubPlatform.BuildJobDto.Status.Success)
             spin.succeed();
         else
             spin.fail();
@@ -145,19 +145,15 @@ export const upCommand = new Command('up')
     catch (err) {
         error(await handleError(err));
     }
-    const serviceDefinition = service?.serviceDefinitions?.[0];
-    if (!serviceDefinition) {
-        error('Service definition not found');
-    }
-    const buildJob = await buildServiceJob(qhubService, service, serviceDefinition, silentMode);
-    if (buildJob?.status === BuildJobDtoStatusEnum.Success) {
+    const buildJob = await buildServiceJob(qhubService, service, silentMode);
+    if (buildJob?.status === HubPlatform.BuildJobDto.Status.Success) {
         const msg = `Service ${serviceExistsInPlatform ? 'updated' : 'created'} \u{1F680}`;
         stdout(msg);
     }
-    else if (buildJob?.status === BuildJobDtoStatusEnum.Failure) {
+    else if (buildJob?.status === HubPlatform.BuildJobDto.Status.Failure) {
         const { validationResult } = buildJob;
         let reason = 'Failed creating service';
-        if (validationResult?.state === ValidationResultStateEnum.Error && validationResult.summary) {
+        if (validationResult?.state === HubPlatform.ValidationResult.State.Error && validationResult.summary) {
             reason = `${reason}: ${validationResult.summary}`;
         }
         error(reason);

package/dist/lib/error.js

@@ -1,16 +1,33 @@
-import { FetchError, ResponseError } from '../client/kqh/index.js';
+import { HubPlatformError, HubPlatformTimeoutError } from '@quantum-hub/qhub-api/platform';
 import { debugEnabled } from './debug.js';
-import { getErrorMessage } from './fetch.js';
 export const handleError = async (error) => {
-    if (error instanceof ResponseError) {
-        return getErrorMessage(error.response);
+    if (error instanceof HubPlatformError) {
+        const httpStatus = error.statusCode;
+        // message is either in body.errorMessage, body.error or body.detail
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const body = error.body;
+        let errorMessage;
+        if (body?.errorMessage)
+            errorMessage = body.errorMessage;
+        if (!errorMessage && body?.error)
+            errorMessage = body.error;
+        if (!errorMessage && body?.detail)
+            errorMessage = body.detail;
+        if (debugEnabled()) {
+            console.error(error.stack ?? error.message);
+        }
+        return errorMessage ? `${errorMessage} (${httpStatus})` : `${httpStatus}`;
     }
-    if (error instanceof FetchError) {
-        const errorMessage = error.cause ? error.cause.message : error.message;
-        return `Internal error occurred, please try again later (${errorMessage})`;
+    if (error instanceof HubPlatformTimeoutError) {
+        return `Internal error occurred, please try again later (${error.message})`;
     }
     if (debugEnabled()) {
-        console.error(JSON.stringify(error));
+        if (error instanceof Error) {
+            console.error(error.stack ?? error.message);
+        }
+        else {
+            console.error(JSON.stringify(error));
+        }
     }
     return 'Internal error occurred, please contact your KQH administrator';
 };

package/dist/lib/repository.d.ts

@@ -1,8 +1,5 @@
 /**
  * Clones a git repository (shallow, depth=1) into targetDirectory and removes
  * the .git metadata afterwards, leaving only the working-tree files.
- *
- * Authentication uses HTTP Basic Auth with username "qhubctl" and the provided
- * API key as the password.
  */
-export declare const cloneRepository: (url: string, targetDirectory: string, apiKey: string) => Promise<void>;
+export declare const cloneRepository: (url: string, targetDirectory: string) => Promise<void>;

package/dist/lib/repository.js

@@ -5,12 +5,8 @@ import nodeFs from 'node:fs';
 /**
  * Clones a git repository (shallow, depth=1) into targetDirectory and removes
  * the .git metadata afterwards, leaving only the working-tree files.
- *
- * Authentication uses HTTP Basic Auth with username "qhubctl" and the provided
- * API key as the password.
  */
-export const cloneRepository = async (url, targetDirectory, apiKey) => {
-    const credentials = Buffer.from(`qhubctl:${apiKey}`).toString('base64');
+export const cloneRepository = async (url, targetDirectory) => {
     try {
         await git.clone({
             fs: nodeFs,
@@ -19,14 +15,11 @@ export const cloneRepository = async (url, targetDirectory, apiKey) => {
             url,
             depth: 1,
             singleBranch: true,
-            // Inject Authorization on every request so the proxy doesn't need to
-            // issue a 401 challenge first (onAuth is only triggered after a 401).
-            headers: { 'Authorization': `Basic ${credentials}` },
         });
     }
     catch (error) {
         console.error(error);
-        throw new Error('Failed to download starter template. Make sure you are logged in and try again.');
+        throw new Error('Failed to download starter template.');
     }
     // Remove git metadata so the project directory is a clean working tree
     await fs.remove(`${targetDirectory}/.git`);

package/dist/service/quantum-hub-service.d.ts

@@ -1,23 +1,19 @@
-import { HubPlatformClient } from "@quantum-hub/qhub-api/platform";
-import { BuildJobDto, ServiceDefinitionDto, ServiceDto, ServiceOverviewDto, ServicePlatformServicesApi } from '../client/kqh/index.js';
-import Account from '../model/account.js';
+import { HubPlatform, HubPlatformClient } from "@quantum-hub/qhub-api/platform";
 import ManagedServiceConfig from '../model/managed-service-config.js';
 import UserConfig from '../model/user-config.js';
 import { CommandService } from './command-service.js';
-import { HubPlatform } from "@quantum-hub/qhub-api/platform";
 export default class QuantumHubService extends CommandService {
-    serviceApi: ServicePlatformServicesApi;
     apiClient: HubPlatformClient;
     constructor(userConfig: UserConfig);
-    createService(serviceConfig: ManagedServiceConfig, sourceCode: Blob, apiDefinition?: Blob): Promise<ServiceDto>;
-    getAccounts(): Promise<Account[]>;
-    getBuildJob(service: ServiceDto, serviceDefinition: ServiceDefinitionDto): Promise<BuildJobDto>;
-    getBuildJobByServiceId(serviceId: string): Promise<BuildJobDto>;
+    getAccounts(): Promise<HubPlatform.AccountDto[]>;
+    createService(serviceConfig: ManagedServiceConfig, sourceCode: Blob, apiDefinition?: Blob): Promise<HubPlatform.ServiceDto>;
+    getBuildJob(id: string): Promise<HubPlatform.BuildJobDto>;
     getJobById(id: string): Promise<HubPlatform.ServiceJobDto>;
-    getService(id: string): Promise<ServiceDto>;
-    getServices(): Promise<ServiceOverviewDto[]>;
+    getService(id: string): Promise<HubPlatform.ServiceDto>;
+    getServices(): Promise<HubPlatform.ServiceOverviewDto[]>;
     runJob(request: HubPlatform.CreateServiceJobRequest): Promise<HubPlatform.ServiceJobDto>;
     updateDescription(serviceConfig: ManagedServiceConfig, description: string): Promise<void>;
-    updateOpenapi(serviceConfig: ManagedServiceConfig, apiDefinition: Blob): Promise<void>;
-    updateService(serviceConfig: ManagedServiceConfig, description: string, sourceCode: Blob, apiDefinition?: Blob): Promise<ServiceDto>;
+    updateOpenapi(serviceConfig: ManagedServiceConfig, openapi: Blob): Promise<void>;
+    updateService(serviceConfig: ManagedServiceConfig, description: string, sourceCode: Blob, openapi?: Blob): Promise<HubPlatform.ServiceDto>;
+    private uploadSourceCode;
 }