@atproto/api 0.9.3 → 0.9.4

package/dist/types.d.ts

@@ -41,6 +41,10 @@ export interface BskyThreadViewPreference {
     prioritizeFollowedUsers: boolean;
     [key: string]: any;
 }
+export interface BskyInterestsPreference {
+    tags: string[];
+    [key: string]: any;
+}
 export interface BskyPreferences {
     feeds: {
         saved?: string[];
@@ -51,5 +55,6 @@ export interface BskyPreferences {
     adultContentEnabled: boolean;
     contentLabels: Record<string, BskyLabelPreference>;
     birthDate: Date | undefined;
+    interests: BskyInterestsPreference;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/api",
-  "version": "0.9.3",
+  "version": "0.9.4",
   "license": "MIT",
   "description": "Client library for atproto and Bluesky",
   "keywords": [
@@ -28,7 +28,7 @@
   "devDependencies": {
     "common-tags": "^1.8.2",
     "@atproto/lex-cli": "^0.3.0",
-    "@atproto/dev-env": "^0.2.26"
+    "@atproto/dev-env": "^0.2.27"
   },
   "scripts": {
     "codegen": "pnpm docgen && node ./scripts/generate-code.mjs && lex gen-api ./src/client ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/*",

package/src/bsky-agent.ts

@@ -11,6 +11,7 @@ import {
   BskyLabelPreference,
   BskyFeedViewPreference,
   BskyThreadViewPreference,
+  BskyInterestsPreference,
 } from './types'
 
 const FEED_VIEW_PREF_DEFAULTS = {
@@ -323,6 +324,9 @@ export class BskyAgent extends AtpAgent {
       adultContentEnabled: false,
       contentLabels: {},
       birthDate: undefined,
+      interests: {
+        tags: [],
+      },
     }
     const res = await this.app.bsky.actor.getPreferences({})
     for (const pref of res.data.preferences) {
@@ -369,6 +373,13 @@ export class BskyAgent extends AtpAgent {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         const { $type, ...v } = pref
         prefs.threadViewPrefs = { ...prefs.threadViewPrefs, ...v }
+      } else if (
+        AppBskyActorDefs.isInterestsPref(pref) &&
+        AppBskyActorDefs.validateInterestsPref(pref).success
+      ) {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { $type, ...v } = pref
+        prefs.interests = { ...prefs.interests, ...v }
       }
     }
     return prefs
@@ -521,6 +532,22 @@ export class BskyAgent extends AtpAgent {
         .concat([{ ...pref, $type: 'app.bsky.actor.defs#threadViewPref' }])
     })
   }
+
+  async setInterestsPref(pref: Partial<BskyInterestsPreference>) {
+    await updatePreferences(this, (prefs: AppBskyActorDefs.Preferences) => {
+      const existing = prefs.findLast(
+        (pref) =>
+          AppBskyActorDefs.isInterestsPref(pref) &&
+          AppBskyActorDefs.validateInterestsPref(pref).success,
+      )
+      if (existing) {
+        pref = { ...existing, ...pref }
+      }
+      return prefs
+        .filter((p) => !AppBskyActorDefs.isInterestsPref(p))
+        .concat([{ ...pref, $type: 'app.bsky.actor.defs#interestsPref' }])
+    })
+  }
 }
 
 /**

package/src/client/index.ts

@@ -132,6 +132,7 @@ import * as AppBskyGraphGetListBlocks from './types/app/bsky/graph/getListBlocks
 import * as AppBskyGraphGetListMutes from './types/app/bsky/graph/getListMutes'
 import * as AppBskyGraphGetLists from './types/app/bsky/graph/getLists'
 import * as AppBskyGraphGetMutes from './types/app/bsky/graph/getMutes'
+import * as AppBskyGraphGetRelationships from './types/app/bsky/graph/getRelationships'
 import * as AppBskyGraphGetSuggestedFollowsByActor from './types/app/bsky/graph/getSuggestedFollowsByActor'
 import * as AppBskyGraphList from './types/app/bsky/graph/list'
 import * as AppBskyGraphListblock from './types/app/bsky/graph/listblock'
@@ -277,6 +278,7 @@ export * as AppBskyGraphGetListBlocks from './types/app/bsky/graph/getListBlocks
 export * as AppBskyGraphGetListMutes from './types/app/bsky/graph/getListMutes'
 export * as AppBskyGraphGetLists from './types/app/bsky/graph/getLists'
 export * as AppBskyGraphGetMutes from './types/app/bsky/graph/getMutes'
+export * as AppBskyGraphGetRelationships from './types/app/bsky/graph/getRelationships'
 export * as AppBskyGraphGetSuggestedFollowsByActor from './types/app/bsky/graph/getSuggestedFollowsByActor'
 export * as AppBskyGraphList from './types/app/bsky/graph/list'
 export * as AppBskyGraphListblock from './types/app/bsky/graph/listblock'
@@ -2057,6 +2059,17 @@ export class AppBskyGraphNS {
       })
   }
 
+  getRelationships(
+    params?: AppBskyGraphGetRelationships.QueryParams,
+    opts?: AppBskyGraphGetRelationships.CallOptions,
+  ): Promise<AppBskyGraphGetRelationships.Response> {
+    return this._service.xrpc
+      .call('app.bsky.graph.getRelationships', params, undefined, opts)
+      .catch((e) => {
+        throw AppBskyGraphGetRelationships.toKnownErr(e)
+      })
+  }
+
   getSuggestedFollowsByActor(
     params?: AppBskyGraphGetSuggestedFollowsByActor.QueryParams,
     opts?: AppBskyGraphGetSuggestedFollowsByActor.CallOptions,

package/src/client/lexicons.ts

@@ -4615,6 +4615,7 @@ export const schemaDict = {
             'lex:app.bsky.actor.defs#personalDetailsPref',
             'lex:app.bsky.actor.defs#feedViewPref',
             'lex:app.bsky.actor.defs#threadViewPref',
+            'lex:app.bsky.actor.defs#interestsPref',
           ],
         },
       },
@@ -4718,6 +4719,23 @@ export const schemaDict = {
           },
         },
       },
+      interestsPref: {
+        type: 'object',
+        required: ['tags'],
+        properties: {
+          tags: {
+            type: 'array',
+            maxLength: 100,
+            items: {
+              type: 'string',
+              maxLength: 640,
+              maxGraphemes: 64,
+            },
+            description:
+              "A list of tags which describe the account owner's interests gathered during onboarding.",
+          },
+        },
+      },
     },
   },
   AppBskyActorGetPreferences: {
@@ -6925,6 +6943,45 @@ export const schemaDict = {
           },
         },
       },
+      notFoundActor: {
+        type: 'object',
+        description: 'indicates that a handle or DID could not be resolved',
+        required: ['actor', 'notFound'],
+        properties: {
+          actor: {
+            type: 'string',
+            format: 'at-identifier',
+          },
+          notFound: {
+            type: 'boolean',
+            const: true,
+          },
+        },
+      },
+      relationship: {
+        type: 'object',
+        description:
+          'lists the bi-directional graph relationships between one actor (not indicated in the object), and the target actors (the DID included in the object)',
+        required: ['did'],
+        properties: {
+          did: {
+            type: 'string',
+            format: 'did',
+          },
+          following: {
+            type: 'string',
+            format: 'at-uri',
+            description:
+              'if the actor follows this DID, this is the AT-URI of the follow record',
+          },
+          followedBy: {
+            type: 'string',
+            format: 'at-uri',
+            description:
+              'if the actor is followed by this DID, contains the AT-URI of the follow record',
+          },
+        },
+      },
     },
   },
   AppBskyGraphFollow: {
@@ -7328,6 +7385,65 @@ export const schemaDict = {
       },
     },
   },
+  AppBskyGraphGetRelationships: {
+    lexicon: 1,
+    id: 'app.bsky.graph.getRelationships',
+    defs: {
+      main: {
+        type: 'query',
+        description:
+          'Enumerates public relationships between one account, and a list of other accounts',
+        parameters: {
+          type: 'params',
+          required: ['actor'],
+          properties: {
+            actor: {
+              type: 'string',
+              format: 'at-identifier',
+            },
+            others: {
+              type: 'array',
+              maxLength: 30,
+              items: {
+                type: 'string',
+                format: 'at-identifier',
+              },
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['relationships'],
+            properties: {
+              actor: {
+                type: 'string',
+                format: 'did',
+              },
+              relationships: {
+                type: 'array',
+                items: {
+                  type: 'union',
+                  refs: [
+                    'lex:app.bsky.graph.defs#relationship',
+                    'lex:app.bsky.graph.defs#notFoundActor',
+                  ],
+                },
+              },
+            },
+          },
+        },
+        errors: [
+          {
+            name: 'ActorNotFound',
+            description:
+              'the primary actor at-identifier could not be resolved',
+          },
+        ],
+      },
+    },
+  },
   AppBskyGraphGetSuggestedFollowsByActor: {
     lexicon: 1,
     id: 'app.bsky.graph.getSuggestedFollowsByActor',
@@ -8272,6 +8388,7 @@ export const ids = {
   AppBskyGraphGetListMutes: 'app.bsky.graph.getListMutes',
   AppBskyGraphGetLists: 'app.bsky.graph.getLists',
   AppBskyGraphGetMutes: 'app.bsky.graph.getMutes',
+  AppBskyGraphGetRelationships: 'app.bsky.graph.getRelationships',
   AppBskyGraphGetSuggestedFollowsByActor:
     'app.bsky.graph.getSuggestedFollowsByActor',
   AppBskyGraphList: 'app.bsky.graph.list',

package/src/client/types/app/bsky/actor/defs.ts

@@ -112,6 +112,7 @@ export type Preferences = (
   | PersonalDetailsPref
   | FeedViewPref
   | ThreadViewPref
+  | InterestsPref
   | { $type: string; [k: string]: unknown }
 )[]
 
@@ -233,3 +234,21 @@ export function isThreadViewPref(v: unknown): v is ThreadViewPref {
 export function validateThreadViewPref(v: unknown): ValidationResult {
   return lexicons.validate('app.bsky.actor.defs#threadViewPref', v)
 }
+
+export interface InterestsPref {
+  /** A list of tags which describe the account owner's interests gathered during onboarding. */
+  tags: string[]
+  [k: string]: unknown
+}
+
+export function isInterestsPref(v: unknown): v is InterestsPref {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.actor.defs#interestsPref'
+  )
+}
+
+export function validateInterestsPref(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.actor.defs#interestsPref', v)
+}

package/src/client/types/app/bsky/graph/defs.ts

@@ -102,3 +102,44 @@ export function isListViewerState(v: unknown): v is ListViewerState {
 export function validateListViewerState(v: unknown): ValidationResult {
   return lexicons.validate('app.bsky.graph.defs#listViewerState', v)
 }
+
+/** indicates that a handle or DID could not be resolved */
+export interface NotFoundActor {
+  actor: string
+  notFound: true
+  [k: string]: unknown
+}
+
+export function isNotFoundActor(v: unknown): v is NotFoundActor {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.graph.defs#notFoundActor'
+  )
+}
+
+export function validateNotFoundActor(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.graph.defs#notFoundActor', v)
+}
+
+/** lists the bi-directional graph relationships between one actor (not indicated in the object), and the target actors (the DID included in the object) */
+export interface Relationship {
+  did: string
+  /** if the actor follows this DID, this is the AT-URI of the follow record */
+  following?: string
+  /** if the actor is followed by this DID, contains the AT-URI of the follow record */
+  followedBy?: string
+  [k: string]: unknown
+}
+
+export function isRelationship(v: unknown): v is Relationship {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.graph.defs#relationship'
+  )
+}
+
+export function validateRelationship(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.graph.defs#relationship', v)
+}

package/src/client/types/app/bsky/graph/getRelationships.ts

@@ -0,0 +1,49 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { Headers, XRPCError } from '@atproto/xrpc'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+import { CID } from 'multiformats/cid'
+import * as AppBskyGraphDefs from './defs'
+
+export interface QueryParams {
+  actor: string
+  others?: string[]
+}
+
+export type InputSchema = undefined
+
+export interface OutputSchema {
+  actor?: string
+  relationships: (
+    | AppBskyGraphDefs.Relationship
+    | AppBskyGraphDefs.NotFoundActor
+    | { $type: string; [k: string]: unknown }
+  )[]
+  [k: string]: unknown
+}
+
+export interface CallOptions {
+  headers?: Headers
+}
+
+export interface Response {
+  success: boolean
+  headers: Headers
+  data: OutputSchema
+}
+
+export class ActorNotFoundError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers)
+  }
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+    if (e.error === 'ActorNotFound') return new ActorNotFoundError(e)
+  }
+  return e
+}

package/src/types.ts

@@ -97,6 +97,14 @@ export interface BskyThreadViewPreference {
   [key: string]: any
 }
 
+/**
+ * Bluesky interests preferences
+ */
+export interface BskyInterestsPreference {
+  tags: string[]
+  [key: string]: any
+}
+
 /**
  * Bluesky preferences
  */
@@ -110,4 +118,5 @@ export interface BskyPreferences {
   adultContentEnabled: boolean
   contentLabels: Record<string, BskyLabelPreference>
   birthDate: Date | undefined
+  interests: BskyInterestsPreference
 }

package/tests/bsky-agent.test.ts

@@ -236,6 +236,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.setAdultContentEnabled(true)
@@ -257,6 +260,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.setAdultContentEnabled(false)
@@ -278,6 +284,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.setContentLabelPref('impersonation', 'warn')
@@ -301,6 +310,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.setContentLabelPref('spam', 'show') // will convert to 'ignore'
@@ -326,6 +338,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.addSavedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -353,6 +368,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -380,6 +398,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.removePinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -407,6 +428,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.removeSavedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -434,6 +458,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -461,6 +488,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake2')
@@ -494,6 +524,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.removeSavedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -521,6 +554,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.setPersonalDetails({ birthDate: '2023-09-11T18:05:42.556Z' })
@@ -548,6 +584,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.setFeedViewPrefs('home', { hideReplies: true })
@@ -575,6 +614,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.setFeedViewPrefs('home', { hideReplies: false })
@@ -602,6 +644,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.setFeedViewPrefs('other', { hideReplies: true })
@@ -636,6 +681,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.setThreadViewPrefs({ sort: 'random' })
@@ -670,6 +718,9 @@ describe('agent', () => {
           sort: 'random',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.setThreadViewPrefs({ sort: 'oldest' })
@@ -704,6 +755,46 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
+      })
+
+      await agent.setInterestsPref({ tags: ['foo', 'bar'] })
+      await expect(agent.getPreferences()).resolves.toStrictEqual({
+        feeds: {
+          pinned: ['at://bob.com/app.bsky.feed.generator/fake2'],
+          saved: ['at://bob.com/app.bsky.feed.generator/fake2'],
+        },
+        adultContentEnabled: false,
+        contentLabels: {
+          impersonation: 'hide',
+          spam: 'ignore',
+        },
+        birthDate: new Date('2023-09-11T18:05:42.556Z'),
+        feedViewPrefs: {
+          home: {
+            hideReplies: false,
+            hideRepliesByUnfollowed: false,
+            hideRepliesByLikeCount: 0,
+            hideReposts: false,
+            hideQuotePosts: false,
+          },
+          other: {
+            hideReplies: true,
+            hideRepliesByUnfollowed: false,
+            hideRepliesByLikeCount: 0,
+            hideReposts: false,
+            hideQuotePosts: false,
+          },
+        },
+        threadViewPrefs: {
+          sort: 'oldest',
+          prioritizeFollowedUsers: true,
+        },
+        interests: {
+          tags: ['foo', 'bar'],
+        },
       })
     })
 
@@ -827,6 +918,9 @@ describe('agent', () => {
           sort: 'newest',
           prioritizeFollowedUsers: false,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.setAdultContentEnabled(false)
@@ -853,6 +947,9 @@ describe('agent', () => {
           sort: 'newest',
           prioritizeFollowedUsers: false,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.setContentLabelPref('nsfw', 'hide')
@@ -879,6 +976,9 @@ describe('agent', () => {
           sort: 'newest',
           prioritizeFollowedUsers: false,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -905,6 +1005,9 @@ describe('agent', () => {
           sort: 'newest',
           prioritizeFollowedUsers: false,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.setPersonalDetails({ birthDate: '2023-09-11T18:05:42.556Z' })
@@ -931,6 +1034,9 @@ describe('agent', () => {
           sort: 'newest',
           prioritizeFollowedUsers: false,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       await agent.setFeedViewPrefs('home', {
@@ -968,6 +1074,9 @@ describe('agent', () => {
           sort: 'oldest',
           prioritizeFollowedUsers: true,
         },
+        interests: {
+          tags: [],
+        },
       })
 
       const res = await agent.app.bsky.actor.getPreferences()