@equinor/fusion-framework-cli-plugin-mock-server 0.1.0 → 0.1.1

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.1.0";
+export declare const version = "0.1.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-cli-plugin-mock-server",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Fusion Framework CLI plugin adding `ffc mock-server`, serving @equinor/fusion-openapi-mock fakes over HTTP",
   "main": "dist/esm/index.js",
   "type": "module",
@@ -27,6 +27,9 @@
   ],
   "author": "",
   "license": "ISC",
+  "files": [
+    "dist"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -37,9 +40,9 @@
   },
   "dependencies": {
     "commander": "^15.0.0",
-    "@equinor/fusion-framework-dev-server": "^2.1.0",
-    "@equinor/fusion-imports": "^2.0.3",
-    "@equinor/fusion-openapi-mock-server": "^0.1.0"
+    "@equinor/fusion-framework-dev-server": "^2.1.1",
+    "@equinor/fusion-imports": "^2.0.4",
+    "@equinor/fusion-openapi-mock-server": "^0.1.1"
   },
   "devDependencies": {
     "typescript": "^7.0.2",

package/CHANGELOG.md

@@ -1,37 +0,0 @@
-# @equinor/fusion-framework-cli-plugin-mock-server
-
-## 0.1.0
-
-### Minor Changes
-
-- f663b46: Add a CLI plugin for running the standalone OpenAPI mock server through `ffc mock-server`.
-  
-  The command layers bundled presets and local executable mock modules, reads `mockServer` defaults
-  from `dev-server.config.ts`, and accepts command-line host, port, and seed overrides. The standalone
-  server resolves only predefined and local mocks; it never fetches remote service discovery.
-  
-  Installing the plugin augments `DevServerOptions` with typed `mockServer` settings for the module
-  directory, host, port, and deterministic seed without coupling the base dev-server package to the
-  optional plugin.
-  
-  ```ts
-  // fusion-cli.config.ts
-  import { defineFusionCli } from '@equinor/fusion-framework-cli';
-  import mockServerPlugin from '@equinor/fusion-framework-cli-plugin-mock-server';
-  
-  export default defineFusionCli(() => ({
-    plugins: [mockServerPlugin()],
-  }));
-  ```
-  
-  ```sh
-  ffc mock-server ./mocks --port 4010
-  ```
-
-### Patch Changes
-
-- Updated dependencies [f663b46]
-- Updated dependencies [f663b46]
-- Updated dependencies [f663b46]
-  - @equinor/fusion-framework-dev-server@2.1.0
-  - @equinor/fusion-openapi-mock-server@0.1.0

package/src/__tests__/create-mock-server-command.test.ts

@@ -1,113 +0,0 @@
-import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-
-const mocks = vi.hoisted(() => ({
-  close: vi.fn().mockResolvedValue(undefined),
-  createMockServer: vi.fn(),
-  discoverServices: vi.fn(),
-  loadMockServerConfig: vi.fn(),
-  start: vi.fn(),
-  use: vi.fn(),
-}));
-
-vi.mock('@equinor/fusion-openapi-mock-server', () => ({
-  createMockServer: mocks.createMockServer,
-}));
-
-vi.mock('@equinor/fusion-openapi-mock-server/discovery', () => ({
-  discoverServices: mocks.discoverServices,
-}));
-
-vi.mock('../load-mock-server-config.js', () => ({
-  loadMockServerConfig: mocks.loadMockServerConfig,
-}));
-
-import { createMockServerCommand } from '../create-mock-server-command.js';
-
-describe('createMockServerCommand', () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-    vi.spyOn(process, 'on').mockReturnValue(process);
-    mocks.createMockServer.mockReturnValue({
-      close: mocks.close,
-      start: mocks.start,
-      use: mocks.use,
-    });
-    mocks.discoverServices.mockResolvedValue([]);
-    mocks.start.mockResolvedValue({ url: 'http://localhost:4010' });
-  });
-
-  afterEach(() => {
-    vi.restoreAllMocks();
-  });
-
-  it('uses project config before plugin defaults', async () => {
-    mocks.loadMockServerConfig.mockResolvedValue({
-      path: 'config-mocks',
-      port: 4010,
-      host: '127.0.0.1',
-      seed: 42,
-    });
-
-    const command = createMockServerCommand({
-      path: 'plugin-mocks',
-      port: 4020,
-      host: 'localhost',
-      seed: 7,
-    });
-    await command.parseAsync(['node', 'test']);
-
-    expect(mocks.discoverServices).toHaveBeenCalledWith('config-mocks');
-    expect(mocks.createMockServer).toHaveBeenCalledWith({ seed: 42 });
-    expect(mocks.start).toHaveBeenCalledWith({ port: 4010, host: '127.0.0.1' });
-  });
-
-  it('uses explicit arguments and flags before project config', async () => {
-    mocks.loadMockServerConfig.mockResolvedValue({
-      path: 'config-mocks',
-      port: 4010,
-      host: '127.0.0.1',
-      seed: 42,
-    });
-
-    const command = createMockServerCommand();
-    await command.parseAsync([
-      'node',
-      'test',
-      'cli-mocks',
-      '--port=5000',
-      '--host=0.0.0.0',
-      '--seed=99',
-    ]);
-
-    expect(mocks.discoverServices).toHaveBeenCalledWith('cli-mocks');
-    expect(mocks.createMockServer).toHaveBeenCalledWith({ seed: 99 });
-    expect(mocks.start).toHaveBeenCalledWith({ port: 5000, host: '0.0.0.0' });
-  });
-
-  it('uses plugin defaults before built-in conventions', async () => {
-    mocks.loadMockServerConfig.mockResolvedValue({});
-
-    const command = createMockServerCommand({
-      path: 'plugin-mocks',
-      port: 4020,
-      host: '127.0.0.1',
-      seed: 7,
-    });
-    await command.parseAsync(['node', 'test']);
-
-    expect(mocks.discoverServices).toHaveBeenCalledWith('plugin-mocks');
-    expect(mocks.createMockServer).toHaveBeenCalledWith({ seed: 7 });
-    expect(mocks.start).toHaveBeenCalledWith({ port: 4020, host: '127.0.0.1' });
-  });
-
-  it('uses built-in conventions when no other values are provided', async () => {
-    mocks.loadMockServerConfig.mockResolvedValue({});
-
-    const command = createMockServerCommand();
-    await command.parseAsync(['node', 'test']);
-
-    expect(mocks.discoverServices).toHaveBeenCalledWith('mocks');
-    expect(mocks.createMockServer).toHaveBeenCalledWith({ seed: undefined });
-    expect(mocks.start).toHaveBeenCalledWith({ port: 4010, host: 'localhost' });
-  });
-});

package/src/__tests__/index.test.ts

@@ -1,88 +0,0 @@
-import { Command } from 'commander';
-import { describe, expect, it } from 'vitest';
-
-import type { DevServerOptions } from '@equinor/fusion-framework-dev-server';
-
-import mockServerPlugin from '../index.js';
-
-describe('mockServerPlugin', () => {
-  it('augments DevServerOptions with mock-server configuration', () => {
-    const config: DevServerOptions = {
-      api: { serviceDiscoveryUrl: 'https://discovery.example.com' },
-      mockServer: { path: 'api-mocks', port: 4010, seed: 42 },
-    };
-
-    expect(config.mockServer).toEqual({ path: 'api-mocks', port: 4010, seed: 42 });
-  });
-
-  it('registers a top-level "mock-server" command', () => {
-    const program = new Command();
-
-    mockServerPlugin()(program);
-
-    // every registered command's name, to check "mock-server" is among them
-    expect(program.commands.map((command) => command.name())).toContain('mock-server');
-  });
-
-  it('applies every --preset before any positional directory', () => {
-    const program = new Command();
-    mockServerPlugin()(program);
-    // locate the command this plugin registered, by name
-    const mockServerCommand = program.commands.find((command) => command.name() === 'mock-server');
-
-    // parse() invokes the command's action; capture what it would pass to createMockServer via the parsed options
-    const parsed = mockServerCommand?.parseOptions([
-      '--preset=fusion',
-      '--preset=extra',
-      './mocks',
-      './overrides',
-    ]);
-
-    expect(parsed?.operands).toEqual(['./mocks', './overrides']);
-    expect(mockServerCommand?.opts().preset).toEqual(['fusion', 'extra']);
-  });
-
-  it('defaults to the "fusion" preset when --preset is omitted', () => {
-    const program = new Command();
-    mockServerPlugin()(program);
-    // locate the command this plugin registered, by name
-    const mockServerCommand = program.commands.find((command) => command.name() === 'mock-server');
-
-    mockServerCommand?.parseOptions(['./mocks']);
-
-    expect(mockServerCommand?.opts().preset).toEqual(['fusion']);
-  });
-
-  it('replaces the default preset instead of appending to it, on the first explicit --preset', () => {
-    const program = new Command();
-    mockServerPlugin()(program);
-    // locate the command this plugin registered, by name
-    const mockServerCommand = program.commands.find((command) => command.name() === 'mock-server');
-
-    mockServerCommand?.parseOptions(['--preset=other', './mocks']);
-
-    expect(mockServerCommand?.opts().preset).toEqual(['other']);
-  });
-
-  it('applies caller-provided preset defaults during option parsing', () => {
-    const program = new Command();
-    mockServerPlugin({ preset: ['other'], port: 4010, host: '0.0.0.0' })(program);
-    // locate the command this plugin registered, by name
-    const mockServerCommand = program.commands.find((command) => command.name() === 'mock-server');
-
-    mockServerCommand?.parseOptions([]);
-
-    expect(mockServerCommand?.opts()).toEqual({ preset: ['other'] });
-  });
-
-  it('lets an explicit flag override a caller-provided default', () => {
-    const program = new Command();
-    mockServerPlugin({ preset: ['other'], port: 4010 })(program);
-    // locate the command this plugin registered, by name
-    const mockServerCommand = program.commands.find((command) => command.name() === 'mock-server');
-
-    mockServerCommand?.parseOptions(['--port=5000']);
-
-    expect(mockServerCommand?.opts().port).toBe(5000);
-  });
-});

package/src/create-mock-server-command.ts

@@ -1,126 +0,0 @@
-import { createCommand, createOption, type Command } from 'commander';
-
-import { createMockServer } from '@equinor/fusion-openapi-mock-server';
-import { discoverServices } from '@equinor/fusion-openapi-mock-server/discovery';
-
-import { loadMockServerConfig } from './load-mock-server-config.js';
-
-/** Option values for `ffc mock-server`. */
-interface MockServerCommandOptions {
-  /** Bundled preset names to layer in, lowest precedence first (e.g. `['fusion']`). */
-  preset: string[];
-  /** Port to listen on; `undefined` lets the OS assign a free one. */
-  port?: number;
-  /** Hostname to bind to. */
-  host?: string;
-  /** Seeds every service's faked responses, if given. */
-  seed?: number;
-}
-
-/** Overrides for `ffc mock-server`'s own built-in defaults, set by whoever registers the plugin. */
-export interface MockServerCommandDefaults {
-  /** Mock-module directory used when no positional directory or config path is supplied. */
-  path?: string;
-  /** Bundled preset(s) to apply when `--preset` isn't given at all. Defaults to `['fusion']`. */
-  preset?: string[];
-  /** Port to listen on when `--port` isn't given. Defaults to `4010`. */
-  port?: number;
-  /** Hostname to bind to when `--host` isn't given. Defaults to `'localhost'`. */
-  host?: string;
-  /** Seed to apply when `--seed` isn't given. Defaults to unseeded (random) faked responses. */
-  seed?: number;
-}
-
-/**
- * Builds the `ffc mock-server` command definition.
- *
- * Serves every service discovered from one or more directories of `<name>.mock.ts`
- * modules (plus any bundled presets) over HTTP, using
- * `@equinor/fusion-openapi-mock-server`'s `createMockServer`. Presets and
- * directories are both layered in ascending precedence — a later `--preset`
- * or directory replaces an earlier one's services by key — with every
- * `--preset` applied before every positional directory, regardless of their
- * order on the command line.
- *
- * Defaults to the bundled `fusion` preset when `--preset` isn't given at
- * all — a Fusion app's default framework modules resolve several
- * service-discovery keys eagerly at startup and fail hard without them. The
- * first explicit `--preset` fully replaces that default rather than
- * appending to it; repeat the flag (`--preset=fusion --preset=other`) to
- * combine it with something else. Pass {@link defaults} to change any of
- * these built-in defaults (e.g. a fixed port for a specific app).
- *
- * Keeps the server running in the foreground until `SIGINT`/`SIGTERM`, so it
- * dies with whatever started it (e.g. Playwright's `webServer`) rather than
- * lingering as an orphaned process.
- *
- * @param defaults - Overrides for the command's own built-in path, preset, port, host, and seed defaults.
- * @returns A fresh `Command` instance — a factory rather than a shared singleton, since
- * Commander stores parsed option values on the `Command` instance itself.
- *
- * @example
- * ```sh
- * ffc mock-server ./mocks --port 4010
- * ```
- */
-export function createMockServerCommand(defaults: MockServerCommandDefaults = {}): Command {
-  // sentinel default for --preset, so the first explicit flag replaces it instead of appending to it
-  const defaultPresets: string[] = defaults.preset ?? ['fusion'];
-
-  return createCommand('mock-server')
-    .description('Serve OpenAPI-fake responses over HTTP, from bundled presets and/or mock modules')
-    .argument('[dirs...]', 'directories of <name>.mock.ts modules, in ascending precedence')
-    .addOption(
-      createOption(
-        '--preset <name>',
-        `bundled preset to layer in, in ascending precedence (repeatable; defaults to ${JSON.stringify(defaultPresets)}, replaced by the first explicit flag)`,
-      )
-        .default(defaultPresets)
-        .argParser((value: string, previous: string[]) =>
-          previous === defaultPresets ? [value] : [...previous, value],
-        ),
-    )
-    .addOption(
-      createOption(
-        '--port <port>',
-        `port to listen on (default: config or ${defaults.port ?? 4010})`,
-      ).argParser(Number),
-    )
-    .addOption(createOption('--host <host>', 'hostname to bind to (default: config or localhost)'))
-    .addOption(
-      createOption(
-        '--seed <seed>',
-        `seeds every service's faked responses, for reproducible output (default: ${defaults.seed ?? 'unseeded/random'})`,
-      ).argParser(Number),
-    )
-    .action(async (dirs: string[], options: MockServerCommandOptions) => {
-      const config = await loadMockServerConfig(process.cwd());
-      const sourceDirs = dirs.length ? dirs : [config.path ?? defaults.path ?? 'mocks'];
-      const definitionGroups = await Promise.all(
-        sourceDirs
-          // Resolve every configured layer before startup so discovery requirements are known.
-          .map((dir) => discoverServices(dir)),
-      );
-      const server = createMockServer({
-        seed: options.seed ?? config.seed ?? defaults.seed,
-      });
-      // presets always apply before directories, regardless of flag position on the command line
-      for (const preset of options.preset) server.use(preset);
-      // Resolved directory groups are the highest-precedence layers, applied after every preset.
-      for (const definitions of definitionGroups) server.use(definitions);
-
-      const { url } = await server.start({
-        port: options.port ?? config.port ?? defaults.port ?? 4010,
-        host: options.host ?? config.host ?? defaults.host ?? 'localhost',
-      });
-      console.log(`mock server listening at ${url}`);
-
-      const shutdown = (): void => {
-        void server.close().finally(() => process.exit(0));
-      };
-      process.on('SIGINT', shutdown);
-      process.on('SIGTERM', shutdown);
-    });
-}
-
-export default createMockServerCommand;

package/src/dev-server-options.ts

@@ -1,26 +0,0 @@
-import type { DevServerOptions, FusionTemplateEnv } from '@equinor/fusion-framework-dev-server';
-
-/** Standalone OpenAPI mock-server settings added to development server configuration. */
-export interface DevServerMockOptions {
-  /** Directory containing `<name>.mock.ts` modules, relative to the project root. Defaults to `mocks`. */
-  path?: string;
-  /** Port used by direct `<key>.localhost` endpoint URLs. */
-  port?: number;
-  /** Hostname the standalone mock server binds to. Defaults to `localhost`. */
-  host?: string;
-  /** Seed used for reproducible generated OpenAPI responses. */
-  seed?: number;
-}
-
-declare module '@equinor/fusion-framework-dev-server' {
-  /** Development server options contributed when the mock-server CLI plugin is installed. */
-  interface DevServerOptions<TEnv extends Partial<FusionTemplateEnv> = Partial<FusionTemplateEnv>> {
-    /** Settings consumed by local mock discovery and the standalone `ffc mock-server` process. */
-    mockServer?: DevServerMockOptions;
-  }
-}
-
-/** Compile-time assertion that the module augmentation is compatible with the base options. */
-export type MockServerDevServerOptions = DevServerOptions & {
-  mockServer?: DevServerMockOptions;
-};

package/src/index.ts

@@ -1,36 +0,0 @@
-import type { Command } from 'commander';
-
-import {
-  createMockServerCommand,
-  type MockServerCommandDefaults,
-} from './create-mock-server-command.js';
-
-export type { MockServerCommandDefaults };
-export type {
-  DevServerMockOptions,
-  MockServerDevServerOptions,
-} from './dev-server-options.js';
-
-/**
- * Creates the `ffc mock-server` CLI plugin, for a `fusion-cli.config.ts`'s `plugins` array.
- *
- * @param defaults - Overrides for the command's own built-in `--preset`/`--port`/`--host` defaults.
- * @returns A plugin function that registers the `mock-server` command on the CLI program.
- *
- * @example
- * ```ts
- * import { defineFusionCli } from '@equinor/fusion-framework-cli';
- * import mockServerPlugin from '@equinor/fusion-framework-cli-plugin-mock-server';
- *
- * export default defineFusionCli(() => ({
- *   plugins: [mockServerPlugin({ preset: ['fusion'], port: 4010 })],
- * }));
- * ```
- */
-export function mockServerPlugin(defaults?: MockServerCommandDefaults): (program: Command) => void {
-  return (program: Command): void => {
-    program.addCommand(createMockServerCommand(defaults));
-  };
-}
-
-export default mockServerPlugin;

package/src/load-mock-server-config.ts

@@ -1,75 +0,0 @@
-import { FileNotFoundError, importConfig, type EsmModule } from '@equinor/fusion-imports';
-
-import type { DevServerOptions } from '@equinor/fusion-framework-dev-server';
-
-import type { DevServerMockOptions } from './dev-server-options.js';
-
-/** Mock-server settings resolved from `dev-server.config.ts`. */
-export interface ResolvedMockServerConfig extends DevServerMockOptions {}
-
-interface DevServerConfigOverrides {
-  mockServer?: DevServerMockOptions;
-}
-
-interface DevServerConfigModule extends EsmModule {
-  default?:
-    | DevServerConfigOverrides
-    | ((
-        env: { command: 'serve'; environment: 'local'; mode: string; root: string },
-        args: { base: DevServerOptions },
-      ) => DevServerConfigOverrides | Promise<DevServerConfigOverrides | undefined> | undefined);
-}
-
-/**
- * Loads standalone mock-server settings from a project's `dev-server.config.ts`.
- *
- * @param root - Project root used to resolve the config file and relative mock path.
- * @returns Mock-server settings explicitly resolved from the project config.
- * @throws {Error} When an existing config cannot be imported or returns an invalid value.
- */
-export async function loadMockServerConfig(root: string): Promise<ResolvedMockServerConfig> {
-  const base: DevServerOptions = {
-    mockServer: { path: 'mocks' },
-    api: { serviceDiscoveryUrl: '' },
-  };
-
-  try {
-    const { config } = await importConfig<DevServerConfigOverrides, DevServerConfigModule>(
-      'dev-server.config',
-      {
-        baseDir: root,
-        script: {
-          // Config factories receive the same runtime shape as ordinary development serving.
-          resolve: async (module) => {
-            const exported = module.default;
-            // Factory configs may derive settings from the supplied base configuration.
-            if (typeof exported === 'function') {
-              return (
-                (await exported(
-                  { command: 'serve', environment: 'local', mode: 'development', root },
-                  { base },
-                )) ?? {}
-              );
-            }
-            return exported ?? {};
-          },
-        },
-      },
-    );
-
-    return {
-      path: config.mockServer?.path ?? base.mockServer?.path,
-      port: config.mockServer?.port,
-      host: config.mockServer?.host,
-      seed: config.mockServer?.seed,
-    };
-  } catch (error) {
-    // An absent config is a supported convention-only setup; import and evaluation failures are not.
-    if (error instanceof FileNotFoundError) {
-      return {};
-    }
-    throw error;
-  }
-}
-
-export default loadMockServerConfig;

package/src/version.ts

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

package/tsconfig.json

@@ -1,26 +0,0 @@
-{
-  "extends": "../../../tsconfig.base.json",
-  "compilerOptions": {
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "outDir": "dist/esm",
-    "rootDir": "src",
-    "declarationDir": "./dist/types",
-    "paths": {
-      "*": ["./*"]
-    }
-  },
-  "references": [
-    {
-      "path": "../../dev-server"
-    },
-    {
-      "path": "../../utils/imports"
-    },
-    {
-      "path": "../../utils/openapi-mock-server"
-    }
-  ],
-  "include": ["src/**/*"],
-  "exclude": ["node_modules"]
-}

package/vitest.config.ts

@@ -1,9 +0,0 @@
-import { defineConfig } from 'vitest/config';
-
-export default defineConfig({
-  test: {
-    globals: true,
-    environment: 'node',
-    include: ['src/**/*.test.ts'],
-  },
-});