@satanwagen/reviewkit 0.1.0

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@satanwagen/reviewkit",
+  "version": "0.1.0",
+  "description": "Drop-in visual review & feedback layer for React sites. Reviewers annotate the live page; nothing is ever applied \u2014 changes are recorded as a portable session for a coding agent.",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "import": "./dist/client/index.js",
+      "require": "./dist/client/index.cjs"
+    },
+    "./schema": {
+      "types": "./dist/schema.d.ts",
+      "import": "./dist/schema.js",
+      "require": "./dist/schema.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "schema",
+    "README.md",
+    "LICENSE",
+    "cli/emblema-sync.mjs"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src",
+    "test": "node --test \"cli/**/*.test.mjs\"",
+    "prepublishOnly": "npm run typecheck && npm run lint && npm test && npm run build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "review",
+    "feedback",
+    "annotation",
+    "react",
+    "vite",
+    "nextjs"
+  ],
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "eslint": "^9.20.0",
+    "eslint-plugin-react-hooks": "^5.1.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "tsup": "^8.3.6",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.24.0"
+  },
+  "bin": {
+    "reviewkit-emblema": "./cli/emblema-sync.mjs"
+  }
+}

package/schema/review-session.schema.json

@@ -0,0 +1,210 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://review-kit.dev/schema/review-session.schema.json",
+  "title": "ReviewSession",
+  "description": "A review-kit feedback session: proposed changes recorded against a live site, never applied to it. Unknown fields and unknown item types are allowed everywhere (forward compatibility).",
+  "type": "object",
+  "required": ["schemaVersion", "id", "createdAt", "updatedAt", "site", "author", "items"],
+  "additionalProperties": true,
+  "properties": {
+    "schemaVersion": { "type": "number", "const": 1 },
+    "id": { "type": "string", "minLength": 1 },
+    "createdAt": { "type": "string", "format": "date-time" },
+    "updatedAt": { "type": "string", "format": "date-time" },
+    "author": { "type": "string" },
+    "site": {
+      "type": "object",
+      "required": ["origin", "route", "viewport", "userAgent"],
+      "additionalProperties": true,
+      "properties": {
+        "origin": { "type": "string" },
+        "route": { "type": "string" },
+        "viewport": {
+          "type": "object",
+          "required": ["width", "height"],
+          "additionalProperties": true,
+          "properties": {
+            "width": { "type": "number" },
+            "height": { "type": "number" }
+          }
+        },
+        "userAgent": { "type": "string" }
+      }
+    },
+    "items": {
+      "type": "array",
+      "items": { "$ref": "#/definitions/reviewItem" }
+    }
+  },
+  "definitions": {
+    "boundingBox": {
+      "type": "object",
+      "required": ["x", "y", "width", "height"],
+      "additionalProperties": true,
+      "properties": {
+        "x": { "type": "number" },
+        "y": { "type": "number" },
+        "width": { "type": "number" },
+        "height": { "type": "number" }
+      }
+    },
+    "targetAttrs": {
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "id": { "type": "string" },
+        "classList": { "type": "array", "items": { "type": "string" } },
+        "alt": { "type": "string" },
+        "src": { "type": "string" },
+        "href": { "type": "string" },
+        "ariaLabel": { "type": "string" },
+        "data": { "type": "object", "additionalProperties": { "type": "string" } }
+      }
+    },
+    "target": {
+      "type": "object",
+      "required": ["selector", "tagName", "textSnippet", "attrs", "nthOfType", "boundingBox"],
+      "additionalProperties": true,
+      "properties": {
+        "selector": { "type": "string" },
+        "tagName": { "type": "string" },
+        "textSnippet": { "type": "string", "maxLength": 160 },
+        "attrs": { "$ref": "#/definitions/targetAttrs" },
+        "nthOfType": { "type": "array", "items": { "type": "integer", "minimum": 1 } },
+        "boundingBox": { "$ref": "#/definitions/boundingBox" },
+        "sourceFile": { "type": "string" },
+        "sourceLine": { "type": "integer" },
+        "anchor": {
+          "type": "object",
+          "required": ["ox", "oy"],
+          "additionalProperties": true,
+          "description": "Fractional point inside the element's box (0..1 each axis) this item refers to — used by cursor-placed comments.",
+          "properties": { "ox": { "type": "number" }, "oy": { "type": "number" } }
+        }
+      }
+    },
+    "reviewItem": {
+      "type": "object",
+      "required": ["id", "createdAt", "type", "status", "route", "target", "priority"],
+      "additionalProperties": true,
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "createdAt": { "type": "string", "format": "date-time" },
+        "author": {
+          "type": "object",
+          "required": ["id", "name"],
+          "additionalProperties": true,
+          "description": "Who created the item (additive since the first release; older sessions may lack it).",
+          "properties": {
+            "id": { "type": "string" },
+            "name": { "type": "string" },
+            "color": { "type": "string" }
+          }
+        },
+        "type": { "type": "string", "minLength": 1 },
+        "status": { "enum": ["open", "accepted", "rejected", "applied"] },
+        "route": { "type": "string" },
+        "target": { "$ref": "#/definitions/target" },
+        "note": { "type": "string" },
+        "priority": { "enum": ["must", "nice"] },
+        "payload": {}
+      },
+      "allOf": [
+        {
+          "if": { "properties": { "type": { "const": "copy" } } },
+          "then": {
+            "properties": {
+              "payload": {
+                "type": "object",
+                "required": ["before", "after"],
+                "additionalProperties": true,
+                "properties": {
+                  "before": { "type": "string" },
+                  "after": { "type": "string" }
+                }
+              }
+            }
+          }
+        },
+        {
+          "if": { "properties": { "type": { "const": "image" } } },
+          "then": {
+            "properties": {
+              "payload": {
+                "type": "object",
+                "required": ["beforeSrc"],
+                "additionalProperties": true,
+                "properties": {
+                  "beforeSrc": { "type": "string", "description": "src of the image being replaced, at capture time." },
+                  "afterSrc": {
+                    "type": "string",
+                    "format": "uri",
+                    "description": "Replacement image by reference — an external URL that could not be (or was chosen not to be) embedded, e.g. when CORS blocks fetching or the file exceeds the embed cap. Mutually exclusive in practice with afterDataUrl."
+                  },
+                  "afterDataUrl": {
+                    "type": "string",
+                    "description": "Replacement image embedded inline as a data: URL (2 MB cap at capture)."
+                  },
+                  "description": { "type": "string" }
+                }
+              }
+            }
+          }
+        },
+        {
+          "if": { "properties": { "type": { "const": "comment" } } },
+          "then": {
+            "properties": {
+              "payload": {
+                "type": "object",
+                "required": ["text"],
+                "additionalProperties": true,
+                "properties": { "text": { "type": "string" } }
+              }
+            }
+          }
+        },
+        {
+          "if": { "properties": { "type": { "const": "delete" } } },
+          "then": {
+            "properties": {
+              "payload": {
+                "type": "object",
+                "additionalProperties": true,
+                "properties": { "reason": { "type": "string" } }
+              }
+            }
+          }
+        },
+        {
+          "if": { "properties": { "type": { "const": "move" } } },
+          "then": {
+            "properties": {
+              "payload": {
+                "type": "object",
+                "additionalProperties": true,
+                "properties": {
+                  "direction": { "enum": ["up", "down", "first", "last"] },
+                  "targetDescription": { "type": "string" }
+                }
+              }
+            }
+          }
+        },
+        {
+          "if": { "properties": { "type": { "const": "style" } } },
+          "then": {
+            "properties": {
+              "payload": {
+                "type": "object",
+                "required": ["description"],
+                "additionalProperties": true,
+                "properties": { "description": { "type": "string" } }
+              }
+            }
+          }
+        }
+      ]
+    }
+  }
+}