angular-toolbox 0.0.8 → 0.9.0

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

@@ -0,0 +1,123 @@
+/**
+ * @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 { EventTargetImpl } from "../event/event-target.impl";
+/**
+ * @private
+ *
+ * Elemenets marked as "Useless" are never invoked by the Angular framework.
+ */
+export declare class XhrBase extends EventTargetImpl {
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    readonly UNSENT = 0;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    readonly OPENED = 1;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    readonly HEADERS_RECEIVED = 2;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    readonly LOADING = 3;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    readonly DONE = 4;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API - Useless
+     */
+    get responseXML(): Document | null;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    withCredentials: boolean;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    timeout: number;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API - Useless
+     */
+    onabort: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API - Useless
+     */
+    onerror: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API - Useless
+     */
+    onload: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API - Useless
+     */
+    onloadend: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API - Useless
+     */
+    onloadstart: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API - Useless
+     */
+    onprogress: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API - Useless
+     */
+    onreadystatechange: ((this: XMLHttpRequest, ev: Event) => any) | null;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API - Useless
+     */
+    ontimeout: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API - Useless
+     */
+    overrideMimeType(mime: string): void;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API - Useless
+     */
+    getResponseHeader(name: string): string | null;
+}

package/lib/framework/mock/http/xhr/xhr-proxy-impl.d.ts

@@ -0,0 +1,125 @@
+/**
+ * @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
+ */
+import { HttpMockService } from "../../../../model/service/mock/http/http-mock.service";
+import { XhrProxy } from "../../../../model";
+import { XhrBase } from "./xhr-base";
+/**
+ * @private
+ * A XHR proxy that is used by the Mocking Framework to apply HTTP call strategies.
+ */
+export declare class XhrProxyImpl extends XhrBase implements XhrProxy {
+    private _httpMockService;
+    /**
+     * @private
+     * Stores an internal XMLHttpRequestobject used as delegate,
+     * depending on the testing strategy defined by the config file.
+     */
+    private XHR;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    get response(): any;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    get status(): number;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    get statusText(): string;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    get readyState(): number;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    get responseURL(): string;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    get responseText(): string;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    get responseType(): XMLHttpRequestResponseType;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    set responseType(value: XMLHttpRequestResponseType);
+    get upload(): XMLHttpRequestUpload;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    open(method: string, url: string | URL): void;
+    open(method: string, url: string | URL, async: boolean, username?: string | null | undefined, password?: string | null | undefined): void;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    abort(): void;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    getAllResponseHeaders(): string;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    addEventListener(type: unknown, listener: unknown, options?: unknown): void;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    removeEventListener(type: unknown, listener: unknown, options?: unknown): void;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    send(body?: Document | XMLHttpRequestBodyInit | null | undefined): void;
+    /**
+     * @private
+     *
+     * XMLHTTPRequest API
+     */
+    setRequestHeader(name: string, value: string): void;
+    /**
+     * @private
+     *
+     * For Unit Testing only.
+     */
+    instanceOf(classRef: any): boolean;
+    /**
+     * @private
+     */
+    constructor(_httpMockService: HttpMockService);
+}

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

@@ -0,0 +1,4 @@
+export * from './version';
+export * from './ui';
+export * from './lang';
+export * from './mock/http';

package/lib/model/business/lang/app-bridge-command.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 ound in
+ * fthe LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * The `Destroyable` interface provides a global interface for creating object that might be destroyed by the system.
+ */
+export type AppBridgeCommand = (...rest: any[]) => void;

package/lib/model/business/lang/destroyable.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @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
+ */
+/**
+ * The `Destroyable` interface provides a global interface for creating object that might be destroyed by the system.
+ */
+export interface Destroyable {
+    /**
+     * Makes an object elligible for garbage collection.
+     */
+    destroy(): void | any;
+}

package/lib/model/business/lang/identifiable.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @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
+ */
+import { Uuid } from "../../../util";
+/**
+ * `Identifiable` objects are Angular components that can be identified by a unique UUID identifier.
+ */
+export interface Identifiable {
+    /**
+     * Returns the unique identifier for this object.
+     *
+     * @returns An instance of the `Uuid` class.
+     */
+    getID(): Uuid;
+}

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

@@ -0,0 +1,4 @@
+export * from './instantiable';
+export * from './destroyable';
+export * from './app-bridge-command';
+export * from './identifiable';

package/lib/model/business/lang/instantiable.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @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 markup interface that defines instantiable objects.
+ */
+export type Instantiable = {
+    constructor: {
+        name: string;
+    };
+};

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

@@ -0,0 +1,35 @@
+/**
+ * @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";
+/**
+ * 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.
+     * Indicates whether to emulate progressive download (`true`), or not (`false`).
+     */
+    progressive?: boolean;
+    /**
+     * An enumerated string value specifying the type of data contained in the response.
+     */
+    responseType?: XMLHttpRequestResponseType;
+    /**
+     * 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;
+}

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

@@ -0,0 +1,28 @@
+/**
+ * @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[];
+}

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

@@ -0,0 +1,41 @@
+/**
+ * @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";
+/**
+ * Provides the API to define mocking strategies for a specific endpoint.
+ */
+export interface HttpMockEndpoint {
+    /**
+     * 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

@@ -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 { 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

@@ -0,0 +1,27 @@
+/**
+ * @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[];
+}

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

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

@@ -0,0 +1,7 @@
+export * from './http-response-mock';
+export * from './http-method-mock';
+export * from './http-mock-config';
+export * from './http-mock-endpoint';
+export * from './http-mock-interceptor';
+export * from './http-mock-error';
+export * from './xhr-proxy';

package/lib/model/business/mock/http/xhr-proxy.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @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
+ * The markup interface for XMLHttpRequest proxy implementations.
+ *
+ * @see https://xhr.spec.whatwg.org/#the-open()-method
+ */
+export interface XhrProxy extends XMLHttpRequest {
+}

package/lib/model/business/ui/dark-mode-config.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @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 properties for the `DarkModeService` configuration.
+ */
+export interface DarkModeConfig {
+    /**
+     * Indicates whether the dark mode is activated by default (`true`), or not (`false`).
+     */
+    darkModeEnabled?: boolean;
+    /**
+     * Indicates whether the dark mode uses browser settings (`true`), or not (`false`).
+     * When `true`, this property overrides the `darkModeEnabled` property.
+     */
+    detectBrowserSettings?: boolean;
+    /**
+     * CSS property name used to set the dark mode look and feel.
+     */
+    cssProperty?: string;
+    /**
+     * Reference to the key value used to persist the dark mode state to local storage.
+     */
+    storageKey?: string;
+}

package/lib/model/business/ui/dark-mode-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 { DarkModeConfig } from "./dark-mode-config";
+/**
+ * The default provider for the `DarkModeService` configuration. You typically define
+ * the custom properties in the main NgModule declaration to initialize the app dark mode:
+ *
+ * @NgModule({
+ * ...
+ * providers: [
+ *   { provide: DARK_MODE_CONFIG, useValue: { enableDarkMode: true } }
+ * ],
+ * ...
+ * });
+ */
+export declare const DARK_MODE_CONFIG: DarkModeConfig;

package/lib/model/business/ui/dark-mode.constant.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @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
+ */
+/**
+ * Reference to the dark mode default storage key.
+ */
+export declare const STORAGE_KEY: string;
+/**
+ * Reference to the dark mode default css property.
+ */
+export declare const CSS_PROP: string;

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

@@ -0,0 +1,4 @@
+export * from './dark-mode-config';
+export * from './dark-mode.constant';
+export * from './dark-mode-config.provider';
+export * from './scroll-behavior.type';

package/lib/model/business/ui/scroll-behavior.type.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
+ */
+/**
+ * Workaround for the typescript `ScrollBehavior` declaration.
+ */
+export type ScrollBehavior = "auto" | "instant" | "smooth";

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

@@ -0,0 +1,3 @@
+export * from './version';
+export * from './version-config';
+export * from './version-config.provider';

package/lib/model/business/version/version-config.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @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 `VersionConfig` interface provides the basic API that defines a version config token.
+ */
+export interface VersionConfig {
+    /**
+     * Specifies the major number for this config.
+     */
+    major: number;
+    /**
+     * Specifies the minor number for this config.
+     */
+    minor: number;
+    /**
+     * Specifies the patch number for this config.
+     */
+    patch: number;
+    /**
+     * Specifies the timestamp that corresponds to the build date for this config.
+     */
+    buildTimestamp: number;
+}