11 Commits

Author SHA1 Message Date
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
12 changed files with 30 additions and 70 deletions
+2 -2
View File
@@ -2,8 +2,8 @@ name: Publish to docs site
on:
workflow_dispatch:
push:
branches:
- main
tags:
- "v*"
jobs:
build-docs:
runs-on: ubuntu-latest
+8 -61
View File
@@ -1,16 +1,16 @@
{
"name": "@showbridge/docs",
"version": "0.1.2",
"version": "0.3.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@showbridge/docs",
"version": "0.1.2",
"version": "0.3.0",
"devDependencies": {
"@astrojs/check": "0.9.9",
"@astrojs/starlight": "^0.39.2",
"astro": "^6.3.1",
"astro": "^6.3.8",
"sharp": "0.34.5",
"typescript": "6.0.3"
}
@@ -2336,15 +2336,15 @@
}
},
"node_modules/astro": {
"version": "6.3.1",
"resolved": "https://registry.npmjs.org/astro/-/astro-6.3.1.tgz",
"integrity": "sha512-atz6dmkE3Gu24bDgb7g2RE/BYnKqPYIHd6hTUM1UXvu/i7qNZOKLAqEHvgYpv9PQVcgWsXpk4/OOXZ0E/FzvSQ==",
"version": "6.3.8",
"resolved": "https://registry.npmjs.org/astro/-/astro-6.3.8.tgz",
"integrity": "sha512-xH2UA8Z17IS+JaqSlSkBor7jO6gd7zXTLdmu06nKpfpDDJFbi/7KZEy3NDmWxmier+6XrCZ9Z4aitO8jhC9oiA==",
"dev": true,
"license": "MIT",
"dependencies": {
"@astrojs/compiler": "^4.0.0",
"@astrojs/internal-helpers": "0.9.0",
"@astrojs/markdown-remark": "7.1.1",
"@astrojs/internal-helpers": "0.9.1",
"@astrojs/markdown-remark": "7.1.2",
"@astrojs/telemetry": "3.3.2",
"@capsizecss/unpack": "^4.0.0",
"@clack/prompts": "^1.1.0",
@@ -2434,59 +2434,6 @@
"dev": true,
"license": "MIT"
},
"node_modules/astro/node_modules/@astrojs/internal-helpers": {
"version": "0.9.0",
"resolved": "https://registry.npmjs.org/@astrojs/internal-helpers/-/internal-helpers-0.9.0.tgz",
"integrity": "sha512-GdYkzR26re8izmyYlBqf4z2s7zNngmWLFuxw0UKiPNqHraZGS6GKWIwSHgS22RDlu2ePFJ8bzmpBcUszut/SDg==",
"dev": true,
"license": "MIT",
"dependencies": {
"picomatch": "^4.0.4"
}
},
"node_modules/astro/node_modules/@astrojs/markdown-remark": {
"version": "7.1.1",
"resolved": "https://registry.npmjs.org/@astrojs/markdown-remark/-/markdown-remark-7.1.1.tgz",
"integrity": "sha512-C6e9BnLGlbdv6bV8MYGeHpHxsUHrCrB4OuRLqi5LI7oiBVcBcqfUN06zpwFQdHgV48QCCrMmLpyqBr7VqC+swA==",
"dev": true,
"license": "MIT",
"dependencies": {
"@astrojs/internal-helpers": "0.9.0",
"@astrojs/prism": "4.0.1",
"github-slugger": "^2.0.0",
"hast-util-from-html": "^2.0.3",
"hast-util-to-text": "^4.0.2",
"js-yaml": "^4.1.1",
"mdast-util-definitions": "^6.0.0",
"rehype-raw": "^7.0.0",
"rehype-stringify": "^10.0.1",
"remark-gfm": "^4.0.1",
"remark-parse": "^11.0.0",
"remark-rehype": "^11.1.2",
"remark-smartypants": "^3.0.2",
"retext-smartypants": "^6.2.0",
"shiki": "^4.0.0",
"smol-toml": "^1.6.0",
"unified": "^11.0.5",
"unist-util-remove-position": "^5.0.0",
"unist-util-visit": "^5.1.0",
"unist-util-visit-parents": "^6.0.2",
"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": {
"version": "3.3.1",
"resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.3.1.tgz",
+2 -2
View File
@@ -1,7 +1,7 @@
{
"name": "@showbridge/docs",
"type": "module",
"version": "0.1.2",
"version": "0.3.0",
"files": [
"dist"
],
@@ -16,7 +16,7 @@
"devDependencies": {
"@astrojs/check": "0.9.9",
"@astrojs/starlight": "^0.39.2",
"astro": "^6.3.1",
"astro": "^6.3.8",
"sharp": "0.34.5",
"typescript": "6.0.3"
}
+2
View File
@@ -10,6 +10,8 @@ The `db.sqlite` module can open/create SQLite databases
- **params**:
- **dsn**: the data source name, this can be a file path or the special `:memory:` name for an in-memory DB
This module implements the `DatabaseModule` interface.
## Cap
### Example snippet
+2
View File
@@ -13,6 +13,8 @@ The `mqtt.client` module connects to a MQTT broker and emits a message messages
- **topic** mqtt topic to subscribe to
- **clientId** client ID for this connection to the broker
This module implements the `PubSubModule` interface.
### Example
Open a mqtt connection to `test.mosquitto.org` subscribing to the `showbridge` topic.
+2
View File
@@ -12,6 +12,8 @@ This module connects to a [NATS](https://nats.io/) server and subscribes to a su
- **url**: the URL of the NATS server to connect to (e.g. `nats://localhost:4222`)
- **subject**: the subject to subscribe to
This module implements the `PubSubModule` interface.
### Example
Connect to a local NATS server and subscribe to the `events` subject
@@ -12,6 +12,8 @@ The `redis.client` module connects to a Redis server. This module does not produ
- **host**: the Redis server host
- **port**: the Redis server port
This module implements the `KeyValueModule` interface.
### Example
Connect to a Redis server running on `localhost` at port `6379`.
+2
View File
@@ -6,6 +6,8 @@ sidebar:
---
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`
- **params**:
@@ -10,7 +10,7 @@ This processor will create a new HTTP response with the specified status code an
- **type**: `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
- **bodyTemplate**: the body template to set for the response
### Example
@@ -20,5 +20,5 @@ This would create an HTTP response with a status code of `200` and a body of `OK
- type: http.response.create
params:
status: 200
body: "OK"
bodyTemplate: "OK"
```
+2 -1
View File
@@ -5,7 +5,8 @@ sidebar:
order: 1
---
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`
- **params**:
+1 -1
View File
@@ -5,7 +5,7 @@ sidebar:
order: 2
---
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 associated with a key from a module that implements the `KeyValueModule` interface. The payload is unchanged so whatever is received by this payload is output unless any errors are encountered.
- **type**: `kv.set`
- **params**:
@@ -5,7 +5,9 @@ sidebar:
order: 1
---
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`
- **params**: