@sasjs/adapter 3.10.18 → 4.0.0

package/node/SASjs.d.ts

@@ -1,9 +1,18 @@
 /// <reference types="node" />
-import { SASjsConfig, UploadFile, EditContextInput, PollOptions, ExecutionQuery } from './types';
+import { SASjsConfig, UploadFile, EditContextInput, PollOptions } from './types';
 import { SASViyaApiClient } from './SASViyaApiClient';
 import { SASjsAuthResponse } from './SASjsApiClient';
-import { MacroVar, AuthConfig, ExtraResponseAttributes, SasAuthResponse, ServicePackSASjs } from '@sasjs/utils/types';
+import { MacroVar, AuthConfig, ExtraResponseAttributes, SasAuthResponse, AuthConfigSas9 } from '@sasjs/utils/types';
 import { LoginOptions, LoginResult } from './types/Login';
+interface ExecuteScriptParams {
+    linesOfCode: string[];
+    fileName?: string;
+    contextName?: string;
+    runTime?: string;
+    authConfig?: AuthConfig;
+    authConfigSas9?: AuthConfigSas9;
+    debug?: boolean;
+}
 /**
  * SASjs is a JavaScript adapter for SAS.
  *
@@ -25,28 +34,16 @@ export default class SASjs {
     constructor(config?: Partial<SASjsConfig>);
     getCsrfToken(type?: 'general' | 'file'): import("./types").CsrfToken | undefined;
     /**
-     * Executes SAS code on a SAS 9 server.  Requires a runner to be present in
-     * the users home directory in metadata.
-     * @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 SAS code on a SASJS server
-     * @param code - a string of code from the file to run.
+     * Executes code on a SAS server.
+     * @param linesOfCode - lines of code to run.
+     * @param fileName - (required for server type sas viya) name of the file to run. It will be converted to path to the file being submitted for execution.
+     * @param contextName - (required for server type sas viya) context name on which code will be run on the server.
+     * @param runTime - (required for server type sasjs) a string to represent runTime for code execution.
      * @param authConfig - (optional) a valid client, secret, refresh and access tokens that are authorised to execute scripts.
-     */
-    executeScriptSASjs(code: string, runTime?: string, authConfig?: AuthConfig): Promise<string | undefined>;
-    /**
-     * Executes sas code in a SAS Viya compute session.
-     * @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 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
      */
-    executeScriptSASViya(fileName: string, linesOfCode: string[], contextName: string, authConfig?: AuthConfig, debug?: boolean): Promise<any>;
+    executeScript({ linesOfCode, fileName, contextName, runTime, authConfig, authConfigSas9, debug }: ExecuteScriptParams): Promise<any>;
     /**
      * Gets compute contexts.
      * @param accessToken - an access token for an authorised user.
@@ -294,24 +291,6 @@ 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>;
-    /**
-     * Creates the folders and services at the given location `appLoc` on the given server `serverUrl`.
-     * @param dataJson - the JSON specifying the folders and files to be created, can also includes
-     * appLoc, streamServiceName, streamWebFolder, streamLogo
-     * @param appLoc - (optional) the base folder in which to create the new folders and
-     * services.  If not provided, is taken from SASjsConfig. Precedence will be of appLoc present in dataJson.
-     * @param authConfig - (optional) a valid client, secret, refresh and access tokens that are authorised to execute compute jobs.
-     */
-    deployToSASjs(dataJson: ServicePackSASjs, appLoc?: string, authConfig?: AuthConfig): Promise<{
-        status: string;
-        message: string;
-        streamServiceName?: string | undefined;
-        example?: {} | undefined;
-    } | undefined>;
-    executeJobSASjs(query: ExecutionQuery, authConfig?: AuthConfig): Promise<{
-        result: any;
-        log: any;
-    } | undefined>;
     /**
      * Kicks off execution of the given job via the compute API.
      * @returns an object representing the compute session created for the given job.
@@ -348,3 +327,4 @@ export default class SASjs {
     private createFoldersAndServices;
     private isMethodSupported;
 }
+export {};

package/node/SASjsApiClient.d.ts

@@ -4,6 +4,13 @@ import { RequestClient } from './request/RequestClient';
 export declare class SASjsApiClient {
     private requestClient;
     constructor(requestClient: RequestClient);
+    /**
+     * Creates the folders and services at the given location `appLoc` on the given server `serverUrl`.
+     * @param dataJson - the JSON specifying the folders and files to be created, can also includes
+     * appLoc, streamServiceName, streamWebFolder, streamLogo
+     * @param appLoc - the base folder in which to create the new folders and services.
+     * @param authConfig - (optional) a valid client, secret, refresh and access tokens that are authorised to execute compute jobs.
+     */
     deploy(dataJson: ServicePackSASjs, appLoc: string, authConfig?: AuthConfig): Promise<{
         status: string;
         message: string;

package/node/index.d.ts

@@ -3,4 +3,6 @@ export * from './types';
 export * from './types/errors';
 export * from './SASViyaApiClient';
 export * from './SAS9ApiClient';
+export * from './SASjsApiClient';
+export * from './request/SasjsRequestClient';
 export default SASjs;