64 Commits
0.1.0 ... 0.3.3

Author SHA1 Message Date
MapleLeaf
b6b05232f7 release v0.3.3 2022-01-12 10:22:41 -06:00
MapleLeaf
33a170a4fb use bash release script 2022-01-12 10:21:54 -06:00
MapleLeaf
9a6f85a726 copy readme before publish 2022-01-12 09:57:02 -06:00
MapleLeaf
a79649048f fix version 2022-01-12 09:55:46 -06:00
MapleLeaf
e7196e686c build before release 2022-01-12 09:55:04 -06:00
Darius
26eb8bedb0 Add useInstance (#6) 2022-01-12 09:55:03 -06:00
MapleLeaf
2851d4b787 update todo 2022-01-12 09:55:03 -06:00
MapleLeaf
46d3c64133 release v0.2.0 2022-01-12 09:55:03 -06:00
MapleLeaf
6b77971ed5 docs -> website 2022-01-11 00:28:41 -06:00
MapleLeaf
effd16ed97 run reacord and docs test in separate processes 2022-01-11 00:25:13 -06:00
MapleLeaf
989ab330b3 just test reacord 2022-01-11 00:25:13 -06:00
MapleLeaf
0aafc66ce1 debug log 2022-01-11 00:25:13 -06:00
MapleLeaf
ff8347b52a try just running parallel test 2022-01-11 00:25:13 -06:00
MapleLeaf
c436500b3a try running test in packages/docs 2022-01-11 00:25:13 -06:00
MapleLeaf
e93506409f no esmo 2022-01-11 00:25:13 -06:00
MapleLeaf
8482f6e91a simplify workflow again 2022-01-11 00:25:13 -06:00
MapleLeaf
c5e11b4417 run scripts in parallel 2022-01-11 00:25:13 -06:00
MapleLeaf
2e4ff0f524 remove detached flag 2022-01-11 00:25:13 -06:00
MapleLeaf
d0c940c693 exit 2022-01-11 00:25:13 -06:00
MapleLeaf
01f245c2e2 kill detached process with sigkill 2022-01-11 00:25:13 -06:00
MapleLeaf
b65004dd75 try to kill detached process 2022-01-11 00:25:12 -06:00
MapleLeaf
d9dd4d5307 test: kill app with sigkill 2022-01-11 00:25:12 -06:00
MapleLeaf
2b3b8953d0 don't test in parallel??? 2022-01-11 00:25:12 -06:00
MapleLeaf
a6b706a3de add wait-on types??? 2022-01-11 00:25:12 -06:00
MapleLeaf
d3f6c8af4d write test script for cypress
to properly kill the process
2022-01-11 00:25:12 -06:00
MapleLeaf
b0e937f896 exit after test 2022-01-11 00:25:12 -06:00
MapleLeaf
8b371cd1cf separate test and test dev scripts 2022-01-11 00:25:12 -06:00
MapleLeaf
ba155226f1 run test scripts in parallel 2022-01-11 00:25:12 -06:00
MapleLeaf
a1424f4607 linter lol 2022-01-11 00:25:12 -06:00
MapleLeaf
42461c7ec8 upgrades 2022-01-11 00:25:12 -06:00
MapleLeaf
27f793b1db print coverage from test script 2022-01-11 00:25:12 -06:00
MapleLeaf
97a5526d9d run test in main workflow 2022-01-11 00:25:12 -06:00
MapleLeaf
99eebef9a9 turn off watch in coverage 2022-01-11 00:25:12 -06:00
MapleLeaf
1b97f9256f deeply prune defined undefined values in test adapter 2022-01-11 00:25:12 -06:00
MapleLeaf
1a04e6093d clearer select option resolution 2022-01-11 00:25:12 -06:00
MapleLeaf
4803cb8478 remove reacord-tester from core 2022-01-11 00:25:12 -06:00
MapleLeaf
4201f45cc9 use export default in cypress plugin file 2022-01-11 00:25:12 -06:00
MapleLeaf
52b83522de ignore cypress videos and screenshots 2022-01-11 00:25:12 -06:00
MapleLeaf
017a417773 add vitest in project 2022-01-11 00:25:12 -06:00
MapleLeaf
661a253d8c update todo 2022-01-10 17:15:50 -06:00
MapleLeaf
5b68a1f0ea yaml is bad 2022-01-10 17:07:24 -06:00
MapleLeaf
8c4a450bfb update paths on deploy workflow 2022-01-10 17:06:45 -06:00
MapleLeaf
14b74a0a3f remove readme in docs 2022-01-10 17:05:33 -06:00
MapleLeaf
f2d309b2a7 add eslint override for cypress 2022-01-10 16:52:31 -06:00
MapleLeaf
adeb0fb0d9 fix type checking for cypress 2022-01-10 16:04:09 -06:00
Sami Ibrahim
4f8308dc73 Update README.md (#5) 2022-01-10 15:33:29 -06:00
MapleLeaf
f5d8fa5271 docker: set node env after install 2022-01-10 15:11:38 -06:00
MapleLeaf
ac759412b3 lint fix 2022-01-10 15:10:50 -06:00
MapleLeaf
608b008659 fix typress type error 2022-01-10 15:10:23 -06:00
MapleLeaf
87cbf1b74d docs: add cypress test 2022-01-10 15:06:55 -06:00
MapleLeaf
4f463bfa23 link directly to alpine dist js
just to reduce network round trips
2022-01-10 14:44:19 -06:00
MapleLeaf
2e65218083 release v0.1.1 2022-01-09 20:35:54 -06:00
MapleLeaf
1e4a2bd006 configure release-it 2022-01-09 20:34:44 -06:00
MapleLeaf
76bd0b0b98 add doc comments 2022-01-09 20:31:31 -06:00
MapleLeaf
021afc154f more helpful reference links 2022-01-09 19:41:48 -06:00
MapleLeaf
fe39859b68 add links doc 2022-01-09 19:34:24 -06:00
MapleLeaf
c55fb22a8f lower framerate gif 2022-01-09 17:40:15 -06:00
MapleLeaf
7d8336c7a7 migrate docs back to remix oops 2022-01-09 17:36:42 -06:00
Darius
c6ea101330 Add demo gif (#3) 2022-01-09 16:39:08 -06:00
MapleLeaf
4e9b358731 run serve script directly from docker container 2022-01-09 13:41:43 -06:00
MapleLeaf
a66520829a remove cross-env 2022-01-09 13:09:17 -06:00
MapleLeaf
e2b150bbe2 docs: disable source maps in prod 2022-01-09 13:01:00 -06:00
MapleLeaf
be42042552 upgrades 2022-01-09 12:55:37 -06:00
MapleLeaf
3bfc5f4977 try to fix deploy issues 2022-01-09 12:46:51 -06:00
115 changed files with 3806 additions and 4358 deletions

View File

@@ -5,7 +5,8 @@
"**/.cache/**", "**/.cache/**",
"**/build/**", "**/build/**",
"**/dist/**", "**/dist/**",
"**/coverage/**" "**/coverage/**",
"**/public/**"
], ],
"parserOptions": { "parserOptions": {
"project": "./tsconfig.base.json" "project": "./tsconfig.base.json"
@@ -13,5 +14,13 @@
"rules": { "rules": {
"import/no-unused-modules": "off", "import/no-unused-modules": "off",
"unicorn/prevent-abbreviations": "off" "unicorn/prevent-abbreviations": "off"
},
"overrides": [
{
"files": ["packages/website/cypress/**"],
"parserOptions": {
"project": "./packages/website/cypress/tsconfig.json"
} }
}
]
} }

View File

@@ -1,9 +1,10 @@
name: deploy docs name: deploy website
on: on:
push: push:
branches: [main] branches: [main]
paths: [packages/docs/**, reacord/library/**/*.ts] paths:
- "packages/website/**"
- "reacord/library/**/*.{ts,tsx}"
jobs: jobs:
deploy: deploy:
runs-on: ubuntu-latest runs-on: ubuntu-latest

View File

@@ -11,20 +11,24 @@ env:
TEST_GUILD_ID: ${{ secrets.TEST_GUILD_ID }} TEST_GUILD_ID: ${{ secrets.TEST_GUILD_ID }}
jobs: jobs:
run-scripts: run-commands:
strategy: strategy:
matrix:
scripts:
- name: test
script: coverage
- name: lint
script: lint
- name: typecheck
script: typecheck
- name: build
script: build
fail-fast: false 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 test -C packages/reacord
- name: test website
run: pnpm test -C packages/website
- name: build
run: pnpm build --recursive
- name: lint
run: pnpm lint
- name: typecheck
run: pnpm typecheck --parallel
name: ${{ matrix.command.name }}
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
@@ -34,4 +38,4 @@ jobs:
node-version: "16" node-version: "16"
- run: npm i -g pnpm - run: npm i -g pnpm
- run: pnpm install --frozen-lockfile - run: pnpm install --frozen-lockfile
- run: pnpm run --recursive ${{ matrix.scripts.script }} - run: ${{ matrix.command.run }}

View File

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

View File

@@ -1,7 +1,23 @@
# reacord # reacord
Create interactive Discord messages using React!
Create interactive Discord messages using React! [Visit the docs to get started.](https://reacord.fly.dev/guides/getting-started) ## Installation
```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.fly.dev/guides/getting-started)
## Example
<!-- prettier-ignore --> <!-- prettier-ignore -->
```tsx ```tsx
import * as React from "react" import * as React from "react"
@@ -21,3 +37,5 @@ function Counter() {
) )
} }
``` ```
![Counter demo](./reacord-counter-demo.gif)

View File

@@ -9,16 +9,16 @@
"@itsmapleleaf/configs": "^1.1.2" "@itsmapleleaf/configs": "^1.1.2"
}, },
"devDependencies": { "devDependencies": {
"@typescript-eslint/eslint-plugin": "^5.8.1", "@typescript-eslint/eslint-plugin": "^5.9.1",
"@typescript-eslint/parser": "^5.8.1", "@typescript-eslint/parser": "^5.9.1",
"eslint": "^8.5.0", "eslint": "^8.6.0",
"eslint-config-prettier": "^8.3.0", "eslint-config-prettier": "^8.3.0",
"eslint-import-resolver-typescript": "^2.5.0", "eslint-import-resolver-typescript": "^2.5.0",
"eslint-plugin-import": "^2.25.3", "eslint-plugin-import": "^2.25.4",
"eslint-plugin-jsx-a11y": "^6.5.1", "eslint-plugin-jsx-a11y": "^6.5.1",
"eslint-plugin-react": "^7.28.0", "eslint-plugin-react": "^7.28.0",
"eslint-plugin-react-hooks": "^4.3.0", "eslint-plugin-react-hooks": "^4.3.0",
"eslint-plugin-unicorn": "^39.0.0", "eslint-plugin-unicorn": "^40.0.0",
"prettier": "^2.5.1", "prettier": "^2.5.1",
"typescript": "^4.5.4" "typescript": "^4.5.4"
}, },

View File

@@ -1,3 +0,0 @@
.asset-cache
node_modules
/api

View File

@@ -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"
}
}

View File

@@ -1,6 +0,0 @@
module.exports = {
plugins: {
tailwindcss: {},
autoprefixer: {},
},
}

View File

@@ -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))
}

View File

@@ -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")

View File

@@ -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 }
}
}

View File

@@ -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)}</>
}

View File

@@ -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,
}
},
}

View File

@@ -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,
}
},
}

View File

@@ -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 }
},
}

View File

@@ -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)
}

View File

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

View File

@@ -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>
)
}

View File

@@ -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
}

View File

@@ -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 }
}

View File

@@ -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>
)
}

View File

@@ -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>
)
}

View File

@@ -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()
})
})

View File

@@ -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>
)
}
}

View File

@@ -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,
}))

View File

@@ -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
}
}

View File

@@ -1,3 +0,0 @@
.prose aside {
@apply opacity-75 italic border-l-4 pl-3 border-white/50;
}

View File

@@ -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
}

View File

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

2
packages/reacord/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
/README.md
/LICENSE

View File

@@ -2,6 +2,7 @@ import type {
CamelCasedPropertiesDeep, CamelCasedPropertiesDeep,
SnakeCasedPropertiesDeep, SnakeCasedPropertiesDeep,
} from "type-fest" } from "type-fest"
import { expect, test } from "vitest"
import { camelCaseDeep, snakeCaseDeep } from "./convert-object-property-case" import { camelCaseDeep, snakeCaseDeep } from "./convert-object-property-case"
test("camelCaseDeep", () => { test("camelCaseDeep", () => {
@@ -12,12 +13,14 @@ test("camelCaseDeep", () => {
someOtherProp: "someOtherValue", someOtherProp: "someOtherValue",
} }
expect(camelCaseDeep(input)).toEqual<CamelCasedPropertiesDeep<typeof input>>({ const expected: CamelCasedPropertiesDeep<typeof input> = {
someProp: { someProp: {
someDeepProp: "some_deep_value", someDeepProp: "some_deep_value",
}, },
someOtherProp: "someOtherValue", someOtherProp: "someOtherValue",
}) }
expect(camelCaseDeep(input)).toEqual(expected)
}) })
test("snakeCaseDeep", () => { test("snakeCaseDeep", () => {
@@ -28,10 +31,12 @@ test("snakeCaseDeep", () => {
some_other_prop: "someOtherValue", some_other_prop: "someOtherValue",
} }
expect(snakeCaseDeep(input)).toEqual<SnakeCasedPropertiesDeep<typeof input>>({ const expected: SnakeCasedPropertiesDeep<typeof input> = {
some_prop: { some_prop: {
some_deep_prop: "someDeepValue", some_deep_prop: "someDeepValue",
}, },
some_other_prop: "someOtherValue", some_other_prop: "someOtherValue",
}) }
expect(snakeCaseDeep(input)).toEqual(expected)
}) })

View 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

View File

@@ -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]>
}

View File

@@ -0,0 +1,27 @@
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
}
type PruneNullishValues<Input> = Input extends ReadonlyArray<infer Value>
? ReadonlyArray<NonNullable<Value>>
: Input extends object
? {
[Key in keyof Input]: NonNullable<Input[Key]>
}
: Input

View File

@@ -6,5 +6,5 @@ export async function rejectAfter(
error: unknown = `rejected after ${timeMs}ms`, error: unknown = `rejected after ${timeMs}ms`,
): Promise<never> { ): Promise<never> {
await setTimeout(timeMs) await setTimeout(timeMs)
return Promise.reject(toError(error)) throw toError(error)
} }

View File

@@ -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

View File

@@ -5,11 +5,41 @@ import type { ReacordInstance } from "./instance"
* @category Component Event * @category Component Event
*/ */
export type ComponentEvent = { 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 message: MessageInfo
/**
* The channel that this event occurred in.
* @see https://discord.com/developers/docs/resources/channel#channel-object
*/
channel: ChannelInfo channel: ChannelInfo
/**
* The user that triggered this event.
* @see https://discord.com/developers/docs/resources/user#user-object
*/
user: UserInfo user: UserInfo
/**
* The guild that this event occurred in.
* @see https://discord.com/developers/docs/resources/guild#guild-object
*/
guild?: GuildInfo guild?: GuildInfo
/**
* Create a new reply to this event.
*/
reply(content?: ReactNode): ReacordInstance reply(content?: ReactNode): ReacordInstance
/**
* Create an ephemeral reply to this event,
* shown only to the user who triggered it.
*/
ephemeralReply(content?: ReactNode): ReacordInstance ephemeralReply(content?: ReactNode): ReacordInstance
} }

View File

@@ -0,0 +1,22 @@
/**
* Common props between button-like components
* @category Button
*/
export type ButtonSharedProps = {
/** The text on the button. Rich formatting (markdown) is not supported here. */
label?: string
/** 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
}

View File

@@ -6,17 +6,24 @@ import type { MessageOptions } from "../../internal/message"
import { getNextActionRow } from "../../internal/message" import { getNextActionRow } from "../../internal/message"
import { Node } from "../../internal/node.js" import { Node } from "../../internal/node.js"
import type { ComponentEvent } from "../component-event" import type { ComponentEvent } from "../component-event"
import type { ButtonSharedProps } from "./button-shared-props"
/** /**
* @category Button * @category Button
*/ */
export type ButtonProps = { export type ButtonProps = ButtonSharedProps & {
label?: string /**
* 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" style?: "primary" | "secondary" | "success" | "danger"
disabled?: boolean
emoji?: string /**
* Happens when a user clicks the button.
*/
onClick: (event: ButtonClickEvent) => void onClick: (event: ButtonClickEvent) => void
} }
/** /**
* @category Button * @category Button
*/ */

View File

@@ -10,6 +10,7 @@ import type { EmbedOptions } from "./embed-options"
/** /**
* @category Embed * @category Embed
* @see https://discord.com/developers/docs/resources/channel#embed-object
*/ */
export type EmbedProps = { export type EmbedProps = {
title?: string title?: string
@@ -28,6 +29,7 @@ export type EmbedProps = {
/** /**
* @category Embed * @category Embed
* @see https://discord.com/developers/docs/resources/channel#embed-object
*/ */
export function Embed(props: EmbedProps) { export function Embed(props: EmbedProps) {
return ( return (

View File

@@ -3,16 +3,16 @@ import { ReacordElement } from "../../internal/element.js"
import type { MessageOptions } from "../../internal/message" import type { MessageOptions } from "../../internal/message"
import { getNextActionRow } from "../../internal/message" import { getNextActionRow } from "../../internal/message"
import { Node } from "../../internal/node.js" import { Node } from "../../internal/node.js"
import type { ButtonSharedProps } from "./button-shared-props"
/** /**
* @category Link * @category Link
*/ */
export type LinkProps = { export type LinkProps = ButtonSharedProps & {
label?: string /** The URL the link should lead to */
children?: string
emoji?: string
disabled?: boolean
url: string url: string
/** The link text */
children?: string
} }
/** /**

View File

@@ -6,10 +6,25 @@ import { OptionNode } from "./option-node"
* @category Select * @category Select
*/ */
export type OptionProps = { export type OptionProps = {
label?: string /** The internal value of this option */
children?: string
value: string value: string
/** The text shown to the user. This takes priority over `children` */
label?: string
/** The text shown to the user */
children?: string
/** Description for the option, shown to the user */
description?: string description?: string
/**
* 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 emoji?: string
} }

View File

@@ -4,7 +4,11 @@ import React from "react"
import { isInstanceOf } from "../../../helpers/is-instance-of" import { isInstanceOf } from "../../../helpers/is-instance-of"
import { ReacordElement } from "../../internal/element.js" import { ReacordElement } from "../../internal/element.js"
import type { ComponentInteraction } from "../../internal/interaction" 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 { Node } from "../../internal/node.js"
import type { ComponentEvent } from "../component-event" import type { ComponentEvent } from "../component-event"
import { OptionNode } from "./option-node" import { OptionNode } from "./option-node"
@@ -14,15 +18,54 @@ import { OptionNode } from "./option-node"
*/ */
export type SelectProps = { export type SelectProps = {
children?: ReactNode children?: ReactNode
/** Sets the currently selected value */
value?: string value?: string
/** Sets the currently selected values, for use with `multiple` */
values?: string[] values?: string[]
/** The text shown when no value is selected */
placeholder?: string placeholder?: string
/** Set to true to allow multiple selected values */
multiple?: boolean 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 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 maxValues?: number
/** When true, the select will be slightly faded, and cannot be interacted with. */
disabled?: boolean 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 onChange?: (event: SelectChangeEvent) => void
/**
* Convenience shorthand for `onChange`, which receives the first selected value.
*/
onChangeValue?: (value: string, event: SelectChangeEvent) => void onChangeValue?: (value: string, event: SelectChangeEvent) => void
/**
* Convenience shorthand for `onChange`, which receives all selected values.
*/
onChangeMultiple?: (values: string[], event: SelectChangeEvent) => void 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 * @category Select
*/ */
export function Select(props: SelectProps) { export function Select(props: SelectProps) {
@@ -68,15 +112,25 @@ class SelectNode extends Node<SelectProps> {
...props ...props
} = this.props } = this.props
actionRow.push({ const item: ActionRowItem = {
...props, ...props,
type: "select", type: "select",
customId: this.customId, customId: this.customId,
options, options,
values: [...(values || []), ...(value ? [value] : [])], values: [],
minValues: multiple ? minValues : undefined, }
maxValues: multiple ? Math.max(minValues, maxValues) : undefined,
}) 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( override handleComponentInteraction(

View 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.fly.dev/guides/use-instance
*/
export function useInstance(): ReacordInstance {
return (
React.useContext(Context) ??
raise("Could not find instance, was this component rendered via Reacord?")
)
}

View File

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

View File

@@ -3,7 +3,7 @@ import * as Discord from "discord.js"
import type { ReactNode } from "react" import type { ReactNode } from "react"
import type { Except } from "type-fest" import type { Except } from "type-fest"
import { pick } from "../../helpers/pick" 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 { raise } from "../../helpers/raise"
import { toUpper } from "../../helpers/to-upper" import { toUpper } from "../../helpers/to-upper"
import type { ComponentInteraction } from "../internal/interaction" import type { ComponentInteraction } from "../internal/interaction"
@@ -40,9 +40,7 @@ export class ReacordDiscordJs extends Reacord {
/** /**
* Sends a message to a channel. * Sends a message to a channel.
* @param channelId The ID of the channel to create a message in. * @see https://reacord.fly.dev/guides/sending-messages
* @param initialContent The initial content of the message.
* @returns A Record instance.
*/ */
override send( override send(
channelId: string, channelId: string,
@@ -54,6 +52,10 @@ export class ReacordDiscordJs extends Reacord {
) )
} }
/**
* Sends a message as a reply to a command interaction.
* @see https://reacord.fly.dev/guides/sending-messages
*/
override reply( override reply(
interaction: Discord.CommandInteraction, interaction: Discord.CommandInteraction,
initialContent?: React.ReactNode, initialContent?: React.ReactNode,
@@ -64,6 +66,10 @@ export class ReacordDiscordJs extends Reacord {
) )
} }
/**
* Sends an ephemeral message as a reply to a command interaction.
* @see https://reacord.fly.dev/guides/sending-messages
*/
override ephemeralReply( override ephemeralReply(
interaction: Discord.CommandInteraction, interaction: Discord.CommandInteraction,
initialContent?: React.ReactNode, initialContent?: React.ReactNode,
@@ -148,7 +154,8 @@ export class ReacordDiscordJs extends Reacord {
// todo please dear god clean this up // todo please dear god clean this up
const channel: ChannelInfo = interaction.channel const channel: ChannelInfo = interaction.channel
? { ? {
...pick(pruneNullishValues(interaction.channel), [ ...pruneNullishValues(
pick(interaction.channel, [
"topic", "topic",
"nsfw", "nsfw",
"lastMessageId", "lastMessageId",
@@ -156,6 +163,7 @@ export class ReacordDiscordJs extends Reacord {
"parentId", "parentId",
"rateLimitPerUser", "rateLimitPerUser",
]), ]),
),
id: interaction.channelId, id: interaction.channelId,
} }
: raise("Non-channel interactions are not supported") : raise("Non-channel interactions are not supported")
@@ -184,7 +192,8 @@ export class ReacordDiscordJs extends Reacord {
const member: GuildMemberInfo | undefined = const member: GuildMemberInfo | undefined =
interaction.member instanceof Discord.GuildMember interaction.member instanceof Discord.GuildMember
? { ? {
...pick(pruneNullishValues(interaction.member), [ ...pruneNullishValues(
pick(interaction.member, [
"id", "id",
"nick", "nick",
"displayName", "displayName",
@@ -193,6 +202,7 @@ export class ReacordDiscordJs extends Reacord {
"color", "color",
"pending", "pending",
]), ]),
),
displayName: interaction.member.displayName, displayName: interaction.member.displayName,
roles: [...interaction.member.roles.cache.map((role) => role.id)], roles: [...interaction.member.roles.cache.map((role) => role.id)],
joinedAt: interaction.member.joinedAt?.toISOString(), joinedAt: interaction.member.joinedAt?.toISOString(),
@@ -204,18 +214,15 @@ export class ReacordDiscordJs extends Reacord {
const guild: GuildInfo | undefined = interaction.guild 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"), member: member ?? raise("unexpected: member is undefined"),
} }
: undefined : undefined
const user: UserInfo = { const user: UserInfo = {
...pick(pruneNullishValues(interaction.user), [ ...pruneNullishValues(
"id", pick(interaction.user, ["id", "username", "discriminator", "tag"]),
"username", ),
"discriminator",
"tag",
]),
avatarUrl: interaction.user.avatarURL()!, avatarUrl: interaction.user.avatarURL()!,
accentColor: interaction.user.accentColor ?? undefined, accentColor: interaction.user.accentColor ?? undefined,
} }

View File

@@ -1,8 +1,10 @@
import type { ReactNode } from "react" import type { ReactNode } from "react"
import React from "react"
import type { ComponentInteraction } from "../internal/interaction" import type { ComponentInteraction } from "../internal/interaction"
import { reconciler } from "../internal/reconciler.js" import { reconciler } from "../internal/reconciler.js"
import type { Renderer } from "../internal/renderers/renderer" import type { Renderer } from "../internal/renderers/renderer"
import type { ReacordInstance } from "./instance" import type { ReacordInstance } from "./instance"
import { InstanceProvider } from "./instance-context"
/** /**
* @category Core * @category Core
@@ -47,13 +49,12 @@ export abstract class Reacord {
const container = reconciler.createContainer(renderer, 0, false, {}) const container = reconciler.createContainer(renderer, 0, false, {})
if (initialContent !== undefined) { const instance: ReacordInstance = {
reconciler.updateContainer(initialContent, container)
}
return {
render: (content: ReactNode) => { render: (content: ReactNode) => {
reconciler.updateContainer(content, container) reconciler.updateContainer(
<InstanceProvider value={instance}>{content}</InstanceProvider>,
container,
)
}, },
deactivate: () => { deactivate: () => {
this.deactivate(renderer) this.deactivate(renderer)
@@ -63,6 +64,12 @@ export abstract class Reacord {
renderer.destroy() renderer.destroy()
}, },
} }
if (initialContent !== undefined) {
instance.render(initialContent)
}
return instance
} }
private deactivate(renderer: Renderer) { private deactivate(renderer: Renderer) {

View File

@@ -9,9 +9,12 @@ export type MessageOptions = {
actionRows: ActionRow[] actionRows: ActionRow[]
} }
export type ActionRow = Array< export type ActionRow = ActionRowItem[]
MessageButtonOptions | MessageLinkOptions | MessageSelectOptions
> export type ActionRowItem =
| MessageButtonOptions
| MessageLinkOptions
| MessageSelectOptions
export type MessageButtonOptions = { export type MessageButtonOptions = {
type: "button" type: "button"

View File

@@ -1,6 +1,7 @@
export * from "./core/component-event" export * from "./core/component-event"
export * from "./core/components/action-row" export * from "./core/components/action-row"
export * from "./core/components/button" export * from "./core/components/button"
export * from "./core/components/button-shared-props"
export * from "./core/components/embed" export * from "./core/components/embed"
export * from "./core/components/embed-author" export * from "./core/components/embed-author"
export * from "./core/components/embed-field" export * from "./core/components/embed-field"
@@ -12,6 +13,6 @@ export * from "./core/components/link"
export * from "./core/components/option" export * from "./core/components/option"
export * from "./core/components/select" export * from "./core/components/select"
export * from "./core/instance" export * from "./core/instance"
export { useInstance } from "./core/instance-context"
export * from "./core/reacord" export * from "./core/reacord"
export * from "./core/reacord-discord-js" export * from "./core/reacord-discord-js"
export * from "./core/reacord-tester"

View File

@@ -2,10 +2,12 @@
"name": "reacord", "name": "reacord",
"type": "module", "type": "module",
"description": "Create interactive Discord messages using React.", "description": "Create interactive Discord messages using React.",
"version": "0.1.0", "version": "0.3.3",
"types": "./dist/main.d.ts", "types": "./dist/main.d.ts",
"files": [ "files": [
"dist" "dist",
"README.md",
"LICENSE"
], ],
"exports": { "exports": {
".": { ".": {
@@ -20,20 +22,19 @@
"scripts": { "scripts": {
"build": "tsup-node library/main.ts --target node16 --format cjs,esm --dts --sourcemap", "build": "tsup-node library/main.ts --target node16 --format cjs,esm --dts --sourcemap",
"build-watch": "pnpm build -- --watch", "build-watch": "pnpm build -- --watch",
"test": "node --experimental-vm-modules --no-warnings ./node_modules/jest/bin/jest.js --colors", "test": "vitest --coverage --no-watch",
"test-watch": "pnpm test -- --watch", "test-dev": "vitest",
"coverage": "pnpm test -- --coverage",
"typecheck": "tsc --noEmit", "typecheck": "tsc --noEmit",
"playground": "nodemon --exec esmo --ext ts,tsx ./playground/main.tsx", "playground": "nodemon --exec esmo --ext ts,tsx --inspect=5858 --enable-source-maps ./playground/main.tsx",
"release": "release-it" "release": "bash scripts/release.sh"
}, },
"dependencies": { "dependencies": {
"@types/node": "*", "@types/node": "*",
"@types/react": "*", "@types/react": "*",
"@types/react-reconciler": "^0.26.4", "@types/react-reconciler": "^0.26.4",
"nanoid": "^3.1.30", "nanoid": "^3.1.31",
"react-reconciler": "^0.26.2", "react-reconciler": "^0.26.2",
"rxjs": "^7.5.1" "rxjs": "^7.5.2"
}, },
"peerDependencies": { "peerDependencies": {
"discord.js": "^13.3", "discord.js": "^13.3",
@@ -45,28 +46,35 @@
} }
}, },
"devDependencies": { "devDependencies": {
"@jest/globals": "^27.4.4",
"@types/jest": "^27.0.3",
"@types/lodash-es": "^4.17.5", "@types/lodash-es": "^4.17.5",
"c8": "^7.10.0", "c8": "^7.11.0",
"discord.js": "^13.4.0", "discord.js": "^13.5.1",
"dotenv": "^10.0.0", "dotenv": "^11.0.0",
"esbuild": "latest", "esbuild": "latest",
"esbuild-jest": "^0.5.0", "esbuild-jest": "^0.5.0",
"esmo": "^0.13.0", "esmo": "^0.13.0",
"jest": "^27.4.5",
"lodash-es": "^4.17.21", "lodash-es": "^4.17.21",
"nodemon": "^2.0.15", "nodemon": "^2.0.15",
"prettier": "^2.5.1", "prettier": "^2.5.1",
"pretty-ms": "^7.0.1", "pretty-ms": "^7.0.1",
"react": "^17.0.2", "react": "^17.0.2",
"release-it": "^14.12.0", "release-it": "^14.12.1",
"tsup": "^5.11.9", "tsup": "^5.11.11",
"type-fest": "^2.8.0", "type-fest": "^2.9.0",
"typescript": "^4.5.4" "typescript": "^4.5.4",
"vite": "^2.7.10",
"vitest": "^0.0.141"
}, },
"resolutions": { "resolutions": {
"esbuild": "latest" "esbuild": "latest"
}, },
"prettier": "@itsmapleleaf/configs/prettier" "release-it": {
"git": {
"commitMessage": "release v${version}"
},
"github": {
"release": true,
"web": true
}
}
} }

View File

@@ -23,6 +23,7 @@ export function Counter(props: { onDeactivate: () => void }) {
)} )}
<Button <Button
style="primary" style="primary"
emoji="<:plus_one:778531744860602388>"
label="clicc" label="clicc"
onClick={() => setCount(count + 1)} onClick={() => setCount(count + 1)}
/> />

View File

@@ -1,7 +1,7 @@
import { Client } from "discord.js" import { Client } from "discord.js"
import "dotenv/config" import "dotenv/config"
import React from "react" import React from "react"
import { Button, ReacordDiscordJs } from "../library/main" import { Button, ReacordDiscordJs, useInstance } from "../library/main"
import { createCommandHandler } from "./command-handler" import { createCommandHandler } from "./command-handler"
import { Counter } from "./counter" import { Counter } from "./counter"
import { FruitSelect } from "./fruit-select" import { FruitSelect } from "./fruit-select"
@@ -93,6 +93,17 @@ createCommandHandler(client, [
) )
}, },
}, },
{
name: "delete-this",
description: "delete this",
run: (interaction) => {
function DeleteThis() {
const instance = useInstance()
return <Button label="delete this" onClick={() => instance.destroy()} />
}
reacord.reply(interaction, <DeleteThis />)
},
},
]) ])
await client.login(process.env.TEST_BOT_TOKEN) await client.login(process.env.TEST_BOT_TOKEN)

View File

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

View File

@@ -1,6 +1,7 @@
import React from "react" import React from "react"
import { ReacordTester } from "../library/core/reacord-tester" import { test } from "vitest"
import { ActionRow, Button, Select } from "../library/main" import { ActionRow, Button, Select } from "../library/main"
import { ReacordTester } from "./test-adapter"
const testing = new ReacordTester() const testing = new ReacordTester()

View File

@@ -1,2 +1,3 @@
import { test } from "vitest"
test.todo("channel message renderer") test.todo("channel message renderer")
export {}

View File

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

View File

@@ -1,5 +1,5 @@
import React from "react" import React from "react"
import { ReacordTester } from "../library/core/reacord-tester" import { test } from "vitest"
import { import {
Embed, Embed,
EmbedAuthor, EmbedAuthor,
@@ -9,6 +9,7 @@ import {
EmbedThumbnail, EmbedThumbnail,
EmbedTitle, EmbedTitle,
} from "../library/main" } from "../library/main"
import { ReacordTester } from "./test-adapter"
const testing = new ReacordTester() const testing = new ReacordTester()

View File

@@ -1,2 +1,2 @@
import { test } from "vitest"
test.todo("ephemeral reply") test.todo("ephemeral reply")
export {}

View File

@@ -1,3 +1,4 @@
import { test } from "vitest"
test.todo("button onClick") test.todo("button onClick")
test.todo("select onChange") test.todo("select onChange")
export {}

View File

@@ -1,6 +1,7 @@
import React from "react" import React from "react"
import { ReacordTester } from "../library/core/reacord-tester" import { test } from "vitest"
import { Link } from "../library/main" import { Link } from "../library/main"
import { ReacordTester } from "./test-adapter"
const tester = new ReacordTester() const tester = new ReacordTester()

View File

@@ -1,11 +1,7 @@
import * as React from "react" import * as React from "react"
import { import { test } from "vitest"
Button, import { Button, Embed, EmbedField, EmbedTitle } from "../library/main"
Embed, import { ReacordTester } from "./test-adapter"
EmbedField,
EmbedTitle,
ReacordTester,
} from "../library/main"
test("rendering behavior", async () => { test("rendering behavior", async () => {
const tester = new ReacordTester() const tester = new ReacordTester()

View File

@@ -1,6 +1,6 @@
import { test } from "vitest"
// test that the interaction update is _eventually_ deferred if there's no component update, // test that the interaction update is _eventually_ deferred if there's no component update,
// and that update isn't called after the fact // and that update isn't called after the fact
// ...somehow // ...somehow
test.todo("defer update timeout") test.todo("defer update timeout")
export {}

View File

@@ -1,10 +1,11 @@
import { jest } from "@jest/globals"
import React, { useState } from "react" import React, { useState } from "react"
import { Button, Option, ReacordTester, Select } from "../library/main" import { expect, fn, test } from "vitest"
import { Button, Option, Select } from "../library/main"
import { ReacordTester } from "./test-adapter"
test("single select", async () => { test("single select", async () => {
const tester = new ReacordTester() const tester = new ReacordTester()
const onSelect = jest.fn() const onSelect = fn()
function TestSelect() { function TestSelect() {
const [value, setValue] = useState<string>() const [value, setValue] = useState<string>()
@@ -74,7 +75,7 @@ test("single select", async () => {
test("multiple select", async () => { test("multiple select", async () => {
const tester = new ReacordTester() const tester = new ReacordTester()
const onSelect = jest.fn() const onSelect = fn()
function TestSelect() { function TestSelect() {
const [values, setValues] = useState<string[]>([]) const [values, setValues] = useState<string[]>([])
@@ -125,13 +126,13 @@ test("multiple select", async () => {
expect(onSelect).toHaveBeenCalledTimes(0) expect(onSelect).toHaveBeenCalledTimes(0)
tester.findSelectByPlaceholder("select").select("1", "3") 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(onSelect).toHaveBeenCalledWith(
expect.objectContaining({ values: expect.arrayContaining(["1", "3"]) }), expect.objectContaining({ values: expect.arrayContaining(["1", "3"]) }),
) )
tester.findSelectByPlaceholder("select").select("2") tester.findSelectByPlaceholder("select").select("2")
await assertSelect(expect.arrayContaining(["2"])) await assertSelect(expect.arrayContaining(["2"]) as unknown as string[])
expect(onSelect).toHaveBeenCalledWith( expect(onSelect).toHaveBeenCalledWith(
expect.objectContaining({ values: expect.arrayContaining(["2"]) }), expect.objectContaining({ values: expect.arrayContaining(["2"]) }),
) )

View File

@@ -4,37 +4,41 @@ import { nanoid } from "nanoid"
import { nextTick } from "node:process" import { nextTick } from "node:process"
import { promisify } from "node:util" import { promisify } from "node:util"
import type { ReactNode } from "react" import type { ReactNode } from "react"
import { logPretty } from "../../helpers/log-pretty" import { expect } from "vitest"
import { omit } from "../../helpers/omit" import { logPretty } from "../helpers/log-pretty"
import { raise } from "../../helpers/raise" import { omit } from "../helpers/omit"
import type { Channel } from "../internal/channel" import { pruneNullishValues } from "../helpers/prune-nullish-values"
import { Container } from "../internal/container" import { raise } from "../helpers/raise"
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 type { import type {
ChannelInfo, ChannelInfo,
GuildInfo, GuildInfo,
MessageInfo, MessageInfo,
UserInfo, UserInfo,
} from "./component-event" } from "../library/core/component-event"
import type { ButtonClickEvent } from "./components/button" import type { ButtonClickEvent } from "../library/core/components/button"
import type { SelectChangeEvent } from "./components/select" import type { SelectChangeEvent } from "../library/core/components/select"
import type { ReacordInstance } from "./instance" import type { ReacordInstance } from "../library/core/instance"
import { Reacord } from "./reacord" 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,
MessageButtonOptions,
MessageOptions,
MessageSelectOptions,
} 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) const nextTickPromise = promisify(nextTick)
export type MessageSample = ReturnType<ReacordTester["sampleMessages"]>[0]
/** /**
* A Record adapter for automated tests. WIP * A Record adapter for automated tests. WIP
*/ */
@@ -49,33 +53,32 @@ export class ReacordTester extends Reacord {
return [...this.messageContainer] return [...this.messageContainer]
} }
override send(): ReacordInstance { override send(initialContent?: ReactNode): ReacordInstance {
return this.createInstance( return this.createInstance(
new ChannelMessageRenderer(new TestChannel(this.messageContainer)), new ChannelMessageRenderer(new TestChannel(this.messageContainer)),
initialContent,
) )
} }
override reply(): ReacordInstance { override reply(initialContent?: ReactNode): ReacordInstance {
return this.createInstance( return this.createInstance(
new InteractionReplyRenderer( new InteractionReplyRenderer(
new TestCommandInteraction(this.messageContainer), new TestCommandInteraction(this.messageContainer),
), ),
initialContent,
) )
} }
override ephemeralReply(): ReacordInstance { override ephemeralReply(initialContent?: ReactNode): ReacordInstance {
return this.reply() return this.reply(initialContent)
} }
async assertMessages(expected: ReturnType<this["sampleMessages"]>) { async assertMessages(expected: MessageSample[]) {
await nextTickPromise() await nextTickPromise()
expect(this.sampleMessages()).toEqual(expected) expect(this.sampleMessages()).toEqual(expected)
} }
async assertRender( async assertRender(content: ReactNode, expected: MessageSample[]) {
content: ReactNode,
expected: ReturnType<this["sampleMessages"]>,
) {
const instance = this.reply() const instance = this.reply()
instance.render(content) instance.render(content)
await this.assertMessages(expected) await this.assertMessages(expected)
@@ -87,14 +90,21 @@ export class ReacordTester extends Reacord {
} }
sampleMessages() { sampleMessages() {
return this.messages.map((message) => ({ return pruneNullishValues(
this.messages.map((message) => ({
...message.options, ...message.options,
actionRows: message.options.actionRows.map((row) => actionRows: message.options.actionRows.map((row) =>
row.map((component) => row.map((component) =>
omit(component, ["customId", "onClick", "onSelect", "onSelectValue"]), omit(component, [
"customId",
"onClick",
"onSelect",
"onSelectValue",
]),
), ),
), ),
})) })),
)
} }
findButtonByLabel(label: string) { findButtonByLabel(label: string) {
@@ -265,11 +275,11 @@ class TestComponentEvent {
guild: GuildInfo = {} as any // todo guild: GuildInfo = {} as any // todo
reply(content?: ReactNode): ReacordInstance { reply(content?: ReactNode): ReacordInstance {
return this.tester.reply() return this.tester.reply(content)
} }
ephemeralReply(content?: ReactNode): ReacordInstance { ephemeralReply(content?: ReactNode): ReacordInstance {
return this.tester.ephemeralReply() return this.tester.ephemeralReply(content)
} }
} }

View File

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

View File

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

9
packages/website/.gitignore vendored Normal file
View File

@@ -0,0 +1,9 @@
node_modules
/.cache
/build
/public/build
.env
/public/api
cypress/videos
cypress/screenshots

View File

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

View File

@@ -0,0 +1,21 @@
import { renderToString } from "react-dom/server";
import { RemixServer } from "remix";
import type { EntryContext } from "remix";
export default function handleRequest(
request: Request,
responseStatusCode: number,
responseHeaders: Headers,
remixContext: EntryContext
) {
const markup = renderToString(
<RemixServer context={remixContext} url={request.url} />
);
responseHeaders.set("Content-Type", "text/html");
return new Response("<!DOCTYPE html>" + markup, {
status: responseStatusCode,
headers: responseHeaders
});
}

View File

@@ -1,4 +1,4 @@
<!-- prettier-ignore --> {/* prettier-ignore */}
```tsx ```tsx
import * as React from "react" import * as React from "react"
import { Embed, Button } from "reacord" import { Embed, Button } from "reacord"

View File

@@ -0,0 +1,31 @@
import type { ComponentPropsWithoutRef } from "react"
import { Link } from "remix"
export type AppLinkProps = ComponentPropsWithoutRef<"a"> & {
type: "internal" | "external" | "router"
to: string
}
export function AppLink({ type, to, children, ...props }: AppLinkProps) {
if (type === "internal") {
return (
<a href={to} {...props}>
{children}
</a>
)
}
if (type === "external") {
return (
<a href={to} target="_blank" rel="noopener noreferrer" {...props}>
{children}
</a>
)
}
return (
<Link to={to} {...props}>
{children}
</Link>
)
}

View File

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

View File

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

View File

@@ -2,16 +2,15 @@ import {
CodeIcon, CodeIcon,
DocumentTextIcon, DocumentTextIcon,
ExternalLinkIcon, ExternalLinkIcon,
} from "@heroicons/react/solid/esm" } from "@heroicons/react/solid"
import React from "react" import type { AppLinkProps } from "~/modules/navigation/app-link"
import { inlineIconClass } from "../ui/components" import { inlineIconClass } from "../ui/components"
import type { AppLinkProps } from "./app-link"
export const mainLinks: AppLinkProps[] = [ export const mainLinks: AppLinkProps[] = [
{ {
type: "internal", type: "internal",
to: "/guides/getting-started", to: "/guides/getting-started",
label: ( children: (
<> <>
<DocumentTextIcon className={inlineIconClass} /> Guides <DocumentTextIcon className={inlineIconClass} /> Guides
</> </>
@@ -20,7 +19,7 @@ export const mainLinks: AppLinkProps[] = [
{ {
type: "internal", type: "internal",
to: "/api", to: "/api",
label: ( children: (
<> <>
<CodeIcon className={inlineIconClass} /> API Reference <CodeIcon className={inlineIconClass} /> API Reference
</> </>
@@ -29,7 +28,7 @@ export const mainLinks: AppLinkProps[] = [
{ {
type: "external", type: "external",
to: "https://github.com/itsMapleLeaf/reacord", to: "https://github.com/itsMapleLeaf/reacord",
label: ( children: (
<> <>
<ExternalLinkIcon className={inlineIconClass} /> GitHub <ExternalLinkIcon className={inlineIconClass} /> GitHub
</> </>

View File

@@ -1,11 +1,11 @@
import React from "react" import { useGuideLinksContext } from "~/modules/navigation/guide-links-context"
import { linkClass } from "../ui/components" import { linkClass } from "../ui/components"
import { PopoverMenu } from "../ui/popover-menu" import { PopoverMenu } from "../ui/popover-menu"
import { AppLink } from "./app-link" import { AppLink } from "./app-link"
import { guideLinks } from "./guide-links"
import { mainLinks } from "./main-links" import { mainLinks } from "./main-links"
export function MainNavigation() { export function MainNavigation() {
const guideLinks = useGuideLinksContext()
return ( return (
<nav className="flex justify-between items-center h-16"> <nav className="flex justify-between items-center h-16">
<a href="/"> <a href="/">
@@ -16,19 +16,21 @@ export function MainNavigation() {
<AppLink {...link} key={link.to} className={linkClass} /> <AppLink {...link} key={link.to} className={linkClass} />
))} ))}
</div> </div>
<div className="md:hidden" id="main-navigation-popover"> <div className="md:hidden">
<PopoverMenu> <PopoverMenu>
{mainLinks.map((link) => ( {mainLinks.map((link) => (
<AppLink <AppLink
{...link} {...link}
role="menuitem"
key={link.to} key={link.to}
className={PopoverMenu.itemClass} className={PopoverMenu.itemClass}
/> />
))} ))}
<hr className="border-0 h-[2px] bg-black/50" /> <hr className="border-0 h-[2px] bg-black/50" />
{guideLinks.map((link) => ( {guideLinks.map(({ link }) => (
<AppLink <AppLink
{...link} {...link}
role="menuitem"
key={link.to} key={link.to}
className={PopoverMenu.itemClass} className={PopoverMenu.itemClass}
/> />

View File

@@ -1,4 +1,4 @@
import { MenuAlt4Icon } from "@heroicons/react/outline/esm" import { MenuAlt4Icon } from "@heroicons/react/outline"
import clsx from "clsx" import clsx from "clsx"
import React from "react" import React from "react"
import { linkClass } from "./components" import { linkClass } from "./components"
@@ -10,6 +10,7 @@ export function PopoverMenu({ children }: { children: React.ReactNode }) {
<MenuAlt4Icon className="w-6" /> <MenuAlt4Icon className="w-6" />
</button> </button>
<div <div
role="menu"
className={` className={`
w-48 max-h-[calc(100vh-4rem)] w-48 max-h-[calc(100vh-4rem)]
absolute right-0 top-[calc(100%+8px)] absolute right-0 top-[calc(100%+8px)]

View File

@@ -0,0 +1,9 @@
@tailwind base;
@tailwind components;
@tailwind utilities;
@layer utilities {
.prose aside {
@apply opacity-75 italic border-l-4 pl-3 border-white/50;
}
}

4
packages/website/app/react.d.ts vendored Normal file
View File

@@ -0,0 +1,4 @@
import "react"
declare module "react" {
export function createContext<Value>(): Context<Value | undefined>
}

2
packages/website/app/remix.env.d.ts vendored Normal file
View File

@@ -0,0 +1,2 @@
/// <reference types="@remix-run/dev" />
/// <reference types="@remix-run/node/globals" />

View File

@@ -0,0 +1,68 @@
import packageJson from "reacord/package.json"
import type { LinksFunction, LoaderFunction, MetaFunction } from "remix"
import {
Links,
LiveReload,
Meta,
Outlet,
ScrollRestoration,
useLoaderData,
} from "remix"
import { GuideLinksProvider } from "~/modules/navigation/guide-links-context"
import type { GuideLink } from "~/modules/navigation/load-guide-links.server"
import { loadGuideLinks } from "~/modules/navigation/load-guide-links.server"
import prismThemeCss from "~/modules/ui/prism-theme.css"
export const meta: MetaFunction = () => ({
title: "Reacord",
description: packageJson.description,
})
export const links: LinksFunction = () => [
{ rel: "preconnect", href: "https://fonts.googleapis.com" },
{
rel: "preconnect",
href: "https://fonts.gstatic.com",
crossOrigin: "anonymous",
},
{
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",
},
{ rel: "stylesheet", href: "/tailwind.css" },
{ rel: "stylesheet", href: prismThemeCss },
]
type LoaderData = {
guideLinks: GuideLink[]
}
export const loader: LoaderFunction = async () => {
const data: LoaderData = {
guideLinks: await loadGuideLinks(),
}
return data
}
export default function App() {
const data: LoaderData = useLoaderData()
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 />
<Links />
<script defer src="https://unpkg.com/alpinejs@3.7.1/dist/cdn.min.js" />
</head>
<body>
<GuideLinksProvider value={data.guideLinks}>
<Outlet />
</GuideLinksProvider>
<ScrollRestoration />
{process.env.NODE_ENV === "development" && <LiveReload />}
</body>
</html>
)
}

View File

@@ -0,0 +1,38 @@
import clsx from "clsx"
import { Outlet } from "remix"
import { AppLink } from "~/modules/navigation/app-link"
import { useGuideLinksContext } from "~/modules/navigation/guide-links-context"
import { MainNavigation } from "~/modules/navigation/main-navigation"
import {
docsProseClass,
linkClass,
maxWidthContainer,
} from "~/modules/ui/components"
export default function GuidePage() {
const guideLinks = useGuideLinksContext()
return (
<>
<header className="bg-slate-700/30 shadow sticky top-0 backdrop-blur-sm transition z-10 flex">
<div className={maxWidthContainer}>
<MainNavigation />
</div>
</header>
<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")}>
<Outlet />
</section>
</main>
</>
)
}

View File

@@ -1,7 +1,8 @@
--- ---
order: 3 order: 3
title: Buttons meta:
description: Using button components title: Buttons
description: Using button components
--- ---
# Buttons # Buttons
@@ -43,4 +44,4 @@ function TheButton() {
} }
``` ```
See the [API reference](/api) for more information. See the [API reference](/api/index.html#ButtonProps) for more information.

View File

@@ -1,6 +1,7 @@
--- ---
title: Using Reacord with other libraries meta:
description: Adapting Reacord to another Discord library title: Using Reacord with other libraries
description: Adapting Reacord to another Discord library
--- ---
# Using Reacord with other libraries # Using Reacord with other libraries

View File

@@ -1,7 +1,8 @@
--- ---
order: 2 order: 2
title: Embeds meta:
description: Using embed components title: Embeds
description: Using embed components
--- ---
# Embeds # Embeds
@@ -60,4 +61,4 @@ reacord.send(
) )
``` ```
See the [API Reference](/api) for the full list of embed components. See the [API Reference](/api/index.html#EmbedAuthorProps) for the full list of embed components.

View File

@@ -1,7 +1,8 @@
--- ---
order: 0 order: 0
title: Getting Started meta:
description: Learn how to get started with Reacord. title: Getting Started
description: Learn how to get started with Reacord.
--- ---
# Getting Started # Getting Started

View File

@@ -0,0 +1,25 @@
---
order: 3
meta:
title: Links
description: Using link components
---
# Links
In Discord, links are a type of button, and they work similarly. Clicking on it leads you to the given URL. They only have one style, and can't be listened to for clicks.
```jsx
import { Link } from "reacord"
function AwesomeLinks() {
return (
<>
<Link label="look at this" url="https://google.com" />
<Link label="wow" url="https://youtube.com/watch?v=dQw4w9WgXcQ" />
</>
)
}
```
See the [API reference](/api/index.html#Link) for more information.

View File

@@ -1,7 +1,8 @@
--- ---
order: 4 order: 4
title: Select Menus meta:
description: Using select menu components title: Select Menus
description: Using select menu components
--- ---
# Select Menus # Select Menus
@@ -67,4 +68,4 @@ export function FruitSelect({ onConfirm }) {
} }
``` ```
The Select component accepts a variety of props beyond what's shown here. See the [API reference](/api) for more information. The Select component accepts a variety of props beyond what's shown here. See the [API reference](/api/index.html#SelectChangeEvent) for more information.

View File

@@ -1,7 +1,8 @@
--- ---
order: 1 order: 1
title: Sending Messages meta:
description: Sending messages by creating Reacord instances title: Sending Messages
description: Sending messages by creating Reacord instances
--- ---
# Sending Messages with Instances # Sending Messages with Instances

View File

@@ -0,0 +1,26 @@
---
meta:
title: useInstance
description: Using useInstance to get the current instance within a component
---
# useInstance
You can use `useInstance` to get the current [instance](/guides/sending-messages) within a component. This can be used to let a component destroy or deactivate itself.
```jsx
import { Button, useInstance } from "reacord"
function SelfDestruct() {
const instance = useInstance()
return (
<Button
style="danger"
label="delete this"
onClick={() => instance.destroy()}
/>
)
}
reacord.send(channelId, <SelfDestruct />)
```

View File

@@ -0,0 +1,29 @@
import packageJson from "reacord/package.json"
import LandingExample from "~/modules/landing/landing-example.mdx"
import { MainNavigation } from "~/modules/navigation/main-navigation"
import { maxWidthContainer } from "~/modules/ui/components"
export default function Landing() {
return (
<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>
<section className="mx-auto text-sm sm:text-base">
<LandingExample />
</section>
<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>
)
}

View File

@@ -0,0 +1,5 @@
import type { LoaderFunction } from "remix"
import { serveTailwindCss } from "remix-tailwind"
export const loader: LoaderFunction = () =>
serveTailwindCss("app/modules/ui/tailwind.css")

View File

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

View File

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

View File

@@ -0,0 +1,12 @@
export {}
describe("main popover menu", () => {
it("should toggle on button click", () => {
cy.viewport(480, 720)
cy.visit("/")
cy.findByRole("button", { name: "Menu" }).click()
cy.findByRole("menu").should("be.visible")
cy.findByRole("button", { name: "Menu" }).click()
cy.findByRole("menu").should("not.exist")
})
})

View File

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

View File

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

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