box-node-sdk
Version:
Official SDK for Box Platform APIs
178 lines • 7.57 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.BoxOAuth = exports.OAuthConfig = void 0;
const network_1 = require("../networking/network");
const authorization_1 = require("../managers/authorization");
const tokenStorage_1 = require("./tokenStorage");
const json_1 = require("../serialization/json");
const utils_1 = require("../internal/utils");
const errors_1 = require("./errors");
class OAuthConfig {
clientId;
clientSecret;
tokenStorage = new tokenStorage_1.InMemoryTokenStorage({});
constructor(fields) {
if (fields.clientId !== undefined) {
this.clientId = fields.clientId;
}
if (fields.clientSecret !== undefined) {
this.clientSecret = fields.clientSecret;
}
if (fields.tokenStorage !== undefined) {
this.tokenStorage = fields.tokenStorage;
}
}
}
exports.OAuthConfig = OAuthConfig;
class BoxOAuth {
/**
* Configuration object of OAuth. */
config;
/**
* An object responsible for storing token. If no custom implementation provided, the token will be stored in memory. */
tokenStorage;
constructor(fields) {
if (fields.config !== undefined) {
this.config = fields.config;
}
this.tokenStorage = this.config.tokenStorage;
}
/**
* Get the authorization URL for the app user.
* @param {GetAuthorizeUrlOptions} options
* @returns {string}
*/
getAuthorizeUrl(options = {}) {
const paramsMap = (0, utils_1.prepareParams)({
['client_id']: !(options.clientId == void 0)
? options.clientId
: this.config.clientId,
['response_type']: !(options.responseType == void 0)
? options.responseType
: 'code',
['redirect_uri']: options.redirectUri,
['state']: options.state,
['scope']: options.scope,
});
return ''.concat('https://account.box.com/api/oauth2/authorize?', (0, json_1.sdToUrlParams)(JSON.stringify(paramsMap)));
}
/**
* Acquires token info using an authorization code.
* @param {string} authorizationCode The authorization code to use to get tokens.
* @param {NetworkSession} networkSession An object to keep network session state
* @returns {Promise<AccessToken>}
*/
async getTokensAuthorizationCodeGrant(authorizationCode, networkSession) {
const authManager = new authorization_1.AuthorizationManager({
networkSession: !(networkSession == void 0)
? networkSession
: new network_1.NetworkSession({}),
});
const token = await authManager.requestAccessToken({
grantType: 'authorization_code',
clientId: this.config.clientId,
clientSecret: this.config.clientSecret,
code: authorizationCode,
});
await this.tokenStorage.store(token);
return token;
}
/**
* Get the current access token. If the current access token is expired or not found, this method will attempt to refresh the token.
* @param {NetworkSession} networkSession An object to keep network session state
* @returns {Promise<AccessToken>}
*/
async retrieveToken(networkSession) {
const token = await this.tokenStorage.get();
if (token == void 0) {
throw new errors_1.BoxSdkError({
message: 'Access and refresh tokens not available. Authenticate before making any API call first.',
});
}
return token;
}
/**
* Get a new access token for the platform app user.
* @param {NetworkSession} networkSession An object to keep network session state
* @returns {Promise<AccessToken>}
*/
async refreshToken(networkSession) {
const oldToken = await this.tokenStorage.get();
const tokenUsedForRefresh = !(oldToken == void 0)
? oldToken.refreshToken
: void 0;
const authManager = new authorization_1.AuthorizationManager({
networkSession: !(networkSession == void 0)
? networkSession
: new network_1.NetworkSession({}),
});
const token = await authManager.requestAccessToken({
grantType: 'refresh_token',
clientId: this.config.clientId,
clientSecret: this.config.clientSecret,
refreshToken: tokenUsedForRefresh,
});
await this.tokenStorage.store(token);
return token;
}
/**
* @param {NetworkSession} networkSession
* @returns {Promise<string>}
*/
async retrieveAuthorizationHeader(networkSession) {
const token = await this.retrieveToken(networkSession);
return ''.concat('Bearer ', token.accessToken);
}
/**
* Revoke an active Access Token, effectively logging a user out that has been previously authenticated.
* @param {NetworkSession} networkSession An object to keep network session state
* @returns {Promise<undefined>}
*/
async revokeToken(networkSession) {
const token = await this.tokenStorage.get();
if (token == void 0) {
return void 0;
}
const authManager = new authorization_1.AuthorizationManager({
networkSession: !(networkSession == void 0)
? networkSession
: new network_1.NetworkSession({}),
});
await authManager.revokeAccessToken({
clientId: this.config.clientId,
clientSecret: this.config.clientSecret,
token: token.accessToken,
});
return void 0;
}
/**
* Downscope access token to the provided scopes. Returning a new access token with the provided scopes, with the original access token unchanged.
* @param {readonly string[]} scopes The scope(s) to apply to the resulting token.
* @param {string} resource The file or folder to get a downscoped token for. If None and shared_link None, the resulting token will not be scoped down to just a single item. The resource should be a full URL to an item, e.g. https://api.box.com/2.0/files/123456.
* @param {string} sharedLink The shared link to get a downscoped token for. If None and item None, the resulting token will not be scoped down to just a single item.
* @param {NetworkSession} networkSession An object to keep network session state
* @returns {Promise<AccessToken>}
*/
async downscopeToken(scopes, resource, sharedLink, networkSession) {
const token = await this.retrieveToken(networkSession);
if (token == void 0 || token.accessToken == void 0) {
throw new errors_1.BoxSdkError({ message: 'No access token is available.' });
}
const authManager = new authorization_1.AuthorizationManager({
networkSession: !(networkSession == void 0)
? networkSession
: new network_1.NetworkSession({}),
});
const downscopedToken = await authManager.requestAccessToken({
grantType: 'urn:ietf:params:oauth:grant-type:token-exchange',
subjectToken: token.accessToken,
subjectTokenType: 'urn:ietf:params:oauth:token-type:access_token',
scope: scopes.join(' '),
resource: resource,
boxSharedLink: sharedLink,
});
return downscopedToken;
}
}
exports.BoxOAuth = BoxOAuth;
//# sourceMappingURL=oauth.js.map