@fivem-nui/core 1.0.0 → 1.1.0

package/src/diagnostics/NuiDiagnostics.ts

@@ -1,28 +1,28 @@
-/**
- * Counter snapshot exposed by {@link NuiClient.getDiagnostics}.
- *
- * Mirrors the C# `NuiDiagnosticsSnapshot` so both sides of the bridge can be
- * inspected with the same vocabulary.
- */
-export interface NuiDiagnostics {
-  /** Envelopes POSTed to the main resource callback. */
-  sent: number;
-  /** Envelopes POSTed to a named callback (`notify`, `notifyAndWait`). */
-  notified: number;
-  /** POSTs that failed or timed out. */
-  failed: number;
-  /** Messages received from C#, any type. */
-  received: number;
-  /** Requests that resolved successfully. */
-  resolved: number;
-  /** Requests rejected by C# or by a timeout. */
-  rejected: number;
-  /** Requests still awaiting a response. */
-  pending: number;
-  /** Registered event listeners, across all events. */
-  listeners: number;
-  /** Registered C#-request handlers. */
-  callbacks: number;
-  /** Window lifecycle listeners. */
-  windowListeners: number;
-}
+/**
+ * Counter snapshot exposed by {@link NuiClient.getDiagnostics}.
+ *
+ * Mirrors the C# `NuiDiagnosticsSnapshot` so both sides of the bridge can be
+ * inspected with the same vocabulary.
+ */
+export interface NuiDiagnostics {
+  /** Envelopes POSTed to the main resource callback. */
+  sent: number;
+  /** Envelopes POSTed to a named callback (`notify`, `notifyAndWait`). */
+  notified: number;
+  /** POSTs that failed or timed out. */
+  failed: number;
+  /** Messages received from C#, any type. */
+  received: number;
+  /** Requests that resolved successfully. */
+  resolved: number;
+  /** Requests rejected by C# or by a timeout. */
+  rejected: number;
+  /** Requests still awaiting a response. */
+  pending: number;
+  /** Registered event listeners, across all events. */
+  listeners: number;
+  /** Registered C#-request handlers. */
+  callbacks: number;
+  /** Window lifecycle listeners. */
+  windowListeners: number;
+}

package/src/types.ts

@@ -1,151 +1,151 @@
-/**
- * Represents an error in NUI communication.
- */
-export interface NuiError {
-  code: string;
-  message: string;
-}
-
-/**
- * Window lifecycle envelope type sent by C# window management.
- */
-export type NuiWindowAction = 'open' | 'close' | 'focus' | 'unfocus';
-
-/**
- * Represents a message sent between C# and NUI.
- */
-export interface NuiMessage {
-  id?: string;
-  type: 'request' | 'response' | 'event' | NuiWindowAction;
-  /**
-   * Absent on responses - the correlation `id` already identifies the call.
-   */
-  event?: string;
-  payload?: unknown;
-  success?: boolean;
-  error?: NuiError;
-}
-
-/**
- * Result of an NUI operation.
- */
-export interface NuiResult<T> {
-  success: boolean;
-  value?: T;
-  error?: NuiError;
-}
-
-/**
- * Maps NUI event names to their request/response or payload shapes.
- *
- * Empty by default. A contracts module generated by `FiveM.Nui.Contracts`
- * augments this interface, so that {@link NuiClient} calls are checked against
- * the C# contract: a name that is not in the map fails to compile, and the
- * request and response types are inferred from the entry.
- *
- * @example
- * ```ts
- * declare module '@fivem-nui/core' {
- *   interface NuiEventMap {
- *     'inventory:use': { request: UseItemRequest; response: UseItemResponse };
- *     'player:healthChanged': { payload: HealthChanged };
- *   }
- * }
- * ```
- */
-export interface NuiEventMap {}
-
-/**
- * Event names accepted by {@link NuiClient}. Falls back to any string while
- * {@link NuiEventMap} is empty, so the client stays usable without generated
- * contracts and becomes strict as soon as the map is augmented.
- */
-export type NuiEventKey = keyof NuiEventMap extends never ? string : keyof NuiEventMap;
-
-/**
- * Discriminates event map entries by their communication pattern.
- * - `request` - events that expect a request from the UI (have both request and response)
- * - `response` - events that only have a response (no request from UI)
- * - `payload` - fire-and-forget events
- * - `event` - events that don't fit other categories (fallback)
- */
-type EventPattern<E> = E extends keyof NuiEventMap
-  ? NuiEventMap[E] extends { request: any; response: any }
-    ? 'request'
-    : NuiEventMap[E] extends { response: any }
-    ? 'response'
-    : NuiEventMap[E] extends { payload: any }
-    ? 'payload'
-    : 'event'
-  : 'event';
-
-/**
- * Extracts the event pattern (request/response/payload) for a mapped event.
- * Useful for conditional typing in overload resolution.
- */
-export type EventCommunication<E> = EventPattern<E>;
-
-/**
- * Payload type for `send` and `sendAndWait` methods.
- * - When the event has `payload`, extracts that type (required parameter).
- * - When `NuiEventMap` is empty, returns `unknown` (fallback behavior).
- * - For other event types, returns `undefined` (payload not applicable, but call allowed).
- */
-export type SendPayload<E> = E extends keyof NuiEventMap
-  ? NuiEventMap[E] extends { payload: infer TPayload }
-    ? TPayload
-    : undefined
-  : unknown;
-
-/**
- * Request type for `request` method.
- * - When the event has `request`, extracts that type (required parameter).
- * - When the event doesn't have `request`, returns `undefined` (request not applicable, but call allowed).
- * - When `NuiEventMap` is empty, returns `unknown` (fallback behavior).
- */
-export type RequestPayload<E> = E extends keyof NuiEventMap
-  ? NuiEventMap[E] extends { request: infer TRequest }
-    ? TRequest
-    : undefined
-  : unknown;
-
-/**
- * Response type for `request` method.
- * - When the event has `response`, returns that type.
- * - When `NuiEventMap` is empty, returns `unknown` (fallback behavior).
- */
-export type RequestResponse<E> = E extends keyof NuiEventMap
-  ? NuiEventMap[E] extends { response: infer TResponse }
-    ? TResponse
-    : unknown
-  : unknown;
-
-/**
- * Request payload type for a mapped event, or `undefined` when the event takes
- * none. Resolves to `unknown` while {@link NuiEventMap} is empty.
- */
-export type NuiEventRequest<E> = E extends keyof NuiEventMap
-  ? NuiEventMap[E] extends { request: infer TRequest }
-    ? TRequest
-    : undefined
-  : unknown;
-
-/**
- * Response payload type for a mapped event. Resolves to `unknown` while
- * {@link NuiEventMap} is empty, preserving the untyped behaviour.
- */
-export type NuiEventResponse<E> = E extends keyof NuiEventMap
-  ? NuiEventMap[E] extends { response: infer TResponse }
-    ? TResponse
-    : unknown
-  : unknown;
-
-/**
- * Fire-and-forget payload type for a mapped event. Resolves to `unknown` while
- * {@link NuiEventMap} is empty.
- */
-export type NuiEventPayload<E> = E extends keyof NuiEventMap
-  ? NuiEventMap[E] extends { payload: infer TPayload }
-    ? TPayload
-    : undefined
-  : unknown;
+/**
+ * Represents an error in NUI communication.
+ */
+export interface NuiError {
+  code: string;
+  message: string;
+}
+
+/**
+ * Window lifecycle envelope type sent by C# window management.
+ */
+export type NuiWindowAction = 'open' | 'close' | 'focus' | 'unfocus';
+
+/**
+ * Represents a message sent between C# and NUI.
+ */
+export interface NuiMessage {
+  id?: string;
+  type: 'request' | 'response' | 'event' | NuiWindowAction;
+  /**
+   * Absent on responses - the correlation `id` already identifies the call.
+   */
+  event?: string;
+  payload?: unknown;
+  success?: boolean;
+  error?: NuiError;
+}
+
+/**
+ * Result of an NUI operation.
+ */
+export interface NuiResult<T> {
+  success: boolean;
+  value?: T;
+  error?: NuiError;
+}
+
+/**
+ * Maps NUI event names to their request/response or payload shapes.
+ *
+ * Empty by default. A contracts module generated by `FiveM.Nui.Contracts`
+ * augments this interface, so that {@link NuiClient} calls are checked against
+ * the C# contract: a name that is not in the map fails to compile, and the
+ * request and response types are inferred from the entry.
+ *
+ * @example
+ * ```ts
+ * declare module '@fivem-nui/core' {
+ *   interface NuiEventMap {
+ *     'inventory:use': { request: UseItemRequest; response: UseItemResponse };
+ *     'player:healthChanged': { payload: HealthChanged };
+ *   }
+ * }
+ * ```
+ */
+export interface NuiEventMap {}
+
+/**
+ * Event names accepted by {@link NuiClient}. Falls back to any string while
+ * {@link NuiEventMap} is empty, so the client stays usable without generated
+ * contracts and becomes strict as soon as the map is augmented.
+ */
+export type NuiEventKey = keyof NuiEventMap extends never ? string : keyof NuiEventMap;
+
+/**
+ * Discriminates event map entries by their communication pattern.
+ * - `request` - events that expect a request from the UI (have both request and response)
+ * - `response` - events that only have a response (no request from UI)
+ * - `payload` - fire-and-forget events
+ * - `event` - events that don't fit other categories (fallback)
+ */
+type EventPattern<E> = E extends keyof NuiEventMap
+  ? NuiEventMap[E] extends { request: any; response: any }
+    ? 'request'
+    : NuiEventMap[E] extends { response: any }
+    ? 'response'
+    : NuiEventMap[E] extends { payload: any }
+    ? 'payload'
+    : 'event'
+  : 'event';
+
+/**
+ * Extracts the event pattern (request/response/payload) for a mapped event.
+ * Useful for conditional typing in overload resolution.
+ */
+export type EventCommunication<E> = EventPattern<E>;
+
+/**
+ * Payload type for `send` and `sendAndWait` methods.
+ * - When the event has `payload`, extracts that type (required parameter).
+ * - When `NuiEventMap` is empty, returns `unknown` (fallback behavior).
+ * - For other event types, returns `undefined` (payload not applicable, but call allowed).
+ */
+export type SendPayload<E> = E extends keyof NuiEventMap
+  ? NuiEventMap[E] extends { payload: infer TPayload }
+    ? TPayload
+    : undefined
+  : unknown;
+
+/**
+ * Request type for `request` method.
+ * - When the event has `request`, extracts that type (required parameter).
+ * - When the event doesn't have `request`, returns `undefined` (request not applicable, but call allowed).
+ * - When `NuiEventMap` is empty, returns `unknown` (fallback behavior).
+ */
+export type RequestPayload<E> = E extends keyof NuiEventMap
+  ? NuiEventMap[E] extends { request: infer TRequest }
+    ? TRequest
+    : undefined
+  : unknown;
+
+/**
+ * Response type for `request` method.
+ * - When the event has `response`, returns that type.
+ * - When `NuiEventMap` is empty, returns `unknown` (fallback behavior).
+ */
+export type RequestResponse<E> = E extends keyof NuiEventMap
+  ? NuiEventMap[E] extends { response: infer TResponse }
+    ? TResponse
+    : unknown
+  : unknown;
+
+/**
+ * Request payload type for a mapped event, or `undefined` when the event takes
+ * none. Resolves to `unknown` while {@link NuiEventMap} is empty.
+ */
+export type NuiEventRequest<E> = E extends keyof NuiEventMap
+  ? NuiEventMap[E] extends { request: infer TRequest }
+    ? TRequest
+    : undefined
+  : unknown;
+
+/**
+ * Response payload type for a mapped event. Resolves to `unknown` while
+ * {@link NuiEventMap} is empty, preserving the untyped behaviour.
+ */
+export type NuiEventResponse<E> = E extends keyof NuiEventMap
+  ? NuiEventMap[E] extends { response: infer TResponse }
+    ? TResponse
+    : unknown
+  : unknown;
+
+/**
+ * Fire-and-forget payload type for a mapped event. Resolves to `unknown` while
+ * {@link NuiEventMap} is empty.
+ */
+export type NuiEventPayload<E> = E extends keyof NuiEventMap
+  ? NuiEventMap[E] extends { payload: infer TPayload }
+    ? TPayload
+    : undefined
+  : unknown;