@hypercerts-org/lexicon 0.10.0-beta.3 → 0.10.0-beta.5

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 (45) hide show
  1. package/CHANGELOG.md +63 -0
  2. package/README.md +66 -311
  3. package/SCHEMAS.md +276 -0
  4. package/dist/exports.d.ts +34 -130
  5. package/dist/exports.d.ts.map +1 -1
  6. package/dist/generated/exports.d.ts +34 -130
  7. package/dist/generated/exports.d.ts.map +1 -1
  8. package/dist/generated/lexicons.d.ts +96 -278
  9. package/dist/generated/lexicons.d.ts.map +1 -1
  10. package/dist/generated/types/org/hypercerts/claim/activity.d.ts +6 -19
  11. package/dist/generated/types/org/hypercerts/claim/activity.d.ts.map +1 -1
  12. package/dist/generated/types/org/hypercerts/claim/collection.d.ts +9 -9
  13. package/dist/generated/types/org/hypercerts/claim/collection.d.ts.map +1 -1
  14. package/dist/generated/types/org/hypercerts/claim/contributor.d.ts +31 -0
  15. package/dist/generated/types/org/hypercerts/claim/contributor.d.ts.map +1 -0
  16. package/dist/index.cjs +261 -503
  17. package/dist/index.cjs.map +1 -1
  18. package/dist/index.mjs +253 -491
  19. package/dist/index.mjs.map +1 -1
  20. package/dist/lexicons.cjs +52 -147
  21. package/dist/lexicons.cjs.map +1 -1
  22. package/dist/lexicons.d.ts +96 -278
  23. package/dist/lexicons.d.ts.map +1 -1
  24. package/dist/lexicons.mjs +52 -147
  25. package/dist/lexicons.mjs.map +1 -1
  26. package/dist/types/org/hypercerts/claim/activity.d.ts +6 -19
  27. package/dist/types/org/hypercerts/claim/activity.d.ts.map +1 -1
  28. package/dist/types/org/hypercerts/claim/collection.d.ts +9 -9
  29. package/dist/types/org/hypercerts/claim/collection.d.ts.map +1 -1
  30. package/dist/types/org/hypercerts/claim/contributor.d.ts +31 -0
  31. package/dist/types/org/hypercerts/claim/contributor.d.ts.map +1 -0
  32. package/lexicons/org/hypercerts/claim/activity.json +11 -48
  33. package/lexicons/org/hypercerts/claim/collection.json +14 -17
  34. package/lexicons/org/hypercerts/claim/{contribution.json → contributor.json} +24 -14
  35. package/lexicons/org/hypercerts/claim/evaluation.json +1 -1
  36. package/package.json +8 -4
  37. package/dist/generated/types/org/hypercerts/claim/contribution.d.ts +0 -24
  38. package/dist/generated/types/org/hypercerts/claim/contribution.d.ts.map +0 -1
  39. package/dist/generated/types/org/hypercerts/claim/project.d.ts +0 -29
  40. package/dist/generated/types/org/hypercerts/claim/project.d.ts.map +0 -1
  41. package/dist/types/org/hypercerts/claim/contribution.d.ts +0 -24
  42. package/dist/types/org/hypercerts/claim/contribution.d.ts.map +0 -1
  43. package/dist/types/org/hypercerts/claim/project.d.ts +0 -29
  44. package/dist/types/org/hypercerts/claim/project.d.ts.map +0 -1
  45. package/lexicons/org/hypercerts/claim/project.json +0 -64
@@ -16,17 +16,16 @@ export interface Main {
16
16
  image?: $Typed<OrgHypercertsDefs.Uri> | $Typed<OrgHypercertsDefs.SmallImage> | {
17
17
  $type: string;
18
18
  };
19
- workScope?: WorkScope;
19
+ workScope?: ComAtprotoRepoStrongRef.Main;
20
20
  /** When the work began */
21
- startDate: string;
21
+ startDate?: string;
22
22
  /** When the work ended */
23
- endDate: string;
24
- /** A strong reference to the contributions done to create the impact in the hypercerts. The record referenced must conform with the lexicon org.hypercerts.claim.contribution. */
23
+ endDate?: string;
24
+ /** A strong reference to the contributions done to create the impact in the hypercerts. The record referenced must conform with the lexicon org.hypercerts.claim.contributor. */
25
25
  contributions?: ComAtprotoRepoStrongRef.Main[];
26
26
  rights?: ComAtprotoRepoStrongRef.Main;
27
- location?: ComAtprotoRepoStrongRef.Main;
28
- /** A reference (AT-URI) to the project record that this activity is part of. The record referenced must conform with the lexicon org.hypercerts.claim.project. This activity must also be referenced by the project, establishing a bidirectional link. */
29
- project?: string;
27
+ /** An array of strong references to the location where activity was performed. The record referenced must conform with the lexicon app.certified.location. */
28
+ locations?: ComAtprotoRepoStrongRef.Main[];
30
29
  /** Client-declared timestamp when this record was originally created */
31
30
  createdAt: string;
32
31
  [k: string]: unknown;
@@ -34,18 +33,6 @@ export interface Main {
34
33
  export declare function isMain<V>(v: V): v is import("../../../../util").$TypedObject<V, "org.hypercerts.claim.activity", "main">;
35
34
  export declare function validateMain<V>(v: V): ValidationResult<Main & V>;
36
35
  export { type Main as Record, isMain as isRecord, validateMain as validateRecord, };
37
- /** Logical scope of the work using label-based conditions. All labels in `withinAllOf` must apply; at least one label in `withinAnyOf` must apply if provided; no label in `withinNoneOf` may apply. */
38
- export interface WorkScope {
39
- $type?: 'org.hypercerts.claim.activity#workScope';
40
- /** Labels that MUST all hold for the scope to apply. */
41
- withinAllOf?: string[];
42
- /** Labels of which AT LEAST ONE must hold (optional). If omitted or empty, imposes no additional condition. */
43
- withinAnyOf?: string[];
44
- /** Labels that MUST NOT hold for the scope to apply. */
45
- withinNoneOf?: string[];
46
- }
47
- export declare function isWorkScope<V>(v: V): v is import("../../../../util").$TypedObject<V, "org.hypercerts.claim.activity", "workScope">;
48
- export declare function validateWorkScope<V>(v: V): ValidationResult<WorkScope & V>;
49
36
  export interface ActivityWeight {
50
37
  $type?: 'org.hypercerts.claim.activity#activityWeight';
51
38
  activity: ComAtprotoRepoStrongRef.Main;
@@ -1 +1 @@
1
- {"version":3,"file":"activity.d.ts","sourceRoot":"","sources":["../../../../../../generated/types/org/hypercerts/claim/activity.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,KAAK,gBAAgB,EAAW,MAAM,kBAAkB,CAAA;AAGjE,OAAO,EACL,KAAK,MAAM,EAGZ,MAAM,kBAAkB,CAAA;AACzB,OAAO,KAAK,KAAK,iBAAiB,MAAM,YAAY,CAAA;AACpD,OAAO,KAAK,KAAK,uBAAuB,MAAM,wCAAwC,CAAA;AAMtF,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,+BAA+B,CAAA;IACtC,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,2CAA2C;IAC3C,gBAAgB,EAAE,MAAM,CAAA;IACxB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EACF,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAC7B,MAAM,CAAC,iBAAiB,CAAC,UAAU,CAAC,GACpC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IACrB,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,0BAA0B;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,kLAAkL;IAClL,aAAa,CAAC,EAAE,uBAAuB,CAAC,IAAI,EAAE,CAAA;IAC9C,MAAM,CAAC,EAAE,uBAAuB,CAAC,IAAI,CAAA;IACrC,QAAQ,CAAC,EAAE,uBAAuB,CAAC,IAAI,CAAA;IACvC,2PAA2P;IAC3P,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,wEAAwE;IACxE,SAAS,EAAE,MAAM,CAAA;IACjB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB;AAID,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,4FAE7B;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,8BAEnC;AAED,OAAO,EACL,KAAK,IAAI,IAAI,MAAM,EACnB,MAAM,IAAI,QAAQ,EAClB,YAAY,IAAI,cAAc,GAC/B,CAAA;AAED,wMAAwM;AACxM,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,EAAE,yCAAyC,CAAA;IACjD,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,+GAA+G;IAC/G,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,wDAAwD;IACxD,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;CACxB;AAID,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,iGAElC;AAED,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,mCAExC;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,8CAA8C,CAAA;IACtD,QAAQ,EAAE,uBAAuB,CAAC,IAAI,CAAA;IACtC,oRAAoR;IACpR,MAAM,EAAE,MAAM,CAAA;CACf;AAID,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,sGAEvC;AAED,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,wCAE7C"}
1
+ {"version":3,"file":"activity.d.ts","sourceRoot":"","sources":["../../../../../../generated/types/org/hypercerts/claim/activity.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,KAAK,gBAAgB,EAAW,MAAM,kBAAkB,CAAA;AAGjE,OAAO,EACL,KAAK,MAAM,EAGZ,MAAM,kBAAkB,CAAA;AACzB,OAAO,KAAK,KAAK,iBAAiB,MAAM,YAAY,CAAA;AACpD,OAAO,KAAK,KAAK,uBAAuB,MAAM,wCAAwC,CAAA;AAMtF,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,+BAA+B,CAAA;IACtC,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,2CAA2C;IAC3C,gBAAgB,EAAE,MAAM,CAAA;IACxB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EACF,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAC7B,MAAM,CAAC,iBAAiB,CAAC,UAAU,CAAC,GACpC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IACrB,SAAS,CAAC,EAAE,uBAAuB,CAAC,IAAI,CAAA;IACxC,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,0BAA0B;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iLAAiL;IACjL,aAAa,CAAC,EAAE,uBAAuB,CAAC,IAAI,EAAE,CAAA;IAC9C,MAAM,CAAC,EAAE,uBAAuB,CAAC,IAAI,CAAA;IACrC,8JAA8J;IAC9J,SAAS,CAAC,EAAE,uBAAuB,CAAC,IAAI,EAAE,CAAA;IAC1C,wEAAwE;IACxE,SAAS,EAAE,MAAM,CAAA;IACjB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB;AAID,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,4FAE7B;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,8BAEnC;AAED,OAAO,EACL,KAAK,IAAI,IAAI,MAAM,EACnB,MAAM,IAAI,QAAQ,EAClB,YAAY,IAAI,cAAc,GAC/B,CAAA;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,8CAA8C,CAAA;IACtD,QAAQ,EAAE,uBAAuB,CAAC,IAAI,CAAA;IACtC,oRAAoR;IACpR,MAAM,EAAE,MAAM,CAAA;CACf;AAID,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,sGAEvC;AAED,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,wCAE7C"}
@@ -1,20 +1,20 @@
1
1
  /**
2
2
  * GENERATED CODE - DO NOT MODIFY
3
3
  */
4
- import { type ValidationResult, BlobRef } from '@atproto/lexicon';
5
- import type * as OrgHypercertsClaimActivity from './activity.js';
4
+ import { type ValidationResult } from '@atproto/lexicon';
5
+ import type * as PubLeafletPagesLinearDocument from '../../../pub/leaflet/pages/linearDocument.js';
6
+ import type * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef.js';
6
7
  export interface Main {
7
8
  $type: 'org.hypercerts.claim.collection';
9
+ /** The type of this collection. Possible fields can be 'favorites', 'project', or any other type of collection. */
10
+ type?: string;
8
11
  /** The title of this collection */
9
12
  title: string;
10
- /** A short description of this collection */
13
+ /** Short summary of this collection, suitable for previews and list views */
11
14
  shortDescription?: string;
12
- /** Primary avatar image representing this collection across apps and views; typically a square image. */
13
- avatar?: BlobRef;
14
- /** The cover photo of this collection. */
15
- coverPhoto?: BlobRef;
16
- /** Array of activities with their associated weights in this collection */
17
- activities: OrgHypercertsClaimActivity.ActivityWeight[];
15
+ description?: PubLeafletPagesLinearDocument.Main;
16
+ /** Array of strong references to items in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.claim.collection). */
17
+ items: ComAtprotoRepoStrongRef.Main[];
18
18
  /** Client-declared timestamp when this record was originally created */
19
19
  createdAt: string;
20
20
  [k: string]: unknown;
@@ -1 +1 @@
1
- {"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../../../../generated/types/org/hypercerts/claim/collection.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,KAAK,gBAAgB,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAQjE,OAAO,KAAK,KAAK,0BAA0B,MAAM,eAAe,CAAA;AAMhE,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,iCAAiC,CAAA;IACxC,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAA;IACb,6CAA6C;IAC7C,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,yGAAyG;IACzG,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,0CAA0C;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,2EAA2E;IAC3E,UAAU,EAAE,0BAA0B,CAAC,cAAc,EAAE,CAAA;IACvD,wEAAwE;IACxE,SAAS,EAAE,MAAM,CAAA;IACjB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB;AAID,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,8FAE7B;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,8BAEnC;AAED,OAAO,EACL,KAAK,IAAI,IAAI,MAAM,EACnB,MAAM,IAAI,QAAQ,EAClB,YAAY,IAAI,cAAc,GAC/B,CAAA"}
1
+ {"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../../../../generated/types/org/hypercerts/claim/collection.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,KAAK,gBAAgB,EAAW,MAAM,kBAAkB,CAAA;AAQjE,OAAO,KAAK,KAAK,6BAA6B,MAAM,8CAA8C,CAAA;AAClG,OAAO,KAAK,KAAK,uBAAuB,MAAM,wCAAwC,CAAA;AAMtF,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,iCAAiC,CAAA;IACxC,mHAAmH;IACnH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAA;IACb,6EAA6E;IAC7E,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,WAAW,CAAC,EAAE,6BAA6B,CAAC,IAAI,CAAA;IAChD,kLAAkL;IAClL,KAAK,EAAE,uBAAuB,CAAC,IAAI,EAAE,CAAA;IACrC,wEAAwE;IACxE,SAAS,EAAE,MAAM,CAAA;IACjB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB;AAID,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,8FAE7B;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,8BAEnC;AAED,OAAO,EACL,KAAK,IAAI,IAAI,MAAM,EACnB,MAAM,IAAI,QAAQ,EAClB,YAAY,IAAI,cAAc,GAC/B,CAAA"}
@@ -0,0 +1,31 @@
1
+ /**
2
+ * GENERATED CODE - DO NOT MODIFY
3
+ */
4
+ import { type ValidationResult } from '@atproto/lexicon';
5
+ import { type $Typed } from '../../../../util';
6
+ import type * as OrgHypercertsDefs from '../defs.js';
7
+ export interface Main {
8
+ $type: 'org.hypercerts.claim.contributor';
9
+ /** DID or a URI to a social profile of the contributor. */
10
+ identifier?: string;
11
+ /** Display name of the contributor. */
12
+ displayName?: string;
13
+ image?: $Typed<OrgHypercertsDefs.Uri> | $Typed<OrgHypercertsDefs.SmallImage> | {
14
+ $type: string;
15
+ };
16
+ /** Role or title of the contributor. */
17
+ role?: string;
18
+ /** What the contribution concretely achieved. */
19
+ contributionDescription?: string;
20
+ /** When this contribution started. This should be a subset of the hypercert timeframe. */
21
+ startDate?: string;
22
+ /** When this contribution finished. This should be a subset of the hypercert timeframe. */
23
+ endDate?: string;
24
+ /** Client-declared timestamp when this record was originally created. */
25
+ createdAt: string;
26
+ [k: string]: unknown;
27
+ }
28
+ export declare function isMain<V>(v: V): v is import("../../../../util").$TypedObject<V, "org.hypercerts.claim.contributor", "main">;
29
+ export declare function validateMain<V>(v: V): ValidationResult<Main & V>;
30
+ export { type Main as Record, isMain as isRecord, validateMain as validateRecord, };
31
+ //# sourceMappingURL=contributor.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"contributor.d.ts","sourceRoot":"","sources":["../../../../../../generated/types/org/hypercerts/claim/contributor.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,KAAK,gBAAgB,EAAW,MAAM,kBAAkB,CAAA;AAGjE,OAAO,EACL,KAAK,MAAM,EAGZ,MAAM,kBAAkB,CAAA;AACzB,OAAO,KAAK,KAAK,iBAAiB,MAAM,YAAY,CAAA;AAMpD,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,kCAAkC,CAAA;IACzC,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,uCAAuC;IACvC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EACF,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAC7B,MAAM,CAAC,iBAAiB,CAAC,UAAU,CAAC,GACpC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IACrB,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,iDAAiD;IACjD,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,0FAA0F;IAC1F,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,2FAA2F;IAC3F,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,yEAAyE;IACzE,SAAS,EAAE,MAAM,CAAA;IACjB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB;AAID,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,+FAE7B;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,8BAEnC;AAED,OAAO,EACL,KAAK,IAAI,IAAI,MAAM,EACnB,MAAM,IAAI,QAAQ,EAClB,YAAY,IAAI,cAAc,GAC/B,CAAA"}