mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-10-05 23:37:04 +00:00
Merge pull request #24591 from SimonSchick/newtypes/bell
feat(types): add typings for bell
This commit is contained in:
Nathan Shively-Sanders
@@ -0,0 +1,106 @@
|
||||
import { RequestQuery, Server } from 'hapi';
|
||||
import * as bell from 'bell';
|
||||
|
||||
async function run() {
|
||||
const server = new Server({ port: 8000 });
|
||||
await server.register(bell);
|
||||
|
||||
server.auth.strategy('arcgisonline', 'bell', {
|
||||
provider: 'twitter',
|
||||
password: 'some cookie password',
|
||||
location: 'http://example.com/oauth',
|
||||
clientId: '',
|
||||
clientSecret: '',
|
||||
scope(request) {
|
||||
const scopes = ['public_profile', 'email'];
|
||||
if ((<RequestQuery> request.query).wantsSharePermission) {
|
||||
scopes.push('publish_actions');
|
||||
}
|
||||
return scopes;
|
||||
}
|
||||
});
|
||||
|
||||
const providers: bell.BellOptions[] = [{
|
||||
provider: 'discord',
|
||||
password: 'cookie_encryption_password_secure',
|
||||
isSecure: false,
|
||||
clientId: '',
|
||||
clientSecret: '',
|
||||
location: () => '',
|
||||
},
|
||||
{
|
||||
provider: 'facebook',
|
||||
password: 'cookie_encryption_password_secure',
|
||||
isSecure: false,
|
||||
clientId: '',
|
||||
clientSecret: '',
|
||||
location: server.info.uri
|
||||
},
|
||||
{
|
||||
provider: 'google',
|
||||
password: 'cookie_encryption_password_secure',
|
||||
isSecure: false,
|
||||
clientId: '',
|
||||
clientSecret: '',
|
||||
location: server.info.uri
|
||||
},
|
||||
{
|
||||
provider: 'linkedin',
|
||||
password: 'cookie_encryption_password_secure',
|
||||
isSecure: false,
|
||||
clientId: '',
|
||||
clientSecret: '',
|
||||
providerParams: {
|
||||
redirect_uri: server.info.uri + '/bell/door'
|
||||
}
|
||||
},
|
||||
{
|
||||
provider: 'meetup',
|
||||
password: 'cookie_encryption_password_secure',
|
||||
isSecure: false,
|
||||
clientId: '',
|
||||
clientSecret: '',
|
||||
scope: ['basic', 'ageless', 'group_edit', 'reporting'],
|
||||
},
|
||||
{
|
||||
provider: 'nest',
|
||||
password: 'cookie_encryption_password_secure',
|
||||
isSecure: false,
|
||||
clientId: '',
|
||||
clientSecret: ''
|
||||
},
|
||||
{
|
||||
provider: 'office365',
|
||||
clientId: '',
|
||||
clientSecret: '',
|
||||
password: 'cookie_encryption_password_secure',
|
||||
providerParams: {
|
||||
response_type: 'code'
|
||||
},
|
||||
scope: ['openid', 'offline_access', 'profile']
|
||||
},
|
||||
{
|
||||
provider: 'okta',
|
||||
config: { uri: 'https://your-organization.okta.com' },
|
||||
password: 'cookie_encryption_password_secure',
|
||||
isSecure: false,
|
||||
location: 'http://127.0.0.1:8000',
|
||||
clientId: '',
|
||||
clientSecret: ''
|
||||
},
|
||||
{
|
||||
provider: 'slack',
|
||||
password: 'cookie_encryption_password_secure',
|
||||
isSecure: false,
|
||||
clientId: '',
|
||||
clientSecret: ''
|
||||
},
|
||||
{
|
||||
provider: 'twitch',
|
||||
password: 'cookie_encryption_password_secure',
|
||||
isSecure: false,
|
||||
clientId: '',
|
||||
clientSecret: '',
|
||||
scope: ['user_read', 'channel_read']
|
||||
}];
|
||||
}
|
||||
Vendored
+269
@@ -0,0 +1,269 @@
|
||||
// Type definitions for bell 9.1
|
||||
// Project: https://github.com/hapijs/bell
|
||||
// Definitions by: Simon Schick <https://github.com/SimonSchick>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
// TypeScript Version: 2.7
|
||||
|
||||
import { Server, Request, Plugin, AuthCredentials } from 'hapi';
|
||||
|
||||
declare module 'hapi' {
|
||||
interface ServerAuth {
|
||||
strategy(name: string, scheme: 'bell', options: BellOptions): void;
|
||||
strategy(
|
||||
name: string,
|
||||
scheme: 'bell',
|
||||
mode: boolean | 'required' | 'optional' | 'try',
|
||||
options: BellOptions,
|
||||
): void;
|
||||
}
|
||||
}
|
||||
|
||||
export interface StringLikeMap {
|
||||
[key: string]: string | number;
|
||||
}
|
||||
export type Provider =
|
||||
'arcgisonline' |
|
||||
'auth0' |
|
||||
'azuread' |
|
||||
'bitbucket' |
|
||||
'digitalocean' |
|
||||
'discord' |
|
||||
'dropbox' |
|
||||
'dropboxV2' |
|
||||
'facebook' |
|
||||
'fitbit' |
|
||||
'foursquare' |
|
||||
'github' |
|
||||
'gitlab' |
|
||||
'google' |
|
||||
'googleplus' |
|
||||
'instagram' |
|
||||
'linkedin' |
|
||||
'live' |
|
||||
'medium' |
|
||||
'meetup' |
|
||||
'mixer' |
|
||||
'nest' |
|
||||
'office365' |
|
||||
'okta' |
|
||||
'phabricator' |
|
||||
'pingfed' |
|
||||
'pinterest' |
|
||||
'reddit' |
|
||||
'salesforce' |
|
||||
'slack' |
|
||||
'spotify' |
|
||||
'stripe' |
|
||||
'trakt' |
|
||||
'tumblr' |
|
||||
'twitch' |
|
||||
'twitter' |
|
||||
'vk' |
|
||||
'wordpress' |
|
||||
'yahoo';
|
||||
|
||||
export type RequestPassThrough = (
|
||||
request: Request,
|
||||
next: (err: Error | null, credentials: AuthCredentials) => void,
|
||||
) => void;
|
||||
|
||||
export interface OptionalOptions {
|
||||
/**
|
||||
* the name of the cookie used to manage the temporary state.
|
||||
* Defaults to 'bell-provider' where 'provider' is the provider name (or 'custom' for custom providers).
|
||||
* For example, the Twitter cookie name defaults to 'bell-twitter'.
|
||||
*/
|
||||
cookie?: string;
|
||||
/**
|
||||
* sets the cookie secure flag.
|
||||
* Defaults to true.
|
||||
*/
|
||||
isSecure?: boolean;
|
||||
/**
|
||||
* sets the cookie HTTP only flag.
|
||||
* Defaults to true.
|
||||
*/
|
||||
isHttpOnly?: boolean;
|
||||
/**
|
||||
* cookie time-to-live in milliseconds.
|
||||
* Defaults to null (session time-life - cookies are deleted when the browser is closed).
|
||||
*/
|
||||
ttl?: number;
|
||||
/**
|
||||
* the domain scope.
|
||||
* Defaults to null (no domain).
|
||||
*/
|
||||
domain?: string;
|
||||
/**
|
||||
* provider-specific query parameters for the authentication endpoint.
|
||||
* It may be passed either as an object to merge into the query string,
|
||||
* or a function which takes the client's request and returns an object.
|
||||
* Each provider supports its own set of parameters which customize the user's login experience.
|
||||
* For example:
|
||||
* * Facebook supports `display` ('page', 'popup', or 'touch'), `auth_type`, `auth_nonce`.
|
||||
* * Google supports `access_type`, `approval_prompt`, `prompt`, `login_hint`, `user_id`, `hd`.
|
||||
* * Twitter supports `force_login`, `screen_name`.
|
||||
* * Linkedin supports `fields`.
|
||||
*/
|
||||
providerParams?: StringLikeMap | ((request: Request) => StringLikeMap);
|
||||
/**
|
||||
* allows passing query parameters from a bell protected endpoint to the auth request.
|
||||
* It will merge the query params you pass along with the providerParams and any other predefined ones.
|
||||
* Be aware that this will override predefined query parameters!
|
||||
* Default to false.
|
||||
*/
|
||||
allowRuntimeProviderParams?: StringLikeMap | boolean;
|
||||
/**
|
||||
* Each built-in vendor comes with the required scope for basic profile information.
|
||||
* Use scope to specify a different scope as required by your application.
|
||||
* It may be passed either as an object to merge into the query string,
|
||||
* or a function which takes the client's request and returns an object.
|
||||
* Consult the provider for their specific supported scopes.
|
||||
*/
|
||||
scope?: string[] | ((request: Request) => string[]);
|
||||
/**
|
||||
* skips obtaining a user profile from the provider.
|
||||
* Useful if you need specific scopes,
|
||||
* but not the user profile.
|
||||
* Defaults to false.
|
||||
*/
|
||||
skipProfile?: boolean;
|
||||
/**
|
||||
* a configuration object used to customize the provider settings.
|
||||
* The built-in 'twitter' provider accepts the `extendedProfile` & `getMethod` options.
|
||||
* option which allows disabling the extra profile request when the provider
|
||||
* returns the user information in the callback (defaults to true).
|
||||
* The built-in 'github' and 'phabricator' providers accept the uri
|
||||
* option which allows pointing to a private enterprise installation (e.g. 'https://vpn.example.com').
|
||||
* See Providers documentation for more information.
|
||||
*/
|
||||
config?: { extendedProfile?: boolean; getMethod?: string } | { uri?: string };
|
||||
/**
|
||||
* an object of key-value pairs that specify additional
|
||||
* URL query parameters to send with the profile request to the provider.
|
||||
* The built-in facebook provider,
|
||||
* for example, could have fields specified to determine the fields returned from the user's graph,
|
||||
* which would then be available to you in the auth.credentials.profile.raw object.
|
||||
*/
|
||||
profileParams?: StringLikeMap;
|
||||
/**
|
||||
* allows passing additional OAuth state from initial request.
|
||||
* This must be a function returning a string,
|
||||
* which will be appended to the bell internal state parameter for OAuth code flow.
|
||||
*/
|
||||
runtimeStateCallback?(req: Request): string;
|
||||
|
||||
// THESE ARE IN THE *REQUIRED* section but are actually not...
|
||||
/**
|
||||
* A boolean indicating whether or not you want the redirect_uri to be forced to https.
|
||||
* Useful if your hapi application runs as http, but is accessed through https.
|
||||
*/
|
||||
forceHttps?: boolean;
|
||||
/**
|
||||
* Set the base redirect_uri manually if it cannot be inferred properly from server settings.
|
||||
* Useful to override port, protocol, and host if proxied or forwarded.
|
||||
*/
|
||||
location?: string | ((req: Request) => string);
|
||||
}
|
||||
|
||||
export interface RequiredProviderOptions {
|
||||
/**
|
||||
* the cookie encryption password.
|
||||
* Used to encrypt the temporary state cookie used by the module in
|
||||
* between the authorization protocol steps.
|
||||
*/
|
||||
password: string;
|
||||
/**
|
||||
* the OAuth client identifier (consumer key).
|
||||
*/
|
||||
clientId: string;
|
||||
/**
|
||||
* the OAuth client secret (consumer secret)
|
||||
*/
|
||||
clientSecret: string;
|
||||
}
|
||||
|
||||
export interface KnownProviderOptions extends RequiredProviderOptions, OptionalOptions {
|
||||
provider: Provider;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param uri the requested resource URI (bell will add the token or authentication header as needed).
|
||||
* @param params any URI query parameters (cannot include them in the URI due to signature requirements).
|
||||
*/
|
||||
export type AuthedRequest = (uri: string, params: { [key: string]: string } | null) => Promise<any>;
|
||||
|
||||
export interface CustomProtocol {
|
||||
/**
|
||||
* the authorization protocol used.
|
||||
*/
|
||||
protocol: 'oauth' | 'oauth2';
|
||||
/**
|
||||
* the OAuth signature method (OAuth 1.0a only). Must be one of:
|
||||
* * 'HMAC-SHA1' - default
|
||||
* * 'RSA-SHA1' - in that case, the clientSecret is your RSA private key
|
||||
*/
|
||||
signatureMethod?: 'HMAC-SHA1' | 'RSA-SHA1';
|
||||
/**
|
||||
* the temporary credentials (request token) endpoint (OAuth 1.0a only).
|
||||
*/
|
||||
temporary?: string;
|
||||
/**
|
||||
* boolean that determines if OAuth client id and client secret will be sent
|
||||
* as parameters as opposed to an Authorization header (OAuth 2.0 only).
|
||||
* Defaults to false.
|
||||
*/
|
||||
useParamsAuth?: boolean;
|
||||
/**
|
||||
* the authorization endpoint URI.
|
||||
*/
|
||||
auth: string;
|
||||
/**
|
||||
* the access token endpoint URI.
|
||||
*/
|
||||
token: string;
|
||||
/**
|
||||
* the OAuth version.
|
||||
*/
|
||||
version?: string;
|
||||
/**
|
||||
* an array of scope strings (OAuth 2.0 only).
|
||||
*/
|
||||
scope?: string[] | ((query: StringLikeMap) => string[]);
|
||||
/**
|
||||
* the scope separator character (OAuth 2.0 only). Only required when a provider has a broken OAuth 2.0 implementation. Defaults to space (Facebook and GitHub default to comma).
|
||||
*/
|
||||
scopeSeparator?: string;
|
||||
/**
|
||||
* a headers object with additional headers required by the provider
|
||||
* (e.g. GitHub required the 'User-Agent' header which is set by default).
|
||||
*/
|
||||
headers?: {
|
||||
[key: string]: string;
|
||||
};
|
||||
/**
|
||||
* a function used to obtain user profile information and normalize it.
|
||||
* @param credentials the credentials object.
|
||||
* Change the object directly within the function (profile information is typically stored under credentials.profile).
|
||||
* @param params the parsed information received from the provider (e.g. token, secret, and other custom fields).
|
||||
* @param get an OAuth helper function to make authenticated requests using the credentials received.
|
||||
*/
|
||||
profile(credentials: any, params: { [key: string]: string }, get: AuthedRequest): Promise<void>;
|
||||
}
|
||||
|
||||
export interface CustomProviderOptions extends RequiredProviderOptions, OptionalOptions {
|
||||
provider: CustomProtocol;
|
||||
}
|
||||
|
||||
export type BellOptions = CustomProviderOptions | KnownProviderOptions;
|
||||
|
||||
export const plugin: Plugin<CustomProviderOptions | KnownProviderOptions>;
|
||||
/**
|
||||
* Enables simulation mode.
|
||||
*/
|
||||
export function simulate(credentialsFunc: RequestPassThrough): void;
|
||||
/**
|
||||
* [See docs](https://github.com/hapijs/bell/blob/master/API.md#simulated-authentication)
|
||||
* Disables simulation mode
|
||||
*/
|
||||
export function simulate(state: false): void;
|
||||
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"lib": [
|
||||
"es6"
|
||||
],
|
||||
"strictFunctionTypes": true,
|
||||
"strictNullChecks": true,
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"baseUrl": "../",
|
||||
"typeRoots": [
|
||||
"../"
|
||||
],
|
||||
"types": [],
|
||||
"noEmit": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"bell-tests.ts"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"extends": "dtslint/dt.json",
|
||||
"rules": {
|
||||
"unified-signatures": false // Disabling as it prevents me from using overloaded doctags
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user