@opendatalabs/vana-sdk 3.4.1 → 3.5.1-pr.159.12a6f39

package/dist/direct/types.d.ts

@@ -0,0 +1,205 @@
+/**
+ * Shared types for the Direct Data Controller and the browser connect helper.
+ *
+ * @remarks
+ * These types describe the "two-tab" Data Portability flow documented in the
+ * builder guide: a backend controller creates an access request, the browser
+ * opens Vana for user approval, and the backend reads the approved data from
+ * the user's Personal Server (handling 402 Payment Required).
+ *
+ * @category Direct
+ * @module direct/types
+ */
+/**
+ * Target environment for a {@link DirectDataController}.
+ *
+ * - `"production"` — Vana mainnet stack (default service URLs).
+ * - `"dev"` — Vana internal dev/testnet stack. Use only when testing against
+ *   Vana's dev infrastructure.
+ */
+export type DirectEnv = "dev" | "production";
+/**
+ * App identity advertised to users during approval and attributed in Builder
+ * League activity reports.
+ */
+export interface DirectAppConfig {
+    /** Stable, human-readable app id (e.g. `"notes-lens"`). */
+    id: string;
+    /** Display name shown to the user in the Vana approval UI. */
+    name: string;
+    /** Public homepage URL for the app. */
+    homepageUrl: string;
+}
+/**
+ * Resolved app identity: the configured {@link DirectAppConfig} plus the app's
+ * derived on-chain address (the address to fund and inspect).
+ */
+export interface AppIdentity extends DirectAppConfig {
+    /** The app's `0x`-prefixed on-chain address (derived from `appPrivateKey`). */
+    address: string;
+}
+/**
+ * Resolved service URLs for a given {@link DirectEnv}.
+ *
+ * @remarks
+ * Centralizes the per-environment base URLs the controller talks to. Each can
+ * be overridden via {@link DirectDataControllerConfig.endpoints} when pointing
+ * at a non-standard deployment.
+ */
+export interface DirectServiceEndpoints {
+    /** Vana chain id for this environment (1480 mainnet, 14800 moksha). */
+    chainId: number;
+    /** Base URL of the Vana Account access-request API that issues `dcr_*` ids. */
+    accessRequestBaseUrl: string;
+    /** Base URL users are sent to for approval (the Vana app). */
+    approvalAppBaseUrl: string;
+}
+/** Result of {@link DirectDataController.createAccessRequest}. */
+export interface AccessRequest {
+    /** Opaque request id (e.g. `"dcr_123"`). */
+    requestId: string;
+    /** URL the browser opens so the user can approve the requested scopes. */
+    approvalUrl: string;
+    /** On-chain address of the (registered or reused) app. */
+    appAddress: string;
+}
+/** Lifecycle status of an access request. */
+export type AccessRequestStatusValue = "pending" | "approved" | "denied" | "expired";
+/** Result of {@link DirectDataController.getAccessRequestStatus}. */
+export interface AccessRequestStatus {
+    /** Current lifecycle status of the request. */
+    status: AccessRequestStatusValue;
+    /** Personal Server base URL — present once `status === "approved"`. */
+    personalServerUrl?: string;
+    /** Grant id covering the approved scope — present once approved. */
+    grantId?: string;
+    /** The approved scope — present once approved. */
+    scope?: string;
+}
+/** Result of {@link DirectDataController.readApprovedData}. */
+export interface ApprovedDataResult<T = unknown> {
+    /** The scope the data was read for. */
+    scope: string;
+    /** The decoded payload returned by the Personal Server. */
+    data: T;
+    /**
+     * Payment receipt — present only when this read required (and settled) a
+     * payment. Lets builders inspect the amount, asset, and fee breakdown without
+     * digging into the underlying 402/escrow exchange. Reads served from a paid-up
+     * grant omit this field.
+     */
+    payment?: DirectPaymentReceipt;
+}
+/**
+ * Client for the Vana Account access-request API — the service that turns a
+ * registered app + scopes into a `dcr_*` id and approval URL.
+ *
+ * @remarks
+ * The controller uses a default client against the Vana Account endpoints. You
+ * can inject your own implementation to point at a custom deployment or to
+ * supply a test double.
+ */
+export interface AccessRequestClient {
+    /**
+     * Create an access request for the given app + scopes.
+     *
+     * @param input - App identity, source, scopes, and the post-approval return URL.
+     * @returns The created {@link AccessRequest}.
+     */
+    createAccessRequest(input: {
+        appAddress: string;
+        app: DirectAppConfig;
+        source: string;
+        scopes: string[];
+        returnUrl: string;
+    }): Promise<AccessRequest>;
+    /**
+     * Fetch the current status of a previously created access request.
+     *
+     * @param requestId - The `dcr_*` id returned by {@link AccessRequestClient.createAccessRequest}.
+     * @returns The current {@link AccessRequestStatus}.
+     */
+    getAccessRequestStatus(requestId: string): Promise<AccessRequestStatus>;
+}
+/**
+ * Op-type vocabulary used by the DPv2 escrow payment surface.
+ *
+ * @remarks
+ * These are the operations the gateway prices and settles via
+ * `POST /v1/escrow/pay` (`opType` field of the `GenericPayment` message). A
+ * direct data read settles the {@link DirectOpType.DataAccess} op for the
+ * approved grant; the other op types are listed here for completeness and to
+ * give builders a typed vocabulary when inspecting fee breakdowns.
+ *
+ * Note: the escrow `GenericPayment` `opType` is currently `"grant"` on the wire
+ * for grant lifecycle payments; this enum names the higher-level fee categories
+ * the gateway reports in a {@link PaymentBreakdown}.
+ */
+export declare const DirectOpType: {
+    readonly GrantRegistration: "grant_registration";
+    readonly DataAccess: "data_access";
+    readonly DataRegistration: "data_registration";
+    readonly ServerRegistration: "server_registration";
+    readonly BuilderRegistration: "builder_registration";
+};
+/** A direct-flow op type (see {@link DirectOpType}). */
+export type DirectOpTypeValue = (typeof DirectOpType)[keyof typeof DirectOpType];
+/**
+ * What a Personal Server `402 Payment Required` tells the controller is owed for
+ * a data read.
+ *
+ * @remarks
+ * The PS read 402 body identifies the grant to settle and the amount/asset. The
+ * controller settles it via the DPv2 escrow gateway (`/v1/escrow/pay`). The full
+ * unmodified body is preserved under {@link PersonalServerPaymentRequired.raw}.
+ */
+export interface PersonalServerPaymentRequired {
+    /** Grant id to settle (the escrow `opId`). Defaults to the read's grantId. */
+    grantId: string;
+    /** Asset address owed (zero address = native VANA). */
+    asset: string;
+    /** Amount owed, as a decimal base-unit string (preserves uint256 precision). */
+    amount: string;
+    /** The full, unmodified 402 response body. */
+    raw: unknown;
+}
+/**
+ * Structured payment metadata attached to a successful paid read.
+ *
+ * @remarks
+ * Derived from the gateway's {@link EscrowPayResult}. Lets builders debug the
+ * amount, asset, and per-op fee breakdown without re-deriving anything from the
+ * raw 402/payment exchange.
+ */
+export interface DirectPaymentReceipt {
+    /** Op type settled (the gateway `opType`, e.g. `"grant"`). */
+    opType: string;
+    /** Op id settled (the grant id). */
+    opId: string;
+    /** Asset paid in (zero address = native VANA). */
+    asset: string;
+    /** Total amount paid, as a decimal base-unit string. */
+    amount: string;
+    /** Payment nonce used for this settlement. */
+    paymentNonce: string;
+    /** Fee breakdown reported by the gateway (registration vs data-access fee). */
+    breakdown: DirectFeeBreakdown;
+    /** ISO timestamp the gateway recorded the payment. */
+    paidAt: string;
+}
+/**
+ * Per-op fee breakdown reported by the gateway.
+ *
+ * @remarks
+ * Mirrors the escrow {@link PaymentBreakdown}: a one-time registration fee plus
+ * the per-read data-access fee, and whether this settlement covered the
+ * registration fee.
+ */
+export interface DirectFeeBreakdown {
+    /** One-time registration fee for the op, as a decimal base-unit string. */
+    registrationFee: string;
+    /** Per-read data-access fee, as a decimal base-unit string. */
+    dataAccessFee: string;
+    /** True when this settlement paid the registration fee. */
+    registrationPaid: boolean;
+}

package/dist/direct/types.js

@@ -0,0 +1,11 @@
+const DirectOpType = {
+  GrantRegistration: "grant_registration",
+  DataAccess: "data_access",
+  DataRegistration: "data_registration",
+  ServerRegistration: "server_registration",
+  BuilderRegistration: "builder_registration"
+};
+export {
+  DirectOpType
+};
+//# sourceMappingURL=types.js.map

package/dist/direct/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/direct/types.ts"],"sourcesContent":["/**\n * Shared types for the Direct Data Controller and the browser connect helper.\n *\n * @remarks\n * These types describe the \"two-tab\" Data Portability flow documented in the\n * builder guide: a backend controller creates an access request, the browser\n * opens Vana for user approval, and the backend reads the approved data from\n * the user's Personal Server (handling 402 Payment Required).\n *\n * @category Direct\n * @module direct/types\n */\n\n/**\n * Target environment for a {@link DirectDataController}.\n *\n * - `\"production\"` — Vana mainnet stack (default service URLs).\n * - `\"dev\"` — Vana internal dev/testnet stack. Use only when testing against\n *   Vana's dev infrastructure.\n */\nexport type DirectEnv = \"dev\" | \"production\";\n\n/**\n * App identity advertised to users during approval and attributed in Builder\n * League activity reports.\n */\nexport interface DirectAppConfig {\n  /** Stable, human-readable app id (e.g. `\"notes-lens\"`). */\n  id: string;\n  /** Display name shown to the user in the Vana approval UI. */\n  name: string;\n  /** Public homepage URL for the app. */\n  homepageUrl: string;\n}\n\n/**\n * Resolved app identity: the configured {@link DirectAppConfig} plus the app's\n * derived on-chain address (the address to fund and inspect).\n */\nexport interface AppIdentity extends DirectAppConfig {\n  /** The app's `0x`-prefixed on-chain address (derived from `appPrivateKey`). */\n  address: string;\n}\n\n/**\n * Resolved service URLs for a given {@link DirectEnv}.\n *\n * @remarks\n * Centralizes the per-environment base URLs the controller talks to. Each can\n * be overridden via {@link DirectDataControllerConfig.endpoints} when pointing\n * at a non-standard deployment.\n */\nexport interface DirectServiceEndpoints {\n  /** Vana chain id for this environment (1480 mainnet, 14800 moksha). */\n  chainId: number;\n  /** Base URL of the Vana Account access-request API that issues `dcr_*` ids. */\n  accessRequestBaseUrl: string;\n  /** Base URL users are sent to for approval (the Vana app). */\n  approvalAppBaseUrl: string;\n}\n\n/** Result of {@link DirectDataController.createAccessRequest}. */\nexport interface AccessRequest {\n  /** Opaque request id (e.g. `\"dcr_123\"`). */\n  requestId: string;\n  /** URL the browser opens so the user can approve the requested scopes. */\n  approvalUrl: string;\n  /** On-chain address of the (registered or reused) app. */\n  appAddress: string;\n}\n\n/** Lifecycle status of an access request. */\nexport type AccessRequestStatusValue =\n  | \"pending\"\n  | \"approved\"\n  | \"denied\"\n  | \"expired\";\n\n/** Result of {@link DirectDataController.getAccessRequestStatus}. */\nexport interface AccessRequestStatus {\n  /** Current lifecycle status of the request. */\n  status: AccessRequestStatusValue;\n  /** Personal Server base URL — present once `status === \"approved\"`. */\n  personalServerUrl?: string;\n  /** Grant id covering the approved scope — present once approved. */\n  grantId?: string;\n  /** The approved scope — present once approved. */\n  scope?: string;\n}\n\n/** Result of {@link DirectDataController.readApprovedData}. */\nexport interface ApprovedDataResult<T = unknown> {\n  /** The scope the data was read for. */\n  scope: string;\n  /** The decoded payload returned by the Personal Server. */\n  data: T;\n  /**\n   * Payment receipt — present only when this read required (and settled) a\n   * payment. Lets builders inspect the amount, asset, and fee breakdown without\n   * digging into the underlying 402/escrow exchange. Reads served from a paid-up\n   * grant omit this field.\n   */\n  payment?: DirectPaymentReceipt;\n}\n\n/**\n * Client for the Vana Account access-request API — the service that turns a\n * registered app + scopes into a `dcr_*` id and approval URL.\n *\n * @remarks\n * The controller uses a default client against the Vana Account endpoints. You\n * can inject your own implementation to point at a custom deployment or to\n * supply a test double.\n */\nexport interface AccessRequestClient {\n  /**\n   * Create an access request for the given app + scopes.\n   *\n   * @param input - App identity, source, scopes, and the post-approval return URL.\n   * @returns The created {@link AccessRequest}.\n   */\n  createAccessRequest(input: {\n    appAddress: string;\n    app: DirectAppConfig;\n    source: string;\n    scopes: string[];\n    returnUrl: string;\n  }): Promise<AccessRequest>;\n\n  /**\n   * Fetch the current status of a previously created access request.\n   *\n   * @param requestId - The `dcr_*` id returned by {@link AccessRequestClient.createAccessRequest}.\n   * @returns The current {@link AccessRequestStatus}.\n   */\n  getAccessRequestStatus(requestId: string): Promise<AccessRequestStatus>;\n}\n\n/**\n * Op-type vocabulary used by the DPv2 escrow payment surface.\n *\n * @remarks\n * These are the operations the gateway prices and settles via\n * `POST /v1/escrow/pay` (`opType` field of the `GenericPayment` message). A\n * direct data read settles the {@link DirectOpType.DataAccess} op for the\n * approved grant; the other op types are listed here for completeness and to\n * give builders a typed vocabulary when inspecting fee breakdowns.\n *\n * Note: the escrow `GenericPayment` `opType` is currently `\"grant\"` on the wire\n * for grant lifecycle payments; this enum names the higher-level fee categories\n * the gateway reports in a {@link PaymentBreakdown}.\n */\nexport const DirectOpType = {\n  GrantRegistration: \"grant_registration\",\n  DataAccess: \"data_access\",\n  DataRegistration: \"data_registration\",\n  ServerRegistration: \"server_registration\",\n  BuilderRegistration: \"builder_registration\",\n} as const;\n\n/** A direct-flow op type (see {@link DirectOpType}). */\nexport type DirectOpTypeValue =\n  (typeof DirectOpType)[keyof typeof DirectOpType];\n\n/**\n * What a Personal Server `402 Payment Required` tells the controller is owed for\n * a data read.\n *\n * @remarks\n * The PS read 402 body identifies the grant to settle and the amount/asset. The\n * controller settles it via the DPv2 escrow gateway (`/v1/escrow/pay`). The full\n * unmodified body is preserved under {@link PersonalServerPaymentRequired.raw}.\n */\nexport interface PersonalServerPaymentRequired {\n  /** Grant id to settle (the escrow `opId`). Defaults to the read's grantId. */\n  grantId: string;\n  /** Asset address owed (zero address = native VANA). */\n  asset: string;\n  /** Amount owed, as a decimal base-unit string (preserves uint256 precision). */\n  amount: string;\n  /** The full, unmodified 402 response body. */\n  raw: unknown;\n}\n\n/**\n * Structured payment metadata attached to a successful paid read.\n *\n * @remarks\n * Derived from the gateway's {@link EscrowPayResult}. Lets builders debug the\n * amount, asset, and per-op fee breakdown without re-deriving anything from the\n * raw 402/payment exchange.\n */\nexport interface DirectPaymentReceipt {\n  /** Op type settled (the gateway `opType`, e.g. `\"grant\"`). */\n  opType: string;\n  /** Op id settled (the grant id). */\n  opId: string;\n  /** Asset paid in (zero address = native VANA). */\n  asset: string;\n  /** Total amount paid, as a decimal base-unit string. */\n  amount: string;\n  /** Payment nonce used for this settlement. */\n  paymentNonce: string;\n  /** Fee breakdown reported by the gateway (registration vs data-access fee). */\n  breakdown: DirectFeeBreakdown;\n  /** ISO timestamp the gateway recorded the payment. */\n  paidAt: string;\n}\n\n/**\n * Per-op fee breakdown reported by the gateway.\n *\n * @remarks\n * Mirrors the escrow {@link PaymentBreakdown}: a one-time registration fee plus\n * the per-read data-access fee, and whether this settlement covered the\n * registration fee.\n */\nexport interface DirectFeeBreakdown {\n  /** One-time registration fee for the op, as a decimal base-unit string. */\n  registrationFee: string;\n  /** Per-read data-access fee, as a decimal base-unit string. */\n  dataAccessFee: string;\n  /** True when this settlement paid the registration fee. */\n  registrationPaid: boolean;\n}\n"],"mappings":"AAwJO,MAAM,eAAe;AAAA,EAC1B,mBAAmB;AAAA,EACnB,YAAY;AAAA,EACZ,kBAAkB;AAAA,EAClB,oBAAoB;AAAA,EACpB,qBAAqB;AACvB;","names":[]}

package/dist/direct/use-direct-vana-connect.cjs

@@ -0,0 +1,68 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var use_direct_vana_connect_exports = {};
+__export(use_direct_vana_connect_exports, {
+  useDirectVanaConnect: () => useDirectVanaConnect
+});
+module.exports = __toCommonJS(use_direct_vana_connect_exports);
+var import_react = require("react");
+var import_connect_flow = require("./connect-flow");
+function useDirectVanaConnect(options) {
+  const optionsRef = (0, import_react.useRef)(options);
+  optionsRef.current = options;
+  const flow = (0, import_react.useMemo)(
+    () => (0, import_connect_flow.createDirectConnectFlow)(
+      {
+        createRequest: () => optionsRef.current.createRequest(),
+        getStatus: (id) => optionsRef.current.getStatus(id),
+        readResult: (id) => optionsRef.current.readResult(id)
+      },
+      {
+        get pollIntervalMs() {
+          return optionsRef.current.pollIntervalMs;
+        },
+        get timeoutMs() {
+          return optionsRef.current.timeoutMs;
+        },
+        get openWindow() {
+          return optionsRef.current.openWindow;
+        }
+      }
+    ),
+    // Created once per component instance; callbacks are read via optionsRef.
+    []
+  );
+  const state = (0, import_react.useSyncExternalStore)(
+    flow.subscribe,
+    flow.getState,
+    flow.getState
+  );
+  const start = (0, import_react.useCallback)(() => {
+    void flow.start();
+  }, [flow]);
+  const reset = (0, import_react.useCallback)(() => {
+    flow.reset();
+  }, [flow]);
+  return { state, start, reset };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  useDirectVanaConnect
+});
+//# sourceMappingURL=use-direct-vana-connect.cjs.map

package/dist/direct/use-direct-vana-connect.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/direct/use-direct-vana-connect.ts"],"sourcesContent":["/**\n * React hook for the browser side of the direct Data Portability flow.\n *\n * @remarks\n * `useDirectVanaConnect` is a thin `useSyncExternalStore` binding over the\n * framework-agnostic {@link createDirectConnectFlow} store. The browser never\n * sees the app private key and never chooses scopes — it only calls the app's\n * own backend routes via the injected transports.\n *\n * This module is browser-safe and imports nothing Node-only. `react` is a peer\n * dependency.\n *\n * @category Direct\n * @module direct/use-direct-vana-connect\n */\n\nimport { useCallback, useMemo, useRef, useSyncExternalStore } from \"react\";\nimport {\n  createDirectConnectFlow,\n  type DirectConnectOptions,\n  type DirectConnectState,\n  type DirectConnectTransports,\n} from \"./connect-flow\";\n\n/** Options for {@link useDirectVanaConnect}: transports plus flow tunables. */\nexport type UseDirectVanaConnectOptions<T = unknown> =\n  DirectConnectTransports<T> & DirectConnectOptions;\n\n/** Return value of {@link useDirectVanaConnect}. */\nexport interface UseDirectVanaConnectResult<T = unknown> {\n  /** Current flow state (`state.type` is `\"idle\"` until `start()` is called). */\n  state: DirectConnectState<T>;\n  /** Begin the connect flow (create request, open Vana, poll, read). */\n  start: () => void;\n  /** Reset back to `idle` and cancel any in-flight polling. */\n  reset: () => void;\n}\n\n/**\n * Drive the two-tab connect flow from a React component.\n *\n * @param options - The `createRequest`/`getStatus`/`readResult` transports plus\n * optional polling/timeout tunables.\n * @returns `{ state, start, reset }`.\n *\n * @example\n * ```tsx\n * const connect = useDirectVanaConnect({\n *   createRequest: () => fetch(\"/api/vana/request\", { method: \"POST\" }).then((r) => r.json()),\n *   getStatus: (id) => fetch(`/api/vana/status?requestId=${id}`).then((r) => r.json()),\n *   readResult: (id) => fetch(`/api/vana/data?requestId=${id}`).then((r) => r.json()),\n * });\n * return <button disabled={connect.state.type !== \"idle\"} onClick={connect.start}>Connect</button>;\n * ```\n */\nexport function useDirectVanaConnect<T = unknown>(\n  options: UseDirectVanaConnectOptions<T>,\n): UseDirectVanaConnectResult<T> {\n  // Keep the latest options in a ref so the store reads current callbacks\n  // without being recreated on every render.\n  const optionsRef = useRef(options);\n  optionsRef.current = options;\n\n  const flow = useMemo(\n    () =>\n      createDirectConnectFlow<T>(\n        {\n          createRequest: () => optionsRef.current.createRequest(),\n          getStatus: (id) => optionsRef.current.getStatus(id),\n          readResult: (id) => optionsRef.current.readResult(id),\n        },\n        {\n          get pollIntervalMs() {\n            return optionsRef.current.pollIntervalMs;\n          },\n          get timeoutMs() {\n            return optionsRef.current.timeoutMs;\n          },\n          get openWindow() {\n            return optionsRef.current.openWindow;\n          },\n        },\n      ),\n    // Created once per component instance; callbacks are read via optionsRef.\n    [],\n  );\n\n  const state = useSyncExternalStore(\n    flow.subscribe,\n    flow.getState,\n    flow.getState,\n  );\n\n  const start = useCallback(() => {\n    void flow.start();\n  }, [flow]);\n\n  const reset = useCallback(() => {\n    flow.reset();\n  }, [flow]);\n\n  return { state, start, reset };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAgBA,mBAAmE;AACnE,0BAKO;AAiCA,SAAS,qBACd,SAC+B;AAG/B,QAAM,iBAAa,qBAAO,OAAO;AACjC,aAAW,UAAU;AAErB,QAAM,WAAO;AAAA,IACX,UACE;AAAA,MACE;AAAA,QACE,eAAe,MAAM,WAAW,QAAQ,cAAc;AAAA,QACtD,WAAW,CAAC,OAAO,WAAW,QAAQ,UAAU,EAAE;AAAA,QAClD,YAAY,CAAC,OAAO,WAAW,QAAQ,WAAW,EAAE;AAAA,MACtD;AAAA,MACA;AAAA,QACE,IAAI,iBAAiB;AACnB,iBAAO,WAAW,QAAQ;AAAA,QAC5B;AAAA,QACA,IAAI,YAAY;AACd,iBAAO,WAAW,QAAQ;AAAA,QAC5B;AAAA,QACA,IAAI,aAAa;AACf,iBAAO,WAAW,QAAQ;AAAA,QAC5B;AAAA,MACF;AAAA,IACF;AAAA;AAAA,IAEF,CAAC;AAAA,EACH;AAEA,QAAM,YAAQ;AAAA,IACZ,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,EACP;AAEA,QAAM,YAAQ,0BAAY,MAAM;AAC9B,SAAK,KAAK,MAAM;AAAA,EAClB,GAAG,CAAC,IAAI,CAAC;AAET,QAAM,YAAQ,0BAAY,MAAM;AAC9B,SAAK,MAAM;AAAA,EACb,GAAG,CAAC,IAAI,CAAC;AAET,SAAO,EAAE,OAAO,OAAO,MAAM;AAC/B;","names":[]}

package/dist/direct/use-direct-vana-connect.d.ts

@@ -0,0 +1,45 @@
+/**
+ * React hook for the browser side of the direct Data Portability flow.
+ *
+ * @remarks
+ * `useDirectVanaConnect` is a thin `useSyncExternalStore` binding over the
+ * framework-agnostic {@link createDirectConnectFlow} store. The browser never
+ * sees the app private key and never chooses scopes — it only calls the app's
+ * own backend routes via the injected transports.
+ *
+ * This module is browser-safe and imports nothing Node-only. `react` is a peer
+ * dependency.
+ *
+ * @category Direct
+ * @module direct/use-direct-vana-connect
+ */
+import { type DirectConnectOptions, type DirectConnectState, type DirectConnectTransports } from "./connect-flow";
+/** Options for {@link useDirectVanaConnect}: transports plus flow tunables. */
+export type UseDirectVanaConnectOptions<T = unknown> = DirectConnectTransports<T> & DirectConnectOptions;
+/** Return value of {@link useDirectVanaConnect}. */
+export interface UseDirectVanaConnectResult<T = unknown> {
+    /** Current flow state (`state.type` is `"idle"` until `start()` is called). */
+    state: DirectConnectState<T>;
+    /** Begin the connect flow (create request, open Vana, poll, read). */
+    start: () => void;
+    /** Reset back to `idle` and cancel any in-flight polling. */
+    reset: () => void;
+}
+/**
+ * Drive the two-tab connect flow from a React component.
+ *
+ * @param options - The `createRequest`/`getStatus`/`readResult` transports plus
+ * optional polling/timeout tunables.
+ * @returns `{ state, start, reset }`.
+ *
+ * @example
+ * ```tsx
+ * const connect = useDirectVanaConnect({
+ *   createRequest: () => fetch("/api/vana/request", { method: "POST" }).then((r) => r.json()),
+ *   getStatus: (id) => fetch(`/api/vana/status?requestId=${id}`).then((r) => r.json()),
+ *   readResult: (id) => fetch(`/api/vana/data?requestId=${id}`).then((r) => r.json()),
+ * });
+ * return <button disabled={connect.state.type !== "idle"} onClick={connect.start}>Connect</button>;
+ * ```
+ */
+export declare function useDirectVanaConnect<T = unknown>(options: UseDirectVanaConnectOptions<T>): UseDirectVanaConnectResult<T>;

package/dist/direct/use-direct-vana-connect.js

@@ -0,0 +1,46 @@
+import { useCallback, useMemo, useRef, useSyncExternalStore } from "react";
+import {
+  createDirectConnectFlow
+} from "./connect-flow.js";
+function useDirectVanaConnect(options) {
+  const optionsRef = useRef(options);
+  optionsRef.current = options;
+  const flow = useMemo(
+    () => createDirectConnectFlow(
+      {
+        createRequest: () => optionsRef.current.createRequest(),
+        getStatus: (id) => optionsRef.current.getStatus(id),
+        readResult: (id) => optionsRef.current.readResult(id)
+      },
+      {
+        get pollIntervalMs() {
+          return optionsRef.current.pollIntervalMs;
+        },
+        get timeoutMs() {
+          return optionsRef.current.timeoutMs;
+        },
+        get openWindow() {
+          return optionsRef.current.openWindow;
+        }
+      }
+    ),
+    // Created once per component instance; callbacks are read via optionsRef.
+    []
+  );
+  const state = useSyncExternalStore(
+    flow.subscribe,
+    flow.getState,
+    flow.getState
+  );
+  const start = useCallback(() => {
+    void flow.start();
+  }, [flow]);
+  const reset = useCallback(() => {
+    flow.reset();
+  }, [flow]);
+  return { state, start, reset };
+}
+export {
+  useDirectVanaConnect
+};
+//# sourceMappingURL=use-direct-vana-connect.js.map

package/dist/direct/use-direct-vana-connect.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/direct/use-direct-vana-connect.ts"],"sourcesContent":["/**\n * React hook for the browser side of the direct Data Portability flow.\n *\n * @remarks\n * `useDirectVanaConnect` is a thin `useSyncExternalStore` binding over the\n * framework-agnostic {@link createDirectConnectFlow} store. The browser never\n * sees the app private key and never chooses scopes — it only calls the app's\n * own backend routes via the injected transports.\n *\n * This module is browser-safe and imports nothing Node-only. `react` is a peer\n * dependency.\n *\n * @category Direct\n * @module direct/use-direct-vana-connect\n */\n\nimport { useCallback, useMemo, useRef, useSyncExternalStore } from \"react\";\nimport {\n  createDirectConnectFlow,\n  type DirectConnectOptions,\n  type DirectConnectState,\n  type DirectConnectTransports,\n} from \"./connect-flow\";\n\n/** Options for {@link useDirectVanaConnect}: transports plus flow tunables. */\nexport type UseDirectVanaConnectOptions<T = unknown> =\n  DirectConnectTransports<T> & DirectConnectOptions;\n\n/** Return value of {@link useDirectVanaConnect}. */\nexport interface UseDirectVanaConnectResult<T = unknown> {\n  /** Current flow state (`state.type` is `\"idle\"` until `start()` is called). */\n  state: DirectConnectState<T>;\n  /** Begin the connect flow (create request, open Vana, poll, read). */\n  start: () => void;\n  /** Reset back to `idle` and cancel any in-flight polling. */\n  reset: () => void;\n}\n\n/**\n * Drive the two-tab connect flow from a React component.\n *\n * @param options - The `createRequest`/`getStatus`/`readResult` transports plus\n * optional polling/timeout tunables.\n * @returns `{ state, start, reset }`.\n *\n * @example\n * ```tsx\n * const connect = useDirectVanaConnect({\n *   createRequest: () => fetch(\"/api/vana/request\", { method: \"POST\" }).then((r) => r.json()),\n *   getStatus: (id) => fetch(`/api/vana/status?requestId=${id}`).then((r) => r.json()),\n *   readResult: (id) => fetch(`/api/vana/data?requestId=${id}`).then((r) => r.json()),\n * });\n * return <button disabled={connect.state.type !== \"idle\"} onClick={connect.start}>Connect</button>;\n * ```\n */\nexport function useDirectVanaConnect<T = unknown>(\n  options: UseDirectVanaConnectOptions<T>,\n): UseDirectVanaConnectResult<T> {\n  // Keep the latest options in a ref so the store reads current callbacks\n  // without being recreated on every render.\n  const optionsRef = useRef(options);\n  optionsRef.current = options;\n\n  const flow = useMemo(\n    () =>\n      createDirectConnectFlow<T>(\n        {\n          createRequest: () => optionsRef.current.createRequest(),\n          getStatus: (id) => optionsRef.current.getStatus(id),\n          readResult: (id) => optionsRef.current.readResult(id),\n        },\n        {\n          get pollIntervalMs() {\n            return optionsRef.current.pollIntervalMs;\n          },\n          get timeoutMs() {\n            return optionsRef.current.timeoutMs;\n          },\n          get openWindow() {\n            return optionsRef.current.openWindow;\n          },\n        },\n      ),\n    // Created once per component instance; callbacks are read via optionsRef.\n    [],\n  );\n\n  const state = useSyncExternalStore(\n    flow.subscribe,\n    flow.getState,\n    flow.getState,\n  );\n\n  const start = useCallback(() => {\n    void flow.start();\n  }, [flow]);\n\n  const reset = useCallback(() => {\n    flow.reset();\n  }, [flow]);\n\n  return { state, start, reset };\n}\n"],"mappings":"AAgBA,SAAS,aAAa,SAAS,QAAQ,4BAA4B;AACnE;AAAA,EACE;AAAA,OAIK;AAiCA,SAAS,qBACd,SAC+B;AAG/B,QAAM,aAAa,OAAO,OAAO;AACjC,aAAW,UAAU;AAErB,QAAM,OAAO;AAAA,IACX,MACE;AAAA,MACE;AAAA,QACE,eAAe,MAAM,WAAW,QAAQ,cAAc;AAAA,QACtD,WAAW,CAAC,OAAO,WAAW,QAAQ,UAAU,EAAE;AAAA,QAClD,YAAY,CAAC,OAAO,WAAW,QAAQ,WAAW,EAAE;AAAA,MACtD;AAAA,MACA;AAAA,QACE,IAAI,iBAAiB;AACnB,iBAAO,WAAW,QAAQ;AAAA,QAC5B;AAAA,QACA,IAAI,YAAY;AACd,iBAAO,WAAW,QAAQ;AAAA,QAC5B;AAAA,QACA,IAAI,aAAa;AACf,iBAAO,WAAW,QAAQ;AAAA,QAC5B;AAAA,MACF;AAAA,IACF;AAAA;AAAA,IAEF,CAAC;AAAA,EACH;AAEA,QAAM,QAAQ;AAAA,IACZ,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,EACP;AAEA,QAAM,QAAQ,YAAY,MAAM;AAC9B,SAAK,KAAK,MAAM;AAAA,EAClB,GAAG,CAAC,IAAI,CAAC;AAET,QAAM,QAAQ,YAAY,MAAM;AAC9B,SAAK,MAAM;AAAA,EACb,GAAG,CAAC,IAAI,CAAC;AAET,SAAO,EAAE,OAAO,OAAO,MAAM;AAC/B;","names":[]}

package/dist/index.browser.d.ts

@@ -35,13 +35,18 @@ export { encryptWithPassword, decryptWithPassword, } from "./crypto/envelope/ope
 export { parseWeb3SignedHeader, verifyWeb3Signed, type Web3SignedPayload, type VerifiedAuth, } from "./auth/web3-signed";
 export { buildWeb3SignedHeader, computeBodyHash, type Web3SignedSignFn, } from "./auth/web3-signed-builder";
 export { MissingAuthError, InvalidSignatureError, ExpiredTokenError, } from "./auth/errors";
-export { fileRegistrationDomain, fileDeletionDomain, grantRegistrationDomain, grantRevocationDomain, serverRegistrationDomain, builderRegistrationDomain, FILE_REGISTRATION_TYPES, FILE_DELETION_TYPES, GRANT_REGISTRATION_TYPES, GRANT_REVOCATION_TYPES, SERVER_REGISTRATION_TYPES, BUILDER_REGISTRATION_TYPES, type DataPortabilityContracts, type DataPortabilityGatewayConfig, type FileRegistrationMessage, type FileDeletionMessage, type GrantRegistrationMessage, type GrantRevocationMessage, type ServerRegistrationMessage, type BuilderRegistrationMessage, } from "./protocol/eip712";
+export { NATIVE_VANA_ASSET, dataRegistryDomain, grantRegistrationDomain, grantRevocationDomain, serverRegistrationDomain, builderRegistrationDomain, escrowPaymentDomain, GRANT_REGISTRATION_TYPES, GRANT_REVOCATION_TYPES, SERVER_REGISTRATION_TYPES, BUILDER_REGISTRATION_TYPES, ADD_DATA_TYPES, RECORD_DATA_ACCESS_TYPES, type DataPortabilityContracts, type DataPortabilityGatewayConfig, type GrantRegistrationMessage, type GrantRevocationMessage, type ServerRegistrationMessage, type BuilderRegistrationMessage, type AddDataMessage, type RecordDataAccessMessage, } from "./protocol/eip712";
 export { PERSONAL_SERVER_REGISTRATION_DEFAULT_CHAIN_ID, PERSONAL_SERVER_REGISTRATION_DEFAULT_VERIFYING_CONTRACT, personalServerRegistrationDomain, createViemPersonalServerRegistrationSigner, buildPersonalServerRegistrationTypedData, buildPersonalServerRegistrationSignature, registerPersonalServerSignature, type PersonalServerRegistrationTypedData, type PersonalServerRegistrationSigner, type PersonalServerRegistrationDomainInput, type ViemPersonalServerRegistrationWalletClient, type ViemPersonalServerRegistrationSignerSource, type BuildPersonalServerRegistrationTypedDataInput, type BuildPersonalServerRegistrationSignatureInput, type PersonalServerRegistrationSignature, } from "./protocol/personal-server-registration";
-export { PERSONAL_SERVER_LITE_OWNER_BINDING_VERSION, PERSONAL_SERVER_LITE_OWNER_BINDING_PURPOSE, PERSONAL_SERVER_LITE_OWNER_BINDING_PREFIX, buildPersonalServerLiteOwnerBindingMessage, createViemPersonalServerLiteOwnerBindingSigner, buildPersonalServerLiteOwnerBindingSignature, signPersonalServerLiteOwnerBinding, type PersonalServerLiteOwnerBindingPurpose, type PersonalServerLiteOwnerBindingMessage, type PersonalServerLiteOwnerBindingSigner, type ViemPersonalServerLiteOwnerBindingWalletClient, type ViemPersonalServerLiteOwnerBindingSignerSource, type BuildPersonalServerLiteOwnerBindingSignatureInput, type PersonalServerLiteOwnerBindingSignature, } from "./protocol/personal-server-lite-owner-binding";
+export { PERSONAL_SERVER_LITE_OWNER_BINDING_VERSION, PERSONAL_SERVER_LITE_OWNER_BINDING_PURPOSE, PERSONAL_SERVER_LITE_OWNER_BINDING_PREFIX, buildPersonalServerLiteOwnerBindingMessage, createViemPersonalServerLiteOwnerBindingSigner, buildPersonalServerLiteOwnerBindingSignature, signPersonalServerLiteOwnerBinding, type PersonalServerLiteOwnerBindingPurpose, type PersonalServerLiteOwnerBindingMessage, type PersonalServerLiteOwnerBindingSigner, type ViemPersonalServerLiteOwnerBindingWalletClient, type ViemPersonalServerLiteOwnerBindingSignerSource, type BuildPersonalServerLiteOwnerBindingSignatureInput, type PersonalServerLiteOwnerBindingSignature, } from "./personal-server-lite/owner-binding";
 export { ACCOUNT_PERSONAL_SERVER_REGISTRATION_INTENT, AccountPersonalServerRegistrationError, signPersonalServerRegistrationWithAccount, type AccountPersonalServerRegistrationIntent, type AccountPersonalServerRegistrationSignature, type AccountPersonalServerRegistrationStatus, type AccountPersonalServerRegistrationRequest, type AccountPersonalServerRegistrationConfig, type AccountSignedPersonalServerRegistration, type AccountConfirmationRequiredPersonalServerRegistration, type AccountFallbackSignedPersonalServerRegistration, type AccountPersonalServerRegistrationResult, } from "./account/personal-server-registration";
 export { AccountPersonalServerLiteOwnerBindingError, signPersonalServerLiteOwnerBindingWithAccountClient, type AccountPersonalServerLiteOwnerBindingClient, type SignPersonalServerLiteOwnerBindingWithAccountClientConfig, } from "./account/personal-server-lite-owner-binding";
-export { isDataPortabilityGatewayConfig, parseGrantRegistrationPayload, verifyGrantRegistration, type DataPortabilityGrantPayload, type VerifyGrantRegistrationInput, type VerifyGrantRegistrationResult, } from "./protocol/grants";
+export { isDataPortabilityGatewayConfig, verifyGrantRegistration, type VerifyGrantRegistrationInput, type VerifyGrantRegistrationResult, } from "./protocol/grants";
+export { FEE_REGISTRY_ABI, REGISTRATION_KIND_FOR_OP, getFee, getOpFee, type FeeKind, type FeeEntry, type OpFee, type FeeRegistryOptions, } from "./protocol/fee-registry";
+export { escrowContractAddress, encodeDepositNativeData, encodeDepositTokenData, buildDepositNativeRequest, buildDepositTokenRequest, type DepositNativeInput, type DepositTokenInput, type DepositTransactionRequest, } from "./protocol/escrow-deposit";
+export { DATA_REGISTRY_STATUS_ABI, DataPointStatus, dataRegistryContractAddress, encodeSetDataPointStatusData, buildSetDataPointStatusRequest, buildMarkDataPointUnavailableRequest, type SetDataPointStatusInput, type DataPointStatusTransactionRequest, } from "./protocol/data-point-status";
+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 GatewayGrantResponse, type GrantListItem, type FileRecord, type FileListResult, type ListFilesOptions, type RegisterServerParams, type RegisterServerResult, type RegisterFileParams, type CreateGrantParams, type RevokeGrantParams, type DeleteFileParams, type GatewayClient, } from "./protocol/gateway";
+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 { 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";