@telegram-md/core 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# @telegram-md/core
+
+## 1.0.0
+
+### Major Changes
+
+- [`3c677a5`](https://github.com/vlad-iakovlev/telegram-md/commit/3c677a50ce5071d3561165d3e196ed77ed7d0a8c) Thanks [@vlad-iakovlev](https://github.com/vlad-iakovlev)! - Initial monorepo release
+  - Latest `@telegram-md/core` release notes: https://github.com/vlad-iakovlev/telegram-md/releases/tag/v2.1.0
+  - Latest `@telegram-md/grammy-plugin` release notes: https://github.com/vlad-iakovlev/grammy-reply-with-markdown/releases/tag/v2.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Vladislav Iakovlev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,132 @@
+# @telegram-md/core
+
+Telegram MarkdownV2 formatter
+
+[![NPM](https://img.shields.io/npm/v/@telegram-md/core)](https://www.npmjs.org/package/@telegram-md/core)
+
+`@telegram-md/core` is a powerful TypesScript library designed to simplify the formatting of text messages in Telegram MarkdownV2 format. It provides a range of methods for applying markdown formatting, such as bold, italic, and links, making it easier to create richly formatted messages programmatically.
+
+## Table of Contents
+
+1. [How to Install](#how-to-install)
+2. [Usage Examples](#usage-examples)
+3. [API Documentation](#api-documentation)
+
+## How to install
+
+```sh
+npm install @telegram-md/core
+```
+
+## Usage Examples
+
+```ts
+import { md } from '@telegram-md/core'
+
+// Simple message formatting
+const message = md`Hello, ${md.bold('World')}!`
+api.sendMessage(chatId, md.build(message))
+
+// Using different formatting styles
+const complexMessage = md`
+  This is an ${md.italic('italic')}
+  and ${md.bold('bold')} text
+  with a ${md.link('link', 'http://example.com')}!
+`
+api.sendMessage(chatId, md.build(complexMessage))
+```
+
+## API Documentation
+
+Every method escapes all unescaped input. Input is assumed to be escaped only when it's an instance of Markdown.
+
+### Markdown
+
+Stores the result of executing md methods. Used to differentiate between normal strings and escaped strings.
+
+### md
+
+Template tag which can be used to build markdown formatted messages.
+
+```ts
+md`Hello, ${md.bold('World')}!` // => Markdown with value 'Hello, *World*\\!'
+```
+
+### md.build
+
+Returns message text that cat be safely sent to telegram API.
+
+```ts
+md.build(md`Hello, ${md.bold('World')}!`) // => 'Hello, *World*\\!'
+md.build('Hello, World!') // => 'Hello, World\\!'
+```
+
+### md.bold
+
+```ts
+md.bold('bold *text') // => Markdown with value '*bold \*text*'
+```
+
+### md.italic
+
+```ts
+md.italic('italic *text') // => Markdown with value '_italic \*text_'
+```
+
+### md.underline
+
+```ts
+md.underline('underline') // => Markdown with value '__underline__'
+```
+
+### md.strikethrough
+
+```ts
+md.strikethrough('strikethrough') // => Markdown with value '~strikethrough~'
+```
+
+### md.spoiler
+
+```ts
+md.spoiler('spoiler') // => Markdown with value '||spoiler||'
+```
+
+### md.link
+
+```ts
+md.link('inline URL', 'http://www.example.com/') // => Markdown with value '[inline URL](http://www\\.example\\.com/)'
+md.link('inline mention of a user', 'tg://user?id=123456789') // => Markdown with value '[inline mention of a user](tg://user?id\\=123456789)'
+```
+
+### md.inlineCode
+
+```ts
+md.inlineCode('inline fixed-width code') // => Markdown with value '`inline fixed\\-width code`'
+```
+
+### md.blockquote
+
+```ts
+md.blockquote('blockquote') // => Markdown with value '>blockquote'
+```
+
+### md.codeBlock
+
+````ts
+md.code(
+  'pre-formatted fixed-width code block',
+) // => Markdown with value
+```
+pre\\-formatted fixed\\-width code block
+```
+````
+
+````ts
+md.code(
+  'pre-formatted fixed-width code block written in the Python',
+  'python',
+) // => Markdown with value
+```python
+pre\\-formatted fixed\\-width code block written in the Python
+```
+````

package/dist/_escape.d.ts

@@ -0,0 +1 @@
+export declare const _escape: (text: string) => string;

package/dist/_escape.js

@@ -0,0 +1 @@
+export const _escape = (text) => text.replace(/([_*[\]()~`>#+\-=|{}.!])/g, '\\$1');

package/dist/_toMarkdown.d.ts

@@ -0,0 +1,2 @@
+import { Markdown } from './markdown.js';
+export declare const _toMarkdown: (text?: unknown, escaped?: boolean) => Markdown;

package/dist/_toMarkdown.js

@@ -0,0 +1,7 @@
+import { Markdown } from './markdown.js';
+export const _toMarkdown = (text, escaped) => {
+    if (text instanceof Markdown) {
+        return text;
+    }
+    return new Markdown(text, escaped);
+};

package/dist/blockquote.d.ts

@@ -0,0 +1,7 @@
+import { Markdown } from './markdown.js';
+/**
+ * Make text with blockquote
+ * @example
+ * md.blockquote('text') // => Markdown with value '>text'
+ */
+export declare const blockquote: (text: unknown) => Markdown;

package/dist/blockquote.js

@@ -0,0 +1,12 @@
+import { _toMarkdown } from './_toMarkdown.js';
+/**
+ * Make text with blockquote
+ * @example
+ * md.blockquote('text') // => Markdown with value '>text'
+ */
+export const blockquote = (text) => {
+    if (!text) {
+        return _toMarkdown();
+    }
+    return _toMarkdown(`>${_toMarkdown(text)}`, true);
+};

package/dist/bold.d.ts

@@ -0,0 +1,7 @@
+import { Markdown } from './markdown.js';
+/**
+ * Make text bold
+ * @example
+ * md.bold('bold *text') // => Markdown with value '*bold \*text*'
+ */
+export declare const bold: (text: unknown) => Markdown;

package/dist/bold.js

@@ -0,0 +1,12 @@
+import { _toMarkdown } from './_toMarkdown.js';
+/**
+ * Make text bold
+ * @example
+ * md.bold('bold *text') // => Markdown with value '*bold \*text*'
+ */
+export const bold = (text) => {
+    if (!text) {
+        return _toMarkdown();
+    }
+    return _toMarkdown(`*${_toMarkdown(text)}*`, true);
+};

package/dist/build.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Build message text for telegram API
+ * @example
+ * md.build(md`Hello, ${md.bold('World')}!`) // => 'Hello, *World*\\!'
+ * md.build('Hello, World!') // => 'Hello, World\\!'
+ */
+export declare const build: (text: unknown) => string;

package/dist/build.js

@@ -0,0 +1,8 @@
+import { _toMarkdown } from './_toMarkdown.js';
+/**
+ * Build message text for telegram API
+ * @example
+ * md.build(md`Hello, ${md.bold('World')}!`) // => 'Hello, *World*\\!'
+ * md.build('Hello, World!') // => 'Hello, World\\!'
+ */
+export const build = (text) => _toMarkdown(text).value;

package/dist/codeBlock.d.ts

@@ -0,0 +1,11 @@
+import { Markdown } from './markdown.js';
+/**
+ * Create code block
+ * @example
+ * md.code('pre-formatted fixed-width code block')
+ * // => Markdown with value '```\npre\\-formatted fixed\\-width code block\n```'
+ *
+ * md.code('pre-formatted fixed-width code block written in the Python', 'python')
+ * // => Markdown with value '```python\npre\\-formatted fixed\\-width code block written in the Python\n```'
+ */
+export declare const codeBlock: (code: unknown, language?: string) => Markdown;

package/dist/codeBlock.js

@@ -0,0 +1,16 @@
+import { _toMarkdown } from './_toMarkdown.js';
+/**
+ * Create code block
+ * @example
+ * md.code('pre-formatted fixed-width code block')
+ * // => Markdown with value '```\npre\\-formatted fixed\\-width code block\n```'
+ *
+ * md.code('pre-formatted fixed-width code block written in the Python', 'python')
+ * // => Markdown with value '```python\npre\\-formatted fixed\\-width code block written in the Python\n```'
+ */
+export const codeBlock = (code, language = '') => {
+    if (!code) {
+        return _toMarkdown();
+    }
+    return _toMarkdown(`\`\`\`${_toMarkdown(language)}\n${_toMarkdown(code)}\n\`\`\``, true);
+};

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import { Markdown } from './markdown.js';
+export { Markdown };
+/**
+ * Creates Markdown from template
+ * @example
+ * md`Hello, ${md.bold('World')}!` // => Markdown with value 'Hello, *World*\\!'
+ */
+export declare const md: {
+    (strings: TemplateStringsArray, ...values: unknown[]): Markdown;
+    blockquote: (text: unknown) => Markdown;
+    bold: (text: unknown) => Markdown;
+    build: (text: unknown) => string;
+    codeBlock: (code: unknown, language?: string) => Markdown;
+    inlineCode: (code: unknown) => Markdown;
+    italic: (text: unknown) => Markdown;
+    join: (texts: unknown[], separator?: unknown) => Markdown;
+    link: (name: unknown, url: unknown) => Markdown;
+    spoiler: (text: unknown) => Markdown;
+    strikethrough: (text: unknown) => Markdown;
+    underline: (text: unknown) => Markdown;
+};

package/dist/index.js

@@ -0,0 +1,38 @@
+import { _toMarkdown } from './_toMarkdown.js';
+import { blockquote } from './blockquote.js';
+import { bold } from './bold.js';
+import { build } from './build.js';
+import { codeBlock } from './codeBlock.js';
+import { inlineCode } from './inlineCode.js';
+import { italic } from './italic.js';
+import { join } from './join.js';
+import { link } from './link.js';
+import { Markdown } from './markdown.js';
+import { spoiler } from './spoiler.js';
+import { strikethrough } from './strikethrough.js';
+import { underline } from './underline.js';
+// istanbul ignore next
+export { Markdown };
+/**
+ * Creates Markdown from template
+ * @example
+ * md`Hello, ${md.bold('World')}!` // => Markdown with value 'Hello, *World*\\!'
+ */
+export const md = (strings, ...values) => {
+    let result = `${_toMarkdown(strings[0])}`;
+    for (let i = 1; i < strings.length; i += 1) {
+        result += `${_toMarkdown(values[i - 1])}${_toMarkdown(strings[i])}`;
+    }
+    return _toMarkdown(result, true);
+};
+md.blockquote = blockquote;
+md.bold = bold;
+md.build = build;
+md.codeBlock = codeBlock;
+md.inlineCode = inlineCode;
+md.italic = italic;
+md.join = join;
+md.link = link;
+md.spoiler = spoiler;
+md.strikethrough = strikethrough;
+md.underline = underline;

package/dist/inlineCode.d.ts

@@ -0,0 +1,7 @@
+import { Markdown } from './markdown.js';
+/**
+ * Create inline code
+ * @example
+ * md.inlineCode('inline fixed-width code') // => Markdown with value '`inline fixed\\-width code`'
+ */
+export declare const inlineCode: (code: unknown) => Markdown;

package/dist/inlineCode.js

@@ -0,0 +1,12 @@
+import { _toMarkdown } from './_toMarkdown.js';
+/**
+ * Create inline code
+ * @example
+ * md.inlineCode('inline fixed-width code') // => Markdown with value '`inline fixed\\-width code`'
+ */
+export const inlineCode = (code) => {
+    if (!code) {
+        return _toMarkdown();
+    }
+    return _toMarkdown(`\`${_toMarkdown(code)}\``, true);
+};

package/dist/italic.d.ts

@@ -0,0 +1,7 @@
+import { Markdown } from './markdown.js';
+/**
+ * Make text italic
+ * @example
+ * md.italic('italic *text') // => Markdown with value '_italic \*text_'
+ */
+export declare const italic: (text: unknown) => Markdown;

package/dist/italic.js

@@ -0,0 +1,12 @@
+import { _toMarkdown } from './_toMarkdown.js';
+/**
+ * Make text italic
+ * @example
+ * md.italic('italic *text') // => Markdown with value '_italic \*text_'
+ */
+export const italic = (text) => {
+    if (!text) {
+        return _toMarkdown();
+    }
+    return _toMarkdown(`_${_toMarkdown(text)}_`, true);
+};

package/dist/join.d.ts

@@ -0,0 +1,7 @@
+import { Markdown } from './markdown.js';
+/**
+ * Join items
+ * @example
+ *    md.join(['foo_bar', 'bar_baz'], '\n') // => Markdown with value 'foo\\_bar\nbar\\_baz'
+ */
+export declare const join: (texts: unknown[], separator?: unknown) => Markdown;

package/dist/join.js

@@ -0,0 +1,12 @@
+import { _toMarkdown } from './_toMarkdown.js';
+/**
+ * Join items
+ * @example
+ *    md.join(['foo_bar', 'bar_baz'], '\n') // => Markdown with value 'foo\\_bar\nbar\\_baz'
+ */
+export const join = (texts, separator = '') => {
+    const value = texts
+        .map((text) => _toMarkdown(text))
+        .join(String(_toMarkdown(separator)));
+    return _toMarkdown(value, true);
+};

package/dist/link.d.ts

@@ -0,0 +1,11 @@
+import { Markdown } from './markdown.js';
+/**
+ * Creates link
+ * @example
+ * md.link('inline URL', 'http://www.example.com/')
+ * // => Markdown with value '[inline URL](http://www\\.example\\.com/)'
+ *
+ * md.link('inline mention of a user', 'tg://user?id=123456789')
+ * // => Markdown with value '[inline mention of a user](tg://user?id\\=123456789)'
+ */
+export declare const link: (name: unknown, url: unknown) => Markdown;

package/dist/link.js

@@ -0,0 +1,22 @@
+import { _toMarkdown } from './_toMarkdown.js';
+/**
+ * Creates link
+ * @example
+ * md.link('inline URL', 'http://www.example.com/')
+ * // => Markdown with value '[inline URL](http://www\\.example\\.com/)'
+ *
+ * md.link('inline mention of a user', 'tg://user?id=123456789')
+ * // => Markdown with value '[inline mention of a user](tg://user?id\\=123456789)'
+ */
+export const link = (name, url) => {
+    if (!name && !url) {
+        return _toMarkdown();
+    }
+    if (!name) {
+        return _toMarkdown(url);
+    }
+    if (!url) {
+        return _toMarkdown(name);
+    }
+    return _toMarkdown(`[${_toMarkdown(name)}](${_toMarkdown(url)})`, true);
+};

package/dist/markdown.d.ts

@@ -0,0 +1,5 @@
+export declare class Markdown {
+    value: string;
+    constructor(value?: unknown, escaped?: boolean);
+    toString(): string;
+}

package/dist/markdown.js

@@ -0,0 +1,10 @@
+import { _escape } from './_escape.js';
+export class Markdown {
+    value;
+    constructor(value = '', escaped = false) {
+        this.value = escaped ? String(value) : _escape(String(value));
+    }
+    toString() {
+        return this.value;
+    }
+}

package/dist/spoiler.d.ts

@@ -0,0 +1,7 @@
+import { Markdown } from './markdown.js';
+/**
+ * Creates spoiler
+ * @example
+ * md.spoiler('spoiler') // => Markdown with value '||spoiler||'
+ */
+export declare const spoiler: (text: unknown) => Markdown;

package/dist/spoiler.js

@@ -0,0 +1,12 @@
+import { _toMarkdown } from './_toMarkdown.js';
+/**
+ * Creates spoiler
+ * @example
+ * md.spoiler('spoiler') // => Markdown with value '||spoiler||'
+ */
+export const spoiler = (text) => {
+    if (!text) {
+        return _toMarkdown();
+    }
+    return _toMarkdown(`||${_toMarkdown(text)}||`, true);
+};

package/dist/strikethrough.d.ts

@@ -0,0 +1,7 @@
+import { Markdown } from './markdown.js';
+/**
+ * Strikethrough text
+ * @example
+ * md.strikethrough('strikethrough') // => Markdown with value '~strikethrough~'
+ */
+export declare const strikethrough: (text: unknown) => Markdown;

package/dist/strikethrough.js

@@ -0,0 +1,12 @@
+import { _toMarkdown } from './_toMarkdown.js';
+/**
+ * Strikethrough text
+ * @example
+ * md.strikethrough('strikethrough') // => Markdown with value '~strikethrough~'
+ */
+export const strikethrough = (text) => {
+    if (!text) {
+        return _toMarkdown();
+    }
+    return _toMarkdown(`~${_toMarkdown(text)}~`, true);
+};

package/dist/underline.d.ts

@@ -0,0 +1,7 @@
+import { Markdown } from './markdown.js';
+/**
+ * Underline text
+ * @example
+ * md.underline('underline') // => Markdown with value '__underline__'
+ */
+export declare const underline: (text: unknown) => Markdown;

package/dist/underline.js

@@ -0,0 +1,12 @@
+import { _toMarkdown } from './_toMarkdown.js';
+/**
+ * Underline text
+ * @example
+ * md.underline('underline') // => Markdown with value '__underline__'
+ */
+export const underline = (text) => {
+    if (!text) {
+        return _toMarkdown();
+    }
+    return _toMarkdown(`__${_toMarkdown(text)}__`, true);
+};

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@telegram-md/core",
+  "version": "1.0.0",
+  "description": "Telegram MarkdownV2 parser",
+  "keywords": [
+    "telegram",
+    "markdown",
+    "parser",
+    "md"
+  ],
+  "homepage": "https://github.com/vlad-iakovlev/telegram-md#readme",
+  "bugs": "https://github.com/vlad-iakovlev/telegram-md/issues",
+  "repository": "https://github.com/vlad-iakovlev/telegram-md.git",
+  "license": "MIT",
+  "author": "Vladislav Iakovlev",
+  "type": "module",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "compile": "tsc --noEmit"
+  }
+}