teidesu/mtcute
1
0
Fork 0
Code Issues 15 Pull requests 1 Projects Releases Packages Wiki Activity Actions

feat(parse-mode): compile-time formatted string compatibility check

Browse source
This commit is contained in:
teidesu 2022-05-06 00:11:28 +03:00
parent 28baf50958
commit d8111ea525
5 changed files with 44 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
packages/client/src/types/parser.ts
View file

@ -41,12 +41,12 @@ export interface IMessageEntityParser {
* Raw string that will not be escaped when passing
* to tagged template helpers (like `html` and `md`)
*/
export class FormattedString {
export class FormattedString<T extends string = never> {
/**
* @param value Value that the string holds
* @param mode Name of the parse mode used
*/
constructor (readonly value: string, readonly mode?: string) {}
constructor (readonly value: string, readonly mode?: T) {}
toString(): string {
return this.value

4
packages/html-parser/src/index.ts
View file

@ -20,8 +20,8 @@ const MENTION_REGEX =
*/
export function html(
strings: TemplateStringsArray,
...sub: (string | FormattedString)[]
): FormattedString {
...sub: (string | FormattedString<'html'>)[]
): FormattedString<'html'> {
let str = ''
sub.forEach((it, idx) => {
if (typeof it === 'string') it = HtmlMessageEntityParser.escape(it)

2
packages/html-parser/tests/html-parser.spec.ts
View file

@ -611,6 +611,8 @@ describe('HtmlMessageEntityParser', () => {
const unsafeString2 = new FormattedString('<&>', 'some-other-mode')
expect(() => html`${unsafeString}`.value).not.throw(Error)
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
expect(() => html`${unsafeString2}`.value).throw(Error)
})
})

54
packages/markdown-parser/src/index.ts
View file

@ -3,7 +3,8 @@ import { tl } from '@mtcute/tl'
import { FormattedString } from '@mtcute/client'
import Long from 'long'
const MENTION_REGEX = /^tg:\/\/user\?id=(\d+)(?:&hash=(-?[0-9a-fA-F]+)(?:&|$)|&|$)/
const MENTION_REGEX =
/^tg:\/\/user\?id=(\d+)(?:&hash=(-?[0-9a-fA-F]+)(?:&|$)|&|$)/
const TAG_BOLD = '**'
const TAG_ITALIC = '__'
@ -22,12 +23,17 @@ const TO_BE_ESCAPED = /[*_\-~`[\\\]]/g
* const escaped = md`**${user.displayName}**`
* ```
*/
export function md(strings: TemplateStringsArray, ...sub: (string | FormattedString)[]): FormattedString {
export function md(
strings: TemplateStringsArray,
...sub: (string | FormattedString<'markdown'>)[]
): FormattedString<'markdown'> {
let str = ''
sub.forEach((it, idx) => {
if (typeof it === 'string') it = MarkdownMessageEntityParser.escape(it as string)
if (typeof it === 'string')
it = MarkdownMessageEntityParser.escape(it as string)
else {
if (it.mode && it.mode !== 'markdown') throw new Error(`Incompatible parse mode: ${it.mode}`)
if (it.mode && it.mode !== 'markdown')
throw new Error(`Incompatible parse mode: ${it.mode}`)
it = it.value
}
@ -126,7 +132,9 @@ export class MarkdownMessageEntityParser implements IMessageEntityParser {
if (text[pos + 1] !== '(') {
// [link text]
// ignore this, and add opening [
result = `${result.substr(0, ent.offset)}[${result.substr(ent.offset)}]`
result = `${result.substr(0, ent.offset)}[${result.substr(
ent.offset
)}]`
pos += 1
insideLink = false
continue
@ -151,24 +159,34 @@ export class MarkdownMessageEntityParser implements IMessageEntityParser {
const userId = parseInt(m[1])
const accessHash = m[2]
if (accessHash) {
;(ent as tl.Mutable<tl.RawInputMessageEntityMentionName>)._ =
'inputMessageEntityMentionName'
;(ent as tl.Mutable<tl.RawInputMessageEntityMentionName>).userId = {
;(
ent as tl.Mutable<tl.RawInputMessageEntityMentionName>
)._ = 'inputMessageEntityMentionName'
;(
ent as tl.Mutable<tl.RawInputMessageEntityMentionName>
).userId = {
_: 'inputUser',
userId,
accessHash: Long.fromString(accessHash, false,16),
accessHash: Long.fromString(
accessHash,
false,
16
),
}
} else {
;(ent as tl.Mutable<tl.RawMessageEntityMentionName>)._ =
'messageEntityMentionName'
;(ent as tl.Mutable<tl.RawMessageEntityMentionName>).userId = userId
;(
ent as tl.Mutable<tl.RawMessageEntityMentionName>
)._ = 'messageEntityMentionName'
;(
ent as tl.Mutable<tl.RawMessageEntityMentionName>
).userId = userId
}
} else {
if (url.match(/^\/\//)) url = 'http:' + url
;(ent as tl.Mutable<tl.RawMessageEntityTextUrl>)._ =
'messageEntityTextUrl'
;(ent as tl.Mutable<tl.RawMessageEntityTextUrl>).url = url
;(ent as tl.Mutable<tl.RawMessageEntityTextUrl>).url =
url
}
entities.push(ent)
}
@ -230,12 +248,8 @@ export class MarkdownMessageEntityParser implements IMessageEntityParser {
if (c === text[pos + 1]) {
// maybe (?) start or end of an entity
let type:
| 'Italic'
| 'Bold'
| 'Underline'
| 'Strike'
| null = null
let type: 'Italic' | 'Bold' | 'Underline' | 'Strike' | null =
null
switch (c) {
case '_':
type = 'Italic'

6
packages/markdown-parser/tests/markdown-parser.spec.ts
View file

@ -3,7 +3,7 @@ import { expect } from 'chai'
import { tl } from '@mtcute/tl'
import { MessageEntity, FormattedString } from '@mtcute/client'
import { MarkdownMessageEntityParser, md } from '../src'
import bigInt from 'big-integer'
import Long from 'long'
const createEntity = <T extends tl.TypeMessageEntity['_']>(
type: T,
@ -356,7 +356,7 @@ describe('MarkdownMessageEntityParser', () => {
userId: {
_: 'inputUser',
userId: 1234567,
accessHash: bigInt('aabbccddaabbccdd', 16),
accessHash: Long.fromString('aabbccddaabbccdd', 16),
},
}),
],
@ -674,6 +674,8 @@ describe('MarkdownMessageEntityParser', () => {
const unsafeString2 = new FormattedString('<&>', 'some-other-mode')
expect(() => md`${unsafeString}`.value).not.throw(Error)
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
expect(() => md`${unsafeString2}`.value).throw(Error)
})
})