camel-language-js 0.45.2

JavaScript language plugin for camel-language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

//! [`JsEngine`] trait — abstraction over the JS runtime.

use std::collections::HashMap;

use serde_json::Value;

use crate::error::JsLanguageError;

/// A snapshot of exchange state passed into and out of JS evaluation.
#[derive(Debug, Clone, Default)]
pub struct JsExchange {
    pub headers: HashMap<String, Value>,
    pub body: Value,
    pub properties: HashMap<String, Value>,
}

impl JsExchange {
    pub fn from_headers_body_properties(
        headers: HashMap<String, Value>,
        body: Value,
        properties: HashMap<String, Value>,
    ) -> Self {
        Self {
            headers,
            body,
            properties,
        }
    }
}

/// The result of evaluating a JS expression.
#[derive(Debug, Clone)]
pub struct JsEvalResult {
    /// The return value of the expression (last evaluated value).
    pub return_value: Value,
    /// Possibly-modified headers after execution.
    pub headers: HashMap<String, Value>,
    /// Possibly-modified body after execution.
    pub body: Value,
    /// Possibly-modified properties after execution.
    pub properties: HashMap<String, Value>,
}

/// Abstraction over a JavaScript engine capable of evaluating expressions
/// against a [`JsExchange`] context.
pub trait JsEngine: Send + Sync + 'static {
    /// Evaluate `source` JavaScript code with the given exchange context.
    ///
    /// Returns the result including the (potentially mutated) exchange state.
    fn eval(&self, source: &str, exchange: JsExchange) -> Result<JsEvalResult, JsLanguageError>;

    /// Validate that `source` is syntactically valid JavaScript without executing it.
    fn validate(&self, source: &str) -> Result<(), JsLanguageError>;
}