angular-toolbox 1.1.1 → 1.2.0

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

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

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

@@ -0,0 +1,4 @@
+export * from './window-ref';
+export * from './window-init';
+export * from './window-feature-state';
+export * from './window-target';

package/lib/model/business/ui/window/window-feature-state.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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 values used to activate, or deactivate, a feature for a browser window created by the `WindowService.open()` method.
+ */
+export declare enum WindowFeatureState {
+    /**
+     * The value used to activate a feature.
+     */
+    YES = "yes",
+    /**
+     * The value used to deactivate a feature.
+     */
+    NO = "no"
+}

package/lib/model/business/ui/window/window-init.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
+ */
+import { WindowFeatureState } from "./window-feature-state";
+import { WindowTarget } from "./window-target";
+/**
+ * Defines the APi used to initialize the windows created by the `WindowService.open()` method.
+ */
+export interface WindowInit {
+    /**
+     * The name of the browsing context the resource is being loaded into.
+     */
+    target?: WindowTarget;
+    /**
+     * The title of the new window.
+     */
+    title?: string;
+    /**
+     * The icon of the new window.
+     */
+    icon?: string;
+    /**
+     * Specifies the distance in pixels from the left side of the work area as defined by the user's operating system where the new window will be generated.
+     */
+    left?: number;
+    /**
+     * Specifies the distance in pixels from the top side of the work area as defined by the user's operating system where the new window will be generated.
+     */
+    top?: number;
+    /**
+     * Specifies the width of the content area, including scrollbars. The minimum required value is `100`.
+     */
+    width?: number;
+    /**
+     * Specifies the height of the content area, including scrollbars. The minimum required value is `100`.
+     */
+    height?: number;
+    /**
+     * Specifies whether the directories are activated (`WindowFeatureState.YES`), or not (`WindowFeatureState.NO`).
+     */
+    directories?: WindowFeatureState;
+    /**
+     * Specifies whether the title bar is activated (`WindowFeatureState.YES`), or not (`WindowFeatureState.NO`).
+     */
+    titlebar?: WindowFeatureState;
+    /**
+     * Specifies whether the scrollbars are activated (`WindowFeatureState.YES`), or not (`WindowFeatureState.NO`).
+     */
+    scrollbars?: WindowFeatureState;
+    /**
+     * Specifies whether the toolbar is activated (`WindowFeatureState.YES`), or not (`WindowFeatureState.NO`).
+     */
+    toolbar?: WindowFeatureState;
+    /**
+     * Specifies whether the location is activated (`WindowFeatureState.YES`), or not (`WindowFeatureState.NO`).
+     */
+    location?: WindowFeatureState;
+    /**
+     * Specifies whether the status is activated (`WindowFeatureState.YES`), or not (`WindowFeatureState.NO`).
+     */
+    status?: WindowFeatureState;
+    /**
+     * Specifies whether the menu bar is activated (`WindowFeatureState.YES`), or not (`WindowFeatureState.NO`).
+     */
+    menubar?: WindowFeatureState;
+}

package/lib/model/business/ui/window/window-ref.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 { ComponentRef } from "@angular/core";
+/**
+ * Defines the type of objects managed by the `AbstractWindowService` class.
+ */
+export interface WindowRef<T, U> {
+    /**
+     * The reference to a window stored within the `AbstractWindowService` class.
+     */
+    window: U;
+    /**
+     * The reference to the Angular component displayed within a window.
+     */
+    componentRef: ComponentRef<T>;
+}

package/lib/model/business/ui/window/window-target.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
+ */
+/**
+ * Specifies the name of the browsing context the resource is being loaded into.
+ */
+export declare enum WindowTarget {
+    /**
+     * The current browsing context.
+     */
+    SELF = "self",
+    /**
+     * Usually a new tab, but users can configure browsers to open a new window instead.
+     */
+    BLANK = "_blank",
+    /**
+     * The parent browsing context of the current one. If no parent, behaves as `WindowTarget.SELF`.
+     */
+    PARENT = "_parent",
+    /**
+     * The topmost browsing context.
+     */
+    TOP = "_top",
+    /**
+     * Allows embedded fenced frames to navigate the top-level frame.
+     */
+    UNFENCED_TOP = "_unfencedTop"
+}

package/lib/model/service/mock/http/logging/atx-http-mock-console.service.d.ts

@@ -5,53 +5,47 @@
  * 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 { ApplicationRef, OnDestroy } from "@angular/core";
-import { AtxHttpMockConsolePopup } from "../../../../business/mock/http/popup/atx-http-mock-console-popup";
+import { OnDestroy } from "@angular/core";
+import { AtxMonitoringConsoleComponent } from "../../../../../framework/mock/http-monitoring-console";
+import { WindowService } from "../../../ui";
+import { WindowInit, WindowRef } from "../../../../business";
 import * as i0 from "@angular/core";
+/**
+ * @private
+ */
+export declare const FEATURES: WindowInit;
 /**
  * Provides functionality to display the ATX monitoring console within a new window.
  */
 export declare class AtxHttpMockConsoleService implements OnDestroy {
-    private _appRef;
-    /**
-     * @private
-     */
-    private _window;
-    /**
-     * @private
-     */
-    private _componentRef;
+    private _windowSrv;
     /**
      * @private
      */
-    readonly ICON: string;
+    private _uuid;
     /**
      * @private
      */
-    constructor(_appRef: ApplicationRef);
+    constructor(_windowSrv: WindowService);
     /**
      * Opens the ATX monitoring console within a new window and returns reference objects
      * to control it.
-     *
-     * @returns An `AtxHttpMockConsolePopup` object.
      */
-    open(): AtxHttpMockConsolePopup | null;
+    open(): void;
     /**
      * Closes the ATX monitoring console currently opened within a popup window.
      */
     close(): void;
     /**
-     * @private
-     */
-    ngOnDestroy(): void;
-    /**
-     * @private
+     * Returns reference to the opened popup window.
+     *
+     * @returns A `WindowRef` object, or undefined if the ATX monitoring console is not opened.
      */
-    private beforUnloadHandler;
+    getWindowRef(): WindowRef<AtxMonitoringConsoleComponent, Window> | undefined;
     /**
      * @private
      */
-    private createHeadTags;
+    ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AtxHttpMockConsoleService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AtxHttpMockConsoleService>;
 }

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

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

package/lib/model/service/ui/window/abstract-window.service.d.ts

@@ -0,0 +1,60 @@
+/**
+ * @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 { Type } from "@angular/core";
+import { Uuid } from "../../../../util";
+import { Destroyable, WindowRef } from "../../../business";
+/**
+ * The abstract class that must be implemented by services that provide
+ * functionality to display Angular component within a new browser window.
+ */
+export declare abstract class AbstractWindowService implements Destroyable {
+    /**
+     * @private
+     */
+    protected windowRefMap: Map<Uuid, WindowRef<any, any>>;
+    /**
+     * Returns the window reference object associated with the specified `Uuid` object.
+     *
+     * @param uuid The `Uuid` object associated with the window reference to get.
+     *
+     * @returns A `WindowRef` object, or `undefined` if the reference cannot be found.
+     */
+    get(uuid: Uuid): WindowRef<any, any> | undefined;
+    /**
+     * Returns all the window reference objects created by the service.
+     *
+     * @returns A list of `WindowRef` objects created by this service.
+     */
+    getAll(): WindowRef<any, any>[];
+    /**
+     * @private
+     */
+    destroy(): void;
+    /**
+     * Opens a new browser window with the specified properties and attaches an instance of
+     * the specified component into the window container.
+     *
+     * @param component The component to attach in the new window.
+     * @param init The config used to initialize the window.
+     *
+     * @returns A `Uuid` object.
+     */
+    abstract open<T>(component: Type<T>, init?: any): Uuid;
+    /**
+     * Closes the window associated with the specified `Uuid` object.
+     *
+     * @param uuid The `Uuid` object associated with the window to close.
+     *
+     * @returns `true` whether the window exists and is closed; `false` otherwise.
+     */
+    abstract close(uuid: Uuid): boolean;
+    /**
+     * Closes all opened windows.
+     */
+    abstract closeAll(): void;
+}

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

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

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

@@ -0,0 +1,48 @@
+/**
+ * @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 { ApplicationRef, OnDestroy, Type } from "@angular/core";
+import { Uuid } from "../../../../util";
+import { WindowInit } from "../../../business";
+import { AbstractWindowService } from "./abstract-window.service";
+import * as i0 from "@angular/core";
+/**
+ * Provides functionality to display Angular component within a new browser window.
+ */
+export declare class WindowService extends AbstractWindowService implements OnDestroy {
+    private _appRef;
+    /**
+     * @private
+     */
+    constructor(_appRef: ApplicationRef);
+    /**
+     * @inheritdoc
+     */
+    open<T>(component: Type<T>, init?: WindowInit): Uuid;
+    /**
+     * @inheritdoc
+     */
+    close(uuid: Uuid): boolean;
+    /**
+     * @inheritdoc
+     */
+    closeAll(): void;
+    /**
+     * @private
+     */
+    ngOnDestroy(): void;
+    /**
+     * @private
+     */
+    private beforUnloadHandler;
+    /**
+     * @private
+     */
+    private getTarget;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WindowService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WindowService>;
+}

package/lib/util/window/window-features-builder.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 found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { WindowInit } from "../../model";
+/**
+ * A static builder that creates the features associated with a popup window created by
+ * the `WindowService.open()` method.
+ */
+export declare class BrowserWindowFeaturesBuilder {
+    /**
+     * Builds a string that represents the features parameter of the `Window.open()` method.
+     *
+     * @param init A `WindowInit` object that contains data to initialize the features string.
+     *
+     * @returns A string that represents the features parameter of the `Window.open()` method.
+     */
+    static build(init?: WindowInit): string;
+    /**
+     * @private
+     */
+    static getLeft(init?: WindowInit): string;
+    /**
+     * @private
+     */
+    static getTop(init?: WindowInit): string;
+    /**
+     * @private
+     */
+    static getWidth(init?: WindowInit): string;
+    /**
+     * @private
+     */
+    static getHeight(init?: WindowInit): string;
+    /**
+     * @private
+     */
+    static getPopupProp(property: string, init?: WindowInit): string;
+}

package/lib/util/window/window-header-tag-util.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 { WindowInit } from "../../model";
+/**
+ * A static utility class that creates header tags for windows created by the `WindowService.open()` method.
+ */
+export declare class WindowHeaderTagUtil {
+    /**
+     * Sets the title of the specified window if defined in the `WindowInit` config object.
+     *
+     * @param win The window for which to set the title.
+     * @param init The `WindowInit` config object used to initialize the window.
+     */
+    static setTitle(win: Window, init?: WindowInit): void;
+    /**
+     * Sets the icon of the specified window if defined in the `WindowInit` config object.
+     *
+     * @param win The window for which to set the icon.
+     * @param init The `WindowInit` config object used to initialize the window.
+     */
+    static setIcon(win: Window, init?: WindowInit): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-toolbox",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "license": "SEE LICENSE IN LICENSE",
   "peerDependencies": {
     "@angular/common": "^18.0.0",

package/esm2022/lib/model/business/mock/http/popup/atx-http-mock-console-popup.mjs

@@ -1,9 +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
- */
-export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXR4LWh0dHAtbW9jay1jb25zb2xlLXBvcHVwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vLi4vLi4vLi4vLi4vcHJvamVjdHMvYW5ndWxhci10b29sYm94L3NyYy9saWIvbW9kZWwvYnVzaW5lc3MvbW9jay9odHRwL3BvcHVwL2F0eC1odHRwLW1vY2stY29uc29sZS1wb3B1cC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7O0dBTUciLCJzb3VyY2VzQ29udGVudCI6WyIvKipcclxuICogQGxpY2Vuc2VcclxuICogQ29weXJpZ2h0IFBhc2NhbCBFQ0hFTUFOTi4gQWxsIFJpZ2h0cyBSZXNlcnZlZC5cclxuICpcclxuICogVXNlIG9mIHRoaXMgc291cmNlIGNvZGUgaXMgZ292ZXJuZWQgYnkgYW4gTUlULXN0eWxlIGxpY2Vuc2UgdGhhdCBjYW4gYmUgZm91bmQgaW5cclxuICogdGhlIExJQ0VOU0UgZmlsZSBhdCBodHRwczovL3Bhc2NhbGVjaGVtYW5uLmNvbS9hbmd1bGFyLXRvb2xib3gvcmVzb3VyY2VzL2xpY2Vuc2VcclxuICovXHJcblxyXG5pbXBvcnQgeyBDb21wb25lbnRSZWYgfSBmcm9tIFwiQGFuZ3VsYXIvY29yZVwiO1xyXG5pbXBvcnQgeyBBdHhNb25pdG9yaW5nQ29uc29sZUNvbXBvbmVudCB9IGZyb20gXCIuLi8uLi8uLi8uLi8uLi9mcmFtZXdvcmtcIjtcclxuXHJcbi8qKlxyXG4gKiBUaGUgYEF0eEh0dHBNb2NrQ29uc29sZVBvcHVwYCBpbnRlcmZhY2UgcHJvdmlkZXMgY29tcG9uZW50IHJlZmVyZW5jZXMgZm9yXHJcbiAqIHRoZSBBVFggbW9uaXRvcmluZyBjb25zb2xlIG9iamVjdHMgY3JlYXRlZCB3aXRoIHRoZSBgQXR4SHR0cE1vY2tDb25zb2xlU2VydmljZWAgY2xhc3MuXHJcbiAqL1xyXG5leHBvcnQgaW50ZXJmYWNlIEF0eEh0dHBNb2NrQ29uc29sZVBvcHVwIHtcclxuXHJcbiAgICAvKipcclxuICAgICAqIFRoZSByZWZlcmVuY2UgdG8gYSBwb3B1cCB3aW5kb3cgY3JlYXRlZCB3aXRoIHRoZSBgQXR4SHR0cE1vY2tDb25zb2xlU2VydmljZWAgY2xhc3MuXHJcbiAgICAgKi9cclxuICAgIHBvcHVwOiBXaW5kb3c7XHJcblxyXG4gICAgLyoqXHJcbiAgICAgKiBUaGUgcmVmZXJlbmNlIHRvIGEgYEF0eE1vbml0b3JpbmdDb25zb2xlQ29tcG9uZW50YCBpbnN0YW5jZSBjcmVhdGVkIHdpdGggdGhlIGBBdHhIdHRwTW9ja0NvbnNvbGVTZXJ2aWNlYCBjbGFzcy5cclxuICAgICAqL1xyXG4gICAgY29tcG9uZW50UmVmOiBDb21wb25lbnRSZWY8QXR4TW9uaXRvcmluZ0NvbnNvbGVDb21wb25lbnQ+O1xyXG59Il19

package/lib/model/business/mock/http/popup/atx-http-mock-console-popup.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 { ComponentRef } from "@angular/core";
-import { AtxMonitoringConsoleComponent } from "../../../../../framework";
-/**
- * The `AtxHttpMockConsolePopup` interface provides component references for
- * the ATX monitoring console objects created with the `AtxHttpMockConsoleService` class.
- */
-export interface AtxHttpMockConsolePopup {
-    /**
-     * The reference to a popup window created with the `AtxHttpMockConsoleService` class.
-     */
-    popup: Window;
-    /**
-     * The reference to a `AtxMonitoringConsoleComponent` instance created with the `AtxHttpMockConsoleService` class.
-     */
-    componentRef: ComponentRef<AtxMonitoringConsoleComponent>;
-}