@hypercerts-org/lexicon 0.10.0-beta.4 → 0.10.0-beta.6

package/dist/lexicons.cjs

@@ -266,13 +266,7 @@ const schemaDict = {
                 key: 'any',
                 record: {
                     type: 'object',
-                    required: [
-                        'title',
-                        'shortDescription',
-                        'createdAt',
-                        'startDate',
-                        'endDate',
-                    ],
+                    required: ['title', 'shortDescription', 'createdAt'],
                     properties: {
                         title: {
                             type: 'string',
@@ -301,7 +295,8 @@ const schemaDict = {
                         },
                         workScope: {
                             type: 'ref',
-                            ref: 'lex:org.hypercerts.claim.activity#workScope',
+                            ref: 'lex:com.atproto.repo.strongRef',
+                            description: 'A strong reference to a record defining the scope of work. The record referenced should describe the logical scope using label-based conditions.',
                         },
                         startDate: {
                             type: 'string',
@@ -313,12 +308,12 @@ const schemaDict = {
                             format: 'datetime',
                             description: 'When the work ended',
                         },
-                        contributions: {
+                        contributors: {
                             type: 'array',
-                            description: '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.',
+                            description: 'An array of contributor objects, each containing contributor information, weight, and contribution details.',
                             items: {
                                 type: 'ref',
-                                ref: 'lex:com.atproto.repo.strongRef',
+                                ref: 'lex:org.hypercerts.claim.activity#contributor',
                             },
                         },
                         rights: {
@@ -334,11 +329,6 @@ const schemaDict = {
                                 ref: 'lex:com.atproto.repo.strongRef',
                             },
                         },
-                        project: {
-                            type: 'string',
-                            format: 'at-uri',
-                            description: '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.',
-                        },
                         createdAt: {
                             type: 'string',
                             format: 'datetime',
@@ -347,36 +337,42 @@ const schemaDict = {
                     },
                 },
             },
-            workScope: {
+            contributor: {
                 type: 'object',
-                description: '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.',
+                required: ['contributorInformation'],
                 properties: {
-                    withinAllOf: {
-                        type: 'array',
-                        description: 'Labels that MUST all hold for the scope to apply.',
-                        items: {
-                            type: 'string',
-                        },
-                        maxLength: 100,
+                    contributorInformation: {
+                        type: 'union',
+                        refs: [
+                            'lex:org.hypercerts.claim.activity#contributorIdentity',
+                            'lex:com.atproto.repo.strongRef',
+                        ],
+                        description: 'Contributor information as a string (DID or identifier) or strong reference to for instance org.hypercerts.claim.contributorInformation#main.',
                     },
-                    withinAnyOf: {
-                        type: 'array',
-                        description: 'Labels of which AT LEAST ONE must hold (optional). If omitted or empty, imposes no additional condition.',
-                        items: {
-                            type: 'string',
-                        },
-                        maxLength: 100,
+                    weight: {
+                        type: 'string',
+                        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.',
                     },
-                    withinNoneOf: {
-                        type: 'array',
-                        description: 'Labels that MUST NOT hold for the scope to apply.',
-                        items: {
-                            type: 'string',
-                        },
-                        maxLength: 100,
+                    contributionDetails: {
+                        type: 'union',
+                        refs: [
+                            'lex:org.hypercerts.claim.activity#contributorRole',
+                            'lex:com.atproto.repo.strongRef',
+                        ],
+                        description: 'Contribution details as a string or strong reference to org.hypercerts.claim.contributionDetails#main.',
                     },
                 },
             },
+            contributorIdentity: {
+                type: 'string',
+                description: 'Contributor information as a string (DID or identifier).',
+            },
+            contributorRole: {
+                type: 'string',
+                description: 'Contribution details as a string.',
+                maxLength: 10000,
+                maxGraphemes: 1000,
+            },
             activityWeight: {
                 type: 'object',
                 required: ['activity', 'weight'],
@@ -400,12 +396,16 @@ const schemaDict = {
         defs: {
             main: {
                 type: 'record',
-                description: 'A collection/group of hypercerts that have a specific property.',
+                description: 'A collection/group of items (activities and/or other collections). Collections support recursive nesting. Use app.certified.location as a sidecar (same TID) for location metadata.',
                 key: 'tid',
                 record: {
                     type: 'object',
-                    required: ['title', 'activities', 'createdAt'],
+                    required: ['title', 'items', 'createdAt'],
                     properties: {
+                        type: {
+                            type: 'string',
+                            description: "The type of this collection. Possible fields can be 'favorites', 'project', or any other type of collection.",
+                        },
                         title: {
                             type: 'string',
                             description: 'The title of this collection',
@@ -416,26 +416,19 @@ const schemaDict = {
                             type: 'string',
                             maxLength: 3000,
                             maxGraphemes: 300,
-                            description: 'A short description of this collection',
+                            description: 'Short summary of this collection, suitable for previews and list views',
                         },
-                        avatar: {
-                            type: 'blob',
-                            description: 'Primary avatar image representing this collection across apps and views; typically a square image.',
-                            accept: ['image/png', 'image/jpeg'],
-                            maxSize: 1000000,
-                        },
-                        coverPhoto: {
-                            type: 'blob',
-                            description: 'The cover photo of this collection.',
-                            accept: ['image/png', 'image/jpeg'],
-                            maxSize: 1000000,
+                        description: {
+                            type: 'ref',
+                            ref: 'lex:pub.leaflet.pages.linearDocument#main',
+                            description: 'Rich-text description, represented as a Leaflet linear document.',
                         },
-                        activities: {
+                        items: {
                             type: 'array',
-                            description: 'Array of activities with their associated weights in this collection',
+                            description: '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).',
                             items: {
                                 type: 'ref',
-                                ref: 'lex:org.hypercerts.claim.activity#activityWeight',
+                                ref: 'lex:com.atproto.repo.strongRef',
                             },
                         },
                         createdAt: {
@@ -448,35 +441,28 @@ const schemaDict = {
             },
         },
     },
-    OrgHypercertsClaimContribution: {
+    OrgHypercertsClaimContributionDetails: {
         lexicon: 1,
-        id: 'org.hypercerts.claim.contribution',
+        id: 'org.hypercerts.claim.contributionDetails',
         defs: {
             main: {
                 type: 'record',
-                description: "A contribution made toward a hypercert's impact.",
+                description: 'Details about a specific contribution including role, description, and timeframe.',
                 key: 'tid',
                 record: {
                     type: 'object',
-                    required: ['contributors', 'createdAt'],
+                    required: ['createdAt'],
                     properties: {
                         role: {
                             type: 'string',
-                            description: 'Role or title of the contributor(s).',
+                            description: 'Role or title of the contributor.',
                             maxLength: 100,
                         },
-                        contributors: {
-                            type: 'array',
-                            description: 'List of the contributors (names, pseudonyms, or DIDs). If multiple contributors are stored in the same hypercertContribution, then they would have the exact same role.',
-                            items: {
-                                type: 'string',
-                            },
-                        },
-                        description: {
+                        contributionDescription: {
                             type: 'string',
-                            description: 'What the contribution concretely achieved',
-                            maxLength: 2000,
-                            maxGraphemes: 500,
+                            description: 'What the contribution concretely was.',
+                            maxLength: 10000,
+                            maxGraphemes: 1000,
                         },
                         startDate: {
                             type: 'string',
@@ -486,12 +472,51 @@ const schemaDict = {
                         endDate: {
                             type: 'string',
                             format: 'datetime',
-                            description: 'When this contribution finished.  This should be a subset of the hypercert timeframe.',
+                            description: 'When this contribution finished. This should be a subset of the hypercert timeframe.',
                         },
                         createdAt: {
                             type: 'string',
                             format: 'datetime',
-                            description: 'Client-declared timestamp when this record was originally created',
+                            description: 'Client-declared timestamp when this record was originally created.',
+                        },
+                    },
+                },
+            },
+        },
+    },
+    OrgHypercertsClaimContributorInformation: {
+        lexicon: 1,
+        id: 'org.hypercerts.claim.contributorInformation',
+        defs: {
+            main: {
+                type: 'record',
+                description: 'Contributor information including identifier, display name, and image.',
+                key: 'tid',
+                record: {
+                    type: 'object',
+                    required: ['createdAt'],
+                    properties: {
+                        identifier: {
+                            type: 'string',
+                            description: 'DID or a URI to a social profile of the contributor.',
+                        },
+                        displayName: {
+                            type: 'string',
+                            description: 'Display name of the contributor.',
+                            maxLength: 100,
+                        },
+                        image: {
+                            type: 'union',
+                            refs: [
+                                'lex:org.hypercerts.defs#uri',
+                                'lex:org.hypercerts.defs#smallImage',
+                            ],
+                            description: 'The contributor visual representation as a URI or image blob.',
+                        },
+                        createdAt: {
+                            type: 'string',
+                            format: 'datetime',
+                            description: 'Client-declared timestamp when this record was originally created.',
                         },
                     },
                 },
@@ -557,7 +582,7 @@ const schemaDict = {
                         },
                         measurements: {
                             type: 'array',
-                            description: 'Optional references to the measurements that contributed to this evaluation. The record(s) referenced must conform with the lexicon org.hypercerts.claim.measurement ',
+                            description: 'Optional references to the measurements that contributed to this evaluation. The record(s) referenced must conform with the lexicon org.hypercerts.claim.measurement',
                             items: {
                                 type: 'ref',
                                 ref: 'lex:com.atproto.repo.strongRef',
@@ -717,70 +742,6 @@ const schemaDict = {
             },
         },
     },
-    OrgHypercertsClaimProject: {
-        lexicon: 1,
-        id: 'org.hypercerts.claim.project',
-        defs: {
-            main: {
-                type: 'record',
-                description: 'A project that can include multiple activities, each of which may be linked to at most one project.',
-                key: 'tid',
-                record: {
-                    type: 'object',
-                    required: ['title', 'shortDescription', 'createdAt'],
-                    properties: {
-                        title: {
-                            type: 'string',
-                            description: 'Title of this project',
-                            maxLength: 800,
-                            maxGraphemes: 80,
-                        },
-                        shortDescription: {
-                            type: 'string',
-                            maxLength: 3000,
-                            maxGraphemes: 300,
-                            description: 'Short summary of this project, suitable for previews and list views.',
-                        },
-                        description: {
-                            type: 'ref',
-                            ref: 'lex:pub.leaflet.pages.linearDocument#main',
-                            description: 'Rich-text description of this project, represented as a Leaflet linear document.',
-                        },
-                        avatar: {
-                            type: 'blob',
-                            description: 'Primary avatar image representing this project across apps and views; typically a square logo or project identity image.',
-                            accept: ['image/png', 'image/jpeg'],
-                            maxSize: 1000000,
-                        },
-                        coverPhoto: {
-                            type: 'blob',
-                            description: 'The cover photo of this project.',
-                            accept: ['image/png', 'image/jpeg'],
-                            maxSize: 1000000,
-                        },
-                        activities: {
-                            type: 'array',
-                            description: 'Array of activities with their associated weights in this project',
-                            items: {
-                                type: 'ref',
-                                ref: 'lex:org.hypercerts.claim.activity#activityWeight',
-                            },
-                        },
-                        location: {
-                            type: 'ref',
-                            ref: 'lex:com.atproto.repo.strongRef',
-                            description: 'A strong reference to a location record describing where the work for this project took place. The referenced record must conform to the app.certified.location lexicon.',
-                        },
-                        createdAt: {
-                            type: 'string',
-                            format: 'datetime',
-                            description: 'Client-declared timestamp when this record was originally created',
-                        },
-                    },
-                },
-            },
-        },
-    },
     OrgHypercertsClaimRights: {
         lexicon: 1,
         id: 'org.hypercerts.claim.rights',
@@ -987,11 +948,11 @@ const ids = {
     ComAtprotoRepoStrongRef: 'com.atproto.repo.strongRef',
     OrgHypercertsClaimActivity: 'org.hypercerts.claim.activity',
     OrgHypercertsClaimCollection: 'org.hypercerts.claim.collection',
-    OrgHypercertsClaimContribution: 'org.hypercerts.claim.contribution',
+    OrgHypercertsClaimContributionDetails: 'org.hypercerts.claim.contributionDetails',
+    OrgHypercertsClaimContributorInformation: 'org.hypercerts.claim.contributorInformation',
     OrgHypercertsClaimEvaluation: 'org.hypercerts.claim.evaluation',
     OrgHypercertsClaimEvidence: 'org.hypercerts.claim.evidence',
     OrgHypercertsClaimMeasurement: 'org.hypercerts.claim.measurement',
-    OrgHypercertsClaimProject: 'org.hypercerts.claim.project',
     OrgHypercertsClaimRights: 'org.hypercerts.claim.rights',
     OrgHypercertsDefs: 'org.hypercerts.defs',
     OrgHypercertsFundingReceipt: 'org.hypercerts.funding.receipt',