@clivly/auth-clerk 0.7.1 → 0.7.2

package/README.md

@@ -1,12 +1,19 @@
 # @clivly/auth-clerk
 
-[Clerk](https://clerk.com) implementation of Clivly's `ClivlyAuthAdapter`. Resolves a CRM end-user's identity from the host app's Clerk session.
+Clerk implementation of Clivly's `ClivlyAuthAdapter`. It resolves the current
+end-user from the host app's Clerk session and returns a Clivly-compatible user
+shape.
 
-> **Preview-quality surface.** Install with `npm install @clivly/auth-clerk`.
-> The email mapper and session resolution are unit-tested; broader host-app
-> compatibility coverage is still growing.
+## Install
 
-`@clerk/backend` is a peer dependency.
+```bash
+npm install @clivly/auth-clerk @clerk/backend
+```
+
+This adapter is a Tier 2 surface in
+[STABILITY.md](https://github.com/amani-joseph/clivly.com/blob/master/STABILITY.md).
+
+## Usage
 
 ```ts
 import { createClerkAuthAdapter } from "@clivly/auth-clerk";
@@ -14,11 +21,17 @@ import { createClerkAuthAdapter } from "@clivly/auth-clerk";
 const authAdapter = createClerkAuthAdapter({
   secretKey: process.env.CLERK_SECRET_KEY!,
   publishableKey: process.env.CLERK_PUBLISHABLE_KEY,
+  // optional:
+  // authorizedParties: ["https://app.example.com"],
 });
 
-const user = await authAdapter.getUser(request); // { id, email, name } | null
+const user = await authAdapter.getUser(request);
+// { id, email, name } | null
 ```
 
+Returns `null` when no Clerk session resolves, or when the resolved Clerk user
+does not map to a Clivly user.
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clivly/auth-clerk",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "private": false,
   "type": "module",
   "description": "Clerk implementation of Clivly's ClivlyAuthAdapter.",
@@ -25,7 +25,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@clivly/core": "0.7.1"
+    "@clivly/core": "0.7.2"
   },
   "peerDependencies": {
     "@clerk/backend": ">=1"