@umbraco-cms/backoffice 1.0.0-next.1855dcb1 → 1.0.0-next.186405ee

package/entity-action.d.ts

@@ -45,7 +45,7 @@ declare class UmbDeleteEntityAction<T extends UmbDetailRepository & UmbItemRepos
     execute(): Promise<void>;
 }
 
-declare class UmbDeleteFolderEntityAction<T extends UmbItemRepository<any> & UmbFolderRepository> extends UmbEntityActionBase$1<T> {
+declare class UmbDeleteFolderEntityAction<T extends UmbFolderRepository> extends UmbEntityActionBase$1<T> {
     #private;
     constructor(host: UmbControllerHostElement, repositoryAlias: string, unique: string);
     execute(): Promise<void>;

package/extensions-api.d.ts

@@ -1,7 +1,6 @@
 import { Observable } from 'rxjs';
-import { ManifestTypes, ManifestKind, ManifestTypeMap, ManifestBase, SpecificManifestTypeOrManifestBase, ManifestElement, ManifestElementWithElementName, ManifestClass } from '@umbraco-cms/backoffice/extensions-registry';
+import { ManifestTypes, ManifestKind, ManifestTypeMap, ManifestBase, SpecificManifestTypeOrManifestBase, ManifestElement, ManifestElementWithElementName, ManifestWithLoader, ManifestClass } from '@umbraco-cms/backoffice/extensions-registry';
 import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
-import { PageComponent } from '@umbraco-cms/backoffice/router';
 import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
 
 declare class UmbExtensionRegistry {
@@ -11,6 +10,7 @@ declare class UmbExtensionRegistry {
     readonly kinds: Observable<ManifestKind[]>;
     defineKind(kind: ManifestKind): void;
     register(manifest: ManifestTypes | ManifestKind): void;
+    registerMany(manifests: Array<ManifestTypes | ManifestKind>): void;
     unregister(alias: string): void;
     isRegistered(alias: string): boolean;
     private _kindsOfType;
@@ -23,7 +23,7 @@ declare class UmbExtensionRegistry {
 }
 declare const UMB_EXTENSION_REGISTRY_TOKEN: UmbContextToken<UmbExtensionRegistry>;
 
-declare function createExtensionElement(manifest: ManifestElement): Promise<PageComponent>;
+declare function createExtensionElement<ElementType extends HTMLElement>(manifest: ManifestElement<ElementType>): Promise<ElementType | undefined>;
 
 declare function hasDefaultExport<ConstructorType>(object: unknown): object is {
     default: ConstructorType;
@@ -44,19 +44,19 @@ declare function hasInitExport(obj: unknown): obj is Pick<UmbEntrypointModule, '
 
 declare function isManifestElementNameType(manifest: unknown): manifest is ManifestElementWithElementName;
 
-declare function isManifestElementableType(manifest: ManifestBase): manifest is ManifestElement;
+declare function isManifestElementableType<ElementType extends HTMLElement = HTMLElement>(manifest: ManifestBase): manifest is ManifestElement;
 
-type ManifestLoaderType = ManifestElement & {
-    loader: () => Promise<object | HTMLElement>;
-};
-type ManifestJSType = ManifestElement & {
+type ManifestJSType<T> = ManifestWithLoader<T> & {
     js: string;
 };
-declare function loadExtension(manifest: ManifestElement): Promise<object | HTMLElement | null>;
+declare function isManifestJSType<T>(manifest: ManifestBase | unknown): manifest is ManifestJSType<T>;
 
-declare function isManifestJSType(manifest: ManifestBase | unknown): manifest is ManifestJSType;
+type ManifestLoaderType<T> = ManifestWithLoader<T> & {
+    loader: () => Promise<T>;
+};
+declare function isManifestLoaderType<T>(manifest: ManifestBase): manifest is ManifestLoaderType<T>;
 
-declare function isManifestLoaderType(manifest: ManifestBase): manifest is ManifestLoaderType;
+declare function loadExtension<T = unknown>(manifest: ManifestWithLoader<T>): Promise<T | null>;
 
 declare function createExtensionElementOrFallback(manifest: any, fallbackElementName: string): Promise<HTMLElement | undefined>;
 

package/extensions-registry.d.ts

@@ -1,6 +1,9 @@
+import { DataTypePropertyPresentationModel, 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 { UmbStoreBase, UmbTreeStore, UmbItemStore } from '@umbraco-cms/backoffice/store';
+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';
 
@@ -31,7 +34,7 @@ interface ConditionsCollectionView {
     entityType: string;
 }
 
-interface ManifestDashboard extends ManifestElement, ManifestWithConditions<ConditionsDashboard> {
+interface ManifestDashboard extends ManifestElement<UmbDashboardExtensionElement>, ManifestWithConditions<ConditionsDashboard> {
     type: 'dashboard';
     meta: MetaDashboard;
 }
@@ -123,7 +126,7 @@ interface MetaEntityAction {
     repositoryAlias: string;
 }
 interface ConditionsEntityAction {
-    entityType: string;
+    entityTypes: Array<string>;
 }
 
 /**
@@ -157,7 +160,11 @@ interface ConditionsEntityBulkAction {
     entityType: string;
 }
 
-interface ManifestExternalLoginProvider extends ManifestElement {
+interface UmbExternalLoginProviderExtensionElement extends HTMLElement {
+    manifest?: ManifestExternalLoginProvider;
+}
+
+interface ManifestExternalLoginProvider extends ManifestElement<UmbExternalLoginProviderExtensionElement> {
     type: 'externalLoginProvider';
     meta: MetaExternalLoginProvider;
 }
@@ -203,6 +210,43 @@ interface HealthCheck {
     description: string;
 }
 
+interface ManifestMenu extends ManifestElement {
+    type: 'menu';
+}
+
+interface UmbMenuItemExtensionElement extends HTMLElement {
+    manifest?: ManifestMenuItem;
+}
+
+interface ManifestMenuItem extends ManifestElement<UmbMenuItemExtensionElement> {
+    type: 'menuItem';
+    meta: MetaMenuItem;
+    conditions: ConditionsMenuItem;
+}
+interface MetaMenuItem {
+    label: string;
+    icon: string;
+    entityType?: string;
+}
+interface ConditionsMenuItem {
+    menus: Array<string>;
+}
+interface ManifestMenuItemTreeKind extends ManifestMenuItem {
+    type: 'menuItem';
+    kind: 'tree';
+    meta: MetaMenuItemTreeKind;
+}
+interface MetaMenuItemTreeKind {
+    treeAlias: string;
+    label: string;
+    icon: string;
+    entityType?: string;
+}
+
+interface ManifestModal extends ManifestElement {
+    type: 'modal';
+}
+
 interface ManifestPackageView extends ManifestElement {
     type: 'packageView';
     meta: MetaPackageView;
@@ -218,7 +262,7 @@ interface ConditionsPropertyAction {
     propertyEditors: string[];
 }
 
-interface ManifestPropertyEditorUI extends ManifestElement {
+interface ManifestPropertyEditorUI extends ManifestElement<UmbPropertyEditorExtensionElement> {
     type: 'propertyEditorUI';
     meta: MetaPropertyEditorUI;
 }
@@ -252,7 +296,11 @@ interface PropertyEditorConfigDefaultData {
     value: any;
 }
 
-interface ManifestSection extends ManifestElement {
+interface ManifestRepository extends ManifestClass<unknown> {
+    type: 'repository';
+}
+
+interface ManifestSection extends ManifestElement<UmbSectionExtensionElement> {
     type: 'section';
     meta: MetaSection;
 }
@@ -261,20 +309,11 @@ interface MetaSection {
     pathname: string;
 }
 
-interface ManifestSectionView extends ManifestElement, ManifestWithConditions<ConditionsSectionView> {
-    type: 'sectionView';
-    meta: MetaSectionView;
-}
-interface MetaSectionView {
-    label: string;
-    pathname: string;
-    icon: string;
-}
-interface ConditionsSectionView {
-    sections: Array<string>;
+interface UmbSectionSidebarAppExtensionElement extends HTMLElement {
+    manifest?: ManifestSectionSidebarApp;
 }
 
-interface ManifestSectionSidebarApp extends ManifestElement {
+interface ManifestSectionSidebarApp extends ManifestElement<UmbSectionSidebarAppExtensionElement> {
     type: 'sectionSidebarApp';
     conditions: ConditionsSectionSidebarApp;
 }
@@ -291,33 +330,31 @@ interface MetaSectionSidebarAppMenuKind {
     menu: string;
 }
 
-interface ManifestMenu extends ManifestElement {
-    type: 'menu';
+interface UmbSectionViewExtensionElement extends HTMLElement {
+    manifest?: ManifestSectionView;
 }
 
-interface ManifestMenuItem extends ManifestElement {
-    type: 'menuItem';
-    meta: MetaMenuItem;
-    conditions: ConditionsMenuItem;
+interface ManifestSectionView extends ManifestElement<UmbSectionViewExtensionElement>, ManifestWithConditions<ConditionsSectionView> {
+    type: 'sectionView';
+    meta: MetaSectionView;
 }
-interface MetaMenuItem {
+interface MetaSectionView {
     label: string;
+    pathname: string;
     icon: string;
-    entityType?: string;
 }
-interface ConditionsMenuItem {
-    menus: Array<string>;
+interface ConditionsSectionView {
+    sections: Array<string>;
 }
-interface ManifestMenuItemTreeKind extends ManifestMenuItem {
-    type: 'menuItem';
-    kind: 'tree';
-    meta: MetaMenuItemTreeKind;
+
+interface ManifestStore extends ManifestClass<UmbStoreBase> {
+    type: 'store';
 }
-interface MetaMenuItemTreeKind {
-    treeAlias: string;
-    label: string;
-    icon: string;
-    entityType?: string;
+interface ManifestTreeStore extends ManifestClass<UmbTreeStore> {
+    type: 'treeStore';
+}
+interface ManifestItemStore extends ManifestClass<UmbItemStore> {
+    type: 'itemStore';
 }
 
 /**
@@ -341,12 +378,12 @@ interface MetaTree {
     repositoryAlias: string;
 }
 
-interface ManifestTreeItem extends ManifestElement {
+interface ManifestTreeItem extends ManifestElement<UmbTreeItemExtensionElement> {
     type: 'treeItem';
     conditions: ConditionsTreeItem;
 }
 interface ConditionsTreeItem {
-    entityType: string;
+    entityTypes: Array<string>;
 }
 
 interface ManifestUserProfileApp extends ManifestElement {
@@ -375,61 +412,37 @@ interface MetaWorkspaceAction {
     label?: string;
     look?: InterfaceLook;
     color?: InterfaceColor;
-    api: ClassConstructor<any>;
+    api: ClassConstructor<UmbWorkspaceAction>;
 }
 interface ConditionsWorkspaceAction {
     workspaces: Array<string>;
 }
 
-interface ManifestWorkspaceView extends ManifestWithView {
-    type: 'workspaceView';
-    meta: MetaWorkspaceView;
-    conditions: ConditionsWorkspaceView;
+interface UmbWorkspaceEditorViewExtensionElement extends HTMLElement {
+    manifest?: ManifestWorkspaceEditorView;
 }
-interface MetaWorkspaceView {
-    pathname: string;
-    label: string;
-    icon: string;
+
+interface ManifestWorkspaceEditorView extends ManifestWithView<UmbWorkspaceEditorViewExtensionElement> {
+    type: 'workspaceEditorView';
+    conditions: ConditionsWorkspaceView;
 }
 interface ConditionsWorkspaceView {
     workspaces: string[];
 }
 
-interface ManifestWorkspaceViewCollection extends ManifestBase, ManifestWithConditions<ConditionsEditorViewCollection> {
+interface ManifestWorkspaceViewCollection extends ManifestWithView, ManifestWithConditions<ConditionsEditorViewCollection> {
     type: 'workspaceViewCollection';
     meta: MetaEditorViewCollection;
 }
-interface MetaEditorViewCollection {
-    pathname: string;
-    label: string;
-    icon: string;
+interface MetaEditorViewCollection extends MetaManifestWithView {
     entityType: string;
-    storeAlias?: string;
-    repositoryAlias?: string;
+    repositoryAlias: string;
 }
 interface ConditionsEditorViewCollection {
     workspaces: string[];
 }
 
-interface ManifestRepository extends ManifestClass {
-    type: 'repository';
-}
-
-interface ManifestModal extends ManifestElement {
-    type: 'modal';
-}
-
-interface ManifestStore extends ManifestClass<UmbStoreBase> {
-    type: 'store';
-}
-interface ManifestTreeStore extends ManifestClass<UmbTreeStore> {
-    type: 'treeStore';
-}
-interface ManifestItemStore extends ManifestClass<UmbItemStore> {
-    type: 'itemStore';
-}
-
-type ManifestTypes = ManifestCollectionView | ManifestDashboard | ManifestDashboardCollection | ManifestEntityAction | ManifestEntityBulkAction | ManifestEntrypoint | ManifestExternalLoginProvider | ManifestHeaderApp | ManifestHeaderAppButtonKind | ManifestHealthCheck | ManifestPackageView | ManifestPropertyAction | ManifestPropertyEditorModel | ManifestPropertyEditorUI | ManifestRepository | ManifestSection | ManifestSectionSidebarApp | ManifestSectionSidebarAppMenuKind | ManifestSectionView | ManifestMenu | ManifestMenuItem | ManifestMenuItemTreeKind | ManifestTheme | ManifestTree | ManifestTreeItem | ManifestUserProfileApp | ManifestWorkspace | ManifestWorkspaceAction | ManifestWorkspaceView | ManifestWorkspaceViewCollection | ManifestModal | ManifestStore | ManifestTreeStore | ManifestItemStore | ManifestBase;
+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;
@@ -481,7 +494,10 @@ interface ManifestWithLoader<LoaderReturnType> extends ManifestBase {
 /**
  * The type of extension such as dashboard etc...
  */
-interface ManifestClass<T = unknown> extends ManifestWithLoader<object> {
+interface ManifestClass<ClassType = unknown> extends ManifestWithLoader<{
+    default: ClassConstructor<ClassType>;
+}> {
+    readonly CLASS_TYPE?: ClassType;
     /**
      * The file location of the javascript file to load
      * @TJS-required
@@ -494,12 +510,15 @@ interface ManifestClass<T = unknown> extends ManifestWithLoader<object> {
     /**
      * @TJS-ignore
      */
-    class?: ClassConstructor<T>;
+    class?: ClassConstructor<ClassType>;
 }
-interface ManifestClassWithClassConstructor extends ManifestClass {
-    class: ClassConstructor<unknown>;
+interface ManifestClassWithClassConstructor<T = unknown> extends ManifestClass<T> {
+    class: ClassConstructor<T>;
 }
-interface ManifestElement extends ManifestWithLoader<object | HTMLElement> {
+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
      *
@@ -516,7 +535,7 @@ interface ManifestElement extends ManifestWithLoader<object | HTMLElement> {
      */
     meta?: unknown;
 }
-interface ManifestWithView extends ManifestElement {
+interface ManifestWithView<ElementType extends HTMLElement = HTMLElement> extends ManifestElement<ElementType> {
     meta: MetaManifestWithView;
 }
 interface MetaManifestWithView {
@@ -542,17 +561,40 @@ interface ManifestWithMeta extends ManifestBase {
  * You could have custom logic to decide which extensions to load/register by using extensionRegistry
  */
 interface ManifestEntrypoint extends ManifestBase {
-    type: 'entrypoint';
+    type: 'entryPoint';
     /**
      * The file location of the javascript file to load in the backoffice
      */
     js: string;
 }
 
+interface UmbDashboardExtensionElement extends HTMLElement {
+    manifest?: ManifestDashboard;
+}
+
+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[];
+}
+
+interface UmbSectionExtensionElement extends HTMLElement {
+    manifest?: ManifestSection;
+}
+
+interface UmbTreeItemExtensionElement extends HTMLElement {
+    item?: TreeItemPresentationModel;
+}
+
 declare class UmbEntryPointExtensionInitializer {
     #private;
-    constructor(rootHost: UmbControllerHostElement, extensionRegistry: UmbExtensionRegistry);
-    instantiateEntryPoint(manifest: ManifestEntrypoint): void;
+    constructor(host: UmbControllerHostElement, extensionRegistry: UmbExtensionRegistry);
+    instantiateEntryPoint(manifest: ManifestEntrypoint): Promise<void>;
 }
 
-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, ManifestWorkspaceView, ManifestWorkspaceViewCollection, MetaCollectionView, MetaDashboard, MetaDashboardCollection, MetaEditor, MetaEditorViewCollection, MetaEntityAction, MetaEntityBulkAction, MetaExternalLoginProvider, MetaHeaderApp, MetaHeaderAppButtonKind, MetaHealthCheck, MetaManifestWithView, MetaMenuItem, MetaMenuItemTreeKind, MetaPackageView, MetaPropertyEditorModel, MetaPropertyEditorUI, MetaSection, MetaSectionSidebarAppMenuKind, MetaSectionView, MetaTree, MetaUserProfileApp, MetaWorkspaceAction, MetaWorkspaceView, PropertyEditorConfig, PropertyEditorConfigDefaultData, PropertyEditorConfigProperty, SpecificManifestTypeOrManifestBase, UmbEntryPointExtensionInitializer };
+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 };

package/id.d.ts

@@ -0,0 +1,6 @@
+declare class UmbId {
+    static new(): string;
+    static validate(id: string): boolean;
+}
+
+export { UmbId };