@wordpress/preferences-persistence 1.0.0

package/README.md

@@ -0,0 +1,59 @@
+# Preferences persistence
+
+Persistence utilities for `wordpress/preferences`.
+
+Includes a persistence layer that saves data to WordPress user meta via the REST API. If for any reason data cannot be saved to the database, this persistence layer also uses local storage as a fallback.
+
+## Installation
+
+Install the module
+
+```bash
+npm install @wordpress/preferences-persistence --save
+```
+
+_This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for such language features and APIs, you should include [the polyfill shipped in `@wordpress/babel-preset-default`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/babel-preset-default#polyfill) in your code._
+
+## Usage
+
+Call the `create` function to create a persistence layer.
+
+```js
+const persistenceLayer = create();
+```
+
+Next, configure the preferences package to use this persistence layer:
+
+```js
+wp.data( 'core/preferences' ).setPersistenceLayer( persistenceLayer );
+```
+
+## Reference
+
+<!-- START TOKEN(Autogenerated Docs|src/index.js) -->
+
+### create
+
+Creates a persistence layer that stores data in WordPress user meta via the
+REST API.
+
+_Parameters_
+
+-   _options_ `Object`:
+-   _options.preloadedData_ `?Object`: Any persisted preferences data that should be preloaded. When set, the persistence layer will avoid fetching data from the REST API.
+-   _options.localStorageRestoreKey_ `?string`: The key to use for restoring the localStorage backup, used when the persistence layer calls `localStorage.getItem` or `localStorage.setItem`.
+-   _options.requestDebounceMS_ `?number`: Debounce requests to the API so that they only occur at minimum every `requestDebounceMS` milliseconds, and don't swamp the server. Defaults to 2500ms.
+
+_Returns_
+
+-   `Object`: A persistence layer for WordPress user meta.
+
+<!-- END TOKEN(Autogenerated Docs|src/index.js) -->
+
+## Contributing to this package
+
+This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects.
+
+To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md).
+
+<br /><br /><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>

package/build/create/debounce-async.js

@@ -0,0 +1,80 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = debounceAsync;
+
+/**
+ * Performs a leading edge debounce of async functions.
+ *
+ * If three functions are throttled at the same time:
+ * - The first happens immediately.
+ * - The second is never called.
+ * - The third happens `delayMS` milliseconds after the first has resolved.
+ *
+ * This is distinct from `lodash.debounce` in that it waits for promise
+ * resolution.
+ *
+ * @param {Function} func    A function that returns a promise.
+ * @param {number}   delayMS A delay in milliseconds.
+ *
+ * @return {Function} A function that debounce whatever function is passed
+ *                    to it.
+ */
+function debounceAsync(func, delayMS) {
+  let timeoutId;
+  let activePromise;
+  return async function debounced() {
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
+    // This is a leading edge debounce. If there's no promise or timeout
+    // in progress, call the debounced function immediately.
+    if (!activePromise && !timeoutId) {
+      return new Promise((resolve, reject) => {
+        // Keep a reference to the promise.
+        activePromise = func(...args).then(function () {
+          resolve(...arguments);
+        }).catch(error => {
+          reject(error);
+        }).finally(() => {
+          // As soon this promise is complete, clear the way for the
+          // next one to happen immediately.
+          activePromise = null;
+        });
+      });
+    }
+
+    if (activePromise) {
+      // Let any active promises finish before queuing the next request.
+      await activePromise;
+    } // Clear any active timeouts, abandoning any requests that have
+    // been queued but not been made.
+
+
+    if (timeoutId) {
+      clearTimeout(timeoutId);
+      timeoutId = null;
+    } // Trigger any trailing edge calls to the function.
+
+
+    return new Promise((resolve, reject) => {
+      // Schedule the next request but with a delay.
+      timeoutId = setTimeout(() => {
+        activePromise = func(...args).then(function () {
+          resolve(...arguments);
+        }).catch(error => {
+          reject(error);
+        }).finally(() => {
+          // As soon this promise is complete, clear the way for the
+          // next one to happen immediately.
+          activePromise = null;
+          timeoutId = null;
+        });
+      }, delayMS);
+    });
+  };
+}
+//# sourceMappingURL=debounce-async.js.map

package/build/create/debounce-async.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences-persistence/src/create/debounce-async.js"],"names":["debounceAsync","func","delayMS","timeoutId","activePromise","debounced","args","Promise","resolve","reject","then","catch","error","finally","clearTimeout","setTimeout"],"mappings":";;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAASA,aAAT,CAAwBC,IAAxB,EAA8BC,OAA9B,EAAwC;AACtD,MAAIC,SAAJ;AACA,MAAIC,aAAJ;AAEA,SAAO,eAAeC,SAAf,GAAoC;AAAA,sCAAPC,IAAO;AAAPA,MAAAA,IAAO;AAAA;;AAC1C;AACA;AACA,QAAK,CAAEF,aAAF,IAAmB,CAAED,SAA1B,EAAsC;AACrC,aAAO,IAAII,OAAJ,CAAa,CAAEC,OAAF,EAAWC,MAAX,KAAuB;AAC1C;AACAL,QAAAA,aAAa,GAAGH,IAAI,CAAE,GAAGK,IAAL,CAAJ,CACdI,IADc,CACR,YAAmB;AACzBF,UAAAA,OAAO,CAAE,YAAF,CAAP;AACA,SAHc,EAIdG,KAJc,CAILC,KAAF,IAAa;AACpBH,UAAAA,MAAM,CAAEG,KAAF,CAAN;AACA,SANc,EAOdC,OAPc,CAOL,MAAM;AACf;AACA;AACAT,UAAAA,aAAa,GAAG,IAAhB;AACA,SAXc,CAAhB;AAYA,OAdM,CAAP;AAeA;;AAED,QAAKA,aAAL,EAAqB;AACpB;AACA,YAAMA,aAAN;AACA,KAxByC,CA0B1C;AACA;;;AACA,QAAKD,SAAL,EAAiB;AAChBW,MAAAA,YAAY,CAAEX,SAAF,CAAZ;AACAA,MAAAA,SAAS,GAAG,IAAZ;AACA,KA/ByC,CAiC1C;;;AACA,WAAO,IAAII,OAAJ,CAAa,CAAEC,OAAF,EAAWC,MAAX,KAAuB;AAC1C;AACAN,MAAAA,SAAS,GAAGY,UAAU,CAAE,MAAM;AAC7BX,QAAAA,aAAa,GAAGH,IAAI,CAAE,GAAGK,IAAL,CAAJ,CACdI,IADc,CACR,YAAmB;AACzBF,UAAAA,OAAO,CAAE,YAAF,CAAP;AACA,SAHc,EAIdG,KAJc,CAILC,KAAF,IAAa;AACpBH,UAAAA,MAAM,CAAEG,KAAF,CAAN;AACA,SANc,EAOdC,OAPc,CAOL,MAAM;AACf;AACA;AACAT,UAAAA,aAAa,GAAG,IAAhB;AACAD,UAAAA,SAAS,GAAG,IAAZ;AACA,SAZc,CAAhB;AAaA,OAdqB,EAcnBD,OAdmB,CAAtB;AAeA,KAjBM,CAAP;AAkBA,GApDD;AAqDA","sourcesContent":["/**\n * Performs a leading edge debounce of async functions.\n *\n * If three functions are throttled at the same time:\n * - The first happens immediately.\n * - The second is never called.\n * - The third happens `delayMS` milliseconds after the first has resolved.\n *\n * This is distinct from `lodash.debounce` in that it waits for promise\n * resolution.\n *\n * @param {Function} func    A function that returns a promise.\n * @param {number}   delayMS A delay in milliseconds.\n *\n * @return {Function} A function that debounce whatever function is passed\n *                    to it.\n */\nexport default function debounceAsync( func, delayMS ) {\n\tlet timeoutId;\n\tlet activePromise;\n\n\treturn async function debounced( ...args ) {\n\t\t// This is a leading edge debounce. If there's no promise or timeout\n\t\t// in progress, call the debounced function immediately.\n\t\tif ( ! activePromise && ! timeoutId ) {\n\t\t\treturn new Promise( ( resolve, reject ) => {\n\t\t\t\t// Keep a reference to the promise.\n\t\t\t\tactivePromise = func( ...args )\n\t\t\t\t\t.then( ( ...thenArgs ) => {\n\t\t\t\t\t\tresolve( ...thenArgs );\n\t\t\t\t\t} )\n\t\t\t\t\t.catch( ( error ) => {\n\t\t\t\t\t\treject( error );\n\t\t\t\t\t} )\n\t\t\t\t\t.finally( () => {\n\t\t\t\t\t\t// As soon this promise is complete, clear the way for the\n\t\t\t\t\t\t// next one to happen immediately.\n\t\t\t\t\t\tactivePromise = null;\n\t\t\t\t\t} );\n\t\t\t} );\n\t\t}\n\n\t\tif ( activePromise ) {\n\t\t\t// Let any active promises finish before queuing the next request.\n\t\t\tawait activePromise;\n\t\t}\n\n\t\t// Clear any active timeouts, abandoning any requests that have\n\t\t// been queued but not been made.\n\t\tif ( timeoutId ) {\n\t\t\tclearTimeout( timeoutId );\n\t\t\ttimeoutId = null;\n\t\t}\n\n\t\t// Trigger any trailing edge calls to the function.\n\t\treturn new Promise( ( resolve, reject ) => {\n\t\t\t// Schedule the next request but with a delay.\n\t\t\ttimeoutId = setTimeout( () => {\n\t\t\t\tactivePromise = func( ...args )\n\t\t\t\t\t.then( ( ...thenArgs ) => {\n\t\t\t\t\t\tresolve( ...thenArgs );\n\t\t\t\t\t} )\n\t\t\t\t\t.catch( ( error ) => {\n\t\t\t\t\t\treject( error );\n\t\t\t\t\t} )\n\t\t\t\t\t.finally( () => {\n\t\t\t\t\t\t// As soon this promise is complete, clear the way for the\n\t\t\t\t\t\t// next one to happen immediately.\n\t\t\t\t\t\tactivePromise = null;\n\t\t\t\t\t\ttimeoutId = null;\n\t\t\t\t\t} );\n\t\t\t}, delayMS );\n\t\t} );\n\t};\n}\n"]}

package/build/create/index.js

@@ -0,0 +1,115 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = create;
+
+var _apiFetch = _interopRequireDefault(require("@wordpress/api-fetch"));
+
+var _debounceAsync = _interopRequireDefault(require("./debounce-async"));
+
+/**
+ * WordPress dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+const EMPTY_OBJECT = {};
+const localStorage = window.localStorage;
+/**
+ * Creates a persistence layer that stores data in WordPress user meta via the
+ * REST API.
+ *
+ * @param {Object}  options
+ * @param {?Object} options.preloadedData          Any persisted preferences data that should be preloaded.
+ *                                                 When set, the persistence layer will avoid fetching data
+ *                                                 from the REST API.
+ * @param {?string} options.localStorageRestoreKey The key to use for restoring the localStorage backup, used
+ *                                                 when the persistence layer calls `localStorage.getItem` or
+ *                                                 `localStorage.setItem`.
+ * @param {?number} options.requestDebounceMS      Debounce requests to the API so that they only occur at
+ *                                                 minimum every `requestDebounceMS` milliseconds, and don't
+ *                                                 swamp the server. Defaults to 2500ms.
+ *
+ * @return {Object} A persistence layer for WordPress user meta.
+ */
+
+function create() {
+  let {
+    preloadedData,
+    localStorageRestoreKey = 'WP_PREFERENCES_RESTORE_DATA',
+    requestDebounceMS = 2500
+  } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let cache = preloadedData;
+  const debouncedApiFetch = (0, _debounceAsync.default)(_apiFetch.default, requestDebounceMS);
+
+  async function get() {
+    var _user$meta;
+
+    if (cache) {
+      return cache;
+    }
+
+    const user = await (0, _apiFetch.default)({
+      path: '/wp/v2/users/me?context=edit'
+    });
+    const serverData = user === null || user === void 0 ? void 0 : (_user$meta = user.meta) === null || _user$meta === void 0 ? void 0 : _user$meta.persisted_preferences;
+    const localData = JSON.parse(localStorage.getItem(localStorageRestoreKey)); // Date parse returns NaN for invalid input. Coerce anything invalid
+    // into a conveniently comparable zero.
+
+    const serverTimestamp = Date.parse(serverData === null || serverData === void 0 ? void 0 : serverData._modified) || 0;
+    const localTimestamp = Date.parse(localData === null || localData === void 0 ? void 0 : localData._modified) || 0; // Prefer server data if it exists and is more recent.
+    // Otherwise fallback to localStorage data.
+
+    if (serverData && serverTimestamp >= localTimestamp) {
+      cache = serverData;
+    } else if (localData) {
+      cache = localData;
+    } else {
+      cache = EMPTY_OBJECT;
+    }
+
+    return cache;
+  }
+
+  function set(newData) {
+    const dataWithTimestamp = { ...newData,
+      _modified: new Date().toISOString()
+    };
+    cache = dataWithTimestamp; // Store data in local storage as a fallback. If for some reason the
+    // api request does not complete or becomes unavailable, this data
+    // can be used to restore preferences.
+
+    localStorage.setItem(localStorageRestoreKey, JSON.stringify(dataWithTimestamp)); // The user meta endpoint seems susceptible to errors when consecutive
+    // requests are made in quick succession. Ensure there's a gap between
+    // any consecutive requests.
+    //
+    // Catch and do nothing with errors from the REST API.
+
+    debouncedApiFetch({
+      path: '/wp/v2/users/me',
+      method: 'PUT',
+      // `keepalive` will still send the request in the background,
+      // even when a browser unload event might interrupt it.
+      // This should hopefully make things more resilient.
+      // This does have a size limit of 64kb, but the data is usually
+      // much less.
+      keepalive: true,
+      data: {
+        meta: {
+          persisted_preferences: dataWithTimestamp
+        }
+      }
+    }).catch(() => {});
+  }
+
+  return {
+    get,
+    set
+  };
+}
+//# sourceMappingURL=index.js.map

package/build/create/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences-persistence/src/create/index.js"],"names":["EMPTY_OBJECT","localStorage","window","create","preloadedData","localStorageRestoreKey","requestDebounceMS","cache","debouncedApiFetch","apiFetch","get","user","path","serverData","meta","persisted_preferences","localData","JSON","parse","getItem","serverTimestamp","Date","_modified","localTimestamp","set","newData","dataWithTimestamp","toISOString","setItem","stringify","method","keepalive","data","catch"],"mappings":";;;;;;;;;AAGA;;AAKA;;AARA;AACA;AACA;;AAGA;AACA;AACA;AAGA,MAAMA,YAAY,GAAG,EAArB;AACA,MAAMC,YAAY,GAAGC,MAAM,CAACD,YAA5B;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACe,SAASE,MAAT,GAIN;AAAA,MAJuB;AAC/BC,IAAAA,aAD+B;AAE/BC,IAAAA,sBAAsB,GAAG,6BAFM;AAG/BC,IAAAA,iBAAiB,GAAG;AAHW,GAIvB,uEAAL,EAAK;AACR,MAAIC,KAAK,GAAGH,aAAZ;AACA,QAAMI,iBAAiB,GAAG,4BAAeC,iBAAf,EAAyBH,iBAAzB,CAA1B;;AAEA,iBAAeI,GAAf,GAAqB;AAAA;;AACpB,QAAKH,KAAL,EAAa;AACZ,aAAOA,KAAP;AACA;;AAED,UAAMI,IAAI,GAAG,MAAM,uBAAU;AAC5BC,MAAAA,IAAI,EAAE;AADsB,KAAV,CAAnB;AAIA,UAAMC,UAAU,GAAGF,IAAH,aAAGA,IAAH,qCAAGA,IAAI,CAAEG,IAAT,+CAAG,WAAYC,qBAA/B;AACA,UAAMC,SAAS,GAAGC,IAAI,CAACC,KAAL,CACjBjB,YAAY,CAACkB,OAAb,CAAsBd,sBAAtB,CADiB,CAAlB,CAVoB,CAcpB;AACA;;AACA,UAAMe,eAAe,GAAGC,IAAI,CAACH,KAAL,CAAYL,UAAZ,aAAYA,UAAZ,uBAAYA,UAAU,CAAES,SAAxB,KAAuC,CAA/D;AACA,UAAMC,cAAc,GAAGF,IAAI,CAACH,KAAL,CAAYF,SAAZ,aAAYA,SAAZ,uBAAYA,SAAS,CAAEM,SAAvB,KAAsC,CAA7D,CAjBoB,CAmBpB;AACA;;AACA,QAAKT,UAAU,IAAIO,eAAe,IAAIG,cAAtC,EAAuD;AACtDhB,MAAAA,KAAK,GAAGM,UAAR;AACA,KAFD,MAEO,IAAKG,SAAL,EAAiB;AACvBT,MAAAA,KAAK,GAAGS,SAAR;AACA,KAFM,MAEA;AACNT,MAAAA,KAAK,GAAGP,YAAR;AACA;;AAED,WAAOO,KAAP;AACA;;AAED,WAASiB,GAAT,CAAcC,OAAd,EAAwB;AACvB,UAAMC,iBAAiB,GAAG,EACzB,GAAGD,OADsB;AAEzBH,MAAAA,SAAS,EAAE,IAAID,IAAJ,GAAWM,WAAX;AAFc,KAA1B;AAIApB,IAAAA,KAAK,GAAGmB,iBAAR,CALuB,CAOvB;AACA;AACA;;AACAzB,IAAAA,YAAY,CAAC2B,OAAb,CACCvB,sBADD,EAECY,IAAI,CAACY,SAAL,CAAgBH,iBAAhB,CAFD,EAVuB,CAevB;AACA;AACA;AACA;AACA;;AACAlB,IAAAA,iBAAiB,CAAE;AAClBI,MAAAA,IAAI,EAAE,iBADY;AAElBkB,MAAAA,MAAM,EAAE,KAFU;AAGlB;AACA;AACA;AACA;AACA;AACAC,MAAAA,SAAS,EAAE,IARO;AASlBC,MAAAA,IAAI,EAAE;AACLlB,QAAAA,IAAI,EAAE;AACLC,UAAAA,qBAAqB,EAAEW;AADlB;AADD;AATY,KAAF,CAAjB,CAcIO,KAdJ,CAcW,MAAM,CAAE,CAdnB;AAeA;;AAED,SAAO;AACNvB,IAAAA,GADM;AAENc,IAAAA;AAFM,GAAP;AAIA","sourcesContent":["/**\n * WordPress dependencies\n */\nimport apiFetch from '@wordpress/api-fetch';\n\n/**\n * Internal dependencies\n */\nimport debounceAsync from './debounce-async';\n\nconst EMPTY_OBJECT = {};\nconst localStorage = window.localStorage;\n\n/**\n * Creates a persistence layer that stores data in WordPress user meta via the\n * REST API.\n *\n * @param {Object}  options\n * @param {?Object} options.preloadedData          Any persisted preferences data that should be preloaded.\n *                                                 When set, the persistence layer will avoid fetching data\n *                                                 from the REST API.\n * @param {?string} options.localStorageRestoreKey The key to use for restoring the localStorage backup, used\n *                                                 when the persistence layer calls `localStorage.getItem` or\n *                                                 `localStorage.setItem`.\n * @param {?number} options.requestDebounceMS      Debounce requests to the API so that they only occur at\n *                                                 minimum every `requestDebounceMS` milliseconds, and don't\n *                                                 swamp the server. Defaults to 2500ms.\n *\n * @return {Object} A persistence layer for WordPress user meta.\n */\nexport default function create( {\n\tpreloadedData,\n\tlocalStorageRestoreKey = 'WP_PREFERENCES_RESTORE_DATA',\n\trequestDebounceMS = 2500,\n} = {} ) {\n\tlet cache = preloadedData;\n\tconst debouncedApiFetch = debounceAsync( apiFetch, requestDebounceMS );\n\n\tasync function get() {\n\t\tif ( cache ) {\n\t\t\treturn cache;\n\t\t}\n\n\t\tconst user = await apiFetch( {\n\t\t\tpath: '/wp/v2/users/me?context=edit',\n\t\t} );\n\n\t\tconst serverData = user?.meta?.persisted_preferences;\n\t\tconst localData = JSON.parse(\n\t\t\tlocalStorage.getItem( localStorageRestoreKey )\n\t\t);\n\n\t\t// Date parse returns NaN for invalid input. Coerce anything invalid\n\t\t// into a conveniently comparable zero.\n\t\tconst serverTimestamp = Date.parse( serverData?._modified ) || 0;\n\t\tconst localTimestamp = Date.parse( localData?._modified ) || 0;\n\n\t\t// Prefer server data if it exists and is more recent.\n\t\t// Otherwise fallback to localStorage data.\n\t\tif ( serverData && serverTimestamp >= localTimestamp ) {\n\t\t\tcache = serverData;\n\t\t} else if ( localData ) {\n\t\t\tcache = localData;\n\t\t} else {\n\t\t\tcache = EMPTY_OBJECT;\n\t\t}\n\n\t\treturn cache;\n\t}\n\n\tfunction set( newData ) {\n\t\tconst dataWithTimestamp = {\n\t\t\t...newData,\n\t\t\t_modified: new Date().toISOString(),\n\t\t};\n\t\tcache = dataWithTimestamp;\n\n\t\t// Store data in local storage as a fallback. If for some reason the\n\t\t// api request does not complete or becomes unavailable, this data\n\t\t// can be used to restore preferences.\n\t\tlocalStorage.setItem(\n\t\t\tlocalStorageRestoreKey,\n\t\t\tJSON.stringify( dataWithTimestamp )\n\t\t);\n\n\t\t// The user meta endpoint seems susceptible to errors when consecutive\n\t\t// requests are made in quick succession. Ensure there's a gap between\n\t\t// any consecutive requests.\n\t\t//\n\t\t// Catch and do nothing with errors from the REST API.\n\t\tdebouncedApiFetch( {\n\t\t\tpath: '/wp/v2/users/me',\n\t\t\tmethod: 'PUT',\n\t\t\t// `keepalive` will still send the request in the background,\n\t\t\t// even when a browser unload event might interrupt it.\n\t\t\t// This should hopefully make things more resilient.\n\t\t\t// This does have a size limit of 64kb, but the data is usually\n\t\t\t// much less.\n\t\t\tkeepalive: true,\n\t\t\tdata: {\n\t\t\t\tmeta: {\n\t\t\t\t\tpersisted_preferences: dataWithTimestamp,\n\t\t\t\t},\n\t\t\t},\n\t\t} ).catch( () => {} );\n\t}\n\n\treturn {\n\t\tget,\n\t\tset,\n\t};\n}\n"]}

package/build/index.js

@@ -0,0 +1,61 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.__unstableCreatePersistenceLayer = __unstableCreatePersistenceLayer;
+Object.defineProperty(exports, "create", {
+  enumerable: true,
+  get: function () {
+    return _create.default;
+  }
+});
+
+var _create = _interopRequireDefault(require("./create"));
+
+var _legacyLocalStorageData = _interopRequireDefault(require("./migrations/legacy-local-storage-data"));
+
+/**
+ * Internal dependencies
+ */
+
+/**
+ * Creates the persistence layer with preloaded data.
+ *
+ * It prioritizes any data from the server, but falls back first to localStorage
+ * restore data, and then to any legacy data.
+ *
+ * This function is used internally by WordPress in an inline script, so
+ * prefixed with `__unstable`.
+ *
+ * @param {Object} serverData Preferences data preloaded from the server.
+ * @param {string} userId     The user id.
+ *
+ * @return {Object} The persistence layer initialized with the preloaded data.
+ */
+function __unstableCreatePersistenceLayer(serverData, userId) {
+  const localStorageRestoreKey = `WP_PREFERENCES_USER_${userId}`;
+  const localData = JSON.parse(window.localStorage.getItem(localStorageRestoreKey)); // Date parse returns NaN for invalid input. Coerce anything invalid
+  // into a conveniently comparable zero.
+
+  const serverModified = Date.parse(serverData && serverData._modified) || 0;
+  const localModified = Date.parse(localData && localData._modified) || 0;
+  let preloadedData;
+
+  if (serverData && serverModified >= localModified) {
+    preloadedData = serverData;
+  } else if (localData) {
+    preloadedData = localData;
+  } else {
+    // Check if there is data in the legacy format from the old persistence system.
+    preloadedData = (0, _legacyLocalStorageData.default)(userId);
+  }
+
+  return (0, _create.default)({
+    preloadedData,
+    localStorageRestoreKey
+  });
+}
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences-persistence/src/index.js"],"names":["__unstableCreatePersistenceLayer","serverData","userId","localStorageRestoreKey","localData","JSON","parse","window","localStorage","getItem","serverModified","Date","_modified","localModified","preloadedData"],"mappings":";;;;;;;;;;;;;;;AAGA;;AACA;;AAJA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,gCAAT,CAA2CC,UAA3C,EAAuDC,MAAvD,EAAgE;AACtE,QAAMC,sBAAsB,GAAI,uBAAuBD,MAAQ,EAA/D;AACA,QAAME,SAAS,GAAGC,IAAI,CAACC,KAAL,CACjBC,MAAM,CAACC,YAAP,CAAoBC,OAApB,CAA6BN,sBAA7B,CADiB,CAAlB,CAFsE,CAMtE;AACA;;AACA,QAAMO,cAAc,GACnBC,IAAI,CAACL,KAAL,CAAYL,UAAU,IAAIA,UAAU,CAACW,SAArC,KAAoD,CADrD;AAEA,QAAMC,aAAa,GAAGF,IAAI,CAACL,KAAL,CAAYF,SAAS,IAAIA,SAAS,CAACQ,SAAnC,KAAkD,CAAxE;AAEA,MAAIE,aAAJ;;AACA,MAAKb,UAAU,IAAIS,cAAc,IAAIG,aAArC,EAAqD;AACpDC,IAAAA,aAAa,GAAGb,UAAhB;AACA,GAFD,MAEO,IAAKG,SAAL,EAAiB;AACvBU,IAAAA,aAAa,GAAGV,SAAhB;AACA,GAFM,MAEA;AACN;AACAU,IAAAA,aAAa,GAAG,qCAA+BZ,MAA/B,CAAhB;AACA;;AAED,SAAO,qBAAQ;AACdY,IAAAA,aADc;AAEdX,IAAAA;AAFc,GAAR,CAAP;AAIA","sourcesContent":["/**\n * Internal dependencies\n */\nimport create from './create';\nimport convertLegacyLocalStorageData from './migrations/legacy-local-storage-data';\n\nexport { create };\n\n/**\n * Creates the persistence layer with preloaded data.\n *\n * It prioritizes any data from the server, but falls back first to localStorage\n * restore data, and then to any legacy data.\n *\n * This function is used internally by WordPress in an inline script, so\n * prefixed with `__unstable`.\n *\n * @param {Object} serverData Preferences data preloaded from the server.\n * @param {string} userId     The user id.\n *\n * @return {Object} The persistence layer initialized with the preloaded data.\n */\nexport function __unstableCreatePersistenceLayer( serverData, userId ) {\n\tconst localStorageRestoreKey = `WP_PREFERENCES_USER_${ userId }`;\n\tconst localData = JSON.parse(\n\t\twindow.localStorage.getItem( localStorageRestoreKey )\n\t);\n\n\t// Date parse returns NaN for invalid input. Coerce anything invalid\n\t// into a conveniently comparable zero.\n\tconst serverModified =\n\t\tDate.parse( serverData && serverData._modified ) || 0;\n\tconst localModified = Date.parse( localData && localData._modified ) || 0;\n\n\tlet preloadedData;\n\tif ( serverData && serverModified >= localModified ) {\n\t\tpreloadedData = serverData;\n\t} else if ( localData ) {\n\t\tpreloadedData = localData;\n\t} else {\n\t\t// Check if there is data in the legacy format from the old persistence system.\n\t\tpreloadedData = convertLegacyLocalStorageData( userId );\n\t}\n\n\treturn create( {\n\t\tpreloadedData,\n\t\tlocalStorageRestoreKey,\n\t} );\n}\n"]}

package/build/migrations/legacy-local-storage-data/convert-edit-post-panels.js

@@ -0,0 +1,60 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = convertEditPostPanels;
+
+/**
+ * Convert the post editor's panels state from:
+ * ```
+ * {
+ *     panels: {
+ *         tags: {
+ *             enabled: true,
+ *             opened: true,
+ *         },
+ *         permalinks: {
+ *             enabled: false,
+ *             opened: false,
+ *         },
+ *     },
+ * }
+ * ```
+ *
+ * to a new, more concise data structure:
+ * {
+ *     inactivePanels: [
+ *         'permalinks',
+ *     ],
+ *     openPanels: [
+ *         'tags',
+ *     ],
+ * }
+ *
+ * @param {Object} preferences A preferences object.
+ *
+ * @return {Object} The converted data.
+ */
+function convertEditPostPanels(preferences) {
+  var _preferences$panels;
+
+  const panels = (_preferences$panels = preferences === null || preferences === void 0 ? void 0 : preferences.panels) !== null && _preferences$panels !== void 0 ? _preferences$panels : {};
+  return Object.keys(panels).reduce((convertedData, panelName) => {
+    const panel = panels[panelName];
+
+    if ((panel === null || panel === void 0 ? void 0 : panel.enabled) === false) {
+      convertedData.inactivePanels.push(panelName);
+    }
+
+    if ((panel === null || panel === void 0 ? void 0 : panel.opened) === true) {
+      convertedData.openPanels.push(panelName);
+    }
+
+    return convertedData;
+  }, {
+    inactivePanels: [],
+    openPanels: []
+  });
+}
+//# sourceMappingURL=convert-edit-post-panels.js.map

package/build/migrations/legacy-local-storage-data/convert-edit-post-panels.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences-persistence/src/migrations/legacy-local-storage-data/convert-edit-post-panels.js"],"names":["convertEditPostPanels","preferences","panels","Object","keys","reduce","convertedData","panelName","panel","enabled","inactivePanels","push","opened","openPanels"],"mappings":";;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAASA,qBAAT,CAAgCC,WAAhC,EAA8C;AAAA;;AAC5D,QAAMC,MAAM,0BAAGD,WAAH,aAAGA,WAAH,uBAAGA,WAAW,CAAEC,MAAhB,qEAA0B,EAAtC;AACA,SAAOC,MAAM,CAACC,IAAP,CAAaF,MAAb,EAAsBG,MAAtB,CACN,CAAEC,aAAF,EAAiBC,SAAjB,KAAgC;AAC/B,UAAMC,KAAK,GAAGN,MAAM,CAAEK,SAAF,CAApB;;AAEA,QAAK,CAAAC,KAAK,SAAL,IAAAA,KAAK,WAAL,YAAAA,KAAK,CAAEC,OAAP,MAAmB,KAAxB,EAAgC;AAC/BH,MAAAA,aAAa,CAACI,cAAd,CAA6BC,IAA7B,CAAmCJ,SAAnC;AACA;;AAED,QAAK,CAAAC,KAAK,SAAL,IAAAA,KAAK,WAAL,YAAAA,KAAK,CAAEI,MAAP,MAAkB,IAAvB,EAA8B;AAC7BN,MAAAA,aAAa,CAACO,UAAd,CAAyBF,IAAzB,CAA+BJ,SAA/B;AACA;;AAED,WAAOD,aAAP;AACA,GAbK,EAcN;AAAEI,IAAAA,cAAc,EAAE,EAAlB;AAAsBG,IAAAA,UAAU,EAAE;AAAlC,GAdM,CAAP;AAgBA","sourcesContent":["/**\n * Convert the post editor's panels state from:\n * ```\n * {\n *     panels: {\n *         tags: {\n *             enabled: true,\n *             opened: true,\n *         },\n *         permalinks: {\n *             enabled: false,\n *             opened: false,\n *         },\n *     },\n * }\n * ```\n *\n * to a new, more concise data structure:\n * {\n *     inactivePanels: [\n *         'permalinks',\n *     ],\n *     openPanels: [\n *         'tags',\n *     ],\n * }\n *\n * @param {Object} preferences A preferences object.\n *\n * @return {Object} The converted data.\n */\nexport default function convertEditPostPanels( preferences ) {\n\tconst panels = preferences?.panels ?? {};\n\treturn Object.keys( panels ).reduce(\n\t\t( convertedData, panelName ) => {\n\t\t\tconst panel = panels[ panelName ];\n\n\t\t\tif ( panel?.enabled === false ) {\n\t\t\t\tconvertedData.inactivePanels.push( panelName );\n\t\t\t}\n\n\t\t\tif ( panel?.opened === true ) {\n\t\t\t\tconvertedData.openPanels.push( panelName );\n\t\t\t}\n\n\t\t\treturn convertedData;\n\t\t},\n\t\t{ inactivePanels: [], openPanels: [] }\n\t);\n}\n"]}

package/build/migrations/legacy-local-storage-data/index.js

@@ -0,0 +1,111 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.convertLegacyData = convertLegacyData;
+exports.default = convertLegacyLocalStorageData;
+
+var _moveFeaturePreferences = _interopRequireDefault(require("./move-feature-preferences"));
+
+var _moveThirdPartyFeaturePreferences = _interopRequireDefault(require("./move-third-party-feature-preferences"));
+
+var _moveIndividualPreference = _interopRequireDefault(require("./move-individual-preference"));
+
+var _moveInterfaceEnableItems = _interopRequireDefault(require("./move-interface-enable-items"));
+
+var _convertEditPostPanels = _interopRequireDefault(require("./convert-edit-post-panels"));
+
+/**
+ * Internal dependencies
+ */
+
+/**
+ * Gets the legacy local storage data for a given user.
+ *
+ * @param {string | number} userId The user id.
+ *
+ * @return {Object | null} The local storage data.
+ */
+function getLegacyData(userId) {
+  const key = `WP_DATA_USER_${userId}`;
+  const unparsedData = window.localStorage.getItem(key);
+  return JSON.parse(unparsedData);
+}
+/**
+ * Converts data from the old `@wordpress/data` package format.
+ *
+ * @param {Object | null | undefined} data The legacy data in its original format.
+ *
+ * @return {Object | undefined} The converted data or `undefined` if there was
+ *                              nothing to convert.
+ */
+
+
+function convertLegacyData(data) {
+  var _data, _data$corePreference;
+
+  if (!data) {
+    return;
+  } // Move boolean feature preferences from each editor into the
+  // preferences store data structure.
+
+
+  data = (0, _moveFeaturePreferences.default)(data, 'core/edit-widgets');
+  data = (0, _moveFeaturePreferences.default)(data, 'core/customize-widgets');
+  data = (0, _moveFeaturePreferences.default)(data, 'core/edit-post');
+  data = (0, _moveFeaturePreferences.default)(data, 'core/edit-site'); // Move third party boolean feature preferences from the interface package
+  // to the preferences store data structure.
+
+  data = (0, _moveThirdPartyFeaturePreferences.default)(data); // Move and convert the interface store's `enableItems` data into the
+  // preferences data structure.
+
+  data = (0, _moveInterfaceEnableItems.default)(data); // Move individual ad-hoc preferences from various packages into the
+  // preferences store data structure.
+
+  data = (0, _moveIndividualPreference.default)(data, {
+    from: 'core/edit-post',
+    to: 'core/edit-post'
+  }, 'hiddenBlockTypes');
+  data = (0, _moveIndividualPreference.default)(data, {
+    from: 'core/edit-post',
+    to: 'core/edit-post'
+  }, 'editorMode');
+  data = (0, _moveIndividualPreference.default)(data, {
+    from: 'core/edit-post',
+    to: 'core/edit-post'
+  }, 'preferredStyleVariations');
+  data = (0, _moveIndividualPreference.default)(data, {
+    from: 'core/edit-post',
+    to: 'core/edit-post'
+  }, 'panels', _convertEditPostPanels.default);
+  data = (0, _moveIndividualPreference.default)(data, {
+    from: 'core/editor',
+    to: 'core/edit-post'
+  }, 'isPublishSidebarEnabled');
+  data = (0, _moveIndividualPreference.default)(data, {
+    from: 'core/edit-site',
+    to: 'core/edit-site'
+  }, 'editorMode'); // The new system is only concerned with persisting
+  // 'core/preferences' preferences reducer, so only return that.
+
+  return (_data = data) === null || _data === void 0 ? void 0 : (_data$corePreference = _data['core/preferences']) === null || _data$corePreference === void 0 ? void 0 : _data$corePreference.preferences;
+}
+/**
+ * Gets the legacy local storage data for the given user and returns the
+ * data converted to the new format.
+ *
+ * @param {string | number} userId The user id.
+ *
+ * @return {Object | undefined} The converted data or undefined if no local
+ *                              storage data could be found.
+ */
+
+
+function convertLegacyLocalStorageData(userId) {
+  const data = getLegacyData(userId);
+  return convertLegacyData(data);
+}
+//# sourceMappingURL=index.js.map

package/build/migrations/legacy-local-storage-data/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences-persistence/src/migrations/legacy-local-storage-data/index.js"],"names":["getLegacyData","userId","key","unparsedData","window","localStorage","getItem","JSON","parse","convertLegacyData","data","from","to","convertEditPostPanels","preferences","convertLegacyLocalStorageData"],"mappings":";;;;;;;;;;AAGA;;AACA;;AACA;;AACA;;AACA;;AAPA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,aAAT,CAAwBC,MAAxB,EAAiC;AAChC,QAAMC,GAAG,GAAI,gBAAgBD,MAAQ,EAArC;AACA,QAAME,YAAY,GAAGC,MAAM,CAACC,YAAP,CAAoBC,OAApB,CAA6BJ,GAA7B,CAArB;AACA,SAAOK,IAAI,CAACC,KAAL,CAAYL,YAAZ,CAAP;AACA;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASM,iBAAT,CAA4BC,IAA5B,EAAmC;AAAA;;AACzC,MAAK,CAAEA,IAAP,EAAc;AACb;AACA,GAHwC,CAKzC;AACA;;;AACAA,EAAAA,IAAI,GAAG,qCAAwBA,IAAxB,EAA8B,mBAA9B,CAAP;AACAA,EAAAA,IAAI,GAAG,qCAAwBA,IAAxB,EAA8B,wBAA9B,CAAP;AACAA,EAAAA,IAAI,GAAG,qCAAwBA,IAAxB,EAA8B,gBAA9B,CAAP;AACAA,EAAAA,IAAI,GAAG,qCAAwBA,IAAxB,EAA8B,gBAA9B,CAAP,CAVyC,CAYzC;AACA;;AACAA,EAAAA,IAAI,GAAG,+CAAkCA,IAAlC,CAAP,CAdyC,CAgBzC;AACA;;AACAA,EAAAA,IAAI,GAAG,uCAA0BA,IAA1B,CAAP,CAlByC,CAoBzC;AACA;;AACAA,EAAAA,IAAI,GAAG,uCACNA,IADM,EAEN;AAAEC,IAAAA,IAAI,EAAE,gBAAR;AAA0BC,IAAAA,EAAE,EAAE;AAA9B,GAFM,EAGN,kBAHM,CAAP;AAKAF,EAAAA,IAAI,GAAG,uCACNA,IADM,EAEN;AAAEC,IAAAA,IAAI,EAAE,gBAAR;AAA0BC,IAAAA,EAAE,EAAE;AAA9B,GAFM,EAGN,YAHM,CAAP;AAKAF,EAAAA,IAAI,GAAG,uCACNA,IADM,EAEN;AAAEC,IAAAA,IAAI,EAAE,gBAAR;AAA0BC,IAAAA,EAAE,EAAE;AAA9B,GAFM,EAGN,0BAHM,CAAP;AAKAF,EAAAA,IAAI,GAAG,uCACNA,IADM,EAEN;AAAEC,IAAAA,IAAI,EAAE,gBAAR;AAA0BC,IAAAA,EAAE,EAAE;AAA9B,GAFM,EAGN,QAHM,EAINC,8BAJM,CAAP;AAMAH,EAAAA,IAAI,GAAG,uCACNA,IADM,EAEN;AAAEC,IAAAA,IAAI,EAAE,aAAR;AAAuBC,IAAAA,EAAE,EAAE;AAA3B,GAFM,EAGN,yBAHM,CAAP;AAKAF,EAAAA,IAAI,GAAG,uCACNA,IADM,EAEN;AAAEC,IAAAA,IAAI,EAAE,gBAAR;AAA0BC,IAAAA,EAAE,EAAE;AAA9B,GAFM,EAGN,YAHM,CAAP,CAhDyC,CAsDzC;AACA;;AACA,kBAAOF,IAAP,kEAAO,MAAQ,kBAAR,CAAP,yDAAO,qBAA8BI,WAArC;AACA;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACe,SAASC,6BAAT,CAAwCd,MAAxC,EAAiD;AAC/D,QAAMS,IAAI,GAAGV,aAAa,CAAEC,MAAF,CAA1B;AACA,SAAOQ,iBAAiB,CAAEC,IAAF,CAAxB;AACA","sourcesContent":["/**\n * Internal dependencies\n */\nimport moveFeaturePreferences from './move-feature-preferences';\nimport moveThirdPartyFeaturePreferences from './move-third-party-feature-preferences';\nimport moveIndividualPreference from './move-individual-preference';\nimport moveInterfaceEnableItems from './move-interface-enable-items';\nimport convertEditPostPanels from './convert-edit-post-panels';\n\n/**\n * Gets the legacy local storage data for a given user.\n *\n * @param {string | number} userId The user id.\n *\n * @return {Object | null} The local storage data.\n */\nfunction getLegacyData( userId ) {\n\tconst key = `WP_DATA_USER_${ userId }`;\n\tconst unparsedData = window.localStorage.getItem( key );\n\treturn JSON.parse( unparsedData );\n}\n\n/**\n * Converts data from the old `@wordpress/data` package format.\n *\n * @param {Object | null | undefined} data The legacy data in its original format.\n *\n * @return {Object | undefined} The converted data or `undefined` if there was\n *                              nothing to convert.\n */\nexport function convertLegacyData( data ) {\n\tif ( ! data ) {\n\t\treturn;\n\t}\n\n\t// Move boolean feature preferences from each editor into the\n\t// preferences store data structure.\n\tdata = moveFeaturePreferences( data, 'core/edit-widgets' );\n\tdata = moveFeaturePreferences( data, 'core/customize-widgets' );\n\tdata = moveFeaturePreferences( data, 'core/edit-post' );\n\tdata = moveFeaturePreferences( data, 'core/edit-site' );\n\n\t// Move third party boolean feature preferences from the interface package\n\t// to the preferences store data structure.\n\tdata = moveThirdPartyFeaturePreferences( data );\n\n\t// Move and convert the interface store's `enableItems` data into the\n\t// preferences data structure.\n\tdata = moveInterfaceEnableItems( data );\n\n\t// Move individual ad-hoc preferences from various packages into the\n\t// preferences store data structure.\n\tdata = moveIndividualPreference(\n\t\tdata,\n\t\t{ from: 'core/edit-post', to: 'core/edit-post' },\n\t\t'hiddenBlockTypes'\n\t);\n\tdata = moveIndividualPreference(\n\t\tdata,\n\t\t{ from: 'core/edit-post', to: 'core/edit-post' },\n\t\t'editorMode'\n\t);\n\tdata = moveIndividualPreference(\n\t\tdata,\n\t\t{ from: 'core/edit-post', to: 'core/edit-post' },\n\t\t'preferredStyleVariations'\n\t);\n\tdata = moveIndividualPreference(\n\t\tdata,\n\t\t{ from: 'core/edit-post', to: 'core/edit-post' },\n\t\t'panels',\n\t\tconvertEditPostPanels\n\t);\n\tdata = moveIndividualPreference(\n\t\tdata,\n\t\t{ from: 'core/editor', to: 'core/edit-post' },\n\t\t'isPublishSidebarEnabled'\n\t);\n\tdata = moveIndividualPreference(\n\t\tdata,\n\t\t{ from: 'core/edit-site', to: 'core/edit-site' },\n\t\t'editorMode'\n\t);\n\n\t// The new system is only concerned with persisting\n\t// 'core/preferences' preferences reducer, so only return that.\n\treturn data?.[ 'core/preferences' ]?.preferences;\n}\n\n/**\n * Gets the legacy local storage data for the given user and returns the\n * data converted to the new format.\n *\n * @param {string | number} userId The user id.\n *\n * @return {Object | undefined} The converted data or undefined if no local\n *                              storage data could be found.\n */\nexport default function convertLegacyLocalStorageData( userId ) {\n\tconst data = getLegacyData( userId );\n\treturn convertLegacyData( data );\n}\n"]}