@gravitee/gamma-modules-sdk 1.0.0-alpha.1-feat-routing.ffa9e43 → 1.0.0-alpha.10

package/README.md

@@ -27,12 +27,13 @@ In GitHub, set the **default branch** to `alpha` while you are in this phase so
 
 ## Architecture
 
-The SDK publishes two entry points:
+The SDK publishes three entry points:
 
 | Entry point                         | Contents                     | Used by                   |
 | ----------------------------------- | ---------------------------- | ------------------------- |
 | `@gravitee/gamma-modules-sdk`       | Types + runtime stubs        | Remotes (and host barrel) |
 | `@gravitee/gamma-modules-sdk/types` | Interfaces only (no runtime) | Host implementation       |
+| `@gravitee/gamma-modules-sdk/mock`  | OpenAPI mock middleware      | Module dev servers        |
 
 Remote modules compile and bundle against the stubs. At runtime, the host provides its real implementation as a Module Federation singleton (`additionalShared`), replacing the stubs transparently.
 
@@ -88,6 +89,55 @@ resolve: {
 
 ## Exports
 
+### Mock middleware (`/mock`)
+
+OpenAPI-based mock middleware for standalone dev mode. Reads OpenAPI specs and serves mock responses from fixture files, so modules can run without a backend.
+
+```typescript
+import { createOpenApiMockMiddleware } from '@gravitee/gamma-modules-sdk/mock';
+
+// In rsbuild.config.ts setupMiddlewares:
+createOpenApiMockMiddleware({
+  moduleId: 'aim',
+  specs: [join(__dirname, 'src/main/resources/openapi/openapi-catalog.yaml')],
+  fixturesDir: join(__dirname, 'src/main/resources/catalog-fixtures'),
+});
+```
+
+Handles GET list (pagination, `?q=` search), GET by ID, sub-resource filtering, POST, PUT, DELETE, and the `/gamma/ui/bootstrap` endpoint.
+
+Fixture files are named after the last path segment in the spec (e.g. `models.json`, `mcp-servers.json`).
+
+#### Setting up standalone dev mode for a new module
+
+1. Add `public/constants.json` with `{ "gammaBaseURL": "/gamma" }`
+2. Write your OpenAPI spec (or copy from an existing module)
+3. Add fixture JSON files matching your spec paths (e.g. `models.json` for `/catalog/models`)
+4. In `rsbuild.config.ts`:
+
+```typescript
+import { createOpenApiMockMiddleware } from '@gravitee/gamma-modules-sdk/mock';
+
+export default defineConfig(() => ({
+  dev: {
+    setupMiddlewares: [
+      (middlewares) => {
+        middlewares.unshift(
+          createOpenApiMockMiddleware({
+            moduleId: 'your-module',
+            specs: [join(__dirname, 'path/to/openapi.yaml')],
+            fixturesDir: join(__dirname, 'path/to/fixtures'),
+          }),
+        );
+        return middlewares;
+      },
+    ],
+  },
+}));
+```
+
+5. Run `yarn serve` and open http://localhost:3002
+
 ### Permissions domain
 
 **Types**: `PermissionScope`, `PermissionCheck`, `UserRole`, `PermissionGateProps`, `UseHasPermissionOptions`

package/dist/mock.d.ts

@@ -0,0 +1,28 @@
+import { IncomingMessage, ServerResponse } from 'http';
+export interface OpenApiMockOptions {
+    /** Gamma module identifier (e.g. "aim"). */
+    moduleId: string;
+    /** Paths to OpenAPI spec files (YAML or JSON). */
+    specs: string[];
+    /** Optional directory with fixture JSON files named after the last path segment (e.g. models.json). */
+    fixturesDir?: string;
+    orgId?: string;
+    envId?: string;
+}
+/**
+ * Creates a Connect-compatible middleware that reads OpenAPI specs and serves
+ * mock responses for all declared paths. Fixtures override spec examples.
+ *
+ * Usage in rsbuild.config.ts:
+ * ```ts
+ * import { createOpenApiMockMiddleware } from '@gravitee/gamma-modules-sdk/mock';
+ *
+ * setupMiddlewares: [(mw) => mw.unshift(createOpenApiMockMiddleware({
+ *     moduleId: 'aim',
+ *     specs: [join(__dirname, 'src/main/resources/openapi/openapi-catalog.yaml')],
+ *     fixturesDir: join(__dirname, 'src/main/resources/catalog-fixtures'),
+ * }))]
+ * ```
+ */
+export declare function createOpenApiMockMiddleware(options: OpenApiMockOptions): (req: IncomingMessage, res: ServerResponse, next: () => void) => void;
+//# sourceMappingURL=mock.d.ts.map

package/dist/mock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock.d.ts","sourceRoot":"","sources":["../src/mock.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAM5D,MAAM,WAAW,kBAAkB;IACjC,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,kDAAkD;IAClD,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,uGAAuG;IACvG,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,kBAAkB,IAM7D,KAAK,eAAe,EAAE,KAAK,cAAc,EAAE,MAAM,MAAM,IAAI,UAkFpE"}