ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2025-02-06 11:10:10 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Convert lib/auth/utils to typescript

Browse Source 
Change-type: patch
This commit is contained in:
Pagan Gazzard 2020-02-05 17:59:54 +00:00
parent 4b8cec652a
commit 4de41ce3e0
2 changed files with 94 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
lib/auth/utils.coffee
View File

@ -1,80 +0,0 @@
###
Copyright 2016 Balena
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
###
balena = require('balena-sdk').fromSharedOptions()
_ = require('lodash')
url = require('url')
Promise = require('bluebird')
###*
# @summary Get dashboard CLI login URL
# @function
# @protected
#
# @param {String} callbackUrl - callback url
# @fulfil {String} - dashboard login url
# @returns {Promise}
#
# @example
# utils.getDashboardLoginURL('http://127.0.0.1:3000').then (url) ->
# console.log(url)
###
exports.getDashboardLoginURL = (callbackUrl) ->
# Encode percentages signs from the escaped url
# characters to avoid angular getting confused.
callbackUrl = encodeURIComponent(callbackUrl).replace(/%/g, '%25')
balena.settings.get('dashboardUrl').then (dashboardUrl) ->
return url.resolve(dashboardUrl, "/login/cli/#{callbackUrl}")
###*
# @summary Log in using a token, but only if the token is valid
# @function
# @protected
#
# @description
# This function checks that the token is not only well-structured
# but that it also authenticates with the server successfully.
#
# If authenticated, the token is persisted, if not then the previous
# login state is restored.
#
# @param {String} token - session token or api key
# @fulfil {Boolean} - whether the login was successful or not
# @returns {Promise}
#
# utils.loginIfTokenValid('...').then (loggedIn) ->
# if loggedIn
# console.log('Token is valid!')
###
exports.loginIfTokenValid = (token) ->
if not token? or _.isEmpty(token.trim())
return Promise.resolve(false)
return balena.auth.getToken()
.catchReturn(undefined)
.then (currentToken) ->
balena.auth.loginWithToken(token)
.return(token)
.then(balena.auth.isLoggedIn)
.tap (isLoggedIn) ->
return if isLoggedIn
if currentToken?
return balena.auth.loginWithToken(currentToken)
else
return balena.auth.logout()

94
lib/auth/utils.ts Normal file
View File

@ -0,0 +1,94 @@
/*
Copyright 2016 Balena
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import * as balenaSdk from 'balena-sdk';
import * as Promise from 'bluebird';
import * as _ from 'lodash';
import * as url from 'url';
const balena = balenaSdk.fromSharedOptions();
/**
* @summary Get dashboard CLI login URL
* @function
* @protected
*
* @param {String} callbackUrl - callback url
* @fulfil {String} - dashboard login url
* @returns {Promise}
*
* @example
* utils.getDashboardLoginURL('http://127.0.0.1:3000').then (url) ->
* console.log(url)
*/
export const getDashboardLoginURL = (callbackUrl: string) => {
// Encode percentages signs from the escaped url
// characters to avoid angular getting confused.
callbackUrl = encodeURIComponent(callbackUrl).replace(/%/g, '%25');
return balena.settings
.get('dashboardUrl')
.then(dashboardUrl =>
url.resolve(dashboardUrl, `/login/cli/${callbackUrl}`),
);
};
/**
* @summary Log in using a token, but only if the token is valid
* @function
* @protected
*
* @description
* This function checks that the token is not only well-structured
* but that it also authenticates with the server successfully.
*
* If authenticated, the token is persisted, if not then the previous
* login state is restored.
*
* @param {String} token - session token or api key
* @fulfil {Boolean} - whether the login was successful or not
* @returns {Promise}
*
* utils.loginIfTokenValid('...').then (loggedIn) ->
* if loggedIn
* console.log('Token is valid!')
*/
export const loginIfTokenValid = (token: string) => {
if (_.isEmpty(token?.trim())) {
return Promise.resolve(false);
}
return balena.auth
.getToken()
.catchReturn(undefined)
.then(currentToken =>
balena.auth
.loginWithToken(token)
.return(token)
.then(balena.auth.isLoggedIn)
.tap(isLoggedIn => {
if (isLoggedIn) {
return;
}
if (currentToken != null) {
return balena.auth.loginWithToken(currentToken);
} else {
return balena.auth.logout();
}
}),
);
};