@atproto/api 0.20.0-next.0 → 0.20.1

package/dist/client/lexicons.js

@@ -2597,9 +2597,12 @@ export const schemaDict = {
                         accept: ['image/*'],
                         maxSize: 1000000,
                     },
-                    associatedRecord: {
-                        type: 'string',
-                        format: 'at-uri',
+                    associatedRecords: {
+                        type: 'array',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:com.atproto.repo.strongRef',
+                        },
                         description: 'The URI of the Atmosphere record representing this external content, if it exists. Example: a site.standard.document record.',
                     },
                 },
@@ -9950,7 +9953,7 @@ export const schemaDict = {
                         type: 'string',
                     },
                     members: {
-                        description: 'Members of this conversation. For direct convos, it will be an immutable list of the 2 members. For group convos, it will a list of important members (the first few members, the viewer, the member who invited the viewer, the member who sent the last message, the member who sent the last reaction), but will not contain the full list of members. Use chat.bsky.convo.getConvoMembers to list all members.',
+                        description: 'Members of this conversation. For direct convos, it will be an immutable list of the 2 members. For group convos, it will a list of important members (the first few members, the viewer, the member who added the viewer, the member who sent the last message, the member who sent the last reaction), but will not contain the full list of members. Use chat.bsky.convo.getConvoMembers to list all members.',
                         type: 'array',
                         items: {
                             type: 'ref',
@@ -11523,7 +11526,7 @@ export const schemaDict = {
                         name: 'BlockedActor',
                     },
                     {
-                        name: 'GroupInvitesDisabled',
+                        name: 'UserForbidsGroups',
                     },
                     {
                         name: 'ConvoLocked',
@@ -11652,7 +11655,7 @@ export const schemaDict = {
                         name: 'BlockedActor',
                     },
                     {
-                        name: 'GroupInvitesDisabled',
+                        name: 'UserForbidsGroups',
                     },
                     {
                         name: 'NotFollowedBySender',
@@ -12132,6 +12135,54 @@ export const schemaDict = {
             },
         },
     },
+    ChatBskyGroupListMutualGroups: {
+        lexicon: 1,
+        id: 'chat.bsky.group.listMutualGroups',
+        defs: {
+            main: {
+                type: 'query',
+                description: '[NOTE: This is under active development and should be considered unstable while this note is here]. Returns a page of group conversations that both the requester and the specified actor are members of.',
+                parameters: {
+                    type: 'params',
+                    required: ['subject'],
+                    properties: {
+                        subject: {
+                            type: 'string',
+                            format: 'did',
+                        },
+                        limit: {
+                            type: 'integer',
+                            minimum: 1,
+                            maximum: 100,
+                            default: 50,
+                        },
+                        cursor: {
+                            type: 'string',
+                        },
+                    },
+                },
+                output: {
+                    encoding: 'application/json',
+                    schema: {
+                        type: 'object',
+                        required: ['convos'],
+                        properties: {
+                            cursor: {
+                                type: 'string',
+                            },
+                            convos: {
+                                type: 'array',
+                                items: {
+                                    type: 'ref',
+                                    ref: 'lex:chat.bsky.convo.defs#convoView',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
     ChatBskyGroupRejectJoinRequest: {
         lexicon: 1,
         id: 'chat.bsky.group.rejectJoinRequest',
@@ -12368,10 +12419,19 @@ export const schemaDict = {
                         before: {
                             type: 'integer',
                             default: 5,
+                            description: 'Number of user messages before the target to include. System messages between the earliest returned user message and the target are also included, capped per gap by `maxInterleavedSystemMessages`. If there are no user messages before the target, up to `maxInterleavedSystemMessages` system messages immediately preceding the target are returned instead.',
                         },
                         after: {
                             type: 'integer',
                             default: 5,
+                            description: 'Number of user messages after the target to include. System messages between the target and the latest returned user message are also included, capped per gap by `maxInterleavedSystemMessages`. If there are no user messages after the target, up to `maxInterleavedSystemMessages` system messages immediately following the target are returned instead.',
+                        },
+                        maxInterleavedSystemMessages: {
+                            type: 'integer',
+                            default: 10,
+                            minimum: 0,
+                            maximum: 1000,
+                            description: 'Maximum number of system messages to include per gap between consecutive returned messages (and per side when there are no user messages on that side). Within a gap, the system messages closest to the earlier message are kept.',
                         },
                     },
                 },
@@ -12387,7 +12447,6 @@ export const schemaDict = {
                                     type: 'union',
                                     refs: [
                                         'lex:chat.bsky.convo.defs#messageView',
-                                        'lex:chat.bsky.convo.defs#deletedMessageView',
                                         'lex:chat.bsky.convo.defs#systemMessageView',
                                     ],
                                 },
@@ -12419,6 +12478,15 @@ export const schemaDict = {
                         type: 'union',
                         refs: [
                             'lex:chat.bsky.moderation.subscribeModEvents#eventConvoFirstMessage',
+                            'lex:chat.bsky.moderation.subscribeModEvents#eventGroupChatCreated',
+                            'lex:chat.bsky.moderation.subscribeModEvents#eventGroupChatMemberAdded',
+                            'lex:chat.bsky.moderation.subscribeModEvents#eventGroupChatMemberJoined',
+                            'lex:chat.bsky.moderation.subscribeModEvents#eventGroupChatJoinRequest',
+                            'lex:chat.bsky.moderation.subscribeModEvents#eventGroupChatJoinRequestApproved',
+                            'lex:chat.bsky.moderation.subscribeModEvents#eventGroupChatJoinRequestRejected',
+                            'lex:chat.bsky.moderation.subscribeModEvents#eventChatAccepted',
+                            'lex:chat.bsky.moderation.subscribeModEvents#eventGroupChatMemberLeft',
+                            'lex:chat.bsky.moderation.subscribeModEvents#eventGroupChatUpdated',
                         ],
                     },
                 },
@@ -12434,6 +12502,7 @@ export const schemaDict = {
             },
             eventConvoFirstMessage: {
                 type: 'object',
+                description: 'Fired when the first message was sent on a convo.',
                 required: ['createdAt', 'rev', 'convoId', 'user', 'recipients'],
                 properties: {
                     convoId: {
@@ -12464,6 +12533,560 @@ export const schemaDict = {
                     },
                 },
             },
+            eventGroupChatCreated: {
+                type: 'object',
+                description: 'Fire when a group chat is created.',
+                required: [
+                    'actorDid',
+                    'convoCreatedAt',
+                    'convoId',
+                    'createdAt',
+                    'groupMemberCount',
+                    'groupName',
+                    'initialMemberDids',
+                    'ownerDid',
+                    'rev',
+                ],
+                properties: {
+                    actorDid: {
+                        description: 'The DID of the actor performing the action. For this event, same as ownerDid.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    convoCreatedAt: {
+                        description: 'When the group was originally created.',
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    convoId: {
+                        type: 'string',
+                    },
+                    createdAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    groupMemberCount: {
+                        description: 'Current member count at the time of the event.',
+                        type: 'integer',
+                    },
+                    groupName: {
+                        description: 'The name set at creation time.',
+                        type: 'string',
+                    },
+                    initialMemberDids: {
+                        description: 'DIDs of everyone added at creation time.',
+                        type: 'array',
+                        items: {
+                            type: 'string',
+                            format: 'did',
+                        },
+                    },
+                    ownerDid: {
+                        description: 'The DID of the group chat owner.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    rev: {
+                        type: 'string',
+                    },
+                },
+            },
+            eventGroupChatMemberAdded: {
+                type: 'object',
+                description: "Fired when a member is added to a group chat. Note that members are added in the 'request' state.",
+                required: [
+                    'actorDid',
+                    'convoCreatedAt',
+                    'convoId',
+                    'createdAt',
+                    'groupMemberCount',
+                    'groupName',
+                    'ownerDid',
+                    'requestMembersCount',
+                    'rev',
+                    'subjectDid',
+                    'subjectFollowsOwner',
+                ],
+                properties: {
+                    actorDid: {
+                        description: 'The DID of the actor performing the action. For this event, same as ownerDid.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    convoCreatedAt: {
+                        description: 'When the group was originally created.',
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    convoId: {
+                        type: 'string',
+                    },
+                    createdAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    groupMemberCount: {
+                        description: 'Current member count at the time of the event.',
+                        type: 'integer',
+                    },
+                    groupName: {
+                        type: 'string',
+                    },
+                    ownerDid: {
+                        description: 'The DID of the group chat owner.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    requestMembersCount: {
+                        description: 'The number of members who have not yet accepted the convo.',
+                        type: 'integer',
+                    },
+                    rev: {
+                        type: 'string',
+                    },
+                    subjectDid: {
+                        description: 'The DID of the member who was added.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    subjectFollowsOwner: {
+                        description: 'Whether the added member follows the group owner.',
+                        type: 'boolean',
+                    },
+                },
+            },
+            eventGroupChatMemberJoined: {
+                type: 'object',
+                description: 'Fired when a member joins a group chat via an join link that does not require approval.',
+                required: [
+                    'actorDid',
+                    'convoCreatedAt',
+                    'convoId',
+                    'createdAt',
+                    'groupMemberCount',
+                    'groupName',
+                    'joinLinkCode',
+                    'ownerDid',
+                    'rev',
+                    'subjectFollowsOwner',
+                ],
+                properties: {
+                    actorDid: {
+                        description: 'The DID of the person joining.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    convoCreatedAt: {
+                        description: 'When the group was originally created.',
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    convoId: {
+                        type: 'string',
+                    },
+                    createdAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    groupMemberCount: {
+                        description: 'Current member count at the time of the event.',
+                        type: 'integer',
+                    },
+                    groupName: {
+                        type: 'string',
+                    },
+                    joinLinkCode: {
+                        description: 'The code of the join link used to join.',
+                        type: 'string',
+                    },
+                    ownerDid: {
+                        description: 'The DID of the group chat owner.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    rev: {
+                        type: 'string',
+                    },
+                    subjectFollowsOwner: {
+                        description: 'Whether the joining member follows the group owner.',
+                        type: 'boolean',
+                    },
+                },
+            },
+            eventGroupChatJoinRequest: {
+                type: 'object',
+                description: 'Fired when a user requests to join a group chat via an join link that requires approval.',
+                required: [
+                    'actorDid',
+                    'convoCreatedAt',
+                    'convoId',
+                    'createdAt',
+                    'groupMemberCount',
+                    'groupName',
+                    'joinLinkCode',
+                    'ownerDid',
+                    'rev',
+                    'subjectFollowsOwner',
+                ],
+                properties: {
+                    actorDid: {
+                        description: 'The DID of the person requesting to join.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    convoCreatedAt: {
+                        description: 'When the group was originally created.',
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    convoId: {
+                        type: 'string',
+                    },
+                    createdAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    groupMemberCount: {
+                        description: 'Current member count at the time of the event.',
+                        type: 'integer',
+                    },
+                    groupName: {
+                        type: 'string',
+                    },
+                    joinLinkCode: {
+                        description: 'The code of the join link used to request joining.',
+                        type: 'string',
+                    },
+                    ownerDid: {
+                        description: 'The DID of the group chat owner.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    rev: {
+                        type: 'string',
+                    },
+                    subjectFollowsOwner: {
+                        description: 'Whether the requesting member follows the group owner.',
+                        type: 'boolean',
+                    },
+                },
+            },
+            eventGroupChatJoinRequestApproved: {
+                type: 'object',
+                description: 'Fired when a join request is approved by the group owner.',
+                required: [
+                    'actorDid',
+                    'convoCreatedAt',
+                    'convoId',
+                    'createdAt',
+                    'groupMemberCount',
+                    'groupName',
+                    'ownerDid',
+                    'rev',
+                    'subjectDid',
+                ],
+                properties: {
+                    actorDid: {
+                        description: 'The DID of the owner approving the request.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    convoCreatedAt: {
+                        description: 'When the group was originally created.',
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    convoId: {
+                        type: 'string',
+                    },
+                    createdAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    groupMemberCount: {
+                        description: 'Current member count at the time of the event.',
+                        type: 'integer',
+                    },
+                    groupName: {
+                        type: 'string',
+                    },
+                    ownerDid: {
+                        description: 'The DID of the group chat owner.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    rev: {
+                        type: 'string',
+                    },
+                    subjectDid: {
+                        description: 'The DID of the member whose request was approved.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                },
+            },
+            eventGroupChatJoinRequestRejected: {
+                type: 'object',
+                description: 'Fired when a join request is rejected by the group owner.',
+                required: [
+                    'actorDid',
+                    'convoCreatedAt',
+                    'convoId',
+                    'createdAt',
+                    'groupMemberCount',
+                    'groupName',
+                    'ownerDid',
+                    'rev',
+                    'subjectDid',
+                ],
+                properties: {
+                    actorDid: {
+                        description: 'The DID of the owner rejecting the request.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    convoCreatedAt: {
+                        description: 'When the group was originally created.',
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    convoId: {
+                        type: 'string',
+                    },
+                    createdAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    groupMemberCount: {
+                        description: 'Current member count at the time of the event.',
+                        type: 'integer',
+                    },
+                    groupName: {
+                        type: 'string',
+                    },
+                    ownerDid: {
+                        description: 'The DID of the group chat owner.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    rev: {
+                        type: 'string',
+                    },
+                    subjectDid: {
+                        description: 'The DID of the member whose request was rejected.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                },
+            },
+            eventChatAccepted: {
+                type: 'object',
+                description: 'Fired when a user accepts a chat convo, either explicitly or by sending a message.',
+                required: [
+                    'actorDid',
+                    'convoCreatedAt',
+                    'convoId',
+                    'createdAt',
+                    'method',
+                    'rev',
+                ],
+                properties: {
+                    actorDid: {
+                        description: 'The DID of the person accepting the convo.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    convoCreatedAt: {
+                        description: 'When the convo was originally created.',
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    convoId: {
+                        type: 'string',
+                    },
+                    createdAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    groupMemberCount: {
+                        description: 'Current member count at the time of the event. Only present for group convos.',
+                        type: 'integer',
+                    },
+                    groupName: {
+                        description: 'The name of the group chat. Only present for group convos.',
+                        type: 'string',
+                    },
+                    method: {
+                        description: 'How the convo was accepted.',
+                        type: 'string',
+                        knownValues: ['explicit', 'message'],
+                    },
+                    ownerDid: {
+                        description: 'The DID of the group chat owner. Only present for group convos.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    rev: {
+                        type: 'string',
+                    },
+                },
+            },
+            eventGroupChatMemberLeft: {
+                type: 'object',
+                description: 'Fired when a member leaves or is removed from a group chat.',
+                required: [
+                    'actorDid',
+                    'convoCreatedAt',
+                    'convoId',
+                    'createdAt',
+                    'groupMemberCount',
+                    'groupName',
+                    'leaveMethod',
+                    'ownerDid',
+                    'rev',
+                    'subjectDid',
+                ],
+                properties: {
+                    actorDid: {
+                        description: 'The DID of the actor. For voluntary: the person leaving. For kicked: the owner.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    convoCreatedAt: {
+                        description: 'When the group was originally created.',
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    convoId: {
+                        type: 'string',
+                    },
+                    createdAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    groupMemberCount: {
+                        description: 'Current member count at the time of the event.',
+                        type: 'integer',
+                    },
+                    groupName: {
+                        type: 'string',
+                    },
+                    leaveMethod: {
+                        description: 'How the member left.',
+                        type: 'string',
+                        knownValues: ['voluntary', 'kicked'],
+                    },
+                    ownerDid: {
+                        description: 'The DID of the group chat owner.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    rev: {
+                        type: 'string',
+                    },
+                    subjectDid: {
+                        description: 'The DID of the member who left or was removed.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                },
+            },
+            eventGroupChatUpdated: {
+                type: 'object',
+                description: "Fired when a group chat's metadata or status changes.",
+                required: [
+                    'actorDid',
+                    'convoCreatedAt',
+                    'convoId',
+                    'createdAt',
+                    'groupMemberCount',
+                    'groupName',
+                    'ownerDid',
+                    'rev',
+                    'updateType',
+                ],
+                properties: {
+                    actorDid: {
+                        description: 'The DID of the actor performing the action (the owner).',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    convoCreatedAt: {
+                        description: 'When the group was originally created.',
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    convoId: {
+                        type: 'string',
+                    },
+                    createdAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    groupMemberCount: {
+                        description: 'Current member count at the time of the event.',
+                        type: 'integer',
+                    },
+                    groupName: {
+                        description: 'Current group name.',
+                        type: 'string',
+                    },
+                    joinLinkCode: {
+                        description: 'The code of the join link. Only present when updateType is join-link-related.',
+                        type: 'string',
+                    },
+                    joinLinkFollowersOnly: {
+                        description: 'Whether the join link is restricted to followers of the owner. Only present when updateType is join-link-related.',
+                        type: 'boolean',
+                    },
+                    joinLinkRequiresApproval: {
+                        description: 'Whether the join link requires owner approval to join. Only present when updateType is join-link-related.',
+                        type: 'boolean',
+                    },
+                    lockReason: {
+                        description: "Why the group was locked. Only present when updateType is 'locked'.",
+                        type: 'string',
+                        knownValues: [
+                            'owner_action',
+                            'owner_left',
+                            'owner_deactivated',
+                            'owner_deleted',
+                            'owner_suspended',
+                            'owner_taken_down',
+                            'label_applied',
+                        ],
+                    },
+                    newName: {
+                        description: "The new group name. Only present when updateType is 'name_changed'.",
+                        type: 'string',
+                    },
+                    oldName: {
+                        description: "The previous group name. Only present when updateType is 'name_changed'.",
+                        type: 'string',
+                    },
+                    ownerDid: {
+                        description: 'The DID of the group chat owner.',
+                        type: 'string',
+                        format: 'did',
+                    },
+                    rev: {
+                        type: 'string',
+                    },
+                    updateType: {
+                        description: 'What changed.',
+                        type: 'string',
+                        knownValues: [
+                            'name_changed',
+                            'locked',
+                            'locked_permanently',
+                            'unlocked',
+                            'join_link_created',
+                            'join_link_disabled',
+                            'join_link_settings_changed',
+                        ],
+                    },
+                },
+            },
         },
     },
     ChatBskyModerationUpdateActorAccess: {
@@ -24021,6 +24644,7 @@ export const ids = {
     ChatBskyGroupEnableJoinLink: 'chat.bsky.group.enableJoinLink',
     ChatBskyGroupGetJoinLinkPreview: 'chat.bsky.group.getJoinLinkPreview',
     ChatBskyGroupListJoinRequests: 'chat.bsky.group.listJoinRequests',
+    ChatBskyGroupListMutualGroups: 'chat.bsky.group.listMutualGroups',
     ChatBskyGroupRejectJoinRequest: 'chat.bsky.group.rejectJoinRequest',
     ChatBskyGroupRemoveMembers: 'chat.bsky.group.removeMembers',
     ChatBskyGroupRequestJoin: 'chat.bsky.group.requestJoin',