ultravisor 1.0.20 → 1.0.22
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.
- package/docs/_version.json +7 -0
- package/docs/css/docuserve.css +277 -23
- package/docs/features/beacon-authentication.md +24 -31
- package/docs/features/beacon-providers.md +31 -37
- package/docs/features/beacons.md +20 -19
- package/docs/features/case-study-retold-remote.md +28 -28
- package/docs/features/llm-model-setup.md +15 -15
- package/docs/features/llm.md +29 -27
- package/docs/features/platform-cards.md +10 -10
- package/docs/features/reachability-matrix.md +12 -12
- package/docs/features/tasks-content-system.md +32 -32
- package/docs/features/tasks-data-transform.md +64 -64
- package/docs/features/tasks-extension.md +14 -14
- package/docs/features/tasks-file-system.md +94 -94
- package/docs/features/tasks-flow-control.md +38 -38
- package/docs/features/tasks-http-client.md +40 -40
- package/docs/features/tasks-llm.md +58 -58
- package/docs/features/tasks-meadow-api.md +50 -50
- package/docs/features/tasks-user-interaction.md +12 -12
- package/docs/features/tasks.md +20 -20
- package/docs/features/universal-addressing.md +12 -12
- package/docs/index.html +2 -2
- package/docs/retold-catalog.json +30 -1
- package/docs/retold-keyword-index.json +15389 -12741
- package/package.json +5 -4
- package/source/services/Ultravisor-Beacon-Coordinator.cjs +40 -1
- package/source/services/Ultravisor-ExecutionEngine.cjs +9 -3
- package/source/services/Ultravisor-OperationAuditor.cjs +471 -0
- package/source/services/tasks/data-transform/Ultravisor-TaskConfigs-DataTransform.cjs +72 -0
- package/source/services/tasks/data-transform/definitions/random-number.json +24 -0
- package/source/services/tasks/data-transform/definitions/random-string.json +23 -0
- package/source/services/tasks/extension/Ultravisor-TaskConfigs-Extension.cjs +19 -7
- package/source/services/tasks/user-interaction/Ultravisor-TaskConfigs-UserInteraction.cjs +30 -2
- package/source/services/tasks/user-interaction/Ultravisor-TaskType-ValueInput.cjs +56 -2
- package/source/web_server/Ultravisor-API-Server.cjs +70 -0
- package/test/Ultravisor-Beacon-Reachability_tests.js +520 -0
- package/test/Ultravisor_tests.js +4 -4
|
@@ -10,20 +10,20 @@ Reads a markdown or content file from a remote Content System beacon.
|
|
|
10
10
|
|
|
11
11
|
### Settings
|
|
12
12
|
|
|
13
|
-
- **FilePath**
|
|
14
|
-
- **Destination**
|
|
15
|
-
- **AffinityKey**
|
|
16
|
-
- **TimeoutMs**
|
|
13
|
+
- **FilePath** -- Relative path within the content directory on the beacon.
|
|
14
|
+
- **Destination** -- State address to store the file content.
|
|
15
|
+
- **AffinityKey** -- Worker affinity key to route to a specific beacon.
|
|
16
|
+
- **TimeoutMs** -- Timeout in milliseconds (default `300000`).
|
|
17
17
|
|
|
18
18
|
### Outputs
|
|
19
19
|
|
|
20
|
-
- **Content**
|
|
21
|
-
- **StdOut**
|
|
20
|
+
- **Content** -- The file content as a string.
|
|
21
|
+
- **StdOut** -- Status message from the beacon.
|
|
22
22
|
|
|
23
23
|
### Events
|
|
24
24
|
|
|
25
|
-
- **Complete**
|
|
26
|
-
- **Error**
|
|
25
|
+
- **Complete** -- Fires after a successful read.
|
|
26
|
+
- **Error** -- Fires if the file is not found or the beacon is unreachable.
|
|
27
27
|
|
|
28
28
|
### Tips
|
|
29
29
|
|
|
@@ -37,20 +37,20 @@ Saves content to a file on a remote Content System beacon.
|
|
|
37
37
|
|
|
38
38
|
### Settings
|
|
39
39
|
|
|
40
|
-
- **FilePath**
|
|
41
|
-
- **Content**
|
|
42
|
-
- **AffinityKey**
|
|
43
|
-
- **TimeoutMs**
|
|
40
|
+
- **FilePath** -- Relative path within the content directory.
|
|
41
|
+
- **Content** -- The file content to write. Supports Pict template expressions.
|
|
42
|
+
- **AffinityKey** -- Worker affinity key to route to a specific beacon.
|
|
43
|
+
- **TimeoutMs** -- Timeout in milliseconds (default `300000`).
|
|
44
44
|
|
|
45
45
|
### Outputs
|
|
46
46
|
|
|
47
|
-
- **FilePath**
|
|
48
|
-
- **StdOut**
|
|
47
|
+
- **FilePath** -- Path of the saved file.
|
|
48
|
+
- **StdOut** -- Status message from the beacon.
|
|
49
49
|
|
|
50
50
|
### Events
|
|
51
51
|
|
|
52
|
-
- **Complete**
|
|
53
|
-
- **Error**
|
|
52
|
+
- **Complete** -- Fires after a successful save.
|
|
53
|
+
- **Error** -- Fires on failure.
|
|
54
54
|
|
|
55
55
|
### Tips
|
|
56
56
|
|
|
@@ -64,21 +64,21 @@ Lists files in a directory on a remote Content System beacon.
|
|
|
64
64
|
|
|
65
65
|
### Settings
|
|
66
66
|
|
|
67
|
-
- **Path**
|
|
68
|
-
- **Pattern**
|
|
69
|
-
- **Recursive**
|
|
70
|
-
- **AffinityKey**
|
|
71
|
-
- **TimeoutMs**
|
|
67
|
+
- **Path** -- Relative directory path within the content directory. Leave empty for the root.
|
|
68
|
+
- **Pattern** -- Glob pattern filter (e.g. `*.md`, `*.json`).
|
|
69
|
+
- **Recursive** -- When `true`, lists files in subdirectories.
|
|
70
|
+
- **AffinityKey** -- Worker affinity key to route to a specific beacon.
|
|
71
|
+
- **TimeoutMs** -- Timeout in milliseconds (default `300000`).
|
|
72
72
|
|
|
73
73
|
### Outputs
|
|
74
74
|
|
|
75
|
-
- **Files**
|
|
76
|
-
- **StdOut**
|
|
75
|
+
- **Files** -- JSON array of file entries.
|
|
76
|
+
- **StdOut** -- Status message from the beacon.
|
|
77
77
|
|
|
78
78
|
### Events
|
|
79
79
|
|
|
80
|
-
- **Complete**
|
|
81
|
-
- **Error**
|
|
80
|
+
- **Complete** -- Fires after listing.
|
|
81
|
+
- **Error** -- Fires on failure.
|
|
82
82
|
|
|
83
83
|
### Tips
|
|
84
84
|
|
|
@@ -92,19 +92,19 @@ Creates a folder in the content directory on a remote Content System beacon.
|
|
|
92
92
|
|
|
93
93
|
### Settings
|
|
94
94
|
|
|
95
|
-
- **Path**
|
|
96
|
-
- **AffinityKey**
|
|
97
|
-
- **TimeoutMs**
|
|
95
|
+
- **Path** -- Relative folder path to create.
|
|
96
|
+
- **AffinityKey** -- Worker affinity key to route to a specific beacon.
|
|
97
|
+
- **TimeoutMs** -- Timeout in milliseconds (default `300000`).
|
|
98
98
|
|
|
99
99
|
### Outputs
|
|
100
100
|
|
|
101
|
-
- **StdOut**
|
|
101
|
+
- **StdOut** -- Status message from the beacon.
|
|
102
102
|
|
|
103
103
|
### Events
|
|
104
104
|
|
|
105
|
-
- **Complete**
|
|
106
|
-
- **Error**
|
|
105
|
+
- **Complete** -- Fires after the folder is created.
|
|
106
|
+
- **Error** -- Fires on failure.
|
|
107
107
|
|
|
108
108
|
### Tips
|
|
109
109
|
|
|
110
|
-
Use Content Create Folder before **Content Save File** to ensure the target directory structure exists. The operation is idempotent
|
|
110
|
+
Use Content Create Folder before **Content Save File** to ensure the target directory structure exists. The operation is idempotent -- creating a folder that already exists succeeds without error.
|
|
@@ -10,12 +10,12 @@ Sets one or more values in operation state at specified addresses. This is the p
|
|
|
10
10
|
|
|
11
11
|
### Settings
|
|
12
12
|
|
|
13
|
-
- **Mappings**
|
|
13
|
+
- **Mappings** -- An array of mapping objects. Each mapping has a `To` address (where to write) and either a `Value` (literal) or `From` address (copy from state).
|
|
14
14
|
|
|
15
15
|
### Events
|
|
16
16
|
|
|
17
|
-
- **Complete**
|
|
18
|
-
- **Error**
|
|
17
|
+
- **Complete** -- Fires after all mappings are applied.
|
|
18
|
+
- **Error** -- Fires if a mapping fails.
|
|
19
19
|
|
|
20
20
|
### Tips
|
|
21
21
|
|
|
@@ -29,21 +29,21 @@ Replaces all occurrences of a search string within the input text.
|
|
|
29
29
|
|
|
30
30
|
### Settings
|
|
31
31
|
|
|
32
|
-
- **InputString**
|
|
33
|
-
- **SearchString**
|
|
34
|
-
- **ReplaceString**
|
|
35
|
-
- **UseRegex**
|
|
36
|
-
- **CaseSensitive**
|
|
32
|
+
- **InputString** -- The source text to search within. Supports Pict template expressions.
|
|
33
|
+
- **SearchString** -- The text or pattern to find.
|
|
34
|
+
- **ReplaceString** -- The replacement text (empty string to delete matches).
|
|
35
|
+
- **UseRegex** -- When `true`, treats SearchString as a regular expression.
|
|
36
|
+
- **CaseSensitive** -- Case-sensitive matching (default `true`).
|
|
37
37
|
|
|
38
38
|
### Outputs
|
|
39
39
|
|
|
40
|
-
- **ReplacedString**
|
|
41
|
-
- **ReplacementCount**
|
|
40
|
+
- **ReplacedString** -- The result after all replacements.
|
|
41
|
+
- **ReplacementCount** -- Number of replacements made.
|
|
42
42
|
|
|
43
43
|
### Events
|
|
44
44
|
|
|
45
|
-
- **ReplaceComplete**
|
|
46
|
-
- **Error**
|
|
45
|
+
- **ReplaceComplete** -- Fires after replacement.
|
|
46
|
+
- **Error** -- Fires on failure (e.g. invalid regex).
|
|
47
47
|
|
|
48
48
|
### Tips
|
|
49
49
|
|
|
@@ -57,18 +57,18 @@ Appends a string to an existing value at a specified state address. Useful for b
|
|
|
57
57
|
|
|
58
58
|
### Settings
|
|
59
59
|
|
|
60
|
-
- **InputString**
|
|
61
|
-
- **OutputAddress**
|
|
62
|
-
- **AppendNewline**
|
|
63
|
-
- **Separator**
|
|
60
|
+
- **InputString** -- The text to append. Supports Pict template expressions.
|
|
61
|
+
- **OutputAddress** -- State address of the string to append to.
|
|
62
|
+
- **AppendNewline** -- When `true`, appends a newline character after the input string.
|
|
63
|
+
- **Separator** -- String inserted between the existing content and new content. Overrides AppendNewline when set.
|
|
64
64
|
|
|
65
65
|
### Outputs
|
|
66
66
|
|
|
67
|
-
- **AppendedString**
|
|
67
|
+
- **AppendedString** -- The full accumulated string after appending.
|
|
68
68
|
|
|
69
69
|
### Events
|
|
70
70
|
|
|
71
|
-
- **Completed**
|
|
71
|
+
- **Completed** -- Fires after the append.
|
|
72
72
|
|
|
73
73
|
### Tips
|
|
74
74
|
|
|
@@ -82,17 +82,17 @@ Processes a Pict template string against the current operation state, resolving
|
|
|
82
82
|
|
|
83
83
|
### Settings
|
|
84
84
|
|
|
85
|
-
- **Template**
|
|
86
|
-
- **Destination**
|
|
85
|
+
- **Template** -- A Pict template string containing `{~D:...~}` expressions that reference state addresses.
|
|
86
|
+
- **Destination** -- State address to store the rendered result. If empty, the result is available at the default output.
|
|
87
87
|
|
|
88
88
|
### Outputs
|
|
89
89
|
|
|
90
|
-
- **Result**
|
|
90
|
+
- **Result** -- The fully rendered template output.
|
|
91
91
|
|
|
92
92
|
### Events
|
|
93
93
|
|
|
94
|
-
- **Complete**
|
|
95
|
-
- **Error**
|
|
94
|
+
- **Complete** -- Fires after rendering.
|
|
95
|
+
- **Error** -- Fires if template parsing fails.
|
|
96
96
|
|
|
97
97
|
### Tips
|
|
98
98
|
|
|
@@ -106,17 +106,17 @@ Evaluates a mathematical or logical expression using the Fable ExpressionParser
|
|
|
106
106
|
|
|
107
107
|
### Settings
|
|
108
108
|
|
|
109
|
-
- **Expression**
|
|
110
|
-
- **Destination**
|
|
109
|
+
- **Expression** -- The expression to evaluate. Can reference state values by address.
|
|
110
|
+
- **Destination** -- State address to store the evaluation result.
|
|
111
111
|
|
|
112
112
|
### Outputs
|
|
113
113
|
|
|
114
|
-
- **Result**
|
|
114
|
+
- **Result** -- The computed result as a string.
|
|
115
115
|
|
|
116
116
|
### Events
|
|
117
117
|
|
|
118
|
-
- **Complete**
|
|
119
|
-
- **Error**
|
|
118
|
+
- **Complete** -- Fires after evaluation.
|
|
119
|
+
- **Error** -- Fires on parse or evaluation failure.
|
|
120
120
|
|
|
121
121
|
### Tips
|
|
122
122
|
|
|
@@ -130,27 +130,27 @@ Parses CSV text into an array of records (objects with field names as keys).
|
|
|
130
130
|
|
|
131
131
|
### Settings
|
|
132
132
|
|
|
133
|
-
- **SourceAddress**
|
|
134
|
-
- **Delimiter**
|
|
135
|
-
- **HasHeaders**
|
|
136
|
-
- **Destination**
|
|
137
|
-
- **QuoteCharacter**
|
|
138
|
-
- **TrimFields**
|
|
139
|
-
- **SkipEmptyLines**
|
|
133
|
+
- **SourceAddress** -- State address containing the CSV text to parse.
|
|
134
|
+
- **Delimiter** -- Column delimiter character (default `,`).
|
|
135
|
+
- **HasHeaders** -- When `true`, the first row provides field names. When `false`, fields are indexed numerically.
|
|
136
|
+
- **Destination** -- State address to store the parsed records array.
|
|
137
|
+
- **QuoteCharacter** -- Character used to quote fields that contain the delimiter (default `"`).
|
|
138
|
+
- **TrimFields** -- Trim leading/trailing whitespace from field values.
|
|
139
|
+
- **SkipEmptyLines** -- Skip blank lines in the input.
|
|
140
140
|
|
|
141
141
|
### Outputs
|
|
142
142
|
|
|
143
|
-
- **Records**
|
|
144
|
-
- **ColumnCount**
|
|
145
|
-
- **Headers**
|
|
143
|
+
- **Records** -- Array of parsed row objects.
|
|
144
|
+
- **ColumnCount** -- Number of columns detected.
|
|
145
|
+
- **Headers** -- Array of header names from the first row.
|
|
146
146
|
|
|
147
147
|
### Events
|
|
148
148
|
|
|
149
|
-
- **Complete**
|
|
149
|
+
- **Complete** -- Fires after parsing.
|
|
150
150
|
|
|
151
151
|
### Tips
|
|
152
152
|
|
|
153
|
-
Chain **Read File**
|
|
153
|
+
Chain **Read File** -> **Parse CSV** -> **CSV Transform** for a complete data import pipeline. Use TrimFields and SkipEmptyLines to handle messy real-world CSV exports cleanly.
|
|
154
154
|
|
|
155
155
|
---
|
|
156
156
|
|
|
@@ -160,20 +160,20 @@ Transforms an array of parsed CSV records by applying field mappings, filters, a
|
|
|
160
160
|
|
|
161
161
|
### Settings
|
|
162
162
|
|
|
163
|
-
- **SourceAddress**
|
|
164
|
-
- **Destination**
|
|
165
|
-
- **Delimiter**
|
|
166
|
-
- **FieldMapping**
|
|
167
|
-
- **FilterExpression**
|
|
168
|
-
- **OutputFields**
|
|
163
|
+
- **SourceAddress** -- State address of the records array to transform.
|
|
164
|
+
- **Destination** -- State address to store the transformed records.
|
|
165
|
+
- **Delimiter** -- Delimiter for re-serialization (default `,`).
|
|
166
|
+
- **FieldMapping** -- JSON array of mapping objects with `From`, `To`, and optional `Template` properties for field renaming and transformation.
|
|
167
|
+
- **FilterExpression** -- An expression to filter rows. Only rows where the expression evaluates to true are included.
|
|
168
|
+
- **OutputFields** -- JSON array of field names to include in the output. Omit to include all fields.
|
|
169
169
|
|
|
170
170
|
### Outputs
|
|
171
171
|
|
|
172
|
-
- **Records**
|
|
172
|
+
- **Records** -- The transformed records array.
|
|
173
173
|
|
|
174
174
|
### Events
|
|
175
175
|
|
|
176
|
-
- **Complete**
|
|
176
|
+
- **Complete** -- Fires after transformation.
|
|
177
177
|
|
|
178
178
|
### Tips
|
|
179
179
|
|
|
@@ -187,19 +187,19 @@ Computes a frequency distribution over a specific field in a dataset array.
|
|
|
187
187
|
|
|
188
188
|
### Settings
|
|
189
189
|
|
|
190
|
-
- **SourceAddress**
|
|
191
|
-
- **Field**
|
|
192
|
-
- **Bins**
|
|
193
|
-
- **Destination**
|
|
194
|
-
- **SortBy**
|
|
190
|
+
- **SourceAddress** -- State address of the data array to analyze.
|
|
191
|
+
- **Field** -- Field name to compute frequencies for (default `score`).
|
|
192
|
+
- **Bins** -- Number of bins for numeric data (default `5`).
|
|
193
|
+
- **Destination** -- State address to store the statistics object.
|
|
194
|
+
- **SortBy** -- Sort frequency results by `count` or `key`.
|
|
195
195
|
|
|
196
196
|
### Outputs
|
|
197
197
|
|
|
198
|
-
- **Stats**
|
|
198
|
+
- **Stats** -- An object containing the frequency distribution, bin boundaries, and summary statistics.
|
|
199
199
|
|
|
200
200
|
### Events
|
|
201
201
|
|
|
202
|
-
- **Complete**
|
|
202
|
+
- **Complete** -- Fires after computation.
|
|
203
203
|
|
|
204
204
|
### Tips
|
|
205
205
|
|
|
@@ -213,21 +213,21 @@ Intersects two arrays by matching records on a common field, similar to an SQL i
|
|
|
213
213
|
|
|
214
214
|
### Settings
|
|
215
215
|
|
|
216
|
-
- **SourceAddressA**
|
|
217
|
-
- **SourceAddressB**
|
|
218
|
-
- **MatchField**
|
|
219
|
-
- **Destination**
|
|
220
|
-
- **JoinType**
|
|
216
|
+
- **SourceAddressA** -- State address of the first array.
|
|
217
|
+
- **SourceAddressB** -- State address of the second array.
|
|
218
|
+
- **MatchField** -- Field name to match records on. Records from both arrays with the same value in this field are merged.
|
|
219
|
+
- **Destination** -- State address to store the intersected results.
|
|
220
|
+
- **JoinType** -- Join type (default `inner`). Inner join returns only records that match in both arrays.
|
|
221
221
|
|
|
222
222
|
### Outputs
|
|
223
223
|
|
|
224
|
-
- **Result**
|
|
225
|
-
- **MatchCount**
|
|
224
|
+
- **Result** -- Array of merged record objects.
|
|
225
|
+
- **MatchCount** -- Number of matched records.
|
|
226
226
|
|
|
227
227
|
### Events
|
|
228
228
|
|
|
229
|
-
- **Complete**
|
|
229
|
+
- **Complete** -- Fires after intersection.
|
|
230
230
|
|
|
231
231
|
### Tips
|
|
232
232
|
|
|
233
|
-
Use Comprehension Intersect to combine data from two different sources
|
|
233
|
+
Use Comprehension Intersect to combine data from two different sources -- for example, joining a list of user IDs from one API with user details from another. The matched records are merged into single objects containing fields from both sources.
|
|
@@ -10,26 +10,26 @@ Dispatches a work item to a remote Beacon worker node. The task pauses until the
|
|
|
10
10
|
|
|
11
11
|
### Settings
|
|
12
12
|
|
|
13
|
-
- **RemoteCapability**
|
|
14
|
-
- **RemoteAction**
|
|
15
|
-
- **Command**
|
|
16
|
-
- **Parameters**
|
|
17
|
-
- **AffinityKey**
|
|
18
|
-
- **TimeoutMs**
|
|
19
|
-
- **InputData**
|
|
20
|
-
- **Destination**
|
|
13
|
+
- **RemoteCapability** -- Required capability on the Beacon (e.g. `Shell`, `FileSystem`, `LLM`).
|
|
14
|
+
- **RemoteAction** -- Specific action within the capability (e.g. `Execute`, `Read`).
|
|
15
|
+
- **Command** -- Shell command to execute on the Beacon (when using Shell capability).
|
|
16
|
+
- **Parameters** -- Command-line parameters for the shell command.
|
|
17
|
+
- **AffinityKey** -- Worker affinity routing key. Requests with the same key are routed to the same Beacon.
|
|
18
|
+
- **TimeoutMs** -- Work item timeout in milliseconds (default `300000`).
|
|
19
|
+
- **InputData** -- JSON data to pass to the Beacon worker.
|
|
20
|
+
- **Destination** -- State address to write results to on completion.
|
|
21
21
|
|
|
22
22
|
### Outputs
|
|
23
23
|
|
|
24
|
-
- **StdOut**
|
|
25
|
-
- **Result**
|
|
26
|
-
- **ExitCode**
|
|
27
|
-
- **BeaconID**
|
|
24
|
+
- **StdOut** -- Standard output from the Beacon execution.
|
|
25
|
+
- **Result** -- Result data from the Beacon.
|
|
26
|
+
- **ExitCode** -- Exit code of the remote command.
|
|
27
|
+
- **BeaconID** -- ID of the Beacon that executed the work.
|
|
28
28
|
|
|
29
29
|
### Events
|
|
30
30
|
|
|
31
|
-
- **Complete**
|
|
32
|
-
- **Error**
|
|
31
|
+
- **Complete** -- Fires when the Beacon finishes.
|
|
32
|
+
- **Error** -- Fires on failure or timeout.
|
|
33
33
|
|
|
34
34
|
### Tips
|
|
35
35
|
|