@pma-network/redm-server 0.0.6 → 0.0.8

package/PMA.d.ts

@@ -1,6 +1,6 @@
-import type { ItemData, ItemName } from "@common-types/Inventory";
-import type { PlayerUID } from "@common-types/PMAPlayer";
-import { PMAPlayerWrapper } from "./class/PMAPlayerWrapper";
+import type { ItemData, ItemName } from "@redm-types/Inventory";
+import type { PlayerUID } from "@redm-types/PMAPlayer";
+import { PMAPlayer } from "./class/PMAPlayer";
 import type { UsableItemCall } from "./types/Inventory";
 /**
  * A static class that's used for invoking framework types
@@ -22,16 +22,16 @@ export declare class PMA {
      * isn't initialized, this won't break anything though.
      * @returns the PMAPlayer wrapper, or `null` if the player doesn't exist
      */
-    static from_source(source: number): PMAPlayerWrapper | null;
+    static from_source(source: number): PMAPlayer | null;
     /**
      * Gets the player from the specified UID
      * @returns the PMAPlayer wrapper, or `null` if there wasn't a player
      */
-    static from_uid(uid: PlayerUID): PMAPlayerWrapper | null;
+    static from_uid(uid: PlayerUID): PMAPlayer | null;
     /**
      * Gets all of the players that habe the specified job(s), and the specified {@param job_rank} if specified.
      */
-    static get_players_with_job(job_names: string | string[], job_rank?: number): PMAPlayerWrapper[];
+    static get_players_with_job(job_names: string | string[], job_rank?: number): PMAPlayer[];
     /**
      * Generic logging
      * TODO: Setup a clickhouse wrapper

package/PMA.js

@@ -1,7 +1,6 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-import { Ped, randomInt } from "@nativewrappers/server";
-import { PMAPlayerWrapper } from "./class/PMAPlayerWrapper";
+import { PMAPlayer } from "./class/PMAPlayer";
 class PMA {
   static {
     __name(this, "PMA");
@@ -18,7 +17,7 @@ class PMA {
    */
   static register_usable_item(item_name, fn) {
     const usable_item_wrapper = /* @__PURE__ */ __name((abstract_ply, inventory, item) => {
-      const ply = PMAPlayerWrapper.from_raw(abstract_ply);
+      const ply = PMAPlayer.from_raw(abstract_ply);
       fn(ply, inventory, item);
     }, "usable_item_wrapper");
     exports["pma"].register_usable_item(item_name, usable_item_wrapper);
@@ -31,7 +30,7 @@ class PMA {
    * @returns the PMAPlayer wrapper, or `null` if the player doesn't exist
    */
   static from_source(source) {
-    return PMAPlayerWrapper.from_source(source);
+    return PMAPlayer.from_source(source);
   }
   /**
    * Gets the player from the specified UID
@@ -39,14 +38,14 @@ class PMA {
    */
   static from_uid(uid) {
     const data = exports["pma"].from_uid(uid);
-    return data ? PMAPlayerWrapper.from_raw(data) : null;
+    return data ? PMAPlayer.from_raw(data) : null;
   }
   /**
    * Gets all of the players that habe the specified job(s), and the specified {@param job_rank} if specified.
    */
   static get_players_with_job(job_names, job_rank) {
     const players = exports["pma"].get_players_with_job(job_names, job_rank);
-    return players.map((v) => PMAPlayerWrapper.from_raw(v));
+    return players.map((v) => PMAPlayer.from_raw(v));
   }
   /**
    * Generic logging

package/class/PMAPlayer.d.ts

@@ -1,37 +1,22 @@
-import type { ItemName, OptionalItem } from "@common-types/Inventory";
-import type { NotificationVariant, PMAPartialNotification } from "@common-types/Notifications";
-import type { AbstractPMAPlayer, CallSign, PlayerJob, PlayerUID } from "@common-types/PMAPlayer";
-import { Player } from "@nativewrappers/server";
-export declare class PMAPlayerWrapper extends Player implements AbstractPMAPlayer {
+import type { ItemName, OptionalItem } from "@redm-types/Inventory";
+import { CommonPMAPlayer } from "@shared-server/class/CommonPMAPlayer";
+import type { CommonAbstractPMAPlayer } from "@shared-server/types/CommonAbstractPMAPlayer";
+export declare class PMAPlayer extends CommonPMAPlayer {
     #private;
     /**
      * Creates the player from the ScRT msgpack'd class
      */
-    static from_raw(ply: AbstractPMAPlayer): PMAPlayerWrapper;
+    static from_raw(ply: CommonAbstractPMAPlayer): PMAPlayer;
     /**
      * Does basic checks that the player exists before lazy initializing the player
      */
-    static from_source(source: number): PMAPlayerWrapper | null;
+    static from_source(source: number): PMAPlayer | null;
+    /**
+     * Creates the player from the source without doing any validity checks
+     */
+    static from_source_unchecked(source: number): CommonPMAPlayer;
     constructor(source: number);
-    constructor(pma_player: AbstractPMAPlayer);
-    ensure_init(): void;
-    send_notification(title?: string, description?: string, variant?: NotificationVariant): void;
-    send_notification_object(partial: PMAPartialNotification): void;
-    get_sex(): number;
-    get_height(): number;
-    get_dob(): string;
-    get_unique_id(): PlayerUID;
-    get_call_sign(): CallSign;
-    get_character_name(): string;
-    get_log_name(): string;
+    constructor(pma_player: CommonAbstractPMAPlayer);
     get_item(item_name: ItemName): OptionalItem;
     add_item(item_name: ItemName, quantity: number): OptionalItem;
-    remove_item(item_name: ItemName, quantity: number): void;
-    has_enough_of_item(item_name: ItemName, quantity: number): boolean;
-    get_job(): PlayerJob;
-    set_job(job_name: string, rank: number): void;
-    get_bank(): number;
-    add_to_bank(positive_amount: number): void;
-    remove_from_bank(negative_amount: number): void;
-    save(): Promise<void>;
 }

package/class/PMAPlayer.js

@@ -1,9 +1,9 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-import { Player } from "@nativewrappers/server";
-class PMAPlayerWrapper extends Player {
+import { CommonPMAPlayer } from "@shared-server/class/CommonPMAPlayer";
+class PMAPlayer extends CommonPMAPlayer {
   static {
-    __name(this, "PMAPlayerWrapper");
+    __name(this, "PMAPlayer");
   }
   // This will get lazy-initialized whenever we actually call a function that needs it,
   // this will make sure we don't pay the un-needed serialize cost if we're only using this for
@@ -13,7 +13,7 @@ class PMAPlayerWrapper extends Player {
    * Creates the player from the ScRT msgpack'd class
    */
   static from_raw(ply) {
-    return new PMAPlayerWrapper(ply);
+    return new PMAPlayer(ply);
   }
   /**
    * Does basic checks that the player exists before lazy initializing the player
@@ -22,7 +22,13 @@ class PMAPlayerWrapper extends Player {
     if (!DoesPlayerExist(source)) {
       return null;
     }
-    return new PMAPlayerWrapper(source);
+    return new PMAPlayer(source);
+  }
+  /**
+   * Creates the player from the source without doing any validity checks
+   */
+  static from_source_unchecked(source) {
+    return new CommonPMAPlayer(source);
   }
   constructor(source) {
     if (typeof source !== "number") {
@@ -33,51 +39,6 @@ class PMAPlayerWrapper extends Player {
       super(source);
     }
   }
-  // Ensure we initialize the player whenever we're doing something that needs it.
-  ensure_init() {
-    if (!this.#pma_player) {
-      this.#pma_player = exports["pma"].from_source(this.Source);
-    }
-  }
-  send_notification(title, description, variant = "default") {
-    const noti = {
-      title,
-      body: description,
-      variant
-    };
-    this.emit("pma:add_notifications", noti);
-  }
-  send_notification_object(partial) {
-    this.emit("pma:add_notification", partial);
-  }
-  get_sex() {
-    this.ensure_init();
-    return this.#pma_player.get_sex();
-  }
-  get_height() {
-    this.ensure_init();
-    return this.#pma_player.get_height();
-  }
-  get_dob() {
-    this.ensure_init();
-    return this.#pma_player.get_dob();
-  }
-  get_unique_id() {
-    this.ensure_init();
-    return this.#pma_player.get_unique_id();
-  }
-  get_call_sign() {
-    this.ensure_init();
-    return this.#pma_player.get_call_sign();
-  }
-  get_character_name() {
-    this.ensure_init();
-    return this.#pma_player.get_character_name();
-  }
-  get_log_name() {
-    this.ensure_init();
-    return this.#pma_player.get_character_name();
-  }
   get_item(item_name) {
     this.ensure_init();
     return this.#pma_player.get_item(item_name);
@@ -86,39 +47,7 @@ class PMAPlayerWrapper extends Player {
     this.ensure_init();
     return this.#pma_player.add_item(item_name, quantity);
   }
-  remove_item(item_name, quantity) {
-    this.ensure_init();
-    return this.#pma_player.remove_item(item_name, quantity);
-  }
-  has_enough_of_item(item_name, quantity) {
-    this.ensure_init();
-    return this.#pma_player.has_enough_of_item(item_name, quantity);
-  }
-  get_job() {
-    this.ensure_init();
-    return this.#pma_player.get_job();
-  }
-  set_job(job_name, rank) {
-    this.ensure_init();
-    return this.#pma_player.set_job(job_name, rank);
-  }
-  get_bank() {
-    this.ensure_init();
-    return this.#pma_player.get_bank();
-  }
-  add_to_bank(positive_amount) {
-    this.ensure_init();
-    return this.#pma_player.add_to_bank(positive_amount);
-  }
-  remove_from_bank(negative_amount) {
-    this.ensure_init();
-    return this.#pma_player.remove_from_bank(negative_amount);
-  }
-  save() {
-    this.ensure_init();
-    return this.#pma_player.save();
-  }
 }
 export {
-  PMAPlayerWrapper
+  PMAPlayer
 };

package/decors/PMANetEvent.d.ts

@@ -0,0 +1,10 @@
+import { PMAPlayer } from "../class/PMAPlayer";
+type PMAServerEventType = (player: PMAPlayer, ...args: any[]) => Promise<void> | void;
+/**
+ * Registers the Net Event call for {@link eventName} to this method
+ *
+ * @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 OnPMANetEvent(eventName: string): (originalMethod: PMAServerEventType, context: ClassMethodDecoratorContext) => void;
+export {};

package/decors/{PMAServerEvent.js → PMANetEvent.js}

@@ -1,7 +1,7 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-import { PMAPlayerWrapper } from "../class/PMAPlayer";
-function PMAServerEvent(eventName) {
+import { PMAPlayer } from "../class/PMAPlayer";
+function OnPMANetEvent(eventName) {
   return /* @__PURE__ */ __name(function actualDecorator(originalMethod, context) {
     if (context.private) {
       throw new Error("NetEvent does not work on private methods, please mark the method as public");
@@ -9,7 +9,7 @@ function PMAServerEvent(eventName) {
     context.addInitializer(function() {
       const _t = this;
       onNet(eventName, async (...args) => {
-        const ply = new PMAPlayerWrapper(source);
+        const ply = new PMAPlayer(source);
         if (_t.__permissionMap) {
           const permissions = _t.__permissionMap.get(context.name);
           if (permissions) {
@@ -40,7 +40,7 @@ function PMAServerEvent(eventName) {
     });
   }, "actualDecorator");
 }
-__name(PMAServerEvent, "PMAServerEvent");
+__name(OnPMANetEvent, "OnPMANetEvent");
 export {
-  PMAServerEvent
+  OnPMANetEvent
 };

package/decors/RegisterUsableItems.d.ts

@@ -1,9 +1,10 @@
-import type { ItemName } from "@common-types/Inventory";
 import type { UsableItemCall } from "../types/Inventory";
+import type { ItemName } from "@redm-types/Inventory";
 /**
- * Registers the Net Event call for {@link eventName} to this method
+ * Registers the {@link item_name} to be usable
  *
- * @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
+ * NOTE: On RedM the item needs to have its usable flag for this to work.
+ *
+ * @param item_name The item to make usable
  */
 export declare function RegisterUsableItem(item_name: ItemName): (originalMethod: UsableItemCall, context: ClassMethodDecoratorContext) => void;

package/decors/RegisterUsableItems.js

@@ -1,11 +1,10 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 import { PMA } from "../PMA";
-import { PMAPlayerWrapper } from "../class/PMAPlayer";
 function RegisterUsableItem(item_name) {
   return /* @__PURE__ */ __name(function actualDecorator(originalMethod, context) {
     if (context.private) {
-      throw new Error("NetEvent does not work on private methods, please mark the method as public");
+      throw new Error("RegisterUsableItem does not work on private methods, please mark the method as public");
     }
     context.addInitializer(function() {
       const t = this;

package/index.d.ts

@@ -1,7 +1,5 @@
 export * from "./PMA";
 export * from "./types/Inventory";
-export * from "./decors/PMANetServerEvent";
-export * from "./decors/PMAServerEvent";
+export * from "./decors/PMANetEvent";
 export * from "./decors/RegisterUsableItems";
-export * from "./class/PMAPlayer";
-export * from "./class/PMAPlayerWrapper";
+export * from "./class/PMAPlayer";

package/index.js

@@ -1,7 +1,5 @@
 export * from "./PMA";
 export * from "./types/Inventory";
-export * from "./decors/PMANetServerEvent";
-export * from "./decors/PMAServerEvent";
+export * from "./decors/PMANetEvent";
 export * from "./decors/RegisterUsableItems";
-export * from "./class/PMAPlayer";
-export * from "./class/PMAPlayerWrapper";
+export * from "./class/PMAPlayer";

package/package.json

@@ -5,7 +5,7 @@
     "Dillon Skaggs <AvarianKnight>"
   ],
   "type": "module",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "files": [
     "./**/*.js",
     "./**/*.d.ts"

package/types/Inventory.d.ts

@@ -1,7 +1,7 @@
-import type { BaseInventory, InventoryItem } from "@common-types/Inventory";
-import type { AbstractPMAPlayer } from "@common-types/PMAPlayer";
-import type { PMAPlayerWrapper } from "../class/PMAPlayerWrapper";
-export type UsableItemCall = (ply: PMAPlayerWrapper, inventory: BaseInventory, item: InventoryItem) => void;
+import type { PMAPlayer } from "../class/PMAPlayer";
+import type { BaseInventory, InventoryItem } from "@redm-types/Inventory";
+import type { AbstractPMAPlayer } from "@redm-types/PMAPlayer";
+export type UsableItemCall = (ply: PMAPlayer, inventory: BaseInventory, item: InventoryItem) => void;
 export type UsableItemCallShared = (ply: AbstractPMAPlayer, inventory: BaseInventory, item: InventoryItem) => void;
 export type UsableItems = {
     fn: UsableItemCallShared;

package/class/PMAPlayerWrapper.d.ts

@@ -1,37 +0,0 @@
-import { Player } from "@nativewrappers/server";
-import type { ItemName, OptionalItem } from "redm-types/Inventory";
-import type { NotificationVariant, PMAPartialNotification } from "redm-types/Notifications";
-import type { AbstractPMAPlayer, CallSign, PlayerJob, PlayerUID } from "redm-types/PMAPlayer";
-export declare class PMAPlayerWrapper extends Player implements AbstractPMAPlayer {
-    #private;
-    /**
-     * Creates the player from the ScRT msgpack'd class
-     */
-    static from_raw(ply: AbstractPMAPlayer): PMAPlayerWrapper;
-    /**
-     * Does basic checks that the player exists before lazy initializing the player
-     */
-    static from_source(source: number): PMAPlayerWrapper | null;
-    constructor(source: number);
-    constructor(pma_player: AbstractPMAPlayer);
-    ensure_init(): void;
-    show_notification(title?: string, description?: string, variant?: NotificationVariant): void;
-    show_notification_object(partial: PMAPartialNotification): void;
-    get_sex(): number;
-    get_height(): number;
-    get_dob(): string;
-    get_unique_id(): PlayerUID;
-    get_call_sign(): CallSign;
-    get_character_name(): string;
-    get_log_name(): string;
-    get_item(item_name: ItemName): OptionalItem;
-    add_item(item_name: ItemName, quantity: number): OptionalItem;
-    remove_item(item_name: ItemName, quantity: number): void;
-    has_enough_of_item(item_name: ItemName, quantity: number): boolean;
-    get_job(): PlayerJob;
-    set_job(job_name: string, rank: number): void;
-    get_bank(): number;
-    add_to_bank(positive_amount: number): void;
-    remove_from_bank(negative_amount: number): void;
-    save(): Promise<void>;
-}

package/class/PMAPlayerWrapper.js

@@ -1,124 +0,0 @@
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-import { Player } from "@nativewrappers/server";
-class PMAPlayerWrapper extends Player {
-  static {
-    __name(this, "PMAPlayerWrapper");
-  }
-  // This will get lazy-initialized whenever we actually call a function that needs it,
-  // this will make sure we don't pay the un-needed serialize cost if we're only using this for
-  // basic nativewrappers types
-  #pma_player;
-  /**
-   * Creates the player from the ScRT msgpack'd class
-   */
-  static from_raw(ply) {
-    return new PMAPlayerWrapper(ply);
-  }
-  /**
-   * Does basic checks that the player exists before lazy initializing the player
-   */
-  static from_source(source) {
-    if (!DoesPlayerExist(source)) {
-      return null;
-    }
-    return new PMAPlayerWrapper(source);
-  }
-  constructor(source) {
-    if (typeof source !== "number") {
-      const ply = source;
-      super(ply.source);
-      this.#pma_player = ply;
-    } else {
-      super(source);
-    }
-  }
-  // Ensure we initialize the player whenever we're doing something that needs it.
-  ensure_init() {
-    if (!this.#pma_player) {
-      this.#pma_player = exports["pma"].from_source(this.Source);
-    }
-  }
-  show_notification(title, description, variant = "default") {
-    const noti = {
-      title,
-      body: description,
-      variant
-    };
-    this.emit("pma:add_notifications", noti);
-  }
-  show_notification_object(partial) {
-    this.emit("pma:add_notification", partial);
-  }
-  get_sex() {
-    this.ensure_init();
-    return this.#pma_player.get_sex();
-  }
-  get_height() {
-    this.ensure_init();
-    return this.#pma_player.get_height();
-  }
-  get_dob() {
-    this.ensure_init();
-    return this.#pma_player.get_dob();
-  }
-  get_unique_id() {
-    this.ensure_init();
-    return this.#pma_player.get_unique_id();
-  }
-  get_call_sign() {
-    this.ensure_init();
-    return this.#pma_player.get_call_sign();
-  }
-  get_character_name() {
-    this.ensure_init();
-    return this.#pma_player.get_character_name();
-  }
-  get_log_name() {
-    this.ensure_init();
-    return this.#pma_player.get_log_name();
-  }
-  get_item(item_name) {
-    this.ensure_init();
-    return this.#pma_player.get_item(item_name);
-  }
-  add_item(item_name, quantity) {
-    this.ensure_init();
-    return this.#pma_player.add_item(item_name, quantity);
-  }
-  remove_item(item_name, quantity) {
-    this.ensure_init();
-    return this.#pma_player.remove_item(item_name, quantity);
-  }
-  has_enough_of_item(item_name, quantity) {
-    this.ensure_init();
-    return this.#pma_player.has_enough_of_item(item_name, quantity);
-  }
-  get_job() {
-    this.ensure_init();
-    return this.#pma_player.get_job();
-  }
-  set_job(job_name, rank) {
-    this.ensure_init();
-    return this.#pma_player.set_job(job_name, rank);
-  }
-  get_bank() {
-    this.ensure_init();
-    return this.#pma_player.get_bank();
-  }
-  add_to_bank(positive_amount) {
-    this.ensure_init();
-    return this.#pma_player.add_to_bank(positive_amount);
-  }
-  remove_from_bank(negative_amount) {
-    this.ensure_init();
-    return this.#pma_player.remove_from_bank(negative_amount);
-  }
-  save() {
-    this.ensure_init();
-    return this.#pma_player.save();
-  }
-}
-export {
-  PMAPlayerWrapper
-};

package/decors/PMANetServerEvent.d.ts

@@ -1,10 +0,0 @@
-import { PMAPlayerWrapper } from "../class/PMAPlayerWrapper";
-type PMAServerEventType = (player: PMAPlayerWrapper, ...args: any[]) => Promise<void> | void;
-/**
- * Registers the Net Event call for {@link eventName} to this method
- *
- * @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 PMAServerEvent(eventName: string): (originalMethod: PMAServerEventType, context: ClassMethodDecoratorContext) => void;
-export {};

package/decors/PMANetServerEvent.js

@@ -1,46 +0,0 @@
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-import { PMAPlayerWrapper } from "../class/PMAPlayerWrapper";
-function PMAServerEvent(eventName) {
-  return /* @__PURE__ */ __name(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, async (...args) => {
-        const ply = new PMAPlayerWrapper(source);
-        if (_t.__permissionMap) {
-          const permissions = _t.__permissionMap.get(context.name);
-          if (permissions) {
-            let hasPermission = false;
-            for (const perm of permissions) {
-              if (ply.isAceAllowed(perm)) {
-                hasPermission = true;
-                break;
-              }
-            }
-            if (!hasPermission) {
-              emit("@nativewrappers:no_permission", { eventName, method: context.name, source: ply.Source });
-              return;
-            }
-          }
-        }
-        try {
-          return await originalMethod.call(this, ply, ...args);
-        } catch (e) {
-          console.error("------- NET EVENT ERROR --------");
-          console.error(`Call to ${eventName} errored`);
-          console.error(`Caller: ${ply.Source}`);
-          console.error(`Data: ${JSON.stringify(args)}`);
-          console.error(`Error: ${e}`);
-          console.error("------- END NET EVENT ERROR --------");
-        }
-      });
-    });
-  }, "actualDecorator");
-}
-__name(PMAServerEvent, "PMAServerEvent");
-export {
-  PMAServerEvent
-};

package/decors/PMAServerEvent.d.ts

@@ -1,10 +0,0 @@
-import { PMAPlayerWrapper } from "../class/PMAPlayer";
-type PMAServerEventType = (player: PMAPlayerWrapper, ...args: any[]) => Promise<void> | void;
-/**
- * Registers the Net Event call for {@link eventName} to this method
- *
- * @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 PMAServerEvent(eventName: string): (originalMethod: PMAServerEventType, context: ClassMethodDecoratorContext) => void;
-export {};