Skip to content

esp-customs/OAuth

Repository files navigation

Typing SVG

size Discord

Typing SVG

npm i @espcustomss/oauth

Typing SVG

Esp Customs OAuth is a library designed to facilitate the integration of OAuth2 with Discord, allowing authentication, retrieval of user data, servers, and connections in a simple and efficient manner.

✨Features

  • 🔒 Full TypeScript Support - Built with TypeScript for a more robust development experience.
  • 🚀 Compatibility with the Latest Discord API Versions - Always up-to-date with the latest Discord changes.
  • 🛠️ Easy to Use - Intuitive API for developers of all skill levels.
  • 🌐 Get User, Server, and Connection Data - Easily access authenticated user information.
  • 🔄 Authorization Link Generation - Simplifies the OAuth2 authentication process.

📦Examples

Basic Configuration

import { Client } from '@espcustomss/oauth';

const auth = new Client({
  id: '<your_bot_id>',
  secret: '<your_bot_secret>',
  redirectURI: 'http://localhost:3000/auth',
  scopes: ['identify', 'guilds', 'connections']
});

Authentication and Data Collection

// Get the access token
const key = await auth.getAccess('<code_from_discord>');

// Get user data
const user = await auth.getUser(key); 
console.log(user); // { id: '...', username: '...', ... }

// Get user servers
const guilds = await auth.getGuilds(key); 
console.log(guilds); // Collection<{ id: '...', name: '...', ... }>

// Get user connections
const connections = await auth.getConnections(key); 
console.log(connections); // Collection<{ id: '...', name: '...', ... }>

Generate an authorization link

const authLink = auth.authCodeLink.url;
console.log(`Visit this link to authenticate: ${authLink}`);

🛠️API Documentation

See the full documentation for more details on how to use this library.

📝Contributing

Contributions are welcome! If you find a bug or have an idea for improving the library, feel free to open an issue or submit a pull request.

📄License

This project is licensed under the MIT License. See the LICENSE file for more details.

About

Simply make Discord OAuth requests. Built with TypeScript, used by Esp Customs.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published