mirror of
https://github.com/sasjs/adapter.git
synced 2025-12-12 17:54:35 +00:00
Compare commits
4 Commits
error-stat
...
v3.2.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c44766ea14 | ||
|
|
2c10b9c65c | ||
|
|
c56874fe00 | ||
|
|
ebe9c2ffeb |
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
1131
docs/classes/request.sasjsrequestclient.html
Normal file
1131
docs/classes/request.sasjsrequestclient.html
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
183
docs/interfaces/root.sasjsauthresponse.html
Normal file
183
docs/interfaces/root.sasjsauthresponse.html
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -22,8 +22,8 @@ import { pollJobState } from './api/viya/pollJobState'
|
|||||||
import { getTokens } from './auth/getTokens'
|
import { getTokens } from './auth/getTokens'
|
||||||
import { uploadTables } from './api/viya/uploadTables'
|
import { uploadTables } from './api/viya/uploadTables'
|
||||||
import { executeScript } from './api/viya/executeScript'
|
import { executeScript } from './api/viya/executeScript'
|
||||||
import { getAccessToken } from './auth/getAccessToken'
|
import { getAccessTokenForViya } from './auth/getAccessTokenForViya'
|
||||||
import { refreshTokens } from './auth/refreshTokens'
|
import { refreshTokensForViya } from './auth/refreshTokensForViya'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A client for interfacing with the SAS Viya REST API.
|
* A client for interfacing with the SAS Viya REST API.
|
||||||
@@ -534,21 +534,26 @@ export class SASViyaApiClient {
|
|||||||
clientSecret: string,
|
clientSecret: string,
|
||||||
authCode: string
|
authCode: string
|
||||||
): Promise<SasAuthResponse> {
|
): Promise<SasAuthResponse> {
|
||||||
return getAccessToken(this.requestClient, clientId, clientSecret, authCode)
|
return getAccessTokenForViya(
|
||||||
|
this.requestClient,
|
||||||
|
clientId,
|
||||||
|
clientSecret,
|
||||||
|
authCode
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Exchanges the refresh token for an access token for the given client.
|
* Exchanges the refresh token for an access token for the given client.
|
||||||
* @param clientId - the client ID to authenticate with.
|
* @param clientId - the client ID to authenticate with.
|
||||||
* @param clientSecret - the client secret to authenticate with.
|
* @param clientSecret - the client secret to authenticate with.
|
||||||
* @param authCode - the refresh token received from the server.
|
* @param refreshToken - the refresh token received from the server.
|
||||||
*/
|
*/
|
||||||
public async refreshTokens(
|
public async refreshTokens(
|
||||||
clientId: string,
|
clientId: string,
|
||||||
clientSecret: string,
|
clientSecret: string,
|
||||||
refreshToken: string
|
refreshToken: string
|
||||||
) {
|
) {
|
||||||
return refreshTokens(
|
return refreshTokensForViya(
|
||||||
this.requestClient,
|
this.requestClient,
|
||||||
clientId,
|
clientId,
|
||||||
clientSecret,
|
clientSecret,
|
||||||
|
|||||||
130
src/SASjs.ts
130
src/SASjs.ts
@@ -11,15 +11,17 @@ import {
|
|||||||
} from './types'
|
} from './types'
|
||||||
import { SASViyaApiClient } from './SASViyaApiClient'
|
import { SASViyaApiClient } from './SASViyaApiClient'
|
||||||
import { SAS9ApiClient } from './SAS9ApiClient'
|
import { SAS9ApiClient } from './SAS9ApiClient'
|
||||||
import { SASjsApiClient } from './SASjsApiClient'
|
import { SASjsApiClient, SASjsAuthResponse } from './SASjsApiClient'
|
||||||
import { AuthManager } from './auth'
|
import { AuthManager } from './auth'
|
||||||
import {
|
import {
|
||||||
ServerType,
|
ServerType,
|
||||||
MacroVar,
|
MacroVar,
|
||||||
AuthConfig,
|
AuthConfig,
|
||||||
ExtraResponseAttributes
|
ExtraResponseAttributes,
|
||||||
|
SasAuthResponse
|
||||||
} from '@sasjs/utils/types'
|
} from '@sasjs/utils/types'
|
||||||
import { RequestClient } from './request/RequestClient'
|
import { RequestClient } from './request/RequestClient'
|
||||||
|
import { SasjsRequestClient } from './request/SasjsRequestClient'
|
||||||
import {
|
import {
|
||||||
JobExecutor,
|
JobExecutor,
|
||||||
WebJobExecutor,
|
WebJobExecutor,
|
||||||
@@ -53,7 +55,7 @@ export default class SASjs {
|
|||||||
private jobsPath: string = ''
|
private jobsPath: string = ''
|
||||||
private sasViyaApiClient: SASViyaApiClient | null = null
|
private sasViyaApiClient: SASViyaApiClient | null = null
|
||||||
private sas9ApiClient: SAS9ApiClient | null = null
|
private sas9ApiClient: SAS9ApiClient | null = null
|
||||||
private SASjsApiClient: SASjsApiClient | null = null
|
private sasJSApiClient: SASjsApiClient | null = null
|
||||||
private fileUploader: FileUploader | null = null
|
private fileUploader: FileUploader | null = null
|
||||||
private authManager: AuthManager | null = null
|
private authManager: AuthManager | null = null
|
||||||
private requestClient: RequestClient | null = null
|
private requestClient: RequestClient | null = null
|
||||||
@@ -80,7 +82,7 @@ export default class SASjs {
|
|||||||
userName: string,
|
userName: string,
|
||||||
password: string
|
password: string
|
||||||
) {
|
) {
|
||||||
this.isMethodSupported('executeScriptSAS9', ServerType.Sas9)
|
this.isMethodSupported('executeScriptSAS9', [ServerType.Sas9])
|
||||||
|
|
||||||
return await this.sas9ApiClient?.executeScript(
|
return await this.sas9ApiClient?.executeScript(
|
||||||
linesOfCode,
|
linesOfCode,
|
||||||
@@ -94,7 +96,7 @@ export default class SASjs {
|
|||||||
* @param accessToken - an access token for an authorized user.
|
* @param accessToken - an access token for an authorized user.
|
||||||
*/
|
*/
|
||||||
public async getComputeContexts(accessToken: string) {
|
public async getComputeContexts(accessToken: string) {
|
||||||
this.isMethodSupported('getComputeContexts', ServerType.SasViya)
|
this.isMethodSupported('getComputeContexts', [ServerType.SasViya])
|
||||||
|
|
||||||
return await this.sasViyaApiClient!.getComputeContexts(accessToken)
|
return await this.sasViyaApiClient!.getComputeContexts(accessToken)
|
||||||
}
|
}
|
||||||
@@ -104,7 +106,7 @@ export default class SASjs {
|
|||||||
* @param accessToken - an access token for an authorized user.
|
* @param accessToken - an access token for an authorized user.
|
||||||
*/
|
*/
|
||||||
public async getLauncherContexts(accessToken: string) {
|
public async getLauncherContexts(accessToken: string) {
|
||||||
this.isMethodSupported('getLauncherContexts', ServerType.SasViya)
|
this.isMethodSupported('getLauncherContexts', [ServerType.SasViya])
|
||||||
|
|
||||||
return await this.sasViyaApiClient!.getLauncherContexts(accessToken)
|
return await this.sasViyaApiClient!.getLauncherContexts(accessToken)
|
||||||
}
|
}
|
||||||
@@ -113,7 +115,7 @@ export default class SASjs {
|
|||||||
* Gets default(system) launcher contexts.
|
* Gets default(system) launcher contexts.
|
||||||
*/
|
*/
|
||||||
public getDefaultComputeContexts() {
|
public getDefaultComputeContexts() {
|
||||||
this.isMethodSupported('getDefaultComputeContexts', ServerType.SasViya)
|
this.isMethodSupported('getDefaultComputeContexts', [ServerType.SasViya])
|
||||||
|
|
||||||
return this.sasViyaApiClient!.getDefaultComputeContexts()
|
return this.sasViyaApiClient!.getDefaultComputeContexts()
|
||||||
}
|
}
|
||||||
@@ -123,7 +125,7 @@ export default class SASjs {
|
|||||||
* @param authConfig - an access token, refresh token, client and secret for an authorized user.
|
* @param authConfig - an access token, refresh token, client and secret for an authorized user.
|
||||||
*/
|
*/
|
||||||
public async getExecutableContexts(authConfig: AuthConfig) {
|
public async getExecutableContexts(authConfig: AuthConfig) {
|
||||||
this.isMethodSupported('getExecutableContexts', ServerType.SasViya)
|
this.isMethodSupported('getExecutableContexts', [ServerType.SasViya])
|
||||||
|
|
||||||
return await this.sasViyaApiClient!.getExecutableContexts(authConfig)
|
return await this.sasViyaApiClient!.getExecutableContexts(authConfig)
|
||||||
}
|
}
|
||||||
@@ -145,7 +147,7 @@ export default class SASjs {
|
|||||||
accessToken: string,
|
accessToken: string,
|
||||||
authorizedUsers?: string[]
|
authorizedUsers?: string[]
|
||||||
) {
|
) {
|
||||||
this.isMethodSupported('createComputeContext', ServerType.SasViya)
|
this.isMethodSupported('createComputeContext', [ServerType.SasViya])
|
||||||
|
|
||||||
return await this.sasViyaApiClient!.createComputeContext(
|
return await this.sasViyaApiClient!.createComputeContext(
|
||||||
contextName,
|
contextName,
|
||||||
@@ -170,7 +172,7 @@ export default class SASjs {
|
|||||||
launchType: string,
|
launchType: string,
|
||||||
accessToken: string
|
accessToken: string
|
||||||
) {
|
) {
|
||||||
this.isMethodSupported('createLauncherContext', ServerType.SasViya)
|
this.isMethodSupported('createLauncherContext', [ServerType.SasViya])
|
||||||
|
|
||||||
return await this.sasViyaApiClient!.createLauncherContext(
|
return await this.sasViyaApiClient!.createLauncherContext(
|
||||||
contextName,
|
contextName,
|
||||||
@@ -191,7 +193,7 @@ export default class SASjs {
|
|||||||
editedContext: EditContextInput,
|
editedContext: EditContextInput,
|
||||||
accessToken?: string
|
accessToken?: string
|
||||||
) {
|
) {
|
||||||
this.isMethodSupported('editComputeContext', ServerType.SasViya)
|
this.isMethodSupported('editComputeContext', [ServerType.SasViya])
|
||||||
|
|
||||||
return await this.sasViyaApiClient!.editComputeContext(
|
return await this.sasViyaApiClient!.editComputeContext(
|
||||||
contextName,
|
contextName,
|
||||||
@@ -206,7 +208,7 @@ export default class SASjs {
|
|||||||
* @param accessToken - an access token for an authorized user.
|
* @param accessToken - an access token for an authorized user.
|
||||||
*/
|
*/
|
||||||
public async deleteComputeContext(contextName: string, accessToken?: string) {
|
public async deleteComputeContext(contextName: string, accessToken?: string) {
|
||||||
this.isMethodSupported('deleteComputeContext', ServerType.SasViya)
|
this.isMethodSupported('deleteComputeContext', [ServerType.SasViya])
|
||||||
|
|
||||||
return await this.sasViyaApiClient!.deleteComputeContext(
|
return await this.sasViyaApiClient!.deleteComputeContext(
|
||||||
contextName,
|
contextName,
|
||||||
@@ -224,7 +226,7 @@ export default class SASjs {
|
|||||||
contextName: string,
|
contextName: string,
|
||||||
accessToken?: string
|
accessToken?: string
|
||||||
) {
|
) {
|
||||||
this.isMethodSupported('getComputeContextByName', ServerType.SasViya)
|
this.isMethodSupported('getComputeContextByName', [ServerType.SasViya])
|
||||||
|
|
||||||
return await this.sasViyaApiClient!.getComputeContextByName(
|
return await this.sasViyaApiClient!.getComputeContextByName(
|
||||||
contextName,
|
contextName,
|
||||||
@@ -238,7 +240,7 @@ export default class SASjs {
|
|||||||
* @param accessToken - an access token for an authorized user.
|
* @param accessToken - an access token for an authorized user.
|
||||||
*/
|
*/
|
||||||
public async getComputeContextById(contextId: string, accessToken?: string) {
|
public async getComputeContextById(contextId: string, accessToken?: string) {
|
||||||
this.isMethodSupported('getComputeContextById', ServerType.SasViya)
|
this.isMethodSupported('getComputeContextById', [ServerType.SasViya])
|
||||||
|
|
||||||
return await this.sasViyaApiClient!.getComputeContextById(
|
return await this.sasViyaApiClient!.getComputeContextById(
|
||||||
contextId,
|
contextId,
|
||||||
@@ -247,7 +249,7 @@ export default class SASjs {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public async createSession(contextName: string, accessToken: string) {
|
public async createSession(contextName: string, accessToken: string) {
|
||||||
this.isMethodSupported('createSession', ServerType.SasViya)
|
this.isMethodSupported('createSession', [ServerType.SasViya])
|
||||||
|
|
||||||
return await this.sasViyaApiClient!.createSession(contextName, accessToken)
|
return await this.sasViyaApiClient!.createSession(contextName, accessToken)
|
||||||
}
|
}
|
||||||
@@ -267,7 +269,7 @@ export default class SASjs {
|
|||||||
authConfig?: AuthConfig,
|
authConfig?: AuthConfig,
|
||||||
debug?: boolean
|
debug?: boolean
|
||||||
) {
|
) {
|
||||||
this.isMethodSupported('executeScriptSASViya', ServerType.SasViya)
|
this.isMethodSupported('executeScriptSASViya', [ServerType.SasViya])
|
||||||
if (!contextName) {
|
if (!contextName) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
'Context name is undefined. Please set a `contextName` in your SASjs or override config.'
|
'Context name is undefined. Please set a `contextName` in your SASjs or override config.'
|
||||||
@@ -357,7 +359,7 @@ export default class SASjs {
|
|||||||
* @param accessToken - the access token to authorize the request.
|
* @param accessToken - the access token to authorize the request.
|
||||||
*/
|
*/
|
||||||
public async getFolder(folderPath: string, accessToken?: string) {
|
public async getFolder(folderPath: string, accessToken?: string) {
|
||||||
this.isMethodSupported('getFolder', ServerType.SasViya)
|
this.isMethodSupported('getFolder', [ServerType.SasViya])
|
||||||
return await this.sasViyaApiClient!.getFolder(folderPath, accessToken)
|
return await this.sasViyaApiClient!.getFolder(folderPath, accessToken)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -367,7 +369,7 @@ export default class SASjs {
|
|||||||
* @param accessToken - an access token for authorizing the request.
|
* @param accessToken - an access token for authorizing the request.
|
||||||
*/
|
*/
|
||||||
public async deleteFolder(folderPath: string, accessToken: string) {
|
public async deleteFolder(folderPath: string, accessToken: string) {
|
||||||
this.isMethodSupported('deleteFolder', ServerType.SasViya)
|
this.isMethodSupported('deleteFolder', [ServerType.SasViya])
|
||||||
|
|
||||||
return await this.sasViyaApiClient?.deleteFolder(folderPath, accessToken)
|
return await this.sasViyaApiClient?.deleteFolder(folderPath, accessToken)
|
||||||
}
|
}
|
||||||
@@ -382,7 +384,7 @@ export default class SASjs {
|
|||||||
accessToken?: string,
|
accessToken?: string,
|
||||||
limit?: number
|
limit?: number
|
||||||
) {
|
) {
|
||||||
this.isMethodSupported('listFolder', ServerType.SasViya)
|
this.isMethodSupported('listFolder', [ServerType.SasViya])
|
||||||
|
|
||||||
return await this.sasViyaApiClient?.listFolder(
|
return await this.sasViyaApiClient?.listFolder(
|
||||||
sourceFolder,
|
sourceFolder,
|
||||||
@@ -404,7 +406,7 @@ export default class SASjs {
|
|||||||
targetFolderName: string,
|
targetFolderName: string,
|
||||||
accessToken: string
|
accessToken: string
|
||||||
) {
|
) {
|
||||||
this.isMethodSupported('moveFolder', ServerType.SasViya)
|
this.isMethodSupported('moveFolder', [ServerType.SasViya])
|
||||||
|
|
||||||
return await this.sasViyaApiClient?.moveFolder(
|
return await this.sasViyaApiClient?.moveFolder(
|
||||||
sourceFolder,
|
sourceFolder,
|
||||||
@@ -422,7 +424,7 @@ export default class SASjs {
|
|||||||
accessToken?: string,
|
accessToken?: string,
|
||||||
sasApiClient?: SASViyaApiClient
|
sasApiClient?: SASViyaApiClient
|
||||||
) {
|
) {
|
||||||
this.isMethodSupported('createJobDefinition', ServerType.SasViya)
|
this.isMethodSupported('createJobDefinition', [ServerType.SasViya])
|
||||||
|
|
||||||
if (sasApiClient)
|
if (sasApiClient)
|
||||||
return await sasApiClient!.createJobDefinition(
|
return await sasApiClient!.createJobDefinition(
|
||||||
@@ -442,7 +444,7 @@ export default class SASjs {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public async getAuthCode(clientId: string) {
|
public async getAuthCode(clientId: string) {
|
||||||
this.isMethodSupported('getAuthCode', ServerType.SasViya)
|
this.isMethodSupported('getAuthCode', [ServerType.SasViya])
|
||||||
|
|
||||||
return await this.sasViyaApiClient!.getAuthCode(clientId)
|
return await this.sasViyaApiClient!.getAuthCode(clientId)
|
||||||
}
|
}
|
||||||
@@ -457,8 +459,14 @@ export default class SASjs {
|
|||||||
clientId: string,
|
clientId: string,
|
||||||
clientSecret: string,
|
clientSecret: string,
|
||||||
authCode: string
|
authCode: string
|
||||||
) {
|
): Promise<SasAuthResponse | SASjsAuthResponse> {
|
||||||
this.isMethodSupported('getAccessToken', ServerType.SasViya)
|
this.isMethodSupported('getAccessToken', [
|
||||||
|
ServerType.SasViya,
|
||||||
|
ServerType.Sasjs
|
||||||
|
])
|
||||||
|
|
||||||
|
if (this.sasjsConfig.serverType === ServerType.Sasjs)
|
||||||
|
return await this.sasJSApiClient!.getAccessToken(clientId, authCode)
|
||||||
|
|
||||||
return await this.sasViyaApiClient!.getAccessToken(
|
return await this.sasViyaApiClient!.getAccessToken(
|
||||||
clientId,
|
clientId,
|
||||||
@@ -467,12 +475,24 @@ export default class SASjs {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exchanges the refresh token for an access token for the given client.
|
||||||
|
* @param clientId - the client ID to authenticate with.
|
||||||
|
* @param clientSecret - the client secret to authenticate with.
|
||||||
|
* @param refreshToken - the refresh token received from the server.
|
||||||
|
*/
|
||||||
public async refreshTokens(
|
public async refreshTokens(
|
||||||
clientId: string,
|
clientId: string,
|
||||||
clientSecret: string,
|
clientSecret: string,
|
||||||
refreshToken: string
|
refreshToken: string
|
||||||
) {
|
): Promise<SasAuthResponse | SASjsAuthResponse> {
|
||||||
this.isMethodSupported('refreshTokens', ServerType.SasViya)
|
this.isMethodSupported('refreshTokens', [
|
||||||
|
ServerType.SasViya,
|
||||||
|
ServerType.Sasjs
|
||||||
|
])
|
||||||
|
|
||||||
|
if (this.sasjsConfig.serverType === ServerType.Sasjs)
|
||||||
|
return await this.sasJSApiClient!.refreshTokens(refreshToken)
|
||||||
|
|
||||||
return await this.sasViyaApiClient!.refreshTokens(
|
return await this.sasViyaApiClient!.refreshTokens(
|
||||||
clientId,
|
clientId,
|
||||||
@@ -482,7 +502,7 @@ export default class SASjs {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public async deleteClient(clientId: string, accessToken: string) {
|
public async deleteClient(clientId: string, accessToken: string) {
|
||||||
this.isMethodSupported('deleteClient', ServerType.SasViya)
|
this.isMethodSupported('deleteClient', [ServerType.SasViya])
|
||||||
|
|
||||||
return await this.sasViyaApiClient!.deleteClient(clientId, accessToken)
|
return await this.sasViyaApiClient!.deleteClient(clientId, accessToken)
|
||||||
}
|
}
|
||||||
@@ -528,29 +548,39 @@ export default class SASjs {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Checks whether a session is active, or login is required.
|
* Checks whether a session is active, or login is required.
|
||||||
* @param accessToken - an optional access token is required for SASjs server type.
|
|
||||||
* @returns - a promise which resolves with an object containing two values - a boolean `isLoggedIn`, and a string `userName`.
|
* @returns - a promise which resolves with an object containing two values - a boolean `isLoggedIn`, and a string `userName`.
|
||||||
*/
|
*/
|
||||||
public async checkSession(accessToken?: string) {
|
public async checkSession() {
|
||||||
return this.authManager!.checkSession(accessToken)
|
return this.authManager!.checkSession()
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Logs into the SAS server with the supplied credentials.
|
* Logs into the SAS server with the supplied credentials.
|
||||||
* @param username - a string representing the username.
|
* @param username - a string representing the username.
|
||||||
* @param password - a string representing the password.
|
* @param password - a string representing the password.
|
||||||
|
* @param clientId - a string representing the client ID.
|
||||||
*/
|
*/
|
||||||
public async logIn(
|
public async logIn(
|
||||||
username?: string,
|
username?: string,
|
||||||
password?: string,
|
password?: string,
|
||||||
|
clientId?: string,
|
||||||
options: LoginOptions = {}
|
options: LoginOptions = {}
|
||||||
): Promise<LoginResult> {
|
): Promise<LoginResult> {
|
||||||
if (this.sasjsConfig.loginMechanism === LoginMechanism.Default) {
|
if (this.sasjsConfig.loginMechanism === LoginMechanism.Default) {
|
||||||
if (!username || !password) {
|
if (!username || !password)
|
||||||
throw new Error(
|
throw new Error(
|
||||||
'A username and password are required when using the default login mechanism.'
|
'A username and password are required when using the default login mechanism.'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if (this.sasjsConfig.serverType === ServerType.Sasjs) {
|
||||||
|
if (!clientId)
|
||||||
|
throw new Error(
|
||||||
|
'A username, password and clientId are required when using the default login mechanism with server type SASJS.'
|
||||||
|
)
|
||||||
|
|
||||||
|
return this.authManager!.logInSasjs(username, password, clientId)
|
||||||
}
|
}
|
||||||
|
|
||||||
return this.authManager!.logIn(username, password)
|
return this.authManager!.logIn(username, password)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -565,10 +595,9 @@ export default class SASjs {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Logs out of the configured SAS server.
|
* Logs out of the configured SAS server.
|
||||||
* @param accessToken - an optional access token is required for SASjs server type.
|
|
||||||
*/
|
*/
|
||||||
public logOut(accessToken?: string) {
|
public logOut() {
|
||||||
return this.authManager!.logOut(accessToken)
|
return this.authManager!.logOut()
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -777,7 +806,7 @@ export default class SASjs {
|
|||||||
accessToken?: string,
|
accessToken?: string,
|
||||||
isForced = false
|
isForced = false
|
||||||
) {
|
) {
|
||||||
this.isMethodSupported('deployServicePack', ServerType.SasViya)
|
this.isMethodSupported('deployServicePack', [ServerType.SasViya])
|
||||||
|
|
||||||
let sasApiClient: any = null
|
let sasApiClient: any = null
|
||||||
if (serverUrl || appLoc) {
|
if (serverUrl || appLoc) {
|
||||||
@@ -832,11 +861,11 @@ export default class SASjs {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public async deployToSASjs(members: [FolderMember, ServiceMember]) {
|
public async deployToSASjs(members: [FolderMember, ServiceMember]) {
|
||||||
return await this.SASjsApiClient?.deploy(members, this.sasjsConfig.appLoc)
|
return await this.sasJSApiClient?.deploy(members, this.sasjsConfig.appLoc)
|
||||||
}
|
}
|
||||||
|
|
||||||
public async executeJobSASjs(query: ExecutionQuery) {
|
public async executeJobSASjs(query: ExecutionQuery) {
|
||||||
return await this.SASjsApiClient?.executeJob(query)
|
return await this.sasJSApiClient?.executeJob(query)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -872,7 +901,7 @@ export default class SASjs {
|
|||||||
...config
|
...config
|
||||||
}
|
}
|
||||||
|
|
||||||
this.isMethodSupported('startComputeJob', ServerType.SasViya)
|
this.isMethodSupported('startComputeJob', [ServerType.SasViya])
|
||||||
if (!config.contextName) {
|
if (!config.contextName) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
'Context name is undefined. Please set a `contextName` in your SASjs or override config.'
|
'Context name is undefined. Please set a `contextName` in your SASjs or override config.'
|
||||||
@@ -964,7 +993,11 @@ export default class SASjs {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (!this.requestClient) {
|
if (!this.requestClient) {
|
||||||
this.requestClient = new RequestClient(
|
const RequestClientClass =
|
||||||
|
this.sasjsConfig.serverType === ServerType.Sasjs
|
||||||
|
? SasjsRequestClient
|
||||||
|
: RequestClient
|
||||||
|
this.requestClient = new RequestClientClass(
|
||||||
this.sasjsConfig.serverUrl,
|
this.sasjsConfig.serverUrl,
|
||||||
this.sasjsConfig.httpsAgentOptions
|
this.sasjsConfig.httpsAgentOptions
|
||||||
)
|
)
|
||||||
@@ -1020,10 +1053,10 @@ export default class SASjs {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (this.sasjsConfig.serverType === ServerType.Sasjs) {
|
if (this.sasjsConfig.serverType === ServerType.Sasjs) {
|
||||||
if (this.SASjsApiClient) {
|
if (this.sasJSApiClient) {
|
||||||
this.SASjsApiClient.setConfig(this.sasjsConfig.serverUrl)
|
this.sasJSApiClient.setConfig(this.sasjsConfig.serverUrl)
|
||||||
} else {
|
} else {
|
||||||
this.SASjsApiClient = new SASjsApiClient(
|
this.sasJSApiClient = new SASjsApiClient(
|
||||||
this.sasjsConfig.serverUrl,
|
this.sasjsConfig.serverUrl,
|
||||||
this.requestClient
|
this.requestClient
|
||||||
)
|
)
|
||||||
@@ -1117,12 +1150,15 @@ export default class SASjs {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
private isMethodSupported(method: string, serverType: string) {
|
private isMethodSupported(method: string, serverTypes: ServerType[]) {
|
||||||
if (this.sasjsConfig.serverType !== serverType) {
|
if (
|
||||||
|
!this.sasjsConfig.serverType ||
|
||||||
|
!serverTypes.includes(this.sasjsConfig.serverType)
|
||||||
|
) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
`Method '${method}' is only supported on ${
|
`Method '${method}' is only supported on ${serverTypes.join(
|
||||||
serverType === ServerType.Sas9 ? 'SAS9' : 'SAS Viya'
|
', '
|
||||||
} servers.`
|
)} servers.`
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,8 @@
|
|||||||
import { FolderMember, ServiceMember, ExecutionQuery } from './types'
|
import { FolderMember, ServiceMember, ExecutionQuery } from './types'
|
||||||
import { RequestClient } from './request/RequestClient'
|
import { RequestClient } from './request/RequestClient'
|
||||||
|
import { getAccessTokenForSasjs } from './auth/getAccessTokenForSasjs'
|
||||||
|
import { refreshTokensForSasjs } from './auth/refreshTokensForSasjs'
|
||||||
|
import { getAuthCodeForSasjs } from './auth/getAuthCodeForSasjs'
|
||||||
|
|
||||||
export class SASjsApiClient {
|
export class SASjsApiClient {
|
||||||
constructor(
|
constructor(
|
||||||
@@ -36,4 +39,44 @@ export class SASjsApiClient {
|
|||||||
|
|
||||||
return Promise.resolve(result)
|
return Promise.resolve(result)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exchanges the auth code for an access token for the given client.
|
||||||
|
* @param clientId - the client ID to authenticate with.
|
||||||
|
* @param authCode - the auth code received from the server.
|
||||||
|
*/
|
||||||
|
public async getAccessToken(
|
||||||
|
clientId: string,
|
||||||
|
authCode: string
|
||||||
|
): Promise<SASjsAuthResponse> {
|
||||||
|
return getAccessTokenForSasjs(this.requestClient, clientId, authCode)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exchanges the refresh token for an access token.
|
||||||
|
* @param refreshToken - the refresh token received from the server.
|
||||||
|
*/
|
||||||
|
public async refreshTokens(refreshToken: string): Promise<SASjsAuthResponse> {
|
||||||
|
return refreshTokensForSasjs(this.requestClient, refreshToken)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Performs a login authenticate and returns an auth code for the given client.
|
||||||
|
* @param username - a string representing the username.
|
||||||
|
* @param password - a string representing the password.
|
||||||
|
* @param clientId - the client ID to authenticate with.
|
||||||
|
*/
|
||||||
|
public async getAuthCode(
|
||||||
|
username: string,
|
||||||
|
password: string,
|
||||||
|
clientId: string
|
||||||
|
) {
|
||||||
|
return getAuthCodeForSasjs(this.requestClient, username, password, clientId)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// todo move to sasjs/utils
|
||||||
|
export interface SASjsAuthResponse {
|
||||||
|
access_token: string
|
||||||
|
refresh_token: string
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,6 +2,8 @@ import { ServerType } from '@sasjs/utils/types'
|
|||||||
import { RequestClient } from '../request/RequestClient'
|
import { RequestClient } from '../request/RequestClient'
|
||||||
import { LoginOptions, LoginResult } from '../types/Login'
|
import { LoginOptions, LoginResult } from '../types/Login'
|
||||||
import { serialize } from '../utils'
|
import { serialize } from '../utils'
|
||||||
|
import { getAccessTokenForSasjs } from './getAccessTokenForSasjs'
|
||||||
|
import { getAuthCodeForSasjs } from './getAuthCodeForSasjs'
|
||||||
import { openWebPage } from './openWebPage'
|
import { openWebPage } from './openWebPage'
|
||||||
import { verifySas9Login } from './verifySas9Login'
|
import { verifySas9Login } from './verifySas9Login'
|
||||||
import { verifySasViyaLogin } from './verifySasViyaLogin'
|
import { verifySasViyaLogin } from './verifySasViyaLogin'
|
||||||
@@ -81,6 +83,39 @@ export class AuthManager {
|
|||||||
return { isLoggedIn: false, userName: '' }
|
return { isLoggedIn: false, userName: '' }
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Logs into the SAS server with the supplied credentials.
|
||||||
|
* @param userName - a string representing the username.
|
||||||
|
* @param password - a string representing the password.
|
||||||
|
* @param clientId - a string representing the client ID.
|
||||||
|
* @returns - a boolean `isLoggedin` and a string `username`
|
||||||
|
*/
|
||||||
|
public async logInSasjs(
|
||||||
|
username: string,
|
||||||
|
password: string,
|
||||||
|
clientId: string
|
||||||
|
): Promise<LoginResult> {
|
||||||
|
const isLoggedIn = await this.sendLoginRequestSasjs(
|
||||||
|
username,
|
||||||
|
password,
|
||||||
|
clientId
|
||||||
|
)
|
||||||
|
.then((res) => {
|
||||||
|
this.userName = username
|
||||||
|
this.requestClient.saveLocalStorageToken(
|
||||||
|
res.access_token,
|
||||||
|
res.refresh_token
|
||||||
|
)
|
||||||
|
return true
|
||||||
|
})
|
||||||
|
.catch(() => false)
|
||||||
|
|
||||||
|
return {
|
||||||
|
isLoggedIn,
|
||||||
|
userName: this.userName
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Logs into the SAS server with the supplied credentials.
|
* Logs into the SAS server with the supplied credentials.
|
||||||
* @param username - a string representing the username.
|
* @param username - a string representing the username.
|
||||||
@@ -180,28 +215,41 @@ export class AuthManager {
|
|||||||
return loginResponse
|
return loginResponse
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private async sendLoginRequestSasjs(
|
||||||
|
username: string,
|
||||||
|
password: string,
|
||||||
|
clientId: string
|
||||||
|
) {
|
||||||
|
const authCode = await getAuthCodeForSasjs(
|
||||||
|
this.requestClient,
|
||||||
|
username,
|
||||||
|
password,
|
||||||
|
clientId
|
||||||
|
)
|
||||||
|
return getAccessTokenForSasjs(this.requestClient, clientId, authCode)
|
||||||
|
}
|
||||||
/**
|
/**
|
||||||
* Checks whether a session is active, or login is required.
|
* Checks whether a session is active, or login is required.
|
||||||
* @param accessToken - an optional access token is required for SASjs server type.
|
|
||||||
* @returns - a promise which resolves with an object containing three values
|
* @returns - a promise which resolves with an object containing three values
|
||||||
* - a boolean `isLoggedIn`
|
* - a boolean `isLoggedIn`
|
||||||
* - a string `userName` and
|
* - a string `userName` and
|
||||||
* - a form `loginForm` if not loggedin.
|
* - a form `loginForm` if not loggedin.
|
||||||
*/
|
*/
|
||||||
public async checkSession(accessToken?: string): Promise<{
|
public async checkSession(): Promise<{
|
||||||
isLoggedIn: boolean
|
isLoggedIn: boolean
|
||||||
userName: string
|
userName: string
|
||||||
loginForm?: any
|
loginForm?: any
|
||||||
}> {
|
}> {
|
||||||
const { isLoggedIn, userName } = await this.fetchUserName(accessToken)
|
const { isLoggedIn, userName } = await this.fetchUserName()
|
||||||
let loginForm = null
|
let loginForm = null
|
||||||
|
|
||||||
if (!isLoggedIn && this.serverType !== ServerType.Sasjs) {
|
if (!isLoggedIn) {
|
||||||
//We will logout to make sure cookies are removed and login form is presented
|
//We will logout to make sure cookies are removed and login form is presented
|
||||||
//Residue can happen in case of session expiration
|
//Residue can happen in case of session expiration
|
||||||
await this.logOut()
|
await this.logOut()
|
||||||
|
|
||||||
loginForm = await this.getNewLoginForm()
|
if (this.serverType !== ServerType.Sasjs)
|
||||||
|
loginForm = await this.getNewLoginForm()
|
||||||
}
|
}
|
||||||
|
|
||||||
return Promise.resolve({
|
return Promise.resolve({
|
||||||
@@ -221,7 +269,7 @@ export class AuthManager {
|
|||||||
return await this.getLoginForm(formResponse)
|
return await this.getLoginForm(formResponse)
|
||||||
}
|
}
|
||||||
|
|
||||||
private async fetchUserName(accessToken?: string): Promise<{
|
private async fetchUserName(): Promise<{
|
||||||
isLoggedIn: boolean
|
isLoggedIn: boolean
|
||||||
userName: string
|
userName: string
|
||||||
}> {
|
}> {
|
||||||
@@ -232,9 +280,8 @@ export class AuthManager {
|
|||||||
? `${this.serverUrl}/SASStoredProcess`
|
? `${this.serverUrl}/SASStoredProcess`
|
||||||
: `${this.serverUrl}/SASjsApi/session`
|
: `${this.serverUrl}/SASjsApi/session`
|
||||||
|
|
||||||
// Access token is required for server type `SASjs`
|
|
||||||
const { result: loginResponse } = await this.requestClient
|
const { result: loginResponse } = await this.requestClient
|
||||||
.get<string>(url, accessToken, 'text/plain')
|
.get<string>(url, undefined, 'text/plain')
|
||||||
.catch((err: any) => {
|
.catch((err: any) => {
|
||||||
return { result: 'authErr' }
|
return { result: 'authErr' }
|
||||||
})
|
})
|
||||||
@@ -315,11 +362,19 @@ export class AuthManager {
|
|||||||
* Logs out of the configured SAS server.
|
* Logs out of the configured SAS server.
|
||||||
* @param accessToken - an optional access token is required for SASjs server type.
|
* @param accessToken - an optional access token is required for SASjs server type.
|
||||||
*/
|
*/
|
||||||
public logOut(accessToken?: string) {
|
public async logOut() {
|
||||||
if (this.serverType === ServerType.Sasjs) {
|
if (this.serverType === ServerType.Sasjs) {
|
||||||
return this.requestClient.post(this.logoutUrl, undefined, accessToken)
|
return this.requestClient
|
||||||
|
.delete(this.logoutUrl)
|
||||||
|
.catch(() => true)
|
||||||
|
.finally(() => {
|
||||||
|
this.requestClient.clearLocalStorageTokens()
|
||||||
|
return true
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
this.requestClient.clearCsrfTokens()
|
this.requestClient.clearCsrfTokens()
|
||||||
|
|
||||||
return this.requestClient.get(this.logoutUrl, undefined).then(() => true)
|
return this.requestClient.get(this.logoutUrl, undefined).then(() => true)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
36
src/auth/getAccessTokenForSasjs.ts
Normal file
36
src/auth/getAccessTokenForSasjs.ts
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
import { prefixMessage } from '@sasjs/utils/error'
|
||||||
|
import { RequestClient } from '../request/RequestClient'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exchanges the auth code for an access token for the given client.
|
||||||
|
* @param requestClient - the pre-configured HTTP request client
|
||||||
|
* @param clientId - the client ID to authenticate with.
|
||||||
|
* @param authCode - the auth code received from the server.
|
||||||
|
*/
|
||||||
|
export async function getAccessTokenForSasjs(
|
||||||
|
requestClient: RequestClient,
|
||||||
|
clientId: string,
|
||||||
|
authCode: string
|
||||||
|
) {
|
||||||
|
const url = '/SASjsApi/auth/token'
|
||||||
|
const data = {
|
||||||
|
clientId,
|
||||||
|
code: authCode
|
||||||
|
}
|
||||||
|
|
||||||
|
return await requestClient
|
||||||
|
.post(url, data, undefined)
|
||||||
|
.then((res) => {
|
||||||
|
const sasAuth = res.result as {
|
||||||
|
accessToken: string
|
||||||
|
refreshToken: string
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
access_token: sasAuth.accessToken,
|
||||||
|
refresh_token: sasAuth.refreshToken
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.catch((err) => {
|
||||||
|
throw prefixMessage(err, 'Error while getting access token. ')
|
||||||
|
})
|
||||||
|
}
|
||||||
@@ -10,7 +10,7 @@ import { RequestClient } from '../request/RequestClient'
|
|||||||
* @param clientSecret - the client secret to authenticate with.
|
* @param clientSecret - the client secret to authenticate with.
|
||||||
* @param authCode - the auth code received from the server.
|
* @param authCode - the auth code received from the server.
|
||||||
*/
|
*/
|
||||||
export async function getAccessToken(
|
export async function getAccessTokenForViya(
|
||||||
requestClient: RequestClient,
|
requestClient: RequestClient,
|
||||||
clientId: string,
|
clientId: string,
|
||||||
clientSecret: string,
|
clientSecret: string,
|
||||||
31
src/auth/getAuthCodeForSasjs.ts
Normal file
31
src/auth/getAuthCodeForSasjs.ts
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
import { prefixMessage } from '@sasjs/utils/error'
|
||||||
|
import { RequestClient } from '../request/RequestClient'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Performs a login authenticate and returns an auth code for the given client.
|
||||||
|
* @param requestClient - the pre-configured HTTP request client
|
||||||
|
* @param username - a string representing the username.
|
||||||
|
* @param password - a string representing the password.
|
||||||
|
* @param clientId - the client ID to authenticate with.
|
||||||
|
*/
|
||||||
|
export const getAuthCodeForSasjs = async (
|
||||||
|
requestClient: RequestClient,
|
||||||
|
username: string,
|
||||||
|
password: string,
|
||||||
|
clientId: string
|
||||||
|
) => {
|
||||||
|
const url = '/SASjsApi/auth/authorize'
|
||||||
|
const data = { username, password, clientId }
|
||||||
|
|
||||||
|
const { code: authCode } = await requestClient
|
||||||
|
.post<{ code: string }>(url, data, undefined)
|
||||||
|
.then((res) => res.result)
|
||||||
|
.catch((err) => {
|
||||||
|
throw prefixMessage(
|
||||||
|
err,
|
||||||
|
'Error while authenticating with provided username, password and clientId. '
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
return authCode
|
||||||
|
}
|
||||||
@@ -3,18 +3,21 @@ import {
|
|||||||
isRefreshTokenExpiring,
|
isRefreshTokenExpiring,
|
||||||
hasTokenExpired
|
hasTokenExpired
|
||||||
} from '@sasjs/utils/auth'
|
} from '@sasjs/utils/auth'
|
||||||
import { AuthConfig } from '@sasjs/utils/types'
|
import { AuthConfig, ServerType } from '@sasjs/utils/types'
|
||||||
import { RequestClient } from '../request/RequestClient'
|
import { RequestClient } from '../request/RequestClient'
|
||||||
import { refreshTokens } from './refreshTokens'
|
import { refreshTokensForViya } from './refreshTokensForViya'
|
||||||
|
import { refreshTokensForSasjs } from './refreshTokensForSasjs'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the auth configuration, refreshing the tokens if necessary.
|
* Returns the auth configuration, refreshing the tokens if necessary.
|
||||||
* @param requestClient - the pre-configured HTTP request client
|
* @param requestClient - the pre-configured HTTP request client
|
||||||
* @param authConfig - an object containing a client ID, secret, access token and refresh token
|
* @param authConfig - an object containing a client ID, secret, access token and refresh token
|
||||||
|
* @param serverType - server type for which refreshing the tokens, defaults to SASVIYA
|
||||||
*/
|
*/
|
||||||
export async function getTokens(
|
export async function getTokens(
|
||||||
requestClient: RequestClient,
|
requestClient: RequestClient,
|
||||||
authConfig: AuthConfig
|
authConfig: AuthConfig,
|
||||||
|
serverType: ServerType = ServerType.SasViya
|
||||||
): Promise<AuthConfig> {
|
): Promise<AuthConfig> {
|
||||||
const logger = process.logger || console
|
const logger = process.logger || console
|
||||||
let { access_token, refresh_token, client, secret } = authConfig
|
let { access_token, refresh_token, client, secret } = authConfig
|
||||||
@@ -29,12 +32,16 @@ export async function getTokens(
|
|||||||
throw new Error(error)
|
throw new Error(error)
|
||||||
}
|
}
|
||||||
logger.info('Refreshing access and refresh tokens.')
|
logger.info('Refreshing access and refresh tokens.')
|
||||||
;({ access_token, refresh_token } = await refreshTokens(
|
const tokens =
|
||||||
requestClient,
|
serverType === ServerType.SasViya
|
||||||
client,
|
? await refreshTokensForViya(
|
||||||
secret,
|
requestClient,
|
||||||
refresh_token
|
client,
|
||||||
))
|
secret,
|
||||||
|
refresh_token
|
||||||
|
)
|
||||||
|
: await refreshTokensForSasjs(requestClient, refresh_token)
|
||||||
|
;({ access_token, refresh_token } = tokens)
|
||||||
}
|
}
|
||||||
return { access_token, refresh_token, client, secret }
|
return { access_token, refresh_token, client, secret }
|
||||||
}
|
}
|
||||||
|
|||||||
35
src/auth/refreshTokensForSasjs.ts
Normal file
35
src/auth/refreshTokensForSasjs.ts
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
import { prefixMessage } from '@sasjs/utils/error'
|
||||||
|
import { RequestClient } from '../request/RequestClient'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exchanges the refresh token for an access token for the given client.
|
||||||
|
* @param requestClient - the pre-configured HTTP request client
|
||||||
|
* @param refreshToken - the refresh token received from the server.
|
||||||
|
*/
|
||||||
|
export async function refreshTokensForSasjs(
|
||||||
|
requestClient: RequestClient,
|
||||||
|
refreshToken: string
|
||||||
|
) {
|
||||||
|
const url = '/SASjsApi/auth/refresh'
|
||||||
|
const headers = {
|
||||||
|
Authorization: 'Bearer ' + refreshToken
|
||||||
|
}
|
||||||
|
|
||||||
|
const authResponse = await requestClient
|
||||||
|
.post(url, undefined, undefined, undefined, headers)
|
||||||
|
.then((res) => {
|
||||||
|
const sasAuth = res.result as {
|
||||||
|
accessToken: string
|
||||||
|
refreshToken: string
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
access_token: sasAuth.accessToken,
|
||||||
|
refresh_token: sasAuth.refreshToken
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.catch((err) => {
|
||||||
|
throw prefixMessage(err, 'Error while refreshing tokens')
|
||||||
|
})
|
||||||
|
|
||||||
|
return authResponse
|
||||||
|
}
|
||||||
@@ -8,9 +8,9 @@ import { RequestClient } from '../request/RequestClient'
|
|||||||
* @param requestClient - the pre-configured HTTP request client
|
* @param requestClient - the pre-configured HTTP request client
|
||||||
* @param clientId - the client ID to authenticate with.
|
* @param clientId - the client ID to authenticate with.
|
||||||
* @param clientSecret - the client secret to authenticate with.
|
* @param clientSecret - the client secret to authenticate with.
|
||||||
* @param authCode - the refresh token received from the server.
|
* @param refreshToken - the refresh token received from the server.
|
||||||
*/
|
*/
|
||||||
export async function refreshTokens(
|
export async function refreshTokensForViya(
|
||||||
requestClient: RequestClient,
|
requestClient: RequestClient,
|
||||||
clientId: string,
|
clientId: string,
|
||||||
clientSecret: string,
|
clientSecret: string,
|
||||||
65
src/auth/spec/getAccessTokenForSasjs.spec.ts
Normal file
65
src/auth/spec/getAccessTokenForSasjs.spec.ts
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
import { AuthConfig } from '@sasjs/utils'
|
||||||
|
import { generateToken, mockSasjsAuthResponse } from './mockResponses'
|
||||||
|
import { RequestClient } from '../../request/RequestClient'
|
||||||
|
import { getAccessTokenForSasjs } from '../getAccessTokenForSasjs'
|
||||||
|
|
||||||
|
const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
|
||||||
|
|
||||||
|
describe('getAccessTokenForSasjs', () => {
|
||||||
|
it('should attempt to refresh tokens', async () => {
|
||||||
|
setupMocks()
|
||||||
|
const access_token = generateToken(30)
|
||||||
|
const refresh_token = generateToken(30)
|
||||||
|
const authConfig: AuthConfig = {
|
||||||
|
access_token,
|
||||||
|
refresh_token,
|
||||||
|
client: 'cl13nt',
|
||||||
|
secret: 's3cr3t'
|
||||||
|
}
|
||||||
|
jest
|
||||||
|
.spyOn(requestClient, 'post')
|
||||||
|
.mockImplementation(() =>
|
||||||
|
Promise.resolve({ result: mockSasjsAuthResponse, etag: '' })
|
||||||
|
)
|
||||||
|
|
||||||
|
await getAccessTokenForSasjs(
|
||||||
|
requestClient,
|
||||||
|
authConfig.client,
|
||||||
|
authConfig.refresh_token
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(requestClient.post).toHaveBeenCalledWith(
|
||||||
|
'/SASjsApi/auth/token',
|
||||||
|
{ clientId: authConfig.client, code: authConfig.refresh_token },
|
||||||
|
undefined
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors while refreshing tokens', async () => {
|
||||||
|
setupMocks()
|
||||||
|
const access_token = generateToken(30)
|
||||||
|
const refresh_token = generateToken(30)
|
||||||
|
const authConfig: AuthConfig = {
|
||||||
|
access_token,
|
||||||
|
refresh_token,
|
||||||
|
client: 'cl13nt',
|
||||||
|
secret: 's3cr3t'
|
||||||
|
}
|
||||||
|
jest
|
||||||
|
.spyOn(requestClient, 'post')
|
||||||
|
.mockImplementation(() => Promise.reject('Token Error'))
|
||||||
|
|
||||||
|
const error = await getAccessTokenForSasjs(
|
||||||
|
requestClient,
|
||||||
|
authConfig.client,
|
||||||
|
authConfig.refresh_token
|
||||||
|
).catch((e) => e)
|
||||||
|
|
||||||
|
expect(error).toContain('Error while getting access token')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
const setupMocks = () => {
|
||||||
|
jest.restoreAllMocks()
|
||||||
|
jest.mock('../../request/RequestClient')
|
||||||
|
}
|
||||||
@@ -2,11 +2,11 @@ import { AuthConfig } from '@sasjs/utils'
|
|||||||
import * as NodeFormData from 'form-data'
|
import * as NodeFormData from 'form-data'
|
||||||
import { generateToken, mockAuthResponse } from './mockResponses'
|
import { generateToken, mockAuthResponse } from './mockResponses'
|
||||||
import { RequestClient } from '../../request/RequestClient'
|
import { RequestClient } from '../../request/RequestClient'
|
||||||
import { getAccessToken } from '../getAccessToken'
|
import { getAccessTokenForViya } from '../getAccessTokenForViya'
|
||||||
|
|
||||||
const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
|
const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
|
||||||
|
|
||||||
describe('getAccessToken', () => {
|
describe('getAccessTokenForViya', () => {
|
||||||
it('should attempt to refresh tokens', async () => {
|
it('should attempt to refresh tokens', async () => {
|
||||||
setupMocks()
|
setupMocks()
|
||||||
const access_token = generateToken(30)
|
const access_token = generateToken(30)
|
||||||
@@ -26,7 +26,7 @@ describe('getAccessToken', () => {
|
|||||||
authConfig.client + ':' + authConfig.secret
|
authConfig.client + ':' + authConfig.secret
|
||||||
).toString('base64')
|
).toString('base64')
|
||||||
|
|
||||||
await getAccessToken(
|
await getAccessTokenForViya(
|
||||||
requestClient,
|
requestClient,
|
||||||
authConfig.client,
|
authConfig.client,
|
||||||
authConfig.secret,
|
authConfig.secret,
|
||||||
@@ -58,7 +58,7 @@ describe('getAccessToken', () => {
|
|||||||
.spyOn(requestClient, 'post')
|
.spyOn(requestClient, 'post')
|
||||||
.mockImplementation(() => Promise.reject('Token Error'))
|
.mockImplementation(() => Promise.reject('Token Error'))
|
||||||
|
|
||||||
const error = await getAccessToken(
|
const error = await getAccessTokenForViya(
|
||||||
requestClient,
|
requestClient,
|
||||||
authConfig.client,
|
authConfig.client,
|
||||||
authConfig.secret,
|
authConfig.secret,
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
import { AuthConfig } from '@sasjs/utils'
|
import { AuthConfig } from '@sasjs/utils'
|
||||||
import * as refreshTokensModule from '../refreshTokens'
|
import * as refreshTokensModule from '../refreshTokensForViya'
|
||||||
import { generateToken, mockAuthResponse } from './mockResponses'
|
import { generateToken, mockAuthResponse } from './mockResponses'
|
||||||
import { getTokens } from '../getTokens'
|
import { getTokens } from '../getTokens'
|
||||||
import { RequestClient } from '../../request/RequestClient'
|
import { RequestClient } from '../../request/RequestClient'
|
||||||
@@ -20,7 +20,7 @@ describe('getTokens', () => {
|
|||||||
|
|
||||||
await getTokens(requestClient, authConfig)
|
await getTokens(requestClient, authConfig)
|
||||||
|
|
||||||
expect(refreshTokensModule.refreshTokens).toHaveBeenCalledWith(
|
expect(refreshTokensModule.refreshTokensForViya).toHaveBeenCalledWith(
|
||||||
requestClient,
|
requestClient,
|
||||||
authConfig.client,
|
authConfig.client,
|
||||||
authConfig.secret,
|
authConfig.secret,
|
||||||
@@ -41,7 +41,7 @@ describe('getTokens', () => {
|
|||||||
|
|
||||||
await getTokens(requestClient, authConfig)
|
await getTokens(requestClient, authConfig)
|
||||||
|
|
||||||
expect(refreshTokensModule.refreshTokens).toHaveBeenCalledWith(
|
expect(refreshTokensModule.refreshTokensForViya).toHaveBeenCalledWith(
|
||||||
requestClient,
|
requestClient,
|
||||||
authConfig.client,
|
authConfig.client,
|
||||||
authConfig.secret,
|
authConfig.secret,
|
||||||
@@ -71,9 +71,9 @@ describe('getTokens', () => {
|
|||||||
const setupMocks = () => {
|
const setupMocks = () => {
|
||||||
jest.restoreAllMocks()
|
jest.restoreAllMocks()
|
||||||
jest.mock('../../request/RequestClient')
|
jest.mock('../../request/RequestClient')
|
||||||
jest.mock('../refreshTokens')
|
jest.mock('../refreshTokensForViya')
|
||||||
|
|
||||||
jest
|
jest
|
||||||
.spyOn(refreshTokensModule, 'refreshTokens')
|
.spyOn(refreshTokensModule, 'refreshTokensForViya')
|
||||||
.mockImplementation(() => Promise.resolve(mockAuthResponse))
|
.mockImplementation(() => Promise.resolve(mockAuthResponse))
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,6 +13,11 @@ export const mockAuthResponse: SasAuthResponse = {
|
|||||||
jti: 'test'
|
jti: 'test'
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export const mockSasjsAuthResponse = {
|
||||||
|
access_token: 'acc355',
|
||||||
|
refresh_token: 'r3fr35h'
|
||||||
|
}
|
||||||
|
|
||||||
export const generateToken = (timeToLiveSeconds: number): string => {
|
export const generateToken = (timeToLiveSeconds: number): string => {
|
||||||
const exp =
|
const exp =
|
||||||
new Date(new Date().getTime() + timeToLiveSeconds * 1000).getTime() / 1000
|
new Date(new Date().getTime() + timeToLiveSeconds * 1000).getTime() / 1000
|
||||||
|
|||||||
47
src/auth/spec/refreshTokensForSasjs.spec.ts
Normal file
47
src/auth/spec/refreshTokensForSasjs.spec.ts
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
import { generateToken, mockAuthResponse } from './mockResponses'
|
||||||
|
import { RequestClient } from '../../request/RequestClient'
|
||||||
|
import { refreshTokensForSasjs } from '../refreshTokensForSasjs'
|
||||||
|
|
||||||
|
const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
|
||||||
|
|
||||||
|
describe('refreshTokensForSasjs', () => {
|
||||||
|
it('should attempt to refresh tokens', async () => {
|
||||||
|
setupMocks()
|
||||||
|
const refresh_token = generateToken(30)
|
||||||
|
jest
|
||||||
|
.spyOn(requestClient, 'post')
|
||||||
|
.mockImplementation(() =>
|
||||||
|
Promise.resolve({ result: mockAuthResponse, etag: '' })
|
||||||
|
)
|
||||||
|
|
||||||
|
await refreshTokensForSasjs(requestClient, refresh_token)
|
||||||
|
|
||||||
|
expect(requestClient.post).toHaveBeenCalledWith(
|
||||||
|
'/SASjsApi/auth/refresh',
|
||||||
|
undefined,
|
||||||
|
undefined,
|
||||||
|
undefined,
|
||||||
|
{ Authorization: `Bearer ${refresh_token}` }
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors while refreshing tokens', async () => {
|
||||||
|
setupMocks()
|
||||||
|
const refresh_token = generateToken(30)
|
||||||
|
jest
|
||||||
|
.spyOn(requestClient, 'post')
|
||||||
|
.mockImplementation(() => Promise.reject('Token Error'))
|
||||||
|
|
||||||
|
const error = await refreshTokensForSasjs(
|
||||||
|
requestClient,
|
||||||
|
refresh_token
|
||||||
|
).catch((e) => e)
|
||||||
|
|
||||||
|
expect(error).toContain('Error while refreshing tokens')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
const setupMocks = () => {
|
||||||
|
jest.restoreAllMocks()
|
||||||
|
jest.mock('../../request/RequestClient')
|
||||||
|
}
|
||||||
@@ -2,11 +2,11 @@ import { AuthConfig } from '@sasjs/utils'
|
|||||||
import * as NodeFormData from 'form-data'
|
import * as NodeFormData from 'form-data'
|
||||||
import { generateToken, mockAuthResponse } from './mockResponses'
|
import { generateToken, mockAuthResponse } from './mockResponses'
|
||||||
import { RequestClient } from '../../request/RequestClient'
|
import { RequestClient } from '../../request/RequestClient'
|
||||||
import { refreshTokens } from '../refreshTokens'
|
import { refreshTokensForViya } from '../refreshTokensForViya'
|
||||||
|
|
||||||
const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
|
const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
|
||||||
|
|
||||||
describe('refreshTokens', () => {
|
describe('refreshTokensForViya', () => {
|
||||||
it('should attempt to refresh tokens', async () => {
|
it('should attempt to refresh tokens', async () => {
|
||||||
setupMocks()
|
setupMocks()
|
||||||
const access_token = generateToken(30)
|
const access_token = generateToken(30)
|
||||||
@@ -26,7 +26,7 @@ describe('refreshTokens', () => {
|
|||||||
authConfig.client + ':' + authConfig.secret
|
authConfig.client + ':' + authConfig.secret
|
||||||
).toString('base64')
|
).toString('base64')
|
||||||
|
|
||||||
await refreshTokens(
|
await refreshTokensForViya(
|
||||||
requestClient,
|
requestClient,
|
||||||
authConfig.client,
|
authConfig.client,
|
||||||
authConfig.secret,
|
authConfig.secret,
|
||||||
@@ -58,7 +58,7 @@ describe('refreshTokens', () => {
|
|||||||
.spyOn(requestClient, 'post')
|
.spyOn(requestClient, 'post')
|
||||||
.mockImplementation(() => Promise.reject('Token Error'))
|
.mockImplementation(() => Promise.reject('Token Error'))
|
||||||
|
|
||||||
const error = await refreshTokens(
|
const error = await refreshTokensForViya(
|
||||||
requestClient,
|
requestClient,
|
||||||
authConfig.client,
|
authConfig.client,
|
||||||
authConfig.secret,
|
authConfig.secret,
|
||||||
@@ -144,7 +144,6 @@ export class WebJobExecutor extends BaseJobExecutor {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const requestPromise = new Promise((resolve, reject) => {
|
const requestPromise = new Promise((resolve, reject) => {
|
||||||
// Access token is required for server type `SASjs`
|
|
||||||
this.requestClient!.post(apiUrl, formData, authConfig?.access_token)
|
this.requestClient!.post(apiUrl, formData, authConfig?.access_token)
|
||||||
.then(async (res: any) => {
|
.then(async (res: any) => {
|
||||||
const resObj =
|
const resObj =
|
||||||
|
|||||||
@@ -48,7 +48,9 @@ export interface HttpClient {
|
|||||||
): Promise<{ result: T; etag: string }>
|
): Promise<{ result: T; etag: string }>
|
||||||
|
|
||||||
getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined
|
getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined
|
||||||
|
saveLocalStorageToken(accessToken: string, refreshToken: string): void
|
||||||
clearCsrfTokens(): void
|
clearCsrfTokens(): void
|
||||||
|
clearLocalStorageTokens(): void
|
||||||
getBaseUrl(): string
|
getBaseUrl(): string
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -70,6 +72,11 @@ export class RequestClient implements HttpClient {
|
|||||||
this.createHttpClient(baseUrl, httpsAgentOptions)
|
this.createHttpClient(baseUrl, httpsAgentOptions)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public saveLocalStorageToken(accessToken: string, refreshToken: string) {
|
||||||
|
localStorage.setItem('accessToken', accessToken)
|
||||||
|
localStorage.setItem('refreshToken', refreshToken)
|
||||||
|
}
|
||||||
|
|
||||||
public getCsrfToken(type: 'general' | 'file' = 'general') {
|
public getCsrfToken(type: 'general' | 'file' = 'general') {
|
||||||
return type === 'file' ? this.fileUploadCsrfToken : this.csrfToken
|
return type === 'file' ? this.fileUploadCsrfToken : this.csrfToken
|
||||||
}
|
}
|
||||||
@@ -78,6 +85,10 @@ export class RequestClient implements HttpClient {
|
|||||||
this.csrfToken = { headerName: '', value: '' }
|
this.csrfToken = { headerName: '', value: '' }
|
||||||
this.fileUploadCsrfToken = { headerName: '', value: '' }
|
this.fileUploadCsrfToken = { headerName: '', value: '' }
|
||||||
}
|
}
|
||||||
|
public clearLocalStorageTokens() {
|
||||||
|
localStorage.setItem('accessToken', '')
|
||||||
|
localStorage.setItem('refreshToken', '')
|
||||||
|
}
|
||||||
|
|
||||||
public getBaseUrl() {
|
public getBaseUrl() {
|
||||||
return this.httpClient.defaults.baseURL || ''
|
return this.httpClient.defaults.baseURL || ''
|
||||||
|
|||||||
@@ -87,7 +87,7 @@ export class Sas9RequestClient extends RequestClient {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
public post<T>(
|
public async post<T>(
|
||||||
url: string,
|
url: string,
|
||||||
data: any,
|
data: any,
|
||||||
accessToken: string | undefined,
|
accessToken: string | undefined,
|
||||||
|
|||||||
23
src/request/SasjsRequestClient.ts
Normal file
23
src/request/SasjsRequestClient.ts
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
import { RequestClient } from './RequestClient'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specific request client for SASJS.
|
||||||
|
* Append tokens in headers.
|
||||||
|
*/
|
||||||
|
export class SasjsRequestClient extends RequestClient {
|
||||||
|
getHeaders = (accessToken: string | undefined, contentType: string) => {
|
||||||
|
const headers: any = {}
|
||||||
|
|
||||||
|
if (contentType !== 'application/x-www-form-urlencoded')
|
||||||
|
headers['Content-Type'] = contentType
|
||||||
|
|
||||||
|
headers.Accept = contentType === 'application/json' ? contentType : '*/*'
|
||||||
|
|
||||||
|
if (!accessToken)
|
||||||
|
accessToken = localStorage.getItem('accessToken') ?? undefined
|
||||||
|
|
||||||
|
if (accessToken) headers.Authorization = `Bearer ${accessToken}`
|
||||||
|
|
||||||
|
return headers
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user