Feature: Dynamic global extension manifest map

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 → 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 → 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;

src/packages/block/block-grid/components/block-grid-block-inline/block-grid-block-inline.element.ts

@@ -3,9 +3,9 @@ import { UmbBlockGridInlinePropertyDatasetContext } from './block-grid-inline-pr
 import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
 import { css, customElement, html, property, state } from '@umbraco-cms/backoffice/external/lit';
 import type { UmbPropertyTypeModel } from '@umbraco-cms/backoffice/content-type';
-import type { UmbBlockEditorCustomViewConfiguration } from '@umbraco-cms/backoffice/extension-registry';
 import '../block-grid-areas-container/index.js';
 import '../ref-grid-block/index.js';
+import type { UmbBlockEditorCustomViewConfiguration } from '@umbraco-cms/backoffice/block-custom-view';
 
 /**
  * @element umb-block-grid-block-inline

src/packages/block/block-grid/components/block-grid-block/block-grid-block.element.ts

@@ -1,8 +1,8 @@
 import { UMB_BLOCK_GRID_ENTRY_CONTEXT } from '../../context/block-grid-entry.context-token.js';
 import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
 import { css, customElement, html, property, state } from '@umbraco-cms/backoffice/external/lit';
-import type { UmbBlockEditorCustomViewConfiguration } from '@umbraco-cms/backoffice/extension-registry';
 import type { UmbBlockDataType } from '@umbraco-cms/backoffice/block';
+import type { UmbBlockEditorCustomViewConfiguration } from '@umbraco-cms/backoffice/block-custom-view';
 
 import '@umbraco-cms/backoffice/ufm';
 import '../block-grid-areas-container/index.js';

src/packages/block/block-grid/components/block-grid-entry/block-grid-entry.element.ts

@@ -2,11 +2,7 @@ import { UmbBlockGridEntryContext } from '../../context/block-grid-entry.context
 import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
 import { html, css, customElement, property, state, nothing } from '@umbraco-cms/backoffice/external/lit';
 import type { PropertyValueMap } from '@umbraco-cms/backoffice/external/lit';
-import type {
-	ManifestBlockEditorCustomView,
-	UmbBlockEditorCustomViewProperties,
-	UmbPropertyEditorUiElement,
-} from '@umbraco-cms/backoffice/extension-registry';
+import type { UmbPropertyEditorUiElement } from '@umbraco-cms/backoffice/extension-registry';
 import { stringOrStringArrayContains } from '@umbraco-cms/backoffice/utils';
 import { UMB_BLOCK_GRID, type UmbBlockGridLayoutModel } from '@umbraco-cms/backoffice/block-grid';
 
@@ -15,6 +11,10 @@ import '../block-grid-block/index.js';
 import '../block-scale-handler/index.js';
 import { UmbObserveValidationStateController } from '@umbraco-cms/backoffice/validation';
 import { UmbDataPathBlockElementDataQuery } from '@umbraco-cms/backoffice/block';
+import type {
+	ManifestBlockEditorCustomView,
+	UmbBlockEditorCustomViewProperties,
+} from '@umbraco-cms/backoffice/block-custom-view';
 import { UUIBlinkAnimationValue, UUIBlinkKeyframes } from '@umbraco-cms/backoffice/external/uui';
 import type { UmbExtensionElementInitializer } from '@umbraco-cms/backoffice/extension-api';
 /**

src/packages/block/block-list/components/block-list-entry/block-list-entry.element.ts

@@ -2,16 +2,16 @@ import { UmbBlockListEntryContext } from '../../context/block-list-entry.context
 import { UMB_BLOCK_LIST, type UmbBlockListLayoutModel } from '../../types.js';
 import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
 import { html, css, customElement, property, state, nothing } from '@umbraco-cms/backoffice/external/lit';
-import type {
-	ManifestBlockEditorCustomView,
-	UmbBlockEditorCustomViewProperties,
-	UmbPropertyEditorUiElement,
-} from '@umbraco-cms/backoffice/extension-registry';
+import type { UmbPropertyEditorUiElement } from '@umbraco-cms/backoffice/extension-registry';
 import '../ref-list-block/index.js';
 import '../inline-list-block/index.js';
 import { stringOrStringArrayContains } from '@umbraco-cms/backoffice/utils';
 import { UmbObserveValidationStateController } from '@umbraco-cms/backoffice/validation';
 import { UmbDataPathBlockElementDataQuery } from '@umbraco-cms/backoffice/block';
+import type {
+	ManifestBlockEditorCustomView,
+	UmbBlockEditorCustomViewProperties,
+} from '@umbraco-cms/backoffice/block-custom-view';
 
 /**
  * @element umb-block-list-entry

src/packages/block/block-list/property-editors/block-list-editor/property-editor-ui-block-list.element.ts

@@ -6,7 +6,7 @@ import { UMB_BLOCK_LIST_PROPERTY_EDITOR_ALIAS } from './manifests.js';
 import { UmbLitElement, umbDestroyOnDisconnect } from '@umbraco-cms/backoffice/lit-element';
 import { html, customElement, property, state, repeat, css, nothing } from '@umbraco-cms/backoffice/external/lit';
 import { UmbTextStyles } from '@umbraco-cms/backoffice/style';
-import type { UmbPropertyEditorUiElement, UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/extension-registry';
+import type { UmbPropertyEditorUiElement } from '@umbraco-cms/backoffice/extension-registry';
 import {
 	UmbPropertyValueChangeEvent,
 	type UmbPropertyEditorConfigCollection,
@@ -19,6 +19,7 @@ import {
 	UmbBlockElementDataValidationPathTranslator,
 	type UmbBlockLayoutBaseModel,
 } from '@umbraco-cms/backoffice/block';
+import type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/block-type';
 
 import '../../components/block-list-entry/index.js';
 import { UMB_PROPERTY_CONTEXT } from '@umbraco-cms/backoffice/property';

src/packages/block/block-list/property-editors/block-list-type-configuration/property-editor-ui-block-list-type-configuration.element.ts

@@ -1,7 +1,7 @@
 import '../../../block-type/components/input-block-type/index.js';
-import type { UmbInputBlockTypeElement } from '../../../block-type/index.js';
 import { UMB_BLOCK_LIST_TYPE } from '../../types.js';
-import type { UmbBlockTypeBaseModel, UmbPropertyEditorUiElement } from '@umbraco-cms/backoffice/extension-registry';
+import type { UmbBlockTypeBaseModel, UmbInputBlockTypeElement } from '@umbraco-cms/backoffice/block-type';
+import type { UmbPropertyEditorUiElement } from '@umbraco-cms/backoffice/extension-registry';
 import { html, customElement, property, state } from '@umbraco-cms/backoffice/external/lit';
 import {
 	UmbPropertyValueChangeEvent,

src/packages/block/block-list/types.ts

@@ -1,5 +1,5 @@
-import type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/extension-registry';
 import type { UmbBlockLayoutBaseModel, UmbBlockValueType } from '@umbraco-cms/backoffice/block';
+import type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/block-type';
 
 export const UMB_BLOCK_LIST_TYPE = 'block-list-type';
 export const UMB_BLOCK_LIST = 'block-list';

src/packages/block/block-rte/components/block-rte-entry/block-rte-entry.element.ts

@@ -2,11 +2,9 @@ import type { UmbBlockRteLayoutModel } from '../../types.js';
 import { UmbBlockRteEntryContext } from '../../context/block-rte-entry.context.js';
 import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
 import { html, css, property, state, customElement } from '@umbraco-cms/backoffice/external/lit';
-import type {
-	UmbBlockEditorCustomViewProperties,
-	UmbPropertyEditorUiElement,
-} from '@umbraco-cms/backoffice/extension-registry';
+import type { UmbPropertyEditorUiElement } from '@umbraco-cms/backoffice/extension-registry';
 import { UmbTextStyles } from '@umbraco-cms/backoffice/style';
+import type { UmbBlockEditorCustomViewProperties } from '@umbraco-cms/backoffice/block-custom-view';
 
 import '../ref-rte-block/index.js';
 

src/packages/block/block-rte/tiny-mce-plugin/tiny-mce-block-picker.plugin.ts

@@ -2,7 +2,7 @@ import { UMB_BLOCK_RTE_MANAGER_CONTEXT } from '../context/block-rte-manager.cont
 import { UMB_BLOCK_RTE_ENTRIES_CONTEXT } from '../context/block-rte-entries.context-token.js';
 import { type TinyMcePluginArguments, UmbTinyMcePluginBase } from '@umbraco-cms/backoffice/tiny-mce';
 import { UmbLocalizationController } from '@umbraco-cms/backoffice/localization-api';
-import type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/extension-registry';
+import type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/block-type';
 
 export default class UmbTinyMceMultiUrlPickerPlugin extends UmbTinyMcePluginBase {
 	#localize = new UmbLocalizationController(this._host);

src/packages/block/block-rte/types.ts

@@ -1,4 +1,4 @@
-import type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/extension-registry';
+import type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/block-type';
 import type { UmbBlockLayoutBaseModel, UmbBlockValueType } from '@umbraco-cms/backoffice/block';
 
 export const UMB_BLOCK_RTE_TYPE = 'block-rte-type';

src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts

@@ -2,11 +2,12 @@ import { UMB_MANIFEST_VIEWER_MODAL } from '../../../modals/manifest-viewer/index
 import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
 import { html, customElement, state, property, css } from '@umbraco-cms/backoffice/external/lit';
 import { UMB_PROPERTY_DATASET_CONTEXT } from '@umbraco-cms/backoffice/property';
-import { umbExtensionsRegistry, type ManifestBlockEditorCustomView } from '@umbraco-cms/backoffice/extension-registry';
+import { umbExtensionsRegistry } from '@umbraco-cms/backoffice/extension-registry';
 import { stringOrStringArrayContains } from '@umbraco-cms/backoffice/utils';
 import { UmbExtensionsManifestInitializer } from '@umbraco-cms/backoffice/extension-api';
 import { UmbDocumentTypeDetailRepository } from '@umbraco-cms/backoffice/document-type';
 import { UMB_MODAL_MANAGER_CONTEXT } from '@umbraco-cms/backoffice/modal';
+import type { ManifestBlockEditorCustomView } from '@umbraco-cms/backoffice/block-custom-view';
 
 @customElement('umb-block-type-custom-view-guide')
 export class UmbBlockTypeCustomViewGuideElement extends UmbLitElement {
@@ -88,7 +89,7 @@ export class UmbBlockTypeCustomViewGuideElement extends UmbLitElement {
 	async #generateManifest() {
 		const modalManager = await this.getContext(UMB_MODAL_MANAGER_CONTEXT);
 
-		const manifest = {
+		const manifest: UmbExtensionManifest = {
 			type: 'blockEditorCustomView',
 			alias: 'Local.blockEditorCustomView.' + this.#contentTypeAlias,
 			name: 'Block Editor Custom View for ' + this.#contentTypeName,

src/packages/block/block-type/components/input-block-type/input-block-type.element.ts

@@ -12,7 +12,7 @@ import {
 	UMB_DOCUMENT_TYPE_PICKER_MODAL,
 } from '@umbraco-cms/backoffice/document-type';
 import { UmbSorterController } from '@umbraco-cms/backoffice/sorter';
-import type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/extension-registry';
+import type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/block-type';
 
 import '../block-type-card/index.js';
 

src/packages/block/block-type/types.ts

@@ -1,6 +1,16 @@
-import type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/extension-registry';
-export type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/extension-registry';
+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;
+}
 export interface UmbBlockTypeGroup {
 	name?: string;
 	key: string;

src/packages/block/block-type/workspace/block-type-workspace.context.ts

@@ -1,4 +1,4 @@
-import type { UmbBlockTypeWithGroupKey } from '../types.js';
+import type { UmbBlockTypeBaseModel, UmbBlockTypeWithGroupKey } from '../types.js';
 import { UmbBlockTypeWorkspaceEditorElement } from './block-type-workspace-editor.element.js';
 import type { UmbPropertyDatasetContext } from '@umbraco-cms/backoffice/property';
 import { UMB_PROPERTY_CONTEXT } from '@umbraco-cms/backoffice/property';
@@ -13,7 +13,7 @@ import {
 } from '@umbraco-cms/backoffice/workspace';
 import { UmbObjectState, appendToFrozenArray } from '@umbraco-cms/backoffice/observable-api';
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
-import type { ManifestWorkspace, UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/extension-registry';
+import type { ManifestWorkspace } from '@umbraco-cms/backoffice/extension-registry';
 
 export class UmbBlockTypeWorkspaceContext<BlockTypeData extends UmbBlockTypeWithGroupKey = UmbBlockTypeWithGroupKey>
 	extends UmbSubmittableWorkspaceContextBase<BlockTypeData>

src/packages/block/block/context/block-entries.context-token.ts

@@ -3,7 +3,7 @@ import type { UmbBlockWorkspaceOriginData } from '../workspace/block-workspace.m
 import type { UmbBlockEntriesContext } from './block-entries.context.js';
 import type { UMB_BLOCK_MANAGER_CONTEXT } from './block-manager.context-token.js';
 import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
-import type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/extension-registry';
+import type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/block-type';
 
 export const UMB_BLOCK_ENTRIES_CONTEXT = new UmbContextToken<
 	UmbBlockEntriesContext<

src/packages/block/block/context/block-entries.context.ts

@@ -4,10 +4,10 @@ import type { UmbBlockDataObjectModel, UmbBlockManagerContext } from './block-ma
 import { UMB_BLOCK_ENTRIES_CONTEXT } from './block-entries.context-token.js';
 import { type Observable, UmbArrayState, UmbBasicState, UmbStringState } from '@umbraco-cms/backoffice/observable-api';
 import { UmbContextBase } from '@umbraco-cms/backoffice/class-api';
-import type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/extension-registry';
 import type { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
 import type { UmbModalRouteBuilder } from '@umbraco-cms/backoffice/router';
+import type { UmbBlockTypeBaseModel } from '@umbraco-cms/backoffice/block-type';
 
 export abstract class UmbBlockEntriesContext<
 	BlockManagerContextTokenType extends UmbContextToken<BlockManagerContextType, BlockManagerContextType>,