@gtkx/codegen 1.0.0-rc.3 → 1.0.0

package/dist/docs/handwritten-props.js

@@ -0,0 +1,149 @@
+import { fileURLToPath } from "node:url";
+import ts from "typescript";
+const RESOLUTION_OPTIONS = {
+    moduleResolution: ts.ModuleResolutionKind.Bundler,
+    customConditions: ["source"],
+};
+const CONTAINING_FILE = fileURLToPath(import.meta.url);
+const WHITESPACE_RUN = /\s+/g;
+const propsByRef = new Map();
+const moduleFileFor = (specifier, containingFile) => ts.resolveModuleName(specifier, containingFile, RESOLUTION_OPTIONS, ts.sys).resolvedModule?.resolvedFileName;
+const parseModule = (filePath) => ts.createSourceFile(filePath, ts.sys.readFile(filePath) ?? "", ts.ScriptTarget.Latest, true);
+const specifierText = (node) => node !== undefined && ts.isStringLiteral(node) ? node.text : undefined;
+const boundName = (elements, name) => {
+    for (const element of elements) {
+        if (element.name.text === name) {
+            return (element.propertyName ?? element.name).text;
+        }
+    }
+    return undefined;
+};
+const findAliasInModule = (specifier, sourceFile, name) => {
+    const filePath = moduleFileFor(specifier, sourceFile.fileName);
+    return filePath === undefined ? undefined : findAlias(parseModule(filePath), name);
+};
+const importedAlias = (statement, sourceFile, name) => {
+    const bindings = statement.importClause?.namedBindings;
+    const specifier = specifierText(statement.moduleSpecifier);
+    if (specifier === undefined || bindings === undefined || !ts.isNamedImports(bindings)) {
+        return undefined;
+    }
+    const imported = boundName(bindings.elements, name);
+    return imported === undefined ? undefined : findAliasInModule(specifier, sourceFile, imported);
+};
+const exportedAlias = (statement, sourceFile, name) => {
+    const specifier = specifierText(statement.moduleSpecifier);
+    if (specifier === undefined) {
+        return undefined;
+    }
+    const clause = statement.exportClause;
+    if (clause === undefined) {
+        return findAliasInModule(specifier, sourceFile, name);
+    }
+    const exported = ts.isNamedExports(clause) ? boundName(clause.elements, name) : undefined;
+    return exported === undefined ? undefined : findAliasInModule(specifier, sourceFile, exported);
+};
+const statementAlias = (statement, sourceFile, name) => {
+    if (ts.isTypeAliasDeclaration(statement)) {
+        return statement.name.text === name ? { sourceFile, declaration: statement } : undefined;
+    }
+    if (ts.isImportDeclaration(statement)) {
+        return importedAlias(statement, sourceFile, name);
+    }
+    return ts.isExportDeclaration(statement) ? exportedAlias(statement, sourceFile, name) : undefined;
+};
+const propType = (type, sourceFile) => {
+    const parts = ts.isUnionTypeNode(type) ? type.types : [type];
+    return parts
+        .filter((part) => part.kind !== ts.SyntaxKind.UndefinedKeyword)
+        .map((part) => part.getText(sourceFile).replaceAll(WHITESPACE_RUN, " "))
+        .join(" | ");
+};
+const propDoc = (member) => {
+    const comments = ts
+        .getJSDocCommentsAndTags(member)
+        .map((node) => (ts.isJSDoc(node) ? ts.getTextOfJSDocComment(node.comment) : undefined));
+    return comments.filter((text) => text !== undefined).join(" ").replaceAll(WHITESPACE_RUN, " ").trim();
+};
+const propertyProp = (member, sourceFile) => {
+    const { name, type } = member;
+    if (type === undefined || !(ts.isIdentifier(name) || ts.isStringLiteral(name))) {
+        return undefined;
+    }
+    return { name: name.text, type: propType(type, sourceFile), doc: propDoc(member) };
+};
+const indexProp = (member, sourceFile) => {
+    const keyType = member.parameters[0]?.type;
+    if (keyType === undefined) {
+        return undefined;
+    }
+    return {
+        name: keyType.getText(sourceFile).replaceAll("`", ""),
+        type: propType(member.type, sourceFile),
+        doc: propDoc(member),
+    };
+};
+const memberProp = (member, sourceFile) => {
+    if (ts.isPropertySignature(member)) {
+        return propertyProp(member, sourceFile);
+    }
+    return ts.isIndexSignatureDeclaration(member) ? indexProp(member, sourceFile) : undefined;
+};
+const literalProps = (type, sourceFile) => {
+    const props = [];
+    for (const member of type.members) {
+        const prop = memberProp(member, sourceFile);
+        if (prop !== undefined) {
+            props.push(prop);
+        }
+    }
+    return props;
+};
+const referenceProps = (type, sourceFile) => {
+    if (!ts.isIdentifier(type.typeName)) {
+        return [];
+    }
+    const site = findAlias(sourceFile, type.typeName.text);
+    return site === undefined ? [] : typeNodeProps(site.declaration.type, site.sourceFile);
+};
+const declaredProps = (ref) => {
+    const filePath = moduleFileFor(ref.module, CONTAINING_FILE);
+    if (filePath === undefined) {
+        throw new Error(`Cannot resolve ${ref.module}, which declares the ${ref.export} element props`);
+    }
+    const site = findAlias(parseModule(filePath), ref.export);
+    if (site === undefined) {
+        throw new Error(`${ref.module} declares no type named ${ref.export}`);
+    }
+    return typeNodeProps(site.declaration.type, site.sourceFile);
+};
+const handwrittenPropsFor = (ref) => {
+    const key = `${ref.module}#${ref.export}`;
+    const cached = propsByRef.get(key);
+    if (cached !== undefined) {
+        return cached;
+    }
+    const props = declaredProps(ref);
+    propsByRef.set(key, props);
+    return props;
+};
+function findAlias(sourceFile, name) {
+    for (const statement of sourceFile.statements) {
+        const site = statementAlias(statement, sourceFile, name);
+        if (site !== undefined) {
+            return site;
+        }
+    }
+    return undefined;
+}
+function typeNodeProps(type, sourceFile) {
+    if (ts.isTypeLiteralNode(type)) {
+        return literalProps(type, sourceFile);
+    }
+    if (ts.isIntersectionTypeNode(type)) {
+        return type.types.flatMap((part) => typeNodeProps(part, sourceFile));
+    }
+    return ts.isTypeReferenceNode(type) ? referenceProps(type, sourceFile) : [];
+}
+export { handwrittenPropsFor };
+//# sourceMappingURL=handwritten-props.js.map

package/dist/docs/handwritten-props.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handwritten-props.js","sourceRoot":"","sources":["../../src/docs/handwritten-props.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,MAAM,YAAY,CAAC;AAe5B,MAAM,kBAAkB,GAAuB;IAC3C,gBAAgB,EAAE,EAAE,CAAC,oBAAoB,CAAC,OAAO;IACjD,gBAAgB,EAAE,CAAC,QAAQ,CAAC;CAC/B,CAAC;AAEF,MAAM,eAAe,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACvD,MAAM,cAAc,GAAG,MAAM,CAAC;AAC9B,MAAM,UAAU,GAAmC,IAAI,GAAG,EAAE,CAAC;AAE7D,MAAM,aAAa,GAAG,CAAC,SAAiB,EAAE,cAAsB,EAAsB,EAAE,CACpF,EAAE,CAAC,iBAAiB,CAAC,SAAS,EAAE,cAAc,EAAE,kBAAkB,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,gBAAgB,CAAC;AAEjH,MAAM,WAAW,GAAG,CAAC,QAAgB,EAAiB,EAAE,CACpD,EAAE,CAAC,gBAAgB,CAAC,QAAQ,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAEjG,MAAM,aAAa,GAAG,CAAC,IAA+B,EAAsB,EAAE,CAC1E,IAAI,KAAK,SAAS,IAAI,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AAE3E,MAAM,SAAS,GAAG,CAAC,QAAiC,EAAE,IAAY,EAAsB,EAAE;IACtF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC7B,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YAC7B,OAAO,CAAC,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;QACvD,CAAC;IACL,CAAC;IAED,OAAO,SAAS,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,SAAiB,EAAE,UAAyB,EAAE,IAAY,EAAyB,EAAE;IAC5G,MAAM,QAAQ,GAAG,aAAa,CAAC,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;IAE/D,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC;AACvF,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAClB,SAA+B,EAC/B,UAAyB,EACzB,IAAY,EACS,EAAE;IACvB,MAAM,QAAQ,GAAG,SAAS,CAAC,YAAY,EAAE,aAAa,CAAC;IACvD,MAAM,SAAS,GAAG,aAAa,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAE3D,IAAI,SAAS,KAAK,SAAS,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;QACpF,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAEpD,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;AACnG,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAClB,SAA+B,EAC/B,UAAyB,EACzB,IAAY,EACS,EAAE;IACvB,MAAM,SAAS,GAAG,aAAa,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAE3D,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC;IAEtC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,iBAAiB,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;IAED,MAAM,QAAQ,GAAG,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE1F,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;AACnG,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,SAAuB,EAAE,UAAyB,EAAE,IAAY,EAAyB,EAAE;IAC/G,IAAI,EAAE,CAAC,sBAAsB,CAAC,SAAS,CAAC,EAAE,CAAC;QACvC,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7F,CAAC;IAED,IAAI,EAAE,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,CAAC;QACpC,OAAO,aAAa,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,EAAE,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACtG,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,IAAiB,EAAE,UAAyB,EAAU,EAAE;IACtE,MAAM,KAAK,GAA2B,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAErF,OAAO,KAAK;SACP,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC;SAC9D,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,UAAU,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;SACvE,IAAI,CAAC,KAAK,CAAC,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,MAAsB,EAAU,EAAE;IAC/C,MAAM,QAAQ,GAAG,EAAE;SACd,uBAAuB,CAAC,MAAM,CAAC;SAC/B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAE5F,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AAC1G,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,MAA4B,EAAE,UAAyB,EAA+B,EAAE;IAC1G,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;IAE9B,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QAC7E,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;AACvF,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,MAAoC,EAAE,UAAyB,EAA+B,EAAE;IAC/G,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;IAE3C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO;QACH,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;QACrD,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC;QACvC,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC;KACvB,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,MAAsB,EAAE,UAAyB,EAA+B,EAAE;IAClG,IAAI,EAAE,CAAC,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAAC;QACjC,OAAO,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,OAAO,EAAE,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9F,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,IAAwB,EAAE,UAAyB,EAAqB,EAAE;IAC5F,MAAM,KAAK,GAAsB,EAAE,CAAC;IAEpC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QAChC,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAE5C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrB,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAA0B,EAAE,UAAyB,EAAqB,EAAE;IAChG,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QAClC,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,IAAI,GAAG,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAEvD,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;AAC3F,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,GAAiB,EAAqB,EAAE;IAC3D,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAE5D,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,kBAAkB,GAAG,CAAC,MAAM,wBAAwB,GAAG,CAAC,MAAM,gBAAgB,CAAC,CAAC;IACpG,CAAC;IAED,MAAM,IAAI,GAAG,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAE1D,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,MAAM,2BAA2B,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,OAAO,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,GAAiB,EAAqB,EAAE;IACjE,MAAM,GAAG,GAAG,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;IAC1C,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAEnC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,KAAK,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IACjC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAE3B,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,SAAS,SAAS,CAAC,UAAyB,EAAE,IAAY;IACtD,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;QAC5C,MAAM,IAAI,GAAG,cAAc,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAEzD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,SAAS,aAAa,CAAC,IAAiB,EAAE,UAAyB;IAC/D,IAAI,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,OAAO,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAChF,CAAC;AAED,OAAO,EAAE,mBAAmB,EAAwB,CAAC","sourcesContent":["import type { ModuleExport } from \"@gtkx/react/config\";\nimport { fileURLToPath } from \"node:url\";\nimport ts from \"typescript\";\n\ntype HandwrittenProp = {\n    name: string;\n    type: string;\n    doc: string;\n};\n\ntype AliasSite = {\n    sourceFile: ts.SourceFile;\n    declaration: ts.TypeAliasDeclaration;\n};\n\ntype NamedBinding = ts.ImportSpecifier | ts.ExportSpecifier;\n\nconst RESOLUTION_OPTIONS: ts.CompilerOptions = {\n    moduleResolution: ts.ModuleResolutionKind.Bundler,\n    customConditions: [\"source\"],\n};\n\nconst CONTAINING_FILE = fileURLToPath(import.meta.url);\nconst WHITESPACE_RUN = /\\s+/g;\nconst propsByRef: Map<string, HandwrittenProp[]> = new Map();\n\nconst moduleFileFor = (specifier: string, containingFile: string): string | undefined =>\n    ts.resolveModuleName(specifier, containingFile, RESOLUTION_OPTIONS, ts.sys).resolvedModule?.resolvedFileName;\n\nconst parseModule = (filePath: string): ts.SourceFile =>\n    ts.createSourceFile(filePath, ts.sys.readFile(filePath) ?? \"\", ts.ScriptTarget.Latest, true);\n\nconst specifierText = (node: ts.Expression | undefined): string | undefined =>\n    node !== undefined && ts.isStringLiteral(node) ? node.text : undefined;\n\nconst boundName = (elements: readonly NamedBinding[], name: string): string | undefined => {\n    for (const element of elements) {\n        if (element.name.text === name) {\n            return (element.propertyName ?? element.name).text;\n        }\n    }\n\n    return undefined;\n};\n\nconst findAliasInModule = (specifier: string, sourceFile: ts.SourceFile, name: string): AliasSite | undefined => {\n    const filePath = moduleFileFor(specifier, sourceFile.fileName);\n\n    return filePath === undefined ? undefined : findAlias(parseModule(filePath), name);\n};\n\nconst importedAlias = (\n    statement: ts.ImportDeclaration,\n    sourceFile: ts.SourceFile,\n    name: string,\n): AliasSite | undefined => {\n    const bindings = statement.importClause?.namedBindings;\n    const specifier = specifierText(statement.moduleSpecifier);\n\n    if (specifier === undefined || bindings === undefined || !ts.isNamedImports(bindings)) {\n        return undefined;\n    }\n\n    const imported = boundName(bindings.elements, name);\n\n    return imported === undefined ? undefined : findAliasInModule(specifier, sourceFile, imported);\n};\n\nconst exportedAlias = (\n    statement: ts.ExportDeclaration,\n    sourceFile: ts.SourceFile,\n    name: string,\n): AliasSite | undefined => {\n    const specifier = specifierText(statement.moduleSpecifier);\n\n    if (specifier === undefined) {\n        return undefined;\n    }\n\n    const clause = statement.exportClause;\n\n    if (clause === undefined) {\n        return findAliasInModule(specifier, sourceFile, name);\n    }\n\n    const exported = ts.isNamedExports(clause) ? boundName(clause.elements, name) : undefined;\n\n    return exported === undefined ? undefined : findAliasInModule(specifier, sourceFile, exported);\n};\n\nconst statementAlias = (statement: ts.Statement, sourceFile: ts.SourceFile, name: string): AliasSite | undefined => {\n    if (ts.isTypeAliasDeclaration(statement)) {\n        return statement.name.text === name ? { sourceFile, declaration: statement } : undefined;\n    }\n\n    if (ts.isImportDeclaration(statement)) {\n        return importedAlias(statement, sourceFile, name);\n    }\n\n    return ts.isExportDeclaration(statement) ? exportedAlias(statement, sourceFile, name) : undefined;\n};\n\nconst propType = (type: ts.TypeNode, sourceFile: ts.SourceFile): string => {\n    const parts: readonly ts.TypeNode[] = ts.isUnionTypeNode(type) ? type.types : [type];\n\n    return parts\n        .filter((part) => part.kind !== ts.SyntaxKind.UndefinedKeyword)\n        .map((part) => part.getText(sourceFile).replaceAll(WHITESPACE_RUN, \" \"))\n        .join(\" | \");\n};\n\nconst propDoc = (member: ts.TypeElement): string => {\n    const comments = ts\n        .getJSDocCommentsAndTags(member)\n        .map((node) => (ts.isJSDoc(node) ? ts.getTextOfJSDocComment(node.comment) : undefined));\n\n    return comments.filter((text) => text !== undefined).join(\" \").replaceAll(WHITESPACE_RUN, \" \").trim();\n};\n\nconst propertyProp = (member: ts.PropertySignature, sourceFile: ts.SourceFile): HandwrittenProp | undefined => {\n    const { name, type } = member;\n\n    if (type === undefined || !(ts.isIdentifier(name) || ts.isStringLiteral(name))) {\n        return undefined;\n    }\n\n    return { name: name.text, type: propType(type, sourceFile), doc: propDoc(member) };\n};\n\nconst indexProp = (member: ts.IndexSignatureDeclaration, sourceFile: ts.SourceFile): HandwrittenProp | undefined => {\n    const keyType = member.parameters[0]?.type;\n\n    if (keyType === undefined) {\n        return undefined;\n    }\n\n    return {\n        name: keyType.getText(sourceFile).replaceAll(\"`\", \"\"),\n        type: propType(member.type, sourceFile),\n        doc: propDoc(member),\n    };\n};\n\nconst memberProp = (member: ts.TypeElement, sourceFile: ts.SourceFile): HandwrittenProp | undefined => {\n    if (ts.isPropertySignature(member)) {\n        return propertyProp(member, sourceFile);\n    }\n\n    return ts.isIndexSignatureDeclaration(member) ? indexProp(member, sourceFile) : undefined;\n};\n\nconst literalProps = (type: ts.TypeLiteralNode, sourceFile: ts.SourceFile): HandwrittenProp[] => {\n    const props: HandwrittenProp[] = [];\n\n    for (const member of type.members) {\n        const prop = memberProp(member, sourceFile);\n\n        if (prop !== undefined) {\n            props.push(prop);\n        }\n    }\n\n    return props;\n};\n\nconst referenceProps = (type: ts.TypeReferenceNode, sourceFile: ts.SourceFile): HandwrittenProp[] => {\n    if (!ts.isIdentifier(type.typeName)) {\n        return [];\n    }\n\n    const site = findAlias(sourceFile, type.typeName.text);\n\n    return site === undefined ? [] : typeNodeProps(site.declaration.type, site.sourceFile);\n};\n\nconst declaredProps = (ref: ModuleExport): HandwrittenProp[] => {\n    const filePath = moduleFileFor(ref.module, CONTAINING_FILE);\n\n    if (filePath === undefined) {\n        throw new Error(`Cannot resolve ${ref.module}, which declares the ${ref.export} element props`);\n    }\n\n    const site = findAlias(parseModule(filePath), ref.export);\n\n    if (site === undefined) {\n        throw new Error(`${ref.module} declares no type named ${ref.export}`);\n    }\n\n    return typeNodeProps(site.declaration.type, site.sourceFile);\n};\n\nconst handwrittenPropsFor = (ref: ModuleExport): HandwrittenProp[] => {\n    const key = `${ref.module}#${ref.export}`;\n    const cached = propsByRef.get(key);\n\n    if (cached !== undefined) {\n        return cached;\n    }\n\n    const props = declaredProps(ref);\n    propsByRef.set(key, props);\n\n    return props;\n};\n\nfunction findAlias(sourceFile: ts.SourceFile, name: string): AliasSite | undefined {\n    for (const statement of sourceFile.statements) {\n        const site = statementAlias(statement, sourceFile, name);\n\n        if (site !== undefined) {\n            return site;\n        }\n    }\n\n    return undefined;\n}\n\nfunction typeNodeProps(type: ts.TypeNode, sourceFile: ts.SourceFile): HandwrittenProp[] {\n    if (ts.isTypeLiteralNode(type)) {\n        return literalProps(type, sourceFile);\n    }\n\n    if (ts.isIntersectionTypeNode(type)) {\n        return type.types.flatMap((part) => typeNodeProps(part, sourceFile));\n    }\n\n    return ts.isTypeReferenceNode(type) ? referenceProps(type, sourceFile) : [];\n}\n\nexport { handwrittenPropsFor, type HandwrittenProp };\n"]}

package/dist/docs/pipeline.d.ts

@@ -16,13 +16,13 @@ type DocsOptions = {
     outDir: string;
     basePath?: string;
     props?: ElementProps;
-    omitProps?: OmittedProps;
-    force?: boolean;
+    omittedProps?: OmittedProps;
+    isForced?: boolean;
 };
 type DocsResult = {
-    regenerated: boolean;
+    isRegenerated: boolean;
     namespaces: DocsNamespace[];
 };
 declare const writeDocs: (options: DocsOptions) => DocsResult;
-export { writeDocs, type DocsElementLink, type DocsNamespace, type DocsOptions, type DocsResult };
+export { writeDocs };
 //# sourceMappingURL=pipeline.d.ts.map

package/dist/docs/pipeline.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pipeline.d.ts","sourceRoot":"","sources":["../../src/docs/pipeline.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,YAAY,EAAmB,MAAM,sCAAsC,CAAC;AAE1F,OAAO,EAAE,KAAK,YAAY,EAAmB,MAAM,+BAA+B,CAAC;AAInF,KAAK,eAAe,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,KAAK,aAAa,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC/B,CAAC;AAEF,KAAK,WAAW,GAAG;IACf,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,SAAS,CAAC,EAAE,YAAY,CAAC;IACzB,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAcF,KAAK,UAAU,GAAG;IACd,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,aAAa,EAAE,CAAC;CAC/B,CAAC;AAuKF,QAAA,MAAM,SAAS,GAAI,SAAS,WAAW,KAAG,UAyBzC,CAAC;AAEF,OAAO,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE,KAAK,aAAa,EAAE,KAAK,WAAW,EAAE,KAAK,UAAU,EAAE,CAAC"}
+{"version":3,"file":"pipeline.d.ts","sourceRoot":"","sources":["../../src/docs/pipeline.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,YAAY,EAAmB,MAAM,sCAAsC,CAAC;AAE1F,OAAO,EAAE,KAAK,YAAY,EAAmB,MAAM,+BAA+B,CAAC;AAInF,KAAK,eAAe,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,KAAK,aAAa,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC/B,CAAC;AAEF,KAAK,WAAW,GAAG;IACf,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAcF,KAAK,UAAU,GAAG;IACd,aAAa,EAAE,OAAO,CAAC;IACvB,UAAU,EAAE,aAAa,EAAE,CAAC;CAC/B,CAAC;AAuKF,QAAA,MAAM,SAAS,GAAI,SAAS,WAAW,KAAG,UAyBzC,CAAC;AAEF,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/dist/docs/pipeline.js

@@ -7,7 +7,7 @@ import { namespaceDirectory } from "../gir/namespace.js";
 import { setElementProps } from "../store/jsx/element-prop-imports.js";
 import { collectIntrinsicElementClasses } from "../store/jsx/intrinsic-elements.js";
 import { setOmittedProps } from "../store/jsx/omitted-props.js";
-import { createElementPageContext, renderElementPage } from "./element-page.js";
+import { renderElementPage } from "./element-page.js";
 import { elementSlug, firstSentence, namespaceOrder } from "./render.js";
 const MANIFEST_FILENAME = "manifest.json";
 const namespaceIndexPage = (namespace, elements) => {
@@ -105,7 +105,7 @@ const generatePages = (options, basePath, library) => {
     const intrinsicElements = collectIntrinsicElementClasses(library);
     const byNamespace = groupElementsByNamespace(intrinsicElements);
     const linkByGlibName = buildElementLinks(intrinsicElements, basePath);
-    const pageContext = createElementPageContext(library, (glibName) => linkByGlibName.get(glibName));
+    const pageContext = { library, linkFor: (glibName) => linkByGlibName.get(glibName) };
     const pages = [];
     const namespaces = [];
     const orderedNames = sortStringsBy(byNamespace.keys(), namespaceOrder);
@@ -119,14 +119,14 @@ const generatePages = (options, basePath, library) => {
     return { pages, namespaces };
 };
 const cachedDocsResult = (options, manifestPath) => {
-    if (options.force === true || !isGiStoreFresh(options.outDir, options.libraries, options.girPath)) {
+    if (options.isForced === true || !isGiStoreFresh(options.outDir, options.libraries, options.girPath)) {
         return undefined;
     }
     if (!existsSync(manifestPath)) {
         return undefined;
     }
     const manifest = JSON.parse(readFileSync(manifestPath, "utf8"));
-    return { regenerated: false, namespaces: manifest.namespaces };
+    return { isRegenerated: false, namespaces: manifest.namespaces };
 };
 const writePages = (outDir, pages) => {
     for (const page of pages) {
@@ -137,7 +137,7 @@ const writePages = (outDir, pages) => {
 };
 const writeDocs = (options) => {
     setElementProps(options.props ?? {});
-    setOmittedProps(options.omitProps ?? {});
+    setOmittedProps(options.omittedProps ?? {});
     const basePath = options.basePath ?? "/reference";
     const manifestPath = join(options.outDir, MANIFEST_FILENAME);
     const cached = cachedDocsResult(options, manifestPath);
@@ -152,7 +152,7 @@ const writeDocs = (options) => {
     const manifest = { namespaces };
     writeFileSync(manifestPath, JSON.stringify(manifest));
     writeFileSync(join(options.outDir, FINGERPRINT_FILENAME), JSON.stringify(computeGiFingerprint(library.girFiles, options.libraries, options.girPath)));
-    return { regenerated: true, namespaces };
+    return { isRegenerated: true, namespaces };
 };
 export { writeDocs };
 //# sourceMappingURL=pipeline.js.map

package/dist/docs/pipeline.js.map

@@ -1 +1 @@
-{"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../../src/docs/pipeline.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACrF,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC/F,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAqB,eAAe,EAAE,MAAM,sCAAsC,CAAC;AAC1F,OAAO,EAAE,8BAA8B,EAAuB,MAAM,oCAAoC,CAAC;AACzG,OAAO,EAAqB,eAAe,EAAE,MAAM,+BAA+B,CAAC;AACnF,OAAO,EAAE,wBAAwB,EAA2B,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACzG,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAyCzE,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAE1C,MAAM,kBAAkB,GAAG,CAAC,SAAwB,EAAE,QAA0B,EAAU,EAAE;IACxF,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACvC,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;QACnD,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAA,IAAI,CAAC,CAAC;QAEnF,OAAO,MAAM,KAAK,CAAC,QAAQ,KAAK,IAAI,OAAO,WAAW,IAAI,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,MAAM,WAAW,GACb,2BAA2B,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,mBAAmB;QAC/E,OAAO,SAAS,CAAC,IAAI,aAAa,CAAC;IAEvC,OAAO;QACH,KAAK;QACL,gBAAgB,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE;QAC7C,KAAK;QACL,EAAE;QACF,KAAK,SAAS,CAAC,IAAI,WAAW;QAC9B,EAAE;QACF,4DAA4D,SAAS,CAAC,SAAS,mBAAmB;YAClG,8DAA8D,SAAS,CAAC,SAAS,KAAK;QACtF,EAAE;QACF,2BAA2B;QAC3B,eAAe;QACf,GAAG,IAAI;QACP,EAAE;KACL,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,UAA2B,EAAE,SAAmB,EAAU,EAAE;IAC/E,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CACvB,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,IAAI,mBAAmB,EAAE,CAAC,SAAS,QAAQ,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CACzG,CAAC;IAEF,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE9E,OAAO;QACH,KAAK;QACL,2GAA2G;QAC3G,KAAK;QACL,EAAE;QACF,qBAAqB;QACrB,EAAE;QACF,+FAA+F;YAC/F,GAAG,aAAa,+EAA+E;YAC/F,gGAAgG;YAChG,qCAAqC;QACrC,EAAE;QACF,0BAA0B;QAC1B,EAAE;QACF,oGAAoG;YACpG,qEAAqE;QACrE,kFAAkF;QAClF,4EAA4E;QAC5E,EAAE;QACF,eAAe;QACf,EAAE;QACF,mCAAmC;QACnC,qBAAqB;QACrB,GAAG,IAAI;QACP,EAAE;KACL,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,QAA0B,EAAiC,EAAE;IAC3F,MAAM,WAAW,GAAkC,IAAI,GAAG,EAAE,CAAC;IAE7D,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACzD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjB,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,WAAW,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,QAA0B,EAAE,QAAgB,EAAuB,EAAE;IAC5F,MAAM,cAAc,GAAwB,IAAI,GAAG,EAAE,CAAC;IAEtD,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC3B,MAAM,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACtD,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,SAAS,IAAI,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAEzE,IAAI,cAAc,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,KAAK,IAAI,CAAC,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,CAAC,QAAQ,OAAO,IAAI,EAAE,CAAC,CAAC;QACjF,CAAC;QAED,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,cAAc,CAAC;AAC1B,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,KAMvB,EAAkB,EAAE;IACjB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;IACxE,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAErC,MAAM,IAAI,GAAkB;QACxB,IAAI;QACJ,SAAS;QACT,IAAI,EAAE,GAAG,QAAQ,IAAI,SAAS,GAAG;QACjC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;KAChH,CAAC;IAEF,MAAM,KAAK,GAAW,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC3C,IAAI,EAAE,GAAG,SAAS,IAAI,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK;QACxD,OAAO,EAAE,iBAAiB,CAAC,KAAK,EAAE,WAAW,CAAC;KACjD,CAAC,CAAC,CAAC;IAEJ,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,SAAS,WAAW,EAAE,OAAO,EAAE,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;IAE3F,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,OAAoB,EAAE,QAAgB,EAAE,OAAgB,EAAiB,EAAE;IAC9F,MAAM,iBAAiB,GAAG,8BAA8B,CAAC,OAAO,CAAC,CAAC;IAClE,MAAM,WAAW,GAAG,wBAAwB,CAAC,iBAAiB,CAAC,CAAC;IAChE,MAAM,cAAc,GAAG,iBAAiB,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACtE,MAAM,WAAW,GAAG,wBAAwB,CAAC,OAAO,EAAE,CAAC,QAAgB,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1G,MAAM,KAAK,GAAW,EAAE,CAAC;IACzB,MAAM,UAAU,GAAoB,EAAE,CAAC;IACvC,MAAM,YAAY,GAAG,aAAa,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,cAAc,CAAC,CAAC;IAEvE,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QAC9B,MAAM,QAAQ,GAAG,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACvF,MAAM,MAAM,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC;QACzF,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5B,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAExF,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAAoB,EAAE,YAAoB,EAA0B,EAAE;IAC5F,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAChG,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAiB,CAAC;IAEhF,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,CAAC;AACnE,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,KAAa,EAAQ,EAAE;IACvD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAChD,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,OAAoB,EAAc,EAAE;IACnD,eAAe,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IACrC,eAAe,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,YAAY,CAAC;IAClD,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC7D,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAEvD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACjE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,aAAa,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACxE,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACzD,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClC,MAAM,QAAQ,GAAiB,EAAE,UAAU,EAAE,CAAC;IAC9C,aAAa,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEtD,aAAa,CACT,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,oBAAoB,CAAC,EAC1C,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAC7F,CAAC;IAEF,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;AAC7C,CAAC,CAAC;AAEF,OAAO,EAAE,SAAS,EAA+E,CAAC","sourcesContent":["import { sortStringsBy } from \"@gtkx/utils\";\nimport { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from \"node:fs\";\nimport { dirname, join } from \"node:path\";\nimport { computeGiFingerprint, FINGERPRINT_FILENAME, isGiStoreFresh } from \"../fingerprint.js\";\nimport { Library } from \"../gir/library.js\";\nimport { namespaceDirectory } from \"../gir/namespace.js\";\nimport { type ElementProps, setElementProps } from \"../store/jsx/element-prop-imports.js\";\nimport { collectIntrinsicElementClasses, type GlibNamedClass } from \"../store/jsx/intrinsic-elements.js\";\nimport { type OmittedProps, setOmittedProps } from \"../store/jsx/omitted-props.js\";\nimport { createElementPageContext, type ElementPageContext, renderElementPage } from \"./element-page.js\";\nimport { elementSlug, firstSentence, namespaceOrder } from \"./render.js\";\n\ntype DocsElementLink = {\n    text: string;\n    link: string;\n};\n\ntype DocsNamespace = {\n    name: string;\n    directory: string;\n    link: string;\n    elements: DocsElementLink[];\n};\n\ntype DocsOptions = {\n    libraries: string[];\n    girPath: string[];\n    outDir: string;\n    basePath?: string;\n    props?: ElementProps;\n    omitProps?: OmittedProps;\n    force?: boolean;\n};\n\ntype DocsManifest = {\n    namespaces: DocsNamespace[];\n};\n\ntype GeneratedDocs = {\n    pages: { path: string; content: string }[];\n    namespaces: DocsNamespace[];\n};\n\ntype Page = { path: string; content: string };\ntype NamespacePages = { docs: DocsNamespace; pages: Page[] };\n\ntype DocsResult = {\n    regenerated: boolean;\n    namespaces: DocsNamespace[];\n};\n\nconst MANIFEST_FILENAME = \"manifest.json\";\n\nconst namespaceIndexPage = (namespace: DocsNamespace, elements: GlibNamedClass[]): string => {\n    const rows = elements.map((entry, index) => {\n        const link = namespace.elements[index]?.link ?? \"\";\n        const description = firstSentence(entry.klass.doc).replaceAll(\"|\", String.raw`\\|`);\n\n        return `| [${entry.glibName}](${link}) | ${description} |`;\n    });\n\n    const description =\n        `Reference pages for the ${String(namespace.elements.length)} JSX elements in ` +\n        `the ${namespace.name} namespace.`;\n\n    return [\n        \"---\",\n        `description: ${JSON.stringify(description)}`,\n        \"---\",\n        \"\",\n        `# ${namespace.name} elements`,\n        \"\",\n        `Elements in this namespace are imported from \\`@gtkx/jsx/${namespace.directory}\\`; the matching ` +\n        `classes, enums, and functions are imported from \\`@gtkx/gi/${namespace.directory}\\`.`,\n        \"\",\n        \"| Element | Description |\",\n        \"| --- | --- |\",\n        ...rows,\n        \"\",\n    ].join(\"\\n\");\n};\n\nconst rootIndexPage = (namespaces: DocsNamespace[], libraries: string[]): string => {\n    const rows = namespaces.map(\n        (ns) => `| [${ns.name}](${ns.link}) | \\`@gtkx/jsx/${ns.directory}\\` | ${String(ns.elements.length)} |`,\n    );\n\n    const librariesList = libraries.map((library) => `\\`${library}\\``).join(\", \");\n\n    return [\n        \"---\",\n        \"description: \\\"Generated reference documentation for every JSX element in this project's GIR libraries.\\\"\",\n        \"---\",\n        \"\",\n        \"# Element Reference\",\n        \"\",\n        \"This reference documents every JSX element generated from the GObject-Introspection data for \" +\n        `${librariesList}, together with the namespaces they pull in. It is produced by \\`gtkx docs\\` ` +\n        \"using the same pipeline that generates the `@gtkx/jsx` and `@gtkx/gi` bindings, so every page \" +\n        \"matches the types your editor sees.\",\n        \"\",\n        \"Each element page lists:\",\n        \"\",\n        \"- **Props** derived from GObject properties, plus the element props GTKX adds (such as `children` \" +\n        \"and named slots), with types, defaults, and upstream documentation.\",\n        \"- **Signals** as `on<Signal>` handler props with their exact handler signatures.\",\n        \"- **Methods** available on the underlying instance through the `ref` prop.\",\n        \"\",\n        \"## Namespaces\",\n        \"\",\n        \"| Namespace | Import | Elements |\",\n        \"| --- | --- | --- |\",\n        ...rows,\n        \"\",\n    ].join(\"\\n\");\n};\n\nconst groupElementsByNamespace = (elements: GlibNamedClass[]): Map<string, GlibNamedClass[]> => {\n    const byNamespace: Map<string, GlibNamedClass[]> = new Map();\n\n    for (const entry of elements) {\n        const list = byNamespace.get(entry.namespace.name) ?? [];\n        list.push(entry);\n        byNamespace.set(entry.namespace.name, list);\n    }\n\n    return byNamespace;\n};\n\nconst buildElementLinks = (elements: GlibNamedClass[], basePath: string): Map<string, string> => {\n    const linkByGlibName: Map<string, string> = new Map();\n\n    for (const entry of elements) {\n        const directory = namespaceDirectory(entry.namespace);\n        const link = `${basePath}/${directory}/${elementSlug(entry.klass.name)}`;\n\n        if (linkByGlibName.values().some((existing) => existing === link)) {\n            throw new Error(`Docs page slug collision for ${entry.glibName} at ${link}`);\n        }\n\n        linkByGlibName.set(entry.glibName, link);\n    }\n\n    return linkByGlibName;\n};\n\nconst namespacePages = (input: {\n    name: string;\n    elements: GlibNamedClass[];\n    basePath: string;\n    linkByGlibName: Map<string, string>;\n    pageContext: ElementPageContext;\n}): NamespacePages => {\n    const { name, elements, basePath, linkByGlibName, pageContext } = input;\n    const directory = name.toLowerCase();\n\n    const docs: DocsNamespace = {\n        name,\n        directory,\n        link: `${basePath}/${directory}/`,\n        elements: elements.map((entry) => ({ text: entry.glibName, link: linkByGlibName.get(entry.glibName) ?? \"\" })),\n    };\n\n    const pages: Page[] = elements.map((entry) => ({\n        path: `${directory}/${elementSlug(entry.klass.name)}.md`,\n        content: renderElementPage(entry, pageContext),\n    }));\n\n    pages.push({ path: `${directory}/index.md`, content: namespaceIndexPage(docs, elements) });\n\n    return { docs, pages };\n};\n\nconst generatePages = (options: DocsOptions, basePath: string, library: Library): GeneratedDocs => {\n    const intrinsicElements = collectIntrinsicElementClasses(library);\n    const byNamespace = groupElementsByNamespace(intrinsicElements);\n    const linkByGlibName = buildElementLinks(intrinsicElements, basePath);\n    const pageContext = createElementPageContext(library, (glibName: string) => linkByGlibName.get(glibName));\n    const pages: Page[] = [];\n    const namespaces: DocsNamespace[] = [];\n    const orderedNames = sortStringsBy(byNamespace.keys(), namespaceOrder);\n\n    for (const name of orderedNames) {\n        const elements = sortStringsBy(byNamespace.get(name) ?? [], (entry) => entry.glibName);\n        const result = namespacePages({ name, elements, basePath, linkByGlibName, pageContext });\n        pages.push(...result.pages);\n        namespaces.push(result.docs);\n    }\n\n    pages.push({ path: \"index.md\", content: rootIndexPage(namespaces, options.libraries) });\n\n    return { pages, namespaces };\n};\n\nconst cachedDocsResult = (options: DocsOptions, manifestPath: string): DocsResult | undefined => {\n    if (options.force === true || !isGiStoreFresh(options.outDir, options.libraries, options.girPath)) {\n        return undefined;\n    }\n\n    if (!existsSync(manifestPath)) {\n        return undefined;\n    }\n\n    const manifest = JSON.parse(readFileSync(manifestPath, \"utf8\")) as DocsManifest;\n\n    return { regenerated: false, namespaces: manifest.namespaces };\n};\n\nconst writePages = (outDir: string, pages: Page[]): void => {\n    for (const page of pages) {\n        const target = join(outDir, page.path);\n        mkdirSync(dirname(target), { recursive: true });\n        writeFileSync(target, page.content);\n    }\n};\n\nconst writeDocs = (options: DocsOptions): DocsResult => {\n    setElementProps(options.props ?? {});\n    setOmittedProps(options.omitProps ?? {});\n    const basePath = options.basePath ?? \"/reference\";\n    const manifestPath = join(options.outDir, MANIFEST_FILENAME);\n    const cached = cachedDocsResult(options, manifestPath);\n\n    if (cached !== undefined) {\n        return cached;\n    }\n\n    const library = Library.load(options.libraries, options.girPath);\n    const { pages, namespaces } = generatePages(options, basePath, library);\n    rmSync(options.outDir, { recursive: true, force: true });\n    mkdirSync(options.outDir, { recursive: true });\n    writePages(options.outDir, pages);\n    const manifest: DocsManifest = { namespaces };\n    writeFileSync(manifestPath, JSON.stringify(manifest));\n\n    writeFileSync(\n        join(options.outDir, FINGERPRINT_FILENAME),\n        JSON.stringify(computeGiFingerprint(library.girFiles, options.libraries, options.girPath)),\n    );\n\n    return { regenerated: true, namespaces };\n};\n\nexport { writeDocs, type DocsElementLink, type DocsNamespace, type DocsOptions, type DocsResult };\n"]}
+{"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../../src/docs/pipeline.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACrF,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC/F,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAqB,eAAe,EAAE,MAAM,sCAAsC,CAAC;AAC1F,OAAO,EAAE,8BAA8B,EAAuB,MAAM,oCAAoC,CAAC;AACzG,OAAO,EAAqB,eAAe,EAAE,MAAM,+BAA+B,CAAC;AACnF,OAAO,EAA2B,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAC/E,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAyCzE,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAE1C,MAAM,kBAAkB,GAAG,CAAC,SAAwB,EAAE,QAA0B,EAAU,EAAE;IACxF,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACvC,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;QACnD,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAA,IAAI,CAAC,CAAC;QAEnF,OAAO,MAAM,KAAK,CAAC,QAAQ,KAAK,IAAI,OAAO,WAAW,IAAI,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,MAAM,WAAW,GACb,2BAA2B,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,mBAAmB;QAC/E,OAAO,SAAS,CAAC,IAAI,aAAa,CAAC;IAEvC,OAAO;QACH,KAAK;QACL,gBAAgB,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE;QAC7C,KAAK;QACL,EAAE;QACF,KAAK,SAAS,CAAC,IAAI,WAAW;QAC9B,EAAE;QACF,4DAA4D,SAAS,CAAC,SAAS,mBAAmB;YAClG,8DAA8D,SAAS,CAAC,SAAS,KAAK;QACtF,EAAE;QACF,2BAA2B;QAC3B,eAAe;QACf,GAAG,IAAI;QACP,EAAE;KACL,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,UAA2B,EAAE,SAAmB,EAAU,EAAE;IAC/E,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CACvB,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,IAAI,mBAAmB,EAAE,CAAC,SAAS,QAAQ,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CACzG,CAAC;IAEF,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE9E,OAAO;QACH,KAAK;QACL,2GAA2G;QAC3G,KAAK;QACL,EAAE;QACF,qBAAqB;QACrB,EAAE;QACF,+FAA+F;YAC/F,GAAG,aAAa,+EAA+E;YAC/F,gGAAgG;YAChG,qCAAqC;QACrC,EAAE;QACF,0BAA0B;QAC1B,EAAE;QACF,oGAAoG;YACpG,qEAAqE;QACrE,kFAAkF;QAClF,4EAA4E;QAC5E,EAAE;QACF,eAAe;QACf,EAAE;QACF,mCAAmC;QACnC,qBAAqB;QACrB,GAAG,IAAI;QACP,EAAE;KACL,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,QAA0B,EAAiC,EAAE;IAC3F,MAAM,WAAW,GAAkC,IAAI,GAAG,EAAE,CAAC;IAE7D,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACzD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjB,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,WAAW,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,QAA0B,EAAE,QAAgB,EAAuB,EAAE;IAC5F,MAAM,cAAc,GAAwB,IAAI,GAAG,EAAE,CAAC;IAEtD,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC3B,MAAM,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACtD,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,SAAS,IAAI,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAEzE,IAAI,cAAc,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,KAAK,IAAI,CAAC,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,CAAC,QAAQ,OAAO,IAAI,EAAE,CAAC,CAAC;QACjF,CAAC;QAED,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,cAAc,CAAC;AAC1B,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,KAMvB,EAAkB,EAAE;IACjB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;IACxE,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAErC,MAAM,IAAI,GAAkB;QACxB,IAAI;QACJ,SAAS;QACT,IAAI,EAAE,GAAG,QAAQ,IAAI,SAAS,GAAG;QACjC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;KAChH,CAAC;IAEF,MAAM,KAAK,GAAW,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC3C,IAAI,EAAE,GAAG,SAAS,IAAI,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK;QACxD,OAAO,EAAE,iBAAiB,CAAC,KAAK,EAAE,WAAW,CAAC;KACjD,CAAC,CAAC,CAAC;IAEJ,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,SAAS,WAAW,EAAE,OAAO,EAAE,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;IAE3F,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,OAAoB,EAAE,QAAgB,EAAE,OAAgB,EAAiB,EAAE;IAC9F,MAAM,iBAAiB,GAAG,8BAA8B,CAAC,OAAO,CAAC,CAAC;IAClE,MAAM,WAAW,GAAG,wBAAwB,CAAC,iBAAiB,CAAC,CAAC;IAChE,MAAM,cAAc,GAAG,iBAAiB,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACtE,MAAM,WAAW,GAAuB,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;IACzG,MAAM,KAAK,GAAW,EAAE,CAAC;IACzB,MAAM,UAAU,GAAoB,EAAE,CAAC;IACvC,MAAM,YAAY,GAAG,aAAa,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,cAAc,CAAC,CAAC;IAEvE,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QAC9B,MAAM,QAAQ,GAAG,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACvF,MAAM,MAAM,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC;QACzF,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5B,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAExF,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAAoB,EAAE,YAAoB,EAA0B,EAAE;IAC5F,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACnG,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAiB,CAAC;IAEhF,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,CAAC;AACrE,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,KAAa,EAAQ,EAAE;IACvD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAChD,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,OAAoB,EAAc,EAAE;IACnD,eAAe,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IACrC,eAAe,CAAC,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;IAC5C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,YAAY,CAAC;IAClD,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC7D,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAEvD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACjE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,aAAa,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACxE,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACzD,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClC,MAAM,QAAQ,GAAiB,EAAE,UAAU,EAAE,CAAC;IAC9C,aAAa,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEtD,aAAa,CACT,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,oBAAoB,CAAC,EAC1C,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAC7F,CAAC;IAEF,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;AAC/C,CAAC,CAAC;AAEF,OAAO,EAAE,SAAS,EAAE,CAAC","sourcesContent":["import { sortStringsBy } from \"@gtkx/utils\";\nimport { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from \"node:fs\";\nimport { dirname, join } from \"node:path\";\nimport { computeGiFingerprint, FINGERPRINT_FILENAME, isGiStoreFresh } from \"../fingerprint.js\";\nimport { Library } from \"../gir/library.js\";\nimport { namespaceDirectory } from \"../gir/namespace.js\";\nimport { type ElementProps, setElementProps } from \"../store/jsx/element-prop-imports.js\";\nimport { collectIntrinsicElementClasses, type GlibNamedClass } from \"../store/jsx/intrinsic-elements.js\";\nimport { type OmittedProps, setOmittedProps } from \"../store/jsx/omitted-props.js\";\nimport { type ElementPageContext, renderElementPage } from \"./element-page.js\";\nimport { elementSlug, firstSentence, namespaceOrder } from \"./render.js\";\n\ntype DocsElementLink = {\n    text: string;\n    link: string;\n};\n\ntype DocsNamespace = {\n    name: string;\n    directory: string;\n    link: string;\n    elements: DocsElementLink[];\n};\n\ntype DocsOptions = {\n    libraries: string[];\n    girPath: string[];\n    outDir: string;\n    basePath?: string;\n    props?: ElementProps;\n    omittedProps?: OmittedProps;\n    isForced?: boolean;\n};\n\ntype DocsManifest = {\n    namespaces: DocsNamespace[];\n};\n\ntype GeneratedDocs = {\n    pages: { path: string; content: string }[];\n    namespaces: DocsNamespace[];\n};\n\ntype Page = { path: string; content: string };\ntype NamespacePages = { docs: DocsNamespace; pages: Page[] };\n\ntype DocsResult = {\n    isRegenerated: boolean;\n    namespaces: DocsNamespace[];\n};\n\nconst MANIFEST_FILENAME = \"manifest.json\";\n\nconst namespaceIndexPage = (namespace: DocsNamespace, elements: GlibNamedClass[]): string => {\n    const rows = elements.map((entry, index) => {\n        const link = namespace.elements[index]?.link ?? \"\";\n        const description = firstSentence(entry.klass.doc).replaceAll(\"|\", String.raw`\\|`);\n\n        return `| [${entry.glibName}](${link}) | ${description} |`;\n    });\n\n    const description =\n        `Reference pages for the ${String(namespace.elements.length)} JSX elements in ` +\n        `the ${namespace.name} namespace.`;\n\n    return [\n        \"---\",\n        `description: ${JSON.stringify(description)}`,\n        \"---\",\n        \"\",\n        `# ${namespace.name} elements`,\n        \"\",\n        `Elements in this namespace are imported from \\`@gtkx/jsx/${namespace.directory}\\`; the matching ` +\n        `classes, enums, and functions are imported from \\`@gtkx/gi/${namespace.directory}\\`.`,\n        \"\",\n        \"| Element | Description |\",\n        \"| --- | --- |\",\n        ...rows,\n        \"\",\n    ].join(\"\\n\");\n};\n\nconst rootIndexPage = (namespaces: DocsNamespace[], libraries: string[]): string => {\n    const rows = namespaces.map(\n        (ns) => `| [${ns.name}](${ns.link}) | \\`@gtkx/jsx/${ns.directory}\\` | ${String(ns.elements.length)} |`,\n    );\n\n    const librariesList = libraries.map((library) => `\\`${library}\\``).join(\", \");\n\n    return [\n        \"---\",\n        \"description: \\\"Generated reference documentation for every JSX element in this project's GIR libraries.\\\"\",\n        \"---\",\n        \"\",\n        \"# Element Reference\",\n        \"\",\n        \"This reference documents every JSX element generated from the GObject-Introspection data for \" +\n        `${librariesList}, together with the namespaces they pull in. It is produced by \\`gtkx docs\\` ` +\n        \"using the same pipeline that generates the `@gtkx/jsx` and `@gtkx/gi` bindings, so every page \" +\n        \"matches the types your editor sees.\",\n        \"\",\n        \"Each element page lists:\",\n        \"\",\n        \"- **Props** derived from GObject properties, plus the element props GTKX adds (such as `children` \" +\n        \"and named slots), with types, defaults, and upstream documentation.\",\n        \"- **Signals** as `on<Signal>` handler props with their exact handler signatures.\",\n        \"- **Methods** available on the underlying instance through the `ref` prop.\",\n        \"\",\n        \"## Namespaces\",\n        \"\",\n        \"| Namespace | Import | Elements |\",\n        \"| --- | --- | --- |\",\n        ...rows,\n        \"\",\n    ].join(\"\\n\");\n};\n\nconst groupElementsByNamespace = (elements: GlibNamedClass[]): Map<string, GlibNamedClass[]> => {\n    const byNamespace: Map<string, GlibNamedClass[]> = new Map();\n\n    for (const entry of elements) {\n        const list = byNamespace.get(entry.namespace.name) ?? [];\n        list.push(entry);\n        byNamespace.set(entry.namespace.name, list);\n    }\n\n    return byNamespace;\n};\n\nconst buildElementLinks = (elements: GlibNamedClass[], basePath: string): Map<string, string> => {\n    const linkByGlibName: Map<string, string> = new Map();\n\n    for (const entry of elements) {\n        const directory = namespaceDirectory(entry.namespace);\n        const link = `${basePath}/${directory}/${elementSlug(entry.klass.name)}`;\n\n        if (linkByGlibName.values().some((existing) => existing === link)) {\n            throw new Error(`Docs page slug collision for ${entry.glibName} at ${link}`);\n        }\n\n        linkByGlibName.set(entry.glibName, link);\n    }\n\n    return linkByGlibName;\n};\n\nconst namespacePages = (input: {\n    name: string;\n    elements: GlibNamedClass[];\n    basePath: string;\n    linkByGlibName: Map<string, string>;\n    pageContext: ElementPageContext;\n}): NamespacePages => {\n    const { name, elements, basePath, linkByGlibName, pageContext } = input;\n    const directory = name.toLowerCase();\n\n    const docs: DocsNamespace = {\n        name,\n        directory,\n        link: `${basePath}/${directory}/`,\n        elements: elements.map((entry) => ({ text: entry.glibName, link: linkByGlibName.get(entry.glibName) ?? \"\" })),\n    };\n\n    const pages: Page[] = elements.map((entry) => ({\n        path: `${directory}/${elementSlug(entry.klass.name)}.md`,\n        content: renderElementPage(entry, pageContext),\n    }));\n\n    pages.push({ path: `${directory}/index.md`, content: namespaceIndexPage(docs, elements) });\n\n    return { docs, pages };\n};\n\nconst generatePages = (options: DocsOptions, basePath: string, library: Library): GeneratedDocs => {\n    const intrinsicElements = collectIntrinsicElementClasses(library);\n    const byNamespace = groupElementsByNamespace(intrinsicElements);\n    const linkByGlibName = buildElementLinks(intrinsicElements, basePath);\n    const pageContext: ElementPageContext = { library, linkFor: (glibName) => linkByGlibName.get(glibName) };\n    const pages: Page[] = [];\n    const namespaces: DocsNamespace[] = [];\n    const orderedNames = sortStringsBy(byNamespace.keys(), namespaceOrder);\n\n    for (const name of orderedNames) {\n        const elements = sortStringsBy(byNamespace.get(name) ?? [], (entry) => entry.glibName);\n        const result = namespacePages({ name, elements, basePath, linkByGlibName, pageContext });\n        pages.push(...result.pages);\n        namespaces.push(result.docs);\n    }\n\n    pages.push({ path: \"index.md\", content: rootIndexPage(namespaces, options.libraries) });\n\n    return { pages, namespaces };\n};\n\nconst cachedDocsResult = (options: DocsOptions, manifestPath: string): DocsResult | undefined => {\n    if (options.isForced === true || !isGiStoreFresh(options.outDir, options.libraries, options.girPath)) {\n        return undefined;\n    }\n\n    if (!existsSync(manifestPath)) {\n        return undefined;\n    }\n\n    const manifest = JSON.parse(readFileSync(manifestPath, \"utf8\")) as DocsManifest;\n\n    return { isRegenerated: false, namespaces: manifest.namespaces };\n};\n\nconst writePages = (outDir: string, pages: Page[]): void => {\n    for (const page of pages) {\n        const target = join(outDir, page.path);\n        mkdirSync(dirname(target), { recursive: true });\n        writeFileSync(target, page.content);\n    }\n};\n\nconst writeDocs = (options: DocsOptions): DocsResult => {\n    setElementProps(options.props ?? {});\n    setOmittedProps(options.omittedProps ?? {});\n    const basePath = options.basePath ?? \"/reference\";\n    const manifestPath = join(options.outDir, MANIFEST_FILENAME);\n    const cached = cachedDocsResult(options, manifestPath);\n\n    if (cached !== undefined) {\n        return cached;\n    }\n\n    const library = Library.load(options.libraries, options.girPath);\n    const { pages, namespaces } = generatePages(options, basePath, library);\n    rmSync(options.outDir, { recursive: true, force: true });\n    mkdirSync(options.outDir, { recursive: true });\n    writePages(options.outDir, pages);\n    const manifest: DocsManifest = { namespaces };\n    writeFileSync(manifestPath, JSON.stringify(manifest));\n\n    writeFileSync(\n        join(options.outDir, FINGERPRINT_FILENAME),\n        JSON.stringify(computeGiFingerprint(library.girFiles, options.libraries, options.girPath)),\n    );\n\n    return { isRegenerated: true, namespaces };\n};\n\nexport { writeDocs };\n"]}

package/dist/docs/render.d.ts

@@ -1,34 +1,54 @@
+import type { GirAnnotations } from "../gir/annotations.js";
 import type { GirClass } from "../gir/class.js";
-import type { GirFunction } from "../gir/function.js";
 import type { Library } from "../gir/library.js";
 import type { GirNamespace } from "../gir/namespace.js";
 import type { GirCallable } from "../gir/parameter.js";
+import type { GirProperty } from "../gir/property.js";
 import type { TypeId } from "../gir/type-id.js";
+import type { JsDocSpec } from "../writer/doc-tags.js";
 import { ModuleContext } from "../writer/context.js";
 type SignatureEntry = {
     name: string;
     signature: string;
     doc: string;
+    tags?: JsDocSpec | undefined;
 };
 type OriginSignatureEntry = SignatureEntry & {
     origin: string | undefined;
 };
+type MetaDocEntry = {
+    name: string;
+    meta: string;
+    doc: string;
+    tags?: JsDocSpec | undefined;
+};
+type PropertyMetaOptions = {
+    type: string;
+    property: GirProperty;
+    accessNotes: string[];
+    origin: string | undefined;
+};
 declare const renderDocsType: (library: Library, ref: TypeId | undefined, isNullable: boolean) => string;
 declare const renderDocsSignalSignature: (library: Library, signal: GirCallable, selfType: string) => string;
 declare const renderDocsSignalHandlerType: (library: Library, signal: GirCallable) => string;
-declare const docsDefaultValue: (value: string) => string;
 declare const docMarkdown: (doc: string | undefined) => string;
+declare const plainText: (doc: string | undefined) => string;
 declare const firstSentence: (doc: string | undefined) => string;
 declare const elementSlug: (className: string) => string;
 declare const implementsLine: (names: string[]) => string[];
 declare const joinSections: (sections: string[]) => string;
-declare const metaBlock: (name: string, meta: string, doc: string) => string;
+declare const tagNotes: (spec: JsDocSpec | undefined) => string[];
+declare const deprecationMeta: (annotations: GirAnnotations) => string[];
+declare const annotationNotes: (annotations: GirAnnotations) => string[];
+declare const signalTags: (signal: GirCallable, isSelfIncluded: boolean) => JsDocSpec;
+declare const sortedMetaBlocks: (entries: MetaDocEntry[]) => string[];
+declare const propertyMetaLine: ({ type, property, accessNotes, origin }: PropertyMetaOptions) => string;
 declare const signatureBlock: (name: string, signature: string, notes: string[]) => string;
+declare const signatureEntryBlock: (entry: SignatureEntry, leadingNotes?: string[]) => string;
 declare const namespaceOrder: (name: string) => string;
 declare const docsSignatureContext: (namespace: GirNamespace, library: Library) => ModuleContext;
 declare const originSignatureBlocks: (entries: OriginSignatureEntry[]) => string[];
 declare const classMethodEntries: (library: Library, namespace: GirNamespace, klass: GirClass) => SignatureEntry[];
 declare const methodsSectionBlocks: (entries: SignatureEntry[], intro: string) => string[];
-declare const instanceMethodEntries: (signatureContext: ModuleContext, klass: GirClass, rename: (fn: GirFunction) => string | undefined) => SignatureEntry[];
-export { renderDocsType, renderDocsSignalSignature, renderDocsSignalHandlerType, docsDefaultValue, docMarkdown, firstSentence, elementSlug, implementsLine, joinSections, metaBlock, signatureBlock, namespaceOrder, docsSignatureContext, originSignatureBlocks, classMethodEntries, methodsSectionBlocks, instanceMethodEntries, type SignatureEntry, type OriginSignatureEntry, };
+export { renderDocsType, renderDocsSignalSignature, renderDocsSignalHandlerType, annotationNotes, deprecationMeta, docMarkdown, firstSentence, elementSlug, implementsLine, joinSections, plainText, propertyMetaLine, signalTags, signatureBlock, signatureEntryBlock, sortedMetaBlocks, namespaceOrder, docsSignatureContext, originSignatureBlocks, classMethodEntries, methodsSectionBlocks, tagNotes, type MetaDocEntry, type SignatureEntry, type OriginSignatureEntry, };
 //# sourceMappingURL=render.d.ts.map

package/dist/docs/render.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../../src/docs/render.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAMhD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAGrD,KAAK,cAAc,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,KAAK,oBAAoB,GAAG,cAAc,GAAG;IAAE,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAe5E,QAAA,MAAM,cAAc,GAAI,SAAS,OAAO,EAAE,KAAK,MAAM,GAAG,SAAS,EAAE,YAAY,OAAO,KAAG,MAIxF,CAAC;AAcF,QAAA,MAAM,yBAAyB,GAAI,SAAS,OAAO,EAAE,QAAQ,WAAW,EAAE,UAAU,MAAM,KAAG,MAI5F,CAAC;AAEF,QAAA,MAAM,2BAA2B,GAAI,SAAS,OAAO,EAAE,QAAQ,WAAW,KAAG,MACwC,CAAC;AAEtH,QAAA,MAAM,gBAAgB,GAAI,OAAO,MAAM,KAAG,MAA6C,CAAC;AAiCxF,QAAA,MAAM,WAAW,GAAI,KAAK,MAAM,GAAG,SAAS,KAAG,MAC6D,CAAC;AAW7G,QAAA,MAAM,aAAa,GAAI,KAAK,MAAM,GAAG,SAAS,KAAG,MAWhD,CAAC;AAEF,QAAA,MAAM,WAAW,GAAI,WAAW,MAAM,KAAG,MAInB,CAAC;AAEvB,QAAA,MAAM,cAAc,GAAI,OAAO,MAAM,EAAE,KAAG,MAAM,EAQ/C,CAAC;AAEF,QAAA,MAAM,YAAY,GAAI,UAAU,MAAM,EAAE,KAAG,MAC6B,CAAC;AAEzE,QAAA,MAAM,SAAS,GAAI,MAAM,MAAM,EAAE,MAAM,MAAM,EAAE,KAAK,MAAM,KAAG,MAQ5D,CAAC;AAEF,QAAA,MAAM,cAAc,GAAI,MAAM,MAAM,EAAE,WAAW,MAAM,EAAE,OAAO,MAAM,EAAE,KAAG,MAU1E,CAAC;AAEF,QAAA,MAAM,cAAc,GAAI,MAAM,MAAM,KAAG,MAItC,CAAC;AAEF,QAAA,MAAM,oBAAoB,GAAI,WAAW,YAAY,EAAE,SAAS,OAAO,KAAG,aACM,CAAC;AAEjF,QAAA,MAAM,qBAAqB,GAAI,SAAS,oBAAoB,EAAE,KAAG,MAAM,EAMlE,CAAC;AAEN,QAAA,MAAM,kBAAkB,GAAI,SAAS,OAAO,EAAE,WAAW,YAAY,EAAE,OAAO,QAAQ,KAAG,cAAc,EAStG,CAAC;AAEF,QAAA,MAAM,oBAAoB,GAAI,SAAS,cAAc,EAAE,EAAE,OAAO,MAAM,KAAG,MAAM,EAGiC,CAAC;AAEjH,QAAA,MAAM,qBAAqB,GACvB,kBAAkB,aAAa,EAC/B,OAAO,QAAQ,EACf,QAAQ,CAAC,EAAE,EAAE,WAAW,KAAK,MAAM,GAAG,SAAS,KAChD,cAAc,EAiChB,CAAC;AAEF,OAAO,EACH,cAAc,EACd,yBAAyB,EACzB,2BAA2B,EAC3B,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,WAAW,EACX,cAAc,EACd,YAAY,EACZ,SAAS,EACT,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,KAAK,cAAc,EACnB,KAAK,oBAAoB,GAC5B,CAAC"}
+{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../../src/docs/render.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAgC,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAYrF,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAIrD,KAAK,cAAc,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,KAAK,oBAAoB,GAAG,cAAc,GAAG;IAAE,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAE5E,KAAK,YAAY,GAAG;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,WAAW,CAAC;IACtB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AAgBF,QAAA,MAAM,cAAc,GAAI,SAAS,OAAO,EAAE,KAAK,MAAM,GAAG,SAAS,EAAE,YAAY,OAAO,KAAG,MAIxF,CAAC;AAcF,QAAA,MAAM,yBAAyB,GAAI,SAAS,OAAO,EAAE,QAAQ,WAAW,EAAE,UAAU,MAAM,KAAG,MAI5F,CAAC;AAEF,QAAA,MAAM,2BAA2B,GAAI,SAAS,OAAO,EAAE,QAAQ,WAAW,KAAG,MACwC,CAAC;AA6BtH,QAAA,MAAM,WAAW,GAAI,KAAK,MAAM,GAAG,SAAS,KAAG,MAC6D,CAAC;AAY7G,QAAA,MAAM,SAAS,GAAI,KAAK,MAAM,GAAG,SAAS,KAAG,MAAyC,CAAC;AAEvF,QAAA,MAAM,aAAa,GAAI,KAAK,MAAM,GAAG,SAAS,KAAG,MAWhD,CAAC;AAEF,QAAA,MAAM,WAAW,GAAI,WAAW,MAAM,KAAG,MAInB,CAAC;AAEvB,QAAA,MAAM,cAAc,GAAI,OAAO,MAAM,EAAE,KAAG,MAAM,EAQ/C,CAAC;AAEF,QAAA,MAAM,YAAY,GAAI,UAAU,MAAM,EAAE,KAAG,MAC6B,CAAC;AAkCzE,QAAA,MAAM,QAAQ,GAAI,MAAM,SAAS,GAAG,SAAS,KAAG,MAAM,EAYrD,CAAC;AAEF,QAAA,MAAM,eAAe,GAAI,aAAa,cAAc,KAAG,MAAM,EAQ5D,CAAC;AAEF,QAAA,MAAM,eAAe,GAAI,aAAa,cAAc,KAAG,MAAM,EAA2C,CAAC;AAEzG,QAAA,MAAM,UAAU,GAAI,QAAQ,WAAW,EAAE,gBAAgB,OAAO,KAAG,SACkB,CAAC;AActF,QAAA,MAAM,gBAAgB,GAAI,SAAS,YAAY,EAAE,KAAG,MAAM,EACoB,CAAC;AAE/E,QAAA,MAAM,gBAAgB,GAAI,yCAAyC,mBAAmB,KAAG,MAkBxF,CAAC;AAEF,QAAA,MAAM,cAAc,GAAI,MAAM,MAAM,EAAE,WAAW,MAAM,EAAE,OAAO,MAAM,EAAE,KAAG,MAU1E,CAAC;AAEF,QAAA,MAAM,mBAAmB,GAAI,OAAO,cAAc,EAAE,eAAc,MAAM,EAAO,KAAG,MACoB,CAAC;AAEvG,QAAA,MAAM,cAAc,GAAI,MAAM,MAAM,KAAG,MAItC,CAAC;AAEF,QAAA,MAAM,oBAAoB,GAAI,WAAW,YAAY,EAAE,SAAS,OAAO,KAAG,aACM,CAAC;AAEjF,QAAA,MAAM,qBAAqB,GAAI,SAAS,oBAAoB,EAAE,KAAG,MAAM,EAGlE,CAAC;AAEN,QAAA,MAAM,kBAAkB,GAAI,SAAS,OAAO,EAAE,WAAW,YAAY,EAAE,OAAO,QAAQ,KAAG,cAAc,EAStG,CAAC;AAEF,QAAA,MAAM,oBAAoB,GAAI,SAAS,cAAc,EAAE,EAAE,OAAO,MAAM,KAAG,MAAM,EAC2B,CAAC;AA0C3G,OAAO,EACH,cAAc,EACd,yBAAyB,EACzB,2BAA2B,EAC3B,eAAe,EACf,eAAe,EACf,WAAW,EACX,aAAa,EACb,WAAW,EACX,cAAc,EACd,YAAY,EACZ,SAAS,EACT,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,mBAAmB,EACnB,gBAAgB,EAChB,cAAc,EACd,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,QAAQ,EACR,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,oBAAoB,GAC5B,CAAC"}

package/dist/docs/render.js

@@ -2,15 +2,18 @@ import { pascalCase, sortStringsBy } from "@gtkx/utils";
 import { collectInheritedMethods, conflictRename } from "../analysis/inheritance.js";
 import { renderHandlerParameters, renderHandlerResultType } from "../analysis/param-structure.js";
 import { recordTypeTarget, renderBaseType } from "../analysis/ts-type.js";
-import { dedupeCallables, instanceScope, renderInstanceMethodSignature } from "../store/gi/callables.js";
+import { dedupeCallables, instanceMemberSpec, instanceScope, renderInstanceMethodSignature, } from "../store/gi/callables.js";
+import { annotationSpec, handlerSpec, selfHandlerSpec } from "../store/gi/doc-spec.js";
 import { methodExportName } from "../store/gi/method.js";
 import { ModuleContext } from "../writer/context.js";
+import { stripDocMedia } from "../writer/doc-tags.js";
 import { gtkDocToMarkdown } from "../writer/gtk-doc.js";
 const DOCS_DEFAULT_VALUES = { TRUE: "true", FALSE: "false", NULL: "null" };
 const FENCE_LINE = /^\s*(```|~~~)/;
 const HEADING_LINE = /^#{1,5}\s/;
 const LEADING_NAMESPACES = ["Gtk", "Adw"];
 const DOCS_SIGNATURE_NAMESPACE = "$docs";
+const WHITESPACE_RUN = /\s+/g;
 const docsTarget = (library) => recordTypeTarget(library, (name) => `${name.namespaceName}.${name.typeName}`, () => "GObject.Type");
 const renderDocsType = (library, ref, isNullable) => {
     const base = renderBaseType(library, docsTarget(library), ref);
@@ -20,8 +23,8 @@ const renderDocsHandlerResultType = (library, signal) => renderHandlerResultType
     library,
     signal,
     renderType: (ref, nullable) => renderDocsType(library, ref, nullable),
-    includeCallerAllocated: false,
-    optOut: true,
+    shouldIncludeCallerAllocated: false,
+    isOptOut: true,
 });
 const renderDocsHandlerParameters = (library, signal) => renderHandlerParameters(signal.parameters, (ref, nullable) => renderDocsType(library, ref, nullable));
 const renderDocsSignalSignature = (library, signal, selfType) => {
@@ -30,25 +33,21 @@ const renderDocsSignalSignature = (library, signal, selfType) => {
 };
 const renderDocsSignalHandlerType = (library, signal) => `(${renderDocsHandlerParameters(library, signal).join(", ")}) => ${renderDocsHandlerResultType(library, signal)}`;
 const docsDefaultValue = (value) => DOCS_DEFAULT_VALUES[value] ?? value;
-const stripDocMedia = (markdown) => markdown
-    .replaceAll(/<picture[\s\S]*?<\/picture>/g, "")
-    .replaceAll(/<video[\s\S]*?(?:<\/video>|\/>)/g, "")
-    .replaceAll(/<img[^>]*>/g, "");
 const demoteLine = (line, isInFence) => {
     if (FENCE_LINE.test(line)) {
-        return { text: line, inFence: !isInFence };
+        return { text: line, isInFence: !isInFence };
     }
     if (isInFence) {
-        return { text: line, inFence: isInFence };
+        return { text: line, isInFence };
     }
-    return { text: HEADING_LINE.test(line) ? `#${line}` : line, inFence: isInFence };
+    return { text: HEADING_LINE.test(line) ? `#${line}` : line, isInFence };
 };
 const demoteHeadings = (markdown) => {
     let isInFence = false;
     const lines = [];
     for (const line of markdown.split("\n")) {
         const result = demoteLine(line, isInFence);
-        isInFence = result.inFence;
+        isInFence = result.isInFence;
         lines.push(result.text);
     }
     return lines.join("\n");
@@ -58,11 +57,13 @@ const stripMarkdown = (markdown) => markdown
     .replaceAll(/```[\s\S]*?```/g, " ")
     .replaceAll(/`([^`]*)`/g, "$1")
     .replaceAll(/\[([^[\]]*)\]\([^)]*\)/g, "$1")
-    .replaceAll(/[*_#>]/g, "")
-    .replaceAll(/\s+/g, " ")
+    .replaceAll(/[*#>]/g, "")
+    .replaceAll(WHITESPACE_RUN, " ")
     .trim();
+const inlineMarkdown = (doc) => docMarkdown(doc).replaceAll(WHITESPACE_RUN, " ").trim();
+const plainText = (doc) => stripMarkdown(docMarkdown(doc));
 const firstSentence = (doc) => {
-    const text = stripMarkdown(docMarkdown(doc));
+    const text = plainText(doc);
     if (text.length === 0) {
         return "";
     }
@@ -82,13 +83,73 @@ const implementsLine = (names) => {
     return [`Implements ${quotedNames}.`];
 };
 const joinSections = (sections) => `${sections.filter((section) => section.length > 0).join("\n\n")}\n`;
-const metaBlock = (name, meta, doc) => {
-    const lines = [`### \`${name}\``, "", meta];
-    if (doc.length > 0) {
-        lines.push("", doc);
+const paramNotes = (params) => {
+    const entries = (params ?? [])
+        .map((param) => ({ name: param.name, text: inlineMarkdown(param.doc) }))
+        .filter((entry) => entry.text.length > 0);
+    if (entries.length === 0) {
+        return [];
+    }
+    const bullets = entries.map((entry) => `- \`${entry.name}\`: ${entry.text}`);
+    return [["**Parameters**", "", ...bullets].join("\n")];
+};
+const labelledNote = (label, text) => (text.length === 0 ? [] : [`${label} ${text}`]);
+const deprecationNote = (deprecation) => {
+    if (deprecation === undefined) {
+        return [];
+    }
+    const since = deprecation.since;
+    const heading = since === undefined ? "**Deprecated.**" : `**Deprecated since ${since}.**`;
+    const text = inlineMarkdown(deprecation.doc);
+    const body = text.length === 0 ? heading : `${heading} ${text}`;
+    return [`> ${body}`];
+};
+const sinceNote = (since) => since === undefined || since.length === 0 ? [] : [`_Available since ${since}._`];
+const tagNotes = (spec) => {
+    if (spec === undefined) {
+        return [];
+    }
+    return [
+        ...paramNotes(spec.params),
+        ...labelledNote("**Returns**", docMarkdown(spec.returns)),
+        ...labelledNote("**Throws**", inlineMarkdown(spec.throws)),
+        ...deprecationNote(spec.deprecated),
+        ...sinceNote(spec.since),
+    ];
+};
+const deprecationMeta = (annotations) => {
+    if (!annotations.isDeprecated) {
+        return [];
+    }
+    const since = annotations.deprecatedSince;
+    return [since === undefined ? "deprecated" : `deprecated since ${since}`];
+};
+const annotationNotes = (annotations) => tagNotes(annotationSpec(annotations));
+const signalTags = (signal, isSelfIncluded) => isSelfIncluded ? selfHandlerSpec(signal) : handlerSpec(signal, signal.parameters);
+const metaBlock = (entry) => {
+    const lines = [`### \`${entry.name}\``, "", entry.meta];
+    for (const note of [entry.doc, ...tagNotes(entry.tags)]) {
+        if (note.length > 0) {
+            lines.push("", note);
+        }
     }
     return lines.join("\n");
 };
+const sortedMetaBlocks = (entries) => sortStringsBy(entries, (item) => item.name).map((item) => metaBlock(item));
+const propertyMetaLine = ({ type, property, accessNotes, origin }) => {
+    const meta = [`\`${type}\``];
+    if (property.defaultValue !== undefined) {
+        meta.push(`default \`${docsDefaultValue(property.defaultValue)}\``);
+    }
+    if (property.constructOnly) {
+        meta.push("construct-only");
+    }
+    meta.push(...accessNotes, ...deprecationMeta(property.annotations));
+    if (origin !== undefined) {
+        meta.push(`from \`${origin}\``);
+    }
+    return meta.join(" · ");
+};
 const signatureBlock = (name, signature, notes) => {
     const lines = [`### \`${name}\``, "", `\`\`\`ts\n${signature}\n\`\`\``];
     for (const note of notes) {
@@ -98,15 +159,13 @@ const signatureBlock = (name, signature, notes) => {
     }
     return lines.join("\n");
 };
+const signatureEntryBlock = (entry, leadingNotes = []) => signatureBlock(entry.name, entry.signature, [...leadingNotes, entry.doc, ...tagNotes(entry.tags)]);
 const namespaceOrder = (name) => {
     const index = LEADING_NAMESPACES.indexOf(name);
     return index === -1 ? `1${name}` : `0${String(index)}`;
 };
 const docsSignatureContext = (namespace, library) => new ModuleContext({ ...namespace, name: DOCS_SIGNATURE_NAMESPACE }, library);
-const originSignatureBlocks = (entries) => sortStringsBy(entries, (item) => item.name).map((item) => signatureBlock(item.name, item.signature, [
-    item.origin === undefined ? "" : `From \`${item.origin}\`.`,
-    item.doc,
-]));
+const originSignatureBlocks = (entries) => sortStringsBy(entries, (item) => item.name).map((item) => signatureEntryBlock(item, item.origin === undefined ? [] : [`From \`${item.origin}\`.`]));
 const classMethodEntries = (library, namespace, klass) => {
     const realContext = new ModuleContext(namespace, library);
     const signatureContext = docsSignatureContext(namespace, library);
@@ -114,9 +173,7 @@ const classMethodEntries = (library, namespace, klass) => {
     const inherited = collectInheritedMethods(realContext, klass);
     return instanceMethodEntries(signatureContext, klass, (method) => conflictRename(realContext, method, inherited, className));
 };
-const methodsSectionBlocks = (entries, intro) => entries.length === 0
-    ? []
-    : ["## Methods", intro, ...entries.map((item) => signatureBlock(item.name, item.signature, [item.doc]))];
+const methodsSectionBlocks = (entries, intro) => entries.length === 0 ? [] : ["## Methods", intro, ...entries.map((item) => signatureEntryBlock(item))];
 const instanceMethodEntries = (signatureContext, klass, rename) => {
     const deduped = dedupeCallables(klass.methods);
     const scope = instanceScope(pascalCase(klass.name), {
@@ -127,17 +184,22 @@ const instanceMethodEntries = (signatureContext, klass, rename) => {
     const entries = [];
     for (const method of deduped) {
         const nameOverride = rename(method);
-        const rendered = renderInstanceMethodSignature(signatureContext, { ...method, doc: undefined }, scope, nameOverride);
+        const rendered = renderInstanceMethodSignature(signatureContext, method, scope, nameOverride);
         if (rendered === undefined) {
             continue;
         }
         entries.push({
             name: nameOverride ?? methodExportName(method),
-            signature: rendered.trim().replace(/;$/, ""),
+            signature: signatureText(rendered),
             doc: docMarkdown(method.doc),
+            tags: instanceMemberSpec(signatureContext, method, scope),
         });
     }
     return sortStringsBy(entries, (entry) => entry.name);
 };
-export { renderDocsType, renderDocsSignalSignature, renderDocsSignalHandlerType, docsDefaultValue, docMarkdown, firstSentence, elementSlug, implementsLine, joinSections, metaBlock, signatureBlock, namespaceOrder, docsSignatureContext, originSignatureBlocks, classMethodEntries, methodsSectionBlocks, instanceMethodEntries, };
+const signatureText = (rendered) => {
+    const start = rendered.startsWith("/**") ? rendered.indexOf("*/") + 2 : 0;
+    return rendered.slice(start).trim().replace(/;$/, "");
+};
+export { renderDocsType, renderDocsSignalSignature, renderDocsSignalHandlerType, annotationNotes, deprecationMeta, docMarkdown, firstSentence, elementSlug, implementsLine, joinSections, plainText, propertyMetaLine, signalTags, signatureBlock, signatureEntryBlock, sortedMetaBlocks, namespaceOrder, docsSignatureContext, originSignatureBlocks, classMethodEntries, methodsSectionBlocks, tagNotes, };
 //# sourceMappingURL=render.js.map