@coolon/angular-ui-powerups 12.3.1 → 12.4.0-alpha.1

package/lib/components/switch-case/switch-case.component.d.ts

@@ -19,6 +19,13 @@ export declare class SwitchCaseDefaultDirective<T> extends SwitchCaseOption<T> {
     constructor(templateRef: TemplateRef<Object>);
     matches(value: T): boolean;
 }
+/**
+ * @example
+ * <aup-switch-case [switchModel]="booleanModel">
+ *    <div *aupSwitchCaseWhen="true"></div>
+ *    <div *aupSwitchCaseDefault>The default content</div>
+ * </aup-switch-case>
+ */
 export declare class SwitchCaseComponent<T> extends DisposableComponent implements OnInit, AfterContentInit {
     private cdr;
     switchModel: ValueModel<T>;

package/lib/place/guards/consolidated-param-map.d.ts

@@ -5,8 +5,8 @@ import { ParamMap, UrlSegment } from '@angular/router';
  * param map even when `parameter`s has content.
  */
 export declare class ConsolidatedParameterMap implements ParamMap {
-    private paramMaps;
-    constructor(paramMap: ParamMap, urlSegments: UrlSegment[]);
+    private readonly paramMaps;
+    constructor(urlSegments: UrlSegment[], paramMap?: ParamMap);
     get(name: string): string | null;
     getAll(name: string): string[];
     has(name: string): boolean;

package/lib/place/navigation/place-component-deactivation-handler.d.ts

@@ -1,4 +1,5 @@
 import { PlaceComponent } from '../place-component';
+import { PlaceDefinition } from '../place-definition';
 import { UrlSnapshot } from '../url-snapshot';
 import { NavigationSession } from './session/navigation-session';
 /**
@@ -16,7 +17,8 @@ export declare class PlaceComponentDeactivationHandler {
     constructor(component: PlaceComponent, navigationSession: NavigationSession, isPrimaryComponent: boolean);
     get routerInteractionAdapter(): import("../../interaction/exports").InteractionServiceRoutingAdapter;
     get urlService(): import("../url-service").UrlService;
+    get placeDefinition(): PlaceDefinition;
     canDeactivate(currentUrl: UrlSnapshot, nextState: UrlSnapshot): Promise<boolean | UrlSnapshot>;
     protected canDeactivateComponent(currentUrl: UrlSnapshot, nextState: UrlSnapshot): Promise<UrlSnapshot | boolean>;
-    protected isNotJustAChangeInRouteId(nextState: UrlSnapshot): boolean;
+    protected isGoingToADifferentPlace(nextState: UrlSnapshot): boolean;
 }

package/lib/place/place-component.d.ts

@@ -1,19 +1,22 @@
 import { ActivatedRouteSnapshot } from '@angular/router';
-import { Constructable } from '@coolon/pectin';
+import { Constructable, ValueModel } from '@coolon/pectin';
 import 'reflect-metadata';
 import { DisposableComponent } from '../components/disposable-component';
 import { InteractionContext } from '../interaction/interaction-context';
 import { PlaceDefinition } from './place-definition';
 import { ParameterDefinition } from './route/parameter-definition';
+import { UrlSnapshot } from './url-snapshot';
 import { Visit } from './visit';
 export declare const DEFINITION_META_DATA_KEY = "PLACE_DEFINITION_OPTIONS";
 export declare const ROUTE_PARAMETER_LIST_KEY: unique symbol;
 export declare class PlaceComponent extends DisposableComponent {
+    private readonly _placeReadyCallbacks;
     private visitModel;
     private _inVisitUpdate;
     private _active;
     interactionContext?: InteractionContext;
     readonly childPlaces: ReadonlyArray<Constructable<PlaceComponent>>;
+    private readonly _parameterChangeInterceptors;
     canDeactivate?(interactionContext: InteractionContext): boolean | Promise<boolean>;
     constructor();
     initialiseVisit(visit: Visit, notifyVisitChanged: (current: Visit, previous: Visit) => void): void;
@@ -21,16 +24,36 @@ export declare class PlaceComponent extends DisposableComponent {
     isInitialised(): boolean;
     private installBinding;
     get placeDefinition(): PlaceDefinition;
-    get active(): import("@coolon/pectin").ValueModel<boolean>;
+    get active(): ValueModel<boolean>;
+    /**
+     * Called by the router to see if this component can deactivate.  This isn't called for route parameter changes.
+     * @param interactionContext
+     */
+    _canLeavePlace(interactionContext: InteractionContext): Promise<boolean>;
+    /**
+     * Called by the router to see if this component can deactivate.  This isn't called for route parameter changes.
+     * @param interactionContext
+     * @param nextState
+     */
+    _canChangeRouteParameters(interactionContext: InteractionContext, nextState: UrlSnapshot): Promise<boolean>;
     /**
      * Called by the router when the place is ready to interact after any animations have run.
      */
     _notifyActive(active: boolean): void;
-    onPlaceReady(): void;
+    /**
+     * Called by the router when the place is ready to interact after any animations have run.
+     */
+    _notifyPlaceReady(): void;
+    onPlaceReady(callback: () => void): void;
+    interceptVisitParameterChange<T>(model: ValueModel<T>, callback: PlaceComponent.InterceptCallback<T>, options?: PlaceComponent.InterceptOptions): void;
 }
 export declare namespace PlaceComponent {
     function isPlaceComponentConstructor(target: any): target is Constructable<PlaceComponent>;
     function getRouteParameters(klass: Constructable<PlaceComponent>): ParameterDefinition<any>[];
     function getDefinition(snapshotOrConstructor: ActivatedRouteSnapshot | Constructable<PlaceComponent>): PlaceDefinition;
     function injectDefinition(klass: Constructable<PlaceComponent>, definition: PlaceDefinition): void;
+    type InterceptCallback<T> = (is: T, was: T, interactionContext: InteractionContext) => boolean | Promise<boolean>;
+    interface InterceptOptions {
+        initialValue: 'evaluationUnlessNil' | 'evaluate';
+    }
 }

package/lib/place/route/parameter-definition.d.ts

@@ -1,4 +1,5 @@
 import { Injector } from '@angular/core';
+import { HasValue, ListModel, MutableListModel, MutableValueModel, ValueModel } from '@coolon/pectin';
 import { PlaceHistory } from '../place-history';
 import { Visit } from '../visit';
 import { Formatter } from './formatter';
@@ -10,11 +11,13 @@ export declare abstract class ParameterDefinition<T, E = T> {
     readonly remember: boolean;
     readonly defaultValue: T;
     private options;
+    protected abstract backingModelFactory: () => HasValue<T>;
     constructor(propertyName: string, options: ParameterDefinition.Options<T>, urlFormat?: Formatter<E>);
     get name(): string;
     get isRouteParameter(): boolean;
     abstract isEmptyValue(value: T): boolean;
     abstract hasChanged(a: any, b: any): boolean;
+    createBackingModel(): HasValue<T>;
     protected getOptionValue<K extends keyof ParameterDefinition.Options<T>>(key: K): ParameterDefinition.Options<T>[K];
     sanitise(value: T, visit: Visit, placeHistory: PlaceHistory, injector: Injector, isPopState: boolean): Promise<T>;
     private isMissingFrom;
@@ -29,20 +32,25 @@ export declare namespace ParameterDefinition {
     class RouteId<T> extends ParameterDefinition<T> {
         readonly isRouteId = true;
         readonly isArray = false;
+        protected backingModelFactory: () => MutableValueModel<T>;
         isEmptyValue(value: T): boolean;
         hasChanged(a: any, b: any): boolean;
     }
     class ValueParameter<T> extends ParameterDefinition<T> {
         readonly isRouteId = false;
         readonly isArray = false;
+        protected backingModelFactory: () => MutableValueModel<T>;
         isEmptyValue(value: T): boolean;
         hasChanged(a: any, b: any): boolean;
     }
     class ArrayParameter<T> extends ParameterDefinition<T[], T> {
         readonly isRouteId = false;
         readonly isArray = true;
+        protected backingModelFactory: () => MutableListModel<T>;
         constructor(parameterName: string, options: Options<T[]>, urlFormat: Formatter<T>);
         isEmptyValue(value: T[]): boolean;
         hasChanged(a: T[], b: T[]): boolean;
     }
+    function get<T>(model: ValueModel<T>): ParameterDefinition.ValueParameter<T>;
+    function get<T>(model: ListModel<T>): ParameterDefinition.ArrayParameter<T>;
 }

package/lib/place/url-snapshot.d.ts

@@ -14,6 +14,7 @@ export declare class UrlSnapshot {
      */
     protected getSegmentsFor(visit: Visit): UrlSegment[];
     includesPathOf(placeDef: PlaceDefinition): UrlSegment;
+    createVisitFor(placeDef: PlaceDefinition): Visit;
     getInteractionIds(): string[];
     hasInteractions(): boolean;
     hasInteractionIds(ids: string[]): boolean;

package/lib/place/visit.d.ts

@@ -13,11 +13,11 @@ export declare class Visit {
      * Returns the value of the place parameter with the specified name.  The parameter
      * name is taken from the `as` option, e.g. {as: 'aCustomName'} otherwise it is the
      * same as the the ValueModel property name.
-     * @param parameterName the field name of the property model or the `as` option if specified.
+     * @param parameterDef the visit parameter definition
      */
-    getParameter(parameterName: string): any;
-    hasParameter(parameterName: string): boolean;
-    replace<S>(parameter: ParameterDefinition<any, S>, value: S): Visit;
+    getParameterValue<T, S>(parameterDef: ParameterDefinition<T, S>): T;
+    hasParameter(parameterDef: ParameterDefinition<any>): boolean;
+    replace<T>(parameter: ParameterDefinition<T, any>, value: T): Visit;
     mergeRouteParameters<S>(routeParams: {
         [p: string]: any;
     }): Visit;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coolon/angular-ui-powerups",
-  "version": "12.3.1",
+  "version": "12.4.0-alpha.1",
   "schematics": "./schematics/collection.json",
   "dependencies": {
     "@coolon/typescript-utilities": "^2.2.0",