@absolutejs/sync-bus-redis 0.0.1 → 0.0.2

package/dist/manifest.json

@@ -0,0 +1,61 @@
+{
+	"contract": 1,
+	"identity": {
+		"accent": "#d82c20",
+		"category": "sync",
+		"description": "Redis pub/sub `ClusterBus` for `@absolutejs/sync` — cross-instance fan-out via PUBLISH/SUBSCRIBE. No payload cap and lower fan-out latency than the Postgres sibling, at the cost of at-most-once delivery (a disconnected subscriber misses messages — use `@absolutejs/sync-bus-pg` when you need the durable spill table). Works with any Redis client (ioredis, node-redis) through a narrow publisher/subscriber interface.",
+		"docsUrl": "https://github.com/absolutejs/sync-adapters/tree/main/redis",
+		"name": "@absolutejs/sync-bus-redis",
+		"tagline": "Scale live updates across servers with Redis."
+	},
+	"implements": [
+		{
+			"contract": "sync/cluster-bus",
+			"factory": "createRedisClusterBus",
+			"from": "@absolutejs/sync-bus-redis",
+			"requires": {
+				"env": [
+					{
+						"description": "Redis connection string the cluster bus publishes and subscribes on",
+						"example": "redis://default:pass@host:6379",
+						"key": "REDIS_URL",
+						"secret": true
+					}
+				],
+				"services": [
+					{
+						"description": "Carries change fan-out between server instances",
+						"id": "redis"
+					}
+				]
+			},
+			"settings": {
+				"type": "object",
+				"properties": {
+					"channel": {
+						"description": "Redis channel name. Two engines on the same Redis can stay separate by using different channels. Default absolutejs_sync_cluster.",
+						"title": "Channel name",
+						"type": "string"
+					}
+				}
+			},
+			"title": "Redis pub/sub (fast fan-out, at-most-once)",
+			"wiring": {
+				"code": "// TODO: create two Redis connections from ${env.REDIS_URL} with your\n// client (e.g. ioredis: `new Redis(url)` plus a `.duplicate()` for the\n// subscription) and wrap them as RedisPublisher / RedisSubscriber —\n// see the package README for ioredis and node-redis wrappers.\ncreateRedisClusterBus({ publisher: redisPublisher, subscriber: redisSubscriber, ...${settings} })",
+				"imports": [
+					{
+						"from": "@absolutejs/sync-bus-redis",
+						"names": [
+							"createRedisClusterBus"
+						]
+					}
+				]
+			}
+		}
+	],
+	"settings": {
+		"type": "object",
+		"properties": {}
+	},
+	"wiring": []
+}

package/package.json

@@ -1,12 +1,16 @@
 {
 	"name": "@absolutejs/sync-bus-redis",
-	"version": "0.0.1",
+	"version": "0.0.2",
 	"description": "Redis pub/sub ClusterBus for @absolutejs/sync — cross-instance fan-out via PUBLISH/SUBSCRIBE. Sibling to @absolutejs/sync-bus-pg; faster fanout, better geo-replication story. Works with any Redis client (ioredis, node-redis, etc.) via a narrow tag-template interface.",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/absolutejs/sync-adapters.git",
 		"directory": "redis"
 	},
+	"homepage": "https://github.com/absolutejs/sync-adapters/tree/main/redis",
+	"bugs": {
+		"url": "https://github.com/absolutejs/sync-adapters/issues"
+	},
 	"main": "./dist/index.js",
 	"module": "./dist/index.js",
 	"types": "./dist/index.d.ts",
@@ -26,7 +30,7 @@
 		"multi-region"
 	],
 	"scripts": {
-		"build": "rm -rf dist && bun build src/index.ts --outdir dist --sourcemap --target=bun --external @absolutejs/sync && tsc --project tsconfig.build.json",
+		"build": "rm -rf dist && bun build src/index.ts src/manifest.ts --outdir dist --sourcemap --target=bun --external @absolutejs/sync && tsc --project tsconfig.build.json && absolute-manifest emit",
 		"test": "bun test",
 		"typecheck": "tsc --noEmit",
 		"format": "prettier --write \"./**/*.{ts,json,md}\"",
@@ -46,10 +50,23 @@
 			"types": "./dist/index.d.ts",
 			"import": "./dist/index.js",
 			"default": "./dist/index.js"
-		}
+		},
+		"./manifest": {
+			"types": "./dist/manifest.d.ts",
+			"import": "./dist/manifest.js",
+			"default": "./dist/manifest.js"
+		},
+		"./manifest.json": "./dist/manifest.json"
 	},
 	"files": [
 		"dist",
 		"README.md"
-	]
+	],
+	"absolutejs": {
+		"manifestContract": 1
+	},
+	"dependencies": {
+		"@absolutejs/manifest": "^0.1.0",
+		"@sinclair/typebox": "^0.34.0"
+	}
 }