Compare commits

22 Commits

Author SHA1 Message Date
dependabot[bot] d6d8e7b532 Bump actions/setup-node from 6.4.0 to 7.0.0
Bumps [actions/setup-node](https://github.com/actions/setup-node) from 6.4.0 to 7.0.0.
- [Release notes](https://github.com/actions/setup-node/releases)
- [Commits](https://github.com/actions/setup-node/compare/48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e...820762786026740c76f36085b0efc47a31fe5020)

---
updated-dependencies:
- dependency-name: actions/setup-node
  dependency-version: 7.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-07-15 16:43:11 +00:00
Joel Wetzell bb1517ca73 Merge pull request #48 from jwetzell/dependabot/github_actions/actions/checkout-6.0.3
Bump actions/checkout from 6.0.2 to 6.0.3
2026-06-07 21:19:58 -05:00
Joel Wetzell 6935a7d969 Merge pull request #49 from jwetzell/dependabot/npm_and_yarn/astrojs/starlight-0.39.3
Bump @astrojs/starlight from 0.39.2 to 0.39.3
2026-06-07 21:19:46 -05:00
dependabot[bot] 98f36a9a46 Bump @astrojs/starlight from 0.39.2 to 0.39.3
Bumps [@astrojs/starlight](https://github.com/withastro/starlight/tree/HEAD/packages/starlight) from 0.39.2 to 0.39.3.
- [Release notes](https://github.com/withastro/starlight/releases)
- [Changelog](https://github.com/withastro/starlight/blob/main/packages/starlight/CHANGELOG.md)
- [Commits](https://github.com/withastro/starlight/commits/@astrojs/starlight@0.39.3/packages/starlight)

---
updated-dependencies:
- dependency-name: "@astrojs/starlight"
  dependency-version: 0.39.3
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-06-08 02:19:33 +00:00
Joel Wetzell 6d191eaa1d Merge pull request #50 from jwetzell/dependabot/npm_and_yarn/astro-6.4.4
Bump astro from 6.3.8 to 6.4.4
2026-06-07 21:17:30 -05:00
dependabot[bot] e614f31478 Bump astro from 6.3.8 to 6.4.4
Bumps [astro](https://github.com/withastro/astro/tree/HEAD/packages/astro) from 6.3.8 to 6.4.4.
- [Release notes](https://github.com/withastro/astro/releases)
- [Changelog](https://github.com/withastro/astro/blob/main/packages/astro/CHANGELOG.md)
- [Commits](https://github.com/withastro/astro/commits/astro@6.4.4/packages/astro)

---
updated-dependencies:
- dependency-name: astro
  dependency-version: 6.4.4
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-06-04 02:30:59 +00:00
dependabot[bot] 7371ac9f8f Bump actions/checkout from 6.0.2 to 6.0.3
Bumps [actions/checkout](https://github.com/actions/checkout) from 6.0.2 to 6.0.3.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/de0fac2e4500dabe0009e67214ff5f5447ce83dd...df4cb1c069e1874edd31b4311f1884172cec0e10)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: 6.0.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-06-04 02:28:02 +00:00
Joel Wetzell 273e08be7d 0.4.0 2026-06-01 18:44:56 -05:00
Joel Wetzell c07d3f8d1a Merge pull request #47 from jwetzell/feat/auto-generate-schema-docs
auto components to auto generate docs from JSON Schema
2026-06-01 18:44:32 -05:00
Joel Wetzell f8efe286f2 sync schema with v0.23.1 2026-06-01 18:42:43 -05:00
Joel Wetzell f82b55963b work on auto-generating parts of docs from JSONSchema 2026-06-01 18:03:47 -05:00
Joel Wetzell e22e25afe2 bump version 2026-05-30 22:22:02 -05:00
Joel Wetzell dc28e1585c Merge pull request #46 from jwetzell/dependabot/npm_and_yarn/astro-6.3.8
Bump astro from 6.3.6 to 6.3.8
2026-05-30 22:13:33 -05:00
Joel Wetzell 6d7bceb536 fix params layout for http.response.create 2026-05-27 21:01:28 -05:00
dependabot[bot] 795ce1ab55 Bump astro from 6.3.6 to 6.3.8
Bumps [astro](https://github.com/withastro/astro/tree/HEAD/packages/astro) from 6.3.6 to 6.3.8.
- [Release notes](https://github.com/withastro/astro/releases)
- [Changelog](https://github.com/withastro/astro/blob/main/packages/astro/CHANGELOG.md)
- [Commits](https://github.com/withastro/astro/commits/astro@6.3.8/packages/astro)

---
updated-dependencies:
- dependency-name: astro
  dependency-version: 6.3.8
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-05-27 19:11:20 +00:00
Joel Wetzell e83c095d97 Merge pull request #45 from jwetzell/dependabot/npm_and_yarn/astro-6.3.6
Bump astro from 6.3.3 to 6.3.6
2026-05-26 16:40:08 -05:00
dependabot[bot] b5ddb3ecc2 Bump astro from 6.3.3 to 6.3.6
Bumps [astro](https://github.com/withastro/astro/tree/HEAD/packages/astro) from 6.3.3 to 6.3.6.
- [Release notes](https://github.com/withastro/astro/releases)
- [Changelog](https://github.com/withastro/astro/blob/main/packages/astro/CHANGELOG.md)
- [Commits](https://github.com/withastro/astro/commits/astro@6.3.6/packages/astro)

---
updated-dependencies:
- dependency-name: astro
  dependency-version: 6.3.6
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-05-20 21:25:32 +00:00
Joel Wetzell e10ae19992 add notes about module interface implementations 2026-05-19 22:27:46 -05:00
Joel Wetzell 4a873a32d4 Merge pull request #44 from jwetzell/dependabot/npm_and_yarn/astro-6.3.3
Bump astro from 6.3.1 to 6.3.3
2026-05-19 22:16:19 -05:00
Joel Wetzell 1c8b6f91b1 bump version 2026-05-19 22:16:02 -05:00
Joel Wetzell 2ec22b1f9b switch docs to publish on tag 2026-05-19 22:14:53 -05:00
dependabot[bot] c1cad438ba Bump astro from 6.3.1 to 6.3.3
Bumps [astro](https://github.com/withastro/astro/tree/HEAD/packages/astro) from 6.3.1 to 6.3.3.
- [Release notes](https://github.com/withastro/astro/releases)
- [Changelog](https://github.com/withastro/astro/blob/main/packages/astro/CHANGELOG.md)
- [Commits](https://github.com/withastro/astro/commits/astro@6.3.3/packages/astro)

---
updated-dependencies:
- dependency-name: astro
  dependency-version: 6.3.3
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-05-18 02:19:44 +00:00
71 changed files with 1975 additions and 335 deletions
+2 -2
View File
@@ -8,10 +8,10 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Check out repository - name: Check out repository
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
- name: Set up Node.js - name: Set up Node.js
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with: with:
node-version-file: ".nvmrc" node-version-file: ".nvmrc"
cache: "npm" cache: "npm"
+4 -4
View File
@@ -2,16 +2,16 @@ name: Publish to docs site
on: on:
workflow_dispatch: workflow_dispatch:
push: push:
branches: tags:
- main - "v*"
jobs: jobs:
build-docs: build-docs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
- name: Set up Node.js - name: Set up Node.js
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with: with:
node-version-file: ".nvmrc" node-version-file: ".nvmrc"
cache: "npm" cache: "npm"
+86 -66
View File
@@ -1,16 +1,16 @@
{ {
"name": "@showbridge/docs", "name": "@showbridge/docs",
"version": "0.1.2", "version": "0.4.0",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "@showbridge/docs", "name": "@showbridge/docs",
"version": "0.1.2", "version": "0.4.0",
"devDependencies": { "devDependencies": {
"@astrojs/check": "0.9.9", "@astrojs/check": "0.9.9",
"@astrojs/starlight": "^0.39.2", "@astrojs/starlight": "^0.39.3",
"astro": "^6.3.1", "astro": "^6.4.4",
"sharp": "0.34.5", "sharp": "0.34.5",
"typescript": "6.0.3" "typescript": "6.0.3"
} }
@@ -177,9 +177,9 @@
} }
}, },
"node_modules/@astrojs/starlight": { "node_modules/@astrojs/starlight": {
"version": "0.39.2", "version": "0.39.3",
"resolved": "https://registry.npmjs.org/@astrojs/starlight/-/starlight-0.39.2.tgz", "resolved": "https://registry.npmjs.org/@astrojs/starlight/-/starlight-0.39.3.tgz",
"integrity": "sha512-vlw+bwnjtf5buCTUtLU7JfV6D3knslxqnspr6LKs6hfRuFZiyr5hT44F7GyDqR9FKANUqFxnIzWM81F1k/kOUA==", "integrity": "sha512-uvAweA2DwhmLgFVfBT9NqG38Ey14k1ck3+y78XNJbceT1pMdzxCCX69RoBajb1QzTJviufsXzSc1xswgRxJfig==",
"dev": true, "dev": true,
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
@@ -203,7 +203,7 @@
"mdast-util-directive": "^3.1.0", "mdast-util-directive": "^3.1.0",
"mdast-util-to-markdown": "^2.1.2", "mdast-util-to-markdown": "^2.1.2",
"mdast-util-to-string": "^4.0.0", "mdast-util-to-string": "^4.0.0",
"pagefind": "^1.3.0", "pagefind": "^1.5.2",
"rehype": "^13.0.2", "rehype": "^13.0.2",
"rehype-format": "^5.0.1", "rehype-format": "^5.0.1",
"remark-directive": "^4.0.0", "remark-directive": "^4.0.0",
@@ -1443,9 +1443,9 @@
"dev": true "dev": true
}, },
"node_modules/@pagefind/darwin-arm64": { "node_modules/@pagefind/darwin-arm64": {
"version": "1.3.0", "version": "1.5.2",
"resolved": "https://registry.npmjs.org/@pagefind/darwin-arm64/-/darwin-arm64-1.3.0.tgz", "resolved": "https://registry.npmjs.org/@pagefind/darwin-arm64/-/darwin-arm64-1.5.2.tgz",
"integrity": "sha512-365BEGl6ChOsauRjyVpBjXybflXAOvoMROw3TucAROHIcdBvXk9/2AmEvGFU0r75+vdQI4LJdJdpH4Y6Yqaj4A==", "integrity": "sha512-MXpI+7HsAdPkvJ0gk9xj9g541BCqBZOBbdwj9g6lB5LCj6kSV6nqDSjzcAJwvOsfu0fjwvC8hQU+ecfhp+MpiQ==",
"cpu": [ "cpu": [
"arm64" "arm64"
], ],
@@ -1457,9 +1457,9 @@
] ]
}, },
"node_modules/@pagefind/darwin-x64": { "node_modules/@pagefind/darwin-x64": {
"version": "1.3.0", "version": "1.5.2",
"resolved": "https://registry.npmjs.org/@pagefind/darwin-x64/-/darwin-x64-1.3.0.tgz", "resolved": "https://registry.npmjs.org/@pagefind/darwin-x64/-/darwin-x64-1.5.2.tgz",
"integrity": "sha512-zlGHA23uuXmS8z3XxEGmbHpWDxXfPZ47QS06tGUq0HDcZjXjXHeLG+cboOy828QIV5FXsm9MjfkP5e4ZNbOkow==", "integrity": "sha512-IojxFWMEJe0RQ7PQ3KXQsPIImNsbpPYpoZ+QUDrL8fAl/O27IX+LVLs74/UzEZy5uA2LD8Nz1AiwKr72vrkZQw==",
"cpu": [ "cpu": [
"x64" "x64"
], ],
@@ -1477,10 +1477,24 @@
"dev": true, "dev": true,
"license": "MIT" "license": "MIT"
}, },
"node_modules/@pagefind/freebsd-x64": {
"version": "1.5.2",
"resolved": "https://registry.npmjs.org/@pagefind/freebsd-x64/-/freebsd-x64-1.5.2.tgz",
"integrity": "sha512-7EVzo9+0w+2cbe671BtMj10UlNo83I+HrLVLfRxO731svHRJKUfJ/mo05gU14pe9PCfpKNQT8FS3Xc/oDN6pOA==",
"cpu": [
"x64"
],
"dev": true,
"license": "MIT",
"optional": true,
"os": [
"freebsd"
]
},
"node_modules/@pagefind/linux-arm64": { "node_modules/@pagefind/linux-arm64": {
"version": "1.3.0", "version": "1.5.2",
"resolved": "https://registry.npmjs.org/@pagefind/linux-arm64/-/linux-arm64-1.3.0.tgz", "resolved": "https://registry.npmjs.org/@pagefind/linux-arm64/-/linux-arm64-1.5.2.tgz",
"integrity": "sha512-8lsxNAiBRUk72JvetSBXs4WRpYrQrVJXjlRRnOL6UCdBN9Nlsz0t7hWstRk36+JqHpGWOKYiuHLzGYqYAqoOnQ==", "integrity": "sha512-Ovt9+K35sqzn8H3ZMXGwls4TD/wMJuvRtShHIsmUQREmaxjrDEX7gHckRCrwYJ4XE1H1p6HkLz3wukrAnsfXQw==",
"cpu": [ "cpu": [
"arm64" "arm64"
], ],
@@ -1492,9 +1506,9 @@
] ]
}, },
"node_modules/@pagefind/linux-x64": { "node_modules/@pagefind/linux-x64": {
"version": "1.3.0", "version": "1.5.2",
"resolved": "https://registry.npmjs.org/@pagefind/linux-x64/-/linux-x64-1.3.0.tgz", "resolved": "https://registry.npmjs.org/@pagefind/linux-x64/-/linux-x64-1.5.2.tgz",
"integrity": "sha512-hAvqdPJv7A20Ucb6FQGE6jhjqy+vZ6pf+s2tFMNtMBG+fzcdc91uTw7aP/1Vo5plD0dAOHwdxfkyw0ugal4kcQ==", "integrity": "sha512-V+tFqHKXhQKq/WqPBD67AFy7scn1/aZID00ws4fSDd+1daSi5UHR9VVlRrOUYKxn3VuFQYRD7lYXdZK1WED1YA==",
"cpu": [ "cpu": [
"x64" "x64"
], ],
@@ -1505,10 +1519,24 @@
"linux" "linux"
] ]
}, },
"node_modules/@pagefind/windows-arm64": {
"version": "1.5.2",
"resolved": "https://registry.npmjs.org/@pagefind/windows-arm64/-/windows-arm64-1.5.2.tgz",
"integrity": "sha512-hN9Nh90fNW61nNRCW9ZyQrAj/mD0eRvmJ8NlTUzkbuW8kIzGJUi3cxjFkEcMZ5h/8FsKWD/VcouZl4yo1F7B6g==",
"cpu": [
"arm64"
],
"dev": true,
"license": "MIT",
"optional": true,
"os": [
"win32"
]
},
"node_modules/@pagefind/windows-x64": { "node_modules/@pagefind/windows-x64": {
"version": "1.3.0", "version": "1.5.2",
"resolved": "https://registry.npmjs.org/@pagefind/windows-x64/-/windows-x64-1.3.0.tgz", "resolved": "https://registry.npmjs.org/@pagefind/windows-x64/-/windows-x64-1.5.2.tgz",
"integrity": "sha512-BR1bIRWOMqkf8IoU576YDhij1Wd/Zf2kX/kCI0b2qzCKC8wcc2GQJaaRMCpzvCCrmliO4vtJ6RITp/AnoYUUmQ==", "integrity": "sha512-Fa2Iyw7kaDRzGMfNYNUXNW2zbL5FQVDgSOcbDHdzBrDEdpqOqg8TcZ68F22ol6NJ9IGzvUdmeyZypLW5dyhqsg==",
"cpu": [ "cpu": [
"x64" "x64"
], ],
@@ -2336,15 +2364,15 @@
} }
}, },
"node_modules/astro": { "node_modules/astro": {
"version": "6.3.1", "version": "6.4.4",
"resolved": "https://registry.npmjs.org/astro/-/astro-6.3.1.tgz", "resolved": "https://registry.npmjs.org/astro/-/astro-6.4.4.tgz",
"integrity": "sha512-atz6dmkE3Gu24bDgb7g2RE/BYnKqPYIHd6hTUM1UXvu/i7qNZOKLAqEHvgYpv9PQVcgWsXpk4/OOXZ0E/FzvSQ==", "integrity": "sha512-hVe8tq3lqt/Dr0UyB//yUmQSlHMTU8scTiF/vQddQVahLE4TTaSdH5H0nb7OvRcwo0UmlAO8DWYar4jNaS7H+A==",
"dev": true, "dev": true,
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@astrojs/compiler": "^4.0.0", "@astrojs/compiler": "^4.0.0",
"@astrojs/internal-helpers": "0.9.0", "@astrojs/internal-helpers": "0.10.0",
"@astrojs/markdown-remark": "7.1.1", "@astrojs/markdown-remark": "7.2.0",
"@astrojs/telemetry": "3.3.2", "@astrojs/telemetry": "3.3.2",
"@capsizecss/unpack": "^4.0.0", "@capsizecss/unpack": "^4.0.0",
"@clack/prompts": "^1.1.0", "@clack/prompts": "^1.1.0",
@@ -2356,7 +2384,7 @@
"clsx": "^2.1.1", "clsx": "^2.1.1",
"common-ancestor-path": "^2.0.0", "common-ancestor-path": "^2.0.0",
"cookie": "^1.1.1", "cookie": "^1.1.1",
"devalue": "^5.6.3", "devalue": "^5.8.1",
"diff": "^8.0.3", "diff": "^8.0.3",
"dset": "^3.1.4", "dset": "^3.1.4",
"es-module-lexer": "^2.0.0", "es-module-lexer": "^2.0.0",
@@ -2435,28 +2463,34 @@
"license": "MIT" "license": "MIT"
}, },
"node_modules/astro/node_modules/@astrojs/internal-helpers": { "node_modules/astro/node_modules/@astrojs/internal-helpers": {
"version": "0.9.0", "version": "0.10.0",
"resolved": "https://registry.npmjs.org/@astrojs/internal-helpers/-/internal-helpers-0.9.0.tgz", "resolved": "https://registry.npmjs.org/@astrojs/internal-helpers/-/internal-helpers-0.10.0.tgz",
"integrity": "sha512-GdYkzR26re8izmyYlBqf4z2s7zNngmWLFuxw0UKiPNqHraZGS6GKWIwSHgS22RDlu2ePFJ8bzmpBcUszut/SDg==", "integrity": "sha512-Ry2R3VPeIN4uPCSA4xQc+e+vsJXkalKpEbDc07hV+a/o5Bs2N/s/uDcPJH/05L19DKh9tAy7e6JM3YZ6Cxfezw==",
"dev": true, "dev": true,
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"picomatch": "^4.0.4" "@types/hast": "^3.0.4",
"@types/mdast": "^4.0.4",
"js-yaml": "^4.1.1",
"picomatch": "^4.0.4",
"retext-smartypants": "^6.2.0",
"shiki": "^4.0.2",
"smol-toml": "^1.6.0",
"unified": "^11.0.5"
} }
}, },
"node_modules/astro/node_modules/@astrojs/markdown-remark": { "node_modules/astro/node_modules/@astrojs/markdown-remark": {
"version": "7.1.1", "version": "7.2.0",
"resolved": "https://registry.npmjs.org/@astrojs/markdown-remark/-/markdown-remark-7.1.1.tgz", "resolved": "https://registry.npmjs.org/@astrojs/markdown-remark/-/markdown-remark-7.2.0.tgz",
"integrity": "sha512-C6e9BnLGlbdv6bV8MYGeHpHxsUHrCrB4OuRLqi5LI7oiBVcBcqfUN06zpwFQdHgV48QCCrMmLpyqBr7VqC+swA==", "integrity": "sha512-+YxmVQu1Bd+MFfSzjq1rOJvD9+nIOJzz5YIIhdIH01RrxRkKbyKoEgyIqP3yv51MhzMDgd79QaPv+kCVPT8vHw==",
"dev": true, "dev": true,
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@astrojs/internal-helpers": "0.9.0", "@astrojs/internal-helpers": "0.10.0",
"@astrojs/prism": "4.0.1", "@astrojs/prism": "4.0.2",
"github-slugger": "^2.0.0", "github-slugger": "^2.0.0",
"hast-util-from-html": "^2.0.3", "hast-util-from-html": "^2.0.3",
"hast-util-to-text": "^4.0.2", "hast-util-to-text": "^4.0.2",
"js-yaml": "^4.1.1",
"mdast-util-definitions": "^6.0.0", "mdast-util-definitions": "^6.0.0",
"rehype-raw": "^7.0.0", "rehype-raw": "^7.0.0",
"rehype-stringify": "^10.0.1", "rehype-stringify": "^10.0.1",
@@ -2464,9 +2498,6 @@
"remark-parse": "^11.0.0", "remark-parse": "^11.0.0",
"remark-rehype": "^11.1.2", "remark-rehype": "^11.1.2",
"remark-smartypants": "^3.0.2", "remark-smartypants": "^3.0.2",
"retext-smartypants": "^6.2.0",
"shiki": "^4.0.0",
"smol-toml": "^1.6.0",
"unified": "^11.0.5", "unified": "^11.0.5",
"unist-util-remove-position": "^5.0.0", "unist-util-remove-position": "^5.0.0",
"unist-util-visit": "^5.1.0", "unist-util-visit": "^5.1.0",
@@ -2474,19 +2505,6 @@
"vfile": "^6.0.3" "vfile": "^6.0.3"
} }
}, },
"node_modules/astro/node_modules/@astrojs/prism": {
"version": "4.0.1",
"resolved": "https://registry.npmjs.org/@astrojs/prism/-/prism-4.0.1.tgz",
"integrity": "sha512-nksZQVjlferuWzhPsBpQ1JE5XuKAf1id1/9Hj4a9KG4+ofrlzxUUwX4YGQF/SuDiuiGKEnzopGOt38F3AnVWsQ==",
"dev": true,
"license": "MIT",
"dependencies": {
"prismjs": "^1.30.0"
},
"engines": {
"node": ">=22.12.0"
}
},
"node_modules/astro/node_modules/jsonc-parser": { "node_modules/astro/node_modules/jsonc-parser": {
"version": "3.3.1", "version": "3.3.1",
"resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.3.1.tgz", "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.3.1.tgz",
@@ -3000,9 +3018,9 @@
} }
}, },
"node_modules/devalue": { "node_modules/devalue": {
"version": "5.6.4", "version": "5.8.1",
"resolved": "https://registry.npmjs.org/devalue/-/devalue-5.6.4.tgz", "resolved": "https://registry.npmjs.org/devalue/-/devalue-5.8.1.tgz",
"integrity": "sha512-Gp6rDldRsFh/7XuouDbxMH3Mx8GMCcgzIb1pDTvNyn8pZGQ22u+Wa+lGV9dQCltFQ7uVw0MhRyb8XDskNFOReA==", "integrity": "sha512-4CXDYRBGqN+57wVJkuXBYmpAVUSg3L6JAQa/DFqm238G73E1wuyc/JhGQJzN7vUf/CMphYau2zXbfWzDR5aTEw==",
"dev": true, "dev": true,
"license": "MIT" "license": "MIT"
}, },
@@ -5591,20 +5609,22 @@
"license": "MIT" "license": "MIT"
}, },
"node_modules/pagefind": { "node_modules/pagefind": {
"version": "1.3.0", "version": "1.5.2",
"resolved": "https://registry.npmjs.org/pagefind/-/pagefind-1.3.0.tgz", "resolved": "https://registry.npmjs.org/pagefind/-/pagefind-1.5.2.tgz",
"integrity": "sha512-8KPLGT5g9s+olKMRTU9LFekLizkVIu9tes90O1/aigJ0T5LmyPqTzGJrETnSw3meSYg58YH7JTzhTTW/3z6VAw==", "integrity": "sha512-XTUaK0hXMCu2jszWE584JGQT7y284TmMV9l/HX3rnG5uo3rHI/uHU56XTyyyPFjeWEBxECbAi0CaFDJOONtG0Q==",
"dev": true, "dev": true,
"license": "MIT", "license": "MIT",
"bin": { "bin": {
"pagefind": "lib/runner/bin.cjs" "pagefind": "lib/runner/bin.cjs"
}, },
"optionalDependencies": { "optionalDependencies": {
"@pagefind/darwin-arm64": "1.3.0", "@pagefind/darwin-arm64": "1.5.2",
"@pagefind/darwin-x64": "1.3.0", "@pagefind/darwin-x64": "1.5.2",
"@pagefind/linux-arm64": "1.3.0", "@pagefind/freebsd-x64": "1.5.2",
"@pagefind/linux-x64": "1.3.0", "@pagefind/linux-arm64": "1.5.2",
"@pagefind/windows-x64": "1.3.0" "@pagefind/linux-x64": "1.5.2",
"@pagefind/windows-arm64": "1.5.2",
"@pagefind/windows-x64": "1.5.2"
} }
}, },
"node_modules/parse-entities": { "node_modules/parse-entities": {
+3 -3
View File
@@ -1,7 +1,7 @@
{ {
"name": "@showbridge/docs", "name": "@showbridge/docs",
"type": "module", "type": "module",
"version": "0.1.2", "version": "0.4.0",
"files": [ "files": [
"dist" "dist"
], ],
@@ -15,8 +15,8 @@
}, },
"devDependencies": { "devDependencies": {
"@astrojs/check": "0.9.9", "@astrojs/check": "0.9.9",
"@astrojs/starlight": "^0.39.2", "@astrojs/starlight": "^0.39.3",
"astro": "^6.3.1", "astro": "^6.4.4",
"sharp": "0.34.5", "sharp": "0.34.5",
"typescript": "6.0.3" "typescript": "6.0.3"
} }
+28
View File
@@ -0,0 +1,28 @@
---
const {schema} = Astro.props
---
<ul>
{Object.keys(schema.properties).map((key)=>{
const propertySchema = schema.properties[key]
const isRequired = schema.required ? schema.required.includes(key) : false
var description = ""
if (!isRequired) {
if (propertySchema.default !== undefined) {
description += `(optional, default <code>${JSON.stringify(propertySchema.default)}</code>)`
} else {
description += "(optional)"
}
}
if (propertySchema.description) {
description += ` ${propertySchema.description}`
}
if (description !== "") {
description = ": " + description
}
return <li><strong>{key}</strong><Fragment set:html={description}/></li>
})}
</ul>
+23
View File
@@ -0,0 +1,23 @@
---
import moduleSchema from '../data/modules.schema.json';
import processorSchema from '../data/processors.schema.json';
import Params from './Params.astro';
const {type, id} = Astro.props;
var schema;
switch(type) {
case 'module':
schema = moduleSchema.items?.oneOf?.find(schema=>schema["$id"] === id);
break;
case 'processor':
schema = processorSchema.items?.oneOf?.find(schema=>schema["$id"] === id);
break;
}
---
{
schema !== undefined &&
<ul>
{schema.properties.type !== undefined && <li><strong>type</strong>:&nbsp;<code>{schema.properties.type.const}</code></li>}
{schema.properties.params !== undefined && <li><strong>params</strong>:<Params schema={schema.properties.params}/></li>}
</ul>
}
+8 -8
View File
@@ -3,22 +3,22 @@ title: SQLite
sidebar: sidebar:
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `db.sqlite` module can open/create SQLite databases The `db.sqlite` module can open/create SQLite databases
- **type**: `db.sqlite` <SchemaInfo type="module" id="db.sqlite"></SchemaInfo>
- **params**:
- **dsn**: the data source name, this can be a file path or the special `:memory:` name for an in-memory DB
## Cap This module implements the `DatabaseModule` interface.
### Example snippet
### Example
Opens an in-memory SQLite database Opens an in-memory SQLite database
```yaml ```yaml
- id: db - id: myDatabase
type: db.sqlite type: db.sqlite
params: params:
dsn: ":memory:" dsn: ":memory:"
``` ```
@@ -4,12 +4,11 @@ sidebar:
label: Server label: Server
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `http.server` module emits a message for every HTTP request that is made to the server. The `http.server` module emits a message for every HTTP request that is made to the server.
- **type**: `http.server` <SchemaInfo type="module" id="http.server"></SchemaInfo>
- **params**:
- **port**: TCP port to listen for HTTP requests on
### Example ### Example
+2 -3
View File
@@ -6,6 +6,7 @@ sidebar:
--- ---
import { Aside } from "@astrojs/starlight/components"; import { Aside } from "@astrojs/starlight/components";
import SchemaInfo from '../../../../components/SchemaInfo.astro';
<Aside type="caution"> <Aside type="caution">
This module is not currently included in the docker builds of This module is not currently included in the docker builds of
@@ -14,9 +15,7 @@ import { Aside } from "@astrojs/starlight/components";
The `midi.input` module connects to a midi device (or virtual device) and emits MIDI messages that come in on that port. This module does not support output. The `midi.input` module connects to a midi device (or virtual device) and emits MIDI messages that come in on that port. This module does not support output.
- **type**: `midi.input` <SchemaInfo type="module" id="midi.input"></SchemaInfo>
- **params**:
- **port**: name of the MIDI port to connect to
### Example ### Example
+2 -3
View File
@@ -6,6 +6,7 @@ sidebar:
--- ---
import { Aside } from "@astrojs/starlight/components"; import { Aside } from "@astrojs/starlight/components";
import SchemaInfo from '../../../../components/SchemaInfo.astro';
<Aside type="caution"> <Aside type="caution">
This module is not currently included in the docker builds of This module is not currently included in the docker builds of
@@ -14,9 +15,7 @@ import { Aside } from "@astrojs/starlight/components";
The `midi.output` module connects to a midi device (or virtual device) and allows sending MIDI messages out to that device. This module does not produce any messages and so using it as an `input` to a [route](/concepts/routes) would be pointless. The `midi.output` module connects to a midi device (or virtual device) and allows sending MIDI messages out to that device. This module does not produce any messages and so using it as an `input` to a [route](/concepts/routes) would be pointless.
- **type**: `midi.output` <SchemaInfo type="module" id="midi.output"></SchemaInfo>
- **params**:
- **port**: name of the MIDI port to connect to
### Example ### Example
+4 -5
View File
@@ -4,14 +4,13 @@ sidebar:
label: Client label: Client
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `mqtt.client` module connects to a MQTT broker and emits a message messages based on the subscribed topic it receives from the port. This module is also capable of publishing MQTT messages to the connected broker. The `mqtt.client` module connects to a MQTT broker and emits a message messages based on the subscribed topic it receives from the port. This module is also capable of publishing MQTT messages to the connected broker.
- **type**: `mqtt.client` <SchemaInfo type="module" id="mqtt.client"></SchemaInfo>
- **params**:
- **broker**: connection string for the mqtt broker (`mqtt://test.mosquitto.org:1833`) This module implements the `PubSubModule` interface.
- **topic** mqtt topic to subscribe to
- **clientId** client ID for this connection to the broker
### Example ### Example
+4 -4
View File
@@ -4,13 +4,13 @@ sidebar:
label: Client label: Client
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
This module connects to a [NATS](https://nats.io/) server and subscribes to a subject. This module connects to a [NATS](https://nats.io/) server and subscribes to a subject.
- **type**: `nats.client` <SchemaInfo type="module" id="nats.client"></SchemaInfo>
- **params**:
- **url**: the URL of the NATS server to connect to (e.g. `nats://localhost:4222`) This module implements the `PubSubModule` interface.
- **subject**: the subject to subscribe to
### Example ### Example
+5 -7
View File
@@ -4,22 +4,20 @@ sidebar:
label: Server label: Server
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
This module starts a NATS server that listens for incoming connections. This module starts a NATS server that listens for incoming connections.
- **type**: `nats.server` <SchemaInfo type="module" id="nats.server"></SchemaInfo>
- **params**:
- **ip**: (optional) the IP address to bind the server to defaults to `0.0.0.0`
- **port**: (optional) the port to listen on defaults to `4222`
### Example ### Example
Start a local NATS server listening on port 5555 Start a local NATS server listening on port 5555
```yaml ```yaml
- id: httpServer - id: natsServer
type: http.server type: nats.server
params: params:
ip: 127.0.0.1 ip: 127.0.0.1
port: 5555 port: 4222
``` ```
+2 -10
View File
@@ -4,19 +4,11 @@ sidebar:
label: Client label: Client
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
The `net.tcp.client` module connects to TCP server and emits messages based on the data it receives from the server that it connects to. Messages are determined by "framing" techniques as TCP is a stream based protocol. The module will attempt to reconnect anytime the connection is closed. The `net.tcp.client` module connects to TCP server and emits messages based on the data it receives from the server that it connects to. Messages are determined by "framing" techniques as TCP is a stream based protocol. The module will attempt to reconnect anytime the connection is closed.
- **type**: `net.tcp.client` <SchemaInfo type="module" id="net.tcp.client"></SchemaInfo>
- **params**:
- **host**: IP or FQDN to connect to
- **port**: TCP port to connect to
- **framing**: how to chunk the TCP stream into "messages"
- LF `\n`
- CR `\r`
- CRLF `\r\n`
- [SLIP](https://en.wikipedia.org/wiki/Serial_Line_Internet_Protocol)
- RAW (no framing is done bytes are sent out as they are received)
### Example ### Example
+2 -10
View File
@@ -4,19 +4,11 @@ sidebar:
label: Server label: Server
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
The `net.tcp.server` module emits a message messages based on the data it receives from clients that connect to it. Messages are determined by "framing" techniques as TCP is a stream based protocol. The `net.tcp.server` module emits a message messages based on the data it receives from clients that connect to it. Messages are determined by "framing" techniques as TCP is a stream based protocol.
- **type**: `net.tcp.server` <SchemaInfo type="module" id="net.tcp.server"></SchemaInfo>
- **params**:
- **ip**: (optional) IP address to bind the TCP server to, if left out it will listen on all interfaces
- **port**: TCP port to listen on
- **framing**: how to chunk of the incoming TCP stream into "messages"
- LF `\n`
- CR `\r`
- CRLF `\r\n`
- [SLIP](https://en.wikipedia.org/wiki/Serial_Line_Internet_Protocol)
- RAW (no framing is done bytes are sent out as they are received)
### Example ### Example
+2 -4
View File
@@ -4,13 +4,11 @@ sidebar:
label: Client label: Client
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
The `net.udp.client` module sends messages to a the configured `host` and `port`. This module does not produce any messages and so using it as an `input` to a [route](/concepts/routes) would be pointless. The `net.udp.client` module sends messages to a the configured `host` and `port`. This module does not produce any messages and so using it as an `input` to a [route](/concepts/routes) would be pointless.
- **type**: `net.udp.client` <SchemaInfo type="module" id="net.udp.client"></SchemaInfo>
- **params**:
- **host**: IP or FQDN to send message to
- **port**: UDP port to send messages to
### Example ### Example
@@ -4,11 +4,9 @@ sidebar:
label: Multicast label: Multicast
order: 3 order: 3
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
- **type**: `net.udp.multicast` <SchemaInfo type="module" id="net.udp.multicast"></SchemaInfo>
- **params**:
- **ip**: the multicast IP address to listen to
- **port**: the port to listen on
### Example ### Example
+2 -5
View File
@@ -4,14 +4,11 @@ sidebar:
label: Server label: Server
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
The `net.udp.server` module emits a message for every incoming UDP datagram. The `net.udp.server` module emits a message for every incoming UDP datagram.
- **type**: `net.udp.server` <SchemaInfo type="module" id="net.udp.server"></SchemaInfo>
- **params**:
- **ip**: (optional) IP address to bind the UDP server to, if left out it will listen on all interfaces
- **port**: UDP port to listen on
- **bufferSize**: (optional) Size of the read buffer for incoming UDP datagrams, defaults to `2048`
### Example ### Example
+3 -2
View File
@@ -4,11 +4,12 @@ sidebar:
label: Client label: Client
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
- **type**: `psn.client`
This module listens on the [PosiStageNet](http://posistage.net/) multicast address and emits tracker states anytime a new PSN message is received. This module listens on the [PosiStageNet](http://posistage.net/) multicast address and emits tracker states anytime a new PSN message is received.
<SchemaInfo type="module" id="psn.client"></SchemaInfo>
### Example ### Example
```yaml ```yaml
+4 -4
View File
@@ -4,13 +4,13 @@ sidebar:
label: Client label: Client
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `redis.client` module connects to a Redis server. This module does not produce any messages and so using it as an `input` to a [route](/concepts/routes) would be pointless. The `redis.client` module connects to a Redis server. This module does not produce any messages and so using it as an `input` to a [route](/concepts/routes) would be pointless.
- **type**: `redis.client` <SchemaInfo type="module" id="redis.client"></SchemaInfo>
- **params**:
- **host**: the Redis server host This module implements the `KeyValueModule` interface.
- **port**: the Redis server port
### Example ### Example
+2 -11
View File
@@ -4,7 +4,7 @@ sidebar:
label: Client label: Client
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
import { Aside } from "@astrojs/starlight/components"; import { Aside } from "@astrojs/starlight/components";
<Aside type="caution"> <Aside type="caution">
@@ -14,16 +14,7 @@ import { Aside } from "@astrojs/starlight/components";
The `serial.client` module connects to a serial device and emits a message messages based on the data it receives from the port. Messages are determined by "framing" techniques as serial is a stream based protocol. The `serial.client` module connects to a serial device and emits a message messages based on the data it receives from the port. Messages are determined by "framing" techniques as serial is a stream based protocol.
- **type**: `serial.client` <SchemaInfo type="module" id="serial.client"></SchemaInfo>
- **params**:
- **port**: serial port to connect to i.e `/dev/ttyS0`
- **baudRate** baud rate to use when connecting to serial port
- **framing**: how to chunk the serial stream into "messages"
- LF `\n`
- CR `\r`
- CRLF `\r\n`
- [SLIP](https://en.wikipedia.org/wiki/Serial_Line_Internet_Protocol)
- RAW (no framing is done bytes are sent out as they are received)
### Example ### Example
+2 -6
View File
@@ -4,15 +4,11 @@ sidebar:
label: Server label: Server
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
This module starts a [SIP](https://en.wikipedia.org/wiki/Session_Initiation_Protocol) server that listens for incoming connections and emits call events when a new call is received. This can be used with cheap SIP gateway devices to connect an analog phone line and do interesting things like [firing QLab cues with phone calls](/examples/dial-a-cue). This module starts a [SIP](https://en.wikipedia.org/wiki/Session_Initiation_Protocol) server that listens for incoming connections and emits call events when a new call is received. This can be used with cheap SIP gateway devices to connect an analog phone line and do interesting things like [firing QLab cues with phone calls](/examples/dial-a-cue).
- **type**: `sip.call.server` <SchemaInfo type="module" id="sip.call.server"></SchemaInfo>
- **params**:
- **ip**: (optional) the IP address to bind the server to defaults to `0.0.0.0`
- **port**: (optional) the port to listen on defaults to `5060`
- **transport**: (optional) the transport protocol to use (e.g. `udp`, `tcp`, `ws`) defaults to `udp`
- **userAgent**: (optional) the User-Agent string to use in SIP responses defaults to `showbridge`
### Example ### Example
+2 -7
View File
@@ -4,16 +4,11 @@ sidebar:
label: Server label: Server
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
This module starts a [SIP](https://en.wikipedia.org/wiki/Session_Initiation_Protocol) server that listens for incoming connections. When a call is received this module will emit events based on the touch tones (DTMF) received during the call. The event is sent out whenever the use presses the separator key defined in the params. This module starts a [SIP](https://en.wikipedia.org/wiki/Session_Initiation_Protocol) server that listens for incoming connections. When a call is received this module will emit events based on the touch tones (DTMF) received during the call. The event is sent out whenever the use presses the separator key defined in the params.
- **type**: `sip.dtmf.server` <SchemaInfo type="module" id="sip.dtmf.server"></SchemaInfo>
- **params**:
- **ip**: (optional) the IP address to bind the server to defaults to `0.0.0.0`
- **port**: (optional) the port to listen on defaults to `5060`
- **transport**: (optional) the transport protocol to use (e.g. `udp`, `tcp`, `ws`) defaults to `udp`
- **userAgent**: (optional) the User-Agent string to use in SIP responses defaults to `showbridge`
- **separator**: the DTMF separator key to know when to emit events
### Example ### Example
+2 -3
View File
@@ -3,12 +3,11 @@ title: Interval
sidebar: sidebar:
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `time.interval` module emits a message at a specified duration. Sending any message to this module will reset the interval timer. The `time.interval` module emits a message at a specified duration. Sending any message to this module will reset the interval timer.
- **type**: `time.interval` <SchemaInfo type="module" id="time.interval"/>
- **params**:
- **duration**: time in milliseconds between messsages
### Example snippet ### Example snippet
+2 -3
View File
@@ -3,12 +3,11 @@ title: Timer
sidebar: sidebar:
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `time.timer` module emits only one message after a specified duration. Sending any message to this module will reset the timer. The `time.timer` module emits only one message after a specified duration. Sending any message to this module will reset the timer.
- **type**: `time.timer` <SchemaInfo type="module" id="time.timer"></SchemaInfo>
- **params**:
- **duration**: time in milliseconds to wait before emitting message
### Example snippet ### Example snippet
@@ -4,12 +4,11 @@ sidebar:
label: Client label: Client
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `websocket.client` module opens a websocket connection to the specified URL. This module supports both text and binary websocket messages. The `websocket.client` module opens a websocket connection to the specified URL. This module supports both text and binary websocket messages.
- **type**: `websocket.client` <SchemaInfo type="module" id="websocket.client"></SchemaInfo>
- **params**:
- **url**: the full url to connect to (`wss://echo.websocket.org`)
### Example ### Example
@@ -4,11 +4,13 @@ sidebar:
label: Decode label: Decode
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
- **type**: `artnet.packet.decode`
This processor will decode incoming bytes into an ArtNet packet. This processor will return an error if the message being processed is not an array of bytes. This processor will decode incoming bytes into an ArtNet packet. This processor will return an error if the message being processed is not an array of bytes.
<SchemaInfo type="processor" id="artnet.packet.decode"/>
### Example ### Example
```yaml ```yaml
@@ -4,9 +4,12 @@ sidebar:
label: Encode label: Encode
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
This processor will encode an ArtNet packet into an array of bytes. This processor will return an error if the message being processed is not an ArtNet packet.
<SchemaInfo type="processor" id="artnet.packet.encode"/>
- **type**: `artnet.packet.encode`
This processor will encode an ArtNet packet into an array of bytes. This processor will return an error if the message being processed is not an ArtNet packet.
### Example ### Example
+4 -4
View File
@@ -4,13 +4,13 @@ sidebar:
label: Query label: Query
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `db.query` processor will issue a query to the specified module and return the result to the next processor in line. The `db.query` processor will issue a query to the specified module and return the result to the next processor in line.
The module must implement the `DatabaseModule` interface for this processor to work.
This processor will return an error if any of the required parameters are missing/invalid or if the module does not implement the `DatabaseModule` interface.
- **type**: `db.query` <SchemaInfo type="processor" id="db.query"/>
- **params**:
- **module**: the id of the [module](/concepts/modules) to issue query to.
- **query**: the query to execute.
### Example ### Example
+4 -2
View File
@@ -4,9 +4,11 @@ sidebar:
label: Log label: Log
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
- **type**: `debug.log` This processor will log information about the message being processed to the console. This processor does not modify the message in any way and will pass the message through to the next processor in the chain.
This processor will log information about the message being processed to the console. This processor does not modify the message in any way and will pass the message through to the next processor in the chain.
<SchemaInfo type="processor" id="debug.log"/>
### Example ### Example
@@ -4,10 +4,11 @@ sidebar:
label: On Change label: On Change
order: 3 order: 3
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
This processor will only pass messages through if the value of the message has changed since the last time a message was processed. This processor is useful for filtering out duplicate messages that may be emitted by a module or processor. This processor will only pass messages through if the value of the message has changed since the last time a message was processed. This processor is useful for filtering out duplicate messages that may be emitted by a module or processor.
- **type**: `filter.change` <SchemaInfo type="processor" id="filter.change"/>
### Example ### Example
+3 -4
View File
@@ -4,12 +4,11 @@ sidebar:
label: Expr label: Expr
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `filter.expr` processor evaluates an [Expr expression](https://expr-lang.org/playground). If the expression evaluates to true then the payload is sent through. This processor will return an error if the expression fails to evaluate. The `filter.expr` processor evaluates an [Expr expression](https://expr-lang.org/playground). If the expression evaluates to true then the payload is sent through. This processor will return an error if the expression fails to evaluate.
- **type**: `filter.expr` <SchemaInfo type="processor" id="filter.expr"/>
- **params**:
- **expression**: [Expr expression](https://expr-lang.org/playground) to evaluate. The expression has access to the [wrapped payload](/concepts/payload).
### Example ### Example
@@ -18,5 +17,5 @@ Match a payload great than or equal to 0
```yaml ```yaml
- type: filter.expr - type: filter.expr
params: params:
pattern: "Payload >= 0" expression: "Payload >= 0"
``` ```
+2 -3
View File
@@ -4,12 +4,11 @@ sidebar:
label: Regex label: Regex
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `filter.regex` processor matches incoming string payload against a regular expression. If there is a match then the payload is sent through. This processor will return an error if the message being processed is not a string. The `filter.regex` processor matches incoming string payload against a regular expression. If there is a match then the payload is sent through. This processor will return an error if the message being processed is not a string.
- **type**: `filter.regex` <SchemaInfo type="processor" id="filter.regex"/>
- **params**:
- **pattern**: regex pattern to match against the incoming string
### Example ### Example
+2 -3
View File
@@ -4,12 +4,11 @@ sidebar:
label: Parse label: Parse
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `float.parse` processor takes a string and parses it as a float with the specified `base` and `bitSize`. This processor will return an error if the message being processed is not a string or if the string cannot be parsed into a float. The `float.parse` processor takes a string and parses it as a float with the specified `base` and `bitSize`. This processor will return an error if the message being processed is not a string or if the string cannot be parsed into a float.
- **type**: `float.parse` <SchemaInfo type="processor" id="float.parse"/>
- **params**:
- **bitSize**: (optional) the bit size of the float to parse, defaults to 64
### Example ### Example
+2 -5
View File
@@ -4,14 +4,11 @@ sidebar:
label: Random label: Random
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `float.random` processor will set the payload to a random float between the specified `min` and `max` value. The `float.random` processor will set the payload to a random float between the specified `min` and `max` value.
- **type**: `float.random` <SchemaInfo type="processor" id="float.random"/>
- **params**:
- **bitSize**: (optional) the bit size of the float to generate, defaults to 32
- **min**: the minimum value for the random float (inclusive).
- **max**: the maximum value for the random float (exclusive).
### Example ### Example
+3 -12
View File
@@ -4,25 +4,16 @@ sidebar:
label: Create label: Create
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
This processor will create a new FreeD message with the specified parameters. This processor will create a new FreeD message with the specified parameters.
- **type**: `free.d.create` <SchemaInfo type="processor" id="freed.create"/>
- **params**:
- **id**: the ID to set for the FreeD message
- **pan**: the pan value to set for the FreeD message
- **tilt**: the tilt value to set for the FreeD message
- **roll**: the roll value to set for the FreeD message
- **posX**: the X position value to set for the FreeD message
- **posY**: the Y position value to set for the FreeD message
- **posZ**: the Z position value to set for the FreeD message
- **zoom**: the zoom value to set for the FreeD message
- **focus**: the focus value to set for the FreeD message
### Example ### Example
```yaml ```yaml
- type: free.d.create - type: freed.create
params: params:
id: "1" id: "1"
pan: "45" pan: "45"
@@ -4,13 +4,14 @@ sidebar:
label: Decode label: Decode
order: 3 order: 3
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
This processor will decode incoming bytes into a FreeD message. This processor will return an error if the message being processed is not an array of bytes. This processor will decode incoming bytes into a FreeD message. This processor will return an error if the message being processed is not an array of bytes.
- **type**: `free.d.decode` <SchemaInfo type="processor" id="freed.decode"/>
### Example ### Example
```yaml ```yaml
- type: free.d.decode - type: freed.decode
``` ```
@@ -4,13 +4,14 @@ sidebar:
label: Encode label: Encode
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
This processor will encode a FreeD message into an array of bytes. This processor will return an error if the message being processed is not a FreeD message. This processor will encode a FreeD message into an array of bytes. This processor will return an error if the message being processed is not a FreeD message.
- **type**: `free.d.encode` <SchemaInfo type="processor" id="freed.encode"/>
### Example ### Example
```yaml ```yaml
- type: free.d.encode - type: freed.encode
``` ```
@@ -4,13 +4,11 @@ sidebar:
label: Make Request label: Make Request
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
This process will make an HTTP request to the specified URL using the specified method. The response will be passed through to the next processor in the chain. This processor will return an error if the request fails for any reason (e.g. network error, invalid URL, etc.). This process will make an HTTP request to the specified URL using the specified method. The response will be passed through to the next processor in the chain. This processor will return an error if the request fails for any reason (e.g. network error, invalid URL, etc.).
- **type**: `http.request.do` <SchemaInfo type="processor" id="http.request.do"/>
- **params**:
- **method**: the HTTP method to use for the request (e.g. `GET`, `POST`, `PUT`, etc.)
- **url**: the URL to send the request to
### Example ### Example
@@ -4,13 +4,11 @@ sidebar:
label: Create label: Create
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
This processor will create a new HTTP response with the specified status code and body template. The created response will be passed through to the next processor in the chain. If the response is subsequently sent to an HTTP server module using the [module.output](../module/output.md) processor, the status code and body template set by this processor will be used for the response sent to the client. This processor will return an error if there is an issue executing the body template. This processor will create a new HTTP response with the specified status code and body template. The created response will be passed through to the next processor in the chain. If the response is subsequently sent to an HTTP server module using the [module.output](../module/output.md) processor, the status code and body template set by this processor will be used for the response sent to the client. This processor will return an error if there is an issue executing the body template.
- **type**: `http.response.create` <SchemaInfo type="processor" id="http.response.create"/>
- **params**:
- **status**: the HTTP status code to set for the response (e.g. `200`, `404`, etc.)
- **body**: the body template to set for the response
### Example ### Example
@@ -20,5 +18,5 @@ This would create an HTTP response with a status code of `200` and a body of `OK
- type: http.response.create - type: http.response.create
params: params:
status: 200 status: 200
body: "OK" bodyTemplate: "OK"
``` ```
+2 -4
View File
@@ -4,13 +4,11 @@ sidebar:
label: Parse label: Parse
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `int.parse` processor takes a string and parses it as an integer with the specified `base` and `bitSize`. This processor will return an error if the message being processed is not a string or if the string cannot be parsed into an integer. The `int.parse` processor takes a string and parses it as an integer with the specified `base` and `bitSize`. This processor will return an error if the message being processed is not a string or if the string cannot be parsed into an integer.
- **type**: `int.parse` <SchemaInfo type="processor" id="int.parse"/>
- **params**:
- **base**: (optional) the base to use for parsing the integer, defaults to 10
- **bitSize**: (optional) the bit size of the integer to parse, defaults to 64
### Example ### Example
+2 -4
View File
@@ -3,13 +3,11 @@ title: Create Random Int
sidebar: sidebar:
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `int.random` processor will set the payload to a random integer between the specified `min` and `max` value. The `int.random` processor will set the payload to a random integer between the specified `min` and `max` value.
- **type**: `int.random` <SchemaInfo type="processor" id="int.random"/>
- **params**:
- **min**: the minimum value for the random integer (inclusive).
- **max**: the maximum value for the random integer (inclusive).
### Example ### Example
+2 -6
View File
@@ -4,15 +4,11 @@ sidebar:
label: Scale label: Scale
order: 3 order: 3
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
This processor will scale an integer value from one range to another. This processor will return an error if the message being processed is not an integer or if the parameters are not valid (e.g. if `inMin` is greater than or equal to `inMax`, etc.). This processor will scale an integer value from one range to another. This processor will return an error if the message being processed is not an integer or if the parameters are not valid (e.g. if `inMin` is greater than or equal to `inMax`, etc.).
- **type**: `int.scale` <SchemaInfo type="processor" id="int.scale"/>
- **params**:
- **inMin**: the minimum value of the input range
- **inMax**: the maximum value of the input range
- **outMin**: the minimum value of the output range
- **outMax**: the maximum value of the output range
### Example ### Example
+2 -1
View File
@@ -4,10 +4,11 @@ sidebar:
label: Decode label: Decode
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
Convert an incoming byte array or raw string into a JSON object. This processor will return an error if the message being processed is not an array of bytes or a raw string, or if the bytes/string cannot be parsed as JSON. Convert an incoming byte array or raw string into a JSON object. This processor will return an error if the message being processed is not an array of bytes or a raw string, or if the bytes/string cannot be parsed as JSON.
- **type**: `json.decode` <SchemaInfo type="processor" id="json.decode"/>
### Example ### Example
+2 -1
View File
@@ -4,10 +4,11 @@ sidebar:
label: Encode label: Encode
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
This processor will encode an incoming object into a JSON byte array. This processor will return an error if the message being processed is not able to be serialized as JSON. This processor will encode an incoming object into a JSON byte array. This processor will return an error if the message being processed is not able to be serialized as JSON.
- **type**: `json.encode` <SchemaInfo type="processor" id="json.encode"/>
### Example ### Example
+4 -5
View File
@@ -4,13 +4,12 @@ sidebar:
label: Get label: Get
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `kv.get` processor gets the value associated with a key from a compatible module. The output payload is the value if the key is found. The `kv.get` processor gets the value associated with a key from a module that implements the `KeyValueModule` interface.
The output payload is the value if the key is found.
- **type**: `kv.get` <SchemaInfo type="processor" id="kv.get"/>
- **params**:
- **module**: id of the module
- **key**: the key to look up
### Example ### Example
+4 -8
View File
@@ -4,23 +4,19 @@ sidebar:
label: Set label: Set
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `kv.set` processor sets the value associated with a key from a compatible module. The payload is unchanged so whatever is received by this payload is output unless any errors are encountered. The `kv.set` processor sets the value of the configured key to the incoming payload using a module that implements the `KeyValueModule` interface. The payload is unchanged so whatever is received by this processor is output unless any errors are encountered.
- **type**: `kv.set` <SchemaInfo type="processor" id="kv.set"/>
- **params**:
- **module**: id of the module
- **key**: the key to look up
- **value**: the value to set
### Example ### Example
This will attempt to set the key `hello` to `world` using the module with an id of `redis` This will attempt to set the key `hello` using the module with an id of `redis`
```yaml ```yaml
- type: kv.set - type: kv.set
params: params:
module: redis module: redis
key: hello key: hello
value: world
``` ```
@@ -4,14 +4,11 @@ sidebar:
label: Create label: Create
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
This processor will create a MIDI Control Change message with the specified channel, control number, and control value. This processor will create a MIDI Control Change message with the specified channel, control number, and control value.
- **type**: `midi.control_change.create` <SchemaInfo type="processor" id="midi.control_change.create"/>
- **params**:
- **channel**: the MIDI channel
- **control**: the control number
- **value**: the control value
### Example ### Example
@@ -4,10 +4,11 @@ sidebar:
label: Decode label: Decode
order: 3 order: 3
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
This processor will decode incoming bytes into a MIDI message. This processor will return an error if the message being processed is not an array of bytes. This processor will decode incoming bytes into a MIDI message. This processor will return an error if the message being processed is not an array of bytes.
- **type**: `midi.message.decode` <SchemaInfo type="processor" id="midi.message.decode"/>
### Example ### Example
@@ -4,10 +4,11 @@ sidebar:
label: Encode label: Encode
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
This processor will encode a MIDI message into an array of bytes. This processor will return an error if the message being processed is not a MIDI message. This processor will encode a MIDI message into an array of bytes. This processor will return an error if the message being processed is not a MIDI message.
- **type**: `midi.message.encode` <SchemaInfo type="processor" id="midi.message.encode"/>
### Example ### Example
@@ -4,10 +4,11 @@ sidebar:
label: Unpack label: Unpack
order: 4 order: 4
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
This processor will unpack a MIDI message into its individual components. This processor will return an error if the message being processed is not a MIDI message. This processor will unpack a MIDI message into its individual components. This processor will return an error if the message being processed is not a MIDI message.
- **type**: `midi.message.unpack` <SchemaInfo type="processor" id="midi.message.unpack"/>
### Example ### Example
@@ -1,22 +1,19 @@
--- ---
title: Create MIDI Note On title: Create MIDI Note Off
sidebar: sidebar:
label: Create label: Create
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
This processor will create a MIDI Note On message with the specified channel, note, and velocity. This processor will create a MIDI Note Off message with the specified channel, note, and velocity.
- **type**: `midi.note_on.create` <SchemaInfo type="processor" id="midi.note_off.create"/>
- **params**:
- **channel**: the MIDI channel
- **note**: the note number
- **velocity**: the velocity
### Example ### Example
```yaml ```yaml
- type: midi.note_on.create - type: midi.note_off.create
params: params:
channel: "1" channel: "1"
note: "60" note: "60"
@@ -1,22 +1,19 @@
--- ---
title: Create MIDI Note Off title: Create MIDI Note On
sidebar: sidebar:
label: Create label: Create
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
This processor will create a MIDI Note Off message with the specified channel, note, and velocity. This processor will create a MIDI Note On message with the specified channel, note, and velocity.
- **type**: `midi.note_off.create` <SchemaInfo type="processor" id="midi.note_on.create"/>
- **params**:
- **channel**: the MIDI channel
- **note**: the note number
- **velocity**: the velocity
### Example ### Example
```yaml ```yaml
- type: midi.note_off.create - type: midi.note_on.create
params: params:
channel: "1" channel: "1"
note: "60" note: "60"
@@ -4,13 +4,11 @@ sidebar:
label: Create label: Create
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
This processor will create a MIDI Program Change message with the specified channel and program number. This processor will create a MIDI Program Change message with the specified channel and program number.
- **type**: `midi.program_change.create` <SchemaInfo type="processor" id="midi.program_change.create"/>
- **params**:
- **channel**: the MIDI channel
- **program**: the program number
### Example ### Example
@@ -4,12 +4,11 @@ sidebar:
label: Output label: Output
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `module.output` processor takes any payload and outputs to the specified module. The `module.output` processor takes any payload and outputs to the specified module.
- **type**: `module.output` <SchemaInfo type="processor" id="module.output"/>
- **params**:
- **module**: the id of the [module](/concepts/modules) to output to.
### Example ### Example
@@ -4,14 +4,11 @@ sidebar:
label: Create label: Create
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
This processor will create an OSC message from the provided parameters. This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type. The address parameter is required, while the args and types parameters are optional. However, if args are provided, then types must also be provided and must match the amount of args provided. This processor will create an OSC message from the provided parameters. This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type. The address parameter is required, while the args and types parameters are optional. However, if args are provided, then types must also be provided and must match the amount of args provided.
- **type**: `osc.message.create` <SchemaInfo type="processor" id="osc.message.create"/>
- **params**:
- **address**: the address of the OSC message.
- **args**: (optional) array of string templates for each argument.
- **types**: (optional) a single string with the of each arg in order. This is required if args are provided.
### Example ### Example
@@ -4,10 +4,11 @@ sidebar:
label: Decode label: Decode
order: 3 order: 3
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
The `osc.message.decode` processor takes a array of bytes and turn it into OSC message if it can be. This processor will return an error if the bytes cannot be parsed as an OSC message The `osc.message.decode` processor takes a array of bytes and turn it into OSC message if it can be. This processor will return an error if the bytes cannot be parsed as an OSC message
- **type**: `osc.message.decode` <SchemaInfo type="processor" id="osc.message.decode"/>
### Example ### Example
@@ -4,10 +4,11 @@ sidebar:
label: Encode label: Encode
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
The `osc.message.encode` processor takes an OSC message and turns it into an array of bytes. This processor will return an error if the OSC message cannot be turned into bytes. The `osc.message.encode` processor takes an OSC message and turns it into an array of bytes. This processor will return an error if the OSC message cannot be turned into bytes.
- **type**: `osc.message.encode` <SchemaInfo type="processor" id="osc.message.encode"/>
### Example ### Example
@@ -4,13 +4,13 @@ sidebar:
label: Publish label: Publish
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
This processor will publish the incoming payload to a Pub/Sub capable module. This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type. This processor will publish the incoming payload to a module that implements the `PubSubModule` interface.
This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type.
The payload is unchanged so whatever is received by this payload is output unless any errors are encountered.
- **type**: `pubsub.publish` <SchemaInfo type="processor" id="pubsub.publish"/>
- **params**:
- **module**: the module to publish with.
- **topic**: the subject to publish to.
### Example ### Example
+2 -3
View File
@@ -4,12 +4,11 @@ sidebar:
label: Expr label: Expr
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The processor will execute the provided Expr expression and return the result as the new payload. This processor will return an error if the expression cannot be executed or if there is an error during execution. The expression will have access to the [wrapped payload](/concepts/payloads). The processor will execute the provided Expr expression and return the result as the new payload. This processor will return an error if the expression cannot be executed or if there is an error during execution. The expression will have access to the [wrapped payload](/concepts/payloads).
- **type**: `script.expr` <SchemaInfo type="processor" id="script.expr"/>
- **params**:
- **expression**: the Expr expressiont to execute.
### Example ### Example
+2 -3
View File
@@ -4,6 +4,7 @@ sidebar:
label: JavaScript label: JavaScript
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `script.js` processor takes in any payload type and executes a JavaScript function that is able to process the payload. The end value of `payload` will be returned as the output of the processor. The `script.js` processor takes in any payload type and executes a JavaScript function that is able to process the payload. The end value of `payload` will be returned as the output of the processor.
@@ -11,9 +12,7 @@ Ending with a `payload` value of `undefined` is treated the same as any other pr
This run your JavaScript program in a [sandboxed environment](https://gitlab.com/cznic/quickjs). It currently support the [ES2023](https://tc39.es/ecma262/2023/) specification. This run your JavaScript program in a [sandboxed environment](https://gitlab.com/cznic/quickjs). It currently support the [ES2023](https://tc39.es/ecma262/2023/) specification.
- **type**: `script.js` <SchemaInfo type="processor" id="script.js"/>
- **params**:
- **program**: The JavaScript program to run. The payload is available as a global variable called `payload`.
### Example ### Example
+2 -5
View File
@@ -4,14 +4,11 @@ sidebar:
label: WASM label: WASM
order: 3 order: 3
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
This processor will load and execute a WASM plugin using the [Extism](https://extism.org/) runtime. The processor will execute the specified function in the WASM plugin and return the result as the new payload. This processor will return an error if the plugin cannot be loaded, if the function cannot be executed, or if there is an error during execution. The incoming payload will be passed as the argument to the WASM function. If the plugin is successfully executed, the result of the function will be returned as the new payload. This processor will load and execute a WASM plugin using the [Extism](https://extism.org/) runtime. The processor will execute the specified function in the WASM plugin and return the result as the new payload. This processor will return an error if the plugin cannot be loaded, if the function cannot be executed, or if there is an error during execution. The incoming payload will be passed as the argument to the WASM function. If the plugin is successfully executed, the result of the function will be returned as the new payload.
- **type**: `script.wasm` <SchemaInfo type="processor" id="script.wasm"/>
- **params**:
- **path**: the path to the WASM plugin to load.
- **function**: (optional) the function to execute in the WASM plugin defaults to `process`
- **enableWasi**: (optional) whether to enable WASI for the plugin defaults to `false`
### Example ### Example
@@ -4,14 +4,11 @@ sidebar:
label: Create label: Create
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../../../components/SchemaInfo.astro';
This processor will create a SIP response message with an audio file as the payload. If this message is output to a SIP module using the [module.output](/processors/module/output) processor, then the SIP module will send the response to the caller and play the audio file included in the response. This processor will create a SIP response message with an audio file as the payload. If this message is output to a SIP module using the [module.output](/processors/module/output) processor, then the SIP module will send the response to the caller and play the audio file included in the response.
- **type**: `sip.response.audio.create` <SchemaInfo type="processor" id="sip.response.audio.create"/>
- **params**:
- **preWait**: the amount of time in milliseconds to wait before sending the response
- **audioFile**: the path to the audio file to include in the response
- **postWait**: the amount of time in milliseconds to wait after sending the response
### Example ### Example
@@ -4,14 +4,11 @@ sidebar:
label: Create label: Create
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../../../components/SchemaInfo.astro';
This processor will create a SIP DTMF response from the provided parameters. If this message is output to a SIP module using the [module.output](/processors/module/output) processor, then the SIP module will send the response to the caller and play the DTMF tones specified. This processor will create a SIP DTMF response from the provided parameters. If this message is output to a SIP module using the [module.output](/processors/module/output) processor, then the SIP module will send the response to the caller and play the DTMF tones specified.
- **type**: `sip.response.dtmf.create` <SchemaInfo type="processor" id="sip.response.dtmf.create"/>
- **params**:
- **preWait**: the amount of time in milliseconds to wait before sending the response
- **digits**: the DTMF digits to include in the response
- **postWait**: the amount of time in milliseconds to wait after sending the response
### Example ### Example
@@ -4,12 +4,11 @@ sidebar:
label: Create label: Create
order: 3 order: 3
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `string.create` processor creates a string based on the provided template. This processor will return an error if there is an issue executing the template. The template property is just a [Go template](https://pkg.go.dev/text/template) that will be evaluated with the incoming message provided as an environment. The `string.create` processor creates a string based on the provided template. This processor will return an error if there is an issue executing the template. The template property is just a [Go template](https://pkg.go.dev/text/template) that will be evaluated with the incoming message provided as an environment.
- **type**: `string.create` <SchemaInfo type="processor" id="string.create"/>
- **params**:
- **template**: string template that will have the incoming message as the context
### Example ### Example
@@ -4,10 +4,11 @@ sidebar:
label: Decode label: Decode
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `string.decode` processor takes a array of bytes and turn it into string. This processor will return an error if the message being processed is not an array of bytes. The `string.decode` processor takes a array of bytes and turn it into string. This processor will return an error if the message being processed is not an array of bytes.
- **type**: `string.decode` <SchemaInfo type="processor" id="string.decode"/>
### Example ### Example
@@ -4,10 +4,11 @@ sidebar:
label: Encode label: Encode
order: 2 order: 2
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `string.encode` processor takes a string and turns it into an array of bytes. This processor will return an error if the message being processed is not a string. The `string.encode` processor takes a string and turns it into an array of bytes. This processor will return an error if the message being processed is not a string.
- **type**: `string.encode` <SchemaInfo type="processor" id="string.encode"/>
### Example ### Example
+2 -3
View File
@@ -4,12 +4,11 @@ sidebar:
label: Split label: Split
order: 5 order: 5
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `string.split` processor takes a string and turns it into an array of strings by splitting on `params.separator`. This processor will return an error if the message being processed is not a string. The `string.split` processor takes a string and turns it into an array of strings by splitting on `params.separator`. This processor will return an error if the message being processed is not a string.
- **type**: `string.split` <SchemaInfo type="processor" id="string.split"/>
- **params**:
- **pattern**: string to split incoming string on
### Example ### Example
+2 -3
View File
@@ -4,12 +4,11 @@ sidebar:
label: Sleep label: Sleep
order: 1 order: 1
--- ---
import SchemaInfo from '../../../../components/SchemaInfo.astro';
The `time.sleep` processor will sleep for the specified `duration` in milliseconds before passing the message to the next processor. The `time.sleep` processor will sleep for the specified `duration` in milliseconds before passing the message to the next processor.
- **type**: `time.sleep` <SchemaInfo type="processor" id="time.sleep"/>
- **params**:
- **duration**: the duration to sleep in milliseconds
### Example ### Example
+625
View File
@@ -0,0 +1,625 @@
{
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"port": {
"type": "string",
"title": "Port",
"description": "the name of the MIDI port to send messages to"
}
},
"required": ["port"],
"additionalProperties": false
},
"type": { "const": "midi.output" }
},
"$id": "midi.output",
"title": "MIDI Output",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"broker": {
"type": "string",
"title": "Broker URL",
"description": "the URL of the MQTT broker to connect to"
},
"clientId": {
"type": "string",
"title": "Client ID",
"description": "the client ID to use when connecting to the MQTT broker"
},
"qos": {
"type": "integer",
"title": "QoS",
"description": "the QoS level to use when publishing messages",
"default": 0,
"minimum": 0,
"maximum": 2
},
"retained": {
"type": "boolean",
"title": "Retained",
"description": "whether to set the retained flag when publishing messages",
"default": false
},
"topic": {
"type": "string",
"title": "Topic",
"description": "an MQTT topic to subscribe to"
}
},
"required": ["broker", "topic", "clientId"],
"additionalProperties": false
},
"type": { "const": "mqtt.client" }
},
"$id": "mqtt.client",
"title": "MQTT Client",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"title": "IP",
"description": "the IP address to bind the NATS server to",
"default": "0.0.0.0"
},
"port": {
"type": "integer",
"title": "Port",
"description": "the port for the NATS server to listen on",
"default": 4222,
"minimum": 1024,
"maximum": 65535
}
},
"additionalProperties": false
},
"type": { "const": "nats.server" }
},
"$id": "nats.server",
"title": "NATS Server",
"required": ["id", "type"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"framing": {
"type": "string",
"title": "Framing Method",
"description": "the method used to frame messages over the TCP connection",
"enum": ["LF", "CR", "CRLF", "SLIP", "RAW"]
},
"host": {
"type": "string",
"title": "Host",
"description": "the hostname or IP address of the TCP server to connect to"
},
"port": {
"type": "integer",
"title": "Port",
"description": "the port of the TCP server to connect to",
"minimum": 1,
"maximum": 65535
}
},
"required": ["host", "port", "framing"],
"additionalProperties": false
},
"type": { "const": "net.tcp.client" }
},
"$id": "net.tcp.client",
"title": "TCP Client",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"title": "Duration",
"description": "time in milliseconds between emitted events"
}
},
"required": ["duration"],
"additionalProperties": false
},
"type": { "const": "time.interval" }
},
"$id": "time.interval",
"title": "Interval",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"host": {
"type": "string",
"title": "Host",
"description": "the hostname or IP address of the UDP server to connect to"
},
"port": {
"type": "integer",
"title": "Port",
"description": "the port of the UDP server to connect to",
"minimum": 1,
"maximum": 65535
}
},
"required": ["host", "port"],
"additionalProperties": false
},
"type": { "const": "net.udp.client" }
},
"$id": "net.udp.client",
"title": "UDP Client",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"bufferSize": {
"type": "integer",
"title": "Buffer Size",
"description": "the size of the buffer for incoming UDP messages",
"default": 2048,
"minimum": 1,
"maximum": 65535
},
"ip": {
"type": "string",
"title": "IP",
"description": "the IP address to bind the UDP server to",
"default": "0.0.0.0"
},
"port": {
"type": "integer",
"title": "Port",
"description": "the port for the UDP server to listen on",
"minimum": 1024,
"maximum": 65535
}
},
"required": ["port"],
"additionalProperties": false
},
"type": { "const": "net.udp.server" }
},
"$id": "net.udp.server",
"title": "UDP Server",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"title": "Subject",
"description": "the subject to subscribe to"
},
"url": {
"type": "string",
"title": "NATS Server URL",
"description": "the URL of the NATS server to connect to"
}
},
"required": ["url", "subject"],
"additionalProperties": false
},
"type": { "const": "nats.client" }
},
"$id": "nats.client",
"title": "NATS Client",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"host": {
"type": "string",
"title": "Host",
"description": "the hostname or IP address of the Redis server to connect to"
},
"port": {
"type": "integer",
"title": "Port",
"description": "the port to use when connecting to the Redis server",
"minimum": 1,
"maximum": 65535
}
},
"required": ["host", "port"],
"additionalProperties": false
},
"type": { "const": "redis.client" }
},
"$id": "redis.client",
"title": "Redis Client",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"title": "IP",
"description": "the IP address to bind the SIP server to",
"default": "0.0.0.0"
},
"port": {
"type": "integer",
"title": "Port",
"description": "the port for the SIP server to listen on",
"default": 5060,
"minimum": 1024,
"maximum": 65535
},
"transport": {
"type": "string",
"title": "Transport",
"description": "the transport protocol to use for the SIP server",
"default": "udp",
"enum": ["udp", "tcp", "ws", "udp4", "tcp4"]
},
"userAgent": {
"type": "string",
"title": "User Agent",
"description": "the user agent string to use",
"default": "showbridge"
}
},
"additionalProperties": false
},
"type": { "const": "sip.call.server" }
},
"$id": "sip.call.server",
"title": "SIP Call Server",
"required": ["id", "type"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"framing": {
"type": "string",
"title": "Framing Method",
"description": "the method used to frame messages over the TCP connection",
"enum": ["LF", "CR", "CRLF", "SLIP", "RAW"]
},
"ip": {
"type": "string",
"title": "IP",
"description": "the IP address to bind the TCP server to",
"default": "0.0.0.0"
},
"port": {
"type": "integer",
"title": "Port",
"description": "the port for the TCP server to listen on",
"minimum": 1024,
"maximum": 65535
}
},
"required": ["port", "framing"],
"additionalProperties": false
},
"type": { "const": "net.tcp.server" }
},
"$id": "net.tcp.server",
"title": "TCP Server",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"url": {
"type": "string",
"title": "URL",
"description": "the URL of the WebSocket server to connect"
}
},
"required": ["url"],
"additionalProperties": false
},
"type": { "const": "websocket.client" }
},
"$id": "websocket.client",
"title": "WebSocket Client",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"port": {
"type": "string",
"title": "Port",
"description": "the name of the MIDI port to listen to"
}
},
"required": ["port"],
"additionalProperties": false
},
"type": { "const": "midi.input" }
},
"$id": "midi.input",
"title": "MIDI Input",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"type": { "const": "psn.client" }
},
"$id": "psn.client",
"title": "PosiStageNet Client",
"required": ["id", "type"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"baudRate": {
"type": "integer",
"title": "Baud Rate",
"description": "the baud rate to use when connecting to the serial port"
},
"framing": {
"type": "string",
"title": "Framing Method",
"description": "the method to use for framing messages on the serial port",
"enum": ["LF", "CR", "CRLF", "SLIP", "RAW"]
},
"port": {
"type": "string",
"title": "Port",
"description": "the name of the serial port to connect to"
}
},
"required": ["port", "baudRate", "framing"],
"additionalProperties": false
},
"type": { "const": "serial.client" }
},
"$id": "serial.client",
"title": "Serial Client",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"title": "Duration",
"description": "time in milliseconds before the timer fires"
}
},
"required": ["duration"],
"additionalProperties": false
},
"type": { "const": "time.timer" }
},
"$id": "time.timer",
"title": "Timer",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"port": {
"type": "integer",
"title": "Port",
"description": "the port for the HTTP server to listen on",
"minimum": 1024,
"maximum": 65535
}
},
"required": ["port"],
"additionalProperties": false
},
"type": { "const": "http.server" }
},
"$id": "http.server",
"title": "HTTP Server",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"title": "IP",
"description": "the IP address to bind the SIP server to",
"default": "0.0.0.0"
},
"port": {
"type": "integer",
"title": "Port",
"description": "the port for the SIP server to listen on",
"default": 5060,
"minimum": 1024,
"maximum": 65535
},
"separator": {
"type": "string",
"title": "DTMF Separator",
"description": "the DTMF character to use as a separator between DTMF digit groups",
"minLength": 1,
"maxLength": 1
},
"transport": {
"type": "string",
"title": "Transport",
"description": "the transport protocol to use for the SIP server",
"default": "udp",
"enum": ["udp", "tcp", "ws", "udp4", "tcp4"]
},
"userAgent": {
"type": "string",
"title": "User Agent",
"description": "the user agent string to use",
"default": "showbridge"
}
},
"required": ["separator"],
"additionalProperties": false
},
"type": { "const": "sip.dtmf.server" }
},
"$id": "sip.dtmf.server",
"title": "SIP DTMF Server",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"title": "IP",
"description": "the multicast address to listen on"
},
"port": {
"type": "integer",
"title": "Port",
"description": "the port to listen on",
"minimum": 1024,
"maximum": 65535
}
},
"required": ["ip", "port"],
"additionalProperties": false
},
"type": { "const": "net.udp.multicast" }
},
"$id": "net.udp.multicast",
"title": "UDP Multicast",
"required": ["id", "type", "params"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": { "type": "string", "minLength": 1 },
"params": {
"type": "object",
"properties": {
"dsn": {
"type": "string",
"title": "Data Source Name",
"description": "the data source name (DSN) for the SQLite database",
"minLength": 1
}
},
"required": ["dsn"],
"additionalProperties": false
},
"type": { "const": "db.sqlite" }
},
"$id": "db.sqlite",
"title": "SQLite Database",
"required": ["id", "type", "params"],
"additionalProperties": false
}
]
},
"$id": "https://showbridge.io/modules.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Modules",
"description": "module configurations",
"default": []
}
File diff suppressed because it is too large Load Diff