prismarine-proxy 1.1.3 → 1.2.0

package/.github/workflows/ci.yml

@@ -13,7 +13,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x]
+        node-version: [24.x]
 
     steps:
     - uses: actions/checkout@v2

package/.github/workflows/commands.yml

@@ -0,0 +1,22 @@
+name: Repo Commands
+
+on:
+  issue_comment:        # Handle comment commands
+    types: [created]
+  pull_request:         # Handle renamed PRs
+    types: [edited]
+
+jobs:
+  comment-trigger:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v3
+    - name: Run command handlers
+      uses: PrismarineJS/prismarine-repo-actions@master
+      with:
+        # NOTE: You must specify a Personal Access Token (PAT) with repo access here. While you can use the default GITHUB_TOKEN, actions taken with it will not trigger other actions, so if you have a CI workflow, commits created by this action will not trigger it.
+        token: ${{ secrets.PAT_PASSWORD }}
+        # See `Options` section below for more info on these options
+        install-command: npm install
+        /fixlint.fix-command: npm run fix

package/.github/workflows/publish.yml

@@ -3,6 +3,9 @@ on:
   push:
     branches:
       - master # Change this to your default branch
+permissions:
+  id-token: write
+  contents: write
 jobs:
   npm-publish:
     name: npm-publish
@@ -13,13 +16,12 @@ jobs:
     - name: Set up Node.js
       uses: actions/setup-node@master
       with:
-        node-version: 14.0.0
+        node-version: 24
+        registry-url: 'https://registry.npmjs.org'
     - id: publish
-      uses: JS-DevTools/npm-publish@v1
-      with:
-        token: ${{ secrets.NPM_AUTH_TOKEN }}
+      uses: JS-DevTools/npm-publish@v4
     - name: Create Release
-      if: steps.publish.outputs.type != 'none'
+      if: ${{ steps.publish.outputs.type }}
       id: create_release
       uses: actions/create-release@v1
       env:

package/HISTORY.md

@@ -1,5 +1,21 @@
 ## History
 
+### 1.2.0
+* [Update CI to Node 24 (#48)](https://github.com/PrismarineJS/prismarine-proxy/commit/b53a1a358ca13998b98dba71587fede8819fb82d) (thanks @rom1504)
+* [Fix publish condition for npm-publish v4 (#47)](https://github.com/PrismarineJS/prismarine-proxy/commit/9ca382db63d45797d1fe0ce854ad5b6f3cec790d) (thanks @rom1504)
+* [Switch to trusted publishing via OIDC (#46)](https://github.com/PrismarineJS/prismarine-proxy/commit/974c931e42c97a6da64fc8a916101b807cd4beba) (thanks @rom1504)
+* [Fix version map and update example (#43)](https://github.com/PrismarineJS/prismarine-proxy/commit/83d9fb754e156b15c0ed678123e4ba017ce65399) (thanks @covyy)
+* [Bump mocha from 10.8.2 to 11.0.1 (#41)](https://github.com/PrismarineJS/prismarine-proxy/commit/71990b2422c433f591307ce51df74b99b911417a) (thanks @dependabot[bot])
+* [node 22 (#44)](https://github.com/PrismarineJS/prismarine-proxy/commit/693fc5eb83ce5d3ddcee7b1ad82b0949bbd5e6c1) (thanks @rom1504)
+* [Add command gh workflow allowing to use release command in comments (#39)](https://github.com/PrismarineJS/prismarine-proxy/commit/cff8e92e38e4215ba6ab70dc5cdf76eb9b59fb6f) (thanks @rom1504)
+* [Update to node 18.0.0 (#37)](https://github.com/PrismarineJS/prismarine-proxy/commit/e84f86e648a1306a0aa587c8d33573ae1ad33974) (thanks @rom1504)
+* [emit start event only on first login (#33)](https://github.com/PrismarineJS/prismarine-proxy/commit/b63daa676f3fff1ab24193eb598eea2f94652987) (thanks @willocn)
+* [Revise readme wording](https://github.com/PrismarineJS/prismarine-proxy/commit/881d9529a2bdec45794e97170ab69fb17ad9e66c) (thanks @u9g)
+
+### 1.1.4
+
+- Fix typescript types
+
 ### 1.1.3
 
 - Use minecraft-data's login packet if one is not in minecraft-packets

package/README.md

@@ -32,11 +32,11 @@ This is a proxy that will allow you to instantly connect to the target, so you w
 ```js
 const { InstantConnectProxy } = require('prismarine-proxy')
 
-const login = ['my@email.com', 'mypassword']
+const login = 'my@email.com' // microsoft email or minecraft username
 
 const proxy = new InstantConnectProxy({
   loginHandler: (client) => { // client object has a username object, so you can store usernames with their respective logins
-    return { username: login[0], password: login[1] } // the login the proxy will connect to the server with
+    return { username: login, auth: 'microsoft' } // the login the proxy will connect to the server with
   },
   serverOptions: { // options for the local server shown to the vanilla client
     version: '1.8.9'
@@ -58,4 +58,4 @@ proxy.on('outgoing', (data, meta, toClient, toServer) => { // packets outgoing f
 })
 ```
 
-The name of the particles can be found [here](https://minecraft-data.prismarine.js.org/) , make sure to select the version you are playing on at the top then click protocol, more info about packets can be found [here](https://wiki.vg/Protocol) , make sure to select the version you are working with
+Information about packets can be found [here](https://prismarinejs.github.io/minecraft-data/), make sure to select the minecraft version at the top, then click protocol.

package/examples/instant_connect_example.js

@@ -1,15 +1,16 @@
 const { InstantConnectProxy } = require('prismarine-proxy')
 const proxy = new InstantConnectProxy({
   loginHandler: (client) => {
-    if (client.username === 'U9G') return { username: 'john' }
-    else return { username: client.username }
+    if (client.username === 'U9G') return { username: 'john', auth: 'microsoft' }
+    else return { username: client.username, auth: 'microsoft' }
   },
   clientOptions: {
     host: 'localhost',
-    version: '1.8.9'
+    version: '1.18.2'
   },
   serverOptions: {
-    version: '1.8.9'
+    version: '1.18.2',
+    port: 25566
   }
 })
 

package/index.d.ts

@@ -10,7 +10,7 @@ interface ServerOptions {
     serverOptions?: protocolServerOptions;
     clientOptions?: Partial<protocolClientOptions>;
 }
-interface ProxyEvents {
+type ProxyEvents = {
     incoming: (data: any, meta: PacketMeta, toClient: ServerClient, toServer: Client) => void;
     outgoing: (data: any, meta: PacketMeta, toClient: ServerClient, toServer: Client) => void;
     start: (toClient: ServerClient, toServer: Client) => void;
@@ -27,4 +27,4 @@ declare class InstantConnectProxy extends ProxyHandler_base {
     clientIsOnline(client: ServerClient): boolean;
 }
 
-export { InstantConnectProxy }
+export { InstantConnectProxy }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prismarine-proxy",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "Provide features to build proxies using Prismarine modules",
   "main": "index.js",
   "scripts": {
@@ -24,7 +24,7 @@
   },
   "homepage": "https://github.com/PrismarineJS/prismarine-proxy#readme",
   "devDependencies": {
-    "mocha": "^10.0.0",
+    "mocha": "^11.0.1",
     "prismarine-proxy": "file:.",
     "standard": "^17.0.0"
   },
@@ -32,6 +32,7 @@
     "debug": "^4.3.1",
     "minecraft-data": "^3.0.0",
     "minecraft-packets": "^1.5.0",
-    "minecraft-protocol": "^1.13.0"
+    "minecraft-protocol": "^1.13.0",
+    "typed-emitter": "^2.1.0"
   }
 }

package/src/instant_connect_proxy.js

@@ -4,8 +4,7 @@ const packets = require('minecraft-packets').pc
 const mcDataLoader = require('minecraft-data')
 const PLAY_STATE = 'play'
 const verMap = {
-  '1.8.8': '1.8',
-  '1.8.9': '1.8'
+  '1.8.9': '1.8.8'
 }
 
 function getPacket (ver, name, mcData) {
@@ -13,7 +12,7 @@ function getPacket (ver, name, mcData) {
   if (name === 'login') {
     packet = packet ?? mcData.loginPacket
   }
-  if (!packet) throw new Error(`Packets for version ${ver} aren't stored. This can be fixed by dumping them adding them to the verMap if similar packets are stored.`)
+  if (!packet) throw new Error(`Packets for version ${ver} aren't stored. This can be fixed by adding them to the verMap if similar packets are stored.`)
   return packet
 }
 
@@ -45,7 +44,7 @@ class InstantConnectProxy extends EventEmitter {
 
     this.toServerClients.set(toClient.id, toServer)
 
-    toServer.on('login', (data) => {
+    toServer.once('login', (data) => {
       if (!this.clientIsOnline(toClient)) return
       this.emit('start', toClient, toServer)
       // https://github.com/VelocityPowered/Velocity/blob/aa210b3544556c46776976cddc45deb4ace9bb68/proxy/src/main/java/com/velocitypowered/proxy/connection/client/ClientPlaySessionHandler.java#L437