@equinor/fusion-framework-cli 11.0.0-next.5 → 11.0.0-next.6

package/dist/types/bin/helpers/resolve-portal-config.d.ts

@@ -0,0 +1,18 @@
+import type { RuntimeEnv } from '../../lib';
+import type { ConsoleLogger } from '../utils';
+import { type PortalConfig } from '../../lib/portal';
+/**
+ * Resolves the portal configuration based on the provided runtime environment and options.
+ * Handles logging, error reporting, and fallback to built-in config if no local config is found.
+ *
+ * @param env - The runtime environment containing the command and mode information.
+ * @param options - Optional parameters:
+ *   - config: Path to a specific configuration file.
+ *   - log: Logger utility for progress and status messages.
+ * @returns A promise resolving to the loaded portal configuration.
+ * @throws If the portal configuration cannot be resolved.
+ */
+export declare const resolvePortalConfig: <T extends PortalConfig = PortalConfig>(env: RuntimeEnv, options: {
+    config?: string;
+    log?: ConsoleLogger | null;
+}) => Promise<T>;

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

@@ -6,4 +6,6 @@ export { startAppDevServer } from './app-dev.js';
 export { buildPortal } from './portal-build.js';
 export { bundlePortal } from './portal-pack.js';
 export { loadPortalManifest } from './portal-manifest.js';
+export { generatePortalConfig } from './portal-config.js';
+export { publishPortalConfig } from './portal-config-publish.js';
 export { pack } from './pack.js';

package/dist/types/bin/portal-config-publish.d.ts

@@ -0,0 +1,26 @@
+import { type FusionEnv, type FusionFrameworkSettings } from '../lib/framework.node.js';
+import { type ConsoleLogger } from './utils';
+type PortalConfigPublishOptions = {
+    config?: string;
+    portal: {
+        name: string;
+        version: string;
+    };
+    environment: Exclude<FusionEnv, FusionEnv.Development>;
+    auth: FusionFrameworkSettings['auth'];
+    debug?: boolean;
+    log?: ConsoleLogger | null;
+};
+/**
+ * Publishes the portal configuration to the portal store for a specific build version.
+ *
+ * This function generates the portal config, loads the manifest, initializes the Fusion Framework,
+ * and sends the config to the portal service. Handles and logs errors for common failure scenarios.
+ *
+ * @param options - Options for config, manifest, environment, authentication, and logging.
+ * @returns A promise that resolves when publishing is complete.
+ * @throws If the build version is missing or publishing fails.
+ * @public
+ */
+export declare const publishPortalConfig: (options: PortalConfigPublishOptions) => Promise<void>;
+export default publishPortalConfig;

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

@@ -0,0 +1,46 @@
+import type { RuntimeEnv } from '../lib';
+import { type ConsoleLogger } from './utils';
+/**
+ * Options for generating the portal configuration.
+ *
+ * This interface defines the shape of the options object accepted by
+ * {@link generatePortalConfig}. It allows for optional logging, environment overrides,
+ * config file path, and output file path.
+ *
+ * @public
+ */
+interface GeneratePortalConfigOptions {
+    /**
+     * Logger instance for outputting progress and debug information (optional).
+     */
+    log?: ConsoleLogger | null;
+    /**
+     * Partial runtime environment overrides (optional).
+     */
+    env?: Partial<RuntimeEnv>;
+    /**
+     * Path to the config file to resolve (optional).
+     */
+    config?: string;
+    /**
+     * Output file path for writing the generated config (optional).
+     */
+    output?: string;
+}
+/**
+ * Generates the portal configuration object for the current project.
+ *
+ * This function resolves the portal package, sets up the runtime environment, resolves the portal config,
+ * and optionally writes the config to a file if an output path is provided. Logging is supported for
+ * debugging and progress tracking.
+ *
+ * @param options - Optional settings for logger, environment overrides, config path, and output file.
+ * @returns An object containing the generated config and the resolved package info.
+ * @throws If writing the config to file fails.
+ * @public
+ */
+export declare const generatePortalConfig: (options?: GeneratePortalConfigOptions) => Promise<{
+    config: import("../lib/portal").PortalConfig;
+    pkg: import("../lib").ResolvedPackage;
+}>;
+export {};

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

@@ -24,9 +24,9 @@
  *   -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
+ *   $ fusion-framework-cli config app.config.ts
+ *   $ fusion-framework-cli config app.config.prod.ts --output ./dist/app.config.json
+ *   $ fusion-framework-cli config --publish --manifest app.manifest.ts --env prod
  *
  * @see generateApplicationConfig, publishAppConfig for implementation details
  */

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

@@ -1,4 +1,4 @@
-export declare const defaultArchive = "app-bundle.zip";
+export declare const DEFAULT_ARCHIVE: "app-bundle.zip";
 /**
  * CLI command: `pack`
  *

package/dist/types/cli/commands/auth/logout.d.ts

@@ -3,10 +3,6 @@
  *
  * This command removes your current authentication state from the Fusion Framework CLI.
  * Supports custom tenant and client options for advanced scenarios.
- *
- * @example
- *   $ fusion logout
- *   $ fusion logout --tenant my-tenant --client my-client-id
  */
 export declare const command: import("commander").Command;
 export default command;

package/dist/types/cli/commands/auth/token.d.ts

@@ -3,11 +3,6 @@
  *
  * This command retrieves an access token for the specified scopes, tenant, and client.
  * Supports debug and silent modes for flexible output.
- *
- * @example
- *   $ fusion token
- *   $ fusion token --scope api://my-app/.default
- *   $ fusion token --tenant my-tenant --client my-client-id --silent
  */
 export declare const command: import("commander").Command;
 export default command;

package/dist/types/cli/commands/disco/resolve.d.ts

@@ -5,13 +5,6 @@
  *
  * Supports environment selection and authentication options.
  *
- * ## Examples
- *
- * ```sh
- * $ fusion resolve my-service
- * $ fusion resolve my-service --env prod
- * ```
- *
  * @command resolve
  * @description Resolve and display information about a service registered in Fusion service discovery.
  * @argument {string} service - Name of the service to resolve in Fusion service discovery.

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

@@ -0,0 +1,32 @@
+/**
+ * CLI command: `portal config`
+ *
+ * Generates and/or publishes the portal configuration for Fusion portals.
+ *
+ * Features:
+ * - Outputs the generated config to stdout or a file.
+ * - Use --publish to upload the config to the Fusion portal registry.
+ * - Options [token, tenant, client, config, identifier, env, output] are only relevant when --publish is used.
+ * - Option [--env] cannot be set to dev when --publish is used.
+ *
+ * Usage:
+ *   $ fusion-framework-cli portal config --identifier <portal@version> [options]
+ *
+ * Options:
+ *   --debug                      Enable debug mode for verbose logging
+ *   --silent                     Silent mode, suppresses output except errors
+ *   --publish                    Publish config to Fusion portal registry
+ *   --identifier <name@version>  Identifier of the portal, example my-portal@1.2.3 (required with --publish)
+ *   -o, --output <stdout|path>   Output to stdout or a file (default: stdout)
+ *   <config>                     Path to the portal config file (e.g., portal.config[.env]?.[ts,js,json])
+ *   --env <env>                  Target environment
+ *
+ * Examples:
+ *   $ fusion-framework-cli portal config --identifier my-portal@1.2.3 -o stdout portal.config.ts
+ *   $ fusion-framework-cli portal config --identifier my-portal@1.2.3 -o ./dist/portal.config.json portal.config.prod.ts
+ *   $ fusion-framework-cli portal config --publish --env prod --identifier my-portal@1.2.3 portal.config.ts
+ *
+ * @see generatePortalConfig, publishPortalConfig for implementation details
+ */
+export declare const command: import("commander").Command;
+export default command;

package/dist/types/lib/portal/index.d.ts

@@ -1,2 +1,4 @@
 export { createPortalManifestFromPackage, definePortalManifest, loadPortalManifest, validatePortalManifest, type PortalManifest, type PortalManifestExport, type PortalManifestFn, } from './portal-manifest.js';
 export { loadPortalSchema, definePortalSchema, type PortalSchema, type PortalSchemaExport, type PortalSchemaFn, } from './load-portal-schema.js';
+export { definePortalConfig, type PortalConfig, type PortalConfigFn, } from './portal-config.js';
+export { loadPortalConfig, type PortalConfigExport, } from './load-portal-config.js';

package/dist/types/lib/portal/load-portal-config.d.ts

@@ -0,0 +1,83 @@
+import z from 'zod';
+import { type ImportConfigResult } from '@equinor/fusion-imports';
+import type { RuntimeEnv } from '../types.js';
+import type { PortalConfig, PortalConfigFn } from './portal-config.js';
+/**
+ * Represents the configuration export for a portal.
+ *
+ * This can either be a static configuration object (`PortalConfig`) or a function (`PortalConfigFn`)
+ * that returns or modifies the portal configuration dynamically.
+ *
+ * Used for both static and dynamic portal config patterns.
+ *
+ * @remarks
+ * - Enables flexible config authoring for different deployment scenarios.
+ * - Supports both object and function-based portal configuration.
+ *
+ * @example <caption>Static export</caption>
+ * ```ts
+ * export default {
+ *   environment: { name: 'production' },
+ *   features: { enableBeta: true },
+ * };
+ * ```
+ *
+ * @example <caption>Dynamic export</caption>
+ * ```ts
+ * export default (env, { base }) => ({
+ *   ...base,
+ *   environment: { name: env.environment },
+ *   features: { enableBeta: env.environment === 'dev' },
+ * });
+ * ```
+ */
+export type PortalConfigExport = PortalConfig | PortalConfigFn;
+/**
+ * Options for loading a portal config file.
+ *
+ * @property base - A base configuration object to merge with the imported configuration.
+ * @property file - The name of the configuration file to import. Defaults to 'portal.config'.
+ * @property extensions - An array of file extensions to consider when resolving the configuration file.
+ * @property schema - An optional Zod schema for validating the loaded portal configuration.
+ *
+ * @remarks
+ * - Allows for custom config file resolution and merging strategies.
+ * - Useful for multi-environment setups and advanced config loading.
+ * - Schema validation ensures type safety for portal configuration.
+ *
+ * @example
+ * ```ts
+ * const config = await loadPortalConfig(env, {
+ *   file: 'custom-portal.config.ts',
+ *   schema: z.object({ environment: z.object({ name: z.string() }) })
+ * });
+ * ```
+ */
+export type LoadPortalConfigOptions = {
+    base?: PortalConfig;
+    file?: string;
+    extensions?: string[];
+    schema?: z.ZodSchema<PortalConfig>;
+};
+/**
+ * Loads and resolves the portal configuration from a file or function export.
+ *
+ * This function uses a script resolver to handle dynamic imports. If the imported module's default export
+ * is a function, it will be invoked with the base configuration and runtime environment. The result
+ * is validated against the provided schema (or a permissive passthrough schema by default).
+ *
+ * @param env - The runtime environment containing the root directory and other environment-specific settings.
+ * @param options - Optional parameters for configuring the import process.
+ * @returns A promise that resolves to the imported and validated portal configuration.
+ *
+ * @remarks
+ * - Supports both static and dynamic config authoring patterns for portals.
+ * - Ensures all configs are validated against the schema for type safety.
+ * - Designed for maintainability and RAG-based documentation extraction.
+ *
+ * @example
+ * ```ts
+ * const config = await loadPortalConfig(env, { file: 'custom-portal.config.ts' });
+ * ```
+ */
+export declare const loadPortalConfig: <T extends PortalConfig = PortalConfig>(env: RuntimeEnv, options?: LoadPortalConfigOptions) => Promise<ImportConfigResult<T>>;

package/dist/types/lib/portal/portal-config.d.ts

@@ -0,0 +1,69 @@
+import type { RuntimeEnv } from '../types';
+/**
+ * Represents the configuration object for a portal.
+ *
+ * @remarks
+ * This is a placeholder type for the portal configuration. In a real implementation,
+ * this should be replaced with a more specific type or interface that describes
+ * the shape of your portal's configuration.
+ *
+ * @example
+ * ```ts
+ * const config: PortalConfig = {
+ *   environment: { name: 'production' },
+ *   features: { enableBeta: true },
+ * };
+ * ```
+ */
+export type PortalConfig = Record<any, any>;
+/**
+ * A function type for defining dynamic or static portal configuration.
+ *
+ * @param env - The runtime environment object, providing context such as root directory, environment variables, etc.
+ * @param args - An object containing the base portal configuration (useful for merging or extending configs).
+ * @returns The portal configuration object, a promise resolving to it, or void if no configuration is provided.
+ *
+ * @remarks
+ * This function enables both static and dynamic configuration patterns. It can be used to
+ * return a configuration object directly, or to compute it asynchronously (e.g., by reading files or fetching data).
+ *
+ * @example <caption>Static configuration</caption>
+ * ```ts
+ * export const config: PortalConfigFn = (env, { base }) => ({
+ *   ...base,
+ *   environment: { name: env.environment },
+ *   features: { enableBeta: false },
+ * });
+ * ```
+ *
+ * @example <caption>Async configuration</caption>
+ * ```ts
+ * export const config: PortalConfigFn = async (env, { base }) => {
+ *   const remoteSettings = await fetchRemoteSettings(env);
+ *   return { ...base, ...remoteSettings };
+ * };
+ * ```
+ */
+export type PortalConfigFn = (config: PortalConfig, env: RuntimeEnv) => PortalConfig | Promise<PortalConfig | void> | void;
+/**
+ * Utility to define a portal configuration function for the framework.
+ *
+ * @param fn - A function that returns the portal configuration object (either synchronously or asynchronously).
+ * @returns The provided configuration function, unchanged.
+ *
+ * @remarks
+ * This utility is used to provide type safety and tooling support for portal configuration authoring.
+ * It is a no-op at runtime, but helps with code completion and documentation for consumers.
+ *
+ * @example
+ * ```ts
+ * import { definePortalConfig } from 'fusion-framework';
+ *
+ * export default definePortalConfig((env, { base }) => ({
+ *   ...base,
+ *   environment: { name: env.environment },
+ *   features: { enableBeta: true },
+ * }));
+ * ```
+ */
+export declare const definePortalConfig: (fn: PortalConfigFn) => PortalConfigFn;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "11.0.0-next.5";
+export declare const version = "11.0.0-next.6";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-cli",
-  "version": "11.0.0-next.5",
+  "version": "11.0.0-next.6",
   "homepage": "https://github.com/equinor/fusion-framework",
   "keywords": [
     "Fusion",
@@ -21,7 +21,8 @@
   ],
   "type": "module",
   "bin": {
-    "fusion-framework-cli": "./bin/cli.mjs"
+    "fusion-framework-cli": "./bin/cli.mjs",
+    "ffc": "./bin/cli.mjs"
   },
   "main": "./bin/main.js",
   "types": "./dist/types/lib.d.ts",
@@ -85,8 +86,8 @@
     "@equinor/fusion-framework-module": "^4.4.3-next.0",
     "@equinor/fusion-framework-module-http": "^6.3.3-next.1",
     "@equinor/fusion-framework-module-app": "^6.1.13",
-    "@equinor/fusion-framework-module-service-discovery": "^8.0.15-next.1",
-    "@equinor/fusion-framework-module-msal-node": "^0.1.1-next.1"
+    "@equinor/fusion-framework-module-msal-node": "^0.1.1-next.1",
+    "@equinor/fusion-framework-module-service-discovery": "^8.0.15-next.1"
   },
   "peerDependenciesMeta": {
     "typescript": {