@hypercerts-org/lexicon 0.10.0-beta.11 → 0.10.0-beta.13
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 +166 -0
- package/README.md +145 -1
- package/SCHEMAS.md +202 -94
- package/dist/exports.d.ts +138 -130
- package/dist/exports.d.ts.map +1 -1
- package/dist/generated/exports.d.ts +138 -130
- package/dist/generated/exports.d.ts.map +1 -1
- package/dist/generated/lexicons.d.ts +299 -283
- package/dist/generated/lexicons.d.ts.map +1 -1
- package/dist/generated/types/app/certified/location.d.ts +9 -1
- package/dist/generated/types/app/certified/location.d.ts.map +1 -1
- package/dist/generated/types/org/hypercerts/claim/activity.d.ts +3 -1
- package/dist/generated/types/org/hypercerts/claim/activity.d.ts.map +1 -1
- package/dist/generated/types/org/hypercerts/claim/attachment.d.ts +37 -0
- package/dist/generated/types/org/hypercerts/claim/attachment.d.ts.map +1 -0
- package/dist/generated/types/org/hypercerts/claim/measurement.d.ts +17 -5
- package/dist/generated/types/org/hypercerts/claim/measurement.d.ts.map +1 -1
- package/dist/generated/types/org/hypercerts/defs.d.ts +0 -44
- package/dist/generated/types/org/hypercerts/defs.d.ts.map +1 -1
- package/dist/index.cjs +409 -465
- package/dist/index.cjs.map +1 -1
- package/dist/index.mjs +406 -462
- package/dist/index.mjs.map +1 -1
- package/dist/lexicons.cjs +155 -163
- package/dist/lexicons.cjs.map +1 -1
- package/dist/lexicons.d.ts +299 -283
- package/dist/lexicons.d.ts.map +1 -1
- package/dist/lexicons.mjs +155 -163
- package/dist/lexicons.mjs.map +1 -1
- package/dist/types/app/certified/location.d.ts +9 -1
- package/dist/types/app/certified/location.d.ts.map +1 -1
- package/dist/types/org/hypercerts/claim/activity.d.ts +3 -1
- package/dist/types/org/hypercerts/claim/activity.d.ts.map +1 -1
- package/dist/types/org/hypercerts/claim/attachment.d.ts +37 -0
- package/dist/types/org/hypercerts/claim/attachment.d.ts.map +1 -0
- package/dist/types/org/hypercerts/claim/measurement.d.ts +17 -5
- package/dist/types/org/hypercerts/claim/measurement.d.ts.map +1 -1
- package/dist/types/org/hypercerts/defs.d.ts +0 -44
- package/dist/types/org/hypercerts/defs.d.ts.map +1 -1
- package/lexicons/app/certified/location.json +16 -2
- package/lexicons/org/hypercerts/claim/activity.json +8 -7
- package/lexicons/org/hypercerts/claim/attachment.json +86 -0
- package/lexicons/org/hypercerts/claim/measurement.json +49 -16
- package/lexicons/org/hypercerts/defs.json +0 -88
- package/package.json +1 -1
- package/dist/generated/types/org/hypercerts/claim/evidence.d.ts +0 -29
- package/dist/generated/types/org/hypercerts/claim/evidence.d.ts.map +0 -1
- package/dist/types/org/hypercerts/claim/evidence.d.ts +0 -29
- package/dist/types/org/hypercerts/claim/evidence.d.ts.map +0 -1
- package/lexicons/org/hypercerts/claim/evidence.json +0 -57
|
@@ -166,8 +166,8 @@ export declare const schemaDict: {
|
|
|
166
166
|
};
|
|
167
167
|
readonly location: {
|
|
168
168
|
readonly type: "union";
|
|
169
|
-
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
170
|
-
readonly description: "The location of where the work was performed as a URI or
|
|
169
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob", "lex:app.certified.location#string"];
|
|
170
|
+
readonly description: "The location of where the work was performed as a URI, blob, or inline string.";
|
|
171
171
|
};
|
|
172
172
|
readonly name: {
|
|
173
173
|
readonly type: "string";
|
|
@@ -189,6 +189,19 @@ export declare const schemaDict: {
|
|
|
189
189
|
};
|
|
190
190
|
};
|
|
191
191
|
};
|
|
192
|
+
readonly string: {
|
|
193
|
+
readonly type: "object";
|
|
194
|
+
readonly required: ["string"];
|
|
195
|
+
readonly description: "A location represented as a string, e.g. coordinates or a small GeoJSON string.";
|
|
196
|
+
readonly properties: {
|
|
197
|
+
readonly string: {
|
|
198
|
+
readonly type: "string";
|
|
199
|
+
readonly description: "The location string value";
|
|
200
|
+
readonly maxLength: 10000;
|
|
201
|
+
readonly maxGraphemes: 1000;
|
|
202
|
+
};
|
|
203
|
+
};
|
|
204
|
+
};
|
|
192
205
|
};
|
|
193
206
|
};
|
|
194
207
|
readonly ComAtprotoRepoStrongRef: {
|
|
@@ -264,8 +277,8 @@ export declare const schemaDict: {
|
|
|
264
277
|
};
|
|
265
278
|
readonly workScope: {
|
|
266
279
|
readonly type: "union";
|
|
267
|
-
readonly refs: ["lex:
|
|
268
|
-
readonly description: "Work scope
|
|
280
|
+
readonly refs: ["lex:com.atproto.repo.strongRef", "lex:org.hypercerts.claim.activity#workScopeString"];
|
|
281
|
+
readonly description: "Work scope definition. Either a strongRef to a work-scope logic record (structured, nested logic), or a free-form string for simple or legacy scopes. The work scope record should conform to the org.hypercerts.helper.workScopeTag lexicon.";
|
|
269
282
|
};
|
|
270
283
|
readonly startDate: {
|
|
271
284
|
readonly type: "string";
|
|
@@ -336,6 +349,95 @@ export declare const schemaDict: {
|
|
|
336
349
|
readonly maxLength: 10000;
|
|
337
350
|
readonly maxGraphemes: 1000;
|
|
338
351
|
};
|
|
352
|
+
readonly workScopeString: {
|
|
353
|
+
readonly type: "string";
|
|
354
|
+
readonly description: "A free-form string describing the work scope for simple or legacy scopes.";
|
|
355
|
+
readonly maxLength: 10000;
|
|
356
|
+
readonly maxGraphemes: 1000;
|
|
357
|
+
};
|
|
358
|
+
};
|
|
359
|
+
};
|
|
360
|
+
readonly OrgHypercertsClaimAttachment: {
|
|
361
|
+
readonly lexicon: 1;
|
|
362
|
+
readonly id: "org.hypercerts.claim.attachment";
|
|
363
|
+
readonly defs: {
|
|
364
|
+
readonly main: {
|
|
365
|
+
readonly type: "record";
|
|
366
|
+
readonly description: "An attachment providing commentary, context, evidence, or documentary material related to a hypercert record (e.g. an activity, project, claim, or evaluation).";
|
|
367
|
+
readonly key: "tid";
|
|
368
|
+
readonly record: {
|
|
369
|
+
readonly type: "object";
|
|
370
|
+
readonly required: ["title", "content", "createdAt"];
|
|
371
|
+
readonly properties: {
|
|
372
|
+
readonly subjects: {
|
|
373
|
+
readonly type: "array";
|
|
374
|
+
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.";
|
|
375
|
+
readonly items: {
|
|
376
|
+
readonly type: "ref";
|
|
377
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
378
|
+
};
|
|
379
|
+
readonly maxLength: 100;
|
|
380
|
+
};
|
|
381
|
+
readonly contentType: {
|
|
382
|
+
readonly type: "string";
|
|
383
|
+
readonly maxLength: 64;
|
|
384
|
+
readonly description: "The type of attachment, e.g. report, audit, evidence, testimonial, methodology, etc.";
|
|
385
|
+
};
|
|
386
|
+
readonly content: {
|
|
387
|
+
readonly type: "array";
|
|
388
|
+
readonly description: "The files, documents, or external references included in this attachment record.";
|
|
389
|
+
readonly items: {
|
|
390
|
+
readonly type: "union";
|
|
391
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
392
|
+
};
|
|
393
|
+
readonly maxLength: 100;
|
|
394
|
+
};
|
|
395
|
+
readonly title: {
|
|
396
|
+
readonly type: "string";
|
|
397
|
+
readonly maxLength: 256;
|
|
398
|
+
readonly description: "Title of this attachment.";
|
|
399
|
+
};
|
|
400
|
+
readonly shortDescription: {
|
|
401
|
+
readonly type: "string";
|
|
402
|
+
readonly description: "Short summary of this attachment, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.";
|
|
403
|
+
readonly maxLength: 3000;
|
|
404
|
+
readonly maxGraphemes: 300;
|
|
405
|
+
};
|
|
406
|
+
readonly shortDescriptionFacets: {
|
|
407
|
+
readonly type: "array";
|
|
408
|
+
readonly description: "Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc).";
|
|
409
|
+
readonly items: {
|
|
410
|
+
readonly type: "ref";
|
|
411
|
+
readonly ref: "lex:app.bsky.richtext.facet";
|
|
412
|
+
};
|
|
413
|
+
};
|
|
414
|
+
readonly description: {
|
|
415
|
+
readonly type: "string";
|
|
416
|
+
readonly description: "Optional longer description of this attachment, including context or interpretation. Rich text annotations may be provided via `descriptionFacets`.";
|
|
417
|
+
readonly maxLength: 30000;
|
|
418
|
+
readonly maxGraphemes: 3000;
|
|
419
|
+
};
|
|
420
|
+
readonly descriptionFacets: {
|
|
421
|
+
readonly type: "array";
|
|
422
|
+
readonly description: "Rich text annotations for `description` (mentions, URLs, hashtags, etc).";
|
|
423
|
+
readonly items: {
|
|
424
|
+
readonly type: "ref";
|
|
425
|
+
readonly ref: "lex:app.bsky.richtext.facet";
|
|
426
|
+
};
|
|
427
|
+
};
|
|
428
|
+
readonly location: {
|
|
429
|
+
readonly type: "ref";
|
|
430
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
431
|
+
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.";
|
|
432
|
+
};
|
|
433
|
+
readonly createdAt: {
|
|
434
|
+
readonly type: "string";
|
|
435
|
+
readonly format: "datetime";
|
|
436
|
+
readonly description: "Client-declared timestamp when this record was originally created.";
|
|
437
|
+
};
|
|
438
|
+
};
|
|
439
|
+
};
|
|
440
|
+
};
|
|
339
441
|
};
|
|
340
442
|
};
|
|
341
443
|
readonly OrgHypercertsClaimCollection: {
|
|
@@ -587,96 +689,57 @@ export declare const schemaDict: {
|
|
|
587
689
|
};
|
|
588
690
|
};
|
|
589
691
|
};
|
|
590
|
-
readonly
|
|
692
|
+
readonly OrgHypercertsClaimMeasurement: {
|
|
591
693
|
readonly lexicon: 1;
|
|
592
|
-
readonly id: "org.hypercerts.claim.
|
|
694
|
+
readonly id: "org.hypercerts.claim.measurement";
|
|
593
695
|
readonly defs: {
|
|
594
696
|
readonly main: {
|
|
595
697
|
readonly type: "record";
|
|
596
|
-
readonly description: "
|
|
698
|
+
readonly description: "Measurement data related to a hypercert record (e.g. an activity and its impact).";
|
|
597
699
|
readonly key: "tid";
|
|
598
700
|
readonly record: {
|
|
599
701
|
readonly type: "object";
|
|
600
|
-
readonly required: ["
|
|
702
|
+
readonly required: ["metric", "unit", "value", "createdAt"];
|
|
601
703
|
readonly properties: {
|
|
602
704
|
readonly subject: {
|
|
603
705
|
readonly type: "ref";
|
|
604
706
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
605
|
-
readonly description: "A strong reference to the record this
|
|
606
|
-
};
|
|
607
|
-
readonly content: {
|
|
608
|
-
readonly type: "union";
|
|
609
|
-
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
610
|
-
readonly description: "A piece of evidence (URI or blob) related to the subject record; it may support, clarify, or challenge a hypercert claim.";
|
|
707
|
+
readonly description: "A strong reference to the record this measurement refers to (e.g. an activity, project, or claim).";
|
|
611
708
|
};
|
|
612
|
-
readonly
|
|
709
|
+
readonly metric: {
|
|
613
710
|
readonly type: "string";
|
|
614
|
-
readonly
|
|
615
|
-
readonly
|
|
711
|
+
readonly description: "The metric being measured, e.g. forest area restored, number of users, etc.";
|
|
712
|
+
readonly maxLength: 500;
|
|
616
713
|
};
|
|
617
|
-
readonly
|
|
714
|
+
readonly unit: {
|
|
618
715
|
readonly type: "string";
|
|
619
|
-
readonly
|
|
620
|
-
readonly
|
|
621
|
-
readonly description: "Short description explaining what this evidence shows.";
|
|
716
|
+
readonly description: "The unit of the measured value (e.g. kg CO₂e, hectares, %, index score).";
|
|
717
|
+
readonly maxLength: 50;
|
|
622
718
|
};
|
|
623
|
-
readonly
|
|
719
|
+
readonly value: {
|
|
624
720
|
readonly type: "string";
|
|
625
|
-
readonly description: "
|
|
626
|
-
readonly maxLength:
|
|
627
|
-
readonly maxGraphemes: 3000;
|
|
721
|
+
readonly description: "The measured numeric value.";
|
|
722
|
+
readonly maxLength: 500;
|
|
628
723
|
};
|
|
629
|
-
readonly
|
|
724
|
+
readonly startDate: {
|
|
630
725
|
readonly type: "string";
|
|
631
|
-
readonly
|
|
632
|
-
readonly
|
|
726
|
+
readonly format: "datetime";
|
|
727
|
+
readonly description: "The start date and time when the measurement began.";
|
|
633
728
|
};
|
|
634
|
-
readonly
|
|
729
|
+
readonly endDate: {
|
|
635
730
|
readonly type: "string";
|
|
636
731
|
readonly format: "datetime";
|
|
637
|
-
readonly description: "
|
|
638
|
-
};
|
|
639
|
-
};
|
|
640
|
-
};
|
|
641
|
-
};
|
|
642
|
-
};
|
|
643
|
-
};
|
|
644
|
-
readonly OrgHypercertsClaimMeasurement: {
|
|
645
|
-
readonly lexicon: 1;
|
|
646
|
-
readonly id: "org.hypercerts.claim.measurement";
|
|
647
|
-
readonly defs: {
|
|
648
|
-
readonly main: {
|
|
649
|
-
readonly type: "record";
|
|
650
|
-
readonly description: "Measurement data related to a hypercert record (e.g. an activity and its impact).";
|
|
651
|
-
readonly key: "tid";
|
|
652
|
-
readonly record: {
|
|
653
|
-
readonly type: "object";
|
|
654
|
-
readonly required: ["measurers", "metric", "value", "createdAt"];
|
|
655
|
-
readonly properties: {
|
|
656
|
-
readonly subject: {
|
|
657
|
-
readonly type: "ref";
|
|
658
|
-
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
659
|
-
readonly description: "A strong reference to the record this measurement refers to (e.g. an activity, project, or claim).";
|
|
732
|
+
readonly description: "The end date and time when the measurement ended. If it was a one time measurement, the endDate should be equal to the startDate.";
|
|
660
733
|
};
|
|
661
|
-
readonly
|
|
734
|
+
readonly locations: {
|
|
662
735
|
readonly type: "array";
|
|
663
|
-
readonly description: "
|
|
736
|
+
readonly description: "Optional geographic references related to where the measurement was taken. Each referenced record must conform with the app.certified.location lexicon.";
|
|
664
737
|
readonly items: {
|
|
665
738
|
readonly type: "ref";
|
|
666
|
-
readonly ref: "lex:
|
|
739
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
667
740
|
};
|
|
668
741
|
readonly maxLength: 100;
|
|
669
742
|
};
|
|
670
|
-
readonly metric: {
|
|
671
|
-
readonly type: "string";
|
|
672
|
-
readonly description: "The metric being measured";
|
|
673
|
-
readonly maxLength: 500;
|
|
674
|
-
};
|
|
675
|
-
readonly value: {
|
|
676
|
-
readonly type: "string";
|
|
677
|
-
readonly description: "The measured value";
|
|
678
|
-
readonly maxLength: 500;
|
|
679
|
-
};
|
|
680
743
|
readonly methodType: {
|
|
681
744
|
readonly type: "string";
|
|
682
745
|
readonly description: "Short identifier for the measurement methodology";
|
|
@@ -696,10 +759,28 @@ export declare const schemaDict: {
|
|
|
696
759
|
};
|
|
697
760
|
readonly maxLength: 50;
|
|
698
761
|
};
|
|
699
|
-
readonly
|
|
700
|
-
readonly type: "
|
|
701
|
-
readonly
|
|
702
|
-
readonly
|
|
762
|
+
readonly measurers: {
|
|
763
|
+
readonly type: "array";
|
|
764
|
+
readonly description: "DIDs of the entity (or entities) that measured this data";
|
|
765
|
+
readonly items: {
|
|
766
|
+
readonly type: "ref";
|
|
767
|
+
readonly ref: "lex:app.certified.defs#did";
|
|
768
|
+
};
|
|
769
|
+
readonly maxLength: 100;
|
|
770
|
+
};
|
|
771
|
+
readonly comment: {
|
|
772
|
+
readonly type: "string";
|
|
773
|
+
readonly description: "Short comment of this measurement, suitable for previews and list views. Rich text annotations may be provided via `commentFacets`.";
|
|
774
|
+
readonly maxLength: 3000;
|
|
775
|
+
readonly maxGraphemes: 300;
|
|
776
|
+
};
|
|
777
|
+
readonly commentFacets: {
|
|
778
|
+
readonly type: "array";
|
|
779
|
+
readonly description: "Rich text annotations for `comment` (mentions, URLs, hashtags, etc).";
|
|
780
|
+
readonly items: {
|
|
781
|
+
readonly type: "ref";
|
|
782
|
+
readonly ref: "lex:app.bsky.richtext.facet";
|
|
783
|
+
};
|
|
703
784
|
};
|
|
704
785
|
readonly createdAt: {
|
|
705
786
|
readonly type: "string";
|
|
@@ -821,79 +902,6 @@ export declare const schemaDict: {
|
|
|
821
902
|
};
|
|
822
903
|
};
|
|
823
904
|
};
|
|
824
|
-
readonly workScopeAll: {
|
|
825
|
-
readonly type: "object";
|
|
826
|
-
readonly required: ["op", "args"];
|
|
827
|
-
readonly description: "Logical AND operation: all arguments must be satisfied.";
|
|
828
|
-
readonly properties: {
|
|
829
|
-
readonly op: {
|
|
830
|
-
readonly type: "string";
|
|
831
|
-
readonly const: "all";
|
|
832
|
-
readonly description: "Operator type: 'all' (logical AND)";
|
|
833
|
-
};
|
|
834
|
-
readonly args: {
|
|
835
|
-
readonly type: "array";
|
|
836
|
-
readonly items: {
|
|
837
|
-
readonly type: "union";
|
|
838
|
-
readonly refs: ["lex:org.hypercerts.defs#workScopeAll", "lex:org.hypercerts.defs#workScopeAny", "lex:org.hypercerts.defs#workScopeNot", "lex:org.hypercerts.defs#workScopeAtom"];
|
|
839
|
-
};
|
|
840
|
-
readonly minLength: 1;
|
|
841
|
-
readonly maxLength: 100;
|
|
842
|
-
readonly description: "Array of work scope expressions that must all be satisfied";
|
|
843
|
-
};
|
|
844
|
-
};
|
|
845
|
-
};
|
|
846
|
-
readonly workScopeAny: {
|
|
847
|
-
readonly type: "object";
|
|
848
|
-
readonly required: ["op", "args"];
|
|
849
|
-
readonly description: "Logical OR operation: at least one argument must be satisfied.";
|
|
850
|
-
readonly properties: {
|
|
851
|
-
readonly op: {
|
|
852
|
-
readonly type: "string";
|
|
853
|
-
readonly const: "any";
|
|
854
|
-
readonly description: "Operator type: 'any' (logical OR)";
|
|
855
|
-
};
|
|
856
|
-
readonly args: {
|
|
857
|
-
readonly type: "array";
|
|
858
|
-
readonly items: {
|
|
859
|
-
readonly type: "union";
|
|
860
|
-
readonly refs: ["lex:org.hypercerts.defs#workScopeAll", "lex:org.hypercerts.defs#workScopeAny", "lex:org.hypercerts.defs#workScopeNot", "lex:org.hypercerts.defs#workScopeAtom"];
|
|
861
|
-
};
|
|
862
|
-
readonly minLength: 1;
|
|
863
|
-
readonly maxLength: 100;
|
|
864
|
-
readonly description: "Array of work scope expressions, at least one of which must be satisfied";
|
|
865
|
-
};
|
|
866
|
-
};
|
|
867
|
-
};
|
|
868
|
-
readonly workScopeNot: {
|
|
869
|
-
readonly type: "object";
|
|
870
|
-
readonly required: ["op", "arg"];
|
|
871
|
-
readonly description: "Logical NOT operation: the argument must not be satisfied.";
|
|
872
|
-
readonly properties: {
|
|
873
|
-
readonly op: {
|
|
874
|
-
readonly type: "string";
|
|
875
|
-
readonly const: "not";
|
|
876
|
-
readonly description: "Operator type: 'not' (logical NOT)";
|
|
877
|
-
};
|
|
878
|
-
readonly arg: {
|
|
879
|
-
readonly type: "union";
|
|
880
|
-
readonly refs: ["lex:org.hypercerts.defs#workScopeAll", "lex:org.hypercerts.defs#workScopeAny", "lex:org.hypercerts.defs#workScopeNot", "lex:org.hypercerts.defs#workScopeAtom"];
|
|
881
|
-
readonly description: "Work scope expression that must not be satisfied";
|
|
882
|
-
};
|
|
883
|
-
};
|
|
884
|
-
};
|
|
885
|
-
readonly workScopeAtom: {
|
|
886
|
-
readonly type: "object";
|
|
887
|
-
readonly required: ["atom"];
|
|
888
|
-
readonly description: "Atomic scope reference: a strong reference to a scope record.";
|
|
889
|
-
readonly properties: {
|
|
890
|
-
readonly atom: {
|
|
891
|
-
readonly type: "ref";
|
|
892
|
-
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
893
|
-
readonly description: "Strong reference to an org.hypercerts.helper.workScopeTag record";
|
|
894
|
-
};
|
|
895
|
-
};
|
|
896
|
-
};
|
|
897
905
|
};
|
|
898
906
|
};
|
|
899
907
|
readonly OrgHypercertsFundingReceipt: {
|
|
@@ -1184,8 +1192,8 @@ export declare const schemas: ({
|
|
|
1184
1192
|
};
|
|
1185
1193
|
readonly location: {
|
|
1186
1194
|
readonly type: "union";
|
|
1187
|
-
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
1188
|
-
readonly description: "The location of where the work was performed as a URI or
|
|
1195
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob", "lex:app.certified.location#string"];
|
|
1196
|
+
readonly description: "The location of where the work was performed as a URI, blob, or inline string.";
|
|
1189
1197
|
};
|
|
1190
1198
|
readonly name: {
|
|
1191
1199
|
readonly type: "string";
|
|
@@ -1207,6 +1215,19 @@ export declare const schemas: ({
|
|
|
1207
1215
|
};
|
|
1208
1216
|
};
|
|
1209
1217
|
};
|
|
1218
|
+
readonly string: {
|
|
1219
|
+
readonly type: "object";
|
|
1220
|
+
readonly required: ["string"];
|
|
1221
|
+
readonly description: "A location represented as a string, e.g. coordinates or a small GeoJSON string.";
|
|
1222
|
+
readonly properties: {
|
|
1223
|
+
readonly string: {
|
|
1224
|
+
readonly type: "string";
|
|
1225
|
+
readonly description: "The location string value";
|
|
1226
|
+
readonly maxLength: 10000;
|
|
1227
|
+
readonly maxGraphemes: 1000;
|
|
1228
|
+
};
|
|
1229
|
+
};
|
|
1230
|
+
};
|
|
1210
1231
|
};
|
|
1211
1232
|
} | {
|
|
1212
1233
|
readonly lexicon: 1;
|
|
@@ -1280,8 +1301,8 @@ export declare const schemas: ({
|
|
|
1280
1301
|
};
|
|
1281
1302
|
readonly workScope: {
|
|
1282
1303
|
readonly type: "union";
|
|
1283
|
-
readonly refs: ["lex:
|
|
1284
|
-
readonly description: "Work scope
|
|
1304
|
+
readonly refs: ["lex:com.atproto.repo.strongRef", "lex:org.hypercerts.claim.activity#workScopeString"];
|
|
1305
|
+
readonly description: "Work scope definition. Either a strongRef to a work-scope logic record (structured, nested logic), or a free-form string for simple or legacy scopes. The work scope record should conform to the org.hypercerts.helper.workScopeTag lexicon.";
|
|
1285
1306
|
};
|
|
1286
1307
|
readonly startDate: {
|
|
1287
1308
|
readonly type: "string";
|
|
@@ -1352,6 +1373,94 @@ export declare const schemas: ({
|
|
|
1352
1373
|
readonly maxLength: 10000;
|
|
1353
1374
|
readonly maxGraphemes: 1000;
|
|
1354
1375
|
};
|
|
1376
|
+
readonly workScopeString: {
|
|
1377
|
+
readonly type: "string";
|
|
1378
|
+
readonly description: "A free-form string describing the work scope for simple or legacy scopes.";
|
|
1379
|
+
readonly maxLength: 10000;
|
|
1380
|
+
readonly maxGraphemes: 1000;
|
|
1381
|
+
};
|
|
1382
|
+
};
|
|
1383
|
+
} | {
|
|
1384
|
+
readonly lexicon: 1;
|
|
1385
|
+
readonly id: "org.hypercerts.claim.attachment";
|
|
1386
|
+
readonly defs: {
|
|
1387
|
+
readonly main: {
|
|
1388
|
+
readonly type: "record";
|
|
1389
|
+
readonly description: "An attachment providing commentary, context, evidence, or documentary material related to a hypercert record (e.g. an activity, project, claim, or evaluation).";
|
|
1390
|
+
readonly key: "tid";
|
|
1391
|
+
readonly record: {
|
|
1392
|
+
readonly type: "object";
|
|
1393
|
+
readonly required: ["title", "content", "createdAt"];
|
|
1394
|
+
readonly properties: {
|
|
1395
|
+
readonly subjects: {
|
|
1396
|
+
readonly type: "array";
|
|
1397
|
+
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.";
|
|
1398
|
+
readonly items: {
|
|
1399
|
+
readonly type: "ref";
|
|
1400
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1401
|
+
};
|
|
1402
|
+
readonly maxLength: 100;
|
|
1403
|
+
};
|
|
1404
|
+
readonly contentType: {
|
|
1405
|
+
readonly type: "string";
|
|
1406
|
+
readonly maxLength: 64;
|
|
1407
|
+
readonly description: "The type of attachment, e.g. report, audit, evidence, testimonial, methodology, etc.";
|
|
1408
|
+
};
|
|
1409
|
+
readonly content: {
|
|
1410
|
+
readonly type: "array";
|
|
1411
|
+
readonly description: "The files, documents, or external references included in this attachment record.";
|
|
1412
|
+
readonly items: {
|
|
1413
|
+
readonly type: "union";
|
|
1414
|
+
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
1415
|
+
};
|
|
1416
|
+
readonly maxLength: 100;
|
|
1417
|
+
};
|
|
1418
|
+
readonly title: {
|
|
1419
|
+
readonly type: "string";
|
|
1420
|
+
readonly maxLength: 256;
|
|
1421
|
+
readonly description: "Title of this attachment.";
|
|
1422
|
+
};
|
|
1423
|
+
readonly shortDescription: {
|
|
1424
|
+
readonly type: "string";
|
|
1425
|
+
readonly description: "Short summary of this attachment, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.";
|
|
1426
|
+
readonly maxLength: 3000;
|
|
1427
|
+
readonly maxGraphemes: 300;
|
|
1428
|
+
};
|
|
1429
|
+
readonly shortDescriptionFacets: {
|
|
1430
|
+
readonly type: "array";
|
|
1431
|
+
readonly description: "Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc).";
|
|
1432
|
+
readonly items: {
|
|
1433
|
+
readonly type: "ref";
|
|
1434
|
+
readonly ref: "lex:app.bsky.richtext.facet";
|
|
1435
|
+
};
|
|
1436
|
+
};
|
|
1437
|
+
readonly description: {
|
|
1438
|
+
readonly type: "string";
|
|
1439
|
+
readonly description: "Optional longer description of this attachment, including context or interpretation. Rich text annotations may be provided via `descriptionFacets`.";
|
|
1440
|
+
readonly maxLength: 30000;
|
|
1441
|
+
readonly maxGraphemes: 3000;
|
|
1442
|
+
};
|
|
1443
|
+
readonly descriptionFacets: {
|
|
1444
|
+
readonly type: "array";
|
|
1445
|
+
readonly description: "Rich text annotations for `description` (mentions, URLs, hashtags, etc).";
|
|
1446
|
+
readonly items: {
|
|
1447
|
+
readonly type: "ref";
|
|
1448
|
+
readonly ref: "lex:app.bsky.richtext.facet";
|
|
1449
|
+
};
|
|
1450
|
+
};
|
|
1451
|
+
readonly location: {
|
|
1452
|
+
readonly type: "ref";
|
|
1453
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1454
|
+
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.";
|
|
1455
|
+
};
|
|
1456
|
+
readonly createdAt: {
|
|
1457
|
+
readonly type: "string";
|
|
1458
|
+
readonly format: "datetime";
|
|
1459
|
+
readonly description: "Client-declared timestamp when this record was originally created.";
|
|
1460
|
+
};
|
|
1461
|
+
};
|
|
1462
|
+
};
|
|
1463
|
+
};
|
|
1355
1464
|
};
|
|
1356
1465
|
} | {
|
|
1357
1466
|
readonly lexicon: 1;
|
|
@@ -1600,93 +1709,55 @@ export declare const schemas: ({
|
|
|
1600
1709
|
};
|
|
1601
1710
|
} | {
|
|
1602
1711
|
readonly lexicon: 1;
|
|
1603
|
-
readonly id: "org.hypercerts.claim.
|
|
1712
|
+
readonly id: "org.hypercerts.claim.measurement";
|
|
1604
1713
|
readonly defs: {
|
|
1605
1714
|
readonly main: {
|
|
1606
1715
|
readonly type: "record";
|
|
1607
|
-
readonly description: "
|
|
1716
|
+
readonly description: "Measurement data related to a hypercert record (e.g. an activity and its impact).";
|
|
1608
1717
|
readonly key: "tid";
|
|
1609
1718
|
readonly record: {
|
|
1610
1719
|
readonly type: "object";
|
|
1611
|
-
readonly required: ["
|
|
1720
|
+
readonly required: ["metric", "unit", "value", "createdAt"];
|
|
1612
1721
|
readonly properties: {
|
|
1613
1722
|
readonly subject: {
|
|
1614
1723
|
readonly type: "ref";
|
|
1615
1724
|
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1616
|
-
readonly description: "A strong reference to the record this
|
|
1617
|
-
};
|
|
1618
|
-
readonly content: {
|
|
1619
|
-
readonly type: "union";
|
|
1620
|
-
readonly refs: ["lex:org.hypercerts.defs#uri", "lex:org.hypercerts.defs#smallBlob"];
|
|
1621
|
-
readonly description: "A piece of evidence (URI or blob) related to the subject record; it may support, clarify, or challenge a hypercert claim.";
|
|
1725
|
+
readonly description: "A strong reference to the record this measurement refers to (e.g. an activity, project, or claim).";
|
|
1622
1726
|
};
|
|
1623
|
-
readonly
|
|
1727
|
+
readonly metric: {
|
|
1624
1728
|
readonly type: "string";
|
|
1625
|
-
readonly
|
|
1626
|
-
readonly
|
|
1729
|
+
readonly description: "The metric being measured, e.g. forest area restored, number of users, etc.";
|
|
1730
|
+
readonly maxLength: 500;
|
|
1627
1731
|
};
|
|
1628
|
-
readonly
|
|
1732
|
+
readonly unit: {
|
|
1629
1733
|
readonly type: "string";
|
|
1630
|
-
readonly
|
|
1631
|
-
readonly
|
|
1632
|
-
readonly description: "Short description explaining what this evidence shows.";
|
|
1734
|
+
readonly description: "The unit of the measured value (e.g. kg CO₂e, hectares, %, index score).";
|
|
1735
|
+
readonly maxLength: 50;
|
|
1633
1736
|
};
|
|
1634
|
-
readonly
|
|
1737
|
+
readonly value: {
|
|
1635
1738
|
readonly type: "string";
|
|
1636
|
-
readonly description: "
|
|
1637
|
-
readonly maxLength:
|
|
1638
|
-
readonly maxGraphemes: 3000;
|
|
1739
|
+
readonly description: "The measured numeric value.";
|
|
1740
|
+
readonly maxLength: 500;
|
|
1639
1741
|
};
|
|
1640
|
-
readonly
|
|
1742
|
+
readonly startDate: {
|
|
1641
1743
|
readonly type: "string";
|
|
1642
|
-
readonly
|
|
1643
|
-
readonly
|
|
1744
|
+
readonly format: "datetime";
|
|
1745
|
+
readonly description: "The start date and time when the measurement began.";
|
|
1644
1746
|
};
|
|
1645
|
-
readonly
|
|
1747
|
+
readonly endDate: {
|
|
1646
1748
|
readonly type: "string";
|
|
1647
1749
|
readonly format: "datetime";
|
|
1648
|
-
readonly description: "
|
|
1649
|
-
};
|
|
1650
|
-
};
|
|
1651
|
-
};
|
|
1652
|
-
};
|
|
1653
|
-
};
|
|
1654
|
-
} | {
|
|
1655
|
-
readonly lexicon: 1;
|
|
1656
|
-
readonly id: "org.hypercerts.claim.measurement";
|
|
1657
|
-
readonly defs: {
|
|
1658
|
-
readonly main: {
|
|
1659
|
-
readonly type: "record";
|
|
1660
|
-
readonly description: "Measurement data related to a hypercert record (e.g. an activity and its impact).";
|
|
1661
|
-
readonly key: "tid";
|
|
1662
|
-
readonly record: {
|
|
1663
|
-
readonly type: "object";
|
|
1664
|
-
readonly required: ["measurers", "metric", "value", "createdAt"];
|
|
1665
|
-
readonly properties: {
|
|
1666
|
-
readonly subject: {
|
|
1667
|
-
readonly type: "ref";
|
|
1668
|
-
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1669
|
-
readonly description: "A strong reference to the record this measurement refers to (e.g. an activity, project, or claim).";
|
|
1750
|
+
readonly description: "The end date and time when the measurement ended. If it was a one time measurement, the endDate should be equal to the startDate.";
|
|
1670
1751
|
};
|
|
1671
|
-
readonly
|
|
1752
|
+
readonly locations: {
|
|
1672
1753
|
readonly type: "array";
|
|
1673
|
-
readonly description: "
|
|
1754
|
+
readonly description: "Optional geographic references related to where the measurement was taken. Each referenced record must conform with the app.certified.location lexicon.";
|
|
1674
1755
|
readonly items: {
|
|
1675
1756
|
readonly type: "ref";
|
|
1676
|
-
readonly ref: "lex:
|
|
1757
|
+
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1677
1758
|
};
|
|
1678
1759
|
readonly maxLength: 100;
|
|
1679
1760
|
};
|
|
1680
|
-
readonly metric: {
|
|
1681
|
-
readonly type: "string";
|
|
1682
|
-
readonly description: "The metric being measured";
|
|
1683
|
-
readonly maxLength: 500;
|
|
1684
|
-
};
|
|
1685
|
-
readonly value: {
|
|
1686
|
-
readonly type: "string";
|
|
1687
|
-
readonly description: "The measured value";
|
|
1688
|
-
readonly maxLength: 500;
|
|
1689
|
-
};
|
|
1690
1761
|
readonly methodType: {
|
|
1691
1762
|
readonly type: "string";
|
|
1692
1763
|
readonly description: "Short identifier for the measurement methodology";
|
|
@@ -1706,10 +1777,28 @@ export declare const schemas: ({
|
|
|
1706
1777
|
};
|
|
1707
1778
|
readonly maxLength: 50;
|
|
1708
1779
|
};
|
|
1709
|
-
readonly
|
|
1710
|
-
readonly type: "
|
|
1711
|
-
readonly
|
|
1712
|
-
readonly
|
|
1780
|
+
readonly measurers: {
|
|
1781
|
+
readonly type: "array";
|
|
1782
|
+
readonly description: "DIDs of the entity (or entities) that measured this data";
|
|
1783
|
+
readonly items: {
|
|
1784
|
+
readonly type: "ref";
|
|
1785
|
+
readonly ref: "lex:app.certified.defs#did";
|
|
1786
|
+
};
|
|
1787
|
+
readonly maxLength: 100;
|
|
1788
|
+
};
|
|
1789
|
+
readonly comment: {
|
|
1790
|
+
readonly type: "string";
|
|
1791
|
+
readonly description: "Short comment of this measurement, suitable for previews and list views. Rich text annotations may be provided via `commentFacets`.";
|
|
1792
|
+
readonly maxLength: 3000;
|
|
1793
|
+
readonly maxGraphemes: 300;
|
|
1794
|
+
};
|
|
1795
|
+
readonly commentFacets: {
|
|
1796
|
+
readonly type: "array";
|
|
1797
|
+
readonly description: "Rich text annotations for `comment` (mentions, URLs, hashtags, etc).";
|
|
1798
|
+
readonly items: {
|
|
1799
|
+
readonly type: "ref";
|
|
1800
|
+
readonly ref: "lex:app.bsky.richtext.facet";
|
|
1801
|
+
};
|
|
1713
1802
|
};
|
|
1714
1803
|
readonly createdAt: {
|
|
1715
1804
|
readonly type: "string";
|
|
@@ -1829,79 +1918,6 @@ export declare const schemas: ({
|
|
|
1829
1918
|
};
|
|
1830
1919
|
};
|
|
1831
1920
|
};
|
|
1832
|
-
readonly workScopeAll: {
|
|
1833
|
-
readonly type: "object";
|
|
1834
|
-
readonly required: ["op", "args"];
|
|
1835
|
-
readonly description: "Logical AND operation: all arguments must be satisfied.";
|
|
1836
|
-
readonly properties: {
|
|
1837
|
-
readonly op: {
|
|
1838
|
-
readonly type: "string";
|
|
1839
|
-
readonly const: "all";
|
|
1840
|
-
readonly description: "Operator type: 'all' (logical AND)";
|
|
1841
|
-
};
|
|
1842
|
-
readonly args: {
|
|
1843
|
-
readonly type: "array";
|
|
1844
|
-
readonly items: {
|
|
1845
|
-
readonly type: "union";
|
|
1846
|
-
readonly refs: ["lex:org.hypercerts.defs#workScopeAll", "lex:org.hypercerts.defs#workScopeAny", "lex:org.hypercerts.defs#workScopeNot", "lex:org.hypercerts.defs#workScopeAtom"];
|
|
1847
|
-
};
|
|
1848
|
-
readonly minLength: 1;
|
|
1849
|
-
readonly maxLength: 100;
|
|
1850
|
-
readonly description: "Array of work scope expressions that must all be satisfied";
|
|
1851
|
-
};
|
|
1852
|
-
};
|
|
1853
|
-
};
|
|
1854
|
-
readonly workScopeAny: {
|
|
1855
|
-
readonly type: "object";
|
|
1856
|
-
readonly required: ["op", "args"];
|
|
1857
|
-
readonly description: "Logical OR operation: at least one argument must be satisfied.";
|
|
1858
|
-
readonly properties: {
|
|
1859
|
-
readonly op: {
|
|
1860
|
-
readonly type: "string";
|
|
1861
|
-
readonly const: "any";
|
|
1862
|
-
readonly description: "Operator type: 'any' (logical OR)";
|
|
1863
|
-
};
|
|
1864
|
-
readonly args: {
|
|
1865
|
-
readonly type: "array";
|
|
1866
|
-
readonly items: {
|
|
1867
|
-
readonly type: "union";
|
|
1868
|
-
readonly refs: ["lex:org.hypercerts.defs#workScopeAll", "lex:org.hypercerts.defs#workScopeAny", "lex:org.hypercerts.defs#workScopeNot", "lex:org.hypercerts.defs#workScopeAtom"];
|
|
1869
|
-
};
|
|
1870
|
-
readonly minLength: 1;
|
|
1871
|
-
readonly maxLength: 100;
|
|
1872
|
-
readonly description: "Array of work scope expressions, at least one of which must be satisfied";
|
|
1873
|
-
};
|
|
1874
|
-
};
|
|
1875
|
-
};
|
|
1876
|
-
readonly workScopeNot: {
|
|
1877
|
-
readonly type: "object";
|
|
1878
|
-
readonly required: ["op", "arg"];
|
|
1879
|
-
readonly description: "Logical NOT operation: the argument must not be satisfied.";
|
|
1880
|
-
readonly properties: {
|
|
1881
|
-
readonly op: {
|
|
1882
|
-
readonly type: "string";
|
|
1883
|
-
readonly const: "not";
|
|
1884
|
-
readonly description: "Operator type: 'not' (logical NOT)";
|
|
1885
|
-
};
|
|
1886
|
-
readonly arg: {
|
|
1887
|
-
readonly type: "union";
|
|
1888
|
-
readonly refs: ["lex:org.hypercerts.defs#workScopeAll", "lex:org.hypercerts.defs#workScopeAny", "lex:org.hypercerts.defs#workScopeNot", "lex:org.hypercerts.defs#workScopeAtom"];
|
|
1889
|
-
readonly description: "Work scope expression that must not be satisfied";
|
|
1890
|
-
};
|
|
1891
|
-
};
|
|
1892
|
-
};
|
|
1893
|
-
readonly workScopeAtom: {
|
|
1894
|
-
readonly type: "object";
|
|
1895
|
-
readonly required: ["atom"];
|
|
1896
|
-
readonly description: "Atomic scope reference: a strong reference to a scope record.";
|
|
1897
|
-
readonly properties: {
|
|
1898
|
-
readonly atom: {
|
|
1899
|
-
readonly type: "ref";
|
|
1900
|
-
readonly ref: "lex:com.atproto.repo.strongRef";
|
|
1901
|
-
readonly description: "Strong reference to an org.hypercerts.helper.workScopeTag record";
|
|
1902
|
-
};
|
|
1903
|
-
};
|
|
1904
|
-
};
|
|
1905
1921
|
};
|
|
1906
1922
|
} | {
|
|
1907
1923
|
readonly lexicon: 1;
|
|
@@ -2045,11 +2061,11 @@ export declare const ids: {
|
|
|
2045
2061
|
readonly AppCertifiedLocation: "app.certified.location";
|
|
2046
2062
|
readonly ComAtprotoRepoStrongRef: "com.atproto.repo.strongRef";
|
|
2047
2063
|
readonly OrgHypercertsClaimActivity: "org.hypercerts.claim.activity";
|
|
2064
|
+
readonly OrgHypercertsClaimAttachment: "org.hypercerts.claim.attachment";
|
|
2048
2065
|
readonly OrgHypercertsClaimCollection: "org.hypercerts.claim.collection";
|
|
2049
2066
|
readonly OrgHypercertsClaimContributionDetails: "org.hypercerts.claim.contributionDetails";
|
|
2050
2067
|
readonly OrgHypercertsClaimContributorInformation: "org.hypercerts.claim.contributorInformation";
|
|
2051
2068
|
readonly OrgHypercertsClaimEvaluation: "org.hypercerts.claim.evaluation";
|
|
2052
|
-
readonly OrgHypercertsClaimEvidence: "org.hypercerts.claim.evidence";
|
|
2053
2069
|
readonly OrgHypercertsClaimMeasurement: "org.hypercerts.claim.measurement";
|
|
2054
2070
|
readonly OrgHypercertsClaimRights: "org.hypercerts.claim.rights";
|
|
2055
2071
|
readonly OrgHypercertsDefs: "org.hypercerts.defs";
|