@wordpress/preferences-persistence 1.0.0

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

@@ -0,0 +1,135 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = moveFeaturePreferences;
+
+/**
+ * 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
+ */
+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/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;AACe,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/migrations/legacy-local-storage-data/move-individual-preference.js

@@ -0,0 +1,91 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = moveIndividualPreferenceToPreferences;
+
+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.
+ */
+
+
+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/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;;;AACe,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"]}

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

@@ -0,0 +1,114 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = moveInterfaceEnableItems;
+
+/**
+ * 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.
+ */
+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/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;AACe,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/migrations/legacy-local-storage-data/move-third-party-feature-preferences.js

@@ -0,0 +1,99 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = moveThirdPartyFeaturePreferencesToPreferences;
+
+/**
+ * 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.
+ */
+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/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;AACe,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/build-module/create/debounce-async.js

@@ -0,0 +1,73 @@
+/**
+ * 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() {
+    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-module/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;AACA,eAAe,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"]}