@absolutejs/sync-pack-comments 0.4.1 → 0.4.3

package/dist/manifest.json

@@ -0,0 +1,100 @@
+{
+	"contract": 1,
+	"identity": {
+		"accent": "#f59e0b",
+		"category": "sync",
+		"description": "Threaded comments pack for `@absolutejs/sync` — one `engine.registerPack(createCommentsPack(...))` adds per-resource comment threads with author/moderator delete gates, the host’s own ACL injected via `canReadResource`, optional emoji reactions, optional live full-text search over bodies, an optional author-join collection, and optional CRDT comment bodies (concurrent edits merge instead of clobbering).",
+		"docsUrl": "https://github.com/absolutejs/sync-packs/tree/main/comments",
+		"name": "@absolutejs/sync-pack-comments",
+		"tagline": "Let people comment on anything — threads, live."
+	},
+	"settings": {
+		"type": "object",
+		"properties": {
+			"maxDepth": {
+				"description": "How deep reply threads can nest (top level is 0). Default 8.",
+				"minimum": 0,
+				"title": "Reply depth limit",
+				"type": "integer"
+			},
+			"prefix": {
+				"description": "Name prefix for the pack’s tables, collections, and mutations — set one when running several comments packs on the same engine.",
+				"title": "Name prefix",
+				"type": "string"
+			},
+			"reactions": {
+				"description": "Turn on emoji reactions: one tap per person per emoji per comment, live counts.",
+				"title": "Reactions",
+				"type": "object",
+				"properties": {
+					"allowedEmojis": {
+						"description": "Which emojis people can react with. Leave empty to allow any.",
+						"title": "Allowed emojis",
+						"type": "array",
+						"items": {
+							"type": "string"
+						}
+					}
+				}
+			},
+			"search": {
+				"description": "Turn on live full-text search over comment bodies — results re-rank as comments change.",
+				"title": "Comment search",
+				"type": "object",
+				"properties": {
+					"topK": {
+						"description": "How many best-matching comments a search returns.",
+						"minimum": 1,
+						"title": "Results per search",
+						"type": "integer"
+					}
+				}
+			}
+		}
+	},
+	"slots": {
+		"bodyCrdt": {
+			"configPath": "bodyCrdt",
+			"contract": "sync/crdt-adapter",
+			"description": "Optional: merge simultaneous edits to a comment body instead of overwriting",
+			"known": [
+				"@absolutejs/sync#rga-text",
+				"@absolutejs/sync-yjs",
+				"@absolutejs/sync-automerge",
+				"@absolutejs/sync-loro"
+			]
+		}
+	},
+	"wiring": [
+		{
+			"description": "Rides @absolutejs/sync’s engine recipe: `engine` is its module-scope binding. The host’s ACL gates every read — the pack never duplicates it.",
+			"id": "default",
+			"server": {
+				"code": "engine.registerPack(createCommentsPack({\n\tbodyCrdt: ${slot.bodyCrdt},\n\t// TODO: your ACL — who can read comments on this resource?\n\tcanReadResource: (resourceId, ctx) => true,\n\t// getActorId defaults to (ctx) => ctx.userId; add canModerate for\n\t// admin deletes and joinUsers for a comments-with-author collection.\n\t...${settings}\n}));",
+				"imports": [
+					{
+						"from": "@absolutejs/sync-pack-comments",
+						"names": [
+							"createCommentsPack"
+						]
+					}
+				],
+				"placement": "module-scope"
+			},
+			"title": "Register threaded comments on the sync engine"
+		}
+	],
+	"tools": {
+		"pack_surface": {
+			"annotations": {
+				"readOnlyHint": true
+			},
+			"description": "What this comments pack adds to the sync engine: owned tables, read tables (author join), collections (including search/join), and mutations.",
+			"input": {
+				"type": "object",
+				"properties": {}
+			},
+			"kind": "runtime"
+		}
+	}
+}

package/package.json

@@ -1,12 +1,16 @@
 {
 	"name": "@absolutejs/sync-pack-comments",
-	"version": "0.4.1",
+	"version": "0.4.3",
 	"description": "Threaded comments pack for @absolutejs/sync — per-resource ACL-scoped, author/moderator gates, optional CRDT bodies",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/absolutejs/sync-packs.git",
 		"directory": "comments"
 	},
+	"homepage": "https://github.com/absolutejs/sync-packs/tree/main/comments",
+	"bugs": {
+		"url": "https://github.com/absolutejs/sync-packs/issues"
+	},
 	"main": "./dist/index.js",
 	"module": "./dist/index.js",
 	"types": "./dist/index.d.ts",
@@ -25,7 +29,7 @@
 		"collaboration"
 	],
 	"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}\"",
@@ -45,7 +49,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
 	},
-	"files": ["dist", "README.md"]
+	"dependencies": {
+		"@absolutejs/manifest": "^0.1.0",
+		"@sinclair/typebox": "^0.34.0"
+	}
 }