1 Commits

Author SHA1 Message Date
itsMapleLeaf
12ec45ccd4 first attempt at files api 2022-04-25 14:52:29 -05:00
67 changed files with 3430 additions and 4707 deletions

View File

@@ -1,8 +0,0 @@
# Changesets
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

View File

@@ -1,11 +0,0 @@
{
"$schema": "https://unpkg.com/@changesets/config@2.1.0/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": false,
"fixed": [],
"linked": [],
"access": "public",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}

View File

@@ -10,10 +10,6 @@ env:
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 }}
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs: jobs:
run-commands: run-commands:
strategy: strategy:
@@ -23,15 +19,15 @@ jobs:
# if these 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 reacord - name: test reacord
run: pnpm -C packages/reacord test run: pnpm test -C packages/reacord
- name: test website - name: test website
run: pnpm -C packages/website test run: pnpm test -C packages/website
- name: build - name: build
run: pnpm --recursive run build run: pnpm build --recursive
- name: lint - name: lint
run: pnpm run lint run: pnpm lint
- name: typecheck - name: typecheck
run: pnpm --recursive run typecheck run: pnpm typecheck --parallel
name: ${{ matrix.command.name }} name: ${{ matrix.command.name }}
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
@@ -40,6 +36,6 @@ jobs:
with: with:
# https://github.com/actions/setup-node#supported-version-syntax # https://github.com/actions/setup-node#supported-version-syntax
node-version: "16" node-version: "16"
- run: npm i -g pnpm@7.5.0 - run: npm i -g pnpm
- run: pnpm install --frozen-lockfile - run: pnpm install --frozen-lockfile
- run: ${{ matrix.command.run }} - run: ${{ matrix.command.run }}

View File

@@ -1,37 +0,0 @@
# https://pnpm.io/using-changesets
name: release
on:
push:
branches:
- main
concurrency: ${{ github.workflow }}-${{ github.ref }}
jobs:
release:
name: release
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v2
- name: setup node
uses: actions/setup-node@v2
with:
node-version: 16
- name: install pnpm
run: npm install -g pnpm
- name: install deps
run: pnpm install --frozen-lockfile
- name: changesets release
id: changesets
uses: changesets/action@v1
with:
publish: pnpm run release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

1
.gitignore vendored
View File

@@ -4,7 +4,6 @@ node_modules
coverage coverage
.env .env
*.code-workspace *.code-workspace
.pnpm-debug.log
build build
.cache .cache

15
Dockerfile Normal file
View File

@@ -0,0 +1,15 @@
FROM node:lts-slim
ENV CYPRESS_INSTALL_BINARY=0
WORKDIR /app
COPY / ./
RUN ls -R
RUN npm install -g pnpm
RUN pnpm install --unsafe-perm --frozen-lockfile
RUN pnpm run build -C packages/website
ENV NODE_ENV=production
CMD [ "pnpm", "-C", "packages/website", "start" ]

View File

@@ -1,23 +1,17 @@
{ {
"name": "reacord-monorepo",
"private": true, "private": true,
"scripts": { "scripts": {
"lint": "eslint --ext js,ts,tsx .", "lint": "eslint --ext js,ts,tsx .",
"lint-fix": "pnpm lint -- --fix", "lint-fix": "pnpm lint -- --fix",
"format": "prettier --write .", "format": "prettier --write ."
"build": "pnpm -r run build",
"start": "pnpm -C packages/website run start",
"release": "pnpm -r run build && changeset publish"
}, },
"devDependencies": { "devDependencies": {
"@changesets/cli": "^2.24.0", "@itsmapleleaf/configs": "^1.1.3",
"@itsmapleleaf/configs": "^1.1.5", "@rushstack/eslint-patch": "^1.1.3",
"@rushstack/eslint-patch": "^1.1.4", "@types/eslint": "^8.4.1",
"@types/eslint": "^8.4.5", "eslint": "^8.14.0",
"eslint": "^8.20.0", "prettier": "^2.6.2",
"node": "^16.16.0", "typescript": "^4.6.3"
"prettier": "^2.7.1",
"typescript": "^4.7.4"
}, },
"resolutions": { "resolutions": {
"esbuild": "latest" "esbuild": "latest"

View File

@@ -1,15 +0,0 @@
# reacord
## 0.5.1
### Patch Changes
- 72f4a4a: upgrade dependencies and remove some unneeded
- 7536bde: add types in exports to work with TS nodenext
- e335165: fix links
## 0.5.0
### Minor Changes
- aa65da5: allow JSX in more places

View File

@@ -1,6 +1,5 @@
import { expect, test } from "vitest" import { expect, test } from "vitest"
import type { PruneNullishValues } from "./prune-nullish-values" import { PruneNullishValues, pruneNullishValues } from "./prune-nullish-values"
import { pruneNullishValues } from "./prune-nullish-values"
test("pruneNullishValues", () => { test("pruneNullishValues", () => {
type InputType = { type InputType = {
@@ -15,7 +14,6 @@ test("pruneNullishValues", () => {
const input: InputType = { const input: InputType = {
a: "a", a: "a",
// eslint-disable-next-line unicorn/no-null
b: null, b: null,
c: undefined, c: undefined,
d: { d: {

View File

@@ -1,3 +1,4 @@
/* eslint-disable import/no-unused-modules */
export type MaybePromise<T> = T | Promise<T> export type MaybePromise<T> = T | Promise<T>
export type ValueOf<Type> = Type extends ReadonlyArray<infer Value> export type ValueOf<Type> = Type extends ReadonlyArray<infer Value>

View File

@@ -1,4 +1,4 @@
import { setTimeout } from "node:timers/promises" import { setTimeout } from "timers/promises"
const maxTime = 1000 const maxTime = 1000

View File

@@ -1,12 +1,10 @@
import type { ReactNode } from "react"
/** /**
* Common props between button-like components * Common props between button-like components
* @category Button * @category Button
*/ */
export type ButtonSharedProps = { export type ButtonSharedProps = {
/** The text on the button. Rich formatting (markdown) is not supported here. */ /** The text on the button. Rich formatting (markdown) is not supported here. */
label?: ReactNode label?: string
/** When true, the button will be slightly faded, and cannot be clicked. */ /** When true, the button will be slightly faded, and cannot be clicked. */
disabled?: boolean disabled?: boolean

View File

@@ -1,4 +1,4 @@
import { randomUUID } from "node:crypto" import { nanoid } from "nanoid"
import React from "react" import React from "react"
import { ReacordElement } from "../../internal/element.js" import { ReacordElement } from "../../internal/element.js"
import type { ComponentInteraction } from "../../internal/interaction" import type { ComponentInteraction } from "../../internal/interaction"
@@ -34,22 +34,12 @@ export type ButtonClickEvent = ComponentEvent
*/ */
export function Button(props: ButtonProps) { export function Button(props: ButtonProps) {
return ( return (
<ReacordElement props={props} createNode={() => new ButtonNode(props)}> <ReacordElement props={props} createNode={() => new ButtonNode(props)} />
<ReacordElement props={{}} createNode={() => new ButtonLabelNode({})}>
{props.label}
</ReacordElement>
</ReacordElement>
) )
} }
class ButtonNode extends Node<ButtonProps> { class ButtonNode extends Node<ButtonProps> {
private customId = randomUUID() private customId = nanoid()
// 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 { override modifyMessageOptions(options: MessageOptions): void {
getNextActionRow(options).push({ getNextActionRow(options).push({
@@ -58,7 +48,7 @@ class ButtonNode extends Node<ButtonProps> {
style: this.props.style ?? "secondary", style: this.props.style ?? "secondary",
disabled: this.props.disabled, disabled: this.props.disabled,
emoji: this.props.emoji, emoji: this.props.emoji,
label: this.children.findType(ButtonLabelNode)?.text, label: this.props.label,
}) })
} }
@@ -73,5 +63,3 @@ class ButtonNode extends Node<ButtonProps> {
return false return false
} }
} }
class ButtonLabelNode extends Node<{}> {}

View File

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

View File

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

View File

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

View File

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

View File

@@ -18,26 +18,18 @@ export type LinkProps = ButtonSharedProps & {
/** /**
* @category Link * @category Link
*/ */
export function Link({ label, children, ...props }: LinkProps) { export function Link(props: LinkProps) {
return ( return <ReacordElement props={props} createNode={() => new LinkNode(props)} />
<ReacordElement props={props} createNode={() => new LinkNode(props)}>
<ReacordElement props={{}} createNode={() => new LinkTextNode({})}>
{label || children}
</ReacordElement>
</ReacordElement>
)
} }
class LinkNode extends Node<Omit<LinkProps, "label" | "children">> { class LinkNode extends Node<LinkProps> {
override modifyMessageOptions(options: MessageOptions): void { override modifyMessageOptions(options: MessageOptions): void {
getNextActionRow(options).push({ getNextActionRow(options).push({
type: "link", type: "link",
disabled: this.props.disabled, disabled: this.props.disabled,
emoji: this.props.emoji, emoji: this.props.emoji,
label: this.children.findType(LinkTextNode)?.text, label: this.props.label || this.props.children,
url: this.props.url, url: this.props.url,
}) })
} }
} }
class LinkTextNode extends Node<{}> {}

View File

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

View File

@@ -1,11 +1,6 @@
import type { ReactNode } from "react"
import React from "react" import React from "react"
import { ReacordElement } from "../../internal/element" import { ReacordElement } from "../../internal/element"
import { import { OptionNode } from "./option-node"
OptionDescriptionNode,
OptionLabelNode,
OptionNode,
} from "./option-node"
/** /**
* @category Select * @category Select
@@ -14,11 +9,11 @@ export type OptionProps = {
/** The internal value of this option */ /** The internal value of this option */
value: string value: string
/** The text shown to the user. This takes priority over `children` */ /** The text shown to the user. This takes priority over `children` */
label?: ReactNode label?: string
/** The text shown to the user */ /** The text shown to the user */
children?: ReactNode children?: string
/** Description for the option, shown to the user */ /** Description for the option, shown to the user */
description?: ReactNode description?: string
/** /**
* Renders an emoji to the left of the text. * Renders an emoji to the left of the text.
@@ -36,27 +31,8 @@ export type OptionProps = {
/** /**
* @category Select * @category Select
*/ */
export function Option({ export function Option(props: OptionProps) {
label,
children,
description,
...props
}: OptionProps) {
return ( return (
<ReacordElement props={props} createNode={() => new OptionNode(props)}> <ReacordElement props={props} createNode={() => new OptionNode(props)} />
{(label !== undefined || children !== undefined) && (
<ReacordElement props={{}} createNode={() => new OptionLabelNode({})}>
{label || children}
</ReacordElement>
)}
{description !== undefined && (
<ReacordElement
props={{}}
createNode={() => new OptionDescriptionNode({})}
>
{description}
</ReacordElement>
)}
</ReacordElement>
) )
} }

View File

@@ -1,4 +1,4 @@
import { randomUUID } from "node:crypto" import { nanoid } from "nanoid"
import type { ReactNode } from "react" import type { ReactNode } from "react"
import React from "react" import React from "react"
import { isInstanceOf } from "../../../helpers/is-instance-of" import { isInstanceOf } from "../../../helpers/is-instance-of"
@@ -89,7 +89,7 @@ export function Select(props: SelectProps) {
} }
class SelectNode extends Node<SelectProps> { class SelectNode extends Node<SelectProps> {
readonly customId = randomUUID() readonly customId = nanoid()
override modifyMessageOptions(message: MessageOptions): void { override modifyMessageOptions(message: MessageOptions): void {
const actionRow: ActionRow = [] const actionRow: ActionRow = []

View File

@@ -0,0 +1,7 @@
import { Readable } from "node:stream"
export type ReacordFile = {
name?: string
description?: string
data: Buffer | Readable | string
}

View File

@@ -1,4 +1,5 @@
import type { ReactNode } from "react" import type { ReactNode } from "react"
import { ReacordFile } from "./file"
/** /**
* Represents an interactive message, which can later be replaced or deleted. * Represents an interactive message, which can later be replaced or deleted.
@@ -16,4 +17,7 @@ export type ReacordInstance = {
* This prevents it from listening to user interactions. * This prevents it from listening to user interactions.
*/ */
deactivate: () => void deactivate: () => void
/** Attach a file to the message for this instance */
attach: (file: ReacordFile) => void
} }

View File

@@ -5,12 +5,9 @@ import type { Except } from "type-fest"
import { pick } from "../../helpers/pick" import { pick } from "../../helpers/pick"
import { pruneNullishValues } from "../../helpers/prune-nullish-values" import { pruneNullishValues } from "../../helpers/prune-nullish-values"
import { raise } from "../../helpers/raise" import { raise } from "../../helpers/raise"
import { toUpper } from "../../helpers/to-upper"
import type { ComponentInteraction } from "../internal/interaction" import type { ComponentInteraction } from "../internal/interaction"
import type { import type { Message, MessageOptions } from "../internal/message"
Message,
MessageButtonOptions,
MessageOptions,
} from "../internal/message"
import { ChannelMessageRenderer } from "../internal/renderers/channel-message-renderer" import { ChannelMessageRenderer } from "../internal/renderers/channel-message-renderer"
import { InteractionReplyRenderer } from "../internal/renderers/interaction-reply-renderer" import { InteractionReplyRenderer } from "../internal/renderers/interaction-reply-renderer"
import type { import type {
@@ -33,7 +30,7 @@ export class ReacordDiscordJs extends Reacord {
super(config) super(config)
client.on("interactionCreate", (interaction) => { client.on("interactionCreate", (interaction) => {
if (interaction.isButton() || interaction.isSelectMenu()) { if (interaction.isMessageComponent()) {
this.handleComponentInteraction( this.handleComponentInteraction(
this.createReacordComponentInteraction(interaction), this.createReacordComponentInteraction(interaction),
) )
@@ -91,7 +88,7 @@ export class ReacordDiscordJs extends Reacord {
(await this.client.channels.fetch(channelId)) ?? (await this.client.channels.fetch(channelId)) ??
raise(`Channel ${channelId} not found`) raise(`Channel ${channelId} not found`)
if (!channel.isTextBased()) { if (!channel.isText()) {
raise(`Channel ${channelId} is not a text channel`) raise(`Channel ${channelId} is not a text channel`)
} }
@@ -304,6 +301,15 @@ function createReacordMessage(message: Discord.Message): Message {
delete: async () => { delete: async () => {
await message.delete() await message.delete()
}, },
updateFiles: async (files) => {
await message.edit({
files: files.map(({ name, description, data }) => ({
name,
description,
attachment: data,
})),
})
},
} }
} }
@@ -313,6 +319,10 @@ function createEphemeralReacordMessage(): Message {
console.warn("Ephemeral messages can't be edited") console.warn("Ephemeral messages can't be edited")
return Promise.resolve() return Promise.resolve()
}, },
updateFiles: () => {
console.warn("Ephemeral messages can't be edited")
return Promise.resolve()
},
delete: () => { delete: () => {
console.warn("Ephemeral messages can't be deleted") console.warn("Ephemeral messages can't be deleted")
return Promise.resolve() return Promise.resolve()
@@ -320,45 +330,25 @@ function createEphemeralReacordMessage(): Message {
} }
} }
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, // TODO: this could be a part of the core library,
// and also handle some edge cases, e.g. empty messages // and also handle some edge cases, e.g. empty messages
function getDiscordMessageOptions(reacordOptions: MessageOptions) { function getDiscordMessageOptions(
const options = { reacordOptions: MessageOptions,
): Discord.MessageOptions {
const options: Discord.MessageOptions = {
// eslint-disable-next-line unicorn/no-null // eslint-disable-next-line unicorn/no-null
content: reacordOptions.content || null, content: reacordOptions.content || null,
embeds: reacordOptions.embeds, embeds: reacordOptions.embeds,
components: reacordOptions.actionRows.map((row) => ({ components: reacordOptions.actionRows.map((row) => ({
type: Discord.ComponentType.ActionRow, type: "ACTION_ROW",
components: row.map( components: row.map(
(component): Discord.MessageActionRowComponentData => { (component): Discord.MessageActionRowComponentOptions => {
if (component.type === "button") { if (component.type === "button") {
return { return {
type: Discord.ComponentType.Button, type: "BUTTON",
customId: component.customId, customId: component.customId,
label: component.label ?? "", label: component.label ?? "",
style: convertButtonStyleToEnum(component.style), style: toUpper(component.style ?? "secondary"),
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, disabled: component.disabled,
emoji: component.emoji, emoji: component.emoji,
} }
@@ -367,7 +357,7 @@ function getDiscordMessageOptions(reacordOptions: MessageOptions) {
if (component.type === "select") { if (component.type === "select") {
return { return {
...component, ...component,
type: Discord.ComponentType.SelectMenu, type: "SELECT_MENU",
options: component.options.map((option) => ({ options: component.options.map((option) => ({
...option, ...option,
default: component.values?.includes(option.value), default: component.values?.includes(option.value),
@@ -375,13 +365,16 @@ function getDiscordMessageOptions(reacordOptions: MessageOptions) {
} }
} }
raise(`Unsupported component type: ${(component as any).type}`) raise(`Unsupported component type: ${component.type}`)
}, },
), ),
})), })),
} }
if (!options.content && !options.embeds?.length) { const hasContent =
options.content || options.embeds?.length || options.files?.length
if (!hasContent) {
options.content = "_ _" options.content = "_ _"
} }

View File

@@ -47,19 +47,7 @@ export abstract class Reacord {
this.renderers.push(renderer) this.renderers.push(renderer)
const container = reconciler.createContainer( const container = reconciler.createContainer(renderer, 0, false, {})
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 = { const instance: ReacordInstance = {
render: (content: ReactNode) => { render: (content: ReactNode) => {
@@ -75,6 +63,9 @@ export abstract class Reacord {
this.renderers = this.renderers.filter((it) => it !== renderer) this.renderers = this.renderers.filter((it) => it !== renderer)
renderer.destroy() renderer.destroy()
}, },
attach: (file) => {
renderer.attach(file)
},
} }
if (initialContent !== undefined) { if (initialContent !== undefined) {

View File

@@ -1,5 +1,7 @@
import { ReacordFile } from "../core/file"
import type { Message, MessageOptions } from "./message" import type { Message, MessageOptions } from "./message"
export type Channel = { export type Channel = {
send(message: MessageOptions): Promise<Message> send(message: MessageOptions): Promise<Message>
sendFiles(files: readonly ReacordFile[]): Promise<Message>
} }

View File

@@ -21,16 +21,6 @@ export class Container<T> {
this.items = [] 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]() { [Symbol.iterator]() {
return this.items[Symbol.iterator]() return this.items[Symbol.iterator]()
} }

View File

@@ -2,6 +2,7 @@ import type { Except } from "type-fest"
import { last } from "../../helpers/last" import { last } from "../../helpers/last"
import type { EmbedOptions } from "../core/components/embed-options" import type { EmbedOptions } from "../core/components/embed-options"
import type { SelectProps } from "../core/components/select" import type { SelectProps } from "../core/components/select"
import { ReacordFile } from "../main"
export type MessageOptions = { export type MessageOptions = {
content: string content: string
@@ -49,6 +50,7 @@ export type MessageSelectOptionOptions = {
export type Message = { export type Message = {
edit(options: MessageOptions): Promise<void> edit(options: MessageOptions): Promise<void>
delete(): Promise<void> delete(): Promise<void>
updateFiles(files: readonly ReacordFile[]): Promise<void>
} }
export function getNextActionRow(options: MessageOptions): ActionRow { export function getNextActionRow(options: MessageOptions): ActionRow {

View File

@@ -13,8 +13,4 @@ export abstract class Node<Props> {
handleComponentInteraction(interaction: ComponentInteraction): boolean { handleComponentInteraction(interaction: ComponentInteraction): boolean {
return false return false
} }
get text(): string {
return [...this.children].map((child) => child.text).join("")
}
} }

View File

@@ -1,6 +1,5 @@
import type { HostConfig } from "react-reconciler" import type { HostConfig } from "react-reconciler"
import ReactReconciler from "react-reconciler" import ReactReconciler from "react-reconciler"
import { DefaultEventPriority } from "react-reconciler/constants"
import { raise } from "../../helpers/raise.js" import { raise } from "../../helpers/raise.js"
import { Node } from "./node.js" import { Node } from "./node.js"
import type { Renderer } from "./renderers/renderer" import type { Renderer } from "./renderers/renderer"
@@ -21,6 +20,8 @@ const config: HostConfig<
number, // TimeoutHandle, number, // TimeoutHandle,
number // NoTimeout, number // NoTimeout,
> = { > = {
// config
now: Date.now,
supportsMutation: true, supportsMutation: true,
supportsPersistence: false, supportsPersistence: false,
supportsHydration: false, supportsHydration: false,
@@ -51,13 +52,8 @@ const config: HostConfig<
}, },
createTextInstance: (text) => new TextNode(text), createTextInstance: (text) => new TextNode(text),
shouldSetTextContent: () => false, shouldSetTextContent: () => false,
// @ts-expect-error
detachDeletedInstance: (instance) => {}, detachDeletedInstance: (instance) => {},
beforeActiveInstanceBlur: () => {},
afterActiveInstanceBlur: () => {},
// eslint-disable-next-line unicorn/no-null
getInstanceFromNode: (node: any) => null,
// eslint-disable-next-line unicorn/no-null
getInstanceFromScope: (scopeInstance: any) => null,
clearContainer: (renderer) => { clearContainer: (renderer) => {
renderer.nodes.clear() renderer.nodes.clear()
@@ -98,14 +94,11 @@ const config: HostConfig<
resetAfterCommit: (renderer) => { resetAfterCommit: (renderer) => {
renderer.render() renderer.render()
}, },
prepareScopeUpdate: (scopeInstance: any, instance: any) => {},
preparePortalMount: () => raise("Portals are not supported"), preparePortalMount: () => raise("Portals are not supported"),
getPublicInstance: () => raise("Refs are currently not supported"), getPublicInstance: () => raise("Refs are currently not supported"),
finalizeInitialChildren: () => false, finalizeInitialChildren: () => false,
getCurrentEventPriority: () => DefaultEventPriority,
} }
export const reconciler = ReactReconciler(config) export const reconciler = ReactReconciler(config)

View File

@@ -1,3 +1,4 @@
import { ReacordFile } from "../../core/file"
import type { Channel } from "../channel" import type { Channel } from "../channel"
import type { Message, MessageOptions } from "../message" import type { Message, MessageOptions } from "../message"
import { Renderer } from "./renderer" import { Renderer } from "./renderer"
@@ -10,4 +11,10 @@ export class ChannelMessageRenderer extends Renderer {
protected createMessage(options: MessageOptions): Promise<Message> { protected createMessage(options: MessageOptions): Promise<Message> {
return this.channel.send(options) return this.channel.send(options)
} }
protected createMessageFromFiles(
files: readonly ReacordFile[],
): Promise<Message> {
return this.channel.sendFiles(files)
}
} }

View File

@@ -1,5 +1,6 @@
import { Subject } from "rxjs" import { Subject } from "rxjs"
import { concatMap } from "rxjs/operators" import { concatMap } from "rxjs/operators"
import { ReacordFile } from "../../core/file"
import { Container } from "../container.js" import { Container } from "../container.js"
import type { ComponentInteraction } from "../interaction" import type { ComponentInteraction } from "../interaction"
import type { Message, MessageOptions } from "../message" import type { Message, MessageOptions } from "../message"
@@ -7,15 +8,21 @@ import type { Node } from "../node.js"
type UpdatePayload = type UpdatePayload =
| { action: "update" | "deactivate"; options: MessageOptions } | { action: "update" | "deactivate"; options: MessageOptions }
| { action: "files"; files: readonly ReacordFile[] }
| { action: "deferUpdate"; interaction: ComponentInteraction } | { action: "deferUpdate"; interaction: ComponentInteraction }
| { action: "destroy" } | { action: "destroy" }
type NewMessagePayload =
| { source: "content"; messageOptions?: MessageOptions }
| { source: "files"; files?: readonly ReacordFile[] }
export abstract class Renderer { export abstract class Renderer {
readonly nodes = new Container<Node<unknown>>() readonly nodes = new Container<Node<unknown>>()
private componentInteraction?: ComponentInteraction private componentInteraction?: ComponentInteraction
private message?: Message private message?: Message
private active = true private active = true
private updates = new Subject<UpdatePayload>() private updates = new Subject<UpdatePayload>()
private files: readonly ReacordFile[] = []
private updateSubscription = this.updates private updateSubscription = this.updates
.pipe(concatMap((payload) => this.updateMessage(payload))) .pipe(concatMap((payload) => this.updateMessage(payload)))
@@ -46,6 +53,11 @@ export abstract class Renderer {
this.updates.next({ action: "destroy" }) this.updates.next({ action: "destroy" })
} }
attach(file: ReacordFile) {
const newFiles = (this.files = [...this.files, file])
this.updates.next({ action: "files", files: newFiles })
}
handleComponentInteraction(interaction: ComponentInteraction) { handleComponentInteraction(interaction: ComponentInteraction) {
this.componentInteraction = interaction this.componentInteraction = interaction
@@ -60,7 +72,7 @@ export abstract class Renderer {
} }
} }
protected abstract createMessage(options: MessageOptions): Promise<Message> protected abstract createMessage(options: NewMessagePayload): Promise<Message>
private getMessageOptions(): MessageOptions { private getMessageOptions(): MessageOptions {
const options: MessageOptions = { const options: MessageOptions = {
@@ -102,6 +114,15 @@ export abstract class Renderer {
return return
} }
if (payload.action === "files") {
if (this.message) {
await this.message?.updateFiles(payload.files)
} else {
this.message = await this.createMessageFromFiles(payload.files)
}
return
}
if (this.componentInteraction) { if (this.componentInteraction) {
const promise = this.componentInteraction.update(payload.options) const promise = this.componentInteraction.update(payload.options)
this.componentInteraction = undefined this.componentInteraction = undefined

View File

@@ -5,8 +5,4 @@ export class TextNode extends Node<string> {
override modifyMessageOptions(options: MessageOptions) { override modifyMessageOptions(options: MessageOptions) {
options.content = options.content + this.props options.content = options.content + this.props
} }
override get text() {
return this.props
}
} }

View File

@@ -12,6 +12,7 @@ export * from "./core/components/embed-title"
export * from "./core/components/link" export * from "./core/components/link"
export * from "./core/components/option" export * from "./core/components/option"
export * from "./core/components/select" export * from "./core/components/select"
export * from "./core/file"
export * from "./core/instance" export * from "./core/instance"
export { useInstance } from "./core/instance-context" export { useInstance } from "./core/instance-context"
export * from "./core/reacord" export * from "./core/reacord"

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.3.5",
"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",
@@ -27,8 +27,7 @@
"exports": { "exports": {
".": { ".": {
"import": "./dist/main.js", "import": "./dist/main.js",
"require": "./dist/main.cjs", "require": "./dist/main.cjs"
"types": "./dist/main.d.ts"
}, },
"./package.json": { "./package.json": {
"import": "./package.json", "import": "./package.json",
@@ -36,23 +35,24 @@
} }
}, },
"scripts": { "scripts": {
"build": "cp ../../README.md . && cp ../../LICENSE . && tsup library/main.ts --target node16 --format cjs,esm --dts --sourcemap", "build": "tsup-node library/main.ts --target node16 --format cjs,esm --dts --sourcemap",
"build-watch": "pnpm build -- --watch", "build-watch": "pnpm build -- --watch",
"test": "vitest --coverage --no-watch", "test": "vitest --coverage --no-watch",
"test-dev": "vitest", "test-dev": "vitest",
"test-manual": "nodemon --exec tsx --ext ts,tsx ./scripts/discordjs-manual-test.tsx",
"typecheck": "tsc --noEmit", "typecheck": "tsc --noEmit",
"playground": "nodemon --exec esmo --ext ts,tsx --inspect=5858 --enable-source-maps ./playground/main.tsx",
"release": "bash scripts/release.sh" "release": "bash scripts/release.sh"
}, },
"dependencies": { "dependencies": {
"@types/node": "*", "@types/node": "*",
"@types/react": "*", "@types/react": "*",
"@types/react-reconciler": "^0.28.0", "@types/react-reconciler": "^0.26.6",
"react-reconciler": "^0.29.0", "nanoid": "^3.3.3",
"rxjs": "^7.5.6" "react-reconciler": "^0.27.0",
"rxjs": "^7.5.5"
}, },
"peerDependencies": { "peerDependencies": {
"discord.js": "^14", "discord.js": "^13.3",
"react": ">=17" "react": ">=17"
}, },
"peerDependenciesMeta": { "peerDependenciesMeta": {
@@ -62,20 +62,23 @@
}, },
"devDependencies": { "devDependencies": {
"@types/lodash-es": "^4.17.6", "@types/lodash-es": "^4.17.6",
"c8": "^7.12.0", "c8": "^7.11.2",
"discord.js": "^14.0.3", "discord.js": "^13.6.0",
"dotenv": "^16.0.1", "dotenv": "^16.0.0",
"esbuild": "latest",
"esbuild-jest": "^0.5.0",
"esmo": "^0.14.1",
"lodash-es": "^4.17.21", "lodash-es": "^4.17.21",
"nodemon": "^2.0.19", "nodemon": "^2.0.15",
"prettier": "^2.7.1", "prettier": "^2.6.2",
"pretty-ms": "^8.0.0", "pretty-ms": "^7.0.1",
"react": "^18.2.0", "react": "^18.0.0",
"release-it": "^15.1.3", "release-it": "^14.14.2",
"tsup": "^6.1.3", "tsup": "^5.12.6",
"tsx": "^3.8.0", "type-fest": "^2.12.2",
"type-fest": "^2.17.0", "typescript": "^4.6.3",
"typescript": "^4.7.4", "vite": "^2.9.5",
"vitest": "^0.18.1" "vitest": "^0.9.4"
}, },
"resolutions": { "resolutions": {
"esbuild": "latest" "esbuild": "latest"
@@ -88,8 +91,5 @@
"release": true, "release": true,
"web": true "web": true
} }
},
"publishConfig": {
"access": "public"
} }
} }

Binary file not shown.

After

Width:  |  Height:  |  Size: 954 KiB

View File

@@ -0,0 +1,36 @@
import type { Client, CommandInteraction } from "discord.js"
type Command = {
name: string
description: string
run: (interaction: CommandInteraction) => unknown
}
export function createCommandHandler(client: Client, commands: Command[]) {
client.on("ready", async () => {
for (const guild of client.guilds.cache.values()) {
client.application!.commands.set(
commands.map(({ name, description }) => ({
name,
description,
})),
guild.id,
)
}
})
client.on("interactionCreate", async (interaction) => {
if (!interaction.isCommand()) return
const command = commands.find(
(command) => command.name === interaction.commandName,
)
if (command) {
try {
await command.run(interaction)
} catch (error) {
console.error(error)
}
}
})
}

View File

@@ -0,0 +1,36 @@
import * as React from "react"
import { Button, Embed, EmbedField, EmbedTitle } from "../library/main"
export function Counter(props: { onDeactivate: () => void }) {
const [count, setCount] = React.useState(0)
const [embedVisible, setEmbedVisible] = React.useState(false)
return (
<>
this button was clicked {count} times
{embedVisible && (
<Embed>
<EmbedTitle>the counter</EmbedTitle>
{count > 0 && (
<EmbedField name="is it even?">
{count % 2 === 0 ? "yes" : "no"}
</EmbedField>
)}
</Embed>
)}
{embedVisible && (
<Button label="hide embed" onClick={() => setEmbedVisible(false)} />
)}
<Button
style="primary"
emoji="<:plus_one:778531744860602388>"
label="clicc"
onClick={() => setCount(count + 1)}
/>
{!embedVisible && (
<Button label="show embed" onClick={() => setEmbedVisible(true)} />
)}
<Button style="danger" label="deactivate" onClick={props.onDeactivate} />
</>
)
}

View File

@@ -0,0 +1,31 @@
import React, { useState } from "react"
import { Button, Option, Select } from "../library/main"
export function FruitSelect({
onConfirm,
}: {
onConfirm: (choice: string) => void
}) {
const [value, setValue] = useState<string>()
return (
<>
<Select
placeholder="choose a fruit"
value={value}
onChangeValue={setValue}
>
<Option value="🍎" />
<Option value="🍌" />
<Option value="🍒" />
</Select>
<Button
label="confirm"
disabled={value == undefined}
onClick={() => {
if (value) onConfirm(value)
}}
/>
</>
)
}

View File

@@ -0,0 +1,125 @@
import { Client } from "discord.js"
import "dotenv/config"
import { readFile } from "fs/promises"
import { join } from "path"
import React from "react"
import { fileURLToPath } from "url"
import { Button, ReacordDiscordJs, useInstance } from "../library/main"
import { createCommandHandler } from "./command-handler"
import { Counter } from "./counter"
import { FruitSelect } from "./fruit-select"
const client = new Client({
intents: ["GUILDS"],
})
const reacord = new ReacordDiscordJs(client)
client.on("ready", () => {
console.info("ready 💖")
// const now = new Date()
// function UptimeCounter() {
// const [uptime, setUptime] = React.useState(0)
// React.useEffect(() => {
// const interval = setInterval(() => {
// setUptime(Date.now() - now.getTime())
// }, 5000)
// return () => clearInterval(interval)
// }, [])
// return (
// <Embed>this bot has been running for {prettyMilliseconds(uptime)}</Embed>
// )
// }
// reacord.send("671787605624487941", <UptimeCounter />)
})
createCommandHandler(client, [
{
name: "button",
description: "it's a button",
run: (interaction) => {
reacord.reply(
interaction,
<Button label="clic" onClick={() => console.info("was clic")} />,
)
},
},
{
name: "counter",
description: "shows a counter button",
run: (interaction) => {
const reply = reacord.reply(interaction)
reply.render(<Counter onDeactivate={() => reply.destroy()} />)
},
},
{
name: "select",
description: "shows a select",
run: (interaction) => {
const instance = reacord.reply(
interaction,
<FruitSelect
onConfirm={(value) => {
instance.render(`you chose ${value}`)
instance.deactivate()
}}
/>,
)
},
},
{
name: "ephemeral-button",
description: "button which shows ephemeral messages",
run: (interaction) => {
reacord.reply(
interaction,
<>
<Button
label="public clic"
onClick={(event) =>
reacord.reply(
interaction,
`${event.guild?.member.displayName} clic`,
)
}
/>
<Button
label="clic"
onClick={(event) => event.ephemeralReply("you clic")}
/>
</>,
)
},
},
{
name: "delete-this",
description: "delete this",
run: (interaction) => {
function DeleteThis() {
const instance = useInstance()
return <Button label="delete this" onClick={() => instance.destroy()} />
}
reacord.reply(interaction, <DeleteThis />)
},
},
{
name: "anime",
description: "shows an anime image",
run: async (interaction) => {
const reply = reacord.reply(interaction)
const image = await readFile(
join(fileURLToPath(import.meta.url), "../anime.jpg"),
)
reply.attach({ name: "anime.jpg", data: image })
// reply.render("anime")
},
},
])
await client.login(process.env.TEST_BOT_TOKEN)

View File

@@ -1,139 +0,0 @@
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

@@ -0,0 +1,4 @@
pnpm build
cp ../../README.md .
cp ../../LICENSE .
pnpx release-it

View File

@@ -1,12 +0,0 @@
import { spawnSync } from "node:child_process"
import { createRequire } from "node:module"
import { beforeAll, expect, test } from "vitest"
beforeAll(() => {
spawnSync("pnpm", ["run", "build"])
})
test("can require commonjs", () => {
const require = createRequire(import.meta.url)
expect(() => require("../dist/main.cjs")).not.toThrow()
})

View File

@@ -35,7 +35,7 @@ test("rendering behavior", async () => {
}, },
]) ])
await tester.findButtonByLabel("show embed").click() tester.findButtonByLabel("show embed").click()
await tester.assertMessages([ await tester.assertMessages([
{ {
content: "count: 0", content: "count: 0",
@@ -62,7 +62,7 @@ test("rendering behavior", async () => {
}, },
]) ])
await tester.findButtonByLabel("clicc").click() tester.findButtonByLabel("clicc").click()
await tester.assertMessages([ await tester.assertMessages([
{ {
content: "count: 1", content: "count: 1",
@@ -94,7 +94,7 @@ test("rendering behavior", async () => {
}, },
]) ])
await tester.findButtonByLabel("clicc").click() tester.findButtonByLabel("clicc").click()
await tester.assertMessages([ await tester.assertMessages([
{ {
content: "count: 2", content: "count: 2",
@@ -126,7 +126,7 @@ test("rendering behavior", async () => {
}, },
]) ])
await tester.findButtonByLabel("hide embed").click() tester.findButtonByLabel("hide embed").click()
await tester.assertMessages([ await tester.assertMessages([
{ {
content: "count: 2", content: "count: 2",
@@ -153,7 +153,7 @@ test("rendering behavior", async () => {
}, },
]) ])
await tester.findButtonByLabel("clicc").click() tester.findButtonByLabel("clicc").click()
await tester.assertMessages([ await tester.assertMessages([
{ {
content: "count: 3", content: "count: 3",
@@ -180,7 +180,7 @@ test("rendering behavior", async () => {
}, },
]) ])
await tester.findButtonByLabel("deactivate").click() tester.findButtonByLabel("deactivate").click()
await tester.assertMessages([ await tester.assertMessages([
{ {
content: "count: 3", content: "count: 3",
@@ -210,7 +210,7 @@ test("rendering behavior", async () => {
}, },
]) ])
await tester.findButtonByLabel("clicc").click() tester.findButtonByLabel("clicc").click()
await tester.assertMessages([ await tester.assertMessages([
{ {
content: "count: 3", content: "count: 3",

View File

@@ -59,16 +59,16 @@ test("single select", async () => {
await assertSelect([]) await assertSelect([])
expect(onSelect).toHaveBeenCalledTimes(0) expect(onSelect).toHaveBeenCalledTimes(0)
await tester.findSelectByPlaceholder("choose one").select("2") tester.findSelectByPlaceholder("choose one").select("2")
await assertSelect(["2"]) await assertSelect(["2"])
expect(onSelect).toHaveBeenCalledWith( expect(onSelect).toHaveBeenCalledWith(
expect.objectContaining({ values: ["2"] }), expect.objectContaining({ values: ["2"] }),
) )
await tester.findButtonByLabel("disable").click() tester.findButtonByLabel("disable").click()
await assertSelect(["2"], true) await assertSelect(["2"], true)
await tester.findSelectByPlaceholder("choose one").select("1") tester.findSelectByPlaceholder("choose one").select("1")
await assertSelect(["2"], true) await assertSelect(["2"], true)
expect(onSelect).toHaveBeenCalledTimes(1) expect(onSelect).toHaveBeenCalledTimes(1)
}) })
@@ -125,19 +125,19 @@ test("multiple select", async () => {
await assertSelect([]) await assertSelect([])
expect(onSelect).toHaveBeenCalledTimes(0) expect(onSelect).toHaveBeenCalledTimes(0)
await tester.findSelectByPlaceholder("select").select("1", "3") tester.findSelectByPlaceholder("select").select("1", "3")
await assertSelect(expect.arrayContaining(["1", "3"]) 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(["1", "3"]) }), expect.objectContaining({ values: expect.arrayContaining(["1", "3"]) }),
) )
await tester.findSelectByPlaceholder("select").select("2") tester.findSelectByPlaceholder("select").select("2")
await assertSelect(expect.arrayContaining(["2"]) as unknown as string[]) await assertSelect(expect.arrayContaining(["2"]) as unknown as string[])
expect(onSelect).toHaveBeenCalledWith( expect(onSelect).toHaveBeenCalledWith(
expect.objectContaining({ values: expect.arrayContaining(["2"]) }), expect.objectContaining({ values: expect.arrayContaining(["2"]) }),
) )
await tester.findSelectByPlaceholder("select").select() tester.findSelectByPlaceholder("select").select()
await assertSelect([]) await assertSelect([])
expect(onSelect).toHaveBeenCalledWith(expect.objectContaining({ values: [] })) expect(onSelect).toHaveBeenCalledWith(expect.objectContaining({ values: [] }))
}) })
@@ -145,7 +145,7 @@ test("multiple select", async () => {
test("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") tester.findSelectByPlaceholder("select").select("something")
await tester.assertMessages([ await tester.assertMessages([
{ {
content: "", content: "",

View File

@@ -1,6 +1,6 @@
/* eslint-disable class-methods-use-this */ /* eslint-disable class-methods-use-this */
/* eslint-disable require-await */ /* eslint-disable require-await */
import { randomUUID } from "node:crypto" import { nanoid } from "nanoid"
import { setTimeout } from "node:timers/promises" import { setTimeout } from "node:timers/promises"
import type { ReactNode } from "react" import type { ReactNode } from "react"
import { expect } from "vitest" import { expect } from "vitest"
@@ -194,7 +194,7 @@ class TestCommandInteraction implements CommandInteraction {
} }
class TestInteraction { class TestInteraction {
readonly id = randomUUID() readonly id = nanoid()
readonly channelId = "test-channel-id" readonly channelId = "test-channel-id"
constructor( constructor(

View File

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

View File

@@ -1,5 +1,5 @@
/// <reference types="vitest" /> /// <reference types="vitest" />
import { defineConfig } from "vitest/config" import { defineConfig } from "vite"
export default defineConfig({ export default defineConfig({
build: { build: {

View File

@@ -1,17 +0,0 @@
# website
## 0.4.2
### Patch Changes
- Updated dependencies [72f4a4a]
- Updated dependencies [7536bde]
- Updated dependencies [e335165]
- reacord@0.5.1
## 0.4.1
### Patch Changes
- Updated dependencies [aa65da5]
- reacord@0.5.0

View File

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

View File

@@ -1,4 +1,9 @@
import type { LinksFunction, MetaFunction } from "@remix-run/node" import packageJson from "reacord/package.json"
import type {
LinksFunction,
LoaderFunction,
MetaFunction,
} from "@remix-run/node"
import { import {
Links, Links,
LiveReload, LiveReload,
@@ -8,10 +13,10 @@ import {
ScrollRestoration, ScrollRestoration,
useLoaderData, useLoaderData,
} from "@remix-run/react" } from "@remix-run/react"
import packageJson from "reacord/package.json"
import bannerUrl from "~/assets/banner.png" import bannerUrl from "~/assets/banner.png"
import faviconUrl from "~/assets/favicon.png" import faviconUrl from "~/assets/favicon.png"
import { GuideLinksProvider } from "~/modules/navigation/guide-links-context" import { GuideLinksProvider } from "~/modules/navigation/guide-links-context"
import type { GuideLink } from "~/modules/navigation/load-guide-links.server"
import { loadGuideLinks } from "~/modules/navigation/load-guide-links.server" import { loadGuideLinks } from "~/modules/navigation/load-guide-links.server"
import prismThemeCss from "~/modules/ui/prism-theme.css" import prismThemeCss from "~/modules/ui/prism-theme.css"
import tailwindCss from "~/modules/ui/tailwind.out.css" import tailwindCss from "~/modules/ui/tailwind.out.css"
@@ -56,18 +61,22 @@ export const links: LinksFunction = () => [
}, },
] ]
export async function loader() { type LoaderData = {
return { guideLinks: GuideLink[]
}
export const loader: LoaderFunction = async () => {
const data: LoaderData = {
guideLinks: await loadGuideLinks(), guideLinks: await loadGuideLinks(),
} }
return data
} }
export default function App() { export default function App() {
const data = useLoaderData<typeof loader>() const data: LoaderData = useLoaderData()
return ( return (
<html lang="en" className="bg-slate-900 text-slate-100"> <html lang="en" className="bg-slate-900 text-slate-100">
<head> <head>
{/* eslint-disable-next-line unicorn/text-encoding-identifier-case */}
<meta charSet="utf-8" /> <meta charSet="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" /> <meta name="viewport" content="width=device-width,initial-scale=1" />
<Meta /> <Meta />
@@ -75,10 +84,9 @@ export default function App() {
{process.env.NODE_ENV === "production" && ( {process.env.NODE_ENV === "production" && (
<script <script
async async
defer data-website-id="49c69ade-5593-4853-9686-c9ca9d519a18"
data-website-id="e3ce3a50-720e-4489-be37-cc091c1b7029" src="https://umami-production-265f.up.railway.app/umami.js"
src="https://umami-production-72bc.up.railway.app/umami.js" />
></script>
)} )}
</head> </head>
<body> <body>

View File

@@ -7,15 +7,11 @@ meta:
# Getting Started # Getting Started
These guides assume some familiarity with JavaScript, [React](https://reactjs.org), [Discord.js](https://discord.js.org) and the [Discord API](https://discord.dev). Keep these pages as reference if you need it. This guide assumes some familiarity with JavaScript, [React](https://reactjs.org), [Discord.js](https://discord.js.org) and the [Discord API](https://discord.dev). Keep these pages as reference if you need it.
## Setup from template **Note:** Ensure your project has support for running code with JSX. I recommend using [esno](https://npm.im/esno).
[Use this starter template](https://github.com/itsMapleLeaf/reacord-starter) to get off the ground quickly. ## Install
## Adding to an existing project
Install Reacord and dependencies:
```bash ```bash
# npm # npm
@@ -28,10 +24,12 @@ yarn add reacord react discord.js
pnpm add reacord react discord.js pnpm add reacord react discord.js
``` ```
## Setup
Create a Discord.js client and a Reacord instance: Create a Discord.js client and a Reacord instance:
```js ```js
// main.jsx // main.js
import { Client } from "discord.js" import { Client } from "discord.js"
import { ReacordDiscordJs } from "reacord" import { ReacordDiscordJs } from "reacord"
@@ -44,10 +42,3 @@ client.on("ready", () => {
await client.login(process.env.BOT_TOKEN) await client.login(process.env.BOT_TOKEN)
``` ```
To use JSX in your code, run it with [tsx](https://npm.im/tsx):
```bash
npm install tsx
tsx main.tsx
```

View File

@@ -1,5 +1,4 @@
--- ---
order: 5
meta: meta:
title: useInstance title: useInstance
description: Using useInstance to get the current instance within a component description: Using useInstance to get the current instance within a component

View File

@@ -1,8 +0,0 @@
import { defineConfig } from "cypress"
export default defineConfig({
e2e: {
setupNodeEvents(on, config) {},
baseUrl: "http://localhost:3000/",
},
})

View File

@@ -0,0 +1,3 @@
{
"baseUrl": "http://localhost:3000/"
}

View File

@@ -0,0 +1,5 @@
{
"name": "Using fixtures to represent data",
"email": "hello@cypress.io",
"body": "Fixtures are a great way to mock data for responses to routes"
}

View File

@@ -0,0 +1,22 @@
/// <reference types="cypress" />
// ***********************************************************
// This example plugins/index.js can be used to load plugins
//
// You can change the location of this file or turn off loading
// the plugins file with the 'pluginsFile' configuration option.
//
// You can read more here:
// https://on.cypress.io/plugins-guide
// ***********************************************************
// This function is called when a project is opened or re-opened (e.g. due to
// the project's config changing)
/**
* @type {Cypress.PluginConfig}
*/
// eslint-disable-next-line no-unused-vars
export default function cypressConfig(on, config) {
// `on` is used to hook into various events Cypress emits
// `config` is the resolved Cypress config
}

View File

@@ -0,0 +1,26 @@
// ***********************************************
// This example commands.js shows you how to
// create various custom commands and overwrite
// existing commands.
//
// For more comprehensive examples of custom
// commands please read more here:
// https://on.cypress.io/custom-commands
// ***********************************************
//
//
// -- This is a parent command --
// Cypress.Commands.add('login', (email, password) => { ... })
//
//
// -- This is a child command --
// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
//
//
// -- This is a dual command --
// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
//
//
// -- This will overwrite an existing command --
// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
import "@testing-library/cypress/add-commands"

View File

@@ -1 +0,0 @@
import "@testing-library/cypress/add-commands"

View File

@@ -1 +0,0 @@
import "./commands"

View File

@@ -0,0 +1,20 @@
// ***********************************************************
// This example support/index.js is processed and
// loaded automatically before your test files.
//
// This is a great place to put global configuration and
// behavior that modifies Cypress.
//
// You can change the location of this file or turn off
// automatically serving support files with the
// 'supportFile' configuration option.
//
// You can read more here:
// https://on.cypress.io/configuration
// ***********************************************************
// Import commands.js using ES2015 syntax:
import "./commands"
// Alternatively you can use CommonJS syntax:
// require('./commands')

View File

@@ -1,7 +1,6 @@
{ {
"name": "website",
"version": "0.4.2",
"private": true, "private": true,
"name": "website",
"scripts": { "scripts": {
"dev": "concurrently 'typedoc --watch' 'pnpm tailwind -- --watch' 'remix dev'", "dev": "concurrently 'typedoc --watch' 'pnpm tailwind -- --watch' 'remix dev'",
"test": "node ./scripts/test.js", "test": "node ./scripts/test.js",
@@ -12,43 +11,45 @@
"typecheck": "tsc --noEmit && tsc --project cypress/tsconfig.json --noEmit" "typecheck": "tsc --noEmit && tsc --project cypress/tsconfig.json --noEmit"
}, },
"dependencies": { "dependencies": {
"@headlessui/react": "^1.6.6", "@headlessui/react": "^1.5.0",
"@heroicons/react": "^1.0.6", "@heroicons/react": "^1.0.6",
"@reach/rect": "^0.17.0", "@reach/rect": "^0.17.0",
"@remix-run/node": "^1.6.5", "@remix-run/node": "^1.4.1",
"@remix-run/react": "^1.6.5", "@remix-run/react": "^1.4.1",
"@remix-run/serve": "^1.6.5", "@remix-run/serve": "^1.4.1",
"@tailwindcss/typography": "^0.5.4", "@tailwindcss/typography": "^0.5.2",
"clsx": "^1.2.1", "clsx": "^1.1.1",
"fast-glob": "^3.2.11", "fast-glob": "^3.2.11",
"gray-matter": "^4.0.3", "gray-matter": "^4.0.3",
"reacord": "workspace:*", "reacord": "workspace:*",
"react": "^18.2.0", "react": "^18.0.0",
"react-dom": "^18.2.0", "react-dom": "^18.0.0",
"react-focus-on": "^3.6.0", "react-focus-on": "^3.5.4",
"react-router": "^6.3.0", "react-router": "^6.3.0",
"react-router-dom": "^6.3.0", "react-router-dom": "^6.3.0"
"zod": "^3.17.10"
}, },
"devDependencies": { "devDependencies": {
"@remix-run/dev": "^1.6.5", "@remix-run/dev": "^1.4.1",
"@remix-run/node": "^1.4.1", "@remix-run/node": "^1.4.1",
"@testing-library/cypress": "^8.0.3", "@testing-library/cypress": "^8.0.2",
"@types/node": "*", "@types/node": "*",
"@types/react": "^18.0.15", "@types/react": "^18.0.6",
"@types/react-dom": "^18.0.6", "@types/react-dom": "^18.0.2",
"@types/tailwindcss": "^3.0.11", "@types/tailwindcss": "^3.0.10",
"@types/wait-on": "^5.3.1", "@types/wait-on": "^5.3.1",
"autoprefixer": "^10.4.7", "autoprefixer": "^10.4.4",
"concurrently": "^7.3.0", "concurrently": "^7.1.0",
"cypress": "^10.3.1", "cypress": "^9.5.4",
"execa": "^6.1.0", "execa": "^6.1.0",
"postcss": "^8.4.14", "postcss": "^8.4.12",
"rehype-prism-plus": "^1.4.2", "rehype-prism-plus": "^1.3.2",
"tailwindcss": "^3.1.6", "tailwindcss": "^3.0.24",
"typedoc": "^0.23.8", "typedoc": "^0.22.15",
"typescript": "^4.7.4", "typescript": "^4.6.3",
"wait-on": "^6.0.1" "wait-on": "^6.0.1"
}, },
"engines": {
"node": ">=14"
},
"sideEffects": false "sideEffects": false
} }

View File

@@ -6,6 +6,5 @@
"paths": { "paths": {
"~/*": ["./app/*"] "~/*": ["./app/*"]
} }
}, }
"include": ["remix.env.d.ts", "**/*.ts", "**/*.tsx"]
} }

6854
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,2 +1 @@
packages: workspaces: [packages/*]
- packages/*