From 074af25836cb05332cc6bfe1e82219cba1fe10f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Zieli=C5=84ski?= Date: Mon, 7 Mar 2022 13:27:10 +0100 Subject: [PATCH 1/4] Rename "Entity type" interfaces to "Entity records" since that's what they actually model --- .../core-data/src/entity-types/helpers.ts | 2 +- packages/core-data/src/entity-types/index.ts | 71 +------------------ .../entity-types/{ => records}/attachment.ts | 12 ++-- .../base-entity-records.ts} | 10 +-- .../src/entity-types/{ => records}/comment.ts | 12 ++-- .../src/entity-types/records/index.ts | 70 ++++++++++++++++++ .../{ => records}/menu-location.ts | 10 +-- .../{ => records}/nav-menu-item.ts | 15 ++-- .../entity-types/{ => records}/nav-menu.ts | 10 +-- .../{ => records}/navigation-area.ts | 10 +-- .../src/entity-types/{ => records}/page.ts | 12 ++-- .../src/entity-types/{ => records}/plugin.ts | 15 ++-- .../src/entity-types/{ => records}/post.ts | 12 ++-- .../entity-types/{ => records}/settings.ts | 15 ++-- .../src/entity-types/{ => records}/sidebar.ts | 12 ++-- .../entity-types/{ => records}/taxonomy.ts | 10 +-- .../src/entity-types/{ => records}/theme.ts | 10 +-- .../src/entity-types/{ => records}/type.ts | 10 +-- .../src/entity-types/{ => records}/user.ts | 15 ++-- .../entity-types/{ => records}/widget-type.ts | 10 +-- .../src/entity-types/{ => records}/widget.ts | 10 +-- .../{ => records}/wp-template-part.ts | 12 ++-- .../entity-types/{ => records}/wp-template.ts | 12 ++-- 23 files changed, 200 insertions(+), 177 deletions(-) rename packages/core-data/src/entity-types/{ => records}/attachment.ts (92%) rename packages/core-data/src/entity-types/{base-entity-types.ts => records/base-entity-records.ts} (74%) rename packages/core-data/src/entity-types/{ => records}/comment.ts (88%) create mode 100644 packages/core-data/src/entity-types/records/index.ts rename packages/core-data/src/entity-types/{ => records}/menu-location.ts (59%) rename packages/core-data/src/entity-types/{ => records}/nav-menu-item.ts (88%) rename packages/core-data/src/entity-types/{ => records}/nav-menu.ts (79%) rename packages/core-data/src/entity-types/{ => records}/navigation-area.ts (60%) rename packages/core-data/src/entity-types/{ => records}/page.ts (93%) rename packages/core-data/src/entity-types/{ => records}/plugin.ts (82%) rename packages/core-data/src/entity-types/{ => records}/post.ts (93%) rename packages/core-data/src/entity-types/{ => records}/settings.ts (85%) rename packages/core-data/src/entity-types/{ => records}/sidebar.ts (81%) rename packages/core-data/src/entity-types/{ => records}/taxonomy.ts (88%) rename packages/core-data/src/entity-types/{ => records}/theme.ts (94%) rename packages/core-data/src/entity-types/{ => records}/type.ts (86%) rename packages/core-data/src/entity-types/{ => records}/user.ts (87%) rename packages/core-data/src/entity-types/{ => records}/widget-type.ts (67%) rename packages/core-data/src/entity-types/{ => records}/widget.ts (82%) rename packages/core-data/src/entity-types/{ => records}/wp-template-part.ts (87%) rename packages/core-data/src/entity-types/{ => records}/wp-template.ts (87%) diff --git a/packages/core-data/src/entity-types/helpers.ts b/packages/core-data/src/entity-types/helpers.ts index e3e60489bdaaf..59ed25a72bc8b 100644 --- a/packages/core-data/src/entity-types/helpers.ts +++ b/packages/core-data/src/entity-types/helpers.ts @@ -1,7 +1,7 @@ /** * Internal dependencies */ -import { EntityRecord } from './index'; +import type { EntityRecord } from './index'; export interface AvatarUrls { /** diff --git a/packages/core-data/src/entity-types/index.ts b/packages/core-data/src/entity-types/index.ts index 80a173862b58a..82cff74cbcedb 100644 --- a/packages/core-data/src/entity-types/index.ts +++ b/packages/core-data/src/entity-types/index.ts @@ -1,72 +1,5 @@ /** * Internal dependencies */ -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 { NavigationArea } from './navigation-area'; -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'; -import type { Context, Updatable } from './helpers'; - -export type { BaseEntityTypes } from './base-entity-types'; - -export type { - Context, - Updatable, - Attachment, - Comment, - MenuLocation, - NavMenu, - NavMenuItem, - NavigationArea, - Page, - Plugin, - Post, - Settings, - Sidebar, - Taxonomy, - Theme, - User, - Type, - Widget, - WidgetType, - WpTemplate, - WpTemplatePart, -}; - -export type EntityRecord< C extends Context > = - | Attachment< C > - | Comment< C > - | MenuLocation< C > - | NavMenu< C > - | NavMenuItem< C > - | NavigationArea< C > - | Page< C > - | Plugin< C > - | Post< C > - | Settings< C > - | Sidebar< C > - | Taxonomy< C > - | Theme< C > - | Type< C > - | User< C > - | Widget< C > - | WidgetType< C > - | WpTemplate< C > - | WpTemplatePart< C >; - -export type UpdatableEntityRecord = Updatable< EntityRecord< 'edit' > >; +export type { Context, Updatable } from './helpers'; +export * from './records'; diff --git a/packages/core-data/src/entity-types/attachment.ts b/packages/core-data/src/entity-types/records/attachment.ts similarity index 92% rename from packages/core-data/src/entity-types/attachment.ts rename to packages/core-data/src/entity-types/records/attachment.ts index 4ad94226f0a87..1a034ccd4d479 100644 --- a/packages/core-data/src/entity-types/attachment.ts +++ b/packages/core-data/src/entity-types/records/attachment.ts @@ -1,7 +1,7 @@ /** * Internal dependencies */ -import { +import type { Context, ContextualField, MediaType, @@ -10,12 +10,12 @@ import { OmitNevers, CommentingStatus, PingStatus, -} from './helpers'; +} from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface Attachment< C extends Context > { /** * The date the post was published, in the site's timezone. @@ -142,5 +142,5 @@ declare module './base-entity-types' { } export type Attachment< C extends Context > = OmitNevers< - _BaseEntityTypes.Attachment< C > + _BaseEntityRecords.Attachment< C > >; diff --git a/packages/core-data/src/entity-types/base-entity-types.ts b/packages/core-data/src/entity-types/records/base-entity-records.ts similarity index 74% rename from packages/core-data/src/entity-types/base-entity-types.ts rename to packages/core-data/src/entity-types/records/base-entity-records.ts index 790eaa63cfc9d..813df023a1114 100644 --- a/packages/core-data/src/entity-types/base-entity-types.ts +++ b/packages/core-data/src/entity-types/records/base-entity-records.ts @@ -1,10 +1,10 @@ /** - * This module exists solely to make the BaseEntityTypes namespace extensible + * This module exists solely to make the BaseEntityRecords namespace extensible * with declaration merging: * * ```ts - * declare module './base-entity-types' { - * export namespace BaseEntityTypes { + * declare module './base-entity-records' { + * export namespace BaseEntityRecords { * export interface Comment< C extends Context > { * id: number; * // ... @@ -19,7 +19,7 @@ * ```ts * import type { Context } from '@wordpress/core-data'; * declare module '@wordpress/core-data' { - * export namespace BaseEntityTypes { + * export namespace BaseEntityRecords { * export interface Comment< C extends Context > { * numberOfViews: number; * } @@ -33,4 +33,4 @@ * // c.id is still present * ``` */ -export namespace BaseEntityTypes {} +export namespace BaseEntityRecords {} diff --git a/packages/core-data/src/entity-types/comment.ts b/packages/core-data/src/entity-types/records/comment.ts similarity index 88% rename from packages/core-data/src/entity-types/comment.ts rename to packages/core-data/src/entity-types/records/comment.ts index 56cd559780770..a3f5ce59a7830 100644 --- a/packages/core-data/src/entity-types/comment.ts +++ b/packages/core-data/src/entity-types/records/comment.ts @@ -1,19 +1,19 @@ /** * Internal dependencies */ -import { +import type { AvatarUrls, Context, ContextualField, OmitNevers, RenderedText, -} from './helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +} from '../helpers'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; export type CommentStatus = 'hold' | 'approve' | 'spam' | 'trash' | '1' | '0'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface Comment< C extends Context > { /** * Unique identifier for the comment. @@ -92,5 +92,5 @@ declare module './base-entity-types' { } export type Comment< C extends Context > = OmitNevers< - _BaseEntityTypes.Comment< C > + _BaseEntityRecords.Comment< C > >; diff --git a/packages/core-data/src/entity-types/records/index.ts b/packages/core-data/src/entity-types/records/index.ts new file mode 100644 index 0000000000000..85ac9d5df73a1 --- /dev/null +++ b/packages/core-data/src/entity-types/records/index.ts @@ -0,0 +1,70 @@ +/** + * Internal dependencies + */ +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 { NavigationArea } from './navigation-area'; +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'; +import type { Context, Updatable } from '../helpers'; + +export type { BaseEntityRecords } from './base-entity-records'; + +export type { + Attachment, + Comment, + MenuLocation, + NavMenu, + NavMenuItem, + NavigationArea, + Page, + Plugin, + Post, + Settings, + Sidebar, + Taxonomy, + Theme, + User, + Type, + Widget, + WidgetType, + WpTemplate, + WpTemplatePart, +}; + +export type EntityRecord< C extends Context > = + | Attachment< C > + | Comment< C > + | MenuLocation< C > + | NavMenu< C > + | NavMenuItem< C > + | NavigationArea< C > + | Page< C > + | Plugin< C > + | Post< C > + | Settings< C > + | Sidebar< C > + | Taxonomy< C > + | Theme< C > + | Type< C > + | User< C > + | Widget< C > + | WidgetType< C > + | WpTemplate< C > + | WpTemplatePart< C >; + +export type UpdatableEntityRecord = Updatable< EntityRecord< 'edit' > >; diff --git a/packages/core-data/src/entity-types/menu-location.ts b/packages/core-data/src/entity-types/records/menu-location.ts similarity index 59% rename from packages/core-data/src/entity-types/menu-location.ts rename to packages/core-data/src/entity-types/records/menu-location.ts index 71fb5abab8714..df3770f14ace0 100644 --- a/packages/core-data/src/entity-types/menu-location.ts +++ b/packages/core-data/src/entity-types/records/menu-location.ts @@ -1,12 +1,12 @@ /** * Internal dependencies */ -import { Context, OmitNevers } from './helpers'; +import type { Context, OmitNevers } from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface MenuLocation< C extends Context > { /** * The name of the menu location. @@ -25,5 +25,5 @@ declare module './base-entity-types' { } export type MenuLocation< C extends Context > = OmitNevers< - _BaseEntityTypes.MenuLocation< C > + _BaseEntityRecords.MenuLocation< C > >; diff --git a/packages/core-data/src/entity-types/nav-menu-item.ts b/packages/core-data/src/entity-types/records/nav-menu-item.ts similarity index 88% rename from packages/core-data/src/entity-types/nav-menu-item.ts rename to packages/core-data/src/entity-types/records/nav-menu-item.ts index dab6b9ffad2f2..6f48620814378 100644 --- a/packages/core-data/src/entity-types/nav-menu-item.ts +++ b/packages/core-data/src/entity-types/records/nav-menu-item.ts @@ -1,9 +1,14 @@ /** * Internal dependencies */ -import { RenderedText, Context, ContextualField, OmitNevers } from './helpers'; +import type { + RenderedText, + Context, + ContextualField, + OmitNevers, +} from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; export type NavMenuItemType = | 'taxonomy' @@ -18,8 +23,8 @@ export type NavMenuItemStatus = | 'private'; export type Target = '_blank' | ''; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface NavMenuItem< C extends Context > { /** * The title for the object. @@ -102,5 +107,5 @@ declare module './base-entity-types' { } export type NavMenuItem< C extends Context > = OmitNevers< - _BaseEntityTypes.NavMenuItem< C > + _BaseEntityRecords.NavMenuItem< C > >; diff --git a/packages/core-data/src/entity-types/nav-menu.ts b/packages/core-data/src/entity-types/records/nav-menu.ts similarity index 79% rename from packages/core-data/src/entity-types/nav-menu.ts rename to packages/core-data/src/entity-types/records/nav-menu.ts index aa3417ddba04b..87de61e3d8d55 100644 --- a/packages/core-data/src/entity-types/nav-menu.ts +++ b/packages/core-data/src/entity-types/records/nav-menu.ts @@ -1,12 +1,12 @@ /** * Internal dependencies */ -import { Context, ContextualField, OmitNevers } from './helpers'; +import type { Context, ContextualField, OmitNevers } from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface NavMenu< C extends Context > { /** * Unique identifier for the term. @@ -49,5 +49,5 @@ declare module './base-entity-types' { } export type NavMenu< C extends Context > = OmitNevers< - _BaseEntityTypes.NavMenu< C > + _BaseEntityRecords.NavMenu< C > >; diff --git a/packages/core-data/src/entity-types/navigation-area.ts b/packages/core-data/src/entity-types/records/navigation-area.ts similarity index 60% rename from packages/core-data/src/entity-types/navigation-area.ts rename to packages/core-data/src/entity-types/records/navigation-area.ts index ed5ae88769207..d8f1c5f365070 100644 --- a/packages/core-data/src/entity-types/navigation-area.ts +++ b/packages/core-data/src/entity-types/records/navigation-area.ts @@ -1,12 +1,12 @@ /** * Internal dependencies */ -import { Context, OmitNevers } from './helpers'; +import type { Context, OmitNevers } from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface NavigationArea< C extends Context > { /** * The name of the navigation area. @@ -25,5 +25,5 @@ declare module './base-entity-types' { } export type NavigationArea< C extends Context > = OmitNevers< - _BaseEntityTypes.NavigationArea< C > + _BaseEntityRecords.NavigationArea< C > >; diff --git a/packages/core-data/src/entity-types/page.ts b/packages/core-data/src/entity-types/records/page.ts similarity index 93% rename from packages/core-data/src/entity-types/page.ts rename to packages/core-data/src/entity-types/records/page.ts index eb95206b8424e..f9b76a0305974 100644 --- a/packages/core-data/src/entity-types/page.ts +++ b/packages/core-data/src/entity-types/records/page.ts @@ -1,7 +1,7 @@ /** * Internal dependencies */ -import { +import type { CommentingStatus, Context, ContextualField, @@ -9,12 +9,12 @@ import { PostStatus, RenderedText, OmitNevers, -} from './helpers'; +} from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface Page< C extends Context > { /** * The date the post was published, in the site's timezone. @@ -140,5 +140,5 @@ declare module './base-entity-types' { } export type Page< C extends Context > = OmitNevers< - _BaseEntityTypes.Page< C > + _BaseEntityRecords.Page< C > >; diff --git a/packages/core-data/src/entity-types/plugin.ts b/packages/core-data/src/entity-types/records/plugin.ts similarity index 82% rename from packages/core-data/src/entity-types/plugin.ts rename to packages/core-data/src/entity-types/records/plugin.ts index 968f71f7a5bb7..139be33d5eac1 100644 --- a/packages/core-data/src/entity-types/plugin.ts +++ b/packages/core-data/src/entity-types/records/plugin.ts @@ -1,12 +1,17 @@ /** * Internal dependencies */ -import { Context, ContextualField, RenderedText, OmitNevers } from './helpers'; +import type { + Context, + ContextualField, + RenderedText, + OmitNevers, +} from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface Plugin< C extends Context > { /** * The plugin file. @@ -70,5 +75,5 @@ declare module './base-entity-types' { export type PluginStatus = 'active' | 'inactive'; export type Plugin< C extends Context > = OmitNevers< - _BaseEntityTypes.Plugin< C > + _BaseEntityRecords.Plugin< C > >; diff --git a/packages/core-data/src/entity-types/post.ts b/packages/core-data/src/entity-types/records/post.ts similarity index 93% rename from packages/core-data/src/entity-types/post.ts rename to packages/core-data/src/entity-types/records/post.ts index 2c7ed4287f183..4b6e1cf1b9399 100644 --- a/packages/core-data/src/entity-types/post.ts +++ b/packages/core-data/src/entity-types/records/post.ts @@ -1,7 +1,7 @@ /** * Internal dependencies */ -import { +import type { CommentingStatus, Context, ContextualField, @@ -10,12 +10,12 @@ import { PostStatus, RenderedText, OmitNevers, -} from './helpers'; +} from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface Post< C extends Context > { /** * The date the post was published, in the site's timezone. @@ -149,5 +149,5 @@ declare module './base-entity-types' { } export type Post< C extends Context > = OmitNevers< - _BaseEntityTypes.Post< C > + _BaseEntityRecords.Post< C > >; diff --git a/packages/core-data/src/entity-types/settings.ts b/packages/core-data/src/entity-types/records/settings.ts similarity index 85% rename from packages/core-data/src/entity-types/settings.ts rename to packages/core-data/src/entity-types/records/settings.ts index 978ce32e9b416..0855827dbd4e1 100644 --- a/packages/core-data/src/entity-types/settings.ts +++ b/packages/core-data/src/entity-types/records/settings.ts @@ -1,12 +1,17 @@ /** * Internal dependencies */ -import { CommentingStatus, Context, OmitNevers, PingStatus } from './helpers'; +import type { + CommentingStatus, + Context, + OmitNevers, + PingStatus, +} from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface Settings< C extends Context > { /** * What to show on the front page @@ -89,5 +94,5 @@ declare module './base-entity-types' { } export type Settings< C extends Context > = OmitNevers< - _BaseEntityTypes.Settings< C > + _BaseEntityRecords.Settings< C > >; diff --git a/packages/core-data/src/entity-types/sidebar.ts b/packages/core-data/src/entity-types/records/sidebar.ts similarity index 81% rename from packages/core-data/src/entity-types/sidebar.ts rename to packages/core-data/src/entity-types/records/sidebar.ts index 7ff4b209ea3ce..bcf681a302451 100644 --- a/packages/core-data/src/entity-types/sidebar.ts +++ b/packages/core-data/src/entity-types/records/sidebar.ts @@ -1,13 +1,13 @@ /** * Internal dependencies */ -import { Widget } from './widget'; -import { Context, OmitNevers } from './helpers'; +import type { Widget } from './widget'; +import type { Context, OmitNevers } from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface Sidebar< C extends Context > { /** * ID of sidebar. @@ -56,5 +56,5 @@ declare module './base-entity-types' { type SidebarStatus = 'active' | 'inactive'; export type Sidebar< C extends Context > = OmitNevers< - _BaseEntityTypes.Sidebar< C > + _BaseEntityRecords.Sidebar< C > >; diff --git a/packages/core-data/src/entity-types/taxonomy.ts b/packages/core-data/src/entity-types/records/taxonomy.ts similarity index 88% rename from packages/core-data/src/entity-types/taxonomy.ts rename to packages/core-data/src/entity-types/records/taxonomy.ts index 120831dbd7acf..9e3b5f9ebecbf 100644 --- a/packages/core-data/src/entity-types/taxonomy.ts +++ b/packages/core-data/src/entity-types/records/taxonomy.ts @@ -1,12 +1,12 @@ /** * Internal dependencies */ -import { Context, ContextualField, OmitNevers } from './helpers'; +import type { Context, ContextualField, OmitNevers } from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface Taxonomy< C extends Context > { /** * All capabilities used by the taxonomy. @@ -88,5 +88,5 @@ declare module './base-entity-types' { } export type Taxonomy< C extends Context > = OmitNevers< - _BaseEntityTypes.Taxonomy< C > + _BaseEntityRecords.Taxonomy< C > >; diff --git a/packages/core-data/src/entity-types/theme.ts b/packages/core-data/src/entity-types/records/theme.ts similarity index 94% rename from packages/core-data/src/entity-types/theme.ts rename to packages/core-data/src/entity-types/records/theme.ts index d3e58fb994861..71c1b77365879 100644 --- a/packages/core-data/src/entity-types/theme.ts +++ b/packages/core-data/src/entity-types/records/theme.ts @@ -1,12 +1,12 @@ /** * Internal dependencies */ -import { Context, PostFormat, RenderedText, OmitNevers } from './helpers'; +import type { Context, PostFormat, RenderedText, OmitNevers } from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface Theme< C extends Context > { /** * The theme's stylesheet. This uniquely identifies the theme. @@ -218,5 +218,5 @@ declare module './base-entity-types' { } export type Theme< C extends Context > = OmitNevers< - _BaseEntityTypes.Theme< C > + _BaseEntityRecords.Theme< C > >; diff --git a/packages/core-data/src/entity-types/type.ts b/packages/core-data/src/entity-types/records/type.ts similarity index 86% rename from packages/core-data/src/entity-types/type.ts rename to packages/core-data/src/entity-types/records/type.ts index 2841559eb1139..c649a0fd1792e 100644 --- a/packages/core-data/src/entity-types/type.ts +++ b/packages/core-data/src/entity-types/records/type.ts @@ -1,12 +1,12 @@ /** * Internal dependencies */ -import { Context, ContextualField, OmitNevers } from './helpers'; +import type { Context, ContextualField, OmitNevers } from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface Type< C extends Context > { /** * All capabilities used by the post type. @@ -76,5 +76,5 @@ declare module './base-entity-types' { } export type Type< C extends Context > = OmitNevers< - _BaseEntityTypes.Type< C > + _BaseEntityRecords.Type< C > >; diff --git a/packages/core-data/src/entity-types/user.ts b/packages/core-data/src/entity-types/records/user.ts similarity index 87% rename from packages/core-data/src/entity-types/user.ts rename to packages/core-data/src/entity-types/records/user.ts index 172d369b44bbb..20c768bafb267 100644 --- a/packages/core-data/src/entity-types/user.ts +++ b/packages/core-data/src/entity-types/records/user.ts @@ -1,12 +1,17 @@ /** * Internal dependencies */ -import { AvatarUrls, Context, ContextualField, OmitNevers } from './helpers'; +import type { + AvatarUrls, + Context, + ContextualField, + OmitNevers, +} from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface User< C extends Context > { /** * Unique identifier for the user. @@ -105,5 +110,5 @@ declare module './base-entity-types' { } export type User< C extends Context > = OmitNevers< - _BaseEntityTypes.User< C > + _BaseEntityRecords.User< C > >; diff --git a/packages/core-data/src/entity-types/widget-type.ts b/packages/core-data/src/entity-types/records/widget-type.ts similarity index 67% rename from packages/core-data/src/entity-types/widget-type.ts rename to packages/core-data/src/entity-types/records/widget-type.ts index 82f65ea493141..cb4ce50f85b52 100644 --- a/packages/core-data/src/entity-types/widget-type.ts +++ b/packages/core-data/src/entity-types/records/widget-type.ts @@ -1,12 +1,12 @@ /** * Internal dependencies */ -import { Context, OmitNevers } from './helpers'; +import type { Context, OmitNevers } from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface WidgetType< C extends Context > { /** * Unique slug identifying the widget type. @@ -33,5 +33,5 @@ declare module './base-entity-types' { } export type WidgetType< C extends Context > = OmitNevers< - _BaseEntityTypes.WidgetType< C > + _BaseEntityRecords.WidgetType< C > >; diff --git a/packages/core-data/src/entity-types/widget.ts b/packages/core-data/src/entity-types/records/widget.ts similarity index 82% rename from packages/core-data/src/entity-types/widget.ts rename to packages/core-data/src/entity-types/records/widget.ts index f1b5a489e9297..95d63df8fb8fd 100644 --- a/packages/core-data/src/entity-types/widget.ts +++ b/packages/core-data/src/entity-types/records/widget.ts @@ -1,12 +1,12 @@ /** * Internal dependencies */ -import { Context, ContextualField, OmitNevers } from './helpers'; +import type { Context, ContextualField, OmitNevers } from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface Widget< C extends Context > { /** * Unique identifier for the widget. @@ -60,5 +60,5 @@ declare module './base-entity-types' { } export type Widget< C extends Context > = OmitNevers< - _BaseEntityTypes.Widget< C > + _BaseEntityRecords.Widget< C > >; diff --git a/packages/core-data/src/entity-types/wp-template-part.ts b/packages/core-data/src/entity-types/records/wp-template-part.ts similarity index 87% rename from packages/core-data/src/entity-types/wp-template-part.ts rename to packages/core-data/src/entity-types/records/wp-template-part.ts index 36fc050900338..6fa91f079ebf9 100644 --- a/packages/core-data/src/entity-types/wp-template-part.ts +++ b/packages/core-data/src/entity-types/records/wp-template-part.ts @@ -1,18 +1,18 @@ /** * Internal dependencies */ -import { +import type { Context, PostStatus, RenderedText, OmitNevers, ContextualField, -} from './helpers'; +} from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface WpTemplatePart< C extends Context > { /** * ID of template. @@ -90,5 +90,5 @@ declare module './base-entity-types' { } export type WpTemplatePart< C extends Context > = OmitNevers< - _BaseEntityTypes.WpTemplatePart< C > + _BaseEntityRecords.WpTemplatePart< C > >; diff --git a/packages/core-data/src/entity-types/wp-template.ts b/packages/core-data/src/entity-types/records/wp-template.ts similarity index 87% rename from packages/core-data/src/entity-types/wp-template.ts rename to packages/core-data/src/entity-types/records/wp-template.ts index 33fa31787792a..37ed2a93bc044 100644 --- a/packages/core-data/src/entity-types/wp-template.ts +++ b/packages/core-data/src/entity-types/records/wp-template.ts @@ -1,18 +1,18 @@ /** * Internal dependencies */ -import { +import type { Context, PostStatus, RenderedText, OmitNevers, ContextualField, -} from './helpers'; +} from '../helpers'; -import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types'; +import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; -declare module './base-entity-types' { - export namespace BaseEntityTypes { +declare module './base-entity-records' { + export namespace BaseEntityRecords { export interface WpTemplate< C extends Context > { /** * ID of template. @@ -90,5 +90,5 @@ declare module './base-entity-types' { } export type WpTemplate< C extends Context > = OmitNevers< - _BaseEntityTypes.WpTemplate< C > + _BaseEntityRecords.WpTemplate< C > >; From 03f2efbf0a3b2381ff7f20c4d80a95f08c4ef22b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Zieli=C5=84ski?= Date: Thu, 10 Mar 2022 11:55:36 +0100 Subject: [PATCH 2/4] Bring the record types back from the records directory to entity-types directory --- .../entity-types/{records => }/attachment.ts | 0 .../{records => }/base-entity-records.ts | 0 .../src/entity-types/{records => }/comment.ts | 0 packages/core-data/src/entity-types/index.ts | 67 +++++++++++++++++- .../{records => }/menu-location.ts | 0 .../{records => }/nav-menu-item.ts | 0 .../entity-types/{records => }/nav-menu.ts | 0 .../{records => }/navigation-area.ts | 0 .../src/entity-types/{records => }/page.ts | 0 .../src/entity-types/{records => }/plugin.ts | 0 .../src/entity-types/{records => }/post.ts | 0 .../src/entity-types/records/index.ts | 70 ------------------- .../entity-types/{records => }/settings.ts | 0 .../src/entity-types/{records => }/sidebar.ts | 0 .../entity-types/{records => }/taxonomy.ts | 0 .../src/entity-types/{records => }/theme.ts | 0 .../src/entity-types/{records => }/type.ts | 0 .../src/entity-types/{records => }/user.ts | 0 .../entity-types/{records => }/widget-type.ts | 0 .../src/entity-types/{records => }/widget.ts | 0 .../{records => }/wp-template-part.ts | 0 .../entity-types/{records => }/wp-template.ts | 0 22 files changed, 66 insertions(+), 71 deletions(-) rename packages/core-data/src/entity-types/{records => }/attachment.ts (100%) rename packages/core-data/src/entity-types/{records => }/base-entity-records.ts (100%) rename packages/core-data/src/entity-types/{records => }/comment.ts (100%) rename packages/core-data/src/entity-types/{records => }/menu-location.ts (100%) rename packages/core-data/src/entity-types/{records => }/nav-menu-item.ts (100%) rename packages/core-data/src/entity-types/{records => }/nav-menu.ts (100%) rename packages/core-data/src/entity-types/{records => }/navigation-area.ts (100%) rename packages/core-data/src/entity-types/{records => }/page.ts (100%) rename packages/core-data/src/entity-types/{records => }/plugin.ts (100%) rename packages/core-data/src/entity-types/{records => }/post.ts (100%) delete mode 100644 packages/core-data/src/entity-types/records/index.ts rename packages/core-data/src/entity-types/{records => }/settings.ts (100%) rename packages/core-data/src/entity-types/{records => }/sidebar.ts (100%) rename packages/core-data/src/entity-types/{records => }/taxonomy.ts (100%) rename packages/core-data/src/entity-types/{records => }/theme.ts (100%) rename packages/core-data/src/entity-types/{records => }/type.ts (100%) rename packages/core-data/src/entity-types/{records => }/user.ts (100%) rename packages/core-data/src/entity-types/{records => }/widget-type.ts (100%) rename packages/core-data/src/entity-types/{records => }/widget.ts (100%) rename packages/core-data/src/entity-types/{records => }/wp-template-part.ts (100%) rename packages/core-data/src/entity-types/{records => }/wp-template.ts (100%) diff --git a/packages/core-data/src/entity-types/records/attachment.ts b/packages/core-data/src/entity-types/attachment.ts similarity index 100% rename from packages/core-data/src/entity-types/records/attachment.ts rename to packages/core-data/src/entity-types/attachment.ts diff --git a/packages/core-data/src/entity-types/records/base-entity-records.ts b/packages/core-data/src/entity-types/base-entity-records.ts similarity index 100% rename from packages/core-data/src/entity-types/records/base-entity-records.ts rename to packages/core-data/src/entity-types/base-entity-records.ts diff --git a/packages/core-data/src/entity-types/records/comment.ts b/packages/core-data/src/entity-types/comment.ts similarity index 100% rename from packages/core-data/src/entity-types/records/comment.ts rename to packages/core-data/src/entity-types/comment.ts diff --git a/packages/core-data/src/entity-types/index.ts b/packages/core-data/src/entity-types/index.ts index 82cff74cbcedb..19416f7b61fa4 100644 --- a/packages/core-data/src/entity-types/index.ts +++ b/packages/core-data/src/entity-types/index.ts @@ -2,4 +2,69 @@ * Internal dependencies */ export type { Context, Updatable } from './helpers'; -export * from './records'; +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 { NavigationArea } from './navigation-area'; +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, + MenuLocation, + NavMenu, + NavMenuItem, + NavigationArea, + Page, + Plugin, + Post, + Settings, + Sidebar, + Taxonomy, + Theme, + User, + Type, + Widget, + WidgetType, + WpTemplate, + WpTemplatePart, +}; + +export type EntityRecord< C extends Context > = + | Attachment< C > + | Comment< C > + | MenuLocation< C > + | NavMenu< C > + | NavMenuItem< C > + | NavigationArea< C > + | Page< C > + | Plugin< C > + | Post< C > + | Settings< C > + | Sidebar< C > + | Taxonomy< C > + | Theme< C > + | Type< C > + | User< C > + | Widget< C > + | WidgetType< C > + | WpTemplate< C > + | WpTemplatePart< C >; + +export type UpdatableEntityRecord = Updatable< EntityRecord< 'edit' > >; diff --git a/packages/core-data/src/entity-types/records/menu-location.ts b/packages/core-data/src/entity-types/menu-location.ts similarity index 100% rename from packages/core-data/src/entity-types/records/menu-location.ts rename to packages/core-data/src/entity-types/menu-location.ts diff --git a/packages/core-data/src/entity-types/records/nav-menu-item.ts b/packages/core-data/src/entity-types/nav-menu-item.ts similarity index 100% rename from packages/core-data/src/entity-types/records/nav-menu-item.ts rename to packages/core-data/src/entity-types/nav-menu-item.ts diff --git a/packages/core-data/src/entity-types/records/nav-menu.ts b/packages/core-data/src/entity-types/nav-menu.ts similarity index 100% rename from packages/core-data/src/entity-types/records/nav-menu.ts rename to packages/core-data/src/entity-types/nav-menu.ts diff --git a/packages/core-data/src/entity-types/records/navigation-area.ts b/packages/core-data/src/entity-types/navigation-area.ts similarity index 100% rename from packages/core-data/src/entity-types/records/navigation-area.ts rename to packages/core-data/src/entity-types/navigation-area.ts diff --git a/packages/core-data/src/entity-types/records/page.ts b/packages/core-data/src/entity-types/page.ts similarity index 100% rename from packages/core-data/src/entity-types/records/page.ts rename to packages/core-data/src/entity-types/page.ts diff --git a/packages/core-data/src/entity-types/records/plugin.ts b/packages/core-data/src/entity-types/plugin.ts similarity index 100% rename from packages/core-data/src/entity-types/records/plugin.ts rename to packages/core-data/src/entity-types/plugin.ts diff --git a/packages/core-data/src/entity-types/records/post.ts b/packages/core-data/src/entity-types/post.ts similarity index 100% rename from packages/core-data/src/entity-types/records/post.ts rename to packages/core-data/src/entity-types/post.ts diff --git a/packages/core-data/src/entity-types/records/index.ts b/packages/core-data/src/entity-types/records/index.ts deleted file mode 100644 index 85ac9d5df73a1..0000000000000 --- a/packages/core-data/src/entity-types/records/index.ts +++ /dev/null @@ -1,70 +0,0 @@ -/** - * Internal dependencies - */ -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 { NavigationArea } from './navigation-area'; -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'; -import type { Context, Updatable } from '../helpers'; - -export type { BaseEntityRecords } from './base-entity-records'; - -export type { - Attachment, - Comment, - MenuLocation, - NavMenu, - NavMenuItem, - NavigationArea, - Page, - Plugin, - Post, - Settings, - Sidebar, - Taxonomy, - Theme, - User, - Type, - Widget, - WidgetType, - WpTemplate, - WpTemplatePart, -}; - -export type EntityRecord< C extends Context > = - | Attachment< C > - | Comment< C > - | MenuLocation< C > - | NavMenu< C > - | NavMenuItem< C > - | NavigationArea< C > - | Page< C > - | Plugin< C > - | Post< C > - | Settings< C > - | Sidebar< C > - | Taxonomy< C > - | Theme< C > - | Type< C > - | User< C > - | Widget< C > - | WidgetType< C > - | WpTemplate< C > - | WpTemplatePart< C >; - -export type UpdatableEntityRecord = Updatable< EntityRecord< 'edit' > >; diff --git a/packages/core-data/src/entity-types/records/settings.ts b/packages/core-data/src/entity-types/settings.ts similarity index 100% rename from packages/core-data/src/entity-types/records/settings.ts rename to packages/core-data/src/entity-types/settings.ts diff --git a/packages/core-data/src/entity-types/records/sidebar.ts b/packages/core-data/src/entity-types/sidebar.ts similarity index 100% rename from packages/core-data/src/entity-types/records/sidebar.ts rename to packages/core-data/src/entity-types/sidebar.ts diff --git a/packages/core-data/src/entity-types/records/taxonomy.ts b/packages/core-data/src/entity-types/taxonomy.ts similarity index 100% rename from packages/core-data/src/entity-types/records/taxonomy.ts rename to packages/core-data/src/entity-types/taxonomy.ts diff --git a/packages/core-data/src/entity-types/records/theme.ts b/packages/core-data/src/entity-types/theme.ts similarity index 100% rename from packages/core-data/src/entity-types/records/theme.ts rename to packages/core-data/src/entity-types/theme.ts diff --git a/packages/core-data/src/entity-types/records/type.ts b/packages/core-data/src/entity-types/type.ts similarity index 100% rename from packages/core-data/src/entity-types/records/type.ts rename to packages/core-data/src/entity-types/type.ts diff --git a/packages/core-data/src/entity-types/records/user.ts b/packages/core-data/src/entity-types/user.ts similarity index 100% rename from packages/core-data/src/entity-types/records/user.ts rename to packages/core-data/src/entity-types/user.ts diff --git a/packages/core-data/src/entity-types/records/widget-type.ts b/packages/core-data/src/entity-types/widget-type.ts similarity index 100% rename from packages/core-data/src/entity-types/records/widget-type.ts rename to packages/core-data/src/entity-types/widget-type.ts diff --git a/packages/core-data/src/entity-types/records/widget.ts b/packages/core-data/src/entity-types/widget.ts similarity index 100% rename from packages/core-data/src/entity-types/records/widget.ts rename to packages/core-data/src/entity-types/widget.ts diff --git a/packages/core-data/src/entity-types/records/wp-template-part.ts b/packages/core-data/src/entity-types/wp-template-part.ts similarity index 100% rename from packages/core-data/src/entity-types/records/wp-template-part.ts rename to packages/core-data/src/entity-types/wp-template-part.ts diff --git a/packages/core-data/src/entity-types/records/wp-template.ts b/packages/core-data/src/entity-types/wp-template.ts similarity index 100% rename from packages/core-data/src/entity-types/records/wp-template.ts rename to packages/core-data/src/entity-types/wp-template.ts From b7241bc6a59c0d5d7f7635e26549e9b175886004 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Zieli=C5=84ski?= Date: Thu, 10 Mar 2022 15:13:51 +0100 Subject: [PATCH 3/4] Replace imports from ../helpers with ./helpers --- docs/reference-guides/data/data-core.md | 1 + packages/core-data/README.md | 1 + packages/core-data/src/entity-types/attachment.ts | 2 +- packages/core-data/src/entity-types/comment.ts | 2 +- packages/core-data/src/entity-types/menu-location.ts | 2 +- packages/core-data/src/entity-types/nav-menu-item.ts | 2 +- packages/core-data/src/entity-types/nav-menu.ts | 2 +- packages/core-data/src/entity-types/navigation-area.ts | 2 +- packages/core-data/src/entity-types/page.ts | 2 +- packages/core-data/src/entity-types/plugin.ts | 2 +- packages/core-data/src/entity-types/post.ts | 2 +- packages/core-data/src/entity-types/settings.ts | 2 +- packages/core-data/src/entity-types/sidebar.ts | 2 +- packages/core-data/src/entity-types/taxonomy.ts | 2 +- packages/core-data/src/entity-types/theme.ts | 2 +- packages/core-data/src/entity-types/type.ts | 2 +- packages/core-data/src/entity-types/user.ts | 2 +- packages/core-data/src/entity-types/widget-type.ts | 2 +- packages/core-data/src/entity-types/widget.ts | 2 +- packages/core-data/src/entity-types/wp-template-part.ts | 2 +- packages/core-data/src/entity-types/wp-template.ts | 2 +- 21 files changed, 21 insertions(+), 19 deletions(-) diff --git a/docs/reference-guides/data/data-core.md b/docs/reference-guides/data/data-core.md index 4d0b64340cd9e..e977d0641fbe9 100644 --- a/docs/reference-guides/data/data-core.md +++ b/docs/reference-guides/data/data-core.md @@ -709,4 +709,5 @@ _Parameters_ Action triggered to undo the last edit to an entity record, if any. + diff --git a/packages/core-data/README.md b/packages/core-data/README.md index 8f63886546c37..b2f59b2e1f6ae 100644 --- a/packages/core-data/README.md +++ b/packages/core-data/README.md @@ -751,6 +751,7 @@ _Returns_ - `boolean`: Whether the entity record is saving or not. + ## Contributing to this package diff --git a/packages/core-data/src/entity-types/attachment.ts b/packages/core-data/src/entity-types/attachment.ts index 1a034ccd4d479..22aceb5a00b86 100644 --- a/packages/core-data/src/entity-types/attachment.ts +++ b/packages/core-data/src/entity-types/attachment.ts @@ -10,7 +10,7 @@ import type { OmitNevers, CommentingStatus, PingStatus, -} from '../helpers'; +} from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/comment.ts b/packages/core-data/src/entity-types/comment.ts index a3f5ce59a7830..70a8fab8bfd61 100644 --- a/packages/core-data/src/entity-types/comment.ts +++ b/packages/core-data/src/entity-types/comment.ts @@ -7,7 +7,7 @@ import type { ContextualField, OmitNevers, RenderedText, -} from '../helpers'; +} from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; export type CommentStatus = 'hold' | 'approve' | 'spam' | 'trash' | '1' | '0'; diff --git a/packages/core-data/src/entity-types/menu-location.ts b/packages/core-data/src/entity-types/menu-location.ts index df3770f14ace0..a7d16067aa7a9 100644 --- a/packages/core-data/src/entity-types/menu-location.ts +++ b/packages/core-data/src/entity-types/menu-location.ts @@ -1,7 +1,7 @@ /** * Internal dependencies */ -import type { Context, OmitNevers } from '../helpers'; +import type { Context, OmitNevers } from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/nav-menu-item.ts b/packages/core-data/src/entity-types/nav-menu-item.ts index 6f48620814378..901eeb78ba4b4 100644 --- a/packages/core-data/src/entity-types/nav-menu-item.ts +++ b/packages/core-data/src/entity-types/nav-menu-item.ts @@ -6,7 +6,7 @@ import type { Context, ContextualField, OmitNevers, -} from '../helpers'; +} from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/nav-menu.ts b/packages/core-data/src/entity-types/nav-menu.ts index 87de61e3d8d55..4bdf84c9cc90f 100644 --- a/packages/core-data/src/entity-types/nav-menu.ts +++ b/packages/core-data/src/entity-types/nav-menu.ts @@ -1,7 +1,7 @@ /** * Internal dependencies */ -import type { Context, ContextualField, OmitNevers } from '../helpers'; +import type { Context, ContextualField, OmitNevers } from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/navigation-area.ts b/packages/core-data/src/entity-types/navigation-area.ts index d8f1c5f365070..06250433f4638 100644 --- a/packages/core-data/src/entity-types/navigation-area.ts +++ b/packages/core-data/src/entity-types/navigation-area.ts @@ -1,7 +1,7 @@ /** * Internal dependencies */ -import type { Context, OmitNevers } from '../helpers'; +import type { Context, OmitNevers } from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/page.ts b/packages/core-data/src/entity-types/page.ts index f9b76a0305974..3240da1ffcda8 100644 --- a/packages/core-data/src/entity-types/page.ts +++ b/packages/core-data/src/entity-types/page.ts @@ -9,7 +9,7 @@ import type { PostStatus, RenderedText, OmitNevers, -} from '../helpers'; +} from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/plugin.ts b/packages/core-data/src/entity-types/plugin.ts index 139be33d5eac1..4d5d92c2b2fe6 100644 --- a/packages/core-data/src/entity-types/plugin.ts +++ b/packages/core-data/src/entity-types/plugin.ts @@ -6,7 +6,7 @@ import type { ContextualField, RenderedText, OmitNevers, -} from '../helpers'; +} from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/post.ts b/packages/core-data/src/entity-types/post.ts index 4b6e1cf1b9399..2308b76cb9264 100644 --- a/packages/core-data/src/entity-types/post.ts +++ b/packages/core-data/src/entity-types/post.ts @@ -10,7 +10,7 @@ import type { PostStatus, RenderedText, OmitNevers, -} from '../helpers'; +} from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/settings.ts b/packages/core-data/src/entity-types/settings.ts index 0855827dbd4e1..ee48198a20803 100644 --- a/packages/core-data/src/entity-types/settings.ts +++ b/packages/core-data/src/entity-types/settings.ts @@ -6,7 +6,7 @@ import type { Context, OmitNevers, PingStatus, -} from '../helpers'; +} from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/sidebar.ts b/packages/core-data/src/entity-types/sidebar.ts index bcf681a302451..cbfceefd901db 100644 --- a/packages/core-data/src/entity-types/sidebar.ts +++ b/packages/core-data/src/entity-types/sidebar.ts @@ -2,7 +2,7 @@ * Internal dependencies */ import type { Widget } from './widget'; -import type { Context, OmitNevers } from '../helpers'; +import type { Context, OmitNevers } from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/taxonomy.ts b/packages/core-data/src/entity-types/taxonomy.ts index 9e3b5f9ebecbf..b2587d0f8deb5 100644 --- a/packages/core-data/src/entity-types/taxonomy.ts +++ b/packages/core-data/src/entity-types/taxonomy.ts @@ -1,7 +1,7 @@ /** * Internal dependencies */ -import type { Context, ContextualField, OmitNevers } from '../helpers'; +import type { Context, ContextualField, OmitNevers } from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/theme.ts b/packages/core-data/src/entity-types/theme.ts index 71c1b77365879..3ff8bdb800999 100644 --- a/packages/core-data/src/entity-types/theme.ts +++ b/packages/core-data/src/entity-types/theme.ts @@ -1,7 +1,7 @@ /** * Internal dependencies */ -import type { Context, PostFormat, RenderedText, OmitNevers } from '../helpers'; +import type { Context, PostFormat, RenderedText, OmitNevers } from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/type.ts b/packages/core-data/src/entity-types/type.ts index c649a0fd1792e..c97c5821f2e4b 100644 --- a/packages/core-data/src/entity-types/type.ts +++ b/packages/core-data/src/entity-types/type.ts @@ -1,7 +1,7 @@ /** * Internal dependencies */ -import type { Context, ContextualField, OmitNevers } from '../helpers'; +import type { Context, ContextualField, OmitNevers } from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/user.ts b/packages/core-data/src/entity-types/user.ts index 20c768bafb267..ddc483fc934a7 100644 --- a/packages/core-data/src/entity-types/user.ts +++ b/packages/core-data/src/entity-types/user.ts @@ -6,7 +6,7 @@ import type { Context, ContextualField, OmitNevers, -} from '../helpers'; +} from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/widget-type.ts b/packages/core-data/src/entity-types/widget-type.ts index cb4ce50f85b52..7f513adab2819 100644 --- a/packages/core-data/src/entity-types/widget-type.ts +++ b/packages/core-data/src/entity-types/widget-type.ts @@ -1,7 +1,7 @@ /** * Internal dependencies */ -import type { Context, OmitNevers } from '../helpers'; +import type { Context, OmitNevers } from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/widget.ts b/packages/core-data/src/entity-types/widget.ts index 95d63df8fb8fd..1c8e2653822a4 100644 --- a/packages/core-data/src/entity-types/widget.ts +++ b/packages/core-data/src/entity-types/widget.ts @@ -1,7 +1,7 @@ /** * Internal dependencies */ -import type { Context, ContextualField, OmitNevers } from '../helpers'; +import type { Context, ContextualField, OmitNevers } from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/wp-template-part.ts b/packages/core-data/src/entity-types/wp-template-part.ts index 6fa91f079ebf9..f569eb2d3cf40 100644 --- a/packages/core-data/src/entity-types/wp-template-part.ts +++ b/packages/core-data/src/entity-types/wp-template-part.ts @@ -7,7 +7,7 @@ import type { RenderedText, OmitNevers, ContextualField, -} from '../helpers'; +} from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; diff --git a/packages/core-data/src/entity-types/wp-template.ts b/packages/core-data/src/entity-types/wp-template.ts index 37ed2a93bc044..a36678fc267a6 100644 --- a/packages/core-data/src/entity-types/wp-template.ts +++ b/packages/core-data/src/entity-types/wp-template.ts @@ -7,7 +7,7 @@ import type { RenderedText, OmitNevers, ContextualField, -} from '../helpers'; +} from './helpers'; import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records'; From f803ae4daf97a52553e6250d09d3cbe29a2fc970 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Zieli=C5=84ski?= Date: Thu, 10 Mar 2022 15:15:40 +0100 Subject: [PATCH 4/4] Remove unnecessary blank line --- docs/reference-guides/data/data-core.md | 1 - packages/core-data/README.md | 1 - 2 files changed, 2 deletions(-) diff --git a/docs/reference-guides/data/data-core.md b/docs/reference-guides/data/data-core.md index e977d0641fbe9..4d0b64340cd9e 100644 --- a/docs/reference-guides/data/data-core.md +++ b/docs/reference-guides/data/data-core.md @@ -709,5 +709,4 @@ _Parameters_ Action triggered to undo the last edit to an entity record, if any. - diff --git a/packages/core-data/README.md b/packages/core-data/README.md index b2f59b2e1f6ae..8f63886546c37 100644 --- a/packages/core-data/README.md +++ b/packages/core-data/README.md @@ -751,7 +751,6 @@ _Returns_ - `boolean`: Whether the entity record is saving or not. - ## Contributing to this package