@lexical/file 0.15.0 → 0.16.0

package/LexicalFile.dev.js

@@ -10,7 +10,7 @@
 
 var lexical = require('lexical');
 
-var version = "0.15.0";
+var version = "0.16.0";
 
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
@@ -20,6 +20,32 @@ var version = "0.15.0";
  *
  */
 
+/**
+ * Generates a SerializedDocument from the given EditorState
+ * @param editorState - the EditorState to serialize
+ * @param config - An object that optionally contains source and lastSaved.
+ * source defaults to Lexical and lastSaved defaults to the current time in
+ * epoch milliseconds.
+ */
+function serializedDocumentFromEditorState(editorState, config = Object.freeze({})) {
+  return {
+    editorState: editorState.toJSON(),
+    lastSaved: config.lastSaved || Date.now(),
+    source: config.source || 'Lexical',
+    version
+  };
+}
+
+/**
+ * Parse an EditorState from the given editor and document
+ *
+ * @param editor - The lexical editor
+ * @param maybeStringifiedDocument - The contents of a .lexical file (as a JSON string, or already parsed)
+ */
+function editorStateFromSerializedDocument(editor, maybeStringifiedDocument) {
+  const json = typeof maybeStringifiedDocument === 'string' ? JSON.parse(maybeStringifiedDocument) : maybeStringifiedDocument;
+  return editor.parseEditorState(json.editorState);
+}
 
 /**
  * Takes a file and inputs its content into the editor state as an input field.
@@ -27,9 +53,7 @@ var version = "0.15.0";
  */
 function importFile(editor) {
   readTextFileFromSystem(text => {
-    const json = JSON.parse(text);
-    const editorState = editor.parseEditorState(JSON.stringify(json.editorState));
-    editor.setEditorState(editorState);
+    editor.setEditorState(editorStateFromSerializedDocument(editor, text));
     editor.dispatchCommand(lexical.CLEAR_HISTORY_COMMAND, undefined);
   });
 }
@@ -53,23 +77,21 @@ function readTextFileFromSystem(callback) {
   });
   input.click();
 }
+
 /**
  * Generates a .lexical file to be downloaded by the browser containing the current editor state.
  * @param editor - The lexical editor.
  * @param config - An object that optionally contains fileName and source. fileName defaults to
- * the current date (as a string) and source defaults to lexical.
+ * the current date (as a string) and source defaults to Lexical.
  */
 function exportFile(editor, config = Object.freeze({})) {
   const now = new Date();
-  const editorState = editor.getEditorState();
-  const documentJSON = {
-    editorState: editorState,
-    lastSaved: now.getTime(),
-    source: config.source || 'Lexical',
-    version
-  };
+  const serializedDocument = serializedDocumentFromEditorState(editor.getEditorState(), {
+    ...config,
+    lastSaved: now.getTime()
+  });
   const fileName = config.fileName || now.toISOString();
-  exportBlob(documentJSON, `${fileName}.lexical`);
+  exportBlob(serializedDocument, `${fileName}.lexical`);
 }
 
 // Adapted from https://stackoverflow.com/a/19328891/2013580
@@ -93,5 +115,7 @@ function exportBlob(data, fileName) {
   a.remove();
 }
 
+exports.editorStateFromSerializedDocument = editorStateFromSerializedDocument;
 exports.exportFile = exportFile;
 exports.importFile = importFile;
+exports.serializedDocumentFromEditorState = serializedDocumentFromEditorState;

package/LexicalFile.dev.mjs

@@ -8,7 +8,7 @@
 
 import { CLEAR_HISTORY_COMMAND } from 'lexical';
 
-var version = "0.15.0";
+var version = "0.16.0";
 
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
@@ -18,6 +18,32 @@ var version = "0.15.0";
  *
  */
 
+/**
+ * Generates a SerializedDocument from the given EditorState
+ * @param editorState - the EditorState to serialize
+ * @param config - An object that optionally contains source and lastSaved.
+ * source defaults to Lexical and lastSaved defaults to the current time in
+ * epoch milliseconds.
+ */
+function serializedDocumentFromEditorState(editorState, config = Object.freeze({})) {
+  return {
+    editorState: editorState.toJSON(),
+    lastSaved: config.lastSaved || Date.now(),
+    source: config.source || 'Lexical',
+    version
+  };
+}
+
+/**
+ * Parse an EditorState from the given editor and document
+ *
+ * @param editor - The lexical editor
+ * @param maybeStringifiedDocument - The contents of a .lexical file (as a JSON string, or already parsed)
+ */
+function editorStateFromSerializedDocument(editor, maybeStringifiedDocument) {
+  const json = typeof maybeStringifiedDocument === 'string' ? JSON.parse(maybeStringifiedDocument) : maybeStringifiedDocument;
+  return editor.parseEditorState(json.editorState);
+}
 
 /**
  * Takes a file and inputs its content into the editor state as an input field.
@@ -25,9 +51,7 @@ var version = "0.15.0";
  */
 function importFile(editor) {
   readTextFileFromSystem(text => {
-    const json = JSON.parse(text);
-    const editorState = editor.parseEditorState(JSON.stringify(json.editorState));
-    editor.setEditorState(editorState);
+    editor.setEditorState(editorStateFromSerializedDocument(editor, text));
     editor.dispatchCommand(CLEAR_HISTORY_COMMAND, undefined);
   });
 }
@@ -51,23 +75,21 @@ function readTextFileFromSystem(callback) {
   });
   input.click();
 }
+
 /**
  * Generates a .lexical file to be downloaded by the browser containing the current editor state.
  * @param editor - The lexical editor.
  * @param config - An object that optionally contains fileName and source. fileName defaults to
- * the current date (as a string) and source defaults to lexical.
+ * the current date (as a string) and source defaults to Lexical.
  */
 function exportFile(editor, config = Object.freeze({})) {
   const now = new Date();
-  const editorState = editor.getEditorState();
-  const documentJSON = {
-    editorState: editorState,
-    lastSaved: now.getTime(),
-    source: config.source || 'Lexical',
-    version
-  };
+  const serializedDocument = serializedDocumentFromEditorState(editor.getEditorState(), {
+    ...config,
+    lastSaved: now.getTime()
+  });
   const fileName = config.fileName || now.toISOString();
-  exportBlob(documentJSON, `${fileName}.lexical`);
+  exportBlob(serializedDocument, `${fileName}.lexical`);
 }
 
 // Adapted from https://stackoverflow.com/a/19328891/2013580
@@ -91,4 +113,4 @@ function exportBlob(data, fileName) {
   a.remove();
 }
 
-export { exportFile, importFile };
+export { editorStateFromSerializedDocument, exportFile, importFile, serializedDocumentFromEditorState };

package/LexicalFile.mjs

@@ -9,5 +9,7 @@
 import * as modDev from './LexicalFile.dev.mjs';
 import * as modProd from './LexicalFile.prod.mjs';
 const mod = process.env.NODE_ENV === 'development' ? modDev : modProd;
+export const editorStateFromSerializedDocument = mod.editorStateFromSerializedDocument;
 export const exportFile = mod.exportFile;
-export const importFile = mod.importFile;
+export const importFile = mod.importFile;
+export const serializedDocumentFromEditorState = mod.serializedDocumentFromEditorState;

package/LexicalFile.node.mjs

@@ -7,5 +7,7 @@
  */
 
 const mod = await (process.env.NODE_ENV === 'development' ? import('./LexicalFile.dev.mjs') : import('./LexicalFile.prod.mjs'));
+export const editorStateFromSerializedDocument = mod.editorStateFromSerializedDocument;
 export const exportFile = mod.exportFile;
-export const importFile = mod.importFile;
+export const importFile = mod.importFile;
+export const serializedDocumentFromEditorState = mod.serializedDocumentFromEditorState;

package/LexicalFile.prod.js

@@ -6,6 +6,7 @@
  *
  */
 
-'use strict';var f=require("lexical");function g(a){let c=document.createElement("input");c.type="file";c.accept=".lexical";c.addEventListener("change",b=>{b=b.target;if(b.files){b=b.files[0];let d=new FileReader;d.readAsText(b,"UTF-8");d.onload=e=>{e.target&&a(e.target.result)}}});c.click()}
-exports.exportFile=function(a,c=Object.freeze({})){var b=new Date;a={editorState:a.getEditorState(),lastSaved:b.getTime(),source:c.source||"Lexical",version:"0.15.0"};{c=`${c.fileName||b.toISOString()}.lexical`;b=document.createElement("a");let d=document.body;null!==d&&(d.appendChild(b),b.style.display="none",a=JSON.stringify(a),a=new Blob([a],{type:"octet/stream"}),a=window.URL.createObjectURL(a),b.href=a,b.download=c,b.click(),window.URL.revokeObjectURL(a),b.remove())}};
-exports.importFile=function(a){g(c=>{c=JSON.parse(c);c=a.parseEditorState(JSON.stringify(c.editorState));a.setEditorState(c);a.dispatchCommand(f.CLEAR_HISTORY_COMMAND,void 0)})}
+'use strict';var e=require("lexical");function f(a,b=Object.freeze({})){return{editorState:a.toJSON(),lastSaved:b.lastSaved||Date.now(),source:b.source||"Lexical",version:"0.16.0"}}function h(a,b){b="string"===typeof b?JSON.parse(b):b;return a.parseEditorState(b.editorState)}
+function k(a){let b=document.createElement("input");b.type="file";b.accept=".lexical";b.addEventListener("change",c=>{c=c.target;if(c.files){c=c.files[0];let d=new FileReader;d.readAsText(c,"UTF-8");d.onload=g=>{g.target&&a(g.target.result)}}});b.click()}exports.editorStateFromSerializedDocument=h;
+exports.exportFile=function(a,b=Object.freeze({})){var c=new Date;a=f(a.getEditorState(),{...b,lastSaved:c.getTime()});{b=`${b.fileName||c.toISOString()}.lexical`;c=document.createElement("a");let d=document.body;null!==d&&(d.appendChild(c),c.style.display="none",a=JSON.stringify(a),a=new Blob([a],{type:"octet/stream"}),a=window.URL.createObjectURL(a),c.href=a,c.download=b,c.click(),window.URL.revokeObjectURL(a),c.remove())}};
+exports.importFile=function(a){k(b=>{a.setEditorState(h(a,b));a.dispatchCommand(e.CLEAR_HISTORY_COMMAND,void 0)})};exports.serializedDocumentFromEditorState=f

package/LexicalFile.prod.mjs

@@ -6,4 +6,4 @@
  *
  */
 
-import{CLEAR_HISTORY_COMMAND as e}from"lexical";function t(t){!function(e){const t=document.createElement("input");t.type="file",t.accept=".lexical",t.addEventListener("change",(t=>{const n=t.target;if(n.files){const t=n.files[0],o=new FileReader;o.readAsText(t,"UTF-8"),o.onload=t=>{if(t.target){const n=t.target.result;e(n)}}}})),t.click()}((n=>{const o=JSON.parse(n),i=t.parseEditorState(JSON.stringify(o.editorState));t.setEditorState(i),t.dispatchCommand(e,void 0)}))}function n(e,t=Object.freeze({})){const n=new Date;!function(e,t){const n=document.createElement("a"),o=document.body;if(null===o)return;o.appendChild(n),n.style.display="none";const i=JSON.stringify(e),c=new Blob([i],{type:"octet/stream"}),a=window.URL.createObjectURL(c);n.href=a,n.download=t,n.click(),window.URL.revokeObjectURL(a),n.remove()}({editorState:e.getEditorState(),lastSaved:n.getTime(),source:t.source||"Lexical",version:"0.15.0"},`${t.fileName||n.toISOString()}.lexical`)}export{n as exportFile,t as importFile};
+import{CLEAR_HISTORY_COMMAND as e}from"lexical";var t="0.16.0";function n(e,n=Object.freeze({})){return{editorState:e.toJSON(),lastSaved:n.lastSaved||Date.now(),source:n.source||"Lexical",version:t}}function o(e,t){const n="string"==typeof t?JSON.parse(t):t;return e.parseEditorState(n.editorState)}function a(t){!function(e){const t=document.createElement("input");t.type="file",t.accept=".lexical",t.addEventListener("change",(t=>{const n=t.target;if(n.files){const t=n.files[0],o=new FileReader;o.readAsText(t,"UTF-8"),o.onload=t=>{if(t.target){const n=t.target.result;e(n)}}}})),t.click()}((n=>{t.setEditorState(o(t,n)),t.dispatchCommand(e,void 0)}))}function i(e,t=Object.freeze({})){const o=new Date;!function(e,t){const n=document.createElement("a"),o=document.body;if(null===o)return;o.appendChild(n),n.style.display="none";const a=JSON.stringify(e),i=new Blob([a],{type:"octet/stream"}),c=window.URL.createObjectURL(i);n.href=c,n.download=t,n.click(),window.URL.revokeObjectURL(c),n.remove()}(n(e.getEditorState(),{...t,lastSaved:o.getTime()}),`${t.fileName||o.toISOString()}.lexical`)}export{o as editorStateFromSerializedDocument,i as exportFile,a as importFile,n as serializedDocumentFromEditorState};

package/fileImportExport.d.ts

@@ -5,7 +5,35 @@
  * LICENSE file in the root directory of this source tree.
  *
  */
-import type { LexicalEditor } from 'lexical';
+import type { EditorState, LexicalEditor, SerializedEditorState } from 'lexical';
+export interface SerializedDocument {
+    /** The serialized editorState produced by editorState.toJSON() */
+    editorState: SerializedEditorState;
+    /** The time this document was created in epoch milliseconds (Date.now()) */
+    lastSaved: number;
+    /** The source of the document, defaults to Lexical */
+    source: string | 'Lexical';
+    /** The version of Lexical that produced this document */
+    version: string;
+}
+/**
+ * Generates a SerializedDocument from the given EditorState
+ * @param editorState - the EditorState to serialize
+ * @param config - An object that optionally contains source and lastSaved.
+ * source defaults to Lexical and lastSaved defaults to the current time in
+ * epoch milliseconds.
+ */
+export declare function serializedDocumentFromEditorState(editorState: EditorState, config?: Readonly<{
+    source?: string;
+    lastSaved?: number;
+}>): SerializedDocument;
+/**
+ * Parse an EditorState from the given editor and document
+ *
+ * @param editor - The lexical editor
+ * @param maybeStringifiedDocument - The contents of a .lexical file (as a JSON string, or already parsed)
+ */
+export declare function editorStateFromSerializedDocument(editor: LexicalEditor, maybeStringifiedDocument: SerializedDocument | string): EditorState;
 /**
  * Takes a file and inputs its content into the editor state as an input field.
  * @param editor - The lexical editor.
@@ -15,7 +43,7 @@ export declare function importFile(editor: LexicalEditor): void;
  * Generates a .lexical file to be downloaded by the browser containing the current editor state.
  * @param editor - The lexical editor.
  * @param config - An object that optionally contains fileName and source. fileName defaults to
- * the current date (as a string) and source defaults to lexical.
+ * the current date (as a string) and source defaults to Lexical.
  */
 export declare function exportFile(editor: LexicalEditor, config?: Readonly<{
     fileName?: string;

package/index.d.ts

@@ -5,5 +5,4 @@
  * LICENSE file in the root directory of this source tree.
  *
  */
-import { exportFile, importFile } from './fileImportExport';
-export { exportFile, importFile };
+export { editorStateFromSerializedDocument, exportFile, importFile, type SerializedDocument, serializedDocumentFromEditorState, } from './fileImportExport';

package/package.json

@@ -10,7 +10,7 @@
     "export"
   ],
   "license": "MIT",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "main": "LexicalFile.js",
   "types": "index.d.ts",
   "repository": {
@@ -38,6 +38,6 @@
     }
   },
   "dependencies": {
-    "lexical": "0.15.0"
+    "lexical": "0.16.0"
   }
 }