Add interest tags to preferences (#2086)

* Add interestsPref * Codegen * Update lex * Add method to agent, test * Codegen * Format * Remove console * Update lex, codegen, update tests * Update tests * Format * Add changeset * Update property name
bluesky-social · Jan 25, 2024 · 4171c04 · 4171c04
1 parent 39fe6b5
commit 4171c04
Show file tree

Hide file tree

Showing 13 changed files with 313 additions and 1 deletion.
diff --git a/.changeset/real-bikes-share.md b/.changeset/real-bikes-share.md
@@ -0,0 +1,6 @@
+---
+'@atproto/api': patch
+---
+
+Add `setInterestsPref` method to BskyAgent, and `interests` prop to
+`getPreferences` response.
diff --git a/lexicons/app/bsky/actor/defs.json b/lexicons/app/bsky/actor/defs.json
@@ -104,7 +104,8 @@
           "#savedFeedsPref",
           "#personalDetailsPref",
           "#feedViewPref",
-          "#threadViewPref"
+          "#threadViewPref",
+          "#interestsPref"
         ]
       }
     },
@@ -199,6 +200,18 @@
           "description": "Show followed users at the top of all replies."
         }
       }
+    },
+    "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."
+        }
+      }
     }
   }
 }
diff --git a/packages/api/src/bsky-agent.ts b/packages/api/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' }])
+    })
+  }
 }
 
 /**

diff --git a/packages/api/src/client/lexicons.ts b/packages/api/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: {

diff --git a/packages/api/src/client/types/app/bsky/actor/defs.ts b/packages/api/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)
+}
diff --git a/packages/api/src/types.ts b/packages/api/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
 }