@wordpress/private-apis 0.8.1

package/README.md

@@ -0,0 +1,98 @@
+# Private APIs
+
+`@wordpress/private-apis` enables sharing private `__experimental` APIs across `@wordpress` packages without
+[publicly exposing them to WordPress extenders](https://make.wordpress.org/core/2022/08/10/proposal-stop-merging-experimental-apis-from-gutenberg-to-wordpress-core/#respond).
+
+## Getting started
+
+Every `@wordpress` package wanting to privately access or expose experimental APIs must opt-in to `@wordpress/private-apis`:
+
+```js
+// In packages/block-editor/private-apis.js:
+import { __dangerousOptInToUnstableAPIsOnlyForCoreModules } from '@wordpress/private-apis';
+export const { lock, unlock } =
+	__dangerousOptInToUnstableAPIsOnlyForCoreModules(
+		'I know using unstable features means my plugin or theme will inevitably break on the next WordPress release.',
+		'@wordpress/block-editor' // Name of the package calling __dangerousOptInToUnstableAPIsOnlyForCoreModules,
+		// (not the name of the package whose APIs you want to access)
+	);
+```
+
+Each package may only opt in once. The function name communicates that plugins are not supposed to use it.
+
+The function will throw an error if the following conditions are not met:
+
+1. The first argument must exactly match the required consent string: `'I know using unstable features means my plugin or theme will inevitably break on the next WordPress release.'`.
+2. The second argument must be a known `@wordpress` package that hasn't yet opted into `@wordpress/private-apis`
+
+Once the opt-in is complete, the obtained `lock()` and `unlock()` utilities enable hiding `__experimental` APIs from the naked eye:
+
+```js
+// Say this object is exported from a package:
+export const publicObject = {};
+
+// However, this string is internal and should not be publicly available:
+const __experimentalString = '__experimental information';
+
+// Solution: lock the string "inside" of the object:
+lock( publicObject, __experimentalString );
+
+// The string is not nested in the object and cannot be extracted from it:
+console.log( publicObject );
+// {}
+
+// The only way to access the string is by "unlocking" the object:
+console.log( unlock( publicObject ) );
+// "__experimental information"
+
+// lock() accepts all data types, not just strings:
+export const anotherObject = {};
+lock( anotherObject, function __experimentalFn() {} );
+console.log( unlock( anotherObject ) );
+// function __experimentalFn() {}
+```
+
+Use `lock()` and `unlock()` to privately distribute the `__experimental` APIs across `@wordpress` packages:
+
+```js
+// In packages/package1/index.js:
+import { lock } from './private-apis';
+
+export const privateApis = {};
+/* Attach private data to the exported object */
+lock( privateApis, {
+	__experimentalFunction: function () {},
+} );
+
+// In packages/package2/index.js:
+import { privateApis } from '@wordpress/package1';
+import { unlock } from './private-apis';
+
+const { __experimentalFunction } = unlock( privateApis );
+```
+
+## Shipping experimental APIs
+
+See the [Experimental and Unstable APIs chapter of Coding Guidelines](/docs/contributors/code/coding-guidelines.md) to learn how `lock()` and `unlock()` can help
+you ship private experimental functions, arguments, components, properties, actions, selectors.
+
+## Technical limitations
+
+A determined developer who would want to use the private experimental APIs at all costs would have to:
+
+-   Realize a private importing system exists
+-   Read the code where the risks would be spelled out in capital letters
+-   Explicitly type out he or she is aware of the consequences
+-   Pretend to register a `@wordpress` package (and trigger an error as soon as the real package is loaded)
+
+Dangerously opting in to using these APIs by theme and plugin developers is not recommended. Furthermore, the WordPress Core philosophy to strive to maintain backward compatibility for third-party developers **does not apply** to experimental APIs registered via this package.
+
+The consent string for opting in to these APIs may change at any time and without notice. This change will break existing third-party code. Such a change may occur in either a major or minor release.
+
+## Contributing to this package
+
+This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects.
+
+To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md).
+
+<br /><br /><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>

package/build/implementation.js

@@ -0,0 +1,208 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.__dangerousOptInToUnstableAPIsOnlyForCoreModules = void 0;
+exports.allowCoreModule = allowCoreModule;
+exports.resetAllowedCoreModules = resetAllowedCoreModules;
+exports.resetRegisteredPrivateApis = resetRegisteredPrivateApis;
+
+/**
+ * wordpress/private-apis – the utilities to enable private cross-package
+ * exports of private APIs.
+ *
+ * This "implementation.js" file is needed for the sake of the unit tests. It
+ * exports more than the public API of the package to aid in testing.
+ */
+
+/**
+ * The list of core modules allowed to opt-in to the private APIs.
+ */
+const CORE_MODULES_USING_PRIVATE_APIS = ['@wordpress/block-editor', '@wordpress/block-library', '@wordpress/blocks', '@wordpress/components', '@wordpress/customize-widgets', '@wordpress/data', '@wordpress/edit-post', '@wordpress/edit-site', '@wordpress/edit-widgets', '@wordpress/editor'];
+/**
+ * A list of core modules that already opted-in to
+ * the privateApis package.
+ *
+ * @type {string[]}
+ */
+
+const registeredPrivateApis = [];
+/*
+ * Warning for theme and plugin developers.
+ *
+ * The use of private developer APIs is intended for use by WordPress Core
+ * and the Gutenberg plugin exclusively.
+ *
+ * Dangerously opting in to using these APIs is NOT RECOMMENDED. Furthermore,
+ * the WordPress Core philosophy to strive to maintain backward compatibility
+ * for third-party developers DOES NOT APPLY to private APIs.
+ *
+ * THE CONSENT STRING FOR OPTING IN TO THESE APIS MAY CHANGE AT ANY TIME AND
+ * WITHOUT NOTICE. THIS CHANGE WILL BREAK EXISTING THIRD-PARTY CODE. SUCH A
+ * CHANGE MAY OCCUR IN EITHER A MAJOR OR MINOR RELEASE.
+ */
+
+const requiredConsent = 'I know using unstable features means my plugin or theme will inevitably break on the next WordPress release.';
+/** @type {boolean} */
+
+let allowReRegistration; // Use try/catch to force "false" if the environment variable is not explicitly
+// set to true (e.g. when building WordPress core).
+
+try {
+  var _process$env$ALLOW_EX;
+
+  allowReRegistration = (_process$env$ALLOW_EX = process.env.ALLOW_EXPERIMENT_REREGISTRATION) !== null && _process$env$ALLOW_EX !== void 0 ? _process$env$ALLOW_EX : false;
+} catch (error) {
+  allowReRegistration = false;
+}
+/**
+ * Called by a @wordpress package wishing to opt-in to accessing or exposing
+ * private private APIs.
+ *
+ * @param {string} consent    The consent string.
+ * @param {string} moduleName The name of the module that is opting in.
+ * @return {{lock: typeof lock, unlock: typeof unlock}} An object containing the lock and unlock functions.
+ */
+
+
+const __dangerousOptInToUnstableAPIsOnlyForCoreModules = (consent, moduleName) => {
+  if (!CORE_MODULES_USING_PRIVATE_APIS.includes(moduleName)) {
+    throw new Error(`You tried to opt-in to unstable APIs as module "${moduleName}". ` + 'This feature is only for JavaScript modules shipped with WordPress core. ' + 'Please do not use it in plugins and themes as the unstable APIs will be removed ' + 'without a warning. If you ignore this error and depend on unstable features, ' + 'your product will inevitably break on one of the next WordPress releases.');
+  }
+
+  if (!allowReRegistration && registeredPrivateApis.includes(moduleName)) {
+    // This check doesn't play well with Story Books / Hot Module Reloading
+    // and isn't included in the Gutenberg plugin. It only matters in the
+    // WordPress core release.
+    throw new Error(`You tried to opt-in to unstable APIs as module "${moduleName}" which is already registered. ` + 'This feature is only for JavaScript modules shipped with WordPress core. ' + 'Please do not use it in plugins and themes as the unstable APIs will be removed ' + 'without a warning. If you ignore this error and depend on unstable features, ' + 'your product will inevitably break on one of the next WordPress releases.');
+  }
+
+  if (consent !== requiredConsent) {
+    throw new Error(`You tried to opt-in to unstable APIs without confirming you know the consequences. ` + 'This feature is only for JavaScript modules shipped with WordPress core. ' + 'Please do not use it in plugins and themes as the unstable APIs will removed ' + 'without a warning. If you ignore this error and depend on unstable features, ' + 'your product will inevitably break on the next WordPress release.');
+  }
+
+  registeredPrivateApis.push(moduleName);
+  return {
+    lock,
+    unlock
+  };
+};
+/**
+ * Binds private data to an object.
+ * It does not alter the passed object in any way, only
+ * registers it in an internal map of private data.
+ *
+ * The private data can't be accessed by any other means
+ * than the `unlock` function.
+ *
+ * @example
+ * ```js
+ * const object = {};
+ * const privateData = { a: 1 };
+ * lock( object, privateData );
+ *
+ * object
+ * // {}
+ *
+ * unlock( object );
+ * // { a: 1 }
+ * ```
+ *
+ * @param {any} object      The object to bind the private data to.
+ * @param {any} privateData The private data to bind to the object.
+ */
+
+
+exports.__dangerousOptInToUnstableAPIsOnlyForCoreModules = __dangerousOptInToUnstableAPIsOnlyForCoreModules;
+
+function lock(object, privateData) {
+  if (!object) {
+    throw new Error('Cannot lock an undefined object.');
+  }
+
+  if (!(__private in object)) {
+    object[__private] = {};
+  }
+
+  lockedData.set(object[__private], privateData);
+}
+/**
+ * Unlocks the private data bound to an object.
+ *
+ * It does not alter the passed object in any way, only
+ * returns the private data paired with it using the `lock()`
+ * function.
+ *
+ * @example
+ * ```js
+ * const object = {};
+ * const privateData = { a: 1 };
+ * lock( object, privateData );
+ *
+ * object
+ * // {}
+ *
+ * unlock( object );
+ * // { a: 1 }
+ * ```
+ *
+ * @param {any} object The object to unlock the private data from.
+ * @return {any} The private data bound to the object.
+ */
+
+
+function unlock(object) {
+  if (!object) {
+    throw new Error('Cannot unlock an undefined object.');
+  }
+
+  if (!(__private in object)) {
+    throw new Error('Cannot unlock an object that was not locked before. ');
+  }
+
+  return lockedData.get(object[__private]);
+}
+
+const lockedData = new WeakMap();
+/**
+ * Used by lock() and unlock() to uniquely identify the private data
+ * related to a containing object.
+ */
+
+const __private = Symbol('Private API ID'); // Unit tests utilities:
+
+/**
+ * Private function to allow the unit tests to allow
+ * a mock module to access the private APIs.
+ *
+ * @param {string} name The name of the module.
+ */
+
+
+function allowCoreModule(name) {
+  CORE_MODULES_USING_PRIVATE_APIS.push(name);
+}
+/**
+ * Private function to allow the unit tests to set
+ * a custom list of allowed modules.
+ */
+
+
+function resetAllowedCoreModules() {
+  while (CORE_MODULES_USING_PRIVATE_APIS.length) {
+    CORE_MODULES_USING_PRIVATE_APIS.pop();
+  }
+}
+/**
+ * Private function to allow the unit tests to reset
+ * the list of registered private apis.
+ */
+
+
+function resetRegisteredPrivateApis() {
+  while (registeredPrivateApis.length) {
+    registeredPrivateApis.pop();
+  }
+}
+//# sourceMappingURL=implementation.js.map

package/build/implementation.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/private-apis/src/implementation.js"],"names":["CORE_MODULES_USING_PRIVATE_APIS","registeredPrivateApis","requiredConsent","allowReRegistration","process","env","ALLOW_EXPERIMENT_REREGISTRATION","error","__dangerousOptInToUnstableAPIsOnlyForCoreModules","consent","moduleName","includes","Error","push","lock","unlock","object","privateData","__private","lockedData","set","get","WeakMap","Symbol","allowCoreModule","name","resetAllowedCoreModules","length","pop","resetRegisteredPrivateApis"],"mappings":";;;;;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA,MAAMA,+BAA+B,GAAG,CACvC,yBADuC,EAEvC,0BAFuC,EAGvC,mBAHuC,EAIvC,uBAJuC,EAKvC,8BALuC,EAMvC,iBANuC,EAOvC,sBAPuC,EAQvC,sBARuC,EASvC,yBATuC,EAUvC,mBAVuC,CAAxC;AAaA;AACA;AACA;AACA;AACA;AACA;;AACA,MAAMC,qBAAqB,GAAG,EAA9B;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,MAAMC,eAAe,GACpB,8GADD;AAGA;;AACA,IAAIC,mBAAJ,C,CACA;AACA;;AACA,IAAI;AAAA;;AACHA,EAAAA,mBAAmB,4BAAGC,OAAO,CAACC,GAAR,CAAYC,+BAAf,yEAAkD,KAArE;AACA,CAFD,CAEE,OAAQC,KAAR,EAAgB;AACjBJ,EAAAA,mBAAmB,GAAG,KAAtB;AACA;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,MAAMK,gDAAgD,GAAG,CAC/DC,OAD+D,EAE/DC,UAF+D,KAG3D;AACJ,MAAK,CAAEV,+BAA+B,CAACW,QAAhC,CAA0CD,UAA1C,CAAP,EAAgE;AAC/D,UAAM,IAAIE,KAAJ,CACJ,mDAAmDF,UAAY,KAAhE,GACC,2EADD,GAEC,kFAFD,GAGC,+EAHD,GAIC,2EALI,CAAN;AAOA;;AACD,MACC,CAAEP,mBAAF,IACAF,qBAAqB,CAACU,QAAtB,CAAgCD,UAAhC,CAFD,EAGE;AACD;AACA;AACA;AACA,UAAM,IAAIE,KAAJ,CACJ,mDAAmDF,UAAY,iCAAhE,GACC,2EADD,GAEC,kFAFD,GAGC,+EAHD,GAIC,2EALI,CAAN;AAOA;;AACD,MAAKD,OAAO,KAAKP,eAAjB,EAAmC;AAClC,UAAM,IAAIU,KAAJ,CACJ,qFAAD,GACC,2EADD,GAEC,+EAFD,GAGC,+EAHD,GAIC,mEALI,CAAN;AAOA;;AACDX,EAAAA,qBAAqB,CAACY,IAAtB,CAA4BH,UAA5B;AAEA,SAAO;AACNI,IAAAA,IADM;AAENC,IAAAA;AAFM,GAAP;AAIA,CA3CM;AA6CP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;;AACA,SAASD,IAAT,CAAeE,MAAf,EAAuBC,WAAvB,EAAqC;AACpC,MAAK,CAAED,MAAP,EAAgB;AACf,UAAM,IAAIJ,KAAJ,CAAW,kCAAX,CAAN;AACA;;AACD,MAAK,EAAIM,SAAS,IAAIF,MAAjB,CAAL,EAAiC;AAChCA,IAAAA,MAAM,CAAEE,SAAF,CAAN,GAAsB,EAAtB;AACA;;AACDC,EAAAA,UAAU,CAACC,GAAX,CAAgBJ,MAAM,CAAEE,SAAF,CAAtB,EAAqCD,WAArC;AACA;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACA,SAASF,MAAT,CAAiBC,MAAjB,EAA0B;AACzB,MAAK,CAAEA,MAAP,EAAgB;AACf,UAAM,IAAIJ,KAAJ,CAAW,oCAAX,CAAN;AACA;;AACD,MAAK,EAAIM,SAAS,IAAIF,MAAjB,CAAL,EAAiC;AAChC,UAAM,IAAIJ,KAAJ,CACL,sDADK,CAAN;AAGA;;AAED,SAAOO,UAAU,CAACE,GAAX,CAAgBL,MAAM,CAAEE,SAAF,CAAtB,CAAP;AACA;;AAED,MAAMC,UAAU,GAAG,IAAIG,OAAJ,EAAnB;AAEA;AACA;AACA;AACA;;AACA,MAAMJ,SAAS,GAAGK,MAAM,CAAE,gBAAF,CAAxB,C,CAEA;;AAEA;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASC,eAAT,CAA0BC,IAA1B,EAAiC;AACvCzB,EAAAA,+BAA+B,CAACa,IAAhC,CAAsCY,IAAtC;AACA;AAED;AACA;AACA;AACA;;;AACO,SAASC,uBAAT,GAAmC;AACzC,SAAQ1B,+BAA+B,CAAC2B,MAAxC,EAAiD;AAChD3B,IAAAA,+BAA+B,CAAC4B,GAAhC;AACA;AACD;AACD;AACA;AACA;AACA;;;AACO,SAASC,0BAAT,GAAsC;AAC5C,SAAQ5B,qBAAqB,CAAC0B,MAA9B,EAAuC;AACtC1B,IAAAA,qBAAqB,CAAC2B,GAAtB;AACA;AACD","sourcesContent":["/**\n * wordpress/private-apis – the utilities to enable private cross-package\n * exports of private APIs.\n *\n * This \"implementation.js\" file is needed for the sake of the unit tests. It\n * exports more than the public API of the package to aid in testing.\n */\n\n/**\n * The list of core modules allowed to opt-in to the private APIs.\n */\nconst CORE_MODULES_USING_PRIVATE_APIS = [\n\t'@wordpress/block-editor',\n\t'@wordpress/block-library',\n\t'@wordpress/blocks',\n\t'@wordpress/components',\n\t'@wordpress/customize-widgets',\n\t'@wordpress/data',\n\t'@wordpress/edit-post',\n\t'@wordpress/edit-site',\n\t'@wordpress/edit-widgets',\n\t'@wordpress/editor',\n];\n\n/**\n * A list of core modules that already opted-in to\n * the privateApis package.\n *\n * @type {string[]}\n */\nconst registeredPrivateApis = [];\n\n/*\n * Warning for theme and plugin developers.\n *\n * The use of private developer APIs is intended for use by WordPress Core\n * and the Gutenberg plugin exclusively.\n *\n * Dangerously opting in to using these APIs is NOT RECOMMENDED. Furthermore,\n * the WordPress Core philosophy to strive to maintain backward compatibility\n * for third-party developers DOES NOT APPLY to private APIs.\n *\n * THE CONSENT STRING FOR OPTING IN TO THESE APIS MAY CHANGE AT ANY TIME AND\n * WITHOUT NOTICE. THIS CHANGE WILL BREAK EXISTING THIRD-PARTY CODE. SUCH A\n * CHANGE MAY OCCUR IN EITHER A MAJOR OR MINOR RELEASE.\n */\nconst requiredConsent =\n\t'I know using unstable features means my plugin or theme will inevitably break on the next WordPress release.';\n\n/** @type {boolean} */\nlet allowReRegistration;\n// Use try/catch to force \"false\" if the environment variable is not explicitly\n// set to true (e.g. when building WordPress core).\ntry {\n\tallowReRegistration = process.env.ALLOW_EXPERIMENT_REREGISTRATION ?? false;\n} catch ( error ) {\n\tallowReRegistration = false;\n}\n\n/**\n * Called by a @wordpress package wishing to opt-in to accessing or exposing\n * private private APIs.\n *\n * @param {string} consent    The consent string.\n * @param {string} moduleName The name of the module that is opting in.\n * @return {{lock: typeof lock, unlock: typeof unlock}} An object containing the lock and unlock functions.\n */\nexport const __dangerousOptInToUnstableAPIsOnlyForCoreModules = (\n\tconsent,\n\tmoduleName\n) => {\n\tif ( ! CORE_MODULES_USING_PRIVATE_APIS.includes( moduleName ) ) {\n\t\tthrow new Error(\n\t\t\t`You tried to opt-in to unstable APIs as module \"${ moduleName }\". ` +\n\t\t\t\t'This feature is only for JavaScript modules shipped with WordPress core. ' +\n\t\t\t\t'Please do not use it in plugins and themes as the unstable APIs will be removed ' +\n\t\t\t\t'without a warning. If you ignore this error and depend on unstable features, ' +\n\t\t\t\t'your product will inevitably break on one of the next WordPress releases.'\n\t\t);\n\t}\n\tif (\n\t\t! allowReRegistration &&\n\t\tregisteredPrivateApis.includes( moduleName )\n\t) {\n\t\t// This check doesn't play well with Story Books / Hot Module Reloading\n\t\t// and isn't included in the Gutenberg plugin. It only matters in the\n\t\t// WordPress core release.\n\t\tthrow new Error(\n\t\t\t`You tried to opt-in to unstable APIs as module \"${ moduleName }\" which is already registered. ` +\n\t\t\t\t'This feature is only for JavaScript modules shipped with WordPress core. ' +\n\t\t\t\t'Please do not use it in plugins and themes as the unstable APIs will be removed ' +\n\t\t\t\t'without a warning. If you ignore this error and depend on unstable features, ' +\n\t\t\t\t'your product will inevitably break on one of the next WordPress releases.'\n\t\t);\n\t}\n\tif ( consent !== requiredConsent ) {\n\t\tthrow new Error(\n\t\t\t`You tried to opt-in to unstable APIs without confirming you know the consequences. ` +\n\t\t\t\t'This feature is only for JavaScript modules shipped with WordPress core. ' +\n\t\t\t\t'Please do not use it in plugins and themes as the unstable APIs will removed ' +\n\t\t\t\t'without a warning. If you ignore this error and depend on unstable features, ' +\n\t\t\t\t'your product will inevitably break on the next WordPress release.'\n\t\t);\n\t}\n\tregisteredPrivateApis.push( moduleName );\n\n\treturn {\n\t\tlock,\n\t\tunlock,\n\t};\n};\n\n/**\n * Binds private data to an object.\n * It does not alter the passed object in any way, only\n * registers it in an internal map of private data.\n *\n * The private data can't be accessed by any other means\n * than the `unlock` function.\n *\n * @example\n * ```js\n * const object = {};\n * const privateData = { a: 1 };\n * lock( object, privateData );\n *\n * object\n * // {}\n *\n * unlock( object );\n * // { a: 1 }\n * ```\n *\n * @param {any} object      The object to bind the private data to.\n * @param {any} privateData The private data to bind to the object.\n */\nfunction lock( object, privateData ) {\n\tif ( ! object ) {\n\t\tthrow new Error( 'Cannot lock an undefined object.' );\n\t}\n\tif ( ! ( __private in object ) ) {\n\t\tobject[ __private ] = {};\n\t}\n\tlockedData.set( object[ __private ], privateData );\n}\n\n/**\n * Unlocks the private data bound to an object.\n *\n * It does not alter the passed object in any way, only\n * returns the private data paired with it using the `lock()`\n * function.\n *\n * @example\n * ```js\n * const object = {};\n * const privateData = { a: 1 };\n * lock( object, privateData );\n *\n * object\n * // {}\n *\n * unlock( object );\n * // { a: 1 }\n * ```\n *\n * @param {any} object The object to unlock the private data from.\n * @return {any} The private data bound to the object.\n */\nfunction unlock( object ) {\n\tif ( ! object ) {\n\t\tthrow new Error( 'Cannot unlock an undefined object.' );\n\t}\n\tif ( ! ( __private in object ) ) {\n\t\tthrow new Error(\n\t\t\t'Cannot unlock an object that was not locked before. '\n\t\t);\n\t}\n\n\treturn lockedData.get( object[ __private ] );\n}\n\nconst lockedData = new WeakMap();\n\n/**\n * Used by lock() and unlock() to uniquely identify the private data\n * related to a containing object.\n */\nconst __private = Symbol( 'Private API ID' );\n\n// Unit tests utilities:\n\n/**\n * Private function to allow the unit tests to allow\n * a mock module to access the private APIs.\n *\n * @param {string} name The name of the module.\n */\nexport function allowCoreModule( name ) {\n\tCORE_MODULES_USING_PRIVATE_APIS.push( name );\n}\n\n/**\n * Private function to allow the unit tests to set\n * a custom list of allowed modules.\n */\nexport function resetAllowedCoreModules() {\n\twhile ( CORE_MODULES_USING_PRIVATE_APIS.length ) {\n\t\tCORE_MODULES_USING_PRIVATE_APIS.pop();\n\t}\n}\n/**\n * Private function to allow the unit tests to reset\n * the list of registered private apis.\n */\nexport function resetRegisteredPrivateApis() {\n\twhile ( registeredPrivateApis.length ) {\n\t\tregisteredPrivateApis.pop();\n\t}\n}\n"]}

package/build/index.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "__dangerousOptInToUnstableAPIsOnlyForCoreModules", {
+  enumerable: true,
+  get: function () {
+    return _implementation.__dangerousOptInToUnstableAPIsOnlyForCoreModules;
+  }
+});
+
+var _implementation = require("./implementation");
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/private-apis/src/index.js"],"names":[],"mappings":";;;;;;;;;;;;AAAA","sourcesContent":["export { __dangerousOptInToUnstableAPIsOnlyForCoreModules } from './implementation';\n"]}

package/build-module/implementation.js

@@ -0,0 +1,193 @@
+/**
+ * wordpress/private-apis – the utilities to enable private cross-package
+ * exports of private APIs.
+ *
+ * This "implementation.js" file is needed for the sake of the unit tests. It
+ * exports more than the public API of the package to aid in testing.
+ */
+
+/**
+ * The list of core modules allowed to opt-in to the private APIs.
+ */
+const CORE_MODULES_USING_PRIVATE_APIS = ['@wordpress/block-editor', '@wordpress/block-library', '@wordpress/blocks', '@wordpress/components', '@wordpress/customize-widgets', '@wordpress/data', '@wordpress/edit-post', '@wordpress/edit-site', '@wordpress/edit-widgets', '@wordpress/editor'];
+/**
+ * A list of core modules that already opted-in to
+ * the privateApis package.
+ *
+ * @type {string[]}
+ */
+
+const registeredPrivateApis = [];
+/*
+ * Warning for theme and plugin developers.
+ *
+ * The use of private developer APIs is intended for use by WordPress Core
+ * and the Gutenberg plugin exclusively.
+ *
+ * Dangerously opting in to using these APIs is NOT RECOMMENDED. Furthermore,
+ * the WordPress Core philosophy to strive to maintain backward compatibility
+ * for third-party developers DOES NOT APPLY to private APIs.
+ *
+ * THE CONSENT STRING FOR OPTING IN TO THESE APIS MAY CHANGE AT ANY TIME AND
+ * WITHOUT NOTICE. THIS CHANGE WILL BREAK EXISTING THIRD-PARTY CODE. SUCH A
+ * CHANGE MAY OCCUR IN EITHER A MAJOR OR MINOR RELEASE.
+ */
+
+const requiredConsent = 'I know using unstable features means my plugin or theme will inevitably break on the next WordPress release.';
+/** @type {boolean} */
+
+let allowReRegistration; // Use try/catch to force "false" if the environment variable is not explicitly
+// set to true (e.g. when building WordPress core).
+
+try {
+  var _process$env$ALLOW_EX;
+
+  allowReRegistration = (_process$env$ALLOW_EX = process.env.ALLOW_EXPERIMENT_REREGISTRATION) !== null && _process$env$ALLOW_EX !== void 0 ? _process$env$ALLOW_EX : false;
+} catch (error) {
+  allowReRegistration = false;
+}
+/**
+ * Called by a @wordpress package wishing to opt-in to accessing or exposing
+ * private private APIs.
+ *
+ * @param {string} consent    The consent string.
+ * @param {string} moduleName The name of the module that is opting in.
+ * @return {{lock: typeof lock, unlock: typeof unlock}} An object containing the lock and unlock functions.
+ */
+
+
+export const __dangerousOptInToUnstableAPIsOnlyForCoreModules = (consent, moduleName) => {
+  if (!CORE_MODULES_USING_PRIVATE_APIS.includes(moduleName)) {
+    throw new Error(`You tried to opt-in to unstable APIs as module "${moduleName}". ` + 'This feature is only for JavaScript modules shipped with WordPress core. ' + 'Please do not use it in plugins and themes as the unstable APIs will be removed ' + 'without a warning. If you ignore this error and depend on unstable features, ' + 'your product will inevitably break on one of the next WordPress releases.');
+  }
+
+  if (!allowReRegistration && registeredPrivateApis.includes(moduleName)) {
+    // This check doesn't play well with Story Books / Hot Module Reloading
+    // and isn't included in the Gutenberg plugin. It only matters in the
+    // WordPress core release.
+    throw new Error(`You tried to opt-in to unstable APIs as module "${moduleName}" which is already registered. ` + 'This feature is only for JavaScript modules shipped with WordPress core. ' + 'Please do not use it in plugins and themes as the unstable APIs will be removed ' + 'without a warning. If you ignore this error and depend on unstable features, ' + 'your product will inevitably break on one of the next WordPress releases.');
+  }
+
+  if (consent !== requiredConsent) {
+    throw new Error(`You tried to opt-in to unstable APIs without confirming you know the consequences. ` + 'This feature is only for JavaScript modules shipped with WordPress core. ' + 'Please do not use it in plugins and themes as the unstable APIs will removed ' + 'without a warning. If you ignore this error and depend on unstable features, ' + 'your product will inevitably break on the next WordPress release.');
+  }
+
+  registeredPrivateApis.push(moduleName);
+  return {
+    lock,
+    unlock
+  };
+};
+/**
+ * Binds private data to an object.
+ * It does not alter the passed object in any way, only
+ * registers it in an internal map of private data.
+ *
+ * The private data can't be accessed by any other means
+ * than the `unlock` function.
+ *
+ * @example
+ * ```js
+ * const object = {};
+ * const privateData = { a: 1 };
+ * lock( object, privateData );
+ *
+ * object
+ * // {}
+ *
+ * unlock( object );
+ * // { a: 1 }
+ * ```
+ *
+ * @param {any} object      The object to bind the private data to.
+ * @param {any} privateData The private data to bind to the object.
+ */
+
+function lock(object, privateData) {
+  if (!object) {
+    throw new Error('Cannot lock an undefined object.');
+  }
+
+  if (!(__private in object)) {
+    object[__private] = {};
+  }
+
+  lockedData.set(object[__private], privateData);
+}
+/**
+ * Unlocks the private data bound to an object.
+ *
+ * It does not alter the passed object in any way, only
+ * returns the private data paired with it using the `lock()`
+ * function.
+ *
+ * @example
+ * ```js
+ * const object = {};
+ * const privateData = { a: 1 };
+ * lock( object, privateData );
+ *
+ * object
+ * // {}
+ *
+ * unlock( object );
+ * // { a: 1 }
+ * ```
+ *
+ * @param {any} object The object to unlock the private data from.
+ * @return {any} The private data bound to the object.
+ */
+
+
+function unlock(object) {
+  if (!object) {
+    throw new Error('Cannot unlock an undefined object.');
+  }
+
+  if (!(__private in object)) {
+    throw new Error('Cannot unlock an object that was not locked before. ');
+  }
+
+  return lockedData.get(object[__private]);
+}
+
+const lockedData = new WeakMap();
+/**
+ * Used by lock() and unlock() to uniquely identify the private data
+ * related to a containing object.
+ */
+
+const __private = Symbol('Private API ID'); // Unit tests utilities:
+
+/**
+ * Private function to allow the unit tests to allow
+ * a mock module to access the private APIs.
+ *
+ * @param {string} name The name of the module.
+ */
+
+
+export function allowCoreModule(name) {
+  CORE_MODULES_USING_PRIVATE_APIS.push(name);
+}
+/**
+ * Private function to allow the unit tests to set
+ * a custom list of allowed modules.
+ */
+
+export function resetAllowedCoreModules() {
+  while (CORE_MODULES_USING_PRIVATE_APIS.length) {
+    CORE_MODULES_USING_PRIVATE_APIS.pop();
+  }
+}
+/**
+ * Private function to allow the unit tests to reset
+ * the list of registered private apis.
+ */
+
+export function resetRegisteredPrivateApis() {
+  while (registeredPrivateApis.length) {
+    registeredPrivateApis.pop();
+  }
+}
+//# sourceMappingURL=implementation.js.map

package/build-module/implementation.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/private-apis/src/implementation.js"],"names":["CORE_MODULES_USING_PRIVATE_APIS","registeredPrivateApis","requiredConsent","allowReRegistration","process","env","ALLOW_EXPERIMENT_REREGISTRATION","error","__dangerousOptInToUnstableAPIsOnlyForCoreModules","consent","moduleName","includes","Error","push","lock","unlock","object","privateData","__private","lockedData","set","get","WeakMap","Symbol","allowCoreModule","name","resetAllowedCoreModules","length","pop","resetRegisteredPrivateApis"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA,MAAMA,+BAA+B,GAAG,CACvC,yBADuC,EAEvC,0BAFuC,EAGvC,mBAHuC,EAIvC,uBAJuC,EAKvC,8BALuC,EAMvC,iBANuC,EAOvC,sBAPuC,EAQvC,sBARuC,EASvC,yBATuC,EAUvC,mBAVuC,CAAxC;AAaA;AACA;AACA;AACA;AACA;AACA;;AACA,MAAMC,qBAAqB,GAAG,EAA9B;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,MAAMC,eAAe,GACpB,8GADD;AAGA;;AACA,IAAIC,mBAAJ,C,CACA;AACA;;AACA,IAAI;AAAA;;AACHA,EAAAA,mBAAmB,4BAAGC,OAAO,CAACC,GAAR,CAAYC,+BAAf,yEAAkD,KAArE;AACA,CAFD,CAEE,OAAQC,KAAR,EAAgB;AACjBJ,EAAAA,mBAAmB,GAAG,KAAtB;AACA;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACA,OAAO,MAAMK,gDAAgD,GAAG,CAC/DC,OAD+D,EAE/DC,UAF+D,KAG3D;AACJ,MAAK,CAAEV,+BAA+B,CAACW,QAAhC,CAA0CD,UAA1C,CAAP,EAAgE;AAC/D,UAAM,IAAIE,KAAJ,CACJ,mDAAmDF,UAAY,KAAhE,GACC,2EADD,GAEC,kFAFD,GAGC,+EAHD,GAIC,2EALI,CAAN;AAOA;;AACD,MACC,CAAEP,mBAAF,IACAF,qBAAqB,CAACU,QAAtB,CAAgCD,UAAhC,CAFD,EAGE;AACD;AACA;AACA;AACA,UAAM,IAAIE,KAAJ,CACJ,mDAAmDF,UAAY,iCAAhE,GACC,2EADD,GAEC,kFAFD,GAGC,+EAHD,GAIC,2EALI,CAAN;AAOA;;AACD,MAAKD,OAAO,KAAKP,eAAjB,EAAmC;AAClC,UAAM,IAAIU,KAAJ,CACJ,qFAAD,GACC,2EADD,GAEC,+EAFD,GAGC,+EAHD,GAIC,mEALI,CAAN;AAOA;;AACDX,EAAAA,qBAAqB,CAACY,IAAtB,CAA4BH,UAA5B;AAEA,SAAO;AACNI,IAAAA,IADM;AAENC,IAAAA;AAFM,GAAP;AAIA,CA3CM;AA6CP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,SAASD,IAAT,CAAeE,MAAf,EAAuBC,WAAvB,EAAqC;AACpC,MAAK,CAAED,MAAP,EAAgB;AACf,UAAM,IAAIJ,KAAJ,CAAW,kCAAX,CAAN;AACA;;AACD,MAAK,EAAIM,SAAS,IAAIF,MAAjB,CAAL,EAAiC;AAChCA,IAAAA,MAAM,CAAEE,SAAF,CAAN,GAAsB,EAAtB;AACA;;AACDC,EAAAA,UAAU,CAACC,GAAX,CAAgBJ,MAAM,CAAEE,SAAF,CAAtB,EAAqCD,WAArC;AACA;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACA,SAASF,MAAT,CAAiBC,MAAjB,EAA0B;AACzB,MAAK,CAAEA,MAAP,EAAgB;AACf,UAAM,IAAIJ,KAAJ,CAAW,oCAAX,CAAN;AACA;;AACD,MAAK,EAAIM,SAAS,IAAIF,MAAjB,CAAL,EAAiC;AAChC,UAAM,IAAIJ,KAAJ,CACL,sDADK,CAAN;AAGA;;AAED,SAAOO,UAAU,CAACE,GAAX,CAAgBL,MAAM,CAAEE,SAAF,CAAtB,CAAP;AACA;;AAED,MAAMC,UAAU,GAAG,IAAIG,OAAJ,EAAnB;AAEA;AACA;AACA;AACA;;AACA,MAAMJ,SAAS,GAAGK,MAAM,CAAE,gBAAF,CAAxB,C,CAEA;;AAEA;AACA;AACA;AACA;AACA;AACA;;;AACA,OAAO,SAASC,eAAT,CAA0BC,IAA1B,EAAiC;AACvCzB,EAAAA,+BAA+B,CAACa,IAAhC,CAAsCY,IAAtC;AACA;AAED;AACA;AACA;AACA;;AACA,OAAO,SAASC,uBAAT,GAAmC;AACzC,SAAQ1B,+BAA+B,CAAC2B,MAAxC,EAAiD;AAChD3B,IAAAA,+BAA+B,CAAC4B,GAAhC;AACA;AACD;AACD;AACA;AACA;AACA;;AACA,OAAO,SAASC,0BAAT,GAAsC;AAC5C,SAAQ5B,qBAAqB,CAAC0B,MAA9B,EAAuC;AACtC1B,IAAAA,qBAAqB,CAAC2B,GAAtB;AACA;AACD","sourcesContent":["/**\n * wordpress/private-apis – the utilities to enable private cross-package\n * exports of private APIs.\n *\n * This \"implementation.js\" file is needed for the sake of the unit tests. It\n * exports more than the public API of the package to aid in testing.\n */\n\n/**\n * The list of core modules allowed to opt-in to the private APIs.\n */\nconst CORE_MODULES_USING_PRIVATE_APIS = [\n\t'@wordpress/block-editor',\n\t'@wordpress/block-library',\n\t'@wordpress/blocks',\n\t'@wordpress/components',\n\t'@wordpress/customize-widgets',\n\t'@wordpress/data',\n\t'@wordpress/edit-post',\n\t'@wordpress/edit-site',\n\t'@wordpress/edit-widgets',\n\t'@wordpress/editor',\n];\n\n/**\n * A list of core modules that already opted-in to\n * the privateApis package.\n *\n * @type {string[]}\n */\nconst registeredPrivateApis = [];\n\n/*\n * Warning for theme and plugin developers.\n *\n * The use of private developer APIs is intended for use by WordPress Core\n * and the Gutenberg plugin exclusively.\n *\n * Dangerously opting in to using these APIs is NOT RECOMMENDED. Furthermore,\n * the WordPress Core philosophy to strive to maintain backward compatibility\n * for third-party developers DOES NOT APPLY to private APIs.\n *\n * THE CONSENT STRING FOR OPTING IN TO THESE APIS MAY CHANGE AT ANY TIME AND\n * WITHOUT NOTICE. THIS CHANGE WILL BREAK EXISTING THIRD-PARTY CODE. SUCH A\n * CHANGE MAY OCCUR IN EITHER A MAJOR OR MINOR RELEASE.\n */\nconst requiredConsent =\n\t'I know using unstable features means my plugin or theme will inevitably break on the next WordPress release.';\n\n/** @type {boolean} */\nlet allowReRegistration;\n// Use try/catch to force \"false\" if the environment variable is not explicitly\n// set to true (e.g. when building WordPress core).\ntry {\n\tallowReRegistration = process.env.ALLOW_EXPERIMENT_REREGISTRATION ?? false;\n} catch ( error ) {\n\tallowReRegistration = false;\n}\n\n/**\n * Called by a @wordpress package wishing to opt-in to accessing or exposing\n * private private APIs.\n *\n * @param {string} consent    The consent string.\n * @param {string} moduleName The name of the module that is opting in.\n * @return {{lock: typeof lock, unlock: typeof unlock}} An object containing the lock and unlock functions.\n */\nexport const __dangerousOptInToUnstableAPIsOnlyForCoreModules = (\n\tconsent,\n\tmoduleName\n) => {\n\tif ( ! CORE_MODULES_USING_PRIVATE_APIS.includes( moduleName ) ) {\n\t\tthrow new Error(\n\t\t\t`You tried to opt-in to unstable APIs as module \"${ moduleName }\". ` +\n\t\t\t\t'This feature is only for JavaScript modules shipped with WordPress core. ' +\n\t\t\t\t'Please do not use it in plugins and themes as the unstable APIs will be removed ' +\n\t\t\t\t'without a warning. If you ignore this error and depend on unstable features, ' +\n\t\t\t\t'your product will inevitably break on one of the next WordPress releases.'\n\t\t);\n\t}\n\tif (\n\t\t! allowReRegistration &&\n\t\tregisteredPrivateApis.includes( moduleName )\n\t) {\n\t\t// This check doesn't play well with Story Books / Hot Module Reloading\n\t\t// and isn't included in the Gutenberg plugin. It only matters in the\n\t\t// WordPress core release.\n\t\tthrow new Error(\n\t\t\t`You tried to opt-in to unstable APIs as module \"${ moduleName }\" which is already registered. ` +\n\t\t\t\t'This feature is only for JavaScript modules shipped with WordPress core. ' +\n\t\t\t\t'Please do not use it in plugins and themes as the unstable APIs will be removed ' +\n\t\t\t\t'without a warning. If you ignore this error and depend on unstable features, ' +\n\t\t\t\t'your product will inevitably break on one of the next WordPress releases.'\n\t\t);\n\t}\n\tif ( consent !== requiredConsent ) {\n\t\tthrow new Error(\n\t\t\t`You tried to opt-in to unstable APIs without confirming you know the consequences. ` +\n\t\t\t\t'This feature is only for JavaScript modules shipped with WordPress core. ' +\n\t\t\t\t'Please do not use it in plugins and themes as the unstable APIs will removed ' +\n\t\t\t\t'without a warning. If you ignore this error and depend on unstable features, ' +\n\t\t\t\t'your product will inevitably break on the next WordPress release.'\n\t\t);\n\t}\n\tregisteredPrivateApis.push( moduleName );\n\n\treturn {\n\t\tlock,\n\t\tunlock,\n\t};\n};\n\n/**\n * Binds private data to an object.\n * It does not alter the passed object in any way, only\n * registers it in an internal map of private data.\n *\n * The private data can't be accessed by any other means\n * than the `unlock` function.\n *\n * @example\n * ```js\n * const object = {};\n * const privateData = { a: 1 };\n * lock( object, privateData );\n *\n * object\n * // {}\n *\n * unlock( object );\n * // { a: 1 }\n * ```\n *\n * @param {any} object      The object to bind the private data to.\n * @param {any} privateData The private data to bind to the object.\n */\nfunction lock( object, privateData ) {\n\tif ( ! object ) {\n\t\tthrow new Error( 'Cannot lock an undefined object.' );\n\t}\n\tif ( ! ( __private in object ) ) {\n\t\tobject[ __private ] = {};\n\t}\n\tlockedData.set( object[ __private ], privateData );\n}\n\n/**\n * Unlocks the private data bound to an object.\n *\n * It does not alter the passed object in any way, only\n * returns the private data paired with it using the `lock()`\n * function.\n *\n * @example\n * ```js\n * const object = {};\n * const privateData = { a: 1 };\n * lock( object, privateData );\n *\n * object\n * // {}\n *\n * unlock( object );\n * // { a: 1 }\n * ```\n *\n * @param {any} object The object to unlock the private data from.\n * @return {any} The private data bound to the object.\n */\nfunction unlock( object ) {\n\tif ( ! object ) {\n\t\tthrow new Error( 'Cannot unlock an undefined object.' );\n\t}\n\tif ( ! ( __private in object ) ) {\n\t\tthrow new Error(\n\t\t\t'Cannot unlock an object that was not locked before. '\n\t\t);\n\t}\n\n\treturn lockedData.get( object[ __private ] );\n}\n\nconst lockedData = new WeakMap();\n\n/**\n * Used by lock() and unlock() to uniquely identify the private data\n * related to a containing object.\n */\nconst __private = Symbol( 'Private API ID' );\n\n// Unit tests utilities:\n\n/**\n * Private function to allow the unit tests to allow\n * a mock module to access the private APIs.\n *\n * @param {string} name The name of the module.\n */\nexport function allowCoreModule( name ) {\n\tCORE_MODULES_USING_PRIVATE_APIS.push( name );\n}\n\n/**\n * Private function to allow the unit tests to set\n * a custom list of allowed modules.\n */\nexport function resetAllowedCoreModules() {\n\twhile ( CORE_MODULES_USING_PRIVATE_APIS.length ) {\n\t\tCORE_MODULES_USING_PRIVATE_APIS.pop();\n\t}\n}\n/**\n * Private function to allow the unit tests to reset\n * the list of registered private apis.\n */\nexport function resetRegisteredPrivateApis() {\n\twhile ( registeredPrivateApis.length ) {\n\t\tregisteredPrivateApis.pop();\n\t}\n}\n"]}

package/build-module/index.js

@@ -0,0 +1,2 @@
+export { __dangerousOptInToUnstableAPIsOnlyForCoreModules } from './implementation';
+//# sourceMappingURL=index.js.map

package/build-module/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["@wordpress/private-apis/src/index.js"],"names":["__dangerousOptInToUnstableAPIsOnlyForCoreModules"],"mappings":"AAAA,SAASA,gDAAT,QAAiE,kBAAjE","sourcesContent":["export { __dangerousOptInToUnstableAPIsOnlyForCoreModules } from './implementation';\n"]}

package/build-types/implementation.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Private function to allow the unit tests to allow
+ * a mock module to access the private APIs.
+ *
+ * @param {string} name The name of the module.
+ */
+export function allowCoreModule(name: string): void;
+/**
+ * Private function to allow the unit tests to set
+ * a custom list of allowed modules.
+ */
+export function resetAllowedCoreModules(): void;
+/**
+ * Private function to allow the unit tests to reset
+ * the list of registered private apis.
+ */
+export function resetRegisteredPrivateApis(): void;
+export function __dangerousOptInToUnstableAPIsOnlyForCoreModules(consent: string, moduleName: string): {
+    lock: typeof lock;
+    unlock: typeof unlock;
+};
+/**
+ * Binds private data to an object.
+ * It does not alter the passed object in any way, only
+ * registers it in an internal map of private data.
+ *
+ * The private data can't be accessed by any other means
+ * than the `unlock` function.
+ *
+ * @example
+ * ```js
+ * const object = {};
+ * const privateData = { a: 1 };
+ * lock( object, privateData );
+ *
+ * object
+ * // {}
+ *
+ * unlock( object );
+ * // { a: 1 }
+ * ```
+ *
+ * @param {any} object      The object to bind the private data to.
+ * @param {any} privateData The private data to bind to the object.
+ */
+declare function lock(object: any, privateData: any): void;
+/**
+ * Unlocks the private data bound to an object.
+ *
+ * It does not alter the passed object in any way, only
+ * returns the private data paired with it using the `lock()`
+ * function.
+ *
+ * @example
+ * ```js
+ * const object = {};
+ * const privateData = { a: 1 };
+ * lock( object, privateData );
+ *
+ * object
+ * // {}
+ *
+ * unlock( object );
+ * // { a: 1 }
+ * ```
+ *
+ * @param {any} object The object to unlock the private data from.
+ * @return {any} The private data bound to the object.
+ */
+declare function unlock(object: any): any;
+export {};
+//# sourceMappingURL=implementation.d.ts.map

package/build-types/implementation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"implementation.d.ts","sourceRoot":"","sources":["../src/implementation.js"],"names":[],"mappings":"AAgMA;;;;;GAKG;AACH,sCAFW,MAAM,QAIhB;AAED;;;GAGG;AACH,gDAIC;AACD;;;GAGG;AACH,mDAIC;AAxJM,0EAJI,MAAM,cACN,MAAM,GACL;IAAC,MAAM,WAAW,CAAC;IAAC,QAAQ,aAAa,CAAA;CAAC,CA6CrD;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,8BAHW,GAAG,eACH,GAAG,QAUb;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,gCAHW,GAAG,GACF,GAAG,CAad"}

package/build-types/index.d.ts

@@ -0,0 +1,2 @@
+export { __dangerousOptInToUnstableAPIsOnlyForCoreModules } from "./implementation";
+//# sourceMappingURL=index.d.ts.map

package/build-types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":""}