Merge pull request #2362 from umbraco/v15/feature/emm-core-types

nielslyngsoe · web-flow · commit 9ead5e463d89 · 2024-09-30T11:09:53.000+02:00
Extension Manifest Map: core types
diff --git a/src/packages/core/entity-bulk-action/types.ts b/src/packages/core/entity-bulk-action/types.ts
@@ -1,4 +1,4 @@
-import type { MetaEntityBulkAction } from '../extension-registry/models/entity-bulk-action.model.js';
+import type { MetaEntityBulkAction } from '../extension-registry/extensions/entity-bulk-action.extension.js';
 
 export interface UmbEntityBulkActionArgs<MetaArgsType extends MetaEntityBulkAction> {
 	entityType: string;
diff --git a/src/packages/core/extension-registry/extensions/app-entry-point.extension.ts b/src/packages/core/extension-registry/extensions/app-entry-point.extension.ts
@@ -10,3 +10,9 @@ import type { ManifestPlainJs, UmbEntryPointModule } from '@umbraco-cms/backoffi
 export interface ManifestAppEntryPoint extends ManifestPlainJs<UmbEntryPointModule> {
 	type: 'appEntryPoint';
 }
+
+declare global {
+	interface UmbExtensionManifestMap {
+		UmbGlobalAppEntryPointExtension: ManifestAppEntryPoint;
+	}
+}
diff --git a/src/packages/core/extension-registry/extensions/backoffice-entry-point.extension.ts b/src/packages/core/extension-registry/extensions/backoffice-entry-point.extension.ts
@@ -9,3 +9,9 @@ import type { ManifestPlainJs, UmbEntryPointModule } from '@umbraco-cms/backoffi
 export interface ManifestBackofficeEntryPoint extends ManifestPlainJs<UmbEntryPointModule> {
 	type: 'backofficeEntryPoint';
 }
+
+declare global {
+	interface UmbExtensionManifestMap {
+		UmbGlobalBackofficeEntryPointExtension: ManifestBackofficeEntryPoint;
+	}
+}
diff --git a/src/packages/core/extension-registry/extensions/entity-action.extension.ts b/src/packages/core/extension-registry/extensions/entity-action.extension.ts
@@ -176,3 +176,30 @@ export interface MetaEntityActionSortChildrenOfKind extends MetaEntityActionDefa
 	sortChildrenOfRepositoryAlias: string;
 	treeRepositoryAlias: string;
 }
+
+export type UmbEntityActionExtensions =
+	| ManifestEntityAction
+	| ManifestEntityActionCreateFolderKind
+	| ManifestEntityActionDefaultKind
+	| ManifestEntityActionDeleteFolderKind
+	| ManifestEntityActionDeleteKind
+	| ManifestEntityActionDuplicateToKind
+	| ManifestEntityActionEmptyRecycleBinKind
+	| ManifestEntityActionMoveToKind
+	| ManifestEntityActionReloadTreeItemChildrenKind
+	| ManifestEntityActionRenameServerFileKind
+	| ManifestEntityActionRestoreFromRecycleBinKind
+	| ManifestEntityActionSortChildrenOfKind
+	| ManifestEntityActionTrashKind
+	| ManifestEntityActionUpdateFolderKind;
+
+/**
+ * @deprecated use `UmbEntityActionExtensions` instead.
+ */
+export type ManifestEntityActions = UmbEntityActionExtensions;
+
+declare global {
+	interface UmbExtensionManifestMap {
+		UmbEntityActionExtensions: UmbEntityActionExtensions;
+	}
+}
diff --git a/src/packages/core/extension-registry/extensions/entity-bulk-action.extension.ts b/src/packages/core/extension-registry/extensions/entity-bulk-action.extension.ts
@@ -78,3 +78,16 @@ export interface ManifestEntityBulkActionTrashKind extends ManifestEntityBulkAct
 export interface MetaEntityBulkActionTrashKind extends MetaEntityBulkActionDefaultKind {
 	bulkTrashRepositoryAlias: string;
 }
+
+export type UmbEntityBulkActionExtensions =
+	| ManifestEntityBulkAction
+	| ManifestEntityBulkActionDefaultKind
+	| ManifestEntityBulkActionDuplicateToKind
+	| ManifestEntityBulkActionMoveToKind
+	| ManifestEntityBulkActionTrashKind;
+
+declare global {
+	interface UmbExtensionManifestMap {
+		UmbEntityBulkActionExtensions: UmbEntityBulkActionExtensions;
+	}
+}
diff --git a/src/packages/core/extension-registry/extensions/entity-user-permission.extension.ts b/src/packages/core/extension-registry/extensions/entity-user-permission.extension.ts
@@ -12,3 +12,9 @@ export interface MetaEntityUserPermission {
 	description?: string;
 	group?: string;
 }
+
+declare global {
+	interface UmbExtensionManifestMap {
+		UmbEntityUserPermissionExtension: ManifestEntityUserPermission;
+	}
+}
diff --git a/src/packages/core/extension-registry/extensions/entry-point.extension.ts b/src/packages/core/extension-registry/extensions/entry-point.extension.ts
@@ -10,3 +10,9 @@ import type { ManifestPlainJs, UmbEntryPointModule } from '@umbraco-cms/backoffi
 export interface ManifestEntryPoint extends ManifestPlainJs<UmbEntryPointModule> {
 	type: 'entryPoint';
 }
+
+declare global {
+	interface UmbExtensionManifestMap {
+		UmbEntryPointExtension: ManifestEntryPoint;
+	}
+}
diff --git a/src/packages/core/extension-registry/extensions/global-context.extension.ts b/src/packages/core/extension-registry/extensions/global-context.extension.ts
@@ -3,3 +3,9 @@ import type { ManifestApi } from '@umbraco-cms/backoffice/extension-api';
 export interface ManifestGlobalContext extends ManifestApi {
 	type: 'globalContext';
 }
+
+declare global {
+	interface UmbExtensionManifestMap {
+		UmbGlobalContextExtension: ManifestGlobalContext;
+	}
+}
diff --git a/src/packages/core/extension-registry/extensions/header-app.extension.ts b/src/packages/core/extension-registry/extensions/header-app.extension.ts
@@ -9,13 +9,6 @@ export interface ManifestHeaderApp extends ManifestElement {
 	//meta: MetaHeaderApp;
 }
 
-// TODO: Warren these don't seem to be used anywhere
-export interface MetaHeaderApp {
-	pathname: string;
-	label: string;
-	icon: string;
-}
-
 export interface ManifestHeaderAppButtonKind extends ManifestHeaderApp {
 	type: 'headerApp';
 	kind: 'button';
@@ -27,3 +20,9 @@ export interface MetaHeaderAppButtonKind {
 	label: string;
 	icon: string;
 }
+
+declare global {
+	interface UmbExtensionManifestMap {
+		UmbHeaderAppExtension: ManifestHeaderApp | ManifestHeaderAppButtonKind;
+	}
+}
diff --git a/src/packages/core/extension-registry/extensions/index.ts b/src/packages/core/extension-registry/extensions/index.ts
@@ -0,0 +1,13 @@
+export type * from './global-context.extension.js';
+export type * from './header-app.extension.js';
+export type * from './repository.extension.js';
+export type * from './app-entry-point.extension.js';
+export type * from './entity-action.extension.js';
+export type * from './backoffice-entry-point.extension.js';
+export type * from './entity-bulk-action.extension.js';
+export type * from './entity-user-permission.extension.js';
+export type * from './entry-point.extension.js';
+export type * from './menu-item.extension.js';
+export type * from './menu.extension.js';
+export type * from './preview-app.extension.js';
+export type * from './store.extension.js';
diff --git a/src/packages/core/extension-registry/extensions/menu-item.extension.ts b/src/packages/core/extension-registry/extensions/menu-item.extension.ts
@@ -35,3 +35,11 @@ export interface ManifestMenuItemLinkKind extends ManifestMenuItem {
 export interface MetaMenuItemLinkKind extends MetaMenuItem {
 	href: string;
 }
+
+export type UmbMenuItemExtensions = ManifestMenuItem | ManifestMenuItemTreeKind | ManifestMenuItemLinkKind;
+
+declare global {
+	interface UmbExtensionManifestMap {
+		UmbMenuItemExtensions: UmbMenuItemExtensions;
+	}
+}
diff --git a/src/packages/core/extension-registry/extensions/menu.extension.ts b/src/packages/core/extension-registry/extensions/menu.extension.ts
@@ -3,3 +3,9 @@ import type { ManifestElement } from '@umbraco-cms/backoffice/extension-api';
 export interface ManifestMenu extends ManifestElement {
 	type: 'menu';
 }
+
+declare global {
+	interface UmbExtensionManifestMap {
+		UmbMenuExtension: ManifestMenu;
+	}
+}
diff --git a/src/packages/core/extension-registry/extensions/preview-app.extension.ts b/src/packages/core/extension-registry/extensions/preview-app.extension.ts
@@ -6,3 +6,9 @@ import type { ManifestElement } from '@umbraco-cms/backoffice/extension-api';
 export interface ManifestPreviewAppProvider extends ManifestElement {
 	type: 'previewApp';
 }
+
+declare global {
+	interface UmbExtensionManifestMap {
+		UmbPreviewAppProviderExtension: ManifestPreviewAppProvider;
+	}
+}
diff --git a/src/packages/core/extension-registry/extensions/repository.extension.ts b/src/packages/core/extension-registry/extensions/repository.extension.ts
@@ -5,3 +5,9 @@ export interface ManifestRepository<ApiType extends UmbApi = UmbApi>
 		ManifestWithDynamicConditions<UmbExtensionCondition> {
 	type: 'repository';
 }
+
+declare global {
+	interface UmbExtensionManifestMap {
+		UmbRepositoryExtension: ManifestRepository;
+	}
+}
diff --git a/src/packages/core/extension-registry/extensions/store.extension.ts b/src/packages/core/extension-registry/extensions/store.extension.ts
@@ -13,3 +13,11 @@ export interface ManifestTreeStore extends ManifestApi<UmbTreeStore<any>> {
 export interface ManifestItemStore extends ManifestApi<UmbItemStore<any>> {
 	type: 'itemStore';
 }
+
+export type UmbStoreExtensions = ManifestStore | ManifestTreeStore | ManifestItemStore;
+
+declare global {
+	interface UmbExtensionManifestMap {
+		UmbStoreExtensions: UmbStoreExtensions;
+	}
+}
diff --git a/src/packages/core/extension-registry/index.ts b/src/packages/core/extension-registry/index.ts
@@ -4,5 +4,6 @@ export * from './registry.js';
 export * from './utils/index.js';
 export type * from './interfaces/index.js';
 export type * from './models/index.js';
+export type * from './extensions/index.js';
 
 export { UmbExtensionElementAndApiSlotElementBase } from './extension-element-and-api-slot-element-base.js';
diff --git a/src/packages/core/extension-registry/initializers/app-entry-point-extension-initializer.ts b/src/packages/core/extension-registry/initializers/app-entry-point-extension-initializer.ts
@@ -1,4 +1,4 @@
-import type { ManifestAppEntryPoint } from '../models/app-entry-point.model.js';
+import type { ManifestAppEntryPoint } from '../extensions/app-entry-point.extension.js';
 import type { UmbElement } from '@umbraco-cms/backoffice/element-api';
 import {
 	type UmbEntryPointModule,
diff --git a/src/packages/core/extension-registry/initializers/backoffice-entry-point-extension-initializer.ts b/src/packages/core/extension-registry/initializers/backoffice-entry-point-extension-initializer.ts
@@ -1,4 +1,4 @@
-import type { ManifestBackofficeEntryPoint } from '../models/backoffice-entry-point.model.js';
+import type { ManifestBackofficeEntryPoint } from '../extensions/backoffice-entry-point.extension.js';
 import type { UmbElement } from '@umbraco-cms/backoffice/element-api';
 import {
 	type UmbEntryPointModule,
diff --git a/src/packages/core/extension-registry/initializers/entry-point-extension-initializer.ts b/src/packages/core/extension-registry/initializers/entry-point-extension-initializer.ts
@@ -1,4 +1,4 @@
-import type { ManifestEntryPoint } from '../models/entry-point.model.js';
+import type { ManifestEntryPoint } from '../extensions/entry-point.extension.js';
 import type { UmbElement } from '@umbraco-cms/backoffice/element-api';
 import {
 	type UmbEntryPointModule,
@@ -20,6 +20,8 @@ export class UmbEntryPointExtensionInitializer extends UmbExtensionInitializerBa
 	}
 
 	async instantiateExtension(manifest: ManifestEntryPoint) {
+		console.error('The `entryPoint` extension-type is deprecated, please use the `backofficeEntryPoint`.');
+
 		if (manifest.js) {
 			const moduleInstance = await loadManifestPlainJs(manifest.js);
 
diff --git a/src/packages/core/extension-registry/manifests.ts b/src/packages/core/extension-registry/manifests.ts
@@ -1,4 +1,3 @@
 import { manifests as conditionManifests } from './conditions/manifests.js';
-import type { ManifestTypes } from './models/index.js';
 
-export const manifests: Array<ManifestTypes> = [...conditionManifests];
+export const manifests: Array<UmbExtensionManifest> = [...conditionManifests];
diff --git a/src/packages/core/extension-registry/models/index.ts b/src/packages/core/extension-registry/models/index.ts
@@ -1,128 +1,69 @@
 import type { ManifestAuthProvider } from './auth-provider.model.js';
 import type { ManifestCurrentUserAction, ManifestCurrentUserActionDefaultKind } from './current-user-action.model.js';
 import type { ManifestDashboard } from './dashboard.model.js';
-import type {
-	ManifestEntityAction,
-	ManifestEntityActionDeleteKind,
-	ManifestEntityActionRenameServerFileKind,
-	ManifestEntityActionReloadTreeItemChildrenKind,
-	ManifestEntityActionDuplicateToKind,
-	ManifestEntityActionMoveToKind,
-	ManifestEntityActionCreateFolderKind,
-	ManifestEntityActionUpdateFolderKind,
-	ManifestEntityActionDeleteFolderKind,
-	ManifestEntityActionDefaultKind,
-	ManifestEntityActionTrashKind,
-	ManifestEntityActionRestoreFromRecycleBinKind,
-	ManifestEntityActionEmptyRecycleBinKind,
-	ManifestEntityActionSortChildrenOfKind,
-} from './entity-action.model.js';
 import type { ManifestDynamicRootOrigin, ManifestDynamicRootQueryStep } from './dynamic-root.model.js';
-import type { ManifestEntityBulkAction } from './entity-bulk-action.model.js';
 import type { ManifestFileUploadPreview } from './file-upload-preview.model.js';
 import type { ManifestExternalLoginProvider } from './external-login-provider.model.js';
-import type { ManifestGlobalContext } from './global-context.model.js';
-import type { ManifestHeaderApp, ManifestHeaderAppButtonKind } from './header-app.model.js';
 import type { ManifestHealthCheck } from './health-check.model.js';
-import type { ManifestMenu } from './menu.model.js';
-import type { ManifestMenuItem, ManifestMenuItemLinkKind, ManifestMenuItemTreeKind } from './menu-item.model.js';
-import type { ManifestPreviewAppProvider } from './preview-app.model.js';
-import type { ManifestRepository } from './repository.model.js';
-import type { ManifestStore, ManifestTreeStore, ManifestItemStore } from './store.model.js';
 import type { ManifestTinyMcePlugin } from './tinymce-plugin.model.js';
 import type { ManifestUfmComponent } from './ufm-component.model.js';
 import type { ManifestUfmFilter } from './ufm-filter.model.js';
 import type { ManifestUserProfileApp } from './user-profile-app.model.js';
-import type { ManifestEntityUserPermission } from './entity-user-permission.model.js';
 import type { ManifestGranularUserPermission } from './user-granular-permission.model.js';
 import type { ManifestMfaLoginProvider } from './mfa-login-provider.model.js';
-import type { ManifestAppEntryPoint } from './app-entry-point.model.js';
-import type { ManifestBackofficeEntryPoint } from './backoffice-entry-point.model.js';
-import type { ManifestEntryPoint } from './entry-point.model.js';
 import type { ManifestMonacoMarkdownEditorAction } from './monaco-markdown-editor-action.model.js';
 import type { ManifestPickerSearchResultItem } from './picker-search-result-item.model.js';
 import type { ManifestBase, ManifestBundle, ManifestCondition } from '@umbraco-cms/backoffice/extension-api';
 
-export type * from './app-entry-point.model.js';
+export type * from '../extensions/app-entry-point.extension.js';
 export type * from './auth-provider.model.js';
-export type * from './backoffice-entry-point.model.js';
+export type * from '../extensions/backoffice-entry-point.extension.js';
 export type * from './current-user-action.model.js';
 export type * from './dashboard.model.js';
 export type * from './dynamic-root.model.js';
-export type * from './entity-action.model.js';
-export type * from './entity-bulk-action.model.js';
-export type * from './entity-user-permission.model.js';
-export type * from './entry-point.model.js';
+export type * from '../extensions/entity-action.extension.js';
+export type * from '../extensions/entity-bulk-action.extension.js';
+export type * from '../extensions/entity-user-permission.extension.js';
+export type * from '../extensions/entry-point.extension.js';
 export type * from './file-upload-preview.model.js';
 export type * from './external-login-provider.model.js';
-export type * from './global-context.model.js';
-export type * from './header-app.model.js';
 export type * from './health-check.model.js';
-export type * from './menu-item.model.js';
-export type * from './menu.model.js';
+export type * from '../extensions/menu-item.extension.js';
+export type * from '../extensions/menu.extension.js';
+export type * from './mfa-login-provider.model.js';
+export type * from './monaco-markdown-editor-action.model.js';
+export type * from './picker-search-result-item.model.js';
+export type * from '../extensions/preview-app.extension.js';
+export type * from '../extensions/store.extension.js';
 export type * from './mfa-login-provider.model.js';
 export type * from './monaco-markdown-editor-action.model.js';
 export type * from './picker-search-result-item.model.js';
-export type * from './preview-app.model.js';
-export type * from './repository.model.js';
-export type * from './store.model.js';
 export type * from './tinymce-plugin.model.js';
 export type * from './ufm-component.model.js';
 export type * from './ufm-filter.model.js';
 export type * from './user-granular-permission.model.js';
 export type * from './user-profile-app.model.js';
 
-export type ManifestEntityActions =
-	| ManifestEntityAction
-	| ManifestEntityActionCreateFolderKind
-	| ManifestEntityActionDefaultKind
-	| ManifestEntityActionDeleteFolderKind
-	| ManifestEntityActionDeleteKind
-	| ManifestEntityActionDuplicateToKind
-	| ManifestEntityActionEmptyRecycleBinKind
-	| ManifestEntityActionMoveToKind
-	| ManifestEntityActionReloadTreeItemChildrenKind
-	| ManifestEntityActionRenameServerFileKind
-	| ManifestEntityActionRestoreFromRecycleBinKind
-	| ManifestEntityActionSortChildrenOfKind
-	| ManifestEntityActionTrashKind
-	| ManifestEntityActionUpdateFolderKind;
-
 export type ManifestTypes =
-	| ManifestAppEntryPoint
 	| ManifestAuthProvider
-	| ManifestBackofficeEntryPoint
 	| ManifestBundle<ManifestTypes>
 	| ManifestCondition
 	| ManifestCurrentUserAction
 	| ManifestCurrentUserActionDefaultKind
 	| ManifestDashboard
 	| ManifestDynamicRootOrigin
 	| ManifestDynamicRootQueryStep
-	| ManifestEntityActions
-	| ManifestEntityBulkAction
-	| ManifestEntityUserPermission
-	| ManifestEntryPoint
 	| ManifestFileUploadPreview
 	| ManifestExternalLoginProvider
-	| ManifestGlobalContext
 	| ManifestGranularUserPermission
-	| ManifestHeaderApp
-	| ManifestHeaderAppButtonKind
 	| ManifestHealthCheck
-	| ManifestItemStore
-	| ManifestMenu
-	| ManifestMenuItem
-	| ManifestMenuItemTreeKind
-	| ManifestMenuItemLinkKind
 	| ManifestMfaLoginProvider
 	| ManifestMonacoMarkdownEditorAction
 	| ManifestPickerSearchResultItem
-	| ManifestPreviewAppProvider
-	| ManifestRepository
-	| ManifestStore
+	| ManifestMfaLoginProvider
+	| ManifestMonacoMarkdownEditorAction
+	| ManifestPickerSearchResultItem
 	| ManifestTinyMcePlugin
-	| ManifestTreeStore
 	| ManifestUfmComponent
 	| ManifestUfmFilter
 	| ManifestUserProfileApp
diff --git a/src/packages/documents/documents/entity-actions/notifications/repository/manifests.ts b/src/packages/documents/documents/entity-actions/notifications/repository/manifests.ts
diff --git a/src/packages/documents/documents/rollback/entity-action/manifests.ts b/src/packages/documents/documents/rollback/entity-action/manifests.ts
diff --git a/src/packages/documents/documents/rollback/manifests.ts b/src/packages/documents/documents/rollback/manifests.ts
diff --git a/src/packages/media/media/components/input-upload-field/preview/manifest.ts b/src/packages/media/media/components/input-upload-field/preview/manifest.ts
diff --git a/src/packages/media/umbraco-package.ts b/src/packages/media/umbraco-package.ts
diff --git a/src/packages/members/member-group/menu-item/manifests.ts b/src/packages/members/member-group/menu-item/manifests.ts
diff --git a/src/packages/members/member/menu-item/manifests.ts b/src/packages/members/member/menu-item/manifests.ts
diff --git a/src/packages/property-editors/umbraco-package.ts b/src/packages/property-editors/umbraco-package.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { MetaEntityBulkAction } from '../extension-registry/models/entity-bulk-action.model.js';`
	`1`	`+import type { MetaEntityBulkAction } from '../extension-registry/extensions/entity-bulk-action.extension.js';`
`2`	`2`
`3`	`3`	`export interface UmbEntityBulkActionArgs<MetaArgsType extends MetaEntityBulkAction> {`
`4`	`4`	`entityType: string;`