116 lines
3.3 KiB
TypeScript
116 lines
3.3 KiB
TypeScript
/**
|
|
* <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
|
|
* <span>Built-in <b>osu!</b> integration.</span>
|
|
* <a href="https://osu.ppy.sh/home">
|
|
* <img style={{display: "block"}} src="https://authjs.dev/img/providers/osu.svg" height="48" />
|
|
* </a>
|
|
* </div>
|
|
*
|
|
* @module providers/osu
|
|
*/
|
|
import type { OAuthConfig, OAuthUserConfig } from "./index.js";
|
|
export interface OsuUserCompact {
|
|
avatar_url: string;
|
|
country_code: string;
|
|
default_group: string;
|
|
id: number;
|
|
is_active: boolean;
|
|
is_bot: boolean;
|
|
is_deleted: boolean;
|
|
is_online: boolean;
|
|
is_supporter: boolean;
|
|
last_visit: Date | null;
|
|
pm_friends_only: boolean;
|
|
profile_colour: string | null;
|
|
username: string;
|
|
}
|
|
export interface OsuProfile extends OsuUserCompact, Record<string, any> {
|
|
discord: string | null;
|
|
has_supported: boolean;
|
|
interests: string | null;
|
|
join_date: Date;
|
|
kudosu: {
|
|
available: number;
|
|
total: number;
|
|
};
|
|
location: string | null;
|
|
max_blocks: number;
|
|
max_friends: number;
|
|
occupation: string | null;
|
|
playmode: string;
|
|
playstyle: string[];
|
|
post_count: number;
|
|
profile_order: string[];
|
|
title: string | null;
|
|
title_url: string | null;
|
|
twitter: string | null;
|
|
website: string | null;
|
|
country: {
|
|
code: string;
|
|
name: string;
|
|
};
|
|
cover: {
|
|
custom_url: string | null;
|
|
url: string;
|
|
id: number | null;
|
|
};
|
|
is_restricted: boolean;
|
|
}
|
|
/**
|
|
* Add osu! login to your page.
|
|
*
|
|
* ### Setup
|
|
*
|
|
* #### Callback URL
|
|
* ```
|
|
* https://example.com/api/auth/callback/osu
|
|
* ```
|
|
*
|
|
* #### Configuration
|
|
*```ts
|
|
* import { Auth } from "@auth/core"
|
|
* import Osu from "@auth/core/providers/osu"
|
|
*
|
|
* const request = new Request(origin)
|
|
* const response = await Auth(request, {
|
|
* providers: [
|
|
* Osu({ clientId: OSU_CLIENT_ID, clientSecret: OSU_CLIENT_SECRET }),
|
|
* ],
|
|
* })
|
|
* ```
|
|
*
|
|
* ### Resources
|
|
*
|
|
* - [osu! OAuth documentation](https://osu.ppy.sh/docs/index.html#authentication)
|
|
* - [osu! app console](https://osu.ppy.sh/home/account/edit#new-oauth-application)
|
|
*
|
|
* ### Notes
|
|
*
|
|
* By default, Auth.js assumes that the Osu provider is
|
|
* based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
|
|
*
|
|
* :::note
|
|
*
|
|
* osu! does not provide a user email.
|
|
*
|
|
* :::
|
|
*
|
|
* :::tip
|
|
*
|
|
* The osu! provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/osu.ts).
|
|
* To override the defaults for your use case, check out [customizing a built-in OAuth provider](https://authjs.dev/guides/configuring-oauth-providers).
|
|
*
|
|
* :::
|
|
*
|
|
* :::info **Disclaimer**
|
|
*
|
|
* If you think you found a bug in the default configuration, you can [open an issue](https://authjs.dev/new/provider-issue).
|
|
*
|
|
* Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from
|
|
* the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec,
|
|
* we might not pursue a resolution. You can ask for more help in [Discussions](https://authjs.dev/new/github-discussions).
|
|
*
|
|
* :::
|
|
*/
|
|
export default function Osu<P extends OsuProfile>(options: OAuthUserConfig<P>): OAuthConfig<P>;
|
|
//# sourceMappingURL=osu.d.ts.map
|