@nativewrappers/common-game 0.0.122 → 0.0.123

package/index.js

@@ -17,28 +17,8 @@ export * from "./entities/CommonPlayer";
 export * from "./entities/CommonProp";
 export * from "./entities/CommonVehicle";
 export * from "./entities/GetEntityClassIdFromHandle";
+export * from "./entities/IHandle";
 export * from "./definitions/index.d";
 export * from "./definitions/redm.d";
-export * from "./common/Command";
-export * from "./common/Convar";
-export * from "./common/GlobalData";
-export * from "./common/Kvp";
-export * from "./common/Resource";
-export * from "./common/types";
-export * from "./common/utils/ClassTypes";
-export * from "./common/utils/Color";
-export * from "./common/utils/Delay";
-export * from "./common/utils/Maths";
-export * from "./common/utils/Point";
-export * from "./common/utils/PointF";
-export * from "./common/utils/Quaternion";
-export * from "./common/utils/Vector";
-export * from "./common/utils/cleanPlayerName";
-export * from "./common/utils/enumValues";
-export * from "./common/utils/getStringFromUInt8Array";
-export * from "./common/utils/getUInt32FromUint8Array";
-export * from "./common/utils/randomInt";
-export * from "./common/net/NetworkedMap";
-export * from "./common/decors/Events";
 export * from "./cfx/StateBagChangeHandler";
 export * from "./cfx/cfx";

package/interfaces/Dimension.d.ts

@@ -1,4 +1,4 @@
-import type { Vector3 } from "../common/utils/Vector";
+import type { Vector3 } from "@common/utils/Vector";
 export interface Dimensions {
     min: Vector3;
     max: Vector3;

package/package.json

@@ -8,7 +8,7 @@
   ],
   "license": "MIT",
   "type": "module",
-  "version": "0.0.122",
+  "version": "0.0.123",
   "repository": {
     "type": "git",
     "url": "https://github.com/nativewrappers/nativewrappers.git"

package/utils/Animations.js

@@ -1,6 +1,6 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-import { Delay } from "../common/utils/Delay";
+import { Delay } from "@common/utils/Delay";
 const LoadAnimDict = /* @__PURE__ */ __name(async (animDict, waitTime = 1e3) => {
   const start = GetGameTimer();
   if (!HasAnimDictLoaded(animDict)) {

package/common/Command.d.ts

@@ -1,77 +0,0 @@
-type Restricted = boolean | string | string[];
-interface ParameterTypes {
-    number: number;
-    playerId: number;
-    string: string;
-    longString: string;
-}
-interface Parameter {
-    name: string;
-    type: keyof ParameterTypes;
-    defaultValue?: any;
-    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>;
-/**
- * ```typescript
- * new Command(["do", "deleteobjects"], async ({source, radius}) => {
- *   const entities = Prop.AllProps();
- *   const ply = new Player(source);
- *   const pos = ply.Ped.Position
- *   for (const ent of entities) {
- *     // if they're outside of the range of our specified radius just continue to next
- *     if (ent.Position.distance(pos) > radius) continue;
- *     ent.delete();
- *   }
- * }, "Deletes all objects in the specified range", [
- *   {
- *      name: "radius",
- *      type: "number",
- *      help: "The radius to delete the entities in",
- *      defaultValue: 5.0
- *   }
- * ] as const, "group.moderator")
- *  ```
- */
-export declare class Command<T extends Parameter[] = Parameter[]> {
-    #private;
-    readonly name: string | string[];
-    readonly help?: string | undefined;
-    readonly params?: T | undefined;
-    /**
-     * Registers a new executable command with optional parameter validation and permission restrictions.
-     * @param name The unique identifier(s) for the command, either as a single string or an array of strings.
-     * @param handler The function to execute when the command is executed.
-     * @param help A description of the command, displayed as a chat suggestion.
-     * @param params An optional array of parameter definitions specifying the command's expected arguments,
-     *               including their names, types, and descriptive help text for chat suggestions.
-     * @param restricted Determines the command's access permissions:
-     *                   - Defaults to `true`, restricting usage to users with the "command.commandName" ACE permission.
-     *                   - A string such as `"group.admin"` grants the command permission to the specified principal.
-     *                   - An array of strings grants permission to multiple principals.
-     */
-    constructor(name: string | string[], handler: CommandHandler<T>, help?: string | undefined, params?: T | undefined, restricted?: Restricted);
-    /**
-     * Maps the arguments received from a command call to the defined parameters while validating the argument types.
-     * @param source The client that executed the command, or -1 if executed by the server.
-     * @param args The arguments passed to the command.
-     * @param raw The raw input string passed to the command.
-     * @returns A mapped object containing parsed parameters.
-     */
-    private mapArguments;
-    /**
-     * Executes the command with the given arguments and source, validating and mapping the arguments before calling the handler.
-     * @param source The client that executed the command.
-     * @param args The arguments passed to the command.
-     * @param raw The raw input string passed to the command.
-     */
-    call(source: number, args: string[], raw?: string): Promise<void>;
-}
-export {};

package/common/Command.js

@@ -1,152 +0,0 @@
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-import { GlobalData } from "./GlobalData";
-const commands = [];
-$SERVER: {
-  on("playerJoining", () => emitNet("chat:addSuggestions", source, commands));
-}
-function registerCommand(name, commandHandler, restricted = true) {
-  if (Array.isArray(name)) {
-    for (const command of name) {
-      registerCommand(command, commandHandler, restricted);
-    }
-    return;
-  }
-  RegisterCommand(name, commandHandler, GlobalData.IS_CLIENT ? false : !!restricted);
-  $SERVER: {
-    const ace = `command.${name}`;
-    if (typeof restricted === "string") {
-      if (IsPrincipalAceAllowed(restricted, ace)) return;
-      return ExecuteCommand(`add_ace ${restricted} ${ace} allow`);
-    }
-    if (Array.isArray(restricted)) {
-      for (const principal of restricted) {
-        if (!IsPrincipalAceAllowed(principal, ace)) ExecuteCommand(`add_ace ${restricted} ${ace} allow`);
-      }
-    }
-  }
-}
-__name(registerCommand, "registerCommand");
-class Command {
-  /**
-   * Registers a new executable command with optional parameter validation and permission restrictions.
-   * @param name The unique identifier(s) for the command, either as a single string or an array of strings.
-   * @param handler The function to execute when the command is executed.
-   * @param help A description of the command, displayed as a chat suggestion.
-   * @param params An optional array of parameter definitions specifying the command's expected arguments,
-   *               including their names, types, and descriptive help text for chat suggestions.
-   * @param restricted Determines the command's access permissions:
-   *                   - Defaults to `true`, restricting usage to users with the "command.commandName" ACE permission.
-   *                   - A string such as `"group.admin"` grants the command permission to the specified principal.
-   *                   - An array of strings grants permission to multiple principals.
-   */
-  constructor(name, handler, help, params, restricted = true) {
-    this.name = name;
-    this.help = help;
-    this.params = params;
-    this.#handler = handler;
-    registerCommand(name, (source2, args, raw) => this.call(source2, args, raw), restricted);
-    if (params) {
-      for (const parameter of params) {
-        if (parameter.type) {
-          const defaultString = parameter.defaultValue !== void 0 ? `[default: ${parameter.defaultValue}]` : "";
-          const typeString = `[type: ${parameter.type}] ${defaultString}`;
-          parameter.help = parameter.help ? `${parameter.help} ${typeString}` : `${typeString}`;
-        }
-      }
-    }
-    setTimeout(() => {
-      const names = Array.isArray(name) ? name : [name];
-      for (const name2 of names) {
-        const commandObj = { ...this, name: `/${name2}` };
-        $SERVER: {
-          commands.push(commandObj);
-          emitNet("chat:addSuggestions", -1, commandObj);
-        }
-        $CLIENT: {
-          emit("chat:addSuggestion", commandObj);
-        }
-      }
-    }, 100);
-  }
-  static {
-    __name(this, "Command");
-  }
-  #handler;
-  /**
-   * Maps the arguments received from a command call to the defined parameters while validating the argument types.
-   * @param source The client that executed the command, or -1 if executed by the server.
-   * @param args The arguments passed to the command.
-   * @param raw The raw input string passed to the command.
-   * @returns A mapped object containing parsed parameters.
-   */
-  mapArguments(source2, args, raw) {
-    const mapped = {
-      source: source2,
-      raw
-    };
-    if (!this.params) return mapped;
-    const result = this.params.every((param, index) => {
-      const arg = args[index];
-      let value = arg;
-      const hasDefaultValue = param.defaultValue !== void 0;
-      const hasArg = typeof arg === "string";
-      if (!hasArg && hasDefaultValue) {
-        value = param.defaultValue;
-      } else {
-        switch (param.type) {
-          case "number":
-            if (hasDefaultValue && !hasArg) {
-              value = param.defaultValue;
-            } else {
-              value = +arg;
-            }
-            break;
-          case "string":
-            value = !Number(arg) ? arg : false;
-            break;
-          case "playerId":
-            $SERVER: {
-              value = arg === "me" ? source2 : +arg;
-              if (!value || !DoesPlayerExist(value.toString())) value = void 0;
-            }
-            $CLIENT: {
-              value = arg === "me" ? GetPlayerServerId(PlayerId()) : +arg;
-              if (!value || GetPlayerFromServerId(value) === -1) value = void 0;
-            }
-            break;
-          case "longString":
-            value = raw.substring(raw.indexOf(arg));
-            break;
-        }
-      }
-      if (value === void 0 && (!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;
-  }
-  /**
-   * Executes the command with the given arguments and source, validating and mapping the arguments before calling the handler.
-   * @param source The client that executed the command.
-   * @param args The arguments passed to the command.
-   * @param raw The raw input string passed to the command.
-   */
-  async call(source2, args, raw = args.join(" ")) {
-    const parsed = this.mapArguments(source2, args, raw);
-    if (!parsed) return;
-    try {
-      await this.#handler(parsed);
-    } catch (err) {
-      Citizen.trace(`^1command '${raw.split(" ")[0] || raw}' failed to execute!^0
-${err.message}`);
-    }
-  }
-}
-export {
-  Command
-};

package/common/Convar.d.ts

@@ -1,13 +0,0 @@
-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/Convar.js

@@ -1,58 +0,0 @@
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-import { GlobalData } from "./GlobalData";
-class Convar {
-  static {
-    __name(this, "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);
-  }
-}
-export {
-  Convar
-};

package/common/GlobalData.d.ts

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

package/common/GlobalData.js

@@ -1,20 +0,0 @@
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-class GlobalData {
-  static {
-    __name(this, "GlobalData");
-  }
-  static CurrentResource = GetCurrentResourceName();
-  static GameName = GetGameName();
-  static GameBuild = GetGameBuildNumber();
-  static IS_SERVER = IsDuplicityVersion();
-  static IS_REDM = GetGameName() === "redm";
-  static IS_FIVEM = GetGameName() === "fivem";
-  static IS_CLIENT = !GlobalData.IS_SERVER;
-  static NetworkTick = null;
-  static NetworkedTicks = [];
-  static EnablePrettyPrint = true;
-}
-export {
-  GlobalData
-};

package/common/Kvp.d.ts

@@ -1,69 +0,0 @@
-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/Kvp.js

@@ -1,137 +0,0 @@
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-class Kvp {
-  static {
-    __name(this, "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);
-      }
-    });
-  }
-}
-export {
-  Kvp
-};

package/common/Resource.d.ts

@@ -1,14 +0,0 @@
-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/Resource.js

@@ -1,54 +0,0 @@
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-import { GlobalData } from "./GlobalData";
-class Resource {
-  constructor(name) {
-    this.name = name;
-  }
-  static {
-    __name(this, "Resource");
-  }
-  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();
-  }
-}
-export {
-  Resource
-};