@open-rlb/nestjs-amqp 2.1.1 → 2.2.0

package/schematics/utils/yaml-config.util.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_CONFIG_PATH = void 0;
+exports.findConfigYaml = findConfigYaml;
+exports.readConfigDoc = readConfigDoc;
+exports.writeConfigDoc = writeConfigDoc;
+exports.ensureSeqAt = ensureSeqAt;
+exports.ensureMapAt = ensureMapAt;
+exports.findSeqItemByKey = findSeqItemByKey;
+exports.seqItemExists = seqItemExists;
+exports.upsertSeqItemByKey = upsertSeqItemByKey;
+exports.setIn = setIn;
+exports.deleteSeqItemByKey = deleteSeqItemByKey;
+exports.getScalar = getScalar;
+const yaml_1 = require("yaml");
+exports.DEFAULT_CONFIG_PATH = 'config/config.yaml';
+function findConfigYaml(tree, preferred) {
+    const candidates = [preferred, exports.DEFAULT_CONFIG_PATH, 'src/config/config.yaml', 'config.yaml'].filter((c) => !!c);
+    for (const c of candidates) {
+        if (tree.exists(c))
+            return c;
+    }
+    let found;
+    tree.visit((p) => {
+        if (!found && p.endsWith('/config.yaml'))
+            found = p.replace(/^\//, '');
+    });
+    return found || preferred || exports.DEFAULT_CONFIG_PATH;
+}
+function readConfigDoc(tree, path) {
+    if (tree.exists(path)) {
+        const raw = tree.read(path).toString('utf-8');
+        return { doc: (0, yaml_1.parseDocument)(raw), existed: true };
+    }
+    return { doc: new yaml_1.Document({}), existed: false };
+}
+function writeConfigDoc(tree, path, doc) {
+    const out = doc.toString({ lineWidth: 0 });
+    if (tree.exists(path))
+        tree.overwrite(path, out);
+    else
+        tree.create(path, out);
+}
+function ensureSeqAt(doc, path) {
+    const node = doc.getIn(path, true);
+    if ((0, yaml_1.isSeq)(node))
+        return node;
+    const seq = new yaml_1.YAMLSeq();
+    doc.setIn(path, seq);
+    return seq;
+}
+function ensureMapAt(doc, path) {
+    const node = doc.getIn(path, true);
+    if ((0, yaml_1.isMap)(node))
+        return node;
+    const map = new yaml_1.YAMLMap();
+    doc.setIn(path, map);
+    return map;
+}
+function findSeqItemByKey(doc, path, keyField, key) {
+    const node = doc.getIn(path, true);
+    if (!(0, yaml_1.isSeq)(node))
+        return undefined;
+    return node.items.find((it) => (0, yaml_1.isMap)(it) && String(it.get(keyField)) === String(key));
+}
+function seqItemExists(doc, path, keyField, key) {
+    return !!findSeqItemByKey(doc, path, keyField, key);
+}
+function upsertSeqItemByKey(doc, path, keyField, item, opts = {}) {
+    const seq = ensureSeqAt(doc, path);
+    const clean = stripUndefined(item);
+    const existing = seq.items.find((it) => (0, yaml_1.isMap)(it) && String(it.get(keyField)) === String(clean[keyField]));
+    if (!existing) {
+        const node = doc.createNode(clean);
+        if (opts.commentBefore)
+            node.commentBefore = ` ${opts.commentBefore}`;
+        seq.flow = false;
+        node.flow = false;
+        seq.add(node);
+        return 'created';
+    }
+    if (!opts.overwrite)
+        return 'unchanged';
+    const before = existing.toString();
+    for (const [k, v] of Object.entries(clean)) {
+        existing.set(k, doc.createNode(v));
+    }
+    return existing.toString() === before ? 'unchanged' : 'updated';
+}
+function setIn(doc, path, value) {
+    const prev = doc.getIn(path, false);
+    const existed = prev !== undefined;
+    if (existed && JSON.stringify(prev) === JSON.stringify(value))
+        return 'unchanged';
+    doc.setIn(path, doc.createNode(value));
+    return existed ? 'updated' : 'created';
+}
+function deleteSeqItemByKey(doc, path, keyField, key) {
+    const node = doc.getIn(path, true);
+    if (!(0, yaml_1.isSeq)(node))
+        return false;
+    const idx = node.items.findIndex((it) => (0, yaml_1.isMap)(it) && String(it.get(keyField)) === String(key));
+    if (idx === -1)
+        return false;
+    node.items.splice(idx, 1);
+    return true;
+}
+function getScalar(doc, path) {
+    return doc.getIn(path, false);
+}
+function stripUndefined(obj) {
+    const out = {};
+    for (const [k, v] of Object.entries(obj)) {
+        if (v !== undefined)
+            out[k] = v;
+    }
+    return out;
+}
+//# sourceMappingURL=yaml-config.util.js.map

package/schematics/utils/yaml-config.util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"yaml-config.util.js","sourceRoot":"","sources":["../../../libs/rlb-nestjs-amqp/src/schematics/utils/yaml-config.util.ts"],"names":[],"mappings":";;;AAkBA,wCAYC;AAGD,sCAMC;AAGD,wCAIC;AAGD,kCAMC;AAGD,kCAMC;AAGD,4CASC;AAGD,sCAEC;AAgBD,gDAgCC;AAGD,sBAMC;AAGD,gDAYC;AAGD,8BAEC;AA7JD,+BAA+E;AAWlE,QAAA,mBAAmB,GAAG,oBAAoB,CAAC;AAMxD,SAAgB,cAAc,CAAC,IAAU,EAAE,SAAkB;IAC3D,MAAM,UAAU,GAAG,CAAC,SAAS,EAAE,2BAAmB,EAAE,wBAAwB,EAAE,aAAa,CAAC,CAAC,MAAM,CACjG,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CACxB,CAAC;IACF,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;QAC3B,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,KAAyB,CAAC;IAC9B,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;QACf,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC;YAAE,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,IAAI,SAAS,IAAI,2BAAmB,CAAC;AACnD,CAAC;AAGD,SAAgB,aAAa,CAAC,IAAU,EAAE,IAAY;IACpD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC/C,OAAO,EAAE,GAAG,EAAE,IAAA,oBAAa,EAAC,GAAG,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACpD,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,IAAI,eAAQ,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AACnD,CAAC;AAGD,SAAgB,cAAc,CAAC,IAAU,EAAE,IAAY,EAAE,GAAa;IACpE,MAAM,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;IAC3C,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;;QAC5C,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAC9B,CAAC;AAGD,SAAgB,WAAW,CAAC,GAAa,EAAE,IAAyB;IAClE,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnC,IAAI,IAAA,YAAK,EAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC7B,MAAM,GAAG,GAAG,IAAI,cAAO,EAAE,CAAC;IAC1B,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACrB,OAAO,GAAG,CAAC;AACb,CAAC;AAGD,SAAgB,WAAW,CAAC,GAAa,EAAE,IAAyB;IAClE,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnC,IAAI,IAAA,YAAK,EAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC7B,MAAM,GAAG,GAAG,IAAI,cAAO,EAAE,CAAC;IAC1B,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACrB,OAAO,GAAG,CAAC;AACb,CAAC;AAGD,SAAgB,gBAAgB,CAC9B,GAAa,EACb,IAAyB,EACzB,QAAgB,EAChB,GAAW;IAEX,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,IAAA,YAAK,EAAC,IAAI,CAAC;QAAE,OAAO,SAAS,CAAC;IACnC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,EAAiB,EAAE,CAAC,IAAA,YAAK,EAAC,EAAE,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;AACvG,CAAC;AAGD,SAAgB,aAAa,CAAC,GAAa,EAAE,IAAyB,EAAE,QAAgB,EAAE,GAAW;IACnG,OAAO,CAAC,CAAC,gBAAgB,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;AACtD,CAAC;AAgBD,SAAgB,kBAAkB,CAChC,GAAa,EACb,IAAyB,EACzB,QAAgB,EAChB,IAA6B,EAC7B,OAAsB,EAAE;IAExB,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAC7B,CAAC,EAAE,EAAiB,EAAE,CAAC,IAAA,YAAK,EAAC,EAAE,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CACzF,CAAC;IAEF,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC,KAAK,CAAY,CAAC;QAC9C,IAAI,IAAI,CAAC,aAAa;YAAE,IAAI,CAAC,aAAa,GAAG,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;QAItE,GAAG,CAAC,IAAI,GAAG,KAAK,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;QAClB,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACd,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,SAAS;QAAE,OAAO,WAAW,CAAC;IAExC,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC;IACnC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3C,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IACD,OAAO,QAAQ,CAAC,QAAQ,EAAE,KAAK,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;AAClE,CAAC;AAGD,SAAgB,KAAK,CAAC,GAAa,EAAE,IAAyB,EAAE,KAAc;IAC5E,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,IAAI,KAAK,SAAS,CAAC;IACnC,IAAI,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,WAAW,CAAC;IAClF,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IACvC,OAAO,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;AACzC,CAAC;AAGD,SAAgB,kBAAkB,CAChC,GAAa,EACb,IAAyB,EACzB,QAAgB,EAChB,GAAW;IAEX,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,IAAA,YAAK,EAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAA,YAAK,EAAC,EAAE,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAChG,IAAI,GAAG,KAAK,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IAC7B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAC1B,OAAO,IAAI,CAAC;AACd,CAAC;AAGD,SAAgB,SAAS,CAAC,GAAa,EAAE,IAAyB;IAChE,OAAO,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAChC,CAAC;AAED,SAAS,cAAc,CAAC,GAA4B;IAClD,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACzC,IAAI,CAAC,KAAK,SAAS;YAAE,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/schematics/utils/yaml-config.util.ts

@@ -0,0 +1,167 @@
+import { Tree } from '@angular-devkit/schematics';
+import { Document, isMap, isSeq, parseDocument, YAMLMap, YAMLSeq } from 'yaml';
+
+/**
+ * Comment-preserving `config.yaml` editing shared by every YAML schematic.
+ *
+ * All edits go through the `yaml` (eemeli) CST/Document API so existing comments, key order and
+ * formatting survive a round-trip — a plain `js-yaml` load/dump would strip them. The helpers are
+ * deliberately data-only: prompting and the "create the missing dependency?" flow live in each
+ * schematic's index.ts, so this module never triggers interactive I/O and stays easy to unit-test.
+ */
+
+export const DEFAULT_CONFIG_PATH = 'config/config.yaml';
+
+/** Outcome of an idempotent upsert, surfaced to the user as a log line. */
+export type UpsertOutcome = 'created' | 'updated' | 'unchanged';
+
+/** Locate the project's config.yaml, preferring an explicit path, then the usual locations, then a scan. */
+export function findConfigYaml(tree: Tree, preferred?: string): string {
+  const candidates = [preferred, DEFAULT_CONFIG_PATH, 'src/config/config.yaml', 'config.yaml'].filter(
+    (c): c is string => !!c,
+  );
+  for (const c of candidates) {
+    if (tree.exists(c)) return c;
+  }
+  let found: string | undefined;
+  tree.visit((p) => {
+    if (!found && p.endsWith('/config.yaml')) found = p.replace(/^\//, '');
+  });
+  return found || preferred || DEFAULT_CONFIG_PATH;
+}
+
+/** Parse the config into a mutable Document (or a fresh empty one when the file does not exist yet). */
+export function readConfigDoc(tree: Tree, path: string): { doc: Document; existed: boolean } {
+  if (tree.exists(path)) {
+    const raw = tree.read(path)!.toString('utf-8');
+    return { doc: parseDocument(raw), existed: true };
+  }
+  return { doc: new Document({}), existed: false };
+}
+
+/** Serialize the Document back to the tree (create or overwrite). `lineWidth: 0` disables line wrapping. */
+export function writeConfigDoc(tree: Tree, path: string, doc: Document): void {
+  const out = doc.toString({ lineWidth: 0 });
+  if (tree.exists(path)) tree.overwrite(path, out);
+  else tree.create(path, out);
+}
+
+/** Ensure `path` resolves to a YAMLSeq, creating (and any missing parent maps) if needed. */
+export function ensureSeqAt(doc: Document, path: (string | number)[]): YAMLSeq {
+  const node = doc.getIn(path, true);
+  if (isSeq(node)) return node;
+  const seq = new YAMLSeq();
+  doc.setIn(path, seq);
+  return seq;
+}
+
+/** Ensure `path` resolves to a YAMLMap, creating (and any missing parent maps) if needed. */
+export function ensureMapAt(doc: Document, path: (string | number)[]): YAMLMap {
+  const node = doc.getIn(path, true);
+  if (isMap(node)) return node;
+  const map = new YAMLMap();
+  doc.setIn(path, map);
+  return map;
+}
+
+/** Find a map item in the seq at `path` whose `keyField` equals `key` (string-compared). */
+export function findSeqItemByKey(
+  doc: Document,
+  path: (string | number)[],
+  keyField: string,
+  key: string,
+): YAMLMap | undefined {
+  const node = doc.getIn(path, true);
+  if (!isSeq(node)) return undefined;
+  return node.items.find((it): it is YAMLMap => isMap(it) && String(it.get(keyField)) === String(key));
+}
+
+/** True when a map keyed by `keyField === key` already exists in the seq at `path`. */
+export function seqItemExists(doc: Document, path: (string | number)[], keyField: string, key: string): boolean {
+  return !!findSeqItemByKey(doc, path, keyField, key);
+}
+
+export interface UpsertOptions {
+  /** When the item already exists: merge `item`'s fields into it. Default false → leave it untouched. */
+  overwrite?: boolean;
+  /** A `# comment` attached above the newly created item (ignored when the item already exists). */
+  commentBefore?: string;
+}
+
+/**
+ * Idempotent upsert of `item` into the YAMLSeq at `path`, matched by `item[keyField]`.
+ *  - missing → appended (block style), optional leading comment → 'created'
+ *  - present & !overwrite → left as-is → 'unchanged'
+ *  - present & overwrite → each field of `item` is set on the existing map → 'updated'/'unchanged'
+ * `undefined` fields in `item` are skipped so callers can pass sparse specs.
+ */
+export function upsertSeqItemByKey(
+  doc: Document,
+  path: (string | number)[],
+  keyField: string,
+  item: Record<string, unknown>,
+  opts: UpsertOptions = {},
+): UpsertOutcome {
+  const seq = ensureSeqAt(doc, path);
+  const clean = stripUndefined(item);
+  const existing = seq.items.find(
+    (it): it is YAMLMap => isMap(it) && String(it.get(keyField)) === String(clean[keyField]),
+  );
+
+  if (!existing) {
+    const node = doc.createNode(clean) as YAMLMap;
+    if (opts.commentBefore) node.commentBefore = ` ${opts.commentBefore}`;
+    // Normalize the container to block style: a config seeded with an empty flow seq (`topics: []`)
+    // would otherwise render every appended item inline (`[ { name: ... } ]`). Block is the readable,
+    // diff-friendly form the rest of the config uses.
+    seq.flow = false;
+    node.flow = false;
+    seq.add(node);
+    return 'created';
+  }
+
+  if (!opts.overwrite) return 'unchanged';
+
+  const before = existing.toString();
+  for (const [k, v] of Object.entries(clean)) {
+    existing.set(k, doc.createNode(v));
+  }
+  return existing.toString() === before ? 'unchanged' : 'updated';
+}
+
+/** Set a scalar (or nested map/seq) at `path`, creating parents. Returns whether the value changed. */
+export function setIn(doc: Document, path: (string | number)[], value: unknown): UpsertOutcome {
+  const prev = doc.getIn(path, false);
+  const existed = prev !== undefined;
+  if (existed && JSON.stringify(prev) === JSON.stringify(value)) return 'unchanged';
+  doc.setIn(path, doc.createNode(value));
+  return existed ? 'updated' : 'created';
+}
+
+/** Delete the item keyed by `keyField === key` from the seq at `path`. Returns true when removed. */
+export function deleteSeqItemByKey(
+  doc: Document,
+  path: (string | number)[],
+  keyField: string,
+  key: string,
+): boolean {
+  const node = doc.getIn(path, true);
+  if (!isSeq(node)) return false;
+  const idx = node.items.findIndex((it) => isMap(it) && String(it.get(keyField)) === String(key));
+  if (idx === -1) return false;
+  node.items.splice(idx, 1);
+  return true;
+}
+
+/** Read a scalar value at `path` (JS value, not the wrapping node). */
+export function getScalar(doc: Document, path: (string | number)[]): unknown {
+  return doc.getIn(path, false);
+}
+
+function stripUndefined(obj: Record<string, unknown>): Record<string, unknown> {
+  const out: Record<string, unknown> = {};
+  for (const [k, v] of Object.entries(obj)) {
+    if (v !== undefined) out[k] = v;
+  }
+  return out;
+}