@api-client/core 0.3.4 → 0.3.7

package/build/src/testing/getPort.js

@@ -0,0 +1,169 @@
+import net from 'net';
+import os from 'os';
+class Locked extends Error {
+    constructor(port = 0) {
+        super(`${port} is locked`);
+    }
+}
+const lockedPorts = {
+    old: new Set(),
+    young: new Set(),
+};
+// On this interval, the old locked ports are discarded,
+// the young locked ports are moved to old locked ports,
+// and a new young set for locked ports are created.
+const releaseOldLockedPortsIntervalMs = 1000 * 15;
+// Lazily create interval on first use
+let interval;
+const getLocalHosts = () => {
+    const interfaces = os.networkInterfaces();
+    // Add undefined value for createServer function to use default host,
+    // and default IPv4 host in case createServer defaults to IPv6.
+    const results = new Set([undefined, '0.0.0.0']);
+    for (const _interface of Object.values(interfaces)) {
+        if (_interface) {
+            for (const config of _interface) {
+                results.add(config.address);
+            }
+        }
+    }
+    return results;
+};
+const checkAvailablePort = (options) => new Promise((resolve, reject) => {
+    const server = net.createServer();
+    server.unref();
+    server.on('error', reject);
+    server.listen(options, () => {
+        const { port } = server.address();
+        server.close(() => {
+            resolve(port);
+        });
+    });
+});
+const getAvailablePort = async (options, hosts) => {
+    if (options.host || options.port === 0) {
+        return checkAvailablePort(options);
+    }
+    for (const host of hosts) {
+        try {
+            await checkAvailablePort({ port: options.port, host }); // eslint-disable-line no-await-in-loop
+        }
+        catch (error) {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const typed = error;
+            if (!['EADDRNOTAVAIL', 'EINVAL'].includes(typed.code)) {
+                throw typed;
+            }
+        }
+    }
+    return options.port;
+};
+const portCheckSequence = function* (ports) {
+    if (ports) {
+        yield* ports;
+    }
+    yield 0; // Fall back to 0 if anything else failed
+};
+/**
+Get an available TCP port number.
+
+@returns Port number.
+
+@example
+```
+import getPort from 'get-port';
+
+console.log(await getPort());
+//=> 51402
+
+// Pass in a preferred port
+console.log(await getPort({port: 3000}));
+// Will use 3000 if available, otherwise fall back to a random port
+
+// Pass in an array of preferred ports
+console.log(await getPort({port: [3000, 3001, 3002]}));
+// Will use any element in the preferred ports array if available, otherwise fall back to a random port
+```
+*/
+export async function getPort(options) {
+    let ports = [];
+    if (options) {
+        if (typeof options.port === 'number') {
+            ports = [options.port];
+        }
+        else if (options.port) {
+            ports = options.port;
+        }
+    }
+    if (interval === undefined) {
+        interval = setInterval(() => {
+            lockedPorts.old = lockedPorts.young;
+            lockedPorts.young = new Set();
+        }, releaseOldLockedPortsIntervalMs);
+        // Does not exist in some environments (Electron, Jest jsdom env, browser, etc).
+        if (interval.unref) {
+            interval.unref();
+        }
+    }
+    const hosts = getLocalHosts();
+    for (const port of portCheckSequence(ports)) {
+        try {
+            let availablePort = await getAvailablePort({ ...options, port }, hosts); // eslint-disable-line no-await-in-loop
+            while (lockedPorts.old.has(availablePort) || lockedPorts.young.has(availablePort)) {
+                if (port !== 0) {
+                    throw new Locked(port);
+                }
+                availablePort = await getAvailablePort({ ...options, port }, hosts); // eslint-disable-line no-await-in-loop
+            }
+            lockedPorts.young.add(availablePort);
+            if (!availablePort) {
+                throw new Error('No available ports found');
+            }
+            return availablePort;
+        }
+        catch (error) {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const typed = error;
+            if (!['EADDRINUSE', 'EACCES'].includes(typed.code) && !(typed instanceof Locked)) {
+                throw error;
+            }
+        }
+    }
+    throw new Error('No available ports found');
+}
+/**
+Generate port numbers in the given range `from`...`to`.
+
+@param from - The first port of the range. Must be in the range `1024`...`65535`.
+@param to - The last port of the range. Must be in the range `1024`...`65535` and must be greater than `from`.
+@returns The port numbers in the range.
+
+@example
+```
+import getPort, {portNumbers} from 'get-port';
+
+console.log(await getPort({port: portNumbers(3000, 3100)}));
+// Will use any port from 3000 to 3100, otherwise fall back to a random port
+```
+*/
+export function portNumbers(from, to) {
+    if (!Number.isInteger(from) || !Number.isInteger(to)) {
+        throw new TypeError('`from` and `to` must be integer numbers');
+    }
+    if (from < 1024 || from > 65_535) {
+        throw new RangeError('`from` must be between 1024 and 65535');
+    }
+    if (to < 1024 || to > 65_536) {
+        throw new RangeError('`to` must be between 1024 and 65536');
+    }
+    if (to < from) {
+        throw new RangeError('`to` must be greater than or equal to `from`');
+    }
+    const generator = function* (from, to) {
+        for (let port = from; port <= to; port++) {
+            yield port;
+        }
+    };
+    return generator(from, to);
+}
+//# sourceMappingURL=getPort.js.map

package/build/src/testing/getPort.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPort.js","sourceRoot":"","sources":["../../../src/testing/getPort.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAE,MAAM,IAAI,CAAC;AAkBpB,MAAM,MAAO,SAAQ,KAAK;IACzB,YAAY,IAAI,GAAG,CAAC;QACnB,KAAK,CAAC,GAAG,IAAI,YAAY,CAAC,CAAC;IAC5B,CAAC;CACD;AAED,MAAM,WAAW,GAAG;IACnB,GAAG,EAAE,IAAI,GAAG,EAAE;IACd,KAAK,EAAE,IAAI,GAAG,EAAE;CAChB,CAAC;AAEF,wDAAwD;AACxD,wDAAwD;AACxD,oDAAoD;AACpD,MAAM,+BAA+B,GAAG,IAAI,GAAG,EAAE,CAAC;AAElD,sCAAsC;AACtC,IAAI,QAAqB,CAAC;AAE1B,MAAM,aAAa,GAAG,GAA4B,EAAE;IACnD,MAAM,UAAU,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;IAE1C,qEAAqE;IACrE,+DAA+D;IAC/D,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IAEhD,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;QACjD,IAAI,UAAU,EAAE;YACd,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE;gBAC/B,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;aAC7B;SACF;KACH;IAED,OAAO,OAAO,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,OAA0B,EAAmB,EAAE,CAC1E,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;IAC/B,MAAM,MAAM,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC;IAClC,MAAM,CAAC,KAAK,EAAE,CAAC;IACf,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAE3B,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE;QAC3B,MAAM,EAAC,IAAI,EAAC,GAAG,MAAM,CAAC,OAAO,EAAqB,CAAC;QACnD,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE;YACjB,OAAO,CAAC,IAAI,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEJ,MAAM,gBAAgB,GAAG,KAAK,EAAE,OAA0B,EAAE,KAA8B,EAA+B,EAAE;IAC1H,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,KAAK,CAAC,EAAE;QACvC,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC;KACnC;IAED,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACzB,IAAI;YACH,MAAM,kBAAkB,CAAC,EAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC,uCAAuC;SAC7F;QAAC,OAAO,KAAK,EAAE;YACZ,8DAA8D;YAC9D,MAAM,KAAK,GAAG,KAAY,CAAC;YAC9B,IAAI,CAAC,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;gBACtD,MAAM,KAAK,CAAC;aACZ;SACD;KACD;IAED,OAAO,OAAO,CAAC,IAAI,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,QAAS,CAAC,EAAE,KAAmC;IACxE,IAAI,KAAK,EAAE;QACV,KAAM,CAAC,CAAC,KAAK,CAAC;KACd;IAED,MAAM,CAAC,CAAC,CAAC,yCAAyC;AACnD,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;EAoBE;AACF,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,OAAyB;IACtD,IAAI,KAAK,GAAgC,EAAE,CAAC;IAE5C,IAAI,OAAO,EAAE;QACV,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;YACpC,KAAK,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACxB;aAAM,IAAI,OAAO,CAAC,IAAI,EAAE;YACvB,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;SACtB;KACH;IAED,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC3B,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;YAC3B,WAAW,CAAC,GAAG,GAAG,WAAW,CAAC,KAAK,CAAC;YACpC,WAAW,CAAC,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;QAC/B,CAAC,EAAE,+BAA+B,CAAC,CAAC;QAEpC,gFAAgF;QAChF,IAAI,QAAQ,CAAC,KAAK,EAAE;YACnB,QAAQ,CAAC,KAAK,EAAE,CAAC;SACjB;KACD;IAED,MAAM,KAAK,GAAG,aAAa,EAAE,CAAC;IAE9B,KAAK,MAAM,IAAI,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAE;QAC5C,IAAI;YACH,IAAI,aAAa,GAAG,MAAM,gBAAgB,CAAC,EAAC,GAAG,OAAO,EAAE,IAAI,EAAC,EAAE,KAAK,CAAC,CAAC,CAAC,uCAAuC;YAC9G,OAAO,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE;gBAClF,IAAI,IAAI,KAAK,CAAC,EAAE;oBACf,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;iBACvB;gBAED,aAAa,GAAG,MAAM,gBAAgB,CAAC,EAAC,GAAG,OAAO,EAAE,IAAI,EAAC,EAAE,KAAK,CAAC,CAAC,CAAC,uCAAuC;aAC1G;YAED,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YAClC,IAAI,CAAC,aAAa,EAAE;gBAClB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;aAC7C;YACJ,OAAO,aAAa,CAAC;SACrB;QAAC,OAAO,KAAK,EAAE;YACZ,8DAA8D;YAC9D,MAAM,KAAK,GAAG,KAAY,CAAC;YAC9B,IAAI,CAAC,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,YAAY,MAAM,CAAC,EAAE;gBACjF,MAAM,KAAK,CAAC;aACZ;SACD;KACD;IAED,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;;;;;;;;EAcE;AACF,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,EAAU;IACnD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE;QACrD,MAAM,IAAI,SAAS,CAAC,yCAAyC,CAAC,CAAC;KAC/D;IAED,IAAI,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,MAAM,EAAE;QACjC,MAAM,IAAI,UAAU,CAAC,uCAAuC,CAAC,CAAC;KAC9D;IAED,IAAI,EAAE,GAAG,IAAI,IAAI,EAAE,GAAG,MAAM,EAAE;QAC7B,MAAM,IAAI,UAAU,CAAC,qCAAqC,CAAC,CAAC;KAC5D;IAED,IAAI,EAAE,GAAG,IAAI,EAAE;QACd,MAAM,IAAI,UAAU,CAAC,8CAA8C,CAAC,CAAC;KACrE;IAED,MAAM,SAAS,GAAG,QAAS,CAAC,EAAE,IAAY,EAAE,EAAU;QACrD,KAAK,IAAI,IAAI,GAAG,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE;YACzC,MAAM,IAAI,CAAC;SACX;IACF,CAAC,CAAC;IAEF,OAAO,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAC5B,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The ARC core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.3.4",
+  "version": "0.3.7",
   "license": "Apache-2.0",
   "main": "build/index.js",
   "module": "build/index.js",
@@ -89,6 +89,7 @@
     "@metrichor/jmespath": "^0.3.1",
     "@pawel-up/jexl": "^3.0.0",
     "@xmldom/xmldom": "^0.8.1",
+    "console-table-printer": "^2.10.0",
     "form-data": "^4.0.0",
     "json8-patch": "^1.0.6",
     "ws": "^8.5.0",

package/src/lib/calculators/DataCalculator.ts

@@ -0,0 +1,91 @@
+/**
+ * Computations related to the data like size.
+ */
+export class DataCalculator {
+  /**
+   * Computes size in the nearest units
+   */
+  static bytesToSize(bytes: number, decimals = 2): string {
+    if (bytes === 0) {
+      return '0 Bytes';
+    }
+
+    const k = 1024;
+    const dm = decimals < 0 ? 0 : decimals;
+    const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
+
+    const i = Math.floor(Math.log(bytes) / Math.log(k));
+    const result = parseFloat((bytes / k**i).toFixed(dm));
+    return `${result} ${sizes[i]}`;
+  }
+
+  /**
+   * Calculates size of the string
+   * @param str A string to compute size from.
+   * @returns The size of the string.
+   */
+  stringSize(str: string): number {
+    if (!str || !str.length || typeof str !== 'string') {
+      return 0;
+    }
+    let s = str.length;
+    for (let i = str.length - 1; i >= 0; i--) {
+      const code = str.charCodeAt(i);
+      if (code > 0x7f && code <= 0x7ff) {
+        s++;
+      } else if (code > 0x7ff && code <= 0xffff) {
+        /* istanbul ignore next */
+        s += 2;
+      }
+      /* istanbul ignore if */
+      if (code >= 0xDC00 && code <= 0xDFFF) {
+        i--; // trail surrogate
+      }
+    }
+    return s;
+  }
+
+  /**
+   * @param data The size of the form data
+   * @returns The size of the form data
+   */
+  async formDataSize(data: FormData): Promise<number> {
+    if (typeof Request === 'undefined') {
+      return 0;
+    }
+    const request = new Request('/', {
+      method: 'POST',
+      body: data,
+    });
+    if (!request.arrayBuffer) {
+      return 0;
+    }
+    const buffer = await request.arrayBuffer();
+    return buffer.byteLength;
+  }
+
+  /**
+   * Computes size of the payload.
+   *
+   * @param payload The payload to compute te size for 
+   * @returns The size of the payload
+   */
+  async payloadSize(payload: unknown): Promise<number> {
+    if (!payload) {
+      return 0;
+    }
+    if (payload instanceof ArrayBuffer) {
+      return payload.byteLength;
+    }
+    if (typeof Buffer !== 'undefined' && payload instanceof Buffer) {
+      return payload.byteLength;
+    }
+    if (payload instanceof Blob) {
+      return payload.size;
+    }
+    if (payload instanceof FormData) {
+      return this.formDataSize(payload);
+    }
+    return this.stringSize(String(payload));
+  }
+}

package/src/lib/fs/Fs.ts

@@ -0,0 +1,258 @@
+import { writeFile, mkdir, rm, readdir, stat, access, readFile, copyFile as fsCopyFile } from 'fs/promises';
+import { constants } from 'fs';
+import { join, dirname } from 'path';
+
+export interface JsonReadOptions {
+  /**
+   * Whether it should throw an error when a reading error occurs.
+   */
+  throws?: boolean;
+}
+
+// function statPromise(filePath: string): Promise<fsSync.Stats> {
+//   return new Promise((resolve, reject) => {
+//     fsSync.stat(filePath, (err, stats) => {
+//       if (err) {
+//         reject(err);
+//       } else {
+//         resolve(stats);
+//       }
+//     });
+//   });
+// }
+
+/**
+ * Checks whether a file exists in the location.
+ */
+export async function pathExists(filePath: string): Promise<boolean> {
+  // return new Promise((resolve) => {
+  //   fsSync.stat(filePath, (err, stats) => {
+  //     if (err) {
+  //       resolve(false);
+  //     } else {
+  //       resolve(true);
+  //     }
+  //   });
+  // });
+  try {
+    await stat(filePath);
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+
+/**
+ * Tests a user's permissions for the file or directory specified by filePath.
+ * @param filePath The path to test
+ * @returns True when the path can be read by the current user.  
+ */
+export async function canRead(filePath: string): Promise<boolean> {
+  const exists = await pathExists(filePath);
+  if (!exists) {
+    return false;
+  }
+  
+  // return new Promise((resolve) => {
+  //   fsSync.access(filePath, constants.R_OK, (err) => {
+  //     if (err) {
+  //       resolve(false);
+  //     } else {
+  //       resolve(true);
+  //     }
+  //   });
+  // });
+  try {
+    await access(filePath, constants.R_OK);
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+
+/**
+ * Tests a user's permissions for the file or directory specified by filePath.
+ * @param filePath The path to test
+ * @returns True when the path can be written to by the current user.  
+ */
+export async function canWrite(filePath: string): Promise<boolean> {
+  const exists = await pathExists(filePath);
+  if (!exists) {
+    return false;
+  }
+  // return new Promise((resolve) => {
+  //   fsSync.access(filePath, constants.W_OK, (err) => {
+  //     if (err) {
+  //       resolve(false);
+  //     } else {
+  //       resolve(true);
+  //     }
+  //   });
+  // });
+  try {
+    await access(filePath, constants.W_OK);
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+
+/**
+ * Reads the contents of a JSON file.
+ * 
+ * @param filePath The path to the JSON file to read.
+ * @returns The contents of the file. When `throws` options is not set and error occurs then it returns an empty file.
+ */
+export async function readJson(filePath: string, opts: JsonReadOptions={}): Promise<unknown> {
+  const readable = await canRead(filePath);
+  if (!readable) {
+    if (opts.throws) {
+      throw new Error(`Unable to read file: ${filePath}. Access is denied.`);
+    }
+    return {};
+  }
+  // return new Promise((resolve, reject) => {
+  //   fsSync.readFile(filePath, 'utf8', (err, contents) => {
+  //     if (err) {
+  //       reject(err);
+  //     } else {
+  //       let data = {};
+  //       try {
+  //         data = JSON.parse(contents);
+  //       } catch (e) {
+  //         if (opts.throws) {
+  //           const err = new Error(`Invalid JSON contents for file: ${filePath}.`);
+  //           reject(err);
+  //           return;
+  //         }
+  //       }
+  //       resolve(data);
+  //     }
+  //   });
+  // });
+  const contents = await readFile(filePath, 'utf8');
+  let data = {};
+  try {
+    data = JSON.parse(contents);
+  } catch (e) {
+    if (opts.throws) {
+      throw new Error(`Invalid JSON contents for file: ${filePath}.`);
+    }
+  }
+  return data;
+}
+
+/**
+ * Writes the contents to the file.
+ * 
+ * @param filePath The file to write to. It replaces the contents.
+ * @param contents The contents to write.
+ */
+export async function writeJson(filePath: string, contents: string|any): Promise<void> {
+  const destParent = dirname(filePath);
+  await ensureDir(destParent);
+  const parentWritable = await canWrite(destParent);
+  if (!parentWritable) {
+    throw new Error(`Unable to write to location: ${parentWritable}. Access is denied.`);
+  }
+  const data = typeof contents === 'string' ? contents : JSON.stringify(contents);
+  await writeFile(filePath, data);
+}
+
+/**
+ * Ensures the directory exists.
+ */
+export async function ensureDir(dirPath: string): Promise<void> {
+  const readable = await canRead(dirPath);
+  if (readable) {
+    return;
+  }
+  await mkdir(dirPath, { recursive: true });
+}
+
+/**
+ * Removes contents of the directory, leaving the directory in the filesystem.
+ */
+export async function emptyDir(dirPath: string): Promise<void> {
+  const exists = await pathExists(dirPath);
+  if (!exists) {
+    return;
+  }
+  const writeable = await canWrite(dirPath);
+  if (!writeable) {
+    throw new Error(`Unable to clear directory: ${dirPath}. Access is denied.`);
+  }
+  const items = await readdir(dirPath, 'utf8');
+  for (const item of items) {
+    const file = join(dirPath, item);
+    await rm(file, { recursive: true });
+  }
+}
+
+/**
+ * Copies a file
+ */
+async function copyFile(source: string, dest: string): Promise<void> {
+  const destParent = dirname(dest);
+  await ensureDir(destParent);
+  await fsCopyFile(source, dest);
+}
+
+// /**
+//  * Copies a file
+//  * @param {string} source 
+//  * @param {string} dest 
+//  * @returns {Promise<void>}
+//  */
+// async function copyFile(source, dest) {
+//   const destParent = dirname(dest);
+//   await ensureDir(destParent);
+//   return new Promise((resolve, reject) => {
+//     fsSync.copyFile(source, dest, (err) => {
+//       if (err) {
+//         reject(err);
+//       } else {
+//         resolve();
+//       }
+//     });
+//   });
+// }
+
+/**
+ * Copies a directory and its contents.
+ */
+async function copyDirectory(source: string, dest: string): Promise<void> {
+  await ensureDir(dest);
+  // const entries = fsSync.readdirSync(source, { withFileTypes: true, encoding: 'utf8' });
+  const entries = await readdir(source, { withFileTypes: true, encoding: 'utf8' });
+  for (const entry of entries) {
+    const srcFile = join(source, entry.name);
+    const destFile = join(dest, entry.name);
+    const srcStat = await stat(srcFile);
+    if (srcStat.isDirectory()) {
+      await copyDirectory(srcFile, destFile);
+    } else {
+      await copyFile(srcFile, destFile);
+    }
+  }
+}
+
+/**
+ * Copies a file or a directory to the destination location.
+ * It creates the destination folder when missing.
+ * 
+ * @param source The source file or folder.
+ * @param dest The destination file or folder.
+ */
+export async function copy(source: string, dest: string): Promise<void> {
+  const existing = await pathExists(source);
+  if (!existing) {
+    throw new Error(`Specified path does not exist: ${source}`);
+  }
+  const srcStat = await stat(source);
+  if (srcStat.isDirectory()) {
+    await copyDirectory(source, dest);
+  } else {
+    await copyFile(source, dest);
+  }
+}

package/src/lib/parsers/UrlEncoder.ts

@@ -0,0 +1,74 @@
+export class UrlEncoder {
+  /**
+   * Returns a string where all characters that are not valid for a URL
+   * component have been escaped. The escaping of a character is done by
+   * converting it into its UTF-8 encoding and then encoding each of the
+   * resulting bytes as a %xx hexadecimal escape sequence.
+   * <p>
+   * Note: this method will convert any the space character into its escape
+   * short form, '+' rather than %20. It should therefore only be used for
+   * query-string parts.
+   *
+   * <p>
+   * The following character sets are <em>not</em> escaped by this method:
+   * <ul>
+   * <li>ASCII digits or letters</li>
+   * <li>ASCII punctuation characters:
+   *
+   * <pre>- _ . ! ~ * ' ( )</pre>
+   * </li>
+   * </ul>
+   * </p>
+   *
+   * <p>
+   * Notice that this method <em>does</em> encode the URL component delimiter
+   * characters:<blockquote>
+   *
+   * <pre>
+   * ; / ? : &amp; = + $ , #
+   * </pre>
+   *
+   * </blockquote>
+   * </p>
+   *
+   * @param str A string containing invalid URL characters
+   * @param replacePlus When set it replaces `%20` with `+`.
+   * @returns a string with all invalid URL characters escaped
+   */
+  static encodeQueryString(str: string, replacePlus?: boolean): string {
+    if (!str) {
+      return str;
+    }
+    // normalize
+    let result = str.toString().replace(/\r?\n/g, "\r\n");
+    // encode
+    result = encodeURIComponent(result);
+    if (replacePlus) {
+      // replace "%20" with "+" when needed
+      result = result.replace(/%20/g, "+");
+    }
+    return result;
+  }
+
+  /**
+   * Returns a string where all URL component escape sequences have been
+   * converted back to their original character representations.
+   *
+   * Note: this method will convert the space character escape short form, '+',
+   * into a space. It should therefore only be used for query-string parts.
+   *
+   * @param str A string containing encoded URL component sequences
+   * @param replacePlus When set it replaces `+` with `%20`.
+   * @returns string with no encoded URL component encoded sequences
+   */
+  static decodeQueryString(str: string, replacePlus?: boolean): string {
+    if (!str) {
+      return str;
+    }
+    let result = str;
+    if (replacePlus) {
+      result = str.replace(/\+/g, "%20");
+    }
+    return decodeURIComponent(result);
+  }
+}