@koolbase/react-native 9.1.0 → 10.0.0

package/dist/auth.d.ts

@@ -1,199 +0,0 @@
-import { AuthStateListener, KoolbaseConfig, KoolbaseSession, KoolbaseUser, LinkPhoneParams, LoginParams, OtpSendResult, PhoneVerifyResult, RegisterParams, RestoreResult, SendOtpParams, SignInWithAppleParams, VerifyOtpParams } from './types';
-import type { SignInWithGoogleParams } from './types';
-export declare class KoolbaseAuth {
-    private config;
-    private storage;
-    private session;
-    private metadata;
-    private fetchFn;
-    private timeoutMs;
-    private ongoingRefresh;
-    private listeners;
-    constructor(config: KoolbaseConfig);
-    /**
-     * Subscribe to authentication state changes. The listener fires:
-     * - Immediately on subscribe, with the current user (or null).
-     * - On every successful login, register, refresh, session restoration.
-     * - On logout / explicit setSession(null).
-     * - On linkPhone success (user object updated with phone fields).
-     *
-     * Returns an unsubscribe function. Call it when the consumer no longer
-     * needs updates (e.g. in a React useEffect cleanup).
-     *
-     * Listener errors are swallowed so a buggy listener can't break auth
-     * state propagation to other listeners.
-     *
-     * @example
-     * const unsubscribe = auth.onAuthStateChange((user) => {
-     *   setCurrentUser(user);
-     * });
-     * // later:
-     * unsubscribe();
-     */
-    onAuthStateChange(listener: AuthStateListener): () => void;
-    private fireAuthStateChange;
-    /**
-     * Compose the full header set for an outbound request: base headers,
-     * device metadata, and optionally the Authorization bearer token.
-     * Async because device metadata's first build may read from keychain.
-     */
-    private prepareHeaders;
-    /**
-     * Low-level request helper used by every endpoint. Wires together:
-     * - The injected fetch implementation (config.fetch or global fetch)
-     * - Device metadata + x-api-key + auth header in one place
-     * - AbortController-based timeout (config.authTimeout, default 10s)
-     *
-     * On timeout, fetch rejects with an AbortError; callers see this as a
-     * non-KoolbaseAuthError exception, which restoreSession() treats as
-     * Offline (preserving optimistic state).
-     */
-    private authRequest;
-    /**
-     * Authenticated request wrapper. Refreshes the access token if it's
-     * stale (within 1-min buffer of expiry) before issuing the call, then
-     * delegates to {@link authRequest} with includeAuth=true.
-     */
-    private authedRequest;
-    private setSessionInternal;
-    private clearSessionInternal;
-    restoreSession(): Promise<RestoreResult>;
-    register(params: RegisterParams): Promise<KoolbaseUser>;
-    login(params: LoginParams): Promise<KoolbaseSession>;
-    /**
-   * Sign in with Apple using a credential obtained from a native Apple
-   * Sign-In SDK.
-   *
-   * The SDK is library-agnostic — use any native Apple Sign-In package
-   * (`@invertase/react-native-apple-authentication`, etc.) and pass the
-   * resulting `identityToken`, optional `nonce`, and optional `fullName`.
-   *
-   * `fullName` is meaningful only on first sign-in — Apple omits name
-   * data on subsequent sign-ins. The server persists at link time and
-   * ignores on subsequent sign-ins.
-   *
-   * On success the session is persisted via the configured storage and
-   * `onAuthStateChange` fires with the resolved user.
-   *
-   * @throws AppleSignInNotConfiguredError when Apple is not enabled in
-   *   the dashboard OAuth config for this environment (400).
-   * @throws InvalidAppleTokenError when the token signature, audience,
-   *   expiry, replay, or nonce check failed server-side (401).
-   * @throws UserDisabledError when the account flag is set to disabled (403).
-   * @throws AppleEmailRequiredError when Apple did not return email for
-   *   a new-account sign-in (400).
-   * @throws OAuthEmailConflictError when email matches existing user
-   *   but auto-link rule blocked (409).
-   */
-    signInWithApple(params: SignInWithAppleParams): Promise<KoolbaseSession>;
-    /**
-     * Sign in with Google using an idToken from a native Google Sign-In SDK.
-     *
-     * The SDK is library-agnostic — use any native Google Sign-In package
-     * (`@react-native-google-signin/google-signin`, etc.) and pass the
-     * resulting `idToken`. Google embeds the user's name and email in the
-     * idToken itself, so this method does not take a `fullName` parameter
-     * (unlike `signInWithApple`).
-     *
-     * On success the session is persisted via the configured storage and
-     * `onAuthStateChange` fires with the resolved user.
-     *
-     * @throws GoogleSignInNotConfiguredError when Google is not enabled
-     *   in the OAuth config for this environment (400).
-     * @throws InvalidGoogleTokenError when the token signature, audience,
-     *   expiry, replay, or nonce check failed server-side (401).
-     * @throws UserDisabledError when the account flag is set to disabled (403).
-     * @throws GoogleEmailRequiredError when Google did not return email
-     *   for a new-account sign-in (400).
-     * @throws OAuthEmailConflictError when email matches existing user
-     *   but auto-link rule blocked (409).
-     */
-    signInWithGoogle(params: SignInWithGoogleParams): Promise<KoolbaseSession>;
-    /**
-     * Parses a /v1/sdk/auth/oauth/google response. Code-first: the server
-     * emits unified OAuth codes (oauth_not_configured, invalid_oauth_token,
-     * oauth_email_required, oauth_email_conflict) for both providers; the
-     * provider distinction is made here so Google codes map to Google-specific
-     * errors. Status + message logic is retained as a fallback for older servers.
-     */
-    private parseGoogleSessionResponse;
-    /**
-     * Parses a /v1/sdk/auth/oauth/apple response. Code-first; the provider
-     * distinction is made here so the server's unified OAuth codes map to
-     * Apple-specific errors. Status + message logic is retained as a fallback
-     * for older servers.
-     */
-    private parseAppleSessionResponse;
-    refresh(refreshToken?: string): Promise<KoolbaseSession>;
-    private _doRefresh;
-    logout(): Promise<boolean>;
-    forgotPassword(email: string): Promise<void>;
-    resetPassword(token: string, password: string): Promise<void>;
-    unlock(token: string): Promise<void>;
-    get currentUser(): KoolbaseUser | null;
-    get accessToken(): string | null;
-    /**
-     * Currently-valid access token for data-plane requests, refreshing
-     * (via refresh()) if the cached one is near expiry. Returns null when no
-     * session exists or refresh fails — callers then go api-key-only and the
-     * server treats it as having no end-user identity. The db/storage/functions
-     * clients pull from this per request so identity follows the live session.
-     */
-    validAccessToken(): Promise<string | null>;
-    setSession(session: KoolbaseSession | null): Promise<void>;
-    /**
-     * @deprecated v1.9.0: Server endpoint /v1/sdk/auth/oauth not yet
-     * shipped. This method previously routed to /v1/auth/oauth (dashboard
-     * developer OAuth) which never created project-scoped end-user
-     * sessions. Properly implemented in v1.10.0 with provider-specific
-     * server endpoints under /v1/sdk/auth/oauth/{apple,google,github}.
-     * Use email/password sign-in for now.
-     *
-     * @throws Always throws KoolbaseAuthError('not_implemented').
-     */
-    oauthLogin(_params: {
-        provider: string;
-        token: string;
-        email?: string;
-        name?: string;
-        avatarUrl?: string;
-    }): Promise<never>;
-    sendOtp(params: SendOtpParams): Promise<OtpSendResult>;
-    verifyOtp(params: VerifyOtpParams): Promise<PhoneVerifyResult>;
-    linkPhone(params: LinkPhoneParams): Promise<void>;
-    /**
-     * Release resources held by this auth client. Clears the in-memory
-     * listener set. Does not invalidate sessions or clear storage — call
-     * {@link logout} for that.
-     */
-    dispose(): void;
-    private validatePhone;
-    private _ensureValidToken;
-    private mapUser;
-    /**
-     * Parse a session-returning response (login, register, refresh).
-     * Non-2xx is delegated to throwTypedError, which is code-first
-     * (reads body.code) with a status/message fallback. isRefresh only
-     * affects how a bare 401 (no code, older server) is interpreted.
-     */
-    private parseSessionResponse;
-    private checkResponse;
-    /**
-     * Map a non-2xx credential/session response to a typed error.
-     *
-     * Code-first: the server now emits a stable `code` on every error
-     * (contract conformance), so we switch on body.code. The status +
-     * message logic is retained as a fallback for older servers or any
-     * response that arrives without a code. isRefresh only changes how a
-     * bare 401 is interpreted in the fallback path.
-     */
-    private throwTypedError;
-    /**
-     * Parse a phone-auth response. Code-first, with a phone-specific twist:
-     * the server emits the generic `rate_limit` code for the phone endpoints
-     * (they share the default 429), but phone has a dedicated server-side
-     * rate-limiter, so we surface OtpRateLimitError rather than RateLimitError.
-     * Status + message logic is retained as a fallback for older servers.
-     */
-    private parsePhoneResponse;
-}