From 9b5594b28bbbfe0161480adf528a937b99e39be9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Niels=20Lyngs=C3=B8?= <niels.lyngso@gmail.com>
Date: Fri, 17 Nov 2023 08:51:38 +0100
Subject: [PATCH] JSDocs

---
 .../libs/extension-api/types/base.types.ts    | 48 +++++++++----------
 .../types/manifest-kind.interface.ts          | 13 ++++-
 2 files changed, 33 insertions(+), 28 deletions(-)

diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/base.types.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/base.types.ts
index 154c8d7ef8..e17bc203fc 100644
--- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/base.types.ts
+++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/base.types.ts
@@ -1,9 +1,12 @@
-import type { UmbApi } from "../models/index.js";
-import type { ManifestBase } from "./manifest-base.interface.js";
-import type { ApiLoaderProperty, CssLoaderProperty, ElementAndApiLoaderProperty, ElementLoaderProperty, JsLoaderProperty } from "./utils.js";
-
-
-
+import type { UmbApi } from '../models/index.js';
+import type { ManifestBase } from './manifest-base.interface.js';
+import type {
+	ApiLoaderProperty,
+	CssLoaderProperty,
+	ElementAndApiLoaderProperty,
+	ElementLoaderProperty,
+	JsLoaderProperty,
+} from './utils.js';
 
 export interface ManifestWithView<ElementType extends HTMLElement = HTMLElement> extends ManifestElement<ElementType> {
 	meta: MetaManifestWithView;
@@ -23,22 +26,18 @@ export interface ManifestElementWithElementName extends ManifestElement {
 	elementName: string;
 }
 
-
-
-
 export interface ManifestPlainCss<CssType = unknown> extends ManifestBase {
 	/**
 	 * The file location of the stylesheet file to load
-   * @TJS-type string
+	 * @TJS-type string
 	 */
-	css?: CssLoaderProperty<CssType>
+	css?: CssLoaderProperty<CssType>;
 }
 
-
 export interface ManifestPlainJs<JsType> extends ManifestBase {
 	/**
 	 * The file location of the javascript file to load
-   * @TJS-type string
+	 * @TJS-type string
 	 */
 	js?: JsLoaderProperty<JsType>;
 }
@@ -54,18 +53,16 @@ export interface ManifestApi<ApiType extends UmbApi = UmbApi> extends ManifestBa
 
 	/**
 	 * The file location of the javascript file to load
-   * @TJS-type string
+	 * @TJS-type string
 	 */
 	js?: ApiLoaderProperty<ApiType>;
 
 	/**
-	 * @TJS-ignore
+	 * @TJS-type string
 	 */
 	api?: ApiLoaderProperty<ApiType>;
-
 }
 
-
 export interface ManifestElement<ElementType extends HTMLElement = HTMLElement> extends ManifestBase {
 	/**
 	 * @TJS-ignore
@@ -74,13 +71,13 @@ export interface ManifestElement<ElementType extends HTMLElement = HTMLElement>
 
 	/**
 	 * The file location of the javascript file to load
-   * @TJS-type string
+	 * @TJS-type string
 	 */
 	js?: ElementLoaderProperty<ElementType>;
 
 	/**
 	 * The file location of the element javascript file to load
-   * @TJS-type string
+	 * @TJS-type string
 	 */
 	element?: ElementLoaderProperty<ElementType>;
 
@@ -96,7 +93,8 @@ export interface ManifestElement<ElementType extends HTMLElement = HTMLElement>
 	meta?: unknown;
 }
 
-export interface ManifestElementAndApi<ElementType extends HTMLElement = HTMLElement, ApiType extends UmbApi = UmbApi> extends ManifestBase {
+export interface ManifestElementAndApi<ElementType extends HTMLElement = HTMLElement, ApiType extends UmbApi = UmbApi>
+	extends ManifestBase {
 	/**
 	 * @TJS-ignore
 	 */
@@ -106,23 +104,21 @@ export interface ManifestElementAndApi<ElementType extends HTMLElement = HTMLEle
 	 */
 	readonly ELEMENT_TYPE?: ElementType;
 
-
-
 	/**
 	 * The file location of the javascript file to load
-   * @TJS-type string
+	 * @TJS-type string
 	 */
 	js?: ElementAndApiLoaderProperty<ElementType, ApiType>;
 
 	/**
 	 * The file location of the api javascript file to load
-   * @TJS-type string
+	 * @TJS-type string
 	 */
 	api?: ApiLoaderProperty<ApiType>;
 
 	/**
 	 * The file location of the element javascript file to load
-   * @TJS-type string
+	 * @TJS-type string
 	 */
 	element?: ElementLoaderProperty<ElementType>;
 
@@ -131,4 +127,4 @@ export interface ManifestElementAndApi<ElementType extends HTMLElement = HTMLEle
 	 * Note it is NOT <my-dashboard></my-dashboard>, just the element name.
 	 */
 	elementName?: string;
-}
\ No newline at end of file
+}
diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/manifest-kind.interface.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/manifest-kind.interface.ts
index 532e1dea2e..17b1b1fd50 100644
--- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/manifest-kind.interface.ts
+++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/manifest-kind.interface.ts
@@ -1,8 +1,17 @@
-
 export interface ManifestKind<ManifestTypes> {
 	type: 'kind';
 	alias: string;
 	matchType: string;
 	matchKind: string;
+	/**
+	 * Provide pre defined properties for the extension manifest.
+	 * Define the `type`-property and other properties you like to preset for implementations of this kind.
+	 *
+	 * @examples {
+	 *		type: 'section',
+	 *		weight: 123,
+	 *	},
+	 * @TJS-type object
+	 */
 	manifest: Partial<ManifestTypes>;
-}
\ No newline at end of file
+}