@readium/navigator 2.5.8 → 2.6.0

package/src/webpub/WebPubNavigator.ts

@@ -1,10 +1,11 @@
-import { Feature, Link, Locator, Publication, ReadingProgression, LocatorLocations } from "@readium/shared";
+import { Feature, Link, Locator, LocatorText, Publication, ReadingProgression, LocatorLocations } from "@readium/shared";
 import { VisualNavigator, VisualNavigatorViewport, ProgressionRange, KeyboardPeripheralEventData } from "../Navigator.ts";
 import { Configurable } from "../preferences/Configurable.ts";
 import { WebPubFramePoolManager } from "./WebPubFramePoolManager.ts";
-import { BasicTextSelection, CommsEventKey, ContextMenuEvent, FrameClickEvent, KeyboardPeripheralEvent, ModuleName, SuspiciousActivityEvent, WebPubModules } from "@readium/navigator-html-injectables";
+import { BasicTextSelection, CommsEventKey, ContextMenuEvent, DecorationActivatedEvent, FrameClickEvent, KeyboardPeripheralEvent, ModuleName, SuspiciousActivityEvent, WebPubModules } from "@readium/navigator-html-injectables";
 import * as path from "path-browserify";
 import { WebPubFrameManager } from "./WebPubFrameManager.ts";
+import { Decoration, DecorableNavigator, DecorationActivationEvent, DecorationObserver, DecoratorConfig, decorationsEqual, resolveDecorationForWire, BUILTIN_DECORATION_TYPES } from "../decorations/index.ts";
 import { ManagerEventKey } from "../epub/EpubNavigator.ts";
 import { getScriptMode } from "../helpers/scriptMode.ts";
 import { WebPubCSS } from "./css/WebPubCSS.ts";
@@ -26,6 +27,7 @@ export interface WebPubNavigatorConfiguration {
     injectables?: IInjectablesConfig;
     contentProtection?: IContentProtectionConfig;
     keyboardPeripherals?: IKeyboardPeripheralsConfig;
+    decoratorConfig?: DecoratorConfig;
 }
 
 export interface WebPubNavigatorListeners {
@@ -58,7 +60,7 @@ const defaultListeners = (listeners: WebPubNavigatorListeners): WebPubNavigatorL
     peripheral: listeners.peripheral || (() => {})
 })
 
-export class WebPubNavigator extends VisualNavigator implements Configurable<WebPubSettings, WebPubPreferences> {
+export class WebPubNavigator extends VisualNavigator implements Configurable<WebPubSettings, WebPubPreferences>, DecorableNavigator {
     private readonly pub: Publication;
     private readonly container: HTMLElement;
     private readonly listeners: WebPubNavigatorListeners;
@@ -80,6 +82,13 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
     private readonly _suspiciousActivityListener: ((event: Event) => void) | null = null;
     private readonly _keyboardPeripheralListener: ((event: Event) => void) | null = null;
 
+    private readonly _decoratorConfig: DecoratorConfig;
+
+    private _decorations: Map<string, Decoration[]> = new Map();
+    private _decorationObservers: Map<string, Set<DecorationObserver>> = new Map();
+    private _decorationActivationState: Map<string, boolean> = new Map();
+    private _decorationActivationConsumed = false;
+
     private webViewport: VisualNavigatorViewport = {
         readingOrder: [],
         progressions: new Map(),
@@ -112,6 +121,7 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
 
         // Initialize content protection with provided config or default values
         this._contentProtection = configuration.contentProtection || {};
+        this._decoratorConfig = configuration.decoratorConfig || {};
 
         // Merge keyboard peripherals
         this._keyboardPeripherals = this.mergeKeyboardPeripherals(
@@ -254,6 +264,7 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
             case "_pong":
                 this.listeners.frameLoaded(this.framePool.currentFrames[0]!.iframe.contentWindow!);
                 this.listeners.positionChanged(this.currentLocation);
+                this._reapplyDecorationsToCurrentFrame();
                 break;
             case "first_visible_locator":
                 const loc = Locator.deserialize(data as string);
@@ -267,11 +278,23 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
                 });
                 this.listeners.positionChanged(this.currentLocation);
                 break;
-            case "text_selected":
-                this.listeners.textSelected(data as BasicTextSelection);
+            case "text_selected": {
+                const selection = data as BasicTextSelection;
+                selection.locator = new Locator({ href: this.currentLocation.href, type: this.currentLocation.type, text: new LocatorText({ highlight: selection.text }) });
+                this.listeners.textSelected(selection);
                 break;
+            }
+            case "decoration_activated": {
+                const handled = this._handleDecorationActivated(data as DecorationActivatedEvent);
+                if (handled) this._decorationActivationConsumed = true;
+                break;
+            }
             case "click":
             case "tap":
+                if (this._decorationActivationConsumed) {
+                    this._decorationActivationConsumed = false;
+                    break;
+                }
                 const edata = data as FrameClickEvent;
                 if (edata.interactiveElement) {
                     const element = new DOMParser().parseFromString(
@@ -392,6 +415,7 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
                 this.eventListener(key, value);
             };
         }
+        this._reapplyDecorationsToCurrentFrame();
     }
 
     private async apply() {
@@ -414,8 +438,128 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
         this._navigatorProtector?.destroy();
         this._keyboardPeripheralsManager?.destroy();
         await this.framePool?.destroy();
+        this._decorations.clear();
+        this._decorationObservers.clear();
+        this._decorationActivationState.clear();
+    }
+
+    // DecorableNavigator
+
+    public supportsDecorationStyle(styleTypeId: string): boolean {
+        return BUILTIN_DECORATION_TYPES.has(styleTypeId) ||
+            !!this._decoratorConfig.decorationTemplates?.[styleTypeId];
+    }
+
+    public registerDecorationObserver(group: string, observer: DecorationObserver): void {
+        if (!this._decorationObservers.has(group))
+            this._decorationObservers.set(group, new Set());
+        this._decorationObservers.get(group)!.add(observer);
+
+        this._decorationActivationState.set(group, true);
+        this._sendDecorationActivatable(group, true);
+    }
+
+    public unregisterDecorationObserver(observer: DecorationObserver): void {
+        this._decorationObservers.forEach((set, group) => {
+            if (set.has(observer)) {
+                set.delete(observer);
+                if (set.size === 0) {
+                    this._decorationActivationState.delete(group);
+                    this._sendDecorationActivatable(group, false);
+                }
+            }
+        });
     }
 
+    private _sendDecorationActivatable(group: string, activatable: boolean): void {
+        const frame = this.framePool?.currentFrames[0];
+        if (frame?.msg) frame.msg.send("decoration_activatable", { group, activatable });
+    }
+
+    public applyDecorations(decorations: Decoration[], group: string): void {
+        const previous = this._decorations.get(group) ?? [];
+        const prevById = new Map(previous.map(d => [d.id, d]));
+        const nextById = new Map(decorations.map(d => [d.id, d]));
+
+        const toRemove: string[] = [];
+        const toAdd: Decoration[] = [];
+        const toUpdate: Decoration[] = [];
+
+        for (const [id, prev] of prevById) {
+            if (!nextById.has(id)) toRemove.push(id);
+            else if (!decorationsEqual(prev, nextById.get(id)!)) toUpdate.push(nextById.get(id)!);
+        }
+        for (const [id, next] of nextById) {
+            if (!prevById.has(id)) toAdd.push(next);
+        }
+
+        this._decorations.set(group, decorations);
+        this._sendDecorationOps(group, toRemove, toAdd, toUpdate, previous);
+
+        const activatable = this._decorationActivationState.get(group);
+        if (activatable !== undefined) this._sendDecorationActivatable(group, activatable);
+    }
+
+    private _sendDecorationOps(
+        group: string,
+        toRemove: string[],
+        toAdd: Decoration[],
+        toUpdate: Decoration[],
+        previous: Decoration[]
+    ): void {
+        const frame = this.framePool?.currentFrames[0];
+        if (!frame?.msg) return;
+        const href = this.currentLocation.href;
+        const prevById = new Map(previous.map(d => [d.id, d]));
+
+        for (const id of toRemove) {
+            const d = prevById.get(id);
+            if (!d || d.locator.href !== href) continue;
+            frame.msg.send("decorate", { group, action: "remove", decoration: { id } });
+        }
+        for (const d of toAdd) {
+            if (d.locator.href !== href) continue;
+            frame.msg.send("decorate", { group, action: "add", decoration: resolveDecorationForWire(d, this._decoratorConfig.decorationTemplates) });
+        }
+        for (const d of toUpdate) {
+            if (d.locator.href !== href) continue;
+            frame.msg.send("decorate", { group, action: "update", decoration: resolveDecorationForWire(d, this._decoratorConfig.decorationTemplates) });
+        }
+    }
+
+    private _reapplyDecorationsToCurrentFrame(): void {
+        const frame = this.framePool?.currentFrames[0];
+        if (!frame?.msg) return;
+        const href = this.currentLocation.href;
+
+        for (const [group, decorations] of this._decorations) {
+            const matching = decorations.filter(d => d.locator.href === href);
+            if (matching.length === 0) continue;
+            frame.msg.send("decorate", { group, action: "clear" });
+            for (const d of matching)
+                frame.msg.send("decorate", { group, action: "add", decoration: resolveDecorationForWire(d, this._decoratorConfig.decorationTemplates) });
+        }
+        for (const [group, activatable] of this._decorationActivationState) {
+            frame.msg.send("decoration_activatable", { group, activatable });
+        }
+    }
+
+    private _handleDecorationActivated(data: DecorationActivatedEvent): boolean {
+        const observers = this._decorationObservers.get(data.group);
+        if (!observers || observers.size === 0) return false;
+
+        const decoration = (this._decorations.get(data.group) ?? []).find(d => d.id === data.decorationId);
+        if (!decoration) return false;
+
+        const event: DecorationActivationEvent = { decoration, group: data.group, rect: data.rect, point: data.point };
+        let anyHandled = false;
+        for (const obs of observers)
+            if (obs.onDecorationActivated(event)) anyHandled = true;
+        return anyHandled;
+    }
+
+    // End of DecorableNavigator
+
     private async changeResource(relative: number): Promise<boolean> {
         if (relative === 0) return false;
 

package/src/webpub/preferences/WebPubDefaults.ts

@@ -14,7 +14,7 @@ import {
   ensureExperiment
 } from "../../preferences/guards.ts";
 
-import { sMLWithRequest } from "../../helpers/index.ts";
+import { sMLWithRequest } from "@readium/navigator-html-injectables";
 
 export interface IWebPubDefaults {
   fontFamily?: string | null,

package/src/webpub/preferences/WebPubSettings.ts

@@ -3,7 +3,7 @@ import { ExperimentKey, TextAlignment } from "../../preferences/Types.ts";
 import { WebPubDefaults } from "./WebPubDefaults.ts";
 import { WebPubPreferences } from "./WebPubPreferences.ts";
 
-import { sMLWithRequest } from "../../helpers/index.ts";
+import { sMLWithRequest } from "@readium/navigator-html-injectables";
 
 export interface IWebPubSettings {
   fontFamily?: string | null,

package/types/src/decorations/index.d.ts

@@ -0,0 +1,75 @@
+import type { Decoration as InjectableDecoration, BuiltinDecorationStyle, HTMLDecorationTemplate as WireHTMLDecorationTemplate } from "@readium/navigator-html-injectables";
+export type { BuiltinDecorationStyle };
+export { DecorationLayout, DecorationStyleType, DecorationWidth } from "@readium/navigator-html-injectables";
+/**
+ * Navigator-level decoration template. `element` is a function called once per decoration to
+ * generate the HTML string that the injectable will render. The result is resolved on the
+ * navigator side (before postMessage) and sanitized by the injectable.
+ */
+export interface HTMLDecorationTemplate extends Omit<WireHTMLDecorationTemplate, 'element'> {
+    element: (decoration: Decoration) => string;
+}
+export type DecorationStyle = BuiltinDecorationStyle | HTMLDecorationTemplate;
+export interface Decoration extends Omit<InjectableDecoration, 'style'> {
+    style: DecorationStyle;
+}
+/**
+ * Resolves a navigator-level Decoration to a wire-safe plain object for postMessage.
+ * For Template styles, calls `element(decoration)` and embeds the resulting HTML string.
+ * For registered custom style IDs (found in `decorationTemplates`), resolves the template
+ * and converts the style to a Template wire object.
+ */
+export declare function resolveDecorationForWire(decoration: Decoration, decorationTemplates?: Record<string, HTMLDecorationTemplate>): unknown;
+export interface DecorationActivationEvent {
+    decoration: Decoration;
+    group: string;
+    /** Bounding rect of the activated decoration in navigator container coordinates (CSS pixels). */
+    rect?: {
+        top: number;
+        left: number;
+        width: number;
+        height: number;
+    };
+    /** Tap/click point in navigator container coordinates (CSS pixels). */
+    point?: {
+        x: number;
+        y: number;
+    };
+}
+export interface DecorationObserver {
+    /**
+     * Called when a user activates a decoration (click or tap).
+     * Return true to indicate the event was handled — this suppresses normal tap/click navigation.
+     */
+    onDecorationActivated(event: DecorationActivationEvent): boolean;
+}
+export declare function decorationsEqual(a: Decoration, b: Decoration): boolean;
+/** Configuration for decoration rendering. */
+export interface DecoratorConfig {
+    /**
+     * Named custom styles. Each key is a style type ID; the value is the template that
+     * generates the HTML for decorations of that type. When a decoration's `style.type`
+     * matches a key here, the navigator resolves the template and sends it to the
+     * injectable as a Template-type decoration.
+     */
+    decorationTemplates?: Record<string, HTMLDecorationTemplate>;
+}
+declare const BUILTIN_DECORATION_TYPES: Set<string>;
+export interface DecorableNavigator {
+    /**
+     * Replaces all decorations for the given group with the provided list.
+     * The navigator diffs the new list against the current state and issues
+     * add / update / remove / clear commands as needed.
+     */
+    applyDecorations(decorations: Decoration[], group: string): void;
+    /**
+     * Returns whether the given style type ID can be rendered by this navigator.
+     * Returns true for all built-in types and any IDs registered in DecoratorConfig.
+     */
+    supportsDecorationStyle(styleTypeId: string): boolean;
+    /** Registers an observer for activation events on the given group. */
+    registerDecorationObserver(group: string, observer: DecorationObserver): void;
+    /** Unregisters a previously registered observer from all groups. */
+    unregisterDecorationObserver(observer: DecorationObserver): void;
+}
+export { BUILTIN_DECORATION_TYPES };

package/types/src/epub/EpubNavigator.d.ts

@@ -3,6 +3,7 @@ import { Configurable, ConfigurableSettings, VisualNavigator, VisualNavigatorVie
 import { FramePoolManager } from "./frame/FramePoolManager.ts";
 import { FXLFramePoolManager } from "./fxl/FXLFramePoolManager.ts";
 import { CommsEventKey, ContextMenuEvent, BasicTextSelection, FrameClickEvent, SuspiciousActivityEvent } from "@readium/navigator-html-injectables";
+import { Decoration, DecorationObserver, DecorableNavigator, DecoratorConfig } from "../decorations/index.ts";
 import { FXLFrameManager } from "./fxl/FXLFrameManager.ts";
 import { FrameManager } from "./frame/FrameManager.ts";
 import { IEpubPreferences, EpubPreferences } from "./preferences/EpubPreferences.ts";
@@ -18,6 +19,7 @@ export interface EpubNavigatorConfiguration {
     injectables?: IInjectablesConfig;
     contentProtection?: IContentProtectionConfig;
     keyboardPeripherals?: IKeyboardPeripheralsConfig;
+    decoratorConfig?: DecoratorConfig;
 }
 export interface EpubNavigatorListeners {
     frameLoaded: (wnd: Window) => void;
@@ -34,7 +36,7 @@ export interface EpubNavigatorListeners {
     contextMenu: (data: ContextMenuEvent) => void;
     peripheral: (data: KeyboardPeripheralEventData) => void;
 }
-export declare class EpubNavigator extends VisualNavigator implements Configurable<ConfigurableSettings, EpubPreferences> {
+export declare class EpubNavigator extends VisualNavigator implements Configurable<ConfigurableSettings, EpubPreferences>, DecorableNavigator {
     private readonly pub;
     private readonly container;
     private readonly listeners;
@@ -60,6 +62,11 @@ export declare class EpubNavigator extends VisualNavigator implements Configurab
     private readonly _suspiciousActivityListener;
     private readonly _keyboardPeripheralListener;
     private resizeObserver;
+    private readonly _decoratorConfig;
+    private _decorations;
+    private _decorationObservers;
+    private _decorationActivationState;
+    private _decorationActivationConsumed;
     private reflowViewport;
     constructor(container: HTMLElement, pub: Publication, listeners: EpubNavigatorListeners, positions?: Locator[], initialPosition?: Locator | undefined, configuration?: EpubNavigatorConfiguration);
     static determineLayout(pub: Publication, scroll?: boolean): Layout;
@@ -90,10 +97,19 @@ export declare class EpubNavigator extends VisualNavigator implements Configurab
      * to trigger the navigator when user's mouse/keyboard focus is
      * outside the readium-controller navigator. Be careful!
      */
-    eventListener(key: CommsEventKey | ManagerEventKey, data: unknown): void;
+    eventListener(key: CommsEventKey | ManagerEventKey, data: unknown, sourceFrame?: FrameManager | FXLFrameManager): void;
     private determineModules;
     private attachListener;
     private apply;
+    supportsDecorationStyle(styleTypeId: string): boolean;
+    registerDecorationObserver(group: string, observer: DecorationObserver): void;
+    unregisterDecorationObserver(observer: DecorationObserver): void;
+    private _sendDecorationActivationToFrames;
+    applyDecorations(decorations: Decoration[], group: string): void;
+    private _sendDecorationOps;
+    private _reapplyDecorationsToFrame;
+    private _reapplyDecorationsToCurrentFrames;
+    private _handleDecorationActivated;
     destroy(): Promise<void>;
     private changeResource;
     private findLastPositionInProgressionRange;

package/types/src/helpers/index.d.ts

@@ -1,3 +1,2 @@
 export * from "./lineLength.ts";
-export * from './sML.ts';
 export * from './scriptMode.ts';

package/types/src/index.d.ts

@@ -1,4 +1,5 @@
 export * from './Navigator.ts';
+export * from './decorations/index.ts';
 export * from './webpub/index.ts';
 export * from './epub/index.ts';
 export * from './audio/index.ts';

package/types/src/webpub/WebPubNavigator.d.ts

@@ -3,6 +3,7 @@ import { VisualNavigator, VisualNavigatorViewport, KeyboardPeripheralEventData }
 import { Configurable } from "../preferences/Configurable.ts";
 import { BasicTextSelection, CommsEventKey, ContextMenuEvent, FrameClickEvent, SuspiciousActivityEvent } from "@readium/navigator-html-injectables";
 import { WebPubFrameManager } from "./WebPubFrameManager.ts";
+import { Decoration, DecorableNavigator, DecorationObserver, DecoratorConfig } from "../decorations/index.ts";
 import { ManagerEventKey } from "../epub/EpubNavigator.ts";
 import { IWebPubPreferences, WebPubPreferences } from "./preferences/WebPubPreferences.ts";
 import { IWebPubDefaults } from "./preferences/WebPubDefaults.ts";
@@ -16,6 +17,7 @@ export interface WebPubNavigatorConfiguration {
     injectables?: IInjectablesConfig;
     contentProtection?: IContentProtectionConfig;
     keyboardPeripherals?: IKeyboardPeripheralsConfig;
+    decoratorConfig?: DecoratorConfig;
 }
 export interface WebPubNavigatorListeners {
     frameLoaded: (wnd: Window) => void;
@@ -31,7 +33,7 @@ export interface WebPubNavigatorListeners {
     contextMenu: (data: ContextMenuEvent) => void;
     peripheral: (data: KeyboardPeripheralEventData) => void;
 }
-export declare class WebPubNavigator extends VisualNavigator implements Configurable<WebPubSettings, WebPubPreferences> {
+export declare class WebPubNavigator extends VisualNavigator implements Configurable<WebPubSettings, WebPubPreferences>, DecorableNavigator {
     private readonly pub;
     private readonly container;
     private readonly listeners;
@@ -51,6 +53,11 @@ export declare class WebPubNavigator extends VisualNavigator implements Configur
     private readonly _keyboardPeripheralsManager;
     private readonly _suspiciousActivityListener;
     private readonly _keyboardPeripheralListener;
+    private readonly _decoratorConfig;
+    private _decorations;
+    private _decorationObservers;
+    private _decorationActivationState;
+    private _decorationActivationConsumed;
     private webViewport;
     constructor(container: HTMLElement, pub: Publication, listeners: WebPubNavigatorListeners, initialPosition?: Locator | undefined, configuration?: WebPubNavigatorConfiguration);
     load(): Promise<void>;
@@ -72,6 +79,14 @@ export declare class WebPubNavigator extends VisualNavigator implements Configur
     private attachListener;
     private apply;
     destroy(): Promise<void>;
+    supportsDecorationStyle(styleTypeId: string): boolean;
+    registerDecorationObserver(group: string, observer: DecorationObserver): void;
+    unregisterDecorationObserver(observer: DecorationObserver): void;
+    private _sendDecorationActivatable;
+    applyDecorations(decorations: Decoration[], group: string): void;
+    private _sendDecorationOps;
+    private _reapplyDecorationsToCurrentFrame;
+    private _handleDecorationActivated;
     private changeResource;
     private updateViewport;
     private syncLocation;

package/src/helpers/sML.ts

@@ -1,143 +0,0 @@
-/*!
- *                                                                                                                         (℠)
- *  # sML.js | I'm a Simple and Middling Library.
- *
- *  * Copyright (c) Satoru MATSUSHIMA - https://github.com/satorumurmur/sML
- *  * Licensed under the MIT license. - http://www.opensource.org/licenses/mit-license.php
- *
- * Portions of this code come from the sML library
- * Current version: 1.0.36
- */
-/// <reference types="user-agent-data-types" />
-
-declare interface OSFlags {
-    iOS: number[];
-    macOS: number[];
-    iPadOS: number[];
-    WindowsPhone: number[];
-    ChromeOS: number[];
-    Windows: number[];
-    Android: number[];
-    Linux: number[];
-    Firefox: boolean;
-}
-
-declare interface UAFlags {
-    Gecko: number[];
-    Firefox: number[];
-    Waterfox: number[];
-    Opera: number[];
-    Silk: number[];
-    Blink: number[];
-    EdgeHTML: number[];
-    Chrome: number[];
-    Chromium: number[];
-    Phoebe: number[];
-    UCBrowser: number[];
-    Vivaldi: number[];
-    Safari: number[];
-    Edge: number[];
-    WebKit: number[];
-    Trident: number[];
-    InternetExplorer: number[];
-    Flash: number[];
-    Facebook: number[];
-    LINE: number[];
-}
-
-declare type iOSRequest = "mobile" | "desktop" | undefined;
-
-// Fallback when global 'navigator' is not available, such as in SSR environments.
-const userAgent = () => typeof navigator === "undefined" ? "" : (navigator.userAgent || "");
-const userAgentData = () => typeof navigator === "undefined" ? undefined : (navigator.userAgentData || undefined);
-
-class sMLFactory {
-    OS: OSFlags;
-    UA: UAFlags;
-    Env!: string[];
-
-    constructor() {
-        const NUAD = userAgentData(), NUA = userAgent();
-
-        const _sV = (V?: string | number) => (typeof V === "string" || typeof V === "number") && V ? String(V).replace(/_/g, ".").split(".").map(I => parseInt(I) || 0) : [];
-        const _dV = (Pre="") => {
-            if(!Pre) return [];
-            const RE = new RegExp("^.*" + Pre + "[ :\\/]?(\\d+([\\._]\\d+)*).*$");
-            if(!RE.test(NUA)) return [];
-            return _sV(NUA.replace(RE, "$1"));
-        };
-
-        this.OS = ((OS: OSFlags) => {
-            if(                /(macOS|Mac OS X)/.test(NUA)) {
-                    if(/\(iP(hone|od touch);/.test(NUA)) OS.iOS = _dV("CPU (?:iPhone )?OS ");
-                    if(             /\(iPad;/.test(NUA)) OS.iOS = OS.iPadOS = _dV("CPU (?:iPhone )?OS ");
-                else if( /(macOS|Mac OS X) \d/.test(NUA)) document.ontouchend !== undefined ? OS.iOS = OS.iPadOS = _dV() : OS.macOS = _dV("(?:macOS|Mac OS X) ");
-            } else if(      /Windows( NT)? \d/.test(NUA)) OS.Windows = (V => V[0] !== 6 || !V[1] ? V : V[1] === 1 ? [7] : V[1] === 2 ? [8] : [8, 1])(_dV("Windows(?: NT)?"));
-            else if(            /Android \d/.test(NUA)) OS.Android = _dV("Android");
-            else if(                  /CrOS/.test(NUA)) OS.ChromeOS = _dV();
-            else if(                  /X11;/.test(NUA)) OS.Linux = _dV();
-            return OS;
-        })({} as OSFlags); if(NUAD) NUAD.getHighEntropyValues(["architecture", "model", "platform", "platformVersion", "uaFullVersion"]).then((HEUAD: any) => (OS => { const Pf = HEUAD.platform, PfV = HEUAD.platformVersion; if(!Pf || !PfV) return;
-                if(         /^i(OS|P(hone|od touch))$/.test(Pf)) OS.iOS = _sV(PfV);
-            else if(                      /^iPad(OS)?$/.test(Pf)) OS.iOS = OS.iPadOS = _sV(PfV);
-            else if(/^(macOS|(Mac )?OS X|Mac(Intel)?)$/.test(Pf)) document.ontouchend !== undefined ? OS.iOS = OS.iPadOS = _sV() : OS.macOS = _sV(PfV);
-            else if(           /^(Microsoft )?Windows$/.test(Pf)) OS.Windows = _sV(PfV);
-            else if(              /^(Google )?Android$/.test(Pf)) OS.Android = _sV(PfV);
-            else if(     /^((Google )?Chrome OS|CrOS)$/.test(Pf)) OS.ChromeOS = _sV(PfV);
-            else if(             /^(Linux|Ubuntu|X11)$/.test(Pf)) OS.Linux = _sV(PfV);
-            else return; /**/ Object.keys(this.OS).forEach(Key => delete (this.OS as any)[Key]), Object.assign(this.OS, OS);
-        })({} as OSFlags));
-
-        this.UA = ((UA: UAFlags) => { let _OK = false;
-            if(NUAD && Array.isArray(NUAD.brands)) { const BnV = NUAD.brands.reduce((BnV: Record<string, number[]>, _: NavigatorUABrandVersion) => { BnV[_.brand] = [(_.version as any) * 1]; return BnV; }, {});
-                    if(BnV["Google Chrome"])  _OK = true, UA.Blink = UA.Chromium = BnV["Chromium"] || [], UA.Chrome = BnV["Google Chrome"];
-                else if(BnV["Microsoft Edge"]) _OK = true, UA.Blink = UA.Chromium = BnV["Chromium"] || [], UA.Edge = BnV["Microsoft Edge"];
-                else if(BnV["Opera"])          _OK = true, UA.Blink = UA.Chromium = BnV["Chromium"] || [], UA.Opera = BnV["Opera"];
-            } if(!_OK) {
-                if(              / Gecko\/\d/.test(NUA)) { UA.Gecko = _dV("rv");
-                        if(  / Waterfox\/\d/.test(NUA))   UA.Waterfox = _dV("Waterfox");
-                    else if(   / Firefox\/\d/.test(NUA))   UA.Firefox = _dV("Firefox");
-                } else if(        / Edge\/\d/.test(NUA)) { UA.EdgeHTML = _dV("Edge");
-                                                        UA.Edge = UA.EdgeHTML;
-                } else if(/ Chrom(ium|e)\/\d/.test(NUA)) { UA.Blink = UA.Chromium = (V => V[0] ? V : _dV("Chrome"))(_dV("Chromium"));
-                        if(     / EdgA?\/\d/.test(NUA))   UA.Edge = (V => V[0] ? V : _dV("Edg"))(_dV("EdgA"));
-                    else if(       / OPR\/\d/.test(NUA))   UA.Opera = _dV("OPR");
-                    else if(   / Vivaldi\/\d/.test(NUA))   UA.Vivaldi = _dV("Vivaldi");
-                    else if(      / Silk\/\d/.test(NUA))   UA.Silk = _dV("Silk");
-                    else if( / UCBrowser\/\d/.test(NUA))   UA.UCBrowser = _dV("UCBrowser");
-                    else if(    / Phoebe\/\d/.test(NUA))   UA.Phoebe = _dV("Phoebe");
-                    else                                   UA.Chrome = (V => V[0] ? V : UA.Chromium)(_dV("Chrome"));
-                } else if( / AppleWebKit\/\d/.test(NUA)) { UA.WebKit = _dV("AppleWebKit");
-                        if(      / CriOS \d/.test(NUA))   UA.Chrome = _dV("CriOS");
-                    else if(      / FxiOS \d/.test(NUA))   UA.Firefox = _dV("FxiOS");
-                    else if(    / EdgiOS\/\d/.test(NUA))   UA.Edge = _dV("EdgiOS");
-                    else if(   / Version\/\d/.test(NUA))   UA.Safari = _dV("Version");
-                } else if(     / Trident\/\d/.test(NUA)) { UA.Trident = _dV("Trident");
-                                                        UA.InternetExplorer = (V => V[0] ? V : _dV("MSIE"))(_dV("rv"));
-                }
-            } /*+*/ if( /[\[; ]FB(AN|_IAB)\//.test(NUA))   UA.Facebook = _dV("FBAV");
-            /*+*/ if(           / Line\/\d/.test(NUA))   UA.LINE = _dV("Line");
-            return UA;
-        })({} as UAFlags);
-
-        (this.Env as any) = { get: () => [this.OS, this.UA].reduce((Env: string[], OS_UA) => { for(const Par in OS_UA) if((OS_UA as any)[Par]) Env.push(Par); return Env; }, []) };
-    }
-}
-
-class sMLFactoryWithRequest extends sMLFactory {
-    get iOSRequest(): iOSRequest {
-        const NUAD = userAgentData(), NUA = userAgent();
-
-        if (this.OS.iOS && !this.OS.iPadOS) {
-            return "mobile";
-        } else if (this.OS.iPadOS) {
-            return (/\(iPad;/.test(NUA) || (NUAD && /^iPad(OS)?$/.test(NUAD.platform))) ? "mobile" : "desktop"
-        }
-
-        return undefined;
-    }
-}
-
-const sML = new sMLFactory();
-const sMLWithRequest = new sMLFactoryWithRequest();
-export { sML, sMLWithRequest };

package/types/src/helpers/sML.d.ts

@@ -1,56 +0,0 @@
-/*!
- *                                                                                                                         (℠)
- *  # sML.js | I'm a Simple and Middling Library.
- *
- *  * Copyright (c) Satoru MATSUSHIMA - https://github.com/satorumurmur/sML
- *  * Licensed under the MIT license. - http://www.opensource.org/licenses/mit-license.php
- *
- * Portions of this code come from the sML library
- * Current version: 1.0.36
- */
-declare interface OSFlags {
-    iOS: number[];
-    macOS: number[];
-    iPadOS: number[];
-    WindowsPhone: number[];
-    ChromeOS: number[];
-    Windows: number[];
-    Android: number[];
-    Linux: number[];
-    Firefox: boolean;
-}
-declare interface UAFlags {
-    Gecko: number[];
-    Firefox: number[];
-    Waterfox: number[];
-    Opera: number[];
-    Silk: number[];
-    Blink: number[];
-    EdgeHTML: number[];
-    Chrome: number[];
-    Chromium: number[];
-    Phoebe: number[];
-    UCBrowser: number[];
-    Vivaldi: number[];
-    Safari: number[];
-    Edge: number[];
-    WebKit: number[];
-    Trident: number[];
-    InternetExplorer: number[];
-    Flash: number[];
-    Facebook: number[];
-    LINE: number[];
-}
-declare type iOSRequest = "mobile" | "desktop" | undefined;
-declare class sMLFactory {
-    OS: OSFlags;
-    UA: UAFlags;
-    Env: string[];
-    constructor();
-}
-declare class sMLFactoryWithRequest extends sMLFactory {
-    get iOSRequest(): iOSRequest;
-}
-declare const sML: sMLFactory;
-declare const sMLWithRequest: sMLFactoryWithRequest;
-export { sML, sMLWithRequest };