lenix 1.8.8 → 1.8.10

package/client/_init.ts

@@ -1,6 +1,6 @@
 import { asserts, type JsonValue } from '@lenix/lenix'
 import type { Request } from '../shared/types.ts'
-import { onNui } from './nui.ts'
+import { state, onNui } from './nui.ts'
 
 type Resolve = {
 	success: true,
@@ -22,8 +22,8 @@ onNui<Request<JsonValue, '__nuiServer', {
 	}
 }>>('__nuiServer', async ({ id, data }) => {
 	const { timeout = DEFAULT_TIMEOUT, requestData } = data
-	
-  const response = await new Promise<Resolve>(resolve => {
+
+	const response = await new Promise<Resolve>(resolve => {
 		requestId = requestId + 1
 		const currentRequestId = requestId
 		pendingResolves[currentRequestId] = resolve
@@ -47,7 +47,7 @@ onNui<Request<JsonValue, '__nuiServer', {
 			}
 		}, timeout)
 	})
-	
+
 	asserts(response.success, `server nui<${id}> timed out after ${timeout}ms, possible slow respose or request does not exist`)
 
 	return response.returned
@@ -63,3 +63,8 @@ onNui<Request<true, '__nuiFocus', {
 	SetNuiFocus(keyboard, cursor)
 	return true
 })
+
+onNui<Request<null, '__nuiInit'>>('__nuiInit', () => {
+	state.nuiReady = true
+	return null
+})

package/client/client.ts

@@ -1,197 +1,171 @@
 import type { JsonValue } from '@lenix/lenix'
-import { repeat } from '../shared/repeat.ts'
+import { repeat } from '../../../typescript/repeat.ts'
 import type { Vec3, Vec4 } from '../shared/types.ts'
 
 
-export const client = {
-	entity: {
-		/**
-		 * Gets the local entity handle from a network ID.
-		 *
-		 * Network IDs are shared, but entity handles are local.
-		 * The returned handle is only valid on the current machine.
-		 *
-		 * If no network ID is provided, this resolves your own player ped
-		 * by first getting its network ID.
-		 *
-		 * Examples:
-		 * - entity(vehicleNetId) -> local vehicle handle
-		 * - entity(pedNetId) -> local ped handle
-		 * - entity() -> your own player ped handle
-		 */
-		handle: (entityNetId: number) => NetworkGetEntityFromNetworkId(entityNetId),
-
-		/**
-		 * Gets the network ID for an entity.
-		 *
-		 * Entity handles are local to the current machine.
-		 * Network IDs are shared references for networked entities.
-		 *
-		 * If no entity is provided, this uses your own player ped.
-		 *
-		 * Examples:
-		 * - netId(vehicle) -> network ID of that vehicle
-		 * - netId(targetPed) -> network ID of that ped
-		 * - netId() -> network ID of your own player ped
-		 */
-		netId: (entity: number) => NetworkGetNetworkIdFromEntity(entity),
-
-		/**
-		 * Gets entity coordinates and heading.
-		 */
-		coords: (() => {
-			function coords(entity: number, excludeH?: true, isAlive?: boolean): Vec3
-			function coords(entity: number, excludeH?: false, isAlive?: boolean): Vec4
-			function coords(entity: number, excludeH = false, isAlive = true) {
-				const entityCoords = GetEntityCoords(entity, isAlive) as Vec3
-
-				if (excludeH) return entityCoords
-
-				return [
-					...entityCoords,
-					GetEntityHeading(entity)
-				]
-			}
-
-			return coords
-		})(),
-
-		/*  */
-		teleport: (
-			entity: number,
-			x: number,
-			y: number,
-			z: number,
-			h?: number,
-			keepTasks = false,
-			keepIK = false,
-			doWarp = false
-		) => {
-			SetEntityCoordsNoOffset(entity, x, y, z, keepTasks, keepIK, doWarp)
-			h && SetEntityHeading(entity, h)
-		},
+export const entity = {
+	/**
+	 * Gets the local entity handle from a network ID.
+	 *
+	 * Network IDs are shared, but entity handles are local.
+	 * The returned handle is only valid on the current machine.
+	 *
+	 * If no network ID is provided, this resolves your own player ped
+	 * by first getting its network ID.
+	 *
+	 * Examples:
+	 * - entity(vehicleNetId) -> local vehicle handle
+	 * - entity(pedNetId) -> local ped handle
+	 * - entity() -> your own player ped handle
+	 */
+	handle: (entityNetId: number) => NetworkGetEntityFromNetworkId(entityNetId),
+
+	/**
+	 * Gets the network ID for an entity.
+	 *
+	 * Entity handles are local to the current machine.
+	 * Network IDs are shared references for networked entities.
+	 *
+	 * If no entity is provided, this uses your own player ped.
+	 *
+	 * Examples:
+	 * - netId(vehicle) -> network ID of that vehicle
+	 * - netId(targetPed) -> network ID of that ped
+	 * - netId() -> network ID of your own player ped
+	 */
+	netId: (entity: number) => NetworkGetNetworkIdFromEntity(entity),
+
+	/**
+	 * Gets entity coordinates and heading.
+	 */
+	coords: (() => {
+		function coords(entity?: number, excludeH?: true, isAlive?: boolean): Vec3
+		function coords(entity?: number, excludeH?: false, isAlive?: boolean): Vec4
+		function coords(handle = player.entity(), excludeH = false, isAlive = true) {
+			const entityCoords = GetEntityCoords(handle, isAlive) as Vec3
+
+			if (excludeH) return entityCoords
+
+			return [
+				...entityCoords,
+				GetEntityHeading(handle)
+			]
+		}
 
-		/*  */
-		playAnim: async (
-			ped: number,
-			dict: string,
-			name: string,
-			blendIn = 2.0,
-			blendOut = 2.0,
-			duration = -1,
-			flag = 0,
-			playbackFrom = 0.0,
-			x = false,
-			y = false,
-			z = false
-		) => {
-			RequestAnimDict(dict)
-			await repeat(() => HasAnimDictLoaded(dict), true)
-			TaskPlayAnim(ped, dict, name, blendIn, blendOut, duration, flag, playbackFrom, x, y, z)
-		},
+		return coords
+	})(),
+
+	/*  */
+	teleport: (
+		x: number,
+		y: number,
+		z: number,
+		handle: number = player.entity(),
+		h?: number,
+		keepTasks = false,
+		keepIK = false,
+		doWarp = false
+	) => {
+		SetEntityCoordsNoOffset(handle, x, y, z, keepTasks, keepIK, doWarp)
+		h && SetEntityHeading(handle, h)
+	},
 
-		/*  */
-		stopAnim: (ped: number, dict: string) => {
-			RemoveAnimDict(dict)
-			ClearPedTasks(ped)
-		}
+	/*  */
+	playAnim: async (
+		ped: number,
+		dict: string,
+		name: string,
+		blendIn = 2.0,
+		blendOut = 2.0,
+		duration = -1,
+		flag = 0,
+		playbackFrom = 0.0,
+		x = false,
+		y = false,
+		z = false
+	) => {
+		RequestAnimDict(dict)
+		await repeat(() => HasAnimDictLoaded(dict), true)
+		TaskPlayAnim(ped, dict, name, blendIn, blendOut, duration, flag, playbackFrom, x, y, z)
 	},
-	player: {
-		/**
-		 * Gets a client player ID.
-		 *
-		 * If a server ID is provided, this converts that server ID into a client
-		 * player ID on the current client.
-		 *
-		 * If no server ID is provided, this returns your own client player ID.
-		 *
-		 * Examples:
-		 * - id(targetServerId) -> target player's client player ID
-		 * - id() -> your own client player ID
-		 */
-		id: (serverId?: number) => serverId !== undefined ? GetPlayerFromServerId(serverId) : PlayerId(),
-
-		/**
-		 * Gets a player's server ID from their client player ID.
-		 *
-		 * Client player IDs are local to each client.
-		 * Server IDs, also called source IDs, identify connected players on the server.
-		 *
-		 * If no client player ID is provided, this uses your own client player ID.
-		 *
-		 * Examples:
-		 * - serverId(targetPlayerId) -> target player's server ID
-		 * - serverId() -> your own server ID
-		 */
-		serverId(playerId?: number) {
-			return GetPlayerServerId(playerId ?? this.id())
-		},
 
-		/*  */
-		entity: (playerId?: number) => playerId !== undefined ? GetPlayerPed(playerId) : PlayerPedId(),
+	/*  */
+	stopAnim: (ped: number, dict: string) => {
+		RemoveAnimDict(dict)
+		ClearPedTasks(ped)
+	}
+}
 
-		/*  */
-		netId(playerId?: number) {
-			return PedToNet(this.entity(playerId))
-		},
+export const player = {
+	/**
+	 * Gets a client player ID.
+	 *
+	 * If a server ID is provided, this converts that server ID into a client
+	 * player ID on the current 
+	 *
+	 * If no server ID is provided, this returns your own client player ID.
+	 *
+	 * Examples:
+	 * - id(targetServerId) -> target player's client player ID
+	 * - id() -> your own client player ID
+	 */
+	id: (serverId?: number) => serverId !== undefined ? GetPlayerFromServerId(serverId) : PlayerId(),
+
+	/**
+	 * Gets a player's server ID from their client player ID.
+	 *
+	 * Client player IDs are local to each 
+	 * Server IDs, also called source IDs, identify connected players on the server.
+	 *
+	 * If no client player ID is provided, this uses your own client player ID.
+	 *
+	 * Examples:
+	 * - serverId(targetPlayerId) -> target player's server ID
+	 * - serverId() -> your own server ID
+	 */
+	serverId(playerId?: number) {
+		return GetPlayerServerId(playerId ?? this.id())
+	},
 
-		/*  */
-		coords<T extends true | undefined = undefined>(
-			excludeH?: T,
-			isAlive?: boolean
-		): T extends true ? Vec3 : Vec4 {
-			return (
-				excludeH === true
-					? client.entity.coords(this.entity(), true, isAlive)
-					: client.entity.coords(this.entity(), false, isAlive)
-			) as T extends true ? Vec3 : Vec4;
-		},
+	/*  */
+	entity: (playerId?: number) => playerId !== undefined ? GetPlayerPed(playerId) : PlayerPedId(),
 
-		/*  */
-		teleport(
-			x: number,
-			y: number,
-			z: number,
-			h?: number,
-			keepTasks = false,
-			keepIK = false,
-			doWarp = false
-		) {
-			return client.entity.teleport(this.entity(), x, y, z, h, keepTasks, keepIK, doWarp)
-		},
+	/*  */
+	netId(playerId: number): number {
+		return PedToNet(entity.handle(playerId))
+	},
 
-		/*  */
-		storage: {
-			set: <Storage>(
-				...[key, value]: {
-					[K in keyof Storage]: Storage[K] extends JsonValue
-						? [key: Extract<K, string>, value: Storage[K]]
-						: never
-				}[keyof Storage]
-			) => SetResourceKvp(key, JSON.stringify(value)),
-
-			get: <Storage, K extends Extract<keyof Storage, string>>(
-				key: K,
-				init?: Storage[K] extends JsonValue ? Storage[K] : never
-			): Storage[K] extends JsonValue ? Storage[K] : never => {
-				const value = GetResourceKvpString(key)
-
-				if (value === null) {
-					if (init === undefined) {
-						throw new Error(`Storage<${key}> was never assigned`)
-					}
-
-					SetResourceKvp(key, JSON.stringify(init))
-					return init as Storage[K] extends JsonValue ? Storage[K] : never
+	/*  */
+	storage: {
+		set: <Storage>(
+			...[key, value]: {
+				[K in keyof Storage]: Storage[K] extends JsonValue
+				? [key: Extract<K, string>, value: Storage[K]]
+				: never
+			}[keyof Storage]
+		) => SetResourceKvp(key, JSON.stringify(value)),
+
+		get: <Storage, K extends Extract<keyof Storage, string>>(
+			key: K,
+			init?: Storage[K] extends JsonValue ? Storage[K] : never
+		): Storage[K] extends JsonValue ? Storage[K] : never => {
+			const value = GetResourceKvpString(key)
+
+			if (value === null) {
+				if (init === undefined) {
+					throw `Storage<${key}> was never assigned`
 				}
 
-				return JSON.parse(value) as Storage[K] extends JsonValue ? Storage[K] : never
-			},
+				SetResourceKvp(key, JSON.stringify(init))
+				return init as Storage[K] extends JsonValue ? Storage[K] : never
+			}
 
-			delete: <Storage>(
-				key: Extract<keyof Storage, string>
-			) => DeleteResourceKvp(key),
-			/* TODO: add on event */
-		}
+			return JSON.parse(value) as Storage[K] extends JsonValue ? Storage[K] : never
+		},
+
+		delete: <Storage>(
+			key: Extract<keyof Storage, string>
+		) => DeleteResourceKvp(key),
+		/* TODO: add on event */
 	}
-}
+}

package/client/nearest.ts

@@ -1,5 +1,5 @@
 import type { Vec3 } from '../shared/types.ts'
-import { client } from './client.ts'
+import { entity } from './client.ts'
 
 /**
  * Finds the nearest coordinates from a list.
@@ -50,7 +50,7 @@ const player = (
 			const playerPed = GetPlayerPed(playerId)
 			const vehicle = GetVehiclePedIsIn(playerPed, false)
 			const playerCoords: Vec3 = vehicle === 0
-				? client.entity.coords(playerPed, true)
+				? entity.coords(playerPed, true)
 				: GetWorldPositionOfEntityBone(playerPed, 0) as Vec3
 
 			const distance = Vdist(
@@ -83,15 +83,15 @@ const player = (
 /**
  * Finds the nearest vehicle around an entity.
  */
-const vehicle = (entity: number, radialSpace: number): number | undefined => {
-	const coords: Vec3 = client.entity.coords(entity, true)
+const vehicle = (entityHandle: number, radialSpace: number): number | undefined => {
+	const coords: Vec3 = entity.coords(entityHandle, true)
 	const vehicles = GetGamePool('CVehicle') as number[]
 
 	let closest: number | undefined
 	let closestDistance = radialSpace
 
 	for (const vehicle of vehicles) {
-		const vehCoords: Vec3 = client.entity.coords(vehicle, true)
+		const vehCoords: Vec3 = entity.coords(vehicle, true)
 		const x = coords[0] - vehCoords[0]
 		const y = coords[1] - vehCoords[1]
 		const z = coords[2] - vehCoords[2]

package/client/nui.ts

@@ -1,4 +1,7 @@
 import type { NuiFetchGeneric } from '../shared/types.ts'
+import { State } from '@lenix/lenix'
+
+export const state = new State({ nuiReady: false as boolean })
 
 /**
  * Sends an event from the game client to the NUI browser.
@@ -29,8 +32,10 @@ export const onNui = <T extends NuiFetchGeneric>(
 	) => {
 		try {
 			reply(await cb(data))
-		} catch(e) {
+		} catch (e) {
 			throw e
 		}
 	})
 }
+
+export const isNuiReady = () => state.nuiReady

package/client/pool.ts

@@ -4,10 +4,12 @@ let running = false
 /**
  * Adds a task to a shared FiveM tick pool.
  */
-export const pool = (func: () => void): void => {
-	tasks.add(func)
+export const pool = (cb: () => void): () => boolean => {
+	const cleanUp = () => tasks.delete(cb)
+	tasks.add(cb)
 
-	if (running) return
+	if (running) return cleanUp
+	
 	running = true
 
 	const tick = setTick(() => {
@@ -25,4 +27,6 @@ export const pool = (func: () => void): void => {
 			}
 		}
 	})
+
+	return cleanUp
 }

package/nui/_init.ts

@@ -0,0 +1,4 @@
+import { Request } from '../shared/types'
+import { fetchNui } from './fetch'
+
+fetchNui<Request<null, '__nuiInit'>>('__nuiInit', {})

package/nui/index.ts

@@ -9,3 +9,4 @@ export * from './on.ts'
 export * from './fetch.ts'
 export * from './focus.ts'
 export * from './keydown.ts'
+export * from './_init.ts'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lenix",
-  "version": "1.8.8",
+  "version": "1.8.10",
   "description": "Typed FiveM utilities for client, server, shared, and NUI scripts",
   "author": "Lenix",
   "license": "MIT",
@@ -47,6 +47,6 @@
     "typescript": "^5"
   },
   "dependencies": {
-    "@lenix/lenix": "npm:@jsr/lenix__lenix@1.8.16"
+    "@lenix/lenix": "npm:@jsr/lenix__lenix@1.8.19"
   }
 }

package/server/server.ts

@@ -1,20 +1,18 @@
-export const server = {
-	entity: {
-		handle: (netId: number) => NetworkGetEntityFromNetworkId(netId),
-		handleBySource: (source: number) => GetPlayerPed(source.toString()),
-		teleport: (
-			entity: number,
-			x: number,
-			y: number,
-			z: number,
-			h?: number,
-			clearArea = false,
-			alive = true,
-			deadDisable = false,
-			ragdol = false
-		) => {
-			SetEntityCoords(entity, x, y, z, alive, deadDisable, ragdol, clearArea)
-			h && SetEntityHeading(entity, h)
-		},
-	}
+export const entity = {
+	handle: (netId: number) => NetworkGetEntityFromNetworkId(netId),
+	handleBySource: (source: number) => GetPlayerPed(source.toString()),
+	teleport: (
+		entity: number,
+		x: number,
+		y: number,
+		z: number,
+		h?: number,
+		clearArea = false,
+		alive = true,
+		deadDisable = false,
+		ragdol = false
+	) => {
+		SetEntityCoords(entity, x, y, z, alive, deadDisable, ragdol, clearArea)
+		h && SetEntityHeading(entity, h)
+	},
 }

package/shared/index.ts

@@ -5,5 +5,4 @@
  */
 
 export * from './types.ts'
-export * from './repeat.ts'
 export * from './palette.ts'

package/shared/types.ts

@@ -3,12 +3,17 @@ import type { JsonValue } from "@lenix/lenix"
 /**
  * Three-dimensional coordinates plus heading.
  */
-export type Vec4 = [number, number, number, number]
+export type Vec4 = readonly [number, number, number, number]
 
 /**
  * Three-dimensional coordinates.
  */
-export type Vec3 = [number, number, number]
+export type Vec3 = readonly [number, number, number]
+
+/**
+ * Two-dimensional coordinates.
+ */
+export type Vec2 = readonly [number, number, number]
 
 /**
  * Typed event tuple containing an event id and positional parameters.

package/shared/repeat.ts

@@ -1,34 +0,0 @@
-/*  */
-export function repeat<T>(check: () => T): Promise<T>
-export function repeat<T, C extends T>(
-	check: () => T,
-	untilOrEqual: C | ((checked: T) => checked is C),
-	each?: number,
-): Promise<C>
-export function repeat<T>(
-	check: () => T,
-	untilOrEqual?: T | ((checked: T) => boolean),
-	each?: number,
-): Promise<T> {
-	const hasCondition = arguments.length > 1
-	const predicate = typeof untilOrEqual === 'function'
-		? untilOrEqual as (checked: T) => boolean
-		: undefined
-
-	return new Promise(resolve => {
-		const interval = setInterval(() => {
-			const checked = check()
-
-			const met = predicate
-				? predicate(checked)
-				: hasCondition
-					? checked === untilOrEqual
-					: checked !== undefined && checked !== null
-
-			if (!met) return
-			
-			clearInterval(interval)
-			resolve(checked)
-		}, each)
-	})
-}