@umbraco-cms/backoffice 1.0.0-next.b3c19406 → 1.0.0-next.b435296e

package/data-type.d.ts

@@ -0,0 +1,13 @@
+import { DataTypePropertyPresentationModel } from '@umbraco-cms/backoffice/backend-api';
+
+/**
+ * Extends Array to add utility functions for accessing data type properties
+ * by alias, returning either the value or the complete DataTypePropertyPresentationModel object
+ */
+declare class UmbDataTypePropertyCollection extends Array<DataTypePropertyPresentationModel> {
+    constructor(args?: Array<DataTypePropertyPresentationModel>);
+    getValueByAlias<T>(alias: string): T | undefined;
+    getByAlias(alias: string): DataTypePropertyPresentationModel | undefined;
+}
+
+export { UmbDataTypePropertyCollection };

package/{element.d.ts → element-api.d.ts}

@@ -1,6 +1,6 @@
 import { Observable } from 'rxjs';
-import { HTMLElementConstructor } from '@umbraco-cms/backoffice/models';
-import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
+import { HTMLElementConstructor } from '@umbraco-cms/backoffice/extension-api';
+import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api';
 import { UmbContextToken, UmbContextProviderController, UmbContextCallback, UmbContextConsumerController } from '@umbraco-cms/backoffice/context-api';
 import { UmbObserverController } from '@umbraco-cms/backoffice/observable-api';
 

package/entity-action.d.ts

@@ -1,4 +1,4 @@
-import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
+import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api';
 import { UmbEntityActionBase as UmbEntityActionBase$1 } from '@umbraco-cms/backoffice/entity-action';
 import { UmbDetailRepository, UmbItemRepository, UmbFolderRepository } from '@umbraco-cms/backoffice/repository';
 

package/extension-api.d.ts

@@ -0,0 +1,200 @@
+import { Observable } from 'rxjs';
+import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api';
+
+type HTMLElementConstructor<T = HTMLElement> = new (...args: any[]) => T;
+type ClassConstructor<T> = new (...args: any[]) => T;
+type ManifestTypeMap<ManifestTypes extends ManifestBase> = {
+    [Manifest in ManifestTypes as Manifest['type']]: Manifest;
+} & {
+    [key: string]: ManifestBase;
+};
+type SpecificManifestTypeOrManifestBase<ManifestTypes extends ManifestBase, T extends keyof ManifestTypeMap<ManifestTypes> | string> = T extends keyof ManifestTypeMap<ManifestTypes> ? ManifestTypeMap<ManifestTypes>[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<ManifestTypes> {
+    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;
+}
+
+declare class UmbExtensionRegistry<IncomingManifestTypes extends ManifestBase, ManifestTypes extends ManifestBase = IncomingManifestTypes | ManifestBase> {
+    private _extensions;
+    readonly extensions: Observable<ManifestTypes[]>;
+    private _kinds;
+    readonly kinds: Observable<ManifestKind<ManifestTypes>[]>;
+    defineKind(kind: ManifestKind<ManifestTypes>): void;
+    register(manifest: ManifestTypes | ManifestKind<ManifestTypes>): void;
+    registerMany(manifests: Array<ManifestTypes | ManifestKind<ManifestTypes>>): void;
+    unregister(alias: string): void;
+    isRegistered(alias: string): boolean;
+    private _kindsOfType;
+    private _extensionsOfType;
+    private _kindsOfTypes;
+    private _extensionsOfTypes;
+    getByTypeAndAlias<Key extends keyof ManifestTypeMap<ManifestTypes> | string, T extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>>(type: Key, alias: string): Observable<T | undefined>;
+    extensionsOfType<Key extends keyof ManifestTypeMap<ManifestTypes> | string, T extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>>(type: Key): Observable<T[]>;
+    extensionsOfTypes<ExtensionTypes extends ManifestBase = ManifestBase>(types: string[]): Observable<Array<ExtensionTypes>>;
+}
+
+declare function isManifestClassConstructorType(manifest: unknown): manifest is ManifestClassWithClassConstructor;
+
+declare function isManifestClassableType(manifest: ManifestBase): manifest is ManifestClass;
+
+declare function isManifestElementNameType(manifest: unknown): manifest is ManifestElementWithElementName;
+
+declare function isManifestElementableType<ElementType extends HTMLElement = HTMLElement>(manifest: ManifestBase): manifest is ManifestElement;
+
+type ManifestJSType<T> = ManifestWithLoader<T> & {
+    js: string;
+};
+declare function isManifestJSType<T>(manifest: ManifestBase | unknown): manifest is ManifestJSType<T>;
+
+type ManifestLoaderType<T> = ManifestWithLoader<T> & {
+    loader: () => Promise<T>;
+};
+declare function isManifestLoaderType<T>(manifest: ManifestBase): manifest is ManifestLoaderType<T>;
+
+declare function createExtensionElement<ElementType extends HTMLElement>(manifest: ManifestElement<ElementType>): Promise<ElementType | undefined>;
+
+declare function hasDefaultExport<ConstructorType>(object: unknown): object is {
+    default: ConstructorType;
+};
+
+type UmbEntryPointOnInit = (host: UmbControllerHostElement, extensionRegistry: UmbExtensionRegistry<ManifestBase>) => void;
+/**
+ * Interface containing supported life-cycle functions for ESModule entry points
+ */
+interface UmbEntryPointModule {
+    onInit: UmbEntryPointOnInit;
+}
+
+/**
+ * Validate if an ESModule exports a known init function called 'onInit'
+ */
+declare function hasInitExport(obj: unknown): obj is Pick<UmbEntryPointModule, 'onInit'>;
+
+declare function loadExtension<T = unknown>(manifest: ManifestWithLoader<T>): Promise<T | null>;
+
+declare function createExtensionElementOrFallback(manifest: any, fallbackElementName: string): Promise<HTMLElement | undefined>;
+
+declare function createExtensionClass<T = unknown>(manifest: ManifestClass, constructorArguments: unknown[]): Promise<T | undefined>;
+
+declare class UmbEntryPointExtensionInitializer {
+    #private;
+    constructor(host: UmbControllerHostElement, extensionRegistry: UmbExtensionRegistry<ManifestEntryPoint>);
+    instantiateEntryPoint(manifest: ManifestEntryPoint): Promise<void>;
+}
+
+export { ClassConstructor, HTMLElementConstructor, ManifestBase, ManifestClass, ManifestClassWithClassConstructor, ManifestElement, ManifestElementWithElementName, ManifestEntryPoint, ManifestJSType, ManifestKind, ManifestLoaderType, ManifestTypeMap, ManifestWithConditions, ManifestWithLoader, ManifestWithMeta, ManifestWithView, MetaManifestWithView, SpecificManifestTypeOrManifestBase, UmbEntryPointExtensionInitializer, UmbEntryPointModule, UmbEntryPointOnInit, UmbExtensionRegistry, createExtensionClass, createExtensionElement, createExtensionElementOrFallback, hasDefaultExport, hasInitExport, isManifestClassConstructorType, isManifestClassableType, isManifestElementNameType, isManifestElementableType, isManifestJSType, isManifestLoaderType, loadExtension };

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';
@@ -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 };

package/modal.d.ts

@@ -4,11 +4,11 @@ import * as lit from 'lit';
 import { LitElement, TemplateResult } from 'lit';
 import * as lit_html from 'lit-html';
 import { UUIModalDialogElement, UUIModalSidebarElement, UUIModalSidebarSize } from '@umbraco-ui/uui';
-import { UmbControllerHostElement, UmbControllerInterface } from '@umbraco-cms/backoffice/controller';
+import { UmbControllerHostElement, UmbControllerInterface } from '@umbraco-cms/backoffice/controller-api';
 import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
 import { Params } from '@umbraco-cms/backoffice/router';
-import { UmbModalToken as UmbModalToken$1, UmbModalConfig as UmbModalConfig$1, UmbPickerModalData as UmbPickerModalData$1 } from '@umbraco-cms/backoffice/modal';
-import { LanguageResponseModel, UserResponseModel, FolderReponseModel } from '@umbraco-cms/backoffice/backend-api';
+import { UmbModalToken as UmbModalToken$1, UmbModalConfig as UmbModalConfig$1, UmbTreePickerModalData as UmbTreePickerModalData$1, UmbPickerModalResult as UmbPickerModalResult$1, UmbPickerModalData as UmbPickerModalData$1 } from '@umbraco-cms/backoffice/modal';
+import { DocumentTreeItemResponseModel, EntityTreeItemResponseModel, LanguageResponseModel, ContentTreeItemResponseModel, UserResponseModel, FolderReponseModel, FolderTreeItemResponseModel } from '@umbraco-cms/backoffice/backend-api';
 
 declare class UmbSearchModalElement extends LitElement {
     #private;
@@ -26,38 +26,36 @@ declare global {
     }
 }
 
-declare class UmbModalToken<Data extends object = object, Result = unknown> {
+declare class UmbModalToken<ModalDataType extends object = object, ModalResultType = unknown> {
     protected alias: string;
     protected defaultConfig?: UmbModalConfig | undefined;
-    protected _desc?: string | undefined;
+    protected defaultData?: ModalDataType | undefined;
     /**
      * Get the data type of the token's data.
      *
      * @public
-     * @type      {Data}
+     * @type      {ModalDataType}
      * @memberOf  UmbModalToken
      * @example   `typeof MyModal.TYPE`
      * @returns   undefined
      */
-    readonly DATA: Data;
+    readonly DATA: ModalDataType;
     /**
      * Get the result type of the token
      *
      * @public
-     * @type      {Result}
+     * @type      {ModalResultType}
      * @memberOf  UmbModalToken
      * @example   `typeof MyModal.RESULT`
      * @returns   undefined
      */
-    readonly RESULT: Result;
+    readonly RESULT: ModalResultType;
     /**
      * @param alias   Unique identifier for the token,
      * @param defaultConfig  Default configuration for the modal,
-     * @param _desc   Description for the token,
-     *                used only for debugging purposes,
-     *                it should but does not need to be unique
+     * @param defaultData  Default data for the modal,
      */
-    constructor(alias: string, defaultConfig?: UmbModalConfig | undefined, _desc?: string | undefined);
+    constructor(alias: string, defaultConfig?: UmbModalConfig | undefined, defaultData?: ModalDataType | undefined);
     /**
      * This method must always return the unique alias of the token since that
      * will be used to look up the token in the injector.
@@ -66,6 +64,7 @@ declare class UmbModalToken<Data extends object = object, Result = unknown> {
      */
     toString(): string;
     getDefaultConfig(): UmbModalConfig | undefined;
+    getDefaultData(): ModalDataType | undefined;
 }
 
 /**
@@ -207,23 +206,13 @@ interface UmbContextDebuggerModalData {
 }
 declare const UMB_CONTEXT_DEBUGGER_MODAL: UmbModalToken$1<UmbContextDebuggerModalData, unknown>;
 
-interface UmbDocumentPickerModalData {
-    multiple?: boolean;
-    selection?: Array<string | null>;
-}
-interface UmbDocumentPickerModalResult {
-    selection: Array<string | null>;
-}
-declare const UMB_DOCUMENT_PICKER_MODAL: UmbModalToken$1<UmbDocumentPickerModalData, UmbDocumentPickerModalResult>;
+type UmbDocumentPickerModalData = UmbTreePickerModalData$1<DocumentTreeItemResponseModel>;
+type UmbDocumentPickerModalResult = UmbPickerModalResult$1;
+declare const UMB_DOCUMENT_PICKER_MODAL: UmbModalToken$1<UmbDocumentPickerModalData, UmbPickerModalResult$1>;
 
-interface UmbDocumentTypePickerModalData {
-    multiple?: boolean;
-    selection?: Array<string>;
-}
-interface UmbDocumentTypePickerModalResult {
-    selection: Array<string | null>;
-}
-declare const UMB_DOCUMENT_TYPE_PICKER_MODAL: UmbModalToken$1<UmbDocumentTypePickerModalData, UmbDocumentTypePickerModalResult>;
+type UmbDocumentTypePickerModalData = UmbTreePickerModalData$1<EntityTreeItemResponseModel>;
+type UmbDocumentTypePickerModalResult = UmbPickerModalResult$1;
+declare const UMB_DOCUMENT_TYPE_PICKER_MODAL: UmbModalToken$1<UmbDocumentTypePickerModalData, UmbPickerModalResult$1>;
 
 declare enum OEmbedStatus {
     NotSupported = 0,
@@ -288,11 +277,11 @@ declare const UMB_INVITE_USER_MODAL: UmbModalToken$1<object, unknown>;
 
 interface UmbLanguagePickerModalData {
     multiple?: boolean;
-    selection?: Array<string>;
+    selection?: Array<string | null>;
     filter?: (language: LanguageResponseModel) => boolean;
 }
 interface UmbLanguagePickerModalResult {
-    selection: Array<string>;
+    selection: Array<string | null>;
 }
 declare const UMB_LANGUAGE_PICKER_MODAL: UmbModalToken$1<UmbLanguagePickerModalData, UmbLanguagePickerModalResult>;
 
@@ -322,14 +311,9 @@ interface UmbLinkPickerConfig {
 }
 declare const UMB_LINK_PICKER_MODAL: UmbModalToken$1<UmbLinkPickerModalData, UmbLinkPickerModalResult>;
 
-interface UmbMediaPickerModalData {
-    multiple?: boolean;
-    selection: Array<string>;
-}
-interface UmbMediaPickerModalResult {
-    selection: Array<string | null>;
-}
-declare const UMB_MEDIA_PICKER_MODAL: UmbModalToken$1<UmbMediaPickerModalData, UmbMediaPickerModalResult>;
+type UmbMediaTreePickerModalData = UmbTreePickerModalData$1<ContentTreeItemResponseModel>;
+type UmbMediaTreePickerModalResult = UmbPickerModalResult$1;
+declare const UMB_MEDIA_TREE_PICKER_MODAL: UmbModalToken$1<UmbMediaTreePickerModalData, UmbPickerModalResult$1>;
 
 interface UmbPropertyEditorUIPickerModalData {
     selection?: Array<string>;
@@ -359,9 +343,12 @@ declare const UMB_SEARCH_MODAL: UmbModalToken$1<object, unknown>;
 
 interface UmbSectionPickerModalData {
     multiple: boolean;
-    selection: string[];
+    selection: Array<string | null>;
 }
-declare const UMB_SECTION_PICKER_MODAL: UmbModalToken$1<UmbSectionPickerModalData, unknown>;
+interface UmbSectionPickerModalResult {
+    selection: Array<string | null>;
+}
+declare const UMB_SECTION_PICKER_MODAL: UmbModalToken$1<UmbSectionPickerModalData, UmbSectionPickerModalResult>;
 
 interface UmbTemplateModalData {
     id: string;
@@ -372,20 +359,15 @@ interface UmbTemplateModalResult {
 }
 declare const UMB_TEMPLATE_MODAL: UmbModalToken$1<UmbTemplateModalData, UmbTemplateModalResult>;
 
-interface UmbTemplatePickerModalData {
-    multiple: boolean;
-    selection: Array<string | null>;
-}
-interface UmbTemplatePickerModalResult {
-    selection: Array<string | null>;
-}
-declare const UMB_TEMPLATE_PICKER_MODAL: UmbModalToken$1<UmbTemplatePickerModalData, UmbTemplatePickerModalResult>;
+type UmbTemplatePickerModalData = UmbTreePickerModalData$1<EntityTreeItemResponseModel>;
+type UmbTemplatePickerModalResult = UmbPickerModalResult$1;
+declare const UMB_TEMPLATE_PICKER_MODAL: UmbModalToken$1<UmbTemplatePickerModalData, UmbPickerModalResult$1>;
 
 declare const UMB_USER_GROUP_PICKER_MODAL: UmbModalToken$1<UmbPickerModalData$1<any>, unknown>;
 
 type UmbUserPickerModalData = UmbPickerModalData$1<UserResponseModel>;
 interface UmbUserPickerModalResult {
-    selection: Array<string>;
+    selection: Array<string | null>;
 }
 declare const UMB_USER_PICKER_MODAL: UmbModalToken$1<UmbUserPickerModalData, UmbUserPickerModalResult>;
 
@@ -398,22 +380,41 @@ interface UmbFolderModalResult {
 }
 declare const UMB_FOLDER_MODAL: UmbModalToken$1<UmbFolderModalData, UmbFolderModalResult>;
 
-interface UmbDataTypePickerModalData {
-    selection?: Array<string | null>;
-    multiple?: boolean;
+interface UmbPartialViewPickerModalData {
+    multiple: boolean;
+    selection: string[];
 }
-interface UmbDataTypePickerModalResult {
-    selection: Array<string | null>;
+interface UmbPartialViewPickerModalResult {
+    selection: Array<string | null> | undefined;
 }
-declare const UMB_DATA_TYPE_PICKER_MODAL: UmbModalToken$1<UmbDataTypePickerModalData, UmbDataTypePickerModalResult>;
+declare const UMB_PARTIAL_VIEW_PICKER_MODAL_ALIAS = "Umb.Modal.PartialViewPicker";
+declare const UMB_PARTIAL_VIEW_PICKER_MODAL: UmbModalToken$1<UmbPartialViewPickerModalData, UmbPartialViewPickerModalResult>;
 
-interface UmbPickerModalData<T> {
+interface UmbDictionaryItemPickerModalData {
     multiple: boolean;
+    selection: string[];
+}
+interface UmbDictionaryItemPickerModalResult {
     selection: Array<string | null>;
-    filter?: (item: T) => boolean;
+}
+declare const UMB_DICTIONARY_ITEM_PICKER_MODAL_ALIAS = "Umb.Modal.DictionaryItemPicker";
+declare const UMB_DICTIONARY_ITEM_PICKER_MODAL: UmbModalToken$1<UmbDictionaryItemPickerModalData, UmbDictionaryItemPickerModalResult>;
+
+type UmbDataTypePickerModalData = UmbTreePickerModalData$1<FolderTreeItemResponseModel>;
+type UmbDataTypePickerModalResult = UmbPickerModalResult$1;
+declare const UMB_DATA_TYPE_PICKER_MODAL: UmbModalToken$1<UmbDataTypePickerModalData, UmbPickerModalResult$1>;
+
+interface UmbPickerModalData<ItemType> {
+    multiple?: boolean;
+    selection?: Array<string | null>;
+    filter?: (item: ItemType) => boolean;
+    pickableFilter?: (item: ItemType) => boolean;
 }
 interface UmbPickerModalResult {
     selection: Array<string | null>;
 }
+interface UmbTreePickerModalData<TreeItemType> extends UmbPickerModalData<TreeItemType> {
+    treeAlias?: string;
+}
 
-export { OEmbedResult, OEmbedStatus, UMB_ALLOWED_DOCUMENT_TYPES_MODAL, UMB_CHANGE_PASSWORD_MODAL, UMB_CONFIRM_MODAL, UMB_CONTEXT_DEBUGGER_MODAL, UMB_CREATE_DICTIONARY_MODAL, UMB_CREATE_USER_MODAL, UMB_CURRENT_USER_MODAL, UMB_DATA_TYPE_PICKER_MODAL, UMB_DOCUMENT_PICKER_MODAL, UMB_DOCUMENT_TYPE_PICKER_MODAL, UMB_EMBEDDED_MEDIA_MODAL, UMB_EXAMINE_FIELDS_SETTINGS_MODAL, UMB_EXPORT_DICTIONARY_MODAL, UMB_FOLDER_MODAL, UMB_ICON_PICKER_MODAL, UMB_IMPORT_DICTIONARY_MODAL, UMB_INVITE_USER_MODAL, UMB_LANGUAGE_PICKER_MODAL, UMB_LINK_PICKER_MODAL, UMB_MEDIA_PICKER_MODAL, UMB_MODAL_CONTEXT_TOKEN, UMB_PROPERTY_EDITOR_UI_PICKER_MODAL, UMB_PROPERTY_SETTINGS_MODAL, UMB_SEARCH_MODAL, UMB_SECTION_PICKER_MODAL, UMB_TEMPLATE_MODAL, UMB_TEMPLATE_PICKER_MODAL, UMB_USER_GROUP_PICKER_MODAL, UMB_USER_PICKER_MODAL, UmbAllowedDocumentTypesModalData, UmbAllowedDocumentTypesModalResult, UmbChangePasswordModalData, UmbConfirmModalData, UmbConfirmModalResult, UmbContextDebuggerModalData, UmbCreateDictionaryModalData, UmbCreateDictionaryModalResult, UmbCreateDocumentModalResultData, UmbDataTypePickerModalData, UmbDataTypePickerModalResult, UmbDocumentPickerModalData, UmbDocumentPickerModalResult, UmbDocumentTypePickerModalData, UmbDocumentTypePickerModalResult, UmbEmbeddedMediaModalData, UmbEmbeddedMediaModalResult, UmbExamineFieldsSettingsModalData, UmbExportDictionaryModalData, UmbExportDictionaryModalResult, UmbFolderModalData, UmbFolderModalResult, UmbIconPickerModalData, UmbIconPickerModalResult, UmbImportDictionaryModalData, UmbImportDictionaryModalResult, UmbLanguagePickerModalData, UmbLanguagePickerModalResult, UmbLinkPickerConfig, UmbLinkPickerLink, UmbLinkPickerModalData, UmbLinkPickerModalResult, UmbMediaPickerModalData, UmbMediaPickerModalResult, UmbModalConfig, UmbModalContext, UmbModalHandler, UmbModalHandlerClass, UmbModalRouteBuilder, UmbModalRouteRegistration, UmbModalRouteRegistrationController, UmbModalToken, UmbModalType, UmbPickerModalData, UmbPickerModalResult, UmbPropertyEditorUIPickerModalData, UmbPropertyEditorUIPickerModalResult, UmbPropertySettingsModalResult, UmbSectionPickerModalData, UmbTemplateModalData, UmbTemplateModalResult, UmbTemplatePickerModalData, UmbTemplatePickerModalResult, UmbUserPickerModalData, UmbUserPickerModalResult };
+export { OEmbedResult, OEmbedStatus, UMB_ALLOWED_DOCUMENT_TYPES_MODAL, UMB_CHANGE_PASSWORD_MODAL, UMB_CONFIRM_MODAL, UMB_CONTEXT_DEBUGGER_MODAL, UMB_CREATE_DICTIONARY_MODAL, UMB_CREATE_USER_MODAL, UMB_CURRENT_USER_MODAL, UMB_DATA_TYPE_PICKER_MODAL, UMB_DICTIONARY_ITEM_PICKER_MODAL, UMB_DICTIONARY_ITEM_PICKER_MODAL_ALIAS, UMB_DOCUMENT_PICKER_MODAL, UMB_DOCUMENT_TYPE_PICKER_MODAL, UMB_EMBEDDED_MEDIA_MODAL, UMB_EXAMINE_FIELDS_SETTINGS_MODAL, UMB_EXPORT_DICTIONARY_MODAL, UMB_FOLDER_MODAL, UMB_ICON_PICKER_MODAL, UMB_IMPORT_DICTIONARY_MODAL, UMB_INVITE_USER_MODAL, UMB_LANGUAGE_PICKER_MODAL, UMB_LINK_PICKER_MODAL, UMB_MEDIA_TREE_PICKER_MODAL, UMB_MODAL_CONTEXT_TOKEN, UMB_PARTIAL_VIEW_PICKER_MODAL, UMB_PARTIAL_VIEW_PICKER_MODAL_ALIAS, UMB_PROPERTY_EDITOR_UI_PICKER_MODAL, UMB_PROPERTY_SETTINGS_MODAL, UMB_SEARCH_MODAL, UMB_SECTION_PICKER_MODAL, UMB_TEMPLATE_MODAL, UMB_TEMPLATE_PICKER_MODAL, UMB_USER_GROUP_PICKER_MODAL, UMB_USER_PICKER_MODAL, UmbAllowedDocumentTypesModalData, UmbAllowedDocumentTypesModalResult, UmbChangePasswordModalData, UmbConfirmModalData, UmbConfirmModalResult, UmbContextDebuggerModalData, UmbCreateDictionaryModalData, UmbCreateDictionaryModalResult, UmbCreateDocumentModalResultData, UmbDataTypePickerModalData, UmbDataTypePickerModalResult, UmbDictionaryItemPickerModalData, UmbDictionaryItemPickerModalResult, UmbDocumentPickerModalData, UmbDocumentPickerModalResult, UmbDocumentTypePickerModalData, UmbDocumentTypePickerModalResult, UmbEmbeddedMediaModalData, UmbEmbeddedMediaModalResult, UmbExamineFieldsSettingsModalData, UmbExportDictionaryModalData, UmbExportDictionaryModalResult, UmbFolderModalData, UmbFolderModalResult, UmbIconPickerModalData, UmbIconPickerModalResult, UmbImportDictionaryModalData, UmbImportDictionaryModalResult, UmbLanguagePickerModalData, UmbLanguagePickerModalResult, UmbLinkPickerConfig, UmbLinkPickerLink, UmbLinkPickerModalData, UmbLinkPickerModalResult, UmbMediaTreePickerModalData, UmbMediaTreePickerModalResult, UmbModalConfig, UmbModalContext, UmbModalHandler, UmbModalHandlerClass, UmbModalRouteBuilder, UmbModalRouteRegistration, UmbModalRouteRegistrationController, UmbModalToken, UmbModalType, UmbPartialViewPickerModalData, UmbPartialViewPickerModalResult, UmbPickerModalData, UmbPickerModalResult, UmbPropertyEditorUIPickerModalData, UmbPropertyEditorUIPickerModalResult, UmbPropertySettingsModalResult, UmbSectionPickerModalData, UmbSectionPickerModalResult, UmbTemplateModalData, UmbTemplateModalResult, UmbTemplatePickerModalData, UmbTemplatePickerModalResult, UmbTreePickerModalData, UmbUserPickerModalData, UmbUserPickerModalResult };

package/models.d.ts

@@ -1,5 +1,3 @@
-type HTMLElementConstructor<T = HTMLElement> = new (...args: any[]) => T;
-type ClassConstructor<T> = new (...args: any[]) => T;
 /** Tried to find a common base of our entities — used by Entity Workspace Context */
 type UmbEntityBase = {
     id?: string;
@@ -9,5 +7,11 @@ interface UmbSwatchDetails {
     label: string;
     value: string;
 }
+interface ServertimeOffset {
+    /**
+     * offset in minutes relative to UTC
+     */
+    offset: number;
+}
 
-export { ClassConstructor, HTMLElementConstructor, UmbEntityBase, UmbSwatchDetails };
+export { ServertimeOffset, UmbEntityBase, UmbSwatchDetails };