@nativewrappers/server 0.0.64 → 0.0.72

package/README.md

@@ -0,0 +1,45 @@
+<h1 align="center">Monorepo for a FiveM server/client wrapper</h1>
+
+<p align="center">
+	<i>🔥 A Javascript/Typescript package for FiveM resource development 🎮</i>
+  <br>
+  <small>This project is in no way affiliated with FiveM or the Cfx.re Collective.</small>
+  </br></br>
+  <a href="https://github.com/nativewrappers/nativewrappers/blob/master/LICENSE">
+    <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat" alt="License: MIT">
+  </a>
+  <a href="https://www.npmjs.com/package/@nativewrappers/fivem">
+    <img src="https://img.shields.io/npm/v/@nativewrappers/fivem?style=flat" alt="npm version">
+  </a>
+  <a href="https://www.npmjs.com/package/@nativewrappers/fivem">
+    <img src="https://img.shields.io/npm/dm/@nativewrappers/fivem?style=flat">
+  </a>
+  <a href="https://github.com/nativewrappers/nativewrappers/actions/workflows/config.yml">
+    <img src="https://github.com/nativewrappers/nativewrappers/actions/workflows/config.yml/badge.svg" alt="Workflow Status">
+  </a>
+  <a href="https://github.com/nativewrappers/nativewrappers/commits/master">
+    <img src="https://img.shields.io/github/last-commit/nativewrappers/fivem.svg?style=flat" alt="Last commit">
+  </a>
+</p>
+
+<h3 align="center">This project is currently iterating rapidly, there will be breaking changes.</h3>
+
+<p align="center">
+	<h2 align="center"><a href="https://github.com/nativewrappers/nativewrappers/tree/main/docs">Documentation</a></h2>
+	<!-- <a href="https://forum.fivem.net/t/fivem-js-v1-3-2-javascript-typescript-wrapper-now-with-menu-class-nativeui/268640">Forum</a> -->
+</p>
+
+## Features
+
+- No runtime dependencies
+- Entity management through class objects (i.e. `Vehicle` and `Ped` entities)
+- Server and Client side variants on wrapper
+
+
+## Download & Install
+```
+pnpm add @nativewrappers/redm # for redm,
+pnpm add @nativewrappers/fivem # for fivem
+pnpm add @nativewrappers/common # for any, should be game agnostic, provides Vector3, decors, kvps, helper functions, etc
+pnpm add @nativewrappers/server # for server
+```

package/cfx/StateBagChangeHandler.d.ts

@@ -1,3 +1 @@
-export interface StateBagChangeHandler<T> {
-    (bagName: string, key: string, value: T, reserved: number, replicated: boolean): void;
-}
+export type StateBagChangeHandler<T> = (bagName: string, key: string, value: T, reserved: number, replicated: boolean) => void;

package/common/Command.d.ts

@@ -0,0 +1,30 @@
+type Restricted = boolean | string | string[];
+interface ParameterTypes {
+    number: number;
+    playerId: number;
+    string: string;
+    longString: string;
+}
+interface Parameter {
+    name: string;
+    type: keyof ParameterTypes;
+    help?: string;
+    optional?: boolean;
+}
+type MappedParameters<T extends Parameter[]> = {
+    [K in T[number] as K["name"]]: ParameterTypes[K["type"]];
+} & {
+    source: number;
+    raw: string;
+};
+type CommandHandler<T extends Parameter[]> = (args: MappedParameters<T>) => void | Promise<void>;
+export declare class Command<T extends Parameter[] = Parameter[]> {
+    #private;
+    readonly name: string | string[];
+    readonly help: string;
+    readonly params?: T | undefined;
+    constructor(name: string | string[], help: string, handler: CommandHandler<T>, params?: T | undefined, restricted?: Restricted);
+    private mapArguments;
+    call(source: number, args: string[], raw?: string): Promise<void>;
+}
+export {};

package/common/Convar.d.ts

@@ -0,0 +1,13 @@
+export declare class Convar {
+    /**
+     * @returns the current console buffer
+     */
+    buffer(): string;
+    get(variable: string, defaultVar: string): string;
+    getInt(variable: string, defaultVar: number): number;
+    getFloat(varName: string, defaultVar: number): number;
+    getBool(varName: string, defaultVar: boolean): boolean;
+    set(variable: string, value: string): void;
+    setReplicated(variable: string, value: string): void;
+    setServerInfo(variable: string, value: string): void;
+}

package/common/GlobalData.d.ts

@@ -0,0 +1,8 @@
+export declare class GlobalData {
+    static CurrentResource: string;
+    static IS_SERVER: boolean;
+    static IS_CLIENT: boolean;
+    static NetworkTick: number | null;
+    static NetworkedTicks: any[];
+    static EnablePrettyPrint: boolean;
+}

package/common/Kvp.d.ts

@@ -0,0 +1,69 @@
+type KvpSchema = Record<string, string | number | object>;
+type KvpObject<T> = T extends `${infer Prefix}.${infer Rest}` ? Rest extends `${string}.${string}` ? never : Prefix : never;
+type ValidJsonKey<Schema> = {
+    [K in keyof Schema]: K extends string ? `${K}.${string}` : never;
+}[keyof Schema];
+export declare class Kvp<Schema extends KvpSchema> {
+    /**
+     * Returns the value associated with a key as a number.
+     */
+    getNumber<K extends string & keyof Schema>(key: K): number;
+    /**
+     * Returns the value associated with a key as a float.
+     */
+    getFloat<K extends string & keyof Schema>(key: K): number;
+    /**
+     * Returns the value associated with a key as a string.
+     */
+    getString<K extends string & keyof Schema>(key: K): string | null;
+    /**
+     * Returns the value associated with a key as a parsed JSON string.
+     */
+    getJson<K extends string, O = KvpObject<K>>(key: K extends ValidJsonKey<O> ? K : never): (O extends string ? Schema[O] : null) | null;
+    /**
+     * Sets the value associated with a key as a number.
+     * @param async set the value using an async operation.
+     */
+    setNumber<K extends string & keyof Schema>(key: K, value: number, async?: boolean): void;
+    /**
+     * Sets the value associated with a key as a float.
+     * @param async set the value using an async operation.
+     */
+    setFloat<K extends string & keyof Schema>(key: K, value: number, async?: boolean): void;
+    /**
+     * Sets the value associated with a key as a string.
+     * @param async set the value using an async operation.
+     */
+    setString<K extends string & keyof Schema>(key: K, value: string, async?: boolean): void;
+    /**
+     * Sets the value associated with a key as a JSON string.
+     * @param async set the value using an async operation.
+     */
+    setJson<K extends string, O = KvpObject<K>>(key: K extends ValidJsonKey<O> ? K : never, value: O extends string ? Schema[O] : never, async?: boolean): void;
+    /**
+     * Sets the value associated with a key as a JSON string.
+     * @param async set the value using an async operation.
+     */
+    set<K extends string, O = KvpObject<K>>(key: K extends keyof Schema ? K : O extends string ? K : never, value: K extends keyof Schema ? Schema[K] : O extends string ? Schema[O] : never, async?: boolean): void;
+    /**
+     * Deletes the specified value for key.
+     * @param async remove the value using an async operation
+     */
+    delete(key: string, async?: boolean): void;
+    /**
+     * Commits pending asynchronous operations to disk, ensuring data consistency.
+     *
+     * Should be called after calling set methods using the async flag.
+     */
+    flush(): void;
+    getAllKeys(prefix: string): (keyof Schema)[];
+    /**
+     * Returns an array of keys which match or contain the given keys.
+     */
+    getKeys<K extends (string & keyof Schema) | string[]>(prefix: K): (keyof Schema)[];
+    /**
+     * Get all values from keys in an array as the specified type.
+     */
+    getValuesAsType<K extends (string & keyof Schema) | (string & keyof Schema)[]>(prefix: K, type: any): (string | number | Schema[string] | null)[];
+}
+export {};

package/common/Resource.d.ts

@@ -0,0 +1,14 @@
+export declare class Resource {
+    name: string;
+    constructor(name: string);
+    getMetadata(metadataKey: string, index: number): string;
+    getPath(): string;
+    loadFile(fileName: string): string;
+    saveFile(fileName: string, data: string, length: number): boolean;
+    scheduleTick(): void;
+    start(): void;
+    stop(): void;
+    static startResource(name: string): void;
+    static stopResource(name: string): void;
+    static resourceCount(): number;
+}

package/common/decors/Events.d.ts

@@ -0,0 +1,54 @@
+export declare enum ConVarType {
+    String = 0,
+    Integer = 1,
+    Float = 2,
+    Boolean = 3
+}
+/**
+ * Disables pretty printing in error messages
+ */
+export declare const DisablePrettyPrint: () => boolean;
+export declare function Exports(exportName: string): (originalMethod: any, context: ClassMethodDecoratorContext) => void;
+/**
+ * Registers the Event call for {@link eventName} to this method.
+ *
+ * This has internal pretty-printing to make errors easier to track, if
+ * you want to disable this you will need to call {@link DisablePrettyPrint}, or if you're
+ * using esbuild you can add `REMOVE_EVENT_LOG` to your drop label {@link https://esbuild.github.io/api/#drop-labels}
+ *
+ * @param eventName the event to bind to
+ */
+export declare function Event(eventName: string): (originalMethod: any, context: ClassMethodDecoratorContext) => void;
+/**
+ * Registers the Net Event call for {@link eventName} to this method
+ *
+ *
+ * This has internal pretty-printing to make errors easier to track, if
+ * you want to disable this you will need to call {@link DisablePrettyPrint}, or if you're
+ * using esbuild you can add `REMOVE_EVENT_LOG` to your drop label {@link https://esbuild.github.io/api/#drop-labels}
+ *
+ * @param eventName the event to bind this net event to
+ * @param remoteOnly if the event should only accept remote calls, if set to true it will ignore any local call via `emit`, defaults to true
+ */
+export declare function NetEvent(eventName: string, remoteOnly?: boolean): (originalMethod: any, context: ClassMethodDecoratorContext) => void;
+/**
+ * Registers the NUI Event call for {eventName} to this method, the function signature
+ * should be (data: unknown, cb: (data?: any) => void) => void
+ * You shoud always execute `cb` with 'ok' if you don't want to send data back to
+ * the UI, otherwise you'll cause a network error for the `fetch` request
+ * @param eventName the event this will listen for
+ */
+export declare function NuiEvent(eventName: string): (originalMethod: any, context: ClassMethodDecoratorContext) => void;
+type DeserializeFn<T> = (data: T) => unknown;
+/**
+ * Gets the specified `ConVar`s value, this will bind to the param.
+ * @param name the convar name
+ * @param is_floating_point if the convar is floating point, this should be explicitly set to true if your convar will be a float
+ */
+export declare function ConVar<T>(name: string, is_floating_point?: boolean, deserialize?: DeserializeFn<T>): (_initialValue: any, context: ClassFieldDecoratorContext, ..._args: any[]) => void;
+/**
+ * Gets called per server/client tick, this is asyncronous though, if you await
+ * in it, it will not be called until whatever was being awaited resolves.
+ */
+export declare function SetTick(): (originalMethod: any, context: ClassMethodDecoratorContext) => void;
+export {};

package/common/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./utils";
+export * from "./net/NetworkedMap";
+export * from "./decors/Events";
+export * from "./Convar";
+export * from "./Command";
+export * from "./Kvp";
+export * from "./Resource";
+export * from "./utils/index";

package/common/net/NetworkedMap.d.ts

@@ -0,0 +1,28 @@
+type ChangeListener<V> = (value: V) => void;
+/**
+ * not ready to be used just thoughts right now
+ */
+export declare class NetworkedMap<K, V> extends Map<K, V> {
+    #private;
+    constructor(syncName: string, initialValue?: [K, V][]);
+    get SyncName(): string;
+    private onPlayerDropped;
+    resync(source: number): void;
+    addSubscriber(source: number): void;
+    removeSubscriber(sub: number): boolean;
+    hasSubscriber(sub: number): boolean;
+    subscriberCount(): number;
+    private handleSync;
+    listenForChange(key: K, fn: ChangeListener<V>): void;
+    set(key: K, value: V): this;
+    clear(): void;
+    delete(key: K): boolean;
+    networkTick(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Unregisters from the tick handler and removes the event listener
+     */
+    dispose(): void;
+    get [Symbol.toStringTag](): string;
+}
+export {};

package/common/types.d.ts

@@ -0,0 +1,5 @@
+import type { Buffer } from "buffer";
+export type MsgpackBuffer = {
+    buffer: Buffer;
+    type: number;
+};

package/common/utils/ClassTypes.d.ts

@@ -0,0 +1,11 @@
+export declare enum ClassTypes {
+    Ped = 0,
+    Prop = 1,
+    Vehicle = 2,
+    Entity = 3,
+    Player = 4,
+    Vector2 = 5,
+    Vector3 = 6,
+    Vector4 = 7,
+    Quanterion = 8
+}

package/common/utils/Color.d.ts

@@ -0,0 +1,14 @@
+export declare class Color {
+    static Transparent: Color;
+    static Black: Color;
+    static White: Color;
+    static WhiteSmoke: Color;
+    static fromArgb(a: number, r: number, g: number, b: number): Color;
+    static fromRgb(r: number, g: number, b: number): Color;
+    static fromArray(primitive: [number, number, number] | number[]): Color;
+    a: number;
+    r: number;
+    g: number;
+    b: number;
+    constructor(r: number, g: number, b: number, a?: number);
+}

package/common/utils/Maths.d.ts

@@ -0,0 +1,4 @@
+export declare abstract class Maths {
+    static clamp(num: number, min: number, max: number): number;
+    static getRandomInt(min: number, max: number): number;
+}

package/common/utils/PointF.d.ts

@@ -0,0 +1,12 @@
+export interface PointF {
+    x: number;
+    y: number;
+    z: number;
+}
+export declare class PointF implements PointF {
+    x: number;
+    y: number;
+    z: number;
+    static empty(): PointF;
+    constructor(x: number, y: number, z: number);
+}

package/common/utils/Quaternion.d.ts

@@ -0,0 +1,10 @@
+import { Vector3 } from "./Vector3";
+export declare class Quaternion {
+    x: number;
+    y: number;
+    z: number;
+    w: number;
+    constructor(value: number);
+    constructor(vector: Vector3, w: number);
+    constructor(x: number, y: number, z: number, w: number);
+}