fork of https://gitlab.com/mx-puppet/discord/matrix-discord-parser forked in order to fix dependency on private npm module @mx-puppet/discord-markdown
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
forest 8034d2b898 fork discord-markdown to get around gitlab http errors 5 months ago
.github/workflows Create npm-publish.yml 10 months ago
.husky Prepare for gitlab 7 months ago
.yarn Prepare for gitlab 7 months ago
src Prepare for gitlab 7 months ago
test Fix failing test for invalid user pills 10 months ago
.gitignore Prepare for gitlab 7 months ago
.mocharc.yml update and stuffs 1 year ago
.nycrc add tests 3 years ago
.yarnrc.yml Prepare for gitlab 7 months ago
LICENSE Initial commit 3 years ago
README.md fix readme 3 years ago
package-lock.json Fix failing test for invalid user pills 10 months ago
package.json fork discord-markdown to get around gitlab http errors 5 months ago
tsconfig.json update and stuffs 1 year ago
tslint.json Refactored DiscordMessageParserResult 3 years ago
yarn.lock Update lockfile 7 months ago

README.md

#discord:half-shot.uk

matrix-discord-parser

This package is a message parser for sending messages between Matrix and Discord. For that, it has two parsers: DiscordMessageParser and MatrixMessageParser.

DiscordMessageParser

Example code:

import { DiscordMessageParser, IDiscordMessageParserOpts } from "matrix-discord-parser";

const parser = new DiscordMessageParser();

const opts = {
    callbacks: {
        getUser: async (id: string) => null,
        getChannel: async (id: string) => null,
        getEmoji: async (name: string, animated: boolean, id: string) => null;
    },
} as IDiscordMessageParserOpts;
const message = msg; // Type Discord.Message from discord.js
const result = await parser.FormatMessage(opts, msg);
console.log(result.body); // the body of the matrix message
console.log(result.formattedBody); // the formatted body of the matrix message
console.log(result.msgtype); // the msgtype of the matrix message

All options of IDiscordMessageParserOpts:

  • callbacks: IDiscordMessageParserCallbacks, the callbacks to handle
    • getUser: async (id: string) => Promise<IDiscordMessageParserEntity | null>, resolves to either the information on the specified discord user or to null
    • getChannel: async (id: string) => Promise<IDiscordMessageParserEntity | null>, resolves to either the information of the specified discord channel or to null
    • getEmoji: async (name: string, animated: boolean, id: string) => Promise<string | null>, resolves to either the mxc uri of the specified discord emoji or to null

All properties of IDiscordMessageParserEntity:

  • name: string, the name of the entity
  • mxid: string, the resulting matrix ID of the entity

All properties of IDiscordMessageParserResult:

  • body: string, the body of the result
  • formattedBody: string, the formatted (html) body of the result
  • msgtype: string, the matrix msgtype of the result

MatrixMessageParser

Example code:

import { MatrixMessageParser, IMatrixMessageParserOpts } from "matrix-discord-parser";

const parser = new MatrixMessageParser();

const opts = {
    callbacks: {
        canNotifyRoom: async () => false,
        getUserId: async (mxid: string) => null,
        getChannelId: async (mxid: string) => null,
        getEmoji: async (mxc: string, name: string) => null,
        mxcUrlToHttp: async (mxc: string) => "http://example.com",
    },
    displayname: "Alice",
    determineCodeLanguage: true,
} as IMatrixMessageParserOpts;

const msg = { // raw matrix event content
    msgtype: "m.text",
    body: "**blah**",
    format: "org.matrix.custom.html",
    formatted_body: "<strong>blah</strong>",
};

const parsed = await parser.FormatMessage(opts, msg);
msg.send(parsed); // send this message to discord

It is expected to create the options for a message within a closure so that the callbacks can determine if, for that particular message, the author may e.g. notify that particular room.

All options of IMatrixMessageParserOpts:

  • callbacks: IMatrixMessageParserCallbacks, the callbacks to handle
    • canNotifyRoom: async () => Promise<boolean>, return if that particular user can notify that particular room
    • getUserId: async (mxid: string) => Promise<string | null>, return the discord user ID given an mxid, or null
    • getChannelId: async (mxid: string) => Promise<string | null>, return the discord channel ID given an mxid, or null
    • getEmoji: async (mxc: string, name: string) => Promise<Discord.Emoji | null>, return a discord emoji given an mxc uri and a name, or null
    • mxcUrlToHttp: async (mxc: string) => Promise<string>, resolve an mxc uri to a publicly available http url.
  • displayname: string, the display name of the sender of the message (used for m.emote parsing)
  • determineCodeLanguage: Boolean (default false), wether the language of code-blocks should be auto-determined, if not specified

Returned is a discord-formatted string, ready to be sent.