angular-toolbox 1.5.4 → 1.6.0

package/lib/model/business/logging/log-connector.d.ts

@@ -1,36 +0,0 @@
-/**
- * @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 } from "../lang";
-import { Log } from "./log";
-/**
- * The markup interface for Angular Toolbox log connectors. ATX log connectors are
- * controllers that apply specific processing to logs (e.g sending logs to a data base...).
- */
-export interface LogConnector extends Destroyable {
-    /**
-     * Initializes the controller.
-     *
-     * @param logList The initial log list.
-     */
-    init(logList: Log[]): void;
-    /**
-     * Sends the specified log to the controller for processing.
-     *
-     * @param log The log to be sent for processing.
-     */
-    sendLog(log: Log): void;
-    /**
-     * Removes all logs from the controller.
-     */
-    clearLogs(): void;
-    /**
-     * Creates a copy of all logs in the controller.
-     * The copying process depends on the controller implementation.
-     */
-    copyLogs(): void;
-}

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

@@ -1,32 +0,0 @@
-/**
- * @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
- */
-/**
- * Defines the level of an Angular Toolbox log.
- */
-export declare enum LogLevel {
-    /**
-     * Indicates that the log is a basic information message.
-     */
-    INFO = 0,
-    /**
-     * Indicates that the log represents a config message.
-     */
-    CONFIG = 1,
-    /**
-     * Indicates that the log is a warning message.
-     */
-    WARNING = 2,
-    /**
-     * Indicates that the log message represents an error.
-     */
-    ERROR = 3,
-    /**
-     * A special level used by loggers to prevent logs to be processed.
-     */
-    OFF = 4
-}

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

@@ -1,34 +0,0 @@
-/**
- * @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 { LogLevel } from "./log-level.enum";
-/**
- * Represents a log in the Angular Toolbox framework.
- */
-export interface Log {
-    /**
-     * Provides a human readable reference for the invoker associated with this log.
-     */
-    readonly caller: string;
-    /**
-     * The message associated with this log.
-     */
-    readonly message: string;
-    /**
-     * The criticality level of this log.
-     */
-    readonly level: LogLevel;
-    /**
-     * The timestamp at which the log has been created.
-     */
-    readonly timestamp: number;
-    /**
-     * Optional metada associated with this log.
-     * Metadata are typically set by Developer to provide custom objects representations.
-     */
-    readonly metadata?: any;
-}

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

@@ -1,17 +0,0 @@
-/**
- * @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

@@ -1,58 +0,0 @@
-/**
- * @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 { LogLevel } from "./log-level.enum";
-import { Log } from "./log";
-/**
- * The base interface of all logging services in the ATX logging framework.
- */
-export interface Logger {
-    /**
-     * Defines the minimum log lovel at which logs must be processed.
-     */
-    minLogLevel: LogLevel;
-    /**
-     * Returns the list of logs processed by this logging service.
-     */
-    getLogs(): Log[];
-    /**
-     * Sends an information log message to the service.
-     *
-     * @param caller The reference to the caller that sends the log.
-     * @param message The log message.
-     * @param metadata Optional metadata associated with this log.
-     */
-    info(caller: string | any, message: string, metadata?: any): void;
-    /**
-     * Sends a config log message to the service.
-     *
-     * @param caller The reference to the caller that sends the log.
-     * @param message The log message.
-     * @param metadata Optional metadata associated with this log.
-     */
-    config(caller: string | any, message: string, metadata?: any): void;
-    /**
-     * Sends an error log to the service.
-     *
-     * @param caller The reference to the caller that sends the log.
-     * @param message The log message.
-     * @param metadata Optional metadata associated with this log.
-     */
-    error(caller: string | any, message: string, metadata?: any): void;
-    /**
-     * 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 Optional metadata associated with this log.
-     */
-    warn(caller: string | any, message: string, metadata?: any): void;
-    /**
-     * Removes all the logs that have been processed by this logger.
-     */
-    clearLogs(): void;
-}

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

@@ -1,28 +0,0 @@
-/**
- * @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 } from "../lang";
-import { LogConnector } from "./log-connector";
-/**
- * Transactional loggers allow to create proxy via the `LogConnector` interface
- * to send logs to third-party tools.
- */
-export interface TransactionalLogger extends Destroyable {
-    /**
-     * Sets a new log connector this transactional logger.
-     *
-     * @param value The reference to the new log connector associated with this transactional logger.
-     *              If `null` the logger uses the instance defined by the `DEFAULT_LOG_CONNECTOR` constant.
-     */
-    setLogConnector(value: LogConnector | null): void;
-    /**
-     * Returns the reference to the log connector associated with this transactional logger.
-     *
-     * @returns The log connector associated with this transactional logger.
-     */
-    getLogConnector(): LogConnector;
-}

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

@@ -1,24 +0,0 @@
-/**
- * @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

@@ -1,21 +0,0 @@
-/**
- * @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

@@ -1,21 +0,0 @@
-/**
- * @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

@@ -1,3 +0,0 @@
-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/fetch-client.d.ts

@@ -1,13 +0,0 @@
-/**
- * @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 { Observable } from "rxjs";
-/**
- * The markup interface for `Observable` object built from the Fetch API.
- */
-export declare abstract class FetchClient extends Observable<any> {
-}

package/lib/model/business/mock/http/http-method-mock.d.ts

@@ -1,35 +0,0 @@
-/**
- * @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 { HttpResponseMock } from "./http-response-mock";
-import { HttpMockParameters } from "../../../../framework";
-import { HttpMockMethodDescriptor } from "./http-mock-method-descriptor";
-/**
- * The `HttpMethodMock` interface defines the behavior of actions invoked each time an Angular
- * `HttpClient` instance sends requests to a specific API endpoint.
- */
-export interface HttpMethodMock {
-    /**
-     * @private
-     * Current progressive download mechanism will be replaced by a more efficient process.
-     */
-    downloadManager?: any;
-    /**
-     * This method emulates a successful HTTP call response.
-     *
-     * @param request The request associated with a HTTP call.
-     * @param parameters The list of parameters associated with the HTTP request.
-     *
-     * @returns A user-defined `HttpResponse` mock object.
-     */
-    data: (request: HttpRequest<any>, parameters?: HttpMockParameters) => HttpResponseMock;
-    /**
-     * The API descriptor of the associated with this HTTP method.
-     */
-    descriptor?: HttpMockMethodDescriptor;
-}

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

@@ -1,32 +0,0 @@
-/**
- * @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 { Uuid } from "../../../../util";
-import { HttpMockInterceptor } from "./http-mock-interceptor";
-/**
- * An interface that let Developer define mocking strategies for Angular HTTP calls.
- */
-export interface HttpMockConfig {
-    /**
-     * The main URL origin for this mock, as defined by the URL standard.
-     *
-     * @see https://url.spec.whatwg.org/#concept-url-origin
-     */
-    origin?: string;
-    /**
-     * The unique identifier for this HTTP mock config.
-     */
-    id?: Uuid;
-    /**
-     * The configuration of mocking strategies for each specific API.
-     */
-    interceptors: HttpMockInterceptor[];
-    /**
-     * The description of this HTTP API.
-     */
-    description?: string;
-}

package/lib/model/business/mock/http/http-mock-endpoint-descriptor.d.ts

@@ -1,21 +0,0 @@
-/**
- * @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 { HttpParameterDescriptor } from "./http-mock-parameter-descriptor";
-/**
- * Provides the API to create documentation for a specific endpoint.
- */
-export interface HttpMockEndpointDescriptor {
-    /**
-     * The description of the endpoint associated with this descriptor.
-     */
-    description?: string;
-    /**
-     * The description all parameters of the endpoint associated with this descriptor.
-     */
-    params?: HttpParameterDescriptor[];
-}

package/lib/model/business/mock/http/http-mock-endpoint.d.ts

@@ -1,46 +0,0 @@
-/**
- * @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 { HttpMethodMock } from "./http-method-mock";
-import { HttpMockEndpointDescriptor } from "./http-mock-endpoint-descriptor";
-/**
- * Provides the API to define mocking strategies for a specific endpoint.
- */
-export interface HttpMockEndpoint {
-    /**
-     * The API descriptor for this endpoint.
-     */
-    descriptor?: HttpMockEndpointDescriptor;
-    /**
-     * The route part of the endpoint to mock.
-     */
-    route: string;
-    /**
-     * The mock configuration of HTTP `GET` method calls for the specified route.
-     */
-    get?: HttpMethodMock;
-    /**
-     * The mock configuration of HTTP `POST` method calls for the specified route.
-     */
-    post?: HttpMethodMock;
-    /**
-     * The mock configuration of HTTP `PUT` method calls for the specified route.
-     */
-    put?: HttpMethodMock;
-    /**
-     * The mock configuration of HTTP `DELETE` method calls for the specified route.
-     */
-    delete?: HttpMethodMock;
-    /**
-     * The mock configuration of HTTP `PATCH` method calls for the specified route.
-     */
-    patch?: HttpMethodMock;
-    /**
-     * The mock configuration of HTTP `HEAD` method calls for the specified route.
-     */
-    head?: HttpMethodMock;
-}

package/lib/model/business/mock/http/http-mock-error.d.ts

@@ -1,21 +0,0 @@
-/**
- * @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 { HttpStatusCode } from "@angular/common/http";
-/**
- * The `HttpMockError` interface provides the API that must be implemented by HTTP mock errors.
- */
-export interface HttpMockError {
-    /**
-     * Error status code.
-     */
-    status: HttpStatusCode;
-    /**
-     * Textual description of error status code.
-     */
-    statusText: string;
-}

package/lib/model/business/mock/http/http-mock-interceptor.d.ts

@@ -1,31 +0,0 @@
-/**
- * @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 { HttpMockEndpoint } from "./http-mock-endpoint";
-/**
- * Provides the API to define mocking strategies for a specific API.
- */
-export interface HttpMockInterceptor {
-    /**
-     * The ID of this interceptor.
-     */
-    id: string;
-    /**
-     * The URL origin for this interceptor, as defined by the URL standard.
-     *
-     * @see https://url.spec.whatwg.org/#url
-     */
-    origin?: string;
-    /**
-     * A list of endpoints that must be intercepted by the HTTP Mocking Framework.
-     */
-    endpoints: HttpMockEndpoint[];
-    /**
-     * The description of this interceptor.
-     */
-    description?: string;
-}

package/lib/model/business/mock/http/http-mock-method-descriptor.d.ts

@@ -1,29 +0,0 @@
-/**
- * @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 { HttpParameterDescriptor } from "./http-mock-parameter-descriptor";
-/**
- * Provides the API to create documentation for a specific HTTP method.
- */
-export interface HttpMockMethodDescriptor {
-    /**
-     * The description of the method associated with this descriptor.
-     */
-    description?: string;
-    /**
-     * The payload description for the method associated with this descriptor.
-     */
-    payload?: string;
-    /**
-     * The body description for the method associated with this descriptor.
-     */
-    body?: string;
-    /**
-     * The list of query string parameters for the method associated with this descriptor.
-     */
-    queryParams?: HttpParameterDescriptor[];
-}

package/lib/model/business/mock/http/http-mock-parameter-descriptor.d.ts

@@ -1,20 +0,0 @@
-/**
- * @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
- */
-/**
- * Provides the API to create documentation for a specific HTTP parameter.
- */
-export interface HttpParameterDescriptor {
-    /**
-     * The description of the HTTP parameter associated with this descriptor.
-     */
-    description: string;
-    /**
-     * The referrence to the HTTP parameter associated with this descriptor.
-     */
-    ref: string;
-}

package/lib/model/business/mock/http/http-mock-request-metadata.d.ts

@@ -1,33 +0,0 @@
-/**
- * @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 { Uuid } from "../../../../util";
-/**
- * Defines the the metadata associated to an HTTP mock request.
- */
-export interface HttpMockRequestMetadata {
-    /**
-     * The unique ID associated with the HTTP request.
-     */
-    id: Uuid;
-    /**
-     * Indicates the starting time of the HTTP request.
-     */
-    start: number;
-    /**
-     * Indicates the how much time the request is stalled befaore the data loading starts.
-     */
-    stalled: number;
-    /**
-     * Indicates the duration of the HTTP request.
-     */
-    duration: number;
-    /**
-     * The reference to the `URL` object for the HTTP request.
-     */
-    url: URL;
-}

package/lib/model/business/mock/http/http-response-mock.d.ts

@@ -1,44 +0,0 @@
-/**
- * @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 { Observable } from "rxjs";
-import { HttpMockError } from "./http-mock-error";
-/**
- * Defines the config of a HTTP response mock object.
- */
-export interface HttpResponseMock {
-    /**
-     * The response body. Can be either an object, or an `Observable` instance.
-     */
-    body?: any | Observable<any>;
-    /**
-     * All response headers.
-     */
-    headers?: HttpHeaders;
-    /**
-     * Response status code.
-     */
-    status: number;
-    /**
-     * Textual description of response status code, defaults to `OK`.
-     */
-    statusText: string;
-    /**
-     * URL of the resource retrieved, or `null` if not available.
-     */
-    url: string | null;
-    /**
-     * The optional error for this HTTP request.
-     */
-    error: HttpMockError | null;
-    /**
-     * Returns a delayed response, in miliseconds.
-     * Maximum value is `10000` miliseconds (10 seconds).
-     */
-    delay?: number;
-}

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

@@ -1,14 +0,0 @@
-export * from './http-response-mock';
-export * from './http-method-mock';
-export * from './http-mock-config';
-export * from './http-mock-endpoint';
-export * from './http-mock-endpoint-descriptor';
-export * from './http-mock-method-descriptor';
-export * from './http-mock-parameter-descriptor';
-export * from './http-mock-interceptor';
-export * from './http-mock-error';
-export * from './http-mock-request-metadata';
-export * from './xhr-proxy';
-export * from './fetch-client';
-export * from './config';
-export * from './logging';

package/lib/model/business/mock/http/logging/http-mock-logging-metadata.d.ts

@@ -1,15 +0,0 @@
-/**
- * @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 { HttpMockLoggingPrefetchMetadata } from "./http-mock-logging-prefetch-metadata";
-/**
- * The markup interface for all log metadata of the HTTP Mocking Framework.
- */
-export interface HttpMockLoggingMetadata extends HttpMockLoggingPrefetchMetadata {
-    response: HttpResponse<any>;
-}

package/lib/model/business/mock/http/logging/http-mock-logging-prefetch-metadata.d.ts

@@ -1,16 +0,0 @@
-/**
- * @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 { HttpMockRequestMetadata } from "../http-mock-request-metadata";
-/**
- * The markup interface for all prefetch log metadata of the HTTP Mocking Framework.
- */
-export interface HttpMockLoggingPrefetchMetadata {
-    request: HttpRequest<any>;
-    requestMetadata: HttpMockRequestMetadata;
-}