@sasjs/adapter 3.1.0 → 3.3.1

package/node/SASViyaApiClient.d.ts

@@ -105,13 +105,7 @@ export declare class SASViyaApiClient {
      */
     editComputeContext(contextName: string, editedContext: EditContextInput, accessToken?: string): Promise<{
         result: Context;
-        etag: string; /**
-         * Creates a launcher context on the given server.
-         * @param contextName - the name of the context to be created.
-         * @param description - the description of the context to be created.
-         * @param launchType - launch type of the context to be created.
-         * @param accessToken - an access token for an authorized user.
-         */
+        etag: string;
     }>;
     /**
      * Deletes a compute context on the given server.
@@ -193,7 +187,7 @@ export declare class SASViyaApiClient {
      * 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 authCode - the refresh token received from the server.
+     * @param refreshToken - the refresh token received from the server.
      */
     refreshTokens(clientId: string, clientSecret: string, refreshToken: string): Promise<SasAuthResponse>;
     /**

package/node/SASjs.d.ts

@@ -1,7 +1,8 @@
 /// <reference types="node" />
 import { SASjsConfig, UploadFile, EditContextInput, PollOptions, FolderMember, ServiceMember, ExecutionQuery } from './types';
 import { SASViyaApiClient } from './SASViyaApiClient';
-import { MacroVar, AuthConfig, ExtraResponseAttributes } from '@sasjs/utils/types';
+import { SASjsAuthResponse } from './SASjsApiClient';
+import { MacroVar, AuthConfig, ExtraResponseAttributes, SasAuthResponse } from '@sasjs/utils/types';
 import { LoginOptions, LoginResult } from './types/Login';
 /**
  * SASjs is a JavaScript adapter for SAS.
@@ -12,7 +13,7 @@ export default class SASjs {
     private jobsPath;
     private sasViyaApiClient;
     private sas9ApiClient;
-    private SASjsApiClient;
+    private sasJSApiClient;
     private fileUploader;
     private authManager;
     private requestClient;
@@ -88,7 +89,11 @@ export default class SASjs {
      * @param accessToken - an access token for an authorized user.
      */
     deleteComputeContext(contextName: string, accessToken?: string): Promise<{
-        result: import("./types").Context;
+        result: import("./types").Context; /**
+         * Returns a JSON representation of a compute context.
+         * @param contextId - an id of the context to return.
+         * @param accessToken - an access token for an authorized user.
+         */
         etag: string;
     }>;
     /**
@@ -171,8 +176,14 @@ export default class SASjs {
      * @param clientSecret - the client secret to authenticate with.
      * @param authCode - the auth code received from the server.
      */
-    getAccessToken(clientId: string, clientSecret: string, authCode: string): Promise<import("@sasjs/utils/types").SasAuthResponse>;
-    refreshTokens(clientId: string, clientSecret: string, refreshToken: string): Promise<import("@sasjs/utils/types").SasAuthResponse>;
+    getAccessToken(clientId: string, clientSecret: string, authCode: string): Promise<SasAuthResponse | SASjsAuthResponse>;
+    /**
+     * 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.
+     */
+    refreshTokens(clientId: string, clientSecret: string, refreshToken: string): Promise<SasAuthResponse | SASjsAuthResponse>;
     deleteClient(clientId: string, accessToken: string): Promise<unknown>;
     /**
      * Returns the current SASjs configuration.
@@ -196,10 +207,9 @@ export default class SASjs {
     setDebugState(value: boolean): void;
     /**
      * 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`.
      */
-    checkSession(accessToken?: string): Promise<{
+    checkSession(): Promise<{
         isLoggedIn: boolean;
         userName: string;
         loginForm?: any;
@@ -208,14 +218,18 @@ export default class SASjs {
      * 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.
      */
-    logIn(username?: string, password?: string, options?: LoginOptions): Promise<LoginResult>;
+    logIn(username?: string, password?: string, clientId?: string, options?: LoginOptions): Promise<LoginResult>;
     /**
      * Logs out of the configured SAS server.
-     * @param accessToken - an optional access token is required for SASjs server type.
      */
-    logOut(accessToken?: string): Promise<boolean> | Promise<{
-        result: unknown;
+    logOut(): Promise<boolean | {
+        result: unknown; /**
+         * Returns a JSON representation of a compute context.
+         * @param contextId - an id of the context to return.
+         * @param accessToken - an access token for an authorized user.
+         */
         etag: string;
     }>;
     /**

package/node/SASjsApiClient.d.ts

@@ -17,4 +17,26 @@ export declare class SASjsApiClient {
         logPath?: string | undefined;
         error?: {} | undefined;
     }>;
+    /**
+     * 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.
+     */
+    getAccessToken(clientId: string, authCode: string): Promise<SASjsAuthResponse>;
+    /**
+     * Exchanges the refresh token for an access token.
+     * @param refreshToken - the refresh token received from the server.
+     */
+    refreshTokens(refreshToken: string): Promise<SASjsAuthResponse>;
+    /**
+     * 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.
+     */
+    getAuthCode(username: string, password: string, clientId: string): Promise<string>;
+}
+export interface SASjsAuthResponse {
+    access_token: string;
+    refresh_token: string;
 }

package/node/auth/AuthManager.d.ts

@@ -16,6 +16,14 @@ export declare class AuthManager {
      * And checks if user has finished login process.
      */
     redirectedLogIn({ onLoggedOut }: LoginOptions): Promise<LoginResult>;
+    /**
+     * 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`
+     */
+    logInSasjs(username: string, password: string, clientId: string): Promise<LoginResult>;
     /**
      * Logs into the SAS server with the supplied credentials.
      * @param username - a string representing the username.
@@ -25,15 +33,15 @@ export declare class AuthManager {
     logIn(username: string, password: string): Promise<LoginResult>;
     private performCASSecurityCheck;
     private sendLoginRequest;
+    private sendLoginRequestSasjs;
     /**
      * 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
      *  - a boolean `isLoggedIn`
      *  - a string `userName` and
      *  - a form `loginForm` if not loggedin.
      */
-    checkSession(accessToken?: string): Promise<{
+    checkSession(): Promise<{
         isLoggedIn: boolean;
         userName: string;
         loginForm?: any;
@@ -47,7 +55,7 @@ export declare class AuthManager {
      * Logs out of the configured SAS server.
      * @param accessToken - an optional access token is required for SASjs server type.
      */
-    logOut(accessToken?: string): Promise<boolean> | Promise<{
+    logOut(): Promise<boolean | {
         result: unknown;
         etag: string;
     }>;

package/node/auth/getAccessTokenForSasjs.d.ts

@@ -0,0 +1,11 @@
+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 declare function getAccessTokenForSasjs(requestClient: RequestClient, clientId: string, authCode: string): Promise<{
+    access_token: string;
+    refresh_token: string;
+}>;

package/node/auth/{getAccessToken.d.ts → getAccessTokenForViya.d.ts}

@@ -7,4 +7,4 @@ import { RequestClient } from '../request/RequestClient';
  * @param clientSecret - the client secret to authenticate with.
  * @param authCode - the auth code received from the server.
  */
-export declare function getAccessToken(requestClient: RequestClient, clientId: string, clientSecret: string, authCode: string): Promise<SasAuthResponse>;
+export declare function getAccessTokenForViya(requestClient: RequestClient, clientId: string, clientSecret: string, authCode: string): Promise<SasAuthResponse>;

package/node/auth/getAuthCodeForSasjs.d.ts

@@ -0,0 +1,9 @@
+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 declare const getAuthCodeForSasjs: (requestClient: RequestClient, username: string, password: string, clientId: string) => Promise<string>;

package/node/auth/getTokens.d.ts

@@ -1,8 +1,9 @@
-import { AuthConfig } from '@sasjs/utils/types';
+import { AuthConfig, ServerType } from '@sasjs/utils/types';
 import { RequestClient } from '../request/RequestClient';
 /**
  * Returns the auth configuration, refreshing the tokens if necessary.
  * @param requestClient - the pre-configured HTTP request client
  * @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 declare function getTokens(requestClient: RequestClient, authConfig: AuthConfig): Promise<AuthConfig>;
+export declare function getTokens(requestClient: RequestClient, authConfig: AuthConfig, serverType?: ServerType): Promise<AuthConfig>;

package/node/auth/refreshTokensForSasjs.d.ts

@@ -0,0 +1,10 @@
+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 declare function refreshTokensForSasjs(requestClient: RequestClient, refreshToken: string): Promise<{
+    access_token: string;
+    refresh_token: string;
+}>;

package/node/auth/{refreshTokens.d.ts → refreshTokensForViya.d.ts}

@@ -5,6 +5,6 @@ import { RequestClient } from '../request/RequestClient';
  * @param requestClient - the pre-configured HTTP request client
  * @param clientId - the client ID 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 declare function refreshTokens(requestClient: RequestClient, clientId: string, clientSecret: string, refreshToken: string): Promise<SasAuthResponse>;
+export declare function refreshTokensForViya(requestClient: RequestClient, clientId: string, clientSecret: string, refreshToken: string): Promise<SasAuthResponse>;