@api3/commons 0.4.0 → 0.5.0

package/dist/processing/processing.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.postProcessApiCallResponse = exports.preProcessApiCallParameters = exports.addReservedParameters = exports.removeReservedParameters = exports.DEFAULT_PROCESSING_TIMEOUT_MS = void 0;
+exports.postProcessResponse = exports.preProcessEndpointParameters = exports.postProcessResponseV2 = exports.preProcessEndpointParametersV2 = exports.postProcessResponseV1 = exports.preProcessEndpointParametersV1 = exports.addReservedParameters = exports.removeReservedParameters = exports.DEFAULT_PROCESSING_TIMEOUT_MS = void 0;
 const ois_1 = require("@api3/ois");
 const promise_utils_1 = require("@api3/promise-utils");
 const schema_1 = require("./schema");
@@ -8,9 +8,9 @@ const unsafe_evaluate_1 = require("./unsafe-evaluate");
 exports.DEFAULT_PROCESSING_TIMEOUT_MS = 10_000;
 const reservedParameters = ois_1.RESERVED_PARAMETERS; // To avoid strict TS checks.
 /**
- * Removes reserved parameters from the parameters object.
- * @param parameters The API call parameters from which reserved parameters will be removed.
- * @returns The parameters object without reserved parameters.
+ * Removes reserved parameters from the endpoint parameters.
+ * @param parameters The endpoint parameters from which reserved parameters will be removed.
+ * @returns The endpoint parameters without reserved parameters.
  */
 const removeReservedParameters = (parameters) => {
     const result = {};
@@ -23,10 +23,10 @@ const removeReservedParameters = (parameters) => {
 };
 exports.removeReservedParameters = removeReservedParameters;
 /**
- * Re-inserts reserved parameters from the initial parameters object into the modified parameters object.
- * @param initialParameters The initial API call parameters that might contain reserved parameters.
- * @param modifiedParameters The modified API call parameters to which reserved parameters will be added.
- * @returns The modified parameters object with re-inserted reserved parameters.
+ * Re-inserts reserved parameters from the initial endpoint parameters into the modified endpoint parameters.
+ * @param initialParameters The initial endpoint parameters that might contain reserved parameters.
+ * @param modifiedParameters The modified endpoint parameters to which reserved parameters will be added.
+ * @returns The modified endpoint parameters with re-inserted reserved parameters.
  */
 const addReservedParameters = (initialParameters, modifiedParameters) => {
     for (const key in initialParameters) {
@@ -38,33 +38,33 @@ const addReservedParameters = (initialParameters, modifiedParameters) => {
 };
 exports.addReservedParameters = addReservedParameters;
 /**
- * Pre-processes API call parameters based on the provided endpoint's processing specifications.
+ * Pre-processes endpoint 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 preProcessingSpecifications The v1 pre-processing specifications.
+ * @param endpointParameters 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.
  */
-const preProcessApiCallParameters = async (endpoint, apiCallParameters, processingOptions = { retries: 0, totalTimeoutMs: exports.DEFAULT_PROCESSING_TIMEOUT_MS }) => {
-    const { preProcessingSpecifications } = endpoint;
+const preProcessEndpointParametersV1 = async (preProcessingSpecifications, endpointParameters, processingOptions = { retries: 0, totalTimeoutMs: exports.DEFAULT_PROCESSING_TIMEOUT_MS }) => {
     if (!preProcessingSpecifications || preProcessingSpecifications.length === 0) {
-        return apiCallParameters;
+        return endpointParameters;
     }
-    // We only wrap the code through "go" utils because of the timeout and retry logic.
+    // We only wrap the code through "go" utils because of the timeout and retry logic. In case of error, the function
+    // just re-throws.
     const goProcessedParameters = await (0, promise_utils_1.go)(async () => {
-        let currentValue = (0, exports.removeReservedParameters)(apiCallParameters);
+        let currentValue = (0, exports.removeReservedParameters)(endpointParameters);
         for (const processing of preProcessingSpecifications) {
             // Provide endpoint parameters without reserved parameters immutably between steps. Recompute them for each
             // snippet independently because processing snippets can modify the parameters.
-            const endpointParameters = (0, exports.removeReservedParameters)(apiCallParameters);
+            const nonReservedEndpointParameters = (0, exports.removeReservedParameters)(endpointParameters);
             switch (processing.environment) {
                 case 'Node': {
-                    currentValue = await (0, unsafe_evaluate_1.unsafeEvaluate)(processing.value, { input: currentValue, endpointParameters }, processing.timeoutMs);
+                    currentValue = await (0, unsafe_evaluate_1.unsafeEvaluate)(processing.value, { input: currentValue, endpointParameters: nonReservedEndpointParameters }, processing.timeoutMs);
                     break;
                 }
                 case 'Node async': {
-                    currentValue = await (0, unsafe_evaluate_1.unsafeEvaluateAsync)(processing.value, { input: currentValue, endpointParameters }, processing.timeoutMs);
+                    currentValue = await (0, unsafe_evaluate_1.unsafeEvaluateAsync)(processing.value, { input: currentValue, endpointParameters: nonReservedEndpointParameters }, processing.timeoutMs);
                     break;
                 }
             }
@@ -74,40 +74,42 @@ const preProcessApiCallParameters = async (endpoint, apiCallParameters, processi
     if (!goProcessedParameters.success)
         throw goProcessedParameters.error;
     // Let this throw if the processed parameters are invalid.
-    const parsedParameters = (0, schema_1.validateApiCallParameters)(goProcessedParameters.data);
-    // Having removed reserved parameters for pre-processing, we need to re-insert them for the API call.
-    return (0, exports.addReservedParameters)(apiCallParameters, parsedParameters);
+    const parsedParameters = schema_1.endpointParametersSchema.parse(goProcessedParameters.data);
+    // Having removed reserved parameters for pre-processing, we need to re-insert them after pre-processing.
+    return (0, exports.addReservedParameters)(endpointParameters, parsedParameters);
 };
-exports.preProcessApiCallParameters = preProcessApiCallParameters;
+exports.preProcessEndpointParametersV1 = preProcessEndpointParametersV1;
 /**
- * Post-processes the API call response based on the provided endpoint's processing specifications.
+ * Post-processes the response based on the provided endpoint's processing specifications. The response is usually the
+ * API call response, but this logic depends on how the processing is used by the target service. For example, Airnode
+ * allows skipping API calls in which case the response is the result of pre-processing.
  *
- * @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 response The response to be post-processed.
+ * @param postProcessingSpecifications The v1 post-processing specifications.
+ * @param endpointParameters The endpoint parameters.
  * @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.
+ * @returns A promise that resolves to the post-processed response.
  */
-const postProcessApiCallResponse = async (apiCallResponse, endpoint, apiCallParameters, processingOptions = { retries: 0, totalTimeoutMs: exports.DEFAULT_PROCESSING_TIMEOUT_MS }) => {
-    const { postProcessingSpecifications } = endpoint;
+const postProcessResponseV1 = async (response, postProcessingSpecifications, endpointParameters, processingOptions = { retries: 0, totalTimeoutMs: exports.DEFAULT_PROCESSING_TIMEOUT_MS }) => {
     if (!postProcessingSpecifications || postProcessingSpecifications?.length === 0) {
-        return apiCallResponse;
+        return response;
     }
-    // We only wrap the code through "go" utils because of the timeout and retry logic.
+    // We only wrap the code through "go" utils because of the timeout and retry logic. In case of error, the function
+    // just re-throws.
     const goResult = await (0, promise_utils_1.go)(async () => {
-        let currentValue = apiCallResponse;
+        let currentValue = response;
         for (const processing of postProcessingSpecifications) {
             // Provide endpoint parameters without reserved parameters immutably between steps. Recompute them for each
             // snippet independently because processing snippets can modify the parameters.
-            const endpointParameters = (0, exports.removeReservedParameters)(apiCallParameters);
+            const nonReservedEndpointParameters = (0, exports.removeReservedParameters)(endpointParameters);
             switch (processing.environment) {
                 case 'Node': {
-                    currentValue = await (0, unsafe_evaluate_1.unsafeEvaluate)(processing.value, { input: currentValue, endpointParameters }, processing.timeoutMs);
+                    currentValue = await (0, unsafe_evaluate_1.unsafeEvaluate)(processing.value, { input: currentValue, endpointParameters: nonReservedEndpointParameters }, processing.timeoutMs);
                     break;
                 }
                 case 'Node async': {
-                    currentValue = await (0, unsafe_evaluate_1.unsafeEvaluateAsync)(processing.value, { input: currentValue, endpointParameters }, processing.timeoutMs);
+                    currentValue = await (0, unsafe_evaluate_1.unsafeEvaluateAsync)(processing.value, { input: currentValue, endpointParameters: nonReservedEndpointParameters }, processing.timeoutMs);
                     break;
                 }
             }
@@ -118,5 +120,111 @@ const postProcessApiCallResponse = async (apiCallResponse, endpoint, apiCallPara
         throw goResult.error;
     return goResult.data;
 };
-exports.postProcessApiCallResponse = postProcessApiCallResponse;
+exports.postProcessResponseV1 = postProcessResponseV1;
+/**
+ * Pre-processes endpoint parameters based on the provided endpoint's processing specifications.
+ *
+ * @param preProcessingSpecificationV2 The v2 pre-processing specification.
+ * @param endpointParameters 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.
+ */
+const preProcessEndpointParametersV2 = async (preProcessingSpecificationV2, endpointParameters, processingOptions = { retries: 0, totalTimeoutMs: exports.DEFAULT_PROCESSING_TIMEOUT_MS }) => {
+    if (!preProcessingSpecificationV2)
+        return { endpointParameters };
+    // We only wrap the code through "go" utils because of the timeout and retry logic.  In case of error, the function
+    // just re-throws.
+    const goProcessedParameters = await (0, promise_utils_1.go)(async () => {
+        const { environment, timeoutMs, value } = preProcessingSpecificationV2;
+        switch (environment) {
+            case 'Node': {
+                return (0, unsafe_evaluate_1.unsafeEvaluateV2)(value, { endpointParameters: (0, exports.removeReservedParameters)(endpointParameters) }, timeoutMs);
+            }
+        }
+    }, processingOptions);
+    if (!goProcessedParameters.success)
+        throw goProcessedParameters.error;
+    // Let this throw if the processed parameters are invalid.
+    const preProcessingResponse = schema_1.preProcessingV2ResponseSchema.parse(goProcessedParameters.data);
+    // Having removed reserved parameters for pre-processing, we need to re-insert them after pre-processing.
+    return { endpointParameters: (0, exports.addReservedParameters)(endpointParameters, preProcessingResponse.endpointParameters) };
+};
+exports.preProcessEndpointParametersV2 = preProcessEndpointParametersV2;
+/**
+ * Post-processes the response based on the provided endpoint's processing specifications. The response is usually the
+ * API call response, but this logic depends on how the processing is used by the target service. For example, Airnode
+ * allows skipping API calls in which case the response is the result of pre-processing.
+ *
+ * @param response The response to be post-processed.
+ * @param postProcessingSpecificationV2 The v2 post-processing specification.
+ * @param endpointParameters The endpoint parameters.
+ * @param processingOptions Options to control the async processing behavior like retries and timeouts.
+ *
+ * @returns A promise that resolves to the post-processed response.
+ */
+const postProcessResponseV2 = async (response, postProcessingSpecificationV2, endpointParameters, processingOptions = { retries: 0, totalTimeoutMs: exports.DEFAULT_PROCESSING_TIMEOUT_MS }) => {
+    if (!postProcessingSpecificationV2)
+        return { response };
+    // We only wrap the code through "go" utils because of the timeout and retry logic. In case of error, the function
+    // just re-throws.
+    const goResult = await (0, promise_utils_1.go)(async () => {
+        const { environment, timeoutMs, value } = postProcessingSpecificationV2;
+        // Provide endpoint parameters without reserved parameters immutably between steps. Recompute them for each
+        // snippet independently because processing snippets can modify the parameters.
+        const nonReservedEndpointParameters = (0, exports.removeReservedParameters)(endpointParameters);
+        switch (environment) {
+            case 'Node': {
+                return (0, unsafe_evaluate_1.unsafeEvaluateV2)(value, { response, endpointParameters: nonReservedEndpointParameters }, timeoutMs);
+            }
+        }
+    }, processingOptions);
+    if (!goResult.success)
+        throw goResult.error;
+    return schema_1.postProcessingV2ResponseSchema.parse(goResult.data);
+};
+exports.postProcessResponseV2 = postProcessResponseV2;
+/**
+ * Pre-processes endpoint parameters based on the provided endpoint's processing specifications. Internally it
+ * determines what processing implementation should be used.
+ *
+ * @param endpoint The endpoint containing processing specifications.
+ * @param endpointParameters 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.
+ */
+const preProcessEndpointParameters = async (endpoint, endpointParameters, processingOptions = { retries: 0, totalTimeoutMs: exports.DEFAULT_PROCESSING_TIMEOUT_MS }) => {
+    const { preProcessingSpecificationV2, preProcessingSpecifications } = endpoint;
+    if (preProcessingSpecificationV2) {
+        return (0, exports.preProcessEndpointParametersV2)(preProcessingSpecificationV2, endpointParameters);
+    }
+    const preProcessV1Response = await (0, exports.preProcessEndpointParametersV1)(preProcessingSpecifications, endpointParameters, processingOptions);
+    return { endpointParameters: preProcessV1Response };
+};
+exports.preProcessEndpointParameters = preProcessEndpointParameters;
+/**
+ * Post-processes the response based on the provided endpoint's processing specifications. The response is usually the
+ * API call response, but this logic depends on how the processing is used by the target service. For example, Airnode
+ * allows skipping API calls in which case the response is the result of pre-processing.
+ *
+ * This function determines what processing version should be used and provides a common interface. This is useful for
+ * services that want to use processing and don't care which processing version is used.
+ *
+ * @param response The response to be post-processed.
+ * @param endpoint The endpoint containing processing specifications.
+ * @param endpointParameters The endpoint parameters.
+ * @param processingOptions Options to control the async processing behavior like retries and timeouts.
+ *
+ * @returns A promise that resolves to the post-processed response.
+ */
+const postProcessResponse = async (response, endpoint, endpointParameters, processingOptions = { retries: 0, totalTimeoutMs: exports.DEFAULT_PROCESSING_TIMEOUT_MS }) => {
+    const { postProcessingSpecificationV2, postProcessingSpecifications } = endpoint;
+    if (postProcessingSpecificationV2) {
+        return (0, exports.postProcessResponseV2)(response, postProcessingSpecificationV2, endpointParameters);
+    }
+    const postProcessV1Response = await (0, exports.postProcessResponseV1)(response, postProcessingSpecifications, endpointParameters, processingOptions);
+    return { response: postProcessV1Response };
+};
+exports.postProcessResponse = postProcessResponse;
 //# sourceMappingURL=processing.js.map

package/dist/processing/processing.js.map

@@ -1 +1 @@
-{"version":3,"file":"processing.js","sourceRoot":"","sources":["../../src/processing/processing.ts"],"names":[],"mappings":";;;AAAA,mCAA+D;AAC/D,uDAA8D;AAE9D,qCAA6E;AAC7E,uDAAwE;AAE3D,QAAA,6BAA6B,GAAG,MAAM,CAAC;AAEpD,MAAM,kBAAkB,GAAG,yBAA+B,CAAC,CAAC,6BAA6B;AAEzF;;;;GAIG;AACI,MAAM,wBAAwB,GAAG,CAAC,UAA6B,EAAqB,EAAE;IAC3F,MAAM,MAAM,GAAsB,EAAE,CAAC;IAErC,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE;QAC5B,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACrC,MAAM,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;SAC/B;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAVW,QAAA,wBAAwB,4BAUnC;AAEF;;;;;GAKG;AACI,MAAM,qBAAqB,GAAG,CACnC,iBAAoC,EACpC,kBAAqC,EAClB,EAAE;IACrB,KAAK,MAAM,GAAG,IAAI,iBAAiB,EAAE;QACnC,IAAI,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACpC,kBAAkB,CAAC,GAAG,CAAC,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;SAClD;KACF;IAED,OAAO,kBAAkB,CAAC;AAC5B,CAAC,CAAC;AAXW,QAAA,qBAAqB,yBAWhC;AAEF;;;;;;;;GAQG;AACI,MAAM,2BAA2B,GAAG,KAAK,EAC9C,QAAkB,EAClB,iBAAoC,EACpC,oBAAoC,EAAE,OAAO,EAAE,CAAC,EAAE,cAAc,EAAE,qCAA6B,EAAE,EACrE,EAAE;IAC9B,MAAM,EAAE,2BAA2B,EAAE,GAAG,QAAQ,CAAC;IACjD,IAAI,CAAC,2BAA2B,IAAI,2BAA2B,CAAC,MAAM,KAAK,CAAC,EAAE;QAC5E,OAAO,iBAAiB,CAAC;KAC1B;IAED,mFAAmF;IACnF,MAAM,qBAAqB,GAAG,MAAM,IAAA,kBAAE,EAAC,KAAK,IAAI,EAAE;QAChD,IAAI,YAAY,GAAY,IAAA,gCAAwB,EAAC,iBAAiB,CAAC,CAAC;QAExE,KAAK,MAAM,UAAU,IAAI,2BAA2B,EAAE;YACpD,2GAA2G;YAC3G,+EAA+E;YAC/E,MAAM,kBAAkB,GAAG,IAAA,gCAAwB,EAAC,iBAAiB,CAAC,CAAC;YAEvE,QAAQ,UAAU,CAAC,WAAW,EAAE;gBAC9B,KAAK,MAAM,CAAC,CAAC;oBACX,YAAY,GAAG,MAAM,IAAA,gCAAc,EACjC,UAAU,CAAC,KAAK,EAChB,EAAE,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,EAC3C,UAAU,CAAC,SAAS,CACrB,CAAC;oBACF,MAAM;iBACP;gBACD,KAAK,YAAY,CAAC,CAAC;oBACjB,YAAY,GAAG,MAAM,IAAA,qCAAmB,EACtC,UAAU,CAAC,KAAK,EAChB,EAAE,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,EAC3C,UAAU,CAAC,SAAS,CACrB,CAAC;oBACF,MAAM;iBACP;aACF;SACF;QAED,OAAO,YAAY,CAAC;IACtB,CAAC,EAAE,iBAAiB,CAAC,CAAC;IACtB,IAAI,CAAC,qBAAqB,CAAC,OAAO;QAAE,MAAM,qBAAqB,CAAC,KAAK,CAAC;IAEtE,0DAA0D;IAC1D,MAAM,gBAAgB,GAAG,IAAA,kCAAyB,EAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAE/E,qGAAqG;IACrG,OAAO,IAAA,6BAAqB,EAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;AACpE,CAAC,CAAC;AAhDW,QAAA,2BAA2B,+BAgDtC;AAEF;;;;;;;;;GASG;AACI,MAAM,0BAA0B,GAAG,KAAK,EAC7C,eAAwB,EACxB,QAAkB,EAClB,iBAAoC,EACpC,oBAAoC,EAAE,OAAO,EAAE,CAAC,EAAE,cAAc,EAAE,qCAA6B,EAAE,EACjG,EAAE;IACF,MAAM,EAAE,4BAA4B,EAAE,GAAG,QAAQ,CAAC;IAClD,IAAI,CAAC,4BAA4B,IAAI,4BAA4B,EAAE,MAAM,KAAK,CAAC,EAAE;QAC/E,OAAO,eAAe,CAAC;KACxB;IAED,mFAAmF;IACnF,MAAM,QAAQ,GAAG,MAAM,IAAA,kBAAE,EAAC,KAAK,IAAI,EAAE;QACnC,IAAI,YAAY,GAAY,eAAe,CAAC;QAE5C,KAAK,MAAM,UAAU,IAAI,4BAA4B,EAAE;YACrD,2GAA2G;YAC3G,+EAA+E;YAC/E,MAAM,kBAAkB,GAAG,IAAA,gCAAwB,EAAC,iBAAiB,CAAC,CAAC;YACvE,QAAQ,UAAU,CAAC,WAAW,EAAE;gBAC9B,KAAK,MAAM,CAAC,CAAC;oBACX,YAAY,GAAG,MAAM,IAAA,gCAAc,EACjC,UAAU,CAAC,KAAK,EAChB,EAAE,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,EAC3C,UAAU,CAAC,SAAS,CACrB,CAAC;oBACF,MAAM;iBACP;gBACD,KAAK,YAAY,CAAC,CAAC;oBACjB,YAAY,GAAG,MAAM,IAAA,qCAAmB,EACtC,UAAU,CAAC,KAAK,EAChB,EAAE,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,EAC3C,UAAU,CAAC,SAAS,CACrB,CAAC;oBACF,MAAM;iBACP;aACF;SACF;QAED,OAAO,YAAY,CAAC;IACtB,CAAC,EAAE,iBAAiB,CAAC,CAAC;IACtB,IAAI,CAAC,QAAQ,CAAC,OAAO;QAAE,MAAM,QAAQ,CAAC,KAAK,CAAC;IAE5C,OAAO,QAAQ,CAAC,IAAI,CAAC;AACvB,CAAC,CAAC;AA5CW,QAAA,0BAA0B,8BA4CrC"}
+{"version":3,"file":"processing.js","sourceRoot":"","sources":["../../src/processing/processing.ts"],"names":[],"mappings":";;;AAAA,mCAA+D;AAC/D,uDAA8D;AAE9D,qCASkB;AAClB,uDAA0F;AAE7E,QAAA,6BAA6B,GAAG,MAAM,CAAC;AAEpD,MAAM,kBAAkB,GAAG,yBAA+B,CAAC,CAAC,6BAA6B;AAEzF;;;;GAIG;AACI,MAAM,wBAAwB,GAAG,CAAC,UAA8B,EAAsB,EAAE;IAC7F,MAAM,MAAM,GAAuB,EAAE,CAAC;IAEtC,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE;QAC5B,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACrC,MAAM,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;SAC/B;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAVW,QAAA,wBAAwB,4BAUnC;AAEF;;;;;GAKG;AACI,MAAM,qBAAqB,GAAG,CACnC,iBAAqC,EACrC,kBAAsC,EAClB,EAAE;IACtB,KAAK,MAAM,GAAG,IAAI,iBAAiB,EAAE;QACnC,IAAI,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACpC,kBAAkB,CAAC,GAAG,CAAC,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;SAClD;KACF;IAED,OAAO,kBAAkB,CAAC;AAC5B,CAAC,CAAC;AAXW,QAAA,qBAAqB,yBAWhC;AAEF;;;;;;;;GAQG;AACI,MAAM,8BAA8B,GAAG,KAAK,EACjD,2BAAiE,EACjE,kBAAsC,EACtC,oBAAoC,EAAE,OAAO,EAAE,CAAC,EAAE,cAAc,EAAE,qCAA6B,EAAE,EACpE,EAAE;IAC/B,IAAI,CAAC,2BAA2B,IAAI,2BAA2B,CAAC,MAAM,KAAK,CAAC,EAAE;QAC5E,OAAO,kBAAkB,CAAC;KAC3B;IAED,kHAAkH;IAClH,kBAAkB;IAClB,MAAM,qBAAqB,GAAG,MAAM,IAAA,kBAAE,EAAC,KAAK,IAAI,EAAE;QAChD,IAAI,YAAY,GAAY,IAAA,gCAAwB,EAAC,kBAAkB,CAAC,CAAC;QAEzE,KAAK,MAAM,UAAU,IAAI,2BAA2B,EAAE;YACpD,2GAA2G;YAC3G,+EAA+E;YAC/E,MAAM,6BAA6B,GAAG,IAAA,gCAAwB,EAAC,kBAAkB,CAAC,CAAC;YAEnF,QAAQ,UAAU,CAAC,WAAW,EAAE;gBAC9B,KAAK,MAAM,CAAC,CAAC;oBACX,YAAY,GAAG,MAAM,IAAA,gCAAc,EACjC,UAAU,CAAC,KAAK,EAChB,EAAE,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,6BAA6B,EAAE,EAC1E,UAAU,CAAC,SAAS,CACrB,CAAC;oBACF,MAAM;iBACP;gBACD,KAAK,YAAY,CAAC,CAAC;oBACjB,YAAY,GAAG,MAAM,IAAA,qCAAmB,EACtC,UAAU,CAAC,KAAK,EAChB,EAAE,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,6BAA6B,EAAE,EAC1E,UAAU,CAAC,SAAS,CACrB,CAAC;oBACF,MAAM;iBACP;aACF;SACF;QAED,OAAO,YAAY,CAAC;IACtB,CAAC,EAAE,iBAAiB,CAAC,CAAC;IACtB,IAAI,CAAC,qBAAqB,CAAC,OAAO;QAAE,MAAM,qBAAqB,CAAC,KAAK,CAAC;IAEtE,0DAA0D;IAC1D,MAAM,gBAAgB,GAAG,iCAAwB,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAEpF,yGAAyG;IACzG,OAAO,IAAA,6BAAqB,EAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC;AACrE,CAAC,CAAC;AAhDW,QAAA,8BAA8B,kCAgDzC;AAEF;;;;;;;;;;;GAWG;AACI,MAAM,qBAAqB,GAAG,KAAK,EACxC,QAAiB,EACjB,4BAAkE,EAClE,kBAAsC,EACtC,oBAAoC,EAAE,OAAO,EAAE,CAAC,EAAE,cAAc,EAAE,qCAA6B,EAAE,EACjG,EAAE;IACF,IAAI,CAAC,4BAA4B,IAAI,4BAA4B,EAAE,MAAM,KAAK,CAAC,EAAE;QAC/E,OAAO,QAAQ,CAAC;KACjB;IAED,kHAAkH;IAClH,kBAAkB;IAClB,MAAM,QAAQ,GAAG,MAAM,IAAA,kBAAE,EAAC,KAAK,IAAI,EAAE;QACnC,IAAI,YAAY,GAAY,QAAQ,CAAC;QAErC,KAAK,MAAM,UAAU,IAAI,4BAA4B,EAAE;YACrD,2GAA2G;YAC3G,+EAA+E;YAC/E,MAAM,6BAA6B,GAAG,IAAA,gCAAwB,EAAC,kBAAkB,CAAC,CAAC;YACnF,QAAQ,UAAU,CAAC,WAAW,EAAE;gBAC9B,KAAK,MAAM,CAAC,CAAC;oBACX,YAAY,GAAG,MAAM,IAAA,gCAAc,EACjC,UAAU,CAAC,KAAK,EAChB,EAAE,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,6BAA6B,EAAE,EAC1E,UAAU,CAAC,SAAS,CACrB,CAAC;oBACF,MAAM;iBACP;gBACD,KAAK,YAAY,CAAC,CAAC;oBACjB,YAAY,GAAG,MAAM,IAAA,qCAAmB,EACtC,UAAU,CAAC,KAAK,EAChB,EAAE,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,6BAA6B,EAAE,EAC1E,UAAU,CAAC,SAAS,CACrB,CAAC;oBACF,MAAM;iBACP;aACF;SACF;QAED,OAAO,YAAY,CAAC;IACtB,CAAC,EAAE,iBAAiB,CAAC,CAAC;IACtB,IAAI,CAAC,QAAQ,CAAC,OAAO;QAAE,MAAM,QAAQ,CAAC,KAAK,CAAC;IAE5C,OAAO,QAAQ,CAAC,IAAI,CAAC;AACvB,CAAC,CAAC;AA5CW,QAAA,qBAAqB,yBA4ChC;AAEF;;;;;;;;GAQG;AACI,MAAM,8BAA8B,GAAG,KAAK,EACjD,4BAAmE,EACnE,kBAAsC,EACtC,oBAAoC,EAAE,OAAO,EAAE,CAAC,EAAE,cAAc,EAAE,qCAA6B,EAAE,EAC/D,EAAE;IACpC,IAAI,CAAC,4BAA4B;QAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAEjE,mHAAmH;IACnH,kBAAkB;IAClB,MAAM,qBAAqB,GAAG,MAAM,IAAA,kBAAE,EAAC,KAAK,IAAI,EAAE;QAChD,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,4BAA4B,CAAC;QAEvE,QAAQ,WAAW,EAAE;YACnB,KAAK,MAAM,CAAC,CAAC;gBACX,OAAO,IAAA,kCAAgB,EAAC,KAAK,EAAE,EAAE,kBAAkB,EAAE,IAAA,gCAAwB,EAAC,kBAAkB,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;aACjH;SACF;IACH,CAAC,EAAE,iBAAiB,CAAC,CAAC;IACtB,IAAI,CAAC,qBAAqB,CAAC,OAAO;QAAE,MAAM,qBAAqB,CAAC,KAAK,CAAC;IAEtE,0DAA0D;IAC1D,MAAM,qBAAqB,GAAG,sCAA6B,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAE9F,yGAAyG;IACzG,OAAO,EAAE,kBAAkB,EAAE,IAAA,6BAAqB,EAAC,kBAAkB,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,EAAE,CAAC;AACrH,CAAC,CAAC;AAzBW,QAAA,8BAA8B,kCAyBzC;AAEF;;;;;;;;;;;GAWG;AACI,MAAM,qBAAqB,GAAG,KAAK,EACxC,QAAiB,EACjB,6BAAoE,EACpE,kBAAsC,EACtC,oBAAoC,EAAE,OAAO,EAAE,CAAC,EAAE,cAAc,EAAE,qCAA6B,EAAE,EAC9D,EAAE;IACrC,IAAI,CAAC,6BAA6B;QAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;IAExD,kHAAkH;IAClH,kBAAkB;IAClB,MAAM,QAAQ,GAAG,MAAM,IAAA,kBAAE,EAAC,KAAK,IAAI,EAAE;QACnC,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,6BAA6B,CAAC;QACxE,2GAA2G;QAC3G,+EAA+E;QAC/E,MAAM,6BAA6B,GAAG,IAAA,gCAAwB,EAAC,kBAAkB,CAAC,CAAC;QAEnF,QAAQ,WAAW,EAAE;YACnB,KAAK,MAAM,CAAC,CAAC;gBACX,OAAO,IAAA,kCAAgB,EAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,kBAAkB,EAAE,6BAA6B,EAAE,EAAE,SAAS,CAAC,CAAC;aAC5G;SACF;IACH,CAAC,EAAE,iBAAiB,CAAC,CAAC;IACtB,IAAI,CAAC,QAAQ,CAAC,OAAO;QAAE,MAAM,QAAQ,CAAC,KAAK,CAAC;IAE5C,OAAO,uCAA8B,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAC7D,CAAC,CAAC;AAzBW,QAAA,qBAAqB,yBAyBhC;AAEF;;;;;;;;;GASG;AACI,MAAM,4BAA4B,GAAG,KAAK,EAC/C,QAAkB,EAClB,kBAAsC,EACtC,oBAAoC,EAAE,OAAO,EAAE,CAAC,EAAE,cAAc,EAAE,qCAA6B,EAAE,EAC/D,EAAE;IACpC,MAAM,EAAE,4BAA4B,EAAE,2BAA2B,EAAE,GAAG,QAAQ,CAAC;IAC/E,IAAI,4BAA4B,EAAE;QAChC,OAAO,IAAA,sCAA8B,EAAC,4BAA4B,EAAE,kBAAkB,CAAC,CAAC;KACzF;IAED,MAAM,oBAAoB,GAAG,MAAM,IAAA,sCAA8B,EAC/D,2BAA2B,EAC3B,kBAAkB,EAClB,iBAAiB,CAClB,CAAC;IACF,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,CAAC;AACtD,CAAC,CAAC;AAhBW,QAAA,4BAA4B,gCAgBvC;AAEF;;;;;;;;;;;;;;GAcG;AACI,MAAM,mBAAmB,GAAG,KAAK,EACtC,QAAiB,EACjB,QAAkB,EAClB,kBAAsC,EACtC,oBAAoC,EAAE,OAAO,EAAE,CAAC,EAAE,cAAc,EAAE,qCAA6B,EAAE,EAC9D,EAAE;IACrC,MAAM,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,GAAG,QAAQ,CAAC;IACjF,IAAI,6BAA6B,EAAE;QACjC,OAAO,IAAA,6BAAqB,EAAC,QAAQ,EAAE,6BAA6B,EAAE,kBAAkB,CAAC,CAAC;KAC3F;IAED,MAAM,qBAAqB,GAAG,MAAM,IAAA,6BAAqB,EACvD,QAAQ,EACR,4BAA4B,EAC5B,kBAAkB,EAClB,iBAAiB,CAClB,CAAC;IACF,OAAO,EAAE,QAAQ,EAAE,qBAAqB,EAAE,CAAC;AAC7C,CAAC,CAAC;AAlBW,QAAA,mBAAmB,uBAkB9B"}

package/dist/processing/schema.d.ts

@@ -1,3 +1,26 @@
-export declare const validateApiCallParameters: (apiCallParameters: unknown) => ApiCallParameters;
-export type ApiCallParameters = Record<string, any>;
+import type { processingSpecificationSchemaV2, ProcessingSpecification } from '@api3/ois';
+import { z } from 'zod';
+export type ProcessingSpecificationV2 = z.infer<typeof processingSpecificationSchemaV2>;
+export type ProcessingSpecifications = ProcessingSpecification[];
+export declare const endpointParametersSchema: z.ZodRecord<z.ZodString, z.ZodAny>;
+export type EndpointParameters = z.infer<typeof endpointParametersSchema>;
+export declare const preProcessingV2ResponseSchema: z.ZodObject<{
+    endpointParameters: z.ZodRecord<z.ZodString, z.ZodAny>;
+}, "strip", z.ZodTypeAny, {
+    endpointParameters: Record<string, any>;
+}, {
+    endpointParameters: Record<string, any>;
+}>;
+export type PreProcessingV2Response = z.infer<typeof preProcessingV2ResponseSchema>;
+export declare const postProcessingV2ResponseSchema: z.ZodObject<{
+    response: z.ZodAny;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    response?: any;
+    timestamp?: number | undefined;
+}, {
+    response?: any;
+    timestamp?: number | undefined;
+}>;
+export type PostProcessingV2Response = z.infer<typeof postProcessingV2ResponseSchema>;
 //# sourceMappingURL=schema.d.ts.map

package/dist/processing/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/processing/schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,yBAAyB,sBAAuB,OAAO,KAAG,iBAOtE,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/processing/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,+BAA+B,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAC;AAC1F,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAExF,MAAM,MAAM,wBAAwB,GAAG,uBAAuB,EAAE,CAAC;AAEjE,eAAO,MAAM,wBAAwB,oCAAoB,CAAC;AAE1D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,6BAA6B;;;;;;EAExC,CAAC;AAEH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEpF,eAAO,MAAM,8BAA8B;;;;;;;;;EAGzC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC"}

package/dist/processing/schema.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateApiCallParameters = void 0;
-const validateApiCallParameters = (apiCallParameters) => {
-    // eslint-disable-next-line lodash/prefer-lodash-typecheck
-    if (typeof apiCallParameters !== 'object' || apiCallParameters === null) {
-        throw new TypeError('Invalid API call parameters');
-    }
-    return apiCallParameters;
-};
-exports.validateApiCallParameters = validateApiCallParameters;
+exports.postProcessingV2ResponseSchema = exports.preProcessingV2ResponseSchema = exports.endpointParametersSchema = void 0;
+const zod_1 = require("zod");
+exports.endpointParametersSchema = zod_1.z.record(zod_1.z.any());
+exports.preProcessingV2ResponseSchema = zod_1.z.object({
+    endpointParameters: exports.endpointParametersSchema,
+});
+exports.postProcessingV2ResponseSchema = zod_1.z.object({
+    response: zod_1.z.any(),
+    timestamp: zod_1.z.number().nonnegative().int().optional(),
+});
 //# sourceMappingURL=schema.js.map

package/dist/processing/schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/processing/schema.ts"],"names":[],"mappings":";;;AAAO,MAAM,yBAAyB,GAAG,CAAC,iBAA0B,EAAqB,EAAE;IACzF,0DAA0D;IAC1D,IAAI,OAAO,iBAAiB,KAAK,QAAQ,IAAI,iBAAiB,KAAK,IAAI,EAAE;QACvE,MAAM,IAAI,SAAS,CAAC,6BAA6B,CAAC,CAAC;KACpD;IAED,OAAO,iBAAsC,CAAC;AAChD,CAAC,CAAC;AAPW,QAAA,yBAAyB,6BAOpC"}
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/processing/schema.ts"],"names":[],"mappings":";;;AACA,6BAAwB;AAMX,QAAA,wBAAwB,GAAG,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,GAAG,EAAE,CAAC,CAAC;AAI7C,QAAA,6BAA6B,GAAG,OAAC,CAAC,MAAM,CAAC;IACpD,kBAAkB,EAAE,gCAAwB;CAC7C,CAAC,CAAC;AAIU,QAAA,8BAA8B,GAAG,OAAC,CAAC,MAAM,CAAC;IACrD,QAAQ,EAAE,OAAC,CAAC,GAAG,EAAE;IACjB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;CACrD,CAAC,CAAC"}

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

@@ -20,6 +20,7 @@
  *console.log(result); // Outputs: 2
  */
 export declare const unsafeEvaluate: (code: string, globalVariables: Record<string, unknown>, timeout: number) => unknown;
+export declare const unsafeEvaluateV2: (code: string, payload: unknown, timeout: number) => Promise<any>;
 /**
  * Asynchronously evaluates the provided code in a new VM context with the specified global variables.
  *

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

@@ -1 +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"}
+{"version":3,"file":"unsafe-evaluate.d.ts","sourceRoot":"","sources":["../../src/processing/unsafe-evaluate.ts"],"names":[],"mappings":"AAiFA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,cAAc,SAAU,MAAM,mBAAmB,OAAO,MAAM,EAAE,OAAO,CAAC,WAAW,MAAM,YAarG,CAAC;AAEF,eAAO,MAAM,gBAAgB,SAAgB,MAAM,WAAW,OAAO,WAAW,MAAM,iBAmCrF,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

@@ -3,7 +3,7 @@ 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;
+exports.unsafeEvaluateAsync = exports.unsafeEvaluateV2 = 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"));
@@ -41,6 +41,7 @@ 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 promise_utils_1 = require("@api3/promise-utils");
 const vm_timers_1 = require("./vm-timers");
 const builtInNodeModules = {
     assert: node_assert_1.default,
@@ -114,6 +115,35 @@ const unsafeEvaluate = (code, globalVariables, timeout) => {
     return vmContext.deferredOutput;
 };
 exports.unsafeEvaluate = unsafeEvaluate;
+const unsafeEvaluateV2 = async (code, payload, timeout) => {
+    const timers = (0, vm_timers_1.createTimers)();
+    const goEvaluate = await (0, promise_utils_1.go)(
+    // eslint-disable-next-line @typescript-eslint/require-await
+    async () => node_vm_1.default.runInNewContext(`
+          (async () => {
+            return await (${code})(payload)
+          })();
+        `, {
+        ...builtInNodeModules,
+        setTimeout: timers.customSetTimeout,
+        setInterval: timers.customSetInterval,
+        clearTimeout: timers.customClearTimeout,
+        clearInterval: timers.customClearInterval,
+        payload,
+    }, { displayErrors: true, timeout }), 
+    // 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.
+    { totalTimeoutMs: timeout });
+    // We need to manually clear all timers and reject the processing manually.
+    timers.clearAll();
+    if (goEvaluate.success) {
+        return goEvaluate.data;
+    }
+    else {
+        throw goEvaluate.error.reason ?? goEvaluate.error;
+    }
+};
+exports.unsafeEvaluateV2 = unsafeEvaluateV2;
 /**
  * Asynchronously evaluates the provided code in a new VM context with the specified global variables.
  *

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

@@ -1 +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"}
+{"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,uDAA8D;AAE9D,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;AAEK,MAAM,gBAAgB,GAAG,KAAK,EAAE,IAAY,EAAE,OAAgB,EAAE,OAAe,EAAE,EAAE;IACxF,MAAM,MAAM,GAAG,IAAA,wBAAY,GAAE,CAAC;IAE9B,MAAM,UAAU,GAAG,MAAM,IAAA,kBAAE;IACzB,4DAA4D;IAC5D,KAAK,IAAI,EAAE,CACT,iBAAE,CAAC,eAAe,CAChB;;4BAEoB,IAAI;;SAEvB,EACD;QACE,GAAG,kBAAkB;QACrB,UAAU,EAAE,MAAM,CAAC,gBAAgB;QACnC,WAAW,EAAE,MAAM,CAAC,iBAAiB;QACrC,YAAY,EAAE,MAAM,CAAC,kBAAkB;QACvC,aAAa,EAAE,MAAM,CAAC,mBAAmB;QACzC,OAAO;KACR,EACD,EAAE,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE,CACjC;IACH,mHAAmH;IACnH,sEAAsE;IACtE,EAAE,cAAc,EAAE,OAAO,EAAE,CAC5B,CAAC;IAEF,2EAA2E;IAC3E,MAAM,CAAC,QAAQ,EAAE,CAAC;IAElB,IAAI,UAAU,CAAC,OAAO,EAAE;QACtB,OAAO,UAAU,CAAC,IAAI,CAAC;KACxB;SAAM;QACL,MAAO,UAAU,CAAC,KAAK,CAAC,MAAgB,IAAI,UAAU,CAAC,KAAK,CAAC;KAC9D;AACH,CAAC,CAAC;AAnCW,QAAA,gBAAgB,oBAmC3B;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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@api3/commons",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "keywords": [],
   "license": "MIT",
   "engines": {
@@ -14,7 +14,7 @@
   "main": "./dist/index.js",
   "exports": "./dist/index.js",
   "dependencies": {
-    "@api3/ois": "^2.2.1",
+    "@api3/ois": "^2.3.0",
     "@api3/promise-utils": "^0.4.0",
     "@typescript-eslint/eslint-plugin": "^6.2.1",
     "@typescript-eslint/parser": "^6.2.1",
@@ -32,9 +32,11 @@
     "eslint-plugin-react": "^7.32.1",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-unicorn": "^48.0.1",
+    "ethers": "^5.7.2",
     "lodash": "^4.17.21",
     "winston": "^3.10.0",
-    "winston-console-format": "^1.0.8"
+    "winston-console-format": "^1.0.8",
+    "zod": "^3.22.4"
   },
   "devDependencies": {
     "@types/jest": "^29.5.5",

package/src/blockchain-utilities/README.md

@@ -0,0 +1,5 @@
+# Blockchain Utilities
+
+## A set of blockchain-related utility functions that are commonly used by API3 applications
+
+Refer to the per-function documentation.

package/src/blockchain-utilities/derivation.test.ts

@@ -0,0 +1,147 @@
+import { ethers } from 'ethers';
+
+import {
+  deriveAirnodeXpub,
+  deriveBeaconId,
+  deriveBeaconSetId,
+  deriveEndpointId,
+  deriveSponsorWallet,
+  deriveTemplateId,
+  deriveWalletPathFromSponsorAddress,
+  fromBytes32String,
+  PROTOCOL_IDS,
+  toBytes32String,
+} from './derivation';
+
+describe('deriveWalletPathFromSponsorAddress', () => {
+  it('converts address to derivation path', () => {
+    const sponsorAddress = '0x8A45eac0267dD0803Fd957723EdE10693A076698';
+    const res = deriveWalletPathFromSponsorAddress(sponsorAddress, PROTOCOL_IDS.AIRSEEKER);
+    expect(res).toBe('5/973563544/2109481170/2137349576/871269377/610184194/17');
+
+    const randomAddress = ethers.utils.getAddress(ethers.utils.hexlify(ethers.utils.randomBytes(20)));
+    const randomPath = deriveWalletPathFromSponsorAddress(randomAddress, PROTOCOL_IDS.AIRSEEKER);
+    expect(res).not.toStrictEqual(randomPath);
+  });
+
+  it('converts zero address to derivation path', () => {
+    const sponsorAddress = ethers.constants.AddressZero;
+    const res = deriveWalletPathFromSponsorAddress(sponsorAddress, PROTOCOL_IDS.AIRSEEKER);
+    expect(res).toBe('5/0/0/0/0/0/0');
+  });
+
+  it('throws if address is null', () => {
+    const sponsorAddress = null;
+    expect(() => deriveWalletPathFromSponsorAddress(sponsorAddress!, PROTOCOL_IDS.AIRSEEKER)).toThrow(
+      expect.objectContaining({ name: expect.stringContaining('Error') })
+    );
+  });
+
+  it('throws if address is undefined', () => {
+    const sponsorAddress = undefined;
+    expect(() => deriveWalletPathFromSponsorAddress(sponsorAddress!, PROTOCOL_IDS.AIRSEEKER)).toThrow(
+      expect.objectContaining({ name: expect.stringContaining('Error') })
+    );
+  });
+
+  it('throws if address is an empty string', () => {
+    const sponsorAddress = '';
+    expect(() => deriveWalletPathFromSponsorAddress(sponsorAddress, PROTOCOL_IDS.AIRSEEKER)).toThrow(
+      expect.objectContaining({ name: expect.stringContaining('Error') })
+    );
+  });
+
+  it('throws if address is invalid', () => {
+    let sponsorAddress = '7dD0803Fd957723EdE10693A076698';
+    expect(() => deriveWalletPathFromSponsorAddress(sponsorAddress, PROTOCOL_IDS.AIRSEEKER)).toThrow(
+      expect.objectContaining({ name: expect.stringContaining('Error') })
+    );
+
+    sponsorAddress = ethers.utils.hexlify(ethers.utils.randomBytes(4));
+    expect(() => deriveWalletPathFromSponsorAddress(sponsorAddress, PROTOCOL_IDS.AIRSEEKER)).toThrow(
+      expect.objectContaining({ name: expect.stringContaining('Error') })
+    );
+
+    sponsorAddress = ethers.utils.hexlify(ethers.utils.randomBytes(32));
+    expect(() => deriveWalletPathFromSponsorAddress(sponsorAddress, PROTOCOL_IDS.AIRSEEKER)).toThrow(
+      expect.objectContaining({ name: expect.stringContaining('Error') })
+    );
+  });
+
+  describe('blockchain utilities', () => {
+    it('derives a sponsor wallet', () => {
+      const dapiName = ethers.utils.formatBytes32String('BTC/ETH');
+      const sponsorWallet = deriveSponsorWallet(
+        'test test test test test test test test test test test junk',
+        dapiName
+      );
+
+      expect(sponsorWallet.address).toBe('0x1e6f0dfb1775f5032f12f56a01526351eD3F07aF');
+    });
+
+    it('throws deriving a sponsor wallet due to an invalid DApi name', () => {
+      const dapiName = 'invalid dapi name';
+      const throwingFn = () =>
+        deriveSponsorWallet('test test test test test test test test test test test junk', dapiName);
+
+      expect(throwingFn).toThrow(expect.objectContaining({ name: expect.stringContaining('Error') }));
+    });
+
+    it(`derives an airnode's xpub from a mnemonic`, () => {
+      const xpub = deriveAirnodeXpub('test test test test test test test test test test test junk');
+
+      expect(xpub).toBe(
+        'xpub6Ce9NcJvTk36xtLSrJLZqE7wtgA5deCeYs7rSQtreh4cj6ByPtrg9sD7V2FNFLPnf8heNP3FGkeV9qwfzvZNSd54JoNXVsXFYSYwHsnJxqP'
+      );
+    });
+
+    it(`derives an endpoint ID`, () => {
+      const endpointId = deriveEndpointId('weather', 'temperature');
+
+      expect(endpointId).toBe('0x5a82d40e44ecd3ef0906e9e82c1a20f2f4ffe4f613ac70f999047496a9cd4635');
+    });
+
+    it(`it derives a template ID`, () => {
+      const templateId = deriveTemplateId({
+        airnode: '0x4E95C31894a89CdC4288669A6F294836948c862b',
+        endpointId: '0x5a82d40e44ecd3ef0906e9e82c1a20f2f4ffe4f613ac70f999047496a9cd4635',
+        encodedParameters: '0x1234',
+      });
+
+      expect(templateId).toBe('0x7655363f294273f84bcc7c47d79858cf46f21951deee92746d9f17a69ac0b0c0');
+    });
+
+    it('derives a beacon ID', () => {
+      const beaconId = deriveBeaconId(
+        '0xc52EeA00154B4fF1EbbF8Ba39FDe37F1AC3B9Fd4',
+        '0x457a3b3da67e394a895ea49e534a4d91b2d009477bef15eab8cbed313925b010'
+      );
+
+      expect(beaconId).toBe('0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc6');
+    });
+
+    it(`derives a beacon set ID`, () => {
+      const beaconSetId = deriveBeaconSetId([
+        '0x0e30ed302a3c8eeaa0053caf5fbd0825c86ce1767584d12c69c310f0068b1176',
+        '0x496092597aef79595df1567412c6ddefd037f63a5a1572702dd469f62f31f469',
+        '0x84c1da28b2f29f0a2b0ff360d537d405d1cd69249fcf5f32ae9c2298cee6da12',
+        '0xe8655dc68f2b765c5e6d4a042ba7ba8606cf37e1c8c96676f85364ec5bfe9163',
+        '0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc6',
+      ]);
+
+      expect(beaconSetId).toBe('0x33bf380fd5b06a317a905b23eaf5c61ef0a9b4a20589a1bf1d13133daca34b0e');
+    });
+
+    it('encodes a string as a bytes32 string', () => {
+      const formattedString = toBytes32String('test string');
+
+      expect(formattedString).toBe('0x7465737420737472696e67000000000000000000000000000000000000000000');
+    });
+
+    it('decodes a bytes32 string to a normal string', () => {
+      const formattedString = fromBytes32String('0x7465737420737472696e67000000000000000000000000000000000000000000');
+
+      expect(formattedString).toBe('test string');
+    });
+  });
+});