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