@wordpress/core-data 4.1.0 → 4.1.2

package/src/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/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 >
+>;

package/src/types/theme.ts

@@ -0,0 +1,222 @@
+/**
+ * Internal dependencies
+ */
+import { Context, PostFormat, RenderedText, OmitNevers } from './helpers';
+
+import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+
+declare module './base-entity-types' {
+	export namespace BaseEntityTypes {
+		export interface Theme< C extends Context > {
+			/**
+			 * The theme's stylesheet. This uniquely identifies the theme.
+			 */
+			stylesheet: string;
+			/**
+			 * The theme's template. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's stylesheet.
+			 */
+			template: string;
+			/**
+			 * The theme author.
+			 */
+			author: RenderedText< 'edit' >;
+			/**
+			 * The website of the theme author.
+			 */
+			author_uri: RenderedText< 'edit' >;
+			/**
+			 * A description of the theme.
+			 */
+			description: RenderedText< 'edit' >;
+			/**
+			 * The name of the theme.
+			 */
+			name: RenderedText< 'edit' >;
+			/**
+			 * The minimum PHP version required for the theme to work.
+			 */
+			requires_php: string;
+			/**
+			 * The minimum WordPress version required for the theme to work.
+			 */
+			requires_wp: string;
+			/**
+			 * The theme's screenshot URL.
+			 */
+			screenshot: string;
+			/**
+			 * Tags indicating styles and features of the theme.
+			 */
+			tags: RenderedText< 'edit' >;
+			/**
+			 * The theme's text domain.
+			 */
+			textdomain: string;
+			/**
+			 * Features supported by this theme.
+			 */
+			theme_supports: ThemeSupports;
+			/**
+			 * The URI of the theme's webpage.
+			 */
+			theme_uri: RenderedText< 'edit' >;
+			/**
+			 * The theme's current version.
+			 */
+			version: string;
+			/**
+			 * A named status for the theme.
+			 */
+			status: ThemeStatus;
+		}
+
+		export type ThemeStatus = 'active' | 'inactive';
+
+		export interface ThemeSupports {
+			/**
+			 * Whether theme opts in to wide alignment CSS class.
+			 */
+			'align-wide': boolean;
+			/**
+			 * Whether posts and comments RSS feed links are added to head.
+			 */
+			'automatic-feed-links': boolean;
+			/**
+			 * Custom background if defined by the theme.
+			 */
+			'custom-background': boolean | CustomBackground;
+			/**
+			 * Custom header if defined by the theme.
+			 */
+			'custom-header': boolean | CustomHeader;
+			/**
+			 * Custom logo if defined by the theme.
+			 */
+			'custom-logo': boolean | CustomLogo;
+			/**
+			 * Whether the theme enables Selective Refresh for Widgets being managed with the Customizer.
+			 */
+			'customize-selective-refresh-widgets': boolean;
+			/**
+			 * Whether theme opts in to the dark editor style UI.
+			 */
+			'dark-editor-style': boolean;
+			/**
+			 * Whether the theme disables custom colors.
+			 */
+			'disable-custom-colors': boolean;
+			/**
+			 * Whether the theme disables custom font sizes.
+			 */
+			'disable-custom-font-sizes': boolean;
+			/**
+			 * Whether the theme disables custom gradients.
+			 */
+			'disable-custom-gradients': boolean;
+			/**
+			 * Custom color palette if defined by the theme.
+			 */
+			'editor-color-palette': boolean | Color[];
+			/**
+			 * Custom font sizes if defined by the theme.
+			 */
+			'editor-font-sizes': boolean | FontSize[];
+			/**
+			 * Custom gradient presets if defined by the theme.
+			 */
+			'editor-gradient-presets': boolean | GradientPreset[];
+			/**
+			 * Whether theme opts in to the editor styles CSS wrapper.
+			 */
+			'editor-styles': boolean;
+			/**
+			 * Allows use of HTML5 markup for search forms, comment forms, comment lists, gallery, and caption.
+			 */
+			html5: boolean | Html5Option[];
+			/**
+			 * Post formats supported.
+			 */
+			formats: PostFormat[];
+			/**
+			 * The post types that support thumbnails or true if all post types are supported.
+			 */
+			'post-thumbnails': boolean | string[];
+			/**
+			 * Whether the theme supports responsive embedded content.
+			 */
+			'responsive-embeds': boolean;
+			/**
+			 * Whether the theme can manage the document title tag.
+			 */
+			'title-tag': boolean;
+			/**
+			 * Whether theme opts in to default WordPress block styles for viewing.
+			 */
+			'wp-block-styles': boolean;
+		}
+
+		export interface CustomBackground {
+			'default-image': string;
+			'default-preset': 'default' | 'fill' | 'fit' | 'repeat' | 'custom';
+			'default-position-x': 'left' | 'center' | 'right';
+			'default-position-y': 'left' | 'center' | 'right';
+			'default-size': 'auto' | 'contain' | 'cover';
+			'default-repeat': 'repeat-x' | 'repeat-y' | 'repeat' | 'no-repeat';
+			'default-attachment': 'scroll' | 'fixed';
+			'default-color': string;
+		}
+
+		export interface CustomHeader {
+			'default-image': string;
+			'random-default': boolean;
+			width: number;
+			height: number;
+			'flex-height': boolean;
+			'flex-width': boolean;
+			'default-text-color': string;
+			'header-text': boolean;
+			uploads: boolean;
+			video: boolean;
+		}
+
+		export interface CustomLogo {
+			width: number;
+			height: number;
+			'flex-width': boolean;
+			'flex-height': boolean;
+			'header-text': string[];
+			'unlink-homepage-logo': boolean;
+		}
+
+		export interface Color {
+			name: string;
+			slug: string;
+			color: string;
+		}
+
+		export interface FontSize {
+			name: string;
+			size: number;
+			slug: string;
+		}
+
+		export interface GradientPreset {
+			name: string;
+			gradient: string;
+			slug: string;
+		}
+
+		export type Html5Option =
+			| 'search-form'
+			| 'comment-form'
+			| 'comment-list'
+			| 'gallery'
+			| 'caption'
+			| 'script'
+			| 'style';
+	}
+}
+
+export type Theme< C extends Context > = OmitNevers<
+	_BaseEntityTypes.Theme< C >
+>;

package/src/types/type.ts

@@ -0,0 +1,80 @@
+/**
+ * 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 Type< C extends Context > {
+			/**
+			 * All capabilities used by the post type.
+			 */
+			capabilities: ContextualField<
+				Record< string, string >,
+				'edit',
+				C
+			>;
+			/**
+			 * A human-readable description of the post type.
+			 */
+			description: ContextualField< string, 'view' | 'edit', C >;
+			/**
+			 * Whether or not the post type should have children.
+			 */
+			hierarchical: ContextualField< boolean, 'view' | 'edit', C >;
+			/**
+			 * Whether or not the post type can be viewed.
+			 */
+			viewable: ContextualField< boolean, 'edit', C >;
+			/**
+			 * Human-readable labels for the post type for various contexts.
+			 */
+			labels: ContextualField< Record< string, string >, 'edit', C >;
+			/**
+			 * The title for the post type.
+			 */
+			name: string;
+			/**
+			 * An alphanumeric identifier for the post type.
+			 */
+			slug: string;
+			/**
+			 * All features, supported by the post type.
+			 */
+			supports: ContextualField< Record< string, string >, 'edit', C >;
+			/**
+			 * Taxonomies associated with post type.
+			 */
+			taxonomies: ContextualField< string[], 'view' | 'edit', C >;
+			/**
+			 * REST base route for the post type.
+			 */
+			rest_base: string;
+			/**
+			 * REST route's namespace for the post type.
+			 */
+			rest_namespace: string;
+			/**
+			 * The visibility settings for the post type.
+			 */
+			visibility: ContextualField< TypeVisibility, 'edit', C >;
+		}
+
+		interface TypeVisibility {
+			/**
+			 * Whether to generate a default UI for managing this post type.
+			 */
+			show_ui: boolean;
+			/**
+			 * Whether to make the post type is available for selection in navigation menus.
+			 */
+			show_in_nav_menus: boolean;
+		}
+	}
+}
+
+export type Type< C extends Context > = OmitNevers<
+	_BaseEntityTypes.Type< C >
+>;

package/src/types/user.ts

@@ -0,0 +1,109 @@
+/**
+ * Internal dependencies
+ */
+import { AvatarUrls, Context, ContextualField, OmitNevers } from './helpers';
+
+import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+
+declare module './base-entity-types' {
+	export namespace BaseEntityTypes {
+		export interface User< C extends Context > {
+			/**
+			 * Unique identifier for the user.
+			 */
+			id: number;
+			/**
+			 * Login name for the user.
+			 */
+			username: ContextualField< string, 'edit', C >;
+			/**
+			 * Display name for the user.
+			 */
+			name: string;
+			/**
+			 * First name for the user.
+			 */
+			first_name: ContextualField< string, 'edit', C >;
+			/**
+			 * Last name for the user.
+			 */
+			last_name: ContextualField< string, 'edit', C >;
+			/**
+			 * The email address for the user.
+			 */
+			email: ContextualField< string, 'edit', C >;
+			/**
+			 * URL of the user.
+			 */
+			url: string;
+			/**
+			 * Description of the user.
+			 */
+			description: string;
+			/**
+			 * Author URL of the user.
+			 */
+			link: string;
+			/**
+			 * Locale for the user.
+			 */
+			locale: ContextualField< string, 'edit', C >;
+			/**
+			 * The nickname for the user.
+			 */
+			nickname: ContextualField< string, 'edit', C >;
+			/**
+			 * An alphanumeric identifier for the user.
+			 */
+			slug: string;
+			/**
+			 * Registration date for the user.
+			 */
+			registered_date: ContextualField< string, 'edit', C >;
+			/**
+			 * Roles assigned to the user.
+			 */
+			roles: ContextualField< string[], 'edit', C >;
+			/**
+			 * Password for the user.
+			 *
+			 * This is never sent from the server to the client
+			 * but exists because we might send an update to the
+			 * server with a new password to set.
+			 */
+			password?: string;
+			/**
+			 * All capabilities assigned to the user.
+			 */
+			capabilities: ContextualField<
+				Record< string, string >,
+				'edit',
+				C
+			>;
+			/**
+			 * Any extra capabilities assigned to the user.
+			 */
+			extra_capabilities: ContextualField<
+				Record< string, string >,
+				'edit',
+				C
+			>;
+			/**
+			 * Avatar URLs for the user.
+			 */
+			avatar_urls: AvatarUrls;
+			/**
+			 * Meta fields.
+			 */
+			meta: ContextualField<
+				Record< string, string >,
+				'view' | 'edit',
+				C
+			>;
+		}
+	}
+}
+
+export type User< C extends Context > = OmitNevers<
+	_BaseEntityTypes.User< C >
+>;

package/src/types/widget-type.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 WidgetType< C extends Context > {
+			/**
+			 * Unique slug identifying the widget type.
+			 */
+			id: string;
+			/**
+			 * Human-readable name identifying the widget type.
+			 */
+			name: string;
+			/**
+			 * Description of the widget.
+			 */
+			description: string;
+			/**
+			 * Whether the widget supports multiple instances
+			 */
+			is_multi: boolean;
+			/**
+			 * Class name
+			 */
+			classname: string;
+		}
+	}
+}
+
+export type WidgetType< C extends Context > = OmitNevers<
+	_BaseEntityTypes.WidgetType< C >
+>;

package/src/types/widget.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 Widget< C extends Context > {
+			/**
+			 * Unique identifier for the widget.
+			 */
+			id: string;
+			/**
+			 * The type of the widget. Corresponds to ID in widget-types endpoint.
+			 */
+			id_base: string;
+			/**
+			 * The sidebar the widget belongs to.
+			 */
+			sidebar: string;
+			/**
+			 * HTML representation of the widget.
+			 */
+			rendered: string;
+			/**
+			 * HTML representation of the widget admin form.
+			 */
+			rendered_form: ContextualField< string, 'edit', C >;
+			/**
+			 * Instance settings of the widget, if supported.
+			 */
+			instance: ContextualField< WidgetInstance, 'edit', C >;
+			/**
+			 * URL-encoded form data from the widget admin form. Used
+			 * to update a widget that does not support instance.
+			 *
+			 * This is never sent from the server to the client but exists
+			 * because we might send an update.
+			 */
+			form_data?: string;
+		}
+
+		interface WidgetInstance {
+			/**
+			 * Base64 encoded representation of the instance settings.
+			 */
+			encoded: string;
+			/**
+			 * Cryptographic hash of the instance settings.
+			 */
+			hash: string;
+			/**
+			 * Unencoded instance settings, if supported.
+			 */
+			raw: Record< string, string >;
+		}
+	}
+}
+
+export type Widget< C extends Context > = OmitNevers<
+	_BaseEntityTypes.Widget< C >
+>;