@wordpress/core-data 7.42.0 → 7.43.2-next.v.202604091042.0

package/src/utils/test/crdt.ts

@@ -8,12 +8,56 @@ import { Y } from '@wordpress/sync';
  */
 import { describe, expect, it, jest, beforeEach } from '@jest/globals';
 
+/**
+ * Mock getBlockTypes so CRDT merging can identify rich-text attributes.
+ */
+jest.mock( '@wordpress/blocks', () => {
+	const actual = jest.requireActual( '@wordpress/blocks' ) as Record<
+		string,
+		unknown
+	>;
+	return {
+		...actual,
+		getBlockTypes: () => [
+			{
+				name: 'core/paragraph',
+				attributes: { content: { type: 'rich-text' } },
+			},
+			{
+				name: 'core/table',
+				attributes: {
+					hasFixedLayout: { type: 'boolean' },
+					caption: { type: 'rich-text' },
+					body: {
+						type: 'array',
+						query: {
+							cells: {
+								type: 'array',
+								query: {
+									content: { type: 'rich-text' },
+									tag: { type: 'string' },
+								},
+							},
+						},
+					},
+				},
+			},
+		],
+	};
+} );
+
+/**
+ * WordPress dependencies
+ */
+import { RichTextData } from '@wordpress/rich-text';
+
 /**
  * Internal dependencies
  */
 import { CRDT_RECORD_MAP_KEY } from '../../sync';
 import {
 	applyPostChangesToCRDTDoc,
+	defaultCollectionSyncConfig,
 	getPostChangesFromCRDTDoc,
 	POST_META_KEY_FOR_CRDT_DOC_PERSISTENCE,
 	type PostChanges,
@@ -39,6 +83,43 @@ const defaultSyncedProperties = new Set< string >( [
 	'title',
 ] );
 
+describe( 'defaultCollectionSyncConfig', () => {
+	it( 'has no-op applyChangesToCRDTDoc', () => {
+		const doc = new Y.Doc();
+		// Should not throw and return undefined.
+		expect(
+			defaultCollectionSyncConfig.applyChangesToCRDTDoc( doc, {
+				title: 'test',
+			} )
+		).toBeUndefined();
+		doc.destroy();
+	} );
+
+	it( 'has getChangesFromCRDTDoc that returns empty object', () => {
+		const doc = new Y.Doc();
+		const result = defaultCollectionSyncConfig.getChangesFromCRDTDoc( doc, {
+			title: 'test',
+		} );
+		expect( result ).toEqual( {} );
+		doc.destroy();
+	} );
+
+	it( 'shouldSync returns true when objectId is null (collection)', () => {
+		expect(
+			defaultCollectionSyncConfig.shouldSync?.( 'comment', null )
+		).toBe( true );
+	} );
+
+	it( 'shouldSync returns false when objectId is provided (individual record)', () => {
+		expect(
+			defaultCollectionSyncConfig.shouldSync?.( 'comment', '123' )
+		).toBe( false );
+		expect(
+			defaultCollectionSyncConfig.shouldSync?.( 'comment', 'foo' )
+		).toBe( false );
+	} );
+} );
+
 describe( 'crdt', () => {
 	let doc: Y.Doc;
 
@@ -515,6 +596,68 @@ describe( 'crdt', () => {
 			expect( changes ).toHaveProperty( 'blocks' );
 		} );
 
+		it( 'returns rich-text block attributes as RichTextData, not strings', () => {
+			// Simulate User A writing a paragraph block into the CRDT doc.
+			addBlockToDoc( map, 'block-1', 'Hello world' );
+
+			// Simulate User B reading the CRDT doc with no local blocks.
+			const editedRecord = { blocks: [] } as unknown as Post;
+
+			const changes = getPostChangesFromCRDTDoc(
+				doc,
+				editedRecord,
+				defaultSyncedProperties
+			);
+
+			const block = ( changes.blocks as any[] )?.[ 0 ];
+			expect( block ).toBeDefined();
+			expect( block.attributes.content ).toBeInstanceOf( RichTextData );
+			expect( block.attributes.content.text ).toBe( 'Hello world' );
+		} );
+
+		it( 'returns nested rich-text in array attributes as RichTextData', () => {
+			// Add a table block to the CRDT doc with nested cell content
+			// stored as plain strings.
+			let blocks = map.get( 'blocks' );
+			if ( ! ( blocks instanceof Y.Array ) ) {
+				blocks = new Y.Array< YBlock >();
+				map.set( 'blocks', blocks );
+			}
+
+			const tableBlock = createYMap< YBlockRecord >();
+			tableBlock.set( 'name', 'core/table' );
+			tableBlock.set( 'clientId', 'table-1' );
+			const attrs = new Y.Map();
+			attrs.set( 'body', [
+				{
+					cells: [
+						{ content: '<strong>Cell</strong>', tag: 'td' },
+						{ content: 'Plain', tag: 'td' },
+					],
+				},
+			] );
+			tableBlock.set( 'attributes', attrs );
+			tableBlock.set( 'innerBlocks', new Y.Array() );
+			( blocks as YBlocks ).push( [ tableBlock ] );
+
+			const editedRecord = { blocks: [] } as unknown as Post;
+
+			const changes = getPostChangesFromCRDTDoc(
+				doc,
+				editedRecord,
+				defaultSyncedProperties
+			);
+
+			const block = ( changes.blocks as any[] )?.[ 0 ];
+			expect( block ).toBeDefined();
+
+			const cell = block.attributes.body[ 0 ].cells[ 0 ];
+			expect( cell.content ).toBeInstanceOf( RichTextData );
+			expect( ( cell.content as RichTextData ).toHTMLString() ).toBe(
+				'<strong>Cell</strong>'
+			);
+		} );
+
 		it( 'includes undefined blocks in changes', () => {
 			map.set( 'blocks', undefined );
 
@@ -801,11 +944,13 @@ describe( 'crdt', () => {
  * @param map
  * @param clientId Block client ID.
  * @param content  Initial text content.
+ * @param name     Block name (default: 'core/paragraph').
  */
 function addBlockToDoc(
 	map: YMapWrap< YPostRecord >,
 	clientId: string,
-	content: string
+	content: string,
+	name = 'core/paragraph'
 ): Y.Text {
 	let blocks = map.get( 'blocks' );
 	if ( ! ( blocks instanceof Y.Array ) ) {
@@ -814,6 +959,7 @@ function addBlockToDoc(
 	}
 
 	const block = createYMap< YBlockRecord >();
+	block.set( 'name', name );
 	block.set( 'clientId', clientId );
 	const attrs = new Y.Map();
 	const ytext = new Y.Text( content );

package/build/hooks/memoize.cjs

@@ -1,38 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// packages/core-data/src/hooks/memoize.js
-var memoize_exports = {};
-__export(memoize_exports, {
-  default: () => memoize_default
-});
-module.exports = __toCommonJS(memoize_exports);
-var import_memize = __toESM(require("memize"));
-var memoize_default = import_memize.default;
-//# sourceMappingURL=memoize.cjs.map

package/build/hooks/memoize.cjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../src/hooks/memoize.js"],
-  "sourcesContent": ["/**\n * External dependencies\n */\nimport memoize from 'memize';\n\n// re-export due to restrictive esModuleInterop setting\nexport default memoize;\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,oBAAoB;AAGpB,IAAO,kBAAQ,cAAAA;",
-  "names": ["memoize"]
-}

package/build/utils/is-raw-attribute.cjs

@@ -1,29 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// packages/core-data/src/utils/is-raw-attribute.js
-var is_raw_attribute_exports = {};
-__export(is_raw_attribute_exports, {
-  default: () => isRawAttribute
-});
-module.exports = __toCommonJS(is_raw_attribute_exports);
-function isRawAttribute(entity, attribute) {
-  return (entity.rawAttributes || []).includes(attribute);
-}
-//# sourceMappingURL=is-raw-attribute.cjs.map

package/build/utils/is-raw-attribute.cjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../src/utils/is-raw-attribute.js"],
-  "sourcesContent": ["/**\n * Checks whether the attribute is a \"raw\" attribute or not.\n *\n * @param {Object} entity    Entity record.\n * @param {string} attribute Attribute name.\n *\n * @return {boolean} Is the attribute raw\n */\nexport default function isRawAttribute( entity, attribute ) {\n\treturn ( entity.rawAttributes || [] ).includes( attribute );\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAQe,SAAR,eAAiC,QAAQ,WAAY;AAC3D,UAAS,OAAO,iBAAiB,CAAC,GAAI,SAAU,SAAU;AAC3D;",
-  "names": []
-}

package/build-module/hooks/memoize.mjs

@@ -1,7 +0,0 @@
-// packages/core-data/src/hooks/memoize.js
-import memoize from "memize";
-var memoize_default = memoize;
-export {
-  memoize_default as default
-};
-//# sourceMappingURL=memoize.mjs.map

package/build-module/hooks/memoize.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../src/hooks/memoize.js"],
-  "sourcesContent": ["/**\n * External dependencies\n */\nimport memoize from 'memize';\n\n// re-export due to restrictive esModuleInterop setting\nexport default memoize;\n"],
-  "mappings": ";AAGA,OAAO,aAAa;AAGpB,IAAO,kBAAQ;",
-  "names": []
-}

package/build-module/utils/is-raw-attribute.mjs

@@ -1,8 +0,0 @@
-// packages/core-data/src/utils/is-raw-attribute.js
-function isRawAttribute(entity, attribute) {
-  return (entity.rawAttributes || []).includes(attribute);
-}
-export {
-  isRawAttribute as default
-};
-//# sourceMappingURL=is-raw-attribute.mjs.map

package/build-module/utils/is-raw-attribute.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../src/utils/is-raw-attribute.js"],
-  "sourcesContent": ["/**\n * Checks whether the attribute is a \"raw\" attribute or not.\n *\n * @param {Object} entity    Entity record.\n * @param {string} attribute Attribute name.\n *\n * @return {boolean} Is the attribute raw\n */\nexport default function isRawAttribute( entity, attribute ) {\n\treturn ( entity.rawAttributes || [] ).includes( attribute );\n}\n"],
-  "mappings": ";AAQe,SAAR,eAAiC,QAAQ,WAAY;AAC3D,UAAS,OAAO,iBAAiB,CAAC,GAAI,SAAU,SAAU;AAC3D;",
-  "names": []
-}

package/build-types/hooks/memoize.d.ts

@@ -1,3 +0,0 @@
-export default memoize;
-import memoize from 'memize';
-//# sourceMappingURL=memoize.d.ts.map

package/build-types/hooks/memoize.d.ts.map

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

package/build-types/utils/is-raw-attribute.d.ts

@@ -1,10 +0,0 @@
-/**
- * Checks whether the attribute is a "raw" attribute or not.
- *
- * @param {Object} entity    Entity record.
- * @param {string} attribute Attribute name.
- *
- * @return {boolean} Is the attribute raw
- */
-export default function isRawAttribute(entity: any, attribute: string): boolean;
-//# sourceMappingURL=is-raw-attribute.d.ts.map

package/build-types/utils/is-raw-attribute.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"is-raw-attribute.d.ts","sourceRoot":"","sources":["../../src/utils/is-raw-attribute.js"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,+DAJW,MAAM,GAEL,OAAO,CAIlB"}

package/src/hooks/memoize.js

@@ -1,7 +0,0 @@
-/**
- * External dependencies
- */
-import memoize from 'memize';
-
-// re-export due to restrictive esModuleInterop setting
-export default memoize;

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

@@ -1,11 +0,0 @@
-/**
- * Checks whether the attribute is a "raw" attribute or not.
- *
- * @param {Object} entity    Entity record.
- * @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

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