@gtkx/codegen 1.0.0-rc.4 → 1.1.0

package/dist/writer/gtk-doc.js

@@ -1,6 +1,6 @@
 import { camelCase } from "@gtkx/utils";
 const CONSTANT_MAP = { TRUE: "true", FALSE: "false", NULL: "null" };
-const CALLABLE_LINK_KINDS = new Set(["method", "func", "ctor", "vfunc"]);
+const CALLABLE_LINK_KINDS = new Set(["method", "func", "ctor", "vfunc", "id"]);
 const SENTINEL = String.fromCodePoint(0xE0_00);
 const CODE_BLOCK_OPEN = "|[";
 const CODE_BLOCK_CLOSE = "]|";
@@ -8,10 +8,23 @@ const CODE_LANGUAGE_PATTERN = /^\s*<!--\s*language="([^"]*)"\s*-->/;
 const FENCED_BLOCK_PATTERN = /```[\s\S]*?```/g;
 const INLINE_CODE_PATTERN = /`[^`\n]*`/g;
 const LINK_PATTERN = /\[(\w+)@([\w.:%#-]+)\]/g;
-const CONSTANT_PATTERN = /(?<!\w)%(\w+)/g;
-const TYPE_REF_PATTERN = /(?<!\w)#(\w+)/g;
+const CONSTANT_PATTERN = /(?<![\w\\])%(\w+)/g;
+const ESCAPED_CONSTANT_PATTERN = /\\%/g;
+const TYPE_REF_PATTERN = /(?<!\w)#(\w+)(::[\w-]+|:[\w-]+)?/g;
 const PARAM_REF_PATTERN = /(?<!\w)@(\w+)/g;
 const FUNCTION_REF_PATTERN = /\b([a-z_][a-z0-9_]*)\(\)/g;
+const HTML_COMMENT_PATTERN = /<!--[\s\S]*?-->/g;
+const DOCBOOK_TAG_PATTERN = /<\/?(?:itemizedlist|listitem|para|literal|link|informalexample|programlisting)[\s>]/;
+const DOCBOOK_LISTING_OPEN = "<programlisting>";
+const DOCBOOK_LISTING_CLOSE = "</programlisting>";
+const DOCBOOK_EXAMPLE_PATTERN = /<\/?informalexample>\s*/g;
+const DOCBOOK_ITEM_OPEN_PATTERN = /<listitem>\s*(?:<para>\s*)?/g;
+const DOCBOOK_ITEM_CLOSE_PATTERN = /(?:<\/para>\s*)?<\/listitem>\s*/g;
+const DOCBOOK_LINK_PATTERN = /<link\s+linkend="[^"]*">([\s\S]*?)<\/link>/g;
+const DOCBOOK_LITERAL_PATTERN = /<literal>([\s\S]*?)<\/literal>/g;
+const DOCBOOK_LIST_PATTERN = /<\/?itemizedlist>\s*/g;
+const DOCBOOK_PARA_PATTERN = /<\/?para>\s*/g;
+const BLANK_LINE_RUN_PATTERN = /\n{3,}/g;
 const renderLink = (kind, target) => {
     const segments = target.split(/::|[.:]/);
     const lastIndex = segments.length - 1;
@@ -21,6 +34,13 @@ const renderLink = (kind, target) => {
     const symbol = segments.join(".");
     return `\`${symbol}${CALLABLE_LINK_KINDS.has(kind) ? "()" : ""}\``;
 };
+const renderTypeRef = (name, member) => {
+    if (member === undefined) {
+        return `\`${name}\``;
+    }
+    return renderLink(member.startsWith("::") ? "signal" : "property", `${name}${member}`);
+};
+const renderParamRef = (name, identifiers) => `\`${identifiers?.get(name) ?? name}\``;
 const trimTrailingNewlines = (value) => {
     let end = value.length;
     while (end > 0 && value[end - 1] === "\n") {
@@ -35,39 +55,68 @@ const renderCodeFence = (body) => {
     const code = trimTrailingNewlines(rest.trimStart());
     return `\`\`\`${fence}\n${code}\n\`\`\``;
 };
-const protectCodeBlocks = (raw, protect) => {
+const renderListing = (code) => `\n\`\`\`\n${code.trim()}\n\`\`\`\n`;
+const replaceDocBookTags = (text) => replaceDelimited(text, [DOCBOOK_LISTING_OPEN, DOCBOOK_LISTING_CLOSE], renderListing)
+    .replaceAll(DOCBOOK_EXAMPLE_PATTERN, "\n")
+    .replaceAll(DOCBOOK_ITEM_OPEN_PATTERN, "\n- ")
+    .replaceAll(DOCBOOK_ITEM_CLOSE_PATTERN, "\n")
+    .replaceAll(DOCBOOK_LINK_PATTERN, (_match, label) => label)
+    .replaceAll(DOCBOOK_LITERAL_PATTERN, (_match, literal) => `\`${literal}\``)
+    .replaceAll(DOCBOOK_LIST_PATTERN, "\n\n")
+    .replaceAll(DOCBOOK_PARA_PATTERN, "\n\n");
+const docBookToMarkdown = (text) => {
+    if (!DOCBOOK_TAG_PATTERN.test(text)) {
+        return text;
+    }
+    return replaceDocBookTags(text).replaceAll(BLANK_LINE_RUN_PATTERN, "\n\n").trim();
+};
+const replaceDelimited = (raw, bounds, render) => {
+    const [open, close] = bounds;
     let result = "";
     let cursor = 0;
     while (cursor < raw.length) {
-        const open = raw.indexOf(CODE_BLOCK_OPEN, cursor);
-        if (open === -1) {
+        const start = raw.indexOf(open, cursor);
+        if (start === -1) {
             break;
         }
-        const close = raw.indexOf(CODE_BLOCK_CLOSE, open + CODE_BLOCK_OPEN.length);
-        if (close === -1) {
+        const end = raw.indexOf(close, start + open.length);
+        if (end === -1) {
             break;
         }
-        result += raw.slice(cursor, open);
-        result += protect(renderCodeFence(raw.slice(open + CODE_BLOCK_OPEN.length, close)));
-        cursor = close + CODE_BLOCK_CLOSE.length;
+        result += raw.slice(cursor, start);
+        result += render(raw.slice(start + open.length, end));
+        cursor = end + close.length;
     }
     return result + raw.slice(cursor);
 };
-const gtkDocToMarkdown = (raw) => {
+const protectCodeBlocks = (raw, protect) => replaceDelimited(raw, [CODE_BLOCK_OPEN, CODE_BLOCK_CLOSE], (body) => protect(renderCodeFence(body)));
+const stripHtmlComments = (text) => {
+    let current = text;
+    let previous = "";
+    while (current !== previous) {
+        previous = current;
+        current = current.replaceAll(HTML_COMMENT_PATTERN, "");
+    }
+    return current;
+};
+// eslint-disable-next-line gtkx/no-library-prefix
+const gtkDocToMarkdown = (raw, identifiers) => {
     const stash = [];
     const protect = (value) => {
         const token = `${SENTINEL}${String(stash.length)}${SENTINEL}`;
         stash.push(value);
         return token;
     };
-    let text = protectCodeBlocks(raw, protect);
+    let text = protectCodeBlocks(docBookToMarkdown(raw), protect);
     text = text.replaceAll(FENCED_BLOCK_PATTERN, (block) => protect(block));
     text = text.replaceAll(INLINE_CODE_PATTERN, (span) => protect(span));
     text = text.replaceAll(LINK_PATTERN, (_match, kind, target) => protect(renderLink(kind, target)));
     text = text.replaceAll(CONSTANT_PATTERN, (_match, name) => protect(`\`${CONSTANT_MAP[name] ?? name}\``));
-    text = text.replaceAll(TYPE_REF_PATTERN, (_match, name) => protect(`\`${name}\``));
-    text = text.replaceAll(PARAM_REF_PATTERN, (_match, name) => protect(`\`${name}\``));
+    text = text.replaceAll(ESCAPED_CONSTANT_PATTERN, "%");
+    text = text.replaceAll(TYPE_REF_PATTERN, (_match, name, member) => protect(renderTypeRef(name, member)));
+    text = text.replaceAll(PARAM_REF_PATTERN, (_match, name) => protect(renderParamRef(name, identifiers)));
     text = text.replaceAll(FUNCTION_REF_PATTERN, (_match, name) => protect(`\`${name}()\``));
+    text = stripHtmlComments(text);
     for (let index = stash.length - 1; index >= 0; index -= 1) {
         const value = stash[index] ?? "";
         text = text.replaceAll(`${SENTINEL}${String(index)}${SENTINEL}`, () => value);

package/dist/writer/gtk-doc.js.map

@@ -1 +1 @@
-{"version":3,"file":"gtk-doc.js","sourceRoot":"","sources":["../../src/writer/gtk-doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,YAAY,GAA2B,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAC5F,MAAM,mBAAmB,GAAgB,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AACtF,MAAM,QAAQ,GAAG,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;AAC/C,MAAM,eAAe,GAAG,IAAI,CAAC;AAC7B,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAC9B,MAAM,qBAAqB,GAAG,qCAAqC,CAAC;AACpE,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;AAC/C,MAAM,mBAAmB,GAAG,YAAY,CAAC;AACzC,MAAM,YAAY,GAAG,yBAAyB,CAAC;AAC/C,MAAM,gBAAgB,GAAG,gBAAgB,CAAC;AAC1C,MAAM,gBAAgB,GAAG,gBAAgB,CAAC;AAC1C,MAAM,iBAAiB,GAAG,gBAAgB,CAAC;AAC3C,MAAM,oBAAoB,GAAG,2BAA2B,CAAC;AAEzD,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,MAAc,EAAU,EAAE;IACxD,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACzC,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;IAEtC,IAAI,IAAI,KAAK,UAAU,IAAI,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACvD,QAAQ,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAElC,OAAO,KAAK,MAAM,GAAG,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;AACvE,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,KAAa,EAAU,EAAE;IACnD,IAAI,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC;IAEvB,OAAO,GAAG,GAAG,CAAC,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QACxC,GAAG,IAAI,CAAC,CAAC;IACb,CAAC;IAED,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,IAAY,EAAU,EAAE;IAC7C,MAAM,aAAa,GAAG,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvD,MAAM,KAAK,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC9D,MAAM,IAAI,GAAG,aAAa,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACjF,MAAM,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IAEpD,OAAO,SAAS,KAAK,KAAK,IAAI,UAAU,CAAC;AAC7C,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,GAAW,EAAE,OAAkC,EAAU,EAAE;IAClF,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,OAAO,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;QAElD,IAAI,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC;YACd,MAAM;QACV,CAAC;QAED,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;QAE3E,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACf,MAAM;QACV,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAClC,MAAM,IAAI,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,GAAG,eAAe,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QACpF,MAAM,GAAG,KAAK,GAAG,gBAAgB,CAAC,MAAM,CAAC;IAC7C,CAAC;IAED,OAAO,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAU,EAAE;IAC7C,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,MAAM,OAAO,GAAG,CAAC,KAAa,EAAU,EAAE;QACtC,MAAM,KAAK,GAAG,GAAG,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,QAAQ,EAAE,CAAC;QAC9D,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAElB,OAAO,KAAK,CAAC;IACjB,CAAC,CAAC;IAEF,IAAI,IAAI,GAAG,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC3C,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IACxE,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,IAAY,EAAE,MAAc,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAClH,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,YAAY,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC;IACjH,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC;IAC3F,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC,MAAM,EAAE,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC;IAC5F,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,MAAM,EAAE,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC;IAEjG,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACxD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QACjC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,EAAE,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;IAClF,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC","sourcesContent":["import { camelCase } from \"@gtkx/utils\";\n\nconst CONSTANT_MAP: Record<string, string> = { TRUE: \"true\", FALSE: \"false\", NULL: \"null\" };\nconst CALLABLE_LINK_KINDS: Set<string> = new Set([\"method\", \"func\", \"ctor\", \"vfunc\"]);\nconst SENTINEL = String.fromCodePoint(0xE0_00);\nconst CODE_BLOCK_OPEN = \"|[\";\nconst CODE_BLOCK_CLOSE = \"]|\";\nconst CODE_LANGUAGE_PATTERN = /^\\s*<!--\\s*language=\"([^\"]*)\"\\s*-->/;\nconst FENCED_BLOCK_PATTERN = /```[\\s\\S]*?```/g;\nconst INLINE_CODE_PATTERN = /`[^`\\n]*`/g;\nconst LINK_PATTERN = /\\[(\\w+)@([\\w.:%#-]+)\\]/g;\nconst CONSTANT_PATTERN = /(?<!\\w)%(\\w+)/g;\nconst TYPE_REF_PATTERN = /(?<!\\w)#(\\w+)/g;\nconst PARAM_REF_PATTERN = /(?<!\\w)@(\\w+)/g;\nconst FUNCTION_REF_PATTERN = /\\b([a-z_][a-z0-9_]*)\\(\\)/g;\n\nconst renderLink = (kind: string, target: string): string => {\n    const segments = target.split(/::|[.:]/);\n    const lastIndex = segments.length - 1;\n\n    if (kind === \"property\" || CALLABLE_LINK_KINDS.has(kind)) {\n        segments[lastIndex] = camelCase(segments[lastIndex] ?? \"\");\n    }\n\n    const symbol = segments.join(\".\");\n\n    return `\\`${symbol}${CALLABLE_LINK_KINDS.has(kind) ? \"()\" : \"\"}\\``;\n};\n\nconst trimTrailingNewlines = (value: string): string => {\n    let end = value.length;\n\n    while (end > 0 && value[end - 1] === \"\\n\") {\n        end -= 1;\n    }\n\n    return value.slice(0, end);\n};\n\nconst renderCodeFence = (body: string): string => {\n    const languageMatch = CODE_LANGUAGE_PATTERN.exec(body);\n    const fence = (languageMatch?.[1] ?? \"\").trim().toLowerCase();\n    const rest = languageMatch === null ? body : body.slice(languageMatch[0].length);\n    const code = trimTrailingNewlines(rest.trimStart());\n\n    return `\\`\\`\\`${fence}\\n${code}\\n\\`\\`\\``;\n};\n\nconst protectCodeBlocks = (raw: string, protect: (value: string) => string): string => {\n    let result = \"\";\n    let cursor = 0;\n\n    while (cursor < raw.length) {\n        const open = raw.indexOf(CODE_BLOCK_OPEN, cursor);\n\n        if (open === -1) {\n            break;\n        }\n\n        const close = raw.indexOf(CODE_BLOCK_CLOSE, open + CODE_BLOCK_OPEN.length);\n\n        if (close === -1) {\n            break;\n        }\n\n        result += raw.slice(cursor, open);\n        result += protect(renderCodeFence(raw.slice(open + CODE_BLOCK_OPEN.length, close)));\n        cursor = close + CODE_BLOCK_CLOSE.length;\n    }\n\n    return result + raw.slice(cursor);\n};\n\nconst gtkDocToMarkdown = (raw: string): string => {\n    const stash: string[] = [];\n\n    const protect = (value: string): string => {\n        const token = `${SENTINEL}${String(stash.length)}${SENTINEL}`;\n        stash.push(value);\n\n        return token;\n    };\n\n    let text = protectCodeBlocks(raw, protect);\n    text = text.replaceAll(FENCED_BLOCK_PATTERN, (block) => protect(block));\n    text = text.replaceAll(INLINE_CODE_PATTERN, (span) => protect(span));\n    text = text.replaceAll(LINK_PATTERN, (_match, kind: string, target: string) => protect(renderLink(kind, target)));\n    text = text.replaceAll(CONSTANT_PATTERN, (_match, name: string) => protect(`\\`${CONSTANT_MAP[name] ?? name}\\``));\n    text = text.replaceAll(TYPE_REF_PATTERN, (_match, name: string) => protect(`\\`${name}\\``));\n    text = text.replaceAll(PARAM_REF_PATTERN, (_match, name: string) => protect(`\\`${name}\\``));\n    text = text.replaceAll(FUNCTION_REF_PATTERN, (_match, name: string) => protect(`\\`${name}()\\``));\n\n    for (let index = stash.length - 1; index >= 0; index -= 1) {\n        const value = stash[index] ?? \"\";\n        text = text.replaceAll(`${SENTINEL}${String(index)}${SENTINEL}`, () => value);\n    }\n\n    return text;\n};\n\nexport { gtkDocToMarkdown };\n"]}
+{"version":3,"file":"gtk-doc.js","sourceRoot":"","sources":["../../src/writer/gtk-doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,YAAY,GAA2B,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAC5F,MAAM,mBAAmB,GAAgB,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;AAC5F,MAAM,QAAQ,GAAG,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;AAC/C,MAAM,eAAe,GAAG,IAAI,CAAC;AAC7B,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAC9B,MAAM,qBAAqB,GAAG,qCAAqC,CAAC;AACpE,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;AAC/C,MAAM,mBAAmB,GAAG,YAAY,CAAC;AACzC,MAAM,YAAY,GAAG,yBAAyB,CAAC;AAC/C,MAAM,gBAAgB,GAAG,oBAAoB,CAAC;AAC9C,MAAM,wBAAwB,GAAG,MAAM,CAAC;AACxC,MAAM,gBAAgB,GAAG,mCAAmC,CAAC;AAC7D,MAAM,iBAAiB,GAAG,gBAAgB,CAAC;AAC3C,MAAM,oBAAoB,GAAG,2BAA2B,CAAC;AACzD,MAAM,oBAAoB,GAAG,kBAAkB,CAAC;AAChD,MAAM,mBAAmB,GAAG,qFAAqF,CAAC;AAClH,MAAM,oBAAoB,GAAG,kBAAkB,CAAC;AAChD,MAAM,qBAAqB,GAAG,mBAAmB,CAAC;AAClD,MAAM,uBAAuB,GAAG,0BAA0B,CAAC;AAC3D,MAAM,yBAAyB,GAAG,8BAA8B,CAAC;AACjE,MAAM,0BAA0B,GAAG,kCAAkC,CAAC;AACtE,MAAM,oBAAoB,GAAG,6CAA6C,CAAC;AAC3E,MAAM,uBAAuB,GAAG,iCAAiC,CAAC;AAClE,MAAM,oBAAoB,GAAG,uBAAuB,CAAC;AACrD,MAAM,oBAAoB,GAAG,eAAe,CAAC;AAC7C,MAAM,sBAAsB,GAAG,SAAS,CAAC;AAEzC,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,MAAc,EAAU,EAAE;IACxD,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACzC,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;IAEtC,IAAI,IAAI,KAAK,UAAU,IAAI,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACvD,QAAQ,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAElC,OAAO,KAAK,MAAM,GAAG,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;AACvE,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,IAAY,EAAE,MAA0B,EAAU,EAAE;IACvE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,KAAK,IAAI,IAAI,CAAC;IACzB,CAAC;IAED,OAAO,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,EAAE,GAAG,IAAI,GAAG,MAAM,EAAE,CAAC,CAAC;AAC3F,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,WAA4C,EAAU,EAAE,CAC1F,KAAK,WAAW,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC;AAE5C,MAAM,oBAAoB,GAAG,CAAC,KAAa,EAAU,EAAE;IACnD,IAAI,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC;IAEvB,OAAO,GAAG,GAAG,CAAC,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QACxC,GAAG,IAAI,CAAC,CAAC;IACb,CAAC;IAED,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,IAAY,EAAU,EAAE;IAC7C,MAAM,aAAa,GAAG,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvD,MAAM,KAAK,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC9D,MAAM,IAAI,GAAG,aAAa,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACjF,MAAM,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IAEpD,OAAO,SAAS,KAAK,KAAK,IAAI,UAAU,CAAC;AAC7C,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,aAAa,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC;AAErF,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAU,EAAE,CAChD,gBAAgB,CAAC,IAAI,EAAE,CAAC,oBAAoB,EAAE,qBAAqB,CAAC,EAAE,aAAa,CAAC;KAC/E,UAAU,CAAC,uBAAuB,EAAE,IAAI,CAAC;KACzC,UAAU,CAAC,yBAAyB,EAAE,MAAM,CAAC;KAC7C,UAAU,CAAC,0BAA0B,EAAE,IAAI,CAAC;KAC5C,UAAU,CAAC,oBAAoB,EAAE,CAAC,MAAM,EAAE,KAAa,EAAE,EAAE,CAAC,KAAK,CAAC;KAClE,UAAU,CAAC,uBAAuB,EAAE,CAAC,MAAM,EAAE,OAAe,EAAE,EAAE,CAAC,KAAK,OAAO,IAAI,CAAC;KAClF,UAAU,CAAC,oBAAoB,EAAE,MAAM,CAAC;KACxC,UAAU,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;AAElD,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAU,EAAE;IAC/C,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;AACtF,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAE,MAAwB,EAAE,MAAgC,EAAU,EAAE;IACzG,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,MAAM,CAAC;IAC7B,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,OAAO,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAExC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACf,MAAM;QACV,CAAC;QAED,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAEpD,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;YACb,MAAM;QACV,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACnC,MAAM,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;QACtD,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC;IAChC,CAAC;IAED,OAAO,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,GAAW,EAAE,OAAkC,EAAU,EAAE,CAClF,gBAAgB,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAEzG,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAU,EAAE;IAC/C,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,IAAI,QAAQ,GAAG,EAAE,CAAC;IAElB,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC1B,QAAQ,GAAG,OAAO,CAAC;QACnB,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,kDAAkD;AAClD,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAE,WAAiC,EAAU,EAAE;IAChF,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,MAAM,OAAO,GAAG,CAAC,KAAa,EAAU,EAAE;QACtC,MAAM,KAAK,GAAG,GAAG,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,QAAQ,EAAE,CAAC;QAC9D,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAElB,OAAO,KAAK,CAAC;IACjB,CAAC,CAAC;IAEF,IAAI,IAAI,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9D,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IACxE,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,IAAY,EAAE,MAAc,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAClH,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,YAAY,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC;IACjH,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,EAAE,GAAG,CAAC,CAAC;IAEtD,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,IAAY,EAAE,MAA0B,EAAE,EAAE,CAC1F,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CACvC,CAAC;IAEF,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC,MAAM,EAAE,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAChH,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,MAAM,EAAE,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC;IACjG,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAE/B,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACxD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QACjC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,EAAE,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;IAClF,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC","sourcesContent":["import { camelCase } from \"@gtkx/utils\";\n\nconst CONSTANT_MAP: Record<string, string> = { TRUE: \"true\", FALSE: \"false\", NULL: \"null\" };\nconst CALLABLE_LINK_KINDS: Set<string> = new Set([\"method\", \"func\", \"ctor\", \"vfunc\", \"id\"]);\nconst SENTINEL = String.fromCodePoint(0xE0_00);\nconst CODE_BLOCK_OPEN = \"|[\";\nconst CODE_BLOCK_CLOSE = \"]|\";\nconst CODE_LANGUAGE_PATTERN = /^\\s*<!--\\s*language=\"([^\"]*)\"\\s*-->/;\nconst FENCED_BLOCK_PATTERN = /```[\\s\\S]*?```/g;\nconst INLINE_CODE_PATTERN = /`[^`\\n]*`/g;\nconst LINK_PATTERN = /\\[(\\w+)@([\\w.:%#-]+)\\]/g;\nconst CONSTANT_PATTERN = /(?<![\\w\\\\])%(\\w+)/g;\nconst ESCAPED_CONSTANT_PATTERN = /\\\\%/g;\nconst TYPE_REF_PATTERN = /(?<!\\w)#(\\w+)(::[\\w-]+|:[\\w-]+)?/g;\nconst PARAM_REF_PATTERN = /(?<!\\w)@(\\w+)/g;\nconst FUNCTION_REF_PATTERN = /\\b([a-z_][a-z0-9_]*)\\(\\)/g;\nconst HTML_COMMENT_PATTERN = /<!--[\\s\\S]*?-->/g;\nconst DOCBOOK_TAG_PATTERN = /<\\/?(?:itemizedlist|listitem|para|literal|link|informalexample|programlisting)[\\s>]/;\nconst DOCBOOK_LISTING_OPEN = \"<programlisting>\";\nconst DOCBOOK_LISTING_CLOSE = \"</programlisting>\";\nconst DOCBOOK_EXAMPLE_PATTERN = /<\\/?informalexample>\\s*/g;\nconst DOCBOOK_ITEM_OPEN_PATTERN = /<listitem>\\s*(?:<para>\\s*)?/g;\nconst DOCBOOK_ITEM_CLOSE_PATTERN = /(?:<\\/para>\\s*)?<\\/listitem>\\s*/g;\nconst DOCBOOK_LINK_PATTERN = /<link\\s+linkend=\"[^\"]*\">([\\s\\S]*?)<\\/link>/g;\nconst DOCBOOK_LITERAL_PATTERN = /<literal>([\\s\\S]*?)<\\/literal>/g;\nconst DOCBOOK_LIST_PATTERN = /<\\/?itemizedlist>\\s*/g;\nconst DOCBOOK_PARA_PATTERN = /<\\/?para>\\s*/g;\nconst BLANK_LINE_RUN_PATTERN = /\\n{3,}/g;\n\nconst renderLink = (kind: string, target: string): string => {\n    const segments = target.split(/::|[.:]/);\n    const lastIndex = segments.length - 1;\n\n    if (kind === \"property\" || CALLABLE_LINK_KINDS.has(kind)) {\n        segments[lastIndex] = camelCase(segments[lastIndex] ?? \"\");\n    }\n\n    const symbol = segments.join(\".\");\n\n    return `\\`${symbol}${CALLABLE_LINK_KINDS.has(kind) ? \"()\" : \"\"}\\``;\n};\n\nconst renderTypeRef = (name: string, member: string | undefined): string => {\n    if (member === undefined) {\n        return `\\`${name}\\``;\n    }\n\n    return renderLink(member.startsWith(\"::\") ? \"signal\" : \"property\", `${name}${member}`);\n};\n\nconst renderParamRef = (name: string, identifiers: Map<string, string> | undefined): string =>\n    `\\`${identifiers?.get(name) ?? name}\\``;\n\nconst trimTrailingNewlines = (value: string): string => {\n    let end = value.length;\n\n    while (end > 0 && value[end - 1] === \"\\n\") {\n        end -= 1;\n    }\n\n    return value.slice(0, end);\n};\n\nconst renderCodeFence = (body: string): string => {\n    const languageMatch = CODE_LANGUAGE_PATTERN.exec(body);\n    const fence = (languageMatch?.[1] ?? \"\").trim().toLowerCase();\n    const rest = languageMatch === null ? body : body.slice(languageMatch[0].length);\n    const code = trimTrailingNewlines(rest.trimStart());\n\n    return `\\`\\`\\`${fence}\\n${code}\\n\\`\\`\\``;\n};\n\nconst renderListing = (code: string): string => `\\n\\`\\`\\`\\n${code.trim()}\\n\\`\\`\\`\\n`;\n\nconst replaceDocBookTags = (text: string): string =>\n    replaceDelimited(text, [DOCBOOK_LISTING_OPEN, DOCBOOK_LISTING_CLOSE], renderListing)\n        .replaceAll(DOCBOOK_EXAMPLE_PATTERN, \"\\n\")\n        .replaceAll(DOCBOOK_ITEM_OPEN_PATTERN, \"\\n- \")\n        .replaceAll(DOCBOOK_ITEM_CLOSE_PATTERN, \"\\n\")\n        .replaceAll(DOCBOOK_LINK_PATTERN, (_match, label: string) => label)\n        .replaceAll(DOCBOOK_LITERAL_PATTERN, (_match, literal: string) => `\\`${literal}\\``)\n        .replaceAll(DOCBOOK_LIST_PATTERN, \"\\n\\n\")\n        .replaceAll(DOCBOOK_PARA_PATTERN, \"\\n\\n\");\n\nconst docBookToMarkdown = (text: string): string => {\n    if (!DOCBOOK_TAG_PATTERN.test(text)) {\n        return text;\n    }\n\n    return replaceDocBookTags(text).replaceAll(BLANK_LINE_RUN_PATTERN, \"\\n\\n\").trim();\n};\n\nconst replaceDelimited = (raw: string, bounds: [string, string], render: (body: string) => string): string => {\n    const [open, close] = bounds;\n    let result = \"\";\n    let cursor = 0;\n\n    while (cursor < raw.length) {\n        const start = raw.indexOf(open, cursor);\n\n        if (start === -1) {\n            break;\n        }\n\n        const end = raw.indexOf(close, start + open.length);\n\n        if (end === -1) {\n            break;\n        }\n\n        result += raw.slice(cursor, start);\n        result += render(raw.slice(start + open.length, end));\n        cursor = end + close.length;\n    }\n\n    return result + raw.slice(cursor);\n};\n\nconst protectCodeBlocks = (raw: string, protect: (value: string) => string): string =>\n    replaceDelimited(raw, [CODE_BLOCK_OPEN, CODE_BLOCK_CLOSE], (body) => protect(renderCodeFence(body)));\n\nconst stripHtmlComments = (text: string): string => {\n    let current = text;\n    let previous = \"\";\n\n    while (current !== previous) {\n        previous = current;\n        current = current.replaceAll(HTML_COMMENT_PATTERN, \"\");\n    }\n\n    return current;\n};\n\n// eslint-disable-next-line gtkx/no-library-prefix\nconst gtkDocToMarkdown = (raw: string, identifiers?: Map<string, string>): string => {\n    const stash: string[] = [];\n\n    const protect = (value: string): string => {\n        const token = `${SENTINEL}${String(stash.length)}${SENTINEL}`;\n        stash.push(value);\n\n        return token;\n    };\n\n    let text = protectCodeBlocks(docBookToMarkdown(raw), protect);\n    text = text.replaceAll(FENCED_BLOCK_PATTERN, (block) => protect(block));\n    text = text.replaceAll(INLINE_CODE_PATTERN, (span) => protect(span));\n    text = text.replaceAll(LINK_PATTERN, (_match, kind: string, target: string) => protect(renderLink(kind, target)));\n    text = text.replaceAll(CONSTANT_PATTERN, (_match, name: string) => protect(`\\`${CONSTANT_MAP[name] ?? name}\\``));\n    text = text.replaceAll(ESCAPED_CONSTANT_PATTERN, \"%\");\n\n    text = text.replaceAll(TYPE_REF_PATTERN, (_match, name: string, member: string | undefined) =>\n        protect(renderTypeRef(name, member)),\n    );\n\n    text = text.replaceAll(PARAM_REF_PATTERN, (_match, name: string) => protect(renderParamRef(name, identifiers)));\n    text = text.replaceAll(FUNCTION_REF_PATTERN, (_match, name: string) => protect(`\\`${name}()\\``));\n    text = stripHtmlComments(text);\n\n    for (let index = stash.length - 1; index >= 0; index -= 1) {\n        const value = stash[index] ?? \"\";\n        text = text.replaceAll(`${SENTINEL}${String(index)}${SENTINEL}`, () => value);\n    }\n\n    return text;\n};\n\nexport { gtkDocToMarkdown };\n"]}

package/dist/writer/module.d.ts

@@ -1,16 +1,30 @@
 import { ImportsBuilder } from "./imports.js";
+type Declaration = {
+    name: string;
+    code: string;
+    owner?: string | undefined;
+};
 declare class ModuleBuilder {
     private bindings;
     private bindingNames;
     private hoistedDescriptors;
+    private claimedSpaces;
     private declarations;
+    private declaredNames;
+    private declaredTypes;
     private registrations;
+    private requiredNames;
     imports: ImportsBuilder;
+    private claimSpace;
+    private claimExportedName;
+    private claimTypeName;
+    private verifyRegistrations;
     appendBinding(code: string, name?: string): void;
     hoistDescriptor(expression: string): string;
-    appendDeclaration(code: string): void;
-    appendRegistration(code: string): void;
+    appendDeclaration(declaration: Declaration): void;
+    hasExports(): boolean;
+    appendRegistration(code: string, requires?: string[]): void;
     toSource(): string;
 }
-export { ModuleBuilder };
+export { type Declaration, ModuleBuilder };
 //# sourceMappingURL=module.d.ts.map

package/dist/writer/module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../src/writer/module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,cAAM,aAAa;IACf,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,YAAY,CAA0B;IAC9C,OAAO,CAAC,kBAAkB,CAAkC;IAC5D,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,aAAa,CAAgB;IAC9B,OAAO,EAAE,cAAc,CAAwB;IAEtD,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAYhD,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAc3C,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAIrC,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAItC,QAAQ,IAAI,MAAM;CAsBrB;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../src/writer/module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,KAAK,WAAW,GAAG;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AA6BF,cAAM,aAAa;IACf,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,YAAY,CAA0B;IAC9C,OAAO,CAAC,kBAAkB,CAAkC;IAC5D,OAAO,CAAC,aAAa,CAA0B;IAC/C,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,aAAa,CAA0B;IAC/C,OAAO,CAAC,aAAa,CAAkC;IACvD,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,aAAa,CAA0B;IACxC,OAAO,EAAE,cAAc,CAAwB;IAEtD,OAAO,CAAC,UAAU;IAalB,OAAO,CAAC,iBAAiB;IAgBzB,OAAO,CAAC,aAAa;IAmBrB,OAAO,CAAC,mBAAmB;IAa3B,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAYhD,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAc3C,iBAAiB,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI;IAOjD,UAAU,IAAI,OAAO;IAIrB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAM,EAAO,GAAG,IAAI;IAQ/D,QAAQ,IAAI,MAAM;CAuBrB;AAED,OAAO,EAAE,KAAK,WAAW,EAAE,aAAa,EAAE,CAAC"}

package/dist/writer/module.js

@@ -1,11 +1,70 @@
 import { ImportsBuilder } from "./imports.js";
+const EXPORTED_DECLARATION = /^export (?:abstract )?(class|const|enum|function|interface|type) ([A-Za-z_$][\w$]*)/mu;
+const SPACES_BY_KEYWORD = new Map([
+    ["class", ["value", "type"]],
+    ["const", ["value"]],
+    ["enum", ["value", "type"]],
+    ["function", ["value"]],
+    ["interface", []],
+    ["type", ["type"]],
+]);
+const getExportedDeclaration = (code) => {
+    const match = EXPORTED_DECLARATION.exec(code);
+    const spaces = SPACES_BY_KEYWORD.get(match?.[1] ?? "");
+    const name = match?.[2];
+    return spaces === undefined || name === undefined ? undefined : { name, spaces };
+};
+const exportedNameText = (exported) => exported === undefined ? "no name at all" : `'${exported.name}'`;
 class ModuleBuilder {
     bindings = [];
     bindingNames = new Set();
     hoistedDescriptors = new Map();
+    claimedSpaces = new Set();
     declarations = [];
+    declaredNames = new Set();
+    declaredTypes = new Map();
     registrations = [];
+    requiredNames = new Set();
     imports = new ImportsBuilder();
+    claimSpace(name, space) {
+        const key = `${space} ${name}`;
+        if (this.claimedSpaces.has(key)) {
+            throw new Error(`The generated module declares '${name}' twice in its ${space} space. ` +
+                "A module may declare each exported name once per declaration space.");
+        }
+        this.claimedSpaces.add(key);
+    }
+    claimExportedName(declaration) {
+        const exported = getExportedDeclaration(declaration.code);
+        const spaces = exported?.name === declaration.name ? exported.spaces : undefined;
+        if (spaces === undefined) {
+            throw new Error(`The declaration recorded as '${declaration.name}' exports ${exportedNameText(exported)}. ` +
+                "A declaration may only be recorded under the name its own code exports.");
+        }
+        for (const space of spaces) {
+            this.claimSpace(declaration.name, space);
+        }
+    }
+    claimTypeName(declaration) {
+        const { name, owner } = declaration;
+        if (owner === undefined) {
+            return;
+        }
+        const previous = this.declaredTypes.get(name);
+        if (previous !== undefined && previous !== owner) {
+            throw new Error(`The generated type '${name}' is declared for both ${previous} and ${owner}. ` +
+                "Rename one of them, or drop the namespace from the configuration.");
+        }
+        this.declaredTypes.set(name, owner);
+    }
+    verifyRegistrations() {
+        const missing = [...this.requiredNames].filter((name) => !this.declaredNames.has(name));
+        if (missing.length === 0) {
+            return;
+        }
+        throw new Error(`The generated module registers ${missing.join(", ")}, which it never declares. ` +
+            "A registration may only name a symbol whose declaration the same module emits.");
+    }
     appendBinding(code, name) {
         if (name !== undefined) {
             if (this.bindingNames.has(name)) {
@@ -25,13 +84,23 @@ class ModuleBuilder {
         this.appendBinding(`const ${name} = ${expression};`, name);
         return name;
     }
-    appendDeclaration(code) {
-        this.declarations.push(code);
+    appendDeclaration(declaration) {
+        this.claimExportedName(declaration);
+        this.claimTypeName(declaration);
+        this.declaredNames.add(declaration.name);
+        this.declarations.push(declaration.code);
+    }
+    hasExports() {
+        return this.declaredNames.size > 0;
     }
-    appendRegistration(code) {
+    appendRegistration(code, requires = []) {
+        for (const name of requires) {
+            this.requiredNames.add(name);
+        }
         this.registrations.push(code);
     }
     toSource() {
+        this.verifyRegistrations();
         const sections = [];
         const importsBlock = this.imports.toSource();
         if (importsBlock.length > 0) {

package/dist/writer/module.js.map

@@ -1 +1 @@
-{"version":3,"file":"module.js","sourceRoot":"","sources":["../../src/writer/module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,MAAM,aAAa;IACP,QAAQ,GAAa,EAAE,CAAC;IACxB,YAAY,GAAgB,IAAI,GAAG,EAAE,CAAC;IACtC,kBAAkB,GAAwB,IAAI,GAAG,EAAE,CAAC;IACpD,YAAY,GAAa,EAAE,CAAC;IAC5B,aAAa,GAAa,EAAE,CAAC;IAC9B,OAAO,GAAmB,IAAI,cAAc,EAAE,CAAC;IAEtD,aAAa,CAAC,IAAY,EAAE,IAAa;QACrC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,OAAO;YACX,CAAC;YAED,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,eAAe,CAAC,UAAkB;QAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAEzD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,QAAQ,CAAC;QACpB,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5D,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,CAAC,SAAS,IAAI,MAAM,UAAU,GAAG,EAAE,IAAI,CAAC,CAAC;QAE3D,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,iBAAiB,CAAC,IAAY;QAC1B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,kBAAkB,CAAC,IAAY;QAC3B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,QAAQ;QACJ,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QAE7C,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1C,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IACxC,CAAC;CACJ;AAED,OAAO,EAAE,aAAa,EAAE,CAAC","sourcesContent":["import { ImportsBuilder } from \"./imports.js\";\n\nclass ModuleBuilder {\n    private bindings: string[] = [];\n    private bindingNames: Set<string> = new Set();\n    private hoistedDescriptors: Map<string, string> = new Map();\n    private declarations: string[] = [];\n    private registrations: string[] = [];\n    public imports: ImportsBuilder = new ImportsBuilder();\n\n    appendBinding(code: string, name?: string): void {\n        if (name !== undefined) {\n            if (this.bindingNames.has(name)) {\n                return;\n            }\n\n            this.bindingNames.add(name);\n        }\n\n        this.bindings.push(code);\n    }\n\n    hoistDescriptor(expression: string): string {\n        const existing = this.hoistedDescriptors.get(expression);\n\n        if (existing !== undefined) {\n            return existing;\n        }\n\n        const name = `_desc${String(this.hoistedDescriptors.size)}`;\n        this.hoistedDescriptors.set(expression, name);\n        this.appendBinding(`const ${name} = ${expression};`, name);\n\n        return name;\n    }\n\n    appendDeclaration(code: string): void {\n        this.declarations.push(code);\n    }\n\n    appendRegistration(code: string): void {\n        this.registrations.push(code);\n    }\n\n    toSource(): string {\n        const sections: string[] = [];\n        const importsBlock = this.imports.toSource();\n\n        if (importsBlock.length > 0) {\n            sections.push(importsBlock.trimEnd());\n        }\n\n        if (this.declarations.length > 0) {\n            sections.push(this.declarations.join(\"\\n\\n\"));\n        }\n\n        if (this.bindings.length > 0) {\n            sections.push(this.bindings.join(\"\\n\\n\"));\n        }\n\n        if (this.registrations.length > 0) {\n            sections.push(this.registrations.join(\"\\n\\n\"));\n        }\n\n        return `${sections.join(\"\\n\\n\")}\\n`;\n    }\n}\n\nexport { ModuleBuilder };\n"]}
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../../src/writer/module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAa9C,MAAM,oBAAoB,GAAG,uFAAuF,CAAC;AAErH,MAAM,iBAAiB,GAA0B,IAAI,GAAG,CAAC;IACrD,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC5B,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC3B,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC,WAAW,EAAE,EAAE,CAAC;IACjB,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;CACrB,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,CAAC,IAAY,EAAmC,EAAE;IAC7E,MAAM,KAAK,GAAG,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,MAAM,MAAM,GAAG,iBAAiB,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACvD,MAAM,IAAI,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IAExB,OAAO,MAAM,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACrF,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,QAAyC,EAAU,EAAE,CAC3E,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC;AAErE,MAAM,aAAa;IACP,QAAQ,GAAa,EAAE,CAAC;IACxB,YAAY,GAAgB,IAAI,GAAG,EAAE,CAAC;IACtC,kBAAkB,GAAwB,IAAI,GAAG,EAAE,CAAC;IACpD,aAAa,GAAgB,IAAI,GAAG,EAAE,CAAC;IACvC,YAAY,GAAa,EAAE,CAAC;IAC5B,aAAa,GAAgB,IAAI,GAAG,EAAE,CAAC;IACvC,aAAa,GAAwB,IAAI,GAAG,EAAE,CAAC;IAC/C,aAAa,GAAa,EAAE,CAAC;IAC7B,aAAa,GAAgB,IAAI,GAAG,EAAE,CAAC;IACxC,OAAO,GAAmB,IAAI,cAAc,EAAE,CAAC;IAE9C,UAAU,CAAC,IAAY,EAAE,KAAa;QAC1C,MAAM,GAAG,GAAG,GAAG,KAAK,IAAI,IAAI,EAAE,CAAC;QAE/B,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACX,kCAAkC,IAAI,kBAAkB,KAAK,UAAU;gBACvE,qEAAqE,CACxE,CAAC;QACN,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAEO,iBAAiB,CAAC,WAAwB;QAC9C,MAAM,QAAQ,GAAG,sBAAsB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,QAAQ,EAAE,IAAI,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QAEjF,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CACX,gCAAgC,WAAW,CAAC,IAAI,aAAa,gBAAgB,CAAC,QAAQ,CAAC,IAAI;gBAC3F,yEAAyE,CAC5E,CAAC;QACN,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC7C,CAAC;IACL,CAAC;IAEO,aAAa,CAAC,WAAwB;QAC1C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,WAAW,CAAC;QAEpC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtB,OAAO;QACX,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAE9C,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CACX,uBAAuB,IAAI,0BAA0B,QAAQ,QAAQ,KAAK,IAAI;gBAC9E,mEAAmE,CACtE,CAAC;QACN,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;IAEO,mBAAmB;QACvB,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAExF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO;QACX,CAAC;QAED,MAAM,IAAI,KAAK,CACX,kCAAkC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,6BAA6B;YACjF,gFAAgF,CACnF,CAAC;IACN,CAAC;IAED,aAAa,CAAC,IAAY,EAAE,IAAa;QACrC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,OAAO;YACX,CAAC;YAED,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,eAAe,CAAC,UAAkB;QAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAEzD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,QAAQ,CAAC;QACpB,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5D,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,CAAC,SAAS,IAAI,MAAM,UAAU,GAAG,EAAE,IAAI,CAAC,CAAC;QAE3D,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,iBAAiB,CAAC,WAAwB;QACtC,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QACpC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QAChC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,UAAU;QACN,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,CAAC;IACvC,CAAC;IAED,kBAAkB,CAAC,IAAY,EAAE,WAAqB,EAAE;QACpD,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC1B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,QAAQ;QACJ,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QAE7C,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1C,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IACxC,CAAC;CACJ;AAED,OAAO,EAAoB,aAAa,EAAE,CAAC","sourcesContent":["import { ImportsBuilder } from \"./imports.js\";\n\ntype Declaration = {\n    name: string;\n    code: string;\n    owner?: string | undefined;\n};\n\ntype ExportedDeclaration = {\n    name: string;\n    spaces: string[];\n};\n\nconst EXPORTED_DECLARATION = /^export (?:abstract )?(class|const|enum|function|interface|type) ([A-Za-z_$][\\w$]*)/mu;\n\nconst SPACES_BY_KEYWORD: Map<string, string[]> = new Map([\n    [\"class\", [\"value\", \"type\"]],\n    [\"const\", [\"value\"]],\n    [\"enum\", [\"value\", \"type\"]],\n    [\"function\", [\"value\"]],\n    [\"interface\", []],\n    [\"type\", [\"type\"]],\n]);\n\nconst getExportedDeclaration = (code: string): ExportedDeclaration | undefined => {\n    const match = EXPORTED_DECLARATION.exec(code);\n    const spaces = SPACES_BY_KEYWORD.get(match?.[1] ?? \"\");\n    const name = match?.[2];\n\n    return spaces === undefined || name === undefined ? undefined : { name, spaces };\n};\n\nconst exportedNameText = (exported: ExportedDeclaration | undefined): string =>\n    exported === undefined ? \"no name at all\" : `'${exported.name}'`;\n\nclass ModuleBuilder {\n    private bindings: string[] = [];\n    private bindingNames: Set<string> = new Set();\n    private hoistedDescriptors: Map<string, string> = new Map();\n    private claimedSpaces: Set<string> = new Set();\n    private declarations: string[] = [];\n    private declaredNames: Set<string> = new Set();\n    private declaredTypes: Map<string, string> = new Map();\n    private registrations: string[] = [];\n    private requiredNames: Set<string> = new Set();\n    public imports: ImportsBuilder = new ImportsBuilder();\n\n    private claimSpace(name: string, space: string): void {\n        const key = `${space} ${name}`;\n\n        if (this.claimedSpaces.has(key)) {\n            throw new Error(\n                `The generated module declares '${name}' twice in its ${space} space. ` +\n                \"A module may declare each exported name once per declaration space.\",\n            );\n        }\n\n        this.claimedSpaces.add(key);\n    }\n\n    private claimExportedName(declaration: Declaration): void {\n        const exported = getExportedDeclaration(declaration.code);\n        const spaces = exported?.name === declaration.name ? exported.spaces : undefined;\n\n        if (spaces === undefined) {\n            throw new Error(\n                `The declaration recorded as '${declaration.name}' exports ${exportedNameText(exported)}. ` +\n                \"A declaration may only be recorded under the name its own code exports.\",\n            );\n        }\n\n        for (const space of spaces) {\n            this.claimSpace(declaration.name, space);\n        }\n    }\n\n    private claimTypeName(declaration: Declaration): void {\n        const { name, owner } = declaration;\n\n        if (owner === undefined) {\n            return;\n        }\n\n        const previous = this.declaredTypes.get(name);\n\n        if (previous !== undefined && previous !== owner) {\n            throw new Error(\n                `The generated type '${name}' is declared for both ${previous} and ${owner}. ` +\n                \"Rename one of them, or drop the namespace from the configuration.\",\n            );\n        }\n\n        this.declaredTypes.set(name, owner);\n    }\n\n    private verifyRegistrations(): void {\n        const missing = [...this.requiredNames].filter((name) => !this.declaredNames.has(name));\n\n        if (missing.length === 0) {\n            return;\n        }\n\n        throw new Error(\n            `The generated module registers ${missing.join(\", \")}, which it never declares. ` +\n            \"A registration may only name a symbol whose declaration the same module emits.\",\n        );\n    }\n\n    appendBinding(code: string, name?: string): void {\n        if (name !== undefined) {\n            if (this.bindingNames.has(name)) {\n                return;\n            }\n\n            this.bindingNames.add(name);\n        }\n\n        this.bindings.push(code);\n    }\n\n    hoistDescriptor(expression: string): string {\n        const existing = this.hoistedDescriptors.get(expression);\n\n        if (existing !== undefined) {\n            return existing;\n        }\n\n        const name = `_desc${String(this.hoistedDescriptors.size)}`;\n        this.hoistedDescriptors.set(expression, name);\n        this.appendBinding(`const ${name} = ${expression};`, name);\n\n        return name;\n    }\n\n    appendDeclaration(declaration: Declaration): void {\n        this.claimExportedName(declaration);\n        this.claimTypeName(declaration);\n        this.declaredNames.add(declaration.name);\n        this.declarations.push(declaration.code);\n    }\n\n    hasExports(): boolean {\n        return this.declaredNames.size > 0;\n    }\n\n    appendRegistration(code: string, requires: string[] = []): void {\n        for (const name of requires) {\n            this.requiredNames.add(name);\n        }\n\n        this.registrations.push(code);\n    }\n\n    toSource(): string {\n        this.verifyRegistrations();\n        const sections: string[] = [];\n        const importsBlock = this.imports.toSource();\n\n        if (importsBlock.length > 0) {\n            sections.push(importsBlock.trimEnd());\n        }\n\n        if (this.declarations.length > 0) {\n            sections.push(this.declarations.join(\"\\n\\n\"));\n        }\n\n        if (this.bindings.length > 0) {\n            sections.push(this.bindings.join(\"\\n\\n\"));\n        }\n\n        if (this.registrations.length > 0) {\n            sections.push(this.registrations.join(\"\\n\\n\"));\n        }\n\n        return `${sections.join(\"\\n\\n\")}\\n`;\n    }\n}\n\nexport { type Declaration, ModuleBuilder };\n"]}

package/dist/xml.d.ts

@@ -1,4 +1,10 @@
 import { type X2jOptions, XMLParser } from "fast-xml-parser";
+type XmlFileInput = {
+    parser: XMLParser;
+    label: string;
+    path: string;
+};
 declare const createXmlParser: (options: Partial<X2jOptions>) => XMLParser;
-export { createXmlParser };
+declare const parseXmlFile: (input: XmlFileInput) => unknown;
+export { createXmlParser, parseXmlFile };
 //# sourceMappingURL=xml.d.ts.map

package/dist/xml.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"xml.d.ts","sourceRoot":"","sources":["../src/xml.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE7D,QAAA,MAAM,eAAe,GAAI,SAAS,OAAO,CAAC,UAAU,CAAC,KAAG,SAOlD,CAAC;AAEP,OAAO,EAAE,eAAe,EAAE,CAAC"}
+{"version":3,"file":"xml.d.ts","sourceRoot":"","sources":["../src/xml.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI7D,KAAK,YAAY,GAAG;IAChB,MAAM,EAAE,SAAS,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,QAAA,MAAM,eAAe,GAAI,SAAS,OAAO,CAAC,UAAU,CAAC,KAAG,SAOlD,CAAC;AA0CP,QAAA,MAAM,YAAY,GAAI,OAAO,YAAY,KAAG,OAS3C,CAAC;AAEF,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,CAAC"}

package/dist/xml.js

@@ -1,4 +1,7 @@
+import { errorMessage, isRecord } from "@gtkx/utils";
 import { XMLParser } from "fast-xml-parser";
+import { SyntaxValidator } from "fast-xml-validator";
+import { readFileSync } from "node:fs";
 const createXmlParser = (options) => new XMLParser({
     ignoreAttributes: false,
     attributeNamePrefix: "@_",
@@ -6,5 +9,44 @@ const createXmlParser = (options) => new XMLParser({
     parseTagValue: false,
     ...options,
 });
-export { createXmlParser };
+const xmlFileError = (input, action, error) => new Error(`Cannot ${action} the ${input.label} at ${input.path}: ${errorMessage(error)}`, { cause: error });
+const readXmlFile = (input) => {
+    try {
+        return readFileSync(input.path, "utf8");
+    }
+    catch (error) {
+        throw xmlFileError(input, "read", error);
+    }
+};
+const isLocated = (line, col) => typeof line === "number" && typeof col === "number" && (line > 1 || col > 1);
+const positionSuffix = (error) => {
+    if (!isRecord(error)) {
+        return "";
+    }
+    const { line, col } = error;
+    if (!isLocated(line, col)) {
+        return "";
+    }
+    return ` (line ${String(line)}, column ${String(col)})`;
+};
+const assertWellFormed = (input, xml) => {
+    try {
+        SyntaxValidator.validate(xml);
+    }
+    catch (error) {
+        throw new Error(`The ${input.label} at ${input.path} is not well-formed XML: ` +
+            `${errorMessage(error)}${positionSuffix(error)}`, { cause: error });
+    }
+};
+const parseXmlFile = (input) => {
+    const xml = readXmlFile(input);
+    assertWellFormed(input, xml);
+    try {
+        return input.parser.parse(xml);
+    }
+    catch (error) {
+        throw xmlFileError(input, "parse", error);
+    }
+};
+export { createXmlParser, parseXmlFile };
 //# sourceMappingURL=xml.js.map

package/dist/xml.js.map

@@ -1 +1 @@
-{"version":3,"file":"xml.js","sourceRoot":"","sources":["../src/xml.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,eAAe,GAAG,CAAC,OAA4B,EAAa,EAAE,CAChE,IAAI,SAAS,CAAC;IACV,gBAAgB,EAAE,KAAK;IACvB,mBAAmB,EAAE,IAAI;IACzB,mBAAmB,EAAE,KAAK;IAC1B,aAAa,EAAE,KAAK;IACpB,GAAG,OAAO;CACb,CAAC,CAAC;AAEP,OAAO,EAAE,eAAe,EAAE,CAAC","sourcesContent":["import { type X2jOptions, XMLParser } from \"fast-xml-parser\";\n\nconst createXmlParser = (options: Partial<X2jOptions>): XMLParser =>\n    new XMLParser({\n        ignoreAttributes: false,\n        attributeNamePrefix: \"@_\",\n        parseAttributeValue: false,\n        parseTagValue: false,\n        ...options,\n    });\n\nexport { createXmlParser };\n"]}
+{"version":3,"file":"xml.js","sourceRoot":"","sources":["../src/xml.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAmB,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAQvC,MAAM,eAAe,GAAG,CAAC,OAA4B,EAAa,EAAE,CAChE,IAAI,SAAS,CAAC;IACV,gBAAgB,EAAE,KAAK;IACvB,mBAAmB,EAAE,IAAI;IACzB,mBAAmB,EAAE,KAAK;IAC1B,aAAa,EAAE,KAAK;IACpB,GAAG,OAAO;CACb,CAAC,CAAC;AAEP,MAAM,YAAY,GAAG,CAAC,KAAmB,EAAE,MAAc,EAAE,KAAc,EAAS,EAAE,CAChF,IAAI,KAAK,CAAC,UAAU,MAAM,QAAQ,KAAK,CAAC,KAAK,OAAO,KAAK,CAAC,IAAI,KAAK,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;AAEhH,MAAM,WAAW,GAAG,CAAC,KAAmB,EAAU,EAAE;IAChD,IAAI,CAAC;QACD,OAAO,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,IAAa,EAAE,GAAY,EAAW,EAAE,CACvD,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC;AAEjF,MAAM,cAAc,GAAG,CAAC,KAAc,EAAU,EAAE;IAC9C,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;IAE5B,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,OAAO,UAAU,MAAM,CAAC,IAAI,CAAC,YAAY,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,KAAmB,EAAE,GAAW,EAAQ,EAAE;IAChE,IAAI,CAAC;QACD,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACX,OAAO,KAAK,CAAC,KAAK,OAAO,KAAK,CAAC,IAAI,2BAA2B;YAC9D,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,EAAE,EAChD,EAAE,KAAK,EAAE,KAAK,EAAE,CACnB,CAAC;IACN,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,KAAmB,EAAW,EAAE;IAClD,MAAM,GAAG,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAC/B,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAE7B,IAAI,CAAC;QACD,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAC9C,CAAC;AACL,CAAC,CAAC;AAEF,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,CAAC","sourcesContent":["import { errorMessage, isRecord } from \"@gtkx/utils\";\nimport { type X2jOptions, XMLParser } from \"fast-xml-parser\";\nimport { SyntaxValidator } from \"fast-xml-validator\";\nimport { readFileSync } from \"node:fs\";\n\ntype XmlFileInput = {\n    parser: XMLParser;\n    label: string;\n    path: string;\n};\n\nconst createXmlParser = (options: Partial<X2jOptions>): XMLParser =>\n    new XMLParser({\n        ignoreAttributes: false,\n        attributeNamePrefix: \"@_\",\n        parseAttributeValue: false,\n        parseTagValue: false,\n        ...options,\n    });\n\nconst xmlFileError = (input: XmlFileInput, action: string, error: unknown): Error =>\n    new Error(`Cannot ${action} the ${input.label} at ${input.path}: ${errorMessage(error)}`, { cause: error });\n\nconst readXmlFile = (input: XmlFileInput): string => {\n    try {\n        return readFileSync(input.path, \"utf8\");\n    } catch (error) {\n        throw xmlFileError(input, \"read\", error);\n    }\n};\n\nconst isLocated = (line: unknown, col: unknown): boolean =>\n    typeof line === \"number\" && typeof col === \"number\" && (line > 1 || col > 1);\n\nconst positionSuffix = (error: unknown): string => {\n    if (!isRecord(error)) {\n        return \"\";\n    }\n\n    const { line, col } = error;\n\n    if (!isLocated(line, col)) {\n        return \"\";\n    }\n\n    return ` (line ${String(line)}, column ${String(col)})`;\n};\n\nconst assertWellFormed = (input: XmlFileInput, xml: string): void => {\n    try {\n        SyntaxValidator.validate(xml);\n    } catch (error) {\n        throw new Error(\n            `The ${input.label} at ${input.path} is not well-formed XML: ` +\n            `${errorMessage(error)}${positionSuffix(error)}`,\n            { cause: error },\n        );\n    }\n};\n\nconst parseXmlFile = (input: XmlFileInput): unknown => {\n    const xml = readXmlFile(input);\n    assertWellFormed(input, xml);\n\n    try {\n        return input.parser.parse(xml);\n    } catch (error) {\n        throw xmlFileError(input, \"parse\", error);\n    }\n};\n\nexport { createXmlParser, parseXmlFile };\n"]}

package/overrides/gdk/rgba.ts.ejs

@@ -1,11 +1,37 @@
 import { RGBA as GeneratedRGBA } from "../gdk.js";
 
+/**
+ * Parses a CSS color string into a new `RGBA`.
+ *
+ * @param value a CSS color string, such as `#rgb`, `rgb(r,g,b)`, or a named color
+ * @returns the parsed color
+ */
 const create = (value: string): GeneratedRGBA => {
     const rgba = new GeneratedRGBA();
     rgba.parse(value);
     return rgba;
 };
 
+/**
+ * Represents a color, in a way that is compatible with cairo's notion of color.
+ *
+ * `GdkRGBA` is a convenient way to pass colors around. It's based on
+ * cairo's way to deal with colors and mirrors its behavior. All values
+ * are in the range from 0.0 to 1.0 inclusive. So the color
+ * (0.0, 0.0, 0.0, 0.0) represents transparent black and
+ * (1.0, 1.0, 1.0, 1.0) is opaque white. Other values will
+ * be clamped to this range when drawing.
+ */
 export const RGBA: typeof GeneratedRGBA & { create: typeof create } = Object.assign(GeneratedRGBA, { create });
 
+/**
+ * Represents a color, in a way that is compatible with cairo's notion of color.
+ *
+ * `GdkRGBA` is a convenient way to pass colors around. It's based on
+ * cairo's way to deal with colors and mirrors its behavior. All values
+ * are in the range from 0.0 to 1.0 inclusive. So the color
+ * (0.0, 0.0, 0.0, 0.0) represents transparent black and
+ * (1.0, 1.0, 1.0, 1.0) is opaque white. Other values will
+ * be clamped to this range when drawing.
+ */
 export type RGBA = GeneratedRGBA;

package/overrides/gobject/object.ts.ejs

@@ -1,22 +1,67 @@
-import { offSignal, onceSignal, onSignal } from "@gtkx/runtime";
-import { Object as GObject, signalHandlerDisconnect, type Type } from "../gobject.js";
+import { disconnectSignal, offSignal, onceSignal, onSignal } from "@gtkx/runtime";
+import { Object as GObject, type Type } from "../gobject.js";
 
 type Listener = (...args: unknown[]) => unknown;
 
 declare module "../gobject.js" {
     interface Object {
+        /** GType the instance's class is registered under, carried on the prototype. */
         __type__: Type;
 
+        /**
+         * Disconnects the handler `connect` returned the given id for.
+         *
+         * @param handlerId Id of the handler to disconnect.
+         */
         disconnect(handlerId: number): void;
 
+        /**
+         * Connects a handler that runs on every emission of `sigName`, remembering it so `off` can
+         * take the same callback back off again.
+         *
+         * @param sigName Signal to connect to.
+         * @param callback Handler invoked on each emission.
+         * @param isAfter Run the handler after the default handler rather than before it.
+         * @returns The same object, so calls chain.
+         */
         on(sigName: string, callback: (...args: unknown[]) => unknown, isAfter?: boolean): Object;
 
+        /**
+         * Connects a handler that runs at most once and disconnects itself after the first emission.
+         *
+         * @param sigName Signal to connect to.
+         * @param callback Handler invoked on the first emission.
+         * @param isAfter Run the handler after the default handler rather than before it.
+         * @returns The same object, so calls chain.
+         */
         once(sigName: string, callback: (...args: unknown[]) => unknown, isAfter?: boolean): Object;
 
+        /**
+         * Disconnects a handler previously connected with `on` or `once`, given the same callback.
+         *
+         * @param sigName Signal the handler was connected to.
+         * @param callback The handler that was connected.
+         * @returns The same object, so calls chain.
+         */
         off(sigName: string, callback: (...args: unknown[]) => unknown): Object;
 
+        /**
+         * Alias of `on`, for callers who prefer the DOM spelling.
+         *
+         * @param sigName Signal to connect to.
+         * @param callback Handler invoked on each emission.
+         * @param isAfter Run the handler after the default handler rather than before it.
+         * @returns The same object, so calls chain.
+         */
         addEventListener(sigName: string, callback: (...args: unknown[]) => unknown, isAfter?: boolean): Object;
 
+        /**
+         * Alias of `off`, for callers who prefer the DOM spelling.
+         *
+         * @param sigName Signal the handler was connected to.
+         * @param callback The handler that was connected.
+         * @returns The same object, so calls chain.
+         */
         removeEventListener(sigName: string, callback: (...args: unknown[]) => unknown): Object;
     }
 }
@@ -26,7 +71,7 @@ type GObjectWithConnect = GObject & {
 };
 
 GObject.prototype.disconnect = function disconnect(handlerId: number): void {
-    signalHandlerDisconnect(this, BigInt(handlerId));
+    disconnectSignal(this, handlerId);
 };
 
 function onImpl(this: GObjectWithConnect, sigName: string, callback: Listener, isAfter?: boolean): GObject {

package/overrides/gobject/value.ts.ejs

@@ -1,6 +1,13 @@
 import { getBoxedValue, getHandle, setBoxedValue } from "@gtkx/runtime";
 import { type Type, Value } from "../gobject.js";
 
+/**
+ * Allocates a `Value`, initializes it to `gtype`, and hands it to `populate` to fill in.
+ *
+ * @param gtype GType the value holds.
+ * @param populate Called with the initialized value to write the contents.
+ * @returns The populated value.
+ */
 export const buildValue = (gtype: Type, populate: (value: Value) => void): Value => {
     const value = new Value();
     value.init(gtype);