Source: sessions/basic-session.ts

  1. /**
  2.  * @fileoverview A Basic Box API Session.
  3.  */
  5. // ------------------------------------------------------------------------------
  6. // Requirements
  7. // ------------------------------------------------------------------------------
  9. import { Promise } from 'bluebird';
  11. // ------------------------------------------------------------------------------
  12. // Typedefs
  13. // ------------------------------------------------------------------------------
  15. type TokenManager = any /* FIXME */;
  16. type TokenRequestOptions = Record<string, any> /*FIXME*/;
  18. // ------------------------------------------------------------------------------
  19. // Public
  20. // ------------------------------------------------------------------------------
  22. /**
  23.  * A BasicSession holds only a single accessToken. It has no idea how to authenticate,
  24.  * refresh, or persist its token information. When that token expires, the session
  25.  * and any clients using it will become useless.
  26.  *
  27.  * Basic API Session is the most simple API Session to use, which makes it a good choice
  28.  * for simple applications, developers who are just getting started, and applications
  29.  * that wish to manage tokens themselves.
  30.  *
  31.  * @param {string} accessToken The existing access token for a user
  32.  * @param {TokenManager} tokenManager The token manager
  33.  * @constructor
  34.  */
  36. class BasicSession {
  37. 	_accessToken: string;
  38. 	_tokenManager: TokenManager;
  40. 	constructor(accessToken: string, tokenManager: TokenManager) {
  41. 		this._accessToken = accessToken;
  42. 		this._tokenManager = tokenManager;
  43. 	}
  45. 	/**
  46. 	 * Returns the clients access token. BasicSession never returns an error, since it doesn't
  47. 	 * know the status of its own token.
  48. 	 *
  49. 	 * @returns {Promise<string>} Promise resolving to the access token
  50. 	 */
  51. 	getAccessToken() {
  52. 		return Promise.resolve(this._accessToken);
  53. 	}
  55. 	/**
  56. 	 * Revokes the session's access token.
  57. 	 *
  58. 	 * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant
  59. 	 * @returns {Promise} Promise resolving if the revoke succeeds
  60. 	 */
  61. 	revokeTokens(options?: TokenRequestOptions) {
  62. 		return this._tokenManager.revokeTokens(this._accessToken, options);
  63. 	}
  65. 	/**
  66. 	 * Exchange the client access token for one with lower scope
  67. 	 * @param {string|string[]} scopes The scope(s) requested for the new token
  68. 	 * @param {string} [resource] The absolute URL of an API resource to scope the new token to
  69. 	 * @param {Object} [options] - Optional parameters
  70. 	 * @param {TokenRequestOptions} [options.tokenRequestOptions] - Sets optional behavior for the token grant
  71. 	 * @param {ActorParams} [options.actor] - Optional actor parameters for creating annotator tokens
  72. 	 * @returns {Promise<TokenInfo>} Promise resolving to the new token info
  73. 	 */
  74. 	exchangeToken(
  75. 		scopes: string | string[],
  76. 		resource?: string,
  77. 		options?: {
  78. 			tokenRequestOptions?: TokenRequestOptions;
  79. 			actor?: any /* FIXME */;
  80. 		}
  81. 	) {
  82. 		return this._tokenManager.exchangeToken(
  83. 			this._accessToken,
  84. 			scopes,
  85. 			resource,
  86. 			options
  87. 		);
  88. 	}
  89. }
  91. /**
  92.  * @module box-node-sdk/lib/sessions/basic-session
  93.  * @see {@Link BasicSession}
  94.  */
  95. export = BasicSession;