@coolon/angular-ui-powerups 0.0.116 → 0.0.117

package/lib/place/guards/navigation-state.d.ts

@@ -13,6 +13,7 @@ export declare abstract class NavigationState extends GarbageCollector {
     abstract readonly isTransitional: boolean;
     abstract readonly startingUrl: string;
     abstract readonly isPopState: boolean;
+    debugPropertyKeys: string[];
     constructor(context: NavigationState.Context);
     readonly name: string;
     readonly idle: boolean;
@@ -35,7 +36,9 @@ export declare abstract class NavigationState extends GarbageCollector {
     protected createTransitionStateFor(event: NavigationStart): any;
     protected createIdleState(): any;
     resetBrowserLocation(url: any): void;
+    ignore(event: RouterEvent, reason?: string): NavigationState;
     toString(): string;
+    protected debugState(properties?: string[]): string;
 }
 export declare namespace NavigationState {
     class Context {
@@ -62,61 +65,155 @@ export declare namespace NavigationState {
         readonly interactionContext: InteractionContext;
         onRouterStarted(event: NavigationStart): NavigationState;
         onRouterEnd(event: NavigationEnd): NavigationState;
-        onBackClickedDuringNavigationInteraction(locationTriggerUrl: string): NavigationState;
+        onBackClickedDuringNavigationInteraction(newUrl: string): NavigationState;
+        abstract createNavigationInteractionCancelledState(newUrl: string): NavigationState;
         canDeactivatePlace(component: PlaceComponent, currentUrl: UrlSnapshot, nextUrl: UrlSnapshot): Promise<boolean | UrlSnapshot>;
-        private detachInteractionContext;
+        protected detachInteractionContext(): InteractionContext;
     }
     class NavigationTransition extends AbstractNavigationTransition {
         readonly isPopState = false;
+        debugPropertyKeys: string[];
         onRouterCancelled(event: NavigationCancel): NavigationState;
         onRouterError(event: NavigationError): NavigationState;
-        toString(): string;
+        createNavigationInteractionCancelledState(newUrl: string): NavigationState;
     }
     class PopStateTransition extends AbstractNavigationTransition {
+        readonly poppedHistoryUrl: string;
         readonly isPopState = true;
+        debugPropertyKeys: string[];
+        constructor(context: NavigationState.Context, startingUrl: string, poppedHistoryUrl: string);
         onRouterCancelled(event: NavigationCancel): NavigationState;
         onRouterError(event: NavigationError): NavigationState;
+        createNavigationInteractionCancelledState(locationTriggerUrl: string): NavigationState;
     }
+    abstract class AbstractInteractionTransition extends AbstractNavigationTransition {
+        readonly startingUrl: string;
+        readonly isTransitional = true;
+        constructor(context: Context, startingUrl: string);
+    }
+    /**
+     * This is the non transitional (i.e. rest) state that is used whenever an interaction context is active.
+     */
     class IdleDuringInteraction extends NavigationState {
         readonly startingUrl: string;
         readonly isTransitional = false;
         readonly isPopState = false;
+        debugPropertyKeys: string[];
         constructor(context: Context, startingUrl: string);
         onPlaceNavigationStart(visit: Visit, initialUrl: string): NavigationState;
         onRouterStarted(event: NavigationStart): NavigationState;
         onPopState(event: NavigationStart): NavigationState;
     }
-    abstract class AbstractInteractionTransition extends AbstractNavigationTransition {
-        readonly startingUrl: string;
-        readonly isTransitional = true;
-        constructor(context: Context, startingUrl: string);
-    }
     /**
      * This state exists to handle all events while any kind of navigation is in progress.  That way all other states can
      * happily ignore interaction contexts.
+     * NOTE: This state is activated when ever an interaction is started.  It might be better to split it into
+     *       different states for different scenarios, e.g. starting model, starting model during route guard etc.
      */
-    class InteractionTransition extends AbstractInteractionTransition {
+    class StartingInteractionTransition extends AbstractInteractionTransition {
         readonly isPopState = false;
         onRouterCancelled(event: NavigationCancel): NavigationState;
         onRouterError(event: NavigationError): NavigationState;
         onRouterEnd(event: NavigationEnd): NavigationState;
+        createNavigationInteractionCancelledState(locationTriggerUrl: string): NavigationState;
+    }
+    /**
+     * The sequence of router events are:
+     * Error -> url = url of navigation link
+     * End
+     * onPopState url = current intereaction url sans the query params
+     * Cancel url == same as above.
+     */
+    class LeavingInteractionTransitionCancelled extends NavigationState {
+        readonly startingUrl: string;
+        readonly locationChangeTriggerUrl: string;
+        readonly isPopState = false;
+        firstCancelHandled: boolean;
+        popStateHandled: boolean;
+        popStateEventUrl: string;
+        debugPropertyKeys: string[];
+        constructor(context: Context, startingUrl: string, locationChangeTriggerUrl: string);
+        readonly isTransitional: boolean;
+        onRouterStarted(event: NavigationStart): NavigationState;
+        onRouterCancelled(event: NavigationCancel): NavigationState;
+        onRouterEnd(event: NavigationEnd): NavigationState;
+        onRouterError(event: NavigationError): NavigationState;
+        onPopState(event: NavigationStart): NavigationState;
+        canDeactivatePlace(component: PlaceComponent, currentUrl: UrlSnapshot, nextUrl: UrlSnapshot): Promise<boolean | UrlSnapshot>;
     }
     /**
      * This state exists to handle all events while any kind of navigation is in progress.  That way all other states can
      * happily ignore interaction contexts.
      */
-    class InteractionPopStateTransition extends AbstractInteractionTransition {
+    class LeavingInteractionAfterPopStateTransition extends AbstractInteractionTransition {
+        readonly poppedHistoryUrl: string;
         readonly isPopState = true;
+        constructor(context: NavigationState.Context, startingUrl: string, poppedHistoryUrl: string);
         onRouterCancelled(event: NavigationCancel): NavigationState;
         onRouterEnd(event: NavigationEnd): NavigationState;
+        createNavigationInteractionCancelledState(newUrl: string): NavigationState;
     }
-    class CancelledDuringNavigationInteraction extends NavigationState {
+    /**
+     * This state handles the scenario where a link navigation triggered an interaction and the user clicked back a to cancel it.
+     * The routing event sequence is different depending on the link that was clicked.
+     *
+     * If the link was the same as the previous history location (i.e. they've gone back via a link rather than clicking back) then the sequence is:
+     *
+     * -> Idle -> NavigationTransition
+     * -> confirm dialog shown.
+     * -> click back
+     * -> NavigationCancel -> clickedLinkUrl === cancel.url
+     * -> NavigationEnd
+     *
+     * Otherwise if the link is different from teh history location then the sequence is:
+     *
+     * -> Idle -> NavigationTransition
+     * -> confirm dialog shown.
+     * -> click back
+     * -> NavigationCancel -> clickedLinkUrl !== cancel.url
+     * -> NavigationEnd
+     * -> PopState
+     * -> NavigationCancel
+     */
+    class LinkTriggeredNavigationInteractionCancelled extends NavigationState {
+        readonly startingUrl: string;
+        readonly clickedLinkUrl: string;
+        readonly isPopState = false;
+        firstCancelEventUrl: string;
+        popStateEventUrl: string;
+        clickedLinkMatchedBackButtonUrl: boolean;
+        debugPropertyKeys: string[];
+        constructor(context: Context, startingUrl: string, clickedLinkUrl: string);
+        readonly isTransitional: boolean;
+        onRouterStarted(event: NavigationStart): NavigationState;
+        onRouterCancelled(event: NavigationCancel): NavigationState;
+        onRouterEnd(event: NavigationEnd): NavigationState;
+        onRouterError(event: NavigationError): NavigationState;
+        onPopState(event: NavigationStart): NavigationState;
+        finaliseRouting(): any;
+        canDeactivatePlace(component: PlaceComponent, currentUrl: UrlSnapshot, nextUrl: UrlSnapshot): Promise<boolean | UrlSnapshot>;
+    }
+    /**
+     * This state handles the scenario where a pop state triggered and interaction and the user clickeb back a second time to cancel it.
+     * The sequence of routing events/state transitions is as follows.
+     * -> Idle -> PopStateTransition (poppedHistoryUrl == page to go to, startingUrl = page to stay on )
+     * -> confirm dialog shown.
+     * -> click back
+     * -> PopStateTransition -> CancelledDuringBackButtonNavigationInteraction(trigger url is the page before the popped history url)
+     * -> NavigationCancel (for the previous back)
+     * -> PopState
+     * -> NavigationCancel
+     */
+    class PopStateTriggeredNavigationInteractionCancelled extends NavigationState {
         readonly startingUrl: string;
-        readonly startingEventWasAPopState: boolean;
         readonly locationChangeTriggerUrl: string;
+        readonly poppedHistoryUrl: string;
         readonly isPopState = false;
-        private gotPopStateWithLeavingUrl;
-        constructor(context: Context, startingUrl: string, startingEventWasAPopState: boolean, locationChangeTriggerUrl: string);
+        firstCancelHandled: boolean;
+        popStateHandled: boolean;
+        popStateEventUrl: string;
+        debugPropertyKeys: string[];
+        constructor(context: Context, startingUrl: string, locationChangeTriggerUrl: string, poppedHistoryUrl: string);
         readonly isTransitional: boolean;
         onRouterStarted(event: NavigationStart): NavigationState;
         onRouterCancelled(event: NavigationCancel): NavigationState;
@@ -124,7 +221,5 @@ export declare namespace NavigationState {
         onRouterError(event: NavigationError): NavigationState;
         onPopState(event: NavigationStart): NavigationState;
         canDeactivatePlace(component: PlaceComponent, currentUrl: UrlSnapshot, nextUrl: UrlSnapshot): Promise<boolean | UrlSnapshot>;
-        ignore(event: RouterEvent, reason?: string): NavigationState;
-        toString(): string;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coolon/angular-ui-powerups",
-  "version": "0.0.116",
+  "version": "0.0.117",
   "schematics": "./schematics/collection.json",
   "dependencies": {
     "ts-morph": "^3.1.3",
@@ -15,7 +15,7 @@
     "@angular/material": "^8.2.3",
     "@angular/animations": "^8.2.14",
     "@angular/cdk": "^8.2.3",
-    "@coolon/pectin": ">=1.15.23",
+    "@coolon/pectin": "1.15.0",
     "resize-observer-polyfill": "^1.5.1"
   },
   "main": "bundles/coolon-angular-ui-powerups.umd.js",