@hypercerts-org/lexicon 0.10.0-beta.9 → 0.11.0

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

@@ -12,11 +12,12 @@
         "properties": {
           "identifier": {
             "type": "string",
-            "description": "DID or a URI to a social profile of the contributor."
+            "description": "DID (did:plc:...) or URI to a social profile of the contributor.",
+            "maxLength": 2048
           },
           "displayName": {
             "type": "string",
-            "description": "Display name of the contributor.",
+            "description": "Human-readable name for the contributor as it should appear in UI.",
             "maxLength": 100
           },
           "image": {

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

@@ -17,17 +17,19 @@
         "properties": {
           "rightsName": {
             "type": "string",
-            "description": "Full name of the rights",
+            "description": "Human-readable name for these rights (e.g. 'All Rights Reserved', 'CC BY-SA 4.0')",
             "maxLength": 100
           },
           "rightsType": {
             "type": "string",
-            "description": "Short rights identifier for easier search",
+            "description": "Short identifier code for this rights type (e.g. 'ARR', 'CC-BY-SA') to facilitate filtering and search",
             "maxLength": 10
           },
           "rightsDescription": {
             "type": "string",
-            "description": "Description of the rights of this hypercert"
+            "description": "Detailed explanation of the rights holders' permissions, restrictions, and conditions",
+            "maxLength": 10000,
+            "maxGraphemes": 1000
           },
           "attachment": {
             "type": "union",

package/lexicons/org/hypercerts/{claim/collection.json → collection.json}

@@ -1,22 +1,24 @@
 {
   "lexicon": 1,
-  "id": "org.hypercerts.claim.collection",
+  "id": "org.hypercerts.collection",
   "defs": {
     "main": {
       "type": "record",
-      "description": "A collection/group of items (activities and/or other collections). Collections support recursive nesting. Use app.certified.location as a sidecar (same TID) for location metadata.",
+      "description": "A collection/group of items (activities and/or other collections). Collections support recursive nesting.",
       "key": "tid",
       "record": {
         "type": "object",
-        "required": ["title", "items", "createdAt"],
+        "required": ["title", "createdAt"],
         "properties": {
           "type": {
             "type": "string",
-            "description": "The type of this collection. Possible fields can be 'favorites', 'project', or any other type of collection."
+            "description": "The type of this collection. Values beyond the known set are permitted.",
+            "knownValues": ["favorites", "project", "portfolio", "program"],
+            "maxLength": 64
           },
           "title": {
             "type": "string",
-            "description": "The title of this collection",
+            "description": "Display name for this collection (e.g. 'Q1 2025 Impact Projects')",
             "maxLength": 800,
             "maxGraphemes": 80
           },
@@ -24,12 +26,24 @@
             "type": "string",
             "maxLength": 3000,
             "maxGraphemes": 300,
-            "description": "Short summary of this collection, suitable for previews and list views"
+            "description": "Short summary of this collection, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`."
+          },
+          "shortDescriptionFacets": {
+            "type": "array",
+            "description": "Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc).",
+            "items": {
+              "type": "ref",
+              "ref": "app.bsky.richtext.facet"
+            }
           },
           "description": {
-            "type": "ref",
-            "ref": "pub.leaflet.pages.linearDocument#main",
-            "description": "Rich-text description, represented as a Leaflet linear document."
+            "type": "union",
+            "refs": [
+              "org.hypercerts.defs#descriptionString",
+              "pub.leaflet.pages.linearDocument",
+              "com.atproto.repo.strongRef"
+            ],
+            "description": "Long-form description of the collection. An inline string for plain text or markdown, a Leaflet linear document for rich-text content, or a strong reference to an external description record."
           },
           "avatar": {
             "type": "union",
@@ -50,11 +64,17 @@
           "items": {
             "type": "array",
             "description": "Array of items in this collection with optional weights.",
+            "maxLength": 1000,
             "items": {
               "type": "ref",
               "ref": "#item"
             }
           },
+          "location": {
+            "type": "ref",
+            "ref": "com.atproto.repo.strongRef",
+            "description": "A strong reference to the location where this collection's activities were performed. The record referenced must conform with the lexicon app.certified.location."
+          },
           "createdAt": {
             "type": "string",
             "format": "datetime",
@@ -65,16 +85,18 @@
     },
     "item": {
       "type": "object",
+      "description": "An item in a collection, with an identifier and optional weight.",
       "required": ["itemIdentifier"],
       "properties": {
         "itemIdentifier": {
           "type": "ref",
           "ref": "com.atproto.repo.strongRef",
-          "description": "Strong reference to an item in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.claim.collection)."
+          "description": "Strong reference to an item in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.collection)."
         },
         "itemWeight": {
           "type": "string",
-          "description": "Optional weight for this item (positive numeric value stored as string). Weights do not need to sum to a specific total; normalization can be performed by the consuming application as needed."
+          "description": "Optional weight for this item (positive numeric value stored as string). Weights do not need to sum to a specific total; normalization can be performed by the consuming application as needed.",
+          "maxLength": 100
         }
       }
     }

package/lexicons/org/hypercerts/context/acknowledgement.json

@@ -0,0 +1,42 @@
+{
+  "lexicon": 1,
+  "id": "org.hypercerts.context.acknowledgement",
+  "defs": {
+    "main": {
+      "type": "record",
+      "description": "Acknowledges a record (subject) or its relationship in a context. Created in the acknowledging actor's repo to form a bidirectional link. Examples: a contributor acknowledging inclusion in an activity, an activity owner acknowledging inclusion in a collection, or a record owner acknowledging an evaluation.",
+      "key": "tid",
+      "record": {
+        "type": "object",
+        "required": ["subject", "acknowledged", "createdAt"],
+        "properties": {
+          "subject": {
+            "type": "ref",
+            "ref": "com.atproto.repo.strongRef",
+            "description": "The record being acknowledged (e.g. an activity, a contributor information record, an evaluation)."
+          },
+          "context": {
+            "type": "union",
+            "refs": ["org.hypercerts.defs#uri", "com.atproto.repo.strongRef"],
+            "description": "Context for the acknowledgement (e.g. the collection that includes an activity, or the activity that includes a contributor). A URI for a lightweight reference or a strong reference for content-hash verification."
+          },
+          "acknowledged": {
+            "type": "boolean",
+            "description": "Whether the relationship is acknowledged (true) or rejected (false)."
+          },
+          "comment": {
+            "type": "string",
+            "description": "Optional plain-text comment providing additional context or reasoning.",
+            "maxLength": 10000,
+            "maxGraphemes": 1000
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "datetime",
+            "description": "Client-declared timestamp when this record was originally created."
+          }
+        }
+      }
+    }
+  }
+}

package/lexicons/org/hypercerts/context/attachment.json

@@ -0,0 +1,88 @@
+{
+  "lexicon": 1,
+  "id": "org.hypercerts.context.attachment",
+  "defs": {
+    "main": {
+      "type": "record",
+      "description": "An attachment providing commentary, context, evidence, or documentary material related to a hypercert record (e.g. an activity, project, claim, or evaluation).",
+      "key": "tid",
+      "record": {
+        "type": "object",
+        "required": ["title", "createdAt"],
+        "properties": {
+          "subjects": {
+            "type": "array",
+            "description": "References to the subject(s) the attachment is connected to—this may be an activity claim, outcome claim, measurement, evaluation, or even another attachment. This is optional as the attachment can exist before the claim is recorded.",
+            "items": {
+              "type": "ref",
+              "ref": "com.atproto.repo.strongRef"
+            },
+            "maxLength": 100
+          },
+          "contentType": {
+            "type": "string",
+            "description": "The type of attachment. Values beyond the known set are permitted.",
+            "knownValues": [
+              "report",
+              "audit",
+              "evidence",
+              "testimonial",
+              "methodology"
+            ],
+            "maxLength": 64
+          },
+          "content": {
+            "type": "array",
+            "description": "The files, documents, or external references included in this attachment record.",
+            "items": {
+              "type": "union",
+              "refs": [
+                "org.hypercerts.defs#uri",
+                "org.hypercerts.defs#smallBlob"
+              ]
+            },
+            "maxLength": 100
+          },
+          "title": {
+            "type": "string",
+            "maxLength": 256,
+            "description": "Display title for this attachment (e.g. 'Impact Assessment Report', 'Audit Findings')"
+          },
+          "shortDescription": {
+            "type": "string",
+            "description": "Short summary of this attachment, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.",
+            "maxLength": 3000,
+            "maxGraphemes": 300
+          },
+          "shortDescriptionFacets": {
+            "type": "array",
+            "description": "Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc).",
+            "items": {
+              "type": "ref",
+              "ref": "app.bsky.richtext.facet"
+            }
+          },
+          "description": {
+            "type": "union",
+            "refs": [
+              "org.hypercerts.defs#descriptionString",
+              "pub.leaflet.pages.linearDocument",
+              "com.atproto.repo.strongRef"
+            ],
+            "description": "Long-form description of the attachment. An inline string for plain text or markdown, a Leaflet linear document for rich-text content, or a strong reference to an external description record."
+          },
+          "location": {
+            "type": "ref",
+            "ref": "com.atproto.repo.strongRef",
+            "description": "A strong reference to the location where this attachment's subject matter occurred. The record referenced must conform with the lexicon app.certified.location."
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "datetime",
+            "description": "Client-declared timestamp when this record was originally created."
+          }
+        }
+      }
+    }
+  }
+}

package/lexicons/org/hypercerts/{claim → context}/evaluation.json

@@ -1,26 +1,7 @@
 {
   "lexicon": 1,
-  "id": "org.hypercerts.claim.evaluation",
+  "id": "org.hypercerts.context.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 record (e.g. an activity and its impact).",
@@ -32,7 +13,7 @@
           "subject": {
             "type": "ref",
             "ref": "com.atproto.repo.strongRef",
-            "description": "A strong reference to what is being evaluated. (e.g activity, measurement, contribution, etc.)"
+            "description": "A strong reference to what is being evaluated (e.g. activity, measurement, contribution, etc.)"
           },
           "evaluators": {
             "type": "array",
@@ -57,7 +38,7 @@
           },
           "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",
+            "description": "Optional references to the measurements that contributed to this evaluation. The record(s) referenced must conform with the lexicon org.hypercerts.context.measurement",
             "items": {
               "type": "ref",
               "ref": "com.atproto.repo.strongRef"
@@ -87,6 +68,28 @@
           }
         }
       }
+    },
+    "score": {
+      "type": "object",
+      "description": "Overall score for an evaluation on a numeric scale.",
+      "required": ["min", "max", "value"],
+      "properties": {
+        "min": {
+          "type": "string",
+          "description": "Minimum value of the scale as a numeric string (e.g. '0', '1').",
+          "maxLength": 50
+        },
+        "max": {
+          "type": "string",
+          "description": "Maximum value of the scale as a numeric string (e.g. '5', '10').",
+          "maxLength": 50
+        },
+        "value": {
+          "type": "string",
+          "description": "Score within the inclusive range [min, max] as a numeric string (e.g. '3.7').",
+          "maxLength": 50
+        }
+      }
     }
   }
 }

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

@@ -0,0 +1,107 @@
+{
+  "lexicon": 1,
+  "id": "org.hypercerts.context.measurement",
+  "defs": {
+    "main": {
+      "type": "record",
+      "description": "Measurement data related to one or more records (e.g. activities, projects, etc.).",
+      "key": "tid",
+      "record": {
+        "type": "object",
+        "required": ["metric", "unit", "value", "createdAt"],
+        "properties": {
+          "subjects": {
+            "type": "array",
+            "description": "Strong references to the records this measurement refers to (e.g. activities, projects, or claims).",
+            "items": {
+              "type": "ref",
+              "ref": "com.atproto.repo.strongRef"
+            },
+            "maxLength": 100
+          },
+          "metric": {
+            "type": "string",
+            "description": "The metric being measured, e.g. forest area restored, number of users, etc.",
+            "maxLength": 500
+          },
+          "unit": {
+            "type": "string",
+            "description": "The unit of the measured value (e.g. kg CO₂e, hectares, %, index score).",
+            "maxLength": 50
+          },
+          "value": {
+            "type": "string",
+            "description": "The measured value as a numeric string (e.g. '1234.56')",
+            "maxLength": 500
+          },
+          "startDate": {
+            "type": "string",
+            "format": "datetime",
+            "description": "The start date and time when the measurement began."
+          },
+          "endDate": {
+            "type": "string",
+            "format": "datetime",
+            "description": "The end date and time when the measurement ended. For one-time measurements, this should equal the start date."
+          },
+          "locations": {
+            "type": "array",
+            "description": "Optional geographic references related to where the measurement was taken. Each referenced record must conform with the app.certified.location lexicon.",
+            "items": {
+              "type": "ref",
+              "ref": "com.atproto.repo.strongRef"
+            },
+            "maxLength": 100
+          },
+          "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 related evidence or underlying data (e.g. org.hypercerts.claim.evidence records or raw datasets)",
+            "items": {
+              "type": "string",
+              "format": "uri"
+            },
+            "maxLength": 50
+          },
+          "measurers": {
+            "type": "array",
+            "description": "DIDs of the entities that performed this measurement",
+            "items": {
+              "type": "ref",
+              "ref": "app.certified.defs#did"
+            },
+            "maxLength": 100
+          },
+          "comment": {
+            "type": "string",
+            "description": "Short comment of this measurement, suitable for previews and list views. Rich text annotations may be provided via `commentFacets`.",
+            "maxLength": 3000,
+            "maxGraphemes": 300
+          },
+          "commentFacets": {
+            "type": "array",
+            "description": "Rich text annotations for `comment` (mentions, URLs, hashtags, etc).",
+            "items": {
+              "type": "ref",
+              "ref": "app.bsky.richtext.facet"
+            }
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "datetime",
+            "description": "Client-declared timestamp when this record was originally created"
+          }
+        }
+      }
+    }
+  }
+}

package/lexicons/org/hypercerts/defs.json

@@ -1,7 +1,29 @@
 {
   "lexicon": 1,
   "id": "org.hypercerts.defs",
+  "description": "Common type definitions used across all Hypercerts protocols.",
   "defs": {
+    "descriptionString": {
+      "type": "object",
+      "description": "An inline long-form description as plain text or markdown, with optional rich-text annotations.",
+      "required": ["value"],
+      "properties": {
+        "value": {
+          "type": "string",
+          "description": "The description text (plain text or markdown).",
+          "maxLength": 250000,
+          "maxGraphemes": 25000
+        },
+        "facets": {
+          "type": "array",
+          "description": "Rich text annotations for the description (mentions, URLs, hashtags, etc).",
+          "items": {
+            "type": "ref",
+            "ref": "app.bsky.richtext.facet"
+          }
+        }
+      }
+    },
     "uri": {
       "type": "object",
       "required": ["uri"],
@@ -10,7 +32,6 @@
         "uri": {
           "type": "string",
           "format": "uri",
-          "maxGraphemes": 1024,
           "description": "URI to external data"
         }
       }
@@ -54,6 +75,19 @@
         }
       }
     },
+    "smallVideo": {
+      "type": "object",
+      "required": ["video"],
+      "description": "Object containing a small video",
+      "properties": {
+        "video": {
+          "type": "blob",
+          "accept": ["video/mp4", "video/webm"],
+          "maxSize": 20971520,
+          "description": "Video (up to 20MB)"
+        }
+      }
+    },
     "largeImage": {
       "type": "object",
       "required": ["image"],
@@ -66,94 +100,6 @@
           "description": "Image (up to 10MB)"
         }
       }
-    },
-    "workScopeAll": {
-      "type": "object",
-      "required": ["op", "args"],
-      "description": "Logical AND operation: all arguments must be satisfied.",
-      "properties": {
-        "op": {
-          "type": "string",
-          "const": "all",
-          "description": "Operator type: 'all' (logical AND)"
-        },
-        "args": {
-          "type": "array",
-          "items": {
-            "type": "union",
-            "refs": [
-              "#workScopeAll",
-              "#workScopeAny",
-              "#workScopeNot",
-              "#workScopeAtom"
-            ]
-          },
-          "minLength": 1,
-          "maxLength": 100,
-          "description": "Array of work scope expressions that must all be satisfied"
-        }
-      }
-    },
-    "workScopeAny": {
-      "type": "object",
-      "required": ["op", "args"],
-      "description": "Logical OR operation: at least one argument must be satisfied.",
-      "properties": {
-        "op": {
-          "type": "string",
-          "const": "any",
-          "description": "Operator type: 'any' (logical OR)"
-        },
-        "args": {
-          "type": "array",
-          "items": {
-            "type": "union",
-            "refs": [
-              "#workScopeAll",
-              "#workScopeAny",
-              "#workScopeNot",
-              "#workScopeAtom"
-            ]
-          },
-          "minLength": 1,
-          "maxLength": 100,
-          "description": "Array of work scope expressions, at least one of which must be satisfied"
-        }
-      }
-    },
-    "workScopeNot": {
-      "type": "object",
-      "required": ["op", "arg"],
-      "description": "Logical NOT operation: the argument must not be satisfied.",
-      "properties": {
-        "op": {
-          "type": "string",
-          "const": "not",
-          "description": "Operator type: 'not' (logical NOT)"
-        },
-        "arg": {
-          "type": "union",
-          "refs": [
-            "#workScopeAll",
-            "#workScopeAny",
-            "#workScopeNot",
-            "#workScopeAtom"
-          ],
-          "description": "Work scope expression that must not be satisfied"
-        }
-      }
-    },
-    "workScopeAtom": {
-      "type": "object",
-      "required": ["atom"],
-      "description": "Atomic scope reference: a strong reference to a scope record.",
-      "properties": {
-        "atom": {
-          "type": "ref",
-          "ref": "com.atproto.repo.strongRef",
-          "description": "Strong reference to an org.hypercerts.helper.workScopeTag record"
-        }
-      }
     }
   }
 }