@quantum-hub/qhubctl 2.1.0 → 2.2.0

package/dist/commands/compress.js

@@ -3,22 +3,13 @@ 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
-
-The '.qhubignore' file uses gitignore syntax. To ship only 'src' and the
-Dockerfile, re-include the directory AND its contents:
-
-  *
-  !src
-  !src/**
-  !Dockerfile
-
-These paths are always excluded: .git, node_modules, .venv, __pycache__, service.zip`;
+  $ qhubctl compress`;
 export const compressCommand = new Command('compress')
-    .description("Compresses the current project and creates a ZIP file. Use a '.qhubignore' file (gitignore syntax) to exclude files and directories from the ZIP file.")
+    .description(`Compresses the current project and creates a ZIP file. ${QHUBIGNORE_HELP}`)
     .addHelpText('after', EXAMPLES)
     .action(async () => {
     const spin = spinner('Compressing project');

package/dist/commands/login.js

@@ -1,8 +1,8 @@
 import { password } from '@inquirer/prompts';
 import { Command } from 'commander';
 import { spinner } from '../lib/output.js';
-import { configDir, getUserConfig, showCustomBasePathWarning } from '../model/command.js';
-import { AuthType, defaultBasePath } from '../model/user-config.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 = `
@@ -23,19 +23,14 @@ export const loginCommand = new Command('login')
     if (!token) {
         throw new Error('Invalid credentials. Please try again.');
     }
+    const userConfig = getUserConfig();
+    const endpoint = resolveEndpoint(userConfig, basePath);
+    const revertingToDefault = !basePath && hasCustomBasePath(userConfig);
     if (basePath) {
         showCustomBasePathWarning();
     }
     const spin = spinner('Login...');
-    const userConfig = getUserConfig();
-    const tempUserConfig = basePath ? {
-        ...userConfig,
-        endpoint: {
-            basePath,
-            defaultHeaders: userConfig.endpoint?.defaultHeaders || {}
-        }
-    } : userConfig;
-    const user = await new AuthService(tempUserConfig).authenticate(token);
+    const user = await new AuthService({ ...userConfig, endpoint }).authenticate(token);
     const newUserConfig = {
         ...userConfig,
         auth: {
@@ -47,13 +42,11 @@ export const loginCommand = new Command('login')
             displayName: `${user.firstname} ${user.lastname}`,
             isOrganization: false,
         },
-        ...(basePath && {
-            endpoint: {
-                basePath,
-                defaultHeaders: userConfig.endpoint?.defaultHeaders || {}
-            }
-        })
+        endpoint,
     };
     writeUserConfig(configDir, newUserConfig);
     spin.succeed('Login successful');
+    if (revertingToDefault) {
+        showBasePathRevertNotice();
+    }
 });

package/dist/commands/logout.js

@@ -1,6 +1,7 @@
 import { Command } from 'commander';
 import { spinner } from '../lib/output.js';
-import { configDir, getUserConfig } from '../model/command.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:
@@ -9,11 +10,17 @@ export const logoutCommand = new Command('logout')
     .description('Logout')
     .addHelpText('after', EXAMPLES)
     .action(async () => {
+    const userConfig = getUserConfig();
+    const revertingToDefault = hasCustomBasePath(userConfig);
     const spin = spinner('Logout');
     writeUserConfig(configDir, {
-        ...getUserConfig(),
+        ...userConfig,
         auth: undefined,
         context: undefined,
+        endpoint: undefined,
     });
     spin.succeed('Logout successful');
+    if (revertingToDefault) {
+        showBasePathRevertNotice();
+    }
 });

package/dist/commands/up.js

@@ -7,6 +7,7 @@ import path from 'node:path';
 import { error, spinner, stdout, warn } from '../lib/output.js';
 import { streamToBlob } from '../lib/stream-to-blob.js';
 import { getDescriptionText } from '../lib/up/get-description.js';
+import { QHUBIGNORE_HELP } from '../lib/up/qhubignore-help.js';
 import { enforceRequiredFiles } from '../lib/up/required-files.js';
 import { buildServiceSource, isRegistrySource, resolveRegistryCredentials } from '../lib/up/source.js';
 import { zipProjectFolder } from '../lib/up/zip.js';
@@ -233,7 +234,7 @@ Examples:
   $ qhubctl up --name "test-service" --no-save-id
   $ qhubctl up --image ghcr.io/acme/my-service:1.2.3`;
 export const upCommand = new Command('up')
-    .description('Creates or updates a service')
+    .description(`Creates or updates a service.\n\n${QHUBIGNORE_HELP}`)
     .option('--silent', 'Suppresses all outputs, helpful when executed in a CI/CD pipeline.', false)
     .option('--no-save-id', 'Prevents storing the created service ID in qhub.json file.')
     .option('--name <value>', 'Override the service name from qhub.json with a custom name.')

package/dist/lib/up/qhubignore-help.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Shared Markdown help text describing '.qhubignore' behaviour. Used in the
+ * command descriptions of both `compress` and `up`, which each package the
+ * project into a ZIP and honour the same ignore rules. Markdown so the
+ * generated CLI reference (docs:generate) renders the fenced code block.
+ */
+export declare const QHUBIGNORE_HELP: string;

package/dist/lib/up/qhubignore-help.js

@@ -0,0 +1,19 @@
+/**
+ * Shared Markdown help text describing '.qhubignore' behaviour. Used in the
+ * command descriptions of both `compress` and `up`, which each package the
+ * project into a ZIP and honour the same ignore rules. Markdown so the
+ * generated CLI reference (docs:generate) renders the fenced code block.
+ */
+export const QHUBIGNORE_HELP = [
+    "Use a '.qhubignore' file (gitignore syntax) to exclude files and directories from the ZIP file.",
+    '',
+    '`.git`, `node_modules`, `.venv`, `__pycache__`, and `service.zip` are always excluded.',
+    "Because `.qhubignore` uses gitignore syntax, re-including a directory's contents requires both the directory and its contents — for example, to ship only `src` and the `Dockerfile`:",
+    '',
+    '```',
+    '*',
+    '!src',
+    '!src/**',
+    '!Dockerfile',
+    '```',
+].join('\n');

package/dist/model/command.d.ts

@@ -3,6 +3,7 @@ export { configDir } from '../lib/config-dir.js';
 export declare function getUserConfig(): UserConfig;
 export declare function getContextDisplayString(userConfig: UserConfig): string;
 export declare function showCustomBasePathWarning(): void;
+export declare function showBasePathRevertNotice(): void;
 /**
  * Validates that the user is authenticated and returns the current UserConfig.
  * Replaces AuthenticatedCommand.init().

package/dist/model/command.js

@@ -17,6 +17,10 @@ export function showCustomBasePathWarning() {
     warn('Using custom base path. This is intended for internal development use only.');
     stdout();
 }
+export function showBasePathRevertNotice() {
+    warn('Custom base path removed. Using the default base path.');
+    stdout();
+}
 /**
  * Validates that the user is authenticated and returns the current UserConfig.
  * Replaces AuthenticatedCommand.init().

package/dist/model/user-config.d.ts

@@ -20,3 +20,12 @@ export default interface UserConfig {
     context?: Context;
     endpoint?: Endpoint;
 }
+/**
+ * Resolves the endpoint to use for a login attempt.
+ *
+ * A truthy `basePath` always yields a custom endpoint (carrying over any
+ * previously stored defaultHeaders); an absent `basePath` always reverts
+ * to the default base path, regardless of what `current` holds.
+ */
+export declare function resolveEndpoint(current: UserConfig, basePath?: string): Endpoint | undefined;
+export declare function hasCustomBasePath(config: UserConfig): boolean;

package/dist/model/user-config.js

@@ -3,3 +3,22 @@ export var AuthType;
     AuthType["API_KEY"] = "API_KEY";
 })(AuthType || (AuthType = {}));
 export const defaultBasePath = 'https://api.hub.kipu-quantum.com';
+/**
+ * Resolves the endpoint to use for a login attempt.
+ *
+ * A truthy `basePath` always yields a custom endpoint (carrying over any
+ * previously stored defaultHeaders); an absent `basePath` always reverts
+ * to the default base path, regardless of what `current` holds.
+ */
+export function resolveEndpoint(current, basePath) {
+    if (!basePath) {
+        return undefined;
+    }
+    return {
+        basePath,
+        defaultHeaders: current.endpoint?.defaultHeaders ?? {},
+    };
+}
+export function hasCustomBasePath(config) {
+    return Boolean(config.endpoint?.basePath);
+}

package/package.json

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