@pma-network/redm-types 0.0.1

package/Inventory.d.ts

@@ -0,0 +1,51 @@
+export type InventoryType = "player" | "horse" | "localHorse" | "ground";
+export type Bitwise<T> = T;
+export declare enum ItemFlags {
+    None = 0,
+    CantBeStolen = 2,
+    Usable = 4,
+    IsWeapon = 8,
+    IsAmmo = 8,
+    Stackable = 32
+}
+export type ItemName = string;
+export type ItemId = number;
+export interface ItemData {
+    item_id: ItemId;
+    name: ItemName;
+    weight: number;
+    flags: Bitwise<ItemFlags>;
+    stack_limit: number;
+    label: string;
+    description: string;
+}
+export interface InventoryItem {
+    item_data_ref: ItemData;
+    quantity: number;
+}
+export type OptionalItem = InventoryItem | null | undefined;
+export declare abstract class BaseInventory {
+    /**
+     * Gets the item with {@link item_name}
+     * @returns the {@link InventoryItem} or undefined if the player doesn't have that item in their inventory.
+     */
+    abstract get_item(item_name: ItemName): OptionalItem;
+    /**
+     * Adds the item with {@link item_name} to the players next free slot
+     * @throws This will throw an error if {@link item_name} is invalid, or if {@link quantity} is negative
+     * @returns the {@link InventoryItem} that was created, or undefined if there wasn't a free slot to put the item into.
+     */
+    abstract add_item(item_name: ItemName, quantity: number): OptionalItem;
+    /**
+     * Removes the item with {@link item_name} from the players inventory
+     * @throws This will throw an error if there wasn't enough {@link quantity} in the players inventory, you should use use {@link has_enough_of_item} to check before calling
+     * @param item_name the item to remove
+     * @param quantity the amount of the item to remove
+     */
+    abstract remove_item(item_name: ItemName, quantity: number): boolean;
+    /**
+     * Checks if the player has enough of {@link item_name}
+     * @returns `true` if they had enough {@link quantity}, `false` otherwise
+     */
+    abstract has_enough_of_item(item_name: ItemName, quantity: number): boolean;
+}

package/Inventory.js

@@ -0,0 +1,20 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var ItemFlags = /* @__PURE__ */ ((ItemFlags2) => {
+  ItemFlags2[ItemFlags2["None"] = 0] = "None";
+  ItemFlags2[ItemFlags2["CantBeStolen"] = 2] = "CantBeStolen";
+  ItemFlags2[ItemFlags2["Usable"] = 4] = "Usable";
+  ItemFlags2[ItemFlags2["IsWeapon"] = 8] = "IsWeapon";
+  ItemFlags2[ItemFlags2["IsAmmo"] = 8] = "IsAmmo";
+  ItemFlags2[ItemFlags2["Stackable"] = 32] = "Stackable";
+  return ItemFlags2;
+})(ItemFlags || {});
+class BaseInventory {
+  static {
+    __name(this, "BaseInventory");
+  }
+}
+export {
+  BaseInventory,
+  ItemFlags
+};

package/Notifications.d.ts

@@ -0,0 +1,12 @@
+export type Position = "top-left" | "top-center" | "top-right" | "middle-left" | "middle" | "middle-right" | "bottom-left" | "bottom-center" | "bottom-right";
+export type NotificationVariant = "default" | "error" | "success";
+export type PMAPartialNotification = Omit<PMANotification, "id">;
+export type PMANotification = {
+    id: number;
+    title?: string;
+    body?: string;
+    variant: NotificationVariant;
+    duration?: number;
+    position?: Position;
+    timeout?: number;
+};

package/PMAPlayer.d.ts

@@ -0,0 +1,52 @@
+import type { ItemName, OptionalItem } from "./Inventory";
+export type Source = number;
+export type PlayerUID = number;
+export type CallSign = string | undefined;
+export type PlayerJob = {
+    name: string;
+    rank: number;
+};
+export declare abstract class AbstractPMAPlayer {
+    abstract get_sex(): number;
+    abstract get_height(): number;
+    abstract get_dob(): string;
+    abstract get_unique_id(): PlayerUID;
+    abstract get_call_sign(): CallSign;
+    abstract get_character_name(): string;
+    abstract get_log_name(): string;
+    abstract get_item(item_name: ItemName): OptionalItem;
+    /**
+     * Adds the item with {@param item_name} to the players next free slot
+     * @throws This will throw an error if {@param item_name} is invalid, or if {@param quantity} is negative
+     * @returns the {@link InventoryItem} that was created, or undefined if there wasn't a free slot to put the item into.
+     */
+    abstract add_item(item_name: ItemName, quantity: number): OptionalItem;
+    /**
+     * Removes the item with {@param item_name} from the players inventory
+     * @throws This will throw an error if there wasn't enough {@param quantity} in the players inventory, you should use use has_enough_of_item to check before calling
+     */
+    abstract remove_item(item_name: ItemName, quantity: number): void;
+    /**
+     * Checks if the player has enough of {@param item_name}
+     * @returns `true` if they had enough {@param quantity}, `false` otherwise
+     */
+    abstract has_enough_of_item(item_name: ItemName, quantity: number): boolean;
+    abstract get_job(): PlayerJob;
+    /**
+     * Sets the players job to the specified {@param job_name} and {@param rank}
+     * @throws This will throw if the players job is invalid
+     */
+    abstract set_job(job_name: string, rank: number): void;
+    abstract get_bank(): number;
+    /**
+     * Adds the {@param positive_amount} to the players bank.
+     * @throws if {@param positive_amount} is negative this will throw an error.
+     */
+    abstract add_to_bank(positive_amount: number): void;
+    /**
+     * Removes the {@param negative_amount} to the players bank.
+     * @throws if {@param negative_amount} is positive this will throw an error.
+     */
+    abstract remove_from_bank(negative_amount: number): void;
+    abstract save(): Promise<void>;
+}

package/PMAPlayer.js

@@ -0,0 +1,10 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+class AbstractPMAPlayer {
+  static {
+    __name(this, "AbstractPMAPlayer");
+  }
+}
+export {
+  AbstractPMAPlayer
+};

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/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Inventory";
+export * from "./Notifications";
+export * from "./PMAPlayer";

package/index.js

@@ -0,0 +1,3 @@
+export * from "./Inventory";
+export * from "./Notifications";
+export * from "./PMAPlayer";

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@pma-network/redm-types",
+  "description": "Native wrappers and utilities for use with PMA RedM Server.",
+  "contributors": [
+    "Dillon Skaggs <AvarianKnight>"
+  ],
+  "type": "module",
+  "version": "0.0.1",
+  "files": [
+    "./**/*.js",
+    "./**/*.d.ts"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": "./index.js",
+    "./*": "./*"
+  }
+}