@api3/commons 0.1.0 → 0.3.0

package/dist/processing/unsafe-evaluate.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Evaluates the provided code in a new VM context with the specified global variables.
+ *
+ * **Security Warning:** This function executes the provided code and can have unintended side effects or
+ * vulnerabilities if used with untrusted or malicious input. It's imperative to use this function only with code you
+ * trust completely. Avoid using this function with user-generated code or third-party code that hasn't been thoroughly
+ * reviewed.
+ *
+ * @param code The JavaScript code to evaluate.
+ * @param globalVariables A key-value pair of variables to be made available in the context of the executed code.
+ * @param timeout Duration in milliseconds to wait before terminating the execution.
+ *
+ * @returns The result of the evaluated code.
+ *
+ * @throws Throws an error if the execution exceeds the provided timeout or if there's a problem with the code.
+ *
+ * @example
+ *
+ *const result = unsafeEvaluate('const output = input + 1;', { input: 1 }, 1000);
+ *console.log(result); // Outputs: 2
+ */
+export declare const unsafeEvaluate: (code: string, globalVariables: Record<string, unknown>, timeout: number) => unknown;
+/**
+ * Asynchronously evaluates the provided code in a new VM context with the specified global variables.
+ *
+ * **Security Warning:** This function executes the provided code and can have unintended side effects or
+ * vulnerabilities if used with untrusted or malicious input. It's imperative to use this function only with code you
+ * trust completely. Avoid using this function with user-generated code or third-party code that hasn't been thoroughly
+ * reviewed.
+ *
+ * @param code The JavaScript code to evaluate. The code should call the `resolve` method to return the result of the
+ * evaluation. You may use async/await syntax in the code.
+ * @param globalVariables A key-value pair of variables to be made available in the context of the executed code.
+ * @param timeout Duration in milliseconds to wait before terminating the execution.
+ *
+ * @returns The result of the evaluated code wrapped in a Promise.
+ *
+ * @throws Throws an error if the execution exceeds the provided timeout or if there's a problem with the code.
+ *
+ * @example
+ *
+ *const result = await unsafeEvaluateAsync(
+ *  "const output = {...input, c: 'some-value'}; resolve(output);",
+ *  { input: { a: true, b: 123 } },
+ *  5000
+ *);
+ *console.log(result); // Outputs: { a: true, b: 123, c: 'some-value' }
+ */
+export declare const unsafeEvaluateAsync: (code: string, globalVariables: Record<string, unknown>, timeout: number) => Promise<unknown>;
+//# sourceMappingURL=unsafe-evaluate.d.ts.map

package/dist/processing/unsafe-evaluate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unsafe-evaluate.d.ts","sourceRoot":"","sources":["../../src/processing/unsafe-evaluate.ts"],"names":[],"mappings":"AA+EA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,cAAc,SAAU,MAAM,mBAAmB,OAAO,MAAM,EAAE,OAAO,CAAC,WAAW,MAAM,YAarG,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,mBAAmB,SAAgB,MAAM,mBAAmB,OAAO,MAAM,EAAE,OAAO,CAAC,WAAW,MAAM,qBAoChH,CAAC"}

package/dist/processing/unsafe-evaluate.js

@@ -0,0 +1,178 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unsafeEvaluateAsync = exports.unsafeEvaluate = void 0;
+/* eslint-disable camelcase */
+const node_assert_1 = __importDefault(require("node:assert"));
+const node_async_hooks_1 = __importDefault(require("node:async_hooks"));
+const node_buffer_1 = __importDefault(require("node:buffer"));
+const node_child_process_1 = __importDefault(require("node:child_process"));
+const node_cluster_1 = __importDefault(require("node:cluster"));
+const node_console_1 = __importDefault(require("node:console"));
+const node_constants_1 = __importDefault(require("node:constants"));
+const node_crypto_1 = __importDefault(require("node:crypto"));
+const node_dgram_1 = __importDefault(require("node:dgram"));
+const node_dns_1 = __importDefault(require("node:dns"));
+const node_events_1 = __importDefault(require("node:events"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_http_1 = __importDefault(require("node:http"));
+const node_http2_1 = __importDefault(require("node:http2"));
+const node_https_1 = __importDefault(require("node:https"));
+const node_inspector_1 = __importDefault(require("node:inspector"));
+const node_module_1 = __importDefault(require("node:module"));
+const node_net_1 = __importDefault(require("node:net"));
+const node_os_1 = __importDefault(require("node:os"));
+const node_path_1 = __importDefault(require("node:path"));
+const node_perf_hooks_1 = __importDefault(require("node:perf_hooks"));
+const node_process_1 = __importDefault(require("node:process"));
+const node_readline_1 = __importDefault(require("node:readline"));
+const node_repl_1 = __importDefault(require("node:repl"));
+const node_stream_1 = __importDefault(require("node:stream"));
+const node_string_decoder_1 = __importDefault(require("node:string_decoder"));
+const node_timers_1 = __importDefault(require("node:timers"));
+const node_tls_1 = __importDefault(require("node:tls"));
+const node_trace_events_1 = __importDefault(require("node:trace_events"));
+const node_tty_1 = __importDefault(require("node:tty"));
+const node_url_1 = __importDefault(require("node:url"));
+const node_util_1 = __importDefault(require("node:util"));
+const node_v8_1 = __importDefault(require("node:v8"));
+const node_vm_1 = __importDefault(require("node:vm"));
+const node_worker_threads_1 = __importDefault(require("node:worker_threads"));
+const node_zlib_1 = __importDefault(require("node:zlib"));
+const vm_timers_1 = require("./vm-timers");
+const builtInNodeModules = {
+    assert: node_assert_1.default,
+    async_hooks: node_async_hooks_1.default,
+    buffer: node_buffer_1.default,
+    child_process: node_child_process_1.default,
+    cluster: node_cluster_1.default,
+    console: node_console_1.default,
+    constants: node_constants_1.default,
+    crypto: node_crypto_1.default,
+    dgram: node_dgram_1.default,
+    dns: node_dns_1.default,
+    events: node_events_1.default,
+    fs: node_fs_1.default,
+    http: node_http_1.default,
+    http2: node_http2_1.default,
+    https: node_https_1.default,
+    inspector: node_inspector_1.default,
+    module: node_module_1.default,
+    net: node_net_1.default,
+    os: node_os_1.default,
+    path: node_path_1.default,
+    perf_hooks: node_perf_hooks_1.default,
+    process: node_process_1.default,
+    readline: node_readline_1.default,
+    repl: node_repl_1.default,
+    stream: node_stream_1.default,
+    string_decoder: node_string_decoder_1.default,
+    timers: node_timers_1.default,
+    tls: node_tls_1.default,
+    trace_events: node_trace_events_1.default,
+    tty: node_tty_1.default,
+    url: node_url_1.default,
+    util: node_util_1.default,
+    v8: node_v8_1.default,
+    vm: node_vm_1.default,
+    worker_threads: node_worker_threads_1.default,
+    zlib: node_zlib_1.default,
+};
+/**
+ * Evaluates the provided code in a new VM context with the specified global variables.
+ *
+ * **Security Warning:** This function executes the provided code and can have unintended side effects or
+ * vulnerabilities if used with untrusted or malicious input. It's imperative to use this function only with code you
+ * trust completely. Avoid using this function with user-generated code or third-party code that hasn't been thoroughly
+ * reviewed.
+ *
+ * @param code The JavaScript code to evaluate.
+ * @param globalVariables A key-value pair of variables to be made available in the context of the executed code.
+ * @param timeout Duration in milliseconds to wait before terminating the execution.
+ *
+ * @returns The result of the evaluated code.
+ *
+ * @throws Throws an error if the execution exceeds the provided timeout or if there's a problem with the code.
+ *
+ * @example
+ *
+ *const result = unsafeEvaluate('const output = input + 1;', { input: 1 }, 1000);
+ *console.log(result); // Outputs: 2
+ */
+const unsafeEvaluate = (code, globalVariables, timeout) => {
+    const vmContext = {
+        ...globalVariables,
+        ...builtInNodeModules,
+        deferredOutput: undefined,
+    };
+    node_vm_1.default.runInNewContext(`${code}; deferredOutput = output;`, vmContext, {
+        displayErrors: true,
+        timeout,
+    });
+    return vmContext.deferredOutput;
+};
+exports.unsafeEvaluate = unsafeEvaluate;
+/**
+ * Asynchronously evaluates the provided code in a new VM context with the specified global variables.
+ *
+ * **Security Warning:** This function executes the provided code and can have unintended side effects or
+ * vulnerabilities if used with untrusted or malicious input. It's imperative to use this function only with code you
+ * trust completely. Avoid using this function with user-generated code or third-party code that hasn't been thoroughly
+ * reviewed.
+ *
+ * @param code The JavaScript code to evaluate. The code should call the `resolve` method to return the result of the
+ * evaluation. You may use async/await syntax in the code.
+ * @param globalVariables A key-value pair of variables to be made available in the context of the executed code.
+ * @param timeout Duration in milliseconds to wait before terminating the execution.
+ *
+ * @returns The result of the evaluated code wrapped in a Promise.
+ *
+ * @throws Throws an error if the execution exceeds the provided timeout or if there's a problem with the code.
+ *
+ * @example
+ *
+ *const result = await unsafeEvaluateAsync(
+ *  "const output = {...input, c: 'some-value'}; resolve(output);",
+ *  { input: { a: true, b: 123 } },
+ *  5000
+ *);
+ *console.log(result); // Outputs: { a: true, b: 123, c: 'some-value' }
+ */
+const unsafeEvaluateAsync = async (code, globalVariables, timeout) => {
+    let vmReject;
+    // Make sure the timeout is applied. When the processing snippet uses setTimeout or setInterval, the timeout option
+    // from VM is broken. See: https://github.com/nodejs/node/issues/3020.
+    //
+    // We need to manually clear all timers and reject the processing manually.
+    const timeoutTimer = setTimeout(() => {
+        vmReject(new Error('Timeout exceeded'));
+    }, timeout);
+    return new Promise((resolve, reject) => {
+        const timers = (0, vm_timers_1.createTimers)();
+        const vmResolve = (value) => {
+            timers.clearAll();
+            clearTimeout(timeoutTimer);
+            resolve(value);
+        };
+        vmReject = (reason) => {
+            timers.clearAll();
+            clearTimeout(timeoutTimer);
+            reject(reason);
+        };
+        const vmContext = {
+            ...globalVariables,
+            ...builtInNodeModules,
+            resolve: vmResolve,
+            reject: vmReject,
+            setTimeout: timers.customSetTimeout,
+            setInterval: timers.customSetInterval,
+            clearTimeout: timers.customClearTimeout,
+            clearInterval: timers.customClearInterval,
+        };
+        node_vm_1.default.runInNewContext(code, vmContext, { displayErrors: true, timeout });
+    });
+};
+exports.unsafeEvaluateAsync = unsafeEvaluateAsync;
+//# sourceMappingURL=unsafe-evaluate.js.map

package/dist/processing/unsafe-evaluate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unsafe-evaluate.js","sourceRoot":"","sources":["../../src/processing/unsafe-evaluate.ts"],"names":[],"mappings":";;;;;;AAAA,8BAA8B;AAC9B,8DAAiC;AACjC,wEAA2C;AAC3C,8DAAiC;AACjC,4EAA+C;AAC/C,gEAAmC;AACnC,gEAAmC;AACnC,oEAAuC;AACvC,8DAAiC;AACjC,4DAA+B;AAC/B,wDAA2B;AAC3B,8DAAiC;AACjC,sDAAyB;AACzB,0DAA6B;AAC7B,4DAA+B;AAC/B,4DAA+B;AAC/B,oEAAuC;AACvC,8DAAiC;AACjC,wDAA2B;AAC3B,sDAAyB;AACzB,0DAA6B;AAC7B,sEAAyC;AACzC,gEAAmC;AACnC,kEAAqC;AACrC,0DAA6B;AAC7B,8DAAiC;AACjC,8EAAiD;AACjD,8DAAiC;AACjC,wDAA2B;AAC3B,0EAA6C;AAC7C,wDAA2B;AAC3B,wDAA2B;AAC3B,0DAA6B;AAC7B,sDAAyB;AACzB,sDAAyB;AACzB,8EAAiD;AACjD,0DAA6B;AAE7B,2CAA2C;AAE3C,MAAM,kBAAkB,GAAG;IACzB,MAAM,EAAN,qBAAM;IACN,WAAW,EAAX,0BAAW;IACX,MAAM,EAAN,qBAAM;IACN,aAAa,EAAb,4BAAa;IACb,OAAO,EAAP,sBAAO;IACP,OAAO,EAAP,sBAAO;IACP,SAAS,EAAT,wBAAS;IACT,MAAM,EAAN,qBAAM;IACN,KAAK,EAAL,oBAAK;IACL,GAAG,EAAH,kBAAG;IACH,MAAM,EAAN,qBAAM;IACN,EAAE,EAAF,iBAAE;IACF,IAAI,EAAJ,mBAAI;IACJ,KAAK,EAAL,oBAAK;IACL,KAAK,EAAL,oBAAK;IACL,SAAS,EAAT,wBAAS;IACT,MAAM,EAAN,qBAAM;IACN,GAAG,EAAH,kBAAG;IACH,EAAE,EAAF,iBAAE;IACF,IAAI,EAAJ,mBAAI;IACJ,UAAU,EAAV,yBAAU;IACV,OAAO,EAAP,sBAAO;IACP,QAAQ,EAAR,uBAAQ;IACR,IAAI,EAAJ,mBAAI;IACJ,MAAM,EAAN,qBAAM;IACN,cAAc,EAAd,6BAAc;IACd,MAAM,EAAN,qBAAM;IACN,GAAG,EAAH,kBAAG;IACH,YAAY,EAAZ,2BAAY;IACZ,GAAG,EAAH,kBAAG;IACH,GAAG,EAAH,kBAAG;IACH,IAAI,EAAJ,mBAAI;IACJ,EAAE,EAAF,iBAAE;IACF,EAAE,EAAF,iBAAE;IACF,cAAc,EAAd,6BAAc;IACd,IAAI,EAAJ,mBAAI;CACL,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACI,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,eAAwC,EAAE,OAAe,EAAE,EAAE;IACxG,MAAM,SAAS,GAAG;QAChB,GAAG,eAAe;QAClB,GAAG,kBAAkB;QACrB,cAAc,EAAE,SAAoB;KACrC,CAAC;IAEF,iBAAE,CAAC,eAAe,CAAC,GAAG,IAAI,4BAA4B,EAAE,SAAS,EAAE;QACjE,aAAa,EAAE,IAAI;QACnB,OAAO;KACR,CAAC,CAAC;IAEH,OAAO,SAAS,CAAC,cAAc,CAAC;AAClC,CAAC,CAAC;AAbW,QAAA,cAAc,kBAazB;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACI,MAAM,mBAAmB,GAAG,KAAK,EAAE,IAAY,EAAE,eAAwC,EAAE,OAAe,EAAE,EAAE;IACnH,IAAI,QAAmC,CAAC;IAExC,mHAAmH;IACnH,sEAAsE;IACtE,EAAE;IACF,2EAA2E;IAC3E,MAAM,YAAY,GAAG,UAAU,CAAC,GAAG,EAAE;QACnC,QAAQ,CAAC,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC1C,CAAC,EAAE,OAAO,CAAC,CAAC;IAEZ,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,MAAM,GAAG,IAAA,wBAAY,GAAE,CAAC;QAC9B,MAAM,SAAS,GAAG,CAAC,KAAc,EAAE,EAAE;YACnC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAClB,YAAY,CAAC,YAAY,CAAC,CAAC;YAC3B,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC,CAAC;QACF,QAAQ,GAAG,CAAC,MAAe,EAAE,EAAE;YAC7B,MAAM,CAAC,QAAQ,EAAE,CAAC;YAClB,YAAY,CAAC,YAAY,CAAC,CAAC;YAC3B,MAAM,CAAC,MAAM,CAAC,CAAC;QACjB,CAAC,CAAC;QAEF,MAAM,SAAS,GAAG;YAChB,GAAG,eAAe;YAClB,GAAG,kBAAkB;YACrB,OAAO,EAAE,SAAS;YAClB,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE,MAAM,CAAC,gBAAgB;YACnC,WAAW,EAAE,MAAM,CAAC,iBAAiB;YACrC,YAAY,EAAE,MAAM,CAAC,kBAAkB;YACvC,aAAa,EAAE,MAAM,CAAC,mBAAmB;SAC1C,CAAC;QACF,iBAAE,CAAC,eAAe,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AApCW,QAAA,mBAAmB,uBAoC9B"}

package/dist/processing/vm-timers.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/**
+ * Timers (setTimeout, setInterval) do not work in Node.js vm, see: https://github.com/nodejs/help/issues/1875
+ *
+ * The API is wrapped in a "create" function so that every processing snippet keeps track of its timers and properly
+ * cleans them up after use.
+ */
+export declare const createTimers: () => {
+    customSetTimeout: (fn: () => void, ms: number) => void;
+    customClearTimeout: (id: NodeJS.Timeout) => void;
+    clearAllTimeouts: () => void;
+    customSetInterval: (fn: () => void, ms: number) => void;
+    customClearInterval: (id: NodeJS.Timeout) => void;
+    clearAllIntervals: () => void;
+    clearAll: () => void;
+};
+//# sourceMappingURL=vm-timers.d.ts.map

package/dist/processing/vm-timers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vm-timers.d.ts","sourceRoot":"","sources":["../../src/processing/vm-timers.ts"],"names":[],"mappings":";;;;;AAAA;;;;;GAKG;AACH,eAAO,MAAM,YAAY;2BAGO,MAAM,IAAI,MAAM,MAAM;6BAIpB,OAAO,OAAO;;4BAcf,MAAM,IAAI,MAAM,MAAM;8BAIpB,OAAO,OAAO;;;CA0BhD,CAAC"}

package/dist/processing/vm-timers.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTimers = void 0;
+/**
+ * Timers (setTimeout, setInterval) do not work in Node.js vm, see: https://github.com/nodejs/help/issues/1875
+ *
+ * The API is wrapped in a "create" function so that every processing snippet keeps track of its timers and properly
+ * cleans them up after use.
+ */
+const createTimers = () => {
+    let timeouts = [];
+    const customSetTimeout = (fn, ms) => {
+        timeouts.push(setTimeout(fn, ms));
+    };
+    const customClearTimeout = (id) => {
+        timeouts = timeouts.filter((timeoutId) => timeoutId !== id);
+        clearTimeout(id);
+    };
+    const clearAllTimeouts = () => {
+        for (const element of timeouts) {
+            clearTimeout(element);
+        }
+        timeouts = [];
+    };
+    let intervals = [];
+    const customSetInterval = (fn, ms) => {
+        intervals.push(setInterval(fn, ms));
+    };
+    const customClearInterval = (id) => {
+        intervals = intervals.filter((intervalId) => intervalId !== id);
+        clearInterval(id);
+    };
+    const clearAllIntervals = () => {
+        for (const element of intervals) {
+            clearInterval(element);
+        }
+        intervals = [];
+    };
+    const clearAll = () => {
+        clearAllTimeouts();
+        clearAllIntervals();
+    };
+    return {
+        customSetTimeout,
+        customClearTimeout,
+        clearAllTimeouts,
+        customSetInterval,
+        customClearInterval,
+        clearAllIntervals,
+        clearAll,
+    };
+};
+exports.createTimers = createTimers;
+//# sourceMappingURL=vm-timers.js.map

package/dist/processing/vm-timers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vm-timers.js","sourceRoot":"","sources":["../../src/processing/vm-timers.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACI,MAAM,YAAY,GAAG,GAAG,EAAE;IAC/B,IAAI,QAAQ,GAAqB,EAAE,CAAC;IAEpC,MAAM,gBAAgB,GAAG,CAAC,EAAc,EAAE,EAAU,EAAE,EAAE;QACtD,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IACpC,CAAC,CAAC;IAEF,MAAM,kBAAkB,GAAG,CAAC,EAAkB,EAAE,EAAE;QAChD,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,EAAE,CAAC,CAAC;QAC5D,YAAY,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,GAAG,EAAE;QAC5B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC9B,YAAY,CAAC,OAAO,CAAC,CAAC;SACvB;QACD,QAAQ,GAAG,EAAE,CAAC;IAChB,CAAC,CAAC;IAEF,IAAI,SAAS,GAAqB,EAAE,CAAC;IAErC,MAAM,iBAAiB,GAAG,CAAC,EAAc,EAAE,EAAU,EAAE,EAAE;QACvD,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IACtC,CAAC,CAAC;IAEF,MAAM,mBAAmB,GAAG,CAAC,EAAkB,EAAE,EAAE;QACjD,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC;QAChE,aAAa,CAAC,EAAE,CAAC,CAAC;IACpB,CAAC,CAAC;IAEF,MAAM,iBAAiB,GAAG,GAAG,EAAE;QAC7B,KAAK,MAAM,OAAO,IAAI,SAAS,EAAE;YAC/B,aAAa,CAAC,OAAO,CAAC,CAAC;SACxB;QACD,SAAS,GAAG,EAAE,CAAC;IACjB,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,GAAG,EAAE;QACpB,gBAAgB,EAAE,CAAC;QACnB,iBAAiB,EAAE,CAAC;IACtB,CAAC,CAAC;IAEF,OAAO;QACL,gBAAgB;QAChB,kBAAkB;QAClB,gBAAgB;QAChB,iBAAiB;QACjB,mBAAmB;QACnB,iBAAiB;QACjB,QAAQ;KACT,CAAC;AACJ,CAAC,CAAC;AAnDW,QAAA,YAAY,gBAmDvB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@api3/commons",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "keywords": [],
   "license": "MIT",
   "engines": {
@@ -11,11 +11,11 @@
     "dist",
     "src"
   ],
-  "exports": {
-    "./logger": "./dist/logger/index.js",
-    "./eslint": "./dist/logger/index.js"
-  },
+  "main": "./dist/index.js",
+  "exports": "./dist/index.js",
   "dependencies": {
+    "@api3/ois": "^2.2.1",
+    "@api3/promise-utils": "^0.4.0",
     "@typescript-eslint/eslint-plugin": "^6.2.1",
     "@typescript-eslint/parser": "^6.2.1",
     "eslint-config-next": "^13.1.6",
@@ -28,7 +28,6 @@
     "eslint-plugin-jest-formatting": "^3.1.0",
     "eslint-plugin-lodash": "^7.4.0",
     "eslint-plugin-no-only-tests": "^3.1.0",
-    "eslint-plugin-prefer-arrow": "^1.2.3",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-react": "^7.32.1",
     "eslint-plugin-react-hooks": "^4.6.0",
@@ -49,12 +48,10 @@
     "rimraf": "^5.0.5",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typescript": "^5.2.2",
-    "zod": "^3.22.2"
+    "typescript": "^5.2.2"
   },
   "peerDependencies": {
-    "eslint": "^8.50.0",
-    "zod": "^3.22.2"
+    "eslint": "^8.50.0"
   },
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -64,7 +61,7 @@
     "eslint:fix": "pnpm run eslint:check --fix",
     "prettier:check": "prettier --check \"./**/*.{js,ts,md,json}\"",
     "prettier:fix": "prettier --write \"./**/*.{js,ts,md,json}\"",
-    "test": "jest --passWithNoTests",
+    "test": "jest",
     "tsc": "tsc --project ."
   }
 }

package/src/eslint/README.md

@@ -58,11 +58,6 @@ The configurations are a collection of various rulesets and the config is quite
 - Fix outdated stuff (avoid `!` ts operator when not necessary)
 - Avoid vulnerabilities and errors (Number.parseInt without radix)
 
-But some stylistical rules are too strict for certain projects, for example:
-
-- Enforce `camelCase` for variables and functions, but `kebab-case` for filenames.
-- Prefer arrow functions everywhere instead of regular `function` functions.
-
 Tip: Some rules do have fixer with multiple variants of the fixes. You need to use the IDE to prompt the fixes and
 choose the one you want.
 

package/src/eslint/jest.js

@@ -29,6 +29,7 @@ module.exports = {
             allow: ['afterEach', 'afterAll'],
           },
         ],
+        'prefer-lowercase-title': 'off', // Sometimes we want to start the test with a capital letter and some words are all uppercase (e.g. AWS).
       },
     },
   ],

package/src/eslint/react.js

@@ -42,7 +42,6 @@ module.exports = {
     'react/destructuring-assignment': ['error', 'always', { destructureInSignature: 'ignore' }],
     'react/forbid-component-props': ['error', { forbid: [] }],
     'react/forbid-dom-props': ['error', { forbid: [] }],
-    'react/function-component-definition': 'off', // Arrow functions are managed by other rules.
     'react/jsx-curly-brace-presence': ['error', { props: 'never', children: 'never', propElementValues: 'always' }],
     'react/jsx-curly-newline': 'off', // Conflicts with prettier.
     'react/jsx-filename-extension': 'off', // We use .tsx extension.

package/src/eslint/universal.js

@@ -20,16 +20,7 @@ module.exports = {
     'plugin:promise/recommended',
     'plugin:lodash/recommended',
   ],
-  plugins: [
-    '@typescript-eslint',
-    'deprecation',
-    'functional',
-    'prefer-arrow',
-    'unicorn',
-    'check-file',
-    'import',
-    'lodash',
-  ],
+  plugins: ['@typescript-eslint', 'deprecation', 'functional', 'unicorn', 'check-file', 'import', 'lodash'],
   rules: {
     /* Rule definitions and overrides for standard ESLint rules */
     camelcase: 'error',
@@ -78,16 +69,6 @@ module.exports = {
       },
     ],
 
-    /* Rules to setup enforcement of arrow functions over regular functions */
-    'prefer-arrow/prefer-arrow-functions': [
-      'error',
-      {
-        disallowPrototype: true,
-        singleReturnOnly: false,
-        classPropertiesAllowed: false,
-      },
-    ],
-
     /* Rules to enforce kebab-case folder structure */
     'check-file/folder-naming-convention': [
       'error',
@@ -110,6 +91,7 @@ module.exports = {
     'unicorn/no-array-reduce': 'off', // We are OK with using reduce occasionally, but I agree with the author that the code using reduce can easily get complex.
     'unicorn/no-nested-ternary': 'off', // This rule is smarter than the standard ESLint rule, but conflicts with prettier so it needs to be turned off. Nested ternaries are very unreadable so it's OK if all of them are flagged.
     'unicorn/no-null': 'off', // We use both null and undefined for representing three state objects. We could use a string union instead, but using combination of null and undefined is less verbose.
+    'unicorn/no-object-as-default-parameter': 'off', // Too restrictive. TypeScript can ensure that the default value matches the type.
     'unicorn/no-useless-undefined': ['error', { checkArguments: false }], // We need to disable "checkArguments", because if a function expects a value of type "T | undefined" the undefined value needs to be passed explicitly.
     'unicorn/prefer-module': 'off', // We use CJS for configuration files and tests. There is no rush to migrate to ESM and the configuration files are probably not yet ready for ESM yet.
     'unicorn/prevent-abbreviations': 'off', // This rule reports many false positives and leads to more verbose code.

package/src/index.ts

@@ -1,2 +1,3 @@
-// eslint-disable-next-line no-console
-console.log('works');
+// NOTE: Not exporting ESLint rules because they need to be imported in a special way inside .eslintrc.js config.
+export * from './logger';
+export * from './processing';

package/src/logger/README.md

@@ -6,8 +6,7 @@ Backend-only logger for Node.js packages based on Winston logger.
 
 ## Getting started
 
-1. Install `zod` which is a peer dependency of this module. Zod is used for validating the logger configuration.
-2. Use `createLogger` function to create a logger instance.
+Import `createLogger` function to create a logger instance.
 
 ## Configuration
 

package/src/logger/index.ts

@@ -1,23 +1,20 @@
 import winston from 'winston';
 import { consoleFormat } from 'winston-console-format';
-import { z } from 'zod';
 
-export const logFormatSchema = z.union([z.literal('json'), z.literal('pretty')]);
+export const logFormatOptions = ['json', 'pretty'] as const;
 
-export type LogType = z.infer<typeof logFormatSchema>;
+export type LogFormat = (typeof logFormatOptions)[number];
 
-export const logLevelSchema = z.union([z.literal('debug'), z.literal('info'), z.literal('warn'), z.literal('error')]);
+export const logLevelOptions = ['debug', 'info', 'warn', 'error'] as const;
 
-export type LogLevel = z.infer<typeof logLevelSchema>;
+export type LogLevel = (typeof logLevelOptions)[number];
 
-export const logConfigSchema = z.object({
-  colorize: z.boolean(),
-  enabled: z.boolean(),
-  format: logFormatSchema,
-  minLevel: logLevelSchema,
-});
-
-export type LogConfig = z.infer<typeof logConfigSchema>;
+export interface LogConfig {
+  colorize: boolean;
+  enabled: boolean;
+  format: LogFormat;
+  minLevel: LogLevel;
+}
 
 const createConsoleTransport = (config: LogConfig) => {
   const { colorize, enabled, format } = config;
@@ -104,7 +101,32 @@ const wrapper = (logger: Logger): Logger => {
   } as Logger;
 };
 
+export const validateLogConfig = (config: unknown): LogConfig => {
+  // eslint-disable-next-line lodash/prefer-lodash-typecheck
+  if (typeof config !== 'object' || config === null) {
+    throw new Error('Invalid logger configuration');
+  }
+
+  const { colorize, enabled, format, minLevel } = config as Partial<LogConfig>;
+  // eslint-disable-next-line lodash/prefer-lodash-typecheck
+  if (typeof colorize !== 'boolean') {
+    throw new TypeError('Invalid logger configuration: colorize must be a boolean');
+  }
+  // eslint-disable-next-line lodash/prefer-lodash-typecheck
+  if (typeof enabled !== 'boolean') {
+    throw new TypeError('Invalid logger configuration: enabled must be a boolean');
+  }
+  if (!logFormatOptions.includes(format as any)) {
+    throw new TypeError('Invalid logger configuration: format must be one of "json" or "pretty"');
+  }
+  if (!logLevelOptions.includes(minLevel as any)) {
+    throw new TypeError('Invalid logger configuration: minLevel must be one of "debug", "info", "warn" or "error"');
+  }
+
+  return config as LogConfig;
+};
+
 export const createLogger = (config: LogConfig) => {
-  // Ensure that the configuration is valid according to the schema.
-  return wrapper(createBaseLogger(logConfigSchema.parse(config)));
+  // Ensure that the logger configuration is valid.
+  return wrapper(createBaseLogger(validateLogConfig(config)));
 };

package/src/processing/README.md

@@ -0,0 +1,45 @@
+# Processing
+
+> Implementation of [OIS processing](https://docs.api3.org/reference/ois/latest/processing.html).
+
+The pre/post processing is only supported for Node.js environments and uses internal Node.js modules.
+
+## Documentation
+
+The processing module exports two main functions:
+
+<!-- NOTE: These are copied over from "processing.d.ts" from "dist" file. -->
+
+```ts
+/**
+ * Pre-processes API call parameters based on the provided endpoint's processing specifications.
+ *
+ * @param endpoint The endpoint containing processing specifications.
+ * @param apiCallParameters The parameters to be pre-processed.
+ * @param processingOptions Options to control the async processing behavior like retries and timeouts.
+ *
+ * @returns A promise that resolves to the pre-processed parameters.
+ */
+export declare const preProcessApiCallParameters: (
+  endpoint: Endpoint,
+  apiCallParameters: ApiCallParameters,
+  processingOptions?: GoAsyncOptions
+) => Promise<ApiCallParameters>;
+
+/**
+ * Post-processes the API call response based on the provided endpoint's processing specifications.
+ *
+ * @param apiCallResponse The raw response obtained from the API call.
+ * @param endpoint The endpoint containing processing specifications.
+ * @param apiCallParameters The parameters used in the API call.
+ * @param processingOptions Options to control the async processing behavior like retries and timeouts.
+ *
+ * @returns A promise that resolves to the post-processed API call response.
+ */
+export declare const postProcessApiCallResponse: (
+  apiCallResponse: unknown,
+  endpoint: Endpoint,
+  apiCallParameters: ApiCallParameters,
+  processingOptions?: GoAsyncOptions
+) => Promise<unknown>;
+```

package/src/processing/index.ts

@@ -0,0 +1,3 @@
+export * from './processing';
+export * from './schema';
+export * from './unsafe-evaluate';