@sasjs/adapter 4.9.1 → 4.10.0

package/SessionManager.d.ts

@@ -5,6 +5,7 @@ export declare class SessionManager {
     private contextName;
     private requestClient;
     private loggedErrors;
+    private sessionStateLinkError;
     constructor(serverUrl: string, contextName: string, requestClient: RequestClient);
     private sessions;
     private currentContext;

package/api/viya/{executeScript.d.ts → executeOnComputeApi.d.ts}

@@ -3,7 +3,7 @@ import { PollOptions } from '../..';
 import { RequestClient } from '../../request/RequestClient';
 import { SessionManager } from '../../SessionManager';
 /**
- * Executes code on the current SAS Viya server.
+ * Executes SAS program on the current SAS Viya server using Compute API.
  * @param jobPath - the path to the file being submitted for execution.
  * @param linesOfCode - an array of code lines to execute.
  * @param contextName - the context to execute the code in.
@@ -16,4 +16,4 @@ import { SessionManager } from '../../SessionManager';
  * @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
  * @param variables - an object that represents macro variables.
  */
-export declare function executeScript(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): Promise<any>;

package/api/viya/pollJobState.d.ts

@@ -1,6 +1,7 @@
 import { AuthConfig } from '@sasjs/utils/types';
 import { Job, PollOptions } from '../..';
 import { RequestClient } from '../../request/RequestClient';
+import { WriteStream, JobSessionManager } from '../../types';
 export declare enum JobState {
     Completed = "completed",
     Running = "running",
@@ -31,6 +32,25 @@ export declare enum JobState {
  *    { maxPollCount: 500, pollInterval: 30000 }, // approximately ~50.5 mins (including time to get response (~300ms))
  *    { maxPollCount: 3400, pollInterval: 60000 } // approximately ~3015 mins (~125 hours) (including time to get response (~300ms))
  * ]
+ * @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): Promise<JobState>;
+export declare function pollJobState(requestClient: RequestClient, postedJob: Job, debug: boolean, authConfig?: AuthConfig, pollOptions?: PollOptions, jobSessionManager?: JobSessionManager): Promise<JobState>;
+/**
+ * Polls job state.
+ * @param requestClient - the pre-configured HTTP request client.
+ * @param postedJob - the relative or absolute path to the job.
+ * @param currentState - current job state.
+ * @param debug - sets the _debug flag in the job arguments.
+ * @param pollCount - current poll count.
+ * @param pollOptions - an object containing maxPollCount, pollInterval, streamLog and logFolderPath.
+ * @param authConfig - an access token, refresh token, client and secret for an authorized user.
+ * @param streamLog - indicates if job log should be streamed.
+ * @param logStream - job log stream.
+ * @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 const doPoll: (requestClient: RequestClient, postedJob: Job, currentState: JobState, debug: boolean, pollCount: number, pollOptions: PollOptions, authConfig?: AuthConfig, streamLog?: boolean, logStream?: WriteStream, jobSessionManager?: JobSessionManager) => Promise<{
+    state: JobState;
+    pollCount: number;
+}>;