@equinor/fusion-framework-dev-server 1.1.31 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @equinor/fusion-framework-dev-server
 
+## 2.0.0
+
+### Major Changes
+
+- abffa53: Major version bump for Fusion Framework React 19 release.
+
+  All packages are bumped to the next major version as part of the React 19 upgrade. This release drops support for React versions below 18 and includes breaking changes across the framework.
+
+  **Breaking changes:**
+  - Peer dependencies now require React 18 or 19 (`^18.0.0 || ^19.0.0`)
+  - React Router upgraded from v6 to v7
+  - Navigation module refactored with new history API
+  - `renderComponent` and `renderApp` now use `createRoot` API
+
+  **Migration:**
+  - Update your React version to 18.0.0 or higher before upgrading
+  - Replace `NavigationProvider.createRouter()` with `@equinor/fusion-framework-react-router`
+  - See individual package changelogs for package-specific migration steps
+
+### Patch Changes
+
+- aa35c46: chore: bump @vitejs/plugin-react from 5.1.4 to 6.0.1
+- 32bcf83: Bump `vite` from `7.3.1` to `8.0.0`.
+
+  Vite 8 replaces Rollup with Rolldown and esbuild with Oxc for faster builds.
+  No breaking API changes affect this codebase. The `dev-server` peerDependency
+  is widened to accept both Vite 7 and Vite 8.
+
+- Updated dependencies [abffa53]
+- Updated dependencies [32bcf83]
+  - @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
+
 ## 1.1.31
 
 ### Patch Changes
@@ -169,20 +203,17 @@
   This update addresses a security vulnerability in Vite's development server and includes bug fixes for improved compatibility. The update ensures secure development environments and better plugin ecosystem compatibility.
 
   **Changes:**
-
   - Updated Vite from v7.1.10 to v7.1.12
   - Includes security fix for development server file system checks
   - Includes compatibility fix for CommonJS plugin
   - No breaking changes or API modifications
 
   **Security Fix (v7.1.11):**
-
   - **dev**: trim trailing slash before `server.fs.deny` check ([#20968](https://github.com/vitejs/vite/issues/20968))
     - Prevents potential path traversal vulnerability in development server
     - Only affects development environment, not production builds
 
   **Bug Fix (v7.1.12):**
-
   - **deps**: downgrade commonjs plugin to 28.0.6 to avoid rollup/plugins issues ([#20990](https://github.com/vitejs/vite/issues/20990))
     - Improves compatibility with Rollup plugin ecosystem
     - Prevents potential build issues
@@ -240,7 +271,6 @@
 ### Patch Changes
 
 - [`56c27ec`](https://github.com/equinor/fusion-framework/commit/56c27ec9de03e07e725eecfdf2c028a1e29b6ece) Thanks [@odinr](https://github.com/odinr)! - Updated workspace dependencies to use exact version specifiers for consistent release behavior.
-
   - Changed workspace dependencies from `workspace:^` to `workspace:*` across CLI, dev-server, and SPA vite plugin packages
   - Ensures exact version resolution within the monorepo for predictable builds and releases
   - Affects both dependencies and devDependencies where applicable
@@ -263,7 +293,6 @@
 ### Patch Changes
 
 - [#3443](https://github.com/equinor/fusion-framework/pull/3443) [`2291483`](https://github.com/equinor/fusion-framework/commit/2291483b10ea288102155839dc47dcfe2addc22c) Thanks [@eikeland](https://github.com/eikeland)! - Fix OPTIONS requests missing Allow header after Vite 7 update
-
   - Disabled Vite's internal CORS handling by setting `server.cors: false`
   - This allows backend services to properly handle OPTIONS requests with correct headers
   - Resolves issue where OPTIONS requests were not forwarded to backend after Vite 7 upgrade
@@ -278,7 +307,6 @@
 - [#3349](https://github.com/equinor/fusion-framework/pull/3349) [`c511123`](https://github.com/equinor/fusion-framework/commit/c511123c835e24e9ddefcc4c47c2455f5df12087) Thanks [@dependabot](https://github.com/apps/dependabot)! - chore: bump vite from 6.x to 7.1.5
 
   Major version update of Vite build tool across all packages. This update includes:
-
   - Enhanced build performance and caching
   - Better error reporting with code frames
   - Improved TypeScript integration
@@ -286,7 +314,6 @@
   - New development server features
 
   ### Links
-
   - [Vite 7.1.5 Release Notes](https://github.com/vitejs/vite/releases/tag/v7.1.5)
   - [Vite 7.x Migration Guide](https://vitejs.dev/guide/migration)
 
@@ -297,18 +324,15 @@
   Major version update of Vitest testing framework for dev-server package.
 
   ### Breaking Changes
-
   - Updated from Vitest v2 to v3
   - Test runner behavior improvements
 
   ### New Features
-
   - Enhanced test performance
   - Better error handling and reporting
   - Updated Vite integration (v6.3.5)
 
   ### Links
-
   - [Vitest v3.2.4 Release Notes](https://github.com/vitest-dev/vitest/releases/tag/v3.2.4)
   - [Vitest v3 Migration Guide](https://vitest.dev/guide/migration.html)
 
@@ -323,7 +347,6 @@
 - [#2910](https://github.com/equinor/fusion-framework/pull/2910) [`07cc985`](https://github.com/equinor/fusion-framework/commit/07cc9857e1427b574e011cc319518e701dba784d) Thanks [@dependabot](https://github.com/apps/dependabot)! - Updated vitest from 2.1.9 to 3.2.4 across all packages.
 
   ## Breaking Changes
-
   - **Node.js Requirements**: Requires Node.js 18+ (already satisfied)
   - **Vite Compatibility**: Updated to work with Vite 7.x (already using Vite 7.1.5)
   - **Snapshot Format**: Snapshots now use backtick quotes (\`) instead of single quotes
@@ -331,18 +354,15 @@
   - **TypeScript Support**: Enhanced TypeScript integration and type definitions
 
   ## Security Updates
-
   - CVE-2025-24963: Browser mode serves arbitrary files (fixed in 2.1.9)
   - CVE-2025-24964: Remote Code Execution vulnerability (fixed in 2.1.9)
 
   ## Migration Notes
-
   - Test snapshots may need regeneration due to quote format changes
   - Some test configurations might need updates for new TypeScript support
   - Peer dependency warnings for @vitest/coverage-v8 are expected and safe to ignore
 
   ## Links
-
   - [Vitest 3.0 Migration Guide](https://vitest.dev/guide/migration)
   - [Vitest 3.2.4 Release Notes](https://github.com/vitest-dev/vitest/releases/tag/v3.2.4)
 
@@ -358,7 +378,6 @@
 - [#3330](https://github.com/equinor/fusion-framework/pull/3330) [`3590104`](https://github.com/equinor/fusion-framework/commit/3590104bdf3bba3386cdec7e2692078e6a92bd01) Thanks [@odinr](https://github.com/odinr)! - Enhanced dev server configuration by removing `vite-tsconfig-paths` plugin.
 
   > The responsibility for adding the `vite-tsconfig-paths` plugin has been moved to `@equinor/fusion-framework-cli`, which now provides it via the `overrides` parameter in `createDevServerConfig`. This ensures consistent TypeScript path resolution in both development and build environments.
-
   - Removed `vite-tsconfig-paths` dependency from package.json
   - Removed plugin usage from `create-dev-server-config.ts`
 
@@ -371,7 +390,6 @@
 ### Patch Changes
 
 - [#3327](https://github.com/equinor/fusion-framework/pull/3327) [`22d6d3b`](https://github.com/equinor/fusion-framework/commit/22d6d3b7753da8ad30054839e8a6083850a208fa) Thanks [@odinr](https://github.com/odinr)! - Enhanced dev server configuration with improved React and TypeScript path resolution support.
-
   - Added `@vitejs/plugin-react` for better React development experience
   - Added `vite-tsconfig-paths` for improved TypeScript path resolution
   - Updated `create-dev-server-config.ts` to include both plugins in the vite configuration
@@ -385,7 +403,6 @@
   For more details, visit the [GitHub repository](https://github.com/equinor/fusion-framework/tree/main/packages/dev-server/README.md).
 
   **Features**
-
   - _`createDevServer` Function_: Simplifies the creation of a development server using a configuration object.
   - _`createDevServerConfig` Function_: Generates a Vite-compatible configuration for the development server.
   - _SPA Support_: Includes `spa.templateEnv` for defining environment variables specific to Single Page Applications.
@@ -396,7 +413,6 @@
   **Dependencies**
 
   The following dependencies were added to support the new package:
-
   - `@equinor/fusion-framework-vite-plugin-api-service`
   - `@equinor/fusion-framework-vite-plugin-spa`
   - `@equinor/fusion-log`
@@ -519,7 +535,6 @@
 ### Patch Changes
 
 - [#3075](https://github.com/equinor/fusion-framework/pull/3075) [`84c16d7`](https://github.com/equinor/fusion-framework/commit/84c16d74c3235f809ce4c3e75868be12010ed695) Thanks [@odinr](https://github.com/odinr)! - Add `prepack` script to `dev-portal` and `dev-server` packages
-
   - Added a `prepack` script to `@equinor/fusion-framework-dev-portal` and `@equinor/fusion-framework-dev-server` to ensure the build runs before packaging.
   - This helps guarantee that the latest build artifacts are included when publishing these packages.
 
@@ -530,7 +545,6 @@
 - [#3074](https://github.com/equinor/fusion-framework/pull/3074) [`6b034e5`](https://github.com/equinor/fusion-framework/commit/6b034e5459094cea0c0f2490335eef3092390a13) Thanks [@odinr](https://github.com/odinr)! - Introduced a new package, `@equinor/fusion-framework-dev-server`, designed to provide a development server tailored for Fusion Framework applications. Built on top of Vite, it seamlessly integrates Vite and Fusion Framework configurations.
 
   **Features**
-
   - _`createDevServer` Function_: Simplifies the creation of a development server using a configuration object.
   - _`createDevServerConfig` Function_: Generates a Vite-compatible configuration for the development server.
   - _SPA Support_: Includes `spa.templateEnv` for defining environment variables specific to Single Page Applications.
@@ -541,7 +555,6 @@
   **Dependencies**
 
   The following dependencies were added to support the new package:
-
   - `@equinor/fusion-framework-vite-plugin-api-service`
   - `@equinor/fusion-framework-vite-plugin-spa`
   - `@equinor/fusion-log`

package/README.md

@@ -46,6 +46,8 @@ await devServer.listen();
 devServer.printUrls();
 ```
 
+If you only need the Vite configuration object without starting the server, use `createDevServerConfig(options, overrides?)` instead. This returns a `UserConfig` that you can pass to Vite directly or merge with other configurations.
+
 ## Configuration
 
 The dev server accepts a configuration object with the following structure:
@@ -66,7 +68,10 @@ Configure the Single Page Application environment and template generation:
       // Application title
       title: 'My Application',
 
-      // Service discovery settings
+      // Service discovery settings (SPA-side — tells the browser where to find services)
+      // The API-side counterpart is `api.serviceDiscoveryUrl` which sets up server-side proxying.
+      // During development you can redirect individual services to local URLs by storing
+      // overrides in sessionStorage under the key "overriddenServiceDiscoveryUrls".
       serviceDiscovery: {
         url: 'https://service-discovery.example.com',
         scopes: ['scope1', 'scope2'],
@@ -111,6 +116,8 @@ Configure API proxying and service discovery:
     serviceDiscoveryUrl: 'https://service-discovery.example.com',
 
     // Optional: Custom service processing
+    // Takes an array of FusionService objects ({ key, uri, name }) from discovery
+    // and returns { data: FusionService[], routes: ApiRoute[] } with proxy routes.
     processServices: (services, route) => {
       // Process and return services with routes
       return processServices(services, route);

package/dist/esm/create-dev-server-config.js

@@ -4,39 +4,62 @@ import apiServicePlugin, { createProxyHandler, } from '@equinor/fusion-framework
 import fusionSpaPlugin from '@equinor/fusion-framework-vite-plugin-spa';
 import { ConsoleLogger, LogLevel } from '@equinor/fusion-log';
 import { processServices as defaultProcessServices } from './process-services.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.Info, title = 'dev-server') => {
     const logger = new ConsoleLogger(title);
     logger.level = lvl;
     return logger;
 };
 /**
- * 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 = (options, overrides) => {

package/dist/esm/create-dev-server-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-dev-server-config.js","sourceRoot":"","sources":["../../src/create-dev-server-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAmB,MAAM,MAAM,CAAC;AAElE,OAAO,WAAW,MAAM,sBAAsB,CAAC;AAE/C,OAAO,gBAAgB,EAAE,EACvB,kBAAkB,GACnB,MAAM,mDAAmD,CAAC;AAE3D,OAAO,eAAe,MAAM,2CAA2C,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE9D,OAAO,EAAE,eAAe,IAAI,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAIlF,MAAM,mBAAmB,GAAG,CAAC,MAAgB,QAAQ,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,EAAE;IAClF,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;IACxC,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC;IACnB,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,OAA+B,EAC/B,SAAsB,EACV,EAAE;IACd,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IAClC,MAAM,eAAe,GAAG,GAAG,CAAC,eAAe,IAAI,sBAAsB,CAAC;IACtE,MAAM,mBAAmB;IACvB,4CAA4C;IAC5C,OAAO,GAAG,EAAE,WAAW,KAAK,UAAU;QACpC,CAAC,CAAC,GAAG,CAAC,WAAW;QACjB,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,WAA4B,CAAC;IAE9C,qBAAqB;IACrB,MAAM,MAAM,GAAG,GAAG,EAAE,MAAM,IAAI,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAE9D,MAAM,gBAAgB,GAAG,MAAM,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IAC/D,MAAM,SAAS,GAAG,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IAEhD,MAAM,UAAU,GAAG,YAAY,CAAC;QAC9B,OAAO,EAAE,QAAQ;QACjB,MAAM,EAAE;YACN,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC;gBAC5B,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;aACvC,CAAC;SACH;QACD,MAAM,EAAE;YACN,6FAA6F;YAC7F,sFAAsF;YACtF,IAAI,EAAE,KAAK;SACZ;QACD,OAAO,EAAE;YACP,WAAW,EAAE;YACb,gBAAgB,CACd;gBACE,YAAY,EAAE,kBAAkB,CAAC,GAAG,CAAC,mBAAmB,EAAE,eAAe,EAAE;oBACzE,MAAM,EAAE,gBAAgB;iBACzB,CAAC;gBACF,MAAM,EAAE,GAAG,CAAC,MAAM;aACnB,EACD;gBACE,MAAM,EAAE,gBAAgB;aACzB,CACF;YACD,eAAe,CAAC,EAAE,mBAAmB,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;SAC5D;KACF,CAAC,CAAC;IACH,OAAO,WAAW,CAAC,UAAU,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF,eAAe,qBAAqB,CAAC"}
+{"version":3,"file":"create-dev-server-config.js","sourceRoot":"","sources":["../../src/create-dev-server-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAmB,MAAM,MAAM,CAAC;AAElE,OAAO,WAAW,MAAM,sBAAsB,CAAC;AAE/C,OAAO,gBAAgB,EAAE,EACvB,kBAAkB,GACnB,MAAM,mDAAmD,CAAC;AAE3D,OAAO,eAAe,MAAM,2CAA2C,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE9D,OAAO,EAAE,eAAe,IAAI,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAIlF;;;;;;GAMG;AACH,MAAM,mBAAmB,GAAG,CAAC,MAAgB,QAAQ,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,EAAE;IAClF,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;IACxC,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC;IACnB,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,OAA+B,EAC/B,SAAsB,EACV,EAAE;IACd,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IAClC,MAAM,eAAe,GAAG,GAAG,CAAC,eAAe,IAAI,sBAAsB,CAAC;IACtE,MAAM,mBAAmB;IACvB,4CAA4C;IAC5C,OAAO,GAAG,EAAE,WAAW,KAAK,UAAU;QACpC,CAAC,CAAC,GAAG,CAAC,WAAW;QACjB,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,WAA4B,CAAC;IAE9C,qBAAqB;IACrB,MAAM,MAAM,GAAG,GAAG,EAAE,MAAM,IAAI,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAE9D,MAAM,gBAAgB,GAAG,MAAM,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IAC/D,MAAM,SAAS,GAAG,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IAEhD,MAAM,UAAU,GAAG,YAAY,CAAC;QAC9B,OAAO,EAAE,QAAQ;QACjB,MAAM,EAAE;YACN,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC;gBAC5B,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;aACvC,CAAC;SACH;QACD,MAAM,EAAE;YACN,6FAA6F;YAC7F,sFAAsF;YACtF,IAAI,EAAE,KAAK;SACZ;QACD,OAAO,EAAE;YACP,WAAW,EAAE;YACb,gBAAgB,CACd;gBACE,YAAY,EAAE,kBAAkB,CAAC,GAAG,CAAC,mBAAmB,EAAE,eAAe,EAAE;oBACzE,MAAM,EAAE,gBAAgB;iBACzB,CAAC;gBACF,MAAM,EAAE,GAAG,CAAC,MAAM;aACnB,EACD;gBACE,MAAM,EAAE,gBAAgB;aACzB,CACF;YACD,eAAe,CAAC,EAAE,mBAAmB,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;SAC5D;KACF,CAAC,CAAC;IACH,OAAO,WAAW,CAAC,UAAU,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF,eAAe,qBAAqB,CAAC"}

package/dist/esm/create-dev-server.js

@@ -1,10 +1,40 @@
 import { createServer } from 'vite';
 import { createDevServerConfig } from './create-dev-server-config.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, overrides) => {
     const config = createDevServerConfig(options, overrides);

package/dist/esm/create-dev-server.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-dev-server.js","sourceRoot":"","sources":["../../src/create-dev-server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAmB,MAAM,MAAM,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAItE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,OAAyB,EAAE,SAAsB,EAAE,EAAE;IACzF,MAAM,MAAM,GAAG,qBAAqB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,CAAC;IAC1C,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,eAAe,eAAe,CAAC"}
+{"version":3,"file":"create-dev-server.js","sourceRoot":"","sources":["../../src/create-dev-server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAmB,MAAM,MAAM,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAItE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,OAAyB,EAAE,SAAsB,EAAE,EAAE;IACzF,MAAM,MAAM,GAAG,qBAAqB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,CAAC;IAC1C,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,eAAe,eAAe,CAAC"}

package/dist/esm/index.js

@@ -1,3 +1,29 @@
+/**
+ * @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();
+ * ```
+ */
 export { processServices } from './process-services.js';
 export { default, createDevServer } from './create-dev-server.js';
 export { createDevServerConfig } from './create-dev-server-config.js';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAElE,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAItE,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAKH,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAElE,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAKtE,cAAc,YAAY,CAAC"}

package/dist/esm/process-services.js

@@ -1,14 +1,17 @@
 /**
- * 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/esm/process-services.js.map

@@ -1 +1 @@
-{"version":3,"file":"process-services.js","sourceRoot":"","sources":["../../src/process-services.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,MAAM,CAAC,MAAM,eAAe,GAAsC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;IAC/E,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAChC,MAAM,SAAS,GAAG,EAAgB,CAAC;IACnC,MAAM,WAAW,GAAG,EAAqB,CAAC;IAE1C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IAED,oDAAoD;IACpD,gCAAgC;IAChC,KAAK,MAAM,OAAO,IAAI,IAAuB,EAAE,CAAC;QAC9C,oDAAoD;QACpD,iDAAiD;QACjD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC/E,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAE1D,sBAAsB;QACtB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjC,SAAS,CAAC,IAAI,CAAC;YACb,KAAK,EAAE,IAAI,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC,QAAQ,MAAM;YAC3C,KAAK,EAAE;gBACL,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC;aACvD;SACF,CAAC,CAAC;IACL,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AAClD,CAAC,CAAC;AAEF,eAAe,eAAe,CAAC"}
+{"version":3,"file":"process-services.js","sourceRoot":"","sources":["../../src/process-services.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,MAAM,CAAC,MAAM,eAAe,GAAsC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;IAC/E,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAChC,MAAM,SAAS,GAAG,EAAgB,CAAC;IACnC,MAAM,WAAW,GAAG,EAAqB,CAAC;IAE1C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IAED,oDAAoD;IACpD,gCAAgC;IAChC,KAAK,MAAM,OAAO,IAAI,IAAuB,EAAE,CAAC;QAC9C,oDAAoD;QACpD,iDAAiD;QACjD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC/E,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAE1D,sBAAsB;QACtB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjC,SAAS,CAAC,IAAI,CAAC;YACb,KAAK,EAAE,IAAI,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC,QAAQ,MAAM;YAC3C,KAAK,EAAE;gBACL,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC;aACvD;SACF,CAAC,CAAC;IACL,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AAClD,CAAC,CAAC;AAEF,eAAe,eAAe,CAAC"}

package/dist/esm/version.js

@@ -1,3 +1,3 @@
 // Generated by genversion.
-export const version = '1.1.31';
+export const version = '2.0.0';
 //# sourceMappingURL=version.js.map

package/dist/esm/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC"}