28 Commits

Author SHA1 Message Date
itsMapleLeaf
69b3112d32 account for trailing slashes 2023-03-12 16:50:11 -05:00
itsMapleLeaf
b4fb6bc47c website cleanup 2023-03-12 16:38:32 -05:00
itsMapleLeaf
7aaef5f85f lint fixe 2023-03-12 16:38:26 -05:00
itsMapleLeaf
b755290569 skip website test for now 2023-03-12 16:29:46 -05:00
itsMapleLeaf
f0ad743080 menu improvements 2023-03-12 16:28:51 -05:00
itsMapleLeaf
af3d1c5058 add start script 2023-03-12 16:26:47 -05:00
itsMapleLeaf
bdee9454f2 disable ligatures 2023-03-12 16:19:52 -05:00
itsMapleLeaf
84348d287f active link style 2023-03-12 16:14:46 -05:00
itsMapleLeaf
6da6008d2c guide pages (why was that so easy wtf) 2023-03-12 15:58:47 -05:00
itsMapleLeaf
bece6c42fc ignore .vercel 2023-03-12 15:12:41 -05:00
itsMapleLeaf
abc809c9fb always run typedoc before build 2023-03-12 15:08:57 -05:00
itsMapleLeaf
d35659f6f6 fix website build 2023-03-12 15:01:12 -05:00
itsMapleLeaf
3969e6471f finished landing 2023-03-12 14:43:53 -05:00
itsMapleLeaf
95041acfd4 root layout 2023-03-12 13:36:03 -05:00
itsMapleLeaf
eb0409f1a2 add astro and configure some things 2023-03-12 13:20:49 -05:00
itsMapleLeaf
fbab145f39 fix dev script 2023-03-12 12:53:37 -05:00
itsMapleLeaf
f59323f245 remove node dep 2022-10-15 00:27:33 -05:00
itsMapleLeaf
1c37d37c28 vercel must be stopped 2022-10-14 14:01:58 -05:00
itsMapleLeaf
408ab4ce89 add version to helpers package 2022-10-14 13:59:27 -05:00
itsMapleLeaf
a8a64e601a pnpm lock 2022-10-14 13:56:45 -05:00
itsMapleLeaf
d88b982830 remove old release script 2022-10-14 13:55:16 -05:00
itsMapleLeaf
d87c27183a upgrades 2022-10-14 13:42:50 -05:00
itsMapleLeaf
b141ca1868 Merge branch 'main' of https://github.com/itsMapleLeaf/reacord 2022-10-14 13:35:14 -05:00
itsMapleLeaf
dfa7f8090c update github workflows 2022-10-14 13:35:12 -05:00
Darius
82068d2d83 Merge pull request #22 from itsMapleLeaf/changeset-release/main
Version Packages
2022-10-14 13:28:30 -05:00
github-actions[bot]
216ae7a29a Version Packages 2022-10-14 18:25:32 +00:00
itsMapleLeaf
9813a01a19 import react-reconciler/constants.js for esm 2022-10-14 13:24:12 -05:00
itsMapleLeaf
0be321b64e move helpers to new workspace folder 2022-10-14 13:22:55 -05:00
158 changed files with 5516 additions and 9931 deletions

View File

@@ -13,6 +13,7 @@ module.exports = {
], ],
parserOptions: { parserOptions: {
project: require.resolve("./tsconfig.base.json"), project: require.resolve("./tsconfig.base.json"),
extraFileExtensions: [".astro"],
}, },
overrides: [ overrides: [
{ {
@@ -21,5 +22,17 @@ module.exports = {
project: require.resolve("./packages/website/cypress/tsconfig.json"), project: require.resolve("./packages/website/cypress/tsconfig.json"),
}, },
}, },
{
files: ["*.astro"],
parser: "astro-eslint-parser",
parserOptions: {
parser: "@typescript-eslint/parser",
},
rules: {
"react/no-unknown-property": "off",
"react/jsx-key": "off",
"react/jsx-no-undef": "off",
},
},
], ],
} }

View File

@@ -9,7 +9,6 @@ env:
TEST_BOT_TOKEN: ${{ secrets.TEST_BOT_TOKEN }} TEST_BOT_TOKEN: ${{ secrets.TEST_BOT_TOKEN }}
TEST_CHANNEL_ID: ${{ secrets.TEST_CHANNEL_ID }} TEST_CHANNEL_ID: ${{ secrets.TEST_CHANNEL_ID }}
TEST_GUILD_ID: ${{ secrets.TEST_GUILD_ID }} TEST_GUILD_ID: ${{ secrets.TEST_GUILD_ID }}
TEST_CATEGORY_ID: ${{ secrets.TEST_CATEGORY_ID }}
concurrency: concurrency:
group: ${{ github.workflow }}-${{ github.ref }} group: ${{ github.workflow }}-${{ github.ref }}
@@ -21,13 +20,12 @@ jobs:
fail-fast: false fail-fast: false
matrix: matrix:
command: command:
# if tests run in the same process, it dies, # if these run in the same process, it dies,
# so we test them separate # so we test them separate
- name: test - name: test reacord
run: pnpm test run: pnpm -C packages/reacord test
- name: test website # - name: test website
# the cache doesn't include cypress install, need to do it manually here # run: pnpm -C packages/website test
run: pnpm -C packages/website exec cypress install && pnpm -C packages/website test
- name: build - name: build
run: pnpm --recursive run build run: pnpm --recursive run build
- name: lint - name: lint
@@ -37,14 +35,19 @@ jobs:
name: ${{ matrix.command.name }} name: ${{ matrix.command.name }}
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - name: checkout
- uses: pnpm/action-setup@v2 uses: actions/checkout@v3
- name: setup pnpm
uses: pnpm/action-setup@v2
with: with:
version: 7.8.0 version: 7.13.4
- uses: actions/setup-node@v2
- name: setup node
uses: actions/setup-node@v3
with: with:
# https://github.com/actions/setup-node#supported-version-syntax node-version: 16
node-version: "16" cache: pnpm
cache: "pnpm"
- run: pnpm install --frozen-lockfile - run: pnpm install --frozen-lockfile
- run: ${{ matrix.command.run }} - run: ${{ matrix.command.run }}

View File

@@ -14,15 +14,18 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: checkout - name: checkout
uses: actions/checkout@v2 uses: actions/checkout@v3
- name: setup pnpm
uses: pnpm/action-setup@v2
with:
version: 7.13.4
- name: setup node - name: setup node
uses: actions/setup-node@v2 uses: actions/setup-node@v3
with: with:
node-version: 16 node-version: 16
cache: pnpm
- name: install pnpm
run: npm install -g pnpm
- name: install deps - name: install deps
run: pnpm install --frozen-lockfile run: pnpm install --frozen-lockfile

2
.gitignore vendored
View File

@@ -8,3 +8,5 @@ coverage
build build
.cache .cache
.vercel

14
.prettierrc.cjs Normal file
View File

@@ -0,0 +1,14 @@
const base = require("@itsmapleleaf/configs/prettier")
module.exports = {
...base,
plugins: [require.resolve("prettier-plugin-astro")],
overrides: [
{
files: "*.astro",
options: {
parser: "astro",
},
},
],
}

View File

@@ -4,28 +4,23 @@
"scripts": { "scripts": {
"lint": "eslint --ext js,ts,tsx .", "lint": "eslint --ext js,ts,tsx .",
"lint-fix": "pnpm lint -- --fix", "lint-fix": "pnpm lint -- --fix",
"test": "vitest --coverage --no-watch",
"test-dev": "vitest --ui",
"format": "prettier --write .", "format": "prettier --write .",
"build": "pnpm -r run build", "build": "pnpm -r run build",
"start": "pnpm -C packages/website run start", "start": "pnpm -C packages/website run start",
"release": "pnpm -r run build && changeset publish" "release": "pnpm -r run build && changeset publish"
}, },
"devDependencies": { "devDependencies": {
"@changesets/cli": "^2.24.2", "@changesets/cli": "^2.25.0",
"@itsmapleleaf/configs": "^1.1.5", "@itsmapleleaf/configs": "^1.1.7",
"@rushstack/eslint-patch": "^1.1.4", "@rushstack/eslint-patch": "^1.2.0",
"@types/eslint": "^8.4.5", "@types/eslint": "^8.4.6",
"@vitest/ui": "^0.21.0", "astro-eslint-parser": "^0.12.0",
"c8": "^7.12.0", "eslint": "^8.36.0",
"eslint": "^8.21.0",
"node": "^16.16.0",
"prettier": "^2.7.1", "prettier": "^2.7.1",
"typescript": "^4.7.4", "prettier-plugin-astro": "^0.8.0",
"vitest": "^0.21.0" "typescript": "^4.8.4"
}, },
"resolutions": { "resolutions": {
"esbuild": "latest" "esbuild": "latest"
}, }
"prettier": "@itsmapleleaf/configs/prettier"
} }

View File

@@ -1,35 +0,0 @@
export type AsyncCallback<T> = () => T
type QueueItem = {
callback: AsyncCallback<unknown>
resolve: (value: unknown) => void
reject: (error: unknown) => void
}
export class AsyncQueue {
private items: QueueItem[] = []
private running = false
append<T>(callback: AsyncCallback<T>): Promise<Awaited<T>> {
return new Promise((resolve, reject) => {
this.items.push({ callback, resolve: resolve as any, reject })
void this.run()
})
}
private async run() {
if (this.running) return
this.running = true
let item
while ((item = this.items.shift())) {
try {
item.resolve(await item.callback())
} catch (error) {
item.reject(error)
}
}
this.running = false
}
}

View File

@@ -1,21 +0,0 @@
export function generatePropCombinations<P>(values: {
[K in keyof P]: ReadonlyArray<P[K]>
}) {
return generatePropCombinationsRecursive(values) as P[]
}
function generatePropCombinationsRecursive(
value: Record<string, readonly unknown[]>,
): Array<Record<string, unknown>> {
const [key] = Object.keys(value)
if (!key) return [{}]
const { [key]: values = [], ...otherValues } = value
const result: Array<Record<string, unknown>> = []
for (const value of values) {
for (const otherValue of generatePropCombinationsRecursive(otherValues)) {
result.push({ [key]: value, ...otherValue })
}
}
return result
}

View File

@@ -1,11 +1,11 @@
{ {
"name": "@reacord/helpers", "name": "@reacord/helpers",
"type": "module", "version": "0.0.0",
"private": true, "private": true,
"dependencies": { "dependencies": {
"@types/lodash-es": "^4.17.6", "@types/lodash-es": "^4.17.6",
"@types/node": "*",
"lodash-es": "^4.17.21", "lodash-es": "^4.17.21",
"type-fest": "^2.18.0" "type-fest": "^2.17.0",
"vitest": "^0.18.1"
} }
} }

View File

@@ -10,7 +10,7 @@ export function pruneNullishValues<T>(input: T): PruneNullishValues<T> {
} }
const result: any = {} const result: any = {}
for (const [key, value] of Object.entries(input)) { for (const [key, value] of Object.entries(input as any)) {
if (value != undefined) { if (value != undefined) {
result[key] = pruneNullishValues(value) result[key] = pruneNullishValues(value)
} }

View File

@@ -1,3 +0,0 @@
{
"extends": "../../tsconfig.base.json"
}

View File

@@ -1,21 +0,0 @@
{
"name": "@reacord/playground",
"version": "0.0.0",
"type": "module",
"scripts": {
"dev": "tsx watch src/main.tsx"
},
"dependencies": {
"@reacord/helpers": "workspace:*",
"discord.js": "^14.1.2",
"dotenv": "^16.0.1",
"ora": "^6.1.2",
"react": "^18.2.0"
},
"devDependencies": {
"@types/node": "*",
"@types/react": "^18.0.16",
"tsx": "^3.8.0",
"typescript": "^4.7.4"
}
}

View File

@@ -1,54 +0,0 @@
import { raise } from "@reacord/helpers/raise"
import { Client, GatewayIntentBits } from "discord.js"
import * as dotenv from "dotenv"
import { join } from "node:path"
import { fileURLToPath } from "node:url"
import { oraPromise } from "ora"
import React from "react"
import { Button, ReacordClient } from "../../reacord/src/main"
dotenv.config({
path: join(fileURLToPath(import.meta.url), "../../../../.env"),
override: true,
})
const token = process.env.TEST_BOT_TOKEN ?? raise("TEST_BOT_TOKEN not defined")
const client = new Client({ intents: [GatewayIntentBits.Guilds] })
const reacord = new ReacordClient({ token })
client.once("ready", async (client) => {
try {
await oraPromise(
client.application.commands.create({
name: "counter",
description: "counts things",
}),
"Registering commands",
)
} catch (error) {
console.error("Failed to register commands:", error)
}
})
client.on("interactionCreate", async (interaction) => {
if (
interaction.isChatInputCommand() &&
interaction.commandName === "counter"
) {
reacord.reply(interaction, <Counter />)
// reacord.reply(interaction, "test3").render("test4")
}
})
await oraPromise(client.login(token), "Logging in")
function Counter() {
const [count, setCount] = React.useState(0)
return (
<>
count: {count}
<Button label="+" onClick={() => setCount(count + 1)} />
</>
)
}

View File

@@ -1,3 +0,0 @@
{
"extends": "../../tsconfig.base.json"
}

View File

@@ -1,5 +1,13 @@
# reacord # reacord
## 0.5.2
### Patch Changes
- 9813a01: import react-reconciler/constants.js for esm
ESM projects which tried to import reacord would fail due to the lack of .js on this import
## 0.5.1 ## 0.5.1
### Patch Changes ### Patch Changes

View File

@@ -0,0 +1,113 @@
import type { ReactNode } from "react"
import type { ReacordInstance } from "./instance"
/**
* @category Component Event
*/
export type ComponentEvent = {
/**
* The message associated with this event.
* For example: with a button click,
* this is the message that the button is on.
* @see https://discord.com/developers/docs/resources/channel#message-object
*/
message: MessageInfo
/**
* The channel that this event occurred in.
* @see https://discord.com/developers/docs/resources/channel#channel-object
*/
channel: ChannelInfo
/**
* The user that triggered this event.
* @see https://discord.com/developers/docs/resources/user#user-object
*/
user: UserInfo
/**
* The guild that this event occurred in.
* @see https://discord.com/developers/docs/resources/guild#guild-object
*/
guild?: GuildInfo
/**
* Create a new reply to this event.
*/
reply(content?: ReactNode): ReacordInstance
/**
* Create an ephemeral reply to this event,
* shown only to the user who triggered it.
*/
ephemeralReply(content?: ReactNode): ReacordInstance
}
/**
* @category Component Event
*/
export type ChannelInfo = {
id: string
name?: string
topic?: string
nsfw?: boolean
lastMessageId?: string
ownerId?: string
parentId?: string
rateLimitPerUser?: number
}
/**
* @category Component Event
*/
export type MessageInfo = {
id: string
channelId: string
authorId: UserInfo
member?: GuildMemberInfo
content: string
timestamp: string
editedTimestamp?: string
tts: boolean
mentionEveryone: boolean
/** The IDs of mentioned users */
mentions: string[]
}
/**
* @category Component Event
*/
export type GuildInfo = {
id: string
name: string
member: GuildMemberInfo
}
/**
* @category Component Event
*/
export type GuildMemberInfo = {
id: string
nick?: string
displayName: string
avatarUrl?: string
displayAvatarUrl: string
roles: string[]
color: number
joinedAt?: string
premiumSince?: string
pending?: boolean
communicationDisabledUntil?: string
}
/**
* @category Component Event
*/
export type UserInfo = {
id: string
username: string
discriminator: string
tag: string
avatarUrl: string
accentColor?: number
}

View File

@@ -1,7 +1,8 @@
import type { ReactNode } from "react" import type { ReactNode } from "react"
import React from "react" import React from "react"
import { Node } from "../node" import { ReacordElement } from "../../internal/element.js"
import { ReacordElement } from "./reacord-element" import type { MessageOptions } from "../../internal/message"
import { Node } from "../../internal/node.js"
/** /**
* Props for an action row * Props for an action row
@@ -30,10 +31,17 @@ export type ActionRowProps = {
*/ */
export function ActionRow(props: ActionRowProps) { export function ActionRow(props: ActionRowProps) {
return ( return (
<ReacordElement props={{}} createNode={() => new ActionRowNode({})}> <ReacordElement props={props} createNode={() => new ActionRowNode(props)}>
{props.children} {props.children}
</ReacordElement> </ReacordElement>
) )
} }
export class ActionRowNode extends Node<{}> {} class ActionRowNode extends Node<{}> {
override modifyMessageOptions(options: MessageOptions): void {
options.actionRows.push([])
for (const child of this.children) {
child.modifyMessageOptions(options)
}
}
}

View File

@@ -0,0 +1,77 @@
import { randomUUID } from "node:crypto"
import React from "react"
import { ReacordElement } from "../../internal/element.js"
import type { ComponentInteraction } from "../../internal/interaction"
import type { MessageOptions } from "../../internal/message"
import { getNextActionRow } from "../../internal/message"
import { Node } from "../../internal/node.js"
import type { ComponentEvent } from "../component-event"
import type { ButtonSharedProps } from "./button-shared-props"
/**
* @category Button
*/
export type ButtonProps = ButtonSharedProps & {
/**
* The style determines the color of the button and signals intent.
* @see https://discord.com/developers/docs/interactions/message-components#button-object-button-styles
*/
style?: "primary" | "secondary" | "success" | "danger"
/**
* Happens when a user clicks the button.
*/
onClick: (event: ButtonClickEvent) => void
}
/**
* @category Button
*/
export type ButtonClickEvent = ComponentEvent
/**
* @category Button
*/
export function Button(props: ButtonProps) {
return (
<ReacordElement props={props} createNode={() => new ButtonNode(props)}>
<ReacordElement props={{}} createNode={() => new ButtonLabelNode({})}>
{props.label}
</ReacordElement>
</ReacordElement>
)
}
class ButtonNode extends Node<ButtonProps> {
private customId = randomUUID()
// this has text children, but buttons themselves shouldn't yield text
// eslint-disable-next-line class-methods-use-this
override get text() {
return ""
}
override modifyMessageOptions(options: MessageOptions): void {
getNextActionRow(options).push({
type: "button",
customId: this.customId,
style: this.props.style ?? "secondary",
disabled: this.props.disabled,
emoji: this.props.emoji,
label: this.children.findType(ButtonLabelNode)?.text,
})
}
override handleComponentInteraction(interaction: ComponentInteraction) {
if (
interaction.type === "button" &&
interaction.customId === this.customId
) {
this.props.onClick(interaction.event)
return true
}
return false
}
}
class ButtonLabelNode extends Node<{}> {}

View File

@@ -0,0 +1,41 @@
import type { ReactNode } from "react"
import React from "react"
import { ReacordElement } from "../../internal/element.js"
import { Node } from "../../internal/node.js"
import { EmbedChildNode } from "./embed-child.js"
import type { EmbedOptions } from "./embed-options"
/**
* @category Embed
*/
export type EmbedAuthorProps = {
name?: ReactNode
children?: ReactNode
url?: string
iconUrl?: string
}
/**
* @category Embed
*/
export function EmbedAuthor(props: EmbedAuthorProps) {
return (
<ReacordElement props={props} createNode={() => new EmbedAuthorNode(props)}>
<ReacordElement props={{}} createNode={() => new AuthorTextNode({})}>
{props.name ?? props.children}
</ReacordElement>
</ReacordElement>
)
}
class EmbedAuthorNode extends EmbedChildNode<EmbedAuthorProps> {
override modifyEmbedOptions(options: EmbedOptions): void {
options.author = {
name: this.children.findType(AuthorTextNode)?.text ?? "",
url: this.props.url,
icon_url: this.props.iconUrl,
}
}
}
class AuthorTextNode extends Node<{}> {}

View File

@@ -0,0 +1,6 @@
import { Node } from "../../internal/node.js"
import type { EmbedOptions } from "./embed-options"
export abstract class EmbedChildNode<Props> extends Node<Props> {
abstract modifyEmbedOptions(options: EmbedOptions): void
}

View File

@@ -0,0 +1,46 @@
import type { ReactNode } from "react"
import React from "react"
import { ReacordElement } from "../../internal/element.js"
import { Node } from "../../internal/node.js"
import { EmbedChildNode } from "./embed-child.js"
import type { EmbedOptions } from "./embed-options"
/**
* @category Embed
*/
export type EmbedFieldProps = {
name: ReactNode
value?: ReactNode
inline?: boolean
children?: ReactNode
}
/**
* @category Embed
*/
export function EmbedField(props: EmbedFieldProps) {
return (
<ReacordElement props={props} createNode={() => new EmbedFieldNode(props)}>
<ReacordElement props={{}} createNode={() => new FieldNameNode({})}>
{props.name}
</ReacordElement>
<ReacordElement props={{}} createNode={() => new FieldValueNode({})}>
{props.value || props.children}
</ReacordElement>
</ReacordElement>
)
}
class EmbedFieldNode extends EmbedChildNode<EmbedFieldProps> {
override modifyEmbedOptions(options: EmbedOptions): void {
options.fields ??= []
options.fields.push({
name: this.children.findType(FieldNameNode)?.text ?? "",
value: this.children.findType(FieldValueNode)?.text ?? "",
inline: this.props.inline,
})
}
}
class FieldNameNode extends Node<{}> {}
class FieldValueNode extends Node<{}> {}

View File

@@ -0,0 +1,45 @@
import type { ReactNode } from "react"
import React from "react"
import { ReacordElement } from "../../internal/element.js"
import { Node } from "../../internal/node.js"
import { EmbedChildNode } from "./embed-child.js"
import type { EmbedOptions } from "./embed-options"
/**
* @category Embed
*/
export type EmbedFooterProps = {
text?: ReactNode
children?: ReactNode
iconUrl?: string
timestamp?: string | number | Date
}
/**
* @category Embed
*/
export function EmbedFooter({ text, children, ...props }: EmbedFooterProps) {
return (
<ReacordElement props={props} createNode={() => new EmbedFooterNode(props)}>
<ReacordElement props={{}} createNode={() => new FooterTextNode({})}>
{text ?? children}
</ReacordElement>
</ReacordElement>
)
}
class EmbedFooterNode extends EmbedChildNode<
Omit<EmbedFooterProps, "text" | "children">
> {
override modifyEmbedOptions(options: EmbedOptions): void {
options.footer = {
text: this.children.findType(FooterTextNode)?.text ?? "",
icon_url: this.props.iconUrl,
}
options.timestamp = this.props.timestamp
? new Date(this.props.timestamp).toISOString()
: undefined
}
}
class FooterTextNode extends Node<{}> {}

View File

@@ -0,0 +1,29 @@
import React from "react"
import { ReacordElement } from "../../internal/element.js"
import { EmbedChildNode } from "./embed-child.js"
import type { EmbedOptions } from "./embed-options"
/**
* @category Embed
*/
export type EmbedImageProps = {
url: string
}
/**
* @category Embed
*/
export function EmbedImage(props: EmbedImageProps) {
return (
<ReacordElement
props={props}
createNode={() => new EmbedImageNode(props)}
/>
)
}
class EmbedImageNode extends EmbedChildNode<EmbedImageProps> {
override modifyEmbedOptions(options: EmbedOptions): void {
options.image = { url: this.props.url }
}
}

View File

@@ -0,0 +1,8 @@
import type { Except, SnakeCasedPropertiesDeep } from "type-fest"
import type { EmbedProps } from "./embed"
export type EmbedOptions = SnakeCasedPropertiesDeep<
Except<EmbedProps, "timestamp" | "children"> & {
timestamp?: string
}
>

View File

@@ -0,0 +1,29 @@
import React from "react"
import { ReacordElement } from "../../internal/element.js"
import { EmbedChildNode } from "./embed-child.js"
import type { EmbedOptions } from "./embed-options"
/**
* @category Embed
*/
export type EmbedThumbnailProps = {
url: string
}
/**
* @category Embed
*/
export function EmbedThumbnail(props: EmbedThumbnailProps) {
return (
<ReacordElement
props={props}
createNode={() => new EmbedThumbnailNode(props)}
/>
)
}
class EmbedThumbnailNode extends EmbedChildNode<EmbedThumbnailProps> {
override modifyEmbedOptions(options: EmbedOptions): void {
options.thumbnail = { url: this.props.url }
}
}

View File

@@ -0,0 +1,36 @@
import type { ReactNode } from "react"
import React from "react"
import { ReacordElement } from "../../internal/element.js"
import { Node } from "../../internal/node.js"
import { EmbedChildNode } from "./embed-child.js"
import type { EmbedOptions } from "./embed-options"
/**
* @category Embed
*/
export type EmbedTitleProps = {
children: ReactNode
url?: string
}
/**
* @category Embed
*/
export function EmbedTitle({ children, ...props }: EmbedTitleProps) {
return (
<ReacordElement props={props} createNode={() => new EmbedTitleNode(props)}>
<ReacordElement props={{}} createNode={() => new TitleTextNode({})}>
{children}
</ReacordElement>
</ReacordElement>
)
}
class EmbedTitleNode extends EmbedChildNode<Omit<EmbedTitleProps, "children">> {
override modifyEmbedOptions(options: EmbedOptions): void {
options.title = this.children.findType(TitleTextNode)?.text ?? ""
options.url = this.props.url
}
}
class TitleTextNode extends Node<{}> {}

View File

@@ -0,0 +1,62 @@
import { snakeCaseDeep } from "@reacord/helpers/convert-object-property-case"
import { omit } from "@reacord/helpers/omit"
import React from "react"
import { ReacordElement } from "../../internal/element.js"
import type { MessageOptions } from "../../internal/message"
import { Node } from "../../internal/node.js"
import { TextNode } from "../../internal/text-node"
import { EmbedChildNode } from "./embed-child.js"
import type { EmbedOptions } from "./embed-options"
/**
* @category Embed
* @see https://discord.com/developers/docs/resources/channel#embed-object
*/
export type EmbedProps = {
title?: string
description?: string
url?: string
color?: number
fields?: Array<{ name: string; value: string; inline?: boolean }>
author?: { name: string; url?: string; iconUrl?: string }
thumbnail?: { url: string }
image?: { url: string }
video?: { url: string }
footer?: { text: string; iconUrl?: string }
timestamp?: string | number | Date
children?: React.ReactNode
}
/**
* @category Embed
* @see https://discord.com/developers/docs/resources/channel#embed-object
*/
export function Embed(props: EmbedProps) {
return (
<ReacordElement props={props} createNode={() => new EmbedNode(props)}>
{props.children}
</ReacordElement>
)
}
class EmbedNode extends Node<EmbedProps> {
override modifyMessageOptions(options: MessageOptions): void {
const embed: EmbedOptions = {
...snakeCaseDeep(omit(this.props, ["children", "timestamp"])),
timestamp: this.props.timestamp
? new Date(this.props.timestamp).toISOString()
: undefined,
}
for (const child of this.children) {
if (child instanceof EmbedChildNode) {
child.modifyEmbedOptions(embed)
}
if (child instanceof TextNode) {
embed.description = (embed.description || "") + child.props
}
}
options.embeds.push(embed)
}
}

View File

@@ -0,0 +1,43 @@
import React from "react"
import { ReacordElement } from "../../internal/element.js"
import type { MessageOptions } from "../../internal/message"
import { getNextActionRow } from "../../internal/message"
import { Node } from "../../internal/node.js"
import type { ButtonSharedProps } from "./button-shared-props"
/**
* @category Link
*/
export type LinkProps = ButtonSharedProps & {
/** The URL the link should lead to */
url: string
/** The link text */
children?: string
}
/**
* @category Link
*/
export function Link({ label, children, ...props }: LinkProps) {
return (
<ReacordElement props={props} createNode={() => new LinkNode(props)}>
<ReacordElement props={{}} createNode={() => new LinkTextNode({})}>
{label || children}
</ReacordElement>
</ReacordElement>
)
}
class LinkNode extends Node<Omit<LinkProps, "label" | "children">> {
override modifyMessageOptions(options: MessageOptions): void {
getNextActionRow(options).push({
type: "link",
disabled: this.props.disabled,
emoji: this.props.emoji,
label: this.children.findType(LinkTextNode)?.text,
url: this.props.url,
})
}
}
class LinkTextNode extends Node<{}> {}

View File

@@ -0,0 +1,19 @@
import type { MessageSelectOptionOptions } from "../../internal/message"
import { Node } from "../../internal/node"
import type { OptionProps } from "./option"
export class OptionNode extends Node<
Omit<OptionProps, "children" | "label" | "description">
> {
get options(): MessageSelectOptionOptions {
return {
label: this.children.findType(OptionLabelNode)?.text ?? this.props.value,
value: this.props.value,
description: this.children.findType(OptionDescriptionNode)?.text,
emoji: this.props.emoji,
}
}
}
export class OptionLabelNode extends Node<{}> {}
export class OptionDescriptionNode extends Node<{}> {}

View File

@@ -1,7 +1,11 @@
import type { ReactNode } from "react" import type { ReactNode } from "react"
import React from "react" import React from "react"
import { Node } from "../node" import { ReacordElement } from "../../internal/element"
import { ReacordElement } from "./reacord-element" import {
OptionDescriptionNode,
OptionLabelNode,
OptionNode,
} from "./option-node"
/** /**
* @category Select * @category Select
@@ -56,9 +60,3 @@ export function Option({
</ReacordElement> </ReacordElement>
) )
} }
export class OptionNode extends Node<
Omit<OptionProps, "children" | "label" | "description">
> {}
export class OptionLabelNode extends Node<{}> {}
export class OptionDescriptionNode extends Node<{}> {}

View File

@@ -1,10 +1,17 @@
import type { APIMessageComponentSelectMenuInteraction } from "discord.js" import { isInstanceOf } from "@reacord/helpers/is-instance-of"
import { randomUUID } from "node:crypto" import { randomUUID } from "node:crypto"
import type { ReactNode } from "react" import type { ReactNode } from "react"
import React from "react" import React from "react"
import { Node } from "../node" import { ReacordElement } from "../../internal/element.js"
import type { ComponentEvent } from "./component-event" import type { ComponentInteraction } from "../../internal/interaction"
import { ReacordElement } from "./reacord-element" import type {
ActionRow,
ActionRowItem,
MessageOptions,
} from "../../internal/message"
import { Node } from "../../internal/node.js"
import type { ComponentEvent } from "../component-event"
import { OptionNode } from "./option-node"
/** /**
* @category Select * @category Select
@@ -66,16 +73,7 @@ export type SelectProps = {
* @category Select * @category Select
*/ */
export type SelectChangeEvent = ComponentEvent & { export type SelectChangeEvent = ComponentEvent & {
/** The set of values that were selected by the user.
* If `multiple`, this can have more than one value.
*/
values: string[] values: string[]
/**
* Event details, e.g. the user who clicked, guild member, guild id, etc.
* @see https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object
*/
interaction: APIMessageComponentSelectMenuInteraction
} }
/** /**
@@ -90,6 +88,66 @@ export function Select(props: SelectProps) {
) )
} }
export class SelectNode extends Node<SelectProps> { class SelectNode extends Node<SelectProps> {
readonly customId = randomUUID() readonly customId = randomUUID()
override modifyMessageOptions(message: MessageOptions): void {
const actionRow: ActionRow = []
message.actionRows.push(actionRow)
const options = [...this.children]
.filter(isInstanceOf(OptionNode))
.map((node) => node.options)
const {
multiple,
value,
values,
minValues = 0,
maxValues = 25,
children,
onChange,
onChangeValue,
onChangeMultiple,
...props
} = this.props
const item: ActionRowItem = {
...props,
type: "select",
customId: this.customId,
options,
values: [],
}
if (multiple) {
item.minValues = minValues
item.maxValues = maxValues
if (values) item.values = values
}
if (!multiple && value != undefined) {
item.values = [value]
}
actionRow.push(item)
}
override handleComponentInteraction(
interaction: ComponentInteraction,
): boolean {
const isSelectInteraction =
interaction.type === "select" &&
interaction.customId === this.customId &&
!this.props.disabled
if (!isSelectInteraction) return false
this.props.onChange?.(interaction.event)
this.props.onChangeMultiple?.(interaction.event.values, interaction.event)
if (interaction.event.values[0]) {
this.props.onChangeValue?.(interaction.event.values[0], interaction.event)
}
return true
}
} }

View File

@@ -1,6 +1,6 @@
import { raise } from "@reacord/helpers/raise" import { raise } from "@reacord/helpers/raise"
import * as React from "react" import * as React from "react"
import type { ReacordInstance } from "../reacord-instance" import type { ReacordInstance } from "./instance"
const Context = React.createContext<ReacordInstance | undefined>(undefined) const Context = React.createContext<ReacordInstance | undefined>(undefined)

View File

@@ -0,0 +1,19 @@
import type { ReactNode } from "react"
/**
* Represents an interactive message, which can later be replaced or deleted.
* @category Core
*/
export type ReacordInstance = {
/** Render some JSX to this instance (edits the message) */
render: (content: ReactNode) => void
/** Remove this message */
destroy: () => void
/**
* Same as destroy, but keeps the message and disables the components on it.
* This prevents it from listening to user interactions.
*/
deactivate: () => void
}

View File

@@ -0,0 +1,389 @@
/* eslint-disable class-methods-use-this */
import { pick } from "@reacord/helpers/pick"
import { pruneNullishValues } from "@reacord/helpers/prune-nullish-values"
import { raise } from "@reacord/helpers/raise"
import * as Discord from "discord.js"
import type { ReactNode } from "react"
import type { Except } from "type-fest"
import type { ComponentInteraction } from "../internal/interaction"
import type {
Message,
MessageButtonOptions,
MessageOptions,
} from "../internal/message"
import { ChannelMessageRenderer } from "../internal/renderers/channel-message-renderer"
import { InteractionReplyRenderer } from "../internal/renderers/interaction-reply-renderer"
import type {
ChannelInfo,
GuildInfo,
GuildMemberInfo,
MessageInfo,
UserInfo,
} from "./component-event"
import type { ReacordInstance } from "./instance"
import type { ReacordConfig } from "./reacord"
import { Reacord } from "./reacord"
/**
* The Reacord adapter for Discord.js.
* @category Core
*/
export class ReacordDiscordJs extends Reacord {
constructor(private client: Discord.Client, config: ReacordConfig = {}) {
super(config)
client.on("interactionCreate", (interaction) => {
if (interaction.isButton() || interaction.isSelectMenu()) {
this.handleComponentInteraction(
this.createReacordComponentInteraction(interaction),
)
}
})
}
/**
* Sends a message to a channel.
* @see https://reacord.mapleleaf.dev/guides/sending-messages
*/
override send(
channelId: string,
initialContent?: React.ReactNode,
): ReacordInstance {
return this.createInstance(
this.createChannelRenderer(channelId),
initialContent,
)
}
/**
* Sends a message as a reply to a command interaction.
* @see https://reacord.mapleleaf.dev/guides/sending-messages
*/
override reply(
interaction: Discord.CommandInteraction,
initialContent?: React.ReactNode,
): ReacordInstance {
return this.createInstance(
this.createInteractionReplyRenderer(interaction),
initialContent,
)
}
/**
* Sends an ephemeral message as a reply to a command interaction.
* @see https://reacord.mapleleaf.dev/guides/sending-messages
*/
override ephemeralReply(
interaction: Discord.CommandInteraction,
initialContent?: React.ReactNode,
): ReacordInstance {
return this.createInstance(
this.createEphemeralInteractionReplyRenderer(interaction),
initialContent,
)
}
private createChannelRenderer(channelId: string) {
return new ChannelMessageRenderer({
send: async (options) => {
const channel =
this.client.channels.cache.get(channelId) ??
(await this.client.channels.fetch(channelId)) ??
raise(`Channel ${channelId} not found`)
if (!channel.isTextBased()) {
raise(`Channel ${channelId} is not a text channel`)
}
const message = await channel.send(getDiscordMessageOptions(options))
return createReacordMessage(message)
},
})
}
private createInteractionReplyRenderer(
interaction:
| Discord.CommandInteraction
| Discord.MessageComponentInteraction,
) {
return new InteractionReplyRenderer({
type: "command",
id: interaction.id,
reply: async (options) => {
const message = await interaction.reply({
...getDiscordMessageOptions(options),
fetchReply: true,
})
return createReacordMessage(message as Discord.Message)
},
followUp: async (options) => {
const message = await interaction.followUp({
...getDiscordMessageOptions(options),
fetchReply: true,
})
return createReacordMessage(message as Discord.Message)
},
})
}
private createEphemeralInteractionReplyRenderer(
interaction:
| Discord.CommandInteraction
| Discord.MessageComponentInteraction,
) {
return new InteractionReplyRenderer({
type: "command",
id: interaction.id,
reply: async (options) => {
await interaction.reply({
...getDiscordMessageOptions(options),
ephemeral: true,
})
return createEphemeralReacordMessage()
},
followUp: async (options) => {
await interaction.followUp({
...getDiscordMessageOptions(options),
ephemeral: true,
})
return createEphemeralReacordMessage()
},
})
}
private createReacordComponentInteraction(
interaction: Discord.MessageComponentInteraction,
): ComponentInteraction {
// todo please dear god clean this up
const channel: ChannelInfo = interaction.channel
? {
...pruneNullishValues(
pick(interaction.channel, [
"topic",
"nsfw",
"lastMessageId",
"ownerId",
"parentId",
"rateLimitPerUser",
]),
),
id: interaction.channelId,
}
: raise("Non-channel interactions are not supported")
const message: MessageInfo =
interaction.message instanceof Discord.Message
? {
...pick(interaction.message, [
"id",
"channelId",
"authorId",
"content",
"tts",
"mentionEveryone",
]),
timestamp: new Date(
interaction.message.createdTimestamp,
).toISOString(),
editedTimestamp: interaction.message.editedTimestamp
? new Date(interaction.message.editedTimestamp).toISOString()
: undefined,
mentions: interaction.message.mentions.users.map((u) => u.id),
}
: raise("Message not found")
const member: GuildMemberInfo | undefined =
interaction.member instanceof Discord.GuildMember
? {
...pruneNullishValues(
pick(interaction.member, [
"id",
"nick",
"displayName",
"avatarUrl",
"displayAvatarUrl",
"color",
"pending",
]),
),
displayName: interaction.member.displayName,
roles: interaction.member.roles.cache.map((role) => role.id),
joinedAt: interaction.member.joinedAt?.toISOString(),
premiumSince: interaction.member.premiumSince?.toISOString(),
communicationDisabledUntil:
interaction.member.communicationDisabledUntil?.toISOString(),
}
: undefined
const guild: GuildInfo | undefined = interaction.guild
? {
...pruneNullishValues(pick(interaction.guild, ["id", "name"])),
member: member ?? raise("unexpected: member is undefined"),
}
: undefined
const user: UserInfo = {
...pruneNullishValues(
pick(interaction.user, ["id", "username", "discriminator", "tag"]),
),
avatarUrl: interaction.user.avatarURL()!,
accentColor: interaction.user.accentColor ?? undefined,
}
const baseProps: Except<ComponentInteraction, "type"> = {
id: interaction.id,
customId: interaction.customId,
update: async (options: MessageOptions) => {
await interaction.update(getDiscordMessageOptions(options))
},
deferUpdate: async () => {
if (interaction.replied || interaction.deferred) return
await interaction.deferUpdate()
},
reply: async (options) => {
const message = await interaction.reply({
...getDiscordMessageOptions(options),
fetchReply: true,
})
return createReacordMessage(message as Discord.Message)
},
followUp: async (options) => {
const message = await interaction.followUp({
...getDiscordMessageOptions(options),
fetchReply: true,
})
return createReacordMessage(message as Discord.Message)
},
event: {
channel,
message,
user,
guild,
reply: (content?: ReactNode) =>
this.createInstance(
this.createInteractionReplyRenderer(interaction),
content,
),
ephemeralReply: (content: ReactNode) =>
this.createInstance(
this.createEphemeralInteractionReplyRenderer(interaction),
content,
),
},
}
if (interaction.isButton()) {
return {
...baseProps,
type: "button",
}
}
if (interaction.isSelectMenu()) {
return {
...baseProps,
type: "select",
event: {
...baseProps.event,
values: interaction.values,
},
}
}
raise(`Unsupported component interaction type: ${interaction.type}`)
}
}
function createReacordMessage(message: Discord.Message): Message {
return {
edit: async (options) => {
await message.edit(getDiscordMessageOptions(options))
},
delete: async () => {
await message.delete()
},
}
}
function createEphemeralReacordMessage(): Message {
return {
edit: () => {
console.warn("Ephemeral messages can't be edited")
return Promise.resolve()
},
delete: () => {
console.warn("Ephemeral messages can't be deleted")
return Promise.resolve()
},
}
}
function convertButtonStyleToEnum(style: MessageButtonOptions["style"]) {
const styleMap = {
primary: Discord.ButtonStyle.Primary,
secondary: Discord.ButtonStyle.Secondary,
success: Discord.ButtonStyle.Success,
danger: Discord.ButtonStyle.Danger,
} as const
return styleMap[style ?? "secondary"]
}
// TODO: this could be a part of the core library,
// and also handle some edge cases, e.g. empty messages
function getDiscordMessageOptions(reacordOptions: MessageOptions) {
const options = {
// eslint-disable-next-line unicorn/no-null
content: reacordOptions.content || null,
embeds: reacordOptions.embeds,
components: reacordOptions.actionRows.map((row) => ({
type: Discord.ComponentType.ActionRow,
components: row.map(
(component): Discord.MessageActionRowComponentData => {
if (component.type === "button") {
return {
type: Discord.ComponentType.Button,
customId: component.customId,
label: component.label ?? "",
style: convertButtonStyleToEnum(component.style),
disabled: component.disabled,
emoji: component.emoji,
}
}
if (component.type === "link") {
return {
type: Discord.ComponentType.Button,
url: component.url,
label: component.label ?? "",
style: Discord.ButtonStyle.Link,
disabled: component.disabled,
emoji: component.emoji,
}
}
if (component.type === "select") {
return {
...component,
type: Discord.ComponentType.SelectMenu,
options: component.options.map((option) => ({
...option,
default: component.values?.includes(option.value),
})),
}
}
raise(`Unsupported component type: ${(component as any).type}`)
},
),
})),
}
if (!options.content && !options.embeds?.length) {
options.content = "_ _"
}
return options
}

View File

@@ -0,0 +1,91 @@
import type { ReactNode } from "react"
import React from "react"
import type { ComponentInteraction } from "../internal/interaction"
import { reconciler } from "../internal/reconciler.js"
import type { Renderer } from "../internal/renderers/renderer"
import type { ReacordInstance } from "./instance"
import { InstanceProvider } from "./instance-context"
/**
* @category Core
*/
export type ReacordConfig = {
/**
* The max number of active instances.
* When this limit is exceeded, the oldest instances will be disabled.
*/
maxInstances?: number
}
/**
* The main Reacord class that other Reacord adapters should extend.
* Only use this directly if you're making [a custom adapter](/guides/custom-adapters).
*/
export abstract class Reacord {
private renderers: Renderer[] = []
constructor(private readonly config: ReacordConfig = {}) {}
abstract send(...args: unknown[]): ReacordInstance
abstract reply(...args: unknown[]): ReacordInstance
abstract ephemeralReply(...args: unknown[]): ReacordInstance
protected handleComponentInteraction(interaction: ComponentInteraction) {
for (const renderer of this.renderers) {
if (renderer.handleComponentInteraction(interaction)) return
}
}
private get maxInstances() {
return this.config.maxInstances ?? 50
}
protected createInstance(renderer: Renderer, initialContent?: ReactNode) {
if (this.renderers.length > this.maxInstances) {
this.deactivate(this.renderers[0]!)
}
this.renderers.push(renderer)
const container = reconciler.createContainer(
renderer,
0,
// eslint-disable-next-line unicorn/no-null
null,
false,
// eslint-disable-next-line unicorn/no-null
null,
"reacord",
() => {},
// eslint-disable-next-line unicorn/no-null
null,
)
const instance: ReacordInstance = {
render: (content: ReactNode) => {
reconciler.updateContainer(
<InstanceProvider value={instance}>{content}</InstanceProvider>,
container,
)
},
deactivate: () => {
this.deactivate(renderer)
},
destroy: () => {
this.renderers = this.renderers.filter((it) => it !== renderer)
renderer.destroy()
},
}
if (initialContent !== undefined) {
instance.render(initialContent)
}
return instance
}
private deactivate(renderer: Renderer) {
this.renderers = this.renderers.filter((it) => it !== renderer)
renderer.deactivate()
}
}

View File

@@ -0,0 +1,5 @@
import type { Message, MessageOptions } from "./message"
export type Channel = {
send(message: MessageOptions): Promise<Message>
}

View File

@@ -0,0 +1,37 @@
export class Container<T> {
private items: T[] = []
add(...items: T[]) {
this.items.push(...items)
}
addBefore(item: T, before: T) {
let index = this.items.indexOf(before)
if (index === -1) {
index = this.items.length
}
this.items.splice(index, 0, item)
}
remove(toRemove: T) {
this.items = this.items.filter((item) => item !== toRemove)
}
clear() {
this.items = []
}
find(predicate: (item: T) => boolean): T | undefined {
return this.items.find(predicate)
}
findType<U extends T>(type: new (...args: any[]) => U): U | undefined {
for (const item of this.items) {
if (item instanceof type) return item
}
}
[Symbol.iterator]() {
return this.items[Symbol.iterator]()
}
}

View File

@@ -1,6 +1,6 @@
import type { ReactNode } from "react" import type { ReactNode } from "react"
import React from "react" import React from "react"
import type { Node } from "../node" import type { Node } from "./node"
export function ReacordElement<Props>(props: { export function ReacordElement<Props>(props: {
props: Props props: Props

View File

@@ -0,0 +1,35 @@
import type { ComponentEvent } from "../core/component-event"
import type { ButtonClickEvent, SelectChangeEvent } from "../main"
import type { Message, MessageOptions } from "./message"
export type Interaction = CommandInteraction | ComponentInteraction
export type ComponentInteraction = ButtonInteraction | SelectInteraction
export type CommandInteraction = BaseInteraction<"command">
export type ButtonInteraction = BaseComponentInteraction<
"button",
ButtonClickEvent
>
export type SelectInteraction = BaseComponentInteraction<
"select",
SelectChangeEvent
>
export type BaseInteraction<Type extends string> = {
type: Type
id: string
reply(messageOptions: MessageOptions): Promise<Message>
followUp(messageOptions: MessageOptions): Promise<Message>
}
export type BaseComponentInteraction<
Type extends string,
Event extends ComponentEvent,
> = BaseInteraction<Type> & {
event: Event
customId: string
update(options: MessageOptions): Promise<void>
deferUpdate(): Promise<void>
}

View File

@@ -0,0 +1,24 @@
export class LimitedCollection<T> {
private items: T[] = []
constructor(private readonly size: number) {}
add(item: T) {
if (this.items.length >= this.size) {
this.items.shift()
}
this.items.push(item)
}
has(item: T) {
return this.items.includes(item)
}
values(): readonly T[] {
return this.items
}
[Symbol.iterator]() {
return this.items[Symbol.iterator]()
}
}

View File

@@ -0,0 +1,65 @@
import { last } from "@reacord/helpers/last"
import type { Except } from "type-fest"
import type { EmbedOptions } from "../core/components/embed-options"
import type { SelectProps } from "../core/components/select"
export type MessageOptions = {
content: string
embeds: EmbedOptions[]
actionRows: ActionRow[]
}
export type ActionRow = ActionRowItem[]
export type ActionRowItem =
| MessageButtonOptions
| MessageLinkOptions
| MessageSelectOptions
export type MessageButtonOptions = {
type: "button"
customId: string
label?: string
style?: "primary" | "secondary" | "success" | "danger"
disabled?: boolean
emoji?: string
}
export type MessageLinkOptions = {
type: "link"
url: string
label?: string
emoji?: string
disabled?: boolean
}
export type MessageSelectOptions = Except<SelectProps, "children" | "value"> & {
type: "select"
customId: string
options: MessageSelectOptionOptions[]
}
export type MessageSelectOptionOptions = {
label: string
value: string
description?: string
emoji?: string
}
export type Message = {
edit(options: MessageOptions): Promise<void>
delete(): Promise<void>
}
export function getNextActionRow(options: MessageOptions): ActionRow {
let actionRow = last(options.actionRows)
if (
actionRow == undefined ||
actionRow.length >= 5 ||
actionRow[0]?.type === "select"
) {
actionRow = []
options.actionRows.push(actionRow)
}
return actionRow
}

View File

@@ -0,0 +1,20 @@
/* eslint-disable class-methods-use-this */
import { Container } from "./container.js"
import type { ComponentInteraction } from "./interaction"
import type { MessageOptions } from "./message"
export abstract class Node<Props> {
readonly children = new Container<Node<unknown>>()
constructor(public props: Props) {}
modifyMessageOptions(options: MessageOptions) {}
handleComponentInteraction(interaction: ComponentInteraction): boolean {
return false
}
get text(): string {
return [...this.children].map((child) => child.text).join("")
}
}

View File

@@ -1,15 +1,16 @@
/* eslint-disable unicorn/prefer-modern-dom-apis */ import { raise } from "@reacord/helpers/raise.js"
import { raise } from "@reacord/helpers/raise" import type { HostConfig } from "react-reconciler"
import ReactReconciler from "react-reconciler" import ReactReconciler from "react-reconciler"
import { DefaultEventPriority } from "react-reconciler/constants" import { DefaultEventPriority } from "react-reconciler/constants.js"
import { Node, TextNode } from "../node" import { Node } from "./node.js"
import type { ReacordInstancePrivate } from "../reacord-instance" import type { Renderer } from "./renderers/renderer"
import { TextNode } from "./text-node.js"
export const reconciler = ReactReconciler< const config: HostConfig<
string, // Type, string, // Type,
Record<string, unknown>, // Props, Record<string, unknown>, // Props,
ReacordInstancePrivate, // Container, Renderer, // Container,
Node, // Instance, Node<unknown>, // Instance,
TextNode, // TextInstance, TextNode, // TextInstance,
never, // SuspenseInstance, never, // SuspenseInstance,
never, // HydratableInstance, never, // HydratableInstance,
@@ -19,7 +20,7 @@ export const reconciler = ReactReconciler<
never, // ChildSet, never, // ChildSet,
number, // TimeoutHandle, number, // TimeoutHandle,
number // NoTimeout, number // NoTimeout,
>({ > = {
supportsMutation: true, supportsMutation: true,
supportsPersistence: false, supportsPersistence: false,
supportsHydration: false, supportsHydration: false,
@@ -48,7 +49,7 @@ export const reconciler = ReactReconciler<
return node return node
}, },
createTextInstance: (text) => new TextNode({ text }), createTextInstance: (text) => new TextNode(text),
shouldSetTextContent: () => false, shouldSetTextContent: () => false,
detachDeletedInstance: (instance) => {}, detachDeletedInstance: (instance) => {},
beforeActiveInstanceBlur: () => {}, beforeActiveInstanceBlur: () => {},
@@ -58,30 +59,30 @@ export const reconciler = ReactReconciler<
// eslint-disable-next-line unicorn/no-null // eslint-disable-next-line unicorn/no-null
getInstanceFromScope: (scopeInstance: any) => null, getInstanceFromScope: (scopeInstance: any) => null,
clearContainer: (instance) => { clearContainer: (renderer) => {
instance.tree.clear() renderer.nodes.clear()
}, },
appendChildToContainer: (instance, child) => { appendChildToContainer: (renderer, child) => {
instance.tree.add(child) renderer.nodes.add(child)
}, },
removeChildFromContainer: (instance, child) => { removeChildFromContainer: (renderer, child) => {
instance.tree.remove(child) renderer.nodes.remove(child)
}, },
insertInContainerBefore: (instance, child, before) => { insertInContainerBefore: (renderer, child, before) => {
instance.tree.insertBefore(child, before) renderer.nodes.addBefore(child, before)
}, },
appendInitialChild: (parent, child) => { appendInitialChild: (parent, child) => {
parent.add(child) parent.children.add(child)
}, },
appendChild: (parent, child) => { appendChild: (parent, child) => {
parent.add(child) parent.children.add(child)
}, },
removeChild: (parent, child) => { removeChild: (parent, child) => {
parent.remove(child) parent.children.remove(child)
}, },
insertBefore: (parent, child, before) => { insertBefore: (parent, child, before) => {
parent.insertBefore(child, before) parent.children.addBefore(child, before)
}, },
prepareUpdate: () => true, prepareUpdate: () => true,
@@ -89,13 +90,13 @@ export const reconciler = ReactReconciler<
node.props = newProps.props node.props = newProps.props
}, },
commitTextUpdate: (node, oldText, newText) => { commitTextUpdate: (node, oldText, newText) => {
node.props.text = newText node.props = newText
}, },
// eslint-disable-next-line unicorn/no-null // eslint-disable-next-line unicorn/no-null
prepareForCommit: () => null, prepareForCommit: () => null,
resetAfterCommit: (renderer) => { resetAfterCommit: (renderer) => {
void renderer.update(renderer.tree) renderer.render()
}, },
prepareScopeUpdate: (scopeInstance: any, instance: any) => {}, prepareScopeUpdate: (scopeInstance: any, instance: any) => {},
@@ -105,4 +106,6 @@ export const reconciler = ReactReconciler<
finalizeInitialChildren: () => false, finalizeInitialChildren: () => false,
getCurrentEventPriority: () => DefaultEventPriority, getCurrentEventPriority: () => DefaultEventPriority,
}) }
export const reconciler = ReactReconciler(config)

View File

@@ -0,0 +1,13 @@
import type { Channel } from "../channel"
import type { Message, MessageOptions } from "../message"
import { Renderer } from "./renderer"
export class ChannelMessageRenderer extends Renderer {
constructor(private channel: Channel) {
super()
}
protected createMessage(options: MessageOptions): Promise<Message> {
return this.channel.send(options)
}
}

View File

@@ -0,0 +1,22 @@
import type { Interaction } from "../interaction"
import type { Message, MessageOptions } from "../message"
import { Renderer } from "./renderer"
// keep track of interaction ids which have replies,
// so we know whether to call reply() or followUp()
const repliedInteractionIds = new Set<string>()
export class InteractionReplyRenderer extends Renderer {
constructor(private interaction: Interaction) {
super()
}
protected createMessage(options: MessageOptions): Promise<Message> {
if (repliedInteractionIds.has(this.interaction.id)) {
return this.interaction.followUp(options)
}
repliedInteractionIds.add(this.interaction.id)
return this.interaction.reply(options)
}
}

View File

@@ -0,0 +1,119 @@
import { Subject } from "rxjs"
import { concatMap } from "rxjs/operators"
import { Container } from "../container.js"
import type { ComponentInteraction } from "../interaction"
import type { Message, MessageOptions } from "../message"
import type { Node } from "../node.js"
type UpdatePayload =
| { action: "update" | "deactivate"; options: MessageOptions }
| { action: "deferUpdate"; interaction: ComponentInteraction }
| { action: "destroy" }
export abstract class Renderer {
readonly nodes = new Container<Node<unknown>>()
private componentInteraction?: ComponentInteraction
private message?: Message
private active = true
private updates = new Subject<UpdatePayload>()
private updateSubscription = this.updates
.pipe(concatMap((payload) => this.updateMessage(payload)))
.subscribe({ error: console.error })
render() {
if (!this.active) {
console.warn("Attempted to update a deactivated message")
return
}
this.updates.next({
options: this.getMessageOptions(),
action: "update",
})
}
deactivate() {
this.active = false
this.updates.next({
options: this.getMessageOptions(),
action: "deactivate",
})
}
destroy() {
this.active = false
this.updates.next({ action: "destroy" })
}
handleComponentInteraction(interaction: ComponentInteraction) {
this.componentInteraction = interaction
setTimeout(() => {
this.updates.next({ action: "deferUpdate", interaction })
}, 500)
for (const node of this.nodes) {
if (node.handleComponentInteraction(interaction)) {
return true
}
}
}
protected abstract createMessage(options: MessageOptions): Promise<Message>
private getMessageOptions(): MessageOptions {
const options: MessageOptions = {
content: "",
embeds: [],
actionRows: [],
}
for (const node of this.nodes) {
node.modifyMessageOptions(options)
}
return options
}
private async updateMessage(payload: UpdatePayload) {
if (payload.action === "destroy") {
this.updateSubscription.unsubscribe()
await this.message?.delete()
return
}
if (payload.action === "deactivate") {
this.updateSubscription.unsubscribe()
await this.message?.edit({
...payload.options,
actionRows: payload.options.actionRows.map((row) =>
row.map((component) => ({
...component,
disabled: true,
})),
),
})
return
}
if (payload.action === "deferUpdate") {
await payload.interaction.deferUpdate()
return
}
if (this.componentInteraction) {
const promise = this.componentInteraction.update(payload.options)
this.componentInteraction = undefined
await promise
return
}
if (this.message) {
await this.message.edit(payload.options)
return
}
this.message = await this.createMessage(payload.options)
}
}

View File

@@ -0,0 +1,12 @@
import type { MessageOptions } from "./message"
import { Node } from "./node.js"
export class TextNode extends Node<string> {
override modifyMessageOptions(options: MessageOptions) {
options.content = options.content + this.props
}
override get text() {
return this.props
}
}

View File

@@ -0,0 +1,20 @@
export class Timeout {
private timeoutId?: NodeJS.Timeout
constructor(
private readonly time: number,
private readonly callback: () => void,
) {}
run() {
this.cancel()
this.timeoutId = setTimeout(this.callback, this.time)
}
cancel() {
if (this.timeoutId) {
clearTimeout(this.timeoutId)
this.timeoutId = undefined
}
}
}

View File

@@ -0,0 +1,18 @@
export * from "./core/component-event"
export * from "./core/components/action-row"
export * from "./core/components/button"
export * from "./core/components/button-shared-props"
export * from "./core/components/embed"
export * from "./core/components/embed-author"
export * from "./core/components/embed-field"
export * from "./core/components/embed-footer"
export * from "./core/components/embed-image"
export * from "./core/components/embed-thumbnail"
export * from "./core/components/embed-title"
export * from "./core/components/link"
export * from "./core/components/option"
export * from "./core/components/select"
export * from "./core/instance"
export { useInstance } from "./core/instance-context"
export * from "./core/reacord"
export * from "./core/reacord-discord-js"

View File

@@ -2,7 +2,7 @@
"name": "reacord", "name": "reacord",
"type": "module", "type": "module",
"description": "Create interactive Discord messages using React.", "description": "Create interactive Discord messages using React.",
"version": "0.5.1", "version": "0.5.2",
"types": "./dist/main.d.ts", "types": "./dist/main.d.ts",
"homepage": "https://reacord.mapleleaf.dev", "homepage": "https://reacord.mapleleaf.dev",
"repository": "https://github.com/itsMapleLeaf/reacord.git", "repository": "https://github.com/itsMapleLeaf/reacord.git",
@@ -36,28 +36,17 @@
} }
}, },
"scripts": { "scripts": {
"build": "cp ../../README.md . && cp ../../LICENSE . && tsx scripts/generate-exports.ts && tsup", "build": "cp ../../README.md . && cp ../../LICENSE . && tsup library/main.ts --target node16 --format cjs,esm --dts --sourcemap",
"build-watch": "pnpm build --watch", "build-watch": "pnpm build -- --watch",
"test-manual": "tsx watch ./scripts/manual-test.tsx", "test": "vitest --coverage --no-watch",
"test-dev": "vitest",
"test-manual": "nodemon --exec tsx --ext ts,tsx ./scripts/discordjs-manual-test.tsx",
"typecheck": "tsc --noEmit" "typecheck": "tsc --noEmit"
}, },
"tsup": {
"entry": [
"src/main.ts"
],
"sourcemap": true,
"target": "node16",
"format": [
"cjs",
"esm"
],
"dts": true
},
"dependencies": { "dependencies": {
"@types/node": "*", "@types/node": "*",
"@types/react": "*", "@types/react": "*",
"@types/react-reconciler": "*", "@types/react-reconciler": "^0.28.0",
"discord-api-types": "^0.37.1",
"react-reconciler": "^0.29.0", "react-reconciler": "^0.29.0",
"rxjs": "^7.5.6" "rxjs": "^7.5.6"
}, },
@@ -73,22 +62,19 @@
"devDependencies": { "devDependencies": {
"@reacord/helpers": "workspace:*", "@reacord/helpers": "workspace:*",
"@types/lodash-es": "^4.17.6", "@types/lodash-es": "^4.17.6",
"@types/prettier": "^2.7.0", "c8": "^7.12.0",
"date-fns": "^2.29.1", "discord.js": "^14.0.3",
"discord.js": "^14.1.2",
"dotenv": "^16.0.1", "dotenv": "^16.0.1",
"lodash-es": "^4.17.21", "lodash-es": "^4.17.21",
"nodemon": "^2.0.19", "nodemon": "^2.0.19",
"ora": "^6.1.2",
"prettier": "^2.7.1", "prettier": "^2.7.1",
"pretty-ms": "^8.0.0", "pretty-ms": "^8.0.0",
"react": "^18.2.0", "react": "^18.2.0",
"release-it": "^15.2.0", "tsup": "^6.1.3",
"ts-morph": "^15.1.0",
"tsup": "^6.2.1",
"tsx": "^3.8.0", "tsx": "^3.8.0",
"type-fest": "^2.18.0", "type-fest": "^2.17.0",
"typescript": "^4.7.4" "typescript": "^4.7.4",
"vitest": "^0.18.1"
}, },
"resolutions": { "resolutions": {
"esbuild": "latest" "esbuild": "latest"

View File

@@ -0,0 +1,139 @@
import type { TextChannel } from "discord.js"
import { ChannelType, Client, IntentsBitField } from "discord.js"
import "dotenv/config"
import { kebabCase } from "lodash-es"
import * as React from "react"
import { useState } from "react"
import {
Button,
Link,
Option,
ReacordDiscordJs,
Select,
useInstance,
} from "../library/main"
const client = new Client({ intents: IntentsBitField.Flags.Guilds })
const reacord = new ReacordDiscordJs(client)
await client.login(process.env.TEST_BOT_TOKEN)
const guild = await client.guilds.fetch(process.env.TEST_GUILD_ID!)
const category = await guild.channels.fetch(process.env.TEST_CATEGORY_ID!)
if (category?.type !== ChannelType.GuildCategory) {
throw new Error(
`channel ${process.env.TEST_CATEGORY_ID} is not a guild category. received ${category?.type}`,
)
}
for (const [, channel] of category.children.cache) {
await channel.delete()
}
let prefix = 0
const createTest = async (
name: string,
block: (channel: TextChannel) => void | Promise<unknown>,
) => {
prefix += 1
const channel = await category.children.create({
type: ChannelType.GuildText,
name: `${String(prefix).padStart(3, "0")}-${kebabCase(name)}`,
})
await block(channel)
}
await createTest("basic", (channel) => {
reacord.send(channel.id, "Hello, world!")
})
await createTest("counter", (channel) => {
const Counter = () => {
const [count, setCount] = React.useState(0)
return (
<>
count: {count}
<Button
style="primary"
emoji=""
onClick={() => setCount(count + 1)}
/>
<Button
style="primary"
emoji=""
onClick={() => setCount(count - 1)}
/>
<Button label="reset" onClick={() => setCount(0)} />
</>
)
}
reacord.send(channel.id, <Counter />)
})
await createTest("select", (channel) => {
function FruitSelect({ onConfirm }: { onConfirm: (choice: string) => void }) {
const [value, setValue] = useState<string>()
return (
<>
<Select
placeholder="choose a fruit"
value={value}
onChangeValue={setValue}
>
<Option value="🍎" emoji="🍎" label="apple" description="it red" />
<Option value="🍌" emoji="🍌" label="banana" description="bnanbna" />
<Option value="🍒" emoji="🍒" label="cherry" description="heh" />
</Select>
<Button
label="confirm"
disabled={value == undefined}
onClick={() => {
if (value) onConfirm(value)
}}
/>
</>
)
}
const instance = reacord.send(
channel.id,
<FruitSelect
onConfirm={(value) => {
instance.render(`you chose ${value}`)
instance.deactivate()
}}
/>,
)
})
await createTest("ephemeral button", (channel) => {
reacord.send(
channel.id,
<>
<Button
label="public clic"
onClick={(event) =>
event.reply(`${event.guild?.member.displayName} clic`)
}
/>
<Button
label="clic"
onClick={(event) => event.ephemeralReply("you clic")}
/>
</>,
)
})
await createTest("delete this", (channel) => {
function DeleteThis() {
const instance = useInstance()
return <Button label="delete this" onClick={() => instance.destroy()} />
}
reacord.send(channel.id, <DeleteThis />)
})
await createTest("link", (channel) => {
reacord.send(channel.id, <Link label="hi" url="https://mapleleaf.dev" />)
})

View File

@@ -1,62 +0,0 @@
import { writeFile } from "node:fs/promises"
import { join, relative } from "node:path/posix"
import prettier from "prettier"
import { Node, Project, SyntaxKind } from "ts-morph"
function isDeclarationPublic(declaration: Node) {
if (!Node.isJSDocable(declaration)) return false
const jsDocTags = new Set(
declaration
.getJsDocs()
.flatMap((doc) => doc.getTags())
.map((tag) => tag.getTagName()),
)
return jsDocTags.has("category") && !jsDocTags.has("private")
}
const project = new Project()
project.addSourceFilesAtPaths(["src/**/*.{ts,tsx}", "!src/main.ts"])
const exportLines = project
.getSourceFiles()
.map((file) => {
const importPath = relative(
"src",
join(file.getDirectoryPath(), file.getBaseNameWithoutExtension()),
)
const exports = file.getExportedDeclarations()
const exportNames = [...exports].flatMap(([name, [declaration]]) => {
if (!declaration) return []
if (!isDeclarationPublic(declaration)) return []
if (
declaration.isKind(SyntaxKind.TypeAliasDeclaration) ||
declaration.isKind(SyntaxKind.InterfaceDeclaration)
) {
return `type ${name}`
}
return name
})
return { importPath, exportNames }
})
.filter(({ exportNames }) => exportNames.length > 0)
.map(({ importPath, exportNames }) => {
return `export { ${exportNames.join(", ")} } from "./${importPath}"`
})
const resolvedConfig = await prettier.resolveConfig("src/main.ts")
if (!resolvedConfig) {
throw new Error("Could not find prettier config")
}
await writeFile(
"src/main.ts",
prettier.format(exportLines.join(";"), {
...resolvedConfig,
parser: "typescript",
}),
)

View File

@@ -1,13 +0,0 @@
import type { ClientOptions } from "discord.js"
import { Client } from "discord.js"
import { once } from "node:events"
export async function createDiscordClient(
token: string,
options: ClientOptions,
) {
const client = new Client(options)
await client.login(token)
const [readyClient] = await once(client, "ready")
return readyClient
}

View File

@@ -1,28 +0,0 @@
export {
type ReacordConfig,
type InteractionInfo,
ReacordClient,
} from "./reacord-client"
export { type ReacordInstance } from "./reacord-instance"
export { ActionRow, type ActionRowProps } from "./react/action-row"
export { type ButtonSharedProps } from "./react/button-shared-props"
export { Button, type ButtonProps, type ButtonClickEvent } from "./react/button"
export { type ComponentEvent } from "./react/component-event"
export { EmbedAuthor, type EmbedAuthorProps } from "./react/embed-author"
export { EmbedField, type EmbedFieldProps } from "./react/embed-field"
export { EmbedFooter, type EmbedFooterProps } from "./react/embed-footer"
export { EmbedImage, type EmbedImageProps } from "./react/embed-image"
export {
EmbedThumbnail,
type EmbedThumbnailProps,
} from "./react/embed-thumbnail"
export { EmbedTitle, type EmbedTitleProps } from "./react/embed-title"
export { Embed, type EmbedProps } from "./react/embed"
export { useInstance } from "./react/instance-context"
export { Link, type LinkProps } from "./react/link"
export { Option, type OptionProps } from "./react/option"
export {
Select,
type SelectProps,
type SelectChangeEvent,
} from "./react/select"

View File

@@ -1,257 +0,0 @@
import type {
APIActionRowComponent,
APIButtonComponent,
APIEmbed,
APISelectMenuComponent,
APISelectMenuOption,
} from "discord-api-types/v10"
import { ButtonStyle, ComponentType } from "discord-api-types/v10"
import type { Node } from "./node"
import { TextNode } from "./node"
import { ActionRowNode } from "./react/action-row"
import type { ButtonProps } from "./react/button"
import { ButtonNode } from "./react/button"
import { EmbedNode } from "./react/embed"
import { EmbedAuthorNode } from "./react/embed-author"
import {
EmbedFieldNameNode,
EmbedFieldNode,
EmbedFieldValueNode,
} from "./react/embed-field"
import { EmbedFooterNode } from "./react/embed-footer"
import { EmbedImageNode } from "./react/embed-image"
import { EmbedThumbnailNode } from "./react/embed-thumbnail"
import { EmbedTitleNode } from "./react/embed-title"
import { LinkNode } from "./react/link"
import {
OptionDescriptionNode,
OptionLabelNode,
OptionNode,
} from "./react/option"
import { SelectNode } from "./react/select"
export type MessageUpdatePayload = {
content: string | null
embeds: APIEmbed[]
components: Array<
APIActionRowComponent<APIButtonComponent | APISelectMenuComponent>
>
}
export function makeMessageUpdatePayload(root: Node): MessageUpdatePayload {
return {
// eslint-disable-next-line unicorn/no-null
content: root.extractText() || null,
embeds: makeEmbeds(root),
components: makeActionRows(root),
}
}
function makeEmbeds(root: Node) {
const embeds: APIEmbed[] = []
for (const node of root.children) {
if (node instanceof EmbedNode) {
const { props, children } = node
const embed: APIEmbed = {
author: props.author && {
name: props.author.name,
icon_url: props.author.iconUrl,
url: props.author.url,
},
color: props.color,
description: props.description,
fields: props.fields?.map(({ name, value, inline }) => ({
name,
value,
inline,
})),
footer: props.footer && {
text: props.footer.text,
icon_url: props.footer.iconUrl,
},
image: props.image,
thumbnail: props.thumbnail,
title: props.title,
url: props.url,
video: props.video,
}
if (props.timestamp !== undefined) {
embed.timestamp = normalizeDatePropToISOString(props.timestamp)
}
applyEmbedChildren(embed, children)
embeds.push(embed)
}
}
return embeds
}
function applyEmbedChildren(embed: APIEmbed, children: Node[]) {
for (const child of children) {
if (child instanceof EmbedAuthorNode) {
embed.author = {
name: child.extractText(),
icon_url: child.props.iconUrl,
url: child.props.url,
}
}
if (child instanceof EmbedFieldNode) {
embed.fields ??= []
embed.fields.push({
name: child.findInstanceOf(EmbedFieldNameNode)?.extractText() ?? "",
value:
child.findInstanceOf(EmbedFieldValueNode)?.extractText() || "_ _", // can't send an empty string
inline: child.props.inline,
})
}
if (child instanceof EmbedFooterNode) {
embed.footer = {
text: child.extractText(),
icon_url: child.props.iconUrl,
}
if (child.props.timestamp != undefined) {
embed.timestamp = normalizeDatePropToISOString(child.props.timestamp)
}
}
if (child instanceof EmbedImageNode) {
embed.image = { url: child.props.url }
}
if (child instanceof EmbedThumbnailNode) {
embed.thumbnail = { url: child.props.url }
}
if (child instanceof EmbedTitleNode) {
embed.title = child.extractText()
embed.url = child.props.url
}
if (child instanceof EmbedNode) {
applyEmbedChildren(embed, child.children)
}
if (child instanceof TextNode) {
embed.description ??= ""
embed.description += child.props.text
}
}
}
function normalizeDatePropToISOString(value: string | number | Date) {
return value instanceof Date
? value.toISOString()
: new Date(value).toISOString()
}
function makeActionRows(root: Node) {
const actionRows: Array<
APIActionRowComponent<APIButtonComponent | APISelectMenuComponent>
> = []
function getNextActionRow() {
let currentRow = actionRows[actionRows.length - 1]
if (
!currentRow ||
currentRow.components.length >= 5 ||
currentRow.components[0]?.type === ComponentType.SelectMenu
) {
currentRow = {
type: ComponentType.ActionRow,
components: [],
}
actionRows.push(currentRow)
}
return currentRow
}
for (const node of root.children) {
if (node instanceof ButtonNode) {
getNextActionRow().components.push({
type: ComponentType.Button,
custom_id: node.customId,
label: node.extractText(Number.POSITIVE_INFINITY),
emoji: node.props.emoji ? { name: node.props.emoji } : undefined,
style: translateButtonStyle(node.props.style ?? "secondary"),
disabled: node.props.disabled,
})
}
if (node instanceof LinkNode) {
getNextActionRow().components.push({
type: ComponentType.Button,
label: node.extractText(Number.POSITIVE_INFINITY),
url: node.props.url,
style: ButtonStyle.Link,
disabled: node.props.disabled,
})
}
if (node instanceof SelectNode) {
const actionRow: APIActionRowComponent<APISelectMenuComponent> = {
type: ComponentType.ActionRow,
components: [],
}
actionRows.push(actionRow)
let selectedValues: string[] = []
if (node.props.multiple && node.props.values) {
selectedValues = node.props.values ?? []
}
if (!node.props.multiple && node.props.value != undefined) {
selectedValues = [node.props.value]
}
const options = [...node.children]
.flatMap((child) => (child instanceof OptionNode ? child : []))
.map<APISelectMenuOption>((child) => ({
label:
child.findInstanceOf(OptionLabelNode)?.extractText() ||
child.props.value,
description: child
.findInstanceOf(OptionDescriptionNode)
?.extractText(),
value: child.props.value,
default: selectedValues.includes(child.props.value),
emoji: { name: child.props.emoji },
}))
const select: APISelectMenuComponent = {
type: ComponentType.SelectMenu,
custom_id: node.customId,
options,
disabled: node.props.disabled,
}
if (node.props.multiple) {
select.min_values = node.props.minValues
select.max_values = node.props.maxValues
}
actionRow.components.push(select)
}
if (node instanceof ActionRowNode) {
actionRows.push(...makeActionRows(node))
}
}
return actionRows
}
function translateButtonStyle(style: NonNullable<ButtonProps["style"]>) {
const styleMap = {
primary: ButtonStyle.Primary,
secondary: ButtonStyle.Secondary,
danger: ButtonStyle.Danger,
success: ButtonStyle.Success,
} as const
return styleMap[style]
}

View File

@@ -1,57 +0,0 @@
export class Node<Props = unknown> {
readonly children: Node[] = []
constructor(public props: Props) {}
clear() {
this.children.splice(0)
}
add(...nodes: Node[]) {
this.children.push(...nodes)
}
remove(node: Node) {
const index = this.children.indexOf(node)
if (index !== -1) this.children.splice(index, 1)
}
insertBefore(node: Node, beforeNode: Node) {
const index = this.children.indexOf(beforeNode)
if (index !== -1) this.children.splice(index, 0, node)
}
replace(oldNode: Node, newNode: Node) {
const index = this.children.indexOf(oldNode)
if (index !== -1) this.children[index] = newNode
}
clone(): this {
const cloned: this = new (this.constructor as any)()
cloned.add(...this.children.map((child) => child.clone()))
return cloned
}
*walk(): Generator<Node> {
yield this
for (const child of this.children) {
yield* child.walk()
}
}
findInstanceOf<T extends Node>(
cls: new (...args: any[]) => T,
): T | undefined {
for (const child of this.children) {
if (child instanceof cls) return child
}
}
extractText(depth = 1): string {
if (this instanceof TextNode) return this.props.text
if (depth <= 0) return ""
return this.children.map((child) => child.extractText(depth - 1)).join("")
}
}
export class TextNode extends Node<{ text: string }> {}

View File

@@ -1,181 +0,0 @@
import type { APIInteraction, Client } from "discord.js"
import {
GatewayDispatchEvents,
GatewayIntentBits,
InteractionResponseType,
InteractionType,
Routes,
} from "discord.js"
import * as React from "react"
import { createDiscordClient } from "./create-discord-client"
import type { ReacordInstance } from "./reacord-instance"
import { ReacordInstancePrivate } from "./reacord-instance"
import { InstanceProvider } from "./react/instance-context"
import type { Renderer } from "./renderer"
import {
ChannelMessageRenderer,
EphemeralInteractionReplyRenderer,
InteractionReplyRenderer,
} from "./renderer"
/**
* @category Core
*/
export type ReacordConfig = {
/** Discord bot token */
token: string
/**
* The max number of active instances.
* When this limit is exceeded, the oldest instances will be cleaned up
* to prevent memory leaks.
*/
maxInstances?: number
}
/**
* Info for replying to an interaction. For Discord.js
* (and probably other libraries) you should be able to pass the
* interaction object directly:
* ```js
* client.on("interactionCreate", (interaction) => {
* if (interaction.isChatInputCommand() && interaction.commandName === "hi") {
* reacord.reply(interacition, "hi lol")
* }
* })
* ```
* @category Core
*/
export type InteractionInfo = {
id: string
token: string
}
/**
* @category Core
*/
export class ReacordClient {
private readonly config: Required<ReacordConfig>
private readonly discordClientPromise: Promise<Client<true>>
private instances: ReacordInstancePrivate[] = []
destroyed = false
constructor(config: ReacordConfig) {
this.config = {
...config,
maxInstances: config.maxInstances ?? 50,
}
this.discordClientPromise = createDiscordClient(this.config.token, {
intents: [GatewayIntentBits.Guilds],
})
this.discordClientPromise
.then((client) => {
// we listen to the websocket message instead of the normal "interactionCreate" event,
// so that we can pass a library-agnostic APIInteraction object to the user's component callbacks
// the DJS MessageComponentInteraction doesn't have the raw data on it (as of writing this)
client.ws.on(
GatewayDispatchEvents.InteractionCreate,
async (interaction: APIInteraction) => {
if (interaction.type !== InteractionType.MessageComponent) return
// handling a component interaction may not always result in a re-render,
// and in the case that it doesn't, discord will incorrectly show "interaction failed",
// so here, we'll just always defer an update just in case
//
// we _can_ be a little smarter and check to see if an update happened before deferring,
// but I can figure that out later
//
// or we can make the user defer themselves if they don't update,
// but that's bad UX probably
await client.rest.post(
Routes.interactionCallback(interaction.id, interaction.token),
{ body: { type: InteractionResponseType.DeferredMessageUpdate } },
)
for (const instance of this.instances) {
instance.handleInteraction(interaction, this)
}
},
)
return client
})
.catch(console.error)
}
send(channelId: string, initialContent?: React.ReactNode) {
return this.createInstance(
new ChannelMessageRenderer(channelId, this.discordClientPromise),
initialContent,
)
}
reply(interaction: InteractionInfo, initialContent?: React.ReactNode) {
return this.createInstance(
new InteractionReplyRenderer(interaction, this.discordClientPromise),
initialContent,
)
}
ephemeralReply(
interaction: InteractionInfo,
initialContent?: React.ReactNode,
) {
return this.createInstance(
new EphemeralInteractionReplyRenderer(
interaction,
this.discordClientPromise,
),
initialContent,
)
}
destroy() {
void this.discordClientPromise.then((client) => client.destroy())
this.destroyed = true
}
private createInstance(renderer: Renderer, initialContent?: React.ReactNode) {
if (this.destroyed) throw new Error("ReacordClient is destroyed")
const instance = new ReacordInstancePrivate(renderer)
this.instances.push(instance)
if (this.instances.length > this.config.maxInstances) {
void this.instances[0]?.deactivate()
this.removeInstance(this.instances[0]!)
}
const publicInstance: ReacordInstance = {
render: (content: React.ReactNode) => {
instance.render(
React.createElement(
InstanceProvider,
{ value: publicInstance },
content,
),
)
},
deactivate: () => {
this.removeInstance(instance)
renderer.deactivate()
},
destroy: () => {
this.removeInstance(instance)
renderer.destroy()
},
}
if (initialContent !== undefined) {
publicInstance.render(initialContent)
}
return publicInstance
}
private removeInstance(instance: ReacordInstancePrivate) {
this.instances = this.instances.filter((the) => the !== instance)
}
}

View File

@@ -1,122 +0,0 @@
import type {
APIMessageComponentButtonInteraction,
APIMessageComponentInteraction,
APIMessageComponentSelectMenuInteraction,
} from "discord.js"
import { ComponentType } from "discord.js"
import type * as React from "react"
import { Node } from "./node"
import type { ReacordClient } from "./reacord-client"
import { ButtonNode } from "./react/button"
import type { ComponentEvent } from "./react/component-event"
import { reconciler } from "./react/reconciler"
import type { SelectChangeEvent } from "./react/select"
import { SelectNode } from "./react/select"
import type { Renderer } from "./renderer"
/**
* Represents an interactive message, which can later be replaced or deleted.
* @category Core
*/
export type ReacordInstance = {
/** Render some JSX to this instance (edits the message) */
render(content: React.ReactNode): void
/** Remove this message */
destroy(): void
/**
* Same as destroy, but keeps the message and disables the components on it.
* This prevents it from listening to user interactions.
*/
deactivate(): void
}
export class ReacordInstancePrivate {
private readonly container = reconciler.createContainer(
this,
0,
// eslint-disable-next-line unicorn/no-null
null,
false,
// eslint-disable-next-line unicorn/no-null
null,
"reacord",
() => {},
// eslint-disable-next-line unicorn/no-null
null,
)
readonly tree = new Node({})
private latestTree?: Node
constructor(readonly renderer: Renderer) {}
render(content: React.ReactNode) {
reconciler.updateContainer(content, this.container)
}
update(tree: Node) {
this.renderer.update(tree)
this.latestTree = tree
}
deactivate() {
this.renderer.deactivate()
}
destroy() {
this.renderer.destroy()
}
handleInteraction(
interaction: APIMessageComponentInteraction,
client: ReacordClient,
) {
if (!this.latestTree) return
this.renderer.onComponentInteraction(interaction)
const baseEvent: ComponentEvent = {
reply: (content) => client.reply(interaction, content),
ephemeralReply: (content) => client.ephemeralReply(interaction, content),
}
if (interaction.data.component_type === ComponentType.Button) {
for (const node of this.latestTree.walk()) {
if (
node instanceof ButtonNode &&
node.customId === interaction.data.custom_id
) {
node.props.onClick({
...baseEvent,
interaction: interaction as APIMessageComponentButtonInteraction,
})
return
}
}
}
if (interaction.data.component_type === ComponentType.SelectMenu) {
const event: SelectChangeEvent = {
...baseEvent,
interaction: interaction as APIMessageComponentSelectMenuInteraction,
values: interaction.data.values,
}
for (const node of this.latestTree.walk()) {
if (
node instanceof SelectNode &&
node.customId === interaction.data.custom_id
) {
node.props.onChange?.(event)
node.props.onChangeMultiple?.(interaction.data.values, event)
if (interaction.data.values[0]) {
node.props.onChangeValue?.(interaction.data.values[0], event)
}
return
}
}
}
}
}

View File

@@ -1,49 +0,0 @@
import type { APIMessageComponentButtonInteraction } from "discord.js"
import { randomUUID } from "node:crypto"
import React from "react"
import { Node } from "../node"
import type { ButtonSharedProps } from "./button-shared-props"
import type { ComponentEvent } from "./component-event"
import { ReacordElement } from "./reacord-element"
/**
* @category Button
*/
export type ButtonProps = ButtonSharedProps & {
/**
* The style determines the color of the button and signals intent.
* @see https://discord.com/developers/docs/interactions/message-components#button-object-button-styles
*/
style?: "primary" | "secondary" | "success" | "danger"
/**
* Happens when a user clicks the button.
*/
onClick: (event: ButtonClickEvent) => void
}
/**
* @category Button
*/
export type ButtonClickEvent = ComponentEvent & {
/**
* Event details, e.g. the user who clicked, guild member, guild id, etc.
* @see https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object
*/
interaction: APIMessageComponentButtonInteraction
}
/**
* @category Button
*/
export function Button(props: ButtonProps) {
return (
<ReacordElement props={props} createNode={() => new ButtonNode(props)}>
{props.label}
</ReacordElement>
)
}
export class ButtonNode extends Node<ButtonProps> {
readonly customId = randomUUID()
}

View File

@@ -1,18 +0,0 @@
import type { ReactNode } from "react"
import type { ReacordInstance } from "../reacord-instance"
/**
* @category Component Event
*/
export type ComponentEvent = {
/**
* Create a new reply to this event.
*/
reply(content?: ReactNode): ReacordInstance
/**
* Create an ephemeral reply to this event,
* shown only to the user who triggered it.
*/
ephemeralReply(content?: ReactNode): ReacordInstance
}

View File

@@ -1,27 +0,0 @@
import type { ReactNode } from "react"
import React from "react"
import { Node } from "../node"
import { ReacordElement } from "./reacord-element"
/**
* @category Embed
*/
export type EmbedAuthorProps = {
name?: ReactNode
children?: ReactNode
url?: string
iconUrl?: string
}
/**
* @category Embed
*/
export function EmbedAuthor(props: EmbedAuthorProps) {
return (
<ReacordElement props={props} createNode={() => new EmbedAuthorNode(props)}>
{props.name ?? props.children}
</ReacordElement>
)
}
export class EmbedAuthorNode extends Node<EmbedAuthorProps> {}

View File

@@ -1,34 +0,0 @@
import type { ReactNode } from "react"
import React from "react"
import { Node } from "../node"
import { ReacordElement } from "./reacord-element"
/**
* @category Embed
*/
export type EmbedFieldProps = {
name: ReactNode
value?: ReactNode
inline?: boolean
children?: ReactNode
}
/**
* @category Embed
*/
export function EmbedField(props: EmbedFieldProps) {
return (
<ReacordElement props={props} createNode={() => new EmbedFieldNode(props)}>
<ReacordElement props={{}} createNode={() => new EmbedFieldNameNode({})}>
{props.name}
</ReacordElement>
<ReacordElement props={{}} createNode={() => new EmbedFieldValueNode({})}>
{props.value ?? props.children}
</ReacordElement>
</ReacordElement>
)
}
export class EmbedFieldNode extends Node<EmbedFieldProps> {}
export class EmbedFieldNameNode extends Node<{}> {}
export class EmbedFieldValueNode extends Node<{}> {}

View File

@@ -1,29 +0,0 @@
import type { ReactNode } from "react"
import React from "react"
import { Node } from "../node"
import { ReacordElement } from "./reacord-element"
/**
* @category Embed
*/
export type EmbedFooterProps = {
text?: ReactNode
children?: ReactNode
iconUrl?: string
timestamp?: string | number | Date
}
/**
* @category Embed
*/
export function EmbedFooter({ text, children, ...props }: EmbedFooterProps) {
return (
<ReacordElement props={props} createNode={() => new EmbedFooterNode(props)}>
{text ?? children}
</ReacordElement>
)
}
export class EmbedFooterNode extends Node<
Omit<EmbedFooterProps, "text" | "children">
> {}

View File

@@ -1,24 +0,0 @@
import React from "react"
import { Node } from "../node"
import { ReacordElement } from "./reacord-element"
/**
* @category Embed
*/
export type EmbedImageProps = {
url: string
}
/**
* @category Embed
*/
export function EmbedImage(props: EmbedImageProps) {
return (
<ReacordElement
props={props}
createNode={() => new EmbedImageNode(props)}
/>
)
}
export class EmbedImageNode extends Node<EmbedImageProps> {}

View File

@@ -1,24 +0,0 @@
import React from "react"
import { Node } from "../node"
import { ReacordElement } from "./reacord-element"
/**
* @category Embed
*/
export type EmbedThumbnailProps = {
url: string
}
/**
* @category Embed
*/
export function EmbedThumbnail(props: EmbedThumbnailProps) {
return (
<ReacordElement
props={props}
createNode={() => new EmbedThumbnailNode(props)}
/>
)
}
export class EmbedThumbnailNode extends Node<EmbedThumbnailProps> {}

View File

@@ -1,26 +0,0 @@
import type { ReactNode } from "react"
import React from "react"
import type { Except } from "type-fest"
import { Node } from "../node"
import { ReacordElement } from "./reacord-element"
/**
* @category Embed
*/
export type EmbedTitleProps = {
children: ReactNode
url?: string
}
/**
* @category Embed
*/
export function EmbedTitle({ children, ...props }: EmbedTitleProps) {
return (
<ReacordElement props={props} createNode={() => new EmbedTitleNode(props)}>
{children}
</ReacordElement>
)
}
export class EmbedTitleNode extends Node<Except<EmbedTitleProps, "children">> {}

View File

@@ -1,36 +0,0 @@
import React from "react"
import { Node } from "../node"
import { ReacordElement } from "./reacord-element"
/**
* @category Embed
* @see https://discord.com/developers/docs/resources/channel#embed-object
*/
export type EmbedProps = {
title?: string
description?: string
url?: string
color?: number
fields?: Array<{ name: string; value: string; inline?: boolean }>
author?: { name: string; url?: string; iconUrl?: string }
thumbnail?: { url: string }
image?: { url: string }
video?: { url: string }
footer?: { text: string; iconUrl?: string }
timestamp?: string | number | Date
children?: React.ReactNode
}
/**
* @category Embed
* @see https://discord.com/developers/docs/resources/channel#embed-object
*/
export function Embed(props: EmbedProps) {
return (
<ReacordElement props={props} createNode={() => new EmbedNode(props)}>
{props.children}
</ReacordElement>
)
}
export class EmbedNode extends Node<EmbedProps> {}

View File

@@ -1,28 +0,0 @@
import React from "react"
import type { Except } from "type-fest"
import { Node } from "../node"
import type { ButtonSharedProps } from "./button-shared-props"
import { ReacordElement } from "./reacord-element"
/**
* @category Link
*/
export type LinkProps = ButtonSharedProps & {
/** The URL the link should lead to */
url: string
/** The link text */
children?: string
}
/**
* @category Link
*/
export function Link({ label, children, ...props }: LinkProps) {
return (
<ReacordElement props={props} createNode={() => new LinkNode(props)}>
{label || children}
</ReacordElement>
)
}
export class LinkNode extends Node<Except<LinkProps, "label" | "children">> {}

View File

@@ -1,251 +0,0 @@
import { AsyncQueue } from "@reacord/helpers/async-queue"
import type {
Client,
Message,
RESTPostAPIInteractionFollowupResult,
Snowflake,
} from "discord.js"
import { InteractionResponseType, Routes, TextChannel } from "discord.js"
import type { MessageUpdatePayload } from "./make-message-update-payload"
import { makeMessageUpdatePayload } from "./make-message-update-payload"
import type { Node } from "./node"
import type { InteractionInfo } from "./reacord-client"
export abstract class Renderer {
private active = true
private componentInteraction?: InteractionInfo
private readonly queue = new AsyncQueue()
constructor(protected readonly clientPromise: Promise<Client<true>>) {}
protected abstract handleUpdate(payload: MessageUpdatePayload): Promise<void>
protected abstract handleDestroy(): Promise<void>
protected abstract handleDeactivate(): Promise<void>
update(tree: Node) {
const payload = makeMessageUpdatePayload(tree)
this.queue
.append(async () => {
if (!this.active) return
if (this.componentInteraction) {
await this.updateInteractionMessage(
this.componentInteraction,
payload,
)
this.componentInteraction = undefined
return
}
await this.handleUpdate(payload)
})
.catch(console.error)
}
destroy() {
if (!this.active) return
this.active = false
this.queue.append(() => this.handleDestroy()).catch(console.error)
}
deactivate() {
this.queue
.append(async () => {
await this.handleDeactivate()
this.active = false
})
.catch(console.error)
}
onComponentInteraction(info: InteractionInfo) {
this.componentInteraction = info
// a component update might not happen in response to this interaction,
// so we'll defer it after a timeout if it's not handled by then
setTimeout(() => {
this.queue
.append(() => {
if (!this.componentInteraction) return
const info = this.componentInteraction
this.componentInteraction = undefined
return this.deferMessageUpdate(info)
})
.catch(console.error)
}, 500)
}
private async updateInteractionMessage(
{ id, token }: InteractionInfo,
payload: MessageUpdatePayload,
) {
const client = await this.clientPromise
await client.rest.post(Routes.interactionCallback(id, token), {
body: {
type: InteractionResponseType.UpdateMessage,
data: payload,
},
})
}
private async deferMessageUpdate({ id, token }: InteractionInfo) {
const client = await this.clientPromise
await client.rest.post(Routes.interactionCallback(id, token), {
body: { type: InteractionResponseType.DeferredMessageUpdate },
})
}
}
export class ChannelMessageRenderer extends Renderer {
private channel?: TextChannel
private message?: Message
constructor(
private readonly channelId: string,
clientPromise: Promise<Client<true>>,
) {
super(clientPromise)
}
override async handleUpdate(payload: MessageUpdatePayload): Promise<void> {
if (this.message) {
await this.message.edit(payload)
return
}
const channel = await this.getChannel()
this.message = await channel.send(payload)
}
override async handleDestroy(): Promise<void> {
const message = this.message
this.message = undefined
await message?.delete()
}
override async handleDeactivate(): Promise<void> {
throw new Error("not implemented")
}
private async getChannel(): Promise<TextChannel> {
if (this.channel) return this.channel
const client = await this.clientPromise
const channel =
client.channels.cache.get(this.channelId) ??
(await client.channels.fetch(this.channelId))
if (!(channel instanceof TextChannel)) {
throw new TypeError(`Channel ${this.channelId} is not a text channel`)
}
this.channel = channel
return channel
}
}
export class InteractionReplyRenderer extends Renderer {
private messageCreated = false
constructor(
private interaction: InteractionInfo,
clientPromise: Promise<Client<true>>,
) {
super(clientPromise)
}
async handleUpdate(payload: MessageUpdatePayload): Promise<void> {
const client = await this.clientPromise
if (!this.messageCreated) {
await client.rest.post(
Routes.interactionCallback(this.interaction.id, this.interaction.token),
{
body: {
type: InteractionResponseType.ChannelMessageWithSource,
data: payload,
},
},
)
this.messageCreated = true
} else {
await client.rest.patch(
Routes.webhookMessage(
client.application.id,
this.interaction.token,
"@original",
),
{ body: payload },
)
}
}
handleDestroy(): Promise<void> {
throw new Error("Method not implemented.")
}
handleDeactivate(): Promise<void> {
throw new Error("Method not implemented.")
}
}
export class InteractionFollowUpRenderer extends Renderer {
private messageId?: Snowflake
constructor(
readonly interaction: InteractionInfo,
clientPromise: Promise<Client<true>>,
) {
super(clientPromise)
}
async handleUpdate(payload: MessageUpdatePayload): Promise<void> {
const client = await this.clientPromise
if (!this.messageId) {
const response = (await client.rest.post(
Routes.webhookMessage(client.application.id, this.interaction.token),
{ body: payload },
)) as RESTPostAPIInteractionFollowupResult
this.messageId = response.id
} else {
await client.rest.patch(
Routes.webhookMessage(
client.application.id,
this.interaction.token,
this.messageId,
),
{ body: payload },
)
}
}
handleDestroy(): Promise<void> {
throw new Error("Method not implemented.")
}
handleDeactivate(): Promise<void> {
throw new Error("Method not implemented.")
}
}
export class EphemeralInteractionReplyRenderer extends Renderer {
constructor(
private readonly interaction: InteractionInfo,
clientPromise: Promise<Client<true>>,
) {
super(clientPromise)
}
handleUpdate(payload: MessageUpdatePayload): Promise<void> {
throw new Error("Method not implemented.")
}
handleDestroy(): Promise<void> {
throw new Error("Method not implemented.")
}
handleDeactivate(): Promise<void> {
throw new Error("Method not implemented.")
}
}

View File

@@ -1,60 +1,41 @@
import { ComponentType } from "discord.js"
import React from "react" import React from "react"
import { expect, test } from "vitest" import { test } from "vitest"
import { ActionRow, Button, Option, Select } from "../src/main" import { ActionRow, Button, Select } from "../library/main"
import { ReacordTester } from "./tester" import { ReacordTester } from "./test-adapter"
const testing = new ReacordTester()
test("action row", async () => { test("action row", async () => {
const { message } = await ReacordTester.render( await testing.assertRender(
"action row",
<> <>
<Button label="outside button" onClick={() => {}} /> <Button label="outside button" onClick={() => {}} />
<ActionRow> <ActionRow>
<Button label="button inside action row" onClick={() => {}} /> <Button label="button inside action row" onClick={() => {}} />
</ActionRow> </ActionRow>
<Select value="the"> <Select />
<Option value="the" />
</Select>
<Button label="last row 1" onClick={() => {}} /> <Button label="last row 1" onClick={() => {}} />
<Button label="last row 2" onClick={() => {}} /> <Button label="last row 2" onClick={() => {}} />
</>, </>,
[
{
content: "",
embeds: [],
actionRows: [
[{ type: "button", style: "secondary", label: "outside button" }],
[
{
type: "button",
style: "secondary",
label: "button inside action row",
},
],
[{ type: "select", options: [], values: [] }],
[
{ type: "button", style: "secondary", label: "last row 1" },
{ type: "button", style: "secondary", label: "last row 2" },
],
],
},
],
) )
expect(message.components.map((c) => c.toJSON())).toEqual([
{
type: ComponentType.ActionRow,
components: [
expect.objectContaining({
type: ComponentType.Button,
label: "outside button",
}),
],
},
{
type: ComponentType.ActionRow,
components: [
expect.objectContaining({
type: ComponentType.Button,
label: "button inside action row",
}),
],
},
{
type: ComponentType.ActionRow,
components: [expect.objectContaining({ type: ComponentType.SelectMenu })],
},
{
type: ComponentType.ActionRow,
components: [
expect.objectContaining({
type: ComponentType.Button,
label: "last row 1",
}),
expect.objectContaining({
type: ComponentType.Button,
label: "last row 2",
}),
],
},
])
}) })

View File

@@ -1,13 +1,9 @@
import { spawnSync } from "node:child_process" import { spawnSync } from "node:child_process"
import { createRequire } from "node:module" import { createRequire } from "node:module"
import { join } from "node:path"
import { fileURLToPath } from "node:url"
import { beforeAll, expect, test } from "vitest" import { beforeAll, expect, test } from "vitest"
beforeAll(() => { beforeAll(() => {
spawnSync("pnpm", ["run", "build"], { spawnSync("pnpm", ["run", "build"])
cwd: join(fileURLToPath(import.meta.url), ".."),
})
}) })
test("can require commonjs", () => { test("can require commonjs", () => {

View File

@@ -0,0 +1,3 @@
import { test } from "vitest"
test.todo("discord js integration")

View File

@@ -1,5 +1,5 @@
import React from "react" import React from "react"
import { expect, test } from "vitest" import { test } from "vitest"
import { import {
Embed, Embed,
EmbedAuthor, EmbedAuthor,
@@ -8,14 +8,15 @@ import {
EmbedImage, EmbedImage,
EmbedThumbnail, EmbedThumbnail,
EmbedTitle, EmbedTitle,
} from "../src/main" } from "../library/main"
import { ReacordTester } from "./tester" import { ReacordTester } from "./test-adapter"
const testing = new ReacordTester()
test("kitchen sink", async () => { test("kitchen sink", async () => {
const now = new Date() const now = new Date()
const { message } = await ReacordTester.render( await testing.assertRender(
"kitchen sink",
<> <>
<Embed color={0xfe_ee_ef}> <Embed color={0xfe_ee_ef}>
<EmbedAuthor name="author" iconUrl="https://example.com/author.png" /> <EmbedAuthor name="author" iconUrl="https://example.com/author.png" />
@@ -32,83 +33,85 @@ test("kitchen sink", async () => {
/> />
</Embed> </Embed>
</>, </>,
[
{
actionRows: [],
content: "",
embeds: [
{
description: "description text",
author: {
icon_url: "https://example.com/author.png",
name: "author",
},
color: 0xfe_ee_ef,
fields: [
{
inline: true,
name: "field name",
value: "field value",
},
{
name: "block field",
value: "block field value",
},
],
footer: {
icon_url: "https://example.com/footer.png",
text: "footer text",
},
image: {
url: "https://example.com/image.png",
},
thumbnail: {
url: "https://example.com/thumbnail.png",
},
timestamp: now.toISOString(),
title: "title text",
},
],
},
],
) )
expect(message.embeds.map((e) => e.toJSON())).toEqual([
expect.objectContaining({
description: "description text",
author: expect.objectContaining({
icon_url: "https://example.com/author.png",
name: "author",
}),
color: 0xfe_ee_ef,
fields: [
{
inline: true,
name: "field name",
value: "field value",
},
{
inline: false,
name: "block field",
value: "block field value",
},
],
footer: expect.objectContaining({
icon_url: "https://example.com/footer.png",
text: "footer text",
}),
image: expect.objectContaining({
url: "https://example.com/image.png",
}),
thumbnail: expect.objectContaining({
url: "https://example.com/thumbnail.png",
}),
title: "title text",
}),
])
// the timestamp format from Discord is not the same one that JS makes
expect(new Date(message.embeds[0]!.timestamp!)).toEqual(now)
}) })
test("author variants", async () => { test("author variants", async () => {
const { message } = await ReacordTester.render( await testing.assertRender(
"author variants",
<> <>
<Embed> <Embed>
<EmbedAuthor iconUrl="https://example.com/author.png"> <EmbedAuthor iconUrl="https://example.com/author.png">
author name 1 author name
</EmbedAuthor> </EmbedAuthor>
</Embed> </Embed>
<Embed> <Embed>
<EmbedAuthor <EmbedAuthor iconUrl="https://example.com/author.png" />
name="author name 2"
iconUrl="https://example.com/author.png"
/>
</Embed> </Embed>
</>, </>,
[
{
content: "",
actionRows: [],
embeds: [
{
author: {
icon_url: "https://example.com/author.png",
name: "author name",
},
},
{
author: {
icon_url: "https://example.com/author.png",
name: "",
},
},
],
},
],
) )
})
expect(message.embeds.map((e) => e.toJSON())).toEqual([
expect.objectContaining({
author: expect.objectContaining({
name: "author name 1",
icon_url: "https://example.com/author.png",
}),
}),
expect.objectContaining({
author: expect.objectContaining({
name: "author name 2",
icon_url: "https://example.com/author.png",
}),
}),
])
}, 20_000)
test("field variants", async () => { test("field variants", async () => {
const { message } = await ReacordTester.render( await testing.assertRender(
"field variants",
<> <>
<Embed> <Embed>
<EmbedField name="field name" value="field value" /> <EmbedField name="field name" value="field value" />
@@ -119,41 +122,43 @@ test("field variants", async () => {
<EmbedField name="field name" /> <EmbedField name="field name" />
</Embed> </Embed>
</>, </>,
[
{
content: "",
actionRows: [],
embeds: [
{
fields: [
{
name: "field name",
value: "field value",
},
{
inline: true,
name: "field name",
value: "field value",
},
{
inline: true,
name: "field name",
value: "field value",
},
{
name: "field name",
value: "",
},
],
},
],
},
],
) )
expect(message.embeds.map((e) => e.toJSON())).toEqual([
expect.objectContaining({
fields: [
{
name: "field name",
value: "field value",
inline: false,
},
{
name: "field name",
value: "field value",
inline: true,
},
{
name: "field name",
value: "field value",
inline: true,
},
{
name: "field name",
value: "_ _",
inline: false,
},
],
}),
])
}) })
test("footer variants", async () => { test("footer variants", async () => {
const now = new Date() const now = new Date()
const { message } = await ReacordTester.render( await testing.assertRender(
"footer variants",
<> <>
<Embed> <Embed>
<EmbedFooter text="footer text" /> <EmbedFooter text="footer text" />
@@ -171,37 +176,45 @@ test("footer variants", async () => {
<EmbedFooter iconUrl="https://example.com/footer.png" timestamp={now} /> <EmbedFooter iconUrl="https://example.com/footer.png" timestamp={now} />
</Embed> </Embed>
</>, </>,
) [
{
expect(message.embeds.map((e) => e.toJSON())).toEqual([ content: "",
expect.objectContaining({ actionRows: [],
footer: { embeds: [
text: "footer text", {
footer: {
text: "footer text",
},
},
{
footer: {
icon_url: "https://example.com/footer.png",
text: "footer text",
},
},
{
footer: {
text: "footer text",
},
timestamp: now.toISOString(),
},
{
footer: {
icon_url: "https://example.com/footer.png",
text: "",
},
timestamp: now.toISOString(),
},
],
}, },
}), ],
expect.objectContaining({ )
footer: expect.objectContaining({
icon_url: "https://example.com/footer.png",
text: "footer text",
}),
}),
expect.objectContaining({
timestamp: expect.stringContaining(""),
}),
expect.objectContaining({
timestamp: expect.stringContaining(""),
}),
])
expect(new Date(message.embeds[2]!.timestamp!)).toEqual(now)
expect(new Date(message.embeds[3]!.timestamp!)).toEqual(now)
}) })
test("embed props", async () => { test("embed props", async () => {
const now = new Date() const now = new Date()
const { message } = await ReacordTester.render( await testing.assertRender(
"embed props",
<Embed <Embed
title="title text" title="title text"
description="description text" description="description text"
@@ -228,33 +241,35 @@ test("embed props", async () => {
{ name: "block field", value: "block field value" }, { name: "block field", value: "block field value" },
]} ]}
/>, />,
[
{
content: "",
actionRows: [],
embeds: [
{
title: "title text",
description: "description text",
url: "https://example.com/",
color: 0xfe_ee_ef,
timestamp: now.toISOString(),
author: {
name: "author name",
url: "https://example.com/author",
icon_url: "https://example.com/author.png",
},
thumbnail: { url: "https://example.com/thumbnail.png" },
image: { url: "https://example.com/image.png" },
footer: {
text: "footer text",
icon_url: "https://example.com/footer.png",
},
fields: [
{ name: "field name", value: "field value", inline: true },
{ name: "block field", value: "block field value" },
],
},
],
},
],
) )
expect(message.embeds.map((e) => e.toJSON())).toEqual([
expect.objectContaining({
title: "title text",
description: "description text",
url: "https://example.com/",
color: 0xfe_ee_ef,
author: expect.objectContaining({
name: "author name",
url: "https://example.com/author",
icon_url: "https://example.com/author.png",
}),
thumbnail: expect.objectContaining({
url: "https://example.com/thumbnail.png",
}),
image: expect.objectContaining({ url: "https://example.com/image.png" }),
footer: expect.objectContaining({
text: "footer text",
icon_url: "https://example.com/footer.png",
}),
fields: [
{ name: "field name", value: "field value", inline: true },
{ name: "block field", value: "block field value", inline: false },
],
}),
])
expect(new Date(message.embeds[0]!.timestamp!)).toEqual(now)
}) })

View File

@@ -1,6 +0,0 @@
import { oraPromise } from "ora"
import { ReacordTester } from "./tester"
export async function setup() {
await oraPromise(ReacordTester.removeChannels(), "Running test setup...")
}

View File

@@ -1,43 +1,42 @@
import { ButtonStyle, ComponentType } from "discord.js"
import React from "react" import React from "react"
import { expect, test } from "vitest" import { test } from "vitest"
import { Link } from "../src/main" import { Link } from "../library/main"
import { ReacordTester } from "./tester" import { ReacordTester } from "./test-adapter"
const tester = new ReacordTester()
test("link", async () => { test("link", async () => {
const { message } = await ReacordTester.render( await tester.assertRender(
"link",
<> <>
<Link url="https://example.com/">link text</Link> <Link url="https://example.com/">link text</Link>
<Link label="link text" url="https://example.com/" /> <Link label="link text" url="https://example.com/" />
<Link label="link text" url="https://example.com/" disabled /> <Link label="link text" url="https://example.com/" disabled />
</>, </>,
[
{
content: "",
embeds: [],
actionRows: [
[
{
type: "link",
url: "https://example.com/",
label: "link text",
},
{
type: "link",
url: "https://example.com/",
label: "link text",
},
{
type: "link",
url: "https://example.com/",
label: "link text",
disabled: true,
},
],
],
},
],
) )
expect(message.components.map((c) => c.toJSON())).toEqual([
{
type: ComponentType.ActionRow,
components: [
{
type: ComponentType.Button,
style: ButtonStyle.Link,
url: "https://example.com/",
label: "link text",
},
{
type: ComponentType.Button,
style: ButtonStyle.Link,
url: "https://example.com/",
label: "link text",
},
{
type: ComponentType.Button,
style: ButtonStyle.Link,
url: "https://example.com/",
label: "link text",
disabled: true,
},
],
},
])
}) })

View File

@@ -1,241 +1,251 @@
import { waitFor } from "@reacord/helpers/wait-for.js"
import * as React from "react" import * as React from "react"
import { expect, test } from "vitest" import { test } from "vitest"
import { Button, Embed, EmbedField, EmbedTitle } from "../src/main" import { Button, Embed, EmbedField, EmbedTitle } from "../library/main"
import { ReacordTester } from "./tester" import { ReacordTester } from "./test-adapter"
test.skip("rendering behavior", async () => { test("rendering behavior", async () => {
// const tester = new ReacordTester() const tester = new ReacordTester()
// const reply = tester.reply()
// reply.render(<KitchenSinkCounter onDeactivate={() => reply.deactivate()} />) const reply = tester.reply()
// await tester.assertMessages([ reply.render(<KitchenSinkCounter onDeactivate={() => reply.deactivate()} />)
// {
// content: "count: 0", await tester.assertMessages([
// embeds: [], {
// actionRows: [ content: "count: 0",
// [ embeds: [],
// { actionRows: [
// type: "button", [
// style: "primary", {
// label: "clicc", type: "button",
// }, style: "primary",
// { label: "clicc",
// type: "button", },
// style: "secondary", {
// label: "show embed", type: "button",
// }, style: "secondary",
// { label: "show embed",
// type: "button", },
// style: "danger", {
// label: "deactivate", type: "button",
// }, style: "danger",
// ], label: "deactivate",
// ], },
// }, ],
// ]) ],
// await tester.findButtonByLabel("show embed").click() },
// await tester.assertMessages([ ])
// {
// content: "count: 0", await tester.findButtonByLabel("show embed").click()
// embeds: [{ title: "the counter" }], await tester.assertMessages([
// actionRows: [ {
// [ content: "count: 0",
// { embeds: [{ title: "the counter" }],
// type: "button", actionRows: [
// style: "secondary", [
// label: "hide embed", {
// }, type: "button",
// { style: "secondary",
// type: "button", label: "hide embed",
// style: "primary", },
// label: "clicc", {
// }, type: "button",
// { style: "primary",
// type: "button", label: "clicc",
// style: "danger", },
// label: "deactivate", {
// }, type: "button",
// ], style: "danger",
// ], label: "deactivate",
// }, },
// ]) ],
// await tester.findButtonByLabel("clicc").click() ],
// await tester.assertMessages([ },
// { ])
// content: "count: 1",
// embeds: [ await tester.findButtonByLabel("clicc").click()
// { await tester.assertMessages([
// title: "the counter", {
// fields: [{ name: "is it even?", value: "no" }], content: "count: 1",
// }, embeds: [
// ], {
// actionRows: [ title: "the counter",
// [ fields: [{ name: "is it even?", value: "no" }],
// { },
// type: "button", ],
// style: "secondary", actionRows: [
// label: "hide embed", [
// }, {
// { type: "button",
// type: "button", style: "secondary",
// style: "primary", label: "hide embed",
// label: "clicc", },
// }, {
// { type: "button",
// type: "button", style: "primary",
// style: "danger", label: "clicc",
// label: "deactivate", },
// }, {
// ], type: "button",
// ], style: "danger",
// }, label: "deactivate",
// ]) },
// await tester.findButtonByLabel("clicc").click() ],
// await tester.assertMessages([ ],
// { },
// content: "count: 2", ])
// embeds: [
// { await tester.findButtonByLabel("clicc").click()
// title: "the counter", await tester.assertMessages([
// fields: [{ name: "is it even?", value: "yes" }], {
// }, content: "count: 2",
// ], embeds: [
// actionRows: [ {
// [ title: "the counter",
// { fields: [{ name: "is it even?", value: "yes" }],
// type: "button", },
// style: "secondary", ],
// label: "hide embed", actionRows: [
// }, [
// { {
// type: "button", type: "button",
// style: "primary", style: "secondary",
// label: "clicc", label: "hide embed",
// }, },
// { {
// type: "button", type: "button",
// style: "danger", style: "primary",
// label: "deactivate", label: "clicc",
// }, },
// ], {
// ], type: "button",
// }, style: "danger",
// ]) label: "deactivate",
// await tester.findButtonByLabel("hide embed").click() },
// await tester.assertMessages([ ],
// { ],
// content: "count: 2", },
// embeds: [], ])
// actionRows: [
// [ await tester.findButtonByLabel("hide embed").click()
// { await tester.assertMessages([
// type: "button", {
// style: "primary", content: "count: 2",
// label: "clicc", embeds: [],
// }, actionRows: [
// { [
// type: "button", {
// style: "secondary", type: "button",
// label: "show embed", style: "primary",
// }, label: "clicc",
// { },
// type: "button", {
// style: "danger", type: "button",
// label: "deactivate", style: "secondary",
// }, label: "show embed",
// ], },
// ], {
// }, type: "button",
// ]) style: "danger",
// await tester.findButtonByLabel("clicc").click() label: "deactivate",
// await tester.assertMessages([ },
// { ],
// content: "count: 3", ],
// embeds: [], },
// actionRows: [ ])
// [
// { await tester.findButtonByLabel("clicc").click()
// type: "button", await tester.assertMessages([
// style: "primary", {
// label: "clicc", content: "count: 3",
// }, embeds: [],
// { actionRows: [
// type: "button", [
// style: "secondary", {
// label: "show embed", type: "button",
// }, style: "primary",
// { label: "clicc",
// type: "button", },
// style: "danger", {
// label: "deactivate", type: "button",
// }, style: "secondary",
// ], label: "show embed",
// ], },
// }, {
// ]) type: "button",
// await tester.findButtonByLabel("deactivate").click() style: "danger",
// await tester.assertMessages([ label: "deactivate",
// { },
// content: "count: 3", ],
// embeds: [], ],
// actionRows: [ },
// [ ])
// {
// type: "button", await tester.findButtonByLabel("deactivate").click()
// style: "primary", await tester.assertMessages([
// label: "clicc", {
// disabled: true, content: "count: 3",
// }, embeds: [],
// { actionRows: [
// type: "button", [
// style: "secondary", {
// label: "show embed", type: "button",
// disabled: true, style: "primary",
// }, label: "clicc",
// { disabled: true,
// type: "button", },
// style: "danger", {
// label: "deactivate", type: "button",
// disabled: true, style: "secondary",
// }, label: "show embed",
// ], disabled: true,
// ], },
// }, {
// ]) type: "button",
// await tester.findButtonByLabel("clicc").click() style: "danger",
// await tester.assertMessages([ label: "deactivate",
// { disabled: true,
// content: "count: 3", },
// embeds: [], ],
// actionRows: [ ],
// [ },
// { ])
// type: "button",
// style: "primary", await tester.findButtonByLabel("clicc").click()
// label: "clicc", await tester.assertMessages([
// disabled: true, {
// }, content: "count: 3",
// { embeds: [],
// type: "button", actionRows: [
// style: "secondary", [
// label: "show embed", {
// disabled: true, type: "button",
// }, style: "primary",
// { label: "clicc",
// type: "button", disabled: true,
// style: "danger", },
// label: "deactivate", {
// disabled: true, type: "button",
// }, style: "secondary",
// ], label: "show embed",
// ], disabled: true,
// }, },
// ]) {
type: "button",
style: "danger",
label: "deactivate",
disabled: true,
},
],
],
},
])
}) })
test("destroy()", async () => { test("delete", async () => {
const { message, channel, instance } = await ReacordTester.render( const tester = new ReacordTester()
"destroy()",
const reply = tester.reply()
reply.render(
<> <>
some text some text
<Embed>some embed</Embed> <Embed>some embed</Embed>
@@ -243,22 +253,18 @@ test("destroy()", async () => {
</>, </>,
) )
expect(message.content).toBe("some text") await tester.assertMessages([
expect(message.embeds.map((e) => e.toJSON())).toEqual([ {
expect.objectContaining({ description: "some embed" }), content: "some text",
]) embeds: [{ description: "some embed" }],
expect(message.components.map((a) => a.toJSON())).toEqual([ actionRows: [
expect.objectContaining({ [{ type: "button", style: "secondary", label: "some button" }],
components: [expect.objectContaining({ label: "some button" })], ],
}), },
]) ])
instance.destroy() reply.destroy()
await tester.assertMessages([])
await waitFor(async () => {
const messages = await channel.messages.fetch()
expect(messages.size).toBe(0)
})
}) })
// test multiple instances that can be updated independently, // test multiple instances that can be updated independently,

View File

@@ -1,143 +1,160 @@
import { test } from "vitest" import React, { useState } from "react"
import { expect, test, vi } from "vitest"
import { Button, Option, Select } from "../library/main"
import { ReacordTester } from "./test-adapter"
test.skip("single select", async () => { test("single select", async () => {
// const tester = new ReacordTester() const tester = new ReacordTester()
// const onSelect = vi.fn() const onSelect = vi.fn()
// function TestSelect() {
// const [value, setValue] = useState<string>() function TestSelect() {
// const [disabled, setDisabled] = useState(false) const [value, setValue] = useState<string>()
// return ( const [disabled, setDisabled] = useState(false)
// <> return (
// <Select <>
// placeholder="choose one" <Select
// value={value} placeholder="choose one"
// onChange={onSelect} value={value}
// onChangeValue={setValue} onChange={onSelect}
// disabled={disabled} onChangeValue={setValue}
// > disabled={disabled}
// <Option value="1" /> >
// <Option value="2" label="two" /> <Option value="1" />
// <Option value="3">three</Option> <Option value="2" label="two" />
// </Select> <Option value="3">three</Option>
// <Button label="disable" onClick={() => setDisabled(true)} /> </Select>
// </> <Button label="disable" onClick={() => setDisabled(true)} />
// ) </>
// } )
// async function assertSelect(values: string[], disabled = false) { }
// await tester.assertMessages([
// { async function assertSelect(values: string[], disabled = false) {
// content: "", await tester.assertMessages([
// embeds: [], {
// actionRows: [ content: "",
// [ embeds: [],
// { actionRows: [
// type: "select", [
// placeholder: "choose one", {
// values, type: "select",
// disabled, placeholder: "choose one",
// options: [ values,
// { label: "1", value: "1" }, disabled,
// { label: "two", value: "2" }, options: [
// { label: "three", value: "3" }, { label: "1", value: "1" },
// ], { label: "two", value: "2" },
// }, { label: "three", value: "3" },
// ], ],
// [{ type: "button", style: "secondary", label: "disable" }], },
// ], ],
// }, [{ type: "button", style: "secondary", label: "disable" }],
// ]) ],
// } },
// const reply = tester.reply() ])
// reply.render(<TestSelect />) }
// await assertSelect([])
// expect(onSelect).toHaveBeenCalledTimes(0) const reply = tester.reply()
// await tester.findSelectByPlaceholder("choose one").select("2")
// await assertSelect(["2"]) reply.render(<TestSelect />)
// expect(onSelect).toHaveBeenCalledWith( await assertSelect([])
// expect.objectContaining({ values: ["2"] }), expect(onSelect).toHaveBeenCalledTimes(0)
// )
// await tester.findButtonByLabel("disable").click() await tester.findSelectByPlaceholder("choose one").select("2")
// await assertSelect(["2"], true) await assertSelect(["2"])
// await tester.findSelectByPlaceholder("choose one").select("1") expect(onSelect).toHaveBeenCalledWith(
// await assertSelect(["2"], true) expect.objectContaining({ values: ["2"] }),
// expect(onSelect).toHaveBeenCalledTimes(1) )
await tester.findButtonByLabel("disable").click()
await assertSelect(["2"], true)
await tester.findSelectByPlaceholder("choose one").select("1")
await assertSelect(["2"], true)
expect(onSelect).toHaveBeenCalledTimes(1)
}) })
test.skip("multiple select", async () => { test("multiple select", async () => {
// const tester = new ReacordTester() const tester = new ReacordTester()
// const onSelect = vi.fn() const onSelect = vi.fn()
// function TestSelect() {
// const [values, setValues] = useState<string[]>([]) function TestSelect() {
// return ( const [values, setValues] = useState<string[]>([])
// <Select return (
// placeholder="select" <Select
// multiple placeholder="select"
// values={values} multiple
// onChange={onSelect} values={values}
// onChangeMultiple={setValues} onChange={onSelect}
// > onChangeMultiple={setValues}
// <Option value="1">one</Option> >
// <Option value="2">two</Option> <Option value="1">one</Option>
// <Option value="3">three</Option> <Option value="2">two</Option>
// </Select> <Option value="3">three</Option>
// ) </Select>
// } )
// async function assertSelect(values: string[]) { }
// await tester.assertMessages([
// { async function assertSelect(values: string[]) {
// content: "", await tester.assertMessages([
// embeds: [], {
// actionRows: [ content: "",
// [ embeds: [],
// { actionRows: [
// type: "select", [
// placeholder: "select", {
// values, type: "select",
// minValues: 0, placeholder: "select",
// maxValues: 25, values,
// options: [ minValues: 0,
// { label: "one", value: "1" }, maxValues: 25,
// { label: "two", value: "2" }, options: [
// { label: "three", value: "3" }, { label: "one", value: "1" },
// ], { label: "two", value: "2" },
// }, { label: "three", value: "3" },
// ], ],
// ], },
// }, ],
// ]) ],
// } },
// const reply = tester.reply() ])
// reply.render(<TestSelect />) }
// await assertSelect([])
// expect(onSelect).toHaveBeenCalledTimes(0) const reply = tester.reply()
// await tester.findSelectByPlaceholder("select").select("1", "3")
// await assertSelect(expect.arrayContaining(["1", "3"]) as unknown as string[]) reply.render(<TestSelect />)
// expect(onSelect).toHaveBeenCalledWith( await assertSelect([])
// expect.objectContaining({ values: expect.arrayContaining(["1", "3"]) }), expect(onSelect).toHaveBeenCalledTimes(0)
// )
// await tester.findSelectByPlaceholder("select").select("2") await tester.findSelectByPlaceholder("select").select("1", "3")
// await assertSelect(expect.arrayContaining(["2"]) as unknown as string[]) await assertSelect(expect.arrayContaining(["1", "3"]) as unknown as string[])
// expect(onSelect).toHaveBeenCalledWith( expect(onSelect).toHaveBeenCalledWith(
// expect.objectContaining({ values: expect.arrayContaining(["2"]) }), expect.objectContaining({ values: expect.arrayContaining(["1", "3"]) }),
// ) )
// await tester.findSelectByPlaceholder("select").select()
// await assertSelect([]) await tester.findSelectByPlaceholder("select").select("2")
// expect(onSelect).toHaveBeenCalledWith(expect.objectContaining({ values: [] })) await assertSelect(expect.arrayContaining(["2"]) as unknown as string[])
expect(onSelect).toHaveBeenCalledWith(
expect.objectContaining({ values: expect.arrayContaining(["2"]) }),
)
await tester.findSelectByPlaceholder("select").select()
await assertSelect([])
expect(onSelect).toHaveBeenCalledWith(expect.objectContaining({ values: [] }))
}) })
test.skip("optional onSelect + unknown value", async () => { test("optional onSelect + unknown value", async () => {
// const tester = new ReacordTester() const tester = new ReacordTester()
// tester.reply().render(<Select placeholder="select" />) tester.reply().render(<Select placeholder="select" />)
// await tester.findSelectByPlaceholder("select").select("something") await tester.findSelectByPlaceholder("select").select("something")
// await tester.assertMessages([ await tester.assertMessages([
// { {
// content: "", content: "",
// embeds: [], embeds: [],
// actionRows: [ actionRows: [
// [{ type: "select", placeholder: "select", options: [], values: [] }], [{ type: "select", placeholder: "select", options: [], values: [] }],
// ], ],
// }, },
// ]) ])
}) })
test.todo("select minValues and maxValues") test.todo("select minValues and maxValues")

View File

@@ -0,0 +1,288 @@
/* eslint-disable class-methods-use-this */
/* eslint-disable require-await */
import { logPretty } from "@reacord/helpers/log-pretty"
import { omit } from "@reacord/helpers/omit"
import { pruneNullishValues } from "@reacord/helpers/prune-nullish-values"
import { raise } from "@reacord/helpers/raise"
import { waitFor } from "@reacord/helpers/wait-for"
import { randomUUID } from "node:crypto"
import { setTimeout } from "node:timers/promises"
import type { ReactNode } from "react"
import { expect } from "vitest"
import type {
ChannelInfo,
GuildInfo,
MessageInfo,
UserInfo,
} from "../library/core/component-event"
import type { ButtonClickEvent } from "../library/core/components/button"
import type { SelectChangeEvent } from "../library/core/components/select"
import type { ReacordInstance } from "../library/core/instance"
import { Reacord } from "../library/core/reacord"
import type { Channel } from "../library/internal/channel"
import { Container } from "../library/internal/container"
import type {
ButtonInteraction,
CommandInteraction,
SelectInteraction,
} from "../library/internal/interaction"
import type { Message, MessageOptions } from "../library/internal/message"
import { ChannelMessageRenderer } from "../library/internal/renderers/channel-message-renderer"
import { InteractionReplyRenderer } from "../library/internal/renderers/interaction-reply-renderer"
export type MessageSample = ReturnType<ReacordTester["sampleMessages"]>[0]
/**
* A Record adapter for automated tests. WIP
*/
export class ReacordTester extends Reacord {
private messageContainer = new Container<TestMessage>()
constructor() {
super({ maxInstances: 2 })
}
get messages(): readonly TestMessage[] {
return [...this.messageContainer]
}
override send(initialContent?: ReactNode): ReacordInstance {
return this.createInstance(
new ChannelMessageRenderer(new TestChannel(this.messageContainer)),
initialContent,
)
}
override reply(initialContent?: ReactNode): ReacordInstance {
return this.createInstance(
new InteractionReplyRenderer(
new TestCommandInteraction(this.messageContainer),
),
initialContent,
)
}
override ephemeralReply(initialContent?: ReactNode): ReacordInstance {
return this.reply(initialContent)
}
assertMessages(expected: MessageSample[]) {
return waitFor(() => {
expect(this.sampleMessages()).toEqual(expected)
})
}
async assertRender(content: ReactNode, expected: MessageSample[]) {
const instance = this.reply()
instance.render(content)
await this.assertMessages(expected)
instance.destroy()
}
logMessages() {
logPretty(this.sampleMessages())
}
sampleMessages() {
return pruneNullishValues(
this.messages.map((message) => ({
...message.options,
actionRows: message.options.actionRows.map((row) =>
row.map((component) =>
omit(component, [
"customId",
"onClick",
"onSelect",
"onSelectValue",
]),
),
),
})),
)
}
findButtonByLabel(label: string) {
return {
click: () => {
return waitFor(() => {
for (const [component, message] of this.eachComponent()) {
if (component.type === "button" && component.label === label) {
this.handleComponentInteraction(
new TestButtonInteraction(component.customId, message, this),
)
return
}
}
raise(`Couldn't find button with label "${label}"`)
})
},
}
}
findSelectByPlaceholder(placeholder: string) {
return {
select: (...values: string[]) => {
return waitFor(() => {
for (const [component, message] of this.eachComponent()) {
if (
component.type === "select" &&
component.placeholder === placeholder
) {
this.handleComponentInteraction(
new TestSelectInteraction(
component.customId,
message,
values,
this,
),
)
return
}
}
raise(`Couldn't find select with placeholder "${placeholder}"`)
})
},
}
}
createMessage(options: MessageOptions) {
return new TestMessage(options, this.messageContainer)
}
private *eachComponent() {
for (const message of this.messageContainer) {
for (const component of message.options.actionRows.flat()) {
yield [component, message] as const
}
}
}
}
class TestMessage implements Message {
constructor(
public options: MessageOptions,
private container: Container<TestMessage>,
) {
container.add(this)
}
async edit(options: MessageOptions): Promise<void> {
this.options = options
}
async delete(): Promise<void> {
this.container.remove(this)
}
}
class TestCommandInteraction implements CommandInteraction {
readonly type = "command"
readonly id = "test-command-interaction"
readonly channelId = "test-channel-id"
constructor(private messageContainer: Container<TestMessage>) {}
async reply(messageOptions: MessageOptions): Promise<Message> {
await setTimeout()
return new TestMessage(messageOptions, this.messageContainer)
}
async followUp(messageOptions: MessageOptions): Promise<Message> {
await setTimeout()
return new TestMessage(messageOptions, this.messageContainer)
}
}
class TestInteraction {
readonly id = randomUUID()
readonly channelId = "test-channel-id"
constructor(
readonly customId: string,
readonly message: TestMessage,
private tester: ReacordTester,
) {}
async update(options: MessageOptions): Promise<void> {
this.message.options = options
}
async deferUpdate(): Promise<void> {}
async reply(messageOptions: MessageOptions): Promise<Message> {
return this.tester.createMessage(messageOptions)
}
async followUp(messageOptions: MessageOptions): Promise<Message> {
return this.tester.createMessage(messageOptions)
}
}
class TestButtonInteraction
extends TestInteraction
implements ButtonInteraction
{
readonly type = "button"
readonly event: ButtonClickEvent
constructor(customId: string, message: TestMessage, tester: ReacordTester) {
super(customId, message, tester)
this.event = new TestButtonClickEvent(tester)
}
}
class TestSelectInteraction
extends TestInteraction
implements SelectInteraction
{
readonly type = "select"
readonly event: SelectChangeEvent
constructor(
customId: string,
message: TestMessage,
readonly values: string[],
tester: ReacordTester,
) {
super(customId, message, tester)
this.event = new TestSelectChangeEvent(values, tester)
}
}
class TestComponentEvent {
constructor(private tester: ReacordTester) {}
message: MessageInfo = {} as any // todo
channel: ChannelInfo = {} as any // todo
user: UserInfo = {} as any // todo
guild: GuildInfo = {} as any // todo
reply(content?: ReactNode): ReacordInstance {
return this.tester.reply(content)
}
ephemeralReply(content?: ReactNode): ReacordInstance {
return this.tester.ephemeralReply(content)
}
}
class TestButtonClickEvent
extends TestComponentEvent
implements ButtonClickEvent {}
class TestSelectChangeEvent
extends TestComponentEvent
implements SelectChangeEvent
{
constructor(readonly values: string[], tester: ReacordTester) {
super(tester)
}
}
class TestChannel implements Channel {
constructor(private messageContainer: Container<TestMessage>) {}
async send(messageOptions: MessageOptions): Promise<Message> {
return new TestMessage(messageOptions, this.messageContainer)
}
}

View File

@@ -1,10 +0,0 @@
import { raise } from "@reacord/helpers/raise"
import "dotenv/config"
const getEnv = (name: string) =>
process.env[name] ?? raise(`Missing env var: ${name}`)
export const testEnv = {
TEST_BOT_TOKEN: getEnv("TEST_BOT_TOKEN"),
TEST_CATEGORY_ID: getEnv("TEST_CATEGORY_ID"),
}

View File

@@ -1,76 +0,0 @@
import { raise } from "@reacord/helpers/raise"
import { CategoryChannel, ChannelType, GatewayIntentBits } from "discord.js"
import { kebabCase } from "lodash-es"
import { randomBytes } from "node:crypto"
import type { ReactNode } from "react"
import { createDiscordClient } from "../src/create-discord-client"
import { ReacordClient } from "../src/main"
import { testEnv } from "./test-env"
const reacord = new ReacordClient({
token: testEnv.TEST_BOT_TOKEN,
})
const clientPromise = createDiscordClient(testEnv.TEST_BOT_TOKEN, {
intents: GatewayIntentBits.Guilds | GatewayIntentBits.GuildMessages,
})
const categoryPromise = getCategory()
async function removeChannels() {
const category = await categoryPromise
for (const [, channel] of category.children.cache) {
await channel.delete()
}
}
async function getCategory() {
const client = await clientPromise
const category =
client.channels.cache.get(testEnv.TEST_CATEGORY_ID) ??
(await client.channels.fetch(testEnv.TEST_CATEGORY_ID))
if (!(category instanceof CategoryChannel)) {
throw new TypeError("Category channel not found")
}
return category
}
async function getTestChannel(testName: string) {
const hash = randomBytes(16).toString("hex").slice(0, 6)
const channelName = `${kebabCase(testName)}-${hash}`
const category = await categoryPromise
let channel = category.children.cache.find((the) => the.name === channelName)
if (!channel || !channel.isTextBased()) {
channel = await category.children.create({
type: ChannelType.GuildText,
name: channelName,
})
}
for (const [, message] of await channel.messages.fetch()) {
await message.delete()
}
return channel
}
async function render(testName: string, content?: ReactNode) {
const channel = await getTestChannel(testName)
await channel.sendTyping()
const instance = reacord.send(channel.id, content)
const result = await channel.awaitMessages({ max: 1 })
const message = result.first() ?? raise("failed to send message")
return { channel, message, instance }
}
export const ReacordTester = {
render,
removeChannels,
}

View File

@@ -1,74 +1,89 @@
import * as React from "react"
import { test } from "vitest" import { test } from "vitest"
import {
Button,
Embed,
EmbedAuthor,
EmbedField,
EmbedFooter,
EmbedTitle,
Link,
Option,
Select,
} from "../library/main"
import { ReacordTester } from "./test-adapter"
test.skip("text children in other components", async () => { test("text children in other components", async () => {
// const tester = new ReacordTester() const tester = new ReacordTester()
// const SomeText = () => <>some text</>
// await tester.assertRender( const SomeText = () => <>some text</>
// <>
// <Embed> await tester.assertRender(
// <EmbedTitle> <>
// <SomeText /> <Embed>
// </EmbedTitle> <EmbedTitle>
// <EmbedAuthor> <SomeText />
// <SomeText /> </EmbedTitle>
// </EmbedAuthor> <EmbedAuthor>
// <EmbedField name={<SomeText />}> <SomeText />
// <SomeText /> <Button label="ignore this" onClick={() => {}} /> </EmbedAuthor>
// nailed it <EmbedField name={<SomeText />}>
// </EmbedField> <SomeText /> <Button label="ignore this" onClick={() => {}} />
// <EmbedFooter> nailed it
// <SomeText /> </EmbedField>
// </EmbedFooter> <EmbedFooter>
// </Embed> <SomeText />
// <Button label={<SomeText />} onClick={() => {}} /> </EmbedFooter>
// <Link url="https://discord.com" label={<SomeText />} /> </Embed>
// <Select> <Button label={<SomeText />} onClick={() => {}} />
// <Option value="1"> <Link url="https://discord.com" label={<SomeText />} />
// <SomeText /> <Select>
// </Option> <Option value="1">
// <Option value="2" label={<SomeText />} description={<SomeText />} /> <SomeText />
// </Select> </Option>
// </>, <Option value="2" label={<SomeText />} description={<SomeText />} />
// [ </Select>
// { </>,
// content: "", [
// embeds: [ {
// { content: "",
// title: "some text", embeds: [
// author: { {
// name: "some text", title: "some text",
// }, author: {
// fields: [{ name: "some text", value: "some text nailed it" }], name: "some text",
// footer: { },
// text: "some text", fields: [{ name: "some text", value: "some text nailed it" }],
// }, footer: {
// }, text: "some text",
// ], },
// actionRows: [ },
// [ ],
// { actionRows: [
// type: "button", [
// label: "some text", {
// style: "secondary", type: "button",
// }, label: "some text",
// { style: "secondary",
// type: "link", },
// url: "https://discord.com", {
// label: "some text", type: "link",
// }, url: "https://discord.com",
// ], label: "some text",
// [ },
// { ],
// type: "select", [
// values: [], {
// options: [ type: "select",
// { value: "1", label: "some text" }, values: [],
// { value: "2", label: "some text", description: "some text" }, options: [
// ], { value: "1", label: "some text" },
// }, { value: "2", label: "some text", description: "some text" },
// ], ],
// ], },
// }, ],
// ], ],
// ) },
],
)
}) })

View File

@@ -1,60 +1,72 @@
import { describe, it } from "vitest" import React from "react"
import { describe, expect, it } from "vitest"
import type { ReacordInstance } from "../library/main"
import { Button, useInstance } from "../library/main"
import type { MessageSample } from "./test-adapter"
import { ReacordTester } from "./test-adapter"
describe("useInstance", () => { describe("useInstance", () => {
it.skip("returns the instance of itself", async () => { it("returns the instance of itself", async () => {
// let instanceFromHook: ReacordInstance | undefined let instanceFromHook: ReacordInstance | undefined
// function TestComponent({ name }: { name: string }) {
// const instance = useInstance() function TestComponent({ name }: { name: string }) {
// instanceFromHook ??= instance const instance = useInstance()
// return ( instanceFromHook ??= instance
// <> return (
// <Button <>
// label={`create ${name}`} <Button
// onClick={(event) => { label={`create ${name}`}
// event.reply(<TestComponent name="child" />) onClick={(event) => {
// }} event.reply(<TestComponent name="child" />)
// /> }}
// <Button />
// label={`destroy ${name}`} <Button
// onClick={() => instance.destroy()} label={`destroy ${name}`}
// /> onClick={() => instance.destroy()}
// </> />
// ) </>
// } )
// function messageOutput(name: string): MessageSample { }
// return {
// content: "", function messageOutput(name: string): MessageSample {
// embeds: [], return {
// actionRows: [ content: "",
// [ embeds: [],
// { actionRows: [
// type: "button", [
// label: `create ${name}`, {
// style: "secondary", type: "button",
// }, label: `create ${name}`,
// { style: "secondary",
// type: "button", },
// label: `destroy ${name}`, {
// style: "secondary", type: "button",
// }, label: `destroy ${name}`,
// ], style: "secondary",
// ], },
// } ],
// } ],
// const tester = new ReacordTester() }
// const instance = tester.send(<TestComponent name="parent" />) }
// await tester.assertMessages([messageOutput("parent")])
// expect(instanceFromHook).toBe(instance) const tester = new ReacordTester()
// await tester.findButtonByLabel("create parent").click() const instance = tester.send(<TestComponent name="parent" />)
// await tester.assertMessages([
// messageOutput("parent"), await tester.assertMessages([messageOutput("parent")])
// messageOutput("child"), expect(instanceFromHook).toBe(instance)
// ])
// // this test ensures that the only the child instance is destroyed, await tester.findButtonByLabel("create parent").click()
// // and not the parent instance await tester.assertMessages([
// await tester.findButtonByLabel("destroy child").click() messageOutput("parent"),
// await tester.assertMessages([messageOutput("parent")]) messageOutput("child"),
// await tester.findButtonByLabel("destroy parent").click() ])
// await tester.assertMessages([])
// this test ensures that the only the child instance is destroyed,
// and not the parent instance
await tester.findButtonByLabel("destroy child").click()
await tester.assertMessages([messageOutput("parent")])
await tester.findButtonByLabel("destroy parent").click()
await tester.assertMessages([])
}) })
}) })

View File

@@ -1,3 +1,4 @@
{ {
"extends": "../../tsconfig.base.json" "extends": "../../tsconfig.base.json",
"include": ["**/*.ts", "**/*.tsx", "**/*.cjs", "**/*.mjs"]
} }

View File

@@ -0,0 +1,8 @@
/// <reference types="vitest" />
import { defineConfig } from "vitest/config"
export default defineConfig({
build: {
sourcemap: true,
},
})

View File

@@ -1,5 +1,4 @@
node_modules node_modules
/.cache /.cache
/build /build
/public/build /public/build
@@ -9,3 +8,4 @@ cypress/videos
cypress/screenshots cypress/screenshots
*.out.css *.out.css
/api /api
.astro

View File

@@ -1,5 +1,12 @@
# website # website
## 0.4.3
### Patch Changes
- Updated dependencies [9813a01]
- reacord@0.5.2
## 0.4.2 ## 0.4.2
### Patch Changes ### Patch Changes

View File

@@ -1,4 +0,0 @@
import { hydrate } from "react-dom"
import { RemixBrowser } from "@remix-run/react"
hydrate(<RemixBrowser />, document)

View File

@@ -1,23 +0,0 @@
import type { EntryContext } from "@remix-run/node"
import * as remixRunReact from "@remix-run/react"
import { renderToString } from "react-dom/server"
export default function handleRequest(
request: Request,
responseStatusCode: number,
responseHeaders: Headers,
remixContext: EntryContext,
) {
const markup = renderToString(
// for some reason, a named import becomes `undefined` here,
// a namespace import makes it work...? 🙃
<remixRunReact.RemixServer context={remixContext} url={request.url} />,
)
responseHeaders.set("Content-Type", "text/html")
return new Response("<!DOCTYPE html>" + markup, {
status: responseStatusCode,
headers: responseHeaders,
})
}

View File

@@ -1,27 +0,0 @@
import { HeartIcon } from "@heroicons/react/solid"
import clsx from "clsx"
import { ExternalLink } from "~/modules/dom/external-link"
import { linkClass, maxWidthContainer } from "~/modules/ui/components"
export function AppFooter() {
return (
<footer className={clsx(maxWidthContainer, "text-xs opacity-75")}>
<address className="not-italic">
&copy; {new Date().getFullYear()} itsMapleLeaf
</address>
<p>
Coded with <HeartIcon className="inline w-4 align-sub" /> using{" "}
<ExternalLink className={linkClass()} href="https://remix.run">
Remix
</ExternalLink>
</p>
<p>
Uses{" "}
<ExternalLink className={linkClass()} href="https://umami.is/">
umami
</ExternalLink>{" "}
for simple, non-identifying analytics.
</p>
</footer>
)
}

File diff suppressed because one or more lines are too long

View File

@@ -1,12 +0,0 @@
import type { ComponentPropsWithoutRef } from "react"
export function ExternalLink({
children,
...props
}: ComponentPropsWithoutRef<"a">) {
return (
<a target="_blank" rel="noopener noreferrer" {...props}>
{children}
</a>
)
}

View File

@@ -1,20 +0,0 @@
import type { ReactNode } from "react"
import { useEffect, useRef } from "react"
import { createPortal } from "react-dom"
export function Portal({ children }: { children: ReactNode }) {
const containerRef = useRef<Element>()
if (!containerRef.current && typeof document !== "undefined") {
containerRef.current = document.createElement("react-portal")
document.body.append(containerRef.current)
}
useEffect(() => () => containerRef.current!.remove(), [])
return containerRef.current ? (
createPortal(children, containerRef.current)
) : (
<>{children}</>
)
}

View File

@@ -1,3 +0,0 @@
export function raise(error: unknown): never {
throw error instanceof Error ? error : new Error(String(error))
}

View File

@@ -1,26 +0,0 @@
{/* prettier-ignore */}
```tsx
import * as React from "react"
import { Button, useInstance } from "reacord"
function Counter() {
const [count, setCount] = React.useState(0)
const instance = useInstance()
return (
<>
this button was clicked {count} times
<Button
label="+1"
style="success"
onClick={() => setCount(count + 1)}
/>
<Button
label="delete"
emoji="🗑"
style="danger"
onClick={() => instance.destroy()}
/>
</>
)
}
```

View File

@@ -1,14 +0,0 @@
import type { ReactNode } from "react"
import type { PathPattern } from "react-router"
import { useMatch } from "react-router"
export function ActiveLink({
to,
children,
}: {
to: string | PathPattern
children: (props: { active: boolean }) => ReactNode
}) {
const match = useMatch(to)
return <>{children({ active: match != undefined })}</>
}

View File

@@ -1,32 +0,0 @@
import type { ComponentPropsWithoutRef } from "react"
import { Link } from "@remix-run/react"
import { ExternalLink } from "~/modules/dom/external-link"
export type AppLinkProps = ComponentPropsWithoutRef<"a"> & {
type: "internal" | "external" | "router"
to: string
}
export function AppLink({ type, to, children, ...props }: AppLinkProps) {
if (type === "internal") {
return (
<a href={to} {...props}>
{children}
</a>
)
}
if (type === "external") {
return (
<ExternalLink href={to} {...props}>
{children}
</ExternalLink>
)
}
return (
<Link to={to} {...props}>
{children}
</Link>
)
}

View File

@@ -1,10 +0,0 @@
import { createContext, useContext } from "react"
import type { GuideLink } from "~/modules/navigation/load-guide-links.server"
const Context = createContext<GuideLink[]>([])
export const GuideLinksProvider = Context.Provider
export function useGuideLinksContext() {
return useContext(Context)
}

View File

@@ -1,39 +0,0 @@
import glob from "fast-glob"
import grayMatter from "gray-matter"
import { readFile } from "node:fs/promises"
import { join, parse } from "node:path"
import { z } from "zod"
const guidesFolder = "app/routes/guides"
const frontmatterSchema = z.object({
meta: z.object({
title: z.string(),
description: z.string(),
}),
order: z.number().optional(),
})
export type GuideLink = Awaited<ReturnType<typeof loadGuideLinks>>[0]
export async function loadGuideLinks() {
const guideFiles = await glob(`**/*.md`, { cwd: guidesFolder })
const links = await Promise.all(
guideFiles.map(async (file) => {
const result = grayMatter(await readFile(join(guidesFolder, file)))
const data = frontmatterSchema.parse(result.data)
return {
title: data.meta.title,
order: data.order ?? Number.POSITIVE_INFINITY,
link: {
type: "router" as const,
to: `/guides/${parse(file).name}`,
children: data.meta.title,
},
}
}),
)
return links.sort((a, b) => a.order - b.order)
}

View File

@@ -1,37 +0,0 @@
import {
CodeIcon,
DocumentTextIcon,
ExternalLinkIcon,
} from "@heroicons/react/solid"
import type { AppLinkProps } from "~/modules/navigation/app-link"
import { inlineIconClass } from "../ui/components"
export const mainLinks: AppLinkProps[] = [
{
type: "internal",
to: "/guides/getting-started",
children: (
<>
<DocumentTextIcon className={inlineIconClass} /> Guides
</>
),
},
{
type: "internal",
to: "/api/",
children: (
<>
<CodeIcon className={inlineIconClass} /> API Reference
</>
),
},
{
type: "external",
to: "https://github.com/itsMapleLeaf/reacord",
children: (
<>
<ExternalLinkIcon className={inlineIconClass} /> GitHub
</>
),
},
]

Some files were not shown because too many files have changed in this diff Show More