box-node-sdk 3.8.0 → 3.8.2

package/lib-esm/schemas/sign-templates.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sign-templates.generated.js","sourceRoot":"","sources":["../../src/schemas/sign-templates.generated.ts"],"names":[],"mappings":""}

package/lib-esm/schemas/template-signer-input.generated.d.ts

@@ -0,0 +1,61 @@
+import * as schemas from '.';
+/**
+ * Template Signer Input
+ *
+ * Input created by a Signer on a Template
+ */
+export interface TemplateSignerInput extends schemas.SignRequestPrefillTag {
+    /**
+     * Type of input
+     * Example: text
+     */
+    type?: 'signature' | 'date' | 'text' | 'checkbox' | 'attachment' | 'radio' | 'dropdown';
+    /**
+     * Content type of input
+     * Example: text
+     */
+    content_type?: 'signature' | 'initial' | 'stamp' | 'date' | 'checkbox' | 'text' | 'full_name' | 'first_name' | 'last_name' | 'company' | 'title' | 'email' | 'attachment' | 'radio' | 'dropdown';
+    /**
+     * Whether or not the input is required.
+     * Example: true
+     */
+    is_required?: boolean;
+    /**
+     * Index of page that the input is on.
+     * Example: 4
+     */
+    page_index: number;
+    /**
+     * Document identifier.
+     * Example: 123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7
+     */
+    document_id?: string;
+    /**
+     * When the input is of the type `dropdown` this values will be filled with all the dropdown options.
+     * Example: Yes,No,Maybe
+     */
+    dropdown_choices?: string[];
+    /**
+     * When the input is of type `radio` they can be grouped to gather with this identifier.
+     * Example: da317330-225a-4c72-89ad-0d6dcaaf4df6
+     */
+    group_id?: string;
+    /**
+     * Where the input is located on a page.
+     */
+    coordinates?: object;
+    /**
+     * The size of the input.
+     */
+    dimensions?: object;
+    /**
+     * The label field is used especially for text, attachment, radio, and checkbox type inputs.
+     * Example: Legal name
+     */
+    label?: string;
+    /**
+     * Whether this input was defined as read-only(immutable by signers) or not
+     * Example: true
+     */
+    read_only?: boolean;
+}

package/lib-esm/schemas/template-signer-input.generated.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=template-signer-input.generated.js.map

package/lib-esm/schemas/template-signer-input.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-signer-input.generated.js","sourceRoot":"","sources":["../../src/schemas/template-signer-input.generated.ts"],"names":[],"mappings":""}

package/lib-esm/schemas/template-signer.generated.d.ts

@@ -0,0 +1,43 @@
+import * as schemas from '.';
+/**
+ * Signer fields for Templates
+ *
+ * The schema for a Signer for Templates
+ */
+export interface TemplateSigner {
+    inputs?: schemas.TemplateSignerInput[];
+    /**
+     * Email address of the signer
+     * Example: example@mail.com
+     */
+    email?: string;
+    /**
+     * Defines the role of the signer in the signature request. A role of
+     * `signer` needs to sign the document, a role `approver`
+     * approves the document and
+     * a `final_copy_reader` role only
+     * receives the final signed document and signing log.
+     * Example: signer
+     * @default signer
+     */
+    role?: 'signer' | 'approver' | 'final_copy_reader';
+    /**
+     * Used in combination with an embed URL for a sender.
+     * After the sender signs, they will be
+     * redirected to the next `in_person` signer.
+     * Example: true
+     */
+    is_in_person?: boolean;
+    /**
+     * Order of the signer
+     * Example: 2
+     */
+    order?: number;
+    /**
+     * If provided, this value points signers that are assigned the same inputs and belongs to same signer group.
+     * A signer group is not a Box Group. It is an entity that belongs to the template itself and can only be used
+     * within Box Sign requests created from it.
+     * Example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7
+     */
+    signer_group_id?: string;
+}

package/lib-esm/schemas/template-signer.generated.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=template-signer.generated.js.map

package/lib-esm/schemas/template-signer.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-signer.generated.js","sourceRoot":"","sources":["../../src/schemas/template-signer.generated.ts"],"names":[],"mappings":""}

package/lib-esm/schemas/user-base.generated.d.ts

@@ -0,0 +1,18 @@
+/**
+ * User (Base)
+ *
+ * A mini representation of a user, used when
+ * nested within another resource.
+ */
+export interface UserBase {
+    /**
+     * The unique identifier for this user
+     * Example: 11446498
+     */
+    id: string;
+    /**
+     * `user`
+     * Example: user
+     */
+    type: 'user';
+}

package/lib-esm/schemas/user-base.generated.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=user-base.generated.js.map

package/lib-esm/schemas/user-base.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-base.generated.js","sourceRoot":"","sources":["../../src/schemas/user-base.generated.ts"],"names":[],"mappings":""}

package/lib-esm/schemas/user-integration-mappings.d.ts

@@ -0,0 +1,19 @@
+import * as schemas from '.';
+/**
+ * User (Integration Mappings)
+ *
+ * A user representation for integration mappings
+ * API purposes. Fields name and login are not required.
+ */
+export interface UserIntegrationMappings extends schemas.UserBase {
+    /**
+     * The display name of this user
+     * Example: Aaron Levie
+     */
+    name?: string;
+    /**
+     * The primary email address of this user
+     * Example: ceo@example.com
+     */
+    login?: string;
+}

package/lib-esm/schemas/user-integration-mappings.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=user-integration-mappings.js.map

package/lib-esm/schemas/user-integration-mappings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-integration-mappings.js","sourceRoot":"","sources":["../../src/schemas/user-integration-mappings.ts"],"names":[],"mappings":""}

package/lib-esm/schemas/user-mini.d.ts

@@ -0,0 +1,6 @@
+export interface UserMini {
+    id: string;
+    type: string;
+    login: string;
+    name: string;
+}

package/lib-esm/schemas/user-mini.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=user-mini.js.map

package/lib-esm/schemas/user-mini.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-mini.js","sourceRoot":"","sources":["../../src/schemas/user-mini.ts"],"names":[],"mappings":""}

package/lib-esm/sessions/app-auth-session.d.ts

@@ -0,0 +1,92 @@
+/**
+ * @fileoverview App Auth Box API Session.
+ */
+type Config = any;
+type TokenManager = any;
+type TokenStore = any;
+type TokenInfo = any;
+type TokenRequestOptions = any;
+/**
+ * App Auth Box API Session.
+ *
+ * The App Auth API Session holds an accessToken for an app user or enterprise,
+ * which it returns to the client so that it may make calls on behalf of
+ * these entities.
+ *
+ * These access tokens will be refreshed in the background if a request is made within the
+ * "stale buffer" (defaults to 10 minutes before the token is set to expire).
+ * If the token is also expired, all incoming requests will be held until a fresh token
+ * is retrieved.
+ *
+ * @param {string} type The type of the entity to authenticate the app auth session as, "user" or "enterprise"
+ * @param {string} id The Box ID of the entity to authenticate as
+ * @param {Config} config The SDK configuration options
+ * @param {TokenManager} tokenManager The TokenManager
+ * @param {TokenStore} [tokenStore] The token store instance to use for caching token info
+ * @constructor
+ */
+declare class AppAuthSession {
+    _type: string;
+    _id: string;
+    _config: Config;
+    _tokenManager: TokenManager;
+    _tokenStore: TokenStore | null;
+    _tokenInfo: TokenInfo;
+    _refreshPromise: Promise<any> | null;
+    constructor(type: string, id: string, config: Config, tokenManager: TokenManager, tokenStore?: TokenStore);
+    /**
+     * 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
+     */
+    _refreshAppAuthAccessToken(options?: TokenRequestOptions): Promise<any> | null;
+    /**
+     * 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
+     */
+    getAccessToken(options?: TokenRequestOptions): any;
+    /**
+     * 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
+     */
+    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;
+    /**
+     * 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/app-auth-session
+ * @see {@Link AppAuthSession}
+ */
+export = AppAuthSession;

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

@@ -0,0 +1,176 @@
+"use strict";
+/**
+ * @fileoverview App Auth Box API Session.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+const assert_1 = __importDefault(require("assert"));
+const bluebird_1 = require("bluebird");
+const errors_1 = __importDefault(require("../util/errors"));
+// ------------------------------------------------------------------------------
+// Private
+// ------------------------------------------------------------------------------
+/**
+ * Validate that an object is a valid TokenStore object
+ *
+ * @param {Object} obj the object to validate
+ * @returns {boolean} returns true if the passed in object is a valid TokenStore object that
+ * has all the expected properties. false otherwise.
+ * @private
+ */
+function isObjectValidTokenStore(obj) {
+    return Boolean(obj && obj.read && obj.write && obj.clear);
+}
+// ------------------------------------------------------------------------------
+// Public
+// ------------------------------------------------------------------------------
+/**
+ * App Auth Box API Session.
+ *
+ * The App Auth API Session holds an accessToken for an app user or enterprise,
+ * which it returns to the client so that it may make calls on behalf of
+ * these entities.
+ *
+ * These access tokens will be refreshed in the background if a request is made within the
+ * "stale buffer" (defaults to 10 minutes before the token is set to expire).
+ * If the token is also expired, all incoming requests will be held until a fresh token
+ * is retrieved.
+ *
+ * @param {string} type The type of the entity to authenticate the app auth session as, "user" or "enterprise"
+ * @param {string} id The Box ID of the entity to authenticate as
+ * @param {Config} config The SDK configuration options
+ * @param {TokenManager} tokenManager The TokenManager
+ * @param {TokenStore} [tokenStore] The token store instance to use for caching token info
+ * @constructor
+ */
+class AppAuthSession {
+    constructor(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) {
+            (0, 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
+     */
+    _refreshAppAuthAccessToken(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
+     */
+    getAccessToken(options) {
+        var expirationBuffer = this._config.expiredBufferMS;
+        // 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 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
+     */
+    revokeTokens(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
+     */
+    exchangeToken(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.
+     */
+    handleExpiredTokensError(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((e) => errors_1.default.unwrapAndThrow(e))
+            .then(() => {
+            throw err;
+        });
+    }
+}
+module.exports = AppAuthSession;
+//# sourceMappingURL=app-auth-session.js.map

package/lib-esm/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,oDAA4B;AAC5B,uCAAmC;AACnC,4DAAoC;AAYpC,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF;;;;;;;GAOG;AACH,SAAS,uBAAuB,CAAC,GAAwB;IACvD,OAAO,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;AAC5D,CAAC;AAED,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,cAAc;IASlB,YACE,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,CAAC;YACf,IAAA,gBAAM,EACJ,uBAAuB,CAAC,UAAU,CAAC,EACnC,2FAA2F,CAC5F,CAAC;YACF,IAAI,CAAC,WAAW,GAAG,kBAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QACtD,CAAC;QAED,iDAAiD;QACjD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvB,oDAAoD;QACpD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACH,0BAA0B,CAAC,OAA6B;QACtD,8DAA8D;QAC9D,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1B,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,aAAa;iBACtC,iBAAiB,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC;iBAChD,IAAI,CAAC,CAAC,SAAoB,EAAE,EAAE;gBAC7B,wDAAwD;gBACxD,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;gBAE5B,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;oBACrB,OAAO,IAAI,CAAC,WAAW;yBACpB,UAAU,CAAC,SAAS,CAAC;yBACrB,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;gBACvC,CAAC;gBAED,OAAO,SAAS,CAAC,WAAW,CAAC;YAC/B,CAAC,CAAC;iBACD,OAAO,CAAC,GAAG,EAAE;gBACZ,kCAAkC;gBAClC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;YAC9B,CAAC,CAAC,CAAC;QACP,CAAC;QAED,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;;;;;;OAQG;IACH,cAAc,CAAC,OAA6B;QAC1C,IAAI,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC;QAEpD,+EAA+E;QAC/E,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACzC,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,CAAC,SAAoB,EAAE,EAAE;gBAChE,IACE,CAAC,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,SAAS,EAAE,gBAAgB,CAAC,EACnE,CAAC;oBACD,+CAA+C;oBAC/C,OAAO,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;gBAClD,CAAC;gBAED,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;gBAC5B,OAAO,SAAS,CAAC,WAAW,CAAC;YAC/B,CAAC,CAAC,CAAC;QACL,CAAC;QAED,mEAAmE;QACnE,0DAA0D;QAC1D,IACE,CAAC,IAAI,CAAC,UAAU;YAChB,CAAC,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,EACzE,CAAC;YACD,OAAO,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;QAClD,CAAC;QAED,sEAAsE;QACtE,OAAO,kBAAO,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,OAA4B;QACvC,iGAAiG;QACjG,IAAI,SAAS,GAAG,IAAI,CAAC,UAAU,IAAI,EAAE,EACnC,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa,CACX,MAAyB,EACzB,QAAiB,EACjB,OAGC;QAED,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,WAAmB,EAAE,EAAE,CAC/D,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CACzE,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,wBAAwB,CAAC,GAAQ,CAAC,WAAW;QAC3C,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,OAAO,kBAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC9B,CAAC;QAED,wEAAwE;QACxE,0DAA0D;QAC1D,OAAO,IAAI,CAAC,WAAW;aACpB,UAAU,EAAE;aACZ,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,gBAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;aAC3C,IAAI,CAAC,GAAG,EAAE;YACT,MAAM,GAAG,CAAC;QACZ,CAAC,CAAC,CAAC;IACP,CAAC;CACF;AAMD,iBAAS,cAAc,CAAC"}

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

@@ -0,0 +1,55 @@
+/**
+ * @fileoverview A Basic Box API Session.
+ */
+type TokenManager = any;
+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-esm/sessions/basic-session.js

@@ -0,0 +1,62 @@
+"use strict";
+/**
+ * @fileoverview A Basic Box API Session.
+ */
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+const 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
+ * 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
+ */
+class BasicSession {
+    constructor(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
+     */
+    getAccessToken() {
+        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
+     */
+    revokeTokens(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
+     */
+    exchangeToken(scopes, resource, options) {
+        return this._tokenManager.exchangeToken(this._accessToken, scopes, resource, options);
+    }
+}
+module.exports = BasicSession;
+//# sourceMappingURL=basic-session.js.map

package/lib-esm/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,uCAAmC;AASnC,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;;;;;;;GAYG;AAEH,MAAM,YAAY;IAIhB,YAAY,WAAmB,EAAE,YAA0B;QACzD,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACH,cAAc;QACZ,OAAO,kBAAO,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,OAA6B;QACxC,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa,CACX,MAAyB,EACzB,QAAiB,EACjB,OAGC;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,aAAa,CACrC,IAAI,CAAC,YAAY,EACjB,MAAM,EACN,QAAQ,EACR,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAMD,iBAAS,YAAY,CAAC"}