prismarine-chat 1.6.0 → 1.7.0

package/.github/workflows/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: 14.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

package/HISTORY.md

@@ -1,5 +1,14 @@
 ## History
 
+### 1.7.0
+
+* Support 1.19 client side message formatting (@extremeheat)
+* Fix motd color codes bleeding through their with block (@U9g)
+
+### 1.6.1
+
+* Update mcdata
+
 ### 1.6.0
 
 * Added number type to getText()'s idx argument

package/MessageBuilder.js

@@ -26,7 +26,7 @@ const supportedColors = {
   r: 'reset'
 }
 
-function loader (version) {
+function loader (registry) {
   class MessageBuilder {
     constructor () {
       this.with = []

package/README.md

@@ -12,7 +12,8 @@ A parser for a minecraft chat message
 ## Usage
 
 ```js
-const ChatMessage = require('prismarine-chat')('1.16')
+const registry = require('prismarine-registry')('1.16')
+const ChatMessage = require('prismarine-chat')(registry)
 
 const msg = new ChatMessage({"text":"Example chat mesasge"})
 console.log(msg.toString()) // Example chat message
@@ -60,7 +61,8 @@ Appends another ChatMessage or a string
 Returns a clone of the ChatMessage
 
 ```js
-const { MessageBuilder } = require('prismarine-chat')('1.16')
+const registry = require('prismarine-registry')('1.16')
+const { MessageBuilder } = require('prismarine-chat')(registry)
 
 const msg = new MessageBuilder().setText('Example chat mesasge')
 console.log(JSON.stringify(msg)) // The string as a message component
@@ -71,6 +73,10 @@ console.log(JSON.stringify(msg)) // The string as a message component
 
 Returns a prismarine-chat representation of the message recieved from the 'chat' packet, example shown [here](examples/minecraftprotocol_fromnotch/fromnotch.js)
 
+#### static ChatMessage.fromNetwork(messageType, messageParameters)
+
+(1.19+) Loads a chat message sent by server that needs to be formatted on client side.
+
 ### MessageBuilder()
 
 #### setBold (val: boolean) : this

package/index.d.ts

@@ -1,8 +1,6 @@
-declare const loader: (mcVersion: string) => typeof ChatMessage
+declare const loader: (registryOrVersion) => typeof ChatMessage
 
-export default loader
-
-export declare class ChatMessage {
+declare class ChatMessage {
   // for export
   static MessageBuilder: typeof MessageBuilder
 
@@ -70,9 +68,7 @@ export declare class ChatMessage {
   static fromNotch(str: string): ChatMessage
 }
 
-type Language = { [key: string]: string }
-
-export declare class MessageBuilder {
+declare class MessageBuilder {
   with: string[]
   extra: string[]
   bold?: boolean
@@ -192,8 +188,16 @@ export declare class MessageBuilder {
     str: string,
     args?: { colorSeparator?: string }
   ): MessageBuilder
+
+  // 1.19+
+  static fromNetwork (messageType: number, parameters: Record<String, Object>): MessageBuilder
 }
 
+loader.ChatMessage = typeof ChatMessage
+export = loader
+
+type Language = { [key: string]: string }
+
 type Color =
   | "black"
   | "dark_blue"

package/index.js

@@ -3,10 +3,10 @@ const vsprintf = require('sprintf-js').vsprintf
 
 module.exports = loader
 
-function loader (mcVersion) {
-  const mcData = require('minecraft-data')(mcVersion)
-  const defaultLang = mcData.language
-  const { MessageBuilder } = require('./MessageBuilder')(mcVersion)
+function loader (registryOrVersion) {
+  const registry = typeof registryOrVersion === 'string' ? require('prismarine-registry')(registryOrVersion) : registryOrVersion
+  const defaultLang = registry.language
+  const { MessageBuilder } = require('./MessageBuilder')(registry)
 
   /**
    * ChatMessage Constructor
@@ -287,7 +287,8 @@ function loader (mcVersion) {
           red: '§c',
           light_purple: '§d',
           yellow: '§e',
-          white: '§f'
+          white: '§f',
+          reset: '§r'
         },
         bold: '§l',
         italic: '§o',
@@ -298,8 +299,7 @@ function loader (mcVersion) {
 
       let message = Object.keys(codes).map((code) => {
         this[code] = this[code] || parent[code]
-        // don't color code empty strings
-        if (!this[code] || this[code] === 'false' || this.text === '') return null
+        if (!this[code] || this[code] === 'false'/* || this.text === '' */) return null
         if (code === 'color') {
           // return hex codes in this format
           if (this.color.startsWith('#')) return `§${this.color}`
@@ -308,10 +308,12 @@ function loader (mcVersion) {
         return codes[code]
       }).join('')
 
-      // don't add empty strings
-      if ((typeof this.text === 'string' || typeof this.text === 'number') && this.text !== '') message += `${this.text}§r`
+      if ((typeof this.text === 'string' || typeof this.text === 'number')/* && this.text !== '' */) message += this.text
       else if (this.with) {
-        const args = this.with.map(entry => entry.toMotd(lang))
+        const args = this.with.map(entry => {
+          const entryAsMotd = entry.toMotd(lang, this)
+          return entryAsMotd + (entryAsMotd.includes('§') ? '§r' + message : '')
+        })
         const format = lang[this.translate]
         if (!format) message += args.join('')
         else message += vsprintf(format, args)
@@ -365,7 +367,7 @@ function loader (mcVersion) {
         // ANSI from https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797#rgb-colors
         message = message.replace(hexRegex, `\u001b[38;2;${red};${green};${blue}m`)
       }
-      return message + '\u001b[0m'
+      return codes['§r'] + message + codes['§r']
     }
 
     static fromNotch (msg) {
@@ -377,6 +379,31 @@ function loader (mcVersion) {
       }
       return toRet
     }
+
+    // 1.19 applies chat formatting on the client side. A format string is provided like in C printf
+    // syntax, including positional arguments which we poll from the supplied parameters map.
+    // For example,
+    //  printf("<%s> %s" /* fmt string */, [sender], [content])
+    static fromNetwork (type, params) {
+      const msg = new ChatMessage('')
+      const format = registry.chatFormattingById[type]
+      const fstr = format.formatString
+      const slices = []
+      for (let i = 0, j = 0, k = 0; i < fstr.length; i++) {
+        const c = fstr[i]
+        const cNext = fstr[i + 1]
+        if (c === '%' && cNext === 's') {
+          slices.push(fstr.slice(j, i), new ChatMessage(params[format.parameters[k++]]))
+          i++
+          j = i + 1
+          continue
+        } else if (cNext == null) {
+          slices.push(fstr.slice(j))
+        }
+      }
+      for (const slice of slices) msg.append(slice)
+      return msg
+    }
   }
 
   ChatMessage.MessageBuilder = MessageBuilder

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prismarine-chat",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Wrapper for a minecraft chat message",
   "main": "index.js",
   "scripts": {
@@ -24,16 +24,16 @@
   },
   "homepage": "https://github.com/PrismarineJS/prismarine-chat#readme",
   "devDependencies": {
-    "expect": "^27.3.1",
-    "mocha": "^9.1.3",
+    "expect": "^29.1.0",
+    "mocha": "^10.0.0",
     "prismarine-chat": "file:.",
-    "standard": "^16.0.1"
+    "standard": "^17.0.0"
   },
   "dependencies": {
-    "minecraft-data": "^2.62.1",
     "mojangson": "^2.0.1",
     "prismarine-item": "^1.10.0",
     "prismarine-nbt": "^2.0.0",
+    "prismarine-registry": "^1.4.0",
     "sprintf-js": "^1.1.2"
   }
 }

package/test/basic.test.js

@@ -1,36 +1,102 @@
 /* eslint-env mocha */
+const expect = require('expect').default
+const assert = require('assert')
 
-const ChatMessage = require('prismarine-chat')('1.16')
-const expect = require('expect')
+describe('Parsing chat on 1.16', function () {
+  const ChatMessage = require('prismarine-chat')('1.16')
+  it('Parsing a chat message', () => {
+    const msg = new ChatMessage({ text: 'Example chat message' })
+    expect(msg.toString()).toBe('Example chat message')
+  })
+  it('Parsing message that uses language file & numbers', () => {
+    const msg = new ChatMessage({
+      italic: true,
+      color: 'gray',
+      translate: 'chat.type.admin',
+      with: [{
+        insertion: 'ripwhitescrolls',
+        clickEvent: {
+          action: 'suggest_command',
+          value: '/tell ripwhitescrolls '
+        },
+        hoverEvent: {
+          action: 'show_entity',
+          contents: {
+            type: 'minecraft:player',
+            id: '9d9e9257-b812-4332-8426-5e9a0d707392',
+            name: {
+              text: 'ripwhitescrolls'
+            }
+          }
+        },
+        text: 'ripwhitescrolls'
+      }, {
+        translate: 'commands.clear.success.multiple',
+        with: [256, 2]
+      }]
+    })
+    // test as a string
+    expect(msg.toString()).toBe('[ripwhitescrolls: Removed 256 items from 2 players]')
+    // test as motd
+    expect(msg.toMotd()).toBe('§7§o[§7§oripwhitescrolls§r§7§o: §7§oRemoved §7§o256§r§7§o items from §7§o2§r§7§o players§r§7§o]')
+    // test as ansi
+    expect(msg.toAnsi()).toBe('\u001b[0m\u001b[37m\u001b[3m[\u001b[37m\u001b[3mripwhitescrolls\u001b[0m\u001b[37m\u001b[3m: \u001b[37m\u001b[3mRemoved \u001b[37m\u001b[3m256\u001b[0m\u001b[37m\u001b[3m items from \u001b[37m\u001b[3m2\u001b[0m\u001b[37m\u001b[3m players\u001b[0m\u001b[37m\u001b[3m]\u001b[0m')
+    // test clickEvent
+    expect(msg.with[0].clickEvent.action).toBe('suggest_command')
+    expect(msg.with[0].clickEvent.value).toBe('/tell ripwhitescrolls ')
+    // test numbers
+    expect(msg.with[1].with[0].text).toBe(256)
+    expect(msg.with[1].with[1].text).toBe(2)
+  })
+  it('Parsing a chat message which is an array', () => {
+    const msg = new ChatMessage([{ text: 'Example chat ' }, { text: 'message' }])
+    expect(msg.toString()).toBe('Example chat message')
+  })
+  it('Chat Message with a single hex color', () => {
+    const msg = new ChatMessage({ text: 'uwu', color: '#FF0000' })
+    expect(msg.toMotd()).toBe('§#FF0000uwu')
+    expect(msg.toAnsi()).toBe('\u001b[0m\u001b[38;2;255;0;0muwu\u001b[0m')
+  })
+  it('Chat Message with multiple hex colors', () => {
+    const msg = new ChatMessage(['', { text: 'uwu ', color: '#FF0000' }, { text: 'owo ', color: '#0000FF' }, { text: 'uwu', color: '#FF0000' }])
+    expect(msg.toMotd()).toBe('§#FF0000uwu §#0000FFowo §#FF0000uwu')
+    expect(msg.toAnsi()).toBe('\u001b[0m\u001b[38;2;255;0;0muwu \u001b[38;2;0;0;255mowo \u001b[38;2;255;0;0muwu\u001b[0m')
+  })
+  it('parse1', () => {
+    const msg = new ChatMessage({ translate: 'chat.type.text', with: [{ text: 'IM_U9G', color: 'aqua' }, { text: 'yo sup', color: 'green' }] })
+    expect(msg.toMotd()).toBe('<§bIM_U9G§r> §ayo sup§r')
+    console.log(msg.toAnsi())
+    expect(msg.toAnsi()).toBe('\u001b[0m<\u001b[96mIM_U9G\u001b[0m> \u001b[92myo sup\u001b[0m\u001b[0m')
+  })
 
-it('Parsing a chat message', () => {
-  const msg = new ChatMessage({ text: 'Example chat message' })
-  expect(msg.toString()).toBe('Example chat message')
+  it('parse2', () => {
+    const msg = new ChatMessage({ color: 'blue', translate: 'chat.type.text', with: [{ text: 'IM_U9G', color: 'aqua' }, { text: 'yo sup', color: 'green' }] })
+    expect(msg.toMotd()).toBe('§9<§bIM_U9G§r§9> §ayo sup§r§9')
+    console.log(msg.toAnsi())
+    expect(msg.toAnsi()).toBe('\u001b[0m\u001b[94m<\u001b[96mIM_U9G\u001b[0m\u001b[94m> \u001b[92myo sup\u001b[0m\u001b[94m\u001b[0m')
+  })
 })
-it('Parsing message that uses language file & numbers', () => {
-  const msg = new ChatMessage({ italic: true, color: 'gray', translate: 'chat.type.admin', with: [{ insertion: 'ripwhitescrolls', clickEvent: { action: 'suggest_command', value: '/tell ripwhitescrolls ' }, hoverEvent: { action: 'show_entity', contents: { type: 'minecraft:player', id: '9d9e9257-b812-4332-8426-5e9a0d707392', name: { text: 'ripwhitescrolls' } } }, text: 'ripwhitescrolls' }, { translate: 'commands.clear.success.multiple', with: [256, 2] }] })
-  // test as a string
-  expect(msg.toString()).toBe('[ripwhitescrolls: Removed 256 items from 2 players]')
-  // test as ansi
-  expect(msg.toAnsi()).toBe('\u001b[37m\u001b[3m[ripwhitescrolls\u001b[0m: Removed 256\u001b[0m items from 2\u001b[0m players]\u001b[0m')
-  // test clickEvent
-  expect(msg.with[0].clickEvent.action).toBe('suggest_command')
-  expect(msg.with[0].clickEvent.value).toBe('/tell ripwhitescrolls ')
-  // test numbers
-  expect(msg.with[1].with[0].text).toBe(256)
-  expect(msg.with[1].with[1].text).toBe(2)
-})
-it('Parsing a chat message which is an array', () => {
-  const msg = new ChatMessage([{ text: 'Example chat ' }, { text: 'message' }])
-  expect(msg.toString()).toBe('Example chat message')
-})
-it('Chat Message with a single hex color', () => {
-  const msg = new ChatMessage({ text: 'uwu', color: '#FF0000' })
-  expect(msg.toMotd()).toBe('§#FF0000uwu§r')
-  expect(msg.toAnsi()).toBe('\u001B[38;2;255;0;0muwu\u001B[0m\u001B[0m')
-})
-it('Chat Message with multiple hex colors', () => {
-  const msg = new ChatMessage(['', { text: 'uwu ', color: '#FF0000' }, { text: 'owo ', color: '#0000FF' }, { text: 'uwu', color: '#FF0000' }])
-  expect(msg.toMotd()).toBe('§#FF0000uwu §r§#0000FFowo §r§#FF0000uwu§r')
-  expect(msg.toAnsi()).toBe('\u001B[38;2;255;0;0muwu \u001B[0m\u001B[38;2;0;0;255mowo \u001B[0m\u001B[38;2;255;0;0muwu\u001B[0m\u001B[0m')
+
+describe('Client-side chat formatting', function () {
+  const sender = { insertion: 'Player', clickEvent: { action: 'suggest_command', value: '/tell Player ' }, hoverEvent: { action: 'show_entity', contents: { type: 'minecraft:player', id: '00000000-00000000-00000000-00000000', name: { text: 'Player' } } }, text: 'Player' }
+  it('loads on 1.19', function () {
+    const registry = require('prismarine-registry')('1.19')
+    const ChatMessage = require('prismarine-chat')(registry)
+    registry.loadDimensionCodec(registry.loginPacket.dimensionCodec)
+    const msg = ChatMessage.fromNetwork(registry.chatFormattingByName['minecraft:emote_command'].id, {
+      sender,
+      content: { text: 'says hi' }
+    })
+    assert.strictEqual(msg.toString(), '* Player says hi')
+  })
+
+  it('loads exotic formatting', function () {
+    const registry = require('prismarine-registry')('1.19')
+    const ChatMessage = require('prismarine-chat')(registry)
+    registry.chatFormattingById = {
+      0: { formatString: '💬 [%s] %s » %s ⏎', parameters: ['rank', 'sender', 'content'] }
+    }
+    const msg = ChatMessage.fromNetwork(0, { sender, content: { text: 'hello world !' }, rank: 'Admin' })
+    assert.strictEqual(msg.toString(), '💬 [Admin] Player » hello world ! ⏎')
+  })
 })

package/test/messagebuilder.test.js

@@ -1,6 +1,6 @@
 /* eslint-env mocha */
 
-const expect = require('expect')
+const expect = require('expect').default
 
 describe('MessageBuilder', () => {
   describe('1.16.5', () => {