@aionbuilders/nabu 0.1.0-alpha.9 → 0.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 (319) hide show
  1. package/CHANGELOG.md +523 -0
  2. package/LICENSE +21 -0
  3. package/README.md +82 -144
  4. package/dist/behaviors/text/RichText.svelte +25 -2
  5. package/dist/behaviors/text/index.d.ts +2 -0
  6. package/dist/behaviors/text/index.js +2 -0
  7. package/dist/behaviors/text/markdown-shortcuts.extension.d.ts +5 -0
  8. package/dist/behaviors/text/markdown-shortcuts.extension.js +79 -0
  9. package/dist/behaviors/text/markdown-syntax.d.ts +42 -0
  10. package/dist/behaviors/text/markdown-syntax.js +81 -0
  11. package/dist/behaviors/text/rich-text.extension.d.ts +3 -0
  12. package/dist/behaviors/text/rich-text.extension.js +135 -53
  13. package/dist/behaviors/text/text.behavior.svelte.d.ts +217 -42
  14. package/dist/behaviors/text/text.behavior.svelte.js +657 -55
  15. package/dist/behaviors/text/typography.extension.d.ts +7 -0
  16. package/dist/behaviors/text/typography.extension.js +25 -0
  17. package/dist/blocks/Block.svelte +5 -2
  18. package/dist/blocks/BlockList.svelte +48 -0
  19. package/dist/blocks/BlockList.svelte.d.ts +17 -0
  20. package/dist/blocks/Nabu.svelte +180 -14
  21. package/dist/blocks/Nabu.svelte.d.ts +13 -0
  22. package/dist/blocks/block.extension.d.ts +3 -0
  23. package/dist/blocks/block.extension.js +8 -9
  24. package/dist/blocks/block.svelte.d.ts +356 -68
  25. package/dist/blocks/block.svelte.js +388 -42
  26. package/dist/blocks/blockquote/Blockquote.svelte +39 -0
  27. package/dist/blocks/blockquote/Blockquote.svelte.d.ts +11 -0
  28. package/dist/blocks/blockquote/blockquote.extension.d.ts +4 -0
  29. package/dist/blocks/blockquote/blockquote.extension.js +80 -0
  30. package/dist/blocks/blockquote/blockquote.svelte.d.ts +63 -0
  31. package/dist/blocks/blockquote/blockquote.svelte.js +136 -0
  32. package/dist/blocks/blockquote/index.d.ts +3 -0
  33. package/dist/blocks/blockquote/index.js +3 -0
  34. package/dist/blocks/callout/Callout.svelte +67 -0
  35. package/dist/blocks/callout/Callout.svelte.d.ts +11 -0
  36. package/dist/blocks/callout/callout.extension.d.ts +4 -0
  37. package/dist/blocks/callout/callout.extension.js +84 -0
  38. package/dist/blocks/callout/callout.svelte.d.ts +80 -0
  39. package/dist/blocks/callout/callout.svelte.js +189 -0
  40. package/dist/blocks/callout/index.d.ts +3 -0
  41. package/dist/blocks/callout/index.js +3 -0
  42. package/dist/blocks/chunks.d.ts +49 -0
  43. package/dist/blocks/chunks.js +90 -0
  44. package/dist/blocks/code/Code.svelte +84 -0
  45. package/dist/blocks/code/Code.svelte.d.ts +11 -0
  46. package/dist/blocks/code/code.extension.d.ts +4 -0
  47. package/dist/blocks/code/code.extension.js +88 -0
  48. package/dist/blocks/code/code.svelte.d.ts +68 -0
  49. package/dist/blocks/code/code.svelte.js +245 -0
  50. package/dist/blocks/code/index.d.ts +3 -0
  51. package/dist/blocks/code/index.js +3 -0
  52. package/dist/blocks/container.utils.d.ts +85 -13
  53. package/dist/blocks/container.utils.js +338 -178
  54. package/dist/blocks/dialogue/Dialogue.svelte +8 -2
  55. package/dist/blocks/dialogue/dialogue.svelte.d.ts +36 -23
  56. package/dist/blocks/dialogue/dialogue.svelte.js +51 -45
  57. package/dist/blocks/dialogue/hooks/onBeforeInput.hook.d.ts +2 -2
  58. package/dist/blocks/dialogue/hooks/onBeforeInput.hook.js +6 -4
  59. package/dist/blocks/dialogue/index.d.ts +12 -1
  60. package/dist/blocks/dialogue/index.js +51 -35
  61. package/dist/blocks/divider/Divider.svelte +28 -0
  62. package/dist/blocks/divider/Divider.svelte.d.ts +11 -0
  63. package/dist/blocks/divider/divider.extension.d.ts +23 -0
  64. package/dist/blocks/divider/divider.extension.js +153 -0
  65. package/dist/blocks/divider/divider.svelte.d.ts +54 -0
  66. package/dist/blocks/divider/divider.svelte.js +89 -0
  67. package/dist/blocks/divider/index.d.ts +3 -0
  68. package/dist/blocks/divider/index.js +3 -0
  69. package/dist/blocks/file/File.svelte +56 -0
  70. package/dist/blocks/file/File.svelte.d.ts +11 -0
  71. package/dist/blocks/file/file.extension.d.ts +4 -0
  72. package/dist/blocks/file/file.extension.js +27 -0
  73. package/dist/blocks/file/file.svelte.d.ts +29 -0
  74. package/dist/blocks/file/file.svelte.js +77 -0
  75. package/dist/blocks/file/index.d.ts +3 -0
  76. package/dist/blocks/file/index.js +3 -0
  77. package/dist/blocks/heading/Heading.svelte +2 -1
  78. package/dist/blocks/heading/heading.svelte.d.ts +27 -34
  79. package/dist/blocks/heading/heading.svelte.js +72 -60
  80. package/dist/blocks/heading/hooks/onBeforeInput.hook.js +7 -5
  81. package/dist/blocks/heading/index.d.ts +2 -2
  82. package/dist/blocks/heading/index.js +33 -8
  83. package/dist/blocks/image/Image.svelte +41 -0
  84. package/dist/blocks/image/Image.svelte.d.ts +11 -0
  85. package/dist/blocks/image/image.extension.d.ts +5 -0
  86. package/dist/blocks/image/image.extension.js +34 -0
  87. package/dist/blocks/image/image.svelte.d.ts +61 -0
  88. package/dist/blocks/image/image.svelte.js +114 -0
  89. package/dist/blocks/image/index.d.ts +3 -0
  90. package/dist/blocks/image/index.js +3 -0
  91. package/dist/blocks/index.d.ts +11 -1
  92. package/dist/blocks/index.js +11 -1
  93. package/dist/blocks/list/List.svelte +9 -2
  94. package/dist/blocks/list/ListItem.svelte +44 -7
  95. package/dist/blocks/list/convert.d.ts +20 -0
  96. package/dist/blocks/list/convert.js +92 -0
  97. package/dist/blocks/list/hooks/onBeforeInput.hook.js +60 -26
  98. package/dist/blocks/list/html-flat.d.ts +78 -0
  99. package/dist/blocks/list/html-flat.js +244 -0
  100. package/dist/blocks/list/indent.d.ts +86 -0
  101. package/dist/blocks/list/indent.js +205 -0
  102. package/dist/blocks/list/index.d.ts +7 -3
  103. package/dist/blocks/list/index.js +43 -31
  104. package/dist/blocks/list/list-item.svelte.d.ts +43 -17
  105. package/dist/blocks/list/list-item.svelte.js +143 -93
  106. package/dist/blocks/list/list.behavior.svelte.d.ts +7 -4
  107. package/dist/blocks/list/list.behavior.svelte.js +10 -5
  108. package/dist/blocks/list/list.svelte.d.ts +101 -23
  109. package/dist/blocks/list/list.svelte.js +136 -114
  110. package/dist/blocks/list/markdown.d.ts +149 -0
  111. package/dist/blocks/list/markdown.js +442 -0
  112. package/dist/blocks/list/normalize.d.ts +11 -0
  113. package/dist/blocks/list/normalize.js +396 -0
  114. package/dist/blocks/list/paste.d.ts +45 -0
  115. package/dist/blocks/list/paste.js +242 -0
  116. package/dist/blocks/list/step-back.d.ts +24 -0
  117. package/dist/blocks/list/step-back.js +87 -0
  118. package/dist/blocks/list/to-list.d.ts +7 -0
  119. package/dist/blocks/list/to-list.js +44 -0
  120. package/dist/blocks/list/todos-toggle.d.ts +20 -0
  121. package/dist/blocks/list/todos-toggle.js +48 -0
  122. package/dist/blocks/list/todos.svelte.d.ts +35 -0
  123. package/dist/blocks/list/todos.svelte.js +76 -0
  124. package/dist/blocks/media/index.d.ts +2 -0
  125. package/dist/blocks/media/index.js +2 -0
  126. package/dist/blocks/media/markdown.d.ts +12 -0
  127. package/dist/blocks/media/markdown.js +26 -0
  128. package/dist/blocks/media/media-block.svelte.d.ts +107 -0
  129. package/dist/blocks/media/media-block.svelte.js +181 -0
  130. package/dist/blocks/media/media.helpers.d.ts +24 -0
  131. package/dist/blocks/media/media.helpers.js +88 -0
  132. package/dist/blocks/megablock.svelte.d.ts +50 -19
  133. package/dist/blocks/megablock.svelte.js +115 -74
  134. package/dist/blocks/move.d.ts +23 -0
  135. package/dist/blocks/move.js +92 -0
  136. package/dist/blocks/nabu.svelte.d.ts +846 -75
  137. package/dist/blocks/nabu.svelte.js +1990 -182
  138. package/dist/blocks/paragraph/Paragraph.svelte +1 -0
  139. package/dist/blocks/paragraph/index.d.ts +2 -2
  140. package/dist/blocks/paragraph/index.js +35 -16
  141. package/dist/blocks/paragraph/paragraph.svelte.d.ts +49 -35
  142. package/dist/blocks/paragraph/paragraph.svelte.js +81 -69
  143. package/dist/blocks/paragraph/table.html.d.ts +9 -0
  144. package/dist/blocks/paragraph/table.html.js +111 -0
  145. package/dist/blocks/paragraph/table.markdown.d.ts +32 -0
  146. package/dist/blocks/paragraph/table.markdown.js +90 -0
  147. package/dist/blocks/region/Region.svelte +264 -0
  148. package/dist/blocks/region/Region.svelte.d.ts +11 -0
  149. package/dist/blocks/region/actions.d.ts +135 -0
  150. package/dist/blocks/region/actions.js +402 -0
  151. package/dist/blocks/region/close.d.ts +35 -0
  152. package/dist/blocks/region/close.js +130 -0
  153. package/dist/blocks/region/commands.d.ts +6 -0
  154. package/dist/blocks/region/commands.js +277 -0
  155. package/dist/blocks/region/create.d.ts +72 -0
  156. package/dist/blocks/region/create.js +208 -0
  157. package/dist/blocks/region/end-marker.d.ts +35 -0
  158. package/dist/blocks/region/end-marker.js +51 -0
  159. package/dist/blocks/region/facts.d.ts +69 -0
  160. package/dist/blocks/region/facts.js +152 -0
  161. package/dist/blocks/region/format.d.ts +91 -0
  162. package/dist/blocks/region/format.js +260 -0
  163. package/dist/blocks/region/index.d.ts +14 -0
  164. package/dist/blocks/region/index.js +14 -0
  165. package/dist/blocks/region/insert.d.ts +59 -0
  166. package/dist/blocks/region/insert.js +102 -0
  167. package/dist/blocks/region/messages.d.ts +254 -0
  168. package/dist/blocks/region/messages.js +131 -0
  169. package/dist/blocks/region/normalize.d.ts +7 -0
  170. package/dist/blocks/region/normalize.js +170 -0
  171. package/dist/blocks/region/region.extension.d.ts +58 -0
  172. package/dist/blocks/region/region.extension.js +119 -0
  173. package/dist/blocks/region/region.svelte.d.ts +221 -0
  174. package/dist/blocks/region/region.svelte.js +582 -0
  175. package/dist/blocks/region/regions.svelte.d.ts +141 -0
  176. package/dist/blocks/region/regions.svelte.js +276 -0
  177. package/dist/blocks/region/serialize.d.ts +57 -0
  178. package/dist/blocks/region/serialize.js +112 -0
  179. package/dist/blocks/region/types.d.ts +255 -0
  180. package/dist/blocks/region/types.js +204 -0
  181. package/dist/blocks/selection.svelte.d.ts +106 -8
  182. package/dist/blocks/selection.svelte.js +632 -74
  183. package/dist/blocks/subthread.d.ts +80 -0
  184. package/dist/blocks/subthread.js +167 -0
  185. package/dist/blocks/text-block.svelte.d.ts +70 -0
  186. package/dist/blocks/text-block.svelte.js +108 -0
  187. package/dist/blocks/toggle/Toggle.svelte +73 -0
  188. package/dist/blocks/toggle/Toggle.svelte.d.ts +11 -0
  189. package/dist/blocks/toggle/index.d.ts +3 -0
  190. package/dist/blocks/toggle/index.js +3 -0
  191. package/dist/blocks/toggle/markdown.d.ts +20 -0
  192. package/dist/blocks/toggle/markdown.js +112 -0
  193. package/dist/blocks/toggle/toggle.extension.d.ts +4 -0
  194. package/dist/blocks/toggle/toggle.extension.js +18 -0
  195. package/dist/blocks/toggle/toggle.svelte.d.ts +135 -0
  196. package/dist/blocks/toggle/toggle.svelte.js +352 -0
  197. package/dist/blocks/undo-selection.d.ts +175 -0
  198. package/dist/blocks/undo-selection.js +360 -0
  199. package/dist/blocks/video/Video.svelte +42 -0
  200. package/dist/blocks/video/Video.svelte.d.ts +11 -0
  201. package/dist/blocks/video/index.d.ts +3 -0
  202. package/dist/blocks/video/index.js +3 -0
  203. package/dist/blocks/video/video.extension.d.ts +4 -0
  204. package/dist/blocks/video/video.extension.js +27 -0
  205. package/dist/blocks/video/video.svelte.d.ts +29 -0
  206. package/dist/blocks/video/video.svelte.js +80 -0
  207. package/dist/extend.d.ts +55 -0
  208. package/dist/extend.js +88 -0
  209. package/dist/files/assets.clipboard.d.ts +77 -0
  210. package/dist/files/assets.clipboard.js +152 -0
  211. package/dist/files/files.svelte.d.ts +363 -0
  212. package/dist/files/files.svelte.js +897 -0
  213. package/dist/files/index.d.ts +3 -0
  214. package/dist/files/index.js +3 -0
  215. package/dist/files/outbox.d.ts +69 -0
  216. package/dist/files/outbox.js +48 -0
  217. package/dist/files/status.d.ts +65 -0
  218. package/dist/files/status.js +87 -0
  219. package/dist/files/store.d.ts +97 -0
  220. package/dist/files/store.js +65 -0
  221. package/dist/files/uploads.svelte.d.ts +174 -0
  222. package/dist/files/uploads.svelte.js +504 -0
  223. package/dist/index.d.ts +68 -6
  224. package/dist/index.js +117 -7
  225. package/dist/nabu-theme.css +112 -0
  226. package/dist/paste/html.paste.d.ts +74 -3
  227. package/dist/paste/html.paste.js +555 -83
  228. package/dist/paste/markdown-inline.d.ts +86 -0
  229. package/dist/paste/markdown-inline.js +528 -0
  230. package/dist/paste/markdown.paste.d.ts +2 -8
  231. package/dist/paste/markdown.paste.js +78 -94
  232. package/dist/paste/nabu.paste.d.ts +3 -0
  233. package/dist/paste/nabu.paste.js +29 -3
  234. package/dist/paste/plain-text.paste.d.ts +2 -2
  235. package/dist/paste/plain-text.paste.js +3 -3
  236. package/dist/persistence/asset-store.d.ts +51 -0
  237. package/dist/persistence/asset-store.js +103 -0
  238. package/dist/persistence/autosave.d.ts +53 -0
  239. package/dist/persistence/autosave.js +62 -0
  240. package/dist/persistence/compact.d.ts +162 -0
  241. package/dist/persistence/compact.js +141 -0
  242. package/dist/persistence/history.d.ts +77 -0
  243. package/dist/persistence/history.js +176 -0
  244. package/dist/persistence/indexeddb.d.ts +190 -4
  245. package/dist/persistence/indexeddb.js +333 -29
  246. package/dist/persistence/merge.d.ts +38 -0
  247. package/dist/persistence/merge.js +36 -0
  248. package/dist/persistence/outbox.d.ts +25 -0
  249. package/dist/persistence/outbox.js +40 -0
  250. package/dist/persistence/persistence.d.ts +70 -9
  251. package/dist/persistence/persistence.js +507 -35
  252. package/dist/persistence/recovery.d.ts +79 -0
  253. package/dist/persistence/recovery.js +79 -0
  254. package/dist/persistence/release.d.ts +34 -0
  255. package/dist/persistence/release.js +64 -0
  256. package/dist/persistence/state.svelte.d.ts +53 -0
  257. package/dist/persistence/state.svelte.js +48 -0
  258. package/dist/persistence/sync.d.ts +39 -0
  259. package/dist/persistence/sync.js +138 -0
  260. package/dist/persistence/tail.d.ts +42 -0
  261. package/dist/persistence/tail.js +103 -0
  262. package/dist/presets.d.ts +29 -24
  263. package/dist/presets.js +51 -14
  264. package/dist/themes/atelier.css +318 -0
  265. package/dist/ui/CommandChooser.svelte +153 -0
  266. package/dist/ui/CommandChooser.svelte.d.ts +13 -0
  267. package/dist/ui/CommandInvite.svelte +99 -0
  268. package/dist/ui/CommandInvite.svelte.d.ts +12 -0
  269. package/dist/ui/DragHandle.svelte +217 -0
  270. package/dist/ui/DragHandle.svelte.d.ts +11 -0
  271. package/dist/ui/FloatingToolbar.svelte +165 -0
  272. package/dist/ui/FloatingToolbar.svelte.d.ts +27 -0
  273. package/dist/ui/SlashMenu.svelte +215 -0
  274. package/dist/ui/SlashMenu.svelte.d.ts +33 -0
  275. package/dist/ui/anchor.d.ts +112 -0
  276. package/dist/ui/anchor.js +136 -0
  277. package/dist/ui/index.d.ts +10 -0
  278. package/dist/ui/index.js +15 -0
  279. package/dist/ui/slash-menu.svelte.d.ts +112 -0
  280. package/dist/ui/slash-menu.svelte.js +150 -0
  281. package/dist/utils/command-confirm.svelte.d.ts +349 -0
  282. package/dist/utils/command-confirm.svelte.js +673 -0
  283. package/dist/utils/commands.d.ts +328 -0
  284. package/dist/utils/commands.js +416 -0
  285. package/dist/utils/dom-scope.d.ts +14 -0
  286. package/dist/utils/dom-scope.js +20 -0
  287. package/dist/utils/drop.d.ts +160 -0
  288. package/dist/utils/drop.js +305 -0
  289. package/dist/utils/extensions.d.ts +488 -40
  290. package/dist/utils/extensions.js +300 -19
  291. package/dist/utils/html.d.ts +44 -0
  292. package/dist/utils/html.js +183 -0
  293. package/dist/utils/index.d.ts +4 -0
  294. package/dist/utils/index.js +4 -0
  295. package/dist/utils/keys.d.ts +120 -0
  296. package/dist/utils/keys.js +248 -0
  297. package/dist/utils/links.d.ts +22 -0
  298. package/dist/utils/links.js +34 -0
  299. package/dist/utils/placeholders.d.ts +88 -0
  300. package/dist/utils/placeholders.js +91 -0
  301. package/dist/utils/selection.svelte.d.ts +47 -19
  302. package/dist/utils/selection.svelte.js +60 -10
  303. package/dist/utils/spellcheck.d.ts +9 -0
  304. package/dist/utils/spellcheck.js +17 -0
  305. package/dist/utils/tab.d.ts +31 -0
  306. package/dist/utils/tab.js +117 -0
  307. package/dist/utils/words.d.ts +7 -0
  308. package/dist/utils/words.js +62 -0
  309. package/dist/vite.d.ts +22 -0
  310. package/dist/vite.js +34 -0
  311. package/package.json +61 -22
  312. package/dist/blocks/zone/Zone.svelte +0 -258
  313. package/dist/blocks/zone/Zone.svelte.d.ts +0 -11
  314. package/dist/blocks/zone/index.d.ts +0 -2
  315. package/dist/blocks/zone/index.js +0 -2
  316. package/dist/blocks/zone/zone.extension.d.ts +0 -2
  317. package/dist/blocks/zone/zone.extension.js +0 -221
  318. package/dist/blocks/zone/zone.svelte.d.ts +0 -112
  319. package/dist/blocks/zone/zone.svelte.js +0 -321
@@ -1,59 +1,252 @@
1
+ /**
2
+ * The base class of every block. A block wraps a node of the document tree (Loro) and holds the behaviour of one block type: the capability flags, the tree accessors, and the handlers for typing, keys, splitting, merging, pasting and serialization that a subclass overrides.
3
+ */
1
4
  export class Block {
2
- /** @param {Nabu} nabu @param {NabuNode} node */
3
- static load(nabu: Nabu, node: NabuNode): Block;
4
- /** @param {Nabu} nabu @param {string} type @param {Object} [props={}] @param {string|null} [parentId=null] @param {number|null} [index=null] */
5
- static create(nabu: Nabu, type: string, props?: Object, parentId?: string | null, index?: number | null): Block;
5
+ /**
6
+ * @param {Nabu} nabu
7
+ * @param {NabuNode} node
8
+ * @public
9
+ */
10
+ public static load(nabu: Nabu, node: NabuNode): Block;
11
+ /**
12
+ * @param {Nabu} nabu
13
+ * @param {string} type
14
+ * @param {Record<string, any>} [props={}]
15
+ * @param {string|null} [parentId=null]
16
+ * @param {number|null} [index=null]
17
+ * @public
18
+ */
19
+ public static create(nabu: Nabu, type: string, props?: Record<string, any>, parentId?: string | null, index?: number | null): Block;
20
+ /**
21
+ * Which HTML elements this block reads on paste (see {@link HtmlRule}). Declare it together with `fromHTML`.
22
+ * @type {import('../utils/extensions.js').HtmlRule[] | undefined}
23
+ * @public
24
+ */
25
+ public static htmlRules: import("../utils/extensions.js").HtmlRule[] | undefined;
26
+ /**
27
+ * Make the block(s) of an element matched by one of `htmlRules`; `null` / `[]` declines. `siblings` are the following
28
+ * elements `htmlSiblings` claimed.
29
+ * @type {((el: Element, helpers: import('../utils/extensions.js').HtmlHelpers, rule: import('../utils/extensions.js').HtmlRule, siblings: Element[]) => import('../utils/extensions.js').PasteBlock | import('../utils/extensions.js').PasteBlock[] | null) | undefined}
30
+ * @public
31
+ */
32
+ public static fromHTML: ((el: Element, helpers: import("../utils/extensions.js").HtmlHelpers, rule: import("../utils/extensions.js").HtmlRule, siblings: Element[]) => import("../utils/extensions.js").PasteBlock | import("../utils/extensions.js").PasteBlock[] | null) | undefined;
33
+ /**
34
+ * Ask to absorb the elements that follow `el` (a structure that spans several elements, a list in Google Docs); returns them in order.
35
+ * @type {((el: Element, rule: import('../utils/extensions.js').HtmlRule, helpers: import('../utils/extensions.js').HtmlHelpers) => Element[]) | undefined}
36
+ * @public
37
+ */
38
+ public static htmlSiblings: ((el: Element, rule: import("../utils/extensions.js").HtmlRule, helpers: import("../utils/extensions.js").HtmlHelpers) => Element[]) | undefined;
39
+ /**
40
+ * How this block starts and how many lines it takes in markdown (see {@link MarkdownRule}). Declare it together with `fromMarkdown`.
41
+ * @type {import('../utils/extensions.js').MarkdownRule[] | undefined}
42
+ * @public
43
+ */
44
+ public static markdownRules: import("../utils/extensions.js").MarkdownRule[] | undefined;
45
+ /**
46
+ * Make the block(s) of the lines a `markdownRules` rule consumed; `null` declines (the next rule is tried).
47
+ * @type {((lines: string[], helpers: import('../utils/extensions.js').MarkdownHelpers, rule: import('../utils/extensions.js').MarkdownRule) => import('../utils/extensions.js').PasteBlock | import('../utils/extensions.js').PasteBlock[] | null) | undefined}
48
+ * @public
49
+ */
50
+ public static fromMarkdown: ((lines: string[], helpers: import("../utils/extensions.js").MarkdownHelpers, rule: import("../utils/extensions.js").MarkdownRule) => import("../utils/extensions.js").PasteBlock | import("../utils/extensions.js").PasteBlock[] | null) | undefined;
51
+ /**
52
+ * The markdown of a block of this type, for the clipboard's `text/plain` and for containers that serialize their children.
53
+ * @type {((pb: import('../utils/extensions.js').PasteBlock, ctx: import('../utils/extensions.js').SerializeContext) => string) | undefined}
54
+ * @public
55
+ */
56
+ public static toMarkdown: ((pb: import("../utils/extensions.js").PasteBlock, ctx: import("../utils/extensions.js").SerializeContext) => string) | undefined;
57
+ /**
58
+ * The HTML of a block of this type, for the clipboard's `text/html`.
59
+ * @type {((pb: import('../utils/extensions.js').PasteBlock, ctx: import('../utils/extensions.js').SerializeContext) => string) | undefined}
60
+ * @public
61
+ */
62
+ public static toHtml: ((pb: import("../utils/extensions.js").PasteBlock, ctx: import("../utils/extensions.js").SerializeContext) => string) | undefined;
6
63
  /** @param {Nabu} nabu @param {NabuNode} node */
7
64
  constructor(nabu: Nabu, node: NabuNode);
8
- nabu: Nabu;
9
- node: NabuNode;
10
- id: string;
11
- type: string;
12
- /** @type {MegaBlock | null} */
13
- parent: MegaBlock | null;
14
- /** @type {SvelteMap<string, function(any): void>} */
15
- serializers: SvelteMap<string, (arg0: any) => void>;
16
- behaviors: SvelteMap<any, any>;
17
- selected: boolean;
18
- isSelectionStart: boolean;
19
- isSelectionEnd: boolean;
20
- isIntermediate: boolean;
21
- clearSelection(): void;
22
- /** @type {{from: number, to: number, direction: "forward" | "backward" | "none"} | null} */
23
- selection: {
65
+ /**
66
+ * The editor this block belongs to.
67
+ * @type {Nabu}
68
+ * @public
69
+ */
70
+ public nabu: Nabu;
71
+ /**
72
+ * The block's node in the document tree (Loro): `node.data` holds its `type` and props, `node.parent()` / `node.children()` the structure.
73
+ * @type {NabuNode}
74
+ * @public
75
+ */
76
+ public node: NabuNode;
77
+ /**
78
+ * The Loro tree id of the node (also the key in `nabu.blocks`).
79
+ * @type {import('loro-crdt').TreeID}
80
+ * @public
81
+ */
82
+ public id: import("loro-crdt").TreeID;
83
+ /**
84
+ * The block type, as registered by its extension (`'paragraph'`, `'callout'`...). Read from the node when the block is built; `retype()` changes the node, and the engine builds a new block.
85
+ * @type {string}
86
+ * @public
87
+ */
88
+ public type: string;
89
+ /**
90
+ * @type {MegaBlock | null}
91
+ * @public
92
+ */
93
+ public parent: MegaBlock | null;
94
+ /**
95
+ * Serializers of this block by format: `'markdown'`, `'json'`, `'application/x-nabu+json'` (the clipboard) or one of your own.
96
+ * Each receives the context of the call (`{ from, to, partial }` for the clipboard) and returns the serialized block.
97
+ * @type {SvelteMap<string, function(any): any>}
98
+ * @public
99
+ */
100
+ public serializers: SvelteMap<string, (arg0: any) => any>;
101
+ /**
102
+ * The behaviors of the block by name; a text block has `'text'` (a `TextBehavior`).
103
+ * @type {SvelteMap<string, any>}
104
+ * @public
105
+ */
106
+ public behaviors: SvelteMap<string, any>;
107
+ /** The selection covers this block (reactive). @public */
108
+ public selected: boolean;
109
+ /** The selection starts in this block (reactive). @public */
110
+ public isSelectionStart: boolean;
111
+ /** The selection ends in this block (reactive). @public */
112
+ public isSelectionEnd: boolean;
113
+ /** The selection covers this block and neither starts nor ends in it (reactive). @public */
114
+ public isIntermediate: boolean;
115
+ /** @public */
116
+ public clearSelection(): void;
117
+ /**
118
+ * @type {{from: number, to: number, direction: "forward" | "backward" | "none"} | null}
119
+ * @public
120
+ */
121
+ public selection: {
24
122
  from: number;
25
123
  to: number;
26
124
  direction: "forward" | "backward" | "none";
27
125
  } | null;
28
- positions: number;
126
+ /** @public */
127
+ public positions: number;
128
+ /**
129
+ * Number of words contained in this block. Overridden by text blocks
130
+ * (own text) and containers (sum of children) so that parents can
131
+ * aggregate without re-traversing the whole subtree.
132
+ * @type {number}
133
+ * @public
134
+ */
135
+ public wordCount: number;
136
+ /**
137
+ * When false, Enter inserts a literal "\n" in place instead of splitting the block.
138
+ * @type {boolean}
139
+ * @public
140
+ */
141
+ public splitsOnEnter: boolean;
142
+ /**
143
+ * When false, onBeforeInput markdown-shortcut hooks and inputRules are skipped in this block.
144
+ * @type {boolean}
145
+ * @public
146
+ */
147
+ public transformsEnabled: boolean;
148
+ /**
149
+ * When false, inline marks (bold/italic/...) are never applied to this block.
150
+ * @type {boolean}
151
+ * @public
152
+ */
153
+ public marksEnabled: boolean;
154
+ /**
155
+ * True when the block currently hides its children (they are not rendered, e.g. a collapsed
156
+ * foldable block): navigation (`findForward` / `findBackward` / `findLastDescendant`, caret
157
+ * normalisation) never enters them. Override with a getter in a subclass.
158
+ * @type {boolean}
159
+ * @public
160
+ */
161
+ public get hidesChildren(): boolean;
162
+ /**
163
+ * When true, the text of this block is an ISOLATED FIELD (like a form input embedded in the document): a text selection
164
+ * that does not lie entirely inside this block never touches its text. For such a selection (the engine's rules, see
165
+ * `container.utils.js`, `selection.svelte.js`):
166
+ * - range deletion, typing over it, cut and the marks skip the text of this block, and delete neither this block nor its
167
+ * container; the clipboard gets the TEXT blocks only (the block's own text and its container are not copied);
168
+ * - two text blocks on either side of an isolated block, or in different "isolation owners" (the nearest ancestor that
169
+ * isolates), never merge, so a deletion across them clears both sides without joining them;
170
+ * - the block is not highlighted (`data-nabu-isolated` + the root's `data-nabu-range`), and a selection end that would
171
+ * land in it is moved past it, in the direction of travel; a selection that STARTS in it stays bounded to it;
172
+ * - the caret enters it at its start going down / right, at its end going up / left; Select All inside it selects its text.
173
+ * @type {boolean}
174
+ * @public
175
+ */
176
+ public isolatesSelection: boolean;
177
+ /**
178
+ * When true, pasting inside this block inserts the clipboard's text/plain verbatim (replacing the selection), skipping every paste interpreter: no blocks created, no markdown/HTML interpretation.
179
+ * @type {boolean}
180
+ * @public
181
+ */
182
+ public pastesAsPlainText: boolean;
29
183
  /**
30
184
  * Resolve a document-local offset to { block, offset } within this block.
31
185
  * Leaf blocks with text return themselves directly.
32
186
  * Override in MegaBlock (pure containers) and mixed blocks (e.g. ListItem).
33
187
  * @param {number} localOffset
34
188
  * @returns {{ block: Block, offset: number } | null}
189
+ * @public
35
190
  */
36
- resolveOffset(localOffset: number): {
191
+ public resolveOffset(localOffset: number): {
37
192
  block: Block;
38
193
  offset: number;
39
194
  } | null;
40
- index: number;
41
- /** @type {Block?} */
42
- previous: Block | null;
43
- /** @type {Block?} */
44
- next: Block | null;
45
- parents: MegaBlock[];
46
- component: import("svelte").Component<any, any, string> | null;
47
- /** @type {HTMLElement | null} */
48
- element: HTMLElement | null;
49
- /** @param {(block: Block) => boolean} predicate @returns {Block | null} */
50
- findForward(predicate: (block: Block) => boolean): Block | null;
51
- /** @param {(block: Block) => boolean} predicate @returns {Block | null} */
52
- findBackward(predicate: (block: Block) => boolean): Block | null;
195
+ /** @public */
196
+ public index: number;
197
+ /**
198
+ * @type {Block?}
199
+ * @public
200
+ */
201
+ public previous: Block | null;
202
+ /**
203
+ * @type {Block?}
204
+ * @public
205
+ */
206
+ public next: Block | null;
207
+ /** @public */
208
+ public parents: MegaBlock[];
209
+ /** @public */
210
+ public component: import("svelte").Component<any, any, string> | null;
211
+ /**
212
+ * Resolved placeholder to render in `data-placeholder` ('' = none). Combines the
213
+ * Nabu `placeholders` option, the block's emptiness and — with `show: 'focus'`
214
+ * (default) — whether it holds the collapsed cursor.
215
+ *
216
+ * The default text is declared by each block class as `static placeholder`
217
+ * (string, `false`, or `(block) => string | false`), overridable per type through
218
+ * the `placeholders.text` option. Blocks without a text behavior never show one.
219
+ * (No `static placeholder` is declared here: Svelte forbids a static and a
220
+ * reactive field with the same name in one class.)
221
+ * @type {string}
222
+ * @public
223
+ */
224
+ public placeholder: string;
225
+ /**
226
+ * @type {HTMLElement | null}
227
+ * @public
228
+ */
229
+ public element: HTMLElement | null;
230
+ /**
231
+ * The next block in document order (own descendants first, then the following siblings with their descendants, then
232
+ * those of each ancestor) that satisfies `predicate`, or null. A block that hides its children is not entered.
233
+ * LINEAR: every block is visited at most once (the following siblings are only DESCENDED into, never searched
234
+ * "forward" again, which would revisit everything after them).
235
+ * @param {(block: Block) => boolean} predicate @returns {Block | null}
236
+ * @public
237
+ */
238
+ public findForward(predicate: (block: Block) => boolean): Block | null;
239
+ /**
240
+ * @param {(block: Block) => boolean} predicate
241
+ * @returns {Block | null}
242
+ * @public
243
+ */
244
+ public findBackward(predicate: (block: Block) => boolean): Block | null;
53
245
  /**
54
246
  * Returns real, uncommitted siblings, which is useful for extensions that want to check the document structure before the transaction is committed.
247
+ * @public
55
248
  */
56
- getAdjacentSiblings(): {
249
+ public getAdjacentSiblings(): {
57
250
  previous: null;
58
251
  next: null;
59
252
  previousNode?: undefined;
@@ -61,58 +254,130 @@ export class Block {
61
254
  } | {
62
255
  previous: Block | null | undefined;
63
256
  next: Block | null | undefined;
64
- previousNode: import("loro-crdt").LoroTreeNode<Record<string, unknown>> | import("loro-crdt").LoroTreeNode<{
257
+ previousNode: import("loro-crdt").LoroTreeNode<{
65
258
  type: string;
66
- }> | null;
67
- nextNode: import("loro-crdt").LoroTreeNode<Record<string, unknown>> | import("loro-crdt").LoroTreeNode<{
259
+ } & Record<string, any>> | import("loro-crdt").LoroTreeNode<Record<string, unknown>> | null;
260
+ nextNode: import("loro-crdt").LoroTreeNode<{
68
261
  type: string;
69
- }> | null;
262
+ } & Record<string, any>> | import("loro-crdt").LoroTreeNode<Record<string, unknown>> | null;
70
263
  };
71
264
  /**
72
265
  * Helper pour trouver le dernier descendant profond qui matche
73
266
  * @param {(block: Block) => boolean} predicate
74
267
  * @returns {Block | null}
268
+ * @public
75
269
  */
76
- findLastDescendant(predicate: (block: Block) => boolean): Block | null;
77
- destroy(): void;
270
+ public findLastDescendant(predicate: (block: Block) => boolean): Block | null;
271
+ /** @public */
272
+ public destroy(): void;
78
273
  /**
79
274
  * Transforme ce bloc en un autre type de bloc.
80
275
  * @param {string} newType
81
- * @param {Object} [props={}]
276
+ * @param {Record<string, any>} [props={}]
277
+ * @public
278
+ */
279
+ public transformTo(newType: string, props?: Record<string, any>): void;
280
+ /**
281
+ * The mutations of a type change, without the commit: the caller owns the transaction
282
+ * (`transformTo`, the `block:transform` action…). By default the block is retyped IN PLACE (same node:
283
+ * its id, text and position survive). Override it when a block cannot simply change type where it
284
+ * stands (e.g. because its parent only accepts some children): do the same job with Loro mutations only.
285
+ * @param {string} newType
286
+ * @param {Record<string, any>} [props={}]
287
+ * @public
82
288
  */
83
- transformTo(newType: string, props?: Object): void;
84
- /** @param {number} index @param {string} text */
85
- insert(index: number, text: string): void;
86
- /** @param {{from?: number, to?: number, index?: number, length?: number}} [deletion] */
87
- delete(deletion?: {
289
+ public retype(newType: string, props?: Record<string, any>): void;
290
+ /**
291
+ * @param {number} index
292
+ * @param {string} text
293
+ * @public
294
+ */
295
+ public insert(index: number, text: string): void;
296
+ /**
297
+ * @param {{from?: number, to?: number, index?: number, length?: number}} [deletion]
298
+ * @public
299
+ */
300
+ public delete(deletion?: {
88
301
  from?: number;
89
302
  to?: number;
90
303
  index?: number;
91
304
  length?: number;
92
305
  }): void;
93
- /** @param {Block} block @returns {any} */
94
- absorbs(block: Block): any;
95
- /** @param {Block} block @returns {any} */
96
- mergeWith(block: Block): any;
306
+ /**
307
+ * @param {Block} block
308
+ * @returns {any}
309
+ * @public
310
+ */
311
+ public absorbs(block: Block): any;
312
+ /**
313
+ * @param {Block} block
314
+ * @returns {any}
315
+ * @public
316
+ */
317
+ public mergeWith(block: Block): any;
97
318
  /**
98
319
  * Consumes another block, handling children relocation intelligently.
99
320
  * @param {Block} otherBlock - The block to consume or be consumed by
100
321
  * @param {'into' | 'from'} direction - 'into' = this merges into other, 'from' = other merges into this
101
322
  * @returns {Block} The surviving block
323
+ * @public
102
324
  */
103
- consume(otherBlock: Block, direction?: "into" | "from"): Block;
325
+ public consume(otherBlock: Block, direction?: "into" | "from"): Block;
104
326
  /**
105
327
  * Declares a required parent type for structural integrity.
106
328
  * Override in subclasses (e.g. ListItem requires a "list" parent).
107
329
  * Used by wrapOrphan() after block relocations.
108
330
  * @returns {{ type: string, props: () => Record<string, any> } | null}
331
+ * @public
109
332
  */
110
- get requiredParent(): {
333
+ public get requiredParent(): {
111
334
  type: string;
112
335
  props: () => Record<string, any>;
113
336
  } | null;
114
- /** @param {{from?: number, to?: number, index?: number, length?: number, offset?: number}} options @returns {{block: Block} | null} */
115
- split(options: {
337
+ /**
338
+ * Whether an EMPTY child of this block takes the type of a whole block pasted into it (a `# Title` pasted
339
+ * into an empty paragraph makes it a heading). Always true for root blocks; a container with structural
340
+ * rules about its children (a list) keeps it `false`, a container with a free-form body (a toggle) opts in.
341
+ * @returns {boolean}
342
+ * @public
343
+ */
344
+ public get adoptsPastedTypes(): boolean;
345
+ /**
346
+ * Paste extension point: lets the block that holds the caret decide how a pasted fragment lands, instead
347
+ * of the engine's default (first block merged into the caret block, the rest inserted after it as
348
+ * siblings). A block that lives in a container with its own rules about what it can hold overrides it
349
+ * (e.g. a list item turns pasted paragraphs into siblings items and splits its list around a block it
350
+ * cannot hold). The engine has already removed the selection; it commits the whole paste as ONE
351
+ * transaction (one undo step) and puts the caret at the returned point.
352
+ *
353
+ * Contract: return null to DECLINE, and then touch nothing (the default insertion runs). Otherwise
354
+ * apply the whole paste on the tree (the blocks are created through `nabu.createPasteBlock` /
355
+ * `nabu.insertPasteBlock`), do NOT commit, and return where the caret goes.
356
+ * @param {import('../utils/extensions.js').PasteBlock[]} blocks the sanitized fragment
357
+ * @param {{ offset: number }} ctx the caret offset in this block's text
358
+ * @returns {{ block: Block | null, offset: number } | null} `block: null` leaves the caret to the engine
359
+ * @public
360
+ */
361
+ public acceptPaste(blocks: import("../utils/extensions.js").PasteBlock[], ctx: {
362
+ offset: number;
363
+ }): {
364
+ block: Block | null;
365
+ offset: number;
366
+ } | null;
367
+ /**
368
+ * The blocks that travel together when THIS block is dragged by its handle (P-81): this block and anything the drag must carry
369
+ * with it, in document order, all in the same parent. The default is the block alone (a container carries its own children:
370
+ * they are its tree children). A block whose "extent" is not its subtree overrides it (an extension may widen the range). The drop rules are the same for any range: it cannot land inside itself.
371
+ * @returns {Block[]}
372
+ * @public
373
+ */
374
+ public dragRange(): Block[];
375
+ /**
376
+ * @param {{from?: number, to?: number, index?: number, length?: number, offset?: number}} options
377
+ * @returns {{block: Block} | null}
378
+ * @public
379
+ */
380
+ public split(options: {
116
381
  from?: number;
117
382
  to?: number;
118
383
  index?: number;
@@ -121,8 +386,12 @@ export class Block {
121
386
  }): {
122
387
  block: Block;
123
388
  } | null;
124
- /** @param {{start?: number, end?: number, offset?: number} | null } options @param {boolean} [passive=false] */
125
- focus(options?: {
389
+ /**
390
+ * @param {{start?: number, end?: number, offset?: number} | null } options
391
+ * @param {boolean} [passive=false]
392
+ * @public
393
+ */
394
+ public focus(options?: {
126
395
  start?: number;
127
396
  end?: number;
128
397
  offset?: number;
@@ -143,20 +412,39 @@ export class Block {
143
412
  /**
144
413
  * @param {number} offset
145
414
  * @returns {{node: Node, offset: number} | null}
415
+ * @public
146
416
  */
147
- getDOMPoint(offset: number): {
417
+ public getDOMPoint(offset: number): {
148
418
  node: Node;
149
419
  offset: number;
150
420
  } | null;
151
- /** @param {string} eventName @param {Event} event @param {Object} [data={}] */
152
- ascend(eventName: string, event: Event, data?: Object): any;
153
- /** @param {InputEvent} event @returns {any} */
154
- beforeinput(event: InputEvent): any;
155
- /** @param {KeyboardEvent} event @returns {any} */
156
- keydown(event: KeyboardEvent): any;
157
- commit(): Promise<void>;
158
- /** @param {string} format @param {Record<string, any>} [context] */
159
- serialize(format: string, context?: Record<string, any>): void | null;
421
+ /**
422
+ * @param {string} eventName
423
+ * @param {Event | null} event
424
+ * @param {Object} [data={}]
425
+ * @public
426
+ */
427
+ public ascend(eventName: string, event: Event | null, data?: Object): any;
428
+ /**
429
+ * @param {InputEvent} event
430
+ * @returns {any}
431
+ * @public
432
+ */
433
+ public beforeinput(event: InputEvent): any;
434
+ /**
435
+ * @param {KeyboardEvent} event
436
+ * @returns {any}
437
+ * @public
438
+ */
439
+ public keydown(event: KeyboardEvent): any;
440
+ /** @public */
441
+ public commit(): Promise<void>;
442
+ /**
443
+ * @param {string} format
444
+ * @param {Record<string, any>} [context]
445
+ * @public
446
+ */
447
+ public serialize(format: string, context?: Record<string, any>): any;
160
448
  }
161
449
  import type { Nabu } from "./nabu.svelte.js";
162
450
  import type { NabuNode } from "./nabu.svelte.js";