bnto-core 0.2.0

Core WASM engine library for Bnto — shared types, traits, and orchestration
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

// Parameters for the `output` node: how results leave a recipe.

use super::helpers::{enum_of, param, visible_when};
use crate::metadata::{ParamCondition, ParameterDef, ParameterType};

/// Parameters for the `output` node, in schema order.
pub(super) fn output_params() -> Vec<ParameterDef> {
    vec![
        mode(),
        directory(),
        filename(),
        zip(),
        label(),
        auto_download(),
    ]
}

fn when_write() -> Option<ParamCondition> {
    Some(visible_when("mode", "write"))
}

fn mode() -> ParameterDef {
    let modes = [
        ("write", "Write"),
        ("overwrite", "Overwrite"),
        ("message", "Message"),
        ("none", "None"),
    ];
    let description = "How results are delivered to the user.";
    ParameterDef {
        default: Some(serde_json::json!("write")),
        control: Some("select".to_string()),
        ..param("mode", "Mode", description, enum_of(&modes))
    }
}

fn directory() -> ParameterDef {
    let description = "Output directory path. Supports {{ctx.date}}, {{ctx.timestamp}} templates.";
    ParameterDef {
        default: Some(serde_json::json!("")),
        placeholder: Some("{{ctx.date}}-bulk-download".to_string()),
        visible_when: when_write(),
        ..param(
            "directory",
            "Output Directory",
            description,
            ParameterType::String,
        )
    }
}

fn filename() -> ParameterDef {
    let description = "Filename template for output files.";
    ParameterDef {
        placeholder: Some("compressed-{{name}}".to_string()),
        visible_when: when_write(),
        ..param(
            "filename",
            "Filename Template",
            description,
            ParameterType::String,
        )
    }
}

fn zip() -> ParameterDef {
    let description = "Auto-zip when there are multiple output files.";
    ParameterDef {
        default: Some(serde_json::json!(true)),
        control: Some("switch".to_string()),
        visible_when: when_write(),
        ..param("zip", "ZIP Multiple", description, ParameterType::Boolean)
    }
}

fn label() -> ParameterDef {
    let description = "Label for the download button or display section.";
    ParameterDef {
        placeholder: Some("Compressed Images".to_string()),
        ..param("label", "Label", description, ParameterType::String)
    }
}

fn auto_download() -> ParameterDef {
    let description = "Automatically download results on completion.";
    ParameterDef {
        default: Some(serde_json::json!(true)),
        control: Some("switch".to_string()),
        visible_when: when_write(),
        ..param(
            "autoDownload",
            "Auto-Download",
            description,
            ParameterType::Boolean,
        )
    }
}