@hypercerts-org/lexicon 0.9.0-beta.0 → 0.10.0-beta.1

package/lexicons/org/hypercerts/claim/evaluation.json

@@ -2,34 +2,65 @@
   "lexicon": 1,
   "id": "org.hypercerts.claim.evaluation",
   "defs": {
+    "score": {
+      "type": "object",
+      "description": "Overall score for an evaluation on a numeric scale.",
+      "required": ["min", "max", "value"],
+      "properties": {
+        "min": {
+          "type": "integer",
+          "description": "Minimum value of the scale, e.g. 0 or 1."
+        },
+        "max": {
+          "type": "integer",
+          "description": "Maximum value of the scale, e.g. 5 or 10."
+        },
+        "value": {
+          "type": "integer",
+          "description": "Score within the inclusive range [min, max]."
+        }
+      }
+    },
     "main": {
       "type": "record",
-      "description": "An evaluation of a hypercert or other claim",
+      "description": "An evaluation of a hypercert record (e.g. an activity and its impact).",
       "key": "tid",
       "record": {
         "type": "object",
-        "required": ["subject", "evaluators", "summary", "createdAt"],
+        "required": ["evaluators", "summary", "createdAt"],
         "properties": {
           "subject": {
             "type": "ref",
             "ref": "com.atproto.repo.strongRef",
-            "description": "A strong reference to the evaluated claim. (e.g measurement, hypercert, contribution, etc)"
+            "description": "A strong reference to what is being evaluated. (e.g activity, measurement, contribution, etc.)"
           },
           "evaluators": {
             "type": "array",
             "description": "DIDs of the evaluators",
             "items": {
-              "type": "string",
-              "format": "did"
+              "type": "ref",
+              "ref": "app.certified.defs#did"
             },
-            "maxLength": 100
+            "maxLength": 1000
           },
-          "evaluations": {
+          "content": {
             "type": "array",
             "description": "Evaluation data (URIs or blobs) containing detailed reports or methodology",
             "items": {
               "type": "union",
-              "refs": ["app.certified.defs#uri", "app.certified.defs#smallBlob"]
+              "refs": [
+                "org.hypercerts.defs#uri",
+                "org.hypercerts.defs#smallBlob"
+              ]
+            },
+            "maxLength": 100
+          },
+          "measurements": {
+            "type": "array",
+            "description": "Optional references to the measurements that contributed to this evaluation. The record(s) referenced must conform with the lexicon org.hypercerts.claim.measurement ",
+            "items": {
+              "type": "ref",
+              "ref": "com.atproto.repo.strongRef"
             },
             "maxLength": 100
           },
@@ -39,6 +70,16 @@
             "maxLength": 5000,
             "maxGraphemes": 1000
           },
+          "score": {
+            "type": "ref",
+            "ref": "#score",
+            "description": "Optional overall score for this evaluation on a numeric scale."
+          },
+          "location": {
+            "type": "ref",
+            "ref": "com.atproto.repo.strongRef",
+            "description": "An optional reference for georeferenced evaluations. The record referenced must conform with the lexicon app.certified.location."
+          },
           "createdAt": {
             "type": "string",
             "format": "datetime",
@@ -48,4 +89,4 @@
       }
     }
   }
-}
+}

package/lexicons/org/hypercerts/claim/evidence.json

@@ -4,41 +4,54 @@
   "defs": {
     "main": {
       "type": "record",
-      "description": "A piece of evidence supporting a hypercert claim",
-      "key": "any",
+      "description": "A piece of evidence related to a hypercert record (e.g. an activity, project, claim, or evaluation). Evidence may support, clarify, or challenge the referenced subject.",
+      "key": "tid",
       "record": {
         "type": "object",
-        "required": ["content", "shortDescription", "createdAt"],
+        "required": ["content", "title", "createdAt"],
         "properties": {
+          "subject": {
+            "type": "ref",
+            "ref": "com.atproto.repo.strongRef",
+            "description": "A strong reference to the record this evidence relates to (e.g. an activity, project, claim, or evaluation)."
+          },
           "content": {
             "type": "union",
-            "refs": ["app.certified.defs#uri", "app.certified.defs#smallBlob"],
-            "description": "A piece of evidence (URI or blobs) supporting a hypercert claim"
+            "refs": [
+              "org.hypercerts.defs#uri",
+              "org.hypercerts.defs#smallBlob"
+            ],
+            "description": "A piece of evidence (URI or blob) related to the subject record; it may support, clarify, or challenge a hypercert claim."
           },
           "title": {
             "type": "string",
             "maxLength": 256,
-            "description": "Optional title to describe the nature of the evidence"
+            "description": "Title to describe the nature of the evidence."
           },
           "shortDescription": {
             "type": "string",
             "maxLength": 3000,
             "maxGraphemes": 300,
-            "description": "Short description explaining what this evidence demonstrates or proves"
+            "description": "Short description explaining what this evidence shows."
           },
           "description": {
-              "type": "string",
-              "description": "Optional longer description describing the impact claim evidence.",
-              "maxLength": 30000,
-              "maxGraphemes": 3000
+            "type": "string",
+            "description": "Longer description describing the evidence in more detail.",
+            "maxLength": 30000,
+            "maxGraphemes": 3000
+          },
+          "relationType": {
+            "type": "string",
+            "description": "How this evidence relates to the subject.",
+            "knownValues": ["supports", "challenges", "clarifies"]
           },
           "createdAt": {
-              "type": "string",
-              "format": "datetime",
-              "description": "Client-declared timestamp when this hypercert claim was originally created"
-            }
+            "type": "string",
+            "format": "datetime",
+            "description": "Client-declared timestamp when this record was originally created"
+          }
         }
       }
     }
   }
-}
+}

package/lexicons/org/hypercerts/claim/measurement.json

@@ -4,23 +4,23 @@
   "defs": {
     "main": {
       "type": "record",
-      "description": "External measurement data supporting a hypercert claim",
+      "description": "Measurement data related to a hypercert record (e.g. an activity and its impact).",
       "key": "tid",
       "record": {
         "type": "object",
-        "required": ["hypercert", "measurers", "metric", "value", "createdAt"],
+        "required": ["measurers", "metric", "value", "createdAt"],
         "properties": {
-          "hypercert": {
+          "subject": {
             "type": "ref",
             "ref": "com.atproto.repo.strongRef",
-            "description": "A strong reference to the hypercert that this measurement is for. The record referenced must conform with the lexicon org.hypercerts.claim."
+            "description": "A strong reference to the record this measurement refers to (e.g. an activity, project, or claim)."
           },
           "measurers": {
             "type": "array",
             "description": "DIDs of the entity (or entities) that measured this data",
             "items": {
-              "type": "string",
-              "format": "did"
+              "type": "ref",
+              "ref": "app.certified.defs#did"
             },
             "maxLength": 100
           },
@@ -34,20 +34,30 @@
             "description": "The measured value",
             "maxLength": 500
           },
-          "measurementMethodURI": {
+          "methodType": {
+            "type": "string",
+            "description": "Short identifier for the measurement methodology",
+            "maxLength": 30
+          },
+          "methodURI": {
             "type": "string",
             "format": "uri",
             "description": "URI to methodology documentation, standard protocol, or measurement procedure"
           },
           "evidenceURI": {
             "type": "array",
-            "description": "URIs to supporting evidence or data",
+            "description": "URIs to related evidence or underlying data (e.g. org.hypercerts.claim.evidence records or raw datasets)",
             "items": {
               "type": "string",
               "format": "uri"
             },
             "maxLength": 50
           },
+          "location": {
+            "type": "ref",
+            "ref": "com.atproto.repo.strongRef",
+            "description": "A strong reference to the location where the measurement was taken. The record referenced must conform with the lexicon app.certified.location"
+          },
           "createdAt": {
             "type": "string",
             "format": "datetime",

package/lexicons/org/hypercerts/claim/project.json

@@ -0,0 +1,64 @@
+{
+  "lexicon": 1,
+  "id": "org.hypercerts.claim.project",
+  "defs": {
+    "main": {
+      "type": "record",
+      "description": "A project that can include multiple activities, each of which may be linked to at most one project.",
+      "key": "tid",
+      "record": {
+        "type": "object",
+        "required": ["title", "shortDescription", "createdAt"],
+        "properties": {
+          "title": {
+            "type": "string",
+            "description": "Title of this project",
+            "maxLength": 800,
+            "maxGraphemes": 80
+          },
+          "shortDescription": {
+            "type": "string",
+            "maxLength": 3000,
+            "maxGraphemes": 300,
+            "description": "Short summary of this project, suitable for previews and list views."
+          },
+          "description": {
+            "type": "ref",
+            "ref": "pub.leaflet.pages.linearDocument#main",
+            "description": "Rich-text description of this project, represented as a Leaflet linear document."
+          },
+          "avatar": {
+            "type": "blob",
+            "description": "Primary avatar image representing this project across apps and views; typically a square logo or project identity image.",
+            "accept": ["image/png", "image/jpeg"],
+            "maxSize": 1000000
+          },
+          "coverPhoto": {
+            "type": "blob",
+            "description": "The cover photo of this project.",
+            "accept": ["image/png", "image/jpeg"],
+            "maxSize": 1000000
+          },
+          "activities": {
+            "type": "array",
+            "description": "Array of activities with their associated weights in this project",
+            "items": {
+              "type": "ref",
+              "ref": "org.hypercerts.claim.activity#activityWeight"
+            }
+          },
+          "location": {
+            "type": "ref",
+            "ref": "com.atproto.repo.strongRef",
+            "description": "A strong reference to a location record describing where the work for this project took place. The referenced record must conform to the app.certified.location lexicon."
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "datetime",
+            "description": "Client-declared timestamp when this record was originally created"
+          }
+        }
+      }
+    }
+  }
+}

package/lexicons/org/hypercerts/claim/rights.json

@@ -4,11 +4,16 @@
   "defs": {
     "main": {
       "type": "record",
-      "description": "Describes the rights that a user has with a hypercert, such as whether it can be sold, transferred, and under what conditions.",
-      "key": "any",
+      "description": "Describes the rights that a contributor and/or an owner has, such as whether the hypercert can be sold, transferred, and under what conditions.",
+      "key": "tid",
       "record": {
         "type": "object",
-        "required": ["rightsName", "rightsType", "rightsDescription", "createdAt"],
+        "required": [
+          "rightsName",
+          "rightsType",
+          "rightsDescription",
+          "createdAt"
+        ],
         "properties": {
           "rightsName": {
             "type": "string",
@@ -24,6 +29,14 @@
             "type": "string",
             "description": "Description of the rights of this hypercert"
           },
+          "attachment": {
+            "type": "union",
+            "refs": [
+              "org.hypercerts.defs#uri",
+              "org.hypercerts.defs#smallBlob"
+            ],
+            "description": "An attachment to define the rights further, e.g. a legal document."
+          },
           "createdAt": {
             "type": "string",
             "format": "datetime",

package/lexicons/org/hypercerts/defs.json

@@ -0,0 +1,71 @@
+{
+  "lexicon": 1,
+  "id": "org.hypercerts.defs",
+  "defs": {
+    "uri": {
+      "type": "object",
+      "required": ["uri"],
+      "description": "Object containing a URI to external data",
+      "properties": {
+        "uri": {
+          "type": "string",
+          "format": "uri",
+          "maxGraphemes": 1024,
+          "description": "URI to external data"
+        }
+      }
+    },
+    "smallBlob": {
+      "type": "object",
+      "required": ["blob"],
+      "description": "Object containing a blob to external data",
+      "properties": {
+        "blob": {
+          "type": "blob",
+          "accept": ["*/*"],
+          "maxSize": 10485760,
+          "description": "Blob to external data (up to 10MB)"
+        }
+      }
+    },
+    "largeBlob": {
+      "type": "object",
+      "required": ["blob"],
+      "description": "Object containing a blob to external data",
+      "properties": {
+        "blob": {
+          "type": "blob",
+          "accept": ["*/*"],
+          "maxSize": 104857600,
+          "description": "Blob to external data (up to 100MB)"
+        }
+      }
+    },
+    "smallImage": {
+      "type": "object",
+      "required": ["image"],
+      "description": "Object containing a small image",
+      "properties": {
+        "image": {
+          "type": "blob",
+          "accept": ["image/jpeg", "image/jpg", "image/png", "image/webp"],
+          "maxSize": 5242880,
+          "description": "Image (up to 5MB)"
+        }
+      }
+    },
+    "largeImage": {
+      "type": "object",
+      "required": ["image"],
+      "description": "Object containing a large image",
+      "properties": {
+        "image": {
+          "type": "blob",
+          "accept": ["image/jpeg", "image/jpg", "image/png", "image/webp"],
+          "maxSize": 10485760,
+          "description": "Image (up to 10MB)"
+        }
+      }
+    }
+  }
+}

package/lexicons/org/hypercerts/funding/receipt.json

@@ -0,0 +1,66 @@
+{
+  "lexicon": 1,
+  "id": "org.hypercerts.funding.receipt",
+  "defs": {
+    "main": {
+      "type": "record",
+      "description": "Records a funding receipt for a payment from one user to another user. It may be recorded by the recipient, by the sender, or by a third party. The sender may remain anonymous.",
+      "key": "tid",
+      "record": {
+        "type": "object",
+        "required": ["from", "to", "amount", "currency", "createdAt"],
+        "properties": {
+          "from": {
+            "type": "ref",
+            "ref": "app.certified.defs#did",
+            "description": "DID of the sender who transferred the funds. Leave empty if sender wants to stay anonymous."
+          },
+          "to": {
+            "type": "string",
+            "description": "The recipient of the funds. Can be identified by DID or a clear-text name."
+          },
+          "amount": {
+            "type": "string",
+            "description": "Amount of funding received."
+          },
+          "currency": {
+            "type": "string",
+            "description": "Currency of the payment (e.g. EUR, USD, ETH)."
+          },
+          "paymentRail": {
+            "type": "string",
+            "description": "How the funds were transferred (e.g. bank_transfer, credit_card, onchain, cash, check, payment_processor)."
+          },
+          "paymentNetwork": {
+            "type": "string",
+            "description": "Optional network within the payment rail (e.g. arbitrum, ethereum, sepa, visa, paypal)."
+          },
+          "transactionId": {
+            "type": "string",
+            "description": "Identifier of the underlying payment transaction (e.g. bank reference, onchain transaction hash, or processor-specific ID). Use paymentNetwork to specify the network where applicable."
+          },
+          "for": {
+            "type": "string",
+            "format": "at-uri",
+            "description": "Optional reference to the activity, project, or organization this funding relates to."
+          },
+          "notes": {
+            "type": "string",
+            "description": "Optional notes or additional context for this funding receipt.",
+            "maxLength": 500
+          },
+          "occurredAt": {
+            "type": "string",
+            "format": "datetime",
+            "description": "Timestamp when the payment occurred."
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "datetime",
+            "description": "Client-declared timestamp when this receipt record was created."
+          }
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,26 +1,27 @@
 {
   "name": "@hypercerts-org/lexicon",
-  "version": "0.9.0-beta.0",
+  "version": "0.10.0-beta.1",
   "description": "ATProto lexicon definitions and TypeScript types for the Hypercerts protocol",
   "type": "module",
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/exports.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": "./dist/exports.d.ts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs"
-    }
+    },
+    "./lexicons": {
+      "types": "./dist/lexicons.d.ts",
+      "import": "./dist/lexicons.mjs",
+      "require": "./dist/lexicons.cjs"
+    },
+    "./package.json": "./package.json"
   },
   "files": [
     "dist",
-    "lexicons",
-    "README.md"
+    "lexicons"
   ],
   "keywords": [
     "hypercerts",
@@ -28,39 +29,58 @@
     "lexicon",
     "typescript"
   ],
-  "author": "Hypercerts Foundation",
+  "author": "",
   "license": "MIT",
   "repository": {
-    "url": "https://github.com/hypercerts-org/hypercerts-sdk.git"
+    "type": "git",
+    "url": "https://github.com/hypercerts-org/hypercerts-lexicon"
   },
   "scripts": {
-    "build": "rollup -c",
-    "typecheck": "tsc --noEmit",
-    "clean": "rm -rf dist",
-    "lint": "eslint .",
-    "format": "prettier --write .",
-    "gen-api": "find ./lexicons -name '*.json' | xargs lex gen-api --yes ./src",
+    "list": "find ./lexicons -name '*.json'",
+    "check": "npm run gen-api && npm run lint && npm run typecheck && npm run build",
+    "build": "rollup -c && npm run build:types",
+    "build:types": "tsc --project tsconfig.build.json",
+    "gen-api": "find ./lexicons -name '*.json' | xargs lex gen-api --yes ./generated && ./scripts/create-shims.sh && npm run gen-index",
     "gen-md": "find ./lexicons -name '*.json' | xargs lex gen-md --yes ./lexicons.md",
-    "gen-ts": "find ./lexicons -name '*.json' | xargs lex gen-ts-obj > src/lexicons.ts",
+    "//gen-ts": "UNUSED - use gen-api instead",
+    "gen-ts": "find ./lexicons -name '*.json' | xargs lex gen-ts-obj > generated/DO-NOT-USE-lexicons.ts",
+    "gen-index": "node ./scripts/generate-exports.js",
     "lex": "lex",
-    "prepublishOnly": "pnpm run build"
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "lint": "npm run format:check && npm run eslint",
+    "eslint": "eslint generated/exports.ts",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist generated",
+    "prepublishOnly": "npm run check",
+    "changeset": "changeset",
+    "version-packages": "changeset version && npm install --package-lock-only",
+    "release": "npm run check && changeset publish"
   },
   "dependencies": {
-    "@atproto/lexicon": "^0.5.1",
+    "@atcute/leaflet": "^1.0.15",
+    "@atproto/lexicon": "^0.6.0",
     "multiformats": "^13.3.6"
   },
   "devDependencies": {
     "@atproto/lex-cli": "^0.9.5",
     "@atproto/xrpc": "^0.7.5",
+    "@changesets/changelog-github": "^0.5.2",
+    "@changesets/cli": "^2.29.8",
+    "@eslint/js": "^9.39.2",
     "@rollup/plugin-commonjs": "^29.0.0",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-typescript": "^12.3.0",
+    "eslint": "^9.39.2",
+    "globals": "^17.0.0",
+    "prettier": "^3.2.5",
     "rollup": "^4.53.3",
-    "rollup-plugin-dts": "^6.2.3"
+    "tslib": "^2.8.1",
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.51.0"
   },
   "peerDependencies": {
     "@atproto/xrpc": "*"
-  },
-  "sideEffects": false
+  }
 }