@ankhorage/runtime 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +21 -0
  3. package/README.md +38 -0
  4. package/dist/index.d.ts +53 -0
  5. package/dist/index.d.ts.map +1 -0
  6. package/dist/index.js +31 -0
  7. package/dist/index.js.map +1 -0
  8. package/dist/readme-usage.d.ts +2 -0
  9. package/dist/readme-usage.d.ts.map +1 -0
  10. package/dist/readme-usage.js +17 -0
  11. package/dist/readme-usage.js.map +1 -0
  12. package/package.json +76 -0
  13. package/paradox/badges/build.svg +7 -0
  14. package/paradox/badges/docs.svg +7 -0
  15. package/paradox/badges/eslint.svg +7 -0
  16. package/paradox/badges/license.svg +7 -0
  17. package/paradox/badges/npm.svg +7 -0
  18. package/paradox/badges/prettier.svg +7 -0
  19. package/paradox/badges/runtime.svg +7 -0
  20. package/paradox/badges/tests.svg +7 -0
  21. package/paradox/badges/typescript.svg +7 -0
  22. package/paradox/components.md +1 -0
  23. package/paradox/diagrams/architecture-overview.mmd +10 -0
  24. package/paradox/diagrams/export-graph.mmd +49 -0
  25. package/paradox/diagrams/module-relationships.mmd +5 -0
  26. package/paradox/exports.json +564 -0
  27. package/paradox/exports.md +185 -0
  28. package/paradox/index.html +1146 -0
  29. package/paradox/paradox.json +952 -0
package/paradox/exports.md ADDED
@@ -0,0 +1,185 @@
1
+ # Public API
2
+
3
+ ## createRuntimeManifest
4
+
5
+ Kind: `function`
6
+ Module: `src/index.ts`
7
+ Source: `src/index.ts:81:1`
8
+
9
+ ### Signatures
10
+
11
+ - `(input: RuntimeManifestInput) => RuntimeManifest`
12
+ - input: `RuntimeManifestInput`
13
+ - returns: `RuntimeManifest`
14
+
15
+ ## defineRuntimeAction
16
+
17
+ Kind: `function`
18
+ Module: `src/index.ts`
19
+ Source: `src/index.ts:63:1`
20
+
21
+ ### Signatures
22
+
23
+ - `(action: RuntimeActionDescriptor<Data>) => RuntimeActionDescriptor<Data>`
24
+ - action: `RuntimeActionDescriptor<Data>`
25
+ - returns: `RuntimeActionDescriptor<Data>`
26
+
27
+ ## defineRuntimeAdapter
28
+
29
+ Kind: `function`
30
+ Module: `src/index.ts`
31
+ Source: `src/index.ts:69:1`
32
+
33
+ ### Signatures
34
+
35
+ - `(adapter: RuntimeAdapterDescriptor<Options>) => RuntimeAdapterDescriptor<Options>`
36
+ - adapter: `RuntimeAdapterDescriptor<Options>`
37
+ - returns: `RuntimeAdapterDescriptor<Options>`
38
+
39
+ ## defineRuntimeBinding
40
+
41
+ Kind: `function`
42
+ Module: `src/index.ts`
43
+ Source: `src/index.ts:75:1`
44
+
45
+ ### Signatures
46
+
47
+ - `(binding: RuntimeBindingDescriptor<Value>) => RuntimeBindingDescriptor<Value>`
48
+ - binding: `RuntimeBindingDescriptor<Value>`
49
+ - returns: `RuntimeBindingDescriptor<Value>`
50
+
51
+ ## listRuntimeCapabilities
52
+
53
+ Kind: `function`
54
+ Module: `src/index.ts`
55
+ Source: `src/index.ts:93:1`
56
+
57
+ ### Signatures
58
+
59
+ - `() => readonly ("runtime.render" | "runtime.actions" | "runtime.bindings" | "runtime.adapters")[]`
60
+ - returns: `readonly ("runtime.render" | "runtime.actions" | "runtime.bindings" | "runtime.adapters")[]`
61
+
62
+ ## RUNTIME_CAPABILITIES
63
+
64
+ Kind: `value`
65
+ Module: `src/index.ts`
66
+ Source: `src/index.ts:1:14`
67
+
68
+ ## RUNTIME_MANIFEST_KIND
69
+
70
+ Kind: `value`
71
+ Module: `src/index.ts`
72
+ Source: `src/index.ts:8:14`
73
+
74
+ ## RuntimeActionDescriptor
75
+
76
+ Kind: `type`
77
+ Module: `src/index.ts`
78
+ Source: `src/index.ts:24:1`
79
+
80
+ ### Members
81
+
82
+ | Name | Kind | Type | Required | Description |
83
+ | ----------- | -------- | ------------------------------------------------------------------------------------------------ | -------- | ----------- |
84
+ | capability | property | `"runtime.render" \| "runtime.actions" \| "runtime.bindings" \| "runtime.adapters" \| undefined` | no | |
85
+ | data | property | `Data \| undefined` | no | |
86
+ | description | property | `string \| undefined` | no | |
87
+ | id | property | `string` | yes | |
88
+
89
+ ## RuntimeAdapterDescriptor
90
+
91
+ Kind: `type`
92
+ Module: `src/index.ts`
93
+ Source: `src/index.ts:39:1`
94
+
95
+ ### Members
96
+
97
+ | Name | Kind | Type | Required | Description |
98
+ | ------- | -------- | ---------------------- | -------- | ----------- |
99
+ | id | property | `string` | yes | |
100
+ | kind | property | `string` | yes | |
101
+ | options | property | `Options \| undefined` | no | |
102
+
103
+ ## RuntimeBindingDescriptor
104
+
105
+ Kind: `type`
106
+ Module: `src/index.ts`
107
+ Source: `src/index.ts:31:1`
108
+
109
+ ### Members
110
+
111
+ | Name | Kind | Type | Required | Description |
112
+ | -------- | -------- | --------------------- | -------- | ----------- |
113
+ | actionId | property | `string \| undefined` | no | |
114
+ | id | property | `string` | yes | |
115
+ | source | property | `string` | yes | |
116
+ | target | property | `string` | yes | |
117
+ | value | property | `Value \| undefined` | no | |
118
+
119
+ ## RuntimeCapability
120
+
121
+ Kind: `unknown`
122
+ Module: `src/index.ts`
123
+ Source: `src/index.ts:10:1`
124
+
125
+ ## RuntimeConfig
126
+
127
+ Kind: `type`
128
+ Module: `src/index.ts`
129
+ Source: `src/index.ts:18:1`
130
+
131
+ ### Members
132
+
133
+ | Name | Kind | Type | Required | Description |
134
+ | ----------- | -------- | ------------------------------------------------ | -------- | ----------- |
135
+ | appId | property | `string` | yes | |
136
+ | environment | property | `string \| undefined` | no | |
137
+ | values | property | `Readonly<Record<string, unknown>> \| undefined` | no | |
138
+
139
+ ## RuntimeDiagnostic
140
+
141
+ Kind: `type`
142
+ Module: `src/index.ts`
143
+ Source: `src/index.ts:12:1`
144
+
145
+ ### Members
146
+
147
+ | Name | Kind | Type | Required | Description |
148
+ | -------- | -------- | -------------------------------- | -------- | ----------- |
149
+ | code | property | `string` | yes | |
150
+ | message | property | `string` | yes | |
151
+ | severity | property | `"error" \| "info" \| "warning"` | yes | |
152
+
153
+ ## RuntimeManifest
154
+
155
+ Kind: `type`
156
+ Module: `src/index.ts`
157
+ Source: `src/index.ts:45:1`
158
+
159
+ ### Members
160
+
161
+ | Name | Kind | Type | Required | Description |
162
+ | ----------- | -------- | ---------------------------------------------- | -------- | ----------- |
163
+ | actions | property | `readonly RuntimeActionDescriptor<unknown>[]` | yes | |
164
+ | adapters | property | `readonly RuntimeAdapterDescriptor<unknown>[]` | yes | |
165
+ | bindings | property | `readonly RuntimeBindingDescriptor<unknown>[]` | yes | |
166
+ | config | property | `RuntimeConfig` | yes | |
167
+ | diagnostics | property | `readonly RuntimeDiagnostic[]` | yes | |
168
+ | kind | property | `"ankhorage-runtime-manifest"` | yes | |
169
+ | version | property | `1` | yes | |
170
+
171
+ ## RuntimeManifestInput
172
+
173
+ Kind: `type`
174
+ Module: `src/index.ts`
175
+ Source: `src/index.ts:55:1`
176
+
177
+ ### Members
178
+
179
+ | Name | Kind | Type | Required | Description |
180
+ | ----------- | -------- | ----------------------------------------------------------- | -------- | ----------- |
181
+ | actions | property | `readonly RuntimeActionDescriptor<unknown>[] \| undefined` | no | |
182
+ | adapters | property | `readonly RuntimeAdapterDescriptor<unknown>[] \| undefined` | no | |
183
+ | bindings | property | `readonly RuntimeBindingDescriptor<unknown>[] \| undefined` | no | |
184
+ | config | property | `RuntimeConfig` | yes | |
185
+ | diagnostics | property | `readonly RuntimeDiagnostic[] \| undefined` | no | |