@sasjs/adapter 4.3.8 → 4.5.0

package/SASViyaApiClient.d.ts

@@ -2,6 +2,13 @@
 import { Job, Session, Context, ContextAllAttributes, Folder, File, EditContextInput, PollOptions } from './types';
 import { SasAuthResponse, MacroVar, AuthConfig } from '@sasjs/utils/types';
 import { RequestClient } from './request/RequestClient';
+interface JobExecutionResult {
+    result?: {
+        result: object;
+    };
+    log?: string;
+    error?: object;
+}
 /**
  * A client for interfacing with the SAS Viya REST API.
  *
@@ -126,7 +133,7 @@ export declare class SASViyaApiClient {
      * @param debug - when set to true, the log will be returned.
      * @param expectWebout - when set to true, the automatic _webout fileref will be checked for content, and that content returned. This fileref is used when the Job contains a SASjs web request (as opposed to executing arbitrary SAS code).
      * @param waitForResult - when set to true, function will return the session
-     * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.
+     * @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.
      */
@@ -206,7 +213,7 @@ export declare class SASViyaApiClient {
      * @param accessToken - an optional access token for an authorized user.
      * @param waitForResult - a boolean indicating if the function should wait for a result.
      * @param expectWebout - a boolean indicating whether to expect a _webout response.
-     * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.
+     * @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.
      */
@@ -219,10 +226,7 @@ export declare class SASViyaApiClient {
      * @param data - any data to be passed in as input to the job.
      * @param accessToken - an optional access token for an authorized user.
      */
-    executeJob(sasJob: string, contextName: string, debug: boolean, data?: any, authConfig?: AuthConfig): Promise<{
-        result: any;
-        log: any;
-    }>;
+    executeJob(sasJob: string, contextName: string, debug: boolean, data?: any, authConfig?: AuthConfig): Promise<JobExecutionResult>;
     private populateFolderMap;
     private pollJobState;
     private uploadTables;
@@ -263,3 +267,4 @@ export declare class SASViyaApiClient {
      */
     deleteFolder(folderPath: string, accessToken?: string): Promise<Folder | undefined>;
 }
+export {};

package/SASjs.d.ts

@@ -305,7 +305,7 @@ export default class SASjs {
      * @param authConfig - a valid client, secret, refresh and access tokens that are authorised to execute compute jobs.
      * The access token is not required when the user is authenticated via the browser.
      * @param waitForResult - a boolean that indicates whether the function needs to wait for execution to complete.
-     * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.
+     * @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.
      */

package/api/viya/executeScript.d.ts

@@ -12,7 +12,7 @@ import { SessionManager } from '../../SessionManager';
  * @param debug - when set to true, the log will be returned.
  * @param expectWebout - when set to true, the automatic _webout fileref will be checked for content, and that content returned. This fileref is used when the Job contains a SASjs web request (as opposed to executing arbitrary SAS code).
  * @param waitForResult - when set to true, function will return the session
- * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.
+ * @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.
  */

package/api/viya/pollJobState.d.ts

@@ -1,4 +1,36 @@
 import { AuthConfig } from '@sasjs/utils/types';
 import { Job, PollOptions } from '../..';
 import { RequestClient } from '../../request/RequestClient';
-export declare function pollJobState(requestClient: RequestClient, postedJob: Job, debug: boolean, authConfig?: AuthConfig, pollOptions?: PollOptions): Promise<string>;
+export declare enum JobState {
+    Completed = "completed",
+    Running = "running",
+    Pending = "pending",
+    Unavailable = "unavailable",
+    NoState = "",
+    Failed = "failed",
+    Error = "error"
+}
+/**
+ * Polls job status using default or provided poll options.
+ * @param requestClient - the pre-configured HTTP request client.
+ * @param postedJob - the relative or absolute path to the job.
+ * @param debug - sets the _debug flag in the job arguments.
+ * @param authConfig - an access token, refresh token, client and secret for an authorized user.
+ * @param pollOptions - an object containing maxPollCount, pollInterval, streamLog and logFolderPath. It will override the first default poll options in poll strategy if provided.
+ * Example pollOptions:
+ * {
+ *    maxPollCount: 200,
+ *    pollInterval: 300,
+ *    streamLog: true, // optional, equals to false by default.
+ *    pollStrategy?: // optional array of poll options that should be applied after 'maxPollCount' of the provided poll options is reached. If not provided the default (see example below) poll strategy will be used.
+ * }
+ * Example pollStrategy (values used from default poll strategy):
+ * [
+ *    { maxPollCount: 200, pollInterval: 300 }, // approximately ~2 mins (including time to get response (~300ms))
+ *    { maxPollCount: 300, pollInterval: 3000 }, // approximately ~5.5 mins (including time to get response (~300ms))
+ *    { 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))
+ * ]
+ * @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>;

package/auth/getAccessTokenForViya.d.ts

@@ -1,8 +1,8 @@
 import { SasAuthResponse } from '@sasjs/utils/types';
 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
+ * Exchange the auth code for access / refresh tokens for the given client / secret pair.
+ * @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 auth code received from the server.

package/auth/getTokenRequestErrorPrefix.d.ts

@@ -0,0 +1,44 @@
+import { ServerType } from '@sasjs/utils/types';
+declare type Server = ServerType.SasViya | ServerType.Sasjs;
+declare type Operation = 'fetching access token' | 'refreshing tokens';
+/**
+ * Forms error prefix for requests related to token operations.
+ * @param operation - string describing operation ('fetching access token' or 'refreshing tokens').
+ * @param funcName - name of the function sent the request.
+ * @param server - server type (SASVIYA or SASJS).
+ * @param url - endpoint used to send the request.
+ * @param data - request payload.
+ * @param headers - request headers.
+ * @param clientId - client ID to authenticate with.
+ * @param clientSecret - client secret to authenticate with.
+ * @returns - string containing request information. Example:
+ * Error while fetching access token from /SASLogon/oauth/token
+ * Thrown by the @sasjs/adapter getAccessTokenForViya function.
+ * Payload:
+ * {
+ *   "grant_type": "authorization_code",
+ *   "code": "example_code"
+ * }
+ * Headers:
+ * {
+ *   "Authorization": "Basic NEdMQXBwOjRHTEFwcDE=",
+ *   "Accept": "application/json"
+ * }
+ * ClientId: exampleClientId
+ * ClientSecret: exampleClientSecret
+ *
+ * Response from Viya is below.
+ * Auth error: {
+ *   "error": "invalid_token",
+ *   "error_description": "No scopes were granted"
+ * }
+ */
+export declare const getTokenRequestErrorPrefix: (operation: Operation, funcName: string, server: Server, url: string, data?: {}, headers?: {}, clientId?: string, clientSecret?: string) => string;
+/**
+ * Parse error prefix to get response payload.
+ * @param prefix - error prefix generated by getTokenRequestErrorPrefix function.
+ * @param server - server type (SASVIYA or SASJS).
+ * @returns - response payload.
+ */
+export declare const getTokenRequestErrorPrefixResponse: (prefix: string, server: ServerType.SasViya | ServerType.Sasjs) => string;
+export {};

package/auth/spec/getTokenRequestErrorPrefix.spec.d.ts

@@ -0,0 +1 @@
+export {};