@atproto/api 0.14.0-next.6 → 0.14.0

package/src/client/types/tools/ozone/signature/defs.ts

@@ -4,14 +4,14 @@
 import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { CID } from 'multiformats/cid'
 import { validate as _validate } from '../../../../lexicons'
-import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import { $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
 
 const is$typed = _is$typed,
   validate = _validate
 const id = 'tools.ozone.signature.defs'
 
 export interface SigDetail {
-  $type?: $Type<'tools.ozone.signature.defs', 'sigDetail'>
+  $type?: 'tools.ozone.signature.defs#sigDetail'
   property: string
   value: string
 }

package/src/client/types/tools/ozone/signature/findCorrelation.ts

@@ -5,7 +5,7 @@ import { HeadersMap, XRPCError } from '@atproto/xrpc'
 import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { CID } from 'multiformats/cid'
 import { validate as _validate } from '../../../../lexicons'
-import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import { $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
 import type * as ToolsOzoneSignatureDefs from './defs.js'
 
 const is$typed = _is$typed,

package/src/client/types/tools/ozone/signature/findRelatedAccounts.ts

@@ -5,7 +5,7 @@ import { HeadersMap, XRPCError } from '@atproto/xrpc'
 import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { CID } from 'multiformats/cid'
 import { validate as _validate } from '../../../../lexicons'
-import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import { $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
 import type * as ComAtprotoAdminDefs from '../../../com/atproto/admin/defs.js'
 import type * as ToolsOzoneSignatureDefs from './defs.js'
 
@@ -42,7 +42,7 @@ export function toKnownErr(e: any) {
 }
 
 export interface RelatedAccount {
-  $type?: $Type<'tools.ozone.signature.findRelatedAccounts', 'relatedAccount'>
+  $type?: 'tools.ozone.signature.findRelatedAccounts#relatedAccount'
   account: ComAtprotoAdminDefs.AccountView
   similarities?: ToolsOzoneSignatureDefs.SigDetail[]
 }

package/src/client/types/tools/ozone/signature/searchAccounts.ts

@@ -5,7 +5,7 @@ import { HeadersMap, XRPCError } from '@atproto/xrpc'
 import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { CID } from 'multiformats/cid'
 import { validate as _validate } from '../../../../lexicons'
-import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import { $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
 import type * as ComAtprotoAdminDefs from '../../../com/atproto/admin/defs.js'
 
 const is$typed = _is$typed,

package/src/client/types/tools/ozone/team/addMember.ts

@@ -5,7 +5,7 @@ import { HeadersMap, XRPCError } from '@atproto/xrpc'
 import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { CID } from 'multiformats/cid'
 import { validate as _validate } from '../../../../lexicons'
-import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import { $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
 import type * as ToolsOzoneTeamDefs from './defs.js'
 
 const is$typed = _is$typed,

package/src/client/types/tools/ozone/team/defs.ts

@@ -4,7 +4,7 @@
 import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { CID } from 'multiformats/cid'
 import { validate as _validate } from '../../../../lexicons'
-import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import { $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
 import type * as AppBskyActorDefs from '../../../app/bsky/actor/defs.js'
 
 const is$typed = _is$typed,
@@ -12,7 +12,7 @@ const is$typed = _is$typed,
 const id = 'tools.ozone.team.defs'
 
 export interface Member {
-  $type?: $Type<'tools.ozone.team.defs', 'member'>
+  $type?: 'tools.ozone.team.defs#member'
   did: string
   disabled?: boolean
   profile?: AppBskyActorDefs.ProfileViewDetailed

package/src/client/types/tools/ozone/team/deleteMember.ts

@@ -5,7 +5,7 @@ import { HeadersMap, XRPCError } from '@atproto/xrpc'
 import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { CID } from 'multiformats/cid'
 import { validate as _validate } from '../../../../lexicons'
-import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import { $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
 
 const is$typed = _is$typed,
   validate = _validate

package/src/client/types/tools/ozone/team/listMembers.ts

@@ -5,7 +5,7 @@ import { HeadersMap, XRPCError } from '@atproto/xrpc'
 import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { CID } from 'multiformats/cid'
 import { validate as _validate } from '../../../../lexicons'
-import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import { $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
 import type * as ToolsOzoneTeamDefs from './defs.js'
 
 const is$typed = _is$typed,

package/src/client/types/tools/ozone/team/updateMember.ts

@@ -5,7 +5,7 @@ import { HeadersMap, XRPCError } from '@atproto/xrpc'
 import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { CID } from 'multiformats/cid'
 import { validate as _validate } from '../../../../lexicons'
-import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import { $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
 import type * as ToolsOzoneTeamDefs from './defs.js'
 
 const is$typed = _is$typed,

package/src/client/util.ts

@@ -19,7 +19,7 @@ function isObject<V>(v: V): v is V & object {
   return v != null && typeof v === 'object'
 }
 
-function compare$type<Id extends string, Hash extends string>(
+function is$type<Id extends string, Hash extends string>(
   $type: unknown,
   id: Id,
   hash: Hash,
@@ -53,7 +53,7 @@ export function is$typed<V, Id extends string, Hash extends string>(
   id: Id,
   hash: Hash,
 ): v is $TypedObject<V, Id, Hash> {
-  return isObject(v) && '$type' in v && compare$type(v.$type, id, hash)
+  return isObject(v) && '$type' in v && is$type(v.$type, id, hash)
 }
 
 export function maybe$typed<V, Id extends string, Hash extends string>(
@@ -63,9 +63,7 @@ export function maybe$typed<V, Id extends string, Hash extends string>(
 ): v is V & object & { $type?: $Type<Id, Hash> } {
   return (
     isObject(v) &&
-    ('$type' in v
-      ? v.$type === undefined || compare$type(v.$type, id, hash)
-      : true)
+    ('$type' in v ? v.$type === undefined || is$type(v.$type, id, hash) : true)
   )
 }
 

package/src/index.ts

@@ -15,7 +15,7 @@ export * from './const'
 export * from './util'
 export * from './client'
 export { schemas } from './client/lexicons'
-export type { $Type, $Typed, Un$Typed } from './client/util'
+export type { $Typed, Un$Typed } from './client/util'
 export { asPredicate } from './client/util'
 export * from './rich-text/rich-text'
 export * from './rich-text/sanitization'

package/src/predicate.ts

@@ -29,6 +29,9 @@ export const isValidMutedWordsPref = asPredicate(
 export const isValidPersonalDetailsPref = asPredicate(
   AppBskyActorDefs.validatePersonalDetailsPref,
 )
+export const isValidPostInteractionSettingsPref = asPredicate(
+  AppBskyActorDefs.validatePostInteractionSettingsPref,
+)
 export const isValidSavedFeedsPref = asPredicate(
   AppBskyActorDefs.validateSavedFeedsPref,
 )

package/src/types.ts

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

package/tests/atp-agent.test.ts

@@ -279,6 +279,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setAdultContentEnabled(true)
@@ -321,6 +325,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setAdultContentEnabled(false)
@@ -363,6 +371,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setContentLabelPref('misinfo', 'hide')
@@ -405,6 +417,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setContentLabelPref('spam', 'ignore')
@@ -451,6 +467,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.addSavedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -500,6 +520,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -549,6 +573,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.removePinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -598,6 +626,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.removeSavedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -647,6 +679,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -696,6 +732,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake2')
@@ -751,6 +791,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.removeSavedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -800,6 +844,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setPersonalDetails({ birthDate: '2023-09-11T18:05:42.556Z' })
@@ -849,6 +897,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setFeedViewPrefs('home', { hideReplies: true })
@@ -898,6 +950,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setFeedViewPrefs('home', { hideReplies: false })
@@ -947,6 +1003,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setFeedViewPrefs('other', { hideReplies: true })
@@ -1003,6 +1063,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setThreadViewPrefs({ sort: 'random' })
@@ -1059,6 +1123,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setThreadViewPrefs({ sort: 'oldest' })
@@ -1115,6 +1183,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setInterestsPref({ tags: ['foo', 'bar'] })
@@ -1171,6 +1243,10 @@ describe('agent', () => {
           queuedNudges: [],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
     })
 
@@ -1354,6 +1430,10 @@ describe('agent', () => {
           queuedNudges: ['two'],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setAdultContentEnabled(false)
@@ -1412,6 +1492,10 @@ describe('agent', () => {
           queuedNudges: ['two'],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setContentLabelPref('porn', 'ignore')
@@ -1471,6 +1555,10 @@ describe('agent', () => {
           queuedNudges: ['two'],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.removeLabeler('did:plc:other')
@@ -1526,6 +1614,10 @@ describe('agent', () => {
           queuedNudges: ['two'],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -1581,6 +1673,10 @@ describe('agent', () => {
           queuedNudges: ['two'],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setPersonalDetails({ birthDate: '2023-09-11T18:05:42.556Z' })
@@ -1636,6 +1732,10 @@ describe('agent', () => {
           queuedNudges: ['two'],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       await agent.setFeedViewPrefs('home', {
@@ -1703,6 +1803,10 @@ describe('agent', () => {
           queuedNudges: ['two', 'three'],
           nuxs: [],
         },
+        postInteractionSettings: {
+          threadgateAllowRules: undefined,
+          postgateEmbeddingRules: undefined,
+        },
       })
 
       const res = await agent.app.bsky.actor.getPreferences()
@@ -3325,6 +3429,81 @@ 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({
+            // @ts-expect-error we are testing invalid inputs
+            threadgateAllowRules: [{ key: 'string' }],
+            postgateEmbeddingRules: [],
+          }),
+        ).rejects.toThrow()
+      })
+    })
+
     // end
   })
 })

package/tests/moderation-prefs.test.ts

@@ -87,6 +87,10 @@ describe('agent', () => {
         queuedNudges: [],
         nuxs: [],
       },
+      postInteractionSettings: {
+        threadgateAllowRules: undefined,
+        postgateEmbeddingRules: undefined,
+      },
     })
   })
 
@@ -137,6 +141,10 @@ describe('agent', () => {
         queuedNudges: [],
         nuxs: [],
       },
+      postInteractionSettings: {
+        threadgateAllowRules: undefined,
+        postgateEmbeddingRules: undefined,
+      },
     })
     expect(agent.labelers).toStrictEqual(['did:plc:other'])
 
@@ -172,6 +180,10 @@ describe('agent', () => {
         queuedNudges: [],
         nuxs: [],
       },
+      postInteractionSettings: {
+        threadgateAllowRules: undefined,
+        postgateEmbeddingRules: undefined,
+      },
     })
     expect(agent.labelers).toStrictEqual([])
   })
@@ -229,6 +241,10 @@ describe('agent', () => {
         queuedNudges: [],
         nuxs: [],
       },
+      postInteractionSettings: {
+        threadgateAllowRules: undefined,
+        postgateEmbeddingRules: undefined,
+      },
     })
   })