@pma-network/shared-server 0.0.8 → 0.0.12

package/class/CommonPMAPlayer.d.ts

@@ -1,8 +1,7 @@
 import { Player } from "@nativewrappers/server";
-import type { ItemName } from "@redm-types/Inventory";
-import type { NotificationVariant, PMAPartialNotification } from "@redm-types/Notifications";
 import type { CommonAbstractPMAPlayer } from "../types/CommonAbstractPMAPlayer";
-import type { CallSign, PlayerJob, PlayerUID } from "../types/SharedTypes";
+import type { CommonNotificationVariant, CommonPMAPartialNotification } from "../types/CommonNotifications";
+import type { CallSign, ItemName, PlayerJob, PlayerUID } from "../types/SharedTypes";
 export declare class CommonPMAPlayer extends Player implements CommonAbstractPMAPlayer {
     #private;
     /**
@@ -20,8 +19,9 @@ export declare class CommonPMAPlayer extends Player implements CommonAbstractPMA
     constructor(source: number);
     constructor(pma_player: CommonAbstractPMAPlayer);
     ensure_init(): void;
-    send_notification(title?: string, description?: string, variant?: NotificationVariant, duration?: number): void;
-    send_notification_object(partial: PMAPartialNotification): void;
+    is_player_valid(): boolean;
+    send_notification(title?: string, description?: string, variant?: CommonNotificationVariant, duration?: number): void;
+    send_notification_object(partial: CommonPMAPartialNotification): void;
     get_sex(): number;
     get_height(): number;
     get_dob(): string;

package/class/CommonPMAPlayer.js

@@ -2,6 +2,7 @@ var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 import { Player } from "@nativewrappers/server";
 import { framework_name } from "../utils/FrameworkName";
+import { pma_get_player_from_id } from "../utils/GlobalOverrides";
 class CommonPMAPlayer extends Player {
   static {
     __name(this, "CommonPMAPlayer");
@@ -9,7 +10,7 @@ class CommonPMAPlayer extends Player {
   // 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;
+  #pma_player = null;
   /**
    * Creates the player from the ScRT msgpack'd class
    */
@@ -43,9 +44,20 @@ class CommonPMAPlayer extends Player {
   // Ensure we initialize the player whenever we're doing something that needs it.
   ensure_init() {
     if (!this.#pma_player) {
-      this.#pma_player = exports[framework_name].from_source(this.Source);
+      this.#pma_player = globalThis.pma_get_player_from_id ? (
+        // @ts-ignore: we override this in GlobalOverrides
+        globalThis.pma_get_player_from_id(this.Source)
+      ) : pma_get_player_from_id(this.Source);
     }
   }
+  /*
+   * This will initialize the player and check that the player exists
+   * @returns `true` if the player is loaded in the framework or `false` otherwise
+   */
+  is_player_valid() {
+    this.ensure_init();
+    return this.#pma_player !== null;
+  }
   send_notification(title, description, variant = "default", duration = 5e3) {
     const noti = {
       body: description,

package/index.d.ts

@@ -1,7 +1,9 @@
 export * from "./CommonPMA";
 export * from "./utils/CooldownTracker";
 export * from "./utils/FrameworkName";
+export * from "./utils/GlobalOverrides";
 export * from "./utils/InfractionsWrapper";
 export * from "./types/CommonAbstractPMAPlayer";
+export * from "./types/CommonNotifications";
 export * from "./types/SharedTypes";
 export * from "./class/CommonPMAPlayer";

package/index.js

@@ -1,7 +1,9 @@
 export * from "./CommonPMA";
 export * from "./utils/CooldownTracker";
 export * from "./utils/FrameworkName";
+export * from "./utils/GlobalOverrides";
 export * from "./utils/InfractionsWrapper";
 export * from "./types/CommonAbstractPMAPlayer";
+export * from "./types/CommonNotifications";
 export * from "./types/SharedTypes";
 export * from "./class/CommonPMAPlayer";

package/package.json

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

package/types/CommonNotifications.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 CommonNotificationVariant = "default" | "error" | "success";
+export type CommonPMAPartialNotification = Omit<CommonPMANotification, "id">;
+export type CommonPMANotification = {
+    id: number;
+    title?: string;
+    body?: string;
+    variant: CommonNotificationVariant;
+    duration?: number;
+    position?: Position;
+    timeout?: number;
+};

package/utils/GlobalOverrides.d.ts

@@ -0,0 +1,3 @@
+import type { CommonPMAPlayer } from "../class/CommonPMAPlayer";
+import type { Source } from "../types/SharedTypes";
+export declare function pma_get_player_from_id(source: Source): CommonPMAPlayer;

package/utils/GlobalOverrides.js

@@ -0,0 +1,11 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+import { framework_name } from "./FrameworkName";
+function pma_get_player_from_id(source) {
+  return exports[framework_name].from_source(source);
+}
+__name(pma_get_player_from_id, "pma_get_player_from_id");
+globalThis.pma_get_player_from_id = pma_get_player_from_id;
+export {
+  pma_get_player_from_id
+};