@sasjs/adapter 4.17.2 → 4.18.0

package/node/SASViyaApiClient.d.ts

@@ -2,6 +2,7 @@
 import { Job, Session, Context, ContextAllAttributes, Folder, File, EditContextInput, PollOptions } from './types';
 import { SasAuthResponse, MacroVar, AuthConfig } from '@sasjs/utils/types';
 import { RequestClient } from './request/RequestClient';
+import { OnTokensRefreshed } from './auth/getTokens';
 import { FileResource } from './types/FileResource';
 interface JobExecutionResult {
     result?: {
@@ -74,10 +75,6 @@ export declare class SASViyaApiClient {
     getLauncherContexts(accessToken?: string): Promise<{
         createdBy: any;
         id: any;
-        /**
-         * A client for interfacing with the SAS Viya REST API.
-         *
-         */
         name: any;
         version: any;
         attributes: {};
@@ -143,8 +140,9 @@ export declare class SASViyaApiClient {
      * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { maxPollCount: 24 * 60 * 60, pollInterval: 1000 }. More information available at src/api/viya/pollJobState.ts.
      * @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
      * @param variables - an object that represents macro variables.
+     * @param onTokensRefreshed - optional callback invoked with the rotated token pair after a successful internal refresh, so consumers that persist tokens can store the new pair.
      */
-    executeScript(jobPath: string, linesOfCode: string[], contextName: string, authConfig?: AuthConfig, data?: null, debug?: boolean, expectWebout?: boolean, waitForResult?: boolean, pollOptions?: PollOptions, printPid?: boolean, variables?: MacroVar): Promise<any>;
+    executeScript(jobPath: string, linesOfCode: string[], contextName: string, authConfig?: AuthConfig, data?: null, debug?: boolean, expectWebout?: boolean, waitForResult?: boolean, pollOptions?: PollOptions, printPid?: boolean, variables?: MacroVar, onTokensRefreshed?: OnTokensRefreshed): Promise<any>;
     /**
      * Fetches the file content for a file in the specified folder.
      *
@@ -241,7 +239,7 @@ export declare class SASViyaApiClient {
      * @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
      * @param variables - an object that represents macro variables.
      */
-    executeComputeJob(sasJob: string, contextName: string, debug?: boolean, data?: any, authConfig?: AuthConfig, waitForResult?: boolean, expectWebout?: boolean, pollOptions?: PollOptions, printPid?: boolean, variables?: MacroVar): Promise<any>;
+    executeComputeJob(sasJob: string, contextName: string, debug?: boolean, data?: any, authConfig?: AuthConfig, waitForResult?: boolean, expectWebout?: boolean, pollOptions?: PollOptions, printPid?: boolean, variables?: MacroVar, onTokensRefreshed?: OnTokensRefreshed): Promise<any>;
     /**
      * Executes a job via the SAS Viya Job Execution API
      * @param sasJob - the relative or absolute path to the job.
@@ -249,8 +247,9 @@ export declare class SASViyaApiClient {
      * @param debug - sets the _debug flag in the job arguments.
      * @param data - any data to be passed in as input to the job.
      * @param accessToken - an optional access token for an authorized user.
+     * @param onTokensRefreshed - optional callback invoked with the rotated token pair after a successful internal refresh, so consumers that persist tokens can store the new pair.
      */
-    executeJob(sasJob: string, contextName: string, debug: boolean, data?: any, authConfig?: AuthConfig): Promise<JobExecutionResult>;
+    executeJob(sasJob: string, contextName: string, debug: boolean, data?: any, authConfig?: AuthConfig, onTokensRefreshed?: OnTokensRefreshed): Promise<JobExecutionResult>;
     private populateFolderMap;
     private pollJobState;
     private uploadTables;

package/node/SASjs.d.ts

@@ -2,6 +2,7 @@
 import { SASjsConfig, UploadFile, EditContextInput, PollOptions, VerboseMode, LoginOptions, LoginResult, ExecutionQuery, Tables } from './types';
 import { SASViyaApiClient } from './SASViyaApiClient';
 import { SASjsAuthResponse } from './SASjsApiClient';
+import { OnTokensRefreshed } from './auth/getTokens';
 import { MacroVar, AuthConfig, ExtraResponseAttributes, SasAuthResponse, AuthConfigSas9 } from '@sasjs/utils/types';
 import { AxiosResponse, AxiosError } from 'axios';
 interface ExecuteScriptParams {
@@ -12,6 +13,7 @@ interface ExecuteScriptParams {
     authConfig?: AuthConfig;
     authConfigSas9?: AuthConfigSas9;
     debug?: boolean;
+    onTokensRefreshed?: OnTokensRefreshed;
 }
 /**
  * SASjs is a JavaScript adapter for SAS.
@@ -42,8 +44,9 @@ export default class SASjs {
      * @param authConfig - (optional) a valid client, secret, refresh and access tokens that are authorised to execute scripts.
      * @param authConfigSas9 - (required for server type sas9) a valid username and password that are authorised to execute scripts.
      * @param debug - (optional) if true, global debug config will be overriden
+     * @param onTokensRefreshed - (optional, SAS Viya only) callback invoked with the rotated token pair after a successful internal refresh, so consumers that persist tokens can store the new pair.
      */
-    executeScript({ linesOfCode, fileName, contextName, runTime, authConfig, authConfigSas9, debug }: ExecuteScriptParams): Promise<any>;
+    executeScript({ linesOfCode, fileName, contextName, runTime, authConfig, authConfigSas9, debug, onTokensRefreshed }: ExecuteScriptParams): Promise<any>;
     /**
      * Executes job on SASJS server.
      * @param query - an object containing job path and debug level.

package/node/api/viya/executeOnComputeApi.d.ts

@@ -1,5 +1,6 @@
 import { AuthConfig, MacroVar } from '@sasjs/utils/types';
 import { PollOptions } from '../..';
+import { OnTokensRefreshed } from '../../auth/getTokens';
 import { RequestClient } from '../../request/RequestClient';
 import { SessionManager } from '../../SessionManager';
 /**
@@ -15,5 +16,6 @@ import { SessionManager } from '../../SessionManager';
  * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { maxPollCount: 24 * 60 * 60, pollInterval: 1000 }. More information available at src/api/viya/pollJobState.ts.
  * @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
  * @param variables - an object that represents macro variables.
+ * @param onTokensRefreshed - optional callback invoked with the rotated token pair after a successful internal refresh, so consumers that persist tokens can store the new pair.
  */
-export declare function executeOnComputeApi(requestClient: RequestClient, sessionManager: SessionManager, rootFolderName: string, jobPath: string, linesOfCode: string[], contextName: string, authConfig?: AuthConfig, data?: any, debug?: boolean, expectWebout?: boolean, waitForResult?: boolean, pollOptions?: PollOptions, printPid?: boolean, variables?: MacroVar): Promise<any>;
+export declare function executeOnComputeApi(requestClient: RequestClient, sessionManager: SessionManager, rootFolderName: string, jobPath: string, linesOfCode: string[], contextName: string, authConfig?: AuthConfig, data?: any, debug?: boolean, expectWebout?: boolean, waitForResult?: boolean, pollOptions?: PollOptions, printPid?: boolean, variables?: MacroVar, onTokensRefreshed?: OnTokensRefreshed): Promise<any>;

package/node/api/viya/pollJobState.d.ts

@@ -1,5 +1,6 @@
 import { AuthConfig } from '@sasjs/utils/types';
 import { Job, PollOptions } from '../..';
+import { OnTokensRefreshed } from '../../auth/getTokens';
 import { RequestClient } from '../../request/RequestClient';
 import { WriteStream, JobSessionManager } from '../../types';
 export declare enum JobState {
@@ -35,7 +36,7 @@ export declare enum JobState {
  * @param jobSessionManager - job session object containing session object and an instance of Session Manager. Job session object is used to periodically (every 10th job state poll) check parent session state.
  * @returns - a promise which resolves with a job state
  */
-export declare function pollJobState(requestClient: RequestClient, postedJob: Job, debug: boolean, authConfig?: AuthConfig, pollOptions?: PollOptions, jobSessionManager?: JobSessionManager): Promise<JobState>;
+export declare function pollJobState(requestClient: RequestClient, postedJob: Job, debug: boolean, authConfig?: AuthConfig, pollOptions?: PollOptions, jobSessionManager?: JobSessionManager, onTokensRefreshed?: OnTokensRefreshed): Promise<JobState>;
 /**
  * Polls job state.
  * @param requestClient - the pre-configured HTTP request client.
@@ -50,7 +51,7 @@ export declare function pollJobState(requestClient: RequestClient, postedJob: Jo
  * @param jobSessionManager - job session object containing session object and an instance of Session Manager. Job session object is used to periodically (every 10th job state poll) check parent session state. Session state is considered healthy if it is equal to 'running' or 'idle'.
  * @returns - a promise which resolves with a job state
  */
-export declare const doPoll: (requestClient: RequestClient, postedJob: Job, currentState: JobState, debug: boolean, pollCount: number, pollOptions: PollOptions, authConfig?: AuthConfig, streamLog?: boolean, logStream?: WriteStream, jobSessionManager?: JobSessionManager) => Promise<{
+export declare const doPoll: (requestClient: RequestClient, postedJob: Job, currentState: JobState, debug: boolean, pollCount: number, pollOptions: PollOptions, authConfig?: AuthConfig, streamLog?: boolean, logStream?: WriteStream, jobSessionManager?: JobSessionManager, onTokensRefreshed?: OnTokensRefreshed) => Promise<{
     state: JobState;
     pollCount: number;
 }>;

package/node/auth/getTokens.d.ts

@@ -1,10 +1,22 @@
 import { AuthConfig, ServerType } from '@sasjs/utils/types';
 import { RequestClient } from '../request/RequestClient';
+/**
+ * Callback invoked with the rotated token pair after a successful internal
+ * refresh. Viya refresh tokens are single-use/rotating, so consumers that
+ * persist tokens (e.g. the CLI writing `.env.{target}`) should pass a handler
+ * wherever this is accepted to avoid the persisted pair going stale.
+ */
+export type OnTokensRefreshed = (tokens: {
+    access_token: string;
+    refresh_token: string;
+}) => void | Promise<void>;
 /**
  * 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
+ * @param onTokensRefreshed - optional callback invoked with the rotated token
+ * pair after a successful internal refresh.
  */
-export declare function getTokens(requestClient: RequestClient, authConfig: AuthConfig, serverType?: ServerType): Promise<AuthConfig>;
+export declare function getTokens(requestClient: RequestClient, authConfig: AuthConfig, serverType?: ServerType, onTokensRefreshed?: OnTokensRefreshed): Promise<AuthConfig>;

package/node/index.d.ts

@@ -5,4 +5,5 @@ export * from './SASViyaApiClient';
 export * from './SAS9ApiClient';
 export * from './SASjsApiClient';
 export * from './request/SasjsRequestClient';
+export type { OnTokensRefreshed } from './auth/getTokens';
 export default SASjs;