@open-rlb/nestjs-amqp 2.1.0 → 2.2.0

package/schematics/add-queue/schema.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "SchematicsRlbAmqpAddQueue",
+  "title": "Add a broker queue to config.yaml",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Queue name (the key).",
+      "x-prompt": "Queue name?",
+      "$default": { "$source": "argv", "index": 0 }
+    },
+    "exchange": {
+      "type": "string",
+      "default": "rlb",
+      "description": "Exchange the queue binds to."
+    },
+    "routingKey": {
+      "type": "string",
+      "description": "routingKey (required — defaulted to the queue name — when the exchange is a topic)."
+    },
+    "createIfNotExists": {
+      "type": "boolean",
+      "default": true,
+      "description": "Emit createQueueIfNotExists (false => the queue must pre-exist)."
+    },
+    "durable": { "type": "boolean", "default": true, "description": "options.durable" },
+    "exclusive": { "type": "boolean", "default": false, "description": "options.exclusive" },
+    "autoDelete": { "type": "boolean", "default": false, "description": "options.autoDelete" },
+    "messageTtl": { "type": "number", "description": "options.messageTtl (ms)." },
+    "maxLength": { "type": "number", "description": "options.maxLength." },
+    "expires": { "type": "number", "description": "options.expires (ms) — unused-queue TTL." },
+    "createExchange": {
+      "type": "boolean",
+      "description": "Create the exchange when it is missing (default: false interactive, true when passed)."
+    },
+    "exchangeType": {
+      "type": "string",
+      "enum": ["direct", "topic", "fanout", "headers"],
+      "default": "direct",
+      "description": "Type of the exchange created via createExchange."
+    },
+    "overwrite": {
+      "type": "boolean",
+      "default": false,
+      "description": "Update the entry if it already exists (default: leave it untouched)."
+    },
+    "config": {
+      "type": "string",
+      "description": "Path to config.yaml (default: auto-detected)."
+    }
+  },
+  "required": []
+}

package/schematics/add-queue/schema.ts

@@ -0,0 +1,32 @@
+import { ExchangeType } from '../utils/broker-yaml.util';
+
+export interface AddQueueOptions {
+  /** Queue name (the key). Prompted when omitted. */
+  name?: string;
+  /** Exchange the queue binds to. Default: 'rlb'. */
+  exchange?: string;
+  /** routingKey (required — and defaulted to the queue name — when the exchange is a topic). */
+  routingKey?: string;
+  /** Emit `createQueueIfNotExists`. Default: true. */
+  createIfNotExists?: boolean;
+  /** options.durable. Default: true. */
+  durable?: boolean;
+  /** options.exclusive. Default: false. */
+  exclusive?: boolean;
+  /** options.autoDelete. Default: false. */
+  autoDelete?: boolean;
+  /** options.messageTtl (ms) — growth bound. */
+  messageTtl?: number;
+  /** options.maxLength — growth bound. */
+  maxLength?: number;
+  /** options.expires (ms) — unused-queue TTL. */
+  expires?: number;
+  /** Create the exchange when it is missing (default: prompt→false, or true when the flag is passed). */
+  createExchange?: boolean;
+  /** Type of the exchange created via createExchange. Default: 'direct'. */
+  exchangeType?: ExchangeType;
+  /** Update the entry when it already exists (default: leave it untouched). */
+  overwrite?: boolean;
+  /** Path to config.yaml (default: auto-detected, typically config/config.yaml). */
+  config?: string;
+}

package/schematics/add-reply-queue/index.d.ts

@@ -0,0 +1,3 @@
+import { Rule } from '@angular-devkit/schematics';
+import { AddReplyQueueOptions } from './schema';
+export declare function main(options: AddReplyQueueOptions): Rule;

package/schematics/add-reply-queue/index.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = main;
+const schematic_prompt_util_1 = require("../utils/schematic-prompt.util");
+const yaml_config_util_1 = require("../utils/yaml-config.util");
+function main(options) {
+    return async (tree, context) => {
+        const flagsProvided = options.exchange !== undefined;
+        const prompts = (0, schematic_prompt_util_1.loadPrompts)(context, flagsProvided);
+        const exchange = options.exchange || (await (0, schematic_prompt_util_1.askText)(prompts, 'Exchange?', ''));
+        const queue = options.queue || (await (0, schematic_prompt_util_1.askText)(prompts, 'Reply queue name?', ''));
+        if (!exchange || !queue) {
+            context.logger.error('[rlb-amqp] add-reply-queue: both exchange and queue are required.');
+            return tree;
+        }
+        const configPath = (0, yaml_config_util_1.findConfigYaml)(tree, options.config);
+        const { doc, existed } = (0, yaml_config_util_1.readConfigDoc)(tree, configPath);
+        if (!existed)
+            context.logger.info(`[rlb-amqp] ${configPath} not found — creating it.`);
+        const outcome = (0, yaml_config_util_1.setIn)(doc, ['broker', 'replyQueues', exchange], queue);
+        (0, schematic_prompt_util_1.logOutcome)(context, `reply queue for '${exchange}'`, outcome);
+        (0, yaml_config_util_1.writeConfigDoc)(tree, configPath, doc);
+        return tree;
+    };
+}
+//# sourceMappingURL=index.js.map

package/schematics/add-reply-queue/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../libs/rlb-nestjs-amqp/src/schematics/add-reply-queue/index.ts"],"names":[],"mappings":";;AAUA,oBAsBC;AA/BD,0EAAkF;AAClF,gEAAiG;AAQjG,SAAgB,IAAI,CAAC,OAA6B;IAChD,OAAO,KAAK,EAAE,IAAU,EAAE,OAAyB,EAAE,EAAE;QACrD,MAAM,aAAa,GAAG,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC;QACrD,MAAM,OAAO,GAAG,IAAA,mCAAW,EAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAEpD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,CAAC,MAAM,IAAA,+BAAO,EAAC,OAAO,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;QAC/E,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,IAAA,+BAAO,EAAC,OAAO,EAAE,mBAAmB,EAAE,EAAE,CAAC,CAAC,CAAC;QACjF,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,EAAE,CAAC;YACxB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,mEAAmE,CAAC,CAAC;YAC1F,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,UAAU,GAAG,IAAA,iCAAc,EAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACxD,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAA,gCAAa,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACzD,IAAI,CAAC,OAAO;YAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,UAAU,2BAA2B,CAAC,CAAC;QAEvF,MAAM,OAAO,GAAG,IAAA,wBAAK,EAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;QACvE,IAAA,kCAAU,EAAC,OAAO,EAAE,oBAAoB,QAAQ,GAAG,EAAE,OAAO,CAAC,CAAC;QAE9D,IAAA,iCAAc,EAAC,IAAI,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;AACJ,CAAC"}

package/schematics/add-reply-queue/index.spec.ts

@@ -0,0 +1,69 @@
+import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
+import { parseDocument } from 'yaml';
+import { main } from './index';
+import { AddReplyQueueOptions } from './schema';
+
+/**
+ * Invoke the factory Rule directly against a Tree (NOT SchematicTestRunner — it eagerly loads `ora`,
+ * an ESM-only module jest cannot transform here). Passing `exchange` makes `flagsProvided` true, so no
+ * interactive prompt is attempted.
+ */
+const ctx = { logger: { info() {}, warn() {}, error() {} } } as unknown as SchematicContext;
+
+async function run(options: AddReplyQueueOptions, tree: Tree): Promise<Tree> {
+  const rule = main(options) as Rule;
+  const result = await (rule as (t: Tree, c: SchematicContext) => Promise<Tree>)(tree, ctx);
+  return result || tree;
+}
+
+function read(tree: Tree, path = 'config/config.yaml'): string {
+  return tree.read(path)!.toString('utf-8');
+}
+function doc(tree: Tree) {
+  return parseDocument(read(tree));
+}
+function seedConfig(): Tree {
+  const tree = Tree.empty();
+  tree.create(
+    'config/config.yaml',
+    ['# my config', 'broker:', '  exchanges:', '    - name: rlb', '      type: direct', 'topics: []', ''].join('\n'),
+  );
+  return tree;
+}
+
+describe('add-reply-queue schematic', () => {
+  it('sets the exchange → reply queue mapping, preserving comments', async () => {
+    const tree = await run({ exchange: 'rlb', queue: 'rlb-reply' }, seedConfig());
+    expect(String(doc(tree).getIn(['broker', 'replyQueues', 'rlb']))).toBe('rlb-reply');
+    expect(read(tree)).toContain('# my config');
+  });
+
+  it('is idempotent: re-adding the same mapping leaves a single key', async () => {
+    let tree = await run({ exchange: 'rlb', queue: 'rlb-reply' }, seedConfig());
+    tree = await run({ exchange: 'rlb', queue: 'rlb-reply' }, tree);
+    const replyQueues = doc(tree).getIn(['broker', 'replyQueues']) as any;
+    expect(replyQueues.items).toHaveLength(1);
+    expect(String(doc(tree).getIn(['broker', 'replyQueues', 'rlb']))).toBe('rlb-reply');
+  });
+
+  it('updates the queue for an existing exchange key', async () => {
+    let tree = await run({ exchange: 'rlb', queue: 'rlb-reply' }, seedConfig());
+    tree = await run({ exchange: 'rlb', queue: 'rlb-reply-2' }, tree);
+    const replyQueues = doc(tree).getIn(['broker', 'replyQueues']) as any;
+    expect(replyQueues.items).toHaveLength(1);
+    expect(String(doc(tree).getIn(['broker', 'replyQueues', 'rlb']))).toBe('rlb-reply-2');
+  });
+
+  it('supports multiple exchanges in the map', async () => {
+    let tree = await run({ exchange: 'rlb', queue: 'rlb-reply' }, seedConfig());
+    tree = await run({ exchange: 'events', queue: 'events-reply' }, tree);
+    expect(String(doc(tree).getIn(['broker', 'replyQueues', 'rlb']))).toBe('rlb-reply');
+    expect(String(doc(tree).getIn(['broker', 'replyQueues', 'events']))).toBe('events-reply');
+  });
+
+  it('creates config.yaml when it does not exist', async () => {
+    const tree = await run({ exchange: 'rlb', queue: 'rlb-reply' }, Tree.empty());
+    expect(tree.exists('config/config.yaml')).toBe(true);
+    expect(String(doc(tree).getIn(['broker', 'replyQueues', 'rlb']))).toBe('rlb-reply');
+  });
+});

package/schematics/add-reply-queue/index.ts

@@ -0,0 +1,33 @@
+import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
+import { askText, loadPrompts, logOutcome } from '../utils/schematic-prompt.util';
+import { findConfigYaml, readConfigDoc, setIn, writeConfigDoc } from '../utils/yaml-config.util';
+import { AddReplyQueueOptions } from './schema';
+
+/**
+ * `add-reply-queue` — idempotent set of a `broker.replyQueues[exchange] = queue` mapping,
+ * comment-preserving. Unlike exchanges/queues/topics this section is a MAP (exchange → reply queue),
+ * not a seq, so we go straight through the generic setIn helper, which reports created/updated/unchanged.
+ */
+export function main(options: AddReplyQueueOptions): Rule {
+  return async (tree: Tree, context: SchematicContext) => {
+    const flagsProvided = options.exchange !== undefined;
+    const prompts = loadPrompts(context, flagsProvided);
+
+    const exchange = options.exchange || (await askText(prompts, 'Exchange?', ''));
+    const queue = options.queue || (await askText(prompts, 'Reply queue name?', ''));
+    if (!exchange || !queue) {
+      context.logger.error('[rlb-amqp] add-reply-queue: both exchange and queue are required.');
+      return tree;
+    }
+
+    const configPath = findConfigYaml(tree, options.config);
+    const { doc, existed } = readConfigDoc(tree, configPath);
+    if (!existed) context.logger.info(`[rlb-amqp] ${configPath} not found — creating it.`);
+
+    const outcome = setIn(doc, ['broker', 'replyQueues', exchange], queue);
+    logOutcome(context, `reply queue for '${exchange}'`, outcome);
+
+    writeConfigDoc(tree, configPath, doc);
+    return tree;
+  };
+}

package/schematics/add-reply-queue/schema.d.ts

@@ -0,0 +1,6 @@
+export interface AddReplyQueueOptions {
+    exchange?: string;
+    queue?: string;
+    overwrite?: boolean;
+    config?: string;
+}

package/schematics/add-reply-queue/schema.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=schema.js.map

package/schematics/add-reply-queue/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../libs/rlb-nestjs-amqp/src/schematics/add-reply-queue/schema.ts"],"names":[],"mappings":""}

package/schematics/add-reply-queue/schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "SchematicsRlbAmqpAddReplyQueue",
+  "title": "Map an exchange to an RPC reply queue via broker.replyQueues",
+  "type": "object",
+  "properties": {
+    "exchange": {
+      "type": "string",
+      "description": "Exchange whose RPC replies route to `queue` (the map key).",
+      "x-prompt": "Exchange?",
+      "$default": { "$source": "argv", "index": 0 }
+    },
+    "queue": {
+      "type": "string",
+      "description": "The reply queue name (the map value)."
+    },
+    "overwrite": {
+      "type": "boolean",
+      "default": false,
+      "description": "Overwrite an existing mapping for this exchange."
+    },
+    "config": {
+      "type": "string",
+      "description": "Path to config.yaml (default: auto-detected)."
+    }
+  },
+  "required": []
+}

package/schematics/add-reply-queue/schema.ts

@@ -0,0 +1,10 @@
+export interface AddReplyQueueOptions {
+  /** Exchange whose RPC replies route to `queue` (the map key). Prompted when omitted. */
+  exchange?: string;
+  /** The reply queue name (the map value). Prompted when omitted. */
+  queue?: string;
+  /** Overwrite an existing mapping for this exchange (setIn is idempotent regardless). */
+  overwrite?: boolean;
+  /** Path to config.yaml (default: auto-detected, typically config/config.yaml). */
+  config?: string;
+}

package/schematics/add-route/index.d.ts

@@ -0,0 +1,3 @@
+import { Rule } from '@angular-devkit/schematics';
+import { AddRouteOptions } from './schema';
+export declare function main(options: AddRouteOptions): Rule;

package/schematics/add-route/index.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = main;
+const schematic_prompt_util_1 = require("../utils/schematic-prompt.util");
+const yaml_config_util_1 = require("../utils/yaml-config.util");
+const METHODS = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH'];
+const MODES = ['rpc', 'event'];
+function main(options) {
+    return async (tree, context) => {
+        const flagsProvided = options.name !== undefined;
+        const prompts = (0, schematic_prompt_util_1.loadPrompts)(context, flagsProvided);
+        const name = options.name || (await (0, schematic_prompt_util_1.askText)(prompts, 'Route name?', ''));
+        if (!name) {
+            context.logger.error('[rlb-amqp] add-route: a name is required.');
+            return tree;
+        }
+        const method = options.method || (await (0, schematic_prompt_util_1.askSelect)(prompts, 'HTTP method?', METHODS, 'GET'));
+        const path = options.path || (await (0, schematic_prompt_util_1.askText)(prompts, 'URL path?', ''));
+        const topic = options.topic || (await (0, schematic_prompt_util_1.askText)(prompts, 'Topic?', ''));
+        const action = options.action || (await (0, schematic_prompt_util_1.askText)(prompts, 'Action?', ''));
+        const mode = options.mode || (await (0, schematic_prompt_util_1.askSelect)(prompts, 'Mode?', MODES, 'rpc'));
+        const dataSource = options.dataSource || (method === 'GET' ? 'query' : 'body');
+        const configPath = (0, yaml_config_util_1.findConfigYaml)(tree, options.config);
+        const { doc, existed } = (0, yaml_config_util_1.readConfigDoc)(tree, configPath);
+        if (!existed)
+            context.logger.info(`[rlb-amqp] ${configPath} not found — creating it.`);
+        const item = {
+            name,
+            method,
+            path,
+            dataSource,
+            topic,
+            action,
+            mode,
+            timeout: options.timeout,
+            auth: options.auth,
+            allowAnonymous: options.allowAnonymous,
+            actions: options.actions,
+            successStatusCode: options.successStatusCode,
+            binary: options.binary,
+            redirect: options.redirect,
+            parseRaw: options.parseRaw,
+        };
+        const hasActions = options.actions !== undefined && (!Array.isArray(options.actions) || options.actions.length > 0);
+        if (hasActions && !options.auth && !options.allowAnonymous) {
+            context.logger.warn('[rlb-amqp] add-route: actions require auth on the same route (fails closed → every request 403).');
+        }
+        if (options.parseRaw) {
+            context.logger.warn('[rlb-amqp] add-route: parseRaw needs rawBody:true at bootstrap (NestFactory.create({rawBody:true})).');
+        }
+        const outcome = (0, yaml_config_util_1.upsertSeqItemByKey)(doc, ['gateway', 'paths'], 'name', item, { overwrite: options.overwrite });
+        (0, schematic_prompt_util_1.logOutcome)(context, `route '${name}'`, outcome);
+        (0, yaml_config_util_1.writeConfigDoc)(tree, configPath, doc);
+        return tree;
+    };
+}
+//# sourceMappingURL=index.js.map

package/schematics/add-route/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../libs/rlb-nestjs-amqp/src/schematics/add-route/index.ts"],"names":[],"mappings":";;AAaA,oBA4DC;AAxED,0EAA6F;AAC7F,gEAA8G;AAG9G,MAAM,OAAO,GAA2B,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;AAClF,MAAM,KAAK,GAAyB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AAOrD,SAAgB,IAAI,CAAC,OAAwB;IAC3C,OAAO,KAAK,EAAE,IAAU,EAAE,OAAyB,EAAE,EAAE;QACrD,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC;QACjD,MAAM,OAAO,GAAG,IAAA,mCAAW,EAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAEpD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,CAAC,MAAM,IAAA,+BAAO,EAAC,OAAO,EAAE,aAAa,EAAE,EAAE,CAAC,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC;YAClE,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,MAAM,GAAI,OAAO,CAAC,MAAsB,IAAI,CAAC,MAAM,IAAA,iCAAS,EAAC,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QAC7G,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,CAAC,MAAM,IAAA,+BAAO,EAAC,OAAO,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;QACvE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,IAAA,+BAAO,EAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;QACtE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,IAAA,+BAAO,EAAC,OAAO,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC;QACzE,MAAM,IAAI,GAAI,OAAO,CAAC,IAAkB,IAAI,CAAC,MAAM,IAAA,iCAAS,EAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QAE9F,MAAM,UAAU,GAAoB,OAAO,CAAC,UAAU,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAEhG,MAAM,UAAU,GAAG,IAAA,iCAAc,EAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACxD,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAA,gCAAa,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACzD,IAAI,CAAC,OAAO;YAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,UAAU,2BAA2B,CAAC,CAAC;QAEvF,MAAM,IAAI,GAA4B;YACpC,IAAI;YACJ,MAAM;YACN,IAAI;YACJ,UAAU;YACV,KAAK;YACL,MAAM;YACN,IAAI;YACJ,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;YAC5C,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC;QAGF,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACpH,IAAI,UAAU,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YAC3D,OAAO,CAAC,MAAM,CAAC,IAAI,CACjB,kGAAkG,CACnG,CAAC;QACJ,CAAC;QACD,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrB,OAAO,CAAC,MAAM,CAAC,IAAI,CACjB,sGAAsG,CACvG,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,IAAA,qCAAkB,EAAC,GAAG,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;QAC9G,IAAA,kCAAU,EAAC,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC;QAEhD,IAAA,iCAAc,EAAC,IAAI,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;AACJ,CAAC"}

package/schematics/add-route/index.spec.ts

@@ -0,0 +1,75 @@
+import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
+import { parseDocument } from 'yaml';
+import { main } from './index';
+import { AddRouteOptions } from './schema';
+
+/**
+ * Schematics are tested by invoking the factory Rule directly against a Tree, NOT via
+ * SchematicTestRunner (its testing entrypoint eagerly loads `ora`, an ESM-only module jest cannot
+ * transform here). Passing `name` makes `flagsProvided` true, so no interactive prompt is attempted.
+ */
+function makeCtx(warnings: string[] = []): SchematicContext {
+  return { logger: { info() {}, warn: (m: string) => warnings.push(m), error() {} } } as unknown as SchematicContext;
+}
+
+async function run(options: AddRouteOptions, tree: Tree, ctx = makeCtx()): Promise<Tree> {
+  const rule = main(options) as Rule;
+  const result = await (rule as (t: Tree, c: SchematicContext) => Promise<Tree>)(tree, ctx);
+  return result || tree;
+}
+
+function read(tree: Tree, path = 'config/config.yaml'): string {
+  return tree.read(path)!.toString('utf-8');
+}
+function doc(tree: Tree) {
+  return parseDocument(read(tree));
+}
+function seedConfig(): Tree {
+  const tree = Tree.empty();
+  tree.create(
+    'config/config.yaml',
+    ['# my config', 'gateway:', '  paths:', '    - name: health', '      method: GET', '      path: /health', ''].join(
+      '\n',
+    ),
+  );
+  return tree;
+}
+
+describe('add-route schematic', () => {
+  it('appends a POST route defaulting dataSource to body, preserving comments', async () => {
+    const tree = await run({ name: 'create-order', method: 'POST', path: '/orders', topic: 'orders', action: 'create' }, seedConfig());
+    const paths = doc(tree).getIn(['gateway', 'paths']) as any;
+    expect(paths.items.map((i: any) => String(i.get('name')))).toEqual(['health', 'create-order']);
+    const route = paths.items[1];
+    expect(String(route.get('dataSource'))).toBe('body');
+    expect(String(route.get('mode'))).toBe('rpc');
+    expect(String(route.get('topic'))).toBe('orders');
+    expect(read(tree)).toContain('# my config');
+  });
+
+  it('defaults GET routes to dataSource query and is idempotent', async () => {
+    let tree = await run({ name: 'get-order', method: 'GET', path: '/orders/:id', topic: 'orders', action: 'get' }, seedConfig());
+    const route = (doc(tree).getIn(['gateway', 'paths']) as any).items[1];
+    expect(String(route.get('dataSource'))).toBe('query');
+    tree = await run({ name: 'get-order', method: 'GET', path: '/orders/:id', topic: 'orders', action: 'get' }, tree);
+    const names = (doc(tree).getIn(['gateway', 'paths']) as any).items.map((i: any) => String(i.get('name')));
+    expect(names.filter((n: string) => n === 'get-order')).toHaveLength(1);
+  });
+
+  it('warns when actions are set without auth (ACL fails closed → 403)', async () => {
+    const warnings: string[] = [];
+    await run(
+      { name: 'gated', method: 'GET', path: '/x', topic: 't', action: 'a', actions: ['gateway-access'] },
+      seedConfig(),
+      makeCtx(warnings),
+    );
+    expect(warnings.some((w) => w.includes('actions require auth'))).toBe(true);
+  });
+
+  it('creates config.yaml when it does not exist', async () => {
+    const tree = await run({ name: 'health', method: 'GET', path: '/health', topic: 'admin', action: 'gw-health' }, Tree.empty());
+    expect(tree.exists('config/config.yaml')).toBe(true);
+    const route = (doc(tree).getIn(['gateway', 'paths']) as any).items[0];
+    expect(String(route.get('name'))).toBe('health');
+  });
+});

package/schematics/add-route/index.ts

@@ -0,0 +1,74 @@
+import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
+import { askSelect, askText, loadPrompts, logOutcome } from '../utils/schematic-prompt.util';
+import { findConfigYaml, readConfigDoc, upsertSeqItemByKey, writeConfigDoc } from '../utils/yaml-config.util';
+import { AddRouteOptions, RouteDataSource, RouteMethod, RouteMode } from './schema';
+
+const METHODS: readonly RouteMethod[] = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH'];
+const MODES: readonly RouteMode[] = ['rpc', 'event'];
+
+/**
+ * `add-route <name>` — idempotent upsert of a `gateway.paths[]` entry, comment-preserving.
+ * Maps an HTTP method+path onto a broker topic/action. Only defined fields are written, so a route
+ * stays as terse as the sample configs. `dataSource` defaults to the natural source for the method.
+ */
+export function main(options: AddRouteOptions): Rule {
+  return async (tree: Tree, context: SchematicContext) => {
+    const flagsProvided = options.name !== undefined;
+    const prompts = loadPrompts(context, flagsProvided);
+
+    const name = options.name || (await askText(prompts, 'Route name?', ''));
+    if (!name) {
+      context.logger.error('[rlb-amqp] add-route: a name is required.');
+      return tree;
+    }
+
+    const method = (options.method as RouteMethod) || (await askSelect(prompts, 'HTTP method?', METHODS, 'GET'));
+    const path = options.path || (await askText(prompts, 'URL path?', ''));
+    const topic = options.topic || (await askText(prompts, 'Topic?', ''));
+    const action = options.action || (await askText(prompts, 'Action?', ''));
+    const mode = (options.mode as RouteMode) || (await askSelect(prompts, 'Mode?', MODES, 'rpc'));
+    // GET has no body, so read from the query string; everything else defaults to the JSON body.
+    const dataSource: RouteDataSource = options.dataSource || (method === 'GET' ? 'query' : 'body');
+
+    const configPath = findConfigYaml(tree, options.config);
+    const { doc, existed } = readConfigDoc(tree, configPath);
+    if (!existed) context.logger.info(`[rlb-amqp] ${configPath} not found — creating it.`);
+
+    const item: Record<string, unknown> = {
+      name,
+      method,
+      path,
+      dataSource,
+      topic,
+      action,
+      mode,
+      timeout: options.timeout,
+      auth: options.auth,
+      allowAnonymous: options.allowAnonymous,
+      actions: options.actions,
+      successStatusCode: options.successStatusCode,
+      binary: options.binary,
+      redirect: options.redirect,
+      parseRaw: options.parseRaw,
+    };
+
+    // The ACL gate fails closed: actions with no auth means no userId to check → every request 403s.
+    const hasActions = options.actions !== undefined && (!Array.isArray(options.actions) || options.actions.length > 0);
+    if (hasActions && !options.auth && !options.allowAnonymous) {
+      context.logger.warn(
+        '[rlb-amqp] add-route: actions require auth on the same route (fails closed → every request 403).',
+      );
+    }
+    if (options.parseRaw) {
+      context.logger.warn(
+        '[rlb-amqp] add-route: parseRaw needs rawBody:true at bootstrap (NestFactory.create({rawBody:true})).',
+      );
+    }
+
+    const outcome = upsertSeqItemByKey(doc, ['gateway', 'paths'], 'name', item, { overwrite: options.overwrite });
+    logOutcome(context, `route '${name}'`, outcome);
+
+    writeConfigDoc(tree, configPath, doc);
+    return tree;
+  };
+}

package/schematics/add-route/schema.d.ts

@@ -0,0 +1,22 @@
+export type RouteMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+export type RouteDataSource = 'body' | 'query' | 'params' | 'body-query' | 'query-body';
+export type RouteMode = 'rpc' | 'event';
+export interface AddRouteOptions {
+    name?: string;
+    method?: RouteMethod;
+    path?: string;
+    dataSource?: RouteDataSource;
+    topic?: string;
+    action?: string;
+    mode?: RouteMode;
+    timeout?: number;
+    auth?: string;
+    allowAnonymous?: boolean;
+    actions?: string | string[];
+    successStatusCode?: number;
+    binary?: boolean;
+    redirect?: number;
+    parseRaw?: boolean;
+    overwrite?: boolean;
+    config?: string;
+}

package/schematics/add-route/schema.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=schema.js.map

package/schematics/add-route/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../libs/rlb-nestjs-amqp/src/schematics/add-route/schema.ts"],"names":[],"mappings":""}

package/schematics/add-route/schema.json

@@ -0,0 +1,74 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "SchematicsRlbAmqpAddRoute",
+  "title": "Add an HTTP route (gateway.paths[]) to config.yaml",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Route name (the key).",
+      "x-prompt": "Route name?",
+      "$default": { "$source": "argv", "index": 0 }
+    },
+    "method": {
+      "type": "string",
+      "enum": ["GET", "POST", "PUT", "DELETE", "PATCH"],
+      "default": "GET",
+      "description": "HTTP method."
+    },
+    "path": {
+      "type": "string",
+      "description": "URL path (e.g. /orders/:id).",
+      "x-prompt": "URL path?"
+    },
+    "dataSource": {
+      "type": "string",
+      "enum": ["body", "query", "params", "body-query", "query-body"],
+      "description": "Where to read the payload from (default: query for GET, body otherwise)."
+    },
+    "topic": {
+      "type": "string",
+      "description": "Broker topic the request forwards to.",
+      "x-prompt": "Topic?"
+    },
+    "action": {
+      "type": "string",
+      "description": "Broker action invoked on that topic.",
+      "x-prompt": "Action?"
+    },
+    "mode": {
+      "type": "string",
+      "enum": ["rpc", "event"],
+      "default": "rpc",
+      "description": "rpc (wait reply) | event (fire-and-forget)."
+    },
+    "timeout": { "type": "number", "description": "RPC reply timeout in ms." },
+    "auth": { "type": "string", "description": "Auth-provider name that must verify the caller." },
+    "allowAnonymous": {
+      "type": "boolean",
+      "description": "Allow anonymous callers even when auth is set."
+    },
+    "actions": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "Actions the caller must hold (OR-semantics) — gated via the ACL. Requires auth."
+    },
+    "successStatusCode": { "type": "number", "description": "HTTP status returned on success." },
+    "binary": { "type": "boolean", "description": "Return the reply as a raw binary buffer." },
+    "redirect": { "type": "number", "description": "Respond with this redirect status instead of a body." },
+    "parseRaw": {
+      "type": "boolean",
+      "description": "Forward the raw (unparsed) request body — needs rawBody:true at bootstrap."
+    },
+    "overwrite": {
+      "type": "boolean",
+      "default": false,
+      "description": "Update the entry if it already exists (default: leave it untouched)."
+    },
+    "config": {
+      "type": "string",
+      "description": "Path to config.yaml (default: auto-detected)."
+    }
+  },
+  "required": []
+}