@wordpress/core-data 7.51.0 → 7.53.0

package/src/utils/test/get-template-info.js

@@ -0,0 +1,218 @@
+import { footer, header, layout } from '@wordpress/icons';
+import { getTemplateInfo } from '../get-template-info';
+
+describe( '__experimentalGetTemplateInfo', () => {
+	const defaultTemplateTypes = [
+		{
+			title: 'Default (Index)',
+			description: 'Main template',
+			slug: 'index',
+		},
+		{
+			title: '404 (Not Found)',
+			description: 'Applied when content cannot be found',
+			slug: '404',
+		},
+	];
+
+	const defaultTemplatePartAreas = [
+		{
+			area: 'header',
+			label: 'Header',
+			description: 'Some description of a header',
+			icon: 'header',
+		},
+		{
+			area: 'footer',
+			label: 'Footer',
+			description: 'Some description of a footer',
+			icon: 'footer',
+		},
+	];
+
+	it( 'should return an empty object if no template is passed', () => {
+		expect( getTemplateInfo( undefined ) ).toEqual( {} );
+		expect( getTemplateInfo( null ) ).toEqual( {} );
+		expect( getTemplateInfo( false ) ).toEqual( {} );
+	} );
+
+	it( 'should return the default title if none is defined on the template', () => {
+		expect(
+			getTemplateInfo( {
+				templateAreas: defaultTemplatePartAreas,
+				templateTypes: defaultTemplateTypes,
+				template: {
+					slug: 'index',
+				},
+			} ).title
+		).toEqual( 'Default (Index)' );
+	} );
+
+	it( 'should return the rendered title if defined on the template', () => {
+		expect(
+			getTemplateInfo( {
+				templateAreas: defaultTemplatePartAreas,
+				templateTypes: defaultTemplateTypes,
+				template: {
+					slug: 'index',
+					title: { rendered: 'test title' },
+				},
+			} ).title
+		).toEqual( 'test title' );
+	} );
+
+	it( 'should return the slug if no title is found', () => {
+		expect(
+			getTemplateInfo( {
+				templateAreas: defaultTemplatePartAreas,
+				templateTypes: defaultTemplateTypes,
+				template: {
+					slug: 'not a real template',
+				},
+			} ).title
+		).toEqual( 'not a real template' );
+	} );
+
+	it( 'should return the default description if none is defined on the template', () => {
+		expect(
+			getTemplateInfo( {
+				templateAreas: defaultTemplatePartAreas,
+				templateTypes: defaultTemplateTypes,
+				template: {
+					slug: 'index',
+				},
+			} ).description
+		).toEqual( 'Main template' );
+	} );
+
+	it( 'should return the raw excerpt as description if defined on the template', () => {
+		expect(
+			getTemplateInfo( {
+				templateAreas: defaultTemplatePartAreas,
+				templateTypes: defaultTemplateTypes,
+				template: {
+					slug: 'index',
+					description: { raw: 'test description' },
+				},
+			} ).description
+		).toEqual( 'test description' );
+	} );
+
+	it( 'should return a title, description, and icon', () => {
+		expect(
+			getTemplateInfo( {
+				templateAreas: defaultTemplatePartAreas,
+				templateTypes: defaultTemplateTypes,
+				template: { slug: 'index' },
+			} )
+		).toEqual( {
+			title: 'Default (Index)',
+			description: 'Main template',
+			icon: layout,
+		} );
+
+		expect(
+			getTemplateInfo( {
+				templateAreas: defaultTemplatePartAreas,
+				templateTypes: defaultTemplateTypes,
+				template: {
+					slug: 'index',
+					title: { rendered: 'test title' },
+				},
+			} )
+		).toEqual( {
+			title: 'test title',
+			description: 'Main template',
+			icon: layout,
+		} );
+
+		expect(
+			getTemplateInfo( {
+				templateAreas: defaultTemplatePartAreas,
+				templateTypes: defaultTemplateTypes,
+				template: {
+					slug: 'index',
+					description: { raw: 'test description' },
+				},
+			} )
+		).toEqual( {
+			title: 'Default (Index)',
+			description: 'test description',
+			icon: layout,
+		} );
+
+		expect(
+			getTemplateInfo( {
+				templateAreas: defaultTemplatePartAreas,
+				templateTypes: defaultTemplateTypes,
+				template: {
+					slug: 'index',
+					title: { rendered: 'test title' },
+					description: { raw: 'test description' },
+				},
+			} )
+		).toEqual( {
+			title: 'test title',
+			description: 'test description',
+			icon: layout,
+		} );
+	} );
+
+	it( 'should return correct icon based on area', () => {
+		expect(
+			getTemplateInfo( {
+				templateAreas: defaultTemplatePartAreas,
+				templateTypes: defaultTemplateTypes,
+				template: {
+					slug: 'template part, area = uncategorized',
+					area: 'uncategorized',
+				},
+			} )
+		).toEqual( {
+			title: 'template part, area = uncategorized',
+			icon: layout,
+		} );
+
+		expect(
+			getTemplateInfo( {
+				templateAreas: defaultTemplatePartAreas,
+				templateTypes: defaultTemplateTypes,
+				template: {
+					slug: 'template part, area = invalid',
+					area: 'invalid',
+				},
+			} )
+		).toEqual( {
+			title: 'template part, area = invalid',
+			icon: layout,
+		} );
+
+		expect(
+			getTemplateInfo( {
+				templateAreas: defaultTemplatePartAreas,
+				templateTypes: defaultTemplateTypes,
+				template: {
+					slug: 'template part, area = header',
+					area: 'header',
+				},
+			} )
+		).toEqual( {
+			title: 'template part, area = header',
+			icon: header,
+		} );
+
+		expect(
+			getTemplateInfo( {
+				templateAreas: defaultTemplatePartAreas,
+				templateTypes: defaultTemplateTypes,
+				template: {
+					slug: 'template part, area = footer',
+					area: 'footer',
+				},
+			} )
+		).toEqual( {
+			title: 'template part, area = footer',
+			icon: footer,
+		} );
+	} );
+} );

package/src/utils/test/if-matching-action.js

@@ -1,11 +1,4 @@
-/**
- * External dependencies
- */
 import deepFreeze from 'deep-freeze';
-
-/**
- * Internal dependencies
- */
 import ifMatchingAction from '../if-matching-action';
 
 describe( 'ifMatchingAction', () => {

package/src/utils/test/is-numeric-id.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import isNumericID from '../is-numeric-id';
 
 describe( 'isNumericID', () => {

package/src/utils/test/log-entity-deprecation.js

@@ -1,11 +1,4 @@
-/**
- * WordPress dependencies
- */
 import deprecated from '@wordpress/deprecated';
-
-/**
- * Internal dependencies
- */
 import logEntityDeprecation from '../log-entity-deprecation';
 
 jest.useFakeTimers();

package/src/utils/test/replace-action.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import replaceAction from '../replace-action';
 
 describe( 'replaceAction', () => {

package/src/utils/test/rtc-rich-text-cursor-scope.test.js

@@ -1,19 +1,10 @@
-/**
- * External dependencies
- */
 import { beforeEach, describe, expect, it, jest } from '@jest/globals';
-
-/**
- * WordPress dependencies
- */
 import { Y } from '@wordpress/sync';
-
 /**
  * Mock block schemas and sync providers.
  */
 jest.mock( '@wordpress/blocks', () => {
 	const actual = jest.requireActual( '@wordpress/blocks' );
-
 	return {
 		...actual,
 		getBlockTypes: () => [
@@ -27,14 +18,9 @@ jest.mock( '@wordpress/blocks', () => {
 		],
 	};
 } );
-
 jest.mock( '../../../../sync/src/providers', () => ( {
 	getProviderCreators: jest.fn(),
 } ) );
-
-/**
- * Internal dependencies
- */
 import { createSyncManager } from '../../../../sync/src/manager';
 import { getProviderCreators } from '../../../../sync/src/providers';
 import { CRDT_RECORD_MAP_KEY } from '../../sync';

package/src/utils/test/rtc-rich-text-offset-space.test.js

@@ -1,19 +1,10 @@
-/**
- * External dependencies
- */
 import { beforeEach, describe, expect, it, jest } from '@jest/globals';
-
-/**
- * WordPress dependencies
- */
 import { Y } from '@wordpress/sync';
-
 /**
  * Mock block schemas and sync providers.
  */
 jest.mock( '@wordpress/blocks', () => {
 	const actual = jest.requireActual( '@wordpress/blocks' );
-
 	return {
 		...actual,
 		getBlockTypes: () => [
@@ -26,14 +17,9 @@ jest.mock( '@wordpress/blocks', () => {
 		],
 	};
 } );
-
 jest.mock( '../../../../sync/src/providers', () => ( {
 	getProviderCreators: jest.fn(),
 } ) );
-
-/**
- * Internal dependencies
- */
 import { createSyncManager } from '../../../../sync/src/manager';
 import { getProviderCreators } from '../../../../sync/src/providers';
 import { CRDT_RECORD_MAP_KEY, Delta } from '../../sync';

package/src/utils/test/save-crdt-doc.js

@@ -1,11 +1,4 @@
-/**
- * WordPress dependencies
- */
 import apiFetch from '@wordpress/api-fetch';
-
-/**
- * Internal dependencies
- */
 import { getSyncManager } from '../../sync';
 import { saveCRDTDoc } from '../save-crdt-doc';
 

package/src/utils/test/set-nested-value.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import setNestedValue from '../set-nested-value';
 
 describe( 'setNestedValue', () => {

package/src/utils/test/with-weak-map-cache.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import withWeakMapCache from '../with-weak-map-cache';
 
 describe( 'withWeakMapCache', () => {