editorjs-undo - npm Package Compare versions

Comparing version 1.0.1 to 2.0.0-rc.0

CHANGELOG.md

 # Changelog
 
+## 2.0.0-rc.0 (28.12.2022)
+* In the undo/redo actions the plugin now updates the involved block.
+* Update eslint-plugin-import to support eslint.
+* Solve linter errors.
+
 ## 1.0.1 (07.12.2021)
@@ -4,0 +9,0 @@ * Updated packages with known security breaches.

dist/bundle.js

@@ -1,1 +0,1 @@
-!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.Undo=e():t.Undo=e()}(self,(function(){return(()=>{"use strict";var t={d:(e,n)=>{for(var i in n)t.o(n,i)&&!t.o(e,i)&&Object.defineProperty(e,i,{enumerable:!0,get:n[i]})},o:(t,e)=>Object.prototype.hasOwnProperty.call(t,e)},e={};function n(t,e){for(var n=0;n<e.length;n++){var i=e[n];i.enumerable=i.enumerable||!1,i.configurable=!0,"value"in i&&(i.writable=!0),Object.defineProperty(t,i.key,i)}}t.d(e,{default:()=>s});var i=function(){function t(e,n){!function(t,e){if(!(t instanceof e))throw new TypeError("Cannot call a class as a function")}(this,t),this.holder=n,this.observer=null,this.debounceTimer=200,this.mutationDebouncer=this.debounce((function(){e()}),this.debounceTimer)}var e,i;return e=t,i=[{key:"setMutationObserver",value:function(){var t=this,e=this.holder;this.observer=new MutationObserver((function(e){t.mutationHandler(e)})),this.observer.observe(e,{childList:!0,attributes:!0,subtree:!0,characterData:!0,characterDataOldValue:!0})}},{key:"mutationHandler",value:function(t){var e=this,n=!1;t.forEach((function(t){switch(t.type){case"childList":t.target===e.holder?e.onDestroy():n=!0;break;case"characterData":n=!0;break;case"attributes":t.target.classList.contains("ce-block")||(n=!0)}})),n&&this.mutationDebouncer()}},{key:"debounce",value:function(t,e){var n,i=this;return function(){for(var o=arguments.length,s=new Array(o),r=0;r<o;r++)s[r]=arguments[r];var a=i;clearTimeout(n),n=setTimeout((function(){return t.apply(a,s)}),e)}}},{key:"onDestroy",value:function(){var t=new CustomEvent("destroy");document.dispatchEvent(t),this.observer.disconnect()}}],i&&n(e.prototype,i),t}();function o(t,e){for(var n=0;n<e.length;n++){var i=e[n];i.enumerable=i.enumerable||!1,i.configurable=!0,"value"in i&&(i.writable=!0),Object.defineProperty(t,i.key,i)}}var s=function(){function t(e){var n=this,o=e.editor,s=e.config,r=void 0===s?{}:s,a=e.onUpdate,c=e.maxLength;!function(t,e){if(!(t instanceof e))throw new TypeError("Cannot call a class as a function")}(this,t);var h={maxLength:30,onUpdate:function(){},config:{shortcuts:{undo:"CMD+Z",redo:"CMD+Y"}}},u=o.configuration,l=u.holder,d=h.config.shortcuts,f=r.shortcuts,v=void 0===f?d:f;this.holder="string"==typeof l?document.getElementById(l):l,this.editor=o,this.shouldSaveHistory=!0,this.readOnly=u.readOnly,this.maxLength=c||h.maxLength,this.onUpdate=a||h.onUpdate,this.config={shortcuts:v},new i((function(){return n.registerChange()}),this.holder).setMutationObserver(),this.setEventListeners(),this.initialItem=null,this.clear()}var e,n,s;return e=t,s=[{key:"isReadOnlySupported",get:function(){return!0}}],(n=[{key:"truncate",value:function(t,e){for(;t.length>e;)t.shift()}},{key:"initialize",value:function(t){var e="blocks"in t?t.blocks:t,n={index:e.length-1,state:e};this.stack[0]=n,this.initialItem=n}},{key:"clear",value:function(){this.stack=this.initialItem?[this.initialItem]:[{index:0,state:[{type:"paragraph",data:{text:""}}]}],this.position=0,this.onUpdate()}},{key:"registerChange",value:function(){var t=this;this.readOnly||(this.editor&&this.editor.save&&this.shouldSaveHistory&&this.editor.save().then((function(e){t.editorDidUpdate(e.blocks)&&t.save(e.blocks)})),this.shouldSaveHistory=!0)}},{key:"editorDidUpdate",value:function(t){var e=this.stack[this.position].state;return!!t.length&&(t.length!==e.length||JSON.stringify(e)!==JSON.stringify(t))}},{key:"save",value:function(t){this.position>=this.maxLength&&this.truncate(this.stack,this.maxLength),this.position=Math.min(this.position,this.stack.length-1),this.stack=this.stack.slice(0,this.position+1);var e=this.editor.blocks.getCurrentBlockIndex();this.stack.push({index:e,state:t}),this.position+=1,this.onUpdate()}},{key:"undo",value:function(){var t=this;if(this.canUndo()){this.shouldSaveHistory=!1;var e=this.stack[this.position-=1],n=e.index,i=e.state;this.onUpdate(),this.editor.blocks.render({blocks:i}).then((function(){return t.editor.caret.setToBlock(n,"end")}))}}},{key:"redo",value:function(){var t=this;if(this.canRedo()){this.shouldSaveHistory=!1;var e=this.stack[this.position+=1],n=e.index,i=e.state;this.onUpdate(),this.editor.blocks.render({blocks:i}).then((function(){return t.editor.caret.setToBlock(n,"end")}))}}},{key:"canUndo",value:function(){return!this.readOnly&&this.position>0}},{key:"canRedo",value:function(){return!this.readOnly&&this.position<this.count()}},{key:"count",value:function(){return this.stack.length-1}},{key:"parseKeys",value:function(t){var e={CMD:/(Mac)/i.test(navigator.platform)?"metaKey":"ctrlKey",ALT:"altKey",SHIFT:"shiftKey"},n=t.slice(0,-1).map((function(t){return e[t]})),i=n.includes("shiftKey")?t[t.length-1].toUpperCase():t[t.length-1].toLowerCase();return n.push(i),n}},{key:"setEventListeners",value:function(){var t=this,e=this.holder,n=this.config.shortcuts,i=n.undo,o=n.redo,s=i.replace(/ /g,"").split("+"),r=o.replace(/ /g,"").split("+"),a=this.parseKeys(s),c=this.parseKeys(r),h=function(t,e){return!(2!==e.length||!t[e[0]]||t.key!==e[1])||!(3!==e.length||!t[e[0]]||!t[e[1]]||t.key!==e[2])},u=function(e){h(e,a)&&(e.preventDefault(),t.undo())},l=function(e){h(e,c)&&(e.preventDefault(),t.redo())};e.addEventListener("keydown",u),e.addEventListener("keydown",l),e.addEventListener("destroy",(function(){e.removeEventListener("keydown",u),e.removeEventListener("keydown",l)}))}}])&&o(e.prototype,n),s&&o(e,s),t}();return e.default})()}));
+!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.Undo=e():t.Undo=e()}(self,(function(){return(()=>{"use strict";var t={d:(e,i)=>{for(var n in i)t.o(i,n)&&!t.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:i[n]})},o:(t,e)=>Object.prototype.hasOwnProperty.call(t,e)},e={};function i(t,e){for(var i=0;i<e.length;i++){var n=e[i];n.enumerable=n.enumerable||!1,n.configurable=!0,"value"in n&&(n.writable=!0),Object.defineProperty(t,n.key,n)}}t.d(e,{default:()=>o});var n=function(){function t(e,i){!function(t,e){if(!(t instanceof e))throw new TypeError("Cannot call a class as a function")}(this,t),this.holder=i,this.observer=null,this.debounceTimer=200,this.mutationDebouncer=this.debounce((function(){e()}),this.debounceTimer)}var e,n;return e=t,n=[{key:"setMutationObserver",value:function(){var t=this,e=this.holder;this.observer=new MutationObserver((function(e){t.mutationHandler(e)})),this.observer.observe(e,{childList:!0,attributes:!0,subtree:!0,characterData:!0,characterDataOldValue:!0})}},{key:"mutationHandler",value:function(t){var e=this,i=!1;t.forEach((function(t){switch(t.type){case"childList":t.target===e.holder?e.onDestroy():i=!0;break;case"characterData":i=!0;break;case"attributes":t.target.classList.contains("ce-block")||(i=!0)}})),i&&this.mutationDebouncer()}},{key:"debounce",value:function(t,e){var i,n=this;return function(){for(var s=arguments.length,o=new Array(s),r=0;r<s;r++)o[r]=arguments[r];var a=n;clearTimeout(i),i=setTimeout((function(){return t.apply(a,o)}),e)}}},{key:"onDestroy",value:function(){var t=new CustomEvent("destroy");document.dispatchEvent(t),this.observer.disconnect()}}],n&&i(e.prototype,n),t}();function s(t,e){for(var i=0;i<e.length;i++){var n=e[i];n.enumerable=n.enumerable||!1,n.configurable=!0,"value"in n&&(n.writable=!0),Object.defineProperty(t,n.key,n)}}var o=function(){function t(e){var i=this,s=e.editor,o=e.config,r=void 0===o?{}:o,a=e.onUpdate,c=e.maxLength;!function(t,e){if(!(t instanceof e))throw new TypeError("Cannot call a class as a function")}(this,t);var h={maxLength:30,onUpdate:function(){},config:{shortcuts:{undo:"CMD+Z",redo:"CMD+Y"}}},l=s.blocks,u=s.caret,d=s.configuration,f=d.holder,k=h.config.shortcuts,v=r.shortcuts,p=void 0===v?k:v;this.holder="string"==typeof f?document.getElementById(f):f,this.editor=s,this.blocks=l,this.caret=u,this.shouldSaveHistory=!0,this.readOnly=d.readOnly,this.maxLength=c||h.maxLength,this.onUpdate=a||h.onUpdate,this.config={shortcuts:p},new n((function(){return i.registerChange()}),this.holder).setMutationObserver(),this.setEventListeners(),this.initialItem=null,this.clear()}var e,i,o;return e=t,o=[{key:"isReadOnlySupported",get:function(){return!0}}],(i=[{key:"truncate",value:function(t,e){for(;t.length>e;)t.shift()}},{key:"initialize",value:function(t){var e="blocks"in t?t.blocks:t,i={index:e.length-1,state:e};this.stack[0]=i,this.initialItem=i}},{key:"clear",value:function(){this.stack=this.initialItem?[this.initialItem]:[{index:0,state:[{type:"paragraph",data:{text:""}}]}],this.position=0,this.onUpdate()}},{key:"registerChange",value:function(){var t=this;this.readOnly||(this.editor&&this.editor.save&&this.shouldSaveHistory&&this.editor.save().then((function(e){t.editorDidUpdate(e.blocks)&&t.save(e.blocks)})),this.shouldSaveHistory=!0)}},{key:"editorDidUpdate",value:function(t){var e=this.stack[this.position].state;return!!t.length&&(t.length!==e.length||JSON.stringify(e)!==JSON.stringify(t))}},{key:"save",value:function(t){this.position>=this.maxLength&&this.truncate(this.stack,this.maxLength),this.position=Math.min(this.position,this.stack.length-1),this.stack=this.stack.slice(0,this.position+1);var e=this.blocks.getCurrentBlockIndex();this.stack.push({index:e,state:t}),this.position+=1,this.onUpdate()}},{key:"insertDeletedBlock",value:function(t,e,i){for(var n=0;n<t.length;n+=1)if(!e[n]||t[n].id!==e[n].id){this.blocks.insert(t[n].type,t[n].data,{},n,!0),this.caret.setToBlock(i,"end");break}}},{key:"blockWasDropped",value:function(t,e){return t.length===e.length&&t.some((function(t,i){return t.id!==e[i].id}))}},{key:"blockWasSkipped",value:function(t,e,i,n){return t<e||i.length!==n.length}},{key:"blockWasDeleted",value:function(t,e){return t.length>e.length}},{key:"undo",value:function(){var t=this;if(this.canUndo()){this.shouldSaveHistory=!1;var e=this.stack[this.position-=1].index,i=this.stack[this.position].state,n=this.stack[this.position+1].index,s=this.stack[this.position+1].state;if(this.onUpdate(),i[e]||(e-=1,this.stack[this.position].index=e),this.blockWasDeleted(i,s))return void this.insertDeletedBlock(i,s,e);if(this.blockWasSkipped(e,n,i,s)&&0!==this.position)return this.blocks.delete(),void this.caret.setToBlock(e,"end");if(this.blockWasDropped(i,s)&&0!==this.position)return void this.blocks.render({blocks:i}).then((function(){return t.caret.setToBlock(e,"end")}));var o=this.blocks.getBlockByIndex(e).id;this.blocks.update(o,i[e].data),this.caret.setToBlock(e,"end")}}},{key:"redo",value:function(){var t=this;if(this.canRedo()){this.shouldSaveHistory=!1;var e=this.stack[this.position+=1],i=e.index,n=e.state,s=this.stack[this.position-1].index,o=this.stack[this.position-1].state;if(this.blockWasDeleted(o,n))return this.blocks.delete(),void this.caret.setToBlock(i,"end");if(this.blockWasSkipped(s,i,n,o))return this.blocks.insert(n[i].type,n[i].data,{},i,!0),void this.caret.setToBlock(i,"end");if(this.blockWasDropped(n,o)&&1!==this.position)return void this.blocks.render({blocks:n}).then((function(){return t.caret.setToBlock(i,"end")}));this.onUpdate();var r=(this.blocks.getBlockByIndex(i)||n[i]).id;this.blocks.update(r,n[i].data),this.caret.setToBlock(i,"end")}}},{key:"canUndo",value:function(){return!this.readOnly&&this.position>0}},{key:"canRedo",value:function(){return!this.readOnly&&this.position<this.count()}},{key:"count",value:function(){return this.stack.length-1}},{key:"parseKeys",value:function(t){var e={CMD:/(Mac)/i.test(navigator.platform)?"metaKey":"ctrlKey",ALT:"altKey",SHIFT:"shiftKey"},i=t.slice(0,-1).map((function(t){return e[t]})),n=i.includes("shiftKey")?t[t.length-1].toUpperCase():t[t.length-1].toLowerCase();return i.push(n),i}},{key:"setEventListeners",value:function(){var t=this,e=this.holder,i=this.config.shortcuts,n=i.undo,s=i.redo,o=n.replace(/ /g,"").split("+"),r=s.replace(/ /g,"").split("+"),a=this.parseKeys(o),c=this.parseKeys(r),h=function(t,e){return!(2!==e.length||!t[e[0]]||t.key!==e[1])||!(3!==e.length||!t[e[0]]||!t[e[1]]||t.key!==e[2])},l=function(e){h(e,a)&&(e.preventDefault(),t.undo())},u=function(e){h(e,c)&&(e.preventDefault(),t.redo())};e.addEventListener("keydown",l),e.addEventListener("keydown",u),e.addEventListener("destroy",(function(){e.removeEventListener("keydown",l),e.removeEventListener("keydown",u)}))}}])&&s(e.prototype,i),o&&s(e,o),t}();return e.default})()}));

package.json

 {
   "name": "editorjs-undo",
-  "version": "1.0.1",
+  "version": "2.0.0-rc.0",
   "keywords": [
@@ -37,3 +37,3 @@ "undo",
     "eslint-config-airbnb-base": "^14.1.0",
-    "eslint-plugin-import": "^2.20.2",
+    "eslint-plugin-import": "^2.25.2",
     "eslint-plugin-jest": "^23.13.2",
@@ -40,0 +40,0 @@ "jest": "^27.2.1",

README.md

@@ -10,11 +10,31 @@ ![](https://badgen.net/badge/Editor.js/v2.0/blue)
 ## Installation
-
 ### Install via NPM
 
+### 2.x.x (beta)
+
+This new version 2.0.0-rc.0 introduces breaking changes. Remember that this is a beta version.
+
+Please, report bugs or behavior issues :).
+
+#### What's new?
+* Overall plugin performance is improved, especially with large documents. 
+* Undo/Redo lifecycle is managed through block updates instead of a full document render.
+* Solves issues in documents with several images, for example the blink with undo/redo.
+
 Get the package
 
 ```shell
-$ npm i --save-dev editorjs-undo
+$ npm i --save-dev editorjs-undo@2.0.0-rc.0
 ```
 
+### 1.x.x (stable version)
+
+To install the latest v1 stable version
+
+Get the package
+
+```shell
+$ npm i --save-dev editorjs-undo@1.0.1
+```
+
 Include module in your application
@@ -21,0 +41,0 @@

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

26307

increased by9.04%

Number of lines in readme file

177

increased by12.74%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

No dependency changes