snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)

apps/meteor/server/lib/utils/slashCommand.ts

@@ -0,0 +1,166 @@
+import { MeteorError } from '@rocket.chat/core-services';
+import type {
+	IMessage,
+	SlashCommand,
+	SlashCommandOptions,
+	RequiredField,
+	SlashCommandPreviewItem,
+	SlashCommandPreviews,
+} from '@rocket.chat/core-typings';
+import type { ServerMethods } from '@rocket.chat/ddp-client';
+import { Meteor } from 'meteor/meteor';
+
+import { methodDeprecationLogger } from '../deprecationWarningLogger';
+
+interface ISlashCommandAddParams<T extends string> {
+	command: string;
+	callback?: SlashCommand<T>['callback'];
+	options?: SlashCommandOptions;
+	result?: SlashCommand['result'];
+	providesPreview?: boolean;
+	previewer?: SlashCommand['previewer'];
+	previewCallback?: SlashCommand['previewCallback'];
+	appId?: string;
+	description?: string;
+}
+
+export const slashCommands = {
+	commands: {} as Record<string, SlashCommand>,
+	add<T extends string>({
+		command,
+		callback,
+		options = {},
+		result,
+		providesPreview = false,
+		previewer,
+		previewCallback,
+		appId,
+		description = '',
+	}: ISlashCommandAddParams<T>): void {
+		if (this.commands[command]) {
+			return;
+		}
+		this.commands[command] = {
+			command,
+			callback,
+			params: options.params,
+			description: options.description || description,
+			permission: options.permission,
+			clientOnly: options.clientOnly || false,
+			result,
+			providesPreview: Boolean(providesPreview),
+			previewer,
+			previewCallback,
+			appId,
+		} as SlashCommand;
+	},
+	async run({
+		command,
+		message,
+		params,
+		triggerId,
+		userId,
+	}: {
+		command: string;
+		params: string;
+		message: RequiredField<Partial<IMessage>, 'rid' | '_id'>;
+		userId: string;
+		triggerId?: string | undefined;
+	}): Promise<unknown> {
+		const cmd = this.commands[command];
+		if (typeof cmd?.callback !== 'function') {
+			return;
+		}
+
+		if (!message?.rid) {
+			throw new MeteorError('invalid-command-usage', 'Executing a command requires at least a message with a room id.');
+		}
+
+		return cmd.callback({ command, params, message, triggerId, userId });
+	},
+	async getPreviews(
+		command: string,
+		params: string,
+		message: RequiredField<Partial<IMessage>, 'rid'>,
+		userId: string,
+	): Promise<SlashCommandPreviews | undefined> {
+		const cmd = this.commands[command];
+		if (typeof cmd?.previewer !== 'function') {
+			return;
+		}
+
+		if (!message?.rid) {
+			throw new MeteorError('invalid-command-usage', 'Executing a command requires at least a message with a room id.');
+		}
+
+		const previewInfo = await cmd.previewer(command, params, message, userId);
+
+		if (!previewInfo?.items?.length) {
+			return;
+		}
+
+		// A limit of ten results, to save time and bandwidth
+		if (previewInfo.items.length >= 10) {
+			previewInfo.items = previewInfo.items.slice(0, 10);
+		}
+
+		return previewInfo;
+	},
+	async executePreview(
+		command: string,
+		params: string,
+		message: Pick<IMessage, 'rid'> & Partial<Omit<IMessage, 'rid'>>,
+		preview: SlashCommandPreviewItem,
+		userId: string,
+		triggerId?: string,
+	) {
+		const cmd = this.commands[command];
+		if (typeof cmd?.previewCallback !== 'function') {
+			return;
+		}
+
+		if (!message?.rid) {
+			throw new MeteorError('invalid-command-usage', 'Executing a command requires at least a message with a room id.');
+		}
+
+		// { id, type, value }
+		if (!preview.id || !preview.type || !preview.value) {
+			throw new MeteorError('error-invalid-preview', 'Preview Item must have an id, type, and value.');
+		}
+
+		return cmd.previewCallback(command, params, message, preview, userId, triggerId);
+	},
+};
+
+declare module '@rocket.chat/ddp-client' {
+	// eslint-disable-next-line @typescript-eslint/naming-convention
+	interface ServerMethods {
+		slashCommand(params: { cmd: string; params: string; msg: IMessage; triggerId: string }): unknown;
+	}
+}
+
+Meteor.methods<ServerMethods>({
+	async slashCommand(command) {
+		methodDeprecationLogger.method('slashCommand', '9.0.0', '/v1/commands.run');
+		const userId = Meteor.userId();
+		if (!userId) {
+			throw new Meteor.Error('error-invalid-user', 'Invalid user', {
+				method: 'slashCommand',
+			});
+		}
+
+		if (!command?.cmd || !slashCommands.commands[command.cmd]) {
+			throw new Meteor.Error('error-invalid-command', 'Invalid Command Provided', {
+				method: 'executeSlashCommandPreview',
+			});
+		}
+
+		return slashCommands.run({
+			command: command.cmd,
+			params: command.params,
+			message: command.msg,
+			triggerId: command.triggerId,
+			userId,
+		});
+	},
+});