Core Data: TypeScript definitions for entity records.

packages/core-data/src/types/attachment.ts

@@ -0,0 +1,121 @@
+/**
+ * Internal dependencies
+ */
+import { EntityRecordWithRawData, OpenOrClosed, PostStatus } from './common';
+
+type MediaType = 'image' | 'file';
+
+export interface Attachment< RawType > extends EntityRecordWithRawData {
+	/**
+	 * The date the post was published, in the site's timezone.
+	 */
+	date: string | null;
+	/**
+	 * The date the post was published, as GMT.
+	 */
+	date_gmt?: string | null;
+	/**
+	 * The globally unique identifier for the post.
+	 */
+	guid?: RawType;
+	/**
+	 * 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?: string;
+	/**
+	 * The date the post was last modified, as GMT.
+	 */
+	modified_gmt?: string;
+	/**
+	 * An alphanumeric identifier for the post unique to its type.
+	 */
+	slug: string;
+	/**
+	 * A named status for the post.
+	 */
+	status?: PostStatus;
+	/**
+	 * Type of post.
+	 */
+	type: string;
+	/**
+	 * Permalink template for the post.
+	 */
+	permalink_template?: string;
+	/**
+	 * Slug automatically generated from the post title.
+	 */
+	generated_slug?: string;
+	/**
+	 * The title for the post.
+	 */
+	title: RawType;
+	/**
+	 * The ID for the author of the post.
+	 */
+	author: number;
+	/**
+	 * Whether or not comments are open on the post.
+	 */
+	comment_status?: OpenOrClosed;
+	/**
+	 * Whether or not the post can be pinged.
+	 */
+	ping_status?: OpenOrClosed;
+	/**
+	 * Meta fields.
+	 */
+	meta?: {
+		[ k: string ]: string;
+	};
+	/**
+	 * The theme file to use to display the post.
+	 */
+	template?: string;
+	/**
+	 * Alternative text to display when attachment is not displayed.
+	 */
+	alt_text: string;
+	/**
+	 * The attachment caption.
+	 */
+	caption: RawType;
+	/**
+	 * The attachment description.
+	 */
+	description?: RawType;
+	/**
+	 * Attachment type.
+	 */
+	media_type: MediaType;
+	/**
+	 * The attachment MIME type.
+	 */
+	mime_type: string;
+	/**
+	 * Details about the media file, specific to its type.
+	 */
+	media_details: {
+		[ k: string ]: string;
+	};
+	/**
+	 * The ID for the associated post of the attachment.
+	 */
+	post?: number;
+	/**
+	 * URL to the original attachment file.
+	 */
+	source_url: string;
+	/**
+	 * List of the missing image sizes of the attachment.
+	 */
+	missing_image_sizes?: string[];
+}

packages/core-data/src/types/comment.ts

@@ -0,0 +1,77 @@
+/**
+ * Internal dependencies
+ */
+import { AvatarUrls, EntityRecordWithRawData } from './common';
+
+export interface Comment< RawType > extends EntityRecordWithRawData {
+	/**
+	 * 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?: string;
+	/**
+	 * IP address for the comment author.
+	 */
+	author_ip?: string;
+	/**
+	 * 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?: string;
+	/**
+	 * The content for the comment.
+	 */
+	content: RawType;
+	/**
+	 * The date the comment was published, in the site's timezone.
+	 */
+	date: string;
+	/**
+	 * The date the comment was published, as GMT.
+	 */
+	date_gmt?: string;
+	/**
+	 * URL to the comment.
+	 */
+	link: string;
+	/**
+	 * The ID for the parent of the comment.
+	 */
+	parent: number;
+	/**
+	 * The ID of the associated post object.
+	 */
+	post?: number;
+	/**
+	 * State of the comment.
+	 */
+	status?: string;
+	/**
+	 * Type of the comment.
+	 */
+	type: string;
+	/**
+	 * Avatar URLs for the comment author.
+	 */
+	author_avatar_urls: AvatarUrls;
+	/**
+	 * Meta fields.
+	 */
+	meta?: {
+		[ k: string ]: string;
+	};
+}

packages/core-data/src/types/common.ts

@@ -0,0 +1,55 @@
+/**
+ * The raw data representation.
+ */
+export interface RawObject {
+	/**
+	 * Data as it exists in the database.
+	 */
+	raw?: string;
+	/**
+	 * Data transformed for display.
+	 */
+	rendered?: string;
+}
+
+export type RawString = string;
+export type RawData = RawObject | RawString;
+
+export type PostStatus = 'publish' | 'future' | 'draft' | 'pending' | 'private';
+
+export type OpenOrClosed = 'open' | 'closed';
+export type ActiveOrInactive = 'active' | 'inactive';
+
+export type TemplateContent =
+	| {
+			/**
+			 * Content for the template, as it exists in the database.
+			 */
+			raw?: string;
+			/**
+			 * Version of the content block format used by the template.
+			 */
+			block_version?: number;
+	  }
+	| string;
+
+export interface EntityRecordWithRawData<
+	RawType extends RawData = RawObject
+> {}
+
+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;
+
+	[ k: string ]: string;
+}

packages/core-data/src/types/menu-location.ts

@@ -0,0 +1,14 @@
+export interface MenuLocation {
+	/**
+	 * The name of the menu location.
+	 */
+	name: string;
+	/**
+	 * The description of the menu location.
+	 */
+	description: string;
+	/**
+	 * The ID of the assigned menu.
+	 */
+	menu: number;
+}

packages/core-data/src/types/nav_menu.ts

@@ -0,0 +1,32 @@
+export interface NavMenu {
+	/**
+	 * Unique identifier for the term.
+	 */
+	id: number;
+	/**
+	 * HTML description of the term.
+	 */
+	description?: string;
+	/**
+	 * HTML title for the term.
+	 */
+	name: string;
+	/**
+	 * An alphanumeric identifier for the term unique to its type.
+	 */
+	slug: string;
+	/**
+	 * Meta fields.
+	 */
+	meta?: {
+		[ k: string ]: string;
+	};
+	/**
+	 * The locations assigned to the menu.
+	 */
+	locations?: string[];
+	/**
+	 * Whether to automatically add top level pages to this menu.
+	 */
+	auto_add?: boolean;
+}

packages/core-data/src/types/nav_menu_item.ts

@@ -0,0 +1,80 @@
+/**
+ * Internal dependencies
+ */
+
+export interface NavMenuItem {
+	/**
+	 * The title for the object.
+	 */
+	title: RawType;
+	/**
+	 * 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: 'taxonomy' | 'post_type' | 'post_type_archive' | 'custom';
+	/**
+	 * A named status for the object.
+	 */
+	status: 'publish' | 'future' | 'draft' | 'pending' | 'private';
+	/**
+	 * 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: '_blank' | '';
+	/**
+	 * 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?: number;
+	/**
+	 * Meta fields.
+	 */
+	meta?: {
+		[ k: string ]: string;
+	};
+}

packages/core-data/src/types/navigation-area.ts

@@ -0,0 +1,14 @@
+export interface NavigationArea {
+	/**
+	 * The name of the navigation area.
+	 */
+	name: string;
+	/**
+	 * The description of the navigation area.
+	 */
+	description: string;
+	/**
+	 * The ID of the assigned navigation.
+	 */
+	navigation: number;
+}