turbogui-angular 15.3.0 → 16.0.0

package/fesm2022/turbogui-angular.mjs

@@ -1,5 +1,5 @@
 import * as i0 from '@angular/core';
-import { EventEmitter, Directive, Output, HostListener, NgModule, inject, Injectable, Component, Inject, HostBinding, ViewContainerRef, Input, ViewChild } from '@angular/core';
+import { EventEmitter, Directive, Output, HostListener, NgModule, inject, Injectable, Component, Inject, HostBinding, Input } from '@angular/core';
 import { Subject } from 'rxjs';
 import { ArrayUtils, NumericUtils, HTTPManager, StringUtils, HTTPManagerGetRequest, HTTPManagerPostRequest, BrowserManager, ConversionUtils } from 'turbocommons-ts';
 import * as i1 from '@angular/material/dialog';
@@ -8,7 +8,6 @@ import * as i3 from '@angular/material/button';
 import { MatButtonModule } from '@angular/material/button';
 import * as i2 from '@angular/common';
 import { CommonModule } from '@angular/common';
-import * as i1$2 from '@angular/animations';
 import { style, animate, transition, trigger } from '@angular/animations';
 import { ComponentPortal, DomPortalOutlet } from '@angular/cdk/portal';
 import * as i2$1 from '@angular/material/datepicker';
@@ -476,6 +475,8 @@ class LocalesService extends SingletoneStrictClass {
     }
     /**
      * Initializes the translation system by loading and parsing bundle files from the specified translations path.
+     * After the promise finishes, the class will contain all the translation data and will be ready to translate any
+     * provided key.
      *
      * @param translationsPath - Url where the translations Json structure of libraries/bundles/locales/keys is available.
      * @param locales An array of locale codes (e.g., ['en_US', 'es_ES', 'fr_FR']) to load. These will be added to the translation
@@ -573,8 +574,8 @@ class LocalesService extends SingletoneStrictClass {
      * @param string key The key we want to read from the specified resource bundle
      * @param string bundlePath A string with the format 'library_name/bundle_name' that is used to locate the bundle were the key to translate is found
      * @param array replaceWildcards A list of values that will replace wildcards that may be found on the translated text. Each wildcard
-     *        will be replaced with the element whose index on toReplace matches it. Check the documentation for this.wildCardsFormat
-     *        property to know more about how to setup wildcards.
+     *        will be replaced with the element whose index on replaceWildcards matches it. Check the documentation for this.wildCardsFormat
+     *        property to know more about how to setup wildcards on your translations.
      *
      * @see setWildCardsFormat()
      *
@@ -1273,8 +1274,9 @@ class DialogService extends SingletoneStrictClass {
      *            - modal: True (default) if selecting an option is mandatory to close the dialog, false if the dialog can be closed
      *              by the user clicking outside it
      *            - texts: A list with strings containing the dialog texts, sorted by importance. When dialog has a title, this should
-     *              be placed first, subtitle second and so (Each dialog may accept different number of texts).
+     *              be placed first, subtitle second and so (Each dialog may accept a different custom number of texts).
      *            - options: A list of strings that will be used as button captions for each one of the accepted dialog options
+     *            - data: An object that we can use to pass any extra data that we want to the dialog
      *            - viewContainerRef: This is important if we want to propagate providers from a parent component to this dialog. We must specify
      *              this reference to make sure the same services injected on the parent are available too at the child dialog
      *
@@ -1289,6 +1291,7 @@ class DialogService extends SingletoneStrictClass {
         properties.modal = properties.modal ?? true;
         properties.texts = properties.texts ?? [];
         properties.options = properties.options ?? [];
+        properties.data = properties.data ?? {};
         // Generate a string to uniquely identify this dialog on the list of active dialogs
         // A dialog is considered as unique if the dialog id and texts are exactly the same. We do not take options into consideration
         // as there may be dialogs with a big amount of options available.
@@ -1308,7 +1311,7 @@ class DialogService extends SingletoneStrictClass {
             autoFocus: false,
             closeOnNavigation: !properties.modal,
             viewContainerRef: properties.viewContainerRef,
-            data: { texts: properties.texts, options: properties.options }
+            data: { texts: properties.texts, options: properties.options, data: properties.data }
         });
         // Assign the dialog ID only if specifically set on properties
         if (properties.id && properties.id !== undefined) {
@@ -1604,6 +1607,10 @@ class TurboApiCallerService extends SingletoneStrictClass {
          * URI Path to the web service that performs the user login
          */
         this.loginServiceURI = 'users/login';
+        /**
+         * URI Path to the web service that allows us to create extra user tokens
+         */
+        this.tokenCreationServiceURI = 'users/user-token-create';
         /**
          * URI Path to the web service that performs the user log out
          */
@@ -1796,6 +1803,18 @@ class TurboApiCallerService extends SingletoneStrictClass {
             this.httpManager.execute(request);
         });
     }
+    /**
+     * Perform a request to the API service to create a new token for the user that is currently logged in.
+     *
+     * @param options The parameters that will affect the token behaviour. To learn more about each option, please
+     *        refer to the turbodepot UsersManager class createToken method documentation
+     *
+     * @returns A promise that resolves with the created token string if the request is successful, or rejects
+     *          with an error (containing all the error response details) if the request fails.
+     */
+    createUserToken(options) {
+        return this.call(this.tokenCreationServiceURI, { options: options }, { resultFormat: 'STRING' });
+    }
     /**
      * Checks if the user and password credentials are filled and not empty.
      * If any of the two values is empty, false will be returned
@@ -2001,149 +2020,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.8", ngImpor
                 }]
         }], ctorParameters: () => [{ type: DialogService }, { type: BrowserService }] });
 
-/**
- * TurboGUI is A library that helps with the most common and generic UI elements and functionalities
- *
- * Website : -> http://www.turbogui.org
- * License : -> Licensed under the Apache License, Version 2.0. You may not use this file except in compliance with the License.
- * License Url : -> http://www.apache.org/licenses/LICENSE-2.0
- * CopyRight : -> Copyright 2018 Edertone Advanded Solutions. https://www.edertone.com
- */
-/**
- * Manages adding, removing and manipulating the application views
- */
-class ViewsService extends SingletoneStrictClass {
-    constructor(animationBuilder) {
-        super(ViewsService);
-        this.animationBuilder = animationBuilder;
-        /**
-         * See getter method for docs
-         */
-        this._loadedViewClass = null;
-        /**
-         * See setter method for docs
-         */
-        this._viewContainerRef = null;
-        /**
-         * Contains the reference to the currently loaded view component
-         */
-        this._currentComponentRef = null;
-        /**
-         * Flag that stores if any view is in the process of being loaded
-         */
-        this._isLoadingView = false;
-    }
-    /**
-     * Tells if there's any view currently loaded on the application views container
-     */
-    get isViewLoaded() {
-        return this._loadedViewClass !== null;
-    }
-    /**
-     * Stores a reference to the visual element that will be used as the container for all the views.
-     * This is automatically assigned by the tg-views-container component once it is created.
-     *
-     * @see ViewsContainerComponent for more information
-     */
-    set viewContainerRef(ref) {
-        if (ref !== null && this._viewContainerRef !== null) {
-            throw new Error('Views container already defined. Only one views container element can exist on an application');
-        }
-        this._viewContainerRef = ref;
-    }
-    /**
-     * Create a new view instance with the specified type and add it to the current application views container. Any currently loaded
-     * view will be removed.
-     *
-     * If we push a view while another one is in the process of being loaded, the new push will be ignored.
-     *
-     * Make sure this method is called when all the visual components of the application have been created (ngAfterViewInit)
-     *
-     * @param view The classname for the view that we want to create (must extend View base class). A new angular object
-     *        will be instantiated and loaded into the views container.
-     */
-    async pushView(view) {
-        // If the loaded view is the same as the specified one, we will do nothing
-        if (this._loadedViewClass === view) {
-            return;
-        }
-        // If a view is already being loaded, nothing to do
-        if (this._isLoadingView) {
-            return;
-        }
-        this._isLoadingView = true;
-        // If a view is already loaded, we will unload it first
-        if (this._loadedViewClass !== null) {
-            await this.removeCurrentView();
-        }
-        // Create the new view
-        const newComponentRef = this._viewContainerRef.createComponent(view);
-        newComponentRef.changeDetectorRef.detectChanges();
-        // Set initial opacity to 0
-        newComponentRef.location.nativeElement.style.opacity = '0';
-        // Fade in the new view
-        const fadeInPlayer = this.animationBuilder.build([
-            style({ opacity: 0 }),
-            animate('300ms ease', style({ opacity: 1 }))
-        ]).create(newComponentRef.location.nativeElement);
-        await new Promise((resolve) => {
-            fadeInPlayer.onDone(() => {
-                this._currentComponentRef = newComponentRef;
-                this._loadedViewClass = view;
-                this._isLoadingView = false;
-                resolve();
-            });
-            fadeInPlayer.play();
-        });
-    }
-    /**
-     * Delete the currently loaded view from the views container, and leave it empty.
-     * If no view is currently loaded, this method will do nothing
-     */
-    async popView() {
-        if (this._loadedViewClass !== null && this._currentComponentRef) {
-            await this.removeCurrentView();
-        }
-    }
-    /**
-     * Aux method to remove the currently loaded view from the views container using a promise
-     */
-    removeCurrentView() {
-        if (this._viewContainerRef === null) {
-            throw new Error('Views container not defined. Please declare a <views-container> element in your application');
-        }
-        return new Promise((resolve) => {
-            if (this._currentComponentRef) {
-                const element = this._currentComponentRef.location.nativeElement;
-                const fadeOutPlayer = this.animationBuilder.build([
-                    style({ opacity: 1 }),
-                    animate('300ms ease', style({ opacity: 0 }))
-                ]).create(element);
-                fadeOutPlayer.onDone(() => {
-                    if (this._viewContainerRef !== null) {
-                        this._viewContainerRef.clear();
-                    }
-                    this._currentComponentRef = null;
-                    this._loadedViewClass = null;
-                    resolve();
-                });
-                fadeOutPlayer.play();
-            }
-            else {
-                resolve();
-            }
-        });
-    }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: ViewsService, deps: [{ token: i1$2.AnimationBuilder }], target: i0.ɵɵFactoryTarget.Injectable }); }
-    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: ViewsService, providedIn: 'root' }); }
-}
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: ViewsService, decorators: [{
-            type: Injectable,
-            args: [{
-                    providedIn: 'root',
-                }]
-        }], ctorParameters: () => [{ type: i1$2.AnimationBuilder }] });
-
 /**
  * TurboGUI is A library that helps with the most common and generic UI elements and functionalities
  *
@@ -2439,73 +2315,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.8", ngImpor
                     args: [MAT_DIALOG_DATA]
                 }] }] });
 
-/**
- * TurboGUI is A library that helps with the most common and generic UI elements and functionalities
- *
- * Website : -> http://www.turbogui.org
- * License : -> Licensed under the Apache License, Version 2.0. You may not use this file except in compliance with the License.
- * License Url : -> http://www.apache.org/licenses/LICENSE-2.0
- * CopyRight : -> Copyright 2018 Edertone Advanded Solutions. https://www.edertone.com
- */
-/**
- * Component that is used as a container for application views.
- * We must create only one views container in our application and pass to it a reference to our main
- * viewsService instance. For example:
- *
- * <tg-views-container [viewsService]="viewsService" [initialView]="HomeViewComponent"></tg-views-container>
- */
-class ViewsContainerComponent {
-    constructor() {
-        /**
-         * If we want to load a view by default when this component is loaded for the first time, we can
-         * set here the respective class view and it will be automatically added.
-         */
-        this.initialView = null;
-        /**
-         * A reference to the views service that is used to operate with this views container.
-         * This must be specified when this component is added to the application
-         */
-        this.viewsService = null;
-    }
-    /**
-     * Check that the service reference has been correctly passed
-     */
-    ngOnInit() {
-        if (!(this.viewsService instanceof ViewsService)) {
-            throw new Error('ViewService instance must be referenced on a views container');
-        }
-        else {
-            this.viewsService.viewContainerRef = this.viewContainerRef;
-        }
-        // Set the initial view if defined
-        if (this.initialView !== null) {
-            this.viewsService.pushView(this.initialView);
-        }
-    }
-    /**
-     * Clear the current view from the service when this component is deleted
-     */
-    ngOnDestroy() {
-        if (this.viewsService instanceof ViewsService) {
-            this.viewsService.popView();
-            this.viewsService.viewContainerRef = null;
-        }
-    }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: ViewsContainerComponent, deps: [], target: i0.ɵɵFactoryTarget.Component }); }
-    static { this.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "17.0.8", type: ViewsContainerComponent, isStandalone: true, selector: "tg-views-container", inputs: { initialView: "initialView", viewsService: "viewsService" }, providers: [], viewQueries: [{ propertyName: "viewContainerRef", first: true, predicate: ["viewContainerRef"], descendants: true, read: ViewContainerRef, static: true }], ngImport: i0, template: "<!--\r\n    This is a dummy template component that will be used as the anchor point where the views will be loaded\r\n-->\r\n<ng-template #viewContainerRef></ng-template>", styles: [""] }); }
-}
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: ViewsContainerComponent, decorators: [{
-            type: Component,
-            args: [{ selector: 'tg-views-container', standalone: true, imports: [], providers: [], template: "<!--\r\n    This is a dummy template component that will be used as the anchor point where the views will be loaded\r\n-->\r\n<ng-template #viewContainerRef></ng-template>" }]
-        }], propDecorators: { initialView: [{
-                type: Input
-            }], viewsService: [{
-                type: Input
-            }], viewContainerRef: [{
-                type: ViewChild,
-                args: ['viewContainerRef', { read: ViewContainerRef, static: true }]
-            }] } });
-
 /**
  * TurboGUI is A library that helps with the most common and generic UI elements and functionalities
  *
@@ -2799,14 +2608,21 @@ class GUINotification {
  */
 /**
  * Defines an application view.
- * Our View components must extend this class so they can be manipulated via ViewsService and be correctly linked to a views-container.
+ * This is a base class that helps managing our application views. We should extend this class to create our views, as it forces us
+ * to set the viewContainerRef and the viewService, which are both used when working with views.
+ *
+ * When using view services, it is important to specify the view service as a provider for the view component to ensure that it will
+ * be created and destroyed when the view is created and destroyed.
  */
 class View {
     /**
      * This constructor is specifically designed to force the view to set the viewContainerRef which will be automatically assigned
-     * to the respective view service. If the view has no service, we can set it to null.
+     * to the respective view service. If the view has no service, we can set it to null, but it is recommended to always use a service with a view,
+     * to store the view state and global methods that can be used by other components loaded in the view.
      */
     constructor(viewContainerRef, viewService) {
+        this.viewContainerRef = viewContainerRef;
+        this.viewService = viewService;
         if (viewService !== null) {
             viewService.viewContainerRef = viewContainerRef;
         }
@@ -2943,5 +2759,5 @@ class ValidatorsPlus extends Validators {
  * Generated bundle index. Do not edit.
  */
 
-export { AutoFocusOnDisplayDirective, AutoSelectTextOnFocusDirective, BrowserService, BusyStateBaseComponent, ButtonContainerComponent, ButtonImageComponent, DelayedMethodCallManager, DialogBaseComponent, DialogDateSelectionComponent, DialogErrorComponent, DialogMultipleOptionComponent, DialogService, DialogSingleInputComponent, DialogSingleOptionComponent, DialogSingleSelectionListComponent, DialogTwoOptionComponent, ElementCreatedDirective, ElementDestroyedDirective, FadeAnimationClass, GUINotification, GlobalErrorService, HTTPService, HTTPServiceGetRequest, HTTPServicePostRequest, LocalesService, NotificationService, SingletoneStrictClass, TurboApiCallerService, TurboGuiAngularModule, ValidatorsPlus, View, ViewService, ViewsContainerComponent, ViewsService };
+export { AutoFocusOnDisplayDirective, AutoSelectTextOnFocusDirective, BrowserService, BusyStateBaseComponent, ButtonContainerComponent, ButtonImageComponent, DelayedMethodCallManager, DialogBaseComponent, DialogDateSelectionComponent, DialogErrorComponent, DialogMultipleOptionComponent, DialogService, DialogSingleInputComponent, DialogSingleOptionComponent, DialogSingleSelectionListComponent, DialogTwoOptionComponent, ElementCreatedDirective, ElementDestroyedDirective, FadeAnimationClass, GUINotification, GlobalErrorService, HTTPService, HTTPServiceGetRequest, HTTPServicePostRequest, LocalesService, NotificationService, SingletoneStrictClass, TurboApiCallerService, TurboGuiAngularModule, ValidatorsPlus, View, ViewService };
 //# sourceMappingURL=turbogui-angular.mjs.map