cauthy-auth 0.5.1 → 0.8.0

package/README.md

@@ -36,14 +36,71 @@ import { CauthyProvider, useSession } from 'cauthy-auth/react'
 const { session, signIn, signOut } = useSession()
 ```
 
-Fastify has a plugin: `import { cauthyFastify } from 'cauthy-auth/fastify'`, which adds `req.cauthy()` and `app.requireSession`.
+Prefer your own sign-in page to Cauthy's? Set `CAUTHY_TENANT` and draw it, with the ready-made forms or the functions under them. The browser still holds no token:
 
-Built with Stackmyth? Give Cauthy's pages your application's look from its own tokens:
+```tsx
+import { SignIn, useAuth } from 'cauthy-auth/react'
+
+<SignIn locale="es" links={{ signUp: '/registro', forgotPassword: '/olvide' }} />
+
+const { signIn } = useAuth()
+const r = await signIn.email({ email, password })   // r.ok, r.status, r.error.field
+```
+
+What Cauthy mails opens your pages too: a new password, a confirmed address, a sign-in link.
+
+```ts
+export const auth = createCauthy({ pages: { signIn: '/sign-in', resetPassword: '/new-password', verifyEmail: '/confirm' } })
+```
+
+```tsx
+import { ResetPassword, VerifyEmail } from 'cauthy-auth/react'
+```
+
+And the person's account, in your application: name, password, second step, sessions.
+
+```tsx
+import { Account } from 'cauthy-auth/react'
+<Account />                                  // or: const { account } = useAuth()
+```
+
+Roles and permissions with their names, from the catalog Cauthy has:
 
 ```bash
-npx cauthy-auth theme --css node_modules/@stackmyth/core/core.vars.css --css src/styles/brand-theme.css --push
+npx cauthy-auth policy --pull --out src/policy.ts
 ```
 
+```ts
+import { can, hasRole } from './policy'
+can(organization, 'ledger:write')            // only what the catalog names compiles
+```
+
+Each framework has its own few lines:
+
+| | |
+| --- | --- |
+| Next.js | `cauthyNext(auth)` from `cauthy-auth/next`: `{ GET, POST }`, `session()`, `middleware()` |
+| Express | `app.use(cauthyExpress(auth))` from `cauthy-auth/express`: `req.cauthy()`, `requireSession` |
+| Hono | `app.use(cauthyHono(auth))` from `cauthy-auth/hono`: `c.get('session')`, `requireSession` |
+| Fastify | `app.register(cauthyFastify, { auth })` from `cauthy-auth/fastify`: `req.cauthy()`, `app.requireSession` |
+| Anything else | `auth.handler(request)` takes a `Request` and answers a `Response` |
+
+In the browser, beside React:
+
+| | |
+| --- | --- |
+| Vue | `app.use(createCauthyVue())`, then `useSession()` and `useAuth()` from `cauthy-auth/vue` |
+| Svelte | `createCauthySession()` from `cauthy-auth/svelte`: `$session`, `$status`, `auth` |
+| Anything else | `createSessionStore()` from `cauthy-auth/client` |
+
+The ready-made forms wear the look set for your application in Cauthy's dashboard (colours, corners, typeface), the same as Cauthy's own sign-in page, with one import:
+
+```ts
+import 'cauthy-auth/styles.css'
+```
+
+Or draw them with your own `components` and `classNames`, and pass `unstyled`. The dashboard can start the look from your stylesheet (shadcn/ui and Tailwind, Stackmyth, or variables of your own); `npx cauthy-auth theme --css src/app/globals.css` reads it the same way from a terminal.
+
 Connect your application to Cauthy in one step, from Cauthy's dashboard ("Connect a System") or from a terminal. It makes the client, registers `https://<your app>/api/auth/callback`, and prints every variable to set, `CAUTHY_SECRET` included:
 
 ```bash
@@ -57,6 +114,14 @@ const org = await auth.system.organizations.create({ name: 'Acme' })
 await auth.system.members.add(org.id, { role: 'owner', email: 'ana@acme.com' })
 ```
 
+A backend that is handed a Cauthy access token checks it with Cauthy's published keys: no secret, no call per request.
+
+```ts
+import { verifyToken } from 'cauthy-auth'
+const who = await verifyToken(request)   // throws CauthyTokenError: answer 401
+who.userId, who.tenantId, who.roles
+```
+
 The full guide is in Cauthy's documentation, under "Auth SDK".
 
 ## License

package/dist/{cauthy-BCTCqubt.d.ts → cauthy-Bn3iv50y.d.ts}

@@ -1,4 +1,4 @@
-import { J as JsonValue, S as Session, f as SessionStatus, e as SessionOrganization, c as CauthySystem, P as PublicSession, b as CauthyOptions } from './system-DvcQjORr.js';
+import { J as JsonValue, S as Session, l as SessionStatus, k as SessionOrganization, c as CauthySystem, i as PublicSession, b as CauthyOptions } from './system-DhRr_WxR.js';
 import { JWTVerifyGetKey } from 'jose';
 
 /** Something that happened in Cauthy, as a subscriber is told. Moments are UTC. */

package/dist/{cauthy-hswMoS7B.d.mts → cauthy-C29HCvag.d.mts}

@@ -1,4 +1,4 @@
-import { J as JsonValue, S as Session, f as SessionStatus, e as SessionOrganization, c as CauthySystem, P as PublicSession, b as CauthyOptions } from './system-CR8p4BjB.mjs';
+import { J as JsonValue, S as Session, l as SessionStatus, k as SessionOrganization, c as CauthySystem, i as PublicSession, b as CauthyOptions } from './system-ZD_Wa8Bm.mjs';
 import { JWTVerifyGetKey } from 'jose';
 
 /** Something that happened in Cauthy, as a subscriber is told. Moments are UTC. */