@umbraco-cms/backoffice 1.0.0-next.99fe12c7 → 1.0.0-next.bc7aa666

package/observable-api.d.ts

@@ -1,6 +1,6 @@
 import * as rxjs from 'rxjs';
 import { Observable, BehaviorSubject } from 'rxjs';
-import { UmbControllerInterface, UmbControllerHostInterface } from './controller';
+import { UmbControllerInterface, UmbControllerHostElement } from './controller';
 
 declare class UmbObserver<T> {
     #private;
@@ -13,7 +13,7 @@ declare class UmbObserver<T> {
 declare class UmbObserverController<T = unknown> extends UmbObserver<T> implements UmbControllerInterface {
     _alias?: string;
     get unique(): string | undefined;
-    constructor(host: UmbControllerHostInterface, source: Observable<T>, callback: (_value: T) => void, alias?: string);
+    constructor(host: UmbControllerHostElement, source: Observable<T>, callback: (_value: T) => void, alias?: string);
 }
 
 /**
@@ -99,7 +99,7 @@ declare class DeepState<T> extends BehaviorSubject<T> {
  */
 declare class ArrayState<T> extends DeepState<T[]> {
     private _getUnique?;
-    constructor(initialData: T[], _getUnique?: ((entry: T) => unknown) | undefined);
+    constructor(initialData: T[], getUniqueMethod?: (entry: T) => unknown);
     /**
      * @method remove
      * @param {unknown[]} uniques - The unique values to remove.
@@ -181,6 +181,21 @@ declare class ArrayState<T> extends DeepState<T[]> {
      * ]);
      */
     append(entries: T[]): this;
+    /**
+     * @method updateOne
+     * @param {unknown} unique - Unique value to find entry to update.
+     * @param {Partial<T>} entry - new data to be added in this Subject.
+     * @return {ArrayState<T>} Reference to it self.
+     * @description - Update a item with some new data, requires the ArrayState to be constructed with a getUnique method.
+     * @example <caption>Example append some data.</caption>
+     * const data = [
+     * 	{ key: 1, value: 'foo'},
+     * 	{ key: 2, value: 'bar'}
+     * ];
+     * const myState = new ArrayState(data, (x) => x.key);
+     * myState.updateOne(2, {value: 'updated-bar'});
+     */
+    updateOne(unique: unknown, entry: Partial<T>): this;
 }
 
 /**
@@ -246,4 +261,4 @@ declare function appendToFrozenArray<T>(data: T[], entry: T, getUniqueMethod?: (
  */
 declare function partialUpdateFrozenArray<T>(data: T[], partialEntry: Partial<T>, findMethod: (entry: T) => boolean): T[];
 
-export { ArrayState, BooleanState, ClassState, DeepState, NumberState, ObjectState, StringState, UmbObserver, UmbObserverController, appendToFrozenArray, createObservablePart, partialUpdateFrozenArray };
+export { ArrayState, BasicState, BooleanState, ClassState, DeepState, MappingFunction, NumberState, ObjectState, StringState, UmbObserver, UmbObserverController, appendToFrozenArray, createObservablePart, partialUpdateFrozenArray };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@umbraco-cms/backoffice",
-	"version": "1.0.0-next.99fe12c7",
+	"version": "1.0.0-next.bc7aa666",
 	"license": "MIT",
 	"keywords": [
 		"umbraco",

package/repository.d.ts

@@ -1,12 +1,34 @@
-import { ProblemDetailsModel, PagedEntityTreeItemResponseModel, EntityTreeItemResponseModel } from './backend-api';
-import { Observable } from 'rxjs';
+import { ProblemDetailsModel, FolderReponseModel, CreateFolderRequestModel, UpdateFolderReponseModel, FolderModelBaseModel } from './backend-api';
 import { DataSourceResponse as DataSourceResponse$1 } from './repository';
+import { Observable } from 'rxjs';
 
 interface DataSourceResponse<T = undefined> {
     data?: T;
     error?: ProblemDetailsModel;
 }
 
+interface UmbDataSource<CreateRequestType, UpdateRequestType, ResponseType> {
+    createScaffold(parentKey: string | null): Promise<DataSourceResponse$1<ResponseType>>;
+    get(unique: string): Promise<DataSourceResponse$1<ResponseType>>;
+    insert(data: CreateRequestType): Promise<any>;
+    update(unique: string, data: UpdateRequestType): Promise<DataSourceResponse$1<ResponseType>>;
+    delete(unique: string): Promise<DataSourceResponse$1>;
+}
+
+interface UmbFolderDataSource {
+    createScaffold(parentKey: string | null): Promise<DataSourceResponse<FolderReponseModel>>;
+    get(unique: string): Promise<DataSourceResponse<FolderReponseModel>>;
+    insert(data: CreateFolderRequestModel): Promise<DataSourceResponse<string>>;
+    update(unique: string, data: CreateFolderRequestModel): Promise<DataSourceResponse<UpdateFolderReponseModel>>;
+    delete(unique: string): Promise<DataSourceResponse>;
+}
+
+interface UmbTreeDataSource<PagedItemsType = any, ItemsType = any> {
+    getRootItems(): Promise<DataSourceResponse$1<PagedItemsType>>;
+    getChildrenOf(parentUnique: string): Promise<DataSourceResponse$1<PagedItemsType>>;
+    getItems(unique: Array<string>): Promise<DataSourceResponse$1<Array<ItemsType>>>;
+}
+
 interface UmbDetailRepository<DetailType> {
     createScaffold(parentKey: string | null): Promise<{
         data?: DetailType;
@@ -27,39 +49,51 @@ interface UmbDetailRepository<DetailType> {
     }>;
 }
 
-interface UmbTreeRepository {
+interface UmbPagedData<T> {
+    total: number;
+    items: Array<T>;
+}
+interface UmbTreeRepository<ItemType = any, PagedItemType = UmbPagedData<ItemType>> {
     requestRootTreeItems: () => Promise<{
-        data: PagedEntityTreeItemResponseModel | undefined;
+        data: PagedItemType | undefined;
         error: ProblemDetailsModel | undefined;
-        asObservable?: () => Observable<EntityTreeItemResponseModel[]>;
+        asObservable?: () => Observable<ItemType[]>;
     }>;
-    requestTreeItemsOf: (parentKey: string | null) => Promise<{
-        data: PagedEntityTreeItemResponseModel | undefined;
+    requestTreeItemsOf: (parentUnique: string | null) => Promise<{
+        data: PagedItemType | undefined;
         error: ProblemDetailsModel | undefined;
-        asObservable?: () => Observable<EntityTreeItemResponseModel[]>;
+        asObservable?: () => Observable<ItemType[]>;
     }>;
-    requestTreeItems: (keys: string[]) => Promise<{
-        data: Array<EntityTreeItemResponseModel> | undefined;
+    requestTreeItems: (uniques: string[]) => Promise<{
+        data: Array<ItemType> | undefined;
         error: ProblemDetailsModel | undefined;
-        asObservable?: () => Observable<EntityTreeItemResponseModel[]>;
+        asObservable?: () => Observable<ItemType[]>;
     }>;
-    rootTreeItems: () => Promise<Observable<EntityTreeItemResponseModel[]>>;
-    treeItemsOf: (parentKey: string | null) => Promise<Observable<EntityTreeItemResponseModel[]>>;
-    treeItems: (keys: string[]) => Promise<Observable<EntityTreeItemResponseModel[]>>;
-}
-
-interface RepositoryTreeDataSource {
-    getRootItems(): Promise<DataSourceResponse$1<PagedEntityTreeItemResponseModel>>;
-    getChildrenOf(parentKey: string): Promise<DataSourceResponse$1<PagedEntityTreeItemResponseModel>>;
-    getItems(key: Array<string>): Promise<DataSourceResponse$1<EntityTreeItemResponseModel[]>>;
+    rootTreeItems: () => Promise<Observable<ItemType[]>>;
+    treeItemsOf: (parentUnique: string | null) => Promise<Observable<ItemType[]>>;
+    treeItems: (uniques: string[]) => Promise<Observable<ItemType[]>>;
 }
 
-interface RepositoryDetailDataSource<DetailType> {
-    createScaffold(parentKey: string | null): Promise<DataSourceResponse$1<DetailType>>;
-    get(key: string): Promise<DataSourceResponse$1<DetailType>>;
-    insert(data: DetailType): Promise<DataSourceResponse$1<DetailType>>;
-    update(data: DetailType): Promise<DataSourceResponse$1<DetailType>>;
-    delete(key: string): Promise<DataSourceResponse$1<DetailType>>;
+interface UmbFolderRepository {
+    createFolderScaffold(parentKey: string | null): Promise<{
+        data?: FolderReponseModel;
+        error?: ProblemDetailsModel;
+    }>;
+    createFolder(folderRequest: CreateFolderRequestModel): Promise<{
+        data?: string;
+        error?: ProblemDetailsModel;
+    }>;
+    requestFolder(unique: string): Promise<{
+        data?: FolderReponseModel;
+        error?: ProblemDetailsModel;
+    }>;
+    updateFolder(unique: string, folder: FolderModelBaseModel): Promise<{
+        data?: UpdateFolderReponseModel;
+        error?: ProblemDetailsModel;
+    }>;
+    deleteFolder(key: string): Promise<{
+        error?: ProblemDetailsModel;
+    }>;
 }
 
-export { DataSourceResponse, RepositoryDetailDataSource, RepositoryTreeDataSource, UmbDetailRepository, UmbTreeRepository };
+export { DataSourceResponse, UmbDataSource, UmbDetailRepository, UmbFolderDataSource, UmbFolderRepository, UmbPagedData, UmbTreeDataSource, UmbTreeRepository };

package/resources.d.ts

@@ -1,11 +1,11 @@
 import { UmbNotificationOptions } from './notification';
 import { ProblemDetailsModel } from './backend-api';
-import { UmbController, UmbControllerHostInterface } from './controller';
+import { UmbController, UmbControllerHostElement } from './controller';
 import { DataSourceResponse as DataSourceResponse$1 } from './repository';
 
 declare class UmbResourceController extends UmbController {
     #private;
-    constructor(host: UmbControllerHostInterface, promise: Promise<any>, alias?: string);
+    constructor(host: UmbControllerHostElement, promise: Promise<any>, alias?: string);
     hostConnected(): void;
     hostDisconnected(): void;
     /**
@@ -45,6 +45,6 @@ interface DataSourceResponse<T = undefined> {
 
 declare function tryExecute<T>(promise: Promise<T>): Promise<DataSourceResponse<T>>;
 
-declare function tryExecuteAndNotify<T>(host: UmbControllerHostInterface, resource: Promise<T>, options?: UmbNotificationOptions<any>): Promise<DataSourceResponse<T>>;
+declare function tryExecuteAndNotify<T>(host: UmbControllerHostElement, resource: Promise<T>, options?: UmbNotificationOptions<any>): Promise<DataSourceResponse<T>>;
 
 export { UmbResourceController, tryExecute, tryExecuteAndNotify };

package/router.d.ts

@@ -0,0 +1,130 @@
+import { UmbContextToken } from './context-api';
+import { UmbControllerHostElement } from './controller';
+import { UmbModalRouteRegistration } from './modal';
+
+interface UmbRouteLocation {
+    name?: string;
+    params: {
+        [key: string]: string;
+    };
+}
+
+declare class UmbRouteContext {
+    #private;
+    private _onGotModals;
+    constructor(host: UmbControllerHostElement, _onGotModals: (contextRoutes: any) => void);
+    registerModal(registration: UmbModalRouteRegistration): UmbModalRouteRegistration<object, any>;
+    unregisterModal(registrationToken: ReturnType<typeof this$1.registerModal>): void;
+    _internal_routerGotBasePath(routerBasePath: string): void;
+    _internal_modalRouterChanged(activeModalPath: string | undefined): void;
+}
+declare const UMB_ROUTE_CONTEXT_TOKEN: UmbContextToken<UmbRouteContext>;
+
+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;
+type ModuleResolver = Promise<{
+    default: any;
+}>;
+type Class<T extends PageComponent = PageComponent> = {
+    new (...args: any[]): T;
+};
+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: Class | ModuleResolver | PageComponent | (() => Class) | (() => PageComponent) | (() => ModuleResolver);
+    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;
+    }
+}
+
+type UmbRoute = IRoute;
+
+export { UMB_ROUTE_CONTEXT_TOKEN, UmbRoute, UmbRouteContext, UmbRouteLocation };

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.
@@ -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 {Partial<EntityTreeItemResponseModel>} data
+     * @memberof UmbEntityTreeStore
      */
     updateItem(key: string, data: Partial<EntityTreeItemResponseModel>): void;
     /**
      * Removes an item from the store
      * @param {string} key
-     * @memberof UmbTreeStoreBase
+     * @memberof UmbEntityTreeStore
      */
     removeItem(key: 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
      * @return {*}
-     * @memberof UmbTreeStoreBase
+     * @memberof UmbEntityTreeStore
      */
     childrenOf(parentKey: string | null): rxjs.Observable<EntityTreeItemResponseModel[]>;
     /**
      * Returns an observable to observe the items with the given keys
      * @param {Array<string>} keys
      * @return {*}
-     * @memberof UmbTreeStoreBase
+     * @memberof UmbEntityTreeStore
      */
     items(keys: Array<string>): rxjs.Observable<EntityTreeItemResponseModel[]>;
 }
 
-export { UmbContentStore, UmbDataStore, UmbDataStoreIdentifiers, UmbEntityDetailStore, UmbStoreBase, UmbTreeStore, UmbTreeStoreBase };
+/**
+ * @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
+     */
+    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 keys
+     * @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, UmbEntityTreeStore, UmbFileSystemTreeStore, UmbStoreBase, UmbTreeStore };