feat(body): add entities formatting support (#250)

Author: BubuMVX

README.md

@@ -160,6 +160,22 @@ const menuTemplate = new MenuTemplate<MyContext>((ctx) => {
 });
 ```
 
+### Can I use `entities` in the message body?
+
+Also see: [`grammyjs/parse-mode`](https://github.com/grammyjs/parse-mode)
+
+```ts
+import { bold, fmt, underline } from '@grammyjs/parse-mode';
+
+const menu = new MenuTemplate<MyContext>(async () => {
+	const message = fmt`${bold(underline('Hello world!'))}`;
+	return {
+		text: message.text,
+		entities: message.entities,
+	};
+});
+```
+
 ### Can the menu body be some media?
 
 The menu body can be an object containing `media` and `type` for media.

source/body.test.ts

@@ -112,6 +112,21 @@ const EXAMPLE_TEXTS: ReadonlyArray<string | TextBody> = [
 		text: 'Hello World',
 		disable_web_page_preview: true,
 	},
+	{
+		text: 'Hello world!',
+		entities: [
+			{
+				type: 'bold',
+				offset: 0,
+				length: 5,
+			},
+			{
+				type: 'italic',
+				offset: 6,
+				length: 5,
+			},
+		],
+	},
 ];
 
 const EXAMPLE_MEDIA: readonly MediaBody[] = [
@@ -130,6 +145,23 @@ const EXAMPLE_MEDIA: readonly MediaBody[] = [
 		text: 'whatever',
 		parse_mode: 'Markdown',
 	},
+	{
+		media: 'whatever',
+		type: 'photo',
+		text: 'Hello world!',
+		entities: [
+			{
+				type: 'bold',
+				offset: 0,
+				length: 5,
+			},
+			{
+				type: 'italic',
+				offset: 6,
+				length: 5,
+			},
+		],
+	},
 ];
 
 const EXAMPLE_LOCATION: readonly LocationBody[] = [

source/body.ts

@@ -1,6 +1,6 @@
 import type {InputFile} from 'grammy';
 import type {
-	LabeledPrice, Location, ParseMode, Venue,
+	LabeledPrice, Location, MessageEntity, ParseMode, Venue,
 } from 'grammy/types';
 import type {ReadonlyDeep} from 'type-fest';
 import {hasTruthyKey, isObject} from './generic-types.js';
@@ -24,6 +24,7 @@ export type MediaType = typeof MEDIA_TYPES[number];
 
 export type TextBody = {
 	readonly text: string;
+	readonly entities?: MessageEntity[];
 	readonly parse_mode?: ParseMode;
 	readonly disable_web_page_preview?: boolean;
 };
@@ -34,6 +35,7 @@ export type MediaBody = {
 
 	/** Caption */
 	readonly text?: string;
+	readonly entities?: MessageEntity[];
 	readonly parse_mode?: ParseMode;
 };
 
@@ -160,6 +162,7 @@ export function isInvoiceBody(body: unknown): body is InvoiceBody {
 		&& typeof invoice.description === 'string';
 }
 
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 export function getBodyText(body: TextBody | string): string {
 	return typeof body === 'string' ? body : body.text;
 }

source/send-menu.ts

@@ -361,6 +361,7 @@ export function generateEditMessageIntoMenuFunction<Context>(
 					type: body.type,
 					media: body.media,
 					caption: body.text,
+					caption_entities: body.entities,
 					parse_mode: body.parse_mode,
 				},
 				createGenericOther(keyboard, other),
@@ -401,12 +402,14 @@ export function generateEditMessageIntoMenuFunction<Context>(
 }
 
 function createTextOther(
+	// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 	body: string | TextBody,
 	keyboard: InlineKeyboard,
 	base: Readonly<Record<string, unknown>>,
 ) {
 	return {
 		...base,
+		entities: typeof body === 'string' ? undefined : body.entities,
 		parse_mode: typeof body === 'string' ? undefined : body.parse_mode,
 		disable_web_page_preview: typeof body !== 'string'
 			&& body.disable_web_page_preview,
@@ -426,6 +429,7 @@ function createSendMediaOther(
 		...base,
 		parse_mode: body.parse_mode,
 		caption: body.text,
+		caption_entities: body.entities,
 		reply_markup: {
 			inline_keyboard: keyboard.map(o => [...o]),
 		},

test/menu-middleware/reply-to-context.ts

@@ -29,6 +29,7 @@ await test('menu-middleware reply-to-context replies main menu', async t => {
 		strictEqual(text, 'whatever');
 		deepStrictEqual(other, {
 			disable_web_page_preview: false,
+			entities: undefined,
 			parse_mode: undefined,
 			reply_markup: {
 				inline_keyboard: [],
@@ -67,6 +68,7 @@ await test('menu-middleware reply-to-context replies main menu explicitly', asyn
 		strictEqual(text, 'whatever');
 		deepStrictEqual(other, {
 			disable_web_page_preview: false,
+			entities: undefined,
 			parse_mode: undefined,
 			reply_markup: {
 				inline_keyboard: [],
@@ -105,6 +107,7 @@ await test('menu-middleware reply-to-context replies submenu', async t => {
 		strictEqual(text, 'submenu');
 		deepStrictEqual(other, {
 			disable_web_page_preview: false,
+			entities: undefined,
 			parse_mode: undefined,
 			reply_markup: {
 				inline_keyboard: [],

test/send-menu/context-edit.ts

@@ -13,6 +13,7 @@ await test('context-edit text reply when not a callback query', async t => {
 		strictEqual(text, 'whatever');
 		deepStrictEqual(other, {
 			disable_web_page_preview: false,
+			entities: undefined,
 			parse_mode: undefined,
 			reply_markup: {
 				inline_keyboard: [],
@@ -36,6 +37,7 @@ await test('context-edit text reply when no message on callback query', async t
 		strictEqual(text, 'whatever');
 		deepStrictEqual(other, {
 			disable_web_page_preview: false,
+			entities: undefined,
 			parse_mode: undefined,
 			reply_markup: {
 				inline_keyboard: [],
@@ -65,6 +67,7 @@ await test('context-edit text edit when message is a text message', async t => {
 			strictEqual(text, 'whatever');
 			deepStrictEqual(other, {
 				disable_web_page_preview: false,
+				entities: undefined,
 				parse_mode: undefined,
 				reply_markup: {
 					inline_keyboard: [],
@@ -106,6 +109,7 @@ await test('context-edit text reply when message is a media message', async t =>
 		strictEqual(text, 'whatever');
 		deepStrictEqual(other, {
 			disable_web_page_preview: false,
+			entities: undefined,
 			parse_mode: undefined,
 			reply_markup: {
 				inline_keyboard: [],
@@ -151,6 +155,7 @@ await test('context-edit text reply when message is a media message but fails wi
 		strictEqual(text, 'whatever');
 		deepStrictEqual(other, {
 			disable_web_page_preview: false,
+			entities: undefined,
 			parse_mode: undefined,
 			reply_markup: {
 				inline_keyboard: [],
@@ -193,6 +198,7 @@ await test('context-edit media reply when not a callback query', async t => {
 			strictEqual(photo, 'whatever');
 			deepStrictEqual(other, {
 				caption: undefined,
+				caption_entities: undefined,
 				parse_mode: undefined,
 				reply_markup: {
 					inline_keyboard: [],
@@ -227,6 +233,7 @@ await test('context-edit media reply when text message', async t => {
 			strictEqual(photo, 'whatever');
 			deepStrictEqual(other, {
 				caption: undefined,
+				caption_entities: undefined,
 				parse_mode: undefined,
 				reply_markup: {
 					inline_keyboard: [],
@@ -375,6 +382,7 @@ await test('context-edit text edit without webpage preview', async () => {
 		async editMessageText(_text, other) {
 			deepStrictEqual(other, {
 				disable_web_page_preview: true,
+				entities: undefined,
 				parse_mode: undefined,
 				reply_markup: {
 					inline_keyboard: [],
@@ -409,6 +417,7 @@ await test('context-edit text edit with parse mode', async () => {
 		async editMessageText(_text, other) {
 			deepStrictEqual(other, {
 				disable_web_page_preview: undefined,
+				entities: undefined,
 				parse_mode: 'Markdown',
 				reply_markup: {
 					inline_keyboard: [],

test/send-menu/context-reply.ts

@@ -19,6 +19,7 @@ await test('context-reply media', async t => {
 						strictEqual(media, 'whatever');
 						deepStrictEqual(other, {
 							caption: undefined,
+							caption_entities: undefined,
 							parse_mode: undefined,
 							reply_markup: {
 								inline_keyboard: [],

test/send-menu/context-resend.ts

@@ -15,6 +15,7 @@ await test('context-resend on callback query', async t => {
 		strictEqual(text, 'whatever');
 		deepStrictEqual(other, {
 			disable_web_page_preview: false,
+			entities: undefined,
 			parse_mode: undefined,
 			reply_markup: {
 				inline_keyboard: [],
@@ -52,6 +53,7 @@ await test('context-resend on whatever', async t => {
 		strictEqual(text, 'whatever');
 		deepStrictEqual(other, {
 			disable_web_page_preview: false,
+			entities: undefined,
 			parse_mode: undefined,
 			reply_markup: {
 				inline_keyboard: [],