@enbox/auth 0.4.0 → 0.6.0

package/src/{flows/wallet-connect.ts → connect/wallet.ts}

@@ -1,32 +1,24 @@
 /**
- * Wallet connect (OIDC/QR) flow.
+ * Wallet connect (Enbox Connect relay) flow.
  *
- * Connects to an external wallet via the WalletConnect relay protocol,
+ * Connects to an external wallet via the Enbox Connect relay protocol,
  * importing a delegated DID with permission grants.
  * This replaces the "Mode B/C" paths in Enbox.connect().
  * @module
  */
 
-import { Convert } from '@enbox/common';
-import { WalletConnect } from '@enbox/agent';
 import type { DwnDataEncodedRecordsWriteMessage, DwnMessagesPermissionScope, DwnRecordsPermissionScope, EnboxUserAgent } from '@enbox/agent';
-import { DwnInterface, DwnPermissionGrant } from '@enbox/agent';
 
-import type { AuthEventEmitter } from '../events.js';
-import { AuthSession } from '../identity-session.js';
-import { registerWithDwnEndpoints } from './dwn-registration.js';
-import { STORAGE_KEYS } from '../types.js';
-import type { RegistrationOptions, StorageAdapter, SyncOption, WalletConnectOptions } from '../types.js';
-
-/** @internal */
-export interface WalletConnectContext {
-  userAgent: EnboxUserAgent;
-  emitter: AuthEventEmitter;
-  storage: StorageAdapter;
-  defaultSync?: SyncOption;
-  defaultDwnEndpoints?: string[];
-  registration?: RegistrationOptions;
-}
+import type { AuthSession } from '../identity-session.js';
+import type { FlowContext } from './lifecycle.js';
+import type { WalletConnectOptions } from '../types.js';
+
+import { Convert } from '@enbox/common';
+import { registerWithDwnEndpoints } from '../registration.js';
+import { WalletConnect } from '../wallet-connect-client.js';
+import { DEFAULT_DWN_ENDPOINTS, STORAGE_KEYS } from '../types.js';
+import { DwnInterface, DwnPermissionGrant } from '@enbox/agent';
+import { ensureVaultReady, finalizeSession, resolvePassword, startSyncIfEnabled } from './lifecycle.js';
 
 /**
  * Process connected grants by storing them in the local DWN as the owner.
@@ -86,7 +78,7 @@ export async function processConnectedGrants(params: {
  * 3. Sets up sync and returns an AuthSession.
  */
 export async function walletConnect(
-  ctx: WalletConnectContext,
+  ctx: FlowContext,
   options: WalletConnectOptions,
 ): Promise<AuthSession> {
   const { userAgent, emitter, storage } = ctx;
@@ -99,12 +91,23 @@ export async function walletConnect(
     );
   }
 
-  // Run the full OIDC wallet connect flow.
+  // Ensure the agent is initialized and started before the relay flow.
+  const isFirstLaunch = await userAgent.firstLaunch();
+  const password = await resolvePassword(ctx, undefined, isFirstLaunch);
+
+  await ensureVaultReady({
+    userAgent,
+    emitter,
+    password,
+    isFirstLaunch,
+  });
+
+  // Run the Enbox Connect relay flow.
   // permissionRequests are already agent-level ConnectPermissionRequest objects.
   const result = await WalletConnect.initClient({
     displayName        : options.displayName,
     connectServerUrl   : options.connectServerUrl,
-    walletUri          : options.walletUri ?? 'web5://connect',
+    walletUri          : options.walletUri ?? 'enbox://connect',
     permissionRequests : options.permissionRequests,
     onWalletUriReady   : options.onWalletUriReady,
     validatePin        : options.validatePin,
@@ -140,13 +143,14 @@ export async function walletConnect(
 
     // Register with DWN endpoints (if registration options are provided).
     if (ctx.registration) {
-      const dwnEndpoints = ctx.defaultDwnEndpoints ?? ['https://enbox-dwn.fly.dev'];
+      const dwnEndpoints = ctx.defaultDwnEndpoints ?? DEFAULT_DWN_ENDPOINTS;
       await registerWithDwnEndpoints(
         {
           userAgent : userAgent,
           dwnEndpoints,
           agentDid  : userAgent.agentDid.uri,
           connectedDid,
+          storage   : storage,
         },
         ctx.registration,
       );
@@ -183,43 +187,23 @@ export async function walletConnect(
     throw new Error(`[@enbox/auth] Wallet connect failed: ${message}`);
   }
 
-  // Start sync.
-  const syncMode = sync === undefined ? 'live' : 'poll';
-  const syncInterval = sync ?? (syncMode === 'live' ? '5m' : '2m');
-  userAgent.sync.startSync({ mode: syncMode, interval: syncInterval })
-    .catch((err: unknown) => {
-      console.error('[@enbox/auth] Sync failed:', err);
-    });
-
   const delegateDid = delegatePortableDid.uri;
 
-  // Persist session info.
-  await storage.set(STORAGE_KEYS.PREVIOUSLY_CONNECTED, 'true');
-  await storage.set(STORAGE_KEYS.ACTIVE_IDENTITY, connectedDid);
-  await storage.set(STORAGE_KEYS.DELEGATE_DID, delegateDid);
-  await storage.set(STORAGE_KEYS.CONNECTED_DID, connectedDid);
-
-  const identityInfo = {
-    didUri       : connectedDid,
-    name         : identity.metadata.name,
-    connectedDid : identity.metadata.connectedDid,
-  };
-
-  const session = new AuthSession({
-    agent    : userAgent,
-    did      : connectedDid,
+  // Start sync.
+  startSyncIfEnabled(userAgent, sync);
+
+  // Persist session info, build AuthSession, and emit lifecycle events.
+  return finalizeSession({
+    userAgent,
+    emitter,
+    storage,
+    connectedDid,
     delegateDid,
-    identity : identityInfo,
-  });
-
-  emitter.emit('identity-added', { identity: identityInfo });
-  emitter.emit('session-start', {
-    session: {
-      did      : session.did,
-      delegateDid,
-      identity : identityInfo,
+    identityName         : identity.metadata.name,
+    identityConnectedDid : identity.metadata.connectedDid,
+    extraStorageKeys     : {
+      [STORAGE_KEYS.DELEGATE_DID]  : delegateDid,
+      [STORAGE_KEYS.CONNECTED_DID] : connectedDid,
     },
   });
-
-  return session;
 }

package/src/{flows/dwn-discovery.ts → discovery.ts}

@@ -7,42 +7,39 @@
  *
  * ## Discovery channels (browser, highest to lowest priority)
  *
- * 1. **URL fragment payload** — A `dwn://register` redirect just landed
+ * 1. **URL fragment payload** — A `dwn://connect` redirect just landed
  *    on the page with the endpoint in `#`. Highest priority because it's
  *    fresh and explicit.
  * 2. **Persisted endpoint** (localStorage) — A previously discovered
  *    endpoint restored and re-validated via `GET /info`.
- * 3. **Agent-level discovery** (transparent, runs on every `sendRequest`)
- *    — `~/.enbox/dwn.json` discovery file (Node/Bun only; skipped in
- *    browsers) and sequential port probing on `127.0.0.1:{3000,55500–55509}`.
- *    This channel works even if the browser-specific functions here
- *    return `false`.
  *
  * ## Discovery channels (CLI / native, all transparent)
  *
- * In Node/Bun environments, all discovery happens automatically inside
+ * In Node/Bun environments, the agent's `LocalDwnDiscovery` reads the
+ * `~/.enbox/dwn.json` discovery file automatically inside
  * `AgentDwnApi.getLocalDwnEndpoint()`. The browser-specific functions
  * in this module (`checkUrlForDwnDiscoveryPayload`, `requestLocalDwnDiscovery`)
- * are not needed — the agent reads `~/.enbox/dwn.json` and probes ports
- * on its own.
+ * are not needed in those environments.
  *
- * @see https://github.com/enboxorg/enbox/issues/589
+ * @see https://github.com/enboxorg/enbox/issues/677
  * @module
  */
 
 import type { EnboxUserAgent } from '@enbox/agent';
 
-import { buildDwnRegisterUrl, readDwnDiscoveryPayloadFromUrl } from '@enbox/agent';
+import { EnboxRpcClient } from '@enbox/dwn-clients';
+import { buildDwnConnectUrl, localDwnServerName, normalizeBaseUrl, readDwnDiscoveryPayloadFromUrl } from '@enbox/agent';
 
-import type { AuthEventEmitter } from '../events.js';
-import { STORAGE_KEYS } from '../types.js';
-import type { StorageAdapter } from '../types.js';
+import type { AuthEventEmitter } from './events.js';
+import type { StorageAdapter } from './types.js';
+
+import { STORAGE_KEYS } from './types.js';
 
 /**
  * Check the current page URL for a `DwnDiscoveryPayload` in the fragment.
  *
  * This is called once at the start of a connection flow to detect whether
- * the user was just redirected back from a `dwn://register` handler. If a
+ * the user was just redirected back from a `dwn://connect` handler. If a
  * valid payload is found, the endpoint is persisted and the fragment is
  * cleared to prevent double-reads.
  *
@@ -69,6 +66,83 @@ export function checkUrlForDwnDiscoveryPayload(): string | undefined {
   return payload.endpoint;
 }
 
+// ─── Standalone (pre-agent) discovery ───────────────────────────
+
+/**
+ * Validate a local DWN endpoint by calling `GET /info` and checking
+ * that the server identifies itself as `@enbox/dwn-server`.
+ *
+ * This function has **zero** agent or vault dependencies — it only uses
+ * the network. It is safe to call before the agent exists.
+ *
+ * @param endpoint - The candidate endpoint URL.
+ * @returns The normalised endpoint if valid, `undefined` otherwise.
+ */
+async function validateEndpointStandalone(endpoint: string): Promise<string | undefined> {
+  const normalized = normalizeBaseUrl(endpoint);
+  try {
+    const rpc = new EnboxRpcClient();
+    const serverInfo = await rpc.getServerInfo(normalized);
+    if (serverInfo.server === localDwnServerName) {
+      return normalized;
+    }
+  } catch {
+    // Server not reachable or not ours.
+  }
+  return undefined;
+}
+
+/**
+ * Run local DWN discovery **before the agent exists**.
+ *
+ * This is the standalone counterpart of {@link applyLocalDwnDiscovery} and
+ * is designed to be called in `AuthManager.create()`, before
+ * `EnboxUserAgent.create()`, so the agent creation can decide whether to
+ * spin up an in-process DWN or operate in remote mode.
+ *
+ * Discovery channels (highest → lowest priority):
+ * 1. **URL fragment payload** — A `dwn://connect` redirect just landed.
+ * 2. **Persisted endpoint** (localStorage) — A previously discovered
+ *    endpoint, re-validated via `GET /info`.
+ *
+ * When a valid endpoint is found it is persisted to storage. When a
+ * previously-persisted endpoint is stale, it is removed.
+ *
+ * @param storage - The auth storage adapter (for reading/writing the
+ *   cached endpoint).
+ * @returns The validated endpoint URL, or `undefined` if no local DWN
+ *   server is available.
+ */
+export async function discoverLocalDwn(
+  storage: StorageAdapter,
+): Promise<string | undefined> {
+  // Channel 1: Fresh redirect payload in the URL fragment.
+  const freshEndpoint = checkUrlForDwnDiscoveryPayload();
+  if (freshEndpoint) {
+    const validated = await validateEndpointStandalone(freshEndpoint);
+    if (validated) {
+      await persistLocalDwnEndpoint(storage, validated);
+      return validated;
+    }
+    // Payload was in the URL but the server is unreachable — fall through.
+  }
+
+  // Channel 2: Persisted endpoint from a previous session.
+  const cached = await storage.get(STORAGE_KEYS.LOCAL_DWN_ENDPOINT);
+  if (cached) {
+    const validated = await validateEndpointStandalone(cached);
+    if (validated) {
+      return validated;
+    }
+    // Stale — server no longer running.
+    await clearLocalDwnEndpoint(storage);
+  }
+
+  return undefined;
+}
+
+// ─── Storage helpers ────────────────────────────────────────────
+
 /**
  * Persist a discovered local DWN endpoint in auth storage.
  *
@@ -130,25 +204,18 @@ export async function restoreLocalDwnEndpoint(
  * Run the full local DWN discovery sequence for a browser connection flow.
  *
  * This function handles the **receiving** side of local DWN discovery in
- * the browser. It does NOT trigger the `dwn://register` redirect — use
+ * the browser. It does NOT trigger the `dwn://connect` redirect — use
  * {@link requestLocalDwnDiscovery} for that.
  *
  * The discovery channels, from highest to lowest priority:
  *
- * 1. **URL fragment payload** — A `dwn://register` redirect just landed on
+ * 1. **URL fragment payload** — A `dwn://connect` redirect just landed on
  *    this page with the DWN endpoint in `#`. This is the highest-priority
  *    signal because it's fresh and explicit.
  *
  * 2. **Persisted endpoint** (localStorage) — A previously discovered
  *    endpoint is restored and re-validated via `GET /info`.
  *
- * 3. **Agent-level discovery** (transparent) — Even if this function
- *    returns `false`, the agent's `LocalDwnDiscovery` will independently
- *    try the discovery file (`~/.enbox/dwn.json`) and port probing on
- *    every `sendRequest()` call. Those channels are not available in
- *    browsers (no filesystem access, CORS may block probes), but they
- *    work transparently in Node/Bun CLI environments.
- *
  * When an `emitter` is provided, this function emits:
  * - `'local-dwn-available'` with the endpoint when discovery succeeds.
  * - `'local-dwn-unavailable'` when no local DWN could be reached.
@@ -191,37 +258,31 @@ export async function applyLocalDwnDiscovery(
   return restored;
 }
 
-// ─── dwn://register trigger ─────────────────────────────────────
+// ─── dwn://connect trigger ──────────────────────────────────────
 
 /**
- * Initiate the `dwn://register` flow by opening the register URL.
+ * Initiate the `dwn://connect` flow by opening the connect URL.
  *
- * This asks the operating system to route `dwn://register?callback=<url>`
+ * This asks the operating system to route `dwn://connect?callback=<url>`
  * to the registered handler (electrobun-dwn), which will redirect the
  * user's browser back to `callbackUrl` with the local DWN endpoint
  * encoded in the URL fragment.
  *
- * **Important:** There is no reliable cross-browser API to detect whether
- * a `dwn://` handler is installed. If no handler is registered, this call
- * will silently fail or show an OS-level error dialog. Use
- * {@link probeLocalDwn} first to check if a local DWN is already
- * reachable via port probing — if it is, you can skip the register flow
- * entirely and call {@link applyLocalDwnDiscovery} instead.
+ * **Note:** There is no reliable cross-browser API to detect whether a
+ * `dwn://` handler is installed. If no handler is registered, this call
+ * will silently fail or show an OS-level error dialog.
  *
  * @param callbackUrl - The URL to redirect back to. Defaults to the
  *   current page URL (without its fragment) if running in a browser.
- * @returns `true` if the register URL was opened, `false` if no
+ * @returns `true` if the connect URL was opened, `false` if no
  *   callback URL could be determined (e.g. no `globalThis.location`).
  *
  * @example
  * ```ts
- * // Check if local DWN is already available via direct probe.
- * const alreadyAvailable = await probeLocalDwn();
- * if (!alreadyAvailable) {
- *   // No local DWN found — trigger the dwn://register flow.
- *   requestLocalDwnDiscovery();
- *   // The page will reload with the endpoint in the URL fragment.
- * }
+ * // Trigger the dwn://connect flow to discover a local DWN.
+ * requestLocalDwnDiscovery();
+ * // The page will reload with the endpoint in the URL fragment.
+ * // On the next connect/restore, applyLocalDwnDiscovery() reads it.
  * ```
  */
 export function requestLocalDwnDiscovery(callbackUrl?: string): boolean {
@@ -230,7 +291,7 @@ export function requestLocalDwnDiscovery(callbackUrl?: string): boolean {
     return false;
   }
 
-  const registerUrl = buildDwnRegisterUrl(resolvedCallback);
+  const registerUrl = buildDwnConnectUrl(resolvedCallback);
 
   // Open the dwn:// URL. Use window.open() rather than location.href
   // assignment to avoid navigating away from the current page if the
@@ -249,46 +310,6 @@ export function requestLocalDwnDiscovery(callbackUrl?: string): boolean {
   return false;
 }
 
-/**
- * Probe whether a local DWN server is reachable via direct HTTP fetch.
- *
- * Attempts `GET http://127.0.0.1:{port}/info` on the well-known port
- * candidates and returns the endpoint URL of the first server that
- * responds with a valid `@enbox/dwn-server` identity.
- *
- * This is useful in browsers to check if a local DWN is available
- * *before* triggering the `dwn://register` redirect flow — if the
- * server is already reachable (CORS permitting), the redirect is
- * unnecessary.
- *
- * @returns The local DWN endpoint URL, or `undefined` if no server
- *   was found. Returns `undefined` (rather than throwing) on CORS
- *   errors or network failures.
- */
-export async function probeLocalDwn(): Promise<string | undefined> {
-  // Import port candidates from @enbox/agent. Using a dynamic import
-  // here keeps the function self-contained and avoids circular deps.
-  const { localDwnPortCandidates, localDwnHostCandidates } = await import('@enbox/agent');
-
-  for (const port of localDwnPortCandidates) {
-    for (const host of localDwnHostCandidates) {
-      const endpoint = `http://${host}:${port}`;
-      try {
-        const response = await fetch(`${endpoint}/info`, { signal: AbortSignal.timeout(2_000) });
-        if (!response.ok) { continue; }
-
-        const serverInfo = await response.json() as { server?: string };
-        if (serverInfo?.server === '@enbox/dwn-server') {
-          return endpoint;
-        }
-      } catch {
-        // Network error, CORS block, or timeout — try next candidate.
-      }
-    }
-  }
-  return undefined;
-}
-
 // ─── Internal helpers ───────────────────────────────────────────
 
 /** Return the current page URL without the fragment, or `undefined`. */

package/src/index.ts

@@ -37,26 +37,34 @@
 // Core classes
 export { AuthManager } from './auth-manager.js';
 export { AuthSession } from './identity-session.js';
-export { VaultManager } from './vault/vault-manager.js';
 export { AuthEventEmitter } from './events.js';
 
+// Password providers
+export { PasswordProvider } from './password-provider.js';
+export type { PasswordContext } from './password-provider.js';
+
 // Re-export agent classes so consumers can construct custom agents/vaults
 // without a direct @enbox/agent dependency.
 export { EnboxUserAgent, HdIdentityVault } from '@enbox/agent';
 
 // Wallet-connect helpers
-export { processConnectedGrants } from './flows/wallet-connect.js';
+export { processConnectedGrants } from './connect/wallet.js';
+export { WalletConnect } from './wallet-connect-client.js';
+export type { Permission, ProtocolPermissionOptions, WalletConnectClientOptions } from './wallet-connect-client.js';
+
+// Registration token storage helpers
+export { loadTokensFromStorage, saveTokensToStorage } from './registration.js';
 
 // Local DWN discovery (browser dwn:// protocol integration)
 export {
   applyLocalDwnDiscovery,
   checkUrlForDwnDiscoveryPayload,
   clearLocalDwnEndpoint,
+  discoverLocalDwn,
   persistLocalDwnEndpoint,
-  probeLocalDwn,
   requestLocalDwnDiscovery,
   restoreLocalDwnEndpoint,
-} from './flows/dwn-discovery.js';
+} from './discovery.js';
 
 // Storage adapters
 export { BrowserStorage, LevelStorage, MemoryStorage, createDefaultStorage } from './storage/storage.js';
@@ -71,6 +79,7 @@ export type {
   AuthState,
   ConnectPermissionRequest,
   DisconnectOptions,
+  HeadlessConnectOptions,
   IdentityInfo,
   IdentityVaultBackup,
   ImportFromPhraseOptions,
@@ -83,6 +92,7 @@ export type {
   RegistrationOptions,
   RegistrationTokenData,
   RestoreSessionOptions,
+  ShutdownOptions,
   StorageAdapter,
   SyncOption,
   WalletConnectOptions,