@umbraco-cms/backoffice 1.0.0-next.2a93cc95 → 1.0.0-next.2b5fb899

package/modal.d.ts

@@ -1,20 +1,24 @@
 import * as rxjs from 'rxjs';
-import * as lit_html from 'lit-html';
+import { Observable } from 'rxjs';
 import * as lit from 'lit';
-import { LitElement } from 'lit';
-import { UUIModalSidebarElement, UUIModalSidebarSize } from '@umbraco-ui/uui-modal-sidebar';
-import { UUIModalDialogElement } from '@umbraco-ui/uui-modal-dialog';
-import { UmbControllerHostInterface } from './controller';
-import { UmbContextToken } from './context-api';
+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 { 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';
 
 declare class UmbSearchModalElement extends LitElement {
     #private;
-    static styles: lit.CSSResult[];
     private _input;
     private _search;
     private _groups;
     connectedCallback(): void;
     render(): lit_html.TemplateResult<1>;
+    static styles: lit.CSSResult[];
 }
 
 declare global {
@@ -23,7 +27,7 @@ declare global {
     }
 }
 
-declare class UmbModalToken<Data = unknown, Result = unknown> {
+declare class UmbModalToken<Data extends object = object, Result = unknown> {
     protected alias: string;
     protected defaultConfig?: UmbModalConfig | undefined;
     protected _desc?: string | undefined;
@@ -68,7 +72,7 @@ declare class UmbModalToken<Data = unknown, Result = unknown> {
 /**
  * Type which omits the real submit method, and replaces it with a submit method which accepts an optional argument depending on the generic type.
  */
-type UmbModalHandler<ModalData = unknown, ModalResult = unknown> = Omit<UmbModalHandlerClass<ModalData, ModalResult>, 'submit'> & OptionalSubmitArgumentIfUndefined<ModalResult>;
+type UmbModalHandler<ModalData extends object = object, ModalResult = any> = Omit<UmbModalHandlerClass<ModalData, ModalResult>, 'submit'> & OptionalSubmitArgumentIfUndefined<ModalResult>;
 type OptionalSubmitArgumentIfUndefined<T> = T extends undefined ? {
     submit: () => void;
 } : T extends unknown ? {
@@ -76,17 +80,17 @@ type OptionalSubmitArgumentIfUndefined<T> = T extends undefined ? {
 } : {
     submit: (arg: T) => void;
 };
-declare class UmbModalHandlerClass<ModalData, ModalResult> {
+declare class UmbModalHandlerClass<ModalData extends object = object, ModalResult = unknown> {
     #private;
     private _submitPromise;
     private _submitResolver?;
     private _submitRejecter?;
     modalElement: UUIModalDialogElement | UUIModalSidebarElement;
-    readonly innerElement: rxjs.Observable<any>;
+    readonly innerElement: rxjs.Observable<HTMLElement | undefined>;
     key: string;
     type: UmbModalType;
     size: UUIModalSidebarSize;
-    constructor(host: UmbControllerHostInterface, modalAlias: string | UmbModalToken<ModalData, ModalResult>, data?: ModalData, config?: UmbModalConfig);
+    constructor(host: UmbControllerHostElement, modalAlias: string | UmbModalToken<ModalData, ModalResult>, data?: ModalData, config?: UmbModalConfig);
     private submit;
     reject(): void;
     onSubmit(): Promise<ModalResult>;
@@ -100,9 +104,9 @@ interface UmbModalConfig {
 }
 declare class UmbModalContext {
     #private;
-    host: UmbControllerHostInterface;
-    readonly modals: rxjs.Observable<UmbModalHandler<any, any>[]>;
-    constructor(host: UmbControllerHostInterface);
+    host: UmbControllerHostElement;
+    readonly modals: rxjs.Observable<UmbModalHandler[]>;
+    constructor(host: UmbControllerHostElement);
     search(): UmbModalHandler<any, any>;
     /**
      * Opens a modal or sidebar modal
@@ -112,7 +116,7 @@ declare class UmbModalContext {
      * @return {*}  {UmbModalHandler}
      * @memberof UmbModalContext
      */
-    open<ModalData = unknown, 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): UmbModalHandler<ModalData, ModalResult>;
     /**
      * Closes a modal or sidebar modal
      * @private
@@ -123,13 +127,294 @@ declare class UmbModalContext {
 }
 declare const UMB_MODAL_CONTEXT_TOKEN: UmbContextToken<UmbModalContext>;
 
+type UmbModalRouteBuilder = (params: {
+    [key: string]: string | number;
+}) => string;
+declare class UmbModalRouteRegistration<UmbModalTokenData extends object = object, UmbModalTokenResult = any> {
+    #private;
+    constructor(modalAlias: UmbModalToken<UmbModalTokenData, UmbModalTokenResult> | string, path: string, modalConfig?: UmbModalConfig);
+    get key(): string;
+    get alias(): string | UmbModalToken<UmbModalTokenData, UmbModalTokenResult>;
+    get path(): string;
+    protected _setPath(path: string): void;
+    get modalConfig(): UmbModalConfig | undefined;
+    /**
+     * Returns true if the modal is currently active.
+     */
+    get active(): boolean;
+    open(params: {
+        [key: string]: string | number;
+    }): void;
+    /**
+     * Returns the modal handler if the modal is currently active. Otherwise its undefined.
+     */
+    get modalHandler(): UmbModalHandler<UmbModalTokenData, UmbModalTokenResult> | undefined;
+    observeRouteBuilder(callback: (urlBuilder: UmbModalRouteBuilder) => void): this;
+    _internal_setRouteBuilder(urlBuilder: UmbModalRouteBuilder): void;
+    onSetup(callback: (routingInfo: Params) => UmbModalTokenData | false): this;
+    onSubmit(callback: (data: UmbModalTokenResult) => void): this;
+    onReject(callback: () => void): this;
+    routeSetup(modalContext: UmbModalContext, params: Params): UmbModalHandler<UmbModalTokenData, UmbModalTokenResult> | null;
+}
+
+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;
+    hostConnected(): void;
+    hostDisconnected(): void;
+    destroy(): void;
+}
+
+interface UmbAllowedDocumentTypesModalData {
+    id: string | null;
+}
+interface UmbAllowedDocumentTypesModalResult {
+    documentTypeKey: string;
+}
+declare const UMB_ALLOWED_DOCUMENT_TYPES_MODAL: UmbModalToken$1<UmbAllowedDocumentTypesModalData, UmbAllowedDocumentTypesModalResult>;
+
+interface UmbChangePasswordModalData {
+    requireOldPassword: boolean;
+}
+declare const UMB_CHANGE_PASSWORD_MODAL: UmbModalToken$1<UmbChangePasswordModalData, unknown>;
+
+interface UmbConfirmModalData {
+    headline: string;
+    content: TemplateResult | string;
+    color?: 'positive' | 'danger';
+    confirmLabel?: string;
+}
+type UmbConfirmModalResult = undefined;
+declare const UMB_CONFIRM_MODAL: UmbModalToken$1<UmbConfirmModalData, undefined>;
+
+interface UmbCreateDictionaryModalData {
+    unique: string | null;
+    parentName?: Observable<string | undefined>;
+}
+interface UmbCreateDictionaryModalResult {
+    name?: string;
+}
+declare const UMB_CREATE_DICTIONARY_MODAL: UmbModalToken$1<UmbCreateDictionaryModalData, UmbCreateDictionaryModalResult>;
+
+declare const UMB_CREATE_USER_MODAL: UmbModalToken$1<object, unknown>;
+
+declare const UMB_CURRENT_USER_MODAL: UmbModalToken$1<object, unknown>;
+
+interface UmbContextDebuggerModalData {
+    content: TemplateResult | string;
+}
+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>;
+
+interface UmbDocumentTypePickerModalData {
+    multiple?: boolean;
+    selection?: Array<string>;
+}
+interface UmbDocumentTypePickerModalResult {
+    selection: Array<string | null>;
+}
+declare const UMB_DOCUMENT_TYPE_PICKER_MODAL: UmbModalToken$1<UmbDocumentTypePickerModalData, UmbDocumentTypePickerModalResult>;
+
+declare enum OEmbedStatus {
+    NotSupported = 0,
+    Error = 1,
+    Success = 2
+}
+interface UmbEmbeddedMediaDimensions {
+    width?: number;
+    height?: number;
+    constrain?: boolean;
+}
+interface UmbEmbeddedMediaModalData extends UmbEmbeddedMediaDimensions {
+    url?: string;
+}
+interface OEmbedResult extends UmbEmbeddedMediaDimensions {
+    oEmbedStatus: OEmbedStatus;
+    supportsDimensions: boolean;
+    markup?: string;
+}
+type UmbEmbeddedMediaModalResult = {
+    selection: OEmbedResult;
+};
+declare const UMB_EMBEDDED_MEDIA_MODAL: UmbModalToken$1<UmbEmbeddedMediaModalData, UmbEmbeddedMediaModalResult>;
+
+type UmbExamineFieldsSettingsModalData = Array<{
+    name: string;
+    exposed: boolean;
+}>;
+interface UmbCreateDocumentModalResultData {
+    fields?: UmbExamineFieldsSettingsModalData;
+}
+declare const UMB_EXAMINE_FIELDS_SETTINGS_MODAL: UmbModalToken$1<UmbExamineFieldsSettingsModalData, UmbCreateDocumentModalResultData>;
+
+interface UmbExportDictionaryModalData {
+    unique: string | null;
+}
+interface UmbExportDictionaryModalResult {
+    includeChildren?: boolean;
+}
+declare const UMB_EXPORT_DICTIONARY_MODAL: UmbModalToken$1<UmbExportDictionaryModalData, UmbExportDictionaryModalResult>;
+
+interface UmbIconPickerModalData {
+    color: string | undefined;
+    icon: string | undefined;
+}
+interface UmbIconPickerModalResult {
+    color: string | undefined;
+    icon: string | undefined;
+}
+declare const UMB_ICON_PICKER_MODAL: UmbModalToken$1<UmbIconPickerModalData, UmbIconPickerModalResult>;
+
+interface UmbImportDictionaryModalData {
+    unique: string | null;
+}
+interface UmbImportDictionaryModalResult {
+    temporaryFileId?: string;
+    parentId?: string;
+}
+declare const UMB_IMPORT_DICTIONARY_MODAL: UmbModalToken$1<UmbImportDictionaryModalData, UmbImportDictionaryModalResult>;
+
+declare const UMB_INVITE_USER_MODAL: UmbModalToken$1<object, unknown>;
+
+interface UmbLanguagePickerModalData {
+    multiple?: boolean;
+    selection?: Array<string>;
+    filter?: (language: LanguageResponseModel) => boolean;
+}
+interface UmbLanguagePickerModalResult {
+    selection: Array<string>;
+}
+declare const UMB_LANGUAGE_PICKER_MODAL: UmbModalToken$1<UmbLanguagePickerModalData, UmbLanguagePickerModalResult>;
+
+interface UmbLinkPickerModalData {
+    index: number | null;
+    link: UmbLinkPickerLink;
+    config: UmbLinkPickerConfig;
+}
+type UmbLinkPickerModalResult = {
+    index: number | null;
+    link: UmbLinkPickerLink;
+};
+interface UmbLinkPickerLink {
+    icon?: string | null;
+    name?: string | null;
+    published?: boolean | null;
+    queryString?: string | null;
+    target?: string | null;
+    trashed?: boolean | null;
+    udi?: string | null;
+    url?: string | null;
+}
+interface UmbLinkPickerConfig {
+    hideAnchor?: boolean;
+    ignoreUserStartNodes?: boolean;
+    overlaySize?: UUIModalSidebarSize;
+}
+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>;
+
+interface UmbPropertyEditorUIPickerModalData {
+    selection?: Array<string>;
+    submitLabel?: string;
+}
+type UmbPropertyEditorUIPickerModalResult = {
+    selection: Array<string>;
+};
+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>;
+
+declare const UMB_SEARCH_MODAL: UmbModalToken$1<object, unknown>;
+
+interface UmbSectionPickerModalData {
+    multiple: boolean;
+    selection: string[];
+}
+declare const UMB_SECTION_PICKER_MODAL: UmbModalToken$1<UmbSectionPickerModalData, unknown>;
+
+interface UmbTemplateModalData {
+    id: string;
+    language?: 'razor' | 'typescript' | 'javascript' | 'css' | 'markdown' | 'json' | 'html';
+}
+interface UmbTemplateModalResult {
+    id: string;
+}
+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>;
+
+declare const UMB_USER_GROUP_PICKER_MODAL: UmbModalToken$1<UmbPickerModalData$1<UserDetails>, unknown>;
+
+type UmbUserPickerModalData = UmbPickerModalData$1<UserResponseModel>;
+interface UmbUserPickerModalResult {
+    selection: Array<string>;
+}
+declare const UMB_USER_PICKER_MODAL: UmbModalToken$1<UmbUserPickerModalData, UmbUserPickerModalResult>;
+
+interface UmbFolderModalData {
+    repositoryAlias: string;
+    unique?: string;
+}
+interface UmbFolderModalResult {
+    folder: FolderReponseModel;
+}
+declare const UMB_FOLDER_MODAL: UmbModalToken$1<UmbFolderModalData, UmbFolderModalResult>;
+
+interface UmbDataTypePickerModalData {
+    selection?: Array<string | null>;
+    multiple?: boolean;
+}
+interface UmbDataTypePickerModalResult {
+    selection: Array<string | null>;
+}
+declare const UMB_DATA_TYPE_PICKER_MODAL: UmbModalToken$1<UmbDataTypePickerModalData, UmbDataTypePickerModalResult>;
+
 interface UmbPickerModalData<T> {
     multiple: boolean;
     selection: Array<string>;
-    filter?: (language: T) => boolean;
+    filter?: (item: T) => boolean;
 }
-interface UmbPickerModalResult<T> {
+interface UmbPickerModalResult {
     selection: Array<string>;
 }
 
-export { UMB_MODAL_CONTEXT_TOKEN, UmbModalConfig, UmbModalContext, UmbModalHandler, UmbModalHandlerClass, UmbModalToken, UmbModalType, UmbPickerModalData, UmbPickerModalResult };
+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 };

package/models.d.ts

@@ -1,15 +1,20 @@
-import { EntityTreeItemResponseModel, FolderTreeItemResponseModel, PackageManifestResponseModel } from './backend-api';
+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 {
-    key: string;
+    id: string;
     name: string;
     icon: string;
     type: string;
     hasChildren: boolean;
-    parentKey: string | null;
+    parentId: string | null;
 }
+/** Tried to find a common base of our entities — used by Entity Workspace Context */
+type BaseEntity = {
+    id?: string;
+    name?: string;
+};
 interface UserEntity extends Entity {
     type: 'user';
 }
@@ -38,23 +43,23 @@ interface UserGroupDetails extends UserGroupEntity {
     permissions: Array<string>;
 }
 interface MemberTypeDetails extends EntityTreeItemResponseModel {
-    key: string;
+    id: string;
     alias: string;
     properties: [];
 }
 interface MediaTypeDetails extends FolderTreeItemResponseModel {
-    key: string;
+    id: string;
     alias: string;
     properties: [];
 }
 interface MemberGroupDetails extends EntityTreeItemResponseModel {
-    key: string;
+    id: string;
 }
 interface MemberDetails extends EntityTreeItemResponseModel {
-    key: string;
+    id: string;
 }
 interface DocumentBlueprintDetails {
-    key: string;
+    id: string;
     name: string;
     type: 'document-blueprint';
     properties: Array<any>;
@@ -71,5 +76,22 @@ type PackageManifestResponse = UmbPackage[];
 type UmbPackageWithMigrationStatus = UmbPackage & {
     hasPendingMigrations: boolean;
 };
+interface UmbFilterModel {
+    skip?: number;
+    take?: number;
+    filter?: string;
+}
+interface UmbTreeRootModel {
+    type: string;
+    name: string;
+    hasChildren: boolean;
+    icon?: string;
+}
+interface UmbTreeRootEntityModel extends UmbTreeRootModel {
+    id: string | null;
+}
+interface UmbTreeRootFileSystemModel extends UmbTreeRootModel {
+    path: string | null;
+}
 
-export { ClassConstructor, DocumentBlueprintDetails, Entity, HTMLElementConstructor, MediaTypeDetails, MemberDetails, MemberGroupDetails, MemberTypeDetails, PackageManifestResponse, SwatchDetails, UmbPackage, UmbPackageWithMigrationStatus, UserDetails, UserEntity, UserGroupDetails, UserGroupEntity, UserStatus };
+export { BaseEntity, ClassConstructor, DocumentBlueprintDetails, Entity, HTMLElementConstructor, MediaTypeDetails, MemberDetails, MemberGroupDetails, MemberTypeDetails, PackageManifestResponse, SwatchDetails, UmbFilterModel, UmbPackage, UmbPackageWithMigrationStatus, UmbTreeRootEntityModel, UmbTreeRootFileSystemModel, UmbTreeRootModel, UserDetails, UserEntity, UserGroupDetails, UserGroupEntity, UserStatus };

package/notification.d.ts

@@ -1,5 +1,5 @@
 import * as rxjs from 'rxjs';
-import { UmbContextToken } from './context-api';
+import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
 
 /**
  * @export