@ably/cli
Version:
Ably CLI for Pub/Sub, Chat and Spaces
154 lines (153 loc) • 7.21 kB
JavaScript
import { Args, Flags } from "@oclif/core";
import { RoomStatus, MessageReactionType, } from "@ably/chat";
import chalk from "chalk";
import { ChatBaseCommand } from "../../../../chat-base-command.js";
// Map CLI-friendly type names to SDK MessageReactionType values
const REACTION_TYPE_MAP = {
unique: MessageReactionType.Unique,
distinct: MessageReactionType.Distinct,
multiple: MessageReactionType.Multiple,
};
export default class MessagesReactionsSend extends ChatBaseCommand {
static args = {
room: Args.string({
description: "The room where the message is located",
required: true,
}),
messageSerial: Args.string({
description: "The serial ID of the message to react to",
required: true,
}),
reaction: Args.string({
description: "The reaction to send (e.g. 👍, ❤️, 😂)",
required: true,
}),
};
static description = "Send a reaction to a message in a chat room";
static examples = [
"$ ably rooms messages reactions send my-room message-serial 👍",
'$ ably rooms messages reactions send --api-key "YOUR_API_KEY" my-room message-serial ❤️',
"$ ably rooms messages reactions send my-room message-serial 👍 --type multiple --count 10",
"$ ably rooms messages reactions send my-room message-serial 👍 --type unique",
"$ ably rooms messages reactions send my-room message-serial 👍 --json",
];
static flags = {
...ChatBaseCommand.globalFlags,
type: Flags.string({
description: "The type of reaction (unique, distinct, or multiple)",
options: Object.keys(REACTION_TYPE_MAP),
}),
count: Flags.integer({
description: "Count value for Multiple type reactions",
dependsOn: ["type"],
}),
};
chatClient = null;
async run() {
const { args, flags } = await this.parse(MessagesReactionsSend);
const { room, messageSerial, reaction } = args;
try {
// Validate count for Multiple type
if (flags.type === "multiple" &&
flags.count !== undefined &&
flags.count <= 0) {
const errorMsg = "Count must be a positive integer for Multiple type reactions";
this.logCliEvent(flags, "reaction", "invalidCount", errorMsg, {
error: errorMsg,
count: flags.count,
});
if (this.shouldOutputJson(flags)) {
this.log(this.formatJsonOutput({ error: errorMsg, room, success: false }, flags));
}
else {
this.error(errorMsg);
}
return;
}
// Create Chat client
this.chatClient = await this.createChatClient(flags);
if (!this.chatClient) {
this.error("Failed to create Chat client");
return;
}
// Add listeners for connection state changes
this.chatClient.connection.onStatusChange((stateChange) => {
this.logCliEvent(flags, "connection", stateChange.current, `Realtime connection state changed to ${stateChange.current}`, { error: stateChange.error });
});
// Get the room
this.logCliEvent(flags, "room", "gettingRoom", `Getting room handle for ${room}`);
const chatRoom = await this.chatClient.rooms.get(room);
this.logCliEvent(flags, "room", "gotRoom", `Got room handle for ${room}`);
// Subscribe to room status changes
this.logCliEvent(flags, "room", "subscribingToStatus", "Subscribing to room status changes");
chatRoom.onStatusChange((statusChange) => {
let reason;
if (statusChange.current === RoomStatus.Failed) {
reason = chatRoom.error; // Get reason from chatRoom.error on failure
}
const reasonMsg = reason instanceof Error ? reason.message : reason;
this.logCliEvent(flags, "room", `status-${statusChange.current}`, `Room status changed to ${statusChange.current}`, { reason: reasonMsg });
if (statusChange.current === RoomStatus.Failed &&
!this.shouldOutputJson(flags)) {
this.error(`Failed to attach to room: ${reasonMsg || "Unknown error"}`);
}
});
this.logCliEvent(flags, "room", "subscribedToStatus", "Successfully subscribed to room status changes");
// Attach to the room
this.logCliEvent(flags, "room", "attaching", `Attaching to room ${room}`);
await chatRoom.attach();
this.logCliEvent(flags, "room", "attached", `Successfully attached to room ${room}`);
// Prepare the reaction parameters
const reactionParams = {
name: reaction,
};
// Set optional parameters if provided
if (flags.type) {
reactionParams.type = REACTION_TYPE_MAP[flags.type];
}
if (flags.type === "multiple" && flags.count) {
reactionParams.count = flags.count;
}
// Send the reaction
this.logCliEvent(flags, "reaction", "sending", `Sending reaction ${reaction} to message`, {
messageSerial,
reaction: reactionParams,
});
await chatRoom.messages.reactions.send(messageSerial, reactionParams);
this.logCliEvent(flags, "reaction", "sent", `Successfully sent reaction ${reaction} to message`);
// Format the response
const resultData = {
messageSerial,
reaction,
room,
success: true,
...(flags.type && { type: flags.type }),
...(flags.count && { count: flags.count }),
};
if (this.shouldOutputJson(flags)) {
this.log(this.formatJsonOutput(resultData, flags));
}
else {
this.log(`${chalk.green("✓")} Sent reaction ${chalk.yellow(reaction)} to message ${chalk.cyan(messageSerial)} in room ${chalk.cyan(room)}`);
}
}
catch (error) {
const errorMsg = error instanceof Error ? error.message : String(error);
this.logCliEvent(flags, "reaction", "error", `Failed to send reaction: ${errorMsg}`, { error: errorMsg, room, messageSerial, reaction });
if (this.shouldOutputJson(flags)) {
this.log(this.formatJsonOutput({
error: errorMsg,
room,
messageSerial,
reaction,
success: false,
...(flags.type && { type: flags.type }),
...(flags.count && { count: flags.count }),
}, flags));
}
else {
this.error(`Failed to send reaction: ${errorMsg}`);
}
}
}
}