@sasjs/adapter 3.7.1 → 3.7.5

package/SASjs.d.ts

@@ -21,18 +21,18 @@ 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
+     * Executes code against 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 the sas code against SASViya server
+     * 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.
@@ -251,7 +251,8 @@ export default class SASjs {
         [key: string]: any;
     }, loginRequiredCallback?: () => any): Promise<unknown>;
     /**
-     * Makes a request to the SAS Service specified in `SASjob`. The response
+     * Makes a request to program specified in `SASjob` (could be a Viya Job, a
+     * SAS 9 Stored Process, or a SASjs Server Stored Program). The response
      * object will always contain table names in lowercase, and column names in
      * uppercase. Values are returned formatted by default, unformatted
      * values can be configured as an option in the `%webout` macro.
@@ -260,7 +261,8 @@ export default class SASjs {
      *  the SAS `_program` parameter to run a Job Definition or SAS 9 Stored
      *  Process). Is prepended at runtime with the value of `appLoc`.
      * @param data - a JSON object containing one or more tables to be sent to
-     * SAS. Can be `null` if no inputs required.
+     * SAS.  For an example of the table structure, see the project README. This
+     * value can be `null` if no inputs are required.
      * @param config - provide any changes to the config here, for instance to
      * enable/disable `debug`. Any change provided will override the global config,
      * for that particular function call.

package/file/generateFileUploadForm.d.ts

@@ -1 +1,11 @@
-export declare const generateFileUploadForm: (formData: FormData, data: any) => FormData;
+import * as NodeFormData from 'form-data';
+/**
+ * One of the approaches SASjs takes to send tables-formatted JSON (see README)
+ * to SAS is as multipart form data, where each table is provided as a specially
+ * formatted CSV file.
+ * @param formData Different objects are used depending on whether the adapter is
+ *  running in the browser, or in the CLI
+ * @param data Special, tables-formatted JSON (see README)
+ * @returns Populated formData
+ */
+export declare const generateFileUploadForm: (formData: FormData | NodeFormData, data: any) => FormData | NodeFormData;

package/file/generateTableUploadForm.d.ts

@@ -1,4 +1,5 @@
-export declare const generateTableUploadForm: (formData: FormData, data: any) => {
-    formData: FormData;
+import * as NodeFormData from 'form-data';
+export declare const generateTableUploadForm: (formData: FormData | NodeFormData, data: any) => {
+    formData: NodeFormData | FormData;
     requestParams: any;
 };