update

.github/CROSS_REPO_TRIGGER.md

@@ -0,0 +1,96 @@
+# Cross-Repository Workflow Trigger Setup
+
+This document explains how to set up cross-repository workflow triggering between the minecraft-data repository and this repository.
+
+## Overview
+
+The workflow `update-from-minecraft-data.yml` can be triggered from the minecraft-data repository in two ways:
+
+1. **Manual Workflow Dispatch** - Triggered manually or programmatically
+2. **Repository Dispatch** - Triggered via webhook/API call
+
+## Setup in minecraft-data repository
+
+### Method 1: Workflow Dispatch (Recommended)
+
+Add this step to a workflow in the minecraft-data repository:
+
+```yaml
+- name: Trigger update in node-minecraft-protocol
+  uses: actions/github-script@v7
+  with:
+    github-token: ${{ secrets.CROSS_REPO_TOKEN }}
+    script: |
+      await github.rest.actions.createWorkflowDispatch({
+        owner: 'extremeheat',
+        repo: 'node-minecraft-protocol',
+        workflow_id: 'update-from-minecraft-data.yml',
+        ref: 'master', // or the target branch
+        inputs: {
+          trigger_source: 'minecraft-data',
+          trigger_reason: 'data_update',
+          data_version: '${{ steps.get_version.outputs.version }}' // or your version variable
+        }
+      });
+```
+
+### Method 2: Repository Dispatch
+
+```yaml
+- name: Trigger update in node-minecraft-protocol
+  uses: actions/github-script@v7
+  with:
+    github-token: ${{ secrets.CROSS_REPO_TOKEN }}
+    script: |
+      await github.rest.repos.createDispatchEvent({
+        owner: 'extremeheat',
+        repo: 'node-minecraft-protocol',
+        event_type: 'minecraft-data-update',
+        client_payload: {
+          repository: 'minecraft-data',
+          reason: 'data_update',
+          version: '${{ steps.get_version.outputs.version }}'
+        }
+      });
+```
+
+## Required Secrets
+
+You need to create a Personal Access Token (PAT) with the following permissions:
+- `repo` scope (for private repositories)
+- `public_repo` scope (for public repositories)
+- `actions:write` permission
+
+Add this token as a secret named `CROSS_REPO_TOKEN` in the minecraft-data repository.
+
+## Token Setup Steps
+
+1. Go to GitHub Settings > Developer settings > Personal access tokens > Tokens (classic)
+2. Generate a new token with appropriate permissions
+3. Add the token as `CROSS_REPO_TOKEN` secret in minecraft-data repository settings
+
+## Customizing the Updator Script
+
+The updator script (`.github/helper/updator.js`) can be customized to:
+
+- Download and process minecraft-data updates
+- Update protocol definitions
+- Run tests to verify compatibility
+- Create pull requests for review
+- Send notifications
+
+## Testing
+
+You can test the workflow manually by:
+
+1. Going to the Actions tab in this repository
+2. Selecting "Update from minecraft-data" workflow
+3. Clicking "Run workflow"
+4. Providing test inputs
+
+## Security Considerations
+
+- Use repository secrets for sensitive tokens
+- Limit token permissions to minimum required
+- Consider using short-lived tokens or GitHub Apps for enhanced security
+- Review and approve automatic commits/PRs if needed

.github/helper/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "gh-helpers": "^1.0.0"
+  }
+}

.github/helper/updator.js

@@ -0,0 +1,100 @@
+#!/usr/bin/env node
+/**
+ * Updator script triggered from minecraft-data repository to auto generate PR
+ */
+const fs = require('fs')
+const cp = require('child_process')
+const assert = require('assert')
+const github = require('gh-helpers')()
+const { join } = require('path')
+const exec = (cmd) => github.mock ? console.log('> ', cmd) : (console.log('> ', cmd), cp.execSync(cmd, { stdio: 'inherit' }))
+
+console.log('Starting update process...')
+// Sanitize and validate environment variables all non alpha numeric / underscore / dot
+const newVersion = process.env.NEW_MC_VERSION?.replace(/[^a-zA-Z0-9_.]/g, '_')
+const triggerBranch = process.env.MCDATA_BRANCH?.replace(/[^a-zA-Z0-9_.]/g, '_')
+const mcdataPrURL = process.env.MCDATA_PR_URL
+console.log({ newVersion, triggerBranch, mcdataPrURL })
+
+assert(newVersion)
+assert(triggerBranch)
+
+async function main () {
+  const currentSupportedPath = require.resolve('../../src/version.js')
+  const readmePath = join(__dirname, '../../docs/README.md')
+  const ciPath = join(__dirname, '../../.github/workflows/ci.yml')
+
+  // Update the version.js
+  const currentSupportedVersion = require('../../src/version.js')
+  const currentContents = fs.readFileSync(currentSupportedPath, 'utf8')
+  console.log('Current supported version:', currentContents)
+  const newContents = currentContents.includes(newVersion)
+    ? currentContents
+    : currentContents
+      .replace(`: '${currentSupportedVersion.defaultVersion}'`, `: '${newVersion}'`)
+      .replace(`, '${currentSupportedVersion.defaultVersion}'`, `, '${currentSupportedVersion.defaultVersion}', '${newVersion}'`)
+
+  // Update the README.md
+  const currentContentsReadme = fs.readFileSync(readmePath, 'utf8')
+  if (!currentContentsReadme.includes(newVersion)) {
+    const newReadmeContents = currentContentsReadme.replace('\n<!--add_next_version_above-->', `, ${newVersion}\n<!--add_next_version_above-->`)
+    fs.writeFileSync(readmePath, newReadmeContents)
+    console.log('Updated README with new version:', newVersion)
+  }
+  fs.writeFileSync(currentSupportedPath, newContents)
+
+  // Update the CI workflow
+  const currentContentsCI = fs.readFileSync(ciPath, 'utf8')
+  if (!currentContentsCI.includes(newVersion)) {
+    const newCIContents = currentContentsCI.replace(
+      'run: npm install', `run: npm install
+    - run: cd node_modules && cd minecraft-data && mv minecraft-data minecraft-data-old && git clone -b ${triggerBranch} https://github.com/PrismarineJS/minecraft-data --depth 1 && node bin/generate_data.js
+    - run: curl -o node_modules/protodef/src/serializer.js https://raw.githubusercontent.com/extremeheat/node-protodef/refs/heads/dlog/src/serializer.js && curl -o node_modules/protodef/src/compiler.js https://raw.githubusercontent.com/extremeheat/node-protodef/refs/heads/dlog/src/compiler.js
+`)
+    fs.writeFileSync(ciPath, newCIContents)
+    console.log('Updated CI workflow with new version:', newVersion)
+  }
+
+  const branchName = 'pc' + newVersion.replace(/[^a-zA-Z0-9_]/g, '_')
+  exec(`git checkout -b ${branchName}`)
+  exec('git config user.name "github-actions[bot]"')
+  exec('git config user.email "41898282+github-actions[bot]@users.noreply.github.com"')
+  exec('git add --all')
+  exec(`git commit -m "Update to version ${newVersion}"`)
+  exec(`git push origin ${branchName} --force`)
+  //     createPullRequest(title: string, body: string, fromBranch: string, intoBranch?: string): Promise<{ number: number, url: string }>;
+  const pr = await github.createPullRequest(
+    `🎈 ${newVersion}`,
+    `This automated PR sets up the relevant boilerplate for Minecraft version ${newVersion}.
+
+Ref: ${mcdataPrURL}
+
+* You can help contribute to this PR by opening a PR against this <code branch>${branchName}</code> branch instead of <code>master</code>.
+    `,
+    branchName,
+    'master'
+  )
+  console.log(`Pull request created`, pr)
+
+  // Ask mineflayer to handle new update
+  const nodeDispatchPayload = {
+    owner: 'PrismarineJS',
+    repo: 'mineflayer',
+    workflow: 'handle-update.yml',
+    branch: 'master',
+    inputs: {
+      new_mc_version: newVersion,
+      mcdata_branch: triggerBranch,
+      mcdata_pr_url: mcdataPrURL,
+      nmp_branch: branchName,
+      nmp_pr_url: pr.url
+    }
+  }
+  console.log('Sending workflow dispatch', nodeDispatchPayload)
+  await github.sendWorkflowDispatch(nodeDispatchPayload)
+}
+
+main().catch(err => {
+  console.error('Error during update process:', err)
+  process.exit(1)
+})

.github/workflows/ci.yml

@@ -9,39 +9,52 @@ on:
       - master
 
 jobs:
-  test:
+  Lint:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        mcVersion: ['1.7', '1.8', '1.9', '1.10', '1.11.2', '1.12.2', '1.13.2', '1.14.4', '1.15.2', '1.16.5', '1.17', '1.17.1', '1.18']
 
     steps:
     - uses: actions/checkout@v2
-    - name: Use Node.js 14.x
-      uses: actions/setup-node@v1
+    - name: Use Node.js 22.x
+      uses: actions/setup-node@v1.4.4
       with:
-        node-version: 14.x
-    - name: Setup Java JDK
-      uses: actions/[email protected]
+        node-version: 22.x
+    - run: npm i && npm run lint
+  PrepareSupportedVersions:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.set-matrix.outputs.matrix }}
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js 22.x
+      uses: actions/[email protected]
       with:
-        java-version: '17'
-        distribution: 'adopt'
-    - name: Install dependencies
-      run: npm install
-    - name: Run tests
-      run: npm test -- -g ${{ matrix.mcVersion }}
-  packet-cycle-test:
+        node-version: 22.x
+    - id: set-matrix
+      run: |
+        node -e "
+          const supportedVersions = require('./src/version').supportedVersions;
+          console.log('matrix='+JSON.stringify({'include': supportedVersions.map(mcVersion => ({mcVersion}))}))
+        " >> $GITHUB_OUTPUT
+  test:
+    needs: PrepareSupportedVersions
     runs-on: ubuntu-latest
+    strategy:
+      matrix: ${{fromJson(needs.PrepareSupportedVersions.outputs.matrix)}}
+      fail-fast: false
 
     steps:
     - uses: actions/checkout@v2
-    - name: Use Node.js 14.x
+    - name: Use Node.js 22.x
       uses: actions/setup-node@v1
       with:
-        node-version: 14.x
+        node-version: 22.x
     - name: Setup Java JDK
       uses: actions/[email protected]
       with:
-        java-version: '16'
+        java-version: '21'
         distribution: 'adopt'
-    - run: npm install && npm run test-non-par
+    - name: Install dependencies
+      run: npm install
+    - name: Run tests
+      run: npm run mochaTest -- -g ${{ matrix.mcVersion }}v

.github/workflows/commands.yml

@@ -0,0 +1,24 @@
+name: Repo Commands
+
+on:
+  issue_comment:        # Handle comment commands
+    types: [created]
+  pull_request:         # Handle renamed PRs
+    types: [edited]
+permissions:
+  contents: write
+
+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

.github/workflows/npm-publish.yml

@@ -13,13 +13,20 @@ jobs:
     - name: Set up Node.js
       uses: actions/setup-node@master
       with:
-        node-version: 10.0.0
-    - name: Publish if version has been updated
-      uses: pascalgn/npm-publish-action@4f4bf159e299f65d21cd1cbd96fc5d53228036df
-      with: # All of theses inputs are optional
-        tag_name: "%s"
-        tag_message: "%s"
-        commit_pattern: "^Release (\\S+)"
-      env: # More info about the environment variables in the README
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Leave this as is, it's automatically generated
-        NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }} # You need to set this in your repo settings
+        node-version: 22.0.0
+    - id: publish
+      uses: JS-DevTools/npm-publish@v1
+      with:
+        token: ${{ secrets.NPM_AUTH_TOKEN }}
+    - name: Create Release
+      if: steps.publish.outputs.type != 'none'
+      id: create_release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ steps.publish.outputs.version }}
+        release_name: Release ${{ steps.publish.outputs.version }}
+        body: ${{ steps.publish.outputs.version }}
+        draft: false
+        prerelease: false

.github/workflows/update-from-minecraft-data.yml

@@ -0,0 +1,36 @@
+name: Update from minecraft-data
+
+on:
+  workflow_dispatch:
+    inputs:
+      new_mc_version:
+        description: New minecraft version number
+        required: true
+        type: string
+      mcdata_branch:
+        description: minecraft-data branch for this version
+        required: true
+        type: string
+      mcdata_pr_url:
+        description: minecraft-data PR number to open a PR here against
+        required: false
+        default: ''
+        type: string
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        token: ${{ secrets.PAT_PASSWORD }}
+
+    - name: Run updator script
+      run: cd .github/helper && npm install && node updator.js
+      env:
+        GITHUB_TOKEN: ${{ secrets.PAT_PASSWORD }}
+        MCDATA_BRANCH: ${{ github.event.inputs.mcdata_branch }}
+        MCDATA_PR_URL: ${{ github.event.inputs.mcdata_pr_url }}
+        NEW_MC_VERSION: ${{ github.event.inputs.new_mc_version }}

.gitignore

@@ -1,6 +1,7 @@
 node_modules
 test/npm-debug.log
-test/server*
+test/server_*
 package-lock.json
 versions/
-src/client/*.json
+src/client/*.json
+test_*

.gitpod.yml

@@ -1,2 +1,2 @@
 tasks:
-- command: npm install
+- command: npm install && sdk install java