TypeScript SDK for Discord's API

---

📦 Installation

npm install --save-dev @discordkit/client zod
# or
yarn add -D @discordkit/client zod

Warning

🚧 Additional documentation and examples are currently under construction! 🚧

Discordkit only recently published it's first stable version. Priority is being given to stablizing the CI/CD infrastructure for this monorepo while use-cases are explored and examples are built.

🔧 Usage

Out of the box Discordkit supports vanilla JavaScript/Typescript, react-query, and tRPC. For each of Discord's API endpoints, Discordkit exports a basic request handler function, a pre-wired tRPC procedure builder, and for GET requests, a react-query query function. Additionally, each endpoint also exports a zod schema object to validate the input for a request handler.

Here is an example of the available exports and their naming patterns:

import {
  // Input validation schema
  getGuildSchema,
  // Request handler
  getGuild,
  // tRPC procedure builder
  getGuildProcedure,
  // react-query query function
  getGuildQuery
} from "@discordkit/client";

In order to make requests, you must first set your access token on the Discord session provider.

import { discord } from "@discordkit/client";

discord.setToken(`Bearer <access-token>`, true);

With react-query:

Using the supplied query functions, you can quickly scaffold your query functions with strong guarantees on input and response validation.

import { useQuery } from "@tanstack/react-query";
import { getUserQuery } from "@discordkit/client";

export const UserProfile = ({ user }) => {
  const { isLoading, isError, data, error } = useQuery({
    queryKey: [user.username],
    queryFn: getUserQuery({ id: user.id })
  });

  // ...
};

import { useMutation } from "@tanstack/react-query";
import { modifyGuild, modifyGuildSchema } from "@discordkit/client";

export const RenameGuild = ({ guild }) => {
  const [name, setName] = useState(guild.name)
  const { isLoading, isError, data, error } = useMutation({
    mutationFn: modifyGuild,
    onMutate: (variables) => {
      // Will throw if invalid input is given
      modifyGuildSchema.parse(variables)
    }
  });

  const onSubmit = (e) => {
    e.preventDefault()
    mutation.mutate({ guild: guild.id, body: { name } })
  }

  return (
    <form onSubmit={onSubmit}>
      {mutation.error && (
        <h5 onClick={() => mutation.reset()}>{mutation.error}</h5>
      )}
      <input
        type="text"
        value={name}
        onChange={(e) => setName(e.target.value)}
      />
      <br />
      <button type="submit">Rename Guild</button>
    </form>
  )
};

With tRPC:

import { initTRPC } from "@trpc/server";
import { createHTTPServer } from "@trpc/server/adapters/standalone";
import {
    discord,
    getCurrentApplicationProcedure,
    getGuildProcedure
} from "@discordkit/client";

const botToken = process.env.DISCORD_BOT_AUTH_TOKEN;

// Configure your client to use a Bot token by default
discord.setToken(botToken, Boolean(botToken));

const t = initTRPC.context<{ user: string | null }>().create();
const baseProcedure = t.procedure;

// Create a reusable procedure to use a User's auth token when available
const authorizedProcedure = baseProcedure.use(({ ctx }) => {
  if (ctx.user) {
    discord.setToken(`Bearer ${ctx.user}`);
  } else {
    discord.setToken(`Bot ${botToken}`);
  }

  return opts.next();
});

const router = t.router({
  getCurrentApplication: getCurrentApplicationProcedure(baseProcedure),
  getGuild: getGuildProcedure(authorizedProcedure)
});

createHTTPServer({
  router,
  createContext({ req }) {
    // Extract a user's auth token from the incoming request headers
    async function getUserTokenFromHeader() {
      if (req.headers.authorization) {
        const user = await decodeAndVerifyJwtToken(
          req.headers.authorization.split(" ")[1]
        );
        return user;
      }
      return null;
    }

    return {
      user: await getUserTokenFromHeader();
    };
  }
}).listen(1337);

📣 Acknowledgements

Endpoint documentation taken from Discord's Official API docs.

🥂 License

Released under the MIT license.