box-node-sdk 1.36.0 → 1.38.0

package/lib/sessions/app-auth-session.js

@@ -1,21 +1,19 @@
+"use strict";
 /**
  * @fileoverview App Auth Box API Session.
  */
-
-'use strict';
-
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 // ------------------------------------------------------------------------------
 // Requirements
 // ------------------------------------------------------------------------------
-
-const Promise = require('bluebird');
-const assert = require('assert');
-const errors = require('../util/errors');
-
+var assert_1 = __importDefault(require("assert"));
+var bluebird_1 = require("bluebird");
+var errors_1 = __importDefault(require("../util/errors"));
 // ------------------------------------------------------------------------------
 // Private
 // ------------------------------------------------------------------------------
-
 /**
  * Validate that an object is a valid TokenStore object
  *
@@ -25,13 +23,11 @@ const errors = require('../util/errors');
  * @private
  */
 function isObjectValidTokenStore(obj) {
-	return Boolean(obj && obj.read && obj.write && obj.clear);
+    return Boolean(obj && obj.read && obj.write && obj.clear);
 }
-
 // ------------------------------------------------------------------------------
 // Public
 // ------------------------------------------------------------------------------
-
 /**
  * App Auth Box API Session.
  *
@@ -51,152 +47,136 @@ function isObjectValidTokenStore(obj) {
  * @param {TokenStore} [tokenStore] The token store instance to use for caching token info
  * @constructor
  */
-function AppAuthSession(type, id, config, tokenManager, tokenStore) {
-	this._type = type;
-	this._id = id;
-	this._config = config;
-	this._tokenManager = tokenManager;
-
-	// If tokenStore was provided, set the persistent data & current store operations
-	if (tokenStore) {
-		assert(isObjectValidTokenStore(tokenStore), 'Token store provided is improperly formatted. Methods required: read(), write(), clear().');
-		this._tokenStore = Promise.promisifyAll(tokenStore);
-	}
-
-	// The TokenInfo object for this app auth session
-	this._tokenInfo = null;
-
-	// Indicates if tokens are currently being refreshed
-	this._refreshPromise = null;
-}
-
-/**
- * Initiate a refresh of the app auth access tokens. New tokens should be passed
- * to the caller, and then cached for later use.
- *
- * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant
- * @returns {Promise<string>} Promise resolving to the access token
- * @private
- */
-AppAuthSession.prototype._refreshAppAuthAccessToken = function(options) {
-
-	// If tokens aren't already being refreshed, start the refresh
-	if (!this._refreshPromise) {
-
-		this._refreshPromise = this._tokenManager.getTokensJWTGrant(this._type, this._id, options)
-			.then(tokenInfo => {
-				// Set new token info and propagate the new access token
-				this._tokenInfo = tokenInfo;
-
-				if (this._tokenStore) {
-					return this._tokenStore.writeAsync(tokenInfo)
-						.then(() => tokenInfo.accessToken);
-				}
-
-				return tokenInfo.accessToken;
-			})
-			.finally(() => {
-				// Refresh complete, clear promise
-				this._refreshPromise = null;
-			});
-	}
-
-	return this._refreshPromise;
-};
-
-/**
- * Produces a valid, app auth access token.
- * Performs a refresh before returning if the current token is expired. If the current
- * token is considered stale but still valid, return the current token but initiate a
- * new refresh in the background.
- *
- * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant
- * @returns {Promise<string>} Promise resolving to the access token
- */
-AppAuthSession.prototype.getAccessToken = function(options) {
-
-	var expirationBuffer = Math.max(this._config.expiredBufferMS, this._config.staleBufferMS);
-
-	// If we're initializing the client and have a token store, try reading from it
-	if (!this._tokenInfo && this._tokenStore) {
-
-		return this._tokenStore.readAsync()
-			.then(tokenInfo => {
-				if (!this._tokenManager.isAccessTokenValid(tokenInfo, expirationBuffer)) {
-					// Token store contains expired tokens, refresh
-					return this._refreshAppAuthAccessToken(options);
-				}
-
-				this._tokenInfo = tokenInfo;
-				return tokenInfo.accessToken;
-			});
-	}
-
-	// If the current token is not fresh, get a new token. All incoming
-	// requests will be held until a fresh token is retrieved.
-	if (!this._tokenInfo || !this._tokenManager.isAccessTokenValid(this._tokenInfo, expirationBuffer)) {
-		return this._refreshAppAuthAccessToken(options);
-	}
-
-	// Your token is not currently stale! Return the current access token.
-	return Promise.resolve(this._tokenInfo.accessToken);
-};
-
-/**
- * Revokes the app auth token used by this session, and clears the saved tokenInfo.
- *
- * @param {TokenRequestOptions} [options]- Sets optional behavior for the token grant
- * @returns {Promise} Promise resolving if the revoke succeeds
- */
-AppAuthSession.prototype.revokeTokens = function(options) {
-	// The current app auth token is revoked (but a new one will be created automatically as needed).
-	var tokenInfo = this._tokenInfo || {},
-		accessToken = tokenInfo.accessToken;
-	this._tokenInfo = null;
-	return this._tokenManager.revokeTokens(accessToken, options);
-};
-
-/**
- * Exchange the client access token for one with lower scope
- * @param {string|string[]} scopes The scope(s) requested for the new token
- * @param {string} [resource] The absolute URL of an API resource to scope the new token to
- * @param {Object} [options] - Optional parameters
- * @param {TokenRequestOptions} [options.tokenRequestOptions] - Sets optional behavior for the token grant
- * @param {ActorParams} [options.actor] - Optional actor parameters for creating annotator tokens
- * @returns {Promise<TokenInfo>} Promise resolving to the new token info
- */
-AppAuthSession.prototype.exchangeToken = function(scopes, resource, options) {
-	return this.getAccessToken(options)
-		.then(accessToken => this._tokenManager.exchangeToken(accessToken, scopes, resource, options));
-};
-
-/**
- * Handle an an "Expired Tokens" Error. If our tokens are expired, we need to clear the token
- * store (if present) before continuing.
- *
- * @param {Errors~ExpiredTokensError} err An "expired tokens" error including information
- *  about the request/response.
- * @returns {Promise<Error>} Promise resolving to an error.  This will
- *  usually be the original response error, but could an error from trying to access the
- *  token store as well.
- */
-AppAuthSession.prototype.handleExpiredTokensError = function(err) {
-
-	if (!this._tokenStore) {
-		return Promise.resolve(err);
-	}
-
-	// If a token store is available, clear the store and throw either error
-	// eslint-disable-next-line promise/no-promise-in-callback
-	return this._tokenStore.clearAsync()
-		.catch(e => errors.unwrapAndThrow(e))
-		.then(() => {
-			throw err;
-		});
-};
-
-/**
- * @module box-node-sdk/lib/sessions/app-auth-session
- * @see {@Link AppAuthSession}
- */
+var AppAuthSession = /** @class */ (function () {
+    function AppAuthSession(type, id, config, tokenManager, tokenStore) {
+        this._type = type;
+        this._id = id;
+        this._config = config;
+        this._tokenManager = tokenManager;
+        // If tokenStore was provided, set the persistent data & current store operations
+        if (tokenStore) {
+            assert_1.default(isObjectValidTokenStore(tokenStore), 'Token store provided is improperly formatted. Methods required: read(), write(), clear().');
+            this._tokenStore = bluebird_1.Promise.promisifyAll(tokenStore);
+        }
+        // The TokenInfo object for this app auth session
+        this._tokenInfo = null;
+        // Indicates if tokens are currently being refreshed
+        this._refreshPromise = null;
+    }
+    /**
+     * Initiate a refresh of the app auth access tokens. New tokens should be passed
+     * to the caller, and then cached for later use.
+     *
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant
+     * @returns {Promise<string>} Promise resolving to the access token
+     * @private
+     */
+    AppAuthSession.prototype._refreshAppAuthAccessToken = function (options) {
+        var _this = this;
+        // If tokens aren't already being refreshed, start the refresh
+        if (!this._refreshPromise) {
+            this._refreshPromise = this._tokenManager
+                .getTokensJWTGrant(this._type, this._id, options)
+                .then(function (tokenInfo) {
+                // Set new token info and propagate the new access token
+                _this._tokenInfo = tokenInfo;
+                if (_this._tokenStore) {
+                    return _this._tokenStore
+                        .writeAsync(tokenInfo)
+                        .then(function () { return tokenInfo.accessToken; });
+                }
+                return tokenInfo.accessToken;
+            })
+                .finally(function () {
+                // Refresh complete, clear promise
+                _this._refreshPromise = null;
+            });
+        }
+        return this._refreshPromise;
+    };
+    /**
+     * Produces a valid, app auth access token.
+     * Performs a refresh before returning if the current token is expired. If the current
+     * token is considered stale but still valid, return the current token but initiate a
+     * new refresh in the background.
+     *
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant
+     * @returns {Promise<string>} Promise resolving to the access token
+     */
+    AppAuthSession.prototype.getAccessToken = function (options) {
+        var _this = this;
+        var expirationBuffer = Math.max(this._config.expiredBufferMS, this._config.staleBufferMS);
+        // If we're initializing the client and have a token store, try reading from it
+        if (!this._tokenInfo && this._tokenStore) {
+            return this._tokenStore.readAsync().then(function (tokenInfo) {
+                if (!_this._tokenManager.isAccessTokenValid(tokenInfo, expirationBuffer)) {
+                    // Token store contains expired tokens, refresh
+                    return _this._refreshAppAuthAccessToken(options);
+                }
+                _this._tokenInfo = tokenInfo;
+                return tokenInfo.accessToken;
+            });
+        }
+        // If the current token is not fresh, get a new token. All incoming
+        // requests will be held until a fresh token is retrieved.
+        if (!this._tokenInfo ||
+            !this._tokenManager.isAccessTokenValid(this._tokenInfo, expirationBuffer)) {
+            return this._refreshAppAuthAccessToken(options);
+        }
+        // Your token is not currently stale! Return the current access token.
+        return bluebird_1.Promise.resolve(this._tokenInfo.accessToken);
+    };
+    /**
+     * Revokes the app auth token used by this session, and clears the saved tokenInfo.
+     *
+     * @param {TokenRequestOptions} [options]- Sets optional behavior for the token grant
+     * @returns {Promise} Promise resolving if the revoke succeeds
+     */
+    AppAuthSession.prototype.revokeTokens = function (options) {
+        // The current app auth token is revoked (but a new one will be created automatically as needed).
+        var tokenInfo = this._tokenInfo || {}, accessToken = tokenInfo.accessToken;
+        this._tokenInfo = null;
+        return this._tokenManager.revokeTokens(accessToken, options);
+    };
+    /**
+     * Exchange the client access token for one with lower scope
+     * @param {string|string[]} scopes The scope(s) requested for the new token
+     * @param {string} [resource] The absolute URL of an API resource to scope the new token to
+     * @param {Object} [options] - Optional parameters
+     * @param {TokenRequestOptions} [options.tokenRequestOptions] - Sets optional behavior for the token grant
+     * @param {ActorParams} [options.actor] - Optional actor parameters for creating annotator tokens
+     * @returns {Promise<TokenInfo>} Promise resolving to the new token info
+     */
+    AppAuthSession.prototype.exchangeToken = function (scopes, resource, options) {
+        var _this = this;
+        return this.getAccessToken(options).then(function (accessToken) {
+            return _this._tokenManager.exchangeToken(accessToken, scopes, resource, options);
+        });
+    };
+    /**
+     * Handle an an "Expired Tokens" Error. If our tokens are expired, we need to clear the token
+     * store (if present) before continuing.
+     *
+     * @param {Errors~ExpiredTokensError} err An "expired tokens" error including information
+     *  about the request/response.
+     * @returns {Promise<Error>} Promise resolving to an error.  This will
+     *  usually be the original response error, but could an error from trying to access the
+     *  token store as well.
+     */
+    AppAuthSession.prototype.handleExpiredTokensError = function (err /* FIXME */) {
+        if (!this._tokenStore) {
+            return bluebird_1.Promise.resolve(err);
+        }
+        // If a token store is available, clear the store and throw either error
+        // eslint-disable-next-line promise/no-promise-in-callback
+        return this._tokenStore
+            .clearAsync()
+            .catch(function (e) { return errors_1.default.unwrapAndThrow(e); })
+            .then(function () {
+            throw err;
+        });
+    };
+    return AppAuthSession;
+}());
 module.exports = AppAuthSession;
+//# sourceMappingURL=app-auth-session.js.map

package/lib/sessions/app-auth-session.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-auth-session.js","sourceRoot":"","sources":["../../src/sessions/app-auth-session.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAEH,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AAEjF,kDAA4B;AAC5B,qCAAmC;AACnC,0DAAoC;AAYpC,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF;;;;;;;GAOG;AACH,SAAS,uBAAuB,CAAC,GAAwB;IACxD,OAAO,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;;;;;;;;;;;;;GAkBG;AACH;IASC,wBACC,IAAY,EACZ,EAAU,EACV,MAAc,EACd,YAA0B,EAC1B,UAAuB;QAEvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAElC,iFAAiF;QACjF,IAAI,UAAU,EAAE;YACf,gBAAM,CACL,uBAAuB,CAAC,UAAU,CAAC,EACnC,2FAA2F,CAC3F,CAAC;YACF,IAAI,CAAC,WAAW,GAAG,kBAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;SACpD;QAED,iDAAiD;QACjD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvB,oDAAoD;QACpD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;IAC7B,CAAC;IAED;;;;;;;OAOG;IACH,mDAA0B,GAA1B,UAA2B,OAA6B;QAAxD,iBAwBC;QAvBA,8DAA8D;QAC9D,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YAC1B,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,aAAa;iBACvC,iBAAiB,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC;iBAChD,IAAI,CAAC,UAAC,SAAoB;gBAC1B,wDAAwD;gBACxD,KAAI,CAAC,UAAU,GAAG,SAAS,CAAC;gBAE5B,IAAI,KAAI,CAAC,WAAW,EAAE;oBACrB,OAAO,KAAI,CAAC,WAAW;yBACrB,UAAU,CAAC,SAAS,CAAC;yBACrB,IAAI,CAAC,cAAM,OAAA,SAAS,CAAC,WAAW,EAArB,CAAqB,CAAC,CAAC;iBACpC;gBAED,OAAO,SAAS,CAAC,WAAW,CAAC;YAC9B,CAAC,CAAC;iBACD,OAAO,CAAC;gBACR,kCAAkC;gBAClC,KAAI,CAAC,eAAe,GAAG,IAAI,CAAC;YAC7B,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,IAAI,CAAC,eAAe,CAAC;IAC7B,CAAC;IAED;;;;;;;;OAQG;IACH,uCAAc,GAAd,UAAe,OAA6B;QAA5C,iBAgCC;QA/BA,IAAI,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAC9B,IAAI,CAAC,OAAO,CAAC,eAAe,EAC5B,IAAI,CAAC,OAAO,CAAC,aAAa,CAC1B,CAAC;QAEF,+EAA+E;QAC/E,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;YACzC,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,UAAC,SAAoB;gBAC7D,IACC,CAAC,KAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,SAAS,EAAE,gBAAgB,CAAC,EAClE;oBACD,+CAA+C;oBAC/C,OAAO,KAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;iBAChD;gBAED,KAAI,CAAC,UAAU,GAAG,SAAS,CAAC;gBAC5B,OAAO,SAAS,CAAC,WAAW,CAAC;YAC9B,CAAC,CAAC,CAAC;SACH;QAED,mEAAmE;QACnE,0DAA0D;QAC1D,IACC,CAAC,IAAI,CAAC,UAAU;YAChB,CAAC,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,EACxE;YACD,OAAO,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;SAChD;QAED,sEAAsE;QACtE,OAAO,kBAAO,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACH,qCAAY,GAAZ,UAAa,OAA4B;QACxC,iGAAiG;QACjG,IAAI,SAAS,GAAG,IAAI,CAAC,UAAU,IAAI,EAAE,EACpC,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;OAQG;IACH,sCAAa,GAAb,UACC,MAAyB,EACzB,QAAiB,EACjB,OAGC;QANF,iBAWC;QAHA,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,UAAC,WAAmB;YAC5D,OAAA,KAAI,CAAC,aAAa,CAAC,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC;QAAxE,CAAwE,CACxE,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,iDAAwB,GAAxB,UAAyB,GAAQ,CAAC,WAAW;QAC5C,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACtB,OAAO,kBAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;SAC5B;QAED,wEAAwE;QACxE,0DAA0D;QAC1D,OAAO,IAAI,CAAC,WAAW;aACrB,UAAU,EAAE;aACZ,KAAK,CAAC,UAAC,CAAM,IAAK,OAAA,gBAAM,CAAC,cAAc,CAAC,CAAC,CAAC,EAAxB,CAAwB,CAAC;aAC3C,IAAI,CAAC;YACL,MAAM,GAAG,CAAC;QACX,CAAC,CAAC,CAAC;IACL,CAAC;IACF,qBAAC;AAAD,CAAC,AA9KD,IA8KC;AAMD,iBAAS,cAAc,CAAC"}

package/lib/sessions/basic-session.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @fileoverview A Basic Box API Session.
+ */
+/// <reference types="bluebird" />
+declare type TokenManager = any;
+declare type TokenRequestOptions = Record<string, any>;
+/**
+ * A BasicSession holds only a single accessToken. It has no idea how to authenticate,
+ * refresh, or persist its token information. When that token expires, the session
+ * and any clients using it will become useless.
+ *
+ * Basic API Session is the most simple API Session to use, which makes it a good choice
+ * for simple applications, developers who are just getting started, and applications
+ * that wish to manage tokens themselves.
+ *
+ * @param {string} accessToken The existing access token for a user
+ * @param {TokenManager} tokenManager The token manager
+ * @constructor
+ */
+declare class BasicSession {
+    _accessToken: string;
+    _tokenManager: TokenManager;
+    constructor(accessToken: string, tokenManager: TokenManager);
+    /**
+     * Returns the clients access token. BasicSession never returns an error, since it doesn't
+     * know the status of its own token.
+     *
+     * @returns {Promise<string>} Promise resolving to the access token
+     */
+    getAccessToken(): import("bluebird")<string>;
+    /**
+     * Revokes the session's access token.
+     *
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant
+     * @returns {Promise} Promise resolving if the revoke succeeds
+     */
+    revokeTokens(options?: TokenRequestOptions): any;
+    /**
+     * Exchange the client access token for one with lower scope
+     * @param {string|string[]} scopes The scope(s) requested for the new token
+     * @param {string} [resource] The absolute URL of an API resource to scope the new token to
+     * @param {Object} [options] - Optional parameters
+     * @param {TokenRequestOptions} [options.tokenRequestOptions] - Sets optional behavior for the token grant
+     * @param {ActorParams} [options.actor] - Optional actor parameters for creating annotator tokens
+     * @returns {Promise<TokenInfo>} Promise resolving to the new token info
+     */
+    exchangeToken(scopes: string | string[], resource?: string, options?: {
+        tokenRequestOptions?: TokenRequestOptions;
+        actor?: any;
+    }): any;
+}
+/**
+ * @module box-node-sdk/lib/sessions/basic-session
+ * @see {@Link BasicSession}
+ */
+export = BasicSession;

package/lib/sessions/basic-session.js

@@ -1,20 +1,14 @@
+"use strict";
 /**
  * @fileoverview A Basic Box API Session.
  */
-
-'use strict';
-
-
 // ------------------------------------------------------------------------------
 // Requirements
 // ------------------------------------------------------------------------------
-
-const Promise = require('bluebird');
-
+var bluebird_1 = require("bluebird");
 // ------------------------------------------------------------------------------
 // Public
 // ------------------------------------------------------------------------------
-
 /**
  * A BasicSession holds only a single accessToken. It has no idea how to authenticate,
  * refresh, or persist its token information. When that token expires, the session
@@ -28,46 +22,42 @@ const Promise = require('bluebird');
  * @param {TokenManager} tokenManager The token manager
  * @constructor
  */
-function BasicSession(accessToken, tokenManager) {
-	this._accessToken = accessToken;
-	this._tokenManager = tokenManager;
-}
-
-/**
- * Returns the clients access token. BasicSession never returns an error, since it doesn't
- * know the status of its own token.
- *
- * @returns {Promise<string>} Promise resolving to the access token
- */
-BasicSession.prototype.getAccessToken = function() {
-	return Promise.resolve(this._accessToken);
-};
-
-/**
- * Revokes the session's access token.
- *
- * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant
- * @returns {Promise} Promise resolving if the revoke succeeds
- */
-BasicSession.prototype.revokeTokens = function(options) {
-	return this._tokenManager.revokeTokens(this._accessToken, options);
-};
-
-/**
- * Exchange the client access token for one with lower scope
- * @param {string|string[]} scopes The scope(s) requested for the new token
- * @param {string} [resource] The absolute URL of an API resource to scope the new token to
- * @param {Object} [options] - Optional parameters
- * @param {TokenRequestOptions} [options.tokenRequestOptions] - Sets optional behavior for the token grant
- * @param {ActorParams} [options.actor] - Optional actor parameters for creating annotator tokens
- * @returns {Promise<TokenInfo>} Promise resolving to the new token info
- */
-BasicSession.prototype.exchangeToken = function(scopes, resource, options) {
-	return this._tokenManager.exchangeToken(this._accessToken, scopes, resource, options);
-};
-
-/**
- * @module box-node-sdk/lib/sessions/basic-session
- * @see {@Link BasicSession}
- */
+var BasicSession = /** @class */ (function () {
+    function BasicSession(accessToken, tokenManager) {
+        this._accessToken = accessToken;
+        this._tokenManager = tokenManager;
+    }
+    /**
+     * Returns the clients access token. BasicSession never returns an error, since it doesn't
+     * know the status of its own token.
+     *
+     * @returns {Promise<string>} Promise resolving to the access token
+     */
+    BasicSession.prototype.getAccessToken = function () {
+        return bluebird_1.Promise.resolve(this._accessToken);
+    };
+    /**
+     * Revokes the session's access token.
+     *
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant
+     * @returns {Promise} Promise resolving if the revoke succeeds
+     */
+    BasicSession.prototype.revokeTokens = function (options) {
+        return this._tokenManager.revokeTokens(this._accessToken, options);
+    };
+    /**
+     * Exchange the client access token for one with lower scope
+     * @param {string|string[]} scopes The scope(s) requested for the new token
+     * @param {string} [resource] The absolute URL of an API resource to scope the new token to
+     * @param {Object} [options] - Optional parameters
+     * @param {TokenRequestOptions} [options.tokenRequestOptions] - Sets optional behavior for the token grant
+     * @param {ActorParams} [options.actor] - Optional actor parameters for creating annotator tokens
+     * @returns {Promise<TokenInfo>} Promise resolving to the new token info
+     */
+    BasicSession.prototype.exchangeToken = function (scopes, resource, options) {
+        return this._tokenManager.exchangeToken(this._accessToken, scopes, resource, options);
+    };
+    return BasicSession;
+}());
 module.exports = BasicSession;
+//# sourceMappingURL=basic-session.js.map

package/lib/sessions/basic-session.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"basic-session.js","sourceRoot":"","sources":["../../src/sessions/basic-session.ts"],"names":[],"mappings":";AAAA;;GAEG;AAEH,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AAEjF,qCAAmC;AASnC,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;;;;;;;GAYG;AAEH;IAIC,sBAAY,WAAmB,EAAE,YAA0B;QAC1D,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,qCAAc,GAAd;QACC,OAAO,kBAAO,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,mCAAY,GAAZ,UAAa,OAA6B;QACzC,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACH,oCAAa,GAAb,UACC,MAAyB,EACzB,QAAiB,EACjB,OAGC;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,aAAa,CACtC,IAAI,CAAC,YAAY,EACjB,MAAM,EACN,QAAQ,EACR,OAAO,CACP,CAAC;IACH,CAAC;IACF,mBAAC;AAAD,CAAC,AArDD,IAqDC;AAMD,iBAAS,YAAY,CAAC"}

package/lib/sessions/persistent-session.d.ts

@@ -0,0 +1,96 @@
+/**
+ * @fileoverview A Persistent Box API Session.
+ */
+declare type TokenInfo = any;
+declare type TokenStore = any;
+declare type Config = any;
+declare type TokenManager = any;
+declare type TokenRequestOptions = Record<string, any>;
+/**
+ * A Persistent API Session has the ability to refresh its access token once it becomes expired.
+ * It takes in a full tokenInfo object for authentication. It can detect when its tokens have
+ * expired and will request new, valid tokens if needed. It can also interface with a token
+ * data-store if one is provided.
+ *
+ * Persistent API Session a good choice for long-running applications or web servers that
+ * must remember users across sessions.
+ *
+ * @param {TokenInfo} tokenInfo A valid TokenInfo object. Will throw if improperly formatted.
+ * @param {TokenStore} [tokenStore] A valid TokenStore object. Will throw if improperly formatted.
+ * @param {Config} config The SDK configuration options
+ * @param {TokenManager} tokenManager The token manager
+ * @constructor
+ */
+declare class PersistentSession {
+    _config: Config;
+    _refreshPromise: Promise<any> | null;
+    _tokenManager: TokenManager;
+    _tokenStore: TokenStore;
+    _tokenInfo: TokenInfo;
+    constructor(tokenInfo: TokenInfo, tokenStore: TokenStore, config: Config, tokenManager: TokenManager);
+    /**
+     * Sets all relevant token info for this client.
+     *
+     * @param {TokenInfo} tokenInfo A valid TokenInfo object.
+     * @returns {void}
+     * @private
+     */
+    _setTokenInfo(tokenInfo: TokenStore): void;
+    /**
+     * Attempts to refresh tokens for the client.
+     * Will use the Box refresh token grant to complete the refresh. On refresh failure, we'll
+     * check the token store for more recently updated tokens and load them if found. Otherwise
+     * an error will be propagated.
+     *
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant
+     * @returns {Promise<string>} Promise resolving to the access token
+     * @private
+     */
+    _refreshTokens(options?: TokenRequestOptions): Promise<any>;
+    /**
+     * Returns the clients access token.
+     *
+     * If tokens don't yet exist, first attempt to retrieve them.
+     * If tokens are expired, first attempt to refresh them.
+     *
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant
+     * @returns {Promise<string>} Promise resolving to the access token
+     */
+    getAccessToken(options?: TokenRequestOptions): Promise<any>;
+    /**
+     * Revokes the session's tokens. If the session has a refresh token we'll use that,
+     * since it is more likely to be up to date. Otherwise, we'll revoke the accessToken.
+     * Revoking either one will disable the other as well.
+     *
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant
+     * @returns {Promise} Promise that resolves when the revoke succeeds
+     */
+    revokeTokens(options?: TokenRequestOptions): any;
+    /**
+     * Exchange the client access token for one with lower scope
+     * @param {string|string[]} scopes The scope(s) requested for the new token
+     * @param {string} [resource] The absolute URL of an API resource to scope the new token to
+     * @param {Object} [options] - Optional parameters
+     * @param {TokenRequestOptions} [options.tokenRequestOptions] - Sets optional behavior for the token grant
+     * @returns {void}
+     */
+    exchangeToken(scopes: string | string[], resource?: string, options?: {
+        tokenRequestOptions?: TokenRequestOptions;
+    }): Promise<any>;
+    /**
+     * Handle an an "Expired Tokens" Error. If our tokens are expired, we need to clear the token
+     * store (if present) before continuing.
+     *
+     * @param {Errors~ExpiredTokensError} err An "expired tokens" error including information
+     *  about the request/response.
+     * @returns {Promise<Error>} Promise resolving to an error.  This will
+     *  usually be the original response error, but could an error from trying to access the
+     *  token store as well.
+     */
+    handleExpiredTokensError(err: any): any;
+}
+/**
+ * @module box-node-sdk/lib/sessions/persistent-session
+ * @see {@Link PersistentSession}
+ */
+export = PersistentSession;