angular-toolbox 0.11.2 → 0.11.3

package/fesm2022/angular-toolbox.mjs

@@ -1,5 +1,5 @@
 import * as i0 from '@angular/core';
-import { Injectable, NgModule, EventEmitter, Component, Directive, Output, Input, HostListener, Inject, inject, Pipe } from '@angular/core';
+import { Injectable, NgModule, EventEmitter, Component, Directive, Output, Input, HostListener, Inject, isDevMode, Optional, inject, Pipe } from '@angular/core';
 import * as i1 from '@angular/router';
 import { RouterModule } from '@angular/router';
 import { DOCUMENT, XhrFactory } from '@angular/common';
@@ -543,8 +543,8 @@ class AbstractVersionManager {
 const LAYERS_VERSION_CONFIG = {
     major: 0,
     minor: 11,
-    patch: 2,
-    buildTimestamp: 1722064682009,
+    patch: 3,
+    buildTimestamp: 1722599248501,
     metadata: "beta"
 };
 /**
@@ -1353,6 +1353,73 @@ const DARK_MODE_CONFIG = {
  * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
  */
 
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * The list of constant values that can be passed to the `productionPolicy` of the `HttpMockingFrameworkConfig` interface.
+ */
+var HttpMockProductionPolicy;
+(function (HttpMockProductionPolicy) {
+    /**
+     * Indicates that the framework intercepts requests silently in producion mode.
+     */
+    HttpMockProductionPolicy[HttpMockProductionPolicy["SILENT"] = 0] = "SILENT";
+    /**
+     * Indicates that the framework has to send a warning message to the console when a request is intercetped in producion mode.
+     */
+    HttpMockProductionPolicy[HttpMockProductionPolicy["WARNING"] = 1] = "WARNING";
+    /**
+     * Indicates that the framework trhows an error when a request is intercetped in producion mode.
+     */
+    HttpMockProductionPolicy[HttpMockProductionPolicy["ERROR"] = 2] = "ERROR";
+})(HttpMockProductionPolicy || (HttpMockProductionPolicy = {}));
+;
+
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * The default provider for the HTTP Mocking Framework configuration. You typically define
+ * the custom properties in the main NgModule declaration to initialize the HTTP Mocking Framework:
+ *
+ * @NgModule({
+ * ...
+ * providers: [
+ *   { provide: HTTP_MOCKING_FRAMEWORK_CONFIG, useValue: { disableVisualFlag: true, productionPolicy: HttpMockProductionPolicy.WARNING } }
+ * ],
+ * ...
+ * });
+ */
+const HTTP_MOCKING_FRAMEWORK_CONFIG = {
+    /**
+     * Indicates whether the visual flag is visible (`false`), or not (`true`).
+     * Default value is `false`.
+     */
+    disableVisualFlag: false,
+    /**
+     * Indicates the behavior of the framework when it is used in production mode.
+     * Default value is `HttpMockProductionPolicy.ERROR`.
+     */
+    productionPolicy: HttpMockProductionPolicy.ERROR
+};
+
 /**
  * @license
  * Copyright Pascal ECHEMANN. All Rights Reserved.
@@ -2615,6 +2682,133 @@ const stringToTokenData = (str, options = {}) => {
     return new TokenData(tokens, delimiter);
 };
 
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * @private
+ */
+const POLICY_WARNING = "HTTP Mocking Framework is running in production mode";
+/**
+ * @private
+ */
+const POLICY_ERROR = new HttpMockServiceError(POLICY_WARNING + ": remove all framework references or change the 'productionPolicy' property value of the HTTP_MOCKING_FRAMEWORK_CONFIG provider.");
+/**
+ * @private
+ */
+const FLAG_ID = "http-mocking-framework-flag";
+/**
+ * The object that manages the HTTP Mocking Framework options.
+ */
+class HttpMockingFrameworkConfigManager {
+    /**
+     * Returns the value specified by the `disableVisualFlag` of the `HttpMockingFrameworkConfig` provider,
+     * or `false` when no provider is defined.
+     */
+    get disableVisualFlag() {
+        const cfg = this._config;
+        return cfg && cfg.disableVisualFlag ? cfg.disableVisualFlag : false;
+    }
+    /**
+     * Returns the value specified by the `productionPolicy` of the `HttpMockingFrameworkConfig` provider,
+     * or `HttpMockProductionPolicy.ERROR` when no provider is defined.
+     */
+    get productionPolicy() {
+        return this._prodPolicy;
+    }
+    /**
+     * @private
+     * Creates and Initializes the manager with the specified config.
+     *
+     * @param document The reference to the `Document` object, injected by Angular.
+     * @param isDevMode Indicates wheter Angular runs in development mode (`true`), or in production mode (`false`).
+     * @param config The `HttpMockingFrameworkConfi` provider.
+     */
+    constructor(document, isDevMode, config) {
+        this._isProdMode = !isDevMode;
+        this._document = document;
+        this._config = config;
+        this._prodPolicy = config && config.productionPolicy !== undefined ? config.productionPolicy : HttpMockProductionPolicy.ERROR;
+        this.checkPolicy();
+        this.createVisualFlag(document, config);
+    }
+    /**
+     * Apply a strategy depending on the current production policy and environment.
+     * @param route An optional parameter used when the methhod is associated to a HTTP request.
+     *              Must be the representation of the intercepted route path.
+     * @param method An optional parameter used when the methhod is associated to a HTTP request.
+     *               Must be the representation of the intercepted HTTP method.
+     */
+    checkPolicy(route, method = undefined) {
+        if (!this._isProdMode)
+            return;
+        if (this._prodPolicy === HttpMockProductionPolicy.ERROR)
+            throw POLICY_ERROR;
+        if (this._prodPolicy === HttpMockProductionPolicy.SILENT)
+            return;
+        const routeMsg = route ? `: intercepted request=[path=${route}, method=${method?.toUpperCase()}]` : ".";
+        console.warn(POLICY_WARNING + routeMsg);
+    }
+    /**
+     * @private
+     */
+    destroy() {
+        const cfg = this._config;
+        const noFlag = (cfg && cfg.disableVisualFlag) === true;
+        this._config = null;
+        if (noFlag)
+            return;
+        const doc = this._document;
+        const flag = doc.getElementById(FLAG_ID);
+        if (flag) {
+            flag.onmouseover = flag.onmouseout = null;
+            doc.body.removeChild(flag);
+        }
+    }
+    /**
+     * @private
+     */
+    createVisualFlag(document, config) {
+        if (config && config.disableVisualFlag)
+            return;
+        const flag = document.createElement("div");
+        const text = document.createTextNode("HTTP Mocking Framwork");
+        const style = flag.style;
+        const body = document.body;
+        flag.setAttribute("id", FLAG_ID);
+        style.backgroundColor = "red";
+        style.color = "white";
+        style.textAlign = "center";
+        style.position = "fixed";
+        style.width = "100%";
+        style.overflow = "hidden";
+        style.height = "26px";
+        style.transition = "all 0.25s ease-in-out";
+        style.zIndex = "10000";
+        style.opacity = "1";
+        style.userSelect = "none";
+        flag.onmouseover = () => {
+            style.height = "26px";
+            style.opacity = "1";
+        };
+        flag.onmouseout = () => {
+            style.height = "6px";
+            style.opacity = "0.35";
+        };
+        flag.appendChild(text);
+        body.insertBefore(flag, body.firstChild);
+        setTimeout(() => {
+            style.height = "4px";
+            style.opacity = "0.35";
+        }, 4000);
+    }
+}
+;
+
 /**
  * @license
  * Copyright Pascal ECHEMANN. All Rights Reserved.
@@ -2630,8 +2824,23 @@ const HTTP_MOCK_SERVICE = "HttpMockService";
 /**
  * The `HttpMockService` class provides the API for managing HTTP mock configuration objects.
  */
-class HttpMockService {
-    constructor() {
+class HttpMockService extends IdentifiableComponent {
+    /**
+     * Returns the vreference to the `HttpMockingFrameworkConfigManager` instance,
+     * associated with this service.
+     */
+    get configMmanager() {
+        return this._configMmanager;
+    }
+    /**
+     * @private
+     * Creates a new `HttpMockService` instance.
+     *
+     * @param _document The reference to the app document.
+     * @param config The optional config provider for the HTTP Mocking Framework.
+     */
+    constructor(document, config) {
+        super(HTTP_MOCK_SERVICE);
         /**
          * @private
          * Ensures that class type is still accessible after TypeScript compilation.
@@ -2652,6 +2861,14 @@ class HttpMockService {
          * The reference to the current app URL origin.
          */
         this.APP_ORIGIN = window.location.origin;
+        this._configMmanager = new HttpMockingFrameworkConfigManager(document, isDevMode(), config);
+    }
+    /**
+     * @private
+     */
+    ngOnDestroy() {
+        this._configMmanager.checkPolicy();
+        this._configMmanager.destroy();
     }
     /**
      * Adds the specified `HttpMockConfig` object to this `HttpMockService` instance.
@@ -2661,6 +2878,7 @@ class HttpMockService {
      */
     addConfig(config) {
         const origin = config.origin || this.APP_ORIGIN;
+        this._configMmanager.checkPolicy();
         this.checkOrigin(origin);
         let id = config.id;
         if (!id) {
@@ -2690,6 +2908,7 @@ class HttpMockService {
      * @param uuid The UUID of the configuration to remove.
      */
     removeConfig(uuid) {
+        this._configMmanager.checkPolicy();
         if (!this.hasRegisteredConfig(uuid))
             return;
         const configId = uuid.toString();
@@ -2704,6 +2923,7 @@ class HttpMockService {
      * Removes all registred configurations from this `HttpMockService` instance.
      */
     clearConfigs() {
+        this._configMmanager.checkPolicy();
         this._configList.clear();
         this._configIdList.length = 0;
     }
@@ -2728,6 +2948,7 @@ class HttpMockService {
     getRouteConfig(url, method) {
         const urlConfigList = this._configList.get(url.origin);
         const route = url.pathname;
+        this._configMmanager.checkPolicy(route, method);
         let result = undefined;
         if (!urlConfigList)
             return result;
@@ -2837,7 +3058,7 @@ class HttpMockService {
     cleanConfig(storage, configId) {
         return storage.filter((value) => value.configId !== configId);
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.0.3", ngImport: i0, type: HttpMockService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.0.3", ngImport: i0, type: HttpMockService, deps: [{ token: DOCUMENT }, { token: HTTP_MOCKING_FRAMEWORK_CONFIG, optional: true }], target: i0.ɵɵFactoryTarget.Injectable }); }
     static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.0.3", ngImport: i0, type: HttpMockService, providedIn: 'root' }); }
 }
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.3", ngImport: i0, type: HttpMockService, decorators: [{
@@ -2845,7 +3066,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.3", ngImpor
             args: [{
                     providedIn: 'root'
                 }]
-        }] });
+        }], ctorParameters: () => [{ type: Document, decorators: [{
+                    type: Inject,
+                    args: [DOCUMENT]
+                }] }, { type: undefined, decorators: [{
+                    type: Optional
+                }, {
+                    type: Inject,
+                    args: [HTTP_MOCKING_FRAMEWORK_CONFIG]
+                }] }] });
 
 /**
  * @license
@@ -4208,5 +4437,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.3", ngImpor
  * Generated bundle index. Do not edit.
  */
 
-export { APP_PRIDGE_REF, AbstractSubscriptionManager, AbstractVersionManager, AnchorLinklDirective, AngularToolboxLogoComponent, AngularToolboxModule, AngularToolboxVersionService, AppBridgeError, AppBrigeService, ArrayList, ArrayListEvent, ArrayListEventType, BIGINT, BOOLEAN, BUTTON_ROLE, ButtonRoleDirective, CSS_PROP, ContentRendererDirective, DARK_MODE_CONFIG, DarkModeService, EMPTY_STRING, FUNCTION, FetchClientBuilder, FetchClientResponseType, HTTP_MOCK_SERVICE, HttpHeadersMockBuilder, HttpMock, HttpMockService, HttpMockServiceError, HttpResponseMockBuilder, IdentifiableComponent, IntegrityError, LINK_ROLE, NUMBER, NavigateToUrlDirective, OBJECT, STORAGE_KEY, STRING, SYMBOL, SafeHtmlPipe, ScrollService, SubscriptionError, SubscriptionService, UNDEFINED, Uuid, VERSION_CONFIG, VersionService, httpHeadersMock, httpMockFactory, httpResponseMock };
+export { APP_PRIDGE_REF, AbstractSubscriptionManager, AbstractVersionManager, AnchorLinklDirective, AngularToolboxLogoComponent, AngularToolboxModule, AngularToolboxVersionService, AppBridgeError, AppBrigeService, ArrayList, ArrayListEvent, ArrayListEventType, BIGINT, BOOLEAN, BUTTON_ROLE, ButtonRoleDirective, CSS_PROP, ContentRendererDirective, DARK_MODE_CONFIG, DarkModeService, EMPTY_STRING, FUNCTION, FetchClientBuilder, FetchClientResponseType, HTTP_MOCKING_FRAMEWORK_CONFIG, HTTP_MOCK_SERVICE, HttpHeadersMockBuilder, HttpMock, HttpMockProductionPolicy, HttpMockService, HttpMockServiceError, HttpResponseMockBuilder, IdentifiableComponent, IntegrityError, LINK_ROLE, NUMBER, NavigateToUrlDirective, OBJECT, STORAGE_KEY, STRING, SYMBOL, SafeHtmlPipe, ScrollService, SubscriptionError, SubscriptionService, UNDEFINED, Uuid, VERSION_CONFIG, VersionService, httpHeadersMock, httpMockFactory, httpResponseMock };
 //# sourceMappingURL=angular-toolbox.mjs.map