@umbraco-cms/backoffice 1.0.0-next.93a8a0e4 → 1.0.0-next.93ffdc6a

package/{extensions-registry.d.ts → extension-registry.d.ts}

@@ -1,11 +1,10 @@
-import { DataTypePropertyPresentationModel, TreeItemPresentationModel } from '@umbraco-cms/backoffice/backend-api';
+import { ManifestElement, ManifestWithConditions, ManifestBase, ManifestClass, ManifestWithLoader, ClassConstructor, ManifestWithView, MetaManifestWithView, ManifestEntryPoint, ManifestKind, UmbExtensionRegistry } from '@umbraco-cms/backoffice/extension-api';
+import { UmbModalHandler } from '@umbraco-cms/backoffice/modal';
+import { UmbDataTypePropertyCollection } from '@umbraco-cms/backoffice/data-type';
+import { TreeItemPresentationModel } from '@umbraco-cms/backoffice/backend-api';
 import { UmbStoreBase, UmbTreeStore, UmbItemStore } from '@umbraco-cms/backoffice/store';
 import { InterfaceLook, InterfaceColor } from '@umbraco-ui/uui-base/lib/types/index';
-import { ClassConstructor } from '@umbraco-cms/backoffice/models';
 import { UmbWorkspaceAction } from '@umbraco-cms/backoffice/workspace';
-import { UmbModalHandler } from '@umbraco-cms/backoffice/modal';
-import { UmbExtensionRegistry } from '@umbraco-cms/backoffice/extensions-api';
-import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
 
 interface ManifestCollectionView extends ManifestElement, ManifestWithConditions<ConditionsCollectionView> {
     type: 'collectionView';
@@ -126,7 +125,7 @@ interface MetaEntityAction {
     repositoryAlias: string;
 }
 interface ConditionsEntityAction {
-    entityType: string;
+    entityTypes: Array<string>;
 }
 
 /**
@@ -383,7 +382,7 @@ interface ManifestTreeItem extends ManifestElement<UmbTreeItemExtensionElement>
     conditions: ConditionsTreeItem;
 }
 interface ConditionsTreeItem {
-    entityType: string;
+    entityTypes: Array<string>;
 }
 
 interface ManifestUserProfileApp extends ManifestElement {
@@ -442,144 +441,21 @@ interface ConditionsEditorViewCollection {
     workspaces: string[];
 }
 
-type ManifestTypes = ManifestCollectionView | ManifestDashboard | ManifestDashboardCollection | ManifestEntityAction | ManifestEntityBulkAction | ManifestEntrypoint | ManifestExternalLoginProvider | ManifestHeaderApp | ManifestHeaderAppButtonKind | ManifestHealthCheck | ManifestItemStore | ManifestMenu | ManifestMenuItem | ManifestMenuItemTreeKind | ManifestModal | ManifestPackageView | ManifestPropertyAction | ManifestPropertyEditorModel | ManifestPropertyEditorUI | ManifestRepository | ManifestSection | ManifestSectionSidebarApp | ManifestSectionSidebarAppMenuKind | ManifestSectionView | ManifestStore | ManifestTheme | ManifestTree | ManifestTreeItem | ManifestTreeStore | ManifestUserProfileApp | ManifestWorkspace | ManifestWorkspaceAction | ManifestWorkspaceEditorView | ManifestWorkspaceViewCollection | ManifestBase;
-type ManifestStandardTypes = ManifestTypes['type'];
-type ManifestTypeMap = {
-    [Manifest in ManifestTypes as Manifest['type']]: Manifest;
-};
-type SpecificManifestTypeOrManifestBase<T extends keyof ManifestTypeMap | string> = T extends keyof ManifestTypeMap ? ManifestTypeMap[T] : ManifestBase;
-interface ManifestBase {
-    /**
-     * The type of extension such as dashboard etc...
-     */
-    type: string;
-    /**
-     * The alias of the extension, ensure it is unique
-     */
-    alias: string;
-    /**
-     * The kind of the extension, used to group extensions together
-     *
-     * @examples ["button"]
-     */
-    kind?: unknown;
-    /**
-     * The friendly name of the extension
-     */
-    name: string;
-    /**
-     * Extensions such as dashboards are ordered by weight with lower numbers being first in the list
-     */
-    weight?: number;
-}
-interface ManifestKind {
-    type: 'kind';
-    alias: string;
-    matchType: string;
-    matchKind: string;
-    manifest: Partial<ManifestTypes>;
-}
-interface ManifestWithConditions<ConditionsType> {
-    /**
-     * Set the conditions for when the extension should be loaded
-     */
-    conditions: ConditionsType;
-}
-interface ManifestWithLoader<LoaderReturnType> extends ManifestBase {
-    /**
-     * @TJS-ignore
-     */
-    loader?: () => Promise<LoaderReturnType>;
-}
-/**
- * The type of extension such as dashboard etc...
- */
-interface ManifestClass<ClassType = unknown> extends ManifestWithLoader<{
-    default: ClassConstructor<ClassType>;
-}> {
-    readonly CLASS_TYPE?: ClassType;
-    /**
-     * The file location of the javascript file to load
-     * @TJS-required
-     */
-    js?: string;
-    /**
-     * @TJS-ignore
-     */
-    className?: string;
-    /**
-     * @TJS-ignore
-     */
-    class?: ClassConstructor<ClassType>;
-}
-interface ManifestClassWithClassConstructor<T = unknown> extends ManifestClass<T> {
-    class: ClassConstructor<T>;
-}
-interface ManifestElement<ElementType extends HTMLElement = HTMLElement> extends ManifestWithLoader<{
-    default: ClassConstructor<ElementType>;
-} | Omit<object, 'default'>> {
-    readonly ELEMENT_TYPE?: ElementType;
-    /**
-     * The file location of the javascript file to load
-     *
-     * @TJS-require
-     */
-    js?: string;
-    /**
-     * The HTML web component name to use such as 'my-dashboard'
-     * Note it is NOT <my-dashboard></my-dashboard> but just the name
-     */
-    elementName?: string;
-    /**
-     * This contains properties specific to the type of extension
-     */
-    meta?: unknown;
-}
-interface ManifestWithView<ElementType extends HTMLElement = HTMLElement> extends ManifestElement<ElementType> {
-    meta: MetaManifestWithView;
-}
-interface MetaManifestWithView {
-    pathname: string;
-    label: string;
-    icon: string;
-}
-interface ManifestElementWithElementName extends ManifestElement {
-    /**
-     * The HTML web component name to use such as 'my-dashboard'
-     * Note it is NOT <my-dashboard></my-dashboard> but just the name
-     */
-    elementName: string;
-}
-interface ManifestWithMeta extends ManifestBase {
-    /**
-     * This contains properties specific to the type of extension
-     */
-    meta: unknown;
-}
-/**
- * This type of extension gives full control and will simply load the specified JS file
- * You could have custom logic to decide which extensions to load/register by using extensionRegistry
- */
-interface ManifestEntrypoint extends ManifestBase {
-    type: 'entryPoint';
-    /**
-     * The file location of the javascript file to load in the backoffice
-     */
-    js: string;
-}
+type ManifestTypes = ManifestCollectionView | ManifestDashboard | ManifestDashboardCollection | ManifestEntityAction | ManifestEntityBulkAction | ManifestEntryPoint | ManifestExternalLoginProvider | ManifestHeaderApp | ManifestHeaderAppButtonKind | ManifestHealthCheck | ManifestItemStore | ManifestMenu | ManifestMenuItem | ManifestMenuItemTreeKind | ManifestModal | ManifestPackageView | ManifestPropertyAction | ManifestPropertyEditorModel | ManifestPropertyEditorUI | ManifestRepository | ManifestSection | ManifestSectionSidebarApp | ManifestSectionSidebarAppMenuKind | ManifestSectionView | ManifestStore | ManifestTheme | ManifestTree | ManifestTreeItem | ManifestTreeStore | ManifestUserProfileApp | ManifestWorkspace | ManifestWorkspaceAction | ManifestWorkspaceEditorView | ManifestWorkspaceViewCollection | ManifestBase;
 
 interface UmbDashboardExtensionElement extends HTMLElement {
     manifest?: ManifestDashboard;
 }
 
-interface UmbModalExtensionElement<UmbModalData extends object = object, UmbModalResult = unknown> extends HTMLElement {
+interface UmbModalExtensionElement<UmbModalData extends object = object, UmbModalResult = unknown, ModalManifestType extends ManifestModal = ManifestModal> extends HTMLElement {
+    manifest?: ModalManifestType;
     modalHandler?: UmbModalHandler<UmbModalData, UmbModalResult>;
     data?: UmbModalData;
 }
 
 interface UmbPropertyEditorExtensionElement extends HTMLElement {
     value: unknown;
-    config: DataTypePropertyPresentationModel[];
+    config?: UmbDataTypePropertyCollection;
 }
 
 interface UmbSectionExtensionElement extends HTMLElement {
@@ -590,10 +466,8 @@ interface UmbTreeItemExtensionElement extends HTMLElement {
     item?: TreeItemPresentationModel;
 }
 
-declare class UmbEntryPointExtensionInitializer {
-    #private;
-    constructor(host: UmbControllerHostElement, extensionRegistry: UmbExtensionRegistry);
-    instantiateEntryPoint(manifest: ManifestEntrypoint): Promise<void>;
-}
+type UmbBackofficeManifestKind = ManifestKind<ManifestTypes>;
+type UmbBackofficeExtensionRegistry = UmbExtensionRegistry<ManifestTypes>;
+declare const umbExtensionsRegistry: UmbBackofficeExtensionRegistry;
 
-export { ConditionsCollectionView, ConditionsDashboard, ConditionsDashboardCollection, ConditionsEditorViewCollection, ConditionsEntityAction, ConditionsEntityBulkAction, ConditionsMenuItem, ConditionsPropertyAction, ConditionsSectionSidebarApp, ConditionsSectionView, ConditionsTreeItem, ConditionsWorkspaceAction, ConditionsWorkspaceView, HealthCheck, ManifestBase, ManifestClass, ManifestClassWithClassConstructor, ManifestCollectionView, ManifestDashboard, ManifestDashboardCollection, ManifestElement, ManifestElementWithElementName, ManifestEntityAction, ManifestEntityBulkAction, ManifestEntrypoint, ManifestExternalLoginProvider, ManifestHeaderApp, ManifestHeaderAppButtonKind, ManifestHealthCheck, ManifestItemStore, ManifestKind, ManifestMenu, ManifestMenuItem, ManifestMenuItemTreeKind, ManifestModal, ManifestPackageView, ManifestPropertyAction, ManifestPropertyEditorModel, ManifestPropertyEditorUI, ManifestRepository, ManifestSection, ManifestSectionSidebarApp, ManifestSectionSidebarAppMenuKind, ManifestSectionView, ManifestStandardTypes, ManifestStore, ManifestTheme, ManifestTree, ManifestTreeItem, ManifestTreeStore, ManifestTypeMap, ManifestTypes, ManifestUserProfileApp, ManifestWithConditions, ManifestWithLoader, ManifestWithMeta, ManifestWithView, ManifestWorkspace, ManifestWorkspaceAction, ManifestWorkspaceEditorView, ManifestWorkspaceViewCollection, MetaCollectionView, MetaDashboard, MetaDashboardCollection, MetaEditor, MetaEditorViewCollection, MetaEntityAction, MetaEntityBulkAction, MetaExternalLoginProvider, MetaHeaderApp, MetaHeaderAppButtonKind, MetaHealthCheck, MetaManifestWithView, MetaMenuItem, MetaMenuItemTreeKind, MetaPackageView, MetaPropertyEditorModel, MetaPropertyEditorUI, MetaSection, MetaSectionSidebarAppMenuKind, MetaSectionView, MetaTree, MetaUserProfileApp, MetaWorkspaceAction, PropertyEditorConfig, PropertyEditorConfigDefaultData, PropertyEditorConfigProperty, SpecificManifestTypeOrManifestBase, UmbDashboardExtensionElement, UmbEntryPointExtensionInitializer, UmbExternalLoginProviderExtensionElement, UmbMenuItemExtensionElement, UmbModalExtensionElement, UmbPropertyEditorExtensionElement, UmbSectionExtensionElement, UmbSectionSidebarAppExtensionElement, UmbSectionViewExtensionElement, UmbTreeItemExtensionElement, UmbWorkspaceEditorViewExtensionElement };
+export { ConditionsCollectionView, ConditionsDashboard, ConditionsDashboardCollection, ConditionsEditorViewCollection, ConditionsEntityAction, ConditionsEntityBulkAction, ConditionsMenuItem, ConditionsPropertyAction, ConditionsSectionSidebarApp, ConditionsSectionView, ConditionsTreeItem, ConditionsWorkspaceAction, ConditionsWorkspaceView, HealthCheck, ManifestCollectionView, ManifestDashboard, ManifestDashboardCollection, ManifestEntityAction, ManifestEntityBulkAction, ManifestExternalLoginProvider, ManifestHeaderApp, ManifestHeaderAppButtonKind, ManifestHealthCheck, ManifestItemStore, ManifestMenu, ManifestMenuItem, ManifestMenuItemTreeKind, ManifestModal, ManifestPackageView, ManifestPropertyAction, ManifestPropertyEditorModel, ManifestPropertyEditorUI, ManifestRepository, ManifestSection, ManifestSectionSidebarApp, ManifestSectionSidebarAppMenuKind, ManifestSectionView, ManifestStore, ManifestTheme, ManifestTree, ManifestTreeItem, ManifestTreeStore, ManifestTypes, ManifestUserProfileApp, ManifestWorkspace, ManifestWorkspaceAction, ManifestWorkspaceEditorView, ManifestWorkspaceViewCollection, MetaCollectionView, MetaDashboard, MetaDashboardCollection, MetaEditor, MetaEditorViewCollection, MetaEntityAction, MetaEntityBulkAction, MetaExternalLoginProvider, MetaHeaderApp, MetaHeaderAppButtonKind, MetaHealthCheck, MetaMenuItem, MetaMenuItemTreeKind, MetaPackageView, MetaPropertyEditorModel, MetaPropertyEditorUI, MetaSection, MetaSectionSidebarAppMenuKind, MetaSectionView, MetaTree, MetaUserProfileApp, MetaWorkspaceAction, PropertyEditorConfig, PropertyEditorConfigDefaultData, PropertyEditorConfigProperty, UmbBackofficeExtensionRegistry, UmbBackofficeManifestKind, UmbDashboardExtensionElement, UmbExternalLoginProviderExtensionElement, UmbMenuItemExtensionElement, UmbModalExtensionElement, UmbPropertyEditorExtensionElement, UmbSectionExtensionElement, UmbSectionSidebarAppExtensionElement, UmbSectionViewExtensionElement, UmbTreeItemExtensionElement, UmbWorkspaceEditorViewExtensionElement, umbExtensionsRegistry };