@skyramp/skyramp 1.2.8 → 1.2.10

package/package.json

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

package/src/classes/MultipartParam.d.ts

@@ -0,0 +1,16 @@
+export interface MultipartParamOptions {
+  name: string;
+  value?: string | object;
+  filename?: string;
+  decoded?: boolean;
+}
+
+export declare class MultipartParam {
+  name: string;
+  value: string | object | null;
+  filename: string;
+  decoded: boolean;
+  
+  constructor(options: MultipartParamOptions);
+  toJson(): object;
+}

package/src/classes/MultipartParam.js

@@ -0,0 +1,65 @@
+/**
+ * The `MultipartParam` class represents a multipart/form-data parameter for file uploads or value-based content.
+ * @class
+ */
+class MultipartParam {
+  /**
+   * Initializes a new instance of the MultipartParam class.
+   * @constructor
+   * @param {Object} options - An options object containing all parameters.
+   * @param {string} options.name - The name of the multipart parameter (required).
+   * @param {string} [options.filename=""] - The filename for file uploads.
+   * @param {boolean} [options.decoded=false] - Whether the content should be decoded.
+   * @param {string} [options.value=null] - The value for value-based parameters.
+   * 
+   * @example
+   * // File upload parameter
+   * new MultipartParam({ 
+   *   name: 'file',
+   *   filename: 'document.pdf',
+   *   decoded: true
+   * })
+   * 
+   * @example
+   * // Value-based parameter
+   * new MultipartParam({ 
+   *   name: 'attributes',
+   *   value: '{"product_id": 3}',
+   *   filename: '',
+   *   decoded: false
+   * })
+   */
+  constructor(options) {
+    if (typeof options !== 'object' || options === null || !('name' in options)) {
+      throw new Error('MultipartParam requires an options object with a name property')
+    }
+    
+    this.name = options.name
+    this.value = options.value || null
+    this.filename = options.filename || ""
+    this.decoded = options.decoded || false
+  }
+
+  toJson() {
+    const result = {
+      name: this.name,
+      in: 'multipart'
+    }
+    
+    if (this.value !== null) {
+      result.value = this.value
+    }
+    
+    if (this.filename && this.filename !== "") {
+      result.filepath = this.filename
+    }
+    
+    if (this.decoded) {
+      result.decoded = this.decoded
+    }
+    
+    return result
+  }
+}
+
+module.exports = MultipartParam;

package/src/classes/RequestV2.d.ts

@@ -1,3 +1,5 @@
+import { MultipartParam } from './MultipartParam';
+
 /**
  * Represents a REST request.
  */
@@ -13,6 +15,7 @@ interface RequestV2Options {
   pathParams?: {[pathName: string]: string | number | boolean | object};
   queryParams?: {[queryName: string]: string | number | boolean | object};
   formParams?: {[formParamName: string]: string | number | boolean | object};
+  multipartParams?: Array<MultipartParam>;
   expectedCode?: string;
   funcHandler?: string;
   funcHandlerType?: string;

package/src/classes/RequestV2.js

@@ -18,6 +18,7 @@ class RequestV2 {
    * @param {Object.<string, *>} [options.pathParams={}] - The path parameters for the request.
    * @param {Object.<string, *>} [options.queryParams={}] - The query parameters for the request.
    * @param {Object.<string, *>} [options.formParams={}] - The form parameters of the request.
+   * @param {Array} [options.multipartParams=[]] - The multipart parameters for the request.
    * @param {string} [options.expectedCode=''] - The expected HTTP status code of the response.
    * @param {string} [options.funcHandler=''] - The dynamic handler function for the request.
    * @param {string} [options.funcHandlerType=''] - The type of the dynamic handler (e.g., 'python', 'javascript').
@@ -35,6 +36,7 @@ class RequestV2 {
     this.pathParams = options.pathParams || {};
     this.queryParams = options.queryParams || {};
     this.formParams = options.formParams || {};
+    this.multipartParams = options.multipartParams || [];
     this.expectedCode = options.expectedCode || '';
     this.description = options.description || '';
     this.insecure = options.insecure || false;
@@ -56,6 +58,7 @@ class RequestV2 {
       pathParams: 'path_params',
       queryParams: 'query_params',
       formParams: 'form_params',
+      multipartParams: 'multipart_params',
       expectedCode: 'expected_code',
       description: 'description',
       insecure: 'insecure',
@@ -70,7 +73,20 @@ class RequestV2 {
       if (value && (typeof value !== 'object' || Object.keys(value).length > 0)) {
         // Use snake_case key if mapping exists, otherwise use original key
         const snakeKey = fieldMappings[key] || key;
-        acc[snakeKey] = value;
+        
+        // Special handling for multipartParams
+        if (key === 'multipartParams' && Array.isArray(value)) {
+          acc[snakeKey] = value.map(param => {
+            // If it's a MultipartParam object with toJson method, call it
+            if (param && typeof param.toJson === 'function') {
+              return param.toJson();
+            }
+            // Otherwise return as-is (already a plain object)
+            return param;
+          });
+        } else {
+          acc[snakeKey] = value;
+        }
       }
       return acc;
     }, {});
@@ -97,6 +113,7 @@ class RequestV2 {
       pathParams: 'path_params',
       queryParams: 'query_params',
       formParams: 'form_params',
+      multipartParams: 'multipart_params',
       expectedCode: 'expected_code',
       description: 'description',
       insecure: 'insecure',
@@ -109,7 +126,20 @@ class RequestV2 {
     const jsonObject = Object.entries(rest).reduce((acc, [key, value]) => {
       if (value && (typeof value !== 'object' || Object.keys(value).length > 0)) {
         const snakeKey = fieldMappings[key] || key;
-        acc[snakeKey] = value;
+        
+        // Special handling for multipartParams
+        if (key === 'multipartParams' && Array.isArray(value)) {
+          acc[snakeKey] = value.map(param => {
+            // If it's a MultipartParam object with toJson method, call it
+            if (param && typeof param.toJson === 'function') {
+              return param.toJson();
+            }
+            // Otherwise return as-is (already a plain object)
+            return param;
+          });
+        } else {
+          acc[snakeKey] = value;
+        }
       }
       return acc;
     }, {});
@@ -161,6 +191,17 @@ class RequestV2 {
     if (this.formParams !== undefined && this.formParams !== null && Object.keys(this.formParams).length > 0) {
       requestDict.formParams = this.formParams;
     }
+    if (this.multipartParams !== undefined && this.multipartParams !== null && this.multipartParams.length > 0) {
+      // Convert MultipartParam objects to their JSON representation
+      requestDict.multipartParams = this.multipartParams.map(param => {
+        // If it's a MultipartParam object with toJson method, call it
+        if (param && typeof param.toJson === 'function') {
+          return param.toJson();
+        }
+        // Otherwise return as-is (already a plain object)
+        return param;
+      });
+    }
     if (this.expectedCode !== undefined && this.expectedCode !== null && this.expectedCode !== '') {
       requestDict.expectedCode = this.expectedCode;
     }

package/src/classes/SkyrampClient.d.ts

@@ -6,6 +6,7 @@ import { Protocol } from './Protocol';
 import { AsyncScenario } from './AsyncScenario';
 import { LoadTestConfig } from './LoadTestConfig';
 import { AsyncTestStatus } from './AsyncTestStatus';
+import { MultipartParam } from './MultipartParam';
 
 export enum Language {
   PYTHON = 'python'
@@ -44,6 +45,7 @@ interface SendRequestV2Options {
   pathParams?: {[pathName: string]: string | number | boolean | object | null};
   queryParams?: {[queryName: string]: string | number | boolean | object | null};
   formParams?: {[formParamName: string]: string | number | boolean | object | null};
+  multipartParams?: Array<MultipartParam>;
   expectedCode?: string;
   description?: string;
   insecure?: boolean;

package/src/index.d.ts

@@ -6,6 +6,7 @@ export * from './classes/SkyrampClient';
 export * from './classes/RequestValue';
 export * from './classes/ResponseValue';
 export * from './classes/RestParam';
+export * from './classes/MultipartParam';
 export * from './classes/TrafficConfig';
 export * from './classes/DelayConfig';
 export * from './classes/Protocol';

package/src/index.js

@@ -5,6 +5,7 @@ const Scenario = require('./classes/Scenario');
 const RequestValue = require('./classes/RequestValue');
 const ResponseValue = require('./classes/ResponseValue');
 const RestParam = require('./classes/RestParam');
+const MultipartParam = require('./classes/MultipartParam');
 const TrafficConfig = require('./classes/TrafficConfig');
 const DelayConfig = require('./classes/DelayConfig');
 const Protocol = require('./classes/Protocol');
@@ -28,6 +29,7 @@ module.exports = {
   RequestValue,
   ResponseValue,
   RestParam,
+  MultipartParam,
   TrafficConfig,
   DelayConfig,
   Protocol,