@hypercerts-org/lexicon 0.10.0-beta.15 → 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 +28 -0
- package/README.md +50 -12
- package/SCHEMAS.md +293 -169
- package/dist/exports.d.ts +566 -179
- package/dist/exports.d.ts.map +1 -1
- package/dist/generated/exports.d.ts +566 -179
- package/dist/generated/exports.d.ts.map +1 -1
- package/dist/generated/lexicons.d.ts +1199 -465
- 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 +2 -2
- 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/generated/types/org/hypercerts/{claim/collection.d.ts → 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 +1822 -830
- package/dist/index.cjs.map +1 -1
- package/dist/index.mjs +1774 -798
- package/dist/index.mjs.map +1 -1
- package/dist/lexicons.cjs +651 -253
- package/dist/lexicons.cjs.map +1 -1
- package/dist/lexicons.d.ts +1199 -465
- package/dist/lexicons.d.ts.map +1 -1
- package/dist/lexicons.mjs +651 -253
- 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 +2 -2
- 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/types/org/hypercerts/{claim/collection.d.ts → 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 +2 -2
- 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/acknowledgement.d.ts +0 -21
- package/dist/generated/types/org/hypercerts/acknowledgement.d.ts.map +0 -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/acknowledgement.d.ts +0 -21
- package/dist/types/org/hypercerts/acknowledgement.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/acknowledgement.json +0 -41
- 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";
|
|
@@ -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,36 +371,199 @@ export declare const schemaDict: {
|
|
|
284
371
|
};
|
|
285
372
|
};
|
|
286
373
|
};
|
|
287
|
-
readonly
|
|
374
|
+
readonly OrgHyperboardsBoard: {
|
|
288
375
|
readonly lexicon: 1;
|
|
289
|
-
readonly id: "org.
|
|
376
|
+
readonly id: "org.hyperboards.board";
|
|
290
377
|
readonly defs: {
|
|
291
378
|
readonly main: {
|
|
292
379
|
readonly type: "record";
|
|
293
|
-
readonly description: "
|
|
380
|
+
readonly description: "Configuration record for a hyperboard, wrapping an underlying activity or collection with visual presentation settings. Stored in the creator's PDS.";
|
|
294
381
|
readonly key: "tid";
|
|
295
382
|
readonly record: {
|
|
296
383
|
readonly type: "object";
|
|
297
|
-
readonly required: ["subject", "
|
|
384
|
+
readonly required: ["subject", "createdAt"];
|
|
298
385
|
readonly properties: {
|
|
299
386
|
readonly subject: {
|
|
300
387
|
readonly type: "ref";
|
|
301
388
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
302
|
-
readonly description: "
|
|
389
|
+
readonly description: "Reference to the org.hypercerts.claim.activity or org.hypercerts.claim.collection this board visualizes.";
|
|
303
390
|
};
|
|
304
|
-
readonly
|
|
391
|
+
readonly config: {
|
|
305
392
|
readonly type: "ref";
|
|
306
|
-
readonly ref: "lex:
|
|
307
|
-
readonly description: "
|
|
393
|
+
readonly ref: "lex:org.hyperboards.board#boardConfig";
|
|
394
|
+
readonly description: "Board-level visual configuration (background, colors, aspect ratio).";
|
|
308
395
|
};
|
|
309
|
-
readonly
|
|
310
|
-
readonly type: "
|
|
311
|
-
readonly description: "
|
|
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
|
+
};
|
|
312
404
|
};
|
|
313
|
-
readonly
|
|
405
|
+
readonly createdAt: {
|
|
314
406
|
readonly type: "string";
|
|
315
|
-
readonly
|
|
316
|
-
readonly
|
|
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;
|
|
317
567
|
};
|
|
318
568
|
readonly createdAt: {
|
|
319
569
|
readonly type: "string";
|
|
@@ -339,7 +589,7 @@ export declare const schemaDict: {
|
|
|
339
589
|
readonly properties: {
|
|
340
590
|
readonly title: {
|
|
341
591
|
readonly type: "string";
|
|
342
|
-
readonly description: "
|
|
592
|
+
readonly description: "Display title summarizing the impact work (e.g. 'Reforestation in Amazon Basin 2024')";
|
|
343
593
|
readonly maxLength: 256;
|
|
344
594
|
};
|
|
345
595
|
readonly shortDescription: {
|
|
@@ -357,28 +607,28 @@ export declare const schemaDict: {
|
|
|
357
607
|
};
|
|
358
608
|
};
|
|
359
609
|
readonly description: {
|
|
360
|
-
readonly type: "
|
|
361
|
-
readonly
|
|
362
|
-
readonly
|
|
363
|
-
readonly maxGraphemes: 3000;
|
|
364
|
-
};
|
|
365
|
-
readonly descriptionFacets: {
|
|
366
|
-
readonly type: "array";
|
|
367
|
-
readonly description: "Rich text annotations for `description` (mentions, URLs, hashtags, etc).";
|
|
368
|
-
readonly items: {
|
|
369
|
-
readonly type: "ref";
|
|
370
|
-
readonly ref: "lex:app.bsky.richtext.facet";
|
|
371
|
-
};
|
|
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.";
|
|
372
613
|
};
|
|
373
614
|
readonly image: {
|
|
374
615
|
readonly type: "union";
|
|
375
616
|
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
376
617
|
readonly description: "The hypercert visual representation as a URI or image blob.";
|
|
377
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
|
+
};
|
|
378
628
|
readonly workScope: {
|
|
379
629
|
readonly type: "union";
|
|
380
|
-
readonly refs: ["lex:
|
|
381
|
-
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.";
|
|
382
632
|
};
|
|
383
633
|
readonly startDate: {
|
|
384
634
|
readonly type: "string";
|
|
@@ -390,12 +640,13 @@ export declare const schemaDict: {
|
|
|
390
640
|
readonly format: "datetime";
|
|
391
641
|
readonly description: "When the work ended";
|
|
392
642
|
};
|
|
393
|
-
readonly
|
|
643
|
+
readonly locations: {
|
|
394
644
|
readonly type: "array";
|
|
395
|
-
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;
|
|
396
647
|
readonly items: {
|
|
397
648
|
readonly type: "ref";
|
|
398
|
-
readonly ref: "lex:
|
|
649
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
399
650
|
};
|
|
400
651
|
};
|
|
401
652
|
readonly rights: {
|
|
@@ -403,14 +654,6 @@ export declare const schemaDict: {
|
|
|
403
654
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
404
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.";
|
|
405
656
|
};
|
|
406
|
-
readonly locations: {
|
|
407
|
-
readonly type: "array";
|
|
408
|
-
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.";
|
|
409
|
-
readonly items: {
|
|
410
|
-
readonly type: "ref";
|
|
411
|
-
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
412
|
-
};
|
|
413
|
-
};
|
|
414
657
|
readonly createdAt: {
|
|
415
658
|
readonly type: "string";
|
|
416
659
|
readonly format: "datetime";
|
|
@@ -426,16 +669,17 @@ export declare const schemaDict: {
|
|
|
426
669
|
readonly contributorIdentity: {
|
|
427
670
|
readonly type: "union";
|
|
428
671
|
readonly refs: ["lex:org.hypercerts.claim.activity#contributorIdentity", "lex:com.atproto.repo.strongRef"];
|
|
429
|
-
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.";
|
|
430
673
|
};
|
|
431
674
|
readonly contributionWeight: {
|
|
432
675
|
readonly type: "string";
|
|
433
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;
|
|
434
678
|
};
|
|
435
679
|
readonly contributionDetails: {
|
|
436
680
|
readonly type: "union";
|
|
437
681
|
readonly refs: ["lex:org.hypercerts.claim.activity#contributorRole", "lex:com.atproto.repo.strongRef"];
|
|
438
|
-
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.";
|
|
439
683
|
};
|
|
440
684
|
};
|
|
441
685
|
};
|
|
@@ -480,78 +724,75 @@ export declare const schemaDict: {
|
|
|
480
724
|
};
|
|
481
725
|
};
|
|
482
726
|
};
|
|
483
|
-
readonly
|
|
727
|
+
readonly OrgHypercertsClaimContribution: {
|
|
484
728
|
readonly lexicon: 1;
|
|
485
|
-
readonly id: "org.hypercerts.claim.
|
|
729
|
+
readonly id: "org.hypercerts.claim.contribution";
|
|
486
730
|
readonly defs: {
|
|
487
731
|
readonly main: {
|
|
488
732
|
readonly type: "record";
|
|
489
|
-
readonly description: "
|
|
733
|
+
readonly description: "Details about a specific contribution including role, description, and timeframe.";
|
|
490
734
|
readonly key: "tid";
|
|
491
735
|
readonly record: {
|
|
492
736
|
readonly type: "object";
|
|
493
|
-
readonly required: ["
|
|
737
|
+
readonly required: ["createdAt"];
|
|
494
738
|
readonly properties: {
|
|
495
|
-
readonly
|
|
496
|
-
readonly type: "array";
|
|
497
|
-
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.";
|
|
498
|
-
readonly items: {
|
|
499
|
-
readonly type: "ref";
|
|
500
|
-
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
501
|
-
};
|
|
502
|
-
readonly maxLength: 100;
|
|
503
|
-
};
|
|
504
|
-
readonly contentType: {
|
|
739
|
+
readonly role: {
|
|
505
740
|
readonly type: "string";
|
|
506
|
-
readonly
|
|
507
|
-
readonly description: "The type of attachment, e.g. report, audit, evidence, testimonial, methodology, etc.";
|
|
508
|
-
};
|
|
509
|
-
readonly content: {
|
|
510
|
-
readonly type: "array";
|
|
511
|
-
readonly description: "The files, documents, or external references included in this attachment record.";
|
|
512
|
-
readonly items: {
|
|
513
|
-
readonly type: "union";
|
|
514
|
-
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
515
|
-
};
|
|
741
|
+
readonly description: "Role or title of the contributor.";
|
|
516
742
|
readonly maxLength: 100;
|
|
517
743
|
};
|
|
518
|
-
readonly
|
|
744
|
+
readonly contributionDescription: {
|
|
519
745
|
readonly type: "string";
|
|
520
|
-
readonly
|
|
521
|
-
readonly
|
|
746
|
+
readonly description: "Description of what the contribution concretely involved.";
|
|
747
|
+
readonly maxLength: 10000;
|
|
748
|
+
readonly maxGraphemes: 1000;
|
|
522
749
|
};
|
|
523
|
-
readonly
|
|
750
|
+
readonly startDate: {
|
|
524
751
|
readonly type: "string";
|
|
525
|
-
readonly
|
|
526
|
-
readonly
|
|
527
|
-
readonly maxGraphemes: 300;
|
|
752
|
+
readonly format: "datetime";
|
|
753
|
+
readonly description: "When this contribution started. Should fall within the parent hypercert's timeframe.";
|
|
528
754
|
};
|
|
529
|
-
readonly
|
|
530
|
-
readonly type: "
|
|
531
|
-
readonly
|
|
532
|
-
readonly
|
|
533
|
-
readonly type: "ref";
|
|
534
|
-
readonly ref: "lex:app.bsky.richtext.facet";
|
|
535
|
-
};
|
|
755
|
+
readonly endDate: {
|
|
756
|
+
readonly type: "string";
|
|
757
|
+
readonly format: "datetime";
|
|
758
|
+
readonly description: "When this contribution finished. Should fall within the parent hypercert's timeframe.";
|
|
536
759
|
};
|
|
537
|
-
readonly
|
|
760
|
+
readonly createdAt: {
|
|
538
761
|
readonly type: "string";
|
|
539
|
-
readonly
|
|
540
|
-
readonly
|
|
541
|
-
readonly maxGraphemes: 3000;
|
|
762
|
+
readonly format: "datetime";
|
|
763
|
+
readonly description: "Client-declared timestamp when this record was originally created.";
|
|
542
764
|
};
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
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: {
|
|
783
|
+
readonly type: "string";
|
|
784
|
+
readonly description: "DID (did:plc:...) or URI to a social profile of the contributor.";
|
|
785
|
+
readonly maxLength: 2048;
|
|
550
786
|
};
|
|
551
|
-
readonly
|
|
552
|
-
readonly type: "
|
|
553
|
-
readonly
|
|
554
|
-
readonly
|
|
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;
|
|
791
|
+
};
|
|
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.";
|
|
555
796
|
};
|
|
556
797
|
readonly createdAt: {
|
|
557
798
|
readonly type: "string";
|
|
@@ -563,9 +804,52 @@ export declare const schemaDict: {
|
|
|
563
804
|
};
|
|
564
805
|
};
|
|
565
806
|
};
|
|
566
|
-
readonly
|
|
807
|
+
readonly OrgHypercertsClaimRights: {
|
|
808
|
+
readonly lexicon: 1;
|
|
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: {
|
|
567
851
|
readonly lexicon: 1;
|
|
568
|
-
readonly id: "org.hypercerts.
|
|
852
|
+
readonly id: "org.hypercerts.collection";
|
|
569
853
|
readonly defs: {
|
|
570
854
|
readonly main: {
|
|
571
855
|
readonly type: "record";
|
|
@@ -573,15 +857,16 @@ export declare const schemaDict: {
|
|
|
573
857
|
readonly key: "tid";
|
|
574
858
|
readonly record: {
|
|
575
859
|
readonly type: "object";
|
|
576
|
-
readonly required: ["title", "
|
|
860
|
+
readonly required: ["title", "createdAt"];
|
|
577
861
|
readonly properties: {
|
|
578
862
|
readonly type: {
|
|
579
863
|
readonly type: "string";
|
|
580
864
|
readonly description: "The type of this collection. Possible fields can be 'favorites', 'project', or any other type of collection.";
|
|
865
|
+
readonly maxLength: 64;
|
|
581
866
|
};
|
|
582
867
|
readonly title: {
|
|
583
868
|
readonly type: "string";
|
|
584
|
-
readonly description: "
|
|
869
|
+
readonly description: "Display name for this collection (e.g. 'Q1 2025 Impact Projects')";
|
|
585
870
|
readonly maxLength: 800;
|
|
586
871
|
readonly maxGraphemes: 80;
|
|
587
872
|
};
|
|
@@ -609,9 +894,10 @@ export declare const schemaDict: {
|
|
|
609
894
|
readonly items: {
|
|
610
895
|
readonly type: "array";
|
|
611
896
|
readonly description: "Array of items in this collection with optional weights.";
|
|
897
|
+
readonly maxLength: 1000;
|
|
612
898
|
readonly items: {
|
|
613
899
|
readonly type: "ref";
|
|
614
|
-
readonly ref: "lex:org.hypercerts.
|
|
900
|
+
readonly ref: "lex:org.hypercerts.collection#item";
|
|
615
901
|
};
|
|
616
902
|
};
|
|
617
903
|
readonly location: {
|
|
@@ -634,48 +920,48 @@ export declare const schemaDict: {
|
|
|
634
920
|
readonly itemIdentifier: {
|
|
635
921
|
readonly type: "ref";
|
|
636
922
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
637
|
-
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).";
|
|
638
924
|
};
|
|
639
925
|
readonly itemWeight: {
|
|
640
926
|
readonly type: "string";
|
|
641
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;
|
|
642
929
|
};
|
|
643
930
|
};
|
|
644
931
|
};
|
|
645
932
|
};
|
|
646
933
|
};
|
|
647
|
-
readonly
|
|
934
|
+
readonly OrgHypercertsContextAcknowledgement: {
|
|
648
935
|
readonly lexicon: 1;
|
|
649
|
-
readonly id: "org.hypercerts.
|
|
936
|
+
readonly id: "org.hypercerts.context.acknowledgement";
|
|
650
937
|
readonly defs: {
|
|
651
938
|
readonly main: {
|
|
652
939
|
readonly type: "record";
|
|
653
|
-
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.";
|
|
654
941
|
readonly key: "tid";
|
|
655
942
|
readonly record: {
|
|
656
943
|
readonly type: "object";
|
|
657
|
-
readonly required: ["createdAt"];
|
|
944
|
+
readonly required: ["subject", "acknowledged", "createdAt"];
|
|
658
945
|
readonly properties: {
|
|
659
|
-
readonly
|
|
660
|
-
readonly type: "
|
|
661
|
-
readonly
|
|
662
|
-
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).";
|
|
663
950
|
};
|
|
664
|
-
readonly
|
|
665
|
-
readonly type: "
|
|
666
|
-
readonly
|
|
667
|
-
readonly
|
|
668
|
-
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.";
|
|
669
955
|
};
|
|
670
|
-
readonly
|
|
671
|
-
readonly type: "
|
|
672
|
-
readonly
|
|
673
|
-
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).";
|
|
674
959
|
};
|
|
675
|
-
readonly
|
|
960
|
+
readonly comment: {
|
|
676
961
|
readonly type: "string";
|
|
677
|
-
readonly
|
|
678
|
-
readonly
|
|
962
|
+
readonly description: "Optional plain-text comment providing additional context or reasoning.";
|
|
963
|
+
readonly maxLength: 10000;
|
|
964
|
+
readonly maxGraphemes: 1000;
|
|
679
965
|
};
|
|
680
966
|
readonly createdAt: {
|
|
681
967
|
readonly type: "string";
|
|
@@ -687,31 +973,69 @@ export declare const schemaDict: {
|
|
|
687
973
|
};
|
|
688
974
|
};
|
|
689
975
|
};
|
|
690
|
-
readonly
|
|
976
|
+
readonly OrgHypercertsContextAttachment: {
|
|
691
977
|
readonly lexicon: 1;
|
|
692
|
-
readonly id: "org.hypercerts.
|
|
978
|
+
readonly id: "org.hypercerts.context.attachment";
|
|
693
979
|
readonly defs: {
|
|
694
980
|
readonly main: {
|
|
695
981
|
readonly type: "record";
|
|
696
|
-
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).";
|
|
697
983
|
readonly key: "tid";
|
|
698
984
|
readonly record: {
|
|
699
985
|
readonly type: "object";
|
|
700
|
-
readonly required: ["createdAt"];
|
|
986
|
+
readonly required: ["title", "createdAt"];
|
|
701
987
|
readonly properties: {
|
|
702
|
-
readonly
|
|
703
|
-
readonly type: "
|
|
704
|
-
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;
|
|
705
996
|
};
|
|
706
|
-
readonly
|
|
997
|
+
readonly contentType: {
|
|
707
998
|
readonly type: "string";
|
|
708
|
-
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
|
+
};
|
|
709
1009
|
readonly maxLength: 100;
|
|
710
1010
|
};
|
|
711
|
-
readonly
|
|
712
|
-
readonly type: "
|
|
713
|
-
readonly
|
|
714
|
-
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.";
|
|
715
1039
|
};
|
|
716
1040
|
readonly createdAt: {
|
|
717
1041
|
readonly type: "string";
|
|
@@ -723,29 +1047,10 @@ export declare const schemaDict: {
|
|
|
723
1047
|
};
|
|
724
1048
|
};
|
|
725
1049
|
};
|
|
726
|
-
readonly
|
|
1050
|
+
readonly OrgHypercertsContextEvaluation: {
|
|
727
1051
|
readonly lexicon: 1;
|
|
728
|
-
readonly id: "org.hypercerts.
|
|
1052
|
+
readonly id: "org.hypercerts.context.evaluation";
|
|
729
1053
|
readonly defs: {
|
|
730
|
-
readonly score: {
|
|
731
|
-
readonly type: "object";
|
|
732
|
-
readonly description: "Overall score for an evaluation on a numeric scale.";
|
|
733
|
-
readonly required: ["min", "max", "value"];
|
|
734
|
-
readonly properties: {
|
|
735
|
-
readonly min: {
|
|
736
|
-
readonly type: "integer";
|
|
737
|
-
readonly description: "Minimum value of the scale, e.g. 0 or 1.";
|
|
738
|
-
};
|
|
739
|
-
readonly max: {
|
|
740
|
-
readonly type: "integer";
|
|
741
|
-
readonly description: "Maximum value of the scale, e.g. 5 or 10.";
|
|
742
|
-
};
|
|
743
|
-
readonly value: {
|
|
744
|
-
readonly type: "integer";
|
|
745
|
-
readonly description: "Score within the inclusive range [min, max].";
|
|
746
|
-
};
|
|
747
|
-
};
|
|
748
|
-
};
|
|
749
1054
|
readonly main: {
|
|
750
1055
|
readonly type: "record";
|
|
751
1056
|
readonly description: "An evaluation of a hypercert record (e.g. an activity and its impact).";
|
|
@@ -757,7 +1062,7 @@ export declare const schemaDict: {
|
|
|
757
1062
|
readonly subject: {
|
|
758
1063
|
readonly type: "ref";
|
|
759
1064
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
760
|
-
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.)";
|
|
761
1066
|
};
|
|
762
1067
|
readonly evaluators: {
|
|
763
1068
|
readonly type: "array";
|
|
@@ -779,7 +1084,7 @@ export declare const schemaDict: {
|
|
|
779
1084
|
};
|
|
780
1085
|
readonly measurements: {
|
|
781
1086
|
readonly type: "array";
|
|
782
|
-
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";
|
|
783
1088
|
readonly items: {
|
|
784
1089
|
readonly type: "ref";
|
|
785
1090
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
@@ -794,7 +1099,7 @@ export declare const schemaDict: {
|
|
|
794
1099
|
};
|
|
795
1100
|
readonly score: {
|
|
796
1101
|
readonly type: "ref";
|
|
797
|
-
readonly ref: "lex:org.hypercerts.
|
|
1102
|
+
readonly ref: "lex:org.hypercerts.context.evaluation#score";
|
|
798
1103
|
readonly description: "Optional overall score for this evaluation on a numeric scale.";
|
|
799
1104
|
};
|
|
800
1105
|
readonly location: {
|
|
@@ -810,24 +1115,47 @@ export declare const schemaDict: {
|
|
|
810
1115
|
};
|
|
811
1116
|
};
|
|
812
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
|
+
};
|
|
813
1137
|
};
|
|
814
1138
|
};
|
|
815
|
-
readonly
|
|
1139
|
+
readonly OrgHypercertsContextMeasurement: {
|
|
816
1140
|
readonly lexicon: 1;
|
|
817
|
-
readonly id: "org.hypercerts.
|
|
1141
|
+
readonly id: "org.hypercerts.context.measurement";
|
|
818
1142
|
readonly defs: {
|
|
819
1143
|
readonly main: {
|
|
820
1144
|
readonly type: "record";
|
|
821
|
-
readonly description: "Measurement data related to
|
|
1145
|
+
readonly description: "Measurement data related to one or more records (e.g. activities, projects, etc.).";
|
|
822
1146
|
readonly key: "tid";
|
|
823
1147
|
readonly record: {
|
|
824
1148
|
readonly type: "object";
|
|
825
1149
|
readonly required: ["metric", "unit", "value", "createdAt"];
|
|
826
1150
|
readonly properties: {
|
|
827
|
-
readonly
|
|
828
|
-
readonly type: "
|
|
829
|
-
readonly
|
|
830
|
-
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;
|
|
831
1159
|
};
|
|
832
1160
|
readonly metric: {
|
|
833
1161
|
readonly type: "string";
|
|
@@ -841,7 +1169,7 @@ export declare const schemaDict: {
|
|
|
841
1169
|
};
|
|
842
1170
|
readonly value: {
|
|
843
1171
|
readonly type: "string";
|
|
844
|
-
readonly description: "The measured numeric
|
|
1172
|
+
readonly description: "The measured value as a numeric string (e.g. '1234.56')";
|
|
845
1173
|
readonly maxLength: 500;
|
|
846
1174
|
};
|
|
847
1175
|
readonly startDate: {
|
|
@@ -852,7 +1180,7 @@ export declare const schemaDict: {
|
|
|
852
1180
|
readonly endDate: {
|
|
853
1181
|
readonly type: "string";
|
|
854
1182
|
readonly format: "datetime";
|
|
855
|
-
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.";
|
|
856
1184
|
};
|
|
857
1185
|
readonly locations: {
|
|
858
1186
|
readonly type: "array";
|
|
@@ -884,7 +1212,7 @@ export declare const schemaDict: {
|
|
|
884
1212
|
};
|
|
885
1213
|
readonly measurers: {
|
|
886
1214
|
readonly type: "array";
|
|
887
|
-
readonly description: "DIDs of the
|
|
1215
|
+
readonly description: "DIDs of the entities that performed this measurement";
|
|
888
1216
|
readonly items: {
|
|
889
1217
|
readonly type: "ref";
|
|
890
1218
|
readonly ref: "lex:app.certified.defs#did";
|
|
@@ -915,50 +1243,10 @@ export declare const schemaDict: {
|
|
|
915
1243
|
};
|
|
916
1244
|
};
|
|
917
1245
|
};
|
|
918
|
-
readonly OrgHypercertsClaimRights: {
|
|
919
|
-
readonly lexicon: 1;
|
|
920
|
-
readonly id: "org.hypercerts.claim.rights";
|
|
921
|
-
readonly defs: {
|
|
922
|
-
readonly main: {
|
|
923
|
-
readonly type: "record";
|
|
924
|
-
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.";
|
|
925
|
-
readonly key: "tid";
|
|
926
|
-
readonly record: {
|
|
927
|
-
readonly type: "object";
|
|
928
|
-
readonly required: ["rightsName", "rightsType", "rightsDescription", "createdAt"];
|
|
929
|
-
readonly properties: {
|
|
930
|
-
readonly rightsName: {
|
|
931
|
-
readonly type: "string";
|
|
932
|
-
readonly description: "Full name of the rights";
|
|
933
|
-
readonly maxLength: 100;
|
|
934
|
-
};
|
|
935
|
-
readonly rightsType: {
|
|
936
|
-
readonly type: "string";
|
|
937
|
-
readonly description: "Short rights identifier for easier search";
|
|
938
|
-
readonly maxLength: 10;
|
|
939
|
-
};
|
|
940
|
-
readonly rightsDescription: {
|
|
941
|
-
readonly type: "string";
|
|
942
|
-
readonly description: "Description of the rights of this hypercert";
|
|
943
|
-
};
|
|
944
|
-
readonly attachment: {
|
|
945
|
-
readonly type: "union";
|
|
946
|
-
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
947
|
-
readonly description: "An attachment to define the rights further, e.g. a legal document.";
|
|
948
|
-
};
|
|
949
|
-
readonly createdAt: {
|
|
950
|
-
readonly type: "string";
|
|
951
|
-
readonly format: "datetime";
|
|
952
|
-
readonly description: "Client-declared timestamp when this record was originally created";
|
|
953
|
-
};
|
|
954
|
-
};
|
|
955
|
-
};
|
|
956
|
-
};
|
|
957
|
-
};
|
|
958
|
-
};
|
|
959
1246
|
readonly OrgHypercertsDefs: {
|
|
960
1247
|
readonly lexicon: 1;
|
|
961
1248
|
readonly id: "org.hypercerts.defs";
|
|
1249
|
+
readonly description: "Common type definitions used across all Hypercerts protocols.";
|
|
962
1250
|
readonly defs: {
|
|
963
1251
|
readonly uri: {
|
|
964
1252
|
readonly type: "object";
|
|
@@ -968,7 +1256,6 @@ export declare const schemaDict: {
|
|
|
968
1256
|
readonly uri: {
|
|
969
1257
|
readonly type: "string";
|
|
970
1258
|
readonly format: "uri";
|
|
971
|
-
readonly maxGraphemes: 1024;
|
|
972
1259
|
readonly description: "URI to external data";
|
|
973
1260
|
};
|
|
974
1261
|
};
|
|
@@ -1012,6 +1299,19 @@ export declare const schemaDict: {
|
|
|
1012
1299
|
};
|
|
1013
1300
|
};
|
|
1014
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
|
+
};
|
|
1015
1315
|
readonly largeImage: {
|
|
1016
1316
|
readonly type: "object";
|
|
1017
1317
|
readonly required: ["image"];
|
|
@@ -1047,26 +1347,32 @@ export declare const schemaDict: {
|
|
|
1047
1347
|
readonly to: {
|
|
1048
1348
|
readonly type: "string";
|
|
1049
1349
|
readonly description: "The recipient of the funds. Can be identified by DID or a clear-text name.";
|
|
1350
|
+
readonly maxLength: 2048;
|
|
1050
1351
|
};
|
|
1051
1352
|
readonly amount: {
|
|
1052
1353
|
readonly type: "string";
|
|
1053
|
-
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;
|
|
1054
1356
|
};
|
|
1055
1357
|
readonly currency: {
|
|
1056
1358
|
readonly type: "string";
|
|
1057
1359
|
readonly description: "Currency of the payment (e.g. EUR, USD, ETH).";
|
|
1360
|
+
readonly maxLength: 10;
|
|
1058
1361
|
};
|
|
1059
1362
|
readonly paymentRail: {
|
|
1060
1363
|
readonly type: "string";
|
|
1061
1364
|
readonly description: "How the funds were transferred (e.g. bank_transfer, credit_card, onchain, cash, check, payment_processor).";
|
|
1365
|
+
readonly maxLength: 50;
|
|
1062
1366
|
};
|
|
1063
1367
|
readonly paymentNetwork: {
|
|
1064
1368
|
readonly type: "string";
|
|
1065
1369
|
readonly description: "Optional network within the payment rail (e.g. arbitrum, ethereum, sepa, visa, paypal).";
|
|
1370
|
+
readonly maxLength: 50;
|
|
1066
1371
|
};
|
|
1067
1372
|
readonly transactionId: {
|
|
1068
1373
|
readonly type: "string";
|
|
1069
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;
|
|
1070
1376
|
};
|
|
1071
1377
|
readonly for: {
|
|
1072
1378
|
readonly type: "string";
|
|
@@ -1093,36 +1399,71 @@ export declare const schemaDict: {
|
|
|
1093
1399
|
};
|
|
1094
1400
|
};
|
|
1095
1401
|
};
|
|
1096
|
-
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: {
|
|
1097
1442
|
readonly lexicon: 1;
|
|
1098
|
-
readonly id: "org.hypercerts.
|
|
1443
|
+
readonly id: "org.hypercerts.workscope.tag";
|
|
1099
1444
|
readonly defs: {
|
|
1100
1445
|
readonly main: {
|
|
1101
1446
|
readonly type: "record";
|
|
1102
|
-
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.";
|
|
1103
1448
|
readonly key: "tid";
|
|
1104
1449
|
readonly record: {
|
|
1105
1450
|
readonly type: "object";
|
|
1106
|
-
readonly required: ["
|
|
1451
|
+
readonly required: ["key", "name", "createdAt"];
|
|
1107
1452
|
readonly properties: {
|
|
1108
|
-
readonly createdAt: {
|
|
1109
|
-
readonly type: "string";
|
|
1110
|
-
readonly format: "datetime";
|
|
1111
|
-
readonly description: "Client-declared timestamp when this record was originally created";
|
|
1112
|
-
};
|
|
1113
1453
|
readonly key: {
|
|
1114
1454
|
readonly type: "string";
|
|
1115
|
-
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.";
|
|
1116
1456
|
readonly maxLength: 120;
|
|
1117
1457
|
};
|
|
1118
|
-
readonly
|
|
1458
|
+
readonly name: {
|
|
1119
1459
|
readonly type: "string";
|
|
1120
|
-
readonly description: "Human-readable
|
|
1460
|
+
readonly description: "Human-readable name for this scope.";
|
|
1121
1461
|
readonly maxLength: 200;
|
|
1122
1462
|
};
|
|
1123
|
-
readonly
|
|
1463
|
+
readonly category: {
|
|
1124
1464
|
readonly type: "string";
|
|
1125
|
-
readonly description: "Category type of this scope.
|
|
1465
|
+
readonly description: "Category type of this scope.";
|
|
1466
|
+
readonly knownValues: ["topic", "language", "domain", "method"];
|
|
1126
1467
|
readonly maxLength: 50;
|
|
1127
1468
|
};
|
|
1128
1469
|
readonly description: {
|
|
@@ -1134,7 +1475,18 @@ export declare const schemaDict: {
|
|
|
1134
1475
|
readonly parent: {
|
|
1135
1476
|
readonly type: "ref";
|
|
1136
1477
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1137
|
-
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.";
|
|
1138
1490
|
};
|
|
1139
1491
|
readonly aliases: {
|
|
1140
1492
|
readonly type: "array";
|
|
@@ -1143,32 +1495,118 @@ export declare const schemaDict: {
|
|
|
1143
1495
|
readonly maxLength: 200;
|
|
1144
1496
|
};
|
|
1145
1497
|
readonly maxLength: 50;
|
|
1146
|
-
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.";
|
|
1147
1499
|
};
|
|
1148
|
-
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: {
|
|
1149
1511
|
readonly type: "union";
|
|
1150
1512
|
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
1151
|
-
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.";
|
|
1519
|
+
};
|
|
1520
|
+
};
|
|
1521
|
+
};
|
|
1522
|
+
};
|
|
1523
|
+
};
|
|
1524
|
+
};
|
|
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";
|
|
1152
1554
|
};
|
|
1153
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;
|
|
1154
1591
|
};
|
|
1155
1592
|
};
|
|
1156
1593
|
};
|
|
1157
1594
|
};
|
|
1158
|
-
}
|
|
1159
|
-
export declare const schemas: ({
|
|
1595
|
+
} | {
|
|
1160
1596
|
readonly lexicon: 1;
|
|
1161
1597
|
readonly id: "app.certified.actor.profile";
|
|
1162
1598
|
readonly defs: {
|
|
1163
1599
|
readonly main: {
|
|
1164
1600
|
readonly type: "record";
|
|
1165
|
-
readonly description: "A declaration of a
|
|
1601
|
+
readonly description: "A declaration of a Certified account profile.";
|
|
1166
1602
|
readonly key: "literal:self";
|
|
1167
1603
|
readonly record: {
|
|
1168
1604
|
readonly type: "object";
|
|
1605
|
+
readonly required: ["createdAt"];
|
|
1169
1606
|
readonly properties: {
|
|
1170
1607
|
readonly displayName: {
|
|
1171
1608
|
readonly type: "string";
|
|
1609
|
+
readonly description: "Display name for the account";
|
|
1172
1610
|
readonly maxGraphemes: 64;
|
|
1173
1611
|
readonly maxLength: 640;
|
|
1174
1612
|
};
|
|
@@ -1187,6 +1625,7 @@ export declare const schemas: ({
|
|
|
1187
1625
|
readonly website: {
|
|
1188
1626
|
readonly type: "string";
|
|
1189
1627
|
readonly format: "uri";
|
|
1628
|
+
readonly description: "Account website URL";
|
|
1190
1629
|
};
|
|
1191
1630
|
readonly avatar: {
|
|
1192
1631
|
readonly type: "union";
|
|
@@ -1201,6 +1640,7 @@ export declare const schemas: ({
|
|
|
1201
1640
|
readonly createdAt: {
|
|
1202
1641
|
readonly type: "string";
|
|
1203
1642
|
readonly format: "datetime";
|
|
1643
|
+
readonly description: "Client-declared timestamp when this record was originally created";
|
|
1204
1644
|
};
|
|
1205
1645
|
};
|
|
1206
1646
|
};
|
|
@@ -1231,6 +1671,13 @@ export declare const schemas: ({
|
|
|
1231
1671
|
readonly note: {
|
|
1232
1672
|
readonly type: "string";
|
|
1233
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;
|
|
1234
1681
|
};
|
|
1235
1682
|
readonly createdAt: {
|
|
1236
1683
|
readonly type: "string";
|
|
@@ -1256,10 +1703,12 @@ export declare const schemas: ({
|
|
|
1256
1703
|
readonly badgeType: {
|
|
1257
1704
|
readonly type: "string";
|
|
1258
1705
|
readonly description: "Category of the badge (e.g. endorsement, participation, affiliation).";
|
|
1706
|
+
readonly maxLength: 100;
|
|
1259
1707
|
};
|
|
1260
1708
|
readonly title: {
|
|
1261
1709
|
readonly type: "string";
|
|
1262
1710
|
readonly description: "Human-readable title of the badge.";
|
|
1711
|
+
readonly maxLength: 256;
|
|
1263
1712
|
};
|
|
1264
1713
|
readonly icon: {
|
|
1265
1714
|
readonly type: "blob";
|
|
@@ -1270,10 +1719,13 @@ export declare const schemas: ({
|
|
|
1270
1719
|
readonly description: {
|
|
1271
1720
|
readonly type: "string";
|
|
1272
1721
|
readonly description: "Optional short statement describing what the badge represents.";
|
|
1722
|
+
readonly maxLength: 5000;
|
|
1723
|
+
readonly maxGraphemes: 500;
|
|
1273
1724
|
};
|
|
1274
1725
|
readonly allowedIssuers: {
|
|
1275
1726
|
readonly type: "array";
|
|
1276
1727
|
readonly description: "Optional allowlist of DIDs allowed to issue this badge. If omitted, anyone may issue it.";
|
|
1728
|
+
readonly maxLength: 100;
|
|
1277
1729
|
readonly items: {
|
|
1278
1730
|
readonly type: "ref";
|
|
1279
1731
|
readonly ref: "lex:app.certified.defs#did";
|
|
@@ -1307,12 +1759,13 @@ export declare const schemas: ({
|
|
|
1307
1759
|
};
|
|
1308
1760
|
readonly response: {
|
|
1309
1761
|
readonly type: "string";
|
|
1310
|
-
readonly
|
|
1762
|
+
readonly knownValues: ["accepted", "rejected"];
|
|
1311
1763
|
readonly description: "The recipient’s response for the badge (accepted or rejected).";
|
|
1312
1764
|
};
|
|
1313
1765
|
readonly weight: {
|
|
1314
1766
|
readonly type: "string";
|
|
1315
1767
|
readonly description: "Optional relative weight for accepted badges, assigned by the recipient.";
|
|
1768
|
+
readonly maxLength: 50;
|
|
1316
1769
|
};
|
|
1317
1770
|
readonly createdAt: {
|
|
1318
1771
|
readonly type: "string";
|
|
@@ -1378,13 +1831,13 @@ export declare const schemas: ({
|
|
|
1378
1831
|
};
|
|
1379
1832
|
readonly name: {
|
|
1380
1833
|
readonly type: "string";
|
|
1381
|
-
readonly description: "
|
|
1834
|
+
readonly description: "Human-readable name for this location (e.g. 'Golden Gate Park', 'San Francisco Bay Area')";
|
|
1382
1835
|
readonly maxLength: 1000;
|
|
1383
1836
|
readonly maxGraphemes: 100;
|
|
1384
1837
|
};
|
|
1385
1838
|
readonly description: {
|
|
1386
1839
|
readonly type: "string";
|
|
1387
|
-
readonly description: "
|
|
1840
|
+
readonly description: "Additional context about this location, such as its significance to the work or specific boundaries";
|
|
1388
1841
|
readonly maxLength: 2000;
|
|
1389
1842
|
readonly maxGraphemes: 500;
|
|
1390
1843
|
};
|
|
@@ -1432,34 +1885,196 @@ export declare const schemas: ({
|
|
|
1432
1885
|
};
|
|
1433
1886
|
} | {
|
|
1434
1887
|
readonly lexicon: 1;
|
|
1435
|
-
readonly id: "org.
|
|
1888
|
+
readonly id: "org.hyperboards.board";
|
|
1436
1889
|
readonly defs: {
|
|
1437
1890
|
readonly main: {
|
|
1438
1891
|
readonly type: "record";
|
|
1439
|
-
readonly description: "
|
|
1892
|
+
readonly description: "Configuration record for a hyperboard, wrapping an underlying activity or collection with visual presentation settings. Stored in the creator's PDS.";
|
|
1440
1893
|
readonly key: "tid";
|
|
1441
1894
|
readonly record: {
|
|
1442
1895
|
readonly type: "object";
|
|
1443
|
-
readonly required: ["subject", "
|
|
1896
|
+
readonly required: ["subject", "createdAt"];
|
|
1444
1897
|
readonly properties: {
|
|
1445
1898
|
readonly subject: {
|
|
1446
1899
|
readonly type: "ref";
|
|
1447
1900
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1448
|
-
readonly description: "
|
|
1901
|
+
readonly description: "Reference to the org.hypercerts.claim.activity or org.hypercerts.claim.collection this board visualizes.";
|
|
1449
1902
|
};
|
|
1450
|
-
readonly
|
|
1903
|
+
readonly config: {
|
|
1451
1904
|
readonly type: "ref";
|
|
1452
|
-
readonly ref: "lex:
|
|
1453
|
-
readonly description: "
|
|
1905
|
+
readonly ref: "lex:org.hyperboards.board#boardConfig";
|
|
1906
|
+
readonly description: "Board-level visual configuration (background, colors, aspect ratio).";
|
|
1454
1907
|
};
|
|
1455
|
-
readonly
|
|
1456
|
-
readonly type: "
|
|
1457
|
-
readonly description: "
|
|
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
|
+
};
|
|
1458
1916
|
};
|
|
1459
|
-
readonly
|
|
1917
|
+
readonly createdAt: {
|
|
1460
1918
|
readonly type: "string";
|
|
1461
|
-
readonly
|
|
1462
|
-
readonly
|
|
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;
|
|
1463
2078
|
};
|
|
1464
2079
|
readonly createdAt: {
|
|
1465
2080
|
readonly type: "string";
|
|
@@ -1484,7 +2099,7 @@ export declare const schemas: ({
|
|
|
1484
2099
|
readonly properties: {
|
|
1485
2100
|
readonly title: {
|
|
1486
2101
|
readonly type: "string";
|
|
1487
|
-
readonly description: "
|
|
2102
|
+
readonly description: "Display title summarizing the impact work (e.g. 'Reforestation in Amazon Basin 2024')";
|
|
1488
2103
|
readonly maxLength: 256;
|
|
1489
2104
|
};
|
|
1490
2105
|
readonly shortDescription: {
|
|
@@ -1502,28 +2117,28 @@ export declare const schemas: ({
|
|
|
1502
2117
|
};
|
|
1503
2118
|
};
|
|
1504
2119
|
readonly description: {
|
|
1505
|
-
readonly type: "
|
|
1506
|
-
readonly
|
|
1507
|
-
readonly
|
|
1508
|
-
readonly maxGraphemes: 3000;
|
|
1509
|
-
};
|
|
1510
|
-
readonly descriptionFacets: {
|
|
1511
|
-
readonly type: "array";
|
|
1512
|
-
readonly description: "Rich text annotations for `description` (mentions, URLs, hashtags, etc).";
|
|
1513
|
-
readonly items: {
|
|
1514
|
-
readonly type: "ref";
|
|
1515
|
-
readonly ref: "lex:app.bsky.richtext.facet";
|
|
1516
|
-
};
|
|
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.";
|
|
1517
2123
|
};
|
|
1518
2124
|
readonly image: {
|
|
1519
2125
|
readonly type: "union";
|
|
1520
2126
|
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallImage"];
|
|
1521
2127
|
readonly description: "The hypercert visual representation as a URI or image blob.";
|
|
1522
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
|
+
};
|
|
1523
2138
|
readonly workScope: {
|
|
1524
2139
|
readonly type: "union";
|
|
1525
|
-
readonly refs: ["lex:
|
|
1526
|
-
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.";
|
|
1527
2142
|
};
|
|
1528
2143
|
readonly startDate: {
|
|
1529
2144
|
readonly type: "string";
|
|
@@ -1535,12 +2150,13 @@ export declare const schemas: ({
|
|
|
1535
2150
|
readonly format: "datetime";
|
|
1536
2151
|
readonly description: "When the work ended";
|
|
1537
2152
|
};
|
|
1538
|
-
readonly
|
|
2153
|
+
readonly locations: {
|
|
1539
2154
|
readonly type: "array";
|
|
1540
|
-
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;
|
|
1541
2157
|
readonly items: {
|
|
1542
2158
|
readonly type: "ref";
|
|
1543
|
-
readonly ref: "lex:
|
|
2159
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1544
2160
|
};
|
|
1545
2161
|
};
|
|
1546
2162
|
readonly rights: {
|
|
@@ -1548,14 +2164,6 @@ export declare const schemas: ({
|
|
|
1548
2164
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1549
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.";
|
|
1550
2166
|
};
|
|
1551
|
-
readonly locations: {
|
|
1552
|
-
readonly type: "array";
|
|
1553
|
-
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.";
|
|
1554
|
-
readonly items: {
|
|
1555
|
-
readonly type: "ref";
|
|
1556
|
-
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1557
|
-
};
|
|
1558
|
-
};
|
|
1559
2167
|
readonly createdAt: {
|
|
1560
2168
|
readonly type: "string";
|
|
1561
2169
|
readonly format: "datetime";
|
|
@@ -1571,16 +2179,17 @@ export declare const schemas: ({
|
|
|
1571
2179
|
readonly contributorIdentity: {
|
|
1572
2180
|
readonly type: "union";
|
|
1573
2181
|
readonly refs: ["lex:org.hypercerts.claim.activity#contributorIdentity", "lex:com.atproto.repo.strongRef"];
|
|
1574
|
-
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.";
|
|
1575
2183
|
};
|
|
1576
2184
|
readonly contributionWeight: {
|
|
1577
2185
|
readonly type: "string";
|
|
1578
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;
|
|
1579
2188
|
};
|
|
1580
2189
|
readonly contributionDetails: {
|
|
1581
2190
|
readonly type: "union";
|
|
1582
2191
|
readonly refs: ["lex:org.hypercerts.claim.activity#contributorRole", "lex:com.atproto.repo.strongRef"];
|
|
1583
|
-
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.";
|
|
1584
2193
|
};
|
|
1585
2194
|
};
|
|
1586
2195
|
};
|
|
@@ -1626,81 +2235,119 @@ export declare const schemas: ({
|
|
|
1626
2235
|
};
|
|
1627
2236
|
} | {
|
|
1628
2237
|
readonly lexicon: 1;
|
|
1629
|
-
readonly id: "org.hypercerts.claim.
|
|
2238
|
+
readonly id: "org.hypercerts.claim.contribution";
|
|
1630
2239
|
readonly defs: {
|
|
1631
2240
|
readonly main: {
|
|
1632
2241
|
readonly type: "record";
|
|
1633
|
-
readonly description: "
|
|
2242
|
+
readonly description: "Details about a specific contribution including role, description, and timeframe.";
|
|
1634
2243
|
readonly key: "tid";
|
|
1635
2244
|
readonly record: {
|
|
1636
2245
|
readonly type: "object";
|
|
1637
|
-
readonly required: ["
|
|
2246
|
+
readonly required: ["createdAt"];
|
|
1638
2247
|
readonly properties: {
|
|
1639
|
-
readonly
|
|
1640
|
-
readonly type: "
|
|
1641
|
-
readonly description: "
|
|
1642
|
-
readonly items: {
|
|
1643
|
-
readonly type: "ref";
|
|
1644
|
-
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1645
|
-
};
|
|
2248
|
+
readonly role: {
|
|
2249
|
+
readonly type: "string";
|
|
2250
|
+
readonly description: "Role or title of the contributor.";
|
|
1646
2251
|
readonly maxLength: 100;
|
|
1647
2252
|
};
|
|
1648
|
-
readonly
|
|
2253
|
+
readonly contributionDescription: {
|
|
1649
2254
|
readonly type: "string";
|
|
1650
|
-
readonly
|
|
1651
|
-
readonly
|
|
2255
|
+
readonly description: "Description of what the contribution concretely involved.";
|
|
2256
|
+
readonly maxLength: 10000;
|
|
2257
|
+
readonly maxGraphemes: 1000;
|
|
1652
2258
|
};
|
|
1653
|
-
readonly
|
|
1654
|
-
readonly type: "
|
|
1655
|
-
readonly
|
|
1656
|
-
readonly
|
|
1657
|
-
readonly type: "union";
|
|
1658
|
-
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
1659
|
-
};
|
|
1660
|
-
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.";
|
|
1661
2263
|
};
|
|
1662
|
-
readonly
|
|
2264
|
+
readonly endDate: {
|
|
1663
2265
|
readonly type: "string";
|
|
1664
|
-
readonly
|
|
1665
|
-
readonly description: "
|
|
2266
|
+
readonly format: "datetime";
|
|
2267
|
+
readonly description: "When this contribution finished. Should fall within the parent hypercert's timeframe.";
|
|
1666
2268
|
};
|
|
1667
|
-
readonly
|
|
2269
|
+
readonly createdAt: {
|
|
1668
2270
|
readonly type: "string";
|
|
1669
|
-
readonly
|
|
1670
|
-
readonly
|
|
1671
|
-
readonly maxGraphemes: 300;
|
|
2271
|
+
readonly format: "datetime";
|
|
2272
|
+
readonly description: "Client-declared timestamp when this record was originally created.";
|
|
1672
2273
|
};
|
|
1673
|
-
|
|
1674
|
-
|
|
1675
|
-
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
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;
|
|
1680
2330
|
};
|
|
1681
|
-
readonly
|
|
2331
|
+
readonly rightsType: {
|
|
1682
2332
|
readonly type: "string";
|
|
1683
|
-
readonly description: "
|
|
1684
|
-
readonly maxLength:
|
|
1685
|
-
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;
|
|
1686
2335
|
};
|
|
1687
|
-
readonly
|
|
1688
|
-
readonly type: "
|
|
1689
|
-
readonly description: "
|
|
1690
|
-
readonly
|
|
1691
|
-
|
|
1692
|
-
readonly ref: "lex:app.bsky.richtext.facet";
|
|
1693
|
-
};
|
|
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;
|
|
1694
2341
|
};
|
|
1695
|
-
readonly
|
|
1696
|
-
readonly type: "
|
|
1697
|
-
readonly
|
|
1698
|
-
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.";
|
|
1699
2346
|
};
|
|
1700
2347
|
readonly createdAt: {
|
|
1701
2348
|
readonly type: "string";
|
|
1702
2349
|
readonly format: "datetime";
|
|
1703
|
-
readonly description: "Client-declared timestamp when this record was originally created
|
|
2350
|
+
readonly description: "Client-declared timestamp when this record was originally created";
|
|
1704
2351
|
};
|
|
1705
2352
|
};
|
|
1706
2353
|
};
|
|
@@ -1708,7 +2355,7 @@ export declare const schemas: ({
|
|
|
1708
2355
|
};
|
|
1709
2356
|
} | {
|
|
1710
2357
|
readonly lexicon: 1;
|
|
1711
|
-
readonly id: "org.hypercerts.
|
|
2358
|
+
readonly id: "org.hypercerts.collection";
|
|
1712
2359
|
readonly defs: {
|
|
1713
2360
|
readonly main: {
|
|
1714
2361
|
readonly type: "record";
|
|
@@ -1716,15 +2363,16 @@ export declare const schemas: ({
|
|
|
1716
2363
|
readonly key: "tid";
|
|
1717
2364
|
readonly record: {
|
|
1718
2365
|
readonly type: "object";
|
|
1719
|
-
readonly required: ["title", "
|
|
2366
|
+
readonly required: ["title", "createdAt"];
|
|
1720
2367
|
readonly properties: {
|
|
1721
2368
|
readonly type: {
|
|
1722
2369
|
readonly type: "string";
|
|
1723
2370
|
readonly description: "The type of this collection. Possible fields can be 'favorites', 'project', or any other type of collection.";
|
|
2371
|
+
readonly maxLength: 64;
|
|
1724
2372
|
};
|
|
1725
2373
|
readonly title: {
|
|
1726
2374
|
readonly type: "string";
|
|
1727
|
-
readonly description: "
|
|
2375
|
+
readonly description: "Display name for this collection (e.g. 'Q1 2025 Impact Projects')";
|
|
1728
2376
|
readonly maxLength: 800;
|
|
1729
2377
|
readonly maxGraphemes: 80;
|
|
1730
2378
|
};
|
|
@@ -1752,9 +2400,10 @@ export declare const schemas: ({
|
|
|
1752
2400
|
readonly items: {
|
|
1753
2401
|
readonly type: "array";
|
|
1754
2402
|
readonly description: "Array of items in this collection with optional weights.";
|
|
2403
|
+
readonly maxLength: 1000;
|
|
1755
2404
|
readonly items: {
|
|
1756
2405
|
readonly type: "ref";
|
|
1757
|
-
readonly ref: "lex:org.hypercerts.
|
|
2406
|
+
readonly ref: "lex:org.hypercerts.collection#item";
|
|
1758
2407
|
};
|
|
1759
2408
|
};
|
|
1760
2409
|
readonly location: {
|
|
@@ -1777,47 +2426,47 @@ export declare const schemas: ({
|
|
|
1777
2426
|
readonly itemIdentifier: {
|
|
1778
2427
|
readonly type: "ref";
|
|
1779
2428
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1780
|
-
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).";
|
|
1781
2430
|
};
|
|
1782
2431
|
readonly itemWeight: {
|
|
1783
2432
|
readonly type: "string";
|
|
1784
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;
|
|
1785
2435
|
};
|
|
1786
2436
|
};
|
|
1787
2437
|
};
|
|
1788
2438
|
};
|
|
1789
2439
|
} | {
|
|
1790
2440
|
readonly lexicon: 1;
|
|
1791
|
-
readonly id: "org.hypercerts.
|
|
2441
|
+
readonly id: "org.hypercerts.context.acknowledgement";
|
|
1792
2442
|
readonly defs: {
|
|
1793
2443
|
readonly main: {
|
|
1794
2444
|
readonly type: "record";
|
|
1795
|
-
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.";
|
|
1796
2446
|
readonly key: "tid";
|
|
1797
2447
|
readonly record: {
|
|
1798
2448
|
readonly type: "object";
|
|
1799
|
-
readonly required: ["createdAt"];
|
|
2449
|
+
readonly required: ["subject", "acknowledged", "createdAt"];
|
|
1800
2450
|
readonly properties: {
|
|
1801
|
-
readonly
|
|
1802
|
-
readonly type: "
|
|
1803
|
-
readonly
|
|
1804
|
-
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).";
|
|
1805
2455
|
};
|
|
1806
|
-
readonly
|
|
1807
|
-
readonly type: "
|
|
1808
|
-
readonly
|
|
1809
|
-
readonly
|
|
1810
|
-
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.";
|
|
1811
2460
|
};
|
|
1812
|
-
readonly
|
|
1813
|
-
readonly type: "
|
|
1814
|
-
readonly
|
|
1815
|
-
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).";
|
|
1816
2464
|
};
|
|
1817
|
-
readonly
|
|
2465
|
+
readonly comment: {
|
|
1818
2466
|
readonly type: "string";
|
|
1819
|
-
readonly
|
|
1820
|
-
readonly
|
|
2467
|
+
readonly description: "Optional plain-text comment providing additional context or reasoning.";
|
|
2468
|
+
readonly maxLength: 10000;
|
|
2469
|
+
readonly maxGraphemes: 1000;
|
|
1821
2470
|
};
|
|
1822
2471
|
readonly createdAt: {
|
|
1823
2472
|
readonly type: "string";
|
|
@@ -1830,29 +2479,67 @@ export declare const schemas: ({
|
|
|
1830
2479
|
};
|
|
1831
2480
|
} | {
|
|
1832
2481
|
readonly lexicon: 1;
|
|
1833
|
-
readonly id: "org.hypercerts.
|
|
2482
|
+
readonly id: "org.hypercerts.context.attachment";
|
|
1834
2483
|
readonly defs: {
|
|
1835
2484
|
readonly main: {
|
|
1836
2485
|
readonly type: "record";
|
|
1837
|
-
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).";
|
|
1838
2487
|
readonly key: "tid";
|
|
1839
2488
|
readonly record: {
|
|
1840
2489
|
readonly type: "object";
|
|
1841
|
-
readonly required: ["createdAt"];
|
|
2490
|
+
readonly required: ["title", "createdAt"];
|
|
1842
2491
|
readonly properties: {
|
|
1843
|
-
readonly
|
|
1844
|
-
readonly type: "
|
|
1845
|
-
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;
|
|
1846
2500
|
};
|
|
1847
|
-
readonly
|
|
2501
|
+
readonly contentType: {
|
|
1848
2502
|
readonly type: "string";
|
|
1849
|
-
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
|
+
};
|
|
1850
2513
|
readonly maxLength: 100;
|
|
1851
2514
|
};
|
|
1852
|
-
readonly
|
|
1853
|
-
readonly type: "
|
|
1854
|
-
readonly
|
|
1855
|
-
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.";
|
|
1856
2543
|
};
|
|
1857
2544
|
readonly createdAt: {
|
|
1858
2545
|
readonly type: "string";
|
|
@@ -1865,27 +2552,8 @@ export declare const schemas: ({
|
|
|
1865
2552
|
};
|
|
1866
2553
|
} | {
|
|
1867
2554
|
readonly lexicon: 1;
|
|
1868
|
-
readonly id: "org.hypercerts.
|
|
2555
|
+
readonly id: "org.hypercerts.context.evaluation";
|
|
1869
2556
|
readonly defs: {
|
|
1870
|
-
readonly score: {
|
|
1871
|
-
readonly type: "object";
|
|
1872
|
-
readonly description: "Overall score for an evaluation on a numeric scale.";
|
|
1873
|
-
readonly required: ["min", "max", "value"];
|
|
1874
|
-
readonly properties: {
|
|
1875
|
-
readonly min: {
|
|
1876
|
-
readonly type: "integer";
|
|
1877
|
-
readonly description: "Minimum value of the scale, e.g. 0 or 1.";
|
|
1878
|
-
};
|
|
1879
|
-
readonly max: {
|
|
1880
|
-
readonly type: "integer";
|
|
1881
|
-
readonly description: "Maximum value of the scale, e.g. 5 or 10.";
|
|
1882
|
-
};
|
|
1883
|
-
readonly value: {
|
|
1884
|
-
readonly type: "integer";
|
|
1885
|
-
readonly description: "Score within the inclusive range [min, max].";
|
|
1886
|
-
};
|
|
1887
|
-
};
|
|
1888
|
-
};
|
|
1889
2557
|
readonly main: {
|
|
1890
2558
|
readonly type: "record";
|
|
1891
2559
|
readonly description: "An evaluation of a hypercert record (e.g. an activity and its impact).";
|
|
@@ -1897,7 +2565,7 @@ export declare const schemas: ({
|
|
|
1897
2565
|
readonly subject: {
|
|
1898
2566
|
readonly type: "ref";
|
|
1899
2567
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1900
|
-
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.)";
|
|
1901
2569
|
};
|
|
1902
2570
|
readonly evaluators: {
|
|
1903
2571
|
readonly type: "array";
|
|
@@ -1919,7 +2587,7 @@ export declare const schemas: ({
|
|
|
1919
2587
|
};
|
|
1920
2588
|
readonly measurements: {
|
|
1921
2589
|
readonly type: "array";
|
|
1922
|
-
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";
|
|
1923
2591
|
readonly items: {
|
|
1924
2592
|
readonly type: "ref";
|
|
1925
2593
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
@@ -1934,7 +2602,7 @@ export declare const schemas: ({
|
|
|
1934
2602
|
};
|
|
1935
2603
|
readonly score: {
|
|
1936
2604
|
readonly type: "ref";
|
|
1937
|
-
readonly ref: "lex:org.hypercerts.
|
|
2605
|
+
readonly ref: "lex:org.hypercerts.context.evaluation#score";
|
|
1938
2606
|
readonly description: "Optional overall score for this evaluation on a numeric scale.";
|
|
1939
2607
|
};
|
|
1940
2608
|
readonly location: {
|
|
@@ -1950,23 +2618,46 @@ export declare const schemas: ({
|
|
|
1950
2618
|
};
|
|
1951
2619
|
};
|
|
1952
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
|
+
};
|
|
1953
2640
|
};
|
|
1954
2641
|
} | {
|
|
1955
2642
|
readonly lexicon: 1;
|
|
1956
|
-
readonly id: "org.hypercerts.
|
|
2643
|
+
readonly id: "org.hypercerts.context.measurement";
|
|
1957
2644
|
readonly defs: {
|
|
1958
2645
|
readonly main: {
|
|
1959
2646
|
readonly type: "record";
|
|
1960
|
-
readonly description: "Measurement data related to
|
|
2647
|
+
readonly description: "Measurement data related to one or more records (e.g. activities, projects, etc.).";
|
|
1961
2648
|
readonly key: "tid";
|
|
1962
2649
|
readonly record: {
|
|
1963
2650
|
readonly type: "object";
|
|
1964
2651
|
readonly required: ["metric", "unit", "value", "createdAt"];
|
|
1965
2652
|
readonly properties: {
|
|
1966
|
-
readonly
|
|
1967
|
-
readonly type: "
|
|
1968
|
-
readonly
|
|
1969
|
-
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;
|
|
1970
2661
|
};
|
|
1971
2662
|
readonly metric: {
|
|
1972
2663
|
readonly type: "string";
|
|
@@ -1980,7 +2671,7 @@ export declare const schemas: ({
|
|
|
1980
2671
|
};
|
|
1981
2672
|
readonly value: {
|
|
1982
2673
|
readonly type: "string";
|
|
1983
|
-
readonly description: "The measured numeric
|
|
2674
|
+
readonly description: "The measured value as a numeric string (e.g. '1234.56')";
|
|
1984
2675
|
readonly maxLength: 500;
|
|
1985
2676
|
};
|
|
1986
2677
|
readonly startDate: {
|
|
@@ -1991,7 +2682,7 @@ export declare const schemas: ({
|
|
|
1991
2682
|
readonly endDate: {
|
|
1992
2683
|
readonly type: "string";
|
|
1993
2684
|
readonly format: "datetime";
|
|
1994
|
-
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.";
|
|
1995
2686
|
};
|
|
1996
2687
|
readonly locations: {
|
|
1997
2688
|
readonly type: "array";
|
|
@@ -2023,7 +2714,7 @@ export declare const schemas: ({
|
|
|
2023
2714
|
};
|
|
2024
2715
|
readonly measurers: {
|
|
2025
2716
|
readonly type: "array";
|
|
2026
|
-
readonly description: "DIDs of the
|
|
2717
|
+
readonly description: "DIDs of the entities that performed this measurement";
|
|
2027
2718
|
readonly items: {
|
|
2028
2719
|
readonly type: "ref";
|
|
2029
2720
|
readonly ref: "lex:app.certified.defs#did";
|
|
@@ -2053,49 +2744,10 @@ export declare const schemas: ({
|
|
|
2053
2744
|
};
|
|
2054
2745
|
};
|
|
2055
2746
|
};
|
|
2056
|
-
} | {
|
|
2057
|
-
readonly lexicon: 1;
|
|
2058
|
-
readonly id: "org.hypercerts.claim.rights";
|
|
2059
|
-
readonly defs: {
|
|
2060
|
-
readonly main: {
|
|
2061
|
-
readonly type: "record";
|
|
2062
|
-
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.";
|
|
2063
|
-
readonly key: "tid";
|
|
2064
|
-
readonly record: {
|
|
2065
|
-
readonly type: "object";
|
|
2066
|
-
readonly required: ["rightsName", "rightsType", "rightsDescription", "createdAt"];
|
|
2067
|
-
readonly properties: {
|
|
2068
|
-
readonly rightsName: {
|
|
2069
|
-
readonly type: "string";
|
|
2070
|
-
readonly description: "Full name of the rights";
|
|
2071
|
-
readonly maxLength: 100;
|
|
2072
|
-
};
|
|
2073
|
-
readonly rightsType: {
|
|
2074
|
-
readonly type: "string";
|
|
2075
|
-
readonly description: "Short rights identifier for easier search";
|
|
2076
|
-
readonly maxLength: 10;
|
|
2077
|
-
};
|
|
2078
|
-
readonly rightsDescription: {
|
|
2079
|
-
readonly type: "string";
|
|
2080
|
-
readonly description: "Description of the rights of this hypercert";
|
|
2081
|
-
};
|
|
2082
|
-
readonly attachment: {
|
|
2083
|
-
readonly type: "union";
|
|
2084
|
-
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
2085
|
-
readonly description: "An attachment to define the rights further, e.g. a legal document.";
|
|
2086
|
-
};
|
|
2087
|
-
readonly createdAt: {
|
|
2088
|
-
readonly type: "string";
|
|
2089
|
-
readonly format: "datetime";
|
|
2090
|
-
readonly description: "Client-declared timestamp when this record was originally created";
|
|
2091
|
-
};
|
|
2092
|
-
};
|
|
2093
|
-
};
|
|
2094
|
-
};
|
|
2095
|
-
};
|
|
2096
2747
|
} | {
|
|
2097
2748
|
readonly lexicon: 1;
|
|
2098
2749
|
readonly id: "org.hypercerts.defs";
|
|
2750
|
+
readonly description: "Common type definitions used across all Hypercerts protocols.";
|
|
2099
2751
|
readonly defs: {
|
|
2100
2752
|
readonly uri: {
|
|
2101
2753
|
readonly type: "object";
|
|
@@ -2105,7 +2757,6 @@ export declare const schemas: ({
|
|
|
2105
2757
|
readonly uri: {
|
|
2106
2758
|
readonly type: "string";
|
|
2107
2759
|
readonly format: "uri";
|
|
2108
|
-
readonly maxGraphemes: 1024;
|
|
2109
2760
|
readonly description: "URI to external data";
|
|
2110
2761
|
};
|
|
2111
2762
|
};
|
|
@@ -2149,6 +2800,19 @@ export declare const schemas: ({
|
|
|
2149
2800
|
};
|
|
2150
2801
|
};
|
|
2151
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
|
+
};
|
|
2152
2816
|
readonly largeImage: {
|
|
2153
2817
|
readonly type: "object";
|
|
2154
2818
|
readonly required: ["image"];
|
|
@@ -2183,26 +2847,32 @@ export declare const schemas: ({
|
|
|
2183
2847
|
readonly to: {
|
|
2184
2848
|
readonly type: "string";
|
|
2185
2849
|
readonly description: "The recipient of the funds. Can be identified by DID or a clear-text name.";
|
|
2850
|
+
readonly maxLength: 2048;
|
|
2186
2851
|
};
|
|
2187
2852
|
readonly amount: {
|
|
2188
2853
|
readonly type: "string";
|
|
2189
|
-
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;
|
|
2190
2856
|
};
|
|
2191
2857
|
readonly currency: {
|
|
2192
2858
|
readonly type: "string";
|
|
2193
2859
|
readonly description: "Currency of the payment (e.g. EUR, USD, ETH).";
|
|
2860
|
+
readonly maxLength: 10;
|
|
2194
2861
|
};
|
|
2195
2862
|
readonly paymentRail: {
|
|
2196
2863
|
readonly type: "string";
|
|
2197
2864
|
readonly description: "How the funds were transferred (e.g. bank_transfer, credit_card, onchain, cash, check, payment_processor).";
|
|
2865
|
+
readonly maxLength: 50;
|
|
2198
2866
|
};
|
|
2199
2867
|
readonly paymentNetwork: {
|
|
2200
2868
|
readonly type: "string";
|
|
2201
2869
|
readonly description: "Optional network within the payment rail (e.g. arbitrum, ethereum, sepa, visa, paypal).";
|
|
2870
|
+
readonly maxLength: 50;
|
|
2202
2871
|
};
|
|
2203
2872
|
readonly transactionId: {
|
|
2204
2873
|
readonly type: "string";
|
|
2205
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;
|
|
2206
2876
|
};
|
|
2207
2877
|
readonly for: {
|
|
2208
2878
|
readonly type: "string";
|
|
@@ -2230,34 +2900,68 @@ export declare const schemas: ({
|
|
|
2230
2900
|
};
|
|
2231
2901
|
} | {
|
|
2232
2902
|
readonly lexicon: 1;
|
|
2233
|
-
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";
|
|
2234
2942
|
readonly defs: {
|
|
2235
2943
|
readonly main: {
|
|
2236
2944
|
readonly type: "record";
|
|
2237
|
-
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.";
|
|
2238
2946
|
readonly key: "tid";
|
|
2239
2947
|
readonly record: {
|
|
2240
2948
|
readonly type: "object";
|
|
2241
|
-
readonly required: ["
|
|
2949
|
+
readonly required: ["key", "name", "createdAt"];
|
|
2242
2950
|
readonly properties: {
|
|
2243
|
-
readonly createdAt: {
|
|
2244
|
-
readonly type: "string";
|
|
2245
|
-
readonly format: "datetime";
|
|
2246
|
-
readonly description: "Client-declared timestamp when this record was originally created";
|
|
2247
|
-
};
|
|
2248
2951
|
readonly key: {
|
|
2249
2952
|
readonly type: "string";
|
|
2250
|
-
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.";
|
|
2251
2954
|
readonly maxLength: 120;
|
|
2252
2955
|
};
|
|
2253
|
-
readonly
|
|
2956
|
+
readonly name: {
|
|
2254
2957
|
readonly type: "string";
|
|
2255
|
-
readonly description: "Human-readable
|
|
2958
|
+
readonly description: "Human-readable name for this scope.";
|
|
2256
2959
|
readonly maxLength: 200;
|
|
2257
2960
|
};
|
|
2258
|
-
readonly
|
|
2961
|
+
readonly category: {
|
|
2259
2962
|
readonly type: "string";
|
|
2260
|
-
readonly description: "Category type of this scope.
|
|
2963
|
+
readonly description: "Category type of this scope.";
|
|
2964
|
+
readonly knownValues: ["topic", "language", "domain", "method"];
|
|
2261
2965
|
readonly maxLength: 50;
|
|
2262
2966
|
};
|
|
2263
2967
|
readonly description: {
|
|
@@ -2269,7 +2973,18 @@ export declare const schemas: ({
|
|
|
2269
2973
|
readonly parent: {
|
|
2270
2974
|
readonly type: "ref";
|
|
2271
2975
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
2272
|
-
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.";
|
|
2273
2988
|
};
|
|
2274
2989
|
readonly aliases: {
|
|
2275
2990
|
readonly type: "array";
|
|
@@ -2278,12 +2993,27 @@ export declare const schemas: ({
|
|
|
2278
2993
|
readonly maxLength: 200;
|
|
2279
2994
|
};
|
|
2280
2995
|
readonly maxLength: 50;
|
|
2281
|
-
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.";
|
|
2282
3007
|
};
|
|
2283
|
-
readonly
|
|
3008
|
+
readonly referenceDocument: {
|
|
2284
3009
|
readonly type: "union";
|
|
2285
3010
|
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
2286
|
-
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.";
|
|
2287
3017
|
};
|
|
2288
3018
|
};
|
|
2289
3019
|
};
|
|
@@ -2298,6 +3028,7 @@ export declare function validate<T extends {
|
|
|
2298
3028
|
$type?: string;
|
|
2299
3029
|
}>(v: unknown, id: string, hash: string, requiredType?: false): ValidationResult<T>;
|
|
2300
3030
|
export declare const ids: {
|
|
3031
|
+
readonly AppCertifiedActorOrganization: "app.certified.actor.organization";
|
|
2301
3032
|
readonly AppCertifiedActorProfile: "app.certified.actor.profile";
|
|
2302
3033
|
readonly AppCertifiedBadgeAward: "app.certified.badge.award";
|
|
2303
3034
|
readonly AppCertifiedBadgeDefinition: "app.certified.badge.definition";
|
|
@@ -2305,17 +3036,20 @@ export declare const ids: {
|
|
|
2305
3036
|
readonly AppCertifiedDefs: "app.certified.defs";
|
|
2306
3037
|
readonly AppCertifiedLocation: "app.certified.location";
|
|
2307
3038
|
readonly ComAtprotoRepoStrongRef: "com.atproto.repo.strongRef";
|
|
2308
|
-
readonly
|
|
3039
|
+
readonly OrgHyperboardsBoard: "org.hyperboards.board";
|
|
3040
|
+
readonly OrgHyperboardsDisplayProfile: "org.hyperboards.displayProfile";
|
|
2309
3041
|
readonly OrgHypercertsClaimActivity: "org.hypercerts.claim.activity";
|
|
2310
|
-
readonly
|
|
2311
|
-
readonly OrgHypercertsClaimCollection: "org.hypercerts.claim.collection";
|
|
2312
|
-
readonly OrgHypercertsClaimContributionDetails: "org.hypercerts.claim.contributionDetails";
|
|
3042
|
+
readonly OrgHypercertsClaimContribution: "org.hypercerts.claim.contribution";
|
|
2313
3043
|
readonly OrgHypercertsClaimContributorInformation: "org.hypercerts.claim.contributorInformation";
|
|
2314
|
-
readonly OrgHypercertsClaimEvaluation: "org.hypercerts.claim.evaluation";
|
|
2315
|
-
readonly OrgHypercertsClaimMeasurement: "org.hypercerts.claim.measurement";
|
|
2316
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";
|
|
2317
3050
|
readonly OrgHypercertsDefs: "org.hypercerts.defs";
|
|
2318
3051
|
readonly OrgHypercertsFundingReceipt: "org.hypercerts.funding.receipt";
|
|
2319
|
-
readonly
|
|
3052
|
+
readonly OrgHypercertsWorkscopeCel: "org.hypercerts.workscope.cel";
|
|
3053
|
+
readonly OrgHypercertsWorkscopeTag: "org.hypercerts.workscope.tag";
|
|
2320
3054
|
};
|
|
2321
3055
|
//# sourceMappingURL=lexicons.d.ts.map
|