@umbraco-cms/backoffice 1.0.0-next.ce55cd35 → 1.0.0-next.d2c0dcf1

package/store.d.ts

@@ -1,8 +1,9 @@
 import * as rxjs from 'rxjs';
 import { Observable } from 'rxjs';
-import { UmbControllerHostElement } from './controller';
-import { EntityTreeItemResponseModel, FileSystemTreeItemPresentationModel } from './backend-api';
-import { UmbStoreBase as UmbStoreBase$1, UmbTreeStore as UmbTreeStore$1 } from './store';
+import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
+import { UmbArrayState } from '@umbraco-cms/backoffice/observable-api';
+import { EntityTreeItemResponseModel, FileSystemTreeItemPresentationModel } from '@umbraco-cms/backoffice/backend-api';
+import { UmbStoreBase as UmbStoreBase$1, UmbTreeStore as UmbTreeStore$1 } from '@umbraco-cms/backoffice/store';
 
 interface UmbDataStoreIdentifiers {
     key?: string;
@@ -38,39 +39,46 @@ interface UmbContentStore<T> extends UmbEntityDetailStore<T> {
     save(data: T[]): Promise<void>;
 }
 
-declare class UmbStoreBase {
-    protected _host: UmbControllerHostElement;
-    readonly storeAlias: string;
-    constructor(_host: UmbControllerHostElement, storeAlias: string);
+interface UmbStore<T> {
+    appendItems: (items: Array<T>) => void;
+    updateItem: (unique: string, item: Partial<T>) => void;
+    removeItem: (unique: string) => void;
 }
 
-/**
- * @export
- * @class UmbEntityTreeStore
- * @extends {UmbStoreBase}
- * @description - General Tree Data Store
- */
-declare class UmbEntityTreeStore extends UmbStoreBase$1 implements UmbTreeStore$1<EntityTreeItemResponseModel> {
-    #private;
+declare class UmbStoreBase<StoreItemType = any> implements UmbStore<StoreItemType> {
+    protected _host: UmbControllerHostElement;
+    protected _data: UmbArrayState<StoreItemType>;
+    readonly storeAlias: string;
+    constructor(_host: UmbControllerHostElement, storeAlias: string, data: UmbArrayState<StoreItemType>);
     /**
      * Appends items to the store
-     * @param {Array<EntityTreeItemResponseModel>} items
+     * @param {Array<StoreItemType>} items
      * @memberof UmbEntityTreeStore
      */
-    appendItems(items: Array<EntityTreeItemResponseModel>): void;
+    appendItems(items: Array<StoreItemType>): void;
     /**
      * Updates an item in the store
      * @param {string} id
-     * @param {Partial<EntityTreeItemResponseModel>} data
+     * @param {Partial<StoreItemType>} data
      * @memberof UmbEntityTreeStore
      */
-    updateItem(id: string, data: Partial<EntityTreeItemResponseModel>): void;
+    updateItem(unique: string, data: Partial<StoreItemType>): void;
     /**
      * Removes an item from the store
      * @param {string} id
      * @memberof UmbEntityTreeStore
      */
-    removeItem(id: string): void;
+    removeItem(unique: string): void;
+}
+
+/**
+ * @export
+ * @class UmbEntityTreeStore
+ * @extends {UmbStoreBase}
+ * @description - Entity Tree Store
+ */
+declare class UmbEntityTreeStore extends UmbStoreBase$1<EntityTreeItemResponseModel> implements UmbTreeStore$1<EntityTreeItemResponseModel> {
+    constructor(host: UmbControllerHostElement, storeAlias: string);
     /**
      * An observable to observe the root items
      * @memberof UmbEntityTreeStore
@@ -96,29 +104,10 @@ declare class UmbEntityTreeStore extends UmbStoreBase$1 implements UmbTreeStore$
  * @export
  * @class UmbFileSystemTreeStore
  * @extends {UmbStoreBase}
- * @description - General Tree Data Store
+ * @description - File System Tree Store
  */
-declare class UmbFileSystemTreeStore extends UmbStoreBase$1 implements UmbTreeStore$1<FileSystemTreeItemPresentationModel> {
-    #private;
-    /**
-     * Appends items to the store
-     * @param {Array<FileSystemTreeItemPresentationModel>} items
-     * @memberof UmbFileSystemTreeStore
-     */
-    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;
+declare class UmbFileSystemTreeStore extends UmbStoreBase$1<FileSystemTreeItemPresentationModel> implements UmbTreeStore$1<FileSystemTreeItemPresentationModel> {
+    constructor(host: UmbControllerHostElement, storeAlias: string);
     /**
      * An observable to observe the root items
      * @memberof UmbFileSystemTreeStore
@@ -132,7 +121,7 @@ declare class UmbFileSystemTreeStore extends UmbStoreBase$1 implements UmbTreeSt
      */
     childrenOf(parentPath: string | null): rxjs.Observable<FileSystemTreeItemPresentationModel[]>;
     /**
-     * Returns an observable to observe the items with the given keys
+     * Returns an observable to observe the items with the given ids
      * @param {Array<string>} paths
      * @return {*}
      * @memberof UmbFileSystemTreeStore
@@ -147,13 +136,19 @@ type TreeItemPresentationModel = {
     hasChildren?: boolean;
 };
 
-interface UmbTreeStore<T extends TreeItemPresentationModel = any> {
-    appendItems: (items: Array<T>) => void;
-    updateItem: (unique: string, item: Partial<T>) => void;
-    removeItem: (unique: string) => void;
+type ItemResponseModelBaseModel = {
+    name?: string;
+    id?: string;
+};
+
+interface UmbTreeStore<T extends TreeItemPresentationModel = any> extends UmbStore<T> {
     rootItems: Observable<Array<T>>;
     childrenOf: (parentUnique: string | null) => Observable<Array<T>>;
     items: (uniques: Array<string>) => Observable<Array<T>>;
 }
 
-export { UmbContentStore, UmbDataStore, UmbDataStoreIdentifiers, UmbEntityDetailStore, UmbEntityTreeStore, UmbFileSystemTreeStore, UmbStoreBase, UmbTreeStore };
+interface UmbItemStore<T extends ItemResponseModelBaseModel = any> extends UmbStore<T> {
+    items: (uniques: Array<string>) => Observable<Array<T>>;
+}
+
+export { UmbContentStore, UmbDataStore, UmbDataStoreIdentifiers, UmbEntityDetailStore, UmbEntityTreeStore, UmbFileSystemTreeStore, UmbItemStore, UmbStoreBase, UmbTreeStore };