@umbraco-cms/backoffice 1.0.0-next.bf0e5e95 → 1.0.0-next.bf36c0fd

package/tree.d.ts

@@ -0,0 +1,136 @@
+import * as _umbraco_cms_backoffice_backend_api from '@umbraco-cms/backoffice/backend-api';
+import { TreeItemPresentationModel, ProblemDetailsModel } from '@umbraco-cms/backoffice/backend-api';
+import * as rxjs from 'rxjs';
+import { Observable } from 'rxjs';
+import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
+import { UmbPagedData as UmbPagedData$1, UmbTreeRepository } from '@umbraco-cms/backoffice/repository';
+import { UmbTreeContextBase as UmbTreeContextBase$1 } from '@umbraco-cms/backoffice/tree';
+import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
+
+interface UmbTreeContext<TreeItemType extends TreeItemPresentationModel> {
+    readonly selectable: Observable<boolean>;
+    readonly selection: Observable<Array<string | null>>;
+    setSelectable(value: boolean): void;
+    getSelectable(): boolean;
+    setMultiple(value: boolean): void;
+    getMultiple(): boolean;
+    setSelection(value: Array<string | null>): void;
+    getSelection(): Array<string | null>;
+    select(unique: string | null): void;
+    deselect(unique: string | null): void;
+    requestChildrenOf: (parentUnique: string | null) => Promise<{
+        data?: UmbPagedData$1<TreeItemType>;
+        error?: ProblemDetailsModel;
+        asObservable?: () => Observable<TreeItemType[]>;
+    }>;
+}
+declare class UmbTreeContextBase<TreeItemType extends TreeItemPresentationModel> implements UmbTreeContext<TreeItemType> {
+    #private;
+    host: UmbControllerHostElement;
+    readonly selectable: Observable<boolean>;
+    readonly multiple: Observable<boolean>;
+    readonly selection: Observable<(string | null)[]>;
+    repository?: UmbTreeRepository<TreeItemType>;
+    selectableFilter?: (item: TreeItemType) => boolean;
+    constructor(host: UmbControllerHostElement);
+    setTreeAlias(treeAlias?: string): Promise<void>;
+    getTreeAlias(): string | undefined;
+    setSelectable(value: boolean): void;
+    getSelectable(): boolean;
+    setMultiple(value: boolean): void;
+    getMultiple(): boolean;
+    setSelection(value: Array<string | null>): void;
+    getSelection(): (string | null)[];
+    select(unique: string | null): void;
+    deselect(unique: string | null): void;
+    requestTreeRoot(): Promise<{
+        data?: UmbTreeRootEntityModel | undefined;
+        error?: ProblemDetailsModel | undefined;
+    }>;
+    requestRootItems(): Promise<{
+        data?: UmbPagedData$1<TreeItemType> | undefined;
+        error?: ProblemDetailsModel | undefined;
+        asObservable?: (() => Observable<TreeItemType[]>) | undefined;
+    }>;
+    requestChildrenOf(parentUnique: string | null): Promise<{
+        data?: UmbPagedData$1<TreeItemType> | undefined;
+        error?: ProblemDetailsModel | undefined;
+        asObservable?: (() => Observable<TreeItemType[]>) | undefined;
+    }>;
+    rootItems(): Promise<Observable<TreeItemType[]>>;
+    childrenOf(parentUnique: string | null): Promise<Observable<TreeItemType[]>>;
+}
+
+interface UmbPagedData<T> {
+    total: number;
+    items: Array<T>;
+}
+
+interface UmbTreeItemContext<TreeItemType extends TreeItemPresentationModel> {
+    host: UmbControllerHostElement;
+    unique?: string | null;
+    type?: string;
+    treeItem: Observable<TreeItemType | undefined>;
+    hasChildren: Observable<boolean>;
+    isLoading: Observable<boolean>;
+    isSelectable: Observable<boolean>;
+    isSelected: Observable<boolean>;
+    isActive: Observable<boolean>;
+    hasActions: Observable<boolean>;
+    path: Observable<string>;
+    setTreeItem(treeItem: TreeItemType | undefined): void;
+    requestChildren(): Promise<{
+        data?: UmbPagedData$1<TreeItemType> | undefined;
+        error?: ProblemDetailsModel | undefined;
+        asObservable?: () => Observable<TreeItemType[]>;
+    }>;
+    toggleContextMenu(): void;
+    select(): void;
+    deselect(): void;
+    constructPath(pathname: string, entityType: string, unique: string): string;
+}
+
+type UmbTreeItemUniqueFunction<TreeItemType extends TreeItemPresentationModel> = (x: TreeItemType) => string | null | undefined;
+declare class UmbTreeItemContextBase<TreeItemType extends TreeItemPresentationModel> implements UmbTreeItemContext<TreeItemType> {
+    #private;
+    host: UmbControllerHostElement;
+    unique?: string | null;
+    type?: string;
+    treeItem: rxjs.Observable<TreeItemType | undefined>;
+    hasChildren: rxjs.Observable<boolean>;
+    isLoading: rxjs.Observable<boolean>;
+    isSelectable: rxjs.Observable<boolean>;
+    isSelected: rxjs.Observable<boolean>;
+    isActive: rxjs.Observable<boolean>;
+    hasActions: rxjs.Observable<boolean>;
+    path: rxjs.Observable<string>;
+    treeContext?: UmbTreeContextBase$1<TreeItemType>;
+    constructor(host: UmbControllerHostElement, getUniqueFunction: UmbTreeItemUniqueFunction<TreeItemType>);
+    setTreeItem(treeItem: TreeItemType | undefined): void;
+    requestChildren(): Promise<{
+        data?: UmbPagedData<TreeItemType> | undefined;
+        error?: _umbraco_cms_backoffice_backend_api.ProblemDetailsModel | undefined;
+        asObservable?: (() => rxjs.Observable<TreeItemType[]>) | undefined;
+    }>;
+    toggleContextMenu(): void;
+    select(): void;
+    deselect(): void;
+    getTreeItem(): TreeItemType | undefined;
+    constructPath(pathname: string, entityType: string, unique: string | null): string;
+}
+declare const UMB_TREE_ITEM_CONTEXT_TOKEN: UmbContextToken<UmbTreeItemContext<any>>;
+
+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 { UMB_TREE_ITEM_CONTEXT_TOKEN, UmbTreeContext, UmbTreeContextBase, UmbTreeItemContext, UmbTreeItemContextBase, UmbTreeItemUniqueFunction, UmbTreeRootEntityModel, UmbTreeRootFileSystemModel, UmbTreeRootModel };