@wordpress/core-data 4.14.1-next.d6164808d3.0 → 5.0.0

package/build-types/utils/with-weak-map-cache.d.ts

@@ -0,0 +1,12 @@
+export default withWeakMapCache;
+/**
+ * Given a function, returns an enhanced function which caches the result and
+ * tracks in WeakMap. The result is only cached if the original function is
+ * passed a valid object-like argument (requirement for WeakMap key).
+ *
+ * @param {Function} fn Original function.
+ *
+ * @return {Function} Enhanced caching function.
+ */
+declare function withWeakMapCache(fn: Function): Function;
+//# sourceMappingURL=with-weak-map-cache.d.ts.map

package/build-types/utils/with-weak-map-cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"with-weak-map-cache.d.ts","sourceRoot":"","sources":["../../src/utils/with-weak-map-cache.js"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;AACH,0DAoBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/core-data",
-	"version": "4.14.1-next.d6164808d3.0",
+	"version": "5.0.0",
 	"description": "Access to and manipulation of core WordPress entities.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -25,20 +25,21 @@
 	"main": "build/index.js",
 	"module": "build-module/index.js",
 	"react-native": "src/index",
+	"types": "build-types",
 	"sideEffects": [
 		"{src,build,build-module}/index.js"
 	],
 	"dependencies": {
 		"@babel/runtime": "^7.16.0",
-		"@wordpress/api-fetch": "^6.12.1-next.d6164808d3.0",
-		"@wordpress/blocks": "^11.14.1-next.d6164808d3.0",
-		"@wordpress/data": "^7.0.1-next.d6164808d3.0",
-		"@wordpress/deprecated": "^3.15.1-next.d6164808d3.0",
-		"@wordpress/element": "^4.13.1-next.d6164808d3.0",
-		"@wordpress/html-entities": "^3.15.1-next.d6164808d3.0",
-		"@wordpress/i18n": "^4.15.1-next.d6164808d3.0",
-		"@wordpress/is-shallow-equal": "^4.15.1-next.d6164808d3.0",
-		"@wordpress/url": "^3.16.1-next.d6164808d3.0",
+		"@wordpress/api-fetch": "^6.14.0",
+		"@wordpress/blocks": "^11.16.0",
+		"@wordpress/data": "^7.1.0",
+		"@wordpress/deprecated": "^3.17.0",
+		"@wordpress/element": "^4.15.0",
+		"@wordpress/html-entities": "^3.17.0",
+		"@wordpress/i18n": "^4.17.0",
+		"@wordpress/is-shallow-equal": "^4.17.0",
+		"@wordpress/url": "^3.18.0",
 		"change-case": "^4.1.2",
 		"equivalent-key-map": "^0.2.2",
 		"lodash": "^4.17.21",
@@ -52,5 +53,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "ba8a396d2f418e53a6c4c50575582f3f3eb11ff7"
+	"gitHead": "0d732d4b184adcb28cc83087603e81b764390d4b"
 }

package/src/entities.js

@@ -0,0 +1,325 @@
+/**
+ * External dependencies
+ */
+import { capitalCase, pascalCase } from 'change-case';
+import { map, find, get } from 'lodash';
+
+/**
+ * WordPress dependencies
+ */
+import apiFetch from '@wordpress/api-fetch';
+import { __ } from '@wordpress/i18n';
+
+/**
+ * Internal dependencies
+ */
+import { addEntities } from './actions';
+
+export const DEFAULT_ENTITY_KEY = 'id';
+
+const POST_RAW_ATTRIBUTES = [ 'title', 'excerpt', 'content' ];
+
+export const rootEntitiesConfig = [
+	{
+		label: __( 'Base' ),
+		kind: 'root',
+		name: '__unstableBase',
+		baseURL: '/',
+		baseURLParams: {
+			_fields: [
+				'description',
+				'gmt_offset',
+				'home',
+				'name',
+				'site_icon',
+				'site_icon_url',
+				'site_logo',
+				'timezone_string',
+				'url',
+			].join( ',' ),
+		},
+	},
+	{
+		label: __( 'Site' ),
+		name: 'site',
+		kind: 'root',
+		baseURL: '/wp/v2/settings',
+		getTitle: ( record ) => {
+			return get( record, [ 'title' ], __( 'Site Title' ) );
+		},
+	},
+	{
+		label: __( 'Post Type' ),
+		name: 'postType',
+		kind: 'root',
+		key: 'slug',
+		baseURL: '/wp/v2/types',
+		baseURLParams: { context: 'edit' },
+	},
+	{
+		name: 'media',
+		kind: 'root',
+		baseURL: '/wp/v2/media',
+		baseURLParams: { context: 'edit' },
+		plural: 'mediaItems',
+		label: __( 'Media' ),
+		rawAttributes: [ 'caption', 'title', 'description' ],
+	},
+	{
+		name: 'taxonomy',
+		kind: 'root',
+		key: 'slug',
+		baseURL: '/wp/v2/taxonomies',
+		baseURLParams: { context: 'edit' },
+		plural: 'taxonomies',
+		label: __( 'Taxonomy' ),
+	},
+	{
+		name: 'sidebar',
+		kind: 'root',
+		baseURL: '/wp/v2/sidebars',
+		baseURLParams: { context: 'edit' },
+		plural: 'sidebars',
+		transientEdits: { blocks: true },
+		label: __( 'Widget areas' ),
+	},
+	{
+		name: 'widget',
+		kind: 'root',
+		baseURL: '/wp/v2/widgets',
+		baseURLParams: { context: 'edit' },
+		plural: 'widgets',
+		transientEdits: { blocks: true },
+		label: __( 'Widgets' ),
+	},
+	{
+		name: 'widgetType',
+		kind: 'root',
+		baseURL: '/wp/v2/widget-types',
+		baseURLParams: { context: 'edit' },
+		plural: 'widgetTypes',
+		label: __( 'Widget types' ),
+	},
+	{
+		label: __( 'User' ),
+		name: 'user',
+		kind: 'root',
+		baseURL: '/wp/v2/users',
+		baseURLParams: { context: 'edit' },
+		plural: 'users',
+	},
+	{
+		name: 'comment',
+		kind: 'root',
+		baseURL: '/wp/v2/comments',
+		baseURLParams: { context: 'edit' },
+		plural: 'comments',
+		label: __( 'Comment' ),
+	},
+	{
+		name: 'menu',
+		kind: 'root',
+		baseURL: '/wp/v2/menus',
+		baseURLParams: { context: 'edit' },
+		plural: 'menus',
+		label: __( 'Menu' ),
+	},
+	{
+		name: 'menuItem',
+		kind: 'root',
+		baseURL: '/wp/v2/menu-items',
+		baseURLParams: { context: 'edit' },
+		plural: 'menuItems',
+		label: __( 'Menu Item' ),
+		rawAttributes: [ 'title' ],
+	},
+	{
+		name: 'menuLocation',
+		kind: 'root',
+		baseURL: '/wp/v2/menu-locations',
+		baseURLParams: { context: 'edit' },
+		plural: 'menuLocations',
+		label: __( 'Menu Location' ),
+		key: 'name',
+	},
+	{
+		label: __( 'Global Styles' ),
+		name: 'globalStyles',
+		kind: 'root',
+		baseURL: '/wp/v2/global-styles',
+		baseURLParams: { context: 'edit' },
+		plural: 'globalStylesVariations', // Should be different than name.
+		getTitle: ( record ) => record?.title?.rendered || record?.title,
+	},
+	{
+		label: __( 'Themes' ),
+		name: 'theme',
+		kind: 'root',
+		baseURL: '/wp/v2/themes',
+		baseURLParams: { context: 'edit' },
+		key: 'stylesheet',
+	},
+	{
+		label: __( 'Plugins' ),
+		name: 'plugin',
+		kind: 'root',
+		baseURL: '/wp/v2/plugins',
+		baseURLParams: { context: 'edit' },
+		key: 'plugin',
+	},
+];
+
+export const additionalEntityConfigLoaders = [
+	{ kind: 'postType', loadEntities: loadPostTypeEntities },
+	{ kind: 'taxonomy', loadEntities: loadTaxonomyEntities },
+];
+
+/**
+ * Returns a function to be used to retrieve extra edits to apply before persisting a post type.
+ *
+ * @param {Object} persistedRecord Already persisted Post
+ * @param {Object} edits           Edits.
+ * @return {Object} Updated edits.
+ */
+export const prePersistPostType = ( persistedRecord, edits ) => {
+	const newEdits = {};
+
+	if ( persistedRecord?.status === 'auto-draft' ) {
+		// Saving an auto-draft should create a draft by default.
+		if ( ! edits.status && ! newEdits.status ) {
+			newEdits.status = 'draft';
+		}
+
+		// Fix the auto-draft default title.
+		if (
+			( ! edits.title || edits.title === 'Auto Draft' ) &&
+			! newEdits.title &&
+			( ! persistedRecord?.title ||
+				persistedRecord?.title === 'Auto Draft' )
+		) {
+			newEdits.title = '';
+		}
+	}
+
+	return newEdits;
+};
+
+/**
+ * Returns the list of post type entities.
+ *
+ * @return {Promise} Entities promise
+ */
+async function loadPostTypeEntities() {
+	const postTypes = await apiFetch( {
+		path: '/wp/v2/types?context=view',
+	} );
+	return map( postTypes, ( postType, name ) => {
+		const isTemplate = [ 'wp_template', 'wp_template_part' ].includes(
+			name
+		);
+		const namespace = postType?.rest_namespace ?? 'wp/v2';
+		return {
+			kind: 'postType',
+			baseURL: `/${ namespace }/${ postType.rest_base }`,
+			baseURLParams: { context: 'edit' },
+			name,
+			label: postType.name,
+			transientEdits: {
+				blocks: true,
+				selection: true,
+			},
+			mergedEdits: { meta: true },
+			rawAttributes: POST_RAW_ATTRIBUTES,
+			getTitle: ( record ) =>
+				record?.title?.rendered ||
+				record?.title ||
+				( isTemplate
+					? capitalCase( record.slug ?? '' )
+					: String( record.id ) ),
+			__unstablePrePersist: isTemplate ? undefined : prePersistPostType,
+			__unstable_rest_base: postType.rest_base,
+		};
+	} );
+}
+
+/**
+ * Returns the list of the taxonomies entities.
+ *
+ * @return {Promise} Entities promise
+ */
+async function loadTaxonomyEntities() {
+	const taxonomies = await apiFetch( {
+		path: '/wp/v2/taxonomies?context=view',
+	} );
+	return map( taxonomies, ( taxonomy, name ) => {
+		const namespace = taxonomy?.rest_namespace ?? 'wp/v2';
+		return {
+			kind: 'taxonomy',
+			baseURL: `/${ namespace }/${ taxonomy.rest_base }`,
+			baseURLParams: { context: 'edit' },
+			name,
+			label: taxonomy.name,
+		};
+	} );
+}
+
+/**
+ * Returns the entity's getter method name given its kind and name.
+ *
+ * @example
+ * ```js
+ * const nameSingular = getMethodName( 'root', 'theme', 'get' );
+ * // nameSingular is getRootTheme
+ *
+ * const namePlural = getMethodName( 'root', 'theme', 'set' );
+ * // namePlural is setRootThemes
+ * ```
+ *
+ * @param {string}  kind      Entity kind.
+ * @param {string}  name      Entity name.
+ * @param {string}  prefix    Function prefix.
+ * @param {boolean} usePlural Whether to use the plural form or not.
+ *
+ * @return {string} Method name
+ */
+export const getMethodName = (
+	kind,
+	name,
+	prefix = 'get',
+	usePlural = false
+) => {
+	const entityConfig = find( rootEntitiesConfig, { kind, name } );
+	const kindPrefix = kind === 'root' ? '' : pascalCase( kind );
+	const nameSuffix = pascalCase( name ) + ( usePlural ? 's' : '' );
+	const suffix =
+		usePlural && 'plural' in entityConfig && entityConfig?.plural
+			? pascalCase( entityConfig.plural )
+			: nameSuffix;
+	return `${ prefix }${ kindPrefix }${ suffix }`;
+};
+
+/**
+ * Loads the kind entities into the store.
+ *
+ * @param {string} kind Kind
+ *
+ * @return {(thunkArgs: object) => Promise<Array>} Entities
+ */
+export const getOrLoadEntitiesConfig =
+	( kind ) =>
+	async ( { select, dispatch } ) => {
+		let configs = select.getEntitiesConfig( kind );
+		if ( configs && configs.length !== 0 ) {
+			return configs;
+		}
+
+		const loader = find( additionalEntityConfigLoaders, { kind } );
+		if ( ! loader ) {
+			return [];
+		}
+
+		configs = await loader.loadEntities();
+		dispatch( addEntities( configs ) );
+
+		return configs;
+	};

package/src/entity-types/attachment.ts

@@ -13,7 +13,6 @@ import type {
 } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
-import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -142,6 +141,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Attachment<
-	C extends Context = DefaultContextOf< 'root', 'media' >
-> = OmitNevers< _BaseEntityRecords.Attachment< C > >;
+export type Attachment< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.Attachment< C >
+>;

package/src/entity-types/comment.ts

@@ -9,7 +9,6 @@ import type {
 	RenderedText,
 } from './helpers';
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
-import type { DefaultContextOf } from './index';
 
 export type CommentStatus = 'hold' | 'approve' | 'spam' | 'trash' | '1' | '0';
 
@@ -92,6 +91,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Comment<
-	C extends Context = DefaultContextOf< 'root', 'comment' >
-> = OmitNevers< _BaseEntityRecords.Comment< C > >;
+export type Comment< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.Comment< C >
+>;

package/src/entity-types/index.ts

@@ -20,9 +20,7 @@ import type { Widget } from './widget';
 import type { WidgetType } from './widget-type';
 import type { WpTemplate } from './wp-template';
 import type { WpTemplatePart } from './wp-template-part';
-import type { CoreEntities } from '../entities';
 
-export type { EntityType } from './entities';
 export type { BaseEntityRecords } from './base-entity-records';
 
 export type {
@@ -48,8 +46,6 @@ export type {
 	WpTemplatePart,
 };
 
-export type UpdatableEntityRecord = Updatable< EntityRecord< 'edit' > >;
-
 /**
  * An interface that may be extended to add types for new entities. Each entry
  * must be a union of entity definitions adhering to the EntityInterface type.
@@ -60,105 +56,52 @@ export type UpdatableEntityRecord = Updatable< EntityRecord< 'edit' > >;
  * import type { Context } from '@wordpress/core-data';
  * // ...
  *
- * interface Order {
+ * interface Client {
  *   id: number;
- *   clientId: number;
+ *   name: string;
  *   // ...
  * }
  *
- * type OrderEntity = {
- *   kind: 'myPlugin';
- *   name: 'order';
- *   recordType: Order;
+ * interface Order< C extends Context > {
+ *   id: number;
+ *   name: string;
+ *   // ...
  * }
  *
  * declare module '@wordpress/core-data' {
- *     export interface PerPackageEntities< C extends Context > {
- *         myPlugin: OrderEntity | ClientEntity
+ *     export interface PerPackageEntityRecords< C extends Context > {
+ *         myPlugin: Client | Order<C>>
  *     }
  * }
  *
- * const c = getEntityRecord( 'myPlugin', 'order', 15 );
+ * const c = getEntityRecord<Order>( 'myPlugin', 'order', 15 );
  * // c is of the type Order
  * ```
  */
-export interface PerPackageEntityConfig< C extends Context > {
-	core: CoreEntities< C >;
+export interface PerPackageEntityRecords< C extends Context > {
+	core:
+		| Attachment< C >
+		| Comment< C >
+		| MenuLocation< C >
+		| NavMenu< C >
+		| NavMenuItem< C >
+		| Page< C >
+		| Plugin< C >
+		| Post< C >
+		| Settings< C >
+		| Sidebar< C >
+		| Taxonomy< C >
+		| Theme< C >
+		| User< C >
+		| Type< C >
+		| Widget< C >
+		| WidgetType< C >
+		| WpTemplate< C >
+		| WpTemplatePart< C >;
 }
 
-/**
- * A union of all the registered entities.
- */
-type EntityConfig< C extends Context = any > =
-	PerPackageEntityConfig< C >[ keyof PerPackageEntityConfig< C > ];
-
 /**
  * A union of all known record types.
  */
-export type EntityRecord< C extends Context = any > =
-	EntityConfig< C >[ 'record' ];
-
-/**
- * An entity corresponding to a specified record type.
- */
-export type EntityConfigOf<
-	RecordOrKind extends EntityRecord | Kind,
-	N extends Name | undefined = undefined
-> = RecordOrKind extends EntityRecord
-	? Extract< EntityConfig, { record: RecordOrKind } >
-	: Extract< EntityConfig, { config: { kind: RecordOrKind; name: N } } >;
-
-/**
- * Name of the requested entity.
- */
-export type NameOf< R extends EntityRecord > =
-	EntityConfigOf< R >[ 'config' ][ 'name' ];
-
-/**
- * Kind of the requested entity.
- */
-export type KindOf< R extends EntityRecord > =
-	EntityConfigOf< R >[ 'config' ][ 'kind' ];
-
-/**
- * Primary key type of the requested entity, sourced from PerPackageEntities.
- *
- * For core entities, the key type is computed using the entity configuration in entities.js.
- */
-export type KeyOf<
-	RecordOrKind extends EntityRecord | Kind,
-	N extends Name | undefined = undefined,
-	E extends EntityConfig = EntityConfigOf< RecordOrKind, N >
-> = ( E[ 'key' ] extends keyof E[ 'record' ]
-	? E[ 'record' ][ E[ 'key' ] ]
-	: never ) &
-	( number | string );
-
-/**
- * Default context of the requested entity, sourced from PerPackageEntities.
- *
- * For core entities, the default context is extracted from the entity configuration
- * in entities.js.
- */
-export type DefaultContextOf<
-	RecordOrKind extends EntityRecord | Kind,
-	N extends Name | undefined = undefined
-> = EntityConfigOf< RecordOrKind, N >[ 'defaultContext' ];
-
-/**
- * An entity record type associated with specified kind and name, sourced from PerPackageEntities.
- */
-export type EntityRecordOf<
-	K extends Kind,
-	N extends Name,
-	C extends Context = DefaultContextOf< K, N >
-> = Extract< EntityConfig< C >, { config: { kind: K; name: N } } >[ 'record' ];
-
-/**
- * A union of all known entity kinds.
- */
-export type Kind = EntityConfig[ 'config' ][ 'kind' ];
-/**
- * A union of all known entity names.
- */
-export type Name = EntityConfig[ 'config' ][ 'name' ];
+export type EntityRecord< C extends Context = 'edit' > =
+	PerPackageEntityRecords< C >[ keyof PerPackageEntityRecords< C > ];

package/src/entity-types/menu-location.ts

@@ -4,7 +4,6 @@
 import type { Context, OmitNevers } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
-import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -25,6 +24,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type MenuLocation<
-	C extends Context = DefaultContextOf< 'root', 'menuLocation' >
-> = OmitNevers< _BaseEntityRecords.MenuLocation< C > >;
+export type MenuLocation< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.MenuLocation< C >
+>;

package/src/entity-types/nav-menu-item.ts

@@ -9,7 +9,6 @@ import type {
 } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
-import type { DefaultContextOf } from './index';
 
 export type NavMenuItemType =
 	| 'taxonomy'
@@ -107,6 +106,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type NavMenuItem<
-	C extends Context = DefaultContextOf< 'root', 'menuItem' >
-> = OmitNevers< _BaseEntityRecords.NavMenuItem< C > >;
+export type NavMenuItem< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.NavMenuItem< C >
+>;

package/src/entity-types/nav-menu.ts

@@ -4,7 +4,6 @@
 import type { Context, ContextualField, OmitNevers } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
-import { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -49,5 +48,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type NavMenu< C extends Context = DefaultContextOf< 'root', 'menu' > > =
-	OmitNevers< _BaseEntityRecords.NavMenu< C > >;
+export type NavMenu< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.NavMenu< C >
+>;

package/src/entity-types/page.ts

@@ -12,7 +12,6 @@ import type {
 } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
-import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -140,5 +139,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Page< C extends Context = DefaultContextOf< 'postType', 'page' > > =
-	OmitNevers< _BaseEntityRecords.Page< C > >;
+export type Page< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.Page< C >
+>;

package/src/entity-types/plugin.ts

@@ -9,7 +9,6 @@ import type {
 } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
-import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -75,5 +74,6 @@ declare module './base-entity-records' {
 }
 
 export type PluginStatus = 'active' | 'inactive';
-export type Plugin< C extends Context = DefaultContextOf< 'root', 'plugin' > > =
-	OmitNevers< _BaseEntityRecords.Plugin< C > >;
+export type Plugin< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.Plugin< C >
+>;

package/src/entity-types/post.ts

@@ -13,7 +13,6 @@ import type {
 } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
-import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -149,5 +148,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Post< C extends Context = DefaultContextOf< 'postType', 'post' > > =
-	OmitNevers< _BaseEntityRecords.Post< C > >;
+export type Post< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.Post< C >
+>;