@open-rlb/nestjs-amqp 2.1.0 → 2.2.0

package/schematics/add-ws-event/index.ts

@@ -0,0 +1,72 @@
+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 { AddWsEventOptions, WsEventType } from './schema';
+
+const TYPES: readonly WsEventType[] = ['ws', 'http'];
+
+/**
+ * `add-ws-event <name>` — idempotent upsert of a `gateway.events[]` entry, comment-preserving.
+ * A `ws` event pushes broker messages to subscribed clients (exchange/routingKey + auth/scoping);
+ * an `http` event fans a broker message out to a webhook (url/method/timeout). Only the fields that
+ * apply to the chosen `type` are written, and `httpMethod` maps onto WebSocketEvent's `method`.
+ */
+export function main(options: AddWsEventOptions): Rule {
+  return async (tree: Tree, context: SchematicContext) => {
+    const flagsProvided = options.name !== undefined;
+    const prompts = loadPrompts(context, flagsProvided);
+
+    const name = options.name || (await askText(prompts, 'Event name?', ''));
+    if (!name) {
+      context.logger.error('[rlb-amqp] add-ws-event: a name is required.');
+      return tree;
+    }
+
+    const type = (options.type as WsEventType) || (await askSelect(prompts, 'Event type?', TYPES, 'ws'));
+
+    const configPath = findConfigYaml(tree, options.config);
+    const { doc, existed } = readConfigDoc(tree, configPath);
+    if (!existed) context.logger.info(`[rlb-amqp] ${configPath} not found — creating it.`);
+
+    // http events talk to a webhook (url/method/timeout); ws events push to subscribers with the
+    // full auth/scoping surface. Building type-specific items keeps stray fields out of the config.
+    const item: Record<string, unknown> =
+      type === 'http'
+        ? {
+            name,
+            type,
+            url: options.url,
+            method: options.httpMethod,
+            timeout: options.timeout,
+          }
+        : {
+            name,
+            type,
+            exchange: options.exchange,
+            routingKey: options.routingKey,
+            auth: options.auth,
+            requireAuth: options.requireAuth,
+            actions: options.actions,
+            scopeClaim: options.scopeClaim,
+            payloadKey: options.payloadKey,
+          };
+
+    // Per-user scoping needs BOTH halves: scopeClaim (the client's value) and payloadKey (the message
+    // field to compare it to). With only scopeClaim, the compare has nothing to match → nothing ships.
+    if (options.scopeClaim && !options.payloadKey) {
+      context.logger.warn(
+        '[rlb-amqp] add-ws-event: scopeClaim without payloadKey denies every message (per-user isolation needs both).',
+      );
+    }
+    const hasActions = options.actions !== undefined && (!Array.isArray(options.actions) || options.actions.length > 0);
+    if (hasActions && !options.auth) {
+      context.logger.warn('[rlb-amqp] add-ws-event: actions require auth.');
+    }
+
+    const outcome = upsertSeqItemByKey(doc, ['gateway', 'events'], 'name', item, { overwrite: options.overwrite });
+    logOutcome(context, `ws-event '${name}'`, outcome);
+
+    writeConfigDoc(tree, configPath, doc);
+    return tree;
+  };
+}

package/schematics/add-ws-event/schema.d.ts

@@ -0,0 +1,17 @@
+export type WsEventType = 'ws' | 'http';
+export interface AddWsEventOptions {
+    name?: string;
+    type?: WsEventType;
+    exchange?: string;
+    routingKey?: string;
+    auth?: string;
+    requireAuth?: boolean;
+    actions?: string | string[];
+    scopeClaim?: string;
+    payloadKey?: string;
+    url?: string;
+    httpMethod?: string;
+    timeout?: number;
+    overwrite?: boolean;
+    config?: string;
+}

package/schematics/add-ws-event/schema.js

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

package/schematics/add-ws-event/schema.js.map

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

package/schematics/add-ws-event/schema.json

@@ -0,0 +1,53 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "SchematicsRlbAmqpAddWsEvent",
+  "title": "Add a WebSocket/webhook event (gateway.events[]) to config.yaml",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Event name (the key).",
+      "x-prompt": "Event name?",
+      "$default": { "$source": "argv", "index": 0 }
+    },
+    "type": {
+      "type": "string",
+      "enum": ["ws", "http"],
+      "default": "ws",
+      "description": "ws (push to subscribed clients) | http (webhook POST)."
+    },
+    "exchange": { "type": "string", "description": "Source exchange the gateway binds to (ws)." },
+    "routingKey": { "type": "string", "description": "routingKey bound on that exchange (ws)." },
+    "auth": { "type": "string", "description": "Auth-provider name used to verify the subscribe token." },
+    "requireAuth": {
+      "type": "boolean",
+      "description": "Set false to make auth optional (anonymous may subscribe)."
+    },
+    "actions": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "Actions the subscriber must hold (OR-semantics). Requires auth."
+    },
+    "scopeClaim": {
+      "type": "string",
+      "description": "Claim used to scope delivery per-user; requires payloadKey."
+    },
+    "payloadKey": {
+      "type": "string",
+      "description": "Payload field compared against scopeClaim — only matching messages are forwarded."
+    },
+    "url": { "type": "string", "description": "Webhook URL to POST to (http)." },
+    "httpMethod": { "type": "string", "description": "HTTP method for the webhook (http) — written as method." },
+    "timeout": { "type": "number", "description": "Webhook request timeout in ms (http)." },
+    "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-ws-event/schema.ts

@@ -0,0 +1,33 @@
+/** Delivery transport for the event. Mirrors WebSocketEvent['type'] (ws push or http webhook). */
+export type WsEventType = 'ws' | 'http';
+
+export interface AddWsEventOptions {
+  /** Event name (the key). Prompted when omitted. */
+  name?: string;
+  /** ws (push to subscribed clients) | http (webhook POST). Default: ws. */
+  type?: WsEventType;
+  /** Source exchange the gateway binds to (ws). */
+  exchange?: string;
+  /** routingKey bound on that exchange (ws). */
+  routingKey?: string;
+  /** Auth-provider name used to verify the subscribe token AND map its claims. */
+  auth?: string;
+  /** Set false to make `auth` optional (anonymous may subscribe; authed still get claims mapped). */
+  requireAuth?: boolean;
+  /** Actions the subscriber must hold (OR-semantics), checked resource-agnostically. Requires `auth`. */
+  actions?: string | string[];
+  /** Claim used to scope delivery per-user; requires `payloadKey` to compare against. */
+  scopeClaim?: string;
+  /** Payload field compared against `scopeClaim` — only matching messages are forwarded. */
+  payloadKey?: string;
+  /** Webhook URL to POST to (http). */
+  url?: string;
+  /** HTTP method for the webhook (http) — written as `method`. */
+  httpMethod?: string;
+  /** Webhook request timeout in ms (http). */
+  timeout?: number;
+  /** 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/collection.json

@@ -5,6 +5,86 @@
       "description": "Add RabbitMQ support to a NestJS project",
       "factory": "./nest-add/index#main",
       "schema": "./nest-add/schema.json"
+    },
+    "add-exchange": {
+      "description": "Add a broker exchange to config.yaml (optionally with a bound queue)",
+      "factory": "./add-exchange/index#main",
+      "schema": "./add-exchange/schema.json"
+    },
+    "add-queue": {
+      "description": "Add a broker queue to config.yaml (creates the exchange if missing; growth bounds)",
+      "factory": "./add-queue/index#main",
+      "schema": "./add-queue/schema.json"
+    },
+    "add-topic": {
+      "description": "Add a broker topic to config.yaml (creates queue/exchange if missing)",
+      "factory": "./add-topic/index#main",
+      "schema": "./add-topic/schema.json"
+    },
+    "add-exchange-binding": {
+      "description": "Bind two exchanges via broker.exchangeBindings[]",
+      "factory": "./add-exchange-binding/index#main",
+      "schema": "./add-exchange-binding/schema.json"
+    },
+    "add-reply-queue": {
+      "description": "Map an exchange to an RPC reply queue via broker.replyQueues",
+      "factory": "./add-reply-queue/index#main",
+      "schema": "./add-reply-queue/schema.json"
+    },
+    "enable-retry": {
+      "description": "Configure a bounded retry policy (broker.retry or topics[].retry) + declare the dead-letter exchange",
+      "factory": "./enable-retry/index#main",
+      "schema": "./enable-retry/schema.json"
+    },
+    "enable-route-discovery": {
+      "description": "Enable publisher-side route auto-discovery (broker.routeDiscovery + fanout exchange)",
+      "factory": "./enable-route-discovery/index#main",
+      "schema": "./enable-route-discovery/schema.json"
+    },
+    "set-connection-name": {
+      "description": "Set the logical AMQP connection_name (the lib auto-suffixes -hostname-pid per instance)",
+      "factory": "./set-connection-name/index#main",
+      "schema": "./set-connection-name/schema.json"
+    },
+    "configure-broker": {
+      "description": "Set broker connection scalars (uri, prefetchCount, defaultRpcTimeout, init/manager options, credentials)",
+      "factory": "./configure-broker/index#main",
+      "schema": "./configure-broker/schema.json"
+    },
+    "add-auth-provider": {
+      "description": "Add an auth-providers[] entry (jwt | jwks | basic | str-compare | none)",
+      "factory": "./add-auth-provider/index#main",
+      "schema": "./add-auth-provider/schema.json"
+    },
+    "add-gateway": {
+      "description": "Promote a config to a gateway: remove publisher route-discovery, add rlb-acl/admin/control infra + gateway section",
+      "factory": "./add-gateway/index#main",
+      "schema": "./add-gateway/schema.json"
+    },
+    "add-route": {
+      "description": "Add an HTTP route (gateway.paths[]) forwarding to a topic/action",
+      "factory": "./add-route/index#main",
+      "schema": "./add-route/schema.json"
+    },
+    "add-ws-event": {
+      "description": "Add a WebSocket/webhook event (gateway.events[])",
+      "factory": "./add-ws-event/index#main",
+      "schema": "./add-ws-event/schema.json"
+    },
+    "add-metrics-topic": {
+      "description": "Isolate gw-metrics-track on a dedicated bounded topic/queue and point gateway.metrics at it",
+      "factory": "./add-metrics-topic/index#main",
+      "schema": "./add-metrics-topic/schema.json"
+    },
+    "enable-load-config": {
+      "description": "Add gateway.loadConfig (pull DB-managed routes/events, merged with YAML, on (re)load)",
+      "factory": "./enable-load-config/index#main",
+      "schema": "./enable-load-config/schema.json"
+    },
+    "harden-gateway": {
+      "description": "Add gateway hardening limits (maxConcurrentRequests, maxBodyBytes + main.ts body parser, upload, ws.maxBufferedBytes)",
+      "factory": "./harden-gateway/index#main",
+      "schema": "./harden-gateway/schema.json"
     }
   }
-}
+}

package/schematics/configure-broker/index.d.ts

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

package/schematics/configure-broker/index.js

@@ -0,0 +1,41 @@
+"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 MANAGER = ['broker', 'connectionManagerOptions'];
+const CREDS = [...MANAGER, 'connectionOptions', 'credentials'];
+function main(options) {
+    return async (tree, context) => {
+        const flagsProvided = options.uri !== undefined;
+        (0, schematic_prompt_util_1.loadPrompts)(context, flagsProvided);
+        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 edits = [
+            [options.uri, ['broker', 'uri'], 'broker.uri'],
+            [options.prefetchCount, ['broker', 'prefetchCount'], 'broker.prefetchCount'],
+            [options.defaultRpcTimeout, ['broker', 'defaultRpcTimeout'], 'broker.defaultRpcTimeout'],
+            [options.heartbeatIntervalInSeconds, [...MANAGER, 'heartbeatIntervalInSeconds'], 'heartbeatIntervalInSeconds'],
+            [options.reconnectTimeInSeconds, [...MANAGER, 'reconnectTimeInSeconds'], 'reconnectTimeInSeconds'],
+            [options.mechanism, [...CREDS, 'mechanism'], 'credentials.mechanism'],
+            [options.username, [...CREDS, 'username'], 'credentials.username'],
+            [options.password, [...CREDS, 'password'], 'credentials.password'],
+        ];
+        let applied = 0;
+        for (const [value, path, label] of edits) {
+            if (value === undefined)
+                continue;
+            (0, schematic_prompt_util_1.logOutcome)(context, label, (0, yaml_config_util_1.setIn)(doc, path, value));
+            applied++;
+        }
+        if (applied === 0) {
+            context.logger.warn('[rlb-amqp] configure-broker: no options provided — nothing to set.');
+            return tree;
+        }
+        (0, yaml_config_util_1.writeConfigDoc)(tree, configPath, doc);
+        return tree;
+    };
+}
+//# sourceMappingURL=index.js.map

package/schematics/configure-broker/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../libs/rlb-nestjs-amqp/src/schematics/configure-broker/index.ts"],"names":[],"mappings":";;AAaA,oBAqCC;AAjDD,0EAAyE;AACzE,gEAAiG;AAGjG,MAAM,OAAO,GAAG,CAAC,QAAQ,EAAE,0BAA0B,CAAC,CAAC;AACvD,MAAM,KAAK,GAAG,CAAC,GAAG,OAAO,EAAE,mBAAmB,EAAE,aAAa,CAAC,CAAC;AAO/D,SAAgB,IAAI,CAAC,OAA+B;IAClD,OAAO,KAAK,EAAE,IAAU,EAAE,OAAyB,EAAE,EAAE;QAErD,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,KAAK,SAAS,CAAC;QAChD,IAAA,mCAAW,EAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAEpC,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;QAGvF,MAAM,KAAK,GAAkD;YAC3D,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,YAAY,CAAC;YAC9C,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,QAAQ,EAAE,eAAe,CAAC,EAAE,sBAAsB,CAAC;YAC5E,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,QAAQ,EAAE,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;YACxF,CAAC,OAAO,CAAC,0BAA0B,EAAE,CAAC,GAAG,OAAO,EAAE,4BAA4B,CAAC,EAAE,4BAA4B,CAAC;YAC9G,CAAC,OAAO,CAAC,sBAAsB,EAAE,CAAC,GAAG,OAAO,EAAE,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;YAClG,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC,EAAE,uBAAuB,CAAC;YACrE,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,GAAG,KAAK,EAAE,UAAU,CAAC,EAAE,sBAAsB,CAAC;YAClE,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,GAAG,KAAK,EAAE,UAAU,CAAC,EAAE,sBAAsB,CAAC;SACnE,CAAC;QAEF,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC;YACzC,IAAI,KAAK,KAAK,SAAS;gBAAE,SAAS;YAClC,IAAA,kCAAU,EAAC,OAAO,EAAE,KAAK,EAAE,IAAA,wBAAK,EAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;YACpD,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;YAClB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,oEAAoE,CAAC,CAAC;YAC1F,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAA,iCAAc,EAAC,IAAI,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;AACJ,CAAC"}

package/schematics/configure-broker/index.spec.ts

@@ -0,0 +1,62 @@
+import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
+import { parseDocument } from 'yaml';
+import { main } from './index';
+import { ConfigureBrokerOptions } from './schema';
+
+/** Invoke the factory Rule directly (SchematicTestRunner eagerly loads ESM `ora`). */
+const ctx = { logger: { info() {}, warn() {}, error() {} } } as unknown as SchematicContext;
+
+async function run(options: ConfigureBrokerOptions, 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:', '  uri: amqp://old', '  prefetchCount: 10', 'topics: []', ''].join('\n'),
+  );
+  return tree;
+}
+
+describe('configure-broker schematic', () => {
+  it('sets only the provided scalars at their nested paths', async () => {
+    const tree = await run(
+      { uri: 'amqp://new', defaultRpcTimeout: 5000, heartbeatIntervalInSeconds: 15, mechanism: 'PLAIN', username: 'u', password: 'p' },
+      seedConfig(),
+    );
+    const d = doc(tree);
+    expect(String(d.getIn(['broker', 'uri']))).toBe('amqp://new');
+    expect(Number(d.getIn(['broker', 'defaultRpcTimeout']))).toBe(5000);
+    expect(Number(d.getIn(['broker', 'connectionManagerOptions', 'heartbeatIntervalInSeconds']))).toBe(15);
+    const creds = ['broker', 'connectionManagerOptions', 'connectionOptions', 'credentials'];
+    expect(String(d.getIn([...creds, 'mechanism']))).toBe('PLAIN');
+    expect(String(d.getIn([...creds, 'username']))).toBe('u');
+    expect(String(d.getIn([...creds, 'password']))).toBe('p');
+    // Untouched pre-existing value survives.
+    expect(Number(d.getIn(['broker', 'prefetchCount']))).toBe(10);
+  });
+
+  it('leaves unprovided keys untouched (no clobbering)', async () => {
+    const tree = await run({ defaultRpcTimeout: 3000 }, seedConfig());
+    const d = doc(tree);
+    expect(String(d.getIn(['broker', 'uri']))).toBe('amqp://old');
+    expect(Number(d.getIn(['broker', 'prefetchCount']))).toBe(10);
+    expect(Number(d.getIn(['broker', 'defaultRpcTimeout']))).toBe(3000);
+  });
+
+  it('is idempotent and makes no change when no options are provided', async () => {
+    const seed = seedConfig();
+    const before = read(seed);
+    const tree = await run({}, seed);
+    expect(read(tree)).toBe(before);
+  });
+});

package/schematics/configure-broker/index.ts

@@ -0,0 +1,51 @@
+import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
+import { loadPrompts, logOutcome } from '../utils/schematic-prompt.util';
+import { findConfigYaml, readConfigDoc, setIn, writeConfigDoc } from '../utils/yaml-config.util';
+import { ConfigureBrokerOptions } from './schema';
+
+const MANAGER = ['broker', 'connectionManagerOptions'];
+const CREDS = [...MANAGER, 'connectionOptions', 'credentials'];
+
+/**
+ * `configure-broker` — set broker connection scalars, ONLY for values that were actually provided
+ * (so re-running with a single flag never clobbers the rest of the config). Mostly non-interactive:
+ * it just applies whatever flags were passed.
+ */
+export function main(options: ConfigureBrokerOptions): Rule {
+  return async (tree: Tree, context: SchematicContext) => {
+    // `uri` is the closest thing to a primary field; otherwise this schematic is flag-driven.
+    const flagsProvided = options.uri !== undefined;
+    loadPrompts(context, flagsProvided);
+
+    const configPath = findConfigYaml(tree, options.config);
+    const { doc, existed } = readConfigDoc(tree, configPath);
+    if (!existed) context.logger.info(`[rlb-amqp] ${configPath} not found — creating it.`);
+
+    // (option value, target path, label) — only entries whose value is defined get applied.
+    const edits: Array<[unknown, (string | number)[], string]> = [
+      [options.uri, ['broker', 'uri'], 'broker.uri'],
+      [options.prefetchCount, ['broker', 'prefetchCount'], 'broker.prefetchCount'],
+      [options.defaultRpcTimeout, ['broker', 'defaultRpcTimeout'], 'broker.defaultRpcTimeout'],
+      [options.heartbeatIntervalInSeconds, [...MANAGER, 'heartbeatIntervalInSeconds'], 'heartbeatIntervalInSeconds'],
+      [options.reconnectTimeInSeconds, [...MANAGER, 'reconnectTimeInSeconds'], 'reconnectTimeInSeconds'],
+      [options.mechanism, [...CREDS, 'mechanism'], 'credentials.mechanism'],
+      [options.username, [...CREDS, 'username'], 'credentials.username'],
+      [options.password, [...CREDS, 'password'], 'credentials.password'],
+    ];
+
+    let applied = 0;
+    for (const [value, path, label] of edits) {
+      if (value === undefined) continue;
+      logOutcome(context, label, setIn(doc, path, value));
+      applied++;
+    }
+
+    if (applied === 0) {
+      context.logger.warn('[rlb-amqp] configure-broker: no options provided — nothing to set.');
+      return tree;
+    }
+
+    writeConfigDoc(tree, configPath, doc);
+    return tree;
+  };
+}

package/schematics/configure-broker/schema.d.ts

@@ -0,0 +1,11 @@
+export interface ConfigureBrokerOptions {
+    uri?: string;
+    prefetchCount?: number;
+    defaultRpcTimeout?: number;
+    heartbeatIntervalInSeconds?: number;
+    reconnectTimeInSeconds?: number;
+    mechanism?: 'PLAIN' | 'EXTERNAL' | 'AMQPLAIN';
+    username?: string;
+    password?: string;
+    config?: string;
+}

package/schematics/configure-broker/schema.js

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

package/schematics/configure-broker/schema.js.map

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

package/schematics/configure-broker/schema.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "SchematicsRlbAmqpConfigureBroker",
+  "title": "Set broker connection scalars in config.yaml",
+  "type": "object",
+  "properties": {
+    "uri": {
+      "type": "string",
+      "description": "broker.uri (the AMQP connection string).",
+      "$default": { "$source": "argv", "index": 0 }
+    },
+    "prefetchCount": {
+      "type": "number",
+      "description": "broker.prefetchCount (channel prefetch)."
+    },
+    "defaultRpcTimeout": {
+      "type": "number",
+      "description": "broker.defaultRpcTimeout (ms)."
+    },
+    "heartbeatIntervalInSeconds": {
+      "type": "number",
+      "description": "connectionManagerOptions.heartbeatIntervalInSeconds."
+    },
+    "reconnectTimeInSeconds": {
+      "type": "number",
+      "description": "connectionManagerOptions.reconnectTimeInSeconds."
+    },
+    "mechanism": {
+      "type": "string",
+      "enum": ["PLAIN", "EXTERNAL", "AMQPLAIN"],
+      "description": "SASL mechanism used in connectionOptions.credentials."
+    },
+    "username": {
+      "type": "string",
+      "description": "connectionOptions.credentials.username."
+    },
+    "password": {
+      "type": "string",
+      "description": "connectionOptions.credentials.password."
+    },
+    "config": {
+      "type": "string",
+      "description": "Path to config.yaml (default: auto-detected)."
+    }
+  },
+  "required": []
+}

package/schematics/configure-broker/schema.ts

@@ -0,0 +1,20 @@
+export interface ConfigureBrokerOptions {
+  /** broker.uri (the AMQP connection string). */
+  uri?: string;
+  /** broker.prefetchCount (channel prefetch). */
+  prefetchCount?: number;
+  /** broker.defaultRpcTimeout (ms). */
+  defaultRpcTimeout?: number;
+  /** connectionManagerOptions.heartbeatIntervalInSeconds. */
+  heartbeatIntervalInSeconds?: number;
+  /** connectionManagerOptions.reconnectTimeInSeconds. */
+  reconnectTimeInSeconds?: number;
+  /** SASL mechanism used in connectionOptions.credentials. */
+  mechanism?: 'PLAIN' | 'EXTERNAL' | 'AMQPLAIN';
+  /** connectionOptions.credentials.username. */
+  username?: string;
+  /** connectionOptions.credentials.password. */
+  password?: string;
+  /** Path to config.yaml (default: auto-detected, typically config/config.yaml). */
+  config?: string;
+}

package/schematics/enable-load-config/index.d.ts

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

package/schematics/enable-load-config/index.js

@@ -0,0 +1,32 @@
+"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.pathsTopic !== undefined || options.eventsTopic !== undefined;
+        const prompts = (0, schematic_prompt_util_1.loadPrompts)(context, flagsProvided);
+        const pathsTopic = options.pathsTopic || (await (0, schematic_prompt_util_1.askText)(prompts, 'Paths export topic?', 'rlb-gateway-admin'));
+        const pathsAction = options.pathsAction || (await (0, schematic_prompt_util_1.askText)(prompts, 'Paths export action?', 'gw-path-export'));
+        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 pOutcome = (0, yaml_config_util_1.setIn)(doc, ['gateway', 'loadConfig', 'paths'], { topic: pathsTopic, action: pathsAction });
+        (0, schematic_prompt_util_1.logOutcome)(context, 'gateway.loadConfig.paths', pOutcome);
+        if (options.eventsTopic && options.eventsAction) {
+            const eOutcome = (0, yaml_config_util_1.setIn)(doc, ['gateway', 'loadConfig', 'events'], {
+                topic: options.eventsTopic,
+                action: options.eventsAction,
+            });
+            (0, schematic_prompt_util_1.logOutcome)(context, 'gateway.loadConfig.events', eOutcome);
+        }
+        else if (options.eventsTopic || options.eventsAction) {
+            context.logger.warn('[rlb-amqp] enable-load-config: events needs BOTH eventsTopic and eventsAction — skipped.');
+        }
+        (0, yaml_config_util_1.writeConfigDoc)(tree, configPath, doc);
+        return tree;
+    };
+}
+//# sourceMappingURL=index.js.map

package/schematics/enable-load-config/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../libs/rlb-nestjs-amqp/src/schematics/enable-load-config/index.ts"],"names":[],"mappings":";;AAUA,oBA4BC;AArCD,0EAAkF;AAClF,gEAAiG;AAQjG,SAAgB,IAAI,CAAC,OAAgC;IACnD,OAAO,KAAK,EAAE,IAAU,EAAE,OAAyB,EAAE,EAAE;QACrD,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,KAAK,SAAS,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC;QAC5F,MAAM,OAAO,GAAG,IAAA,mCAAW,EAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAEpD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,CAAC,MAAM,IAAA,+BAAO,EAAC,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,CAAC,CAAC,CAAC;QAC9G,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,CAAC,MAAM,IAAA,+BAAO,EAAC,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,CAAC,CAAC,CAAC;QAE9G,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,QAAQ,GAAG,IAAA,wBAAK,EAAC,GAAG,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;QAC5G,IAAA,kCAAU,EAAC,OAAO,EAAE,0BAA0B,EAAE,QAAQ,CAAC,CAAC;QAE1D,IAAI,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YAChD,MAAM,QAAQ,GAAG,IAAA,wBAAK,EAAC,GAAG,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE;gBAC/D,KAAK,EAAE,OAAO,CAAC,WAAW;gBAC1B,MAAM,EAAE,OAAO,CAAC,YAAY;aAC7B,CAAC,CAAC;YACH,IAAA,kCAAU,EAAC,OAAO,EAAE,2BAA2B,EAAE,QAAQ,CAAC,CAAC;QAC7D,CAAC;aAAM,IAAI,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YACvD,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,0FAA0F,CAAC,CAAC;QAClH,CAAC;QAED,IAAA,iCAAc,EAAC,IAAI,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;AACJ,CAAC"}

package/schematics/enable-load-config/index.spec.ts

@@ -0,0 +1,61 @@
+import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
+import { parseDocument } from 'yaml';
+import { main } from './index';
+import { EnableLoadConfigOptions } from './schema';
+
+/**
+ * Factory invoked directly against a Tree (not SchematicTestRunner — ESM `ora`). Passing
+ * `pathsTopic` makes `flagsProvided` true → no prompts.
+ */
+const ctx = { logger: { info() {}, warn() {}, error() {} } } as unknown as SchematicContext;
+
+async function run(options: EnableLoadConfigOptions, 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', 'gateway:', '  paths: []', ''].join('\n'));
+  return tree;
+}
+
+describe('enable-load-config schematic', () => {
+  it('sets gateway.loadConfig.paths with defaults, preserving comments', async () => {
+    const tree = await run({ pathsTopic: 'rlb-gateway-admin' }, seedConfig());
+    const d = doc(tree);
+    expect(String(d.getIn(['gateway', 'loadConfig', 'paths', 'topic']))).toBe('rlb-gateway-admin');
+    expect(String(d.getIn(['gateway', 'loadConfig', 'paths', 'action']))).toBe('gw-path-export');
+    expect(d.hasIn(['gateway', 'loadConfig', 'events'])).toBe(false);
+    expect(read(tree)).toContain('# my config');
+  });
+
+  it('adds events only when both eventsTopic and eventsAction are provided', async () => {
+    const tree = await run(
+      { pathsTopic: 'p', pathsAction: 'pa', eventsTopic: 'e', eventsAction: 'ea' },
+      seedConfig(),
+    );
+    const d = doc(tree);
+    expect(String(d.getIn(['gateway', 'loadConfig', 'events', 'topic']))).toBe('e');
+    expect(String(d.getIn(['gateway', 'loadConfig', 'events', 'action']))).toBe('ea');
+  });
+
+  it('skips events when only one of the pair is given', async () => {
+    const tree = await run({ pathsTopic: 'p', eventsTopic: 'e' }, seedConfig());
+    expect(doc(tree).hasIn(['gateway', 'loadConfig', 'events'])).toBe(false);
+  });
+
+  it('is idempotent', async () => {
+    let tree = await run({ pathsTopic: 'rlb-gateway-admin' }, seedConfig());
+    tree = await run({ pathsTopic: 'rlb-gateway-admin' }, tree);
+    const d = doc(tree);
+    expect(String(d.getIn(['gateway', 'loadConfig', 'paths', 'topic']))).toBe('rlb-gateway-admin');
+  });
+});