Snippet Code

The collection of useful snippet code for the Scripting tool
1. What's it?
A collection of snippet Javascript code for the Scripting Tool.
Could not find the Snippet Code you are looking for? 
Please open a ticket at https://github.com/ProxymanApp/Proxyman, we will get back to help you ⭐️
2. Common on Request and Response
​Add/Update/Remove Header on Request/Response​
​Add/Update/Remove Query on Request​
​Add/Update/Delete URLEncoded-Form Body​
​Add/Update/Delete JSON Body​
​Change Request Scheme, Host, Port, Path​
​Change Request Method​
​Change Response Status Code​
​Logging​
​Use JSON File as a Body of Request or Response​
​Use multiple JSON files​
​Local Map for GraphQL​
​Use ArrayBuffer in Request/Response Body​
​Preserve the Host​
3. Addons 
​Base64 Encoding/Decoding or atob/btoa​
​Hashing Addon (MD5, SHA1, SHA256, SHA512)​
​UUIDv4 Generator​
​Deflate/Inflate or GZip/UnGZip​
​JWT Decode​
4. Regex 
​Check if a given string contains only numbers​
5. Import / Export Files
​Import JSON File​
​Import Binary Data (Image)​
​Import Text-based file (css, html, js....)​
​Import Files without using the "Import Tool"​
​Write / Export to a local file​
​Map a local file to Response's Body like Map Local Tool (Proxyman 2.25.0+)​
6. Miscellaneous
​By-pass CORS​
​Inject a Header to the Request or Response​
​Response delay with sleep() function​
7. Encryption/Decryption
​AES 
​DES​
HTTP Header
Add/Update: Request or Response Header
request.headers["X-Proxyman-Key"] = "My-Value";
response.headers["X-Proxyman-Key"] = "My-Value";
Delete: Header
delete request.headers["X-Proxyman-Key"];
delete response.headers["X-Proxyman-Key"];
Request Query
Add/Update
request.queries["name"] = "Proxyman";
request.queries["platform"] = "macOS";
// => http://proxyman.io?name=Proxyman&platform=macOS
Delete
delete request.queries["name"];
delete request.queries["platform"];
// => http://proxyman.io
URLEncoded Form Body
Add/Update
// Content-Type: application/x-www-form-urlencoded
var formBody = request.body;
​
formBody["name"] = "Proxyman";
formBody["flatform"] = "macOS";
​
request.body = formBody;
// => name=Proxyman&platform=macOS
Delete 
// Content-Type: application/x-www-form-urlencoded
var formBody = request.body;
​
delete formBody["name"];
delete formBody["flatform"];
​
request.body = formBody;
Change Request Destination (scheme, host, port, path)
request.scheme = "http";
request.host = "proxyman.dev";
request.port = 9090;
request.path = "v1/data/user";
Change HTTP Request Method
request.method = "POST";
Change Response HTTP Status Code
response.statusCode = 404;
JSON Body
Add/Update
// Content-Type: application/json or JSON Families
// Work fine with request or response
var jsonBody = request.body;
​
jsonBody["name"] = "Proxyman";
jsonBody["flatform"] = "macOS";
jsonBody["info"] = { 
                    "website": "proxyman.io",
                    "region": "Earth"
                   };
              
request.body = jsonBody;
​
/*
{
  "name": "Proxyman",
  "platform": "macOS",
  "info": {
    "website": "proxyman.io",
    "region": "Earth"
  }
}
*/
Delete
// Content-Type: application/json or JSON Families
// Work fine with request or response
var jsonBody = request.body;
​
delete jsonBody["name"];
              
request.body = jsonBody;
Use JSON File as a Body of Request or Response
It's possible to use your JSON file and set it as a Request/Response's body
Please follow this tutorial​
Use multiple JSON files
You can use set a different body for each matching endpoint by using the IF statement.
Follow this tutorial to understand how to import a JSON file to the script
Set Script Rule with wildcard or Regex pattern that can match many endpoints. E.g https://my-domain.com/v*
Use `includes()` to check whether or not the endpoint is matched
const file_1 = require("@users/myfile_1.json");
const file_2 = require("@users/myfile_2.json");
const file_3 = require("@users/myfile_3.json");
​
function onResponse(context, url, request, response) {
  
  // Set JSON content
  response.headers["Content-Type"] = "application/json";
  
  // Check
  if (url.includes("v1/data")) {
    response.body = file_1
  } else if (url.includes("v2/login")) {
      response.body = file_2
  } else if (url.includes("v3/user")) {
      response.body = file_3
  }
​
  // Done
  return response;
}
Map Local with GraphQL
Read more at https://github.com/ProxymanApp/Proxyman/issues/412#issuecomment-697101594​
// Import your JSON file here 
const file = require("@users/B02D96D5.default_message_32E64A5B.json");
​
function onRequest(context, url, request) {
​
  // 1. Extract the queryName from the request
  var queryName = request.body.query.match(/\S+/gi)[1].split('(').shift();
​
  // 2. Save to sharedState
  sharedState.queryName = queryName
​
  // Done
  return request;
}
​
function onResponse(context, url, request, response) {
​
  // 3. Check if it's the request we need to map
  if (sharedState.queryName == "user") {
    
    // 4. Import the local file by Action Button -> Import
    // Get the local JSON file and set it as a body (like Map Local)
    response.headers["Content-Type"] = "application/json";
    response.body = file;
  }
​
  // Done
  return response;
}
Use ArrayBuffer in Request/Response Body
Since Javascript doesn't have the Data object type, the Data Body will convert to Base64 Encoded String in Javascript. To pass Uint8Array, blob, or ArrayBuffer to the body, make sure you convert to Base64 Encoded String and set the ContentType to application/octet-stream
Proxyman will convert Base64 Encoding to ArrayBuffer, so the client will receive the data properly. 
// Import
const { btoa } = require('@addons/Base64.js');
​
function onResponse(context, url, request, response) {
  // Construct the ArrayBuffer
  const buffer = new ArrayBuffer(256)
  const view = new Uint8Array(buffer)
  for (let i = 0; i < view.length; i++) {
    view[i] = i
  }
  
  // Convert ArrayBuffer to Base64String
  var newBody = btoa(String.fromCharCode.apply(null, new Uint8Array(buffer)));
  
  // Set new body
  response.body = newBody;
  response.statusCode = 200
  response.headers['Content-Type'] = 'application/octet-stream'
​
  // Done
  return response;
}
Preserve the Host
request.preserveHostHeader = true
Import Files with require()
JSON
Prepare a JSON file and save it to your Desktop
// myfile.json
{
  "name": "Proxyman",
  "platform": "macOS",
  "info": {
    "website": "proxyman.io",
    "region": "Earth"
  }
}
2. More -> Import JSON or Other Files. Then selecting your file 
3. Proxyman will add the import code to the top of the script
// ~/Library/Application Support/com.proxyman.NSProxy/users/myfile.json
const file = require("@users/myfile.json");
​
function onResponse(context, url, request, response) {
  // 1. Set header to JSON if need
  response.headers["Content-Type"] = "application/json";
​
  // 2. Set Body as a imported file
  response.body = file;
  
  return response;
}
The selected file is copied to ~/Library/Application\ Support/com.proxyman.NSProxy/users folder.
To support other format files, such as image, text, pdf. Make sure you have correct Header Content-Type
Binary File
Follow the same above instruction (Select your Binary File)
Set it as a body
// ~/Library/Application Support/com.proxyman.NSProxy/users/myscreenshot.png
const file = require("@users/myscreenshot.png");
​
function onResponse(context, url, request, response) {
  // Set header
  response.headers["Content-Type"] = "image/png";
​
  // Set Body
  response.body = file;
  
  return response;
}
Text-Based File
Follow the same above instruction (Select your Binary File)
Set it as a body
// ~/Library/Application Support/com.proxyman.NSProxy/users/main.css
const file = require("@users/main.css");
​
function onResponse(context, url, request, response) {
  // Set header
  response.headers["Content-Type"] = "text/css";
​
  // Set Body
  response.body = file;
  
  return response;
}
Import File without using the "Import Tool"
From Proxyman 2.24.0+, you can import any files without using the "Import File".
// Import your file from your Desktop folder
const file = require("~/Desktop/myfile.json");
​
function onResponse(context, url, request, response) {
​
  // 1. Set header to JSON if need
  response.headers["Content-Type"] = "application/json";
​
  // 2. Set Body as a imported file
  response.body = file;
  
  return response;
}
If the file has ".js" as an extension => Proxyman will execute it as a JS Script
Otherwise, Proxyman will import it as normal
Only files that are imported by using the "Import Tool", are included when exporting the script to your colleague.
Map a local file to Response's Body like Map Local Tool (Proxyman 2.25.0+)
It's a convenient way to directly set a local file to a Body by using bodyFilePath property
// For request
request.bodyFilePath = "~/Desktop/image.png";
​
// For response
response.bodyFilePath = "~/Desktop/image.png";
function onResponse(context, url, request, response) {
 
  response.headers["Content-Type"] = "image/png";
  response.bodyFilePath = "~/Desktop/image.png";
 
  // Done
  return response;
}
Using Addons
​Full list of built-in addons​
Use Base64 Addon
// Encode Base64
const { btoa } = require("@addons/Base64.js")
​
// Usage:
var text = "HelloWorld";
var encodedText = btoa(text);
// Decode Base64
const { atob } = require("@addons/Base64.js")
​
// Usage:
var text = atob("aGVsbG8=");
Use Hashing Addon (MD5, SHA1, SHA256, SHA512)
// Hash MD5
const { md5 } = require("@addons/MD5.js")
​
// Usage:
var hashedText = md5("Hello World");
// Hash SHA1
const { sha1 } = require("@addons/SHA1.js")
​
// Usage:
var hashedText = sha1("Hello World");
Use UUID-v4 Addon
// Hash MD5
const { uuidv4 } = require("@addons/UUID.js")
​
// Usage:
var uuid = uuidv4();
Deflate/Inflate and GZip/UnGZip
Deflate/inflate
const { inflate, deflate } = require("@addons/Pako.js")
​
// Compress
var input = "Hello World from Pako!!!"
var result = deflate(input);
console.log(result); // eJzzSM3JyVcIzy/KSVFIK8rPVQhIzM5XVFQEAGsMB/8=
​
// Decompress
var text = 'eJzzSM3JyVcIzy/KSVFIK8rPVQhIzM5XVFQEAGsMB/8=';
var rawText = inflate(text);
console.log(rawText); // Hello World from Pako!!!
GZip/UnGZip
const { ungzip, gzip } = require("@addons/Pako.js")
​
// Compress
var text =  'HelloWorld';
var result = gzip(text);
console.log(result); // H4sIAAAAAAAAA/NIzcnJD88vykkBAHkMd3cKAAAA
​
// Decompress
var text =  'H4sIAAAAAAAAA/NIzcnJD88vykkBAHkMd3cKAAAA';
var rawText = ungzip(text);
console.log(rawText); // HelloWorld
JWT Decode
const { jwtDecode } = require('@addons/JWTDecode.js');
​
var text = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
var jSONObject = jwtDecode(text)
Logging
// Print the obj
const myObj = {};
console.log(myObj);
​
// Print type of the obj
console.log(typeof(myObj));
Regex
Only number
//Init Regex
var reg = /^-?\d*\.?\d*$/;
​
if (reg.test("123123123")) {
    console.log("Matched");
}
Miscellaneous
By-pass CORS 
function onResponse(context, url, request, response) {  
​
  // Allow all
  response.headers["Access-Control-Allow-Origin"] = "*";
​
  // Done
  return response;
}
Inject Header to Request / Response 
function onRequest(context, url, request) {
  // add header
  request.headers["My-Injected-Header"] = "Proxyman";
  return request
}
​
function onResponse(context, url, request, response) {    
  // add header
  response.headers["My-Injected-Header"] = "Proxyman";
  return response;
}
​
Response delay with sleep() function
function onResponse(context, url, request, response) {
  console.log("Start sleep");
  
  // Sleep 5 seconds
  sleep(5000);
  
  // Done
  return response;
}
AES Encryption/Decryption
const { encryptAES, decryptAES } = require("@addons/CryptoJS.js")
​
function onRequest(context, url, request) {
  
  // Encrypt
  var message = 'my message from Proxyman';
  var password = 'secret key 123';
  var ciphertext = encryptAES(message, password);
  
  // Decrypt
  var originalText = decryptAES(ciphertext, password);
​
  // Done
  return request;
}
DES Encryption/Decryption
const { encryptDES, decryptDES } = require("@addons/CryptoJS.js")
​
function onRequest(context, url, request) {
  
  // Encrypt
  var message = 'my message from Proxyman';
  var password = 'secret key 123';
  var ciphertext = encryptDES(message, password);
  
  // Decrypt
  var originalText = decryptDES(ciphertext, password);
​
  // Done
  return request;
}
Write / Export to a local file
function onResponse(context, url, request, response) {
​
  // Write to single file
  writeToFile(response.body, "~/Desktop/body.json");
  
  // Write the Body to file with flow ID
  writeToFile(response.body, "~/Desktop/sample-" + context.flow.id);
  
  // Done
  return response;
}
Scripting - Previous
Write your own Addons
Next - Scripting
Environment Variables
Last updated 1 week ago