@wordpress/core-data 4.0.1 → 4.0.5

package/src/test/selectors.js

@@ -11,6 +11,7 @@ import {
 	__experimentalGetEntityRecordNoResolver,
 	hasEntityRecords,
 	getEntityRecords,
+	getRawEntityRecord,
 	__experimentalGetDirtyEntityRecords,
 	__experimentalGetEntitiesBeingSaved,
 	getEntityRecordNonTransientEdits,
@@ -204,6 +205,76 @@ describe( 'hasEntityRecords', () => {
 	} );
 } );
 
+describe( 'getRawEntityRecord', () => {
+	const data = {
+		someKind: {
+			someName: {
+				queriedData: {
+					items: {
+						default: {
+							post: {
+								title: {
+									raw: { html: '<h1>post</h1>' },
+									rendered:
+										'<div id="post"><h1>rendered post</h1></div>',
+								},
+							},
+						},
+					},
+					itemIsComplete: {
+						default: {
+							post: true,
+						},
+					},
+					queries: {},
+				},
+			},
+		},
+	};
+	it( 'should preserve the structure of `raw` field by default', () => {
+		const state = deepFreeze( {
+			entities: {
+				config: [
+					{
+						kind: 'someKind',
+						name: 'someName',
+					},
+				],
+				data: { ...data },
+			},
+		} );
+		expect(
+			getRawEntityRecord( state, 'someKind', 'someName', 'post' )
+		).toEqual( {
+			title: {
+				raw: { html: '<h1>post</h1>' },
+				rendered: '<div id="post"><h1>rendered post</h1></div>',
+			},
+		} );
+	} );
+	it( 'should flatten the structure of `raw` field for entities configured with rawAttributes', () => {
+		const state = deepFreeze( {
+			entities: {
+				config: [
+					{
+						kind: 'someKind',
+						name: 'someName',
+						rawAttributes: [ 'title' ],
+					},
+				],
+				data: { ...data },
+			},
+		} );
+		expect(
+			getRawEntityRecord( state, 'someKind', 'someName', 'post' )
+		).toEqual( {
+			title: {
+				html: '<h1>post</h1>',
+			},
+		} );
+	} );
+} );
+
 describe( 'getEntityRecords', () => {
 	it( 'should return null by default', () => {
 		const state = deepFreeze( {
@@ -347,7 +418,56 @@ describe( 'getEntityRecords', () => {
 } );
 
 describe( '__experimentalGetDirtyEntityRecords', () => {
-	it( 'should return a map of objects with each raw edited entity record and its corresponding edits', () => {
+	it( 'returns a map of objects with each raw edited entity record and its corresponding edits', () => {
+		const state = deepFreeze( {
+			entities: {
+				config: [
+					{
+						kind: 'someKind',
+						name: 'someName',
+						transientEdits: { someTransientEditProperty: true },
+					},
+				],
+				data: {
+					someKind: {
+						someName: {
+							queriedData: {
+								items: {
+									default: {
+										someKey: {
+											someProperty: 'somePersistedValue',
+											someRawProperty: {
+												raw: 'somePersistedRawValue',
+											},
+											id: 'someKey',
+										},
+									},
+								},
+								itemIsComplete: {
+									default: {
+										someKey: true,
+									},
+								},
+							},
+							edits: {
+								someKey: {
+									someProperty: 'someEditedValue',
+									someRawProperty: 'someEditedRawValue',
+									someTransientEditProperty:
+										'someEditedTransientEditValue',
+								},
+							},
+						},
+					},
+				},
+			},
+		} );
+		expect( __experimentalGetDirtyEntityRecords( state ) ).toEqual( [
+			{ kind: 'someKind', name: 'someName', key: 'someKey', title: '' },
+		] );
+	} );
+
+	it( 'excludes entity records that no longer exist', () => {
 		const state = deepFreeze( {
 			entities: {
 				config: [
@@ -385,6 +505,12 @@ describe( '__experimentalGetDirtyEntityRecords', () => {
 									someTransientEditProperty:
 										'someEditedTransientEditValue',
 								},
+								deletedKey: {
+									someProperty: 'someEditedValue',
+									someRawProperty: 'someEditedRawValue',
+									someTransientEditProperty:
+										'someEditedTransientEditValue',
+								},
 							},
 						},
 					},

package/src/utils/forward-resolver.js

@@ -0,0 +1,14 @@
+/**
+ * Higher-order function which forward the resolution to another resolver with the same arguments.
+ *
+ * @param {string} resolverName forwarded resolver.
+ *
+ * @return {Function} Enhanced resolver.
+ */
+const forwardResolver = ( resolverName ) => ( ...args ) => async ( {
+	resolveSelect,
+} ) => {
+	await resolveSelect[ resolverName ]( ...args );
+};
+
+export default forwardResolver;

package/src/utils/index.js

@@ -1,7 +1,8 @@
 export { default as conservativeMapItem } from './conservative-map-item';
 export { default as getNormalizedCommaSeparable } from './get-normalized-comma-separable';
 export { default as ifMatchingAction } from './if-matching-action';
-export { default as ifNotResolved } from './if-not-resolved';
+export { default as forwardResolver } from './forward-resolver';
 export { default as onSubKey } from './on-sub-key';
 export { default as replaceAction } from './replace-action';
 export { default as withWeakMapCache } from './with-weak-map-cache';
+export { default as isRawAttribute } from './is-raw-attribute';

package/src/utils/is-raw-attribute.js

@@ -0,0 +1,11 @@
+/**
+ * Checks whether the attribute is a "raw" attribute or not.
+ *
+ * @param {Object} entity    Entity data.
+ * @param {string} attribute Attribute name.
+ *
+ * @return {boolean} Is the attribute raw
+ */
+export default function isRawAttribute( entity, attribute ) {
+	return ( entity.rawAttributes || [] ).includes( attribute );
+}

package/src/utils/test/is-raw-attribute.js

@@ -0,0 +1,22 @@
+/**
+ * Internal dependencies
+ */
+import { isRawAttribute } from '../';
+
+describe( 'isRawAttribute', () => {
+	it( 'should correctly assess that the attribute is not raw', () => {
+		const entity = {
+			kind: 'someKind',
+			name: 'someName',
+		};
+		expect( isRawAttribute( entity, 'title' ) ).toBe( false );
+	} );
+	it( 'should correctly assess that the attribute is raw', () => {
+		const entity = {
+			kind: 'someKind',
+			name: 'someName',
+			rawAttributes: [ 'title' ],
+		};
+		expect( isRawAttribute( entity, 'title' ) ).toBe( true );
+	} );
+} );

package/build/controls.js

@@ -1,44 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.regularFetch = regularFetch;
-exports.getDispatch = getDispatch;
-exports.default = void 0;
-
-var _data = require("@wordpress/data");
-
-/**
- * WordPress dependencies
- */
-function regularFetch(url) {
-  return {
-    type: 'REGULAR_FETCH',
-    url
-  };
-}
-
-function getDispatch() {
-  return {
-    type: 'GET_DISPATCH'
-  };
-}
-
-const controls = {
-  async REGULAR_FETCH({
-    url
-  }) {
-    const {
-      data
-    } = await window.fetch(url).then(res => res.json());
-    return data;
-  },
-
-  GET_DISPATCH: (0, _data.createRegistryControl)(({
-    dispatch
-  }) => () => dispatch)
-};
-var _default = controls;
-exports.default = _default;
-//# sourceMappingURL=controls.js.map

package/build/controls.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["@wordpress/core-data/src/controls.js"],"names":["regularFetch","url","type","getDispatch","controls","REGULAR_FETCH","data","window","fetch","then","res","json","GET_DISPATCH","dispatch"],"mappings":";;;;;;;;;AAGA;;AAHA;AACA;AACA;AAGO,SAASA,YAAT,CAAuBC,GAAvB,EAA6B;AACnC,SAAO;AACNC,IAAAA,IAAI,EAAE,eADA;AAEND,IAAAA;AAFM,GAAP;AAIA;;AAEM,SAASE,WAAT,GAAuB;AAC7B,SAAO;AACND,IAAAA,IAAI,EAAE;AADA,GAAP;AAGA;;AAED,MAAME,QAAQ,GAAG;AAChB,QAAMC,aAAN,CAAqB;AAAEJ,IAAAA;AAAF,GAArB,EAA+B;AAC9B,UAAM;AAAEK,MAAAA;AAAF,QAAW,MAAMC,MAAM,CAC3BC,KADqB,CACdP,GADc,EAErBQ,IAFqB,CAEbC,GAAF,IAAWA,GAAG,CAACC,IAAJ,EAFI,CAAvB;AAIA,WAAOL,IAAP;AACA,GAPe;;AAShBM,EAAAA,YAAY,EAAE,iCAAuB,CAAE;AAAEC,IAAAA;AAAF,GAAF,KAAoB,MAAMA,QAAjD;AATE,CAAjB;eAYeT,Q","sourcesContent":["/**\n * WordPress dependencies\n */\nimport { createRegistryControl } from '@wordpress/data';\n\nexport function regularFetch( url ) {\n\treturn {\n\t\ttype: 'REGULAR_FETCH',\n\t\turl,\n\t};\n}\n\nexport function getDispatch() {\n\treturn {\n\t\ttype: 'GET_DISPATCH',\n\t};\n}\n\nconst controls = {\n\tasync REGULAR_FETCH( { url } ) {\n\t\tconst { data } = await window\n\t\t\t.fetch( url )\n\t\t\t.then( ( res ) => res.json() );\n\n\t\treturn data;\n\t},\n\n\tGET_DISPATCH: createRegistryControl( ( { dispatch } ) => () => dispatch ),\n};\n\nexport default controls;\n"]}

package/build/locks/index.js

@@ -1,47 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _exportNames = {
-  reducer: true
-};
-Object.defineProperty(exports, "reducer", {
-  enumerable: true,
-  get: function () {
-    return _reducer.default;
-  }
-});
-
-var _actions = require("./actions");
-
-Object.keys(_actions).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
-  if (key in exports && exports[key] === _actions[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _actions[key];
-    }
-  });
-});
-
-var _selectors = require("./selectors");
-
-Object.keys(_selectors).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
-  if (key in exports && exports[key] === _selectors[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _selectors[key];
-    }
-  });
-});
-
-var _reducer = _interopRequireDefault(require("./reducer"));
-//# sourceMappingURL=index.js.map

package/build/locks/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["@wordpress/core-data/src/locks/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AACA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AACA","sourcesContent":["export * from './actions';\nexport * from './selectors';\nexport { default as reducer } from './reducer';\n"]}

package/build/utils/if-not-resolved.js

@@ -1,46 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _data = require("@wordpress/data");
-
-var _name = require("../name");
-
-/**
- * WordPress dependencies
- */
-
-/**
- * Internal dependencies
- */
-
-/**
- * Higher-order function which invokes the given resolver only if it has not
- * already been resolved with the arguments passed to the enhanced function.
- *
- * This only considers resolution state, and notably does not support resolver
- * custom `isFulfilled` behavior.
- *
- * @param {Function} resolver     Original resolver.
- * @param {string}   selectorName Selector name associated with resolver.
- *
- * @return {Function} Enhanced resolver.
- */
-const ifNotResolved = (resolver, selectorName) =>
-/**
- * @param {...any} args Original resolver arguments.
- */
-function* resolveIfNotResolved(...args) {
-  const hasStartedResolution = yield _data.controls.select(_name.STORE_NAME, 'hasStartedResolution', selectorName, args);
-
-  if (!hasStartedResolution) {
-    yield* resolver(...args);
-  }
-};
-
-var _default = ifNotResolved;
-exports.default = _default;
-//# sourceMappingURL=if-not-resolved.js.map

package/build/utils/if-not-resolved.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["@wordpress/core-data/src/utils/if-not-resolved.js"],"names":["ifNotResolved","resolver","selectorName","resolveIfNotResolved","args","hasStartedResolution","controls","select","STORE_NAME"],"mappings":";;;;;;;AAGA;;AAKA;;AARA;AACA;AACA;;AAGA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMA,aAAa,GAAG,CAAEC,QAAF,EAAYC,YAAZ;AACrB;AACD;AACA;AACC,UAAUC,oBAAV,CAAgC,GAAGC,IAAnC,EAA0C;AACzC,QAAMC,oBAAoB,GAAG,MAAMC,eAASC,MAAT,CAClCC,gBADkC,EAElC,sBAFkC,EAGlCN,YAHkC,EAIlCE,IAJkC,CAAnC;;AAOA,MAAK,CAAEC,oBAAP,EAA8B;AAC7B,WAAOJ,QAAQ,CAAE,GAAGG,IAAL,CAAf;AACA;AACD,CAfF;;eAiBeJ,a","sourcesContent":["/**\n * WordPress dependencies\n */\nimport { controls } from '@wordpress/data';\n\n/**\n * Internal dependencies\n */\nimport { STORE_NAME } from '../name';\n\n/**\n * Higher-order function which invokes the given resolver only if it has not\n * already been resolved with the arguments passed to the enhanced function.\n *\n * This only considers resolution state, and notably does not support resolver\n * custom `isFulfilled` behavior.\n *\n * @param {Function} resolver     Original resolver.\n * @param {string}   selectorName Selector name associated with resolver.\n *\n * @return {Function} Enhanced resolver.\n */\nconst ifNotResolved = ( resolver, selectorName ) =>\n\t/**\n\t * @param {...any} args Original resolver arguments.\n\t */\n\tfunction* resolveIfNotResolved( ...args ) {\n\t\tconst hasStartedResolution = yield controls.select(\n\t\t\tSTORE_NAME,\n\t\t\t'hasStartedResolution',\n\t\t\tselectorName,\n\t\t\targs\n\t\t);\n\n\t\tif ( ! hasStartedResolution ) {\n\t\t\tyield* resolver( ...args );\n\t\t}\n\t};\n\nexport default ifNotResolved;\n"]}

package/build-module/controls.js

@@ -1,31 +0,0 @@
-/**
- * WordPress dependencies
- */
-import { createRegistryControl } from '@wordpress/data';
-export function regularFetch(url) {
-  return {
-    type: 'REGULAR_FETCH',
-    url
-  };
-}
-export function getDispatch() {
-  return {
-    type: 'GET_DISPATCH'
-  };
-}
-const controls = {
-  async REGULAR_FETCH({
-    url
-  }) {
-    const {
-      data
-    } = await window.fetch(url).then(res => res.json());
-    return data;
-  },
-
-  GET_DISPATCH: createRegistryControl(({
-    dispatch
-  }) => () => dispatch)
-};
-export default controls;
-//# sourceMappingURL=controls.js.map

package/build-module/controls.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["@wordpress/core-data/src/controls.js"],"names":["createRegistryControl","regularFetch","url","type","getDispatch","controls","REGULAR_FETCH","data","window","fetch","then","res","json","GET_DISPATCH","dispatch"],"mappings":"AAAA;AACA;AACA;AACA,SAASA,qBAAT,QAAsC,iBAAtC;AAEA,OAAO,SAASC,YAAT,CAAuBC,GAAvB,EAA6B;AACnC,SAAO;AACNC,IAAAA,IAAI,EAAE,eADA;AAEND,IAAAA;AAFM,GAAP;AAIA;AAED,OAAO,SAASE,WAAT,GAAuB;AAC7B,SAAO;AACND,IAAAA,IAAI,EAAE;AADA,GAAP;AAGA;AAED,MAAME,QAAQ,GAAG;AAChB,QAAMC,aAAN,CAAqB;AAAEJ,IAAAA;AAAF,GAArB,EAA+B;AAC9B,UAAM;AAAEK,MAAAA;AAAF,QAAW,MAAMC,MAAM,CAC3BC,KADqB,CACdP,GADc,EAErBQ,IAFqB,CAEbC,GAAF,IAAWA,GAAG,CAACC,IAAJ,EAFI,CAAvB;AAIA,WAAOL,IAAP;AACA,GAPe;;AAShBM,EAAAA,YAAY,EAAEb,qBAAqB,CAAE,CAAE;AAAEc,IAAAA;AAAF,GAAF,KAAoB,MAAMA,QAA5B;AATnB,CAAjB;AAYA,eAAeT,QAAf","sourcesContent":["/**\n * WordPress dependencies\n */\nimport { createRegistryControl } from '@wordpress/data';\n\nexport function regularFetch( url ) {\n\treturn {\n\t\ttype: 'REGULAR_FETCH',\n\t\turl,\n\t};\n}\n\nexport function getDispatch() {\n\treturn {\n\t\ttype: 'GET_DISPATCH',\n\t};\n}\n\nconst controls = {\n\tasync REGULAR_FETCH( { url } ) {\n\t\tconst { data } = await window\n\t\t\t.fetch( url )\n\t\t\t.then( ( res ) => res.json() );\n\n\t\treturn data;\n\t},\n\n\tGET_DISPATCH: createRegistryControl( ( { dispatch } ) => () => dispatch ),\n};\n\nexport default controls;\n"]}

package/build-module/locks/index.js

@@ -1,4 +0,0 @@
-export * from './actions';
-export * from './selectors';
-export { default as reducer } from './reducer';
-//# sourceMappingURL=index.js.map

package/build-module/locks/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["@wordpress/core-data/src/locks/index.js"],"names":["default","reducer"],"mappings":"AAAA,cAAc,WAAd;AACA,cAAc,aAAd;AACA,SAASA,OAAO,IAAIC,OAApB,QAAmC,WAAnC","sourcesContent":["export * from './actions';\nexport * from './selectors';\nexport { default as reducer } from './reducer';\n"]}

package/build-module/utils/if-not-resolved.js

@@ -1,36 +0,0 @@
-/**
- * WordPress dependencies
- */
-import { controls } from '@wordpress/data';
-/**
- * Internal dependencies
- */
-
-import { STORE_NAME } from '../name';
-/**
- * Higher-order function which invokes the given resolver only if it has not
- * already been resolved with the arguments passed to the enhanced function.
- *
- * This only considers resolution state, and notably does not support resolver
- * custom `isFulfilled` behavior.
- *
- * @param {Function} resolver     Original resolver.
- * @param {string}   selectorName Selector name associated with resolver.
- *
- * @return {Function} Enhanced resolver.
- */
-
-const ifNotResolved = (resolver, selectorName) =>
-/**
- * @param {...any} args Original resolver arguments.
- */
-function* resolveIfNotResolved(...args) {
-  const hasStartedResolution = yield controls.select(STORE_NAME, 'hasStartedResolution', selectorName, args);
-
-  if (!hasStartedResolution) {
-    yield* resolver(...args);
-  }
-};
-
-export default ifNotResolved;
-//# sourceMappingURL=if-not-resolved.js.map

package/build-module/utils/if-not-resolved.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["@wordpress/core-data/src/utils/if-not-resolved.js"],"names":["controls","STORE_NAME","ifNotResolved","resolver","selectorName","resolveIfNotResolved","args","hasStartedResolution","select"],"mappings":"AAAA;AACA;AACA;AACA,SAASA,QAAT,QAAyB,iBAAzB;AAEA;AACA;AACA;;AACA,SAASC,UAAT,QAA2B,SAA3B;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,MAAMC,aAAa,GAAG,CAAEC,QAAF,EAAYC,YAAZ;AACrB;AACD;AACA;AACC,UAAUC,oBAAV,CAAgC,GAAGC,IAAnC,EAA0C;AACzC,QAAMC,oBAAoB,GAAG,MAAMP,QAAQ,CAACQ,MAAT,CAClCP,UADkC,EAElC,sBAFkC,EAGlCG,YAHkC,EAIlCE,IAJkC,CAAnC;;AAOA,MAAK,CAAEC,oBAAP,EAA8B;AAC7B,WAAOJ,QAAQ,CAAE,GAAGG,IAAL,CAAf;AACA;AACD,CAfF;;AAiBA,eAAeJ,aAAf","sourcesContent":["/**\n * WordPress dependencies\n */\nimport { controls } from '@wordpress/data';\n\n/**\n * Internal dependencies\n */\nimport { STORE_NAME } from '../name';\n\n/**\n * Higher-order function which invokes the given resolver only if it has not\n * already been resolved with the arguments passed to the enhanced function.\n *\n * This only considers resolution state, and notably does not support resolver\n * custom `isFulfilled` behavior.\n *\n * @param {Function} resolver     Original resolver.\n * @param {string}   selectorName Selector name associated with resolver.\n *\n * @return {Function} Enhanced resolver.\n */\nconst ifNotResolved = ( resolver, selectorName ) =>\n\t/**\n\t * @param {...any} args Original resolver arguments.\n\t */\n\tfunction* resolveIfNotResolved( ...args ) {\n\t\tconst hasStartedResolution = yield controls.select(\n\t\t\tSTORE_NAME,\n\t\t\t'hasStartedResolution',\n\t\t\tselectorName,\n\t\t\targs\n\t\t);\n\n\t\tif ( ! hasStartedResolution ) {\n\t\t\tyield* resolver( ...args );\n\t\t}\n\t};\n\nexport default ifNotResolved;\n"]}

package/src/controls.js

@@ -1,31 +0,0 @@
-/**
- * WordPress dependencies
- */
-import { createRegistryControl } from '@wordpress/data';
-
-export function regularFetch( url ) {
-	return {
-		type: 'REGULAR_FETCH',
-		url,
-	};
-}
-
-export function getDispatch() {
-	return {
-		type: 'GET_DISPATCH',
-	};
-}
-
-const controls = {
-	async REGULAR_FETCH( { url } ) {
-		const { data } = await window
-			.fetch( url )
-			.then( ( res ) => res.json() );
-
-		return data;
-	},
-
-	GET_DISPATCH: createRegistryControl( ( { dispatch } ) => () => dispatch ),
-};
-
-export default controls;

package/src/locks/index.js

@@ -1,3 +0,0 @@
-export * from './actions';
-export * from './selectors';
-export { default as reducer } from './reducer';