Add setPostInteractionSettings and related prefs (#3494)

* Add setPostInteractionSettings and related prefs

* Fix test

* Align types and implementation

* Tighten up, clarifying descriptions

* Fix test

* Format

.changeset/tame-cobras-lick.md

@@ -0,0 +1,5 @@
+---
+"@atproto/api": patch
+---
+
+Add `setPostInteractionSettings` for configuring default interaction settings for creation of posts

lexicons/app/bsky/actor/defs.json

@@ -174,7 +174,8 @@
           "#mutedWordsPref",
           "#hiddenPostsPref",
           "#bskyAppStatePref",
-          "#labelersPref"
+          "#labelersPref",
+          "#postInteractionSettingsPref"
         ]
       }
     },
@@ -468,6 +469,35 @@
           "description": "The date and time at which the NUX will expire and should be considered completed."
         }
       }
+    },
+    "postInteractionSettingsPref": {
+      "type": "object",
+      "description": "Default post interaction settings for the account. These values should be applied as default values when creating new posts. These refs should mirror the threadgate and postgate records exactly.",
+      "required": [],
+      "properties": {
+        "threadgateAllowRules": {
+          "description": "Matches threadgate record. List of rules defining who can reply to this users posts. If value is an empty array, no one can reply. If value is undefined, anyone can reply.",
+          "type": "array",
+          "maxLength": 5,
+          "items": {
+            "type": "union",
+            "refs": [
+              "app.bsky.feed.threadgate#mentionRule",
+              "app.bsky.feed.threadgate#followingRule",
+              "app.bsky.feed.threadgate#listRule"
+            ]
+          }
+        },
+        "postgateEmbeddingRules": {
+          "description": "Matches postgate record. List of rules defining who can embed this users posts. If value is an empty array or is undefined, no particular rules apply and anyone can embed.",
+          "type": "array",
+          "maxLength": 5,
+          "items": {
+            "type": "union",
+            "refs": ["app.bsky.feed.postgate#disableRule"]
+          }
+        }
+      }
     }
   }
 }

lexicons/app/bsky/feed/postgate.json

@@ -26,6 +26,7 @@
             "description": "List of AT-URIs embedding this post that the author has detached from."
           },
           "embeddingRules": {
+            "description": "List of rules defining who can embed this post. If value is an empty array or is undefined, no particular rules apply and anyone can embed.",
             "type": "array",
             "maxLength": 5,
             "items": {

lexicons/app/bsky/feed/threadgate.json

@@ -16,6 +16,7 @@
             "description": "Reference (AT-URI) to the post record."
           },
           "allow": {
+            "description": "List of rules defining who can reply to this post. If value is an empty array, no one can reply. If value is undefined, anyone can reply.",
             "type": "array",
             "maxLength": 5,
             "items": {

packages/api/src/agent.ts

@@ -583,6 +583,10 @@ export class Agent extends XrpcClient {
         activeProgressGuide: undefined,
         nuxs: [],
       },
+      postInteractionSettings: {
+        threadgateAllowRules: undefined,
+        postgateEmbeddingRules: undefined,
+      },
     }
     const res = await this.app.bsky.actor.getPreferences({})
     const labelPrefs: AppBskyActorDefs.ContentLabelPref[] = []
@@ -687,6 +691,14 @@ export class Agent extends XrpcClient {
         prefs.bskyAppState.queuedNudges = v.queuedNudges || []
         prefs.bskyAppState.activeProgressGuide = v.activeProgressGuide
         prefs.bskyAppState.nuxs = v.nuxs || []
+      } else if (
+        AppBskyActorDefs.isPostInteractionSettingsPref(pref) &&
+        AppBskyActorDefs.validatePostInteractionSettingsPref(pref).success
+      ) {
+        prefs.postInteractionSettings.threadgateAllowRules =
+          pref.threadgateAllowRules
+        prefs.postInteractionSettings.postgateEmbeddingRules =
+          pref.postgateEmbeddingRules
       }
     }
 
@@ -1463,6 +1475,49 @@ export class Agent extends XrpcClient {
     })
   }
 
+  async setPostInteractionSettings(
+    settings: AppBskyActorDefs.PostInteractionSettingsPref,
+  ) {
+    if (
+      !AppBskyActorDefs.validatePostInteractionSettingsPref(settings).success
+    ) {
+      throw new Error('Invalid post interaction settings')
+    }
+
+    await this.updatePreferences((prefs: AppBskyActorDefs.Preferences) => {
+      let prev = prefs.findLast(
+        (pref) =>
+          AppBskyActorDefs.isPostInteractionSettingsPref(pref) &&
+          AppBskyActorDefs.validatePostInteractionSettingsPref(pref).success,
+      ) as AppBskyActorDefs.PostInteractionSettingsPref
+
+      if (!prev) {
+        prev = {
+          /**
+           * Matches handling of `threadgate.allow` where `undefined` means "everyone"
+           */
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        }
+      }
+
+      /**
+       * Matches handling of `threadgate.allow` where `undefined` means "everyone"
+       */
+      prev.threadgateAllowRules = settings.threadgateAllowRules
+      prev.postgateEmbeddingRules = settings.postgateEmbeddingRules
+
+      return prefs
+        .filter((p) => !AppBskyActorDefs.isPostInteractionSettingsPref(p))
+        .concat([
+          {
+            ...prev,
+            $type: 'app.bsky.actor.defs#postInteractionSettingsPref',
+          },
+        ])
+    })
+  }
+
   //- Private methods
 
   #prefsLock = new AwaitLock()

packages/api/src/client/lexicons.ts

@@ -4381,6 +4381,7 @@ export const schemaDict = {
             'lex:app.bsky.actor.defs#hiddenPostsPref',
             'lex:app.bsky.actor.defs#bskyAppStatePref',
             'lex:app.bsky.actor.defs#labelersPref',
+            'lex:app.bsky.actor.defs#postInteractionSettingsPref',
           ],
         },
       },
@@ -4714,6 +4715,38 @@ export const schemaDict = {
           },
         },
       },
+      postInteractionSettingsPref: {
+        type: 'object',
+        description:
+          'Default post interaction settings for the account. These values should be applied as default values when creating new posts. These refs should mirror the threadgate and postgate records exactly.',
+        required: [],
+        properties: {
+          threadgateAllowRules: {
+            description:
+              'Matches threadgate record. List of rules defining who can reply to this users posts. If value is an empty array, no one can reply. If value is undefined, anyone can reply.',
+            type: 'array',
+            maxLength: 5,
+            items: {
+              type: 'union',
+              refs: [
+                'lex:app.bsky.feed.threadgate#mentionRule',
+                'lex:app.bsky.feed.threadgate#followingRule',
+                'lex:app.bsky.feed.threadgate#listRule',
+              ],
+            },
+          },
+          postgateEmbeddingRules: {
+            description:
+              'Matches postgate record. List of rules defining who can embed this users posts. If value is an empty array or is undefined, no particular rules apply and anyone can embed.',
+            type: 'array',
+            maxLength: 5,
+            items: {
+              type: 'union',
+              refs: ['lex:app.bsky.feed.postgate#disableRule'],
+            },
+          },
+        },
+      },
     },
   },
   AppBskyActorGetPreferences: {
@@ -7120,6 +7153,8 @@ export const schemaDict = {
                 'List of AT-URIs embedding this post that the author has detached from.',
             },
             embeddingRules: {
+              description:
+                'List of rules defining who can embed this post. If value is an empty array or is undefined, no particular rules apply and anyone can embed.',
               type: 'array',
               maxLength: 5,
               items: {
@@ -7333,6 +7368,8 @@ export const schemaDict = {
               description: 'Reference (AT-URI) to the post record.',
             },
             allow: {
+              description:
+                'List of rules defining who can reply to this post. If value is an empty array, no one can reply. If value is undefined, anyone can reply.',
               type: 'array',
               maxLength: 5,
               items: {

packages/api/src/client/types/app/bsky/actor/defs.ts

@@ -8,6 +8,8 @@ import { CID } from 'multiformats/cid'
 import * as ComAtprotoLabelDefs from '../../../com/atproto/label/defs'
 import * as AppBskyGraphDefs from '../graph/defs'
 import * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef'
+import * as AppBskyFeedThreadgate from '../feed/threadgate'
+import * as AppBskyFeedPostgate from '../feed/postgate'
 
 export interface ProfileViewBasic {
   did: string
@@ -188,6 +190,7 @@ export type Preferences = (
   | HiddenPostsPref
   | BskyAppStatePref
   | LabelersPref
+  | PostInteractionSettingsPref
   | { $type: string; [k: string]: unknown }
 )[]
 
@@ -532,3 +535,36 @@ export function isNux(v: unknown): v is Nux {
 export function validateNux(v: unknown): ValidationResult {
   return lexicons.validate('app.bsky.actor.defs#nux', v)
 }
+
+/** Default post interaction settings for the account. These values should be applied as default values when creating new posts. These refs should mirror the threadgate and postgate records exactly. */
+export interface PostInteractionSettingsPref {
+  /** Matches threadgate record. List of rules defining who can reply to this users posts. If value is an empty array, no one can reply. If value is undefined, anyone can reply. */
+  threadgateAllowRules?: (
+    | AppBskyFeedThreadgate.MentionRule
+    | AppBskyFeedThreadgate.FollowingRule
+    | AppBskyFeedThreadgate.ListRule
+    | { $type: string; [k: string]: unknown }
+  )[]
+  /** Matches postgate record. List of rules defining who can embed this users posts. If value is an empty array or is undefined, no particular rules apply and anyone can embed. */
+  postgateEmbeddingRules?: (
+    | AppBskyFeedPostgate.DisableRule
+    | { $type: string; [k: string]: unknown }
+  )[]
+  [k: string]: unknown
+}
+
+export function isPostInteractionSettingsPref(
+  v: unknown,
+): v is PostInteractionSettingsPref {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.actor.defs#postInteractionSettingsPref'
+  )
+}
+
+export function validatePostInteractionSettingsPref(
+  v: unknown,
+): ValidationResult {
+  return lexicons.validate('app.bsky.actor.defs#postInteractionSettingsPref', v)
+}

packages/api/src/client/types/app/bsky/feed/postgate.ts

@@ -12,6 +12,7 @@ export interface Record {
   post: string
   /** List of AT-URIs embedding this post that the author has detached from. */
   detachedEmbeddingUris?: string[]
+  /** List of rules defining who can embed this post. If value is an empty array or is undefined, no particular rules apply and anyone can embed. */
   embeddingRules?: (DisableRule | { $type: string; [k: string]: unknown })[]
   [k: string]: unknown
 }

packages/api/src/client/types/app/bsky/feed/threadgate.ts

@@ -9,6 +9,7 @@ import { CID } from 'multiformats/cid'
 export interface Record {
   /** Reference (AT-URI) to the post record. */
   post: string
+  /** List of rules defining who can reply to this post. If value is an empty array, no one can reply. If value is undefined, anyone can reply. */
   allow?: (
     | MentionRule
     | FollowingRule

packages/api/src/types.ts

@@ -109,4 +109,5 @@ export interface BskyPreferences {
     activeProgressGuide: AppBskyActorDefs.BskyAppProgressGuide | undefined
     nuxs: AppBskyActorDefs.Nux[]
   }
+  postInteractionSettings: AppBskyActorDefs.PostInteractionSettingsPref
 }