@seamless-auth/svelte 0.0.0-stage → 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,29 @@
+# @seamless-auth/svelte
+
+## 0.2.0
+
+### Minor Changes
+
+- 59802e2: Add a confirmation step for magic links opened on another device.
+
+  A magic link opened on a device other than the one that asked for it now waits for the reader to approve it (auth API 0.19.0 and later). The bundled verify screens show which kind of device asked and when, and offer "Yes, sign in that device" or "No, this wasn't me". Approving signs in the requesting device and tells the reader to return to it; declining changes nothing.
+
+  `@seamless-auth/client` adds `client.confirmMagicLink(token)`, the `getMagicLinkConfirmation`, `isMagicLinkConfirmationRequired`, `describeMagicLinkDevice`, `magicLinkConfirmationPrompt` and `confirmMagicLinkSignIn` helpers, and the `MagicLinkConfirmation` and `MagicLinkDeviceClass` types. In bearer mode the verify call now sends the sign-in's ephemeral token when one is held. A custom verify screen that treats every failure as an invalid link should check `getMagicLinkConfirmation(error)` first.
+
+  The React Native README describes the new step for apps that handle magic links.
+
+### Patch Changes
+
+- Updated dependencies [59802e2]
+  - @seamless-auth/client@0.6.0
+
+## 0.1.0
+
+### Minor Changes
+
+- d1a70a1: First release of `@seamless-auth/svelte`, the Svelte binding for Seamless Auth (Svelte 5).
+  - `createSeamlessAuth({ apiHost })` creates a session whose properties (`user`, `isAuthenticated`, `loading`, and the rest) are runes, with every auth action. `setSeamlessAuth` and `getSeamlessAuth` share it through context.
+  - `@seamless-auth/svelte/kit` provides `requireAuth(auth, { roles })` and `requireGuest(auth)` `load` guards, and `createKitNavigator` for the bundled screens, for SvelteKit 2.26 and later, and SvelteKit 3. Each guard waits for the session to be read.
+  - Sign-in screens (`SaLogin`, `SaVerifyOtp`, `SaMagicLinkSent`, `SaVerifyMagicLink`, `SaOAuthCallback`, `SaPasskeyLogin`, `SaRegisterPasskey`) to mount at your routes, themed with the same `--seamless-*` properties as the other bindings. They navigate through an `AuthNavigator`, so any router can drive them.
+
+  The binding uses cookie transport only: tokens stay in the server adapter, and nothing is written where page scripts can read it.

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,254 @@
-# Temporary Holding Version
+# @seamless-auth/svelte
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![npm version](https://img.shields.io/npm/v/@seamless-auth/svelte.svg?label=%40seamless-auth%2Fsvelte)](https://www.npmjs.com/package/@seamless-auth/svelte)
+[![CI](https://github.com/fells-code/seamless-auth-react/actions/workflows/ci.yml/badge.svg)](https://github.com/fells-code/seamless-auth-react/actions/workflows/ci.yml)
+[![license](https://img.shields.io/github/license/fells-code/seamless-auth-react)](./LICENSE)
+
+Svelte bindings for Seamless Auth: a rune-based session with every auth action, SvelteKit `load`
+guards, and optional sign-in screens. It is a thin binding over
+[`@seamless-auth/client`](../client/README.md), the same core the React, Angular, and Vue bindings
+use, so the flows behave the same in all of them.
+
+## Start here
+
+New to Seamless Auth? The [self-hosted quickstart](https://docs.seamlessauth.com/start/quickstart/)
+runs the full stack locally with Docker. The [compatibility matrix](https://docs.seamlessauth.com/build/ecosystem/#compatibility-matrix)
+lists which package versions work together.
+
+The browser talks only to your backend's `/auth` routes, served by a server adapter. The adapter keeps
+the tokens; the browser holds only HttpOnly cookies. This package has no bearer mode and never writes
+a token to `localStorage`, `sessionStorage`, or anywhere page scripts can read it.
+
+## Requirements
+
+- Svelte 5
+- For the guards and the SvelteKit navigator in `@seamless-auth/svelte/kit`: SvelteKit 2.26 or later,
+  or SvelteKit 3. The root entry works in any Svelte 5 application
+- A Seamless Auth server adapter mounted at `/auth` on `apiHost`
+
+## Installation
+
+```bash
+npm install @seamless-auth/svelte
+```
+
+## Quick start with SvelteKit
+
+The examples import from `$lib`, as SvelteKit 2 does. In SvelteKit 3, which renamed it, import from
+`#lib`.
+
+Create the session once, in the browser:
+
+```ts
+// src/lib/auth.ts
+import { createSeamlessAuth } from '@seamless-auth/svelte';
+
+export const auth = createSeamlessAuth({ apiHost: 'https://app.example.com' });
+```
+
+The session lives in the browser, so render the application there. A backend-for-frontend app
+usually ships as a single-page app (`adapter-static` with a fallback page):
+
+```ts
+// src/routes/+layout.ts
+export const ssr = false;
+```
+
+Hand the session and a navigator to the components below the root layout:
+
+```svelte
+<!-- src/routes/+layout.svelte -->
+<script lang="ts">
+  import { setAuthNavigator, setSeamlessAuth } from '@seamless-auth/svelte';
+  import { createKitNavigator } from '@seamless-auth/svelte/kit';
+  import { auth } from '$lib/auth';
+
+  let { children } = $props();
+
+  setSeamlessAuth(auth);
+  setAuthNavigator(createKitNavigator(auth));
+</script>
+
+{@render children()}
+```
+
+Guard a route with a `load` function:
+
+```ts
+// src/routes/(app)/+layout.ts
+import { requireAuth } from '@seamless-auth/svelte/kit';
+import { auth } from '$lib/auth';
+
+export const load = requireAuth(auth);
+```
+
+Mount each sign-in screen at its route:
+
+```svelte
+<!-- src/routes/login/+page.svelte -->
+<script lang="ts">
+  import { SaLogin } from '@seamless-auth/svelte';
+</script>
+
+<SaLogin />
+```
+
+| Option                     | Default          | Purpose                                                     |
+| -------------------------- | ---------------- | ----------------------------------------------------------- |
+| `apiHost`                  | required         | Origin of the server adapter                                |
+| `basePath`                 | `/auth`          | Where the adapter is mounted                                |
+| `magicLinkRedirectUri`     | the deployment's | Where an emailed magic link lands                           |
+| `autoDetectPreviousSignIn` | `true`           | Open the login screen on Sign In for a returning browser    |
+| `initialSession`           | none             | A session the server already resolved                       |
+| `ports`                    | browser          | `passkeys` and `oauthRedirect` ports                        |
+| `fetch`                    | global `fetch`   | The fetch auth requests go through                          |
+| `trustedOrigins`           | none             | Other origins of yours that may receive the session cookies |
+| `injectStyles`             | `true`           | Whether the screens add their stylesheet to the page        |
+| `cspNonce`                 | none             | A CSP nonce for that stylesheet                             |
+| `signedInPath`             | `/`              | Where the bundled screens go after sign-in                  |
+| `loginPath`                | `/login`         | Where `requireAuth` sends someone signed out                |
+
+## Reading session state
+
+Every property of the session is reactive, so read it straight in markup or an `$effect`:
+
+```svelte
+<script lang="ts">
+  import { goto } from '$app/navigation';
+  import { getSeamlessAuth } from '@seamless-auth/svelte';
+
+  const auth = getSeamlessAuth();
+
+  async function signOut() {
+    await auth.logout();
+    await goto('/login');
+  }
+</script>
+
+{#if auth.user}
+  <span>{auth.user.email}</span>
+  <button type="button" onclick={signOut}>Logout</button>
+{/if}
+```
+
+Properties: `state`, `user`, `isAuthenticated`, `loading`, `credentials`, `organizations`,
+`activeOrganization`, `stepUpStatus`, `hasSignedInBefore`, plus `loginMethods`,
+`loginMethodsLoading`, `passkeySupported`, and `passkeySupportLoading`.
+
+Actions, each resolving to a `SeamlessAuthResult<T>` (`{ data, error }`) that never throws for an HTTP
+failure: `login`, `handlePasskeyLogin`, `registerPasskey`, `refreshSession`, `logout`,
+`logoutAllSessions`, `deleteUser`, `updateCredential`, `deleteCredential`, `switchOrganization`,
+`listOAuthProviders`, `startOAuthLogin`, `finishOAuthLogin`, `refreshStepUpStatus`,
+`verifyStepUpWithPasskey`, `verifyStepUpWithPasskeyPrf`, `verifyStepUpWithTotp`.
+
+Also: `hasRole`, `hasScopedRole`, `markSignedIn`, `whenSettled()` (resolves once the session is read),
+`loadLoginMethods()` and `checkPasskeySupport()` (each read once and cached), `authorizedFetch` (a
+fetch for your own API that carries the cookies to `apiHost` and `trustedOrigins` only), `client`
+(the headless client for everything else, such as OTP and magic link calls), `ports`, and
+`destroy()`.
+
+## Guards
+
+`@seamless-auth/svelte/kit` exports `load` functions. They wait for the session to be read before
+deciding, so reloading a protected page does not bounce a signed-in user to the login screen.
+
+| Guard                          | Admits                                    | Otherwise                                                                                                             |
+| ------------------------------ | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
+| `requireAuth(auth, options?)`  | A signed-in user, with `roles` when given | Redirects to `redirectTo` (default `loginPath`), or `forbiddenRedirectTo` (default `signedInPath`) for a missing role |
+| `requireGuest(auth, options?)` | Someone signed out                        | Redirects to `redirectTo` (default `signedInPath`)                                                                    |
+
+The guards register a dependency on the session and on the URL, so they run again on every
+navigation and whenever the session changes (a sign-out in another tab, an expired session, a
+switched organization), as long as the navigator from `createKitNavigator` is set in the root layout.
+A server render that was not handed an `initialSession` cannot see the session, so `requireAuth`
+treats it as signed out and redirects. Turn server rendering off for guarded routes
+(`export const ssr = false`). `roles` uses the same matching as
+the auth API, scoped roles such as `org:admin` included. A guard is a convenience for navigation, not
+access control: your server still checks every request.
+
+Put `requireGuest` only on the screens that start a sign-in (`login`, `passkey-login`,
+`magic-link-sent`). A user can already have a session when `register-passkey`, `oauth/callback`, or
+`verify-magiclink` renders.
+
+## Built-in screens
+
+Mount each at its route. The paths below are what the screens navigate between by default; pass
+`paths` to `createKitNavigator` if you mount them elsewhere.
+
+| Default path        | Component                     | Purpose                                                     |
+| ------------------- | ----------------------------- | ----------------------------------------------------------- |
+| `/login`            | `SaLogin`                     | Sign in with an email or phone number, or create an account |
+| `/passkey-login`    | `SaPasskeyLogin`              | Sign in with a passkey alone                                |
+| `/verify-email-otp` | `SaVerifyOtp channel="email"` | Check an email code                                         |
+| `/verify-phone-otp` | `SaVerifyOtp channel="phone"` | Check a text message code                                   |
+| `/magic-link-sent`  | `SaMagicLinkSent`             | Wait for an emailed link to be used                         |
+| `/verify-magiclink` | `SaVerifyMagicLink`           | Where the emailed link lands. The auth API builds this URL  |
+| `/oauth/callback`   | `SaOAuthCallback`             | The OAuth redirect URI to register with providers           |
+| `/register-passkey` | `SaRegisterPasskey`           | Offer passkey enrolment after sign-up                       |
+
+The building blocks are exported too: `SaOtpInput` (bind with `bind:value`), `SaFallbackOptions`,
+`SaOAuthProviderButtons`, `SaAuthLayout`, and `authRoutePaths`.
+
+The magic link and OAuth callback screens remove the token or code from the URL once they have read
+it. Serve those routes with `Referrer-Policy: no-referrer` (or `same-origin`) so a single-use secret
+does not leave in a `Referer` before then.
+
+### Without SvelteKit
+
+The screens never import a router. They navigate through an `AuthNavigator` set with
+`setAuthNavigator`, so any router can drive them: implement its seven methods (`toScreen`, `toApp`,
+`toLocation`, `state`, `query`, `dropQuery`, `absoluteUrl`) on top of your router.
+`createKitNavigator` is the SvelteKit one.
+
+## Headless use
+
+Every screen is a thin view over a flow in `@seamless-auth/client` (`beginSignIn`,
+`registerWithEmail`, `verifyOtp`, `watchMagicLink`, `finishMagicLinkSignIn`,
+`confirmMagicLinkSignIn`, `startOAuthSignIn`, `completeOAuthCallback`, `enrollPasskey`, and helpers). A custom screen calls the same flows with the
+session as its actions:
+
+```ts
+import { beginSignIn } from '@seamless-auth/client';
+
+const step = await beginSignIn(auth, {
+  identifier: email,
+  passkeySupported: await auth.checkPasskeySupport(),
+  configuredMethods: await auth.loadLoginMethods(),
+});
+
+if (step.kind === 'signed_in') await goto('/');
+```
+
+See the [client README](../client/README.md#flows) for the full list.
+
+## Styling
+
+The screens render inside `.sa-auth` with plain `.sa-*` classes. The first screen to mount adds the
+stylesheet to the top of `<head>`, so your own styles override it. Colours come from the same
+`--seamless-*` custom properties the React, Angular, and Vue screens read, so one theme covers every
+binding:
+
+```css
+:root {
+  --seamless-accent: #1f3a34;
+  --seamless-accent-hover: #16302b;
+  --seamless-surface: #f7f5f0;
+  --seamless-surface-raised: #ffffff;
+  --seamless-text: #1a1a1a;
+  --seamless-text-muted: #4b5563;
+}
+```
+
+Under a Content Security Policy, pass `cspNonce`, or set `injectStyles: false` and link
+`@seamless-auth/svelte/seamless-auth.css` yourself.
+
+## Server rendering
+
+The session is meant for the browser. On a server it does not read the session or browser storage,
+the screens start no requests, and `requireAuth` redirects. If you do render on a server, create the
+session per request (never in a module shared between requests) and pass `initialSession` from your
+adapter. Never forward the browser's cookies to the adapter's `/auth/users/me` from a server.
+
+## License
+
+Apache-2.0. See [LICENSE](./LICENSE).

package/dist/auth.svelte.d.ts

@@ -0,0 +1,170 @@
+import { type AuthSessionActions, type AuthSessionState, type LoginMethod, type SeamlessAuthClient } from '@seamless-auth/client';
+import type { SeamlessAuthConfig, SeamlessAuthPorts } from './config.js';
+/**
+ * Session state and auth actions for a Svelte application, from
+ * `createSeamlessAuth`.
+ *
+ * A thin binding over the framework-agnostic session store in
+ * `@seamless-auth/client`: the store owns the state machine, and this mirrors
+ * it into runes, so every property reads reactively in a component or an
+ * `$effect`. Change the session through the actions.
+ */
+export declare class SeamlessAuth implements AuthSessionActions {
+    #private;
+    /** The platform ports the bundled screens go through. */
+    readonly ports: SeamlessAuthPorts;
+    /** The client behind the session, for calls the session does not wrap. */
+    readonly client: SeamlessAuthClient;
+    /** How the bundled screens add their stylesheet. */
+    readonly styles: {
+        inject: boolean;
+        nonce?: string;
+    };
+    /** Where the bundled screens go once someone is signed in. */
+    readonly signedInPath: string;
+    /** Where `requireAuth` sends someone who is signed out. */
+    readonly loginPath: string;
+    constructor(config: SeamlessAuthConfig);
+    /** Everything the session knows. Replaced wholesale on every change. */
+    get state(): AuthSessionState;
+    get user(): {
+        id: string;
+        email: string;
+        phone: string | null;
+        roles: string[];
+        lastLogin?: string | null | undefined;
+        activeOrganizationId?: string | null | undefined;
+    } | null;
+    get isAuthenticated(): boolean;
+    /** True until the session has been read. Guards wait on this. */
+    get loading(): boolean;
+    get credentials(): {
+        id: string;
+        createdAt: string;
+        counter: number;
+        backedup: boolean;
+        backedUp: boolean;
+        platform?: string | null | undefined;
+        browser?: string | null | undefined;
+        aaguid?: string | null | undefined;
+        transports?: ("hybrid" | "ble" | "internal" | "nfc" | "usb" | "cable" | "smart-card")[] | undefined;
+        deviceType?: "singleDevice" | "multiDevice" | undefined;
+        friendlyName?: string | null | undefined;
+        lastUsedAt?: string | null | undefined;
+        deviceInfo?: string | null | undefined;
+        prfCapable?: boolean | undefined;
+    }[];
+    get organizations(): {
+        id: string;
+        name: string;
+        slug: string;
+        createdByUserId: string | null;
+        metadata: Record<string, unknown> | null;
+        createdAt: string;
+        updatedAt: string;
+        membership?: {
+            id: string;
+            organizationId: string;
+            userId: string;
+            roles: string[];
+            scopes: string[];
+            createdAt: string;
+            updatedAt: string;
+            user?: {
+                id: string;
+                email: string;
+                phone: string | null;
+                roles: string[];
+            } | undefined;
+        } | undefined;
+        memberCount?: number | undefined;
+        retiredOAuthProviders?: string[] | undefined;
+    }[];
+    get activeOrganization(): {
+        id: string;
+        name: string;
+        slug: string;
+        createdByUserId: string | null;
+        metadata: Record<string, unknown> | null;
+        createdAt: string;
+        updatedAt: string;
+        membership?: {
+            id: string;
+            organizationId: string;
+            userId: string;
+            roles: string[];
+            scopes: string[];
+            createdAt: string;
+            updatedAt: string;
+            user?: {
+                id: string;
+                email: string;
+                phone: string | null;
+                roles: string[];
+            } | undefined;
+        } | undefined;
+        memberCount?: number | undefined;
+        retiredOAuthProviders?: string[] | undefined;
+    } | null;
+    get stepUpStatus(): {
+        fresh: boolean;
+        method: "webauthn" | "totp" | null;
+        verifiedAt: string | null;
+        expiresAt: string | null;
+        maxAgeSeconds: number;
+    } | null;
+    get hasSignedInBefore(): boolean;
+    /**
+     * Sign-in methods this instance has enabled, once `loadLoginMethods()` has
+     * answered. Null means unknown, never "none".
+     */
+    get loginMethods(): ("passkey" | "magic_link" | "email_otp" | "phone_otp" | "oauth")[] | null;
+    get loginMethodsLoading(): boolean;
+    /** Whether this device can use a passkey, once `checkPasskeySupport()` has answered. */
+    get passkeySupported(): boolean;
+    get passkeySupportLoading(): boolean;
+    /** Reads the instance's sign-in methods once and caches the answer. */
+    loadLoginMethods(): Promise<LoginMethod[] | null>;
+    /** Detects passkey support once and caches the answer. */
+    checkPasskeySupport(): Promise<boolean>;
+    /**
+     * Resolves with the state once the session has been read. During a server
+     * render the session is never read there, so this resolves at once with what
+     * the server knows. It also resolves if the session is destroyed first.
+     */
+    whenSettled(): Promise<AuthSessionState>;
+    /**
+     * A fetch for the application's own API that carries the session cookies.
+     * A path resolves on `apiHost`. Only `apiHost` and `trustedOrigins` receive
+     * the session; any other origin rejects with `UntrustedOriginError`.
+     */
+    authorizedFetch: SeamlessAuthClient['authorizedFetch'];
+    login: AuthSessionActions['login'];
+    handlePasskeyLogin: AuthSessionActions['handlePasskeyLogin'];
+    registerPasskey: AuthSessionActions['registerPasskey'];
+    refreshSession: AuthSessionActions['refreshSession'];
+    logout: AuthSessionActions['logout'];
+    logoutAllSessions: AuthSessionActions['logoutAllSessions'];
+    deleteUser: AuthSessionActions['deleteUser'];
+    updateCredential: AuthSessionActions['updateCredential'];
+    deleteCredential: AuthSessionActions['deleteCredential'];
+    switchOrganization: AuthSessionActions['switchOrganization'];
+    listOAuthProviders: AuthSessionActions['listOAuthProviders'];
+    startOAuthLogin: AuthSessionActions['startOAuthLogin'];
+    finishOAuthLogin: AuthSessionActions['finishOAuthLogin'];
+    refreshStepUpStatus: AuthSessionActions['refreshStepUpStatus'];
+    verifyStepUpWithPasskey: AuthSessionActions['verifyStepUpWithPasskey'];
+    verifyStepUpWithPasskeyPrf: AuthSessionActions['verifyStepUpWithPasskeyPrf'];
+    verifyStepUpWithTotp: AuthSessionActions['verifyStepUpWithTotp'];
+    hasRole: AuthSessionActions['hasRole'];
+    hasScopedRole: AuthSessionActions['hasScopedRole'];
+    markSignedIn: AuthSessionActions['markSignedIn'];
+    /** Stops the session. Pending `whenSettled()` calls resolve with the last state. */
+    destroy(): void;
+}
+/**
+ * Creates the session for an application. In the browser it is read straight
+ * away. Create one per application (one per request when rendering on a
+ * server), and hand it to the screens with `setSeamlessAuth`.
+ */
+export declare function createSeamlessAuth(config: SeamlessAuthConfig): SeamlessAuth;