@opendatalabs/vana-sdk 3.8.3 → 3.10.0

package/README.md

@@ -29,6 +29,10 @@ encryption, storage providers, and a shared isomorphic platform layer.
 - **Storage providers** — `VanaStorage` (default, talks to `storage.vana.org`),
   `R2Storage`, `StorageManager`, `IpfsStorage`, `PinataStorage`,
   `GoogleDriveStorage`, `DropboxStorage`, `CallbackStorage`.
+- **Vana service integrations** — `@opendatalabs/vana-sdk/server`,
+  `@opendatalabs/vana-sdk/react`, and `@opendatalabs/vana-sdk/session-relay`
+  for Vana-operated app handoff flows. These are integration helpers, not
+  protocol-core modules.
 - **Platform adapters** — `NodePlatformAdapter` and `BrowserPlatformAdapter`
   with a shared `VanaPlatformAdapter` interface, plus detection helpers
   (`detectPlatform`, `isPlatformSupported`, `createPlatformAdapter`,
@@ -104,12 +108,12 @@ const result = await storage.upload(myBlob, "report.json");
 console.log(result.url);
 ```
 
-## Build a direct Vana app
+## Build a Vana app
 
 Request user-approved data, read it from the user's Personal Server, and pay
 for the read — without the browser ever seeing your app private key or choosing
-scopes. Your **backend** owns the controller (`@opendatalabs/vana-sdk/server`);
-your **frontend** drives a two-tab approval flow with a React hook
+scopes. Your **backend** owns the Data Portability controller
+(`@opendatalabs/vana-sdk/server`); your **frontend** drives a two-tab approval flow with a React hook
 (`@opendatalabs/vana-sdk/react`).
 
 > **How it fits together.** Access requests are created through the Vana Account
@@ -136,12 +140,12 @@ export const vana = createDirectDataController({
   network: process.env.VANA_NETWORK === "moksha" ? "moksha" : "mainnet",
   appPrivateKey: process.env.VANA_APP_PRIVATE_KEY!,
   app: {
-    id: "notes-lens",
-    name: "Notes Lens",
+    id: "spotify-taste",
+    name: "Spotify Taste",
     homepageUrl: process.env.VANA_APP_URL!,
   },
-  source: "icloud_notes",
-  scopes: ["icloud_notes.notes"],
+  source: "spotify",
+  scopes: ["spotify.savedTracks"],
   // Settle paid reads through the DPv2 escrow gateway. The controller signs the
   // GenericPayment with your app key; you supply the gateway client + contract.
   escrow: {
@@ -172,7 +176,7 @@ const status = await vana.getAccessRequestStatus(requestId);
 // GET /api/vana/data?requestId=...
 const result = await vana.readApprovedData({ requestId });
 // -> {
-//   scope: "icloud_notes.notes",
+//   scope: "spotify.savedTracks",
 //   data: ...,
 //   payment?: {            // present only when this read settled a payment
 //     amount, asset, paymentNonce, paidAt,
@@ -194,7 +198,7 @@ amount and asset owed.
 "use client";
 import { useDirectVanaConnect } from "@opendatalabs/vana-sdk/react";
 
-export function ConnectNotesButton() {
+export function ConnectSpotifyButton() {
   const connect = useDirectVanaConnect({
     createRequest: () =>
       fetch("/api/vana/request", { method: "POST" }).then((r) => r.json()),
@@ -214,7 +218,7 @@ export function ConnectNotesButton() {
       onClick={connect.start}
       type="button"
     >
-      {connect.state.type === "idle" ? "Connect Apple Notes" : "Connecting..."}
+      {connect.state.type === "idle" ? "Connect Spotify" : "Connecting..."}
     </button>
   );
 }
@@ -225,6 +229,23 @@ until the request is approved, then calls `readResult`. `react` is an optional
 peer dependency. The underlying `createDirectConnectFlow` store is also exported
 for non-React frontends.
 
+### Test with large sample data
+
+When testing with realistic exports, use the public fixture catalog in
+[`vana-com/data-connectors`](https://github.com/vana-com/data-connectors). Keep
+the payload in a file or raw URL and point your app or agent at that location.
+Do not paste large JSON into the terminal.
+
+The controller can run against local test data by injecting an
+`accessRequestClient` that returns an approved request and a
+`personalServerFetch` that loads the sample payload, while the rest of your app
+still calls `readApprovedData`.
+
+See [`examples/vana-app`](../../examples/vana-app) for a runnable Next.js Vana
+app. It includes the route handlers, return page, and React connect button from
+this flow, defaults to sample-data mode using `vana-com/data-connectors`, and
+can be switched to live protocol mode with environment variables.
+
 ## Networks
 
 | Network        | Chain ID | RPC URL                     |

package/dist/index.browser.d.ts

@@ -48,6 +48,6 @@ export { DATA_REGISTRY_STATUS_ABI, DataPointStatus, dataRegistryContractAddress,
 export { personalServerDataReadPath, buildPersonalServerDataReadRequest, readPersonalServerData, type BuildPersonalServerDataReadRequestParams, type ReadPersonalServerDataParams, } from "./protocol/personal-server-data";
 export { ScopeSchema, parseScope, scopeToPathSegments, scopeMatchesPattern, scopeCoveredByGrant, type Scope, type ParsedScope, } from "./protocol/scopes";
 export { DataFileEnvelopeSchema, createDataFileEnvelope, IngestResponseSchema, type DataFileEnvelope, type IngestResponse, } from "./protocol/data-file";
-export { createGatewayClient, type GatewayEnvelope, type GatewayProof, type Builder, type Schema, type ServerInfo, type GatewayGrantFee, type GatewayGrantStatus, type GatewayGrantResponse, type GrantListItem, type DataPointRecord, type DataPointListResult, type ListDataPointsOptions, type RegisterServerParams, type RegisterServerResult, type RegisterBuilderParams, type RegisterBuilderResult, type RegisterDataPointParams, type RegisterDataPointResult, type CreateGrantParams, type RevokeGrantParams, type AccessRecord, type PayForOperationParams, type PayForOperationResult, type SettleOpType, type SettleItem, type SettlePromoteResult, type SettleReconcileItem, type SettleParams, type SettleResult, type GatewayClient, } from "./protocol/gateway";
+export { createGatewayClient, type GatewayEnvelope, type GatewayProof, type Builder, type Schema, type ServerInfo, type OwnerServerRecord, type OwnerServersResult, type GatewayGrantFee, type GatewayGrantStatus, type GatewayGrantResponse, type GrantListItem, type DataPointRecord, type DataPointListResult, type ListDataPointsOptions, type RegisterServerParams, type RegisterServerResult, type RegisterBuilderParams, type RegisterBuilderResult, type RegisterDataPointParams, type RegisterDataPointResult, type CreateGrantParams, type RevokeGrantParams, type AccessRecord, type PayForOperationParams, type PayForOperationResult, type SettleOpType, type SettleItem, type SettlePromoteResult, type SettleReconcileItem, type SettleParams, type SettleResult, type GatewayClient, } from "./protocol/gateway";
 export { createEscrowGatewayClient, genericPaymentDomain, GENERIC_PAYMENT_TYPES, ESCROW_DEPOSIT_ABI, NATIVE_ASSET_ADDRESS, type GenericPaymentMessage, type EscrowBalanceEntry, type EscrowBalanceResult, type EscrowBalanceSyncResult, type DepositSubmissionResult, type PaymentBreakdown, type EscrowPayResult, type SubmitDepositParams, type PayForOpParams, type EscrowGatewayClient, type SubmittedDepositEntry, type FinalizedDepositEntry, type FailedDepositEntry, } from "./protocol/escrow";
 export { PSError, parsePSError, type PSErrorCode } from "./types/ps-errors";

package/dist/index.browser.js

@@ -32921,6 +32921,14 @@ function createGatewayClient(baseUrl) {
       }
       return unwrapEnvelope(res);
     },
+    async listServersByOwner(owner) {
+      const params = new URLSearchParams({ owner });
+      const res = await fetch(`${base}/v1/servers?${params.toString()}`);
+      if (!res.ok) {
+        throw new Error(`Gateway error: ${res.status} ${res.statusText}`);
+      }
+      return await res.json();
+    },
     async getDataPoint(dataPointId) {
       const res = await fetch(`${base}/v1/data/${dataPointId}`);
       if (res.status === 404) return null;