Merge pull request #2249 from umbraco/v14/feature/POC-dynamic-global-manifest-types

POC: feature dynamic global manifest types

Author: nielslyngsoe

examples/block-custom-view/block-custom-view.ts

@@ -1,7 +1,8 @@
 import { UmbTextStyles } from '@umbraco-cms/backoffice/style';
 import { html, customElement, LitElement, property, css } from '@umbraco-cms/backoffice/external/lit';
 import { UmbElementMixin } from '@umbraco-cms/backoffice/element-api';
-import type { UmbBlockDataType, UmbBlockEditorCustomViewElement } from '@umbraco-cms/backoffice/extension-registry';
+import type { UmbBlockDataType } from '@umbraco-cms/backoffice/block';
+import type { UmbBlockEditorCustomViewElement } from '@umbraco-cms/backoffice/block-custom-view';
 
 // eslint-disable-next-line local-rules/enforce-umb-prefix-on-element-name
 @customElement('example-block-custom-view')

examples/block-custom-view/index.ts

@@ -1,6 +1,4 @@
-import type { ManifestBlockEditorCustomView } from '@umbraco-cms/backoffice/extension-registry';
-
-export const manifests: Array<ManifestBlockEditorCustomView> = [
+export const manifests: Array<UmbExtensionManifest> = [
 	{
 		type: 'blockEditorCustomView',
 		alias: 'Umb.blockEditorCustomView.TestView',

package.json

@@ -17,6 +17,7 @@
 		"./action": "./dist-cms/packages/core/action/index.js",
 		"./audit-log": "./dist-cms/packages/core/audit-log/index.js",
 		"./auth": "./dist-cms/packages/core/auth/index.js",
+		"./block-custom-view": "./dist-cms/packages/block/block-custom-view/index.js",
 		"./block-grid": "./dist-cms/packages/block/block-grid/index.js",
 		"./block-list": "./dist-cms/packages/block/block-list/index.js",
 		"./block-rte": "./dist-cms/packages/block/block-rte/index.js",

src/libs/extension-api/models/extension-api.interface.ts

@@ -0,0 +1,9 @@
+import type { ManifestBase } from '../types/index.js';
+import type { UmbApi } from './api.interface.js';
+
+/**
+ * Interface for APIs of a Extension.
+ */
+export interface UmbExtensionApi<ManifestType extends ManifestBase = ManifestBase> extends UmbApi {
+	manifest?: ManifestType;
+}

src/libs/extension-api/models/index.ts

@@ -1,2 +1,3 @@
 export * from './entry-point.interface.js';
 export * from './api.interface.js';
+export * from './extension-api.interface.js';

src/libs/extension-api/registry/extension.registry.ts

@@ -11,8 +11,9 @@ import { map, distinctUntilChanged, combineLatest, of, switchMap } from '@umbrac
 
 /**
  *
- * @param previousValue
- * @param currentValue
+ * @param previousValue {Array<ManifestBase>} - previous value
+ * @param currentValue {Array<ManifestBase>} - current value
+ * @returns {boolean} - true if value is assumed to be the same as previous value.
  */
 function extensionArrayMemoization<T extends Pick<ManifestBase, 'alias'>>(
 	previousValue: Array<T>,
@@ -31,8 +32,9 @@ function extensionArrayMemoization<T extends Pick<ManifestBase, 'alias'>>(
 
 /**
  *
- * @param previousValue
- * @param currentValue
+ * @param previousValue {Array<ManifestBase>} - previous value
+ * @param currentValue {Array<ManifestBase>} - current value
+ * @returns {boolean} - true if value is assumed to be the same as previous value.
  */
 function extensionAndKindMatchArrayMemoization<
 	T extends Pick<ManifestBase, 'alias'> & { __isMatchedWithKind?: boolean },
@@ -62,8 +64,9 @@ function extensionAndKindMatchArrayMemoization<
 
 /**
  *
- * @param previousValue
- * @param currentValue
+ * @param previousValue {Array<ManifestBase>} - previous value
+ * @param currentValue {Array<ManifestBase>} - current value
+ * @returns {boolean} - true if value is assumed to be the same as previous value.
  */
 function extensionSingleMemoization<T extends Pick<ManifestBase, 'alias'>>(
 	previousValue: T | undefined,
@@ -77,8 +80,9 @@ function extensionSingleMemoization<T extends Pick<ManifestBase, 'alias'>>(
 
 /**
  *
- * @param previousValue
- * @param currentValue
+ * @param previousValue {Array<ManifestBase>} - previous value
+ * @param currentValue {Array<ManifestBase>} - current value
+ * @returns {boolean} - true if value is assumed to be the same as previous value.
  */
 function extensionAndKindMatchSingleMemoization<
 	T extends Pick<ManifestBase, 'alias'> & { __isMatchedWithKind?: boolean },

src/libs/extension-api/types/manifest-bundle.interface.ts

@@ -4,7 +4,7 @@ import type { ManifestBase } from './manifest-base.interface.js';
 /**
  * This type of extension takes a JS module and registers all exported manifests from the pointed JS file.
  */
-export interface ManifestBundle<UmbManifestTypes extends ManifestBase = ManifestBase>
-	extends ManifestPlainJs<{ [key: string]: Array<UmbManifestTypes> }> {
+export interface ManifestBundle<ManifestTypes extends ManifestBase = ManifestBase>
+	extends ManifestPlainJs<{ [key: string]: Array<ManifestTypes> }> {
 	type: 'bundle';
 }

src/packages/core/extension-registry/models/block-editor-custom-view.model.ts renamed to src/packages/block/block-custom-view/block-editor-custom-view.extension.ts

@@ -1,20 +1,26 @@
-import type { UmbBlockEditorCustomViewElement } from '../interfaces/index.js';
+import type { UmbBlockEditorCustomViewElement } from './types.js';
 import type { ManifestElement } from '@umbraco-cms/backoffice/extension-api';
 
 export interface ManifestBlockEditorCustomView extends ManifestElement<UmbBlockEditorCustomViewElement> {
 	type: 'blockEditorCustomView';
 	/**
-	 * @property {string | Array<string> } - Declare if this Custom View only must appear at specific Content Types by Alias.
+	 * @property {string | Array<string> } forContentTypeAlias - Declare if this Custom View only must appear at specific Content Types by Alias.
 	 * @description Optional condition if you like this custom view to only appear at for one or more specific Content Types.
 	 * @example 'my-element-type-alias'
 	 * @example ['my-element-type-alias-A', 'my-element-type-alias-B']
 	 */
 	forContentTypeAlias?: string | Array<string>;
 	/**
-	 * @property {string | Array<string> } - Declare if this Custom View only must appear at specific Block Editors.
+	 * @property {string | Array<string> } forBlockEditor - Declare if this Custom View only must appear at specific Block Editors.
 	 * @description Optional condition if you like this custom view to only appear at a specific type of Block Editor.
 	 * @example 'block-list'
 	 * @example ['block-list', 'block-grid']
 	 */
 	forBlockEditor?: string | Array<string>;
 }
+
+declare global {
+	interface UmbExtensionManifestMap {
+		blockEditorCustomView: ManifestBlockEditorCustomView;
+	}
+}

src/packages/block/block-custom-view/index.ts

@@ -0,0 +1 @@
+export type * from './types.js';

src/packages/core/extension-registry/interfaces/block-editor-custom-view-element.interface.ts renamed to src/packages/block/block-custom-view/types.ts

@@ -1,29 +1,8 @@
-import type { ManifestBlockEditorCustomView } from '../index.js';
-import type { UUIModalSidebarSize } from '@umbraco-cms/backoffice/external/uui';
-// Shared with the Property Editor
-export interface UmbBlockTypeBaseModel {
-	contentElementTypeKey: string;
-	settingsElementTypeKey?: string;
-	label?: string;
-	thumbnail?: string;
-	iconColor?: string;
-	backgroundColor?: string;
-	editorSize?: UUIModalSidebarSize;
-	forceHideContentEditorInOverlay: boolean;
-}
+import type { ManifestBlockEditorCustomView } from './block-editor-custom-view.extension.js';
+import type { UmbBlockLayoutBaseModel, UmbBlockDataType } from '@umbraco-cms/backoffice/block';
+import type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/block-type';
 
-// Shared with the Property Editor
-export interface UmbBlockLayoutBaseModel {
-	contentUdi: string;
-	settingsUdi?: string | null;
-}
-
-// Shared with the Property Editor
-export interface UmbBlockDataType {
-	udi: string;
-	contentTypeKey: string;
-	[key: string]: unknown;
-}
+export type * from './block-editor-custom-view.extension.js';
 
 export interface UmbBlockEditorCustomViewConfiguration {
 	editContentPath?: string;