@folijs/core 0.1.0 → 0.3.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 (189) hide show
  1. package/CHANGELOG.md +39 -0
  2. package/README.md +1 -1
  3. package/dist/document.d.ts +10 -15
  4. package/dist/document.d.ts.map +1 -1
  5. package/dist/document.js +41 -19
  6. package/dist/document.js.map +1 -1
  7. package/dist/index.d.ts +3 -2
  8. package/dist/index.d.ts.map +1 -1
  9. package/dist/index.js +3 -2
  10. package/dist/index.js.map +1 -1
  11. package/dist/model/attrs.d.ts +5 -0
  12. package/dist/model/attrs.d.ts.map +1 -1
  13. package/dist/model/attrs.js +17 -0
  14. package/dist/model/attrs.js.map +1 -1
  15. package/dist/model/content.d.ts +10 -0
  16. package/dist/model/content.d.ts.map +1 -1
  17. package/dist/model/content.js +44 -0
  18. package/dist/model/content.js.map +1 -1
  19. package/dist/model/fragment.d.ts +7 -2
  20. package/dist/model/fragment.d.ts.map +1 -1
  21. package/dist/model/fragment.js +13 -2
  22. package/dist/model/fragment.js.map +1 -1
  23. package/dist/model/index.d.ts +1 -1
  24. package/dist/model/index.d.ts.map +1 -1
  25. package/dist/model/index.js +1 -1
  26. package/dist/model/index.js.map +1 -1
  27. package/dist/model/mark.d.ts.map +1 -1
  28. package/dist/model/mark.js +4 -3
  29. package/dist/model/mark.js.map +1 -1
  30. package/dist/model/node.d.ts +13 -1
  31. package/dist/model/node.d.ts.map +1 -1
  32. package/dist/model/node.js +35 -3
  33. package/dist/model/node.js.map +1 -1
  34. package/dist/model/resolvedpos.d.ts +26 -2
  35. package/dist/model/resolvedpos.d.ts.map +1 -1
  36. package/dist/model/resolvedpos.js +54 -2
  37. package/dist/model/resolvedpos.js.map +1 -1
  38. package/dist/model/schema.d.ts +25 -0
  39. package/dist/model/schema.d.ts.map +1 -1
  40. package/dist/model/schema.js +23 -0
  41. package/dist/model/schema.js.map +1 -1
  42. package/dist/model/slice.d.ts +7 -0
  43. package/dist/model/slice.d.ts.map +1 -1
  44. package/dist/model/slice.js +53 -0
  45. package/dist/model/slice.js.map +1 -1
  46. package/dist/schema.d.ts +72 -8
  47. package/dist/schema.d.ts.map +1 -1
  48. package/dist/schema.js +93 -9
  49. package/dist/schema.js.map +1 -1
  50. package/dist/state/attempt.d.ts +4 -0
  51. package/dist/state/attempt.d.ts.map +1 -0
  52. package/dist/state/attempt.js +19 -0
  53. package/dist/state/attempt.js.map +1 -0
  54. package/dist/state/commands.d.ts +21 -5
  55. package/dist/state/commands.d.ts.map +1 -1
  56. package/dist/state/commands.js +260 -68
  57. package/dist/state/commands.js.map +1 -1
  58. package/dist/state/editor.d.ts +41 -7
  59. package/dist/state/editor.d.ts.map +1 -1
  60. package/dist/state/editor.js +51 -10
  61. package/dist/state/editor.js.map +1 -1
  62. package/dist/state/format.d.ts +13 -0
  63. package/dist/state/format.d.ts.map +1 -0
  64. package/dist/state/format.js +20 -0
  65. package/dist/state/format.js.map +1 -0
  66. package/dist/state/history.js +2 -2
  67. package/dist/state/history.js.map +1 -1
  68. package/dist/state/index.d.ts +10 -3
  69. package/dist/state/index.d.ts.map +1 -1
  70. package/dist/state/index.js +10 -3
  71. package/dist/state/index.js.map +1 -1
  72. package/dist/state/links.d.ts +42 -0
  73. package/dist/state/links.d.ts.map +1 -0
  74. package/dist/state/links.js +194 -0
  75. package/dist/state/links.js.map +1 -0
  76. package/dist/state/lists.d.ts +23 -0
  77. package/dist/state/lists.d.ts.map +1 -0
  78. package/dist/state/lists.js +34 -0
  79. package/dist/state/lists.js.map +1 -0
  80. package/dist/state/mark.d.ts +25 -0
  81. package/dist/state/mark.d.ts.map +1 -0
  82. package/dist/state/mark.js +40 -0
  83. package/dist/state/mark.js.map +1 -0
  84. package/dist/state/selection.d.ts +18 -2
  85. package/dist/state/selection.d.ts.map +1 -1
  86. package/dist/state/selection.js +63 -2
  87. package/dist/state/selection.js.map +1 -1
  88. package/dist/state/state.d.ts.map +1 -1
  89. package/dist/state/state.js +23 -2
  90. package/dist/state/state.js.map +1 -1
  91. package/dist/state/word.d.ts +72 -0
  92. package/dist/state/word.d.ts.map +1 -0
  93. package/dist/state/word.js +173 -0
  94. package/dist/state/word.js.map +1 -0
  95. package/dist/state/wordclip.d.ts +43 -0
  96. package/dist/state/wordclip.d.ts.map +1 -0
  97. package/dist/state/wordclip.js +412 -0
  98. package/dist/state/wordclip.js.map +1 -0
  99. package/dist/state/wordformat.d.ts +136 -0
  100. package/dist/state/wordformat.d.ts.map +1 -0
  101. package/dist/state/wordformat.js +846 -0
  102. package/dist/state/wordformat.js.map +1 -0
  103. package/dist/transform/index.d.ts +2 -1
  104. package/dist/transform/index.d.ts.map +1 -1
  105. package/dist/transform/index.js +2 -1
  106. package/dist/transform/index.js.map +1 -1
  107. package/dist/transform/stepmap.d.ts +8 -6
  108. package/dist/transform/stepmap.d.ts.map +1 -1
  109. package/dist/transform/stepmap.js +18 -15
  110. package/dist/transform/stepmap.js.map +1 -1
  111. package/dist/transform/steps.d.ts +27 -2
  112. package/dist/transform/steps.d.ts.map +1 -1
  113. package/dist/transform/steps.js +115 -4
  114. package/dist/transform/steps.js.map +1 -1
  115. package/dist/transform/structure.d.ts +26 -0
  116. package/dist/transform/structure.d.ts.map +1 -0
  117. package/dist/transform/structure.js +116 -0
  118. package/dist/transform/structure.js.map +1 -0
  119. package/dist/transform/transform.d.ts +34 -11
  120. package/dist/transform/transform.d.ts.map +1 -1
  121. package/dist/transform/transform.js +145 -18
  122. package/dist/transform/transform.js.map +1 -1
  123. package/dist/v3/check.d.ts +33 -0
  124. package/dist/v3/check.d.ts.map +1 -0
  125. package/dist/v3/check.js +90 -0
  126. package/dist/v3/check.js.map +1 -0
  127. package/dist/v3/document.d.ts +217 -0
  128. package/dist/v3/document.d.ts.map +1 -0
  129. package/dist/v3/document.js +225 -0
  130. package/dist/v3/document.js.map +1 -0
  131. package/dist/v3/index.d.ts +6 -0
  132. package/dist/v3/index.d.ts.map +1 -0
  133. package/dist/v3/index.js +6 -0
  134. package/dist/v3/index.js.map +1 -0
  135. package/dist/v3/migrate.d.ts +19 -0
  136. package/dist/v3/migrate.d.ts.map +1 -0
  137. package/dist/v3/migrate.js +227 -0
  138. package/dist/v3/migrate.js.map +1 -0
  139. package/dist/v3/resolve.d.ts +129 -0
  140. package/dist/v3/resolve.d.ts.map +1 -0
  141. package/dist/v3/resolve.js +534 -0
  142. package/dist/v3/resolve.js.map +1 -0
  143. package/dist/v3/schema.d.ts +27 -0
  144. package/dist/v3/schema.d.ts.map +1 -0
  145. package/dist/v3/schema.js +429 -0
  146. package/dist/v3/schema.js.map +1 -0
  147. package/dist/v3/units.d.ts +16 -0
  148. package/dist/v3/units.d.ts.map +1 -0
  149. package/dist/v3/units.js +28 -0
  150. package/dist/v3/units.js.map +1 -0
  151. package/package.json +1 -1
  152. package/src/document.ts +49 -23
  153. package/src/index.ts +17 -6
  154. package/src/model/attrs.ts +19 -0
  155. package/src/model/content.ts +56 -0
  156. package/src/model/fragment.ts +18 -3
  157. package/src/model/index.ts +1 -1
  158. package/src/model/mark.ts +3 -2
  159. package/src/model/node.ts +48 -3
  160. package/src/model/resolvedpos.ts +55 -2
  161. package/src/model/schema.ts +43 -0
  162. package/src/model/slice.ts +81 -1
  163. package/src/schema.ts +148 -13
  164. package/src/state/attempt.ts +22 -0
  165. package/src/state/commands.ts +287 -69
  166. package/src/state/editor.ts +103 -21
  167. package/src/state/format.ts +35 -0
  168. package/src/state/history.ts +3 -3
  169. package/src/state/index.ts +63 -1
  170. package/src/state/links.ts +193 -0
  171. package/src/state/lists.ts +50 -0
  172. package/src/state/mark.ts +47 -0
  173. package/src/state/selection.ts +72 -3
  174. package/src/state/state.ts +22 -2
  175. package/src/state/word.ts +245 -0
  176. package/src/state/wordclip.ts +445 -0
  177. package/src/state/wordformat.ts +982 -0
  178. package/src/transform/index.ts +8 -0
  179. package/src/transform/stepmap.ts +18 -12
  180. package/src/transform/steps.ts +126 -3
  181. package/src/transform/structure.ts +135 -0
  182. package/src/transform/transform.ts +165 -16
  183. package/src/v3/check.ts +119 -0
  184. package/src/v3/document.ts +456 -0
  185. package/src/v3/index.ts +33 -0
  186. package/src/v3/migrate.ts +267 -0
  187. package/src/v3/resolve.ts +646 -0
  188. package/src/v3/schema.ts +479 -0
  189. package/src/v3/units.ts +34 -0
@@ -1 +1 @@
1
- {"version":3,"file":"slice.js","sourceRoot":"","sources":["../../src/model/slice.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AASzC;;;;GAIG;AACH,MAAM,OAAO,KAAK;IAIL,OAAO;IACP,SAAS;IACT,OAAO;IALlB,MAAM,CAAU,KAAK,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAExD,YACW,OAAiB,EACjB,SAAiB,EACjB,OAAe;uBAFf,OAAO;yBACP,SAAS;uBACT,OAAO;IACf,CAAC;IAEJ,6DAA6D;IAC7D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC;IAC3D,CAAC;IAED,EAAE,CAAC,KAAY;QACb,OAAO,CACL,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;YAC9B,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;YAClC,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAC/B,CAAC;IACJ,CAAC;IAED,MAAM;QACJ,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;IAC9F,CAAC;CACF"}
1
+ {"version":3,"file":"slice.js","sourceRoot":"","sources":["../../src/model/slice.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AASzC;;;;GAIG;AACH,MAAM,OAAO,KAAK;IAIL,OAAO;IACP,SAAS;IACT,OAAO;IALlB,MAAM,CAAU,KAAK,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAExD,YACW,OAAiB,EACjB,SAAiB,EACjB,OAAe;uBAFf,OAAO;yBACP,SAAS;uBACT,OAAO;IACf,CAAC;IAEJ,6DAA6D;IAC7D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,GAAW,EAAE,QAAkB;QACtC,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE;YACvE,MAAM,EAAE,IAAI;YACZ,KAAK,EAAE,CAAC;YACR,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,IAAI;YACX,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAC;QACH,OAAO,OAAO,IAAI,IAAI,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;IAED,sEAAsE;IACtE,aAAa,CAAC,IAAY,EAAE,EAAU;QACpC,OAAO,IAAI,KAAK,CACd,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,EACrE,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,OAAO,CACb,CAAC;IACJ,CAAC;IAED,EAAE,CAAC,KAAY;QACb,OAAO,CACL,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;YAC9B,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;YAClC,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAC/B,CAAC;IACJ,CAAC;IAED,MAAM;QACJ,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;IAC9F,CAAC;CACF;AAcD,SAAS,UAAU,CACjB,OAAiB,EACjB,IAAY,EACZ,MAAgB,EAChB,IAAgB;IAEhB,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAClD,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACxC,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAC/B,oFAAoF;QACpF,iFAAiF;QACjF,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;QAChG,OAAO,MAAM,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;IAC9E,CAAC;IACD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,GAAG,MAAM,GAAG,CAAC,EAAE,MAAM,EAAE;QACjE,GAAG,IAAI;QACP,MAAM,EAAE,KAAK;QACb,KAAK,EAAE,IAAI,CAAC,KAAK,GAAG,CAAC;QACrB,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,KAAK,KAAK,CAAC;QACpC,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,KAAK,KAAK,OAAO,CAAC,UAAU,GAAG,CAAC;KACtD,CAAC,CAAC;IACH,OAAO,KAAK,IAAI,OAAO,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,WAAW,CAAC,OAAiB,EAAE,IAAY,EAAE,EAAU;IAC9D,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAClD,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACxC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACnE,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QAC9C,IAAI,QAAQ,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;YACtD,MAAM,IAAI,UAAU,CAAC,2BAA2B,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IACtD,CAAC;IACD,IAAI,KAAK,KAAK,OAAO;QAAE,MAAM,IAAI,UAAU,CAAC,2BAA2B,CAAC,CAAC;IACzE,OAAO,OAAO,CAAC,YAAY,CACzB,KAAK,EACL,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,GAAG,MAAM,GAAG,CAAC,EAAE,EAAE,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAC3E,CAAC;AACJ,CAAC"}
package/dist/schema.d.ts CHANGED
@@ -1,17 +1,58 @@
1
1
  import { Schema } from "./model/index.js";
2
2
  /**
3
- * Schema v1: the node and mark types a Foli document may contain, defined through the same
4
- * spec API third-party extensions use. The JSON types below describe the persisted shape of v1
5
- * content ({type, attrs, content, text, marks}); that shape is permanent.
3
+ * Schema v2: the node and mark types a Foli document may contain, defined through the same spec
4
+ * API third-party extensions use. The JSON types below describe the persisted shape of v2
5
+ * content ({type, attrs, content, text, marks}); that shape is permanent. v1 content (0.1.0) is
6
+ * valid v2 content: v2 only adds types and attributes with defaults.
6
7
  */
7
- export declare const MARK_TYPES: readonly ["bold", "italic", "underline", "strike"];
8
+ /** Marks without attributes. */
9
+ export declare const SIMPLE_MARK_TYPES: readonly ["bold", "italic", "underline", "strike"];
10
+ export type SimpleMarkName = (typeof SIMPLE_MARK_TYPES)[number];
11
+ /** Every mark type, in canonical order (the order of mark sets and of nesting when rendered). */
12
+ export declare const MARK_TYPES: readonly ["link", "bold", "italic", "underline", "strike", "textColor", "highlight"];
8
13
  export type MarkName = (typeof MARK_TYPES)[number];
9
14
  export declare const HEADING_LEVELS: readonly [1, 2, 3, 4, 5, 6];
10
15
  export type HeadingLevel = (typeof HEADING_LEVELS)[number];
11
- export declare const schema: Schema;
12
- export interface MarkNameJSON {
13
- type: MarkName;
16
+ /** `start` and `end` follow the text direction (left and right in left-to-right text). */
17
+ export declare const ALIGNMENTS: readonly ["start", "center", "end", "justify"];
18
+ export type Alignment = (typeof ALIGNMENTS)[number];
19
+ /** URL schemes a link may use; anything else (javascript:, data:, file:…) is rejected. */
20
+ export declare const SAFE_LINK_PROTOCOLS: readonly ["http:", "https:", "mailto:", "tel:"];
21
+ /**
22
+ * Whether `href` may be stored in a link: an absolute URL with a safe protocol, or a relative
23
+ * URL (path, `?query`, `#fragment`, `//host`). Rejects control characters and spaces anywhere
24
+ * (browsers strip tabs and newlines inside schemes, so `java\tscript:` would run) and
25
+ * backslashes (some browsers read `\\` as `//`).
26
+ */
27
+ export declare function isSafeHref(href: unknown): href is string;
28
+ /**
29
+ * Whether a link's attributes may come in from outside the document (a command, a paste from
30
+ * elsewhere): a safe `href`, or none with a bookmark (`anchor`, schema v3: Word's table of
31
+ * contents and cross-references).
32
+ */
33
+ export declare function isSafeLink(attrs: {
34
+ href?: unknown;
35
+ anchor?: unknown;
36
+ } | null | undefined): boolean;
37
+ /** Whether `color` is a canonical color value: `#rrggbb`, lowercase. */
38
+ export declare function isColor(color: unknown): color is string;
39
+ export declare const schemaV2: Schema;
40
+ export interface SimpleMarkJSON {
41
+ type: SimpleMarkName;
42
+ }
43
+ export interface LinkMarkJSON {
44
+ type: "link";
45
+ attrs: {
46
+ href: string;
47
+ };
48
+ }
49
+ export interface ColorMarkJSON {
50
+ type: "textColor" | "highlight";
51
+ attrs: {
52
+ color: string;
53
+ };
14
54
  }
55
+ export type MarkNameJSON = SimpleMarkJSON | LinkMarkJSON | ColorMarkJSON;
15
56
  export interface TextJSON {
16
57
  type: "text";
17
58
  text: string;
@@ -26,18 +67,41 @@ export interface PageBreakJSON {
26
67
  marks?: MarkNameJSON[];
27
68
  }
28
69
  export type InlineJSON = TextJSON | HardBreakJSON | PageBreakJSON;
70
+ /** Attributes equal to their default (`align: "start"`, `start: 1`) are omitted. */
29
71
  export interface ParagraphJSON {
30
72
  type: "paragraph";
73
+ attrs?: {
74
+ align?: Alignment;
75
+ };
31
76
  content?: InlineJSON[];
32
77
  }
33
78
  export interface HeadingJSON {
34
79
  type: "heading";
35
80
  attrs: {
36
81
  level: HeadingLevel;
82
+ align?: Alignment;
37
83
  };
38
84
  content?: InlineJSON[];
39
85
  }
40
- export type BlockJSON = ParagraphJSON | HeadingJSON;
86
+ export interface ListItemJSON {
87
+ type: "listItem";
88
+ content: [ParagraphJSON, ...BlockJSON[]];
89
+ }
90
+ export interface BulletListJSON {
91
+ type: "bulletList";
92
+ content: ListItemJSON[];
93
+ }
94
+ export interface OrderedListJSON {
95
+ type: "orderedList";
96
+ attrs?: {
97
+ start?: number;
98
+ };
99
+ content: ListItemJSON[];
100
+ }
101
+ export interface HorizontalRuleJSON {
102
+ type: "horizontalRule";
103
+ }
104
+ export type BlockJSON = ParagraphJSON | HeadingJSON | BulletListJSON | OrderedListJSON | HorizontalRuleJSON;
41
105
  export interface DocJSON {
42
106
  type: "doc";
43
107
  content: BlockJSON[];
@@ -1 +1 @@
1
- {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C;;;;GAIG;AAEH,eAAO,MAAM,UAAU,YAAI,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,CAAU,CAAC;AAC7E,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAEnD,eAAO,MAAM,cAAc,YAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAU,CAAC;AAC1D,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3D,eAAO,MAAM,MAAM,QAuBjB,CAAC;AAEH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAED,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,aAAa,GAAG,aAAa,CAAC;AAElE,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE;QAAE,KAAK,EAAE,YAAY,CAAA;KAAE,CAAC;IAC/B,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;CACxB;AAED,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG,WAAW,CAAC;AAEpD,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,KAAK,CAAC;IACZ,OAAO,EAAE,SAAS,EAAE,CAAC;CACtB"}
1
+ {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C;;;;;GAKG;AAEH,gCAAgC;AAChC,eAAO,MAAM,iBAAiB,YAAI,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,CAAU,CAAC;AACpF,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEhE,iGAAiG;AACjG,eAAO,MAAM,UAAU,sFAAoE,CAAC;AAC5F,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAEnD,eAAO,MAAM,cAAc,YAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAU,CAAC;AAC1D,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3D,0FAA0F;AAC1F,eAAO,MAAM,UAAU,YAAI,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,CAAU,CAAC;AACzE,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpD,0FAA0F;AAC1F,eAAO,MAAM,mBAAmB,YAAI,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAU,CAAC;AAEnF;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,MAAM,CAQxD;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE;IAAE,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,IAAI,GAAG,SAAS,GAC7D,OAAO,CAGT;AAED,wEAAwE;AACxE,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAEvD;AAeD,eAAO,MAAM,QAAQ,QA4DnB,CAAC;AAEH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;IAChC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1B;AAED,MAAM,MAAM,YAAY,GAAG,cAAc,GAAG,YAAY,GAAG,aAAa,CAAC;AAEzE,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAED,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,aAAa,GAAG,aAAa,CAAC;AAElE,oFAAoF;AACpF,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,SAAS,CAAA;KAAE,CAAC;IAC9B,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE;QAAE,KAAK,EAAE,YAAY,CAAC;QAAC,KAAK,CAAC,EAAE,SAAS,CAAA;KAAE,CAAC;IAClD,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,CAAC,aAAa,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,aAAa,CAAC;IACpB,KAAK,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3B,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED,MAAM,MAAM,SAAS,GACjB,aAAa,GACb,WAAW,GACX,cAAc,GACd,eAAe,GACf,kBAAkB,CAAC;AAEvB,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,KAAK,CAAC;IACZ,OAAO,EAAE,SAAS,EAAE,CAAC;CACtB"}
package/dist/schema.js CHANGED
@@ -1,15 +1,64 @@
1
1
  import { Schema } from "./model/index.js";
2
2
  /**
3
- * Schema v1: the node and mark types a Foli document may contain, defined through the same
4
- * spec API third-party extensions use. The JSON types below describe the persisted shape of v1
5
- * content ({type, attrs, content, text, marks}); that shape is permanent.
3
+ * Schema v2: the node and mark types a Foli document may contain, defined through the same spec
4
+ * API third-party extensions use. The JSON types below describe the persisted shape of v2
5
+ * content ({type, attrs, content, text, marks}); that shape is permanent. v1 content (0.1.0) is
6
+ * valid v2 content: v2 only adds types and attributes with defaults.
6
7
  */
7
- export const MARK_TYPES = ["bold", "italic", "underline", "strike"];
8
+ /** Marks without attributes. */
9
+ export const SIMPLE_MARK_TYPES = ["bold", "italic", "underline", "strike"];
10
+ /** Every mark type, in canonical order (the order of mark sets and of nesting when rendered). */
11
+ export const MARK_TYPES = ["link", ...SIMPLE_MARK_TYPES, "textColor", "highlight"];
8
12
  export const HEADING_LEVELS = [1, 2, 3, 4, 5, 6];
9
- export const schema = new Schema({
13
+ /** `start` and `end` follow the text direction (left and right in left-to-right text). */
14
+ export const ALIGNMENTS = ["start", "center", "end", "justify"];
15
+ /** URL schemes a link may use; anything else (javascript:, data:, file:…) is rejected. */
16
+ export const SAFE_LINK_PROTOCOLS = ["http:", "https:", "mailto:", "tel:"];
17
+ /**
18
+ * Whether `href` may be stored in a link: an absolute URL with a safe protocol, or a relative
19
+ * URL (path, `?query`, `#fragment`, `//host`). Rejects control characters and spaces anywhere
20
+ * (browsers strip tabs and newlines inside schemes, so `java\tscript:` would run) and
21
+ * backslashes (some browsers read `\\` as `//`).
22
+ */
23
+ export function isSafeHref(href) {
24
+ if (typeof href !== "string" || !href || href.length > 8192)
25
+ return false;
26
+ // Control characters, spaces and backslashes are never part of a URL we keep.
27
+ // biome-ignore lint/suspicious/noControlCharactersInRegex: matching control characters is the point.
28
+ if (/[\u0000- \u007f-\u009f\\]/.test(href))
29
+ return false;
30
+ const scheme = /^([a-zA-Z][a-zA-Z0-9+.-]*):/.exec(href);
31
+ if (!scheme)
32
+ return true; // relative
33
+ return SAFE_LINK_PROTOCOLS.includes(`${scheme[1]?.toLowerCase()}:`);
34
+ }
35
+ /**
36
+ * Whether a link's attributes may come in from outside the document (a command, a paste from
37
+ * elsewhere): a safe `href`, or none with a bookmark (`anchor`, schema v3: Word's table of
38
+ * contents and cross-references).
39
+ */
40
+ export function isSafeLink(attrs) {
41
+ if (attrs?.href === null || attrs?.href === undefined)
42
+ return typeof attrs?.anchor === "string";
43
+ return isSafeHref(attrs.href);
44
+ }
45
+ /** Whether `color` is a canonical color value: `#rrggbb`, lowercase. */
46
+ export function isColor(color) {
47
+ return typeof color === "string" && /^#[0-9a-f]{6}$/.test(color);
48
+ }
49
+ const align = {
50
+ default: "start",
51
+ validate: (value) => ALIGNMENTS.includes(value)
52
+ ? undefined
53
+ : `align must be one of ${ALIGNMENTS.join(", ")}`,
54
+ };
55
+ const color = {
56
+ validate: (value) => isColor(value) ? undefined : "color must be a lowercase #rrggbb value",
57
+ };
58
+ export const schemaV2 = new Schema({
10
59
  nodes: {
11
60
  doc: { content: "block+" },
12
- paragraph: { group: "block", content: "inline*" },
61
+ paragraph: { group: "block", content: "inline*", attrs: { align } },
13
62
  heading: {
14
63
  group: "block",
15
64
  content: "inline*",
@@ -19,14 +68,49 @@ export const schema = new Schema({
19
68
  ? undefined
20
69
  : "heading level must be an integer from 1 to 6",
21
70
  },
71
+ align,
72
+ },
73
+ },
74
+ bulletList: { group: "block", content: "listItem+" },
75
+ orderedList: {
76
+ group: "block",
77
+ content: "listItem+",
78
+ attrs: {
79
+ start: {
80
+ default: 1,
81
+ validate: (value) => Number.isInteger(value) && value >= 0 && value <= 99_999
82
+ ? undefined
83
+ : "start must be an integer from 0 to 99999",
84
+ },
22
85
  },
23
86
  },
87
+ // A list item starts with a paragraph; nested lists and other blocks may follow.
88
+ listItem: { content: "paragraph block*" },
89
+ horizontalRule: { group: "block" },
24
90
  text: { group: "inline" },
25
- hardBreak: { group: "inline", inline: true },
91
+ hardBreak: { group: "inline", inline: true, selectable: false },
26
92
  // An explicit page break: inline like a hard break (as in DOCX, `<w:br w:type="page"/>`);
27
93
  // the line it ends is the last on its page.
28
- pageBreak: { group: "inline", inline: true },
94
+ pageBreak: { group: "inline", inline: true, selectable: false },
95
+ },
96
+ marks: {
97
+ // First, so a link wraps the formatting inside it when rendered.
98
+ link: {
99
+ attrs: {
100
+ href: {
101
+ validate: (value) => isSafeHref(value)
102
+ ? undefined
103
+ : "href must be a relative URL or use http, https, mailto or tel",
104
+ },
105
+ },
106
+ inclusive: false,
107
+ },
108
+ bold: {},
109
+ italic: {},
110
+ underline: {},
111
+ strike: {},
112
+ textColor: { attrs: { color } },
113
+ highlight: { attrs: { color } },
29
114
  },
30
- marks: Object.fromEntries(MARK_TYPES.map((name) => [name, {}])),
31
115
  });
32
116
  //# sourceMappingURL=schema.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C;;;;GAIG;AAEH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,CAAU,CAAC;AAG7E,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAU,CAAC;AAG1D,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;IAC/B,KAAK,EAAE;QACL,GAAG,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE;QAC1B,SAAS,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE;QACjD,OAAO,EAAE;YACP,KAAK,EAAE,OAAO;YACd,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE;gBACL,KAAK,EAAE;oBACL,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAClB,cAAc,CAAC,QAAQ,CAAC,KAAqB,CAAC;wBAC5C,CAAC,CAAC,SAAS;wBACX,CAAC,CAAC,8CAA8C;iBACrD;aACF;SACF;QACD,IAAI,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE;QACzB,SAAS,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE;QAC5C,0FAA0F;QAC1F,4CAA4C;QAC5C,SAAS,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE;KAC7C;IACD,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;CAChE,CAAC,CAAC"}
1
+ {"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C;;;;;GAKG;AAEH,gCAAgC;AAChC,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,CAAU,CAAC;AAGpF,iGAAiG;AACjG,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,GAAG,iBAAiB,EAAE,WAAW,EAAE,WAAW,CAAU,CAAC;AAG5F,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAU,CAAC;AAG1D,0FAA0F;AAC1F,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,CAAU,CAAC;AAGzE,0FAA0F;AAC1F,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAU,CAAC;AAEnF;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,IAAa;IACtC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI;QAAE,OAAO,KAAK,CAAC;IAC1E,8EAA8E;IAC9E,qGAAqG;IACrG,IAAI,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IACzD,MAAM,MAAM,GAAG,6BAA6B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxD,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC,CAAC,WAAW;IACrC,OAAQ,mBAAyC,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;AAC7F,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CACxB,KAA8D;IAE9D,IAAI,KAAK,EAAE,IAAI,KAAK,IAAI,IAAI,KAAK,EAAE,IAAI,KAAK,SAAS;QAAE,OAAO,OAAO,KAAK,EAAE,MAAM,KAAK,QAAQ,CAAC;IAChG,OAAO,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAChC,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,OAAO,CAAC,KAAc;IACpC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACnE,CAAC;AAED,MAAM,KAAK,GAAG;IACZ,OAAO,EAAE,OAAO;IAChB,QAAQ,EAAE,CAAC,KAAc,EAAE,EAAE,CAC1B,UAAiC,CAAC,QAAQ,CAAC,KAAK,CAAC;QAChD,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,wBAAwB,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;CACtD,CAAC;AAEF,MAAM,KAAK,GAAG;IACZ,QAAQ,EAAE,CAAC,KAAc,EAAE,EAAE,CAC3B,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,yCAAyC;CACzE,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC;IACjC,KAAK,EAAE;QACL,GAAG,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE;QAC1B,SAAS,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE;QACnE,OAAO,EAAE;YACP,KAAK,EAAE,OAAO;YACd,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE;gBACL,KAAK,EAAE;oBACL,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAClB,cAAc,CAAC,QAAQ,CAAC,KAAqB,CAAC;wBAC5C,CAAC,CAAC,SAAS;wBACX,CAAC,CAAC,8CAA8C;iBACrD;gBACD,KAAK;aACN;SACF;QACD,UAAU,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE;QACpD,WAAW,EAAE;YACX,KAAK,EAAE,OAAO;YACd,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE;gBACL,KAAK,EAAE;oBACL,OAAO,EAAE,CAAC;oBACV,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAClB,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAK,KAAgB,IAAI,CAAC,IAAK,KAAgB,IAAI,MAAM;wBAC9E,CAAC,CAAC,SAAS;wBACX,CAAC,CAAC,0CAA0C;iBACjD;aACF;SACF;QACD,iFAAiF;QACjF,QAAQ,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE;QACzC,cAAc,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;QAClC,IAAI,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE;QACzB,SAAS,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE;QAC/D,0FAA0F;QAC1F,4CAA4C;QAC5C,SAAS,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE;KAChE;IACD,KAAK,EAAE;QACL,iEAAiE;QACjE,IAAI,EAAE;YACJ,KAAK,EAAE;gBACL,IAAI,EAAE;oBACJ,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAClB,UAAU,CAAC,KAAK,CAAC;wBACf,CAAC,CAAC,SAAS;wBACX,CAAC,CAAC,+DAA+D;iBACtE;aACF;YACD,SAAS,EAAE,KAAK;SACjB;QACD,IAAI,EAAE,EAAE;QACR,MAAM,EAAE,EAAE;QACV,SAAS,EAAE,EAAE;QACb,MAAM,EAAE,EAAE;QACV,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE;QAC/B,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE;KAChC;CACF,CAAC,CAAC"}
@@ -0,0 +1,4 @@
1
+ import type { EditorState, Transaction } from "./state.js";
2
+ /** @internal Runs `build`; a TransformError, or a transaction that changes nothing, does not apply. */
3
+ export declare function attempt(state: EditorState, dispatch: ((tr: Transaction) => void) | undefined, build: (tr: Transaction) => void): boolean;
4
+ //# sourceMappingURL=attempt.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"attempt.d.ts","sourceRoot":"","sources":["../../src/state/attempt.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE3D,uGAAuG;AACvG,wBAAgB,OAAO,CACrB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,WAAW,KAAK,IAAI,CAAC,GAAG,SAAS,EACjD,KAAK,EAAE,CAAC,EAAE,EAAE,WAAW,KAAK,IAAI,GAC/B,OAAO,CAaT"}
@@ -0,0 +1,19 @@
1
+ import { TransformError } from "../transform/transform.js";
2
+ /** @internal Runs `build`; a TransformError, or a transaction that changes nothing, does not apply. */
3
+ export function attempt(state, dispatch, build) {
4
+ const tr = state.tr;
5
+ try {
6
+ build(tr);
7
+ }
8
+ catch (error) {
9
+ if (error instanceof TransformError)
10
+ return false;
11
+ throw error;
12
+ }
13
+ if (!tr.docChanged && tr.selection.eq(state.selection) && tr.storedMarks === state.storedMarks) {
14
+ return false;
15
+ }
16
+ dispatch?.(tr);
17
+ return true;
18
+ }
19
+ //# sourceMappingURL=attempt.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"attempt.js","sourceRoot":"","sources":["../../src/state/attempt.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAG3D,uGAAuG;AACvG,MAAM,UAAU,OAAO,CACrB,KAAkB,EAClB,QAAiD,EACjD,KAAgC;IAEhC,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC;IACpB,IAAI,CAAC;QACH,KAAK,CAAC,EAAE,CAAC,CAAC;IACZ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,cAAc;YAAE,OAAO,KAAK,CAAC;QAClD,MAAM,KAAK,CAAC;IACd,CAAC;IACD,IAAI,CAAC,EAAE,CAAC,UAAU,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;QAC/F,OAAO,KAAK,CAAC;IACf,CAAC;IACD,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC;IACf,OAAO,IAAI,CAAC;AACd,CAAC"}
@@ -1,4 +1,4 @@
1
- import type { Attrs, MarkType, NodeType } from "../model/index.js";
1
+ import { type Attrs, type MarkType, type NodeType } from "../model/index.js";
2
2
  import { type Command, type EditorState, Plugin } from "./state.js";
3
3
  export type DeleteUnit = "char" | "word";
4
4
  export declare const deleteSelection: Command;
@@ -9,17 +9,30 @@ export declare function deleteBackward(unit?: DeleteUnit): Command;
9
9
  /** Delete: deletes the selection, else the next character or word, else joins with the next block. */
10
10
  export declare function deleteForward(unit?: DeleteUnit): Command;
11
11
  /**
12
- * At the start of a textblock: merges it into the previous textblock, or deletes a previous leaf
13
- * block. Does nothing at the start of the first block.
12
+ * At the start of a textblock: merges it into the previous textblock, or selects a previous
13
+ * opaque block (a table), as Word does. Does nothing at the start of the first block.
14
14
  */
15
15
  export declare const joinBackward: Command;
16
- /** At the end of a textblock: merges the next textblock into it, or deletes a next leaf block. */
16
+ /**
17
+ * At the end of a textblock: merges the next textblock into it, or selects a next opaque block.
18
+ */
17
19
  export declare const joinForward: Command;
18
20
  /**
19
21
  * Enter: splits the textblock at the selection. Splitting at the end of a non-default block
20
22
  * (a heading) starts a normal paragraph. Formatting carries over to the new block.
21
23
  */
22
24
  export declare const splitBlock: Command;
25
+ /**
26
+ * Arrow keys around a block leaf (a rule, which has no caret stop). From a selected leaf: to the
27
+ * text beside it (the end of the text before, the start of the text after), or the next leaf.
28
+ * From a caret: selects the leaf beside the caret's textblock, when the caret is at its edge
29
+ * (`"char"`: Left/Right at the textblock's first or last position) or the view found it on the
30
+ * first or last line (`"line"`: Up/Down). `"none"` only moves from a selected leaf. `dir` -1 is
31
+ * back (left, up), 1 forward.
32
+ */
33
+ export declare function arrowAcrossLeaf(dir: -1 | 1, from: "char" | "line" | "none"): Command;
34
+ /** Inserts a tab (schema v3) in place of the selection; does not apply where there is none. */
35
+ export declare const insertTab: Command;
23
36
  /** Inserts a hard break (a line break inside the block) in place of the selection. */
24
37
  export declare const insertHardBreak: Command;
25
38
  /** Inserts an explicit page break in place of the selection (Mod-Enter). */
@@ -32,7 +45,10 @@ export declare const selectAll: Command;
32
45
  export declare function toggleMark(type: string | MarkType, attrs?: Attrs | null): Command;
33
46
  /** Whether the mark is active: in stored marks at a caret, or on all selected text. */
34
47
  export declare function isMarkActive(state: EditorState, type: string | MarkType): boolean;
35
- /** Changes the textblocks in the selection to `type` (e.g. heading level 2, or paragraph). */
48
+ /**
49
+ * Gives the selected paragraphs a block type as Word does: `heading` (with its `level`) is
50
+ * Word's heading style of that level, `paragraph` the document's default paragraph style.
51
+ */
36
52
  export declare function setBlockType(type: string | NodeType, attrs?: Attrs | null): Command;
37
53
  /**
38
54
  * Default key bindings. Key names follow the view's normalization ("Mod" = Ctrl or Cmd). Word and
@@ -1 +1 @@
1
- {"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/state/commands.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAe,MAAM,mBAAmB,CAAC;AAIhF,OAAO,EACL,KAAK,OAAO,EAEZ,KAAK,WAAW,EAChB,MAAM,EAEP,MAAM,YAAY,CAAC;AAEpB,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAmCzC,eAAO,MAAM,eAAe,EAAE,OAG7B,CAAC;AAEF,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAiBhD;AAwBD,iHAAiH;AACjH,wBAAgB,cAAc,CAAC,IAAI,GAAE,UAAmB,GAAG,OAAO,CASjE;AAED,sGAAsG;AACtG,wBAAgB,aAAa,CAAC,IAAI,GAAE,UAAmB,GAAG,OAAO,CAShE;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE,OAW1B,CAAC;AAEF,kGAAkG;AAClG,eAAO,MAAM,WAAW,EAAE,OAYzB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,EAAE,OAaxB,CAAC;AAEF,sFAAsF;AACtF,eAAO,MAAM,eAAe,EAAE,OACY,CAAC;AAE3C,4EAA4E;AAC5E,eAAO,MAAM,eAAe,EAAE,OACY,CAAC;AAyB3C,eAAO,MAAM,SAAS,EAAE,OAGvB,CAAC;AAmBF;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI,GAAG,OAAO,CA+BjF;AAED,uFAAuF;AACvF,wBAAgB,YAAY,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAMjF;AAED,8FAA8F;AAC9F,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,EAAE,KAAK,GAAE,KAAK,GAAG,IAAW,GAAG,OAAO,CAczF;AAED;;;;GAIG;AACH,wBAAgB,UAAU,IAAI,MAAM,CAiBnC"}
1
+ {"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/state/commands.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,KAAK,EAIV,KAAK,QAAQ,EAEb,KAAK,QAAQ,EAGd,MAAM,mBAAmB,CAAC;AAO3B,OAAO,EACL,KAAK,OAAO,EAEZ,KAAK,WAAW,EAChB,MAAM,EAEP,MAAM,YAAY,CAAC;AAcpB,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAsBzC,eAAO,MAAM,eAAe,EAAE,OAG7B,CAAC;AAEF,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CA2BhD;AAwCD,iHAAiH;AACjH,wBAAgB,cAAc,CAAC,IAAI,GAAE,UAAmB,GAAG,OAAO,CAmBjE;AAED,sGAAsG;AACtG,wBAAgB,aAAa,CAAC,IAAI,GAAE,UAAmB,GAAG,OAAO,CAkBhE;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE,OAkB1B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,OAmBzB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,EAAE,OA6BxB,CAAC;AA6CF;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CA8BpF;AAED,+FAA+F;AAC/F,eAAO,MAAM,SAAS,EAAE,OAAiE,CAAC;AAE1F,sFAAsF;AACtF,eAAO,MAAM,eAAe,EAAE,OACY,CAAC;AAE3C,4EAA4E;AAC5E,eAAO,MAAM,eAAe,EAAE,OACY,CAAC;AAyB3C,eAAO,MAAM,SAAS,EAAE,OAGvB,CAAC;AAmBF;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI,GAAG,OAAO,CAgDjF;AAcD,uFAAuF;AACvF,wBAAgB,YAAY,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAcjF;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,EAAE,KAAK,GAAE,KAAK,GAAG,IAAW,GAAG,OAAO,CAUzF;AAED;;;;GAIG;AACH,wBAAgB,UAAU,IAAI,MAAM,CAyBnC"}