daenamnu/discord-api-types
1
0
Fork 0
mirror of https://github.com/discordjs/discord-api-types.git synced 2026-05-28 06:20:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: optional client_id and client_secret in access token data (#1248)

Browse Source
This commit is contained in:
Almeida
2025-05-17 17:22:57 +01:00
committed by GitHub
parent 544bd94be5
commit b360b2e6a7
7 changed files with 190 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.eslintrc.json
View File

@@ -41,6 +41,7 @@
"RESTAPIMessageReference",
"RESTAPIPartialCurrentUserGuild",
"RESTAPIPoll",
"RESTOAuth2TokenOptionalClientCredentials",
"RESTOAuth2AdvancedBotAuthorizationQuery",
"RESTOAuth2AdvancedBotAuthorizationQueryResult",

22
deno/rest/v10/oauth2.ts generated
View File

@@ -62,15 +62,20 @@ export interface RESTPostOAuth2AuthorizationQueryResult {
export type RESTOAuth2AuthorizationQueryResult = RESTPostOAuth2AuthorizationQueryResult;
/**
* @remarks
* This endpoint requires either HTTP Basic authentication using `client_id:client_secret`,
* or the `client_id` and `client_secret` must be provided in the form body.
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-redirect-url-example}
*/
export interface RESTPostOAuth2AccessTokenURLEncodedData {
client_id: Snowflake;
client_secret: string;
export type RESTPostOAuth2AccessTokenURLEncodedData = RESTOAuth2TokenOptionalClientCredentials & {
grant_type: 'authorization_code';
code: string;
redirect_uri?: string;
}
};
export type RESTOAuth2TokenOptionalClientCredentials =
| { client_id: Snowflake; client_secret: string }
| { client_id?: never; client_secret?: never };
/**
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-access-token-response}
@@ -84,14 +89,15 @@ export interface RESTPostOAuth2AccessTokenResult {
}
/**
* @remarks
* This endpoint requires either HTTP Basic authentication using `client_id:client_secret`,
* or the `client_id` and `client_secret` must be provided in the form body.
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-refresh-token-exchange-example}
*/
export interface RESTPostOAuth2RefreshTokenURLEncodedData {
client_id: Snowflake;
client_secret: string;
export type RESTPostOAuth2RefreshTokenURLEncodedData = RESTOAuth2TokenOptionalClientCredentials & {
grant_type: 'refresh_token';
refresh_token: string;
}
};
export type RESTPostOAuth2RefreshTokenResult = RESTPostOAuth2AccessTokenResult;

22
deno/rest/v9/oauth2.ts generated
View File

@@ -62,15 +62,20 @@ export interface RESTPostOAuth2AuthorizationQueryResult {
export type RESTOAuth2AuthorizationQueryResult = RESTPostOAuth2AuthorizationQueryResult;
/**
* @remarks
* This endpoint requires either HTTP Basic authentication using `client_id:client_secret`,
* or the `client_id` and `client_secret` must be provided in the form body.
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-redirect-url-example}
*/
export interface RESTPostOAuth2AccessTokenURLEncodedData {
client_id: Snowflake;
client_secret: string;
export type RESTPostOAuth2AccessTokenURLEncodedData = RESTOAuth2TokenOptionalClientCredentials & {
grant_type: 'authorization_code';
code: string;
redirect_uri?: string;
}
};
export type RESTOAuth2TokenOptionalClientCredentials =
| { client_id: Snowflake; client_secret: string }
| { client_id?: never; client_secret?: never };
/**
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-access-token-response}
@@ -84,14 +89,15 @@ export interface RESTPostOAuth2AccessTokenResult {
}
/**
* @remarks
* This endpoint requires either HTTP Basic authentication using `client_id:client_secret`,
* or the `client_id` and `client_secret` must be provided in the form body.
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-refresh-token-exchange-example}
*/
export interface RESTPostOAuth2RefreshTokenURLEncodedData {
client_id: Snowflake;
client_secret: string;
export type RESTPostOAuth2RefreshTokenURLEncodedData = RESTOAuth2TokenOptionalClientCredentials & {
grant_type: 'refresh_token';
refresh_token: string;
}
};
export type RESTPostOAuth2RefreshTokenResult = RESTPostOAuth2AccessTokenResult;

22
rest/v10/oauth2.ts
View File

@@ -62,15 +62,20 @@ export interface RESTPostOAuth2AuthorizationQueryResult {
export type RESTOAuth2AuthorizationQueryResult = RESTPostOAuth2AuthorizationQueryResult;
/**
* @remarks
* This endpoint requires either HTTP Basic authentication using `client_id:client_secret`,
* or the `client_id` and `client_secret` must be provided in the form body.
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-redirect-url-example}
*/
export interface RESTPostOAuth2AccessTokenURLEncodedData {
client_id: Snowflake;
client_secret: string;
export type RESTPostOAuth2AccessTokenURLEncodedData = RESTOAuth2TokenOptionalClientCredentials & {
grant_type: 'authorization_code';
code: string;
redirect_uri?: string;
}
};
export type RESTOAuth2TokenOptionalClientCredentials =
| { client_id: Snowflake; client_secret: string }
| { client_id?: never; client_secret?: never };
/**
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-access-token-response}
@@ -84,14 +89,15 @@ export interface RESTPostOAuth2AccessTokenResult {
}
/**
* @remarks
* This endpoint requires either HTTP Basic authentication using `client_id:client_secret`,
* or the `client_id` and `client_secret` must be provided in the form body.
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-refresh-token-exchange-example}
*/
export interface RESTPostOAuth2RefreshTokenURLEncodedData {
client_id: Snowflake;
client_secret: string;
export type RESTPostOAuth2RefreshTokenURLEncodedData = RESTOAuth2TokenOptionalClientCredentials & {
grant_type: 'refresh_token';
refresh_token: string;
}
};
export type RESTPostOAuth2RefreshTokenResult = RESTPostOAuth2AccessTokenResult;

22
rest/v9/oauth2.ts
View File

@@ -62,15 +62,20 @@ export interface RESTPostOAuth2AuthorizationQueryResult {
export type RESTOAuth2AuthorizationQueryResult = RESTPostOAuth2AuthorizationQueryResult;
/**
* @remarks
* This endpoint requires either HTTP Basic authentication using `client_id:client_secret`,
* or the `client_id` and `client_secret` must be provided in the form body.
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-redirect-url-example}
*/
export interface RESTPostOAuth2AccessTokenURLEncodedData {
client_id: Snowflake;
client_secret: string;
export type RESTPostOAuth2AccessTokenURLEncodedData = RESTOAuth2TokenOptionalClientCredentials & {
grant_type: 'authorization_code';
code: string;
redirect_uri?: string;
}
};
export type RESTOAuth2TokenOptionalClientCredentials =
| { client_id: Snowflake; client_secret: string }
| { client_id?: never; client_secret?: never };
/**
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-access-token-response}
@@ -84,14 +89,15 @@ export interface RESTPostOAuth2AccessTokenResult {
}
/**
* @remarks
* This endpoint requires either HTTP Basic authentication using `client_id:client_secret`,
* or the `client_id` and `client_secret` must be provided in the form body.
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-refresh-token-exchange-example}
*/
export interface RESTPostOAuth2RefreshTokenURLEncodedData {
client_id: Snowflake;
client_secret: string;
export type RESTPostOAuth2RefreshTokenURLEncodedData = RESTOAuth2TokenOptionalClientCredentials & {
grant_type: 'refresh_token';
refresh_token: string;
}
};
export type RESTPostOAuth2RefreshTokenResult = RESTPostOAuth2AccessTokenResult;

68
tests/v10/oauth2.ts
View File

@@ -1,4 +1,10 @@
import type { OAuth2Scopes, RESTOAuth2BotAuthorizationQuery, RESTOAuth2AdvancedBotAuthorizationQuery } from '../../v10';
import type {
OAuth2Scopes,
RESTOAuth2BotAuthorizationQuery,
RESTOAuth2AdvancedBotAuthorizationQuery,
RESTPostOAuth2AccessTokenURLEncodedData,
RESTPostOAuth2RefreshTokenURLEncodedData,
} from '../../v10';
import { expectAssignable, expectNotAssignable } from '../__utils__/type-assertions';
declare const validBotScope:
@@ -22,3 +28,63 @@ expectNotAssignable<RESTOAuth2BotAuthorizationQuery['scope']>(invalidBotScope);
expectAssignable<RESTOAuth2AdvancedBotAuthorizationQuery['scope']>(validBotScope);
// @ts-expect-error - invalid scope
expectNotAssignable<RESTOAuth2AdvancedBotAuthorizationQuery['scope']>(invalidBotScope);
{
expectAssignable<RESTPostOAuth2AccessTokenURLEncodedData>({
code: 'code',
grant_type: 'authorization_code',
redirect_uri: 'https://discord.com',
});
expectAssignable<RESTPostOAuth2AccessTokenURLEncodedData>({
client_id: '123456789',
client_secret: 'very secret',
code: 'code',
grant_type: 'authorization_code',
redirect_uri: 'https://discord.com',
});
// @ts-expect-error - client_secret is missing
expectNotAssignable<RESTPostOAuth2AccessTokenURLEncodedData>({
client_id: '123456789',
code: 'code',
grant_type: 'authorization_code',
redirect_uri: 'https://discord.com',
});
// @ts-expect-error - client_id is missing
expectNotAssignable<RESTPostOAuth2AccessTokenURLEncodedData>({
client_secret: 'very secret',
code: 'code',
grant_type: 'authorization_code',
redirect_uri: 'https://discord.com',
});
}
{
expectAssignable<RESTPostOAuth2RefreshTokenURLEncodedData>({
grant_type: 'refresh_token',
refresh_token: 'a real token this is',
});
expectAssignable<RESTPostOAuth2RefreshTokenURLEncodedData>({
client_id: '123456789',
client_secret: 'very secret',
grant_type: 'refresh_token',
refresh_token: 'a real token this is',
});
// @ts-expect-error - client_secret is missing
expectNotAssignable<RESTPostOAuth2RefreshTokenURLEncodedData>({
client_id: '123456789',
grant_type: 'refresh_token',
refresh_token: 'a real token this is',
});
// @ts-expect-error - client_id is missing
expectNotAssignable<RESTPostOAuth2RefreshTokenURLEncodedData>({
client_secret: 'very secret',
grant_type: 'refresh_token',
refresh_token: 'a real token this is',
});
}

67
tests/v9/oauth2.ts
View File

@@ -1,4 +1,10 @@
import type { OAuth2Scopes, RESTOAuth2BotAuthorizationQuery, RESTOAuth2AdvancedBotAuthorizationQuery } from '../../v9';
import type {
OAuth2Scopes,
RESTOAuth2BotAuthorizationQuery,
RESTOAuth2AdvancedBotAuthorizationQuery,
RESTPostOAuth2AccessTokenURLEncodedData,
RESTPostOAuth2RefreshTokenURLEncodedData,
} from '../../v9';
import { expectAssignable, expectNotAssignable } from '../__utils__/type-assertions';
declare const validBotScope:
@@ -20,3 +26,62 @@ expectNotAssignable<RESTOAuth2BotAuthorizationQuery['scope']>(invalidBotScope);
expectAssignable<RESTOAuth2AdvancedBotAuthorizationQuery['scope']>(validBotScope);
// @ts-expect-error - invalid scope
expectNotAssignable<RESTOAuth2AdvancedBotAuthorizationQuery['scope']>(invalidBotScope);
{
expectAssignable<RESTPostOAuth2AccessTokenURLEncodedData>({
code: 'code',
grant_type: 'authorization_code',
redirect_uri: 'https://discord.com',
});
expectAssignable<RESTPostOAuth2AccessTokenURLEncodedData>({
client_id: '123456789',
client_secret: 'very secret',
code: 'code',
grant_type: 'authorization_code',
redirect_uri: 'https://discord.com',
});
// @ts-expect-error - client_secret is missing
expectNotAssignable<RESTPostOAuth2AccessTokenURLEncodedData>({
client_id: '123456789',
code: 'code',
grant_type: 'authorization_code',
redirect_uri: 'https://discord.com',
});
// @ts-expect-error - client_id is missing
expectNotAssignable<RESTPostOAuth2AccessTokenURLEncodedData>({
client_secret: 'very secret',
code: 'code',
grant_type: 'authorization_code',
redirect_uri: 'https://discord.com',
});
}
{
expectAssignable<RESTPostOAuth2RefreshTokenURLEncodedData>({
grant_type: 'refresh_token',
refresh_token: 'a real token this is',
});
expectAssignable<RESTPostOAuth2RefreshTokenURLEncodedData>({
client_id: '123456789',
client_secret: 'very secret',
grant_type: 'refresh_token',
refresh_token: 'a real token this is',
});
// @ts-expect-error - client_secret is missing
expectNotAssignable<RESTPostOAuth2RefreshTokenURLEncodedData>({
client_id: '123456789',
grant_type: 'refresh_token',
refresh_token: 'a real token this is',
});
// @ts-expect-error - client_id is missing
expectNotAssignable<RESTPostOAuth2RefreshTokenURLEncodedData>({
client_secret: 'very secret',
grant_type: 'refresh_token',
refresh_token: 'a real token this is',
});
}