@atproto/api 0.6.15 → 0.6.16

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atproto/api
 
+## 0.6.16
+
+### Patch Changes
+
+- [#1653](https://github.com/bluesky-social/atproto/pull/1653) [`56e2cf89`](https://github.com/bluesky-social/atproto/commit/56e2cf8999f6d7522529a9be8652c47545f82242) Thanks [@pfrazee](https://github.com/pfrazee)! - Improve the types of the thread and feed preferences APIs
+
 ## 0.6.15
 
 ### Patch Changes

package/README.md

@@ -31,6 +31,8 @@ Log into a server or create accounts using these APIs. You'll need an active ses
 
 ```typescript
 import { BskyAgent, AtpSessionEvent, AtpSessionData } from '@atproto/api'
+
+// configure connection to the server, without account authentication
 const agent = new BskyAgent({
   service: 'https://example.com',
   persistSession: (evt: AtpSessionEvent, sess?: AtpSessionData) => {
@@ -38,13 +40,19 @@ const agent = new BskyAgent({
   },
 })
 
-await agent.login({ identifier: 'alice@mail.com', password: 'hunter2' })
-await agent.resumeSession(savedSessionData)
+// create a new account on the server
 await agent.createAccount({
   email: 'alice@mail.com',
   password: 'hunter2',
   handle: 'alice.example.com',
+  inviteCode: 'some-code-12345-abcde',
 })
+
+// if an existing session (accessed with 'agent.session') was securely stored previously, then reuse that
+await agent.resumeSession(savedSessionData)
+
+// if no old session was available, create a new one by logging in with password (App Password)
+await agent.login({ identifier: 'alice@mail.com', password: 'hunter2' })
 ```
 
 ### API calls

package/dist/bsky-agent.d.ts

@@ -1,6 +1,6 @@
 import { AtpAgent } from './agent';
-import { AppBskyFeedPost, AppBskyActorProfile, AppBskyActorDefs } from './client';
-import { BskyPreferences, BskyLabelPreference } from './types';
+import { AppBskyFeedPost, AppBskyActorProfile } from './client';
+import { BskyPreferences, BskyLabelPreference, BskyFeedViewPreference, BskyThreadViewPreference } from './types';
 declare global {
     interface Array<T> {
         findLast(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): T;
@@ -75,6 +75,6 @@ export declare class BskyAgent extends AtpAgent {
     setPersonalDetails({ birthDate, }: {
         birthDate: string | Date | undefined;
     }): Promise<void>;
-    setFeedViewPrefs(feed: string, pref: Omit<AppBskyActorDefs.FeedViewPref, '$type' | 'feed'>): Promise<void>;
-    setThreadViewPrefs(pref: Omit<AppBskyActorDefs.ThreadViewPref, '$type'>): Promise<void>;
+    setFeedViewPrefs(feed: string, pref: Partial<BskyFeedViewPreference>): Promise<void>;
+    setThreadViewPrefs(pref: Partial<BskyThreadViewPreference>): Promise<void>;
 }

package/dist/index.js

@@ -22382,7 +22382,7 @@ var schemaDict = {
     defs: {
       main: {
         type: "query",
-        description: "An unspecced view of globally popular items",
+        description: "DEPRECATED: will be removed soon, please find a feed generator alternative",
         parameters: {
           type: "params",
           properties: {
@@ -28892,12 +28892,12 @@ function decideQuotedPostWithMediaAccount(subject, opts) {
 }
 
 // src/moderation/subjects/feed-generator.ts
-function decideFeedGenerator(subject, opts) {
+function decideFeedGenerator(_subject, _opts) {
   return ModerationDecision.noop();
 }
 
 // src/moderation/subjects/user-list.ts
-function decideUserList(subject, opts) {
+function decideUserList(_subject, _opts) {
   return ModerationDecision.noop();
 }