@wordpress/preferences-persistence 1.0.0

package/build-module/create/index.js

@@ -0,0 +1,104 @@
+/**
+ * WordPress dependencies
+ */
+import apiFetch from '@wordpress/api-fetch';
+/**
+ * Internal dependencies
+ */
+
+import debounceAsync from './debounce-async';
+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.
+ */
+
+export default function create() {
+  let {
+    preloadedData,
+    localStorageRestoreKey = 'WP_PREFERENCES_RESTORE_DATA',
+    requestDebounceMS = 2500
+  } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let cache = preloadedData;
+  const debouncedApiFetch = debounceAsync(apiFetch, requestDebounceMS);
+
+  async function get() {
+    var _user$meta;
+
+    if (cache) {
+      return cache;
+    }
+
+    const user = await apiFetch({
+      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-module/create/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences-persistence/src/create/index.js"],"names":["apiFetch","debounceAsync","EMPTY_OBJECT","localStorage","window","create","preloadedData","localStorageRestoreKey","requestDebounceMS","cache","debouncedApiFetch","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":"AAAA;AACA;AACA;AACA,OAAOA,QAAP,MAAqB,sBAArB;AAEA;AACA;AACA;;AACA,OAAOC,aAAP,MAA0B,kBAA1B;AAEA,MAAMC,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;;AACA,eAAe,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,GAAGT,aAAa,CAAED,QAAF,EAAYQ,iBAAZ,CAAvC;;AAEA,iBAAeG,GAAf,GAAqB;AAAA;;AACpB,QAAKF,KAAL,EAAa;AACZ,aAAOA,KAAP;AACA;;AAED,UAAMG,IAAI,GAAG,MAAMZ,QAAQ,CAAE;AAC5Ba,MAAAA,IAAI,EAAE;AADsB,KAAF,CAA3B;AAIA,UAAMC,UAAU,GAAGF,IAAH,aAAGA,IAAH,qCAAGA,IAAI,CAAEG,IAAT,+CAAG,WAAYC,qBAA/B;AACA,UAAMC,SAAS,GAAGC,IAAI,CAACC,KAAL,CACjBhB,YAAY,CAACiB,OAAb,CAAsBb,sBAAtB,CADiB,CAAlB,CAVoB,CAcpB;AACA;;AACA,UAAMc,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;AACtDf,MAAAA,KAAK,GAAGK,UAAR;AACA,KAFD,MAEO,IAAKG,SAAL,EAAiB;AACvBR,MAAAA,KAAK,GAAGQ,SAAR;AACA,KAFM,MAEA;AACNR,MAAAA,KAAK,GAAGP,YAAR;AACA;;AAED,WAAOO,KAAP;AACA;;AAED,WAASgB,GAAT,CAAcC,OAAd,EAAwB;AACvB,UAAMC,iBAAiB,GAAG,EACzB,GAAGD,OADsB;AAEzBH,MAAAA,SAAS,EAAE,IAAID,IAAJ,GAAWM,WAAX;AAFc,KAA1B;AAIAnB,IAAAA,KAAK,GAAGkB,iBAAR,CALuB,CAOvB;AACA;AACA;;AACAxB,IAAAA,YAAY,CAAC0B,OAAb,CACCtB,sBADD,EAECW,IAAI,CAACY,SAAL,CAAgBH,iBAAhB,CAFD,EAVuB,CAevB;AACA;AACA;AACA;AACA;;AACAjB,IAAAA,iBAAiB,CAAE;AAClBG,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-module/index.js

@@ -0,0 +1,45 @@
+/**
+ * Internal dependencies
+ */
+import create from './create';
+import convertLegacyLocalStorageData from './migrations/legacy-local-storage-data';
+export { create };
+/**
+ * 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.
+ */
+
+export 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 = convertLegacyLocalStorageData(userId);
+  }
+
+  return create({
+    preloadedData,
+    localStorageRestoreKey
+  });
+}
+//# sourceMappingURL=index.js.map

package/build-module/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences-persistence/src/index.js"],"names":["create","convertLegacyLocalStorageData","__unstableCreatePersistenceLayer","serverData","userId","localStorageRestoreKey","localData","JSON","parse","window","localStorage","getItem","serverModified","Date","_modified","localModified","preloadedData"],"mappings":"AAAA;AACA;AACA;AACA,OAAOA,MAAP,MAAmB,UAAnB;AACA,OAAOC,6BAAP,MAA0C,wCAA1C;AAEA,SAASD,MAAT;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASE,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,GAAGf,6BAA6B,CAAEG,MAAF,CAA7C;AACA;;AAED,SAAOJ,MAAM,CAAE;AACdgB,IAAAA,aADc;AAEdX,IAAAA;AAFc,GAAF,CAAb;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-module/migrations/legacy-local-storage-data/convert-edit-post-panels.js

@@ -0,0 +1,53 @@
+/**
+ * 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.
+ */
+export default 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-module/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;AACA,eAAe,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-module/migrations/legacy-local-storage-data/index.js

@@ -0,0 +1,95 @@
+/**
+ * Internal dependencies
+ */
+import moveFeaturePreferences from './move-feature-preferences';
+import moveThirdPartyFeaturePreferences from './move-third-party-feature-preferences';
+import moveIndividualPreference from './move-individual-preference';
+import moveInterfaceEnableItems from './move-interface-enable-items';
+import convertEditPostPanels from './convert-edit-post-panels';
+/**
+ * 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.
+ */
+
+
+export function convertLegacyData(data) {
+  var _data, _data$corePreference;
+
+  if (!data) {
+    return;
+  } // Move boolean feature preferences from each editor into the
+  // preferences store data structure.
+
+
+  data = moveFeaturePreferences(data, 'core/edit-widgets');
+  data = moveFeaturePreferences(data, 'core/customize-widgets');
+  data = moveFeaturePreferences(data, 'core/edit-post');
+  data = moveFeaturePreferences(data, 'core/edit-site'); // Move third party boolean feature preferences from the interface package
+  // to the preferences store data structure.
+
+  data = moveThirdPartyFeaturePreferences(data); // Move and convert the interface store's `enableItems` data into the
+  // preferences data structure.
+
+  data = moveInterfaceEnableItems(data); // Move individual ad-hoc preferences from various packages into the
+  // preferences store data structure.
+
+  data = moveIndividualPreference(data, {
+    from: 'core/edit-post',
+    to: 'core/edit-post'
+  }, 'hiddenBlockTypes');
+  data = moveIndividualPreference(data, {
+    from: 'core/edit-post',
+    to: 'core/edit-post'
+  }, 'editorMode');
+  data = moveIndividualPreference(data, {
+    from: 'core/edit-post',
+    to: 'core/edit-post'
+  }, 'preferredStyleVariations');
+  data = moveIndividualPreference(data, {
+    from: 'core/edit-post',
+    to: 'core/edit-post'
+  }, 'panels', convertEditPostPanels);
+  data = moveIndividualPreference(data, {
+    from: 'core/editor',
+    to: 'core/edit-post'
+  }, 'isPublishSidebarEnabled');
+  data = moveIndividualPreference(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.
+ */
+
+export default function convertLegacyLocalStorageData(userId) {
+  const data = getLegacyData(userId);
+  return convertLegacyData(data);
+}
+//# sourceMappingURL=index.js.map

package/build-module/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":["moveFeaturePreferences","moveThirdPartyFeaturePreferences","moveIndividualPreference","moveInterfaceEnableItems","convertEditPostPanels","getLegacyData","userId","key","unparsedData","window","localStorage","getItem","JSON","parse","convertLegacyData","data","from","to","preferences","convertLegacyLocalStorageData"],"mappings":"AAAA;AACA;AACA;AACA,OAAOA,sBAAP,MAAmC,4BAAnC;AACA,OAAOC,gCAAP,MAA6C,wCAA7C;AACA,OAAOC,wBAAP,MAAqC,8BAArC;AACA,OAAOC,wBAAP,MAAqC,+BAArC;AACA,OAAOC,qBAAP,MAAkC,4BAAlC;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,SAASC,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;;;AACA,OAAO,SAASM,iBAAT,CAA4BC,IAA5B,EAAmC;AAAA;;AACzC,MAAK,CAAEA,IAAP,EAAc;AACb;AACA,GAHwC,CAKzC;AACA;;;AACAA,EAAAA,IAAI,GAAGf,sBAAsB,CAAEe,IAAF,EAAQ,mBAAR,CAA7B;AACAA,EAAAA,IAAI,GAAGf,sBAAsB,CAAEe,IAAF,EAAQ,wBAAR,CAA7B;AACAA,EAAAA,IAAI,GAAGf,sBAAsB,CAAEe,IAAF,EAAQ,gBAAR,CAA7B;AACAA,EAAAA,IAAI,GAAGf,sBAAsB,CAAEe,IAAF,EAAQ,gBAAR,CAA7B,CAVyC,CAYzC;AACA;;AACAA,EAAAA,IAAI,GAAGd,gCAAgC,CAAEc,IAAF,CAAvC,CAdyC,CAgBzC;AACA;;AACAA,EAAAA,IAAI,GAAGZ,wBAAwB,CAAEY,IAAF,CAA/B,CAlByC,CAoBzC;AACA;;AACAA,EAAAA,IAAI,GAAGb,wBAAwB,CAC9Ba,IAD8B,EAE9B;AAAEC,IAAAA,IAAI,EAAE,gBAAR;AAA0BC,IAAAA,EAAE,EAAE;AAA9B,GAF8B,EAG9B,kBAH8B,CAA/B;AAKAF,EAAAA,IAAI,GAAGb,wBAAwB,CAC9Ba,IAD8B,EAE9B;AAAEC,IAAAA,IAAI,EAAE,gBAAR;AAA0BC,IAAAA,EAAE,EAAE;AAA9B,GAF8B,EAG9B,YAH8B,CAA/B;AAKAF,EAAAA,IAAI,GAAGb,wBAAwB,CAC9Ba,IAD8B,EAE9B;AAAEC,IAAAA,IAAI,EAAE,gBAAR;AAA0BC,IAAAA,EAAE,EAAE;AAA9B,GAF8B,EAG9B,0BAH8B,CAA/B;AAKAF,EAAAA,IAAI,GAAGb,wBAAwB,CAC9Ba,IAD8B,EAE9B;AAAEC,IAAAA,IAAI,EAAE,gBAAR;AAA0BC,IAAAA,EAAE,EAAE;AAA9B,GAF8B,EAG9B,QAH8B,EAI9Bb,qBAJ8B,CAA/B;AAMAW,EAAAA,IAAI,GAAGb,wBAAwB,CAC9Ba,IAD8B,EAE9B;AAAEC,IAAAA,IAAI,EAAE,aAAR;AAAuBC,IAAAA,EAAE,EAAE;AAA3B,GAF8B,EAG9B,yBAH8B,CAA/B;AAKAF,EAAAA,IAAI,GAAGb,wBAAwB,CAC9Ba,IAD8B,EAE9B;AAAEC,IAAAA,IAAI,EAAE,gBAAR;AAA0BC,IAAAA,EAAE,EAAE;AAA9B,GAF8B,EAG9B,YAH8B,CAA/B,CAhDyC,CAsDzC;AACA;;AACA,kBAAOF,IAAP,kEAAO,MAAQ,kBAAR,CAAP,yDAAO,qBAA8BG,WAArC;AACA;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,eAAe,SAASC,6BAAT,CAAwCb,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"]}

package/build-module/migrations/legacy-local-storage-data/move-feature-preferences.js

@@ -0,0 +1,128 @@
+/**
+ * Move the 'features' object in local storage from the sourceStoreName to the
+ * preferences store data structure.
+ *
+ * Previously, editors used a data structure like this for feature preferences:
+ * ```js
+ * {
+ *     'core/edit-post': {
+ *         preferences: {
+ *             features; {
+ *                 topToolbar: true,
+ *                 // ... other boolean 'feature' preferences
+ *             },
+ *         },
+ *     },
+ * }
+ * ```
+ *
+ * And for a while these feature preferences lived in the interface package:
+ * ```js
+ * {
+ *     'core/interface': {
+ *         preferences: {
+ *             features: {
+ *                 'core/edit-post': {
+ *                     topToolbar: true
+ *                 }
+ *             }
+ *         }
+ *     }
+ * }
+ * ```
+ *
+ * In the preferences store, 'features' aren't considered special, they're
+ * merged to the root level of the scope along with other preferences:
+ * ```js
+ * {
+ *     'core/preferences': {
+ *         preferences: {
+ *             'core/edit-post': {
+ *                 topToolbar: true,
+ *                 // ... any other preferences.
+ *             }
+ *         }
+ *     }
+ * }
+ * ```
+ *
+ * This function handles moving from either the source store or the interface
+ * store to the preferences data structure.
+ *
+ * @param {Object} state           The state before migration.
+ * @param {string} sourceStoreName The name of the store that has persisted
+ *                                 preferences to migrate to the preferences
+ *                                 package.
+ * @return {Object} The migrated state
+ */
+export default function moveFeaturePreferences(state, sourceStoreName) {
+  var _state$interfaceStore, _state$interfaceStore2, _state$interfaceStore3, _state$sourceStoreNam, _state$sourceStoreNam2, _state$preferencesSto;
+
+  const preferencesStoreName = 'core/preferences';
+  const interfaceStoreName = 'core/interface'; // Features most recently (and briefly) lived in the interface package.
+  // If data exists there, prioritize using that for the migration. If not
+  // also check the original package as the user may have updated from an
+  // older block editor version.
+
+  const interfaceFeatures = state === null || state === void 0 ? void 0 : (_state$interfaceStore = state[interfaceStoreName]) === null || _state$interfaceStore === void 0 ? void 0 : (_state$interfaceStore2 = _state$interfaceStore.preferences) === null || _state$interfaceStore2 === void 0 ? void 0 : (_state$interfaceStore3 = _state$interfaceStore2.features) === null || _state$interfaceStore3 === void 0 ? void 0 : _state$interfaceStore3[sourceStoreName];
+  const sourceFeatures = state === null || state === void 0 ? void 0 : (_state$sourceStoreNam = state[sourceStoreName]) === null || _state$sourceStoreNam === void 0 ? void 0 : (_state$sourceStoreNam2 = _state$sourceStoreNam.preferences) === null || _state$sourceStoreNam2 === void 0 ? void 0 : _state$sourceStoreNam2.features;
+  const featuresToMigrate = interfaceFeatures ? interfaceFeatures : sourceFeatures;
+
+  if (!featuresToMigrate) {
+    return state;
+  }
+
+  const existingPreferences = state === null || state === void 0 ? void 0 : (_state$preferencesSto = state[preferencesStoreName]) === null || _state$preferencesSto === void 0 ? void 0 : _state$preferencesSto.preferences; // Avoid migrating features again if they've previously been migrated.
+
+  if (existingPreferences !== null && existingPreferences !== void 0 && existingPreferences[sourceStoreName]) {
+    return state;
+  }
+
+  let updatedInterfaceState;
+
+  if (interfaceFeatures) {
+    var _state$interfaceStore4, _state$interfaceStore5;
+
+    const otherInterfaceState = state === null || state === void 0 ? void 0 : state[interfaceStoreName];
+    const otherInterfaceScopes = state === null || state === void 0 ? void 0 : (_state$interfaceStore4 = state[interfaceStoreName]) === null || _state$interfaceStore4 === void 0 ? void 0 : (_state$interfaceStore5 = _state$interfaceStore4.preferences) === null || _state$interfaceStore5 === void 0 ? void 0 : _state$interfaceStore5.features;
+    updatedInterfaceState = {
+      [interfaceStoreName]: { ...otherInterfaceState,
+        preferences: {
+          features: { ...otherInterfaceScopes,
+            [sourceStoreName]: undefined
+          }
+        }
+      }
+    };
+  }
+
+  let updatedSourceState;
+
+  if (sourceFeatures) {
+    var _state$sourceStoreNam3;
+
+    const otherSourceState = state === null || state === void 0 ? void 0 : state[sourceStoreName];
+    const sourcePreferences = state === null || state === void 0 ? void 0 : (_state$sourceStoreNam3 = state[sourceStoreName]) === null || _state$sourceStoreNam3 === void 0 ? void 0 : _state$sourceStoreNam3.preferences;
+    updatedSourceState = {
+      [sourceStoreName]: { ...otherSourceState,
+        preferences: { ...sourcePreferences,
+          features: undefined
+        }
+      }
+    };
+  } // Set the feature values in the interface store, the features
+  // object is keyed by 'scope', which matches the store name for
+  // the source.
+
+
+  return { ...state,
+    [preferencesStoreName]: {
+      preferences: { ...existingPreferences,
+        [sourceStoreName]: featuresToMigrate
+      }
+    },
+    ...updatedInterfaceState,
+    ...updatedSourceState
+  };
+}
+//# sourceMappingURL=move-feature-preferences.js.map

package/build-module/migrations/legacy-local-storage-data/move-feature-preferences.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences-persistence/src/migrations/legacy-local-storage-data/move-feature-preferences.js"],"names":["moveFeaturePreferences","state","sourceStoreName","preferencesStoreName","interfaceStoreName","interfaceFeatures","preferences","features","sourceFeatures","featuresToMigrate","existingPreferences","updatedInterfaceState","otherInterfaceState","otherInterfaceScopes","undefined","updatedSourceState","otherSourceState","sourcePreferences"],"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;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,eAAe,SAASA,sBAAT,CAAiCC,KAAjC,EAAwCC,eAAxC,EAA0D;AAAA;;AACxE,QAAMC,oBAAoB,GAAG,kBAA7B;AACA,QAAMC,kBAAkB,GAAG,gBAA3B,CAFwE,CAIxE;AACA;AACA;AACA;;AACA,QAAMC,iBAAiB,GACtBJ,KADsB,aACtBA,KADsB,gDACtBA,KAAK,CAAIG,kBAAJ,CADiB,oFACtB,sBAA+BE,WADT,qFACtB,uBAA4CC,QADtB,2DACtB,uBACCL,eADD,CADD;AAIA,QAAMM,cAAc,GAAGP,KAAH,aAAGA,KAAH,gDAAGA,KAAK,CAAIC,eAAJ,CAAR,oFAAG,sBAA4BI,WAA/B,2DAAG,uBAAyCC,QAAhE;AACA,QAAME,iBAAiB,GAAGJ,iBAAiB,GACxCA,iBADwC,GAExCG,cAFH;;AAIA,MAAK,CAAEC,iBAAP,EAA2B;AAC1B,WAAOR,KAAP;AACA;;AAED,QAAMS,mBAAmB,GAAGT,KAAH,aAAGA,KAAH,gDAAGA,KAAK,CAAIE,oBAAJ,CAAR,0DAAG,sBAAiCG,WAA7D,CArBwE,CAuBxE;;AACA,MAAKI,mBAAL,aAAKA,mBAAL,eAAKA,mBAAmB,CAAIR,eAAJ,CAAxB,EAAgD;AAC/C,WAAOD,KAAP;AACA;;AAED,MAAIU,qBAAJ;;AACA,MAAKN,iBAAL,EAAyB;AAAA;;AACxB,UAAMO,mBAAmB,GAAGX,KAAH,aAAGA,KAAH,uBAAGA,KAAK,CAAIG,kBAAJ,CAAjC;AACA,UAAMS,oBAAoB,GACzBZ,KADyB,aACzBA,KADyB,iDACzBA,KAAK,CAAIG,kBAAJ,CADoB,qFACzB,uBAA+BE,WADN,2DACzB,uBAA4CC,QAD7C;AAGAI,IAAAA,qBAAqB,GAAG;AACvB,OAAEP,kBAAF,GAAwB,EACvB,GAAGQ,mBADoB;AAEvBN,QAAAA,WAAW,EAAE;AACZC,UAAAA,QAAQ,EAAE,EACT,GAAGM,oBADM;AAET,aAAEX,eAAF,GAAqBY;AAFZ;AADE;AAFU;AADD,KAAxB;AAWA;;AAED,MAAIC,kBAAJ;;AACA,MAAKP,cAAL,EAAsB;AAAA;;AACrB,UAAMQ,gBAAgB,GAAGf,KAAH,aAAGA,KAAH,uBAAGA,KAAK,CAAIC,eAAJ,CAA9B;AACA,UAAMe,iBAAiB,GAAGhB,KAAH,aAAGA,KAAH,iDAAGA,KAAK,CAAIC,eAAJ,CAAR,2DAAG,uBAA4BI,WAAtD;AAEAS,IAAAA,kBAAkB,GAAG;AACpB,OAAEb,eAAF,GAAqB,EACpB,GAAGc,gBADiB;AAEpBV,QAAAA,WAAW,EAAE,EACZ,GAAGW,iBADS;AAEZV,UAAAA,QAAQ,EAAEO;AAFE;AAFO;AADD,KAArB;AASA,GA7DuE,CA+DxE;AACA;AACA;;;AACA,SAAO,EACN,GAAGb,KADG;AAEN,KAAEE,oBAAF,GAA0B;AACzBG,MAAAA,WAAW,EAAE,EACZ,GAAGI,mBADS;AAEZ,SAAER,eAAF,GAAqBO;AAFT;AADY,KAFpB;AAQN,OAAGE,qBARG;AASN,OAAGI;AATG,GAAP;AAWA","sourcesContent":["/**\n * Move the 'features' object in local storage from the sourceStoreName to the\n * preferences store data structure.\n *\n * Previously, editors used a data structure like this for feature preferences:\n * ```js\n * {\n *     'core/edit-post': {\n *         preferences: {\n *             features; {\n *                 topToolbar: true,\n *                 // ... other boolean 'feature' preferences\n *             },\n *         },\n *     },\n * }\n * ```\n *\n * And for a while these feature preferences lived in the interface package:\n * ```js\n * {\n *     'core/interface': {\n *         preferences: {\n *             features: {\n *                 'core/edit-post': {\n *                     topToolbar: true\n *                 }\n *             }\n *         }\n *     }\n * }\n * ```\n *\n * In the preferences store, 'features' aren't considered special, they're\n * merged to the root level of the scope along with other preferences:\n * ```js\n * {\n *     'core/preferences': {\n *         preferences: {\n *             'core/edit-post': {\n *                 topToolbar: true,\n *                 // ... any other preferences.\n *             }\n *         }\n *     }\n * }\n * ```\n *\n * This function handles moving from either the source store or the interface\n * store to the preferences data structure.\n *\n * @param {Object} state           The state before migration.\n * @param {string} sourceStoreName The name of the store that has persisted\n *                                 preferences to migrate to the preferences\n *                                 package.\n * @return {Object} The migrated state\n */\nexport default function moveFeaturePreferences( state, sourceStoreName ) {\n\tconst preferencesStoreName = 'core/preferences';\n\tconst interfaceStoreName = 'core/interface';\n\n\t// Features most recently (and briefly) lived in the interface package.\n\t// If data exists there, prioritize using that for the migration. If not\n\t// also check the original package as the user may have updated from an\n\t// older block editor version.\n\tconst interfaceFeatures =\n\t\tstate?.[ interfaceStoreName ]?.preferences?.features?.[\n\t\t\tsourceStoreName\n\t\t];\n\tconst sourceFeatures = state?.[ sourceStoreName ]?.preferences?.features;\n\tconst featuresToMigrate = interfaceFeatures\n\t\t? interfaceFeatures\n\t\t: sourceFeatures;\n\n\tif ( ! featuresToMigrate ) {\n\t\treturn state;\n\t}\n\n\tconst existingPreferences = state?.[ preferencesStoreName ]?.preferences;\n\n\t// Avoid migrating features again if they've previously been migrated.\n\tif ( existingPreferences?.[ sourceStoreName ] ) {\n\t\treturn state;\n\t}\n\n\tlet updatedInterfaceState;\n\tif ( interfaceFeatures ) {\n\t\tconst otherInterfaceState = state?.[ interfaceStoreName ];\n\t\tconst otherInterfaceScopes =\n\t\t\tstate?.[ interfaceStoreName ]?.preferences?.features;\n\n\t\tupdatedInterfaceState = {\n\t\t\t[ interfaceStoreName ]: {\n\t\t\t\t...otherInterfaceState,\n\t\t\t\tpreferences: {\n\t\t\t\t\tfeatures: {\n\t\t\t\t\t\t...otherInterfaceScopes,\n\t\t\t\t\t\t[ sourceStoreName ]: undefined,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t};\n\t}\n\n\tlet updatedSourceState;\n\tif ( sourceFeatures ) {\n\t\tconst otherSourceState = state?.[ sourceStoreName ];\n\t\tconst sourcePreferences = state?.[ sourceStoreName ]?.preferences;\n\n\t\tupdatedSourceState = {\n\t\t\t[ sourceStoreName ]: {\n\t\t\t\t...otherSourceState,\n\t\t\t\tpreferences: {\n\t\t\t\t\t...sourcePreferences,\n\t\t\t\t\tfeatures: undefined,\n\t\t\t\t},\n\t\t\t},\n\t\t};\n\t}\n\n\t// Set the feature values in the interface store, the features\n\t// object is keyed by 'scope', which matches the store name for\n\t// the source.\n\treturn {\n\t\t...state,\n\t\t[ preferencesStoreName ]: {\n\t\t\tpreferences: {\n\t\t\t\t...existingPreferences,\n\t\t\t\t[ sourceStoreName ]: featuresToMigrate,\n\t\t\t},\n\t\t},\n\t\t...updatedInterfaceState,\n\t\t...updatedSourceState,\n\t};\n}\n"]}

package/build-module/migrations/legacy-local-storage-data/move-individual-preference.js

@@ -0,0 +1,84 @@
+const identity = arg => arg;
+/**
+ * Migrates an individual item inside the `preferences` object for a package's store.
+ *
+ * Previously, some packages had individual 'preferences' of any data type, and many used
+ * complex nested data structures. For example:
+ * ```js
+ * {
+ *     'core/edit-post': {
+ *         preferences: {
+ *             panels: {
+ *                 publish: {
+ *                     opened: true,
+ *                     enabled: true,
+ *                 }
+ *             },
+ *             // ...other preferences.
+ *         },
+ *     },
+ * }
+ *
+ * This function supports moving an individual preference like 'panels' above into the
+ * preferences package data structure.
+ *
+ * It supports moving a preference to a particular scope in the preferences store and
+ * optionally converting the data using a `convert` function.
+ *
+ * ```
+ *
+ * @param {Object}    state        The original state.
+ * @param {Object}    migrate      An options object that contains details of the migration.
+ * @param {string}    migrate.from The name of the store to migrate from.
+ * @param {string}    migrate.to   The scope in the preferences store to migrate to.
+ * @param {string}    key          The key in the preferences object to migrate.
+ * @param {?Function} convert      A function that converts preferences from one format to another.
+ */
+
+
+export default function moveIndividualPreferenceToPreferences(state, _ref, key) {
+  var _state$sourceStoreNam, _state$sourceStoreNam2, _state$preferencesSto, _state$preferencesSto2, _state$preferencesSto3, _state$preferencesSto4, _state$preferencesSto5, _state$preferencesSto6, _state$sourceStoreNam3;
+
+  let {
+    from: sourceStoreName,
+    to: scope
+  } = _ref;
+  let convert = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : identity;
+  const preferencesStoreName = 'core/preferences';
+  const sourcePreference = state === null || state === void 0 ? void 0 : (_state$sourceStoreNam = state[sourceStoreName]) === null || _state$sourceStoreNam === void 0 ? void 0 : (_state$sourceStoreNam2 = _state$sourceStoreNam.preferences) === null || _state$sourceStoreNam2 === void 0 ? void 0 : _state$sourceStoreNam2[key]; // There's nothing to migrate, exit early.
+
+  if (sourcePreference === undefined) {
+    return state;
+  }
+
+  const targetPreference = state === null || state === void 0 ? void 0 : (_state$preferencesSto = state[preferencesStoreName]) === null || _state$preferencesSto === void 0 ? void 0 : (_state$preferencesSto2 = _state$preferencesSto.preferences) === null || _state$preferencesSto2 === void 0 ? void 0 : (_state$preferencesSto3 = _state$preferencesSto2[scope]) === null || _state$preferencesSto3 === void 0 ? void 0 : _state$preferencesSto3[key]; // There's existing data at the target, so don't overwrite it, exit early.
+
+  if (targetPreference) {
+    return state;
+  }
+
+  const otherScopes = state === null || state === void 0 ? void 0 : (_state$preferencesSto4 = state[preferencesStoreName]) === null || _state$preferencesSto4 === void 0 ? void 0 : _state$preferencesSto4.preferences;
+  const otherPreferences = state === null || state === void 0 ? void 0 : (_state$preferencesSto5 = state[preferencesStoreName]) === null || _state$preferencesSto5 === void 0 ? void 0 : (_state$preferencesSto6 = _state$preferencesSto5.preferences) === null || _state$preferencesSto6 === void 0 ? void 0 : _state$preferencesSto6[scope];
+  const otherSourceState = state === null || state === void 0 ? void 0 : state[sourceStoreName];
+  const allSourcePreferences = state === null || state === void 0 ? void 0 : (_state$sourceStoreNam3 = state[sourceStoreName]) === null || _state$sourceStoreNam3 === void 0 ? void 0 : _state$sourceStoreNam3.preferences; // Pass an object with the key and value as this allows the convert
+  // function to convert to a data structure that has different keys.
+
+  const convertedPreferences = convert({
+    [key]: sourcePreference
+  });
+  return { ...state,
+    [preferencesStoreName]: {
+      preferences: { ...otherScopes,
+        [scope]: { ...otherPreferences,
+          ...convertedPreferences
+        }
+      }
+    },
+    [sourceStoreName]: { ...otherSourceState,
+      preferences: { ...allSourcePreferences,
+        [key]: undefined
+      }
+    }
+  };
+}
+//# sourceMappingURL=move-individual-preference.js.map

package/build-module/migrations/legacy-local-storage-data/move-individual-preference.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences-persistence/src/migrations/legacy-local-storage-data/move-individual-preference.js"],"names":["identity","arg","moveIndividualPreferenceToPreferences","state","key","from","sourceStoreName","to","scope","convert","preferencesStoreName","sourcePreference","preferences","undefined","targetPreference","otherScopes","otherPreferences","otherSourceState","allSourcePreferences","convertedPreferences"],"mappings":"AAAA,MAAMA,QAAQ,GAAKC,GAAF,IAAWA,GAA5B;AAEA;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;AACA;AACA;AACA;AACA;;;AACA,eAAe,SAASC,qCAAT,CACdC,KADc,QAGdC,GAHc,EAKb;AAAA;;AAAA,MAHD;AAAEC,IAAAA,IAAI,EAAEC,eAAR;AAAyBC,IAAAA,EAAE,EAAEC;AAA7B,GAGC;AAAA,MADDC,OACC,uEADST,QACT;AACD,QAAMU,oBAAoB,GAAG,kBAA7B;AACA,QAAMC,gBAAgB,GAAGR,KAAH,aAAGA,KAAH,gDAAGA,KAAK,CAAIG,eAAJ,CAAR,oFAAG,sBAA4BM,WAA/B,2DAAG,uBAA2CR,GAA3C,CAAzB,CAFC,CAID;;AACA,MAAKO,gBAAgB,KAAKE,SAA1B,EAAsC;AACrC,WAAOV,KAAP;AACA;;AAED,QAAMW,gBAAgB,GACrBX,KADqB,aACrBA,KADqB,gDACrBA,KAAK,CAAIO,oBAAJ,CADgB,oFACrB,sBAAiCE,WADZ,qFACrB,uBAAgDJ,KAAhD,CADqB,2DACrB,uBAA2DJ,GAA3D,CADD,CATC,CAYD;;AACA,MAAKU,gBAAL,EAAwB;AACvB,WAAOX,KAAP;AACA;;AAED,QAAMY,WAAW,GAAGZ,KAAH,aAAGA,KAAH,iDAAGA,KAAK,CAAIO,oBAAJ,CAAR,2DAAG,uBAAiCE,WAArD;AACA,QAAMI,gBAAgB,GACrBb,KADqB,aACrBA,KADqB,iDACrBA,KAAK,CAAIO,oBAAJ,CADgB,qFACrB,uBAAiCE,WADZ,2DACrB,uBAAgDJ,KAAhD,CADD;AAGA,QAAMS,gBAAgB,GAAGd,KAAH,aAAGA,KAAH,uBAAGA,KAAK,CAAIG,eAAJ,CAA9B;AACA,QAAMY,oBAAoB,GAAGf,KAAH,aAAGA,KAAH,iDAAGA,KAAK,CAAIG,eAAJ,CAAR,2DAAG,uBAA4BM,WAAzD,CAtBC,CAwBD;AACA;;AACA,QAAMO,oBAAoB,GAAGV,OAAO,CAAE;AAAE,KAAEL,GAAF,GAASO;AAAX,GAAF,CAApC;AAEA,SAAO,EACN,GAAGR,KADG;AAEN,KAAEO,oBAAF,GAA0B;AACzBE,MAAAA,WAAW,EAAE,EACZ,GAAGG,WADS;AAEZ,SAAEP,KAAF,GAAW,EACV,GAAGQ,gBADO;AAEV,aAAGG;AAFO;AAFC;AADY,KAFpB;AAWN,KAAEb,eAAF,GAAqB,EACpB,GAAGW,gBADiB;AAEpBL,MAAAA,WAAW,EAAE,EACZ,GAAGM,oBADS;AAEZ,SAAEd,GAAF,GAASS;AAFG;AAFO;AAXf,GAAP;AAmBA","sourcesContent":["const identity = ( arg ) => arg;\n\n/**\n * Migrates an individual item inside the `preferences` object for a package's store.\n *\n * Previously, some packages had individual 'preferences' of any data type, and many used\n * complex nested data structures. For example:\n * ```js\n * {\n *     'core/edit-post': {\n *         preferences: {\n *             panels: {\n *                 publish: {\n *                     opened: true,\n *                     enabled: true,\n *                 }\n *             },\n *             // ...other preferences.\n *         },\n *     },\n * }\n *\n * This function supports moving an individual preference like 'panels' above into the\n * preferences package data structure.\n *\n * It supports moving a preference to a particular scope in the preferences store and\n * optionally converting the data using a `convert` function.\n *\n * ```\n *\n * @param {Object}    state        The original state.\n * @param {Object}    migrate      An options object that contains details of the migration.\n * @param {string}    migrate.from The name of the store to migrate from.\n * @param {string}    migrate.to   The scope in the preferences store to migrate to.\n * @param {string}    key          The key in the preferences object to migrate.\n * @param {?Function} convert      A function that converts preferences from one format to another.\n */\nexport default function moveIndividualPreferenceToPreferences(\n\tstate,\n\t{ from: sourceStoreName, to: scope },\n\tkey,\n\tconvert = identity\n) {\n\tconst preferencesStoreName = 'core/preferences';\n\tconst sourcePreference = state?.[ sourceStoreName ]?.preferences?.[ key ];\n\n\t// There's nothing to migrate, exit early.\n\tif ( sourcePreference === undefined ) {\n\t\treturn state;\n\t}\n\n\tconst targetPreference =\n\t\tstate?.[ preferencesStoreName ]?.preferences?.[ scope ]?.[ key ];\n\n\t// There's existing data at the target, so don't overwrite it, exit early.\n\tif ( targetPreference ) {\n\t\treturn state;\n\t}\n\n\tconst otherScopes = state?.[ preferencesStoreName ]?.preferences;\n\tconst otherPreferences =\n\t\tstate?.[ preferencesStoreName ]?.preferences?.[ scope ];\n\n\tconst otherSourceState = state?.[ sourceStoreName ];\n\tconst allSourcePreferences = state?.[ sourceStoreName ]?.preferences;\n\n\t// Pass an object with the key and value as this allows the convert\n\t// function to convert to a data structure that has different keys.\n\tconst convertedPreferences = convert( { [ key ]: sourcePreference } );\n\n\treturn {\n\t\t...state,\n\t\t[ preferencesStoreName ]: {\n\t\t\tpreferences: {\n\t\t\t\t...otherScopes,\n\t\t\t\t[ scope ]: {\n\t\t\t\t\t...otherPreferences,\n\t\t\t\t\t...convertedPreferences,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t[ sourceStoreName ]: {\n\t\t\t...otherSourceState,\n\t\t\tpreferences: {\n\t\t\t\t...allSourcePreferences,\n\t\t\t\t[ key ]: undefined,\n\t\t\t},\n\t\t},\n\t};\n}\n"]}