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

package/modal.d.ts

@@ -4,12 +4,117 @@ 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 { UmbController, 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 { UserDetails } from '@umbraco-cms/backoffice/models';
+import { Params as Params$1 } from '@umbraco-cms/backoffice/router';
+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, PropertyTypeResponseModelBaseModel, UserResponseModel, FolderReponseModel, FolderTreeItemResponseModel } from '@umbraco-cms/backoffice/backend-api';
+
+interface IRouterSlot<D = any, P = any> extends HTMLElement {
+    readonly route: IRoute<D> | null;
+    readonly isRoot: boolean;
+    readonly fragments: IPathFragments | null;
+    readonly params: Params | null;
+    readonly match: IRouteMatch<D> | null;
+    routes: IRoute<D>[];
+    add: ((routes: IRoute<D>[], navigate?: boolean) => void);
+    clear: (() => void);
+    render: (() => Promise<void>);
+    constructAbsolutePath: ((path: PathFragment) => string);
+    parent: IRouterSlot<P> | null | undefined;
+    queryParentRouterSlot: (() => IRouterSlot<P> | null);
+}
+type IRoutingInfo<D = any, P = any> = {
+    slot: IRouterSlot<D, P>;
+    match: IRouteMatch<D>;
+};
+type CustomResolver<D = any, P = any> = ((info: IRoutingInfo<D>) => boolean | void | Promise<boolean> | Promise<void>);
+type Guard<D = any, P = any> = ((info: IRoutingInfo<D, P>) => boolean | Promise<boolean>);
+type PageComponent = HTMLElement | undefined;
+type ModuleResolver = Promise<{
+    default: any;
+}>;
+type Class<T extends PageComponent = PageComponent> = {
+    new (...args: any[]): T;
+};
+type Component = Class | ModuleResolver | PageComponent | (() => Class) | (() => PromiseLike<Class>) | (() => PageComponent) | (() => PromiseLike<PageComponent>) | (() => ModuleResolver) | (() => PromiseLike<ModuleResolver>);
+type Setup<D = any> = ((component: PageComponent, info: IRoutingInfo<D>) => void);
+type PathMatch = "prefix" | "suffix" | "full" | "fuzzy";
+/**
+ * The base route interface.
+ * D = the data type of the data
+ */
+interface IRouteBase<D = any> {
+    path: PathFragment;
+    data?: D;
+    guards?: Guard[];
+    pathMatch?: PathMatch;
+}
+/**
+ * Route type used for redirection.
+ */
+interface IRedirectRoute<D = any> extends IRouteBase<D> {
+    redirectTo: string;
+    preserveQuery?: boolean;
+}
+/**
+ * Route type used to resolve and stamp components.
+ */
+interface IComponentRoute<D = any> extends IRouteBase<D> {
+    component: Component | PromiseLike<Component>;
+    setup?: Setup;
+}
+/**
+ * Route type used to take control of how the route should resolve.
+ */
+interface IResolverRoute<D = any> extends IRouteBase<D> {
+    resolve: CustomResolver;
+}
+type IRoute<D = any> = IRedirectRoute<D> | IComponentRoute<D> | IResolverRoute<D>;
+type PathFragment = string;
+type IPathFragments = {
+    consumed: PathFragment;
+    rest: PathFragment;
+};
+interface IRouteMatch<D = any> {
+    route: IRoute<D>;
+    params: Params;
+    fragments: IPathFragments;
+    match: RegExpMatchArray;
+}
+type PushStateEvent = CustomEvent<null>;
+type ReplaceStateEvent = CustomEvent<null>;
+type ChangeStateEvent = CustomEvent<null>;
+type WillChangeStateEvent = CustomEvent<{
+    url?: string | null;
+    eventName: GlobalRouterEvent;
+}>;
+type NavigationStartEvent<D = any> = CustomEvent<IRoutingInfo<D>>;
+type NavigationSuccessEvent<D = any> = CustomEvent<IRoutingInfo<D>>;
+type NavigationCancelEvent<D = any> = CustomEvent<IRoutingInfo<D>>;
+type NavigationErrorEvent<D = any> = CustomEvent<IRoutingInfo<D>>;
+type NavigationEndEvent<D = any> = CustomEvent<IRoutingInfo<D>>;
+type Params = {
+    [key: string]: string;
+};
+/**
+ * History related events.
+ */
+type GlobalRouterEvent = "pushstate" | "replacestate" | "popstate" | "changestate" | "willchangestate" | "navigationstart" | "navigationcancel" | "navigationerror" | "navigationsuccess" | "navigationend";
+declare global {
+    interface GlobalEventHandlersEventMap {
+        "pushstate": PushStateEvent;
+        "replacestate": ReplaceStateEvent;
+        "popstate": PopStateEvent;
+        "changestate": ChangeStateEvent;
+        "navigationstart": NavigationStartEvent;
+        "navigationend": NavigationEndEvent;
+        "navigationsuccess": NavigationSuccessEvent;
+        "navigationcancel": NavigationCancelEvent;
+        "navigationerror": NavigationErrorEvent;
+        "willchangestate": WillChangeStateEvent;
+    }
+}
 
 declare class UmbSearchModalElement extends LitElement {
     #private;
@@ -27,38 +132,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.
@@ -67,6 +170,7 @@ declare class UmbModalToken<Data extends object = object, Result = unknown> {
      */
     toString(): string;
     getDefaultConfig(): UmbModalConfig | undefined;
+    getDefaultData(): ModalDataType | undefined;
 }
 
 /**
@@ -80,7 +184,7 @@ type OptionalSubmitArgumentIfUndefined<T> = T extends undefined ? {
 } : {
     submit: (arg: T) => void;
 };
-declare class UmbModalHandlerClass<ModalData extends object = object, ModalResult = unknown> {
+declare class UmbModalHandlerClass<ModalData extends object = object, ModalResult = unknown> extends UmbController {
     #private;
     private _submitPromise;
     private _submitResolver?;
@@ -90,10 +194,14 @@ declare class UmbModalHandlerClass<ModalData extends object = object, ModalResul
     key: string;
     type: UmbModalType;
     size: UUIModalSidebarSize;
-    constructor(host: UmbControllerHostElement, modalAlias: string | UmbModalToken<ModalData, ModalResult>, data?: ModalData, config?: UmbModalConfig);
+    private modalAlias;
+    constructor(host: UmbControllerHostElement, router: IRouterSlot | null, modalAlias: string | UmbModalToken<ModalData, ModalResult>, data?: ModalData, config?: UmbModalConfig);
+    hostConnected(): void;
+    hostDisconnected(): void;
     private submit;
     reject(): void;
     onSubmit(): Promise<ModalResult>;
+    destroy(): void;
 }
 
 type UmbModalType = 'dialog' | 'sidebar';
@@ -116,7 +224,7 @@ declare class UmbModalContext {
      * @return {*}  {UmbModalHandler}
      * @memberof UmbModalContext
      */
-    open<ModalData extends object = object, ModalResult = unknown>(modalAlias: string | UmbModalToken<ModalData, ModalResult>, data?: ModalData, config?: UmbModalConfig): UmbModalHandler<ModalData, ModalResult>;
+    open<ModalData extends object = object, ModalResult = unknown>(modalAlias: string | UmbModalToken<ModalData, ModalResult>, data?: ModalData, config?: UmbModalConfig, router?: IRouterSlot | null): UmbModalHandler<ModalData, ModalResult>;
     /**
      * Closes a modal or sidebar modal
      * @private
@@ -129,14 +237,15 @@ declare const UMB_MODAL_CONTEXT_TOKEN: UmbContextToken<UmbModalContext>;
 
 type UmbModalRouteBuilder = (params: {
     [key: string]: string | number;
-}) => string;
+} | null) => string;
 declare class UmbModalRouteRegistration<UmbModalTokenData extends object = object, UmbModalTokenResult = any> {
     #private;
-    constructor(modalAlias: UmbModalToken<UmbModalTokenData, UmbModalTokenResult> | string, path: string, modalConfig?: UmbModalConfig);
+    constructor(modalAlias: UmbModalToken<UmbModalTokenData, UmbModalTokenResult> | string, path?: string | null, modalConfig?: UmbModalConfig);
     get key(): string;
     get alias(): string | UmbModalToken<UmbModalTokenData, UmbModalTokenResult>;
-    get path(): string;
-    protected _setPath(path: string): void;
+    generateModalPath(): string;
+    get path(): string | null;
+    protected _setPath(path: string | null): void;
     get modalConfig(): UmbModalConfig | undefined;
     /**
      * Returns true if the modal is currently active.
@@ -151,18 +260,75 @@ declare class UmbModalRouteRegistration<UmbModalTokenData extends object = objec
     get modalHandler(): UmbModalHandler<UmbModalTokenData, UmbModalTokenResult> | undefined;
     observeRouteBuilder(callback: (urlBuilder: UmbModalRouteBuilder) => void): this;
     _internal_setRouteBuilder(urlBuilder: UmbModalRouteBuilder): void;
-    onSetup(callback: (routingInfo: Params) => UmbModalTokenData | false): this;
+    onSetup(callback: (routingInfo: Params$1) => UmbModalTokenData | false): this;
     onSubmit(callback: (data: UmbModalTokenResult) => void): this;
     onReject(callback: () => void): this;
-    routeSetup(modalContext: UmbModalContext, params: Params): UmbModalHandler<UmbModalTokenData, UmbModalTokenResult> | null;
+    routeSetup(router: IRouterSlot, modalContext: UmbModalContext, params: Params$1): UmbModalHandler<UmbModalTokenData, UmbModalTokenResult> | null | undefined;
 }
 
 declare class UmbModalRouteRegistrationController<D extends object = object, R = any> extends UmbModalRouteRegistration<D, R> implements UmbControllerInterface {
     #private;
     get unique(): undefined;
-    constructor(host: UmbControllerHostElement, alias: UmbModalToken$1<D, R> | string, path: string, uniqueParts?: Map<string, string | undefined> | null, modalConfig?: UmbModalConfig$1);
-    setUniqueIdentifier(identifier: string, value: string | undefined): void;
-    private _registererModal;
+    /**
+     * Creates an instance of UmbModalRouteRegistrationController.
+     * @param {EventTarget} host - The host element of the modal, this is used to identify the modal.
+     * @param {UmbModalToken} alias - The alias of the modal, this is used to identify the modal.
+     * @param {UmbModalConfig} modalConfig - The configuration of the modal.
+     * @memberof UmbModalRouteRegistrationController
+     */
+    constructor(host: UmbControllerHostElement, alias: UmbModalToken$1<D, R> | string, modalConfig?: UmbModalConfig$1);
+    /**
+     * Appends an additional path to the modal route.
+     *
+     * This can help specify the URL for this modal, or used to add a parameter to the URL like this: "/modal/my-modal/:index/"
+     * A folder name starting with a colon ":" will be interpreted as a parameter. Then this modal can open with any value in that location.
+     * When modal is being setup the value of the parameter can be read from the route params. See the example:
+     * @param additionalPath
+     * @returns UmbModalRouteRegistrationController
+     * @memberof UmbContextConsumer
+     * @example <caption>Example of adding an additional path to the modal route</caption>
+     * const modalRegistration = new UmbModalRouteRegistrationController(this, MY_MODAL_TOKEN)
+     * modalRegistration.addAdditionalPath(':index')
+     *
+     * modalRegistration.onSetup((params) => {
+     * 	const index = params.index;
+     *  // When entering the url of: "/modal/my-modal/hello-world/"
+     *  // Then index will be "hello-world"
+     * }
+     */
+    addAdditionalPath(additionalPath: string): this;
+    /**
+     * Registerer one or more additional paths to the modal route, similar to addAdditionalPath. But without defining the actual path name. This enables this to be asynchronously defined and even changed later.
+     * This can be useful if your modal has to be unique for this registration, avoiding collision with other registrations.
+     * If you made a modal for editing one of multiple property, then you can add a unique path holding the property id.
+     * Making the URL unique to this modal registration: /modal/my-modal/my-unique-value/
+     *
+     * Notice the modal will only be available when all unique paths have a value.
+     * @param {Array<string>} uniquePathNames
+     * @returns UmbModalRouteRegistrationController
+     * @memberof UmbContextConsumer
+     * @example <caption>Example of adding an additional unique path to the modal route</caption>
+     * const modalRegistration = new UmbModalRouteRegistrationController(this, MY_MODAL_TOKEN)
+     * modalRegistration.addUniquePaths(['myAliasForIdentifyingThisPartOfThePath'])
+     *
+     * // Later:
+     * modalRegistration.setUniquePathValue('myAliasForIdentifyingThisPartOfThePath', 'myValue');
+     */
+    addUniquePaths(uniquePathNames: Array<string>): this;
+    /**
+     * Set or change the value of a unique path part.
+     * @param {string} identifier
+     * @param {value | undefined} value
+     * @returns UmbModalRouteRegistrationController
+     * @memberof UmbContextConsumer
+     * @example <caption>Example of adding an additional unique path to the modal route</caption>
+     * const modalRegistration = new UmbModalRouteRegistrationController(this, MY_MODAL_TOKEN)
+     * modalRegistration.addUniquePaths(['first-one', 'another-one'])
+     *
+     * // Later:
+     * modalRegistration.setUniquePathValue('first-one', 'myValue');
+     */
+    setUniquePathValue(identifier: string, value: string | undefined): void;
     hostConnected(): void;
     hostDisconnected(): void;
     destroy(): void;
@@ -208,23 +374,13 @@ interface UmbContextDebuggerModalData {
 }
 declare const UMB_CONTEXT_DEBUGGER_MODAL: UmbModalToken$1<UmbContextDebuggerModalData, unknown>;
 
-interface UmbDocumentPickerModalData {
-    multiple?: boolean;
-    selection?: Array<string>;
-}
-interface UmbDocumentPickerModalResult {
-    selection: Array<string>;
-}
-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>;
-}
-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,
@@ -289,11 +445,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>;
 
@@ -323,14 +479,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>;
-}
-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>;
@@ -341,28 +492,20 @@ type UmbPropertyEditorUIPickerModalResult = {
 };
 declare const UMB_PROPERTY_EDITOR_UI_PICKER_MODAL: UmbModalToken$1<UmbPropertyEditorUIPickerModalData, UmbPropertyEditorUIPickerModalResult>;
 
-interface UmbPropertySettingsModalResult {
-    label: string;
-    alias: string;
-    description: string;
-    propertyEditorUI?: string;
-    labelOnTop: boolean;
-    validation: {
-        mandatory: boolean;
-        mandatoryMessage: string;
-        pattern: string;
-        patternMessage: string;
-    };
-}
-declare const UMB_PROPERTY_SETTINGS_MODAL: UmbModalToken$1<object, UmbPropertySettingsModalResult>;
+type UmbPropertySettingsModalData = PropertyTypeResponseModelBaseModel;
+type UmbPropertySettingsModalResult = PropertyTypeResponseModelBaseModel;
+declare const UMB_PROPERTY_SETTINGS_MODAL: UmbModalToken$1<PropertyTypeResponseModelBaseModel, PropertyTypeResponseModelBaseModel>;
 
 declare const UMB_SEARCH_MODAL: UmbModalToken$1<object, unknown>;
 
 interface UmbSectionPickerModalData {
     multiple: boolean;
-    selection: string[];
+    selection: Array<string | null>;
+}
+interface UmbSectionPickerModalResult {
+    selection: Array<string | null>;
 }
-declare const UMB_SECTION_PICKER_MODAL: UmbModalToken$1<UmbSectionPickerModalData, unknown>;
+declare const UMB_SECTION_PICKER_MODAL: UmbModalToken$1<UmbSectionPickerModalData, UmbSectionPickerModalResult>;
 
 interface UmbTemplateModalData {
     id: string;
@@ -373,20 +516,15 @@ interface UmbTemplateModalResult {
 }
 declare const UMB_TEMPLATE_MODAL: UmbModalToken$1<UmbTemplateModalData, UmbTemplateModalResult>;
 
-interface UmbTemplatePickerModalData {
-    multiple: boolean;
-    selection: string[];
-}
-interface UmbTemplatePickerModalResult {
-    selection: string[] | undefined;
-}
-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<UserDetails>, unknown>;
+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>;
 
@@ -399,22 +537,50 @@ interface UmbFolderModalResult {
 }
 declare const UMB_FOLDER_MODAL: UmbModalToken$1<UmbFolderModalData, UmbFolderModalResult>;
 
-interface UmbDataTypePickerModalData {
-    selection?: Array<string>;
-    multiple?: boolean;
+interface UmbPartialViewPickerModalData {
+    multiple: boolean;
+    selection: string[];
 }
-interface UmbDataTypePickerModalResult {
-    selection: Array<string>;
+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>;
+}
+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 UmbDataTypePickerFlowModalData {
+    selection?: Array<string>;
+    submitLabel?: string;
+}
+type UmbDataTypePickerFlowModalResult = {
     selection: Array<string>;
-    filter?: (item: T) => boolean;
+};
+declare const UMB_DATA_TYPE_PICKER_FLOW_MODAL: UmbModalToken$1<UmbDataTypePickerFlowModalData, UmbDataTypePickerFlowModalResult>;
+
+interface UmbPickerModalData<ItemType> {
+    multiple?: boolean;
+    selection?: Array<string | null>;
+    filter?: (item: ItemType) => boolean;
+    pickableFilter?: (item: ItemType) => boolean;
 }
 interface UmbPickerModalResult {
-    selection: Array<string>;
+    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_FLOW_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, UmbDataTypePickerFlowModalData, UmbDataTypePickerFlowModalResult, 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, UmbPropertySettingsModalData, UmbPropertySettingsModalResult, UmbSectionPickerModalData, UmbSectionPickerModalResult, UmbTemplateModalData, UmbTemplateModalResult, UmbTemplatePickerModalData, UmbTemplatePickerModalResult, UmbTreePickerModalData, UmbUserPickerModalData, UmbUserPickerModalResult };

package/models.d.ts

@@ -1,85 +1,17 @@
-import { EntityTreeItemResponseModel, FolderTreeItemResponseModel, PackageManifestResponseModel } from '@umbraco-cms/backoffice/backend-api';
-
-type HTMLElementConstructor<T = HTMLElement> = new (...args: any[]) => T;
-type ClassConstructor<T> = new (...args: any[]) => T;
-interface Entity {
-    id: string;
-    name: string;
-    icon: string;
-    type: string;
-    hasChildren: boolean;
-    parentId: string | null;
-}
 /** Tried to find a common base of our entities — used by Entity Workspace Context */
-type BaseEntity = {
+type UmbEntityBase = {
     id?: string;
     name?: string;
 };
-interface UserEntity extends Entity {
-    type: 'user';
-}
-type UserStatus = 'enabled' | 'inactive' | 'invited' | 'disabled';
-interface UserDetails extends UserEntity {
-    email: string;
-    status: UserStatus;
-    language: string;
-    lastLoginDate?: string;
-    lastLockoutDate?: string;
-    lastPasswordChangeDate?: string;
-    updateDate: string;
-    createDate: string;
-    failedLoginAttempts: number;
-    userGroups: Array<string>;
-    contentStartNodes: Array<string>;
-    mediaStartNodes: Array<string>;
-}
-interface UserGroupEntity extends Entity {
-    type: 'user-group';
-}
-interface UserGroupDetails extends UserGroupEntity {
-    sections: Array<string>;
-    contentStartNode?: string;
-    mediaStartNode?: string;
-    permissions: Array<string>;
-}
-interface MemberTypeDetails extends EntityTreeItemResponseModel {
-    id: string;
-    alias: string;
-    properties: [];
-}
-interface MediaTypeDetails extends FolderTreeItemResponseModel {
-    id: string;
-    alias: string;
-    properties: [];
-}
-interface MemberGroupDetails extends EntityTreeItemResponseModel {
-    id: string;
-}
-interface MemberDetails extends EntityTreeItemResponseModel {
-    id: string;
-}
-interface DocumentBlueprintDetails {
-    id: string;
-    name: string;
-    type: 'document-blueprint';
-    properties: Array<any>;
-    data: Array<any>;
-    icon: string;
-    documentTypeKey: string;
-}
-interface SwatchDetails {
+interface UmbSwatchDetails {
     label: string;
     value: string;
 }
-type UmbPackage = PackageManifestResponseModel;
-type PackageManifestResponse = UmbPackage[];
-type UmbPackageWithMigrationStatus = UmbPackage & {
-    hasPendingMigrations: boolean;
-};
-interface UmbFilterModel {
-    skip?: number;
-    take?: number;
-    filter?: string;
+interface ServertimeOffset {
+    /**
+     * offset in minutes relative to UTC
+     */
+    offset: number;
 }
 
-export { BaseEntity, ClassConstructor, DocumentBlueprintDetails, Entity, HTMLElementConstructor, MediaTypeDetails, MemberDetails, MemberGroupDetails, MemberTypeDetails, PackageManifestResponse, SwatchDetails, UmbFilterModel, UmbPackage, UmbPackageWithMigrationStatus, UserDetails, UserEntity, UserGroupDetails, UserGroupEntity, UserStatus };
+export { ServertimeOffset, UmbEntityBase, UmbSwatchDetails };

package/observable-api.d.ts

@@ -1,10 +1,11 @@
 import * as rxjs from 'rxjs';
 import { Observable, BehaviorSubject } from 'rxjs';
-import { UmbControllerInterface, UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
+import { UmbControllerInterface, UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api';
 
 declare class UmbObserver<T> {
     #private;
     constructor(source: Observable<T>, callback: (_value: T) => void);
+    asPromise(): Promise<T>;
     hostConnected(): void;
     hostDisconnected(): void;
     destroy(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@umbraco-cms/backoffice",
-	"version": "1.0.0-next.93a8a0e4",
+	"version": "1.0.0-next.93ffdc6a",
 	"license": "MIT",
 	"keywords": [
 		"umbraco",
@@ -26,7 +26,7 @@
 	],
 	"peerDependencies": {
 		"@types/uuid": "^9.0.1",
-		"@umbraco-ui/uui": "^1.2.0-rc.0",
+		"@umbraco-ui/uui": "1.2.1",
 		"rxjs": "^7.8.0"
 	},
 	"customElements": "custom-elements.json"

package/picker-input.d.ts

@@ -1,7 +1,7 @@
 import * as rxjs from 'rxjs';
 import { UmbItemRepository } from '@umbraco-cms/backoffice/repository';
-import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
-import { UmbModalToken, UmbModalContext } from '@umbraco-cms/backoffice/modal';
+import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api';
+import { UmbModalToken, UmbModalContext, UmbPickerModalData } from '@umbraco-cms/backoffice/modal';
 import { ItemResponseModelBaseModel } from '@umbraco-cms/backoffice/backend-api';
 
 declare class UmbPickerInputContext<ItemType extends ItemResponseModelBaseModel> {
@@ -10,6 +10,7 @@ declare class UmbPickerInputContext<ItemType extends ItemResponseModelBaseModel>
     modalAlias: string | UmbModalToken;
     repository?: UmbItemRepository<ItemType>;
     modalContext?: UmbModalContext;
+    pickableFilter?: (item: ItemType) => boolean;
     selection: rxjs.Observable<string[]>;
     selectedItems: rxjs.Observable<ItemType[]>;
     max: number;
@@ -17,7 +18,7 @@ declare class UmbPickerInputContext<ItemType extends ItemResponseModelBaseModel>
     constructor(host: UmbControllerHostElement, repositoryAlias: string, modalAlias: string | UmbModalToken, getUniqueMethod?: (entry: ItemType) => string | undefined);
     getSelection(): string[];
     setSelection(selection: string[]): void;
-    openPicker(pickerData?: any): void;
+    openPicker(pickerData?: Partial<UmbPickerModalData<ItemType>>): void;
     requestRemoveItem(unique: string): Promise<void>;
 }