2 Commits

Author SHA1 Message Date
MapleLeaf
d6e2f083bc more docks mockuping 2022-01-14 15:58:06 -06:00
MapleLeaf
723d663d3c wip custom reference page 2022-01-14 15:58:06 -06:00
47 changed files with 2241 additions and 3159 deletions

View File

@@ -1,25 +0,0 @@
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"),
},
},
],
}

26
.eslintrc.json Normal file
View File

@@ -0,0 +1,26 @@
{
"extends": ["./node_modules/@itsmapleleaf/configs/eslint"],
"ignorePatterns": [
"**/node_modules/**",
"**/.cache/**",
"**/build/**",
"**/dist/**",
"**/coverage/**",
"**/public/**"
],
"parserOptions": {
"project": "./tsconfig.base.json"
},
"rules": {
"import/no-unused-modules": "off",
"unicorn/prevent-abbreviations": "off"
},
"overrides": [
{
"files": ["packages/website/cypress/**"],
"parserOptions": {
"project": "./packages/website/cypress/tsconfig.json"
}
}
]
}

17
.github/workflows/deploy-website.yml vendored Normal file
View File

@@ -0,0 +1,17 @@
name: deploy website
on:
push:
branches: [main]
paths:
- "packages/website/**"
- "reacord/library/**/*.{ts,tsx}"
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"

3
.gitignore vendored
View File

@@ -3,7 +3,4 @@ node_modules
.vscode .vscode
coverage coverage
.env .env
*.code-workspace
build
.cache

1
.npmrc
View File

@@ -1 +0,0 @@
ignore-workspace-root-check = true

View File

@@ -4,4 +4,3 @@ coverage
pnpm-lock.yaml pnpm-lock.yaml
build build
.cache .cache
packages/website/public/api

15
Dockerfile Normal file
View File

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

View File

@@ -18,7 +18,7 @@ pnpm add reacord react discord.js
## Get Started ## Get Started
[Visit the docs to get started.](https://reacord.mapleleaf.dev/guides/getting-started) [Visit the docs to get started.](https://reacord.fly.dev/guides/getting-started)
## Example ## Example

40
fly.toml Normal file
View File

@@ -0,0 +1,40 @@
# 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"

View File

@@ -3,19 +3,24 @@
"scripts": { "scripts": {
"lint": "eslint --ext js,ts,tsx .", "lint": "eslint --ext js,ts,tsx .",
"lint-fix": "pnpm lint -- --fix", "lint-fix": "pnpm lint -- --fix",
"format": "prettier --write .", "format": "prettier --write ."
"release": "pnpm -C packages/reacord run release", },
"build": "pnpm -C packages/website run build", "dependencies": {
"start": "pnpm -C packages/website run start" "@itsmapleleaf/configs": "^1.1.2"
}, },
"devDependencies": { "devDependencies": {
"@itsmapleleaf/configs": "^1.1.3", "@typescript-eslint/eslint-plugin": "^5.9.1",
"@rushstack/eslint-patch": "^1.1.3", "@typescript-eslint/parser": "^5.9.1",
"@types/eslint": "^8.4.1", "eslint": "^8.6.0",
"eslint": "^8.14.0", "eslint-config-prettier": "^8.3.0",
"prettier": "^2.6.2", "eslint-import-resolver-typescript": "^2.5.0",
"typescript": "^4.6.3", "eslint-plugin-import": "^2.25.4",
"node": "^16" "eslint-plugin-jsx-a11y": "^6.5.1",
"eslint-plugin-react": "^7.28.0",
"eslint-plugin-react-hooks": "^4.3.0",
"eslint-plugin-unicorn": "^40.0.0",
"prettier": "^2.5.1",
"typescript": "^4.5.4"
}, },
"resolutions": { "resolutions": {
"esbuild": "latest" "esbuild": "latest"

View File

@@ -1,5 +1,6 @@
import { inspect } from "node:util" import { inspect } from "node:util"
// eslint-disable-next-line import/no-unused-modules
export function logPretty(value: unknown) { export function logPretty(value: unknown) {
console.info( console.info(
inspect(value, { inspect(value, {

View File

@@ -1,3 +1,4 @@
// eslint-disable-next-line import/no-unused-modules
export function omit<Subject extends object, Key extends PropertyKey>( export function omit<Subject extends object, Key extends PropertyKey>(
subject: Subject, subject: Subject,
keys: Key[], keys: Key[],

View File

@@ -1,5 +1,6 @@
import type { LoosePick, UnknownRecord } from "./types" import type { LoosePick, UnknownRecord } from "./types"
// eslint-disable-next-line import/no-unused-modules
export function pick<T, K extends keyof T | PropertyKey>( export function pick<T, K extends keyof T | PropertyKey>(
object: T, object: T,
keys: K[], keys: K[],

View File

@@ -1,35 +0,0 @@
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)
})

View File

@@ -18,25 +18,10 @@ export function pruneNullishValues<T>(input: T): PruneNullishValues<T> {
return result return result
} }
export type PruneNullishValues<Input> = Input extends object type PruneNullishValues<Input> = Input extends ReadonlyArray<infer Value>
? OptionalKeys< ? ReadonlyArray<NonNullable<Value>>
{ [Key in keyof Input]: NonNullable<PruneNullishValues<Input[Key]>> }, : Input extends object
KeysWithNullishValues<Input> ? {
> [Key in keyof Input]: NonNullable<Input[Key]>
}
: 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]

View File

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

View File

@@ -1,21 +0,0 @@
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")
}

View File

@@ -1,5 +1,6 @@
import { inspect } from "node:util" import { inspect } from "node:util"
// eslint-disable-next-line import/no-unused-modules
export function withLoggedMethodCalls<T extends object>(value: T) { export function withLoggedMethodCalls<T extends object>(value: T) {
return new Proxy(value as Record<string | symbol, unknown>, { return new Proxy(value as Record<string | symbol, unknown>, {
get(target, property) { get(target, property) {

View File

@@ -10,7 +10,7 @@ export const InstanceProvider = Context.Provider
* Get the associated instance for the current component. * Get the associated instance for the current component.
* *
* @category Core * @category Core
* @see https://reacord.mapleleaf.dev/guides/use-instance * @see https://reacord.fly.dev/guides/use-instance
*/ */
export function useInstance(): ReacordInstance { export function useInstance(): ReacordInstance {
return ( return (

View File

@@ -40,7 +40,7 @@ export class ReacordDiscordJs extends Reacord {
/** /**
* Sends a message to a channel. * Sends a message to a channel.
* @see https://reacord.mapleleaf.dev/guides/sending-messages * @see https://reacord.fly.dev/guides/sending-messages
*/ */
override send( override send(
channelId: string, channelId: string,
@@ -54,7 +54,7 @@ export class ReacordDiscordJs extends Reacord {
/** /**
* Sends a message as a reply to a command interaction. * Sends a message as a reply to a command interaction.
* @see https://reacord.mapleleaf.dev/guides/sending-messages * @see https://reacord.fly.dev/guides/sending-messages
*/ */
override reply( override reply(
interaction: Discord.CommandInteraction, interaction: Discord.CommandInteraction,
@@ -68,7 +68,7 @@ export class ReacordDiscordJs extends Reacord {
/** /**
* Sends an ephemeral message as a reply to a command interaction. * Sends an ephemeral message as a reply to a command interaction.
* @see https://reacord.mapleleaf.dev/guides/sending-messages * @see https://reacord.fly.dev/guides/sending-messages
*/ */
override ephemeralReply( override ephemeralReply(
interaction: Discord.CommandInteraction, interaction: Discord.CommandInteraction,
@@ -298,6 +298,17 @@ function createReacordMessage(message: Discord.Message): Message {
edit: async (options) => { edit: async (options) => {
await message.edit(getDiscordMessageOptions(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 () => { delete: async () => {
await message.delete() await message.delete()
}, },
@@ -310,6 +321,10 @@ function createEphemeralReacordMessage(): Message {
console.warn("Ephemeral messages can't be edited") console.warn("Ephemeral messages can't be edited")
return Promise.resolve() return Promise.resolve()
}, },
disableComponents: () => {
console.warn("Ephemeral messages can't be edited")
return Promise.resolve()
},
delete: () => { delete: () => {
console.warn("Ephemeral messages can't be deleted") console.warn("Ephemeral messages can't be deleted")
return Promise.resolve() return Promise.resolve()

View File

@@ -49,6 +49,7 @@ export type MessageSelectOptionOptions = {
export type Message = { export type Message = {
edit(options: MessageOptions): Promise<void> edit(options: MessageOptions): Promise<void>
delete(): Promise<void> delete(): Promise<void>
disableComponents(): Promise<void>
} }
export function getNextActionRow(options: MessageOptions): ActionRow { export function getNextActionRow(options: MessageOptions): ActionRow {

View File

@@ -52,8 +52,6 @@ const config: HostConfig<
}, },
createTextInstance: (text) => new TextNode(text), createTextInstance: (text) => new TextNode(text),
shouldSetTextContent: () => false, shouldSetTextContent: () => false,
// @ts-expect-error
detachDeletedInstance: (instance) => {},
clearContainer: (renderer) => { clearContainer: (renderer) => {
renderer.nodes.clear() renderer.nodes.clear()

View File

@@ -83,17 +83,7 @@ export abstract class Renderer {
if (payload.action === "deactivate") { if (payload.action === "deactivate") {
this.updateSubscription.unsubscribe() 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 return
} }

View File

@@ -2,9 +2,9 @@
"name": "reacord", "name": "reacord",
"type": "module", "type": "module",
"description": "Create interactive Discord messages using React.", "description": "Create interactive Discord messages using React.",
"version": "0.3.7", "version": "0.3.4",
"types": "./dist/main.d.ts", "types": "./dist/main.d.ts",
"homepage": "https://reacord.mapleleaf.dev", "homepage": "https://reacord.fly.dev",
"repository": "https://github.com/itsMapleLeaf/reacord.git", "repository": "https://github.com/itsMapleLeaf/reacord.git",
"changelog": "https://github.com/itsMapleLeaf/reacord/releases", "changelog": "https://github.com/itsMapleLeaf/reacord/releases",
"license": "MIT", "license": "MIT",
@@ -35,7 +35,7 @@
} }
}, },
"scripts": { "scripts": {
"build": "tsup library/main.ts --target node16 --format cjs,esm --dts --sourcemap", "build": "tsup-node library/main.ts --target node16 --format cjs,esm --dts --sourcemap",
"build-watch": "pnpm build -- --watch", "build-watch": "pnpm build -- --watch",
"test": "vitest --coverage --no-watch", "test": "vitest --coverage --no-watch",
"test-dev": "vitest", "test-dev": "vitest",
@@ -46,10 +46,10 @@
"dependencies": { "dependencies": {
"@types/node": "*", "@types/node": "*",
"@types/react": "*", "@types/react": "*",
"@types/react-reconciler": "^0.26.6", "@types/react-reconciler": "^0.26.4",
"nanoid": "^3.3.3", "nanoid": "^3.1.31",
"react-reconciler": "^0.27.0", "react-reconciler": "^0.26.2",
"rxjs": "^7.5.5" "rxjs": "^7.5.2"
}, },
"peerDependencies": { "peerDependencies": {
"discord.js": "^13.3", "discord.js": "^13.3",
@@ -61,24 +61,24 @@
} }
}, },
"devDependencies": { "devDependencies": {
"@types/lodash-es": "^4.17.6", "@types/lodash-es": "^4.17.5",
"c8": "^7.11.2", "c8": "^7.11.0",
"discord.js": "^13.6.0", "discord.js": "^13.5.1",
"dotenv": "^16.0.0", "dotenv": "^11.0.0",
"esbuild": "latest", "esbuild": "latest",
"esbuild-jest": "^0.5.0", "esbuild-jest": "^0.5.0",
"esmo": "^0.14.1", "esmo": "^0.13.0",
"lodash-es": "^4.17.21", "lodash-es": "^4.17.21",
"nodemon": "^2.0.15", "nodemon": "^2.0.15",
"prettier": "^2.6.2", "prettier": "^2.5.1",
"pretty-ms": "^7.0.1", "pretty-ms": "^7.0.1",
"react": "^18.0.0", "react": "^17.0.2",
"release-it": "^14.14.2", "release-it": "^14.12.1",
"tsup": "^5.12.6", "tsup": "^5.11.11",
"type-fest": "^2.12.2", "type-fest": "^2.9.0",
"typescript": "^4.6.3", "typescript": "^4.5.4",
"vite": "^2.9.5", "vite": "^2.7.10",
"vitest": "^0.10.0" "vitest": "^0.0.141"
}, },
"resolutions": { "resolutions": {
"esbuild": "latest" "esbuild": "latest"

View File

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

View File

@@ -1,11 +1,11 @@
import React, { useState } from "react" import React, { useState } from "react"
import { expect, test, vi } from "vitest" import { expect, fn, test } from "vitest"
import { Button, Option, Select } from "../library/main" import { Button, Option, Select } from "../library/main"
import { ReacordTester } from "./test-adapter" import { ReacordTester } from "./test-adapter"
test("single select", async () => { test("single select", async () => {
const tester = new ReacordTester() const tester = new ReacordTester()
const onSelect = vi.fn() const onSelect = fn()
function TestSelect() { function TestSelect() {
const [value, setValue] = useState<string>() const [value, setValue] = useState<string>()
@@ -75,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 = vi.fn() const onSelect = fn()
function TestSelect() { function TestSelect() {
const [values, setValues] = useState<string[]>([]) const [values, setValues] = useState<string[]>([])

View File

@@ -1,14 +1,14 @@
/* eslint-disable class-methods-use-this */ /* eslint-disable class-methods-use-this */
/* eslint-disable require-await */ /* eslint-disable require-await */
import { nanoid } from "nanoid" import { nanoid } from "nanoid"
import { setTimeout } from "node:timers/promises" import { nextTick } from "node:process"
import { promisify } from "node:util"
import type { ReactNode } from "react" import type { ReactNode } from "react"
import { expect } from "vitest" import { expect } from "vitest"
import { logPretty } from "../helpers/log-pretty" import { logPretty } from "../helpers/log-pretty"
import { omit } from "../helpers/omit" import { omit } from "../helpers/omit"
import { pruneNullishValues } from "../helpers/prune-nullish-values" import { pruneNullishValues } from "../helpers/prune-nullish-values"
import { raise } from "../helpers/raise" import { raise } from "../helpers/raise"
import { waitFor } from "../helpers/wait-for"
import type { import type {
ChannelInfo, ChannelInfo,
GuildInfo, GuildInfo,
@@ -26,10 +26,17 @@ import type {
CommandInteraction, CommandInteraction,
SelectInteraction, SelectInteraction,
} from "../library/internal/interaction" } from "../library/internal/interaction"
import type { Message, MessageOptions } from "../library/internal/message" import type {
Message,
MessageButtonOptions,
MessageOptions,
MessageSelectOptions,
} from "../library/internal/message"
import { ChannelMessageRenderer } from "../library/internal/renderers/channel-message-renderer" import { ChannelMessageRenderer } from "../library/internal/renderers/channel-message-renderer"
import { InteractionReplyRenderer } from "../library/internal/renderers/interaction-reply-renderer" import { InteractionReplyRenderer } from "../library/internal/renderers/interaction-reply-renderer"
const nextTickPromise = promisify(nextTick)
export type MessageSample = ReturnType<ReacordTester["sampleMessages"]>[0] export type MessageSample = ReturnType<ReacordTester["sampleMessages"]>[0]
/** /**
@@ -66,10 +73,9 @@ export class ReacordTester extends Reacord {
return this.reply(initialContent) return this.reply(initialContent)
} }
assertMessages(expected: MessageSample[]) { async assertMessages(expected: MessageSample[]) {
return waitFor(() => { await nextTickPromise()
expect(this.sampleMessages()).toEqual(expected) expect(this.sampleMessages()).toEqual(expected)
})
} }
async assertRender(content: ReactNode, expected: MessageSample[]) { async assertRender(content: ReactNode, expected: MessageSample[]) {
@@ -102,59 +108,58 @@ export class ReacordTester extends Reacord {
} }
findButtonByLabel(label: string) { findButtonByLabel(label: string) {
return { for (const message of this.messageContainer) {
click: () => { for (const component of message.options.actionRows.flat()) {
return waitFor(() => {
for (const [component, message] of this.eachComponent()) {
if (component.type === "button" && component.label === label) { if (component.type === "button" && component.label === label) {
this.handleComponentInteraction( return this.createButtonActions(component, message)
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) { findSelectByPlaceholder(placeholder: string) {
return { for (const message of this.messageContainer) {
select: (...values: string[]) => { for (const component of message.options.actionRows.flat()) {
return waitFor(() => {
for (const [component, message] of this.eachComponent()) {
if ( if (
component.type === "select" && component.type === "select" &&
component.placeholder === placeholder component.placeholder === placeholder
) { ) {
this.handleComponentInteraction( return this.createSelectActions(component, message)
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) { createMessage(options: MessageOptions) {
return new TestMessage(options, this.messageContainer) return new TestMessage(options, this.messageContainer)
} }
private *eachComponent() { private createButtonActions(
for (const message of this.messageContainer) { button: MessageButtonOptions,
for (const component of message.options.actionRows.flat()) { message: TestMessage,
yield [component, message] as const ) {
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),
)
},
}
} }
} }
@@ -170,6 +175,16 @@ class TestMessage implements Message {
this.options = options 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> { async delete(): Promise<void> {
this.container.remove(this) this.container.remove(this)
} }
@@ -182,14 +197,16 @@ class TestCommandInteraction implements CommandInteraction {
constructor(private messageContainer: Container<TestMessage>) {} constructor(private messageContainer: Container<TestMessage>) {}
async reply(messageOptions: MessageOptions): Promise<Message> { reply(messageOptions: MessageOptions): Promise<Message> {
await setTimeout() return Promise.resolve(
return new TestMessage(messageOptions, this.messageContainer) new TestMessage(messageOptions, this.messageContainer),
)
} }
async followUp(messageOptions: MessageOptions): Promise<Message> { followUp(messageOptions: MessageOptions): Promise<Message> {
await setTimeout() return Promise.resolve(
return new TestMessage(messageOptions, this.messageContainer) new TestMessage(messageOptions, this.messageContainer),
)
} }
} }

View File

@@ -55,7 +55,7 @@ describe("useInstance", () => {
await tester.assertMessages([messageOutput("parent")]) await tester.assertMessages([messageOutput("parent")])
expect(instanceFromHook).toBe(instance) expect(instanceFromHook).toBe(instance)
await tester.findButtonByLabel("create parent").click() tester.findButtonByLabel("create parent").click()
await tester.assertMessages([ await tester.assertMessages([
messageOutput("parent"), messageOutput("parent"),
messageOutput("child"), messageOutput("child"),
@@ -63,10 +63,10 @@ describe("useInstance", () => {
// this test ensures that the only the child instance is destroyed, // this test ensures that the only the child instance is destroyed,
// and not the parent instance // and not the parent instance
await tester.findButtonByLabel("destroy child").click() tester.findButtonByLabel("destroy child").click()
await tester.assertMessages([messageOutput("parent")]) await tester.assertMessages([messageOutput("parent")])
await tester.findButtonByLabel("destroy parent").click() tester.findButtonByLabel("destroy parent").click()
await tester.assertMessages([]) await tester.assertMessages([])
}) })
}) })

View File

@@ -4,7 +4,10 @@ node_modules
/build /build
/public/build /public/build
.env .env
/public/api
cypress/videos cypress/videos
cypress/screenshots cypress/screenshots
*.out.css *.out.css
# typedoc output
/public/api
/app/assets/api.json

View File

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

View File

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

View File

@@ -0,0 +1,8 @@
import type { JSONOutput } from "typedoc"
import apiData from "~/assets/api.json"
export type ApiData = JSONOutput.ContainerReflection
export function getApiData(): ApiData {
return apiData as ApiData
}

View File

@@ -0,0 +1,13 @@
export async function promiseAllObject<Input extends object>(
input: Input,
): Promise<{
[K in keyof Input]: Awaited<Input[K]>
}> {
const result: any = {}
await Promise.all(
Object.entries(input).map(async ([key, promise]) => {
result[key] = await promise
}),
)
return result
}

View File

@@ -0,0 +1,23 @@
export async function renderMarkdown(
markdown: string,
): Promise<{ __html: string }> {
const rehypePrism = import("rehype-prism-plus").then(
(module) => module.default,
)
const rehypeStringify = import("rehype-stringify").then(
(module) => module.default,
)
const remarkParse = import("remark-parse").then((module) => module.default)
const remarkRehype = import("remark-rehype").then((module) => module.default)
const { unified } = await import("unified")
const processor = unified()
.use(await remarkParse)
.use(await remarkRehype)
.use(await rehypeStringify)
.use(await rehypePrism)
const result = await processor.process(markdown)
return { __html: result.toString() }
}

View File

@@ -1,5 +1,5 @@
import type { ComponentPropsWithoutRef } from "react" import type { ComponentPropsWithoutRef } from "react"
import { Link } from "@remix-run/react" import { Link } from "remix"
import { ExternalLink } from "~/modules/dom/external-link" import { ExternalLink } from "~/modules/dom/external-link"
export type AppLinkProps = ComponentPropsWithoutRef<"a"> & { export type AppLinkProps = ComponentPropsWithoutRef<"a"> & {

View File

@@ -9,7 +9,6 @@ export function MainNavigation() {
<nav className="flex justify-between items-center h-16"> <nav className="flex justify-between items-center h-16">
<a href="/"> <a href="/">
<AppLogo className="w-32" /> <AppLogo className="w-32" />
<span className="sr-only">Home</span>
</a> </a>
<div className="hidden md:flex gap-4"> <div className="hidden md:flex gap-4">
{mainLinks.map((link) => ( {mainLinks.map((link) => (

View File

@@ -61,7 +61,7 @@ export function Modal({
) )
} }
export function UncontrolledModal({ export function ControlledModal({
children, children,
button, button,
}: { }: {

View File

@@ -1,8 +1,5 @@
import type { import packageJson from "reacord/package.json"
LinksFunction, import type { LinksFunction, LoaderFunction, MetaFunction } from "remix"
LoaderFunction,
MetaFunction,
} from "@remix-run/node"
import { import {
Links, Links,
LiveReload, LiveReload,
@@ -11,8 +8,7 @@ import {
Scripts, Scripts,
ScrollRestoration, ScrollRestoration,
useLoaderData, useLoaderData,
} from "@remix-run/react" } from "remix"
import packageJson from "reacord/package.json"
import bannerUrl from "~/assets/banner.png" import bannerUrl from "~/assets/banner.png"
import faviconUrl from "~/assets/favicon.png" import faviconUrl from "~/assets/favicon.png"
import { GuideLinksProvider } from "~/modules/navigation/guide-links-context" import { GuideLinksProvider } from "~/modules/navigation/guide-links-context"
@@ -26,15 +22,15 @@ export const meta: MetaFunction = () => ({
"description": packageJson.description, "description": packageJson.description,
"theme-color": "#21754b", "theme-color": "#21754b",
"og:url": "https://reacord.mapleleaf.dev/", "og:url": "https://reacord.fly.dev/",
"og:type": "website", "og:type": "website",
"og:title": "Reacord", "og:title": "Reacord",
"og:description": "Create interactive Discord messages using React", "og:description": "Create interactive Discord messages using React",
"og:image": bannerUrl, "og:image": bannerUrl,
"twitter:card": "summary_large_image", "twitter:card": "summary_large_image",
"twitter:domain": "reacord.mapleleaf.dev", "twitter:domain": "reacord.fly.dev",
"twitter:url": "https://reacord.mapleleaf.dev/", "twitter:url": "https://reacord.fly.dev/",
"twitter:title": "Reacord", "twitter:title": "Reacord",
"twitter:description": "Create interactive Discord messages using React", "twitter:description": "Create interactive Discord messages using React",
"twitter:image": bannerUrl, "twitter:image": bannerUrl,
@@ -55,10 +51,6 @@ export const links: LinksFunction = () => [
as: "style", 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", 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: "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",
},
] ]
type LoaderData = { type LoaderData = {
@@ -77,7 +69,6 @@ export default function App() {
return ( return (
<html lang="en" className="bg-slate-900 text-slate-100"> <html lang="en" className="bg-slate-900 text-slate-100">
<head> <head>
{/* eslint-disable-next-line unicorn/text-encoding-identifier-case */}
<meta charSet="utf-8" /> <meta charSet="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" /> <meta name="viewport" content="width=device-width,initial-scale=1" />
<Meta /> <Meta />
@@ -85,10 +76,9 @@ export default function App() {
{process.env.NODE_ENV === "production" && ( {process.env.NODE_ENV === "production" && (
<script <script
async async
defer data-website-id="49c69ade-5593-4853-9686-c9ca9d519a18"
data-website-id="e3ce3a50-720e-4489-be37-cc091c1b7029" src="https://maple-umami.fly.dev/umami.js"
src="https://umami-production-72bc.up.railway.app/umami.js" />
></script>
)} )}
</head> </head>
<body> <body>

View File

@@ -0,0 +1,78 @@
import clsx from "clsx"
import { Fragment } from "react"
import type { LoaderFunction } from "remix"
import { Outlet, useLoaderData } from "remix"
import { getApiData } from "~/modules/api/api-data.server"
import { ActiveLink } from "~/modules/navigation/active-link"
import type { AppLinkProps } from "~/modules/navigation/app-link"
import { AppLink } from "~/modules/navigation/app-link"
import { MainNavigation } from "~/modules/navigation/main-navigation"
import { linkClass, maxWidthContainer } from "~/modules/ui/components"
type LoaderData = {
categorySections: Array<{
title: string
links: AppLinkProps[]
}>
// [key: string]: unknown
}
export const loader: LoaderFunction = async () => {
const apiData = getApiData()
const childrenById = Object.fromEntries(
apiData.children.map((child) => [child.id, { name: child.name }]),
)
const data: LoaderData = {
categorySections: apiData.categories.map((category) => ({
title: category.title,
links: category.children
.map((childId) => childrenById[childId])
.flatMap<AppLinkProps>((child) =>
child
? { to: `/api/${child.name}`, type: "router", children: child.name }
: [],
),
})),
}
return data
}
export default function ApiReferencePage() {
const data = useLoaderData<LoaderData>()
return (
<div className="isolate">
<header className="bg-slate-700/30 shadow sticky top-0 backdrop-blur-sm transition z-10 flex">
<div className={maxWidthContainer}>
<MainNavigation />
</div>
</header>
<div className={clsx(maxWidthContainer, "mt-8 flex items-start gap-4")}>
<nav className="w-48 sticky top-24 hidden md:block">
{data.categorySections.map((category) => (
<Fragment key={category.title}>
<h2 className="text-2xl">{category.title}</h2>
<ul className="mt-3 mb-6 flex flex-col gap-2 items-start">
{category.links.map((link) => (
<li key={link.to}>
<ActiveLink to={link.to}>
{({ active }) => (
<AppLink {...link} className={linkClass({ active })} />
)}
</ActiveLink>
</li>
))}
</ul>
</Fragment>
))}
</nav>
<main className="pb-8 flex-1 min-w-0">
<Outlet />
</main>
</div>
</div>
)
}

View File

@@ -0,0 +1,92 @@
import type { LoaderFunction } from "remix"
import { useLoaderData } from "remix"
import { getApiData } from "~/modules/api/api-data.server"
import { renderMarkdown } from "~/modules/markdown/render-markdown.server"
import { docsProseClass } from "~/modules/ui/components"
type LoaderData = {
title: string
description?: { __html: string }
[key: string]: unknown
}
export const loader: LoaderFunction = async ({ params }) => {
const apiData = getApiData()
const entityName = params.name!
const info = apiData.children?.find((child) => child.name === entityName)
const description = [
info?.comment?.shortText,
info?.comment?.text,
info?.signatures?.[0]?.comment?.shortText,
info?.signatures?.[0]?.comment?.text,
]
.filter(Boolean)
.join("\n\n")
const data: LoaderData = {
title: entityName,
description: description ? await renderMarkdown(description) : undefined,
sig: await renderMarkdown(`
\`\`\`tsx
function ActionRow(props: ActionRowProps): ReactElement
\`\`\`
`),
}
return data
}
export default function ApiDetailPage() {
const data = useLoaderData<LoaderData>()
return (
<>
<h1 className="text-3xl font-light">{data.title}</h1>
<p className="text-sm font-bold opacity-50 uppercase mt-1">Component</p>
<section
className={docsProseClass}
dangerouslySetInnerHTML={data.description}
/>
<section className={docsProseClass}>
<ul>
<li>
<p>
<code>children?: ReactNode</code>
</p>
<p>
This should be a list of <code>{`<Option />`}</code> components.
</p>
<ul>
<li>
<p>
<code>disabled?: boolean</code>
</p>
<p>
When true, the select will be slightly faded, and cannot be
interacted with.
</p>
</li>
</ul>
</li>
<li>
<p>
<code>minValues?: number</code>
</p>
<p>
With <code>multiple</code>, the minimum number of values that can
be selected. When <code>multiple</code> is false or not defined,
this is always 1.
</p>
<p>
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.
</p>
</li>
</ul>
</section>
</>
)
}

View File

@@ -1,5 +1,5 @@
import clsx from "clsx" import clsx from "clsx"
import { Outlet } from "@remix-run/react" import { Outlet } from "remix"
import { ActiveLink } from "~/modules/navigation/active-link" import { ActiveLink } from "~/modules/navigation/active-link"
import { AppLink } from "~/modules/navigation/app-link" import { AppLink } from "~/modules/navigation/app-link"
import { useGuideLinksContext } from "~/modules/navigation/guide-links-context" import { useGuideLinksContext } from "~/modules/navigation/guide-links-context"

View File

@@ -5,7 +5,7 @@ import LandingCode from "~/modules/landing/landing-code.mdx"
import { MainNavigation } from "~/modules/navigation/main-navigation" import { MainNavigation } from "~/modules/navigation/main-navigation"
import { buttonClass, maxWidthContainer } from "~/modules/ui/components" import { buttonClass, maxWidthContainer } from "~/modules/ui/components"
import { LandingAnimation } from "../modules/landing/landing-animation" import { LandingAnimation } from "../modules/landing/landing-animation"
import { UncontrolledModal } from "../modules/ui/modal" import { ControlledModal } from "../modules/ui/modal"
export default function Landing() { export default function Landing() {
return ( return (
@@ -37,7 +37,7 @@ export default function Landing() {
Get Started Get Started
</a> </a>
<UncontrolledModal <ControlledModal
button={(button) => ( button={(button) => (
<button <button
{...button} {...button}
@@ -50,7 +50,7 @@ export default function Landing() {
<div className="text-sm sm:text-base"> <div className="text-sm sm:text-base">
<LandingCode /> <LandingCode />
</div> </div>
</UncontrolledModal> </ControlledModal>
</div> </div>
</div> </div>

View File

@@ -14,7 +14,7 @@
// *********************************************************** // ***********************************************************
// Import commands.js using ES2015 syntax: // Import commands.js using ES2015 syntax:
import "./commands" import './commands'
// Alternatively you can use CommonJS syntax: // Alternatively you can use CommonJS syntax:
// require('./commands') // require('./commands')

View File

@@ -2,7 +2,8 @@
"private": true, "private": true,
"name": "website", "name": "website",
"scripts": { "scripts": {
"dev": "concurrently 'typedoc --watch' 'pnpm tailwind -- --watch' 'remix dev'", "prepare": "remix setup node",
"dev": "NODE_OPTIONS=--enable-source-maps concurrently 'typedoc --watch' 'pnpm tailwind -- --watch' 'remix dev'",
"test": "node ./scripts/test.js", "test": "node ./scripts/test.js",
"test-dev": "pnpm dev & wait-on http-get://localhost:3000 && cypress open", "test-dev": "pnpm dev & wait-on http-get://localhost:3000 && cypress open",
"build": "typedoc && pnpm tailwind -- --minify && remix build", "build": "typedoc && pnpm tailwind -- --minify && remix build",
@@ -11,42 +12,49 @@
"typecheck": "tsc --noEmit && tsc --project cypress/tsconfig.json --noEmit" "typecheck": "tsc --noEmit && tsc --project cypress/tsconfig.json --noEmit"
}, },
"dependencies": { "dependencies": {
"@headlessui/react": "^1.6.0", "@headlessui/react": "^1.4.2",
"@heroicons/react": "^1.0.6", "@heroicons/react": "^1.0.5",
"@reach/rect": "^0.17.0", "@reach/rect": "^0.16.0",
"@remix-run/node": "^1.4.1", "@remix-run/react": "^1.1.1",
"@remix-run/react": "^1.4.1", "@remix-run/serve": "^1.1.1",
"@remix-run/serve": "^1.4.1", "@tailwindcss/typography": "^0.5.0",
"@tailwindcss/typography": "^0.5.2",
"clsx": "^1.1.1", "clsx": "^1.1.1",
"fast-glob": "^3.2.11", "fast-glob": "^3.2.10",
"gray-matter": "^4.0.3", "gray-matter": "^4.0.3",
"reacord": "workspace:*", "reacord": "workspace:*",
"react": "^18.0.0", "react": "^17.0.2",
"react-dom": "^18.0.0", "react-dom": "^17.0.2",
"react-focus-on": "^3.5.4", "react-focus-on": "^3.5.4",
"react-router": "^6.3.0", "react-router": "^6.2.1",
"react-router-dom": "^6.3.0" "react-router-dom": "^6.2.1",
"rehype-stringify": "^9.0.2",
"remark-parse": "^10.0.1",
"rehype-prism-plus": "^1.3.1",
"remark-rehype": "^10.1.0",
"remix": "^1.1.1",
"unified": "^10.1.1"
}, },
"devDependencies": { "devDependencies": {
"@remix-run/dev": "^1.4.1", "@remix-run/dev": "^1.1.1",
"@remix-run/node": "^1.4.1", "@remix-run/node": "^1.1.1",
"@testing-library/cypress": "^8.0.2", "@testing-library/cypress": "^8.0.2",
"@types/node": "*", "@types/node": "*",
"@types/react": "^18.0.7", "@types/react": "^17.0.38",
"@types/react-dom": "^18.0.2", "@types/react-dom": "^17.0.11",
"@types/tailwindcss": "^3.0.10", "@types/tailwindcss": "^3.0.2",
"@types/wait-on": "^5.3.1", "@types/wait-on": "^5.3.1",
"autoprefixer": "^10.4.5", "autoprefixer": "^10.4.2",
"concurrently": "^7.1.0", "concurrently": "^7.0.0",
"cypress": "^9.6.0", "cypress": "^9.2.1",
"execa": "^6.1.0", "execa": "^6.0.0",
"postcss": "^8.4.12", "postcss": "^8.4.5",
"rehype-prism-plus": "^1.3.2", "tailwindcss": "^3.0.13",
"tailwindcss": "^3.0.24", "typedoc": "^0.22.10",
"typedoc": "^0.22.15", "typescript": "^4.5.4",
"typescript": "^4.6.3", "wait-on": "^6.0.0"
"wait-on": "^6.0.1" },
"engines": {
"node": ">=14"
}, },
"sideEffects": false "sideEffects": false
} }

View File

@@ -2,7 +2,6 @@
"extends": "../../tsconfig.base.json", "extends": "../../tsconfig.base.json",
"compilerOptions": { "compilerOptions": {
"jsx": "react-jsx", "jsx": "react-jsx",
"baseUrl": ".",
"paths": { "paths": {
"~/*": ["./app/*"] "~/*": ["./app/*"]
} }

View File

@@ -1,7 +1,8 @@
{ {
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["../reacord/library/main.ts"], "entryPoints": ["../reacord/library/main.ts"],
"out": ["public/api"],
"tsconfig": "../reacord/tsconfig.json", "tsconfig": "../reacord/tsconfig.json",
"json": "./app/assets/api.json",
"excludeInternal": true, "excludeInternal": true,
"excludePrivate": true, "excludePrivate": true,
"excludeProtected": true, "excludeProtected": true,

4574
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff