Simplify the TS-based lookups

WordPress · Feb 28, 2022 · b9eb573 · b9eb573
1 parent c22383e
commit b9eb573
Show file tree

Hide file tree

Showing 24 changed files with 562 additions and 423 deletions.
diff --git a/packages/core-data/src/entities.ts b/packages/core-data/src/entities.ts
diff --git a/packages/core-data/src/types/attachment.ts b/packages/core-data/src/types/attachment.ts
@@ -12,10 +12,10 @@ import {
 	PingStatus,
 } from './helpers';
 
-import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+import { 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/.../core-data/src/types/base-entity-types.ts → ...ore-data/src/types/base-entity-records.ts b/.../core-data/src/types/base-entity-types.ts → ...ore-data/src/types/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/types/comment.ts b/packages/core-data/src/types/comment.ts
@@ -8,12 +8,12 @@ import {
 	OmitNevers,
 	RenderedText,
 } from './helpers';
-import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+import { 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/types/configure.ts b/packages/core-data/src/types/configure.ts
diff --git a/packages/core-data/src/types/helpers.ts b/packages/core-data/src/types/helpers.ts
@@ -1,7 +1,7 @@
 /**
  * Internal dependencies
  */
-import { CoreEntityRecord } from './index';
+import { EntityRecord } from './index';
 
 export interface AvatarUrls {
 	/**
@@ -148,6 +148,35 @@ export interface RenderedText< C extends Context > {
  * // updatablePost.title is a string
  * ```
  */
-export type Updatable< T extends CoreEntityRecord< 'edit' > > = {
+export type Updatable< T extends EntityRecord< 'edit' > > = {
 	[ K in keyof T ]: T[ K ] extends RenderedText< any > ? string : T[ K ];
 };
+
+/**
+ * TODO Docstring
+ */
+export type EntityFromConfig<
+	E extends {
+		kind: string;
+		name: string;
+		key?: string;
+		baseURLParams?: EntityQuery< any >;
+	},
+	R
+> = {
+	kind: E[ 'kind' ];
+	name: E[ 'name' ];
+	recordType: R;
+	key: E[ 'key' ] extends string ? E[ 'key' ] : 'id';
+	defaultContext: E[ 'baseURLParams' ] extends EntityQuery< infer C >
+		? C
+		: 'view';
+};
+
+/**
+ * TODO Docstring
+ */
+export type EntityQuery< C extends Context > = {
+	[ key: string ]: string;
+	context?: C;
+};