@umbraco-cms/backoffice 1.0.0-next.37dcc47c → 1.0.0-next.3b4f30db

package/router.d.ts

@@ -0,0 +1,380 @@
+import { UmbContextToken } from './context-api';
+import { UmbControllerHostElement } from './controller';
+import { UmbModalRouteRegistration } from './modal';
+
+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 Cancel = (() => boolean);
+type PageComponent = HTMLElement | undefined;
+type ModuleResolver = Promise<{
+    default: any;
+}>;
+type Class<T extends PageComponent = PageComponent> = {
+    new (...args: any[]): T;
+};
+type Component = Class | ModuleResolver | PageComponent | (() => Class) | (() => PromiseLike<Class>) | (() => PageComponent) | (() => PromiseLike<PageComponent>) | (() => ModuleResolver) | (() => PromiseLike<ModuleResolver>);
+type Setup<D = any> = ((component: PageComponent, info: IRoutingInfo<D>) => void);
+type RouterTree<D = any, P = any> = {
+    slot: IRouterSlot<D, P>;
+} & {
+    child?: RouterTree;
+} | null | undefined;
+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: Component | PromiseLike<Component>;
+    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;
+};
+type Query = {
+    [key: string]: string;
+};
+type EventListenerSubscription = (() => void);
+/**
+ * RouterSlot related events.
+ */
+type RouterSlotEvent = "changestate";
+/**
+ * History related events.
+ */
+type GlobalRouterEvent = "pushstate" | "replacestate" | "popstate" | "changestate" | "willchangestate" | "navigationstart" | "navigationcancel" | "navigationerror" | "navigationsuccess" | "navigationend";
+interface ISlashOptions {
+    start: boolean;
+    end: boolean;
+}
+declare global {
+    interface GlobalEventHandlersEventMap {
+        "pushstate": PushStateEvent;
+        "replacestate": ReplaceStateEvent;
+        "popstate": PopStateEvent;
+        "changestate": ChangeStateEvent;
+        "navigationstart": NavigationStartEvent;
+        "navigationend": NavigationEndEvent;
+        "navigationsuccess": NavigationSuccessEvent;
+        "navigationcancel": NavigationCancelEvent;
+        "navigationerror": NavigationErrorEvent;
+        "willchangestate": WillChangeStateEvent;
+    }
+}
+
+/**
+ * Dispatches a did change route event.
+ * @param $elem
+ * @param {IRoute} detail
+ */
+declare function dispatchRouteChangeEvent<D = any>($elem: HTMLElement, detail: IRoutingInfo<D>): void;
+/**
+ * Dispatches an event on the window object.
+ * @param name
+ * @param detail
+ */
+declare function dispatchGlobalRouterEvent<D = any>(name: GlobalRouterEvent, detail?: IRoutingInfo<D>): void;
+/**
+ * Adds an event listener (or more) to an element and returns a function to unsubscribe.
+ * @param $elem
+ * @param type
+ * @param listener
+ * @param options
+ */
+declare function addListener<T extends Event, eventType extends string>($elem: EventTarget, type: eventType[] | eventType, listener: ((e: T) => void), options?: boolean | AddEventListenerOptions): EventListenerSubscription;
+/**
+ * Removes the event listeners in the array.
+ * @param listeners
+ */
+declare function removeListeners(listeners: EventListenerSubscription[]): void;
+
+declare const historyPatches: [string, GlobalRouterEvent[]][];
+/**
+ * Patches the history object by ensuring correct events are dispatches when the history changes.
+ */
+declare function ensureHistoryEvents(): void;
+/**
+ * Attaches a global router event after the native function on the object has been invoked.
+ * Stores the original function at the _name.
+ * @param obj
+ * @param functionName
+ * @param eventName
+ */
+declare function attachCallback(obj: any, functionName: string, eventName: GlobalRouterEvent): void;
+/**
+ * Saves the native function on the history object.
+ * @param obj
+ * @param name
+ * @param func
+ */
+declare function saveNativeFunction(obj: any, name: string, func: (() => void)): void;
+declare global {
+    interface History {
+        "native": {
+            "back": ((distance?: any) => void);
+            "forward": ((distance?: any) => void);
+            "go": ((delta?: any) => void);
+            "pushState": ((data: any, title?: string, url?: string | null) => void);
+            "replaceState": ((data: any, title?: string, url?: string | null) => void);
+        };
+    }
+}
+
+/**
+ * Determines whether the path is active.
+ * If the full path starts with the path and is followed by the end of the string or a "/" the path is considered active.
+ * @param path
+ * @param fullPath
+ */
+declare function isPathActive(path: string | PathFragment, fullPath?: string): boolean;
+/**
+ * Matches a route.
+ * @param route
+ * @param path
+ */
+declare function matchRoute<D = any>(route: IRoute<D>, path: string | PathFragment): IRouteMatch<D> | null;
+/**
+ * Matches the first route that matches the given path.
+ * @param routes
+ * @param path
+ */
+declare function matchRoutes<D = any>(routes: IRoute<D>[], path: string | PathFragment): IRouteMatch<D> | null;
+/**
+ * Returns the page from the route.
+ * If the component provided is a function (and not a class) call the function to get the promise.
+ * @param route
+ * @param info
+ */
+declare function resolvePageComponent(route: IComponentRoute, info: IRoutingInfo): Promise<PageComponent>;
+/**
+ * Determines if a route is a redirect route.
+ * @param route
+ */
+declare function isRedirectRoute(route: IRoute): route is IRedirectRoute;
+/**
+ * Determines if a route is a resolver route.
+ * @param route
+ */
+declare function isResolverRoute(route: IRoute): route is IResolverRoute;
+/**
+ * Traverses the router tree up to the root route.
+ * @param slot
+ */
+declare function traverseRouterTree(slot: IRouterSlot): {
+    tree: RouterTree;
+    depth: number;
+};
+/**
+ * Generates a path based on the router tree.
+ * @param tree
+ * @param depth
+ */
+declare function getFragments(tree: RouterTree, depth: number): PathFragment[];
+/**
+ * Constructs the correct absolute path based on a router.
+ * - Handles relative paths: "mypath"
+ * - Handles absolute paths: "/mypath"
+ * - Handles traversing paths: "../../mypath"
+ * @param slot
+ * @param path
+ */
+declare function constructAbsolutePath<D = any, P = any>(slot: IRouterSlot<D, P>, path?: string | PathFragment): string;
+/**
+ * Handles a redirect.
+ * @param slot
+ * @param route
+ */
+declare function handleRedirect(slot: IRouterSlot, route: IRedirectRoute): void;
+/**
+ * Determines whether the navigation should start based on the current match and the new match.
+ * @param currentMatch
+ * @param newMatch
+ */
+declare function shouldNavigate<D>(currentMatch: IRouteMatch<D> | null, newMatch: IRouteMatch<D>): boolean;
+
+/**
+ * Queries the parent router.
+ * @param $elem
+ */
+declare function queryParentRouterSlot<D = any>($elem: Element): IRouterSlot<D> | null;
+/**
+ * Traverses the roots and returns the first match.
+ * The minRoots parameter indicates how many roots should be traversed before we started matching with the query.
+ * @param $elem
+ * @param query
+ * @param minRoots
+ * @param roots
+ */
+declare function queryParentRoots<T>($elem: Element, query: string, minRoots?: number, roots?: number): T | null;
+
+/**
+ * The current path of the location.
+ * As default slashes are included at the start and end.
+ * @param options
+ */
+declare function path(options?: Partial<ISlashOptions>): string;
+/**
+ * Returns the path without the base path.
+ * @param options
+ */
+declare function pathWithoutBasePath(options?: Partial<ISlashOptions>): string;
+/**
+ * Returns the base path as defined in the <base> tag in the head in a reliable way.
+ * If eg. <base href="/router-slot/"> is defined this function will return "/router-slot/".
+ *
+ * An alternative would be to use regex on document.baseURI,
+ * but that will be unreliable in some cases because it
+ * doesn't use the built in HTMLHyperlinkElementUtils.
+ *
+ * To make this method more performant we could cache the anchor element.
+ * As default it will return the base path with slashes in front and at the end.
+ */
+declare function basePath(options?: Partial<ISlashOptions>): string;
+/**
+ * Creates an URL using the built in HTMLHyperlinkElementUtils.
+ * An alternative would be to use regex on document.baseURI,
+ * but that will be unreliable in some cases because it
+ * doesn't use the built in HTMLHyperlinkElementUtils.
+ *
+ * As default it will return the base path with slashes in front and at the end.
+ * @param path
+ * @param options
+ */
+declare function constructPathWithBasePath(path: string, options?: Partial<ISlashOptions>): string;
+/**
+ * Removes the start of the path that matches the part.
+ * @param path
+ * @param part
+ */
+declare function stripStart(path: string, part: string): string;
+/**
+ * Returns the query string.
+ */
+declare function queryString(): string;
+/**
+ * Returns the params for the current path.
+ * @returns Params
+ */
+declare function query(): Query;
+/**
+ * Strips the slash from the start and end of a path.
+ * @param path
+ */
+declare function stripSlash(path: string): string;
+/**
+ * Ensures the path starts and ends with a slash
+ * @param path
+ */
+declare function ensureSlash(path: string): string;
+/**
+ * Makes sure that the start and end slashes are present or not depending on the options.
+ * @param path
+ * @param start
+ * @param end
+ */
+declare function slashify(path: string, { start, end }?: Partial<ISlashOptions>): string;
+/**
+ * Turns a query string into an object.
+ * @param {string} queryString (example: ("test=123&hejsa=LOL&wuhuu"))
+ * @returns {Query}
+ */
+declare function toQuery(queryString: string): Query;
+/**
+ * Turns a query object into a string query.
+ * @param query
+ */
+declare function toQueryString(query: Query): string;
+
+/**
+ * Hook up a click listener to the window that, for all anchor tags
+ * that has a relative HREF, uses the history API instead.
+ */
+declare function ensureAnchorHistory(): void;
+
+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>;
+
+declare function generateRoutePathBuilder(path: string): (params: {
+    [key: string]: string | number;
+}) => string;
+
+export { Cancel, ChangeStateEvent, Class, Component, CustomResolver, EventListenerSubscription, GlobalRouterEvent, Guard, IComponentRoute, IPathFragments, IRedirectRoute, IResolverRoute, IRoute, IRouteBase, IRouteMatch, IRouterSlot, IRoutingInfo, ISlashOptions, ModuleResolver, NavigationCancelEvent, NavigationEndEvent, NavigationErrorEvent, NavigationStartEvent, NavigationSuccessEvent, PageComponent, Params, PathFragment, PathMatch, PushStateEvent, Query, ReplaceStateEvent, RouterSlotEvent, RouterTree, Setup, UMB_ROUTE_CONTEXT_TOKEN, IRoute as UmbRoute, UmbRouteContext, UmbRouteLocation, WillChangeStateEvent, addListener, attachCallback, basePath, constructAbsolutePath, constructPathWithBasePath, dispatchGlobalRouterEvent, dispatchRouteChangeEvent, ensureAnchorHistory, ensureHistoryEvents, ensureSlash, generateRoutePathBuilder, getFragments, handleRedirect, historyPatches, isPathActive, isRedirectRoute, isResolverRoute, matchRoute, matchRoutes, path, pathWithoutBasePath, query, queryParentRoots, queryParentRouterSlot, queryString, removeListeners, resolvePageComponent, saveNativeFunction, shouldNavigate, slashify, stripSlash, stripStart, toQuery, toQueryString, traverseRouterTree };

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 };