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

package/lexicons/org/hyperboards/displayProfile.json

@@ -0,0 +1,64 @@
+{
+  "lexicon": 1,
+  "id": "org.hyperboards.displayProfile",
+  "defs": {
+    "main": {
+      "type": "record",
+      "description": "User-declared visual presentation defaults for how a contributor appears on hyperboards. Stored in the contributor's own PDS and reusable across multiple boards.",
+      "key": "literal:self",
+      "record": {
+        "type": "object",
+        "required": ["createdAt"],
+        "properties": {
+          "displayName": {
+            "type": "string",
+            "description": "Display name override for this user on hyperboards.",
+            "maxLength": 640,
+            "maxGraphemes": 64
+          },
+          "image": {
+            "type": "union",
+            "refs": [
+              "org.hypercerts.defs#uri",
+              "org.hypercerts.defs#smallImage"
+            ],
+            "description": "Avatar or face image override for this user on hyperboards, as a URI or image blob."
+          },
+          "video": {
+            "type": "union",
+            "refs": [
+              "org.hypercerts.defs#uri",
+              "org.hypercerts.defs#smallVideo"
+            ],
+            "description": "Default video for this user across boards, as a URI (embed/direct link) or uploaded video blob."
+          },
+          "hoverImage": {
+            "type": "union",
+            "refs": [
+              "org.hypercerts.defs#uri",
+              "org.hypercerts.defs#smallImage"
+            ],
+            "description": "Default hover image for this user across boards, as a URI or image blob."
+          },
+          "hoverIframeUrl": {
+            "type": "string",
+            "format": "uri",
+            "description": "Default hover iframe URL for this user across boards.",
+            "maxLength": 2048
+          },
+          "url": {
+            "type": "string",
+            "format": "uri",
+            "description": "Default click-through link URL for this user across boards.",
+            "maxLength": 2048
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "datetime",
+            "description": "Client-declared timestamp when this record was originally created."
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -12,7 +12,7 @@
         "properties": {
           "title": {
             "type": "string",
-            "description": "Title of the hypercert.",
+            "description": "Display title summarizing the impact work (e.g. 'Reforestation in Amazon Basin 2024')",
             "maxLength": 256
           },
           "shortDescription": {
@@ -30,18 +30,9 @@
             }
           },
           "description": {
-            "type": "string",
-            "description": "Optional longer description of this activity claim, including context or interpretation. Rich text annotations may be provided via `descriptionFacets`.",
-            "maxLength": 30000,
-            "maxGraphemes": 3000
-          },
-          "descriptionFacets": {
-            "type": "array",
-            "description": "Rich text annotations for `description` (mentions, URLs, hashtags, etc).",
-            "items": {
-              "type": "ref",
-              "ref": "app.bsky.richtext.facet"
-            }
+            "type": "ref",
+            "ref": "pub.leaflet.pages.linearDocument#main",
+            "description": "Rich-text description, represented as a Leaflet linear document."
           },
           "image": {
             "type": "union",
@@ -51,15 +42,19 @@
             ],
             "description": "The hypercert visual representation as a URI or image blob."
           },
+          "contributors": {
+            "type": "array",
+            "description": "An array of contributor objects, each containing contributor information, weight, and contribution details.",
+            "maxLength": 1000,
+            "items": {
+              "type": "ref",
+              "ref": "#contributor"
+            }
+          },
           "workScope": {
             "type": "union",
-            "refs": [
-              "org.hypercerts.defs#workScopeAll",
-              "org.hypercerts.defs#workScopeAny",
-              "org.hypercerts.defs#workScopeNot",
-              "org.hypercerts.defs#workScopeAtom"
-            ],
-            "description": "Work scope logic expression using boolean operators (all/any/not) and atomic scope references."
+            "refs": ["org.hypercerts.workscope.cel", "#workScopeString"],
+            "description": "Work scope definition. A CEL expression for structured, machine-evaluable scopes or a free-form string for simple and legacy scopes."
           },
           "startDate": {
             "type": "string",
@@ -71,12 +66,13 @@
             "format": "datetime",
             "description": "When the work ended"
           },
-          "contributors": {
+          "locations": {
             "type": "array",
-            "description": "An array of contributor objects, each containing contributor information, weight, and contribution details.",
+            "description": "An array of strong references to the location where activity was performed. The record referenced must conform with the lexicon app.certified.location.",
+            "maxLength": 1000,
             "items": {
               "type": "ref",
-              "ref": "#contributor"
+              "ref": "com.atproto.repo.strongRef"
             }
           },
           "rights": {
@@ -84,14 +80,6 @@
             "ref": "com.atproto.repo.strongRef",
             "description": "A strong reference to the rights that this hypercert has. The record referenced must conform with the lexicon org.hypercerts.claim.rights."
           },
-          "locations": {
-            "type": "array",
-            "description": "An array of strong references to the location where activity was performed. The record referenced must conform with the lexicon app.certified.location.",
-            "items": {
-              "type": "ref",
-              "ref": "com.atproto.repo.strongRef"
-            }
-          },
           "createdAt": {
             "type": "string",
             "format": "datetime",
@@ -107,28 +95,58 @@
         "contributorIdentity": {
           "type": "union",
           "refs": ["#contributorIdentity", "com.atproto.repo.strongRef"],
-          "description": "Contributor identity as a string (DID or identifier) via org.hypercerts.claim.activity#contributorIdentity, or a strong reference to a contributor information record."
+          "description": "Inline contributor identity object with an identity string (DID or identifier) via org.hypercerts.claim.activity#contributorIdentity, or a strong reference to a contributor information record. The record referenced must conform with the lexicon org.hypercerts.claim.contributorInformation."
         },
         "contributionWeight": {
           "type": "string",
-          "description": "The relative weight/importance of this contribution (stored as a string to avoid float precision issues). Must be a positive numeric value. Weights do not need to sum to a specific total; normalization can be performed by the consuming application as needed."
+          "description": "The relative weight/importance of this contribution (stored as a string to avoid float precision issues). Must be a positive numeric value. Weights do not need to sum to a specific total; normalization can be performed by the consuming application as needed.",
+          "maxLength": 100
         },
         "contributionDetails": {
           "type": "union",
           "refs": ["#contributorRole", "com.atproto.repo.strongRef"],
-          "description": "Contribution details as a string via org.hypercerts.claim.activity#contributorRole, or a strong reference to a contribution details record."
+          "description": "Inline contribution role object with a role string via org.hypercerts.claim.activity#contributorRole, or a strong reference to a contribution details record. The record referenced must conform with the lexicon org.hypercerts.claim.contribution."
         }
       }
     },
     "contributorIdentity": {
-      "type": "string",
-      "description": "Contributor information as a string (DID or identifier)."
+      "type": "object",
+      "description": "Contributor information as a string (DID or identifier).",
+      "required": ["identity"],
+      "properties": {
+        "identity": {
+          "type": "string",
+          "description": "The contributor identity string (DID or identifier).",
+          "maxLength": 1000,
+          "maxGraphemes": 100
+        }
+      }
     },
     "contributorRole": {
-      "type": "string",
+      "type": "object",
       "description": "Contribution details as a string.",
-      "maxLength": 10000,
-      "maxGraphemes": 1000
+      "required": ["role"],
+      "properties": {
+        "role": {
+          "type": "string",
+          "description": "The contribution role or details.",
+          "maxLength": 1000,
+          "maxGraphemes": 100
+        }
+      }
+    },
+    "workScopeString": {
+      "type": "object",
+      "description": "A free-form string describing the work scope for simple or legacy scopes.",
+      "required": ["scope"],
+      "properties": {
+        "scope": {
+          "type": "string",
+          "description": "The work scope description string.",
+          "maxLength": 1000,
+          "maxGraphemes": 100
+        }
+      }
     }
   }
 }

package/lexicons/org/hypercerts/claim/{contributionDetails.json → contribution.json}

@@ -1,6 +1,6 @@
 {
   "lexicon": 1,
-  "id": "org.hypercerts.claim.contributionDetails",
+  "id": "org.hypercerts.claim.contribution",
   "defs": {
     "main": {
       "type": "record",
@@ -17,19 +17,19 @@
           },
           "contributionDescription": {
             "type": "string",
-            "description": "What the contribution concretely was.",
+            "description": "Description of what the contribution concretely involved.",
             "maxLength": 10000,
             "maxGraphemes": 1000
           },
           "startDate": {
             "type": "string",
             "format": "datetime",
-            "description": "When this contribution started. This should be a subset of the hypercert timeframe."
+            "description": "When this contribution started. Should fall within the parent hypercert's timeframe."
           },
           "endDate": {
             "type": "string",
             "format": "datetime",
-            "description": "When this contribution finished. This should be a subset of the hypercert timeframe."
+            "description": "When this contribution finished. Should fall within the parent hypercert's timeframe."
           },
           "createdAt": {
             "type": "string",

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,23 @@
 {
   "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. Possible fields can be 'favorites', 'project', or any other type of collection.",
+            "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
           },
@@ -50,11 +51,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",
@@ -70,11 +77,12 @@
         "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,77 @@
+{
+  "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",
+            "maxLength": 64,
+            "description": "The type of attachment, e.g. report, audit, evidence, testimonial, methodology, etc."
+          },
+          "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": "ref",
+            "ref": "pub.leaflet.pages.linearDocument#main",
+            "description": "Rich-text description, represented as a Leaflet linear document."
+          },
+          "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,25 @@
           }
         }
       }
+    },
+    "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]."
+        }
+      }
     }
   }
 }

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"
+          }
+        }
+      }
+    }
+  }
+}