@energycap/components 0.43.11 → 0.44.0

package/esm2022/lib/display/tour/tour.service.mjs

@@ -1,75 +0,0 @@
-import { Injectable } from '@angular/core';
-import { Subject } from 'rxjs';
-import { TourEvent } from './tour-types';
-import * as i0 from "@angular/core";
-import * as i1 from "../../core/cache.service";
-export class TourService {
-    constructor(cacheService) {
-        this.cacheService = cacheService;
-        this.events = new Subject();
-    }
-    /**
-     * Start a tour of the application. Allows one or many tours to be sent in, each will
-     * follow the next. If multiple tours have exit steps defined only the final tour will
-     * execute the exit step.
-     * @param tours
-     */
-    start(tours, isAutoStart = false) {
-        let tourEvent = new TourEvent(tours, 'start', isAutoStart);
-        this.events.next(tourEvent);
-    }
-    end() {
-        let tourEvent = new TourEvent([], 'end');
-        this.events.next(tourEvent);
-    }
-    append(tours, isAutoStart = false) {
-        let tourEvent = new TourEvent(tours, 'append', isAutoStart);
-        this.events.next(tourEvent);
-    }
-    /**
-     * Returns a formatted cache key for tours
-     * @param tour
-     * @returns
-     */
-    getCacheKey(tour) {
-        return `TourCompleted_${tour.id}`;
-    }
-    /**
-     * Given a tour, check to see if it's been completed
-     * @param tour
-     * @returns
-     */
-    hasTourBeenViewed(tour) {
-        let cacheValue = this.cacheService.getItem(this.getCacheKey(tour));
-        if (cacheValue) {
-            return cacheValue.completed;
-        }
-        else {
-            // If no cache value then we never ran through it and wrote a key
-            return false;
-        }
-    }
-    /**
-     * Given a list of tours, check to see if any will show to the user
-     * @param tours
-     * @returns
-     */
-    haveAllToursBeenViewed(tours) {
-        let viewedCount = 0;
-        tours.forEach(tour => {
-            if (this.hasTourBeenViewed(tour)) {
-                viewedCount++;
-            }
-        });
-        return viewedCount === tours.length;
-    }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.13", ngImport: i0, type: TourService, deps: [{ token: i1.CacheService }], target: i0.ɵɵFactoryTarget.Injectable }); }
-    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.2.13", ngImport: i0, type: TourService, providedIn: 'root' }); }
-}
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.13", ngImport: i0, type: TourService, decorators: [{
-            type: Injectable,
-            args: [{
-                    providedIn: 'root'
-                }]
-        }], ctorParameters: () => [{ type: i1.CacheService }] });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidG91ci5zZXJ2aWNlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vLi4vcHJvamVjdHMvY29tcG9uZW50cy9zcmMvbGliL2Rpc3BsYXkvdG91ci90b3VyLnNlcnZpY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFVBQVUsRUFBRSxNQUFNLGVBQWUsQ0FBQztBQUMzQyxPQUFPLEVBQWMsT0FBTyxFQUFFLE1BQU0sTUFBTSxDQUFDO0FBRTNDLE9BQU8sRUFBd0IsU0FBUyxFQUFFLE1BQU0sY0FBYyxDQUFDOzs7QUFLL0QsTUFBTSxPQUFPLFdBQVc7SUFJdEIsWUFDVSxZQUEwQjtRQUExQixpQkFBWSxHQUFaLFlBQVksQ0FBYztRQUg3QixXQUFNLEdBQTBCLElBQUksT0FBTyxFQUFFLENBQUM7SUFJakQsQ0FBQztJQUVMOzs7OztPQUtHO0lBQ0ksS0FBSyxDQUFDLEtBQWEsRUFBRSxjQUF1QixLQUFLO1FBQ3RELElBQUksU0FBUyxHQUFjLElBQUksU0FBUyxDQUFDLEtBQUssRUFBRSxPQUFPLEVBQUUsV0FBVyxDQUFDLENBQUM7UUFDckUsSUFBSSxDQUFDLE1BQTZCLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQ3RELENBQUM7SUFFTSxHQUFHO1FBQ1IsSUFBSSxTQUFTLEdBQWMsSUFBSSxTQUFTLENBQUMsRUFBRSxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBQ25ELElBQUksQ0FBQyxNQUE2QixDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsQ0FBQztJQUN0RCxDQUFDO0lBRU0sTUFBTSxDQUFDLEtBQWEsRUFBRSxjQUF1QixLQUFLO1FBQ3ZELElBQUksU0FBUyxHQUFjLElBQUksU0FBUyxDQUFDLEtBQUssRUFBRSxRQUFRLEVBQUUsV0FBVyxDQUFDLENBQUM7UUFDdEUsSUFBSSxDQUFDLE1BQTZCLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQ3RELENBQUM7SUFFRDs7OztPQUlHO0lBQ0ksV0FBVyxDQUFDLElBQVU7UUFDM0IsT0FBTyxpQkFBaUIsSUFBSSxDQUFDLEVBQUUsRUFBRSxDQUFDO0lBQ3BDLENBQUM7SUFFRDs7OztPQUlHO0lBQ0ksaUJBQWlCLENBQUMsSUFBVTtRQUNqQyxJQUFJLFVBQVUsR0FBRyxJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU8sQ0FBaUIsSUFBSSxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO1FBQ25GLElBQUksVUFBVSxFQUFFLENBQUM7WUFDZixPQUFPLFVBQVUsQ0FBQyxTQUFTLENBQUM7UUFDOUIsQ0FBQzthQUFNLENBQUM7WUFDTixpRUFBaUU7WUFDakUsT0FBTyxLQUFLLENBQUM7UUFDZixDQUFDO0lBQ0gsQ0FBQztJQUVEOzs7O09BSUc7SUFDSSxzQkFBc0IsQ0FBQyxLQUFhO1FBQ3pDLElBQUksV0FBVyxHQUFXLENBQUMsQ0FBQztRQUU1QixLQUFLLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxFQUFFO1lBQ25CLElBQUksSUFBSSxDQUFDLGlCQUFpQixDQUFDLElBQUksQ0FBQyxFQUFFLENBQUM7Z0JBQ2pDLFdBQVcsRUFBRSxDQUFDO1lBQ2hCLENBQUM7UUFDSCxDQUFDLENBQUMsQ0FBQztRQUVILE9BQU8sV0FBVyxLQUFLLEtBQUssQ0FBQyxNQUFNLENBQUM7SUFDdEMsQ0FBQzsrR0FwRVUsV0FBVzttSEFBWCxXQUFXLGNBRlYsTUFBTTs7NEZBRVAsV0FBVztrQkFIdkIsVUFBVTttQkFBQztvQkFDVixVQUFVLEVBQUUsTUFBTTtpQkFDbkIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBJbmplY3RhYmxlIH0gZnJvbSAnQGFuZ3VsYXIvY29yZSc7XHJcbmltcG9ydCB7IE9ic2VydmFibGUsIFN1YmplY3QgfSBmcm9tICdyeGpzJztcclxuaW1wb3J0IHsgQ2FjaGVTZXJ2aWNlIH0gZnJvbSAnLi4vLi4vY29yZS9jYWNoZS5zZXJ2aWNlJztcclxuaW1wb3J0IHsgVG91ciwgVG91ckNhY2hlRW50cnksIFRvdXJFdmVudCB9IGZyb20gJy4vdG91ci10eXBlcyc7XHJcblxyXG5ASW5qZWN0YWJsZSh7XHJcbiAgcHJvdmlkZWRJbjogJ3Jvb3QnXHJcbn0pXHJcbmV4cG9ydCBjbGFzcyBUb3VyU2VydmljZSB7XHJcblxyXG4gIHB1YmxpYyBldmVudHM6IE9ic2VydmFibGU8VG91ckV2ZW50PiA9IG5ldyBTdWJqZWN0KCk7XHJcblxyXG4gIGNvbnN0cnVjdG9yKFxyXG4gICAgcHJpdmF0ZSBjYWNoZVNlcnZpY2U6IENhY2hlU2VydmljZVxyXG4gICkgeyB9XHJcblxyXG4gIC8qKlxyXG4gICAqIFN0YXJ0IGEgdG91ciBvZiB0aGUgYXBwbGljYXRpb24uIEFsbG93cyBvbmUgb3IgbWFueSB0b3VycyB0byBiZSBzZW50IGluLCBlYWNoIHdpbGxcclxuICAgKiBmb2xsb3cgdGhlIG5leHQuIElmIG11bHRpcGxlIHRvdXJzIGhhdmUgZXhpdCBzdGVwcyBkZWZpbmVkIG9ubHkgdGhlIGZpbmFsIHRvdXIgd2lsbFxyXG4gICAqIGV4ZWN1dGUgdGhlIGV4aXQgc3RlcC5cclxuICAgKiBAcGFyYW0gdG91cnMgXHJcbiAgICovXHJcbiAgcHVibGljIHN0YXJ0KHRvdXJzOiBUb3VyW10sIGlzQXV0b1N0YXJ0OiBib29sZWFuID0gZmFsc2UpOiB2b2lkIHtcclxuICAgIGxldCB0b3VyRXZlbnQ6IFRvdXJFdmVudCA9IG5ldyBUb3VyRXZlbnQodG91cnMsICdzdGFydCcsIGlzQXV0b1N0YXJ0KTtcclxuICAgICh0aGlzLmV2ZW50cyBhcyBTdWJqZWN0PFRvdXJFdmVudD4pLm5leHQodG91ckV2ZW50KTtcclxuICB9XHJcblxyXG4gIHB1YmxpYyBlbmQoKTogdm9pZCB7XHJcbiAgICBsZXQgdG91ckV2ZW50OiBUb3VyRXZlbnQgPSBuZXcgVG91ckV2ZW50KFtdLCAnZW5kJyk7XHJcbiAgICAodGhpcy5ldmVudHMgYXMgU3ViamVjdDxUb3VyRXZlbnQ+KS5uZXh0KHRvdXJFdmVudCk7XHJcbiAgfVxyXG5cclxuICBwdWJsaWMgYXBwZW5kKHRvdXJzOiBUb3VyW10sIGlzQXV0b1N0YXJ0OiBib29sZWFuID0gZmFsc2UpOiB2b2lkIHtcclxuICAgIGxldCB0b3VyRXZlbnQ6IFRvdXJFdmVudCA9IG5ldyBUb3VyRXZlbnQodG91cnMsICdhcHBlbmQnLCBpc0F1dG9TdGFydCk7XHJcbiAgICAodGhpcy5ldmVudHMgYXMgU3ViamVjdDxUb3VyRXZlbnQ+KS5uZXh0KHRvdXJFdmVudCk7XHJcbiAgfVxyXG5cclxuICAvKipcclxuICAgKiBSZXR1cm5zIGEgZm9ybWF0dGVkIGNhY2hlIGtleSBmb3IgdG91cnNcclxuICAgKiBAcGFyYW0gdG91ciBcclxuICAgKiBAcmV0dXJucyBcclxuICAgKi9cclxuICBwdWJsaWMgZ2V0Q2FjaGVLZXkodG91cjogVG91cik6IHN0cmluZyB7XHJcbiAgICByZXR1cm4gYFRvdXJDb21wbGV0ZWRfJHt0b3VyLmlkfWA7XHJcbiAgfVxyXG5cclxuICAvKipcclxuICAgKiBHaXZlbiBhIHRvdXIsIGNoZWNrIHRvIHNlZSBpZiBpdCdzIGJlZW4gY29tcGxldGVkXHJcbiAgICogQHBhcmFtIHRvdXIgXHJcbiAgICogQHJldHVybnMgXHJcbiAgICovXHJcbiAgcHVibGljIGhhc1RvdXJCZWVuVmlld2VkKHRvdXI6IFRvdXIpOiBib29sZWFuIHtcclxuICAgIGxldCBjYWNoZVZhbHVlID0gdGhpcy5jYWNoZVNlcnZpY2UuZ2V0SXRlbTxUb3VyQ2FjaGVFbnRyeT4odGhpcy5nZXRDYWNoZUtleSh0b3VyKSk7XHJcbiAgICBpZiAoY2FjaGVWYWx1ZSkge1xyXG4gICAgICByZXR1cm4gY2FjaGVWYWx1ZS5jb21wbGV0ZWQ7XHJcbiAgICB9IGVsc2Uge1xyXG4gICAgICAvLyBJZiBubyBjYWNoZSB2YWx1ZSB0aGVuIHdlIG5ldmVyIHJhbiB0aHJvdWdoIGl0IGFuZCB3cm90ZSBhIGtleVxyXG4gICAgICByZXR1cm4gZmFsc2U7XHJcbiAgICB9XHJcbiAgfVxyXG5cclxuICAvKipcclxuICAgKiBHaXZlbiBhIGxpc3Qgb2YgdG91cnMsIGNoZWNrIHRvIHNlZSBpZiBhbnkgd2lsbCBzaG93IHRvIHRoZSB1c2VyXHJcbiAgICogQHBhcmFtIHRvdXJzIFxyXG4gICAqIEByZXR1cm5zIFxyXG4gICAqL1xyXG4gIHB1YmxpYyBoYXZlQWxsVG91cnNCZWVuVmlld2VkKHRvdXJzOiBUb3VyW10pOiBib29sZWFuIHtcclxuICAgIGxldCB2aWV3ZWRDb3VudDogbnVtYmVyID0gMDtcclxuXHJcbiAgICB0b3Vycy5mb3JFYWNoKHRvdXIgPT4ge1xyXG4gICAgICBpZiAodGhpcy5oYXNUb3VyQmVlblZpZXdlZCh0b3VyKSkge1xyXG4gICAgICAgIHZpZXdlZENvdW50Kys7XHJcbiAgICAgIH1cclxuICAgIH0pO1xyXG5cclxuICAgIHJldHVybiB2aWV3ZWRDb3VudCA9PT0gdG91cnMubGVuZ3RoO1xyXG4gIH1cclxufVxyXG4iXX0=

package/lib/display/tour/tour-types.d.ts

@@ -1,70 +0,0 @@
-import { TemplateRef, Type } from "@angular/core";
-import { DialogContent } from "../dialog/dialog-content";
-import { DialogOptions, DialogSize } from "../dialog/dialog-types";
-import { TooltipPosition } from "../tooltip/tooltip.component";
-export type TourCacheEntry = {
-    completed: boolean;
-};
-export declare class Tour<T = any> {
-    /** Unique identifier for the tour */
-    id: string;
-    /** List of tour steps to present to the user */
-    steps: TourStep[];
-    /** Final step to be presented to the user if defined */
-    exitStep?: TourStep;
-    /** Dialog to present to the user before the tour begins */
-    introDialog?: TourIntroDialog<T>;
-}
-export interface TourIntroDialog<T> {
-    content?: Type<DialogContent<T>> | TemplateRef<any>;
-    context?: T;
-    options?: DialogOptions;
-    size?: DialogSize;
-}
-export declare class TourStep {
-    /** Unique identifier for the tour step */
-    id: string;
-    /** Optional tour step title displayed at top of tooltip */
-    title?: string;
-    /** Optional media to display below title and above tour text. Can be a jpg, png, or gif */
-    media?: string;
-    /** HTML formatted text that contains the primary content of the tour step */
-    text: string;
-    /** The element to attach the tour step to. If undefined, step will appear centered on screen */
-    anchor?: TourAnchor;
-    helpLink?: string;
-    /** Allows the step to have a fixed width defined for the tooltip. If not defined the width will be defaulted to 400. If you would like
-     *  auto width define as 'auto'.
-     */
-    width?: number | 'auto';
-    /** Allows the step to have a max width defined for the tooltip */
-    maxWidth?: number;
-}
-export declare class TourAnchor {
-    /**
-     * Optional css selector of an element to click in order to open a menu or
-     * overlay. Should not cause a navigation. If defined but does not exist in
-     * the DOM, skip this step because it is probably hidden to the user because of permissions
-     */
-    clickBefore?: string;
-    /**
-     * CSS selector of element to click in order to close a menu or overlay
-     * before continuing to the next step. Ignored if clickBefore is undefined.
-     * Should not cause a navigation
-     */
-    clickAfter?: string;
-    /**
-     * Selector to attach the tooltip to. If defined but does not exist in the
-     * DOM skip this step because it is probably hidden to the user because of
-     * permissions.
-     */
-    selector: string;
-    /** Position of the tooltip relative to the anchor. https://energycap-components.netlify.app/tooltip#position */
-    position?: TooltipPosition;
-}
-export declare class TourEvent {
-    tours: Tour[];
-    tourAction: 'start' | 'end' | 'append';
-    isAutoStart: boolean;
-    constructor(tours: Tour[], tourAction?: 'start' | 'end' | 'append', isAutoStart?: boolean);
-}

package/lib/display/tour/tour.component.d.ts

@@ -1,147 +0,0 @@
-import { OnInit, TemplateRef } from '@angular/core';
-import { TranslateService } from '@ngx-translate/core';
-import { CacheService } from '../../core/cache.service';
-import { TelemetryService } from '../../core/telemetry.service';
-import { DialogService } from '../dialog/dialog.service';
-import { TooltipComponent } from './../tooltip/tooltip.component';
-import { TooltipService } from './../tooltip/tooltip.service';
-import { TourStep } from './tour-types';
-import { TourService } from './tour.service';
-import * as i0 from "@angular/core";
-export declare class TourComponent implements OnInit {
-    private tourService;
-    private tooltipService;
-    private telemetryService;
-    private cacheService;
-    private dialogService;
-    private translateService;
-    private document;
-    /** Current tour step being shown to the user. The custom content in the template is bound to properties on this and therefor needs to be
-    *  its own property. The exitStep is a tour step and this will hold that step at the end of the tour.
-    */
-    currentTourStep?: TourStep;
-    /** Used to tell the UI that the step being shown is an exit step. This will change the
-     *  link text and the action when clicked
-     */
-    showDoneButton: boolean;
-    /** Reference to the tooltip used for the tour steps */
-    tooltip?: TooltipComponent;
-    /** Array of tours provided when the start tour event was detected */
-    private tours;
-    private currentStepIndex;
-    private currentTourIndex;
-    /** Used to know if the restore step should be triggered when the tour is dismissed */
-    private isAutoStart;
-    private destroyed;
-    custom: TemplateRef<any>;
-    constructor(tourService: TourService, tooltipService: TooltipService, telemetryService: TelemetryService, cacheService: CacheService, dialogService: DialogService, translateService: TranslateService, document: Document);
-    ngOnInit(): void;
-    ngOnDestroy(): void;
-    /**
-     * Called when a restore step has been completed
-     */
-    done(): Promise<void>;
-    /**
-     * Called when a tour begins and when the user clicks next on the current tour step. It will handle any after click actions and then
-     * find the next step and present it to the user and transition to a restore step or new tour if needed.
-     */
-    showNextStep(): Promise<void>;
-    private setupTourComponent;
-    /**
-     * Shows a tour and emits an event that it was started
-     * @param tour
-     */
-    private showNextTour;
-    private endTour;
-    /**
-     * Displays a tooltip for the current tour step
-     */
-    private showStepTooltip;
-    /**
-     * Subscribes to the tooltips onHide event emitter and reacts if the user dismisses the tooltip
-     */
-    private subscribeToTooltipOnHide;
-    /**
-     * Loops through the current tour steps starting after the current step index. It will try to find a visible
-     * selector and if so return the index.
-     * @returns
-     */
-    private getNextAvailableStepIndex;
-    /**
-     * Try to find the tour step element to know if it is visible for the user. Check for the clickBefore first if defined
-     * @param anchor
-     * @returns
-     */
-    private stepElementFound;
-    /**
-     * Some tour steps may have a click after defined. If so call the click method on the html element
-     */
-    private handleClickAfter;
-    /**
-     * Some tour steps may have a click before defined. If so call the click method on the html element
-     */
-    private handleClickBefore;
-    /**
-    * Checks for an exit step on the current tour and if found displays the step
-    */
-    private handleExitStep;
-    /**
-     * Try to find the element with the selector provided and if so click it. This is how tour steps will open/close menus to
-     * give a tour to the user
-     * @param selector
-     */
-    private clickElementIfFound;
-    /**
-     * When auto starting tours we will want to remove any that have the local storage key written as completed so
-     * they are not presented to the user again.
-     * @param tours
-     * @returns
-     */
-    private removeCompletedTours;
-    /**
-     * Writes a key to local storage so the tour will not be shown again automatically
-     */
-    private writeCompletionKey;
-    /**
-     * When dismissing a tour or one being dismissed via a navigation event, etc we will want to mark
-     * every tour in the array as completed so it doesn't resurface unless the user requests the tour.
-     * This function will loop over all and write the local storage key
-     */
-    private writeCompletionKeyForAllTours;
-    /**
-     * Cache key used to set/get the completion status of a tour
-     * @param tour
-     * @returns
-     */
-    private makeCacheKey;
-    /**
-     * Removes a tooltip from the view, used when switching tour steps and closing a tour
-     */
-    private removeTooltip;
-    /**
-     * Returns the tour based on the current index
-     */
-    private get currentTour();
-    /**
-     * The click before/after and show tooltip functions need to be wrapped in setTimeout for the UI
-     * to operate correctly but setTimeout is an action we cannot await so we're wrapping it in a promise to return
-     * so the function calls can await the action
-     * @param fn
-     * @returns
-     */
-    private waitForTimeout;
-    /**
-     * Find the "next" or "done" button and focus on it.
-     *
-     * They are mutually exclusive, so if we cannot find the next button
-     * we look for the done button.
-     */
-    private focusOnNextOrDoneButton;
-    /**
-     * Find an element with given selector and focus on it.
-     * Return false if element not found.
-     */
-    private focusOnElement;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TourComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<TourComponent, "ec-tour", never, {}, {}, never, never, false, never>;
-}

package/lib/display/tour/tour.service.d.ts

@@ -1,38 +0,0 @@
-import { Observable } from 'rxjs';
-import { CacheService } from '../../core/cache.service';
-import { Tour, TourEvent } from './tour-types';
-import * as i0 from "@angular/core";
-export declare class TourService {
-    private cacheService;
-    events: Observable<TourEvent>;
-    constructor(cacheService: CacheService);
-    /**
-     * Start a tour of the application. Allows one or many tours to be sent in, each will
-     * follow the next. If multiple tours have exit steps defined only the final tour will
-     * execute the exit step.
-     * @param tours
-     */
-    start(tours: Tour[], isAutoStart?: boolean): void;
-    end(): void;
-    append(tours: Tour[], isAutoStart?: boolean): void;
-    /**
-     * Returns a formatted cache key for tours
-     * @param tour
-     * @returns
-     */
-    getCacheKey(tour: Tour): string;
-    /**
-     * Given a tour, check to see if it's been completed
-     * @param tour
-     * @returns
-     */
-    hasTourBeenViewed(tour: Tour): boolean;
-    /**
-     * Given a list of tours, check to see if any will show to the user
-     * @param tours
-     * @returns
-     */
-    haveAllToursBeenViewed(tours: Tour[]): boolean;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TourService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<TourService>;
-}