@fivem-nui/svelte 0.0.0-stage → 1.0.0

package/dist/runes/window.svelte.js

@@ -0,0 +1,196 @@
+import { onDestroy } from 'svelte';
+import { globalErrorHandler } from '@fivem-nui/error';
+import { useNuiClient } from '../context';
+/**
+ * Window lifecycle actions dispatched from C# backend to NUI UI.
+ */
+export var NuiWindowActionType;
+(function (NuiWindowActionType) {
+    NuiWindowActionType["Open"] = "open";
+    NuiWindowActionType["Close"] = "close";
+    NuiWindowActionType["Focus"] = "focus";
+    NuiWindowActionType["Unfocus"] = "unfocus";
+})(NuiWindowActionType || (NuiWindowActionType = {}));
+/**
+ * Window lifecycle notifications dispatched from UI to C# backend.
+ */
+export var NuiWindowNotification;
+(function (NuiWindowNotification) {
+    NuiWindowNotification["Ready"] = "ready";
+    NuiWindowNotification["Close"] = "close";
+})(NuiWindowNotification || (NuiWindowNotification = {}));
+function safeCallback(operation, callback, ...args) {
+    if (!callback)
+        return;
+    try {
+        callback(...args);
+    }
+    catch (error) {
+        void globalErrorHandler
+            .handle(error instanceof Error ? error : new Error(String(error)), { args }, operation)
+            .catch(() => { });
+        console.error(error);
+    }
+}
+/**
+ * Controller managing reactive visibility, focus, and backend events for a named NUI window.
+ */
+export class NuiWindowController {
+    windowName;
+    options;
+    client;
+    visible = $state(false);
+    focused = $state(false);
+    destroyed = false;
+    listeningForEscape = false;
+    unsubscribe;
+    constructor(windowName, options = {}, client) {
+        this.windowName = windowName;
+        this.options = options;
+        this.client = client;
+        this.visible = options.initialVisible ?? false;
+        this.unsubscribe = client.onWindow(this.handleWindowAction);
+        if (this.visible) {
+            this.syncEscapeListener(true);
+        }
+    }
+    syncEscapeListener(shouldListen) {
+        if (typeof window === 'undefined' || this.options.closeOnEscape === false)
+            return;
+        if (this.listeningForEscape === shouldListen)
+            return;
+        if (shouldListen) {
+            window.addEventListener('keydown', this.handleEscape);
+        }
+        else {
+            window.removeEventListener('keydown', this.handleEscape);
+        }
+        this.listeningForEscape = shouldListen;
+    }
+    handleEscape = (event) => {
+        if (event.key !== 'Escape' || !this.visible || this.destroyed)
+            return;
+        event.preventDefault();
+        this.close();
+    };
+    transition(nextVisible, nextFocused) {
+        const changes = {
+            visibility: nextVisible !== undefined && this.visible !== nextVisible,
+            focus: nextFocused !== undefined && this.focused !== nextFocused
+        };
+        if (nextVisible !== undefined && changes.visibility) {
+            this.visible = nextVisible;
+            this.syncEscapeListener(nextVisible);
+        }
+        if (nextFocused !== undefined && changes.focus) {
+            this.focused = nextFocused;
+        }
+        return changes;
+    }
+    notifyAndDispatch(changes, notification) {
+        if (notification && (changes.visibility || changes.focus)) {
+            try {
+                this.client.notify(notification, { window: this.windowName });
+            }
+            catch (error) {
+                void globalErrorHandler
+                    .handle(error instanceof Error ? error : new Error(String(error)), { window: this.windowName, notification }, 'useNuiWindow:notify')
+                    .catch(() => { });
+                console.error('[NuiWindow] Failed to dispatch notify to backend:', error);
+            }
+        }
+        if (changes.visibility) {
+            safeCallback('useNuiWindow:visibility', this.visible ? this.options.onOpen : this.options.onClose);
+        }
+        if (changes.focus) {
+            safeCallback('useNuiWindow:focus', this.options.onFocusChange, this.focused);
+        }
+    }
+    open = () => {
+        if (this.destroyed)
+            return;
+        const changes = this.transition(true, true);
+        this.notifyAndDispatch(changes, NuiWindowNotification.Ready);
+    };
+    close = () => {
+        if (this.destroyed)
+            return;
+        const changes = this.transition(false, false);
+        this.notifyAndDispatch(changes, NuiWindowNotification.Close);
+    };
+    toggle = () => {
+        if (this.destroyed)
+            return;
+        if (this.visible)
+            this.close();
+        else
+            this.open();
+    };
+    handleWindowAction = (action, targetWindow) => {
+        if (this.destroyed || (targetWindow && targetWindow !== this.windowName)) {
+            return;
+        }
+        switch (action) {
+            case NuiWindowActionType.Open:
+                this.notifyAndDispatch(this.transition(true, true));
+                break;
+            case NuiWindowActionType.Close:
+                this.notifyAndDispatch(this.transition(false, false));
+                break;
+            case NuiWindowActionType.Focus:
+                if (this.visible) {
+                    this.notifyAndDispatch(this.transition(undefined, true));
+                }
+                break;
+            case NuiWindowActionType.Unfocus:
+                this.notifyAndDispatch(this.transition(undefined, false));
+                break;
+        }
+    };
+    destroy = () => {
+        if (this.destroyed)
+            return;
+        this.destroyed = true;
+        this.syncEscapeListener(false);
+        this.unsubscribe();
+    };
+}
+/**
+ * Reactive controller for a named NUI window.
+ * Synchronizes visibility and focus states with the FiveM C# backend.
+ *
+ * @param windowName - Window identifier matching backend events.
+ * @param options - Optional configuration (callbacks, Escape handling).
+ *
+ * @example
+ * ```svelte
+ * <script>
+ *   import { useNuiWindow } from '@fivem-nui/svelte';
+ *
+ *   const win = useNuiWindow('inventory', { closeOnEscape: true });
+ * </script>
+ *
+ * {#if win.visible}
+ *   <div class="panel">
+ *     <button onclick={() => win.close()}>Close</button>
+ *   </div>
+ * {/if}
+ * ```
+ */
+export function useNuiWindow(windowName, options = {}) {
+    const client = options.client ?? useNuiClient();
+    const controller = new NuiWindowController(windowName, options, client);
+    if (options.autoDestroy !== false) {
+        try {
+            onDestroy(controller.destroy);
+        }
+        catch (error) {
+            if (options.autoDestroy === true) {
+                controller.destroy();
+                throw error;
+            }
+        }
+    }
+    return controller;
+}
+//# sourceMappingURL=window.svelte.js.map

package/dist/runes/window.svelte.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"window.svelte.js","sourceRoot":"","sources":["../../src/runes/window.svelte.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAEnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C;;GAEG;AACH,MAAM,CAAN,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,oCAAa,CAAA;IACb,sCAAe,CAAA;IACf,sCAAe,CAAA;IACf,0CAAmB,CAAA;AACrB,CAAC,EALW,mBAAmB,KAAnB,mBAAmB,QAK9B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC/B,wCAAe,CAAA;IACf,wCAAe,CAAA;AACjB,CAAC,EAHW,qBAAqB,KAArB,qBAAqB,QAGhC;AAuED,SAAS,YAAY,CACnB,SAAiB,EACjB,QAAgD,EAChD,GAAG,IAAW;IAEd,IAAI,CAAC,QAAQ;QAAE,OAAO;IAEtB,IAAI,CAAC;QACH,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,KAAK,kBAAkB;aACpB,MAAM,CACL,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EACzD,EAAE,IAAI,EAAE,EACR,SAAS,CACV;aACA,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACnB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,mBAAmB;IASX,UAAU;IACV,OAAO;IACP,MAAM;IAVzB,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACxB,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAEhB,SAAS,GAAG,KAAK,CAAC;IAClB,kBAAkB,GAAG,KAAK,CAAC;IAClB,WAAW,CAAa;IAEzC,YACmB,UAAkB,EAClB,OAAO,GAAqB,EAAE,EAC9B,MAAuB;0BAFvB,UAAU;uBACV,OAAO;sBACP,MAAM;QAEvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,cAAc,IAAI,KAAK,CAAC;QAC/C,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAE5D,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAEO,kBAAkB,CAAC,YAAqB;QAC9C,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,KAAK;YAAE,OAAO;QAClF,IAAI,IAAI,CAAC,kBAAkB,KAAK,YAAY;YAAE,OAAO;QAErD,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC;IACzC,CAAC;IAEO,YAAY,GAAG,CAAC,KAAoB,EAAQ,EAAE;QACpD,IAAI,KAAK,CAAC,GAAG,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAEtE,KAAK,CAAC,cAAc,EAAE,CAAC;QACvB,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC,CAAC;IAEM,UAAU,CAChB,WAAqB,EACrB,WAAqB;QAErB,MAAM,OAAO,GAAG;YACd,UAAU,EAAE,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,WAAW;YACrE,KAAK,EAAE,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,WAAW;SACjE,CAAC;QAEF,IAAI,WAAW,KAAK,SAAS,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACpD,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC;YAC3B,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACvC,CAAC;QAED,IAAI,WAAW,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAC/C,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC;QAC7B,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,iBAAiB,CACvB,OAAgD,EAChD,YAAoC;QAEpC,IAAI,YAAY,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1D,IAAI,CAAC;gBACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;YAChE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,KAAK,kBAAkB;qBACpB,MAAM,CACL,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EACzD,EAAE,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,YAAY,EAAE,EACzC,qBAAqB,CACtB;qBACA,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;gBACnB,OAAO,CAAC,KAAK,CAAC,mDAAmD,EAAE,KAAK,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,YAAY,CAAC,yBAAyB,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACrG,CAAC;QAED,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,YAAY,CAAC,oBAAoB,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/E,CAAC;IACH,CAAC;IAED,IAAI,GAAG,GAAS,EAAE;QAChB,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAE3B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC;IAC/D,CAAC,CAAC;IAEF,KAAK,GAAG,GAAS,EAAE;QACjB,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAE3B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC9C,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC;IAC/D,CAAC,CAAC;IAEF,MAAM,GAAG,GAAS,EAAE;QAClB,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAE3B,IAAI,IAAI,CAAC,OAAO;YAAE,IAAI,CAAC,KAAK,EAAE,CAAC;;YAC1B,IAAI,CAAC,IAAI,EAAE,CAAC;IACnB,CAAC,CAAC;IAEM,kBAAkB,GAAG,CAC3B,MAAuB,EACvB,YAAgC,EAC1B,EAAE;QACR,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,YAAY,IAAI,YAAY,KAAK,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YACzE,OAAO;QACT,CAAC;QAED,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,mBAAmB,CAAC,IAAI;gBAC3B,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;gBACpD,MAAM;YAER,KAAK,mBAAmB,CAAC,KAAK;gBAC5B,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;gBACtD,MAAM;YAER,KAAK,mBAAmB,CAAC,KAAK;gBAC5B,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;oBACjB,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;gBAC3D,CAAC;gBACD,MAAM;YAER,KAAK,mBAAmB,CAAC,OAAO;gBAC9B,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;gBAC1D,MAAM;QACV,CAAC;IACH,CAAC,CAAC;IAEF,OAAO,GAAG,GAAS,EAAE;QACnB,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAE3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,YAAY,CAC1B,UAAkB,EAClB,OAAO,GAAqB,EAAE;IAE9B,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,YAAY,EAAE,CAAC;IAChD,MAAM,UAAU,GAAG,IAAI,mBAAmB,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAExE,IAAI,OAAO,CAAC,WAAW,KAAK,KAAK,EAAE,CAAC;QAClC,IAAI,CAAC;YACH,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAChC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,OAAO,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;gBACjC,UAAU,CAAC,OAAO,EAAE,CAAC;gBACrB,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export type { NuiEventMap, EventKey, PayloadForEvent, NuiEventKey, NuiEventPayload } from './nui';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAEA,YAAY,EACV,WAAW,EACX,QAAQ,EACR,eAAe,EACf,WAAW,EACX,eAAe,EAChB,MAAM,OAAO,CAAC"}

package/dist/types/index.js

@@ -0,0 +1,3 @@
+// Type definitions for @fivem-nui/svelte
+export {};
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,yCAAyC"}

package/dist/types/nui.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Type augmentation for FiveM NUI events.
+ * Extend this interface in your project to get type safety.
+ *
+ * @example
+ * ```ts
+ * // In separate .d.ts file in your project:
+ * declare module '@fivem-nui/core' {
+ *   interface NuiEventMap {
+ *     'player:health': { payload: { health: number } };
+ *     'inventory:get': { request: { id: string }; response: Item };
+ *   }
+ * }
+ * ```
+ */
+import type { NuiEventMap as CoreNuiEventMap, NuiEventPayload } from '@fivem-nui/core';
+/**
+ * Extended NuiEventMap that can be augmented by consumers.
+ */
+export interface NuiEventMap extends CoreNuiEventMap {
+}
+/**
+ * Available event keys from the extended event map.
+ */
+export type EventKey<T extends NuiEventMap = NuiEventMap> = keyof T;
+/**
+ * Payload type for a specific event.
+ */
+export type PayloadForEvent<E extends EventKey> = NuiEventPayload<E>;
+/**
+ * Re-export core types for convenience
+ */
+export type { NuiEventKey, NuiEventPayload } from '@fivem-nui/core';
+//# sourceMappingURL=nui.d.ts.map

package/dist/types/nui.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nui.d.ts","sourceRoot":"","sources":["../../src/types/nui.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,WAAW,IAAI,eAAe,EAAe,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEpG;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,eAAe;CAAI;AAExD;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,MAAM,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,QAAQ,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;AAErE;;GAEG;AACH,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/types/nui.js

@@ -0,0 +1,17 @@
+/**
+ * Type augmentation for FiveM NUI events.
+ * Extend this interface in your project to get type safety.
+ *
+ * @example
+ * ```ts
+ * // In separate .d.ts file in your project:
+ * declare module '@fivem-nui/core' {
+ *   interface NuiEventMap {
+ *     'player:health': { payload: { health: number } };
+ *     'inventory:get': { request: { id: string }; response: Item };
+ *   }
+ * }
+ * ```
+ */
+export {};
+//# sourceMappingURL=nui.js.map

package/dist/types/nui.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nui.js","sourceRoot":"","sources":["../../src/types/nui.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG"}

package/dist/utils/env.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Detects whether the current page is running inside FiveM's Chromium Embedded Framework (CEF).
+ * In FiveM CEF, `window.GetParentResourceName` is injected as a native global function.
+ *
+ * @returns `true` if executing within FiveM CEF, `false` otherwise.
+ */
+export declare function isNui(): boolean;
+/**
+ * Returns true when running in a standard browser (Vite dev server, standalone preview), outside FiveM.
+ *
+ * @returns `true` if running in a standard browser outside FiveM, `false` if inside CEF.
+ */
+export declare function isBrowser(): boolean;
+/**
+ * Safely resolves the parent resource name if running in FiveM CEF, or returns fallback in browser.
+ *
+ * @param fallback - Resource name to return if not running in FiveM CEF or if resolution fails.
+ * @returns The FiveM resource name or the provided fallback.
+ */
+export declare function getResourceName(fallback?: string): string;
+//# sourceMappingURL=env.d.ts.map

package/dist/utils/env.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../../src/utils/env.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,KAAK,IAAI,OAAO,CAE/B;AAED;;;;GAIG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAEnC;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,QAAQ,SAAqB,GAAG,MAAM,CAUrE"}

package/dist/utils/env.js

@@ -0,0 +1,36 @@
+/**
+ * Detects whether the current page is running inside FiveM's Chromium Embedded Framework (CEF).
+ * In FiveM CEF, `window.GetParentResourceName` is injected as a native global function.
+ *
+ * @returns `true` if executing within FiveM CEF, `false` otherwise.
+ */
+export function isNui() {
+    return typeof globalThis.GetParentResourceName === 'function';
+}
+/**
+ * Returns true when running in a standard browser (Vite dev server, standalone preview), outside FiveM.
+ *
+ * @returns `true` if running in a standard browser outside FiveM, `false` if inside CEF.
+ */
+export function isBrowser() {
+    return !isNui();
+}
+/**
+ * Safely resolves the parent resource name if running in FiveM CEF, or returns fallback in browser.
+ *
+ * @param fallback - Resource name to return if not running in FiveM CEF or if resolution fails.
+ * @returns The FiveM resource name or the provided fallback.
+ */
+export function getResourceName(fallback = 'unknown_resource') {
+    const g = globalThis;
+    if (typeof g.GetParentResourceName === 'function') {
+        try {
+            return g.GetParentResourceName();
+        }
+        catch {
+            return fallback;
+        }
+    }
+    return fallback;
+}
+//# sourceMappingURL=env.js.map

package/dist/utils/env.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.js","sourceRoot":"","sources":["../../src/utils/env.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,KAAK;IACnB,OAAO,OAAQ,UAAkD,CAAC,qBAAqB,KAAK,UAAU,CAAC;AACzG,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS;IACvB,OAAO,CAAC,KAAK,EAAE,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,QAAQ,GAAG,kBAAkB;IAC3D,MAAM,CAAC,GAAG,UAAsD,CAAC;IACjE,IAAI,OAAO,CAAC,CAAC,qBAAqB,KAAK,UAAU,EAAE,CAAC;QAClD,IAAI,CAAC;YACH,OAAO,CAAC,CAAC,qBAAqB,EAAE,CAAC;QACnC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/utils/error.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Checks whether an error represents an aborted asynchronous operation.
+ * Matches standard DOMException AbortError, Fetch AbortError, or custom NuiRequestError with code 'ABORTED'.
+ */
+export declare function isAbortError(err: unknown): boolean;
+/**
+ * Creates an AbortError in an environment-agnostic way.
+ * Uses global DOMException if available; falls back to Error with name 'AbortError' and code 'ABORTED'.
+ */
+export declare function createAbortError(message?: string): Error | DOMException;
+//# sourceMappingURL=error.d.ts.map

package/dist/utils/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/utils/error.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAWlD;AAGD;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,SAA+B,GAAG,KAAK,GAAG,YAAY,CAQ7F"}

package/dist/utils/error.js

@@ -0,0 +1,30 @@
+/**
+ * Checks whether an error represents an aborted asynchronous operation.
+ * Matches standard DOMException AbortError, Fetch AbortError, or custom NuiRequestError with code 'ABORTED'.
+ */
+export function isAbortError(err) {
+    if (typeof err !== 'object' || err === null) {
+        return false;
+    }
+    try {
+        const candidate = err;
+        return candidate.name === 'AbortError' || candidate.code === 'ABORTED';
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Creates an AbortError in an environment-agnostic way.
+ * Uses global DOMException if available; falls back to Error with name 'AbortError' and code 'ABORTED'.
+ */
+export function createAbortError(message = 'The operation was aborted.') {
+    if (typeof DOMException !== 'undefined') {
+        return new DOMException(message, 'AbortError');
+    }
+    const err = new Error(message);
+    err.name = 'AbortError';
+    err.code = 'ABORTED';
+    return err;
+}
+//# sourceMappingURL=error.js.map

package/dist/utils/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../src/utils/error.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,GAAY;IACvC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QAC5C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,GAAyC,CAAC;QAC5D,OAAO,SAAS,CAAC,IAAI,KAAK,YAAY,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,CAAC;IACzE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAGD;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAO,GAAG,4BAA4B;IACrE,IAAI,OAAO,YAAY,KAAK,WAAW,EAAE,CAAC;QACxC,OAAO,IAAI,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IACjD,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/B,GAAG,CAAC,IAAI,GAAG,YAAY,CAAC;IACvB,GAAyB,CAAC,IAAI,GAAG,SAAS,CAAC;IAC5C,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './env';
+export * from './keyboard';
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC"}

package/dist/utils/index.js

@@ -0,0 +1,3 @@
+export * from './env';
+export * from './keyboard';
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC"}

package/dist/utils/keyboard.d.ts

@@ -0,0 +1,127 @@
+/**
+ * Keyboard modifier keys.
+ */
+export declare enum NuiKeyboardModifier {
+    Ctrl = "ctrl",
+    Alt = "alt",
+    Shift = "shift",
+    Meta = "meta"
+}
+/**
+ * Standard special key names commonly used in FiveM NUI shortcuts.
+ */
+export declare enum NuiSpecialKey {
+    Escape = "Escape",
+    Enter = "Enter",
+    Tab = "Tab",
+    Space = " ",
+    Backspace = "Backspace",
+    ArrowUp = "ArrowUp",
+    ArrowDown = "ArrowDown",
+    ArrowLeft = "ArrowLeft",
+    ArrowRight = "ArrowRight"
+}
+/**
+ * Configuration options for keyboard event handlers and shortcuts.
+ */
+export interface KeyOptions {
+    /**
+     * Listen during capture phase.
+     * @defaultValue false
+     */
+    capture?: boolean;
+    /**
+     * Automatically call `event.preventDefault()`.
+     * @defaultValue false
+     */
+    preventDefault?: boolean;
+    /**
+     * Automatically call `event.stopPropagation()`.
+     * @defaultValue false
+     */
+    stopPropagation?: boolean;
+    /**
+     * Whether the key shortcut is enabled.
+     * Accepts a static boolean or a reactive getter `() => boolean`.
+     * @defaultValue true
+     */
+    enabled?: boolean | (() => boolean);
+    /**
+     * If true, suppresses shortcut execution when the active element is an input,
+     * textarea, select, or contenteditable.
+     * Crucial in FiveM NUI panels to prevent game hotkeys firing while typing messages/searches.
+     * @defaultValue false
+     */
+    ignoreInputs?: boolean;
+    /**
+     * Ignore repeating keydown events triggered while holding a key down.
+     * @defaultValue false
+     */
+    ignoreRepeat?: boolean;
+    /**
+     * Require Ctrl key to be pressed (or Cmd on Mac).
+     */
+    ctrl?: boolean;
+    /**
+     * Require Alt key to be pressed.
+     */
+    alt?: boolean;
+    /**
+     * Require Shift key to be pressed.
+     */
+    shift?: boolean;
+    /**
+     * Require Meta (Windows / Cmd) key to be pressed.
+     */
+    meta?: boolean;
+    /**
+     * Component lifecycle registration strategy:
+     * - `true`: Strictly requires component initialization lifecycle; registers `onDestroy`.
+     *   If called outside a component, unsubscribes immediately to prevent memory leaks and throws.
+     * - `false`: Disables automatic lifecycle cleanup. The caller must invoke the returned cleanup function manually.
+     * - `undefined` (default): Attempts to register `onDestroy` within a component lifecycle;
+     *   falls back gracefully to manual cleanup if called outside a component.
+     * @defaultValue undefined
+     */
+    autoDestroy?: boolean;
+}
+/**
+ * Registers a keyboard shortcut with automatic lifecycle management.
+ *
+ * Designed for FiveM NUI with support for:
+ * - `ignoreInputs`: prevents hotkeys from firing while typing in input fields.
+ * - Modifier keys (Ctrl, Alt, Shift, Meta).
+ * - Automatic cleanup via `onDestroy` and `AbortController`.
+ *
+ * @param keys - Key or array of keys (case-insensitive) to listen for.
+ * @param handler - Callback function invoked when matching keydown occurs.
+ * @param options - Optional shortcut configuration including modifiers and lifecycle strategy.
+ * @returns Cleanup function to remove event listeners.
+ *
+ * @example
+ * ```svelte
+ * <script>
+ *   import { useNuiKey } from '@fivem-nui/svelte';
+ *   useNuiKey('e', () => interact(), { ignoreInputs: true });
+ * </script>
+ * ```
+ */
+export declare function useNuiKey(keys: string | string[], handler: (event: KeyboardEvent) => void, options?: KeyOptions): () => void;
+/**
+ * Listens for the `Escape` key to close or dismiss NUI panels.
+ * In FiveM, ESC is the universal standard for closing NUI windows.
+ *
+ * @param onEscape - Callback function invoked when the Escape key is pressed.
+ * @param options - Optional configuration overriding default key options (`preventDefault` defaults to `true`).
+ * @returns Cleanup function to remove the Escape listener.
+ *
+ * @example
+ * ```svelte
+ * <script>
+ *   import { useNuiEscape, nui } from '@fivem-nui/svelte';
+ *   useNuiEscape(() => nui.notify('close'));
+ * </script>
+ * ```
+ */
+export declare function useNuiEscape(onEscape: (event: KeyboardEvent) => void, options?: KeyOptions): () => void;
+//# sourceMappingURL=keyboard.d.ts.map

package/dist/utils/keyboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyboard.d.ts","sourceRoot":"","sources":["../../src/utils/keyboard.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,mBAAmB;IAC7B,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,IAAI,SAAS;CACd;AAED;;GAEG;AACH,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,KAAK,MAAM;IACX,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,UAAU,eAAe;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,CAAC,MAAM,OAAO,CAAC,CAAC;IAEpC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAcD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,OAAO,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,EACvC,OAAO,GAAE,UAAe,GACvB,MAAM,IAAI,CA8EZ;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,EACxC,OAAO,GAAE,UAAe,GACvB,MAAM,IAAI,CAKZ"}