@sparkvault/sdk 1.23.9 → 1.24.0

package/dist/api-base.d.ts

@@ -0,0 +1,58 @@
+/**
+ * SparkVault API Base
+ *
+ * Shared lifecycle and HTTP plumbing for every internal API client in the
+ * SDK. Concrete clients (IdentityApi, UploadApi, ...) extend this and
+ * provide:
+ *   - their own error factory via makeError()
+ *   - their own typed endpoint methods that call rawRequest()
+ *
+ * Session lifecycle invariant: every user-facing session (a modal open, a
+ * verify flow, an upload widget invocation) starts with the owning Module
+ * calling resetSession(). close() aborts the current AbortController; the
+ * next resetSession() swaps in a fresh one. The Module is responsible for
+ * this; clients of the SDK never see any of it.
+ */
+import { SparkVaultError } from './errors';
+export interface RawRequestOptions {
+    method: string;
+    body?: string;
+    headers?: Record<string, string>;
+}
+export interface RawResponse {
+    data: unknown;
+    status: number;
+}
+export declare abstract class SparkVaultApi {
+    protected readonly timeoutMs: number;
+    /**
+     * Abort controller for the current session. Replaced by resetSession()
+     * at the start of every user-facing session — an aborted controller can
+     * never leak into the next session.
+     */
+    private closeController;
+    constructor(timeoutMs?: number);
+    /** Abort all pending requests on this client. Called by the Module on close. */
+    abort(): void;
+    /** Whether the *current* session has been aborted. */
+    isAborted(): boolean;
+    /** The current session's abort signal — for callers that need to wire it into XHR/etc. */
+    getAbortSignal(): AbortSignal;
+    /**
+     * Swap in a fresh AbortController. The Module calls this at the start of
+     * every user-facing session. Long-lived per-client state (e.g. config
+     * caches) is intentionally NOT cleared here.
+     */
+    resetSession(): void;
+    /** Subclass-specific error factory. */
+    protected abstract makeError(message: string, code: string, statusCode: number): SparkVaultError;
+    /**
+     * Issue an HTTP request with timeout + session abort + standard error
+     * mapping. Subclasses build URLs and unwrap response envelopes on top.
+     *
+     * Returns the parsed JSON body (whatever shape it takes) plus the
+     * status code. Throws subclass-typed errors via makeError() for: aborted
+     * sessions, timeouts, network failures, and non-2xx responses.
+     */
+    protected rawRequest(url: string, options: RawRequestOptions): Promise<RawResponse>;
+}

package/dist/identity/api.d.ts

@@ -5,36 +5,16 @@
  * Single responsibility: API calls only.
  */
 import type { ResolvedConfig } from '../config';
+import { SparkVaultApi } from '../api-base';
+import { SparkVaultError } from '../errors';
 import type { SdkConfig, TotpSendResponse, TotpVerifyResponse, PasskeyChallengeResponse, PasskeyVerifyResponse, SparkLinkSendResponse, AuthContext } from './types';
-export declare class IdentityApi {
+export declare class IdentityApi extends SparkVaultApi {
     private readonly config;
-    private readonly timeoutMs;
     /** Cached config promise - allows preloading and deduplication */
     private configCache;
-    /**
-     * Abort controller for cancelling all pending requests on close.
-     * Replaced by resetSession() at the start of every user-facing session.
-     */
-    private closeController;
     constructor(config: ResolvedConfig, timeoutMs?: number);
-    /**
-     * Abort all pending requests.
-     * Call this when the renderer is closed to prevent orphaned requests.
-     */
-    abort(): void;
-    /**
-     * Check if the API has been aborted.
-     */
-    isAborted(): boolean;
-    /**
-     * Reset the session lifecycle by swapping in a fresh AbortController.
-     * The Module calls this at the start of every user-facing session so a
-     * previously-closed session can never leak its aborted state into the
-     * next one. The config cache is intentionally preserved across sessions
-     * so preloadConfig() keeps making modal opens instant.
-     */
-    resetSession(): void;
     private get baseUrl();
+    protected makeError(message: string, code: string, statusCode: number): IdentityApiError;
     private request;
     /**
      * Fetch SDK configuration (branding, enabled methods).
@@ -120,8 +100,6 @@ export declare class IdentityApi {
      */
     sendSparkLink(email: string, connectionId: string, authContext?: AuthContext): Promise<SparkLinkSendResponse>;
 }
-export declare class IdentityApiError extends Error {
-    readonly code: string;
-    readonly statusCode: number;
+export declare class IdentityApiError extends SparkVaultError {
     constructor(message: string, code: string, statusCode: number);
 }

package/dist/index.d.ts

@@ -117,6 +117,37 @@ interface TokenClaims {
     method: string;
 }
 
+/**
+ * SparkVault SDK Error Types
+ */
+declare class SparkVaultError extends Error {
+    readonly code: string;
+    readonly statusCode?: number;
+    readonly details?: Record<string, unknown>;
+    constructor(message: string, code: string, statusCode?: number, details?: Record<string, unknown>);
+}
+declare class AuthenticationError extends SparkVaultError {
+    constructor(message: string, details?: Record<string, unknown>);
+}
+declare class AuthorizationError extends SparkVaultError {
+    constructor(message: string, details?: Record<string, unknown>);
+}
+declare class ValidationError extends SparkVaultError {
+    constructor(message: string, details?: Record<string, unknown>);
+}
+declare class NetworkError extends SparkVaultError {
+    constructor(message: string, details?: Record<string, unknown>);
+}
+declare class TimeoutError extends SparkVaultError {
+    constructor(message?: string);
+}
+declare class UserCancelledError extends SparkVaultError {
+    constructor(message?: string);
+}
+declare class PopupBlockedError extends SparkVaultError {
+    constructor();
+}
+
 /**
  * Identity Module
  *
@@ -455,37 +486,6 @@ interface UploadResult {
     uploadTime: string;
 }
 
-/**
- * SparkVault SDK Error Types
- */
-declare class SparkVaultError extends Error {
-    readonly code: string;
-    readonly statusCode?: number;
-    readonly details?: Record<string, unknown>;
-    constructor(message: string, code: string, statusCode?: number, details?: Record<string, unknown>);
-}
-declare class AuthenticationError extends SparkVaultError {
-    constructor(message: string, details?: Record<string, unknown>);
-}
-declare class AuthorizationError extends SparkVaultError {
-    constructor(message: string, details?: Record<string, unknown>);
-}
-declare class ValidationError extends SparkVaultError {
-    constructor(message: string, details?: Record<string, unknown>);
-}
-declare class NetworkError extends SparkVaultError {
-    constructor(message: string, details?: Record<string, unknown>);
-}
-declare class TimeoutError extends SparkVaultError {
-    constructor(message?: string);
-}
-declare class UserCancelledError extends SparkVaultError {
-    constructor(message?: string);
-}
-declare class PopupBlockedError extends SparkVaultError {
-    constructor();
-}
-
 /**
  * Vaults Module
  *