box-node-sdk 3.8.1 → 3.8.2

package/lib-esm/box-node-sdk.d.ts

@@ -0,0 +1,227 @@
+/**
+ * @fileoverview Box SDK for Node.js
+ */
+import { EventEmitter } from 'events';
+import CCGAPISession = require('./sessions/ccg-session');
+import APIRequestManager = require('./api-request-manager');
+import BoxClient = require('./box-client');
+import TokenManager = require('./token-manager');
+/**
+ * Object representing interface functions for PersistentClient to interact with the consumer app's central storage layer.
+ * @typedef {Object} TokenStore
+ * @property {ReadTokenInfoFromStore} read - read TokenInfo from app central store.
+ * @property {WriteTokenInfoToStore} write - write TokenInfo to the app's central store.
+ * @property {ClearTokenInfoFromStore} clear - delete TokenInfo from the app's central store.
+ */
+/**
+ * Acquires TokenInfo from the consumer app's central store.
+ * @typedef {Function} ReadTokenInfoFromStore
+ * @param {Function} callback - err if store read issue occurred, otherwise propagates a TokenInfo object
+ */
+/**
+ * Writes TokenInfo to the consumer app's central store
+ * @typedef {Function} WriteTokenInfoToStore
+ * @param {TokenInfo} tokenInfo - the token info to be written
+ * @param {Function} callback - err if store write issue occurred, otherwise propagates null err
+ *  and null result to indicate success
+ */
+/**
+ * Clears TokenInfo from the consumer app's central store
+ * @typedef {Function} ClearTokenInfoFromStore
+ * @param {Function} callback - err if store delete issue occurred, otherwise propagates null err
+ *  and null result to indicate success
+ */
+type TokenStore = object;
+type UserConfigurationOptions = object;
+type TokenRequestOptions = object;
+type CCGConfig = {
+    boxSubjectType: 'user' | 'enterprise';
+    boxSubjectId: string;
+};
+/**
+ * A backend NodeJS SDK to interact with the Box V2 API.
+ * This is the single entry point for all SDK consumer interactions. This is the only file that a 3rd party app
+ * should require. All other components are private and reached out to via this component.
+ * 1. Provides getters to spawn client instances for users to interact with the Box API.
+ * 2. Provides manual capability to acquire tokens via token grant endpoints.
+ *    However, it is recommended to use clients to do this for you.
+ * 3. Emits notification events about relevant request/response events. Useful for logging Box API interactions.
+ *    Notification events: request retries, exceeding max retries, permanent failures.
+ *
+ * @param {UserConfigurationOptions} params User settings used to initialize and customize the SDK
+ * @constructor
+ */
+declare class BoxSDKNode extends EventEmitter {
+    accessLevels: any;
+    collaborationRoles: any;
+    CURRENT_USER_ID: any;
+    config: any;
+    _eventBus: EventEmitter;
+    requestManager: APIRequestManager;
+    tokenManager: TokenManager;
+    ccgSession: CCGAPISession;
+    /**
+     * Expose the BoxClient property enumerations to the SDK as a whole. This allows
+     * the consumer to access and use these values from anywhere in their application
+     * (like a helper) by requiring the SDK, instead of needing to pass the client.
+     */
+    static accessLevels: any;
+    static collaborationRoles: any;
+    static CURRENT_USER_ID: any;
+    /**
+     * Expose Webhooks.validateMessage() to the SDK as a whole. This allows
+     * the consumer to call BoxSDK.validateWebhookMessage() by just requiring the SDK,
+     * instead of needing to create a client (which is not needed to validate messages).
+     */
+    static validateWebhookMessage: any;
+    constructor(params: UserConfigurationOptions);
+    /**
+     * Setup the SDK instance by instantiating necessary objects with current
+     * configuration values.
+     *
+     * @returns {void}
+     * @private
+     */
+    _setup(): void;
+    /**
+     * Gets the BoxSDKNode instance by passing boxAppSettings json downloaded from the developer console.
+     *
+     * @param {Object} appConfig boxAppSettings object retrieved from Dev Console.
+     * @returns {BoxSDKNode} an instance that has been preconfigured with the values from the Dev Console
+     */
+    static getPreconfiguredInstance(appConfig: any): BoxSDKNode;
+    /**
+     * Updates the SDK configuration with new parameters.
+     *
+     * @param {UserConfigurationOptions} params User settings
+     * @returns {void}
+     */
+    configure(params: UserConfigurationOptions): void;
+    /**
+     * Returns a Box Client with a Basic API Session. The client is able to make requests on behalf of a user.
+     * A basic session has no access to a user's refresh token. Because of this, once the session's tokens
+     * expire the client cannot recover and a new session will need to be generated.
+     *
+     * @param {string} accessToken A user's Box API access token
+     * @returns {BoxClient} Returns a new Box Client paired to a new BasicAPISession
+     */
+    getBasicClient(accessToken: string): BoxClient;
+    /**
+     * Returns a Box Client with a Basic API Session. The client is able to make requests on behalf of a user.
+     * A basic session has no access to a user's refresh token. Because of this, once the session's tokens
+     * expire the client cannot recover and a new session will need to be generated.
+     *
+     * @param {string} accessToken A user's Box API access token
+     * @returns {BoxClient} Returns a new Box Client paired to a new BasicAPISession
+     */
+    static getBasicClient(accessToken: string): BoxClient;
+    /**
+     * Returns a Box Client with a persistent API session. A persistent API session helps manage the user's tokens,
+     * and can refresh them automatically if the access token expires. If a central data-store is given, the session
+     * can read & write tokens to it.
+     *
+     * NOTE: If tokenInfo or tokenStore are formatted incorrectly, this method will throw an error. If you
+     * haven't explicitly created either of these objects or are otherwise not completly confident in their validity,
+     * you should wrap your call to getPersistentClient in a try-catch to handle any potential errors.
+     *
+     * @param {TokenInfo} tokenInfo A tokenInfo object to use for authentication
+     * @param {TokenStore} [tokenStore] An optional token store for reading/writing tokens to session
+     * @returns {BoxClient} Returns a new Box Client paired to a new PersistentAPISession
+     */
+    getPersistentClient(tokenInfo: any, tokenStore?: TokenStore): BoxClient;
+    /**
+     * Returns a Box Client configured to use Client Credentials Grant for a service account. Requires enterprise ID
+     * to be set when configuring SDK instance.
+     *
+     * @returns {BoxClient} Returns a new Box Client paired to a AnonymousAPISession. All Anonymous API Sessions share the
+     * same tokens, which allows them to refresh them efficiently and reduce load on both the application and
+     * the API.
+     */
+    getAnonymousClient(): BoxClient;
+    /**
+     * Returns a Box Client configured to use Client Credentials Grant for a specified user.
+     *
+     * @param userId the user ID to use when getting the access token
+     * @returns {BoxClient} Returns a new Box Client paired to a AnonymousAPISession. All Anonymous API Sessions share the
+     * same tokens, which allows them to refresh them efficiently and reduce load on both the application and
+     * the API.
+     */
+    getCCGClientForUser(userId: string): BoxClient;
+    _getCCGClient(config: CCGConfig): BoxClient;
+    /**
+     * Create a new client using App Auth for the given entity. This allows either
+     * managing App Users (as the enterprise) or performing operations as the App
+     * Users or Managed Users themselves (as a user).
+     *
+     * @param {string} type The type of entity to operate as, "enterprise" or "user"
+     * @param {string} [id] (Optional) The Box ID of the entity to operate as
+     * @param {TokenStore} [tokenStore] (Optional) the token store to use for caching tokens
+     * @returns {BoxClient} A new client authorized as the app user or enterprise
+     */
+    getAppAuthClient(type: string, id?: string, tokenStore?: TokenStore): BoxClient;
+    /**
+     * Generate the URL for the authorize page to send users to for the first leg of
+     * the OAuth2 flow.
+     *
+     * @param {Object} params The OAuth2 parameters
+     * @returns {string} The authorize page URL
+     */
+    getAuthorizeURL(params: {
+        client_id?: string;
+    }): string;
+    /**
+     * Acquires token info using an authorization code
+     *
+     * @param {string} authorizationCode - authorization code issued by Box
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
+     * @param {Function} [callback] - passed a TokenInfo object if tokens were granted successfully
+     * @returns {Promise<TokenInfo>} Promise resolving to the token info
+     */
+    getTokensAuthorizationCodeGrant(authorizationCode: string, options?: TokenRequestOptions | null, callback?: Function): import("bluebird")<{
+        accessToken: any;
+        refreshToken: any;
+        accessTokenTTLMS: number;
+        acquiredAtMS: number;
+    }>;
+    /**
+     * Refreshes the access and refresh tokens for a given refresh token.
+     *
+     * @param {string} refreshToken - A valid OAuth refresh token
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
+     * @param {Function} [callback] - passed a TokenInfo object if tokens were granted successfully
+     * @returns {Promise<TokenInfo>} Promise resolving to the token info
+     */
+    getTokensRefreshGrant(refreshToken: string, options?: TokenRequestOptions | Function | null, callback?: Function): import("bluebird")<{
+        accessToken: any;
+        refreshToken: any;
+        accessTokenTTLMS: number;
+        acquiredAtMS: number;
+    }>;
+    /**
+     * Gets tokens for enterprise administration of app users
+     * @param {string} enterpriseID The ID of the enterprise to generate a token for
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
+     * @param {Function} [callback] Passed the tokens if successful
+     * @returns {Promise<TokenInfo>} Promise resolving to the token info
+     */
+    getEnterpriseAppAuthTokens(enterpriseID: string, options?: TokenRequestOptions | Function | null, callback?: Function): import("bluebird")<any>;
+    /**
+     * Gets tokens for App Users via a JWT grant
+     * @param {string} userID The ID of the App User to generate a token for
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
+     * @param {Function} [callback] Passed the tokens if successful
+     * @returns {Promise<TokentInfo>} Promise resolving to the token info
+     */
+    getAppUserTokens(userID: string, options?: TokenRequestOptions | Function | null, callback?: Function): import("bluebird")<any>;
+    /**
+     * Revokes a token pair associated with a given access or refresh token.
+     *
+     * @param {string} token - A valid access or refresh token to revoke
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
+     * @param {Function} [callback] - If err, revoke failed. Otherwise, revoke succeeded.
+     * @returns {Promise<TokenInfo>} Promise resolving to the token info
+     */
+    revokeTokens(token: string, options?: TokenRequestOptions | Function | null, callback?: Function): import("bluebird")<unknown>;
+}
+/** @module box-node-sdk/lib/box-node-sdk */
+export = BoxSDKNode;

package/lib-esm/box-node-sdk.js

@@ -0,0 +1,373 @@
+"use strict";
+/**
+ * @fileoverview Box SDK for Node.js
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+const events_1 = require("events");
+const qs = __importStar(require("querystring"));
+const CCGAPISession = require("./sessions/ccg-session");
+const APIRequestManager = require("./api-request-manager");
+const BoxClient = require("./box-client");
+const TokenManager = require("./token-manager");
+const Config = require('./util/config'), BasicAPISession = require('./sessions/basic-session'), PersistentAPISession = require('./sessions/persistent-session'), AppAuthSession = require('./sessions/app-auth-session'), Webhooks = require('./managers/webhooks');
+// ------------------------------------------------------------------------------
+// Private
+// ------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
+// Public
+// ------------------------------------------------------------------------------
+/**
+ * A backend NodeJS SDK to interact with the Box V2 API.
+ * This is the single entry point for all SDK consumer interactions. This is the only file that a 3rd party app
+ * should require. All other components are private and reached out to via this component.
+ * 1. Provides getters to spawn client instances for users to interact with the Box API.
+ * 2. Provides manual capability to acquire tokens via token grant endpoints.
+ *    However, it is recommended to use clients to do this for you.
+ * 3. Emits notification events about relevant request/response events. Useful for logging Box API interactions.
+ *    Notification events: request retries, exceeding max retries, permanent failures.
+ *
+ * @param {UserConfigurationOptions} params User settings used to initialize and customize the SDK
+ * @constructor
+ */
+class BoxSDKNode extends events_1.EventEmitter {
+    constructor(params) {
+        super();
+        const eventBus = new events_1.EventEmitter();
+        const self = this;
+        eventBus.on('response', function () {
+            const args /* FIXME */ = [].slice.call(arguments);
+            args.unshift('response');
+            self.emit.apply(self, args);
+        });
+        // Setup the configuration with the given params
+        this.config = new Config(params);
+        this._eventBus = eventBus;
+        this._setup();
+    }
+    /**
+     * Setup the SDK instance by instantiating necessary objects with current
+     * configuration values.
+     *
+     * @returns {void}
+     * @private
+     */
+    _setup() {
+        // Instantiate the request manager
+        this.requestManager = new APIRequestManager(this.config, this._eventBus);
+        // Initialize the rest of the SDK with the given configuration
+        this.tokenManager = new TokenManager(this.config, this.requestManager);
+        this.ccgSession = new CCGAPISession(this.config, this.tokenManager);
+    }
+    /**
+     * Gets the BoxSDKNode instance by passing boxAppSettings json downloaded from the developer console.
+     *
+     * @param {Object} appConfig boxAppSettings object retrieved from Dev Console.
+     * @returns {BoxSDKNode} an instance that has been preconfigured with the values from the Dev Console
+     */
+    static getPreconfiguredInstance(appConfig /* FIXME */) {
+        if (typeof appConfig.boxAppSettings !== 'object') {
+            throw new TypeError('Configuration does not include boxAppSettings object.');
+        }
+        const boxAppSettings = appConfig.boxAppSettings;
+        const webhooks = appConfig.webhooks;
+        if (typeof webhooks === 'object') {
+            Webhooks.setSignatureKeys(webhooks.primaryKey, webhooks.secondaryKey);
+        }
+        const params = {};
+        if (typeof boxAppSettings.clientID === 'string') {
+            params.clientID = boxAppSettings.clientID;
+        }
+        if (typeof boxAppSettings.clientSecret === 'string') {
+            params.clientSecret = boxAppSettings.clientSecret;
+        }
+        // Only try to assign app auth settings if they are present
+        // Some configurations do not include them (but might include other info, e.g. webhooks)
+        if (typeof boxAppSettings.appAuth === 'object' &&
+            boxAppSettings.appAuth.publicKeyID) {
+            params.appAuth = {
+                keyID: boxAppSettings.appAuth.publicKeyID, // Assign publicKeyID to keyID
+                privateKey: boxAppSettings.appAuth.privateKey,
+            };
+            const passphrase = boxAppSettings.appAuth.passphrase;
+            if (typeof passphrase === 'string') {
+                params.appAuth.passphrase = passphrase;
+            }
+        }
+        if (typeof appConfig.enterpriseID === 'string') {
+            params.enterpriseID = appConfig.enterpriseID;
+        }
+        return new BoxSDKNode(params);
+    }
+    /**
+     * Updates the SDK configuration with new parameters.
+     *
+     * @param {UserConfigurationOptions} params User settings
+     * @returns {void}
+     */
+    configure(params) {
+        this.config = this.config.extend(params);
+        this._setup();
+    }
+    /**
+     * Returns a Box Client with a Basic API Session. The client is able to make requests on behalf of a user.
+     * A basic session has no access to a user's refresh token. Because of this, once the session's tokens
+     * expire the client cannot recover and a new session will need to be generated.
+     *
+     * @param {string} accessToken A user's Box API access token
+     * @returns {BoxClient} Returns a new Box Client paired to a new BasicAPISession
+     */
+    getBasicClient(accessToken) {
+        const apiSession = new BasicAPISession(accessToken, this.tokenManager);
+        return new BoxClient(apiSession, this.config, this.requestManager);
+    }
+    /**
+     * Returns a Box Client with a Basic API Session. The client is able to make requests on behalf of a user.
+     * A basic session has no access to a user's refresh token. Because of this, once the session's tokens
+     * expire the client cannot recover and a new session will need to be generated.
+     *
+     * @param {string} accessToken A user's Box API access token
+     * @returns {BoxClient} Returns a new Box Client paired to a new BasicAPISession
+     */
+    static getBasicClient(accessToken) {
+        return new BoxSDKNode({
+            clientID: '',
+            clientSecret: '',
+        }).getBasicClient(accessToken);
+    }
+    /**
+     * Returns a Box Client with a persistent API session. A persistent API session helps manage the user's tokens,
+     * and can refresh them automatically if the access token expires. If a central data-store is given, the session
+     * can read & write tokens to it.
+     *
+     * NOTE: If tokenInfo or tokenStore are formatted incorrectly, this method will throw an error. If you
+     * haven't explicitly created either of these objects or are otherwise not completly confident in their validity,
+     * you should wrap your call to getPersistentClient in a try-catch to handle any potential errors.
+     *
+     * @param {TokenInfo} tokenInfo A tokenInfo object to use for authentication
+     * @param {TokenStore} [tokenStore] An optional token store for reading/writing tokens to session
+     * @returns {BoxClient} Returns a new Box Client paired to a new PersistentAPISession
+     */
+    getPersistentClient(tokenInfo /* FIXME */, tokenStore) {
+        const apiSession = new PersistentAPISession(tokenInfo, tokenStore, this.config, this.tokenManager);
+        return new BoxClient(apiSession, this.config, this.requestManager);
+    }
+    /**
+     * Returns a Box Client configured to use Client Credentials Grant for a service account. Requires enterprise ID
+     * to be set when configuring SDK instance.
+     *
+     * @returns {BoxClient} Returns a new Box Client paired to a AnonymousAPISession. All Anonymous API Sessions share the
+     * same tokens, which allows them to refresh them efficiently and reduce load on both the application and
+     * the API.
+     */
+    getAnonymousClient() {
+        if (!this.config.enterpriseID) {
+            throw new Error('Enterprise ID must be passed');
+        }
+        return this._getCCGClient({
+            boxSubjectType: 'enterprise',
+            boxSubjectId: this.config.enterpriseID,
+        });
+    }
+    /**
+     * Returns a Box Client configured to use Client Credentials Grant for a specified user.
+     *
+     * @param userId the user ID to use when getting the access token
+     * @returns {BoxClient} Returns a new Box Client paired to a AnonymousAPISession. All Anonymous API Sessions share the
+     * same tokens, which allows them to refresh them efficiently and reduce load on both the application and
+     * the API.
+     */
+    getCCGClientForUser(userId) {
+        return this._getCCGClient({
+            boxSubjectType: 'user',
+            boxSubjectId: userId,
+        });
+    }
+    _getCCGClient(config) {
+        const anonymousTokenManager = new TokenManager({
+            ...this.config,
+            ...config,
+        }, this.requestManager);
+        const newAnonymousSession = new CCGAPISession(this.config, anonymousTokenManager);
+        return new BoxClient(newAnonymousSession, this.config, this.requestManager);
+    }
+    /**
+     * Create a new client using App Auth for the given entity. This allows either
+     * managing App Users (as the enterprise) or performing operations as the App
+     * Users or Managed Users themselves (as a user).
+     *
+     * @param {string} type The type of entity to operate as, "enterprise" or "user"
+     * @param {string} [id] (Optional) The Box ID of the entity to operate as
+     * @param {TokenStore} [tokenStore] (Optional) the token store to use for caching tokens
+     * @returns {BoxClient} A new client authorized as the app user or enterprise
+     */
+    getAppAuthClient(type, id, tokenStore) {
+        if (type === 'enterprise' && !id) {
+            if (this.config.enterpriseID) {
+                id = this.config.enterpriseID;
+            }
+            else {
+                throw new Error('Enterprise ID must be passed');
+            }
+        }
+        const appAuthSession = new AppAuthSession(type, id, this.config, this.tokenManager, tokenStore);
+        return new BoxClient(appAuthSession, this.config, this.requestManager);
+    }
+    /**
+     * Generate the URL for the authorize page to send users to for the first leg of
+     * the OAuth2 flow.
+     *
+     * @param {Object} params The OAuth2 parameters
+     * @returns {string} The authorize page URL
+     */
+    getAuthorizeURL(params) {
+        params.client_id = this.config.clientID;
+        return `${this.config.authorizeRootURL}/oauth2/authorize?${qs.stringify(params)}`;
+    }
+    /**
+     * Acquires token info using an authorization code
+     *
+     * @param {string} authorizationCode - authorization code issued by Box
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
+     * @param {Function} [callback] - passed a TokenInfo object if tokens were granted successfully
+     * @returns {Promise<TokenInfo>} Promise resolving to the token info
+     */
+    getTokensAuthorizationCodeGrant(authorizationCode, options, callback) {
+        return this.tokenManager
+            .getTokensAuthorizationCodeGrant(authorizationCode, options /* FIXME */)
+            .asCallback(callback);
+    }
+    /**
+     * Refreshes the access and refresh tokens for a given refresh token.
+     *
+     * @param {string} refreshToken - A valid OAuth refresh token
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
+     * @param {Function} [callback] - passed a TokenInfo object if tokens were granted successfully
+     * @returns {Promise<TokenInfo>} Promise resolving to the token info
+     */
+    getTokensRefreshGrant(refreshToken, options, callback) {
+        if (typeof options === 'function') {
+            callback = options;
+            options = null;
+        }
+        return this.tokenManager
+            .getTokensRefreshGrant(refreshToken, options /* FIXME */)
+            .asCallback(callback);
+    }
+    /**
+     * Gets tokens for enterprise administration of app users
+     * @param {string} enterpriseID The ID of the enterprise to generate a token for
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
+     * @param {Function} [callback] Passed the tokens if successful
+     * @returns {Promise<TokenInfo>} Promise resolving to the token info
+     */
+    getEnterpriseAppAuthTokens(enterpriseID, options, callback) {
+        if (typeof options === 'function') {
+            callback = options;
+            options = null;
+        }
+        if (!enterpriseID) {
+            if (this.config.enterpriseID) {
+                enterpriseID = this.config.enterpriseID;
+            }
+            else {
+                throw new Error('Enterprise id must be passed');
+            }
+        }
+        return this.tokenManager
+            .getTokensJWTGrant('enterprise', enterpriseID, options /* FIXME */)
+            .asCallback(callback);
+    }
+    /**
+     * Gets tokens for App Users via a JWT grant
+     * @param {string} userID The ID of the App User to generate a token for
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
+     * @param {Function} [callback] Passed the tokens if successful
+     * @returns {Promise<TokentInfo>} Promise resolving to the token info
+     */
+    getAppUserTokens(userID, options, callback) {
+        if (typeof options === 'function') {
+            callback = options;
+            options = null;
+        }
+        return this.tokenManager
+            .getTokensJWTGrant('user', userID, options /* FIXME */)
+            .asCallback(callback);
+    }
+    /**
+     * Revokes a token pair associated with a given access or refresh token.
+     *
+     * @param {string} token - A valid access or refresh token to revoke
+     * @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
+     * @param {Function} [callback] - If err, revoke failed. Otherwise, revoke succeeded.
+     * @returns {Promise<TokenInfo>} Promise resolving to the token info
+     */
+    revokeTokens(token, options, callback) {
+        if (typeof options === 'function') {
+            callback = options;
+            options = null;
+        }
+        return this.tokenManager
+            .revokeTokens(token, options /* FIXME */)
+            .asCallback(callback);
+    }
+}
+/**
+ * Expose the BoxClient property enumerations to the SDK as a whole. This allows
+ * the consumer to access and use these values from anywhere in their application
+ * (like a helper) by requiring the SDK, instead of needing to pass the client.
+ */
+BoxSDKNode.accessLevels = BoxSDKNode.prototype.accessLevels;
+BoxSDKNode.collaborationRoles = BoxSDKNode.prototype.collaborationRoles;
+BoxSDKNode.CURRENT_USER_ID = BoxSDKNode.prototype.CURRENT_USER_ID;
+/**
+ * Expose Webhooks.validateMessage() to the SDK as a whole. This allows
+ * the consumer to call BoxSDK.validateWebhookMessage() by just requiring the SDK,
+ * instead of needing to create a client (which is not needed to validate messages).
+ */
+BoxSDKNode.validateWebhookMessage = Webhooks.validateMessage;
+/**
+ * Expose the BoxClient property enumerations to the SDK as a whole. This allows
+ * the consumer to access and use these values from anywhere in their application
+ * (like a helper) by requiring the SDK, instead of needing to pass the client.
+ */
+BoxSDKNode.prototype.accessLevels = BoxClient.prototype.accessLevels;
+BoxSDKNode.prototype.collaborationRoles =
+    BoxClient.prototype.collaborationRoles;
+BoxSDKNode.prototype.CURRENT_USER_ID = BoxClient.prototype.CURRENT_USER_ID;
+module.exports = BoxSDKNode;
+//# sourceMappingURL=box-node-sdk.js.map

package/lib-esm/box-node-sdk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"box-node-sdk.js","sourceRoot":"","sources":["../src/box-node-sdk.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AAEjF,mCAAsC;AACtC,gDAAkC;AAClC,wDAAyD;AACzD,2DAA4D;AAC5D,0CAA2C;AAC3C,gDAAiD;AAEjD,MAAM,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,EACrC,eAAe,GAAG,OAAO,CAAC,0BAA0B,CAAC,EACrD,oBAAoB,GAAG,OAAO,CAAC,+BAA+B,CAAC,EAC/D,cAAc,GAAG,OAAO,CAAC,6BAA6B,CAAC,EACvD,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;AA2C5C,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;;;;;;;GAYG;AACH,MAAM,UAAW,SAAQ,qBAAY;IA2BnC,YAAY,MAAgC;QAC1C,KAAK,EAAE,CAAC;QAER,MAAM,QAAQ,GAAG,IAAI,qBAAY,EAAE,CAAC;QAEpC,MAAM,IAAI,GAAG,IAAI,CAAC;QAClB,QAAQ,CAAC,EAAE,CAAC,UAAU,EAAE;YACtB,MAAM,IAAI,CAAM,WAAW,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACvD,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,gDAAgD;QAChD,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACH,MAAM;QACJ,kCAAkC;QAClC,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAEzE,8DAA8D;QAC9D,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QACvE,IAAI,CAAC,UAAU,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,wBAAwB,CAAC,SAAc,CAAC,WAAW;QACxD,IAAI,OAAO,SAAS,CAAC,cAAc,KAAK,QAAQ,EAAE,CAAC;YACjD,MAAM,IAAI,SAAS,CACjB,uDAAuD,CACxD,CAAC;QACJ,CAAC;QAED,MAAM,cAAc,GAAG,SAAS,CAAC,cAAc,CAAC;QAChD,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;QACpC,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;QACxE,CAAC;QAED,MAAM,MAAM,GASR,EAAE,CAAC;QAEP,IAAI,OAAO,cAAc,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAChD,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;QAC5C,CAAC;QAED,IAAI,OAAO,cAAc,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;YACpD,MAAM,CAAC,YAAY,GAAG,cAAc,CAAC,YAAY,CAAC;QACpD,CAAC;QAED,2DAA2D;QAC3D,wFAAwF;QACxF,IACE,OAAO,cAAc,CAAC,OAAO,KAAK,QAAQ;YAC1C,cAAc,CAAC,OAAO,CAAC,WAAW,EAClC,CAAC;YACD,MAAM,CAAC,OAAO,GAAG;gBACf,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,WAAW,EAAE,8BAA8B;gBACzE,UAAU,EAAE,cAAc,CAAC,OAAO,CAAC,UAAU;aAC9C,CAAC;YAEF,MAAM,UAAU,GAAG,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC;YACrD,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;gBACnC,MAAM,CAAC,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;YACzC,CAAC;QACH,CAAC;QAED,IAAI,OAAO,SAAS,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;YAC/C,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC;QAC/C,CAAC;QAED,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,MAAgC;QACxC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,WAAmB;QAChC,MAAM,UAAU,GAAG,IAAI,eAAe,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACvE,OAAO,IAAI,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,cAAc,CAAC,WAAmB;QACvC,OAAO,IAAI,UAAU,CAAC;YACpB,QAAQ,EAAE,EAAE;YACZ,YAAY,EAAE,EAAE;SACjB,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,SAAc,CAAC,WAAW,EAAE,UAAuB;QACrE,MAAM,UAAU,GAAG,IAAI,oBAAoB,CACzC,SAAS,EACT,UAAU,EACV,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,CAClB,CAAC;QACF,OAAO,IAAI,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;OAOG;IACH,kBAAkB;QAChB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,IAAI,CAAC,aAAa,CAAC;YACxB,cAAc,EAAE,YAAY;YAC5B,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY;SACvC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,mBAAmB,CAAC,MAAc;QAChC,OAAO,IAAI,CAAC,aAAa,CAAC;YACxB,cAAc,EAAE,MAAM;YACtB,YAAY,EAAE,MAAM;SACrB,CAAC,CAAC;IACL,CAAC;IAED,aAAa,CAAC,MAAiB;QAC7B,MAAM,qBAAqB,GAAG,IAAI,YAAY,CAC5C;YACE,GAAG,IAAI,CAAC,MAAM;YACd,GAAG,MAAM;SACV,EACD,IAAI,CAAC,cAAc,CACpB,CAAC;QACF,MAAM,mBAAmB,GAAG,IAAI,aAAa,CAC3C,IAAI,CAAC,MAAM,EACX,qBAAqB,CACtB,CAAC;QACF,OAAO,IAAI,SAAS,CAAC,mBAAmB,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CAAC,IAAY,EAAE,EAAW,EAAE,UAAuB;QACjE,IAAI,IAAI,KAAK,YAAY,IAAI,CAAC,EAAE,EAAE,CAAC;YACjC,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;gBAC7B,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YAChC,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;YAClD,CAAC;QACH,CAAC;QAED,MAAM,cAAc,GAAG,IAAI,cAAc,CACvC,IAAI,EACJ,EAAE,EACF,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,EACjB,UAAU,CACX,CAAC;QACF,OAAO,IAAI,SAAS,CAAC,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CAAC,MAA8B;QAC5C,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAExC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,qBAAqB,EAAE,CAAC,SAAS,CACrE,MAAM,CACP,EAAE,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACH,+BAA+B,CAC7B,iBAAyB,EACzB,OAAoC,EACpC,QAAmB;QAEnB,OAAO,IAAI,CAAC,YAAY;aACrB,+BAA+B,CAC9B,iBAAiB,EACjB,OAAc,CAAC,WAAW,CAC3B;aACA,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;;OAOG;IACH,qBAAqB,CACnB,YAAoB,EACpB,OAA+C,EAC/C,QAAmB;QAEnB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;QAED,OAAO,IAAI,CAAC,YAAY;aACrB,qBAAqB,CAAC,YAAY,EAAE,OAAc,CAAC,WAAW,CAAC;aAC/D,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACH,0BAA0B,CACxB,YAAoB,EACpB,OAA+C,EAC/C,QAAmB;QAEnB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;QAED,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;gBAC7B,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YAC1C,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;YAClD,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,YAAY;aACrB,iBAAiB,CAAC,YAAY,EAAE,YAAY,EAAE,OAAc,CAAC,WAAW,CAAC;aACzE,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CACd,MAAc,EACd,OAA+C,EAC/C,QAAmB;QAEnB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;QAED,OAAO,IAAI,CAAC,YAAY;aACrB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAc,CAAC,WAAW,CAAC;aAC7D,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CACV,KAAa,EACb,OAA+C,EAC/C,QAAmB;QAEnB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;QAED,OAAO,IAAI,CAAC,YAAY;aACrB,YAAY,CAAC,KAAK,EAAE,OAAc,CAAC,WAAW,CAAC;aAC/C,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;;AA/XD;;;;GAIG;AACI,uBAAY,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;AACjD,6BAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC;AAC7D,0BAAe,GAAG,UAAU,CAAC,SAAS,CAAC,eAAe,CAAC;AAE9D;;;;GAIG;AACI,iCAAsB,GAAG,QAAQ,CAAC,eAAe,CAAC;AAoX3D;;;;GAIG;AACH,UAAU,CAAC,SAAS,CAAC,YAAY,GAAG,SAAS,CAAC,SAAS,CAAC,YAAY,CAAC;AACrE,UAAU,CAAC,SAAS,CAAC,kBAAkB;IACrC,SAAS,CAAC,SAAS,CAAC,kBAAkB,CAAC;AACzC,UAAU,CAAC,SAAS,CAAC,eAAe,GAAG,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC;AAG3E,iBAAS,UAAU,CAAC"}