Compare commits
157 Commits
0.1.0
...
reacord@0.
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3f078c91d2 | ||
|
|
8df7bc9baa | ||
|
|
52e587e70f | ||
|
|
3152b1b79e | ||
|
|
d20afb094c | ||
|
|
118f567e8d | ||
|
|
a447fefc7b | ||
|
|
9efc61d8eb | ||
|
|
aa65da59df | ||
|
|
bc91080eca | ||
|
|
9afe6fe0fa | ||
|
|
abc60528d5 | ||
|
|
413f88c7b8 | ||
|
|
b482f07788 | ||
|
|
3b191d274e | ||
|
|
be5ec7c545 | ||
|
|
c93815b9f9 | ||
|
|
1e527993e5 | ||
|
|
f4eae8da75 | ||
|
|
62505ca98c | ||
|
|
cc1bc0932f | ||
|
|
c08f5621ef | ||
|
|
b6d2aac7a3 | ||
|
|
51ac0c89da | ||
|
|
f4985b1d87 | ||
|
|
96affac979 | ||
|
|
93b321dc36 | ||
|
|
e313399a5a | ||
|
|
90744ebe47 | ||
|
|
33bb2ee196 | ||
|
|
eb97b2d23d | ||
|
|
5aaaffbda9 | ||
|
|
43029019f4 | ||
|
|
8c481f18c6 | ||
|
|
87ecb20f7a | ||
|
|
2324f3c89f | ||
|
|
c35c32bddd | ||
|
|
6eb36b44f3 | ||
|
|
a1fc0287fc | ||
|
|
02dd763e63 | ||
|
|
a4024394e3 | ||
|
|
c72096058a | ||
|
|
672fcd5bc4 | ||
|
|
25f34b3715 | ||
|
|
8a7557f0eb | ||
|
|
fc3025baaf | ||
|
|
81f32794b4 | ||
|
|
dbf9640b16 | ||
|
|
a485ebaf74 | ||
|
|
7ef5a7ac9d | ||
|
|
6715756c2b | ||
|
|
6851c5419a | ||
|
|
1ba75492e5 | ||
|
|
aced338d72 | ||
|
|
512c0649d8 | ||
|
|
91b82ca41f | ||
|
|
752ccc080d | ||
|
|
3c2d3b4683 | ||
|
|
ad57674d6e | ||
|
|
065bec9a37 | ||
|
|
d3ccafc6d5 | ||
|
|
c71d70bbb4 | ||
|
|
5ba12af699 | ||
|
|
ff39ef753f | ||
|
|
2288c27e1e | ||
|
|
c86648f44e | ||
|
|
0edf702b5f | ||
|
|
05bda71ad6 | ||
|
|
0217fb8533 | ||
|
|
b59dcc0ae7 | ||
|
|
3efaef162b | ||
|
|
4c2aafe185 | ||
|
|
d3d1f473ae | ||
|
|
116e606db1 | ||
|
|
490bf2cefa | ||
|
|
e06bfa490f | ||
|
|
2765b4fda4 | ||
|
|
5660297588 | ||
|
|
2cdd324495 | ||
|
|
7a09e8fdca | ||
|
|
8111931183 | ||
|
|
fd64132e58 | ||
|
|
1ba0da6c86 | ||
|
|
fdd6a3a3cc | ||
|
|
8ce3834cf4 | ||
|
|
1bfbe9608c | ||
|
|
0695bbc6bd | ||
|
|
569e5c7473 | ||
|
|
62300d23ca | ||
|
|
cda69a0c85 | ||
|
|
785384286b | ||
|
|
50961e888e | ||
|
|
8c3304144e | ||
|
|
b6b05232f7 | ||
|
|
33a170a4fb | ||
|
|
9a6f85a726 | ||
|
|
a79649048f | ||
|
|
e7196e686c | ||
|
|
26eb8bedb0 | ||
|
|
2851d4b787 | ||
|
|
46d3c64133 | ||
|
|
6b77971ed5 | ||
|
|
effd16ed97 | ||
|
|
989ab330b3 | ||
|
|
0aafc66ce1 | ||
|
|
ff8347b52a | ||
|
|
c436500b3a | ||
|
|
e93506409f | ||
|
|
8482f6e91a | ||
|
|
c5e11b4417 | ||
|
|
2e4ff0f524 | ||
|
|
d0c940c693 | ||
|
|
01f245c2e2 | ||
|
|
b65004dd75 | ||
|
|
d9dd4d5307 | ||
|
|
2b3b8953d0 | ||
|
|
a6b706a3de | ||
|
|
d3f6c8af4d | ||
|
|
b0e937f896 | ||
|
|
8b371cd1cf | ||
|
|
ba155226f1 | ||
|
|
a1424f4607 | ||
|
|
42461c7ec8 | ||
|
|
27f793b1db | ||
|
|
97a5526d9d | ||
|
|
99eebef9a9 | ||
|
|
1b97f9256f | ||
|
|
1a04e6093d | ||
|
|
4803cb8478 | ||
|
|
4201f45cc9 | ||
|
|
52b83522de | ||
|
|
017a417773 | ||
|
|
661a253d8c | ||
|
|
5b68a1f0ea | ||
|
|
8c4a450bfb | ||
|
|
14b74a0a3f | ||
|
|
f2d309b2a7 | ||
|
|
adeb0fb0d9 | ||
|
|
4f8308dc73 | ||
|
|
f5d8fa5271 | ||
|
|
ac759412b3 | ||
|
|
608b008659 | ||
|
|
87cbf1b74d | ||
|
|
4f463bfa23 | ||
|
|
2e65218083 | ||
|
|
1e4a2bd006 | ||
|
|
76bd0b0b98 | ||
|
|
021afc154f | ||
|
|
fe39859b68 | ||
|
|
c55fb22a8f | ||
|
|
7d8336c7a7 | ||
|
|
c6ea101330 | ||
|
|
4e9b358731 | ||
|
|
a66520829a | ||
|
|
e2b150bbe2 | ||
|
|
be42042552 | ||
|
|
3bfc5f4977 |
8
.changeset/README.md
Normal file
8
.changeset/README.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# 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)
|
||||
11
.changeset/config.json
Normal file
11
.changeset/config.json
Normal file
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"$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": []
|
||||
}
|
||||
25
.eslintrc.cjs
Normal file
25
.eslintrc.cjs
Normal file
@@ -0,0 +1,25 @@
|
||||
require("@rushstack/eslint-patch/modern-module-resolution")
|
||||
|
||||
/** @type {import('eslint').Linter.Config} */
|
||||
module.exports = {
|
||||
extends: [require.resolve("@itsmapleleaf/configs/eslint")],
|
||||
ignorePatterns: [
|
||||
"**/node_modules/**",
|
||||
"**/.cache/**",
|
||||
"**/build/**",
|
||||
"**/dist/**",
|
||||
"**/coverage/**",
|
||||
"**/public/**",
|
||||
],
|
||||
parserOptions: {
|
||||
project: require.resolve("./tsconfig.base.json"),
|
||||
},
|
||||
overrides: [
|
||||
{
|
||||
files: ["packages/website/cypress/**"],
|
||||
parserOptions: {
|
||||
project: require.resolve("./packages/website/cypress/tsconfig.json"),
|
||||
},
|
||||
},
|
||||
],
|
||||
}
|
||||
@@ -1,17 +0,0 @@
|
||||
{
|
||||
"extends": ["./node_modules/@itsmapleleaf/configs/eslint"],
|
||||
"ignorePatterns": [
|
||||
"**/node_modules/**",
|
||||
"**/.cache/**",
|
||||
"**/build/**",
|
||||
"**/dist/**",
|
||||
"**/coverage/**"
|
||||
],
|
||||
"parserOptions": {
|
||||
"project": "./tsconfig.base.json"
|
||||
},
|
||||
"rules": {
|
||||
"import/no-unused-modules": "off",
|
||||
"unicorn/prevent-abbreviations": "off"
|
||||
}
|
||||
}
|
||||
16
.github/workflows/deploy-docs.yml
vendored
16
.github/workflows/deploy-docs.yml
vendored
@@ -1,16 +0,0 @@
|
||||
name: deploy docs
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
paths: [packages/docs/**, reacord/library/**/*.ts]
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: superfly/flyctl-actions@master
|
||||
env:
|
||||
FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
|
||||
with:
|
||||
args: "deploy"
|
||||
36
.github/workflows/main.yml
vendored
36
.github/workflows/main.yml
vendored
@@ -10,21 +10,29 @@ env:
|
||||
TEST_CHANNEL_ID: ${{ secrets.TEST_CHANNEL_ID }}
|
||||
TEST_GUILD_ID: ${{ secrets.TEST_GUILD_ID }}
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
run-scripts:
|
||||
run-commands:
|
||||
strategy:
|
||||
matrix:
|
||||
scripts:
|
||||
- name: test
|
||||
script: coverage
|
||||
- name: lint
|
||||
script: lint
|
||||
- name: typecheck
|
||||
script: typecheck
|
||||
- name: build
|
||||
script: build
|
||||
fail-fast: false
|
||||
name: ${{ matrix.scripts.name }}
|
||||
matrix:
|
||||
command:
|
||||
# if these run in the same process, it dies,
|
||||
# so we test them separate
|
||||
- name: test reacord
|
||||
run: pnpm -C packages/reacord test
|
||||
- name: test website
|
||||
run: pnpm -C packages/website test
|
||||
- name: build
|
||||
run: pnpm --recursive run build
|
||||
- name: lint
|
||||
run: pnpm run lint
|
||||
- name: typecheck
|
||||
run: pnpm --recursive run typecheck
|
||||
name: ${{ matrix.command.name }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
@@ -32,6 +40,6 @@ jobs:
|
||||
with:
|
||||
# https://github.com/actions/setup-node#supported-version-syntax
|
||||
node-version: "16"
|
||||
- run: npm i -g pnpm
|
||||
- run: npm i -g pnpm@7.5.0
|
||||
- run: pnpm install --frozen-lockfile
|
||||
- run: pnpm run --recursive ${{ matrix.scripts.script }}
|
||||
- run: ${{ matrix.command.run }}
|
||||
|
||||
37
.github/workflows/release.yml
vendored
Normal file
37
.github/workflows/release.yml
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
# 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 }}
|
||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -3,4 +3,8 @@ node_modules
|
||||
.vscode
|
||||
coverage
|
||||
.env
|
||||
*.code-workspace
|
||||
.pnpm-debug.log
|
||||
|
||||
build
|
||||
.cache
|
||||
|
||||
@@ -4,3 +4,4 @@ coverage
|
||||
pnpm-lock.yaml
|
||||
build
|
||||
.cache
|
||||
packages/website/public/api
|
||||
|
||||
13
Dockerfile
13
Dockerfile
@@ -1,13 +0,0 @@
|
||||
FROM node:lts-slim
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
COPY / ./
|
||||
RUN ls -R
|
||||
|
||||
RUN npm install -g pnpm
|
||||
RUN pnpm install --unsafe-perm --frozen-lockfile
|
||||
RUN pnpm build -C packages/docs
|
||||
RUN pnpm install --prod --unsafe-perm --frozen-lockfile
|
||||
|
||||
CMD [ "pnpm", "start", "-C", "packages/docs" ]
|
||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2022 itsMapleLeaf
|
||||
Copyright (c) 2022 itsMapleLeaf
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
26
README.md
26
README.md
@@ -1,6 +1,26 @@
|
||||
# reacord
|
||||
<center>
|
||||
<img src="./packages/website/app/assets/banner.png" alt="Reacord: Create interactive Discord messages using React">
|
||||
</center>
|
||||
|
||||
Create interactive Discord messages using React! [Visit the docs to get started.](https://reacord.fly.dev/guides/getting-started)
|
||||
## Installation ∙ [](https://www.npmjs.com/package/reacord)
|
||||
|
||||
```console
|
||||
# npm
|
||||
npm install reacord react discord.js
|
||||
|
||||
# yarn
|
||||
yarn add reacord react discord.js
|
||||
|
||||
# pnpm
|
||||
pnpm add reacord react discord.js
|
||||
|
||||
```
|
||||
|
||||
## Get Started
|
||||
|
||||
[Visit the docs to get started.](https://reacord.mapleleaf.dev/guides/getting-started)
|
||||
|
||||
## Example
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
```tsx
|
||||
@@ -21,3 +41,5 @@ function Counter() {
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||

|
||||
|
||||
40
fly.toml
40
fly.toml
@@ -1,40 +0,0 @@
|
||||
# fly.toml file generated for reacord on 2021-12-29T14:06:41-06:00
|
||||
|
||||
app = "reacord"
|
||||
|
||||
kill_signal = "SIGINT"
|
||||
kill_timeout = 5
|
||||
processes = []
|
||||
|
||||
[env]
|
||||
PORT = 8080
|
||||
|
||||
[experimental]
|
||||
allowed_public_ports = []
|
||||
auto_rollback = true
|
||||
|
||||
[[services]]
|
||||
http_checks = []
|
||||
internal_port = 8080
|
||||
processes = ["app"]
|
||||
protocol = "tcp"
|
||||
script_checks = []
|
||||
|
||||
[services.concurrency]
|
||||
hard_limit = 25
|
||||
soft_limit = 20
|
||||
type = "connections"
|
||||
|
||||
[[services.ports]]
|
||||
handlers = ["http"]
|
||||
port = 80
|
||||
|
||||
[[services.ports]]
|
||||
handlers = ["tls", "http"]
|
||||
port = 443
|
||||
|
||||
[[services.tcp_checks]]
|
||||
grace_period = "1s"
|
||||
interval = "15s"
|
||||
restart_limit = 0
|
||||
timeout = "2s"
|
||||
29
package.json
29
package.json
@@ -1,26 +1,23 @@
|
||||
{
|
||||
"name": "reacord-monorepo",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"lint": "eslint --ext js,ts,tsx .",
|
||||
"lint-fix": "pnpm lint -- --fix",
|
||||
"format": "prettier --write ."
|
||||
},
|
||||
"dependencies": {
|
||||
"@itsmapleleaf/configs": "^1.1.2"
|
||||
"format": "prettier --write .",
|
||||
"build": "pnpm -r run build",
|
||||
"start": "pnpm -C packages/website run start",
|
||||
"release": "pnpm -r run build && changeset publish"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@typescript-eslint/eslint-plugin": "^5.8.1",
|
||||
"@typescript-eslint/parser": "^5.8.1",
|
||||
"eslint": "^8.5.0",
|
||||
"eslint-config-prettier": "^8.3.0",
|
||||
"eslint-import-resolver-typescript": "^2.5.0",
|
||||
"eslint-plugin-import": "^2.25.3",
|
||||
"eslint-plugin-jsx-a11y": "^6.5.1",
|
||||
"eslint-plugin-react": "^7.28.0",
|
||||
"eslint-plugin-react-hooks": "^4.3.0",
|
||||
"eslint-plugin-unicorn": "^39.0.0",
|
||||
"prettier": "^2.5.1",
|
||||
"typescript": "^4.5.4"
|
||||
"@changesets/cli": "^2.24.0",
|
||||
"@itsmapleleaf/configs": "^1.1.3",
|
||||
"@rushstack/eslint-patch": "^1.1.3",
|
||||
"@types/eslint": "^8.4.1",
|
||||
"eslint": "^8.14.0",
|
||||
"node": "^16",
|
||||
"prettier": "^2.6.2",
|
||||
"typescript": "^4.6.3"
|
||||
},
|
||||
"resolutions": {
|
||||
"esbuild": "latest"
|
||||
|
||||
3
packages/docs/.gitignore
vendored
3
packages/docs/.gitignore
vendored
@@ -1,3 +0,0 @@
|
||||
.asset-cache
|
||||
node_modules
|
||||
/api
|
||||
@@ -1,65 +0,0 @@
|
||||
{
|
||||
"name": "reacord-docs-new",
|
||||
"type": "module",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"prepare": "node ./scripts/fix-heroicons.js",
|
||||
"serve": "esmo --experimental-import-meta-resolve --experimental-json-modules --no-warnings --enable-source-maps src/main.tsx | pino-colada",
|
||||
"dev": "npm-run-all --parallel --print-label --race dev-*",
|
||||
"dev-server": "nodemon --inspect --exec \"pnpm serve\" --watch src --ext ts,tsx,md,css",
|
||||
"dev-docs": "typedoc --watch",
|
||||
"build": "typedoc",
|
||||
"start": "cross-env NODE_ENV=production pnpm serve",
|
||||
"typecheck": "tsc --noEmit"
|
||||
},
|
||||
"dependencies": {
|
||||
"@heroicons/react": "^1.0.5",
|
||||
"@tailwindcss/typography": "^0.5.0",
|
||||
"alpinejs": "^3.7.1",
|
||||
"autoprefixer": "^10.4.1",
|
||||
"clsx": "^1.1.1",
|
||||
"compression": "^1.7.4",
|
||||
"cross-env": "^7.0.3",
|
||||
"cssnano": "^5.0.15",
|
||||
"esbuild": "^0.14.10",
|
||||
"esno": "^0.13.0",
|
||||
"express": "^4.17.2",
|
||||
"express-promise-router": "^4.1.1",
|
||||
"fast-glob": "^3.2.7",
|
||||
"gray-matter": "^4.0.3",
|
||||
"http-terminator": "^3.0.4",
|
||||
"markdown-it": "^12.3.0",
|
||||
"markdown-it-prism": "^2.2.1",
|
||||
"pino": "^7.6.2",
|
||||
"pino-colada": "^2.2.2",
|
||||
"pino-http": "^6.5.0",
|
||||
"postcss": "^8.4.5",
|
||||
"reacord": "workspace:*",
|
||||
"react": "^18.0.0-rc.0",
|
||||
"react-dom": "^18.0.0-rc.0",
|
||||
"react-ssr-prepass": "^1.5.0",
|
||||
"tailwindcss": "^3.0.8"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/browser-sync": "^2.26.3",
|
||||
"@types/compression": "^1.7.2",
|
||||
"@types/cssnano": "^5.0.0",
|
||||
"@types/express": "^4.17.13",
|
||||
"@types/markdown-it": "^12.2.3",
|
||||
"@types/node": "*",
|
||||
"@types/react": "^17.0.38",
|
||||
"@types/react-dom": "^17.0.9",
|
||||
"@types/tailwindcss": "^3.0.0",
|
||||
"@types/wait-on": "^5.3.1",
|
||||
"browser-sync": "^2.27.7",
|
||||
"execa": "^6.0.0",
|
||||
"nodemon": "^2.0.15",
|
||||
"npm-run-all": "^4.1.5",
|
||||
"rxjs": "^7.5.1",
|
||||
"tsup": "^5.11.10",
|
||||
"type-fest": "^2.8.0",
|
||||
"typedoc": "^0.22.10",
|
||||
"typescript": "^4.5.4",
|
||||
"wait-on": "^6.0.0"
|
||||
}
|
||||
}
|
||||
@@ -1,6 +0,0 @@
|
||||
module.exports = {
|
||||
plugins: {
|
||||
tailwindcss: {},
|
||||
autoprefixer: {},
|
||||
},
|
||||
}
|
||||
@@ -1,15 +0,0 @@
|
||||
// heroicons doesn't have "sideEffects": false in it's package json,
|
||||
// which causes esbuild to bundle in 460+ imports of react for some reason,
|
||||
// which causes memory issues
|
||||
import glob from "fast-glob"
|
||||
import { readFile, writeFile } from "node:fs/promises"
|
||||
|
||||
const files = await glob("node_modules/@heroicons/react/**/*.json", {
|
||||
absolute: true,
|
||||
})
|
||||
|
||||
for (const file of files) {
|
||||
const data = JSON.parse(await readFile(file, "utf8"))
|
||||
data.sideEffects = false
|
||||
await writeFile(file, JSON.stringify(data, undefined, 2))
|
||||
}
|
||||
@@ -1,10 +0,0 @@
|
||||
import { createContext, useContext } from "react"
|
||||
import type { AssetBuilder } from "../asset-builder/asset-builder.js"
|
||||
import { raise } from "../helpers/raise.js"
|
||||
|
||||
const Context = createContext<AssetBuilder>()
|
||||
|
||||
export const AssetBuilderProvider = Context.Provider
|
||||
|
||||
export const useAssetBuilder = () =>
|
||||
useContext(Context) ?? raise("AssetBuilderProvider not found")
|
||||
@@ -1,96 +0,0 @@
|
||||
import type { RequestHandler } from "express"
|
||||
import express from "express"
|
||||
import { createHash } from "node:crypto"
|
||||
import { mkdir, rm } from "node:fs/promises"
|
||||
import { join, parse } from "node:path"
|
||||
import React from "react"
|
||||
import { renderToStaticMarkup } from "react-dom/server"
|
||||
import ssrPrepass from "react-ssr-prepass"
|
||||
import type { Promisable } from "type-fest"
|
||||
import { ensureWrite, normalizeAsFilePath } from "../helpers/filesystem.js"
|
||||
import { AssetBuilderProvider } from "./asset-builder-context.js"
|
||||
|
||||
export type AssetTransformer<Asset> = {
|
||||
transform: (context: AssetTransformContext) => Promise<Asset>
|
||||
}
|
||||
|
||||
export class AssetBuilder {
|
||||
private constructor(private cacheFolder: string) {}
|
||||
|
||||
static async create(cacheFolder: string) {
|
||||
if (process.env.NODE_ENV !== "production") {
|
||||
await rm(cacheFolder, { recursive: true }).catch(() => {})
|
||||
}
|
||||
await mkdir(cacheFolder, { recursive: true })
|
||||
return new AssetBuilder(cacheFolder)
|
||||
}
|
||||
|
||||
async build<Asset>(
|
||||
input: Promisable<string | URL>,
|
||||
transformer: AssetTransformer<Asset>,
|
||||
alias?: string,
|
||||
): Promise<Asset> {
|
||||
const inputFile = normalizeAsFilePath(await input)
|
||||
// TODO: cache assets by inputFile in production
|
||||
|
||||
return transformer.transform(
|
||||
new AssetTransformContext({
|
||||
inputFile,
|
||||
cacheFolder: this.cacheFolder,
|
||||
alias: alias || parse(inputFile).name,
|
||||
}),
|
||||
)
|
||||
}
|
||||
|
||||
async render(element: React.ReactElement) {
|
||||
element = (
|
||||
<AssetBuilderProvider value={this}>
|
||||
<React.Suspense fallback={<></>}>{element}</React.Suspense>
|
||||
</AssetBuilderProvider>
|
||||
)
|
||||
await ssrPrepass(element)
|
||||
return `<!DOCTYPE html>\n${renderToStaticMarkup(element)}`
|
||||
}
|
||||
|
||||
middleware(): RequestHandler {
|
||||
return express.static(this.cacheFolder, {
|
||||
immutable: true,
|
||||
maxAge: "1y",
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
export type AssetTransformOptions = {
|
||||
inputFile: string
|
||||
cacheFolder: string
|
||||
alias: string
|
||||
}
|
||||
|
||||
export class AssetTransformContext {
|
||||
constructor(private options: AssetTransformOptions) {}
|
||||
|
||||
get inputFile() {
|
||||
return this.options.inputFile
|
||||
}
|
||||
|
||||
get cacheFolder() {
|
||||
return this.options.cacheFolder
|
||||
}
|
||||
|
||||
get alias() {
|
||||
return this.options.alias
|
||||
}
|
||||
|
||||
getOutputFileName(content: string) {
|
||||
const { ext } = parse(this.inputFile)
|
||||
const hash = createHash("sha256").update(content).digest("hex").slice(0, 8)
|
||||
return `${this.alias}.${hash}${ext}`
|
||||
}
|
||||
|
||||
async writeOutputFile(content: string) {
|
||||
const outputFileName = this.getOutputFileName(content)
|
||||
const outputFile = join(this.cacheFolder, outputFileName)
|
||||
await ensureWrite(outputFile, content)
|
||||
return { outputFileName, outputFile }
|
||||
}
|
||||
}
|
||||
@@ -1,75 +0,0 @@
|
||||
import type { ReactNode } from "react";
|
||||
import React from "react"
|
||||
import { normalizeAsFilePath } from "../helpers/filesystem.js"
|
||||
import { useAssetBuilder } from "./asset-builder-context.js"
|
||||
import type { AssetBuilder, AssetTransformer } from "./asset-builder.js"
|
||||
|
||||
type AssetState =
|
||||
| { status: "building"; promise: Promise<unknown> }
|
||||
| { status: "built"; asset: unknown }
|
||||
|
||||
const cache = new Map<string, AssetState>()
|
||||
|
||||
function useAssetBuild<Asset>(
|
||||
cacheKey: string,
|
||||
build: (builder: AssetBuilder) => Promise<Asset>,
|
||||
) {
|
||||
const builder = useAssetBuilder()
|
||||
|
||||
const state = cache.get(cacheKey)
|
||||
if (!state) {
|
||||
const promise = build(builder).then((asset) => {
|
||||
cache.set(cacheKey, { status: "built", asset })
|
||||
})
|
||||
|
||||
cache.set(cacheKey, { status: "building", promise })
|
||||
throw promise
|
||||
}
|
||||
|
||||
if (state.status === "building") {
|
||||
throw state.promise
|
||||
}
|
||||
|
||||
return state.asset as Asset
|
||||
}
|
||||
|
||||
export function LocalFileAsset<Asset>({
|
||||
from,
|
||||
using: transformer,
|
||||
as: alias,
|
||||
children,
|
||||
}: {
|
||||
from: string | URL
|
||||
using: AssetTransformer<Asset>
|
||||
as?: string
|
||||
children: (url: Asset) => ReactNode
|
||||
}) {
|
||||
const inputFile = normalizeAsFilePath(from)
|
||||
|
||||
const asset = useAssetBuild(inputFile, (builder) => {
|
||||
return builder.build(inputFile, transformer, alias)
|
||||
})
|
||||
|
||||
return <>{children(asset)}</>
|
||||
}
|
||||
|
||||
export function ModuleAsset<Asset>({
|
||||
from,
|
||||
using: transformer,
|
||||
as: name,
|
||||
children,
|
||||
}: {
|
||||
from: string
|
||||
using: AssetTransformer<Asset>
|
||||
as?: string
|
||||
children: (url: Asset) => ReactNode
|
||||
}) {
|
||||
const cacheKey = `node:${from}`
|
||||
|
||||
const asset = useAssetBuild(cacheKey, async (builder) => {
|
||||
const inputFile = await import.meta.resolve!(from)
|
||||
return await builder.build(inputFile, transformer, name)
|
||||
})
|
||||
|
||||
return <>{children(asset)}</>
|
||||
}
|
||||
@@ -1,29 +0,0 @@
|
||||
import grayMatter from "gray-matter"
|
||||
import MarkdownIt from "markdown-it"
|
||||
import prism from "markdown-it-prism"
|
||||
import { readFile } from "node:fs/promises"
|
||||
import type { AssetTransformer } from "./asset-builder.jsx"
|
||||
|
||||
const renderer = new MarkdownIt({
|
||||
html: true,
|
||||
linkify: true,
|
||||
}).use(prism)
|
||||
|
||||
export type MarkdownAsset = {
|
||||
content: { __html: string }
|
||||
data: Record<string, any>
|
||||
}
|
||||
|
||||
export const markdownTransformer: AssetTransformer<MarkdownAsset> = {
|
||||
async transform(context) {
|
||||
const { data, content } = grayMatter(
|
||||
await readFile(context.inputFile, "utf8"),
|
||||
)
|
||||
const html = renderer.render(content)
|
||||
|
||||
return {
|
||||
content: { __html: html },
|
||||
data,
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -1,26 +0,0 @@
|
||||
import { build } from "esbuild"
|
||||
import type { AssetTransformer } from "./asset-builder.jsx"
|
||||
|
||||
type ScriptAsset = {
|
||||
url: string
|
||||
}
|
||||
|
||||
export const scriptTransformer: AssetTransformer<ScriptAsset> = {
|
||||
async transform(context) {
|
||||
const scriptBuild = await build({
|
||||
entryPoints: [context.inputFile],
|
||||
bundle: true,
|
||||
target: ["chrome89", "firefox89"],
|
||||
format: "esm",
|
||||
write: false,
|
||||
minify: process.env.NODE_ENV === "production",
|
||||
})
|
||||
|
||||
const content = scriptBuild.outputFiles[0]!.text
|
||||
const { outputFileName } = await context.writeOutputFile(content)
|
||||
|
||||
return {
|
||||
url: "/" + outputFileName,
|
||||
}
|
||||
},
|
||||
}
|
||||
@@ -1,26 +0,0 @@
|
||||
import autoprefixer from "autoprefixer"
|
||||
import cssnano from "cssnano"
|
||||
import { readFile } from "node:fs/promises"
|
||||
import type { AcceptedPlugin } from "postcss"
|
||||
import postcss from "postcss"
|
||||
import tailwindcss from "tailwindcss"
|
||||
import type { AssetTransformer } from "./asset-builder.jsx"
|
||||
|
||||
export type StylesheetAsset = { url: string }
|
||||
|
||||
export const stylesheetTransformer: AssetTransformer<StylesheetAsset> = {
|
||||
async transform(context) {
|
||||
const plugins: AcceptedPlugin[] = [tailwindcss, autoprefixer]
|
||||
if (process.env.NODE_ENV === "production") {
|
||||
plugins.push(cssnano)
|
||||
}
|
||||
|
||||
const result = await postcss(plugins).process(
|
||||
await readFile(context.inputFile),
|
||||
{ from: context.inputFile },
|
||||
)
|
||||
|
||||
const { outputFileName } = await context.writeOutputFile(result.css)
|
||||
return { url: "/" + outputFileName }
|
||||
},
|
||||
}
|
||||
@@ -1,7 +0,0 @@
|
||||
import { join } from "node:path"
|
||||
|
||||
const projectRoot = new URL("../", import.meta.url).pathname
|
||||
|
||||
export function fromProjectRoot(...subPaths: string[]) {
|
||||
return join(projectRoot, ...subPaths)
|
||||
}
|
||||
@@ -1,56 +0,0 @@
|
||||
import clsx from "clsx"
|
||||
import React from "react"
|
||||
import { LocalFileAsset } from "../asset-builder/asset.js"
|
||||
import { markdownTransformer } from "../asset-builder/markdown-transformer.js"
|
||||
import { Html } from "../html.js"
|
||||
import { AppLink } from "../navigation/app-link"
|
||||
import { guideLinks } from "../navigation/guide-links"
|
||||
import { MainNavigation } from "../navigation/main-navigation"
|
||||
import { docsProseClass, linkClass, maxWidthContainer } from "../ui/components"
|
||||
|
||||
export function GuidePage({ url }: { url: string }) {
|
||||
return (
|
||||
<LocalFileAsset
|
||||
from={new URL(`${url}.md`, import.meta.url)}
|
||||
using={markdownTransformer}
|
||||
>
|
||||
{(asset) => (
|
||||
<Html title={asset.data.title} description={asset.data.description}>
|
||||
<Header />
|
||||
<Body content={asset.content} />
|
||||
</Html>
|
||||
)}
|
||||
</LocalFileAsset>
|
||||
)
|
||||
}
|
||||
|
||||
function Header() {
|
||||
return (
|
||||
<header className="bg-slate-700/30 shadow sticky top-0 backdrop-blur-sm transition z-10 flex">
|
||||
<div className={maxWidthContainer}>
|
||||
<MainNavigation />
|
||||
</div>
|
||||
</header>
|
||||
)
|
||||
}
|
||||
|
||||
function Body({ content }: { content: { __html: string } }) {
|
||||
return (
|
||||
<main className={clsx(maxWidthContainer, "mt-8 flex items-start gap-4")}>
|
||||
<nav className="w-48 sticky top-24 hidden md:block">
|
||||
<h2 className="text-2xl">Guides</h2>
|
||||
<ul className="mt-3 flex flex-col gap-2 items-start">
|
||||
{guideLinks.map((link) => (
|
||||
<li key={link.to}>
|
||||
<AppLink {...link} className={linkClass} />
|
||||
</li>
|
||||
))}
|
||||
</ul>
|
||||
</nav>
|
||||
<section
|
||||
className={clsx(docsProseClass, "pb-8 flex-1 min-w-0")}
|
||||
dangerouslySetInnerHTML={content}
|
||||
/>
|
||||
</main>
|
||||
)
|
||||
}
|
||||
@@ -1,11 +0,0 @@
|
||||
import { mkdir, writeFile } from "node:fs/promises"
|
||||
import { dirname } from "node:path"
|
||||
|
||||
export async function ensureWrite(file: string, content: string) {
|
||||
await mkdir(dirname(file), { recursive: true })
|
||||
await writeFile(file, content)
|
||||
}
|
||||
|
||||
export function normalizeAsFilePath(file: string | URL) {
|
||||
return new URL(file, "file:").pathname
|
||||
}
|
||||
@@ -1,15 +0,0 @@
|
||||
import grayMatter from "gray-matter"
|
||||
import MarkdownIt from "markdown-it"
|
||||
import prism from "markdown-it-prism"
|
||||
import { readFile } from "node:fs/promises"
|
||||
|
||||
const renderer = new MarkdownIt({
|
||||
html: true,
|
||||
linkify: true,
|
||||
}).use(prism)
|
||||
|
||||
export async function renderMarkdownFile(filePath: string) {
|
||||
const { data, content } = grayMatter(await readFile(filePath, "utf8"))
|
||||
const html = renderer.render(content)
|
||||
return { html, data }
|
||||
}
|
||||
@@ -1,70 +0,0 @@
|
||||
import packageJson from "reacord/package.json"
|
||||
import type { ReactNode } from "react"
|
||||
import React from "react"
|
||||
import { LocalFileAsset, ModuleAsset } from "./asset-builder/asset.js"
|
||||
import { scriptTransformer } from "./asset-builder/script-transformer.js"
|
||||
import { stylesheetTransformer } from "./asset-builder/stylesheet-transformer.js"
|
||||
|
||||
export function Html({
|
||||
title: titleProp,
|
||||
description = packageJson.description,
|
||||
children,
|
||||
}: {
|
||||
title?: string
|
||||
description?: string
|
||||
children: ReactNode
|
||||
}) {
|
||||
const title = [titleProp, "Reacord"].filter(Boolean).join(" | ")
|
||||
return (
|
||||
<html lang="en" className="bg-slate-900 text-slate-100">
|
||||
<head>
|
||||
<meta charSet="utf-8" />
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||
<meta name="description" content={description} />
|
||||
|
||||
<link rel="preconnect" href="https://fonts.googleapis.com" />
|
||||
<link
|
||||
rel="preconnect"
|
||||
href="https://fonts.gstatic.com"
|
||||
crossOrigin=""
|
||||
/>
|
||||
<link
|
||||
rel="preload"
|
||||
as="style"
|
||||
href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@500&family=Rubik:ital,wght@0,300;0,400;0,500;1,300;1,400;1,500&display=swap"
|
||||
/>
|
||||
|
||||
<ModuleAsset
|
||||
from="tailwindcss/tailwind.css"
|
||||
using={stylesheetTransformer}
|
||||
>
|
||||
{(asset) => <link rel="stylesheet" href={asset.url} />}
|
||||
</ModuleAsset>
|
||||
|
||||
<LocalFileAsset
|
||||
from={new URL("ui/prism-theme.css", import.meta.url)}
|
||||
using={stylesheetTransformer}
|
||||
>
|
||||
{(asset) => <link rel="stylesheet" href={asset.url} />}
|
||||
</LocalFileAsset>
|
||||
<LocalFileAsset
|
||||
from={new URL("ui/markdown.css", import.meta.url)}
|
||||
using={stylesheetTransformer}
|
||||
>
|
||||
{(asset) => <link rel="stylesheet" href={asset.url} />}
|
||||
</LocalFileAsset>
|
||||
|
||||
<title>{title}</title>
|
||||
|
||||
<ModuleAsset
|
||||
from="alpinejs/dist/cdn.js"
|
||||
as="alpine"
|
||||
using={scriptTransformer}
|
||||
>
|
||||
{(asset) => <script defer src={asset.url} />}
|
||||
</ModuleAsset>
|
||||
</head>
|
||||
<body>{children}</body>
|
||||
</html>
|
||||
)
|
||||
}
|
||||
@@ -1,19 +0,0 @@
|
||||
<!-- prettier-ignore -->
|
||||
```tsx
|
||||
import * as React from "react"
|
||||
import { Embed, Button } from "reacord"
|
||||
|
||||
function Counter() {
|
||||
const [count, setCount] = React.useState(0)
|
||||
return (
|
||||
<>
|
||||
<Embed title="Counter">
|
||||
This button has been clicked {count} times.
|
||||
</Embed>
|
||||
<Button onClick={() => setCount(count + 1)}>
|
||||
+1
|
||||
</Button>
|
||||
</>
|
||||
)
|
||||
}
|
||||
```
|
||||
@@ -1,42 +0,0 @@
|
||||
import packageJson from "reacord/package.json"
|
||||
import React from "react"
|
||||
import { LocalFileAsset } from "../asset-builder/asset.js"
|
||||
import { markdownTransformer } from "../asset-builder/markdown-transformer.js"
|
||||
import { Html } from "../html.js"
|
||||
import { MainNavigation } from "../navigation/main-navigation"
|
||||
import { maxWidthContainer } from "../ui/components"
|
||||
|
||||
export function Landing() {
|
||||
return (
|
||||
<Html>
|
||||
<div className="flex flex-col min-w-0 min-h-screen text-center">
|
||||
<header className={maxWidthContainer}>
|
||||
<MainNavigation />
|
||||
</header>
|
||||
<div className="px-4 pb-8 flex flex-1">
|
||||
<main className="px-4 py-6 rounded-lg shadow bg-slate-800 space-y-5 m-auto w-full max-w-xl">
|
||||
<h1 className="text-6xl font-light">reacord</h1>
|
||||
<LocalFileAsset
|
||||
from={new URL("landing-example.md", import.meta.url)}
|
||||
using={markdownTransformer}
|
||||
>
|
||||
{(asset) => (
|
||||
<section
|
||||
className="mx-auto text-sm sm:text-base"
|
||||
dangerouslySetInnerHTML={asset.content}
|
||||
/>
|
||||
)}
|
||||
</LocalFileAsset>
|
||||
<p className="text-2xl font-light">{packageJson.description}</p>
|
||||
<a
|
||||
href="/guides/getting-started"
|
||||
className="inline-block px-4 py-3 text-xl transition rounded-lg bg-emerald-700 hover:translate-y-[-2px] hover:bg-emerald-800 hover:shadow"
|
||||
>
|
||||
Get Started
|
||||
</a>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</Html>
|
||||
)
|
||||
}
|
||||
@@ -1,61 +0,0 @@
|
||||
import compression from "compression"
|
||||
import type { ErrorRequestHandler, Request } from "express"
|
||||
import express from "express"
|
||||
import PromiseRouter from "express-promise-router"
|
||||
import httpTerminator from "http-terminator"
|
||||
import pino from "pino"
|
||||
import pinoHttp from "pino-http"
|
||||
import * as React from "react"
|
||||
import { AssetBuilder } from "./asset-builder/asset-builder.js"
|
||||
import { fromProjectRoot } from "./constants"
|
||||
import { GuidePage } from "./guides/guide-page"
|
||||
import { Landing } from "./landing/landing"
|
||||
|
||||
const port = process.env.PORT || 3000
|
||||
const builder = await AssetBuilder.create(fromProjectRoot(".asset-cache"))
|
||||
const logger = pino()
|
||||
|
||||
const errorHandler: ErrorRequestHandler = (error, request, response, next) => {
|
||||
response.status(500).send(error.message)
|
||||
logger.error(error)
|
||||
}
|
||||
|
||||
const router = PromiseRouter()
|
||||
.use(pinoHttp({ logger }))
|
||||
.use(compression())
|
||||
.use(builder.middleware())
|
||||
.use("/api", express.static("dist/api"))
|
||||
|
||||
.get("/guides/*", async (req: Request<{ 0: string }>, res) => {
|
||||
res
|
||||
.type("html")
|
||||
.send(await builder.render(<GuidePage url={req.params[0]} />))
|
||||
})
|
||||
|
||||
.get("/", async (req, res) => {
|
||||
res.type("html").send(await builder.render(<Landing />))
|
||||
})
|
||||
|
||||
.use(errorHandler)
|
||||
|
||||
const server = express()
|
||||
.use(router)
|
||||
.listen(port, () => {
|
||||
logger.info(`Server is running on http://localhost:${port}`)
|
||||
})
|
||||
|
||||
const terminator = httpTerminator.createHttpTerminator({ server })
|
||||
|
||||
process.on("SIGINT", () => {
|
||||
terminator
|
||||
.terminate()
|
||||
.then(() => {
|
||||
logger.info("Server terminated")
|
||||
})
|
||||
.catch((error) => {
|
||||
logger.error(error)
|
||||
})
|
||||
.finally(() => {
|
||||
process.exit()
|
||||
})
|
||||
})
|
||||
@@ -1,27 +0,0 @@
|
||||
import React from "react"
|
||||
import { ExternalLink } from "../dom/external-link"
|
||||
|
||||
export type AppLinkProps = {
|
||||
type: "internal" | "external"
|
||||
label: React.ReactNode
|
||||
to: string
|
||||
className?: string
|
||||
}
|
||||
|
||||
export function AppLink(props: AppLinkProps) {
|
||||
switch (props.type) {
|
||||
case "internal":
|
||||
return (
|
||||
<a className={props.className} href={props.to}>
|
||||
{props.label}
|
||||
</a>
|
||||
)
|
||||
|
||||
case "external":
|
||||
return (
|
||||
<ExternalLink className={props.className} href={props.to}>
|
||||
{props.label}
|
||||
</ExternalLink>
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -1,34 +0,0 @@
|
||||
import glob from "fast-glob"
|
||||
import grayMatter from "gray-matter"
|
||||
import { readFile } from "node:fs/promises"
|
||||
import { join } from "node:path"
|
||||
import type { AppLinkProps } from "./app-link"
|
||||
|
||||
const docsFolder = new URL("../guides", import.meta.url).pathname
|
||||
const guideFiles = await glob("**/*.md", { cwd: docsFolder })
|
||||
|
||||
const entries = await Promise.all(
|
||||
guideFiles.map(async (file) => {
|
||||
const content = await readFile(join(docsFolder, file), "utf-8")
|
||||
const { data } = grayMatter(content)
|
||||
|
||||
let order = Number(data.order)
|
||||
if (!Number.isFinite(order)) {
|
||||
order = Number.POSITIVE_INFINITY
|
||||
}
|
||||
|
||||
return {
|
||||
route: `/guides/${file.replace(/\.mdx?$/, "")}`,
|
||||
title: String(data.title || ""),
|
||||
order,
|
||||
}
|
||||
}),
|
||||
)
|
||||
|
||||
export const guideLinks: AppLinkProps[] = entries
|
||||
.sort((a, b) => a.order - b.order)
|
||||
.map((item) => ({
|
||||
type: "internal",
|
||||
label: item.title,
|
||||
to: item.route,
|
||||
}))
|
||||
@@ -1,40 +0,0 @@
|
||||
import React from "react"
|
||||
import { linkClass } from "../ui/components"
|
||||
import { PopoverMenu } from "../ui/popover-menu"
|
||||
import { AppLink } from "./app-link"
|
||||
import { guideLinks } from "./guide-links"
|
||||
import { mainLinks } from "./main-links"
|
||||
|
||||
export function MainNavigation() {
|
||||
return (
|
||||
<nav className="flex justify-between items-center h-16">
|
||||
<a href="/">
|
||||
<h1 className="text-3xl font-light">reacord</h1>
|
||||
</a>
|
||||
<div className="hidden md:flex gap-4">
|
||||
{mainLinks.map((link) => (
|
||||
<AppLink {...link} key={link.to} className={linkClass} />
|
||||
))}
|
||||
</div>
|
||||
<div className="md:hidden" id="main-navigation-popover">
|
||||
<PopoverMenu>
|
||||
{mainLinks.map((link) => (
|
||||
<AppLink
|
||||
{...link}
|
||||
key={link.to}
|
||||
className={PopoverMenu.itemClass}
|
||||
/>
|
||||
))}
|
||||
<hr className="border-0 h-[2px] bg-black/50" />
|
||||
{guideLinks.map((link) => (
|
||||
<AppLink
|
||||
{...link}
|
||||
key={link.to}
|
||||
className={PopoverMenu.itemClass}
|
||||
/>
|
||||
))}
|
||||
</PopoverMenu>
|
||||
</div>
|
||||
</nav>
|
||||
)
|
||||
}
|
||||
10
packages/docs/src/react.d.ts
vendored
10
packages/docs/src/react.d.ts
vendored
@@ -1,10 +0,0 @@
|
||||
import "react"
|
||||
declare module "react" {
|
||||
export function createContext<Value>(): Context<Value | undefined>
|
||||
}
|
||||
|
||||
declare module "react-dom" {
|
||||
export function createRoot(element: Element): {
|
||||
render(element: React.ReactNode): void
|
||||
}
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
import clsx from "clsx"
|
||||
|
||||
export const maxWidthContainer = clsx`mx-auto w-full max-w-screen-lg px-4`
|
||||
|
||||
export const inlineIconClass = clsx`inline w-5 align-sub`
|
||||
|
||||
export const linkClass = clsx`
|
||||
font-medium inline-block relative
|
||||
opacity-60 hover:opacity-100 transition-opacity
|
||||
after:absolute after:block after:w-full after:h-px after:bg-white/50 after:translate-y-[3px] after:opacity-0 after:transition
|
||||
hover:after:translate-y-[-1px] hover:after:opacity-100
|
||||
`
|
||||
|
||||
export const docsProseClass = clsx`
|
||||
prose prose-invert
|
||||
prose-h1:font-light prose-h1:mb-4 prose-h1:text-3xl lg:prose-h1:text-4xl
|
||||
prose-h2:font-light
|
||||
prose-h3:font-light
|
||||
prose-p:my-4
|
||||
prose-a:font-medium prose-a:text-emerald-400 hover:prose-a:no-underline
|
||||
prose-strong:font-medium prose-strong:text-emerald-400
|
||||
prose-pre:font-monospace prose-pre:overflow-x-auto
|
||||
max-w-none
|
||||
`
|
||||
@@ -1,3 +0,0 @@
|
||||
.prose aside {
|
||||
@apply opacity-75 italic border-l-4 pl-3 border-white/50;
|
||||
}
|
||||
@@ -1,38 +0,0 @@
|
||||
import clsx from "clsx"
|
||||
|
||||
const menus = document.querySelectorAll("[data-popover]")
|
||||
|
||||
for (const menu of menus) {
|
||||
const button = menu.querySelector<HTMLButtonElement>("[data-popover-button]")!
|
||||
|
||||
const panel = menu.querySelector<HTMLDivElement>("[data-popover-panel]")!
|
||||
const panelClasses = clsx`${panel.className} transition-all`
|
||||
|
||||
const visibleClass = clsx`${panelClasses} visible opacity-100 translate-y-0`
|
||||
const hiddenClass = clsx`${panelClasses} invisible opacity-0 translate-y-2`
|
||||
|
||||
let visible = false
|
||||
|
||||
const setVisible = (newVisible: boolean) => {
|
||||
visible = newVisible
|
||||
panel.className = visible ? visibleClass : hiddenClass
|
||||
|
||||
if (!visible) return
|
||||
|
||||
requestAnimationFrame(() => {
|
||||
const handleClose = (event: MouseEvent) => {
|
||||
if (panel.contains(event.target as Node)) return
|
||||
setVisible(false)
|
||||
window.removeEventListener("click", handleClose)
|
||||
}
|
||||
window.addEventListener("click", handleClose)
|
||||
})
|
||||
}
|
||||
|
||||
const toggleVisible = () => setVisible(!visible)
|
||||
|
||||
button.addEventListener("click", toggleVisible)
|
||||
|
||||
setVisible(false)
|
||||
panel.hidden = false
|
||||
}
|
||||
@@ -1,31 +0,0 @@
|
||||
import { MenuAlt4Icon } from "@heroicons/react/outline/esm"
|
||||
import clsx from "clsx"
|
||||
import React from "react"
|
||||
import { linkClass } from "./components"
|
||||
|
||||
export function PopoverMenu({ children }: { children: React.ReactNode }) {
|
||||
return (
|
||||
<div className="relative" x-data="{ open: false }">
|
||||
<button title="Menu" className={linkClass} x-on:click="open = !open">
|
||||
<MenuAlt4Icon className="w-6" />
|
||||
</button>
|
||||
<div
|
||||
className={`
|
||||
w-48 max-h-[calc(100vh-4rem)]
|
||||
absolute right-0 top-[calc(100%+8px)]
|
||||
bg-slate-800 shadow rounded-lg
|
||||
overflow-hidden overflow-y-auto
|
||||
transition-all
|
||||
`}
|
||||
x-bind:class="open ? 'visible opacity-100' : 'invisible opacity-0 translate-y-3'"
|
||||
>
|
||||
{children}
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
PopoverMenu.itemClass = clsx`
|
||||
px-3 py-2 transition text-left font-medium block
|
||||
opacity-50 hover:opacity-100 hover:bg-black/30
|
||||
`
|
||||
@@ -1,3 +0,0 @@
|
||||
{
|
||||
"extends": "../../tsconfig.base.json"
|
||||
}
|
||||
2
packages/reacord/.gitignore
vendored
Normal file
2
packages/reacord/.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
/README.md
|
||||
/LICENSE
|
||||
7
packages/reacord/CHANGELOG.md
Normal file
7
packages/reacord/CHANGELOG.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# reacord
|
||||
|
||||
## 0.5.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- aa65da5: allow JSX in more places
|
||||
@@ -2,6 +2,7 @@ import type {
|
||||
CamelCasedPropertiesDeep,
|
||||
SnakeCasedPropertiesDeep,
|
||||
} from "type-fest"
|
||||
import { expect, test } from "vitest"
|
||||
import { camelCaseDeep, snakeCaseDeep } from "./convert-object-property-case"
|
||||
|
||||
test("camelCaseDeep", () => {
|
||||
@@ -12,12 +13,14 @@ test("camelCaseDeep", () => {
|
||||
someOtherProp: "someOtherValue",
|
||||
}
|
||||
|
||||
expect(camelCaseDeep(input)).toEqual<CamelCasedPropertiesDeep<typeof input>>({
|
||||
const expected: CamelCasedPropertiesDeep<typeof input> = {
|
||||
someProp: {
|
||||
someDeepProp: "some_deep_value",
|
||||
},
|
||||
someOtherProp: "someOtherValue",
|
||||
})
|
||||
}
|
||||
|
||||
expect(camelCaseDeep(input)).toEqual(expected)
|
||||
})
|
||||
|
||||
test("snakeCaseDeep", () => {
|
||||
@@ -28,10 +31,12 @@ test("snakeCaseDeep", () => {
|
||||
some_other_prop: "someOtherValue",
|
||||
}
|
||||
|
||||
expect(snakeCaseDeep(input)).toEqual<SnakeCasedPropertiesDeep<typeof input>>({
|
||||
const expected: SnakeCasedPropertiesDeep<typeof input> = {
|
||||
some_prop: {
|
||||
some_deep_prop: "someDeepValue",
|
||||
},
|
||||
some_other_prop: "someOtherValue",
|
||||
})
|
||||
}
|
||||
|
||||
expect(snakeCaseDeep(input)).toEqual(expected)
|
||||
})
|
||||
|
||||
7
packages/reacord/helpers/is-object.ts
Normal file
7
packages/reacord/helpers/is-object.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
export function isObject<T>(
|
||||
value: T,
|
||||
): value is Exclude<T, Primitive | AnyFunction> {
|
||||
return typeof value === "object" && value !== null
|
||||
}
|
||||
type Primitive = string | number | boolean | undefined | null
|
||||
type AnyFunction = (...args: any[]) => any
|
||||
@@ -1,6 +1,5 @@
|
||||
import { inspect } from "node:util"
|
||||
|
||||
// eslint-disable-next-line import/no-unused-modules
|
||||
export function logPretty(value: unknown) {
|
||||
console.info(
|
||||
inspect(value, {
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
// eslint-disable-next-line import/no-unused-modules
|
||||
export function omit<Subject extends object, Key extends PropertyKey>(
|
||||
subject: Subject,
|
||||
keys: Key[],
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import type { LoosePick, UnknownRecord } from "./types"
|
||||
|
||||
// eslint-disable-next-line import/no-unused-modules
|
||||
export function pick<T, K extends keyof T | PropertyKey>(
|
||||
object: T,
|
||||
keys: K[],
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
export function pruneNullishValues<T extends object>(
|
||||
object: T,
|
||||
): PruneNullishValues<T> {
|
||||
const result: any = {}
|
||||
for (const [key, value] of Object.entries(object)) {
|
||||
if (value != undefined) {
|
||||
result[key] = value
|
||||
}
|
||||
}
|
||||
return result
|
||||
}
|
||||
|
||||
type PruneNullishValues<T> = {
|
||||
[Key in keyof T]: NonNullable<T[Key]>
|
||||
}
|
||||
35
packages/reacord/helpers/prune-nullish-values.test.ts
Normal file
35
packages/reacord/helpers/prune-nullish-values.test.ts
Normal file
@@ -0,0 +1,35 @@
|
||||
import { expect, test } from "vitest"
|
||||
import type { PruneNullishValues } from "./prune-nullish-values"
|
||||
import { pruneNullishValues } from "./prune-nullish-values"
|
||||
|
||||
test("pruneNullishValues", () => {
|
||||
type InputType = {
|
||||
a: string
|
||||
b: string | null | undefined
|
||||
c?: string
|
||||
d: {
|
||||
a: string
|
||||
b: string | undefined
|
||||
}
|
||||
}
|
||||
|
||||
const input: InputType = {
|
||||
a: "a",
|
||||
// eslint-disable-next-line unicorn/no-null
|
||||
b: null,
|
||||
c: undefined,
|
||||
d: {
|
||||
a: "a",
|
||||
b: undefined,
|
||||
},
|
||||
}
|
||||
|
||||
const output: PruneNullishValues<InputType> = {
|
||||
a: "a",
|
||||
d: {
|
||||
a: "a",
|
||||
},
|
||||
}
|
||||
|
||||
expect(pruneNullishValues(input)).toEqual(output)
|
||||
})
|
||||
42
packages/reacord/helpers/prune-nullish-values.ts
Normal file
42
packages/reacord/helpers/prune-nullish-values.ts
Normal file
@@ -0,0 +1,42 @@
|
||||
import { isObject } from "./is-object"
|
||||
|
||||
export function pruneNullishValues<T>(input: T): PruneNullishValues<T> {
|
||||
if (Array.isArray(input)) {
|
||||
return input.filter(Boolean).map((item) => pruneNullishValues(item)) as any
|
||||
}
|
||||
|
||||
if (!isObject(input)) {
|
||||
return input as any
|
||||
}
|
||||
|
||||
const result: any = {}
|
||||
for (const [key, value] of Object.entries(input)) {
|
||||
if (value != undefined) {
|
||||
result[key] = pruneNullishValues(value)
|
||||
}
|
||||
}
|
||||
return result
|
||||
}
|
||||
|
||||
export type PruneNullishValues<Input> = Input extends object
|
||||
? OptionalKeys<
|
||||
{ [Key in keyof Input]: NonNullable<PruneNullishValues<Input[Key]>> },
|
||||
KeysWithNullishValues<Input>
|
||||
>
|
||||
: Input
|
||||
|
||||
type OptionalKeys<Input, Keys extends keyof Input> = Omit<Input, Keys> & {
|
||||
[Key in Keys]?: Input[Key]
|
||||
}
|
||||
|
||||
type KeysWithNullishValues<Input> = NonNullable<
|
||||
Values<{
|
||||
[Key in keyof Input]: null extends Input[Key]
|
||||
? Key
|
||||
: undefined extends Input[Key]
|
||||
? Key
|
||||
: never
|
||||
}>
|
||||
>
|
||||
|
||||
type Values<Input> = Input[keyof Input]
|
||||
@@ -6,5 +6,5 @@ export async function rejectAfter(
|
||||
error: unknown = `rejected after ${timeMs}ms`,
|
||||
): Promise<never> {
|
||||
await setTimeout(timeMs)
|
||||
return Promise.reject(toError(error))
|
||||
throw toError(error)
|
||||
}
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
/* eslint-disable import/no-unused-modules */
|
||||
export type MaybePromise<T> = T | Promise<T>
|
||||
|
||||
export type ValueOf<Type> = Type extends ReadonlyArray<infer Value>
|
||||
|
||||
21
packages/reacord/helpers/wait-for.ts
Normal file
21
packages/reacord/helpers/wait-for.ts
Normal file
@@ -0,0 +1,21 @@
|
||||
import { setTimeout } from "node:timers/promises"
|
||||
|
||||
const maxTime = 1000
|
||||
|
||||
export async function waitFor<Result>(
|
||||
predicate: () => Result,
|
||||
): Promise<Awaited<Result>> {
|
||||
const startTime = Date.now()
|
||||
let lastError: unknown
|
||||
|
||||
while (Date.now() - startTime < maxTime) {
|
||||
try {
|
||||
return await predicate()
|
||||
} catch (error) {
|
||||
lastError = error
|
||||
await setTimeout(50)
|
||||
}
|
||||
}
|
||||
|
||||
throw lastError ?? new Error("Timeout")
|
||||
}
|
||||
@@ -1,6 +1,5 @@
|
||||
import { inspect } from "node:util"
|
||||
|
||||
// eslint-disable-next-line import/no-unused-modules
|
||||
export function withLoggedMethodCalls<T extends object>(value: T) {
|
||||
return new Proxy(value as Record<string | symbol, unknown>, {
|
||||
get(target, property) {
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
/** @type {import('@jest/types').Config.InitialOptions} */
|
||||
const config = {
|
||||
transform: {
|
||||
"^.+\\.[jt]sx?$": ["esbuild-jest", { format: "esm", sourcemap: true }],
|
||||
},
|
||||
extensionsToTreatAsEsm: [".ts", ".tsx"],
|
||||
moduleNameMapper: {
|
||||
"^(\\.\\.?/.+)\\.jsx?$": "$1",
|
||||
},
|
||||
verbose: true,
|
||||
cache: false,
|
||||
coverageReporters: ["text", "text-summary", "html"],
|
||||
coveragePathIgnorePatterns: ["discord-js-adapter", "test/setup-testing"],
|
||||
}
|
||||
export default config
|
||||
@@ -5,11 +5,41 @@ 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
|
||||
}
|
||||
|
||||
|
||||
@@ -21,9 +21,9 @@ export type ActionRowProps = {
|
||||
* ```tsx
|
||||
* // put buttons on two separate rows
|
||||
* <ActionRow>
|
||||
* <Button onClick={handleFirst}>First</Button>
|
||||
* <Button label="First" onClick={handleFirst} />
|
||||
* </ActionRow>
|
||||
* <Button onClick={handleSecond}>Second</Button>
|
||||
* <Button label="Second" onClick={handleSecond} />
|
||||
* ```
|
||||
*
|
||||
* @category Action Row
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
import type { ReactNode } from "react"
|
||||
|
||||
/**
|
||||
* Common props between button-like components
|
||||
* @category Button
|
||||
*/
|
||||
export type ButtonSharedProps = {
|
||||
/** The text on the button. Rich formatting (markdown) is not supported here. */
|
||||
label?: ReactNode
|
||||
|
||||
/** When true, the button will be slightly faded, and cannot be clicked. */
|
||||
disabled?: boolean
|
||||
|
||||
/**
|
||||
* Renders an emoji to the left of the text.
|
||||
* Has to be a literal emoji character (e.g. 🍍),
|
||||
* or an emoji code, like `<:plus_one:778531744860602388>`.
|
||||
*
|
||||
* To get an emoji code, type your emoji in Discord chat
|
||||
* with a backslash `\` in front.
|
||||
* The bot has to be in the emoji's guild to use it.
|
||||
*/
|
||||
emoji?: string
|
||||
}
|
||||
@@ -6,17 +6,24 @@ 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 = {
|
||||
label?: string
|
||||
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"
|
||||
disabled?: boolean
|
||||
emoji?: string
|
||||
|
||||
/**
|
||||
* Happens when a user clicks the button.
|
||||
*/
|
||||
onClick: (event: ButtonClickEvent) => void
|
||||
}
|
||||
|
||||
/**
|
||||
* @category Button
|
||||
*/
|
||||
@@ -27,13 +34,23 @@ export type ButtonClickEvent = ComponentEvent
|
||||
*/
|
||||
export function Button(props: ButtonProps) {
|
||||
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> {
|
||||
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 {
|
||||
getNextActionRow(options).push({
|
||||
type: "button",
|
||||
@@ -41,7 +58,7 @@ class ButtonNode extends Node<ButtonProps> {
|
||||
style: this.props.style ?? "secondary",
|
||||
disabled: this.props.disabled,
|
||||
emoji: this.props.emoji,
|
||||
label: this.props.label,
|
||||
label: this.children.findType(ButtonLabelNode)?.text,
|
||||
})
|
||||
}
|
||||
|
||||
@@ -56,3 +73,5 @@ class ButtonNode extends Node<ButtonProps> {
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
class ButtonLabelNode extends Node<{}> {}
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
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"
|
||||
|
||||
@@ -7,8 +9,8 @@ import type { EmbedOptions } from "./embed-options"
|
||||
* @category Embed
|
||||
*/
|
||||
export type EmbedAuthorProps = {
|
||||
name?: string
|
||||
children?: string
|
||||
name?: ReactNode
|
||||
children?: ReactNode
|
||||
url?: string
|
||||
iconUrl?: string
|
||||
}
|
||||
@@ -18,19 +20,22 @@ export type EmbedAuthorProps = {
|
||||
*/
|
||||
export function EmbedAuthor(props: EmbedAuthorProps) {
|
||||
return (
|
||||
<ReacordElement
|
||||
props={props}
|
||||
createNode={() => new EmbedAuthorNode(props)}
|
||||
/>
|
||||
<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.props.name ?? this.props.children ?? "",
|
||||
name: this.children.findType(AuthorTextNode)?.text ?? "",
|
||||
url: this.props.url,
|
||||
icon_url: this.props.iconUrl,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
class AuthorTextNode extends Node<{}> {}
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
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"
|
||||
|
||||
@@ -7,10 +9,10 @@ import type { EmbedOptions } from "./embed-options"
|
||||
* @category Embed
|
||||
*/
|
||||
export type EmbedFieldProps = {
|
||||
name: string
|
||||
value?: string
|
||||
name: ReactNode
|
||||
value?: ReactNode
|
||||
inline?: boolean
|
||||
children?: string
|
||||
children?: ReactNode
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -18,10 +20,14 @@ export type EmbedFieldProps = {
|
||||
*/
|
||||
export function EmbedField(props: EmbedFieldProps) {
|
||||
return (
|
||||
<ReacordElement
|
||||
props={props}
|
||||
createNode={() => new EmbedFieldNode(props)}
|
||||
/>
|
||||
<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>
|
||||
)
|
||||
}
|
||||
|
||||
@@ -29,9 +35,12 @@ class EmbedFieldNode extends EmbedChildNode<EmbedFieldProps> {
|
||||
override modifyEmbedOptions(options: EmbedOptions): void {
|
||||
options.fields ??= []
|
||||
options.fields.push({
|
||||
name: this.props.name,
|
||||
value: this.props.value ?? this.props.children ?? "",
|
||||
name: this.children.findType(FieldNameNode)?.text ?? "",
|
||||
value: this.children.findType(FieldValueNode)?.text ?? "",
|
||||
inline: this.props.inline,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
class FieldNameNode extends Node<{}> {}
|
||||
class FieldValueNode extends Node<{}> {}
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
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"
|
||||
|
||||
@@ -7,8 +9,8 @@ import type { EmbedOptions } from "./embed-options"
|
||||
* @category Embed
|
||||
*/
|
||||
export type EmbedFooterProps = {
|
||||
text?: string
|
||||
children?: string
|
||||
text?: ReactNode
|
||||
children?: ReactNode
|
||||
iconUrl?: string
|
||||
timestamp?: string | number | Date
|
||||
}
|
||||
@@ -16,19 +18,22 @@ export type EmbedFooterProps = {
|
||||
/**
|
||||
* @category Embed
|
||||
*/
|
||||
export function EmbedFooter(props: EmbedFooterProps) {
|
||||
export function EmbedFooter({ text, children, ...props }: EmbedFooterProps) {
|
||||
return (
|
||||
<ReacordElement
|
||||
props={props}
|
||||
createNode={() => new EmbedFooterNode(props)}
|
||||
/>
|
||||
<ReacordElement props={props} createNode={() => new EmbedFooterNode(props)}>
|
||||
<ReacordElement props={{}} createNode={() => new FooterTextNode({})}>
|
||||
{text ?? children}
|
||||
</ReacordElement>
|
||||
</ReacordElement>
|
||||
)
|
||||
}
|
||||
|
||||
class EmbedFooterNode extends EmbedChildNode<EmbedFooterProps> {
|
||||
class EmbedFooterNode extends EmbedChildNode<
|
||||
Omit<EmbedFooterProps, "text" | "children">
|
||||
> {
|
||||
override modifyEmbedOptions(options: EmbedOptions): void {
|
||||
options.footer = {
|
||||
text: this.props.text ?? this.props.children ?? "",
|
||||
text: this.children.findType(FooterTextNode)?.text ?? "",
|
||||
icon_url: this.props.iconUrl,
|
||||
}
|
||||
options.timestamp = this.props.timestamp
|
||||
@@ -36,3 +41,5 @@ class EmbedFooterNode extends EmbedChildNode<EmbedFooterProps> {
|
||||
: undefined
|
||||
}
|
||||
}
|
||||
|
||||
class FooterTextNode extends Node<{}> {}
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
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"
|
||||
|
||||
@@ -7,25 +9,28 @@ import type { EmbedOptions } from "./embed-options"
|
||||
* @category Embed
|
||||
*/
|
||||
export type EmbedTitleProps = {
|
||||
children: string
|
||||
children: ReactNode
|
||||
url?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* @category Embed
|
||||
*/
|
||||
export function EmbedTitle(props: EmbedTitleProps) {
|
||||
export function EmbedTitle({ children, ...props }: EmbedTitleProps) {
|
||||
return (
|
||||
<ReacordElement
|
||||
props={props}
|
||||
createNode={() => new EmbedTitleNode(props)}
|
||||
/>
|
||||
<ReacordElement props={props} createNode={() => new EmbedTitleNode(props)}>
|
||||
<ReacordElement props={{}} createNode={() => new TitleTextNode({})}>
|
||||
{children}
|
||||
</ReacordElement>
|
||||
</ReacordElement>
|
||||
)
|
||||
}
|
||||
|
||||
class EmbedTitleNode extends EmbedChildNode<EmbedTitleProps> {
|
||||
class EmbedTitleNode extends EmbedChildNode<Omit<EmbedTitleProps, "children">> {
|
||||
override modifyEmbedOptions(options: EmbedOptions): void {
|
||||
options.title = this.props.children
|
||||
options.title = this.children.findType(TitleTextNode)?.text ?? ""
|
||||
options.url = this.props.url
|
||||
}
|
||||
}
|
||||
|
||||
class TitleTextNode extends Node<{}> {}
|
||||
|
||||
@@ -10,6 +10,7 @@ import type { EmbedOptions } from "./embed-options"
|
||||
|
||||
/**
|
||||
* @category Embed
|
||||
* @see https://discord.com/developers/docs/resources/channel#embed-object
|
||||
*/
|
||||
export type EmbedProps = {
|
||||
title?: string
|
||||
@@ -28,6 +29,7 @@ export type EmbedProps = {
|
||||
|
||||
/**
|
||||
* @category Embed
|
||||
* @see https://discord.com/developers/docs/resources/channel#embed-object
|
||||
*/
|
||||
export function Embed(props: EmbedProps) {
|
||||
return (
|
||||
|
||||
@@ -3,33 +3,41 @@ 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 = {
|
||||
label?: string
|
||||
children?: string
|
||||
emoji?: string
|
||||
disabled?: boolean
|
||||
export type LinkProps = ButtonSharedProps & {
|
||||
/** The URL the link should lead to */
|
||||
url: string
|
||||
/** The link text */
|
||||
children?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* @category Link
|
||||
*/
|
||||
export function Link(props: LinkProps) {
|
||||
return <ReacordElement props={props} createNode={() => new LinkNode(props)} />
|
||||
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<LinkProps> {
|
||||
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.props.label || this.props.children,
|
||||
label: this.children.findType(LinkTextNode)?.text,
|
||||
url: this.props.url,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
class LinkTextNode extends Node<{}> {}
|
||||
|
||||
@@ -2,13 +2,18 @@ import type { MessageSelectOptionOptions } from "../../internal/message"
|
||||
import { Node } from "../../internal/node"
|
||||
import type { OptionProps } from "./option"
|
||||
|
||||
export class OptionNode extends Node<OptionProps> {
|
||||
export class OptionNode extends Node<
|
||||
Omit<OptionProps, "children" | "label" | "description">
|
||||
> {
|
||||
get options(): MessageSelectOptionOptions {
|
||||
return {
|
||||
label: this.props.children || this.props.label || this.props.value,
|
||||
label: this.children.findType(OptionLabelNode)?.text ?? this.props.value,
|
||||
value: this.props.value,
|
||||
description: this.props.description,
|
||||
description: this.children.findType(OptionDescriptionNode)?.text,
|
||||
emoji: this.props.emoji,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export class OptionLabelNode extends Node<{}> {}
|
||||
export class OptionDescriptionNode extends Node<{}> {}
|
||||
|
||||
@@ -1,23 +1,62 @@
|
||||
import type { ReactNode } from "react"
|
||||
import React from "react"
|
||||
import { ReacordElement } from "../../internal/element"
|
||||
import { OptionNode } from "./option-node"
|
||||
import {
|
||||
OptionDescriptionNode,
|
||||
OptionLabelNode,
|
||||
OptionNode,
|
||||
} from "./option-node"
|
||||
|
||||
/**
|
||||
* @category Select
|
||||
*/
|
||||
export type OptionProps = {
|
||||
label?: string
|
||||
children?: string
|
||||
/** The internal value of this option */
|
||||
value: string
|
||||
description?: string
|
||||
/** The text shown to the user. This takes priority over `children` */
|
||||
label?: ReactNode
|
||||
/** The text shown to the user */
|
||||
children?: ReactNode
|
||||
/** Description for the option, shown to the user */
|
||||
description?: ReactNode
|
||||
|
||||
/**
|
||||
* Renders an emoji to the left of the text.
|
||||
*
|
||||
* Has to be a literal emoji character (e.g. 🍍),
|
||||
* or an emoji code, like `<:plus_one:778531744860602388>`.
|
||||
*
|
||||
* To get an emoji code, type your emoji in Discord chat
|
||||
* with a backslash `\` in front.
|
||||
* The bot has to be in the emoji's guild to use it.
|
||||
*/
|
||||
emoji?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* @category Select
|
||||
*/
|
||||
export function Option(props: OptionProps) {
|
||||
export function Option({
|
||||
label,
|
||||
children,
|
||||
description,
|
||||
...props
|
||||
}: OptionProps) {
|
||||
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>
|
||||
)
|
||||
}
|
||||
|
||||
@@ -4,7 +4,11 @@ import React from "react"
|
||||
import { isInstanceOf } from "../../../helpers/is-instance-of"
|
||||
import { ReacordElement } from "../../internal/element.js"
|
||||
import type { ComponentInteraction } from "../../internal/interaction"
|
||||
import type { ActionRow, MessageOptions } from "../../internal/message"
|
||||
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"
|
||||
@@ -14,15 +18,54 @@ import { OptionNode } from "./option-node"
|
||||
*/
|
||||
export type SelectProps = {
|
||||
children?: ReactNode
|
||||
/** Sets the currently selected value */
|
||||
value?: string
|
||||
|
||||
/** Sets the currently selected values, for use with `multiple` */
|
||||
values?: string[]
|
||||
|
||||
/** The text shown when no value is selected */
|
||||
placeholder?: string
|
||||
|
||||
/** Set to true to allow multiple selected values */
|
||||
multiple?: boolean
|
||||
|
||||
/**
|
||||
* With `multiple`, the minimum number of values that can be selected.
|
||||
* When `multiple` is false or not defined, this is always 1.
|
||||
*
|
||||
* This only limits the number of values that can be received by the user.
|
||||
* This does not limit the number of values that can be displayed by you.
|
||||
*/
|
||||
minValues?: number
|
||||
|
||||
/**
|
||||
* With `multiple`, the maximum number of values that can be selected.
|
||||
* When `multiple` is false or not defined, this is always 1.
|
||||
*
|
||||
* This only limits the number of values that can be received by the user.
|
||||
* This does not limit the number of values that can be displayed by you.
|
||||
*/
|
||||
maxValues?: number
|
||||
|
||||
/** When true, the select will be slightly faded, and cannot be interacted with. */
|
||||
disabled?: boolean
|
||||
|
||||
/**
|
||||
* Called when the user inputs a selection.
|
||||
* Receives the entire select change event,
|
||||
* which can be used to create new replies, etc.
|
||||
*/
|
||||
onChange?: (event: SelectChangeEvent) => void
|
||||
|
||||
/**
|
||||
* Convenience shorthand for `onChange`, which receives the first selected value.
|
||||
*/
|
||||
onChangeValue?: (value: string, event: SelectChangeEvent) => void
|
||||
|
||||
/**
|
||||
* Convenience shorthand for `onChange`, which receives all selected values.
|
||||
*/
|
||||
onChangeMultiple?: (values: string[], event: SelectChangeEvent) => void
|
||||
}
|
||||
|
||||
@@ -34,6 +77,7 @@ export type SelectChangeEvent = ComponentEvent & {
|
||||
}
|
||||
|
||||
/**
|
||||
* See [the select menu guide](/guides/select-menu) for a usage example.
|
||||
* @category Select
|
||||
*/
|
||||
export function Select(props: SelectProps) {
|
||||
@@ -68,15 +112,25 @@ class SelectNode extends Node<SelectProps> {
|
||||
...props
|
||||
} = this.props
|
||||
|
||||
actionRow.push({
|
||||
const item: ActionRowItem = {
|
||||
...props,
|
||||
type: "select",
|
||||
customId: this.customId,
|
||||
options,
|
||||
values: [...(values || []), ...(value ? [value] : [])],
|
||||
minValues: multiple ? minValues : undefined,
|
||||
maxValues: multiple ? Math.max(minValues, maxValues) : undefined,
|
||||
})
|
||||
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(
|
||||
|
||||
20
packages/reacord/library/core/instance-context.tsx
Normal file
20
packages/reacord/library/core/instance-context.tsx
Normal file
@@ -0,0 +1,20 @@
|
||||
import * as React from "react"
|
||||
import { raise } from "../../helpers/raise"
|
||||
import type { ReacordInstance } from "./instance"
|
||||
|
||||
const Context = React.createContext<ReacordInstance | undefined>(undefined)
|
||||
|
||||
export const InstanceProvider = Context.Provider
|
||||
|
||||
/**
|
||||
* Get the associated instance for the current component.
|
||||
*
|
||||
* @category Core
|
||||
* @see https://reacord.mapleleaf.dev/guides/use-instance
|
||||
*/
|
||||
export function useInstance(): ReacordInstance {
|
||||
return (
|
||||
React.useContext(Context) ??
|
||||
raise("Could not find instance, was this component rendered via Reacord?")
|
||||
)
|
||||
}
|
||||
@@ -1,10 +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
|
||||
deactivate: () => 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
|
||||
}
|
||||
|
||||
@@ -3,11 +3,14 @@ import * as Discord from "discord.js"
|
||||
import type { ReactNode } from "react"
|
||||
import type { Except } from "type-fest"
|
||||
import { pick } from "../../helpers/pick"
|
||||
import { pruneNullishValues } from "../../helpers/prune-null-values"
|
||||
import { pruneNullishValues } from "../../helpers/prune-nullish-values"
|
||||
import { raise } from "../../helpers/raise"
|
||||
import { toUpper } from "../../helpers/to-upper"
|
||||
import type { ComponentInteraction } from "../internal/interaction"
|
||||
import type { Message, MessageOptions } from "../internal/message"
|
||||
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 {
|
||||
@@ -30,7 +33,7 @@ export class ReacordDiscordJs extends Reacord {
|
||||
super(config)
|
||||
|
||||
client.on("interactionCreate", (interaction) => {
|
||||
if (interaction.isMessageComponent()) {
|
||||
if (interaction.isButton() || interaction.isSelectMenu()) {
|
||||
this.handleComponentInteraction(
|
||||
this.createReacordComponentInteraction(interaction),
|
||||
)
|
||||
@@ -40,9 +43,7 @@ export class ReacordDiscordJs extends Reacord {
|
||||
|
||||
/**
|
||||
* Sends a message to a channel.
|
||||
* @param channelId The ID of the channel to create a message in.
|
||||
* @param initialContent The initial content of the message.
|
||||
* @returns A Record instance.
|
||||
* @see https://reacord.mapleleaf.dev/guides/sending-messages
|
||||
*/
|
||||
override send(
|
||||
channelId: string,
|
||||
@@ -54,6 +55,10 @@ export class ReacordDiscordJs extends Reacord {
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* 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,
|
||||
@@ -64,6 +69,10 @@ export class ReacordDiscordJs extends Reacord {
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* 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,
|
||||
@@ -82,7 +91,7 @@ export class ReacordDiscordJs extends Reacord {
|
||||
(await this.client.channels.fetch(channelId)) ??
|
||||
raise(`Channel ${channelId} not found`)
|
||||
|
||||
if (!channel.isText()) {
|
||||
if (!channel.isTextBased()) {
|
||||
raise(`Channel ${channelId} is not a text channel`)
|
||||
}
|
||||
|
||||
@@ -148,14 +157,16 @@ export class ReacordDiscordJs extends Reacord {
|
||||
// todo please dear god clean this up
|
||||
const channel: ChannelInfo = interaction.channel
|
||||
? {
|
||||
...pick(pruneNullishValues(interaction.channel), [
|
||||
"topic",
|
||||
"nsfw",
|
||||
"lastMessageId",
|
||||
"ownerId",
|
||||
"parentId",
|
||||
"rateLimitPerUser",
|
||||
]),
|
||||
...pruneNullishValues(
|
||||
pick(interaction.channel, [
|
||||
"topic",
|
||||
"nsfw",
|
||||
"lastMessageId",
|
||||
"ownerId",
|
||||
"parentId",
|
||||
"rateLimitPerUser",
|
||||
]),
|
||||
),
|
||||
id: interaction.channelId,
|
||||
}
|
||||
: raise("Non-channel interactions are not supported")
|
||||
@@ -184,15 +195,17 @@ export class ReacordDiscordJs extends Reacord {
|
||||
const member: GuildMemberInfo | undefined =
|
||||
interaction.member instanceof Discord.GuildMember
|
||||
? {
|
||||
...pick(pruneNullishValues(interaction.member), [
|
||||
"id",
|
||||
"nick",
|
||||
"displayName",
|
||||
"avatarUrl",
|
||||
"displayAvatarUrl",
|
||||
"color",
|
||||
"pending",
|
||||
]),
|
||||
...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(),
|
||||
@@ -204,18 +217,15 @@ export class ReacordDiscordJs extends Reacord {
|
||||
|
||||
const guild: GuildInfo | undefined = interaction.guild
|
||||
? {
|
||||
...pick(pruneNullishValues(interaction.guild), ["id", "name"]),
|
||||
...pruneNullishValues(pick(interaction.guild, ["id", "name"])),
|
||||
member: member ?? raise("unexpected: member is undefined"),
|
||||
}
|
||||
: undefined
|
||||
|
||||
const user: UserInfo = {
|
||||
...pick(pruneNullishValues(interaction.user), [
|
||||
"id",
|
||||
"username",
|
||||
"discriminator",
|
||||
"tag",
|
||||
]),
|
||||
...pruneNullishValues(
|
||||
pick(interaction.user, ["id", "username", "discriminator", "tag"]),
|
||||
),
|
||||
avatarUrl: interaction.user.avatarURL()!,
|
||||
accentColor: interaction.user.accentColor ?? undefined,
|
||||
}
|
||||
@@ -291,17 +301,6 @@ function createReacordMessage(message: Discord.Message): Message {
|
||||
edit: async (options) => {
|
||||
await message.edit(getDiscordMessageOptions(options))
|
||||
},
|
||||
disableComponents: async () => {
|
||||
for (const actionRow of message.components) {
|
||||
for (const component of actionRow.components) {
|
||||
component.setDisabled(true)
|
||||
}
|
||||
}
|
||||
|
||||
await message.edit({
|
||||
components: message.components,
|
||||
})
|
||||
},
|
||||
delete: async () => {
|
||||
await message.delete()
|
||||
},
|
||||
@@ -314,10 +313,6 @@ function createEphemeralReacordMessage(): Message {
|
||||
console.warn("Ephemeral messages can't be edited")
|
||||
return Promise.resolve()
|
||||
},
|
||||
disableComponents: () => {
|
||||
console.warn("Ephemeral messages can't be edited")
|
||||
return Promise.resolve()
|
||||
},
|
||||
delete: () => {
|
||||
console.warn("Ephemeral messages can't be deleted")
|
||||
return Promise.resolve()
|
||||
@@ -325,25 +320,34 @@ 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,
|
||||
// and also handle some edge cases, e.g. empty messages
|
||||
function getDiscordMessageOptions(
|
||||
reacordOptions: MessageOptions,
|
||||
): Discord.MessageOptions {
|
||||
const options: Discord.MessageOptions = {
|
||||
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: "ACTION_ROW",
|
||||
type: Discord.ComponentType.ActionRow,
|
||||
components: row.map(
|
||||
(component): Discord.MessageActionRowComponentOptions => {
|
||||
(component): Discord.MessageActionRowComponentData => {
|
||||
if (component.type === "button") {
|
||||
return {
|
||||
type: "BUTTON",
|
||||
type: Discord.ComponentType.Button,
|
||||
customId: component.customId,
|
||||
label: component.label ?? "",
|
||||
style: toUpper(component.style ?? "secondary"),
|
||||
style: convertButtonStyleToEnum(component.style),
|
||||
disabled: component.disabled,
|
||||
emoji: component.emoji,
|
||||
}
|
||||
@@ -352,7 +356,7 @@ function getDiscordMessageOptions(
|
||||
if (component.type === "select") {
|
||||
return {
|
||||
...component,
|
||||
type: "SELECT_MENU",
|
||||
type: Discord.ComponentType.SelectMenu,
|
||||
options: component.options.map((option) => ({
|
||||
...option,
|
||||
default: component.values?.includes(option.value),
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
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
|
||||
@@ -47,13 +49,12 @@ export abstract class Reacord {
|
||||
|
||||
const container = reconciler.createContainer(renderer, 0, false, {})
|
||||
|
||||
if (initialContent !== undefined) {
|
||||
reconciler.updateContainer(initialContent, container)
|
||||
}
|
||||
|
||||
return {
|
||||
const instance: ReacordInstance = {
|
||||
render: (content: ReactNode) => {
|
||||
reconciler.updateContainer(content, container)
|
||||
reconciler.updateContainer(
|
||||
<InstanceProvider value={instance}>{content}</InstanceProvider>,
|
||||
container,
|
||||
)
|
||||
},
|
||||
deactivate: () => {
|
||||
this.deactivate(renderer)
|
||||
@@ -63,6 +64,12 @@ export abstract class Reacord {
|
||||
renderer.destroy()
|
||||
},
|
||||
}
|
||||
|
||||
if (initialContent !== undefined) {
|
||||
instance.render(initialContent)
|
||||
}
|
||||
|
||||
return instance
|
||||
}
|
||||
|
||||
private deactivate(renderer: Renderer) {
|
||||
@@ -21,6 +21,16 @@ export class Container<T> {
|
||||
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]()
|
||||
}
|
||||
|
||||
@@ -9,9 +9,12 @@ export type MessageOptions = {
|
||||
actionRows: ActionRow[]
|
||||
}
|
||||
|
||||
export type ActionRow = Array<
|
||||
MessageButtonOptions | MessageLinkOptions | MessageSelectOptions
|
||||
>
|
||||
export type ActionRow = ActionRowItem[]
|
||||
|
||||
export type ActionRowItem =
|
||||
| MessageButtonOptions
|
||||
| MessageLinkOptions
|
||||
| MessageSelectOptions
|
||||
|
||||
export type MessageButtonOptions = {
|
||||
type: "button"
|
||||
@@ -46,7 +49,6 @@ export type MessageSelectOptionOptions = {
|
||||
export type Message = {
|
||||
edit(options: MessageOptions): Promise<void>
|
||||
delete(): Promise<void>
|
||||
disableComponents(): Promise<void>
|
||||
}
|
||||
|
||||
export function getNextActionRow(options: MessageOptions): ActionRow {
|
||||
|
||||
@@ -13,4 +13,8 @@ export abstract class Node<Props> {
|
||||
handleComponentInteraction(interaction: ComponentInteraction): boolean {
|
||||
return false
|
||||
}
|
||||
|
||||
get text(): string {
|
||||
return [...this.children].map((child) => child.text).join("")
|
||||
}
|
||||
}
|
||||
|
||||
@@ -52,6 +52,8 @@ const config: HostConfig<
|
||||
},
|
||||
createTextInstance: (text) => new TextNode(text),
|
||||
shouldSetTextContent: () => false,
|
||||
// @ts-expect-error
|
||||
detachDeletedInstance: (instance) => {},
|
||||
|
||||
clearContainer: (renderer) => {
|
||||
renderer.nodes.clear()
|
||||
|
||||
@@ -83,7 +83,17 @@ export abstract class Renderer {
|
||||
|
||||
if (payload.action === "deactivate") {
|
||||
this.updateSubscription.unsubscribe()
|
||||
await this.message?.disableComponents()
|
||||
|
||||
await this.message?.edit({
|
||||
...payload.options,
|
||||
actionRows: payload.options.actionRows.map((row) =>
|
||||
row.map((component) => ({
|
||||
...component,
|
||||
disabled: true,
|
||||
})),
|
||||
),
|
||||
})
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
@@ -5,4 +5,8 @@ export class TextNode extends Node<string> {
|
||||
override modifyMessageOptions(options: MessageOptions) {
|
||||
options.content = options.content + this.props
|
||||
}
|
||||
|
||||
override get text() {
|
||||
return this.props
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
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"
|
||||
@@ -12,6 +13,6 @@ 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"
|
||||
export * from "./core/reacord-tester"
|
||||
|
||||
@@ -2,10 +2,27 @@
|
||||
"name": "reacord",
|
||||
"type": "module",
|
||||
"description": "Create interactive Discord messages using React.",
|
||||
"version": "0.1.0",
|
||||
"version": "0.5.0",
|
||||
"types": "./dist/main.d.ts",
|
||||
"homepage": "https://reacord.mapleleaf.dev",
|
||||
"repository": "https://github.com/itsMapleLeaf/reacord.git",
|
||||
"changelog": "https://github.com/itsMapleLeaf/reacord/releases",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"discord",
|
||||
"discord-js",
|
||||
"react",
|
||||
"react-js",
|
||||
"react-renderer",
|
||||
"interaction",
|
||||
"message",
|
||||
"embed",
|
||||
"reacord"
|
||||
],
|
||||
"files": [
|
||||
"dist"
|
||||
"dist",
|
||||
"README.md",
|
||||
"LICENSE"
|
||||
],
|
||||
"exports": {
|
||||
".": {
|
||||
@@ -18,25 +35,24 @@
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"build": "tsup-node library/main.ts --target node16 --format cjs,esm --dts --sourcemap",
|
||||
"build": "cp ../../README.md . && cp ../../LICENSE . && tsup library/main.ts --target node16 --format cjs,esm --dts --sourcemap",
|
||||
"build-watch": "pnpm build -- --watch",
|
||||
"test": "node --experimental-vm-modules --no-warnings ./node_modules/jest/bin/jest.js --colors",
|
||||
"test-watch": "pnpm test -- --watch",
|
||||
"coverage": "pnpm test -- --coverage",
|
||||
"test": "vitest --coverage --no-watch",
|
||||
"test-dev": "vitest",
|
||||
"test-manual": "nodemon --exec tsx --ext ts,tsx ./scripts/discordjs-manual-test.tsx",
|
||||
"typecheck": "tsc --noEmit",
|
||||
"playground": "nodemon --exec esmo --ext ts,tsx ./playground/main.tsx",
|
||||
"release": "release-it"
|
||||
"release": "bash scripts/release.sh"
|
||||
},
|
||||
"dependencies": {
|
||||
"@types/node": "*",
|
||||
"@types/react": "*",
|
||||
"@types/react-reconciler": "^0.26.4",
|
||||
"nanoid": "^3.1.30",
|
||||
"react-reconciler": "^0.26.2",
|
||||
"rxjs": "^7.5.1"
|
||||
"@types/react-reconciler": "^0.26.6",
|
||||
"nanoid": "^3.3.3",
|
||||
"react-reconciler": "^0.27.0",
|
||||
"rxjs": "^7.5.5"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"discord.js": "^13.3",
|
||||
"discord.js": "^14",
|
||||
"react": ">=17"
|
||||
},
|
||||
"peerDependenciesMeta": {
|
||||
@@ -45,28 +61,36 @@
|
||||
}
|
||||
},
|
||||
"devDependencies": {
|
||||
"@jest/globals": "^27.4.4",
|
||||
"@types/jest": "^27.0.3",
|
||||
"@types/lodash-es": "^4.17.5",
|
||||
"c8": "^7.10.0",
|
||||
"discord.js": "^13.4.0",
|
||||
"dotenv": "^10.0.0",
|
||||
"esbuild": "latest",
|
||||
"esbuild-jest": "^0.5.0",
|
||||
"esmo": "^0.13.0",
|
||||
"jest": "^27.4.5",
|
||||
"@types/lodash-es": "^4.17.6",
|
||||
"c8": "^7.11.2",
|
||||
"discord.js": "^14.0.3",
|
||||
"dotenv": "^16.0.0",
|
||||
"lodash-es": "^4.17.21",
|
||||
"nodemon": "^2.0.15",
|
||||
"prettier": "^2.5.1",
|
||||
"prettier": "^2.6.2",
|
||||
"pretty-ms": "^7.0.1",
|
||||
"react": "^17.0.2",
|
||||
"release-it": "^14.12.0",
|
||||
"tsup": "^5.11.9",
|
||||
"type-fest": "^2.8.0",
|
||||
"typescript": "^4.5.4"
|
||||
"react": "^18.0.0",
|
||||
"release-it": "^14.14.2",
|
||||
"tsup": "^5.12.6",
|
||||
"tsx": "^3.8.0",
|
||||
"type-fest": "^2.12.2",
|
||||
"typescript": "^4.6.3",
|
||||
"vite": "^2.9.5",
|
||||
"vitest": "^0.10.0"
|
||||
},
|
||||
"resolutions": {
|
||||
"esbuild": "latest"
|
||||
},
|
||||
"prettier": "@itsmapleleaf/configs/prettier"
|
||||
"release-it": {
|
||||
"git": {
|
||||
"commitMessage": "release v${version}"
|
||||
},
|
||||
"github": {
|
||||
"release": true,
|
||||
"web": true
|
||||
}
|
||||
},
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,38 +0,0 @@
|
||||
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 command of commands) {
|
||||
for (const guild of client.guilds.cache.values()) {
|
||||
await client.application?.commands.create(
|
||||
{
|
||||
name: command.name,
|
||||
description: command.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)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -1,35 +0,0 @@
|
||||
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"
|
||||
label="clicc"
|
||||
onClick={() => setCount(count + 1)}
|
||||
/>
|
||||
{!embedVisible && (
|
||||
<Button label="show embed" onClick={() => setEmbedVisible(true)} />
|
||||
)}
|
||||
<Button style="danger" label="deactivate" onClick={props.onDeactivate} />
|
||||
</>
|
||||
)
|
||||
}
|
||||
@@ -1,31 +0,0 @@
|
||||
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)
|
||||
}}
|
||||
/>
|
||||
</>
|
||||
)
|
||||
}
|
||||
@@ -1,98 +0,0 @@
|
||||
import { Client } from "discord.js"
|
||||
import "dotenv/config"
|
||||
import React from "react"
|
||||
import { Button, ReacordDiscordJs } 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")}
|
||||
/>
|
||||
</>,
|
||||
)
|
||||
},
|
||||
},
|
||||
])
|
||||
|
||||
await client.login(process.env.TEST_BOT_TOKEN)
|
||||
134
packages/reacord/scripts/discordjs-manual-test.tsx
Normal file
134
packages/reacord/scripts/discordjs-manual-test.tsx
Normal file
@@ -0,0 +1,134 @@
|
||||
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,
|
||||
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 />)
|
||||
})
|
||||
@@ -1,6 +1,7 @@
|
||||
import React from "react"
|
||||
import { ReacordTester } from "../library/core/reacord-tester"
|
||||
import { test } from "vitest"
|
||||
import { ActionRow, Button, Select } from "../library/main"
|
||||
import { ReacordTester } from "./test-adapter"
|
||||
|
||||
const testing = new ReacordTester()
|
||||
|
||||
|
||||
@@ -1,2 +1,3 @@
|
||||
import { test } from "vitest"
|
||||
|
||||
test.todo("channel message renderer")
|
||||
export {}
|
||||
|
||||
12
packages/reacord/test/commonjs-require.test.ts
Normal file
12
packages/reacord/test/commonjs-require.test.ts
Normal file
@@ -0,0 +1,12 @@
|
||||
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()
|
||||
})
|
||||
@@ -1,2 +1,3 @@
|
||||
import { test } from "vitest"
|
||||
|
||||
test.todo("discord js integration")
|
||||
export {}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import React from "react"
|
||||
import { ReacordTester } from "../library/core/reacord-tester"
|
||||
import { test } from "vitest"
|
||||
import {
|
||||
Embed,
|
||||
EmbedAuthor,
|
||||
@@ -9,6 +9,7 @@ import {
|
||||
EmbedThumbnail,
|
||||
EmbedTitle,
|
||||
} from "../library/main"
|
||||
import { ReacordTester } from "./test-adapter"
|
||||
|
||||
const testing = new ReacordTester()
|
||||
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
import { test } from "vitest"
|
||||
test.todo("ephemeral reply")
|
||||
export {}
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import { test } from "vitest"
|
||||
|
||||
test.todo("button onClick")
|
||||
test.todo("select onChange")
|
||||
export {}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import React from "react"
|
||||
import { ReacordTester } from "../library/core/reacord-tester"
|
||||
import { test } from "vitest"
|
||||
import { Link } from "../library/main"
|
||||
import { ReacordTester } from "./test-adapter"
|
||||
|
||||
const tester = new ReacordTester()
|
||||
|
||||
|
||||
@@ -1,11 +1,7 @@
|
||||
import * as React from "react"
|
||||
import {
|
||||
Button,
|
||||
Embed,
|
||||
EmbedField,
|
||||
EmbedTitle,
|
||||
ReacordTester,
|
||||
} from "../library/main"
|
||||
import { test } from "vitest"
|
||||
import { Button, Embed, EmbedField, EmbedTitle } from "../library/main"
|
||||
import { ReacordTester } from "./test-adapter"
|
||||
|
||||
test("rendering behavior", async () => {
|
||||
const tester = new ReacordTester()
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { test } from "vitest"
|
||||
|
||||
// test that the interaction update is _eventually_ deferred if there's no component update,
|
||||
// and that update isn't called after the fact
|
||||
// ...somehow
|
||||
test.todo("defer update timeout")
|
||||
|
||||
export {}
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
import { jest } from "@jest/globals"
|
||||
import React, { useState } from "react"
|
||||
import { Button, Option, ReacordTester, Select } from "../library/main"
|
||||
import { expect, test, vi } from "vitest"
|
||||
import { Button, Option, Select } from "../library/main"
|
||||
import { ReacordTester } from "./test-adapter"
|
||||
|
||||
test("single select", async () => {
|
||||
const tester = new ReacordTester()
|
||||
const onSelect = jest.fn()
|
||||
const onSelect = vi.fn()
|
||||
|
||||
function TestSelect() {
|
||||
const [value, setValue] = useState<string>()
|
||||
@@ -74,7 +75,7 @@ test("single select", async () => {
|
||||
|
||||
test("multiple select", async () => {
|
||||
const tester = new ReacordTester()
|
||||
const onSelect = jest.fn()
|
||||
const onSelect = vi.fn()
|
||||
|
||||
function TestSelect() {
|
||||
const [values, setValues] = useState<string[]>([])
|
||||
@@ -125,13 +126,13 @@ test("multiple select", async () => {
|
||||
expect(onSelect).toHaveBeenCalledTimes(0)
|
||||
|
||||
tester.findSelectByPlaceholder("select").select("1", "3")
|
||||
await assertSelect(expect.arrayContaining(["1", "3"]))
|
||||
await assertSelect(expect.arrayContaining(["1", "3"]) as unknown as string[])
|
||||
expect(onSelect).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ values: expect.arrayContaining(["1", "3"]) }),
|
||||
)
|
||||
|
||||
tester.findSelectByPlaceholder("select").select("2")
|
||||
await assertSelect(expect.arrayContaining(["2"]))
|
||||
await assertSelect(expect.arrayContaining(["2"]) as unknown as string[])
|
||||
expect(onSelect).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ values: expect.arrayContaining(["2"]) }),
|
||||
)
|
||||
|
||||
@@ -1,39 +1,36 @@
|
||||
/* eslint-disable class-methods-use-this */
|
||||
/* eslint-disable require-await */
|
||||
import { nanoid } from "nanoid"
|
||||
import { nextTick } from "node:process"
|
||||
import { promisify } from "node:util"
|
||||
import { setTimeout } from "node:timers/promises"
|
||||
import type { ReactNode } from "react"
|
||||
import { logPretty } from "../../helpers/log-pretty"
|
||||
import { omit } from "../../helpers/omit"
|
||||
import { raise } from "../../helpers/raise"
|
||||
import type { Channel } from "../internal/channel"
|
||||
import { Container } from "../internal/container"
|
||||
import type {
|
||||
ButtonInteraction,
|
||||
CommandInteraction,
|
||||
SelectInteraction,
|
||||
} from "../internal/interaction"
|
||||
import type {
|
||||
Message,
|
||||
MessageButtonOptions,
|
||||
MessageOptions,
|
||||
MessageSelectOptions,
|
||||
} from "../internal/message"
|
||||
import { ChannelMessageRenderer } from "../internal/renderers/channel-message-renderer"
|
||||
import { InteractionReplyRenderer } from "../internal/renderers/interaction-reply-renderer"
|
||||
import { expect } from "vitest"
|
||||
import { logPretty } from "../helpers/log-pretty"
|
||||
import { omit } from "../helpers/omit"
|
||||
import { pruneNullishValues } from "../helpers/prune-nullish-values"
|
||||
import { raise } from "../helpers/raise"
|
||||
import { waitFor } from "../helpers/wait-for"
|
||||
import type {
|
||||
ChannelInfo,
|
||||
GuildInfo,
|
||||
MessageInfo,
|
||||
UserInfo,
|
||||
} from "./component-event"
|
||||
import type { ButtonClickEvent } from "./components/button"
|
||||
import type { SelectChangeEvent } from "./components/select"
|
||||
import type { ReacordInstance } from "./instance"
|
||||
import { Reacord } from "./reacord"
|
||||
} 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"
|
||||
|
||||
const nextTickPromise = promisify(nextTick)
|
||||
export type MessageSample = ReturnType<ReacordTester["sampleMessages"]>[0]
|
||||
|
||||
/**
|
||||
* A Record adapter for automated tests. WIP
|
||||
@@ -49,33 +46,33 @@ export class ReacordTester extends Reacord {
|
||||
return [...this.messageContainer]
|
||||
}
|
||||
|
||||
override send(): ReacordInstance {
|
||||
override send(initialContent?: ReactNode): ReacordInstance {
|
||||
return this.createInstance(
|
||||
new ChannelMessageRenderer(new TestChannel(this.messageContainer)),
|
||||
initialContent,
|
||||
)
|
||||
}
|
||||
|
||||
override reply(): ReacordInstance {
|
||||
override reply(initialContent?: ReactNode): ReacordInstance {
|
||||
return this.createInstance(
|
||||
new InteractionReplyRenderer(
|
||||
new TestCommandInteraction(this.messageContainer),
|
||||
),
|
||||
initialContent,
|
||||
)
|
||||
}
|
||||
|
||||
override ephemeralReply(): ReacordInstance {
|
||||
return this.reply()
|
||||
override ephemeralReply(initialContent?: ReactNode): ReacordInstance {
|
||||
return this.reply(initialContent)
|
||||
}
|
||||
|
||||
async assertMessages(expected: ReturnType<this["sampleMessages"]>) {
|
||||
await nextTickPromise()
|
||||
expect(this.sampleMessages()).toEqual(expected)
|
||||
assertMessages(expected: MessageSample[]) {
|
||||
return waitFor(() => {
|
||||
expect(this.sampleMessages()).toEqual(expected)
|
||||
})
|
||||
}
|
||||
|
||||
async assertRender(
|
||||
content: ReactNode,
|
||||
expected: ReturnType<this["sampleMessages"]>,
|
||||
) {
|
||||
async assertRender(content: ReactNode, expected: MessageSample[]) {
|
||||
const instance = this.reply()
|
||||
instance.render(content)
|
||||
await this.assertMessages(expected)
|
||||
@@ -87,68 +84,76 @@ export class ReacordTester extends Reacord {
|
||||
}
|
||||
|
||||
sampleMessages() {
|
||||
return this.messages.map((message) => ({
|
||||
...message.options,
|
||||
actionRows: message.options.actionRows.map((row) =>
|
||||
row.map((component) =>
|
||||
omit(component, ["customId", "onClick", "onSelect", "onSelectValue"]),
|
||||
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) {
|
||||
for (const message of this.messageContainer) {
|
||||
for (const component of message.options.actionRows.flat()) {
|
||||
if (component.type === "button" && component.label === label) {
|
||||
return this.createButtonActions(component, message)
|
||||
}
|
||||
}
|
||||
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}"`)
|
||||
})
|
||||
},
|
||||
}
|
||||
raise(`Couldn't find button with label "${label}"`)
|
||||
}
|
||||
|
||||
findSelectByPlaceholder(placeholder: string) {
|
||||
for (const message of this.messageContainer) {
|
||||
for (const component of message.options.actionRows.flat()) {
|
||||
if (
|
||||
component.type === "select" &&
|
||||
component.placeholder === placeholder
|
||||
) {
|
||||
return this.createSelectActions(component, message)
|
||||
}
|
||||
}
|
||||
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}"`)
|
||||
})
|
||||
},
|
||||
}
|
||||
raise(`Couldn't find select with placeholder "${placeholder}"`)
|
||||
}
|
||||
|
||||
createMessage(options: MessageOptions) {
|
||||
return new TestMessage(options, this.messageContainer)
|
||||
}
|
||||
|
||||
private createButtonActions(
|
||||
button: MessageButtonOptions,
|
||||
message: TestMessage,
|
||||
) {
|
||||
return {
|
||||
click: () => {
|
||||
this.handleComponentInteraction(
|
||||
new TestButtonInteraction(button.customId, message, this),
|
||||
)
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
private createSelectActions(
|
||||
component: MessageSelectOptions,
|
||||
message: TestMessage,
|
||||
) {
|
||||
return {
|
||||
select: (...values: string[]) => {
|
||||
this.handleComponentInteraction(
|
||||
new TestSelectInteraction(component.customId, message, values, this),
|
||||
)
|
||||
},
|
||||
private *eachComponent() {
|
||||
for (const message of this.messageContainer) {
|
||||
for (const component of message.options.actionRows.flat()) {
|
||||
yield [component, message] as const
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -165,16 +170,6 @@ class TestMessage implements Message {
|
||||
this.options = options
|
||||
}
|
||||
|
||||
async disableComponents(): Promise<void> {
|
||||
for (const row of this.options.actionRows) {
|
||||
for (const action of row) {
|
||||
if (action.type === "button") {
|
||||
action.disabled = true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async delete(): Promise<void> {
|
||||
this.container.remove(this)
|
||||
}
|
||||
@@ -187,16 +182,14 @@ class TestCommandInteraction implements CommandInteraction {
|
||||
|
||||
constructor(private messageContainer: Container<TestMessage>) {}
|
||||
|
||||
reply(messageOptions: MessageOptions): Promise<Message> {
|
||||
return Promise.resolve(
|
||||
new TestMessage(messageOptions, this.messageContainer),
|
||||
)
|
||||
async reply(messageOptions: MessageOptions): Promise<Message> {
|
||||
await setTimeout()
|
||||
return new TestMessage(messageOptions, this.messageContainer)
|
||||
}
|
||||
|
||||
followUp(messageOptions: MessageOptions): Promise<Message> {
|
||||
return Promise.resolve(
|
||||
new TestMessage(messageOptions, this.messageContainer),
|
||||
)
|
||||
async followUp(messageOptions: MessageOptions): Promise<Message> {
|
||||
await setTimeout()
|
||||
return new TestMessage(messageOptions, this.messageContainer)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -265,11 +258,11 @@ class TestComponentEvent {
|
||||
guild: GuildInfo = {} as any // todo
|
||||
|
||||
reply(content?: ReactNode): ReacordInstance {
|
||||
return this.tester.reply()
|
||||
return this.tester.reply(content)
|
||||
}
|
||||
|
||||
ephemeralReply(content?: ReactNode): ReacordInstance {
|
||||
return this.tester.ephemeralReply()
|
||||
return this.tester.ephemeralReply(content)
|
||||
}
|
||||
}
|
||||
|
||||
89
packages/reacord/test/text-children.test.tsx
Normal file
89
packages/reacord/test/text-children.test.tsx
Normal file
@@ -0,0 +1,89 @@
|
||||
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" },
|
||||
],
|
||||
},
|
||||
],
|
||||
],
|
||||
},
|
||||
],
|
||||
)
|
||||
})
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user