@robelest/convex-auth 0.0.4-preview.12 → 0.0.4-preview.15

package/README.md

@@ -1,12 +1,12 @@
 # @robelest/convex-auth
 
 Component-first authentication for [Convex](https://convex.dev). One component,
-one class, full TypeScript support.
+one setup API, full TypeScript support.
 
 ## Features
 
-- **Class-based API** — `new Auth(components.auth, { providers })` gives you
-  everything.
+- **Convex-native setup API** — `createAuth(components.auth, { providers })`
+  gives you everything.
 - **OAuth via Arctic** — 50+ providers through [Arctic](https://arcticjs.dev),
   zero-dependency OAuth 2.0.
 - **Fluent Convex builders (recommended)** — cleaner auth-aware API handling
@@ -61,12 +61,12 @@ export default app;
 
 ```ts
 // convex/auth.ts
-import { Auth } from "@robelest/convex-auth/component";
+import { createAuth } from "@robelest/convex-auth/component";
 import { components } from "./_generated/api";
 import { GitHub } from "arctic";
 import { OAuth } from "@robelest/convex-auth/providers";
 
-const auth = new Auth(components.auth, {
+const auth = createAuth(components.auth, {
   providers: [
     OAuth(
       new GitHub(process.env.AUTH_GITHUB_ID!, process.env.AUTH_GITHUB_SECRET!),
@@ -119,15 +119,32 @@ project already uses `convex-helpers`.
 
 ## Providers
 
-| Provider          | Import                                                              |
-| ----------------- | ------------------------------------------------------------------- |
-| OAuth (Arctic)    | `import { OAuth } from "@robelest/convex-auth/providers"`           |
-| Password          | `import password from "@robelest/convex-auth/providers/password"`   |
-| Passkey           | `import passkey from "@robelest/convex-auth/providers/passkey"`     |
-| TOTP              | `import totp from "@robelest/convex-auth/providers/totp"`           |
-| Phone/SMS         | `import phone from "@robelest/convex-auth/providers/phone"`         |
-| Anonymous         | `import anonymous from "@robelest/convex-auth/providers/anonymous"` |
-| Device (RFC 8628) | `import { Device } from "@robelest/convex-auth/providers"`          |
+| Provider          | Import                                                                  |
+| ----------------- | ----------------------------------------------------------------------- |
+| OAuth (Arctic)    | `import { OAuth } from "@robelest/convex-auth/providers"`               |
+| Password          | `import { Password } from "@robelest/convex-auth/providers/password"`   |
+| Passkey           | `import { Passkey } from "@robelest/convex-auth/providers/passkey"`     |
+| TOTP              | `import { Totp } from "@robelest/convex-auth/providers/totp"`           |
+| Phone/SMS         | `import { phone } from "@robelest/convex-auth/providers/phone"`         |
+| Anonymous         | `import { Anonymous } from "@robelest/convex-auth/providers/anonymous"` |
+| Device (RFC 8628) | `import { Device } from "@robelest/convex-auth/providers"`              |
+
+## Enterprise
+
+The enterprise direction is a headless SDK/API rather than a hosted admin UI.
+
+- `auth.sso.*` stores enterprise config on top of `auth.group`, with distinct
+  `admin` and `client` helper surfaces.
+- Standardized helpers are exposed as `auth.sso.admin.connection.*`,
+  `auth.sso.admin.connection.domain.*`, `auth.sso.admin.oidc.*`,
+  `auth.sso.admin.saml.*`, `auth.sso.admin.policy.*`,
+  `auth.sso.admin.audit.list`, `auth.sso.admin.webhook.endpoint.*`,
+  `auth.sso.client.signIn`, `auth.sso.client.metadata`, and
+  `auth.scim.admin.configure/get/validate`.
+- Enterprise helpers are server-side primitives. Consumers can build and expose
+  their own Convex RPC wrappers when needed.
+- `auth.sso.client.metadata(...)` uses the local `@robelest/samlify` package to
+  parse IdP metadata and generate SP metadata from the same setup state.
 
 ## Documentation