@sasjs/adapter 4.7.0 → 4.9.0

package/README.md

@@ -151,7 +151,11 @@ The `request()` method also has optional parameters such as a config object and
 
 The response object will contain returned tables and columns.  Table names are always lowercase, and column names uppercase.
 
-The adapter will also cache the logs (if debug enabled) and even the work tables.  For performance, it is best to keep debug mode off.
+The adapter will also cache the logs (if debug enabled) and even the work tables. For performance, it is best to keep debug mode off.
+
+### Verbose Mode
+
+Set `verbose` to `true` to enable verbose mode that logs a summary of every HTTP response. Verbose mode can be disabled by calling `disableVerboseMode` method or enabled by `enableVerboseMode` method. Verbose mode also supports `bleached` mode that disables extra colors in req/res summary. To enable `bleached` verbose mode, pass `verbose` equal to `bleached` while instantiating an instance of `RequestClient` or to `setVerboseMode` method. Verbose mode can also be enabled/disabled by `startComputeJob` method.
 
 ### Session Manager
 
@@ -273,6 +277,7 @@ Configuration on the client side involves passing an object on startup, which ca
 * `serverType` - either `SAS9`, `SASVIYA` or `SASJS`.  The `SASJS` server type is for use with [sasjs/server](https://github.com/sasjs/server).
 * `serverUrl` - the location (including http protocol and port) of the SAS Server. Can be omitted, eg if serving directly from the SAS Web Server, or in streaming mode.
 * `debug` - if `true` then SAS Logs and extra debug information is returned.
+* `verbose` - optional, if `true` then a summary of every HTTP response is logged.
 * `loginMechanism` - either `Default` or `Redirected`.  See [SAS Logon](#sas-logon) section.
 * `useComputeApi` - Only relevant when the serverType is `SASVIYA`. If `true` the [Compute API](#using-the-compute-api) is used.  If `false` the [JES API](#using-the-jes-api) is used.  If `null` or `undefined` the [Web](#using-jes-web-app) approach is used.
 * `contextName` - Compute context on which the requests will be called.  If missing or not provided, defaults to `Job Execution Compute context`.

package/SASjs.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="node" />
-import { SASjsConfig, UploadFile, EditContextInput, PollOptions } from './types';
+import { SASjsConfig, UploadFile, EditContextInput, PollOptions, VerboseMode, LoginOptions, LoginResult, ExecutionQuery } from './types';
 import { SASViyaApiClient } from './SASViyaApiClient';
 import { SASjsAuthResponse } from './SASjsApiClient';
 import { MacroVar, AuthConfig, ExtraResponseAttributes, SasAuthResponse, AuthConfigSas9 } from '@sasjs/utils/types';
-import { LoginOptions, LoginResult } from './types/Login';
+import { AxiosResponse } from 'axios';
 interface ExecuteScriptParams {
     linesOfCode: string[];
     fileName?: string;
@@ -44,6 +44,17 @@ export default class SASjs {
      * @param debug - (optional) if true, global debug config will be overriden
      */
     executeScript({ linesOfCode, fileName, contextName, runTime, authConfig, authConfigSas9, debug }: ExecuteScriptParams): Promise<any>;
+    /**
+     * Executes job on SASJS server.
+     * @param query - an object containing job path and debug level.
+     * @param appLoc - an application path.
+     * @param authConfig - an object for authentication.
+     * @returns a promise that resolves into job execution result and log.
+     */
+    executeJob(query: ExecutionQuery, appLoc: string, authConfig?: AuthConfig): Promise<{
+        result: any;
+        log: any;
+    } | undefined>;
     /**
      * Gets compute contexts.
      * @param accessToken - an access token for an authorised user.
@@ -216,7 +227,7 @@ export default class SASjs {
      * Checks whether a session is active, or login is required.
      * @returns - a promise which resolves with an object containing two values - a boolean `isLoggedIn`, and a string `userName`.
      */
-    checkSession(): Promise<import("./types/Login").LoginResultInternal>;
+    checkSession(): Promise<import("./types").LoginResultInternal>;
     /**
      * Logs into the SAS server with the supplied credentials.
      * @param username - a string representing the username.
@@ -308,9 +319,9 @@ export default class SASjs {
      * @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 verboseMode - boolean to enable verbose mode (log every HTTP response).
+     * @param verboseMode - boolean or a string equal to 'bleached' to enable verbose mode (log every HTTP response).
      */
-    startComputeJob(sasJob: string, data: any, config?: any, authConfig?: AuthConfig, waitForResult?: boolean, pollOptions?: PollOptions, printPid?: boolean, variables?: MacroVar, verboseMode?: boolean): Promise<any>;
+    startComputeJob(sasJob: string, data: any, config?: any, authConfig?: AuthConfig, waitForResult?: boolean, pollOptions?: PollOptions, printPid?: boolean, variables?: MacroVar, verboseMode?: VerboseMode): Promise<any>;
     private resendWaitingRequests;
     /**
      * Fetches content of the log file
@@ -327,5 +338,20 @@ export default class SASjs {
     private setupConfiguration;
     private createFoldersAndServices;
     private isMethodSupported;
+    /**
+     * Enables verbose mode that will log a summary of every HTTP response.
+     * @param successCallBack - function that should be triggered on every HTTP response with the status 2**.
+     * @param errorCallBack - function that should be triggered on every HTTP response with the status different from 2**.
+     */
+    enableVerboseMode(successCallBack?: (response: AxiosResponse) => AxiosResponse, errorCallBack?: (response: AxiosResponse) => AxiosResponse): void;
+    /**
+     * Turns off verbose mode to log every HTTP response.
+     */
+    disableVerboseMode(): void;
+    /**
+     * Sets verbose mode.
+     * @param verboseMode - value of the verbose mode, can be true, false or bleached(without extra colors).
+     */
+    setVerboseMode: (verboseMode: VerboseMode) => void;
 }
 export {};