@hypercerts-org/lexicon 0.10.0-beta.4 → 0.10.0-beta.6
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.
- package/CHANGELOG.md +82 -0
- package/README.md +66 -311
- package/SCHEMAS.md +284 -0
- package/dist/exports.d.ts +76 -118
- package/dist/exports.d.ts.map +1 -1
- package/dist/generated/exports.d.ts +76 -118
- package/dist/generated/exports.d.ts.map +1 -1
- package/dist/generated/lexicons.d.ts +182 -266
- package/dist/generated/lexicons.d.ts.map +1 -1
- package/dist/generated/types/org/hypercerts/claim/activity.d.ts +21 -18
- package/dist/generated/types/org/hypercerts/claim/activity.d.ts.map +1 -1
- package/dist/generated/types/org/hypercerts/claim/collection.d.ts +9 -9
- package/dist/generated/types/org/hypercerts/claim/collection.d.ts.map +1 -1
- package/dist/generated/types/org/hypercerts/claim/{contribution.d.ts → contributionDetails.d.ts} +8 -10
- package/dist/generated/types/org/hypercerts/claim/contributionDetails.d.ts.map +1 -0
- package/dist/generated/types/org/hypercerts/claim/contributorInformation.d.ts +23 -0
- package/dist/generated/types/org/hypercerts/claim/contributorInformation.d.ts.map +1 -0
- package/dist/index.cjs +270 -357
- package/dist/index.cjs.map +1 -1
- package/dist/index.mjs +263 -350
- package/dist/index.mjs.map +1 -1
- package/dist/lexicons.cjs +102 -141
- package/dist/lexicons.cjs.map +1 -1
- package/dist/lexicons.d.ts +182 -266
- package/dist/lexicons.d.ts.map +1 -1
- package/dist/lexicons.mjs +102 -141
- package/dist/lexicons.mjs.map +1 -1
- package/dist/types/org/hypercerts/claim/activity.d.ts +21 -18
- package/dist/types/org/hypercerts/claim/activity.d.ts.map +1 -1
- package/dist/types/org/hypercerts/claim/collection.d.ts +9 -9
- package/dist/types/org/hypercerts/claim/collection.d.ts.map +1 -1
- package/dist/types/org/hypercerts/claim/{contribution.d.ts → contributionDetails.d.ts} +8 -10
- package/dist/types/org/hypercerts/claim/contributionDetails.d.ts.map +1 -0
- package/dist/types/org/hypercerts/claim/contributorInformation.d.ts +23 -0
- package/dist/types/org/hypercerts/claim/contributorInformation.d.ts.map +1 -0
- package/lexicons/org/hypercerts/claim/activity.json +29 -39
- package/lexicons/org/hypercerts/claim/collection.json +14 -17
- package/lexicons/org/hypercerts/claim/contributionDetails.json +43 -0
- package/lexicons/org/hypercerts/claim/contributorInformation.json +39 -0
- package/lexicons/org/hypercerts/claim/evaluation.json +1 -1
- package/package.json +6 -2
- package/dist/generated/types/org/hypercerts/claim/contribution.d.ts.map +0 -1
- package/dist/generated/types/org/hypercerts/claim/project.d.ts +0 -29
- package/dist/generated/types/org/hypercerts/claim/project.d.ts.map +0 -1
- package/dist/types/org/hypercerts/claim/contribution.d.ts.map +0 -1
- package/dist/types/org/hypercerts/claim/project.d.ts +0 -29
- package/dist/types/org/hypercerts/claim/project.d.ts.map +0 -1
- package/lexicons/org/hypercerts/claim/contribution.json +0 -50
- package/lexicons/org/hypercerts/claim/project.json +0 -64
package/SCHEMAS.md
ADDED
|
@@ -0,0 +1,284 @@
|
|
|
1
|
+
# Schema Reference
|
|
2
|
+
|
|
3
|
+
> This file is auto-generated from lexicon definitions.
|
|
4
|
+
> Do not edit manually.
|
|
5
|
+
|
|
6
|
+
## Hypercerts Lexicons
|
|
7
|
+
|
|
8
|
+
Hypercerts-specific lexicons for tracking impact work and claims.
|
|
9
|
+
|
|
10
|
+
### `org.hypercerts.claim.activity`
|
|
11
|
+
|
|
12
|
+
**Description:** A hypercert record tracking impact work.
|
|
13
|
+
|
|
14
|
+
**Key:** `any`
|
|
15
|
+
|
|
16
|
+
#### Properties
|
|
17
|
+
|
|
18
|
+
| Property | Type | Required | Description | Comments |
|
|
19
|
+
| ------------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
|
|
20
|
+
| `title` | `string` | yes | Title of the hypercert. | maxLength: 256 |
|
|
21
|
+
| `shortDescription` | `string` | yes | Short blurb of the impact work done. | maxLength: 3000, maxGraphemes: 300 |
|
|
22
|
+
| `description` | `string` | no | Optional longer description of the impact work done. | maxLength: 30000, maxGraphemes: 3000 |
|
|
23
|
+
| `image` | `union` | no | The hypercert visual representation as a URI or image blob. | |
|
|
24
|
+
| `workScope` | `ref` | no | A strong reference to a record defining the scope of work. The record referenced should describe the logical scope using label-based conditions. | |
|
|
25
|
+
| `startDate` | `string` | no | When the work began | |
|
|
26
|
+
| `endDate` | `string` | no | When the work ended | |
|
|
27
|
+
| `contributors` | `ref` | no | An array of contributor objects, each containing contributor information, weight, and contribution details. | |
|
|
28
|
+
| `rights` | `ref` | no | A strong reference to the rights that this hypercert has. The record referenced must conform with the lexicon org.hypercerts.claim.rights. | |
|
|
29
|
+
| `locations` | `ref` | no | An array of strong references to the location where activity was performed. The record referenced must conform with the lexicon app.certified.location. | |
|
|
30
|
+
| `createdAt` | `string` | yes | Client-declared timestamp when this record was originally created | |
|
|
31
|
+
|
|
32
|
+
#### Defs
|
|
33
|
+
|
|
34
|
+
##### contributor
|
|
35
|
+
|
|
36
|
+
| Property | Type | Required | Description |
|
|
37
|
+
| ------------------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
38
|
+
| `contributorInformation` | `union` | yes | Contributor information as a string (DID or identifier) or strong reference to for instance org.hypercerts.claim.contributorInformation#main. |
|
|
39
|
+
| `weight` | `string` | no | 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. |
|
|
40
|
+
| `contributionDetails` | `union` | no | Contribution details as a string or strong reference to org.hypercerts.claim.contributionDetails#main. |
|
|
41
|
+
|
|
42
|
+
##### activityWeight
|
|
43
|
+
|
|
44
|
+
| Property | Type | Required | Description |
|
|
45
|
+
| ---------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
46
|
+
| `activity` | `ref` | yes | A strong reference to a hypercert activity record. This activity must conform to the lexicon org.hypercerts.claim.activity |
|
|
47
|
+
| `weight` | `string` | yes | 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. |
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
### `org.hypercerts.claim.evaluation`
|
|
52
|
+
|
|
53
|
+
**Description:** An evaluation of a hypercert record (e.g. an activity and its impact).
|
|
54
|
+
|
|
55
|
+
**Key:** `tid`
|
|
56
|
+
|
|
57
|
+
#### Properties
|
|
58
|
+
|
|
59
|
+
| Property | Type | Required | Description | Comments |
|
|
60
|
+
| -------------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
|
|
61
|
+
| `subject` | `ref` | no | A strong reference to what is being evaluated. (e.g activity, measurement, contribution, etc.) | |
|
|
62
|
+
| `evaluators` | `ref` | yes | DIDs of the evaluators | maxLength: 1000 |
|
|
63
|
+
| `content` | `union` | no | Evaluation data (URIs or blobs) containing detailed reports or methodology | maxLength: 100 |
|
|
64
|
+
| `measurements` | `ref` | no | 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 |
|
|
65
|
+
| `summary` | `string` | yes | Brief evaluation summary | maxLength: 5000, maxGraphemes: 1000 |
|
|
66
|
+
| `score` | `ref` | no | Overall score for an evaluation on a numeric scale. | |
|
|
67
|
+
| `location` | `ref` | no | An optional reference for georeferenced evaluations. The record referenced must conform with the lexicon app.certified.location. | |
|
|
68
|
+
| `createdAt` | `string` | yes | Client-declared timestamp when this record was originally created | |
|
|
69
|
+
|
|
70
|
+
#### Defs
|
|
71
|
+
|
|
72
|
+
##### score
|
|
73
|
+
|
|
74
|
+
| Property | Type | Required | Description |
|
|
75
|
+
| -------- | --------- | -------- | -------------------------------------------- |
|
|
76
|
+
| `min` | `integer` | yes | Minimum value of the scale, e.g. 0 or 1. |
|
|
77
|
+
| `max` | `integer` | yes | Maximum value of the scale, e.g. 5 or 10. |
|
|
78
|
+
| `value` | `integer` | yes | Score within the inclusive range [min, max]. |
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
### `org.hypercerts.claim.evidence`
|
|
83
|
+
|
|
84
|
+
**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.
|
|
85
|
+
|
|
86
|
+
**Key:** `tid`
|
|
87
|
+
|
|
88
|
+
#### Properties
|
|
89
|
+
|
|
90
|
+
| Property | Type | Required | Description | Comments |
|
|
91
|
+
| ------------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
|
|
92
|
+
| `subject` | `ref` | no | A strong reference to the record this evidence relates to (e.g. an activity, project, claim, or evaluation). | |
|
|
93
|
+
| `content` | `union` | yes | A piece of evidence (URI or blob) related to the subject record; it may support, clarify, or challenge a hypercert claim. | |
|
|
94
|
+
| `title` | `string` | yes | Title to describe the nature of the evidence. | maxLength: 256 |
|
|
95
|
+
| `shortDescription` | `string` | no | Short description explaining what this evidence shows. | maxLength: 3000, maxGraphemes: 300 |
|
|
96
|
+
| `description` | `string` | no | Longer description describing the evidence in more detail. | maxLength: 30000, maxGraphemes: 3000 |
|
|
97
|
+
| `relationType` | `string` | no | How this evidence relates to the subject. | Known values: `supports`, `challenges`, `clarifies` |
|
|
98
|
+
| `createdAt` | `string` | yes | Client-declared timestamp when this record was originally created | |
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
### `org.hypercerts.claim.measurement`
|
|
103
|
+
|
|
104
|
+
**Description:** Measurement data related to a hypercert record (e.g. an activity and its impact).
|
|
105
|
+
|
|
106
|
+
**Key:** `tid`
|
|
107
|
+
|
|
108
|
+
#### Properties
|
|
109
|
+
|
|
110
|
+
| Property | Type | Required | Description | Comments |
|
|
111
|
+
| ------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
|
|
112
|
+
| `subject` | `ref` | no | A strong reference to the record this measurement refers to (e.g. an activity, project, or claim). | |
|
|
113
|
+
| `measurers` | `ref` | yes | DIDs of the entity (or entities) that measured this data | maxLength: 100 |
|
|
114
|
+
| `metric` | `string` | yes | The metric being measured | maxLength: 500 |
|
|
115
|
+
| `value` | `string` | yes | The measured value | maxLength: 500 |
|
|
116
|
+
| `methodType` | `string` | no | Short identifier for the measurement methodology | maxLength: 30 |
|
|
117
|
+
| `methodURI` | `string` | no | URI to methodology documentation, standard protocol, or measurement procedure | |
|
|
118
|
+
| `evidenceURI` | `string` | no | URIs to related evidence or underlying data (e.g. org.hypercerts.claim.evidence records or raw datasets) | maxLength: 50 |
|
|
119
|
+
| `location` | `ref` | no | A strong reference to the location where the measurement was taken. The record referenced must conform with the lexicon app.certified.location | |
|
|
120
|
+
| `createdAt` | `string` | yes | Client-declared timestamp when this record was originally created | |
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
### `org.hypercerts.claim.collection`
|
|
125
|
+
|
|
126
|
+
**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.
|
|
127
|
+
|
|
128
|
+
**Key:** `tid`
|
|
129
|
+
|
|
130
|
+
#### Properties
|
|
131
|
+
|
|
132
|
+
| Property | Type | Required | Description | Comments |
|
|
133
|
+
| ------------------ | -------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
|
|
134
|
+
| `type` | `string` | no | The type of this collection. Possible fields can be 'favorites', 'project', or any other type of collection. | |
|
|
135
|
+
| `title` | `string` | yes | The title of this collection | maxLength: 800, maxGraphemes: 80 |
|
|
136
|
+
| `shortDescription` | `string` | no | Short summary of this collection, suitable for previews and list views | maxLength: 3000, maxGraphemes: 300 |
|
|
137
|
+
| `description` | `ref` | no | Rich-text description, represented as a Leaflet linear document. | |
|
|
138
|
+
| `items` | `ref` | yes | 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). | |
|
|
139
|
+
| `createdAt` | `string` | yes | Client-declared timestamp when this record was originally created | |
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
|
|
143
|
+
### `org.hypercerts.claim.rights`
|
|
144
|
+
|
|
145
|
+
**Description:** Describes the rights that a contributor and/or an owner has, such as whether the hypercert can be sold, transferred, and under what conditions.
|
|
146
|
+
|
|
147
|
+
**Key:** `tid`
|
|
148
|
+
|
|
149
|
+
#### Properties
|
|
150
|
+
|
|
151
|
+
| Property | Type | Required | Description | Comments |
|
|
152
|
+
| ------------------- | -------- | -------- | ------------------------------------------------------------------ | -------------- |
|
|
153
|
+
| `rightsName` | `string` | yes | Full name of the rights | maxLength: 100 |
|
|
154
|
+
| `rightsType` | `string` | yes | Short rights identifier for easier search | maxLength: 10 |
|
|
155
|
+
| `rightsDescription` | `string` | yes | Description of the rights of this hypercert | |
|
|
156
|
+
| `attachment` | `union` | no | An attachment to define the rights further, e.g. a legal document. | |
|
|
157
|
+
| `createdAt` | `string` | yes | Client-declared timestamp when this record was originally created | |
|
|
158
|
+
|
|
159
|
+
---
|
|
160
|
+
|
|
161
|
+
### `org.hypercerts.funding.receipt`
|
|
162
|
+
|
|
163
|
+
**Description:** Records a funding receipt for a payment from one user to another user. It may be recorded by the recipient, by the sender, or by a third party. The sender may remain anonymous.
|
|
164
|
+
|
|
165
|
+
**Key:** `tid`
|
|
166
|
+
|
|
167
|
+
#### Properties
|
|
168
|
+
|
|
169
|
+
| Property | Type | Required | Description | Comments |
|
|
170
|
+
| ---------------- | -------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
|
|
171
|
+
| `from` | `ref` | yes | DID of the sender who transferred the funds. Leave empty if sender wants to stay anonymous. | |
|
|
172
|
+
| `to` | `string` | yes | The recipient of the funds. Can be identified by DID or a clear-text name. | |
|
|
173
|
+
| `amount` | `string` | yes | Amount of funding received. | |
|
|
174
|
+
| `currency` | `string` | yes | Currency of the payment (e.g. EUR, USD, ETH). | |
|
|
175
|
+
| `paymentRail` | `string` | no | How the funds were transferred (e.g. bank_transfer, credit_card, onchain, cash, check, payment_processor). | |
|
|
176
|
+
| `paymentNetwork` | `string` | no | Optional network within the payment rail (e.g. arbitrum, ethereum, sepa, visa, paypal). | |
|
|
177
|
+
| `transactionId` | `string` | no | 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. | |
|
|
178
|
+
| `for` | `string` | no | Optional reference to the activity, project, or organization this funding relates to. | |
|
|
179
|
+
| `notes` | `string` | no | Optional notes or additional context for this funding receipt. | maxLength: 500 |
|
|
180
|
+
| `occurredAt` | `string` | no | Timestamp when the payment occurred. | |
|
|
181
|
+
| `createdAt` | `string` | yes | Client-declared timestamp when this receipt record was created. | |
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
## Certified Lexicons
|
|
186
|
+
|
|
187
|
+
Certified lexicons are common/shared lexicons that can be used across multiple protocols.
|
|
188
|
+
|
|
189
|
+
### `org.hypercerts.defs`
|
|
190
|
+
|
|
191
|
+
**Description:** Common type definitions used across all certified protocols.
|
|
192
|
+
|
|
193
|
+
#### Defs
|
|
194
|
+
|
|
195
|
+
| Def | Type | Description | Comments |
|
|
196
|
+
| ------------ | -------- | ----------------------------------------- | --------------------------------------- |
|
|
197
|
+
| `uri` | `object` | Object containing a URI to external data | Has `uri` property (string, format uri) |
|
|
198
|
+
| `smallBlob` | `object` | Object containing a blob to external data | Has `blob` property (blob, up to 10MB) |
|
|
199
|
+
| `largeBlob` | `object` | Object containing a blob to external data | Has `blob` property (blob, up to 100MB) |
|
|
200
|
+
| `smallImage` | `object` | Object containing a small image | Has `image` property (blob, up to 5MB) |
|
|
201
|
+
| `largeImage` | `object` | Object containing a large image | Has `image` property (blob, up to 10MB) |
|
|
202
|
+
|
|
203
|
+
---
|
|
204
|
+
|
|
205
|
+
### `app.certified.location`
|
|
206
|
+
|
|
207
|
+
**Description:** A location reference
|
|
208
|
+
|
|
209
|
+
**Key:** `tid`
|
|
210
|
+
|
|
211
|
+
#### Properties
|
|
212
|
+
|
|
213
|
+
| Property | Type | Required | Description | Comments |
|
|
214
|
+
| -------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
|
215
|
+
| `lpVersion` | `string` | yes | The version of the Location Protocol | maxLength: 10 |
|
|
216
|
+
| `srs` | `string` | yes | The Spatial Reference System URI (e.g., http://www.opengis.net/def/crs/OGC/1.3/CRS84) that defines the coordinate system. | maxLength: 100 |
|
|
217
|
+
| `locationType` | `string` | yes | An identifier for the format of the location data (e.g., coordinate-decimal, geojson-point) | maxLength: 20, Known values: `coordinate-decimal`, `geojson-point` |
|
|
218
|
+
| `location` | `union` | yes | The location of where the work was performed as a URI or blob. | |
|
|
219
|
+
| `name` | `string` | no | Optional name for this location | maxLength: 1000, maxGraphemes: 100 |
|
|
220
|
+
| `description` | `string` | no | Optional description for this location | maxLength: 2000, maxGraphemes: 500 |
|
|
221
|
+
| `createdAt` | `string` | yes | Client-declared timestamp when this record was originally created | |
|
|
222
|
+
|
|
223
|
+
---
|
|
224
|
+
|
|
225
|
+
### `app.certified.badge.definition`
|
|
226
|
+
|
|
227
|
+
**Description:** Defines a badge that can be awarded via badge award records to users, projects, or activity claims.
|
|
228
|
+
|
|
229
|
+
**Key:** `tid`
|
|
230
|
+
|
|
231
|
+
#### Properties
|
|
232
|
+
|
|
233
|
+
| Property | Type | Required | Description | Comments |
|
|
234
|
+
| ---------------- | -------- | -------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
|
|
235
|
+
| `badgeType` | `string` | yes | Category of the badge (e.g. endorsement, participation, affiliation). | |
|
|
236
|
+
| `title` | `string` | yes | Human-readable title of the badge. | |
|
|
237
|
+
| `icon` | `blob` | yes | Icon representing the badge, stored as a blob for compact visual display. | maxSize: 1048576, accepts: image/png, image/jpeg, image/webp, image/svg+xml |
|
|
238
|
+
| `description` | `string` | no | Optional short statement describing what the badge represents. | |
|
|
239
|
+
| `allowedIssuers` | `ref` | no | Optional allowlist of DIDs allowed to issue this badge. If omitted, anyone may issue it. | |
|
|
240
|
+
| `createdAt` | `string` | yes | Client-declared timestamp when this record was originally created | |
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
### `app.certified.badge.award`
|
|
245
|
+
|
|
246
|
+
**Description:** Records a badge award to a user, project, or activity claim.
|
|
247
|
+
|
|
248
|
+
**Key:** `tid`
|
|
249
|
+
|
|
250
|
+
#### Properties
|
|
251
|
+
|
|
252
|
+
| Property | Type | Required | Description |
|
|
253
|
+
| ----------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
254
|
+
| `badge` | `ref` | yes | Reference to the badge definition for this award. |
|
|
255
|
+
| `subject` | `union` | yes | Entity the badge award is for (either an account DID or any specific AT Protocol record), e.g. a user, a project, or a specific activity claim. |
|
|
256
|
+
| `note` | `string` | no | Optional statement explaining the reason for this badge award. |
|
|
257
|
+
| `createdAt` | `string` | yes | Client-declared timestamp when this record was originally created |
|
|
258
|
+
|
|
259
|
+
---
|
|
260
|
+
|
|
261
|
+
### `app.certified.badge.response`
|
|
262
|
+
|
|
263
|
+
**Description:** Recipient response to a badge award.
|
|
264
|
+
|
|
265
|
+
**Key:** `tid`
|
|
266
|
+
|
|
267
|
+
#### Properties
|
|
268
|
+
|
|
269
|
+
| Property | Type | Required | Description |
|
|
270
|
+
| ------------ | -------- | -------- | ------------------------------------------------------------------------ |
|
|
271
|
+
| `badgeAward` | `ref` | yes | Reference to the badge award. |
|
|
272
|
+
| `response` | `string` | yes | The recipient’s response for the badge (accepted or rejected). |
|
|
273
|
+
| `weight` | `string` | no | Optional relative weight for accepted badges, assigned by the recipient. |
|
|
274
|
+
| `createdAt` | `string` | yes | Client-declared timestamp when this record was originally created |
|
|
275
|
+
|
|
276
|
+
---
|
|
277
|
+
|
|
278
|
+
## Notes
|
|
279
|
+
|
|
280
|
+
- All timestamps use the `datetime` format (ISO 8601)
|
|
281
|
+
- Strong references (`com.atproto.repo.strongRef`) include both the URI and CID of the referenced record
|
|
282
|
+
- Union types allow multiple possible formats (e.g., URI or blob)
|
|
283
|
+
- Array items may have constraints like `maxLength` to limit the number of elements
|
|
284
|
+
- String fields may have both `maxLength` (bytes) and `maxGraphemes` (Unicode grapheme clusters) constraints
|
package/dist/exports.d.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* ⚠️ DO NOT EDIT THIS FILE MANUALLY ⚠️
|
|
5
5
|
*
|
|
6
6
|
* This file is automatically generated by scripts/generate-exports.js
|
|
7
|
-
* Generated: 2026-01-
|
|
7
|
+
* Generated: 2026-01-21T07:15:37.790Z
|
|
8
8
|
*
|
|
9
9
|
* To regenerate this file, run:
|
|
10
10
|
* npm run gen-api
|
|
@@ -29,15 +29,15 @@ import LOCATION_LEXICON_JSON from "../lexicons/app/certified/location.json";
|
|
|
29
29
|
import STRONGREF_LEXICON_JSON from "../lexicons/com/atproto/repo/strongRef.json";
|
|
30
30
|
import ACTIVITY_LEXICON_JSON from "../lexicons/org/hypercerts/claim/activity.json";
|
|
31
31
|
import COLLECTION_LEXICON_JSON from "../lexicons/org/hypercerts/claim/collection.json";
|
|
32
|
-
import
|
|
32
|
+
import CONTRIBUTIONDETAILS_LEXICON_JSON from "../lexicons/org/hypercerts/claim/contributionDetails.json";
|
|
33
|
+
import CONTRIBUTORINFORMATION_LEXICON_JSON from "../lexicons/org/hypercerts/claim/contributorInformation.json";
|
|
33
34
|
import EVALUATION_LEXICON_JSON from "../lexicons/org/hypercerts/claim/evaluation.json";
|
|
34
35
|
import EVIDENCE_LEXICON_JSON from "../lexicons/org/hypercerts/claim/evidence.json";
|
|
35
36
|
import MEASUREMENT_LEXICON_JSON from "../lexicons/org/hypercerts/claim/measurement.json";
|
|
36
|
-
import PROJECT_LEXICON_JSON from "../lexicons/org/hypercerts/claim/project.json";
|
|
37
37
|
import RIGHTS_LEXICON_JSON from "../lexicons/org/hypercerts/claim/rights.json";
|
|
38
38
|
import HYPERCERTS_DEFS_LEXICON_JSON from "../lexicons/org/hypercerts/defs.json";
|
|
39
39
|
import FUNDING_RECEIPT_LEXICON_JSON from "../lexicons/org/hypercerts/funding/receipt.json";
|
|
40
|
-
export { BADGE_AWARD_LEXICON_JSON, BADGE_DEFINITION_LEXICON_JSON, BADGE_RESPONSE_LEXICON_JSON, CERTIFIED_DEFS_LEXICON_JSON, LOCATION_LEXICON_JSON, STRONGREF_LEXICON_JSON, ACTIVITY_LEXICON_JSON, COLLECTION_LEXICON_JSON,
|
|
40
|
+
export { BADGE_AWARD_LEXICON_JSON, BADGE_DEFINITION_LEXICON_JSON, BADGE_RESPONSE_LEXICON_JSON, CERTIFIED_DEFS_LEXICON_JSON, LOCATION_LEXICON_JSON, STRONGREF_LEXICON_JSON, ACTIVITY_LEXICON_JSON, COLLECTION_LEXICON_JSON, CONTRIBUTIONDETAILS_LEXICON_JSON, CONTRIBUTORINFORMATION_LEXICON_JSON, EVALUATION_LEXICON_JSON, EVIDENCE_LEXICON_JSON, MEASUREMENT_LEXICON_JSON, RIGHTS_LEXICON_JSON, HYPERCERTS_DEFS_LEXICON_JSON, FUNDING_RECEIPT_LEXICON_JSON, };
|
|
41
41
|
export { schemas as HYPERCERTS_SCHEMAS, schemaDict as HYPERCERTS_SCHEMA_DICT, lexicons, validate, ids as HYPERCERTS_NSIDS_BY_TYPE, } from "./lexicons.js";
|
|
42
42
|
export declare const BADGE_AWARD_NSID: "app.certified.badge.award";
|
|
43
43
|
export declare const BADGE_DEFINITION_NSID: "app.certified.badge.definition";
|
|
@@ -47,11 +47,11 @@ export declare const LOCATION_NSID: "app.certified.location";
|
|
|
47
47
|
export declare const STRONGREF_NSID: "com.atproto.repo.strongRef";
|
|
48
48
|
export declare const ACTIVITY_NSID: "org.hypercerts.claim.activity";
|
|
49
49
|
export declare const COLLECTION_NSID: "org.hypercerts.claim.collection";
|
|
50
|
-
export declare const
|
|
50
|
+
export declare const CONTRIBUTIONDETAILS_NSID: "org.hypercerts.claim.contributionDetails";
|
|
51
|
+
export declare const CONTRIBUTORINFORMATION_NSID: "org.hypercerts.claim.contributorInformation";
|
|
51
52
|
export declare const EVALUATION_NSID: "org.hypercerts.claim.evaluation";
|
|
52
53
|
export declare const EVIDENCE_NSID: "org.hypercerts.claim.evidence";
|
|
53
54
|
export declare const MEASUREMENT_NSID: "org.hypercerts.claim.measurement";
|
|
54
|
-
export declare const PROJECT_NSID: "org.hypercerts.claim.project";
|
|
55
55
|
export declare const RIGHTS_NSID: "org.hypercerts.claim.rights";
|
|
56
56
|
export declare const HYPERCERTS_DEFS_NSID: "org.hypercerts.defs";
|
|
57
57
|
export declare const FUNDING_RECEIPT_NSID: "org.hypercerts.funding.receipt";
|
|
@@ -70,11 +70,11 @@ export declare const HYPERCERTS_NSIDS: {
|
|
|
70
70
|
readonly STRONGREF: "com.atproto.repo.strongRef";
|
|
71
71
|
readonly ACTIVITY: "org.hypercerts.claim.activity";
|
|
72
72
|
readonly COLLECTION: "org.hypercerts.claim.collection";
|
|
73
|
-
readonly
|
|
73
|
+
readonly CONTRIBUTIONDETAILS: "org.hypercerts.claim.contributionDetails";
|
|
74
|
+
readonly CONTRIBUTORINFORMATION: "org.hypercerts.claim.contributorInformation";
|
|
74
75
|
readonly EVALUATION: "org.hypercerts.claim.evaluation";
|
|
75
76
|
readonly EVIDENCE: "org.hypercerts.claim.evidence";
|
|
76
77
|
readonly MEASUREMENT: "org.hypercerts.claim.measurement";
|
|
77
|
-
readonly PROJECT: "org.hypercerts.claim.project";
|
|
78
78
|
readonly RIGHTS: "org.hypercerts.claim.rights";
|
|
79
79
|
readonly HYPERCERTS_DEFS: "org.hypercerts.defs";
|
|
80
80
|
readonly FUNDING_RECEIPT: "org.hypercerts.funding.receipt";
|
|
@@ -329,6 +329,7 @@ export declare const HYPERCERTS_LEXICON_JSON: {
|
|
|
329
329
|
workScope: {
|
|
330
330
|
type: string;
|
|
331
331
|
ref: string;
|
|
332
|
+
description: string;
|
|
332
333
|
};
|
|
333
334
|
startDate: {
|
|
334
335
|
type: string;
|
|
@@ -340,7 +341,7 @@ export declare const HYPERCERTS_LEXICON_JSON: {
|
|
|
340
341
|
format: string;
|
|
341
342
|
description: string;
|
|
342
343
|
};
|
|
343
|
-
|
|
344
|
+
contributors: {
|
|
344
345
|
type: string;
|
|
345
346
|
description: string;
|
|
346
347
|
items: {
|
|
@@ -361,11 +362,6 @@ export declare const HYPERCERTS_LEXICON_JSON: {
|
|
|
361
362
|
ref: string;
|
|
362
363
|
};
|
|
363
364
|
};
|
|
364
|
-
project: {
|
|
365
|
-
type: string;
|
|
366
|
-
format: string;
|
|
367
|
-
description: string;
|
|
368
|
-
};
|
|
369
365
|
createdAt: {
|
|
370
366
|
type: string;
|
|
371
367
|
format: string;
|
|
@@ -374,36 +370,36 @@ export declare const HYPERCERTS_LEXICON_JSON: {
|
|
|
374
370
|
};
|
|
375
371
|
};
|
|
376
372
|
};
|
|
377
|
-
|
|
373
|
+
contributor: {
|
|
378
374
|
type: string;
|
|
379
|
-
|
|
375
|
+
required: string[];
|
|
380
376
|
properties: {
|
|
381
|
-
|
|
377
|
+
contributorInformation: {
|
|
382
378
|
type: string;
|
|
379
|
+
refs: string[];
|
|
383
380
|
description: string;
|
|
384
|
-
items: {
|
|
385
|
-
type: string;
|
|
386
|
-
};
|
|
387
|
-
maxLength: number;
|
|
388
381
|
};
|
|
389
|
-
|
|
382
|
+
weight: {
|
|
390
383
|
type: string;
|
|
391
384
|
description: string;
|
|
392
|
-
items: {
|
|
393
|
-
type: string;
|
|
394
|
-
};
|
|
395
|
-
maxLength: number;
|
|
396
385
|
};
|
|
397
|
-
|
|
386
|
+
contributionDetails: {
|
|
398
387
|
type: string;
|
|
388
|
+
refs: string[];
|
|
399
389
|
description: string;
|
|
400
|
-
items: {
|
|
401
|
-
type: string;
|
|
402
|
-
};
|
|
403
|
-
maxLength: number;
|
|
404
390
|
};
|
|
405
391
|
};
|
|
406
392
|
};
|
|
393
|
+
contributorIdentity: {
|
|
394
|
+
type: string;
|
|
395
|
+
description: string;
|
|
396
|
+
};
|
|
397
|
+
contributorRole: {
|
|
398
|
+
type: string;
|
|
399
|
+
description: string;
|
|
400
|
+
maxLength: number;
|
|
401
|
+
maxGraphemes: number;
|
|
402
|
+
};
|
|
407
403
|
activityWeight: {
|
|
408
404
|
type: string;
|
|
409
405
|
required: string[];
|
|
@@ -433,6 +429,10 @@ export declare const HYPERCERTS_LEXICON_JSON: {
|
|
|
433
429
|
type: string;
|
|
434
430
|
required: string[];
|
|
435
431
|
properties: {
|
|
432
|
+
type: {
|
|
433
|
+
type: string;
|
|
434
|
+
description: string;
|
|
435
|
+
};
|
|
436
436
|
title: {
|
|
437
437
|
type: string;
|
|
438
438
|
description: string;
|
|
@@ -445,19 +445,12 @@ export declare const HYPERCERTS_LEXICON_JSON: {
|
|
|
445
445
|
maxGraphemes: number;
|
|
446
446
|
description: string;
|
|
447
447
|
};
|
|
448
|
-
|
|
448
|
+
description: {
|
|
449
449
|
type: string;
|
|
450
|
+
ref: string;
|
|
450
451
|
description: string;
|
|
451
|
-
accept: string[];
|
|
452
|
-
maxSize: number;
|
|
453
452
|
};
|
|
454
|
-
|
|
455
|
-
type: string;
|
|
456
|
-
description: string;
|
|
457
|
-
accept: string[];
|
|
458
|
-
maxSize: number;
|
|
459
|
-
};
|
|
460
|
-
activities: {
|
|
453
|
+
items: {
|
|
461
454
|
type: string;
|
|
462
455
|
description: string;
|
|
463
456
|
items: {
|
|
@@ -475,7 +468,7 @@ export declare const HYPERCERTS_LEXICON_JSON: {
|
|
|
475
468
|
};
|
|
476
469
|
};
|
|
477
470
|
};
|
|
478
|
-
readonly
|
|
471
|
+
readonly CONTRIBUTIONDETAILS: {
|
|
479
472
|
lexicon: number;
|
|
480
473
|
id: string;
|
|
481
474
|
defs: {
|
|
@@ -492,14 +485,7 @@ export declare const HYPERCERTS_LEXICON_JSON: {
|
|
|
492
485
|
description: string;
|
|
493
486
|
maxLength: number;
|
|
494
487
|
};
|
|
495
|
-
|
|
496
|
-
type: string;
|
|
497
|
-
description: string;
|
|
498
|
-
items: {
|
|
499
|
-
type: string;
|
|
500
|
-
};
|
|
501
|
-
};
|
|
502
|
-
description: {
|
|
488
|
+
contributionDescription: {
|
|
503
489
|
type: string;
|
|
504
490
|
description: string;
|
|
505
491
|
maxLength: number;
|
|
@@ -525,6 +511,42 @@ export declare const HYPERCERTS_LEXICON_JSON: {
|
|
|
525
511
|
};
|
|
526
512
|
};
|
|
527
513
|
};
|
|
514
|
+
readonly CONTRIBUTORINFORMATION: {
|
|
515
|
+
lexicon: number;
|
|
516
|
+
id: string;
|
|
517
|
+
defs: {
|
|
518
|
+
main: {
|
|
519
|
+
type: string;
|
|
520
|
+
description: string;
|
|
521
|
+
key: string;
|
|
522
|
+
record: {
|
|
523
|
+
type: string;
|
|
524
|
+
required: string[];
|
|
525
|
+
properties: {
|
|
526
|
+
identifier: {
|
|
527
|
+
type: string;
|
|
528
|
+
description: string;
|
|
529
|
+
};
|
|
530
|
+
displayName: {
|
|
531
|
+
type: string;
|
|
532
|
+
description: string;
|
|
533
|
+
maxLength: number;
|
|
534
|
+
};
|
|
535
|
+
image: {
|
|
536
|
+
type: string;
|
|
537
|
+
refs: string[];
|
|
538
|
+
description: string;
|
|
539
|
+
};
|
|
540
|
+
createdAt: {
|
|
541
|
+
type: string;
|
|
542
|
+
format: string;
|
|
543
|
+
description: string;
|
|
544
|
+
};
|
|
545
|
+
};
|
|
546
|
+
};
|
|
547
|
+
};
|
|
548
|
+
};
|
|
549
|
+
};
|
|
528
550
|
readonly EVALUATION: {
|
|
529
551
|
lexicon: number;
|
|
530
552
|
id: string;
|
|
@@ -738,70 +760,6 @@ export declare const HYPERCERTS_LEXICON_JSON: {
|
|
|
738
760
|
};
|
|
739
761
|
};
|
|
740
762
|
};
|
|
741
|
-
readonly PROJECT: {
|
|
742
|
-
lexicon: number;
|
|
743
|
-
id: string;
|
|
744
|
-
defs: {
|
|
745
|
-
main: {
|
|
746
|
-
type: string;
|
|
747
|
-
description: string;
|
|
748
|
-
key: string;
|
|
749
|
-
record: {
|
|
750
|
-
type: string;
|
|
751
|
-
required: string[];
|
|
752
|
-
properties: {
|
|
753
|
-
title: {
|
|
754
|
-
type: string;
|
|
755
|
-
description: string;
|
|
756
|
-
maxLength: number;
|
|
757
|
-
maxGraphemes: number;
|
|
758
|
-
};
|
|
759
|
-
shortDescription: {
|
|
760
|
-
type: string;
|
|
761
|
-
maxLength: number;
|
|
762
|
-
maxGraphemes: number;
|
|
763
|
-
description: string;
|
|
764
|
-
};
|
|
765
|
-
description: {
|
|
766
|
-
type: string;
|
|
767
|
-
ref: string;
|
|
768
|
-
description: string;
|
|
769
|
-
};
|
|
770
|
-
avatar: {
|
|
771
|
-
type: string;
|
|
772
|
-
description: string;
|
|
773
|
-
accept: string[];
|
|
774
|
-
maxSize: number;
|
|
775
|
-
};
|
|
776
|
-
coverPhoto: {
|
|
777
|
-
type: string;
|
|
778
|
-
description: string;
|
|
779
|
-
accept: string[];
|
|
780
|
-
maxSize: number;
|
|
781
|
-
};
|
|
782
|
-
activities: {
|
|
783
|
-
type: string;
|
|
784
|
-
description: string;
|
|
785
|
-
items: {
|
|
786
|
-
type: string;
|
|
787
|
-
ref: string;
|
|
788
|
-
};
|
|
789
|
-
};
|
|
790
|
-
location: {
|
|
791
|
-
type: string;
|
|
792
|
-
ref: string;
|
|
793
|
-
description: string;
|
|
794
|
-
};
|
|
795
|
-
createdAt: {
|
|
796
|
-
type: string;
|
|
797
|
-
format: string;
|
|
798
|
-
description: string;
|
|
799
|
-
};
|
|
800
|
-
};
|
|
801
|
-
};
|
|
802
|
-
};
|
|
803
|
-
};
|
|
804
|
-
};
|
|
805
763
|
readonly RIGHTS: {
|
|
806
764
|
lexicon: number;
|
|
807
765
|
id: string;
|
|
@@ -989,11 +947,11 @@ export declare const LOCATION_LEXICON_DOC: LexiconDoc;
|
|
|
989
947
|
export declare const STRONGREF_LEXICON_DOC: LexiconDoc;
|
|
990
948
|
export declare const ACTIVITY_LEXICON_DOC: LexiconDoc;
|
|
991
949
|
export declare const COLLECTION_LEXICON_DOC: LexiconDoc;
|
|
992
|
-
export declare const
|
|
950
|
+
export declare const CONTRIBUTIONDETAILS_LEXICON_DOC: LexiconDoc;
|
|
951
|
+
export declare const CONTRIBUTORINFORMATION_LEXICON_DOC: LexiconDoc;
|
|
993
952
|
export declare const EVALUATION_LEXICON_DOC: LexiconDoc;
|
|
994
953
|
export declare const EVIDENCE_LEXICON_DOC: LexiconDoc;
|
|
995
954
|
export declare const MEASUREMENT_LEXICON_DOC: LexiconDoc;
|
|
996
|
-
export declare const PROJECT_LEXICON_DOC: LexiconDoc;
|
|
997
955
|
export declare const RIGHTS_LEXICON_DOC: LexiconDoc;
|
|
998
956
|
export declare const HYPERCERTS_DEFS_LEXICON_DOC: LexiconDoc;
|
|
999
957
|
export declare const FUNDING_RECEIPT_LEXICON_DOC: LexiconDoc;
|
|
@@ -1009,11 +967,11 @@ export * as AppCertifiedLocation from "./types/app/certified/location.js";
|
|
|
1009
967
|
export * as ComAtprotoRepoStrongRef from "./types/com/atproto/repo/strongRef.js";
|
|
1010
968
|
export * as OrgHypercertsClaimActivity from "./types/org/hypercerts/claim/activity.js";
|
|
1011
969
|
export * as OrgHypercertsClaimCollection from "./types/org/hypercerts/claim/collection.js";
|
|
1012
|
-
export * as
|
|
970
|
+
export * as OrgHypercertsClaimContributionDetails from "./types/org/hypercerts/claim/contributionDetails.js";
|
|
971
|
+
export * as OrgHypercertsClaimContributorInformation from "./types/org/hypercerts/claim/contributorInformation.js";
|
|
1013
972
|
export * as OrgHypercertsClaimEvaluation from "./types/org/hypercerts/claim/evaluation.js";
|
|
1014
973
|
export * as OrgHypercertsClaimEvidence from "./types/org/hypercerts/claim/evidence.js";
|
|
1015
974
|
export * as OrgHypercertsClaimMeasurement from "./types/org/hypercerts/claim/measurement.js";
|
|
1016
|
-
export * as OrgHypercertsClaimProject from "./types/org/hypercerts/claim/project.js";
|
|
1017
975
|
export * as OrgHypercertsClaimRights from "./types/org/hypercerts/claim/rights.js";
|
|
1018
976
|
export * as OrgHypercertsDefs from "./types/org/hypercerts/defs.js";
|
|
1019
977
|
export * as OrgHypercertsFundingReceipt from "./types/org/hypercerts/funding/receipt.js";
|