angular-toolbox 0.11.3 → 0.12.0

package/lib/core/bridge/app-bridge.d.ts

@@ -2,8 +2,8 @@
  * @license
  * Copyright Pascal ECHEMANN. All Rights Reserved.
  *
- * Use of this source code is governed by an MIT-style license that can be ound in
- * fthe LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ * 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 { AppBridgeCommand } from "../../model/business/lang/app-bridge-command";
 /**

package/lib/core/error/app-bridge-error.d.ts

@@ -2,8 +2,8 @@
  * @license
  * Copyright Pascal ECHEMANN. All Rights Reserved.
  *
- * Use of this source code is governed by an MIT-style license that can be ound in
- * fthe LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ * 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
  */
 /**
  * Represents exceptions thrown by the `AppBridge` class.

package/lib/core/error/http-mock-service-error.d.ts

@@ -2,8 +2,8 @@
  * @license
  * Copyright Pascal ECHEMANN. All Rights Reserved.
  *
- * Use of this source code is governed by an MIT-style license that can be ound in
- * fthe LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ * 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
  */
 /**
  * Represents errors thrown by `HttpMockService` instances.

package/lib/core/error/integrity-error.d.ts

@@ -2,8 +2,8 @@
  * @license
  * Copyright Pascal ECHEMANN. All Rights Reserved.
  *
- * Use of this source code is governed by an MIT-style license that can be ound in
- * fthe LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ * 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
  */
 /**
  * Represents a data integrity violation error.

package/lib/core/error/subscription-error.d.ts

@@ -2,8 +2,8 @@
  * @license
  * Copyright Pascal ECHEMANN. All Rights Reserved.
  *
- * Use of this source code is governed by an MIT-style license that can be ound in
- * fthe LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ * 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
  */
 /**
  * Represents errors thrown by `SubscriptionService` instances.

package/lib/core/impl/lang/identifiable-component.d.ts

@@ -2,8 +2,8 @@
  * @license
  * Copyright Pascal ECHEMANN. All Rights Reserved.
  *
- * Use of this source code is governed by an MIT-style license that can be ound in
- * fthe LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ * 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 { Identifiable } from "../../../model";
 import { Uuid } from "../../../util";

package/lib/core/impl/version/version.impl.d.ts

@@ -2,8 +2,8 @@
  * @license
  * Copyright Pascal ECHEMANN. All Rights Reserved.
  *
- * Use of this source code is governed by an MIT-style license that can be ound in
- * fthe LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ * 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 { Version } from "../../../model";
 /**

package/lib/framework/index.d.ts

@@ -1 +1,3 @@
 export * from './mock/http';
+export * from './mock/http-monitoring-console';
+export * from './logging';

package/lib/framework/logging/connector/console-log-connector.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @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, LogConnector } from "../../../model";
+/**
+ * An implementation of the `LogConnector` class that sends logs to the JavaScript
+ * native `console` object.
+ */
+export declare class ConsoleLogConnector implements LogConnector {
+    /**
+     * @inheritdoc
+     */
+    destroy(): void;
+    /**
+     * @inheritdoc
+     */
+    init(logList: Log[]): void;
+    /**
+     * @inheritdoc
+     */
+    sendLog(log: Log): void;
+    /**
+     * @inheritdoc
+     */
+    clearLogs(): void;
+    /**
+     * Not supported.
+     */
+    copyLogs(): void;
+}

package/lib/framework/logging/connector/default-log-connector.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @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, LogConnector } from "../../../model";
+/**
+ * The default ATX log connector. Allows to process logs silently.
+ * This can be useful for removing logs from production environments, if needed.
+ */
+export declare class DefaultLogConnector implements LogConnector {
+    /**
+     * @inheritdoc
+     */
+    destroy(): void;
+    /**
+     * @inheritdoc
+     */
+    init(logList: Log[]): void;
+    /**
+     * @inheritdoc
+     */
+    sendLog(log: Log): void;
+    /**
+     * @inheritdoc
+     */
+    clearLogs(): void;
+    /**
+     * @inheritdoc
+     */
+    copyLogs(): void;
+}

package/lib/framework/logging/connector/html-log-connector.d.ts

@@ -0,0 +1,72 @@
+/**
+ * @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, LogConnector } from "../../../model";
+/**
+ * An implementation of the `LogConnector` interface that processes logs as HTML renderable elements.
+ */
+export declare class HtmlLogConnector implements LogConnector {
+    /**
+     * @private
+     */
+    private _logs;
+    /**
+     * @private
+     */
+    private _tgt;
+    /**
+     * Creates a new `HtmlLogConnector` instance.
+     *
+     * @param target The HTML element where the logs will be rendered.
+     * @param injectStyle Indicates whether the ATX default HTML styles are injected into the current document (`true`), or not (`false`).
+     */
+    constructor(target: HTMLElement, injectStyle?: boolean);
+    /**
+     * @inheritdoc
+     */
+    init(logList: Log[]): void;
+    /**
+     * @inheritdoc
+     */
+    sendLog(log: Log): void;
+    /**
+     * @inheritdoc
+     */
+    destroy(): void;
+    /**
+     * @inheritdoc
+     */
+    clearLogs(): void;
+    /**
+     * @inheritdoc
+     */
+    copyLogs(): void;
+    /**
+     * @private
+     */
+    private buildLog;
+    /**
+     * @private
+     */
+    private getCssClassName;
+    /**
+     * @private
+     */
+    private getSpan;
+    /**
+     * @private
+     */
+    private injectStyle;
+    /**
+     * @private
+     */
+    private deleteStyle;
+    /**
+     * @private
+     */
+    private getHead;
+}

package/lib/framework/logging/connector/index.d.ts

@@ -0,0 +1,3 @@
+export * from './default-log-connector';
+export * from './console-log-connector';
+export * from './html-log-connector';

package/lib/framework/logging/impl/abstract-logger.d.ts

@@ -0,0 +1,69 @@
+/**
+ * @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, LogConnector, Logger, TransactionalLogger, LogLevel } from "../../../model";
+/**
+ * A convenient immutable instance of the `DefaultLogConnector` class.
+ */
+export declare const DEFAULT_LOG_CONNECTOR: LogConnector;
+/**
+ * The base class for all `Logger` objects.
+ */
+export declare abstract class AbstractLogger implements Logger, TransactionalLogger {
+    /**
+     * @inheritdoc
+     */
+    minLogLevel: LogLevel;
+    /**
+     * The list of logs sent to this logger.
+     */
+    protected logs: Log[];
+    /**
+     * The reference to the log connector associated with this logger.
+     */
+    protected logConnector: LogConnector;
+    /**
+     * @inheritdoc
+     */
+    setLogConnector(value: LogConnector | null): void;
+    /**
+     * @inheritdoc
+     */
+    getLogConnector(): LogConnector;
+    /**
+     * @inheritdoc
+     */
+    getLogs(): Log[];
+    /**
+     * @inheritdoc
+     */
+    info(caller: string | any, msg: string, metadata?: any): void;
+    /**
+     * @inheritdoc
+     */
+    config(caller: string | any, msg: string, metadata?: any): void;
+    /**
+     * @inheritdoc
+     */
+    error(caller: string | any, msg: string, metadata?: any): void;
+    /**
+     * @inheritdoc
+     */
+    warn(caller: string | any, msg: string, metadata?: any): void;
+    /**
+     * @inheritdoc
+     */
+    destroy(): void;
+    /**
+     * @inheritdoc
+     */
+    clearLogs(): void;
+    /**
+     * @private
+     */
+    private addLog;
+}

package/lib/framework/logging/impl/index.d.ts

@@ -0,0 +1,2 @@
+export * from './log-impl';
+export * from './abstract-logger';

package/lib/framework/logging/impl/log-impl.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @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, LogLevel } from "../../../model";
+/**
+ * The default implementation of the `Log` interface.
+ */
+export declare class LogImpl implements Log {
+    /**
+     * @inheritdoc
+     */
+    readonly caller: string;
+    /**
+     * @inheritdoc
+     */
+    readonly message: string;
+    /**
+     * @inheritdoc
+     */
+    readonly level: LogLevel;
+    /**
+     * @inheritdoc
+     */
+    readonly timestamp: number;
+    /**
+     * @inheritdoc
+     */
+    readonly metadata: any;
+    /**
+     * Creates a new `LogImpl` instance.
+     *
+     * @param caller Ahuman readable reference for the invoker associated with this log.
+     * @param message The message associated with this log.
+     * @param level The criticality level of this log.
+     * @param metadata Optional metada associated with this log.
+     */
+    constructor(caller: string, message: string, level: LogLevel, metadata?: any);
+}

package/lib/framework/logging/index.d.ts

@@ -0,0 +1,3 @@
+export * from './util';
+export * from './impl';
+export * from './connector';

package/lib/framework/logging/util/index.d.ts

@@ -0,0 +1,3 @@
+export * from './log.builder';
+export * from './log.util';
+export * from './log.constant';

package/lib/framework/logging/util/log.builder.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
+ */
+import { Log, LogLevel } from "../../../model";
+/**
+ * A static builder that creates new `Log` objects.
+ */
+export declare class LogBuilder {
+    /**
+     * Builds and returns a new `Log` object initialized with the specified parameters.
+     *
+     * @param caller The reference to the object that sends the new log.
+     * @param message The message of the new log.
+     * @param level The level of the new log.
+     * @param metadata The optional metadata associated with the new log.
+     *
+     * @returns A new `Log` object
+     */
+    static build(caller: string, message: string, level?: LogLevel, metadata?: any): Log;
+}

package/lib/framework/logging/util/log.constant.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
+ */
+/**
+ * A convenient string used to identify logs of LogLevel.INFO.
+ */
+export declare const LOG_INFO_STRING: string;
+/**
+ * A convenient string used to identify logs of LogLevel.CONFIG.
+ */
+export declare const LOG_CONFIG_STRING: string;
+/**
+ * A convenient string used to identify logs of LogLevel.WARNING.
+ */
+export declare const LOG_WARNING_STRING: string;
+/**
+ * A convenient string used to identify logs of LogLevel.ERROR.
+ */
+export declare const LOG_ERROR_STRING: string;

package/lib/framework/logging/util/log.util.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @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, LogLevel } from "../../../model";
+/**
+ * A convenient utility class for formatting logs.
+ */
+export declare class LogUtil {
+    /**
+     * Turns the specified log list into a human redeable string.
+     *
+     * @param logList The list of logs to format.
+     * @returns The formatted log list.
+     */
+    static logListToString(logList: Log[]): string;
+    /**
+     * Turns the specified log level into a human redeable string.
+     *
+     * @param level The log level to format.
+     * @returns The formatted log level.
+     */
+    static getLevelString(level: LogLevel): string;
+    /**
+     * Return a string that represents the specified metadata object.
+     *
+     * @param obj The metadata object to format.
+     * @returns A string that represents the specified metadata object.
+     */
+    static metadataToString(obj: any): string;
+    /**
+     * Returns a string that represents the specified timestamp in form `"HH:MM:SS"`.
+     *
+     * @param timestamp The timestamp to format.
+     * @returns A string that represents the specified timestamp in form `"HH:MM:SS"`.
+     */
+    static dateToHHMMSS(timestamp: number): string;
+    /**
+     * Returns a string that represents the specified array.
+     *
+     * @param array The array to format.
+     * @returns A tring that represents the specified array.
+     */
+    private static formatArray;
+}

package/lib/framework/mock/http/core/data-storage.d.ts

@@ -5,7 +5,7 @@
  * 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 { HttpResponseMock } from "../../../../model";
+import { HttpResponseMock, HttpMockRequestMetadata } from "../../../../model";
 /**
  * @private
  * Utility interface used by the `DelegateXhr` class to store HTTP request information.
@@ -35,4 +35,9 @@ export interface DataStorage {
      * The JSON string prepresentation of the loaded data.
      */
     stringifiedData: string;
+    /**
+     * @private
+     * The metadata associated to the HTTP request.
+     */
+    requestMetadata: HttpMockRequestMetadata;
 }

package/lib/framework/mock/http/core/response-delay.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
+ */
+/**
+ * @private
+ * Utility interface used by the `DelegateXhr` class to manage the delay of an HTTP response.
+ */
+export interface ResponseDelay {
+    /**
+     * @private
+     * The amount of time the HTTP resquest is stalled before sending the response, in milliseconds.
+     */
+    stalled: number;
+    /**
+     * @private
+     * The complete duration of an HTTP request, in milliseconds.
+     */
+    duration: number;
+}

package/lib/framework/mock/http/event/event-target.impl.d.ts

@@ -63,6 +63,14 @@ export declare class EventTargetImpl implements EventTarget {
      * @see https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/dispatchEvent
      */
     dispatchEvent(event: Event): boolean;
+    /**
+     * Checks whether the `EventTarget` object has any listeners registered for a specific type of event.
+     *
+     * @param type The type of event.
+     *
+     * @return  A value of `true` if a listener of the specified type is registered; `false` otherwise.
+     */
+    hasEventListener(type: string): boolean;
     /**
      * @private
      */

package/lib/framework/mock/http/logging/http-mock-logger.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @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 { AbstractLogger } from "../../../logging";
+/**
+ * @private
+ * The `Logger` implementation used by the `HttpMockLoggingService` class to manage logs.
+ */
+export declare class HttpMockLogger extends AbstractLogger {
+}

package/lib/framework/mock/http/logging/http-mock-logging-metadata.builder.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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 { XhrProxy, HttpMockLoggingMetadata, HttpMockRequestMetadata } from "../../../../model";
+/**
+ * @private
+ * A static builder for creating `HttpMockLoggingMetadata` objects.
+ */
+export declare class HttpMockLoggingMetadataBuilder {
+    /**
+     * @private
+     * Creates and returns a new `HttpMockLoggingMetadata` object.
+     */
+    static build(xhr: XhrProxy, request: HttpRequest<any>, requestMetadata: HttpMockRequestMetadata): HttpMockLoggingMetadata;
+}

package/lib/framework/mock/http/path-to-regexp/escape-to-regexp-string.d.ts

@@ -2,8 +2,8 @@
  * @license
  * Copyright Pascal ECHEMANN. All Rights Reserved.
  *
- * Use of this source code is governed by an MIT-style license that can be ound in
- * fthe LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ * 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
  *
  * This source code is derived from the following original source code:
  * - https://github.com/pillarjs/path-to-regexp

package/lib/framework/mock/http/path-to-regexp/model/lex-token.d.ts

@@ -2,8 +2,8 @@
  * @license
  * Copyright Pascal ECHEMANN. All Rights Reserved.
  *
- * Use of this source code is governed by an MIT-style license that can be ound in
- * fthe LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ * 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
  *
  * This source code is derived from the following original source code:
  * - https://github.com/pillarjs/path-to-regexp

package/lib/framework/mock/http/util/data-storage.builder.d.ts

@@ -5,7 +5,7 @@
  * 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 { HttpResponseMock } from "../../../../model";
+import { HttpMockRequestMetadata, HttpResponseMock } from "../../../../model";
 import { DataStorage } from "../core/data-storage";
 /**
  * @private
@@ -18,8 +18,9 @@ export declare class DataStorageBuilder {
      *
      * @param httpResponse The `HttpResponseMock` to be stored by the framework.
      * @param data The data of the HTTP response to be stored by the framework.
+     * @param metadata The metadata of the HTTP mock request to be stored by the framework.
      *
      * @returns A new `DataStorage` object.
      */
-    static buildDataStorage(httpResponse: HttpResponseMock, data: any): DataStorage;
+    static buildDataStorage(httpResponse: HttpResponseMock, data: any, metadata: HttpMockRequestMetadata): DataStorage;
 }

package/lib/framework/mock/http/util/http-headers.util.d.ts

@@ -21,6 +21,16 @@ export declare class HttpHeadersUtil {
      * @returns A string compatible with the format expected by the `XMLHttpRequest.getAllResponseHeaders()` method.
      */
     static stringify(headers: HttpHeaders | undefined): string;
+    /**
+     * @private
+     * Returns a `HttpHeaders` object built from the string returns by the `XMLHttpRequest.getAllResponseHeaders()` method,
+     * or `null` wheher  `XMLHttpRequest.getAllResponseHeaders()` return `null`.
+     *
+     * @param value The string to turn into a `HttpHeaders `object.
+     *
+     * @returns A `HttpHeaders` object, or `null`.
+     */
+    static encode(value: string | null): HttpHeaders | null;
     /**
      * @private
      * Creates the default `HttpHeaders` object for a mocked HTTP request.

package/lib/framework/mock/http/util/http-mock-max-delay.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @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
+ */
+/**
+ * A convenient constant that represents the maximum value for a delayed HTTP response.
+ */
+export declare const HTTP_MOCK_MAX_DELAY: number;

package/lib/framework/mock/http/util/http-mock-response-delay.util.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @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 { ResponseDelay } from "../core/response-delay";
+/**
+ * @private
+ * A utility for managing HTTP responses delay.
+ */
+export declare class HttpMockResponseDelayUtil {
+    /**
+     * @private
+     * A utility function that return a `ResponseDelay` object, depending on the timer parameters.
+     *
+     * @param timer The seed value used to create the  `ResponseDelay` object.
+     * @returns A `ResponseDelay` object.
+     */
+    static getResponseDelay(timer: number): ResponseDelay;
+}