@zenera/faker 1.1.20 → 1.1.22

package/dist/spec.js

@@ -3,6 +3,11 @@ import { CliError, EXIT } from '@zenera/cli/lib';
 import { createHash } from 'node:crypto';
 import { pagingOf } from "./paging.js";
 import { normalize } from "./schema.js";
+/**
+ * Version of generator prompt rules and environment contracts.
+ * Bumping this invalidates cached Python generators and triggers regeneration.
+ */
+export const GENERATOR_RULES_VERSION = 2;
 // ---------------------------------------------------------------------------
 // Documents, flattened
 //
@@ -57,13 +62,14 @@ export async function loadSpec(file) {
             if (!isObject(op)) {
                 continue;
             }
-            const path = join(prefix, template);
-            const merged = override(shared, params(op.parameters, dialect));
+            const { path, fixed } = splitQuery(join(prefix, template));
+            const merged = override(override(shared, params(op.parameters, dialect)), pinned(fixed));
             out.push(build({
                 source: file,
                 dialect,
                 method,
                 path,
+                fixed,
                 op,
                 params: merged,
                 body: requestBody(op, dialect),
@@ -88,11 +94,42 @@ function join(prefix, template) {
     const base = prefix.replace(/\/+$/, '');
     return `${base}${template.startsWith('/') ? '' : '/'}${template}` || '/';
 }
+/** The path as it has to be called — what a person needs to see. */
+export const called = (op) => op.fixed ? `${op.path}?${new URLSearchParams(op.fixed).toString()}` : op.path;
+/**
+ * A path template has no query string, but VMware, Oracle and others write one
+ * anyway — `/x/{id}?action=retry` — because they need two `post`s under one
+ * path and the object model gives them one. Taken verbatim the key matches
+ * nothing, since a request path never contains a `?`. So it is read for what
+ * it means: the path is the part before the `?`, and each pair after it is a
+ * query value this operation insists on.
+ */
+function splitQuery(template) {
+    const cut = template.indexOf('?');
+    if (cut < 0) {
+        return { path: template };
+    }
+    const fixed = {};
+    for (const [name, value] of new URLSearchParams(template.slice(cut + 1))) {
+        fixed[name] = value;
+    }
+    const path = template.slice(0, cut) || '/';
+    return Object.keys(fixed).length > 0 ? { path, fixed } : { path };
+}
+/** A one-value enum, so the check, the page and the generator all see the rule. */
+function pinned(fixed) {
+    return Object.entries(fixed ?? {}).map(([name, value]) => ({
+        name,
+        in: 'query',
+        required: true,
+        schema: { type: 'string', enum: [value] },
+    }));
+}
 function build(b) {
     const success = successOf(b.op, b.dialect);
     const operationId = typeof b.op.operationId === 'string' && b.op.operationId
         ? b.op.operationId
-        : synthesizeId(b.method, b.path);
+        : synthesizeId(b.method, b.path, b.fixed);
     const operation = {
         key: '',
         source: b.source,
@@ -102,9 +139,10 @@ function build(b) {
         summary: typeof b.op.summary === 'string' ? b.op.summary : undefined,
         description: typeof b.op.description === 'string' ? b.op.description : undefined,
         params: b.params,
+        fixed: b.fixed,
         requestBody: b.body,
         success,
-        paging: pagingOf(b.params, success.schema),
+        paging: pagingOf(b.params, success.schema, b.body?.schema),
     };
     return { ...operation, key: keyOf(operation) };
 }
@@ -117,6 +155,7 @@ function build(b) {
  */
 function keyOf(op) {
     const shape = {
+        version: GENERATOR_RULES_VERSION,
         method: op.method,
         path: op.path,
         operationId: op.operationId,
@@ -146,9 +185,8 @@ function canonical(value) {
     }
     return value;
 }
-function synthesizeId(method, path) {
-    const words = path
-        .split('/')
+function synthesizeId(method, path, fixed) {
+    const words = [...path.split('/'), ...Object.values(fixed ?? {})]
         .filter(Boolean)
         .map((s) => s.replace(/[{}]/g, '').replace(/[^A-Za-z0-9]+/g, '_'));
     return [method, ...words].join('_');

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zenera/faker",
-    "version": "1.1.20",
+    "version": "1.1.22",
     "description": "Mock HTTP server for swagger/OpenAPI documents, with response bodies generated by a model.",
     "keywords": [
         "openapi",
@@ -45,7 +45,7 @@
         "@apidevtools/swagger-parser": "^12.0.0",
         "ajv": "^8.17.1",
         "ajv-formats": "^3.0.1",
-        "@zenera/cli": "^1.1.20",
-        "@zenera/neo": "^1.1.20"
+        "@zenera/cli": "^1.1.22",
+        "@zenera/neo": "^1.1.22"
     }
 }