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

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

@@ -8,41 +8,55 @@
       "key": "tid",
       "record": {
         "type": "object",
-        "required": ["from", "to", "amount", "currency", "createdAt"],
+        "required": ["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."
+            "type": "union",
+            "description": "The sender of the funds (a free-text string, an account DID, or a strong reference to a record). Optional — omit to represent anonymity.",
+            "refs": [
+              "#text",
+              "app.certified.defs#did",
+              "com.atproto.repo.strongRef"
+            ]
           },
           "to": {
-            "type": "string",
-            "description": "The recipient of the funds. Can be identified by DID or a clear-text name."
+            "type": "union",
+            "description": "The recipient of the funds (a free-text string, an account DID, or a strong reference to a record).",
+            "refs": [
+              "#text",
+              "app.certified.defs#did",
+              "com.atproto.repo.strongRef"
+            ]
           },
           "amount": {
             "type": "string",
-            "description": "Amount of funding received."
+            "description": "Amount of funding received as a numeric string (e.g. '1000.50').",
+            "maxLength": 50
           },
           "currency": {
             "type": "string",
-            "description": "Currency of the payment (e.g. EUR, USD, ETH)."
+            "description": "Currency of the payment (e.g. EUR, USD, ETH).",
+            "maxLength": 10
           },
           "paymentRail": {
             "type": "string",
-            "description": "How the funds were transferred (e.g. bank_transfer, credit_card, onchain, cash, check, payment_processor)."
+            "description": "How the funds were transferred (e.g. bank_transfer, credit_card, onchain, cash, check, payment_processor).",
+            "maxLength": 50
           },
           "paymentNetwork": {
             "type": "string",
-            "description": "Optional network within the payment rail (e.g. arbitrum, ethereum, sepa, visa, paypal)."
+            "description": "Optional network within the payment rail (e.g. arbitrum, ethereum, sepa, visa, paypal).",
+            "maxLength": 50
           },
           "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."
+            "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.",
+            "maxLength": 256
           },
           "for": {
-            "type": "string",
-            "format": "at-uri",
-            "description": "Optional reference to the activity, project, or organization this funding relates to."
+            "type": "ref",
+            "ref": "com.atproto.repo.strongRef",
+            "description": "Optional strong reference to the activity, project, or organization this funding relates to."
           },
           "notes": {
             "type": "string",
@@ -61,6 +75,18 @@
           }
         }
       }
+    },
+    "text": {
+      "type": "object",
+      "description": "A free-text string value (e.g. a display name, wallet address, or other identifier).",
+      "required": ["value"],
+      "properties": {
+        "value": {
+          "type": "string",
+          "description": "The string value.",
+          "maxLength": 2048
+        }
+      }
     }
   }
 }

package/lexicons/org/hypercerts/workscope/cel.json

@@ -0,0 +1,39 @@
+{
+  "lexicon": 1,
+  "id": "org.hypercerts.workscope.cel",
+  "defs": {
+    "main": {
+      "type": "object",
+      "description": "A structured, machine-evaluable work scope definition using CEL (Common Expression Language). Tags referenced in the expression correspond to org.hypercerts.workscope.tag keys. See https://github.com/google/cel-spec. Note: this is intentionally type 'object' (not 'record') so it can be directly embedded inline in union types (e.g., activity.workScope) without requiring a separate collection or strongRef indirection.",
+      "required": ["expression", "usedTags", "version", "createdAt"],
+      "properties": {
+        "expression": {
+          "type": "string",
+          "maxLength": 10000,
+          "maxGraphemes": 5000,
+          "description": "A CEL expression encoding the work scope conditions. Example: scope.hasAll(['mangrove_restoration', 'environmental_education']) && location.country == 'KE'"
+        },
+        "usedTags": {
+          "type": "array",
+          "items": {
+            "type": "ref",
+            "ref": "com.atproto.repo.strongRef"
+          },
+          "maxLength": 100,
+          "description": "Strong references to org.hypercerts.workscope.tag records used in the expression. Enables fast indexing by AT-URI and provides referential integrity to the underlying tag records."
+        },
+        "version": {
+          "type": "string",
+          "maxLength": 16,
+          "knownValues": ["v1"],
+          "description": "CEL context schema version."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "datetime",
+          "description": "Client-declared timestamp when this expression was originally created."
+        }
+      }
+    }
+  }
+}

package/lexicons/org/hypercerts/workscope/tag.json

@@ -0,0 +1,87 @@
+{
+  "lexicon": 1,
+  "id": "org.hypercerts.workscope.tag",
+  "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. Tags are composed into structured expressions via CEL (Common Expression Language) on activity records.",
+      "key": "tid",
+      "record": {
+        "type": "object",
+        "required": ["key", "name", "createdAt"],
+        "properties": {
+          "key": {
+            "type": "string",
+            "description": "Lowercase, underscore-separated machine-readable key for this scope (e.g., 'mangrove_restoration', 'biodiversity_monitoring'). Used as the canonical identifier in CEL expressions.",
+            "maxLength": 120
+          },
+          "name": {
+            "type": "string",
+            "description": "Human-readable name for this scope.",
+            "maxLength": 200
+          },
+          "category": {
+            "type": "string",
+            "description": "Category type of this scope.",
+            "knownValues": ["topic", "language", "domain", "method"],
+            "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 work scope tag record for taxonomy/hierarchy support. The record referenced must conform with the lexicon org.hypercerts.workscope.tag."
+          },
+          "status": {
+            "type": "string",
+            "description": "Lifecycle status of this tag. Communities propose tags, curators accept them, deprecated tags point to replacements via supersededBy.",
+            "knownValues": ["proposed", "accepted", "deprecated"],
+            "maxLength": 20
+          },
+          "supersededBy": {
+            "type": "ref",
+            "ref": "com.atproto.repo.strongRef",
+            "description": "When status is 'deprecated', points to the replacement work scope tag record. The record referenced must conform with the lexicon org.hypercerts.workscope.tag."
+          },
+          "aliases": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "maxLength": 50,
+            "description": "Alternative human-readable names for this scope (e.g., translations, abbreviations, or common synonyms). Unlike sameAs, these are plain-text labels, not links to external ontologies."
+          },
+          "sameAs": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "format": "uri",
+              "maxLength": 2048
+            },
+            "maxLength": 20,
+            "description": "URIs to semantically equivalent concepts in external ontologies or taxonomies (e.g., Wikidata QIDs, ENVO terms, SDG targets). Used for interoperability, not as documentation."
+          },
+          "referenceDocument": {
+            "type": "union",
+            "refs": [
+              "org.hypercerts.defs#uri",
+              "org.hypercerts.defs#smallBlob"
+            ],
+            "description": "Link to a governance or reference document where this work scope tag is defined and further explained."
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "datetime",
+            "description": "Client-declared timestamp when this record was originally created."
+          }
+        }
+      }
+    }
+  }
+}

package/lexicons/pub/leaflet/blocks/blockquote.json

@@ -0,0 +1,22 @@
+{
+  "lexicon": 1,
+  "id": "pub.leaflet.blocks.blockquote",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": ["plaintext"],
+      "properties": {
+        "plaintext": {
+          "type": "string"
+        },
+        "facets": {
+          "type": "array",
+          "items": {
+            "type": "ref",
+            "ref": "pub.leaflet.richtext.facet"
+          }
+        }
+      }
+    }
+  }
+}

package/lexicons/pub/leaflet/blocks/bskyPost.json

@@ -0,0 +1,19 @@
+{
+  "lexicon": 1,
+  "id": "pub.leaflet.blocks.bskyPost",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": ["postRef"],
+      "properties": {
+        "postRef": {
+          "type": "ref",
+          "ref": "com.atproto.repo.strongRef"
+        },
+        "clientHost": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

package/lexicons/pub/leaflet/blocks/button.json

@@ -0,0 +1,19 @@
+{
+  "lexicon": 1,
+  "id": "pub.leaflet.blocks.button",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": ["text", "url"],
+      "properties": {
+        "text": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string",
+          "format": "uri"
+        }
+      }
+    }
+  }
+}

package/lexicons/pub/leaflet/blocks/code.json

@@ -0,0 +1,21 @@
+{
+  "lexicon": 1,
+  "id": "pub.leaflet.blocks.code",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": ["plaintext"],
+      "properties": {
+        "plaintext": {
+          "type": "string"
+        },
+        "language": {
+          "type": "string"
+        },
+        "syntaxHighlightingTheme": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

package/lexicons/pub/leaflet/blocks/header.json

@@ -0,0 +1,27 @@
+{
+  "lexicon": 1,
+  "id": "pub.leaflet.blocks.header",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": ["plaintext"],
+      "properties": {
+        "level": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 6
+        },
+        "plaintext": {
+          "type": "string"
+        },
+        "facets": {
+          "type": "array",
+          "items": {
+            "type": "ref",
+            "ref": "pub.leaflet.richtext.facet"
+          }
+        }
+      }
+    }
+  }
+}

package/lexicons/pub/leaflet/blocks/horizontalRule.json

@@ -0,0 +1,11 @@
+{
+  "lexicon": 1,
+  "id": "pub.leaflet.blocks.horizontalRule",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": [],
+      "properties": {}
+    }
+  }
+}

package/lexicons/pub/leaflet/blocks/iframe.json

@@ -0,0 +1,21 @@
+{
+  "lexicon": 1,
+  "id": "pub.leaflet.blocks.iframe",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": ["url"],
+      "properties": {
+        "url": {
+          "type": "string",
+          "format": "uri"
+        },
+        "height": {
+          "type": "integer",
+          "minimum": 16,
+          "maximum": 1600
+        }
+      }
+    }
+  }
+}

package/lexicons/pub/leaflet/blocks/image.json

@@ -0,0 +1,37 @@
+{
+  "lexicon": 1,
+  "id": "pub.leaflet.blocks.image",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": ["image", "aspectRatio"],
+      "properties": {
+        "image": {
+          "type": "blob",
+          "accept": ["image/*"],
+          "maxSize": 1000000
+        },
+        "alt": {
+          "type": "string",
+          "description": "Alt text description of the image, for accessibility."
+        },
+        "aspectRatio": {
+          "type": "ref",
+          "ref": "#aspectRatio"
+        }
+      }
+    },
+    "aspectRatio": {
+      "type": "object",
+      "required": ["width", "height"],
+      "properties": {
+        "width": {
+          "type": "integer"
+        },
+        "height": {
+          "type": "integer"
+        }
+      }
+    }
+  }
+}

package/lexicons/pub/leaflet/blocks/math.json

@@ -0,0 +1,15 @@
+{
+  "lexicon": 1,
+  "id": "pub.leaflet.blocks.math",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": ["tex"],
+      "properties": {
+        "tex": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

package/lexicons/pub/leaflet/blocks/orderedList.json

@@ -0,0 +1,54 @@
+{
+  "lexicon": 1,
+  "id": "pub.leaflet.blocks.orderedList",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": ["children"],
+      "properties": {
+        "startIndex": {
+          "type": "integer",
+          "description": "The starting number for this ordered list. Defaults to 1 if not specified."
+        },
+        "children": {
+          "type": "array",
+          "items": {
+            "type": "ref",
+            "ref": "#listItem"
+          }
+        }
+      }
+    },
+    "listItem": {
+      "type": "object",
+      "required": ["content"],
+      "properties": {
+        "checked": {
+          "type": "boolean",
+          "description": "If present, this item is a checklist item. true = checked, false = unchecked. If absent, this is a normal list item."
+        },
+        "content": {
+          "type": "union",
+          "refs": [
+            "pub.leaflet.blocks.text",
+            "pub.leaflet.blocks.header",
+            "pub.leaflet.blocks.image"
+          ]
+        },
+        "children": {
+          "type": "array",
+          "description": "Nested ordered list items. Mutually exclusive with unorderedListChildren; if both are present, children takes precedence.",
+          "items": {
+            "type": "ref",
+            "ref": "#listItem"
+          }
+        },
+        "unorderedListChildren": {
+          "type": "ref",
+          "description": "A nested unordered list. Mutually exclusive with children; if both are present, children takes precedence.",
+          "ref": "pub.leaflet.blocks.unorderedList"
+        }
+      }
+    }
+  }
+}

package/lexicons/pub/leaflet/blocks/page.json

@@ -0,0 +1,15 @@
+{
+  "lexicon": 1,
+  "id": "pub.leaflet.blocks.page",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": ["id"],
+      "properties": {
+        "id": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

package/lexicons/pub/leaflet/blocks/poll.json

@@ -0,0 +1,16 @@
+{
+  "lexicon": 1,
+  "id": "pub.leaflet.blocks.poll",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": ["pollRef"],
+      "properties": {
+        "pollRef": {
+          "type": "ref",
+          "ref": "com.atproto.repo.strongRef"
+        }
+      }
+    }
+  }
+}

package/lexicons/pub/leaflet/blocks/text.json

@@ -0,0 +1,26 @@
+{
+  "lexicon": 1,
+  "id": "pub.leaflet.blocks.text",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": ["plaintext"],
+      "properties": {
+        "plaintext": {
+          "type": "string"
+        },
+        "textSize": {
+          "type": "string",
+          "enum": ["default", "small", "large"]
+        },
+        "facets": {
+          "type": "array",
+          "items": {
+            "type": "ref",
+            "ref": "pub.leaflet.richtext.facet"
+          }
+        }
+      }
+    }
+  }
+}

package/lexicons/pub/leaflet/blocks/unorderedList.json

@@ -0,0 +1,50 @@
+{
+  "lexicon": 1,
+  "id": "pub.leaflet.blocks.unorderedList",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": ["children"],
+      "properties": {
+        "children": {
+          "type": "array",
+          "items": {
+            "type": "ref",
+            "ref": "#listItem"
+          }
+        }
+      }
+    },
+    "listItem": {
+      "type": "object",
+      "required": ["content"],
+      "properties": {
+        "checked": {
+          "type": "boolean",
+          "description": "If present, this item is a checklist item. true = checked, false = unchecked. If absent, this is a normal list item."
+        },
+        "content": {
+          "type": "union",
+          "refs": [
+            "pub.leaflet.blocks.text",
+            "pub.leaflet.blocks.header",
+            "pub.leaflet.blocks.image"
+          ]
+        },
+        "children": {
+          "type": "array",
+          "description": "Nested unordered list items. Mutually exclusive with orderedListChildren; if both are present, children takes precedence.",
+          "items": {
+            "type": "ref",
+            "ref": "#listItem"
+          }
+        },
+        "orderedListChildren": {
+          "type": "ref",
+          "description": "Nested ordered list items. Mutually exclusive with children; if both are present, children takes precedence.",
+          "ref": "pub.leaflet.blocks.orderedList"
+        }
+      }
+    }
+  }
+}

package/lexicons/pub/leaflet/blocks/website.json

@@ -0,0 +1,27 @@
+{
+  "lexicon": 1,
+  "id": "pub.leaflet.blocks.website",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": ["src"],
+      "properties": {
+        "previewImage": {
+          "type": "blob",
+          "accept": ["image/*"],
+          "maxSize": 1000000
+        },
+        "title": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "src": {
+          "type": "string",
+          "format": "uri"
+        }
+      }
+    }
+  }
+}