angular-toolbox 1.5.5 → 1.6.1

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

@@ -1,26 +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 { HttpMockRequestMetadata, HttpResponseMock } from "../../../../model";
-import { DataStorage } from "../core/data-storage";
-/**
- * @private
- * A static utility class for building `DataStorage` objects.
- */
-export declare class DataStorageBuilder {
-    /**
-     * @private
-     * Builds and returns a new `DataStorage` objects.
-     *
-     * @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, metadata: HttpMockRequestMetadata): DataStorage;
-}

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

@@ -1,38 +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 possible values for the `responseType` property of the
- * `FetchClientBuilder.buildFetchClient()` method.
- */
-export declare enum FetchClientResponseType {
-    /**
-     * Allows to return the response as a promise that resolves with an `ArrayBuffer`.
-     */
-    ARRAY_BUFFER = "arrayBuffer",
-    /**
-     * Allows to return the response as a promise that resolves with a `Blob`.
-     */
-    BLOB = "blob",
-    /**
-     * Allows to return the response as a promise that resolves with a `FormData` object.
-     */
-    FORM_DATA = "formData",
-    /**
-     * Allows to return the response as a promise which resolves with the result of parsing the body text as JSON.
-     */
-    JSON = "json",
-    /**
-     * Allows to return the response as a promise that resolves with a `String`.
-     * The response is always decoded using UTF-8.
-     */
-    TEXT = "text",
-    /**
-     * Allows to return the response as a promise that resolves with a `Response` object.
-     */
-    RESPONSE = "response"
-}

package/lib/framework/mock/http/util/fetch-client.builder.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 { FetchClient } from "../../../../model";
-import { FetchClientResponseType } from "./fetch-client-response-type.enum";
-/**
- * A static utility class for building `FetchClient` objects.
- */
-export declare class FetchClientBuilder {
-    /**
-     * Builds and returns a new `FetchClient` object.
-     *
-     * @param input The definition of the resource to fetch.
-     * @param init The object containing options to configure the request.
-     * @param responseType Specifies the type of response for the resource to fetch.
-     *
-     * @returns A new `FetchClient` object.
-     */
-    static buildFetchClient(input: RequestInfo | URL, init?: RequestInit | null, responseType?: FetchClientResponseType): FetchClient;
-    /**
-     * @private
-     */
-    private static buildResponseStrategy;
-}

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

@@ -1,106 +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";
-/**
- * A statefull builder for creating new `HttpHeaders` instances.
- */
-export declare class HttpHeadersMockBuilder {
-    /**
-     * @private
-     */
-    private _headers;
-    /**
-     * Sets the `"Cache-Control"` property of the new `HttpHeaders` instance with the specified value.
-     *
-     * @param value The value used to set the `"Cache-Control"` property of the new `HttpHeaders` instance.
-     * Default value is `"no-cache"`.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    cacheControl(value?: string): HttpHeadersMockBuilder;
-    /**
-     * Sets the `"CContent-Type"` property of the new `HttpHeaders` instance with the specified value.
-     *
-     * @param value The value used to set the `"Content-Type"` property of the new `HttpHeaders` instance.
-     * Default value is `"application/json; charset=utf-8"`.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    contentType(value?: string): HttpHeadersMockBuilder;
-    /**
-     * Sets the `"Priority"` property of the new `HttpHeaders` instance with the specified value.
-     *
-     * @param value The value used to set the `"Priority"` property of the new `HttpHeaders` instance.
-     * Default value is `"u=0, i"`.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    priority(value?: string): HttpHeadersMockBuilder;
-    /**
-     * Sets the `"User-Agent"` property of the new `HttpHeaders` instance with the specified value.
-     *
-     * @param value The value used to set the `"User-Agent"` property of the new `HttpHeaders` instance.
-     * Default value is the navigator user agent.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    userAgent(value?: string | null): HttpHeadersMockBuilder;
-    /**
-     * Sets the `"Accept-Language"` property of the new `HttpHeaders` instance with the specified value.
-     *
-     * @param value The value used to set the `"Accept-Language"` property of the new `HttpHeaders` instance.
-     * Default value is the navigator language.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    acceptLanguage(value?: string | null): HttpHeadersMockBuilder;
-    /**
-     * Sets the `"Accept"` property of the new `HttpHeaders` instance with the specified value.
-     *
-     * @param value The value used to set the `"Accept"` property of the new `HttpHeaders` instance.
-     * Default value is `'*\/*'`.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    accept(value?: string): HttpHeadersMockBuilder;
-    /**
-     * Sets the `"Accept-Encoding"` property of the new `HttpHeaders` instance with the specified value.
-     *
-     * @param value The value used to set the `"Accept-Encoding"` property of the new `HttpHeaders` instance.
-     * Default value is `"ngzip, deflate, br, zstd"`.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    acceptEncoding(value?: string): HttpHeadersMockBuilder;
-    /**
-     * Sets or modifies a value of the new `HttpHeaders` instance.
-     *
-     * @param name The header name.
-     * @param value The value or values to set or override for the given header.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    set(name: string, value: string | string[]): HttpHeadersMockBuilder;
-    /**
-     * Return a new `HttpHeaders` instance, built from the properties specified with the
-     * `HttpHeadersMockBuilder` methods.
-     *
-     * @returns A new `HttpHeaders` instance.
-     */
-    headers(): HttpHeaders;
-    /**
-     * @private
-     */
-    private setHeader;
-}
-/**
- * A utility function used to create new "chainable" `HttpHeadersMockBuilder` instances.
- *
- * @returns A new `HttpHeadersMockBuilder` instance;
- */
-export declare const httpHeadersMock: () => HttpHeadersMockBuilder;

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

@@ -1,41 +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";
-/**
- * @private
- * A set of static utilities for manipulating `HttpHeaders` objects.
- */
-export declare class HttpHeadersUtil {
-    /**
-     * @private
-     * Returns a string representation the the specified `HttpHeaders `object, compatible with the format
-     * expected by the `XMLHttpRequest.getAllResponseHeaders()` method.
-     *
-     * @param headers The `HttpHeaders` object to format.
-     *
-     * @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.
-     *
-     * @returns The default `HttpHeaders` object for a mocked HTTP request.
-     */
-    static createDefaultRequestHeaders(): HttpHeaders;
-}

package/lib/framework/mock/http/util/http-method-ref.enum.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
- */
-/**
- * @private
- * Provides the list of HTTP verbs.
- */
-export declare enum HTTPMethodRef {
-    /**
-     * @private
-     * A reference to the `connect` route associated with the `CONNECT` HTTP verb.
-     */
-    CONNECT = "connect",
-    /**
-     * @private
-     * A reference to the `delete` route associated with the `DELETE` HTTP verb.
-     */
-    DELETE = "delete",
-    /**
-     * @private
-     * A reference to the `get` route associated with the `GET` HTTP verb.
-     */
-    GET = "get",
-    /**
-     * @private
-     * A reference to the `head` route associated with the `HEAD` HTTP verb.
-     */
-    HEAD = "head",
-    /**
-     * @private
-     * A reference to the `options` route associated with the `OPTIONS` HTTP verb.
-     */
-    OPTIONS = "options",
-    /**
-     * @private
-     * A reference to the `patch` route associated with the `PATCH` HTTP verb.
-     */
-    PATCH = "patch",
-    /**
-     * @private
-     * A reference to the `post` route associated with the `POST` HTTP verb.
-     */
-    POST = "post",
-    /**
-     * @private
-     * A reference to the `put` route associated with the `PUT` HTTP verb.
-     */
-    PUT = "put",
-    /**
-     * @private
-     * A reference to the `trace` route associated with the `TRACE` HTTP verb.
-     */
-    TRACE = "trace"
-}

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

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

@@ -1,22 +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 { 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;
-}

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

@@ -1,91 +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 { HttpMockError, HttpResponseMock } from "../../../../model";
-/**
- * A statefull builder for creating new `HttpResponseMock` instances.
- */
-export declare class HttpResponseMockBuilder {
-    /**
-     * @private
-     */
-    private _response;
-    /**
-     * Sets the body property of the new `HttpResponseMock` instance with the specified `body` value.
-     *
-     * @param body The value used to set the body property of the new `HttpResponseMock` instance.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    body(body: any): HttpResponseMockBuilder;
-    /**
-     * Sets the headers property of the new `HttpResponseMock` instance with the specified `headers` value.
-     *
-     * @param headers The value used to set the `headers` property of the new `HttpResponseMock` instance.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    headers(headers: HttpHeaders): HttpResponseMockBuilder;
-    /**
-     * Add the list of HTTP headers generated by the `HttpHeadersUtil.createDefaultRequestHeaders()`
-     * to the mock response.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    defaultHeaders(): HttpResponseMockBuilder;
-    /**
-     * Sets the `status` property of the new `HttpResponseMock` instance with the specified `status` value.
-     *
-     * @param status The value used to set the `status` property of the new `HttpResponseMock` instance.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    status(status: number): HttpResponseMockBuilder;
-    /**
-     * Sets the `url` property of the new `HttpResponseMock` instance with the specified `url` value.
-     *
-     * @param url The value used to set the `url` property of the new `HttpResponseMock` instance.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    url(url: string | null): HttpResponseMockBuilder;
-    /**
-     * Sets the `delay` property of the new `HttpResponseMock` instance with the specified `timer` duration.
-     * Maximum value is `10000` miliseconds (10 seconds).
-     *
-     * @param timer The value used to set the `delay` property of the new `HttpResponseMock` instance.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    delay(timer?: number): HttpResponseMockBuilder;
-    /**
-     * Sets the `delay` property of the new `HttpResponseMock` instance with the specified `timer` duration.
-     * Maximum value is `10000` miliseconds (10 seconds).
-     *
-     * @param timer The value used to set the `delay` property of the new `HttpResponseMock` instance.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    delay(min?: number, max?: number): HttpResponseMockBuilder;
-    /**
-     * Returns a new `HttpResponseMock` instance, built from the properties specified with the
-     * `HttpResponseMockBuilder` methods.
-     *
-     * @param error An optional value used to set the `error` property of the new `HttpResponseMock` instance.
-     *              The `error` parameter values take precedence over all other properties of the `HttpResponseMock`
-     *              instance.
-     * @returns A new `HttpResponseMock` instance.
-     */
-    response(error?: HttpMockError | null): HttpResponseMock;
-}
-/**
- * A utility function used to create new "chainable" `HttpResponseMockBuilder` instances.
- *
- * @returns A new `HttpResponseMockBuilder` instance.
- */
-export declare const httpResponseMock: () => HttpResponseMockBuilder;

package/lib/framework/mock/http/util/http-status-text-finder.d.ts

@@ -1,23 +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";
-import { HttpStatusText } from "./http-status-text.enum";
-/**
- * @private
- * A utility class that helps to retreive a status text depending on its status code.
- */
-export declare class HttpStatusTextFinder {
-    /**
-     * @private
-     * Retreives and return a status text depending on its status code.
-     *
-     * @param code The status code for which to find the status text.
-     * @returns A `HttpStatusText` constant.
-     */
-    static getStatusText(code: HttpStatusCode): HttpStatusText;
-}