@atproto/bsky 0.0.28 → 0.0.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (303) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/LICENSE.txt +1 -1
  3. package/dist/api/app/bsky/feed/getAuthorFeed.d.ts +1 -0
  4. package/dist/auto-moderator/index.d.ts +1 -14
  5. package/dist/context.d.ts +0 -3
  6. package/dist/db/index.js +43762 -12377
  7. package/dist/db/index.js.map +3 -3
  8. package/dist/db/pagination.d.ts +1 -0
  9. package/dist/index.d.ts +0 -4
  10. package/dist/index.js +2422 -2135
  11. package/dist/index.js.map +3 -3
  12. package/dist/indexer/config.d.ts +0 -8
  13. package/dist/lexicon/index.d.ts +0 -2
  14. package/dist/lexicon/lexicons.d.ts +134 -52
  15. package/dist/lexicon/types/app/bsky/actor/defs.d.ts +1 -0
  16. package/dist/lexicon/types/app/bsky/actor/getPreferences.d.ts +2 -2
  17. package/dist/lexicon/types/app/bsky/actor/getProfile.d.ts +2 -2
  18. package/dist/lexicon/types/app/bsky/actor/getProfiles.d.ts +2 -2
  19. package/dist/lexicon/types/app/bsky/actor/getSuggestions.d.ts +2 -2
  20. package/dist/lexicon/types/app/bsky/actor/searchActors.d.ts +2 -2
  21. package/dist/lexicon/types/app/bsky/actor/searchActorsTypeahead.d.ts +2 -2
  22. package/dist/lexicon/types/app/bsky/feed/describeFeedGenerator.d.ts +2 -2
  23. package/dist/lexicon/types/app/bsky/feed/getActorFeeds.d.ts +2 -2
  24. package/dist/lexicon/types/app/bsky/feed/getActorLikes.d.ts +2 -2
  25. package/dist/lexicon/types/app/bsky/feed/getAuthorFeed.d.ts +2 -2
  26. package/dist/lexicon/types/app/bsky/feed/getFeed.d.ts +2 -2
  27. package/dist/lexicon/types/app/bsky/feed/getFeedGenerator.d.ts +2 -2
  28. package/dist/lexicon/types/app/bsky/feed/getFeedGenerators.d.ts +2 -2
  29. package/dist/lexicon/types/app/bsky/feed/getFeedSkeleton.d.ts +2 -2
  30. package/dist/lexicon/types/app/bsky/feed/getLikes.d.ts +2 -2
  31. package/dist/lexicon/types/app/bsky/feed/getListFeed.d.ts +2 -2
  32. package/dist/lexicon/types/app/bsky/feed/getPostThread.d.ts +2 -2
  33. package/dist/lexicon/types/app/bsky/feed/getPosts.d.ts +2 -2
  34. package/dist/lexicon/types/app/bsky/feed/getRepostedBy.d.ts +2 -2
  35. package/dist/lexicon/types/app/bsky/feed/getSuggestedFeeds.d.ts +2 -2
  36. package/dist/lexicon/types/app/bsky/feed/getTimeline.d.ts +2 -2
  37. package/dist/lexicon/types/app/bsky/feed/searchPosts.d.ts +2 -2
  38. package/dist/lexicon/types/app/bsky/graph/getBlocks.d.ts +2 -2
  39. package/dist/lexicon/types/app/bsky/graph/getFollowers.d.ts +2 -2
  40. package/dist/lexicon/types/app/bsky/graph/getFollows.d.ts +2 -2
  41. package/dist/lexicon/types/app/bsky/graph/getList.d.ts +2 -2
  42. package/dist/lexicon/types/app/bsky/graph/getListBlocks.d.ts +2 -2
  43. package/dist/lexicon/types/app/bsky/graph/getListMutes.d.ts +2 -2
  44. package/dist/lexicon/types/app/bsky/graph/getLists.d.ts +2 -2
  45. package/dist/lexicon/types/app/bsky/graph/getMutes.d.ts +2 -2
  46. package/dist/lexicon/types/app/bsky/graph/getRelationships.d.ts +2 -2
  47. package/dist/lexicon/types/app/bsky/graph/getSuggestedFollowsByActor.d.ts +2 -2
  48. package/dist/lexicon/types/app/bsky/notification/getUnreadCount.d.ts +2 -2
  49. package/dist/lexicon/types/app/bsky/notification/listNotifications.d.ts +2 -2
  50. package/dist/lexicon/types/app/bsky/unspecced/getPopularFeedGenerators.d.ts +2 -2
  51. package/dist/lexicon/types/app/bsky/unspecced/getTaggedSuggestions.d.ts +2 -2
  52. package/dist/lexicon/types/app/bsky/unspecced/searchActorsSkeleton.d.ts +2 -2
  53. package/dist/lexicon/types/app/bsky/unspecced/searchPostsSkeleton.d.ts +2 -2
  54. package/dist/lexicon/types/com/atproto/admin/createCommunicationTemplate.d.ts +2 -2
  55. package/dist/lexicon/types/com/atproto/admin/defs.d.ts +2 -2
  56. package/dist/lexicon/types/com/atproto/admin/emitModerationEvent.d.ts +2 -2
  57. package/dist/lexicon/types/com/atproto/admin/getAccountInfo.d.ts +2 -2
  58. package/dist/lexicon/types/com/atproto/admin/getAccountInfos.d.ts +2 -2
  59. package/dist/lexicon/types/com/atproto/admin/getInviteCodes.d.ts +2 -2
  60. package/dist/lexicon/types/com/atproto/admin/getModerationEvent.d.ts +2 -2
  61. package/dist/lexicon/types/com/atproto/admin/getRecord.d.ts +2 -2
  62. package/dist/lexicon/types/com/atproto/admin/getRepo.d.ts +2 -2
  63. package/dist/lexicon/types/com/atproto/admin/getSubjectStatus.d.ts +2 -2
  64. package/dist/lexicon/types/com/atproto/admin/listCommunicationTemplates.d.ts +2 -2
  65. package/dist/lexicon/types/com/atproto/admin/queryModerationEvents.d.ts +9 -2
  66. package/dist/lexicon/types/com/atproto/admin/queryModerationStatuses.d.ts +2 -2
  67. package/dist/lexicon/types/com/atproto/admin/searchRepos.d.ts +2 -2
  68. package/dist/lexicon/types/com/atproto/admin/sendEmail.d.ts +2 -2
  69. package/dist/lexicon/types/com/atproto/admin/updateCommunicationTemplate.d.ts +2 -2
  70. package/dist/lexicon/types/com/atproto/admin/updateSubjectStatus.d.ts +2 -2
  71. package/dist/lexicon/types/com/atproto/identity/resolveHandle.d.ts +2 -2
  72. package/dist/lexicon/types/com/atproto/label/queryLabels.d.ts +2 -2
  73. package/dist/lexicon/types/com/atproto/moderation/createReport.d.ts +2 -2
  74. package/dist/lexicon/types/com/atproto/repo/createRecord.d.ts +2 -2
  75. package/dist/lexicon/types/com/atproto/repo/describeRepo.d.ts +2 -2
  76. package/dist/lexicon/types/com/atproto/repo/getRecord.d.ts +2 -2
  77. package/dist/lexicon/types/com/atproto/repo/listRecords.d.ts +2 -2
  78. package/dist/lexicon/types/com/atproto/repo/putRecord.d.ts +2 -2
  79. package/dist/lexicon/types/com/atproto/repo/uploadBlob.d.ts +2 -2
  80. package/dist/lexicon/types/com/atproto/server/createAccount.d.ts +2 -2
  81. package/dist/lexicon/types/com/atproto/server/createAppPassword.d.ts +2 -2
  82. package/dist/lexicon/types/com/atproto/server/createInviteCode.d.ts +2 -2
  83. package/dist/lexicon/types/com/atproto/server/createInviteCodes.d.ts +2 -2
  84. package/dist/lexicon/types/com/atproto/server/createSession.d.ts +2 -2
  85. package/dist/lexicon/types/com/atproto/server/describeServer.d.ts +2 -2
  86. package/dist/lexicon/types/com/atproto/server/getAccountInviteCodes.d.ts +2 -2
  87. package/dist/lexicon/types/com/atproto/server/getSession.d.ts +2 -2
  88. package/dist/lexicon/types/com/atproto/server/listAppPasswords.d.ts +2 -2
  89. package/dist/lexicon/types/com/atproto/server/refreshSession.d.ts +2 -2
  90. package/dist/lexicon/types/com/atproto/server/requestEmailUpdate.d.ts +2 -2
  91. package/dist/lexicon/types/com/atproto/server/reserveSigningKey.d.ts +2 -2
  92. package/dist/lexicon/types/com/atproto/sync/getBlob.d.ts +2 -2
  93. package/dist/lexicon/types/com/atproto/sync/getBlocks.d.ts +2 -2
  94. package/dist/lexicon/types/com/atproto/sync/getCheckout.d.ts +2 -2
  95. package/dist/lexicon/types/com/atproto/sync/getHead.d.ts +2 -2
  96. package/dist/lexicon/types/com/atproto/sync/getLatestCommit.d.ts +2 -2
  97. package/dist/lexicon/types/com/atproto/sync/getRecord.d.ts +2 -2
  98. package/dist/lexicon/types/com/atproto/sync/getRepo.d.ts +2 -2
  99. package/dist/lexicon/types/com/atproto/sync/listBlobs.d.ts +2 -2
  100. package/dist/lexicon/types/com/atproto/sync/listRepos.d.ts +2 -2
  101. package/dist/lexicon/types/com/atproto/temp/checkSignupQueue.d.ts +2 -2
  102. package/dist/lexicon/types/com/atproto/temp/fetchLabels.d.ts +2 -2
  103. package/dist/lexicon/types/com/atproto/temp/importRepo.d.ts +2 -2
  104. package/dist/lexicon/types/com/atproto/temp/transferAccount.d.ts +2 -2
  105. package/dist/services/feed/index.d.ts +2 -1
  106. package/package.json +8 -7
  107. package/src/api/app/bsky/actor/getSuggestions.ts +1 -1
  108. package/src/api/app/bsky/actor/searchActors.ts +1 -0
  109. package/src/api/app/bsky/feed/getActorFeeds.ts +6 -0
  110. package/src/api/app/bsky/feed/getActorLikes.ts +4 -0
  111. package/src/api/app/bsky/feed/getAuthorFeed.ts +16 -4
  112. package/src/api/app/bsky/feed/getFeed.ts +8 -5
  113. package/src/api/app/bsky/feed/getLikes.ts +4 -0
  114. package/src/api/app/bsky/feed/getListFeed.ts +4 -0
  115. package/src/api/app/bsky/feed/getRepostedBy.ts +4 -0
  116. package/src/api/app/bsky/feed/getSuggestedFeeds.ts +1 -1
  117. package/src/api/app/bsky/feed/getTimeline.ts +4 -0
  118. package/src/api/app/bsky/feed/searchPosts.ts +1 -0
  119. package/src/api/app/bsky/graph/getBlocks.ts +7 -0
  120. package/src/api/app/bsky/graph/getFollowers.ts +4 -0
  121. package/src/api/app/bsky/graph/getFollows.ts +4 -0
  122. package/src/api/app/bsky/graph/getList.ts +4 -0
  123. package/src/api/app/bsky/graph/getListBlocks.ts +4 -0
  124. package/src/api/app/bsky/graph/getListMutes.ts +7 -0
  125. package/src/api/app/bsky/graph/getLists.ts +7 -0
  126. package/src/api/app/bsky/graph/getMutes.ts +7 -0
  127. package/src/api/app/bsky/notification/listNotifications.ts +3 -0
  128. package/src/api/app/bsky/unspecced/getPopularFeedGenerators.ts +7 -1
  129. package/src/api/index.ts +0 -6
  130. package/src/auto-moderator/index.ts +9 -176
  131. package/src/context.ts +0 -6
  132. package/src/db/pagination.ts +3 -0
  133. package/src/index.ts +1 -6
  134. package/src/indexer/config.ts +0 -29
  135. package/src/lexicon/index.ts +0 -12
  136. package/src/lexicon/lexicons.ts +382 -173
  137. package/src/lexicon/types/app/bsky/actor/defs.ts +2 -0
  138. package/src/lexicon/types/app/bsky/actor/getPreferences.ts +2 -2
  139. package/src/lexicon/types/app/bsky/actor/getProfile.ts +3 -2
  140. package/src/lexicon/types/app/bsky/actor/getProfiles.ts +2 -2
  141. package/src/lexicon/types/app/bsky/actor/getSuggestions.ts +2 -2
  142. package/src/lexicon/types/app/bsky/actor/profile.ts +3 -0
  143. package/src/lexicon/types/app/bsky/actor/putPreferences.ts +1 -1
  144. package/src/lexicon/types/app/bsky/actor/searchActors.ts +2 -2
  145. package/src/lexicon/types/app/bsky/actor/searchActorsTypeahead.ts +2 -2
  146. package/src/lexicon/types/app/bsky/embed/external.ts +1 -0
  147. package/src/lexicon/types/app/bsky/embed/images.ts +4 -0
  148. package/src/lexicon/types/app/bsky/embed/record.ts +1 -0
  149. package/src/lexicon/types/app/bsky/feed/defs.ts +1 -0
  150. package/src/lexicon/types/app/bsky/feed/describeFeedGenerator.ts +2 -2
  151. package/src/lexicon/types/app/bsky/feed/getActorFeeds.ts +2 -2
  152. package/src/lexicon/types/app/bsky/feed/getActorLikes.ts +2 -2
  153. package/src/lexicon/types/app/bsky/feed/getAuthorFeed.ts +3 -2
  154. package/src/lexicon/types/app/bsky/feed/getFeed.ts +2 -2
  155. package/src/lexicon/types/app/bsky/feed/getFeedGenerator.ts +5 -2
  156. package/src/lexicon/types/app/bsky/feed/getFeedGenerators.ts +2 -2
  157. package/src/lexicon/types/app/bsky/feed/getFeedSkeleton.ts +3 -2
  158. package/src/lexicon/types/app/bsky/feed/getLikes.ts +4 -2
  159. package/src/lexicon/types/app/bsky/feed/getListFeed.ts +3 -2
  160. package/src/lexicon/types/app/bsky/feed/getPostThread.ts +5 -2
  161. package/src/lexicon/types/app/bsky/feed/getPosts.ts +3 -2
  162. package/src/lexicon/types/app/bsky/feed/getRepostedBy.ts +4 -2
  163. package/src/lexicon/types/app/bsky/feed/getSuggestedFeeds.ts +2 -2
  164. package/src/lexicon/types/app/bsky/feed/getTimeline.ts +3 -2
  165. package/src/lexicon/types/app/bsky/feed/post.ts +5 -1
  166. package/src/lexicon/types/app/bsky/feed/searchPosts.ts +2 -2
  167. package/src/lexicon/types/app/bsky/feed/threadgate.ts +1 -0
  168. package/src/lexicon/types/app/bsky/graph/block.ts +1 -0
  169. package/src/lexicon/types/app/bsky/graph/getBlocks.ts +2 -2
  170. package/src/lexicon/types/app/bsky/graph/getFollowers.ts +2 -2
  171. package/src/lexicon/types/app/bsky/graph/getFollows.ts +2 -2
  172. package/src/lexicon/types/app/bsky/graph/getList.ts +3 -2
  173. package/src/lexicon/types/app/bsky/graph/getListBlocks.ts +2 -2
  174. package/src/lexicon/types/app/bsky/graph/getListMutes.ts +2 -2
  175. package/src/lexicon/types/app/bsky/graph/getLists.ts +3 -2
  176. package/src/lexicon/types/app/bsky/graph/getMutes.ts +2 -2
  177. package/src/lexicon/types/app/bsky/graph/getRelationships.ts +4 -2
  178. package/src/lexicon/types/app/bsky/graph/getSuggestedFollowsByActor.ts +2 -2
  179. package/src/lexicon/types/app/bsky/graph/list.ts +1 -0
  180. package/src/lexicon/types/app/bsky/graph/listblock.ts +1 -0
  181. package/src/lexicon/types/app/bsky/graph/listitem.ts +2 -0
  182. package/src/lexicon/types/app/bsky/graph/muteActor.ts +1 -1
  183. package/src/lexicon/types/app/bsky/graph/muteActorList.ts +1 -1
  184. package/src/lexicon/types/app/bsky/graph/unmuteActor.ts +1 -1
  185. package/src/lexicon/types/app/bsky/graph/unmuteActorList.ts +1 -1
  186. package/src/lexicon/types/app/bsky/notification/getUnreadCount.ts +2 -2
  187. package/src/lexicon/types/app/bsky/notification/listNotifications.ts +2 -2
  188. package/src/lexicon/types/app/bsky/notification/registerPush.ts +1 -1
  189. package/src/lexicon/types/app/bsky/notification/updateSeen.ts +1 -1
  190. package/src/lexicon/types/app/bsky/richtext/facet.ts +5 -4
  191. package/src/lexicon/types/app/bsky/unspecced/getPopularFeedGenerators.ts +2 -2
  192. package/src/lexicon/types/app/bsky/unspecced/getTaggedSuggestions.ts +2 -2
  193. package/src/lexicon/types/app/bsky/unspecced/searchActorsSkeleton.ts +2 -2
  194. package/src/lexicon/types/app/bsky/unspecced/searchPostsSkeleton.ts +2 -2
  195. package/src/lexicon/types/com/atproto/admin/createCommunicationTemplate.ts +2 -2
  196. package/src/lexicon/types/com/atproto/admin/defs.ts +2 -0
  197. package/src/lexicon/types/com/atproto/admin/deleteAccount.ts +1 -1
  198. package/src/lexicon/types/com/atproto/admin/deleteCommunicationTemplate.ts +1 -1
  199. package/src/lexicon/types/com/atproto/admin/disableAccountInvites.ts +1 -1
  200. package/src/lexicon/types/com/atproto/admin/disableInviteCodes.ts +1 -1
  201. package/src/lexicon/types/com/atproto/admin/emitModerationEvent.ts +2 -2
  202. package/src/lexicon/types/com/atproto/admin/enableAccountInvites.ts +1 -1
  203. package/src/lexicon/types/com/atproto/admin/getAccountInfo.ts +2 -2
  204. package/src/lexicon/types/com/atproto/admin/getAccountInfos.ts +2 -2
  205. package/src/lexicon/types/com/atproto/admin/getInviteCodes.ts +2 -2
  206. package/src/lexicon/types/com/atproto/admin/getModerationEvent.ts +2 -2
  207. package/src/lexicon/types/com/atproto/admin/getRecord.ts +2 -2
  208. package/src/lexicon/types/com/atproto/admin/getRepo.ts +2 -2
  209. package/src/lexicon/types/com/atproto/admin/getSubjectStatus.ts +2 -2
  210. package/src/lexicon/types/com/atproto/admin/listCommunicationTemplates.ts +2 -2
  211. package/src/lexicon/types/com/atproto/admin/queryModerationEvents.ts +15 -2
  212. package/src/lexicon/types/com/atproto/admin/queryModerationStatuses.ts +2 -2
  213. package/src/lexicon/types/com/atproto/admin/searchRepos.ts +2 -2
  214. package/src/lexicon/types/com/atproto/admin/sendEmail.ts +2 -2
  215. package/src/lexicon/types/com/atproto/admin/updateAccountEmail.ts +1 -1
  216. package/src/lexicon/types/com/atproto/admin/updateAccountHandle.ts +1 -1
  217. package/src/lexicon/types/com/atproto/admin/updateCommunicationTemplate.ts +2 -2
  218. package/src/lexicon/types/com/atproto/admin/updateSubjectStatus.ts +2 -2
  219. package/src/lexicon/types/com/atproto/identity/resolveHandle.ts +2 -2
  220. package/src/lexicon/types/com/atproto/identity/updateHandle.ts +2 -1
  221. package/src/lexicon/types/com/atproto/label/queryLabels.ts +2 -2
  222. package/src/lexicon/types/com/atproto/label/subscribeLabels.ts +1 -1
  223. package/src/lexicon/types/com/atproto/moderation/createReport.ts +3 -2
  224. package/src/lexicon/types/com/atproto/repo/applyWrites.ts +7 -6
  225. package/src/lexicon/types/com/atproto/repo/createRecord.ts +6 -6
  226. package/src/lexicon/types/com/atproto/repo/deleteRecord.ts +3 -3
  227. package/src/lexicon/types/com/atproto/repo/describeRepo.ts +5 -2
  228. package/src/lexicon/types/com/atproto/repo/getRecord.ts +3 -3
  229. package/src/lexicon/types/com/atproto/repo/listRecords.ts +2 -2
  230. package/src/lexicon/types/com/atproto/repo/putRecord.ts +6 -6
  231. package/src/lexicon/types/com/atproto/repo/uploadBlob.ts +2 -2
  232. package/src/lexicon/types/com/atproto/server/confirmEmail.ts +1 -1
  233. package/src/lexicon/types/com/atproto/server/createAccount.ts +10 -2
  234. package/src/lexicon/types/com/atproto/server/createAppPassword.ts +3 -2
  235. package/src/lexicon/types/com/atproto/server/createInviteCode.ts +2 -2
  236. package/src/lexicon/types/com/atproto/server/createInviteCodes.ts +2 -2
  237. package/src/lexicon/types/com/atproto/server/createSession.ts +2 -2
  238. package/src/lexicon/types/com/atproto/server/deleteAccount.ts +1 -1
  239. package/src/lexicon/types/com/atproto/server/deleteSession.ts +1 -1
  240. package/src/lexicon/types/com/atproto/server/describeServer.ts +5 -2
  241. package/src/lexicon/types/com/atproto/server/getAccountInviteCodes.ts +3 -2
  242. package/src/lexicon/types/com/atproto/server/getSession.ts +2 -2
  243. package/src/lexicon/types/com/atproto/server/listAppPasswords.ts +2 -2
  244. package/src/lexicon/types/com/atproto/server/refreshSession.ts +2 -2
  245. package/src/lexicon/types/com/atproto/server/requestAccountDelete.ts +1 -1
  246. package/src/lexicon/types/com/atproto/server/requestEmailConfirmation.ts +1 -1
  247. package/src/lexicon/types/com/atproto/server/requestEmailUpdate.ts +2 -2
  248. package/src/lexicon/types/com/atproto/server/requestPasswordReset.ts +1 -1
  249. package/src/lexicon/types/com/atproto/server/reserveSigningKey.ts +4 -4
  250. package/src/lexicon/types/com/atproto/server/resetPassword.ts +1 -1
  251. package/src/lexicon/types/com/atproto/server/revokeAppPassword.ts +1 -1
  252. package/src/lexicon/types/com/atproto/server/updateEmail.ts +1 -1
  253. package/src/lexicon/types/com/atproto/sync/getBlob.ts +3 -3
  254. package/src/lexicon/types/com/atproto/sync/getBlocks.ts +2 -2
  255. package/src/lexicon/types/com/atproto/sync/getCheckout.ts +2 -2
  256. package/src/lexicon/types/com/atproto/sync/getHead.ts +2 -2
  257. package/src/lexicon/types/com/atproto/sync/getLatestCommit.ts +2 -2
  258. package/src/lexicon/types/com/atproto/sync/getRecord.ts +3 -2
  259. package/src/lexicon/types/com/atproto/sync/getRepo.ts +3 -3
  260. package/src/lexicon/types/com/atproto/sync/listBlobs.ts +2 -2
  261. package/src/lexicon/types/com/atproto/sync/listRepos.ts +3 -2
  262. package/src/lexicon/types/com/atproto/sync/notifyOfUpdate.ts +2 -2
  263. package/src/lexicon/types/com/atproto/sync/requestCrawl.ts +2 -2
  264. package/src/lexicon/types/com/atproto/sync/subscribeRepos.ts +17 -5
  265. package/src/lexicon/types/com/atproto/temp/checkSignupQueue.ts +2 -2
  266. package/src/lexicon/types/com/atproto/temp/fetchLabels.ts +2 -2
  267. package/src/lexicon/types/com/atproto/temp/importRepo.ts +2 -2
  268. package/src/lexicon/types/com/atproto/temp/pushBlob.ts +1 -1
  269. package/src/lexicon/types/com/atproto/temp/requestPhoneVerification.ts +1 -1
  270. package/src/lexicon/types/com/atproto/temp/transferAccount.ts +2 -2
  271. package/src/logger.ts +32 -0
  272. package/src/services/feed/index.ts +10 -4
  273. package/src/services/feed/views.ts +3 -1
  274. package/tests/auto-moderator/labeler.test.ts +2 -0
  275. package/tests/feed-generation.test.ts +0 -6
  276. package/tests/views/author-feed.test.ts +29 -9
  277. package/tests/views/notifications.test.ts +9 -0
  278. package/tests/views/timeline.test.ts +8 -0
  279. package/dist/api/app/bsky/feed/describeFeedGenerator.d.ts +0 -3
  280. package/dist/api/app/bsky/feed/getFeedSkeleton.d.ts +0 -3
  281. package/dist/api/app/bsky/unspecced/getTimelineSkeleton.d.ts +0 -3
  282. package/dist/auto-moderator/abyss.d.ts +0 -48
  283. package/dist/auto-moderator/fuzzy-matcher.d.ts +0 -14
  284. package/dist/feed-gen/bsky-team.d.ts +0 -3
  285. package/dist/feed-gen/hot-classic.d.ts +0 -3
  286. package/dist/feed-gen/index.d.ts +0 -2
  287. package/dist/feed-gen/mutuals.d.ts +0 -3
  288. package/dist/feed-gen/types.d.ts +0 -15
  289. package/dist/lexicon/types/app/bsky/unspecced/getTimelineSkeleton.d.ts +0 -35
  290. package/src/api/app/bsky/feed/describeFeedGenerator.ts +0 -21
  291. package/src/api/app/bsky/feed/getFeedSkeleton.ts +0 -30
  292. package/src/api/app/bsky/unspecced/getTimelineSkeleton.ts +0 -26
  293. package/src/auto-moderator/abyss.ts +0 -114
  294. package/src/auto-moderator/fuzzy-matcher.ts +0 -126
  295. package/src/feed-gen/bsky-team.ts +0 -42
  296. package/src/feed-gen/hot-classic.ts +0 -55
  297. package/src/feed-gen/index.ts +0 -17
  298. package/src/feed-gen/mutuals.ts +0 -57
  299. package/src/feed-gen/types.ts +0 -32
  300. package/src/lexicon/types/app/bsky/unspecced/getTimelineSkeleton.ts +0 -49
  301. package/tests/algos/hot-classic.test.ts +0 -87
  302. package/tests/auto-moderator/fuzzy-matcher.test.ts +0 -163
  303. package/tests/auto-moderator/takedowns.test.ts +0 -202
@@ -91,6 +91,7 @@ export const schemaDict = {
91
91
  'lex:com.atproto.admin.defs#modEventEscalate',
92
92
  'lex:com.atproto.admin.defs#modEventMute',
93
93
  'lex:com.atproto.admin.defs#modEventEmail',
94
+ 'lex:com.atproto.admin.defs#modEventResolveAppeal',
94
95
  ],
95
96
  },
96
97
  subject: {
@@ -147,6 +148,7 @@ export const schemaDict = {
147
148
  'lex:com.atproto.admin.defs#modEventAcknowledge',
148
149
  'lex:com.atproto.admin.defs#modEventEscalate',
149
150
  'lex:com.atproto.admin.defs#modEventMute',
151
+ 'lex:com.atproto.admin.defs#modEventEmail',
150
152
  'lex:com.atproto.admin.defs#modEventResolveAppeal',
151
153
  ],
152
154
  },
@@ -1450,6 +1452,16 @@ export const schemaDict = {
1450
1452
  description:
1451
1453
  'Sort direction for the events. Defaults to descending order of created at timestamp.',
1452
1454
  },
1455
+ createdAfter: {
1456
+ type: 'string',
1457
+ format: 'datetime',
1458
+ description: 'Retrieve events created after a given timestamp',
1459
+ },
1460
+ createdBefore: {
1461
+ type: 'string',
1462
+ format: 'datetime',
1463
+ description: 'Retrieve events created before a given timestamp',
1464
+ },
1453
1465
  subject: {
1454
1466
  type: 'string',
1455
1467
  format: 'uri',
@@ -1466,6 +1478,37 @@ export const schemaDict = {
1466
1478
  maximum: 100,
1467
1479
  default: 50,
1468
1480
  },
1481
+ hasComment: {
1482
+ type: 'boolean',
1483
+ description: 'If true, only events with comments are returned',
1484
+ },
1485
+ comment: {
1486
+ type: 'string',
1487
+ description:
1488
+ 'If specified, only events with comments containing the keyword are returned',
1489
+ },
1490
+ addedLabels: {
1491
+ type: 'array',
1492
+ items: {
1493
+ type: 'string',
1494
+ },
1495
+ description:
1496
+ 'If specified, only events where all of these labels were added are returned',
1497
+ },
1498
+ removedLabels: {
1499
+ type: 'array',
1500
+ items: {
1501
+ type: 'string',
1502
+ },
1503
+ description:
1504
+ 'If specified, only events where all of these labels were removed are returned',
1505
+ },
1506
+ reportTypes: {
1507
+ type: 'array',
1508
+ items: {
1509
+ type: 'string',
1510
+ },
1511
+ },
1469
1512
  cursor: {
1470
1513
  type: 'string',
1471
1514
  },
@@ -1869,7 +1912,7 @@ export const schemaDict = {
1869
1912
  defs: {
1870
1913
  main: {
1871
1914
  type: 'query',
1872
- description: 'Provides the DID of a repo.',
1915
+ description: 'Resolves a handle (domain name) to a DID.',
1873
1916
  parameters: {
1874
1917
  type: 'params',
1875
1918
  required: ['handle'],
@@ -1903,7 +1946,8 @@ export const schemaDict = {
1903
1946
  defs: {
1904
1947
  main: {
1905
1948
  type: 'procedure',
1906
- description: 'Updates the handle of the account.',
1949
+ description:
1950
+ "Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth.",
1907
1951
  input: {
1908
1952
  encoding: 'application/json',
1909
1953
  schema: {
@@ -1913,6 +1957,7 @@ export const schemaDict = {
1913
1957
  handle: {
1914
1958
  type: 'string',
1915
1959
  format: 'handle',
1960
+ description: 'The new handle.',
1916
1961
  },
1917
1962
  },
1918
1963
  },
@@ -2003,7 +2048,8 @@ export const schemaDict = {
2003
2048
  defs: {
2004
2049
  main: {
2005
2050
  type: 'query',
2006
- description: 'Find labels relevant to the provided URI patterns.',
2051
+ description:
2052
+ 'Find labels relevant to the provided AT-URI patterns. Public endpoint for moderation services, though may return different or additional results with auth.',
2007
2053
  parameters: {
2008
2054
  type: 'params',
2009
2055
  required: ['uriPatterns'],
@@ -2064,13 +2110,14 @@ export const schemaDict = {
2064
2110
  defs: {
2065
2111
  main: {
2066
2112
  type: 'subscription',
2067
- description: 'Subscribe to label updates.',
2113
+ description:
2114
+ 'Subscribe to stream of labels (and negations). Public endpoint implemented by mod services. Uses same sequencing scheme as repo event stream.',
2068
2115
  parameters: {
2069
2116
  type: 'params',
2070
2117
  properties: {
2071
2118
  cursor: {
2072
2119
  type: 'integer',
2073
- description: 'The last known event to backfill from.',
2120
+ description: 'The last known event seq number to backfill from.',
2074
2121
  },
2075
2122
  },
2076
2123
  },
@@ -2126,7 +2173,8 @@ export const schemaDict = {
2126
2173
  defs: {
2127
2174
  main: {
2128
2175
  type: 'procedure',
2129
- description: 'Report a repo or a record.',
2176
+ description:
2177
+ 'Submit a moderation report regarding an atproto account or record. Implemented by moderation services (with PDS proxying), and requires auth.',
2130
2178
  input: {
2131
2179
  encoding: 'application/json',
2132
2180
  schema: {
@@ -2135,10 +2183,14 @@ export const schemaDict = {
2135
2183
  properties: {
2136
2184
  reasonType: {
2137
2185
  type: 'ref',
2186
+ description:
2187
+ 'Indicates the broad category of violation the report is for.',
2138
2188
  ref: 'lex:com.atproto.moderation.defs#reasonType',
2139
2189
  },
2140
2190
  reason: {
2141
2191
  type: 'string',
2192
+ description:
2193
+ 'Additional context about the content and violation.',
2142
2194
  },
2143
2195
  subject: {
2144
2196
  type: 'union',
@@ -2249,7 +2301,7 @@ export const schemaDict = {
2249
2301
  main: {
2250
2302
  type: 'procedure',
2251
2303
  description:
2252
- 'Apply a batch transaction of creates, updates, and deletes.',
2304
+ 'Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.',
2253
2305
  input: {
2254
2306
  encoding: 'application/json',
2255
2307
  schema: {
@@ -2259,12 +2311,14 @@ export const schemaDict = {
2259
2311
  repo: {
2260
2312
  type: 'string',
2261
2313
  format: 'at-identifier',
2262
- description: 'The handle or DID of the repo.',
2314
+ description:
2315
+ 'The handle or DID of the repo (aka, current account).',
2263
2316
  },
2264
2317
  validate: {
2265
2318
  type: 'boolean',
2266
2319
  default: true,
2267
- description: 'Flag for validating the records.',
2320
+ description:
2321
+ "Can be set to 'false' to skip Lexicon schema validation of record data, for all operations.",
2268
2322
  },
2269
2323
  writes: {
2270
2324
  type: 'array',
@@ -2280,6 +2334,8 @@ export const schemaDict = {
2280
2334
  },
2281
2335
  swapCommit: {
2282
2336
  type: 'string',
2337
+ description:
2338
+ 'If provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations.',
2283
2339
  format: 'cid',
2284
2340
  },
2285
2341
  },
@@ -2288,12 +2344,14 @@ export const schemaDict = {
2288
2344
  errors: [
2289
2345
  {
2290
2346
  name: 'InvalidSwap',
2347
+ description:
2348
+ "Indicates that the 'swapCommit' parameter did not match current commit.",
2291
2349
  },
2292
2350
  ],
2293
2351
  },
2294
2352
  create: {
2295
2353
  type: 'object',
2296
- description: 'Create a new record.',
2354
+ description: 'Operation which creates a new record.',
2297
2355
  required: ['collection', 'value'],
2298
2356
  properties: {
2299
2357
  collection: {
@@ -2311,7 +2369,7 @@ export const schemaDict = {
2311
2369
  },
2312
2370
  update: {
2313
2371
  type: 'object',
2314
- description: 'Update an existing record.',
2372
+ description: 'Operation which updates an existing record.',
2315
2373
  required: ['collection', 'rkey', 'value'],
2316
2374
  properties: {
2317
2375
  collection: {
@@ -2328,7 +2386,7 @@ export const schemaDict = {
2328
2386
  },
2329
2387
  delete: {
2330
2388
  type: 'object',
2331
- description: 'Delete an existing record.',
2389
+ description: 'Operation which deletes an existing record.',
2332
2390
  required: ['collection', 'rkey'],
2333
2391
  properties: {
2334
2392
  collection: {
@@ -2348,7 +2406,8 @@ export const schemaDict = {
2348
2406
  defs: {
2349
2407
  main: {
2350
2408
  type: 'procedure',
2351
- description: 'Create a new record.',
2409
+ description:
2410
+ 'Create a single new repository record. Requires auth, implemented by PDS.',
2352
2411
  input: {
2353
2412
  encoding: 'application/json',
2354
2413
  schema: {
@@ -2358,7 +2417,8 @@ export const schemaDict = {
2358
2417
  repo: {
2359
2418
  type: 'string',
2360
2419
  format: 'at-identifier',
2361
- description: 'The handle or DID of the repo.',
2420
+ description:
2421
+ 'The handle or DID of the repo (aka, current account).',
2362
2422
  },
2363
2423
  collection: {
2364
2424
  type: 'string',
@@ -2367,17 +2427,18 @@ export const schemaDict = {
2367
2427
  },
2368
2428
  rkey: {
2369
2429
  type: 'string',
2370
- description: 'The key of the record.',
2430
+ description: 'The Record Key.',
2371
2431
  maxLength: 15,
2372
2432
  },
2373
2433
  validate: {
2374
2434
  type: 'boolean',
2375
2435
  default: true,
2376
- description: 'Flag for validating the record.',
2436
+ description:
2437
+ "Can be set to 'false' to skip Lexicon schema validation of record data.",
2377
2438
  },
2378
2439
  record: {
2379
2440
  type: 'unknown',
2380
- description: 'The record to create.',
2441
+ description: 'The record itself. Must contain a $type field.',
2381
2442
  },
2382
2443
  swapCommit: {
2383
2444
  type: 'string',
@@ -2408,6 +2469,8 @@ export const schemaDict = {
2408
2469
  errors: [
2409
2470
  {
2410
2471
  name: 'InvalidSwap',
2472
+ description:
2473
+ "Indicates that 'swapCommit' didn't match current repo commit.",
2411
2474
  },
2412
2475
  ],
2413
2476
  },
@@ -2419,7 +2482,8 @@ export const schemaDict = {
2419
2482
  defs: {
2420
2483
  main: {
2421
2484
  type: 'procedure',
2422
- description: "Delete a record, or ensure it doesn't exist.",
2485
+ description:
2486
+ "Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS.",
2423
2487
  input: {
2424
2488
  encoding: 'application/json',
2425
2489
  schema: {
@@ -2429,7 +2493,8 @@ export const schemaDict = {
2429
2493
  repo: {
2430
2494
  type: 'string',
2431
2495
  format: 'at-identifier',
2432
- description: 'The handle or DID of the repo.',
2496
+ description:
2497
+ 'The handle or DID of the repo (aka, current account).',
2433
2498
  },
2434
2499
  collection: {
2435
2500
  type: 'string',
@@ -2438,7 +2503,7 @@ export const schemaDict = {
2438
2503
  },
2439
2504
  rkey: {
2440
2505
  type: 'string',
2441
- description: 'The key of the record.',
2506
+ description: 'The Record Key.',
2442
2507
  },
2443
2508
  swapRecord: {
2444
2509
  type: 'string',
@@ -2470,7 +2535,7 @@ export const schemaDict = {
2470
2535
  main: {
2471
2536
  type: 'query',
2472
2537
  description:
2473
- 'Get information about the repo, including the list of collections.',
2538
+ 'Get information about an account and repository, including the list of collections. Does not require auth.',
2474
2539
  parameters: {
2475
2540
  type: 'params',
2476
2541
  required: ['repo'],
@@ -2504,9 +2569,12 @@ export const schemaDict = {
2504
2569
  },
2505
2570
  didDoc: {
2506
2571
  type: 'unknown',
2572
+ description: 'The complete DID document for this account.',
2507
2573
  },
2508
2574
  collections: {
2509
2575
  type: 'array',
2576
+ description:
2577
+ 'List of all the collections (NSIDs) for which this repo contains at least one record.',
2510
2578
  items: {
2511
2579
  type: 'string',
2512
2580
  format: 'nsid',
@@ -2514,6 +2582,8 @@ export const schemaDict = {
2514
2582
  },
2515
2583
  handleIsCorrect: {
2516
2584
  type: 'boolean',
2585
+ description:
2586
+ 'Indicates if handle is currently valid (resolves bi-directionally)',
2517
2587
  },
2518
2588
  },
2519
2589
  },
@@ -2527,7 +2597,8 @@ export const schemaDict = {
2527
2597
  defs: {
2528
2598
  main: {
2529
2599
  type: 'query',
2530
- description: 'Get a record.',
2600
+ description:
2601
+ 'Get a single record from a repository. Does not require auth.',
2531
2602
  parameters: {
2532
2603
  type: 'params',
2533
2604
  required: ['repo', 'collection', 'rkey'],
@@ -2544,7 +2615,7 @@ export const schemaDict = {
2544
2615
  },
2545
2616
  rkey: {
2546
2617
  type: 'string',
2547
- description: 'The key of the record.',
2618
+ description: 'The Record Key.',
2548
2619
  },
2549
2620
  cid: {
2550
2621
  type: 'string',
@@ -2583,7 +2654,8 @@ export const schemaDict = {
2583
2654
  defs: {
2584
2655
  main: {
2585
2656
  type: 'query',
2586
- description: 'List a range of records in a collection.',
2657
+ description:
2658
+ 'List a range of records in a repository, matching a specific collection. Does not require auth.',
2587
2659
  parameters: {
2588
2660
  type: 'params',
2589
2661
  required: ['repo', 'collection'],
@@ -2669,7 +2741,8 @@ export const schemaDict = {
2669
2741
  defs: {
2670
2742
  main: {
2671
2743
  type: 'procedure',
2672
- description: 'Write a record, creating or updating it as needed.',
2744
+ description:
2745
+ 'Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS.',
2673
2746
  input: {
2674
2747
  encoding: 'application/json',
2675
2748
  schema: {
@@ -2680,7 +2753,8 @@ export const schemaDict = {
2680
2753
  repo: {
2681
2754
  type: 'string',
2682
2755
  format: 'at-identifier',
2683
- description: 'The handle or DID of the repo.',
2756
+ description:
2757
+ 'The handle or DID of the repo (aka, current account).',
2684
2758
  },
2685
2759
  collection: {
2686
2760
  type: 'string',
@@ -2689,13 +2763,14 @@ export const schemaDict = {
2689
2763
  },
2690
2764
  rkey: {
2691
2765
  type: 'string',
2692
- description: 'The key of the record.',
2766
+ description: 'The Record Key.',
2693
2767
  maxLength: 15,
2694
2768
  },
2695
2769
  validate: {
2696
2770
  type: 'boolean',
2697
2771
  default: true,
2698
- description: 'Flag for validating the record.',
2772
+ description:
2773
+ "Can be set to 'false' to skip Lexicon schema validation of record data.",
2699
2774
  },
2700
2775
  record: {
2701
2776
  type: 'unknown',
@@ -2705,7 +2780,7 @@ export const schemaDict = {
2705
2780
  type: 'string',
2706
2781
  format: 'cid',
2707
2782
  description:
2708
- 'Compare and swap with the previous record by CID.',
2783
+ 'Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation',
2709
2784
  },
2710
2785
  swapCommit: {
2711
2786
  type: 'string',
@@ -2769,7 +2844,7 @@ export const schemaDict = {
2769
2844
  main: {
2770
2845
  type: 'procedure',
2771
2846
  description:
2772
- 'Upload a new blob to be added to repo in a later request.',
2847
+ 'Upload a new blob, to be referenced from a repository record. The blob will be deleted if it is not referenced within a time window (eg, minutes). Blob restrictions (mimetype, size, etc) are enforced when the reference is created. Requires auth, implemented by PDS.',
2773
2848
  input: {
2774
2849
  encoding: '*/*',
2775
2850
  },
@@ -2834,7 +2909,7 @@ export const schemaDict = {
2834
2909
  defs: {
2835
2910
  main: {
2836
2911
  type: 'procedure',
2837
- description: 'Create an account.',
2912
+ description: 'Create an account. Implemented by PDS.',
2838
2913
  input: {
2839
2914
  encoding: 'application/json',
2840
2915
  schema: {
@@ -2847,10 +2922,13 @@ export const schemaDict = {
2847
2922
  handle: {
2848
2923
  type: 'string',
2849
2924
  format: 'handle',
2925
+ description: 'Requested handle for the account.',
2850
2926
  },
2851
2927
  did: {
2852
2928
  type: 'string',
2853
2929
  format: 'did',
2930
+ description:
2931
+ 'Pre-existing atproto DID, being imported to a new account.',
2854
2932
  },
2855
2933
  inviteCode: {
2856
2934
  type: 'string',
@@ -2863,12 +2941,18 @@ export const schemaDict = {
2863
2941
  },
2864
2942
  password: {
2865
2943
  type: 'string',
2944
+ description:
2945
+ 'Initial account password. May need to meet instance-specific password strength requirements.',
2866
2946
  },
2867
2947
  recoveryKey: {
2868
2948
  type: 'string',
2949
+ description:
2950
+ 'DID PLC rotation key (aka, recovery key) to be included in PLC creation operation.',
2869
2951
  },
2870
2952
  plcOp: {
2871
2953
  type: 'unknown',
2954
+ description:
2955
+ 'A signed DID PLC operation to be submitted as part of importing an existing account to this instance. NOTE: this optional field may be updated when full account migration is implemented.',
2872
2956
  },
2873
2957
  },
2874
2958
  },
@@ -2877,6 +2961,8 @@ export const schemaDict = {
2877
2961
  encoding: 'application/json',
2878
2962
  schema: {
2879
2963
  type: 'object',
2964
+ description:
2965
+ 'Account login session returned on successful account creation.',
2880
2966
  required: ['accessJwt', 'refreshJwt', 'handle', 'did'],
2881
2967
  properties: {
2882
2968
  accessJwt: {
@@ -2892,9 +2978,11 @@ export const schemaDict = {
2892
2978
  did: {
2893
2979
  type: 'string',
2894
2980
  format: 'did',
2981
+ description: 'The DID of the new account.',
2895
2982
  },
2896
2983
  didDoc: {
2897
2984
  type: 'unknown',
2985
+ description: 'Complete DID document.',
2898
2986
  },
2899
2987
  },
2900
2988
  },
@@ -2940,6 +3028,8 @@ export const schemaDict = {
2940
3028
  properties: {
2941
3029
  name: {
2942
3030
  type: 'string',
3031
+ description:
3032
+ 'A short name for the App Password, to help distinguish them.',
2943
3033
  },
2944
3034
  },
2945
3035
  },
@@ -3207,7 +3297,8 @@ export const schemaDict = {
3207
3297
  defs: {
3208
3298
  main: {
3209
3299
  type: 'procedure',
3210
- description: "Delete an actor's account with a token and password.",
3300
+ description:
3301
+ "Delete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth.",
3211
3302
  input: {
3212
3303
  encoding: 'application/json',
3213
3304
  schema: {
@@ -3244,7 +3335,7 @@ export const schemaDict = {
3244
3335
  defs: {
3245
3336
  main: {
3246
3337
  type: 'procedure',
3247
- description: 'Delete the current session.',
3338
+ description: 'Delete the current session. Requires auth.',
3248
3339
  },
3249
3340
  },
3250
3341
  },
@@ -3255,7 +3346,7 @@ export const schemaDict = {
3255
3346
  main: {
3256
3347
  type: 'query',
3257
3348
  description:
3258
- "Get a document describing the service's accounts configuration.",
3349
+ "Describes the server's account creation requirements and capabilities. Implemented by PDS.",
3259
3350
  output: {
3260
3351
  encoding: 'application/json',
3261
3352
  schema: {
@@ -3264,18 +3355,25 @@ export const schemaDict = {
3264
3355
  properties: {
3265
3356
  inviteCodeRequired: {
3266
3357
  type: 'boolean',
3358
+ description:
3359
+ 'If true, an invite code must be supplied to create an account on this instance.',
3267
3360
  },
3268
3361
  phoneVerificationRequired: {
3269
3362
  type: 'boolean',
3363
+ description:
3364
+ 'If true, a phone verification token must be supplied to create an account on this instance.',
3270
3365
  },
3271
3366
  availableUserDomains: {
3272
3367
  type: 'array',
3368
+ description:
3369
+ 'List of domain suffixes that can be used in account handles.',
3273
3370
  items: {
3274
3371
  type: 'string',
3275
3372
  },
3276
3373
  },
3277
3374
  links: {
3278
3375
  type: 'ref',
3376
+ description: 'URLs of service policy documents.',
3279
3377
  ref: 'lex:com.atproto.server.describeServer#links',
3280
3378
  },
3281
3379
  },
@@ -3301,7 +3399,8 @@ export const schemaDict = {
3301
3399
  defs: {
3302
3400
  main: {
3303
3401
  type: 'query',
3304
- description: 'Get all invite codes for a given account.',
3402
+ description:
3403
+ 'Get all invite codes for the current account. Requires auth.',
3305
3404
  parameters: {
3306
3405
  type: 'params',
3307
3406
  properties: {
@@ -3312,6 +3411,8 @@ export const schemaDict = {
3312
3411
  createAvailable: {
3313
3412
  type: 'boolean',
3314
3413
  default: true,
3414
+ description:
3415
+ "Controls whether any new 'earned' but not 'created' invites should be created.",
3315
3416
  },
3316
3417
  },
3317
3418
  },
@@ -3345,7 +3446,8 @@ export const schemaDict = {
3345
3446
  defs: {
3346
3447
  main: {
3347
3448
  type: 'query',
3348
- description: 'Get information about the current session.',
3449
+ description:
3450
+ 'Get information about the current auth session. Requires auth.',
3349
3451
  output: {
3350
3452
  encoding: 'application/json',
3351
3453
  schema: {
@@ -3425,7 +3527,8 @@ export const schemaDict = {
3425
3527
  defs: {
3426
3528
  main: {
3427
3529
  type: 'procedure',
3428
- description: 'Refresh an authentication session.',
3530
+ description:
3531
+ "Refresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt').",
3429
3532
  output: {
3430
3533
  encoding: 'application/json',
3431
3534
  schema: {
@@ -3531,7 +3634,8 @@ export const schemaDict = {
3531
3634
  defs: {
3532
3635
  main: {
3533
3636
  type: 'procedure',
3534
- description: 'Reserve a repo signing key for account creation.',
3637
+ description:
3638
+ 'Reserve a repo signing key, for use with account creation. Necessary so that a DID PLC update operation can be constructed during an account migraiton. Public and does not require auth; implemented by PDS. NOTE: this endpoint may change when full account migration is implemented.',
3535
3639
  input: {
3536
3640
  encoding: 'application/json',
3537
3641
  schema: {
@@ -3539,7 +3643,8 @@ export const schemaDict = {
3539
3643
  properties: {
3540
3644
  did: {
3541
3645
  type: 'string',
3542
- description: 'The did to reserve a new did:key for',
3646
+ format: 'did',
3647
+ description: 'The DID to reserve a key for.',
3543
3648
  },
3544
3649
  },
3545
3650
  },
@@ -3552,7 +3657,8 @@ export const schemaDict = {
3552
3657
  properties: {
3553
3658
  signingKey: {
3554
3659
  type: 'string',
3555
- description: 'Public signing key in the form of a did:key.',
3660
+ description:
3661
+ 'The public key for the reserved signing key, in did:key serialization.',
3556
3662
  },
3557
3663
  },
3558
3664
  },
@@ -3659,7 +3765,8 @@ export const schemaDict = {
3659
3765
  defs: {
3660
3766
  main: {
3661
3767
  type: 'query',
3662
- description: 'Get a blob associated with a given repo.',
3768
+ description:
3769
+ 'Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS.',
3663
3770
  parameters: {
3664
3771
  type: 'params',
3665
3772
  required: ['did', 'cid'],
@@ -3667,7 +3774,7 @@ export const schemaDict = {
3667
3774
  did: {
3668
3775
  type: 'string',
3669
3776
  format: 'did',
3670
- description: 'The DID of the repo.',
3777
+ description: 'The DID of the account.',
3671
3778
  },
3672
3779
  cid: {
3673
3780
  type: 'string',
@@ -3688,7 +3795,8 @@ export const schemaDict = {
3688
3795
  defs: {
3689
3796
  main: {
3690
3797
  type: 'query',
3691
- description: 'Get blocks from a given repo.',
3798
+ description:
3799
+ 'Get data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS.',
3692
3800
  parameters: {
3693
3801
  type: 'params',
3694
3802
  required: ['did', 'cids'],
@@ -3783,7 +3891,8 @@ export const schemaDict = {
3783
3891
  defs: {
3784
3892
  main: {
3785
3893
  type: 'query',
3786
- description: 'Get the current commit CID & revision of the repo.',
3894
+ description:
3895
+ 'Get the current commit CID & revision of the specified repo. Does not require auth.',
3787
3896
  parameters: {
3788
3897
  type: 'params',
3789
3898
  required: ['did'],
@@ -3826,7 +3935,7 @@ export const schemaDict = {
3826
3935
  main: {
3827
3936
  type: 'query',
3828
3937
  description:
3829
- 'Get blocks needed for existence or non-existence of record.',
3938
+ 'Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth.',
3830
3939
  parameters: {
3831
3940
  type: 'params',
3832
3941
  required: ['did', 'collection', 'rkey'],
@@ -3842,6 +3951,7 @@ export const schemaDict = {
3842
3951
  },
3843
3952
  rkey: {
3844
3953
  type: 'string',
3954
+ description: 'Record Key',
3845
3955
  },
3846
3956
  commit: {
3847
3957
  type: 'string',
@@ -3863,7 +3973,7 @@ export const schemaDict = {
3863
3973
  main: {
3864
3974
  type: 'query',
3865
3975
  description:
3866
- "Gets the DID's repo, optionally catching up from a specific revision.",
3976
+ "Download a repository export as CAR file. Optionally only a 'diff' since a previous revision. Does not require auth; implemented by PDS.",
3867
3977
  parameters: {
3868
3978
  type: 'params',
3869
3979
  required: ['did'],
@@ -3875,7 +3985,8 @@ export const schemaDict = {
3875
3985
  },
3876
3986
  since: {
3877
3987
  type: 'string',
3878
- description: 'The revision of the repo to catch up from.',
3988
+ description:
3989
+ "The revision ('rev') of the repo to create a diff from.",
3879
3990
  },
3880
3991
  },
3881
3992
  },
@@ -3891,7 +4002,8 @@ export const schemaDict = {
3891
4002
  defs: {
3892
4003
  main: {
3893
4004
  type: 'query',
3894
- description: 'List blob CIDs since some revision.',
4005
+ description:
4006
+ 'List blob CIDso for an account, since some repo revision. Does not require auth; implemented by PDS.',
3895
4007
  parameters: {
3896
4008
  type: 'params',
3897
4009
  required: ['did'],
@@ -3944,7 +4056,8 @@ export const schemaDict = {
3944
4056
  defs: {
3945
4057
  main: {
3946
4058
  type: 'query',
3947
- description: 'List DIDs and root CIDs of hosted repos.',
4059
+ description:
4060
+ 'Enumerates all the DID, rev, and commit CID for all repos hosted by this service. Does not require auth; implemented by PDS and Relay.',
3948
4061
  parameters: {
3949
4062
  type: 'params',
3950
4063
  properties: {
@@ -3990,6 +4103,7 @@ export const schemaDict = {
3990
4103
  head: {
3991
4104
  type: 'string',
3992
4105
  format: 'cid',
4106
+ description: 'Current repo commit CID',
3993
4107
  },
3994
4108
  rev: {
3995
4109
  type: 'string',
@@ -4005,7 +4119,7 @@ export const schemaDict = {
4005
4119
  main: {
4006
4120
  type: 'procedure',
4007
4121
  description:
4008
- 'Notify a crawling service of a recent update; often when a long break between updates causes the connection with the crawling service to break.',
4122
+ 'Notify a crawling service of a recent update, and that crawling should resume. Intended use is after a gap between repo stream events caused the crawling service to disconnect. Does not require auth; implemented by Relay.',
4009
4123
  input: {
4010
4124
  encoding: 'application/json',
4011
4125
  schema: {
@@ -4015,7 +4129,7 @@ export const schemaDict = {
4015
4129
  hostname: {
4016
4130
  type: 'string',
4017
4131
  description:
4018
- 'Hostname of the service that is notifying of update.',
4132
+ 'Hostname of the current service (usually a PDS) that is notifying of update.',
4019
4133
  },
4020
4134
  },
4021
4135
  },
@@ -4029,7 +4143,8 @@ export const schemaDict = {
4029
4143
  defs: {
4030
4144
  main: {
4031
4145
  type: 'procedure',
4032
- description: 'Request a service to persistently crawl hosted repos.',
4146
+ description:
4147
+ 'Request a service to persistently crawl hosted repos. Expected use is new PDS instances declaring their existence to Relays. Does not require auth.',
4033
4148
  input: {
4034
4149
  encoding: 'application/json',
4035
4150
  schema: {
@@ -4039,7 +4154,7 @@ export const schemaDict = {
4039
4154
  hostname: {
4040
4155
  type: 'string',
4041
4156
  description:
4042
- 'Hostname of the service that is requesting to be crawled.',
4157
+ 'Hostname of the current service (eg, PDS) that is requesting to be crawled.',
4043
4158
  },
4044
4159
  },
4045
4160
  },
@@ -4053,13 +4168,14 @@ export const schemaDict = {
4053
4168
  defs: {
4054
4169
  main: {
4055
4170
  type: 'subscription',
4056
- description: 'Subscribe to repo updates.',
4171
+ description:
4172
+ 'Repository event stream, aka Firehose endpoint. Outputs repo commits with diff data, and identity update events, for all repositories on the current server. See the atproto specifications for details around stream sequencing, repo versioning, CAR diff format, and more. Public and does not require auth; implemented by PDS and Relay.',
4057
4173
  parameters: {
4058
4174
  type: 'params',
4059
4175
  properties: {
4060
4176
  cursor: {
4061
4177
  type: 'integer',
4062
- description: 'The last known event to backfill from.',
4178
+ description: 'The last known event seq number to backfill from.',
4063
4179
  },
4064
4180
  },
4065
4181
  },
@@ -4081,11 +4197,15 @@ export const schemaDict = {
4081
4197
  },
4082
4198
  {
4083
4199
  name: 'ConsumerTooSlow',
4200
+ description:
4201
+ 'If the consumer of the stream can not keep up with events, and a backlog gets too large, the server will drop the connection.',
4084
4202
  },
4085
4203
  ],
4086
4204
  },
4087
4205
  commit: {
4088
4206
  type: 'object',
4207
+ description:
4208
+ 'Represents an update of repository state. Note that empty commits are allowed, which include no repo data changes, but an update to rev and signature.',
4089
4209
  required: [
4090
4210
  'seq',
4091
4211
  'rebase',
@@ -4103,34 +4223,45 @@ export const schemaDict = {
4103
4223
  properties: {
4104
4224
  seq: {
4105
4225
  type: 'integer',
4226
+ description: 'The stream sequence number of this message.',
4106
4227
  },
4107
4228
  rebase: {
4108
4229
  type: 'boolean',
4230
+ description: 'DEPRECATED -- unused',
4109
4231
  },
4110
4232
  tooBig: {
4111
4233
  type: 'boolean',
4234
+ description:
4235
+ 'Indicates that this commit contained too many ops, or data size was too large. Consumers will need to make a separate request to get missing data.',
4112
4236
  },
4113
4237
  repo: {
4114
4238
  type: 'string',
4115
4239
  format: 'did',
4240
+ description: 'The repo this event comes from.',
4116
4241
  },
4117
4242
  commit: {
4118
4243
  type: 'cid-link',
4244
+ description: 'Repo commit object CID.',
4119
4245
  },
4120
4246
  prev: {
4121
4247
  type: 'cid-link',
4248
+ description:
4249
+ 'DEPRECATED -- unused. WARNING -- nullable and optional; stick with optional to ensure golang interoperability.',
4122
4250
  },
4123
4251
  rev: {
4124
4252
  type: 'string',
4125
- description: 'The rev of the emitted commit.',
4253
+ description:
4254
+ 'The rev of the emitted commit. Note that this information is also in the commit object included in blocks, unless this is a tooBig event.',
4126
4255
  },
4127
4256
  since: {
4128
4257
  type: 'string',
4129
- description: 'The rev of the last emitted commit from this repo.',
4258
+ description:
4259
+ 'The rev of the last emitted commit from this repo (if any).',
4130
4260
  },
4131
4261
  blocks: {
4132
4262
  type: 'bytes',
4133
- description: 'CAR file containing relevant blocks.',
4263
+ description:
4264
+ 'CAR file containing relevant blocks, as a diff since the previous repo state.',
4134
4265
  maxLength: 1000000,
4135
4266
  },
4136
4267
  ops: {
@@ -4138,6 +4269,8 @@ export const schemaDict = {
4138
4269
  items: {
4139
4270
  type: 'ref',
4140
4271
  ref: 'lex:com.atproto.sync.subscribeRepos#repoOp',
4272
+ description:
4273
+ 'List of repo mutation operations in this commit (eg, records created, updated, or deleted).',
4141
4274
  },
4142
4275
  maxLength: 200,
4143
4276
  },
@@ -4145,16 +4278,22 @@ export const schemaDict = {
4145
4278
  type: 'array',
4146
4279
  items: {
4147
4280
  type: 'cid-link',
4281
+ description:
4282
+ 'List of new blobs (by CID) referenced by records in this commit.',
4148
4283
  },
4149
4284
  },
4150
4285
  time: {
4151
4286
  type: 'string',
4152
4287
  format: 'datetime',
4288
+ description:
4289
+ 'Timestamp of when this message was originally broadcast.',
4153
4290
  },
4154
4291
  },
4155
4292
  },
4156
4293
  handle: {
4157
4294
  type: 'object',
4295
+ description:
4296
+ "Represents an update of the account's handle, or transition to/from invalid state.",
4158
4297
  required: ['seq', 'did', 'handle', 'time'],
4159
4298
  properties: {
4160
4299
  seq: {
@@ -4176,6 +4315,8 @@ export const schemaDict = {
4176
4315
  },
4177
4316
  migrate: {
4178
4317
  type: 'object',
4318
+ description:
4319
+ 'Represents an account moving from one PDS instance to another. NOTE: not implemented; full account migration may introduce a new message instead.',
4179
4320
  required: ['seq', 'did', 'migrateTo', 'time'],
4180
4321
  nullable: ['migrateTo'],
4181
4322
  properties: {
@@ -4197,6 +4338,7 @@ export const schemaDict = {
4197
4338
  },
4198
4339
  tombstone: {
4199
4340
  type: 'object',
4341
+ description: 'Indicates that an account has been deleted.',
4200
4342
  required: ['seq', 'did', 'time'],
4201
4343
  properties: {
4202
4344
  seq: {
@@ -4227,8 +4369,7 @@ export const schemaDict = {
4227
4369
  },
4228
4370
  repoOp: {
4229
4371
  type: 'object',
4230
- description:
4231
- "A repo operation, ie a write of a single record. For creates and updates, CID is the record's CID as of this operation. For deletes, it's null.",
4372
+ description: 'A repo operation, ie a mutation of a single record.',
4232
4373
  required: ['action', 'path', 'cid'],
4233
4374
  nullable: ['cid'],
4234
4375
  properties: {
@@ -4241,6 +4382,8 @@ export const schemaDict = {
4241
4382
  },
4242
4383
  cid: {
4243
4384
  type: 'cid-link',
4385
+ description:
4386
+ 'For creates and updates, the new record CID. For deletions, null.',
4244
4387
  },
4245
4388
  },
4246
4389
  },
@@ -4281,7 +4424,7 @@ export const schemaDict = {
4281
4424
  main: {
4282
4425
  type: 'query',
4283
4426
  description:
4284
- 'Fetch all labels from a labeler created after a certain date.',
4427
+ 'Fetch all labels from a labeler created after a certain date. DEPRECATED: use queryLabels or subscribeLabels instead',
4285
4428
  parameters: {
4286
4429
  type: 'params',
4287
4430
  properties: {
@@ -4397,7 +4540,8 @@ export const schemaDict = {
4397
4540
  defs: {
4398
4541
  main: {
4399
4542
  type: 'procedure',
4400
- description: 'Transfer an account.',
4543
+ description:
4544
+ 'Transfer an account. NOTE: temporary method, necessarily how account migration will be implemented.',
4401
4545
  input: {
4402
4546
  encoding: 'application/json',
4403
4547
  schema: {
@@ -4470,7 +4614,6 @@ export const schemaDict = {
4470
4614
  AppBskyActorDefs: {
4471
4615
  lexicon: 1,
4472
4616
  id: 'app.bsky.actor.defs',
4473
- description: 'A reference to an actor in the network.',
4474
4617
  defs: {
4475
4618
  profileViewBasic: {
4476
4619
  type: 'object',
@@ -4603,6 +4746,8 @@ export const schemaDict = {
4603
4746
  },
4604
4747
  viewerState: {
4605
4748
  type: 'object',
4749
+ description:
4750
+ "Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.",
4606
4751
  properties: {
4607
4752
  muted: {
4608
4753
  type: 'boolean',
@@ -4688,6 +4833,9 @@ export const schemaDict = {
4688
4833
  format: 'at-uri',
4689
4834
  },
4690
4835
  },
4836
+ timelineIndex: {
4837
+ type: 'integer',
4838
+ },
4691
4839
  },
4692
4840
  },
4693
4841
  personalDetailsPref: {
@@ -4772,7 +4920,8 @@ export const schemaDict = {
4772
4920
  defs: {
4773
4921
  main: {
4774
4922
  type: 'query',
4775
- description: 'Get private preferences attached to the account.',
4923
+ description:
4924
+ 'Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.',
4776
4925
  parameters: {
4777
4926
  type: 'params',
4778
4927
  properties: {},
@@ -4799,7 +4948,8 @@ export const schemaDict = {
4799
4948
  defs: {
4800
4949
  main: {
4801
4950
  type: 'query',
4802
- description: 'Get detailed profile view of an actor.',
4951
+ description:
4952
+ 'Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth.',
4803
4953
  parameters: {
4804
4954
  type: 'params',
4805
4955
  required: ['actor'],
@@ -4807,6 +4957,7 @@ export const schemaDict = {
4807
4957
  actor: {
4808
4958
  type: 'string',
4809
4959
  format: 'at-identifier',
4960
+ description: 'Handle or DID of account to fetch profile of.',
4810
4961
  },
4811
4962
  },
4812
4963
  },
@@ -4866,7 +5017,8 @@ export const schemaDict = {
4866
5017
  defs: {
4867
5018
  main: {
4868
5019
  type: 'query',
4869
- description: 'Get a list of suggested actors, used for discovery.',
5020
+ description:
5021
+ 'Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding.',
4870
5022
  parameters: {
4871
5023
  type: 'params',
4872
5024
  properties: {
@@ -4909,7 +5061,7 @@ export const schemaDict = {
4909
5061
  defs: {
4910
5062
  main: {
4911
5063
  type: 'record',
4912
- description: 'A declaration of a profile.',
5064
+ description: 'A declaration of a Bluesky account profile.',
4913
5065
  key: 'literal:self',
4914
5066
  record: {
4915
5067
  type: 'object',
@@ -4921,21 +5073,28 @@ export const schemaDict = {
4921
5073
  },
4922
5074
  description: {
4923
5075
  type: 'string',
5076
+ description: 'Free-form profile description text.',
4924
5077
  maxGraphemes: 256,
4925
5078
  maxLength: 2560,
4926
5079
  },
4927
5080
  avatar: {
4928
5081
  type: 'blob',
5082
+ description:
5083
+ "Small image to be displayed next to posts from account. AKA, 'profile picture'",
4929
5084
  accept: ['image/png', 'image/jpeg'],
4930
5085
  maxSize: 1000000,
4931
5086
  },
4932
5087
  banner: {
4933
5088
  type: 'blob',
5089
+ description:
5090
+ 'Larger horizontal image to display behind profile view.',
4934
5091
  accept: ['image/png', 'image/jpeg'],
4935
5092
  maxSize: 1000000,
4936
5093
  },
4937
5094
  labels: {
4938
5095
  type: 'union',
5096
+ description:
5097
+ 'Self-label values, specific to the Bluesky application, on the overall account.',
4939
5098
  refs: ['lex:com.atproto.label.defs#selfLabels'],
4940
5099
  },
4941
5100
  },
@@ -4972,7 +5131,8 @@ export const schemaDict = {
4972
5131
  defs: {
4973
5132
  main: {
4974
5133
  type: 'query',
4975
- description: 'Find actors (profiles) matching search criteria.',
5134
+ description:
5135
+ 'Find actors (profiles) matching search criteria. Does not require auth.',
4976
5136
  parameters: {
4977
5137
  type: 'params',
4978
5138
  properties: {
@@ -5024,7 +5184,8 @@ export const schemaDict = {
5024
5184
  defs: {
5025
5185
  main: {
5026
5186
  type: 'query',
5027
- description: 'Find actor suggestions for a prefix search term.',
5187
+ description:
5188
+ 'Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth.',
5028
5189
  parameters: {
5029
5190
  type: 'params',
5030
5191
  properties: {
@@ -5066,11 +5227,11 @@ export const schemaDict = {
5066
5227
  AppBskyEmbedExternal: {
5067
5228
  lexicon: 1,
5068
5229
  id: 'app.bsky.embed.external',
5069
- description:
5070
- 'A representation of some externally linked content, embedded in another form of content.',
5071
5230
  defs: {
5072
5231
  main: {
5073
5232
  type: 'object',
5233
+ description:
5234
+ "A representation of some externally linked content (eg, a URL and 'card'), embedded in a Bluesky record (eg, a post).",
5074
5235
  required: ['external'],
5075
5236
  properties: {
5076
5237
  external: {
@@ -5134,7 +5295,7 @@ export const schemaDict = {
5134
5295
  AppBskyEmbedImages: {
5135
5296
  lexicon: 1,
5136
5297
  id: 'app.bsky.embed.images',
5137
- description: 'A set of images embedded in some other form of content.',
5298
+ description: 'A set of images embedded in a Bluesky record (eg, a post).',
5138
5299
  defs: {
5139
5300
  main: {
5140
5301
  type: 'object',
@@ -5161,6 +5322,8 @@ export const schemaDict = {
5161
5322
  },
5162
5323
  alt: {
5163
5324
  type: 'string',
5325
+ description:
5326
+ 'Alt text description of the image, for accessibility.',
5164
5327
  },
5165
5328
  aspectRatio: {
5166
5329
  type: 'ref',
@@ -5204,12 +5367,18 @@ export const schemaDict = {
5204
5367
  properties: {
5205
5368
  thumb: {
5206
5369
  type: 'string',
5370
+ description:
5371
+ 'Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View.',
5207
5372
  },
5208
5373
  fullsize: {
5209
5374
  type: 'string',
5375
+ description:
5376
+ 'Fully-qualified URL where a large version of the image can be fetched. May or may not be the exact original blob. For example, CDN location provided by the App View.',
5210
5377
  },
5211
5378
  alt: {
5212
5379
  type: 'string',
5380
+ description:
5381
+ 'Alt text description of the image, for accessibility.',
5213
5382
  },
5214
5383
  aspectRatio: {
5215
5384
  type: 'ref',
@@ -5223,7 +5392,7 @@ export const schemaDict = {
5223
5392
  lexicon: 1,
5224
5393
  id: 'app.bsky.embed.record',
5225
5394
  description:
5226
- 'A representation of a record embedded in another form of content.',
5395
+ 'A representation of a record embedded in a Bluesky record (eg, a post). For example, a quote-post, or sharing a feed generator record.',
5227
5396
  defs: {
5228
5397
  main: {
5229
5398
  type: 'object',
@@ -5269,6 +5438,7 @@ export const schemaDict = {
5269
5438
  },
5270
5439
  value: {
5271
5440
  type: 'unknown',
5441
+ description: 'The record data itself.',
5272
5442
  },
5273
5443
  labels: {
5274
5444
  type: 'array',
@@ -5333,7 +5503,7 @@ export const schemaDict = {
5333
5503
  lexicon: 1,
5334
5504
  id: 'app.bsky.embed.recordWithMedia',
5335
5505
  description:
5336
- 'A representation of a record embedded in another form of content, alongside other compatible embeds.',
5506
+ 'A representation of a record embedded in a Bluesky record (eg, a post), alongside other compatible embeds. For example, a quote post and image, or a quote post and external URL card.',
5337
5507
  defs: {
5338
5508
  main: {
5339
5509
  type: 'object',
@@ -5432,6 +5602,8 @@ export const schemaDict = {
5432
5602
  },
5433
5603
  viewerState: {
5434
5604
  type: 'object',
5605
+ description:
5606
+ "Metadata about the requesting account's relationship with the subject content. Only has meaningful content for authed requests.",
5435
5607
  properties: {
5436
5608
  repost: {
5437
5609
  type: 'string',
@@ -5692,7 +5864,7 @@ export const schemaDict = {
5692
5864
  main: {
5693
5865
  type: 'query',
5694
5866
  description:
5695
- 'Get information about a feed generator, including policies and offered feed URIs.',
5867
+ 'Get information about a feed generator, including policies and offered feed URIs. Does not require auth; implemented by Feed Generator services (not App View).',
5696
5868
  output: {
5697
5869
  encoding: 'application/json',
5698
5870
  schema: {
@@ -5747,7 +5919,8 @@ export const schemaDict = {
5747
5919
  defs: {
5748
5920
  main: {
5749
5921
  type: 'record',
5750
- description: 'A declaration of the existence of a feed generator.',
5922
+ description:
5923
+ 'Record declaring of the existence of a feed generator, and containing metadata about it. The record can exist in any repository.',
5751
5924
  key: 'any',
5752
5925
  record: {
5753
5926
  type: 'object',
@@ -5781,6 +5954,7 @@ export const schemaDict = {
5781
5954
  },
5782
5955
  labels: {
5783
5956
  type: 'union',
5957
+ description: 'Self-label values',
5784
5958
  refs: ['lex:com.atproto.label.defs#selfLabels'],
5785
5959
  },
5786
5960
  createdAt: {
@@ -5798,7 +5972,8 @@ export const schemaDict = {
5798
5972
  defs: {
5799
5973
  main: {
5800
5974
  type: 'query',
5801
- description: 'Get a list of feeds created by the actor.',
5975
+ description:
5976
+ "Get a list of feeds (feed generator records) created by the actor (in the actor's repo).",
5802
5977
  parameters: {
5803
5978
  type: 'params',
5804
5979
  required: ['actor'],
@@ -5846,7 +6021,8 @@ export const schemaDict = {
5846
6021
  defs: {
5847
6022
  main: {
5848
6023
  type: 'query',
5849
- description: 'Get a list of posts liked by an actor.',
6024
+ description:
6025
+ 'Get a list of posts liked by an actor. Does not require auth.',
5850
6026
  parameters: {
5851
6027
  type: 'params',
5852
6028
  required: ['actor'],
@@ -5902,7 +6078,8 @@ export const schemaDict = {
5902
6078
  defs: {
5903
6079
  main: {
5904
6080
  type: 'query',
5905
- description: "Get a view of an actor's feed.",
6081
+ description:
6082
+ "Get a view of an actor's 'author feed' (post and reposts by the author). Does not require auth.",
5906
6083
  parameters: {
5907
6084
  type: 'params',
5908
6085
  required: ['actor'],
@@ -5922,6 +6099,8 @@ export const schemaDict = {
5922
6099
  },
5923
6100
  filter: {
5924
6101
  type: 'string',
6102
+ description:
6103
+ 'Combinations of post/repost types to include in response.',
5925
6104
  knownValues: [
5926
6105
  'posts_with_replies',
5927
6106
  'posts_no_replies',
@@ -5969,7 +6148,7 @@ export const schemaDict = {
5969
6148
  main: {
5970
6149
  type: 'query',
5971
6150
  description:
5972
- "Get a hydrated feed from an actor's selected feed generator.",
6151
+ "Get a hydrated feed from an actor's selected feed generator. Implemented by App View.",
5973
6152
  parameters: {
5974
6153
  type: 'params',
5975
6154
  required: ['feed'],
@@ -6022,7 +6201,8 @@ export const schemaDict = {
6022
6201
  defs: {
6023
6202
  main: {
6024
6203
  type: 'query',
6025
- description: 'Get information about a feed generator.',
6204
+ description:
6205
+ 'Get information about a feed generator. Implemented by AppView.',
6026
6206
  parameters: {
6027
6207
  type: 'params',
6028
6208
  required: ['feed'],
@@ -6030,6 +6210,7 @@ export const schemaDict = {
6030
6210
  feed: {
6031
6211
  type: 'string',
6032
6212
  format: 'at-uri',
6213
+ description: 'AT-URI of the feed generator record.',
6033
6214
  },
6034
6215
  },
6035
6216
  },
@@ -6045,9 +6226,13 @@ export const schemaDict = {
6045
6226
  },
6046
6227
  isOnline: {
6047
6228
  type: 'boolean',
6229
+ description:
6230
+ 'Indicates whether the feed generator service has been online recently, or else seems to be inactive.',
6048
6231
  },
6049
6232
  isValid: {
6050
6233
  type: 'boolean',
6234
+ description:
6235
+ 'Indicates whether the feed generator service is compatible with the record declaration.',
6051
6236
  },
6052
6237
  },
6053
6238
  },
@@ -6100,7 +6285,8 @@ export const schemaDict = {
6100
6285
  defs: {
6101
6286
  main: {
6102
6287
  type: 'query',
6103
- description: 'Get a skeleton of a feed provided by a feed generator.',
6288
+ description:
6289
+ 'Get a skeleton of a feed provided by a feed generator. Auth is optional, depending on provider requirements, and provides the DID of the requester. Implemented by Feed Generator Service.',
6104
6290
  parameters: {
6105
6291
  type: 'params',
6106
6292
  required: ['feed'],
@@ -6108,6 +6294,8 @@ export const schemaDict = {
6108
6294
  feed: {
6109
6295
  type: 'string',
6110
6296
  format: 'at-uri',
6297
+ description:
6298
+ 'Reference to feed generator record describing the specific feed being requested.',
6111
6299
  },
6112
6300
  limit: {
6113
6301
  type: 'integer',
@@ -6153,7 +6341,8 @@ export const schemaDict = {
6153
6341
  defs: {
6154
6342
  main: {
6155
6343
  type: 'query',
6156
- description: 'Get the list of likes.',
6344
+ description:
6345
+ 'Get like records which reference a subject (by AT-URI and CID).',
6157
6346
  parameters: {
6158
6347
  type: 'params',
6159
6348
  required: ['uri'],
@@ -6161,10 +6350,13 @@ export const schemaDict = {
6161
6350
  uri: {
6162
6351
  type: 'string',
6163
6352
  format: 'at-uri',
6353
+ description: 'AT-URI of the subject (eg, a post record).',
6164
6354
  },
6165
6355
  cid: {
6166
6356
  type: 'string',
6167
6357
  format: 'cid',
6358
+ description:
6359
+ 'CID of the subject record (aka, specific version of record), to filter likes.',
6168
6360
  },
6169
6361
  limit: {
6170
6362
  type: 'integer',
@@ -6231,7 +6423,8 @@ export const schemaDict = {
6231
6423
  defs: {
6232
6424
  main: {
6233
6425
  type: 'query',
6234
- description: 'Get a view of a recent posts from actors in a list.',
6426
+ description:
6427
+ 'Get a feed of recent posts from a list (posts and reposts from any actors on the list). Does not require auth.',
6235
6428
  parameters: {
6236
6429
  type: 'params',
6237
6430
  required: ['list'],
@@ -6239,6 +6432,7 @@ export const schemaDict = {
6239
6432
  list: {
6240
6433
  type: 'string',
6241
6434
  format: 'at-uri',
6435
+ description: 'Reference (AT-URI) to the list record.',
6242
6436
  },
6243
6437
  limit: {
6244
6438
  type: 'integer',
@@ -6284,7 +6478,8 @@ export const schemaDict = {
6284
6478
  defs: {
6285
6479
  main: {
6286
6480
  type: 'query',
6287
- description: 'Get posts in a thread.',
6481
+ description:
6482
+ 'Get posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests.',
6288
6483
  parameters: {
6289
6484
  type: 'params',
6290
6485
  required: ['uri'],
@@ -6292,15 +6487,20 @@ export const schemaDict = {
6292
6487
  uri: {
6293
6488
  type: 'string',
6294
6489
  format: 'at-uri',
6490
+ description: 'Reference (AT-URI) to post record.',
6295
6491
  },
6296
6492
  depth: {
6297
6493
  type: 'integer',
6494
+ description:
6495
+ 'How many levels of reply depth should be included in response.',
6298
6496
  default: 6,
6299
6497
  minimum: 0,
6300
6498
  maximum: 1000,
6301
6499
  },
6302
6500
  parentHeight: {
6303
6501
  type: 'integer',
6502
+ description:
6503
+ 'How many levels of parent (and grandparent, etc) post to include.',
6304
6504
  default: 80,
6305
6505
  minimum: 0,
6306
6506
  maximum: 1000,
@@ -6338,13 +6538,15 @@ export const schemaDict = {
6338
6538
  defs: {
6339
6539
  main: {
6340
6540
  type: 'query',
6341
- description: "Get a view of an actor's feed.",
6541
+ description:
6542
+ "Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'.",
6342
6543
  parameters: {
6343
6544
  type: 'params',
6344
6545
  required: ['uris'],
6345
6546
  properties: {
6346
6547
  uris: {
6347
6548
  type: 'array',
6549
+ description: 'List of post AT-URIs to return hydrated views for.',
6348
6550
  items: {
6349
6551
  type: 'string',
6350
6552
  format: 'at-uri',
@@ -6378,7 +6580,7 @@ export const schemaDict = {
6378
6580
  defs: {
6379
6581
  main: {
6380
6582
  type: 'query',
6381
- description: 'Get a list of reposts.',
6583
+ description: 'Get a list of reposts for a given post.',
6382
6584
  parameters: {
6383
6585
  type: 'params',
6384
6586
  required: ['uri'],
@@ -6386,10 +6588,13 @@ export const schemaDict = {
6386
6588
  uri: {
6387
6589
  type: 'string',
6388
6590
  format: 'at-uri',
6591
+ description: 'Reference (AT-URI) of post record',
6389
6592
  },
6390
6593
  cid: {
6391
6594
  type: 'string',
6392
6595
  format: 'cid',
6596
+ description:
6597
+ 'If supplied, filters to reposts of specific version (by CID) of the post record.',
6393
6598
  },
6394
6599
  limit: {
6395
6600
  type: 'integer',
@@ -6438,7 +6643,8 @@ export const schemaDict = {
6438
6643
  defs: {
6439
6644
  main: {
6440
6645
  type: 'query',
6441
- description: 'Get a list of suggested feeds for the viewer.',
6646
+ description:
6647
+ 'Get a list of suggested feeds (feed generators) for the requesting account.',
6442
6648
  parameters: {
6443
6649
  type: 'params',
6444
6650
  properties: {
@@ -6481,12 +6687,15 @@ export const schemaDict = {
6481
6687
  defs: {
6482
6688
  main: {
6483
6689
  type: 'query',
6484
- description: "Get a view of the actor's home timeline.",
6690
+ description:
6691
+ "Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed.",
6485
6692
  parameters: {
6486
6693
  type: 'params',
6487
6694
  properties: {
6488
6695
  algorithm: {
6489
6696
  type: 'string',
6697
+ description:
6698
+ "Variant 'algorithm' for timeline. Implementation-specific. NOTE: most feed flexibility has been moved to feed generator mechanism.",
6490
6699
  },
6491
6700
  limit: {
6492
6701
  type: 'integer',
@@ -6527,7 +6736,7 @@ export const schemaDict = {
6527
6736
  defs: {
6528
6737
  main: {
6529
6738
  type: 'record',
6530
- description: 'A declaration of a like.',
6739
+ description: "Record declaring a 'like' of a piece of subject content.",
6531
6740
  key: 'tid',
6532
6741
  record: {
6533
6742
  type: 'object',
@@ -6552,7 +6761,7 @@ export const schemaDict = {
6552
6761
  defs: {
6553
6762
  main: {
6554
6763
  type: 'record',
6555
- description: 'A declaration of a post.',
6764
+ description: 'Record containing a Bluesky post.',
6556
6765
  key: 'tid',
6557
6766
  record: {
6558
6767
  type: 'object',
@@ -6562,10 +6771,12 @@ export const schemaDict = {
6562
6771
  type: 'string',
6563
6772
  maxLength: 3000,
6564
6773
  maxGraphemes: 300,
6774
+ description:
6775
+ 'The primary post content. May be an empty string, if there are embeds.',
6565
6776
  },
6566
6777
  entities: {
6567
6778
  type: 'array',
6568
- description: 'Deprecated: replaced by app.bsky.richtext.facet.',
6779
+ description: 'DEPRECATED: replaced by app.bsky.richtext.facet.',
6569
6780
  items: {
6570
6781
  type: 'ref',
6571
6782
  ref: 'lex:app.bsky.feed.post#entity',
@@ -6573,6 +6784,8 @@ export const schemaDict = {
6573
6784
  },
6574
6785
  facets: {
6575
6786
  type: 'array',
6787
+ description:
6788
+ 'Annotations of text (mentions, URLs, hashtags, etc)',
6576
6789
  items: {
6577
6790
  type: 'ref',
6578
6791
  ref: 'lex:app.bsky.richtext.facet',
@@ -6593,6 +6806,8 @@ export const schemaDict = {
6593
6806
  },
6594
6807
  langs: {
6595
6808
  type: 'array',
6809
+ description:
6810
+ 'Indicates human language of post primary text content.',
6596
6811
  maxLength: 3,
6597
6812
  items: {
6598
6813
  type: 'string',
@@ -6601,21 +6816,25 @@ export const schemaDict = {
6601
6816
  },
6602
6817
  labels: {
6603
6818
  type: 'union',
6819
+ description:
6820
+ 'Self-label values for this post. Effectively content warnings.',
6604
6821
  refs: ['lex:com.atproto.label.defs#selfLabels'],
6605
6822
  },
6606
6823
  tags: {
6607
6824
  type: 'array',
6825
+ description: 'Additional non-inline tags describing this post.',
6608
6826
  maxLength: 8,
6609
6827
  items: {
6610
6828
  type: 'string',
6611
6829
  maxLength: 640,
6612
6830
  maxGraphemes: 64,
6613
6831
  },
6614
- description: 'Additional non-inline tags describing this post.',
6615
6832
  },
6616
6833
  createdAt: {
6617
6834
  type: 'string',
6618
6835
  format: 'datetime',
6836
+ description:
6837
+ 'Client-declared timestamp when this post was originally created.',
6619
6838
  },
6620
6839
  },
6621
6840
  },
@@ -6675,7 +6894,8 @@ export const schemaDict = {
6675
6894
  id: 'app.bsky.feed.repost',
6676
6895
  defs: {
6677
6896
  main: {
6678
- description: 'A declaration of a repost.',
6897
+ description:
6898
+ "Record representing a 'repost' of an existing Bluesky post.",
6679
6899
  type: 'record',
6680
6900
  key: 'tid',
6681
6901
  record: {
@@ -6701,7 +6921,8 @@ export const schemaDict = {
6701
6921
  defs: {
6702
6922
  main: {
6703
6923
  type: 'query',
6704
- description: 'Find posts matching search criteria.',
6924
+ description:
6925
+ 'Find posts matching search criteria, returning views of those posts.',
6705
6926
  parameters: {
6706
6927
  type: 'params',
6707
6928
  required: ['q'],
@@ -6764,7 +6985,7 @@ export const schemaDict = {
6764
6985
  type: 'record',
6765
6986
  key: 'tid',
6766
6987
  description:
6767
- "Defines interaction gating rules for a thread. The rkey of the threadgate record should match the rkey of the thread's root post.",
6988
+ "Record defining interaction gating rules for a thread (aka, reply controls). The record key (rkey) of the threadgate record must match the record key of the thread's root post, and that record must be in the same repository..",
6768
6989
  record: {
6769
6990
  type: 'object',
6770
6991
  required: ['post', 'createdAt'],
@@ -6772,6 +6993,7 @@ export const schemaDict = {
6772
6993
  post: {
6773
6994
  type: 'string',
6774
6995
  format: 'at-uri',
6996
+ description: 'Reference (AT-URI) to the post record.',
6775
6997
  },
6776
6998
  allow: {
6777
6999
  type: 'array',
@@ -6821,7 +7043,8 @@ export const schemaDict = {
6821
7043
  defs: {
6822
7044
  main: {
6823
7045
  type: 'record',
6824
- description: 'A declaration of a block.',
7046
+ description:
7047
+ "Record declaring a 'block' relationship against another account. NOTE: blocks are public in Bluesky; see blog posts for details.",
6825
7048
  key: 'tid',
6826
7049
  record: {
6827
7050
  type: 'object',
@@ -6830,6 +7053,7 @@ export const schemaDict = {
6830
7053
  subject: {
6831
7054
  type: 'string',
6832
7055
  format: 'did',
7056
+ description: 'DID of the account to be blocked.',
6833
7057
  },
6834
7058
  createdAt: {
6835
7059
  type: 'string',
@@ -7018,7 +7242,8 @@ export const schemaDict = {
7018
7242
  defs: {
7019
7243
  main: {
7020
7244
  type: 'record',
7021
- description: 'A declaration of a social follow.',
7245
+ description:
7246
+ "Record declaring a social 'follow' relationship of another account. Duplicate follows will be ignored by the AppView.",
7022
7247
  key: 'tid',
7023
7248
  record: {
7024
7249
  type: 'object',
@@ -7043,7 +7268,8 @@ export const schemaDict = {
7043
7268
  defs: {
7044
7269
  main: {
7045
7270
  type: 'query',
7046
- description: 'Get a list of who the actor is blocking.',
7271
+ description:
7272
+ 'Enumerates which accounts the requesting account is currently blocking. Requires auth.',
7047
7273
  parameters: {
7048
7274
  type: 'params',
7049
7275
  properties: {
@@ -7086,7 +7312,8 @@ export const schemaDict = {
7086
7312
  defs: {
7087
7313
  main: {
7088
7314
  type: 'query',
7089
- description: "Get a list of an actor's followers.",
7315
+ description:
7316
+ 'Enumerates accounts which follow a specified account (actor).',
7090
7317
  parameters: {
7091
7318
  type: 'params',
7092
7319
  required: ['actor'],
@@ -7138,7 +7365,8 @@ export const schemaDict = {
7138
7365
  defs: {
7139
7366
  main: {
7140
7367
  type: 'query',
7141
- description: 'Get a list of who the actor follows.',
7368
+ description:
7369
+ 'Enumerates accounts which a specified account (actor) follows.',
7142
7370
  parameters: {
7143
7371
  type: 'params',
7144
7372
  required: ['actor'],
@@ -7190,7 +7418,8 @@ export const schemaDict = {
7190
7418
  defs: {
7191
7419
  main: {
7192
7420
  type: 'query',
7193
- description: 'Get a list of actors.',
7421
+ description:
7422
+ "Gets a 'view' (with additional context) of a specified list.",
7194
7423
  parameters: {
7195
7424
  type: 'params',
7196
7425
  required: ['list'],
@@ -7198,6 +7427,7 @@ export const schemaDict = {
7198
7427
  list: {
7199
7428
  type: 'string',
7200
7429
  format: 'at-uri',
7430
+ description: 'Reference (AT-URI) of the list record to hydrate.',
7201
7431
  },
7202
7432
  limit: {
7203
7433
  type: 'integer',
@@ -7242,7 +7472,8 @@ export const schemaDict = {
7242
7472
  defs: {
7243
7473
  main: {
7244
7474
  type: 'query',
7245
- description: 'Get lists that the actor is blocking.',
7475
+ description:
7476
+ 'Get mod lists that the requesting account (actor) is blocking. Requires auth.',
7246
7477
  parameters: {
7247
7478
  type: 'params',
7248
7479
  properties: {
@@ -7285,7 +7516,8 @@ export const schemaDict = {
7285
7516
  defs: {
7286
7517
  main: {
7287
7518
  type: 'query',
7288
- description: 'Get lists that the actor is muting.',
7519
+ description:
7520
+ 'Enumerates mod lists that the requesting account (actor) currently has muted. Requires auth.',
7289
7521
  parameters: {
7290
7522
  type: 'params',
7291
7523
  properties: {
@@ -7328,7 +7560,8 @@ export const schemaDict = {
7328
7560
  defs: {
7329
7561
  main: {
7330
7562
  type: 'query',
7331
- description: 'Get a list of lists that belong to an actor.',
7563
+ description:
7564
+ 'Enumerates the lists created by a specified account (actor).',
7332
7565
  parameters: {
7333
7566
  type: 'params',
7334
7567
  required: ['actor'],
@@ -7336,6 +7569,7 @@ export const schemaDict = {
7336
7569
  actor: {
7337
7570
  type: 'string',
7338
7571
  format: 'at-identifier',
7572
+ description: 'The account (actor) to enumerate lists from.',
7339
7573
  },
7340
7574
  limit: {
7341
7575
  type: 'integer',
@@ -7376,7 +7610,8 @@ export const schemaDict = {
7376
7610
  defs: {
7377
7611
  main: {
7378
7612
  type: 'query',
7379
- description: 'Get a list of who the actor mutes.',
7613
+ description:
7614
+ 'Enumerates accounts that the requesting account (actor) currently has muted. Requires auth.',
7380
7615
  parameters: {
7381
7616
  type: 'params',
7382
7617
  properties: {
@@ -7420,7 +7655,7 @@ export const schemaDict = {
7420
7655
  main: {
7421
7656
  type: 'query',
7422
7657
  description:
7423
- 'Enumerates public relationships between one account, and a list of other accounts',
7658
+ 'Enumerates public relationships between one account, and a list of other accounts. Does not require auth.',
7424
7659
  parameters: {
7425
7660
  type: 'params',
7426
7661
  required: ['actor'],
@@ -7428,9 +7663,12 @@ export const schemaDict = {
7428
7663
  actor: {
7429
7664
  type: 'string',
7430
7665
  format: 'at-identifier',
7666
+ description: 'Primary account requesting relationships for.',
7431
7667
  },
7432
7668
  others: {
7433
7669
  type: 'array',
7670
+ description:
7671
+ "List of 'other' accounts to be related back to the primary.",
7434
7672
  maxLength: 30,
7435
7673
  items: {
7436
7674
  type: 'string',
@@ -7478,7 +7716,8 @@ export const schemaDict = {
7478
7716
  defs: {
7479
7717
  main: {
7480
7718
  type: 'query',
7481
- description: 'Get suggested follows related to a given actor.',
7719
+ description:
7720
+ 'Enumerates follows similar to a given account (actor). Expected use is to recommend additional accounts immediately after following one account.',
7482
7721
  parameters: {
7483
7722
  type: 'params',
7484
7723
  required: ['actor'],
@@ -7514,7 +7753,8 @@ export const schemaDict = {
7514
7753
  defs: {
7515
7754
  main: {
7516
7755
  type: 'record',
7517
- description: 'A declaration of a list of actors.',
7756
+ description:
7757
+ 'Record representing a list of accounts (actors). Scope includes both moderation-oriented lists and curration-oriented lists.',
7518
7758
  key: 'tid',
7519
7759
  record: {
7520
7760
  type: 'object',
@@ -7522,12 +7762,15 @@ export const schemaDict = {
7522
7762
  properties: {
7523
7763
  purpose: {
7524
7764
  type: 'ref',
7765
+ description:
7766
+ 'Defines the purpose of the list (aka, moderation-oriented or curration-oriented)',
7525
7767
  ref: 'lex:app.bsky.graph.defs#listPurpose',
7526
7768
  },
7527
7769
  name: {
7528
7770
  type: 'string',
7529
7771
  maxLength: 64,
7530
7772
  minLength: 1,
7773
+ description: 'Display name for list; can not be empty.',
7531
7774
  },
7532
7775
  description: {
7533
7776
  type: 'string',
@@ -7565,7 +7808,8 @@ export const schemaDict = {
7565
7808
  defs: {
7566
7809
  main: {
7567
7810
  type: 'record',
7568
- description: 'A block of an entire list of actors.',
7811
+ description:
7812
+ 'Record representing a block relationship against an entire an entire list of accounts (actors).',
7569
7813
  key: 'tid',
7570
7814
  record: {
7571
7815
  type: 'object',
@@ -7574,6 +7818,7 @@ export const schemaDict = {
7574
7818
  subject: {
7575
7819
  type: 'string',
7576
7820
  format: 'at-uri',
7821
+ description: 'Reference (AT-URI) to the mod list record.',
7577
7822
  },
7578
7823
  createdAt: {
7579
7824
  type: 'string',
@@ -7590,7 +7835,8 @@ export const schemaDict = {
7590
7835
  defs: {
7591
7836
  main: {
7592
7837
  type: 'record',
7593
- description: 'An item under a declared list of actors.',
7838
+ description:
7839
+ "Record representing an account's inclusion on a specific list. The AppView will ignore duplicate listitem records.",
7594
7840
  key: 'tid',
7595
7841
  record: {
7596
7842
  type: 'object',
@@ -7599,10 +7845,13 @@ export const schemaDict = {
7599
7845
  subject: {
7600
7846
  type: 'string',
7601
7847
  format: 'did',
7848
+ description: 'The account which is included on the list.',
7602
7849
  },
7603
7850
  list: {
7604
7851
  type: 'string',
7605
7852
  format: 'at-uri',
7853
+ description:
7854
+ 'Reference (AT-URI) to the list record (app.bsky.graph.list).',
7606
7855
  },
7607
7856
  createdAt: {
7608
7857
  type: 'string',
@@ -7619,7 +7868,8 @@ export const schemaDict = {
7619
7868
  defs: {
7620
7869
  main: {
7621
7870
  type: 'procedure',
7622
- description: 'Mute an actor by DID or handle.',
7871
+ description:
7872
+ 'Creates a mute relationship for the specified account. Mutes are private in Bluesky. Requires auth.',
7623
7873
  input: {
7624
7874
  encoding: 'application/json',
7625
7875
  schema: {
@@ -7642,7 +7892,8 @@ export const schemaDict = {
7642
7892
  defs: {
7643
7893
  main: {
7644
7894
  type: 'procedure',
7645
- description: 'Mute a list of actors.',
7895
+ description:
7896
+ 'Creates a mute relationship for the specified list of accounts. Mutes are private in Bluesky. Requires auth.',
7646
7897
  input: {
7647
7898
  encoding: 'application/json',
7648
7899
  schema: {
@@ -7665,7 +7916,7 @@ export const schemaDict = {
7665
7916
  defs: {
7666
7917
  main: {
7667
7918
  type: 'procedure',
7668
- description: 'Unmute an actor by DID or handle.',
7919
+ description: 'Unmutes the specified account. Requires auth.',
7669
7920
  input: {
7670
7921
  encoding: 'application/json',
7671
7922
  schema: {
@@ -7688,7 +7939,7 @@ export const schemaDict = {
7688
7939
  defs: {
7689
7940
  main: {
7690
7941
  type: 'procedure',
7691
- description: 'Unmute a list of actors.',
7942
+ description: 'Unmutes the specified list of accounts. Requires auth.',
7692
7943
  input: {
7693
7944
  encoding: 'application/json',
7694
7945
  schema: {
@@ -7711,7 +7962,8 @@ export const schemaDict = {
7711
7962
  defs: {
7712
7963
  main: {
7713
7964
  type: 'query',
7714
- description: 'Get the count of unread notifications.',
7965
+ description:
7966
+ 'Count the number of unread notifications for the requesting account. Requires auth.',
7715
7967
  parameters: {
7716
7968
  type: 'params',
7717
7969
  properties: {
@@ -7742,7 +7994,8 @@ export const schemaDict = {
7742
7994
  defs: {
7743
7995
  main: {
7744
7996
  type: 'query',
7745
- description: 'Get a list of notifications.',
7997
+ description:
7998
+ 'Enumerate notifications for the requesting account. Requires auth.',
7746
7999
  parameters: {
7747
8000
  type: 'params',
7748
8001
  properties: {
@@ -7853,7 +8106,8 @@ export const schemaDict = {
7853
8106
  defs: {
7854
8107
  main: {
7855
8108
  type: 'procedure',
7856
- description: 'Register for push notifications with a service.',
8109
+ description:
8110
+ 'Register to receive push notifications, via a specified service, for the requesting account. Requires auth.',
7857
8111
  input: {
7858
8112
  encoding: 'application/json',
7859
8113
  schema: {
@@ -7886,7 +8140,8 @@ export const schemaDict = {
7886
8140
  defs: {
7887
8141
  main: {
7888
8142
  type: 'procedure',
7889
- description: 'Notify server that the user has seen notifications.',
8143
+ description:
8144
+ 'Notify server that the requesting account has seen notifications. Requires auth.',
7890
8145
  input: {
7891
8146
  encoding: 'application/json',
7892
8147
  schema: {
@@ -7909,6 +8164,7 @@ export const schemaDict = {
7909
8164
  defs: {
7910
8165
  main: {
7911
8166
  type: 'object',
8167
+ description: 'Annotation of a sub-string within rich text.',
7912
8168
  required: ['index', 'features'],
7913
8169
  properties: {
7914
8170
  index: {
@@ -7930,7 +8186,8 @@ export const schemaDict = {
7930
8186
  },
7931
8187
  mention: {
7932
8188
  type: 'object',
7933
- description: 'A facet feature for actor mentions.',
8189
+ description:
8190
+ "Facet feature for mention of another account. The text is usually a handle, including a '@' prefix, but the facet reference is a DID.",
7934
8191
  required: ['did'],
7935
8192
  properties: {
7936
8193
  did: {
@@ -7941,7 +8198,8 @@ export const schemaDict = {
7941
8198
  },
7942
8199
  link: {
7943
8200
  type: 'object',
7944
- description: 'A facet feature for links.',
8201
+ description:
8202
+ 'Facet feature for a URL. The text URL may have been simplified or truncated, but the facet reference should be a complete URL.',
7945
8203
  required: ['uri'],
7946
8204
  properties: {
7947
8205
  uri: {
@@ -7952,7 +8210,8 @@ export const schemaDict = {
7952
8210
  },
7953
8211
  tag: {
7954
8212
  type: 'object',
7955
- description: 'A hashtag.',
8213
+ description:
8214
+ "Facet feature for a hashtag. The text usually includes a '#' prefix, but the facet reference should not (except in the case of 'double hash tags').",
7956
8215
  required: ['tag'],
7957
8216
  properties: {
7958
8217
  tag: {
@@ -7965,7 +8224,7 @@ export const schemaDict = {
7965
8224
  byteSlice: {
7966
8225
  type: 'object',
7967
8226
  description:
7968
- 'A text segment. Start is inclusive, end is exclusive. Indices are for utf8-encoded strings.',
8227
+ 'Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text. NOTE: some languages, like Javascript, use UTF-16 or Unicode codepoints for string slice indexing; in these languages, convert to byte arrays before working with facets.',
7969
8228
  required: ['byteStart', 'byteEnd'],
7970
8229
  properties: {
7971
8230
  byteStart: {
@@ -8100,55 +8359,6 @@ export const schemaDict = {
8100
8359
  },
8101
8360
  },
8102
8361
  },
8103
- AppBskyUnspeccedGetTimelineSkeleton: {
8104
- lexicon: 1,
8105
- id: 'app.bsky.unspecced.getTimelineSkeleton',
8106
- defs: {
8107
- main: {
8108
- type: 'query',
8109
- description:
8110
- 'DEPRECATED: a skeleton of a timeline. Unspecced and will be unavailable soon.',
8111
- parameters: {
8112
- type: 'params',
8113
- properties: {
8114
- limit: {
8115
- type: 'integer',
8116
- minimum: 1,
8117
- maximum: 100,
8118
- default: 50,
8119
- },
8120
- cursor: {
8121
- type: 'string',
8122
- },
8123
- },
8124
- },
8125
- output: {
8126
- encoding: 'application/json',
8127
- schema: {
8128
- type: 'object',
8129
- required: ['feed'],
8130
- properties: {
8131
- cursor: {
8132
- type: 'string',
8133
- },
8134
- feed: {
8135
- type: 'array',
8136
- items: {
8137
- type: 'ref',
8138
- ref: 'lex:app.bsky.feed.defs#skeletonFeedPost',
8139
- },
8140
- },
8141
- },
8142
- },
8143
- },
8144
- errors: [
8145
- {
8146
- name: 'UnknownFeed',
8147
- },
8148
- ],
8149
- },
8150
- },
8151
- },
8152
8362
  AppBskyUnspeccedSearchActorsSkeleton: {
8153
8363
  lexicon: 1,
8154
8364
  id: 'app.bsky.unspecced.searchActorsSkeleton',
@@ -8438,7 +8648,6 @@ export const ids = {
8438
8648
  'app.bsky.unspecced.getPopularFeedGenerators',
8439
8649
  AppBskyUnspeccedGetTaggedSuggestions:
8440
8650
  'app.bsky.unspecced.getTaggedSuggestions',
8441
- AppBskyUnspeccedGetTimelineSkeleton: 'app.bsky.unspecced.getTimelineSkeleton',
8442
8651
  AppBskyUnspeccedSearchActorsSkeleton:
8443
8652
  'app.bsky.unspecced.searchActorsSkeleton',
8444
8653
  AppBskyUnspeccedSearchPostsSkeleton: 'app.bsky.unspecced.searchPostsSkeleton',