@sasjs/adapter 3.4.1 → 3.6.0

package/SASjs.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { SASjsConfig, UploadFile, EditContextInput, PollOptions, FolderMember, ServiceMember, ExecutionQuery } from './types';
+import { SASjsConfig, UploadFile, EditContextInput, PollOptions, ExecutionQuery, FileTree } from './types';
 import { SASViyaApiClient } from './SASViyaApiClient';
 import { SASjsAuthResponse } from './SASjsApiClient';
 import { MacroVar, AuthConfig, ExtraResponseAttributes, SasAuthResponse } from '@sasjs/utils/types';
@@ -21,9 +21,25 @@ export default class SASjs {
     private computeJobExecutor;
     private jesJobExecutor;
     private sas9JobExecutor;
+    private sasJsJobExecutor;
     constructor(config?: Partial<SASjsConfig>);
     getCsrfToken(type?: 'general' | 'file'): import("./types").CsrfToken | undefined;
+    /**
+     * Executes the sas code against SAS9 server
+     * @param linesOfCode - lines of sas code from the file to run.
+     * @param username - a string representing the username.
+     * @param password - a string representing the password.
+     */
     executeScriptSAS9(linesOfCode: string[], userName: string, password: string): Promise<string | undefined>;
+    /**
+     * Executes the sas code against SASViya server
+     * @param fileName - name of the file to run. It will be converted to path to the file being submitted for execution.
+     * @param linesOfCode - lines of sas code from the file to run.
+     * @param contextName - context name on which code will be run on the server.
+     * @param authConfig - (optional) the access token, refresh token, client and secret for authorizing the request.
+     * @param debug - (optional) if true, global debug config will be overriden
+     */
+    executeScriptSASViya(fileName: string, linesOfCode: string[], contextName: string, authConfig?: AuthConfig, debug?: boolean): Promise<any>;
     /**
      * Gets compute contexts.
      * @param accessToken - an access token for an authorized user.
@@ -89,11 +105,7 @@ export default class SASjs {
      * @param accessToken - an access token for an authorized user.
      */
     deleteComputeContext(contextName: string, accessToken?: string): Promise<{
-        result: import("./types").Context; /**
-         * Returns a JSON representation of a compute context.
-         * @param contextId - an id of the context to return.
-         * @param accessToken - an access token for an authorized user.
-         */
+        result: import("./types").Context;
         etag: string;
     }>;
     /**
@@ -110,15 +122,6 @@ export default class SASjs {
      */
     getComputeContextById(contextId: string, accessToken?: string): Promise<import("./types").ContextAllAttributes>;
     createSession(contextName: string, accessToken: string): Promise<import("./types").Session>;
-    /**
-     * Executes the sas code against given sas server
-     * @param fileName - name of the file to run. It will be converted to path to the file being submitted for execution.
-     * @param linesOfCode - lines of sas code from the file to run.
-     * @param contextName - context name on which code will be run on the server.
-     * @param authConfig - (optional) the access token, refresh token, client and secret for authorizing the request.
-     * @param debug - (optional) if true, global debug config will be overriden
-     */
-    executeScriptSASViya(fileName: string, linesOfCode: string[], contextName: string, authConfig?: AuthConfig, debug?: boolean): Promise<any>;
     /**
      * Creates a folder in the logical SAS folder tree
      * @param folderName - name of the folder to be created.
@@ -225,11 +228,7 @@ export default class SASjs {
      * Logs out of the configured SAS server.
      */
     logOut(): Promise<boolean | {
-        result: unknown; /**
-         * Returns a JSON representation of a compute context.
-         * @param contextId - an id of the context to return.
-         * @param accessToken - an access token for an authorized user.
-         */
+        result: unknown;
         etag: string;
     }>;
     /**
@@ -307,7 +306,14 @@ export default class SASjs {
      * @param isForced - flag that indicates if target folder already exists, it and all subfolders have to be deleted.
      */
     deployServicePack(serviceJson: any, appLoc?: string, serverUrl?: string, accessToken?: string, isForced?: boolean): Promise<void>;
-    deployToSASjs(members: [FolderMember, ServiceMember]): Promise<{
+    /**
+     * Creates the folders and services at the given location `appLoc` on the given server `serverUrl`.
+     * @param members - the JSON specifying the folders and services to be created.
+     * @param appLoc - the base folder in which to create the new folders and
+     * services.  If not provided, is taken from SASjsConfig.
+     * @param authConfig - a valid client, secret, refresh and access tokens that are authorised to execute compute jobs.
+     */
+    deployToSASjs(members: FileTree, appLoc?: string, authConfig?: AuthConfig): Promise<{
         status: string;
         message: string;
         example?: {} | undefined;
@@ -318,6 +324,7 @@ export default class SASjs {
         log?: string | undefined;
         logPath?: string | undefined;
         error?: {} | undefined;
+        _webout?: string | undefined;
     } | undefined>;
     /**
      * Kicks off execution of the given job via the compute API.

package/SASjsApiClient.d.ts

@@ -1,11 +1,12 @@
-import { FolderMember, ServiceMember, ExecutionQuery } from './types';
+import { AuthConfig } from '@sasjs/utils/types';
+import { FileTree, ExecutionQuery } from './types';
 import { RequestClient } from './request/RequestClient';
 export declare class SASjsApiClient {
     private serverUrl;
     private requestClient;
     constructor(serverUrl: string, requestClient: RequestClient);
     setConfig(serverUrl: string): void;
-    deploy(members: [FolderMember, ServiceMember], appLoc: string): Promise<{
+    deploy(members: FileTree, appLoc: string, authConfig?: AuthConfig): Promise<{
         status: string;
         message: string;
         example?: {} | undefined;
@@ -16,6 +17,7 @@ export declare class SASjsApiClient {
         log?: string | undefined;
         logPath?: string | undefined;
         error?: {} | undefined;
+        _webout?: string | undefined;
     }>;
     /**
      * Exchanges the auth code for an access token for the given client.

package/api/viya/spec/writeStream.spec.d.ts

@@ -1 +1 @@
-import 'jest-extended';
+export {};