@gtkx/codegen 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (316) hide show
  1. package/README.md +1 -1
  2. package/dist/analysis/descriptor-render.d.ts +12 -15
  3. package/dist/analysis/descriptor-render.d.ts.map +1 -1
  4. package/dist/analysis/descriptor-render.js +48 -31
  5. package/dist/analysis/descriptor-render.js.map +1 -1
  6. package/dist/analysis/descriptor.d.ts +16 -7
  7. package/dist/analysis/descriptor.d.ts.map +1 -1
  8. package/dist/analysis/descriptor.js +15 -3
  9. package/dist/analysis/descriptor.js.map +1 -1
  10. package/dist/analysis/inheritance.d.ts +4 -2
  11. package/dist/analysis/inheritance.d.ts.map +1 -1
  12. package/dist/analysis/inheritance.js +80 -38
  13. package/dist/analysis/inheritance.js.map +1 -1
  14. package/dist/analysis/interface-conflicts.d.ts +23 -0
  15. package/dist/analysis/interface-conflicts.d.ts.map +1 -0
  16. package/dist/analysis/interface-conflicts.js +144 -0
  17. package/dist/analysis/interface-conflicts.js.map +1 -0
  18. package/dist/analysis/param-capability.d.ts.map +1 -1
  19. package/dist/analysis/param-capability.js +3 -4
  20. package/dist/analysis/param-capability.js.map +1 -1
  21. package/dist/analysis/param-structure.js +2 -2
  22. package/dist/analysis/param-structure.js.map +1 -1
  23. package/dist/analysis/ts-type.d.ts.map +1 -1
  24. package/dist/analysis/ts-type.js +10 -17
  25. package/dist/analysis/ts-type.js.map +1 -1
  26. package/dist/analysis/type-key.d.ts +5 -0
  27. package/dist/analysis/type-key.d.ts.map +1 -0
  28. package/dist/analysis/type-key.js +9 -0
  29. package/dist/analysis/type-key.js.map +1 -0
  30. package/dist/compile.d.ts +12 -3
  31. package/dist/compile.d.ts.map +1 -1
  32. package/dist/compile.js +73 -24
  33. package/dist/compile.js.map +1 -1
  34. package/dist/docs/api-reference.d.ts.map +1 -1
  35. package/dist/docs/api-reference.js +10 -9
  36. package/dist/docs/api-reference.js.map +1 -1
  37. package/dist/docs/element-page.d.ts.map +1 -1
  38. package/dist/docs/element-page.js +5 -3
  39. package/dist/docs/element-page.js.map +1 -1
  40. package/dist/docs/pipeline.d.ts.map +1 -1
  41. package/dist/docs/pipeline.js +85 -18
  42. package/dist/docs/pipeline.js.map +1 -1
  43. package/dist/docs/render.d.ts +2 -1
  44. package/dist/docs/render.d.ts.map +1 -1
  45. package/dist/docs/render.js +5 -4
  46. package/dist/docs/render.js.map +1 -1
  47. package/dist/docs/symbol-page.d.ts.map +1 -1
  48. package/dist/docs/symbol-page.js +9 -6
  49. package/dist/docs/symbol-page.js.map +1 -1
  50. package/dist/fingerprint.d.ts +12 -1
  51. package/dist/fingerprint.d.ts.map +1 -1
  52. package/dist/fingerprint.js +44 -28
  53. package/dist/fingerprint.js.map +1 -1
  54. package/dist/gi.d.ts.map +1 -1
  55. package/dist/gi.js +1 -0
  56. package/dist/gi.js.map +1 -1
  57. package/dist/gir/ancestry.d.ts +7 -1
  58. package/dist/gir/ancestry.d.ts.map +1 -1
  59. package/dist/gir/ancestry.js +9 -1
  60. package/dist/gir/ancestry.js.map +1 -1
  61. package/dist/gir/annotations.d.ts +1 -2
  62. package/dist/gir/annotations.d.ts.map +1 -1
  63. package/dist/gir/annotations.js +1 -1
  64. package/dist/gir/annotations.js.map +1 -1
  65. package/dist/gir/cursor-overrides.d.ts +8 -0
  66. package/dist/gir/cursor-overrides.d.ts.map +1 -0
  67. package/dist/gir/cursor-overrides.js +6 -0
  68. package/dist/gir/cursor-overrides.js.map +1 -0
  69. package/dist/gir/emittable.d.ts +7 -0
  70. package/dist/gir/emittable.d.ts.map +1 -0
  71. package/dist/gir/emittable.js +3 -0
  72. package/dist/gir/emittable.js.map +1 -0
  73. package/dist/gir/function.d.ts.map +1 -1
  74. package/dist/gir/function.js +28 -2
  75. package/dist/gir/function.js.map +1 -1
  76. package/dist/gir/library.js +1 -1
  77. package/dist/gir/library.js.map +1 -1
  78. package/dist/gir/namespace.d.ts +5 -1
  79. package/dist/gir/namespace.d.ts.map +1 -1
  80. package/dist/gir/namespace.js +4 -2
  81. package/dist/gir/namespace.js.map +1 -1
  82. package/dist/gir/parameter.d.ts +13 -1
  83. package/dist/gir/parameter.d.ts.map +1 -1
  84. package/dist/gir/parameter.js +1 -0
  85. package/dist/gir/parameter.js.map +1 -1
  86. package/dist/gir/parse.d.ts.map +1 -1
  87. package/dist/gir/parse.js +3 -6
  88. package/dist/gir/parse.js.map +1 -1
  89. package/dist/guards.d.ts +16 -0
  90. package/dist/guards.d.ts.map +1 -0
  91. package/dist/guards.js +11 -0
  92. package/dist/guards.js.map +1 -0
  93. package/dist/internal.d.ts +2 -0
  94. package/dist/internal.d.ts.map +1 -1
  95. package/dist/internal.js +2 -0
  96. package/dist/internal.js.map +1 -1
  97. package/dist/json.d.ts +3 -0
  98. package/dist/json.d.ts.map +1 -0
  99. package/dist/json.js +11 -0
  100. package/dist/json.js.map +1 -0
  101. package/dist/khronos/modules.d.ts.map +1 -1
  102. package/dist/khronos/modules.js +22 -7
  103. package/dist/khronos/modules.js.map +1 -1
  104. package/dist/khronos/parse.d.ts.map +1 -1
  105. package/dist/khronos/parse.js +3 -4
  106. package/dist/khronos/parse.js.map +1 -1
  107. package/dist/khronos/pipeline.d.ts +1 -1
  108. package/dist/khronos/pipeline.d.ts.map +1 -1
  109. package/dist/khronos/pipeline.js.map +1 -1
  110. package/dist/khronos/plan.d.ts +1 -7
  111. package/dist/khronos/plan.d.ts.map +1 -1
  112. package/dist/khronos/plan.js +1 -1
  113. package/dist/khronos/plan.js.map +1 -1
  114. package/dist/runner.d.ts +5 -1
  115. package/dist/runner.d.ts.map +1 -1
  116. package/dist/runner.js +16 -0
  117. package/dist/runner.js.map +1 -1
  118. package/dist/staging.d.ts +5 -0
  119. package/dist/staging.d.ts.map +1 -0
  120. package/dist/staging.js +57 -0
  121. package/dist/staging.js.map +1 -0
  122. package/dist/store/compile-store.d.ts.map +1 -1
  123. package/dist/store/compile-store.js +4 -2
  124. package/dist/store/compile-store.js.map +1 -1
  125. package/dist/store/gi/callables.d.ts +7 -2
  126. package/dist/store/gi/callables.d.ts.map +1 -1
  127. package/dist/store/gi/callables.js +25 -30
  128. package/dist/store/gi/callables.js.map +1 -1
  129. package/dist/store/gi/callback.d.ts.map +1 -1
  130. package/dist/store/gi/callback.js +9 -5
  131. package/dist/store/gi/callback.js.map +1 -1
  132. package/dist/store/gi/class.d.ts.map +1 -1
  133. package/dist/store/gi/class.js +59 -38
  134. package/dist/store/gi/class.js.map +1 -1
  135. package/dist/store/gi/companion.d.ts.map +1 -1
  136. package/dist/store/gi/companion.js +6 -6
  137. package/dist/store/gi/companion.js.map +1 -1
  138. package/dist/store/gi/constant.d.ts.map +1 -1
  139. package/dist/store/gi/constant.js +10 -2
  140. package/dist/store/gi/constant.js.map +1 -1
  141. package/dist/store/gi/constructor-props.js +1 -1
  142. package/dist/store/gi/constructor-props.js.map +1 -1
  143. package/dist/store/gi/enum.d.ts.map +1 -1
  144. package/dist/store/gi/enum.js +28 -8
  145. package/dist/store/gi/enum.js.map +1 -1
  146. package/dist/store/gi/function.d.ts +1 -3
  147. package/dist/store/gi/function.d.ts.map +1 -1
  148. package/dist/store/gi/function.js +24 -18
  149. package/dist/store/gi/function.js.map +1 -1
  150. package/dist/store/gi/gtype-binding.d.ts.map +1 -1
  151. package/dist/store/gi/gtype-binding.js +4 -1
  152. package/dist/store/gi/gtype-binding.js.map +1 -1
  153. package/dist/store/gi/interface.d.ts.map +1 -1
  154. package/dist/store/gi/interface.js +32 -17
  155. package/dist/store/gi/interface.js.map +1 -1
  156. package/dist/store/gi/method.d.ts +7 -6
  157. package/dist/store/gi/method.d.ts.map +1 -1
  158. package/dist/store/gi/method.js +13 -21
  159. package/dist/store/gi/method.js.map +1 -1
  160. package/dist/store/gi/param-marshal.d.ts +3 -2
  161. package/dist/store/gi/param-marshal.d.ts.map +1 -1
  162. package/dist/store/gi/param-marshal.js +50 -5
  163. package/dist/store/gi/param-marshal.js.map +1 -1
  164. package/dist/store/gi/pipeline.d.ts.map +1 -1
  165. package/dist/store/gi/pipeline.js +21 -10
  166. package/dist/store/gi/pipeline.js.map +1 -1
  167. package/dist/store/gi/properties.d.ts +2 -1
  168. package/dist/store/gi/properties.d.ts.map +1 -1
  169. package/dist/store/gi/properties.js +6 -3
  170. package/dist/store/gi/properties.js.map +1 -1
  171. package/dist/store/gi/property-accessor.d.ts +10 -5
  172. package/dist/store/gi/property-accessor.d.ts.map +1 -1
  173. package/dist/store/gi/property-accessor.js +95 -44
  174. package/dist/store/gi/property-accessor.js.map +1 -1
  175. package/dist/store/gi/record-constructor.d.ts +8 -1
  176. package/dist/store/gi/record-constructor.d.ts.map +1 -1
  177. package/dist/store/gi/record-constructor.js +31 -10
  178. package/dist/store/gi/record-constructor.js.map +1 -1
  179. package/dist/store/gi/record-field-accessor.d.ts.map +1 -1
  180. package/dist/store/gi/record-field-accessor.js +5 -1
  181. package/dist/store/gi/record-field-accessor.js.map +1 -1
  182. package/dist/store/gi/record-layout.d.ts +6 -1
  183. package/dist/store/gi/record-layout.d.ts.map +1 -1
  184. package/dist/store/gi/record-layout.js +8 -1
  185. package/dist/store/gi/record-layout.js.map +1 -1
  186. package/dist/store/gi/record.d.ts.map +1 -1
  187. package/dist/store/gi/record.js +19 -8
  188. package/dist/store/gi/record.js.map +1 -1
  189. package/dist/store/gi/registration.js +2 -2
  190. package/dist/store/gi/registration.js.map +1 -1
  191. package/dist/store/gi/signal.d.ts +2 -1
  192. package/dist/store/gi/signal.d.ts.map +1 -1
  193. package/dist/store/gi/signal.js +30 -24
  194. package/dist/store/gi/signal.js.map +1 -1
  195. package/dist/store/gi/value-marshalable.d.ts.map +1 -1
  196. package/dist/store/gi/value-marshalable.js +2 -1
  197. package/dist/store/gi/value-marshalable.js.map +1 -1
  198. package/dist/store/gi/vtable.d.ts +4 -1
  199. package/dist/store/gi/vtable.d.ts.map +1 -1
  200. package/dist/store/gi/vtable.js +60 -17
  201. package/dist/store/gi/vtable.js.map +1 -1
  202. package/dist/store/gi-store.d.ts +1 -0
  203. package/dist/store/gi-store.d.ts.map +1 -1
  204. package/dist/store/gi-store.js +15 -20
  205. package/dist/store/gi-store.js.map +1 -1
  206. package/dist/store/jsx/generated-elements.d.ts +2 -1
  207. package/dist/store/jsx/generated-elements.d.ts.map +1 -1
  208. package/dist/store/jsx/generated-elements.js +13 -7
  209. package/dist/store/jsx/generated-elements.js.map +1 -1
  210. package/dist/store/jsx/jsx.js +3 -3
  211. package/dist/store/jsx/jsx.js.map +1 -1
  212. package/dist/store/jsx/metadata.d.ts.map +1 -1
  213. package/dist/store/jsx/metadata.js +3 -1
  214. package/dist/store/jsx/metadata.js.map +1 -1
  215. package/dist/store/jsx-store.d.ts.map +1 -1
  216. package/dist/store/jsx-store.js +3 -3
  217. package/dist/store/jsx-store.js.map +1 -1
  218. package/dist/store/resolve-store.d.ts +14 -3
  219. package/dist/store/resolve-store.d.ts.map +1 -1
  220. package/dist/store/resolve-store.js +98 -15
  221. package/dist/store/resolve-store.js.map +1 -1
  222. package/dist/store/store-fs.d.ts +9 -6
  223. package/dist/store/store-fs.d.ts.map +1 -1
  224. package/dist/store/store-fs.js +59 -25
  225. package/dist/store/store-fs.js.map +1 -1
  226. package/dist/store/store-links.d.ts +3 -0
  227. package/dist/store/store-links.d.ts.map +1 -0
  228. package/dist/store/store-links.js +39 -0
  229. package/dist/store/store-links.js.map +1 -0
  230. package/dist/writer/comparison-context.d.ts +4 -0
  231. package/dist/writer/comparison-context.d.ts.map +1 -0
  232. package/dist/writer/comparison-context.js +13 -0
  233. package/dist/writer/comparison-context.js.map +1 -0
  234. package/dist/writer/context.d.ts +3 -3
  235. package/dist/writer/context.d.ts.map +1 -1
  236. package/dist/writer/context.js +11 -6
  237. package/dist/writer/context.js.map +1 -1
  238. package/dist/writer/module.d.ts +13 -5
  239. package/dist/writer/module.d.ts.map +1 -1
  240. package/dist/writer/module.js +68 -11
  241. package/dist/writer/module.js.map +1 -1
  242. package/dist/xml.d.ts +7 -1
  243. package/dist/xml.d.ts.map +1 -1
  244. package/dist/xml.js +43 -1
  245. package/dist/xml.js.map +1 -1
  246. package/package.json +14 -3
  247. package/src/analysis/descriptor-render.ts +90 -45
  248. package/src/analysis/descriptor.ts +35 -8
  249. package/src/analysis/inheritance.ts +134 -44
  250. package/src/analysis/interface-conflicts.ts +237 -0
  251. package/src/analysis/param-capability.ts +3 -6
  252. package/src/analysis/param-structure.ts +2 -2
  253. package/src/analysis/ts-type.ts +13 -17
  254. package/src/analysis/type-key.ts +14 -0
  255. package/src/compile.ts +110 -26
  256. package/src/docs/api-reference.ts +10 -9
  257. package/src/docs/element-page.ts +5 -2
  258. package/src/docs/pipeline.ts +129 -19
  259. package/src/docs/render.ts +7 -3
  260. package/src/docs/symbol-page.ts +12 -7
  261. package/src/fingerprint.ts +86 -31
  262. package/src/gi.ts +1 -0
  263. package/src/gir/ancestry.ts +17 -1
  264. package/src/gir/annotations.ts +1 -1
  265. package/src/gir/cursor-overrides.ts +12 -0
  266. package/src/gir/emittable.ts +8 -0
  267. package/src/gir/function.ts +45 -9
  268. package/src/gir/library.ts +1 -1
  269. package/src/gir/namespace.ts +8 -2
  270. package/src/gir/parameter.ts +15 -0
  271. package/src/gir/parse.ts +5 -7
  272. package/src/guards.ts +23 -0
  273. package/src/internal.ts +2 -0
  274. package/src/json.ts +11 -0
  275. package/src/khronos/modules.ts +25 -9
  276. package/src/khronos/parse.ts +3 -4
  277. package/src/khronos/pipeline.ts +1 -1
  278. package/src/khronos/plan.ts +0 -1
  279. package/src/runner.ts +19 -1
  280. package/src/staging.ts +69 -0
  281. package/src/store/compile-store.ts +6 -4
  282. package/src/store/gi/callables.ts +41 -33
  283. package/src/store/gi/callback.ts +9 -9
  284. package/src/store/gi/class.ts +79 -48
  285. package/src/store/gi/companion.ts +7 -6
  286. package/src/store/gi/constant.ts +12 -2
  287. package/src/store/gi/constructor-props.ts +1 -1
  288. package/src/store/gi/enum.ts +35 -21
  289. package/src/store/gi/function.ts +30 -24
  290. package/src/store/gi/gtype-binding.ts +7 -2
  291. package/src/store/gi/interface.ts +37 -18
  292. package/src/store/gi/method.ts +28 -29
  293. package/src/store/gi/param-marshal.ts +77 -6
  294. package/src/store/gi/pipeline.ts +25 -15
  295. package/src/store/gi/properties.ts +8 -4
  296. package/src/store/gi/property-accessor.ts +156 -73
  297. package/src/store/gi/record-constructor.ts +50 -18
  298. package/src/store/gi/record-field-accessor.ts +8 -1
  299. package/src/store/gi/record-layout.ts +11 -1
  300. package/src/store/gi/record.ts +20 -12
  301. package/src/store/gi/registration.ts +2 -2
  302. package/src/store/gi/signal.ts +36 -38
  303. package/src/store/gi/value-marshalable.ts +3 -1
  304. package/src/store/gi/vtable.ts +97 -20
  305. package/src/store/gi-store.ts +26 -31
  306. package/src/store/jsx/generated-elements.ts +17 -8
  307. package/src/store/jsx/jsx.ts +3 -3
  308. package/src/store/jsx/metadata.ts +4 -1
  309. package/src/store/jsx-store.ts +3 -3
  310. package/src/store/resolve-store.ts +133 -18
  311. package/src/store/store-fs.ts +87 -34
  312. package/src/store/store-links.ts +49 -0
  313. package/src/writer/comparison-context.ts +18 -0
  314. package/src/writer/context.ts +12 -6
  315. package/src/writer/module.ts +101 -14
  316. package/src/xml.ts +61 -1
@@ -1,15 +1,20 @@
1
1
  import { sortStringsBy } from "@gtkx/utils";
2
- import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from "node:fs";
2
+ import { mkdirSync, readdirSync, rmSync, statSync, writeFileSync } from "node:fs";
3
3
  import { dirname, join } from "node:path";
4
- import { computeGiFingerprint, FINGERPRINT_FILENAME, isGiStoreFresh } from "../fingerprint.js";
4
+ import { computeDocsFingerprint, FINGERPRINT_FILENAME, isDocsOutputFresh, } from "../fingerprint.js";
5
5
  import { Library } from "../gir/library.js";
6
6
  import { namespaceDirectory } from "../gir/namespace.js";
7
+ import { arrayGuard, hasFields, isString } from "../guards.js";
8
+ import { readJsonFile } from "../json.js";
7
9
  import { setElementProps } from "../store/jsx/element-prop-imports.js";
8
10
  import { collectIntrinsicElementClasses } from "../store/jsx/intrinsic-elements.js";
9
11
  import { setOmittedProps } from "../store/jsx/omitted-props.js";
10
12
  import { renderElementPage } from "./element-page.js";
11
13
  import { elementSlug, firstSentence, namespaceOrder } from "./render.js";
12
14
  const MANIFEST_FILENAME = "manifest.json";
15
+ const MANIFEST_GENERATOR = "gtkx-docs";
16
+ const ROOT_INDEX_FILENAME = "index.md";
17
+ const DEFAULT_BASE_PATH = "/reference";
13
18
  const namespaceIndexPage = (namespace, elements) => {
14
19
  const rows = elements.map((entry, index) => {
15
20
  const link = namespace.elements[index]?.link ?? "";
@@ -85,9 +90,22 @@ const buildElementLinks = (elements, basePath) => {
85
90
  }
86
91
  return linkByGlibName;
87
92
  };
93
+ const isEntryInsideOutDir = (value) => value.length > 0 && value !== "." && value !== ".." && !value.includes("/") && !value.includes("\\");
94
+ const isChildEntry = (value) => isString(value) && isEntryInsideOutDir(value);
95
+ const ownedEntry = (entry, source) => {
96
+ if (isEntryInsideOutDir(entry)) {
97
+ return entry;
98
+ }
99
+ throw new Error(`Refusing to generate documentation outside the output directory: ${source} maps to \`${entry}\`, ` +
100
+ "which is not an entry inside it. The GIR that declares it is malformed.");
101
+ };
102
+ const elementPagePath = (directory, entry) => {
103
+ const slug = ownedEntry(elementSlug(entry.klass.name), `the element ${entry.glibName}`);
104
+ return `${directory}/${slug}.md`;
105
+ };
88
106
  const namespacePages = (input) => {
89
107
  const { name, elements, basePath, linkByGlibName, pageContext } = input;
90
- const directory = name.toLowerCase();
108
+ const directory = ownedEntry(namespaceDirectory({ name }), `the GIR namespace ${name}`);
91
109
  const docs = {
92
110
  name,
93
111
  directory,
@@ -95,7 +113,7 @@ const namespacePages = (input) => {
95
113
  elements: elements.map((entry) => ({ text: entry.glibName, link: linkByGlibName.get(entry.glibName) ?? "" })),
96
114
  };
97
115
  const pages = elements.map((entry) => ({
98
- path: `${directory}/${elementSlug(entry.klass.name)}.md`,
116
+ path: elementPagePath(directory, entry),
99
117
  content: renderElementPage(entry, pageContext),
100
118
  }));
101
119
  pages.push({ path: `${directory}/index.md`, content: namespaceIndexPage(docs, elements) });
@@ -115,17 +133,59 @@ const generatePages = (options, basePath, library) => {
115
133
  pages.push(...result.pages);
116
134
  namespaces.push(result.docs);
117
135
  }
118
- pages.push({ path: "index.md", content: rootIndexPage(namespaces, options.libraries) });
136
+ pages.push({ path: ROOT_INDEX_FILENAME, content: rootIndexPage(namespaces, options.libraries) });
119
137
  return { pages, namespaces };
120
138
  };
121
- const cachedDocsResult = (options, manifestPath) => {
122
- if (options.isForced === true || !isGiStoreFresh(options.outDir, options.libraries, options.girPath)) {
139
+ const isGeneratorTag = (value) => value === MANIFEST_GENERATOR;
140
+ const isDocsElementLink = (value) => hasFields(value, { text: isString, link: isString });
141
+ const isDocsNamespace = (value) => hasFields(value, {
142
+ name: isString,
143
+ directory: isChildEntry,
144
+ link: isString,
145
+ elements: arrayGuard(isDocsElementLink),
146
+ });
147
+ const isDocsManifest = (value) => hasFields(value, { generator: isGeneratorTag, namespaces: arrayGuard(isDocsNamespace) });
148
+ const readDocsManifest = (manifestPath) => {
149
+ const parsed = readJsonFile(manifestPath);
150
+ return isDocsManifest(parsed) ? parsed : undefined;
151
+ };
152
+ const outDirRefusal = (outDir, reason) => new Error(`Refusing to generate documentation into ${outDir}: ${reason}. Point the output directory at an ` +
153
+ "empty directory or at one gtkx generated, or remove it yourself first.");
154
+ const assertOwnedOutDir = (options, manifest) => {
155
+ const stats = statSync(options.outDir, { throwIfNoEntry: false });
156
+ if (stats === undefined) {
157
+ return;
158
+ }
159
+ if (!stats.isDirectory()) {
160
+ throw outDirRefusal(options.outDir, "it already exists and is not a directory");
161
+ }
162
+ if (manifest !== undefined || readdirSync(options.outDir).length === 0) {
163
+ return;
164
+ }
165
+ throw outDirRefusal(options.outDir, `it is not empty and holds no ${MANIFEST_FILENAME} written by \`gtkx docs\`, ` +
166
+ "so its contents are not gtkx's to replace");
167
+ };
168
+ const clearOutDir = (options, manifest) => {
169
+ if (manifest === undefined) {
170
+ return;
171
+ }
172
+ const entries = [
173
+ ...manifest.namespaces.map((namespace) => namespace.directory),
174
+ ROOT_INDEX_FILENAME,
175
+ MANIFEST_FILENAME,
176
+ FINGERPRINT_FILENAME,
177
+ ];
178
+ for (const entry of entries) {
179
+ rmSync(join(options.outDir, entry), { recursive: true, force: true });
180
+ }
181
+ };
182
+ const cachedDocsResult = (options, manifest, input) => {
183
+ if (manifest === undefined || options.isForced === true) {
123
184
  return undefined;
124
185
  }
125
- if (!existsSync(manifestPath)) {
186
+ if (!isDocsOutputFresh(options.outDir, options.libraries, options.girPath, input)) {
126
187
  return undefined;
127
188
  }
128
- const manifest = JSON.parse(readFileSync(manifestPath, "utf8"));
129
189
  return { isRegenerated: false, namespaces: manifest.namespaces };
130
190
  };
131
191
  const writePages = (outDir, pages) => {
@@ -135,23 +195,30 @@ const writePages = (outDir, pages) => {
135
195
  writeFileSync(target, page.content);
136
196
  }
137
197
  };
198
+ const docsFingerprintInput = (options) => ({
199
+ basePath: options.basePath ?? DEFAULT_BASE_PATH,
200
+ props: options.props ?? {},
201
+ omittedProps: options.omittedProps ?? {},
202
+ });
138
203
  const writeDocs = (options) => {
139
- setElementProps(options.props ?? {});
140
- setOmittedProps(options.omittedProps ?? {});
141
- const basePath = options.basePath ?? "/reference";
204
+ const input = docsFingerprintInput(options);
205
+ setElementProps(input.props);
206
+ setOmittedProps(input.omittedProps);
142
207
  const manifestPath = join(options.outDir, MANIFEST_FILENAME);
143
- const cached = cachedDocsResult(options, manifestPath);
208
+ const previous = readDocsManifest(manifestPath);
209
+ const cached = cachedDocsResult(options, previous, input);
144
210
  if (cached !== undefined) {
145
211
  return cached;
146
212
  }
213
+ assertOwnedOutDir(options, previous);
147
214
  const library = Library.load(options.libraries, options.girPath);
148
- const { pages, namespaces } = generatePages(options, basePath, library);
149
- rmSync(options.outDir, { recursive: true, force: true });
215
+ const { pages, namespaces } = generatePages(options, input.basePath, library);
216
+ clearOutDir(options, previous);
150
217
  mkdirSync(options.outDir, { recursive: true });
151
- writePages(options.outDir, pages);
152
- const manifest = { namespaces };
218
+ const manifest = { generator: MANIFEST_GENERATOR, namespaces };
153
219
  writeFileSync(manifestPath, JSON.stringify(manifest));
154
- writeFileSync(join(options.outDir, FINGERPRINT_FILENAME), JSON.stringify(computeGiFingerprint(library.girFiles, options.libraries, options.girPath)));
220
+ writePages(options.outDir, pages);
221
+ writeFileSync(join(options.outDir, FINGERPRINT_FILENAME), JSON.stringify(computeDocsFingerprint(library.girFiles, options.libraries, options.girPath, input)));
155
222
  return { isRegenerated: true, namespaces };
156
223
  };
157
224
  export { writeDocs };
@@ -1 +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,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"]}
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,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAClF,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EACH,sBAAsB,EAEtB,oBAAoB,EACpB,iBAAiB,GACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,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;AA0CzE,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAC1C,MAAM,kBAAkB,GAAG,WAAW,CAAC;AACvC,MAAM,mBAAmB,GAAG,UAAU,CAAC;AACvC,MAAM,iBAAiB,GAAG,YAAY,CAAC;AAEvC,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,mBAAmB,GAAG,CAAC,KAAa,EAAW,EAAE,CACnD,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,KAAK,GAAG,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAEzG,MAAM,YAAY,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,mBAAmB,CAAC,KAAK,CAAC,CAAC;AAExG,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,MAAc,EAAU,EAAE;IACzD,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,IAAI,KAAK,CACX,oEAAoE,MAAM,cAAc,KAAK,MAAM;QACnG,yEAAyE,CAC5E,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAE,KAAqB,EAAU,EAAE;IACzE,MAAM,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,eAAe,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IAExF,OAAO,GAAG,SAAS,IAAI,IAAI,KAAK,CAAC;AACrC,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,UAAU,CAAC,kBAAkB,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,qBAAqB,IAAI,EAAE,CAAC,CAAC;IAExF,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,eAAe,CAAC,SAAS,EAAE,KAAK,CAAC;QACvC,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,mBAAmB,EAAE,OAAO,EAAE,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAEjG,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,KAAK,KAAK,kBAAkB,CAAC;AAEzF,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAA4B,EAAE,CACnE,SAAS,CAAkB,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;AAE1E,MAAM,eAAe,GAAG,CAAC,KAAc,EAA0B,EAAE,CAC/D,SAAS,CAAgB,KAAK,EAAE;IAC5B,IAAI,EAAE,QAAQ;IACd,SAAS,EAAE,YAAY;IACvB,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,UAAU,CAAC,iBAAiB,CAAC;CAC1C,CAAC,CAAC;AAEP,MAAM,cAAc,GAAG,CAAC,KAAc,EAAyB,EAAE,CAC7D,SAAS,CAAe,KAAK,EAAE,EAAE,SAAS,EAAE,cAAc,EAAE,UAAU,EAAE,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;AAE3G,MAAM,gBAAgB,GAAG,CAAC,YAAoB,EAA4B,EAAE;IACxE,MAAM,MAAM,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;IAE1C,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACvD,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,MAAc,EAAE,MAAc,EAAS,EAAE,CAC5D,IAAI,KAAK,CACL,2CAA2C,MAAM,KAAK,MAAM,qCAAqC;IACjG,wEAAwE,CAC3E,CAAC;AAEN,MAAM,iBAAiB,GAAG,CAAC,OAAoB,EAAE,QAAkC,EAAQ,EAAE;IACzF,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;IAElE,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO;IACX,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;QACvB,MAAM,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,0CAA0C,CAAC,CAAC;IACpF,CAAC;IAED,IAAI,QAAQ,KAAK,SAAS,IAAI,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrE,OAAO;IACX,CAAC;IAED,MAAM,aAAa,CACf,OAAO,CAAC,MAAM,EACd,gCAAgC,iBAAiB,6BAA6B;QAC9E,2CAA2C,CAC9C,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,OAAoB,EAAE,QAAkC,EAAQ,EAAE;IACnF,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO;IACX,CAAC;IAED,MAAM,OAAO,GAAG;QACZ,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC;QAC9D,mBAAmB;QACnB,iBAAiB;QACjB,oBAAoB;KACvB,CAAC;IAEF,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC1B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1E,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CACrB,OAAoB,EACpB,QAAkC,EAClC,KAA2B,EACL,EAAE;IACxB,IAAI,QAAQ,KAAK,SAAS,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;QAChF,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,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,oBAAoB,GAAG,CAAC,OAAoB,EAAwB,EAAE,CAAC,CAAC;IAC1E,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,iBAAiB;IAC/C,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE;IAC1B,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,EAAE;CAC3C,CAAC,CAAC;AAEH,MAAM,SAAS,GAAG,CAAC,OAAoB,EAAc,EAAE;IACnD,MAAM,KAAK,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAC5C,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7B,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACpC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC7D,MAAM,QAAQ,GAAG,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IAE1D,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,iBAAiB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACrC,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,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC9E,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC/B,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,MAAM,QAAQ,GAAiB,EAAE,SAAS,EAAE,kBAAkB,EAAE,UAAU,EAAE,CAAC;IAC7E,aAAa,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtD,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAElC,aAAa,CACT,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,oBAAoB,CAAC,EAC1C,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CACtG,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 { mkdirSync, readdirSync, rmSync, statSync, writeFileSync } from \"node:fs\";\nimport { dirname, join } from \"node:path\";\nimport {\n computeDocsFingerprint,\n type DocsFingerprintInput,\n FINGERPRINT_FILENAME,\n isDocsOutputFresh,\n} from \"../fingerprint.js\";\nimport { Library } from \"../gir/library.js\";\nimport { namespaceDirectory } from \"../gir/namespace.js\";\nimport { arrayGuard, hasFields, isString } from \"../guards.js\";\nimport { readJsonFile } from \"../json.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 generator: string;\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\";\nconst MANIFEST_GENERATOR = \"gtkx-docs\";\nconst ROOT_INDEX_FILENAME = \"index.md\";\nconst DEFAULT_BASE_PATH = \"/reference\";\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 isEntryInsideOutDir = (value: string): boolean =>\n value.length > 0 && value !== \".\" && value !== \"..\" && !value.includes(\"/\") && !value.includes(\"\\\\\");\n\nconst isChildEntry = (value: unknown): value is string => isString(value) && isEntryInsideOutDir(value);\n\nconst ownedEntry = (entry: string, source: string): string => {\n if (isEntryInsideOutDir(entry)) {\n return entry;\n }\n\n throw new Error(\n `Refusing to generate documentation outside the output directory: ${source} maps to \\`${entry}\\`, ` +\n \"which is not an entry inside it. The GIR that declares it is malformed.\",\n );\n};\n\nconst elementPagePath = (directory: string, entry: GlibNamedClass): string => {\n const slug = ownedEntry(elementSlug(entry.klass.name), `the element ${entry.glibName}`);\n\n return `${directory}/${slug}.md`;\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 = ownedEntry(namespaceDirectory({ name }), `the GIR namespace ${name}`);\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: elementPagePath(directory, entry),\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: ROOT_INDEX_FILENAME, content: rootIndexPage(namespaces, options.libraries) });\n\n return { pages, namespaces };\n};\n\nconst isGeneratorTag = (value: unknown): value is string => value === MANIFEST_GENERATOR;\n\nconst isDocsElementLink = (value: unknown): value is DocsElementLink =>\n hasFields<DocsElementLink>(value, { text: isString, link: isString });\n\nconst isDocsNamespace = (value: unknown): value is DocsNamespace =>\n hasFields<DocsNamespace>(value, {\n name: isString,\n directory: isChildEntry,\n link: isString,\n elements: arrayGuard(isDocsElementLink),\n });\n\nconst isDocsManifest = (value: unknown): value is DocsManifest =>\n hasFields<DocsManifest>(value, { generator: isGeneratorTag, namespaces: arrayGuard(isDocsNamespace) });\n\nconst readDocsManifest = (manifestPath: string): DocsManifest | undefined => {\n const parsed = readJsonFile(manifestPath);\n\n return isDocsManifest(parsed) ? parsed : undefined;\n};\n\nconst outDirRefusal = (outDir: string, reason: string): Error =>\n new Error(\n `Refusing to generate documentation into ${outDir}: ${reason}. Point the output directory at an ` +\n \"empty directory or at one gtkx generated, or remove it yourself first.\",\n );\n\nconst assertOwnedOutDir = (options: DocsOptions, manifest: DocsManifest | undefined): void => {\n const stats = statSync(options.outDir, { throwIfNoEntry: false });\n\n if (stats === undefined) {\n return;\n }\n\n if (!stats.isDirectory()) {\n throw outDirRefusal(options.outDir, \"it already exists and is not a directory\");\n }\n\n if (manifest !== undefined || readdirSync(options.outDir).length === 0) {\n return;\n }\n\n throw outDirRefusal(\n options.outDir,\n `it is not empty and holds no ${MANIFEST_FILENAME} written by \\`gtkx docs\\`, ` +\n \"so its contents are not gtkx's to replace\",\n );\n};\n\nconst clearOutDir = (options: DocsOptions, manifest: DocsManifest | undefined): void => {\n if (manifest === undefined) {\n return;\n }\n\n const entries = [\n ...manifest.namespaces.map((namespace) => namespace.directory),\n ROOT_INDEX_FILENAME,\n MANIFEST_FILENAME,\n FINGERPRINT_FILENAME,\n ];\n\n for (const entry of entries) {\n rmSync(join(options.outDir, entry), { recursive: true, force: true });\n }\n};\n\nconst cachedDocsResult = (\n options: DocsOptions,\n manifest: DocsManifest | undefined,\n input: DocsFingerprintInput,\n): DocsResult | undefined => {\n if (manifest === undefined || options.isForced === true) {\n return undefined;\n }\n\n if (!isDocsOutputFresh(options.outDir, options.libraries, options.girPath, input)) {\n return undefined;\n }\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 docsFingerprintInput = (options: DocsOptions): DocsFingerprintInput => ({\n basePath: options.basePath ?? DEFAULT_BASE_PATH,\n props: options.props ?? {},\n omittedProps: options.omittedProps ?? {},\n});\n\nconst writeDocs = (options: DocsOptions): DocsResult => {\n const input = docsFingerprintInput(options);\n setElementProps(input.props);\n setOmittedProps(input.omittedProps);\n const manifestPath = join(options.outDir, MANIFEST_FILENAME);\n const previous = readDocsManifest(manifestPath);\n const cached = cachedDocsResult(options, previous, input);\n\n if (cached !== undefined) {\n return cached;\n }\n\n assertOwnedOutDir(options, previous);\n const library = Library.load(options.libraries, options.girPath);\n const { pages, namespaces } = generatePages(options, input.basePath, library);\n clearOutDir(options, previous);\n mkdirSync(options.outDir, { recursive: true });\n const manifest: DocsManifest = { generator: MANIFEST_GENERATOR, namespaces };\n writeFileSync(manifestPath, JSON.stringify(manifest));\n writePages(options.outDir, pages);\n\n writeFileSync(\n join(options.outDir, FINGERPRINT_FILENAME),\n JSON.stringify(computeDocsFingerprint(library.girFiles, options.libraries, options.girPath, input)),\n );\n\n return { isRegenerated: true, namespaces };\n};\n\nexport { writeDocs };\n"]}
@@ -48,7 +48,8 @@ declare const signatureEntryBlock: (entry: SignatureEntry, leadingNotes?: string
48
48
  declare const namespaceOrder: (name: string) => string;
49
49
  declare const docsSignatureContext: (namespace: GirNamespace, library: Library) => ModuleContext;
50
50
  declare const originSignatureBlocks: (entries: OriginSignatureEntry[]) => string[];
51
+ declare const qualifiedClassName: (namespaceName: string, className: string) => string;
51
52
  declare const classMethodEntries: (library: Library, namespace: GirNamespace, klass: GirClass) => SignatureEntry[];
52
53
  declare const methodsSectionBlocks: (entries: SignatureEntry[], intro: string) => string[];
53
- 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, };
54
+ export { renderDocsType, renderDocsSignalSignature, renderDocsSignalHandlerType, annotationNotes, deprecationMeta, docMarkdown, firstSentence, elementSlug, implementsLine, joinSections, plainText, propertyMetaLine, signalTags, signatureBlock, signatureEntryBlock, sortedMetaBlocks, namespaceOrder, docsSignatureContext, originSignatureBlocks, classMethodEntries, methodsSectionBlocks, qualifiedClassName, tagNotes, type MetaDocEntry, type SignatureEntry, type OriginSignatureEntry, };
54
55
  //# sourceMappingURL=render.d.ts.map
@@ -1 +1 @@
1
- {"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"}
1
+ {"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,eAAe,MAAM,EAAE,WAAW,MAAM,KAAG,MACZ,CAAC;AAE5D,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,kBAAkB,EAClB,QAAQ,EACR,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,oBAAoB,GAC5B,CAAC"}
@@ -1,4 +1,4 @@
1
- import { pascalCase, sortStringsBy } from "@gtkx/utils";
1
+ import { sanitizeTypeIdentifier, sortStringsBy } from "@gtkx/utils";
2
2
  import { collectInheritedMethods, conflictRename } from "../analysis/inheritance.js";
3
3
  import { renderHandlerParameters, renderHandlerResultType } from "../analysis/param-structure.js";
4
4
  import { recordTypeTarget, renderBaseType } from "../analysis/ts-type.js";
@@ -166,17 +166,18 @@ const namespaceOrder = (name) => {
166
166
  };
167
167
  const docsSignatureContext = (namespace, library) => new ModuleContext({ ...namespace, name: DOCS_SIGNATURE_NAMESPACE }, library);
168
168
  const originSignatureBlocks = (entries) => sortStringsBy(entries, (item) => item.name).map((item) => signatureEntryBlock(item, item.origin === undefined ? [] : [`From \`${item.origin}\`.`]));
169
+ const qualifiedClassName = (namespaceName, className) => `${namespaceName}.${sanitizeTypeIdentifier(className)}`;
169
170
  const classMethodEntries = (library, namespace, klass) => {
170
171
  const realContext = new ModuleContext(namespace, library);
171
172
  const signatureContext = docsSignatureContext(namespace, library);
172
- const className = pascalCase(klass.name);
173
+ const className = sanitizeTypeIdentifier(klass.name);
173
174
  const inherited = collectInheritedMethods(realContext, klass);
174
175
  return instanceMethodEntries(signatureContext, klass, (method) => conflictRename(realContext, method, inherited, className));
175
176
  };
176
177
  const methodsSectionBlocks = (entries, intro) => entries.length === 0 ? [] : ["## Methods", intro, ...entries.map((item) => signatureEntryBlock(item))];
177
178
  const instanceMethodEntries = (signatureContext, klass, rename) => {
178
179
  const deduped = dedupeCallables(klass.methods);
179
- const scope = instanceScope(pascalCase(klass.name), {
180
+ const scope = instanceScope(sanitizeTypeIdentifier(klass.name), {
180
181
  constructors: dedupeCallables(klass.constructors),
181
182
  functions: dedupeCallables(klass.functions),
182
183
  methods: deduped,
@@ -201,5 +202,5 @@ const signatureText = (rendered) => {
201
202
  const start = rendered.startsWith("/**") ? rendered.indexOf("*/") + 2 : 0;
202
203
  return rendered.slice(start).trim().replace(/;$/, "");
203
204
  };
204
- export { renderDocsType, renderDocsSignalSignature, renderDocsSignalHandlerType, annotationNotes, deprecationMeta, docMarkdown, firstSentence, elementSlug, implementsLine, joinSections, plainText, propertyMetaLine, signalTags, signatureBlock, signatureEntryBlock, sortedMetaBlocks, namespaceOrder, docsSignatureContext, originSignatureBlocks, classMethodEntries, methodsSectionBlocks, tagNotes, };
205
+ export { renderDocsType, renderDocsSignalSignature, renderDocsSignalHandlerType, annotationNotes, deprecationMeta, docMarkdown, firstSentence, elementSlug, implementsLine, joinSections, plainText, propertyMetaLine, signalTags, signatureBlock, signatureEntryBlock, sortedMetaBlocks, namespaceOrder, docsSignatureContext, originSignatureBlocks, classMethodEntries, methodsSectionBlocks, qualifiedClassName, tagNotes, };
205
206
  //# sourceMappingURL=render.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"render.js","sourceRoot":"","sources":["../../src/docs/render.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAUxD,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACrF,OAAO,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAClG,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAqB,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EACH,eAAe,EACf,kBAAkB,EAClB,aAAa,EACb,6BAA6B,GAChC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AACvF,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAyBxD,MAAM,mBAAmB,GAA2B,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACnG,MAAM,UAAU,GAAG,eAAe,CAAC;AACnC,MAAM,YAAY,GAAG,WAAW,CAAC;AACjC,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC1C,MAAM,wBAAwB,GAAG,OAAO,CAAC;AACzC,MAAM,cAAc,GAAG,MAAM,CAAC;AAE9B,MAAM,UAAU,GAAG,CAAC,OAAgB,EAAgB,EAAE,CAClD,gBAAgB,CACZ,OAAO,EACP,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,QAAQ,EAAE,EAClD,GAAG,EAAE,CAAC,cAAc,CACvB,CAAC;AAEN,MAAM,cAAc,GAAG,CAAC,OAAgB,EAAE,GAAuB,EAAE,UAAmB,EAAU,EAAE;IAC9F,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC;IAE/D,OAAO,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAU,EAAE,CAClF,uBAAuB,CAAC;IACpB,OAAO;IACP,MAAM;IACN,UAAU,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC;IACrE,4BAA4B,EAAE,KAAK;IACnC,QAAQ,EAAE,IAAI;CACjB,CAAC,CAAC;AAEP,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAY,EAAE,CACpF,uBAAuB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE1G,MAAM,yBAAyB,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAE,QAAgB,EAAU,EAAE;IAClG,MAAM,MAAM,GAAG,CAAC,GAAG,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAC,CAAC;IAEtF,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;AACvF,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAU,EAAE,CAClF,IAAI,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;AAEtH,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC;AAExF,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,SAAkB,EAAwC,EAAE;IAC1F,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,SAAS,EAAE,CAAC;IACjD,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACZ,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IACrC,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC;AAC5E,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,QAAgB,EAAU,EAAE;IAChD,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAC3C,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAC7B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,GAAuB,EAAU,EAAE,CACpD,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAE7G,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAU,EAAE,CAC/C,QAAQ;KACH,UAAU,CAAC,iBAAiB,EAAE,GAAG,CAAC;KAClC,UAAU,CAAC,YAAY,EAAE,IAAI,CAAC;KAC9B,UAAU,CAAC,yBAAyB,EAAE,IAAI,CAAC;KAC3C,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC;KACxB,UAAU,CAAC,cAAc,EAAE,GAAG,CAAC;KAC/B,IAAI,EAAE,CAAC;AAEhB,MAAM,cAAc,GAAG,CAAC,GAAuB,EAAU,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AACpH,MAAM,SAAS,GAAG,CAAC,GAAuB,EAAU,EAAE,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;AAEvF,MAAM,aAAa,GAAG,CAAC,GAAuB,EAAU,EAAE;IACtD,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAE5B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;IAEpC,OAAO,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC7E,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAU,EAAE,CAC9C,SAAS;KACJ,UAAU,CAAC,oBAAoB,EAAE,OAAO,CAAC;KACzC,UAAU,CAAC,wBAAwB,EAAE,KAAK,CAAC;KAC3C,WAAW,EAAE,CAAC;AAEvB,MAAM,cAAc,GAAG,CAAC,KAAe,EAAY,EAAE;IACjD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAElE,OAAO,CAAC,cAAc,WAAW,GAAG,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,QAAkB,EAAU,EAAE,CAChD,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;AAEzE,MAAM,UAAU,GAAG,CAAC,MAAgC,EAAY,EAAE;IAC9D,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;SACzB,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACvE,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE9C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IAE7E,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3D,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,KAAa,EAAE,IAAY,EAAY,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;AAEhH,MAAM,eAAe,GAAG,CAAC,WAAyC,EAAY,EAAE;IAC5E,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC;IAChC,MAAM,OAAO,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,sBAAsB,KAAK,KAAK,CAAC;IAC3F,MAAM,IAAI,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,IAAI,EAAE,CAAC;IAEhE,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;AACzB,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,KAAyB,EAAY,EAAE,CACtD,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,oBAAoB,KAAK,IAAI,CAAC,CAAC;AAErF,MAAM,QAAQ,GAAG,CAAC,IAA2B,EAAY,EAAE;IACvD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,OAAO;QACH,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC;QAC1B,GAAG,YAAY,CAAC,aAAa,EAAE,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,GAAG,YAAY,CAAC,YAAY,EAAE,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1D,GAAG,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC;QACnC,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;KAC3B,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,WAA2B,EAAY,EAAE;IAC9D,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,WAAW,CAAC,eAAe,CAAC;IAE1C,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,oBAAoB,KAAK,EAAE,CAAC,CAAC;AAC9E,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,WAA2B,EAAY,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC;AAEzG,MAAM,UAAU,GAAG,CAAC,MAAmB,EAAE,cAAuB,EAAa,EAAE,CAC3E,cAAc,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;AAEtF,MAAM,SAAS,GAAG,CAAC,KAAmB,EAAU,EAAE;IAC9C,MAAM,KAAK,GAAG,CAAC,SAAS,KAAK,CAAC,IAAI,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAExD,KAAK,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACtD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QACzB,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAAuB,EAAY,EAAE,CAC3D,aAAa,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;AAE/E,MAAM,gBAAgB,GAAG,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAuB,EAAU,EAAE;IAC9F,MAAM,IAAI,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;IAE7B,IAAI,QAAQ,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,aAAa,gBAAgB,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC;IAED,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAChC,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,GAAG,WAAW,EAAE,GAAG,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;IAEpE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,CAAC,IAAI,CAAC,UAAU,MAAM,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,SAAiB,EAAE,KAAe,EAAU,EAAE;IAChF,MAAM,KAAK,GAAG,CAAC,SAAS,IAAI,IAAI,EAAE,EAAE,EAAE,aAAa,SAAS,UAAU,CAAC,CAAC;IAExE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QACzB,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,KAAqB,EAAE,eAAyB,EAAE,EAAU,EAAE,CACvF,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,GAAG,YAAY,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAEvG,MAAM,cAAc,GAAG,CAAC,IAAY,EAAU,EAAE;IAC5C,MAAM,KAAK,GAAG,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;AAC3D,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,SAAuB,EAAE,OAAgB,EAAiB,EAAE,CACtF,IAAI,aAAa,CAAC,EAAE,GAAG,SAAS,EAAE,IAAI,EAAE,wBAAwB,EAAE,EAAE,OAAO,CAAC,CAAC;AAEjF,MAAM,qBAAqB,GAAG,CAAC,OAA+B,EAAY,EAAE,CACxE,aAAa,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACrD,mBAAmB,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAC3F,CAAC;AAEN,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAE,SAAuB,EAAE,KAAe,EAAoB,EAAE;IACxG,MAAM,WAAW,GAAG,IAAI,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1D,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAClE,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,SAAS,GAAG,uBAAuB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAE9D,OAAO,qBAAqB,CAAC,gBAAgB,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,CAC7D,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAC5D,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,OAAyB,EAAE,KAAa,EAAY,EAAE,CAChF,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAE3G,MAAM,qBAAqB,GAAG,CAC1B,gBAA+B,EAC/B,KAAe,EACf,MAA+C,EAC/B,EAAE;IAClB,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAE/C,MAAM,KAAK,GAAG,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;QAChD,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC;QACjD,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS,CAAC;QAC3C,OAAO,EAAE,OAAO;KACnB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAqB,EAAE,CAAC;IAErC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC3B,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,QAAQ,GAAG,6BAA6B,CAAC,gBAAgB,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;QAE9F,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,SAAS;QACb,CAAC;QAED,OAAO,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,YAAY,IAAI,gBAAgB,CAAC,MAAM,CAAC;YAC9C,SAAS,EAAE,aAAa,CAAC,QAAQ,CAAC;YAClC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC;YAC5B,IAAI,EAAE,kBAAkB,CAAC,gBAAgB,EAAE,MAAM,EAAE,KAAK,CAAC;SAC5D,CAAC,CAAC;IACP,CAAC;IAED,OAAO,aAAa,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAU,EAAE;IAC/C,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1E,OAAO,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAC1D,CAAC,CAAC;AAEF,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,GAIX,CAAC","sourcesContent":["import { pascalCase, sortStringsBy } from \"@gtkx/utils\";\nimport type { GirAnnotations } from \"../gir/annotations.js\";\nimport type { GirClass } from \"../gir/class.js\";\nimport type { GirFunction } from \"../gir/function.js\";\nimport type { Library } from \"../gir/library.js\";\nimport type { GirNamespace } from \"../gir/namespace.js\";\nimport type { GirCallable } from \"../gir/parameter.js\";\nimport type { GirProperty } from \"../gir/property.js\";\nimport type { TypeId } from \"../gir/type-id.js\";\nimport type { JsDocDeprecation, JsDocParam, JsDocSpec } from \"../writer/doc-tags.js\";\nimport { collectInheritedMethods, conflictRename } from \"../analysis/inheritance.js\";\nimport { renderHandlerParameters, renderHandlerResultType } from \"../analysis/param-structure.js\";\nimport { recordTypeTarget, renderBaseType, type TsTypeTarget } from \"../analysis/ts-type.js\";\nimport {\n dedupeCallables,\n instanceMemberSpec,\n instanceScope,\n renderInstanceMethodSignature,\n} from \"../store/gi/callables.js\";\nimport { annotationSpec, handlerSpec, selfHandlerSpec } from \"../store/gi/doc-spec.js\";\nimport { methodExportName } from \"../store/gi/method.js\";\nimport { ModuleContext } from \"../writer/context.js\";\nimport { stripDocMedia } from \"../writer/doc-tags.js\";\nimport { gtkDocToMarkdown } from \"../writer/gtk-doc.js\";\n\ntype SignatureEntry = {\n name: string;\n signature: string;\n doc: string;\n tags?: JsDocSpec | undefined;\n};\n\ntype OriginSignatureEntry = SignatureEntry & { origin: string | undefined };\n\ntype MetaDocEntry = {\n name: string;\n meta: string;\n doc: string;\n tags?: JsDocSpec | undefined;\n};\n\ntype PropertyMetaOptions = {\n type: string;\n property: GirProperty;\n accessNotes: string[];\n origin: string | undefined;\n};\n\nconst DOCS_DEFAULT_VALUES: Record<string, string> = { TRUE: \"true\", FALSE: \"false\", NULL: \"null\" };\nconst FENCE_LINE = /^\\s*(```|~~~)/;\nconst HEADING_LINE = /^#{1,5}\\s/;\nconst LEADING_NAMESPACES = [\"Gtk\", \"Adw\"];\nconst DOCS_SIGNATURE_NAMESPACE = \"$docs\";\nconst WHITESPACE_RUN = /\\s+/g;\n\nconst docsTarget = (library: Library): TsTypeTarget =>\n recordTypeTarget(\n library,\n (name) => `${name.namespaceName}.${name.typeName}`,\n () => \"GObject.Type\",\n );\n\nconst renderDocsType = (library: Library, ref: TypeId | undefined, isNullable: boolean): string => {\n const base = renderBaseType(library, docsTarget(library), ref);\n\n return isNullable ? `${base} | null` : base;\n};\n\nconst renderDocsHandlerResultType = (library: Library, signal: GirCallable): string =>\n renderHandlerResultType({\n library,\n signal,\n renderType: (ref, nullable) => renderDocsType(library, ref, nullable),\n shouldIncludeCallerAllocated: false,\n isOptOut: true,\n });\n\nconst renderDocsHandlerParameters = (library: Library, signal: GirCallable): string[] =>\n renderHandlerParameters(signal.parameters, (ref, nullable) => renderDocsType(library, ref, nullable));\n\nconst renderDocsSignalSignature = (library: Library, signal: GirCallable, selfType: string): string => {\n const params = [...renderDocsHandlerParameters(library, signal), `self: ${selfType}`];\n\n return `(${params.join(\", \")}) => ${renderDocsHandlerResultType(library, signal)}`;\n};\n\nconst renderDocsSignalHandlerType = (library: Library, signal: GirCallable): string =>\n `(${renderDocsHandlerParameters(library, signal).join(\", \")}) => ${renderDocsHandlerResultType(library, signal)}`;\n\nconst docsDefaultValue = (value: string): string => DOCS_DEFAULT_VALUES[value] ?? value;\n\nconst demoteLine = (line: string, isInFence: boolean): { text: string; isInFence: boolean } => {\n if (FENCE_LINE.test(line)) {\n return { text: line, isInFence: !isInFence };\n }\n\n if (isInFence) {\n return { text: line, isInFence };\n }\n\n return { text: HEADING_LINE.test(line) ? `#${line}` : line, isInFence };\n};\n\nconst demoteHeadings = (markdown: string): string => {\n let isInFence = false;\n const lines: string[] = [];\n\n for (const line of markdown.split(\"\\n\")) {\n const result = demoteLine(line, isInFence);\n isInFence = result.isInFence;\n lines.push(result.text);\n }\n\n return lines.join(\"\\n\");\n};\n\nconst docMarkdown = (doc: string | undefined): string =>\n doc === undefined || doc.length === 0 ? \"\" : demoteHeadings(stripDocMedia(gtkDocToMarkdown(doc))).trim();\n\nconst stripMarkdown = (markdown: string): string =>\n markdown\n .replaceAll(/```[\\s\\S]*?```/g, \" \")\n .replaceAll(/`([^`]*)`/g, \"$1\")\n .replaceAll(/\\[([^[\\]]*)\\]\\([^)]*\\)/g, \"$1\")\n .replaceAll(/[*#>]/g, \"\")\n .replaceAll(WHITESPACE_RUN, \" \")\n .trim();\n\nconst inlineMarkdown = (doc: string | undefined): string => docMarkdown(doc).replaceAll(WHITESPACE_RUN, \" \").trim();\nconst plainText = (doc: string | undefined): string => stripMarkdown(docMarkdown(doc));\n\nconst firstSentence = (doc: string | undefined): string => {\n const text = plainText(doc);\n\n if (text.length === 0) {\n return \"\";\n }\n\n const match = /^.*?[.!?](?=\\s|$)/.exec(text);\n const sentence = match?.[0] ?? text;\n\n return sentence.length > 220 ? `${sentence.slice(0, 217)}...` : sentence;\n};\n\nconst elementSlug = (className: string): string =>\n className\n .replaceAll(/([a-z0-9])([A-Z])/g, \"$1-$2\")\n .replaceAll(/([A-Z])(?=[A-Z][a-z])/g, \"$1-\")\n .toLowerCase();\n\nconst implementsLine = (names: string[]): string[] => {\n if (names.length === 0) {\n return [];\n }\n\n const quotedNames = names.map((name) => `\\`${name}\\``).join(\", \");\n\n return [`Implements ${quotedNames}.`];\n};\n\nconst joinSections = (sections: string[]): string =>\n `${sections.filter((section) => section.length > 0).join(\"\\n\\n\")}\\n`;\n\nconst paramNotes = (params: JsDocParam[] | undefined): string[] => {\n const entries = (params ?? [])\n .map((param) => ({ name: param.name, text: inlineMarkdown(param.doc) }))\n .filter((entry) => entry.text.length > 0);\n\n if (entries.length === 0) {\n return [];\n }\n\n const bullets = entries.map((entry) => `- \\`${entry.name}\\`: ${entry.text}`);\n\n return [[\"**Parameters**\", \"\", ...bullets].join(\"\\n\")];\n};\n\nconst labelledNote = (label: string, text: string): string[] => (text.length === 0 ? [] : [`${label} ${text}`]);\n\nconst deprecationNote = (deprecation: JsDocDeprecation | undefined): string[] => {\n if (deprecation === undefined) {\n return [];\n }\n\n const since = deprecation.since;\n const heading = since === undefined ? \"**Deprecated.**\" : `**Deprecated since ${since}.**`;\n const text = inlineMarkdown(deprecation.doc);\n const body = text.length === 0 ? heading : `${heading} ${text}`;\n\n return [`> ${body}`];\n};\n\nconst sinceNote = (since: string | undefined): string[] =>\n since === undefined || since.length === 0 ? [] : [`_Available since ${since}._`];\n\nconst tagNotes = (spec: JsDocSpec | undefined): string[] => {\n if (spec === undefined) {\n return [];\n }\n\n return [\n ...paramNotes(spec.params),\n ...labelledNote(\"**Returns**\", docMarkdown(spec.returns)),\n ...labelledNote(\"**Throws**\", inlineMarkdown(spec.throws)),\n ...deprecationNote(spec.deprecated),\n ...sinceNote(spec.since),\n ];\n};\n\nconst deprecationMeta = (annotations: GirAnnotations): string[] => {\n if (!annotations.isDeprecated) {\n return [];\n }\n\n const since = annotations.deprecatedSince;\n\n return [since === undefined ? \"deprecated\" : `deprecated since ${since}`];\n};\n\nconst annotationNotes = (annotations: GirAnnotations): string[] => tagNotes(annotationSpec(annotations));\n\nconst signalTags = (signal: GirCallable, isSelfIncluded: boolean): JsDocSpec =>\n isSelfIncluded ? selfHandlerSpec(signal) : handlerSpec(signal, signal.parameters);\n\nconst metaBlock = (entry: MetaDocEntry): string => {\n const lines = [`### \\`${entry.name}\\``, \"\", entry.meta];\n\n for (const note of [entry.doc, ...tagNotes(entry.tags)]) {\n if (note.length > 0) {\n lines.push(\"\", note);\n }\n }\n\n return lines.join(\"\\n\");\n};\n\nconst sortedMetaBlocks = (entries: MetaDocEntry[]): string[] =>\n sortStringsBy(entries, (item) => item.name).map((item) => metaBlock(item));\n\nconst propertyMetaLine = ({ type, property, accessNotes, origin }: PropertyMetaOptions): string => {\n const meta = [`\\`${type}\\``];\n\n if (property.defaultValue !== undefined) {\n meta.push(`default \\`${docsDefaultValue(property.defaultValue)}\\``);\n }\n\n if (property.constructOnly) {\n meta.push(\"construct-only\");\n }\n\n meta.push(...accessNotes, ...deprecationMeta(property.annotations));\n\n if (origin !== undefined) {\n meta.push(`from \\`${origin}\\``);\n }\n\n return meta.join(\" · \");\n};\n\nconst signatureBlock = (name: string, signature: string, notes: string[]): string => {\n const lines = [`### \\`${name}\\``, \"\", `\\`\\`\\`ts\\n${signature}\\n\\`\\`\\``];\n\n for (const note of notes) {\n if (note.length > 0) {\n lines.push(\"\", note);\n }\n }\n\n return lines.join(\"\\n\");\n};\n\nconst signatureEntryBlock = (entry: SignatureEntry, leadingNotes: string[] = []): string =>\n signatureBlock(entry.name, entry.signature, [...leadingNotes, entry.doc, ...tagNotes(entry.tags)]);\n\nconst namespaceOrder = (name: string): string => {\n const index = LEADING_NAMESPACES.indexOf(name);\n\n return index === -1 ? `1${name}` : `0${String(index)}`;\n};\n\nconst docsSignatureContext = (namespace: GirNamespace, library: Library): ModuleContext =>\n new ModuleContext({ ...namespace, name: DOCS_SIGNATURE_NAMESPACE }, library);\n\nconst originSignatureBlocks = (entries: OriginSignatureEntry[]): string[] =>\n sortStringsBy(entries, (item) => item.name).map((item) =>\n signatureEntryBlock(item, item.origin === undefined ? [] : [`From \\`${item.origin}\\`.`]),\n );\n\nconst classMethodEntries = (library: Library, namespace: GirNamespace, klass: GirClass): SignatureEntry[] => {\n const realContext = new ModuleContext(namespace, library);\n const signatureContext = docsSignatureContext(namespace, library);\n const className = pascalCase(klass.name);\n const inherited = collectInheritedMethods(realContext, klass);\n\n return instanceMethodEntries(signatureContext, klass, (method) =>\n conflictRename(realContext, method, inherited, className),\n );\n};\n\nconst methodsSectionBlocks = (entries: SignatureEntry[], intro: string): string[] =>\n entries.length === 0 ? [] : [\"## Methods\", intro, ...entries.map((item) => signatureEntryBlock(item))];\n\nconst instanceMethodEntries = (\n signatureContext: ModuleContext,\n klass: GirClass,\n rename: (fn: GirFunction) => string | undefined,\n): SignatureEntry[] => {\n const deduped = dedupeCallables(klass.methods);\n\n const scope = instanceScope(pascalCase(klass.name), {\n constructors: dedupeCallables(klass.constructors),\n functions: dedupeCallables(klass.functions),\n methods: deduped,\n });\n\n const entries: SignatureEntry[] = [];\n\n for (const method of deduped) {\n const nameOverride = rename(method);\n const rendered = renderInstanceMethodSignature(signatureContext, method, scope, nameOverride);\n\n if (rendered === undefined) {\n continue;\n }\n\n entries.push({\n name: nameOverride ?? methodExportName(method),\n signature: signatureText(rendered),\n doc: docMarkdown(method.doc),\n tags: instanceMemberSpec(signatureContext, method, scope),\n });\n }\n\n return sortStringsBy(entries, (entry) => entry.name);\n};\n\nconst signatureText = (rendered: string): string => {\n const start = rendered.startsWith(\"/**\") ? rendered.indexOf(\"*/\") + 2 : 0;\n\n return rendered.slice(start).trim().replace(/;$/, \"\");\n};\n\nexport {\n renderDocsType,\n renderDocsSignalSignature,\n renderDocsSignalHandlerType,\n annotationNotes,\n deprecationMeta,\n docMarkdown,\n firstSentence,\n elementSlug,\n implementsLine,\n joinSections,\n plainText,\n propertyMetaLine,\n signalTags,\n signatureBlock,\n signatureEntryBlock,\n sortedMetaBlocks,\n namespaceOrder,\n docsSignatureContext,\n originSignatureBlocks,\n classMethodEntries,\n methodsSectionBlocks,\n tagNotes,\n type MetaDocEntry,\n type SignatureEntry,\n type OriginSignatureEntry,\n};\n"]}
1
+ {"version":3,"file":"render.js","sourceRoot":"","sources":["../../src/docs/render.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAUpE,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACrF,OAAO,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAClG,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAqB,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EACH,eAAe,EACf,kBAAkB,EAClB,aAAa,EACb,6BAA6B,GAChC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AACvF,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAyBxD,MAAM,mBAAmB,GAA2B,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACnG,MAAM,UAAU,GAAG,eAAe,CAAC;AACnC,MAAM,YAAY,GAAG,WAAW,CAAC;AACjC,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC1C,MAAM,wBAAwB,GAAG,OAAO,CAAC;AACzC,MAAM,cAAc,GAAG,MAAM,CAAC;AAE9B,MAAM,UAAU,GAAG,CAAC,OAAgB,EAAgB,EAAE,CAClD,gBAAgB,CACZ,OAAO,EACP,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,QAAQ,EAAE,EAClD,GAAG,EAAE,CAAC,cAAc,CACvB,CAAC;AAEN,MAAM,cAAc,GAAG,CAAC,OAAgB,EAAE,GAAuB,EAAE,UAAmB,EAAU,EAAE;IAC9F,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC;IAE/D,OAAO,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAU,EAAE,CAClF,uBAAuB,CAAC;IACpB,OAAO;IACP,MAAM;IACN,UAAU,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC;IACrE,4BAA4B,EAAE,KAAK;IACnC,QAAQ,EAAE,IAAI;CACjB,CAAC,CAAC;AAEP,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAY,EAAE,CACpF,uBAAuB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE1G,MAAM,yBAAyB,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAE,QAAgB,EAAU,EAAE;IAClG,MAAM,MAAM,GAAG,CAAC,GAAG,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAC,CAAC;IAEtF,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;AACvF,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAU,EAAE,CAClF,IAAI,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;AAEtH,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC;AAExF,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,SAAkB,EAAwC,EAAE;IAC1F,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,SAAS,EAAE,CAAC;IACjD,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACZ,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IACrC,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC;AAC5E,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,QAAgB,EAAU,EAAE;IAChD,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAC3C,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAC7B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,GAAuB,EAAU,EAAE,CACpD,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAE7G,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAU,EAAE,CAC/C,QAAQ;KACH,UAAU,CAAC,iBAAiB,EAAE,GAAG,CAAC;KAClC,UAAU,CAAC,YAAY,EAAE,IAAI,CAAC;KAC9B,UAAU,CAAC,yBAAyB,EAAE,IAAI,CAAC;KAC3C,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC;KACxB,UAAU,CAAC,cAAc,EAAE,GAAG,CAAC;KAC/B,IAAI,EAAE,CAAC;AAEhB,MAAM,cAAc,GAAG,CAAC,GAAuB,EAAU,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AACpH,MAAM,SAAS,GAAG,CAAC,GAAuB,EAAU,EAAE,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;AAEvF,MAAM,aAAa,GAAG,CAAC,GAAuB,EAAU,EAAE;IACtD,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAE5B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;IAEpC,OAAO,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC7E,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAU,EAAE,CAC9C,SAAS;KACJ,UAAU,CAAC,oBAAoB,EAAE,OAAO,CAAC;KACzC,UAAU,CAAC,wBAAwB,EAAE,KAAK,CAAC;KAC3C,WAAW,EAAE,CAAC;AAEvB,MAAM,cAAc,GAAG,CAAC,KAAe,EAAY,EAAE;IACjD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAElE,OAAO,CAAC,cAAc,WAAW,GAAG,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,QAAkB,EAAU,EAAE,CAChD,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;AAEzE,MAAM,UAAU,GAAG,CAAC,MAAgC,EAAY,EAAE;IAC9D,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;SACzB,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACvE,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE9C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IAE7E,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3D,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,KAAa,EAAE,IAAY,EAAY,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;AAEhH,MAAM,eAAe,GAAG,CAAC,WAAyC,EAAY,EAAE;IAC5E,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC;IAChC,MAAM,OAAO,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,sBAAsB,KAAK,KAAK,CAAC;IAC3F,MAAM,IAAI,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,IAAI,EAAE,CAAC;IAEhE,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;AACzB,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,KAAyB,EAAY,EAAE,CACtD,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,oBAAoB,KAAK,IAAI,CAAC,CAAC;AAErF,MAAM,QAAQ,GAAG,CAAC,IAA2B,EAAY,EAAE;IACvD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,OAAO;QACH,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC;QAC1B,GAAG,YAAY,CAAC,aAAa,EAAE,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,GAAG,YAAY,CAAC,YAAY,EAAE,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1D,GAAG,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC;QACnC,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;KAC3B,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,WAA2B,EAAY,EAAE;IAC9D,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,WAAW,CAAC,eAAe,CAAC;IAE1C,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,oBAAoB,KAAK,EAAE,CAAC,CAAC;AAC9E,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,WAA2B,EAAY,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC;AAEzG,MAAM,UAAU,GAAG,CAAC,MAAmB,EAAE,cAAuB,EAAa,EAAE,CAC3E,cAAc,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;AAEtF,MAAM,SAAS,GAAG,CAAC,KAAmB,EAAU,EAAE;IAC9C,MAAM,KAAK,GAAG,CAAC,SAAS,KAAK,CAAC,IAAI,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAExD,KAAK,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACtD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QACzB,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAAuB,EAAY,EAAE,CAC3D,aAAa,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;AAE/E,MAAM,gBAAgB,GAAG,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAuB,EAAU,EAAE;IAC9F,MAAM,IAAI,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;IAE7B,IAAI,QAAQ,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,aAAa,gBAAgB,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC;IAED,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAChC,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,GAAG,WAAW,EAAE,GAAG,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;IAEpE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,CAAC,IAAI,CAAC,UAAU,MAAM,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,SAAiB,EAAE,KAAe,EAAU,EAAE;IAChF,MAAM,KAAK,GAAG,CAAC,SAAS,IAAI,IAAI,EAAE,EAAE,EAAE,aAAa,SAAS,UAAU,CAAC,CAAC;IAExE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QACzB,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,KAAqB,EAAE,eAAyB,EAAE,EAAU,EAAE,CACvF,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,GAAG,YAAY,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAEvG,MAAM,cAAc,GAAG,CAAC,IAAY,EAAU,EAAE;IAC5C,MAAM,KAAK,GAAG,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;AAC3D,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,SAAuB,EAAE,OAAgB,EAAiB,EAAE,CACtF,IAAI,aAAa,CAAC,EAAE,GAAG,SAAS,EAAE,IAAI,EAAE,wBAAwB,EAAE,EAAE,OAAO,CAAC,CAAC;AAEjF,MAAM,qBAAqB,GAAG,CAAC,OAA+B,EAAY,EAAE,CACxE,aAAa,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACrD,mBAAmB,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAC3F,CAAC;AAEN,MAAM,kBAAkB,GAAG,CAAC,aAAqB,EAAE,SAAiB,EAAU,EAAE,CAC5E,GAAG,aAAa,IAAI,sBAAsB,CAAC,SAAS,CAAC,EAAE,CAAC;AAE5D,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAE,SAAuB,EAAE,KAAe,EAAoB,EAAE;IACxG,MAAM,WAAW,GAAG,IAAI,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1D,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAClE,MAAM,SAAS,GAAG,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACrD,MAAM,SAAS,GAAG,uBAAuB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAE9D,OAAO,qBAAqB,CAAC,gBAAgB,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,CAC7D,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAC5D,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,OAAyB,EAAE,KAAa,EAAY,EAAE,CAChF,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAE3G,MAAM,qBAAqB,GAAG,CAC1B,gBAA+B,EAC/B,KAAe,EACf,MAA+C,EAC/B,EAAE;IAClB,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAE/C,MAAM,KAAK,GAAG,aAAa,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;QAC5D,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC;QACjD,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS,CAAC;QAC3C,OAAO,EAAE,OAAO;KACnB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAqB,EAAE,CAAC;IAErC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC3B,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,QAAQ,GAAG,6BAA6B,CAAC,gBAAgB,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;QAE9F,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,SAAS;QACb,CAAC;QAED,OAAO,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,YAAY,IAAI,gBAAgB,CAAC,MAAM,CAAC;YAC9C,SAAS,EAAE,aAAa,CAAC,QAAQ,CAAC;YAClC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC;YAC5B,IAAI,EAAE,kBAAkB,CAAC,gBAAgB,EAAE,MAAM,EAAE,KAAK,CAAC;SAC5D,CAAC,CAAC;IACP,CAAC;IAED,OAAO,aAAa,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAU,EAAE;IAC/C,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1E,OAAO,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAC1D,CAAC,CAAC;AAEF,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,kBAAkB,EAClB,QAAQ,GAIX,CAAC","sourcesContent":["import { sanitizeTypeIdentifier, sortStringsBy } from \"@gtkx/utils\";\nimport type { GirAnnotations } from \"../gir/annotations.js\";\nimport type { GirClass } from \"../gir/class.js\";\nimport type { GirFunction } from \"../gir/function.js\";\nimport type { Library } from \"../gir/library.js\";\nimport type { GirNamespace } from \"../gir/namespace.js\";\nimport type { GirCallable } from \"../gir/parameter.js\";\nimport type { GirProperty } from \"../gir/property.js\";\nimport type { TypeId } from \"../gir/type-id.js\";\nimport type { JsDocDeprecation, JsDocParam, JsDocSpec } from \"../writer/doc-tags.js\";\nimport { collectInheritedMethods, conflictRename } from \"../analysis/inheritance.js\";\nimport { renderHandlerParameters, renderHandlerResultType } from \"../analysis/param-structure.js\";\nimport { recordTypeTarget, renderBaseType, type TsTypeTarget } from \"../analysis/ts-type.js\";\nimport {\n dedupeCallables,\n instanceMemberSpec,\n instanceScope,\n renderInstanceMethodSignature,\n} from \"../store/gi/callables.js\";\nimport { annotationSpec, handlerSpec, selfHandlerSpec } from \"../store/gi/doc-spec.js\";\nimport { methodExportName } from \"../store/gi/method.js\";\nimport { ModuleContext } from \"../writer/context.js\";\nimport { stripDocMedia } from \"../writer/doc-tags.js\";\nimport { gtkDocToMarkdown } from \"../writer/gtk-doc.js\";\n\ntype SignatureEntry = {\n name: string;\n signature: string;\n doc: string;\n tags?: JsDocSpec | undefined;\n};\n\ntype OriginSignatureEntry = SignatureEntry & { origin: string | undefined };\n\ntype MetaDocEntry = {\n name: string;\n meta: string;\n doc: string;\n tags?: JsDocSpec | undefined;\n};\n\ntype PropertyMetaOptions = {\n type: string;\n property: GirProperty;\n accessNotes: string[];\n origin: string | undefined;\n};\n\nconst DOCS_DEFAULT_VALUES: Record<string, string> = { TRUE: \"true\", FALSE: \"false\", NULL: \"null\" };\nconst FENCE_LINE = /^\\s*(```|~~~)/;\nconst HEADING_LINE = /^#{1,5}\\s/;\nconst LEADING_NAMESPACES = [\"Gtk\", \"Adw\"];\nconst DOCS_SIGNATURE_NAMESPACE = \"$docs\";\nconst WHITESPACE_RUN = /\\s+/g;\n\nconst docsTarget = (library: Library): TsTypeTarget =>\n recordTypeTarget(\n library,\n (name) => `${name.namespaceName}.${name.typeName}`,\n () => \"GObject.Type\",\n );\n\nconst renderDocsType = (library: Library, ref: TypeId | undefined, isNullable: boolean): string => {\n const base = renderBaseType(library, docsTarget(library), ref);\n\n return isNullable ? `${base} | null` : base;\n};\n\nconst renderDocsHandlerResultType = (library: Library, signal: GirCallable): string =>\n renderHandlerResultType({\n library,\n signal,\n renderType: (ref, nullable) => renderDocsType(library, ref, nullable),\n shouldIncludeCallerAllocated: false,\n isOptOut: true,\n });\n\nconst renderDocsHandlerParameters = (library: Library, signal: GirCallable): string[] =>\n renderHandlerParameters(signal.parameters, (ref, nullable) => renderDocsType(library, ref, nullable));\n\nconst renderDocsSignalSignature = (library: Library, signal: GirCallable, selfType: string): string => {\n const params = [...renderDocsHandlerParameters(library, signal), `self: ${selfType}`];\n\n return `(${params.join(\", \")}) => ${renderDocsHandlerResultType(library, signal)}`;\n};\n\nconst renderDocsSignalHandlerType = (library: Library, signal: GirCallable): string =>\n `(${renderDocsHandlerParameters(library, signal).join(\", \")}) => ${renderDocsHandlerResultType(library, signal)}`;\n\nconst docsDefaultValue = (value: string): string => DOCS_DEFAULT_VALUES[value] ?? value;\n\nconst demoteLine = (line: string, isInFence: boolean): { text: string; isInFence: boolean } => {\n if (FENCE_LINE.test(line)) {\n return { text: line, isInFence: !isInFence };\n }\n\n if (isInFence) {\n return { text: line, isInFence };\n }\n\n return { text: HEADING_LINE.test(line) ? `#${line}` : line, isInFence };\n};\n\nconst demoteHeadings = (markdown: string): string => {\n let isInFence = false;\n const lines: string[] = [];\n\n for (const line of markdown.split(\"\\n\")) {\n const result = demoteLine(line, isInFence);\n isInFence = result.isInFence;\n lines.push(result.text);\n }\n\n return lines.join(\"\\n\");\n};\n\nconst docMarkdown = (doc: string | undefined): string =>\n doc === undefined || doc.length === 0 ? \"\" : demoteHeadings(stripDocMedia(gtkDocToMarkdown(doc))).trim();\n\nconst stripMarkdown = (markdown: string): string =>\n markdown\n .replaceAll(/```[\\s\\S]*?```/g, \" \")\n .replaceAll(/`([^`]*)`/g, \"$1\")\n .replaceAll(/\\[([^[\\]]*)\\]\\([^)]*\\)/g, \"$1\")\n .replaceAll(/[*#>]/g, \"\")\n .replaceAll(WHITESPACE_RUN, \" \")\n .trim();\n\nconst inlineMarkdown = (doc: string | undefined): string => docMarkdown(doc).replaceAll(WHITESPACE_RUN, \" \").trim();\nconst plainText = (doc: string | undefined): string => stripMarkdown(docMarkdown(doc));\n\nconst firstSentence = (doc: string | undefined): string => {\n const text = plainText(doc);\n\n if (text.length === 0) {\n return \"\";\n }\n\n const match = /^.*?[.!?](?=\\s|$)/.exec(text);\n const sentence = match?.[0] ?? text;\n\n return sentence.length > 220 ? `${sentence.slice(0, 217)}...` : sentence;\n};\n\nconst elementSlug = (className: string): string =>\n className\n .replaceAll(/([a-z0-9])([A-Z])/g, \"$1-$2\")\n .replaceAll(/([A-Z])(?=[A-Z][a-z])/g, \"$1-\")\n .toLowerCase();\n\nconst implementsLine = (names: string[]): string[] => {\n if (names.length === 0) {\n return [];\n }\n\n const quotedNames = names.map((name) => `\\`${name}\\``).join(\", \");\n\n return [`Implements ${quotedNames}.`];\n};\n\nconst joinSections = (sections: string[]): string =>\n `${sections.filter((section) => section.length > 0).join(\"\\n\\n\")}\\n`;\n\nconst paramNotes = (params: JsDocParam[] | undefined): string[] => {\n const entries = (params ?? [])\n .map((param) => ({ name: param.name, text: inlineMarkdown(param.doc) }))\n .filter((entry) => entry.text.length > 0);\n\n if (entries.length === 0) {\n return [];\n }\n\n const bullets = entries.map((entry) => `- \\`${entry.name}\\`: ${entry.text}`);\n\n return [[\"**Parameters**\", \"\", ...bullets].join(\"\\n\")];\n};\n\nconst labelledNote = (label: string, text: string): string[] => (text.length === 0 ? [] : [`${label} ${text}`]);\n\nconst deprecationNote = (deprecation: JsDocDeprecation | undefined): string[] => {\n if (deprecation === undefined) {\n return [];\n }\n\n const since = deprecation.since;\n const heading = since === undefined ? \"**Deprecated.**\" : `**Deprecated since ${since}.**`;\n const text = inlineMarkdown(deprecation.doc);\n const body = text.length === 0 ? heading : `${heading} ${text}`;\n\n return [`> ${body}`];\n};\n\nconst sinceNote = (since: string | undefined): string[] =>\n since === undefined || since.length === 0 ? [] : [`_Available since ${since}._`];\n\nconst tagNotes = (spec: JsDocSpec | undefined): string[] => {\n if (spec === undefined) {\n return [];\n }\n\n return [\n ...paramNotes(spec.params),\n ...labelledNote(\"**Returns**\", docMarkdown(spec.returns)),\n ...labelledNote(\"**Throws**\", inlineMarkdown(spec.throws)),\n ...deprecationNote(spec.deprecated),\n ...sinceNote(spec.since),\n ];\n};\n\nconst deprecationMeta = (annotations: GirAnnotations): string[] => {\n if (!annotations.isDeprecated) {\n return [];\n }\n\n const since = annotations.deprecatedSince;\n\n return [since === undefined ? \"deprecated\" : `deprecated since ${since}`];\n};\n\nconst annotationNotes = (annotations: GirAnnotations): string[] => tagNotes(annotationSpec(annotations));\n\nconst signalTags = (signal: GirCallable, isSelfIncluded: boolean): JsDocSpec =>\n isSelfIncluded ? selfHandlerSpec(signal) : handlerSpec(signal, signal.parameters);\n\nconst metaBlock = (entry: MetaDocEntry): string => {\n const lines = [`### \\`${entry.name}\\``, \"\", entry.meta];\n\n for (const note of [entry.doc, ...tagNotes(entry.tags)]) {\n if (note.length > 0) {\n lines.push(\"\", note);\n }\n }\n\n return lines.join(\"\\n\");\n};\n\nconst sortedMetaBlocks = (entries: MetaDocEntry[]): string[] =>\n sortStringsBy(entries, (item) => item.name).map((item) => metaBlock(item));\n\nconst propertyMetaLine = ({ type, property, accessNotes, origin }: PropertyMetaOptions): string => {\n const meta = [`\\`${type}\\``];\n\n if (property.defaultValue !== undefined) {\n meta.push(`default \\`${docsDefaultValue(property.defaultValue)}\\``);\n }\n\n if (property.constructOnly) {\n meta.push(\"construct-only\");\n }\n\n meta.push(...accessNotes, ...deprecationMeta(property.annotations));\n\n if (origin !== undefined) {\n meta.push(`from \\`${origin}\\``);\n }\n\n return meta.join(\" · \");\n};\n\nconst signatureBlock = (name: string, signature: string, notes: string[]): string => {\n const lines = [`### \\`${name}\\``, \"\", `\\`\\`\\`ts\\n${signature}\\n\\`\\`\\``];\n\n for (const note of notes) {\n if (note.length > 0) {\n lines.push(\"\", note);\n }\n }\n\n return lines.join(\"\\n\");\n};\n\nconst signatureEntryBlock = (entry: SignatureEntry, leadingNotes: string[] = []): string =>\n signatureBlock(entry.name, entry.signature, [...leadingNotes, entry.doc, ...tagNotes(entry.tags)]);\n\nconst namespaceOrder = (name: string): string => {\n const index = LEADING_NAMESPACES.indexOf(name);\n\n return index === -1 ? `1${name}` : `0${String(index)}`;\n};\n\nconst docsSignatureContext = (namespace: GirNamespace, library: Library): ModuleContext =>\n new ModuleContext({ ...namespace, name: DOCS_SIGNATURE_NAMESPACE }, library);\n\nconst originSignatureBlocks = (entries: OriginSignatureEntry[]): string[] =>\n sortStringsBy(entries, (item) => item.name).map((item) =>\n signatureEntryBlock(item, item.origin === undefined ? [] : [`From \\`${item.origin}\\`.`]),\n );\n\nconst qualifiedClassName = (namespaceName: string, className: string): string =>\n `${namespaceName}.${sanitizeTypeIdentifier(className)}`;\n\nconst classMethodEntries = (library: Library, namespace: GirNamespace, klass: GirClass): SignatureEntry[] => {\n const realContext = new ModuleContext(namespace, library);\n const signatureContext = docsSignatureContext(namespace, library);\n const className = sanitizeTypeIdentifier(klass.name);\n const inherited = collectInheritedMethods(realContext, klass);\n\n return instanceMethodEntries(signatureContext, klass, (method) =>\n conflictRename(realContext, method, inherited, className),\n );\n};\n\nconst methodsSectionBlocks = (entries: SignatureEntry[], intro: string): string[] =>\n entries.length === 0 ? [] : [\"## Methods\", intro, ...entries.map((item) => signatureEntryBlock(item))];\n\nconst instanceMethodEntries = (\n signatureContext: ModuleContext,\n klass: GirClass,\n rename: (fn: GirFunction) => string | undefined,\n): SignatureEntry[] => {\n const deduped = dedupeCallables(klass.methods);\n\n const scope = instanceScope(sanitizeTypeIdentifier(klass.name), {\n constructors: dedupeCallables(klass.constructors),\n functions: dedupeCallables(klass.functions),\n methods: deduped,\n });\n\n const entries: SignatureEntry[] = [];\n\n for (const method of deduped) {\n const nameOverride = rename(method);\n const rendered = renderInstanceMethodSignature(signatureContext, method, scope, nameOverride);\n\n if (rendered === undefined) {\n continue;\n }\n\n entries.push({\n name: nameOverride ?? methodExportName(method),\n signature: signatureText(rendered),\n doc: docMarkdown(method.doc),\n tags: instanceMemberSpec(signatureContext, method, scope),\n });\n }\n\n return sortStringsBy(entries, (entry) => entry.name);\n};\n\nconst signatureText = (rendered: string): string => {\n const start = rendered.startsWith(\"/**\") ? rendered.indexOf(\"*/\") + 2 : 0;\n\n return rendered.slice(start).trim().replace(/;$/, \"\");\n};\n\nexport {\n renderDocsType,\n renderDocsSignalSignature,\n renderDocsSignalHandlerType,\n annotationNotes,\n deprecationMeta,\n docMarkdown,\n firstSentence,\n elementSlug,\n implementsLine,\n joinSections,\n plainText,\n propertyMetaLine,\n signalTags,\n signatureBlock,\n signatureEntryBlock,\n sortedMetaBlocks,\n namespaceOrder,\n docsSignatureContext,\n originSignatureBlocks,\n classMethodEntries,\n methodsSectionBlocks,\n qualifiedClassName,\n tagNotes,\n type MetaDocEntry,\n type SignatureEntry,\n type OriginSignatureEntry,\n};\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"symbol-page.d.ts","sourceRoot":"","sources":["../../src/docs/symbol-page.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAc,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAMlD,OAAO,EAAsB,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAsB,MAAM,qBAAqB,CAAC;AAkD7G,gEAAgE;AAChE,KAAK,YAAY,GAAG;IAChB,0CAA0C;IAC1C,SAAS,EAAE,YAAY,CAAC;IACxB,kHAAkH;IAClH,IAAI,EAAE,MAAM,CAAC;IACb,gFAAgF;IAChF,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,mHAAmH;AACnH,KAAK,aAAa,GACZ,CAAC,YAAY,GAAG;IACd,yGAAyG;IACzG,IAAI,EAAE,OAAO,GAAG,WAAW,CAAC;IAC5B,mGAAmG;IACnG,KAAK,EAAE,QAAQ,CAAC;CACnB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,uEAAuE;IACvE,IAAI,EAAE,QAAQ,CAAC;IACf,+EAA+E;IAC/E,MAAM,EAAE,SAAS,CAAC;CACrB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,oGAAoG;IACpG,IAAI,EAAE,MAAM,CAAC;IACb,2FAA2F;IAC3F,WAAW,EAAE,OAAO,CAAC;CACxB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,qEAAqE;IACrE,IAAI,EAAE,UAAU,CAAC;IACjB,8EAA8E;IAC9E,QAAQ,EAAE,WAAW,CAAC;CACzB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,gEAAgE;IAChE,IAAI,EAAE,OAAO,CAAC;IACd,gDAAgD;IAChD,KAAK,EAAE,QAAQ,CAAC;CACnB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,sGAAsG;IACtG,IAAI,EAAE,UAAU,CAAC;IACjB,8EAA8E;IAC9E,EAAE,EAAE,WAAW,CAAC;CACnB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,2FAA2F;IAC3F,IAAI,EAAE,UAAU,CAAC;IACjB,mEAAmE;IACnE,QAAQ,EAAE,WAAW,CAAC;CACzB,CAAC,CAAC;AAKP,oEAAoE;AACpE,KAAK,iBAAiB,GAAG;IACrB,uFAAuF;IACvF,OAAO,EAAE,OAAO,CAAC;IACjB,yFAAyF;IACzF,cAAc,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;CACpF,CAAC;AAgaF,QAAA,MAAM,gBAAgB,GAAI,OAAO,aAAa,EAAE,SAAS,iBAAiB,KAAG,MAyB5E,CAAC;AA0KF,OAAO,EAAE,gBAAgB,EAAE,KAAK,aAAa,EAAE,KAAK,iBAAiB,EAAE,CAAC"}
1
+ {"version":3,"file":"symbol-page.d.ts","sourceRoot":"","sources":["../../src/docs/symbol-page.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAc,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAMlD,OAAO,EAAsB,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAsB,MAAM,qBAAqB,CAAC;AAmD7G,gEAAgE;AAChE,KAAK,YAAY,GAAG;IAChB,0CAA0C;IAC1C,SAAS,EAAE,YAAY,CAAC;IACxB,kHAAkH;IAClH,IAAI,EAAE,MAAM,CAAC;IACb,gFAAgF;IAChF,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,mHAAmH;AACnH,KAAK,aAAa,GACZ,CAAC,YAAY,GAAG;IACd,yGAAyG;IACzG,IAAI,EAAE,OAAO,GAAG,WAAW,CAAC;IAC5B,mGAAmG;IACnG,KAAK,EAAE,QAAQ,CAAC;CACnB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,uEAAuE;IACvE,IAAI,EAAE,QAAQ,CAAC;IACf,+EAA+E;IAC/E,MAAM,EAAE,SAAS,CAAC;CACrB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,oGAAoG;IACpG,IAAI,EAAE,MAAM,CAAC;IACb,2FAA2F;IAC3F,WAAW,EAAE,OAAO,CAAC;CACxB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,qEAAqE;IACrE,IAAI,EAAE,UAAU,CAAC;IACjB,8EAA8E;IAC9E,QAAQ,EAAE,WAAW,CAAC;CACzB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,gEAAgE;IAChE,IAAI,EAAE,OAAO,CAAC;IACd,gDAAgD;IAChD,KAAK,EAAE,QAAQ,CAAC;CACnB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,sGAAsG;IACtG,IAAI,EAAE,UAAU,CAAC;IACjB,8EAA8E;IAC9E,EAAE,EAAE,WAAW,CAAC;CACnB,CAAC,GACF,CAAC,YAAY,GAAG;IACZ,2FAA2F;IAC3F,IAAI,EAAE,UAAU,CAAC;IACjB,mEAAmE;IACnE,QAAQ,EAAE,WAAW,CAAC;CACzB,CAAC,CAAC;AAKP,oEAAoE;AACpE,KAAK,iBAAiB,GAAG;IACrB,uFAAuF;IACvF,OAAO,EAAE,OAAO,CAAC;IACjB,yFAAyF;IACzF,cAAc,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;CACpF,CAAC;AAoaF,QAAA,MAAM,gBAAgB,GAAI,OAAO,aAAa,EAAE,SAAS,iBAAiB,KAAG,MAyB5E,CAAC;AA0KF,OAAO,EAAE,gBAAgB,EAAE,KAAK,aAAa,EAAE,KAAK,iBAAiB,EAAE,CAAC"}
@@ -1,4 +1,4 @@
1
- import { pascalCase, sortStringsBy, upperFirst } from "@gtkx/utils";
1
+ import { sanitizeTypeIdentifier, sortStringsBy, upperFirst } from "@gtkx/utils";
2
2
  import { reservedSignalMemberRename } from "../analysis/inheritance.js";
3
3
  import { renderTsType } from "../analysis/ts-type.js";
4
4
  import { ancestorChain } from "../gir/ancestry.js";
@@ -16,7 +16,7 @@ import { resolveRecordFieldEntry } from "../store/gi/record-field-accessor.js";
16
16
  import { computeRecordFieldSlots } from "../store/gi/record-layout.js";
17
17
  import { vfuncEntries } from "../store/gi/vtable.js";
18
18
  import { implementedInterfaces, newlyImplementedInterfaces } from "../store/jsx/intrinsic-elements.js";
19
- import { annotationNotes, classMethodEntries, deprecationMeta, docMarkdown, docsSignatureContext, firstSentence, implementsLine, joinSections, methodsSectionBlocks, originSignatureBlocks, plainText, propertyMetaLine, renderDocsSignalHandlerType, renderDocsType, signalTags, signatureBlock, signatureEntryBlock, sortedMetaBlocks, tagNotes, } from "./render.js";
19
+ import { annotationNotes, classMethodEntries, deprecationMeta, docMarkdown, docsSignatureContext, firstSentence, implementsLine, joinSections, methodsSectionBlocks, originSignatureBlocks, plainText, propertyMetaLine, qualifiedClassName, renderDocsSignalHandlerType, renderDocsType, signalTags, signatureBlock, signatureEntryBlock, sortedMetaBlocks, tagNotes, } from "./render.js";
20
20
  const qualifiedName = (entry) => `${entry.namespace.name}.${entry.name}`;
21
21
  const pageTagNotes = (spec) => tagNotes({ ...spec, deprecated: undefined, since: undefined });
22
22
  const frontmatter = (entry, kindLabel) => {
@@ -60,7 +60,6 @@ const pageHeader = (entry, kindLabel) => [
60
60
  ...annotationNotes(entryAnnotations(entry)),
61
61
  importBlock(entry),
62
62
  ];
63
- const qualifiedClassName = (namespaceName, className) => `${namespaceName}.${pascalCase(className)}`;
64
63
  const elementNote = (entry, options) => {
65
64
  const glibName = options.elementNameFor(entry.namespace.name, entry.klass.name);
66
65
  if (glibName === undefined) {
@@ -164,7 +163,7 @@ const memberOwners = (entry, library) => [
164
163
  ];
165
164
  const interfaceMethodNames = (library, owner) => {
166
165
  const context = docsSignatureContext(owner.namespace, library);
167
- const className = pascalCase(owner.klass.name);
166
+ const className = sanitizeTypeIdentifier(owner.klass.name);
168
167
  const methods = dedupeCallables(owner.klass.methods);
169
168
  const scope = instanceScope(className, {
170
169
  constructors: dedupeCallables(owner.klass.constructors),
@@ -196,8 +195,12 @@ const getAccessNotes = (accessor) => {
196
195
  if (!accessor.isWritable) {
197
196
  return ["read-only"];
198
197
  }
199
- return accessor.hasGetter ? [] : ["write-only"];
198
+ if (!accessor.hasGetter) {
199
+ return ["write-only"];
200
+ }
201
+ return accessor.readType === accessor.writeType ? [] : [`writes \`${accessor.writeType}\``];
200
202
  };
203
+ const documentedAccessorType = (accessor) => accessor.hasGetter ? accessor.readType : accessor.writeType;
201
204
  const ownerPropertyEntries = (owner, setup, seen) => {
202
205
  const entries = [];
203
206
  for (const property of owner.klass.properties) {
@@ -214,7 +217,7 @@ const ownerPropertyEntries = (owner, setup, seen) => {
214
217
  entries.push({
215
218
  name: accessor.jsName,
216
219
  meta: propertyMetaLine({
217
- type: accessor.tsType,
220
+ type: documentedAccessorType(accessor),
218
221
  property,
219
222
  accessNotes: getAccessNotes(accessor),
220
223
  origin: owner.origin,