docs(core): Add documentation to entity interfaces

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

@@ -7,28 +7,44 @@ import { Tag } from '../../entity/tag/tag.entity';
 import { LocaleString } from './locale-types';
 
 /**
+ * @description
  * Entities which can be assigned to Channels should implement this interface.
+ *
+ * @docsCategory entities
+ * @docsPage interfaces
  */
 export interface ChannelAware {
     channels: Channel[];
 }
 
 /**
+ * @description
  * Entities which can be soft deleted should implement this interface.
+ *
+ * @docsCategory entities
+ * @docsPage interfaces
  */
 export interface SoftDeletable {
     deletedAt: Date | null;
 }
 
 /**
+ * @description
  * Entities which can be ordered relative to their siblings in a list.
+ *
+ * @docsCategory entities
+ * @docsPage interfaces
  */
 export interface Orderable {
     position: number;
 }
 
 /**
+ * @description
  * Entities which can have Tags applied to them.
+ *
+ * @docsCategory entities
+ * @docsPage interfaces
  */
 export interface Taggable {
     tags: Tag[];

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

@@ -20,9 +20,15 @@ export type NonTranslateableKeys<T> = { [K in keyof T]: T[K] extends LocaleStrin
 
 // prettier-ignore
 /**
+ * @description
  * Entities which have localizable string properties should implement this type.
+ *
+ * @docsCategory entities
+ * @docsPage interfaces
  */
-export interface Translatable { translations: Array<Translation<VendureEntity>>; }
+export interface Translatable {
+    translations: Array<Translation<VendureEntity>>;
+}
 
 export type TranslationCustomFields<T> = { [K in keyof T]: K extends 'customFields' ? K : never }[keyof T];
 
@@ -31,7 +37,7 @@ export type TranslationCustomFields<T> = { [K in keyof T]: K extends 'customFiel
  * Translations of localizable entities should implement this type.
  */
 export type Translation<T> =
-    // Translation must include the languageCode and a reference to the base Translatable entity it is associated with
+// Translation must include the languageCode and a reference to the base Translatable entity it is associated with
     {
         id: ID;
         languageCode: LanguageCode;
@@ -61,6 +67,6 @@ export interface TranslatedInput<T> {
 /**
  * This is the type of a Translatable entity after it has been deep-translated into a given language.
  */
-export type Translated<T> =  T & { languageCode: LanguageCode; } & {
+export type Translated<T> = T & { languageCode: LanguageCode; } & {
     [K in TranslatableRelationsKeys<T>]: T[K] extends any[] ? Array<Translated<UnwrappedArray<T[K]>>> : Translated<T[K]>;
 };