@wordpress/core-data 4.13.0 → 5.0.1-next.957ca95e4c.0

package/build-types/entity-types/comment.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Internal dependencies
+ */
+import type { AvatarUrls, Context, ContextualField, OmitNevers, RenderedText } from './helpers';
+import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+export declare type CommentStatus = 'hold' | 'approve' | 'spam' | 'trash' | '1' | '0';
+declare module './base-entity-records' {
+    namespace BaseEntityRecords {
+        interface Comment<C extends Context> {
+            /**
+             * Unique identifier for the comment.
+             */
+            id: number;
+            /**
+             * The ID of the user object, if author was a user.
+             */
+            author: number;
+            /**
+             * Email address for the comment author.
+             */
+            author_email: ContextualField<string, 'edit', C>;
+            /**
+             * IP address for the comment author.
+             */
+            author_ip: ContextualField<string, 'edit', C>;
+            /**
+             * Display name for the comment author.
+             */
+            author_name: string;
+            /**
+             * URL for the comment author.
+             */
+            author_url: string;
+            /**
+             * User agent for the comment author.
+             */
+            author_user_agent: ContextualField<string, 'edit', C>;
+            /**
+             * The content for the comment.
+             */
+            content: RenderedText<C>;
+            /**
+             * The date the comment was published, in the site's timezone.
+             */
+            date: string;
+            /**
+             * The date the comment was published, as GMT.
+             */
+            date_gmt: ContextualField<string, 'view' | 'edit', C>;
+            /**
+             * URL to the comment.
+             */
+            link: string;
+            /**
+             * The ID for the parent of the comment.
+             */
+            parent: number;
+            /**
+             * The ID of the associated post object.
+             */
+            post: ContextualField<number, 'view' | 'edit', C>;
+            /**
+             * State of the comment.
+             */
+            status: ContextualField<CommentStatus, 'view' | 'edit', C>;
+            /**
+             * Type of the comment.
+             */
+            type: string;
+            /**
+             * Avatar URLs for the comment author.
+             */
+            author_avatar_urls: AvatarUrls;
+            /**
+             * Meta fields.
+             */
+            meta: ContextualField<Record<string, string>, 'view' | 'edit', C>;
+        }
+    }
+}
+export declare type Comment<C extends Context = 'edit'> = OmitNevers<_BaseEntityRecords.Comment<C>>;
+//# sourceMappingURL=comment.d.ts.map

package/build-types/entity-types/comment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment.d.ts","sourceRoot":"","sources":["../../src/entity-types/comment.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EACX,UAAU,EACV,OAAO,EACP,eAAe,EACf,UAAU,EACV,YAAY,EACZ,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,EAAE,iBAAiB,IAAI,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAErF,oBAAY,aAAa,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,GAAG,GAAG,GAAG,CAAC;AAE9E,OAAO,QAAQ,uBAAuB,CAAC;IACtC,UAAiB,iBAAiB,CAAC;QAClC,UAAiB,OAAO,CAAE,CAAC,SAAS,OAAO;YAC1C;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YACX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YACf;;eAEG;YACH,YAAY,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAE,CAAC;YACnD;;eAEG;YACH,SAAS,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAE,CAAC;YAChD;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YACpB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YACnB;;eAEG;YACH,iBAAiB,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAE,CAAC;YACxD;;eAEG;YACH,OAAO,EAAE,YAAY,CAAE,CAAC,CAAE,CAAC;YAC3B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YACb;;eAEG;YACH,QAAQ,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YACxD;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YACb;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YACf;;eAEG;YACH,IAAI,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YACpD;;eAEG;YACH,MAAM,EAAE,eAAe,CAAE,aAAa,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YAC7D;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YACb;;eAEG;YACH,kBAAkB,EAAE,UAAU,CAAC;YAC/B;;eAEG;YACH,IAAI,EAAE,eAAe,CACpB,MAAM,CAAE,MAAM,EAAE,MAAM,CAAE,EACxB,MAAM,GAAG,MAAM,EACf,CAAC,CACD,CAAC;SACF;KACD;CACD;AAED,oBAAY,OAAO,CAAE,CAAC,SAAS,OAAO,GAAG,MAAM,IAAK,UAAU,CAC7D,kBAAkB,CAAC,OAAO,CAAE,CAAC,CAAE,CAC/B,CAAC"}

package/build-types/entity-types/helpers.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Internal dependencies
+ */
+import type { EntityRecord } from './index';
+export interface AvatarUrls {
+    /**
+     * Avatar URL with image size of 24 pixels.
+     */
+    '24': string;
+    /**
+     * Avatar URL with image size of 48 pixels.
+     */
+    '48': string;
+    /**
+     * Avatar URL with image size of 96 pixels.
+     */
+    '96': string;
+}
+export declare type MediaType = 'image' | 'file';
+export declare type CommentingStatus = 'open' | 'closed';
+export declare type PingStatus = 'open' | 'closed';
+export declare type PostStatus = 'publish' | 'future' | 'draft' | 'pending' | 'private';
+export declare type PostFormat = 'standard' | 'aside' | 'chat' | 'gallery' | 'link' | 'image' | 'quote' | 'status' | 'video' | 'audio';
+/**
+ * The REST API context parameter.
+ */
+export declare type Context = 'view' | 'edit' | 'embed';
+/**
+ * ContextualField makes the field available only in the specified given contexts,
+ * and ensure the field is absent from the object when in a different context.
+ *
+ * @example
+ * ```ts
+ * interface Post< C extends Context > {
+ * 	…
+ * 	modified: ContextualField< string, 'edit' | 'view', C >;
+ * 	password: ContextualField< string, 'edit', C >;
+ * 	…
+ * }
+ *
+ * const post: Post<'edit'> = …
+ * // post.modified exists as a string
+ * // post.password exists as a string
+ *
+ * const post: Post<'view'> = …
+ * // post.modified still exists as a string
+ * // post.password is missing, undefined, because we're not in the `edit` context.
+ * ```
+ */
+export declare type ContextualField<FieldType, AvailableInContexts extends Context, C extends Context> = AvailableInContexts extends C ? FieldType : never;
+/**
+ * Removes all the properties of type never, even the deeply nested ones.
+ *
+ * @example
+ * ```ts
+ * type MyType = {
+ *   foo: string;
+ *   bar: never;
+ *   nested: {
+ *     foo: string;
+ *     bar: never;
+ *   }
+ * }
+ * const x = {} as OmitNevers<MyType>;
+ * // x is of type { foo: string; nested: { foo: string; }}
+ * // The `never` properties were removed entirely
+ * ```
+ */
+export declare type OmitNevers<T, Nevers = {
+    [K in keyof T]: Exclude<T[K], undefined> extends never ? never : T[K] extends Record<string, unknown> ? OmitNevers<T[K]> : T[K];
+}> = Pick<Nevers, {
+    [K in keyof Nevers]: Nevers[K] extends never ? never : K;
+}[keyof Nevers]>;
+/**
+ * A string that the server renders which often involves
+ * modifications from the raw source string.
+ *
+ * For example, block HTML with the comment delimiters exists
+ * in `post_content` but those comments are stripped out when
+ * rendering to a page view. Similarly, plugins might modify
+ * content or replace shortcodes.
+ */
+export interface RenderedText<C extends Context> {
+    /**
+     * The source string which will be rendered on page views.
+     */
+    raw: ContextualField<string, 'edit', C>;
+    /**
+     * The output of the raw source after processing and filtering on the server.
+     */
+    rendered: string;
+}
+/**
+ * Updatable<EntityRecord> is a type describing Edited Entity Records. They are like
+ * regular Entity Records, but they have all the local edits applied on top of the REST API data.
+ *
+ * This turns certain field from an object into a string.
+ *
+ * Entities like Post have fields that only be rendered on the server, like title, excerpt,
+ * and content. The REST API exposes both the raw markup and the rendered version of those fields.
+ * For example, in the block editor, content.rendered could used as a visual preview, and
+ * content.raw could be used to populate the code editor.
+ *
+ * When updating these rendered fields, Javascript is not be able to properly render arbitrary block
+ * markup. Therefore, it stores only the raw markup without the rendered part. And since that's a string,
+ * the entire field becomes a string.
+ *
+ * @example
+ * ```ts
+ * type Post< C extends Context > {
+ *   title: RenderedText< C >;
+ * }
+ * const post = {} as Post;
+ * // post.title is an object with raw and rendered properties
+ *
+ * const updatablePost = {} as Updatable< Post >;
+ * // updatablePost.title is a string
+ * ```
+ */
+export declare type Updatable<T extends EntityRecord<'edit'>> = {
+    [K in keyof T]: T[K] extends RenderedText<any> ? string : T[K];
+};
+//# sourceMappingURL=helpers.d.ts.map

package/build-types/entity-types/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/entity-types/helpers.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C,MAAM,WAAW,UAAU;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACb;AAED,oBAAY,SAAS,GAAG,OAAO,GAAG,MAAM,CAAC;AACzC,oBAAY,gBAAgB,GAAG,MAAM,GAAG,QAAQ,CAAC;AACjD,oBAAY,UAAU,GAAG,MAAM,GAAG,QAAQ,CAAC;AAC3C,oBAAY,UAAU,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;AAChF,oBAAY,UAAU,GACnB,UAAU,GACV,OAAO,GACP,MAAM,GACN,SAAS,GACT,MAAM,GACN,OAAO,GACP,OAAO,GACP,QAAQ,GACR,OAAO,GACP,OAAO,CAAC;AAEX;;GAEG;AACH,oBAAY,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,oBAAY,eAAe,CAC1B,SAAS,EACT,mBAAmB,SAAS,OAAO,EACnC,CAAC,SAAS,OAAO,IACd,mBAAmB,SAAS,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC;AAEtD;;;;;;;;;;;;;;;;;GAiBG;AACH,oBAAY,UAAU,CACrB,CAAC,EACD,MAAM,GAAG;KACN,CAAC,IAAI,MAAM,CAAC,GAAI,OAAO,CAAE,CAAC,CAAE,CAAC,CAAE,EAAE,SAAS,CAAE,SAAS,KAAK,GACzD,KAAK,GACL,CAAC,CAAE,CAAC,CAAE,SAAS,MAAM,CAAE,MAAM,EAAE,OAAO,CAAE,GACxC,UAAU,CAAE,CAAC,CAAE,CAAC,CAAE,CAAE,GACpB,CAAC,CAAE,CAAC,CAAE;CACT,IACE,IAAI,CACP,MAAM,EACN;KACG,CAAC,IAAI,MAAM,MAAM,GAAI,MAAM,CAAE,CAAC,CAAE,SAAS,KAAK,GAAG,KAAK,GAAG,CAAC;CAC5D,CAAE,MAAM,MAAM,CAAE,CACjB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAY,CAAE,CAAC,SAAS,OAAO;IAC/C;;OAEG;IACH,GAAG,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAE,CAAC;IAC1C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,oBAAY,SAAS,CAAE,CAAC,SAAS,YAAY,CAAE,MAAM,CAAE,IAAK;KACzD,CAAC,IAAI,MAAM,CAAC,GAAI,CAAC,CAAE,CAAC,CAAE,SAAS,YAAY,CAAE,GAAG,CAAE,GAAG,MAAM,GAAG,CAAC,CAAE,CAAC,CAAE;CACtE,CAAC"}

package/build-types/entity-types/index.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Internal dependencies
+ */
+import type { Context, Updatable } from './helpers';
+import type { Attachment } from './attachment';
+import type { Comment } from './comment';
+import type { MenuLocation } from './menu-location';
+import type { NavMenu } from './nav-menu';
+import type { NavMenuItem } from './nav-menu-item';
+import type { Page } from './page';
+import type { Plugin } from './plugin';
+import type { Post } from './post';
+import type { Settings } from './settings';
+import type { Sidebar } from './sidebar';
+import type { Taxonomy } from './taxonomy';
+import type { Theme } from './theme';
+import type { User } from './user';
+import type { Type } from './type';
+import type { Widget } from './widget';
+import type { WidgetType } from './widget-type';
+import type { WpTemplate } from './wp-template';
+import type { WpTemplatePart } from './wp-template-part';
+export type { BaseEntityRecords } from './base-entity-records';
+export type { Attachment, Comment, Context, MenuLocation, NavMenu, NavMenuItem, Page, Plugin, Post, Settings, Sidebar, Taxonomy, Theme, Updatable, User, Type, Widget, WidgetType, WpTemplate, WpTemplatePart, };
+/**
+ * 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.
+ *
+ * Example:
+ *
+ * ```ts
+ * import type { Context } from '@wordpress/core-data';
+ * // ...
+ *
+ * interface Client {
+ *   id: number;
+ *   name: string;
+ *   // ...
+ * }
+ *
+ * interface Order< C extends Context > {
+ *   id: number;
+ *   name: string;
+ *   // ...
+ * }
+ *
+ * declare module '@wordpress/core-data' {
+ *     export interface PerPackageEntityRecords< C extends Context > {
+ *         myPlugin: Client | Order<C>>
+ *     }
+ * }
+ *
+ * const c = getEntityRecord<Order>( 'myPlugin', 'order', 15 );
+ * // c is of the type Order
+ * ```
+ */
+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 known record types.
+ */
+export declare type EntityRecord<C extends Context = 'edit'> = PerPackageEntityRecords<C>[keyof PerPackageEntityRecords<C>];
+//# sourceMappingURL=index.d.ts.map

package/build-types/entity-types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/entity-types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,YAAY,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,YAAY,EACX,UAAU,EACV,OAAO,EACP,OAAO,EACP,YAAY,EACZ,OAAO,EACP,WAAW,EACX,IAAI,EACJ,MAAM,EACN,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,QAAQ,EACR,KAAK,EACL,SAAS,EACT,IAAI,EACJ,IAAI,EACJ,MAAM,EACN,UAAU,EACV,UAAU,EACV,cAAc,GACd,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,WAAW,uBAAuB,CAAE,CAAC,SAAS,OAAO;IAC1D,IAAI,EACD,UAAU,CAAE,CAAC,CAAE,GACf,OAAO,CAAE,CAAC,CAAE,GACZ,YAAY,CAAE,CAAC,CAAE,GACjB,OAAO,CAAE,CAAC,CAAE,GACZ,WAAW,CAAE,CAAC,CAAE,GAChB,IAAI,CAAE,CAAC,CAAE,GACT,MAAM,CAAE,CAAC,CAAE,GACX,IAAI,CAAE,CAAC,CAAE,GACT,QAAQ,CAAE,CAAC,CAAE,GACb,OAAO,CAAE,CAAC,CAAE,GACZ,QAAQ,CAAE,CAAC,CAAE,GACb,KAAK,CAAE,CAAC,CAAE,GACV,IAAI,CAAE,CAAC,CAAE,GACT,IAAI,CAAE,CAAC,CAAE,GACT,MAAM,CAAE,CAAC,CAAE,GACX,UAAU,CAAE,CAAC,CAAE,GACf,UAAU,CAAE,CAAC,CAAE,GACf,cAAc,CAAE,CAAC,CAAE,CAAC;CACvB;AAED;;GAEG;AACH,oBAAY,YAAY,CAAE,CAAC,SAAS,OAAO,GAAG,MAAM,IACnD,uBAAuB,CAAE,CAAC,CAAE,CAAE,MAAM,uBAAuB,CAAE,CAAC,CAAE,CAAE,CAAC"}

package/build-types/entity-types/menu-location.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Internal dependencies
+ */
+import type { Context, OmitNevers } from './helpers';
+import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+declare module './base-entity-records' {
+    namespace BaseEntityRecords {
+        interface MenuLocation<C extends Context> {
+            /**
+             * The name of the menu location.
+             */
+            name: string;
+            /**
+             * The description of the menu location.
+             */
+            description: string;
+            /**
+             * The ID of the assigned menu.
+             */
+            menu: number;
+        }
+    }
+}
+export declare type MenuLocation<C extends Context = 'edit'> = OmitNevers<_BaseEntityRecords.MenuLocation<C>>;
+//# sourceMappingURL=menu-location.d.ts.map

package/build-types/entity-types/menu-location.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"menu-location.d.ts","sourceRoot":"","sources":["../../src/entity-types/menu-location.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAErD,OAAO,KAAK,EAAE,iBAAiB,IAAI,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAErF,OAAO,QAAQ,uBAAuB,CAAC;IACtC,UAAiB,iBAAiB,CAAC;QAClC,UAAiB,YAAY,CAAE,CAAC,SAAS,OAAO;YAC/C;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YACb;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YACpB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACb;KACD;CACD;AAED,oBAAY,YAAY,CAAE,CAAC,SAAS,OAAO,GAAG,MAAM,IAAK,UAAU,CAClE,kBAAkB,CAAC,YAAY,CAAE,CAAC,CAAE,CACpC,CAAC"}

package/build-types/entity-types/nav-menu-item.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Internal dependencies
+ */
+import type { RenderedText, Context, ContextualField, OmitNevers } from './helpers';
+import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+export declare type NavMenuItemType = 'taxonomy' | 'post_type' | 'post_type_archive' | 'custom';
+export declare type NavMenuItemStatus = 'publish' | 'future' | 'draft' | 'pending' | 'private';
+export declare type Target = '_blank' | '';
+declare module './base-entity-records' {
+    namespace BaseEntityRecords {
+        interface NavMenuItem<C extends Context> {
+            /**
+             * The title for the object.
+             */
+            title: RenderedText<C>;
+            /**
+             * Unique identifier for the object.
+             */
+            id: number;
+            /**
+             * The singular label used to describe this type of menu item.
+             */
+            type_label: string;
+            /**
+             * The family of objects originally represented, such as "post_type" or "taxonomy".
+             */
+            type: NavMenuItemType;
+            /**
+             * A named status for the object.
+             */
+            status: NavMenuItemStatus;
+            /**
+             * The ID for the parent of the object.
+             */
+            parent: number;
+            /**
+             * Text for the title attribute of the link element for this menu item.
+             */
+            attr_title: string;
+            /**
+             * Class names for the link element of this menu item.
+             */
+            classes: string[];
+            /**
+             * The description of this menu item.
+             */
+            description: string;
+            /**
+             * The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.
+             */
+            menu_order: number;
+            /**
+             * The type of object originally represented, such as "category", "post", or "attachment".
+             */
+            object: string;
+            /**
+             * The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.
+             */
+            object_id: number;
+            /**
+             * The target attribute of the link element for this menu item.
+             */
+            target: Target;
+            /**
+             * The URL to which this menu item points.
+             */
+            url: string;
+            /**
+             * The XFN relationship expressed in the link of this menu item.
+             */
+            xfn: string[];
+            /**
+             * Whether the menu item represents an object that no longer exists.
+             */
+            invalid: boolean;
+            /**
+             * The terms assigned to the object in the nav_menu taxonomy.
+             */
+            menus: ContextualField<number, 'view' | 'edit', C>;
+            /**
+             * Meta fields.
+             */
+            meta: ContextualField<Record<string, string>, 'view' | 'edit', C>;
+        }
+    }
+}
+export declare type NavMenuItem<C extends Context = 'edit'> = OmitNevers<_BaseEntityRecords.NavMenuItem<C>>;
+//# sourceMappingURL=nav-menu-item.d.ts.map

package/build-types/entity-types/nav-menu-item.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nav-menu-item.d.ts","sourceRoot":"","sources":["../../src/entity-types/nav-menu-item.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EACX,YAAY,EACZ,OAAO,EACP,eAAe,EACf,UAAU,EACV,MAAM,WAAW,CAAC;AAEnB,OAAO,KAAK,EAAE,iBAAiB,IAAI,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAErF,oBAAY,eAAe,GACxB,UAAU,GACV,WAAW,GACX,mBAAmB,GACnB,QAAQ,CAAC;AACZ,oBAAY,iBAAiB,GAC1B,SAAS,GACT,QAAQ,GACR,OAAO,GACP,SAAS,GACT,SAAS,CAAC;AACb,oBAAY,MAAM,GAAG,QAAQ,GAAG,EAAE,CAAC;AAEnC,OAAO,QAAQ,uBAAuB,CAAC;IACtC,UAAiB,iBAAiB,CAAC;QAClC,UAAiB,WAAW,CAAE,CAAC,SAAS,OAAO;YAC9C;;eAEG;YACH,KAAK,EAAE,YAAY,CAAE,CAAC,CAAE,CAAC;YACzB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YACX;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YACnB;;eAEG;YACH,IAAI,EAAE,eAAe,CAAC;YACtB;;eAEG;YACH,MAAM,EAAE,iBAAiB,CAAC;YAC1B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YACf;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YACnB;;eAEG;YACH,OAAO,EAAE,MAAM,EAAE,CAAC;YAClB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YACpB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YACnB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YACf;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAClB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YACf;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;YACZ;;eAEG;YACH,GAAG,EAAE,MAAM,EAAE,CAAC;YACd;;eAEG;YACH,OAAO,EAAE,OAAO,CAAC;YACjB;;eAEG;YACH,KAAK,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YACrD;;eAEG;YACH,IAAI,EAAE,eAAe,CACpB,MAAM,CAAE,MAAM,EAAE,MAAM,CAAE,EACxB,MAAM,GAAG,MAAM,EACf,CAAC,CACD,CAAC;SACF;KACD;CACD;AAED,oBAAY,WAAW,CAAE,CAAC,SAAS,OAAO,GAAG,MAAM,IAAK,UAAU,CACjE,kBAAkB,CAAC,WAAW,CAAE,CAAC,CAAE,CACnC,CAAC"}

package/build-types/entity-types/nav-menu.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Internal dependencies
+ */
+import type { Context, ContextualField, OmitNevers } from './helpers';
+import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+declare module './base-entity-records' {
+    namespace BaseEntityRecords {
+        interface NavMenu<C extends Context> {
+            /**
+             * Unique identifier for the term.
+             */
+            id: number;
+            /**
+             * HTML description of the term.
+             */
+            description: ContextualField<string, 'view' | 'edit', C>;
+            /**
+             * HTML title for the term.
+             */
+            name: string;
+            /**
+             * An alphanumeric identifier for the term unique to its type.
+             */
+            slug: string;
+            /**
+             * Meta fields.
+             */
+            meta: ContextualField<Record<string, string>, 'view' | 'edit', C>;
+            /**
+             * The locations assigned to the menu.
+             */
+            locations: ContextualField<string[], 'view' | 'edit', C>;
+            /**
+             * The DB ID of the original object this menu item represents, e . g . ID for posts and term_id for categories.
+             */
+            object_id: number;
+            /**
+             * Whether to automatically add top level pages to this menu.
+             */
+            auto_add: ContextualField<boolean, 'view' | 'edit', C>;
+        }
+    }
+}
+export declare type NavMenu<C extends Context = 'edit'> = OmitNevers<_BaseEntityRecords.NavMenu<C>>;
+//# sourceMappingURL=nav-menu.d.ts.map

package/build-types/entity-types/nav-menu.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nav-menu.d.ts","sourceRoot":"","sources":["../../src/entity-types/nav-menu.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEtE,OAAO,KAAK,EAAE,iBAAiB,IAAI,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAErF,OAAO,QAAQ,uBAAuB,CAAC;IACtC,UAAiB,iBAAiB,CAAC;QAClC,UAAiB,OAAO,CAAE,CAAC,SAAS,OAAO;YAC1C;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YACX;;eAEG;YACH,WAAW,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YAC3D;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YACb;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YACb;;eAEG;YACH,IAAI,EAAE,eAAe,CACpB,MAAM,CAAE,MAAM,EAAE,MAAM,CAAE,EACxB,MAAM,GAAG,MAAM,EACf,CAAC,CACD,CAAC;YACF;;eAEG;YACH,SAAS,EAAE,eAAe,CAAE,MAAM,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YAC3D;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAClB;;eAEG;YACH,QAAQ,EAAE,eAAe,CAAE,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;SACzD;KACD;CACD;AAED,oBAAY,OAAO,CAAE,CAAC,SAAS,OAAO,GAAG,MAAM,IAAK,UAAU,CAC7D,kBAAkB,CAAC,OAAO,CAAE,CAAC,CAAE,CAC/B,CAAC"}

package/build-types/entity-types/page.d.ts

@@ -0,0 +1,120 @@
+/**
+ * Internal dependencies
+ */
+import type { CommentingStatus, Context, ContextualField, PingStatus, PostStatus, RenderedText, OmitNevers } from './helpers';
+import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+declare module './base-entity-records' {
+    namespace BaseEntityRecords {
+        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 declare type Page<C extends Context = 'edit'> = OmitNevers<_BaseEntityRecords.Page<C>>;
+//# sourceMappingURL=page.d.ts.map

package/build-types/entity-types/page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page.d.ts","sourceRoot":"","sources":["../../src/entity-types/page.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EACX,gBAAgB,EAChB,OAAO,EACP,eAAe,EACf,UAAU,EACV,UAAU,EACV,YAAY,EACZ,UAAU,EACV,MAAM,WAAW,CAAC;AAEnB,OAAO,KAAK,EAAE,iBAAiB,IAAI,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAErF,OAAO,QAAQ,uBAAuB,CAAC;IACtC,UAAiB,iBAAiB,CAAC;QAClC,UAAiB,IAAI,CAAE,CAAC,SAAS,OAAO;YACvC;;eAEG;YACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;YACpB;;eAEG;YACH,QAAQ,EAAE,eAAe,CAAE,MAAM,GAAG,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YAC/D;;eAEG;YACH,IAAI,EAAE,eAAe,CAAE,YAAY,CAAE,CAAC,CAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YAC/D;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YACX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YACb;;eAEG;YACH,QAAQ,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YACxD;;eAEG;YACH,YAAY,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YAC5D;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YACb;;eAEG;YACH,MAAM,EAAE,eAAe,CAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YAC1D;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YACb;;eAEG;YACH,QAAQ,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAE,CAAC;YAC/C;;eAEG;YACH,kBAAkB,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAE,CAAC;YACzD;;eAEG;YACH,cAAc,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAE,CAAC;YACrD;;eAEG;YACH,MAAM,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YACtD;;eAEG;YACH,KAAK,EAAE,YAAY,CAAE,CAAC,CAAE,CAAC;YACzB;;eAEG;YACH,OAAO,EAAE,eAAe,CACvB,YAAY,CAAE,CAAC,CAAE,GAAG;gBACnB;;mBAEG;gBACH,YAAY,EAAE,OAAO,CAAC;gBACtB;;mBAEG;gBACH,aAAa,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAE,CAAC;aACpD,EACD,MAAM,GAAG,MAAM,EACf,CAAC,CACD,CAAC;YACF;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YACf;;eAEG;YACH,OAAO,EAAE,YAAY,CAAE,CAAC,CAAE,GAAG;gBAC5B,SAAS,EAAE,OAAO,CAAC;aACnB,CAAC;YACF;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;YACvB;;eAEG;YACH,cAAc,EAAE,eAAe,CAC9B,gBAAgB,EAChB,MAAM,GAAG,MAAM,EACf,CAAC,CACD,CAAC;YACF;;eAEG;YACH,WAAW,EAAE,eAAe,CAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YAC/D;;eAEG;YACH,UAAU,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YAC1D;;eAEG;YACH,IAAI,EAAE,eAAe,CACpB,MAAM,CAAE,MAAM,EAAE,MAAM,CAAE,EACxB,MAAM,GAAG,MAAM,EACf,CAAC,CACD,CAAC;YACF;;eAEG;YACH,QAAQ,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;SACxD;KACD;CACD;AAED,oBAAY,IAAI,CAAE,CAAC,SAAS,OAAO,GAAG,MAAM,IAAK,UAAU,CAC1D,kBAAkB,CAAC,IAAI,CAAE,CAAC,CAAE,CAC5B,CAAC"}

package/build-types/entity-types/plugin.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Internal dependencies
+ */
+import type { Context, ContextualField, RenderedText, OmitNevers } from './helpers';
+import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+declare module './base-entity-records' {
+    namespace BaseEntityRecords {
+        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 declare type PluginStatus = 'active' | 'inactive';
+export declare type Plugin<C extends Context = 'edit'> = OmitNevers<_BaseEntityRecords.Plugin<C>>;
+//# sourceMappingURL=plugin.d.ts.map

package/build-types/entity-types/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/entity-types/plugin.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EACX,OAAO,EACP,eAAe,EACf,YAAY,EACZ,UAAU,EACV,MAAM,WAAW,CAAC;AAEnB,OAAO,KAAK,EAAE,iBAAiB,IAAI,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAErF,OAAO,QAAQ,uBAAuB,CAAC;IACtC,UAAiB,iBAAiB,CAAC;QAClC,UAAiB,MAAM,CAAE,CAAC,SAAS,OAAO;YACzC;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YACf;;eAEG;YACH,MAAM,EAAE,YAAY,CAAC;YACrB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YACb;;eAEG;YACH,UAAU,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YAC1D;;eAEG;YACH,MAAM,EAAE,eAAe,CACtB,MAAM,CAAE,MAAM,EAAE,MAAM,CAAE,EACxB,MAAM,GAAG,MAAM,EACf,CAAC,CACD,CAAC;YACF;;eAEG;YACH,UAAU,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YAC1D;;eAEG;YACH,WAAW,EAAE,eAAe,CAC3B,YAAY,CAAE,MAAM,CAAE,EACtB,MAAM,GAAG,MAAM,EACf,CAAC,CACD,CAAC;YACF;;eAEG;YACH,OAAO,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;YACvD;;eAEG;YACH,YAAY,EAAE,OAAO,CAAC;YACtB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YACpB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YACrB;;eAEG;YACH,UAAU,EAAE,eAAe,CAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;SAC1D;KACD;CACD;AAED,oBAAY,YAAY,GAAG,QAAQ,GAAG,UAAU,CAAC;AACjD,oBAAY,MAAM,CAAE,CAAC,SAAS,OAAO,GAAG,MAAM,IAAK,UAAU,CAC5D,kBAAkB,CAAC,MAAM,CAAE,CAAC,CAAE,CAC9B,CAAC"}