angular-toolbox 0.12.1 → 0.12.3

package/lib/framework/mock/http-monitoring-console/util/console-type-class.d.ts

@@ -5,11 +5,39 @@
  * 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
+ * The list of CSS class types for rendered objects.
+ */
 export declare enum ConsoleTypeClass {
+    /**
+     * @private
+     * The class type for JS vanilla objects.
+     */
     OBJECT = "atx-object",
+    /**
+     * @private
+     * The class type for JS string primitives.
+     */
     STRING = "atx-string",
+    /**
+     * @private
+     * The class type for JS number primitives.
+     */
     NUMBER = "atx-number",
+    /**
+     * @private
+     * The class type for JS boolean primitives.
+     */
     BOOLEAN = "atx-boolean",
+    /**
+     * @private
+     * The class type for JS Arrays.
+     */
     ARRAY = "atx-array",
+    /**
+     * @private
+     * The class type for the JS `null` type.
+     */
     NULL = "atx-null"
 }

package/lib/framework/mock/http-monitoring-console/util/data.util.d.ts

@@ -7,7 +7,27 @@
  */
 import { AtxConsoleJson } from '../model/business/atx-console-json';
 import { ConsoleBodyType } from './console-body-type';
+/**
+ * @private
+ * A utility class for managing metadata objects.
+ */
 export declare class DataUtil {
+    /**
+     * @private
+     * Parses the specified object and returns a `AtxConsoleJson` tree that represents
+     * the structure of parsed object.
+     *
+     * @param obj The object to parse.
+     * @param label An optional `label` used to set the label property of the `AtxConsoleJson` object.
+     * @returns a `AtxConsoleJson` tree object.
+     */
     static parseJson(obj: any, label?: string): AtxConsoleJson;
+    /**
+     * @private
+     * Returns a constant of the ConsoleBodyType enum, depending on the type of the specified object.
+     *
+     * @param obj The object for wich to get the type.
+     * @returns A constant of the ConsoleBodyType enum.
+     */
     static getBodyType(obj: any): ConsoleBodyType;
 }

package/lib/framework/mock/http-monitoring-console/util/io/body-converter.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @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 { AtxBodyDto } from "../../model/business/io/atx-body-dto";
+/**
+ * @private
+ * A utility class that performs conversions between JavaScript objects and `AtxBodyDto` objects.
+ */
+export declare class BodyConverter {
+    /**
+     * @private
+     * Turns a JavaScript object into an `AtxBodyDto` object and returns the result of the conversion.
+     *
+     * @param body The JavaScript object to convert.
+     * @returns An `AtxBodyDto` object.
+     */
+    static bodyToDto(body: any): AtxBodyDto;
+    /**
+     * @private
+     * Turns an `AtxBodyDto` object into a JavaScript object and returns the result of the conversion.
+     *
+     * @param dto The `AtxBodyDto` object to convert.
+     * @returns A JavaScript object.
+     */
+    static dtoToBody(dto: AtxBodyDto): any;
+}

package/lib/framework/mock/http-monitoring-console/util/io/body-serializer.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @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 { ConsoleBodyType } from "../console-body-type";
+/**
+ * @private
+ * A utility class that serialize and unserialize the objects rendered into the monitoring console.
+ */
+export declare class BodySerializer {
+    /**
+     * @private
+     * Serializes the specified object depending on the `type` parameter.
+     *
+     * @param data The object to serialize.
+     * @param type The type of the object to serialize.
+     * @returns A string, or `null` whether the object type is not supported.
+     */
+    static serialize(data: any, type: ConsoleBodyType): string | null;
+    /**
+     * @private
+     * Unserializes the specified string depending on the `type` parameter.
+     *
+     * @param data The string to unserialize.
+     * @param type The type of the object to unserialize.
+     * @returns An object, or `null` whether the object type is not supported.
+     */
+    static unserialize(data: any, type: ConsoleBodyType): any;
+}

package/lib/framework/mock/http-monitoring-console/util/io/form-data-serializer.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
+ */
+/**
+ * @private
+ * A utility class that unserialize the `FormData` objects.
+ */
+export declare class FormDataSerializer {
+    /**
+     * @private
+     * Unserializes the specified `FormData` objects.
+     *
+     * @param data The string to turn into a `FormData` object.
+     * @returns A `FormData` object, or null whether the `data` string is not a Array string.
+     */
+    static unserialize(data: string): FormData | null;
+}

package/lib/framework/mock/http-monitoring-console/util/io/hmfl-builder.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @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 { AtxHttpLogDto } from "../../model/business/io/atx-http-log.dto";
+import { HMFL } from "../../model/business/io/hmfl";
+/**
+ * @private
+ * A utility class that creates `HMFL` objects.
+ */
+export declare class HMFLBuilder {
+    /**
+     * @private
+     * Creates and returns a new `HMFL` object.
+     *
+     * @param logDtoList The list of serialized logs to include in the new `HMFL` object.
+     * @returns A new `HMFL` object.
+     */
+    static build(logDtoList: AtxHttpLogDto[]): HMFL;
+}

package/lib/framework/mock/http-monitoring-console/util/io/http-request-converter.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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 { HttpRequest } from "@angular/common/http";
+import { AtxHttpRequestDto } from "../../model/business/io/atx-http-request.dto";
+/**
+ * @private
+ * A utility class that converts `HttpRequest` instances into `AtxHttpRequestDto` objects.
+ */
+export declare class HttpRequestConverter {
+    /**
+     * @private
+     * Converts a `HttpRequest` instance into an `AtxHttpRequestDto` object.
+     *
+     * @param request The `HttpRequest` instance to convert.
+     * @returns A new `AtxHttpRequestDto` object.
+     */
+    static buildRequestDto(request: HttpRequest<any>): AtxHttpRequestDto;
+    /**
+     * @private
+     * Converts an `AtxHttpRequestDto` object into a `HttpRequest` instance.
+     *
+     * @param dto The `AtxHttpRequestDto` object to convert.
+     * @returns A new `HttpRequest` instance.
+     */
+    static buildHttpRequest(dto: AtxHttpRequestDto): HttpRequest<any>;
+}

package/lib/framework/mock/http-monitoring-console/util/io/http-response-converter.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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 { HttpResponse } from "@angular/common/http";
+import { AtxHttpResponseDto } from "../../model/business/io/atx-http-response.dto";
+/**
+ * @private
+ * A utility class that converts `HttpResponse` instances into `AtxHttpResponseDto` objects.
+ */
+export declare class HttpResponseConverter {
+    /**
+     * @private
+     * Converts a `HttpResponse` instance into an `AtxHttpResponseDto` object.
+     *
+     * @param response The `HttpResponse` instance to convert.
+     * @returns A new `AtxHttpResponseDto` object.
+     */
+    static buildResponseDto(response: HttpResponse<any>): AtxHttpResponseDto;
+    /**
+     * @private
+     * Converts an `AtxHttpResponseDto` object into a `HttpResponse` instance.
+     *
+     * @param dto The `AtxHttpResponseDto` object to convert.
+     * @returns A new `HttpResponse` instance.
+     */
+    static buildHttpResponse(dto: AtxHttpResponseDto): HttpResponse<any>;
+}

package/lib/framework/mock/http-monitoring-console/util/io/log-converter.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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 { Log } from "../../../../../model";
+import { AtxHttpLogDto } from "../../model/business/io/atx-http-log.dto";
+/**
+ * @private
+ * A utility class that converts `Log` objects into `AtxHttpLogDto` objects.
+ */
+export declare class LogConverter {
+    /**
+     * @private
+     * Converts a `object` object into an `AtxHttpLogDto` object.
+     *
+     * @param log The `Log` object to convert.
+     * @returns A new `AtxHttpLogDto` object.
+     */
+    static logToDto(log: Log): AtxHttpLogDto;
+    /**
+     * @private
+     * Converts an `AtxHttpLogDto` object into a `Log` object.
+     *
+     * @param dto The `AtxHttpLogDto` object to convert.
+     * @returns A new `Log` object.
+     */
+    static dtoToLog(dto: AtxHttpLogDto): Log;
+}

package/lib/framework/mock/http-monitoring-console/util/io/log-headers-converter.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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 { HttpHeaders } from "@angular/common/http";
+import { AtxHeaderDto } from "../../model/business/io/atx-header-dto";
+/**
+ * @private
+ * A utility class that converts `HttpHeaders` instances into lists of `AtxHeaderDto` objects.
+ */
+export declare class HttpHeadersConverter {
+    /**
+     * @private
+     * Converts a `HttpHeaders` instance into a list of `AtxHeaderDto` object.
+     *
+     * @param headers The `HttpHeaders` instance to convert.
+     * @returns A new `AtxHeaderDto` object.
+     */
+    static headersToDto(headers: HttpHeaders): AtxHeaderDto[];
+    /**
+     * @private
+     * Converts a list of `AtxHeaderDto` objects into a `HttpHeaders` instance.
+     *
+     * @param headersDto The list of `AtxHeaderDto` objects to convert.
+     * @returns A new `HttpHeaders` instance.
+     */
+    static dtoToHeaders(headersDto: AtxHeaderDto[]): HttpHeaders;
+}

package/lib/framework/mock/http-monitoring-console/util/io/log-message.util.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @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 { HttpMockLoggingConstant } from "../../../../../model/business/logging/http-mock-logging-constant.enum";
+import { LogLevel } from "../../../../../model";
+/**
+ * @private
+ * A utility class that returns a human-readable message depending on the specified level.
+ */
+export declare class LogMessageUtil {
+    /**
+     * @private
+     * Returns a human-readable message depending on the specified level.
+     *
+     * @param level The level for which to get the message.
+     * @returns A string.
+     */
+    static getMessageFromLevel(level: LogLevel): HttpMockLoggingConstant;
+}

package/lib/framework/mock/http-monitoring-console/util/io/log-metadata-converter.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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 { HttpMockLoggingMetadata } from "../../../../../model";
+import { AtxHttpLogMetadataDto } from "../../model/business/io/atx-http-log-metadata.dto";
+/**
+ * @private
+ * A utility class that converts `HttpMockLoggingMetadata` objects into `AtxHttpLogMetadataDto` objects.
+ */
+export declare class LogMetadataConverter {
+    /**
+     * @private
+     * Converts a `HttpMockLoggingMetadata` object into an `AtxHttpLogMetadataDto` object.
+     *
+     * @param headers The `HttpMockLoggingMetadata` object to convert.
+     * @returns A new `AtxHttpLogMetadataDto` object.
+     */
+    static metadataToDto(metadata: HttpMockLoggingMetadata): AtxHttpLogMetadataDto;
+    /**
+     * @private
+     * Converts an `AtxHttpLogMetadataDto` object into a `HttpMockLoggingMetadata` object.
+     *
+     * @param headersDto The `AtxHttpLogMetadataDto` objects to convert.
+     * @returns A new `HttpMockLoggingMetadata` objects.
+     */
+    static dtoToMetadata(dto: AtxHttpLogMetadataDto): HttpMockLoggingMetadata;
+}

package/lib/framework/mock/http-monitoring-console/util/io/request-metadata-converter.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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 { HttpMockRequestMetadata } from "../../../../../model";
+import { AtxHttpRequestMetadataDto } from "../../model/business/io/atx-http-request-metadata.dto.ts";
+/**
+ * @private
+ * A utility class that converts `HttpMockRequestMetadata` objects into `AtxHttpRequestMetadataDto` objects.
+ */
+export declare class RequestMetadataConverter {
+    /**
+     * @private
+     * Converts a `HttpMockRequestMetadata` object into an `AtxHttpRequestMetadataDto` object.
+     *
+     * @param headers The `HttpMockRequestMetadata` object to convert.
+     * @returns A new `AtxHttpRequestMetadataDto` object.
+     */
+    static requestMetadataToDto(metadata: HttpMockRequestMetadata): AtxHttpRequestMetadataDto;
+    /**
+     * @private
+     * Converts an `AtxHttpRequestMetadataDto` object into a `HttpMockRequestMetadata` object.
+     *
+     * @param headersDto The `AtxHttpRequestMetadataDto` objects to convert.
+     * @returns A new `HttpMockRequestMetadata` objects.
+     */
+    static dtoToRequestMetadata(dto: AtxHttpRequestMetadataDto): HttpMockRequestMetadata;
+}

package/lib/framework/mock/http-monitoring-console/util/size.util.d.ts

@@ -5,7 +5,29 @@
  * 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
+ * A utility class for managing request data size.
+ */
 export declare class SizeUtil {
+    /**
+     * The string reference to the initial data size.
+     */
+    static readonly INITIAL_SIZE: string;
+    /**
+     * @private
+     * Returns the size of the specified object in bytes.
+     *
+     * @param obj The object for which to get the size.
+     * @returns The size of the specified object.
+     */
     static getSize(obj: any): number;
+    /**
+     * @private
+     *
+     * Returns the string representation of the specified size.
+     * @param size The size, in bytes, for which to get the string representation.
+     * @returns The string representation of the specified size.
+     */
     static sizeToString(size: number): string;
 }

package/lib/framework/mock/http-monitoring-console/util/timeline.util.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @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 { HttpMockRequestMetadata } from "../../../../model";
+import { AtxTimelineData } from "../model/business/atx-timeline-data";
+/**
+ * @private
+ * A utility class for computing the timeline data of an HTTP request.
+ */
+export declare class TimelineUtil {
+    /**
+     * @private
+     * Returns the timeline data for the specified HTTP log.
+     *
+     * @param metadata The HTTP metadata for which to get the timeline data.
+     * @returns A `AtxTimelineData` object.
+     */
+    static getTimelineData(metadata: HttpMockRequestMetadata): AtxTimelineData;
+}

package/lib/framework/mock/http-monitoring-console/util/url.util.d.ts

@@ -6,8 +6,33 @@
  * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
  */
 import { Log } from "../../../../model";
+/**
+ * @private
+ * A utility class for managing request resources path.
+ */
 export declare class UrlUtil {
+    /**
+     * @private
+     * Returns the resource name from the specified HTTP log.
+     *
+     * @param log The HTTP log for which to get the resource name.
+     * @returns A string that represents the resource name of the specified HTTP log.
+     */
     static getResourceName(log: Log): string;
+    /**
+     * @private
+     * Returns the resource name from the specified URL path.
+     *
+     * @param pathname The URL path for which to get the resource name.
+     * @returns A string that represents the resource name of the specified URL path.
+     */
     static getResourceNameFromPath(pathname: string): string;
+    /**
+     * @private
+     * Returns the resource path from the specified HTTP log.
+     *
+     * @param log The HTTP log for which to get the resource path.
+     * @returns A string that represents the resource path of the specified HTTP log.
+     */
     static getResourcePath(log: Log): string;
 }

package/lib/model/business/logging/atx-logger-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 { LoggerConfig } from "./logger-config";
+/**
+ * The default provider for the `LoggerService` configuration. You typically define
+ * the custom properties in the main NgModule declaration to initialize the logger:
+ *
+ * @NgModule({
+ * ...
+ * providers: [
+ *   { provide: ATX_LOGGER_CONFIG, useValue: { dataConnector: new ConsoleLogConnector() } }
+ * ],
+ * ...
+ * });
+ */
+export declare const ATX_LOGGER_CONFIG: LoggerConfig;

package/lib/model/business/logging/index.d.ts

@@ -3,3 +3,5 @@ export * from "./log";
 export * from "./logger";
 export * from "./transactional-logger";
 export * from './log-level.enum';
+export * from './logger-config';
+export * from './atx-logger-config.provider';

package/lib/model/business/logging/log-level.enum.d.ts

@@ -7,7 +7,6 @@
  */
 /**
  * Defines the level of an Angular Toolbox log.
- *
  */
 export declare enum LogLevel {
     /**

package/lib/model/business/logging/logger-config.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @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 { LogConnector } from "./log-connector";
+/**
+ * Defines properties for the `LoggerService` configuration.
+ */
+export interface LoggerConfig {
+    /**
+     * Defines the log connector of the `LoggerService` singleton.
+     */
+    logConnector?: LogConnector;
+}

package/lib/model/business/logging/logger.d.ts

@@ -24,7 +24,7 @@ export interface Logger {
      *
      * @param caller The reference to the caller that sends the log.
      * @param message The log message.
-     * @param metadata Optionale metadata associated with this log.
+     * @param metadata Optional metadata associated with this log.
      */
     info(caller: string | any, message: string, metadata?: any): void;
     /**
@@ -32,7 +32,7 @@ export interface Logger {
      *
      * @param caller The reference to the caller that sends the log.
      * @param message The log message.
-     * @param metadata Optionale metadata associated with this log.
+     * @param metadata Optional metadata associated with this log.
      */
     config(caller: string | any, message: string, metadata?: any): void;
     /**
@@ -40,15 +40,15 @@ export interface Logger {
      *
      * @param caller The reference to the caller that sends the log.
      * @param message The log message.
-     * @param metadata Optionale metadata associated with this log.
+     * @param metadata Optional metadata associated with this log.
      */
     error(caller: string | any, message: string, metadata?: any): void;
     /**
-     * Sends an warning log to the service.
+     * Sends a warning log to the service.
      *
      * @param caller The reference to the caller that sends the log.
      * @param message The log message.
-     * @param metadata Optionale metadata associated with this log.
+     * @param metadata Optional metadata associated with this log.
      */
     warn(caller: string | any, message: string, metadata?: any): void;
     /**

package/lib/model/business/logging/transactional-logger.d.ts

@@ -8,7 +8,7 @@
 import { Destroyable } from "../lang";
 import { LogConnector } from "./log-connector";
 /**
- * TTransactional loggers allow to create proxy via the `LogConnector` interface
+ * Transactional loggers allow to create proxy via the `LogConnector` interface
  * to send logs to third-party tools.
  */
 export interface TransactionalLogger extends Destroyable {

package/lib/model/business/mock/http/popup/atx-http-mock-console-popup.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @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 { ComponentRef } from "@angular/core";
+import { AtxMonitoringConsoleComponent } from "../../../../../framework";
+/**
+ * The `AtxHttpMockConsolePopup` interface provides component references for
+ * the ATX monitoring console objects created with the `AtxHttpMockConsoleService` class.
+ */
+export interface AtxHttpMockConsolePopup {
+    /**
+     * The reference to a popup window created with the `AtxHttpMockConsoleService` class.
+     */
+    popup: Window;
+    /**
+     * The reference to a `AtxMonitoringConsoleComponent` instance created with the `AtxHttpMockConsoleService` class.
+     */
+    componentRef: ComponentRef<AtxMonitoringConsoleComponent>;
+}

package/lib/model/service/logging/logger-service.d.ts

@@ -1,9 +1,14 @@
 import { AbstractLogger } from "../../../framework";
+import { LoggerConfig } from "../../business";
 import * as i0 from "@angular/core";
 /**
  * A convenient high-level singleton that implements the `Logger` interface.
  */
 export declare class LoggerService extends AbstractLogger {
-    static ɵfac: i0.ɵɵFactoryDeclaration<LoggerService, never>;
+    /**
+     * @private
+     */
+    constructor(config: LoggerConfig);
+    static ɵfac: i0.ɵɵFactoryDeclaration<LoggerService, [{ optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<LoggerService>;
 }