@atproto/api 0.19.10 → 0.19.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/api",
-  "version": "0.19.10",
+  "version": "0.19.11",
   "license": "MIT",
   "description": "Client library for atproto and Bluesky",
   "keywords": [
@@ -22,9 +22,9 @@
     "tlds": "^1.234.0",
     "zod": "^3.23.8",
     "@atproto/common-web": "^0.4.21",
-    "@atproto/lexicon": "^0.6.2",
     "@atproto/syntax": "^0.5.4",
-    "@atproto/xrpc": "^0.7.7"
+    "@atproto/xrpc": "^0.7.7",
+    "@atproto/lexicon": "^0.6.2"
   },
   "devDependencies": {
     "@jest/globals": "^28.1.3",

package/src/client/lexicons.ts

@@ -9739,6 +9739,7 @@ export const schemaDict = {
             refs: [
               'lex:chat.bsky.actor.defs#directConvoMember',
               'lex:chat.bsky.actor.defs#groupConvoMember',
+              'lex:chat.bsky.actor.defs#pastGroupConvoMember',
             ],
           },
         },
@@ -9751,7 +9752,7 @@ export const schemaDict = {
       },
       groupConvoMember: {
         description:
-          '[NOTE: This is under active development and should be considered unstable while this note is here].',
+          '[NOTE: This is under active development and should be considered unstable while this note is here]. A current group convo member.',
         type: 'object',
         required: ['role'],
         properties: {
@@ -9769,6 +9770,13 @@ export const schemaDict = {
           },
         },
       },
+      pastGroupConvoMember: {
+        description:
+          '[NOTE: This is under active development and should be considered unstable while this note is here]. A past group convo member.',
+        type: 'object',
+        required: [],
+        properties: {},
+      },
     },
   },
   ChatBskyActorDeleteAccount: {
@@ -10012,6 +10020,16 @@ export const schemaDict = {
           },
         },
       },
+      systemMessageReferredUser: {
+        type: 'object',
+        required: ['did'],
+        properties: {
+          did: {
+            type: 'string',
+            format: 'did',
+          },
+        },
+      },
       systemMessageView: {
         description:
           '[NOTE: This is under active development and should be considered unstable while this note is here].',
@@ -10056,7 +10074,7 @@ export const schemaDict = {
           member: {
             description: 'Current view of the member who was added.',
             type: 'ref',
-            ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            ref: 'lex:chat.bsky.convo.defs#systemMessageReferredUser',
           },
           role: {
             description:
@@ -10066,7 +10084,7 @@ export const schemaDict = {
           },
           addedBy: {
             type: 'ref',
-            ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            ref: 'lex:chat.bsky.convo.defs#systemMessageReferredUser',
           },
         },
       },
@@ -10079,11 +10097,11 @@ export const schemaDict = {
           member: {
             description: 'Current view of the member who was removed.',
             type: 'ref',
-            ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            ref: 'lex:chat.bsky.convo.defs#systemMessageReferredUser',
           },
           removedBy: {
             type: 'ref',
-            ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            ref: 'lex:chat.bsky.convo.defs#systemMessageReferredUser',
           },
         },
       },
@@ -10096,7 +10114,7 @@ export const schemaDict = {
           member: {
             description: 'Current view of the member who joined.',
             type: 'ref',
-            ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            ref: 'lex:chat.bsky.convo.defs#systemMessageReferredUser',
           },
           role: {
             description:
@@ -10108,7 +10126,7 @@ export const schemaDict = {
             description:
               'If join link was configured to require approval, this will be set to who approved the request. Undefined if approval was not required.',
             type: 'ref',
-            ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            ref: 'lex:chat.bsky.convo.defs#systemMessageReferredUser',
           },
         },
       },
@@ -10121,7 +10139,7 @@ export const schemaDict = {
           member: {
             description: 'Current view of the member who left the group.',
             type: 'ref',
-            ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            ref: 'lex:chat.bsky.convo.defs#systemMessageReferredUser',
           },
         },
       },
@@ -10134,7 +10152,7 @@ export const schemaDict = {
           lockedBy: {
             description: 'Current view of the member who locked the group.',
             type: 'ref',
-            ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            ref: 'lex:chat.bsky.convo.defs#systemMessageReferredUser',
           },
         },
       },
@@ -10147,7 +10165,7 @@ export const schemaDict = {
           unlockedBy: {
             description: 'Current view of the member who unlocked the group.',
             type: 'ref',
-            ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            ref: 'lex:chat.bsky.convo.defs#systemMessageReferredUser',
           },
         },
       },
@@ -10160,7 +10178,7 @@ export const schemaDict = {
           lockedBy: {
             description: 'Current view of the member who locked the group.',
             type: 'ref',
-            ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            ref: 'lex:chat.bsky.convo.defs#systemMessageReferredUser',
           },
         },
       },
@@ -10570,7 +10588,7 @@ export const schemaDict = {
         description:
           '[NOTE: This is under active development and should be considered unstable while this note is here]. Event indicating a member was added to a group convo. The member who was added gets a logBeginConvo (to create the convo) but also a logAddMember (to show the system message as the first message the user sees).',
         type: 'object',
-        required: ['rev', 'convoId', 'message'],
+        required: ['rev', 'convoId', 'message', 'relatedProfiles'],
         properties: {
           rev: {
             type: 'string',
@@ -10584,13 +10602,21 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:chat.bsky.convo.defs#systemMessageView',
           },
+          relatedProfiles: {
+            description: 'Profiles referred in the system message.',
+            type: 'array',
+            items: {
+              type: 'ref',
+              ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            },
+          },
         },
       },
       logRemoveMember: {
         description:
           "[NOTE: This is under active development and should be considered unstable while this note is here]. Event indicating a member was removed from a group convo. The member who was removed gets a logLeaveConvo (to leave the convo) but not a logRemoveMember (because they already left, so can't see the system message).",
         type: 'object',
-        required: ['rev', 'convoId', 'message'],
+        required: ['rev', 'convoId', 'message', 'relatedProfiles'],
         properties: {
           rev: {
             type: 'string',
@@ -10604,13 +10630,21 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:chat.bsky.convo.defs#systemMessageView',
           },
+          relatedProfiles: {
+            description: 'Profiles referred in the system message.',
+            type: 'array',
+            items: {
+              type: 'ref',
+              ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            },
+          },
         },
       },
       logMemberJoin: {
         description:
           '[NOTE: This is under active development and should be considered unstable while this note is here]. Event indicating a member joined a group convo via join link. The member who was added gets a logBeginConvo (to create the convo) but also a logMemberJoin (to show the system message as the first message the user sees).',
         type: 'object',
-        required: ['rev', 'convoId', 'message'],
+        required: ['rev', 'convoId', 'message', 'relatedProfiles'],
         properties: {
           rev: {
             type: 'string',
@@ -10624,13 +10658,21 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:chat.bsky.convo.defs#systemMessageView',
           },
+          relatedProfiles: {
+            description: 'Profiles referred in the system message.',
+            type: 'array',
+            items: {
+              type: 'ref',
+              ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            },
+          },
         },
       },
       logMemberLeave: {
         description:
           "[NOTE: This is under active development and should be considered unstable while this note is here]. Event indicating a member voluntarily left a group convo. The member who was removed gets a logLeaveConvo (to leave the convo) but not a logMemberLeave (because they already left, so can't see the system message).",
         type: 'object',
-        required: ['rev', 'convoId', 'message'],
+        required: ['rev', 'convoId', 'message', 'relatedProfiles'],
         properties: {
           rev: {
             type: 'string',
@@ -10644,13 +10686,21 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:chat.bsky.convo.defs#systemMessageView',
           },
+          relatedProfiles: {
+            description: 'Profiles referred in the system message.',
+            type: 'array',
+            items: {
+              type: 'ref',
+              ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            },
+          },
         },
       },
       logLockConvo: {
         description:
           '[NOTE: This is under active development and should be considered unstable while this note is here]. Event indicating a group convo was locked.',
         type: 'object',
-        required: ['rev', 'convoId', 'message'],
+        required: ['rev', 'convoId', 'message', 'relatedProfiles'],
         properties: {
           rev: {
             type: 'string',
@@ -10664,13 +10714,21 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:chat.bsky.convo.defs#systemMessageView',
           },
+          relatedProfiles: {
+            description: 'Profiles referred in the system message.',
+            type: 'array',
+            items: {
+              type: 'ref',
+              ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            },
+          },
         },
       },
       logUnlockConvo: {
         description:
           '[NOTE: This is under active development and should be considered unstable while this note is here]. Event indicating a group convo was unlocked.',
         type: 'object',
-        required: ['rev', 'convoId', 'message'],
+        required: ['rev', 'convoId', 'message', 'relatedProfiles'],
         properties: {
           rev: {
             type: 'string',
@@ -10684,13 +10742,21 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:chat.bsky.convo.defs#systemMessageView',
           },
+          relatedProfiles: {
+            description: 'Profiles referred in the system message.',
+            type: 'array',
+            items: {
+              type: 'ref',
+              ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            },
+          },
         },
       },
       logLockConvoPermanently: {
         description:
           '[NOTE: This is under active development and should be considered unstable while this note is here]. Event indicating a group convo was locked permanently.',
         type: 'object',
-        required: ['rev', 'convoId', 'message'],
+        required: ['rev', 'convoId', 'message', 'relatedProfiles'],
         properties: {
           rev: {
             type: 'string',
@@ -10704,6 +10770,14 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:chat.bsky.convo.defs#systemMessageView',
           },
+          relatedProfiles: {
+            description: 'Profiles referred in the system message.',
+            type: 'array',
+            items: {
+              type: 'ref',
+              ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+            },
+          },
         },
       },
       logEditGroup: {
@@ -11224,6 +11298,15 @@ export const schemaDict = {
                   ],
                 },
               },
+              relatedProfiles: {
+                description:
+                  'Set of all members who authored or reacted to the returned messages. Members referred to by system messages are also included.',
+                type: 'array',
+                items: {
+                  type: 'ref',
+                  ref: 'lex:chat.bsky.actor.defs#profileViewBasic',
+                },
+              },
             },
           },
         },

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

@@ -34,6 +34,7 @@ export interface ProfileViewBasic {
   kind?:
     | $Typed<DirectConvoMember>
     | $Typed<GroupConvoMember>
+    | $Typed<PastGroupConvoMember>
     | { $type: string }
 }
 
@@ -62,7 +63,7 @@ export function validateDirectConvoMember<V>(v: V) {
   return validate<DirectConvoMember & V>(v, id, hashDirectConvoMember)
 }
 
-/** [NOTE: This is under active development and should be considered unstable while this note is here]. */
+/** [NOTE: This is under active development and should be considered unstable while this note is here]. A current group convo member. */
 export interface GroupConvoMember {
   $type?: 'chat.bsky.actor.defs#groupConvoMember'
   addedBy?: ProfileViewBasic
@@ -78,3 +79,18 @@ export function isGroupConvoMember<V>(v: V) {
 export function validateGroupConvoMember<V>(v: V) {
   return validate<GroupConvoMember & V>(v, id, hashGroupConvoMember)
 }
+
+/** [NOTE: This is under active development and should be considered unstable while this note is here]. A past group convo member. */
+export interface PastGroupConvoMember {
+  $type?: 'chat.bsky.actor.defs#pastGroupConvoMember'
+}
+
+const hashPastGroupConvoMember = 'pastGroupConvoMember'
+
+export function isPastGroupConvoMember<V>(v: V) {
+  return is$typed(v, id, hashPastGroupConvoMember)
+}
+
+export function validatePastGroupConvoMember<V>(v: V) {
+  return validate<PastGroupConvoMember & V>(v, id, hashPastGroupConvoMember)
+}

package/src/client/types/chat/bsky/convo/defs.ts

@@ -85,6 +85,25 @@ export function validateMessageView<V>(v: V) {
   return validate<MessageView & V>(v, id, hashMessageView)
 }
 
+export interface SystemMessageReferredUser {
+  $type?: 'chat.bsky.convo.defs#systemMessageReferredUser'
+  did: string
+}
+
+const hashSystemMessageReferredUser = 'systemMessageReferredUser'
+
+export function isSystemMessageReferredUser<V>(v: V) {
+  return is$typed(v, id, hashSystemMessageReferredUser)
+}
+
+export function validateSystemMessageReferredUser<V>(v: V) {
+  return validate<SystemMessageReferredUser & V>(
+    v,
+    id,
+    hashSystemMessageReferredUser,
+  )
+}
+
 /** [NOTE: This is under active development and should be considered unstable while this note is here]. */
 export interface SystemMessageView {
   $type?: 'chat.bsky.convo.defs#systemMessageView'
@@ -120,9 +139,9 @@ export function validateSystemMessageView<V>(v: V) {
 /** [NOTE: This is under active development and should be considered unstable while this note is here]. System message indicating a user was added to the group convo. */
 export interface SystemMessageDataAddMember {
   $type?: 'chat.bsky.convo.defs#systemMessageDataAddMember'
-  member: ChatBskyActorDefs.ProfileViewBasic
+  member: SystemMessageReferredUser
   role: ChatBskyActorDefs.MemberRole
-  addedBy: ChatBskyActorDefs.ProfileViewBasic
+  addedBy: SystemMessageReferredUser
 }
 
 const hashSystemMessageDataAddMember = 'systemMessageDataAddMember'
@@ -142,8 +161,8 @@ export function validateSystemMessageDataAddMember<V>(v: V) {
 /** [NOTE: This is under active development and should be considered unstable while this note is here]. System message indicating a user was removed from the group convo. */
 export interface SystemMessageDataRemoveMember {
   $type?: 'chat.bsky.convo.defs#systemMessageDataRemoveMember'
-  member: ChatBskyActorDefs.ProfileViewBasic
-  removedBy: ChatBskyActorDefs.ProfileViewBasic
+  member: SystemMessageReferredUser
+  removedBy: SystemMessageReferredUser
 }
 
 const hashSystemMessageDataRemoveMember = 'systemMessageDataRemoveMember'
@@ -163,9 +182,9 @@ export function validateSystemMessageDataRemoveMember<V>(v: V) {
 /** [NOTE: This is under active development and should be considered unstable while this note is here]. System message indicating a user joined the group convo via join link. */
 export interface SystemMessageDataMemberJoin {
   $type?: 'chat.bsky.convo.defs#systemMessageDataMemberJoin'
-  member: ChatBskyActorDefs.ProfileViewBasic
+  member: SystemMessageReferredUser
   role: ChatBskyActorDefs.MemberRole
-  approvedBy?: ChatBskyActorDefs.ProfileViewBasic
+  approvedBy?: SystemMessageReferredUser
 }
 
 const hashSystemMessageDataMemberJoin = 'systemMessageDataMemberJoin'
@@ -185,7 +204,7 @@ export function validateSystemMessageDataMemberJoin<V>(v: V) {
 /** [NOTE: This is under active development and should be considered unstable while this note is here]. System message indicating a user voluntarily left the group convo. */
 export interface SystemMessageDataMemberLeave {
   $type?: 'chat.bsky.convo.defs#systemMessageDataMemberLeave'
-  member: ChatBskyActorDefs.ProfileViewBasic
+  member: SystemMessageReferredUser
 }
 
 const hashSystemMessageDataMemberLeave = 'systemMessageDataMemberLeave'
@@ -205,7 +224,7 @@ export function validateSystemMessageDataMemberLeave<V>(v: V) {
 /** [NOTE: This is under active development and should be considered unstable while this note is here]. System message indicating the group convo was locked. */
 export interface SystemMessageDataLockConvo {
   $type?: 'chat.bsky.convo.defs#systemMessageDataLockConvo'
-  lockedBy: ChatBskyActorDefs.ProfileViewBasic
+  lockedBy: SystemMessageReferredUser
 }
 
 const hashSystemMessageDataLockConvo = 'systemMessageDataLockConvo'
@@ -225,7 +244,7 @@ export function validateSystemMessageDataLockConvo<V>(v: V) {
 /** [NOTE: This is under active development and should be considered unstable while this note is here]. System message indicating the group convo was unlocked. */
 export interface SystemMessageDataUnlockConvo {
   $type?: 'chat.bsky.convo.defs#systemMessageDataUnlockConvo'
-  unlockedBy: ChatBskyActorDefs.ProfileViewBasic
+  unlockedBy: SystemMessageReferredUser
 }
 
 const hashSystemMessageDataUnlockConvo = 'systemMessageDataUnlockConvo'
@@ -245,7 +264,7 @@ export function validateSystemMessageDataUnlockConvo<V>(v: V) {
 /** [NOTE: This is under active development and should be considered unstable while this note is here]. System message indicating the group convo was locked permanently. */
 export interface SystemMessageDataLockConvoPermanently {
   $type?: 'chat.bsky.convo.defs#systemMessageDataLockConvoPermanently'
-  lockedBy: ChatBskyActorDefs.ProfileViewBasic
+  lockedBy: SystemMessageReferredUser
 }
 
 const hashSystemMessageDataLockConvoPermanently =
@@ -716,6 +735,8 @@ export interface LogAddMember {
   rev: string
   convoId: string
   message: SystemMessageView
+  /** Profiles referred in the system message. */
+  relatedProfiles: ChatBskyActorDefs.ProfileViewBasic[]
 }
 
 const hashLogAddMember = 'logAddMember'
@@ -734,6 +755,8 @@ export interface LogRemoveMember {
   rev: string
   convoId: string
   message: SystemMessageView
+  /** Profiles referred in the system message. */
+  relatedProfiles: ChatBskyActorDefs.ProfileViewBasic[]
 }
 
 const hashLogRemoveMember = 'logRemoveMember'
@@ -752,6 +775,8 @@ export interface LogMemberJoin {
   rev: string
   convoId: string
   message: SystemMessageView
+  /** Profiles referred in the system message. */
+  relatedProfiles: ChatBskyActorDefs.ProfileViewBasic[]
 }
 
 const hashLogMemberJoin = 'logMemberJoin'
@@ -770,6 +795,8 @@ export interface LogMemberLeave {
   rev: string
   convoId: string
   message: SystemMessageView
+  /** Profiles referred in the system message. */
+  relatedProfiles: ChatBskyActorDefs.ProfileViewBasic[]
 }
 
 const hashLogMemberLeave = 'logMemberLeave'
@@ -788,6 +815,8 @@ export interface LogLockConvo {
   rev: string
   convoId: string
   message: SystemMessageView
+  /** Profiles referred in the system message. */
+  relatedProfiles: ChatBskyActorDefs.ProfileViewBasic[]
 }
 
 const hashLogLockConvo = 'logLockConvo'
@@ -806,6 +835,8 @@ export interface LogUnlockConvo {
   rev: string
   convoId: string
   message: SystemMessageView
+  /** Profiles referred in the system message. */
+  relatedProfiles: ChatBskyActorDefs.ProfileViewBasic[]
 }
 
 const hashLogUnlockConvo = 'logUnlockConvo'
@@ -824,6 +855,8 @@ export interface LogLockConvoPermanently {
   rev: string
   convoId: string
   message: SystemMessageView
+  /** Profiles referred in the system message. */
+  relatedProfiles: ChatBskyActorDefs.ProfileViewBasic[]
 }
 
 const hashLogLockConvoPermanently = 'logLockConvoPermanently'

package/src/client/types/chat/bsky/convo/getMessages.ts

@@ -11,6 +11,7 @@ import {
   type OmitKey,
 } from '../../../../util'
 import type * as ChatBskyConvoDefs from './defs.js'
+import type * as ChatBskyActorDefs from '../actor/defs.js'
 
 const is$typed = _is$typed,
   validate = _validate
@@ -31,6 +32,8 @@ export interface OutputSchema {
     | $Typed<ChatBskyConvoDefs.SystemMessageView>
     | { $type: string }
   )[]
+  /** Set of all members who authored or reacted to the returned messages. Members referred to by system messages are also included. */
+  relatedProfiles?: ChatBskyActorDefs.ProfileViewBasic[]
 }
 
 export interface CallOptions {