@gtkx/codegen 0.21.0 → 1.0.0-rc.1

package/dist/docs/api-reference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-reference.js","sourceRoot":"","sources":["../../src/docs/api-reference.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAqB,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAChF,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,8BAA8B,EAAuB,MAAM,sCAAsC,CAAC;AAC3G,OAAO,EAAE,wBAAwB,EAA2B,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACzG,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClF,OAAO,EAAsB,gBAAgB,EAA0B,MAAM,kBAAkB,CAAC;AAUhG,MAAM,CAAC,MAAM,gBAAgB,GAAoB;IAC7C,SAAS;IACT,OAAO;IACP,WAAW;IACX,QAAQ;IACR,MAAM;IACN,UAAU;IACV,OAAO;IACP,UAAU;IACV,UAAU;CACb,CAAC;AAsCF,MAAM,mBAAmB,GAAkC;IACvD,OAAO,EAAE,cAAc;IACvB,KAAK,EAAE,SAAS;IAChB,SAAS,EAAE,YAAY;IACvB,MAAM,EAAE,SAAS;IACjB,IAAI,EAAE,OAAO;IACb,QAAQ,EAAE,WAAW;IACrB,KAAK,EAAE,SAAS;IAChB,QAAQ,EAAE,WAAW;IACrB,QAAQ,EAAE,WAAW;CACxB,CAAC;AAEF,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAEhC,MAAM,YAAY,GAAG,CAAC,CAAS,EAAE,CAAS,EAAU,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpF,MAAM,YAAY;IACN,OAAO,CAAU;IACjB,SAAS,CAAW;IACpB,cAAc,CAAqB;IACnC,OAAO,GAAkB,EAAE,CAAC;IAC5B,WAAW,GAAG,IAAI,GAAG,EAAyB,CAAC;IAC/C,MAAM,GAAG,IAAI,GAAG,EAAyB,CAAC;IAC1C,WAAW,GAAG,IAAI,GAAG,EAAyB,CAAC;IAC/C,eAAe,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEpD,YAAY,OAA4B;QACpC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAChE,IAAI,CAAC,cAAc,GAAG,wBAAwB,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,YAAY,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC1G,IAAI,CAAC,UAAU,EAAE,CAAC;IACtB,CAAC;IAED,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IACjC,CAAC;IAEO,GAAG,CAAC,KAAkB;QAC1B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,CAAC,GAA+B,EAAE,GAAW,EAAQ,EAAE;YAChE,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YAChC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACjB,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACvB,CAAC,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QAC9E,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAEO,UAAU;QACd,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;YACvD,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QACnC,CAAC;QACD,KAAK,MAAM,OAAO,IAAI,8BAA8B,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACjE,IAAI,CAAC,GAAG,CAAC;gBACL,IAAI,EAAE,SAAS;gBACf,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,IAAI,EAAE,OAAO,CAAC,QAAQ;gBACtB,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG;gBACtB,OAAO;aACV,CAAC,CAAC;YACH,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAClG,CAAC;IACL,CAAC;IAEO,cAAc,CAAC,SAAuB;QAC1C,MAAM,OAAO,GAAG;YACZ,GAAG,YAAY,CAAC,SAAS,CAAC;YAC1B,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC;YACzC,GAAG,YAAY,CAAC,SAAS,CAAC;SAC7B,CAAC;QACF,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAEO,cAAc,CAAC,SAAuB;QAC1C,IAAI,SAAS,CAAC,aAAa,KAAK,SAAS;YAAE,OAAO;QAClD,MAAM,WAAW,GAAG,oBAAoB,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAClE,KAAK,MAAM,EAAE,IAAI,eAAe,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;YACpD,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,EAAE,CAAC;gBAAE,SAAS;YACpD,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC;YACnC,IAAI,WAAW,KAAK,SAAS;gBAAE,SAAS;YACxC,MAAM,IAAI,GAAG,2BAA2B,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC;YAC1F,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC;QACrE,CAAC;IACL,CAAC;IAEO,WAAW,CAAC,KAAkB;QAClC,OAAO;YACH,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,IAAI;YAC/B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,OAAO,EAAE,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC;SACpC,CAAC;IACN,CAAC;IAEO,iBAAiB;QACrB,OAAO;YACH,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,cAAc,EAAE,CAAC,aAAa,EAAE,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,aAAa,IAAI,SAAS,EAAE,CAAC;SAC1G,CAAC;IACN,CAAC;IAEO,UAAU,CAAC,KAAkB;QACjC,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;YAAE,OAAO,iBAAiB,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3F,OAAO,gBAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAC7D,CAAC;IAEO,aAAa,CAAC,IAAY;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACjC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;YACvD,IAAI,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK;gBAAE,OAAO,SAAS,CAAC;QACjE,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,KAAa,EAAE,IAAoB;QACtC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC7B,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;QACzD,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACxC,MAAM,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QACvD,IAAI,UAAU,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;QACtD,IAAI,IAAI,KAAK,SAAS;YAAE,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QACvF,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CACtC,SAAS,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO,CAC3F,CAAC;YACF,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;gBAAE,UAAU,GAAG,KAAK,CAAC;QAC7C,CAAC;QACD,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAC5B,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;QACxD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;QAC5G,CAAC;QACD,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;IAClG,CAAC;IAED,MAAM,CAAC,OAAyB;QAC5B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACjD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI,oBAAoB,CAAC,CAAC,CAAC;QAC7E,MAAM,eAAe,GAAG,OAAO,CAAC,SAAS,EAAE,WAAW,EAAE,CAAC;QACzD,MAAM,MAAM,GAA4C,EAAE,CAAC;QAC3D,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC/B,IAAI,eAAe,KAAK,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,eAAe;gBAAE,SAAS;YACtG,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;gBAAE,SAAS;YACjF,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACxC,IAAI,KAAK,KAAK,CAAC;gBAAE,SAAS;YAC1B,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAClC,CAAC;QACD,MAAM,CAAC,IAAI,CACP,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACL,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK;YACjB,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM;YACzC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;YACxC,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC5F,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAC/C,CAAC;QACF,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED,UAAU;QACN,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;YACxE,IAAI;YACJ,UAAU,EAAE,YAAY,kBAAkB,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE;YACtD,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,MAAM;YACnE,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,MAAM;SACvE,CAAC,CAAC,CAAC;QACJ,OAAO,aAAa,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/E,CAAC;IAED,WAAW,CAAC,aAAqB;QAC7B,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QACpD,IAAI,SAAS,KAAK,SAAS;YAAE,OAAO,EAAE,CAAC;QACvC,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAC3D,OAAO,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,QAAQ;QACJ,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,GAAG,CAC9B,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,QAAQ,OAAO,CAAC,UAAU,QAAQ,OAAO,CAAC,OAAO,MAAM,OAAO,CAAC,QAAQ,IAAI,CAC5G,CAAC;QACF,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnF,OAAO;YACH,iBAAiB;YACjB,EAAE;YACF,0BAA0B,aAAa,2NAA2N;YAClQ,EAAE;YACF,sMAAsM;YACtM,EAAE;YACF,iDAAiD;YACjD,2BAA2B;YAC3B,GAAG,IAAI;YACP,EAAE;SACL,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,iBAAiB,CAAC,IAAY;QAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,SAAS,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAC3D,MAAM,SAAS,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAChD,MAAM,KAAK,GAAG;YACV,KAAK,SAAS,CAAC,IAAI,EAAE;YACrB,EAAE;YACF,yBAAyB,SAAS,CAAC,IAAI,mBAAmB,SAAS,YAAY;SAClF,CAAC;QACF,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE,CAAC;YAClC,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACxF,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAS;YACjC,KAAK,CAAC,IAAI,CACN,EAAE,EACF,MAAM,mBAAmB,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,MAAM,GAAG,EACnD,EAAE,EACF,WAAW,CAAC,KAAK,CAAC;iBACb,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,KAAK,UAAU,IAAI,CAAC;iBACxC,IAAI,CAAC,IAAI,CAAC,CAClB,CAAC;QACN,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;CACJ;AAID,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAA4B,EAAgB,EAAE,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;AAE1G,MAAM,YAAY,GAAG,CAAC,SAAuB,EAAmB,EAAE;IAC9D,MAAM,OAAO,GAAoB,EAAE,CAAC;IACpC,KAAK,MAAM,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;QAClE,IAAI,CAAC,KAAK,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QAC/D,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC;QACvD,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7F,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,OAAgB,EAAE,SAAuB,EAAmB,EAAE;IACjF,MAAM,OAAO,GAAoB,EAAE,CAAC;IACpC,KAAK,MAAM,MAAM,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,cAAc,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QACpF,IAAI,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC;YAAE,SAAS;QACnE,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;IAC5F,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,SAAuB,EAAmB,EAAE,CAAC;IAC/D,GAAG,SAAS,CAAC,KAAK;SACb,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC;SACnD,GAAG,CAAgB,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAClC,IAAI,EAAE,MAAM;QACZ,SAAS;QACT,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,GAAG,EAAE,WAAW,CAAC,GAAG;QACpB,WAAW;KACd,CAAC,CAAC;IACP,GAAG,SAAS,CAAC,SAAS;SACjB,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC;SAC7C,GAAG,CAAgB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC/B,IAAI,EAAE,UAAU;QAChB,SAAS;QACT,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,GAAG,EAAE,QAAQ,CAAC,GAAG;QACjB,QAAQ;KACX,CAAC,CAAC;IACP,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAgB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAChD,IAAI,EAAE,OAAO;QACb,SAAS;QACT,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,KAAK;KACR,CAAC,CAAC;IACH,GAAG,SAAS,CAAC,SAAS,CAAC,GAAG,CAAgB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACrD,IAAI,EAAE,UAAU;QAChB,SAAS;QACT,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,GAAG,EAAE,QAAQ,CAAC,GAAG;QACjB,QAAQ;KACX,CAAC,CAAC;CACN,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,KAAkB,EAAE,KAAa,EAAU,EAAE;IAC9D,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IACtC,MAAM,SAAS,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC;IAClE,IAAI,IAAI,KAAK,KAAK,IAAI,SAAS,KAAK,KAAK;QAAE,OAAO,CAAC,CAAC;IACpD,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC;IACrC,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC;IAChE,OAAO,CAAC,CAAC;AACb,CAAC,CAAC","sourcesContent":["import type { ElementProp } from \"@gtkx/config\";\nimport { sortStrings, sortStringsBy, toPascalCase } from \"@gtkx/utils\";\nimport { Library } from \"../gir/library.js\";\nimport { type GirNamespace, namespaceDirectory } from \"../gir/namespace.js\";\nimport { dedupeCallables, isEmittableCallable } from \"../store/gi/callables.js\";\nimport { isClassStructRecord } from \"../store/gi/class-struct-record.js\";\nimport { namespaceFunctionExportName } from \"../store/gi/function.js\";\nimport { collectIntrinsicElementClasses, type GlibNamedClass } from \"../store/react/intrinsic-elements.js\";\nimport { createElementPageContext, type ElementPageContext, renderElementPage } from \"./element-page.js\";\nimport { docsSignatureContext, firstSentence, namespaceOrder } from \"./render.js\";\nimport { type GiSymbolEntry, renderSymbolPage, type SymbolPageOptions } from \"./symbol-page.js\";\n\nexport type ApiReferenceOptions = {\n    libraries: string[];\n    girPath: string[];\n    elementProps?: Record<string, ElementProp[]>;\n};\n\nexport type ApiSymbolKind = GiSymbolEntry[\"kind\"] | \"element\";\n\nexport const API_SYMBOL_KINDS: ApiSymbolKind[] = [\n    \"element\",\n    \"class\",\n    \"interface\",\n    \"record\",\n    \"enum\",\n    \"callback\",\n    \"alias\",\n    \"function\",\n    \"constant\",\n];\n\nexport type ApiSymbol = {\n    namespace: string;\n    name: string;\n    kind: ApiSymbolKind;\n    summary: string;\n};\n\nexport type ApiNamespaceSummary = {\n    name: string;\n    importPath: string;\n    symbols: number;\n    elements: number;\n};\n\nexport type ApiLookupResult =\n    | { outcome: \"page\"; symbol: ApiSymbol; markdown: string }\n    | { outcome: \"ambiguous\"; candidates: ApiSymbol[] }\n    | { outcome: \"notFound\" };\n\nexport type ApiSearchOptions = {\n    query: string;\n    namespace?: string;\n    kinds?: ApiSymbolKind[];\n    limit?: number;\n};\n\ntype ElementEntry = {\n    kind: \"element\";\n    namespace: GirNamespace;\n    name: string;\n    doc: string | undefined;\n    element: GlibNamedClass;\n};\n\ntype SymbolEntry = GiSymbolEntry | ElementEntry;\n\nconst KIND_SECTION_TITLES: Record<ApiSymbolKind, string> = {\n    element: \"JSX elements\",\n    class: \"Classes\",\n    interface: \"Interfaces\",\n    record: \"Records\",\n    enum: \"Enums\",\n    callback: \"Callbacks\",\n    alias: \"Aliases\",\n    function: \"Functions\",\n    constant: \"Constants\",\n};\n\nconst DEFAULT_SEARCH_LIMIT = 20;\n\nconst compareNames = (a: string, b: string): number => (a < b ? -1 : a > b ? 1 : 0);\n\nclass ApiReference {\n    private library: Library;\n    private libraries: string[];\n    private elementContext: ElementPageContext;\n    private entries: SymbolEntry[] = [];\n    private byQualified = new Map<string, SymbolEntry[]>();\n    private byName = new Map<string, SymbolEntry[]>();\n    private byNamespace = new Map<string, SymbolEntry[]>();\n    private elementsByClass = new Map<string, string>();\n\n    constructor(options: ApiReferenceOptions) {\n        this.libraries = options.libraries;\n        this.library = Library.load(options.libraries, options.girPath);\n        this.elementContext = createElementPageContext(this.library, options.elementProps ?? {}, () => undefined);\n        this.buildIndex();\n    }\n\n    get girFiles(): string[] {\n        return this.library.girFiles;\n    }\n\n    private add(entry: SymbolEntry): void {\n        this.entries.push(entry);\n        const push = (map: Map<string, SymbolEntry[]>, key: string): void => {\n            const list = map.get(key) ?? [];\n            list.push(entry);\n            map.set(key, list);\n        };\n        push(this.byQualified, `${entry.namespace.name}.${entry.name}`.toLowerCase());\n        push(this.byName, entry.name.toLowerCase());\n        push(this.byNamespace, entry.namespace.name);\n    }\n\n    private buildIndex(): void {\n        for (const namespace of this.library.namespaces.values()) {\n            this.indexNamespace(namespace);\n        }\n        for (const element of collectIntrinsicElementClasses(this.library)) {\n            this.add({\n                kind: \"element\",\n                namespace: element.namespace,\n                name: element.glibName,\n                doc: element.klass.doc,\n                element,\n            });\n            this.elementsByClass.set(`${element.namespace.name}.${element.klass.name}`, element.glibName);\n        }\n    }\n\n    private indexNamespace(namespace: GirNamespace): void {\n        const entries = [\n            ...classEntries(namespace),\n            ...recordEntries(this.library, namespace),\n            ...valueEntries(namespace),\n        ];\n        for (const entry of entries) {\n            this.add(entry);\n        }\n        this.indexFunctions(namespace);\n    }\n\n    private indexFunctions(namespace: GirNamespace): void {\n        if (namespace.sharedLibrary === undefined) return;\n        const docsContext = docsSignatureContext(namespace, this.library);\n        for (const fn of dedupeCallables(namespace.functions)) {\n            if (!isEmittableCallable(docsContext, fn)) continue;\n            const cIdentifier = fn.cIdentifier;\n            if (cIdentifier === undefined) continue;\n            const name = namespaceFunctionExportName(cIdentifier, fn.name, namespace.cSymbolPrefixes);\n            this.add({ kind: \"function\", namespace, name, doc: fn.doc, fn });\n        }\n    }\n\n    private toApiSymbol(entry: SymbolEntry): ApiSymbol {\n        return {\n            namespace: entry.namespace.name,\n            name: entry.name,\n            kind: entry.kind,\n            summary: firstSentence(entry.doc),\n        };\n    }\n\n    private symbolPageOptions(): SymbolPageOptions {\n        return {\n            library: this.library,\n            elementNameFor: (namespaceName, className) => this.elementsByClass.get(`${namespaceName}.${className}`),\n        };\n    }\n\n    private renderPage(entry: SymbolEntry): string {\n        if (entry.kind === \"element\") return renderElementPage(entry.element, this.elementContext);\n        return renderSymbolPage(entry, this.symbolPageOptions());\n    }\n\n    private findNamespace(name: string): GirNamespace | undefined {\n        const lower = name.toLowerCase();\n        for (const namespace of this.library.namespaces.values()) {\n            if (namespace.name.toLowerCase() === lower) return namespace;\n        }\n        return undefined;\n    }\n\n    lookup(query: string, kind?: ApiSymbolKind): ApiLookupResult {\n        const trimmed = query.trim();\n        if (trimmed.length === 0) return { outcome: \"notFound\" };\n        const qualified = trimmed.includes(\".\");\n        const map = qualified ? this.byQualified : this.byName;\n        let candidates = map.get(trimmed.toLowerCase()) ?? [];\n        if (kind !== undefined) candidates = candidates.filter((entry) => entry.kind === kind);\n        if (candidates.length > 1) {\n            const exact = candidates.filter((entry) =>\n                qualified ? `${entry.namespace.name}.${entry.name}` === trimmed : entry.name === trimmed,\n            );\n            if (exact.length > 0) candidates = exact;\n        }\n        const entry = candidates[0];\n        if (entry === undefined) return { outcome: \"notFound\" };\n        if (candidates.length > 1) {\n            return { outcome: \"ambiguous\", candidates: candidates.map((candidate) => this.toApiSymbol(candidate)) };\n        }\n        return { outcome: \"page\", symbol: this.toApiSymbol(entry), markdown: this.renderPage(entry) };\n    }\n\n    search(options: ApiSearchOptions): ApiSymbol[] {\n        const query = options.query.trim().toLowerCase();\n        if (query.length === 0) return [];\n        const limit = Math.max(1, Math.floor(options.limit ?? DEFAULT_SEARCH_LIMIT));\n        const namespaceFilter = options.namespace?.toLowerCase();\n        const scored: { score: number; entry: SymbolEntry }[] = [];\n        for (const entry of this.entries) {\n            if (namespaceFilter !== undefined && entry.namespace.name.toLowerCase() !== namespaceFilter) continue;\n            if (options.kinds !== undefined && !options.kinds.includes(entry.kind)) continue;\n            const score = searchScore(entry, query);\n            if (score === 0) continue;\n            scored.push({ score, entry });\n        }\n        scored.sort(\n            (a, b) =>\n                b.score - a.score ||\n                a.entry.name.length - b.entry.name.length ||\n                compareNames(a.entry.name, b.entry.name) ||\n                compareNames(namespaceOrder(a.entry.namespace.name), namespaceOrder(b.entry.namespace.name)) ||\n                compareNames(a.entry.kind, b.entry.kind),\n        );\n        return scored.slice(0, limit).map((item) => this.toApiSymbol(item.entry));\n    }\n\n    namespaces(): ApiNamespaceSummary[] {\n        const summaries = [...this.byNamespace.entries()].map(([name, entries]) => ({\n            name,\n            importPath: `@gtkx/gi/${namespaceDirectory({ name })}`,\n            symbols: entries.filter((entry) => entry.kind !== \"element\").length,\n            elements: entries.filter((entry) => entry.kind === \"element\").length,\n        }));\n        return sortStringsBy(summaries, (summary) => namespaceOrder(summary.name));\n    }\n\n    symbolNames(namespaceName: string): string[] {\n        const namespace = this.findNamespace(namespaceName);\n        if (namespace === undefined) return [];\n        const entries = this.byNamespace.get(namespace.name) ?? [];\n        return sortStrings(entries.map((entry) => entry.name));\n    }\n\n    overview(): string {\n        const rows = this.namespaces().map(\n            (summary) => `| ${summary.name} | \\`${summary.importPath}\\` | ${summary.symbols} | ${summary.elements} |`,\n        );\n        const librariesList = this.libraries.map((library) => `\\`${library}\\``).join(\", \");\n        return [\n            \"# API Reference\",\n            \"\",\n            `Generated bindings for ${librariesList} and the namespaces they pull in. Classes, interfaces, records, enums, callbacks, aliases, functions, and constants are imported from \\`@gtkx/gi/<namespace>\\`; JSX elements are imported from \\`@gtkx/jsx/<namespace>\\`.`,\n            \"\",\n            \"Every symbol has a reference page addressed by its qualified name (for example `Gtk.Button`, `Gtk.Orientation`, `GLib.idleAdd`) and every JSX element by its element name (for example `GtkButton`).\",\n            \"\",\n            \"| Namespace | Import | Symbols | JSX elements |\",\n            \"| --- | --- | --- | --- |\",\n            ...rows,\n            \"\",\n        ].join(\"\\n\");\n    }\n\n    namespaceOverview(name: string): string | undefined {\n        const namespace = this.findNamespace(name);\n        if (namespace === undefined) return undefined;\n        const entries = this.byNamespace.get(namespace.name) ?? [];\n        const directory = namespaceDirectory(namespace);\n        const lines = [\n            `# ${namespace.name}`,\n            \"\",\n            `\\`\\`\\`ts\\nimport * as ${namespace.name} from \"@gtkx/gi/${directory}\";\\n\\`\\`\\``,\n        ];\n        for (const kind of API_SYMBOL_KINDS) {\n            const names = entries.filter((entry) => entry.kind === kind).map((entry) => entry.name);\n            if (names.length === 0) continue;\n            lines.push(\n                \"\",\n                `## ${KIND_SECTION_TITLES[kind]} (${names.length})`,\n                \"\",\n                sortStrings(names)\n                    .map((symbolName) => `\\`${symbolName}\\``)\n                    .join(\", \"),\n            );\n        }\n        lines.push(\"\");\n        return lines.join(\"\\n\");\n    }\n}\n\nexport type { ApiReference };\n\nexport const loadApiReference = (options: ApiReferenceOptions): ApiReference => new ApiReference(options);\n\nconst classEntries = (namespace: GirNamespace): GiSymbolEntry[] => {\n    const entries: GiSymbolEntry[] = [];\n    for (const klass of [...namespace.classes, ...namespace.interfaces]) {\n        if (!klass.introspectable || klass.name.length === 0) continue;\n        const kind = klass.isInterface ? \"interface\" : \"class\";\n        entries.push({ kind, namespace, name: toPascalCase(klass.name), doc: klass.doc, klass });\n    }\n    return entries;\n};\n\nconst recordEntries = (library: Library, namespace: GirNamespace): GiSymbolEntry[] => {\n    const entries: GiSymbolEntry[] = [];\n    for (const record of namespace.records) {\n        if (!record.introspectable || record.isVtable || record.name.length === 0) continue;\n        if (isClassStructRecord(library, namespace.name, record)) continue;\n        entries.push({ kind: \"record\", namespace, name: record.name, doc: record.doc, record });\n    }\n    return entries;\n};\n\nconst valueEntries = (namespace: GirNamespace): GiSymbolEntry[] => [\n    ...namespace.enums\n        .filter((enumeration) => enumeration.introspectable)\n        .map<GiSymbolEntry>((enumeration) => ({\n            kind: \"enum\",\n            namespace,\n            name: enumeration.name,\n            doc: enumeration.doc,\n            enumeration,\n        })),\n    ...namespace.callbacks\n        .filter((callback) => callback.introspectable)\n        .map<GiSymbolEntry>((callback) => ({\n            kind: \"callback\",\n            namespace,\n            name: callback.name,\n            doc: callback.doc,\n            callback,\n        })),\n    ...namespace.aliases.map<GiSymbolEntry>((alias) => ({\n        kind: \"alias\",\n        namespace,\n        name: alias.name,\n        doc: alias.doc,\n        alias,\n    })),\n    ...namespace.constants.map<GiSymbolEntry>((constant) => ({\n        kind: \"constant\",\n        namespace,\n        name: constant.name,\n        doc: constant.doc,\n        constant,\n    })),\n];\n\nconst searchScore = (entry: SymbolEntry, query: string): number => {\n    const name = entry.name.toLowerCase();\n    const qualified = `${entry.namespace.name.toLowerCase()}.${name}`;\n    if (name === query || qualified === query) return 3;\n    if (name.startsWith(query)) return 2;\n    if (name.includes(query) || qualified.includes(query)) return 1;\n    return 0;\n};\n"]}

package/dist/docs/element-page.d.ts

@@ -0,0 +1,15 @@
+import type { ElementProp } from "@gtkx/config";
+import type { Library } from "../gir/library.js";
+import { type ElementPropTypegen } from "../store/react/element-prop-types.js";
+import { type GirIndex } from "../store/react/gir-index.js";
+import { type GlibNamedClass } from "../store/react/intrinsic-elements.js";
+export type ElementPageContext = {
+    library: Library;
+    girIndex: GirIndex;
+    typegen: ElementPropTypegen;
+    elementProps: Record<string, ElementProp[]>;
+    linkFor: (glibName: string) => string | undefined;
+};
+export declare const createElementPageContext: (library: Library, elementProps: Record<string, ElementProp[]>, linkFor: (glibName: string) => string | undefined) => ElementPageContext;
+export declare const renderElementPage: (entry: GlibNamedClass, context: ElementPageContext) => string;
+//# sourceMappingURL=element-page.d.ts.map

package/dist/docs/element-page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"element-page.d.ts","sourceRoot":"","sources":["../../src/docs/element-page.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAiB,WAAW,EAAE,MAAM,cAAc,CAAC;AAI/D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAIjD,OAAO,EAA4B,KAAK,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAEzG,OAAO,EAAiB,KAAK,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC3E,OAAO,EACH,KAAK,cAAc,EAKtB,MAAM,sCAAsC,CAAC;AAe9C,MAAM,MAAM,kBAAkB,GAAG;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,kBAAkB,CAAC;IAC5B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;IAC5C,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;CACrD,CAAC;AAEF,eAAO,MAAM,wBAAwB,YACxB,OAAO,gBACF,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,WAClC,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,KAClD,kBAUF,CAAC;AA8NF,eAAO,MAAM,iBAAiB,UAAW,cAAc,WAAW,kBAAkB,KAAG,MAatF,CAAC"}

package/dist/docs/element-page.js

@@ -0,0 +1,221 @@
+import { sortStringsBy, toCamelIdentifier, upperFirst } from "@gtkx/utils";
+import { ancestorChain } from "../gir/ancestry.js";
+import { namespaceDirectory } from "../gir/namespace.js";
+import { isConstructableProperty } from "../gir/property.js";
+import { createElementPropTypegen } from "../store/react/element-prop-types.js";
+import { assembleElementProps } from "../store/react/element-props.js";
+import { buildGirIndex } from "../store/react/gir-index.js";
+import { glibNameOf, implementedInterfaces, newlyImplementedInterfaces, signalHandlerName, } from "../store/react/intrinsic-elements.js";
+import { isObjectProp } from "../store/react/props.js";
+import { classMethodEntries, docMarkdown, docsDefaultValue, firstSentence, joinSections, metaBlock, methodsSectionBlocks, originSignatureBlocks, renderDocsSignalSignature, renderDocsType, } from "./render.js";
+export const createElementPageContext = (library, elementProps, linkFor) => {
+    const girIndex = buildGirIndex(library);
+    const applied = assembleElementProps(girIndex, elementProps);
+    return {
+        library,
+        girIndex,
+        typegen: createElementPropTypegen(girIndex, applied),
+        elementProps: applied,
+        linkFor,
+    };
+};
+const frontmatter = (entry) => {
+    const sentence = firstSentence(entry.klass.doc);
+    const description = sentence.length > 0 ? sentence : `API reference for the ${entry.glibName} element.`;
+    return `---\ndescription: ${JSON.stringify(description)}\n---`;
+};
+const importBlock = (entry) => `\`\`\`tsx\nimport { ${entry.glibName} } from "@gtkx/jsx/${namespaceDirectory(entry.namespace)}";\n\`\`\``;
+const glibLabel = (context, glibName) => {
+    const link = context.linkFor(glibName);
+    return link === undefined ? `\`${glibName}\`` : `[${glibName}](${link})`;
+};
+const hierarchySection = (entry, context) => {
+    const ancestors = [...ancestorChain(context.library, entry.klass, entry.namespace.name)].slice(1).reverse();
+    if (ancestors.length === 0)
+        return [];
+    const parts = ancestors.map((ancestor) => {
+        const glib = glibNameOf(ancestor.klass);
+        return glib === undefined ? `\`${ancestor.namespaceName}.${ancestor.klass.name}\`` : glibLabel(context, glib);
+    });
+    parts.push(`**${entry.glibName}**`);
+    const lines = [`## Hierarchy`, parts.join(" → ")];
+    const interfaces = implementedInterfaces(entry.klass, entry.namespace, context.library)
+        .map((iface) => glibNameOf(iface.klass))
+        .filter((name) => name !== undefined);
+    if (interfaces.length > 0) {
+        lines.push(`Implements ${interfaces.map((name) => `\`${name}\``).join(", ")}.`);
+    }
+    return lines;
+};
+const callName = (call) => call === undefined ? undefined : typeof call === "string" ? call : call.method;
+const containerLine = (prop, context) => {
+    const child = glibLabel(context, prop.child);
+    const attach = callName(prop.append);
+    const detail = [];
+    if (attach !== undefined)
+        detail.push(`attached with \`${attach}()\``);
+    if (prop.autowrap !== undefined) {
+        detail.push(`children are wrapped in a ${glibLabel(context, prop.autowrap)} before attaching`);
+    }
+    const suffix = detail.length > 0 ? ` (${detail.join("; ")})` : "";
+    if (prop.prop === "children")
+        return `- \`children\` accepts ${child} elements${suffix}.`;
+    return `- \`${prop.prop}\` is a slot accepting ${child} elements${suffix}.`;
+};
+const childrenSection = (entry, context) => {
+    const lines = [];
+    const seen = new Set();
+    for (const owner of memberOwners(entry, context)) {
+        if (owner.glibName === undefined)
+            continue;
+        const overlays = context.elementProps[owner.glibName] ?? [];
+        const containers = overlays.filter((prop) => prop.kind === "container" && !seen.has(prop.prop));
+        for (const prop of containers)
+            lines.push(containerLine(prop, context));
+        for (const prop of containers)
+            seen.add(prop.prop);
+    }
+    if (!seen.has("children") && context.typegen.acceptsChildren(entry.glibName)) {
+        lines.push("- `children` accepts child elements.");
+    }
+    if (lines.length === 0)
+        return [];
+    return ["## Children", lines.join("\n")];
+};
+const memberOwners = (entry, context) => [
+    { klass: entry.klass, namespace: entry.namespace, origin: undefined, glibName: entry.glibName },
+    ...newlyImplementedInterfaces(entry.klass, entry.namespace, context.library, (glibName) => glibName !== undefined && context.typegen.containerPropNamesFor(glibName).length > 0).map((iface) => {
+        const glibName = glibNameOf(iface.klass);
+        return { klass: iface.klass, namespace: iface.namespace, origin: glibName, glibName };
+    }),
+];
+const propertyEntry = (context, owner, property, jsName) => {
+    const object = isObjectProp({ library: context.library, klass: owner.klass, namespace: owner.namespace }, property, jsName);
+    const baseType = renderDocsType(context.library, property.type, false);
+    const type = object ? `${baseType} | ReactElement` : baseType;
+    const meta = [`\`${type}\``];
+    if (property.defaultValue !== undefined)
+        meta.push(`default \`${docsDefaultValue(property.defaultValue)}\``);
+    if (property.constructOnly)
+        meta.push("construct-only");
+    if (!isConstructableProperty(property))
+        meta.push(`read-only, observe with \`onNotify${upperFirst(jsName)}\``);
+    if (owner.origin !== undefined)
+        meta.push(`from \`${owner.origin}\``);
+    return { name: jsName, meta: meta.join(" · "), doc: docMarkdown(property.doc) };
+};
+const overlayNote = (overlays, name) => {
+    for (const overlay of overlays) {
+        if (overlay.kind === "container" || overlay.prop !== name)
+            continue;
+        if (overlay.kind === "value")
+            return `Applied with \`${callName(overlay.call)}()\`.`;
+        if (overlay.kind === "list") {
+            const applied = (Array.isArray(overlay.add) ? overlay.add : [overlay.add])
+                .map((call) => `\`${callName(call)}()\``)
+                .join(", ");
+            return `Array prop; items are applied with ${applied}.`;
+        }
+        if (overlay.kind === "controlled-text") {
+            return "Controlled: the element is synced to the prop value whenever that value changes; text the user has typed is preserved rather than reverted on every render.";
+        }
+    }
+    return undefined;
+};
+const cleanOverlayType = (type) => type.replace(/\s*\|\s*undefined$/, "").replaceAll("$.", ".");
+const overlayEntries = (entry, context, seen) => {
+    const overlays = context.elementProps[entry.glibName] ?? [];
+    const entries = [];
+    const lines = context.typegen.classPropLines(entry.glibName, entry.klass, entry.namespace, new Map());
+    for (const line of lines) {
+        const match = line.match(/^([A-Za-z0-9_]+)\?: (.*);$/);
+        if (match === null)
+            continue;
+        const [, name = "", rawType = ""] = match;
+        if (seen.has(name))
+            continue;
+        seen.add(name);
+        const note = overlayNote(overlays, name) ?? "Element prop managed by GTKX.";
+        entries.push({ name, meta: `\`${cleanOverlayType(rawType)}\``, doc: note });
+    }
+    return entries;
+};
+const withOverlayNote = (propEntry, note) => {
+    if (note === undefined)
+        return propEntry;
+    return { ...propEntry, doc: propEntry.doc.length > 0 ? `${note}\n\n${propEntry.doc}` : note };
+};
+const propertyEntries = (entry, context, seen) => {
+    const owners = memberOwners(entry, context);
+    const overlays = owners.flatMap((owner) => owner.glibName === undefined ? [] : (context.elementProps[owner.glibName] ?? []));
+    const entries = [];
+    for (const owner of owners) {
+        for (const property of owner.klass.properties) {
+            if (!property.introspectable)
+                continue;
+            const jsName = toCamelIdentifier(property.name);
+            if (seen.has(jsName))
+                continue;
+            seen.add(jsName);
+            const propEntry = propertyEntry(context, owner, property, jsName);
+            entries.push(withOverlayNote(propEntry, overlayNote(overlays, jsName)));
+        }
+    }
+    return entries;
+};
+const propsSection = (entry, context, selfType) => {
+    const seen = new Set();
+    const entries = [...propertyEntries(entry, context, seen), ...overlayEntries(entry, context, seen)];
+    const intro = [
+        `\`ref\` receives the \`${selfType}\` instance.`,
+        `Every mutable property also has an \`onNotify<Prop>\` handler prop called with the new value when the property changes.`,
+        `Props inherited from ancestor elements are documented on their own pages.`,
+    ].join(" ");
+    if (entries.length === 0)
+        return ["## Props", intro];
+    const sorted = sortStringsBy(entries, (item) => item.name);
+    return ["## Props", intro, ...sorted.map((item) => metaBlock(item.name, item.meta, item.doc))];
+};
+const signalsSection = (entry, context, selfType) => {
+    const seen = new Set();
+    const entries = [];
+    const acceptSignal = (signal, origin) => {
+        const name = signalHandlerName(signal.name);
+        if (seen.has(name))
+            return;
+        seen.add(name);
+        entries.push({
+            name,
+            signature: renderDocsSignalSignature(context.library, signal, selfType),
+            doc: docMarkdown(signal.doc),
+            origin,
+        });
+    };
+    for (const owner of memberOwners(entry, context)) {
+        for (const signal of owner.klass.signals)
+            acceptSignal(signal, owner.origin);
+    }
+    if (entries.length === 0)
+        return [];
+    return ["## Signals", ...originSignatureBlocks(entries)];
+};
+const methodsSection = (entry, context, selfType) => {
+    const entries = classMethodEntries(context.library, entry.namespace, entry.klass);
+    const intro = `Methods are called on the \`${selfType}\` instance, obtained with the \`ref\` prop or imported from \`@gtkx/gi/${namespaceDirectory(entry.namespace)}\`. Methods inherited from ancestors are documented on their own pages.`;
+    return methodsSectionBlocks(entries, intro);
+};
+export const renderElementPage = (entry, context) => {
+    const selfType = `${entry.namespace.name}.${entry.klass.name}`;
+    return joinSections([
+        frontmatter(entry),
+        `# ${entry.glibName}`,
+        docMarkdown(entry.klass.doc),
+        importBlock(entry),
+        ...hierarchySection(entry, context),
+        ...childrenSection(entry, context),
+        ...propsSection(entry, context, selfType),
+        ...signalsSection(entry, context, selfType),
+        ...methodsSection(entry, context, selfType),
+    ]);
+};
+//# sourceMappingURL=element-page.js.map

package/dist/docs/element-page.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"element-page.js","sourceRoot":"","sources":["../../src/docs/element-page.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGnD,OAAO,EAAqB,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAE5E,OAAO,EAAoB,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAC/E,OAAO,EAAE,wBAAwB,EAA2B,MAAM,sCAAsC,CAAC;AACzG,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,aAAa,EAAiB,MAAM,6BAA6B,CAAC;AAC3E,OAAO,EAEH,UAAU,EACV,qBAAqB,EACrB,0BAA0B,EAC1B,iBAAiB,GACpB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EACH,kBAAkB,EAClB,WAAW,EACX,gBAAgB,EAChB,aAAa,EACb,YAAY,EACZ,SAAS,EACT,oBAAoB,EACpB,qBAAqB,EACrB,yBAAyB,EACzB,cAAc,GACjB,MAAM,aAAa,CAAC;AAUrB,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACpC,OAAgB,EAChB,YAA2C,EAC3C,OAAiD,EAC/B,EAAE;IACpB,MAAM,QAAQ,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IACxC,MAAM,OAAO,GAAG,oBAAoB,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAC7D,OAAO;QACH,OAAO;QACP,QAAQ;QACR,OAAO,EAAE,wBAAwB,CAAC,QAAQ,EAAE,OAAO,CAAC;QACpD,YAAY,EAAE,OAAO;QACrB,OAAO;KACV,CAAC;AACN,CAAC,CAAC;AAeF,MAAM,WAAW,GAAG,CAAC,KAAqB,EAAU,EAAE;IAClD,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChD,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,yBAAyB,KAAK,CAAC,QAAQ,WAAW,CAAC;IACxG,OAAO,qBAAqB,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC;AACnE,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,KAAqB,EAAU,EAAE,CAClD,uBAAuB,KAAK,CAAC,QAAQ,sBAAsB,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC;AAE/G,MAAM,SAAS,GAAG,CAAC,OAA2B,EAAE,QAAgB,EAAU,EAAE;IACxE,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACvC,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,CAAC,IAAI,QAAQ,KAAK,IAAI,GAAG,CAAC;AAC7E,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,KAAqB,EAAE,OAA2B,EAAY,EAAE;IACtF,MAAM,SAAS,GAAG,CAAC,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC5G,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACtC,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QACrC,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxC,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,aAAa,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAClH,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,QAAQ,IAAI,CAAC,CAAC;IACpC,MAAM,KAAK,GAAG,CAAC,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAClD,MAAM,UAAU,GAAG,qBAAqB,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC;SAClF,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SACvC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IAC1D,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,cAAc,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpF,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,IAA6B,EAAsB,EAAE,CACnE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;AAEnF,MAAM,aAAa,GAAG,CAAC,IAAmB,EAAE,OAA2B,EAAU,EAAE;IAC/E,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,MAAM,KAAK,SAAS;QAAE,MAAM,CAAC,IAAI,CAAC,mBAAmB,MAAM,MAAM,CAAC,CAAC;IACvE,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,6BAA6B,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IACnG,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAClE,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU;QAAE,OAAO,0BAA0B,KAAK,YAAY,MAAM,GAAG,CAAC;IAC1F,OAAO,OAAO,IAAI,CAAC,IAAI,0BAA0B,KAAK,YAAY,MAAM,GAAG,CAAC;AAChF,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,KAAqB,EAAE,OAA2B,EAAY,EAAE;IACrF,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;QAC/C,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS;YAAE,SAAS;QAC3C,MAAM,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC5D,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAC9B,CAAC,IAAI,EAAyB,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,WAAW,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CACrF,CAAC;QACF,KAAK,MAAM,IAAI,IAAI,UAAU;YAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QACxE,KAAK,MAAM,IAAI,IAAI,UAAU;YAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3E,KAAK,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;IACvD,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAClC,OAAO,CAAC,aAAa,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAC7C,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,KAAqB,EAAE,OAA2B,EAAiB,EAAE,CAAC;IACxF,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE;IAC/F,GAAG,0BAA0B,CACzB,KAAK,CAAC,KAAK,EACX,KAAK,CAAC,SAAS,EACf,OAAO,CAAC,OAAO,EACf,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,CACrG,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACZ,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;IAC1F,CAAC,CAAC;CACL,CAAC;AAEF,MAAM,aAAa,GAAG,CAClB,OAA2B,EAC3B,KAAkB,EAClB,QAAqB,EACrB,MAAc,EACL,EAAE;IACX,MAAM,MAAM,GAAG,YAAY,CACvB,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,EAC5E,QAAQ,EACR,MAAM,CACT,CAAC;IACF,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACvE,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,QAAQ,iBAAiB,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC9D,MAAM,IAAI,GAAa,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;IACvC,IAAI,QAAQ,CAAC,YAAY,KAAK,SAAS;QAAE,IAAI,CAAC,IAAI,CAAC,aAAa,gBAAgB,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7G,IAAI,QAAQ,CAAC,aAAa;QAAE,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACxD,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC;QAAE,IAAI,CAAC,IAAI,CAAC,qCAAqC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/G,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;QAAE,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;IACtE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;AACpF,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,QAAuB,EAAE,IAAY,EAAsB,EAAE;IAC9E,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC7B,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI;YAAE,SAAS;QACpE,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO;YAAE,OAAO,kBAAkB,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;QACrF,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC1B,MAAM,OAAO,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;iBACrE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;iBACxC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChB,OAAO,sCAAsC,OAAO,GAAG,CAAC;QAC5D,CAAC;QACD,IAAI,OAAO,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;YACrC,OAAO,6JAA6J,CAAC;QACzK,CAAC;IACL,CAAC;IACD,OAAO,SAAS,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAEhH,MAAM,cAAc,GAAG,CAAC,KAAqB,EAAE,OAA2B,EAAE,IAAiB,EAAe,EAAE;IAC1G,MAAM,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC5D,MAAM,OAAO,GAAgB,EAAE,CAAC;IAChC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IACtG,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;QACvD,IAAI,KAAK,KAAK,IAAI;YAAE,SAAS;QAC7B,MAAM,CAAC,EAAE,IAAI,GAAG,EAAE,EAAE,OAAO,GAAG,EAAE,CAAC,GAAG,KAAK,CAAC;QAC1C,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,SAAS;QAC7B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACf,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,+BAA+B,CAAC;QAC5E,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;IAChF,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,SAAoB,EAAE,IAAwB,EAAa,EAAE;IAClF,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACzC,OAAO,EAAE,GAAG,SAAS,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,OAAO,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAClG,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,KAAqB,EAAE,OAA2B,EAAE,IAAiB,EAAe,EAAE;IAC3G,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC5C,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CACtC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CACnF,CAAC;IACF,MAAM,OAAO,GAAgB,EAAE,CAAC;IAChC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QACzB,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;YAC5C,IAAI,CAAC,QAAQ,CAAC,cAAc;gBAAE,SAAS;YACvC,MAAM,MAAM,GAAG,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAChD,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;gBAAE,SAAS;YAC/B,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACjB,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;YAClE,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QAC5E,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,KAAqB,EAAE,OAA2B,EAAE,QAAgB,EAAY,EAAE;IACpG,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,OAAO,GAAG,CAAC,GAAG,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,GAAG,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IACpG,MAAM,KAAK,GAAG;QACV,0BAA0B,QAAQ,cAAc;QAChD,yHAAyH;QACzH,2EAA2E;KAC9E,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACZ,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACrD,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3D,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACnG,CAAC,CAAC;AASF,MAAM,cAAc,GAAG,CAAC,KAAqB,EAAE,OAA2B,EAAE,QAAgB,EAAY,EAAE;IACtG,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,OAAO,GAAkB,EAAE,CAAC;IAClC,MAAM,YAAY,GAAG,CAAC,MAAiB,EAAE,MAA0B,EAAQ,EAAE;QACzE,MAAM,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,OAAO;QAC3B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACf,OAAO,CAAC,IAAI,CAAC;YACT,IAAI;YACJ,SAAS,EAAE,yBAAyB,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC;YACvE,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC;YAC5B,MAAM;SACT,CAAC,CAAC;IACP,CAAC,CAAC;IACF,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;QAC/C,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO;YAAE,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACjF,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACpC,OAAO,CAAC,YAAY,EAAE,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;AAC7D,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,KAAqB,EAAE,OAA2B,EAAE,QAAgB,EAAY,EAAE;IACtG,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAClF,MAAM,KAAK,GAAG,+BAA+B,QAAQ,2EAA2E,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,yEAAyE,CAAC;IAC7O,OAAO,oBAAoB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAAqB,EAAE,OAA2B,EAAU,EAAE;IAC5F,MAAM,QAAQ,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC/D,OAAO,YAAY,CAAC;QAChB,WAAW,CAAC,KAAK,CAAC;QAClB,KAAK,KAAK,CAAC,QAAQ,EAAE;QACrB,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC;QAC5B,WAAW,CAAC,KAAK,CAAC;QAClB,GAAG,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC;QACnC,GAAG,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC;QAClC,GAAG,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC;QACzC,GAAG,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC;QAC3C,GAAG,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC;KAC9C,CAAC,CAAC;AACP,CAAC,CAAC","sourcesContent":["import type { ContainerProp, ElementProp } from \"@gtkx/config\";\nimport { sortStringsBy, toCamelIdentifier, upperFirst } from \"@gtkx/utils\";\nimport { ancestorChain } from \"../gir/ancestry.js\";\nimport type { GirClass } from \"../gir/class.js\";\nimport type { Library } from \"../gir/library.js\";\nimport { type GirNamespace, namespaceDirectory } from \"../gir/namespace.js\";\nimport type { GirSignal } from \"../gir/parameter.js\";\nimport { type GirProperty, isConstructableProperty } from \"../gir/property.js\";\nimport { createElementPropTypegen, type ElementPropTypegen } from \"../store/react/element-prop-types.js\";\nimport { assembleElementProps } from \"../store/react/element-props.js\";\nimport { buildGirIndex, type GirIndex } from \"../store/react/gir-index.js\";\nimport {\n    type GlibNamedClass,\n    glibNameOf,\n    implementedInterfaces,\n    newlyImplementedInterfaces,\n    signalHandlerName,\n} from \"../store/react/intrinsic-elements.js\";\nimport { isObjectProp } from \"../store/react/props.js\";\nimport {\n    classMethodEntries,\n    docMarkdown,\n    docsDefaultValue,\n    firstSentence,\n    joinSections,\n    metaBlock,\n    methodsSectionBlocks,\n    originSignatureBlocks,\n    renderDocsSignalSignature,\n    renderDocsType,\n} from \"./render.js\";\n\nexport type ElementPageContext = {\n    library: Library;\n    girIndex: GirIndex;\n    typegen: ElementPropTypegen;\n    elementProps: Record<string, ElementProp[]>;\n    linkFor: (glibName: string) => string | undefined;\n};\n\nexport const createElementPageContext = (\n    library: Library,\n    elementProps: Record<string, ElementProp[]>,\n    linkFor: (glibName: string) => string | undefined,\n): ElementPageContext => {\n    const girIndex = buildGirIndex(library);\n    const applied = assembleElementProps(girIndex, elementProps);\n    return {\n        library,\n        girIndex,\n        typegen: createElementPropTypegen(girIndex, applied),\n        elementProps: applied,\n        linkFor,\n    };\n};\n\ntype MemberOwner = {\n    klass: GirClass;\n    namespace: GirNamespace;\n    origin: string | undefined;\n    glibName: string | undefined;\n};\n\ntype PropEntry = {\n    name: string;\n    meta: string;\n    doc: string;\n};\n\nconst frontmatter = (entry: GlibNamedClass): string => {\n    const sentence = firstSentence(entry.klass.doc);\n    const description = sentence.length > 0 ? sentence : `API reference for the ${entry.glibName} element.`;\n    return `---\\ndescription: ${JSON.stringify(description)}\\n---`;\n};\n\nconst importBlock = (entry: GlibNamedClass): string =>\n    `\\`\\`\\`tsx\\nimport { ${entry.glibName} } from \"@gtkx/jsx/${namespaceDirectory(entry.namespace)}\";\\n\\`\\`\\``;\n\nconst glibLabel = (context: ElementPageContext, glibName: string): string => {\n    const link = context.linkFor(glibName);\n    return link === undefined ? `\\`${glibName}\\`` : `[${glibName}](${link})`;\n};\n\nconst hierarchySection = (entry: GlibNamedClass, context: ElementPageContext): string[] => {\n    const ancestors = [...ancestorChain(context.library, entry.klass, entry.namespace.name)].slice(1).reverse();\n    if (ancestors.length === 0) return [];\n    const parts = ancestors.map((ancestor) => {\n        const glib = glibNameOf(ancestor.klass);\n        return glib === undefined ? `\\`${ancestor.namespaceName}.${ancestor.klass.name}\\`` : glibLabel(context, glib);\n    });\n    parts.push(`**${entry.glibName}**`);\n    const lines = [`## Hierarchy`, parts.join(\" → \")];\n    const interfaces = implementedInterfaces(entry.klass, entry.namespace, context.library)\n        .map((iface) => glibNameOf(iface.klass))\n        .filter((name): name is string => name !== undefined);\n    if (interfaces.length > 0) {\n        lines.push(`Implements ${interfaces.map((name) => `\\`${name}\\``).join(\", \")}.`);\n    }\n    return lines;\n};\n\nconst callName = (call: ContainerProp[\"append\"]): string | undefined =>\n    call === undefined ? undefined : typeof call === \"string\" ? call : call.method;\n\nconst containerLine = (prop: ContainerProp, context: ElementPageContext): string => {\n    const child = glibLabel(context, prop.child);\n    const attach = callName(prop.append);\n    const detail: string[] = [];\n    if (attach !== undefined) detail.push(`attached with \\`${attach}()\\``);\n    if (prop.autowrap !== undefined) {\n        detail.push(`children are wrapped in a ${glibLabel(context, prop.autowrap)} before attaching`);\n    }\n    const suffix = detail.length > 0 ? ` (${detail.join(\"; \")})` : \"\";\n    if (prop.prop === \"children\") return `- \\`children\\` accepts ${child} elements${suffix}.`;\n    return `- \\`${prop.prop}\\` is a slot accepting ${child} elements${suffix}.`;\n};\n\nconst childrenSection = (entry: GlibNamedClass, context: ElementPageContext): string[] => {\n    const lines: string[] = [];\n    const seen = new Set<string>();\n    for (const owner of memberOwners(entry, context)) {\n        if (owner.glibName === undefined) continue;\n        const overlays = context.elementProps[owner.glibName] ?? [];\n        const containers = overlays.filter(\n            (prop): prop is ContainerProp => prop.kind === \"container\" && !seen.has(prop.prop),\n        );\n        for (const prop of containers) lines.push(containerLine(prop, context));\n        for (const prop of containers) seen.add(prop.prop);\n    }\n    if (!seen.has(\"children\") && context.typegen.acceptsChildren(entry.glibName)) {\n        lines.push(\"- `children` accepts child elements.\");\n    }\n    if (lines.length === 0) return [];\n    return [\"## Children\", lines.join(\"\\n\")];\n};\n\nconst memberOwners = (entry: GlibNamedClass, context: ElementPageContext): MemberOwner[] => [\n    { klass: entry.klass, namespace: entry.namespace, origin: undefined, glibName: entry.glibName },\n    ...newlyImplementedInterfaces(\n        entry.klass,\n        entry.namespace,\n        context.library,\n        (glibName) => glibName !== undefined && context.typegen.containerPropNamesFor(glibName).length > 0,\n    ).map((iface) => {\n        const glibName = glibNameOf(iface.klass);\n        return { klass: iface.klass, namespace: iface.namespace, origin: glibName, glibName };\n    }),\n];\n\nconst propertyEntry = (\n    context: ElementPageContext,\n    owner: MemberOwner,\n    property: GirProperty,\n    jsName: string,\n): PropEntry => {\n    const object = isObjectProp(\n        { library: context.library, klass: owner.klass, namespace: owner.namespace },\n        property,\n        jsName,\n    );\n    const baseType = renderDocsType(context.library, property.type, false);\n    const type = object ? `${baseType} | ReactElement` : baseType;\n    const meta: string[] = [`\\`${type}\\``];\n    if (property.defaultValue !== undefined) meta.push(`default \\`${docsDefaultValue(property.defaultValue)}\\``);\n    if (property.constructOnly) meta.push(\"construct-only\");\n    if (!isConstructableProperty(property)) meta.push(`read-only, observe with \\`onNotify${upperFirst(jsName)}\\``);\n    if (owner.origin !== undefined) meta.push(`from \\`${owner.origin}\\``);\n    return { name: jsName, meta: meta.join(\" · \"), doc: docMarkdown(property.doc) };\n};\n\nconst overlayNote = (overlays: ElementProp[], name: string): string | undefined => {\n    for (const overlay of overlays) {\n        if (overlay.kind === \"container\" || overlay.prop !== name) continue;\n        if (overlay.kind === \"value\") return `Applied with \\`${callName(overlay.call)}()\\`.`;\n        if (overlay.kind === \"list\") {\n            const applied = (Array.isArray(overlay.add) ? overlay.add : [overlay.add])\n                .map((call) => `\\`${callName(call)}()\\``)\n                .join(\", \");\n            return `Array prop; items are applied with ${applied}.`;\n        }\n        if (overlay.kind === \"controlled-text\") {\n            return \"Controlled: the element is synced to the prop value whenever that value changes; text the user has typed is preserved rather than reverted on every render.\";\n        }\n    }\n    return undefined;\n};\n\nconst cleanOverlayType = (type: string): string => type.replace(/\\s*\\|\\s*undefined$/, \"\").replaceAll(\"$.\", \".\");\n\nconst overlayEntries = (entry: GlibNamedClass, context: ElementPageContext, seen: Set<string>): PropEntry[] => {\n    const overlays = context.elementProps[entry.glibName] ?? [];\n    const entries: PropEntry[] = [];\n    const lines = context.typegen.classPropLines(entry.glibName, entry.klass, entry.namespace, new Map());\n    for (const line of lines) {\n        const match = line.match(/^([A-Za-z0-9_]+)\\?: (.*);$/);\n        if (match === null) continue;\n        const [, name = \"\", rawType = \"\"] = match;\n        if (seen.has(name)) continue;\n        seen.add(name);\n        const note = overlayNote(overlays, name) ?? \"Element prop managed by GTKX.\";\n        entries.push({ name, meta: `\\`${cleanOverlayType(rawType)}\\``, doc: note });\n    }\n    return entries;\n};\n\nconst withOverlayNote = (propEntry: PropEntry, note: string | undefined): PropEntry => {\n    if (note === undefined) return propEntry;\n    return { ...propEntry, doc: propEntry.doc.length > 0 ? `${note}\\n\\n${propEntry.doc}` : note };\n};\n\nconst propertyEntries = (entry: GlibNamedClass, context: ElementPageContext, seen: Set<string>): PropEntry[] => {\n    const owners = memberOwners(entry, context);\n    const overlays = owners.flatMap((owner) =>\n        owner.glibName === undefined ? [] : (context.elementProps[owner.glibName] ?? []),\n    );\n    const entries: PropEntry[] = [];\n    for (const owner of owners) {\n        for (const property of owner.klass.properties) {\n            if (!property.introspectable) continue;\n            const jsName = toCamelIdentifier(property.name);\n            if (seen.has(jsName)) continue;\n            seen.add(jsName);\n            const propEntry = propertyEntry(context, owner, property, jsName);\n            entries.push(withOverlayNote(propEntry, overlayNote(overlays, jsName)));\n        }\n    }\n    return entries;\n};\n\nconst propsSection = (entry: GlibNamedClass, context: ElementPageContext, selfType: string): string[] => {\n    const seen = new Set<string>();\n    const entries = [...propertyEntries(entry, context, seen), ...overlayEntries(entry, context, seen)];\n    const intro = [\n        `\\`ref\\` receives the \\`${selfType}\\` instance.`,\n        `Every mutable property also has an \\`onNotify<Prop>\\` handler prop called with the new value when the property changes.`,\n        `Props inherited from ancestor elements are documented on their own pages.`,\n    ].join(\" \");\n    if (entries.length === 0) return [\"## Props\", intro];\n    const sorted = sortStringsBy(entries, (item) => item.name);\n    return [\"## Props\", intro, ...sorted.map((item) => metaBlock(item.name, item.meta, item.doc))];\n};\n\ntype SignalEntry = {\n    name: string;\n    signature: string;\n    doc: string;\n    origin: string | undefined;\n};\n\nconst signalsSection = (entry: GlibNamedClass, context: ElementPageContext, selfType: string): string[] => {\n    const seen = new Set<string>();\n    const entries: SignalEntry[] = [];\n    const acceptSignal = (signal: GirSignal, origin: string | undefined): void => {\n        const name = signalHandlerName(signal.name);\n        if (seen.has(name)) return;\n        seen.add(name);\n        entries.push({\n            name,\n            signature: renderDocsSignalSignature(context.library, signal, selfType),\n            doc: docMarkdown(signal.doc),\n            origin,\n        });\n    };\n    for (const owner of memberOwners(entry, context)) {\n        for (const signal of owner.klass.signals) acceptSignal(signal, owner.origin);\n    }\n    if (entries.length === 0) return [];\n    return [\"## Signals\", ...originSignatureBlocks(entries)];\n};\n\nconst methodsSection = (entry: GlibNamedClass, context: ElementPageContext, selfType: string): string[] => {\n    const entries = classMethodEntries(context.library, entry.namespace, entry.klass);\n    const intro = `Methods are called on the \\`${selfType}\\` instance, obtained with the \\`ref\\` prop or imported from \\`@gtkx/gi/${namespaceDirectory(entry.namespace)}\\`. Methods inherited from ancestors are documented on their own pages.`;\n    return methodsSectionBlocks(entries, intro);\n};\n\nexport const renderElementPage = (entry: GlibNamedClass, context: ElementPageContext): string => {\n    const selfType = `${entry.namespace.name}.${entry.klass.name}`;\n    return joinSections([\n        frontmatter(entry),\n        `# ${entry.glibName}`,\n        docMarkdown(entry.klass.doc),\n        importBlock(entry),\n        ...hierarchySection(entry, context),\n        ...childrenSection(entry, context),\n        ...propsSection(entry, context, selfType),\n        ...signalsSection(entry, context, selfType),\n        ...methodsSection(entry, context, selfType),\n    ]);\n};\n"]}

package/dist/docs/pipeline.d.ts

@@ -0,0 +1,25 @@
+import type { ElementProp } from "@gtkx/config";
+export type DocsElementLink = {
+    text: string;
+    link: string;
+};
+export type DocsNamespace = {
+    name: string;
+    directory: string;
+    link: string;
+    elements: DocsElementLink[];
+};
+export type DocsOptions = {
+    libraries: string[];
+    girPath: string[];
+    outDir: string;
+    basePath?: string;
+    elementProps?: Record<string, ElementProp[]>;
+    force?: boolean;
+};
+export type DocsResult = {
+    regenerated: boolean;
+    namespaces: DocsNamespace[];
+};
+export declare const writeDocs: (options: DocsOptions) => DocsResult;
+//# sourceMappingURL=pipeline.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pipeline.d.ts","sourceRoot":"","sources":["../../src/docs/pipeline.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAShD,MAAM,MAAM,eAAe,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACtB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;IAC7C,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAkHF,MAAM,MAAM,UAAU,GAAG;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,aAAa,EAAE,CAAC;CAC/B,CAAC;AAEF,eAAO,MAAM,SAAS,YAAa,WAAW,KAAG,UAgChD,CAAC"}

package/dist/docs/pipeline.js

@@ -0,0 +1,130 @@
+import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { sortStringsBy } from "@gtkx/utils";
+import { computeFingerprint, FINGERPRINT_FILENAME, isStoreFresh } from "../fingerprint.js";
+import { Library } from "../gir/library.js";
+import { namespaceDirectory } from "../gir/namespace.js";
+import { collectIntrinsicElementClasses } from "../store/react/intrinsic-elements.js";
+import { createElementPageContext, renderElementPage } from "./element-page.js";
+import { elementSlug, firstSentence, namespaceOrder } from "./render.js";
+const MANIFEST_FILENAME = "manifest.json";
+const namespaceIndexPage = (namespace, elements) => {
+    const rows = elements.map((entry, index) => {
+        const link = namespace.elements[index]?.link ?? "";
+        const description = firstSentence(entry.klass.doc).replaceAll("|", "\\|");
+        return `| [${entry.glibName}](${link}) | ${description} |`;
+    });
+    return [
+        "---",
+        `description: ${JSON.stringify(`Reference pages for the ${namespace.elements.length} JSX elements in the ${namespace.name} namespace.`)}`,
+        "---",
+        "",
+        `# ${namespace.name} elements`,
+        "",
+        `Elements in this namespace are imported from \`@gtkx/jsx/${namespace.directory}\`; the matching classes, enums, and functions are imported from \`@gtkx/gi/${namespace.directory}\`.`,
+        "",
+        "| Element | Description |",
+        "| --- | --- |",
+        ...rows,
+        "",
+    ].join("\n");
+};
+const rootIndexPage = (namespaces, libraries) => {
+    const rows = namespaces.map((ns) => `| [${ns.name}](${ns.link}) | \`@gtkx/jsx/${ns.directory}\` | ${ns.elements.length} |`);
+    const librariesList = libraries.map((library) => `\`${library}\``).join(", ");
+    return [
+        "---",
+        `description: "Generated reference documentation for every JSX element in this project's GIR libraries."`,
+        "---",
+        "",
+        "# Element Reference",
+        "",
+        `This reference documents every JSX element generated from the GObject-Introspection data for ${librariesList}, together with the namespaces they pull in. It is produced by \`gtkx docs\` using the same pipeline that generates the \`@gtkx/jsx\` and \`@gtkx/gi\` bindings, so every page matches the types your editor sees.`,
+        "",
+        "Each element page lists:",
+        "",
+        "- **Props** derived from GObject properties, plus the element props GTKX adds (such as `children` and named slots), with types, defaults, and upstream documentation.",
+        "- **Signals** as `on<Signal>` handler props with their exact handler signatures.",
+        "- **Methods** available on the underlying instance through the `ref` prop.",
+        "",
+        "## Namespaces",
+        "",
+        "| Namespace | Import | Elements |",
+        "| --- | --- | --- |",
+        ...rows,
+        "",
+    ].join("\n");
+};
+const generatePages = (options, basePath, library) => {
+    const intrinsicElements = collectIntrinsicElementClasses(library);
+    const byNamespace = new Map();
+    for (const entry of intrinsicElements) {
+        const list = byNamespace.get(entry.namespace.name) ?? [];
+        list.push(entry);
+        byNamespace.set(entry.namespace.name, list);
+    }
+    const linkByGlibName = new Map();
+    for (const entry of intrinsicElements) {
+        const directory = namespaceDirectory(entry.namespace);
+        const slug = elementSlug(entry.klass.name);
+        const link = `${basePath}/${directory}/${slug}`;
+        const existing = [...linkByGlibName.values()].includes(link);
+        if (existing)
+            throw new Error(`Docs page slug collision for ${entry.glibName} at ${link}`);
+        linkByGlibName.set(entry.glibName, link);
+    }
+    const pageContext = createElementPageContext(library, options.elementProps ?? {}, (glibName) => linkByGlibName.get(glibName));
+    const pages = [];
+    const namespaces = [];
+    const orderedNames = sortStringsBy([...byNamespace.keys()], namespaceOrder);
+    for (const name of orderedNames) {
+        const elements = sortStringsBy(byNamespace.get(name) ?? [], (entry) => entry.glibName);
+        const directory = name.toLowerCase();
+        const namespaceDocs = {
+            name,
+            directory,
+            link: `${basePath}/${directory}/`,
+            elements: elements.map((entry) => ({
+                text: entry.glibName,
+                link: linkByGlibName.get(entry.glibName) ?? "",
+            })),
+        };
+        for (const entry of elements) {
+            const slug = elementSlug(entry.klass.name);
+            pages.push({ path: `${directory}/${slug}.md`, content: renderElementPage(entry, pageContext) });
+        }
+        pages.push({ path: `${directory}/index.md`, content: namespaceIndexPage(namespaceDocs, elements) });
+        namespaces.push(namespaceDocs);
+    }
+    pages.push({ path: "index.md", content: rootIndexPage(namespaces, options.libraries) });
+    return { pages, namespaces };
+};
+export const writeDocs = (options) => {
+    const basePath = options.basePath ?? "/reference";
+    const elementProps = options.elementProps ?? {};
+    const manifestPath = join(options.outDir, MANIFEST_FILENAME);
+    if (options.force !== true && isStoreFresh(options.outDir, options.libraries, elementProps)) {
+        if (existsSync(manifestPath)) {
+            const manifest = JSON.parse(readFileSync(manifestPath, "utf8"));
+            return { regenerated: false, namespaces: manifest.namespaces };
+        }
+    }
+    const library = Library.load(options.libraries, options.girPath);
+    const { pages, namespaces } = generatePages(options, basePath, library);
+    rmSync(options.outDir, { recursive: true, force: true });
+    mkdirSync(options.outDir, { recursive: true });
+    for (const page of pages) {
+        const target = join(options.outDir, page.path);
+        mkdirSync(dirname(target), { recursive: true });
+        writeFileSync(target, page.content);
+    }
+    const manifest = { namespaces };
+    writeFileSync(manifestPath, JSON.stringify(manifest));
+    writeFileSync(join(options.outDir, FINGERPRINT_FILENAME), JSON.stringify({
+        value: computeFingerprint(library.girFiles, options.libraries, elementProps),
+        girFiles: library.girFiles,
+        libraries: options.libraries,
+    }));
+    return { regenerated: true, namespaces };
+};
+//# sourceMappingURL=pipeline.js.map

package/dist/docs/pipeline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../../src/docs/pipeline.ts"],"names":[],"mappings":"AAAA,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;AAE1C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC3F,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,8BAA8B,EAAuB,MAAM,sCAAsC,CAAC;AAC3G,OAAO,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AA2BzE,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,KAAK,CAAC,CAAC;QAC1E,OAAO,MAAM,KAAK,CAAC,QAAQ,KAAK,IAAI,OAAO,WAAW,IAAI,CAAC;IAC/D,CAAC,CAAC,CAAC;IACH,OAAO;QACH,KAAK;QACL,gBAAgB,IAAI,CAAC,SAAS,CAAC,2BAA2B,SAAS,CAAC,QAAQ,CAAC,MAAM,wBAAwB,SAAS,CAAC,IAAI,aAAa,CAAC,EAAE;QACzI,KAAK;QACL,EAAE;QACF,KAAK,SAAS,CAAC,IAAI,WAAW;QAC9B,EAAE;QACF,4DAA4D,SAAS,CAAC,SAAS,+EAA+E,SAAS,CAAC,SAAS,KAAK;QACtL,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,EAAE,CAAC,QAAQ,CAAC,MAAM,IAAI,CACjG,CAAC;IACF,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9E,OAAO;QACH,KAAK;QACL,yGAAyG;QACzG,KAAK;QACL,EAAE;QACF,qBAAqB;QACrB,EAAE;QACF,gGAAgG,aAAa,oNAAoN;QACjU,EAAE;QACF,0BAA0B;QAC1B,EAAE;QACF,uKAAuK;QACvK,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;AAOF,MAAM,aAAa,GAAG,CAAC,OAAoB,EAAE,QAAgB,EAAE,OAAgB,EAAiB,EAAE;IAC9F,MAAM,iBAAiB,GAAG,8BAA8B,CAAC,OAAO,CAAC,CAAC;IAElE,MAAM,WAAW,GAAG,IAAI,GAAG,EAA4B,CAAC;IACxD,KAAK,MAAM,KAAK,IAAI,iBAAiB,EAAE,CAAC;QACpC,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,MAAM,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;IACjD,KAAK,MAAM,KAAK,IAAI,iBAAiB,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACtD,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;QAChD,MAAM,QAAQ,GAAG,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,CAAC,QAAQ,OAAO,IAAI,EAAE,CAAC,CAAC;QAC3F,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,WAAW,GAAG,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,YAAY,IAAI,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,CAC3F,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAC/B,CAAC;IAEF,MAAM,KAAK,GAAwC,EAAE,CAAC;IACtD,MAAM,UAAU,GAAoB,EAAE,CAAC;IACvC,MAAM,YAAY,GAAG,aAAa,CAAC,CAAC,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC;IAC5E,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,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACrC,MAAM,aAAa,GAAkB;YACjC,IAAI;YACJ,SAAS;YACT,IAAI,EAAE,GAAG,QAAQ,IAAI,SAAS,GAAG;YACjC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAC/B,IAAI,EAAE,KAAK,CAAC,QAAQ;gBACpB,IAAI,EAAE,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE;aACjD,CAAC,CAAC;SACN,CAAC;QACF,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3C,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,SAAS,IAAI,IAAI,KAAK,EAAE,OAAO,EAAE,iBAAiB,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;QACpG,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,SAAS,WAAW,EAAE,OAAO,EAAE,kBAAkB,CAAC,aAAa,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;QACpG,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACnC,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACxF,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AACjC,CAAC,CAAC;AAOF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,OAAoB,EAAc,EAAE;IAC1D,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,YAAY,CAAC;IAClD,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC;IAChD,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC7D,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI,IAAI,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,EAAE,YAAY,CAAC,EAAE,CAAC;QAC1F,IAAI,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAiB,CAAC;YAChF,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,CAAC;QACnE,CAAC;IACL,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;IAExE,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,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,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;IACD,MAAM,QAAQ,GAAiB,EAAE,UAAU,EAAE,CAAC;IAC9C,aAAa,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtD,aAAa,CACT,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,oBAAoB,CAAC,EAC1C,IAAI,CAAC,SAAS,CAAC;QACX,KAAK,EAAE,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,SAAS,EAAE,YAAY,CAAC;QAC5E,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;KAC/B,CAAC,CACL,CAAC;IACF,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;AAC7C,CAAC,CAAC","sourcesContent":["import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from \"node:fs\";\nimport { dirname, join } from \"node:path\";\nimport type { ElementProp } from \"@gtkx/config\";\nimport { sortStringsBy } from \"@gtkx/utils\";\nimport { computeFingerprint, FINGERPRINT_FILENAME, isStoreFresh } from \"../fingerprint.js\";\nimport { Library } from \"../gir/library.js\";\nimport { namespaceDirectory } from \"../gir/namespace.js\";\nimport { collectIntrinsicElementClasses, type GlibNamedClass } from \"../store/react/intrinsic-elements.js\";\nimport { createElementPageContext, renderElementPage } from \"./element-page.js\";\nimport { elementSlug, firstSentence, namespaceOrder } from \"./render.js\";\n\nexport type DocsElementLink = {\n    text: string;\n    link: string;\n};\n\nexport type DocsNamespace = {\n    name: string;\n    directory: string;\n    link: string;\n    elements: DocsElementLink[];\n};\n\nexport type DocsOptions = {\n    libraries: string[];\n    girPath: string[];\n    outDir: string;\n    basePath?: string;\n    elementProps?: Record<string, ElementProp[]>;\n    force?: boolean;\n};\n\ntype DocsManifest = {\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(\"|\", \"\\\\|\");\n        return `| [${entry.glibName}](${link}) | ${description} |`;\n    });\n    return [\n        \"---\",\n        `description: ${JSON.stringify(`Reference pages for the ${namespace.elements.length} JSX elements in the ${namespace.name} namespace.`)}`,\n        \"---\",\n        \"\",\n        `# ${namespace.name} elements`,\n        \"\",\n        `Elements in this namespace are imported from \\`@gtkx/jsx/${namespace.directory}\\`; the matching 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}\\` | ${ns.elements.length} |`,\n    );\n    const librariesList = libraries.map((library) => `\\`${library}\\``).join(\", \");\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 ${librariesList}, together with the namespaces they pull in. It is produced by \\`gtkx docs\\` using the same pipeline that generates the \\`@gtkx/jsx\\` and \\`@gtkx/gi\\` bindings, so every page 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` 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\ntype GeneratedDocs = {\n    pages: { path: string; content: string }[];\n    namespaces: DocsNamespace[];\n};\n\nconst generatePages = (options: DocsOptions, basePath: string, library: Library): GeneratedDocs => {\n    const intrinsicElements = collectIntrinsicElementClasses(library);\n\n    const byNamespace = new Map<string, GlibNamedClass[]>();\n    for (const entry of intrinsicElements) {\n        const list = byNamespace.get(entry.namespace.name) ?? [];\n        list.push(entry);\n        byNamespace.set(entry.namespace.name, list);\n    }\n\n    const linkByGlibName = new Map<string, string>();\n    for (const entry of intrinsicElements) {\n        const directory = namespaceDirectory(entry.namespace);\n        const slug = elementSlug(entry.klass.name);\n        const link = `${basePath}/${directory}/${slug}`;\n        const existing = [...linkByGlibName.values()].includes(link);\n        if (existing) throw new Error(`Docs page slug collision for ${entry.glibName} at ${link}`);\n        linkByGlibName.set(entry.glibName, link);\n    }\n\n    const pageContext = createElementPageContext(library, options.elementProps ?? {}, (glibName) =>\n        linkByGlibName.get(glibName),\n    );\n\n    const pages: { path: string; content: string }[] = [];\n    const namespaces: DocsNamespace[] = [];\n    const orderedNames = sortStringsBy([...byNamespace.keys()], namespaceOrder);\n    for (const name of orderedNames) {\n        const elements = sortStringsBy(byNamespace.get(name) ?? [], (entry) => entry.glibName);\n        const directory = name.toLowerCase();\n        const namespaceDocs: DocsNamespace = {\n            name,\n            directory,\n            link: `${basePath}/${directory}/`,\n            elements: elements.map((entry) => ({\n                text: entry.glibName,\n                link: linkByGlibName.get(entry.glibName) ?? \"\",\n            })),\n        };\n        for (const entry of elements) {\n            const slug = elementSlug(entry.klass.name);\n            pages.push({ path: `${directory}/${slug}.md`, content: renderElementPage(entry, pageContext) });\n        }\n        pages.push({ path: `${directory}/index.md`, content: namespaceIndexPage(namespaceDocs, elements) });\n        namespaces.push(namespaceDocs);\n    }\n    pages.push({ path: \"index.md\", content: rootIndexPage(namespaces, options.libraries) });\n    return { pages, namespaces };\n};\n\nexport type DocsResult = {\n    regenerated: boolean;\n    namespaces: DocsNamespace[];\n};\n\nexport const writeDocs = (options: DocsOptions): DocsResult => {\n    const basePath = options.basePath ?? \"/reference\";\n    const elementProps = options.elementProps ?? {};\n    const manifestPath = join(options.outDir, MANIFEST_FILENAME);\n    if (options.force !== true && isStoreFresh(options.outDir, options.libraries, elementProps)) {\n        if (existsSync(manifestPath)) {\n            const manifest = JSON.parse(readFileSync(manifestPath, \"utf8\")) as DocsManifest;\n            return { regenerated: false, namespaces: manifest.namespaces };\n        }\n    }\n\n    const library = Library.load(options.libraries, options.girPath);\n    const { pages, namespaces } = generatePages(options, basePath, library);\n\n    rmSync(options.outDir, { recursive: true, force: true });\n    mkdirSync(options.outDir, { recursive: true });\n    for (const page of pages) {\n        const target = join(options.outDir, page.path);\n        mkdirSync(dirname(target), { recursive: true });\n        writeFileSync(target, page.content);\n    }\n    const manifest: DocsManifest = { namespaces };\n    writeFileSync(manifestPath, JSON.stringify(manifest));\n    writeFileSync(\n        join(options.outDir, FINGERPRINT_FILENAME),\n        JSON.stringify({\n            value: computeFingerprint(library.girFiles, options.libraries, elementProps),\n            girFiles: library.girFiles,\n            libraries: options.libraries,\n        }),\n    );\n    return { regenerated: true, namespaces };\n};\n"]}

package/dist/docs/render.d.ts

@@ -0,0 +1,32 @@
+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 { GirSignal } from "../gir/parameter.js";
+import type { TypeId } from "../gir/type-id.js";
+import { ModuleContext } from "../writer/context.js";
+export declare const renderDocsType: (library: Library, ref: TypeId | undefined, isNullable: boolean) => string;
+export declare const renderDocsSignalSignature: (library: Library, signal: GirSignal, selfType: string) => string;
+export declare const renderDocsSignalHandlerType: (library: Library, signal: GirSignal) => string;
+export declare const docsDefaultValue: (value: string) => string;
+export declare const docMarkdown: (doc: string | undefined) => string;
+export declare const firstSentence: (doc: string | undefined) => string;
+export declare const elementSlug: (className: string) => string;
+export declare const joinSections: (sections: string[]) => string;
+export declare const metaBlock: (name: string, meta: string, doc: string) => string;
+export declare const signatureBlock: (name: string, signature: string, notes: string[]) => string;
+export declare const namespaceOrder: (name: string) => string;
+export declare const docsSignatureContext: (namespace: GirNamespace, library: Library) => ModuleContext;
+export type SignatureEntry = {
+    name: string;
+    signature: string;
+    doc: string;
+};
+export type OriginSignatureEntry = SignatureEntry & {
+    origin: string | undefined;
+};
+export declare const originSignatureBlocks: (entries: OriginSignatureEntry[]) => string[];
+export declare const classMethodEntries: (library: Library, namespace: GirNamespace, klass: GirClass) => SignatureEntry[];
+export declare const methodsSectionBlocks: (entries: SignatureEntry[], intro: string) => string[];
+export declare const instanceMethodEntries: (signatureContext: ModuleContext, methods: GirFunction[], rename: (fn: GirFunction) => string | undefined) => SignatureEntry[];
+//# sourceMappingURL=render.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../../src/docs/render.ts"],"names":[],"mappings":"AAIA,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,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAGhD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAkBrD,eAAO,MAAM,cAAc,YAAa,OAAO,OAAO,MAAM,GAAG,SAAS,cAAc,OAAO,KAAG,MAG/F,CAAC;AAcF,eAAO,MAAM,yBAAyB,YAAa,OAAO,UAAU,SAAS,YAAY,MAAM,KAAG,MAGjG,CAAC;AAEF,eAAO,MAAM,2BAA2B,YAAa,OAAO,UAAU,SAAS,KAAG,MACmC,CAAC;AAItH,eAAO,MAAM,gBAAgB,UAAW,MAAM,KAAG,MAA6C,CAAC;AAuB/F,eAAO,MAAM,WAAW,QAAS,MAAM,GAAG,SAAS,KAAG,MACsD,CAAC;AAW7G,eAAO,MAAM,aAAa,QAAS,MAAM,GAAG,SAAS,KAAG,MAMvD,CAAC;AAEF,eAAO,MAAM,WAAW,cAAe,MAAM,KAAG,MAI1B,CAAC;AAEvB,eAAO,MAAM,YAAY,aAAc,MAAM,EAAE,KAAG,MACsB,CAAC;AAEzE,eAAO,MAAM,SAAS,SAAU,MAAM,QAAQ,MAAM,OAAO,MAAM,KAAG,MAInE,CAAC;AAEF,eAAO,MAAM,cAAc,SAAU,MAAM,aAAa,MAAM,SAAS,MAAM,EAAE,KAAG,MAMjF,CAAC;AAIF,eAAO,MAAM,cAAc,SAAU,MAAM,KAAG,MAG7C,CAAC;AAIF,eAAO,MAAM,oBAAoB,cAAe,YAAY,WAAW,OAAO,KAAG,aACD,CAAC;AAEjF,MAAM,MAAM,cAAc,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAAE,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAEnF,eAAO,MAAM,qBAAqB,YAAa,oBAAoB,EAAE,KAAG,MAAM,EAMzE,CAAC;AAEN,eAAO,MAAM,kBAAkB,YAAa,OAAO,aAAa,YAAY,SAAS,QAAQ,KAAG,cAAc,EAQ7G,CAAC;AAEF,eAAO,MAAM,oBAAoB,YAAa,cAAc,EAAE,SAAS,MAAM,KAAG,MAAM,EAG0B,CAAC;AAEjH,eAAO,MAAM,qBAAqB,qBACZ,aAAa,WACtB,WAAW,EAAE,UACd,CAAC,EAAE,EAAE,WAAW,KAAK,MAAM,GAAG,SAAS,KAChD,cAAc,EAoBhB,CAAC"}