@robelest/convex-auth 0.0.4-preview.25 → 0.0.4-preview.28

package/dist/client/index.d.ts

@@ -1 +1,47 @@
-import { AuthApiRefs } from "./core/types.js";
+import { AuthApiRefs, AuthClient, AuthState, BrowserAuthClient, ClientOptions, ClientRuntime, DeviceClient, DeviceCodeResult, PasskeyClient, PendingInvite, SignInResult, Storage, TotpClient } from "./core/types.js";
+
+//#region src/client/index.d.ts
+/**
+ * Create a framework-agnostic auth client.
+ *
+ * Returns an object with `signIn`, `signOut`, `onChange`, `state`, and any
+ * factor helpers enabled by your configured providers. Browser-specific
+ * passkey support is added by the `@robelest/convex-auth/browser` entrypoint.
+ *
+ * ### SPA mode (default)
+ *
+ * ```ts
+ * import { ConvexClient } from 'convex/browser';
+ * import { client } from '@robelest/convex-auth/client';
+ * import { api } from '../convex/_generated/api';
+ *
+ * const convex = new ConvexClient(CONVEX_URL);
+ * const auth = client({ convex, api: api.auth });
+ * ```
+ *
+ * ### Proxy mode
+ *
+ * ```ts
+ * const auth = client({
+ *   convex,
+ *   proxyPath: '/api/auth',
+ *   tokenSeed: tokenFromServer, // JWT read from httpOnly cookie during SSR
+ *   runtime: myRuntime,
+ * });
+ * ```
+ *
+ * In proxy mode all auth operations go through the injected proxy runtime.
+ * Tokens are stored in httpOnly cookies server-side — the client
+ * holds the JWT in memory only.
+ *
+ * @param options - Client configuration. See {@link ClientOptions}.
+ * @typeParam Api - An AuthApiRefs type determining which factor helpers are available.
+ * @returns Auth client with conditional `totp` and `device` helpers.
+ * @throws {Error} When the Convex deployment URL cannot be determined and `url` is not passed explicitly.
+ * @throws {Error} When `proxyPath` is not set and the `api` option is missing.
+ * @throws {Error} When `proxyPath` is set and `runtime.proxy` is missing.
+ */
+declare function client<Api extends AuthApiRefs<boolean, boolean, boolean> = AuthApiRefs>(options: ClientOptions<Api>): AuthClient<Api>;
+//#endregion
+export { type AuthApiRefs, type AuthClient, type AuthState, type BrowserAuthClient, type ClientOptions, type ClientRuntime, type DeviceClient, type DeviceCodeResult, type PasskeyClient, type PendingInvite, type SignInResult, type Storage, type TotpClient, client };
+//# sourceMappingURL=index.d.ts.map