@skyramp/skyramp 1.3.3 → 1.3.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyramp/skyramp",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "module for leveraging skyramp cli functionality",
   "scripts": {
     "lint": "eslint 'src/**/*.js' 'src/**/*.ts' --fix",

package/src/classes/AsyncScenario.d.ts

@@ -7,8 +7,9 @@ export interface AsyncRequestOptions {
   method?: string;
   body?: string;
   headers?: Record<string, string>;
-  pathParams?: Record<string, string>;
-  queryParams?: Record<string, string | number | boolean>;
+  cookies?: Record<string, string>;
+  pathParams?: Record<string, string | number | boolean>;
+  queryParams?: Record<string, string | string[] | number | boolean>;
   formParams?: Record<string, string | number | boolean>;
   multipartParams?: Record<string, string | number | boolean>;
   dataOverride?: Record<string, string | number | boolean>;
@@ -33,6 +34,18 @@ export class AsyncRequest {
    */
   getAsyncRequestValue(path: string | null): string;
 
+  /**
+   * Returns request's cookie value construct for asynchronous backend
+   * @param cookieName The name of the cookie
+   */
+  getCookieValue(cookieName: string): string;
+
+  /**
+   * Returns request's response header value construct for asynchronous backend
+   * @param headerName The name of the response header
+   */
+  getResponseHeaderValue(headerName: string): string;
+
   /**
    * Returns request's status check construct for asynchronous backend
    * @param code The expected status code

package/src/classes/AsyncScenario.js

@@ -42,6 +42,24 @@ class AsyncRequest {
     return `requests.${this.request.name}.res.${path}`;
   }
 
+  /**
+   * Returns request's cookie value construct for asynchronous backend
+   * @param {string} cookieName - The name of the cookie
+   * @returns {string} The cookie value reference
+   */
+  getCookieValue(cookieName) {
+    return `requests.${this.request.name}.cookies["${cookieName}"]`;
+  }
+
+  /**
+   * Returns request's response header value construct for asynchronous backend
+   * @param {string} headerName - The name of the response header
+   * @returns {string} The response header value reference
+   */
+  getResponseHeaderValue(headerName) {
+    return `requests.${this.request.name}.headers["${headerName}"]`;
+  }
+
   /**
    * Returns request's status check construct for asynchronous backend
    * @param {string|number} code - The expected status code
@@ -111,6 +129,7 @@ class AsyncScenario {
    * @param {string} [options.method] - The HTTP method of the request (e.g., GET, POST)
    * @param {string} [options.body] - The body of the request
    * @param {Object} [options.headers] - The headers of the request
+   * @param {Object} [options.cookies] - The cookies of the request
    * @param {Object} [options.pathParams] - The path parameters of the request
    * @param {Object} [options.queryParams] - The query parameters of the request
    * @param {Object} [options.formParams] - The form parameters of the request
@@ -132,6 +151,7 @@ class AsyncScenario {
       method,
       body,
       headers,
+      cookies,
       pathParams,
       queryParams,
       formParams,
@@ -152,6 +172,7 @@ class AsyncScenario {
       method,
       body,
       headers,
+      cookies,
       pathParams,
       queryParams,
       formParams,

package/src/classes/RequestV2.d.ts

@@ -12,8 +12,8 @@ interface RequestV2Options {
   headers?: {[headerName: string]: string};
   cookies?: {[cookieName: string]: string};
   dataOverride?: {[dataName: string]: string | number | boolean | object};
-  pathParams?: {[pathName: string]: string | number | boolean | object};
-  queryParams?: {[queryName: string]: string | number | boolean | object};
+  pathParams?: {[pathName: string]: string| number | boolean | object};
+  queryParams?: {[queryName: string]: string | string[] | number | boolean | object};
   formParams?: {[formParamName: string]: string | number | boolean | object};
   multipartParams?: Array<MultipartParam>;
   expectedCode?: string;