@hypercerts-org/lexicon 0.10.0-beta.11 → 0.10.0-beta.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/CHANGELOG.md +166 -0
  2. package/README.md +145 -1
  3. package/SCHEMAS.md +202 -94
  4. package/dist/exports.d.ts +138 -130
  5. package/dist/exports.d.ts.map +1 -1
  6. package/dist/generated/exports.d.ts +138 -130
  7. package/dist/generated/exports.d.ts.map +1 -1
  8. package/dist/generated/lexicons.d.ts +299 -283
  9. package/dist/generated/lexicons.d.ts.map +1 -1
  10. package/dist/generated/types/app/certified/location.d.ts +9 -1
  11. package/dist/generated/types/app/certified/location.d.ts.map +1 -1
  12. package/dist/generated/types/org/hypercerts/claim/activity.d.ts +3 -1
  13. package/dist/generated/types/org/hypercerts/claim/activity.d.ts.map +1 -1
  14. package/dist/generated/types/org/hypercerts/claim/attachment.d.ts +37 -0
  15. package/dist/generated/types/org/hypercerts/claim/attachment.d.ts.map +1 -0
  16. package/dist/generated/types/org/hypercerts/claim/measurement.d.ts +17 -5
  17. package/dist/generated/types/org/hypercerts/claim/measurement.d.ts.map +1 -1
  18. package/dist/generated/types/org/hypercerts/defs.d.ts +0 -44
  19. package/dist/generated/types/org/hypercerts/defs.d.ts.map +1 -1
  20. package/dist/index.cjs +409 -465
  21. package/dist/index.cjs.map +1 -1
  22. package/dist/index.mjs +406 -462
  23. package/dist/index.mjs.map +1 -1
  24. package/dist/lexicons.cjs +155 -163
  25. package/dist/lexicons.cjs.map +1 -1
  26. package/dist/lexicons.d.ts +299 -283
  27. package/dist/lexicons.d.ts.map +1 -1
  28. package/dist/lexicons.mjs +155 -163
  29. package/dist/lexicons.mjs.map +1 -1
  30. package/dist/types/app/certified/location.d.ts +9 -1
  31. package/dist/types/app/certified/location.d.ts.map +1 -1
  32. package/dist/types/org/hypercerts/claim/activity.d.ts +3 -1
  33. package/dist/types/org/hypercerts/claim/activity.d.ts.map +1 -1
  34. package/dist/types/org/hypercerts/claim/attachment.d.ts +37 -0
  35. package/dist/types/org/hypercerts/claim/attachment.d.ts.map +1 -0
  36. package/dist/types/org/hypercerts/claim/measurement.d.ts +17 -5
  37. package/dist/types/org/hypercerts/claim/measurement.d.ts.map +1 -1
  38. package/dist/types/org/hypercerts/defs.d.ts +0 -44
  39. package/dist/types/org/hypercerts/defs.d.ts.map +1 -1
  40. package/lexicons/app/certified/location.json +16 -2
  41. package/lexicons/org/hypercerts/claim/activity.json +8 -7
  42. package/lexicons/org/hypercerts/claim/attachment.json +86 -0
  43. package/lexicons/org/hypercerts/claim/measurement.json +49 -16
  44. package/lexicons/org/hypercerts/defs.json +0 -88
  45. package/package.json +1 -1
  46. package/dist/generated/types/org/hypercerts/claim/evidence.d.ts +0 -29
  47. package/dist/generated/types/org/hypercerts/claim/evidence.d.ts.map +0 -1
  48. package/dist/types/org/hypercerts/claim/evidence.d.ts +0 -29
  49. package/dist/types/org/hypercerts/claim/evidence.d.ts.map +0 -1
  50. package/lexicons/org/hypercerts/claim/evidence.json +0 -57
package/SCHEMAS.md CHANGED
@@ -15,25 +15,25 @@ Hypercerts-specific lexicons for tracking impact work and claims.
15
15
 
16
16
  #### Properties
17
17
 
18
- | Property | Type | Required | Description | Comments |
19
- | ------------------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
20
- | `title` | `string` | ✅ | Title of the hypercert. | maxLength: 256 |
21
- | `shortDescription` | `string` | ✅ | Short summary of this activity claim, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`. | maxLength: 3000, maxGraphemes: 300 |
22
- | `shortDescriptionFacets` | `ref` | ❌ | Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc). | |
23
- | `description` | `string` | ❌ | Optional longer description of this activity claim, including context or interpretation. Rich text annotations may be provided via `descriptionFacets`. | maxLength: 30000, maxGraphemes: 3000 |
24
- | `descriptionFacets` | `ref` | ❌ | Rich text annotations for `description` (mentions, URLs, hashtags, etc). | |
25
- | `image` | `union` | ❌ | The hypercert visual representation as a URI or image blob. | |
26
- | `workScope` | `union` | ❌ | Work scope logic expression using boolean operators (all/any/not) and atomic scope references. | |
27
- | `startDate` | `string` | ❌ | When the work began | |
28
- | `endDate` | `string` | ❌ | When the work ended | |
29
- | `contributors` | `ref` | ❌ | An array of contributor objects, each containing contributor information, weight, and contribution details. | |
30
- | `rights` | `ref` | ❌ | A strong reference to the rights that this hypercert has. The record referenced must conform with the lexicon org.hypercerts.claim.rights. | |
31
- | `locations` | `ref` | ❌ | An array of strong references to the location where activity was performed. The record referenced must conform with the lexicon app.certified.location. | |
32
- | `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |
18
+ | Property | Type | Required | Description | Comments |
19
+ | ------------------------ | -------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
20
+ | `title` | `string` | ✅ | Title of the hypercert. | maxLength: 256 |
21
+ | `shortDescription` | `string` | ✅ | Short summary of this activity claim, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`. | maxLength: 3000, maxGraphemes: 300 |
22
+ | `shortDescriptionFacets` | `ref` | ❌ | Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc). | |
23
+ | `description` | `string` | ❌ | Optional longer description of this activity claim, including context or interpretation. Rich text annotations may be provided via `descriptionFacets`. | maxLength: 30000, maxGraphemes: 3000 |
24
+ | `descriptionFacets` | `ref` | ❌ | Rich text annotations for `description` (mentions, URLs, hashtags, etc). | |
25
+ | `image` | `union` | ❌ | The hypercert visual representation as a URI or image blob. | |
26
+ | `workScope` | `union` | ❌ | Work scope definition. Either a strongRef to a work-scope logic record (structured, nested logic), or a free-form string for simple or legacy scopes. The work scope record should conform to the org.hypercerts.helper.workScopeTag lexicon. | |
27
+ | `startDate` | `string` | ❌ | When the work began | |
28
+ | `endDate` | `string` | ❌ | When the work ended | |
29
+ | `contributors` | `ref` | ❌ | An array of contributor objects, each containing contributor information, weight, and contribution details. | |
30
+ | `rights` | `ref` | ❌ | A strong reference to the rights that this hypercert has. The record referenced must conform with the lexicon org.hypercerts.claim.rights. | |
31
+ | `locations` | `ref` | ❌ | An array of strong references to the location where activity was performed. The record referenced must conform with the lexicon app.certified.location. | |
32
+ | `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |
33
33
 
34
34
  #### Defs
35
35
 
36
- ##### contributor
36
+ ##### `org.hypercerts.claim.activity#contributor`
37
37
 
38
38
  | Property | Type | Required | Description |
39
39
  | --------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
@@ -43,107 +43,150 @@ Hypercerts-specific lexicons for tracking impact work and claims.
43
43
 
44
44
  ---
45
45
 
46
- ### `org.hypercerts.claim.evaluation`
46
+ ### `org.hypercerts.claim.attachment`
47
47
 
48
- **Description:** An evaluation of a hypercert record (e.g. an activity and its impact).
48
+ **Description:** An attachment providing commentary, context, evidence, or documentary material related to a hypercert record (e.g. an activity, project, claim, or evaluation).
49
49
 
50
50
  **Key:** `tid`
51
51
 
52
52
  #### Properties
53
53
 
54
- | Property | Type | Required | Description | Comments |
55
- | -------------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
56
- | `subject` | `ref` | ❌ | A strong reference to what is being evaluated. (e.g activity, measurement, contribution, etc.) | |
57
- | `evaluators` | `ref` | ✅ | DIDs of the evaluators | maxLength: 1000 |
58
- | `content` | `union` | ❌ | Evaluation data (URIs or blobs) containing detailed reports or methodology | maxLength: 100 |
59
- | `measurements` | `ref` | ❌ | Optional references to the measurements that contributed to this evaluation. The record(s) referenced must conform with the lexicon org.hypercerts.claim.measurement | maxLength: 100 |
60
- | `summary` | `string` | ✅ | Brief evaluation summary | maxLength: 5000, maxGraphemes: 1000 |
61
- | `score` | `ref` | ❌ | Overall score for an evaluation on a numeric scale. | |
62
- | `location` | `ref` | ❌ | An optional reference for georeferenced evaluations. The record referenced must conform with the lexicon app.certified.location. | |
63
- | `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |
54
+ | Property | Type | Required | Description | Comments |
55
+ | ------------------------ | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
56
+ | `subjects` | `ref` | ❌ | 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. | maxLength: 100 |
57
+ | `contentType` | `string` | ❌ | The type of attachment, e.g. report, audit, evidence, testimonial, methodology, etc. | maxLength: 64 |
58
+ | `content` | `union` | ✅ | The files, documents, or external references included in this attachment record. | maxLength: 100 |
59
+ | `title` | `string` | ✅ | Title of this attachment. | maxLength: 256 |
60
+ | `shortDescription` | `string` | ❌ | Short summary of this attachment, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`. | maxLength: 3000, maxGraphemes: 300 |
61
+ | `shortDescriptionFacets` | `ref` | ❌ | Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc). | |
62
+ | `description` | `string` | ❌ | Optional longer description of this attachment, including context or interpretation. Rich text annotations may be provided via `descriptionFacets`. | maxLength: 30000, maxGraphemes: 3000 |
63
+ | `descriptionFacets` | `ref` | ❌ | Rich text annotations for `description` (mentions, URLs, hashtags, etc). | |
64
+ | `location` | `ref` | ❌ | A strong reference to the location where this attachment's subject matter occurred. The record referenced must conform with the lexicon app.certified.location. | |
65
+ | `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created. | |
66
+
67
+ ---
68
+
69
+ ### `org.hypercerts.claim.collection`
70
+
71
+ **Description:** A collection/group of items (activities and/or other collections). Collections support recursive nesting.
72
+
73
+ **Key:** `tid`
74
+
75
+ #### Properties
76
+
77
+ | Property | Type | Required | Description | Comments |
78
+ | ------------------ | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
79
+ | `type` | `string` | ❌ | The type of this collection. Possible fields can be 'favorites', 'project', or any other type of collection. | |
80
+ | `title` | `string` | ✅ | The title of this collection | maxLength: 800, maxGraphemes: 80 |
81
+ | `shortDescription` | `string` | ❌ | Short summary of this collection, suitable for previews and list views | maxLength: 3000, maxGraphemes: 300 |
82
+ | `description` | `ref` | ❌ | Rich-text description, represented as a Leaflet linear document. | |
83
+ | `avatar` | `union` | ❌ | The collection's avatar/profile image as a URI or image blob. | |
84
+ | `banner` | `union` | ❌ | Larger horizontal image to display behind the collection view. | |
85
+ | `items` | `ref` | ✅ | Array of items in this collection with optional weights. | |
86
+ | `location` | `ref` | ❌ | A strong reference to the location where this collection's activities were performed. The record referenced must conform with the lexicon app.certified.location. | |
87
+ | `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |
64
88
 
65
89
  #### Defs
66
90
 
67
- ##### score
91
+ ##### `org.hypercerts.claim.collection#item`
68
92
 
69
- | Property | Type | Required | Description |
70
- | -------- | --------- | -------- | -------------------------------------------- |
71
- | `min` | `integer` | ✅ | Minimum value of the scale, e.g. 0 or 1. |
72
- | `max` | `integer` | ✅ | Maximum value of the scale, e.g. 5 or 10. |
73
- | `value` | `integer` | ✅ | Score within the inclusive range [min, max]. |
93
+ | Property | Type | Required | Description |
94
+ | ---------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
95
+ | `itemIdentifier` | `ref` | ✅ | Strong reference to an item in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.claim.collection). |
96
+ | `itemWeight` | `string` | ❌ | 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. |
74
97
 
75
98
  ---
76
99
 
77
- ### `org.hypercerts.claim.evidence`
100
+ ### `org.hypercerts.claim.contributionDetails`
78
101
 
79
- **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.
102
+ **Description:** Details about a specific contribution including role, description, and timeframe.
80
103
 
81
104
  **Key:** `tid`
82
105
 
83
106
  #### Properties
84
107
 
85
- | Property | Type | Required | Description | Comments |
86
- | ------------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
87
- | `subject` | `ref` | ❌ | A strong reference to the record this evidence relates to (e.g. an activity, project, claim, or evaluation). | |
88
- | `content` | `union` | ✅ | A piece of evidence (URI or blob) related to the subject record; it may support, clarify, or challenge a hypercert claim. | |
89
- | `title` | `string` | ✅ | Title to describe the nature of the evidence. | maxLength: 256 |
90
- | `shortDescription` | `string` | ❌ | Short description explaining what this evidence shows. | maxLength: 3000, maxGraphemes: 300 |
91
- | `description` | `string` | ❌ | Longer description describing the evidence in more detail. | maxLength: 30000, maxGraphemes: 3000 |
92
- | `relationType` | `string` | ❌ | How this evidence relates to the subject. | Known values: `supports`, `challenges`, `clarifies` |
93
- | `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |
108
+ | Property | Type | Required | Description | Comments |
109
+ | ------------------------- | -------- | -------- | ------------------------------------------------------------------------------------ | ------------------------------------ |
110
+ | `role` | `string` | ❌ | Role or title of the contributor. | maxLength: 100 |
111
+ | `contributionDescription` | `string` | ❌ | What the contribution concretely was. | maxLength: 10000, maxGraphemes: 1000 |
112
+ | `startDate` | `string` | ❌ | When this contribution started. This should be a subset of the hypercert timeframe. | |
113
+ | `endDate` | `string` | ❌ | When this contribution finished. This should be a subset of the hypercert timeframe. | |
114
+ | `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created. | |
94
115
 
95
116
  ---
96
117
 
97
- ### `org.hypercerts.claim.measurement`
118
+ ### `org.hypercerts.claim.contributorInformation`
98
119
 
99
- **Description:** Measurement data related to a hypercert record (e.g. an activity and its impact).
120
+ **Description:** Contributor information including identifier, display name, and image.
100
121
 
101
122
  **Key:** `tid`
102
123
 
103
124
  #### Properties
104
125
 
105
- | Property | Type | Required | Description | Comments |
106
- | ------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
107
- | `subject` | `ref` | ❌ | A strong reference to the record this measurement refers to (e.g. an activity, project, or claim). | |
108
- | `measurers` | `ref` | ✅ | DIDs of the entity (or entities) that measured this data | maxLength: 100 |
109
- | `metric` | `string` | ✅ | The metric being measured | maxLength: 500 |
110
- | `value` | `string` | ✅ | The measured value | maxLength: 500 |
111
- | `methodType` | `string` | ❌ | Short identifier for the measurement methodology | maxLength: 30 |
112
- | `methodURI` | `string` | ❌ | URI to methodology documentation, standard protocol, or measurement procedure | |
113
- | `evidenceURI` | `string` | ❌ | URIs to related evidence or underlying data (e.g. org.hypercerts.claim.evidence records or raw datasets) | maxLength: 50 |
114
- | `location` | `ref` | ❌ | A strong reference to the location where the measurement was taken. The record referenced must conform with the lexicon app.certified.location | |
115
- | `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |
126
+ | Property | Type | Required | Description | Comments |
127
+ | ------------- | -------- | -------- | ------------------------------------------------------------------ | -------------- |
128
+ | `identifier` | `string` | ❌ | DID or a URI to a social profile of the contributor. | |
129
+ | `displayName` | `string` | ❌ | Display name of the contributor. | maxLength: 100 |
130
+ | `image` | `union` | ❌ | The contributor visual representation as a URI or image blob. | |
131
+ | `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created. | |
116
132
 
117
133
  ---
118
134
 
119
- ### `org.hypercerts.claim.collection`
135
+ ### `org.hypercerts.claim.evaluation`
120
136
 
121
- **Description:** A collection/group of items (activities and/or other collections). Collections support recursive nesting.
137
+ **Description:** An evaluation of a hypercert record (e.g. an activity and its impact).
122
138
 
123
139
  **Key:** `tid`
124
140
 
125
141
  #### Properties
126
142
 
127
- | Property | Type | Required | Description | Comments |
128
- | ------------------ | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
129
- | `type` | `string` | ❌ | The type of this collection. Possible fields can be 'favorites', 'project', or any other type of collection. | |
130
- | `title` | `string` | ✅ | The title of this collection | maxLength: 800, maxGraphemes: 80 |
131
- | `shortDescription` | `string` | ❌ | Short summary of this collection, suitable for previews and list views | maxLength: 3000, maxGraphemes: 300 |
132
- | `description` | `ref` | ❌ | Rich-text description, represented as a Leaflet linear document. | |
133
- | `avatar` | `union` | ❌ | The collection's avatar/profile image as a URI or image blob. | |
134
- | `banner` | `union` | ❌ | Larger horizontal image to display behind the collection view. | |
135
- | `items` | `ref` | ✅ | Array of items in this collection with optional weights. | |
136
- | `location` | `ref` | ❌ | A strong reference to the location where this collection's activities were performed. The record referenced must conform with the lexicon app.certified.location. | |
137
- | `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |
143
+ | Property | Type | Required | Description | Comments |
144
+ | -------------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
145
+ | `subject` | `ref` | ❌ | A strong reference to what is being evaluated. (e.g activity, measurement, contribution, etc.) | |
146
+ | `evaluators` | `ref` | ✅ | DIDs of the evaluators | maxLength: 1000 |
147
+ | `content` | `union` | ❌ | Evaluation data (URIs or blobs) containing detailed reports or methodology | maxLength: 100 |
148
+ | `measurements` | `ref` | ❌ | Optional references to the measurements that contributed to this evaluation. The record(s) referenced must conform with the lexicon org.hypercerts.claim.measurement | maxLength: 100 |
149
+ | `summary` | `string` | ✅ | Brief evaluation summary | maxLength: 5000, maxGraphemes: 1000 |
150
+ | `score` | `ref` | ❌ | Overall score for an evaluation on a numeric scale. | |
151
+ | `location` | `ref` | ❌ | An optional reference for georeferenced evaluations. The record referenced must conform with the lexicon app.certified.location. | |
152
+ | `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |
138
153
 
139
154
  #### Defs
140
155
 
141
- ##### item
156
+ ##### `org.hypercerts.claim.evaluation#score`
142
157
 
143
- | Property | Type | Required | Description |
144
- | ---------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
145
- | `itemIdentifier` | `ref` | ✅ | Strong reference to an item in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.claim.collection). |
146
- | `itemWeight` | `string` | ❌ | 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. |
158
+ | Property | Type | Required | Description |
159
+ | -------- | --------- | -------- | -------------------------------------------- |
160
+ | `min` | `integer` | ✅ | Minimum value of the scale, e.g. 0 or 1. |
161
+ | `max` | `integer` | ✅ | Maximum value of the scale, e.g. 5 or 10. |
162
+ | `value` | `integer` | ✅ | Score within the inclusive range [min, max]. |
163
+
164
+ ---
165
+
166
+ ### `org.hypercerts.claim.measurement`
167
+
168
+ **Description:** Measurement data related to a hypercert record (e.g. an activity and its impact).
169
+
170
+ **Key:** `tid`
171
+
172
+ #### Properties
173
+
174
+ | Property | Type | Required | Description | Comments |
175
+ | --------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
176
+ | `subject` | `ref` | ❌ | A strong reference to the record this measurement refers to (e.g. an activity, project, or claim). | |
177
+ | `metric` | `string` | ✅ | The metric being measured, e.g. forest area restored, number of users, etc. | maxLength: 500 |
178
+ | `unit` | `string` | ✅ | The unit of the measured value (e.g. kg CO₂e, hectares, %, index score). | maxLength: 50 |
179
+ | `value` | `string` | ✅ | The measured numeric value. | maxLength: 500 |
180
+ | `startDate` | `string` | ❌ | The start date and time when the measurement began. | |
181
+ | `endDate` | `string` | ❌ | The end date and time when the measurement ended. If it was a one time measurement, the endDate should be equal to the startDate. | |
182
+ | `locations` | `ref` | ❌ | Optional geographic references related to where the measurement was taken. Each referenced record must conform with the app.certified.location lexicon. | maxLength: 100 |
183
+ | `methodType` | `string` | ❌ | Short identifier for the measurement methodology | maxLength: 30 |
184
+ | `methodURI` | `string` | ❌ | URI to methodology documentation, standard protocol, or measurement procedure | |
185
+ | `evidenceURI` | `string` | ❌ | URIs to related evidence or underlying data (e.g. org.hypercerts.claim.evidence records or raw datasets) | maxLength: 50 |
186
+ | `measurers` | `ref` | ❌ | DIDs of the entity (or entities) that measured this data | maxLength: 100 |
187
+ | `comment` | `string` | ❌ | Short comment of this measurement, suitable for previews and list views. Rich text annotations may be provided via `commentFacets`. | maxLength: 3000, maxGraphemes: 300 |
188
+ | `commentFacets` | `ref` | ❌ | Rich text annotations for `comment` (mentions, URLs, hashtags, etc). | |
189
+ | `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |
147
190
 
148
191
  ---
149
192
 
@@ -189,30 +232,31 @@ Hypercerts-specific lexicons for tracking impact work and claims.
189
232
 
190
233
  ---
191
234
 
192
- ## Certified Lexicons
235
+ ### `org.hypercerts.helper.workScopeTag`
193
236
 
194
- Certified lexicons are common/shared lexicons that can be used across multiple protocols.
237
+ **Description:** A reusable scope atom for work scope logic expressions. Scopes can represent topics, languages, domains, deliverables, methods, regions, tags, or other categorical labels.
195
238
 
196
- ### `org.hypercerts.defs`
197
-
198
- **Description:** Common type definitions used across all certified protocols.
239
+ **Key:** `tid`
199
240
 
200
- #### Defs
241
+ #### Properties
201
242
 
202
- | Def | Type | Description | Comments |
203
- | --------------- | -------- | -------------------------------------------------------------- | --------------------------------------- |
204
- | `uri` | `object` | Object containing a URI to external data | Has `uri` property (string, format uri) |
205
- | `smallBlob` | `object` | Object containing a blob to external data | Has `blob` property (blob, up to 10MB) |
206
- | `largeBlob` | `object` | Object containing a blob to external data | Has `blob` property (blob, up to 100MB) |
207
- | `smallImage` | `object` | Object containing a small image | Has `image` property (blob, up to 5MB) |
208
- | `largeImage` | `object` | Object containing a large image | Has `image` property (blob, up to 10MB) |
209
- | `workScopeAll` | `object` | Logical AND operation: all arguments must be satisfied. | |
210
- | `workScopeAny` | `object` | Logical OR operation: at least one argument must be satisfied. | |
211
- | `workScopeNot` | `object` | Logical NOT operation: the argument must not be satisfied. | |
212
- | `workScopeAtom` | `object` | Atomic scope reference: a strong reference to a scope record. | |
243
+ | Property | Type | Required | Description | Comments |
244
+ | ------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------ | ------------------------------------ |
245
+ | `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |
246
+ | `key` | `string` | ✅ | Lowercase, hyphenated machine-readable key for this scope (e.g., 'ipfs', 'go-lang', 'filecoin'). | maxLength: 120 |
247
+ | `label` | `string` | ✅ | Human-readable label for this scope. | maxLength: 200 |
248
+ | `kind` | `string` | ❌ | Category type of this scope. Recommended values: topic, language, domain, method, tag. | maxLength: 50 |
249
+ | `description` | `string` | ❌ | Optional longer description of this scope. | maxLength: 10000, maxGraphemes: 1000 |
250
+ | `parent` | `ref` | ❌ | Optional strong reference to a parent scope record for taxonomy/hierarchy support. | |
251
+ | `aliases` | `string` | ❌ | Optional array of alternative names or identifiers for this scope. | maxLength: 50 |
252
+ | `externalReference` | `union` | ❌ | Optional external reference for this scope as a URI or blob. | |
213
253
 
214
254
  ---
215
255
 
256
+ ## Certified Lexicons
257
+
258
+ Certified lexicons are common/shared lexicons that can be used across multiple protocols.
259
+
216
260
  ### `app.certified.location`
217
261
 
218
262
  **Description:** A location reference
@@ -226,11 +270,19 @@ Certified lexicons are common/shared lexicons that can be used across multiple p
226
270
  | `lpVersion` | `string` | ✅ | The version of the Location Protocol | maxLength: 10 |
227
271
  | `srs` | `string` | ✅ | The Spatial Reference System URI (e.g., http://www.opengis.net/def/crs/OGC/1.3/CRS84) that defines the coordinate system. | maxLength: 100 |
228
272
  | `locationType` | `string` | ✅ | An identifier for the format of the location data (e.g., coordinate-decimal, geojson-point) | maxLength: 20, Known values: `coordinate-decimal`, `geojson-point` |
229
- | `location` | `union` | ✅ | The location of where the work was performed as a URI or blob. | |
273
+ | `location` | `union` | ✅ | The location of where the work was performed as a URI, blob, or inline string. | |
230
274
  | `name` | `string` | ❌ | Optional name for this location | maxLength: 1000, maxGraphemes: 100 |
231
275
  | `description` | `string` | ❌ | Optional description for this location | maxLength: 2000, maxGraphemes: 500 |
232
276
  | `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |
233
277
 
278
+ #### Defs
279
+
280
+ ##### `app.certified.location#string`
281
+
282
+ | Property | Type | Required | Description |
283
+ | -------- | -------- | -------- | ------------------------- |
284
+ | `string` | `string` | ✅ | The location string value |
285
+
234
286
  ---
235
287
 
236
288
  ### `app.certified.badge.definition`
@@ -286,6 +338,62 @@ Certified lexicons are common/shared lexicons that can be used across multiple p
286
338
 
287
339
  ---
288
340
 
341
+ ### `app.certified.defs`
342
+
343
+ **Description:** Common type definitions used across certified protocols.
344
+
345
+ ---
346
+
347
+ ## Type Definitions
348
+
349
+ Common type definitions used across all protocols.
350
+
351
+ ### `org.hypercerts.defs`
352
+
353
+ #### Defs
354
+
355
+ ##### `org.hypercerts.defs#uri`
356
+
357
+ | Property | Type | Required | Description |
358
+ | -------- | -------- | -------- | -------------------- |
359
+ | `uri` | `string` | ✅ | URI to external data |
360
+
361
+ ##### `org.hypercerts.defs#smallBlob`
362
+
363
+ | Property | Type | Required | Description |
364
+ | -------- | ------ | -------- | ---------------------------------- |
365
+ | `blob` | `blob` | ✅ | Blob to external data (up to 10MB) |
366
+
367
+ ##### `org.hypercerts.defs#largeBlob`
368
+
369
+ | Property | Type | Required | Description |
370
+ | -------- | ------ | -------- | ----------------------------------- |
371
+ | `blob` | `blob` | ✅ | Blob to external data (up to 100MB) |
372
+
373
+ ##### `org.hypercerts.defs#smallImage`
374
+
375
+ | Property | Type | Required | Description |
376
+ | -------- | ------ | -------- | ----------------- |
377
+ | `image` | `blob` | ✅ | Image (up to 5MB) |
378
+
379
+ ##### `org.hypercerts.defs#largeImage`
380
+
381
+ | Property | Type | Required | Description |
382
+ | -------- | ------ | -------- | ------------------ |
383
+ | `image` | `blob` | ✅ | Image (up to 10MB) |
384
+
385
+ ---
386
+
387
+ ## External Lexicons
388
+
389
+ External lexicons from other protocols and systems.
390
+
391
+ ### `com.atproto.repo.strongRef`
392
+
393
+ **Key:** `tid`
394
+
395
+ ---
396
+
289
397
  ## Notes
290
398
 
291
399
  - All timestamps use the `datetime` format (ISO 8601)