feat: useServerWeather, update deps, fix _id deprecation (#30)

Stuyk · Jun 5, 2024 · 9d9fcac · 9d9fcac
1 parent 4543f8e
commit 9d9fcac
Show file tree

Hide file tree

Showing 10 changed files with 132 additions and 40 deletions.
diff --git a/docs/api/server/systems/useServerWeather.md b/docs/api/server/systems/useServerWeather.md
@@ -0,0 +1,25 @@
+# useServerWeather
+
+This stores server weather during runtime, and allows for weather to be shared to other plugins.
+
+Additionally, when these functions are used the internal RebarEvents for weather changes are invoked.
+
+```ts
+import * as alt from 'alt-server';
+import { useRebar } from '@Server/index.js';
+
+const Rebar = useRebar();
+const serverWeather = Rebar.useServerWeather();
+
+function whatever() {
+    // Used as a way to store the current weather on server-side for other plugins
+    serverWeather.set('CLEARING');
+
+    // Used as a way to show a weather forecast for the upcoming weather events
+    serverWeather.setForecast(['CLEAR', 'CLOUDS', 'RAIN', 'THUNDER', 'FOGGY', 'CLOUDS', 'CLEARING', 'EXTRASUNNY'])
+
+    const currentWeather = serverWeather.get();
+
+    const currentForecast = serverWeather.getForecast();
+}
+```
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -4,6 +4,21 @@ order: -5
 
 # Changelog
 
+## Version 15
+
+### Code Changes
+
+- Update dependencies
+- Update `_id` in database functions to use a non-deprecated ObjectId handler
+- Added `useServerWeather` function to allow setting weather and weather forecast
+  - This does not automatically sync for players, it's just a global way to set the data
+
+### Docs Changes
+
+- Added `useServerWeather` docs
+
+---
+
 ## Version 14
 
 ### Code Changes

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "author": "stuyk",
     "type": "module",
-    "version": "14",
+    "version": "15",
     "scripts": {
         "dev": "nodemon -x pnpm start",
         "dev:linux": "nodemon -x pnpm start:linux",
@@ -18,12 +18,13 @@
         "@altv/types-server": "^16.2.1",
         "@altv/types-shared": "^16.2.1",
         "@altv/types-webview": "^16.2.1",
-        "@types/node": "^20.14.0",
+        "@altv/types-worker": "^16.2.0",
+        "@types/node": "^20.14.1",
         "altv-pkg": "^2.7.5",
         "autoprefixer": "^10.4.19",
         "fast-glob": "^3.3.2",
         "fkill": "^9.0.0",
-        "nodemon": "^3.1.2",
+        "nodemon": "^3.1.3",
         "postcss": "^8.4.38",
         "prettier": "^3.3.0",
         "prettier-plugin-tailwindcss": "^0.5.14",
@@ -33,7 +34,6 @@
         "tailwindcss": "^3.4.3"
     },
     "dependencies": {
-        "@altv/types-worker": "^16.2.0",
         "@vitejs/plugin-vue": "^5.0.5",
         "dotenv": "^16.4.5",
         "mongodb": "^6.7.0",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/main/client/player/camera.ts b/src/main/client/player/camera.ts
@@ -14,10 +14,13 @@ function destroy() {
         alt.clearInterval(interval);
     } catch(err) {}
 
-    interval = undefined;
+    try {
+        native.setCamActive(camera, false);
+    } catch(err) {}
+
     native.destroyAllCams(true);
-    native.setCamActive(camera, false);
     native.renderScriptCams(false, false, 0, false, false, 0);
+    interval = undefined;
     camera = undefined;
 }
 

diff --git a/src/main/server/controllers/interaction.ts b/src/main/server/controllers/interaction.ts
@@ -45,6 +45,10 @@ function isValid(entity: alt.Entity, interaction: InteractionInternal) {
         valid = true;
     }
 
+    if (interaction.type === 'any') {
+        valid = true;
+    }
+
     return valid;
 }
 

diff --git a/src/main/server/database/index.ts b/src/main/server/database/index.ts
@@ -110,7 +110,7 @@ export function useDatabase() {
         try {
             const result = await client
                 .collection(collection)
-                .findOneAndUpdate({ _id: new ObjectId(data._id) }, { $set: dataClone });
+                .findOneAndUpdate({ _id: ObjectId.createFromHexString(data._id) }, { $set: dataClone });
             return result.ok ? true : false;
         } catch (err) {
             return false;
@@ -131,7 +131,7 @@ export function useDatabase() {
         const client = await getClient();
 
         try {
-            const result = await client.collection(collection).deleteOne({ _id: new ObjectId(_id) });
+            const result = await client.collection(collection).deleteOne({ _id: ObjectId.createFromHexString(_id) });
             return result.deletedCount >= 1;
         } catch (err) {
             return false;
@@ -151,7 +151,7 @@ export function useDatabase() {
      * @param {string} collection
      * @return {(Promise<T | undefined>)}
      */
-    async function get<T extends { [key: string]: any; _id?: string | ObjectId }>(
+    async function get<T extends { [key: string]: any; _id?: string }>(
         dataToMatch: Partial<T>,
         collection: string,
     ): Promise<T | undefined> {
@@ -161,7 +161,7 @@ export function useDatabase() {
             const dataLookup: any = { ...dataToMatch };
 
             if (dataToMatch._id) {
-                dataLookup._id = new ObjectId(dataToMatch._id);
+                dataLookup._id = ObjectId.createFromHexString(dataToMatch._id)
             }
 
             const document = await client.collection(collection).findOne<T>(dataLookup);
@@ -195,7 +195,7 @@ export function useDatabase() {
             const dataLookup: any = { ...dataToMatch };
 
             if (dataToMatch._id) {
-                dataLookup._id = new ObjectId(dataToMatch._id);
+                dataLookup._id = ObjectId.createFromHexString(dataToMatch._id);
             }
 
             const cursor = await client.collection(collection).find<T>(dataLookup);
@@ -246,7 +246,7 @@ export function useDatabase() {
         const client = await getClient();
 
         try {
-            const result = await client.collection(collection).deleteOne({ _id: new ObjectId(_id) });
+            const result = await client.collection(collection).deleteOne({ _id: ObjectId.createFromHexString(_id) });
             return result.acknowledged;
         } catch (err) {
             return false;

diff --git a/src/main/server/events/index.ts b/src/main/server/events/index.ts
@@ -2,8 +2,11 @@ import * as alt from 'alt-server';
 import { Account } from '@Shared/types/account.js';
 import { Character } from '@Shared/types/character.js';
 import { Vehicle } from '@Shared/types/vehicle.js';
+import { Weathers } from '@Shared/data/weathers.js';
 
 type RebarEvents = {
+    'weather-forecast-changed': (weather: Weathers[])=> void;
+    'weather-changed': (weather: Weathers) => void;
     'time-changed': (hour: number, minute: number, second: number) => void;
     'time-second-changed': (minute: number) => void;
     'time-minute-changed': (minute: number) => void;
@@ -17,6 +20,8 @@ type RebarEvents = {
 type EventCallbacks<K extends keyof RebarEvents> = { [key in K]: RebarEvents[K][] };
 
 const eventCallbacks: EventCallbacks<keyof RebarEvents> = {
+    'weather-forecast-changed': [],
+    'weather-changed': [],
     'time-changed': [],
     'time-second-changed': [],
     'time-hour-changed': [],

diff --git a/src/main/server/index.ts b/src/main/server/index.ts
@@ -58,6 +58,7 @@ import { check, hash } from './utility/password.js';
 import { useVehicle } from './vehicle/index.js';
 import { useProtectCallback } from './utility/protectCallback.js';
 import { useServerTime } from './systems/serverTime.js';
+import { useServerWeather } from './systems/serverWeather.js';
 
 export function useRebar() {
     return {
@@ -135,6 +136,7 @@ export function useRebar() {
         },
         usePlayer,
         useServerTime,
+        useServerWeather,
         utility: {
             sha256,
             sha256Random,