@atproto/oauth-client-node 0.0.1 → 0.0.2-rc.0

package/README.md

@@ -280,6 +280,69 @@ const requestLock: RuntimeLock = async (key, fn) => {
 }
 ```
 
+## Usage with `@atproto/api`
+
+`@atproto/oauth-client-*` packages all return an `ApiClient` instance upon
+successful authentication. This instance can be used to make authenticated
+requests using all the `ApiClient` methods defined in [[API]] (non exhaustive
+list of examples below). Any refresh of the credentials will happen under the
+hood, and the new tokens will be saved in the session store.
+
+```ts
+const agent = await client.restore('did:plc:123')
+
+// Feeds and content
+await agent.getTimeline(params, opts)
+await agent.getAuthorFeed(params, opts)
+await agent.getPostThread(params, opts)
+await agent.getPost(params)
+await agent.getPosts(params, opts)
+await agent.getLikes(params, opts)
+await agent.getRepostedBy(params, opts)
+await agent.post(record)
+await agent.deletePost(postUri)
+await agent.like(uri, cid)
+await agent.deleteLike(likeUri)
+await agent.repost(uri, cid)
+await agent.deleteRepost(repostUri)
+await agent.uploadBlob(data, opts)
+
+// Social graph
+await agent.getFollows(params, opts)
+await agent.getFollowers(params, opts)
+await agent.follow(did)
+await agent.deleteFollow(followUri)
+
+// Actors
+await agent.getProfile(params, opts)
+await agent.upsertProfile(updateFn)
+await agent.getProfiles(params, opts)
+await agent.getSuggestions(params, opts)
+await agent.searchActors(params, opts)
+await agent.searchActorsTypeahead(params, opts)
+await agent.mute(did)
+await agent.unmute(did)
+await agent.muteModList(listUri)
+await agent.unmuteModList(listUri)
+await agent.blockModList(listUri)
+await agent.unblockModList(listUri)
+
+// Notifications
+await agent.listNotifications(params, opts)
+await agent.countUnreadNotifications(params, opts)
+await agent.updateSeenNotifications()
+
+// Identity
+await agent.resolveHandle(params, opts)
+await agent.updateHandle(params, opts)
+
+// etc.
+
+if (agent instanceof OAuthAtpAgent) {
+  agent.signOut()
+}
+```
+
 ## Advances use-cases
 
 ### Listening for session updates and deletion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/oauth-client-node",
-  "version": "0.0.1",
+  "version": "0.0.2-rc.0",
   "license": "MIT",
   "description": "ATPROTO OAuth client for the NodeJS",
   "keywords": [
@@ -35,12 +35,12 @@
     "@atproto/jwk": "0.1.1",
     "@atproto/jwk-jose": "0.1.1",
     "@atproto/jwk-webcrypto": "0.1.1",
-    "@atproto/oauth-client": "0.1.1",
+    "@atproto/oauth-client": "0.1.2-rc.0",
     "@atproto/oauth-types": "0.1.1"
   },
   "devDependencies": {
     "typescript": "^5.3.3",
-    "@atproto/api": "0.12.24"
+    "@atproto/api": "0.13.0-rc.0"
   },
   "scripts": {
     "build": "tsc --build tsconfig.build.json"