@folijs/react 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.
package/dist/editor.js CHANGED
@@ -7,8 +7,9 @@ import { createContext, useCallback, useContext, useEffect, useLayoutEffect, use
7
7
  */
8
8
  export const useIsomorphicLayoutEffect = typeof document === "undefined" ? useEffect : useLayoutEffect;
9
9
  /**
10
- * A headless `Editor` (state, commands, history) owned by the calling component: created on the
11
- * first render and kept for its lifetime. Later changes to `options` are ignored.
10
+ * A headless `Editor` (state, commands, history) of a schema v3 document, owned by the calling
11
+ * component: created on the first render and kept for its lifetime. Later changes to `options`
12
+ * are ignored. Throws FoliDocumentError when `initialContent` is not a valid document.
12
13
  */
13
14
  export function useFoliEditor(options = {}) {
14
15
  const [editor] = useState(() => {
@@ -1 +1 @@
1
- {"version":3,"file":"editor.js","sourceRoot":"","sources":["../src/editor.tsx"],"names":[],"mappings":";AAAA,OAAO,EACL,YAAY,GAKb,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,aAAa,EAEb,WAAW,EACX,UAAU,EACV,SAAS,EACT,eAAe,EACf,MAAM,EACN,QAAQ,EACR,oBAAoB,GACrB,MAAM,OAAO,CAAC;AAEf;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GACpC,OAAO,QAAQ,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC;AAShE;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,OAAO,GAAyB,EAAE;IAC9D,MAAM,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE;QAC7B,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QACtD,OAAO,YAAY,CAAC,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;IACtF,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,aAAa,GAAG,aAAa,CAAgB,IAAI,CAAC,CAAC;AAEzD,iGAAiG;AACjG,MAAM,UAAU,kBAAkB,CAAC,EACjC,MAAM,EACN,QAAQ,GAIT;IACC,OAAO,KAAC,aAAa,CAAC,QAAQ,IAAC,KAAK,EAAE,MAAM,YAAG,QAAQ,GAA0B,CAAC;AACpF,CAAC;AAED,4FAA4F;AAC5F,MAAM,UAAU,gBAAgB;IAC9B,MAAM,MAAM,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC;IACzC,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;IAC5F,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,kBAAkB,CAAC,MAA0B,EAAE,MAAc;IAC3E,MAAM,OAAO,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,MAAM,IAAI,OAAO,CAAC;IAChC,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,MAAM,wDAAwD,CAAC,CAAC;IAC/F,OAAO,KAAK,CAAC;AACf,CAAC;AASD;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAC5B,QAAmD,EACnD,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC,EAAE,EAAE,GAA6B,EAAE;IAErE,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;IAC3D,6FAA6F;IAC7F,6FAA6F;IAC7F,MAAM,IAAI,GAAG,MAAM,CAA6D,IAAI,CAAC,CAAC;IACtF,MAAM,SAAS,GAAG,WAAW,CAAC,CAAC,MAAkB,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1F,MAAM,WAAW,GAAG,GAAG,EAAE;QACvB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;QAC9B,IAAI,QAAQ,EAAE,KAAK,KAAK,KAAK,IAAI,QAAQ,CAAC,QAAQ,KAAK,QAAQ;YAAE,OAAO,QAAQ,CAAC,KAAK,CAAC;QACvF,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;QACjF,IAAI,CAAC,OAAO,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IACF,OAAO,oBAAoB,CAAC,SAAS,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;AACnE,CAAC"}
1
+ {"version":3,"file":"editor.js","sourceRoot":"","sources":["../src/editor.tsx"],"names":[],"mappings":";AAAA,OAAO,EACL,YAAY,GAKb,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,aAAa,EAEb,WAAW,EACX,UAAU,EACV,SAAS,EACT,eAAe,EACf,MAAM,EACN,QAAQ,EACR,oBAAoB,GACrB,MAAM,OAAO,CAAC;AAEf;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GACpC,OAAO,QAAQ,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC;AAahE;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,OAAO,GAAyB,EAAE;IAC9D,MAAM,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE;QAC7B,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QACtD,OAAO,YAAY,CAAC,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;IACtF,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,aAAa,GAAG,aAAa,CAAgB,IAAI,CAAC,CAAC;AAEzD,iGAAiG;AACjG,MAAM,UAAU,kBAAkB,CAAC,EACjC,MAAM,EACN,QAAQ,GAIT;IACC,OAAO,KAAC,aAAa,CAAC,QAAQ,IAAC,KAAK,EAAE,MAAM,YAAG,QAAQ,GAA0B,CAAC;AACpF,CAAC;AAED,4FAA4F;AAC5F,MAAM,UAAU,gBAAgB;IAC9B,MAAM,MAAM,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC;IACzC,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;IAC5F,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,kBAAkB,CAAC,MAA0B,EAAE,MAAc;IAC3E,MAAM,OAAO,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,MAAM,IAAI,OAAO,CAAC;IAChC,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,MAAM,wDAAwD,CAAC,CAAC;IAC/F,OAAO,KAAK,CAAC;AACf,CAAC;AASD;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAC5B,QAAmD,EACnD,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC,EAAE,EAAE,GAA6B,EAAE;IAErE,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;IAC3D,6FAA6F;IAC7F,6FAA6F;IAC7F,MAAM,IAAI,GAAG,MAAM,CAA6D,IAAI,CAAC,CAAC;IACtF,MAAM,SAAS,GAAG,WAAW,CAAC,CAAC,MAAkB,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1F,MAAM,WAAW,GAAG,GAAG,EAAE;QACvB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;QAC9B,IAAI,QAAQ,EAAE,KAAK,KAAK,KAAK,IAAI,QAAQ,CAAC,QAAQ,KAAK,QAAQ;YAAE,OAAO,QAAQ,CAAC,KAAK,CAAC;QACvF,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;QACjF,IAAI,CAAC,OAAO,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IACF,OAAO,oBAAoB,CAAC,SAAS,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;AACnE,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@folijs/react",
3
- "version": "0.1.0",
3
+ "version": "0.3.0",
4
4
  "description": "React components for the Foli document editor.",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -29,8 +29,8 @@
29
29
  "!src/**/*.test.*"
30
30
  ],
31
31
  "dependencies": {
32
- "@folijs/core": "^0.1.0",
33
- "@folijs/view": "^0.1.0"
32
+ "@folijs/view": "^0.3.0",
33
+ "@folijs/core": "^0.3.0"
34
34
  },
35
35
  "peerDependencies": {
36
36
  "react": "^18.2.0 || ^19.0.0",
@@ -1,10 +1,10 @@
1
1
  import {
2
- createDocument,
3
- type DocJSON,
4
2
  type Editor,
3
+ type EditorDocument,
5
4
  type FoliDocument,
6
5
  type Plugin,
7
6
  type Transaction,
7
+ wordContext,
8
8
  } from "@folijs/core";
9
9
  import { forwardRef, type ReactNode, useImperativeHandle, useRef } from "react";
10
10
  import { FoliEditorProvider, useFoliEditor, useIsomorphicLayoutEffect } from "./editor.js";
@@ -21,14 +21,17 @@ export interface FoliChange {
21
21
  readonly transactions: readonly Transaction[];
22
22
  /**
23
23
  * The whole document right after this change, serialized on first read (keep reads out of
24
- * the hot path of typing: a debounced save reads only the last change's).
24
+ * the hot path of typing: a debounced save reads only the last change's). Schema v3.
25
25
  */
26
26
  readonly document: FoliDocument;
27
27
  }
28
28
 
29
29
  export interface FoliEditorProps extends Omit<FoliCanvasProps, "editor"> {
30
- /** Read once on mount. To load another document later: `editor.setDocument()` or a new `key`. */
31
- initialContent?: FoliDocument | undefined;
30
+ /**
31
+ * Read once on mount: a document of any version (0.1.0 and 0.2.0 documents are migrated to
32
+ * schema v3). To load another document later: `editor.setDocument()` or a new `key`.
33
+ */
34
+ initialContent?: EditorDocument | undefined;
32
35
  /** Read once on mount. */
33
36
  plugins?: readonly Plugin[] | undefined;
34
37
  /**
@@ -73,13 +76,15 @@ export const FoliEditor = forwardRef<FoliEditorHandle, FoliEditorProps>(function
73
76
  const listener = onChangeRef.current;
74
77
  if (!listener || !transactions.some((tr) => tr.docChanged)) return;
75
78
  // The state is immutable: keeping it makes a later read give this change's document.
76
- const { settings } = editor;
77
79
  let document: FoliDocument | undefined;
78
80
  listener({
79
81
  editor,
80
82
  transactions,
81
83
  get document() {
82
- document ??= createDocument(state.doc.toJSON() as DocJSON, settings);
84
+ document ??= {
85
+ ...(structuredClone(wordContext(state)?.envelope) as Omit<FoliDocument, "content">),
86
+ content: state.doc.toJSON(),
87
+ };
83
88
  return document;
84
89
  },
85
90
  });