zebflow 0.11.3

Reactive web automation platform — pipelines, templates, and real-time collaboration in a single binary.
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

//! Manual trigger node.

use async_trait::async_trait;
use serde::{Deserialize, Serialize};

use crate::pipeline::model::{LayoutItem, NodeFieldDef, NodeFieldType};
use crate::pipeline::{
    NodeDefinition, PipelineError,
    nodes::{NodeExecutionInput, NodeExecutionOutput, NodeHandler},
};

pub const NODE_KIND: &str = "trigger.manual";
pub const OUTPUT_PIN_OUT: &str = "out";
/// The key this trigger answers under.
pub const ANSWER_KEY: &str = "manual";

/// Unified node-definition metadata for `trigger.manual`.
pub fn definition() -> NodeDefinition {
    NodeDefinition {
        kind: NODE_KIND.to_string(),
        title: "Manual Trigger".to_string(),
        description: "Starts the pipeline when someone runs it by hand. That is the Studio's Run button, `POST /pipelines/execute` with \
            `trigger: \"manual\"`, or the console's `execute pipeline`. Answers one key, `manual`: whatever `input` the caller sent, \
            unchanged (`{}` when nothing was sent) — the Run form sends `{ body, files }`, so a field is `input.manual.body.<name>`, \
            and `$trigger.body.<name>` anywhere later. Use it for one-off jobs and admin actions; a pipeline another pipeline should call is \
            `trigger.function`, and one that runs on its own is `trigger.schedule`."
            .to_string(),
        input_schema: serde_json::json!({
            "type":"object",
            "description":"Manual execution payload."
        }),
        output_schema: serde_json::json!({
            "type":"object",
            "description":"The caller's input, under `manual`."
        }),
        input_pins: vec![],
        output_pins: vec![OUTPUT_PIN_OUT.to_string()],
        script_available: false,
        script_bridge: None,
        config_schema: Default::default(),
        dsl_flags: Default::default(),
        fields: vec![NodeFieldDef {
            name: "__manual_note".to_string(),
            label: "Manual Trigger".to_string(),
            field_type: NodeFieldType::Text,
            readonly: true,
            default_value: Some(serde_json::json!(
                "Runs only when pipeline execute trigger=manual."
            )),
            help: Some(
                "Read-only note: this trigger fires only from explicit manual pipeline execution."
                    .to_string(),
            ),
            ..Default::default()
        }],
        layout: vec![LayoutItem::Field("__manual_note".to_string())],
        ai_tool: Default::default(),
        examples: vec![
            crate::pipeline::model::NodeExample::dsl("A job run from the Studio", "trigger.manual")
                .input(serde_json::json!({ "body": { "dry_run": true } }))
                .output(serde_json::json!({ "manual": { "body": { "dry_run": true } } }))
                .note("The next node reads `input.manual.body.dry_run` (or `$trigger.body.dry_run`); with no input the answer is `manual: {}`."),
        ],
        ..Default::default()
    }
}

/// The `$trigger` snapshot of a manual run: the envelope the caller sent —
/// the same value the trigger answers under `manual` — with the request
/// keys a manual run does not have filled empty.
///
/// `kinds/node-io`: "the originals are reachable forever via `$trigger`". A
/// manual run has no route, so `params`, `query` and `auth` are empty — but
/// its envelope, `body` and `files`, is what an `input.*` node declared and
/// what a script reads back after a node has replaced the payload.
pub fn trigger_snapshot(input: &serde_json::Value) -> serde_json::Value {
    let mut snapshot = match input {
        serde_json::Value::Object(map) => map.clone(),
        _ => serde_json::Map::new(),
    };
    snapshot.entry("body").or_insert(serde_json::Value::Null);
    snapshot.entry("files").or_insert_with(|| serde_json::json!({}));
    snapshot.entry("params").or_insert_with(|| serde_json::json!({}));
    snapshot.entry("query").or_insert_with(|| serde_json::json!({}));
    snapshot.entry("auth").or_insert(serde_json::Value::Null);
    serde_json::Value::Object(snapshot)
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Config {}

pub struct Node;

impl Node {
    pub fn new(_config: Config) -> Self {
        Self
    }
}

#[async_trait]
impl NodeHandler for Node {
    fn kind(&self) -> &'static str {
        NODE_KIND
    }
    fn input_pins(&self) -> &'static [&'static str] {
        &[]
    }
    fn output_pins(&self) -> &'static [&'static str] {
        &[OUTPUT_PIN_OUT]
    }

    async fn execute_async(
        &self,
        input: NodeExecutionInput,
    ) -> Result<NodeExecutionOutput, PipelineError> {
        Ok(NodeExecutionOutput {
            output_pins: vec![OUTPUT_PIN_OUT.to_string()],
            payload: super::answer_under(ANSWER_KEY, input.payload),
            trace: vec![format!("node_kind={NODE_KIND}")],
        })
    }
}