@korajs/auth 0.3.3 → 0.5.0

package/dist/org-client-BVTLKcIk.d.ts

@@ -1,355 +0,0 @@
-import { KoraError } from '@korajs/core';
-
-/**
- * Thrown when an authentication operation fails.
- * Includes a machine-readable code and optional context for debugging.
- */
-declare class AuthError extends KoraError {
-    constructor(message: string, code: string, context?: Record<string, unknown>);
-}
-/**
- * Possible authentication states for the client.
- * - 'loading': Initial state while restoring tokens from storage
- * - 'authenticated': User is signed in with a valid session
- * - 'unauthenticated': No valid session exists
- */
-type AuthState = 'loading' | 'authenticated' | 'unauthenticated';
-/**
- * Authenticated user information.
- */
-interface AuthUser {
-    /** Unique user identifier */
-    id: string;
-    /** User email address */
-    email: string;
-    /** Display name (may be absent if user did not provide one) */
-    name: string | null;
-}
-/**
- * Configuration for the AuthClient.
- */
-interface AuthClientConfig {
-    /** Base URL of the auth server (e.g. 'http://localhost:3001') */
-    serverUrl: string;
-    /** Storage key prefix for tokens. Defaults to 'kora_auth' */
-    storageKey?: string;
-}
-/**
- * Client-side authentication manager for Kora.js.
- *
- * Manages token storage, session restoration, sign-up, sign-in, sign-out,
- * token refresh, and auth state change notifications. Framework-agnostic --
- * works in any JavaScript environment with `fetch` and optionally `localStorage`.
- *
- * @example
- * ```typescript
- * const auth = new AuthClient({ serverUrl: 'http://localhost:3001' })
- * await auth.initialize()
- *
- * if (!auth.isAuthenticated) {
- *   await auth.signIn({ email: 'user@example.com', password: 'secret' })
- * }
- *
- * const unsub = auth.onAuthChange((state) => {
- *   console.log('Auth state:', state)
- * })
- * ```
- */
-declare class AuthClient {
-    private readonly serverUrl;
-    private readonly storage;
-    private readonly listeners;
-    private _state;
-    private _user;
-    private _refreshPromise;
-    private _initialized;
-    /**
-     * Creates a new AuthClient.
-     *
-     * @param config - Auth client configuration
-     */
-    constructor(config: AuthClientConfig);
-    /** Current authentication state. */
-    get state(): AuthState;
-    /** Current authenticated user, or null if not signed in. */
-    get currentUser(): AuthUser | null;
-    /** Whether the user is currently authenticated. */
-    get isAuthenticated(): boolean;
-    /**
-     * Initialize the auth client by restoring a session from stored tokens.
-     *
-     * Loads tokens from storage, validates the access token, and attempts a
-     * refresh if the access token is expired but a refresh token is available.
-     * Safe to call multiple times -- subsequent calls are no-ops once initialized.
-     */
-    initialize(): Promise<void>;
-    /**
-     * Register a new user account.
-     *
-     * @param params - Sign-up credentials
-     * @returns The newly created AuthUser
-     * @throws {AuthError} If the request fails or the server returns an error
-     */
-    signUp(params: {
-        email: string;
-        password: string;
-        name?: string;
-    }): Promise<AuthUser>;
-    /**
-     * Sign in with email and password.
-     *
-     * @param params - Sign-in credentials
-     * @returns The authenticated AuthUser
-     * @throws {AuthError} If the credentials are invalid or the request fails
-     */
-    signIn(params: {
-        email: string;
-        password: string;
-    }): Promise<AuthUser>;
-    /**
-     * Sign out the current user.
-     *
-     * Clears local tokens and attempts to revoke the refresh token on the server
-     * (best-effort — succeeds even if the server is unreachable). This ensures that
-     * stolen refresh tokens cannot be used after the user explicitly signs out.
-     */
-    signOut(): Promise<void>;
-    /**
-     * Get a valid access token, automatically refreshing if expired.
-     *
-     * @returns A valid access token string, or null if the user is not
-     *          authenticated and refresh is not possible
-     */
-    getAccessToken(): Promise<string | null>;
-    /**
-     * Get a valid token for the sync engine handshake.
-     * Alias for {@link getAccessToken}.
-     *
-     * @returns A valid access token string, or null if unavailable
-     */
-    getSyncToken(): Promise<string | null>;
-    /**
-     * Subscribe to authentication state changes.
-     *
-     * The callback is invoked whenever the auth state transitions (e.g., from
-     * 'unauthenticated' to 'authenticated' on sign-in).
-     *
-     * @param callback - Function called with the new AuthState on each change
-     * @returns An unsubscribe function that removes the listener
-     *
-     * @example
-     * ```typescript
-     * const unsub = auth.onAuthChange((state) => {
-     *   console.log('Auth state changed to:', state)
-     * })
-     * // Later: unsub()
-     * ```
-     */
-    onAuthChange(callback: (state: AuthState) => void): () => void;
-    /**
-     * Update internal state and notify all listeners.
-     */
-    private setState;
-    /**
-     * Restore a session from a valid access token by fetching the user profile.
-     * Falls back to extracting the user ID from the token payload if the
-     * /auth/me request fails (offline scenario).
-     */
-    private restoreSession;
-    /**
-     * Fetch the current user profile from the server.
-     */
-    private fetchUserProfile;
-    /**
-     * Refresh the access token using a refresh token.
-     * De-duplicates concurrent refresh calls so only one network request is made.
-     */
-    private refreshAccessToken;
-    /**
-     * Execute the token refresh network request.
-     */
-    private performRefresh;
-    /**
-     * Make an HTTP request to the auth server.
-     *
-     * @param path - URL path relative to serverUrl (e.g. '/auth/signin')
-     * @param options - Request options
-     * @returns Parsed JSON response body
-     * @throws {AuthError} On network failure or non-2xx response
-     */
-    private request;
-}
-
-/**
- * Organization info returned by the server.
- */
-interface ClientOrganization {
-    id: string;
-    name: string;
-    slug: string;
-    ownerId: string;
-    createdAt: number;
-    updatedAt: number;
-    metadata: Record<string, unknown>;
-}
-/**
- * Membership info returned by the server.
- */
-interface ClientMembership {
-    id: string;
-    orgId: string;
-    userId: string;
-    role: string;
-    invitedBy: string | null;
-    joinedAt: number;
-}
-/**
- * Invitation info returned by the server.
- */
-interface ClientInvitation {
-    id: string;
-    orgId: string;
-    email: string;
-    role: string;
-    invitedBy: string;
-    token: string;
-    createdAt: number;
-    expiresAt: number;
-    status: string;
-}
-/**
- * Configuration for the OrgClient.
- */
-interface OrgClientConfig {
-    /** Base URL of the auth/org server */
-    serverUrl: string;
-    /** Function that returns a valid access token for authenticated requests */
-    getAccessToken: () => Promise<string | null>;
-}
-/**
- * Thrown when an org operation fails.
- */
-declare class OrgClientError extends KoraError {
-    constructor(message: string, code: string, context?: Record<string, unknown>);
-}
-/**
- * Client-side organization manager.
- *
- * Handles org CRUD, member management, invitations, and active org switching.
- * Framework-agnostic — works in any JavaScript environment with `fetch`.
- *
- * @example
- * ```typescript
- * const orgClient = new OrgClient({
- *   serverUrl: 'http://localhost:3001',
- *   getAccessToken: () => authClient.getAccessToken(),
- * })
- *
- * const org = await orgClient.createOrg({ name: 'Acme Inc', slug: 'acme' })
- * orgClient.switchOrg(org.id)
- * ```
- */
-declare class OrgClient {
-    private readonly serverUrl;
-    private readonly getAccessToken;
-    private readonly listeners;
-    private _activeOrgId;
-    private _activeOrg;
-    private _activeRole;
-    constructor(config: OrgClientConfig);
-    /** Currently active organization ID */
-    get activeOrgId(): string | null;
-    /** Currently active organization */
-    get activeOrg(): ClientOrganization | null;
-    /** Current user's role in the active organization */
-    get activeRole(): string | null;
-    /**
-     * Create a new organization.
-     */
-    createOrg(params: {
-        name: string;
-        slug?: string;
-        metadata?: Record<string, unknown>;
-    }): Promise<ClientOrganization>;
-    /**
-     * List all organizations the current user belongs to.
-     */
-    listOrgs(): Promise<ClientOrganization[]>;
-    /**
-     * Get an organization by ID.
-     */
-    getOrg(orgId: string): Promise<ClientOrganization>;
-    /**
-     * Update an organization.
-     */
-    updateOrg(orgId: string, params: {
-        name?: string;
-        slug?: string;
-        metadata?: Record<string, unknown>;
-    }): Promise<ClientOrganization>;
-    /**
-     * Delete an organization.
-     */
-    deleteOrg(orgId: string): Promise<void>;
-    /**
-     * Switch the active organization context.
-     * Fetches the org details and the user's membership/role.
-     */
-    switchOrg(orgId: string): Promise<void>;
-    /**
-     * Clear the active organization (no org selected).
-     */
-    clearActiveOrg(): void;
-    /**
-     * List members of an organization.
-     */
-    listMembers(orgId: string): Promise<ClientMembership[]>;
-    /**
-     * Remove a member from an organization.
-     */
-    removeMember(orgId: string, userId: string): Promise<void>;
-    /**
-     * Update a member's role.
-     */
-    updateMemberRole(orgId: string, userId: string, role: string): Promise<ClientMembership>;
-    /**
-     * Transfer ownership to another member.
-     */
-    transferOwnership(orgId: string, newOwnerId: string): Promise<void>;
-    /**
-     * Leave an organization (remove yourself).
-     */
-    leaveOrg(orgId: string): Promise<void>;
-    /**
-     * Invite a user to an organization by email.
-     */
-    inviteMember(orgId: string, params: {
-        email: string;
-        role: string;
-    }): Promise<ClientInvitation>;
-    /**
-     * Accept an invitation by token.
-     */
-    acceptInvitation(token: string): Promise<ClientMembership>;
-    /**
-     * List pending invitations for an organization.
-     */
-    listInvitations(orgId: string): Promise<ClientInvitation[]>;
-    /**
-     * Revoke a pending invitation.
-     */
-    revokeInvitation(orgId: string, invitationId: string): Promise<void>;
-    /**
-     * List pending invitations for the current user's email.
-     */
-    listMyInvitations(email: string): Promise<ClientInvitation[]>;
-    /**
-     * Subscribe to active org changes.
-     * @returns Unsubscribe function
-     */
-    onOrgChange(callback: (orgId: string | null) => void): () => void;
-    private notifyListeners;
-    private request;
-}
-
-export { AuthClient as A, type ClientInvitation as C, OrgClient as O, type AuthClientConfig as a, AuthError as b, type AuthState as c, type AuthUser as d, type ClientMembership as e, type ClientOrganization as f, type OrgClientConfig as g, OrgClientError as h };