angular-toolbox 0.0.8 → 0.9.0

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

@@ -0,0 +1,59 @@
+/**
+ * @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 { AppBridgeCommand } from "../../model/business/lang/app-bridge-command";
+/**
+ * @private
+ * The `AppBridge` class is an internal invoker utility that executes commans declared
+ * by the `AppBridgeService` instance.
+ */
+export declare class AppBridge {
+    /**
+     * @private
+     * Stores all commands registered by the `AppBridgeService` instance.
+     */
+    private readonly _commandMap;
+    /**
+     * Executes the command with the specified `name` parameter.
+     *
+     * @param name The reference to the command to execute.
+     * @param args The list of parmeters so be sent to the command.
+     */
+    execute(name: string, ...args: any[]): void;
+    /**
+     * Registers a command.
+     *
+     * @param name The name of the command to register.
+     * @param command The command to register.
+     */
+    addCommand(name: string, command: AppBridgeCommand): void;
+    /**
+     * Unregisters a command.
+     *
+     * @param name The name of the command to unregister.
+     *
+     * @returns `true` whether the command existed and has been removed; `false` otherwise.
+     */
+    removeCommand(name: string): boolean;
+    /**
+     * Returns the command with the specified name.
+     *
+     * @param name The name of the command to retrieve.
+     *
+     * @returns Returns the command associated with the specified name.
+     *          If no command is associated with the specified name, `undefined` is returned.
+     */
+    getCommand(name: string): AppBridgeCommand | undefined;
+    /**
+     * Returns a boolean indicating whether a command with the specified name exists or not.
+     *
+     * @param name The name of the command to retrieve.
+     *
+     * @returns Returns `true` whether the command exists; `false` otherwise.
+     */
+    hasCommand(name: string): boolean;
+}

package/lib/core/error/app-bridge-error.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
+ */
+/**
+ * Represents exceptions thrown by the `AppBridge` class.
+ */
+export declare class AppBridgeError extends ReferenceError {
+    /**
+     * @private
+     */
+    constructor(message: string);
+}

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

@@ -0,0 +1,18 @@
+/**
+ * @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
+ */
+/**
+ * Represents errors thrown by `HttpMockService` instances.
+ */
+export declare class HttpMockServiceError extends Error {
+    /**
+     * Creates en new `HttpMockService` instances.
+     *
+     * @param message A human-readable description of the error.
+     */
+    constructor(message: string);
+}

package/lib/core/error/index.d.ts

@@ -0,0 +1,4 @@
+export * from './subscription-error';
+export * from './integrity-error';
+export * from './app-bridge-error';
+export * from './http-mock-service-error';

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

@@ -0,0 +1,18 @@
+/**
+ * @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
+ */
+/**
+ * Represents a data integrity violation error.
+ */
+export declare class IntegrityError extends Error {
+    /**
+     * Creates en new `IntegrityError` instances.
+     *
+     * @param message A human-readable description of the error.
+     */
+    constructor(message: string);
+}

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

@@ -0,0 +1,18 @@
+/**
+ * @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
+ */
+/**
+ * Represents errors thrown by `SubscriptionService` instances.
+ */
+export declare class SubscriptionError extends Error {
+    /**
+     * Creates en new `SubscriptionService` instances.
+     *
+     * @param message A human-readable description of the error.
+     */
+    constructor(message: string);
+}

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

@@ -0,0 +1 @@
+export * from './lang';

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

@@ -0,0 +1,26 @@
+/**
+ * @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 { Identifiable } from "../../../model";
+import { Uuid } from "../../../util";
+/**
+ * @private
+ * The base class that must be extended by objects to be indentified by the
+ * Angular Toolbox Subscription Service.
+ */
+export declare class IdentifiableComponent implements Identifiable {
+    /**
+     * @private
+     */
+    private readonly _uuid;
+    /**
+     * Returns the unique identifier for this object.
+     *
+     * @returns An instance of the `Uuid` class.
+     */
+    getID(): Uuid;
+}

package/lib/core/impl/lang/index.d.ts

@@ -0,0 +1 @@
+export * from './identifiable-component';

package/lib/core/impl/version/version.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 ound in
+ * fthe LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { Version } from "../../../model";
+/**
+ * @private
+ * Specifies the semantic versioning of an API.
+ */
+export declare class VersionImpl implements Version {
+    /**
+     * Specifies versions with incompatible API changes.
+     */
+    readonly major: number;
+    /**
+     * Specifies versions with functionalities that have  backward compatibility.
+     */
+    readonly minor: number;
+    /**
+     * Specifies versions that fixes bugs.
+     */
+    readonly patch: number;
+    /**
+     * Specifies the timestamp that corresponds to the build date for this `Version` instance.
+     */
+    readonly buildTimeStamp: number;
+    /**
+     * @private
+     */
+    constructor(major: number, minor: number, patch: number, buildTimeStamp: number);
+    /**
+     * Returns a string representation of this `Version` object in the form `M.m.p`, where
+     * `M` represents the major number, `m` represents the minor number and `p` represents
+     * the patch number of this `VersionImpl` instance.
+     *
+     * @returns A string representation of this `VersionImpl` instance.
+     */
+    toString(): string;
+}

package/lib/core/index.d.ts

@@ -0,0 +1,2 @@
+export * from './error';
+export * from './impl';

package/lib/directive/anchor-link.directive.d.ts

@@ -0,0 +1,29 @@
+import { AfterViewInit, ElementRef } from '@angular/core';
+import { Router } from '@angular/router';
+import { NavigationDirectiveBase } from './navigation-directive-base';
+import * as i0 from "@angular/core";
+/**
+ * Provides functionality to activate anchor navigation through the native Angular router.
+ */
+export declare class AnchorLinklDirective extends NavigationDirectiveBase implements AfterViewInit {
+    private _document;
+    private _router;
+    /**
+     * The `href` attribute of the decorated element.
+     */
+    href: string;
+    /**
+     * @private
+     */
+    private onClick;
+    /**
+     * @private
+     */
+    constructor(_document: any, elmRef: ElementRef, _router: Router);
+    /**
+     * @private
+     */
+    ngAfterViewInit(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AnchorLinklDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<AnchorLinklDirective, "[anchorLink]", never, { "href": { "alias": "href"; "required": false; }; }, {}, never, never, true, never>;
+}

package/lib/directive/button-role.directive.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @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 { AfterViewInit, ElementRef, EventEmitter } from '@angular/core';
+import { Router } from '@angular/router';
+import { NavigationDirectiveBase } from './navigation-directive-base';
+import * as i0 from "@angular/core";
+/**
+ * An easy-to-use directive that enables keyboard navigation and provides support for keyboard "Enter" key events.
+ */
+export declare class ButtonRoleDirective<T> extends NavigationDirectiveBase implements AfterViewInit {
+    private _router;
+    /**
+     * Dispatches events when the user presses the "Enter" key.
+     */
+    readonly enter: EventEmitter<T>;
+    /**
+     * Forces callback methods defined with the "enter" event listener to be invoked when user clicks on the
+     * decorated element.
+     */
+    delegateClick: any;
+    /**
+     * @private
+     */
+    private onKeyup;
+    /**
+     * @private
+     */
+    private onClick;
+    /**
+     * @private
+     */
+    private _routerLinkRef;
+    /**
+     * @private
+     */
+    constructor(elmRef: ElementRef, _router: Router);
+    /**
+     * @private
+     */
+    ngAfterViewInit(): void;
+    /**
+     * @private
+     */
+    private processEvent;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ButtonRoleDirective<any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<ButtonRoleDirective<any>, "[buttonRole]", never, { "delegateClick": { "alias": "delegateClick"; "required": false; }; }, { "enter": "enter"; }, never, never, true, never>;
+}

package/lib/directive/content-renderer.directive.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @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 { ElementRef, EventEmitter, OnDestroy, OnInit } from '@angular/core';
+import * as i0 from "@angular/core";
+/**
+ * Allows injection of any value into an HTML element container (`div`, `button`, etc...).
+ * A rendered event is emitted after the injected content has been rendered and is
+ * available for DOM manipulation.
+ */
+export declare class ContentRendererDirective implements OnInit, OnDestroy {
+    private _elmRef;
+    /**
+     * @private
+     */
+    private readonly _observer;
+    /**
+     * Dispatches events when the content of the HTML element has been rendered.
+     */
+    readonly rendered: EventEmitter<HTMLElement>;
+    /**
+     * @private
+     */
+    constructor(_elmRef: ElementRef);
+    /**
+     * @private
+     */
+    ngOnDestroy(): void;
+    /**
+     * @private
+     */
+    ngOnInit(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ContentRendererDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<ContentRendererDirective, "[contentRenderer]", never, {}, { "rendered": "rendered"; }, never, never, true, never>;
+}

package/lib/directive/index.d.ts

@@ -0,0 +1,4 @@
+export * from './button-role.directive';
+export * from './navigate-to-url.directive';
+export * from './anchor-link.directive';
+export * from './content-renderer.directive';

package/lib/directive/navigate-to-url.directive.d.ts

@@ -0,0 +1,23 @@
+import { ElementRef } from '@angular/core';
+import { NavigationDirectiveBase } from './navigation-directive-base';
+import * as i0 from "@angular/core";
+/**
+ * An easy-to-use directive that enables keyboard navigation and provides support for navigating to an external URL.
+ */
+export declare class NavigateToUrlDirective extends NavigationDirectiveBase {
+    private _document;
+    /**
+     * The `href` attribute of the decorated element.
+     */
+    href: string;
+    /**
+     * @private
+     */
+    private onClick;
+    /**
+     * @private
+     */
+    constructor(_document: any, elmRef: ElementRef);
+    static ɵfac: i0.ɵɵFactoryDeclaration<NavigateToUrlDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<NavigateToUrlDirective, "[navigateToUrl]", never, { "href": { "alias": "href"; "required": false; }; }, {}, never, never, true, never>;
+}

package/lib/directive/navigation-directive-base.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
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { ElementRef } from '@angular/core';
+/**
+ * @private
+ * The base class for all directives that are responsible for navigation whithin ab Angular app.
+ */
+export declare class NavigationDirectiveBase {
+    protected elmRef: ElementRef;
+    /**
+     * @private
+     */
+    constructor(elmRef: ElementRef, role: string);
+}

package/lib/framework/index.d.ts

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

package/lib/framework/mock/http/config/http-mock-parameters.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @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 type of parameter objects associated with a HTTP call.
+ */
+export type HttpMockParameters = {
+    [key: string]: any;
+};

package/lib/framework/mock/http/config/http-mock.decorator.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @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 definition function for the `@HttpMock` decorator.
+ *
+ * @param config The `HttpMockConfig` object used to initialize the HTTP Mocking Framework.
+ */
+export declare const HttpMock: Function;

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

@@ -0,0 +1,2 @@
+export * from './http-mock-parameters';
+export * from './http-mock.decorator';

package/lib/framework/mock/http/config/route-mock-config.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @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 "../../../../model";
+import { HttpMockParameters } from "./http-mock-parameters";
+/**
+ * @private
+ *
+ * The markup interface for DTOs that are used to send a mock config to the delegate
+ * `XhrProxy` instance.
+ * This interface is not exposed.
+ */
+export interface RouteMockConfig {
+    /**
+     * @private
+     *
+     * The `HttpMethodMock`object to be consumed by the the delegate `XhrProxy` instance.
+     */
+    methodConfig: HttpMethodMock;
+    /**
+     * @private
+     *
+     * The list of URI parameters associated with the current HTTP call.
+     */
+    parameters: HttpMockParameters | null;
+}

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

@@ -0,0 +1,38 @@
+/**
+ * @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";
+/**
+ * @private
+ * Utility interface used by the `DelegateXhr` class to store HTTP request information.
+ */
+export interface DataStorage {
+    /**
+     * @private
+     */
+    httpResponse: HttpResponseMock;
+    /**
+     * @private
+     * The amount of data currently loaded.
+     */
+    loaded: number;
+    /**
+     * @private
+     * The total size of data to load.
+     */
+    total: number;
+    /**
+     * @private
+     * The loaded data.
+     */
+    data: any;
+    /**
+     * @private
+     * The JSON string prepresentation of the loaded data.
+     */
+    stringifiedData: string;
+}

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

@@ -0,0 +1,70 @@
+/**
+ * @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/benlesh/event-target-polyfill
+ * - Copyright (c) 2020 Ben Lesh
+ *
+ * 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/benlesh/event-target-polyfill/blob/master/LICENSE
+ */
+/**
+ * @private
+ * A utility class the provides an implementation for the `EventTarget` interface.
+ * This class is used internally by the framework; please do not expose it.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/EventTarget
+ */
+export declare class EventTargetImpl implements EventTarget {
+    /**
+     * @private
+     */
+    private _listenerList;
+    /**
+     * @private
+     */
+    constructor();
+    /**
+     * @private
+     * Sets up a function that will be called whenever the specified event is delivered to the target.
+     *
+     * @param type a case-sensitive string representing the event type to listen for.
+     * @param listener the object that receives a notification (an object that implements the
+     *                 `Event` interface) when an event of the specified type occurs.
+     * @param options an object that specifies characteristics about the event listener.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener
+     */
+    addEventListener(type: string, listener: EventListenerOrEventListenerObject | null, options?: boolean | AddEventListenerOptions | undefined): void;
+    /**
+     * @private
+     * Removes an event listener previously registered with `EventTarget.addEventListener()` from the target.
+     *
+     * @param type a case-sensitive which specifies the type of event for which to remove an event listener.
+     * @param listener the event listener function of the event handler to remove from the event target.
+     * @param options An options object that specifies characteristics about the event listener.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener
+     */
+    removeEventListener(type: string, listener: EventListenerOrEventListenerObject | null, options?: boolean | EventListenerOptions | undefined): void;
+    /**
+     * @private
+     * Sends an `Event` to this to the `Event` object, (synchronously) invoking the affected event listeners
+     * in the appropriate order.
+     *
+     * @param event the `Event object to dispatch. Its Event.target property will be set to the current EventTarget.
+     * @returns true since there are no cancellable events on a base `EventTarget`.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/dispatchEvent
+     */
+    dispatchEvent(event: Event): boolean;
+    /**
+     * @private
+     */
+    private checkArgLength;
+}

package/lib/framework/mock/http/event/progress-event-mock.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @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
+ * A utility class used by delegate `XhrProxy` instances to dispatch `ProgressEvent`
+ * instances.
+ *
+ * This class is not exposed.
+ */
+export declare class ProgressEventMock extends ProgressEvent {
+    /**
+     * @private
+     */
+    private _total;
+    /**
+     * A 64-bit unsigned integer indicating the size, in bytes, of the data already
+     * transmitted or processed.
+     */
+    set total(value: number);
+    get total(): number;
+    /**
+     * @private
+     */
+    private _loaded;
+    /**
+     * A 64-bit unsigned integer indicating the total size, in bytes, of the data being
+     * transmitted or processed.
+     */
+    set loaded(value: number);
+    get loaded(): number;
+}

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

@@ -0,0 +1,3 @@
+export * from './config';
+export * from './util';
+export * from './xhr';