@authowl/react 0.15.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -1
- package/dist/index.cjs +107 -966
- package/dist/index.d.cts +2 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +102 -947
- package/dist/styles.css +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# @authowl/react
|
|
2
2
|
|
|
3
|
+
**[Complete SDK guide](https://authowl.dev/docs/sdks/react)** ·
|
|
4
|
+
**[React quickstart](https://authowl.dev/docs/getting-started/quickstart-react)** ·
|
|
5
|
+
**[Error handling](https://authowl.dev/docs/sdks/errors)**
|
|
6
|
+
|
|
3
7
|
React provider, hooks, and drop-in components for [AuthOwl](https://authowl.dev),
|
|
4
8
|
the multi-tenant auth service. Publishable-key based, zero CSS setup.
|
|
5
9
|
|
|
@@ -51,10 +55,27 @@ link or code email verification, passkey registration, email changes, account
|
|
|
51
55
|
deletion, and TOTP backup-code availability. Existing credentials remain
|
|
52
56
|
manageable even when creating another credential of that type is disabled.
|
|
53
57
|
|
|
58
|
+
Built-in controls use AuthOwl gold (`#F5B84C`) by default. A project color set
|
|
59
|
+
in the dashboard replaces it automatically, and an explicit provider override
|
|
60
|
+
wins over the project setting:
|
|
61
|
+
|
|
62
|
+
```tsx
|
|
63
|
+
<AuthOwlProvider appearance={{ primaryColor: '#0EA5A4' }} {...config} />
|
|
64
|
+
```
|
|
65
|
+
|
|
54
66
|
When phone OTP is enabled, `<SignIn />` adds the localized phone flow automatically.
|
|
55
67
|
`<PhoneOTP />` is also available as a standalone surface. Production hosts must allow
|
|
56
68
|
Cloudflare Turnstile's challenge script in their Content Security Policy. Local and CI
|
|
57
69
|
servers use AuthOwl's documented dummy-token path when no public site key is configured.
|
|
70
|
+
When the server selects an Akedly Shield V1.2 route, these components fetch a fresh
|
|
71
|
+
challenge and complete its proof-of-work and optional Turnstile ceremony automatically.
|
|
72
|
+
Provider API keys and pipeline credentials remain server-side. Custom phone UIs can call
|
|
73
|
+
`phoneOtp.prepare()` and `solvePhoneOtpChallenge()` to implement the same guarded flow.
|
|
74
|
+
See the [complete headless and retry guide](https://github.com/mstfash/authowl-sdk/blob/main/docs/phone-otp.md).
|
|
75
|
+
|
|
76
|
+
`@akedly/shield` is installed with `@authowl/core` so every consumer bundler can
|
|
77
|
+
resolve the integration safely. It remains behind a dynamic import, so its
|
|
78
|
+
browser proof code is loaded only when the server selects a Shield route.
|
|
58
79
|
|
|
59
80
|
When broad auth protection is enabled, the sign-in, sign-up, magic-link, email
|
|
60
81
|
OTP, password-reset, and verification components automatically run an
|
|
@@ -72,7 +93,8 @@ safe to embed in client code. Durable session tokens live only in `HttpOnly` +
|
|
|
72
93
|
`Secure` + `SameSite=None` cookies. `useSession()` and `<UserProfile />` use
|
|
73
94
|
token-free session ids and safe device metadata.
|
|
74
95
|
|
|
75
|
-
See the
|
|
96
|
+
See the [complete React guide](https://authowl.dev/docs/sdks/react) for provider
|
|
97
|
+
configuration, hooks, component contracts, localization, theming, and errors.
|
|
76
98
|
|
|
77
99
|
## License
|
|
78
100
|
|