@hypercerts-org/lexicon 0.10.0-beta.6 → 0.10.0-beta.8

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

@@ -17,16 +17,32 @@
           },
           "shortDescription": {
             "type": "string",
-            "description": "Short blurb of the impact work done.",
+            "description": "Short summary of this activity claim, 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": "string",
-            "description": "Optional longer description of the impact work done.",
+            "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"
+            }
+          },
           "image": {
             "type": "union",
             "refs": [
@@ -36,9 +52,14 @@
             "description": "The hypercert visual representation as a URI or image blob."
           },
           "workScope": {
-            "type": "ref",
-            "ref": "com.atproto.repo.strongRef",
-            "description": "A strong reference to a record defining the scope of work. The record referenced should describe the logical scope using label-based conditions."
+            "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."
           },
           "startDate": {
             "type": "string",
@@ -81,21 +102,21 @@
     },
     "contributor": {
       "type": "object",
-      "required": ["contributorInformation"],
+      "required": ["contributorIdentity"],
       "properties": {
-        "contributorInformation": {
+        "contributorIdentity": {
           "type": "union",
           "refs": ["#contributorIdentity", "com.atproto.repo.strongRef"],
-          "description": "Contributor information as a string (DID or identifier) or strong reference to for instance org.hypercerts.claim.contributorInformation#main."
+          "description": "Contributor identity as a string (DID or identifier) via org.hypercerts.claim.activity#contributorIdentity, or a strong reference to a contributor information record."
         },
-        "weight": {
+        "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."
         },
         "contributionDetails": {
           "type": "union",
           "refs": ["#contributorRole", "com.atproto.repo.strongRef"],
-          "description": "Contribution details as a string or strong reference to org.hypercerts.claim.contributionDetails#main."
+          "description": "Contribution details as a string via org.hypercerts.claim.activity#contributorRole, or a strong reference to a contribution details record."
         }
       }
     },
@@ -108,21 +129,6 @@
       "description": "Contribution details as a string.",
       "maxLength": 10000,
       "maxGraphemes": 1000
-    },
-    "activityWeight": {
-      "type": "object",
-      "required": ["activity", "weight"],
-      "properties": {
-        "activity": {
-          "type": "ref",
-          "ref": "com.atproto.repo.strongRef",
-          "description": "A strong reference to a hypercert activity record. This activity must conform to the lexicon org.hypercerts.claim.activity"
-        },
-        "weight": {
-          "type": "string",
-          "description": "The relative weight/importance of this hypercert activity (stored as a string to avoid float precision issues). Weights can be any positive numeric values and do not need to sum to a specific total; normalization can be performed by the consuming application as needed."
-        }
-      }
     }
   }
 }

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

@@ -31,12 +31,28 @@
             "ref": "pub.leaflet.pages.linearDocument#main",
             "description": "Rich-text description, represented as a Leaflet linear document."
           },
+          "avatar": {
+            "type": "union",
+            "refs": [
+              "org.hypercerts.defs#uri",
+              "org.hypercerts.defs#smallImage"
+            ],
+            "description": "The collection's avatar/profile image as a URI or image blob."
+          },
+          "banner": {
+            "type": "union",
+            "refs": [
+              "org.hypercerts.defs#uri",
+              "org.hypercerts.defs#largeImage"
+            ],
+            "description": "Larger horizontal image to display behind the collection view."
+          },
           "items": {
             "type": "array",
-            "description": "Array of strong references to items in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.claim.collection).",
+            "description": "Array of items in this collection with optional weights.",
             "items": {
               "type": "ref",
-              "ref": "com.atproto.repo.strongRef"
+              "ref": "#item"
             }
           },
           "createdAt": {
@@ -46,6 +62,21 @@
           }
         }
       }
+    },
+    "item": {
+      "type": "object",
+      "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)."
+        },
+        "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."
+        }
+      }
     }
   }
 }

package/lexicons/org/hypercerts/defs.json

@@ -66,6 +66,94 @@
           "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"
+        }
+      }
     }
   }
 }

package/lexicons/org/hypercerts/helper/workScopeTag.json

@@ -0,0 +1,65 @@
+{
+  "lexicon": 1,
+  "id": "org.hypercerts.helper.workScopeTag",
+  "defs": {
+    "main": {
+      "type": "record",
+      "description": "A reusable scope atom for work scope logic expressions. Scopes can represent topics, languages, domains, deliverables, methods, regions, tags, or other categorical labels.",
+      "key": "tid",
+      "record": {
+        "type": "object",
+        "required": ["createdAt", "key", "label"],
+        "properties": {
+          "createdAt": {
+            "type": "string",
+            "format": "datetime",
+            "description": "Client-declared timestamp when this record was originally created"
+          },
+          "key": {
+            "type": "string",
+            "description": "Lowercase, hyphenated machine-readable key for this scope (e.g., 'ipfs', 'go-lang', 'filecoin').",
+            "maxLength": 120
+          },
+          "label": {
+            "type": "string",
+            "description": "Human-readable label for this scope.",
+            "maxLength": 200
+          },
+          "kind": {
+            "type": "string",
+            "description": "Category type of this scope. Recommended values: topic, language, domain, method, tag.",
+            "maxLength": 50
+          },
+          "description": {
+            "type": "string",
+            "description": "Optional longer description of this scope.",
+            "maxLength": 10000,
+            "maxGraphemes": 1000
+          },
+          "parent": {
+            "type": "ref",
+            "ref": "com.atproto.repo.strongRef",
+            "description": "Optional strong reference to a parent scope record for taxonomy/hierarchy support."
+          },
+          "aliases": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "maxLength": 50,
+            "description": "Optional array of alternative names or identifiers for this scope."
+          },
+          "externalReference": {
+            "type": "union",
+            "refs": [
+              "org.hypercerts.defs#uri",
+              "org.hypercerts.defs#smallBlob"
+            ],
+            "description": "Optional external reference for this scope as a URI or blob."
+          }
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hypercerts-org/lexicon",
-  "version": "0.10.0-beta.6",
+  "version": "0.10.0-beta.8",
   "description": "ATProto lexicon definitions and TypeScript types for the Hypercerts protocol",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -57,6 +57,7 @@
     "eslint": "eslint generated/exports.ts",
     "typecheck": "tsc --noEmit",
     "clean": "rm -rf dist generated",
+    "style:check": "node ./scripts/check-lexicon-style.js",
     "prepublishOnly": "npm run check",
     "changeset": "changeset",
     "version-packages": "changeset version && npm install --package-lock-only",
@@ -64,6 +65,7 @@
     "prepare": "husky && ./scripts/setup-merge-driver.sh"
   },
   "dependencies": {
+    "@atcute/bluesky": "^3.2.15",
     "@atcute/leaflet": "^1.0.15",
     "@atproto/lexicon": "^0.6.0",
     "multiformats": "^13.3.6"
@@ -83,6 +85,7 @@
     "husky": "^9.1.7",
     "prettier": "^3.2.5",
     "rollup": "^4.53.3",
+    "string-width": "^8.1.0",
     "tslib": "^2.8.1",
     "typescript": "^5.7.2",
     "typescript-eslint": "^8.51.0",