@quantum-hub/qhubctl 1.8.0 → 1.9.0

package/dist/commands/init.js

@@ -3,17 +3,38 @@ 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 { cloneRepository, downloadRepository, extractStarter } from '../lib/repository.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 { 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
+  $ qhubctl init --token <personal access token>
+  $ qhubctl init --non-interactive --token <personal access token>`;
 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) => {
@@ -52,18 +73,11 @@ export const initCommand = new Command('init')
     }
     writeServiceConfig(targetDirectory, serviceConfig);
     if (input.starter) {
-        if (input.starter.requiresAuth) {
-            const userConfig = getUserConfig();
-            if (!userConfig.auth?.value) {
-                error('This starter template requires authentication. Use the "login" command to log in first.');
-            }
-            await cloneRepository(input.starter.url, targetDirectory, userConfig.auth.value);
-        }
-        else {
-            const zip = await downloadRepository(input.starter.url);
-            const starterName = path.basename(input.starter.url, '.zip');
-            extractStarter(zip, starterName, targetDirectory);
+        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);
     }
     stdout('\u{1F389} Initialized project. Happy hacking!');
     if (input.starter) {

package/dist/lib/init-user-input.d.ts

@@ -2,7 +2,6 @@ import { GpuType, Runtime } from '../model/managed-service-config.js';
 export interface StarterInput {
     url: string;
     runtime: Runtime;
-    requiresAuth?: boolean;
 }
 export interface UserInput {
     cpu: number;

package/dist/lib/init-user-input.js

@@ -1,7 +1,7 @@
 import { input, select, number } from '@inquirer/prompts';
 import { GpuType, Runtime } from '../model/managed-service-config.js';
 export const DEFAULT_STARTER = {
-    url: 'https://gitlab.com/planqk-foss/planqk-starter-python/-/archive/main/planqk-starter-python-main.zip',
+    url: 'https://repository.hub.kipu-quantum.com/cec4a31d-5856-4387-b4cf-718345803558/qhub-starter-python.git',
     runtime: Runtime.PYTHON_TEMPLATE,
 };
 export const promptUserInput = async (defaultName) => {
@@ -21,7 +21,6 @@ export const promptUserInput = async (defaultName) => {
                 value: {
                     url: 'https://repository.hub.kipu-quantum.com/cec4a31d-5856-4387-b4cf-718345803558/qhub-starter-docker.git',
                     runtime: Runtime.DOCKER,
-                    requiresAuth: true,
                 },
             },
             {
@@ -29,7 +28,6 @@ export const promptUserInput = async (defaultName) => {
                 value: {
                     url: 'https://repository.hub.kipu-quantum.com/cec4a31d-5856-4387-b4cf-718345803558/qhub-starter-gpu.git',
                     runtime: Runtime.DOCKER,
-                    requiresAuth: true,
                 },
             },
             { name: 'None (creates "qhub.json" in current directory)', value: undefined },

package/dist/lib/repository.d.ts

@@ -1,11 +1,8 @@
-import AdmZip from 'adm-zip';
-export declare const downloadRepository: (url: string, apiKey?: string) => Promise<AdmZip>;
 /**
  * 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 "planqk" and the provided
+ * 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 extractStarter: (zip: AdmZip, starterName: string, targetDirectory: string) => void;

package/dist/lib/repository.js

@@ -1,47 +1,12 @@
-import AdmZip from 'adm-zip';
 import fs from 'fs-extra';
 import git from 'isomorphic-git';
 import http from 'isomorphic-git/http/node';
 import nodeFs from 'node:fs';
-import { debugEnabled } from './debug.js';
-import { fetchOrThrow, PlatformError } from './fetch.js';
-export const downloadRepository = async (url, apiKey) => {
-    const headers = {};
-    if (apiKey) {
-        // Use HTTP Basic Auth: username "planqk", password is the API key
-        const credentials = Buffer.from(`qhubctl:${apiKey}`).toString('base64');
-        headers['Authorization'] = `Basic ${credentials}`;
-    }
-    const config = {
-        cache: 'no-cache',
-        method: 'GET',
-        mode: 'same-origin',
-        referrerPolicy: 'no-referrer',
-        headers,
-    };
-    let zip;
-    try {
-        const response = await fetchOrThrow(url, config);
-        const buffer = await response.arrayBuffer();
-        zip = new AdmZip(Buffer.from(buffer), {});
-    }
-    catch (error) {
-        if (error instanceof PlatformError) {
-            const errorMessage = await error.getErrorMessage();
-            throw new Error(errorMessage);
-        }
-        if (debugEnabled()) {
-            console.error(JSON.stringify(error));
-        }
-        throw new Error('Internal error occurred, please contact your Quantum Hub administrator');
-    }
-    return zip;
-};
 /**
  * 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 "planqk" and the provided
+ * Authentication uses HTTP Basic Auth with username "qhubctl" and the provided
  * API key as the password.
  */
 export const cloneRepository = async (url, targetDirectory, apiKey) => {
@@ -66,17 +31,3 @@ export const cloneRepository = async (url, targetDirectory, apiKey) => {
     // Remove git metadata so the project directory is a clean working tree
     await fs.remove(`${targetDirectory}/.git`);
 };
-export const extractStarter = (zip, starterName, targetDirectory) => {
-    const templateFolder = `${starterName}/`;
-    for (const entry of zip.getEntries()) {
-        if (!entry.isDirectory && entry.entryName.startsWith(templateFolder)) {
-            let destinationPath = targetDirectory;
-            // check if file is in sub-folder
-            if (entry.entryName.replace(templateFolder, '').includes('/')) {
-                const pathWithinFolder = entry.entryName.replace(templateFolder, '');
-                destinationPath = destinationPath + '/' + pathWithinFolder.slice(0, Math.max(0, pathWithinFolder.lastIndexOf('/')));
-            }
-            zip.extractEntryTo(entry.entryName, destinationPath, false, true);
-        }
-    }
-};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quantum-hub/qhubctl",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "Kipu Quantum Hub CLI",
   "author": "Kipu Quantum GmbH",
   "contributors": [