@wordpress/preferences-persistence 1.0.0

package/build-module/migrations/legacy-local-storage-data/move-interface-enable-items.js

@@ -0,0 +1,107 @@
+/**
+ * Migrates interface 'enableItems' data to the preferences store.
+ *
+ * The interface package stores this data in this format:
+ * ```js
+ * {
+ *     enableItems: {
+ *         singleEnableItems: {
+ * 	           complementaryArea: {
+ *                 'core/edit-post': 'edit-post/document',
+ *                 'core/edit-site': 'edit-site/global-styles',
+ *             }
+ *         },
+ *         multipleEnableItems: {
+ *             pinnedItems: {
+ *                 'core/edit-post': {
+ *                     'plugin-1': true,
+ *                 },
+ *                 'core/edit-site': {
+ *                     'plugin-2': true,
+ *                 },
+ *             },
+ *         }
+ *     }
+ * }
+ * ```
+ *
+ * and it should be converted it to:
+ * ```js
+ * {
+ *     'core/edit-post': {
+ *         complementaryArea: 'edit-post/document',
+ *         pinnedItems: {
+ *             'plugin-1': true,
+ *         },
+ *     },
+ *     'core/edit-site': {
+ *         complementaryArea: 'edit-site/global-styles',
+ *         pinnedItems: {
+ *             'plugin-2': true,
+ *         },
+ *     },
+ * }
+ * ```
+ *
+ * @param {Object} state The local storage state.
+ */
+export default function moveInterfaceEnableItems(state) {
+  var _state$interfaceStore, _state$preferencesSto, _state$preferencesSto2, _sourceEnableItems$si, _sourceEnableItems$si2, _sourceEnableItems$mu, _sourceEnableItems$mu2;
+
+  const interfaceStoreName = 'core/interface';
+  const preferencesStoreName = 'core/preferences';
+  const sourceEnableItems = state === null || state === void 0 ? void 0 : (_state$interfaceStore = state[interfaceStoreName]) === null || _state$interfaceStore === void 0 ? void 0 : _state$interfaceStore.enableItems; // There's nothing to migrate, exit early.
+
+  if (!sourceEnableItems) {
+    return state;
+  }
+
+  const allPreferences = (_state$preferencesSto = state === null || state === void 0 ? void 0 : (_state$preferencesSto2 = state[preferencesStoreName]) === null || _state$preferencesSto2 === void 0 ? void 0 : _state$preferencesSto2.preferences) !== null && _state$preferencesSto !== void 0 ? _state$preferencesSto : {}; // First convert complementaryAreas into the right format.
+  // Use the existing preferences as the accumulator so that the data is
+  // merged.
+
+  const sourceComplementaryAreas = (_sourceEnableItems$si = sourceEnableItems === null || sourceEnableItems === void 0 ? void 0 : (_sourceEnableItems$si2 = sourceEnableItems.singleEnableItems) === null || _sourceEnableItems$si2 === void 0 ? void 0 : _sourceEnableItems$si2.complementaryArea) !== null && _sourceEnableItems$si !== void 0 ? _sourceEnableItems$si : {};
+  const preferencesWithConvertedComplementaryAreas = Object.keys(sourceComplementaryAreas).reduce((accumulator, scope) => {
+    var _accumulator$scope;
+
+    const data = sourceComplementaryAreas[scope]; // Don't overwrite any existing data in the preferences store.
+
+    if (accumulator !== null && accumulator !== void 0 && (_accumulator$scope = accumulator[scope]) !== null && _accumulator$scope !== void 0 && _accumulator$scope.complementaryArea) {
+      return accumulator;
+    }
+
+    return { ...accumulator,
+      [scope]: { ...accumulator[scope],
+        complementaryArea: data
+      }
+    };
+  }, allPreferences); // Next feed the converted complementary areas back into a reducer that
+  // converts the pinned items, resulting in the fully migrated data.
+
+  const sourcePinnedItems = (_sourceEnableItems$mu = sourceEnableItems === null || sourceEnableItems === void 0 ? void 0 : (_sourceEnableItems$mu2 = sourceEnableItems.multipleEnableItems) === null || _sourceEnableItems$mu2 === void 0 ? void 0 : _sourceEnableItems$mu2.pinnedItems) !== null && _sourceEnableItems$mu !== void 0 ? _sourceEnableItems$mu : {};
+  const allConvertedData = Object.keys(sourcePinnedItems).reduce((accumulator, scope) => {
+    var _accumulator$scope2;
+
+    const data = sourcePinnedItems[scope]; // Don't overwrite any existing data in the preferences store.
+
+    if (accumulator !== null && accumulator !== void 0 && (_accumulator$scope2 = accumulator[scope]) !== null && _accumulator$scope2 !== void 0 && _accumulator$scope2.pinnedItems) {
+      return accumulator;
+    }
+
+    return { ...accumulator,
+      [scope]: { ...accumulator[scope],
+        pinnedItems: data
+      }
+    };
+  }, preferencesWithConvertedComplementaryAreas);
+  const otherInterfaceItems = state[interfaceStoreName];
+  return { ...state,
+    [preferencesStoreName]: {
+      preferences: allConvertedData
+    },
+    [interfaceStoreName]: { ...otherInterfaceItems,
+      enableItems: undefined
+    }
+  };
+}
+//# sourceMappingURL=move-interface-enable-items.js.map

package/build-module/migrations/legacy-local-storage-data/move-interface-enable-items.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences-persistence/src/migrations/legacy-local-storage-data/move-interface-enable-items.js"],"names":["moveInterfaceEnableItems","state","interfaceStoreName","preferencesStoreName","sourceEnableItems","enableItems","allPreferences","preferences","sourceComplementaryAreas","singleEnableItems","complementaryArea","preferencesWithConvertedComplementaryAreas","Object","keys","reduce","accumulator","scope","data","sourcePinnedItems","multipleEnableItems","pinnedItems","allConvertedData","otherInterfaceItems","undefined"],"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,eAAe,SAASA,wBAAT,CAAmCC,KAAnC,EAA2C;AAAA;;AACzD,QAAMC,kBAAkB,GAAG,gBAA3B;AACA,QAAMC,oBAAoB,GAAG,kBAA7B;AACA,QAAMC,iBAAiB,GAAGH,KAAH,aAAGA,KAAH,gDAAGA,KAAK,CAAIC,kBAAJ,CAAR,0DAAG,sBAA+BG,WAAzD,CAHyD,CAKzD;;AACA,MAAK,CAAED,iBAAP,EAA2B;AAC1B,WAAOH,KAAP;AACA;;AAED,QAAMK,cAAc,4BAAGL,KAAH,aAAGA,KAAH,iDAAGA,KAAK,CAAIE,oBAAJ,CAAR,2DAAG,uBAAiCI,WAApC,yEAAmD,EAAvE,CAVyD,CAYzD;AACA;AACA;;AACA,QAAMC,wBAAwB,4BAC7BJ,iBAD6B,aAC7BA,iBAD6B,iDAC7BA,iBAAiB,CAAEK,iBADU,2DAC7B,uBAAsCC,iBADT,yEAC8B,EAD5D;AAGA,QAAMC,0CAA0C,GAAGC,MAAM,CAACC,IAAP,CAClDL,wBADkD,EAEjDM,MAFiD,CAEzC,CAAEC,WAAF,EAAeC,KAAf,KAA0B;AAAA;;AACnC,UAAMC,IAAI,GAAGT,wBAAwB,CAAEQ,KAAF,CAArC,CADmC,CAGnC;;AACA,QAAKD,WAAL,aAAKA,WAAL,qCAAKA,WAAW,CAAIC,KAAJ,CAAhB,+CAAK,mBAAwBN,iBAA7B,EAAiD;AAChD,aAAOK,WAAP;AACA;;AAED,WAAO,EACN,GAAGA,WADG;AAEN,OAAEC,KAAF,GAAW,EACV,GAAGD,WAAW,CAAEC,KAAF,CADJ;AAEVN,QAAAA,iBAAiB,EAAEO;AAFT;AAFL,KAAP;AAOA,GAjBkD,EAiBhDX,cAjBgD,CAAnD,CAlByD,CAqCzD;AACA;;AACA,QAAMY,iBAAiB,4BACtBd,iBADsB,aACtBA,iBADsB,iDACtBA,iBAAiB,CAAEe,mBADG,2DACtB,uBAAwCC,WADlB,yEACiC,EADxD;AAEA,QAAMC,gBAAgB,GAAGT,MAAM,CAACC,IAAP,CAAaK,iBAAb,EAAiCJ,MAAjC,CACxB,CAAEC,WAAF,EAAeC,KAAf,KAA0B;AAAA;;AACzB,UAAMC,IAAI,GAAGC,iBAAiB,CAAEF,KAAF,CAA9B,CADyB,CAEzB;;AACA,QAAKD,WAAL,aAAKA,WAAL,sCAAKA,WAAW,CAAIC,KAAJ,CAAhB,gDAAK,oBAAwBI,WAA7B,EAA2C;AAC1C,aAAOL,WAAP;AACA;;AAED,WAAO,EACN,GAAGA,WADG;AAEN,OAAEC,KAAF,GAAW,EACV,GAAGD,WAAW,CAAEC,KAAF,CADJ;AAEVI,QAAAA,WAAW,EAAEH;AAFH;AAFL,KAAP;AAOA,GAfuB,EAgBxBN,0CAhBwB,CAAzB;AAmBA,QAAMW,mBAAmB,GAAGrB,KAAK,CAAEC,kBAAF,CAAjC;AAEA,SAAO,EACN,GAAGD,KADG;AAEN,KAAEE,oBAAF,GAA0B;AACzBI,MAAAA,WAAW,EAAEc;AADY,KAFpB;AAKN,KAAEnB,kBAAF,GAAwB,EACvB,GAAGoB,mBADoB;AAEvBjB,MAAAA,WAAW,EAAEkB;AAFU;AALlB,GAAP;AAUA","sourcesContent":["/**\n * Migrates interface 'enableItems' data to the preferences store.\n *\n * The interface package stores this data in this format:\n * ```js\n * {\n *     enableItems: {\n *         singleEnableItems: {\n * \t           complementaryArea: {\n *                 'core/edit-post': 'edit-post/document',\n *                 'core/edit-site': 'edit-site/global-styles',\n *             }\n *         },\n *         multipleEnableItems: {\n *             pinnedItems: {\n *                 'core/edit-post': {\n *                     'plugin-1': true,\n *                 },\n *                 'core/edit-site': {\n *                     'plugin-2': true,\n *                 },\n *             },\n *         }\n *     }\n * }\n * ```\n *\n * and it should be converted it to:\n * ```js\n * {\n *     'core/edit-post': {\n *         complementaryArea: 'edit-post/document',\n *         pinnedItems: {\n *             'plugin-1': true,\n *         },\n *     },\n *     'core/edit-site': {\n *         complementaryArea: 'edit-site/global-styles',\n *         pinnedItems: {\n *             'plugin-2': true,\n *         },\n *     },\n * }\n * ```\n *\n * @param {Object} state The local storage state.\n */\nexport default function moveInterfaceEnableItems( state ) {\n\tconst interfaceStoreName = 'core/interface';\n\tconst preferencesStoreName = 'core/preferences';\n\tconst sourceEnableItems = state?.[ interfaceStoreName ]?.enableItems;\n\n\t// There's nothing to migrate, exit early.\n\tif ( ! sourceEnableItems ) {\n\t\treturn state;\n\t}\n\n\tconst allPreferences = state?.[ preferencesStoreName ]?.preferences ?? {};\n\n\t// First convert complementaryAreas into the right format.\n\t// Use the existing preferences as the accumulator so that the data is\n\t// merged.\n\tconst sourceComplementaryAreas =\n\t\tsourceEnableItems?.singleEnableItems?.complementaryArea ?? {};\n\n\tconst preferencesWithConvertedComplementaryAreas = Object.keys(\n\t\tsourceComplementaryAreas\n\t).reduce( ( accumulator, scope ) => {\n\t\tconst data = sourceComplementaryAreas[ scope ];\n\n\t\t// Don't overwrite any existing data in the preferences store.\n\t\tif ( accumulator?.[ scope ]?.complementaryArea ) {\n\t\t\treturn accumulator;\n\t\t}\n\n\t\treturn {\n\t\t\t...accumulator,\n\t\t\t[ scope ]: {\n\t\t\t\t...accumulator[ scope ],\n\t\t\t\tcomplementaryArea: data,\n\t\t\t},\n\t\t};\n\t}, allPreferences );\n\n\t// Next feed the converted complementary areas back into a reducer that\n\t// converts the pinned items, resulting in the fully migrated data.\n\tconst sourcePinnedItems =\n\t\tsourceEnableItems?.multipleEnableItems?.pinnedItems ?? {};\n\tconst allConvertedData = Object.keys( sourcePinnedItems ).reduce(\n\t\t( accumulator, scope ) => {\n\t\t\tconst data = sourcePinnedItems[ scope ];\n\t\t\t// Don't overwrite any existing data in the preferences store.\n\t\t\tif ( accumulator?.[ scope ]?.pinnedItems ) {\n\t\t\t\treturn accumulator;\n\t\t\t}\n\n\t\t\treturn {\n\t\t\t\t...accumulator,\n\t\t\t\t[ scope ]: {\n\t\t\t\t\t...accumulator[ scope ],\n\t\t\t\t\tpinnedItems: data,\n\t\t\t\t},\n\t\t\t};\n\t\t},\n\t\tpreferencesWithConvertedComplementaryAreas\n\t);\n\n\tconst otherInterfaceItems = state[ interfaceStoreName ];\n\n\treturn {\n\t\t...state,\n\t\t[ preferencesStoreName ]: {\n\t\t\tpreferences: allConvertedData,\n\t\t},\n\t\t[ interfaceStoreName ]: {\n\t\t\t...otherInterfaceItems,\n\t\t\tenableItems: undefined,\n\t\t},\n\t};\n}\n"]}

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

@@ -0,0 +1,92 @@
+/**
+ * The interface package previously had a public API that could be used by
+ * plugins to set persisted boolean 'feature' preferences.
+ *
+ * While usage was likely non-existent or very small, this function ensures
+ * those are migrated to the preferences data structure. The interface
+ * package's APIs have now been deprecated and use the preferences store.
+ *
+ * This will convert data that looks like this:
+ * ```js
+ * {
+ *     'core/interface': {
+ *         preferences: {
+ *             features: {
+ *                 'my-plugin': {
+ *                     myPluginFeature: true
+ *                 }
+ *             }
+ *         }
+ *     }
+ * }
+ * ```
+ *
+ * To this:
+ * ```js
+ *  * {
+ *     'core/preferences': {
+ *         preferences: {
+ *             'my-plugin': {
+ *                 myPluginFeature: true
+ *             }
+ *         }
+ *     }
+ * }
+ * ```
+ *
+ * @param {Object} state The local storage state
+ *
+ * @return {Object} The state with third party preferences moved to the
+ *                  preferences data structure.
+ */
+export default function moveThirdPartyFeaturePreferencesToPreferences(state) {
+  var _state$interfaceStore, _state$interfaceStore2;
+
+  const interfaceStoreName = 'core/interface';
+  const preferencesStoreName = 'core/preferences';
+  const interfaceScopes = 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$interfaceStore2.features;
+  const interfaceScopeKeys = interfaceScopes ? Object.keys(interfaceScopes) : [];
+
+  if (!(interfaceScopeKeys !== null && interfaceScopeKeys !== void 0 && interfaceScopeKeys.length)) {
+    return state;
+  }
+
+  return interfaceScopeKeys.reduce(function (convertedState, scope) {
+    var _convertedState$prefe, _convertedState$prefe2, _convertedState$prefe3, _convertedState$inter, _convertedState$inter2;
+
+    if (scope.startsWith('core')) {
+      return convertedState;
+    }
+
+    const featuresToMigrate = interfaceScopes === null || interfaceScopes === void 0 ? void 0 : interfaceScopes[scope];
+
+    if (!featuresToMigrate) {
+      return convertedState;
+    }
+
+    const existingMigratedData = convertedState === null || convertedState === void 0 ? void 0 : (_convertedState$prefe = convertedState[preferencesStoreName]) === null || _convertedState$prefe === void 0 ? void 0 : (_convertedState$prefe2 = _convertedState$prefe.preferences) === null || _convertedState$prefe2 === void 0 ? void 0 : _convertedState$prefe2[scope];
+
+    if (existingMigratedData) {
+      return convertedState;
+    }
+
+    const otherPreferencesScopes = convertedState === null || convertedState === void 0 ? void 0 : (_convertedState$prefe3 = convertedState[preferencesStoreName]) === null || _convertedState$prefe3 === void 0 ? void 0 : _convertedState$prefe3.preferences;
+    const otherInterfaceState = convertedState === null || convertedState === void 0 ? void 0 : convertedState[interfaceStoreName];
+    const otherInterfaceScopes = convertedState === null || convertedState === void 0 ? void 0 : (_convertedState$inter = convertedState[interfaceStoreName]) === null || _convertedState$inter === void 0 ? void 0 : (_convertedState$inter2 = _convertedState$inter.preferences) === null || _convertedState$inter2 === void 0 ? void 0 : _convertedState$inter2.features;
+    return { ...convertedState,
+      [preferencesStoreName]: {
+        preferences: { ...otherPreferencesScopes,
+          [scope]: featuresToMigrate
+        }
+      },
+      [interfaceStoreName]: { ...otherInterfaceState,
+        preferences: {
+          features: { ...otherInterfaceScopes,
+            [scope]: undefined
+          }
+        }
+      }
+    };
+  }, state);
+}
+//# sourceMappingURL=move-third-party-feature-preferences.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/preferences-persistence/src/migrations/legacy-local-storage-data/move-third-party-feature-preferences.js"],"names":["moveThirdPartyFeaturePreferencesToPreferences","state","interfaceStoreName","preferencesStoreName","interfaceScopes","preferences","features","interfaceScopeKeys","Object","keys","length","reduce","convertedState","scope","startsWith","featuresToMigrate","existingMigratedData","otherPreferencesScopes","otherInterfaceState","otherInterfaceScopes","undefined"],"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,eAAe,SAASA,6CAAT,CAAwDC,KAAxD,EAAgE;AAAA;;AAC9E,QAAMC,kBAAkB,GAAG,gBAA3B;AACA,QAAMC,oBAAoB,GAAG,kBAA7B;AAEA,QAAMC,eAAe,GACpBH,KADoB,aACpBA,KADoB,gDACpBA,KAAK,CAAIC,kBAAJ,CADe,oFACpB,sBAA+BG,WADX,2DACpB,uBAA4CC,QAD7C;AAEA,QAAMC,kBAAkB,GAAGH,eAAe,GACvCI,MAAM,CAACC,IAAP,CAAaL,eAAb,CADuC,GAEvC,EAFH;;AAIA,MAAK,EAAEG,kBAAF,aAAEA,kBAAF,eAAEA,kBAAkB,CAAEG,MAAtB,CAAL,EAAoC;AACnC,WAAOT,KAAP;AACA;;AAED,SAAOM,kBAAkB,CAACI,MAAnB,CAA2B,UAAWC,cAAX,EAA2BC,KAA3B,EAAmC;AAAA;;AACpE,QAAKA,KAAK,CAACC,UAAN,CAAkB,MAAlB,CAAL,EAAkC;AACjC,aAAOF,cAAP;AACA;;AAED,UAAMG,iBAAiB,GAAGX,eAAH,aAAGA,eAAH,uBAAGA,eAAe,CAAIS,KAAJ,CAAzC;;AACA,QAAK,CAAEE,iBAAP,EAA2B;AAC1B,aAAOH,cAAP;AACA;;AAED,UAAMI,oBAAoB,GACzBJ,cADyB,aACzBA,cADyB,gDACzBA,cAAc,CAAIT,oBAAJ,CADW,oFACzB,sBAA0CE,WADjB,2DACzB,uBAAyDQ,KAAzD,CADD;;AAGA,QAAKG,oBAAL,EAA4B;AAC3B,aAAOJ,cAAP;AACA;;AAED,UAAMK,sBAAsB,GAC3BL,cAD2B,aAC3BA,cAD2B,iDAC3BA,cAAc,CAAIT,oBAAJ,CADa,2DAC3B,uBAA0CE,WAD3C;AAEA,UAAMa,mBAAmB,GAAGN,cAAH,aAAGA,cAAH,uBAAGA,cAAc,CAAIV,kBAAJ,CAA1C;AACA,UAAMiB,oBAAoB,GACzBP,cADyB,aACzBA,cADyB,gDACzBA,cAAc,CAAIV,kBAAJ,CADW,oFACzB,sBAAwCG,WADf,2DACzB,uBAAqDC,QADtD;AAGA,WAAO,EACN,GAAGM,cADG;AAEN,OAAET,oBAAF,GAA0B;AACzBE,QAAAA,WAAW,EAAE,EACZ,GAAGY,sBADS;AAEZ,WAAEJ,KAAF,GAAWE;AAFC;AADY,OAFpB;AAQN,OAAEb,kBAAF,GAAwB,EACvB,GAAGgB,mBADoB;AAEvBb,QAAAA,WAAW,EAAE;AACZC,UAAAA,QAAQ,EAAE,EACT,GAAGa,oBADM;AAET,aAAEN,KAAF,GAAWO;AAFF;AADE;AAFU;AARlB,KAAP;AAkBA,GAzCM,EAyCJnB,KAzCI,CAAP;AA0CA","sourcesContent":["/**\n * The interface package previously had a public API that could be used by\n * plugins to set persisted boolean 'feature' preferences.\n *\n * While usage was likely non-existent or very small, this function ensures\n * those are migrated to the preferences data structure. The interface\n * package's APIs have now been deprecated and use the preferences store.\n *\n * This will convert data that looks like this:\n * ```js\n * {\n *     'core/interface': {\n *         preferences: {\n *             features: {\n *                 'my-plugin': {\n *                     myPluginFeature: true\n *                 }\n *             }\n *         }\n *     }\n * }\n * ```\n *\n * To this:\n * ```js\n *  * {\n *     'core/preferences': {\n *         preferences: {\n *             'my-plugin': {\n *                 myPluginFeature: true\n *             }\n *         }\n *     }\n * }\n * ```\n *\n * @param {Object} state The local storage state\n *\n * @return {Object} The state with third party preferences moved to the\n *                  preferences data structure.\n */\nexport default function moveThirdPartyFeaturePreferencesToPreferences( state ) {\n\tconst interfaceStoreName = 'core/interface';\n\tconst preferencesStoreName = 'core/preferences';\n\n\tconst interfaceScopes =\n\t\tstate?.[ interfaceStoreName ]?.preferences?.features;\n\tconst interfaceScopeKeys = interfaceScopes\n\t\t? Object.keys( interfaceScopes )\n\t\t: [];\n\n\tif ( ! interfaceScopeKeys?.length ) {\n\t\treturn state;\n\t}\n\n\treturn interfaceScopeKeys.reduce( function ( convertedState, scope ) {\n\t\tif ( scope.startsWith( 'core' ) ) {\n\t\t\treturn convertedState;\n\t\t}\n\n\t\tconst featuresToMigrate = interfaceScopes?.[ scope ];\n\t\tif ( ! featuresToMigrate ) {\n\t\t\treturn convertedState;\n\t\t}\n\n\t\tconst existingMigratedData =\n\t\t\tconvertedState?.[ preferencesStoreName ]?.preferences?.[ scope ];\n\n\t\tif ( existingMigratedData ) {\n\t\t\treturn convertedState;\n\t\t}\n\n\t\tconst otherPreferencesScopes =\n\t\t\tconvertedState?.[ preferencesStoreName ]?.preferences;\n\t\tconst otherInterfaceState = convertedState?.[ interfaceStoreName ];\n\t\tconst otherInterfaceScopes =\n\t\t\tconvertedState?.[ interfaceStoreName ]?.preferences?.features;\n\n\t\treturn {\n\t\t\t...convertedState,\n\t\t\t[ preferencesStoreName ]: {\n\t\t\t\tpreferences: {\n\t\t\t\t\t...otherPreferencesScopes,\n\t\t\t\t\t[ scope ]: featuresToMigrate,\n\t\t\t\t},\n\t\t\t},\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[ scope ]: undefined,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t};\n\t}, state );\n}\n"]}

package/package.json

@@ -0,0 +1,37 @@
+{
+	"name": "@wordpress/preferences-persistence",
+	"version": "1.0.0",
+	"description": "Persistence utilities for `wordpress/preferences`.",
+	"author": "The WordPress Contributors",
+	"license": "GPL-2.0-or-later",
+	"keywords": [
+		"wordpress",
+		"gutenberg",
+		"preferences",
+		"settings"
+	],
+	"homepage": "https://github.com/WordPress/gutenberg/tree/HEAD/packages/preferences-persistence/README.md",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/WordPress/gutenberg.git",
+		"directory": "packages/preferences-persistence"
+	},
+	"bugs": {
+		"url": "https://github.com/WordPress/gutenberg/issues"
+	},
+	"engines": {
+		"node": ">=12"
+	},
+	"main": "build/index.js",
+	"module": "build-module/index.js",
+	"react-native": "src/index",
+	"sideEffects": false,
+	"dependencies": {
+		"@babel/runtime": "^7.16.0",
+		"@wordpress/api-fetch": "^6.5.0"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"gitHead": "4631d515033397fcfeda77e5755960253caef9bf"
+}

package/src/create/debounce-async.js

@@ -0,0 +1,75 @@
+/**
+ * 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.
+ */
+export default function debounceAsync( func, delayMS ) {
+	let timeoutId;
+	let activePromise;
+
+	return async function debounced( ...args ) {
+		// 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( ( ...thenArgs ) => {
+						resolve( ...thenArgs );
+					} )
+					.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( ( ...thenArgs ) => {
+						resolve( ...thenArgs );
+					} )
+					.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 );
+		} );
+	};
+}

package/src/create/index.js

@@ -0,0 +1,112 @@
+/**
+ * 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( {
+	preloadedData,
+	localStorageRestoreKey = 'WP_PREFERENCES_RESTORE_DATA',
+	requestDebounceMS = 2500,
+} = {} ) {
+	let cache = preloadedData;
+	const debouncedApiFetch = debounceAsync( apiFetch, requestDebounceMS );
+
+	async function get() {
+		if ( cache ) {
+			return cache;
+		}
+
+		const user = await apiFetch( {
+			path: '/wp/v2/users/me?context=edit',
+		} );
+
+		const serverData = 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?._modified ) || 0;
+		const localTimestamp = Date.parse( 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,
+	};
+}

package/src/create/test/debounce-async.js

@@ -0,0 +1,129 @@
+/**
+ * Internal dependencies
+ */
+import debounceAsync from '../debounce-async';
+
+// See https://stackoverflow.com/questions/52177631/jest-timer-and-promise-dont-work-well-settimeout-and-async-function.
+// Jest fake timers and async functions don't mix too well, since queued up
+// promises can prevent jest from calling timeouts.
+// This function flushes promises in the queue.
+function flushPromises() {
+	return new Promise( jest.requireActual( 'timers' ).setImmediate );
+}
+
+// Promisify a timeout for use with jest.fn.
+function timeout( milliseconds ) {
+	return new Promise( ( resolve ) => setTimeout( resolve, milliseconds ) );
+}
+
+describe( 'debounceAsync', () => {
+	it( 'uses a leading debounce, the first call happens immediately', () => {
+		const fn = jest.fn( async () => {} );
+		const debounced = debounceAsync( fn, 20 );
+		debounced();
+		expect( fn ).toHaveBeenCalledTimes( 1 );
+	} );
+
+	it( 'calls the function on the leading edge and then once on the trailing edge when there are multiple calls', async () => {
+		jest.useFakeTimers();
+		const fn = jest.fn( async () => {} );
+		const debounced = debounceAsync( fn, 20 );
+
+		debounced( 'A' );
+
+		expect( fn ).toHaveBeenCalledTimes( 1 );
+
+		debounced( 'B' );
+		debounced( 'C' );
+		debounced( 'D' );
+
+		await flushPromises();
+		jest.runAllTimers();
+
+		expect( fn ).toHaveBeenCalledTimes( 2 );
+		expect( fn ).toHaveBeenCalledWith( 'A' );
+		expect( fn ).toHaveBeenCalledWith( 'D' );
+
+		jest.runOnlyPendingTimers();
+		jest.useRealTimers();
+	} );
+
+	it( 'ensures the delay has elapsed between calls', async () => {
+		jest.useFakeTimers();
+		const fn = jest.fn( async () => timeout( 10 ) );
+		const debounced = debounceAsync( fn, 20 );
+
+		// The first call has been triggered, but will take 10ms to resolve.
+		debounced();
+		debounced();
+		debounced();
+		debounced();
+		expect( fn ).toHaveBeenCalledTimes( 1 );
+
+		// The first call has resolved. The delay period has started but has yet to finish.
+		await flushPromises();
+		jest.advanceTimersByTime( 11 );
+		expect( fn ).toHaveBeenCalledTimes( 1 );
+
+		// The second call is about to commence, but hasn't yet.
+		await flushPromises();
+		jest.advanceTimersByTime( 18 );
+		expect( fn ).toHaveBeenCalledTimes( 1 );
+
+		// The second call has now commenced.
+		await flushPromises();
+		jest.advanceTimersByTime( 2 );
+		expect( fn ).toHaveBeenCalledTimes( 2 );
+
+		// No more calls happen.
+		await flushPromises();
+		jest.runAllTimers();
+		expect( fn ).toHaveBeenCalledTimes( 2 );
+
+		jest.runOnlyPendingTimers();
+		jest.useRealTimers();
+	} );
+
+	it( 'is thenable, returning any data from promise resolution of the debounced function', async () => {
+		expect.assertions( 2 );
+		const fn = async () => 'test';
+		const debounced = debounceAsync( fn, 20 );
+
+		// Test the return value via awaiting.
+		const returnValue = await debounced();
+		expect( returnValue ).toBe( 'test' );
+
+		// Test then-ing.
+		await debounced().then( ( thenValue ) =>
+			expect( thenValue ).toBe( 'test' )
+		);
+	} );
+
+	it( 'is catchable', async () => {
+		expect.assertions( 2 );
+		const expectedError = new Error( 'test' );
+		const fn = async () => {
+			throw expectedError;
+		};
+
+		const debounced = debounceAsync( fn, 20 );
+
+		// Test traditional try/catch.
+		try {
+			await debounced();
+		} catch ( error ) {
+			// Disable reason - the test uses `expect.assertions` to ensure
+			// conditional assertions are called.
+			// eslint-disable-next-line jest/no-conditional-expect
+			expect( error ).toBe( expectedError );
+		}
+
+		// Test chained .catch().
+		await debounced().catch( ( error ) => {
+			// Disable reason - the test uses `expect.assertions` to ensure
+			// conditional assertions are called.
+			// eslint-disable-next-line jest/no-conditional-expect
+			expect( error ).toBe( expectedError );
+		} );
+	} );
+} );