dredless 0.3.0 → 0.3.1

package/docs/API_REFERENCE.md

@@ -2117,6 +2117,23 @@ interface InventoryDragCommand {
 
 `normalizeInventoryEvent()` returns the normalized `InventoryState` shape documented under `client.inventory`.
 
+### Chat helpers
+
+Module: `dredless/protocol/chat` or root.
+
+```ts
+function buildChatMessage(message?: string): ChatMessage;
+```
+
+Ship chat uses protocol message type 2. It is separate from comms-station
+messages, which use type 3. The game handles ship chat through the same
+chat-command path used by its chat commands, so client.sendChatMessage() can
+send executable chat commands as well as ordinary chat text. For example:
+
+```js
+client.sendChatMessage("/help");
+```
+
 ### Comms helpers
 
 Module: `dredless/protocol/comms` or root.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "dredless",
-    "version": "0.3.0",
+    "version": "0.3.1",
     "description": "A fully-featured and from-scratch headless drednot.io client implementation written in pure js.",
     "license": "MIT",
     "homepage": "https://github.com/certainhuman/dredless#readme",

package/src/client/core.js

@@ -7,6 +7,7 @@ import {Connection} from "../network/connection.js";
 import {itemEquipmentSlotFromId} from "../state/items.js";
 import {WorldStore} from "../state/world/index.js";
 import {buildBlueprintPlacementMessage} from "../protocol/outbound/blueprint.js";
+import {buildChatMessage} from "../protocol/outbound/chat.js";
 import {buildCommsMessage, normalizeCommsEvent} from "../protocol/outbound/comms.js";
 import {buildSignedCommandPacket} from "../protocol/outbound/commands.js";
 import {buildInventoryDragCommand, normalizeEquipmentSlot, normalizeInventoryEvent} from "../protocol/outbound/inventory.js";
@@ -286,6 +287,10 @@ export class DredlessClient extends EventBus {
         return this.sendMessage({type: 5, cmd, args});
     }
 
+    sendChatMessage(message = "") {
+        return this.sendMessage(buildChatMessage(message));
+    }
+
     sendCommsMessage(message = "") {
         return this.sendMessage(buildCommsMessage(message));
     }

package/src/index.d.ts

@@ -132,6 +132,11 @@ export interface BlueprintPlacement {
     source: string;
 }
 
+export interface ChatMessage {
+    type: 2;
+    msg: string;
+}
+
 export interface BlueprintPlacementMessage {
     type: 9;
     x: number;
@@ -463,6 +468,8 @@ export class DredlessClient {
     close(code?: number, reason?: string): this;
 
     disconnect(code?: number, reason?: string): this;
+    sendChatMessage(message?: string): this;
+    sendCommsMessage(message?: string): this;
 
     currentShip(): ShipDomain | null;
 
@@ -2108,6 +2115,8 @@ export function decodeMsgpack(bytes: Uint8Array | ArrayBuffer | number[]): unkno
 
 export function encodeMsgpack(value: unknown): Uint8Array;
 
+export function buildChatMessage(message?: string): ChatMessage;
+
 export function buildCommsMessage(message?: string): CommsMessage;
 
 export function normalizeCommsEvent(event: unknown): CommsEvent;

package/src/index.js

@@ -5,6 +5,7 @@ export {WorldStore, WorldState} from "./state/world/index.js";
 export {FabricatorType, ModelState, decodeModelData} from "./state/model/index.js";
 export {generateGeneratorMaze, solveGeneratorMazeSeed, maybeSolveGeneratorMazeSeed} from "./state/generator-maze.js";
 export {buildBlueprintPlacementMessage} from "./protocol/outbound/blueprint.js";
+export {buildChatMessage} from "./protocol/outbound/chat.js";
 export {decodeMsgpack, encodeMsgpack} from "./protocol/codec/msgpack.js";
 export {
     buildCommsMessage,

package/src/protocol/index.d.ts

@@ -3,6 +3,7 @@ export * from "./codec/binary.js";
 export * from "./inbound/frame.js";
 export * from "./inbound/world-payload.js";
 export * from "./outbound/blueprint.js";
+export * from "./outbound/chat.js";
 export * from "./outbound/comms.js";
 export * from "./outbound/commands.js";
 export * from "./outbound/inventory.js";

package/src/protocol/index.js

@@ -3,6 +3,7 @@ export {toUint8Array, concatBytes, valuesEqual} from "./codec/binary.js";
 export {decodeIncomingFrame} from "./inbound/frame.js";
 export {decodeWorldPayload, decodeModelPayload, decompressWorldChunk} from "./inbound/world-payload.js";
 export {buildBlueprintPlacementMessage} from "./outbound/blueprint.js";
+export {buildChatMessage} from "./outbound/chat.js";
 export {buildCommsMessage, flattenRichText, normalizeCommsEvent} from "./outbound/comms.js";
 export {buildSignedCommandPacket} from "./outbound/commands.js";
 export {

package/src/protocol/outbound/chat.d.ts

@@ -0,0 +1,8 @@
+export interface ChatMessage {
+    type: 2;
+    msg: string;
+}
+
+export function buildChatMessage(message?: string): ChatMessage;
+
+export const CHAT_MESSAGE_TYPE: 2;

package/src/protocol/outbound/chat.js

@@ -0,0 +1,13 @@
+const CHAT_MESSAGE_TYPE = 2;
+
+function buildChatMessage(message = "") {
+    return {
+        type: CHAT_MESSAGE_TYPE,
+        msg: String(message)
+    };
+}
+
+export {
+    CHAT_MESSAGE_TYPE,
+    buildChatMessage
+};