@hypercerts-org/sdk-core 0.6.0-beta.0 → 0.8.0-beta.0

package/README.md

@@ -44,7 +44,100 @@ const claim = await repo.hypercerts.create({
 
 ## Core Concepts
 
-### 1. Authentication
+### 1. PDS vs SDS: Understanding Server Types
+
+The SDK supports two types of AT Protocol servers:
+
+#### Personal Data Server (PDS)
+- **Purpose**: User's own data storage (e.g., Bluesky)
+- **Use case**: Individual hypercerts, personal records
+- **Features**: Profile management, basic CRUD operations
+- **Example**: `bsky.social`, any Bluesky PDS
+
+#### Shared Data Server (SDS)
+- **Purpose**: Collaborative data storage with access control
+- **Use case**: Organization hypercerts, team collaboration
+- **Features**: Organizations, multi-user access, role-based permissions
+- **Example**: `sds.hypercerts.org`
+
+```typescript
+// Connect to user's PDS (default)
+const pdsRepo = sdk.repository(session);
+await pdsRepo.hypercerts.create({ ... }); // Creates in user's PDS
+
+// Connect to SDS for collaboration features
+const sdsRepo = sdk.repository(session, { server: "sds" });
+await sdsRepo.organizations.create({ name: "My Org" }); // SDS-only feature
+
+// Switch to organization repository (still on SDS)
+const orgs = await sdsRepo.organizations.list();
+const orgRepo = sdsRepo.repo(orgs.organizations[0].did);
+await orgRepo.hypercerts.list(); // Queries organization's hypercerts on SDS
+```
+
+#### How Repository Routing Works
+
+The SDK uses a `ConfigurableAgent` to route requests to different servers while maintaining your OAuth authentication:
+
+1. **Initial Repository Creation**
+   ```typescript
+   // User authenticates (OAuth session knows user's PDS)
+   const session = await sdk.callback(params);
+   
+   // Create PDS repository - routes to user's PDS
+   const pdsRepo = sdk.repository(session);
+   
+   // Create SDS repository - routes to SDS server
+   const sdsRepo = sdk.repository(session, { server: "sds" });
+   ```
+
+2. **Switching Repositories with `.repo()`**
+   ```typescript
+   // Start with user's SDS repository
+   const userSdsRepo = sdk.repository(session, { server: "sds" });
+   
+   // Switch to organization's repository
+   const orgRepo = userSdsRepo.repo("did:plc:org-did");
+   
+   // All operations on orgRepo still route to SDS, not user's PDS
+   await orgRepo.hypercerts.list(); // ✅ Queries SDS
+   await orgRepo.collaborators.list(); // ✅ Queries SDS
+   ```
+
+3. **Key Implementation Details**
+   - Each Repository uses a `ConfigurableAgent` that wraps your OAuth session's fetch handler
+   - The agent routes all requests to the specified server URL (PDS, SDS, or custom)
+   - When you call `.repo(did)`, a new Repository is created with the same server configuration
+   - Your OAuth session provides authentication (DPoP, access tokens), while the agent handles routing
+   - This enables simultaneous connections to multiple servers with one authentication session
+
+#### Common Patterns
+
+```typescript
+// Pattern 1: Personal hypercerts on PDS
+const myRepo = sdk.repository(session);
+await myRepo.hypercerts.create({ title: "My Personal Impact" });
+
+// Pattern 2: Organization hypercerts on SDS
+const sdsRepo = sdk.repository(session, { server: "sds" });
+const orgRepo = sdsRepo.repo(organizationDid);
+await orgRepo.hypercerts.create({ title: "Team Impact" });
+
+// Pattern 3: Reading another user's hypercerts
+const otherUserRepo = myRepo.repo("did:plc:other-user");
+await otherUserRepo.hypercerts.list(); // Read-only access to their PDS
+
+// Pattern 4: Collaborating on organization data
+const sdsRepo = sdk.repository(session, { server: "sds" });
+await sdsRepo.collaborators.grant({
+  userDid: "did:plc:teammate",
+  role: "editor",
+});
+const orgRepo = sdsRepo.repo(organizationDid);
+// Teammate can now access orgRepo and create hypercerts
+```
+
+### 2. Authentication
 
 The SDK uses OAuth 2.0 for authentication with support for both PDS (Personal Data Server) and SDS (Shared Data Server).
 
@@ -67,7 +160,7 @@ const session = await sdk.restoreSession("did:plc:user123");
 const repo = sdk.getRepository(session);
 ```
 
-### 2. Working with Hypercerts
+### 3. Working with Hypercerts
 
 #### Creating a Hypercert
 
@@ -144,7 +237,7 @@ await repo.hypercerts.delete(
 );
 ```
 
-### 3. Contributions and Measurements
+### 4. Contributions and Measurements
 
 #### Adding Contributions
 
@@ -174,7 +267,7 @@ const measurement = await repo.hypercerts.addMeasurement({
 });
 ```
 
-### 4. Blob Operations (Images & Files)
+### 5. Blob Operations (Images & Files)
 
 ```typescript
 // Upload an image or file
@@ -188,7 +281,7 @@ const blobData = await repo.blobs.get(
 );
 ```
 
-### 5. Organizations (SDS only)
+### 6. Organizations (SDS only)
 
 Organizations allow multiple users to collaborate on shared repositories.
 
@@ -216,7 +309,7 @@ const org = await repo.organizations.get("did:plc:org123");
 console.log(`${org.name} - ${org.description}`);
 ```
 
-### 6. Collaborator Management (SDS only)
+### 7. Collaborator Management (SDS only)
 
 Manage who has access to your repository and what they can do.
 
@@ -285,7 +378,7 @@ await repo.collaborators.transferOwnership({
 });
 ```
 
-### 7. Generic Record Operations
+### 8. Generic Record Operations
 
 For working with any ATProto record type:
 
@@ -330,7 +423,7 @@ const { records, cursor } = await repo.records.list({
 });
 ```
 
-### 8. Profile Management (PDS only)
+### 9. Profile Management (PDS only)
 
 ```typescript
 // Get user profile
@@ -457,6 +550,35 @@ try {
 
 ## Advanced Usage
 
+### Multi-Server Routing with ConfigurableAgent
+
+The `ConfigurableAgent` allows you to create custom agents that route to specific servers:
+
+```typescript
+import { ConfigurableAgent } from "@hypercerts-org/sdk-core";
+
+// Authenticate once with your PDS
+const session = await sdk.callback(params);
+
+// Create agents for different servers using the same session
+const pdsAgent = new ConfigurableAgent(session, "https://bsky.social");
+const sdsAgent = new ConfigurableAgent(session, "https://sds.hypercerts.org");
+const orgAgent = new ConfigurableAgent(session, "https://sds-org-a.example.com");
+
+// Use agents directly with AT Protocol APIs
+await pdsAgent.com.atproto.repo.createRecord({...});
+await sdsAgent.com.atproto.repo.listRecords({...});
+
+// Or pass to Repository for high-level operations
+// (Repository internally uses ConfigurableAgent)
+```
+
+This is useful for:
+- Connecting to multiple SDS instances simultaneously
+- Testing against different server environments
+- Building tools that work across multiple organizations
+- Direct AT Protocol API access with custom routing
+
 ### Custom Session Storage
 
 ```typescript

package/dist/index.cjs

@@ -2,8 +2,8 @@
 
 var oauthClientNode = require('@atproto/oauth-client-node');
 var lexicon$1 = require('@atproto/lexicon');
-var api = require('@atproto/api');
 var lexicon = require('@hypercerts-org/lexicon');
+var api = require('@atproto/api');
 var eventemitter3 = require('eventemitter3');
 var zod = require('zod');
 
@@ -1246,6 +1246,80 @@ class LexiconRegistry {
     }
 }
 
+/**
+ * ConfigurableAgent - Agent with configurable service URL routing.
+ *
+ * This module provides an Agent extension that allows routing requests to
+ * a specific server URL, overriding the default URL from the OAuth session.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Agent subclass that routes requests to a configurable service URL.
+ *
+ * The standard Agent uses the service URL embedded in the OAuth session's
+ * fetch handler. This class allows overriding that URL to route requests
+ * to different servers (e.g., PDS vs SDS, or multiple SDS instances).
+ *
+ * @remarks
+ * This is particularly useful for:
+ * - Routing to a Shared Data Server (SDS) while authenticated via PDS
+ * - Supporting multiple SDS instances for different organizations
+ * - Testing against different server environments
+ *
+ * @example Basic usage
+ * ```typescript
+ * const session = await sdk.authorize("user.bsky.social");
+ *
+ * // Create agent routing to SDS instead of session's default PDS
+ * const sdsAgent = new ConfigurableAgent(session, "https://sds.hypercerts.org");
+ *
+ * // All requests will now go to the SDS
+ * await sdsAgent.com.atproto.repo.createRecord({...});
+ * ```
+ *
+ * @example Multiple SDS instances
+ * ```typescript
+ * // Route to organization A's SDS
+ * const orgAAgent = new ConfigurableAgent(session, "https://sds-org-a.example.com");
+ *
+ * // Route to organization B's SDS
+ * const orgBAgent = new ConfigurableAgent(session, "https://sds-org-b.example.com");
+ * ```
+ */
+class ConfigurableAgent extends api.Agent {
+    /**
+     * Creates a ConfigurableAgent that routes to a specific service URL.
+     *
+     * @param session - OAuth session for authentication
+     * @param serviceUrl - Base URL of the server to route requests to
+     *
+     * @remarks
+     * The agent wraps the session's fetch handler to intercept requests and
+     * prepend the custom service URL instead of using the session's default.
+     */
+    constructor(session, serviceUrl) {
+        // Create a custom fetch handler that uses our service URL
+        const customFetchHandler = async (pathname, init) => {
+            // Construct the full URL with our custom service
+            const url = new URL(pathname, serviceUrl).toString();
+            // Use the session's fetch handler for authentication (DPoP, etc.)
+            return session.fetchHandler(url, init);
+        };
+        // Initialize the parent Agent with our custom fetch handler
+        super(customFetchHandler);
+        this.customServiceUrl = serviceUrl;
+    }
+    /**
+     * Gets the service URL this agent routes to.
+     *
+     * @returns The base URL of the configured service
+     */
+    getServiceUrl() {
+        return this.customServiceUrl;
+    }
+}
+
 /**
  * RecordOperationsImpl - Low-level record CRUD operations.
  *
@@ -2196,6 +2270,7 @@ class HypercertOperationsImpl extends eventemitter3.EventEmitter {
             // Step 2: Create rights record
             this.emitProgress(params.onProgress, { name: "createRights", status: "start" });
             const rightsRecord = {
+                $type: lexicon.HYPERCERT_COLLECTIONS.RIGHTS,
                 rightsName: params.rights.name,
                 rightsType: params.rights.type,
                 rightsDescription: params.rights.description,
@@ -2224,6 +2299,7 @@ class HypercertOperationsImpl extends eventemitter3.EventEmitter {
             // Step 3: Create hypercert record
             this.emitProgress(params.onProgress, { name: "createHypercert", status: "start" });
             const hypercertRecord = {
+                $type: lexicon.HYPERCERT_COLLECTIONS.CLAIM,
                 title: params.title,
                 description: params.description,
                 workScope: params.workScope,
@@ -2571,6 +2647,7 @@ class HypercertOperationsImpl extends eventemitter3.EventEmitter {
      * await repo.hypercerts.attachLocation(hypercertUri, {
      *   value: "San Francisco, CA",
      *   name: "SF Bay Area",
+     *   srs: "EPSG:4326",
      * });
      * ```
      *
@@ -2589,32 +2666,54 @@ class HypercertOperationsImpl extends eventemitter3.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: lexicon.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(lexicon.HYPERCERT_COLLECTIONS.LOCATION, locationRecord);
             if (!validation.valid) {
@@ -2701,10 +2800,12 @@ class HypercertOperationsImpl extends eventemitter3.EventEmitter {
         try {
             const createdAt = new Date().toISOString();
             const contributionRecord = {
+                $type: lexicon.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);
@@ -2765,6 +2866,7 @@ class HypercertOperationsImpl extends eventemitter3.EventEmitter {
             const hypercert = await this.get(params.hypercertUri);
             const createdAt = new Date().toISOString();
             const measurementRecord = {
+                $type: lexicon.HYPERCERT_COLLECTIONS.MEASUREMENT,
                 hypercert: { uri: hypercert.uri, cid: hypercert.cid },
                 measurers: params.measurers,
                 metric: params.metric,
@@ -2820,6 +2922,7 @@ class HypercertOperationsImpl extends eventemitter3.EventEmitter {
             const subject = await this.get(params.subjectUri);
             const createdAt = new Date().toISOString();
             const evaluationRecord = {
+                $type: lexicon.HYPERCERT_COLLECTIONS.EVALUATION,
                 subject: { uri: subject.uri, cid: subject.cid },
                 evaluators: params.evaluators,
                 summary: params.summary,
@@ -2894,6 +2997,7 @@ class HypercertOperationsImpl extends eventemitter3.EventEmitter {
                 }
             }
             const collectionRecord = {
+                $type: lexicon.HYPERCERT_COLLECTIONS.COLLECTION,
                 title: params.title,
                 claims: params.claims.map((c) => ({ claim: { uri: c.uri, cid: c.cid }, weight: c.weight })),
                 createdAt,
@@ -3772,11 +3876,10 @@ class Repository {
         this.lexiconRegistry = lexiconRegistry;
         this._isSDS = isSDS;
         this.logger = logger;
-        // Create Agent with OAuth session
-        this.agent = new api.Agent(session);
-        // Configure Agent to use the specified server URL (PDS or SDS)
-        // This ensures queries are routed to the correct server
-        this.agent.api.xrpc.uri = new URL(serverUrl);
+        // Create a ConfigurableAgent that routes requests to the specified server URL
+        // This allows routing to PDS, SDS, or any custom server while maintaining
+        // the OAuth session's authentication
+        this.agent = new ConfigurableAgent(session, serverUrl);
         this.lexiconRegistry.addToAgent(this.agent);
         // Register hypercert lexicons
         this.lexiconRegistry.registerMany(lexicon.HYPERCERT_LEXICONS);
@@ -4696,6 +4799,7 @@ exports.ATProtoSDKError = ATProtoSDKError;
 exports.AuthenticationError = AuthenticationError;
 exports.CollaboratorPermissionsSchema = CollaboratorPermissionsSchema;
 exports.CollaboratorSchema = CollaboratorSchema;
+exports.ConfigurableAgent = ConfigurableAgent;
 exports.InMemorySessionStore = InMemorySessionStore;
 exports.InMemoryStateStore = InMemoryStateStore;
 exports.LexiconRegistry = LexiconRegistry;