@hypercerts-org/lexicon 0.2.0-beta.0

package/lexicons/org/hypercerts/collection.json

@@ -0,0 +1,62 @@
+{
+  "lexicon": 1,
+  "id": "org.hypercerts.collection",
+  "defs": {
+    "main": {
+      "type": "record",
+      "description": "A collection/group of hypercerts that have a specific property.",
+      "key": "tid",
+      "record": {
+        "type": "object",
+        "required": ["title", "claims", "createdAt"],
+        "properties": {
+          "title": {
+            "type": "string",
+            "description": "The title of this collection",
+            "maxLength": 800,
+            "maxGraphemes": 80
+          },
+          "shortDescription": {
+            "type": "string",
+            "maxLength": 3000,
+            "maxGraphemes": 300,
+            "description": "A short description of this collection"
+          },
+          "coverPhoto": {
+            "type": "union",
+            "refs": ["app.certified.defs#uri", "app.certified.defs#smallBlob"],
+            "description": "The cover photo of this collection (either in URI format or in a blob)."
+          },
+          "claims": {
+            "type": "array",
+            "description": "Array of claims with their associated weights in this collection",
+            "items": {
+              "type": "ref",
+              "ref": "#claimItem"
+            }
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "datetime",
+            "description": "Client-declared timestamp when this record was originally created"
+          }
+        }
+      }
+    },
+      "claimItem": {
+        "type": "object",
+        "required": ["claim", "weight"],
+        "properties": {
+          "claim": {
+            "type": "ref",
+            "ref": "com.atproto.repo.strongRef",
+            "description": "A strong reference to a hypercert claim record. This claim must conform to the lexicon org.hypercerts.claim.record"
+          },
+          "weight": {
+            "type": "string",
+            "description": "The weight/importance of this hypercert claim in the collection (a percentage from 0-100, stored as a string to avoid float precision issues). The total claim weights should add up to 100."
+          }
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@hypercerts-org/lexicon",
+  "version": "0.2.0-beta.0",
+  "description": "ATProto lexicon definitions and TypeScript types for the Hypercerts protocol",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "lexicons",
+    "src"
+  ],
+  "keywords": [
+    "hypercerts",
+    "atproto",
+    "lexicon",
+    "typescript"
+  ],
+  "author": "Hypercerts Foundation",
+  "license": "MIT",
+  "repository": {
+    "url": "https://github.com/hypercerts-org/hypercerts-sdk.git"
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "gen-api": "find ./lexicons -name '*.json' | xargs lex gen-api --yes ./src",
+    "gen-md": "find ./lexicons -name '*.json' | xargs lex gen-md --yes ./lexicons.md",
+    "gen-ts": "find ./lexicons -name '*.json' | xargs lex gen-ts-obj > src/lexicons.ts",
+    "lex": "lex",
+    "prepublishOnly": "pnpm run build"
+  },
+  "dependencies": {
+    "@atproto/lexicon": "^0.5.1",
+    "multiformats": "^13.3.6"
+  },
+  "devDependencies": {
+    "@atproto/lex-cli": "^0.9.5",
+    "@atproto/xrpc": "^0.7.5",
+    "@rollup/plugin-commonjs": "^29.0.0",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-typescript": "^12.3.0",
+    "rollup": "^4.53.3",
+    "rollup-plugin-dts": "^6.2.3"
+  },
+  "peerDependencies": {
+    "@atproto/xrpc": "*"
+  },
+  "sideEffects": false
+}

package/src/index.ts

@@ -0,0 +1,118 @@
+/**
+ * Hypercert lexicon definitions for AT Protocol.
+ *
+ * This module exports the lexicon documents, collection names,
+ * and generated TypeScript types for all hypercert-related record types.
+ *
+ * @packageDocumentation
+ */
+
+import defsLexicon from "../lexicons/app/certified/defs.json";
+import locationLexicon from "../lexicons/app/certified/location.json";
+import claimLexicon from "../lexicons/org/hypercerts/claim.json";
+import contributionLexicon from "../lexicons/org/hypercerts/claim/contribution.json";
+import evaluationLexicon from "../lexicons/org/hypercerts/claim/evaluation.json";
+import evidenceLexicon from "../lexicons/org/hypercerts/claim/evidence.json";
+import measurementLexicon from "../lexicons/org/hypercerts/claim/measurement.json";
+import rightsLexicon from "../lexicons/org/hypercerts/claim/rights.json";
+import strongRefLexicon from "../lexicons/com/atproto/repo/strongRef.json";
+import collectionLexicon from "../lexicons/org/hypercerts/collection.json";
+import type { LexiconDoc } from "@atproto/lexicon";
+
+/**
+ * All hypercert-related lexicons for registration with AT Protocol Agent.
+ *
+ * This array contains all lexicon documents needed to work with
+ * hypercert records.
+ */
+export const HYPERCERT_LEXICONS: LexiconDoc[] = [
+  defsLexicon as LexiconDoc,
+  locationLexicon as LexiconDoc,
+  claimLexicon as LexiconDoc,
+  rightsLexicon as LexiconDoc,
+  contributionLexicon as LexiconDoc,
+  measurementLexicon as LexiconDoc,
+  evaluationLexicon as LexiconDoc,
+  evidenceLexicon as LexiconDoc,
+  collectionLexicon as LexiconDoc,
+];
+
+/**
+ * Collection NSIDs (Namespaced Identifiers) for hypercert records.
+ *
+ * Use these constants when performing record operations to ensure
+ * correct collection names.
+ */
+export const HYPERCERT_COLLECTIONS = {
+  /**
+   * Main hypercert claim record collection.
+   */
+  CLAIM: "org.hypercerts.claim",
+
+  /**
+   * Rights record collection.
+   */
+  RIGHTS: "org.hypercerts.claim.rights",
+
+  /**
+   * Location record collection (shared certified lexicon).
+   */
+  LOCATION: "app.certified.location",
+
+  /**
+   * Contribution record collection.
+   */
+  CONTRIBUTION: "org.hypercerts.claim.contribution",
+
+  /**
+   * Measurement record collection.
+   */
+  MEASUREMENT: "org.hypercerts.claim.measurement",
+
+  /**
+   * Evaluation record collection.
+   */
+  EVALUATION: "org.hypercerts.claim.evaluation",
+
+  /**
+   * Evidence record collection.
+   */
+  EVIDENCE: "org.hypercerts.claim.evidence",
+
+  /**
+   * Collection record collection (groups of hypercerts).
+   */
+  COLLECTION: "org.hypercerts.collection",
+} as const;
+
+// Re-export individual lexicons for direct access
+export {
+  defsLexicon,
+  locationLexicon,
+  strongRefLexicon,
+  claimLexicon,
+  contributionLexicon,
+  evaluationLexicon,
+  evidenceLexicon,
+  measurementLexicon,
+  rightsLexicon,
+  collectionLexicon,
+};
+
+// Re-export generated types as namespaces (avoiding conflicts)
+export * as AppCertifiedDefs from "./types/app/certified/defs.js";
+export * as AppCertifiedLocation from "./types/app/certified/location.js";
+export * as ComAtprotoRepoStrongRef from "./types/com/atproto/repo/strongRef.js";
+export * as OrgHypercertsClaim from "./types/org/hypercerts/claim.js";
+export * as OrgHypercertsClaimContribution from "./types/org/hypercerts/claim/contribution.js";
+export * as OrgHypercertsClaimEvaluation from "./types/org/hypercerts/claim/evaluation.js";
+export * as OrgHypercertsClaimEvidence from "./types/org/hypercerts/claim/evidence.js";
+export * as OrgHypercertsClaimMeasurement from "./types/org/hypercerts/claim/measurement.js";
+export * as OrgHypercertsClaimRights from "./types/org/hypercerts/claim/rights.js";
+export * as OrgHypercertsCollection from "./types/org/hypercerts/collection.js";
+
+// Re-export lexicon schemas, validation, and IDs
+export { schemas, schemaDict, lexicons, validate, ids } from "./lexicons.js";
+
+// Re-export utilities
+export * from "./util.js";