angular-toolbox 0.0.7 → 0.9.0

package/lib/model/business/version/version-config.provider.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
+ */
+import { VersionConfig } from "./version-config";
+/**
+ * The default provider for the `VersionService` configuration. You typically define
+ * the custom properties in the main `NgModule` declaration to initialize the application
+ * config:
+ *
+ * @NgModule({
+ * ...
+ * providers: [
+ *   { provide: VERSION_CONFIG, useValue: { major: 1, minor: 2, patch: 12 } }
+ * ],
+ * ...
+ * });
+ */
+export declare const VERSION_CONFIG: VersionConfig;

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

@@ -0,0 +1,34 @@
+/**
+ * @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
+ */
+/**
+ * Specifies the semantic versioning of an Angular application.
+ */
+export interface Version {
+    /**
+     * Specifies versions with incompatible API changes.
+     */
+    major: number;
+    /**
+     * Specifies versions with functionalities that have  backward compatibility.
+     */
+    minor: number;
+    /**
+     * Specifies versions that fixes bugs.
+     */
+    patch: number;
+    /**
+     * Specifies the timestamp that corresponds to the build date for this `Version` object.
+     */
+    buildTimeStamp: number;
+    /**
+     * Returns a string representation of this `Version` object.
+     *
+     * @returns A string representation of this `Version` object.
+     */
+    toString(): string;
+}

package/lib/model/index.d.ts

@@ -0,0 +1,2 @@
+export * from './business';
+export * from './service';

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

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

package/lib/model/service/mock/http/http-mock.service.d.ts

@@ -0,0 +1,101 @@
+import { HttpMockConfig } from '../../../business';
+import { HTTPMethodRef } from '../../../../framework/mock/http/util/http-method-ref.enum';
+import { RouteMockConfig } from '../../../../framework/mock/http/config/route-mock-config';
+import { Uuid } from '../../../../util';
+import * as i0 from "@angular/core";
+/**
+ * @private
+ * Reference to the original type for this class.
+ */
+export declare const HTTP_MOCK_SERVICE: string;
+/**
+ * The `HttpMockService` class provides the API for managing HTTP mock configuration objects.
+ */
+export declare class HttpMockService {
+    /**
+     * @private
+     * Ensures that class type is still accessible after TypeScript compilation.
+     */
+    readonly type: string;
+    /**
+     * @private
+     * The list of IDs associated with each config object.
+     */
+    private _configIdList;
+    /**
+     * @private
+     * Stores the complete collection of mocking behaviors for each registered config.
+     */
+    private _configList;
+    /**
+     * @private
+     * The reference to the current app URL origin.
+     */
+    private readonly APP_ORIGIN;
+    /**
+     * Adds the specified `HttpMockConfig` object to this `HttpMockService` instance.
+     *
+     * @param config The `HttpMockConfig` object to add to this `HttpMockService` instance.
+     * @Returns The `Uuid` instance associated with the added `HttpMockConfig` object.
+     */
+    addConfig(config: HttpMockConfig): Uuid;
+    /**
+     * Returns the current app URL origin.
+     *
+     * @returns A string that represents the current app URL origin.
+     */
+    getAppOrigin(): string;
+    /**
+     * Removes the configuration registered with the specified `uuid` from this `HttpMockService` instance.
+     *
+     * @param uuid The UUID of the configuration to remove.
+     */
+    removeConfig(uuid: Uuid): void;
+    /**
+     * Removes all registred configurations from this `HttpMockService` instance.
+     */
+    clearConfigs(): void;
+    /**
+     * Returns a boolean value that indicates whether a config with the specified UUID has been registered
+     * (`true`), or not (`false`).
+     *
+     * @param uuid The UUID of the config to check.
+     * @returns `true` whether a config with the specified UUID has been registered; `false` otherwise.
+     */
+    hasRegisteredConfig(uuid: Uuid): boolean;
+    /**
+     * Returns the `RouteMockConfig` object associated with the specified `URL` instance and HTTP method.
+     *
+     * @param url The `URL` instance for which to find a route config.
+     * @param method The HTTP method for which to find a route config.
+     * @returns The `RouteMockConfig` object associated with the specified `URL` instance and HTTP method whether it exists;
+     *          `undefined` otherwise.
+     */
+    getRouteConfig(url: URL, method: HTTPMethodRef): RouteMockConfig | undefined;
+    /**
+     * @rivate
+     */
+    private buildParameters;
+    /**
+     * @rivate
+     */
+    private extractConfig;
+    /**
+     * @rivate
+     */
+    private extractEndpointConfig;
+    /**
+     * @rivate
+     */
+    private checkOrigin;
+    /**
+     * @rivate
+     */
+    private deleteConfigById;
+    /**
+     * @rivate
+     */
+    private cleanConfig;
+    static ɵfac: i0.ɵɵFactoryDeclaration<HttpMockService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<HttpMockService>;
+}

package/lib/model/service/subscription/subscription.service.d.ts

@@ -0,0 +1,66 @@
+import { Subscription } from 'rxjs';
+import { Identifiable } from '../../business';
+import * as i0 from "@angular/core";
+export declare class SubscriptionService {
+    /**
+     * @private
+     * Stores an internal reference to the last reference used with the `register()`
+     * method.
+     */
+    private _lastRef;
+    /**
+     * @private
+     * The internal `Subscription` instances storage.
+     */
+    private _subMap;
+    /**
+     * Stores a new `Subscription` instance associated with the specified reference.
+     *
+     * @param ref The reference for which to store a new `Subscription` instance.
+     *            Can be either a string or an `Identifiable` object.
+     * @param subscription The `Subscription` instance to register.
+     *
+     * @returns A reference to this `SubscriptionService` instance.
+     */
+    register(ref: string | Identifiable, subscription: Subscription): SubscriptionService;
+    /**
+     * Stores a new `Subscription` instance associated with the reference specified
+     * by the last `register()` method invokation.
+     *
+     * @param subscription The `Subscription` instance to register.
+     *
+     * @returns A reference to this `SubscriptionService` instance.
+     */
+    append(subscription: Subscription): SubscriptionService;
+    /**
+     * Unsubscribes and removes all `Subscription` instances associated with the specified reference.
+     *
+     * @param ref The reference for which to remove all `Subscription` instances.
+     *            Can be either a string or an `Identifiable` object.
+     *
+     * @returns `true` whether the specified reference exists; `false` otherwise.
+     */
+    clearAll(ref: string | Identifiable): boolean;
+    /**
+     * Returns all `Subscription` instances associated with the specified reference.
+     *
+     * @param ref The reference for which to remove get `Subscription` instances.
+     *            Can be either a string or an `Identifiable` object.
+     *
+     * @returns All `Subscription` instances associated with the specified reference, or
+     *          `null` whether the specified reference does not exists.
+     */
+    get(ref: string | Identifiable): Array<Subscription> | null;
+    /**
+     * @private
+     * Returns the string reference for the regsitration process.
+     *
+     * @param ref The reference to be used the regsitration process.
+     *            Can be either a string or an `Identifiable` object.
+     *
+     * @returns the string reference for the regsitration process.
+     */
+    private getRef;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SubscriptionService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SubscriptionService>;
+}

package/lib/model/service/ui/app-bridge.service.d.ts

@@ -0,0 +1,80 @@
+import { NgZone } from '@angular/core';
+import { NavigationExtras, Router } from '@angular/router';
+import { AppBridgeCommand } from '../../business/lang/app-bridge-command';
+import * as i0 from "@angular/core";
+/**
+ * @private
+ */
+export declare const APP_PRIDGE_REF: string;
+/**
+ * A utility service that allows dynamically injected HTML fragments, to interact with the Angular application.
+ */
+export declare class AppBrigeService {
+    private _router;
+    private _zone;
+    private _document;
+    /**
+     * @private
+     */
+    private readonly _defaultView;
+    /**
+     * @private
+     * Thereference to the command invoker.
+     */
+    private readonly _appBridge;
+    /**
+     * @private
+     */
+    constructor(_router: Router, _zone: NgZone, _document: any);
+    /**
+     * Provides the ability to invoke the `navigate()` method of the Angular app router.
+     *
+     * @param commands The commands array as specified by the Angular router `navigate()` method.
+     * @param extras The navigation options as specified by the Angular router `navigate()` method.
+     * @return `Promise` that resolves to `true` when navigation succeeds, or `false` when navigation fails.
+     *
+     * @see https://angular.dev/api/router/Router#navigate
+     */
+    navigate(commands: string[], extras?: NavigationExtras | undefined): Promise<boolean>;
+    /**
+     * Allows to scroll to the fragment specified by the `href` attribute when the user element interact with the associated element.
+     *
+     * @example
+     * <a href="#myAnchor" onclick="appBridge.goToAnchor(event)">My Section</a></code>
+     *
+     * @param event The event that triggers the anchor navigation.
+     * @return `Promise` that resolves to `true` when navigation succeeds, or `false` when navigation fails.
+     *
+     * @see https://angular.dev/api/router/Router#navigate
+     */
+    goToAnchor(event: Event): Promise<boolean>;
+    /**
+     * Declares a new JavaScript command to be used with dynamically loaded documents.
+     *
+     * @param name The name of the command to declare.
+     * @param command The reference to a JavaScript command to be used with dynamically loaded documents.
+     */
+    declareCommand(name: string, command: AppBridgeCommand): void;
+    /**
+     * Unregisters a JavaScript command previously referenced with the `declareCommand()` method.
+     *
+     * @param name The name of the command to remove.
+     *
+     * @returns `true` whether the command existed and has been removed; `false` otherwise.
+     */
+    deleteCommand(name: string): boolean;
+    /**
+     * Returns the JavaScript command previously referenced with the `declareCommand()` method.
+     *
+     * @param name The name of the command to retrieve.
+     * @returns The JavaScript command previously referenced with the specified `name` parameter.
+     *          If no command is found, returns `undefined`.
+     */
+    getCommand(name: string): AppBridgeCommand | undefined;
+    /**
+     * @private
+     */
+    private checkCommandName;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AppBrigeService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AppBrigeService>;
+}

package/lib/model/service/ui/dark-mode.service.d.ts

@@ -0,0 +1,99 @@
+/**
+ * @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 { EventEmitter } from '@angular/core';
+import { DarkModeConfig } from '../../business';
+import * as i0 from "@angular/core";
+export declare class DarkModeService {
+    private _document;
+    /**
+     * @private
+     */
+    private _darkModeEnabled;
+    /**
+     * @private
+     */
+    private _cssProperty;
+    /**
+     * @private
+     */
+    private _storageKey;
+    /**
+     * The callback function that is triggered when the dark mode changes.
+     *
+     * @typeParam `EventEmitter<boolean>` the value returned by the `darkModeEnabled()` property.
+     */
+    readonly change: EventEmitter<boolean>;
+    /**
+     * @private
+     * Creates a new `DarkModeService` instance.
+     *
+     * @param _document The reference to the `Document` singleton.
+     * @param config The reference to the `DarkModeConfig` provider.
+     */
+    constructor(_document: Document, config: DarkModeConfig);
+    /**
+     * Toogles the dark mode state.
+     */
+    toggleDarkMode(): void;
+    /**
+     * Sets the dark mode state to active.
+     */
+    enableDarkMode(): void;
+    /**
+     * Sets the dark mode state to inactive.
+     */
+    disableDarkMode(): void;
+    /**
+     * Returns a `boolean` value that indicates whether the dark mode state is active (`true`), or not (`false`).
+     *
+     * @returns `true` whether the dark mode state is active; `false` otherwise.
+     */
+    darkModeEnabled(): boolean;
+    /**
+     * Returns the value of the CSS property as defined by the config provider.
+     *
+     * @returns The value of the CSS property.
+     */
+    getCssProperty(): string;
+    /**
+     * Returns the value of the storage key as defined by the config provider.
+     *
+     * @returns The value of the storage key.
+     */
+    getStorageKey(): string;
+    /**
+     * Removes the dark mode information from local storage.
+     */
+    invalidateStorage(): void;
+    /**
+     * @private
+     */
+    private initDarkMode;
+    /**
+     * @private
+     */
+    private initStoredDarkMode;
+    /**
+     * @private
+     */
+    private setStoredDarkMode;
+    /**
+     * @private
+     */
+    private setDarkMode;
+    /**
+     * @private
+     */
+    private initBrowserMode;
+    /**
+     * @private
+     */
+    private matchDarkTheme;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DarkModeService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DarkModeService>;
+}

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

@@ -0,0 +1,3 @@
+export * from './dark-mode.service';
+export * from './scroll.service';
+export * from './app-bridge.service';

package/lib/model/service/ui/scroll.service.d.ts

@@ -0,0 +1,55 @@
+import { EventEmitter } from '@angular/core';
+import { ScrollBehavior } from '../../business';
+import * as i0 from "@angular/core";
+export declare class ScrollService {
+    private _document;
+    /**
+     * The callback function that is triggered when a scroll operation is performed.
+     *
+     * @typeParam `EventEmitter<Event>` The reference to the original scroll event.
+     */
+    readonly onScroll: EventEmitter<Event>;
+    /**
+     * @private
+     * Creates a new `ScrollService` instance.
+     *
+     * @param _document The reference to the `Document` singleton.
+     */
+    constructor(_document: Document);
+    /**
+     * Scrolls the ancestor containers of the element with the specified selector such that
+     * this element  is visible to the user.
+     *
+     * @param selector The selector of the target element.
+     * @param arg A `boolean` value:
+     * If `true`, the top of the element will be aligned to the top of the visible area of the
+     * scrollable ancestor.
+     * If `false`, the bottom of the element will be aligned to the bottom of the visible area
+     * of the scrollable ancestor.
+     * @param arg A dictionary containing the scroll parameters.
+     */
+    scrollIntoView(selector: string, arg?: boolean | ScrollIntoViewOptions | undefined): void;
+    /**
+     * Scrolls the app viewport to the top of the browser window.
+     *
+     * @param behavior Specifies whether the scrolling should animate smoothly (`smooth`),
+     *                 happen instantly in a single jump (`instant`), or let the browser
+     *                 choose (`auto`, `default`).
+     */
+    gotoTop(behavior?: ScrollBehavior): void;
+    /**
+     * Scrolls the app viewport according to the specified options, into the browser window.
+     *
+     * @param options A dictionary containing the scroll parameters.
+     */
+    scroll(options?: ScrollToOptions): void;
+    /**
+     * Scrolls the app viewport by the specified `x/y` coordinates, into the browser window.
+     *
+     * @param x The horizontal pixel value that you want to scroll by.
+     * @param y The vertical  pixel value that you want to scroll by.
+     */
+    scrollBy(x: number, y: number): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ScrollService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ScrollService>;
+}

package/lib/model/service/version/version.service.d.ts

@@ -0,0 +1,30 @@
+import { Version, VersionConfig } from '../../business';
+import * as i0 from "@angular/core";
+/**
+ * A lightweight service that provides Semantic Versioning implementation for your Angular projects.
+ */
+export declare class VersionService {
+    /**
+     * @private
+     */
+    private readonly _version;
+    /**
+     * Creates a new VersionService instance.
+     * @param config the reference to the VersionConfig provider.
+     */
+    constructor(config: VersionConfig);
+    /**
+     * Returns the version of the associated Angular project.
+     *
+     * @return the version of the associated Angular project.
+     */
+    getVersion(): Version;
+    /**
+     * Returns the build timestamp of the associated Angular project.
+     *
+     * @return the  build timestamp of the associated Angular project.
+     */
+    getBuildTimestamp(): number;
+    static ɵfac: i0.ɵɵFactoryDeclaration<VersionService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<VersionService>;
+}

package/lib/pipe/index.d.ts

@@ -1 +1 @@
-export * from './safe/safe-html.pipe';
+export * from './safe/safe-html.pipe';

package/lib/pipe/safe/safe-html.pipe.d.ts

@@ -1,10 +1,30 @@
-import { DomSanitizer, SafeHtml } from '@angular/platform-browser';
-import { PipeTransform } from "@angular/core";
-import * as i0 from "@angular/core";
-export declare class SafeHtmlPipe implements PipeTransform {
-    private _sanitizer;
-    constructor(_sanitizer: DomSanitizer);
-    transform(value: string): SafeHtml;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SafeHtmlPipe, never>;
-    static ɵpipe: i0.ɵɵPipeDeclaration<SafeHtmlPipe, "safeHtml", false>;
-}
+/**
+ * @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 { DomSanitizer, SafeHtml } from '@angular/platform-browser';
+import { PipeTransform } from "@angular/core";
+import * as i0 from "@angular/core";
+/**
+ * A basic implementation of HTML sanitization pipe.
+ */
+export declare class SafeHtmlPipe implements PipeTransform {
+    private _sanitizer;
+    /**
+     * @private
+     */
+    constructor(_sanitizer: DomSanitizer);
+    /**
+     * Transforms the HTML input string value into a `SafeHtml` instance and returns the result
+     * of the transformation.
+     *
+     * @param value The HTML input value to transform into a `SafeHtml` instance.
+     * @returns A `SafeHtml` instance based on the specified input value.
+     */
+    transform(value: string): SafeHtml;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SafeHtmlPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<SafeHtmlPipe, "safeHtml", true>;
+}

package/lib/util/aria-role.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
+ */
+/**
+ * A reference to the `"button"` value of the `role` property.
+ */
+export declare const BUTTON_ROLE: string;
+/**
+ * A reference to the `"link"` value of the `role` property.
+ */
+export declare const LINK_ROLE: string;

package/lib/util/default-scroll-behavior.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @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
+ */
+/**
+ * @private
+ * An internal convenient object that defined default `ScrollIntoViewOptions` objects.
+ */
+export declare const DEFAULT_SCROLL_BEHAVIOR: ScrollIntoViewOptions;

package/lib/util/empty-string.const.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
+ */
+/**
+ * A reference to an immutable empty string.
+ */
+export declare const EMPTY_STRING: string;

package/lib/util/index.d.ts

@@ -0,0 +1,4 @@
+export * from './empty-string.const';
+export * from './aria-role.constant';
+export * from './uuid';
+export * from './js-type';

package/lib/util/js-type.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
+ */
+/**
+ * A reference to the `"undefined"` type.
+ */
+export declare const UNDEFINED: string;
+/**
+ * A reference to the `"object"` type.
+ */
+export declare const OBJECT: string;
+/**
+ * A reference to the `"boolean"` type.
+ */
+export declare const BOOLEAN: string;
+/**
+ * A reference to the `"number"` type.
+ */
+export declare const NUMBER: string;
+/**
+ * A reference to the `"bigint"` type.
+ */
+export declare const BIGINT: string;
+/**
+ * A reference to the `"function"` type.
+ */
+export declare const FUNCTION: string;
+/**
+ * A reference to the `"string"` type.
+ */
+export declare const STRING: string;
+/**
+ * A reference to the `"symbol"` type.
+ */
+export declare const SYMBOL: string;