@sasjs/adapter 3.7.13 → 3.8.1

package/SASjs.d.ts

@@ -2,7 +2,7 @@
 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';
+import { MacroVar, AuthConfig, ExtraResponseAttributes, SasAuthResponse, StreamConfig } from '@sasjs/utils/types';
 import { LoginOptions, LoginResult } from './types/Login';
 /**
  * SASjs is a JavaScript adapter for SAS.
@@ -42,7 +42,7 @@ export default class SASjs {
     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.
+     * @param accessToken - an access token for an authorised user.
      */
     getComputeContexts(accessToken: string): Promise<{
         createdBy: any;
@@ -53,7 +53,7 @@ export default class SASjs {
     }[]>;
     /**
      * Gets launcher contexts.
-     * @param accessToken - an access token for an authorized user.
+     * @param accessToken - an access token for an authorised user.
      */
     getLauncherContexts(accessToken: string): Promise<{
         createdBy: any;
@@ -68,7 +68,7 @@ export default class SASjs {
     getDefaultComputeContexts(): string[];
     /**
      * Gets executable compute contexts.
-     * @param authConfig - an access token, refresh token, client and secret for an authorized user.
+     * @param authConfig - an access token, refresh token, client and secret for an authorised user.
      */
     getExecutableContexts(authConfig: AuthConfig): Promise<any[]>;
     /**
@@ -77,23 +77,23 @@ export default class SASjs {
      * @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 autoExecLines - the lines of code to execute during session initialization.
-     * @param accessToken - an access token for an authorized user.
-     * @param authorizedUsers - an optional list of authorized user IDs.
+     * @param accessToken - an access token for an authorised user.
+     * @param authorisedUsers - an optional list of authorised user IDs.
      */
-    createComputeContext(contextName: string, launchContextName: string, sharedAccountId: string, autoExecLines: string[], accessToken: string, authorizedUsers?: string[]): Promise<import("./types").Context>;
+    createComputeContext(contextName: string, launchContextName: string, sharedAccountId: string, autoExecLines: string[], accessToken: string, authorisedUsers?: string[]): Promise<import("./types").Context>;
     /**
      * Creates a launcher context on the given server.
      * @param contextName - the name of the context to be created.
      * @param description - the description of the context to be created.
      * @param launchType - launch type of the context to be created.
-     * @param accessToken - an access token for an authorized user.
+     * @param accessToken - an access token for an authorised user.
      */
     createLauncherContext(contextName: string, description: string, launchType: string, accessToken: string): Promise<import("./types").Context>;
     /**
      * Updates a compute context on the given server.
      * @param contextName - the original name of the context to be deleted.
      * @param editedContext - an object with the properties to be updated.
-     * @param accessToken - an access token for an authorized user.
+     * @param accessToken - an access token for an authorised user.
      */
     editComputeContext(contextName: string, editedContext: EditContextInput, accessToken?: string): Promise<{
         result: import("./types").Context;
@@ -102,7 +102,7 @@ export default class SASjs {
     /**
      * Deletes a compute context on the given server.
      * @param contextName - the name of the context to be deleted.
-     * @param accessToken - an access token for an authorized user.
+     * @param accessToken - an access token for an authorised user.
      */
     deleteComputeContext(contextName: string, accessToken?: string): Promise<{
         result: import("./types").Context;
@@ -112,13 +112,13 @@ export default class SASjs {
      * Returns a JSON representation of a compute context.
      * @example: { "createdBy": "admin", "links": [...], "id": "ID", "version": 2, "name": "context1" }
      * @param contextName - the name of the context to return.
-     * @param accessToken - an access token for an authorized user.
+     * @param accessToken - an access token for an authorised user.
      */
     getComputeContextByName(contextName: string, accessToken?: string): Promise<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.
+     * @param accessToken - an access token for an authorised user.
      */
     getComputeContextById(contextId: string, accessToken?: string): Promise<import("./types").ContextAllAttributes>;
     createSession(contextName: string, accessToken: string): Promise<import("./types").Session>;
@@ -313,11 +313,13 @@ export default class SASjs {
      * @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 streamConfig - optional configuration object of StreamConfig for deploying streaming app.
      * @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<{
+    deployToSASjs(members: FileTree, appLoc?: string, streamConfig?: StreamConfig, authConfig?: AuthConfig): Promise<{
         status: string;
         message: string;
+        streamServiceName?: string | undefined;
         example?: {} | undefined;
     } | undefined>;
     executeJobSASjs(query: ExecutionQuery): Promise<{
@@ -351,7 +353,7 @@ export default class SASjs {
     /**
      * Fetches content of the log file
      * @param logUrl - url of the log file.
-     * @param accessToken - an access token for an authorized user.
+     * @param accessToken - an access token for an authorised user.
      */
     fetchLogFileContent(logUrl: string, accessToken?: string): Promise<string>;
     /**

package/SASjsApiClient.d.ts

@@ -1,4 +1,4 @@
-import { AuthConfig } from '@sasjs/utils/types';
+import { AuthConfig, StreamConfig } from '@sasjs/utils/types';
 import { FileTree, ExecutionQuery } from './types';
 import { RequestClient } from './request/RequestClient';
 export declare class SASjsApiClient {
@@ -6,9 +6,10 @@ export declare class SASjsApiClient {
     private requestClient;
     constructor(serverUrl: string, requestClient: RequestClient);
     setConfig(serverUrl: string): void;
-    deploy(members: FileTree, appLoc: string, authConfig?: AuthConfig): Promise<{
+    deploy(members: FileTree, appLoc: string, streamConfig?: StreamConfig, authConfig?: AuthConfig): Promise<{
         status: string;
         message: string;
+        streamServiceName?: string | undefined;
         example?: {} | undefined;
     }>;
     executeJob(query: ExecutionQuery): Promise<{