@bespunky/angular-zen
Version:
The Angular tools you always wished were there.
64 lines • 12.4 kB
JavaScript
import { Observable, switchMap } from 'rxjs';
import { inject } from '@angular/core';
import { ActivatedRoute, NavigationEnd } from '@angular/router';
import { RouterOutletComponentBus } from '@bespunky/angular-zen/router-x';
import { useRouterEvent } from './use-router-event';
/**
* Recoursively runs a processing function on the route and its children.
* Scan is done from parent to child, meaning the parent is the first to process.
*
* @export
* @param {(RouterOutletComponentBus | null)} componentBus The instance of the component bus.
* @param {ActivatedRouteSnapshot} route The top route on which to apply the processing function.
* @param {RouteProcessFunction} process The function to run on the route and its children.
* The function receives a `route` argument which reflects the route being processed,
* and a `component` argument which reflects the instance of the component loaded for the route's corresponsind outlet.
* If the corresponding outlet wasn't marked with the `publishComponent` directive, the `component` argument will be null.
* @param {number} [levels=-1] (Optional) The number of levels (excluding the parent) to dive deeper into the route tree.
* A value of 1 for example, will process the route and its first-level children only. By default, scans all levels of the route tree.
*/
export function deepScanRoute(componentBus, route, process, levels = -1) {
// Make sure the caller wants scan to proceed, then make sure level limit wasn't reached.
const processing = process(route, componentBus?.instance(route.outlet));
// Negative values will scan all, positives will scan until reaching zero.
const shouldScanChildren = !processing.done && levels !== 0;
if (shouldScanChildren && route.children)
route.children.forEach(childRoute => deepScanRoute(componentBus, childRoute, process, levels - 1));
}
function observeRouteDeepScan(route, componentBus, process, levels) {
return new Observable(({ next, error, complete }) => {
const processAndEmit = (...args) => {
const result = process(...args);
if (result.emit)
next(result.emit);
return result;
};
try {
deepScanRoute(componentBus, route, processAndEmit, levels);
}
catch (e) {
error(e);
}
finally {
complete();
}
});
}
/**
* Creates an observable which, upon navigation end, deep scans the activated route by running the provided
* processing function.
*
* @export
* @template TResult The type of the value emitted by the provided processing function.
* @param {ObservedRouteProcessFunction<TResult>} process The function to run on the activated route and its children.
* @param {number} [levels=-1] (Optional) The number of levels (excluding the parent) to dive deeper into the route tree.
* A value of 1 for example, will process the route and its first-level children only. By default, scans all levels of the route tree.
* @return {Observable<TResult>} An observable which, upon navigation end, deep scans the activated route by running the provided
* processing function.
*/
export function useRouteDeepScan(process, levels = -1) {
const route = inject(ActivatedRoute);
const componentBus = inject(RouterOutletComponentBus);
return useRouterEvent(NavigationEnd).pipe(switchMap(() => observeRouteDeepScan(route.snapshot, componentBus, process, levels)));
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"use-route-deep-scan.js","sourceRoot":"","sources":["../../../../../../../libs/angular-zen/router-x/utils/src/lib/use-route-deep-scan.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,cAAc,EAA0B,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACxF,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAE1E,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AA2BpD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,aAAa,CACzB,YAA6C,EAC7C,KAA6B,EAC7B,OAA6B,EAC7B,SAAiB,CAAC,CAAC;IAGnB,yFAAyF;IACzF,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAExE,0EAA0E;IAC1E,MAAM,kBAAkB,GAAG,CAAC,UAAU,CAAC,IAAI,IAAI,MAAM,KAAK,CAAC,CAAC;IAE5D,IAAI,kBAAkB,IAAI,KAAK,CAAC,QAAQ;QAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,aAAa,CAAC,YAAY,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;AACjJ,CAAC;AAED,SAAS,oBAAoB,CAAU,KAA6B,EAAE,YAA6C,EAAE,OAA8C,EAAE,MAAe;IAEhL,OAAO,IAAI,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE;QAEhD,MAAM,cAAc,GAAG,CAAC,GAAG,IAAuD,EAAE,EAAE;YAElF,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;YAEhC,IAAI,MAAM,CAAC,IAAI;gBAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAEnC,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC;QAEF,IACA;YACI,aAAa,CAAC,YAAY,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC;SAC9D;QACD,OAAO,CAAC,EACR;YACI,KAAK,CAAC,CAAC,CAAC,CAAC;SACZ;gBAED;YACI,QAAQ,EAAE,CAAC;SACd;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,gBAAgB,CAAU,OAA8C,EAAE,SAAiB,CAAC,CAAC;IAEzG,MAAM,KAAK,GAAU,MAAM,CAAC,cAAc,CAAC,CAAC;IAC5C,MAAM,YAAY,GAAG,MAAM,CAAC,wBAAwB,CAAC,CAAC;IAEtD,OAAO,cAAc,CAAC,aAAa,CAAC,CAAC,IAAI,CACrC,SAAS,CAAC,GAAG,EAAE,CAAC,oBAAoB,CAAC,KAAK,CAAC,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CACvF,CAAC;AACN,CAAC","sourcesContent":["import { Observable, switchMap } from 'rxjs';\nimport { inject } from '@angular/core';\nimport { ActivatedRoute, ActivatedRouteSnapshot, NavigationEnd } from '@angular/router';\nimport { RouterOutletComponentBus } from '@bespunky/angular-zen/router-x';\nimport { AnyObject } from '@bespunky/typescript-utils';\nimport { useRouterEvent } from './use-router-event';\n\nexport interface RouteProcessResult\n{\n    /**\n     * Used for optimizing the recursion of the deep route scanning operation by feeding it back with a 'stop' signal.\n     *\n     * @type {boolean}\n     */\n    done: boolean;\n}\n\nexport interface ObservedRouteProcessResult<T> extends RouteProcessResult\n{\n    /**\n     * Used for feeding a value from your process function back to the deep route scanning operation.\n     * The scan operation will emit this value through the observable it returned.\n     *\n     * @type {T}\n     */\n    emit?: T;\n}\n\nexport type RouteProcessFunction<TResult extends RouteProcessResult = RouteProcessResult> = (route: ActivatedRouteSnapshot, component?: AnyObject | null) => TResult;\n\nexport type ObservedRouteProcessFunction<TResult> = RouteProcessFunction<ObservedRouteProcessResult<TResult>>;\n\n/**\n * Recoursively runs a processing function on the route and its children.\n * Scan is done from parent to child, meaning the parent is the first to process.\n *\n * @export\n * @param {(RouterOutletComponentBus | null)} componentBus The instance of the component bus.\n * @param {ActivatedRouteSnapshot} route The top route on which to apply the processing function. \n * @param {RouteProcessFunction} process The function to run on the route and its children.\n * The function receives a `route` argument which reflects the route being processed,\n * and a `component` argument which reflects the instance of the component loaded for the route's corresponsind outlet.\n * If the corresponding outlet wasn't marked with the `publishComponent` directive, the `component` argument will be null.\n * @param {number} [levels=-1] (Optional) The number of levels (excluding the parent) to dive deeper into the route tree.\n * A value of 1 for example, will process the route and its first-level children only. By default, scans all levels of the route tree.\n */\nexport function deepScanRoute(\n    componentBus: RouterOutletComponentBus | null,\n    route: ActivatedRouteSnapshot,\n    process: RouteProcessFunction,\n    levels: number = -1\n): void\n{\n    // Make sure the caller wants scan to proceed, then make sure level limit wasn't reached.\n    const processing = process(route, componentBus?.instance(route.outlet));\n\n    // Negative values will scan all, positives will scan until reaching zero.\n    const shouldScanChildren = !processing.done && levels !== 0;\n    \n    if (shouldScanChildren && route.children) route.children.forEach(childRoute => deepScanRoute(componentBus, childRoute, process, levels - 1));\n}\n\nfunction observeRouteDeepScan<TReturn>(route: ActivatedRouteSnapshot, componentBus: RouterOutletComponentBus | null, process: ObservedRouteProcessFunction<TReturn>, levels?: number): Observable<TReturn>\n{\n    return new Observable(({ next, error, complete }) =>\n    {\n        const processAndEmit = (...args: Parameters<ObservedRouteProcessFunction<TReturn>>) =>\n        {\n            const result = process(...args);\n    \n            if (result.emit) next(result.emit);\n    \n            return result;\n        };\n\n        try\n        {\n            deepScanRoute(componentBus, route, processAndEmit, levels);\n        }\n        catch (e)\n        {\n            error(e);\n        }\n        finally\n        {\n            complete();\n        }\n    });\n}\n\n/**\n * Creates an observable which, upon navigation end, deep scans the activated route by running the provided\n * processing function.\n *\n * @export\n * @template TResult The type of the value emitted by the provided processing function.\n * @param {ObservedRouteProcessFunction<TResult>} process The function to run on the activated route and its children.\n * @param {number} [levels=-1] (Optional) The number of levels (excluding the parent) to dive deeper into the route tree.\n * A value of 1 for example, will process the route and its first-level children only. By default, scans all levels of the route tree.\n * @return {Observable<TResult>} An observable which, upon navigation end, deep scans the activated route by running the provided\n * processing function.\n */\nexport function useRouteDeepScan<TResult>(process: ObservedRouteProcessFunction<TResult>, levels: number = -1): Observable<TResult>\n{\n    const route        = inject(ActivatedRoute);\n    const componentBus = inject(RouterOutletComponentBus);\n\n    return useRouterEvent(NavigationEnd).pipe(\n        switchMap(() => observeRouteDeepScan(route.snapshot, componentBus, process, levels))\n    );\n}"]}