angular-toolbox 0.11.1 → 0.11.3

package/lib/framework/mock/http/util/fetch-client-response-type.enum.d.ts

@@ -30,5 +30,9 @@ export declare enum FetchClientResponseType {
      * Allows to return the response as a promise that resolves with a `String`.
      * The response is always decoded using UTF-8.
      */
-    TEXT = "text"
+    TEXT = "text",
+    /**
+     * Allows to return the response as a promise that resolves with a `Response` object.
+     */
+    RESPONSE = "response"
 }

package/lib/model/business/mock/http/config/http-mock-production-policy.enum.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @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.
+ */
+export declare enum HttpMockProductionPolicy {
+    /**
+     * Indicates that the framework intercepts requests silently in producion mode.
+     */
+    SILENT = 0,
+    /**
+     * Indicates that the framework has to send a warning message to the console when a request is intercetped in producion mode.
+     */
+    WARNING = 1,
+    /**
+     * Indicates that the framework trhows an error when a request is intercetped in producion mode.
+     */
+    ERROR = 2
+}

package/lib/model/business/mock/http/config/http-mocking-framework-config.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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
+ */
+import { HttpMockProductionPolicy } from "./http-mock-production-policy.enum";
+/**
+ * Defines properties for the HTTP Mocking framework configuration.
+ */
+export interface HttpMockingFrameworkConfig {
+    /**
+     * Indicates whether the visual flag is visible (`false`), or not (`true`).
+     */
+    disableVisualFlag?: boolean;
+    /**
+     * Indicates the behavior of the framework when it is used in production mode.
+     */
+    productionPolicy?: HttpMockProductionPolicy;
+}

package/lib/model/business/mock/http/config/http-mocking-framework-config.provider.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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
+ */
+import { HttpMockingFrameworkConfig } from "./http-mocking-framework-config";
+/**
+ * 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 } }
+ * ],
+ * ...
+ * });
+ */
+export declare const HTTP_MOCKING_FRAMEWORK_CONFIG: HttpMockingFrameworkConfig;

package/lib/model/business/mock/http/config/index.d.ts

@@ -0,0 +1,3 @@
+export * from './http-mocking-framework-config.provider';
+export * from './http-mocking-framework-config';
+export * from './http-mock-production-policy.enum';

package/lib/model/business/mock/http/index.d.ts

@@ -6,3 +6,4 @@ export * from './http-mock-interceptor';
 export * from './http-mock-error';
 export * from './xhr-proxy';
 export * from './fetch-client';
+export * from './config';

package/lib/model/service/mock/http/http-mock.service.d.ts

@@ -1,7 +1,18 @@
+/**
+ * @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
+ */
+import { OnDestroy } from '@angular/core';
 import { HttpMockConfig } from '../../../business';
 import { HTTPMethodRef } from '../../../../framework/mock/http/util/http-method-ref.enum';
 import { RouteMockConfig } from '../../../../framework/mock/http/config/route-mock-config';
 import { Uuid } from '../../../../util';
+import { HttpMockingFrameworkConfigManager } from '../../../../util/http-mocking-framework-config.manager';
+import { HttpMockingFrameworkConfig } from '../../../business/mock/http/config/http-mocking-framework-config';
+import { IdentifiableComponent } from '../../../../core';
 import * as i0 from "@angular/core";
 /**
  * @private
@@ -11,7 +22,7 @@ export declare const HTTP_MOCK_SERVICE: string;
 /**
  * The `HttpMockService` class provides the API for managing HTTP mock configuration objects.
  */
-export declare class HttpMockService {
+export declare class HttpMockService extends IdentifiableComponent implements OnDestroy {
     /**
      * @private
      * Ensures that class type is still accessible after TypeScript compilation.
@@ -32,6 +43,28 @@ export declare class HttpMockService {
      * The reference to the current app URL origin.
      */
     private readonly APP_ORIGIN;
+    /**
+     * @private
+     * The reference to the èHttpMockingFrameworkConfigManager` instance.
+     */
+    private readonly _configMmanager;
+    /**
+     * Returns the vreference to the `HttpMockingFrameworkConfigManager` instance,
+     * associated with this service.
+     */
+    get configMmanager(): HttpMockingFrameworkConfigManager;
+    /**
+     * @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: Document, config: HttpMockingFrameworkConfig);
+    /**
+     * @private
+     */
+    ngOnDestroy(): void;
     /**
      * Adds the specified `HttpMockConfig` object to this `HttpMockService` instance.
      *
@@ -96,6 +129,6 @@ export declare class HttpMockService {
      * @rivate
      */
     private cleanConfig;
-    static ɵfac: i0.ɵɵFactoryDeclaration<HttpMockService, never>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<HttpMockService, [null, { optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<HttpMockService>;
 }

package/lib/util/http-mocking-framework-config.manager.d.ts

@@ -0,0 +1,66 @@
+/**
+ * @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
+ */
+import { Destroyable, HttpMockProductionPolicy } from "../model";
+import { HttpMockingFrameworkConfig } from "../model/business/mock/http/config/http-mocking-framework-config";
+import { HTTPMethodRef } from "../framework/mock/http/util/http-method-ref.enum";
+/**
+ * The object that manages the HTTP Mocking Framework options.
+ */
+export declare class HttpMockingFrameworkConfigManager implements Destroyable {
+    /**
+     * @private
+     */
+    private _document;
+    /**
+     * @private
+     */
+    private _config?;
+    /**
+     * @private
+     */
+    private readonly _isProdMode;
+    /**
+     * @private
+     */
+    private readonly _prodPolicy;
+    /**
+     * Returns the value specified by the `disableVisualFlag` of the `HttpMockingFrameworkConfig` provider,
+     * or `false` when no provider is defined.
+     */
+    get disableVisualFlag(): boolean;
+    /**
+     * Returns the value specified by the `productionPolicy` of the `HttpMockingFrameworkConfig` provider,
+     * or `HttpMockProductionPolicy.ERROR` when no provider is defined.
+     */
+    get productionPolicy(): HttpMockProductionPolicy;
+    /**
+     * @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: Document, isDevMode: boolean, config?: HttpMockingFrameworkConfig);
+    /**
+     * 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?: string, method?: HTTPMethodRef | undefined): void;
+    /**
+     * @private
+     */
+    destroy(): void;
+    /**
+     * @private
+     */
+    private createVisualFlag;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-toolbox",
-  "version": "0.11.1",
+  "version": "0.11.3",
   "license": "SEE LICENSE IN LICENSE",
   "peerDependencies": {
     "@angular/common": "^18.0.0",