vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2025-10-16 12:05:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Allow more Falsey returns and allow scope string arrays

Browse Source 
* scopes can be string arrays
* Models can return `Falsey` types
* Revoke Token accepts `Token` or `RefreshToken` (should really only be `RefreshToken`, though)
This commit is contained in:
Connor Schlesiger 2018-09-27 15:37:05 -04:00 committed by GitHub
parent 5b0522b4af
commit 044b4178f6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
types/oauth2-server/index.d.ts vendored
View File

@ -123,7 +123,7 @@ declare namespace OAuth2Server {
/**
* The scope(s) to authenticate.
*/
scope?: string;
scope?: string | string[];
/**
* Set the X-Accepted-OAuth-Scopes HTTP header on response objects.
@ -200,7 +200,7 @@ declare namespace OAuth2Server {
* Invoked to generate a new access token.
*
*/
generateAccessToken?(client: Client, user: User, scope: string, callback?: Callback<string>): Promise<string>;
generateAccessToken?(client: Client, user: User, scope: string | string[], callback?: Callback<string>): Promise<string>;
/**
* Invoked to retrieve a client using a client id or a client id/client secret combination, depending on the grant type.
@ -212,7 +212,7 @@ declare namespace OAuth2Server {
* Invoked to save an access token and optionally a refresh token, depending on the grant type.
*
*/
saveToken(token: Token, client: Client, user: User, callback?: Callback<Token>): Promise<Token>;
saveToken(token: Token, client: Client, user: User, callback?: Callback<Token>): Promise<Token | Falsey>;
}
interface RequestAuthenticationModel {
@ -220,13 +220,13 @@ declare namespace OAuth2Server {
* Invoked to retrieve an existing access token previously saved through Model#saveToken().
*
*/
getAccessToken(accessToken: string, callback?: Callback<Token>): Promise<Token>;
getAccessToken(accessToken: string, callback?: Callback<Token>): Promise<Token | Falsey>;
/**
* Invoked during request authentication to check if the provided access token was authorized the requested scopes.
*
*/
verifyScope(token: Token, scope: string, callback?: Callback<boolean>): Promise<boolean>;
verifyScope(token: Token, scope: string | string[], callback?: Callback<boolean>): Promise<boolean>;
}
interface AuthorizationCodeModel extends BaseModel, RequestAuthenticationModel {
@ -234,25 +234,25 @@ declare namespace OAuth2Server {
* Invoked to generate a new refresh token.
*
*/
generateRefreshToken?(client: Client, user: User, scope: string, callback?: Callback<string>): Promise<string>;
generateRefreshToken?(client: Client, user: User, scope: string | string[], callback?: Callback<string>): Promise<string>;
/**
* Invoked to generate a new authorization code.
*
*/
generateAuthorizationCode?(client: Client, user: User, scope: string, callback?: Callback<string>): Promise<string>;
generateAuthorizationCode?(client: Client, user: User, scope: string | string[], callback?: Callback<string>): Promise<string>;
/**
* Invoked to retrieve an existing authorization code previously saved through Model#saveAuthorizationCode().
*
*/
getAuthorizationCode(authorizationCode: string, callback?: Callback<AuthorizationCode>): Promise<AuthorizationCode>;
getAuthorizationCode(authorizationCode: string, callback?: Callback<AuthorizationCode>): Promise<AuthorizationCode | Falsey>;
/**
* Invoked to save an authorization code.
*
*/
saveAuthorizationCode(code: AuthorizationCode, client: Client, user: User, callback?: Callback<AuthorizationCode>): Promise<AuthorizationCode>;
saveAuthorizationCode(code: AuthorizationCode, client: Client, user: User, callback?: Callback<AuthorizationCode>): Promise<AuthorizationCode | Falsey>;
/**
* Invoked to revoke an authorization code.
@ -264,7 +264,7 @@ declare namespace OAuth2Server {
* Invoked to check if the requested scope is valid for a particular client/user combination.
*
*/
validateScope?(user: User, client: Client, scope: string, callback?: Callback<string | Falsey>): Promise<string | Falsey>;
validateScope?(user: User, client: Client, scope: string | string[], callback?: Callback<string | Falsey>): Promise<string | string[] | Falsey>;
}
interface PasswordModel extends BaseModel, RequestAuthenticationModel {
@ -272,7 +272,7 @@ declare namespace OAuth2Server {
* Invoked to generate a new refresh token.
*
*/
generateRefreshToken?(client: Client, user: User, scope: string, callback?: Callback<string>): Promise<string>;
generateRefreshToken?(client: Client, user: User, scope: string | string[], callback?: Callback<string>): Promise<string>;
/**
* Invoked to retrieve a user using a username/password combination.
@ -284,7 +284,7 @@ declare namespace OAuth2Server {
* Invoked to check if the requested scope is valid for a particular client/user combination.
*
*/
validateScope?(user: User, client: Client, scope: string, callback?: Callback<string | Falsey>): Promise<string | Falsey>;
validateScope?(user: User, client: Client, scope: string | string[], callback?: Callback<string | Falsey>): Promise<string | string[] | Falsey>;
}
interface RefreshTokenModel extends BaseModel, RequestAuthenticationModel {
@ -292,19 +292,19 @@ declare namespace OAuth2Server {
* Invoked to generate a new refresh token.
*
*/
generateRefreshToken?(client: Client, user: User, scope: string, callback?: Callback<string>): Promise<string>;
generateRefreshToken?(client: Client, user: User, scope: string | string[], callback?: Callback<string>): Promise<string>;
/**
* Invoked to retrieve an existing refresh token previously saved through Model#saveToken().
*
*/
getRefreshToken(refreshToken: string, callback?: Callback<RefreshToken>): Promise<RefreshToken>;
getRefreshToken(refreshToken: string, callback?: Callback<RefreshToken>): Promise<RefreshToken | Falsey>;
/**
* Invoked to revoke a refresh token.
*
*/
revokeToken(token: Token, callback?: Callback<boolean>): Promise<boolean>;
revokeToken(token: RefreshToken | Token, callback?: Callback<boolean>): Promise<boolean>;
}
interface ClientCredentialsModel extends BaseModel, RequestAuthenticationModel {
@ -318,7 +318,7 @@ declare namespace OAuth2Server {
* Invoked to check if the requested scope is valid for a particular client/user combination.
*
*/
validateScope?(user: User, client: Client, scope: string, callback?: Callback<string | Falsey>): Promise<string | Falsey>;
validateScope?(user: User, client: Client, scope: string | string[], callback?: Callback<string | Falsey>): Promise<string | string[] | Falsey>;
}
interface ExtensionModel extends BaseModel, RequestAuthenticationModel {}
@ -336,8 +336,8 @@ declare namespace OAuth2Server {
*/
interface Client {
id: string;
redirectUris?: string[];
grants: string[];
redirectUris?: string | string[];
grants: string | string[];
accessTokenLifetime?: number;
refreshTokenLifetime?: number;
[key: string]: any;
@ -350,7 +350,7 @@ declare namespace OAuth2Server {
authorizationCode: string;
expiresAt: Date;
redirectUri: string;
scope?: string;
scope?: string | string[];
client: Client;
user: User;
[key: string]: any;
@ -364,7 +364,7 @@ declare namespace OAuth2Server {
accessTokenExpiresAt?: Date;
refreshToken?: string;
refreshTokenExpiresAt?: Date;
scope?: string;
scope?: string | string[];
client: Client;
user: User;
[key: string]: any;
@ -376,7 +376,7 @@ declare namespace OAuth2Server {
interface RefreshToken {
refreshToken: string;
refreshTokenExpiresAt?: Date;
scope?: string;
scope?: string | string[];
client: Client;
user: User;
[key: string]: any;