joist-codegen 2.0.3 → 2.1.0-next.1

package/build/docs/parsing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parsing.d.ts","sourceRoot":"","sources":["../../src/docs/parsing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAoB,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAInD,KAAK,WAAW,GAAG,CAAC,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG;IAC3G,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,KAAK,SAAS,GAAG,OAAO,GAAG;IACzB,QAAQ,CAAC,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAErE,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAED,iEAAiE;AACjE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM;;;;;EAiC/C;AAgBD;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,CAQxE;AAED,0DAA0D;AAC1D,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,MAAM,CAOtE"}

package/build/docs/parsing.js

@@ -0,0 +1,109 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseEntityJSDocs = parseEntityJSDocs;
+exports.buildJSDocEdit = buildJSDocEdit;
+exports.applyEdits = applyEdits;
+const jscodeshift_1 = __importDefault(require("jscodeshift"));
+const j = jscodeshift_1.default.withParser("ts");
+j;
+/** Parse an entity .ts file and extract class + member JSDoc. */
+function parseEntityJSDocs(source) {
+    const root = j(source);
+    let classDoc;
+    let classNode;
+    const members = [];
+    root.find(j.ExportNamedDeclaration).forEach((p) => {
+        if (p.node.declaration?.type === "ClassDeclaration") {
+            classDoc = extractJSDoc(p.node);
+            classNode = p.node;
+        }
+    });
+    root.find(j.ClassProperty).forEach((p) => {
+        const name = p.node.key?.name;
+        if (name) {
+            members.push({ name, kind: "property", doc: extractJSDoc(p.node), node: p.node });
+        }
+    });
+    root.find(j.ClassMethod).forEach((p) => {
+        const name = p.node.key?.name;
+        if (name) {
+            members.push({
+                name,
+                kind: classMethodKind(p.node),
+                doc: extractJSDoc(p.node),
+                node: p.node,
+            });
+        }
+    });
+    return { classDoc, classNode, members, fieldDocs: collectFieldDocs(members) };
+}
+/**
+ * Collect field docs from members for backfill.
+ * When a getter and setter share the same name, prefer the getter's doc.
+ */
+function collectFieldDocs(members) {
+    const result = {};
+    for (const m of members) {
+        if (!m.doc || m.kind === "method")
+            continue;
+        if (result[m.name] && m.kind === "setter")
+            continue;
+        result[m.name] = m.doc;
+    }
+    return result;
+}
+/**
+ * Build a source edit that sets the JSDoc on a node (replacing existing or inserting new).
+ *
+ * (This is bizarre, but this `SourceEdit` + `applyEdits` leaves all existing formatting
+ * alone better than doing a `node.toSource()` or other AST-based updates. :grimmacing:)
+ */
+function buildJSDocEdit(node, text) {
+    const column = node.loc.start.column;
+    const existingComment = node.comments?.find((c) => c.leading && "value" in c && c.value.startsWith("*"));
+    if (existingComment) {
+        return { start: existingComment.start, end: existingComment.end, text: buildJSDocBlock(text, column) };
+    }
+    const indent = " ".repeat(column);
+    return { start: node.start, end: node.start, text: buildJSDocBlock(text, column) + "\n" + indent };
+}
+/** Apply edits to source by splicing in reverse order. */
+function applyEdits(source, edits) {
+    const sorted = [...edits].sort((a, b) => b.start - a.start);
+    let result = source;
+    for (const edit of sorted) {
+        result = result.slice(0, edit.start) + edit.text + result.slice(edit.end);
+    }
+    return result;
+}
+/** Build a JSDoc block comment string from plain text. */
+function buildJSDocBlock(text, indent) {
+    const pad = " ".repeat(indent);
+    const lines = text.split("\n");
+    if (lines.length === 1)
+        return `/** ${lines[0]} */`;
+    return `/**\n` + lines.map((l) => (l ? `${pad} * ${l}` : `${pad} *`)).join("\n") + `\n${pad} */`;
+}
+/** Extract text from a JSDoc-style leading block comment (i.e. one starting with `*`). */
+function extractJSDoc(node) {
+    const block = node.comments?.find((c) => c.leading && "value" in c && c.value.startsWith("*"));
+    if (!block || !("value" in block))
+        return undefined;
+    const lines = block.value.split("\n").map((l) => l.replace(/^\s*\*\s?/, "").trimEnd());
+    while (lines.length > 0 && lines[0].trim() === "")
+        lines.shift();
+    while (lines.length > 0 && lines[lines.length - 1].trim() === "")
+        lines.pop();
+    return lines.join("\n") || undefined;
+}
+function classMethodKind(node) {
+    if (node.kind === "get")
+        return "getter";
+    if (node.kind === "set")
+        return "setter";
+    return "method";
+}
+//# sourceMappingURL=parsing.js.map

package/build/docs/parsing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parsing.js","sourceRoot":"","sources":["../../src/docs/parsing.ts"],"names":[],"mappings":";;;;;AAiCA,8CAiCC;AAsBD,wCAQC;AAGD,gCAOC;AAzGD,8DAAmD;AAEnD,MAAM,CAAC,GAAG,qBAAW,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AAMvC,CAAC,CAAC;AAuBF,iEAAiE;AACjE,SAAgB,iBAAiB,CAAC,MAAc;IAC9C,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;IACvB,IAAI,QAA4B,CAAC;IACjC,IAAI,SAAgC,CAAC;IACrC,MAAM,OAAO,GAAiB,EAAE,CAAC;IAEjC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QAChD,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,KAAK,kBAAkB,EAAE,CAAC;YACpD,QAAQ,GAAG,YAAY,CAAC,CAAC,CAAC,IAAiB,CAAC,CAAC;YAC7C,SAAS,GAAG,CAAC,CAAC,IAAiB,CAAC;QAClC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QACvC,MAAM,IAAI,GAAI,CAAC,CAAC,IAAI,CAAC,GAA6B,EAAE,IAAI,CAAC;QACzD,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC,IAAiB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAiB,EAAE,CAAC,CAAC;QAC9G,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QACrC,MAAM,IAAI,GAAI,CAAC,CAAC,IAAI,CAAC,GAA6B,EAAE,IAAI,CAAC;QACzD,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,CAAC,IAAI,CAAC;gBACX,IAAI;gBACJ,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC7B,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC,IAAiB,CAAC;gBACtC,IAAI,EAAE,CAAC,CAAC,IAAiB;aAC1B,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;AAChF,CAAC;AAED;;;GAGG;AACH,SAAS,gBAAgB,CAAC,OAAqB;IAC7C,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;QACxB,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ;YAAE,SAAS;QAC5C,IAAI,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ;YAAE,SAAS;QACpD,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC;IACzB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,IAAe,EAAE,IAAY;IAC1D,MAAM,MAAM,GAAG,IAAI,CAAC,GAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IACtC,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IACzG,IAAI,eAAe,EAAE,CAAC;QACpB,OAAO,EAAE,KAAK,EAAE,eAAe,CAAC,KAAM,EAAE,GAAG,EAAE,eAAe,CAAC,GAAI,EAAE,IAAI,EAAE,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;IAC3G,CAAC;IACD,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAClC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,KAAM,EAAE,GAAG,EAAE,IAAI,CAAC,KAAM,EAAE,IAAI,EAAE,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,IAAI,GAAG,MAAM,EAAE,CAAC;AACvG,CAAC;AAED,0DAA0D;AAC1D,SAAgB,UAAU,CAAC,MAAc,EAAE,KAAmB;IAC5D,MAAM,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;IAC5D,IAAI,MAAM,GAAG,MAAM,CAAC;IACpB,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;QAC1B,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5E,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,0DAA0D;AAC1D,SAAS,eAAe,CAAC,IAAY,EAAE,MAAc;IACnD,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;IACpD,OAAO,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,GAAG,KAAK,CAAC;AACnG,CAAC;AAED,0FAA0F;AAC1F,SAAS,YAAY,CAAC,IAAe;IACnC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/F,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,OAAO,IAAI,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACpD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IACvF,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,KAAK,CAAC,KAAK,EAAE,CAAC;IACjE,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,KAAK,CAAC,GAAG,EAAE,CAAC;IAC9E,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;AACvC,CAAC;AAED,SAAS,eAAe,CAAC,IAA4B;IACnD,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK;QAAE,OAAO,QAAQ,CAAC;IACzC,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK;QAAE,OAAO,QAAQ,CAAC;IACzC,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/build/docs/parsing.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=parsing.test.d.ts.map

package/build/docs/parsing.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parsing.test.d.ts","sourceRoot":"","sources":["../../src/docs/parsing.test.ts"],"names":[],"mappings":""}

package/build/docs/parsing.test.js

@@ -0,0 +1,190 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const parsing_1 = require("./parsing");
+describe("parsing", () => {
+    describe("parseEntityJSDocs", () => {
+        it("extracts class-level JSDoc", () => {
+            const source = ["/** The Author entity. */", "export class Author extends AuthorCodegen {}"].join("\n");
+            const { classDoc } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(classDoc).toBe("The Author entity.");
+        });
+        it("extracts class-level JSDoc when no doc present", () => {
+            const source = "export class Author extends AuthorCodegen {}";
+            const { classDoc } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(classDoc).toBeUndefined();
+        });
+        it("extracts field JSDoc from class properties", () => {
+            const source = [
+                "export class Author extends AuthorCodegen {",
+                "  /** The first name. */",
+                '  readonly firstName: string = "";',
+                '  lastName: string = "";',
+                "}",
+            ].join("\n");
+            const { members } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(members).toMatchObject([
+                { name: "firstName", kind: "property", doc: "The first name." },
+                { name: "lastName", kind: "property", doc: undefined },
+            ]);
+        });
+        it("extracts JSDoc from getters, setters, and methods", () => {
+            const source = [
+                "export class Author extends AuthorCodegen {",
+                "  /** Getter doc. */",
+                '  get fullName(): string { return ""; }',
+                "  /** Setter doc. */",
+                "  set fullName(v: string) {}",
+                "  /** Method doc. */",
+                "  async doStuff(): Promise<void> {}",
+                "}",
+            ].join("\n");
+            const { members } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(members).toMatchObject([
+                { name: "fullName", kind: "getter", doc: "Getter doc." },
+                { name: "fullName", kind: "setter", doc: "Setter doc." },
+                { name: "doStuff", kind: "method", doc: "Method doc." },
+            ]);
+        });
+        it("handles multi-line JSDoc", () => {
+            const source = [
+                "export class Author extends AuthorCodegen {",
+                "  /**",
+                "   * Line one.",
+                "   * Line two.",
+                "   */",
+                '  readonly notes: string = "";',
+                "}",
+            ].join("\n");
+            const { members } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(members[0].doc).toBe("Line one.\nLine two.");
+        });
+    });
+    describe("buildJSDocEdit / applyEdits", () => {
+        it("does not produce trailing spaces on blank lines in multi-line docs", () => {
+            const source = ["export class Author extends AuthorCodegen {", '  readonly notes: string = "";', "}"].join("\n");
+            const { members } = (0, parsing_1.parseEntityJSDocs)(source);
+            const edit = (0, parsing_1.buildJSDocEdit)(members[0].node, "First paragraph.\n\nSecond paragraph.");
+            const output = (0, parsing_1.applyEdits)(source, [edit]);
+            for (const line of output.split("\n")) {
+                expect(line).toBe(line.trimEnd());
+            }
+            expect(output).toMatch(/\* First paragraph\.\n\s+\*\n\s+\* Second paragraph\./);
+        });
+        it("replaces an existing comment without reformatting other code", () => {
+            const source = [
+                "/** Old class doc. */",
+                "export class Foo {",
+                "  /** Old field doc. */",
+                '  readonly name: string = "";',
+                "}",
+            ].join("\n");
+            const { classNode, members } = (0, parsing_1.parseEntityJSDocs)(source);
+            const edits = [(0, parsing_1.buildJSDocEdit)(classNode, "New class doc."), (0, parsing_1.buildJSDocEdit)(members[0].node, "New field doc.")];
+            const output = (0, parsing_1.applyEdits)(source, edits);
+            expect(output).toBe([
+                "/** New class doc. */",
+                "export class Foo {",
+                "  /** New field doc. */",
+                '  readonly name: string = "";',
+                "}",
+            ].join("\n"));
+        });
+        it("inserts a new comment where none existed", () => {
+            const source = ["export class Foo {", '  readonly name: string = "";', "}"].join("\n");
+            const { members } = (0, parsing_1.parseEntityJSDocs)(source);
+            const output = (0, parsing_1.applyEdits)(source, [(0, parsing_1.buildJSDocEdit)(members[0].node, "The name.")]);
+            expect(output).toBe(["export class Foo {", "  /** The name. */", '  readonly name: string = "";', "}"].join("\n"));
+        });
+        it("indents multi-line field docs to match the field's indentation", () => {
+            const source = [
+                "export class Invoice extends InvoiceCodegen {",
+                "  /** Old doc. */",
+                "  readonly pocInvoicedToDateInCents: number = 0;",
+                "}",
+            ].join("\n");
+            const { members } = (0, parsing_1.parseEntityJSDocs)(source);
+            const text = "Calculate the POC as of this invoice creation.\nFilter out Void and Rejected invoices.";
+            const output = (0, parsing_1.applyEdits)(source, [(0, parsing_1.buildJSDocEdit)(members[0].node, text)]);
+            expect(output).toBe([
+                "export class Invoice extends InvoiceCodegen {",
+                "  /**",
+                "   * Calculate the POC as of this invoice creation.",
+                "   * Filter out Void and Rejected invoices.",
+                "   */",
+                "  readonly pocInvoicedToDateInCents: number = 0;",
+                "}",
+            ].join("\n"));
+        });
+        it("preserves all original formatting when replacing docs", () => {
+            const source = [
+                "/** The entity. */",
+                "export class Author extends AuthorCodegen {",
+                "  readonly transientFields = {",
+                '    beforeFlushRan: { type: "boolean", default: false },',
+                '    beforeCreateRan: { type: "boolean", default: false },',
+                "  };",
+                "}",
+            ].join("\n");
+            const { classNode } = (0, parsing_1.parseEntityJSDocs)(source);
+            const output = (0, parsing_1.applyEdits)(source, [(0, parsing_1.buildJSDocEdit)(classNode, "Updated entity.")]);
+            expect(output).toBe([
+                "/** Updated entity. */",
+                "export class Author extends AuthorCodegen {",
+                "  readonly transientFields = {",
+                '    beforeFlushRan: { type: "boolean", default: false },',
+                '    beforeCreateRan: { type: "boolean", default: false },',
+                "  };",
+                "}",
+            ].join("\n"));
+        });
+    });
+    describe("fieldDocs", () => {
+        it("prefers getter doc over setter doc for same name", () => {
+            const source = [
+                "export class Author extends AuthorCodegen {",
+                "  /** The full name. */",
+                '  get fullName(): string { return ""; }',
+                "  /** Set the full name. */",
+                "  set fullName(v: string) {}",
+                "}",
+            ].join("\n");
+            const { fieldDocs } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(fieldDocs).toEqual({ fullName: "The full name." });
+        });
+        it("uses setter doc when getter has no doc", () => {
+            const source = [
+                "export class Author extends AuthorCodegen {",
+                '  get fullName(): string { return ""; }',
+                "  /** Set the full name. */",
+                "  set fullName(v: string) {}",
+                "}",
+            ].join("\n");
+            const { fieldDocs } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(fieldDocs).toEqual({ fullName: "Set the full name." });
+        });
+        it("skips members without docs", () => {
+            const source = [
+                "export class Author extends AuthorCodegen {",
+                "  /** A doc. */",
+                '  readonly a: string = "";',
+                '  readonly b: string = "";',
+                "}",
+            ].join("\n");
+            const { fieldDocs } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(fieldDocs).toEqual({ a: "A doc." });
+        });
+        it("skips methods", () => {
+            const source = [
+                "export class Author extends AuthorCodegen {",
+                "  /** The first name. */",
+                '  readonly firstName: string = "";',
+                "  /** Text representation. */",
+                "  async toDetailString(): Promise<string> { return ''; }",
+                "}",
+            ].join("\n");
+            const { fieldDocs } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(fieldDocs).toEqual({ firstName: "The first name." });
+        });
+    });
+});
+//# sourceMappingURL=parsing.test.js.map

package/build/docs/parsing.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parsing.test.js","sourceRoot":"","sources":["../../src/docs/parsing.test.ts"],"names":[],"mappings":";;AAAA,uCAA0E;AAE1E,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;YACpC,MAAM,MAAM,GAAG,CAAC,2BAA2B,EAAE,8CAA8C,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxG,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC/C,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACxD,MAAM,MAAM,GAAG,8CAA8C,CAAC;YAC9D,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC/C,MAAM,CAAC,QAAQ,CAAC,CAAC,aAAa,EAAE,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,MAAM,GAAG;gBACb,6CAA6C;gBAC7C,0BAA0B;gBAC1B,oCAAoC;gBACpC,0BAA0B;gBAC1B,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;gBAC5B,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,iBAAiB,EAAE;gBAC/D,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE;aACvD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YAC3D,MAAM,MAAM,GAAG;gBACb,6CAA6C;gBAC7C,sBAAsB;gBACtB,yCAAyC;gBACzC,sBAAsB;gBACtB,8BAA8B;gBAC9B,sBAAsB;gBACtB,qCAAqC;gBACrC,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;gBAC5B,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,aAAa,EAAE;gBACxD,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,aAAa,EAAE;gBACxD,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,aAAa,EAAE;aACxD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;YAClC,MAAM,MAAM,GAAG;gBACb,6CAA6C;gBAC7C,OAAO;gBACP,gBAAgB;gBAChB,gBAAgB;gBAChB,OAAO;gBACP,gCAAgC;gBAChC,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;QAC3C,EAAE,CAAC,oEAAoE,EAAE,GAAG,EAAE;YAC5E,MAAM,MAAM,GAAG,CAAC,6CAA6C,EAAE,gCAAgC,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjH,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,IAAI,GAAG,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,uCAAuC,CAAC,CAAC;YACtF,MAAM,MAAM,GAAG,IAAA,oBAAU,EAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;YAC1C,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACtC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;YACpC,CAAC;YACD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,uDAAuD,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;YACtE,MAAM,MAAM,GAAG;gBACb,uBAAuB;gBACvB,oBAAoB;gBACpB,yBAAyB;gBACzB,+BAA+B;gBAC/B,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YACzD,MAAM,KAAK,GAAG,CAAC,IAAA,wBAAc,EAAC,SAAU,EAAE,gBAAgB,CAAC,EAAE,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;YAChH,MAAM,MAAM,GAAG,IAAA,oBAAU,EAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YACzC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CACjB;gBACE,uBAAuB;gBACvB,oBAAoB;gBACpB,yBAAyB;gBACzB,+BAA+B;gBAC/B,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;YAClD,MAAM,MAAM,GAAG,CAAC,oBAAoB,EAAE,+BAA+B,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACvF,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,MAAM,GAAG,IAAA,oBAAU,EAAC,MAAM,EAAE,CAAC,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;YAClF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CACjB,CAAC,oBAAoB,EAAE,oBAAoB,EAAE,+BAA+B,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAC9F,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;YACxE,MAAM,MAAM,GAAG;gBACb,+CAA+C;gBAC/C,mBAAmB;gBACnB,kDAAkD;gBAClD,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,IAAI,GAAG,wFAAwF,CAAC;YACtG,MAAM,MAAM,GAAG,IAAA,oBAAU,EAAC,MAAM,EAAE,CAAC,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;YAC3E,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CACjB;gBACE,+CAA+C;gBAC/C,OAAO;gBACP,qDAAqD;gBACrD,6CAA6C;gBAC7C,OAAO;gBACP,kDAAkD;gBAClD,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,MAAM,GAAG;gBACb,oBAAoB;gBACpB,6CAA6C;gBAC7C,gCAAgC;gBAChC,0DAA0D;gBAC1D,2DAA2D;gBAC3D,MAAM;gBACN,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,IAAA,oBAAU,EAAC,MAAM,EAAE,CAAC,IAAA,wBAAc,EAAC,SAAU,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;YACnF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CACjB;gBACE,wBAAwB;gBACxB,6CAA6C;gBAC7C,gCAAgC;gBAChC,0DAA0D;gBAC1D,2DAA2D;gBAC3D,MAAM;gBACN,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QACzB,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,MAAM,GAAG;gBACb,6CAA6C;gBAC7C,yBAAyB;gBACzB,yCAAyC;gBACzC,6BAA6B;gBAC7B,8BAA8B;gBAC9B,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAChD,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,MAAM,GAAG;gBACb,6CAA6C;gBAC7C,yCAAyC;gBACzC,6BAA6B;gBAC7B,8BAA8B;gBAC9B,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAChD,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,oBAAoB,EAAE,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;YACpC,MAAM,MAAM,GAAG;gBACb,6CAA6C;gBAC7C,iBAAiB;gBACjB,4BAA4B;gBAC5B,4BAA4B;gBAC5B,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAChD,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;YACvB,MAAM,MAAM,GAAG;gBACb,6CAA6C;gBAC7C,0BAA0B;gBAC1B,oCAAoC;gBACpC,+BAA+B;gBAC/B,0DAA0D;gBAC1D,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAChD,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/build/generate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AACA,OAAO,EAAQ,WAAW,EAAY,MAAM,SAAS,CAAC;AAStD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAI7C,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CAC/D;AAED,uFAAuF;AACvF,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAsH9F"}
+{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AACA,OAAO,EAAQ,WAAW,EAAY,MAAM,SAAS,CAAC;AAStD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAK7C,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CAC/D;AAED,uFAAuF;AACvF,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAgI9F"}

package/build/generate.js

@@ -13,6 +13,7 @@ const generateMetadataFile_1 = require("./generateMetadataFile");
 const generatePgEnumFile_1 = require("./generatePgEnumFile");
 const symbols_1 = require("./symbols");
 const utils_1 = require("./utils");
+const docs_1 = require("./docs");
 /** Generates our `${Entity}` and `${Entity}Codegen` files based on the `db` schema. */
 async function generateFiles(config, dbMeta) {
     const { entities, enums, pgEnums } = dbMeta;
@@ -20,6 +21,11 @@ async function generateFiles(config, dbMeta) {
     // skip making test files except for the _first_ time we create an entity. This achieves
     // `.history`-like "create once" behavior without the need for the `.history` file.
     const files = await readExistingFiles(config);
+    // Sync documentation: backfill .md from existing JSDocs, then sync MD -> JSDoc
+    if (config.docs) {
+        const entityNames = entities.map((meta) => meta.entity.name);
+        await (0, docs_1.syncDocs)(config.entitiesDirectory, entityNames);
+    }
     const entityFiles = entities
         .map((meta) => {
         const entityName = meta.entity.name;
@@ -107,6 +113,8 @@ async function generateFiles(config, dbMeta) {
         const plugin = require(p);
         return plugin.run(config, dbMeta);
     }))).flat();
+    // Generate metadata-docs.ts if enabled
+    const docsFile = config.outputDocs ? await (0, docs_1.generateMetadataDocsFile)(config, dbMeta) : undefined;
     return [
         ...entityFiles,
         ...enumFiles,
@@ -114,6 +122,7 @@ async function generateFiles(config, dbMeta) {
         entitiesFile,
         ...factoriesFiles,
         metadataFile,
+        ...(docsFile ? [docsFile] : []),
         indexFile,
         ...pluginFiles,
     ];

package/build/generate.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate.js","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":";;AAwBA,sCAsHC;AA9ID,0CAAsC;AACtC,qCAAsD;AACtD,iEAA8D;AAC9D,2EAAmF;AACnF,6DAA0D;AAC1D,qEAAkE;AAClE,yDAAsD;AACtD,qEAAkE;AAClE,iEAA8D;AAC9D,6DAA0D;AAE1D,uCAA4F;AAC5F,mCAAmD;AAWnD,uFAAuF;AAChF,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAkB;IACpE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAE5C,2FAA2F;IAC3F,wFAAwF;IACxF,mFAAmF;IACnF,MAAM,KAAK,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAE9C,MAAM,WAAW,GAAG,QAAQ;SACzB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACZ,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACpC,MAAM,aAAa,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,UAAU,KAAK,CAAC,CAAC;QACzD,OAAO;YACL;gBACE,IAAI,EAAE,aAAa,UAAU,YAAY;gBACzC,QAAQ,EAAE,IAAA,qDAAyB,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC;gBACzD,SAAS,EAAE,IAAI;aAChB;YACD,GAAG,CAAC,aAAa;gBACf,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC;oBACE,EAAE,IAAI,EAAE,GAAG,UAAU,KAAK,EAAE,QAAQ,EAAE,IAAA,uCAAkB,EAAC,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE;oBAC1F,EAAE,IAAI,EAAE,GAAG,UAAU,UAAU,EAAE,QAAQ,EAAE,IAAA,+CAAsB,EAAC,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE;iBACpG,CAAC;SACP,CAAC;IACJ,CAAC,CAAC;SACD,MAAM,CAAC,aAAK,EAAE,EAAE,CAAC,CAAC;IAErB,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;SACnC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChB,MAAM,QAAQ,GAAG,IAAA,yBAAiB,EAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC3D,OAAO;YACL;gBACE,IAAI,EAAE,WAAW,QAAQ,KAAK;gBAC9B,QAAQ,EAAE,IAAA,mCAAgB,EAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC;gBACtD,SAAS,EAAE,IAAI;aAChB;SACF,CAAC;IACJ,CAAC,CAAC;SACD,MAAM,CAAC,aAAK,EAAE,EAAE,CAAC,CAAC;IACrB,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;SACvC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChB,OAAO;YACL;gBACE,IAAI,EAAE,WAAW,QAAQ,CAAC,IAAI,KAAK;gBACnC,QAAQ,EAAE,IAAA,uCAAkB,EAAC,MAAM,EAAE,QAAQ,CAAC;gBAC9C,SAAS,EAAE,IAAI;aAChB;SACF,CAAC;IACJ,CAAC,CAAC;SACD,MAAM,CAAC,aAAK,EAAE,EAAE,CAAC,CAAC;IAErB,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAA,aAAG,EAAC,KAAK,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/E,MAAM,OAAO,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,IAAA,aAAG,EAAC,KAAK,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAExF,MAAM,YAAY,GAAgB;QAChC,IAAI,EAAE,uBAAuB;QAC7B,QAAQ,EAAE,IAAA,cAAI,EAAA;QACV,0BAAgB;oBACJ,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO;;;qBAGhH,IAAA,aAAG,EAAC,eAAe,CAAC,YAAY,4BAAkB,IAAI,WAAW,aAAa,OAAO;;yBAEjF,IAAA,aAAG,EAAC,QAAQ,CAAC,YAAY,gBAAM;cAC1C,IAAA,qCAAS,EAAC,MAAM,CAAC;;;;QAIvB,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,2CAAoB,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;;oCAEtC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACnF,2BAAiB;KACpB;QACD,SAAS,EAAE,IAAI;QACf,YAAY,EAAE,EAAE,aAAa,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE;KACpD,CAAC;IAEF,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;SACrC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC;SACzB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAEhD,MAAM,YAAY,GAAgB;QAChC,IAAI,EAAE,eAAe;QACrB,QAAQ,EAAE,IAAA,2CAAoB,EAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACrF,SAAS,EAAE,IAAI;QACf,YAAY,EAAE,EAAE,aAAa,EAAE,EAAE,+BAA+B,EAAE,UAAU,EAAE,EAAE;KACjF,CAAC;IAEF,MAAM,cAAc,GAAkB,IAAA,+CAAsB,EAAC,QAAQ,CAAC,CAAC;IAEvE,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACrF,MAAM,SAAS,GAAgB;QAC7B,IAAI,EAAE,YAAY;QAClB,QAAQ,EAAE,IAAA,cAAI,EAAA,4BAA4B,MAAM,GAAG;QACnD,SAAS,EAAE,KAAK;KACjB,CAAC;IAEF,kFAAkF;IAClF,MAAM,WAAW,GAAkB,CACjC,MAAM,OAAO,CAAC,GAAG,CACf,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACtC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAkB,CAAC;QAC3C,OAAO,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC,CAAC,CACH,CACF,CAAC,IAAI,EAAE,CAAC;IAET,OAAO;QACL,GAAG,WAAW;QACd,GAAG,SAAS;QACZ,GAAG,WAAW;QACd,YAAY;QACZ,GAAG,cAAc;QACjB,YAAY;QACZ,SAAS;QACT,GAAG,WAAW;KACf,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,KAAK,UAAU,iBAAiB,CAAC,MAAc;IAC7C,IAAI,CAAC;QACH,OAAO,MAAM,IAAA,kBAAO,EAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACjD,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC"}
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":";;AAyBA,sCAgIC;AAzJD,0CAAsC;AACtC,qCAAsD;AACtD,iEAA8D;AAC9D,2EAAmF;AACnF,6DAA0D;AAC1D,qEAAkE;AAClE,yDAAsD;AACtD,qEAAkE;AAClE,iEAA8D;AAC9D,6DAA0D;AAE1D,uCAA4F;AAC5F,mCAAmD;AACnD,iCAA4D;AAW5D,uFAAuF;AAChF,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAkB;IACpE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAE5C,2FAA2F;IAC3F,wFAAwF;IACxF,mFAAmF;IACnF,MAAM,KAAK,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAE9C,+EAA+E;IAC/E,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7D,MAAM,IAAA,eAAQ,EAAC,MAAM,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,WAAW,GAAG,QAAQ;SACzB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACZ,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACpC,MAAM,aAAa,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,UAAU,KAAK,CAAC,CAAC;QACzD,OAAO;YACL;gBACE,IAAI,EAAE,aAAa,UAAU,YAAY;gBACzC,QAAQ,EAAE,IAAA,qDAAyB,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC;gBACzD,SAAS,EAAE,IAAI;aAChB;YACD,GAAG,CAAC,aAAa;gBACf,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC;oBACE,EAAE,IAAI,EAAE,GAAG,UAAU,KAAK,EAAE,QAAQ,EAAE,IAAA,uCAAkB,EAAC,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE;oBAC1F,EAAE,IAAI,EAAE,GAAG,UAAU,UAAU,EAAE,QAAQ,EAAE,IAAA,+CAAsB,EAAC,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE;iBACpG,CAAC;SACP,CAAC;IACJ,CAAC,CAAC;SACD,MAAM,CAAC,aAAK,EAAE,EAAE,CAAC,CAAC;IAErB,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;SACnC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChB,MAAM,QAAQ,GAAG,IAAA,yBAAiB,EAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC3D,OAAO;YACL;gBACE,IAAI,EAAE,WAAW,QAAQ,KAAK;gBAC9B,QAAQ,EAAE,IAAA,mCAAgB,EAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC;gBACtD,SAAS,EAAE,IAAI;aAChB;SACF,CAAC;IACJ,CAAC,CAAC;SACD,MAAM,CAAC,aAAK,EAAE,EAAE,CAAC,CAAC;IACrB,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;SACvC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChB,OAAO;YACL;gBACE,IAAI,EAAE,WAAW,QAAQ,CAAC,IAAI,KAAK;gBACnC,QAAQ,EAAE,IAAA,uCAAkB,EAAC,MAAM,EAAE,QAAQ,CAAC;gBAC9C,SAAS,EAAE,IAAI;aAChB;SACF,CAAC;IACJ,CAAC,CAAC;SACD,MAAM,CAAC,aAAK,EAAE,EAAE,CAAC,CAAC;IAErB,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAA,aAAG,EAAC,KAAK,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/E,MAAM,OAAO,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,IAAA,aAAG,EAAC,KAAK,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAExF,MAAM,YAAY,GAAgB;QAChC,IAAI,EAAE,uBAAuB;QAC7B,QAAQ,EAAE,IAAA,cAAI,EAAA;QACV,0BAAgB;oBACJ,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO;;;qBAGhH,IAAA,aAAG,EAAC,eAAe,CAAC,YAAY,4BAAkB,IAAI,WAAW,aAAa,OAAO;;yBAEjF,IAAA,aAAG,EAAC,QAAQ,CAAC,YAAY,gBAAM;cAC1C,IAAA,qCAAS,EAAC,MAAM,CAAC;;;;QAIvB,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,2CAAoB,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;;oCAEtC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACnF,2BAAiB;KACpB;QACD,SAAS,EAAE,IAAI;QACf,YAAY,EAAE,EAAE,aAAa,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE;KACpD,CAAC;IAEF,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;SACrC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC;SACzB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAEhD,MAAM,YAAY,GAAgB;QAChC,IAAI,EAAE,eAAe;QACrB,QAAQ,EAAE,IAAA,2CAAoB,EAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACrF,SAAS,EAAE,IAAI;QACf,YAAY,EAAE,EAAE,aAAa,EAAE,EAAE,+BAA+B,EAAE,UAAU,EAAE,EAAE;KACjF,CAAC;IAEF,MAAM,cAAc,GAAkB,IAAA,+CAAsB,EAAC,QAAQ,CAAC,CAAC;IAEvE,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACrF,MAAM,SAAS,GAAgB;QAC7B,IAAI,EAAE,YAAY;QAClB,QAAQ,EAAE,IAAA,cAAI,EAAA,4BAA4B,MAAM,GAAG;QACnD,SAAS,EAAE,KAAK;KACjB,CAAC;IAEF,kFAAkF;IAClF,MAAM,WAAW,GAAkB,CACjC,MAAM,OAAO,CAAC,GAAG,CACf,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACtC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAkB,CAAC;QAC3C,OAAO,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC,CAAC,CACH,CACF,CAAC,IAAI,EAAE,CAAC;IAET,uCAAuC;IACvC,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,IAAA,+BAAwB,EAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAEhG,OAAO;QACL,GAAG,WAAW;QACd,GAAG,SAAS;QACZ,GAAG,WAAW;QACd,YAAY;QACZ,GAAG,cAAc;QACjB,YAAY;QACZ,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/B,SAAS;QACT,GAAG,WAAW;KACf,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,KAAK,UAAU,iBAAiB,CAAC,MAAc;IAC7C,IAAI,CAAC;QACH,OAAO,MAAM,IAAA,kBAAO,EAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACjD,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC"}

package/build/generateEntityCodegenFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generateEntityCodegenFile.d.ts","sourceRoot":"","sources":["../src/generateEntityCodegenFile.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAuB,MAAM,SAAS,CAAC;AACpD,OAAO,EACL,UAAU,EAEV,gBAAgB,EAMhB,uBAAuB,EACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAyElC,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,uBAAuB,CAAC;CACpC;AAWD,+DAA+D;AAC/D,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,gBAAgB,GAAG,IAAI,CAyO1G;AA2wBD,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,uBAWvC"}
+{"version":3,"file":"generateEntityCodegenFile.d.ts","sourceRoot":"","sources":["../src/generateEntityCodegenFile.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAuB,MAAM,SAAS,CAAC;AACpD,OAAO,EACL,UAAU,EAEV,gBAAgB,EAMhB,uBAAuB,EACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AA0ElC,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,uBAAuB,CAAC;CACpC;AAWD,+DAA+D;AAC/D,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,gBAAgB,GAAG,IAAI,CAyO1G;AAmyBD,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,uBAWvC"}

package/build/generateEntityCodegenFile.js

@@ -810,7 +810,8 @@ function createRelations(config, meta, entity) {
         .filter((m2o) => m2o.otherEntity.name === meta.name)
         // Allow disabling recursive relations
         .filter((m2o) => 
-    // For STI - look at the baseClassName, since there is actually no configuration for the subtype currently
+    // STI subtypes don't have their own key in config.entities (stripped by stripStiPlaceholders),
+    // so look up the base class name to find skipRecursiveRelations config
     !(config.entities[meta.inheritanceType == "sti" && meta.baseClassName ? meta.baseClassName : meta.name]
         ?.relations?.[m2o.fieldName]?.skipRecursiveRelations === true))
         // Skip ReactiveReferences because they don't have an `other` side for us to use
@@ -835,6 +836,23 @@ function createRelations(config, meta, entity) {
             },
         ];
     });
+    // Add any recursive ManyToMany entities (self-referential m2m)
+    const m2mRecursive = meta.manyToManys
+        .filter((m2m) => m2m.otherEntity.name === meta.name)
+        .filter((m2m) => !m2m.derived)
+        // STI subtypes don't have their own key in config.entities (stripped by stripStiPlaceholders),
+        // so look up the base class name to find skipRecursiveRelations config
+        .filter((m2m) => !(config.entities[meta.inheritanceType == "sti" && meta.baseClassName ? meta.baseClassName : meta.name]
+        ?.relations?.[m2m.fieldName]?.skipRecursiveRelations === true))
+        .map((m2m) => {
+        const { fieldName, otherFieldName, otherEntity } = m2m;
+        return {
+            kind: "concrete",
+            fieldName: `${fieldName}Recursive`,
+            decl: (0, ts_poet_1.code) `${symbols_1.ReadOnlyCollection}<${entity.type}, ${otherEntity.type}>`,
+            init: (0, ts_poet_1.code) `${symbols_1.hasRecursiveM2m}("${fieldName}", "${otherFieldName}Recursive")`,
+        };
+    });
     // Add OneToMany
     const o2m = meta.oneToManys.map((o2m) => {
         const { fieldName, otherEntity } = o2m;
@@ -924,7 +942,7 @@ function createRelations(config, meta, entity) {
         const init = (0, ts_poet_1.code) `${symbols_1.hasOnePolymorphic}()`;
         return { kind: "concrete", fieldName, decl, init };
     });
-    return [o2m, o2mBase, lo2m, m2o, m2oBase, m2oRecursive, o2o, o2oBase, m2m, m2mBase, lm2m, polymorphic].flat();
+    return [o2m, o2mBase, lo2m, m2o, m2oBase, m2oRecursive, m2mRecursive, o2o, o2oBase, m2m, m2mBase, lm2m, polymorphic].flat();
 }
 /** Makes the field required if there is a `NOT NULL` and no db-or-config default. */
 function maybeOptionalOrDefault(field) {