Merge pull request #95 from sasjs/issue-90

docs: fixed typos and updated docs

src/FileUploader.ts

@@ -18,7 +18,8 @@ export class FileUploader {
   private retryCount = 0
 
   public uploadFile(sasJob: string, files: UploadFile[], params: any) {
-    if (files?.length < 1) throw new Error('Atleast one file must be provided')
+    if (files?.length < 1)
+      throw new Error('At least one file must be provided.')
 
     let paramsString = ''
 
@@ -75,7 +76,7 @@ export class FileUploader {
         })
         .then((responseText) => {
           if (isLogInRequired(responseText))
-            reject('You must be logged in to upload a fle')
+            reject('You must be logged in to upload a file')
 
           if (needsRetry(responseText)) {
             if (this.retryCount < requestRetryLimit) {

src/SAS9ApiClient.ts

@@ -1,7 +1,7 @@
 import { isUrl } from './utils'
 
 /**
- * A client for interfacing with the SAS9 REST API
+ * A client for interfacing with the SAS9 REST API.
  *
  */
 export class SAS9ApiClient {
@@ -10,7 +10,7 @@ export class SAS9ApiClient {
   }
 
   /**
-   * returns on object containing the server URL
+   * Returns an object containing server URL.
    */
   public getConfig() {
     return {
@@ -19,8 +19,8 @@ export class SAS9ApiClient {
   }
 
   /**
-   * Updates serverurl which is not null
+   * Updates server URL which is not null.
-   * @param serverUrl - the URL of the server.
+   * @param serverUrl - URL of the server to be set.
    */
   public setConfig(serverUrl: string) {
     if (serverUrl) this.serverUrl = serverUrl
@@ -28,9 +28,9 @@ export class SAS9ApiClient {
 
   /**
    * Executes code on a SAS9 server.
-   * @param linesOfCode - an array of lines of code to execute
+   * @param linesOfCode - an array of code lines to execute.
-   * @param serverName - the server to execute the code on
+   * @param serverName - the server to execute the code on.
-   * @param repositoryName - the repository to execute the code on
+   * @param repositoryName - the repository to execute the code in.
    */
   public async executeScript(
     linesOfCode: string[],

src/SASViyaApiClient.ts

@@ -21,7 +21,7 @@ import { formatDataForRequest } from './utils/formatDataForRequest'
 import { SessionManager } from './SessionManager'
 
 /**
- * A client for interfacing with the SAS Viya REST API
+ * A client for interfacing with the SAS Viya REST API.
  *
  */
 export class SASViyaApiClient {
@@ -61,7 +61,7 @@ export class SASViyaApiClient {
   }
 
   /**
-   * returns an object containing the Server URL and root folder name
+   * Returns an object containing the server URL and root folder name.
    */
   public getConfig() {
     return {
@@ -71,9 +71,9 @@ export class SASViyaApiClient {
   }
 
   /**
-   * Updates server URL or root folder name when not null
+   * Updates server URL and root folder name, if it was not set.
    * @param serverUrl - the URL of the server.
-   * @param rootFolderName - the name for rootFolderName.
+   * @param rootFolderName - the name for root folder.
    */
   public setConfig(serverUrl: string, rootFolderName: string) {
     if (serverUrl) this.serverUrl = serverUrl
@@ -126,7 +126,7 @@ export class SASViyaApiClient {
       `${this.serverUrl}/compute/contexts?limit=10000`,
       { headers }
     ).catch((err) => {
-      throw new Error(err)
+      throw err
     })
 
     const contextsList = contexts.items || []
@@ -222,7 +222,7 @@ export class SASViyaApiClient {
    * Creates a compute context on the given server.
    * @param contextName - the name of the context to be created.
    * @param launchContextName - the name of the launcher context used by the compute service.
-   * @param sharedAccountId - the ID of the account to run the servers for this context as.
+   * @param sharedAccountId - the ID of the account to run the servers for this context.
    * @param autoExecLines - the lines of code to execute during session initialization.
    * @param authorizedUsers - an optional list of authorized user IDs.
    * @param accessToken - an access token for an authorized user.
@@ -236,15 +236,15 @@ export class SASViyaApiClient {
     accessToken?: string
   ) {
     if (!contextName) {
-      throw new Error('Missing context name.')
+      throw new Error('Context name is required.')
     }
 
     if (!launchContextName) {
-      throw new Error('Missing launch context name.')
+      throw new Error('Launch context name is required.')
     }
 
     if (!sharedAccountId) {
-      throw new Error('Missing shared account ID.')
+      throw new Error('Shared account ID is required.')
     }
 
     const headers: any = {
@@ -328,11 +328,11 @@ export class SASViyaApiClient {
 
       if (e && e.status === 404) {
         throw new Error(
-          `The context ${contextName} was not found on this server.`
+          `The context '${contextName}' was not found on this server.`
         )
       }
       throw new Error(
-        `An error occurred when fetching the context ${contextName}`
+        `An error occurred when fetching the context '${contextName}'.`
       )
     })
 
@@ -364,7 +364,7 @@ export class SASViyaApiClient {
    */
   public async deleteContext(contextName: string, accessToken?: string) {
     if (!contextName) {
-      throw new Error('Invalid context Name.')
+      throw new Error('Invalid context name.')
     }
 
     const headers: any = {
@@ -391,11 +391,11 @@ export class SASViyaApiClient {
   /**
    * Executes code on the current SAS Viya server.
    * @param fileName - a name for the file being submitted for execution.
-   * @param linesOfCode - an array of lines of code to execute.
+   * @param linesOfCode - an array of code lines to execute.
    * @param contextName - the context to execute the code in.
    * @param accessToken - an access token for an authorized user.
    * @param sessionId - optional session ID to reuse.
-   * @param silent - optional flag to turn of logging.
+   * @param silent - optional flag to disable logging.
    * @param data - execution data.
    * @param debug - when set to true, the log will be returned.
    * @param expectWebout - when set to true, the automatic _webout fileref will be checked for content, and that content returned. This fileref is used when the Job contains a SASjs web request (as opposed to executing arbitrary SAS code).
@@ -486,11 +486,11 @@ export class SASViyaApiClient {
       )
 
       if (!silent) {
-        console.log(`Job has been submitted for ${fileName}`)
+        console.log(`Job has been submitted for '${fileName}'.`)
         console.log(
-          `You can monitor the job progress at ${this.serverUrl}${
+          `You can monitor the job progress at '${this.serverUrl}${
             postedJob.links.find((l: any) => l.rel === 'state')!.href
-          }`
+          }'.`
         )
       }
 
@@ -563,13 +563,12 @@ export class SASViyaApiClient {
   }
 
   /**
-   * Creates a folder in the specified location.  Either parentFolderPath or
+   * Creates a folder. Path to or URI of the parent folder is required.
-   *   parentFolderUri must be provided.
    * @param folderName - the name of the new folder.
    * @param parentFolderPath - the full path to the parent folder.  If not
    *  provided, the parentFolderUri must be provided.
    * @param parentFolderUri - the URI (eg /folders/folders/UUID) of the parent
-   *  folder.  If not provided, the parentFolderPath must be provided.
+   *  folder. If not provided, the parentFolderPath must be provided.
    * @param accessToken - an access token for authorizing the request.
    * @param isForced - flag that indicates if target folder already exists, it and all subfolders have to be deleted.
    */
@@ -581,7 +580,7 @@ export class SASViyaApiClient {
     isForced?: boolean
   ): Promise<Folder> {
     if (!parentFolderPath && !parentFolderUri) {
-      throw new Error('Parent folder path or uri is required')
+      throw new Error('Path or URI of the parent folder is required.')
     }
 
     if (!parentFolderUri && parentFolderPath) {
@@ -589,7 +588,9 @@ export class SASViyaApiClient {
       if (!parentFolderUri) {
         if (isForced) this.isForceDeploy = true
 
-        console.log(`Parent folder is not present: ${parentFolderPath}`)
+        console.log(
+          `Parent folder at path '${parentFolderPath}' is not present.`
+        )
 
         const newParentFolderPath = parentFolderPath.substring(
           0,
@@ -597,10 +598,10 @@ export class SASViyaApiClient {
         )
         const newFolderName = `${parentFolderPath.split('/').pop()}`
         if (newParentFolderPath === '') {
-          throw new Error('Root Folder should have been present on server')
+          throw new Error('Root folder has to be present on the server.')
         }
         console.log(
-          `Creating Parent Folder:\n${newFolderName} in ${newParentFolderPath}`
+          `Creating parent folder:\n'${newFolderName}' in '${newParentFolderPath}'`
         )
         const parentFolder = await this.createFolder(
           newFolderName,
@@ -608,7 +609,9 @@ export class SASViyaApiClient {
           undefined,
           accessToken
         )
-        console.log(`Parent Folder "${newFolderName}" successfully created.`)
+        console.log(
+          `Parent folder '${newFolderName}' has been successfully created.`
+        )
         parentFolderUri = `/folders/folders/${parentFolder.id}`
       } else if (isForced && accessToken && !this.isForceDeploy) {
         this.isForceDeploy = true
@@ -622,11 +625,11 @@ export class SASViyaApiClient {
         const newFolderName = `${parentFolderPath.split('/').pop()}`
 
         if (newParentFolderPath === '') {
-          throw new Error('Root Folder should have been present on server')
+          throw new Error(`Root folder has to be present on the server.`)
         }
 
         console.log(
-          `Creating Parent Folder:\n${newFolderName} in ${newParentFolderPath}`
+          `Creating parent folder:\n'${newFolderName}' in '${newParentFolderPath}'`
         )
 
         const parentFolder = await this.createFolder(
@@ -636,7 +639,9 @@ export class SASViyaApiClient {
           accessToken
         )
 
-        console.log(`Parent Folder "${newFolderName}" successfully created.`)
+        console.log(
+          `Parent folder '${newFolderName}' has been successfully created.`
+        )
 
         parentFolderUri = `/folders/folders/${parentFolder.id}`
       }
@@ -660,7 +665,7 @@ export class SASViyaApiClient {
       createFolderRequest
     )
 
-    // update rootFolderMap with newly created folder.
+    // updates rootFolderMap with newly created folder.
     await this.populateRootFolderMap(accessToken)
     return createFolderResponse
   }
@@ -681,9 +686,7 @@ export class SASViyaApiClient {
     accessToken?: string
   ) {
     if (!parentFolderPath && !parentFolderUri) {
-      throw new Error(
+      throw new Error(`Path to or URI of the parent folder is required.`)
-        'Either parentFolderPath or parentFolderUri must be provided'
-      )
     }
 
     if (!parentFolderUri && parentFolderPath) {
@@ -724,7 +727,7 @@ export class SASViyaApiClient {
   }
 
   /**
-   * Performs a login redirect and returns an auth code for the given client
+   * Performs a login redirect and returns an auth code for the given client.
    * @param clientId - the client ID to authenticate with.
    */
   public async getAuthCode(clientId: string) {
@@ -878,7 +881,7 @@ export class SASViyaApiClient {
   }
 
   /**
-   * Executes a job via the SAS Viya Compute API
+   * Executes a job via the SAS Viya Compute API.
    * @param sasJob - the relative path to the job.
    * @param contextName - the name of the context where the job is to be executed.
    * @param debug - sets the _debug flag in the job arguments.
@@ -896,16 +899,14 @@ export class SASViyaApiClient {
       await this.populateRootFolder(accessToken)
     }
     if (!this.rootFolder) {
-      console.error('Root folder was not found')
+      throw new Error(`Root folder was not found.`)
-      throw new Error('Root folder was not found')
     }
     if (!this.rootFolderMap.size) {
       await this.populateRootFolderMap(accessToken)
     }
     if (!this.rootFolderMap.size) {
-      console.error(`The job ${sasJob} was not found in ${this.rootFolderName}`)
       throw new Error(
-        `The job ${sasJob} was not found in ${this.rootFolderName}`
+        `The job '${sasJob}' was not found in '${this.rootFolderName}'.`
       )
     }
 
@@ -920,7 +921,7 @@ export class SASViyaApiClient {
     const jobToExecute = jobFolder?.find((item) => item.name === jobName)
 
     if (!jobToExecute) {
-      throw new Error('Job was not found.')
+      throw new Error(`Job was not found.`)
     }
 
     let code = jobToExecute?.code
@@ -931,8 +932,7 @@ export class SASViyaApiClient {
       )
 
       if (!jobDefinitionLink) {
-        console.error('Job definition URI was not found.')
+        throw new Error(`URI of job definition was not found.`)
-        throw new Error('Job definition URI was not found.')
       }
 
       const { result: jobDefinition } = await this.request<JobDefinition>(
@@ -942,7 +942,7 @@ export class SASViyaApiClient {
 
       code = jobDefinition.code
 
-      // Add code to existing job definition
+      // Adds code to existing job definition
       jobToExecute.code = code
     }
 
@@ -960,7 +960,7 @@ export class SASViyaApiClient {
   }
 
   /**
-   * Executes a job via the SAS Viya Job Execution API
+   * Executes a job via the SAS Viya Job Execution API.
    * @param sasJob - the relative path to the job.
    * @param contextName - the name of the context where the job is to be executed.
    * @param debug - sets the _debug flag in the job arguments.
@@ -979,14 +979,14 @@ export class SASViyaApiClient {
     }
 
     if (!this.rootFolder) {
-      throw new Error('Root folder was not found')
+      throw new Error(`Root folder was not found.`)
     }
     if (!this.rootFolderMap.size) {
       await this.populateRootFolderMap(accessToken)
     }
     if (!this.rootFolderMap.size) {
       throw new Error(
-        `The job ${sasJob} was not found in ${this.rootFolderName}`
+        `The job '${sasJob}' was not found in folder '${this.rootFolderName}'.`
       )
     }
 
@@ -1095,7 +1095,7 @@ export class SASViyaApiClient {
       return { result: jobResult?.result, log }
     } else {
       throw new Error(
-        `The job ${sasJob} was not found at the location ${this.rootFolderName}`
+        `The job '${sasJob}' was not found in folder '${this.rootFolderName}'.`
       )
     }
   }
@@ -1114,7 +1114,9 @@ export class SASViyaApiClient {
       requestInfo
     )
     if (!folder) {
-      throw new Error('Cannot populate RootFolderMap unless rootFolder exists')
+      throw new Error(
+        `Not able to populate root folder map, because folder '${this.rootFolderName}' does not exist.`
+      )
     }
     const { result: members } = await this.request<{ items: any[] }>(
       `${this.serverUrl}/folders/folders/${folder.id}/members`,
@@ -1192,7 +1194,7 @@ export class SASViyaApiClient {
     }
     const stateLink = postedJob.links.find((l: any) => l.rel === 'state')
     if (!stateLink) {
-      Promise.reject('Job state link was not found.')
+      Promise.reject(`Job state link was not found.`)
     }
 
     const { result: state } = await this.request<string>(
@@ -1380,13 +1382,13 @@ export class SASViyaApiClient {
       console.error(e)
 
       throw new Error(
-        `An error occurred when fetching the context with ID ${contextName}`
+        `An error occurred when fetching the context '${contextName}'.`
       )
     })
 
     if (!contexts || !(contexts.items && contexts.items.length)) {
       throw new Error(
-        `The context ${contextName} was not found on ${this.serverUrl}.`
+        `The context '${contextName}' was not found at '${this.serverUrl}'.`
       )
     }
 
@@ -1445,7 +1447,7 @@ export class SASViyaApiClient {
   }
 
   /**
-   * For performance (and in case of accidental error) the `deleteFolder` function does not actually delete the folder (and all it's content and subfolder content). Instead the folder is simply moved to the recycle bin. Deletion time will be added to the folder name.
+   * For performance (and in case of accidental error) the `deleteFolder` function does not actually delete the folder (and all its content and subfolder content). Instead the folder is simply moved to the recycle bin. Deletion time will be added to the folder name.
    * @param folderPath - the full path (eg `/Public/example/deleteThis`) of the folder to be deleted.
    * @param accessToken - an access token for authorizing the request.
    */

src/SASjs.ts

@@ -84,9 +84,8 @@ export default class SASjs {
     serverName: string,
     repositoryName: string
   ) {
-    if (this.sasjsConfig.serverType !== ServerType.SAS9) {
+    this.isMethodSupported('executeScriptSAS9', ServerType.SAS9)
-      throw new Error('This operation is only supported on SAS9 servers.')
+
-    }
     return await this.sas9ApiClient?.executeScript(
       linesOfCode,
       serverName,
@@ -95,16 +94,14 @@ export default class SASjs {
   }
 
   public async getAllContexts(accessToken: string) {
-    if (this.sasjsConfig.serverType !== ServerType.SASViya) {
+    this.isMethodSupported('getAllContexts', ServerType.SASViya)
-      throw new Error('This operation is only supported on SAS Viya servers.')
+
-    }
     return await this.sasViyaApiClient!.getAllContexts(accessToken)
   }
 
   public async getExecutableContexts(accessToken: string) {
-    if (this.sasjsConfig.serverType !== ServerType.SASViya) {
+    this.isMethodSupported('getExecutableContexts', ServerType.SASViya)
-      throw new Error('This operation is only supported on SAS Viya servers.')
+
-    }
     return await this.sasViyaApiClient!.getExecutableContexts(accessToken)
   }
 
@@ -125,9 +122,8 @@ export default class SASjs {
     authorizedUsers: string[],
     accessToken: string
   ) {
-    if (this.sasjsConfig.serverType !== ServerType.SASViya) {
+    this.isMethodSupported('createContext', ServerType.SASViya)
-      throw new Error('This operation is only supported on SAS Viya servers.')
+
-    }
     return await this.sasViyaApiClient!.createContext(
       contextName,
       launchContextName,
@@ -149,9 +145,8 @@ export default class SASjs {
     editedContext: EditContextInput,
     accessToken?: string
   ) {
-    if (this.sasjsConfig.serverType !== ServerType.SASViya) {
+    this.isMethodSupported('editContext', ServerType.SASViya)
-      throw new Error('This operation is only supported on SAS Viya servers.')
+
-    }
     return await this.sasViyaApiClient!.editContext(
       contextName,
       editedContext,
@@ -165,16 +160,14 @@ export default class SASjs {
    * @param accessToken - an access token for an authorized user.
    */
   public async deleteContext(contextName: string, accessToken?: string) {
-    if (this.sasjsConfig.serverType !== ServerType.SASViya) {
+    this.isMethodSupported('deleteContext', ServerType.SASViya)
-      throw new Error('This operation is only supported on SAS Viya servers.')
+
-    }
     return await this.sasViyaApiClient!.deleteContext(contextName, accessToken)
   }
 
   public async createSession(contextName: string, accessToken: string) {
-    if (this.sasjsConfig.serverType !== ServerType.SASViya) {
+    this.isMethodSupported('createSession', ServerType.SASViya)
-      throw new Error('This operation is only supported on SAS Viya servers.')
+
-    }
     return await this.sasViyaApiClient!.createSession(contextName, accessToken)
   }
 
@@ -186,9 +179,8 @@ export default class SASjs {
     sessionId = '',
     silent = false
   ) {
-    if (this.sasjsConfig.serverType !== ServerType.SASViya) {
+    this.isMethodSupported('executeScriptSASViya', ServerType.SASViya)
-      throw new Error('This operation is only supported on SAS Viya servers.')
+
-    }
     return await this.sasViyaApiClient!.executeScript(
       fileName,
       linesOfCode,
@@ -201,7 +193,7 @@ export default class SASjs {
   }
 
   /**
-   * Creates a folder at SAS file system
+   * Creates a folder at SAS file system.
    * @param folderName - name of the folder to be created.
    * @param parentFolderPath - the full path (eg `/Public/example/myFolder`) of the parent folder.
    * @param parentFolderUri - the URI of the parent folder.
@@ -217,9 +209,8 @@ export default class SASjs {
     sasApiClient?: SASViyaApiClient,
     isForced?: boolean
   ) {
-    if (this.sasjsConfig.serverType !== ServerType.SASViya) {
+    this.isMethodSupported('createFolder', ServerType.SASViya)
-      throw new Error('This operation is only supported on SAS Viya servers.')
+
-    }
     if (sasApiClient)
       return await sasApiClient.createFolder(
         folderName,
@@ -244,9 +235,8 @@ export default class SASjs {
     accessToken?: string,
     sasApiClient?: SASViyaApiClient
   ) {
-    if (this.sasjsConfig.serverType !== ServerType.SASViya) {
+    this.isMethodSupported('createJobDefinition', ServerType.SASViya)
-      throw new Error('This operation is only supported on SAS Viya servers.')
+
-    }
     if (sasApiClient)
       return await sasApiClient!.createJobDefinition(
         jobName,
@@ -265,9 +255,8 @@ export default class SASjs {
   }
 
   public async getAuthCode(clientId: string) {
-    if (this.sasjsConfig.serverType !== ServerType.SASViya) {
+    this.isMethodSupported('getAuthCode', ServerType.SASViya)
-      throw new Error('This operation is only supported on SAS Viya servers.')
+
-    }
     return await this.sasViyaApiClient!.getAuthCode(clientId)
   }
 
@@ -276,9 +265,8 @@ export default class SASjs {
     clientSecret: string,
     authCode: string
   ) {
-    if (this.sasjsConfig.serverType !== ServerType.SASViya) {
+    this.isMethodSupported('getAccessToken', ServerType.SASViya)
-      throw new Error('This operation is only supported on SAS Viya servers.')
+
-    }
     return await this.sasViyaApiClient!.getAccessToken(
       clientId,
       clientSecret,
@@ -291,9 +279,8 @@ export default class SASjs {
     clientSecret: string,
     refreshToken: string
   ) {
-    if (this.sasjsConfig.serverType !== ServerType.SASViya) {
+    this.isMethodSupported('refreshTokens', ServerType.SASViya)
-      throw new Error('This operation is only supported on SAS Viya servers.')
+
-    }
     return await this.sasViyaApiClient!.refreshTokens(
       clientId,
       clientSecret,
@@ -302,9 +289,8 @@ export default class SASjs {
   }
 
   public async deleteClient(clientId: string, accessToken: string) {
-    if (this.sasjsConfig.serverType !== ServerType.SASViya) {
+    this.isMethodSupported('deleteClient', ServerType.SASViya)
-      throw new Error('This operation is only supported on SAS Viya servers.')
+
-    }
     return await this.sasViyaApiClient!.deleteClient(clientId, accessToken)
   }
 
@@ -325,7 +311,7 @@ export default class SASjs {
   }
 
   /**
-   * Returns the _csrf token of the current session for the API approach
+   * Returns the _csrf token of the current session for the API approach.
    *
    */
   public getCsrfApi() {
@@ -342,7 +328,7 @@ export default class SASjs {
 
   /**
    * Sets the SASjs configuration.
-   * @param config - SASjsConfig indicating SASjs Configuration
+   * @param config - SASjs configuration.
    */
   public async setSASjsConfig(config: SASjsConfig) {
     this.sasjsConfig = {
@@ -353,17 +339,16 @@ export default class SASjs {
   }
 
   /**
-   * Sets the debug state.  Turning this on will enable additional logging to
+   * Sets the debug state. Turning this on will enable additional logging in the adapter.
-   * be returned to the adapter.
+   * @param value - boolean indicating debug state (on/off).
-   * @param value - Boolean indicating debug state
    */
   public setDebugState(value: boolean) {
     this.sasjsConfig.debug = value
   }
 
   /**
-   * Checks whether a session is active, or login is required
+   * 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`
+   * @returns - a promise which resolves with an object containing two values - a boolean `isLoggedIn`, and a string `userName`.
    */
   public async checkSession() {
     const loginResponse = await fetch(this.loginUrl.replace('.do', ''))
@@ -377,9 +362,9 @@ export default class SASjs {
   }
 
   /**
-   * Logs into the SAS server with the supplied credentials
+   * Logs into the SAS server with the supplied credentials.
-   * @param username - a string representing the username
+   * @param username - a string representing the username.
-   * @param password - a string representing the password
+   * @param password - a string representing the password.
    */
   public async logIn(username: string, password: string) {
     const loginParams: any = {
@@ -448,7 +433,7 @@ export default class SASjs {
   }
 
   /**
-   * Logs out of the configured SAS server
+   * Logs out of the configured SAS server.
    */
   public logOut() {
     return new Promise((resolve, reject) => {
@@ -462,12 +447,12 @@ export default class SASjs {
   }
 
   /**
-   * Uploads a file to the given service
+   * Uploads a file to the given service.
-   * @param sasJob - The path to the SAS program (ultimately resolves to
+   * @param sasJob - the path to the SAS program (ultimately resolves to
    *  the SAS `_program` parameter to run a Job Definition or SAS 9 Stored
-   *  Process.)  Is prepended at runtime with the value of `appLoc`.
+   *  Process). Is prepended at runtime with the value of `appLoc`.
-   * @param file - Array of files to be uploaded, including File object and file name.
+   * @param files - array of files to be uploaded, including File object and file name.
-   * @param params - Request URL paramaters
+   * @param params - request URL parameters.
    */
   public uploadFile(sasJob: string, files: UploadFile[], params: any) {
     const fileUploader =
@@ -484,21 +469,21 @@ export default class SASjs {
   }
 
   /**
-   * Makes a request to the SAS Service specified in `SASjob`.  The response
+   * Makes a request to the SAS Service specified in `SASjob`. The response
    * object will always contain table names in lowercase, and column names in
-   * uppercase.  Values are returned formatted by default, unformatted
+   * uppercase. Values are returned formatted by default, unformatted
    * values can be configured as an option in the `%webout` macro.
    *
-   * @param sasJob - The path to the SAS program (ultimately resolves to
+   * @param sasJob - the path to the SAS program (ultimately resolves to
    *  the SAS `_program` parameter to run a Job Definition or SAS 9 Stored
-   *  Process.)  Is prepended at runtime with the value of `appLoc`.
+   *  Process). Is prepended at runtime with the value of `appLoc`.
-   * @param data - A JSON object containing one or more tables to be sent to
+   * @param data - a JSON object containing one or more tables to be sent to
-   * SAS.  Can be `null` if no inputs required.
+   * SAS. Can be `null` if no inputs required.
-   * @param config - Provide any changes to the config here, for instance to
+   * @param config - provide any changes to the config here, for instance to
-   * enable / disable `debug`. Any change provided will override the global config,
+   * enable/disable `debug`. Any change provided will override the global config,
    * for that particular function call.
    * @param loginRequiredCallback - provide a function here to be called if the
-   * user is not logged in (eg to display a login form).  The request will be
+   * user is not logged in (eg to display a login form). The request will be
    * resubmitted after logon.
    */
   public async request(
@@ -552,8 +537,7 @@ export default class SASjs {
   }
 
   /**
-   * Creates the folders and services in the provided JSON on the given location
+   * Creates the folders and services at the given location `appLoc` on the given server `serverUrl`.
-   * (appLoc) on the given server (serverUrl).
    * @param serviceJson - 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.
@@ -570,9 +554,7 @@ export default class SASjs {
     accessToken?: string,
     isForced = false
   ) {
-    if (this.sasjsConfig.serverType !== ServerType.SASViya) {
+    this.isMethodSupported('deployServicePack', ServerType.SASViya)
-      throw new Error('This operation is only supported on SAS Viya servers.')
-    }
 
     let sasApiClient: any = null
     if (serverUrl || appLoc) {
@@ -686,7 +668,7 @@ export default class SASjs {
                 resolve(retryResponse)
               } else {
                 this.retryCountComputeApi = 0
-                reject({ MESSAGE: 'Compute API retry requests limit reached' })
+                reject({ MESSAGE: 'Compute API retry requests limit reached.' })
               }
             }
 
@@ -697,7 +679,7 @@ export default class SASjs {
               sasjsWaitingRequest.config = config
               this.sasjsWaitingRequests.push(sasjsWaitingRequest)
             } else {
-              reject({ MESSAGE: error || 'Job execution failed' })
+              reject({ MESSAGE: error || 'Job execution failed.' })
             }
 
             this.appendSasjsRequest(response.log, sasJob, null)
@@ -779,11 +761,11 @@ export default class SASjs {
                     resolve(retryResponse)
                   } else {
                     this.retryCountJeseApi = 0
-                    reject({ MESSAGE: 'Jes API retry requests limit reached' })
+                    reject({ MESSAGE: 'JES API retry requests limit reached' })
                   }
                 }
 
-                reject({ MESSAGE: (e && e.message) || 'Job execution failed' })
+                reject({ MESSAGE: (e && e.message) || 'Job execution failed.' })
               })
           )
         }
@@ -1074,7 +1056,7 @@ export default class SASjs {
             resolve(resText)
           })
       } else {
-        reject('No debug info in response')
+        reject('No debug info found in response.')
       }
     })
   }
@@ -1353,7 +1335,7 @@ export default class SASjs {
           )
           break
         default:
-          throw new Error(`Unidenitied member present in Json: ${member.name}`)
+          throw new Error(`Unidentified member '${member.name}' provided.`)
       }
       if (member.type === 'folder' && member.members && member.members.length)
         await this.createFoldersAndServices(
@@ -1365,4 +1347,14 @@ export default class SASjs {
         )
     })
   }
+
+  private isMethodSupported(method: string, serverType: string) {
+    if (this.sasjsConfig.serverType !== serverType) {
+      throw new Error(
+        `Method '${method}' is only supported on ${
+          serverType === ServerType.SAS9 ? 'SAS9' : 'SAS Viya'
+        } servers.`
+      )
+    }
+  }
 }

src/SessionManager.ts

@@ -93,7 +93,7 @@ export class SessionManager {
 
       if (!currentContext) {
         throw new Error(
-          `The context ${this.contextName} was not found on the server ${this.serverUrl}`
+          `The context '${this.contextName}' was not found on the server ${this.serverUrl}.`
         )
       }
 
@@ -128,7 +128,7 @@ export class SessionManager {
       if (sessionState === 'pending') {
         if (stateLink) {
           if (!silent) {
-            console.log('Polling session status... \n')
+            console.log('Polling session status... \n') // ?
           }
           const { result: state } = await this.request<string>(
             `${this.serverUrl}${stateLink.href}?wait=30`,
@@ -140,7 +140,7 @@ export class SessionManager {
 
           sessionState = state.trim()
           if (!silent) {
-            console.log(`Current state: ${sessionState}\n`)
+            console.log(`Current state is '${sessionState}'\n`)
           }
           resolve(sessionState)
         }

src/types/SASjsConfig.ts

@@ -19,7 +19,7 @@ export class SASjsConfig {
    */
   appLoc: string = ''
   /**
-   * Can be SAS9 or SASVIYA
+   * Can be `SAS9` or `SASVIYA`.
    */
   serverType: ServerType | null = null
   /**

src/types/SASjsWaitingRequest.ts

@@ -1,5 +1,5 @@
 /**
- * Represents requests that are queued, pending a signon event
+ * Represents requests that are queued, pending a signon event.
  *
  */
 export interface SASjsWaitingRequest {

src/types/ServerType.ts

@@ -1,5 +1,5 @@
 /**
- * Server type - Viya or SAS9.
+ * Server type that can be `Viya` or `SAS9`.
  *
  */
 export enum ServerType {

src/types/UploadFile.ts

@@ -1,5 +1,5 @@
 /**
- * Represents a object that is passed to file uploader
+ * Represents an object that is passed to the file uploader.
  *
  */
 export interface UploadFile {

src/utils/compareTimestamps.ts

@@ -1,7 +1,7 @@
 import { SASjsRequest } from '../types/SASjsRequest'
 
 /**
- * Comparator for SASjs request timestamps
+ * Comparator for SASjs request timestamps.
  *
  */
 export const compareTimestamps = (a: SASjsRequest, b: SASjsRequest) => {

src/utils/isUri.ts

@@ -1,5 +1,5 @@
 /**
- * Checks if string is in URI format
+ * Checks if string is in URI format.
- * @param str string to check
+ * @param str - string to check.
  */
 export const isUri = (str: string): boolean => /^\/folders\/folders\//.test(str)

src/utils/isUrl.ts

@@ -1,3 +1,7 @@
+/**
+ * Checks if string is in URL format.
+ * @param url - string to check.
+ */
 export const isUrl = (url: string): boolean => {
   const pattern = new RegExp(
     '^(http://|https://)[a-z0-9]+([-.]{1}[a-z0-9]+)*.[a-z]{2,5}(:[0-9]{1,5})?(/.*)?$',

typedoc.json

@@ -11,11 +11,11 @@
   "outline": [
     {
       "SAS Adapter": {
-        "SASjs": "classes/reflection-708.reflection-180.sasjs",
+        "SASjs": "classes/reflection-717.reflection-180.sasjs",
         "Types": "modules/types"
       },
-      "SAS Viya API Client": "classes/reflection-708.reflection-180.sasviyaapiclient",
+      "SAS Viya API Client": "classes/reflection-717.reflection-180.sasviyaapiclient",
-      "SAS 9 API Client": "classes/reflection-708.reflection-180.sas9apiclient"
+      "SAS 9 API Client": "classes/reflection-717.reflection-180.sas9apiclient"
     }
   ],
   "links": [