@ckeditor/ckeditor5-autosave 36.0.1 → 37.0.0-alpha.0

package/build/autosave.js

@@ -2,4 +2,4 @@
 /*!
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
- */(()=>{var t={704:(t,e,i)=>{t.exports=i(79)("./src/core.js")},209:(t,e,i)=>{t.exports=i(79)("./src/utils.js")},79:t=>{"use strict";t.exports=CKEditor5.dll}},e={};function i(n){var s=e[n];if(void 0!==s)return s.exports;var o=e[n]={exports:{}};return t[n](o,o.exports,i),o.exports}i.d=(t,e)=>{for(var n in e)i.o(e,n)&&!i.o(t,n)&&Object.defineProperty(t,n,{enumerable:!0,get:e[n]})},i.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e),i.r=t=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})};var n={};(()=>{"use strict";i.r(n),i.d(n,{Autosave:()=>L});var t=i(704),e=i(209);const s=function(t){var e=typeof t;return null!=t&&("object"==e||"function"==e)};const o="object"==typeof global&&global&&global.Object===Object&&global;var r="object"==typeof self&&self&&self.Object===Object&&self;const a=o||r||Function("return this")();const c=function(){return a.Date.now()};var u=/\s/;const d=function(t){for(var e=t.length;e--&&u.test(t.charAt(e)););return e};var l=/^\s+/;const h=function(t){return t?t.slice(0,d(t)+1).replace(l,""):t};const v=a.Symbol;var f=Object.prototype,m=f.hasOwnProperty,g=f.toString,p=v?v.toStringTag:void 0;const _=function(t){var e=m.call(t,p),i=t[p];try{t[p]=void 0;var n=!0}catch(t){}var s=g.call(t);return n&&(e?t[p]=i:delete t[p]),s};var b=Object.prototype.toString;const y=function(t){return b.call(t)};var S="[object Null]",j="[object Undefined]",O=v?v.toStringTag:void 0;const T=function(t){return null==t?void 0===t?j:S:O&&O in Object(t)?_(t):y(t)};const w=function(t){return null!=t&&"object"==typeof t};var P="[object Symbol]";const A=function(t){return"symbol"==typeof t||w(t)&&T(t)==P};var x=NaN,E=/^[-+]0x[0-9a-f]+$/i,I=/^0b[01]+$/i,C=/^0o[0-7]+$/i,D=parseInt;const N=function(t){if("number"==typeof t)return t;if(A(t))return x;if(s(t)){var e="function"==typeof t.valueOf?t.valueOf():t;t=s(e)?e+"":e}if("string"!=typeof t)return 0===t?t:+t;t=h(t);var i=I.test(t);return i||C.test(t)?D(t.slice(2),i?2:8):E.test(t)?x:+t};var k="Expected a function",M=Math.max,K=Math.min;const V=function(t,e,i){var n,o,r,a,u,d,l=0,h=!1,v=!1,f=!0;if("function"!=typeof t)throw new TypeError(k);function m(e){var i=n,s=o;return n=o=void 0,l=e,a=t.apply(s,i)}function g(t){var i=t-d;return void 0===d||i>=e||i<0||v&&t-l>=r}function p(){var t=c();if(g(t))return _(t);u=setTimeout(p,function(t){var i=e-(t-d);return v?K(i,r-(t-l)):i}(t))}function _(t){return u=void 0,f&&n?m(t):(n=o=void 0,a)}function b(){var t=c(),i=g(t);if(n=arguments,o=this,d=t,i){if(void 0===u)return function(t){return l=t,u=setTimeout(p,e),h?m(t):a}(d);if(v)return clearTimeout(u),u=setTimeout(p,e),m(d)}return void 0===u&&(u=setTimeout(p,e)),a}return e=N(e)||0,s(i)&&(h=!!i.leading,r=(v="maxWait"in i)?M(N(i.maxWait)||0,e):r,f="trailing"in i?!!i.trailing:f),b.cancel=function(){void 0!==u&&clearTimeout(u),l=0,n=d=o=u=void 0},b.flush=function(){return void 0===u?a:_(c())},b};class L extends t.Plugin{static get pluginName(){return"Autosave"}static get requires(){return[t.PendingActions]}constructor(i){super(i);const n=i.config.get("autosave")||{},s=n.waitingTime||1e3;this.set("state","synchronized"),this._debouncedSave=V(this._save.bind(this),s),this._lastDocumentVersion=i.model.document.version,this._savePromise=null,this._domEmitter=Object.create(e.DomEmitterMixin),this._config=n,this._pendingActions=i.plugins.get(t.PendingActions),this._makeImmediateSave=!1}init(){const t=this.editor,e=t.model.document;this.listenTo(t,"ready",(()=>{this.listenTo(e,"change:data",((t,e)=>{this._saveCallbacks.length&&e.isLocal&&("synchronized"===this.state&&(this.state="waiting",this._setPendingAction()),"waiting"===this.state&&this._debouncedSave())}))})),this.listenTo(t,"destroy",(()=>this._flush()),{priority:"highest"}),this._domEmitter.listenTo(window,"beforeunload",((t,e)=>{this._pendingActions.hasAny&&(e.returnValue=this._pendingActions.first.message)}))}destroy(){this._domEmitter.stopListening(),super.destroy()}save(){return this._debouncedSave.cancel(),this._save()}_flush(){this._debouncedSave.flush()}_save(){return this._savePromise?(this._makeImmediateSave=this.editor.model.document.version>this._lastDocumentVersion,this._savePromise):(this._setPendingAction(),this.state="saving",this._lastDocumentVersion=this.editor.model.document.version,this._savePromise=Promise.resolve().then((()=>Promise.all(this._saveCallbacks.map((t=>t(this.editor)))))).finally((()=>{this._savePromise=null})).then((()=>{if(this._makeImmediateSave)return this._makeImmediateSave=!1,this._save();this.editor.model.document.version>this._lastDocumentVersion?(this.state="waiting",this._debouncedSave()):(this.state="synchronized",this._pendingActions.remove(this._action),this._action=null)})).catch((t=>{throw this.state="error",this.state="saving",this._debouncedSave(),t})),this._savePromise)}_setPendingAction(){const t=this.editor.t;this._action||(this._action=this._pendingActions.add(t("Saving changes")))}get _saveCallbacks(){const t=[];return this.adapter&&this.adapter.save&&t.push(this.adapter.save),this._config.save&&t.push(this._config.save),t}}(0,e.mix)(L,e.ObservableMixin)})(),(window.CKEditor5=window.CKEditor5||{}).autosave=n})();
+ */(()=>{var t={704:(t,e,i)=>{t.exports=i(79)("./src/core.js")},209:(t,e,i)=>{t.exports=i(79)("./src/utils.js")},79:t=>{"use strict";t.exports=CKEditor5.dll}},e={};function i(n){var s=e[n];if(void 0!==s)return s.exports;var o=e[n]={exports:{}};return t[n](o,o.exports,i),o.exports}i.d=(t,e)=>{for(var n in e)i.o(e,n)&&!i.o(t,n)&&Object.defineProperty(t,n,{enumerable:!0,get:e[n]})},i.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e),i.r=t=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})};var n={};(()=>{"use strict";i.r(n),i.d(n,{Autosave:()=>L});var t=i(704),e=i(209);const s=function(t){var e=typeof t;return null!=t&&("object"==e||"function"==e)};const o="object"==typeof global&&global&&global.Object===Object&&global;var r="object"==typeof self&&self&&self.Object===Object&&self;const a=o||r||Function("return this")();const c=function(){return a.Date.now()};var u=/\s/;const l=function(t){for(var e=t.length;e--&&u.test(t.charAt(e)););return e};var d=/^\s+/;const h=function(t){return t?t.slice(0,l(t)+1).replace(d,""):t};const v=a.Symbol;var f=Object.prototype,m=f.hasOwnProperty,g=f.toString,_=v?v.toStringTag:void 0;const p=function(t){var e=m.call(t,_),i=t[_];try{t[_]=void 0;var n=!0}catch(t){}var s=g.call(t);return n&&(e?t[_]=i:delete t[_]),s};var b=Object.prototype.toString;const y=function(t){return b.call(t)};var S="[object Null]",T="[object Undefined]",j=v?v.toStringTag:void 0;const w=function(t){return null==t?void 0===t?T:S:j&&j in Object(t)?p(t):y(t)};const O=function(t){return null!=t&&"object"==typeof t};var P="[object Symbol]";const A=function(t){return"symbol"==typeof t||O(t)&&w(t)==P};var x=NaN,E=/^[-+]0x[0-9a-f]+$/i,I=/^0b[01]+$/i,C=/^0o[0-7]+$/i,D=parseInt;const N=function(t){if("number"==typeof t)return t;if(A(t))return x;if(s(t)){var e="function"==typeof t.valueOf?t.valueOf():t;t=s(e)?e+"":e}if("string"!=typeof t)return 0===t?t:+t;t=h(t);var i=I.test(t);return i||C.test(t)?D(t.slice(2),i?2:8):E.test(t)?x:+t};var k="Expected a function",K=Math.max,M=Math.min;const V=function(t,e,i){var n,o,r,a,u,l,d=0,h=!1,v=!1,f=!0;if("function"!=typeof t)throw new TypeError(k);function m(e){var i=n,s=o;return n=o=void 0,d=e,a=t.apply(s,i)}function g(t){var i=t-l;return void 0===l||i>=e||i<0||v&&t-d>=r}function _(){var t=c();if(g(t))return p(t);u=setTimeout(_,function(t){var i=e-(t-l);return v?M(i,r-(t-d)):i}(t))}function p(t){return u=void 0,f&&n?m(t):(n=o=void 0,a)}function b(){var t=c(),i=g(t);if(n=arguments,o=this,l=t,i){if(void 0===u)return function(t){return d=t,u=setTimeout(_,e),h?m(t):a}(l);if(v)return clearTimeout(u),u=setTimeout(_,e),m(l)}return void 0===u&&(u=setTimeout(_,e)),a}return e=N(e)||0,s(i)&&(h=!!i.leading,r=(v="maxWait"in i)?K(N(i.maxWait)||0,e):r,f="trailing"in i?!!i.trailing:f),b.cancel=function(){void 0!==u&&clearTimeout(u),d=0,n=l=o=u=void 0},b.flush=function(){return void 0===u?a:p(c())},b};class L extends t.Plugin{static get pluginName(){return"Autosave"}static get requires(){return[t.PendingActions]}constructor(i){super(i),this._action=null;const n=i.config.get("autosave")||{},s=n.waitingTime||1e3;this.set("state","synchronized"),this._debouncedSave=V(this._save.bind(this),s),this._lastDocumentVersion=i.model.document.version,this._savePromise=null,this._domEmitter=new((0,e.DomEmitterMixin)()),this._config=n,this._pendingActions=i.plugins.get(t.PendingActions),this._makeImmediateSave=!1}init(){const t=this.editor,e=t.model.document;this.listenTo(t,"ready",(()=>{this.listenTo(e,"change:data",((t,e)=>{this._saveCallbacks.length&&e.isLocal&&("synchronized"===this.state&&(this.state="waiting",this._setPendingAction()),"waiting"===this.state&&this._debouncedSave())}))})),this.listenTo(t,"destroy",(()=>this._flush()),{priority:"highest"}),this._domEmitter.listenTo(window,"beforeunload",((t,e)=>{this._pendingActions.hasAny&&(e.returnValue=this._pendingActions.first.message)}))}destroy(){this._domEmitter.stopListening(),super.destroy()}save(){return this._debouncedSave.cancel(),this._save()}_flush(){this._debouncedSave.flush()}_save(){return this._savePromise?(this._makeImmediateSave=this.editor.model.document.version>this._lastDocumentVersion,this._savePromise):(this._setPendingAction(),this.state="saving",this._lastDocumentVersion=this.editor.model.document.version,this._savePromise=Promise.resolve().then((()=>Promise.all(this._saveCallbacks.map((t=>t(this.editor)))))).finally((()=>{this._savePromise=null})).then((()=>{if(this._makeImmediateSave)return this._makeImmediateSave=!1,this._save();this.editor.model.document.version>this._lastDocumentVersion?(this.state="waiting",this._debouncedSave()):(this.state="synchronized",this._pendingActions.remove(this._action),this._action=null)})).catch((t=>{throw this.state="error",this.state="saving",this._debouncedSave(),t})),this._savePromise)}_setPendingAction(){const t=this.editor.t;this._action||(this._action=this._pendingActions.add(t("Saving changes")))}get _saveCallbacks(){const t=[];return this.adapter&&this.adapter.save&&t.push(this.adapter.save),this._config.save&&t.push(this._config.save),t}}})(),(window.CKEditor5=window.CKEditor5||{}).autosave=n})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-autosave",
-  "version": "36.0.1",
+  "version": "37.0.0-alpha.0",
   "description": "Autosave feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,16 +12,17 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "^36.0.1",
+    "ckeditor5": "^37.0.0-alpha.0",
     "lodash-es": "^4.17.15"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-core": "^36.0.1",
-    "@ckeditor/ckeditor5-dev-utils": "^32.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^36.0.1",
-    "@ckeditor/ckeditor5-paragraph": "^36.0.1",
-    "@ckeditor/ckeditor5-source-editing": "^36.0.1",
-    "@ckeditor/ckeditor5-theme-lark": "^36.0.1",
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-dev-utils": "^34.0.0",
+    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-source-editing": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.0",
+    "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"
   },
@@ -40,13 +41,17 @@
   },
   "files": [
     "lang",
-    "src",
+    "src/**/*.js",
+    "src/**/*.d.ts",
     "theme",
     "build",
     "ckeditor5-metadata.json",
     "CHANGELOG.md"
   ],
   "scripts": {
-    "dll:build": "webpack"
-  }
+    "dll:build": "webpack",
+    "build": "tsc -p ./tsconfig.release.json",
+    "postversion": "npm run build"
+  },
+  "types": "src/index.d.ts"
 }

package/src/autosave.d.ts

@@ -0,0 +1,233 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module autosave/autosave
+ */
+import { Plugin, type PluginDependencies, type Editor } from 'ckeditor5/src/core';
+/**
+ * The {@link module:autosave/autosave~Autosave} plugin allows you to automatically save the data (e.g. send it to the server)
+ * when needed (when the user changed the content).
+ *
+ * It listens to the {@link module:engine/model/document~Document#event:change:data `editor.model.document#change:data`}
+ * and `window#beforeunload` events and calls the
+ * {@link module:autosave/autosave~AutosaveAdapter#save `config.autosave.save()`} function.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( document.querySelector( '#editor' ), {
+ * 		plugins: [ ArticlePluginSet, Autosave ],
+ * 		toolbar: [ 'heading', '|', 'bold', 'italic', 'link', 'bulletedList', 'numberedList', 'blockQuote', 'undo', 'redo' ],
+ * 		image: {
+ * 			toolbar: [ 'imageStyle:block', 'imageStyle:side', '|', 'toggleImageCaption', 'imageTextAlternative' ],
+ * 		},
+ * 		autosave: {
+ * 			save( editor: Editor ) {
+ * 				// The saveData() function must return a promise
+ * 				// which should be resolved when the data is successfully saved.
+ * 				return saveData( editor.getData() );
+ * 			}
+ * 		}
+ * 	} );
+ *	```
+ *
+ * Read more about this feature in the {@glink installation/getting-started/getting-and-setting-data#autosave-feature Autosave feature}
+ * section of the {@glink installation/getting-started/getting-and-setting-data Saving and getting data}.
+ */
+export default class Autosave extends Plugin {
+    /**
+     * The adapter is an object with a `save()` method. That method will be called whenever
+     * the data changes. It might be called some time after the change,
+     * since the event is throttled for performance reasons.
+     */
+    adapter?: AutosaveAdapter;
+    /**
+     * The state of this plugin.
+     *
+     * The plugin can be in the following states:
+     *
+     * * synchronized – When all changes are saved.
+     * * waiting – When the plugin is waiting for other changes before calling `adapter#save()` and `config.autosave.save()`.
+     * * saving – When the provided save method is called and the plugin waits for the response.
+     * * error &ndash When the provided save method will throw an error. This state immediately changes to the `saving` state and
+     * the save method will be called again in the short period of time.
+     *
+     * @observable
+     * @readonly
+     */
+    state: 'synchronized' | 'waiting' | 'saving' | 'error';
+    /**
+     * Debounced save method. The `save()` method is called the specified `waitingTime` after `debouncedSave()` is called,
+     * unless a new action happens in the meantime.
+     */
+    private _debouncedSave;
+    /**
+     * The last saved document version.
+     */
+    private _lastDocumentVersion;
+    /**
+     * Promise used for asynchronous save calls.
+     *
+     * Created to handle the autosave call to an external data source. It resolves when that call is finished. It is re-used if
+     * save is called before the promise has been resolved. It is set to `null` if there is no call in progress.
+     */
+    private _savePromise;
+    /**
+     * DOM emitter.
+     */
+    private _domEmitter;
+    /**
+     * The configuration of this plugins.
+     */
+    private _config;
+    /**
+     * Editor's pending actions manager.
+     */
+    private _pendingActions;
+    /**
+     * Informs whether there should be another autosave callback performed, immediately after current autosave callback finishes.
+     *
+     * This is set to `true` when there is a save request while autosave callback is already being processed
+     * and the model has changed since the last save.
+     */
+    private _makeImmediateSave;
+    /**
+     * An action that will be added to the pending action manager for actions happening in that plugin.
+     */
+    private _action;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'Autosave';
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Immediately calls autosave callback. All previously queued (debounced) callbacks are cleared. If there is already an autosave
+     * callback in progress, then the requested save will be performed immediately after the current callback finishes.
+     *
+     * @returns A promise that will be resolved when the autosave callback is finished.
+     */
+    save(): Promise<void>;
+    /**
+     * Invokes the remaining `_save()` method call.
+     */
+    private _flush;
+    /**
+     * If the adapter is set and a new document version exists,
+     * the `_save()` method creates a pending action and calls the `adapter.save()` method.
+     * It waits for the result and then removes the created pending action.
+     *
+     * @returns A promise that will be resolved when the autosave callback is finished.
+     */
+    private _save;
+    /**
+     * Creates a pending action if it is not set already.
+     */
+    private _setPendingAction;
+    /**
+     * Saves callbacks.
+     */
+    private get _saveCallbacks();
+}
+/**
+ * An interface that requires the `save()` method.
+ *
+ * Used by {@link module:autosave/autosave~Autosave#adapter}.
+ */
+export interface AutosaveAdapter {
+    /**
+     * The method that will be called when the data changes. It should return a promise (e.g. in case of saving content to the database),
+     * so the autosave plugin will wait for that action before removing it from pending actions.
+     */
+    save(editor: Editor): Promise<unknown>;
+}
+/**
+ * The configuration of the {@link module:autosave/autosave~Autosave autosave feature}.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		autosave: {
+ * 			save( editor: Editor ) {
+ * 				// The saveData() function must return a promise
+ * 				// which should be resolved when the data is successfully saved.
+ * 				return saveData( editor.getData() );
+ * 			}
+ * 		}
+ * 	} );
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
+ *
+ * See also the demo of the {@glink installation/getting-started/getting-and-setting-data#autosave-feature autosave feature}.
+ */
+export interface AutosaveConfig {
+    /**
+     * The callback to be executed when the data needs to be saved.
+     *
+     * This function must return a promise which should be resolved when the data is successfully saved.
+     *
+     * ```ts
+     * ClassicEditor
+     * 	.create( editorElement, {
+     * 		autosave: {
+     * 			save( editor: Editor ) {
+     * 				return saveData( editor.getData() );
+     * 			}
+     * 		}
+     * 	} );
+     * 	.then( ... )
+     * 	.catch( ... );
+     * ```
+     */
+    save?: (editor: Editor) => Promise<unknown>;
+    /**
+     * The minimum amount of time that needs to pass after the last action to call the provided callback.
+     * By default it is 1000 ms.
+     *
+     * ```ts
+     * ClassicEditor
+     * 	.create( editorElement, {
+     * 		autosave: {
+     * 			save( editor: Editor ) {
+     * 				return saveData( editor.getData() );
+     * 			},
+     * 			waitingTime: 2000
+     * 		}
+     * 	} );
+     * 	.then( ... )
+     * 	.catch( ... );
+     * ```
+     */
+    waitingTime?: number;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [Autosave.pluginName]: Autosave;
+    }
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:autosave/autosave~Autosave autosave feature}.
+         *
+         * Read more in {@link module:autosave/autosave~AutosaveConfig}.
+         */
+        autosave?: AutosaveConfig;
+    }
+}

package/src/autosave.js

@@ -2,17 +2,13 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module autosave/autosave
  */
-
 import { Plugin, PendingActions } from 'ckeditor5/src/core';
-import { DomEmitterMixin, ObservableMixin, mix } from 'ckeditor5/src/utils';
+import { DomEmitterMixin } from 'ckeditor5/src/utils';
 import { debounce } from 'lodash-es';
-
 /* globals window */
-
 /**
  * The {@link module:autosave/autosave~Autosave} plugin allows you to automatically save the data (e.g. send it to the server)
  * when needed (when the user changed the content).
@@ -21,425 +17,213 @@ import { debounce } from 'lodash-es';
  * and `window#beforeunload` events and calls the
  * {@link module:autosave/autosave~AutosaveAdapter#save `config.autosave.save()`} function.
  *
- *		ClassicEditor
- *			.create( document.querySelector( '#editor' ), {
- *				plugins: [ ArticlePluginSet, Autosave ],
- *				toolbar: [ 'heading', '|', 'bold', 'italic', 'link', 'bulletedList', 'numberedList', 'blockQuote', 'undo', 'redo' ],
- *				image: {
- *					toolbar: [ 'imageStyle:block', 'imageStyle:side', '|', 'toggleImageCaption', 'imageTextAlternative' ],
- *				},
- *				autosave: {
- *					save( editor ) {
- *						// The saveData() function must return a promise
- *						// which should be resolved when the data is successfully saved.
- *						return saveData( editor.getData() );
- *					}
- *				}
- *			} );
+ * ```ts
+ * ClassicEditor
+ * 	.create( document.querySelector( '#editor' ), {
+ * 		plugins: [ ArticlePluginSet, Autosave ],
+ * 		toolbar: [ 'heading', '|', 'bold', 'italic', 'link', 'bulletedList', 'numberedList', 'blockQuote', 'undo', 'redo' ],
+ * 		image: {
+ * 			toolbar: [ 'imageStyle:block', 'imageStyle:side', '|', 'toggleImageCaption', 'imageTextAlternative' ],
+ * 		},
+ * 		autosave: {
+ * 			save( editor: Editor ) {
+ * 				// The saveData() function must return a promise
+ * 				// which should be resolved when the data is successfully saved.
+ * 				return saveData( editor.getData() );
+ * 			}
+ * 		}
+ * 	} );
+ *	```
  *
  * Read more about this feature in the {@glink installation/getting-started/getting-and-setting-data#autosave-feature Autosave feature}
  * section of the {@glink installation/getting-started/getting-and-setting-data Saving and getting data}.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class Autosave extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'Autosave';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ PendingActions ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	constructor( editor ) {
-		super( editor );
-
-		const config = editor.config.get( 'autosave' ) || {};
-
-		// A minimum amount of time that needs to pass after the last action.
-		// After that time the provided save callbacks are being called.
-		const waitingTime = config.waitingTime || 1000;
-
-		/**
-		 * The adapter is an object with a `save()` method. That method will be called whenever
-		 * the data changes. It might be called some time after the change,
-		 * since the event is throttled for performance reasons.
-		 *
-		 * @member {module:autosave/autosave~AutosaveAdapter} #adapter
-		 */
-
-		/**
-		 * The state of this plugin.
-		 *
-		 * The plugin can be in the following states:
-		 *
-		 * * synchronized – When all changes are saved.
-		 * * waiting – When the plugin is waiting for other changes before calling `adapter#save()` and `config.autosave.save()`.
-		 * * saving – When the provided save method is called and the plugin waits for the response.
-		 * * error &ndash When the provided save method will throw an error. This state immediately changes to the `saving` state and
-		 * the save method will be called again in the short period of time.
-		 *
-		 * @readonly
-		 * @member {'synchronized'|'waiting'|'saving'} #state
-		 */
-		this.set( 'state', 'synchronized' );
-
-		/**
-		 * Debounced save method. The `save()` method is called the specified `waitingTime` after `debouncedSave()` is called,
-		 * unless a new action happens in the meantime.
-		 *
-		 * @private
-		 * @type {Function}
-		 */
-		this._debouncedSave = debounce( this._save.bind( this ), waitingTime );
-
-		/**
-		 * The last saved document version.
-		 *
-		 * @private
-		 * @type {Number}
-		 */
-		this._lastDocumentVersion = editor.model.document.version;
-
-		/**
-		 * Promise used for asynchronous save calls.
-		 *
-		 * Created to handle the autosave call to an external data source. It resolves when that call is finished. It is re-used if
-		 * save is called before the promise has been resolved. It is set to `null` if there is no call in progress.
-		 *
-		 * @type {Promise|null}
-		 * @private
-		 */
-		this._savePromise = null;
-
-		/**
-		 * DOM emitter.
-		 *
-		 * @private
-		 * @type {DomEmitterMixin}
-		 */
-		this._domEmitter = Object.create( DomEmitterMixin );
-
-		/**
-		 * The configuration of this plugins.
-		 *
-		 * @private
-		 * @type {Object}
-		 */
-		this._config = config;
-
-		/**
-		 * Editor's pending actions manager.
-		 *
-		 * @private
-		 * @member {module:core/pendingactions~PendingActions} #_pendingActions
-		 */
-		this._pendingActions = editor.plugins.get( PendingActions );
-
-		/**
-		 * Informs whether there should be another autosave callback performed, immediately after current autosave callback finishes.
-		 *
-		 * This is set to `true` when there is a save request while autosave callback is already being processed
-		 * and the model has changed since the last save.
-		 *
-		 * @private
-		 * @type {Boolean}
-		 */
-		this._makeImmediateSave = false;
-
-		/**
-		 * An action that will be added to the pending action manager for actions happening in that plugin.
-		 *
-		 * @private
-		 * @member {Object} #_action
-		 */
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const editor = this.editor;
-		const doc = editor.model.document;
-
-		// Add the listener only after the editor is initialized to prevent firing save callback on data init.
-		this.listenTo( editor, 'ready', () => {
-			this.listenTo( doc, 'change:data', ( evt, batch ) => {
-				if ( !this._saveCallbacks.length ) {
-					return;
-				}
-
-				if ( !batch.isLocal ) {
-					return;
-				}
-
-				if ( this.state === 'synchronized' ) {
-					this.state = 'waiting';
-					// Set pending action already when we are waiting for the autosave callback.
-					this._setPendingAction();
-				}
-
-				if ( this.state === 'waiting' ) {
-					this._debouncedSave();
-				}
-
-				// If the plugin is in `saving` state, it will change its state later basing on the `document.version`.
-				// If the `document.version` will be higher than stored `#_lastDocumentVersion`, then it means, that some `change:data`
-				// event has fired in the meantime.
-			} );
-		} );
-
-		// Flush on the editor's destroy listener with the highest priority to ensure that
-		// `editor.getData()` will be called before plugins are destroyed.
-		this.listenTo( editor, 'destroy', () => this._flush(), { priority: 'highest' } );
-
-		// It's not possible to easy test it because karma uses `beforeunload` event
-		// to warn before full page reload and this event cannot be dispatched manually.
-		/* istanbul ignore next */
-		this._domEmitter.listenTo( window, 'beforeunload', ( evtInfo, domEvt ) => {
-			if ( this._pendingActions.hasAny ) {
-				domEvt.returnValue = this._pendingActions.first.message;
-			}
-		} );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	destroy() {
-		// There's no need for canceling or flushing the throttled save, as
-		// it's done on the editor's destroy event with the highest priority.
-
-		this._domEmitter.stopListening();
-		super.destroy();
-	}
-
-	/**
-	 * Immediately calls autosave callback. All previously queued (debounced) callbacks are cleared. If there is already an autosave
-	 * callback in progress, then the requested save will be performed immediately after the current callback finishes.
-	 *
-	 * @returns {Promise} A promise that will be resolved when the autosave callback is finished.
-	 */
-	save() {
-		this._debouncedSave.cancel();
-
-		return this._save();
-	}
-
-	/**
-	 * Invokes the remaining `_save()` method call.
-	 *
-	 * @protected
-	 */
-	_flush() {
-		this._debouncedSave.flush();
-	}
-
-	/**
-	 * If the adapter is set and a new document version exists,
-	 * the `_save()` method creates a pending action and calls the `adapter.save()` method.
-	 * It waits for the result and then removes the created pending action.
-	 *
-	 * @private
-	 * @returns {Promise} A promise that will be resolved when the autosave callback is finished.
-	 */
-	_save() {
-		if ( this._savePromise ) {
-			this._makeImmediateSave = this.editor.model.document.version > this._lastDocumentVersion;
-
-			return this._savePromise;
-		}
-
-		// Make sure there is a pending action (in case if `_save()` was called through manual `save()` call).
-		this._setPendingAction();
-
-		this.state = 'saving';
-		this._lastDocumentVersion = this.editor.model.document.version;
-
-		// Wait one promise cycle to be sure that save callbacks are not called inside a conversion or when the editor's state changes.
-		this._savePromise = Promise.resolve()
-			// Make autosave callback.
-			.then( () => Promise.all(
-				this._saveCallbacks.map( cb => cb( this.editor ) )
-			) )
-			// When the autosave callback is finished, always clear `this._savePromise`, no matter if it was successful or not.
-			.finally( () => {
-				this._savePromise = null;
-			} )
-			// If the save was successful, we have three scenarios:
-			//
-			// 1. If a save was requested when an autosave callback was already processed, we need to immediately call
-			// another autosave callback. In this case, `this._savePromise` will not be resolved until the next callback is done.
-			// 2. Otherwise, if changes happened to the model, make a delayed autosave callback (like the change just happened).
-			// 3. If no changes happened to the model, return to the `synchronized` state.
-			.then( () => {
-				if ( this._makeImmediateSave ) {
-					this._makeImmediateSave = false;
-
-					// Start another autosave callback. Return a promise that will be resolved after the new autosave callback.
-					// This way promises returned by `_save()` will not be resolved until all changes are saved.
-					//
-					// If `save()` was called when another (most often automatic) autosave callback was already processed,
-					// the promise returned by `save()` call will be resolved only after new changes have been saved.
-					//
-					// Note that it would not work correctly if `this._savePromise` is not cleared.
-					return this._save();
-				} else {
-					if ( this.editor.model.document.version > this._lastDocumentVersion ) {
-						this.state = 'waiting';
-						this._debouncedSave();
-					} else {
-						this.state = 'synchronized';
-						this._pendingActions.remove( this._action );
-						this._action = null;
-					}
-				}
-			} )
-			// In case of an error, retry the autosave callback after a delay (and also throw the original error).
-			.catch( err => {
-				// Change state to `error` so that listeners handling autosave error can be called.
-				this.state = 'error';
-				// Then, immediately change to the `saving` state as described above.
-				// Being in the `saving` state ensures that the autosave callback won't be delayed further by the `change:data` listener.
-				this.state = 'saving';
-
-				this._debouncedSave();
-
-				throw err;
-			} );
-
-		return this._savePromise;
-	}
-
-	/**
-	 * Creates a pending action if it is not set already.
-	 *
-	 * @private
-	 */
-	_setPendingAction() {
-		const t = this.editor.t;
-
-		if ( !this._action ) {
-			this._action = this._pendingActions.add( t( 'Saving changes' ) );
-		}
-	}
-
-	/**
-	 * Saves callbacks.
-	 *
-	 * @private
-	 * @type {Array.<Function>}
-	 */
-	get _saveCallbacks() {
-		const saveCallbacks = [];
-
-		if ( this.adapter && this.adapter.save ) {
-			saveCallbacks.push( this.adapter.save );
-		}
-
-		if ( this._config.save ) {
-			saveCallbacks.push( this._config.save );
-		}
-
-		return saveCallbacks;
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Autosave';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [PendingActions];
+    }
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        /**
+         * An action that will be added to the pending action manager for actions happening in that plugin.
+         */
+        this._action = null;
+        const config = editor.config.get('autosave') || {};
+        // A minimum amount of time that needs to pass after the last action.
+        // After that time the provided save callbacks are being called.
+        const waitingTime = config.waitingTime || 1000;
+        this.set('state', 'synchronized');
+        this._debouncedSave = debounce(this._save.bind(this), waitingTime);
+        this._lastDocumentVersion = editor.model.document.version;
+        this._savePromise = null;
+        this._domEmitter = new (DomEmitterMixin())();
+        this._config = config;
+        this._pendingActions = editor.plugins.get(PendingActions);
+        this._makeImmediateSave = false;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const doc = editor.model.document;
+        // Add the listener only after the editor is initialized to prevent firing save callback on data init.
+        this.listenTo(editor, 'ready', () => {
+            this.listenTo(doc, 'change:data', (evt, batch) => {
+                if (!this._saveCallbacks.length) {
+                    return;
+                }
+                if (!batch.isLocal) {
+                    return;
+                }
+                if (this.state === 'synchronized') {
+                    this.state = 'waiting';
+                    // Set pending action already when we are waiting for the autosave callback.
+                    this._setPendingAction();
+                }
+                if (this.state === 'waiting') {
+                    this._debouncedSave();
+                }
+                // If the plugin is in `saving` state, it will change its state later basing on the `document.version`.
+                // If the `document.version` will be higher than stored `#_lastDocumentVersion`, then it means, that some `change:data`
+                // event has fired in the meantime.
+            });
+        });
+        // Flush on the editor's destroy listener with the highest priority to ensure that
+        // `editor.getData()` will be called before plugins are destroyed.
+        this.listenTo(editor, 'destroy', () => this._flush(), { priority: 'highest' });
+        // It's not possible to easy test it because karma uses `beforeunload` event
+        // to warn before full page reload and this event cannot be dispatched manually.
+        /* istanbul ignore next */
+        this._domEmitter.listenTo(window, 'beforeunload', (evtInfo, domEvt) => {
+            if (this._pendingActions.hasAny) {
+                domEvt.returnValue = this._pendingActions.first.message;
+            }
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    destroy() {
+        // There's no need for canceling or flushing the throttled save, as
+        // it's done on the editor's destroy event with the highest priority.
+        this._domEmitter.stopListening();
+        super.destroy();
+    }
+    /**
+     * Immediately calls autosave callback. All previously queued (debounced) callbacks are cleared. If there is already an autosave
+     * callback in progress, then the requested save will be performed immediately after the current callback finishes.
+     *
+     * @returns A promise that will be resolved when the autosave callback is finished.
+     */
+    save() {
+        this._debouncedSave.cancel();
+        return this._save();
+    }
+    /**
+     * Invokes the remaining `_save()` method call.
+     */
+    _flush() {
+        this._debouncedSave.flush();
+    }
+    /**
+     * If the adapter is set and a new document version exists,
+     * the `_save()` method creates a pending action and calls the `adapter.save()` method.
+     * It waits for the result and then removes the created pending action.
+     *
+     * @returns A promise that will be resolved when the autosave callback is finished.
+     */
+    _save() {
+        if (this._savePromise) {
+            this._makeImmediateSave = this.editor.model.document.version > this._lastDocumentVersion;
+            return this._savePromise;
+        }
+        // Make sure there is a pending action (in case if `_save()` was called through manual `save()` call).
+        this._setPendingAction();
+        this.state = 'saving';
+        this._lastDocumentVersion = this.editor.model.document.version;
+        // Wait one promise cycle to be sure that save callbacks are not called inside a conversion or when the editor's state changes.
+        this._savePromise = Promise.resolve()
+            // Make autosave callback.
+            .then(() => Promise.all(this._saveCallbacks.map(cb => cb(this.editor))))
+            // When the autosave callback is finished, always clear `this._savePromise`, no matter if it was successful or not.
+            .finally(() => {
+            this._savePromise = null;
+        })
+            // If the save was successful, we have three scenarios:
+            //
+            // 1. If a save was requested when an autosave callback was already processed, we need to immediately call
+            // another autosave callback. In this case, `this._savePromise` will not be resolved until the next callback is done.
+            // 2. Otherwise, if changes happened to the model, make a delayed autosave callback (like the change just happened).
+            // 3. If no changes happened to the model, return to the `synchronized` state.
+            .then(() => {
+            if (this._makeImmediateSave) {
+                this._makeImmediateSave = false;
+                // Start another autosave callback. Return a promise that will be resolved after the new autosave callback.
+                // This way promises returned by `_save()` will not be resolved until all changes are saved.
+                //
+                // If `save()` was called when another (most often automatic) autosave callback was already processed,
+                // the promise returned by `save()` call will be resolved only after new changes have been saved.
+                //
+                // Note that it would not work correctly if `this._savePromise` is not cleared.
+                return this._save();
+            }
+            else {
+                if (this.editor.model.document.version > this._lastDocumentVersion) {
+                    this.state = 'waiting';
+                    this._debouncedSave();
+                }
+                else {
+                    this.state = 'synchronized';
+                    this._pendingActions.remove(this._action);
+                    this._action = null;
+                }
+            }
+        })
+            // In case of an error, retry the autosave callback after a delay (and also throw the original error).
+            .catch(err => {
+            // Change state to `error` so that listeners handling autosave error can be called.
+            this.state = 'error';
+            // Then, immediately change to the `saving` state as described above.
+            // Being in the `saving` state ensures that the autosave callback won't be delayed further by the `change:data` listener.
+            this.state = 'saving';
+            this._debouncedSave();
+            throw err;
+        });
+        return this._savePromise;
+    }
+    /**
+     * Creates a pending action if it is not set already.
+     */
+    _setPendingAction() {
+        const t = this.editor.t;
+        if (!this._action) {
+            this._action = this._pendingActions.add(t('Saving changes'));
+        }
+    }
+    /**
+     * Saves callbacks.
+     */
+    get _saveCallbacks() {
+        const saveCallbacks = [];
+        if (this.adapter && this.adapter.save) {
+            saveCallbacks.push(this.adapter.save);
+        }
+        if (this._config.save) {
+            saveCallbacks.push(this._config.save);
+        }
+        return saveCallbacks;
+    }
 }
-
-mix( Autosave, ObservableMixin );
-
-/**
- * An interface that requires the `save()` method.
- *
- * Used by {@link module:autosave/autosave~Autosave#adapter}.
- *
- * @interface module:autosave/autosave~AutosaveAdapter
- */
-
-/**
- * The method that will be called when the data changes. It should return a promise (e.g. in case of saving content to the database),
- * so the autosave plugin will wait for that action before removing it from pending actions.
- *
- * @method #save
- * @param {module:core/editor/editor~Editor} editor The editor instance.
- * @returns {Promise.<*>}
- */
-
-/**
- * The configuration of the {@link module:autosave/autosave~Autosave autosave feature}.
- *
- * Read more in {@link module:autosave/autosave~AutosaveConfig}.
- *
- * @member {module:autosave/autosave~AutosaveConfig} module:core/editor/editorconfig~EditorConfig#autosave
- */
-
-/**
- * The configuration of the {@link module:autosave/autosave~Autosave autosave feature}.
- *
- *		ClassicEditor
- *			.create( editorElement, {
- *				autosave: {
- *					save( editor ) {
- *						// The saveData() function must return a promise
- *						// which should be resolved when the data is successfully saved.
- *						return saveData( editor.getData() );
- *					}
- *				}
- *			} );
- *			.then( ... )
- *			.catch( ... );
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
- *
- * See also the demo of the {@glink installation/getting-started/getting-and-setting-data#autosave-feature autosave feature}.
- *
- * @interface AutosaveConfig
- */
-
-/**
- * The callback to be executed when the data needs to be saved.
- *
- * This function must return a promise which should be resolved when the data is successfully saved.
- *
- *		ClassicEditor
- *			.create( editorElement, {
- *				autosave: {
- *					save( editor ) {
- *						return saveData( editor.getData() );
- *					}
- *				}
- *			} );
- *			.then( ... )
- *			.catch( ... );
- *
- * @method module:autosave/autosave~AutosaveConfig#save
- * @param {module:core/editor/editor~Editor} editor The editor instance.
- * @returns {Promise.<*>}
- */
-
-/**
- * The minimum amount of time that needs to pass after the last action to call the provided callback.
- * By default it is 1000 ms.
- *
- *		ClassicEditor
- *			.create( editorElement, {
- *				autosave: {
- *					save( editor ) {
- *						return saveData( editor.getData() );
- *					},
- *					waitingTime: 2000
- *				}
- *			} );
- *			.then( ... )
- *			.catch( ... );
- *
- * @member {Number} module:autosave/autosave~AutosaveConfig#waitingTime
- */

package/src/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module autosave
+ */
+export { default as Autosave } from './autosave';

package/src/index.js

@@ -2,9 +2,7 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module autosave
  */
-
 export { default as Autosave } from './autosave';