greentic-interfaces 1.1.1

Greentic ABI: WIT contracts, generated bindings, thin mappers
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
123
124
125
126
127
128

// SPDX-License-Identifier: MIT

package greentic:component@0.6.0;

interface control {
  should-cancel: func() -> bool;
  yield-now: func();
}

interface node {
  use greentic:types-core/core@0.6.0.{capability-id, component-id, flow-id, node-error, step-id, tenant-ctx};

  record invocation-envelope {
    ctx: tenant-ctx,
    flow-id: flow-id,
    step-id: step-id,
    component-id: component-id,
    attempt: u32,
    payload-cbor: list<u8>,
    metadata-cbor: option<list<u8>>,
  }

  record invocation-result {
    ok: bool,
    output-cbor: list<u8>,
    output-metadata-cbor: option<list<u8>>,
  }

  variant schema-source {
    cbor-schema-id(string),
    inline-cbor(list<u8>),
    ref-pack-path(string),
    ref-uri(string),
  }

  record io-schema {
    schema: schema-source,
    content-type: string,
    schema-version: option<string>,
  }

  record example {
    title: string,
    input-cbor: list<u8>,
    output-cbor: list<u8>,
  }

  record schema-ref {
    id: string,
    content-type: string,
    blake3-hash: string,
    version: string,
    bytes: option<list<u8>>,
    uri: option<string>,
  }

  record setup-example {
    title: string,
    answers-cbor: list<u8>,
  }

  record setup-template-scaffold {
    template-ref: string,
    output-layout: option<string>,
  }

  variant setup-output {
    config-only,
    template-scaffold(setup-template-scaffold),
  }

  record setup-contract {
    qa-spec: schema-source,
    answers-schema: schema-source,
    examples: list<setup-example>,
    outputs: list<setup-output>,
  }

  record op {
    name: string,
    summary: option<string>,
    input: io-schema,
    output: io-schema,
    examples: list<example>,
  }

  record component-descriptor {
    name: string,
    version: string,
    summary: option<string>,
    capabilities: list<capability-id>,
    ops: list<op>,
    schemas: list<schema-ref>,
    setup: option<setup-contract>,
  }

  describe: func() -> component-descriptor;
  invoke: func(op: string, envelope: invocation-envelope) -> result<invocation-result, node-error>;
}

interface component-qa {
  enum qa-mode {
    default,
    setup,
    update,
    remove,
  }

  qa-spec: func(mode: qa-mode) -> list<u8>;
  apply-answers: func(mode: qa-mode, current-config: list<u8>, answers: list<u8>) -> list<u8>;
}

interface component-i18n {
  i18n-keys: func() -> list<string>;
}

world component {
  import control;
  export node;
}

world component-qa-support {
  export component-qa;
}

world component-i18n-support {
  export component-i18n;
}