@equinor/fusion-framework-dev-server 1.1.32-next.0 → 2.0.0

package/dist/types/create-dev-server-config.d.ts

@@ -1,33 +1,49 @@
 import { type UserConfig } from 'vite';
 import type { DevServerOptions, TemplateEnv } from './types.js';
 /**
- * Creates a development server configuration for a Fusion Framework application.
+ * Build a Vite {@link import('vite').UserConfig | UserConfig} for a Fusion Framework dev server
+ * without starting the server.
  *
- * @template TEnv - A type extending `Partial<TemplateEnv>` that represents the environment variables for the template.
- * @param options - The options for configuring the development server.
- * @param options.spa - Optional configuration for the Single Page Application (SPA), including template environment settings.
- * @param options.api - Configuration for the API, including service discovery URL, routes, and service processing logic.
+ * Use this function when you need control over the server lifecycle (e.g. to pass the config
+ * to another Vite tool). For a simpler create-and-listen workflow, use {@link createDevServer}.
  *
- * @returns A `UserConfig` object that defines the Vite development server configuration.
+ * The generated config includes:
+ * - `@vitejs/plugin-react` for React Fast Refresh / HMR
+ * - `@equinor/fusion-framework-vite-plugin-api-service` for service discovery proxying
+ * - `@equinor/fusion-framework-vite-plugin-spa` for template environment injection
+ * - CORS disabled so backend services handle OPTIONS with proper headers
+ *
+ * @template TEnv - Environment variable shape extending `Partial<TemplateEnv>`, used to type-check
+ *                  the SPA template environment object or factory function.
+ * @param options - Development server options containing SPA, API, and logging settings.
+ * @param overrides - Optional Vite config merged on top of the generated base config via
+ *                    {@link import('vite').mergeConfig | mergeConfig}.
+ * @returns A fully resolved Vite `UserConfig` ready for {@link import('vite').createServer | createServer}.
  *
  * @remarks
- * - The `spa.templateEnv` can either be a function or a partial object of type `TEnv`.
- * - The `api.processServices` defaults to `defaultProcessServices` if not provided.
- * - The server is configured to run on port 3000.
- * - Includes plugins for API service handling and SPA template environment generation.
- * - CORS is disabled to allow backend services to handle OPTIONS requests with proper headers.
+ * - `spa.templateEnv` accepts either a static object or a factory function returning the environment.
+ * - `api.processServices` defaults to the built-in {@link processServices} when omitted.
+ * - The default log level is `Info`; set `log.level` to `4` for debug output.
  *
  * @example
  * ```typescript
+ * import { createDevServerConfig } from '@equinor/fusion-framework-dev-server';
+ * import { createServer } from 'vite';
+ *
  * const config = createDevServerConfig({
  *   spa: {
- *     templateEnv: { API_URL: 'https://api.example.com' },
- *   },
- *   api: {
- *     serviceDiscoveryUrl: 'https://discovery.example.com',
- *     routes: ['/api'],
+ *     templateEnv: {
+ *       portal: { id: 'my-portal' },
+ *       title: 'My App',
+ *       serviceDiscovery: { url: 'https://discovery.example.com', scopes: [] },
+ *       msal: { clientId: 'cid', tenantId: 'tid', redirectUri: '/auth/cb', requiresAuth: 'true' },
+ *     },
  *   },
+ *   api: { serviceDiscoveryUrl: 'https://discovery.example.com' },
  * });
+ *
+ * const server = await createServer(config);
+ * await server.listen();
  * ```
  */
 export declare const createDevServerConfig: <TEnv extends Partial<TemplateEnv>>(options: DevServerOptions<TEnv>, overrides?: UserConfig) => UserConfig;

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

@@ -1,10 +1,40 @@
 import { type UserConfig } from 'vite';
 import type { DevServerOptions } from './types.js';
 /**
- * Asynchronously creates and configures a development server instance.
+ * Create and return a fully configured Vite development server for a Fusion Framework application.
  *
- * @param options - The options used to configure the development server.
- * @returns A promise that resolves to the created development server instance.
+ * Combines SPA template environment injection, service discovery proxying, and React HMR into
+ * a single ready-to-listen server instance. Use this function when you want the default
+ * development workflow; use {@link createDevServerConfig} instead if you only need the Vite
+ * configuration object without starting the server.
+ *
+ * @param options - Development server configuration including SPA template environment,
+ *                  API proxy settings, and optional logging overrides.
+ * @param overrides - Optional Vite {@link import('vite').UserConfig | UserConfig} merged on top
+ *                    of the generated configuration (e.g. custom port, extra plugins).
+ * @returns A promise that resolves to a Vite {@link import('vite').ViteDevServer | ViteDevServer}
+ *          ready for {@link import('vite').ViteDevServer.listen | listen()} and
+ *          {@link import('vite').ViteDevServer.printUrls | printUrls()}.
+ *
+ * @example
+ * ```typescript
+ * import { createDevServer } from '@equinor/fusion-framework-dev-server';
+ *
+ * const server = await createDevServer({
+ *   spa: {
+ *     templateEnv: {
+ *       portal: { id: 'my-portal' },
+ *       title: 'My App',
+ *       serviceDiscovery: { url: 'https://discovery.example.com', scopes: [] },
+ *       msal: { clientId: 'id', tenantId: 'tid', redirectUri: '/auth/callback', requiresAuth: 'true' },
+ *     },
+ *   },
+ *   api: { serviceDiscoveryUrl: 'https://discovery.example.com' },
+ * });
+ *
+ * await server.listen();
+ * server.printUrls();
+ * ```
  */
 export declare const createDevServer: (options: DevServerOptions, overrides?: UserConfig) => Promise<import("vite").ViteDevServer>;
 export default createDevServer;

package/dist/types/index.d.ts

@@ -1,6 +1,34 @@
+/**
+ * @packageDocumentation
+ *
+ * Development server for Fusion Framework applications.
+ *
+ * Provides a pre-configured Vite dev server with integrated service discovery proxying,
+ * SPA template environment injection, and React HMR support. Use this package when you
+ * need a local development environment that mirrors production Fusion portal behaviour.
+ *
+ * @remarks
+ * Main entry points:
+ * - {@link createDevServer} — create and start a fully configured Vite dev server
+ * - {@link createDevServerConfig} — build a Vite `UserConfig` without starting the server
+ * - {@link processServices} — remap Fusion service URIs to local proxy routes
+ *
+ * @example
+ * ```typescript
+ * import { createDevServer } from '@equinor/fusion-framework-dev-server';
+ *
+ * const server = await createDevServer({
+ *   api: { serviceDiscoveryUrl: 'https://discovery.example.com' },
+ * });
+ * await server.listen();
+ * server.printUrls();
+ * ```
+ */
+/** Re-export of Vite's {@link import('vite').UserConfig | UserConfig} for consumer convenience when passing overrides. */
 export type { UserConfig } from 'vite';
 export { processServices } from './process-services.js';
 export { default, createDevServer } from './create-dev-server.js';
 export { createDevServerConfig } from './create-dev-server-config.js';
+/** Re-export of the SPA template environment type used to configure portal, MSAL, and service discovery settings. */
 export type { FusionTemplateEnv } from '@equinor/fusion-framework-vite-plugin-spa';
 export * from './types.js';

package/dist/types/process-services.d.ts

@@ -1,16 +1,19 @@
 import type { ApiDataProcessor } from '@equinor/fusion-framework-vite-plugin-api-service';
 import type { FusionService } from './types.js';
 /**
- * Processes an array of Fusion services, remapping their URIs to proxy through the development server
- * and generating corresponding proxy routes.
+ * Remap Fusion service discovery entries so their URIs point through the local dev server proxy,
+ * and generate matching Vite proxy routes for each service.
  *
- * @template T - The type of the input data, expected to be an array of `FusionService`.
- * @param data - The input array of Fusion services to process.
- * @param args - Additional arguments containing the route and request information.
- * @param args.route - The base route used to construct the proxy paths.
- * @param args.request - The HTTP request object, used to extract the referer header.
- * @returns An object containing the processed services and the generated proxy routes.
- * @throws {Error} If the input data is not an array.
+ * Use this as the default `api.processServices` handler in {@link DevServerOptions}, or call it
+ * inside a custom handler to get the base mapping before applying additional transformations
+ * (e.g. adding mock services or filtering environments).
+ *
+ * @param data - Array of {@link FusionService} entries returned by the service discovery endpoint.
+ * @param args - Context provided by the API service plugin.
+ * @param args.route - Base route path used to construct local proxy URLs (e.g. `'/services-proxy'`).
+ * @param args.request - Incoming HTTP request; the `referer` header is used to resolve the local origin.
+ * @returns An object with `data` (services with rewritten URIs) and `routes` (Vite proxy route configs).
+ * @throws {Error} When `data` is not an array, indicating an unexpected service discovery response.
  *
  * @example
  * ```typescript

package/dist/types/types.d.ts

@@ -1,32 +1,61 @@
 import type { ApiDataProcessor, ApiRoute } from '@equinor/fusion-framework-vite-plugin-api-service';
 import type { FusionTemplateEnv, TemplateEnvFn } from '@equinor/fusion-framework-vite-plugin-spa';
 import type { ConsoleLogger } from '@equinor/fusion-log';
+/**
+ * A service entry returned by the Fusion service discovery endpoint.
+ *
+ * Each entry represents a single backend service that can be proxied
+ * through the development server via {@link processServices}.
+ */
 export type FusionService = {
+    /** Unique service identifier used as the proxy path segment (e.g. `'context'`, `'people'`). */
     key: string;
+    /** Absolute URL of the upstream service endpoint. */
     uri: string;
+    /** Human-readable display name of the service. */
     name: string;
 };
+/**
+ * Re-export of {@link FusionTemplateEnv} under the local alias `TemplateEnv`.
+ *
+ * Describes the environment variables injected into the SPA HTML template
+ * (portal ID, service discovery URL, MSAL settings, telemetry level, etc.).
+ */
 export { FusionTemplateEnv as TemplateEnv, TemplateEnvFn, } from '@equinor/fusion-framework-vite-plugin-spa';
+/**
+ * Alias for Vite's `UserConfig`, used as the optional overrides parameter
+ * of {@link createDevServer} and {@link createDevServerConfig}.
+ */
 export { UserConfig as DevServerOverrides } from 'vite';
 /**
- * Configuration options for the development server.
- *
- * @template TEnv - The type of the environment variables, extending Partial<FusionTemplateEnv>.
+ * Configuration options for the Fusion Framework development server.
  *
- * @property spa - Optional Single Page Application (SPA) specific options.
- * @property spa.templateEnv - The template environment configuration or a function returning it.
+ * Pass an instance of this type to {@link createDevServer} or {@link createDevServerConfig}
+ * to configure SPA template injection, API service discovery proxying, and server-side logging.
  *
- * @property api - API proxy configuration options.
- * @property api.serviceDiscoveryUrl - The URL of the service discovery proxy endpoint.
- * @property api.processServices - Optional route mapper for processing service discovery data.
- * @property api.routes - Optional additional routes for the API service proxy, used for overriding proxy responses and mocking services.
+ * @template TEnv - Shape of the SPA template environment variables, extending
+ *                  `Partial<FusionTemplateEnv>`. Defaults to `Partial<FusionTemplateEnv>`.
  *
- * @property log - Optional logging configuration.
- * @property log.level - Optional log level.
- * @property log.logger - Optional custom logger implementing the ConsoleLogger interface.
+ * @example
+ * ```typescript
+ * const opts: DevServerOptions = {
+ *   spa: {
+ *     templateEnv: {
+ *       portal: { id: 'my-portal' },
+ *       title: 'My App',
+ *       serviceDiscovery: { url: 'https://discovery.example.com', scopes: [] },
+ *       msal: { clientId: 'id', tenantId: 'tid', redirectUri: '/auth/cb', requiresAuth: 'true' },
+ *     },
+ *   },
+ *   api: { serviceDiscoveryUrl: 'https://discovery.example.com' },
+ *   log: { level: 3 },
+ * };
+ * ```
  */
 export type DevServerOptions<TEnv extends Partial<FusionTemplateEnv> = Partial<FusionTemplateEnv>> = {
+    /** SPA template settings. When provided, the dev server injects these values into the HTML template at serve time. */
     spa?: {
+        /** Static environment object or factory function that produces it on each request. */
         templateEnv: TEnv | TemplateEnvFn<TEnv>;
     };
     api: {
@@ -44,8 +73,11 @@ export type DevServerOptions<TEnv extends Partial<FusionTemplateEnv> = Partial<F
          */
         routes?: ApiRoute[];
     };
+    /** Server-side (CLI) logging configuration. */
     log?: {
+        /** Log verbosity: 0 = None, 1 = Error, 2 = Warning, 3 = Info, 4 = Debug. Defaults to Info (3). */
         level?: number;
+        /** Custom logger instance. When omitted a default {@link ConsoleLogger} is created. */
         logger?: ConsoleLogger;
     };
 };

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "1.1.32-next.0";
+export declare const version = "2.0.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-dev-server",
-  "version": "1.1.32-next.0",
+  "version": "2.0.0",
   "description": "Package for running a development server for fusion-framework",
   "type": "module",
   "exports": {
@@ -29,18 +29,18 @@
     "access": "public"
   },
   "dependencies": {
-    "@vitejs/plugin-react": "^5.0.2",
-    "@equinor/fusion-framework-vite-plugin-api-service": "1.2.6-next.0",
-    "@equinor/fusion-framework-vite-plugin-spa": "3.1.12-next.0",
-    "@equinor/fusion-log": "1.1.9-next.0"
+    "@vitejs/plugin-react": "^6.0.1",
+    "@equinor/fusion-framework-vite-plugin-api-service": "2.0.0",
+    "@equinor/fusion-framework-vite-plugin-spa": "4.0.0",
+    "@equinor/fusion-log": "2.0.0"
   },
   "devDependencies": {
-    "typescript": "^5.8.2",
-    "vite": "^7.1.12",
-    "vitest": "^4.0.18"
+    "typescript": "^5.9.3",
+    "vite": "^8.0.0",
+    "vitest": "^4.1.0"
   },
   "peerDependencies": {
-    "vite": "^7.0.0"
+    "vite": "^7.0.0 || ^8.0.0"
   },
   "scripts": {
     "build": "tsc -b",

package/src/create-dev-server-config.ts

@@ -13,6 +13,13 @@ import { processServices as defaultProcessServices } from './process-services.js
 
 import type { DevServerOptions, TemplateEnv, TemplateEnvFn } from './types.js';
 
+/**
+ * Create a default {@link ConsoleLogger} instance for the dev server.
+ *
+ * @param lvl - Log verbosity level; defaults to {@link LogLevel.Info}.
+ * @param title - Logger title printed as a prefix in console output; defaults to `'dev-server'`.
+ * @returns A configured {@link ConsoleLogger} instance.
+ */
 const createDefaultLogger = (lvl: LogLevel = LogLevel.Info, title = 'dev-server') => {
   const logger = new ConsoleLogger(title);
   logger.level = lvl;
@@ -20,33 +27,49 @@ const createDefaultLogger = (lvl: LogLevel = LogLevel.Info, title = 'dev-server'
 };
 
 /**
- * Creates a development server configuration for a Fusion Framework application.
+ * Build a Vite {@link import('vite').UserConfig | UserConfig} for a Fusion Framework dev server
+ * without starting the server.
+ *
+ * Use this function when you need control over the server lifecycle (e.g. to pass the config
+ * to another Vite tool). For a simpler create-and-listen workflow, use {@link createDevServer}.
  *
- * @template TEnv - A type extending `Partial<TemplateEnv>` that represents the environment variables for the template.
- * @param options - The options for configuring the development server.
- * @param options.spa - Optional configuration for the Single Page Application (SPA), including template environment settings.
- * @param options.api - Configuration for the API, including service discovery URL, routes, and service processing logic.
+ * The generated config includes:
+ * - `@vitejs/plugin-react` for React Fast Refresh / HMR
+ * - `@equinor/fusion-framework-vite-plugin-api-service` for service discovery proxying
+ * - `@equinor/fusion-framework-vite-plugin-spa` for template environment injection
+ * - CORS disabled so backend services handle OPTIONS with proper headers
  *
- * @returns A `UserConfig` object that defines the Vite development server configuration.
+ * @template TEnv - Environment variable shape extending `Partial<TemplateEnv>`, used to type-check
+ *                  the SPA template environment object or factory function.
+ * @param options - Development server options containing SPA, API, and logging settings.
+ * @param overrides - Optional Vite config merged on top of the generated base config via
+ *                    {@link import('vite').mergeConfig | mergeConfig}.
+ * @returns A fully resolved Vite `UserConfig` ready for {@link import('vite').createServer | createServer}.
  *
  * @remarks
- * - The `spa.templateEnv` can either be a function or a partial object of type `TEnv`.
- * - The `api.processServices` defaults to `defaultProcessServices` if not provided.
- * - The server is configured to run on port 3000.
- * - Includes plugins for API service handling and SPA template environment generation.
- * - CORS is disabled to allow backend services to handle OPTIONS requests with proper headers.
+ * - `spa.templateEnv` accepts either a static object or a factory function returning the environment.
+ * - `api.processServices` defaults to the built-in {@link processServices} when omitted.
+ * - The default log level is `Info`; set `log.level` to `4` for debug output.
  *
  * @example
  * ```typescript
+ * import { createDevServerConfig } from '@equinor/fusion-framework-dev-server';
+ * import { createServer } from 'vite';
+ *
  * const config = createDevServerConfig({
  *   spa: {
- *     templateEnv: { API_URL: 'https://api.example.com' },
- *   },
- *   api: {
- *     serviceDiscoveryUrl: 'https://discovery.example.com',
- *     routes: ['/api'],
+ *     templateEnv: {
+ *       portal: { id: 'my-portal' },
+ *       title: 'My App',
+ *       serviceDiscovery: { url: 'https://discovery.example.com', scopes: [] },
+ *       msal: { clientId: 'cid', tenantId: 'tid', redirectUri: '/auth/cb', requiresAuth: 'true' },
+ *     },
  *   },
+ *   api: { serviceDiscoveryUrl: 'https://discovery.example.com' },
  * });
+ *
+ * const server = await createServer(config);
+ * await server.listen();
  * ```
  */
 export const createDevServerConfig = <TEnv extends Partial<TemplateEnv>>(

package/src/create-dev-server.ts

@@ -4,10 +4,40 @@ import { createDevServerConfig } from './create-dev-server-config.js';
 import type { DevServerOptions } from './types.js';
 
 /**
- * Asynchronously creates and configures a development server instance.
+ * Create and return a fully configured Vite development server for a Fusion Framework application.
  *
- * @param options - The options used to configure the development server.
- * @returns A promise that resolves to the created development server instance.
+ * Combines SPA template environment injection, service discovery proxying, and React HMR into
+ * a single ready-to-listen server instance. Use this function when you want the default
+ * development workflow; use {@link createDevServerConfig} instead if you only need the Vite
+ * configuration object without starting the server.
+ *
+ * @param options - Development server configuration including SPA template environment,
+ *                  API proxy settings, and optional logging overrides.
+ * @param overrides - Optional Vite {@link import('vite').UserConfig | UserConfig} merged on top
+ *                    of the generated configuration (e.g. custom port, extra plugins).
+ * @returns A promise that resolves to a Vite {@link import('vite').ViteDevServer | ViteDevServer}
+ *          ready for {@link import('vite').ViteDevServer.listen | listen()} and
+ *          {@link import('vite').ViteDevServer.printUrls | printUrls()}.
+ *
+ * @example
+ * ```typescript
+ * import { createDevServer } from '@equinor/fusion-framework-dev-server';
+ *
+ * const server = await createDevServer({
+ *   spa: {
+ *     templateEnv: {
+ *       portal: { id: 'my-portal' },
+ *       title: 'My App',
+ *       serviceDiscovery: { url: 'https://discovery.example.com', scopes: [] },
+ *       msal: { clientId: 'id', tenantId: 'tid', redirectUri: '/auth/callback', requiresAuth: 'true' },
+ *     },
+ *   },
+ *   api: { serviceDiscoveryUrl: 'https://discovery.example.com' },
+ * });
+ *
+ * await server.listen();
+ * server.printUrls();
+ * ```
  */
 export const createDevServer = async (options: DevServerOptions, overrides?: UserConfig) => {
   const config = createDevServerConfig(options, overrides);

package/src/index.ts

@@ -1,3 +1,31 @@
+/**
+ * @packageDocumentation
+ *
+ * Development server for Fusion Framework applications.
+ *
+ * Provides a pre-configured Vite dev server with integrated service discovery proxying,
+ * SPA template environment injection, and React HMR support. Use this package when you
+ * need a local development environment that mirrors production Fusion portal behaviour.
+ *
+ * @remarks
+ * Main entry points:
+ * - {@link createDevServer} — create and start a fully configured Vite dev server
+ * - {@link createDevServerConfig} — build a Vite `UserConfig` without starting the server
+ * - {@link processServices} — remap Fusion service URIs to local proxy routes
+ *
+ * @example
+ * ```typescript
+ * import { createDevServer } from '@equinor/fusion-framework-dev-server';
+ *
+ * const server = await createDevServer({
+ *   api: { serviceDiscoveryUrl: 'https://discovery.example.com' },
+ * });
+ * await server.listen();
+ * server.printUrls();
+ * ```
+ */
+
+/** Re-export of Vite's {@link import('vite').UserConfig | UserConfig} for consumer convenience when passing overrides. */
 export type { UserConfig } from 'vite';
 
 export { processServices } from './process-services.js';
@@ -6,6 +34,7 @@ export { default, createDevServer } from './create-dev-server.js';
 
 export { createDevServerConfig } from './create-dev-server-config.js';
 
+/** Re-export of the SPA template environment type used to configure portal, MSAL, and service discovery settings. */
 export type { FusionTemplateEnv } from '@equinor/fusion-framework-vite-plugin-spa';
 
 export * from './types.js';

package/src/process-services.ts

@@ -2,16 +2,19 @@ import type { ApiDataProcessor, ApiRoute } from '@equinor/fusion-framework-vite-
 import type { FusionService } from './types.js';
 
 /**
- * Processes an array of Fusion services, remapping their URIs to proxy through the development server
- * and generating corresponding proxy routes.
+ * Remap Fusion service discovery entries so their URIs point through the local dev server proxy,
+ * and generate matching Vite proxy routes for each service.
  *
- * @template T - The type of the input data, expected to be an array of `FusionService`.
- * @param data - The input array of Fusion services to process.
- * @param args - Additional arguments containing the route and request information.
- * @param args.route - The base route used to construct the proxy paths.
- * @param args.request - The HTTP request object, used to extract the referer header.
- * @returns An object containing the processed services and the generated proxy routes.
- * @throws {Error} If the input data is not an array.
+ * Use this as the default `api.processServices` handler in {@link DevServerOptions}, or call it
+ * inside a custom handler to get the base mapping before applying additional transformations
+ * (e.g. adding mock services or filtering environments).
+ *
+ * @param data - Array of {@link FusionService} entries returned by the service discovery endpoint.
+ * @param args - Context provided by the API service plugin.
+ * @param args.route - Base route path used to construct local proxy URLs (e.g. `'/services-proxy'`).
+ * @param args.request - Incoming HTTP request; the `referer` header is used to resolve the local origin.
+ * @returns An object with `data` (services with rewritten URIs) and `routes` (Vite proxy route configs).
+ * @throws {Error} When `data` is not an array, indicating an unexpected service discovery response.
  *
  * @example
  * ```typescript

package/src/types.ts

@@ -2,39 +2,68 @@ import type { ApiDataProcessor, ApiRoute } from '@equinor/fusion-framework-vite-
 import type { FusionTemplateEnv, TemplateEnvFn } from '@equinor/fusion-framework-vite-plugin-spa';
 import type { ConsoleLogger } from '@equinor/fusion-log';
 
+/**
+ * A service entry returned by the Fusion service discovery endpoint.
+ *
+ * Each entry represents a single backend service that can be proxied
+ * through the development server via {@link processServices}.
+ */
 export type FusionService = {
+  /** Unique service identifier used as the proxy path segment (e.g. `'context'`, `'people'`). */
   key: string;
+  /** Absolute URL of the upstream service endpoint. */
   uri: string;
+  /** Human-readable display name of the service. */
   name: string;
 };
 
+/**
+ * Re-export of {@link FusionTemplateEnv} under the local alias `TemplateEnv`.
+ *
+ * Describes the environment variables injected into the SPA HTML template
+ * (portal ID, service discovery URL, MSAL settings, telemetry level, etc.).
+ */
 export {
   FusionTemplateEnv as TemplateEnv,
   TemplateEnvFn,
 } from '@equinor/fusion-framework-vite-plugin-spa';
 
+/**
+ * Alias for Vite's `UserConfig`, used as the optional overrides parameter
+ * of {@link createDevServer} and {@link createDevServerConfig}.
+ */
 export { UserConfig as DevServerOverrides } from 'vite';
 
 /**
- * Configuration options for the development server.
- *
- * @template TEnv - The type of the environment variables, extending Partial<FusionTemplateEnv>.
+ * Configuration options for the Fusion Framework development server.
  *
- * @property spa - Optional Single Page Application (SPA) specific options.
- * @property spa.templateEnv - The template environment configuration or a function returning it.
+ * Pass an instance of this type to {@link createDevServer} or {@link createDevServerConfig}
+ * to configure SPA template injection, API service discovery proxying, and server-side logging.
  *
- * @property api - API proxy configuration options.
- * @property api.serviceDiscoveryUrl - The URL of the service discovery proxy endpoint.
- * @property api.processServices - Optional route mapper for processing service discovery data.
- * @property api.routes - Optional additional routes for the API service proxy, used for overriding proxy responses and mocking services.
+ * @template TEnv - Shape of the SPA template environment variables, extending
+ *                  `Partial<FusionTemplateEnv>`. Defaults to `Partial<FusionTemplateEnv>`.
  *
- * @property log - Optional logging configuration.
- * @property log.level - Optional log level.
- * @property log.logger - Optional custom logger implementing the ConsoleLogger interface.
+ * @example
+ * ```typescript
+ * const opts: DevServerOptions = {
+ *   spa: {
+ *     templateEnv: {
+ *       portal: { id: 'my-portal' },
+ *       title: 'My App',
+ *       serviceDiscovery: { url: 'https://discovery.example.com', scopes: [] },
+ *       msal: { clientId: 'id', tenantId: 'tid', redirectUri: '/auth/cb', requiresAuth: 'true' },
+ *     },
+ *   },
+ *   api: { serviceDiscoveryUrl: 'https://discovery.example.com' },
+ *   log: { level: 3 },
+ * };
+ * ```
  */
 export type DevServerOptions<TEnv extends Partial<FusionTemplateEnv> = Partial<FusionTemplateEnv>> =
   {
+    /** SPA template settings. When provided, the dev server injects these values into the HTML template at serve time. */
     spa?: {
+      /** Static environment object or factory function that produces it on each request. */
       templateEnv: TEnv | TemplateEnvFn<TEnv>;
     };
     api: {
@@ -54,8 +83,11 @@ export type DevServerOptions<TEnv extends Partial<FusionTemplateEnv> = Partial<F
        */
       routes?: ApiRoute[];
     };
+    /** Server-side (CLI) logging configuration. */
     log?: {
+      /** Log verbosity: 0 = None, 1 = Error, 2 = Warning, 3 = Info, 4 = Debug. Defaults to Info (3). */
       level?: number;
+      /** Custom logger instance. When omitted a default {@link ConsoleLogger} is created. */
       logger?: ConsoleLogger;
     };
   };

package/src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '1.1.32-next.0';
+export const version = '2.0.0';