@xan105/request/lib/h1/helper.js

Simple HTTP request client with file download progress

/*
Copyright (c) Anthony Beaumont
This source code is licensed under the MIT License
found in the LICENSE file in the root directory of this source tree.
*/

import { promisify } from "node:util";
import { Failure } from "@xan105/error";
import { isArray, isObj } from "@xan105/is";
import { 
  shouldObj, 
  shouldArrayOfStringNotEmpty 
} from "@xan105/is/assert";
import { request } from "./request.js";
import { download } from "./download.js";

//optional peerDependencies
import { load } from "../util/optPeerDep.js";
const xml2js = await load("xml2js");

function post(url, payload, option = {}){
  option.method = "POST";
  return request(url, payload, option);
}

function get(url, option = {}){
  option.method = "GET";
  return request(url, option);
}

function head(url, option = {}){
  option.method = "HEAD";
  return request(url, option);
}

async function getJSON(url, option = {}){
  if (!option.headers) option.headers = {};
  option.headers["Accept"] = "application/json";
  option.method = "GET";

  const { body } = await request(url, option);
  const json = JSON.parse(body, function(key, value) {
    if (key === "__proto__") return; //not allowed
    if(isObj(value))
      return Object.assign(Object.create(null), value);
    else
      return value;
  });
  return json;
}

async function postJSON(url, obj, option = {}){

  shouldObj(obj);
  const payload = JSON.stringify(obj);

  if (!option.headers) option.headers = {};
  option.headers["Accept"] = "application/json";
  option.headers["Content-Type"] = "application/json";
  option.headers["Content-Length"] = payload.length;
  option.method = "POST";
  
  const { body } = await request(url, payload, option);
  const json = JSON.parse(body, function(key, value) {
    if (key === "__proto__") return; //not allowed
    if(isObj(value))
      return Object.assign(Object.create(null), value);
    else
      return value;
  });
  return json;
}

async function getXML(url, option = {}) {
  
  if(!xml2js) throw new Failure("Couldn't load the module xml2js", "ERR_MISSING_OPT_MODULE");
  
  if (!option.headers) option.headers = {};
  option.headers["Accept"] = "application/xml";
  option.method = "GET";

  const { body } = await request(url, option);
  
  const opts = {
    explicitArray: false,
    explicitRoot: false,
    ignoreAttrs: true,
    emptyTag: null,
  };
  
  const xml = await promisify(xml2js.parseString)(body, opts);
  return xml;
}

async function upload(url, payload, option = {}){
  
  if (!payload) throw new Failure("Invalid payload", "ERR_INVALID_ARGS");

  const crlf = "\r\n";
  const headers = `Content-Disposition: form-data; name="${option.fieldname || "file"}"; filename="${option.filename || Date.now()}"` + crlf;
  const boundary = `--${Math.random().toString(16)}`;
  const delimeter = {
    start: `${crlf}--${boundary}`,
    end: `${crlf}--${boundary}--`,
  };

  const _payload = Buffer.concat([
    Buffer.from(delimeter.start + crlf + headers + crlf),
    Buffer.from(payload),
    Buffer.from(delimeter.end),
  ]);

  if (!option.headers) option.headers = {};
  option.headers["Content-Type"] = "multipart/form-data; boundary=" + boundary;
  option.headers["Content-Length"] = _payload.length;
  option.method = "POST";

  const result = await request(url, _payload, option);
  return result;
}

async function downloadAll(listURL, destDir, option, callbackProgress = () => {}){
  
  shouldArrayOfStringNotEmpty(listURL);
  
  //Multiple opt args
  if (typeof option === "function") {
    callbackProgress = option;
    option = null;
  }
  if (!option) option = {};

  const signal = option.signal;
  delete option.signal;
  
  let count = 0;
  const list = [];
  
  for (const [ index, url ] of listURL.entries()) 
  {
    const itemOption = JSON.parse(JSON.stringify(option)); //Obj copy
    itemOption.signal = signal;

    const slice_size = 100 / listURL.length;
    const progressPercent = Math.floor((count / listURL.length) * 100);
    const destination = isArray(destDir) ? destDir[index] : destDir;

    itemOption.filename = isArray(option.filename) ? option.filename[index] : null;
    itemOption.hash = isArray(option.hash) ? option.hash[index] : null;

    const filePath = await download(url, destination, itemOption,  function (itemPercent, ...args) {
      const percent = progressPercent + Math.floor((slice_size / 100) * itemPercent);
      callbackProgress(percent, ...args);
    });
    
    list.push(filePath);
    count += 1;
  }

  return list;
}

export {
  post,
  get,
  head,
  getJSON,
  getJSON as getJson, //alias
  postJSON,
  getXML,
  getXML as getXml, //alias
  upload,
  downloadAll
};