@sasjs/adapter 4.2.4 → 4.3.1

package/node/SASViyaApiClient.d.ts

@@ -185,6 +185,7 @@ export declare class SASViyaApiClient {
     getAccessToken(clientId: string, clientSecret: string, authCode: string): Promise<SasAuthResponse>;
     /**
      * Exchanges the refresh token for an access token for the given client.
+     * This method can only be used by Node.
      * @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.

package/node/SessionManager.d.ts

@@ -8,18 +8,104 @@ export declare class SessionManager {
     constructor(serverUrl: string, contextName: string, requestClient: RequestClient);
     private sessions;
     private currentContext;
+    private settingContext;
     private _debug;
     private printedSessionState;
     get debug(): boolean;
     set debug(value: boolean);
-    getSession(accessToken?: string): Promise<Session | undefined>;
+    /**
+     * Checks if session is valid. Session is considered valid if time since it's creation is less than 'sessionInactiveTimeout' attribute.
+     * @param session - session object.
+     * @returns - boolean indicating if session is valid.
+     */
+    private isSessionValid;
+    /**
+     * Removes session from pool of hot sessions.
+     * @param session - session object.
+     * @returns - void.
+     */
+    private removeSessionFromPool;
+    /**
+     * Filters session pool to keep only valid sessions.
+     * @param session - session object.
+     * @returns - void.
+     */
+    private removeExpiredSessions;
+    /**
+     * Throws set of errors as a single error.
+     * @param errors - array of errors or string.
+     * @param prefix - an optional final error prefix.
+     * @returns - never.
+     */
+    private throwErrors;
+    /**
+     * Returns session.
+     * If there is a hot session available, it will be returned immediately and an asynchronous request to create new hot session will be submitted.
+     * If there is no available session, 2 session creation requests will be submitted. The session is returned once it is created and ready.
+     * @param accessToken - an optional access token.
+     * @returns - a promise which resolves with a session.
+     */
+    getSession(accessToken?: string): Promise<Session>;
+    /**
+     * Returns error message based on the response from SAS API.
+     * @param err - an optional access token.
+     * @param accessToken - an optional access token.
+     * @returns - an error message.
+     */
+    private getErrorMessage;
+    /**
+     * Deletes session.
+     * @param id - a session id.
+     * @param accessToken - an optional access token.
+     * @returns - a promise which resolves when session is deleted.
+     */
     clearSession(id: string, accessToken?: string): Promise<void>;
+    /**
+     * Creates sessions in amount equal to MAX_SESSION_COUNT.
+     * @param accessToken - an optional access token.
+     * @returns - a promise which resolves when required amount of sessions is created.
+     */
     private createSessions;
+    /**
+     * Waits for the current context to be set.
+     * @returns - a promise which resolves when current context is set.
+     */
+    private waitForCurrentContext;
+    /**
+     * Creates and waits for session to be ready.
+     * @param accessToken - an optional access token.
+     * @returns - a promise which resolves with a session.
+     */
     private createAndWaitForSession;
+    /**
+     * Sets current context.
+     * @param accessToken - an optional access token.
+     * @returns - a promise which resolves when current context is set.
+     */
     private setCurrentContext;
-    private getHeaders;
+    /**
+     * Waits for session to be ready.
+     * @param session - a session object.
+     * @param etag - an etag that can be a string or null.
+     * @param accessToken - an optional access token.
+     * @returns - a promise which resolves with a session state.
+     */
     private waitForSession;
+    /**
+     * Gets session state.
+     * @param url - a URL to get session state.
+     * @param etag - an etag string.
+     * @param accessToken - an optional access token.
+     * @returns - a promise which resolves with a result string and response status.
+     */
     private getSessionState;
+    /**
+     * Gets variable.
+     * @param sessionId - a session id.
+     * @param variable - a variable string.
+     * @param accessToken - an optional access token.
+     * @returns - a promise which resolves with a result that confirms to SessionVariable interface, etag string and status code.
+     */
     getVariable(sessionId: string, variable: string, accessToken?: string): Promise<{
         result: SessionVariable;
         etag: string;

package/node/auth/getTokens.d.ts

@@ -2,6 +2,7 @@ import { AuthConfig, ServerType } from '@sasjs/utils/types';
 import { RequestClient } from '../request/RequestClient';
 /**
  * Returns the auth configuration, refreshing the tokens if necessary.
+ * This function can only be used by Node, if a server type is SASVIYA.
  * @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

package/node/auth/refreshTokensForViya.d.ts

@@ -2,6 +2,7 @@ import { SasAuthResponse } from '@sasjs/utils/types';
 import { RequestClient } from '../request/RequestClient';
 /**
  * Exchanges the refresh token for an access token for the given client.
+ * This function can only be used by Node.
  * @param requestClient - the pre-configured HTTP request client
  * @param clientId - the client ID to authenticate with.
  * @param clientSecret - the client secret to authenticate with.