@hypercerts-org/lexicon 0.10.0-beta.12 → 0.10.0-beta.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/CHANGELOG.md +136 -0
  2. package/README.md +142 -0
  3. package/SCHEMAS.md +220 -67
  4. package/dist/exports.d.ts +195 -66
  5. package/dist/exports.d.ts.map +1 -1
  6. package/dist/generated/exports.d.ts +195 -66
  7. package/dist/generated/exports.d.ts.map +1 -1
  8. package/dist/generated/lexicons.d.ts +378 -130
  9. package/dist/generated/lexicons.d.ts.map +1 -1
  10. package/dist/generated/types/app/certified/actor/profile.d.ts +27 -0
  11. package/dist/generated/types/app/certified/actor/profile.d.ts.map +1 -0
  12. package/dist/generated/types/app/certified/defs.d.ts +11 -1
  13. package/dist/generated/types/app/certified/defs.d.ts.map +1 -1
  14. package/dist/generated/types/app/certified/location.d.ts +9 -1
  15. package/dist/generated/types/app/certified/location.d.ts.map +1 -1
  16. package/dist/generated/types/org/hypercerts/claim/activity.d.ts +21 -3
  17. package/dist/generated/types/org/hypercerts/claim/activity.d.ts.map +1 -1
  18. package/dist/generated/types/org/hypercerts/claim/attachment.d.ts +37 -0
  19. package/dist/generated/types/org/hypercerts/claim/attachment.d.ts.map +1 -0
  20. package/dist/index.cjs +618 -270
  21. package/dist/index.cjs.map +1 -1
  22. package/dist/index.mjs +606 -262
  23. package/dist/index.mjs.map +1 -1
  24. package/dist/lexicons.cjs +200 -68
  25. package/dist/lexicons.cjs.map +1 -1
  26. package/dist/lexicons.d.ts +378 -130
  27. package/dist/lexicons.d.ts.map +1 -1
  28. package/dist/lexicons.mjs +200 -68
  29. package/dist/lexicons.mjs.map +1 -1
  30. package/dist/types/app/certified/actor/profile.d.ts +27 -0
  31. package/dist/types/app/certified/actor/profile.d.ts.map +1 -0
  32. package/dist/types/app/certified/defs.d.ts +11 -1
  33. package/dist/types/app/certified/defs.d.ts.map +1 -1
  34. package/dist/types/app/certified/location.d.ts +9 -1
  35. package/dist/types/app/certified/location.d.ts.map +1 -1
  36. package/dist/types/org/hypercerts/claim/activity.d.ts +21 -3
  37. package/dist/types/org/hypercerts/claim/activity.d.ts.map +1 -1
  38. package/dist/types/org/hypercerts/claim/attachment.d.ts +37 -0
  39. package/dist/types/org/hypercerts/claim/attachment.d.ts.map +1 -0
  40. package/lexicons/app/certified/actor/profile.json +51 -0
  41. package/lexicons/app/certified/defs.json +11 -3
  42. package/lexicons/app/certified/location.json +16 -2
  43. package/lexicons/org/hypercerts/claim/activity.json +31 -8
  44. package/lexicons/org/hypercerts/claim/attachment.json +86 -0
  45. package/package.json +1 -1
  46. package/dist/generated/types/org/hypercerts/claim/evidence.d.ts +0 -29
  47. package/dist/generated/types/org/hypercerts/claim/evidence.d.ts.map +0 -1
  48. package/dist/types/org/hypercerts/claim/evidence.d.ts +0 -29
  49. package/dist/types/org/hypercerts/claim/evidence.d.ts.map +0 -1
  50. package/lexicons/org/hypercerts/claim/evidence.json +0 -57
package/dist/lexicons.mjs CHANGED
@@ -28,6 +28,63 @@ function maybe$typed(v, id, hash) {
28
28
  * GENERATED CODE - DO NOT MODIFY
29
29
  */
30
30
  const schemaDict = {
31
+ AppCertifiedActorProfile: {
32
+ lexicon: 1,
33
+ id: 'app.certified.actor.profile',
34
+ defs: {
35
+ main: {
36
+ type: 'record',
37
+ description: 'A declaration of a Hypercert account profile.',
38
+ key: 'literal:self',
39
+ record: {
40
+ type: 'object',
41
+ properties: {
42
+ displayName: {
43
+ type: 'string',
44
+ maxGraphemes: 64,
45
+ maxLength: 640,
46
+ },
47
+ description: {
48
+ type: 'string',
49
+ description: 'Free-form profile description text.',
50
+ maxGraphemes: 256,
51
+ maxLength: 2560,
52
+ },
53
+ pronouns: {
54
+ type: 'string',
55
+ description: 'Free-form pronouns text.',
56
+ maxGraphemes: 20,
57
+ maxLength: 200,
58
+ },
59
+ website: {
60
+ type: 'string',
61
+ format: 'uri',
62
+ },
63
+ avatar: {
64
+ type: 'union',
65
+ refs: [
66
+ 'lex:org.hypercerts.defs#uri',
67
+ 'lex:org.hypercerts.defs#smallImage',
68
+ ],
69
+ description: "Small image to be displayed next to posts from account. AKA, 'profile picture'",
70
+ },
71
+ banner: {
72
+ type: 'union',
73
+ refs: [
74
+ 'lex:org.hypercerts.defs#uri',
75
+ 'lex:org.hypercerts.defs#largeImage',
76
+ ],
77
+ description: 'Larger horizontal image to display behind profile view.',
78
+ },
79
+ createdAt: {
80
+ type: 'string',
81
+ format: 'datetime',
82
+ },
83
+ },
84
+ },
85
+ },
86
+ },
87
+ },
31
88
  AppCertifiedBadgeAward: {
32
89
  lexicon: 1,
33
90
  id: 'app.certified.badge.award',
@@ -162,9 +219,17 @@ const schemaDict = {
162
219
  description: 'Common type definitions used across certified protocols.',
163
220
  defs: {
164
221
  did: {
165
- type: 'string',
166
- format: 'did',
222
+ type: 'object',
167
223
  description: 'A Decentralized Identifier (DID) string.',
224
+ required: ['did'],
225
+ properties: {
226
+ did: {
227
+ type: 'string',
228
+ format: 'did',
229
+ description: 'The DID string value.',
230
+ maxLength: 256,
231
+ },
232
+ },
168
233
  },
169
234
  },
170
235
  },
@@ -208,8 +273,9 @@ const schemaDict = {
208
273
  refs: [
209
274
  'lex:org.hypercerts.defs#uri',
210
275
  'lex:org.hypercerts.defs#smallBlob',
276
+ 'lex:app.certified.location#string',
211
277
  ],
212
- description: 'The location of where the work was performed as a URI or blob.',
278
+ description: 'The location of where the work was performed as a URI, blob, or inline string.',
213
279
  },
214
280
  name: {
215
281
  type: 'string',
@@ -231,6 +297,19 @@ const schemaDict = {
231
297
  },
232
298
  },
233
299
  },
300
+ string: {
301
+ type: 'object',
302
+ required: ['string'],
303
+ description: 'A location represented as a string, e.g. coordinates or a small GeoJSON string.',
304
+ properties: {
305
+ string: {
306
+ type: 'string',
307
+ description: 'The location string value',
308
+ maxLength: 10000,
309
+ maxGraphemes: 1000,
310
+ },
311
+ },
312
+ },
234
313
  },
235
314
  },
236
315
  ComAtprotoRepoStrongRef: {
@@ -381,20 +460,129 @@ const schemaDict = {
381
460
  },
382
461
  },
383
462
  contributorIdentity: {
384
- type: 'string',
463
+ type: 'object',
385
464
  description: 'Contributor information as a string (DID or identifier).',
465
+ required: ['identity'],
466
+ properties: {
467
+ identity: {
468
+ type: 'string',
469
+ description: 'The contributor identity string (DID or identifier).',
470
+ maxLength: 1000,
471
+ maxGraphemes: 100,
472
+ },
473
+ },
386
474
  },
387
475
  contributorRole: {
388
- type: 'string',
476
+ type: 'object',
389
477
  description: 'Contribution details as a string.',
390
- maxLength: 10000,
391
- maxGraphemes: 1000,
478
+ required: ['role'],
479
+ properties: {
480
+ role: {
481
+ type: 'string',
482
+ description: 'The contribution role or details.',
483
+ maxLength: 1000,
484
+ maxGraphemes: 100,
485
+ },
486
+ },
392
487
  },
393
488
  workScopeString: {
394
- type: 'string',
489
+ type: 'object',
395
490
  description: 'A free-form string describing the work scope for simple or legacy scopes.',
396
- maxLength: 10000,
397
- maxGraphemes: 1000,
491
+ required: ['scope'],
492
+ properties: {
493
+ scope: {
494
+ type: 'string',
495
+ description: 'The work scope description string.',
496
+ maxLength: 1000,
497
+ maxGraphemes: 100,
498
+ },
499
+ },
500
+ },
501
+ },
502
+ },
503
+ OrgHypercertsClaimAttachment: {
504
+ lexicon: 1,
505
+ id: 'org.hypercerts.claim.attachment',
506
+ defs: {
507
+ main: {
508
+ type: 'record',
509
+ description: 'An attachment providing commentary, context, evidence, or documentary material related to a hypercert record (e.g. an activity, project, claim, or evaluation).',
510
+ key: 'tid',
511
+ record: {
512
+ type: 'object',
513
+ required: ['title', 'content', 'createdAt'],
514
+ properties: {
515
+ subjects: {
516
+ type: 'array',
517
+ 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.',
518
+ items: {
519
+ type: 'ref',
520
+ ref: 'lex:com.atproto.repo.strongRef',
521
+ },
522
+ maxLength: 100,
523
+ },
524
+ contentType: {
525
+ type: 'string',
526
+ maxLength: 64,
527
+ description: 'The type of attachment, e.g. report, audit, evidence, testimonial, methodology, etc.',
528
+ },
529
+ content: {
530
+ type: 'array',
531
+ description: 'The files, documents, or external references included in this attachment record.',
532
+ items: {
533
+ type: 'union',
534
+ refs: [
535
+ 'lex:org.hypercerts.defs#uri',
536
+ 'lex:org.hypercerts.defs#smallBlob',
537
+ ],
538
+ },
539
+ maxLength: 100,
540
+ },
541
+ title: {
542
+ type: 'string',
543
+ maxLength: 256,
544
+ description: 'Title of this attachment.',
545
+ },
546
+ shortDescription: {
547
+ type: 'string',
548
+ description: 'Short summary of this attachment, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.',
549
+ maxLength: 3000,
550
+ maxGraphemes: 300,
551
+ },
552
+ shortDescriptionFacets: {
553
+ type: 'array',
554
+ description: 'Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc).',
555
+ items: {
556
+ type: 'ref',
557
+ ref: 'lex:app.bsky.richtext.facet',
558
+ },
559
+ },
560
+ description: {
561
+ type: 'string',
562
+ description: 'Optional longer description of this attachment, including context or interpretation. Rich text annotations may be provided via `descriptionFacets`.',
563
+ maxLength: 30000,
564
+ maxGraphemes: 3000,
565
+ },
566
+ descriptionFacets: {
567
+ type: 'array',
568
+ description: 'Rich text annotations for `description` (mentions, URLs, hashtags, etc).',
569
+ items: {
570
+ type: 'ref',
571
+ ref: 'lex:app.bsky.richtext.facet',
572
+ },
573
+ },
574
+ location: {
575
+ type: 'ref',
576
+ ref: 'lex:com.atproto.repo.strongRef',
577
+ 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.",
578
+ },
579
+ createdAt: {
580
+ type: 'string',
581
+ format: 'datetime',
582
+ description: 'Client-declared timestamp when this record was originally created.',
583
+ },
584
+ },
585
+ },
398
586
  },
399
587
  },
400
588
  },
@@ -659,63 +847,6 @@ const schemaDict = {
659
847
  },
660
848
  },
661
849
  },
662
- OrgHypercertsClaimEvidence: {
663
- lexicon: 1,
664
- id: 'org.hypercerts.claim.evidence',
665
- defs: {
666
- main: {
667
- type: 'record',
668
- description: 'A piece of evidence related to a hypercert record (e.g. an activity, project, claim, or evaluation). Evidence may support, clarify, or challenge the referenced subject.',
669
- key: 'tid',
670
- record: {
671
- type: 'object',
672
- required: ['content', 'title', 'createdAt'],
673
- properties: {
674
- subject: {
675
- type: 'ref',
676
- ref: 'lex:com.atproto.repo.strongRef',
677
- description: 'A strong reference to the record this evidence relates to (e.g. an activity, project, claim, or evaluation).',
678
- },
679
- content: {
680
- type: 'union',
681
- refs: [
682
- 'lex:org.hypercerts.defs#uri',
683
- 'lex:org.hypercerts.defs#smallBlob',
684
- ],
685
- description: 'A piece of evidence (URI or blob) related to the subject record; it may support, clarify, or challenge a hypercert claim.',
686
- },
687
- title: {
688
- type: 'string',
689
- maxLength: 256,
690
- description: 'Title to describe the nature of the evidence.',
691
- },
692
- shortDescription: {
693
- type: 'string',
694
- maxLength: 3000,
695
- maxGraphemes: 300,
696
- description: 'Short description explaining what this evidence shows.',
697
- },
698
- description: {
699
- type: 'string',
700
- description: 'Longer description describing the evidence in more detail.',
701
- maxLength: 30000,
702
- maxGraphemes: 3000,
703
- },
704
- relationType: {
705
- type: 'string',
706
- description: 'How this evidence relates to the subject.',
707
- knownValues: ['supports', 'challenges', 'clarifies'],
708
- },
709
- createdAt: {
710
- type: 'string',
711
- format: 'datetime',
712
- description: 'Client-declared timestamp when this record was originally created',
713
- },
714
- },
715
- },
716
- },
717
- },
718
- },
719
850
  OrgHypercertsClaimMeasurement: {
720
851
  lexicon: 1,
721
852
  id: 'org.hypercerts.claim.measurement',
@@ -1082,6 +1213,7 @@ function validate(v, id, hash, requiredType) {
1082
1213
  };
1083
1214
  }
1084
1215
  const ids = {
1216
+ AppCertifiedActorProfile: 'app.certified.actor.profile',
1085
1217
  AppCertifiedBadgeAward: 'app.certified.badge.award',
1086
1218
  AppCertifiedBadgeDefinition: 'app.certified.badge.definition',
1087
1219
  AppCertifiedBadgeResponse: 'app.certified.badge.response',
@@ -1089,11 +1221,11 @@ const ids = {
1089
1221
  AppCertifiedLocation: 'app.certified.location',
1090
1222
  ComAtprotoRepoStrongRef: 'com.atproto.repo.strongRef',
1091
1223
  OrgHypercertsClaimActivity: 'org.hypercerts.claim.activity',
1224
+ OrgHypercertsClaimAttachment: 'org.hypercerts.claim.attachment',
1092
1225
  OrgHypercertsClaimCollection: 'org.hypercerts.claim.collection',
1093
1226
  OrgHypercertsClaimContributionDetails: 'org.hypercerts.claim.contributionDetails',
1094
1227
  OrgHypercertsClaimContributorInformation: 'org.hypercerts.claim.contributorInformation',
1095
1228
  OrgHypercertsClaimEvaluation: 'org.hypercerts.claim.evaluation',
1096
- OrgHypercertsClaimEvidence: 'org.hypercerts.claim.evidence',
1097
1229
  OrgHypercertsClaimMeasurement: 'org.hypercerts.claim.measurement',
1098
1230
  OrgHypercertsClaimRights: 'org.hypercerts.claim.rights',
1099
1231
  OrgHypercertsDefs: 'org.hypercerts.defs',