@atproto/api 0.13.32 → 0.13.33

package/src/rich-text/detection.ts

@@ -2,10 +2,10 @@ import TLDs from 'tlds'
 import { AppBskyRichtextFacet } from '../client'
 import { UnicodeString } from './unicode'
 import {
-  URL_REGEX,
   MENTION_REGEX,
   TAG_REGEX,
   TRAILING_PUNCTUATION_REGEX,
+  URL_REGEX,
 } from './util'
 
 export type Facet = AppBskyRichtextFacet.Main

package/src/rich-text/rich-text.ts

@@ -92,9 +92,9 @@ F: 0 1 2 3 4 5 6 7 8 910   // string indices
  */
 
 import { AppBskyFeedPost, AppBskyRichtextFacet, AtpBaseClient } from '../client'
-import { UnicodeString } from './unicode'
-import { sanitizeRichText } from './sanitization'
 import { detectFacets } from './detection'
+import { sanitizeRichText } from './sanitization'
+import { UnicodeString } from './unicode'
 
 export type Facet = AppBskyRichtextFacet.Main
 export type FacetLink = AppBskyRichtextFacet.Link

package/src/types.ts

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

package/src/util.ts

@@ -1,9 +1,8 @@
-import { AtUri } from '@atproto/syntax'
+import { z } from 'zod'
 import { TID } from '@atproto/common-web'
-import zod from 'zod'
-
-import { Nux } from './client/types/app/bsky/actor/defs'
+import { AtUri } from '@atproto/syntax'
 import { AppBskyActorDefs } from './client'
+import { Nux } from './client/types/app/bsky/actor/defs'
 
 export function sanitizeMutedWordValue(value: string) {
   return (
@@ -97,12 +96,12 @@ export const asDid = (value: string): Did => {
   throw new TypeError(`Invalid DID: ${value}`)
 }
 
-export const nuxSchema = zod
+export const nuxSchema = z
   .object({
-    id: zod.string().max(64),
-    completed: zod.boolean(),
-    data: zod.string().max(300).optional(),
-    expiresAt: zod.string().datetime().optional(),
+    id: z.string().max(64),
+    completed: z.boolean(),
+    data: z.string().max(300).optional(),
+    expiresAt: z.string().datetime().optional(),
   })
   .strict()
 

package/tests/atp-agent.test.ts

@@ -1,5 +1,5 @@
-import { TestNetworkNoAppView } from '@atproto/dev-env'
 import { TID } from '@atproto/common-web'
+import { TestNetworkNoAppView } from '@atproto/dev-env'
 import {
   AppBskyActorDefs,
   AppBskyActorProfile,
@@ -278,6 +278,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setAdultContentEnabled(true)
@@ -320,6 +324,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setAdultContentEnabled(false)
@@ -362,6 +370,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setContentLabelPref('misinfo', 'hide')
@@ -404,6 +416,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setContentLabelPref('spam', 'ignore')
@@ -450,6 +466,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.addSavedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -499,6 +519,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -548,6 +572,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.removePinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -597,6 +625,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.removeSavedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -646,6 +678,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -695,6 +731,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake2')
@@ -750,6 +790,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.removeSavedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -799,6 +843,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setPersonalDetails({ birthDate: '2023-09-11T18:05:42.556Z' })
@@ -848,6 +896,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setFeedViewPrefs('home', { hideReplies: true })
@@ -897,6 +949,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setFeedViewPrefs('home', { hideReplies: false })
@@ -946,6 +1002,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setFeedViewPrefs('other', { hideReplies: true })
@@ -1002,6 +1062,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setThreadViewPrefs({ sort: 'random' })
@@ -1058,6 +1122,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setThreadViewPrefs({ sort: 'oldest' })
@@ -1114,6 +1182,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setInterestsPref({ tags: ['foo', 'bar'] })
@@ -1170,6 +1242,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
     })
 
@@ -1353,6 +1429,10 @@ describe('agent', () => {
           queuedNudges: ['two'],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setAdultContentEnabled(false)
@@ -1411,6 +1491,10 @@ describe('agent', () => {
           queuedNudges: ['two'],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setContentLabelPref('porn', 'ignore')
@@ -1470,6 +1554,10 @@ describe('agent', () => {
           queuedNudges: ['two'],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.removeLabeler('did:plc:other')
@@ -1525,6 +1613,10 @@ describe('agent', () => {
           queuedNudges: ['two'],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -1580,6 +1672,10 @@ describe('agent', () => {
           queuedNudges: ['two'],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setPersonalDetails({ birthDate: '2023-09-11T18:05:42.556Z' })
@@ -1635,6 +1731,10 @@ describe('agent', () => {
           queuedNudges: ['two'],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setFeedViewPrefs('home', {
@@ -1702,6 +1802,10 @@ describe('agent', () => {
           queuedNudges: ['two', 'three'],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       const res = await agent.app.bsky.actor.getPreferences()
@@ -3337,6 +3441,80 @@ describe('agent', () => {
       })
     })
 
+    describe('setPostInteractionSettings', () => {
+      let agent: AtpAgent
+
+      beforeAll(async () => {
+        agent = new AtpAgent({ service: network.pds.url })
+
+        await agent.createAccount({
+          handle: 'pints.test',
+          email: 'pints@test.com',
+          password: 'password',
+        })
+      })
+
+      it('works', async () => {
+        const next: AppBskyActorDefs.PostInteractionSettingsPref = {
+          threadgateAllowRules: [
+            { $type: 'app.bsky.feed.threadgate#mentionRule' },
+          ],
+          postgateEmbeddingRules: [],
+        }
+
+        await agent.setPostInteractionSettings(next)
+
+        const prefs = await agent.getPreferences()
+
+        expect(prefs.postInteractionSettings).toEqual(next)
+      })
+
+      it('clears', async () => {
+        const next: AppBskyActorDefs.PostInteractionSettingsPref = {
+          threadgateAllowRules: [],
+          postgateEmbeddingRules: [],
+        }
+
+        await agent.setPostInteractionSettings(next)
+
+        const prefs = await agent.getPreferences()
+
+        expect(prefs.postInteractionSettings).toEqual(next)
+      })
+
+      /**
+       * Logic matches threadgate `allow` logic, where `undefined` means "anyone
+       * can reply" and an empty array means "no one can reply".
+       *
+       * Postgate `embeddingRules` behaves differently, where `undefined` and
+       * an empty array both mean "no particular rules applied".
+       *
+       * Both props are optional though, so for easier sharing of types, we
+       * allow `undefined`.
+       */
+      it('clears using undefined', async () => {
+        const next: AppBskyActorDefs.PostInteractionSettingsPref = {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        }
+
+        await agent.setPostInteractionSettings(next)
+
+        const prefs = await agent.getPreferences()
+
+        expect(prefs.postInteractionSettings).toEqual(next)
+      })
+
+      it('validates inputs', async () => {
+        expect(() =>
+          agent.setPostInteractionSettings({
+            threadgateAllowRules: [{ key: 'string' }],
+            postgateEmbeddingRules: [],
+          }),
+        ).rejects.toThrow()
+      })
+    })
+
     // end
   })
 })

package/tests/dispatcher.test.ts

@@ -1,13 +1,13 @@
+import assert from 'node:assert'
 import { AddressInfo } from 'node:net'
-import assert from 'assert'
+import { getPdsEndpoint, isValidDidDoc } from '@atproto/common-web'
+import { TestNetworkNoAppView } from '@atproto/dev-env'
 import {
   AtpAgent,
-  AtpSessionEvent,
   AtpSessionData,
+  AtpSessionEvent,
   BSKY_LABELER_DID,
 } from '../src'
-import { TestNetworkNoAppView } from '@atproto/dev-env'
-import { getPdsEndpoint, isValidDidDoc } from '@atproto/common-web'
 import { createHeaderEchoServer } from './util/echo-server'
 
 const getPdsEndpointUrl = (...args: Parameters<typeof getPdsEndpoint>) => {

package/tests/errors.test.ts

@@ -1,5 +1,5 @@
-import { AtpAgent, ComAtprotoServerCreateAccount } from '..'
 import { TestNetworkNoAppView } from '@atproto/dev-env'
+import { AtpAgent, ComAtprotoServerCreateAccount } from '..'
 
 describe('errors', () => {
   let network: TestNetworkNoAppView

package/tests/moderation-behaviors.test.ts

@@ -1,10 +1,10 @@
-import { moderateProfile, moderatePost } from '../src'
+import { moderatePost, moderateProfile } from '../src'
 import {
   ModerationBehaviorSuiteRunner,
-  SuiteUsers,
+  ModerationTestSuiteScenario,
   SuiteConfigurations,
   SuiteScenarios,
-  ModerationTestSuiteScenario,
+  SuiteUsers,
 } from './util/moderation-behavior'
 
 const USERS: SuiteUsers = {

package/tests/moderation-custom-labels.test.ts

@@ -1,10 +1,10 @@
 import {
-  moderateProfile,
-  moderatePost,
-  mock,
-  ModerationOpts,
   InterpretedLabelValueDefinition,
+  ModerationOpts,
   interpretLabelValueDefinition,
+  mock,
+  moderatePost,
+  moderateProfile,
 } from '../src'
 import './util/moderation-behavior'
 

package/tests/moderation-mutewords.test.ts

@@ -1,5 +1,4 @@
 import { RichText, mock, moderatePost } from '../src/'
-
 import { hasMutedWord } from '../src/moderation/mutewords'
 
 describe(`hasMutedWord`, () => {

package/tests/moderation-prefs.test.ts

@@ -86,6 +86,10 @@ describe('agent', () => {
         queuedNudges: [],
         nuxs: [],
       },
+      postInteractionSettings: {
+        threadgateAllowRules: undefined,
+        postgateEmbeddingRules: undefined,
+      },
     })
   })
 
@@ -136,6 +140,10 @@ describe('agent', () => {
         queuedNudges: [],
         nuxs: [],
       },
+      postInteractionSettings: {
+        threadgateAllowRules: undefined,
+        postgateEmbeddingRules: undefined,
+      },
     })
     expect(agent.labelers).toStrictEqual(['did:plc:other'])
 
@@ -171,6 +179,10 @@ describe('agent', () => {
         queuedNudges: [],
         nuxs: [],
       },
+      postInteractionSettings: {
+        threadgateAllowRules: undefined,
+        postgateEmbeddingRules: undefined,
+      },
     })
     expect(agent.labelers).toStrictEqual([])
   })
@@ -228,6 +240,10 @@ describe('agent', () => {
         queuedNudges: [],
         nuxs: [],
       },
+      postInteractionSettings: {
+        threadgateAllowRules: undefined,
+        postgateEmbeddingRules: undefined,
+      },
     })
   })
 

package/tests/moderation-quoteposts.test.ts

@@ -1,9 +1,9 @@
 import {
-  moderatePost,
-  mock,
-  ModerationOpts,
   InterpretedLabelValueDefinition,
+  ModerationOpts,
   interpretLabelValueDefinition,
+  mock,
+  moderatePost,
 } from '../src'
 import './util/moderation-behavior'
 

package/tests/moderation.test.ts

@@ -1,11 +1,11 @@
+import { ModerationOpts } from '../dist'
 import {
-  moderateProfile,
-  moderatePost,
-  mock,
   interpretLabelValueDefinition,
+  mock,
+  moderatePost,
+  moderateProfile,
 } from '../src'
 import './util/moderation-behavior'
-import { ModerationOpts } from '../dist'
 
 describe('Moderation', () => {
   it('Applies self-labels on profiles according to the global preferences', () => {

package/tests/rich-text-sanitization.test.ts

@@ -1,4 +1,4 @@
-import { RichText, sanitizeRichText, Facet, UnicodeString } from '../src'
+import { Facet, RichText, UnicodeString, sanitizeRichText } from '../src'
 
 describe('sanitizeRichText: cleanNewlines', () => {
   it('removes more than two consecutive new lines', () => {

package/tests/util/moderation-behavior.ts

@@ -1,8 +1,8 @@
 import {
-  ModerationUI,
-  ModerationOpts,
   ComAtprotoLabelDefs,
   LabelPreference,
+  ModerationOpts,
+  ModerationUI,
 } from '../../src'
 import { mock as m } from '../../src/mocker'
 

package/bench/agent.bench.ts

@@ -1,9 +0,0 @@
-import { BskyAgent } from '@atproto/api'
-
-describe('Agent Benchmarks', () => {
-  it('Creates new Agent instance 10 times', () => {
-    for (let i = 0; i < 10; i++) {
-      new BskyAgent({ service: 'https://bsky.social' })
-    }
-  })
-})