@salesforce/core
Version:
Core libraries to interact with SFDX projects, orgs, and APIs.
201 lines • 20.6 kB
JavaScript
"use strict";
/*
* Copyright (c) 2020, salesforce.com, inc.
* All rights reserved.
* Licensed under the BSD 3-Clause license.
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
*/
/* eslint-disable camelcase */
/* eslint-disable @typescript-eslint/ban-types */
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.DeviceOauthService = void 0;
const transport_1 = __importDefault(require("@jsforce/jsforce-node/lib/transport"));
const kit_1 = require("@salesforce/kit");
const ts_types_1 = require("@salesforce/ts-types");
const form_data_1 = __importDefault(require("form-data"));
const logger_1 = require("./logger/logger");
const authInfo_1 = require("./org/authInfo");
const connection_1 = require("./org/connection");
const sfError_1 = require("./sfError");
const messages_1 = require("./messages");
;
const messages = new messages_1.Messages('@salesforce/core', 'auth', new Map([["targetOrgNotSet", "A default user is not set."], ["targetOrgNotSet.actions", ["Run the \"sfdx auth\" commands with --setdefaultusername to connect to an org and set it as your default org.", "Run \"force:org:create\" with --setdefaultusername to create a scratch org and set it as your default org.", "Run \"sfdx config:set defaultusername=<username>\" to set your default username."]], ["portInUse", "Cannot start the OAuth redirect server on port %s."], ["portInUse.actions", ["Kill the process running on port %s or use a custom connected app and update OauthLocalPort in the sfdx-project.json file."]], ["invalidRequestMethod", "Invalid request method: %s"], ["invalidRequestUri", "Invalid request uri: %s"], ["error.HttpApi", "HTTP response contains html content. Check that the org exists and can be reached."], ["pollingTimeout", "The device authorization request timed out. After executing force:auth:device:login, you must approve access to the device within 10 minutes. This can happen if the URL wasn\u2019t copied into the browser, login was not attempted, or the 2FA process was not completed within 10 minutes. Request authorization again."], ["serverErrorHTMLResponse", "<html><head><style>body {background-color:#F4F6F9; font-family: Arial, sans-serif; font-size: 0.8125rem; line-height: 1.5rem; color: #16325c;} #center {margin: auto; width: 370px; padding: 100px 0px 20px;} #logo-container {margin-left: auto; margin-right: auto; text-align: center;} #logo {max-width: 180px; max-height: 113px; margin-bottom: 2rem; border: 0;} #header {font-size: 1.5rem; text-align: center; margin-bottom: 1rem;} #message {background-color: #FFFFFF; margin: 0px auto; padding: 1.25rem; border-radius: 0.25rem; border: 1px solid #D8DDE6;} #footer {height: 24px; width: 370px; text-align: center; font-size: .75rem; position: absolute; bottom: 10;}</style></head><body><div id=\"center\"><div id=\"logo-container\"><img id=\"logo\" aria-hidden=\"true\" name=\"logo\" alt=\"Salesforce\" src=\"data:image/svg+xml;base64,%s\"></div><div id=\"header\">%s</div><div id=\"message\">%s<br/><br/>This is most likely <b>not</b> an error with the Salesforce CLI. Please ensure all information is accurate and try again.</div><div id=\"footer\">© %s Salesforce, Inc. All rights reserved.</div></div></body></html>"], ["missingAuthCode", "No authentication code found on login response."], ["serverSuccessHTMLResponse", "<html><head><style>body {background-color:#F4F6F9; font-family: Arial, sans-serif; font-size: 0.8125rem; line-height: 1.5rem; color: #16325c;} #center {margin: auto; width: 300px; padding: 100px 0px 20px;} #logo-container {margin-left: auto; margin-right: auto; text-align: center;} #logo {max-width: 180px; max-height: 113px; margin-bottom: 2rem; border: 0;} #header {font-size: 1.5rem; text-align: center; margin-bottom: 1rem;} #message {background-color: #FFFFFF; margin: 0px auto; padding: 1.25rem; border-radius: 0.25rem; border: 1px solid #D8DDE6;} #footer {height: 24px; width: 300px; text-align: center; font-size: .75rem; position: absolute; bottom: 10;}</style></head><body><div id=\"center\"><div id=\"logo-container\"><img id=\"logo\" aria-hidden=\"true\" name=\"logo\" alt=\"Salesforce\" src=\"data:image/svg+xml;base64,%s\"></div><div id=\"header\">Authentication Successful</div><div id=\"message\">You've successfully logged in. You can now close this browser tab or window.</div><div id=\"footer\">© %s Salesforce, Inc. All rights reserved.</div></div></body></html>"], ["serverSfdcImage", "<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 21.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
	 viewBox="0 0 262 184" style="enable-background:new 0 0 262 184;" xml:space="preserve">
<style type="text/css">
	.st0{fill:#00A1E0;}
	.st1{fill:#FFFFFF;}
</style>
<title>logo-salesforce</title>
<desc>Created with Sketch.</desc>
<g id="Test-B">
	<g id="Mobile-Nav---Test-B-_x28_0_x29_">
		<g id="Group">
			<g id="logo-salesforce">
				<path id="Fill-1" class="st0" d="M109.2,20.9c8.4-8.7,20.1-14.2,33-14.2c17.2,0,32.1,9.6,40.1,23.8c6.9-3.1,14.6-4.8,22.7-4.8
					c31,0,56,25.3,56,56.5s-25.1,56.5-56,56.5c-3.8,0-7.5-0.4-11-1.1c-7,12.5-20.4,21-35.8,21c-6.4,0-12.5-1.5-17.9-4.1
					c-7.1,16.7-23.7,28.5-43,28.5c-20.1,0-37.3-12.7-43.9-30.6c-2.9,0.6-5.9,0.9-8.9,0.9c-24,0-43.4-19.6-43.4-43.9
					c0-16.2,8.7-30.4,21.7-38c-2.7-6.1-4.2-12.9-4.2-20.1C18.5,23.6,41.2,1,69,1C85.4,1,100,8.8,109.2,20.9"/>
				<path id="Combined-Shape" class="st1" d="M38.7,95.4l1.1-2.9c0.2-0.5,0.5-0.3,0.7-0.2c0.3,0.2,0.5,0.3,0.9,0.6c3.1,2,6,2,6.9,2
					c2.3,0,3.8-1.2,3.8-2.9v-0.1c0-1.8-2.2-2.5-4.8-3.3l-0.6-0.2c-3.5-1-7.3-2.5-7.3-6.9v-0.1c0-4.2,3.4-7.2,8.3-7.2l0.5,0
					c2.9,0,5.6,0.8,7.6,2.1c0.2,0.1,0.4,0.3,0.3,0.6c-0.1,0.3-1,2.6-1.1,2.9c-0.2,0.5-0.7,0.2-0.7,0.2c-1.8-1-4.5-1.7-6.8-1.7
					c-2.1,0-3.4,1.1-3.4,2.6v0.1c0,1.7,2.3,2.5,4.9,3.3l0.5,0.1c3.5,1.1,7.2,2.6,7.2,6.9v0.1c0,4.6-3.3,7.4-8.6,7.4
					c-2.6,0-5.1-0.4-7.8-1.8c-0.5-0.3-1-0.5-1.5-0.9C38.7,95.9,38.5,95.8,38.7,95.4z M116.7,95.4l1.1-2.9c0.2-0.5,0.6-0.3,0.7-0.2
					c0.3,0.2,0.5,0.3,0.9,0.6c3.1,2,6,2,6.9,2c2.3,0,3.8-1.2,3.8-2.9v-0.1c0-1.8-2.2-2.5-4.8-3.3l-0.6-0.2c-3.5-1-7.3-2.5-7.3-6.9
					v-0.1c0-4.2,3.4-7.2,8.3-7.2l0.5,0c2.9,0,5.6,0.8,7.6,2.1c0.2,0.1,0.4,0.3,0.3,0.6c-0.1,0.3-1,2.6-1.1,2.9
					c-0.2,0.5-0.7,0.2-0.7,0.2c-1.8-1-4.5-1.7-6.8-1.7c-2.1,0-3.4,1.1-3.4,2.6v0.1c0,1.7,2.3,2.5,4.9,3.3l0.5,0.1
					c3.5,1.1,7.2,2.6,7.2,6.9v0.1c0,4.6-3.3,7.4-8.6,7.4c-2.6,0-5.1-0.4-7.8-1.8c-0.5-0.3-1-0.5-1.5-0.9
					C116.8,95.9,116.6,95.8,116.7,95.4z M174.5,81.7c0.4,1.5,0.7,3.1,0.7,4.8s-0.2,3.3-0.7,4.8c-0.4,1.5-1.1,2.8-2,3.9
					c-0.9,1.1-2.1,2-3.4,2.6c-1.4,0.6-3,0.9-4.8,0.9c-1.8,0-3.4-0.3-4.8-0.9c-1.4-0.6-2.5-1.5-3.4-2.6c-0.9-1.1-1.6-2.4-2-3.9
					c-0.4-1.5-0.7-3.1-0.7-4.8c0-1.7,0.2-3.3,0.7-4.8c0.4-1.5,1.1-2.8,2-3.9c0.9-1.1,2.1-2,3.4-2.6c1.4-0.6,3-1,4.8-1
					c1.8,0,3.4,0.3,4.8,1c1.4,0.6,2.5,1.5,3.4,2.6C173.4,78.9,174.1,80.2,174.5,81.7z M170,86.4c0-2.6-0.5-4.6-1.4-6
					c-0.9-1.4-2.4-2.1-4.3-2.1c-2,0-3.4,0.7-4.3,2.1c-0.9,1.4-1.4,3.4-1.4,6c0,2.6,0.5,4.6,1.4,6.1c0.9,1.4,2.3,2.1,4.3,2.1
					c2,0,3.4-0.7,4.3-2.1C169.6,91.1,170,89,170,86.4z M211.1,93.9l1.1,3c0.1,0.4-0.2,0.5-0.2,0.5c-1.7,0.7-4,1.1-6.3,1.1
					c-3.9,0-6.8-1.1-8.8-3.3c-2-2.2-3-5.2-3-8.9c0-1.7,0.2-3.3,0.7-4.8c0.5-1.5,1.2-2.8,2.2-3.9c1-1.1,2.2-2,3.6-2.6
					c1.4-0.6,3.1-1,5-1c1.3,0,2.4,0.1,3.3,0.2c1,0.2,2.4,0.5,3,0.8c0.1,0,0.4,0.2,0.3,0.5c-0.4,1.2-0.7,2-1.1,3
					c-0.2,0.5-0.5,0.3-0.5,0.3c-1.5-0.5-2.9-0.7-4.7-0.7c-2.2,0-3.9,0.7-4.9,2.2c-1.1,1.4-1.7,3.3-1.7,5.9c0,2.8,0.7,4.8,1.9,6.1
					c1.2,1.3,2.9,1.9,5.1,1.9c0.9,0,1.7-0.1,2.4-0.2c0.7-0.1,1.4-0.3,2.1-0.6C210.5,93.6,210.9,93.5,211.1,93.9z M233.8,80.8
					c1,3.4,0.5,6.3,0.4,6.5c0,0.4-0.4,0.4-0.4,0.4l-15.1,0c0.1,2.3,0.6,3.9,1.8,5c1.1,1.1,2.8,1.8,5.2,1.8c3.6,0,5.1-0.7,6.2-1.1
					c0,0,0.4-0.1,0.6,0.3l1,2.8c0.2,0.5,0,0.6-0.1,0.7c-0.9,0.5-3.2,1.5-7.6,1.5c-2.1,0-4-0.3-5.5-0.9c-1.5-0.6-2.8-1.4-3.8-2.5
					c-1-1.1-1.7-2.4-2.2-3.8c-0.5-1.5-0.7-3.1-0.7-4.8c0-1.7,0.2-3.3,0.7-4.8c0.4-1.5,1.1-2.8,2-3.9c0.9-1.1,2.1-2,3.5-2.6
					c1.4-0.7,3.1-1,5-1c1.6,0,3.1,0.3,4.3,0.9c0.9,0.4,1.9,1.1,2.9,2.2C232.5,77.9,233.4,79.4,233.8,80.8z M218.8,84h10.7
					c-0.1-1.4-0.4-2.6-1-3.6c-0.9-1.4-2.2-2.2-4.2-2.2c-2,0-3.4,0.8-4.3,2.2C219.4,81.3,219.1,82.5,218.8,84z M113.1,80.8
					c1,3.4,0.5,6.3,0.5,6.5c0,0.4-0.4,0.4-0.4,0.4l-15.1,0c0.1,2.3,0.6,3.9,1.8,5c1.1,1.1,2.8,1.8,5.2,1.8c3.6,0,5.1-0.7,6.2-1.1
					c0,0,0.4-0.1,0.6,0.3l1,2.8c0.2,0.5,0,0.6-0.1,0.7c-0.9,0.5-3.2,1.5-7.6,1.5c-2.1,0-4-0.3-5.5-0.9c-1.5-0.6-2.8-1.4-3.8-2.5
					c-1-1.1-1.7-2.4-2.2-3.8c-0.5-1.5-0.7-3.1-0.7-4.8c0-1.7,0.2-3.3,0.7-4.8c0.4-1.5,1.1-2.8,2-3.9c0.9-1.1,2.1-2,3.5-2.6
					c1.4-0.7,3.1-1,5-1c1.6,0,3.1,0.3,4.3,0.9c0.9,0.4,1.9,1.1,2.9,2.2C111.8,77.9,112.8,79.4,113.1,80.8z M98.1,84h10.8
					c-0.1-1.4-0.4-2.6-1-3.6c-0.9-1.4-2.2-2.2-4.2-2.2c-2,0-3.4,0.8-4.3,2.2C98.7,81.3,98.4,82.5,98.1,84z M71.6,83.2
					c0,0,1.2,0.1,2.5,0.3v-0.6c0-2-0.4-3-1.2-3.6c-0.8-0.6-2.1-1-3.7-1c0,0-3.7,0-6.6,1.5c-0.1,0.1-0.2,0.1-0.2,0.1
					s-0.4,0.1-0.5-0.2l-1.1-2.9c-0.2-0.4,0.1-0.6,0.1-0.6c1.4-1.1,4.6-1.7,4.6-1.7c1.1-0.2,2.9-0.4,4-0.4c3,0,5.3,0.7,6.9,2.1
					c1.6,1.4,2.4,3.6,2.4,6.7l0,13.8c0,0,0,0.4-0.3,0.5c0,0-0.6,0.2-1.1,0.3c-0.5,0.1-2.3,0.5-3.8,0.7c-1.5,0.3-3,0.4-4.6,0.4
					c-1.5,0-2.8-0.1-4-0.4c-1.2-0.3-2.2-0.7-3.1-1.3c-0.8-0.6-1.5-1.4-2-2.4c-0.5-0.9-0.7-2.1-0.7-3.4c0-1.3,0.3-2.5,0.8-3.5
					c0.5-1,1.3-1.8,2.2-2.5c0.9-0.7,2-1.1,3.1-1.5c1.2-0.3,2.4-0.5,3.7-0.5C70.2,83.2,71,83.2,71.6,83.2z M65.6,93.8
					c0,0,1.4,1.1,4.4,0.9c2.2-0.1,4.1-0.5,4.1-0.5v-6.9c0,0-1.9-0.3-4.1-0.3c-3.1,0-4.4,1.1-4.4,1.1c-0.9,0.6-1.3,1.6-1.3,2.9
					c0,0.8,0.2,1.5,0.5,2C64.9,93.2,65,93.4,65.6,93.8z M193.1,75.5c-0.1,0.4-0.9,2.5-1.1,3.2c-0.1,0.3-0.3,0.4-0.6,0.4
					c0,0-0.9-0.2-1.7-0.2c-0.5,0-1.3,0.1-2,0.3c-0.7,0.2-1.3,0.6-1.9,1.1c-0.6,0.5-1,1.3-1.3,2.2c-0.3,0.9-0.5,2.4-0.5,4v11.2
					c0,0.3-0.2,0.5-0.5,0.5h-4c-0.3,0-0.5-0.2-0.5-0.5V75.2c0-0.3,0.2-0.5,0.4-0.5h3.9c0.3,0,0.4,0.2,0.4,0.5V77
					c0.6-0.8,1.6-1.5,2.5-1.9c0.9-0.4,2-0.7,3.9-0.6c1,0.1,2.3,0.3,2.5,0.4C193,75,193.2,75.1,193.1,75.5z M156,65.1
					c0.1,0,0.4,0.2,0.3,0.5l-1.2,3.2c-0.1,0.2-0.2,0.4-0.7,0.2c-0.1,0-0.3-0.1-0.8-0.2c-0.3-0.1-0.8-0.1-1.2-0.1
					c-0.6,0-1.1,0.1-1.6,0.2c-0.5,0.1-0.9,0.4-1.3,0.8c-0.4,0.4-0.8,0.9-1.1,1.6c-0.6,1.6-0.8,3.3-0.8,3.4h4.8
					c0.4,0,0.5,0.2,0.5,0.5l-0.6,3.1c-0.1,0.5-0.5,0.4-0.5,0.4h-5L143.6,98c-0.4,2-0.8,3.7-1.3,5.1c-0.5,1.4-1.1,2.4-2,3.4
					c-0.8,0.9-1.7,1.6-2.8,1.9c-1,0.4-2.3,0.6-3.7,0.6c-0.7,0-1.4,0-2.2-0.2c-0.6-0.1-0.9-0.2-1.4-0.4c-0.2-0.1-0.3-0.3-0.2-0.6
					c0.1-0.3,1-2.7,1.1-3.1c0.2-0.4,0.5-0.2,0.5-0.2c0.3,0.1,0.5,0.2,0.8,0.3c0.4,0.1,0.8,0.1,1.2,0.1c0.7,0,1.3-0.1,1.8-0.3
					c0.6-0.2,1-0.6,1.4-1.1c0.4-0.5,0.7-1.2,1.1-2.1c0.3-0.9,0.6-2.2,0.9-3.7l3.4-18.9h-3.3c-0.4,0-0.5-0.2-0.5-0.5l0.6-3.1
					c0.1-0.5,0.5-0.4,0.5-0.4h3.4l0.2-1c0.5-3,1.5-5.3,3-6.8c1.5-1.5,3.7-2.3,6.4-2.3c0.8,0,1.5,0.1,2.1,0.2
					C155,64.8,155.5,64.9,156,65.1z M88.6,97.6c0,0.3-0.2,0.5-0.4,0.5h-4c-0.3,0-0.4-0.2-0.4-0.5V65.5c0-0.2,0.2-0.5,0.4-0.5h4
					c0.3,0,0.4,0.2,0.4,0.5V97.6z"/>
			</g>
		</g>
	</g>
</g>
</svg>
"]]));
async function makeRequest(options) {
const rawResponse = await new transport_1.default().httpRequest(options);
if (rawResponse?.headers?.['content-type'] === 'text/html') {
const htmlResponseError = messages.createError('error.HttpApi');
htmlResponseError.setData(rawResponse.body);
throw htmlResponseError;
}
const response = (0, kit_1.parseJsonMap)(rawResponse.body);
if (response.error) {
const errorDescription = typeof response.error_description === 'string' ? response.error_description : '';
const error = typeof response.error === 'string' ? response.error : 'Unknown';
const err = new sfError_1.SfError(`Request Failed: ${error} ${errorDescription}`);
err.data = Object.assign(response, { status: rawResponse.statusCode });
throw err;
}
else {
return response;
}
}
/**
* Handles device based login flows
*
* Usage:
* ```
* const oauthConfig = {
* loginUrl: this.flags.instanceurl,
* clientId: this.flags.clientid,
* };
* const deviceOauthService = await DeviceOauthService.create(oauthConfig);
* const loginData = await deviceOauthService.requestDeviceLogin();
* console.log(loginData);
* const approval = await deviceOauthService.awaitDeviceApproval(loginData);
* const authInfo = await deviceOauthService.authorizeAndSave(approval);
* ```
*/
class DeviceOauthService extends kit_1.AsyncCreatable {
static RESPONSE_TYPE = 'device_code';
static GRANT_TYPE = 'device';
static SCOPE = 'refresh_token web api';
static POLLING_COUNT_MAX = 100;
logger;
options;
pollingCount = 0;
constructor(options) {
super(options);
this.options = options;
if (!this.options.clientId)
this.options.clientId = authInfo_1.DEFAULT_CONNECTED_APP_INFO.clientId;
if (!this.options.loginUrl)
this.options.loginUrl = authInfo_1.AuthInfo.getDefaultInstanceUrl();
}
/**
* Begin the authorization flow by requesting the login
*
* @returns {Promise<DeviceCodeResponse>}
*/
async requestDeviceLogin() {
const deviceFlowRequestUrl = this.getDeviceFlowRequestUrl();
const loginOptions = this.getLoginOptions(deviceFlowRequestUrl);
return makeRequest(loginOptions);
}
/**
* Polls the server until successful response OR max attempts have been made
*
* @returns {Promise<Nullable<DeviceCodePollingResponse>>}
*/
async awaitDeviceApproval(loginData) {
const deviceFlowRequestUrl = this.getDeviceFlowRequestUrl();
const pollingOptions = this.getPollingOptions(deviceFlowRequestUrl, loginData.device_code);
const interval = kit_1.Duration.seconds(loginData.interval).milliseconds;
return this.pollForDeviceApproval(pollingOptions, interval);
}
/**
* Creates and saves new AuthInfo
*
* @returns {Promise<AuthInfo>}
*/
async authorizeAndSave(approval) {
const authInfo = await authInfo_1.AuthInfo.create({
oauth2Options: {
loginUrl: approval.instance_url,
refreshToken: approval.refresh_token,
clientSecret: this.options.clientSecret,
clientId: this.options.clientId,
},
});
await authInfo.save();
return authInfo;
}
async init() {
this.logger = await logger_1.Logger.child(this.constructor.name);
this.logger.debug(`this.options.clientId: ${this.options.clientId}`);
this.logger.debug(`this.options.loginUrl: ${this.options.loginUrl}`);
}
getLoginOptions(url) {
const form = new form_data_1.default();
form.append('client_id', (0, ts_types_1.ensureString)(this.options.clientId));
form.append('response_type', DeviceOauthService.RESPONSE_TYPE);
form.append('scope', DeviceOauthService.SCOPE);
return {
url,
headers: { ...connection_1.SFDX_HTTP_HEADERS, ...form.getHeaders() },
method: 'POST',
body: form.getBuffer(),
};
}
getPollingOptions(url, code) {
const form = new form_data_1.default();
form.append('client_id', (0, ts_types_1.ensureString)(this.options.clientId));
form.append('grant_type', DeviceOauthService.GRANT_TYPE);
form.append('code', code);
return {
url,
headers: { ...connection_1.SFDX_HTTP_HEADERS, ...form.getHeaders() },
method: 'POST',
body: form.getBuffer(),
};
}
getDeviceFlowRequestUrl() {
return `${(0, ts_types_1.ensureString)(this.options.loginUrl)}/services/oauth2/token`;
}
async poll(httpRequest) {
this.logger.debug(`polling for device approval (attempt ${this.pollingCount} of ${DeviceOauthService.POLLING_COUNT_MAX})`);
try {
return await makeRequest(httpRequest);
}
catch (e) {
if (e instanceof sfError_1.SfError && e.name === 'HttpApiError') {
throw e;
}
const err = (e instanceof sfError_1.SfError ? e.data : sfError_1.SfError.wrap((0, ts_types_1.isString)(e) ? e : 'unknown').data);
if (err?.error && err?.status === 400 && err?.error === 'authorization_pending') {
// do nothing because we're still waiting
}
else {
if (err?.error && err?.error_description) {
this.logger.error(`Polling error: ${err.error}: ${err.error_description}`);
}
else {
this.logger.error('Unknown Polling Error:');
this.logger.error(err ?? e);
}
throw err ?? e;
}
}
}
shouldContinuePolling() {
return this.pollingCount < DeviceOauthService.POLLING_COUNT_MAX;
}
async pollForDeviceApproval(httpRequest, interval) {
this.logger.debug('BEGIN POLLING FOR DEVICE APPROVAL');
let result;
while (this.shouldContinuePolling()) {
// eslint-disable-next-line no-await-in-loop
result = await this.poll(httpRequest);
if (result) {
this.logger.debug('POLLING FOR DEVICE APPROVAL SUCCESS');
break;
}
else {
this.logger.debug(`waiting ${interval} ms...`);
// eslint-disable-next-line no-await-in-loop
await (0, kit_1.sleep)(interval);
this.pollingCount += 1;
}
}
if (this.pollingCount >= DeviceOauthService.POLLING_COUNT_MAX) {
// stop polling, the user has likely abandoned the command...
this.logger.error(`Polling timed out because max polling was hit: ${this.pollingCount}`);
throw messages.createError('pollingTimeout');
}
return result;
}
}
exports.DeviceOauthService = DeviceOauthService;
//# sourceMappingURL=deviceOauthService.js.map