@hypercerts-org/sdk-core 0.7.0-beta.0 → 0.9.0-beta.0

package/dist/index.d.ts

@@ -1179,13 +1179,13 @@ interface CreateHypercertParams {
      *
      * ISO 8601 date format (YYYY-MM-DD).
      */
-    workTimeframeFrom: string;
+    workTimeFrameFrom: string;
     /**
      * End date of the work period.
      *
      * ISO 8601 date format (YYYY-MM-DD).
      */
-    workTimeframeTo: string;
+    workTimeFrameTo: string;
     /**
      * Rights associated with the hypercert.
      */
@@ -1210,11 +1210,11 @@ interface CreateHypercertParams {
         description: string;
     };
     /**
-     * Optional short description for display in lists/cards.
+     * Short description for display in lists/cards.
      *
-     * Should be under 200 characters.
+     * Required field. Should be under 300 characters.
      */
-    shortDescription?: string;
+    shortDescription: string;
     /**
      * Optional cover image for the hypercert.
      *
@@ -1242,11 +1242,11 @@ interface CreateHypercertParams {
          */
         description?: string;
         /**
-         * Spatial Reference System identifier.
+         * Spatial Reference System identifier (required if location is provided).
          *
          * @example "EPSG:4326" for WGS84
          */
-        srs?: string;
+        srs: string;
         /**
          * GeoJSON file as a Blob for precise boundaries.
          */
@@ -1723,13 +1723,18 @@ interface HypercertOperations extends EventEmitter<HypercertEvents> {
      *
      * @param uri - AT-URI of the hypercert
      * @param location - Location data
+     * @param location.value - Location value (address, coordinates, or description)
+     * @param location.srs - Spatial Reference System (required). Use 'EPSG:4326' for WGS84 lat/lon coordinates.
+     * @param location.name - Optional human-readable location name
+     * @param location.description - Optional description of the location
+     * @param location.geojson - Optional GeoJSON blob for precise boundaries
      * @returns Promise resolving to location record result
      */
     attachLocation(uri: string, location: {
         value: string;
         name?: string;
         description?: string;
-        srs?: string;
+        srs: string;
         geojson?: Blob;
     }): Promise<CreateResult>;
     /**

package/dist/index.mjs

@@ -2269,6 +2269,7 @@ class HypercertOperationsImpl extends EventEmitter {
             // Step 2: Create rights record
             this.emitProgress(params.onProgress, { name: "createRights", status: "start" });
             const rightsRecord = {
+                $type: HYPERCERT_COLLECTIONS.RIGHTS,
                 rightsName: params.rights.name,
                 rightsType: params.rights.type,
                 rightsDescription: params.rights.description,
@@ -2297,17 +2298,16 @@ class HypercertOperationsImpl extends EventEmitter {
             // Step 3: Create hypercert record
             this.emitProgress(params.onProgress, { name: "createHypercert", status: "start" });
             const hypercertRecord = {
+                $type: HYPERCERT_COLLECTIONS.CLAIM,
                 title: params.title,
+                shortDescription: params.shortDescription,
                 description: params.description,
                 workScope: params.workScope,
-                workTimeframeFrom: params.workTimeframeFrom,
-                workTimeframeTo: params.workTimeframeTo,
+                workTimeFrameFrom: params.workTimeFrameFrom,
+                workTimeFrameTo: params.workTimeFrameTo,
                 rights: { uri: result.rightsUri, cid: result.rightsCid },
                 createdAt,
             };
-            if (params.shortDescription) {
-                hypercertRecord.shortDescription = params.shortDescription;
-            }
             if (imageBlobRef) {
                 hypercertRecord.image = imageBlobRef;
             }
@@ -2644,6 +2644,7 @@ class HypercertOperationsImpl extends EventEmitter {
      * await repo.hypercerts.attachLocation(hypercertUri, {
      *   value: "San Francisco, CA",
      *   name: "SF Bay Area",
+     *   srs: "EPSG:4326",
      * });
      * ```
      *
@@ -2662,32 +2663,54 @@ class HypercertOperationsImpl extends EventEmitter {
      */
     async attachLocation(hypercertUri, location) {
         try {
-            // Get hypercert to get CID
-            const hypercert = await this.get(hypercertUri);
+            // Validate required srs field
+            if (!location.srs) {
+                throw new ValidationError("srs (Spatial Reference System) is required. Example: 'EPSG:4326' for WGS84 coordinates, or 'http://www.opengis.net/def/crs/OGC/1.3/CRS84' for CRS84.");
+            }
+            // Validate that hypercert exists (unused but confirms hypercert is valid)
+            await this.get(hypercertUri);
             const createdAt = new Date().toISOString();
-            let locationValue = location.value;
+            // Determine location type and prepare location data
+            let locationData;
+            let locationType;
             if (location.geojson) {
+                // Upload GeoJSON as a blob
                 const arrayBuffer = await location.geojson.arrayBuffer();
                 const uint8Array = new Uint8Array(arrayBuffer);
                 const uploadResult = await this.agent.com.atproto.repo.uploadBlob(uint8Array, {
                     encoding: location.geojson.type || "application/geo+json",
                 });
                 if (uploadResult.success) {
-                    locationValue = {
+                    locationData = {
                         $type: "blob",
                         ref: { $link: uploadResult.data.blob.ref.toString() },
                         mimeType: uploadResult.data.blob.mimeType,
                         size: uploadResult.data.blob.size,
                     };
+                    locationType = "geojson-point";
+                }
+                else {
+                    throw new NetworkError("Failed to upload GeoJSON blob");
                 }
             }
+            else {
+                // Use value as a URI reference
+                locationData = {
+                    $type: "app.certified.defs#uri",
+                    uri: location.value,
+                };
+                locationType = "coordinate-decimal";
+            }
+            // Build location record according to app.certified.location lexicon
             const locationRecord = {
-                hypercert: { uri: hypercert.uri, cid: hypercert.cid },
-                value: locationValue,
+                $type: HYPERCERT_COLLECTIONS.LOCATION,
+                lpVersion: "1.0",
+                srs: location.srs,
+                locationType,
+                location: locationData,
                 createdAt,
                 name: location.name,
                 description: location.description,
-                srs: location.srs,
             };
             const validation = this.lexiconRegistry.validate(HYPERCERT_COLLECTIONS.LOCATION, locationRecord);
             if (!validation.valid) {
@@ -2774,10 +2797,12 @@ class HypercertOperationsImpl extends EventEmitter {
         try {
             const createdAt = new Date().toISOString();
             const contributionRecord = {
+                $type: HYPERCERT_COLLECTIONS.CONTRIBUTION,
                 contributors: params.contributors,
                 role: params.role,
                 createdAt,
                 description: params.description,
+                hypercert: { uri: "", cid: "" }, // Will be set below if hypercertUri provided
             };
             if (params.hypercertUri) {
                 const hypercert = await this.get(params.hypercertUri);
@@ -2838,6 +2863,7 @@ class HypercertOperationsImpl extends EventEmitter {
             const hypercert = await this.get(params.hypercertUri);
             const createdAt = new Date().toISOString();
             const measurementRecord = {
+                $type: HYPERCERT_COLLECTIONS.MEASUREMENT,
                 hypercert: { uri: hypercert.uri, cid: hypercert.cid },
                 measurers: params.measurers,
                 metric: params.metric,
@@ -2893,6 +2919,7 @@ class HypercertOperationsImpl extends EventEmitter {
             const subject = await this.get(params.subjectUri);
             const createdAt = new Date().toISOString();
             const evaluationRecord = {
+                $type: HYPERCERT_COLLECTIONS.EVALUATION,
                 subject: { uri: subject.uri, cid: subject.cid },
                 evaluators: params.evaluators,
                 summary: params.summary,
@@ -2967,6 +2994,7 @@ class HypercertOperationsImpl extends EventEmitter {
                 }
             }
             const collectionRecord = {
+                $type: HYPERCERT_COLLECTIONS.COLLECTION,
                 title: params.title,
                 claims: params.claims.map((c) => ({ claim: { uri: c.uri, cid: c.cid }, weight: c.weight })),
                 createdAt,