balena-sdk 17.1.0 → 17.1.1

package/es2015/2fa.js

@@ -35,15 +35,6 @@ const get2fa = function (deps, opts) {
      * 		console.log('2FA is enabled for this account');
      * 	}
      * });
-     *
-     * @example
-     * balena.auth.twoFactor.isEnabled(function(error, isEnabled) {
-     * 	if (error) throw error;
-     *
-     * 	if (isEnabled) {
-     * 		console.log('2FA is enabled for this account');
-     * 	}
-     * });
      */
     function isEnabled() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -67,15 +58,6 @@ const get2fa = function (deps, opts) {
      * 		console.log('2FA challenge passed');
      * 	}
      * });
-     *
-     * @example
-     * balena.auth.twoFactor.isPassed(function(error, isPassed) {
-     * 	if (error) throw error;
-     *
-     * 	if (isPassed) {
-     * 		console.log('2FA challenge passed');
-     * 	}
-     * });
      */
     function isPassed() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -102,12 +84,6 @@ const get2fa = function (deps, opts) {
      * @example
      * const token = balena.auth.twoFactor.verify('1234');
      * balena.auth.loginWithToken(token);
-     *
-     * @example
-     * balena.auth.twoFactor.verify('1234', function(error, token) {
-     * 	if (error) throw error;
-     * 	console.log(token);
-     * });
      */
     function verify(code) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -135,12 +111,6 @@ const get2fa = function (deps, opts) {
      * @example
      * const setupKey = balena.auth.twoFactor.getSetupKey();
      * console.log(setupKey);
-     *
-     * @example
-     * balena.auth.twoFactor.getSetupKey(function(error, setupKey) {
-     * 	if (error) throw error;
-     * 	console.log(setupKey);
-     * });
      */
     function getSetupKey() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -168,12 +138,6 @@ const get2fa = function (deps, opts) {
      * @example
      * const token = balena.auth.twoFactor.enable('1234');
      * balena.auth.loginWithToken(token);
-     *
-     * @example
-     * balena.auth.twoFactor.enable('1234', function(error, token) {
-     * 	if (error) throw error;
-     * 	console.log(token);
-     * });
      */
     const enable = (code) => tslib_1.__awaiter(this, void 0, void 0, function* () {
         const token = yield verify(code);
@@ -195,11 +159,6 @@ const get2fa = function (deps, opts) {
      *
      * @example
      * balena.auth.twoFactor.challenge('1234');
-     *
-     * @example
-     * balena.auth.twoFactor.challenge('1234', function(error) {
-     * 	if (error) throw error;
-     * });
      */
     function challenge(code) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -223,12 +182,6 @@ const get2fa = function (deps, opts) {
      * @example
      * const token = balena.auth.twoFactor.disable('1234');
      * balena.auth.loginWithToken(token);
-     *
-     * @example
-     * balena.auth.twoFactor.disable('1234', function(error, token) {
-     * 	if (error) throw error;
-     * 	console.log(token);
-     * });
      */
     function disable(password) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {

package/es2015/auth.d.ts

@@ -6,6 +6,21 @@ declare const getAuth: (deps: InjectedDependenciesParam, opts: InjectedOptionsPa
         getSetupKey: () => Promise<string>;
         enable: (code: string) => Promise<string>;
         verify: (code: string) => Promise<string>;
+        /**
+         * @summary Login with a token or api key
+         * @name loginWithToken
+         * @public
+         * @function
+         * @memberof balena.auth
+         *
+         * @description Login to balena with a session token or api key instead of with credentials.
+         *
+         * @param {String} authToken - the auth token
+         * @returns {Promise}
+         *
+         * @example
+         * balena.auth.loginWithToken(authToken);
+         */
         challenge: (code: string) => Promise<void>;
         disable: (password: string) => Promise<string>;
     };

package/es2015/auth.js

@@ -91,17 +91,6 @@ const getAuth = function (deps, opts) {
      * 		console.log('My username is:', username);
      * 	}
      * });
-     *
-     * @example
-     * balena.auth.whoami(function(error, username) {
-     * 	if (error) throw error;
-     *
-     * 	if (!username) {
-     * 		console.log('I\'m not logged in!');
-     * 	} else {
-     * 		console.log('My username is:', username);
-     * 	}
-     * });
      */
     function whoami() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -141,12 +130,6 @@ const getAuth = function (deps, opts) {
      * balena.auth.authenticate(credentials).then(function(token) {
      * 	console.log('My token is:', token);
      * });
-     *
-     * @example
-     * balena.auth.authenticate(credentials, function(error, token) {
-     * 	if (error) throw error;
-     * 	console.log('My token is:', token);
-     * });
      */
     function authenticate(credentials) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -191,11 +174,6 @@ const getAuth = function (deps, opts) {
      *
      * @example
      * balena.auth.login(credentials);
-     *
-     * @example
-     * balena.auth.login(credentials, function(error) {
-     * 	if (error) throw error;
-     * });
      */
     function login(credentials) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -218,11 +196,6 @@ const getAuth = function (deps, opts) {
      *
      * @example
      * balena.auth.loginWithToken(authToken);
-     *
-     * @example
-     * balena.auth.loginWithToken(authToken, function(error) {
-     * 	if (error) throw error;
-     * });
      */
     function loginWithToken(authToken) {
         memoizedUserWhoami.clear();
@@ -246,17 +219,6 @@ const getAuth = function (deps, opts) {
      * 		console.log('Too bad!');
      * 	}
      * });
-     *
-     * @example
-     * balena.auth.isLoggedIn(function(error, isLoggedIn) {
-     * 	if (error) throw error;
-     *
-     * 	if (isLoggedIn) {
-     * 		console.log('I\'m in!');
-     * 	} else {
-     * 		console.log('Too bad!');
-     * 	}
-     * });
      */
     function isLoggedIn() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -289,12 +251,6 @@ const getAuth = function (deps, opts) {
      * balena.auth.getToken().then(function(token) {
      * 	console.log(token);
      * });
-     *
-     * @example
-     * balena.auth.getToken(function(error, token) {
-     * 	if (error) throw error;
-     * 	console.log(token);
-     * });
      */
     function getToken() {
         return auth.getKey().catch(function (err) {
@@ -317,12 +273,6 @@ const getAuth = function (deps, opts) {
      * balena.auth.getUserId().then(function(userId) {
      * 	console.log(userId);
      * });
-     *
-     * @example
-     * balena.auth.getUserId(function(error, userId) {
-     * 	if (error) throw error;
-     * 	console.log(userId);
-     * });
      */
     function getUserId() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -346,12 +296,6 @@ const getAuth = function (deps, opts) {
      * balena.auth.getUserActorId().then(function(userActorId) {
      * 	console.log(userActorId);
      * });
-     *
-     * @example
-     * balena.auth.getUserActorId(function(error, userActorId) {
-     * 	if (error) throw error;
-     * 	console.log(userActorId);
-     * });
      */
     function getUserActorId() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -381,12 +325,6 @@ const getAuth = function (deps, opts) {
      * balena.auth.getEmail().then(function(email) {
      * 	console.log(email);
      * });
-     *
-     * @example
-     * balena.auth.getEmail(function(error, email) {
-     * 	if (error) throw error;
-     * 	console.log(email);
-     * });
      */
     function getEmail() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -405,11 +343,6 @@ const getAuth = function (deps, opts) {
      *
      * @example
      * balena.auth.logout();
-     *
-     * @example
-     * balena.auth.logout(function(error) {
-     * 	if (error) throw error;
-     * });
      */
     function logout() {
         memoizedUserWhoami.clear();
@@ -437,16 +370,6 @@ const getAuth = function (deps, opts) {
      * }).then(function(token) {
      * 	console.log(token);
      * });
-     *
-     * @example
-     * balena.auth.register({
-     * 	email: 'johndoe@gmail.com',
-     * 	password: 'secret'
-     * }, function(error, token) {
-     * 	if (error) throw error;
-     * 	console.log(token);
-     * });
-     *
      */
     function register(credentials) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {