@nativewrappers/common 0.0.65 → 0.0.76

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "@nativewrappers/common",
-  "description": "Native wrappers and utilities for use with Cfx.re's scripting runtimes.",
+  "description": "Native wrappers and utilities for use with Common Utilities.",
+  "contributors": [
+    "Remco Troost <d0p3t>",
+    "Dillon Skaggs <AvarianKnight>",
+    "Linden <thelindat>"
+  ],
   "license": "MIT",
   "type": "module",
-  "version": "0.0.65",
+  "version": "0.0.76",
   "repository": {
     "type": "git",
     "url": "https://github.com/nativewrappers/nativewrappers.git"

package/utils/PointF.d.ts

@@ -1,8 +1,3 @@
-export interface PointF {
-    x: number;
-    y: number;
-    z: number;
-}
 export declare class PointF implements PointF {
     x: number;
     y: number;

package/Command.js

@@ -1,103 +0,0 @@
-import { GlobalData } from "./GlobalData";
-const commands = [];
-if (GlobalData.IS_SERVER) {
-    on("playerJoining", () => emitNet("chat:addSuggestions", source, commands));
-}
-function registerCommand(name, commandHandler, restricted) {
-    if (Array.isArray(name))
-        return name.forEach((name) => registerCommand(name, commandHandler, restricted));
-    RegisterCommand(name, commandHandler, !!restricted);
-    if (GlobalData.IS_CLIENT)
-        return;
-    const ace = `command.${name}`;
-    if (typeof restricted === "string") {
-        if (IsPrincipalAceAllowed(restricted, ace))
-            return;
-        return ExecuteCommand(`add_ace ${restricted} ${ace} allow`);
-    }
-    if (Array.isArray(restricted)) {
-        restricted.forEach((principal) => !IsPrincipalAceAllowed(principal, ace) &&
-            ExecuteCommand(`add_ace ${restricted} ${ace} allow`));
-    }
-}
-export class Command {
-    name;
-    help;
-    params;
-    #handler;
-    constructor(name, help, handler, params, restricted = true) {
-        this.name = name;
-        this.help = help;
-        this.params = params;
-        this.#handler = handler;
-        this.name = `/${name}`;
-        registerCommand(name, (source, args, raw) => this.call(source, args, raw), restricted);
-        if (params) {
-            params.forEach((param) => {
-                if (param.type)
-                    param.help = param.help
-                        ? `${param.help} (type: ${param.type})`
-                        : `(type: ${param.type})`;
-            });
-            setTimeout(() => {
-                if (GlobalData.IS_SERVER) {
-                    commands.push(this);
-                    return emitNet("chat:addSuggestions", -1, this);
-                }
-                emit("chat:addSuggestion", this);
-            }, 100);
-        }
-    }
-    mapArguments(source, args, raw) {
-        const mapped = {
-            source,
-            raw,
-        };
-        if (!this.params)
-            return mapped;
-        const result = this.params.every((param, index) => {
-            const arg = args[index];
-            let value = arg;
-            switch (param.type) {
-                case "number":
-                    value = +arg;
-                    break;
-                case "string":
-                    value = !Number(arg) ? arg : false;
-                    break;
-                case "playerId":
-                    if (GlobalData.IS_SERVER) {
-                        value = arg === "me" ? source : +arg;
-                        if (!value || !DoesPlayerExist(value.toString()))
-                            value = undefined;
-                    }
-                    else {
-                        value = arg === "me" ? GetPlayerServerId(PlayerId()) : +arg;
-                        if (!value || GetPlayerFromServerId(value) === -1)
-                            value = undefined;
-                    }
-                    break;
-                case "longString":
-                    value = raw.substring(raw.indexOf(arg));
-                    break;
-            }
-            if (value === undefined && (!param.optional || (param.optional && arg))) {
-                return Citizen.trace(`^1command '${raw.split(" ")[0] || raw}' received an invalid ${param.type} for argument ${index + 1} (${param.name}), received '${arg}'^0`);
-            }
-            mapped[param.name] = value;
-            return true;
-        });
-        return result ? mapped : null;
-    }
-    async call(source, args, raw = args.join(" ")) {
-        const parsed = this.mapArguments(source, args, raw);
-        if (!parsed)
-            return;
-        try {
-            await this.#handler(parsed);
-        }
-        catch (err) {
-            Citizen.trace(`^1command '${raw.split(" ")[0] || raw}' failed to execute!^0\n${err.message}`);
-        }
-    }
-}

package/Convar.js

@@ -1,50 +0,0 @@
-import { GlobalData } from "./GlobalData";
-export class Convar {
-    /**
-     * @returns the current console buffer
-     */
-    buffer() {
-        CLIENT: {
-            if (GlobalData.IS_CLIENT) {
-                throw new Error("This function isn't available on the client");
-            }
-        }
-        return GetConsoleBuffer();
-    }
-    get(variable, defaultVar) {
-        return GetConvar(variable, defaultVar);
-    }
-    getInt(variable, defaultVar) {
-        return GetConvarInt(variable, defaultVar);
-    }
-    getFloat(varName, defaultVar) {
-        return GetConvarFloat(varName, defaultVar);
-    }
-    getBool(varName, defaultVar) {
-        return GetConvarBool(varName, defaultVar);
-    }
-    set(variable, value) {
-        CLIENT: {
-            if (GlobalData.IS_CLIENT) {
-                throw new Error("This function isn't available on the client");
-            }
-        }
-        SetConvar(variable, value);
-    }
-    setReplicated(variable, value) {
-        CLIENT: {
-            if (GlobalData.IS_CLIENT) {
-                throw new Error("This function isn't available on the client");
-            }
-        }
-        SetConvarReplicated(variable, value);
-    }
-    setServerInfo(variable, value) {
-        CLIENT: {
-            if (GlobalData.IS_CLIENT) {
-                throw new Error("This function isn't available on the client");
-            }
-        }
-        SetConvarServerInfo(variable, value);
-    }
-}

package/GlobalData.js

@@ -1,8 +0,0 @@
-export class GlobalData {
-    static CurrentResource = GetCurrentResourceName();
-    static IS_SERVER = IsDuplicityVersion();
-    static IS_CLIENT = !GlobalData.IS_SERVER;
-    static NetworkTick = null;
-    static NetworkedTicks = [];
-    static EnablePrettyPrint = true;
-}

package/Kvp.js

@@ -1,141 +0,0 @@
-export class Kvp {
-    /**
-     * Returns the value associated with a key as a number.
-     */
-    getNumber(key) {
-        return GetResourceKvpInt(key);
-    }
-    /**
-     * Returns the value associated with a key as a float.
-     */
-    getFloat(key) {
-        return GetResourceKvpFloat(key);
-    }
-    /**
-     * Returns the value associated with a key as a string.
-     */
-    getString(key) {
-        return GetResourceKvpString(key);
-    }
-    /**
-     * Returns the value associated with a key as a parsed JSON string.
-     */
-    getJson(key) {
-        const str = GetResourceKvpString(key);
-        return str ? JSON.parse(str) : null;
-    }
-    /**
-     * Sets the value associated with a key as a number.
-     * @param async set the value using an async operation.
-     */
-    setNumber(key, value, async = false) {
-        return async
-            ? SetResourceKvpIntNoSync(key, value)
-            : SetResourceKvpInt(key, value);
-    }
-    /**
-     * Sets the value associated with a key as a float.
-     * @param async set the value using an async operation.
-     */
-    setFloat(key, value, async = false) {
-        return async
-            ? SetResourceKvpFloatNoSync(key, value)
-            : SetResourceKvpFloat(key, value);
-    }
-    /**
-     * Sets the value associated with a key as a string.
-     * @param async set the value using an async operation.
-     */
-    setString(key, value, async = false) {
-        return async
-            ? SetResourceKvpNoSync(key, value)
-            : SetResourceKvp(key, value);
-    }
-    /**
-     * Sets the value associated with a key as a JSON string.
-     * @param async set the value using an async operation.
-     */
-    setJson(key, value, async = false) {
-        const str = JSON.stringify(value);
-        return async ? SetResourceKvpNoSync(key, str) : SetResourceKvp(key, str);
-    }
-    /**
-     * Sets the value associated with a key as a JSON string.
-     * @param async set the value using an async operation.
-     */
-    set(key, value, async = false) {
-        switch (typeof value) {
-            case "function":
-            case "symbol":
-                throw new Error(`Failed to set Kvp for invalid type '${typeof value}'`);
-            case "undefined":
-                return this.delete(key, async);
-            case "object":
-                return this.setJson(key, value, async);
-            case "boolean":
-                value = value ? 1 : 0;
-            case "number":
-                return Number.isInteger(value)
-                    ? this.setNumber(key, value, async)
-                    : this.setFloat(key, value, async);
-            default:
-                value = String(value);
-                return this.setString(key, value, async);
-        }
-    }
-    /**
-     * Deletes the specified value for key.
-     * @param async remove the value using an async operation
-     */
-    delete(key, async = false) {
-        return async ? DeleteResourceKvpNoSync(key) : DeleteResourceKvp(key);
-    }
-    /**
-     * Commits pending asynchronous operations to disk, ensuring data consistency.
-     *
-     * Should be called after calling set methods using the async flag.
-     */
-    flush() {
-        FlushResourceKvp();
-    }
-    getAllKeys(prefix) {
-        const keys = [];
-        const handle = StartFindKvp(prefix);
-        if (handle === -1)
-            return keys;
-        let key;
-        do {
-            key = FindKvp(handle);
-            if (key)
-                keys.push(key);
-        } while (key);
-        EndFindKvp(handle);
-        return keys;
-    }
-    /**
-     * Returns an array of keys which match or contain the given keys.
-     */
-    getKeys(prefix) {
-        return typeof prefix === "string"
-            ? this.getAllKeys(prefix)
-            : prefix.flatMap((key) => this.getAllKeys(key));
-    }
-    /**
-     * Get all values from keys in an array as the specified type.
-     */
-    getValuesAsType(prefix, type) {
-        const values = this.getKeys(prefix);
-        return values.map((key) => {
-            switch (type) {
-                case "number":
-                    return this.getNumber(key);
-                case "float":
-                    return this.getFloat(key);
-                case "string":
-                    return this.getString(key);
-                default:
-                    return this.getJson(key);
-            }
-        });
-    }
-}

package/Resource.js

@@ -1,47 +0,0 @@
-import { GlobalData } from "./GlobalData";
-export class Resource {
-    name;
-    constructor(name) {
-        this.name = name;
-    }
-    getMetadata(metadataKey, index) {
-        return GetResourceMetadata(this.name, metadataKey, index);
-    }
-    getPath() {
-        return GetResourcePath(this.name);
-    }
-    loadFile(fileName) {
-        return LoadResourceFile(this.name, fileName);
-    }
-    saveFile(fileName, data, length) {
-        CLIENT: {
-            if (GlobalData.IS_CLIENT) {
-                throw new Error("This function isn't available on the client");
-            }
-        }
-        return SaveResourceFile(this.name, fileName, data, length);
-    }
-    scheduleTick() {
-        CLIENT: {
-            if (GlobalData.IS_CLIENT) {
-                throw new Error("This function isn't available on the client");
-            }
-        }
-        return ScheduleResourceTick(this.name);
-    }
-    start() {
-        StartResource(this.name);
-    }
-    stop() {
-        StopResource(this.name);
-    }
-    static startResource(name) {
-        StartResource(name);
-    }
-    static stopResource(name) {
-        StopResource(name);
-    }
-    static resourceCount() {
-        return GetNumResources();
-    }
-}

package/decors/Events.js

@@ -1,217 +0,0 @@
-import { GlobalData } from "../GlobalData";
-export var ConVarType;
-(function (ConVarType) {
-    ConVarType[ConVarType["String"] = 0] = "String";
-    ConVarType[ConVarType["Integer"] = 1] = "Integer";
-    ConVarType[ConVarType["Float"] = 2] = "Float";
-    ConVarType[ConVarType["Boolean"] = 3] = "Boolean";
-})(ConVarType || (ConVarType = {}));
-/**
- * Disables pretty printing in error messages
- */
-export const DisablePrettyPrint = () => (GlobalData.EnablePrettyPrint = false);
-// TODO: Have a way to clean all of this up (maybe hook Symbol.disposable
-// somehow?)
-/*
- * Registers the export call for {exportName} to this method
- */
-export function Exports(exportName) {
-    return function actualDecorator(originalMethod, context) {
-        if (context.private) {
-            throw new Error("Exports does not work on private methods, please mark the method as public");
-        }
-        context.addInitializer(function () {
-            const t = this;
-            exports(exportName, (...args) => {
-                return originalMethod.call(t, ...args);
-            });
-        });
-    };
-}
-/**
- * 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 function Event(eventName) {
-    return function actualDecorator(originalMethod, context) {
-        if (context.private) {
-            throw new Error("Event does not work on private methods, please mark the method as public");
-        }
-        context.addInitializer(function () {
-            const t = this;
-            on(eventName, (...args) => {
-                try {
-                    return originalMethod.call(t, ...args);
-                }
-                catch (e) {
-                    REMOVE_EVENT_LOG: {
-                        if (!GlobalData.EnablePrettyPrint)
-                            return;
-                        console.error(`------- EVENT ERROR --------`);
-                        console.error(`Call to ${eventName} errored`);
-                        console.error(`Data: ${JSON.stringify(args)}`);
-                        console.error(`Error: ${e}`);
-                        console.error(`------- END EVENT ERROR --------`);
-                    }
-                }
-            });
-        });
-    };
-}
-/**
- * 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 function NetEvent(eventName, remoteOnly = true) {
-    return function actualDecorator(originalMethod, context) {
-        if (context.private) {
-            throw new Error("NetEvent does not work on private methods, please mark the method as public");
-        }
-        context.addInitializer(function () {
-            const t = this;
-            onNet(eventName, (...args) => {
-                const src = source;
-                try {
-                    CLIENT: {
-                        if (remoteOnly && source !== 65535) {
-                            return;
-                        }
-                    }
-                    return originalMethod.call(t, ...args);
-                }
-                catch (e) {
-                    REMOVE_NET_EVENT_LOG: {
-                        if (!GlobalData.EnablePrettyPrint)
-                            return;
-                        console.error(`------- NET EVENT ERROR --------`);
-                        console.error(`Call to ${eventName} errored`);
-                        console.error(`Caller: ${src}`);
-                        console.error(`Data: ${JSON.stringify(args)}`);
-                        console.error(`Error: ${e}`);
-                        console.error(`------- END NET EVENT ERROR --------`);
-                    }
-                }
-            });
-        });
-    };
-}
-/**
- * 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 function NuiEvent(eventName) {
-    return function actualDecorator(originalMethod, context) {
-        if (context.private) {
-            throw new Error("NuiEvent does not work on private methods, please mark the method as public");
-        }
-        context.addInitializer(function () {
-            const t = this;
-            RegisterNuiCallback(eventName, (...args) => {
-                return originalMethod.call(t, ...args);
-            });
-        });
-    };
-}
-const get_convar_fn = (con_var_type) => {
-    switch (con_var_type) {
-        case ConVarType.String:
-            return GetConvar;
-        case ConVarType.Integer:
-            return GetConvarInt;
-        case ConVarType.Float:
-            return GetConvarFloat;
-        case ConVarType.Boolean:
-            return GetConvarBool;
-        // needed so typescript wont complain about "unreachable code" for the error below
-        default:
-    }
-    // never guess people wont manage to hit this
-    throw new Error("Got invalid ConVarType");
-};
-/**
- * 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 function ConVar(name, is_floating_point, deserialize) {
-    // the implementation shows that this will be _initialValue, but it doesn't
-    // seem to actually be???
-    return function actualDecorator(_initialValue, context, ..._args) {
-        if (context.private) {
-            throw new Error("ConVar does not work on private types, please mark the field as public");
-        }
-        context.addInitializer(function () {
-            const t = this;
-            const default_value = Reflect.get(t, context.name);
-            const default_type = typeof default_value;
-            let con_var_type = null;
-            if (default_type == "number") {
-                if (is_floating_point || !Number.isInteger(default_value)) {
-                    con_var_type = ConVarType.Float;
-                }
-                else {
-                    con_var_type = ConVarType.Integer;
-                }
-            }
-            else if (default_type == "boolean") {
-                con_var_type = ConVarType.Boolean;
-            }
-            else if (default_value == "string") {
-                con_var_type = ConVarType.String;
-            }
-            // if we're not set that means our default value was not valid, and likely
-            // undefined (which we should just get rid of) or an object, and the
-            // caller should send a deserialize function to work with.
-            if (!deserialize && con_var_type === null) {
-                throw new Error("You should provide a deserialize function if you want to convert this to an object type");
-            }
-            // if we got past our previous check then we're going to take the data as
-            // a string and pass it to the deserialize function
-            if (con_var_type === null) {
-                con_var_type = ConVarType.String;
-            }
-            const con_var_fn = get_convar_fn(con_var_type);
-            // nice and easy wrapper
-            const get_convar_value = () => {
-                const data = con_var_fn(name, default_value);
-                return deserialize ? deserialize(data) : data;
-            };
-            Reflect.set(t, context.name, get_convar_value());
-            AddConvarChangeListener(name, () => {
-                Reflect.set(t, context.name, get_convar_value());
-            });
-        });
-    };
-}
-/**
- * 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 function SetTick() {
-    return function actualDecorator(originalMethod, context) {
-        if (context.private) {
-            throw new Error("SetTick does not work on private types, please mark the field as public");
-        }
-        context.addInitializer(function () {
-            const t = this;
-            setTick(async () => {
-                await originalMethod.call(t);
-            });
-        });
-    };
-}