@equinor/fusion-framework-cli 10.7.4 → 11.0.0-next.0

package/dist/types/bin/portal-manifest.d.ts

@@ -0,0 +1,60 @@
+import type { RuntimeEnv } from '../lib';
+import type { ConsoleLogger } from './utils';
+/**
+ * Options for resolving the portal manifest.
+ *
+ * This type defines the shape of the options object accepted by
+ * {@link loadPortalManifest}. It allows for optional logging, environment overrides,
+ * and a custom manifest file path.
+ *
+ * @public
+ */
+export type ResolvePortalManifestOptions = {
+    /**
+     * Logger instance for outputting progress and debug information (optional).
+     */
+    log?: ConsoleLogger | null;
+    /**
+     * Path to a specific manifest file to resolve (optional).
+     */
+    manifest?: string;
+    /**
+     * Partial runtime environment overrides (optional).
+     */
+    env?: Partial<RuntimeEnv>;
+};
+/**
+ * Loads and resolves the portal manifest based on the provided options.
+ *
+ * This function resolves the app package, sets up the runtime environment, and loads the portal manifest.
+ * Logging is supported for debugging and progress tracking. Returns the manifest, package, and environment.
+ *
+ * @param options - The options for resolving the portal manifest.
+ * @returns An object containing the resolved manifest, package, and runtime environment.
+ * @throws Will throw an error if resolving the application package or manifest fails.
+ * @public
+ */
+export declare const loadPortalManifest: (options: ResolvePortalManifestOptions) => Promise<{
+    manifest: {
+        build: {
+            version: string;
+            timestamp: string;
+            commitSha: string;
+            allowedExtensions: string[];
+            templateEntry: string;
+            schemaEntry: string;
+            config?: Record<string, unknown> | undefined;
+            githubRepo?: string | undefined;
+            projectPage?: string | undefined;
+            assetPath?: string | undefined;
+            annotations?: Record<string, string> | undefined;
+            schema?: Record<string, unknown> | undefined;
+        };
+        name: string;
+        displayName?: string | undefined;
+        description?: string | undefined;
+    };
+    pkg: import("../lib").ResolvedPackage;
+    env: RuntimeEnv;
+}>;
+export default loadPortalManifest;

package/dist/types/bin/portal-pack.d.ts

@@ -0,0 +1,54 @@
+import type { ConsoleLogger } from './utils/ConsoleLogger';
+/**
+ * Options for bundling a portal into an archive for distribution or deployment.
+ *
+ * This type defines the optional parameters for the {@link bundlePortal} function, including
+ * logger, manifest path, schema path, and archive name.
+ *
+ * @property log - Logger instance for outputting progress and debug information (optional).
+ * @property manifest - Path to the portal manifest file (optional).
+ * @property schema - Path to the portal schema file (optional).
+ * @property archive - Name or path of the output archive file (optional).
+ *
+ * @public
+ */
+export type BundlePortalOptions = {
+    log?: ConsoleLogger | null;
+    manifest?: string;
+    schema?: string;
+    archive?: string;
+};
+/**
+ * Bundles the portal into an archive for distribution or deployment.
+ *
+ * This function builds the portal, validates the manifest, loads the schema, and creates an archive containing
+ * the portal manifest, schema, and metadata. Handles errors and logs progress for maintainability and debugging.
+ *
+ * @param options - Options for logger, manifest path, schema path, and archive name.
+ * @returns An object containing the archive path, portal manifest, and schema.
+ * @throws If the manifest build config is missing or packaging fails.
+ * @public
+ */
+export declare const bundlePortal: (options: BundlePortalOptions) => Promise<{
+    archive: import("adm-zip");
+    manifest: {
+        build: {
+            version: string;
+            timestamp: string;
+            commitSha: string;
+            allowedExtensions: string[];
+            templateEntry: string;
+            schemaEntry: string;
+            config?: Record<string, unknown> | undefined;
+            githubRepo?: string | undefined;
+            projectPage?: string | undefined;
+            assetPath?: string | undefined;
+            annotations?: Record<string, string> | undefined;
+            schema?: Record<string, unknown> | undefined;
+        };
+        name: string;
+        displayName?: string | undefined;
+        description?: string | undefined;
+    };
+    schema: import("../lib/portal").PortalSchema;
+}>;

package/dist/types/bin/portal-tag.d.ts

@@ -0,0 +1,51 @@
+import { type ConsoleLogger } from './utils';
+import type { FusionFramework } from '../lib/framework.node.js';
+/**
+ * Allowed tags for portal versions in the portal service.
+ *
+ * - `latest`: Marks the most recent stable version of the portal template.
+ * - `preview`: Marks a pre-release or preview version for testing or review.
+ *
+ * Used by {@link tagPortal} to validate and apply version tags.
+ *
+ * @public
+ */
+export declare enum AllowedTags {
+    Latest = "latest",
+    Preview = "preview"
+}
+/**
+ * Options for tagging a portal template version in the portal service.
+ *
+ * This type defines the required and optional parameters for the
+ * {@link tagPortal} function, including the tag type, portal name,
+ * version, framework instance, and logger.
+ *
+ * @property tag - The tag to apply to the portal version (e.g., 'latest' or 'preview').
+ * @property name - The unique name identifying the portal template.
+ * @property version - The version of the portal template to tag.
+ * @property framework - The FusionFramework instance used for service discovery and requests.
+ * @property log - Optional logger for outputting progress and debug information.
+ *
+ * @public
+ */
+export type TagPortalOptions = {
+    tag: AllowedTags;
+    name: string;
+    version: string;
+    framework: FusionFramework;
+    log?: ConsoleLogger | null;
+};
+/**
+ * Tags a portal template version in the portal service with a specified tag (e.g., 'latest' or 'preview').
+ *
+ * This function validates input, creates a client for the portal service, and sends a tag request.
+ * It provides detailed logging and error handling for common failure scenarios.
+ *
+ * @param options - Tag, portal name, version, framework instance, and logger.
+ * @returns The result of the tag operation from the portal service.
+ * @throws If the tag, name, or version is invalid, or if the tag operation fails.
+ * @public
+ */
+export declare const tagPortal: (options: TagPortalOptions) => Promise<void>;
+export default tagPortal;

package/dist/types/bin/portal-upload.d.ts

@@ -0,0 +1,37 @@
+import AdmZip from 'adm-zip';
+import { type ConsoleLogger } from './utils';
+import type { FusionFramework } from '../lib/framework.node.js';
+/**
+ * Options for uploading a portal bundle to the portal service.
+ *
+ * This type defines the required and optional parameters for the
+ * {@link uploadPortalBundle} function, including the bundle file or AdmZip instance,
+ * portal name, framework instance, and logger.
+ *
+ * @property fileOrBundle - Path to the bundle file or an AdmZip instance.
+ * @property name - Optional portal name to override bundle metadata.
+ * @property framework - The FusionFramework instance used for service discovery and requests.
+ * @property log - Optional logger for outputting progress and debug information.
+ *
+ * @public
+ */
+export type UploadPortalOptions = {
+    fileOrBundle: string | AdmZip;
+    name?: string;
+    framework: FusionFramework;
+    log?: ConsoleLogger;
+};
+/**
+ * Uploads a portal bundle to the portal service for publishing or updating a portal template.
+ *
+ * This function loads the bundle, resolves the portal name (from argument or metadata),
+ * reads the bundle content, and uploads it to the portal service. Handles and logs errors
+ * for common failure scenarios, including HTTP status codes and bundle reading issues.
+ *
+ * @param opt - Options for bundle file, portal name, framework, and logger.
+ * @returns A promise that resolves when the upload is complete.
+ * @throws If bundle reading or upload fails, or if the portal service returns an error status.
+ * @public
+ */
+export declare const uploadPortalBundle: (opt: UploadPortalOptions) => Promise<void>;
+export default uploadPortalBundle;

package/dist/types/bin/utils/ConsoleLogger.d.ts

@@ -0,0 +1,84 @@
+import { Spinner } from './spinner.js';
+/**
+ * ConsoleLogger is a utility class for logging progress, status, and debug information in CLI applications.
+ * It uses a spinner for visual feedback and supports debug mode for verbose output.
+ *
+ * @remarks
+ * This class is designed for CLI tools that require both spinner-based progress indication and
+ * structured logging at various levels (info, warn, error, debug).
+ *
+ * @example
+ * ```ts
+ * const logger = new ConsoleLogger('My CLI', { debug: true });
+ * logger.start('Starting task...');
+ * logger.succeed('Task complete!');
+ * logger.debug('Debug info');
+ * ```
+ */
+export declare class ConsoleLogger {
+    /**
+     * The spinner instance used for progress and status messages.
+     */
+    readonly spinner: Spinner;
+    /**
+     * Indicates if debug mode is enabled for verbose output.
+     */
+    readonly debugMode: boolean;
+    /**
+     * Creates a new ConsoleLogger.
+     * @param title - Prefix for spinner/log messages.
+     * @param options - Optional debug flag.
+     */
+    constructor(title: string, options?: {
+        debug?: boolean;
+    });
+    /**
+     * Start the spinner with a message.
+     * @param args - Message parts to display.
+     */
+    start(...args: string[]): void;
+    /**
+     * Mark spinner as succeeded with a message.
+     * @param args - Message parts to display.
+     */
+    succeed(...args: string[]): void;
+    /**
+     * Mark spinner as failed with a message.
+     * @param args - Message parts to display.
+     */
+    fail(...args: string[]): void;
+    /**
+     * Log an error message to the console.
+     * @param args - Error message parts.
+     */
+    error(...args: any[]): void;
+    /**
+     * Log a warning message.
+     * @param args - Warning message parts.
+     */
+    warn(...args: string[]): void;
+    /**
+     * Log an informational message.
+     * @param args - Info message parts.
+     */
+    info(...args: string[]): void;
+    /**
+     * Alias for info.
+     * @param args - Info message parts.
+     */
+    log(...args: string[]): void;
+    /**
+     * Log debug messages if debugMode is enabled.
+     * @param args - Debug message parts.
+     */
+    debug(...args: any[]): void;
+    /**
+     * Attach spinner to native console output.
+     */
+    startNativeConsoleCapture(): void;
+    /**
+     * Detach spinner from native console output.
+     */
+    stopNativeConsoleCapture(): void;
+}
+export default ConsoleLogger;

package/dist/types/bin/utils/create-dev-server.d.ts

@@ -0,0 +1,49 @@
+import type { AppManifest } from '@equinor/fusion-framework-module-app';
+import type { ApiAppConfig } from '@equinor/fusion-framework-module-app/schemas.js';
+import type { RuntimeEnv } from '../../lib';
+import { type UserConfig, type DevServerOptions, type FusionTemplateEnv } from '@equinor/fusion-framework-dev-server';
+/**
+ * PortalManifest describes the minimal structure required for a portal manifest.
+ * Used for dev server portal routing and config.
+ */
+type PortalManifest = {
+    id: string;
+    build: {
+        entrypoint: string;
+    };
+};
+/**
+ * PortalConfig is a placeholder for portal-specific configuration.
+ * Replace 'any' with a more specific type as needed.
+ */
+type PortalConfig = Record<string, unknown>;
+/**
+ * Options for creating a dev server configuration.
+ *
+ * @property template - Optional template environment overrides.
+ * @property portal - Optional portal manifest and config.
+ * @property app - Optional app manifest and config.
+ * @property server - Optional server options for the dev server.
+ */
+export type CreateDevServerOptions = {
+    template?: Partial<FusionTemplateEnv>;
+    portal?: {
+        manifest: PortalManifest;
+        config: PortalConfig;
+    };
+    app?: {
+        manifest: AppManifest;
+        config?: ApiAppConfig;
+    };
+    server?: DevServerOptions['server'];
+};
+/**
+ * Creates the full dev server configuration for Fusion CLI.
+ * Applies app and portal routing as needed.
+ *
+ * @param options - Options for dev server config, including app/portal manifests and overrides.
+ * @returns The complete dev server options object.
+ */
+export declare const createDevServerConfig: (options: CreateDevServerOptions) => DevServerOptions;
+export declare const createDevServer: (env: RuntimeEnv, options: CreateDevServerOptions, overrides?: UserConfig) => Promise<import("vite").ViteDevServer>;
+export {};

package/dist/types/bin/utils/format.d.ts

@@ -1,8 +1,35 @@
 import chalk from 'chalk';
 export { chalk };
+/**
+ * Formats a file path for CLI output, with optional relative path and styling.
+ *
+ * @param path - The file path to format.
+ * @param opt - Optional formatting options.
+ * @param opt.relative - If true, formats as a relative path from cwd or opt.cwd.
+ * @param opt.cwd - The base directory for relative path calculation. Defaults to process.cwd().
+ * @returns The formatted file path, styled with chalk.blueBright.
+ *
+ * @example
+ * formatPath('/foo/bar/baz.txt', { relative: true });
+ */
 export declare const formatPath: (path: string, opt?: {
     relative?: boolean;
     cwd?: string;
 }) => string;
+/**
+ * Formats a byte size value or file path into a human-readable string for CLI output.
+ *
+ * If the input is a string, it is treated as a file path and the file size is used.
+ * If the input is a number, it is formatted directly.
+ *
+ * @param input - File path (string) or byte size (number).
+ * @returns A formatted string representing the byte size, styled with chalk.yellowBright.
+ *
+ * @throws If the input is a string and the file does not exist.
+ *
+ * @example
+ * formatByteSize(1024); // '1 kB'
+ * formatByteSize('/path/to/file.zip'); // '2.3 MB'
+ */
 export declare const formatByteSize: (input: string | number) => string;
 export default chalk;

package/dist/types/bin/utils/index.d.ts

@@ -1,14 +1,4 @@
-export { getEndpointUrl } from './getEndpointUrl.js';
-export type { FusionEnv } from './getEndpointUrl.js';
-export { requireToken } from './requireToken.js';
-export { isAppRegistered } from './isAppRegistered.js';
-export { loadAppConfig } from './load-app-config.js';
-export { loadAppManifest } from './load-manifest.js';
-export { loadPackage } from './load-package.js';
-export { loadViteConfig } from './load-vite-config.js';
-export { formatPath, formatByteSize } from './format.js';
-export { executeCommand } from './execute-command.js';
-export { publishAppConfig } from './publishAppConfig.js';
-export { tagAppBundle } from './tagAppBundle.js';
-export { uploadAppBundle } from './uploadAppBundle.js';
+export { formatPath, formatByteSize, chalk } from './format.js';
 export { Spinner } from './spinner.js';
+export { ConsoleLogger } from './ConsoleLogger.js';
+export { createDevServerConfig, createDevServer, type CreateDevServerOptions, } from './create-dev-server.js';

package/dist/types/bin/utils/spinner.d.ts

@@ -1,20 +1,95 @@
 import { type Options, type Ora } from 'ora';
+/**
+ * Spinner utility class for CLI progress indication and logging.
+ * Wraps the `ora` spinner and provides additional features for console capture and global state.
+ *
+ * @remarks
+ * - Allows attaching/detaching spinner to native console output.
+ * - Supports global and cloneable spinner instances.
+ * - Provides info, success, warning, and failure logging methods.
+ *
+ * @example
+ * const spinner = new Spinner({ text: 'Loading...' });
+ * spinner.start('Processing');
+ * spinner.succeed('Done!');
+ */
 export declare class Spinner {
     #private;
+    /**
+     * Get the underlying ora instance for advanced usage.
+     */
     get ora(): Ora;
+    /**
+     * Attach or detach spinner to native console output.
+     * When enabled, console.log/info are redirected to spinner.info.
+     */
     set attachConsole(value: boolean);
+    /**
+     * Create and set a global spinner instance.
+     * @param options - Spinner options.
+     * @returns The global spinner instance.
+     */
     static Global(options?: Options): Spinner;
+    /**
+     * Clone a spinner instance, optionally from an existing spinner.
+     * @param spinner - Spinner to clone from, or use global spinner if omitted.
+     * @returns A new Spinner instance with the same prefixText.
+     */
     static Clone(spinner?: Spinner): Spinner;
+    /**
+     * Get the current global spinner instance.
+     */
     static get Current(): Spinner;
+    /**
+     * Set the current global spinner instance.
+     */
     static set Current(spinner: Spinner);
+    /**
+     * Create a new Spinner instance.
+     * @param options - Spinner options from ora.
+     */
     constructor(options?: Options);
+    /**
+     * Get the prefix text for the spinner.
+     */
     get prefixText(): string;
+    /**
+     * Log an informational message with the spinner.
+     * @param args - Message parts to display.
+     */
     info(...args: string[]): void;
+    /**
+     * Mark spinner as succeeded with a message.
+     * @param args - Message parts to display.
+     */
     succeed(...args: string[]): void;
+    /**
+     * Start the spinner with a message.
+     * @param args - Message parts to display.
+     */
     start(...args: string[]): void;
+    /**
+     * Mark spinner as failed with a message.
+     * @param args - Message parts to display.
+     */
     fail(...args: string[]): void;
+    /**
+     * Log a warning message with the spinner.
+     * @param args - Message parts to display.
+     */
     warn(...args: string[]): void;
+    /**
+     * Clear the spinner output.
+     */
     clear(): void;
+    /**
+     * Stop the spinner without marking as success or failure.
+     */
     stop(): void;
+    /**
+     * Stop the spinner and persist output with custom options.
+     * @param args - Arguments for ora's stopAndPersist.
+     */
     stopAndPersist(...args: Parameters<Ora['stopAndPersist']>): void;
 }
+export type { Options as SpinnerOptions } from 'ora';

package/dist/types/cli/commands/app/alias.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file defines deprecated command aliases to support a smoother transition to v11.
+ * Each alias maps an old "build-*" command to its new equivalent, providing warnings and guidance for users.
+ * These aliases help maintain backward compatibility and inform users about updated command usage.
+ */
+export {};

package/dist/types/cli/commands/app/build.d.ts

@@ -0,0 +1,27 @@
+/**
+ * CLI command: `build`
+ *
+ * Builds the application using a manifest file and environment-specific configuration.
+ *
+ * Features:
+ * - If no manifest is provided, searches for a default `app.manifest.[ts|js|json]` in the current directory.
+ * - Supports environment variables to customize the build process.
+ * - Provides a debug mode for verbose logging.
+ *
+ * Usage:
+ *   $ fusion build
+ *   $ fusion build app.manifest.dev.ts --debug
+ *
+ * Arguments:
+ *   [manifest]   Manifest file to use for building (e.g., app.manifest.ts)
+ *
+ * Options:
+ *   -d, --debug  Enable debug mode for verbose logging (default: false)
+ *
+ * Example:
+ *   $ fusion build app.manifest.dev.ts --debug
+ *
+ * @see buildApplication for build implementation details
+ */
+export declare const command: import("commander").Command;
+export default command;

package/dist/types/cli/commands/app/check.d.ts

@@ -0,0 +1,26 @@
+/**
+ * CLI command: `check`
+ *
+ * Checks if the application is registered in the Fusion app store.
+ *
+ * Features:
+ * - Verifies the registration status of your application in the Fusion app store.
+ * - Helps identify issues with app registration or configuration.
+ * - Supports authentication and environment options.
+ * - Provides a debug mode for verbose logging.
+ *
+ * Usage:
+ *   $ fusion check [options]
+ *
+ * Options:
+ *   -d, --debug         Enable debug mode for verbose logging (default: false)
+ *   --environment <env> Specify the environment (see available environments)
+ *   --token <token>     Provide an authentication token (if required)
+ *
+ * Example:
+ *   $ fusion check --environment prod --debug
+ *
+ * @see checkApp for implementation details
+ */
+export declare const command: import("commander").Command;
+export default command;

package/dist/types/cli/commands/app/config.d.ts

@@ -0,0 +1,34 @@
+/**
+ * CLI command: `config`
+ *
+ * Generates and/or publishes the application configuration for Fusion apps.
+ *
+ * Features:
+ * - Outputs the generated config to stdout or a file.
+ * - Use --publish to upload the config to the Fusion app registry.
+ * - Options [token, tenant, client, manifest] are only relevant when --publish is used.
+ * - Option [-e, --env] cannot be set to dev when --publish is used.
+ *
+ * Usage:
+ *   $ fusion config [config] [options]
+ *
+ * Arguments:
+ *   [config]             Config build file to use (e.g., app.config[.env]?.[ts,js,json])
+ *
+ * Options:
+ *   --debug              Enable debug mode for verbose logging
+ *   --silent             Silent mode, suppresses output except errors
+ *   --publish            Publish config to Fusion app registry
+ *   --manifest <path>    Path to the app manifest file (required with --publish)
+ *   -e, --env <env>      Target environment
+ *   -o, --output <stdout|path> Output to stdout or a file (default: stdout)
+ *
+ * Example:
+ *   $ fusion config app.config.ts
+ *   $ fusion config app.config.prod.ts --output ./dist/app.config.json
+ *   $ fusion config --publish --manifest app.manifest.ts --env prod
+ *
+ * @see generateApplicationConfig, publishAppConfig for implementation details
+ */
+export declare const command: import("commander").Command;
+export default command;

package/dist/types/cli/commands/app/dev.d.ts

@@ -0,0 +1,29 @@
+/**
+ * CLI command: `dev`
+ *
+ * Starts the application in development mode with a local dev server.
+ *
+ * Features:
+ * - Launches the development server for your application.
+ * - Supports custom manifest/config files, runtime environment, and port selection.
+ * - Debug mode available for verbose logging.
+ *
+ * Usage:
+ *   $ fusion app dev [options]
+ *
+ * Options:
+ *   --debug              Enable debug mode
+ *   --manifest <path>    Path to the app manifest file (app.manifest[.env]?.[ts,js,json])
+ *   --config <path>      Path to the app config file (app.config[.env]?.[ts,js,json])
+ *   --env <environment>  Runtime environment for the dev server (default: local)
+ *   --port <port>        Port for the development server (default: 3000)
+ *
+ * Example:
+ *   $ fusion app dev
+ *   $ fusion app dev --port 4000
+ *   $ fusion app dev --manifest ./app.manifest.local.ts --config ./app.config.ts
+ *
+ * @see startAppDevServer for implementation details
+ */
+export declare const command: import("commander").Command;
+export default command;

package/dist/types/cli/commands/app/index.d.ts

@@ -0,0 +1,3 @@
+import './alias.js';
+export declare const command: import("commander").Command;
+export default command;

package/dist/types/cli/commands/app/manifest.d.ts

@@ -0,0 +1,30 @@
+/**
+ * CLI command: `manifest`
+ *
+ * Builds and outputs the application manifest for Fusion apps.
+ *
+ * Features:
+ * - Prints the manifest to stdout by default, or writes to a file with --output.
+ * - Supports custom manifest build files or defaults to app.manifest[.env]?.[ts,js,json].
+ * - Debug and silent modes for flexible output.
+ *
+ * Usage:
+ *   $ fusion manifest [manifest] [options]
+ *
+ * Arguments:
+ *   [manifest]           Manifest build file to use (e.g., app.manifest[.env]?.[ts,js,json])
+ *
+ * Options:
+ *   -d, --debug          Enable debug mode for verbose logging
+ *   -o, --output         Write manifest to the specified file (default: stdout)
+ *   -s, --silent         Silent mode, suppresses output except errors
+ *
+ * Example:
+ *   $ fusion manifest
+ *   $ fusion manifest app.manifest.prod.ts --output ./dist/app.manifest.json
+ *   $ fusion manifest --debug
+ *
+ * @see loadAppManifest for implementation details
+ */
+export declare const command: import("commander").Command;
+export default command;