@wordpress/core-data 4.1.1 → 4.2.0-next.e230fbab09.0

package/src/entity-types/navigation-area.ts

@@ -0,0 +1,29 @@
+/**
+ * Internal dependencies
+ */
+import { Context, OmitNevers } from './helpers';
+
+import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+
+declare module './base-entity-types' {
+	export namespace BaseEntityTypes {
+		export interface NavigationArea< C extends Context > {
+			/**
+			 * The name of the navigation area.
+			 */
+			name: string;
+			/**
+			 * The description of the navigation area.
+			 */
+			description: string;
+			/**
+			 * The ID of the assigned navigation.
+			 */
+			navigation: number;
+		}
+	}
+}
+
+export type NavigationArea< C extends Context > = OmitNevers<
+	_BaseEntityTypes.NavigationArea< C >
+>;

package/src/entity-types/page.ts

@@ -0,0 +1,144 @@
+/**
+ * Internal dependencies
+ */
+import {
+	CommentingStatus,
+	Context,
+	ContextualField,
+	PingStatus,
+	PostStatus,
+	RenderedText,
+	OmitNevers,
+} from './helpers';
+
+import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+
+declare module './base-entity-types' {
+	export namespace BaseEntityTypes {
+		export interface Page< C extends Context > {
+			/**
+			 * The date the post was published, in the site's timezone.
+			 */
+			date: string | null;
+			/**
+			 * The date the post was published, as GMT.
+			 */
+			date_gmt: ContextualField< string | null, 'view' | 'edit', C >;
+			/**
+			 * The globally unique identifier for the post.
+			 */
+			guid: ContextualField< RenderedText< C >, 'view' | 'edit', C >;
+			/**
+			 * Unique identifier for the post.
+			 */
+			id: number;
+			/**
+			 * URL to the post.
+			 */
+			link: string;
+			/**
+			 * The date the post was last modified, in the site's timezone.
+			 */
+			modified: ContextualField< string, 'view' | 'edit', C >;
+			/**
+			 * The date the post was last modified, as GMT.
+			 */
+			modified_gmt: ContextualField< string, 'view' | 'edit', C >;
+			/**
+			 * An alphanumeric identifier for the post unique to its type.
+			 */
+			slug: string;
+			/**
+			 * A named status for the post.
+			 */
+			status: ContextualField< PostStatus, 'view' | 'edit', C >;
+			/**
+			 * Type of post.
+			 */
+			type: string;
+			/**
+			 * A password to protect access to the content and excerpt.
+			 */
+			password: ContextualField< string, 'edit', C >;
+			/**
+			 * Permalink template for the post.
+			 */
+			permalink_template: ContextualField< string, 'edit', C >;
+			/**
+			 * Slug automatically generated from the post title.
+			 */
+			generated_slug: ContextualField< string, 'edit', C >;
+			/**
+			 * The ID for the parent of the post.
+			 */
+			parent: ContextualField< number, 'view' | 'edit', C >;
+			/**
+			 * The title for the post.
+			 */
+			title: RenderedText< C >;
+			/**
+			 * The content for the post.
+			 */
+			content: ContextualField<
+				RenderedText< C > & {
+					/**
+					 * Whether the content is protected with a password.
+					 */
+					is_protected: boolean;
+					/**
+					 * Version of the content block format used by the page.
+					 */
+					block_version: ContextualField< string, 'edit', C >;
+				},
+				'view' | 'edit',
+				C
+			>;
+			/**
+			 * The ID for the author of the post.
+			 */
+			author: number;
+			/**
+			 * The excerpt for the post.
+			 */
+			excerpt: RenderedText< C > & {
+				protected: boolean;
+			};
+			/**
+			 * The ID of the featured media for the post.
+			 */
+			featured_media: number;
+			/**
+			 * Whether or not comments are open on the post.
+			 */
+			comment_status: ContextualField<
+				CommentingStatus,
+				'view' | 'edit',
+				C
+			>;
+			/**
+			 * Whether or not the post can be pinged.
+			 */
+			ping_status: ContextualField< PingStatus, 'view' | 'edit', C >;
+			/**
+			 * The order of the post in relation to other posts.
+			 */
+			menu_order: ContextualField< number, 'view' | 'edit', C >;
+			/**
+			 * Meta fields.
+			 */
+			meta: ContextualField<
+				Record< string, string >,
+				'view' | 'edit',
+				C
+			>;
+			/**
+			 * The theme file to use to display the post.
+			 */
+			template: ContextualField< string, 'view' | 'edit', C >;
+		}
+	}
+}
+
+export type Page< C extends Context > = OmitNevers<
+	_BaseEntityTypes.Page< C >
+>;

package/src/entity-types/plugin.ts

@@ -0,0 +1,74 @@
+/**
+ * Internal dependencies
+ */
+import { Context, ContextualField, RenderedText, OmitNevers } from './helpers';
+
+import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+
+declare module './base-entity-types' {
+	export namespace BaseEntityTypes {
+		export interface Plugin< C extends Context > {
+			/**
+			 * The plugin file.
+			 */
+			plugin: string;
+			/**
+			 * The plugin activation status.
+			 */
+			status: PluginStatus;
+			/**
+			 * The plugin name.
+			 */
+			name: string;
+			/**
+			 * The plugin's website address.
+			 */
+			plugin_uri: ContextualField< string, 'view' | 'edit', C >;
+			/**
+			 * The plugin author.
+			 */
+			author: ContextualField<
+				Record< string, string >,
+				'view' | 'edit',
+				C
+			>;
+			/**
+			 * Plugin author's website address.
+			 */
+			author_uri: ContextualField< string, 'view' | 'edit', C >;
+			/**
+			 * The plugin description.
+			 */
+			description: ContextualField<
+				RenderedText< 'edit' >,
+				'view' | 'edit',
+				C
+			>;
+			/**
+			 * The plugin version number.
+			 */
+			version: ContextualField< string, 'view' | 'edit', C >;
+			/**
+			 * Whether the plugin can only be activated network-wide.
+			 */
+			network_only: boolean;
+			/**
+			 * Minimum required version of WordPress.
+			 */
+			requires_wp: string;
+			/**
+			 * Minimum required version of PHP.
+			 */
+			requires_php: string;
+			/**
+			 * The plugin's text domain.
+			 */
+			textdomain: ContextualField< string, 'view' | 'edit', C >;
+		}
+	}
+}
+
+export type PluginStatus = 'active' | 'inactive';
+export type Plugin< C extends Context > = OmitNevers<
+	_BaseEntityTypes.Plugin< C >
+>;

package/src/entity-types/post.ts

@@ -0,0 +1,153 @@
+/**
+ * Internal dependencies
+ */
+import {
+	CommentingStatus,
+	Context,
+	ContextualField,
+	PingStatus,
+	PostFormat,
+	PostStatus,
+	RenderedText,
+	OmitNevers,
+} from './helpers';
+
+import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+
+declare module './base-entity-types' {
+	export namespace BaseEntityTypes {
+		export interface Post< C extends Context > {
+			/**
+			 * The date the post was published, in the site's timezone.
+			 */
+			date: string | null;
+			/**
+			 * The date the post was published, as GMT.
+			 */
+			date_gmt: ContextualField< string | null, 'view' | 'edit', C >;
+			/**
+			 * The globally unique identifier for the post.
+			 */
+			guid: ContextualField< RenderedText< C >, 'view' | 'edit', C >;
+			/**
+			 * Unique identifier for the post.
+			 */
+			id: number;
+			/**
+			 * URL to the post.
+			 */
+			link: string;
+			/**
+			 * The date the post was last modified, in the site's timezone.
+			 */
+			modified: ContextualField< string, 'view' | 'edit', C >;
+			/**
+			 * The date the post was last modified, as GMT.
+			 */
+			modified_gmt: ContextualField< string, 'view' | 'edit', C >;
+			/**
+			 * An alphanumeric identifier for the post unique to its type.
+			 */
+			slug: string;
+			/**
+			 * A named status for the post.
+			 */
+			status: ContextualField< PostStatus, 'view' | 'edit', C >;
+			/**
+			 * Type of post.
+			 */
+			type: string;
+			/**
+			 * A password to protect access to the content and excerpt.
+			 */
+			password: ContextualField< string, 'edit', C >;
+			/**
+			 * Permalink template for the post.
+			 */
+			permalink_template: ContextualField< string, 'edit', C >;
+			/**
+			 * Slug automatically generated from the post title.
+			 */
+			generated_slug: ContextualField< string, 'edit', C >;
+			/**
+			 * The title for the post.
+			 */
+			title: RenderedText< C >;
+			/**
+			 * The content for the post.
+			 */
+			content: ContextualField<
+				RenderedText< C > & {
+					/**
+					 * Whether the content is protected with a password.
+					 */
+					is_protected: boolean;
+					/**
+					 * Version of the content block format used by the page.
+					 */
+					block_version: ContextualField< string, 'edit', C >;
+				},
+				'view' | 'edit',
+				C
+			>;
+			/**
+			 * The ID for the author of the post.
+			 */
+			author: number;
+			/**
+			 * The excerpt for the post.
+			 */
+			excerpt: RenderedText< C > & {
+				protected: boolean;
+			};
+			/**
+			 * The ID of the featured media for the post.
+			 */
+			featured_media: number;
+			/**
+			 * Whether or not comments are open on the post.
+			 */
+			comment_status: ContextualField<
+				CommentingStatus,
+				'view' | 'edit',
+				C
+			>;
+			/**
+			 * Whether or not the post can be pinged.
+			 */
+			ping_status: ContextualField< PingStatus, 'view' | 'edit', C >;
+			/**
+			 * The format for the post.
+			 */
+			format: ContextualField< PostFormat, 'view' | 'edit', C >;
+			/**
+			 * Meta fields.
+			 */
+			meta: ContextualField<
+				Record< string, string >,
+				'view' | 'edit',
+				C
+			>;
+			/**
+			 * Whether or not the post should be treated as sticky.
+			 */
+			sticky: ContextualField< boolean, 'view' | 'edit', C >;
+			/**
+			 * The theme file to use to display the post.
+			 */
+			template: ContextualField< string, 'view' | 'edit', C >;
+			/**
+			 * The terms assigned to the post in the category taxonomy.
+			 */
+			categories: ContextualField< number[], 'view' | 'edit', C >;
+			/**
+			 * The terms assigned to the post in the post_tag taxonomy.
+			 */
+			tags: ContextualField< number[], 'view' | 'edit', C >;
+		}
+	}
+}
+
+export type Post< C extends Context > = OmitNevers<
+	_BaseEntityTypes.Post< C >
+>;

package/src/entity-types/settings.ts

@@ -0,0 +1,93 @@
+/**
+ * Internal dependencies
+ */
+import { CommentingStatus, Context, OmitNevers, PingStatus } from './helpers';
+
+import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+
+declare module './base-entity-types' {
+	export namespace BaseEntityTypes {
+		export interface Settings< C extends Context > {
+			/**
+			 * What to show on the front page
+			 */
+			show_on_front: string;
+			/**
+			 * The ID of the page that should be displayed on the front page
+			 */
+			page_on_front: number;
+			/**
+			 * Site title.
+			 */
+			title: string;
+			/**
+			 * Site tagline.
+			 */
+			description: string;
+			/**
+			 * Site URL.
+			 */
+			url: string;
+			/**
+			 * This address is used for admin purposes, like new user notification.
+			 */
+			email: string;
+			/**
+			 * A city in the same timezone as you.
+			 */
+			timezone: string;
+			/**
+			 * A date format for all date strings.
+			 */
+			date_format: string;
+			/**
+			 * A time format for all time strings.
+			 */
+			time_format: string;
+			/**
+			 * A day number of the week that the week should start on.
+			 */
+			start_of_week: number;
+			/**
+			 * WordPress locale code.
+			 */
+			language: string;
+			/**
+			 * Convert emoticons like :-) and :-P to graphics on display.
+			 */
+			use_smilies: boolean;
+			/**
+			 * Default post category.
+			 */
+			default_category: number;
+			/**
+			 * Default post format.
+			 */
+			default_post_format: string;
+			/**
+			 * Blog pages show at most.
+			 */
+			posts_per_page: number;
+			/**
+			 * Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.
+			 */
+			default_ping_status: PingStatus;
+			/**
+			 * Allow people to submit comments on new posts.
+			 */
+			default_comment_status: CommentingStatus;
+			/**
+			 * Site logo.
+			 */
+			site_logo: number;
+			/**
+			 * Site icon.
+			 */
+			site_icon: number;
+		}
+	}
+}
+
+export type Settings< C extends Context > = OmitNevers<
+	_BaseEntityTypes.Settings< C >
+>;

package/src/entity-types/sidebar.ts

@@ -0,0 +1,60 @@
+/**
+ * Internal dependencies
+ */
+import { Widget } from './widget';
+import { Context, OmitNevers } from './helpers';
+
+import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+
+declare module './base-entity-types' {
+	export namespace BaseEntityTypes {
+		export interface Sidebar< C extends Context > {
+			/**
+			 * ID of sidebar.
+			 */
+			id: string;
+			/**
+			 * Unique name identifying the sidebar.
+			 */
+			name: string;
+			/**
+			 * Description of sidebar.
+			 */
+			description: string;
+			/**
+			 * Extra CSS class to assign to the sidebar in the Widgets interface.
+			 */
+			class: string;
+			/**
+			 * HTML content to prepend to each widget's HTML output when assigned to this sidebar. Default is an opening list item element.
+			 */
+			before_widget: string;
+			/**
+			 * HTML content to append to each widget's HTML output when assigned to this sidebar. Default is a closing list item element.
+			 */
+			after_widget: string;
+			/**
+			 * HTML content to prepend to the sidebar title when displayed. Default is an opening h2 element.
+			 */
+			before_title: string;
+			/**
+			 * HTML content to append to the sidebar title when displayed. Default is a closing h2 element.
+			 */
+			after_title: string;
+			/**
+			 * Status of sidebar.
+			 */
+			status: SidebarStatus;
+			/**
+			 * Nested widgets.
+			 */
+			widgets: ( Widget< C > | string )[];
+		}
+	}
+}
+
+type SidebarStatus = 'active' | 'inactive';
+
+export type Sidebar< C extends Context > = OmitNevers<
+	_BaseEntityTypes.Sidebar< C >
+>;

package/src/entity-types/taxonomy.ts

@@ -0,0 +1,92 @@
+/**
+ * Internal dependencies
+ */
+import { Context, ContextualField, OmitNevers } from './helpers';
+
+import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+
+declare module './base-entity-types' {
+	export namespace BaseEntityTypes {
+		export interface Taxonomy< C extends Context > {
+			/**
+			 * All capabilities used by the taxonomy.
+			 */
+			capabilities: ContextualField<
+				Record< string, string >,
+				'edit',
+				C
+			>;
+			/**
+			 * A human-readable description of the taxonomy.
+			 */
+			description: ContextualField< string, 'view' | 'edit', C >;
+			/**
+			 * Whether or not the taxonomy should have children.
+			 */
+			hierarchical: ContextualField< boolean, 'view' | 'edit', C >;
+			/**
+			 * Human-readable labels for the taxonomy for various contexts.
+			 */
+			labels: ContextualField< Record< string, string >, 'edit', C >;
+			/**
+			 * The title for the taxonomy.
+			 */
+			name: string;
+			/**
+			 * An alphanumeric identifier for the taxonomy.
+			 */
+			slug: string;
+			/**
+			 * Whether or not the term cloud should be displayed.
+			 */
+			show_cloud: ContextualField< boolean, 'edit', C >;
+			/**
+			 * Types associated with the taxonomy.
+			 */
+			types: ContextualField< string[], 'view' | 'edit', C >;
+			/**
+			 * REST base route for the taxonomy.
+			 */
+			rest_base: string;
+			/**
+			 * REST namespace route for the taxonomy.
+			 */
+			rest_namespace: string;
+			/**
+			 * The visibility settings for the taxonomy.
+			 */
+			visibility: TaxonomyVisibility;
+		}
+
+		export interface TaxonomyVisibility {
+			/**
+			 * Whether a taxonomy is intended for use publicly either via the admin interface or by front-end users.
+			 */
+			public: boolean;
+			/**
+			 * Whether the taxonomy is publicly queryable.
+			 */
+			publicly_queryable: boolean;
+			/**
+			 * Whether to generate a default UI for managing this taxonomy.
+			 */
+			show_ui: boolean;
+			/**
+			 * Whether to allow automatic creation of taxonomy columns on associated post-types table.
+			 */
+			show_admin_column: boolean;
+			/**
+			 * Whether to make the taxonomy available for selection in navigation menus.
+			 */
+			show_in_nav_menus: boolean;
+			/**
+			 * Whether to show the taxonomy in the quick/bulk edit panel.
+			 */
+			show_in_quick_edit: boolean;
+		}
+	}
+}
+
+export type Taxonomy< C extends Context > = OmitNevers<
+	_BaseEntityTypes.Taxonomy< C >
+>;