@pathmx/auth 0.5.0 → 0.5.1

package/README.md

@@ -1,8 +1,8 @@
 # `@pathmx/auth`
 
-Optional PathMX authentication with development Actor switching,
-production magic links, isolated SQLite state, React App View Components, and
-plugin-contributed administrator commands.
+Optional authentication and account UI for PathMX applications. Development
+mode provides local Actor switching; production supports provider-based
+credentials such as magic links.
 
 ## Install
 
@@ -11,49 +11,50 @@ bun run pmx plugins add auth
 ```
 
 ```ts
-// plugins/auth/index.plugin.ts
+// plugins/auth.plugin.ts
 export { default } from "@pathmx/auth"
 ```
 
-Run `pmx auth setup`, copy `.env.example` to `.env`, and set:
+Auth is intentionally separate from [`@pathmx/paths`](https://www.npmjs.com/package/@pathmx/paths)
+because every deployment must choose its own credential provider.
 
-- `PATHMX_AUTH_MODE=magic-link`
-- `PATHMX_AUTH_ORIGIN` to the exact public origin
-- `PATHMX_AUTH_SECRET` to at least 32 characters
-- `PATHMX_AUTH_EMAIL_FROM` and `RESEND_API_KEY`
+## Development
 
-The setup command installs the exported `AuthSetupPattern`. Different existing
-files are preserved, and the resulting Sources and configuration are ordinary
-user-owned project files with no runtime Pattern dependency.
+Start the project with `pmx dev`. The development credential host lets you
+switch among repository Actors locally without configuring a production
+provider.
 
-Only emails authored on User Sources may receive a link. GET requests to the
-confirmation page are inert; the token stays in the URL fragment and the React
-client submits it once by same-origin POST.
-
-Additional providers implement `AuthProviderFactory` and are passed with
-`AuthPlugin({ providers: [...] })`. Factories receive the isolated auth
-database and structured auth logger; provider resolution and `/api/auth/*`
-handling compose in declaration order.
-
-`pmx dev` binds to `127.0.0.1` because its development Actor switcher is local
-administrator tooling, not authentication for a shared server. Use a production
-provider when exposing PathMX through a tunnel, proxy, container port, or LAN.
-
-## UI
+Available UI components are:
 
 - `<x-auth-sign-in />`
 - `<x-auth-confirm />`
 - `<x-auth-session />`
 
-The components render useful HTML before JavaScript, inherit the PathMX theme,
-and can be restyled with ordinary repository CSS. Override `--auth-accent`,
-`--auth-border`, or `--auth-surface` on `.pmx-auth`; authored attributes such as
-`email-label` and `submit-label` customize sign-in copy. Advanced provider UIs
-can replace the component set through `AuthPlugin({ components })`.
+## Magic-link setup
+
+Generate the stock sign-in pages and environment template:
+
+```sh
+bun run pmx auth setup
+```
 
-## Commands
+Copy the generated `.env.example` values into your local `.env` and configure
+them for the deployment:
+
+```dotenv
+PATHMX_AUTH_MODE=magic-link
+PATHMX_AUTH_ORIGIN=https://example.com
+PATHMX_AUTH_SECRET=replace-with-at-least-32-characters
+PATHMX_AUTH_EMAIL_FROM=PathMX <auth@example.com>
+RESEND_API_KEY=replace-with-your-key
+```
+
+Only emails declared on User Sources can receive a sign-in link. Before
+deploying, verify the configuration with:
+
+```sh
+bun run pmx auth doctor
+```
 
-- `pmx auth setup`
-- `pmx auth doctor`
-- `pmx auth users list`
-- `pmx auth sessions revoke-all`
+Custom integrations can import `AuthPlugin`, `magicLinkProvider`, and provider
+types from `@pathmx/auth` or `@pathmx/auth/providers`.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pathmx/auth",
   "description": "Authentication and account UI for PathMX applications.",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "license": "SEE LICENSE IN LICENSE.md",
   "repository": {
     "type": "git",
@@ -29,7 +29,7 @@
     "react-dom": ">=19.0.0"
   },
   "dependencies": {
-    "@pathmx/react": "0.5.0",
+    "@pathmx/react": "0.5.1",
     "better-auth": "1.6.29"
   }
 }