1 Commits

Author SHA1 Message Date
renovate[bot] 063d7736cd Update dependency typescript to v7 2026-08-17 17:42:36 +00:00
50 changed files with 593 additions and 796 deletions
+10
View File
@@ -0,0 +1,10 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
+529 -689
View File
File diff suppressed because it is too large Load Diff
+3 -3
View File
@@ -1,7 +1,7 @@
{
"name": "@showbridge/docs",
"type": "module",
"version": "0.5.1",
"version": "0.4.1",
"files": [
"dist"
],
@@ -16,8 +16,8 @@
"devDependencies": {
"@astrojs/check": "0.9.10",
"@astrojs/starlight": "0.41.7",
"astro": "7.2.3",
"astro": "7.2.0",
"sharp": "0.35.3",
"typescript": "6.0.3"
"typescript": "7.0.2"
}
}
-1
View File
@@ -10,6 +10,5 @@ Processors are anything that create or manipulate messages. They are configured
A processor YAML block has the following properties
- **id**: a unique identifier for the processor (auto generated when using the web interface)
- **type**: the processor type
- **params**: optional map for processor configuration values. The valid values will depend on the processor type
-1
View File
@@ -8,7 +8,6 @@ Routes take the messages coming from a module and push them through a list of [p
## YAML Definition
- **id**: a unique identifier for the route (auto generated when using the web interface)
- **input**: the id of the [module](/concepts/modules) that will provide messages to this route
- **processors**: (optional) array of [processors](/concepts/processors) that will be called in order and the result of the previous will be fed to the next processor.
- an error in a processor step will result in the individual route being terminated
+4 -8
View File
@@ -23,17 +23,13 @@ modules:
host: 127.0.0.1
port: 53000
routes:
- id: sip-to-osc
input: sip
- input: sip
processors:
- id: create-osc-message
type: osc.message.create
- type: osc.message.create
params:
address: "/cue/{{.Payload.To}}/go"
- id: encode-osc-message
type: osc.message.encode
- id: send-osc
type: module.output
- type: osc.message.encode
- type: module.output
params:
module: udp
`;
+4 -8
View File
@@ -23,17 +23,13 @@ modules:
host: 127.0.0.1
port: 8000
routes:
- id: http-to-osc
input: http
- input: http
processors:
- id: create-osc-message
type: osc.message.create # create OSC message
- type: osc.message.create # create OSC message
params:
address: "{{.Payload.URL.Path}}" # template the address from the incoming message
- id: encode-osc-message
type: osc.message.encode # turn OSC message into bytes
- id: send-osc
type: module.output # output to the udp module
- type: osc.message.encode # turn OSC message into bytes
- type: module.output # output to the udp module
params:
module: udp
`;
@@ -14,6 +14,5 @@ This processor will decode incoming bytes into an ArtNet packet. This processor
### Example
```yaml
- id: decode
type: artnet.packet.decode
- type: artnet.packet.decode
```
@@ -14,6 +14,5 @@ This processor will encode an ArtNet packet into an array of bytes. This process
### Example
```yaml
- id: encode
type: artnet.packet.encode
- type: artnet.packet.encode
```
+1 -2
View File
@@ -17,8 +17,7 @@ This processor will return an error if any of the required parameters are missin
Issue a `SELECT` statement to a module with id `sqlite`.
```yaml
- id: query
type: db.query
- type: db.query
params:
module: sqlite
query: "SELECT * from users;"
+1 -2
View File
@@ -13,6 +13,5 @@ This processor will log information about the message being processed to the con
### Example
```yaml
- id: log
type: debug.log
- type: debug.log
```
@@ -13,6 +13,5 @@ This processor will only pass messages through if the value of the message has c
### Example
```yaml
- id: filter
type: filter.change
- type: filter.change
```
+1 -2
View File
@@ -15,8 +15,7 @@ The `filter.expr` processor evaluates an [Expr expression](https://expr-lang.org
Match a payload great than or equal to 0
```yaml
- id: filter
type: filter.expr
- type: filter.expr
params:
expression: "Payload >= 0"
```
+1 -2
View File
@@ -15,8 +15,7 @@ The `filter.regex` processor matches incoming string payload against a regular e
Match strings starting with `hello`
```yaml
- id: filter
type: filter.regex
- type: filter.regex
params:
pattern: "^hello.*"
```
+1 -2
View File
@@ -15,8 +15,7 @@ The `float.parse` processor takes a string and parses it as a float with the spe
This would parse the string payload as a 32 bit float and set the payload to that value.
```yaml
- id: parse
type: float.parse
- type: float.parse
params:
bitSize: 32
```
+1 -2
View File
@@ -15,8 +15,7 @@ The `float.random` processor will set the payload to a random float between the
This would generate a random 64-bit float between 1.1 and 1.5 and set the payload to that value.
```yaml
- id: random
type: float.random
- type: float.random
params:
bitSize: 64
min: 1.0
@@ -13,8 +13,7 @@ This processor will create a new FreeD message with the specified parameters.
### Example
```yaml
- id: freed-message
type: freed.create
- type: freed.create
params:
id: "1"
pan: "45"
@@ -13,6 +13,5 @@ This processor will decode incoming bytes into a FreeD message. This processor w
### Example
```yaml
- id: decode
type: freed.decode
- type: freed.decode
```
@@ -13,6 +13,5 @@ This processor will encode a FreeD message into an array of bytes. This processo
### Example
```yaml
- id: encode
type: freed.encode
- type: freed.encode
```
@@ -15,8 +15,7 @@ This process will make an HTTP request to the specified URL using the specified
Make a GET request to `https://example.com`
```yaml
- id: make-request
type: http.request.do
- type: http.request.do
params:
method: GET
url: https://example.com
@@ -15,8 +15,7 @@ This processor will create a new HTTP response with the specified status code an
This would create an HTTP response with a status code of `200` and a body of `OK`
```yaml
- id: create-response
type: http.response.create
- type: http.response.create
params:
status: 200
bodyTemplate: "OK"
+1 -2
View File
@@ -15,8 +15,7 @@ The `int.parse` processor takes a string and parses it as an integer with the sp
This would parse the string payload as a 32 bit, base 10 integer and set the payload to that value.
```yaml
- id: parse
type: int.parse
- type: int.parse
params:
bitSize: 32
```
+1 -2
View File
@@ -14,8 +14,7 @@ The `int.random` processor will set the payload to a random integer between the
This would generate a random integer between -127 and 127 and set the payload to that value.
```yaml
- id: random
type: int.random
- type: int.random
params:
min: -127
max: 127
+1 -2
View File
@@ -15,8 +15,7 @@ This processor will scale an integer value from one range to another. This proce
Scale an integer value from the range 0-255 to the range 0-100
```yaml
- id: scale
type: int.scale
- type: int.scale
params:
inMin: 0
inMax: 255
+1 -2
View File
@@ -13,6 +13,5 @@ Convert an incoming byte array or raw string into a JSON object. This processor
### Example
```yaml
- id: decode
type: json.decode
- type: json.decode
```
+1 -2
View File
@@ -13,6 +13,5 @@ This processor will encode an incoming object into a JSON byte array. This proce
### Example
```yaml
- id: encode
type: json.encode
- type: json.encode
```
+1 -2
View File
@@ -16,8 +16,7 @@ The output payload is the value if the key is found.
This will attempt to get the value for the `counter` key from the module with an id of `redis`
```yaml
- id: get
type: kv.get
- type: kv.get
params:
module: redis
key: counter
+1 -2
View File
@@ -15,8 +15,7 @@ The `kv.set` processor sets the value of the configured key to the incoming payl
This will attempt to set the key `hello` using the module with an id of `redis`
```yaml
- id: set
type: kv.set
- type: kv.set
params:
module: redis
key: hello
@@ -13,8 +13,7 @@ This processor will create a MIDI Control Change message with the specified chan
### Example
```yaml
- id: create
type: midi.control_change.create
- type: midi.control_change.create
params:
channel: "1"
control: "64"
@@ -13,6 +13,5 @@ This processor will decode incoming bytes into a MIDI message. This processor wi
### Example
```yaml
- id: decode
type: midi.message.decode
- type: midi.message.decode
```
@@ -13,6 +13,5 @@ This processor will encode a MIDI message into an array of bytes. This processor
### Example
```yaml
- id: encode
type: midi.message.encode
- type: midi.message.encode
```
@@ -13,6 +13,5 @@ This processor will unpack a MIDI message into its individual components. This p
### Example
```yaml
- id: unpack
type: midi.message.unpack
- type: midi.message.unpack
```
@@ -13,8 +13,7 @@ This processor will create a MIDI Note Off message with the specified channel, n
### Example
```yaml
- id: create
type: midi.note_off.create
- type: midi.note_off.create
params:
channel: "1"
note: "60"
@@ -13,8 +13,7 @@ This processor will create a MIDI Note On message with the specified channel, no
### Example
```yaml
- id: create
type: midi.note_on.create
- type: midi.note_on.create
params:
channel: "1"
note: "60"
@@ -13,8 +13,7 @@ This processor will create a MIDI Program Change message with the specified chan
### Example
```yaml
- id: create
type: midi.program_change.create
- type: midi.program_change.create
params:
channel: "1"
program: "10"
@@ -15,8 +15,7 @@ The `module.output` processor takes any payload and outputs to the specified mod
Output whatever payload comes through this processor to the `osc-out` module.
```yaml
- id: output
type: module.output
- type: module.output
params:
module: osc-out
```
@@ -15,8 +15,7 @@ This processor will create an OSC message from the provided parameters. This pro
Create an OSC message with the address `/test/message` and two integer arguments from the payload of the message being processed.
```yaml
- id: create
type: osc.message.create
- type: osc.message.create
params:
address: "/test/message"
args: ["{{.Payload[0]}}", "{{.Payload[1]}}"]
@@ -13,6 +13,5 @@ The `osc.message.decode` processor takes a array of bytes and turn it into OSC m
### Example
```yaml
- id: decode
type: osc.message.decode
- type: osc.message.encode
```
@@ -13,6 +13,5 @@ The `osc.message.encode` processor takes an OSC message and turns it into an arr
### Example
```yaml
- id: encode
type: osc.message.encode
- type: osc.message.encode
```
@@ -15,8 +15,7 @@ The payload is unchanged so whatever is received by this payload is output unles
### Example
```yaml
- id: publish
type: pubsub.publish
- type: pubsub.publish
params:
module: mqtt-out
topic: "test"
+1 -2
View File
@@ -15,8 +15,7 @@ The processor will execute the provided Expr expression and return the result as
This example will add 1 to the wrapped payload.
```yaml
- id: expr
type: script.expr
- type: script.expr
params:
expression: "Payload + 1"
```
+1 -2
View File
@@ -19,8 +19,7 @@ This run your JavaScript program in a [sandboxed environment](https://gitlab.com
Replace all occurrences of `|` with `,` in the payload
```yaml
- id: javascript
type: script.js
- type: script.js
params:
program: |
payload = payload.replaceAll('|',',');
+1 -2
View File
@@ -15,8 +15,7 @@ This processor will load and execute a WASM plugin using the [Extism](https://ex
This example will load the plugin at `./test.wasm` and execute the `test` function
```yaml
- id: wasm
type: script.wasm
- type: script.wasm
params:
path: "./test.wasm"
function: "test"
@@ -15,8 +15,7 @@ This processor will create a SIP response message with an audio file as the payl
This example will create a SIP response that will wait 1 second then play `response.wav` then wait another second before completing the response.
```yaml
- id: create-audio-response
type: sip.response.audio.create
- type: sip.response.audio.create
params:
preWait: 1000
audioFile: "response.wav"
@@ -15,8 +15,7 @@ This processor will create a SIP DTMF response from the provided parameters. If
This example will create a SIP response that will wait 1 second then play the DTMF digits "1234" then wait another second before completing the response.
```yaml
- id: create-dtmf-response
type: sip.response.dtmf.create
- type: sip.response.dtmf.create
params:
preWait: 1000
digits: "1234"
@@ -15,8 +15,7 @@ The `string.create` processor creates a string based on the provided template. T
This would create a string using the `Address` property of the incoming message like and OSC message
```yaml
- id: create
type: string.create
- type: string.create
params:
template: "{{.Address}}
```
@@ -13,6 +13,5 @@ The `string.decode` processor takes a array of bytes and turn it into string. Th
### Example
```yaml
- id: decode
type: string.decode
- type: string.decode
```
@@ -13,6 +13,5 @@ The `string.encode` processor takes a string and turns it into an array of bytes
### Example
```yaml
- id: encode
type: string.encode
- type: string.encode
```
+1 -2
View File
@@ -15,8 +15,7 @@ The `string.split` processor takes a string and turns it into an array of string
Split incoming string on `,` i.e `"one,two,three"` -> `["one","two","three"]`
```yaml
- id: split
type: string.split
- type: string.split
params:
separator: ","
```
+1 -2
View File
@@ -15,8 +15,7 @@ The `time.sleep` processor will sleep for the specified `duration` in millisecon
This would sleep for 5 seconds before passing the message to the next processor.
```yaml
- id: sleep
type: time.sleep
- type: time.sleep
params:
duration: 5000
```