angular-toolbox 0.0.7 → 0.9.0

package/lib/framework/mock/http/path-to-regexp/to-key-regexp.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
+ *
+ * This source code is derived from the following original source code:
+ * - https://github.com/pillarjs/path-to-regexp
+ * - Copyright (c) 2014 Blake Embrey (hello@blakeembrey.com)
+ *
+ * Use of the original source code is governed by an MIT-style license
+ * that can be found in the LICENSE file at
+ * https://github.com/pillarjs/path-to-regexp/blob/master/LICENSE
+ */
+import { DecodeKeyToString } from "./model/decode-key-to-string";
+import { Encode } from "./model/encode";
+/**
+ * @private
+ * Returns a function that converts a token into a regexp string.
+ */
+export declare const toKeyRegexp: (stringify: Encode, delimiter: string) => DecodeKeyToString;

package/lib/framework/mock/http/path-to-regexp/to-stringify.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
+ *
+ * This source code is derived from the following original source code:
+ * - https://github.com/pillarjs/path-to-regexp
+ * - Copyright (c) 2014 Blake Embrey (hello@blakeembrey.com)
+ *
+ * Use of the original source code is governed by an MIT-style license
+ * that can be found in the LICENSE file at
+ * https://github.com/pillarjs/path-to-regexp/blob/master/LICENSE
+ */
+import { NonDelimiterEncoderProvider } from "./model/non-delimiter-encoder-provider";
+/**
+ * @private
+ * Encode all non-delimiter characters using the encode function.
+ */
+export declare const toStringify: NonDelimiterEncoderProvider;

package/lib/framework/mock/http/path-to-regexp/token-data-to-regexp.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
+ *
+ * This source code is derived from the following original source code:
+ * - https://github.com/pillarjs/path-to-regexp
+ * - Copyright (c) 2014 Blake Embrey (hello@blakeembrey.com)
+ *
+ * Use of the original source code is governed by an MIT-style license
+ * that can be found in the LICENSE file at
+ * https://github.com/pillarjs/path-to-regexp/blob/master/LICENSE
+ */
+import { TokenDataRegExpFactory } from "./model/token-data-regexp-factory";
+/**
+ * @Private
+ * Expose a function for taking tokens and returning a RegExp.
+ */
+export declare const tokenDataToRegexp: TokenDataRegExpFactory;

package/lib/framework/mock/http/path-to-regexp/token-data.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
+ *
+ * This source code is derived from the following original source code:
+ * - https://github.com/pillarjs/path-to-regexp
+ * - Copyright (c) 2014 Blake Embrey (hello@blakeembrey.com)
+ *
+ * Use of the original source code is governed by an MIT-style license
+ * that can be found in the LICENSE file at
+ * https://github.com/pillarjs/path-to-regexp/blob/master/LICENSE
+ */
+import { Token } from "./model/token";
+/**
+ * @private
+ * Tokenized path instance.
+ */
+export declare class TokenData {
+    readonly tokens: Token[];
+    readonly delimiter: string;
+    /**
+     * @private
+     * Creates a new `TokenData` instance.
+     *
+     * @param tokens A list of `Token` objects.
+     * @param delimiter the string delimiter for this `TokenData` instance.
+     */
+    constructor(tokens: Token[], delimiter: string);
+}

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

@@ -0,0 +1,25 @@
+/**
+ * @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 { 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.
+     *
+     * @returns A new `DataStorage` objects.
+     */
+    static buildDataStorage(httpResponse: HttpResponseMock, data: any): DataStorage;
+}

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

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

@@ -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";
+/**
+ * @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
+     * 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

@@ -0,0 +1,58 @@
+/**
+ * @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-response.builder.d.ts

@@ -0,0 +1,83 @@
+/**
+ * @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;
+    /**
+     * 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 `statusText` property of the new `HttpResponseMock` instance with the specified `statusText` value.
+     *
+     * @param statusText The value used to set the `statusText` property of the new `HttpResponseMock` instance.
+     *
+     * @returns A reference to this `HttpResponseMockBuilder` instance.
+     */
+    statusText(statusText: string): 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;
+    /**
+     * 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/index.d.ts

@@ -0,0 +1,2 @@
+export * from './http-mock-response.builder';
+export * from './http-headers-mock.builder';

package/lib/framework/mock/http/xhr/delegate-xhr.d.ts

@@ -0,0 +1,199 @@
+/**
+ * @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 { XhrProxy } from "../../../../model";
+import { XhrBase } from "./xhr-base";
+import { RouteMockConfig } from "../config/route-mock-config";
+/**
+ * @private
+ * A utility class used as delegate of `XMLHttpRequest` functionalities when
+ * a HTTP request is intercepted by the Mocking Framework .
+ */
+export declare class DelegateXhr extends XhrBase implements XhrProxy {
+    /**
+     * @private
+     * Indicates whether the progressive download is activated, or not.
+     */
+    private _progressiveDownload;
+    /**
+     * @private
+     * The config for the intercepted route.
+     */
+    private _routeConfig;
+    /**
+     * @private
+     *
+     * Internal storage for HTTP response `data`.
+     */
+    private _dataStorage;
+    /**
+     * @private
+     *
+     * Internal storage for the HTTP request `method`.
+     */
+    private _method;
+    /**
+     * @private
+     *
+     * Internal storage for the HTTP request URL.
+     */
+    private _url;
+    /**
+     * @private
+     *
+     * Internal storage for the HTTP request `readyState`.
+     */
+    private _readyState;
+    /**
+     * @private
+     *
+     * Internal storage for the HTTP request `headers`.
+     */
+    private _headers;
+    /**
+     * @private
+     *
+     * Internal storage for the HTTP request `status`.
+     */
+    private _status;
+    /**
+     * @private
+     *
+     * Internal storage for the HTTP request `statusText`.
+     */
+    private _statusText;
+    /**
+     * @private
+     */
+    private _loadSubscription;
+    /**
+     * Returns the response body content.
+     *
+     * @see https://developer.mozilla.org/docs/Web/API/XMLHttpRequest/response
+     */
+    get response(): any;
+    /**
+     * Returns the numerical HTTP status code of the `XMLHttpRequest` response.
+     *
+     * @see https://developer.mozilla.org/docs/Web/API/XMLHttpRequest/status
+     */
+    get status(): number;
+    /**
+     * Returns a string containing the response status message as returned by the HTTP server.
+     *
+     * @see https://developer.mozilla.org/docs/Web/API/XMLHttpRequest/statusText
+     */
+    get statusText(): string;
+    /**
+     * Returns the state the `XMLHttpRequest` client is in.
+     *
+     * @see https://developer.mozilla.org/docs/Web/API/XMLHttpRequest/readyState
+     */
+    get readyState(): number;
+    /**
+     * Returns the serialized URL of the response or the empty string if the URL is `null`.
+     *
+     * @see https://developer.mozilla.org/docs/Web/API/XMLHttpRequest/responseURL
+     */
+    get responseURL(): string;
+    /**
+     * Returns the text received from a server following a request being sent.
+     *
+     * Throws an `InvalidStateError` DOMException if responseType is not the empty string or "text".
+     *
+     * @see https://developer.mozilla.org/docs/Web/API/XMLHttpRequest/responseText
+     */
+    get responseText(): string;
+    /**
+     *  Returns an `XMLHttpRequestUpload` object that can be observed to monitor an upload progress.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/upload
+     */
+    get upload(): XMLHttpRequestUpload;
+    /**
+     *  Returns an an enumerated string value specifying the type of data contained in the response.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType
+     */
+    responseType: XMLHttpRequestResponseType;
+    /**
+     * Initializes a newly-created request, or re-initializes an existing one.
+     *
+     * @param method The HTTP request method to use, such as `"GET"`, `"POST"`, `"PUT"`, `"DELETE"`,
+     *               etc. Ignored for non-HTTP(S) URLs.
+     * @param url A string or any other object with a stringifier — including a URL object —
+     *            that provides the URL of the resource to send the request to.
+     */
+    open(method: string, url: string | URL): void;
+    /**
+     * @private
+     */
+    open(method: string, url: string | URL, async: boolean, username?: string | null | undefined, password?: string | null | undefined): void;
+    /**
+     * Aborts the request if it has already been sent. When a request is aborted, its `readyState`
+     * is changed to `XMLHttpRequest.UNSENT` and the request status code is set to `0`.
+     */
+    abort(): void;
+    /**
+     * Returns all the response headers, separated by CRLF, as a string, or returns `null`
+     * if no response has been received.
+     *
+     * @returns All the response headers, separated by CRLF, as a string, or returns `null`
+     *          if no response has been received.
+     */
+    getAllResponseHeaders(): string;
+    /**
+     * Sends the request to the server.
+     *
+     * @param body A body of data to be sent in the XHR request.
+     */
+    send(body?: Document | XMLHttpRequestBodyInit | null | undefined): void;
+    /**
+     * Sets the value of an HTTP request header.
+     *
+     * @param name The name of the header whose value is to be set.
+     * @param value The value to set as the body of the header.
+     */
+    setRequestHeader(name: string, value: string): void;
+    /**
+     * @private
+     */
+    constructor(routeConfig: RouteMockConfig);
+    /**
+     * @private
+     * Internally used by the framework to delete a `DelegateXhr` instance.
+     */
+    destroy(): void;
+    /**
+     * @private
+     */
+    private doProgressiveDownload;
+    /**
+     * @private
+     */
+    private onLoadComplete;
+    /**
+     * @private
+     */
+    private onError;
+    /**
+     * @private
+     */
+    private eventDispatch;
+    /**
+     * @private
+     */
+    private dispatchProgressEvent;
+    /**
+     * @private
+     */
+    private setReadyState;
+    /**
+     * @private
+     */
+    private loadData;
+}

package/lib/framework/mock/http/xhr/http-mock-factory.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 { XhrProxyFactoryImpl } from "./http-mock-factory.impl";
+/**
+ * A factory function that creates and returns a new `XhrFactory` object.
+ *
+ * @returns A new `XhrFactory` object.
+ */
+export declare const httpMockFactory: () => XhrProxyFactoryImpl;

package/lib/framework/mock/http/xhr/http-mock-factory.impl.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 { XhrFactory } from "@angular/common";
+import { HttpMockService } from "../../../../model/service/mock/http/http-mock.service";
+/**
+ * @private
+ * The concrete implementation of the `XhrFactory` interface.
+ */
+export declare class XhrProxyFactoryImpl extends XhrFactory {
+    private _httpMockService;
+    /**
+     * @private
+     */
+    constructor(_httpMockService: HttpMockService);
+    /**
+     * @private
+     */
+    build(): XMLHttpRequest;
+}

package/lib/framework/mock/http/xhr/index.d.ts

@@ -0,0 +1 @@
+export * from './http-mock-factory';