prismarine-chat 1.3.1 → 1.4.1

package/HISTORY.md

@@ -1,5 +1,20 @@
 ## History
 
+### 1.4.1
+* Remake ChatMessage#clone (@u9g)
+
+### 1.4.0
+* Add a example (@u9g)
+* Add hex color code support (@U5B)
+* use rest arg to allow many withs or extras (@u9g)
+* Add missing json attribute to typescript defintions (@Paulomart & @u9g)
+
+### 1.3.3
+* fix typings
+
+### 1.3.2
+* Properly export loader function and export ChatMessage & MessageBuilder as types
+
 ### 1.3.1
 * export ChatMessage object in typings
 

package/MessageBuilder.js

@@ -102,7 +102,7 @@ function loader (version) {
             hoverEvent.contents = {
               id: `minecraft:${data.name}`,
               count: data.count,
-              tag: mojangson.stringify(data.nbt)
+              tag: data.nbt ? mojangson.stringify(data.nbt) : {}
             }
             break
           case 'show_entity':
@@ -125,8 +125,8 @@ function loader (version) {
             hoverEvent.value = mojangson.stringify(nbt.comp({
               id: nbt.string(`minecraft:${data.name}`),
               Count: nbt.byte(data.count),
-              tag: data.nbt,
-              Damage: nbt.int(0)
+              tag: data.nbt || nbt.comp({}),
+              Damage: nbt.short(0)
             }))
             break
           case 'show_text':
@@ -144,16 +144,29 @@ function loader (version) {
     /**
      * appended to the end of this message object with the existing formatting.
      * formatting can be overrode in child messagebuilder
-     * @param {MessageBuilder|string} val
+     * @param {Array<MessageBuilder | string>} ...args
      * @returns
      */
-    addExtra (val) { this.extra.push(typeof val === 'string' ? val : val.toJSON()); return this }
+    addExtra (...args) {
+      for (const v of args) {
+        const value = typeof v === 'string' ? v : v.toJSON()
+        this.extra.push(value)
+      }
+      return this
+    }
+
     /**
      * requires .translate to be set for this to be used
-     * @param {MessageBuilder|string} val
+     * @param {Array<MessageBuilder | string>} ...args
      * @returns
      */
-    addWith (val) { this.with.push(typeof val === 'string' ? val : val.toJSON()); return this }
+    addWith (...args) {
+      for (const v of args) {
+        const value = typeof v === 'string' ? v : v.toJSON()
+        this.with.push(value)
+      }
+      return this
+    }
 
     resetFormatting () {
       this.setBold(false)

package/README.md

@@ -90,8 +90,8 @@ Returns a prismarine-chat representation of the message recieved from the 'chat'
 #### setScore (name: string, objective: string) : this
 #### setClickEvent (action: string, value: object) : this
 #### setHoverEvent (action: string, data: object, type?: 'contents'|'value') : this
-#### addExtra (val: MessageBuilder | string) : this
-#### addWith (val: MessageBuilder | string) : this
+#### addExtra (...val: MessageBuilder | string) : this
+#### addWith (...val: MessageBuilder | string) : this
 #### resetFormatting () : void
 sets every one of the formatting options to false and sets text to `reset` type
 

package/index.d.ts

@@ -14,6 +14,8 @@ export declare class ChatMessage {
     displayWarning?: boolean
   )
 
+  public readonly json: any
+
   /**
    * Append one or more ChatMessages
    */
@@ -57,11 +59,13 @@ export declare class ChatMessage {
    * Flattens the message into plain-text, without style.
    */
   valueOf(): string
+
+  static fromNotch(str: string): ChatMessage
 }
 
 type Language = { [key: string]: string }
 
-declare class MessageBuilder {
+export declare class MessageBuilder {
   with: string[]
   extra: string[]
   bold?: boolean
@@ -162,22 +166,24 @@ declare class MessageBuilder {
    * appended to the end of this message object with the existing formatting.
    * formatting can be overridden in child messagebuilder
    */
-  addExtra(val: MessageBuilder | string): this
+  addExtra(...args: Array<MessageBuilder | string>): this
 
   /**
    * requires .translate to be set for this to be used
    */
-  addWith(val: MessageBuilder | string): this
+  addWith(...args: Array<MessageBuilder | string>): this
 
   resetFormatting(): void
 
   toJSON(): object
 
   toString(): string
-
+  /**
+   * fromString('&aHello').toJSON() => { text: 'Hello', color: 'aqua' }
+   */
   static fromString(
     str: string,
-    args: { colorSeparator?: string }
+    args?: { colorSeparator?: string }
   ): MessageBuilder
 }
 

package/index.js

@@ -134,8 +134,10 @@ class ChatMessage {
         this.color = null
         break
     }
+    // Make sure color is valid
     if (Array.prototype.indexOf && this.color &&
-      supportedColors.indexOf(this.color) === -1 && displayWarning) {
+      supportedColors.indexOf(this.color) === -1 &&
+      !this.color.match(/#[a-fA-F\d]{6}/) && displayWarning) {
       console.warn('ChatMessage parsed with unsupported color', this.color)
     }
 
@@ -203,12 +205,7 @@ class ChatMessage {
   * @return {ChatMessage}
    */
   clone () {
-    return Object.assign(
-      Object.create(
-        Object.getPrototypeOf(this)
-      ),
-      this
-    )
+    return new ChatMessage(JSON.parse(JSON.stringify(this.json)))
   }
 
   /**
@@ -301,7 +298,11 @@ class ChatMessage {
     let message = Object.keys(codes).map((code) => {
       this[code] = this[code] || parent[code]
       if (!this[code] || this[code] === 'false') return null
-      if (code === 'color') return codes.color[this.color]
+      if (code === 'color') {
+        // return hex codes in this format
+        if (this.color.startsWith('#')) return `§${this.color}`
+        return codes.color[this.color]
+      }
       return codes[code]
     }).join('')
 
@@ -350,6 +351,17 @@ class ChatMessage {
     for (const k in codes) {
       message = message.replace(new RegExp(k, 'g'), codes[k])
     }
+    const hexRegex = /§#?([a-fA-F\d]{2})([a-fA-F\d]{2})([a-fA-F\d]{2})/
+    while (message.search(hexRegex) !== -1) {
+      // Stolen from https://stackoverflow.com/questions/5623838/rgb-to-hex-and-hex-to-rgb
+      const hexCodes = hexRegex.exec(message)
+      // Iterate over each hexColorCode match (§#69420, §#ABCDEF, §#A1B2C3)
+      const red = parseInt(hexCodes[1], 16)
+      const green = parseInt(hexCodes[2], 16)
+      const blue = parseInt(hexCodes[3], 16)
+      // 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'
   }
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "prismarine-chat",
-  "version": "1.3.1",
+  "version": "1.4.1",
   "description": "Wrapper for a minecraft chat message",
   "main": "index.js",
   "scripts": {
-    "test": "jest --verbose",
+    "test": "mocha --reporter spec --exit",
     "pretest": "npm run lint",
     "lint": "standard",
     "fix": "standard --fix"
@@ -24,7 +24,8 @@
   },
   "homepage": "https://github.com/PrismarineJS/prismarine-chat#readme",
   "devDependencies": {
-    "jest": "^27.0.4",
+    "expect": "^27.3.1",
+    "mocha": "^9.1.3",
     "prismarine-chat": "file:.",
     "standard": "^16.0.1"
   },
@@ -32,7 +33,7 @@
     "minecraft-data": "^2.62.1",
     "mojangson": "^2.0.1",
     "prismarine-item": "^1.10.0",
-    "prismarine-nbt": "^1.6.0",
+    "prismarine-nbt": "^2.0.0",
     "sprintf-js": "^1.1.2"
   }
 }

package/test/basic.test.js

@@ -1,10 +1,13 @@
-/* eslint-env jest */
+/* eslint-env mocha */
+
 const ChatMessage = require('prismarine-chat')('1.16')
-test('Parsing a chat message', () => {
+const expect = require('expect')
+
+it('Parsing a chat message', () => {
   const msg = new ChatMessage({ text: 'Example chat message' })
   expect(msg.toString()).toBe('Example chat message')
 })
-test('Parsing message that uses language file & numbers', () => {
+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]')
@@ -17,7 +20,17 @@ test('Parsing message that uses language file & numbers', () => {
   expect(msg.with[1].with[0].text).toBe(256)
   expect(msg.with[1].with[1].text).toBe(2)
 })
-test('Parsing a chat message which is an array', () => {
+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('§r§#FF0000uwu §r§#0000FFowo §r§#FF0000uwu§r')
+  expect(msg.toAnsi()).toBe('\u001B[0m\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')
+})

package/test/messagebuilder.test.js

@@ -1,4 +1,6 @@
-/* eslint-env jest */
+/* eslint-env mocha */
+
+const expect = require('expect')
 
 describe('MessageBuilder', () => {
   describe('1.16.5', () => {
@@ -18,7 +20,7 @@ describe('MessageBuilder', () => {
         ['Insertion', "Hi I'm inserted!"]
       ]
       for (const [prop, val] of properties) {
-        test(`builder#set${prop}`, () => { // ex: builder#setBold
+        it(`builder#set${prop}`, () => { // ex: builder#setBold
           const msg = new MessageBuilder()[`set${prop}`](val) // ex: .setBold(true)
           const json = msg.toJSON() // ex: { bold: true}
           const propName = prop.toLowerCase() // ex: 'bold'
@@ -28,13 +30,13 @@ describe('MessageBuilder', () => {
     })
 
     describe('with/extra', () => {
-      test('no translate w/ .with', () => {
+      it('no translate w/ .with', () => {
         const msg = new MessageBuilder()
           .addWith('Hello,')
           .addWith('World.')
         expect(msg.toJSON()).toStrictEqual({})
       })
-      test('translate w/ .with', () => {
+      it('translate w/ .with', () => {
         const msg = new MessageBuilder()
           .setTranslate('chat.type.text')
           .addWith(new MessageBuilder().setText('U9G'))
@@ -46,7 +48,7 @@ describe('MessageBuilder', () => {
         expect(text).toStrictEqual('<U9G> Hello world')
       })
 
-      test('w/ .addExtra add split hello & world', () => {
+      it('w/ .addExtra add split hello & world', () => {
         const msg = new MessageBuilder()
           .addExtra(new MessageBuilder().setText('Hello'))
           .addExtra(new MessageBuilder().setText(' ').setColor('reset'))