From e255ae5bac6fe1755473554af87e4b0318d86aaf Mon Sep 17 00:00:00 2001 From: Nystik <236107-Nystik@users.noreply.gitlab.com> Date: Wed, 15 Jan 2025 02:45:20 +0100 Subject: [PATCH] move docs back --- docs.js | 2 +- {core/docs => docs}/.nojekyll | 0 {core/docs => docs}/assets/hierarchy.js | 0 {core/docs => docs}/assets/highlight.css | 0 {core/docs => docs}/assets/icons.js | 0 {core/docs => docs}/assets/icons.svg | 0 {core/docs => docs}/assets/main.js | 0 {core/docs => docs}/assets/navigation.js | 0 {core/docs => docs}/assets/search.js | 0 {core/docs => docs}/assets/style.css | 0 {core/docs => docs}/index.html | 0 .../modules_dom_naie-dom.DOMUtils.html | 20 +++++++++---------- ...s_controls_naie-controls.NAIEControls.html | 4 ++-- ...s_controls_naie-controls.SelectOption.html | 4 ++-- ...ie-indicator-utils.NAIEIndicatorUtils.html | 4 ++-- ...e-indicator-utils.NAIEStatusIndicator.html | 4 ++-- ...nsions_loaders_naie-loader.NAIELoader.html | 6 +++--- ...nsions_naie-extensions.NAIEExtensions.html | 4 ++-- ...dules_internal_naie-internal.NAIECore.html | 6 +++--- ...s_internal_naie-internal.NAIEInternal.html | 12 +++++------ .../modules_logging_naie-logging.Logger.html | 4 ++-- ...ules_logging_naie-logging.NAIELogging.html | 12 +++++------ .../modules_misc_naie-misc.MiscEmitter.html | 8 ++++---- .../modules_misc_naie-misc.MiscUtils.html | 16 +++++++-------- ...dules_nai_modals_naie-modal.NAIEModal.html | 8 ++++---- ...i_modals_naie-modal.NAIEModalObserver.html | 8 ++++---- .../modules_nai_naie-nai.NAIUtils.html | 4 ++-- ...es_network_naie-network.BlockResponse.html | 4 ++-- ...ules_network_naie-network.NAIENetwork.html | 4 ++-- ...s_network_naie-network.NetworkManager.html | 14 ++++++------- ...ules_network_naie-network.RequestHook.html | 16 +++++++-------- ...les_network_naie-network.RequestUtils.html | 4 ++-- ...reflight_naie-preflight.NAIEPreflight.html | 4 ++-- ...eflight_naie-preflight.PreflightError.html | 4 ++-- ...reflight_naie-preflight.PreflightHook.html | 4 ++-- .../interfaces/naie-core.NAIE.html | 4 ++-- .../interfaces/naie-core.NAIEServices.html | 6 +++--- .../interfaces/naie-core.Window.html | 4 ++-- {core/docs => docs}/media/LICENSE | 0 {core/docs => docs}/modules.html | 0 .../modules/modules_dom_naie-dom.html | 0 ...les_extensions_controls_naie-controls.html | 0 ...nsions_indicator_naie-indicator-utils.html | 0 ...odules_extensions_loaders_naie-loader.html | 0 .../modules_extensions_naie-extensions.html | 0 .../modules_internal_naie-internal.html | 0 .../modules/modules_logging_naie-logging.html | 0 .../modules/modules_misc_naie-misc.html | 0 .../modules_nai_modals_naie-modal.html | 0 .../modules/modules_nai_naie-nai.html | 0 .../modules/modules_network_naie-network.html | 0 .../modules_preflight_naie-preflight.html | 0 {core/docs => docs}/modules/naie-core.html | 0 ...modules_logging_naie-logging.LogLevel.html | 2 +- ...odules_logging_naie-logging.LogMethod.html | 2 +- ...i_modals_naie-modal.ModalEventHandler.html | 2 +- ..._nai_modals_naie-modal.ModalPredicate.html | 2 +- ...eflight_naie-preflight.PreflightStage.html | 2 +- .../variables/naie-core.Window-1.html | 2 +- 59 files changed, 103 insertions(+), 103 deletions(-) rename {core/docs => docs}/.nojekyll (100%) rename {core/docs => docs}/assets/hierarchy.js (100%) rename {core/docs => docs}/assets/highlight.css (100%) rename {core/docs => docs}/assets/icons.js (100%) rename {core/docs => docs}/assets/icons.svg (100%) rename {core/docs => docs}/assets/main.js (100%) rename {core/docs => docs}/assets/navigation.js (100%) rename {core/docs => docs}/assets/search.js (100%) rename {core/docs => docs}/assets/style.css (100%) rename {core/docs => docs}/index.html (100%) rename {core/docs => docs}/interfaces/modules_dom_naie-dom.DOMUtils.html (97%) rename {core/docs => docs}/interfaces/modules_extensions_controls_naie-controls.NAIEControls.html (97%) rename {core/docs => docs}/interfaces/modules_extensions_controls_naie-controls.SelectOption.html (96%) rename {core/docs => docs}/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEIndicatorUtils.html (97%) rename {core/docs => docs}/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEStatusIndicator.html (97%) rename {core/docs => docs}/interfaces/modules_extensions_loaders_naie-loader.NAIELoader.html (96%) rename {core/docs => docs}/interfaces/modules_extensions_naie-extensions.NAIEExtensions.html (96%) rename {core/docs => docs}/interfaces/modules_internal_naie-internal.NAIECore.html (97%) rename {core/docs => docs}/interfaces/modules_internal_naie-internal.NAIEInternal.html (95%) rename {core/docs => docs}/interfaces/modules_logging_naie-logging.Logger.html (95%) rename {core/docs => docs}/interfaces/modules_logging_naie-logging.NAIELogging.html (96%) rename {core/docs => docs}/interfaces/modules_misc_naie-misc.MiscEmitter.html (97%) rename {core/docs => docs}/interfaces/modules_misc_naie-misc.MiscUtils.html (96%) rename {core/docs => docs}/interfaces/modules_nai_modals_naie-modal.NAIEModal.html (96%) rename {core/docs => docs}/interfaces/modules_nai_modals_naie-modal.NAIEModalObserver.html (96%) rename {core/docs => docs}/interfaces/modules_nai_naie-nai.NAIUtils.html (97%) rename {core/docs => docs}/interfaces/modules_network_naie-network.BlockResponse.html (98%) rename {core/docs => docs}/interfaces/modules_network_naie-network.NAIENetwork.html (97%) rename {core/docs => docs}/interfaces/modules_network_naie-network.NetworkManager.html (96%) rename {core/docs => docs}/interfaces/modules_network_naie-network.RequestHook.html (95%) rename {core/docs => docs}/interfaces/modules_network_naie-network.RequestUtils.html (98%) rename {core/docs => docs}/interfaces/modules_preflight_naie-preflight.NAIEPreflight.html (98%) rename {core/docs => docs}/interfaces/modules_preflight_naie-preflight.PreflightError.html (95%) rename {core/docs => docs}/interfaces/modules_preflight_naie-preflight.PreflightHook.html (95%) rename {core/docs => docs}/interfaces/naie-core.NAIE.html (94%) rename {core/docs => docs}/interfaces/naie-core.NAIEServices.html (96%) rename {core/docs => docs}/interfaces/naie-core.Window.html (99%) rename {core/docs => docs}/media/LICENSE (100%) rename {core/docs => docs}/modules.html (100%) rename {core/docs => docs}/modules/modules_dom_naie-dom.html (100%) rename {core/docs => docs}/modules/modules_extensions_controls_naie-controls.html (100%) rename {core/docs => docs}/modules/modules_extensions_indicator_naie-indicator-utils.html (100%) rename {core/docs => docs}/modules/modules_extensions_loaders_naie-loader.html (100%) rename {core/docs => docs}/modules/modules_extensions_naie-extensions.html (100%) rename {core/docs => docs}/modules/modules_internal_naie-internal.html (100%) rename {core/docs => docs}/modules/modules_logging_naie-logging.html (100%) rename {core/docs => docs}/modules/modules_misc_naie-misc.html (100%) rename {core/docs => docs}/modules/modules_nai_modals_naie-modal.html (100%) rename {core/docs => docs}/modules/modules_nai_naie-nai.html (100%) rename {core/docs => docs}/modules/modules_network_naie-network.html (100%) rename {core/docs => docs}/modules/modules_preflight_naie-preflight.html (100%) rename {core/docs => docs}/modules/naie-core.html (100%) rename {core/docs => docs}/types/modules_logging_naie-logging.LogLevel.html (97%) rename {core/docs => docs}/types/modules_logging_naie-logging.LogMethod.html (98%) rename {core/docs => docs}/types/modules_nai_modals_naie-modal.ModalEventHandler.html (98%) rename {core/docs => docs}/types/modules_nai_modals_naie-modal.ModalPredicate.html (98%) rename {core/docs => docs}/types/modules_preflight_naie-preflight.PreflightStage.html (98%) rename {core/docs => docs}/variables/naie-core.Window-1.html (98%) diff --git a/docs.js b/docs.js index dffbf27..573e7c6 100644 --- a/docs.js +++ b/docs.js @@ -28,7 +28,7 @@ const getDtsFiles = (dir, files = []) => { const runTypedoc = (files) => { const version = getCoreVersion() const fileList = files.join(' ') - const command = `npx typedoc --out core/docs ${fileList} --name "NAIE Core API v${version}"` + const command = `npx typedoc --out docs ${fileList} --name "NAIE Core API v${version}"` console.log(`Running command: ${command}`) exec(command, (error, stdout, stderr) => { if (error) { diff --git a/core/docs/.nojekyll b/docs/.nojekyll similarity index 100% rename from core/docs/.nojekyll rename to docs/.nojekyll diff --git a/core/docs/assets/hierarchy.js b/docs/assets/hierarchy.js similarity index 100% rename from core/docs/assets/hierarchy.js rename to docs/assets/hierarchy.js diff --git a/core/docs/assets/highlight.css b/docs/assets/highlight.css similarity index 100% rename from core/docs/assets/highlight.css rename to docs/assets/highlight.css diff --git a/core/docs/assets/icons.js b/docs/assets/icons.js similarity index 100% rename from core/docs/assets/icons.js rename to docs/assets/icons.js diff --git a/core/docs/assets/icons.svg b/docs/assets/icons.svg similarity index 100% rename from core/docs/assets/icons.svg rename to docs/assets/icons.svg diff --git a/core/docs/assets/main.js b/docs/assets/main.js similarity index 100% rename from core/docs/assets/main.js rename to docs/assets/main.js diff --git a/core/docs/assets/navigation.js b/docs/assets/navigation.js similarity index 100% rename from core/docs/assets/navigation.js rename to docs/assets/navigation.js diff --git a/core/docs/assets/search.js b/docs/assets/search.js similarity index 100% rename from core/docs/assets/search.js rename to docs/assets/search.js diff --git a/core/docs/assets/style.css b/docs/assets/style.css similarity index 100% rename from core/docs/assets/style.css rename to docs/assets/style.css diff --git a/core/docs/index.html b/docs/index.html similarity index 100% rename from core/docs/index.html rename to docs/index.html diff --git a/core/docs/interfaces/modules_dom_naie-dom.DOMUtils.html b/docs/interfaces/modules_dom_naie-dom.DOMUtils.html similarity index 97% rename from core/docs/interfaces/modules_dom_naie-dom.DOMUtils.html rename to docs/interfaces/modules_dom_naie-dom.DOMUtils.html index 8d62ff5..d42f2f1 100644 --- a/core/docs/interfaces/modules_dom_naie-dom.DOMUtils.html +++ b/docs/interfaces/modules_dom_naie-dom.DOMUtils.html @@ -1,5 +1,5 @@ DOMUtils | NAIE Core API v1.0.4

An interface defining general dom utility functions for NAIE

-
interface DOMUtils {
    addEventListenerOnce(
        element: HTMLElement,
        event: string,
        handler: (event: Event) => void,
    ): void;
    createElement(tag: string, styles?: Record<string, string>): HTMLElement;
    findElementWithMaskImage(
        elements: HTMLElement[],
        urlSubstrings: string[],
    ): HTMLElement[];
    onClickOutside(
        element: HTMLElement,
        callback: () => void,
        oneShot?: boolean,
    ): { remove: () => void };
    setNativeValue(
        element: HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement,
        value: string | number,
    ): void;
    simulateClick(element: HTMLElement): void;
    simulateInputEvent(
        element: HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement,
    ): void;
    simulateRightClick(element: HTMLElement): void;
    waitForElement(
        selector: string,
        timeout: number,
        rootElement?: HTMLElement,
    ): Promise<null | HTMLElement>;
}

Methods

interface DOMUtils {
    addEventListenerOnce(
        element: HTMLElement,
        event: string,
        handler: (event: Event) => void,
    ): void;
    createElement(tag: string, styles?: Record<string, string>): HTMLElement;
    findElementWithMaskImage(
        elements: HTMLElement[],
        urlSubstrings: string[],
    ): HTMLElement[];
    onClickOutside(
        element: HTMLElement,
        callback: () => void,
        oneShot?: boolean,
    ): { remove: () => void };
    setNativeValue(
        element: HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement,
        value: string | number,
    ): void;
    simulateClick(element: HTMLElement): void;
    simulateInputEvent(
        element: HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement,
    ): void;
    simulateRightClick(element: HTMLElement): void;
    waitForElement(
        selector: string,
        timeout: number,
        rootElement?: HTMLElement,
    ): Promise<null | HTMLElement>;
}

Methods

Parameters

  • element: HTMLElement

    The DOM element to add the event listener to.

  • event: string

    The event type to listen for (e.g., 'click', 'mouseover').

  • handler: (event: Event) => void

    The function to handle the event.

    -

Returns void

  • Creates a new HTML element with the specified tag and applies the given styles.

    +

Returns void

  • Creates a new HTML element with the specified tag and applies the given styles.

    Parameters

    • tag: string

      The tag name for the element (e.g., 'div', 'span').

    • Optionalstyles: Record<string, string>

      An object containing CSS properties and values to apply to the element.

    Returns HTMLElement

    The newly created HTML element with applied styles.

    -
  • Finds elements with a mask image that includes all specified URL substrings.

    +
  • Finds elements with a mask image that includes all specified URL substrings.

    Parameters

    • elements: HTMLElement[]

      An array of elements to search.

    • urlSubstrings: string[]

      An array of substrings to check for in the mask-image property.

    Returns HTMLElement[]

    An array of elements that match the criteria.

    -
  • Adds a click event listener that triggers a callback when a click occurs outside the specified element. +

  • Adds a click event listener that triggers a callback when a click occurs outside the specified element. Optionally, the listener can be removed after the first click if oneShot is true.

    Parameters

    • element: HTMLElement

      The DOM element to detect clicks outside of.

    • callback: () => void

      The function to call when a click outside the element is detected.

    • OptionaloneShot: boolean

      Optional. If true, the listener is removed after the first click.

    Returns { remove: () => void }

    An object with a remove method to manually remove the event listener.

    -
  • Sets the value of an input element using native value setter methods.

    +
  • Sets the value of an input element using native value setter methods.

    Parameters

    • element: HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement

      The input element to set the value for.

    • value: string | number

      The value to set on the input element.

      -

    Returns void

  • Simulates a click event on the specified element.

    +

Returns void

  • Simulates a click event on the specified element.

    Parameters

    • element: HTMLElement

      The element on which to simulate the click event.

      -

    Returns void

  • Simulates an input event on the specified element.

    +

Returns void

Returns void

Returns void

+
diff --git a/core/docs/interfaces/modules_extensions_controls_naie-controls.NAIEControls.html b/docs/interfaces/modules_extensions_controls_naie-controls.NAIEControls.html similarity index 97% rename from core/docs/interfaces/modules_extensions_controls_naie-controls.NAIEControls.html rename to docs/interfaces/modules_extensions_controls_naie-controls.NAIEControls.html index 3a6d108..e31c73e 100644 --- a/core/docs/interfaces/modules_extensions_controls_naie-controls.NAIEControls.html +++ b/docs/interfaces/modules_extensions_controls_naie-controls.NAIEControls.html @@ -1,8 +1,8 @@ NAIEControls | NAIE Core API v1.0.4

An interface defining functions for NAIE controls

-
interface NAIEControls {
    Select: {
        constructSelectControl(
            options: SelectOption[],
            selectedValue: string,
            onChange: (value: string) => void,
        ): HTMLElement;
    };
}

Properties

interface NAIEControls {
    Select: {
        constructSelectControl(
            options: SelectOption[],
            selectedValue: string,
            onChange: (value: string) => void,
        ): HTMLElement;
    };
}

Properties

Properties

Select: {
    constructSelectControl(
        options: SelectOption[],
        selectedValue: string,
        onChange: (value: string) => void,
    ): HTMLElement;
}

Type declaration

  • constructSelectControl:function
    • Creates a custom select control element with options and handles user interactions.

      Parameters

      • options: SelectOption[]

        Array of options with title and value properties.

      • selectedValue: string

        The value of the initially selected option.

      • onChange: (value: string) => void

        Function called with the selected value when an option is chosen.

      Returns HTMLElement

      The custom select control element.

      -
+
diff --git a/core/docs/interfaces/modules_extensions_controls_naie-controls.SelectOption.html b/docs/interfaces/modules_extensions_controls_naie-controls.SelectOption.html similarity index 96% rename from core/docs/interfaces/modules_extensions_controls_naie-controls.SelectOption.html rename to docs/interfaces/modules_extensions_controls_naie-controls.SelectOption.html index 41f7576..c96ae69 100644 --- a/core/docs/interfaces/modules_extensions_controls_naie-controls.SelectOption.html +++ b/docs/interfaces/modules_extensions_controls_naie-controls.SelectOption.html @@ -1,3 +1,3 @@ -SelectOption | NAIE Core API v1.0.4
interface SelectOption {
    title: string;
    value: string;
}

Properties

title +SelectOption | NAIE Core API v1.0.4
interface SelectOption {
    title: string;
    value: string;
}

Properties

Properties

title: string
value: string
+

Properties

title: string
value: string
diff --git a/core/docs/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEIndicatorUtils.html b/docs/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEIndicatorUtils.html similarity index 97% rename from core/docs/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEIndicatorUtils.html rename to docs/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEIndicatorUtils.html index 9e892ce..f22401f 100644 --- a/core/docs/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEIndicatorUtils.html +++ b/docs/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEIndicatorUtils.html @@ -1,7 +1,7 @@ NAIEIndicatorUtils | NAIE Core API v1.0.4

An interface defining functions for NAIE controls

-
interface NAIEIndicatorUtils {
    createIndicatorManager(
        logContainer: HTMLElement,
        maxRows: number,
        duration?: number,
    ): NAIEStatusIndicator;
    createMessageManager(): {
        hasMessages(): boolean;
        popMessage(): string;
        pushMessage(message: string): void;
    };
    createNAIEIndicator(): NAIEStatusIndicator;
    createNAIEindicatorElement(): HTMLElement;
    getNAIEindicator(): HTMLElement;
}

Methods

interface NAIEIndicatorUtils {
    createIndicatorManager(
        logContainer: HTMLElement,
        maxRows: number,
        duration?: number,
    ): NAIEStatusIndicator;
    createMessageManager(): {
        hasMessages(): boolean;
        popMessage(): string;
        pushMessage(message: string): void;
    };
    createNAIEIndicator(): NAIEStatusIndicator;
    createNAIEindicatorElement(): HTMLElement;
    getNAIEindicator(): HTMLElement;
}

Methods

  • Returns {
        hasMessages(): boolean;
        popMessage(): string;
        pushMessage(message: string): void;
    }

+

Methods

  • Returns {
        hasMessages(): boolean;
        popMessage(): string;
        pushMessage(message: string): void;
    }

diff --git a/core/docs/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEStatusIndicator.html b/docs/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEStatusIndicator.html similarity index 97% rename from core/docs/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEStatusIndicator.html rename to docs/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEStatusIndicator.html index a12a2c0..0b9b40d 100644 --- a/core/docs/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEStatusIndicator.html +++ b/docs/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEStatusIndicator.html @@ -1,3 +1,3 @@ NAIEStatusIndicator | NAIE Core API v1.0.4

An object that controls the NAIE indicator element

-
interface NAIEStatusIndicator {
    displayMessage(message: string): void;
}

Methods

+
interface NAIEStatusIndicator {
    displayMessage(message: string): void;
}

Methods

diff --git a/core/docs/interfaces/modules_extensions_loaders_naie-loader.NAIELoader.html b/docs/interfaces/modules_extensions_loaders_naie-loader.NAIELoader.html similarity index 96% rename from core/docs/interfaces/modules_extensions_loaders_naie-loader.NAIELoader.html rename to docs/interfaces/modules_extensions_loaders_naie-loader.NAIELoader.html index 470fed7..215cf74 100644 --- a/core/docs/interfaces/modules_extensions_loaders_naie-loader.NAIELoader.html +++ b/docs/interfaces/modules_extensions_loaders_naie-loader.NAIELoader.html @@ -1,9 +1,9 @@ NAIELoader | NAIE Core API v1.0.4

An interface defining functions for the NAIE loader

-
interface NAIELoader {
    getSpinner(): HTMLElement;
    lockLoader(app: HTMLElement): { unlock(): void };
}

Methods

interface NAIELoader {
    getSpinner(): HTMLElement;
    lockLoader(app: HTMLElement): { unlock(): void };
}

Methods

  • Creates and displays a loader element to indicate loading state, and provides a method to remove it.

    Parameters

    • app: HTMLElement

      Should be the #app container

    Returns { unlock(): void }

    lock object

    -
+
diff --git a/core/docs/interfaces/modules_extensions_naie-extensions.NAIEExtensions.html b/docs/interfaces/modules_extensions_naie-extensions.NAIEExtensions.html similarity index 96% rename from core/docs/interfaces/modules_extensions_naie-extensions.NAIEExtensions.html rename to docs/interfaces/modules_extensions_naie-extensions.NAIEExtensions.html index 6124bd1..bf96479 100644 --- a/core/docs/interfaces/modules_extensions_naie-extensions.NAIEExtensions.html +++ b/docs/interfaces/modules_extensions_naie-extensions.NAIEExtensions.html @@ -1,4 +1,4 @@ NAIEExtensions | NAIE Core API v1.0.4

An interface defining functions for NAIE extensions

-
interface NAIEExtensions {
    Controls: NAIEControls;
    Loader: NAIELoader;
}

Properties

interface NAIEExtensions {
    Controls: NAIEControls;
    Loader: NAIELoader;
}

Properties

Properties

Controls: NAIEControls
Loader: NAIELoader
+

Properties

Controls: NAIEControls
Loader: NAIELoader
diff --git a/core/docs/interfaces/modules_internal_naie-internal.NAIECore.html b/docs/interfaces/modules_internal_naie-internal.NAIECore.html similarity index 97% rename from core/docs/interfaces/modules_internal_naie-internal.NAIECore.html rename to docs/interfaces/modules_internal_naie-internal.NAIECore.html index 8484981..f895b55 100644 --- a/core/docs/interfaces/modules_internal_naie-internal.NAIECore.html +++ b/docs/interfaces/modules_internal_naie-internal.NAIECore.html @@ -1,12 +1,12 @@ NAIECore | NAIE Core API v1.0.4

Core script management interface

-
interface NAIECore {
    markScriptReady(scriptId: string): Promise<void>;
    registerScript(scriptId: string): void;
}

Methods

interface NAIECore {
    markScriptReady(scriptId: string): Promise<void>;
    registerScript(scriptId: string): void;
}

Methods

  • Mark a feature script as ready for preflight Script must be registered first

    Parameters

    • scriptId: string

      Unique identifier for the script

    Returns Promise<void>

    If script is not registered

    -
  • Register a feature script with NAIE +

  • Register a feature script with NAIE Must be called before markScriptReady

    Parameters

    • scriptId: string

      Unique identifier for the script

    Returns void

    If script tries to register after preflight started

    -
+
diff --git a/core/docs/interfaces/modules_internal_naie-internal.NAIEInternal.html b/docs/interfaces/modules_internal_naie-internal.NAIEInternal.html similarity index 95% rename from core/docs/interfaces/modules_internal_naie-internal.NAIEInternal.html rename to docs/interfaces/modules_internal_naie-internal.NAIEInternal.html index 393182f..89addfa 100644 --- a/core/docs/interfaces/modules_internal_naie-internal.NAIEInternal.html +++ b/docs/interfaces/modules_internal_naie-internal.NAIEInternal.html @@ -1,12 +1,12 @@ NAIEInternal | NAIE Core API v1.0.4

Internal state and management interface for NAIE

-
interface NAIEInternal {
    isPreflightStarted: boolean;
    isWaitingForScripts: boolean;
    preflight: { runStages(): Promise<PreflightError[]> };
    readyScripts: Set<string>;
    registeredScripts: Set<string>;
}

Properties

interface NAIEInternal {
    isPreflightStarted: boolean;
    isWaitingForScripts: boolean;
    preflight: { runStages(): Promise<PreflightError[]> };
    readyScripts: Set<string>;
    registeredScripts: Set<string>;
}

Properties

isPreflightStarted: boolean

Whether the preflight process has started

-
isWaitingForScripts: boolean

Whether we are currently waiting for scripts to become ready

-
preflight: { runStages(): Promise<PreflightError[]> }

Preflight management

-
readyScripts: Set<string>

Set of script IDs that have been marked as ready

-
registeredScripts: Set<string>

Set of script IDs that have been registered

-
+
isWaitingForScripts: boolean

Whether we are currently waiting for scripts to become ready

+
preflight: { runStages(): Promise<PreflightError[]> }

Preflight management

+
readyScripts: Set<string>

Set of script IDs that have been marked as ready

+
registeredScripts: Set<string>

Set of script IDs that have been registered

+
diff --git a/core/docs/interfaces/modules_logging_naie-logging.Logger.html b/docs/interfaces/modules_logging_naie-logging.Logger.html similarity index 95% rename from core/docs/interfaces/modules_logging_naie-logging.Logger.html rename to docs/interfaces/modules_logging_naie-logging.Logger.html index 1d2ee71..5c7419a 100644 --- a/core/docs/interfaces/modules_logging_naie-logging.Logger.html +++ b/docs/interfaces/modules_logging_naie-logging.Logger.html @@ -1,6 +1,6 @@ Logger | NAIE Core API v1.0.4

Logger instance with methods for each log level

-
interface Logger {
    debug: LogMethod;
    error: LogMethod;
    info: LogMethod;
    warn: LogMethod;
}

Properties

interface Logger {
    debug: LogMethod;
    error: LogMethod;
    info: LogMethod;
    warn: LogMethod;
}

Properties

Properties

debug: LogMethod
error: LogMethod
info: LogMethod
warn: LogMethod
+

Properties

debug: LogMethod
error: LogMethod
info: LogMethod
warn: LogMethod
diff --git a/core/docs/interfaces/modules_logging_naie-logging.NAIELogging.html b/docs/interfaces/modules_logging_naie-logging.NAIELogging.html similarity index 96% rename from core/docs/interfaces/modules_logging_naie-logging.NAIELogging.html rename to docs/interfaces/modules_logging_naie-logging.NAIELogging.html index 9297730..21d06ea 100644 --- a/core/docs/interfaces/modules_logging_naie-logging.NAIELogging.html +++ b/docs/interfaces/modules_logging_naie-logging.NAIELogging.html @@ -1,15 +1,15 @@ NAIELogging | NAIE Core API v1.0.4

Core logging utilities

-
interface NAIELogging {
    createLogger(level: LogLevel): Logger;
    getLogger(): Logger;
    getLogLevel(): LogLevel;
    isDebugMode(): boolean;
    setLogLevel(level: LogLevel): void;
}

Methods

interface NAIELogging {
    createLogger(level: LogLevel): Logger;
    getLogger(): Logger;
    getLogLevel(): LogLevel;
    isDebugMode(): boolean;
    setLogLevel(level: LogLevel): void;
}

Methods

+
diff --git a/core/docs/interfaces/modules_misc_naie-misc.MiscEmitter.html b/docs/interfaces/modules_misc_naie-misc.MiscEmitter.html similarity index 97% rename from core/docs/interfaces/modules_misc_naie-misc.MiscEmitter.html rename to docs/interfaces/modules_misc_naie-misc.MiscEmitter.html index 72112e3..191ccc5 100644 --- a/core/docs/interfaces/modules_misc_naie-misc.MiscEmitter.html +++ b/docs/interfaces/modules_misc_naie-misc.MiscEmitter.html @@ -1,14 +1,14 @@ MiscEmitter | NAIE Core API v1.0.4

Event emitter class for handling event subscriptions and emissions

-
interface MiscEmitter {
    emit(event: string, ...data: any[]): void;
    off(event: string, callback: (...args: any[]) => void): void;
    on(event: string, callback: (...args: any[]) => void): void;
}

Methods

interface MiscEmitter {
    emit(event: string, ...data: any[]): void;
    off(event: string, callback: (...args: any[]) => void): void;
    on(event: string, callback: (...args: any[]) => void): void;
}

Methods

Methods

  • Emit an event with optional data

    Parameters

    • event: string

      The event name to emit

    • ...data: any[]

      Optional data to pass to event handlers

      -

    Returns void

  • Unsubscribe from an event

    +

Returns void

  • Unsubscribe from an event

    Parameters

    • event: string

      The event name to unsubscribe from

    • callback: (...args: any[]) => void

      The callback function to remove

      -

    Returns void

  • Subscribe to an event

    +

Returns void

+

Returns void

diff --git a/core/docs/interfaces/modules_misc_naie-misc.MiscUtils.html b/docs/interfaces/modules_misc_naie-misc.MiscUtils.html similarity index 96% rename from core/docs/interfaces/modules_misc_naie-misc.MiscUtils.html rename to docs/interfaces/modules_misc_naie-misc.MiscUtils.html index 46530c0..889e7b4 100644 --- a/core/docs/interfaces/modules_misc_naie-misc.MiscUtils.html +++ b/docs/interfaces/modules_misc_naie-misc.MiscUtils.html @@ -1,5 +1,5 @@ MiscUtils | NAIE Core API v1.0.4

An interface defining general utility functions for NAIE

-
interface MiscUtils {
    Emitter: new () => MiscEmitter;
    addGlobalStyle(css: string): void;
    decodeBase64(str: string): string;
    encodeBase64(str: string): string;
    isMobileView(): boolean;
    isObjEmpty(obj: object): boolean;
    sleep(duration: number): Promise<void>;
}

Properties

interface MiscUtils {
    Emitter: new () => MiscEmitter;
    addGlobalStyle(css: string): void;
    decodeBase64(str: string): string;
    encodeBase64(str: string): string;
    isMobileView(): boolean;
    isObjEmpty(obj: object): boolean;
    sleep(duration: number): Promise<void>;
}

Properties

Methods

Properties

Emitter: new () => MiscEmitter

Creates a new event emitter instance

Type declaration

Methods

  • Add a global CSS style to the document

    +

Methods

  • Decode a base64 string

    +

Returns void

+
diff --git a/core/docs/interfaces/modules_nai_modals_naie-modal.NAIEModal.html b/docs/interfaces/modules_nai_modals_naie-modal.NAIEModal.html similarity index 96% rename from core/docs/interfaces/modules_nai_modals_naie-modal.NAIEModal.html rename to docs/interfaces/modules_nai_modals_naie-modal.NAIEModal.html index 97ce2a1..d4ff650 100644 --- a/core/docs/interfaces/modules_nai_modals_naie-modal.NAIEModal.html +++ b/docs/interfaces/modules_nai_modals_naie-modal.NAIEModal.html @@ -1,8 +1,8 @@ NAIEModal | NAIE Core API v1.0.4

Represents a modal dialog in the NAI interface

-
interface NAIEModal {
    closeButton: HTMLElement;
    modal: HTMLElement;
    overlay: HTMLElement;
}

Properties

interface NAIEModal {
    closeButton: HTMLElement;
    modal: HTMLElement;
    overlay: HTMLElement;
}

Properties

closeButton: HTMLElement

The close button element for the modal

-
modal: HTMLElement

The modal element itself

-
overlay: HTMLElement

The overlay element that contains the modal

-
+
modal: HTMLElement

The modal element itself

+
overlay: HTMLElement

The overlay element that contains the modal

+
diff --git a/core/docs/interfaces/modules_nai_modals_naie-modal.NAIEModalObserver.html b/docs/interfaces/modules_nai_modals_naie-modal.NAIEModalObserver.html similarity index 96% rename from core/docs/interfaces/modules_nai_modals_naie-modal.NAIEModalObserver.html rename to docs/interfaces/modules_nai_modals_naie-modal.NAIEModalObserver.html index ee57dc7..bc43fb1 100644 --- a/core/docs/interfaces/modules_nai_modals_naie-modal.NAIEModalObserver.html +++ b/docs/interfaces/modules_nai_modals_naie-modal.NAIEModalObserver.html @@ -1,11 +1,11 @@ NAIEModalObserver | NAIE Core API v1.0.4

Observer service for detecting and interacting with NAI modals

-
interface NAIEModalObserver {
    emitter: MiscEmitter;
    observer: MutationObserver;
    waitForSpecificModal(
        predicate: ModalPredicate,
        timeout?: number,
    ): Promise<NAIEModal>;
}

Properties

interface NAIEModalObserver {
    emitter: MiscEmitter;
    observer: MutationObserver;
    waitForSpecificModal(
        predicate: ModalPredicate,
        timeout?: number,
    ): Promise<NAIEModal>;
}

Properties

emitter: MiscEmitter

Event emitter for modal-related events

-
observer: MutationObserver

The underlying MutationObserver that watches for modal changes

-

Methods

observer: MutationObserver

The underlying MutationObserver that watches for modal changes

+

Methods

  • Wait for a specific modal to appear that matches the given predicate

    Parameters

    • predicate: ModalPredicate

      Function that determines if a modal matches what we're looking for

    • Optionaltimeout: number

      Maximum time to wait for the modal in milliseconds

    Returns Promise<NAIEModal>

    Promise that resolves with the modal data when found, or rejects on timeout

    -
+
diff --git a/core/docs/interfaces/modules_nai_naie-nai.NAIUtils.html b/docs/interfaces/modules_nai_naie-nai.NAIUtils.html similarity index 97% rename from core/docs/interfaces/modules_nai_naie-nai.NAIUtils.html rename to docs/interfaces/modules_nai_naie-nai.NAIUtils.html index a74b113..d793d0f 100644 --- a/core/docs/interfaces/modules_nai_naie-nai.NAIUtils.html +++ b/docs/interfaces/modules_nai_naie-nai.NAIUtils.html @@ -1,5 +1,5 @@ NAIUtils | NAIE Core API v1.0.4

An interface defining functions associated with base NAI elements

-
interface NAIUtils {
    findTitleBar(): null | HTMLElement;
}

Methods

interface NAIUtils {
    findTitleBar(): null | HTMLElement;
}

Methods

Methods

  • Finds and returns the title bar element.

    Returns null | HTMLElement

    The title bar element if found, otherwise null.

    -
+
diff --git a/core/docs/interfaces/modules_network_naie-network.BlockResponse.html b/docs/interfaces/modules_network_naie-network.BlockResponse.html similarity index 98% rename from core/docs/interfaces/modules_network_naie-network.BlockResponse.html rename to docs/interfaces/modules_network_naie-network.BlockResponse.html index 11ae73f..dd72021 100644 --- a/core/docs/interfaces/modules_network_naie-network.BlockResponse.html +++ b/docs/interfaces/modules_network_naie-network.BlockResponse.html @@ -1,4 +1,4 @@ BlockResponse | NAIE Core API v1.0.4

Response returned when blocking a request

-
interface BlockResponse {
    type: "response";
    value: Response;
}

Properties

interface BlockResponse {
    type: "response";
    value: Response;
}

Properties

Properties

type: "response"
value: Response
+

Properties

type: "response"
value: Response
diff --git a/core/docs/interfaces/modules_network_naie-network.NAIENetwork.html b/docs/interfaces/modules_network_naie-network.NAIENetwork.html similarity index 97% rename from core/docs/interfaces/modules_network_naie-network.NAIENetwork.html rename to docs/interfaces/modules_network_naie-network.NAIENetwork.html index 32d2a57..dce087b 100644 --- a/core/docs/interfaces/modules_network_naie-network.NAIENetwork.html +++ b/docs/interfaces/modules_network_naie-network.NAIENetwork.html @@ -1,3 +1,3 @@ NAIENetwork | NAIE Core API v1.0.4

Interface for accessing the network module

-
interface NAIENetwork {
    manager: NetworkManager;
}

Properties

Properties

+
interface NAIENetwork {
    manager: NetworkManager;
}

Properties

Properties

diff --git a/core/docs/interfaces/modules_network_naie-network.NetworkManager.html b/docs/interfaces/modules_network_naie-network.NetworkManager.html similarity index 96% rename from core/docs/interfaces/modules_network_naie-network.NetworkManager.html rename to docs/interfaces/modules_network_naie-network.NetworkManager.html index d7de6db..aadd6e0 100644 --- a/core/docs/interfaces/modules_network_naie-network.NetworkManager.html +++ b/docs/interfaces/modules_network_naie-network.NetworkManager.html @@ -1,18 +1,18 @@ NetworkManager | NAIE Core API v1.0.4

Network manager interface for registering and managing request hooks

-
interface NetworkManager {
    utils: RequestUtils;
    disableHook(id: string): void;
    enableHook(id: string): void;
    initialize(): void;
    registerHook(hook: RequestHook): void;
    unregisterHook(id: string): void;
}

Properties

interface NetworkManager {
    utils: RequestUtils;
    disableHook(id: string): void;
    enableHook(id: string): void;
    initialize(): void;
    registerHook(hook: RequestHook): void;
    unregisterHook(id: string): void;
}

Properties

Utility functions for working with requests

-

Methods

Methods

  • Enables a hook by its ID

    +

Returns void

  • Registers a new request hook

    +

Returns void

Returns void

+

Returns void

diff --git a/core/docs/interfaces/modules_network_naie-network.RequestHook.html b/docs/interfaces/modules_network_naie-network.RequestHook.html similarity index 95% rename from core/docs/interfaces/modules_network_naie-network.RequestHook.html rename to docs/interfaces/modules_network_naie-network.RequestHook.html index 856444f..dd290b2 100644 --- a/core/docs/interfaces/modules_network_naie-network.RequestHook.html +++ b/docs/interfaces/modules_network_naie-network.RequestHook.html @@ -1,5 +1,5 @@ RequestHook | NAIE Core API v1.0.4

A hook for intercepting and modifying network requests

-
interface RequestHook {
    enabled: boolean;
    id: string;
    methods: string[];
    modifyRequest?: (request: Request) => Promise<BlockResponse | Request>;
    modifyResponse?: (
        response: Response,
        request: Request,
    ) => Promise<Response>;
    priority: number;
    urlPattern: string | RegExp;
}

Properties

interface RequestHook {
    enabled: boolean;
    id: string;
    methods: string[];
    modifyRequest?: (request: Request) => Promise<BlockResponse | Request>;
    modifyResponse?: (
        response: Response,
        request: Request,
    ) => Promise<Response>;
    priority: number;
    urlPattern: string | RegExp;
}

Properties

Properties

enabled: boolean

Whether the hook is currently active

-
id: string

Unique identifier for the hook

-
methods: string[]

HTTP methods this hook handles (empty array means all methods)

-
modifyRequest?: (request: Request) => Promise<BlockResponse | Request>

Modifies the request before it is sent

+
id: string

Unique identifier for the hook

+
methods: string[]

HTTP methods this hook handles (empty array means all methods)

+
modifyRequest?: (request: Request) => Promise<BlockResponse | Request>

Modifies the request before it is sent

Type declaration

    • (request: Request): Promise<BlockResponse | Request>
    • Parameters

      • request: Request

        The request to modify

      Returns Promise<BlockResponse | Request>

      Modified request or block response

      -
modifyResponse?: (response: Response, request: Request) => Promise<Response>

Modifies the response after it is received

+
modifyResponse?: (response: Response, request: Request) => Promise<Response>

Modifies the response after it is received

Type declaration

    • (response: Response, request: Request): Promise<Response>
    • Parameters

      • response: Response

        The response to modify

      • request: Request

        The original request

      Returns Promise<Response>

      Modified response

      -
priority: number

Priority level for hook execution (higher numbers run first)

-
urlPattern: string | RegExp

URL pattern to match for this hook (string prefix or RegExp)

-
+
priority: number

Priority level for hook execution (higher numbers run first)

+
urlPattern: string | RegExp

URL pattern to match for this hook (string prefix or RegExp)

+
diff --git a/core/docs/interfaces/modules_network_naie-network.RequestUtils.html b/docs/interfaces/modules_network_naie-network.RequestUtils.html similarity index 98% rename from core/docs/interfaces/modules_network_naie-network.RequestUtils.html rename to docs/interfaces/modules_network_naie-network.RequestUtils.html index 06f7468..bf3cc29 100644 --- a/core/docs/interfaces/modules_network_naie-network.RequestUtils.html +++ b/docs/interfaces/modules_network_naie-network.RequestUtils.html @@ -1,6 +1,6 @@ RequestUtils | NAIE Core API v1.0.4

Utility functions for working with requests

-
interface RequestUtils {
    getFetchOptions: (
        request: Request,
    ) => {
        body: any;
        credentials: string;
        headers: Headers;
        method: string;
        timeout: number;
    };
}

Properties

interface RequestUtils {
    getFetchOptions: (
        request: Request,
    ) => {
        body: any;
        credentials: string;
        headers: Headers;
        method: string;
        timeout: number;
    };
}

Properties

Properties

getFetchOptions: (
    request: Request,
) => {
    body: any;
    credentials: string;
    headers: Headers;
    method: string;
    timeout: number;
}

Extracts fetch options from a request object

Type declaration

    • (
          request: Request,
      ): {
          body: any;
          credentials: string;
          headers: Headers;
          method: string;
          timeout: number;
      }
    • Parameters

      • request: Request

        The request to extract options from

      Returns {
          body: any;
          credentials: string;
          headers: Headers;
          method: string;
          timeout: number;
      }

      The fetch options

      -
+
diff --git a/core/docs/interfaces/modules_preflight_naie-preflight.NAIEPreflight.html b/docs/interfaces/modules_preflight_naie-preflight.NAIEPreflight.html similarity index 98% rename from core/docs/interfaces/modules_preflight_naie-preflight.NAIEPreflight.html rename to docs/interfaces/modules_preflight_naie-preflight.NAIEPreflight.html index a1d2d90..cf1bb95 100644 --- a/core/docs/interfaces/modules_preflight_naie-preflight.NAIEPreflight.html +++ b/docs/interfaces/modules_preflight_naie-preflight.NAIEPreflight.html @@ -1,9 +1,9 @@ NAIEPreflight | NAIE Core API v1.0.4

An interface defining functions for NAIE preflight

-
interface NAIEPreflight {
    registerHook(
        stage: PreflightStage,
        id: string,
        priority: number,
        callback: () => Promise<void>,
        timeout?: number,
    ): void;
}

Methods

interface NAIEPreflight {
    registerHook(
        stage: PreflightStage,
        id: string,
        priority: number,
        callback: () => Promise<void>,
        timeout?: number,
    ): void;
}

Methods

Methods

  • Register a hook to be run during preflight

    Parameters

    • stage: PreflightStage

      The stage to run this hook in ('early', 'main', 'late')

    • id: string

      Unique identifier for this hook

    • priority: number

      Higher priority hooks run first (default: 0)

    • callback: () => Promise<void>

      Async function to run

    • Optionaltimeout: number

      Maximum time in ms to wait (default: 10000)

      -

    Returns void

+

Returns void

diff --git a/core/docs/interfaces/modules_preflight_naie-preflight.PreflightError.html b/docs/interfaces/modules_preflight_naie-preflight.PreflightError.html similarity index 95% rename from core/docs/interfaces/modules_preflight_naie-preflight.PreflightError.html rename to docs/interfaces/modules_preflight_naie-preflight.PreflightError.html index f3e51d6..199f2f6 100644 --- a/core/docs/interfaces/modules_preflight_naie-preflight.PreflightError.html +++ b/docs/interfaces/modules_preflight_naie-preflight.PreflightError.html @@ -1,5 +1,5 @@ -PreflightError | NAIE Core API v1.0.4
interface PreflightError {
    error: Error;
    hookId: string;
    stage: PreflightStage;
    timeoutError?: boolean;
}

Properties

error +PreflightError | NAIE Core API v1.0.4
interface PreflightError {
    error: Error;
    hookId: string;
    stage: PreflightStage;
    timeoutError?: boolean;
}

Properties

error: Error
hookId: string
timeoutError?: boolean
+

Properties

error: Error
hookId: string
timeoutError?: boolean
diff --git a/core/docs/interfaces/modules_preflight_naie-preflight.PreflightHook.html b/docs/interfaces/modules_preflight_naie-preflight.PreflightHook.html similarity index 95% rename from core/docs/interfaces/modules_preflight_naie-preflight.PreflightHook.html rename to docs/interfaces/modules_preflight_naie-preflight.PreflightHook.html index 9c0e0fa..a1333d9 100644 --- a/core/docs/interfaces/modules_preflight_naie-preflight.PreflightHook.html +++ b/docs/interfaces/modules_preflight_naie-preflight.PreflightHook.html @@ -1,5 +1,5 @@ -PreflightHook | NAIE Core API v1.0.4
interface PreflightHook {
    callback: () => Promise<void>;
    id: string;
    priority: number;
    timeout: number;
}

Properties

callback +PreflightHook | NAIE Core API v1.0.4
interface PreflightHook {
    callback: () => Promise<void>;
    id: string;
    priority: number;
    timeout: number;
}

Properties

callback: () => Promise<void>
id: string
priority: number
timeout: number
+

Properties

callback: () => Promise<void>
id: string
priority: number
timeout: number
diff --git a/core/docs/interfaces/naie-core.NAIE.html b/docs/interfaces/naie-core.NAIE.html similarity index 94% rename from core/docs/interfaces/naie-core.NAIE.html rename to docs/interfaces/naie-core.NAIE.html index 8a4246e..e70271f 100644 --- a/core/docs/interfaces/naie-core.NAIE.html +++ b/docs/interfaces/naie-core.NAIE.html @@ -1,4 +1,4 @@ -NAIE | NAIE Core API v1.0.4
interface NAIE {
    CORE: NAIECore;
    DOM: DOMUtils;
    EXTENSIONS: NAIEExtensions;
    LOGGING: NAIELogging;
    MISC: MiscUtils;
    NAI: NAIUtils;
    NETWORK: NAIENetwork;
    PREFLIGHT: NAIEPreflight;
    SERVICES: NAIEServices;
}

Properties

CORE +NAIE | NAIE Core API v1.0.4
interface NAIE {
    CORE: NAIECore;
    DOM: DOMUtils;
    EXTENSIONS: NAIEExtensions;
    LOGGING: NAIELogging;
    MISC: MiscUtils;
    NAI: NAIUtils;
    NETWORK: NAIENetwork;
    PREFLIGHT: NAIEPreflight;
    SERVICES: NAIEServices;
}

Properties

Properties

CORE: NAIECore
EXTENSIONS: NAIEExtensions
LOGGING: NAIELogging
MISC: MiscUtils
NETWORK: NAIENetwork
PREFLIGHT: NAIEPreflight
SERVICES: NAIEServices
+

Properties

CORE: NAIECore
EXTENSIONS: NAIEExtensions
LOGGING: NAIELogging
MISC: MiscUtils
NETWORK: NAIENetwork
PREFLIGHT: NAIEPreflight
SERVICES: NAIEServices
diff --git a/core/docs/interfaces/naie-core.NAIEServices.html b/docs/interfaces/naie-core.NAIEServices.html similarity index 96% rename from core/docs/interfaces/naie-core.NAIEServices.html rename to docs/interfaces/naie-core.NAIEServices.html index 134e4fa..f3f3555 100644 --- a/core/docs/interfaces/naie-core.NAIEServices.html +++ b/docs/interfaces/naie-core.NAIEServices.html @@ -1,7 +1,7 @@ NAIEServices | NAIE Core API v1.0.4

Core services that are initialized and managed by NAIE These services are singletons that provide functionality across the application

-
interface NAIEServices {
    modalObserver: NAIEModalObserver;
    statusIndicator: NAIEStatusIndicator;
}

Properties

interface NAIEServices {
    modalObserver: NAIEModalObserver;
    statusIndicator: NAIEStatusIndicator;
}

Properties

modalObserver: NAIEModalObserver

Modal observer service for detecting and interacting with NAI modals

-
statusIndicator: NAIEStatusIndicator

Status indicator service for displaying messages and notifications

-
+
statusIndicator: NAIEStatusIndicator

Status indicator service for displaying messages and notifications

+
diff --git a/core/docs/interfaces/naie-core.Window.html b/docs/interfaces/naie-core.Window.html similarity index 99% rename from core/docs/interfaces/naie-core.Window.html rename to docs/interfaces/naie-core.Window.html index 8113d21..383a21f 100644 --- a/core/docs/interfaces/naie-core.Window.html +++ b/docs/interfaces/naie-core.Window.html @@ -1,6 +1,6 @@ Window | NAIE Core API v1.0.4

A window containing a DOM document; the document property points to the DOM document loaded in that window.

MDN Reference

-
interface Window {
    caches: CacheStorage;
    clientInformation: Navigator;
    closed: boolean;
    crossOriginIsolated: boolean;
    crypto: Crypto;
    customElements: CustomElementRegistry;
    devicePixelRatio: number;
    document: Document;
    event: undefined | Event;
    external: External;
    frameElement: null | Element;
    frames: Window;
    history: History;
    indexedDB: IDBFactory;
    innerHeight: number;
    innerWidth: number;
    isSecureContext: boolean;
    length: number;
    localStorage: Storage;
    locationbar: BarProp;
    menubar: BarProp;
    NAIE_INSTANCE: NAIE;
    name: string;
    navigator: Navigator;
    onabort: null | (this: GlobalEventHandlers, ev: UIEvent) => any;
    onafterprint: null | (this: WindowEventHandlers, ev: Event) => any;
    onanimationcancel:
        | null
        | (this: GlobalEventHandlers, ev: AnimationEvent) => any;
    onanimationend:
        | null
        | (this: GlobalEventHandlers, ev: AnimationEvent) => any;
    onanimationiteration:
        | null
        | (this: GlobalEventHandlers, ev: AnimationEvent) => any;
    onanimationstart:
        | null
        | (this: GlobalEventHandlers, ev: AnimationEvent) => any;
    onauxclick: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onbeforeinput: null | (this: GlobalEventHandlers, ev: InputEvent) => any;
    onbeforeprint: null | (this: WindowEventHandlers, ev: Event) => any;
    onbeforetoggle: null | (this: GlobalEventHandlers, ev: Event) => any;
    onbeforeunload:
        | null
        | (this: WindowEventHandlers, ev: BeforeUnloadEvent) => any;
    onblur: null | (this: GlobalEventHandlers, ev: FocusEvent) => any;
    oncancel: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncanplay: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncanplaythrough: null | (this: GlobalEventHandlers, ev: Event) => any;
    onchange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onclick: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onclose: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncontextlost: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncontextmenu: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    oncontextrestored: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncopy: null | (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
    oncuechange: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncut: null | (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
    ondblclick: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    ondevicemotion: null | (this: Window, ev: DeviceMotionEvent) => any;
    ondeviceorientation:
        | null
        | (this: Window, ev: DeviceOrientationEvent) => any;
    ondeviceorientationabsolute:
        | null
        | (this: Window, ev: DeviceOrientationEvent) => any;
    ondrag: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondragend: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondragenter: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondragleave: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondragover: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondragstart: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondrop: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondurationchange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onemptied: null | (this: GlobalEventHandlers, ev: Event) => any;
    onended: null | (this: GlobalEventHandlers, ev: Event) => any;
    onerror: OnErrorEventHandler;
    onfocus: null | (this: GlobalEventHandlers, ev: FocusEvent) => any;
    onformdata: null | (this: GlobalEventHandlers, ev: FormDataEvent) => any;
    ongamepadconnected:
        | null
        | (this: WindowEventHandlers, ev: GamepadEvent) => any;
    ongamepaddisconnected:
        | null
        | (this: WindowEventHandlers, ev: GamepadEvent) => any;
    ongotpointercapture:
        | null
        | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onhashchange:
        | null
        | (this: WindowEventHandlers, ev: HashChangeEvent) => any;
    oninput: null | (this: GlobalEventHandlers, ev: Event) => any;
    oninvalid: null | (this: GlobalEventHandlers, ev: Event) => any;
    onkeydown: null | (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
    onkeypress: null | (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
    onkeyup: null | (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
    onlanguagechange: null | (this: WindowEventHandlers, ev: Event) => any;
    onload: null | (this: GlobalEventHandlers, ev: Event) => any;
    onloadeddata: null | (this: GlobalEventHandlers, ev: Event) => any;
    onloadedmetadata: null | (this: GlobalEventHandlers, ev: Event) => any;
    onloadstart: null | (this: GlobalEventHandlers, ev: Event) => any;
    onlostpointercapture:
        | null
        | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onmessage: null | (this: WindowEventHandlers, ev: MessageEvent) => any;
    onmessageerror: null | (this: WindowEventHandlers, ev: MessageEvent) => any;
    onmousedown: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmouseenter: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmouseleave: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmousemove: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmouseout: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmouseover: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmouseup: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onoffline: null | (this: WindowEventHandlers, ev: Event) => any;
    ononline: null | (this: WindowEventHandlers, ev: Event) => any;
    onorientationchange: null | (this: Window, ev: Event) => any;
    onpagehide:
        | null
        | (this: WindowEventHandlers, ev: PageTransitionEvent) => any;
    onpageshow:
        | null
        | (this: WindowEventHandlers, ev: PageTransitionEvent) => any;
    onpaste: null | (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
    onpause: null | (this: GlobalEventHandlers, ev: Event) => any;
    onplay: null | (this: GlobalEventHandlers, ev: Event) => any;
    onplaying: null | (this: GlobalEventHandlers, ev: Event) => any;
    onpointercancel:
        | null
        | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerdown: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerenter: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerleave: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointermove: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerout: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerover: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerup: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpopstate: null | (this: WindowEventHandlers, ev: PopStateEvent) => any;
    onprogress: null | (this: GlobalEventHandlers, ev: ProgressEvent) => any;
    onratechange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onrejectionhandled:
        | null
        | (this: WindowEventHandlers, ev: PromiseRejectionEvent) => any;
    onreset: null | (this: GlobalEventHandlers, ev: Event) => any;
    onresize: null | (this: GlobalEventHandlers, ev: UIEvent) => any;
    onscroll: null | (this: GlobalEventHandlers, ev: Event) => any;
    onscrollend: null | (this: GlobalEventHandlers, ev: Event) => any;
    onsecuritypolicyviolation:
        | null
        | (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
    onseeked: null | (this: GlobalEventHandlers, ev: Event) => any;
    onseeking: null | (this: GlobalEventHandlers, ev: Event) => any;
    onselect: null | (this: GlobalEventHandlers, ev: Event) => any;
    onselectionchange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onselectstart: null | (this: GlobalEventHandlers, ev: Event) => any;
    onslotchange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onstalled: null | (this: GlobalEventHandlers, ev: Event) => any;
    onstorage: null | (this: WindowEventHandlers, ev: StorageEvent) => any;
    onsubmit: null | (this: GlobalEventHandlers, ev: SubmitEvent) => any;
    onsuspend: null | (this: GlobalEventHandlers, ev: Event) => any;
    ontimeupdate: null | (this: GlobalEventHandlers, ev: Event) => any;
    ontoggle: null | (this: GlobalEventHandlers, ev: Event) => any;
    ontouchcancel?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any;
    ontouchend?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any;
    ontouchmove?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any;
    ontouchstart?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any;
    ontransitioncancel:
        | null
        | (this: GlobalEventHandlers, ev: TransitionEvent) => any;
    ontransitionend:
        | null
        | (this: GlobalEventHandlers, ev: TransitionEvent) => any;
    ontransitionrun:
        | null
        | (this: GlobalEventHandlers, ev: TransitionEvent) => any;
    ontransitionstart:
        | null
        | (this: GlobalEventHandlers, ev: TransitionEvent) => any;
    onunhandledrejection:
        | null
        | (this: WindowEventHandlers, ev: PromiseRejectionEvent) => any;
    onunload: null | (this: WindowEventHandlers, ev: Event) => any;
    onvolumechange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onwaiting: null | (this: GlobalEventHandlers, ev: Event) => any;
    onwebkitanimationend: null | (this: GlobalEventHandlers, ev: Event) => any;
    onwebkitanimationiteration:
        | null
        | (this: GlobalEventHandlers, ev: Event) => any;
    onwebkitanimationstart:
        | null
        | (this: GlobalEventHandlers, ev: Event) => any;
    onwebkittransitionend: null | (this: GlobalEventHandlers, ev: Event) => any;
    onwheel: null | (this: GlobalEventHandlers, ev: WheelEvent) => any;
    opener: any;
    orientation: number;
    origin: string;
    outerHeight: number;
    outerWidth: number;
    pageXOffset: number;
    pageYOffset: number;
    parent: Window;
    performance: Performance;
    personalbar: BarProp;
    screen: Screen;
    screenLeft: number;
    screenTop: number;
    screenX: number;
    screenY: number;
    scrollbars: BarProp;
    scrollX: number;
    scrollY: number;
    self: Window & typeof globalThis;
    sessionStorage: Storage;
    speechSynthesis: SpeechSynthesis;
    status: string;
    statusbar: BarProp;
    toolbar: BarProp;
    top: null | Window;
    visualViewport: null | VisualViewport;
    window: Window & typeof globalThis;
    get location(): Location;
    set location(href: string | Location): void;
    addEventListener<K extends keyof WindowEventMap>(
        type: K,
        listener: (this: Window, ev: WindowEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    alert(message?: any): void;
    atob(data: string): string;
    blur(): void;
    btoa(data: string): string;
    cancelAnimationFrame(handle: number): void;
    cancelIdleCallback(handle: number): void;
    captureEvents(): void;
    clearInterval(id: undefined | number): void;
    clearTimeout(id: undefined | number): void;
    close(): void;
    confirm(message?: string): boolean;
    createImageBitmap(
        image: ImageBitmapSource,
        options?: ImageBitmapOptions,
    ): Promise<ImageBitmap>;
    createImageBitmap(
        image: ImageBitmapSource,
        sx: number,
        sy: number,
        sw: number,
        sh: number,
        options?: ImageBitmapOptions,
    ): Promise<ImageBitmap>;
    dispatchEvent(event: Event): boolean;
    fetch(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
    focus(): void;
    getComputedStyle(
        elt: Element,
        pseudoElt?: null | string,
    ): CSSStyleDeclaration;
    getSelection(): null | Selection;
    matchMedia(query: string): MediaQueryList;
    moveBy(x: number, y: number): void;
    moveTo(x: number, y: number): void;
    open(url?: string | URL, target?: string, features?: string): null | Window;
    postMessage(
        message: any,
        targetOrigin: string,
        transfer?: Transferable[],
    ): void;
    postMessage(message: any, options?: WindowPostMessageOptions): void;
    print(): void;
    prompt(message?: string, _default?: string): null | string;
    queueMicrotask(callback: VoidFunction): void;
    releaseEvents(): void;
    removeEventListener<K extends keyof WindowEventMap>(
        type: K,
        listener: (this: Window, ev: WindowEventMap[K]) => any,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
    reportError(e: any): void;
    requestAnimationFrame(callback: FrameRequestCallback): number;
    requestIdleCallback(
        callback: IdleRequestCallback,
        options?: IdleRequestOptions,
    ): number;
    resizeBy(x: number, y: number): void;
    resizeTo(width: number, height: number): void;
    scroll(options?: ScrollToOptions): void;
    scroll(x: number, y: number): void;
    scrollBy(options?: ScrollToOptions): void;
    scrollBy(x: number, y: number): void;
    scrollTo(options?: ScrollToOptions): void;
    scrollTo(x: number, y: number): void;
    setInterval(
        handler: TimerHandler,
        timeout?: number,
        ...arguments: any[],
    ): number;
    setTimeout(
        handler: TimerHandler,
        timeout?: number,
        ...arguments: any[],
    ): number;
    stop(): void;
    structuredClone<T = any>(value: T, options?: StructuredSerializeOptions): T;
    [index: number]: Window;
}

Hierarchy

  • EventTarget
  • AnimationFrameProvider
  • GlobalEventHandlers
  • WindowEventHandlers
  • WindowLocalStorage
  • WindowOrWorkerGlobalScope
  • WindowSessionStorage
    • Window

Indexable

Properties

interface Window {
    caches: CacheStorage;
    clientInformation: Navigator;
    closed: boolean;
    crossOriginIsolated: boolean;
    crypto: Crypto;
    customElements: CustomElementRegistry;
    devicePixelRatio: number;
    document: Document;
    event: undefined | Event;
    external: External;
    frameElement: null | Element;
    frames: Window;
    history: History;
    indexedDB: IDBFactory;
    innerHeight: number;
    innerWidth: number;
    isSecureContext: boolean;
    length: number;
    localStorage: Storage;
    locationbar: BarProp;
    menubar: BarProp;
    NAIE_INSTANCE: NAIE;
    name: string;
    navigator: Navigator;
    onabort: null | (this: GlobalEventHandlers, ev: UIEvent) => any;
    onafterprint: null | (this: WindowEventHandlers, ev: Event) => any;
    onanimationcancel:
        | null
        | (this: GlobalEventHandlers, ev: AnimationEvent) => any;
    onanimationend:
        | null
        | (this: GlobalEventHandlers, ev: AnimationEvent) => any;
    onanimationiteration:
        | null
        | (this: GlobalEventHandlers, ev: AnimationEvent) => any;
    onanimationstart:
        | null
        | (this: GlobalEventHandlers, ev: AnimationEvent) => any;
    onauxclick: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onbeforeinput: null | (this: GlobalEventHandlers, ev: InputEvent) => any;
    onbeforeprint: null | (this: WindowEventHandlers, ev: Event) => any;
    onbeforetoggle: null | (this: GlobalEventHandlers, ev: Event) => any;
    onbeforeunload:
        | null
        | (this: WindowEventHandlers, ev: BeforeUnloadEvent) => any;
    onblur: null | (this: GlobalEventHandlers, ev: FocusEvent) => any;
    oncancel: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncanplay: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncanplaythrough: null | (this: GlobalEventHandlers, ev: Event) => any;
    onchange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onclick: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onclose: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncontextlost: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncontextmenu: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    oncontextrestored: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncopy: null | (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
    oncuechange: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncut: null | (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
    ondblclick: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    ondevicemotion: null | (this: Window, ev: DeviceMotionEvent) => any;
    ondeviceorientation:
        | null
        | (this: Window, ev: DeviceOrientationEvent) => any;
    ondeviceorientationabsolute:
        | null
        | (this: Window, ev: DeviceOrientationEvent) => any;
    ondrag: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondragend: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondragenter: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondragleave: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondragover: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondragstart: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondrop: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondurationchange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onemptied: null | (this: GlobalEventHandlers, ev: Event) => any;
    onended: null | (this: GlobalEventHandlers, ev: Event) => any;
    onerror: OnErrorEventHandler;
    onfocus: null | (this: GlobalEventHandlers, ev: FocusEvent) => any;
    onformdata: null | (this: GlobalEventHandlers, ev: FormDataEvent) => any;
    ongamepadconnected:
        | null
        | (this: WindowEventHandlers, ev: GamepadEvent) => any;
    ongamepaddisconnected:
        | null
        | (this: WindowEventHandlers, ev: GamepadEvent) => any;
    ongotpointercapture:
        | null
        | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onhashchange:
        | null
        | (this: WindowEventHandlers, ev: HashChangeEvent) => any;
    oninput: null | (this: GlobalEventHandlers, ev: Event) => any;
    oninvalid: null | (this: GlobalEventHandlers, ev: Event) => any;
    onkeydown: null | (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
    onkeypress: null | (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
    onkeyup: null | (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
    onlanguagechange: null | (this: WindowEventHandlers, ev: Event) => any;
    onload: null | (this: GlobalEventHandlers, ev: Event) => any;
    onloadeddata: null | (this: GlobalEventHandlers, ev: Event) => any;
    onloadedmetadata: null | (this: GlobalEventHandlers, ev: Event) => any;
    onloadstart: null | (this: GlobalEventHandlers, ev: Event) => any;
    onlostpointercapture:
        | null
        | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onmessage: null | (this: WindowEventHandlers, ev: MessageEvent) => any;
    onmessageerror: null | (this: WindowEventHandlers, ev: MessageEvent) => any;
    onmousedown: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmouseenter: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmouseleave: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmousemove: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmouseout: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmouseover: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmouseup: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onoffline: null | (this: WindowEventHandlers, ev: Event) => any;
    ononline: null | (this: WindowEventHandlers, ev: Event) => any;
    onorientationchange: null | (this: Window, ev: Event) => any;
    onpagehide:
        | null
        | (this: WindowEventHandlers, ev: PageTransitionEvent) => any;
    onpageshow:
        | null
        | (this: WindowEventHandlers, ev: PageTransitionEvent) => any;
    onpaste: null | (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
    onpause: null | (this: GlobalEventHandlers, ev: Event) => any;
    onplay: null | (this: GlobalEventHandlers, ev: Event) => any;
    onplaying: null | (this: GlobalEventHandlers, ev: Event) => any;
    onpointercancel:
        | null
        | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerdown: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerenter: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerleave: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointermove: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerout: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerover: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerup: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpopstate: null | (this: WindowEventHandlers, ev: PopStateEvent) => any;
    onprogress: null | (this: GlobalEventHandlers, ev: ProgressEvent) => any;
    onratechange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onrejectionhandled:
        | null
        | (this: WindowEventHandlers, ev: PromiseRejectionEvent) => any;
    onreset: null | (this: GlobalEventHandlers, ev: Event) => any;
    onresize: null | (this: GlobalEventHandlers, ev: UIEvent) => any;
    onscroll: null | (this: GlobalEventHandlers, ev: Event) => any;
    onscrollend: null | (this: GlobalEventHandlers, ev: Event) => any;
    onsecuritypolicyviolation:
        | null
        | (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
    onseeked: null | (this: GlobalEventHandlers, ev: Event) => any;
    onseeking: null | (this: GlobalEventHandlers, ev: Event) => any;
    onselect: null | (this: GlobalEventHandlers, ev: Event) => any;
    onselectionchange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onselectstart: null | (this: GlobalEventHandlers, ev: Event) => any;
    onslotchange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onstalled: null | (this: GlobalEventHandlers, ev: Event) => any;
    onstorage: null | (this: WindowEventHandlers, ev: StorageEvent) => any;
    onsubmit: null | (this: GlobalEventHandlers, ev: SubmitEvent) => any;
    onsuspend: null | (this: GlobalEventHandlers, ev: Event) => any;
    ontimeupdate: null | (this: GlobalEventHandlers, ev: Event) => any;
    ontoggle: null | (this: GlobalEventHandlers, ev: Event) => any;
    ontouchcancel?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any;
    ontouchend?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any;
    ontouchmove?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any;
    ontouchstart?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any;
    ontransitioncancel:
        | null
        | (this: GlobalEventHandlers, ev: TransitionEvent) => any;
    ontransitionend:
        | null
        | (this: GlobalEventHandlers, ev: TransitionEvent) => any;
    ontransitionrun:
        | null
        | (this: GlobalEventHandlers, ev: TransitionEvent) => any;
    ontransitionstart:
        | null
        | (this: GlobalEventHandlers, ev: TransitionEvent) => any;
    onunhandledrejection:
        | null
        | (this: WindowEventHandlers, ev: PromiseRejectionEvent) => any;
    onunload: null | (this: WindowEventHandlers, ev: Event) => any;
    onvolumechange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onwaiting: null | (this: GlobalEventHandlers, ev: Event) => any;
    onwebkitanimationend: null | (this: GlobalEventHandlers, ev: Event) => any;
    onwebkitanimationiteration:
        | null
        | (this: GlobalEventHandlers, ev: Event) => any;
    onwebkitanimationstart:
        | null
        | (this: GlobalEventHandlers, ev: Event) => any;
    onwebkittransitionend: null | (this: GlobalEventHandlers, ev: Event) => any;
    onwheel: null | (this: GlobalEventHandlers, ev: WheelEvent) => any;
    opener: any;
    orientation: number;
    origin: string;
    outerHeight: number;
    outerWidth: number;
    pageXOffset: number;
    pageYOffset: number;
    parent: Window;
    performance: Performance;
    personalbar: BarProp;
    screen: Screen;
    screenLeft: number;
    screenTop: number;
    screenX: number;
    screenY: number;
    scrollbars: BarProp;
    scrollX: number;
    scrollY: number;
    self: Window & typeof globalThis;
    sessionStorage: Storage;
    speechSynthesis: SpeechSynthesis;
    status: string;
    statusbar: BarProp;
    toolbar: BarProp;
    top: null | Window;
    visualViewport: null | VisualViewport;
    window: Window & typeof globalThis;
    get location(): Location;
    set location(href: string | Location): void;
    addEventListener<K extends keyof WindowEventMap>(
        type: K,
        listener: (this: Window, ev: WindowEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    alert(message?: any): void;
    atob(data: string): string;
    blur(): void;
    btoa(data: string): string;
    cancelAnimationFrame(handle: number): void;
    cancelIdleCallback(handle: number): void;
    captureEvents(): void;
    clearInterval(id: undefined | number): void;
    clearTimeout(id: undefined | number): void;
    close(): void;
    confirm(message?: string): boolean;
    createImageBitmap(
        image: ImageBitmapSource,
        options?: ImageBitmapOptions,
    ): Promise<ImageBitmap>;
    createImageBitmap(
        image: ImageBitmapSource,
        sx: number,
        sy: number,
        sw: number,
        sh: number,
        options?: ImageBitmapOptions,
    ): Promise<ImageBitmap>;
    dispatchEvent(event: Event): boolean;
    fetch(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
    focus(): void;
    getComputedStyle(
        elt: Element,
        pseudoElt?: null | string,
    ): CSSStyleDeclaration;
    getSelection(): null | Selection;
    matchMedia(query: string): MediaQueryList;
    moveBy(x: number, y: number): void;
    moveTo(x: number, y: number): void;
    open(url?: string | URL, target?: string, features?: string): null | Window;
    postMessage(
        message: any,
        targetOrigin: string,
        transfer?: Transferable[],
    ): void;
    postMessage(message: any, options?: WindowPostMessageOptions): void;
    print(): void;
    prompt(message?: string, _default?: string): null | string;
    queueMicrotask(callback: VoidFunction): void;
    releaseEvents(): void;
    removeEventListener<K extends keyof WindowEventMap>(
        type: K,
        listener: (this: Window, ev: WindowEventMap[K]) => any,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
    reportError(e: any): void;
    requestAnimationFrame(callback: FrameRequestCallback): number;
    requestIdleCallback(
        callback: IdleRequestCallback,
        options?: IdleRequestOptions,
    ): number;
    resizeBy(x: number, y: number): void;
    resizeTo(width: number, height: number): void;
    scroll(options?: ScrollToOptions): void;
    scroll(x: number, y: number): void;
    scrollBy(options?: ScrollToOptions): void;
    scrollBy(x: number, y: number): void;
    scrollTo(options?: ScrollToOptions): void;
    scrollTo(x: number, y: number): void;
    setInterval(
        handler: TimerHandler,
        timeout?: number,
        ...arguments: any[],
    ): number;
    setTimeout(
        handler: TimerHandler,
        timeout?: number,
        ...arguments: any[],
    ): number;
    stop(): void;
    structuredClone<T = any>(value: T, options?: StructuredSerializeOptions): T;
    [index: number]: Window;
}

Hierarchy

  • EventTarget
  • AnimationFrameProvider
  • GlobalEventHandlers
  • WindowEventHandlers
  • WindowLocalStorage
  • WindowOrWorkerGlobalScope
  • WindowSessionStorage
    • Window

Indexable

Properties

menubar: BarProp

Returns true if the menu bar is visible; otherwise, returns false.

MDN Reference

-
NAIE_INSTANCE: NAIE
name: string
NAIE_INSTANCE: NAIE
name: string
navigator: Navigator
onabort: null | (this: GlobalEventHandlers, ev: UIEvent) => any

Fires when the user aborts the download.

The event.

diff --git a/core/docs/media/LICENSE b/docs/media/LICENSE similarity index 100% rename from core/docs/media/LICENSE rename to docs/media/LICENSE diff --git a/core/docs/modules.html b/docs/modules.html similarity index 100% rename from core/docs/modules.html rename to docs/modules.html diff --git a/core/docs/modules/modules_dom_naie-dom.html b/docs/modules/modules_dom_naie-dom.html similarity index 100% rename from core/docs/modules/modules_dom_naie-dom.html rename to docs/modules/modules_dom_naie-dom.html diff --git a/core/docs/modules/modules_extensions_controls_naie-controls.html b/docs/modules/modules_extensions_controls_naie-controls.html similarity index 100% rename from core/docs/modules/modules_extensions_controls_naie-controls.html rename to docs/modules/modules_extensions_controls_naie-controls.html diff --git a/core/docs/modules/modules_extensions_indicator_naie-indicator-utils.html b/docs/modules/modules_extensions_indicator_naie-indicator-utils.html similarity index 100% rename from core/docs/modules/modules_extensions_indicator_naie-indicator-utils.html rename to docs/modules/modules_extensions_indicator_naie-indicator-utils.html diff --git a/core/docs/modules/modules_extensions_loaders_naie-loader.html b/docs/modules/modules_extensions_loaders_naie-loader.html similarity index 100% rename from core/docs/modules/modules_extensions_loaders_naie-loader.html rename to docs/modules/modules_extensions_loaders_naie-loader.html diff --git a/core/docs/modules/modules_extensions_naie-extensions.html b/docs/modules/modules_extensions_naie-extensions.html similarity index 100% rename from core/docs/modules/modules_extensions_naie-extensions.html rename to docs/modules/modules_extensions_naie-extensions.html diff --git a/core/docs/modules/modules_internal_naie-internal.html b/docs/modules/modules_internal_naie-internal.html similarity index 100% rename from core/docs/modules/modules_internal_naie-internal.html rename to docs/modules/modules_internal_naie-internal.html diff --git a/core/docs/modules/modules_logging_naie-logging.html b/docs/modules/modules_logging_naie-logging.html similarity index 100% rename from core/docs/modules/modules_logging_naie-logging.html rename to docs/modules/modules_logging_naie-logging.html diff --git a/core/docs/modules/modules_misc_naie-misc.html b/docs/modules/modules_misc_naie-misc.html similarity index 100% rename from core/docs/modules/modules_misc_naie-misc.html rename to docs/modules/modules_misc_naie-misc.html diff --git a/core/docs/modules/modules_nai_modals_naie-modal.html b/docs/modules/modules_nai_modals_naie-modal.html similarity index 100% rename from core/docs/modules/modules_nai_modals_naie-modal.html rename to docs/modules/modules_nai_modals_naie-modal.html diff --git a/core/docs/modules/modules_nai_naie-nai.html b/docs/modules/modules_nai_naie-nai.html similarity index 100% rename from core/docs/modules/modules_nai_naie-nai.html rename to docs/modules/modules_nai_naie-nai.html diff --git a/core/docs/modules/modules_network_naie-network.html b/docs/modules/modules_network_naie-network.html similarity index 100% rename from core/docs/modules/modules_network_naie-network.html rename to docs/modules/modules_network_naie-network.html diff --git a/core/docs/modules/modules_preflight_naie-preflight.html b/docs/modules/modules_preflight_naie-preflight.html similarity index 100% rename from core/docs/modules/modules_preflight_naie-preflight.html rename to docs/modules/modules_preflight_naie-preflight.html diff --git a/core/docs/modules/naie-core.html b/docs/modules/naie-core.html similarity index 100% rename from core/docs/modules/naie-core.html rename to docs/modules/naie-core.html diff --git a/core/docs/types/modules_logging_naie-logging.LogLevel.html b/docs/types/modules_logging_naie-logging.LogLevel.html similarity index 97% rename from core/docs/types/modules_logging_naie-logging.LogLevel.html rename to docs/types/modules_logging_naie-logging.LogLevel.html index 23d3efe..8d8da28 100644 --- a/core/docs/types/modules_logging_naie-logging.LogLevel.html +++ b/docs/types/modules_logging_naie-logging.LogLevel.html @@ -1,2 +1,2 @@ LogLevel | NAIE Core API v1.0.4
LogLevel: "none" | "debug" | "info" | "warn" | "error"

Available log levels in order of verbosity

-
+
diff --git a/core/docs/types/modules_logging_naie-logging.LogMethod.html b/docs/types/modules_logging_naie-logging.LogMethod.html similarity index 98% rename from core/docs/types/modules_logging_naie-logging.LogMethod.html rename to docs/types/modules_logging_naie-logging.LogMethod.html index e73cd47..0f70a4e 100644 --- a/core/docs/types/modules_logging_naie-logging.LogMethod.html +++ b/docs/types/modules_logging_naie-logging.LogMethod.html @@ -1,2 +1,2 @@ LogMethod | NAIE Core API v1.0.4
LogMethod: { (message: string): void; (message: string, ...args: any[]): void }

Function signature for log methods

-

Type declaration

    • (message: string): void
    • Parameters

      • message: string

      Returns void

    • (message: string, ...args: any[]): void
    • Parameters

      • message: string
      • ...args: any[]

      Returns void

+

Type declaration

    • (message: string): void
    • Parameters

      • message: string

      Returns void

    • (message: string, ...args: any[]): void
    • Parameters

      • message: string
      • ...args: any[]

      Returns void

diff --git a/core/docs/types/modules_nai_modals_naie-modal.ModalEventHandler.html b/docs/types/modules_nai_modals_naie-modal.ModalEventHandler.html similarity index 98% rename from core/docs/types/modules_nai_modals_naie-modal.ModalEventHandler.html rename to docs/types/modules_nai_modals_naie-modal.ModalEventHandler.html index cc9be31..9f7dddd 100644 --- a/core/docs/types/modules_nai_modals_naie-modal.ModalEventHandler.html +++ b/docs/types/modules_nai_modals_naie-modal.ModalEventHandler.html @@ -1,2 +1,2 @@ ModalEventHandler | NAIE Core API v1.0.4
ModalEventHandler: (modal: NAIEModal) => void

Event handler for modal events

-

Type declaration

+

Type declaration

diff --git a/core/docs/types/modules_nai_modals_naie-modal.ModalPredicate.html b/docs/types/modules_nai_modals_naie-modal.ModalPredicate.html similarity index 98% rename from core/docs/types/modules_nai_modals_naie-modal.ModalPredicate.html rename to docs/types/modules_nai_modals_naie-modal.ModalPredicate.html index e28458a..df98e38 100644 --- a/core/docs/types/modules_nai_modals_naie-modal.ModalPredicate.html +++ b/docs/types/modules_nai_modals_naie-modal.ModalPredicate.html @@ -1,2 +1,2 @@ ModalPredicate | NAIE Core API v1.0.4
ModalPredicate: (modal: NAIEModal) => boolean

Function that determines if a modal matches specific criteria

-

Type declaration

+

Type declaration

diff --git a/core/docs/types/modules_preflight_naie-preflight.PreflightStage.html b/docs/types/modules_preflight_naie-preflight.PreflightStage.html similarity index 98% rename from core/docs/types/modules_preflight_naie-preflight.PreflightStage.html rename to docs/types/modules_preflight_naie-preflight.PreflightStage.html index d618d6e..b015abc 100644 --- a/core/docs/types/modules_preflight_naie-preflight.PreflightStage.html +++ b/docs/types/modules_preflight_naie-preflight.PreflightStage.html @@ -1 +1 @@ -PreflightStage | NAIE Core API v1.0.4
PreflightStage: "early" | "main" | "late"
+PreflightStage | NAIE Core API v1.0.4
PreflightStage: "early" | "main" | "late"
diff --git a/core/docs/variables/naie-core.Window-1.html b/docs/variables/naie-core.Window-1.html similarity index 98% rename from core/docs/variables/naie-core.Window-1.html rename to docs/variables/naie-core.Window-1.html index 1e8d3bd..a5ad1ce 100644 --- a/core/docs/variables/naie-core.Window-1.html +++ b/docs/variables/naie-core.Window-1.html @@ -1 +1 @@ -Window | NAIE Core API v1.0.4
Window: { prototype: Window; new (): Window }

Type declaration

+Window | NAIE Core API v1.0.4
Window: { prototype: Window; new (): Window }

Type declaration