Merge pull request #120 from hypercerts-org/measurements-migration

Author: aspiers

.changeset/update-measurement-api.md

@@ -0,0 +1,33 @@
+---
+"@hypercerts-org/sdk-core": minor
+"@hypercerts-org/sdk-react": minor
+---
+
+Update measurement API to align with lexicon beta.12+ schema
+
+**Breaking Changes (sdk-core):**
+
+- `addMeasurement()` now accepts `CreateMeasurementParams` instead of individual parameters
+- `subject` field replaces `hypercertUri` and accepts both string AT-URIs and StrongRefs
+- `unit` is now a required field (e.g., "tons CO2e", "hectares", "%")
+- `measurers` is now optional instead of required
+- Field name changes: `methodUri` → `methodURI`, `evidenceUris` → `evidenceURI`
+
+**Breaking Changes (sdk-react):**
+
+- Removed `OrgHypercertsDefs` export (WorkScope types removed from lexicon)
+- `UpdateHypercertParams.workScope` now accepts `string | StrongRef` (i.e., `string | { uri: string; cid: string }`)
+
+**New Features:**
+
+- Added `updateMeasurement()` method with `UpdateMeasurementParams` type (subject is immutable)
+- Support for `locations` array to specify where measurements were taken
+- Added `startDate` and `endDate` for measurement timeframes
+- Added `methodType` for short methodology identifiers
+- Rich text support via `comment` and `commentFacets` fields
+
+**Internal Improvements:**
+
+- Added `resolveToStrongRef` utility for handling string/StrongRef conversions
+- Updated evidence handling to use `HypercertAttachment` schema (beta.13 compatibility)
+- Improved error messages in URI resolution functions

packages/sdk-core/package.json

@@ -88,7 +88,7 @@
     "@atproto/lexicon": "^0.5.1",
     "@atproto/oauth-client": "^0.5.10",
     "@atproto/oauth-client-node": "^0.3.12",
-    "@hypercerts-org/lexicon": "0.10.0-beta.11",
+    "@hypercerts-org/lexicon": "0.10.0-beta.13",
     "eventemitter3": "^5.0.1",
     "type-fest": "^5.4.1",
     "zod": "^3.24.4"

packages/sdk-core/src/index.ts

@@ -114,7 +114,7 @@ export {
   OrgHypercertsClaimContributorInformation,
   OrgHypercertsClaimMeasurement,
   OrgHypercertsClaimEvaluation,
-  OrgHypercertsClaimEvidence,
+  OrgHypercertsClaimAttachment,
   OrgHypercertsClaimCollection,
   OrgHypercertsHelperWorkScopeTag,
   AppCertifiedLocation,

packages/sdk-core/src/lexicons.ts

@@ -70,7 +70,7 @@ import {
   CONTRIBUTION_DETAILS_LEXICON_JSON,
   CONTRIBUTOR_INFORMATION_LEXICON_JSON,
   EVALUATION_LEXICON_JSON,
-  EVIDENCE_LEXICON_JSON,
+  ATTACHMENT_LEXICON_JSON,
   MEASUREMENT_LEXICON_JSON,
   RIGHTS_LEXICON_JSON,
   BADGE_AWARD_LEXICON_JSON,
@@ -86,7 +86,7 @@ import {
   CONTRIBUTOR_INFORMATION_NSID,
   MEASUREMENT_NSID,
   EVALUATION_NSID,
-  EVIDENCE_NSID,
+  ATTACHMENT_NSID,
   COLLECTION_NSID,
   BADGE_AWARD_NSID,
   BADGE_DEFINITION_NSID,
@@ -113,7 +113,7 @@ export const HYPERCERT_LEXICONS: LexiconDoc[] = [
   CONTRIBUTION_DETAILS_LEXICON_JSON as LexiconDoc,
   CONTRIBUTOR_INFORMATION_LEXICON_JSON as LexiconDoc,
   EVALUATION_LEXICON_JSON as LexiconDoc,
-  EVIDENCE_LEXICON_JSON as LexiconDoc,
+  ATTACHMENT_LEXICON_JSON as LexiconDoc,
   MEASUREMENT_LEXICON_JSON as LexiconDoc,
   RIGHTS_LEXICON_JSON as LexiconDoc,
   BADGE_AWARD_LEXICON_JSON as LexiconDoc,
@@ -168,9 +168,15 @@ export const HYPERCERT_COLLECTIONS = {
   EVALUATION: EVALUATION_NSID,
 
   /**
-   * Evidence record collection.
+   * Attachment record collection (formerly evidence).
+   * @remarks Renamed from EVIDENCE in beta.13
    */
-  EVIDENCE: EVIDENCE_NSID,
+  ATTACHMENT: ATTACHMENT_NSID,
+
+  /**
+   * @deprecated Use ATTACHMENT instead. Renamed in beta.13.
+   */
+  EVIDENCE: ATTACHMENT_NSID,
 
   /**
    * Collection record collection (groups of hypercerts).