@sasjs/adapter 3.3.1 → 3.5.0

package/node/utils/convertToCsv.d.ts

@@ -2,4 +2,8 @@
  * Converts the given JSON object array to a CSV string.
  * @param data - the array of JSON objects to convert.
  */
-export declare const convertToCSV: (data: any) => string;
+export declare const convertToCSV: (data: any, sasFormats?: {
+    formats: {
+        [key: string]: string;
+    };
+} | undefined) => string;

package/node/utils/createAxiosInstance.d.ts

@@ -1,3 +1,2 @@
-/// <reference types="node" />
 import * as https from 'https';
 export declare const createAxiosInstance: (baseURL: string, httpsAgent?: https.Agent | undefined) => import("axios").AxiosInstance;

package/package.json

@@ -40,45 +40,45 @@
   },
   "license": "ISC",
   "devDependencies": {
-    "@types/axios": "^0.14.0",
-    "@types/express": "^4.17.13",
-    "@types/form-data": "^2.5.0",
-    "@types/jest": "^27.0.2",
-    "@types/mime": "^2.0.3",
-    "@types/pem": "^1.9.6",
-    "@types/tough-cookie": "^4.0.1",
-    "copyfiles": "^2.4.1",
-    "cp": "^0.2.0",
-    "dotenv": "^10.0.0",
-    "express": "^4.17.1",
-    "jest": "^27.2.0",
-    "jest-extended": "^0.11.5",
-    "node-polyfill-webpack-plugin": "^1.1.4",
-    "path": "^0.12.7",
-    "pem": "^1.14.4",
-    "process": "^0.11.10",
-    "rimraf": "^3.0.2",
-    "semantic-release": "^18.0.0",
-    "terser-webpack-plugin": "^5.2.4",
-    "ts-jest": "^27.0.3",
-    "ts-loader": "^9.2.6",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
-    "typedoc": "0.19.2",
-    "typedoc-neo-theme": "^1.1.1",
-    "typedoc-plugin-external-module-name": "^4.0.6",
-    "typescript": "4.3.5",
-    "webpack": "^5.56.0",
-    "webpack-cli": "^4.7.2"
+    "@types/axios": "0.14.0",
+    "@types/express": "4.17.13",
+    "@types/form-data": "2.5.0",
+    "@types/jest": "27.0.2",
+    "@types/mime": "2.0.3",
+    "@types/pem": "1.9.6",
+    "@types/tough-cookie": "4.0.1",
+    "copyfiles": "2.4.1",
+    "cp": "0.2.0",
+    "dotenv": "10.0.0",
+    "express": "4.17.1",
+    "jest": "27.4.7",
+    "jest-extended": "2.0.0",
+    "node-polyfill-webpack-plugin": "1.1.4",
+    "path": "0.12.7",
+    "pem": "1.14.4",
+    "process": "0.11.10",
+    "rimraf": "3.0.2",
+    "semantic-release": "18.0.0",
+    "terser-webpack-plugin": "5.3.0",
+    "ts-jest": "27.1.3",
+    "ts-loader": "9.2.6",
+    "tslint": "6.1.3",
+    "tslint-config-prettier": "1.18.0",
+    "typedoc": "0.22.11",
+    "typedoc-neo-theme": "1.1.1",
+    "typedoc-plugin-external-module-name": "4.0.6",
+    "typescript": "4.5.4",
+    "webpack": "5.66.0",
+    "webpack-cli": "4.7.2"
   },
   "main": "index.js",
   "dependencies": {
-    "@sasjs/utils": "^2.32.0",
-    "axios": "^0.21.4",
-    "axios-cookiejar-support": "^1.0.1",
-    "form-data": "^4.0.0",
-    "https": "^1.0.0",
-    "tough-cookie": "^4.0.0"
+    "@sasjs/utils": "2.35.0",
+    "axios": "0.26.0",
+    "axios-cookiejar-support": "2.0.3",
+    "form-data": "4.0.0",
+    "https": "1.0.0",
+    "tough-cookie": "4.0.0"
   },
-  "version": "3.3.1"
+  "version": "3.5.0"
 }

package/src/SASjs.ts

@@ -5,9 +5,8 @@ import {
   EditContextInput,
   PollOptions,
   LoginMechanism,
-  FolderMember,
-  ServiceMember,
-  ExecutionQuery
+  ExecutionQuery,
+  FileTree
 } from './types'
 import { SASViyaApiClient } from './SASViyaApiClient'
 import { SAS9ApiClient } from './SAS9ApiClient'
@@ -736,15 +735,19 @@ export default class SASjs {
     msg: string
   } {
     if (data === null) return { status: true, msg: '' }
+
+    const isSasFormatsTable = (key: string) =>
+      key.match(/^\$.*/) && Object.keys(data).includes(key.replace(/^\$/, ''))
+
     for (const key in data) {
-      if (!key.match(/^[a-zA-Z_]/)) {
+      if (!key.match(/^[a-zA-Z_]/) && !isSasFormatsTable(key)) {
         return {
           status: false,
           msg: 'First letter of table should be alphabet or underscore.'
         }
       }
 
-      if (!key.match(/^[a-zA-Z_][a-zA-Z0-9_]*$/)) {
+      if (!key.match(/^[a-zA-Z_][a-zA-Z0-9_]*$/) && !isSasFormatsTable(key)) {
         return { status: false, msg: 'Table name should be alphanumeric.' }
       }
 
@@ -755,7 +758,7 @@ export default class SASjs {
         }
       }
 
-      if (this.getType(data[key]) !== 'Array') {
+      if (this.getType(data[key]) !== 'Array' && !isSasFormatsTable(key)) {
         return {
           status: false,
           msg: 'Parameter data contains invalid table structure.'
@@ -771,6 +774,7 @@ export default class SASjs {
         }
       }
     }
+
     return { status: true, msg: '' }
   }
 
@@ -860,8 +864,22 @@ export default class SASjs {
     )
   }
 
-  public async deployToSASjs(members: [FolderMember, ServiceMember]) {
-    return await this.sasJSApiClient?.deploy(members, this.sasjsConfig.appLoc)
+  /**
+   * 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.
+   */
+  public async deployToSASjs(
+    members: FileTree,
+    appLoc?: string,
+    authConfig?: AuthConfig
+  ) {
+    if (!appLoc) {
+      appLoc = this.sasjsConfig.appLoc
+    }
+    return await this.sasJSApiClient?.deploy(members, appLoc, authConfig)
   }
 
   public async executeJobSASjs(query: ExecutionQuery) {

package/src/SASjsApiClient.ts

@@ -1,8 +1,11 @@
-import { FolderMember, ServiceMember, ExecutionQuery } from './types'
+import { AuthConfig, ServerType } from '@sasjs/utils/types'
+import { FileTree, ExecutionQuery } from './types'
 import { RequestClient } from './request/RequestClient'
 import { getAccessTokenForSasjs } from './auth/getAccessTokenForSasjs'
 import { refreshTokensForSasjs } from './auth/refreshTokensForSasjs'
 import { getAuthCodeForSasjs } from './auth/getAuthCodeForSasjs'
+import { parseWeboutResponse } from './utils'
+import { getTokens } from './auth/getTokens'
 
 export class SASjsApiClient {
   constructor(
@@ -14,7 +17,19 @@ export class SASjsApiClient {
     if (serverUrl) this.serverUrl = serverUrl
   }
 
-  public async deploy(members: [FolderMember, ServiceMember], appLoc: string) {
+  public async deploy(
+    members: FileTree,
+    appLoc: string,
+    authConfig?: AuthConfig
+  ) {
+    let access_token = (authConfig || {}).access_token
+    if (authConfig) {
+      ;({ access_token } = await getTokens(
+        this.requestClient,
+        authConfig,
+        ServerType.Sasjs
+      ))
+    }
     const { result } = await this.requestClient.post<{
       status: string
       message: string
@@ -22,7 +37,7 @@ export class SASjsApiClient {
     }>(
       'SASjsApi/drive/deploy',
       { fileTree: members, appLoc: appLoc },
-      undefined
+      access_token
     )
 
     return Promise.resolve(result)
@@ -35,8 +50,13 @@ export class SASjsApiClient {
       log?: string
       logPath?: string
       error?: {}
+      _webout?: string
     }>('SASjsApi/stp/execute', query, undefined)
 
+    if (Object.keys(result).includes('_webout')) {
+      result._webout = parseWeboutResponse(result._webout!)
+    }
+
     return Promise.resolve(result)
   }
 

package/src/api/viya/executeScript.ts

@@ -272,7 +272,13 @@ export async function executeScript(
 
     return { result: jobResult?.result, log }
   } catch (e) {
-    if (e && e.status === 404) {
+    interface HttpError {
+      status: number
+    }
+
+    const error = e as HttpError
+
+    if (error.status === 404) {
       return executeScript(
         requestClient,
         sessionManager,
@@ -287,7 +293,7 @@ export async function executeScript(
         true
       )
     } else {
-      throw prefixMessage(e, 'Error while executing script. ')
+      throw prefixMessage(e as Error, 'Error while executing script. ')
     }
   }
 }

package/src/api/viya/writeStream.ts

@@ -3,13 +3,9 @@ import { WriteStream } from '../../types'
 export const writeStream = async (
   stream: WriteStream,
   content: string
-): Promise<void> => {
-  return new Promise((resolve, reject) => {
-    stream.write(content + '\n', (e) => {
-      if (e) {
-        return reject(e)
-      }
-      return resolve()
-    })
+): Promise<void> =>
+  stream.write(content + '\n', (e) => {
+    if (e) return Promise.reject(e)
+
+    return Promise.resolve()
   })
-}

package/src/request/Sas9RequestClient.ts

@@ -1,6 +1,6 @@
 import * as https from 'https'
 import { AxiosRequestConfig } from 'axios'
-import axiosCookieJarSupport from 'axios-cookiejar-support'
+import * as axiosCookieJarSupport from 'axios-cookiejar-support'
 import * as tough from 'tough-cookie'
 import { prefixMessage } from '@sasjs/utils/error'
 import { RequestClient, throwIfError } from './RequestClient'
@@ -17,7 +17,7 @@ export class Sas9RequestClient extends RequestClient {
       status >= 200 && status < 303
 
     if (axiosCookieJarSupport) {
-      axiosCookieJarSupport(this.httpClient)
+      axiosCookieJarSupport.wrapper(this.httpClient)
       this.httpClient.defaults.jar = new tough.CookieJar()
     }
   }

package/src/types/system/global.d.ts

@@ -0,0 +1 @@
+import 'jest-extended'

package/src/utils/convertToCsv.ts

@@ -2,70 +2,115 @@
  * Converts the given JSON object array to a CSV string.
  * @param data - the array of JSON objects to convert.
  */
-export const convertToCSV = (data: any) => {
-  const replacer = (key: any, value: any) => (value === null ? '' : value)
-  const headerFields = Object.keys(data[0])
+export const convertToCSV = (
+  data: any,
+  sasFormats?: { formats: { [key: string]: string } }
+) => {
+  let formats = sasFormats?.formats
+  let headers: string[] = []
   let csvTest
   let invalidString = false
-  const headers = headerFields.map((field) => {
-    let firstFoundType: string | null = null
-    let hasMixedTypes: boolean = false
-    let rowNumError: number = -1
-
-    const longestValueForField = data
-      .map((row: any, index: number) => {
-        if (row[field] || row[field] === '') {
-          if (firstFoundType) {
-            let currentFieldType =
-              row[field] === '' || typeof row[field] === 'string'
-                ? 'chars'
-                : 'number'
-
-            if (!hasMixedTypes) {
-              hasMixedTypes = currentFieldType !== firstFoundType
-              rowNumError = hasMixedTypes ? index + 1 : -1
-            }
-          } else {
-            if (row[field] === '') {
-              firstFoundType = 'chars'
-            } else {
-              firstFoundType =
-                typeof row[field] === 'string' ? 'chars' : 'number'
-            }
-          }
+  const specialMissingValueRegExp = /^[a-z_]{1}$/i
 
-          let byteSize
+  if (formats) {
+    headers = Object.keys(formats).map((key) => `${key}:${formats![key]}`)
+  }
 
-          if (typeof row[field] === 'string') {
-            byteSize = getByteSize(row[field])
-          }
+  const headerFields = Object.keys(data[0])
 
-          return byteSize
+  headerFields.forEach((field) => {
+    if (!formats || !Object.keys(formats).includes(field)) {
+      let hasNullOrNumber = false
+      let hasSpecialMissingString = false
+
+      data.forEach((row: { [key: string]: any }) => {
+        if (row[field] === null || typeof row[field] === 'number') {
+          hasNullOrNumber = true
+        } else if (
+          typeof row[field] === 'string' &&
+          specialMissingValueRegExp.test(row[field])
+        ) {
+          hasSpecialMissingString = true
         }
       })
-      .sort((a: number, b: number) => b - a)[0]
-    if (longestValueForField && longestValueForField > 32765) {
-      invalidString = true
-    }
-    if (hasMixedTypes) {
-      console.error(
-        `Row (${rowNumError}), Column (${field}) has mixed types: ERROR`
-      )
-    }
 
-    return `${field}:${firstFoundType === 'chars' ? '$char' : ''}${
-      longestValueForField
-        ? longestValueForField
-        : firstFoundType === 'chars'
-        ? '1'
-        : 'best'
-    }.`
+      if (hasNullOrNumber && hasSpecialMissingString) {
+        headers.push(`${field}:best.`)
+
+        if (!formats) formats = {}
+
+        formats[field] = 'best.'
+      } else {
+        let firstFoundType: string | null = null
+        let hasMixedTypes: boolean = false
+        let rowNumError: number = -1
+
+        const longestValueForField = data
+          .map((row: any, index: number) => {
+            if (row[field] || row[field] === '') {
+              if (firstFoundType) {
+                let currentFieldType =
+                  row[field] === '' || typeof row[field] === 'string'
+                    ? 'chars'
+                    : 'number'
+
+                if (!hasMixedTypes) {
+                  hasMixedTypes = currentFieldType !== firstFoundType
+                  rowNumError = hasMixedTypes ? index + 1 : -1
+                }
+              } else {
+                if (row[field] === '') {
+                  firstFoundType = 'chars'
+                } else {
+                  firstFoundType =
+                    typeof row[field] === 'string' ? 'chars' : 'number'
+                }
+              }
+
+              let byteSize
+
+              if (typeof row[field] === 'string') {
+                byteSize = getByteSize(row[field])
+              }
+
+              return byteSize
+            }
+          })
+          .sort((a: number, b: number) => b - a)[0]
+
+        if (longestValueForField && longestValueForField > 32765) {
+          invalidString = true
+        }
+
+        if (hasMixedTypes) {
+          console.error(
+            `Row (${rowNumError}), Column (${field}) has mixed types: ERROR`
+          )
+        }
+
+        headers.push(
+          `${field}:${firstFoundType === 'chars' ? '$char' : ''}${
+            longestValueForField
+              ? longestValueForField
+              : firstFoundType === 'chars'
+              ? '1'
+              : 'best'
+          }.`
+        )
+      }
+    }
   })
 
-  if (invalidString) {
-    return 'ERROR: LARGE STRING LENGTH'
+  if (sasFormats) {
+    headers = headers.sort(
+      (a, b) =>
+        headerFields.indexOf(a.replace(/:.*/, '')) -
+        headerFields.indexOf(b.replace(/:.*/, ''))
+    )
   }
 
+  if (invalidString) return 'ERROR: LARGE STRING LENGTH'
+
   csvTest = data.map((row: any) => {
     const fields = Object.keys(row).map((fieldName, index) => {
       let value
@@ -76,6 +121,17 @@ export const convertToCSV = (data: any) => {
       // stringify with replacer converts null values to empty strings
       value = currentCell === null ? '' : currentCell
 
+      if (formats && formats[fieldName] === 'best.') {
+        if (value && !specialMissingValueRegExp.test(value)) {
+          console.log(`🤖[value]🤖`, value)
+          throw new Error(
+            'Special missing value can only be a single character from A to Z or _'
+          )
+        }
+
+        return `.${value.toLowerCase()}`
+      }
+
       // if there any present, it should have preceding (") for escaping
       value = value.replace(/"/g, `""`)
 

package/src/utils/formatDataForRequest.ts

@@ -7,9 +7,17 @@ export const formatDataForRequest = (data: any) => {
   const result: any = {}
 
   for (const tableName in data) {
+    if (
+      tableName.match(/^\$.*/) &&
+      Object.keys(data).includes(tableName.replace(/^\$/, ''))
+    ) {
+      continue
+    }
+
     tableCounter++
     sasjsTables.push(tableName)
-    const csv = convertToCSV(data[tableName])
+    const csv = convertToCSV(data[tableName], data[`$${tableName}`])
+
     if (csv === 'ERROR: LARGE STRING LENGTH') {
       throw new Error(
         'The max length of a string value in SASjs is 32765 characters.'
@@ -27,6 +35,7 @@ export const formatDataForRequest = (data: any) => {
       result[`sasjs${tableCounter}data`] = csv
     }
   }
+
   result['sasjs_tables'] = sasjsTables.join(' ')
 
   return result

package/src/utils/parseWeboutResponse.ts

@@ -10,6 +10,7 @@ export const parseWeboutResponse = (response: string, url?: string): string => {
         .split('>>weboutEND<<')[0]
     } catch (e) {
       if (url) throw new WeboutResponseError(url)
+
       sasResponse = ''
       console.error(e)
     }

package/test/utils/formatDataForRequest.spec.d.ts

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

package/tsconfig.json

@@ -6,7 +6,8 @@
     "declaration": true,
     "outDir": "./build",
     "strict": true,
-    "sourceMap": true
+    "sourceMap": true,
+    "typeRoots": ["./node_modules/@types", "./src/types/system"]
   },
   "include": ["src"],
   "exclude": ["node_modules"]

package/utils/convertToCsv.d.ts

@@ -2,4 +2,8 @@
  * Converts the given JSON object array to a CSV string.
  * @param data - the array of JSON objects to convert.
  */
-export declare const convertToCSV: (data: any) => string;
+export declare const convertToCSV: (data: any, sasFormats?: {
+    formats: {
+        [key: string]: string;
+    };
+} | undefined) => string;

package/utils/createAxiosInstance.d.ts

@@ -1,3 +1,2 @@
-/// <reference types="node" />
 import * as https from 'https';
 export declare const createAxiosInstance: (baseURL: string, httpsAgent?: https.Agent | undefined) => import("axios").AxiosInstance;