@hypercerts-org/lexicon 0.10.0-beta.14 → 0.10.0-beta.16
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 +36 -0
- package/README.md +117 -12
- package/SCHEMAS.md +300 -158
- package/dist/exports.d.ts +604 -171
- package/dist/exports.d.ts.map +1 -1
- package/dist/generated/exports.d.ts +604 -171
- package/dist/generated/exports.d.ts.map +1 -1
- package/dist/generated/lexicons.d.ts +1256 -440
- package/dist/generated/lexicons.d.ts.map +1 -1
- package/dist/generated/types/app/certified/actor/organization.d.ts +32 -0
- package/dist/generated/types/app/certified/actor/organization.d.ts.map +1 -0
- package/dist/generated/types/app/certified/actor/profile.d.ts +4 -1
- package/dist/generated/types/app/certified/actor/profile.d.ts.map +1 -1
- package/dist/generated/types/app/certified/badge/award.d.ts +2 -0
- package/dist/generated/types/app/certified/badge/award.d.ts.map +1 -1
- package/dist/generated/types/app/certified/badge/response.d.ts +1 -1
- package/dist/generated/types/app/certified/badge/response.d.ts.map +1 -1
- package/dist/generated/types/app/certified/location.d.ts +4 -4
- package/dist/generated/types/app/certified/location.d.ts.map +1 -1
- package/dist/generated/types/org/hyperboards/board.d.ts +75 -0
- package/dist/generated/types/org/hyperboards/board.d.ts.map +1 -0
- package/dist/generated/types/org/hyperboards/displayProfile.d.ts +31 -0
- package/dist/generated/types/org/hyperboards/displayProfile.d.ts.map +1 -0
- package/dist/generated/types/org/hypercerts/claim/activity.d.ts +8 -9
- package/dist/generated/types/org/hypercerts/claim/activity.d.ts.map +1 -1
- package/dist/generated/types/org/hypercerts/claim/{contributionDetails.d.ts → contribution.d.ts} +6 -6
- package/dist/generated/types/org/hypercerts/claim/contribution.d.ts.map +1 -0
- package/dist/generated/types/org/hypercerts/claim/contributorInformation.d.ts +2 -2
- package/dist/generated/types/org/hypercerts/claim/contributorInformation.d.ts.map +1 -1
- package/dist/generated/types/org/hypercerts/claim/rights.d.ts +3 -3
- package/dist/generated/types/org/hypercerts/claim/rights.d.ts.map +1 -1
- package/dist/{types/org/hypercerts/claim → generated/types/org/hypercerts}/collection.d.ts +10 -10
- package/dist/generated/types/org/hypercerts/collection.d.ts.map +1 -0
- package/dist/generated/types/org/hypercerts/context/acknowledgement.d.ts +25 -0
- package/dist/generated/types/org/hypercerts/context/acknowledgement.d.ts.map +1 -0
- package/dist/generated/types/org/hypercerts/{claim → context}/attachment.d.ts +6 -8
- package/dist/generated/types/org/hypercerts/context/attachment.d.ts.map +1 -0
- package/dist/generated/types/org/hypercerts/{claim → context}/evaluation.d.ts +15 -15
- package/dist/generated/types/org/hypercerts/context/evaluation.d.ts.map +1 -0
- package/dist/{types/org/hypercerts/claim → generated/types/org/hypercerts/context}/measurement.d.ts +7 -6
- package/dist/generated/types/org/hypercerts/context/measurement.d.ts.map +1 -0
- package/dist/generated/types/org/hypercerts/defs.d.ts +8 -0
- package/dist/generated/types/org/hypercerts/defs.d.ts.map +1 -1
- package/dist/generated/types/org/hypercerts/funding/receipt.d.ts +1 -1
- package/dist/generated/types/org/hypercerts/funding/receipt.d.ts.map +1 -1
- package/dist/generated/types/org/hypercerts/workscope/cel.d.ts +20 -0
- package/dist/generated/types/org/hypercerts/workscope/cel.d.ts.map +1 -0
- package/dist/generated/types/org/hypercerts/workscope/tag.d.ts +36 -0
- package/dist/generated/types/org/hypercerts/workscope/tag.d.ts.map +1 -0
- package/dist/index.cjs +1931 -805
- package/dist/index.cjs.map +1 -1
- package/dist/index.mjs +1883 -777
- package/dist/index.mjs.map +1 -1
- package/dist/lexicons.cjs +689 -240
- package/dist/lexicons.cjs.map +1 -1
- package/dist/lexicons.d.ts +1256 -440
- package/dist/lexicons.d.ts.map +1 -1
- package/dist/lexicons.mjs +689 -240
- package/dist/lexicons.mjs.map +1 -1
- package/dist/types/app/certified/actor/organization.d.ts +32 -0
- package/dist/types/app/certified/actor/organization.d.ts.map +1 -0
- package/dist/types/app/certified/actor/profile.d.ts +4 -1
- package/dist/types/app/certified/actor/profile.d.ts.map +1 -1
- package/dist/types/app/certified/badge/award.d.ts +2 -0
- package/dist/types/app/certified/badge/award.d.ts.map +1 -1
- package/dist/types/app/certified/badge/response.d.ts +1 -1
- package/dist/types/app/certified/badge/response.d.ts.map +1 -1
- package/dist/types/app/certified/location.d.ts +4 -4
- package/dist/types/app/certified/location.d.ts.map +1 -1
- package/dist/types/org/hyperboards/board.d.ts +75 -0
- package/dist/types/org/hyperboards/board.d.ts.map +1 -0
- package/dist/types/org/hyperboards/displayProfile.d.ts +31 -0
- package/dist/types/org/hyperboards/displayProfile.d.ts.map +1 -0
- package/dist/types/org/hypercerts/claim/activity.d.ts +8 -9
- package/dist/types/org/hypercerts/claim/activity.d.ts.map +1 -1
- package/dist/types/org/hypercerts/claim/{contributionDetails.d.ts → contribution.d.ts} +6 -6
- package/dist/types/org/hypercerts/claim/contribution.d.ts.map +1 -0
- package/dist/types/org/hypercerts/claim/contributorInformation.d.ts +2 -2
- package/dist/types/org/hypercerts/claim/contributorInformation.d.ts.map +1 -1
- package/dist/types/org/hypercerts/claim/rights.d.ts +3 -3
- package/dist/types/org/hypercerts/claim/rights.d.ts.map +1 -1
- package/dist/{generated/types/org/hypercerts/claim → types/org/hypercerts}/collection.d.ts +10 -10
- package/dist/types/org/hypercerts/collection.d.ts.map +1 -0
- package/dist/types/org/hypercerts/context/acknowledgement.d.ts +25 -0
- package/dist/types/org/hypercerts/context/acknowledgement.d.ts.map +1 -0
- package/dist/types/org/hypercerts/{claim → context}/attachment.d.ts +6 -8
- package/dist/types/org/hypercerts/context/attachment.d.ts.map +1 -0
- package/dist/types/org/hypercerts/{claim → context}/evaluation.d.ts +15 -15
- package/dist/types/org/hypercerts/context/evaluation.d.ts.map +1 -0
- package/dist/{generated/types/org/hypercerts/claim → types/org/hypercerts/context}/measurement.d.ts +7 -6
- package/dist/types/org/hypercerts/context/measurement.d.ts.map +1 -0
- package/dist/types/org/hypercerts/defs.d.ts +8 -0
- package/dist/types/org/hypercerts/defs.d.ts.map +1 -1
- package/dist/types/org/hypercerts/funding/receipt.d.ts +1 -1
- package/dist/types/org/hypercerts/funding/receipt.d.ts.map +1 -1
- package/dist/types/org/hypercerts/workscope/cel.d.ts +20 -0
- package/dist/types/org/hypercerts/workscope/cel.d.ts.map +1 -0
- package/dist/types/org/hypercerts/workscope/tag.d.ts +36 -0
- package/dist/types/org/hypercerts/workscope/tag.d.ts.map +1 -0
- package/lexicons/app/certified/actor/organization.json +70 -0
- package/lexicons/app/certified/actor/profile.json +13 -3
- package/lexicons/app/certified/badge/award.json +8 -1
- package/lexicons/app/certified/badge/definition.json +8 -3
- package/lexicons/app/certified/badge/response.json +3 -2
- package/lexicons/app/certified/location.json +13 -4
- package/lexicons/org/hyperboards/board.json +152 -0
- package/lexicons/org/hyperboards/displayProfile.json +64 -0
- package/lexicons/org/hypercerts/claim/activity.json +23 -29
- package/lexicons/org/hypercerts/claim/{contributionDetails.json → contribution.json} +4 -4
- package/lexicons/org/hypercerts/claim/contributorInformation.json +3 -2
- package/lexicons/org/hypercerts/claim/rights.json +5 -3
- package/lexicons/org/hypercerts/{claim/collection.json → collection.json} +9 -6
- package/lexicons/org/hypercerts/context/acknowledgement.json +42 -0
- package/lexicons/org/hypercerts/{claim → context}/attachment.json +6 -15
- package/lexicons/org/hypercerts/{claim → context}/evaluation.json +22 -22
- package/lexicons/org/hypercerts/{claim → context}/measurement.json +13 -9
- package/lexicons/org/hypercerts/defs.json +14 -1
- package/lexicons/org/hypercerts/funding/receipt.json +12 -6
- package/lexicons/org/hypercerts/workscope/cel.json +39 -0
- package/lexicons/org/hypercerts/workscope/tag.json +87 -0
- package/package.json +1 -1
- package/dist/generated/types/org/hypercerts/claim/attachment.d.ts.map +0 -1
- package/dist/generated/types/org/hypercerts/claim/collection.d.ts.map +0 -1
- package/dist/generated/types/org/hypercerts/claim/contributionDetails.d.ts.map +0 -1
- package/dist/generated/types/org/hypercerts/claim/evaluation.d.ts.map +0 -1
- package/dist/generated/types/org/hypercerts/claim/measurement.d.ts.map +0 -1
- package/dist/generated/types/org/hypercerts/helper/workScopeTag.d.ts +0 -31
- package/dist/generated/types/org/hypercerts/helper/workScopeTag.d.ts.map +0 -1
- package/dist/types/org/hypercerts/claim/attachment.d.ts.map +0 -1
- package/dist/types/org/hypercerts/claim/collection.d.ts.map +0 -1
- package/dist/types/org/hypercerts/claim/contributionDetails.d.ts.map +0 -1
- package/dist/types/org/hypercerts/claim/evaluation.d.ts.map +0 -1
- package/dist/types/org/hypercerts/claim/measurement.d.ts.map +0 -1
- package/dist/types/org/hypercerts/helper/workScopeTag.d.ts +0 -31
- package/dist/types/org/hypercerts/helper/workScopeTag.d.ts.map +0 -1
- package/lexicons/org/hypercerts/helper/workScopeTag.json +0 -65
package/dist/lexicons.d.ts
CHANGED
|
@@ -3,19 +3,91 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import { Lexicons, type ValidationResult } from '@atproto/lexicon';
|
|
5
5
|
export declare const schemaDict: {
|
|
6
|
+
readonly AppCertifiedActorOrganization: {
|
|
7
|
+
readonly lexicon: 1;
|
|
8
|
+
readonly id: "app.certified.actor.organization";
|
|
9
|
+
readonly defs: {
|
|
10
|
+
readonly main: {
|
|
11
|
+
readonly type: "record";
|
|
12
|
+
readonly description: "Extended metadata for an organization actor. Complements the base actor profile with organization-specific fields like legal structure and reference links.";
|
|
13
|
+
readonly key: "literal:self";
|
|
14
|
+
readonly record: {
|
|
15
|
+
readonly type: "object";
|
|
16
|
+
readonly required: ["createdAt"];
|
|
17
|
+
readonly properties: {
|
|
18
|
+
readonly organizationType: {
|
|
19
|
+
readonly type: "array";
|
|
20
|
+
readonly description: "Legal or operational structures of the organization (e.g. 'nonprofit', 'ngo', 'government', 'social-enterprise', 'cooperative').";
|
|
21
|
+
readonly items: {
|
|
22
|
+
readonly type: "string";
|
|
23
|
+
readonly maxLength: 128;
|
|
24
|
+
readonly maxGraphemes: 100;
|
|
25
|
+
};
|
|
26
|
+
readonly maxLength: 10;
|
|
27
|
+
};
|
|
28
|
+
readonly urls: {
|
|
29
|
+
readonly type: "array";
|
|
30
|
+
readonly description: "Additional reference URLs (social media profiles, contact pages, donation links, etc.) with a display label for each URL.";
|
|
31
|
+
readonly items: {
|
|
32
|
+
readonly type: "ref";
|
|
33
|
+
readonly ref: "lex:app.certified.actor.organization#urlItem";
|
|
34
|
+
};
|
|
35
|
+
};
|
|
36
|
+
readonly location: {
|
|
37
|
+
readonly type: "ref";
|
|
38
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
39
|
+
readonly description: "A strong reference to the location where the organization is based. The record referenced must conform with the lexicon app.certified.location.";
|
|
40
|
+
};
|
|
41
|
+
readonly foundedDate: {
|
|
42
|
+
readonly type: "string";
|
|
43
|
+
readonly format: "datetime";
|
|
44
|
+
readonly description: "When the organization was established. Stored as datetime per ATProto conventions (no date-only format exists). Clients should use midnight UTC (e.g., '2005-01-01T00:00:00.000Z'); consumers should treat only the date portion as canonical.";
|
|
45
|
+
};
|
|
46
|
+
readonly createdAt: {
|
|
47
|
+
readonly type: "string";
|
|
48
|
+
readonly format: "datetime";
|
|
49
|
+
readonly description: "Client-declared timestamp when this record was originally created.";
|
|
50
|
+
};
|
|
51
|
+
};
|
|
52
|
+
};
|
|
53
|
+
};
|
|
54
|
+
readonly urlItem: {
|
|
55
|
+
readonly type: "object";
|
|
56
|
+
readonly description: "A labeled URL reference.";
|
|
57
|
+
readonly required: ["url"];
|
|
58
|
+
readonly properties: {
|
|
59
|
+
readonly url: {
|
|
60
|
+
readonly type: "string";
|
|
61
|
+
readonly format: "uri";
|
|
62
|
+
readonly description: "The URL.";
|
|
63
|
+
readonly maxLength: 10000;
|
|
64
|
+
readonly maxGraphemes: 2048;
|
|
65
|
+
};
|
|
66
|
+
readonly label: {
|
|
67
|
+
readonly type: "string";
|
|
68
|
+
readonly description: "Optional human-readable label for this URL (e.g. 'Support page', 'Donation page').";
|
|
69
|
+
readonly maxLength: 640;
|
|
70
|
+
readonly maxGraphemes: 64;
|
|
71
|
+
};
|
|
72
|
+
};
|
|
73
|
+
};
|
|
74
|
+
};
|
|
75
|
+
};
|
|
6
76
|
readonly AppCertifiedActorProfile: {
|
|
7
77
|
readonly lexicon: 1;
|
|
8
78
|
readonly id: "app.certified.actor.profile";
|
|
9
79
|
readonly defs: {
|
|
10
80
|
readonly main: {
|
|
11
81
|
readonly type: "record";
|
|
12
|
-
readonly description: "A declaration of a
|
|
82
|
+
readonly description: "A declaration of a Certified account profile.";
|
|
13
83
|
readonly key: "literal:self";
|
|
14
84
|
readonly record: {
|
|
15
85
|
readonly type: "object";
|
|
86
|
+
readonly required: ["createdAt"];
|
|
16
87
|
readonly properties: {
|
|
17
88
|
readonly displayName: {
|
|
18
89
|
readonly type: "string";
|
|
90
|
+
readonly description: "Display name for the account";
|
|
19
91
|
readonly maxGraphemes: 64;
|
|
20
92
|
readonly maxLength: 640;
|
|
21
93
|
};
|
|
@@ -34,6 +106,7 @@ export declare const schemaDict: {
|
|
|
34
106
|
readonly website: {
|
|
35
107
|
readonly type: "string";
|
|
36
108
|
readonly format: "uri";
|
|
109
|
+
readonly description: "Account website URL";
|
|
37
110
|
};
|
|
38
111
|
readonly avatar: {
|
|
39
112
|
readonly type: "union";
|
|
@@ -48,6 +121,7 @@ export declare const schemaDict: {
|
|
|
48
121
|
readonly createdAt: {
|
|
49
122
|
readonly type: "string";
|
|
50
123
|
readonly format: "datetime";
|
|
124
|
+
readonly description: "Client-declared timestamp when this record was originally created";
|
|
51
125
|
};
|
|
52
126
|
};
|
|
53
127
|
};
|
|
@@ -79,6 +153,13 @@ export declare const schemaDict: {
|
|
|
79
153
|
readonly note: {
|
|
80
154
|
readonly type: "string";
|
|
81
155
|
readonly description: "Optional statement explaining the reason for this badge award.";
|
|
156
|
+
readonly maxLength: 500;
|
|
157
|
+
};
|
|
158
|
+
readonly url: {
|
|
159
|
+
readonly type: "string";
|
|
160
|
+
readonly format: "uri";
|
|
161
|
+
readonly description: "Optional URL the badge award links to.";
|
|
162
|
+
readonly maxLength: 2048;
|
|
82
163
|
};
|
|
83
164
|
readonly createdAt: {
|
|
84
165
|
readonly type: "string";
|
|
@@ -105,10 +186,12 @@ export declare const schemaDict: {
|
|
|
105
186
|
readonly badgeType: {
|
|
106
187
|
readonly type: "string";
|
|
107
188
|
readonly description: "Category of the badge (e.g. endorsement, participation, affiliation).";
|
|
189
|
+
readonly maxLength: 100;
|
|
108
190
|
};
|
|
109
191
|
readonly title: {
|
|
110
192
|
readonly type: "string";
|
|
111
193
|
readonly description: "Human-readable title of the badge.";
|
|
194
|
+
readonly maxLength: 256;
|
|
112
195
|
};
|
|
113
196
|
readonly icon: {
|
|
114
197
|
readonly type: "blob";
|
|
@@ -119,10 +202,13 @@ export declare const schemaDict: {
|
|
|
119
202
|
readonly description: {
|
|
120
203
|
readonly type: "string";
|
|
121
204
|
readonly description: "Optional short statement describing what the badge represents.";
|
|
205
|
+
readonly maxLength: 5000;
|
|
206
|
+
readonly maxGraphemes: 500;
|
|
122
207
|
};
|
|
123
208
|
readonly allowedIssuers: {
|
|
124
209
|
readonly type: "array";
|
|
125
210
|
readonly description: "Optional allowlist of DIDs allowed to issue this badge. If omitted, anyone may issue it.";
|
|
211
|
+
readonly maxLength: 100;
|
|
126
212
|
readonly items: {
|
|
127
213
|
readonly type: "ref";
|
|
128
214
|
readonly ref: "lex:app.certified.defs#did";
|
|
@@ -157,12 +243,13 @@ export declare const schemaDict: {
|
|
|
157
243
|
};
|
|
158
244
|
readonly response: {
|
|
159
245
|
readonly type: "string";
|
|
160
|
-
readonly
|
|
246
|
+
readonly knownValues: ["accepted", "rejected"];
|
|
161
247
|
readonly description: "The recipient’s response for the badge (accepted or rejected).";
|
|
162
248
|
};
|
|
163
249
|
readonly weight: {
|
|
164
250
|
readonly type: "string";
|
|
165
251
|
readonly description: "Optional relative weight for accepted badges, assigned by the recipient.";
|
|
252
|
+
readonly maxLength: 50;
|
|
166
253
|
};
|
|
167
254
|
readonly createdAt: {
|
|
168
255
|
readonly type: "string";
|
|
@@ -219,8 +306,8 @@ export declare const schemaDict: {
|
|
|
219
306
|
};
|
|
220
307
|
readonly locationType: {
|
|
221
308
|
readonly type: "string";
|
|
222
|
-
readonly description: "An identifier for the format of the location data (e.g., coordinate-decimal, geojson-point)";
|
|
223
|
-
readonly knownValues: ["coordinate-decimal", "geojson-point"];
|
|
309
|
+
readonly description: "An identifier for the format of the location data (e.g., coordinate-decimal, geojson-point). See the Location Protocol spec for the full registry: https://spec.decentralizedgeo.org/specification/location-types/#location-type-registry";
|
|
310
|
+
readonly knownValues: ["coordinate-decimal", "geojson-point", "geojson", "h3", "geohash", "wkt", "address", "scaledCoordinates"];
|
|
224
311
|
readonly maxLength: 20;
|
|
225
312
|
};
|
|
226
313
|
readonly location: {
|
|
@@ -230,13 +317,13 @@ export declare const schemaDict: {
|
|
|
230
317
|
};
|
|
231
318
|
readonly name: {
|
|
232
319
|
readonly type: "string";
|
|
233
|
-
readonly description: "
|
|
320
|
+
readonly description: "Human-readable name for this location (e.g. 'Golden Gate Park', 'San Francisco Bay Area')";
|
|
234
321
|
readonly maxLength: 1000;
|
|
235
322
|
readonly maxGraphemes: 100;
|
|
236
323
|
};
|
|
237
324
|
readonly description: {
|
|
238
325
|
readonly type: "string";
|
|
239
|
-
readonly description: "
|
|
326
|
+
readonly description: "Additional context about this location, such as its significance to the work or specific boundaries";
|
|
240
327
|
readonly maxLength: 2000;
|
|
241
328
|
readonly maxGraphemes: 500;
|
|
242
329
|
};
|
|
@@ -284,6 +371,210 @@ export declare const schemaDict: {
|
|
|
284
371
|
};
|
|
285
372
|
};
|
|
286
373
|
};
|
|
374
|
+
readonly OrgHyperboardsBoard: {
|
|
375
|
+
readonly lexicon: 1;
|
|
376
|
+
readonly id: "org.hyperboards.board";
|
|
377
|
+
readonly defs: {
|
|
378
|
+
readonly main: {
|
|
379
|
+
readonly type: "record";
|
|
380
|
+
readonly description: "Configuration record for a hyperboard, wrapping an underlying activity or collection with visual presentation settings. Stored in the creator's PDS.";
|
|
381
|
+
readonly key: "tid";
|
|
382
|
+
readonly record: {
|
|
383
|
+
readonly type: "object";
|
|
384
|
+
readonly required: ["subject", "createdAt"];
|
|
385
|
+
readonly properties: {
|
|
386
|
+
readonly subject: {
|
|
387
|
+
readonly type: "ref";
|
|
388
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
389
|
+
readonly description: "Reference to the org.hypercerts.claim.activity or org.hypercerts.claim.collection this board visualizes.";
|
|
390
|
+
};
|
|
391
|
+
readonly config: {
|
|
392
|
+
readonly type: "ref";
|
|
393
|
+
readonly ref: "lex:org.hyperboards.board#boardConfig";
|
|
394
|
+
readonly description: "Board-level visual configuration (background, colors, aspect ratio).";
|
|
395
|
+
};
|
|
396
|
+
readonly contributorConfigs: {
|
|
397
|
+
readonly type: "array";
|
|
398
|
+
readonly description: "Per-contributor configuration entries for this board.";
|
|
399
|
+
readonly maxLength: 1000;
|
|
400
|
+
readonly items: {
|
|
401
|
+
readonly type: "ref";
|
|
402
|
+
readonly ref: "lex:org.hyperboards.board#contributorConfig";
|
|
403
|
+
};
|
|
404
|
+
};
|
|
405
|
+
readonly createdAt: {
|
|
406
|
+
readonly type: "string";
|
|
407
|
+
readonly format: "datetime";
|
|
408
|
+
readonly description: "Client-declared timestamp when this record was originally created.";
|
|
409
|
+
};
|
|
410
|
+
};
|
|
411
|
+
};
|
|
412
|
+
};
|
|
413
|
+
readonly boardConfig: {
|
|
414
|
+
readonly type: "object";
|
|
415
|
+
readonly description: "Visual configuration for a hyperboard's background, colors, and layout.";
|
|
416
|
+
readonly properties: {
|
|
417
|
+
readonly backgroundType: {
|
|
418
|
+
readonly type: "string";
|
|
419
|
+
readonly description: "Type of background content.";
|
|
420
|
+
readonly knownValues: ["image", "iframe"];
|
|
421
|
+
readonly maxLength: 10;
|
|
422
|
+
};
|
|
423
|
+
readonly backgroundImage: {
|
|
424
|
+
readonly type: "union";
|
|
425
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
426
|
+
readonly description: "Background image as a URI or image blob.";
|
|
427
|
+
};
|
|
428
|
+
readonly backgroundIframeUrl: {
|
|
429
|
+
readonly type: "string";
|
|
430
|
+
readonly format: "uri";
|
|
431
|
+
readonly description: "URI of the background iframe.";
|
|
432
|
+
readonly maxLength: 2048;
|
|
433
|
+
};
|
|
434
|
+
readonly backgroundGrayscale: {
|
|
435
|
+
readonly type: "boolean";
|
|
436
|
+
readonly description: "Whether the background is rendered in grayscale. Default: true.";
|
|
437
|
+
};
|
|
438
|
+
readonly backgroundOpacity: {
|
|
439
|
+
readonly type: "integer";
|
|
440
|
+
readonly description: "Background opacity as a percentage (0–100).";
|
|
441
|
+
readonly minimum: 0;
|
|
442
|
+
readonly maximum: 100;
|
|
443
|
+
};
|
|
444
|
+
readonly backgroundColor: {
|
|
445
|
+
readonly type: "string";
|
|
446
|
+
readonly description: "Background color as a hex string (e.g. '#ffffff').";
|
|
447
|
+
readonly maxLength: 20;
|
|
448
|
+
};
|
|
449
|
+
readonly borderColor: {
|
|
450
|
+
readonly type: "string";
|
|
451
|
+
readonly description: "Border color as a hex string (e.g. '#000000').";
|
|
452
|
+
readonly maxLength: 20;
|
|
453
|
+
};
|
|
454
|
+
readonly grayscaleImages: {
|
|
455
|
+
readonly type: "boolean";
|
|
456
|
+
readonly description: "Whether contributor images are rendered in grayscale. Default: false.";
|
|
457
|
+
};
|
|
458
|
+
readonly imageShape: {
|
|
459
|
+
readonly type: "string";
|
|
460
|
+
readonly description: "Shape used to crop contributor images on this board.";
|
|
461
|
+
readonly knownValues: ["circular", "square"];
|
|
462
|
+
readonly maxLength: 20;
|
|
463
|
+
};
|
|
464
|
+
readonly aspectRatio: {
|
|
465
|
+
readonly type: "string";
|
|
466
|
+
readonly description: "Display aspect ratio of the board.";
|
|
467
|
+
readonly knownValues: ["16:9", "4:3", "1:1"];
|
|
468
|
+
readonly maxLength: 10;
|
|
469
|
+
};
|
|
470
|
+
};
|
|
471
|
+
};
|
|
472
|
+
readonly contributorConfig: {
|
|
473
|
+
readonly type: "object";
|
|
474
|
+
readonly description: "Configuration for a specific contributor within a board. Values serve as fallbacks when the contributor has not defined them on their profile. It can also be used to override contributor settings on this board without changing their global profile.";
|
|
475
|
+
readonly required: ["contributor"];
|
|
476
|
+
readonly properties: {
|
|
477
|
+
readonly contributor: {
|
|
478
|
+
readonly type: "union";
|
|
479
|
+
readonly refs: ["lex:com.atproto.repo.strongRef", "lex:org.hypercerts.claim.activity#contributorIdentity"];
|
|
480
|
+
readonly description: "Identifies the contributor being styled. A strong reference to an org.hypercerts.claim.contributorInformation record, or a contributorIdentity (DID or identifier string) for contributors without a dedicated record.";
|
|
481
|
+
};
|
|
482
|
+
readonly override: {
|
|
483
|
+
readonly type: "boolean";
|
|
484
|
+
readonly description: "When true, these values take precedence over the contributor's own profile and display settings. When false or omitted, they are only used as fallbacks if the contributor has not set their own settings.";
|
|
485
|
+
};
|
|
486
|
+
readonly displayName: {
|
|
487
|
+
readonly type: "string";
|
|
488
|
+
readonly description: "Display name for this contributor on this board.";
|
|
489
|
+
readonly maxLength: 640;
|
|
490
|
+
readonly maxGraphemes: 64;
|
|
491
|
+
};
|
|
492
|
+
readonly image: {
|
|
493
|
+
readonly type: "union";
|
|
494
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
495
|
+
readonly description: "Avatar or face image for this contributor on this board, as a URI or image blob.";
|
|
496
|
+
};
|
|
497
|
+
readonly video: {
|
|
498
|
+
readonly type: "union";
|
|
499
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallVideo"];
|
|
500
|
+
readonly description: "Video for this contributor, as a URI (embed/direct link) or uploaded video blob.";
|
|
501
|
+
};
|
|
502
|
+
readonly hoverImage: {
|
|
503
|
+
readonly type: "union";
|
|
504
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
505
|
+
readonly description: "Image overlay shown when hovering over this contributor, as a URI or image blob.";
|
|
506
|
+
};
|
|
507
|
+
readonly hoverIframeUrl: {
|
|
508
|
+
readonly type: "string";
|
|
509
|
+
readonly format: "uri";
|
|
510
|
+
readonly description: "Iframe overlay shown when hovering over this contributor.";
|
|
511
|
+
readonly maxLength: 2048;
|
|
512
|
+
};
|
|
513
|
+
readonly url: {
|
|
514
|
+
readonly type: "string";
|
|
515
|
+
readonly format: "uri";
|
|
516
|
+
readonly description: "Click-through link URL for this contributor.";
|
|
517
|
+
readonly maxLength: 2048;
|
|
518
|
+
};
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
};
|
|
522
|
+
};
|
|
523
|
+
readonly OrgHyperboardsDisplayProfile: {
|
|
524
|
+
readonly lexicon: 1;
|
|
525
|
+
readonly id: "org.hyperboards.displayProfile";
|
|
526
|
+
readonly defs: {
|
|
527
|
+
readonly main: {
|
|
528
|
+
readonly type: "record";
|
|
529
|
+
readonly description: "User-declared visual presentation defaults for how a contributor appears on hyperboards. Stored in the contributor's own PDS and reusable across multiple boards.";
|
|
530
|
+
readonly key: "literal:self";
|
|
531
|
+
readonly record: {
|
|
532
|
+
readonly type: "object";
|
|
533
|
+
readonly required: ["createdAt"];
|
|
534
|
+
readonly properties: {
|
|
535
|
+
readonly displayName: {
|
|
536
|
+
readonly type: "string";
|
|
537
|
+
readonly description: "Display name override for this user on hyperboards.";
|
|
538
|
+
readonly maxLength: 640;
|
|
539
|
+
readonly maxGraphemes: 64;
|
|
540
|
+
};
|
|
541
|
+
readonly image: {
|
|
542
|
+
readonly type: "union";
|
|
543
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
544
|
+
readonly description: "Avatar or face image override for this user on hyperboards, as a URI or image blob.";
|
|
545
|
+
};
|
|
546
|
+
readonly video: {
|
|
547
|
+
readonly type: "union";
|
|
548
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallVideo"];
|
|
549
|
+
readonly description: "Default video for this user across boards, as a URI (embed/direct link) or uploaded video blob.";
|
|
550
|
+
};
|
|
551
|
+
readonly hoverImage: {
|
|
552
|
+
readonly type: "union";
|
|
553
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
554
|
+
readonly description: "Default hover image for this user across boards, as a URI or image blob.";
|
|
555
|
+
};
|
|
556
|
+
readonly hoverIframeUrl: {
|
|
557
|
+
readonly type: "string";
|
|
558
|
+
readonly format: "uri";
|
|
559
|
+
readonly description: "Default hover iframe URL for this user across boards.";
|
|
560
|
+
readonly maxLength: 2048;
|
|
561
|
+
};
|
|
562
|
+
readonly url: {
|
|
563
|
+
readonly type: "string";
|
|
564
|
+
readonly format: "uri";
|
|
565
|
+
readonly description: "Default click-through link URL for this user across boards.";
|
|
566
|
+
readonly maxLength: 2048;
|
|
567
|
+
};
|
|
568
|
+
readonly createdAt: {
|
|
569
|
+
readonly type: "string";
|
|
570
|
+
readonly format: "datetime";
|
|
571
|
+
readonly description: "Client-declared timestamp when this record was originally created.";
|
|
572
|
+
};
|
|
573
|
+
};
|
|
574
|
+
};
|
|
575
|
+
};
|
|
576
|
+
};
|
|
577
|
+
};
|
|
287
578
|
readonly OrgHypercertsClaimActivity: {
|
|
288
579
|
readonly lexicon: 1;
|
|
289
580
|
readonly id: "org.hypercerts.claim.activity";
|
|
@@ -298,7 +589,7 @@ export declare const schemaDict: {
|
|
|
298
589
|
readonly properties: {
|
|
299
590
|
readonly title: {
|
|
300
591
|
readonly type: "string";
|
|
301
|
-
readonly description: "
|
|
592
|
+
readonly description: "Display title summarizing the impact work (e.g. 'Reforestation in Amazon Basin 2024')";
|
|
302
593
|
readonly maxLength: 256;
|
|
303
594
|
};
|
|
304
595
|
readonly shortDescription: {
|
|
@@ -316,28 +607,28 @@ export declare const schemaDict: {
|
|
|
316
607
|
};
|
|
317
608
|
};
|
|
318
609
|
readonly description: {
|
|
319
|
-
readonly type: "
|
|
320
|
-
readonly
|
|
321
|
-
readonly
|
|
322
|
-
readonly maxGraphemes: 3000;
|
|
323
|
-
};
|
|
324
|
-
readonly descriptionFacets: {
|
|
325
|
-
readonly type: "array";
|
|
326
|
-
readonly description: "Rich text annotations for `description` (mentions, URLs, hashtags, etc).";
|
|
327
|
-
readonly items: {
|
|
328
|
-
readonly type: "ref";
|
|
329
|
-
readonly ref: "lex:app.bsky.richtext.facet";
|
|
330
|
-
};
|
|
610
|
+
readonly type: "ref";
|
|
611
|
+
readonly ref: "lex:pub.leaflet.pages.linearDocument#main";
|
|
612
|
+
readonly description: "Rich-text description, represented as a Leaflet linear document.";
|
|
331
613
|
};
|
|
332
614
|
readonly image: {
|
|
333
615
|
readonly type: "union";
|
|
334
616
|
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
335
617
|
readonly description: "The hypercert visual representation as a URI or image blob.";
|
|
336
618
|
};
|
|
619
|
+
readonly contributors: {
|
|
620
|
+
readonly type: "array";
|
|
621
|
+
readonly description: "An array of contributor objects, each containing contributor information, weight, and contribution details.";
|
|
622
|
+
readonly maxLength: 1000;
|
|
623
|
+
readonly items: {
|
|
624
|
+
readonly type: "ref";
|
|
625
|
+
readonly ref: "lex:org.hypercerts.claim.activity#contributor";
|
|
626
|
+
};
|
|
627
|
+
};
|
|
337
628
|
readonly workScope: {
|
|
338
629
|
readonly type: "union";
|
|
339
|
-
readonly refs: ["lex:
|
|
340
|
-
readonly description: "Work scope definition.
|
|
630
|
+
readonly refs: ["lex:org.hypercerts.workscope.cel", "lex:org.hypercerts.claim.activity#workScopeString"];
|
|
631
|
+
readonly description: "Work scope definition. A CEL expression for structured, machine-evaluable scopes or a free-form string for simple and legacy scopes.";
|
|
341
632
|
};
|
|
342
633
|
readonly startDate: {
|
|
343
634
|
readonly type: "string";
|
|
@@ -349,12 +640,13 @@ export declare const schemaDict: {
|
|
|
349
640
|
readonly format: "datetime";
|
|
350
641
|
readonly description: "When the work ended";
|
|
351
642
|
};
|
|
352
|
-
readonly
|
|
643
|
+
readonly locations: {
|
|
353
644
|
readonly type: "array";
|
|
354
|
-
readonly description: "An array of
|
|
645
|
+
readonly description: "An array of strong references to the location where activity was performed. The record referenced must conform with the lexicon app.certified.location.";
|
|
646
|
+
readonly maxLength: 1000;
|
|
355
647
|
readonly items: {
|
|
356
648
|
readonly type: "ref";
|
|
357
|
-
readonly ref: "lex:
|
|
649
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
358
650
|
};
|
|
359
651
|
};
|
|
360
652
|
readonly rights: {
|
|
@@ -362,14 +654,6 @@ export declare const schemaDict: {
|
|
|
362
654
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
363
655
|
readonly description: "A strong reference to the rights that this hypercert has. The record referenced must conform with the lexicon org.hypercerts.claim.rights.";
|
|
364
656
|
};
|
|
365
|
-
readonly locations: {
|
|
366
|
-
readonly type: "array";
|
|
367
|
-
readonly description: "An array of strong references to the location where activity was performed. The record referenced must conform with the lexicon app.certified.location.";
|
|
368
|
-
readonly items: {
|
|
369
|
-
readonly type: "ref";
|
|
370
|
-
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
371
|
-
};
|
|
372
|
-
};
|
|
373
657
|
readonly createdAt: {
|
|
374
658
|
readonly type: "string";
|
|
375
659
|
readonly format: "datetime";
|
|
@@ -385,16 +669,17 @@ export declare const schemaDict: {
|
|
|
385
669
|
readonly contributorIdentity: {
|
|
386
670
|
readonly type: "union";
|
|
387
671
|
readonly refs: ["lex:org.hypercerts.claim.activity#contributorIdentity", "lex:com.atproto.repo.strongRef"];
|
|
388
|
-
readonly description: "
|
|
672
|
+
readonly description: "Inline contributor identity object with an identity string (DID or identifier) via org.hypercerts.claim.activity#contributorIdentity, or a strong reference to a contributor information record. The record referenced must conform with the lexicon org.hypercerts.claim.contributorInformation.";
|
|
389
673
|
};
|
|
390
674
|
readonly contributionWeight: {
|
|
391
675
|
readonly type: "string";
|
|
392
676
|
readonly 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.";
|
|
677
|
+
readonly maxLength: 100;
|
|
393
678
|
};
|
|
394
679
|
readonly contributionDetails: {
|
|
395
680
|
readonly type: "union";
|
|
396
681
|
readonly refs: ["lex:org.hypercerts.claim.activity#contributorRole", "lex:com.atproto.repo.strongRef"];
|
|
397
|
-
readonly description: "
|
|
682
|
+
readonly description: "Inline contribution role object with a role string via org.hypercerts.claim.activity#contributorRole, or a strong reference to a contribution details record. The record referenced must conform with the lexicon org.hypercerts.claim.contribution.";
|
|
398
683
|
};
|
|
399
684
|
};
|
|
400
685
|
};
|
|
@@ -439,78 +724,75 @@ export declare const schemaDict: {
|
|
|
439
724
|
};
|
|
440
725
|
};
|
|
441
726
|
};
|
|
442
|
-
readonly
|
|
727
|
+
readonly OrgHypercertsClaimContribution: {
|
|
443
728
|
readonly lexicon: 1;
|
|
444
|
-
readonly id: "org.hypercerts.claim.
|
|
729
|
+
readonly id: "org.hypercerts.claim.contribution";
|
|
445
730
|
readonly defs: {
|
|
446
731
|
readonly main: {
|
|
447
732
|
readonly type: "record";
|
|
448
|
-
readonly description: "
|
|
733
|
+
readonly description: "Details about a specific contribution including role, description, and timeframe.";
|
|
449
734
|
readonly key: "tid";
|
|
450
735
|
readonly record: {
|
|
451
736
|
readonly type: "object";
|
|
452
|
-
readonly required: ["
|
|
737
|
+
readonly required: ["createdAt"];
|
|
453
738
|
readonly properties: {
|
|
454
|
-
readonly
|
|
455
|
-
readonly type: "
|
|
456
|
-
readonly description: "
|
|
457
|
-
readonly items: {
|
|
458
|
-
readonly type: "ref";
|
|
459
|
-
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
460
|
-
};
|
|
739
|
+
readonly role: {
|
|
740
|
+
readonly type: "string";
|
|
741
|
+
readonly description: "Role or title of the contributor.";
|
|
461
742
|
readonly maxLength: 100;
|
|
462
743
|
};
|
|
463
|
-
readonly
|
|
744
|
+
readonly contributionDescription: {
|
|
464
745
|
readonly type: "string";
|
|
465
|
-
readonly
|
|
466
|
-
readonly
|
|
467
|
-
|
|
468
|
-
readonly content: {
|
|
469
|
-
readonly type: "array";
|
|
470
|
-
readonly description: "The files, documents, or external references included in this attachment record.";
|
|
471
|
-
readonly items: {
|
|
472
|
-
readonly type: "union";
|
|
473
|
-
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
474
|
-
};
|
|
475
|
-
readonly maxLength: 100;
|
|
746
|
+
readonly description: "Description of what the contribution concretely involved.";
|
|
747
|
+
readonly maxLength: 10000;
|
|
748
|
+
readonly maxGraphemes: 1000;
|
|
476
749
|
};
|
|
477
|
-
readonly
|
|
750
|
+
readonly startDate: {
|
|
478
751
|
readonly type: "string";
|
|
479
|
-
readonly
|
|
480
|
-
readonly description: "
|
|
752
|
+
readonly format: "datetime";
|
|
753
|
+
readonly description: "When this contribution started. Should fall within the parent hypercert's timeframe.";
|
|
481
754
|
};
|
|
482
|
-
readonly
|
|
755
|
+
readonly endDate: {
|
|
483
756
|
readonly type: "string";
|
|
484
|
-
readonly
|
|
485
|
-
readonly
|
|
486
|
-
readonly maxGraphemes: 300;
|
|
757
|
+
readonly format: "datetime";
|
|
758
|
+
readonly description: "When this contribution finished. Should fall within the parent hypercert's timeframe.";
|
|
487
759
|
};
|
|
488
|
-
readonly
|
|
489
|
-
readonly type: "
|
|
490
|
-
readonly
|
|
491
|
-
readonly
|
|
492
|
-
readonly type: "ref";
|
|
493
|
-
readonly ref: "lex:app.bsky.richtext.facet";
|
|
494
|
-
};
|
|
760
|
+
readonly createdAt: {
|
|
761
|
+
readonly type: "string";
|
|
762
|
+
readonly format: "datetime";
|
|
763
|
+
readonly description: "Client-declared timestamp when this record was originally created.";
|
|
495
764
|
};
|
|
496
|
-
|
|
765
|
+
};
|
|
766
|
+
};
|
|
767
|
+
};
|
|
768
|
+
};
|
|
769
|
+
};
|
|
770
|
+
readonly OrgHypercertsClaimContributorInformation: {
|
|
771
|
+
readonly lexicon: 1;
|
|
772
|
+
readonly id: "org.hypercerts.claim.contributorInformation";
|
|
773
|
+
readonly defs: {
|
|
774
|
+
readonly main: {
|
|
775
|
+
readonly type: "record";
|
|
776
|
+
readonly description: "Contributor information including identifier, display name, and image.";
|
|
777
|
+
readonly key: "tid";
|
|
778
|
+
readonly record: {
|
|
779
|
+
readonly type: "object";
|
|
780
|
+
readonly required: ["createdAt"];
|
|
781
|
+
readonly properties: {
|
|
782
|
+
readonly identifier: {
|
|
497
783
|
readonly type: "string";
|
|
498
|
-
readonly description: "
|
|
499
|
-
readonly maxLength:
|
|
500
|
-
readonly maxGraphemes: 3000;
|
|
784
|
+
readonly description: "DID (did:plc:...) or URI to a social profile of the contributor.";
|
|
785
|
+
readonly maxLength: 2048;
|
|
501
786
|
};
|
|
502
|
-
readonly
|
|
503
|
-
readonly type: "
|
|
504
|
-
readonly description: "
|
|
505
|
-
readonly
|
|
506
|
-
readonly type: "ref";
|
|
507
|
-
readonly ref: "lex:app.bsky.richtext.facet";
|
|
508
|
-
};
|
|
787
|
+
readonly displayName: {
|
|
788
|
+
readonly type: "string";
|
|
789
|
+
readonly description: "Human-readable name for the contributor as it should appear in UI.";
|
|
790
|
+
readonly maxLength: 100;
|
|
509
791
|
};
|
|
510
|
-
readonly
|
|
511
|
-
readonly type: "
|
|
512
|
-
readonly
|
|
513
|
-
readonly description: "
|
|
792
|
+
readonly image: {
|
|
793
|
+
readonly type: "union";
|
|
794
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
795
|
+
readonly description: "The contributor visual representation as a URI or image blob.";
|
|
514
796
|
};
|
|
515
797
|
readonly createdAt: {
|
|
516
798
|
readonly type: "string";
|
|
@@ -522,9 +804,52 @@ export declare const schemaDict: {
|
|
|
522
804
|
};
|
|
523
805
|
};
|
|
524
806
|
};
|
|
525
|
-
readonly
|
|
807
|
+
readonly OrgHypercertsClaimRights: {
|
|
526
808
|
readonly lexicon: 1;
|
|
527
|
-
readonly id: "org.hypercerts.claim.
|
|
809
|
+
readonly id: "org.hypercerts.claim.rights";
|
|
810
|
+
readonly defs: {
|
|
811
|
+
readonly main: {
|
|
812
|
+
readonly type: "record";
|
|
813
|
+
readonly 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.";
|
|
814
|
+
readonly key: "tid";
|
|
815
|
+
readonly record: {
|
|
816
|
+
readonly type: "object";
|
|
817
|
+
readonly required: ["rightsName", "rightsType", "rightsDescription", "createdAt"];
|
|
818
|
+
readonly properties: {
|
|
819
|
+
readonly rightsName: {
|
|
820
|
+
readonly type: "string";
|
|
821
|
+
readonly description: "Human-readable name for these rights (e.g. 'All Rights Reserved', 'CC BY-SA 4.0')";
|
|
822
|
+
readonly maxLength: 100;
|
|
823
|
+
};
|
|
824
|
+
readonly rightsType: {
|
|
825
|
+
readonly type: "string";
|
|
826
|
+
readonly description: "Short identifier code for this rights type (e.g. 'ARR', 'CC-BY-SA') to facilitate filtering and search";
|
|
827
|
+
readonly maxLength: 10;
|
|
828
|
+
};
|
|
829
|
+
readonly rightsDescription: {
|
|
830
|
+
readonly type: "string";
|
|
831
|
+
readonly description: "Detailed explanation of the rights holders' permissions, restrictions, and conditions";
|
|
832
|
+
readonly maxLength: 10000;
|
|
833
|
+
readonly maxGraphemes: 1000;
|
|
834
|
+
};
|
|
835
|
+
readonly attachment: {
|
|
836
|
+
readonly type: "union";
|
|
837
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
838
|
+
readonly description: "An attachment to define the rights further, e.g. a legal document.";
|
|
839
|
+
};
|
|
840
|
+
readonly createdAt: {
|
|
841
|
+
readonly type: "string";
|
|
842
|
+
readonly format: "datetime";
|
|
843
|
+
readonly description: "Client-declared timestamp when this record was originally created";
|
|
844
|
+
};
|
|
845
|
+
};
|
|
846
|
+
};
|
|
847
|
+
};
|
|
848
|
+
};
|
|
849
|
+
};
|
|
850
|
+
readonly OrgHypercertsCollection: {
|
|
851
|
+
readonly lexicon: 1;
|
|
852
|
+
readonly id: "org.hypercerts.collection";
|
|
528
853
|
readonly defs: {
|
|
529
854
|
readonly main: {
|
|
530
855
|
readonly type: "record";
|
|
@@ -532,15 +857,16 @@ export declare const schemaDict: {
|
|
|
532
857
|
readonly key: "tid";
|
|
533
858
|
readonly record: {
|
|
534
859
|
readonly type: "object";
|
|
535
|
-
readonly required: ["title", "
|
|
860
|
+
readonly required: ["title", "createdAt"];
|
|
536
861
|
readonly properties: {
|
|
537
862
|
readonly type: {
|
|
538
863
|
readonly type: "string";
|
|
539
864
|
readonly description: "The type of this collection. Possible fields can be 'favorites', 'project', or any other type of collection.";
|
|
865
|
+
readonly maxLength: 64;
|
|
540
866
|
};
|
|
541
867
|
readonly title: {
|
|
542
868
|
readonly type: "string";
|
|
543
|
-
readonly description: "
|
|
869
|
+
readonly description: "Display name for this collection (e.g. 'Q1 2025 Impact Projects')";
|
|
544
870
|
readonly maxLength: 800;
|
|
545
871
|
readonly maxGraphemes: 80;
|
|
546
872
|
};
|
|
@@ -568,9 +894,10 @@ export declare const schemaDict: {
|
|
|
568
894
|
readonly items: {
|
|
569
895
|
readonly type: "array";
|
|
570
896
|
readonly description: "Array of items in this collection with optional weights.";
|
|
897
|
+
readonly maxLength: 1000;
|
|
571
898
|
readonly items: {
|
|
572
899
|
readonly type: "ref";
|
|
573
|
-
readonly ref: "lex:org.hypercerts.
|
|
900
|
+
readonly ref: "lex:org.hypercerts.collection#item";
|
|
574
901
|
};
|
|
575
902
|
};
|
|
576
903
|
readonly location: {
|
|
@@ -593,48 +920,48 @@ export declare const schemaDict: {
|
|
|
593
920
|
readonly itemIdentifier: {
|
|
594
921
|
readonly type: "ref";
|
|
595
922
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
596
|
-
readonly description: "Strong reference to an item in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.
|
|
923
|
+
readonly description: "Strong reference to an item in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.collection).";
|
|
597
924
|
};
|
|
598
925
|
readonly itemWeight: {
|
|
599
926
|
readonly type: "string";
|
|
600
927
|
readonly 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.";
|
|
928
|
+
readonly maxLength: 100;
|
|
601
929
|
};
|
|
602
930
|
};
|
|
603
931
|
};
|
|
604
932
|
};
|
|
605
933
|
};
|
|
606
|
-
readonly
|
|
934
|
+
readonly OrgHypercertsContextAcknowledgement: {
|
|
607
935
|
readonly lexicon: 1;
|
|
608
|
-
readonly id: "org.hypercerts.
|
|
936
|
+
readonly id: "org.hypercerts.context.acknowledgement";
|
|
609
937
|
readonly defs: {
|
|
610
938
|
readonly main: {
|
|
611
939
|
readonly type: "record";
|
|
612
|
-
readonly description: "
|
|
940
|
+
readonly description: "Acknowledges a record (subject) or its relationship in a context. Created in the acknowledging actor's repo to form a bidirectional link. Examples: a contributor acknowledging inclusion in an activity, an activity owner acknowledging inclusion in a collection, or a record owner acknowledging an evaluation.";
|
|
613
941
|
readonly key: "tid";
|
|
614
942
|
readonly record: {
|
|
615
943
|
readonly type: "object";
|
|
616
|
-
readonly required: ["createdAt"];
|
|
944
|
+
readonly required: ["subject", "acknowledged", "createdAt"];
|
|
617
945
|
readonly properties: {
|
|
618
|
-
readonly
|
|
619
|
-
readonly type: "
|
|
620
|
-
readonly
|
|
621
|
-
readonly
|
|
946
|
+
readonly subject: {
|
|
947
|
+
readonly type: "ref";
|
|
948
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
949
|
+
readonly description: "The record being acknowledged (e.g. an activity, a contributor information record, an evaluation).";
|
|
622
950
|
};
|
|
623
|
-
readonly
|
|
624
|
-
readonly type: "
|
|
625
|
-
readonly
|
|
626
|
-
readonly
|
|
627
|
-
readonly maxGraphemes: 1000;
|
|
951
|
+
readonly context: {
|
|
952
|
+
readonly type: "union";
|
|
953
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:com.atproto.repo.strongRef"];
|
|
954
|
+
readonly description: "Context for the acknowledgement (e.g. the collection that includes an activity, or the activity that includes a contributor). A URI for a lightweight reference or a strong reference for content-hash verification.";
|
|
628
955
|
};
|
|
629
|
-
readonly
|
|
630
|
-
readonly type: "
|
|
631
|
-
readonly
|
|
632
|
-
readonly description: "When this contribution started. This should be a subset of the hypercert timeframe.";
|
|
956
|
+
readonly acknowledged: {
|
|
957
|
+
readonly type: "boolean";
|
|
958
|
+
readonly description: "Whether the relationship is acknowledged (true) or rejected (false).";
|
|
633
959
|
};
|
|
634
|
-
readonly
|
|
960
|
+
readonly comment: {
|
|
635
961
|
readonly type: "string";
|
|
636
|
-
readonly
|
|
637
|
-
readonly
|
|
962
|
+
readonly description: "Optional plain-text comment providing additional context or reasoning.";
|
|
963
|
+
readonly maxLength: 10000;
|
|
964
|
+
readonly maxGraphemes: 1000;
|
|
638
965
|
};
|
|
639
966
|
readonly createdAt: {
|
|
640
967
|
readonly type: "string";
|
|
@@ -646,31 +973,69 @@ export declare const schemaDict: {
|
|
|
646
973
|
};
|
|
647
974
|
};
|
|
648
975
|
};
|
|
649
|
-
readonly
|
|
976
|
+
readonly OrgHypercertsContextAttachment: {
|
|
650
977
|
readonly lexicon: 1;
|
|
651
|
-
readonly id: "org.hypercerts.
|
|
978
|
+
readonly id: "org.hypercerts.context.attachment";
|
|
652
979
|
readonly defs: {
|
|
653
980
|
readonly main: {
|
|
654
981
|
readonly type: "record";
|
|
655
|
-
readonly description: "
|
|
982
|
+
readonly description: "An attachment providing commentary, context, evidence, or documentary material related to a hypercert record (e.g. an activity, project, claim, or evaluation).";
|
|
656
983
|
readonly key: "tid";
|
|
657
984
|
readonly record: {
|
|
658
985
|
readonly type: "object";
|
|
659
|
-
readonly required: ["createdAt"];
|
|
986
|
+
readonly required: ["title", "createdAt"];
|
|
660
987
|
readonly properties: {
|
|
661
|
-
readonly
|
|
662
|
-
readonly type: "
|
|
663
|
-
readonly description: "
|
|
988
|
+
readonly subjects: {
|
|
989
|
+
readonly type: "array";
|
|
990
|
+
readonly description: "References to the subject(s) the attachment is connected to—this may be an activity claim, outcome claim, measurement, evaluation, or even another attachment. This is optional as the attachment can exist before the claim is recorded.";
|
|
991
|
+
readonly items: {
|
|
992
|
+
readonly type: "ref";
|
|
993
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
994
|
+
};
|
|
995
|
+
readonly maxLength: 100;
|
|
664
996
|
};
|
|
665
|
-
readonly
|
|
997
|
+
readonly contentType: {
|
|
666
998
|
readonly type: "string";
|
|
667
|
-
readonly
|
|
999
|
+
readonly maxLength: 64;
|
|
1000
|
+
readonly description: "The type of attachment, e.g. report, audit, evidence, testimonial, methodology, etc.";
|
|
1001
|
+
};
|
|
1002
|
+
readonly content: {
|
|
1003
|
+
readonly type: "array";
|
|
1004
|
+
readonly description: "The files, documents, or external references included in this attachment record.";
|
|
1005
|
+
readonly items: {
|
|
1006
|
+
readonly type: "union";
|
|
1007
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
1008
|
+
};
|
|
668
1009
|
readonly maxLength: 100;
|
|
669
1010
|
};
|
|
670
|
-
readonly
|
|
671
|
-
readonly type: "
|
|
672
|
-
readonly
|
|
673
|
-
readonly description: "
|
|
1011
|
+
readonly title: {
|
|
1012
|
+
readonly type: "string";
|
|
1013
|
+
readonly maxLength: 256;
|
|
1014
|
+
readonly description: "Display title for this attachment (e.g. 'Impact Assessment Report', 'Audit Findings')";
|
|
1015
|
+
};
|
|
1016
|
+
readonly shortDescription: {
|
|
1017
|
+
readonly type: "string";
|
|
1018
|
+
readonly description: "Short summary of this attachment, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.";
|
|
1019
|
+
readonly maxLength: 3000;
|
|
1020
|
+
readonly maxGraphemes: 300;
|
|
1021
|
+
};
|
|
1022
|
+
readonly shortDescriptionFacets: {
|
|
1023
|
+
readonly type: "array";
|
|
1024
|
+
readonly description: "Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc).";
|
|
1025
|
+
readonly items: {
|
|
1026
|
+
readonly type: "ref";
|
|
1027
|
+
readonly ref: "lex:app.bsky.richtext.facet";
|
|
1028
|
+
};
|
|
1029
|
+
};
|
|
1030
|
+
readonly description: {
|
|
1031
|
+
readonly type: "ref";
|
|
1032
|
+
readonly ref: "lex:pub.leaflet.pages.linearDocument#main";
|
|
1033
|
+
readonly description: "Rich-text description, represented as a Leaflet linear document.";
|
|
1034
|
+
};
|
|
1035
|
+
readonly location: {
|
|
1036
|
+
readonly type: "ref";
|
|
1037
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1038
|
+
readonly description: "A strong reference to the location where this attachment's subject matter occurred. The record referenced must conform with the lexicon app.certified.location.";
|
|
674
1039
|
};
|
|
675
1040
|
readonly createdAt: {
|
|
676
1041
|
readonly type: "string";
|
|
@@ -682,29 +1047,10 @@ export declare const schemaDict: {
|
|
|
682
1047
|
};
|
|
683
1048
|
};
|
|
684
1049
|
};
|
|
685
|
-
readonly
|
|
1050
|
+
readonly OrgHypercertsContextEvaluation: {
|
|
686
1051
|
readonly lexicon: 1;
|
|
687
|
-
readonly id: "org.hypercerts.
|
|
1052
|
+
readonly id: "org.hypercerts.context.evaluation";
|
|
688
1053
|
readonly defs: {
|
|
689
|
-
readonly score: {
|
|
690
|
-
readonly type: "object";
|
|
691
|
-
readonly description: "Overall score for an evaluation on a numeric scale.";
|
|
692
|
-
readonly required: ["min", "max", "value"];
|
|
693
|
-
readonly properties: {
|
|
694
|
-
readonly min: {
|
|
695
|
-
readonly type: "integer";
|
|
696
|
-
readonly description: "Minimum value of the scale, e.g. 0 or 1.";
|
|
697
|
-
};
|
|
698
|
-
readonly max: {
|
|
699
|
-
readonly type: "integer";
|
|
700
|
-
readonly description: "Maximum value of the scale, e.g. 5 or 10.";
|
|
701
|
-
};
|
|
702
|
-
readonly value: {
|
|
703
|
-
readonly type: "integer";
|
|
704
|
-
readonly description: "Score within the inclusive range [min, max].";
|
|
705
|
-
};
|
|
706
|
-
};
|
|
707
|
-
};
|
|
708
1054
|
readonly main: {
|
|
709
1055
|
readonly type: "record";
|
|
710
1056
|
readonly description: "An evaluation of a hypercert record (e.g. an activity and its impact).";
|
|
@@ -716,7 +1062,7 @@ export declare const schemaDict: {
|
|
|
716
1062
|
readonly subject: {
|
|
717
1063
|
readonly type: "ref";
|
|
718
1064
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
719
|
-
readonly description: "A strong reference to what is being evaluated
|
|
1065
|
+
readonly description: "A strong reference to what is being evaluated (e.g. activity, measurement, contribution, etc.)";
|
|
720
1066
|
};
|
|
721
1067
|
readonly evaluators: {
|
|
722
1068
|
readonly type: "array";
|
|
@@ -738,7 +1084,7 @@ export declare const schemaDict: {
|
|
|
738
1084
|
};
|
|
739
1085
|
readonly measurements: {
|
|
740
1086
|
readonly type: "array";
|
|
741
|
-
readonly description: "Optional references to the measurements that contributed to this evaluation. The record(s) referenced must conform with the lexicon org.hypercerts.
|
|
1087
|
+
readonly description: "Optional references to the measurements that contributed to this evaluation. The record(s) referenced must conform with the lexicon org.hypercerts.context.measurement";
|
|
742
1088
|
readonly items: {
|
|
743
1089
|
readonly type: "ref";
|
|
744
1090
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
@@ -753,7 +1099,7 @@ export declare const schemaDict: {
|
|
|
753
1099
|
};
|
|
754
1100
|
readonly score: {
|
|
755
1101
|
readonly type: "ref";
|
|
756
|
-
readonly ref: "lex:org.hypercerts.
|
|
1102
|
+
readonly ref: "lex:org.hypercerts.context.evaluation#score";
|
|
757
1103
|
readonly description: "Optional overall score for this evaluation on a numeric scale.";
|
|
758
1104
|
};
|
|
759
1105
|
readonly location: {
|
|
@@ -769,24 +1115,47 @@ export declare const schemaDict: {
|
|
|
769
1115
|
};
|
|
770
1116
|
};
|
|
771
1117
|
};
|
|
1118
|
+
readonly score: {
|
|
1119
|
+
readonly type: "object";
|
|
1120
|
+
readonly description: "Overall score for an evaluation on a numeric scale.";
|
|
1121
|
+
readonly required: ["min", "max", "value"];
|
|
1122
|
+
readonly properties: {
|
|
1123
|
+
readonly min: {
|
|
1124
|
+
readonly type: "integer";
|
|
1125
|
+
readonly description: "Minimum value of the scale, e.g. 0 or 1.";
|
|
1126
|
+
};
|
|
1127
|
+
readonly max: {
|
|
1128
|
+
readonly type: "integer";
|
|
1129
|
+
readonly description: "Maximum value of the scale, e.g. 5 or 10.";
|
|
1130
|
+
};
|
|
1131
|
+
readonly value: {
|
|
1132
|
+
readonly type: "integer";
|
|
1133
|
+
readonly description: "Score within the inclusive range [min, max].";
|
|
1134
|
+
};
|
|
1135
|
+
};
|
|
1136
|
+
};
|
|
772
1137
|
};
|
|
773
1138
|
};
|
|
774
|
-
readonly
|
|
1139
|
+
readonly OrgHypercertsContextMeasurement: {
|
|
775
1140
|
readonly lexicon: 1;
|
|
776
|
-
readonly id: "org.hypercerts.
|
|
1141
|
+
readonly id: "org.hypercerts.context.measurement";
|
|
777
1142
|
readonly defs: {
|
|
778
1143
|
readonly main: {
|
|
779
1144
|
readonly type: "record";
|
|
780
|
-
readonly description: "Measurement data related to
|
|
1145
|
+
readonly description: "Measurement data related to one or more records (e.g. activities, projects, etc.).";
|
|
781
1146
|
readonly key: "tid";
|
|
782
1147
|
readonly record: {
|
|
783
1148
|
readonly type: "object";
|
|
784
1149
|
readonly required: ["metric", "unit", "value", "createdAt"];
|
|
785
1150
|
readonly properties: {
|
|
786
|
-
readonly
|
|
787
|
-
readonly type: "
|
|
788
|
-
readonly
|
|
789
|
-
readonly
|
|
1151
|
+
readonly subjects: {
|
|
1152
|
+
readonly type: "array";
|
|
1153
|
+
readonly description: "Strong references to the records this measurement refers to (e.g. activities, projects, or claims).";
|
|
1154
|
+
readonly items: {
|
|
1155
|
+
readonly type: "ref";
|
|
1156
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1157
|
+
};
|
|
1158
|
+
readonly maxLength: 100;
|
|
790
1159
|
};
|
|
791
1160
|
readonly metric: {
|
|
792
1161
|
readonly type: "string";
|
|
@@ -800,7 +1169,7 @@ export declare const schemaDict: {
|
|
|
800
1169
|
};
|
|
801
1170
|
readonly value: {
|
|
802
1171
|
readonly type: "string";
|
|
803
|
-
readonly description: "The measured numeric
|
|
1172
|
+
readonly description: "The measured value as a numeric string (e.g. '1234.56')";
|
|
804
1173
|
readonly maxLength: 500;
|
|
805
1174
|
};
|
|
806
1175
|
readonly startDate: {
|
|
@@ -811,7 +1180,7 @@ export declare const schemaDict: {
|
|
|
811
1180
|
readonly endDate: {
|
|
812
1181
|
readonly type: "string";
|
|
813
1182
|
readonly format: "datetime";
|
|
814
|
-
readonly description: "The end date and time when the measurement ended.
|
|
1183
|
+
readonly description: "The end date and time when the measurement ended. For one-time measurements, this should equal the start date.";
|
|
815
1184
|
};
|
|
816
1185
|
readonly locations: {
|
|
817
1186
|
readonly type: "array";
|
|
@@ -843,7 +1212,7 @@ export declare const schemaDict: {
|
|
|
843
1212
|
};
|
|
844
1213
|
readonly measurers: {
|
|
845
1214
|
readonly type: "array";
|
|
846
|
-
readonly description: "DIDs of the
|
|
1215
|
+
readonly description: "DIDs of the entities that performed this measurement";
|
|
847
1216
|
readonly items: {
|
|
848
1217
|
readonly type: "ref";
|
|
849
1218
|
readonly ref: "lex:app.certified.defs#did";
|
|
@@ -874,50 +1243,10 @@ export declare const schemaDict: {
|
|
|
874
1243
|
};
|
|
875
1244
|
};
|
|
876
1245
|
};
|
|
877
|
-
readonly OrgHypercertsClaimRights: {
|
|
878
|
-
readonly lexicon: 1;
|
|
879
|
-
readonly id: "org.hypercerts.claim.rights";
|
|
880
|
-
readonly defs: {
|
|
881
|
-
readonly main: {
|
|
882
|
-
readonly type: "record";
|
|
883
|
-
readonly 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.";
|
|
884
|
-
readonly key: "tid";
|
|
885
|
-
readonly record: {
|
|
886
|
-
readonly type: "object";
|
|
887
|
-
readonly required: ["rightsName", "rightsType", "rightsDescription", "createdAt"];
|
|
888
|
-
readonly properties: {
|
|
889
|
-
readonly rightsName: {
|
|
890
|
-
readonly type: "string";
|
|
891
|
-
readonly description: "Full name of the rights";
|
|
892
|
-
readonly maxLength: 100;
|
|
893
|
-
};
|
|
894
|
-
readonly rightsType: {
|
|
895
|
-
readonly type: "string";
|
|
896
|
-
readonly description: "Short rights identifier for easier search";
|
|
897
|
-
readonly maxLength: 10;
|
|
898
|
-
};
|
|
899
|
-
readonly rightsDescription: {
|
|
900
|
-
readonly type: "string";
|
|
901
|
-
readonly description: "Description of the rights of this hypercert";
|
|
902
|
-
};
|
|
903
|
-
readonly attachment: {
|
|
904
|
-
readonly type: "union";
|
|
905
|
-
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
906
|
-
readonly description: "An attachment to define the rights further, e.g. a legal document.";
|
|
907
|
-
};
|
|
908
|
-
readonly createdAt: {
|
|
909
|
-
readonly type: "string";
|
|
910
|
-
readonly format: "datetime";
|
|
911
|
-
readonly description: "Client-declared timestamp when this record was originally created";
|
|
912
|
-
};
|
|
913
|
-
};
|
|
914
|
-
};
|
|
915
|
-
};
|
|
916
|
-
};
|
|
917
|
-
};
|
|
918
1246
|
readonly OrgHypercertsDefs: {
|
|
919
1247
|
readonly lexicon: 1;
|
|
920
1248
|
readonly id: "org.hypercerts.defs";
|
|
1249
|
+
readonly description: "Common type definitions used across all Hypercerts protocols.";
|
|
921
1250
|
readonly defs: {
|
|
922
1251
|
readonly uri: {
|
|
923
1252
|
readonly type: "object";
|
|
@@ -927,7 +1256,6 @@ export declare const schemaDict: {
|
|
|
927
1256
|
readonly uri: {
|
|
928
1257
|
readonly type: "string";
|
|
929
1258
|
readonly format: "uri";
|
|
930
|
-
readonly maxGraphemes: 1024;
|
|
931
1259
|
readonly description: "URI to external data";
|
|
932
1260
|
};
|
|
933
1261
|
};
|
|
@@ -971,6 +1299,19 @@ export declare const schemaDict: {
|
|
|
971
1299
|
};
|
|
972
1300
|
};
|
|
973
1301
|
};
|
|
1302
|
+
readonly smallVideo: {
|
|
1303
|
+
readonly type: "object";
|
|
1304
|
+
readonly required: ["video"];
|
|
1305
|
+
readonly description: "Object containing a small video";
|
|
1306
|
+
readonly properties: {
|
|
1307
|
+
readonly video: {
|
|
1308
|
+
readonly type: "blob";
|
|
1309
|
+
readonly accept: ["video/mp4", "video/webm"];
|
|
1310
|
+
readonly maxSize: 20971520;
|
|
1311
|
+
readonly description: "Video (up to 20MB)";
|
|
1312
|
+
};
|
|
1313
|
+
};
|
|
1314
|
+
};
|
|
974
1315
|
readonly largeImage: {
|
|
975
1316
|
readonly type: "object";
|
|
976
1317
|
readonly required: ["image"];
|
|
@@ -1006,26 +1347,32 @@ export declare const schemaDict: {
|
|
|
1006
1347
|
readonly to: {
|
|
1007
1348
|
readonly type: "string";
|
|
1008
1349
|
readonly description: "The recipient of the funds. Can be identified by DID or a clear-text name.";
|
|
1350
|
+
readonly maxLength: 2048;
|
|
1009
1351
|
};
|
|
1010
1352
|
readonly amount: {
|
|
1011
1353
|
readonly type: "string";
|
|
1012
|
-
readonly description: "Amount of funding received.";
|
|
1354
|
+
readonly description: "Amount of funding received as a numeric string (e.g. '1000.50').";
|
|
1355
|
+
readonly maxLength: 50;
|
|
1013
1356
|
};
|
|
1014
1357
|
readonly currency: {
|
|
1015
1358
|
readonly type: "string";
|
|
1016
1359
|
readonly description: "Currency of the payment (e.g. EUR, USD, ETH).";
|
|
1360
|
+
readonly maxLength: 10;
|
|
1017
1361
|
};
|
|
1018
1362
|
readonly paymentRail: {
|
|
1019
1363
|
readonly type: "string";
|
|
1020
1364
|
readonly description: "How the funds were transferred (e.g. bank_transfer, credit_card, onchain, cash, check, payment_processor).";
|
|
1365
|
+
readonly maxLength: 50;
|
|
1021
1366
|
};
|
|
1022
1367
|
readonly paymentNetwork: {
|
|
1023
1368
|
readonly type: "string";
|
|
1024
1369
|
readonly description: "Optional network within the payment rail (e.g. arbitrum, ethereum, sepa, visa, paypal).";
|
|
1370
|
+
readonly maxLength: 50;
|
|
1025
1371
|
};
|
|
1026
1372
|
readonly transactionId: {
|
|
1027
1373
|
readonly type: "string";
|
|
1028
1374
|
readonly 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.";
|
|
1375
|
+
readonly maxLength: 256;
|
|
1029
1376
|
};
|
|
1030
1377
|
readonly for: {
|
|
1031
1378
|
readonly type: "string";
|
|
@@ -1052,36 +1399,71 @@ export declare const schemaDict: {
|
|
|
1052
1399
|
};
|
|
1053
1400
|
};
|
|
1054
1401
|
};
|
|
1055
|
-
readonly
|
|
1402
|
+
readonly OrgHypercertsWorkscopeCel: {
|
|
1403
|
+
readonly lexicon: 1;
|
|
1404
|
+
readonly id: "org.hypercerts.workscope.cel";
|
|
1405
|
+
readonly defs: {
|
|
1406
|
+
readonly main: {
|
|
1407
|
+
readonly type: "object";
|
|
1408
|
+
readonly 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.";
|
|
1409
|
+
readonly required: ["expression", "usedTags", "version", "createdAt"];
|
|
1410
|
+
readonly properties: {
|
|
1411
|
+
readonly expression: {
|
|
1412
|
+
readonly type: "string";
|
|
1413
|
+
readonly maxLength: 10000;
|
|
1414
|
+
readonly maxGraphemes: 5000;
|
|
1415
|
+
readonly description: "A CEL expression encoding the work scope conditions. Example: scope.hasAll(['mangrove_restoration', 'environmental_education']) && location.country == 'KE'";
|
|
1416
|
+
};
|
|
1417
|
+
readonly usedTags: {
|
|
1418
|
+
readonly type: "array";
|
|
1419
|
+
readonly items: {
|
|
1420
|
+
readonly type: "ref";
|
|
1421
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1422
|
+
};
|
|
1423
|
+
readonly maxLength: 100;
|
|
1424
|
+
readonly 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.";
|
|
1425
|
+
};
|
|
1426
|
+
readonly version: {
|
|
1427
|
+
readonly type: "string";
|
|
1428
|
+
readonly maxLength: 16;
|
|
1429
|
+
readonly knownValues: ["v1"];
|
|
1430
|
+
readonly description: "CEL context schema version.";
|
|
1431
|
+
};
|
|
1432
|
+
readonly createdAt: {
|
|
1433
|
+
readonly type: "string";
|
|
1434
|
+
readonly format: "datetime";
|
|
1435
|
+
readonly description: "Client-declared timestamp when this expression was originally created.";
|
|
1436
|
+
};
|
|
1437
|
+
};
|
|
1438
|
+
};
|
|
1439
|
+
};
|
|
1440
|
+
};
|
|
1441
|
+
readonly OrgHypercertsWorkscopeTag: {
|
|
1056
1442
|
readonly lexicon: 1;
|
|
1057
|
-
readonly id: "org.hypercerts.
|
|
1443
|
+
readonly id: "org.hypercerts.workscope.tag";
|
|
1058
1444
|
readonly defs: {
|
|
1059
1445
|
readonly main: {
|
|
1060
1446
|
readonly type: "record";
|
|
1061
|
-
readonly description: "A reusable scope atom for work scope logic expressions. Scopes can represent topics, languages, domains, deliverables, methods, regions, tags, or other categorical labels.";
|
|
1447
|
+
readonly 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.";
|
|
1062
1448
|
readonly key: "tid";
|
|
1063
1449
|
readonly record: {
|
|
1064
1450
|
readonly type: "object";
|
|
1065
|
-
readonly required: ["
|
|
1451
|
+
readonly required: ["key", "name", "createdAt"];
|
|
1066
1452
|
readonly properties: {
|
|
1067
|
-
readonly createdAt: {
|
|
1068
|
-
readonly type: "string";
|
|
1069
|
-
readonly format: "datetime";
|
|
1070
|
-
readonly description: "Client-declared timestamp when this record was originally created";
|
|
1071
|
-
};
|
|
1072
1453
|
readonly key: {
|
|
1073
1454
|
readonly type: "string";
|
|
1074
|
-
readonly description: "Lowercase,
|
|
1455
|
+
readonly description: "Lowercase, underscore-separated machine-readable key for this scope (e.g., 'mangrove_restoration', 'biodiversity_monitoring'). Used as the canonical identifier in CEL expressions.";
|
|
1075
1456
|
readonly maxLength: 120;
|
|
1076
1457
|
};
|
|
1077
|
-
readonly
|
|
1458
|
+
readonly name: {
|
|
1078
1459
|
readonly type: "string";
|
|
1079
|
-
readonly description: "Human-readable
|
|
1460
|
+
readonly description: "Human-readable name for this scope.";
|
|
1080
1461
|
readonly maxLength: 200;
|
|
1081
1462
|
};
|
|
1082
|
-
readonly
|
|
1463
|
+
readonly category: {
|
|
1083
1464
|
readonly type: "string";
|
|
1084
|
-
readonly description: "Category type of this scope.
|
|
1465
|
+
readonly description: "Category type of this scope.";
|
|
1466
|
+
readonly knownValues: ["topic", "language", "domain", "method"];
|
|
1085
1467
|
readonly maxLength: 50;
|
|
1086
1468
|
};
|
|
1087
1469
|
readonly description: {
|
|
@@ -1093,7 +1475,18 @@ export declare const schemaDict: {
|
|
|
1093
1475
|
readonly parent: {
|
|
1094
1476
|
readonly type: "ref";
|
|
1095
1477
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1096
|
-
readonly description: "Optional strong reference to a parent scope record for taxonomy/hierarchy support.";
|
|
1478
|
+
readonly 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.";
|
|
1479
|
+
};
|
|
1480
|
+
readonly status: {
|
|
1481
|
+
readonly type: "string";
|
|
1482
|
+
readonly description: "Lifecycle status of this tag. Communities propose tags, curators accept them, deprecated tags point to replacements via supersededBy.";
|
|
1483
|
+
readonly knownValues: ["proposed", "accepted", "deprecated"];
|
|
1484
|
+
readonly maxLength: 20;
|
|
1485
|
+
};
|
|
1486
|
+
readonly supersededBy: {
|
|
1487
|
+
readonly type: "ref";
|
|
1488
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1489
|
+
readonly 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.";
|
|
1097
1490
|
};
|
|
1098
1491
|
readonly aliases: {
|
|
1099
1492
|
readonly type: "array";
|
|
@@ -1102,32 +1495,118 @@ export declare const schemaDict: {
|
|
|
1102
1495
|
readonly maxLength: 200;
|
|
1103
1496
|
};
|
|
1104
1497
|
readonly maxLength: 50;
|
|
1105
|
-
readonly description: "
|
|
1498
|
+
readonly 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.";
|
|
1106
1499
|
};
|
|
1107
|
-
readonly
|
|
1500
|
+
readonly sameAs: {
|
|
1501
|
+
readonly type: "array";
|
|
1502
|
+
readonly items: {
|
|
1503
|
+
readonly type: "string";
|
|
1504
|
+
readonly format: "uri";
|
|
1505
|
+
readonly maxLength: 2048;
|
|
1506
|
+
};
|
|
1507
|
+
readonly maxLength: 20;
|
|
1508
|
+
readonly 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.";
|
|
1509
|
+
};
|
|
1510
|
+
readonly referenceDocument: {
|
|
1108
1511
|
readonly type: "union";
|
|
1109
1512
|
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
1110
|
-
readonly description: "
|
|
1513
|
+
readonly description: "Link to a governance or reference document where this work scope tag is defined and further explained.";
|
|
1514
|
+
};
|
|
1515
|
+
readonly createdAt: {
|
|
1516
|
+
readonly type: "string";
|
|
1517
|
+
readonly format: "datetime";
|
|
1518
|
+
readonly description: "Client-declared timestamp when this record was originally created.";
|
|
1111
1519
|
};
|
|
1112
1520
|
};
|
|
1113
1521
|
};
|
|
1114
1522
|
};
|
|
1115
1523
|
};
|
|
1116
1524
|
};
|
|
1117
|
-
};
|
|
1118
|
-
export declare const schemas: ({
|
|
1525
|
+
};
|
|
1526
|
+
export declare const schemas: ({
|
|
1527
|
+
readonly lexicon: 1;
|
|
1528
|
+
readonly id: "app.certified.actor.organization";
|
|
1529
|
+
readonly defs: {
|
|
1530
|
+
readonly main: {
|
|
1531
|
+
readonly type: "record";
|
|
1532
|
+
readonly description: "Extended metadata for an organization actor. Complements the base actor profile with organization-specific fields like legal structure and reference links.";
|
|
1533
|
+
readonly key: "literal:self";
|
|
1534
|
+
readonly record: {
|
|
1535
|
+
readonly type: "object";
|
|
1536
|
+
readonly required: ["createdAt"];
|
|
1537
|
+
readonly properties: {
|
|
1538
|
+
readonly organizationType: {
|
|
1539
|
+
readonly type: "array";
|
|
1540
|
+
readonly description: "Legal or operational structures of the organization (e.g. 'nonprofit', 'ngo', 'government', 'social-enterprise', 'cooperative').";
|
|
1541
|
+
readonly items: {
|
|
1542
|
+
readonly type: "string";
|
|
1543
|
+
readonly maxLength: 128;
|
|
1544
|
+
readonly maxGraphemes: 100;
|
|
1545
|
+
};
|
|
1546
|
+
readonly maxLength: 10;
|
|
1547
|
+
};
|
|
1548
|
+
readonly urls: {
|
|
1549
|
+
readonly type: "array";
|
|
1550
|
+
readonly description: "Additional reference URLs (social media profiles, contact pages, donation links, etc.) with a display label for each URL.";
|
|
1551
|
+
readonly items: {
|
|
1552
|
+
readonly type: "ref";
|
|
1553
|
+
readonly ref: "lex:app.certified.actor.organization#urlItem";
|
|
1554
|
+
};
|
|
1555
|
+
};
|
|
1556
|
+
readonly location: {
|
|
1557
|
+
readonly type: "ref";
|
|
1558
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1559
|
+
readonly description: "A strong reference to the location where the organization is based. The record referenced must conform with the lexicon app.certified.location.";
|
|
1560
|
+
};
|
|
1561
|
+
readonly foundedDate: {
|
|
1562
|
+
readonly type: "string";
|
|
1563
|
+
readonly format: "datetime";
|
|
1564
|
+
readonly description: "When the organization was established. Stored as datetime per ATProto conventions (no date-only format exists). Clients should use midnight UTC (e.g., '2005-01-01T00:00:00.000Z'); consumers should treat only the date portion as canonical.";
|
|
1565
|
+
};
|
|
1566
|
+
readonly createdAt: {
|
|
1567
|
+
readonly type: "string";
|
|
1568
|
+
readonly format: "datetime";
|
|
1569
|
+
readonly description: "Client-declared timestamp when this record was originally created.";
|
|
1570
|
+
};
|
|
1571
|
+
};
|
|
1572
|
+
};
|
|
1573
|
+
};
|
|
1574
|
+
readonly urlItem: {
|
|
1575
|
+
readonly type: "object";
|
|
1576
|
+
readonly description: "A labeled URL reference.";
|
|
1577
|
+
readonly required: ["url"];
|
|
1578
|
+
readonly properties: {
|
|
1579
|
+
readonly url: {
|
|
1580
|
+
readonly type: "string";
|
|
1581
|
+
readonly format: "uri";
|
|
1582
|
+
readonly description: "The URL.";
|
|
1583
|
+
readonly maxLength: 10000;
|
|
1584
|
+
readonly maxGraphemes: 2048;
|
|
1585
|
+
};
|
|
1586
|
+
readonly label: {
|
|
1587
|
+
readonly type: "string";
|
|
1588
|
+
readonly description: "Optional human-readable label for this URL (e.g. 'Support page', 'Donation page').";
|
|
1589
|
+
readonly maxLength: 640;
|
|
1590
|
+
readonly maxGraphemes: 64;
|
|
1591
|
+
};
|
|
1592
|
+
};
|
|
1593
|
+
};
|
|
1594
|
+
};
|
|
1595
|
+
} | {
|
|
1119
1596
|
readonly lexicon: 1;
|
|
1120
1597
|
readonly id: "app.certified.actor.profile";
|
|
1121
1598
|
readonly defs: {
|
|
1122
1599
|
readonly main: {
|
|
1123
1600
|
readonly type: "record";
|
|
1124
|
-
readonly description: "A declaration of a
|
|
1601
|
+
readonly description: "A declaration of a Certified account profile.";
|
|
1125
1602
|
readonly key: "literal:self";
|
|
1126
1603
|
readonly record: {
|
|
1127
1604
|
readonly type: "object";
|
|
1605
|
+
readonly required: ["createdAt"];
|
|
1128
1606
|
readonly properties: {
|
|
1129
1607
|
readonly displayName: {
|
|
1130
1608
|
readonly type: "string";
|
|
1609
|
+
readonly description: "Display name for the account";
|
|
1131
1610
|
readonly maxGraphemes: 64;
|
|
1132
1611
|
readonly maxLength: 640;
|
|
1133
1612
|
};
|
|
@@ -1146,6 +1625,7 @@ export declare const schemas: ({
|
|
|
1146
1625
|
readonly website: {
|
|
1147
1626
|
readonly type: "string";
|
|
1148
1627
|
readonly format: "uri";
|
|
1628
|
+
readonly description: "Account website URL";
|
|
1149
1629
|
};
|
|
1150
1630
|
readonly avatar: {
|
|
1151
1631
|
readonly type: "union";
|
|
@@ -1160,6 +1640,7 @@ export declare const schemas: ({
|
|
|
1160
1640
|
readonly createdAt: {
|
|
1161
1641
|
readonly type: "string";
|
|
1162
1642
|
readonly format: "datetime";
|
|
1643
|
+
readonly description: "Client-declared timestamp when this record was originally created";
|
|
1163
1644
|
};
|
|
1164
1645
|
};
|
|
1165
1646
|
};
|
|
@@ -1190,6 +1671,13 @@ export declare const schemas: ({
|
|
|
1190
1671
|
readonly note: {
|
|
1191
1672
|
readonly type: "string";
|
|
1192
1673
|
readonly description: "Optional statement explaining the reason for this badge award.";
|
|
1674
|
+
readonly maxLength: 500;
|
|
1675
|
+
};
|
|
1676
|
+
readonly url: {
|
|
1677
|
+
readonly type: "string";
|
|
1678
|
+
readonly format: "uri";
|
|
1679
|
+
readonly description: "Optional URL the badge award links to.";
|
|
1680
|
+
readonly maxLength: 2048;
|
|
1193
1681
|
};
|
|
1194
1682
|
readonly createdAt: {
|
|
1195
1683
|
readonly type: "string";
|
|
@@ -1215,10 +1703,12 @@ export declare const schemas: ({
|
|
|
1215
1703
|
readonly badgeType: {
|
|
1216
1704
|
readonly type: "string";
|
|
1217
1705
|
readonly description: "Category of the badge (e.g. endorsement, participation, affiliation).";
|
|
1706
|
+
readonly maxLength: 100;
|
|
1218
1707
|
};
|
|
1219
1708
|
readonly title: {
|
|
1220
1709
|
readonly type: "string";
|
|
1221
1710
|
readonly description: "Human-readable title of the badge.";
|
|
1711
|
+
readonly maxLength: 256;
|
|
1222
1712
|
};
|
|
1223
1713
|
readonly icon: {
|
|
1224
1714
|
readonly type: "blob";
|
|
@@ -1229,10 +1719,13 @@ export declare const schemas: ({
|
|
|
1229
1719
|
readonly description: {
|
|
1230
1720
|
readonly type: "string";
|
|
1231
1721
|
readonly description: "Optional short statement describing what the badge represents.";
|
|
1722
|
+
readonly maxLength: 5000;
|
|
1723
|
+
readonly maxGraphemes: 500;
|
|
1232
1724
|
};
|
|
1233
1725
|
readonly allowedIssuers: {
|
|
1234
1726
|
readonly type: "array";
|
|
1235
1727
|
readonly description: "Optional allowlist of DIDs allowed to issue this badge. If omitted, anyone may issue it.";
|
|
1728
|
+
readonly maxLength: 100;
|
|
1236
1729
|
readonly items: {
|
|
1237
1730
|
readonly type: "ref";
|
|
1238
1731
|
readonly ref: "lex:app.certified.defs#did";
|
|
@@ -1266,12 +1759,13 @@ export declare const schemas: ({
|
|
|
1266
1759
|
};
|
|
1267
1760
|
readonly response: {
|
|
1268
1761
|
readonly type: "string";
|
|
1269
|
-
readonly
|
|
1762
|
+
readonly knownValues: ["accepted", "rejected"];
|
|
1270
1763
|
readonly description: "The recipient’s response for the badge (accepted or rejected).";
|
|
1271
1764
|
};
|
|
1272
1765
|
readonly weight: {
|
|
1273
1766
|
readonly type: "string";
|
|
1274
1767
|
readonly description: "Optional relative weight for accepted badges, assigned by the recipient.";
|
|
1768
|
+
readonly maxLength: 50;
|
|
1275
1769
|
};
|
|
1276
1770
|
readonly createdAt: {
|
|
1277
1771
|
readonly type: "string";
|
|
@@ -1326,8 +1820,8 @@ export declare const schemas: ({
|
|
|
1326
1820
|
};
|
|
1327
1821
|
readonly locationType: {
|
|
1328
1822
|
readonly type: "string";
|
|
1329
|
-
readonly description: "An identifier for the format of the location data (e.g., coordinate-decimal, geojson-point)";
|
|
1330
|
-
readonly knownValues: ["coordinate-decimal", "geojson-point"];
|
|
1823
|
+
readonly description: "An identifier for the format of the location data (e.g., coordinate-decimal, geojson-point). See the Location Protocol spec for the full registry: https://spec.decentralizedgeo.org/specification/location-types/#location-type-registry";
|
|
1824
|
+
readonly knownValues: ["coordinate-decimal", "geojson-point", "geojson", "h3", "geohash", "wkt", "address", "scaledCoordinates"];
|
|
1331
1825
|
readonly maxLength: 20;
|
|
1332
1826
|
};
|
|
1333
1827
|
readonly location: {
|
|
@@ -1337,13 +1831,13 @@ export declare const schemas: ({
|
|
|
1337
1831
|
};
|
|
1338
1832
|
readonly name: {
|
|
1339
1833
|
readonly type: "string";
|
|
1340
|
-
readonly description: "
|
|
1834
|
+
readonly description: "Human-readable name for this location (e.g. 'Golden Gate Park', 'San Francisco Bay Area')";
|
|
1341
1835
|
readonly maxLength: 1000;
|
|
1342
1836
|
readonly maxGraphemes: 100;
|
|
1343
1837
|
};
|
|
1344
1838
|
readonly description: {
|
|
1345
1839
|
readonly type: "string";
|
|
1346
|
-
readonly description: "
|
|
1840
|
+
readonly description: "Additional context about this location, such as its significance to the work or specific boundaries";
|
|
1347
1841
|
readonly maxLength: 2000;
|
|
1348
1842
|
readonly maxGraphemes: 500;
|
|
1349
1843
|
};
|
|
@@ -1389,6 +1883,208 @@ export declare const schemas: ({
|
|
|
1389
1883
|
};
|
|
1390
1884
|
};
|
|
1391
1885
|
};
|
|
1886
|
+
} | {
|
|
1887
|
+
readonly lexicon: 1;
|
|
1888
|
+
readonly id: "org.hyperboards.board";
|
|
1889
|
+
readonly defs: {
|
|
1890
|
+
readonly main: {
|
|
1891
|
+
readonly type: "record";
|
|
1892
|
+
readonly description: "Configuration record for a hyperboard, wrapping an underlying activity or collection with visual presentation settings. Stored in the creator's PDS.";
|
|
1893
|
+
readonly key: "tid";
|
|
1894
|
+
readonly record: {
|
|
1895
|
+
readonly type: "object";
|
|
1896
|
+
readonly required: ["subject", "createdAt"];
|
|
1897
|
+
readonly properties: {
|
|
1898
|
+
readonly subject: {
|
|
1899
|
+
readonly type: "ref";
|
|
1900
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1901
|
+
readonly description: "Reference to the org.hypercerts.claim.activity or org.hypercerts.claim.collection this board visualizes.";
|
|
1902
|
+
};
|
|
1903
|
+
readonly config: {
|
|
1904
|
+
readonly type: "ref";
|
|
1905
|
+
readonly ref: "lex:org.hyperboards.board#boardConfig";
|
|
1906
|
+
readonly description: "Board-level visual configuration (background, colors, aspect ratio).";
|
|
1907
|
+
};
|
|
1908
|
+
readonly contributorConfigs: {
|
|
1909
|
+
readonly type: "array";
|
|
1910
|
+
readonly description: "Per-contributor configuration entries for this board.";
|
|
1911
|
+
readonly maxLength: 1000;
|
|
1912
|
+
readonly items: {
|
|
1913
|
+
readonly type: "ref";
|
|
1914
|
+
readonly ref: "lex:org.hyperboards.board#contributorConfig";
|
|
1915
|
+
};
|
|
1916
|
+
};
|
|
1917
|
+
readonly createdAt: {
|
|
1918
|
+
readonly type: "string";
|
|
1919
|
+
readonly format: "datetime";
|
|
1920
|
+
readonly description: "Client-declared timestamp when this record was originally created.";
|
|
1921
|
+
};
|
|
1922
|
+
};
|
|
1923
|
+
};
|
|
1924
|
+
};
|
|
1925
|
+
readonly boardConfig: {
|
|
1926
|
+
readonly type: "object";
|
|
1927
|
+
readonly description: "Visual configuration for a hyperboard's background, colors, and layout.";
|
|
1928
|
+
readonly properties: {
|
|
1929
|
+
readonly backgroundType: {
|
|
1930
|
+
readonly type: "string";
|
|
1931
|
+
readonly description: "Type of background content.";
|
|
1932
|
+
readonly knownValues: ["image", "iframe"];
|
|
1933
|
+
readonly maxLength: 10;
|
|
1934
|
+
};
|
|
1935
|
+
readonly backgroundImage: {
|
|
1936
|
+
readonly type: "union";
|
|
1937
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
1938
|
+
readonly description: "Background image as a URI or image blob.";
|
|
1939
|
+
};
|
|
1940
|
+
readonly backgroundIframeUrl: {
|
|
1941
|
+
readonly type: "string";
|
|
1942
|
+
readonly format: "uri";
|
|
1943
|
+
readonly description: "URI of the background iframe.";
|
|
1944
|
+
readonly maxLength: 2048;
|
|
1945
|
+
};
|
|
1946
|
+
readonly backgroundGrayscale: {
|
|
1947
|
+
readonly type: "boolean";
|
|
1948
|
+
readonly description: "Whether the background is rendered in grayscale. Default: true.";
|
|
1949
|
+
};
|
|
1950
|
+
readonly backgroundOpacity: {
|
|
1951
|
+
readonly type: "integer";
|
|
1952
|
+
readonly description: "Background opacity as a percentage (0–100).";
|
|
1953
|
+
readonly minimum: 0;
|
|
1954
|
+
readonly maximum: 100;
|
|
1955
|
+
};
|
|
1956
|
+
readonly backgroundColor: {
|
|
1957
|
+
readonly type: "string";
|
|
1958
|
+
readonly description: "Background color as a hex string (e.g. '#ffffff').";
|
|
1959
|
+
readonly maxLength: 20;
|
|
1960
|
+
};
|
|
1961
|
+
readonly borderColor: {
|
|
1962
|
+
readonly type: "string";
|
|
1963
|
+
readonly description: "Border color as a hex string (e.g. '#000000').";
|
|
1964
|
+
readonly maxLength: 20;
|
|
1965
|
+
};
|
|
1966
|
+
readonly grayscaleImages: {
|
|
1967
|
+
readonly type: "boolean";
|
|
1968
|
+
readonly description: "Whether contributor images are rendered in grayscale. Default: false.";
|
|
1969
|
+
};
|
|
1970
|
+
readonly imageShape: {
|
|
1971
|
+
readonly type: "string";
|
|
1972
|
+
readonly description: "Shape used to crop contributor images on this board.";
|
|
1973
|
+
readonly knownValues: ["circular", "square"];
|
|
1974
|
+
readonly maxLength: 20;
|
|
1975
|
+
};
|
|
1976
|
+
readonly aspectRatio: {
|
|
1977
|
+
readonly type: "string";
|
|
1978
|
+
readonly description: "Display aspect ratio of the board.";
|
|
1979
|
+
readonly knownValues: ["16:9", "4:3", "1:1"];
|
|
1980
|
+
readonly maxLength: 10;
|
|
1981
|
+
};
|
|
1982
|
+
};
|
|
1983
|
+
};
|
|
1984
|
+
readonly contributorConfig: {
|
|
1985
|
+
readonly type: "object";
|
|
1986
|
+
readonly description: "Configuration for a specific contributor within a board. Values serve as fallbacks when the contributor has not defined them on their profile. It can also be used to override contributor settings on this board without changing their global profile.";
|
|
1987
|
+
readonly required: ["contributor"];
|
|
1988
|
+
readonly properties: {
|
|
1989
|
+
readonly contributor: {
|
|
1990
|
+
readonly type: "union";
|
|
1991
|
+
readonly refs: ["lex:com.atproto.repo.strongRef", "lex:org.hypercerts.claim.activity#contributorIdentity"];
|
|
1992
|
+
readonly description: "Identifies the contributor being styled. A strong reference to an org.hypercerts.claim.contributorInformation record, or a contributorIdentity (DID or identifier string) for contributors without a dedicated record.";
|
|
1993
|
+
};
|
|
1994
|
+
readonly override: {
|
|
1995
|
+
readonly type: "boolean";
|
|
1996
|
+
readonly description: "When true, these values take precedence over the contributor's own profile and display settings. When false or omitted, they are only used as fallbacks if the contributor has not set their own settings.";
|
|
1997
|
+
};
|
|
1998
|
+
readonly displayName: {
|
|
1999
|
+
readonly type: "string";
|
|
2000
|
+
readonly description: "Display name for this contributor on this board.";
|
|
2001
|
+
readonly maxLength: 640;
|
|
2002
|
+
readonly maxGraphemes: 64;
|
|
2003
|
+
};
|
|
2004
|
+
readonly image: {
|
|
2005
|
+
readonly type: "union";
|
|
2006
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
2007
|
+
readonly description: "Avatar or face image for this contributor on this board, as a URI or image blob.";
|
|
2008
|
+
};
|
|
2009
|
+
readonly video: {
|
|
2010
|
+
readonly type: "union";
|
|
2011
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallVideo"];
|
|
2012
|
+
readonly description: "Video for this contributor, as a URI (embed/direct link) or uploaded video blob.";
|
|
2013
|
+
};
|
|
2014
|
+
readonly hoverImage: {
|
|
2015
|
+
readonly type: "union";
|
|
2016
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
2017
|
+
readonly description: "Image overlay shown when hovering over this contributor, as a URI or image blob.";
|
|
2018
|
+
};
|
|
2019
|
+
readonly hoverIframeUrl: {
|
|
2020
|
+
readonly type: "string";
|
|
2021
|
+
readonly format: "uri";
|
|
2022
|
+
readonly description: "Iframe overlay shown when hovering over this contributor.";
|
|
2023
|
+
readonly maxLength: 2048;
|
|
2024
|
+
};
|
|
2025
|
+
readonly url: {
|
|
2026
|
+
readonly type: "string";
|
|
2027
|
+
readonly format: "uri";
|
|
2028
|
+
readonly description: "Click-through link URL for this contributor.";
|
|
2029
|
+
readonly maxLength: 2048;
|
|
2030
|
+
};
|
|
2031
|
+
};
|
|
2032
|
+
};
|
|
2033
|
+
};
|
|
2034
|
+
} | {
|
|
2035
|
+
readonly lexicon: 1;
|
|
2036
|
+
readonly id: "org.hyperboards.displayProfile";
|
|
2037
|
+
readonly defs: {
|
|
2038
|
+
readonly main: {
|
|
2039
|
+
readonly type: "record";
|
|
2040
|
+
readonly description: "User-declared visual presentation defaults for how a contributor appears on hyperboards. Stored in the contributor's own PDS and reusable across multiple boards.";
|
|
2041
|
+
readonly key: "literal:self";
|
|
2042
|
+
readonly record: {
|
|
2043
|
+
readonly type: "object";
|
|
2044
|
+
readonly required: ["createdAt"];
|
|
2045
|
+
readonly properties: {
|
|
2046
|
+
readonly displayName: {
|
|
2047
|
+
readonly type: "string";
|
|
2048
|
+
readonly description: "Display name override for this user on hyperboards.";
|
|
2049
|
+
readonly maxLength: 640;
|
|
2050
|
+
readonly maxGraphemes: 64;
|
|
2051
|
+
};
|
|
2052
|
+
readonly image: {
|
|
2053
|
+
readonly type: "union";
|
|
2054
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
2055
|
+
readonly description: "Avatar or face image override for this user on hyperboards, as a URI or image blob.";
|
|
2056
|
+
};
|
|
2057
|
+
readonly video: {
|
|
2058
|
+
readonly type: "union";
|
|
2059
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallVideo"];
|
|
2060
|
+
readonly description: "Default video for this user across boards, as a URI (embed/direct link) or uploaded video blob.";
|
|
2061
|
+
};
|
|
2062
|
+
readonly hoverImage: {
|
|
2063
|
+
readonly type: "union";
|
|
2064
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
2065
|
+
readonly description: "Default hover image for this user across boards, as a URI or image blob.";
|
|
2066
|
+
};
|
|
2067
|
+
readonly hoverIframeUrl: {
|
|
2068
|
+
readonly type: "string";
|
|
2069
|
+
readonly format: "uri";
|
|
2070
|
+
readonly description: "Default hover iframe URL for this user across boards.";
|
|
2071
|
+
readonly maxLength: 2048;
|
|
2072
|
+
};
|
|
2073
|
+
readonly url: {
|
|
2074
|
+
readonly type: "string";
|
|
2075
|
+
readonly format: "uri";
|
|
2076
|
+
readonly description: "Default click-through link URL for this user across boards.";
|
|
2077
|
+
readonly maxLength: 2048;
|
|
2078
|
+
};
|
|
2079
|
+
readonly createdAt: {
|
|
2080
|
+
readonly type: "string";
|
|
2081
|
+
readonly format: "datetime";
|
|
2082
|
+
readonly description: "Client-declared timestamp when this record was originally created.";
|
|
2083
|
+
};
|
|
2084
|
+
};
|
|
2085
|
+
};
|
|
2086
|
+
};
|
|
2087
|
+
};
|
|
1392
2088
|
} | {
|
|
1393
2089
|
readonly lexicon: 1;
|
|
1394
2090
|
readonly id: "org.hypercerts.claim.activity";
|
|
@@ -1403,7 +2099,7 @@ export declare const schemas: ({
|
|
|
1403
2099
|
readonly properties: {
|
|
1404
2100
|
readonly title: {
|
|
1405
2101
|
readonly type: "string";
|
|
1406
|
-
readonly description: "
|
|
2102
|
+
readonly description: "Display title summarizing the impact work (e.g. 'Reforestation in Amazon Basin 2024')";
|
|
1407
2103
|
readonly maxLength: 256;
|
|
1408
2104
|
};
|
|
1409
2105
|
readonly shortDescription: {
|
|
@@ -1421,28 +2117,28 @@ export declare const schemas: ({
|
|
|
1421
2117
|
};
|
|
1422
2118
|
};
|
|
1423
2119
|
readonly description: {
|
|
1424
|
-
readonly type: "
|
|
1425
|
-
readonly
|
|
1426
|
-
readonly
|
|
1427
|
-
readonly maxGraphemes: 3000;
|
|
1428
|
-
};
|
|
1429
|
-
readonly descriptionFacets: {
|
|
1430
|
-
readonly type: "array";
|
|
1431
|
-
readonly description: "Rich text annotations for `description` (mentions, URLs, hashtags, etc).";
|
|
1432
|
-
readonly items: {
|
|
1433
|
-
readonly type: "ref";
|
|
1434
|
-
readonly ref: "lex:app.bsky.richtext.facet";
|
|
1435
|
-
};
|
|
2120
|
+
readonly type: "ref";
|
|
2121
|
+
readonly ref: "lex:pub.leaflet.pages.linearDocument#main";
|
|
2122
|
+
readonly description: "Rich-text description, represented as a Leaflet linear document.";
|
|
1436
2123
|
};
|
|
1437
2124
|
readonly image: {
|
|
1438
2125
|
readonly type: "union";
|
|
1439
2126
|
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
1440
2127
|
readonly description: "The hypercert visual representation as a URI or image blob.";
|
|
1441
2128
|
};
|
|
2129
|
+
readonly contributors: {
|
|
2130
|
+
readonly type: "array";
|
|
2131
|
+
readonly description: "An array of contributor objects, each containing contributor information, weight, and contribution details.";
|
|
2132
|
+
readonly maxLength: 1000;
|
|
2133
|
+
readonly items: {
|
|
2134
|
+
readonly type: "ref";
|
|
2135
|
+
readonly ref: "lex:org.hypercerts.claim.activity#contributor";
|
|
2136
|
+
};
|
|
2137
|
+
};
|
|
1442
2138
|
readonly workScope: {
|
|
1443
2139
|
readonly type: "union";
|
|
1444
|
-
readonly refs: ["lex:
|
|
1445
|
-
readonly description: "Work scope definition.
|
|
2140
|
+
readonly refs: ["lex:org.hypercerts.workscope.cel", "lex:org.hypercerts.claim.activity#workScopeString"];
|
|
2141
|
+
readonly description: "Work scope definition. A CEL expression for structured, machine-evaluable scopes or a free-form string for simple and legacy scopes.";
|
|
1446
2142
|
};
|
|
1447
2143
|
readonly startDate: {
|
|
1448
2144
|
readonly type: "string";
|
|
@@ -1454,12 +2150,13 @@ export declare const schemas: ({
|
|
|
1454
2150
|
readonly format: "datetime";
|
|
1455
2151
|
readonly description: "When the work ended";
|
|
1456
2152
|
};
|
|
1457
|
-
readonly
|
|
2153
|
+
readonly locations: {
|
|
1458
2154
|
readonly type: "array";
|
|
1459
|
-
readonly description: "An array of
|
|
2155
|
+
readonly description: "An array of strong references to the location where activity was performed. The record referenced must conform with the lexicon app.certified.location.";
|
|
2156
|
+
readonly maxLength: 1000;
|
|
1460
2157
|
readonly items: {
|
|
1461
2158
|
readonly type: "ref";
|
|
1462
|
-
readonly ref: "lex:
|
|
2159
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1463
2160
|
};
|
|
1464
2161
|
};
|
|
1465
2162
|
readonly rights: {
|
|
@@ -1467,14 +2164,6 @@ export declare const schemas: ({
|
|
|
1467
2164
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1468
2165
|
readonly description: "A strong reference to the rights that this hypercert has. The record referenced must conform with the lexicon org.hypercerts.claim.rights.";
|
|
1469
2166
|
};
|
|
1470
|
-
readonly locations: {
|
|
1471
|
-
readonly type: "array";
|
|
1472
|
-
readonly description: "An array of strong references to the location where activity was performed. The record referenced must conform with the lexicon app.certified.location.";
|
|
1473
|
-
readonly items: {
|
|
1474
|
-
readonly type: "ref";
|
|
1475
|
-
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1476
|
-
};
|
|
1477
|
-
};
|
|
1478
2167
|
readonly createdAt: {
|
|
1479
2168
|
readonly type: "string";
|
|
1480
2169
|
readonly format: "datetime";
|
|
@@ -1490,16 +2179,17 @@ export declare const schemas: ({
|
|
|
1490
2179
|
readonly contributorIdentity: {
|
|
1491
2180
|
readonly type: "union";
|
|
1492
2181
|
readonly refs: ["lex:org.hypercerts.claim.activity#contributorIdentity", "lex:com.atproto.repo.strongRef"];
|
|
1493
|
-
readonly description: "
|
|
2182
|
+
readonly description: "Inline contributor identity object with an identity string (DID or identifier) via org.hypercerts.claim.activity#contributorIdentity, or a strong reference to a contributor information record. The record referenced must conform with the lexicon org.hypercerts.claim.contributorInformation.";
|
|
1494
2183
|
};
|
|
1495
2184
|
readonly contributionWeight: {
|
|
1496
2185
|
readonly type: "string";
|
|
1497
2186
|
readonly 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.";
|
|
2187
|
+
readonly maxLength: 100;
|
|
1498
2188
|
};
|
|
1499
2189
|
readonly contributionDetails: {
|
|
1500
2190
|
readonly type: "union";
|
|
1501
2191
|
readonly refs: ["lex:org.hypercerts.claim.activity#contributorRole", "lex:com.atproto.repo.strongRef"];
|
|
1502
|
-
readonly description: "
|
|
2192
|
+
readonly description: "Inline contribution role object with a role string via org.hypercerts.claim.activity#contributorRole, or a strong reference to a contribution details record. The record referenced must conform with the lexicon org.hypercerts.claim.contribution.";
|
|
1503
2193
|
};
|
|
1504
2194
|
};
|
|
1505
2195
|
};
|
|
@@ -1545,81 +2235,119 @@ export declare const schemas: ({
|
|
|
1545
2235
|
};
|
|
1546
2236
|
} | {
|
|
1547
2237
|
readonly lexicon: 1;
|
|
1548
|
-
readonly id: "org.hypercerts.claim.
|
|
2238
|
+
readonly id: "org.hypercerts.claim.contribution";
|
|
1549
2239
|
readonly defs: {
|
|
1550
2240
|
readonly main: {
|
|
1551
2241
|
readonly type: "record";
|
|
1552
|
-
readonly description: "
|
|
2242
|
+
readonly description: "Details about a specific contribution including role, description, and timeframe.";
|
|
1553
2243
|
readonly key: "tid";
|
|
1554
2244
|
readonly record: {
|
|
1555
2245
|
readonly type: "object";
|
|
1556
|
-
readonly required: ["
|
|
2246
|
+
readonly required: ["createdAt"];
|
|
1557
2247
|
readonly properties: {
|
|
1558
|
-
readonly
|
|
1559
|
-
readonly type: "
|
|
1560
|
-
readonly description: "
|
|
1561
|
-
readonly items: {
|
|
1562
|
-
readonly type: "ref";
|
|
1563
|
-
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1564
|
-
};
|
|
2248
|
+
readonly role: {
|
|
2249
|
+
readonly type: "string";
|
|
2250
|
+
readonly description: "Role or title of the contributor.";
|
|
1565
2251
|
readonly maxLength: 100;
|
|
1566
2252
|
};
|
|
1567
|
-
readonly
|
|
2253
|
+
readonly contributionDescription: {
|
|
1568
2254
|
readonly type: "string";
|
|
1569
|
-
readonly
|
|
1570
|
-
readonly
|
|
2255
|
+
readonly description: "Description of what the contribution concretely involved.";
|
|
2256
|
+
readonly maxLength: 10000;
|
|
2257
|
+
readonly maxGraphemes: 1000;
|
|
1571
2258
|
};
|
|
1572
|
-
readonly
|
|
1573
|
-
readonly type: "
|
|
1574
|
-
readonly
|
|
1575
|
-
readonly
|
|
1576
|
-
readonly type: "union";
|
|
1577
|
-
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
1578
|
-
};
|
|
1579
|
-
readonly maxLength: 100;
|
|
2259
|
+
readonly startDate: {
|
|
2260
|
+
readonly type: "string";
|
|
2261
|
+
readonly format: "datetime";
|
|
2262
|
+
readonly description: "When this contribution started. Should fall within the parent hypercert's timeframe.";
|
|
1580
2263
|
};
|
|
1581
|
-
readonly
|
|
2264
|
+
readonly endDate: {
|
|
1582
2265
|
readonly type: "string";
|
|
1583
|
-
readonly
|
|
1584
|
-
readonly description: "
|
|
2266
|
+
readonly format: "datetime";
|
|
2267
|
+
readonly description: "When this contribution finished. Should fall within the parent hypercert's timeframe.";
|
|
1585
2268
|
};
|
|
1586
|
-
readonly
|
|
2269
|
+
readonly createdAt: {
|
|
1587
2270
|
readonly type: "string";
|
|
1588
|
-
readonly
|
|
1589
|
-
readonly
|
|
1590
|
-
readonly maxGraphemes: 300;
|
|
2271
|
+
readonly format: "datetime";
|
|
2272
|
+
readonly description: "Client-declared timestamp when this record was originally created.";
|
|
1591
2273
|
};
|
|
1592
|
-
|
|
1593
|
-
|
|
1594
|
-
|
|
1595
|
-
|
|
1596
|
-
|
|
1597
|
-
|
|
1598
|
-
|
|
2274
|
+
};
|
|
2275
|
+
};
|
|
2276
|
+
};
|
|
2277
|
+
};
|
|
2278
|
+
} | {
|
|
2279
|
+
readonly lexicon: 1;
|
|
2280
|
+
readonly id: "org.hypercerts.claim.contributorInformation";
|
|
2281
|
+
readonly defs: {
|
|
2282
|
+
readonly main: {
|
|
2283
|
+
readonly type: "record";
|
|
2284
|
+
readonly description: "Contributor information including identifier, display name, and image.";
|
|
2285
|
+
readonly key: "tid";
|
|
2286
|
+
readonly record: {
|
|
2287
|
+
readonly type: "object";
|
|
2288
|
+
readonly required: ["createdAt"];
|
|
2289
|
+
readonly properties: {
|
|
2290
|
+
readonly identifier: {
|
|
2291
|
+
readonly type: "string";
|
|
2292
|
+
readonly description: "DID (did:plc:...) or URI to a social profile of the contributor.";
|
|
2293
|
+
readonly maxLength: 2048;
|
|
2294
|
+
};
|
|
2295
|
+
readonly displayName: {
|
|
2296
|
+
readonly type: "string";
|
|
2297
|
+
readonly description: "Human-readable name for the contributor as it should appear in UI.";
|
|
2298
|
+
readonly maxLength: 100;
|
|
2299
|
+
};
|
|
2300
|
+
readonly image: {
|
|
2301
|
+
readonly type: "union";
|
|
2302
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
2303
|
+
readonly description: "The contributor visual representation as a URI or image blob.";
|
|
2304
|
+
};
|
|
2305
|
+
readonly createdAt: {
|
|
2306
|
+
readonly type: "string";
|
|
2307
|
+
readonly format: "datetime";
|
|
2308
|
+
readonly description: "Client-declared timestamp when this record was originally created.";
|
|
2309
|
+
};
|
|
2310
|
+
};
|
|
2311
|
+
};
|
|
2312
|
+
};
|
|
2313
|
+
};
|
|
2314
|
+
} | {
|
|
2315
|
+
readonly lexicon: 1;
|
|
2316
|
+
readonly id: "org.hypercerts.claim.rights";
|
|
2317
|
+
readonly defs: {
|
|
2318
|
+
readonly main: {
|
|
2319
|
+
readonly type: "record";
|
|
2320
|
+
readonly 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.";
|
|
2321
|
+
readonly key: "tid";
|
|
2322
|
+
readonly record: {
|
|
2323
|
+
readonly type: "object";
|
|
2324
|
+
readonly required: ["rightsName", "rightsType", "rightsDescription", "createdAt"];
|
|
2325
|
+
readonly properties: {
|
|
2326
|
+
readonly rightsName: {
|
|
2327
|
+
readonly type: "string";
|
|
2328
|
+
readonly description: "Human-readable name for these rights (e.g. 'All Rights Reserved', 'CC BY-SA 4.0')";
|
|
2329
|
+
readonly maxLength: 100;
|
|
1599
2330
|
};
|
|
1600
|
-
readonly
|
|
2331
|
+
readonly rightsType: {
|
|
1601
2332
|
readonly type: "string";
|
|
1602
|
-
readonly description: "
|
|
1603
|
-
readonly maxLength:
|
|
1604
|
-
readonly maxGraphemes: 3000;
|
|
2333
|
+
readonly description: "Short identifier code for this rights type (e.g. 'ARR', 'CC-BY-SA') to facilitate filtering and search";
|
|
2334
|
+
readonly maxLength: 10;
|
|
1605
2335
|
};
|
|
1606
|
-
readonly
|
|
1607
|
-
readonly type: "
|
|
1608
|
-
readonly description: "
|
|
1609
|
-
readonly
|
|
1610
|
-
|
|
1611
|
-
readonly ref: "lex:app.bsky.richtext.facet";
|
|
1612
|
-
};
|
|
2336
|
+
readonly rightsDescription: {
|
|
2337
|
+
readonly type: "string";
|
|
2338
|
+
readonly description: "Detailed explanation of the rights holders' permissions, restrictions, and conditions";
|
|
2339
|
+
readonly maxLength: 10000;
|
|
2340
|
+
readonly maxGraphemes: 1000;
|
|
1613
2341
|
};
|
|
1614
|
-
readonly
|
|
1615
|
-
readonly type: "
|
|
1616
|
-
readonly
|
|
1617
|
-
readonly description: "
|
|
2342
|
+
readonly attachment: {
|
|
2343
|
+
readonly type: "union";
|
|
2344
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
2345
|
+
readonly description: "An attachment to define the rights further, e.g. a legal document.";
|
|
1618
2346
|
};
|
|
1619
2347
|
readonly createdAt: {
|
|
1620
2348
|
readonly type: "string";
|
|
1621
2349
|
readonly format: "datetime";
|
|
1622
|
-
readonly description: "Client-declared timestamp when this record was originally created
|
|
2350
|
+
readonly description: "Client-declared timestamp when this record was originally created";
|
|
1623
2351
|
};
|
|
1624
2352
|
};
|
|
1625
2353
|
};
|
|
@@ -1627,7 +2355,7 @@ export declare const schemas: ({
|
|
|
1627
2355
|
};
|
|
1628
2356
|
} | {
|
|
1629
2357
|
readonly lexicon: 1;
|
|
1630
|
-
readonly id: "org.hypercerts.
|
|
2358
|
+
readonly id: "org.hypercerts.collection";
|
|
1631
2359
|
readonly defs: {
|
|
1632
2360
|
readonly main: {
|
|
1633
2361
|
readonly type: "record";
|
|
@@ -1635,15 +2363,16 @@ export declare const schemas: ({
|
|
|
1635
2363
|
readonly key: "tid";
|
|
1636
2364
|
readonly record: {
|
|
1637
2365
|
readonly type: "object";
|
|
1638
|
-
readonly required: ["title", "
|
|
2366
|
+
readonly required: ["title", "createdAt"];
|
|
1639
2367
|
readonly properties: {
|
|
1640
2368
|
readonly type: {
|
|
1641
2369
|
readonly type: "string";
|
|
1642
2370
|
readonly description: "The type of this collection. Possible fields can be 'favorites', 'project', or any other type of collection.";
|
|
2371
|
+
readonly maxLength: 64;
|
|
1643
2372
|
};
|
|
1644
2373
|
readonly title: {
|
|
1645
2374
|
readonly type: "string";
|
|
1646
|
-
readonly description: "
|
|
2375
|
+
readonly description: "Display name for this collection (e.g. 'Q1 2025 Impact Projects')";
|
|
1647
2376
|
readonly maxLength: 800;
|
|
1648
2377
|
readonly maxGraphemes: 80;
|
|
1649
2378
|
};
|
|
@@ -1671,9 +2400,10 @@ export declare const schemas: ({
|
|
|
1671
2400
|
readonly items: {
|
|
1672
2401
|
readonly type: "array";
|
|
1673
2402
|
readonly description: "Array of items in this collection with optional weights.";
|
|
2403
|
+
readonly maxLength: 1000;
|
|
1674
2404
|
readonly items: {
|
|
1675
2405
|
readonly type: "ref";
|
|
1676
|
-
readonly ref: "lex:org.hypercerts.
|
|
2406
|
+
readonly ref: "lex:org.hypercerts.collection#item";
|
|
1677
2407
|
};
|
|
1678
2408
|
};
|
|
1679
2409
|
readonly location: {
|
|
@@ -1696,47 +2426,47 @@ export declare const schemas: ({
|
|
|
1696
2426
|
readonly itemIdentifier: {
|
|
1697
2427
|
readonly type: "ref";
|
|
1698
2428
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1699
|
-
readonly description: "Strong reference to an item in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.
|
|
2429
|
+
readonly description: "Strong reference to an item in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.collection).";
|
|
1700
2430
|
};
|
|
1701
2431
|
readonly itemWeight: {
|
|
1702
2432
|
readonly type: "string";
|
|
1703
2433
|
readonly 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.";
|
|
2434
|
+
readonly maxLength: 100;
|
|
1704
2435
|
};
|
|
1705
2436
|
};
|
|
1706
2437
|
};
|
|
1707
2438
|
};
|
|
1708
2439
|
} | {
|
|
1709
2440
|
readonly lexicon: 1;
|
|
1710
|
-
readonly id: "org.hypercerts.
|
|
2441
|
+
readonly id: "org.hypercerts.context.acknowledgement";
|
|
1711
2442
|
readonly defs: {
|
|
1712
2443
|
readonly main: {
|
|
1713
2444
|
readonly type: "record";
|
|
1714
|
-
readonly description: "
|
|
2445
|
+
readonly description: "Acknowledges a record (subject) or its relationship in a context. Created in the acknowledging actor's repo to form a bidirectional link. Examples: a contributor acknowledging inclusion in an activity, an activity owner acknowledging inclusion in a collection, or a record owner acknowledging an evaluation.";
|
|
1715
2446
|
readonly key: "tid";
|
|
1716
2447
|
readonly record: {
|
|
1717
2448
|
readonly type: "object";
|
|
1718
|
-
readonly required: ["createdAt"];
|
|
2449
|
+
readonly required: ["subject", "acknowledged", "createdAt"];
|
|
1719
2450
|
readonly properties: {
|
|
1720
|
-
readonly
|
|
1721
|
-
readonly type: "
|
|
1722
|
-
readonly
|
|
1723
|
-
readonly
|
|
2451
|
+
readonly subject: {
|
|
2452
|
+
readonly type: "ref";
|
|
2453
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
2454
|
+
readonly description: "The record being acknowledged (e.g. an activity, a contributor information record, an evaluation).";
|
|
1724
2455
|
};
|
|
1725
|
-
readonly
|
|
1726
|
-
readonly type: "
|
|
1727
|
-
readonly
|
|
1728
|
-
readonly
|
|
1729
|
-
readonly maxGraphemes: 1000;
|
|
2456
|
+
readonly context: {
|
|
2457
|
+
readonly type: "union";
|
|
2458
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:com.atproto.repo.strongRef"];
|
|
2459
|
+
readonly description: "Context for the acknowledgement (e.g. the collection that includes an activity, or the activity that includes a contributor). A URI for a lightweight reference or a strong reference for content-hash verification.";
|
|
1730
2460
|
};
|
|
1731
|
-
readonly
|
|
1732
|
-
readonly type: "
|
|
1733
|
-
readonly
|
|
1734
|
-
readonly description: "When this contribution started. This should be a subset of the hypercert timeframe.";
|
|
2461
|
+
readonly acknowledged: {
|
|
2462
|
+
readonly type: "boolean";
|
|
2463
|
+
readonly description: "Whether the relationship is acknowledged (true) or rejected (false).";
|
|
1735
2464
|
};
|
|
1736
|
-
readonly
|
|
2465
|
+
readonly comment: {
|
|
1737
2466
|
readonly type: "string";
|
|
1738
|
-
readonly
|
|
1739
|
-
readonly
|
|
2467
|
+
readonly description: "Optional plain-text comment providing additional context or reasoning.";
|
|
2468
|
+
readonly maxLength: 10000;
|
|
2469
|
+
readonly maxGraphemes: 1000;
|
|
1740
2470
|
};
|
|
1741
2471
|
readonly createdAt: {
|
|
1742
2472
|
readonly type: "string";
|
|
@@ -1749,29 +2479,67 @@ export declare const schemas: ({
|
|
|
1749
2479
|
};
|
|
1750
2480
|
} | {
|
|
1751
2481
|
readonly lexicon: 1;
|
|
1752
|
-
readonly id: "org.hypercerts.
|
|
2482
|
+
readonly id: "org.hypercerts.context.attachment";
|
|
1753
2483
|
readonly defs: {
|
|
1754
2484
|
readonly main: {
|
|
1755
2485
|
readonly type: "record";
|
|
1756
|
-
readonly description: "
|
|
2486
|
+
readonly description: "An attachment providing commentary, context, evidence, or documentary material related to a hypercert record (e.g. an activity, project, claim, or evaluation).";
|
|
1757
2487
|
readonly key: "tid";
|
|
1758
2488
|
readonly record: {
|
|
1759
2489
|
readonly type: "object";
|
|
1760
|
-
readonly required: ["createdAt"];
|
|
2490
|
+
readonly required: ["title", "createdAt"];
|
|
1761
2491
|
readonly properties: {
|
|
1762
|
-
readonly
|
|
1763
|
-
readonly type: "
|
|
1764
|
-
readonly description: "
|
|
2492
|
+
readonly subjects: {
|
|
2493
|
+
readonly type: "array";
|
|
2494
|
+
readonly description: "References to the subject(s) the attachment is connected to—this may be an activity claim, outcome claim, measurement, evaluation, or even another attachment. This is optional as the attachment can exist before the claim is recorded.";
|
|
2495
|
+
readonly items: {
|
|
2496
|
+
readonly type: "ref";
|
|
2497
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
2498
|
+
};
|
|
2499
|
+
readonly maxLength: 100;
|
|
1765
2500
|
};
|
|
1766
|
-
readonly
|
|
2501
|
+
readonly contentType: {
|
|
1767
2502
|
readonly type: "string";
|
|
1768
|
-
readonly
|
|
2503
|
+
readonly maxLength: 64;
|
|
2504
|
+
readonly description: "The type of attachment, e.g. report, audit, evidence, testimonial, methodology, etc.";
|
|
2505
|
+
};
|
|
2506
|
+
readonly content: {
|
|
2507
|
+
readonly type: "array";
|
|
2508
|
+
readonly description: "The files, documents, or external references included in this attachment record.";
|
|
2509
|
+
readonly items: {
|
|
2510
|
+
readonly type: "union";
|
|
2511
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
2512
|
+
};
|
|
1769
2513
|
readonly maxLength: 100;
|
|
1770
2514
|
};
|
|
1771
|
-
readonly
|
|
1772
|
-
readonly type: "
|
|
1773
|
-
readonly
|
|
1774
|
-
readonly description: "
|
|
2515
|
+
readonly title: {
|
|
2516
|
+
readonly type: "string";
|
|
2517
|
+
readonly maxLength: 256;
|
|
2518
|
+
readonly description: "Display title for this attachment (e.g. 'Impact Assessment Report', 'Audit Findings')";
|
|
2519
|
+
};
|
|
2520
|
+
readonly shortDescription: {
|
|
2521
|
+
readonly type: "string";
|
|
2522
|
+
readonly description: "Short summary of this attachment, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.";
|
|
2523
|
+
readonly maxLength: 3000;
|
|
2524
|
+
readonly maxGraphemes: 300;
|
|
2525
|
+
};
|
|
2526
|
+
readonly shortDescriptionFacets: {
|
|
2527
|
+
readonly type: "array";
|
|
2528
|
+
readonly description: "Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc).";
|
|
2529
|
+
readonly items: {
|
|
2530
|
+
readonly type: "ref";
|
|
2531
|
+
readonly ref: "lex:app.bsky.richtext.facet";
|
|
2532
|
+
};
|
|
2533
|
+
};
|
|
2534
|
+
readonly description: {
|
|
2535
|
+
readonly type: "ref";
|
|
2536
|
+
readonly ref: "lex:pub.leaflet.pages.linearDocument#main";
|
|
2537
|
+
readonly description: "Rich-text description, represented as a Leaflet linear document.";
|
|
2538
|
+
};
|
|
2539
|
+
readonly location: {
|
|
2540
|
+
readonly type: "ref";
|
|
2541
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
2542
|
+
readonly description: "A strong reference to the location where this attachment's subject matter occurred. The record referenced must conform with the lexicon app.certified.location.";
|
|
1775
2543
|
};
|
|
1776
2544
|
readonly createdAt: {
|
|
1777
2545
|
readonly type: "string";
|
|
@@ -1784,27 +2552,8 @@ export declare const schemas: ({
|
|
|
1784
2552
|
};
|
|
1785
2553
|
} | {
|
|
1786
2554
|
readonly lexicon: 1;
|
|
1787
|
-
readonly id: "org.hypercerts.
|
|
2555
|
+
readonly id: "org.hypercerts.context.evaluation";
|
|
1788
2556
|
readonly defs: {
|
|
1789
|
-
readonly score: {
|
|
1790
|
-
readonly type: "object";
|
|
1791
|
-
readonly description: "Overall score for an evaluation on a numeric scale.";
|
|
1792
|
-
readonly required: ["min", "max", "value"];
|
|
1793
|
-
readonly properties: {
|
|
1794
|
-
readonly min: {
|
|
1795
|
-
readonly type: "integer";
|
|
1796
|
-
readonly description: "Minimum value of the scale, e.g. 0 or 1.";
|
|
1797
|
-
};
|
|
1798
|
-
readonly max: {
|
|
1799
|
-
readonly type: "integer";
|
|
1800
|
-
readonly description: "Maximum value of the scale, e.g. 5 or 10.";
|
|
1801
|
-
};
|
|
1802
|
-
readonly value: {
|
|
1803
|
-
readonly type: "integer";
|
|
1804
|
-
readonly description: "Score within the inclusive range [min, max].";
|
|
1805
|
-
};
|
|
1806
|
-
};
|
|
1807
|
-
};
|
|
1808
2557
|
readonly main: {
|
|
1809
2558
|
readonly type: "record";
|
|
1810
2559
|
readonly description: "An evaluation of a hypercert record (e.g. an activity and its impact).";
|
|
@@ -1816,7 +2565,7 @@ export declare const schemas: ({
|
|
|
1816
2565
|
readonly subject: {
|
|
1817
2566
|
readonly type: "ref";
|
|
1818
2567
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1819
|
-
readonly description: "A strong reference to what is being evaluated
|
|
2568
|
+
readonly description: "A strong reference to what is being evaluated (e.g. activity, measurement, contribution, etc.)";
|
|
1820
2569
|
};
|
|
1821
2570
|
readonly evaluators: {
|
|
1822
2571
|
readonly type: "array";
|
|
@@ -1838,7 +2587,7 @@ export declare const schemas: ({
|
|
|
1838
2587
|
};
|
|
1839
2588
|
readonly measurements: {
|
|
1840
2589
|
readonly type: "array";
|
|
1841
|
-
readonly description: "Optional references to the measurements that contributed to this evaluation. The record(s) referenced must conform with the lexicon org.hypercerts.
|
|
2590
|
+
readonly description: "Optional references to the measurements that contributed to this evaluation. The record(s) referenced must conform with the lexicon org.hypercerts.context.measurement";
|
|
1842
2591
|
readonly items: {
|
|
1843
2592
|
readonly type: "ref";
|
|
1844
2593
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
@@ -1853,7 +2602,7 @@ export declare const schemas: ({
|
|
|
1853
2602
|
};
|
|
1854
2603
|
readonly score: {
|
|
1855
2604
|
readonly type: "ref";
|
|
1856
|
-
readonly ref: "lex:org.hypercerts.
|
|
2605
|
+
readonly ref: "lex:org.hypercerts.context.evaluation#score";
|
|
1857
2606
|
readonly description: "Optional overall score for this evaluation on a numeric scale.";
|
|
1858
2607
|
};
|
|
1859
2608
|
readonly location: {
|
|
@@ -1869,23 +2618,46 @@ export declare const schemas: ({
|
|
|
1869
2618
|
};
|
|
1870
2619
|
};
|
|
1871
2620
|
};
|
|
2621
|
+
readonly score: {
|
|
2622
|
+
readonly type: "object";
|
|
2623
|
+
readonly description: "Overall score for an evaluation on a numeric scale.";
|
|
2624
|
+
readonly required: ["min", "max", "value"];
|
|
2625
|
+
readonly properties: {
|
|
2626
|
+
readonly min: {
|
|
2627
|
+
readonly type: "integer";
|
|
2628
|
+
readonly description: "Minimum value of the scale, e.g. 0 or 1.";
|
|
2629
|
+
};
|
|
2630
|
+
readonly max: {
|
|
2631
|
+
readonly type: "integer";
|
|
2632
|
+
readonly description: "Maximum value of the scale, e.g. 5 or 10.";
|
|
2633
|
+
};
|
|
2634
|
+
readonly value: {
|
|
2635
|
+
readonly type: "integer";
|
|
2636
|
+
readonly description: "Score within the inclusive range [min, max].";
|
|
2637
|
+
};
|
|
2638
|
+
};
|
|
2639
|
+
};
|
|
1872
2640
|
};
|
|
1873
2641
|
} | {
|
|
1874
2642
|
readonly lexicon: 1;
|
|
1875
|
-
readonly id: "org.hypercerts.
|
|
2643
|
+
readonly id: "org.hypercerts.context.measurement";
|
|
1876
2644
|
readonly defs: {
|
|
1877
2645
|
readonly main: {
|
|
1878
2646
|
readonly type: "record";
|
|
1879
|
-
readonly description: "Measurement data related to
|
|
2647
|
+
readonly description: "Measurement data related to one or more records (e.g. activities, projects, etc.).";
|
|
1880
2648
|
readonly key: "tid";
|
|
1881
2649
|
readonly record: {
|
|
1882
2650
|
readonly type: "object";
|
|
1883
2651
|
readonly required: ["metric", "unit", "value", "createdAt"];
|
|
1884
2652
|
readonly properties: {
|
|
1885
|
-
readonly
|
|
1886
|
-
readonly type: "
|
|
1887
|
-
readonly
|
|
1888
|
-
readonly
|
|
2653
|
+
readonly subjects: {
|
|
2654
|
+
readonly type: "array";
|
|
2655
|
+
readonly description: "Strong references to the records this measurement refers to (e.g. activities, projects, or claims).";
|
|
2656
|
+
readonly items: {
|
|
2657
|
+
readonly type: "ref";
|
|
2658
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
2659
|
+
};
|
|
2660
|
+
readonly maxLength: 100;
|
|
1889
2661
|
};
|
|
1890
2662
|
readonly metric: {
|
|
1891
2663
|
readonly type: "string";
|
|
@@ -1899,7 +2671,7 @@ export declare const schemas: ({
|
|
|
1899
2671
|
};
|
|
1900
2672
|
readonly value: {
|
|
1901
2673
|
readonly type: "string";
|
|
1902
|
-
readonly description: "The measured numeric
|
|
2674
|
+
readonly description: "The measured value as a numeric string (e.g. '1234.56')";
|
|
1903
2675
|
readonly maxLength: 500;
|
|
1904
2676
|
};
|
|
1905
2677
|
readonly startDate: {
|
|
@@ -1910,7 +2682,7 @@ export declare const schemas: ({
|
|
|
1910
2682
|
readonly endDate: {
|
|
1911
2683
|
readonly type: "string";
|
|
1912
2684
|
readonly format: "datetime";
|
|
1913
|
-
readonly description: "The end date and time when the measurement ended.
|
|
2685
|
+
readonly description: "The end date and time when the measurement ended. For one-time measurements, this should equal the start date.";
|
|
1914
2686
|
};
|
|
1915
2687
|
readonly locations: {
|
|
1916
2688
|
readonly type: "array";
|
|
@@ -1942,7 +2714,7 @@ export declare const schemas: ({
|
|
|
1942
2714
|
};
|
|
1943
2715
|
readonly measurers: {
|
|
1944
2716
|
readonly type: "array";
|
|
1945
|
-
readonly description: "DIDs of the
|
|
2717
|
+
readonly description: "DIDs of the entities that performed this measurement";
|
|
1946
2718
|
readonly items: {
|
|
1947
2719
|
readonly type: "ref";
|
|
1948
2720
|
readonly ref: "lex:app.certified.defs#did";
|
|
@@ -1972,49 +2744,10 @@ export declare const schemas: ({
|
|
|
1972
2744
|
};
|
|
1973
2745
|
};
|
|
1974
2746
|
};
|
|
1975
|
-
} | {
|
|
1976
|
-
readonly lexicon: 1;
|
|
1977
|
-
readonly id: "org.hypercerts.claim.rights";
|
|
1978
|
-
readonly defs: {
|
|
1979
|
-
readonly main: {
|
|
1980
|
-
readonly type: "record";
|
|
1981
|
-
readonly 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.";
|
|
1982
|
-
readonly key: "tid";
|
|
1983
|
-
readonly record: {
|
|
1984
|
-
readonly type: "object";
|
|
1985
|
-
readonly required: ["rightsName", "rightsType", "rightsDescription", "createdAt"];
|
|
1986
|
-
readonly properties: {
|
|
1987
|
-
readonly rightsName: {
|
|
1988
|
-
readonly type: "string";
|
|
1989
|
-
readonly description: "Full name of the rights";
|
|
1990
|
-
readonly maxLength: 100;
|
|
1991
|
-
};
|
|
1992
|
-
readonly rightsType: {
|
|
1993
|
-
readonly type: "string";
|
|
1994
|
-
readonly description: "Short rights identifier for easier search";
|
|
1995
|
-
readonly maxLength: 10;
|
|
1996
|
-
};
|
|
1997
|
-
readonly rightsDescription: {
|
|
1998
|
-
readonly type: "string";
|
|
1999
|
-
readonly description: "Description of the rights of this hypercert";
|
|
2000
|
-
};
|
|
2001
|
-
readonly attachment: {
|
|
2002
|
-
readonly type: "union";
|
|
2003
|
-
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
2004
|
-
readonly description: "An attachment to define the rights further, e.g. a legal document.";
|
|
2005
|
-
};
|
|
2006
|
-
readonly createdAt: {
|
|
2007
|
-
readonly type: "string";
|
|
2008
|
-
readonly format: "datetime";
|
|
2009
|
-
readonly description: "Client-declared timestamp when this record was originally created";
|
|
2010
|
-
};
|
|
2011
|
-
};
|
|
2012
|
-
};
|
|
2013
|
-
};
|
|
2014
|
-
};
|
|
2015
2747
|
} | {
|
|
2016
2748
|
readonly lexicon: 1;
|
|
2017
2749
|
readonly id: "org.hypercerts.defs";
|
|
2750
|
+
readonly description: "Common type definitions used across all Hypercerts protocols.";
|
|
2018
2751
|
readonly defs: {
|
|
2019
2752
|
readonly uri: {
|
|
2020
2753
|
readonly type: "object";
|
|
@@ -2024,7 +2757,6 @@ export declare const schemas: ({
|
|
|
2024
2757
|
readonly uri: {
|
|
2025
2758
|
readonly type: "string";
|
|
2026
2759
|
readonly format: "uri";
|
|
2027
|
-
readonly maxGraphemes: 1024;
|
|
2028
2760
|
readonly description: "URI to external data";
|
|
2029
2761
|
};
|
|
2030
2762
|
};
|
|
@@ -2068,6 +2800,19 @@ export declare const schemas: ({
|
|
|
2068
2800
|
};
|
|
2069
2801
|
};
|
|
2070
2802
|
};
|
|
2803
|
+
readonly smallVideo: {
|
|
2804
|
+
readonly type: "object";
|
|
2805
|
+
readonly required: ["video"];
|
|
2806
|
+
readonly description: "Object containing a small video";
|
|
2807
|
+
readonly properties: {
|
|
2808
|
+
readonly video: {
|
|
2809
|
+
readonly type: "blob";
|
|
2810
|
+
readonly accept: ["video/mp4", "video/webm"];
|
|
2811
|
+
readonly maxSize: 20971520;
|
|
2812
|
+
readonly description: "Video (up to 20MB)";
|
|
2813
|
+
};
|
|
2814
|
+
};
|
|
2815
|
+
};
|
|
2071
2816
|
readonly largeImage: {
|
|
2072
2817
|
readonly type: "object";
|
|
2073
2818
|
readonly required: ["image"];
|
|
@@ -2102,26 +2847,32 @@ export declare const schemas: ({
|
|
|
2102
2847
|
readonly to: {
|
|
2103
2848
|
readonly type: "string";
|
|
2104
2849
|
readonly description: "The recipient of the funds. Can be identified by DID or a clear-text name.";
|
|
2850
|
+
readonly maxLength: 2048;
|
|
2105
2851
|
};
|
|
2106
2852
|
readonly amount: {
|
|
2107
2853
|
readonly type: "string";
|
|
2108
|
-
readonly description: "Amount of funding received.";
|
|
2854
|
+
readonly description: "Amount of funding received as a numeric string (e.g. '1000.50').";
|
|
2855
|
+
readonly maxLength: 50;
|
|
2109
2856
|
};
|
|
2110
2857
|
readonly currency: {
|
|
2111
2858
|
readonly type: "string";
|
|
2112
2859
|
readonly description: "Currency of the payment (e.g. EUR, USD, ETH).";
|
|
2860
|
+
readonly maxLength: 10;
|
|
2113
2861
|
};
|
|
2114
2862
|
readonly paymentRail: {
|
|
2115
2863
|
readonly type: "string";
|
|
2116
2864
|
readonly description: "How the funds were transferred (e.g. bank_transfer, credit_card, onchain, cash, check, payment_processor).";
|
|
2865
|
+
readonly maxLength: 50;
|
|
2117
2866
|
};
|
|
2118
2867
|
readonly paymentNetwork: {
|
|
2119
2868
|
readonly type: "string";
|
|
2120
2869
|
readonly description: "Optional network within the payment rail (e.g. arbitrum, ethereum, sepa, visa, paypal).";
|
|
2870
|
+
readonly maxLength: 50;
|
|
2121
2871
|
};
|
|
2122
2872
|
readonly transactionId: {
|
|
2123
2873
|
readonly type: "string";
|
|
2124
2874
|
readonly 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.";
|
|
2875
|
+
readonly maxLength: 256;
|
|
2125
2876
|
};
|
|
2126
2877
|
readonly for: {
|
|
2127
2878
|
readonly type: "string";
|
|
@@ -2149,34 +2900,68 @@ export declare const schemas: ({
|
|
|
2149
2900
|
};
|
|
2150
2901
|
} | {
|
|
2151
2902
|
readonly lexicon: 1;
|
|
2152
|
-
readonly id: "org.hypercerts.
|
|
2903
|
+
readonly id: "org.hypercerts.workscope.cel";
|
|
2904
|
+
readonly defs: {
|
|
2905
|
+
readonly main: {
|
|
2906
|
+
readonly type: "object";
|
|
2907
|
+
readonly 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.";
|
|
2908
|
+
readonly required: ["expression", "usedTags", "version", "createdAt"];
|
|
2909
|
+
readonly properties: {
|
|
2910
|
+
readonly expression: {
|
|
2911
|
+
readonly type: "string";
|
|
2912
|
+
readonly maxLength: 10000;
|
|
2913
|
+
readonly maxGraphemes: 5000;
|
|
2914
|
+
readonly description: "A CEL expression encoding the work scope conditions. Example: scope.hasAll(['mangrove_restoration', 'environmental_education']) && location.country == 'KE'";
|
|
2915
|
+
};
|
|
2916
|
+
readonly usedTags: {
|
|
2917
|
+
readonly type: "array";
|
|
2918
|
+
readonly items: {
|
|
2919
|
+
readonly type: "ref";
|
|
2920
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
2921
|
+
};
|
|
2922
|
+
readonly maxLength: 100;
|
|
2923
|
+
readonly 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.";
|
|
2924
|
+
};
|
|
2925
|
+
readonly version: {
|
|
2926
|
+
readonly type: "string";
|
|
2927
|
+
readonly maxLength: 16;
|
|
2928
|
+
readonly knownValues: ["v1"];
|
|
2929
|
+
readonly description: "CEL context schema version.";
|
|
2930
|
+
};
|
|
2931
|
+
readonly createdAt: {
|
|
2932
|
+
readonly type: "string";
|
|
2933
|
+
readonly format: "datetime";
|
|
2934
|
+
readonly description: "Client-declared timestamp when this expression was originally created.";
|
|
2935
|
+
};
|
|
2936
|
+
};
|
|
2937
|
+
};
|
|
2938
|
+
};
|
|
2939
|
+
} | {
|
|
2940
|
+
readonly lexicon: 1;
|
|
2941
|
+
readonly id: "org.hypercerts.workscope.tag";
|
|
2153
2942
|
readonly defs: {
|
|
2154
2943
|
readonly main: {
|
|
2155
2944
|
readonly type: "record";
|
|
2156
|
-
readonly description: "A reusable scope atom for work scope logic expressions. Scopes can represent topics, languages, domains, deliverables, methods, regions, tags, or other categorical labels.";
|
|
2945
|
+
readonly 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.";
|
|
2157
2946
|
readonly key: "tid";
|
|
2158
2947
|
readonly record: {
|
|
2159
2948
|
readonly type: "object";
|
|
2160
|
-
readonly required: ["
|
|
2949
|
+
readonly required: ["key", "name", "createdAt"];
|
|
2161
2950
|
readonly properties: {
|
|
2162
|
-
readonly createdAt: {
|
|
2163
|
-
readonly type: "string";
|
|
2164
|
-
readonly format: "datetime";
|
|
2165
|
-
readonly description: "Client-declared timestamp when this record was originally created";
|
|
2166
|
-
};
|
|
2167
2951
|
readonly key: {
|
|
2168
2952
|
readonly type: "string";
|
|
2169
|
-
readonly description: "Lowercase,
|
|
2953
|
+
readonly description: "Lowercase, underscore-separated machine-readable key for this scope (e.g., 'mangrove_restoration', 'biodiversity_monitoring'). Used as the canonical identifier in CEL expressions.";
|
|
2170
2954
|
readonly maxLength: 120;
|
|
2171
2955
|
};
|
|
2172
|
-
readonly
|
|
2956
|
+
readonly name: {
|
|
2173
2957
|
readonly type: "string";
|
|
2174
|
-
readonly description: "Human-readable
|
|
2958
|
+
readonly description: "Human-readable name for this scope.";
|
|
2175
2959
|
readonly maxLength: 200;
|
|
2176
2960
|
};
|
|
2177
|
-
readonly
|
|
2961
|
+
readonly category: {
|
|
2178
2962
|
readonly type: "string";
|
|
2179
|
-
readonly description: "Category type of this scope.
|
|
2963
|
+
readonly description: "Category type of this scope.";
|
|
2964
|
+
readonly knownValues: ["topic", "language", "domain", "method"];
|
|
2180
2965
|
readonly maxLength: 50;
|
|
2181
2966
|
};
|
|
2182
2967
|
readonly description: {
|
|
@@ -2188,7 +2973,18 @@ export declare const schemas: ({
|
|
|
2188
2973
|
readonly parent: {
|
|
2189
2974
|
readonly type: "ref";
|
|
2190
2975
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
2191
|
-
readonly description: "Optional strong reference to a parent scope record for taxonomy/hierarchy support.";
|
|
2976
|
+
readonly 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.";
|
|
2977
|
+
};
|
|
2978
|
+
readonly status: {
|
|
2979
|
+
readonly type: "string";
|
|
2980
|
+
readonly description: "Lifecycle status of this tag. Communities propose tags, curators accept them, deprecated tags point to replacements via supersededBy.";
|
|
2981
|
+
readonly knownValues: ["proposed", "accepted", "deprecated"];
|
|
2982
|
+
readonly maxLength: 20;
|
|
2983
|
+
};
|
|
2984
|
+
readonly supersededBy: {
|
|
2985
|
+
readonly type: "ref";
|
|
2986
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
2987
|
+
readonly 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.";
|
|
2192
2988
|
};
|
|
2193
2989
|
readonly aliases: {
|
|
2194
2990
|
readonly type: "array";
|
|
@@ -2197,12 +2993,27 @@ export declare const schemas: ({
|
|
|
2197
2993
|
readonly maxLength: 200;
|
|
2198
2994
|
};
|
|
2199
2995
|
readonly maxLength: 50;
|
|
2200
|
-
readonly description: "
|
|
2996
|
+
readonly 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.";
|
|
2997
|
+
};
|
|
2998
|
+
readonly sameAs: {
|
|
2999
|
+
readonly type: "array";
|
|
3000
|
+
readonly items: {
|
|
3001
|
+
readonly type: "string";
|
|
3002
|
+
readonly format: "uri";
|
|
3003
|
+
readonly maxLength: 2048;
|
|
3004
|
+
};
|
|
3005
|
+
readonly maxLength: 20;
|
|
3006
|
+
readonly 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.";
|
|
2201
3007
|
};
|
|
2202
|
-
readonly
|
|
3008
|
+
readonly referenceDocument: {
|
|
2203
3009
|
readonly type: "union";
|
|
2204
3010
|
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
2205
|
-
readonly description: "
|
|
3011
|
+
readonly description: "Link to a governance or reference document where this work scope tag is defined and further explained.";
|
|
3012
|
+
};
|
|
3013
|
+
readonly createdAt: {
|
|
3014
|
+
readonly type: "string";
|
|
3015
|
+
readonly format: "datetime";
|
|
3016
|
+
readonly description: "Client-declared timestamp when this record was originally created.";
|
|
2206
3017
|
};
|
|
2207
3018
|
};
|
|
2208
3019
|
};
|
|
@@ -2217,6 +3028,7 @@ export declare function validate<T extends {
|
|
|
2217
3028
|
$type?: string;
|
|
2218
3029
|
}>(v: unknown, id: string, hash: string, requiredType?: false): ValidationResult<T>;
|
|
2219
3030
|
export declare const ids: {
|
|
3031
|
+
readonly AppCertifiedActorOrganization: "app.certified.actor.organization";
|
|
2220
3032
|
readonly AppCertifiedActorProfile: "app.certified.actor.profile";
|
|
2221
3033
|
readonly AppCertifiedBadgeAward: "app.certified.badge.award";
|
|
2222
3034
|
readonly AppCertifiedBadgeDefinition: "app.certified.badge.definition";
|
|
@@ -2224,16 +3036,20 @@ export declare const ids: {
|
|
|
2224
3036
|
readonly AppCertifiedDefs: "app.certified.defs";
|
|
2225
3037
|
readonly AppCertifiedLocation: "app.certified.location";
|
|
2226
3038
|
readonly ComAtprotoRepoStrongRef: "com.atproto.repo.strongRef";
|
|
3039
|
+
readonly OrgHyperboardsBoard: "org.hyperboards.board";
|
|
3040
|
+
readonly OrgHyperboardsDisplayProfile: "org.hyperboards.displayProfile";
|
|
2227
3041
|
readonly OrgHypercertsClaimActivity: "org.hypercerts.claim.activity";
|
|
2228
|
-
readonly
|
|
2229
|
-
readonly OrgHypercertsClaimCollection: "org.hypercerts.claim.collection";
|
|
2230
|
-
readonly OrgHypercertsClaimContributionDetails: "org.hypercerts.claim.contributionDetails";
|
|
3042
|
+
readonly OrgHypercertsClaimContribution: "org.hypercerts.claim.contribution";
|
|
2231
3043
|
readonly OrgHypercertsClaimContributorInformation: "org.hypercerts.claim.contributorInformation";
|
|
2232
|
-
readonly OrgHypercertsClaimEvaluation: "org.hypercerts.claim.evaluation";
|
|
2233
|
-
readonly OrgHypercertsClaimMeasurement: "org.hypercerts.claim.measurement";
|
|
2234
3044
|
readonly OrgHypercertsClaimRights: "org.hypercerts.claim.rights";
|
|
3045
|
+
readonly OrgHypercertsCollection: "org.hypercerts.collection";
|
|
3046
|
+
readonly OrgHypercertsContextAcknowledgement: "org.hypercerts.context.acknowledgement";
|
|
3047
|
+
readonly OrgHypercertsContextAttachment: "org.hypercerts.context.attachment";
|
|
3048
|
+
readonly OrgHypercertsContextEvaluation: "org.hypercerts.context.evaluation";
|
|
3049
|
+
readonly OrgHypercertsContextMeasurement: "org.hypercerts.context.measurement";
|
|
2235
3050
|
readonly OrgHypercertsDefs: "org.hypercerts.defs";
|
|
2236
3051
|
readonly OrgHypercertsFundingReceipt: "org.hypercerts.funding.receipt";
|
|
2237
|
-
readonly
|
|
3052
|
+
readonly OrgHypercertsWorkscopeCel: "org.hypercerts.workscope.cel";
|
|
3053
|
+
readonly OrgHypercertsWorkscopeTag: "org.hypercerts.workscope.tag";
|
|
2238
3054
|
};
|
|
2239
3055
|
//# sourceMappingURL=lexicons.d.ts.map
|