@sanctumterra/raknet 1.3.0 → 1.3.2

package/.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Publish to NPM
+
+on:
+  push:
+    branches:
+      - develop
+      - main  # Change this to your default branch if different
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'  # Ensure this matches your engines.node version
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run lint
+        run: npm run lint
+
+      - name: Clean build directory
+        run: rm -rf build dist  # Clean previous build artifacts
+
+      - name: Build Rust
+        run: npm run build:rust
+
+      - name: Build TypeScript
+        run: npm run build:ts
+
+      - name: Publish to NPM
+        run: npm publish --access=public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "raknet"
+version = "0.1.0"
+edition = "2021"
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+chrono = "0.4.38"
+rand = "0.8.5"
+napi = "2"
+napi-derive = "2"
+
+[build-dependencies]
+napi-build = "2.1.3"

package/build.rs

@@ -0,0 +1,3 @@
+fn main() {
+    napi_build::setup();
+}

package/dist/client/client-events.d.ts

@@ -0,0 +1,22 @@
+import type { Ack, ConnectedPing, ConnectionRequest, NewIncomingConnection, OpenConnectionReplyOne, OpenConnectionReplyTwo, OpenConnectionRequestOne, OpenConnectionRequestTwo, UnconnectedPing, UnconnectedPong, Frameset, Nack, ConnectedPong, ConnectionRequestAccepted } from "../proto";
+export interface ClientEvents {
+    "open-connection-reply-one": [OpenConnectionReplyOne];
+    "open-connection-reply-two": [OpenConnectionReplyTwo];
+    "open-connection-request-one": [OpenConnectionRequestOne];
+    "open-connection-request-two": [OpenConnectionRequestTwo];
+    "unconnected-ping": [UnconnectedPing];
+    "unconnected-pong": [UnconnectedPong];
+    frameset: [Frameset];
+    "connected-ping": [ConnectedPing];
+    "connection-request": [ConnectionRequest];
+    "new-incoming-connection": [NewIncomingConnection];
+    "connection-request-accepted": [ConnectionRequestAccepted];
+    "connected-pong": [ConnectedPong];
+    encapsulated: [Buffer];
+    ack: [Ack];
+    nack: [Nack];
+    error: [Error];
+    close: [];
+    connect: [];
+    tick: [];
+}

package/dist/client/client-events.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/client/client.d.ts

@@ -0,0 +1,15 @@
+import Emitter from "@serenityjs/emitter";
+import { type ClientOptions } from "./client_options";
+import type { ClientEvents } from "./client-events";
+export declare class Client extends Emitter<ClientEvents> {
+    private rakSocket;
+    options: ClientOptions;
+    ticker: NodeJS.Timeout;
+    tick: number;
+    private advertisement;
+    constructor(options: Partial<ClientOptions>);
+    connect(): Promise<string>;
+    ping(): Promise<string>;
+    frameAndSend(buffer: Buffer): void;
+    private handleData;
+}

package/dist/client/client.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+const emitter_1 = require("@serenityjs/emitter");
+const index_1 = require("../index");
+const client_options_1 = require("./client_options");
+const proto_1 = require("../proto");
+class Client extends emitter_1.default {
+    rakSocket;
+    options;
+    ticker;
+    tick = 0;
+    advertisement;
+    constructor(options) {
+        super();
+        this.options = { ...client_options_1.defaultClientOptions, ...options };
+        this.rakSocket = new index_1.RaknetClient(this.options.address, this.options.port, this.options.mtuSize);
+    }
+    async connect() {
+        this.rakSocket.connect();
+        this.ticker = setInterval(() => {
+            this.rakSocket.tick();
+            this.handleData(this.rakSocket.receive());
+            this.tick++;
+        }, 50);
+        await this.ping();
+        return new Promise((resolve, reject) => {
+            this.once("ack", () => {
+                resolve(this.advertisement);
+            });
+        });
+    }
+    async ping() {
+        return new Promise((resolve, reject) => {
+            const timeout = setTimeout(() => {
+                cleanup();
+                reject(new Error("Ping timeout"));
+            }, 5000);
+            const pongHandler = (pong) => {
+                this.advertisement = pong.message;
+                cleanup();
+                resolve(pong.message);
+            };
+            const cleanup = () => {
+                clearTimeout(timeout);
+                this.remove("unconnected-pong", pongHandler);
+            };
+            this.rakSocket.ping();
+            this.once("unconnected-pong", pongHandler);
+        });
+    }
+    frameAndSend(buffer) {
+        this.rakSocket.frameAndSend(buffer);
+    }
+    handleData(data) {
+        if (!data || data.length === 0) {
+            // console.log("Received empty data buffer");
+            return;
+        }
+        let packetId = data[0];
+        if ((packetId & 0xf0) === 0x80)
+            packetId = 0x80;
+        switch (packetId) {
+            case proto_1.Packet.Ack: {
+                const ack = new proto_1.Ack(data).deserialize();
+                this.emit("ack", ack);
+                break;
+            }
+            case proto_1.Packet.FrameSet: {
+                const frameset = new proto_1.Frameset(data).deserialize();
+                this.emit("frameset", frameset);
+                break;
+            }
+            case proto_1.Packet.ConnectedPing: {
+                const connectedPing = new proto_1.ConnectedPing(data).deserialize();
+                this.emit("connected-ping", connectedPing);
+                break;
+            }
+            case proto_1.Packet.ConnectionRequest: {
+                const connectionRequest = new proto_1.ConnectionRequest(data).deserialize();
+                this.emit("connection-request", connectionRequest);
+                break;
+            }
+            case proto_1.Packet.NewIncomingConnection: {
+                const newIncomingConnection = new proto_1.NewIncomingConnection(data).deserialize();
+                this.emit("new-incoming-connection", newIncomingConnection);
+                break;
+            }
+            case proto_1.Packet.UnconnectedPing: {
+                const unconnectedPing = new proto_1.UnconnectedPing(data).deserialize();
+                this.emit("unconnected-ping", unconnectedPing);
+                break;
+            }
+            case proto_1.Packet.UnconnectedPong: {
+                const unconnectedPong = new proto_1.UnconnectedPong(data).deserialize();
+                this.emit("unconnected-pong", unconnectedPong);
+                break;
+            }
+            case proto_1.Packet.Nack: {
+                const nack = new proto_1.Nack(data).deserialize();
+                this.emit("nack", nack);
+                break;
+            }
+            case proto_1.Packet.ConnectedPong: {
+                const connectedPong = new proto_1.ConnectedPong(data).deserialize();
+                this.emit("connected-pong", connectedPong);
+                break;
+            }
+            case proto_1.Packet.ConnectionRequestAccepted: {
+                const connectionRequestAccepted = new proto_1.ConnectionRequestAccepted(data).deserialize();
+                this.emit("connection-request-accepted", connectionRequestAccepted);
+                break;
+            }
+        }
+    }
+}
+exports.Client = Client;

package/dist/client/client_options.d.ts

@@ -0,0 +1,9 @@
+type ClientOptions = {
+    address: string;
+    port: number;
+    mtuSize: number;
+    debug: boolean;
+    timeout: number;
+};
+declare const defaultClientOptions: ClientOptions;
+export { type ClientOptions, defaultClientOptions };

package/dist/client/client_options.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultClientOptions = void 0;
+const defaultClientOptions = {
+    address: "127.0.0.1",
+    port: 19132,
+    mtuSize: 1492,
+    debug: false,
+    timeout: 5000,
+};
+exports.defaultClientOptions = defaultClientOptions;

package/dist/client/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./client";
+export * from "./client-events";
+export * from "./client_options";

package/dist/client/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client"), exports);
+__exportStar(require("./client-events"), exports);
+__exportStar(require("./client_options"), exports);

package/dist/proto/decorators/create.d.ts

@@ -0,0 +1,7 @@
+import type { BasePacket } from "../packets";
+/**
+ * Thanks to SerenityJS as an example.
+ * @param id
+ * @returns
+ */
+export declare function Create(id: number): (target: typeof BasePacket) => void;

package/dist/proto/decorators/create.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Create = Create;
+/**
+ * Thanks to SerenityJS as an example.
+ * @param id
+ * @returns
+ */
+function Create(id) {
+    return (target) => {
+        target.id = id;
+        const packetData = Reflect.getOwnMetadata("properties", target.prototype);
+        const properties = Reflect.getMetadata("properties", target) || [];
+        if (!properties.includes("serialize")) {
+            target.prototype.serialize = function () {
+                this.clear();
+                if (id < 1)
+                    throw new Error("Packet ID cannot be less than 1.");
+                if (id <= 255)
+                    this.writeUint8(id);
+                else if (id <= 65535)
+                    this.writeUint16(id);
+                else if (id <= 4294967295)
+                    this.writeUint32(id);
+                else
+                    throw new Error("Packet ID cannot be greater than 4294967295.");
+                if (!packetData)
+                    return this.getBuffer();
+                for (const { name, type, endian, parameter } of packetData) {
+                    if (parameter) {
+                        const value = this[parameter];
+                        const dtype = type;
+                        const data = this[name];
+                        dtype.write(this, data, endian, value);
+                    }
+                    else {
+                        const dtype = type;
+                        const data = this[name];
+                        dtype.write(this, data, endian);
+                    }
+                }
+                return Buffer.from(this.binary);
+            };
+        }
+        if (!properties.includes("deserialize")) {
+            target.prototype.deserialize = function () {
+                if (this.binary.length === 0)
+                    return this;
+                if (id <= 255)
+                    target.id = this.readUint8();
+                else if (id <= 65535)
+                    target.id = this.readUint16();
+                else if (id <= 4294967295)
+                    target.id = this.readUint32();
+                else
+                    throw new Error("Invalid packet ID range");
+                if (!packetData)
+                    return this;
+                for (const { name, type, endian, parameter } of packetData) {
+                    if (parameter) {
+                        const value = this[parameter];
+                        const dtype = type;
+                        const data = this[name];
+                        this[name] = dtype.read(this, endian, value);
+                    }
+                    else {
+                        const dtype = type;
+                        const data = this[name];
+                        this[name] = dtype.read(this, endian);
+                    }
+                }
+                return this;
+            };
+        }
+        if (!properties.includes("getId")) {
+            target.prototype.getId = () => target.id;
+        }
+    };
+}

package/dist/proto/decorators/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./create";
+export * from "./serialize";

package/dist/proto/decorators/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./create"), exports);
+__exportStar(require("./serialize"), exports);

package/dist/proto/decorators/serialize.d.ts

@@ -0,0 +1,3 @@
+import { Endianness } from "@serenityjs/binarystream";
+import type { ValidTypes } from "../types";
+export declare function Serialize(type: ValidTypes, endian?: Endianness | boolean, parameter?: string): (target: object, propertyKey: string) => void;

package/dist/proto/decorators/serialize.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Serialize = Serialize;
+function Serialize(type, endian = 0 /* Endianness.Big */, parameter) {
+    if (!type)
+        throw new Error("@Serialize() must be given a type.");
+    return (target, propertyKey) => {
+        const properties = Reflect.getMetadata("properties", target) || [];
+        properties.push({ name: propertyKey, type, endian, parameter });
+        Reflect.defineMetadata("properties", properties, target);
+    };
+}

package/dist/proto/enums/flags.d.ts

@@ -0,0 +1,6 @@
+export declare enum Flags {
+    Split = 16,
+    Valid = 128,
+    Ack = 64,
+    Nak = 32
+}

package/dist/proto/enums/flags.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Flags = void 0;
+var Flags;
+(function (Flags) {
+    Flags[Flags["Split"] = 16] = "Split";
+    Flags[Flags["Valid"] = 128] = "Valid";
+    Flags[Flags["Ack"] = 64] = "Ack";
+    Flags[Flags["Nak"] = 32] = "Nak";
+})(Flags || (exports.Flags = Flags = {}));

package/dist/proto/enums/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./packet";
+export * from "./flags";
+export * from "./reliability";
+export * from "./priority";

package/dist/proto/enums/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./packet"), exports);
+__exportStar(require("./flags"), exports);
+__exportStar(require("./reliability"), exports);
+__exportStar(require("./priority"), exports);

package/dist/proto/enums/packet.d.ts

@@ -0,0 +1,121 @@
+export declare enum Packet {
+    ConnectedPing = 0,
+    UnconnectedPing = 1,
+    UnconnectedPingOpenConnections = 2,
+    ConnectedPong = 3,
+    DetectLostConnections = 4,
+    OpenConnectionRequestOne = 5,
+    OpenConnectionReplyOne = 6,
+    OpenConnectionRequestTwo = 7,
+    OpenConnectionReplyTwo = 8,
+    ConnectionRequest = 9,
+    RemoteSystemRequiresPublicKey = 10,
+    OurSystemRequiresSecurity = 11,
+    PublicKeyMismatch = 12,
+    OutOfBandInternal = 13,
+    SndReceiptAcked = 14,
+    SndReceiptLoss = 15,
+    ConnectionRequestAccepted = 16,
+    ConnectionAttemptFailed = 17,
+    AlreadyConnected = 18,
+    NewIncomingConnection = 19,
+    NoFreeIncomingConnections = 20,
+    DisconnectionNotification = 21,
+    ConnectionLost = 22,
+    ConnectionBanned = 23,
+    InvalidPassword = 24,
+    IncompatibleProtocolVersion = 25,
+    IpRecentlyConnected = 26,
+    Timestamp = 27,
+    UnconnectedPong = 28,
+    AdvertiseSystem = 29,
+    DownloadProgress = 30,
+    RemoteDisconnectionNotification = 31,
+    RemoteConnectionLost = 32,
+    RemoteNewIncomingConnection = 33,
+    FileListTransferHeader = 34,
+    FileListTransferFile = 35,
+    FileListReferenceTransferFile = 36,
+    DdtDownloadRequest = 37,
+    TransportString = 38,
+    ReplicaManagerConstruction = 39,
+    ReplicaManagerScope = 40,
+    ReplicaManagerSerialize = 41,
+    ReplicaManagerDownloadStarted = 42,
+    ReplicaManagerDownloadComplete = 43,
+    ConnectionGraphRequest = 44,
+    ConnectionGraphReply = 45,
+    ConnectionGraphUpdate = 46,
+    ConnectionGraphNewConnection = 47,
+    ConnectionGraphConnectionLost = 48,
+    ConnectionGraphDisconnectionNotification = 49,
+    RouteAndMulticast = 50,
+    RakVoice = 51,
+    AutopatcherGetChangelistSinceDate = 52,
+    AutopatcherCreationList = 53,
+    AutopatcherDeletionList = 54,
+    AutopatcherGetPatch = 55,
+    AutopatcherPatchList = 56,
+    AutopatcherRepositoryFatalError = 57,
+    AutopatcherFinishedInternal = 58,
+    AutopatcherFinished = 59,
+    AutopatcherRestartApplication = 60,
+    NatPunchthroughRequest = 61,
+    NatTarget = 62,
+    NatTargetNotConnected = 63,
+    NatTargetConnectionLost = 64,
+    NatConnectAtTime = 65,
+    NatSendOfflineMessageAtTime = 66,
+    NatClientReady = 67,
+    NatPunchthroughFailed = 68,
+    NatPunchthroughSucceeded = 69,
+    FlexibleChat = 70,
+    ReadyEventSet = 71,
+    ReadyEventUnset = 72,
+    ReadyEventAllSet = 73,
+    ReadyEventQuery = 74,
+    LobbyGeneral = 75,
+    AutoRpcCall = 76,
+    AutoRpcRemoteIndex = 77,
+    AutoRpcUnknownRemoteIndex = 78,
+    RpcRemoteError = 79,
+    FileListTransferFile2 = 80,
+    FileListReferenceTransferFile2 = 81,
+    ChatCommand = 82,
+    ChatMessage = 83,
+    BridgeDataTransfer = 84,
+    ViveSync = 85,
+    ViveSyncUnreliable = 86,
+    ViveSyncPong = 87,
+    ConnectionRequestAcceptedEx = 88,
+    ConnectionAttemptFailedEx = 89,
+    NewIncomingConnectionEx = 90,
+    TwoWayAuthenticationNegotiation = 91,
+    TwoWayAuthenticationIncomingChallengeSuccess = 92,
+    TwoWayAuthenticationOutgoingChallengeSuccess = 93,
+    TwoWayAuthenticationIncomingChallengeFailure = 94,
+    TwoWayAuthenticationOutgoingChallengeFailure = 95,
+    TwoWayAuthenticationOutgoingChallengeTimeout = 96,
+    CloudPostRequest = 97,
+    CloudReleaseRequest = 98,
+    CloudGetRequest = 99,
+    CloudGetResponse = 100,
+    CloudUnsubscribeRequest = 101,
+    CloudServerToServerCommand = 102,
+    CloudSubscriptionNotification = 103,
+    LibVoice = 122,
+    RelayPlugin = 123,
+    NatRequestBoundAddresses = 124,
+    NatRespondBoundAddresses = 125,
+    Fcm2UpdateUserContext = 126,
+    Reserved3 = 127,
+    FrameSet = 128,// Set this to FrameSet cause only this will be used
+    Reserved5 = 129,
+    Reserved6 = 130,
+    Reserved7 = 131,
+    Reserved8 = 132,
+    Reserved9 = 133,
+    UserPacketEnum = 134,
+    Nack = 160,
+    Ack = 192
+}