@forward-software/react-auth 2.0.2 → 2.0.4
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 +4 -22
- package/package.json +8 -7
package/README.md
CHANGED
|
@@ -147,31 +147,13 @@ The `createAuth` function wraps your `AuthClient` implementation with an `Enhanc
|
|
|
147
147
|
- `subscribe(() => { })`, subscribe to AuthClient state changes
|
|
148
148
|
- `getSnapshot()`, returns the current state of the AuthClient
|
|
149
149
|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
Setup React components to interact with the AuthClient using the `createAuth` function exported by this library
|
|
153
|
-
|
|
154
|
-
```ts
|
|
155
|
-
import { createAuth } from '@forward-software/react-auth';
|
|
156
|
-
|
|
157
|
-
export const { AuthProvider, useAuthClient } = createAuth(authClient);
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
the `createAuth` function returns:
|
|
161
|
-
|
|
162
|
-
- `AuthProvider`, the context Provider component that should wrap your app and provide access to your AuthClient
|
|
163
|
-
- `useAuthClient`, the hook to retrieve and interact with your AuthClient
|
|
164
|
-
|
|
165
|
-
#### AuthProvider
|
|
166
|
-
|
|
167
|
-
The context Provider component that should wrap your app and provide access to your AuthClient, this component also accepts 2 additional props
|
|
150
|
+
## Examples
|
|
168
151
|
|
|
169
|
-
|
|
170
|
-
- `LoadingComponent`, displayed while the AuthClient is being initialized
|
|
152
|
+
The [`examples`](https://github.com/forwardsoftware/react-auth/tree/main/examples) folder in the repository contains some examples of how you can integrate this library in your React app.
|
|
171
153
|
|
|
172
|
-
##
|
|
154
|
+
## Contributing
|
|
173
155
|
|
|
174
|
-
|
|
156
|
+
Contributions are welcome! Please read the [Contributing Guide](https://github.com/forwardsoftware/react-auth/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/forwardsoftware/react-auth/blob/main/CODE_OF_CONDUCT.md) before submitting a pull request.
|
|
175
157
|
|
|
176
158
|
## Credits
|
|
177
159
|
|
package/package.json
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@forward-software/react-auth",
|
|
3
3
|
"description": "Simplify your Auth flow when working with React apps",
|
|
4
|
-
"version": "2.0.
|
|
4
|
+
"version": "2.0.4",
|
|
5
5
|
"author": "ForWarD Software (https://forwardsoftware.solutions/)",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
|
-
"url": "git+https://github.com/forwardsoftware/react-auth.git"
|
|
9
|
+
"url": "git+https://github.com/forwardsoftware/react-auth.git",
|
|
10
|
+
"directory": "lib"
|
|
10
11
|
},
|
|
11
|
-
"homepage": "https://github.com/forwardsoftware/react-auth#readme",
|
|
12
|
+
"homepage": "https://github.com/forwardsoftware/react-auth/tree/main/lib#readme",
|
|
12
13
|
"keywords": [
|
|
13
14
|
"react",
|
|
14
15
|
"react-native",
|
|
@@ -35,17 +36,17 @@
|
|
|
35
36
|
"devDependencies": {
|
|
36
37
|
"@testing-library/dom": "^10.4.1",
|
|
37
38
|
"@testing-library/jest-dom": "^6.9.1",
|
|
38
|
-
"@testing-library/react": "^16.3.
|
|
39
|
-
"@types/node": "^
|
|
39
|
+
"@testing-library/react": "^16.3.2",
|
|
40
|
+
"@types/node": "^25.2.3",
|
|
40
41
|
"@types/react": "catalog:",
|
|
41
42
|
"@types/react-dom": "catalog:",
|
|
42
43
|
"@types/use-sync-external-store": "^1.5.0",
|
|
43
44
|
"@vitejs/plugin-react": "catalog:",
|
|
44
|
-
"jsdom": "
|
|
45
|
+
"jsdom": "catalog:",
|
|
45
46
|
"react": "catalog:",
|
|
46
47
|
"react-dom": "catalog:",
|
|
47
48
|
"vite": "catalog:",
|
|
48
|
-
"vitest": "
|
|
49
|
+
"vitest": "catalog:"
|
|
49
50
|
},
|
|
50
51
|
"dependencies": {
|
|
51
52
|
"use-sync-external-store": "^1.6.0"
|