Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 4 additions & 20 deletions packages/message-parser/src/definitions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -198,29 +198,13 @@ export type Types = {
LIST_ITEM: ListItem;
IMAGE: Image;
LINE_BREAK: LineBreak;
KATEX: KaTeX;
INLINE_KATEX: InlineKaTeX;
TIMESTAMP: Timestamp;
SPOILER_BLOCK: SpoilerBlock;
};

export type ASTNode =
| BigEmoji
| Bold
| Spoiler
| Paragraph
| Plain
| Italic
| Strike
| Code
| CodeLine
| InlineCode
| Heading
| Quote
| SpoilerBlock
| Link
| UserMention
| ChannelMention
| Emoji
| Color
| Tasks;
export type ASTNode = Types[keyof Types];

export type TypesKeys = keyof Types;

Expand Down
2 changes: 1 addition & 1 deletion packages/message-parser/src/guards.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { ASTNode } from './definitions';

export const isNodeOfType = <N extends ASTNode>(value: unknown, type: N['type']): value is N =>
export const isNodeOfType = <T extends ASTNode['type']>(value: unknown, type: T): value is Extract<ASTNode, { type: T }> =>
typeof value === 'object' && value !== null && 'type' in value && (value as { type: unknown }).type === type;
62 changes: 62 additions & 0 deletions packages/message-parser/tests/guards.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import { isNodeOfType, parse } from '../src';
import type { Image, OrderedList, Timestamp } from '../src/definitions';
import { timestamp } from '../src/utils';

describe('isNodeOfType', () => {
it('narrows timestamp nodes', () => {
const value: unknown = timestamp('1708551317');

expect(isNodeOfType(value, 'TIMESTAMP')).toBe(true);

if (!isNodeOfType(value, 'TIMESTAMP')) {
throw new Error('expected TIMESTAMP node');
}

const narrowed: Timestamp = value;
expect(value.value.timestamp).toBe('1708551317');
expect(value.value.format).toBe('t');
expect(narrowed.value.format).toBe('t');
});

it('narrows ordered list nodes from parser output', () => {
const value: unknown = parse('1. one')[0];

expect(isNodeOfType(value, 'ORDERED_LIST')).toBe(true);

if (!isNodeOfType(value, 'ORDERED_LIST')) {
throw new Error('expected ORDERED_LIST node');
}

const narrowed: OrderedList = value;
expect(value.value[0].number).toBe(1);
expect(narrowed.value[0].number).toBe(1);
});

it('narrows image nodes from parser output', () => {
const paragraph: unknown = parse('![logo](https://rocket.chat/logo.png)')[0];

expect(isNodeOfType(paragraph, 'PARAGRAPH')).toBe(true);

if (!isNodeOfType(paragraph, 'PARAGRAPH')) {
throw new Error('expected PARAGRAPH node');
}

const imageNode: unknown = paragraph.value[0];

expect(isNodeOfType(imageNode, 'IMAGE')).toBe(true);

if (!isNodeOfType(imageNode, 'IMAGE')) {
throw new Error('expected IMAGE node');
}

const narrowed: Image = imageNode;
expect(imageNode.value.src.value).toBe('https://rocket.chat/logo.png');
expect(narrowed.value.src.value).toBe('https://rocket.chat/logo.png');
});

it('returns false for mismatched types', () => {
const value: unknown = timestamp('1708551317');

expect(isNodeOfType(value, 'ORDERED_LIST')).toBe(false);
});
});
Loading