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

package/lexicons/org/hypercerts/claim/collection.json

@@ -4,12 +4,16 @@
   "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",
@@ -20,26 +24,19 @@
             "type": "string",
             "maxLength": 3000,
             "maxGraphemes": 300,
-            "description": "A short description of this collection"
-          },
-          "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
+            "description": "Short summary of this collection, suitable for previews and list views"
           },
-          "coverPhoto": {
-            "type": "blob",
-            "description": "The cover photo of this collection.",
-            "accept": ["image/png", "image/jpeg"],
-            "maxSize": 1000000
+          "description": {
+            "type": "ref",
+            "ref": "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": "org.hypercerts.claim.activity#activityWeight"
+              "ref": "com.atproto.repo.strongRef"
             }
           },
           "createdAt": {

package/lexicons/org/hypercerts/claim/contributionDetails.json

@@ -0,0 +1,43 @@
+{
+  "lexicon": 1,
+  "id": "org.hypercerts.claim.contributionDetails",
+  "defs": {
+    "main": {
+      "type": "record",
+      "description": "Details about a specific contribution including role, description, and timeframe.",
+      "key": "tid",
+      "record": {
+        "type": "object",
+        "required": ["createdAt"],
+        "properties": {
+          "role": {
+            "type": "string",
+            "description": "Role or title of the contributor.",
+            "maxLength": 100
+          },
+          "contributionDescription": {
+            "type": "string",
+            "description": "What the contribution concretely was.",
+            "maxLength": 10000,
+            "maxGraphemes": 1000
+          },
+          "startDate": {
+            "type": "string",
+            "format": "datetime",
+            "description": "When this contribution started. This should be a subset of the hypercert timeframe."
+          },
+          "endDate": {
+            "type": "string",
+            "format": "datetime",
+            "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."
+          }
+        }
+      }
+    }
+  }
+}

package/lexicons/org/hypercerts/claim/contributorInformation.json

@@ -0,0 +1,39 @@
+{
+  "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": [
+              "org.hypercerts.defs#uri",
+              "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."
+          }
+        }
+      }
+    }
+  }
+}

package/lexicons/org/hypercerts/claim/evaluation.json

@@ -57,7 +57,7 @@
           },
           "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": "com.atproto.repo.strongRef"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hypercerts-org/lexicon",
-  "version": "0.10.0-beta.4",
+  "version": "0.10.0-beta.6",
   "description": "ATProto lexicon definitions and TypeScript types for the Hypercerts protocol",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -22,6 +22,7 @@
   "files": [
     "dist",
     "lexicons",
+    "SCHEMAS.md",
     "CHANGELOG.md"
   ],
   "keywords": [
@@ -43,6 +44,7 @@
     "build:types": "tsc --project tsconfig.build.json",
     "gen-api": "find ./lexicons -name '*.json' | xargs lex gen-api --yes ./generated && ./scripts/create-shims.sh && npm run gen-index",
     "gen-md": "find ./lexicons -name '*.json' | xargs lex gen-md --yes ./lexicons.md",
+    "gen-schemas-md": "node ./scripts/generate-schemas.js",
     "//gen-ts": "UNUSED - use gen-api instead",
     "gen-ts": "find ./lexicons -name '*.json' | xargs lex gen-ts-obj > generated/DO-NOT-USE-lexicons.ts",
     "gen-index": "node ./scripts/generate-exports.js",
@@ -58,7 +60,8 @@
     "prepublishOnly": "npm run check",
     "changeset": "changeset",
     "version-packages": "changeset version && npm install --package-lock-only",
-    "release": "npm run check && changeset publish"
+    "release": "npm run check && changeset publish",
+    "prepare": "husky && ./scripts/setup-merge-driver.sh"
   },
   "dependencies": {
     "@atcute/leaflet": "^1.0.15",
@@ -77,6 +80,7 @@
     "@rollup/plugin-typescript": "^12.3.0",
     "eslint": "^9.39.2",
     "globals": "^17.0.0",
+    "husky": "^9.1.7",
     "prettier": "^3.2.5",
     "rollup": "^4.53.3",
     "tslib": "^2.8.1",

package/dist/generated/types/org/hypercerts/claim/contribution.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"contribution.d.ts","sourceRoot":"","sources":["../../../../../../generated/types/org/hypercerts/claim/contribution.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,KAAK,gBAAgB,EAAW,MAAM,kBAAkB,CAAA;AAajE,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,mCAAmC,CAAA;IAC1C,2CAA2C;IAC3C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,8KAA8K;IAC9K,YAAY,EAAE,MAAM,EAAE,CAAA;IACtB,gDAAgD;IAChD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0FAA0F;IAC1F,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,4FAA4F;IAC5F,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,gGAE7B;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"}

package/dist/generated/types/org/hypercerts/claim/project.d.ts

@@ -1,29 +0,0 @@
-/**
- * GENERATED CODE - DO NOT MODIFY
- */
-import { type ValidationResult, BlobRef } from '@atproto/lexicon';
-import type * as PubLeafletPagesLinearDocument from '../../../pub/leaflet/pages/linearDocument.js';
-import type * as OrgHypercertsClaimActivity from './activity.js';
-import type * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef.js';
-export interface Main {
-    $type: 'org.hypercerts.claim.project';
-    /** Title of this project */
-    title: string;
-    /** Short summary of this project, suitable for previews and list views. */
-    shortDescription: string;
-    description?: PubLeafletPagesLinearDocument.Main;
-    /** Primary avatar image representing this project across apps and views; typically a square logo or project identity image. */
-    avatar?: BlobRef;
-    /** The cover photo of this project. */
-    coverPhoto?: BlobRef;
-    /** Array of activities with their associated weights in this project */
-    activities?: OrgHypercertsClaimActivity.ActivityWeight[];
-    location?: ComAtprotoRepoStrongRef.Main;
-    /** Client-declared timestamp when this record was originally created */
-    createdAt: string;
-    [k: string]: unknown;
-}
-export declare function isMain<V>(v: V): v is import("../../../../util").$TypedObject<V, "org.hypercerts.claim.project", "main">;
-export declare function validateMain<V>(v: V): ValidationResult<Main & V>;
-export { type Main as Record, isMain as isRecord, validateMain as validateRecord, };
-//# sourceMappingURL=project.d.ts.map

package/dist/generated/types/org/hypercerts/claim/project.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"project.d.ts","sourceRoot":"","sources":["../../../../../../generated/types/org/hypercerts/claim/project.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,KAAK,gBAAgB,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAQjE,OAAO,KAAK,KAAK,6BAA6B,MAAM,8CAA8C,CAAA;AAClG,OAAO,KAAK,KAAK,0BAA0B,MAAM,eAAe,CAAA;AAChE,OAAO,KAAK,KAAK,uBAAuB,MAAM,wCAAwC,CAAA;AAMtF,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,8BAA8B,CAAA;IACrC,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAA;IACb,2EAA2E;IAC3E,gBAAgB,EAAE,MAAM,CAAA;IACxB,WAAW,CAAC,EAAE,6BAA6B,CAAC,IAAI,CAAA;IAChD,+HAA+H;IAC/H,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,uCAAuC;IACvC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,wEAAwE;IACxE,UAAU,CAAC,EAAE,0BAA0B,CAAC,cAAc,EAAE,CAAA;IACxD,QAAQ,CAAC,EAAE,uBAAuB,CAAC,IAAI,CAAA;IACvC,wEAAwE;IACxE,SAAS,EAAE,MAAM,CAAA;IACjB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB;AAID,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,2FAE7B;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"}

package/dist/types/org/hypercerts/claim/contribution.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"contribution.d.ts","sourceRoot":"","sources":["../../../../../generated/types/org/hypercerts/claim/contribution.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,KAAK,gBAAgB,EAAW,MAAM,kBAAkB,CAAA;AAajE,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,mCAAmC,CAAA;IAC1C,2CAA2C;IAC3C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,8KAA8K;IAC9K,YAAY,EAAE,MAAM,EAAE,CAAA;IACtB,gDAAgD;IAChD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0FAA0F;IAC1F,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,4FAA4F;IAC5F,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,gGAE7B;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"}

package/dist/types/org/hypercerts/claim/project.d.ts

@@ -1,29 +0,0 @@
-/**
- * GENERATED CODE - DO NOT MODIFY
- */
-import { type ValidationResult, BlobRef } from '@atproto/lexicon';
-import type * as PubLeafletPagesLinearDocument from '../../../pub/leaflet/pages/linearDocument.js';
-import type * as OrgHypercertsClaimActivity from './activity.js';
-import type * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef.js';
-export interface Main {
-    $type: 'org.hypercerts.claim.project';
-    /** Title of this project */
-    title: string;
-    /** Short summary of this project, suitable for previews and list views. */
-    shortDescription: string;
-    description?: PubLeafletPagesLinearDocument.Main;
-    /** Primary avatar image representing this project across apps and views; typically a square logo or project identity image. */
-    avatar?: BlobRef;
-    /** The cover photo of this project. */
-    coverPhoto?: BlobRef;
-    /** Array of activities with their associated weights in this project */
-    activities?: OrgHypercertsClaimActivity.ActivityWeight[];
-    location?: ComAtprotoRepoStrongRef.Main;
-    /** Client-declared timestamp when this record was originally created */
-    createdAt: string;
-    [k: string]: unknown;
-}
-export declare function isMain<V>(v: V): v is import("../../../../util").$TypedObject<V, "org.hypercerts.claim.project", "main">;
-export declare function validateMain<V>(v: V): ValidationResult<Main & V>;
-export { type Main as Record, isMain as isRecord, validateMain as validateRecord, };
-//# sourceMappingURL=project.d.ts.map

package/dist/types/org/hypercerts/claim/project.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"project.d.ts","sourceRoot":"","sources":["../../../../../generated/types/org/hypercerts/claim/project.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,KAAK,gBAAgB,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAQjE,OAAO,KAAK,KAAK,6BAA6B,MAAM,8CAA8C,CAAA;AAClG,OAAO,KAAK,KAAK,0BAA0B,MAAM,eAAe,CAAA;AAChE,OAAO,KAAK,KAAK,uBAAuB,MAAM,wCAAwC,CAAA;AAMtF,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,8BAA8B,CAAA;IACrC,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAA;IACb,2EAA2E;IAC3E,gBAAgB,EAAE,MAAM,CAAA;IACxB,WAAW,CAAC,EAAE,6BAA6B,CAAC,IAAI,CAAA;IAChD,+HAA+H;IAC/H,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,uCAAuC;IACvC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,wEAAwE;IACxE,UAAU,CAAC,EAAE,0BAA0B,CAAC,cAAc,EAAE,CAAA;IACxD,QAAQ,CAAC,EAAE,uBAAuB,CAAC,IAAI,CAAA;IACvC,wEAAwE;IACxE,SAAS,EAAE,MAAM,CAAA;IACjB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB;AAID,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,2FAE7B;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"}

package/lexicons/org/hypercerts/claim/contribution.json

@@ -1,50 +0,0 @@
-{
-  "lexicon": 1,
-  "id": "org.hypercerts.claim.contribution",
-  "defs": {
-    "main": {
-      "type": "record",
-      "description": "A contribution made toward a hypercert's impact.",
-      "key": "tid",
-      "record": {
-        "type": "object",
-        "required": ["contributors", "createdAt"],
-        "properties": {
-          "role": {
-            "type": "string",
-            "description": "Role or title of the contributor(s).",
-            "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": {
-            "type": "string",
-            "description": "What the contribution concretely achieved",
-            "maxLength": 2000,
-            "maxGraphemes": 500
-          },
-          "startDate": {
-            "type": "string",
-            "format": "datetime",
-            "description": "When this contribution started. This should be a subset of the hypercert timeframe."
-          },
-          "endDate": {
-            "type": "string",
-            "format": "datetime",
-            "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"
-          }
-        }
-      }
-    }
-  }
-}

package/lexicons/org/hypercerts/claim/project.json

@@ -1,64 +0,0 @@
-{
-  "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": "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": "org.hypercerts.claim.activity#activityWeight"
-            }
-          },
-          "location": {
-            "type": "ref",
-            "ref": "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"
-          }
-        }
-      }
-    }
-  }
-}