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

package/store.d.ts

@@ -1,8 +1,8 @@
 import * as rxjs from 'rxjs';
 import { Observable } from 'rxjs';
-import { UmbControllerHostInterface } from './controller';
-import { EntityTreeItemResponseModel } from './backend-api';
-import { UmbStoreBase as UmbStoreBase$1 } from './store';
+import { UmbControllerHostElement } from './controller';
+import { EntityTreeItemResponseModel, FileSystemTreeItemPresentationModel } from './backend-api';
+import { UmbStoreBase as UmbStoreBase$1, UmbTreeStore as UmbTreeStore$1 } from './store';
 
 interface UmbDataStoreIdentifiers {
     key?: string;
@@ -11,24 +11,6 @@ interface UmbDataStoreIdentifiers {
 interface UmbDataStore {
     readonly storeAlias: string;
 }
-interface UmbTreeStore<T> extends UmbDataStore {
-    getTreeRoot(): Observable<Array<T>>;
-    getTreeItemChildren(key: string): Observable<Array<T>>;
-    /**
-     * @description - Trash data.
-     * @param {string[]} keys
-     * @return {*}  {(Promise<void>)}
-     * @memberof UmbTreeStore
-     */
-    trash(keys: string[]): Promise<void>;
-    /**
-     * @description - Move data.
-     * @param {string[]} keys
-     * @return {*}  {(Promise<void>)}
-     * @memberof UmbTreeStore
-     */
-    move(keys: string[], destination: string): Promise<void>;
-}
 interface UmbEntityDetailStore<T> extends UmbDataStore {
     /**
      * @description - Request scaffold data by entityType and . The data is added to the store and is returned as an Observable.
@@ -36,7 +18,7 @@ interface UmbEntityDetailStore<T> extends UmbDataStore {
      * @return {*}  {T}
      * @memberof UmbEntityDetailStore
      */
-    getScaffold: (entityType: string, parentKey: string | null) => T;
+    getScaffold: (entityType: string, parentId: string | null) => T;
     /**
      * @description - Request data by key. The data is added to the store and is returned as an Observable.
      * @param {string} key
@@ -57,57 +39,121 @@ interface UmbContentStore<T> extends UmbEntityDetailStore<T> {
 }
 
 declare class UmbStoreBase {
-    protected _host: UmbControllerHostInterface;
+    protected _host: UmbControllerHostElement;
     readonly storeAlias: string;
-    constructor(_host: UmbControllerHostInterface, storeAlias: string);
+    constructor(_host: UmbControllerHostElement, storeAlias: string);
 }
 
 /**
  * @export
- * @class UmbTreeStoreBase
+ * @class UmbEntityTreeStore
  * @extends {UmbStoreBase}
  * @description - General Tree Data Store
  */
-declare class UmbTreeStoreBase extends UmbStoreBase$1 {
+declare class UmbEntityTreeStore extends UmbStoreBase$1 implements UmbTreeStore$1<EntityTreeItemResponseModel> {
     #private;
     /**
      * Appends items to the store
-     * @param {Array<EntityTreeItemModel>} items
-     * @memberof UmbTreeStoreBase
+     * @param {Array<EntityTreeItemResponseModel>} items
+     * @memberof UmbEntityTreeStore
      */
     appendItems(items: Array<EntityTreeItemResponseModel>): void;
     /**
      * Updates an item in the store
-     * @param {string} key
-     * @param {Partial<EntityTreeItemModel>} data
-     * @memberof UmbTreeStoreBase
+     * @param {string} id
+     * @param {Partial<EntityTreeItemResponseModel>} data
+     * @memberof UmbEntityTreeStore
      */
-    updateItem(key: string, data: Partial<EntityTreeItemResponseModel>): void;
+    updateItem(id: string, data: Partial<EntityTreeItemResponseModel>): void;
     /**
      * Removes an item from the store
-     * @param {string} key
-     * @memberof UmbTreeStoreBase
+     * @param {string} id
+     * @memberof UmbEntityTreeStore
      */
-    removeItem(key: string): void;
+    removeItem(id: string): void;
     /**
      * An observable to observe the root items
-     * @memberof UmbTreeStoreBase
+     * @memberof UmbEntityTreeStore
      */
     rootItems: rxjs.Observable<EntityTreeItemResponseModel[]>;
     /**
      * Returns an observable to observe the children of a given parent
-     * @param {(string | null)} parentKey
+     * @param {(string | null)} parentId
      * @return {*}
-     * @memberof UmbTreeStoreBase
+     * @memberof UmbEntityTreeStore
      */
-    childrenOf(parentKey: string | null): rxjs.Observable<EntityTreeItemResponseModel[]>;
+    childrenOf(parentId: string | null): rxjs.Observable<EntityTreeItemResponseModel[]>;
     /**
-     * Returns an observable to observe the items with the given keys
-     * @param {Array<string>} keys
+     * Returns an observable to observe the items with the given ids
+     * @param {Array<string>} ids
      * @return {*}
-     * @memberof UmbTreeStoreBase
+     * @memberof UmbEntityTreeStore
+     */
+    items(ids: Array<string>): rxjs.Observable<EntityTreeItemResponseModel[]>;
+}
+
+/**
+ * @export
+ * @class UmbFileSystemTreeStore
+ * @extends {UmbStoreBase}
+ * @description - General Tree Data Store
+ */
+declare class UmbFileSystemTreeStore extends UmbStoreBase$1 implements UmbTreeStore$1<FileSystemTreeItemPresentationModel> {
+    #private;
+    /**
+     * Appends items to the store
+     * @param {Array<FileSystemTreeItemPresentationModel>} items
+     * @memberof UmbFileSystemTreeStore
      */
-    items(keys: Array<string>): rxjs.Observable<EntityTreeItemResponseModel[]>;
+    appendItems(items: Array<FileSystemTreeItemPresentationModel>): void;
+    /**
+     * Updates an item in the store
+     * @param {string} path
+     * @param {Partial<FileSystemTreeItemPresentationModel>} data
+     * @memberof UmbFileSystemTreeStore
+     */
+    updateItem(path: string, data: Partial<FileSystemTreeItemPresentationModel>): void;
+    /**
+     * Removes an item from the store
+     * @param {string} path
+     * @memberof UmbFileSystemTreeStore
+     */
+    removeItem(path: string): void;
+    /**
+     * An observable to observe the root items
+     * @memberof UmbFileSystemTreeStore
+     */
+    rootItems: rxjs.Observable<FileSystemTreeItemPresentationModel[]>;
+    /**
+     * Returns an observable to observe the children of a given parent
+     * @param {(string | null)} parentPath
+     * @return {*}
+     * @memberof UmbFileSystemTreeStore
+     */
+    childrenOf(parentPath: string | null): rxjs.Observable<FileSystemTreeItemPresentationModel[]>;
+    /**
+     * Returns an observable to observe the items with the given ids
+     * @param {Array<string>} paths
+     * @return {*}
+     * @memberof UmbFileSystemTreeStore
+     */
+    items(paths: Array<string>): rxjs.Observable<FileSystemTreeItemPresentationModel[]>;
+}
+
+type TreeItemPresentationModel = {
+    name?: string;
+    type?: string;
+    icon?: string;
+    hasChildren?: boolean;
+};
+
+interface UmbTreeStore<T extends TreeItemPresentationModel = any> {
+    appendItems: (items: Array<T>) => void;
+    updateItem: (unique: string, item: Partial<T>) => void;
+    removeItem: (unique: string) => void;
+    rootItems: Observable<Array<T>>;
+    childrenOf: (parentUnique: string | null) => Observable<Array<T>>;
+    items: (uniques: Array<string>) => Observable<Array<T>>;
 }
 
-export { UmbContentStore, UmbDataStore, UmbDataStoreIdentifiers, UmbEntityDetailStore, UmbStoreBase, UmbTreeStore, UmbTreeStoreBase };
+export { UmbContentStore, UmbDataStore, UmbDataStoreIdentifiers, UmbEntityDetailStore, UmbEntityTreeStore, UmbFileSystemTreeStore, UmbStoreBase, UmbTreeStore };

package/utils.d.ts

@@ -11,4 +11,6 @@ declare function umbracoPath(path: string): string;
 declare function buildUdi(entityType: string, guid: string): string;
 declare function getKeyFromUdi(udi: string): string;
 
-export { buildUdi, getKeyFromUdi, getLookAndColorFromUserStatus, umbracoPath };
+declare function generateGuid(): string;
+
+export { buildUdi, generateGuid, getKeyFromUdi, getLookAndColorFromUserStatus, umbracoPath };