@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
package/src/schema.ts CHANGED
@@ -1,21 +1,80 @@
1
1
  import { Schema } from "./model/index.js";
2
2
 
3
3
  /**
4
- * Schema v1: the node and mark types a Foli document may contain, defined through the same
5
- * spec API third-party extensions use. The JSON types below describe the persisted shape of v1
6
- * content ({type, attrs, content, text, marks}); that shape is permanent.
4
+ * Schema v2: the node and mark types a Foli document may contain, defined through the same spec
5
+ * API third-party extensions use. The JSON types below describe the persisted shape of v2
6
+ * content ({type, attrs, content, text, marks}); that shape is permanent. v1 content (0.1.0) is
7
+ * valid v2 content: v2 only adds types and attributes with defaults.
7
8
  */
8
9
 
9
- export const MARK_TYPES = ["bold", "italic", "underline", "strike"] as const;
10
+ /** Marks without attributes. */
11
+ export const SIMPLE_MARK_TYPES = ["bold", "italic", "underline", "strike"] as const;
12
+ export type SimpleMarkName = (typeof SIMPLE_MARK_TYPES)[number];
13
+
14
+ /** Every mark type, in canonical order (the order of mark sets and of nesting when rendered). */
15
+ export const MARK_TYPES = ["link", ...SIMPLE_MARK_TYPES, "textColor", "highlight"] as const;
10
16
  export type MarkName = (typeof MARK_TYPES)[number];
11
17
 
12
18
  export const HEADING_LEVELS = [1, 2, 3, 4, 5, 6] as const;
13
19
  export type HeadingLevel = (typeof HEADING_LEVELS)[number];
14
20
 
15
- export const schema = new Schema({
21
+ /** `start` and `end` follow the text direction (left and right in left-to-right text). */
22
+ export const ALIGNMENTS = ["start", "center", "end", "justify"] as const;
23
+ export type Alignment = (typeof ALIGNMENTS)[number];
24
+
25
+ /** URL schemes a link may use; anything else (javascript:, data:, file:…) is rejected. */
26
+ export const SAFE_LINK_PROTOCOLS = ["http:", "https:", "mailto:", "tel:"] as const;
27
+
28
+ /**
29
+ * Whether `href` may be stored in a link: an absolute URL with a safe protocol, or a relative
30
+ * URL (path, `?query`, `#fragment`, `//host`). Rejects control characters and spaces anywhere
31
+ * (browsers strip tabs and newlines inside schemes, so `java\tscript:` would run) and
32
+ * backslashes (some browsers read `\\` as `//`).
33
+ */
34
+ export function isSafeHref(href: unknown): href is string {
35
+ if (typeof href !== "string" || !href || href.length > 8192) return false;
36
+ // Control characters, spaces and backslashes are never part of a URL we keep.
37
+ // biome-ignore lint/suspicious/noControlCharactersInRegex: matching control characters is the point.
38
+ if (/[\u0000- \u007f-\u009f\\]/.test(href)) return false;
39
+ const scheme = /^([a-zA-Z][a-zA-Z0-9+.-]*):/.exec(href);
40
+ if (!scheme) return true; // relative
41
+ return (SAFE_LINK_PROTOCOLS as readonly string[]).includes(`${scheme[1]?.toLowerCase()}:`);
42
+ }
43
+
44
+ /**
45
+ * Whether a link's attributes may come in from outside the document (a command, a paste from
46
+ * elsewhere): a safe `href`, or none with a bookmark (`anchor`, schema v3: Word's table of
47
+ * contents and cross-references).
48
+ */
49
+ export function isSafeLink(
50
+ attrs: { href?: unknown; anchor?: unknown } | null | undefined,
51
+ ): boolean {
52
+ if (attrs?.href === null || attrs?.href === undefined) return typeof attrs?.anchor === "string";
53
+ return isSafeHref(attrs.href);
54
+ }
55
+
56
+ /** Whether `color` is a canonical color value: `#rrggbb`, lowercase. */
57
+ export function isColor(color: unknown): color is string {
58
+ return typeof color === "string" && /^#[0-9a-f]{6}$/.test(color);
59
+ }
60
+
61
+ const align = {
62
+ default: "start",
63
+ validate: (value: unknown) =>
64
+ (ALIGNMENTS as readonly unknown[]).includes(value)
65
+ ? undefined
66
+ : `align must be one of ${ALIGNMENTS.join(", ")}`,
67
+ };
68
+
69
+ const color = {
70
+ validate: (value: unknown) =>
71
+ isColor(value) ? undefined : "color must be a lowercase #rrggbb value",
72
+ };
73
+
74
+ export const schemaV2 = new Schema({
16
75
  nodes: {
17
76
  doc: { content: "block+" },
18
- paragraph: { group: "block", content: "inline*" },
77
+ paragraph: { group: "block", content: "inline*", attrs: { align } },
19
78
  heading: {
20
79
  group: "block",
21
80
  content: "inline*",
@@ -26,21 +85,70 @@ export const schema = new Schema({
26
85
  ? undefined
27
86
  : "heading level must be an integer from 1 to 6",
28
87
  },
88
+ align,
89
+ },
90
+ },
91
+ bulletList: { group: "block", content: "listItem+" },
92
+ orderedList: {
93
+ group: "block",
94
+ content: "listItem+",
95
+ attrs: {
96
+ start: {
97
+ default: 1,
98
+ validate: (value) =>
99
+ Number.isInteger(value) && (value as number) >= 0 && (value as number) <= 99_999
100
+ ? undefined
101
+ : "start must be an integer from 0 to 99999",
102
+ },
29
103
  },
30
104
  },
105
+ // A list item starts with a paragraph; nested lists and other blocks may follow.
106
+ listItem: { content: "paragraph block*" },
107
+ horizontalRule: { group: "block" },
31
108
  text: { group: "inline" },
32
- hardBreak: { group: "inline", inline: true },
109
+ hardBreak: { group: "inline", inline: true, selectable: false },
33
110
  // An explicit page break: inline like a hard break (as in DOCX, `<w:br w:type="page"/>`);
34
111
  // the line it ends is the last on its page.
35
- pageBreak: { group: "inline", inline: true },
112
+ pageBreak: { group: "inline", inline: true, selectable: false },
113
+ },
114
+ marks: {
115
+ // First, so a link wraps the formatting inside it when rendered.
116
+ link: {
117
+ attrs: {
118
+ href: {
119
+ validate: (value) =>
120
+ isSafeHref(value)
121
+ ? undefined
122
+ : "href must be a relative URL or use http, https, mailto or tel",
123
+ },
124
+ },
125
+ inclusive: false,
126
+ },
127
+ bold: {},
128
+ italic: {},
129
+ underline: {},
130
+ strike: {},
131
+ textColor: { attrs: { color } },
132
+ highlight: { attrs: { color } },
36
133
  },
37
- marks: Object.fromEntries(MARK_TYPES.map((name) => [name, {}])),
38
134
  });
39
135
 
40
- export interface MarkNameJSON {
41
- type: MarkName;
136
+ export interface SimpleMarkJSON {
137
+ type: SimpleMarkName;
42
138
  }
43
139
 
140
+ export interface LinkMarkJSON {
141
+ type: "link";
142
+ attrs: { href: string };
143
+ }
144
+
145
+ export interface ColorMarkJSON {
146
+ type: "textColor" | "highlight";
147
+ attrs: { color: string };
148
+ }
149
+
150
+ export type MarkNameJSON = SimpleMarkJSON | LinkMarkJSON | ColorMarkJSON;
151
+
44
152
  export interface TextJSON {
45
153
  type: "text";
46
154
  text: string;
@@ -59,18 +167,45 @@ export interface PageBreakJSON {
59
167
 
60
168
  export type InlineJSON = TextJSON | HardBreakJSON | PageBreakJSON;
61
169
 
170
+ /** Attributes equal to their default (`align: "start"`, `start: 1`) are omitted. */
62
171
  export interface ParagraphJSON {
63
172
  type: "paragraph";
173
+ attrs?: { align?: Alignment };
64
174
  content?: InlineJSON[];
65
175
  }
66
176
 
67
177
  export interface HeadingJSON {
68
178
  type: "heading";
69
- attrs: { level: HeadingLevel };
179
+ attrs: { level: HeadingLevel; align?: Alignment };
70
180
  content?: InlineJSON[];
71
181
  }
72
182
 
73
- export type BlockJSON = ParagraphJSON | HeadingJSON;
183
+ export interface ListItemJSON {
184
+ type: "listItem";
185
+ content: [ParagraphJSON, ...BlockJSON[]];
186
+ }
187
+
188
+ export interface BulletListJSON {
189
+ type: "bulletList";
190
+ content: ListItemJSON[];
191
+ }
192
+
193
+ export interface OrderedListJSON {
194
+ type: "orderedList";
195
+ attrs?: { start?: number };
196
+ content: ListItemJSON[];
197
+ }
198
+
199
+ export interface HorizontalRuleJSON {
200
+ type: "horizontalRule";
201
+ }
202
+
203
+ export type BlockJSON =
204
+ | ParagraphJSON
205
+ | HeadingJSON
206
+ | BulletListJSON
207
+ | OrderedListJSON
208
+ | HorizontalRuleJSON;
74
209
 
75
210
  export interface DocJSON {
76
211
  type: "doc";
@@ -0,0 +1,22 @@
1
+ import { TransformError } from "../transform/transform.js";
2
+ import type { EditorState, Transaction } from "./state.js";
3
+
4
+ /** @internal Runs `build`; a TransformError, or a transaction that changes nothing, does not apply. */
5
+ export function attempt(
6
+ state: EditorState,
7
+ dispatch: ((tr: Transaction) => void) | undefined,
8
+ build: (tr: Transaction) => void,
9
+ ): boolean {
10
+ const tr = state.tr;
11
+ try {
12
+ build(tr);
13
+ } catch (error) {
14
+ if (error instanceof TransformError) return false;
15
+ throw error;
16
+ }
17
+ if (!tr.docChanged && tr.selection.eq(state.selection) && tr.storedMarks === state.storedMarks) {
18
+ return false;
19
+ }
20
+ dispatch?.(tr);
21
+ return true;
22
+ }