@clivly/auth-workos 0.7.2 → 0.7.3
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 +6 -19
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,19 +1,12 @@
|
|
|
1
1
|
# @clivly/auth-workos
|
|
2
2
|
|
|
3
|
-
WorkOS implementation of Clivly's `ClivlyAuthAdapter`.
|
|
4
|
-
AuthKit session cookie, authenticates it through WorkOS, and maps the user into
|
|
5
|
-
Clivly's auth shape.
|
|
3
|
+
[WorkOS](https://workos.com) implementation of Clivly's `ClivlyAuthAdapter`. Unseals the host app's AuthKit session cookie to resolve a CRM end-user's identity.
|
|
6
4
|
|
|
7
|
-
|
|
5
|
+
> **Preview-quality surface.** Install with `npm install @clivly/auth-workos`.
|
|
6
|
+
> The user mapper, cookie reader, and session resolution are unit-tested;
|
|
7
|
+
> broader host-app compatibility coverage is still growing.
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
npm install @clivly/auth-workos @workos-inc/node
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
This adapter is a Tier 2 surface in
|
|
14
|
-
[STABILITY.md](https://github.com/amani-joseph/clivly.com/blob/master/STABILITY.md).
|
|
15
|
-
|
|
16
|
-
## Usage
|
|
9
|
+
`@workos-inc/node` is a peer dependency.
|
|
17
10
|
|
|
18
11
|
```ts
|
|
19
12
|
import { createWorkOSAuthAdapter } from "@clivly/auth-workos";
|
|
@@ -22,17 +15,11 @@ const authAdapter = createWorkOSAuthAdapter({
|
|
|
22
15
|
apiKey: process.env.WORKOS_API_KEY!,
|
|
23
16
|
clientId: process.env.WORKOS_CLIENT_ID!,
|
|
24
17
|
cookiePassword: process.env.WORKOS_COOKIE_PASSWORD!,
|
|
25
|
-
// optional:
|
|
26
|
-
// cookieName: "wos-session",
|
|
27
18
|
});
|
|
28
19
|
|
|
29
|
-
const user = await authAdapter.getUser(request);
|
|
30
|
-
// { id, email, name } | null
|
|
20
|
+
const user = await authAdapter.getUser(request); // { id, email, name } | null
|
|
31
21
|
```
|
|
32
22
|
|
|
33
|
-
Returns `null` when there is no session cookie or the WorkOS session does not
|
|
34
|
-
authenticate.
|
|
35
|
-
|
|
36
23
|
## License
|
|
37
24
|
|
|
38
25
|
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@clivly/auth-workos",
|
|
3
|
-
"version": "0.7.
|
|
3
|
+
"version": "0.7.3",
|
|
4
4
|
"private": false,
|
|
5
5
|
"type": "module",
|
|
6
6
|
"description": "WorkOS implementation of Clivly's ClivlyAuthAdapter.",
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
"access": "public"
|
|
26
26
|
},
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@clivly/core": "0.7.
|
|
28
|
+
"@clivly/core": "0.7.3"
|
|
29
29
|
},
|
|
30
30
|
"peerDependencies": {
|
|
31
31
|
"@workos-inc/node": ">=7"
|