@atproto/ozone 0.0.8 → 0.0.9

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 (230) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/dist/db/index.js +280 -15
  3. package/dist/db/index.js.map +3 -3
  4. package/dist/index.js +875 -402
  5. package/dist/index.js.map +3 -3
  6. package/dist/lexicon/lexicons.d.ts +96 -5
  7. package/dist/lexicon/types/app/bsky/actor/defs.d.ts +1 -0
  8. package/dist/lexicon/types/app/bsky/actor/getPreferences.d.ts +2 -2
  9. package/dist/lexicon/types/app/bsky/actor/getProfile.d.ts +2 -2
  10. package/dist/lexicon/types/app/bsky/actor/getProfiles.d.ts +2 -2
  11. package/dist/lexicon/types/app/bsky/actor/getSuggestions.d.ts +2 -2
  12. package/dist/lexicon/types/app/bsky/actor/searchActors.d.ts +2 -2
  13. package/dist/lexicon/types/app/bsky/actor/searchActorsTypeahead.d.ts +2 -2
  14. package/dist/lexicon/types/app/bsky/feed/describeFeedGenerator.d.ts +2 -2
  15. package/dist/lexicon/types/app/bsky/feed/getActorFeeds.d.ts +2 -2
  16. package/dist/lexicon/types/app/bsky/feed/getActorLikes.d.ts +2 -2
  17. package/dist/lexicon/types/app/bsky/feed/getAuthorFeed.d.ts +2 -2
  18. package/dist/lexicon/types/app/bsky/feed/getFeed.d.ts +2 -2
  19. package/dist/lexicon/types/app/bsky/feed/getFeedGenerator.d.ts +2 -2
  20. package/dist/lexicon/types/app/bsky/feed/getFeedGenerators.d.ts +2 -2
  21. package/dist/lexicon/types/app/bsky/feed/getFeedSkeleton.d.ts +2 -2
  22. package/dist/lexicon/types/app/bsky/feed/getLikes.d.ts +2 -2
  23. package/dist/lexicon/types/app/bsky/feed/getListFeed.d.ts +2 -2
  24. package/dist/lexicon/types/app/bsky/feed/getPostThread.d.ts +2 -2
  25. package/dist/lexicon/types/app/bsky/feed/getPosts.d.ts +2 -2
  26. package/dist/lexicon/types/app/bsky/feed/getRepostedBy.d.ts +2 -2
  27. package/dist/lexicon/types/app/bsky/feed/getSuggestedFeeds.d.ts +2 -2
  28. package/dist/lexicon/types/app/bsky/feed/getTimeline.d.ts +2 -2
  29. package/dist/lexicon/types/app/bsky/feed/searchPosts.d.ts +2 -2
  30. package/dist/lexicon/types/app/bsky/graph/getBlocks.d.ts +2 -2
  31. package/dist/lexicon/types/app/bsky/graph/getFollowers.d.ts +2 -2
  32. package/dist/lexicon/types/app/bsky/graph/getFollows.d.ts +2 -2
  33. package/dist/lexicon/types/app/bsky/graph/getList.d.ts +2 -2
  34. package/dist/lexicon/types/app/bsky/graph/getListBlocks.d.ts +2 -2
  35. package/dist/lexicon/types/app/bsky/graph/getListMutes.d.ts +2 -2
  36. package/dist/lexicon/types/app/bsky/graph/getLists.d.ts +2 -2
  37. package/dist/lexicon/types/app/bsky/graph/getMutes.d.ts +2 -2
  38. package/dist/lexicon/types/app/bsky/graph/getRelationships.d.ts +2 -2
  39. package/dist/lexicon/types/app/bsky/graph/getSuggestedFollowsByActor.d.ts +2 -2
  40. package/dist/lexicon/types/app/bsky/notification/getUnreadCount.d.ts +2 -2
  41. package/dist/lexicon/types/app/bsky/notification/listNotifications.d.ts +2 -2
  42. package/dist/lexicon/types/app/bsky/unspecced/getPopularFeedGenerators.d.ts +2 -2
  43. package/dist/lexicon/types/app/bsky/unspecced/getTaggedSuggestions.d.ts +2 -2
  44. package/dist/lexicon/types/app/bsky/unspecced/searchActorsSkeleton.d.ts +2 -2
  45. package/dist/lexicon/types/app/bsky/unspecced/searchPostsSkeleton.d.ts +2 -2
  46. package/dist/lexicon/types/com/atproto/admin/createCommunicationTemplate.d.ts +2 -2
  47. package/dist/lexicon/types/com/atproto/admin/emitModerationEvent.d.ts +2 -2
  48. package/dist/lexicon/types/com/atproto/admin/getAccountInfo.d.ts +2 -2
  49. package/dist/lexicon/types/com/atproto/admin/getAccountInfos.d.ts +2 -2
  50. package/dist/lexicon/types/com/atproto/admin/getInviteCodes.d.ts +2 -2
  51. package/dist/lexicon/types/com/atproto/admin/getModerationEvent.d.ts +2 -2
  52. package/dist/lexicon/types/com/atproto/admin/getRecord.d.ts +2 -2
  53. package/dist/lexicon/types/com/atproto/admin/getRepo.d.ts +2 -2
  54. package/dist/lexicon/types/com/atproto/admin/getSubjectStatus.d.ts +2 -2
  55. package/dist/lexicon/types/com/atproto/admin/listCommunicationTemplates.d.ts +2 -2
  56. package/dist/lexicon/types/com/atproto/admin/queryModerationEvents.d.ts +2 -2
  57. package/dist/lexicon/types/com/atproto/admin/queryModerationStatuses.d.ts +2 -2
  58. package/dist/lexicon/types/com/atproto/admin/searchRepos.d.ts +2 -2
  59. package/dist/lexicon/types/com/atproto/admin/sendEmail.d.ts +2 -2
  60. package/dist/lexicon/types/com/atproto/admin/updateCommunicationTemplate.d.ts +2 -2
  61. package/dist/lexicon/types/com/atproto/admin/updateSubjectStatus.d.ts +2 -2
  62. package/dist/lexicon/types/com/atproto/identity/resolveHandle.d.ts +2 -2
  63. package/dist/lexicon/types/com/atproto/label/queryLabels.d.ts +2 -2
  64. package/dist/lexicon/types/com/atproto/moderation/createReport.d.ts +2 -2
  65. package/dist/lexicon/types/com/atproto/repo/createRecord.d.ts +2 -2
  66. package/dist/lexicon/types/com/atproto/repo/describeRepo.d.ts +2 -2
  67. package/dist/lexicon/types/com/atproto/repo/getRecord.d.ts +2 -2
  68. package/dist/lexicon/types/com/atproto/repo/listRecords.d.ts +2 -2
  69. package/dist/lexicon/types/com/atproto/repo/putRecord.d.ts +2 -2
  70. package/dist/lexicon/types/com/atproto/repo/uploadBlob.d.ts +2 -2
  71. package/dist/lexicon/types/com/atproto/server/createAccount.d.ts +2 -2
  72. package/dist/lexicon/types/com/atproto/server/createAppPassword.d.ts +2 -2
  73. package/dist/lexicon/types/com/atproto/server/createInviteCode.d.ts +2 -2
  74. package/dist/lexicon/types/com/atproto/server/createInviteCodes.d.ts +2 -2
  75. package/dist/lexicon/types/com/atproto/server/createSession.d.ts +2 -2
  76. package/dist/lexicon/types/com/atproto/server/describeServer.d.ts +2 -2
  77. package/dist/lexicon/types/com/atproto/server/getAccountInviteCodes.d.ts +2 -2
  78. package/dist/lexicon/types/com/atproto/server/getSession.d.ts +2 -2
  79. package/dist/lexicon/types/com/atproto/server/listAppPasswords.d.ts +2 -2
  80. package/dist/lexicon/types/com/atproto/server/refreshSession.d.ts +2 -2
  81. package/dist/lexicon/types/com/atproto/server/requestEmailUpdate.d.ts +2 -2
  82. package/dist/lexicon/types/com/atproto/server/reserveSigningKey.d.ts +2 -2
  83. package/dist/lexicon/types/com/atproto/sync/getBlob.d.ts +2 -2
  84. package/dist/lexicon/types/com/atproto/sync/getBlocks.d.ts +2 -2
  85. package/dist/lexicon/types/com/atproto/sync/getCheckout.d.ts +2 -2
  86. package/dist/lexicon/types/com/atproto/sync/getHead.d.ts +2 -2
  87. package/dist/lexicon/types/com/atproto/sync/getLatestCommit.d.ts +2 -2
  88. package/dist/lexicon/types/com/atproto/sync/getRecord.d.ts +2 -2
  89. package/dist/lexicon/types/com/atproto/sync/getRepo.d.ts +2 -2
  90. package/dist/lexicon/types/com/atproto/sync/listBlobs.d.ts +2 -2
  91. package/dist/lexicon/types/com/atproto/sync/listRepos.d.ts +2 -2
  92. package/dist/lexicon/types/com/atproto/temp/checkSignupQueue.d.ts +2 -2
  93. package/dist/lexicon/types/com/atproto/temp/fetchLabels.d.ts +2 -2
  94. package/dist/lexicon/types/com/atproto/temp/importRepo.d.ts +2 -2
  95. package/dist/lexicon/types/com/atproto/temp/transferAccount.d.ts +2 -2
  96. package/package.json +5 -5
  97. package/src/lexicon/lexicons.ts +339 -123
  98. package/src/lexicon/types/app/bsky/actor/defs.ts +2 -0
  99. package/src/lexicon/types/app/bsky/actor/getPreferences.ts +2 -2
  100. package/src/lexicon/types/app/bsky/actor/getProfile.ts +3 -2
  101. package/src/lexicon/types/app/bsky/actor/getProfiles.ts +2 -2
  102. package/src/lexicon/types/app/bsky/actor/getSuggestions.ts +2 -2
  103. package/src/lexicon/types/app/bsky/actor/profile.ts +3 -0
  104. package/src/lexicon/types/app/bsky/actor/putPreferences.ts +1 -1
  105. package/src/lexicon/types/app/bsky/actor/searchActors.ts +2 -2
  106. package/src/lexicon/types/app/bsky/actor/searchActorsTypeahead.ts +2 -2
  107. package/src/lexicon/types/app/bsky/embed/external.ts +1 -0
  108. package/src/lexicon/types/app/bsky/embed/images.ts +4 -0
  109. package/src/lexicon/types/app/bsky/embed/record.ts +1 -0
  110. package/src/lexicon/types/app/bsky/feed/defs.ts +1 -0
  111. package/src/lexicon/types/app/bsky/feed/describeFeedGenerator.ts +2 -2
  112. package/src/lexicon/types/app/bsky/feed/getActorFeeds.ts +2 -2
  113. package/src/lexicon/types/app/bsky/feed/getActorLikes.ts +2 -2
  114. package/src/lexicon/types/app/bsky/feed/getAuthorFeed.ts +3 -2
  115. package/src/lexicon/types/app/bsky/feed/getFeed.ts +2 -2
  116. package/src/lexicon/types/app/bsky/feed/getFeedGenerator.ts +5 -2
  117. package/src/lexicon/types/app/bsky/feed/getFeedGenerators.ts +2 -2
  118. package/src/lexicon/types/app/bsky/feed/getFeedSkeleton.ts +3 -2
  119. package/src/lexicon/types/app/bsky/feed/getLikes.ts +4 -2
  120. package/src/lexicon/types/app/bsky/feed/getListFeed.ts +3 -2
  121. package/src/lexicon/types/app/bsky/feed/getPostThread.ts +5 -2
  122. package/src/lexicon/types/app/bsky/feed/getPosts.ts +3 -2
  123. package/src/lexicon/types/app/bsky/feed/getRepostedBy.ts +4 -2
  124. package/src/lexicon/types/app/bsky/feed/getSuggestedFeeds.ts +2 -2
  125. package/src/lexicon/types/app/bsky/feed/getTimeline.ts +3 -2
  126. package/src/lexicon/types/app/bsky/feed/post.ts +5 -1
  127. package/src/lexicon/types/app/bsky/feed/searchPosts.ts +2 -2
  128. package/src/lexicon/types/app/bsky/feed/threadgate.ts +1 -0
  129. package/src/lexicon/types/app/bsky/graph/block.ts +1 -0
  130. package/src/lexicon/types/app/bsky/graph/getBlocks.ts +2 -2
  131. package/src/lexicon/types/app/bsky/graph/getFollowers.ts +2 -2
  132. package/src/lexicon/types/app/bsky/graph/getFollows.ts +2 -2
  133. package/src/lexicon/types/app/bsky/graph/getList.ts +3 -2
  134. package/src/lexicon/types/app/bsky/graph/getListBlocks.ts +2 -2
  135. package/src/lexicon/types/app/bsky/graph/getListMutes.ts +2 -2
  136. package/src/lexicon/types/app/bsky/graph/getLists.ts +3 -2
  137. package/src/lexicon/types/app/bsky/graph/getMutes.ts +2 -2
  138. package/src/lexicon/types/app/bsky/graph/getRelationships.ts +4 -2
  139. package/src/lexicon/types/app/bsky/graph/getSuggestedFollowsByActor.ts +2 -2
  140. package/src/lexicon/types/app/bsky/graph/list.ts +1 -0
  141. package/src/lexicon/types/app/bsky/graph/listblock.ts +1 -0
  142. package/src/lexicon/types/app/bsky/graph/listitem.ts +2 -0
  143. package/src/lexicon/types/app/bsky/graph/muteActor.ts +1 -1
  144. package/src/lexicon/types/app/bsky/graph/muteActorList.ts +1 -1
  145. package/src/lexicon/types/app/bsky/graph/unmuteActor.ts +1 -1
  146. package/src/lexicon/types/app/bsky/graph/unmuteActorList.ts +1 -1
  147. package/src/lexicon/types/app/bsky/notification/getUnreadCount.ts +2 -2
  148. package/src/lexicon/types/app/bsky/notification/listNotifications.ts +2 -2
  149. package/src/lexicon/types/app/bsky/notification/registerPush.ts +1 -1
  150. package/src/lexicon/types/app/bsky/notification/updateSeen.ts +1 -1
  151. package/src/lexicon/types/app/bsky/richtext/facet.ts +5 -4
  152. package/src/lexicon/types/app/bsky/unspecced/getPopularFeedGenerators.ts +2 -2
  153. package/src/lexicon/types/app/bsky/unspecced/getTaggedSuggestions.ts +2 -2
  154. package/src/lexicon/types/app/bsky/unspecced/searchActorsSkeleton.ts +2 -2
  155. package/src/lexicon/types/app/bsky/unspecced/searchPostsSkeleton.ts +2 -2
  156. package/src/lexicon/types/com/atproto/admin/createCommunicationTemplate.ts +2 -2
  157. package/src/lexicon/types/com/atproto/admin/deleteAccount.ts +1 -1
  158. package/src/lexicon/types/com/atproto/admin/deleteCommunicationTemplate.ts +1 -1
  159. package/src/lexicon/types/com/atproto/admin/disableAccountInvites.ts +1 -1
  160. package/src/lexicon/types/com/atproto/admin/disableInviteCodes.ts +1 -1
  161. package/src/lexicon/types/com/atproto/admin/emitModerationEvent.ts +2 -2
  162. package/src/lexicon/types/com/atproto/admin/enableAccountInvites.ts +1 -1
  163. package/src/lexicon/types/com/atproto/admin/getAccountInfo.ts +2 -2
  164. package/src/lexicon/types/com/atproto/admin/getAccountInfos.ts +2 -2
  165. package/src/lexicon/types/com/atproto/admin/getInviteCodes.ts +2 -2
  166. package/src/lexicon/types/com/atproto/admin/getModerationEvent.ts +2 -2
  167. package/src/lexicon/types/com/atproto/admin/getRecord.ts +2 -2
  168. package/src/lexicon/types/com/atproto/admin/getRepo.ts +2 -2
  169. package/src/lexicon/types/com/atproto/admin/getSubjectStatus.ts +2 -2
  170. package/src/lexicon/types/com/atproto/admin/listCommunicationTemplates.ts +2 -2
  171. package/src/lexicon/types/com/atproto/admin/queryModerationEvents.ts +2 -2
  172. package/src/lexicon/types/com/atproto/admin/queryModerationStatuses.ts +2 -2
  173. package/src/lexicon/types/com/atproto/admin/searchRepos.ts +2 -2
  174. package/src/lexicon/types/com/atproto/admin/sendEmail.ts +2 -2
  175. package/src/lexicon/types/com/atproto/admin/updateAccountEmail.ts +1 -1
  176. package/src/lexicon/types/com/atproto/admin/updateAccountHandle.ts +1 -1
  177. package/src/lexicon/types/com/atproto/admin/updateCommunicationTemplate.ts +2 -2
  178. package/src/lexicon/types/com/atproto/admin/updateSubjectStatus.ts +2 -2
  179. package/src/lexicon/types/com/atproto/identity/resolveHandle.ts +2 -2
  180. package/src/lexicon/types/com/atproto/identity/updateHandle.ts +2 -1
  181. package/src/lexicon/types/com/atproto/label/queryLabels.ts +2 -2
  182. package/src/lexicon/types/com/atproto/label/subscribeLabels.ts +1 -1
  183. package/src/lexicon/types/com/atproto/moderation/createReport.ts +3 -2
  184. package/src/lexicon/types/com/atproto/repo/applyWrites.ts +7 -6
  185. package/src/lexicon/types/com/atproto/repo/createRecord.ts +6 -6
  186. package/src/lexicon/types/com/atproto/repo/deleteRecord.ts +3 -3
  187. package/src/lexicon/types/com/atproto/repo/describeRepo.ts +5 -2
  188. package/src/lexicon/types/com/atproto/repo/getRecord.ts +3 -3
  189. package/src/lexicon/types/com/atproto/repo/listRecords.ts +2 -2
  190. package/src/lexicon/types/com/atproto/repo/putRecord.ts +6 -6
  191. package/src/lexicon/types/com/atproto/repo/uploadBlob.ts +2 -2
  192. package/src/lexicon/types/com/atproto/server/confirmEmail.ts +1 -1
  193. package/src/lexicon/types/com/atproto/server/createAccount.ts +10 -2
  194. package/src/lexicon/types/com/atproto/server/createAppPassword.ts +3 -2
  195. package/src/lexicon/types/com/atproto/server/createInviteCode.ts +2 -2
  196. package/src/lexicon/types/com/atproto/server/createInviteCodes.ts +2 -2
  197. package/src/lexicon/types/com/atproto/server/createSession.ts +2 -2
  198. package/src/lexicon/types/com/atproto/server/deleteAccount.ts +1 -1
  199. package/src/lexicon/types/com/atproto/server/deleteSession.ts +1 -1
  200. package/src/lexicon/types/com/atproto/server/describeServer.ts +5 -2
  201. package/src/lexicon/types/com/atproto/server/getAccountInviteCodes.ts +3 -2
  202. package/src/lexicon/types/com/atproto/server/getSession.ts +2 -2
  203. package/src/lexicon/types/com/atproto/server/listAppPasswords.ts +2 -2
  204. package/src/lexicon/types/com/atproto/server/refreshSession.ts +2 -2
  205. package/src/lexicon/types/com/atproto/server/requestAccountDelete.ts +1 -1
  206. package/src/lexicon/types/com/atproto/server/requestEmailConfirmation.ts +1 -1
  207. package/src/lexicon/types/com/atproto/server/requestEmailUpdate.ts +2 -2
  208. package/src/lexicon/types/com/atproto/server/requestPasswordReset.ts +1 -1
  209. package/src/lexicon/types/com/atproto/server/reserveSigningKey.ts +4 -4
  210. package/src/lexicon/types/com/atproto/server/resetPassword.ts +1 -1
  211. package/src/lexicon/types/com/atproto/server/revokeAppPassword.ts +1 -1
  212. package/src/lexicon/types/com/atproto/server/updateEmail.ts +1 -1
  213. package/src/lexicon/types/com/atproto/sync/getBlob.ts +3 -3
  214. package/src/lexicon/types/com/atproto/sync/getBlocks.ts +2 -2
  215. package/src/lexicon/types/com/atproto/sync/getCheckout.ts +2 -2
  216. package/src/lexicon/types/com/atproto/sync/getHead.ts +2 -2
  217. package/src/lexicon/types/com/atproto/sync/getLatestCommit.ts +2 -2
  218. package/src/lexicon/types/com/atproto/sync/getRecord.ts +3 -2
  219. package/src/lexicon/types/com/atproto/sync/getRepo.ts +3 -3
  220. package/src/lexicon/types/com/atproto/sync/listBlobs.ts +2 -2
  221. package/src/lexicon/types/com/atproto/sync/listRepos.ts +3 -2
  222. package/src/lexicon/types/com/atproto/sync/notifyOfUpdate.ts +2 -2
  223. package/src/lexicon/types/com/atproto/sync/requestCrawl.ts +2 -2
  224. package/src/lexicon/types/com/atproto/sync/subscribeRepos.ts +17 -5
  225. package/src/lexicon/types/com/atproto/temp/checkSignupQueue.ts +2 -2
  226. package/src/lexicon/types/com/atproto/temp/fetchLabels.ts +2 -2
  227. package/src/lexicon/types/com/atproto/temp/importRepo.ts +2 -2
  228. package/src/lexicon/types/com/atproto/temp/pushBlob.ts +1 -1
  229. package/src/lexicon/types/com/atproto/temp/requestPhoneVerification.ts +1 -1
  230. package/src/lexicon/types/com/atproto/temp/transferAccount.ts +2 -2
package/dist/index.js CHANGED
@@ -15144,7 +15144,7 @@ var require_object_inspect = __commonJS({
15144
15144
  if (isBoolean2(obj)) {
15145
15145
  return markBoxed(booleanValueOf.call(obj));
15146
15146
  }
15147
- if (isString2(obj)) {
15147
+ if (isString3(obj)) {
15148
15148
  return markBoxed(inspect(String(obj)));
15149
15149
  }
15150
15150
  if (!isDate2(obj) && !isRegExp(obj)) {
@@ -15183,7 +15183,7 @@ var require_object_inspect = __commonJS({
15183
15183
  function isError(obj) {
15184
15184
  return toStr(obj) === "[object Error]" && (!toStringTag || !(typeof obj === "object" && toStringTag in obj));
15185
15185
  }
15186
- function isString2(obj) {
15186
+ function isString3(obj) {
15187
15187
  return toStr(obj) === "[object String]" && (!toStringTag || !(typeof obj === "object" && toStringTag in obj));
15188
15188
  }
15189
15189
  function isNumber2(obj) {
@@ -22264,13 +22264,13 @@ var require_implementation2 = __commonJS({
22264
22264
  var isObject3 = object2 !== null && typeof object2 === "object";
22265
22265
  var isFunction2 = toStr.call(object2) === "[object Function]";
22266
22266
  var isArguments = isArgs(object2);
22267
- var isString2 = isObject3 && toStr.call(object2) === "[object String]";
22267
+ var isString3 = isObject3 && toStr.call(object2) === "[object String]";
22268
22268
  var theKeys = [];
22269
22269
  if (!isObject3 && !isFunction2 && !isArguments) {
22270
22270
  throw new TypeError("Object.keys called on a non-object");
22271
22271
  }
22272
22272
  var skipProto = hasProtoEnumBug && isFunction2;
22273
- if (isString2 && object2.length > 0 && !has.call(object2, 0)) {
22273
+ if (isString3 && object2.length > 0 && !has.call(object2, 0)) {
22274
22274
  for (var i = 0; i < object2.length; ++i) {
22275
22275
  theKeys.push(String(i));
22276
22276
  }
@@ -33941,7 +33941,7 @@ var require_lib4 = __commonJS({
33941
33941
  preflightContinue: false,
33942
33942
  optionsSuccessStatus: 204
33943
33943
  };
33944
- function isString2(s) {
33944
+ function isString3(s) {
33945
33945
  return typeof s === "string" || s instanceof String;
33946
33946
  }
33947
33947
  function isOriginAllowed(origin, allowedOrigin) {
@@ -33952,7 +33952,7 @@ var require_lib4 = __commonJS({
33952
33952
  }
33953
33953
  }
33954
33954
  return false;
33955
- } else if (isString2(allowedOrigin)) {
33955
+ } else if (isString3(allowedOrigin)) {
33956
33956
  return origin === allowedOrigin;
33957
33957
  } else if (allowedOrigin instanceof RegExp) {
33958
33958
  return allowedOrigin.test(origin);
@@ -33967,7 +33967,7 @@ var require_lib4 = __commonJS({
33967
33967
  key: "Access-Control-Allow-Origin",
33968
33968
  value: "*"
33969
33969
  }]);
33970
- } else if (isString2(options.origin)) {
33970
+ } else if (isString3(options.origin)) {
33971
33971
  headers.push([{
33972
33972
  key: "Access-Control-Allow-Origin",
33973
33973
  value: options.origin
@@ -43357,30 +43357,292 @@ var require_dist2 = __commonJS({
43357
43357
  }
43358
43358
  });
43359
43359
 
43360
- // ../../node_modules/.pnpm/node-gyp-build-optional-packages@5.0.3/node_modules/node-gyp-build-optional-packages/index.js
43360
+ // ../../node_modules/.pnpm/detect-libc@2.0.2/node_modules/detect-libc/lib/process.js
43361
+ var require_process = __commonJS({
43362
+ "../../node_modules/.pnpm/detect-libc@2.0.2/node_modules/detect-libc/lib/process.js"(exports, module2) {
43363
+ "use strict";
43364
+ var isLinux = () => process.platform === "linux";
43365
+ var report = null;
43366
+ var getReport = () => {
43367
+ if (!report) {
43368
+ report = isLinux() && process.report ? process.report.getReport() : {};
43369
+ }
43370
+ return report;
43371
+ };
43372
+ module2.exports = { isLinux, getReport };
43373
+ }
43374
+ });
43375
+
43376
+ // ../../node_modules/.pnpm/detect-libc@2.0.2/node_modules/detect-libc/lib/filesystem.js
43377
+ var require_filesystem = __commonJS({
43378
+ "../../node_modules/.pnpm/detect-libc@2.0.2/node_modules/detect-libc/lib/filesystem.js"(exports, module2) {
43379
+ "use strict";
43380
+ var fs = require("fs");
43381
+ var LDD_PATH = "/usr/bin/ldd";
43382
+ var readFileSync = (path) => fs.readFileSync(path, "utf-8");
43383
+ var readFile = (path) => new Promise((resolve, reject) => {
43384
+ fs.readFile(path, "utf-8", (err, data) => {
43385
+ if (err) {
43386
+ reject(err);
43387
+ } else {
43388
+ resolve(data);
43389
+ }
43390
+ });
43391
+ });
43392
+ module2.exports = {
43393
+ LDD_PATH,
43394
+ readFileSync,
43395
+ readFile
43396
+ };
43397
+ }
43398
+ });
43399
+
43400
+ // ../../node_modules/.pnpm/detect-libc@2.0.2/node_modules/detect-libc/lib/detect-libc.js
43401
+ var require_detect_libc = __commonJS({
43402
+ "../../node_modules/.pnpm/detect-libc@2.0.2/node_modules/detect-libc/lib/detect-libc.js"(exports, module2) {
43403
+ "use strict";
43404
+ var childProcess = require("child_process");
43405
+ var { isLinux, getReport } = require_process();
43406
+ var { LDD_PATH, readFile, readFileSync } = require_filesystem();
43407
+ var cachedFamilyFilesystem;
43408
+ var cachedVersionFilesystem;
43409
+ var command = "getconf GNU_LIBC_VERSION 2>&1 || true; ldd --version 2>&1 || true";
43410
+ var commandOut = "";
43411
+ var safeCommand = () => {
43412
+ if (!commandOut) {
43413
+ return new Promise((resolve) => {
43414
+ childProcess.exec(command, (err, out) => {
43415
+ commandOut = err ? " " : out;
43416
+ resolve(commandOut);
43417
+ });
43418
+ });
43419
+ }
43420
+ return commandOut;
43421
+ };
43422
+ var safeCommandSync = () => {
43423
+ if (!commandOut) {
43424
+ try {
43425
+ commandOut = childProcess.execSync(command, { encoding: "utf8" });
43426
+ } catch (_err) {
43427
+ commandOut = " ";
43428
+ }
43429
+ }
43430
+ return commandOut;
43431
+ };
43432
+ var GLIBC = "glibc";
43433
+ var RE_GLIBC_VERSION = /GLIBC\s(\d+\.\d+)/;
43434
+ var MUSL = "musl";
43435
+ var GLIBC_ON_LDD = GLIBC.toUpperCase();
43436
+ var MUSL_ON_LDD = MUSL.toLowerCase();
43437
+ var isFileMusl = (f) => f.includes("libc.musl-") || f.includes("ld-musl-");
43438
+ var familyFromReport = () => {
43439
+ const report = getReport();
43440
+ if (report.header && report.header.glibcVersionRuntime) {
43441
+ return GLIBC;
43442
+ }
43443
+ if (Array.isArray(report.sharedObjects)) {
43444
+ if (report.sharedObjects.some(isFileMusl)) {
43445
+ return MUSL;
43446
+ }
43447
+ }
43448
+ return null;
43449
+ };
43450
+ var familyFromCommand = (out) => {
43451
+ const [getconf, ldd1] = out.split(/[\r\n]+/);
43452
+ if (getconf && getconf.includes(GLIBC)) {
43453
+ return GLIBC;
43454
+ }
43455
+ if (ldd1 && ldd1.includes(MUSL)) {
43456
+ return MUSL;
43457
+ }
43458
+ return null;
43459
+ };
43460
+ var getFamilyFromLddContent = (content) => {
43461
+ if (content.includes(MUSL_ON_LDD)) {
43462
+ return MUSL;
43463
+ }
43464
+ if (content.includes(GLIBC_ON_LDD)) {
43465
+ return GLIBC;
43466
+ }
43467
+ return null;
43468
+ };
43469
+ var familyFromFilesystem = async () => {
43470
+ if (cachedFamilyFilesystem !== void 0) {
43471
+ return cachedFamilyFilesystem;
43472
+ }
43473
+ cachedFamilyFilesystem = null;
43474
+ try {
43475
+ const lddContent = await readFile(LDD_PATH);
43476
+ cachedFamilyFilesystem = getFamilyFromLddContent(lddContent);
43477
+ } catch (e) {
43478
+ }
43479
+ return cachedFamilyFilesystem;
43480
+ };
43481
+ var familyFromFilesystemSync = () => {
43482
+ if (cachedFamilyFilesystem !== void 0) {
43483
+ return cachedFamilyFilesystem;
43484
+ }
43485
+ cachedFamilyFilesystem = null;
43486
+ try {
43487
+ const lddContent = readFileSync(LDD_PATH);
43488
+ cachedFamilyFilesystem = getFamilyFromLddContent(lddContent);
43489
+ } catch (e) {
43490
+ }
43491
+ return cachedFamilyFilesystem;
43492
+ };
43493
+ var family = async () => {
43494
+ let family2 = null;
43495
+ if (isLinux()) {
43496
+ family2 = await familyFromFilesystem();
43497
+ if (!family2) {
43498
+ family2 = familyFromReport();
43499
+ }
43500
+ if (!family2) {
43501
+ const out = await safeCommand();
43502
+ family2 = familyFromCommand(out);
43503
+ }
43504
+ }
43505
+ return family2;
43506
+ };
43507
+ var familySync = () => {
43508
+ let family2 = null;
43509
+ if (isLinux()) {
43510
+ family2 = familyFromFilesystemSync();
43511
+ if (!family2) {
43512
+ family2 = familyFromReport();
43513
+ }
43514
+ if (!family2) {
43515
+ const out = safeCommandSync();
43516
+ family2 = familyFromCommand(out);
43517
+ }
43518
+ }
43519
+ return family2;
43520
+ };
43521
+ var isNonGlibcLinux = async () => isLinux() && await family() !== GLIBC;
43522
+ var isNonGlibcLinuxSync = () => isLinux() && familySync() !== GLIBC;
43523
+ var versionFromFilesystem = async () => {
43524
+ if (cachedVersionFilesystem !== void 0) {
43525
+ return cachedVersionFilesystem;
43526
+ }
43527
+ cachedVersionFilesystem = null;
43528
+ try {
43529
+ const lddContent = await readFile(LDD_PATH);
43530
+ const versionMatch = lddContent.match(RE_GLIBC_VERSION);
43531
+ if (versionMatch) {
43532
+ cachedVersionFilesystem = versionMatch[1];
43533
+ }
43534
+ } catch (e) {
43535
+ }
43536
+ return cachedVersionFilesystem;
43537
+ };
43538
+ var versionFromFilesystemSync = () => {
43539
+ if (cachedVersionFilesystem !== void 0) {
43540
+ return cachedVersionFilesystem;
43541
+ }
43542
+ cachedVersionFilesystem = null;
43543
+ try {
43544
+ const lddContent = readFileSync(LDD_PATH);
43545
+ const versionMatch = lddContent.match(RE_GLIBC_VERSION);
43546
+ if (versionMatch) {
43547
+ cachedVersionFilesystem = versionMatch[1];
43548
+ }
43549
+ } catch (e) {
43550
+ }
43551
+ return cachedVersionFilesystem;
43552
+ };
43553
+ var versionFromReport = () => {
43554
+ const report = getReport();
43555
+ if (report.header && report.header.glibcVersionRuntime) {
43556
+ return report.header.glibcVersionRuntime;
43557
+ }
43558
+ return null;
43559
+ };
43560
+ var versionSuffix = (s) => s.trim().split(/\s+/)[1];
43561
+ var versionFromCommand = (out) => {
43562
+ const [getconf, ldd1, ldd2] = out.split(/[\r\n]+/);
43563
+ if (getconf && getconf.includes(GLIBC)) {
43564
+ return versionSuffix(getconf);
43565
+ }
43566
+ if (ldd1 && ldd2 && ldd1.includes(MUSL)) {
43567
+ return versionSuffix(ldd2);
43568
+ }
43569
+ return null;
43570
+ };
43571
+ var version2 = async () => {
43572
+ let version3 = null;
43573
+ if (isLinux()) {
43574
+ version3 = await versionFromFilesystem();
43575
+ if (!version3) {
43576
+ version3 = versionFromReport();
43577
+ }
43578
+ if (!version3) {
43579
+ const out = await safeCommand();
43580
+ version3 = versionFromCommand(out);
43581
+ }
43582
+ }
43583
+ return version3;
43584
+ };
43585
+ var versionSync = () => {
43586
+ let version3 = null;
43587
+ if (isLinux()) {
43588
+ version3 = versionFromFilesystemSync();
43589
+ if (!version3) {
43590
+ version3 = versionFromReport();
43591
+ }
43592
+ if (!version3) {
43593
+ const out = safeCommandSync();
43594
+ version3 = versionFromCommand(out);
43595
+ }
43596
+ }
43597
+ return version3;
43598
+ };
43599
+ module2.exports = {
43600
+ GLIBC,
43601
+ MUSL,
43602
+ family,
43603
+ familySync,
43604
+ isNonGlibcLinux,
43605
+ isNonGlibcLinuxSync,
43606
+ version: version2,
43607
+ versionSync
43608
+ };
43609
+ }
43610
+ });
43611
+
43612
+ // ../../node_modules/.pnpm/node-gyp-build-optional-packages@5.1.1/node_modules/node-gyp-build-optional-packages/index.js
43361
43613
  var require_node_gyp_build_optional_packages = __commonJS({
43362
- "../../node_modules/.pnpm/node-gyp-build-optional-packages@5.0.3/node_modules/node-gyp-build-optional-packages/index.js"(exports, module2) {
43614
+ "../../node_modules/.pnpm/node-gyp-build-optional-packages@5.1.1/node_modules/node-gyp-build-optional-packages/index.js"(exports, module2) {
43363
43615
  var fs = require("fs");
43364
43616
  var path = require("path");
43365
- var runtimeRequire = typeof __webpack_require__ === "function" ? __non_webpack_require__ : require;
43617
+ var url = require("url");
43366
43618
  var vars = process.config && process.config.variables || {};
43367
43619
  var prebuildsOnly = !!process.env.PREBUILDS_ONLY;
43368
- var abi = process.versions.modules;
43620
+ var versions = process.versions;
43621
+ var abi = versions.modules;
43622
+ if (versions.deno || process.isBun) {
43623
+ abi = "unsupported";
43624
+ }
43369
43625
  var runtime = isElectron() ? "electron" : "node";
43370
43626
  var arch = process.arch;
43371
43627
  var platform = process.platform;
43372
- var libc = process.env.LIBC || (isAlpine(platform) ? "musl" : "glibc");
43628
+ var libc = process.env.LIBC || (isMusl(platform) ? "musl" : "glibc");
43373
43629
  var armv = process.env.ARM_VERSION || (arch === "arm64" ? "8" : vars.arm_version) || "";
43374
- var uv = (process.versions.uv || "").split(".")[0];
43630
+ var uv = (versions.uv || "").split(".")[0];
43375
43631
  module2.exports = load;
43376
43632
  function load(dir) {
43377
- return runtimeRequire(load.path(dir));
43633
+ if (typeof __webpack_require__ === "function")
43634
+ return __non_webpack_require__(load.path(dir));
43635
+ else
43636
+ return require(load.path(dir));
43378
43637
  }
43379
43638
  load.path = function(dir) {
43380
43639
  dir = path.resolve(dir || ".");
43381
- var packageName;
43640
+ var packageName = "";
43382
43641
  try {
43383
- packageName = runtimeRequire(path.join(dir, "package.json")).name;
43642
+ if (typeof __webpack_require__ === "function")
43643
+ packageName = __non_webpack_require__(path.join(dir, "package.json")).name;
43644
+ else
43645
+ packageName = require(path.join(dir, "package.json")).name;
43384
43646
  var varName = packageName.toUpperCase().replace(/-/g, "_") + "_PREBUILD";
43385
43647
  if (process.env[varName])
43386
43648
  dir = process.env[varName];
@@ -43402,7 +43664,7 @@ var require_node_gyp_build_optional_packages = __commonJS({
43402
43664
  return nearby;
43403
43665
  var platformPackage = (packageName[0] == "@" ? "" : "@" + packageName + "/") + packageName + "-" + platform + "-" + arch;
43404
43666
  try {
43405
- var prebuildPackage = path.dirname(require("module").createRequire(path.join(dir, "package.json")).resolve(platformPackage));
43667
+ var prebuildPackage = path.dirname(require("module").createRequire(url.pathToFileURL(path.join(dir, "package.json"))).resolve(platformPackage));
43406
43668
  return resolveFile(prebuildPackage);
43407
43669
  } catch (error) {
43408
43670
  }
@@ -43418,7 +43680,7 @@ var require_node_gyp_build_optional_packages = __commonJS({
43418
43680
  process.versions.electron ? "electron=" + process.versions.electron : "",
43419
43681
  typeof __webpack_require__ === "function" ? "webpack=true" : ""
43420
43682
  ].filter(Boolean).join(" ");
43421
- throw new Error("No native build was found for " + target2 + "\n loaded from: " + dir + " and package: " + platformPackage + "\n");
43683
+ throw new Error("No native build was found for " + target2 + "\n attempted loading from: " + dir + " and package: " + platformPackage + "\n");
43422
43684
  function resolve(dir2) {
43423
43685
  var tuples = readdirSync(path.join(dir2, "prebuilds")).map(parseTuple);
43424
43686
  var tuple = tuples.filter(matchTuple(platform, arch)).sort(compareTuples)[0];
@@ -43541,8 +43803,11 @@ var require_node_gyp_build_optional_packages = __commonJS({
43541
43803
  return true;
43542
43804
  return typeof window !== "undefined" && window.process && window.process.type === "renderer";
43543
43805
  }
43544
- function isAlpine(platform2) {
43545
- return platform2 === "linux" && fs.existsSync("/etc/alpine-release");
43806
+ function isMusl(platform2) {
43807
+ if (platform2 !== "linux")
43808
+ return false;
43809
+ const { familySync, MUSL } = require_detect_libc();
43810
+ return familySync() === MUSL;
43546
43811
  }
43547
43812
  load.parseTags = parseTags;
43548
43813
  load.matchTags = matchTags;
@@ -43553,9 +43818,9 @@ var require_node_gyp_build_optional_packages = __commonJS({
43553
43818
  }
43554
43819
  });
43555
43820
 
43556
- // ../../node_modules/.pnpm/cbor-extract@2.1.1/node_modules/cbor-extract/index.js
43821
+ // ../../node_modules/.pnpm/cbor-extract@2.2.0/node_modules/cbor-extract/index.js
43557
43822
  var require_cbor_extract = __commonJS({
43558
- "../../node_modules/.pnpm/cbor-extract@2.1.1/node_modules/cbor-extract/index.js"(exports, module2) {
43823
+ "../../node_modules/.pnpm/cbor-extract@2.2.0/node_modules/cbor-extract/index.js"(exports, module2) {
43559
43824
  module2.exports = require_node_gyp_build_optional_packages()(__dirname);
43560
43825
  }
43561
43826
  });
@@ -75987,7 +76252,7 @@ if (cid) {
75987
76252
  }
75988
76253
  return result;
75989
76254
  }
75990
- var isString2 = typeOfTest("string");
76255
+ var isString3 = typeOfTest("string");
75991
76256
  var isFunction2 = typeOfTest("function");
75992
76257
  var isNumber2 = typeOfTest("number");
75993
76258
  var isObject22 = (thing) => thing !== null && typeof thing === "object";
@@ -76263,7 +76528,7 @@ if (cid) {
76263
76528
  isBuffer: isBuffer32,
76264
76529
  isFormData,
76265
76530
  isArrayBufferView,
76266
- isString: isString2,
76531
+ isString: isString3,
76267
76532
  isNumber: isNumber2,
76268
76533
  isBoolean: isBoolean2,
76269
76534
  isObject: isObject22,
@@ -79444,7 +79709,7 @@ var require_utils4 = __commonJS({
79444
79709
  }
79445
79710
  return result;
79446
79711
  }
79447
- function isString2(val) {
79712
+ function isString3(val) {
79448
79713
  return typeof val === "string";
79449
79714
  }
79450
79715
  function isNumber2(val) {
@@ -79594,7 +79859,7 @@ var require_utils4 = __commonJS({
79594
79859
  isBuffer: isBuffer3,
79595
79860
  isFormData,
79596
79861
  isArrayBufferView,
79597
- isString: isString2,
79862
+ isString: isString3,
79598
79863
  isNumber: isNumber2,
79599
79864
  isObject: isObject3,
79600
79865
  isPlainObject,
@@ -81022,7 +81287,7 @@ var require_follow_redirects = __commonJS({
81022
81287
  if (this._ending) {
81023
81288
  throw new WriteAfterEndError();
81024
81289
  }
81025
- if (!isString2(data) && !isBuffer3(data)) {
81290
+ if (!isString3(data) && !isBuffer3(data)) {
81026
81291
  throw new TypeError("data should be a string, Buffer or Uint8Array");
81027
81292
  }
81028
81293
  if (isFunction2(encoding)) {
@@ -81282,14 +81547,14 @@ var require_follow_redirects = __commonJS({
81282
81547
  var nativeProtocol = nativeProtocols[protocol] = protocols[scheme];
81283
81548
  var wrappedProtocol = exports2[scheme] = Object.create(nativeProtocol);
81284
81549
  function request(input, options, callback) {
81285
- if (isString2(input)) {
81550
+ if (isString3(input)) {
81286
81551
  var parsed;
81287
81552
  try {
81288
81553
  parsed = urlToOptions(new URL2(input));
81289
81554
  } catch (err) {
81290
81555
  parsed = url.parse(input);
81291
81556
  }
81292
- if (!isString2(parsed.protocol)) {
81557
+ if (!isString3(parsed.protocol)) {
81293
81558
  throw new InvalidUrlError({ input });
81294
81559
  }
81295
81560
  input = parsed;
@@ -81309,7 +81574,7 @@ var require_follow_redirects = __commonJS({
81309
81574
  maxBodyLength: exports2.maxBodyLength
81310
81575
  }, input, options);
81311
81576
  options.nativeProtocols = nativeProtocols;
81312
- if (!isString2(options.host) && !isString2(options.hostname)) {
81577
+ if (!isString3(options.host) && !isString3(options.hostname)) {
81313
81578
  options.hostname = "::1";
81314
81579
  }
81315
81580
  assert7.equal(options.protocol, protocol, "protocol mismatch");
@@ -81375,11 +81640,11 @@ var require_follow_redirects = __commonJS({
81375
81640
  request.abort();
81376
81641
  }
81377
81642
  function isSubdomain(subdomain, domain) {
81378
- assert7(isString2(subdomain) && isString2(domain));
81643
+ assert7(isString3(subdomain) && isString3(domain));
81379
81644
  var dot = subdomain.length - domain.length - 1;
81380
81645
  return dot > 0 && subdomain[dot] === "." && subdomain.endsWith(domain);
81381
81646
  }
81382
- function isString2(value) {
81647
+ function isString3(value) {
81383
81648
  return typeof value === "string" || value instanceof String;
81384
81649
  }
81385
81650
  function isFunction2(value) {
@@ -94769,6 +95034,11 @@ var handlerSuccess = z.object({
94769
95034
  body: z.any(),
94770
95035
  headers: z.record(z.string()).optional()
94771
95036
  });
95037
+ var handlerPipeThrough = z.object({
95038
+ encoding: z.string(),
95039
+ buffer: z.instanceof(ArrayBuffer),
95040
+ headers: z.record(z.string()).optional()
95041
+ });
94772
95042
  var handlerError = z.object({
94773
95043
  status: z.number(),
94774
95044
  error: z.string().optional(),
@@ -101405,6 +101675,15 @@ var Server = class {
101405
101675
  if (isHandlerError(outputUnvalidated)) {
101406
101676
  throw XRPCError2.fromError(outputUnvalidated);
101407
101677
  }
101678
+ if (outputUnvalidated && isHandlerPipeThrough(outputUnvalidated)) {
101679
+ if (outputUnvalidated?.headers) {
101680
+ Object.entries(outputUnvalidated.headers).forEach(([name2, val]) => {
101681
+ res.header(name2, val);
101682
+ });
101683
+ }
101684
+ res.header("Content-Type", outputUnvalidated.encoding).status(200).send(Buffer.from(outputUnvalidated.buffer));
101685
+ return;
101686
+ }
101408
101687
  if (!outputUnvalidated || isHandlerSuccess(outputUnvalidated)) {
101409
101688
  const output2 = validateResOutput(outputUnvalidated);
101410
101689
  if (output2?.headers) {
@@ -101546,6 +101825,24 @@ var Server = class {
101546
101825
  function isHandlerSuccess(v) {
101547
101826
  return handlerSuccess.safeParse(v).success;
101548
101827
  }
101828
+ function isHandlerPipeThrough(v) {
101829
+ if (v === null || typeof v !== "object") {
101830
+ return false;
101831
+ }
101832
+ if (!isString(v["encoding"]) || !(v["buffer"] instanceof ArrayBuffer)) {
101833
+ return false;
101834
+ }
101835
+ if (v["headers"] !== void 0) {
101836
+ if (v["headers"] === null || typeof v["headers"] !== "object") {
101837
+ return false;
101838
+ }
101839
+ if (!Object.values(v["headers"]).every(isString)) {
101840
+ return false;
101841
+ }
101842
+ }
101843
+ return true;
101844
+ }
101845
+ var isString = (val) => typeof val === "string";
101549
101846
  var kRequestLocals = Symbol("requestLocals");
101550
101847
  function createLocalsMiddleware(nsid2) {
101551
101848
  return function(req, _res, next) {
@@ -103481,7 +103778,7 @@ var schemaDict = {
103481
103778
  defs: {
103482
103779
  main: {
103483
103780
  type: "query",
103484
- description: "Provides the DID of a repo.",
103781
+ description: "Resolves a handle (domain name) to a DID.",
103485
103782
  parameters: {
103486
103783
  type: "params",
103487
103784
  required: ["handle"],
@@ -103515,7 +103812,7 @@ var schemaDict = {
103515
103812
  defs: {
103516
103813
  main: {
103517
103814
  type: "procedure",
103518
- description: "Updates the handle of the account.",
103815
+ description: "Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth.",
103519
103816
  input: {
103520
103817
  encoding: "application/json",
103521
103818
  schema: {
@@ -103524,7 +103821,8 @@ var schemaDict = {
103524
103821
  properties: {
103525
103822
  handle: {
103526
103823
  type: "string",
103527
- format: "handle"
103824
+ format: "handle",
103825
+ description: "The new handle."
103528
103826
  }
103529
103827
  }
103530
103828
  }
@@ -103607,7 +103905,7 @@ var schemaDict = {
103607
103905
  defs: {
103608
103906
  main: {
103609
103907
  type: "query",
103610
- description: "Find labels relevant to the provided URI patterns.",
103908
+ description: "Find labels relevant to the provided AT-URI patterns. Public endpoint for moderation services, though may return different or additional results with auth.",
103611
103909
  parameters: {
103612
103910
  type: "params",
103613
103911
  required: ["uriPatterns"],
@@ -103666,13 +103964,13 @@ var schemaDict = {
103666
103964
  defs: {
103667
103965
  main: {
103668
103966
  type: "subscription",
103669
- description: "Subscribe to label updates.",
103967
+ description: "Subscribe to stream of labels (and negations). Public endpoint implemented by mod services. Uses same sequencing scheme as repo event stream.",
103670
103968
  parameters: {
103671
103969
  type: "params",
103672
103970
  properties: {
103673
103971
  cursor: {
103674
103972
  type: "integer",
103675
- description: "The last known event to backfill from."
103973
+ description: "The last known event seq number to backfill from."
103676
103974
  }
103677
103975
  }
103678
103976
  },
@@ -103728,7 +104026,7 @@ var schemaDict = {
103728
104026
  defs: {
103729
104027
  main: {
103730
104028
  type: "procedure",
103731
- description: "Report a repo or a record.",
104029
+ description: "Submit a moderation report regarding an atproto account or record. Implemented by moderation services (with PDS proxying), and requires auth.",
103732
104030
  input: {
103733
104031
  encoding: "application/json",
103734
104032
  schema: {
@@ -103737,10 +104035,12 @@ var schemaDict = {
103737
104035
  properties: {
103738
104036
  reasonType: {
103739
104037
  type: "ref",
104038
+ description: "Indicates the broad category of violation the report is for.",
103740
104039
  ref: "lex:com.atproto.moderation.defs#reasonType"
103741
104040
  },
103742
104041
  reason: {
103743
- type: "string"
104042
+ type: "string",
104043
+ description: "Additional context about the content and violation."
103744
104044
  },
103745
104045
  subject: {
103746
104046
  type: "union",
@@ -103849,7 +104149,7 @@ var schemaDict = {
103849
104149
  defs: {
103850
104150
  main: {
103851
104151
  type: "procedure",
103852
- description: "Apply a batch transaction of creates, updates, and deletes.",
104152
+ description: "Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.",
103853
104153
  input: {
103854
104154
  encoding: "application/json",
103855
104155
  schema: {
@@ -103859,12 +104159,12 @@ var schemaDict = {
103859
104159
  repo: {
103860
104160
  type: "string",
103861
104161
  format: "at-identifier",
103862
- description: "The handle or DID of the repo."
104162
+ description: "The handle or DID of the repo (aka, current account)."
103863
104163
  },
103864
104164
  validate: {
103865
104165
  type: "boolean",
103866
104166
  default: true,
103867
- description: "Flag for validating the records."
104167
+ description: "Can be set to 'false' to skip Lexicon schema validation of record data, for all operations."
103868
104168
  },
103869
104169
  writes: {
103870
104170
  type: "array",
@@ -103880,6 +104180,7 @@ var schemaDict = {
103880
104180
  },
103881
104181
  swapCommit: {
103882
104182
  type: "string",
104183
+ description: "If provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations.",
103883
104184
  format: "cid"
103884
104185
  }
103885
104186
  }
@@ -103887,13 +104188,14 @@ var schemaDict = {
103887
104188
  },
103888
104189
  errors: [
103889
104190
  {
103890
- name: "InvalidSwap"
104191
+ name: "InvalidSwap",
104192
+ description: "Indicates that the 'swapCommit' parameter did not match current commit."
103891
104193
  }
103892
104194
  ]
103893
104195
  },
103894
104196
  create: {
103895
104197
  type: "object",
103896
- description: "Create a new record.",
104198
+ description: "Operation which creates a new record.",
103897
104199
  required: ["collection", "value"],
103898
104200
  properties: {
103899
104201
  collection: {
@@ -103911,7 +104213,7 @@ var schemaDict = {
103911
104213
  },
103912
104214
  update: {
103913
104215
  type: "object",
103914
- description: "Update an existing record.",
104216
+ description: "Operation which updates an existing record.",
103915
104217
  required: ["collection", "rkey", "value"],
103916
104218
  properties: {
103917
104219
  collection: {
@@ -103928,7 +104230,7 @@ var schemaDict = {
103928
104230
  },
103929
104231
  delete: {
103930
104232
  type: "object",
103931
- description: "Delete an existing record.",
104233
+ description: "Operation which deletes an existing record.",
103932
104234
  required: ["collection", "rkey"],
103933
104235
  properties: {
103934
104236
  collection: {
@@ -103948,7 +104250,7 @@ var schemaDict = {
103948
104250
  defs: {
103949
104251
  main: {
103950
104252
  type: "procedure",
103951
- description: "Create a new record.",
104253
+ description: "Create a single new repository record. Requires auth, implemented by PDS.",
103952
104254
  input: {
103953
104255
  encoding: "application/json",
103954
104256
  schema: {
@@ -103958,7 +104260,7 @@ var schemaDict = {
103958
104260
  repo: {
103959
104261
  type: "string",
103960
104262
  format: "at-identifier",
103961
- description: "The handle or DID of the repo."
104263
+ description: "The handle or DID of the repo (aka, current account)."
103962
104264
  },
103963
104265
  collection: {
103964
104266
  type: "string",
@@ -103967,17 +104269,17 @@ var schemaDict = {
103967
104269
  },
103968
104270
  rkey: {
103969
104271
  type: "string",
103970
- description: "The key of the record.",
104272
+ description: "The Record Key.",
103971
104273
  maxLength: 15
103972
104274
  },
103973
104275
  validate: {
103974
104276
  type: "boolean",
103975
104277
  default: true,
103976
- description: "Flag for validating the record."
104278
+ description: "Can be set to 'false' to skip Lexicon schema validation of record data."
103977
104279
  },
103978
104280
  record: {
103979
104281
  type: "unknown",
103980
- description: "The record to create."
104282
+ description: "The record itself. Must contain a $type field."
103981
104283
  },
103982
104284
  swapCommit: {
103983
104285
  type: "string",
@@ -104006,7 +104308,8 @@ var schemaDict = {
104006
104308
  },
104007
104309
  errors: [
104008
104310
  {
104009
- name: "InvalidSwap"
104311
+ name: "InvalidSwap",
104312
+ description: "Indicates that 'swapCommit' didn't match current repo commit."
104010
104313
  }
104011
104314
  ]
104012
104315
  }
@@ -104018,7 +104321,7 @@ var schemaDict = {
104018
104321
  defs: {
104019
104322
  main: {
104020
104323
  type: "procedure",
104021
- description: "Delete a record, or ensure it doesn't exist.",
104324
+ description: "Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS.",
104022
104325
  input: {
104023
104326
  encoding: "application/json",
104024
104327
  schema: {
@@ -104028,7 +104331,7 @@ var schemaDict = {
104028
104331
  repo: {
104029
104332
  type: "string",
104030
104333
  format: "at-identifier",
104031
- description: "The handle or DID of the repo."
104334
+ description: "The handle or DID of the repo (aka, current account)."
104032
104335
  },
104033
104336
  collection: {
104034
104337
  type: "string",
@@ -104037,7 +104340,7 @@ var schemaDict = {
104037
104340
  },
104038
104341
  rkey: {
104039
104342
  type: "string",
104040
- description: "The key of the record."
104343
+ description: "The Record Key."
104041
104344
  },
104042
104345
  swapRecord: {
104043
104346
  type: "string",
@@ -104066,7 +104369,7 @@ var schemaDict = {
104066
104369
  defs: {
104067
104370
  main: {
104068
104371
  type: "query",
104069
- description: "Get information about the repo, including the list of collections.",
104372
+ description: "Get information about an account and repository, including the list of collections. Does not require auth.",
104070
104373
  parameters: {
104071
104374
  type: "params",
104072
104375
  required: ["repo"],
@@ -104099,17 +104402,20 @@ var schemaDict = {
104099
104402
  format: "did"
104100
104403
  },
104101
104404
  didDoc: {
104102
- type: "unknown"
104405
+ type: "unknown",
104406
+ description: "The complete DID document for this account."
104103
104407
  },
104104
104408
  collections: {
104105
104409
  type: "array",
104410
+ description: "List of all the collections (NSIDs) for which this repo contains at least one record.",
104106
104411
  items: {
104107
104412
  type: "string",
104108
104413
  format: "nsid"
104109
104414
  }
104110
104415
  },
104111
104416
  handleIsCorrect: {
104112
- type: "boolean"
104417
+ type: "boolean",
104418
+ description: "Indicates if handle is currently valid (resolves bi-directionally)"
104113
104419
  }
104114
104420
  }
104115
104421
  }
@@ -104123,7 +104429,7 @@ var schemaDict = {
104123
104429
  defs: {
104124
104430
  main: {
104125
104431
  type: "query",
104126
- description: "Get a record.",
104432
+ description: "Get a single record from a repository. Does not require auth.",
104127
104433
  parameters: {
104128
104434
  type: "params",
104129
104435
  required: ["repo", "collection", "rkey"],
@@ -104140,7 +104446,7 @@ var schemaDict = {
104140
104446
  },
104141
104447
  rkey: {
104142
104448
  type: "string",
104143
- description: "The key of the record."
104449
+ description: "The Record Key."
104144
104450
  },
104145
104451
  cid: {
104146
104452
  type: "string",
@@ -104178,7 +104484,7 @@ var schemaDict = {
104178
104484
  defs: {
104179
104485
  main: {
104180
104486
  type: "query",
104181
- description: "List a range of records in a collection.",
104487
+ description: "List a range of records in a repository, matching a specific collection. Does not require auth.",
104182
104488
  parameters: {
104183
104489
  type: "params",
104184
104490
  required: ["repo", "collection"],
@@ -104262,7 +104568,7 @@ var schemaDict = {
104262
104568
  defs: {
104263
104569
  main: {
104264
104570
  type: "procedure",
104265
- description: "Write a record, creating or updating it as needed.",
104571
+ description: "Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS.",
104266
104572
  input: {
104267
104573
  encoding: "application/json",
104268
104574
  schema: {
@@ -104273,7 +104579,7 @@ var schemaDict = {
104273
104579
  repo: {
104274
104580
  type: "string",
104275
104581
  format: "at-identifier",
104276
- description: "The handle or DID of the repo."
104582
+ description: "The handle or DID of the repo (aka, current account)."
104277
104583
  },
104278
104584
  collection: {
104279
104585
  type: "string",
@@ -104282,13 +104588,13 @@ var schemaDict = {
104282
104588
  },
104283
104589
  rkey: {
104284
104590
  type: "string",
104285
- description: "The key of the record.",
104591
+ description: "The Record Key.",
104286
104592
  maxLength: 15
104287
104593
  },
104288
104594
  validate: {
104289
104595
  type: "boolean",
104290
104596
  default: true,
104291
- description: "Flag for validating the record."
104597
+ description: "Can be set to 'false' to skip Lexicon schema validation of record data."
104292
104598
  },
104293
104599
  record: {
104294
104600
  type: "unknown",
@@ -104297,7 +104603,7 @@ var schemaDict = {
104297
104603
  swapRecord: {
104298
104604
  type: "string",
104299
104605
  format: "cid",
104300
- description: "Compare and swap with the previous record by CID."
104606
+ description: "Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation"
104301
104607
  },
104302
104608
  swapCommit: {
104303
104609
  type: "string",
@@ -104359,7 +104665,7 @@ var schemaDict = {
104359
104665
  defs: {
104360
104666
  main: {
104361
104667
  type: "procedure",
104362
- description: "Upload a new blob to be added to repo in a later request.",
104668
+ description: "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.",
104363
104669
  input: {
104364
104670
  encoding: "*/*"
104365
104671
  },
@@ -104423,7 +104729,7 @@ var schemaDict = {
104423
104729
  defs: {
104424
104730
  main: {
104425
104731
  type: "procedure",
104426
- description: "Create an account.",
104732
+ description: "Create an account. Implemented by PDS.",
104427
104733
  input: {
104428
104734
  encoding: "application/json",
104429
104735
  schema: {
@@ -104435,11 +104741,13 @@ var schemaDict = {
104435
104741
  },
104436
104742
  handle: {
104437
104743
  type: "string",
104438
- format: "handle"
104744
+ format: "handle",
104745
+ description: "Requested handle for the account."
104439
104746
  },
104440
104747
  did: {
104441
104748
  type: "string",
104442
- format: "did"
104749
+ format: "did",
104750
+ description: "Pre-existing atproto DID, being imported to a new account."
104443
104751
  },
104444
104752
  inviteCode: {
104445
104753
  type: "string"
@@ -104451,13 +104759,16 @@ var schemaDict = {
104451
104759
  type: "string"
104452
104760
  },
104453
104761
  password: {
104454
- type: "string"
104762
+ type: "string",
104763
+ description: "Initial account password. May need to meet instance-specific password strength requirements."
104455
104764
  },
104456
104765
  recoveryKey: {
104457
- type: "string"
104766
+ type: "string",
104767
+ description: "DID PLC rotation key (aka, recovery key) to be included in PLC creation operation."
104458
104768
  },
104459
104769
  plcOp: {
104460
- type: "unknown"
104770
+ type: "unknown",
104771
+ description: "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."
104461
104772
  }
104462
104773
  }
104463
104774
  }
@@ -104466,6 +104777,7 @@ var schemaDict = {
104466
104777
  encoding: "application/json",
104467
104778
  schema: {
104468
104779
  type: "object",
104780
+ description: "Account login session returned on successful account creation.",
104469
104781
  required: ["accessJwt", "refreshJwt", "handle", "did"],
104470
104782
  properties: {
104471
104783
  accessJwt: {
@@ -104480,10 +104792,12 @@ var schemaDict = {
104480
104792
  },
104481
104793
  did: {
104482
104794
  type: "string",
104483
- format: "did"
104795
+ format: "did",
104796
+ description: "The DID of the new account."
104484
104797
  },
104485
104798
  didDoc: {
104486
- type: "unknown"
104799
+ type: "unknown",
104800
+ description: "Complete DID document."
104487
104801
  }
104488
104802
  }
104489
104803
  }
@@ -104528,7 +104842,8 @@ var schemaDict = {
104528
104842
  required: ["name"],
104529
104843
  properties: {
104530
104844
  name: {
104531
- type: "string"
104845
+ type: "string",
104846
+ description: "A short name for the App Password, to help distinguish them."
104532
104847
  }
104533
104848
  }
104534
104849
  }
@@ -104795,7 +105110,7 @@ var schemaDict = {
104795
105110
  defs: {
104796
105111
  main: {
104797
105112
  type: "procedure",
104798
- description: "Delete an actor's account with a token and password.",
105113
+ description: "Delete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth.",
104799
105114
  input: {
104800
105115
  encoding: "application/json",
104801
105116
  schema: {
@@ -104832,7 +105147,7 @@ var schemaDict = {
104832
105147
  defs: {
104833
105148
  main: {
104834
105149
  type: "procedure",
104835
- description: "Delete the current session."
105150
+ description: "Delete the current session. Requires auth."
104836
105151
  }
104837
105152
  }
104838
105153
  },
@@ -104842,7 +105157,7 @@ var schemaDict = {
104842
105157
  defs: {
104843
105158
  main: {
104844
105159
  type: "query",
104845
- description: "Get a document describing the service's accounts configuration.",
105160
+ description: "Describes the server's account creation requirements and capabilities. Implemented by PDS.",
104846
105161
  output: {
104847
105162
  encoding: "application/json",
104848
105163
  schema: {
@@ -104850,19 +105165,23 @@ var schemaDict = {
104850
105165
  required: ["availableUserDomains"],
104851
105166
  properties: {
104852
105167
  inviteCodeRequired: {
104853
- type: "boolean"
105168
+ type: "boolean",
105169
+ description: "If true, an invite code must be supplied to create an account on this instance."
104854
105170
  },
104855
105171
  phoneVerificationRequired: {
104856
- type: "boolean"
105172
+ type: "boolean",
105173
+ description: "If true, a phone verification token must be supplied to create an account on this instance."
104857
105174
  },
104858
105175
  availableUserDomains: {
104859
105176
  type: "array",
105177
+ description: "List of domain suffixes that can be used in account handles.",
104860
105178
  items: {
104861
105179
  type: "string"
104862
105180
  }
104863
105181
  },
104864
105182
  links: {
104865
105183
  type: "ref",
105184
+ description: "URLs of service policy documents.",
104866
105185
  ref: "lex:com.atproto.server.describeServer#links"
104867
105186
  }
104868
105187
  }
@@ -104888,7 +105207,7 @@ var schemaDict = {
104888
105207
  defs: {
104889
105208
  main: {
104890
105209
  type: "query",
104891
- description: "Get all invite codes for a given account.",
105210
+ description: "Get all invite codes for the current account. Requires auth.",
104892
105211
  parameters: {
104893
105212
  type: "params",
104894
105213
  properties: {
@@ -104898,7 +105217,8 @@ var schemaDict = {
104898
105217
  },
104899
105218
  createAvailable: {
104900
105219
  type: "boolean",
104901
- default: true
105220
+ default: true,
105221
+ description: "Controls whether any new 'earned' but not 'created' invites should be created."
104902
105222
  }
104903
105223
  }
104904
105224
  },
@@ -104932,7 +105252,7 @@ var schemaDict = {
104932
105252
  defs: {
104933
105253
  main: {
104934
105254
  type: "query",
104935
- description: "Get information about the current session.",
105255
+ description: "Get information about the current auth session. Requires auth.",
104936
105256
  output: {
104937
105257
  encoding: "application/json",
104938
105258
  schema: {
@@ -105012,7 +105332,7 @@ var schemaDict = {
105012
105332
  defs: {
105013
105333
  main: {
105014
105334
  type: "procedure",
105015
- description: "Refresh an authentication session.",
105335
+ description: "Refresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt').",
105016
105336
  output: {
105017
105337
  encoding: "application/json",
105018
105338
  schema: {
@@ -105117,7 +105437,7 @@ var schemaDict = {
105117
105437
  defs: {
105118
105438
  main: {
105119
105439
  type: "procedure",
105120
- description: "Reserve a repo signing key for account creation.",
105440
+ description: "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.",
105121
105441
  input: {
105122
105442
  encoding: "application/json",
105123
105443
  schema: {
@@ -105125,7 +105445,8 @@ var schemaDict = {
105125
105445
  properties: {
105126
105446
  did: {
105127
105447
  type: "string",
105128
- description: "The did to reserve a new did:key for"
105448
+ format: "did",
105449
+ description: "The DID to reserve a key for."
105129
105450
  }
105130
105451
  }
105131
105452
  }
@@ -105138,7 +105459,7 @@ var schemaDict = {
105138
105459
  properties: {
105139
105460
  signingKey: {
105140
105461
  type: "string",
105141
- description: "Public signing key in the form of a did:key."
105462
+ description: "The public key for the reserved signing key, in did:key serialization."
105142
105463
  }
105143
105464
  }
105144
105465
  }
@@ -105244,7 +105565,7 @@ var schemaDict = {
105244
105565
  defs: {
105245
105566
  main: {
105246
105567
  type: "query",
105247
- description: "Get a blob associated with a given repo.",
105568
+ description: "Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS.",
105248
105569
  parameters: {
105249
105570
  type: "params",
105250
105571
  required: ["did", "cid"],
@@ -105252,7 +105573,7 @@ var schemaDict = {
105252
105573
  did: {
105253
105574
  type: "string",
105254
105575
  format: "did",
105255
- description: "The DID of the repo."
105576
+ description: "The DID of the account."
105256
105577
  },
105257
105578
  cid: {
105258
105579
  type: "string",
@@ -105273,7 +105594,7 @@ var schemaDict = {
105273
105594
  defs: {
105274
105595
  main: {
105275
105596
  type: "query",
105276
- description: "Get blocks from a given repo.",
105597
+ description: "Get data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS.",
105277
105598
  parameters: {
105278
105599
  type: "params",
105279
105600
  required: ["did", "cids"],
@@ -105367,7 +105688,7 @@ var schemaDict = {
105367
105688
  defs: {
105368
105689
  main: {
105369
105690
  type: "query",
105370
- description: "Get the current commit CID & revision of the repo.",
105691
+ description: "Get the current commit CID & revision of the specified repo. Does not require auth.",
105371
105692
  parameters: {
105372
105693
  type: "params",
105373
105694
  required: ["did"],
@@ -105409,7 +105730,7 @@ var schemaDict = {
105409
105730
  defs: {
105410
105731
  main: {
105411
105732
  type: "query",
105412
- description: "Get blocks needed for existence or non-existence of record.",
105733
+ description: "Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth.",
105413
105734
  parameters: {
105414
105735
  type: "params",
105415
105736
  required: ["did", "collection", "rkey"],
@@ -105424,7 +105745,8 @@ var schemaDict = {
105424
105745
  format: "nsid"
105425
105746
  },
105426
105747
  rkey: {
105427
- type: "string"
105748
+ type: "string",
105749
+ description: "Record Key"
105428
105750
  },
105429
105751
  commit: {
105430
105752
  type: "string",
@@ -105445,7 +105767,7 @@ var schemaDict = {
105445
105767
  defs: {
105446
105768
  main: {
105447
105769
  type: "query",
105448
- description: "Gets the DID's repo, optionally catching up from a specific revision.",
105770
+ description: "Download a repository export as CAR file. Optionally only a 'diff' since a previous revision. Does not require auth; implemented by PDS.",
105449
105771
  parameters: {
105450
105772
  type: "params",
105451
105773
  required: ["did"],
@@ -105457,7 +105779,7 @@ var schemaDict = {
105457
105779
  },
105458
105780
  since: {
105459
105781
  type: "string",
105460
- description: "The revision of the repo to catch up from."
105782
+ description: "The revision ('rev') of the repo to create a diff from."
105461
105783
  }
105462
105784
  }
105463
105785
  },
@@ -105473,7 +105795,7 @@ var schemaDict = {
105473
105795
  defs: {
105474
105796
  main: {
105475
105797
  type: "query",
105476
- description: "List blob CIDs since some revision.",
105798
+ description: "List blob CIDso for an account, since some repo revision. Does not require auth; implemented by PDS.",
105477
105799
  parameters: {
105478
105800
  type: "params",
105479
105801
  required: ["did"],
@@ -105526,7 +105848,7 @@ var schemaDict = {
105526
105848
  defs: {
105527
105849
  main: {
105528
105850
  type: "query",
105529
- description: "List DIDs and root CIDs of hosted repos.",
105851
+ description: "Enumerates all the DID, rev, and commit CID for all repos hosted by this service. Does not require auth; implemented by PDS and Relay.",
105530
105852
  parameters: {
105531
105853
  type: "params",
105532
105854
  properties: {
@@ -105571,7 +105893,8 @@ var schemaDict = {
105571
105893
  },
105572
105894
  head: {
105573
105895
  type: "string",
105574
- format: "cid"
105896
+ format: "cid",
105897
+ description: "Current repo commit CID"
105575
105898
  },
105576
105899
  rev: {
105577
105900
  type: "string"
@@ -105586,7 +105909,7 @@ var schemaDict = {
105586
105909
  defs: {
105587
105910
  main: {
105588
105911
  type: "procedure",
105589
- description: "Notify a crawling service of a recent update; often when a long break between updates causes the connection with the crawling service to break.",
105912
+ description: "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.",
105590
105913
  input: {
105591
105914
  encoding: "application/json",
105592
105915
  schema: {
@@ -105595,7 +105918,7 @@ var schemaDict = {
105595
105918
  properties: {
105596
105919
  hostname: {
105597
105920
  type: "string",
105598
- description: "Hostname of the service that is notifying of update."
105921
+ description: "Hostname of the current service (usually a PDS) that is notifying of update."
105599
105922
  }
105600
105923
  }
105601
105924
  }
@@ -105609,7 +105932,7 @@ var schemaDict = {
105609
105932
  defs: {
105610
105933
  main: {
105611
105934
  type: "procedure",
105612
- description: "Request a service to persistently crawl hosted repos.",
105935
+ description: "Request a service to persistently crawl hosted repos. Expected use is new PDS instances declaring their existence to Relays. Does not require auth.",
105613
105936
  input: {
105614
105937
  encoding: "application/json",
105615
105938
  schema: {
@@ -105618,7 +105941,7 @@ var schemaDict = {
105618
105941
  properties: {
105619
105942
  hostname: {
105620
105943
  type: "string",
105621
- description: "Hostname of the service that is requesting to be crawled."
105944
+ description: "Hostname of the current service (eg, PDS) that is requesting to be crawled."
105622
105945
  }
105623
105946
  }
105624
105947
  }
@@ -105632,13 +105955,13 @@ var schemaDict = {
105632
105955
  defs: {
105633
105956
  main: {
105634
105957
  type: "subscription",
105635
- description: "Subscribe to repo updates.",
105958
+ description: "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.",
105636
105959
  parameters: {
105637
105960
  type: "params",
105638
105961
  properties: {
105639
105962
  cursor: {
105640
105963
  type: "integer",
105641
- description: "The last known event to backfill from."
105964
+ description: "The last known event seq number to backfill from."
105642
105965
  }
105643
105966
  }
105644
105967
  },
@@ -105659,12 +105982,14 @@ var schemaDict = {
105659
105982
  name: "FutureCursor"
105660
105983
  },
105661
105984
  {
105662
- name: "ConsumerTooSlow"
105985
+ name: "ConsumerTooSlow",
105986
+ description: "If the consumer of the stream can not keep up with events, and a backlog gets too large, the server will drop the connection."
105663
105987
  }
105664
105988
  ]
105665
105989
  },
105666
105990
  commit: {
105667
105991
  type: "object",
105992
+ description: "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.",
105668
105993
  required: [
105669
105994
  "seq",
105670
105995
  "rebase",
@@ -105681,59 +106006,69 @@ var schemaDict = {
105681
106006
  nullable: ["prev", "since"],
105682
106007
  properties: {
105683
106008
  seq: {
105684
- type: "integer"
106009
+ type: "integer",
106010
+ description: "The stream sequence number of this message."
105685
106011
  },
105686
106012
  rebase: {
105687
- type: "boolean"
106013
+ type: "boolean",
106014
+ description: "DEPRECATED -- unused"
105688
106015
  },
105689
106016
  tooBig: {
105690
- type: "boolean"
106017
+ type: "boolean",
106018
+ description: "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."
105691
106019
  },
105692
106020
  repo: {
105693
106021
  type: "string",
105694
- format: "did"
106022
+ format: "did",
106023
+ description: "The repo this event comes from."
105695
106024
  },
105696
106025
  commit: {
105697
- type: "cid-link"
106026
+ type: "cid-link",
106027
+ description: "Repo commit object CID."
105698
106028
  },
105699
106029
  prev: {
105700
- type: "cid-link"
106030
+ type: "cid-link",
106031
+ description: "DEPRECATED -- unused. WARNING -- nullable and optional; stick with optional to ensure golang interoperability."
105701
106032
  },
105702
106033
  rev: {
105703
106034
  type: "string",
105704
- description: "The rev of the emitted commit."
106035
+ description: "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."
105705
106036
  },
105706
106037
  since: {
105707
106038
  type: "string",
105708
- description: "The rev of the last emitted commit from this repo."
106039
+ description: "The rev of the last emitted commit from this repo (if any)."
105709
106040
  },
105710
106041
  blocks: {
105711
106042
  type: "bytes",
105712
- description: "CAR file containing relevant blocks.",
106043
+ description: "CAR file containing relevant blocks, as a diff since the previous repo state.",
105713
106044
  maxLength: 1e6
105714
106045
  },
105715
106046
  ops: {
105716
106047
  type: "array",
105717
106048
  items: {
105718
106049
  type: "ref",
105719
- ref: "lex:com.atproto.sync.subscribeRepos#repoOp"
106050
+ ref: "lex:com.atproto.sync.subscribeRepos#repoOp",
106051
+ description: "List of repo mutation operations in this commit (eg, records created, updated, or deleted)."
105720
106052
  },
105721
106053
  maxLength: 200
105722
106054
  },
105723
106055
  blobs: {
105724
106056
  type: "array",
105725
106057
  items: {
105726
- type: "cid-link"
106058
+ type: "cid-link",
106059
+ description: "List of new blobs (by CID) referenced by records in this commit."
105727
106060
  }
105728
106061
  },
105729
106062
  time: {
105730
106063
  type: "string",
105731
- format: "datetime"
106064
+ format: "datetime",
106065
+ description: "Timestamp of when this message was originally broadcast."
105732
106066
  }
105733
106067
  }
105734
106068
  },
105735
106069
  handle: {
105736
106070
  type: "object",
106071
+ description: "Represents an update of the account's handle, or transition to/from invalid state.",
105737
106072
  required: ["seq", "did", "handle", "time"],
105738
106073
  properties: {
105739
106074
  seq: {
@@ -105755,6 +106090,7 @@ var schemaDict = {
105755
106090
  },
105756
106091
  migrate: {
105757
106092
  type: "object",
106093
+ description: "Represents an account moving from one PDS instance to another. NOTE: not implemented; full account migration may introduce a new message instead.",
105758
106094
  required: ["seq", "did", "migrateTo", "time"],
105759
106095
  nullable: ["migrateTo"],
105760
106096
  properties: {
@@ -105776,6 +106112,7 @@ var schemaDict = {
105776
106112
  },
105777
106113
  tombstone: {
105778
106114
  type: "object",
106115
+ description: "Indicates that an account has been deleted.",
105779
106116
  required: ["seq", "did", "time"],
105780
106117
  properties: {
105781
106118
  seq: {
@@ -105806,7 +106143,7 @@ var schemaDict = {
105806
106143
  },
105807
106144
  repoOp: {
105808
106145
  type: "object",
105809
- description: "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.",
106146
+ description: "A repo operation, ie a mutation of a single record.",
105810
106147
  required: ["action", "path", "cid"],
105811
106148
  nullable: ["cid"],
105812
106149
  properties: {
@@ -105818,7 +106155,8 @@ var schemaDict = {
105818
106155
  type: "string"
105819
106156
  },
105820
106157
  cid: {
105821
- type: "cid-link"
106158
+ type: "cid-link",
106159
+ description: "For creates and updates, the new record CID. For deletions, null."
105822
106160
  }
105823
106161
  }
105824
106162
  }
@@ -105858,7 +106196,7 @@ var schemaDict = {
105858
106196
  defs: {
105859
106197
  main: {
105860
106198
  type: "query",
105861
- description: "Fetch all labels from a labeler created after a certain date.",
106199
+ description: "Fetch all labels from a labeler created after a certain date. DEPRECATED: use queryLabels or subscribeLabels instead",
105862
106200
  parameters: {
105863
106201
  type: "params",
105864
106202
  properties: {
@@ -105971,7 +106309,7 @@ var schemaDict = {
105971
106309
  defs: {
105972
106310
  main: {
105973
106311
  type: "procedure",
105974
- description: "Transfer an account.",
106312
+ description: "Transfer an account. NOTE: temporary method, necessarily how account migration will be implemented.",
105975
106313
  input: {
105976
106314
  encoding: "application/json",
105977
106315
  schema: {
@@ -106044,7 +106382,6 @@ var schemaDict = {
106044
106382
  AppBskyActorDefs: {
106045
106383
  lexicon: 1,
106046
106384
  id: "app.bsky.actor.defs",
106047
- description: "A reference to an actor in the network.",
106048
106385
  defs: {
106049
106386
  profileViewBasic: {
106050
106387
  type: "object",
@@ -106177,6 +106514,7 @@ var schemaDict = {
106177
106514
  },
106178
106515
  viewerState: {
106179
106516
  type: "object",
106517
+ description: "Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.",
106180
106518
  properties: {
106181
106519
  muted: {
106182
106520
  type: "boolean"
@@ -106261,6 +106599,9 @@ var schemaDict = {
106261
106599
  type: "string",
106262
106600
  format: "at-uri"
106263
106601
  }
106602
+ },
106603
+ timelineIndex: {
106604
+ type: "integer"
106264
106605
  }
106265
106606
  }
106266
106607
  },
@@ -106342,7 +106683,7 @@ var schemaDict = {
106342
106683
  defs: {
106343
106684
  main: {
106344
106685
  type: "query",
106345
- description: "Get private preferences attached to the account.",
106686
+ description: "Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.",
106346
106687
  parameters: {
106347
106688
  type: "params",
106348
106689
  properties: {}
@@ -106369,14 +106710,15 @@ var schemaDict = {
106369
106710
  defs: {
106370
106711
  main: {
106371
106712
  type: "query",
106372
- description: "Get detailed profile view of an actor.",
106713
+ description: "Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth.",
106373
106714
  parameters: {
106374
106715
  type: "params",
106375
106716
  required: ["actor"],
106376
106717
  properties: {
106377
106718
  actor: {
106378
106719
  type: "string",
106379
- format: "at-identifier"
106720
+ format: "at-identifier",
106721
+ description: "Handle or DID of account to fetch profile of."
106380
106722
  }
106381
106723
  }
106382
106724
  },
@@ -106436,7 +106778,7 @@ var schemaDict = {
106436
106778
  defs: {
106437
106779
  main: {
106438
106780
  type: "query",
106439
- description: "Get a list of suggested actors, used for discovery.",
106781
+ description: "Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding.",
106440
106782
  parameters: {
106441
106783
  type: "params",
106442
106784
  properties: {
@@ -106479,7 +106821,7 @@ var schemaDict = {
106479
106821
  defs: {
106480
106822
  main: {
106481
106823
  type: "record",
106482
- description: "A declaration of a profile.",
106824
+ description: "A declaration of a Bluesky account profile.",
106483
106825
  key: "literal:self",
106484
106826
  record: {
106485
106827
  type: "object",
@@ -106491,21 +106833,25 @@ var schemaDict = {
106491
106833
  },
106492
106834
  description: {
106493
106835
  type: "string",
106836
+ description: "Free-form profile description text.",
106494
106837
  maxGraphemes: 256,
106495
106838
  maxLength: 2560
106496
106839
  },
106497
106840
  avatar: {
106498
106841
  type: "blob",
106842
+ description: "Small image to be displayed next to posts from account. AKA, 'profile picture'",
106499
106843
  accept: ["image/png", "image/jpeg"],
106500
106844
  maxSize: 1e6
106501
106845
  },
106502
106846
  banner: {
106503
106847
  type: "blob",
106848
+ description: "Larger horizontal image to display behind profile view.",
106504
106849
  accept: ["image/png", "image/jpeg"],
106505
106850
  maxSize: 1e6
106506
106851
  },
106507
106852
  labels: {
106508
106853
  type: "union",
106854
+ description: "Self-label values, specific to the Bluesky application, on the overall account.",
106509
106855
  refs: ["lex:com.atproto.label.defs#selfLabels"]
106510
106856
  }
106511
106857
  }
@@ -106542,7 +106888,7 @@ var schemaDict = {
106542
106888
  defs: {
106543
106889
  main: {
106544
106890
  type: "query",
106545
- description: "Find actors (profiles) matching search criteria.",
106891
+ description: "Find actors (profiles) matching search criteria. Does not require auth.",
106546
106892
  parameters: {
106547
106893
  type: "params",
106548
106894
  properties: {
@@ -106593,7 +106939,7 @@ var schemaDict = {
106593
106939
  defs: {
106594
106940
  main: {
106595
106941
  type: "query",
106596
- description: "Find actor suggestions for a prefix search term.",
106942
+ description: "Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth.",
106597
106943
  parameters: {
106598
106944
  type: "params",
106599
106945
  properties: {
@@ -106635,10 +106981,10 @@ var schemaDict = {
106635
106981
  AppBskyEmbedExternal: {
106636
106982
  lexicon: 1,
106637
106983
  id: "app.bsky.embed.external",
106638
- description: "A representation of some externally linked content, embedded in another form of content.",
106639
106984
  defs: {
106640
106985
  main: {
106641
106986
  type: "object",
106987
+ description: "A representation of some externally linked content (eg, a URL and 'card'), embedded in a Bluesky record (eg, a post).",
106642
106988
  required: ["external"],
106643
106989
  properties: {
106644
106990
  external: {
@@ -106702,7 +107048,7 @@ var schemaDict = {
106702
107048
  AppBskyEmbedImages: {
106703
107049
  lexicon: 1,
106704
107050
  id: "app.bsky.embed.images",
106705
- description: "A set of images embedded in some other form of content.",
107051
+ description: "A set of images embedded in a Bluesky record (eg, a post).",
106706
107052
  defs: {
106707
107053
  main: {
106708
107054
  type: "object",
@@ -106728,7 +107074,8 @@ var schemaDict = {
106728
107074
  maxSize: 1e6
106729
107075
  },
106730
107076
  alt: {
106731
- type: "string"
107077
+ type: "string",
107078
+ description: "Alt text description of the image, for accessibility."
106732
107079
  },
106733
107080
  aspectRatio: {
106734
107081
  type: "ref",
@@ -106770,13 +107117,16 @@ var schemaDict = {
106770
107117
  required: ["thumb", "fullsize", "alt"],
106771
107118
  properties: {
106772
107119
  thumb: {
106773
- type: "string"
107120
+ type: "string",
107121
+ description: "Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View."
106774
107122
  },
106775
107123
  fullsize: {
106776
- type: "string"
107124
+ type: "string",
107125
+ description: "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."
106777
107126
  },
106778
107127
  alt: {
106779
- type: "string"
107128
+ type: "string",
107129
+ description: "Alt text description of the image, for accessibility."
106780
107130
  },
106781
107131
  aspectRatio: {
106782
107132
  type: "ref",
@@ -106789,7 +107139,7 @@ var schemaDict = {
106789
107139
  AppBskyEmbedRecord: {
106790
107140
  lexicon: 1,
106791
107141
  id: "app.bsky.embed.record",
106792
- description: "A representation of a record embedded in another form of content.",
107142
+ description: "A representation of a record embedded in a Bluesky record (eg, a post). For example, a quote-post, or sharing a feed generator record.",
106793
107143
  defs: {
106794
107144
  main: {
106795
107145
  type: "object",
@@ -106834,7 +107184,8 @@ var schemaDict = {
106834
107184
  ref: "lex:app.bsky.actor.defs#profileViewBasic"
106835
107185
  },
106836
107186
  value: {
106837
- type: "unknown"
107187
+ type: "unknown",
107188
+ description: "The record data itself."
106838
107189
  },
106839
107190
  labels: {
106840
107191
  type: "array",
@@ -106898,7 +107249,7 @@ var schemaDict = {
106898
107249
  AppBskyEmbedRecordWithMedia: {
106899
107250
  lexicon: 1,
106900
107251
  id: "app.bsky.embed.recordWithMedia",
106901
- description: "A representation of a record embedded in another form of content, alongside other compatible embeds.",
107252
+ description: "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.",
106902
107253
  defs: {
106903
107254
  main: {
106904
107255
  type: "object",
@@ -106997,6 +107348,7 @@ var schemaDict = {
106997
107348
  },
106998
107349
  viewerState: {
106999
107350
  type: "object",
107351
+ description: "Metadata about the requesting account's relationship with the subject content. Only has meaningful content for authed requests.",
107000
107352
  properties: {
107001
107353
  repost: {
107002
107354
  type: "string",
@@ -107256,7 +107608,7 @@ var schemaDict = {
107256
107608
  defs: {
107257
107609
  main: {
107258
107610
  type: "query",
107259
- description: "Get information about a feed generator, including policies and offered feed URIs.",
107611
+ description: "Get information about a feed generator, including policies and offered feed URIs. Does not require auth; implemented by Feed Generator services (not App View).",
107260
107612
  output: {
107261
107613
  encoding: "application/json",
107262
107614
  schema: {
@@ -107311,7 +107663,7 @@ var schemaDict = {
107311
107663
  defs: {
107312
107664
  main: {
107313
107665
  type: "record",
107314
- description: "A declaration of the existence of a feed generator.",
107666
+ description: "Record declaring of the existence of a feed generator, and containing metadata about it. The record can exist in any repository.",
107315
107667
  key: "any",
107316
107668
  record: {
107317
107669
  type: "object",
@@ -107345,6 +107697,7 @@ var schemaDict = {
107345
107697
  },
107346
107698
  labels: {
107347
107699
  type: "union",
107700
+ description: "Self-label values",
107348
107701
  refs: ["lex:com.atproto.label.defs#selfLabels"]
107349
107702
  },
107350
107703
  createdAt: {
@@ -107362,7 +107715,7 @@ var schemaDict = {
107362
107715
  defs: {
107363
107716
  main: {
107364
107717
  type: "query",
107365
- description: "Get a list of feeds created by the actor.",
107718
+ description: "Get a list of feeds (feed generator records) created by the actor (in the actor's repo).",
107366
107719
  parameters: {
107367
107720
  type: "params",
107368
107721
  required: ["actor"],
@@ -107410,7 +107763,7 @@ var schemaDict = {
107410
107763
  defs: {
107411
107764
  main: {
107412
107765
  type: "query",
107413
- description: "Get a list of posts liked by an actor.",
107766
+ description: "Get a list of posts liked by an actor. Does not require auth.",
107414
107767
  parameters: {
107415
107768
  type: "params",
107416
107769
  required: ["actor"],
@@ -107466,7 +107819,7 @@ var schemaDict = {
107466
107819
  defs: {
107467
107820
  main: {
107468
107821
  type: "query",
107469
- description: "Get a view of an actor's feed.",
107822
+ description: "Get a view of an actor's 'author feed' (post and reposts by the author). Does not require auth.",
107470
107823
  parameters: {
107471
107824
  type: "params",
107472
107825
  required: ["actor"],
@@ -107486,6 +107839,7 @@ var schemaDict = {
107486
107839
  },
107487
107840
  filter: {
107488
107841
  type: "string",
107842
+ description: "Combinations of post/repost types to include in response.",
107489
107843
  knownValues: [
107490
107844
  "posts_with_replies",
107491
107845
  "posts_no_replies",
@@ -107532,7 +107886,7 @@ var schemaDict = {
107532
107886
  defs: {
107533
107887
  main: {
107534
107888
  type: "query",
107535
- description: "Get a hydrated feed from an actor's selected feed generator.",
107889
+ description: "Get a hydrated feed from an actor's selected feed generator. Implemented by App View.",
107536
107890
  parameters: {
107537
107891
  type: "params",
107538
107892
  required: ["feed"],
@@ -107585,14 +107939,15 @@ var schemaDict = {
107585
107939
  defs: {
107586
107940
  main: {
107587
107941
  type: "query",
107588
- description: "Get information about a feed generator.",
107942
+ description: "Get information about a feed generator. Implemented by AppView.",
107589
107943
  parameters: {
107590
107944
  type: "params",
107591
107945
  required: ["feed"],
107592
107946
  properties: {
107593
107947
  feed: {
107594
107948
  type: "string",
107595
- format: "at-uri"
107949
+ format: "at-uri",
107950
+ description: "AT-URI of the feed generator record."
107596
107951
  }
107597
107952
  }
107598
107953
  },
@@ -107607,10 +107962,12 @@ var schemaDict = {
107607
107962
  ref: "lex:app.bsky.feed.defs#generatorView"
107608
107963
  },
107609
107964
  isOnline: {
107610
- type: "boolean"
107965
+ type: "boolean",
107966
+ description: "Indicates whether the feed generator service has been online recently, or else seems to be inactive."
107611
107967
  },
107612
107968
  isValid: {
107613
- type: "boolean"
107969
+ type: "boolean",
107970
+ description: "Indicates whether the feed generator service is compatible with the record declaration."
107614
107971
  }
107615
107972
  }
107616
107973
  }
@@ -107663,14 +108020,15 @@ var schemaDict = {
107663
108020
  defs: {
107664
108021
  main: {
107665
108022
  type: "query",
107666
- description: "Get a skeleton of a feed provided by a feed generator.",
108023
+ description: "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.",
107667
108024
  parameters: {
107668
108025
  type: "params",
107669
108026
  required: ["feed"],
107670
108027
  properties: {
107671
108028
  feed: {
107672
108029
  type: "string",
107673
- format: "at-uri"
108030
+ format: "at-uri",
108031
+ description: "Reference to feed generator record describing the specific feed being requested."
107674
108032
  },
107675
108033
  limit: {
107676
108034
  type: "integer",
@@ -107716,18 +108074,20 @@ var schemaDict = {
107716
108074
  defs: {
107717
108075
  main: {
107718
108076
  type: "query",
107719
- description: "Get the list of likes.",
108077
+ description: "Get like records which reference a subject (by AT-URI and CID).",
107720
108078
  parameters: {
107721
108079
  type: "params",
107722
108080
  required: ["uri"],
107723
108081
  properties: {
107724
108082
  uri: {
107725
108083
  type: "string",
107726
- format: "at-uri"
108084
+ format: "at-uri",
108085
+ description: "AT-URI of the subject (eg, a post record)."
107727
108086
  },
107728
108087
  cid: {
107729
108088
  type: "string",
107730
- format: "cid"
108089
+ format: "cid",
108090
+ description: "CID of the subject record (aka, specific version of record), to filter likes."
107731
108091
  },
107732
108092
  limit: {
107733
108093
  type: "integer",
@@ -107794,14 +108154,15 @@ var schemaDict = {
107794
108154
  defs: {
107795
108155
  main: {
107796
108156
  type: "query",
107797
- description: "Get a view of a recent posts from actors in a list.",
108157
+ description: "Get a feed of recent posts from a list (posts and reposts from any actors on the list). Does not require auth.",
107798
108158
  parameters: {
107799
108159
  type: "params",
107800
108160
  required: ["list"],
107801
108161
  properties: {
107802
108162
  list: {
107803
108163
  type: "string",
107804
- format: "at-uri"
108164
+ format: "at-uri",
108165
+ description: "Reference (AT-URI) to the list record."
107805
108166
  },
107806
108167
  limit: {
107807
108168
  type: "integer",
@@ -107847,23 +108208,26 @@ var schemaDict = {
107847
108208
  defs: {
107848
108209
  main: {
107849
108210
  type: "query",
107850
- description: "Get posts in a thread.",
108211
+ description: "Get posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests.",
107851
108212
  parameters: {
107852
108213
  type: "params",
107853
108214
  required: ["uri"],
107854
108215
  properties: {
107855
108216
  uri: {
107856
108217
  type: "string",
107857
- format: "at-uri"
108218
+ format: "at-uri",
108219
+ description: "Reference (AT-URI) to post record."
107858
108220
  },
107859
108221
  depth: {
107860
108222
  type: "integer",
108223
+ description: "How many levels of reply depth should be included in response.",
107861
108224
  default: 6,
107862
108225
  minimum: 0,
107863
108226
  maximum: 1e3
107864
108227
  },
107865
108228
  parentHeight: {
107866
108229
  type: "integer",
108230
+ description: "How many levels of parent (and grandparent, etc) post to include.",
107867
108231
  default: 80,
107868
108232
  minimum: 0,
107869
108233
  maximum: 1e3
@@ -107901,13 +108265,14 @@ var schemaDict = {
107901
108265
  defs: {
107902
108266
  main: {
107903
108267
  type: "query",
107904
- description: "Get a view of an actor's feed.",
108268
+ description: "Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'.",
107905
108269
  parameters: {
107906
108270
  type: "params",
107907
108271
  required: ["uris"],
107908
108272
  properties: {
107909
108273
  uris: {
107910
108274
  type: "array",
108275
+ description: "List of post AT-URIs to return hydrated views for.",
107911
108276
  items: {
107912
108277
  type: "string",
107913
108278
  format: "at-uri"
@@ -107941,18 +108306,20 @@ var schemaDict = {
107941
108306
  defs: {
107942
108307
  main: {
107943
108308
  type: "query",
107944
- description: "Get a list of reposts.",
108309
+ description: "Get a list of reposts for a given post.",
107945
108310
  parameters: {
107946
108311
  type: "params",
107947
108312
  required: ["uri"],
107948
108313
  properties: {
107949
108314
  uri: {
107950
108315
  type: "string",
107951
- format: "at-uri"
108316
+ format: "at-uri",
108317
+ description: "Reference (AT-URI) of post record"
107952
108318
  },
107953
108319
  cid: {
107954
108320
  type: "string",
107955
- format: "cid"
108321
+ format: "cid",
108322
+ description: "If supplied, filters to reposts of specific version (by CID) of the post record."
107956
108323
  },
107957
108324
  limit: {
107958
108325
  type: "integer",
@@ -108001,7 +108368,7 @@ var schemaDict = {
108001
108368
  defs: {
108002
108369
  main: {
108003
108370
  type: "query",
108004
- description: "Get a list of suggested feeds for the viewer.",
108371
+ description: "Get a list of suggested feeds (feed generators) for the requesting account.",
108005
108372
  parameters: {
108006
108373
  type: "params",
108007
108374
  properties: {
@@ -108044,12 +108411,13 @@ var schemaDict = {
108044
108411
  defs: {
108045
108412
  main: {
108046
108413
  type: "query",
108047
- description: "Get a view of the actor's home timeline.",
108414
+ description: "Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed.",
108048
108415
  parameters: {
108049
108416
  type: "params",
108050
108417
  properties: {
108051
108418
  algorithm: {
108052
- type: "string"
108419
+ type: "string",
108420
+ description: "Variant 'algorithm' for timeline. Implementation-specific. NOTE: most feed flexibility has been moved to feed generator mechanism."
108053
108421
  },
108054
108422
  limit: {
108055
108423
  type: "integer",
@@ -108090,7 +108458,7 @@ var schemaDict = {
108090
108458
  defs: {
108091
108459
  main: {
108092
108460
  type: "record",
108093
- description: "A declaration of a like.",
108461
+ description: "Record declaring a 'like' of a piece of subject content.",
108094
108462
  key: "tid",
108095
108463
  record: {
108096
108464
  type: "object",
@@ -108115,7 +108483,7 @@ var schemaDict = {
108115
108483
  defs: {
108116
108484
  main: {
108117
108485
  type: "record",
108118
- description: "A declaration of a post.",
108486
+ description: "Record containing a Bluesky post.",
108119
108487
  key: "tid",
108120
108488
  record: {
108121
108489
  type: "object",
@@ -108124,11 +108492,12 @@ var schemaDict = {
108124
108492
  text: {
108125
108493
  type: "string",
108126
108494
  maxLength: 3e3,
108127
- maxGraphemes: 300
108495
+ maxGraphemes: 300,
108496
+ description: "The primary post content. May be an empty string, if there are embeds."
108128
108497
  },
108129
108498
  entities: {
108130
108499
  type: "array",
108131
- description: "Deprecated: replaced by app.bsky.richtext.facet.",
108500
+ description: "DEPRECATED: replaced by app.bsky.richtext.facet.",
108132
108501
  items: {
108133
108502
  type: "ref",
108134
108503
  ref: "lex:app.bsky.feed.post#entity"
@@ -108136,6 +108505,7 @@ var schemaDict = {
108136
108505
  },
108137
108506
  facets: {
108138
108507
  type: "array",
108508
+ description: "Annotations of text (mentions, URLs, hashtags, etc)",
108139
108509
  items: {
108140
108510
  type: "ref",
108141
108511
  ref: "lex:app.bsky.richtext.facet"
@@ -108156,6 +108526,7 @@ var schemaDict = {
108156
108526
  },
108157
108527
  langs: {
108158
108528
  type: "array",
108529
+ description: "Indicates human language of post primary text content.",
108159
108530
  maxLength: 3,
108160
108531
  items: {
108161
108532
  type: "string",
@@ -108164,21 +108535,23 @@ var schemaDict = {
108164
108535
  },
108165
108536
  labels: {
108166
108537
  type: "union",
108538
+ description: "Self-label values for this post. Effectively content warnings.",
108167
108539
  refs: ["lex:com.atproto.label.defs#selfLabels"]
108168
108540
  },
108169
108541
  tags: {
108170
108542
  type: "array",
108543
+ description: "Additional non-inline tags describing this post.",
108171
108544
  maxLength: 8,
108172
108545
  items: {
108173
108546
  type: "string",
108174
108547
  maxLength: 640,
108175
108548
  maxGraphemes: 64
108176
- },
108177
- description: "Additional non-inline tags describing this post."
108549
+ }
108178
108550
  },
108179
108551
  createdAt: {
108180
108552
  type: "string",
108181
- format: "datetime"
108553
+ format: "datetime",
108554
+ description: "Client-declared timestamp when this post was originally created."
108182
108555
  }
108183
108556
  }
108184
108557
  }
@@ -108237,7 +108610,7 @@ var schemaDict = {
108237
108610
  id: "app.bsky.feed.repost",
108238
108611
  defs: {
108239
108612
  main: {
108240
- description: "A declaration of a repost.",
108613
+ description: "Record representing a 'repost' of an existing Bluesky post.",
108241
108614
  type: "record",
108242
108615
  key: "tid",
108243
108616
  record: {
@@ -108263,7 +108636,7 @@ var schemaDict = {
108263
108636
  defs: {
108264
108637
  main: {
108265
108638
  type: "query",
108266
- description: "Find posts matching search criteria.",
108639
+ description: "Find posts matching search criteria, returning views of those posts.",
108267
108640
  parameters: {
108268
108641
  type: "params",
108269
108642
  required: ["q"],
@@ -108322,14 +108695,15 @@ var schemaDict = {
108322
108695
  main: {
108323
108696
  type: "record",
108324
108697
  key: "tid",
108325
- description: "Defines interaction gating rules for a thread. The rkey of the threadgate record should match the rkey of the thread's root post.",
108698
+ description: "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..",
108326
108699
  record: {
108327
108700
  type: "object",
108328
108701
  required: ["post", "createdAt"],
108329
108702
  properties: {
108330
108703
  post: {
108331
108704
  type: "string",
108332
- format: "at-uri"
108705
+ format: "at-uri",
108706
+ description: "Reference (AT-URI) to the post record."
108333
108707
  },
108334
108708
  allow: {
108335
108709
  type: "array",
@@ -108379,7 +108753,7 @@ var schemaDict = {
108379
108753
  defs: {
108380
108754
  main: {
108381
108755
  type: "record",
108382
- description: "A declaration of a block.",
108756
+ description: "Record declaring a 'block' relationship against another account. NOTE: blocks are public in Bluesky; see blog posts for details.",
108383
108757
  key: "tid",
108384
108758
  record: {
108385
108759
  type: "object",
@@ -108387,7 +108761,8 @@ var schemaDict = {
108387
108761
  properties: {
108388
108762
  subject: {
108389
108763
  type: "string",
108390
- format: "did"
108764
+ format: "did",
108765
+ description: "DID of the account to be blocked."
108391
108766
  },
108392
108767
  createdAt: {
108393
108768
  type: "string",
@@ -108571,7 +108946,7 @@ var schemaDict = {
108571
108946
  defs: {
108572
108947
  main: {
108573
108948
  type: "record",
108574
- description: "A declaration of a social follow.",
108949
+ description: "Record declaring a social 'follow' relationship of another account. Duplicate follows will be ignored by the AppView.",
108575
108950
  key: "tid",
108576
108951
  record: {
108577
108952
  type: "object",
@@ -108596,7 +108971,7 @@ var schemaDict = {
108596
108971
  defs: {
108597
108972
  main: {
108598
108973
  type: "query",
108599
- description: "Get a list of who the actor is blocking.",
108974
+ description: "Enumerates which accounts the requesting account is currently blocking. Requires auth.",
108600
108975
  parameters: {
108601
108976
  type: "params",
108602
108977
  properties: {
@@ -108639,7 +109014,7 @@ var schemaDict = {
108639
109014
  defs: {
108640
109015
  main: {
108641
109016
  type: "query",
108642
- description: "Get a list of an actor's followers.",
109017
+ description: "Enumerates accounts which follow a specified account (actor).",
108643
109018
  parameters: {
108644
109019
  type: "params",
108645
109020
  required: ["actor"],
@@ -108691,7 +109066,7 @@ var schemaDict = {
108691
109066
  defs: {
108692
109067
  main: {
108693
109068
  type: "query",
108694
- description: "Get a list of who the actor follows.",
109069
+ description: "Enumerates accounts which a specified account (actor) follows.",
108695
109070
  parameters: {
108696
109071
  type: "params",
108697
109072
  required: ["actor"],
@@ -108743,14 +109118,15 @@ var schemaDict = {
108743
109118
  defs: {
108744
109119
  main: {
108745
109120
  type: "query",
108746
- description: "Get a list of actors.",
109121
+ description: "Gets a 'view' (with additional context) of a specified list.",
108747
109122
  parameters: {
108748
109123
  type: "params",
108749
109124
  required: ["list"],
108750
109125
  properties: {
108751
109126
  list: {
108752
109127
  type: "string",
108753
- format: "at-uri"
109128
+ format: "at-uri",
109129
+ description: "Reference (AT-URI) of the list record to hydrate."
108754
109130
  },
108755
109131
  limit: {
108756
109132
  type: "integer",
@@ -108795,7 +109171,7 @@ var schemaDict = {
108795
109171
  defs: {
108796
109172
  main: {
108797
109173
  type: "query",
108798
- description: "Get lists that the actor is blocking.",
109174
+ description: "Get mod lists that the requesting account (actor) is blocking. Requires auth.",
108799
109175
  parameters: {
108800
109176
  type: "params",
108801
109177
  properties: {
@@ -108838,7 +109214,7 @@ var schemaDict = {
108838
109214
  defs: {
108839
109215
  main: {
108840
109216
  type: "query",
108841
- description: "Get lists that the actor is muting.",
109217
+ description: "Enumerates mod lists that the requesting account (actor) currently has muted. Requires auth.",
108842
109218
  parameters: {
108843
109219
  type: "params",
108844
109220
  properties: {
@@ -108881,14 +109257,15 @@ var schemaDict = {
108881
109257
  defs: {
108882
109258
  main: {
108883
109259
  type: "query",
108884
- description: "Get a list of lists that belong to an actor.",
109260
+ description: "Enumerates the lists created by a specified account (actor).",
108885
109261
  parameters: {
108886
109262
  type: "params",
108887
109263
  required: ["actor"],
108888
109264
  properties: {
108889
109265
  actor: {
108890
109266
  type: "string",
108891
- format: "at-identifier"
109267
+ format: "at-identifier",
109268
+ description: "The account (actor) to enumerate lists from."
108892
109269
  },
108893
109270
  limit: {
108894
109271
  type: "integer",
@@ -108929,7 +109306,7 @@ var schemaDict = {
108929
109306
  defs: {
108930
109307
  main: {
108931
109308
  type: "query",
108932
- description: "Get a list of who the actor mutes.",
109309
+ description: "Enumerates accounts that the requesting account (actor) currently has muted. Requires auth.",
108933
109310
  parameters: {
108934
109311
  type: "params",
108935
109312
  properties: {
@@ -108972,17 +109349,19 @@ var schemaDict = {
108972
109349
  defs: {
108973
109350
  main: {
108974
109351
  type: "query",
108975
- description: "Enumerates public relationships between one account, and a list of other accounts",
109352
+ description: "Enumerates public relationships between one account, and a list of other accounts. Does not require auth.",
108976
109353
  parameters: {
108977
109354
  type: "params",
108978
109355
  required: ["actor"],
108979
109356
  properties: {
108980
109357
  actor: {
108981
109358
  type: "string",
108982
- format: "at-identifier"
109359
+ format: "at-identifier",
109360
+ description: "Primary account requesting relationships for."
108983
109361
  },
108984
109362
  others: {
108985
109363
  type: "array",
109364
+ description: "List of 'other' accounts to be related back to the primary.",
108986
109365
  maxLength: 30,
108987
109366
  items: {
108988
109367
  type: "string",
@@ -109029,7 +109408,7 @@ var schemaDict = {
109029
109408
  defs: {
109030
109409
  main: {
109031
109410
  type: "query",
109032
- description: "Get suggested follows related to a given actor.",
109411
+ description: "Enumerates follows similar to a given account (actor). Expected use is to recommend additional accounts immediately after following one account.",
109033
109412
  parameters: {
109034
109413
  type: "params",
109035
109414
  required: ["actor"],
@@ -109065,7 +109444,7 @@ var schemaDict = {
109065
109444
  defs: {
109066
109445
  main: {
109067
109446
  type: "record",
109068
- description: "A declaration of a list of actors.",
109447
+ description: "Record representing a list of accounts (actors). Scope includes both moderation-oriented lists and curration-oriented lists.",
109069
109448
  key: "tid",
109070
109449
  record: {
109071
109450
  type: "object",
@@ -109073,12 +109452,14 @@ var schemaDict = {
109073
109452
  properties: {
109074
109453
  purpose: {
109075
109454
  type: "ref",
109455
+ description: "Defines the purpose of the list (aka, moderation-oriented or curration-oriented)",
109076
109456
  ref: "lex:app.bsky.graph.defs#listPurpose"
109077
109457
  },
109078
109458
  name: {
109079
109459
  type: "string",
109080
109460
  maxLength: 64,
109081
- minLength: 1
109461
+ minLength: 1,
109462
+ description: "Display name for list; can not be empty."
109082
109463
  },
109083
109464
  description: {
109084
109465
  type: "string",
@@ -109116,7 +109497,7 @@ var schemaDict = {
109116
109497
  defs: {
109117
109498
  main: {
109118
109499
  type: "record",
109119
- description: "A block of an entire list of actors.",
109500
+ description: "Record representing a block relationship against an entire an entire list of accounts (actors).",
109120
109501
  key: "tid",
109121
109502
  record: {
109122
109503
  type: "object",
@@ -109124,7 +109505,8 @@ var schemaDict = {
109124
109505
  properties: {
109125
109506
  subject: {
109126
109507
  type: "string",
109127
- format: "at-uri"
109508
+ format: "at-uri",
109509
+ description: "Reference (AT-URI) to the mod list record."
109128
109510
  },
109129
109511
  createdAt: {
109130
109512
  type: "string",
@@ -109141,7 +109523,7 @@ var schemaDict = {
109141
109523
  defs: {
109142
109524
  main: {
109143
109525
  type: "record",
109144
- description: "An item under a declared list of actors.",
109526
+ description: "Record representing an account's inclusion on a specific list. The AppView will ignore duplicate listitem records.",
109145
109527
  key: "tid",
109146
109528
  record: {
109147
109529
  type: "object",
@@ -109149,11 +109531,13 @@ var schemaDict = {
109149
109531
  properties: {
109150
109532
  subject: {
109151
109533
  type: "string",
109152
- format: "did"
109534
+ format: "did",
109535
+ description: "The account which is included on the list."
109153
109536
  },
109154
109537
  list: {
109155
109538
  type: "string",
109156
- format: "at-uri"
109539
+ format: "at-uri",
109540
+ description: "Reference (AT-URI) to the list record (app.bsky.graph.list)."
109157
109541
  },
109158
109542
  createdAt: {
109159
109543
  type: "string",
@@ -109170,7 +109554,7 @@ var schemaDict = {
109170
109554
  defs: {
109171
109555
  main: {
109172
109556
  type: "procedure",
109173
- description: "Mute an actor by DID or handle.",
109557
+ description: "Creates a mute relationship for the specified account. Mutes are private in Bluesky. Requires auth.",
109174
109558
  input: {
109175
109559
  encoding: "application/json",
109176
109560
  schema: {
@@ -109193,7 +109577,7 @@ var schemaDict = {
109193
109577
  defs: {
109194
109578
  main: {
109195
109579
  type: "procedure",
109196
- description: "Mute a list of actors.",
109580
+ description: "Creates a mute relationship for the specified list of accounts. Mutes are private in Bluesky. Requires auth.",
109197
109581
  input: {
109198
109582
  encoding: "application/json",
109199
109583
  schema: {
@@ -109216,7 +109600,7 @@ var schemaDict = {
109216
109600
  defs: {
109217
109601
  main: {
109218
109602
  type: "procedure",
109219
- description: "Unmute an actor by DID or handle.",
109603
+ description: "Unmutes the specified account. Requires auth.",
109220
109604
  input: {
109221
109605
  encoding: "application/json",
109222
109606
  schema: {
@@ -109239,7 +109623,7 @@ var schemaDict = {
109239
109623
  defs: {
109240
109624
  main: {
109241
109625
  type: "procedure",
109242
- description: "Unmute a list of actors.",
109626
+ description: "Unmutes the specified list of accounts. Requires auth.",
109243
109627
  input: {
109244
109628
  encoding: "application/json",
109245
109629
  schema: {
@@ -109262,7 +109646,7 @@ var schemaDict = {
109262
109646
  defs: {
109263
109647
  main: {
109264
109648
  type: "query",
109265
- description: "Get the count of unread notifications.",
109649
+ description: "Count the number of unread notifications for the requesting account. Requires auth.",
109266
109650
  parameters: {
109267
109651
  type: "params",
109268
109652
  properties: {
@@ -109293,7 +109677,7 @@ var schemaDict = {
109293
109677
  defs: {
109294
109678
  main: {
109295
109679
  type: "query",
109296
- description: "Get a list of notifications.",
109680
+ description: "Enumerate notifications for the requesting account. Requires auth.",
109297
109681
  parameters: {
109298
109682
  type: "params",
109299
109683
  properties: {
@@ -109403,7 +109787,7 @@ var schemaDict = {
109403
109787
  defs: {
109404
109788
  main: {
109405
109789
  type: "procedure",
109406
- description: "Register for push notifications with a service.",
109790
+ description: "Register to receive push notifications, via a specified service, for the requesting account. Requires auth.",
109407
109791
  input: {
109408
109792
  encoding: "application/json",
109409
109793
  schema: {
@@ -109436,7 +109820,7 @@ var schemaDict = {
109436
109820
  defs: {
109437
109821
  main: {
109438
109822
  type: "procedure",
109439
- description: "Notify server that the user has seen notifications.",
109823
+ description: "Notify server that the requesting account has seen notifications. Requires auth.",
109440
109824
  input: {
109441
109825
  encoding: "application/json",
109442
109826
  schema: {
@@ -109459,6 +109843,7 @@ var schemaDict = {
109459
109843
  defs: {
109460
109844
  main: {
109461
109845
  type: "object",
109846
+ description: "Annotation of a sub-string within rich text.",
109462
109847
  required: ["index", "features"],
109463
109848
  properties: {
109464
109849
  index: {
@@ -109480,7 +109865,7 @@ var schemaDict = {
109480
109865
  },
109481
109866
  mention: {
109482
109867
  type: "object",
109483
- description: "A facet feature for actor mentions.",
109868
+ description: "Facet feature for mention of another account. The text is usually a handle, including a '@' prefix, but the facet reference is a DID.",
109484
109869
  required: ["did"],
109485
109870
  properties: {
109486
109871
  did: {
@@ -109491,7 +109876,7 @@ var schemaDict = {
109491
109876
  },
109492
109877
  link: {
109493
109878
  type: "object",
109494
- description: "A facet feature for links.",
109879
+ description: "Facet feature for a URL. The text URL may have been simplified or truncated, but the facet reference should be a complete URL.",
109495
109880
  required: ["uri"],
109496
109881
  properties: {
109497
109882
  uri: {
@@ -109502,7 +109887,7 @@ var schemaDict = {
109502
109887
  },
109503
109888
  tag: {
109504
109889
  type: "object",
109505
- description: "A hashtag.",
109890
+ description: "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').",
109506
109891
  required: ["tag"],
109507
109892
  properties: {
109508
109893
  tag: {
@@ -109514,7 +109899,7 @@ var schemaDict = {
109514
109899
  },
109515
109900
  byteSlice: {
109516
109901
  type: "object",
109517
- description: "A text segment. Start is inclusive, end is exclusive. Indices are for utf8-encoded strings.",
109902
+ description: "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.",
109518
109903
  required: ["byteStart", "byteEnd"],
109519
109904
  properties: {
109520
109905
  byteStart: {
@@ -110433,7 +110818,7 @@ var import_express2 = __toESM(require_express2());
110433
110818
  function isUndefined(obj) {
110434
110819
  return obj === void 0;
110435
110820
  }
110436
- function isString(obj) {
110821
+ function isString2(obj) {
110437
110822
  return typeof obj === "string";
110438
110823
  }
110439
110824
  function isNumber(obj) {
@@ -111175,7 +111560,7 @@ var DynamicReferenceBuilder = class {
111175
111560
  }
111176
111561
  };
111177
111562
  function isDynamicReferenceBuilder(obj) {
111178
- return isObject2(obj) && isOperationNodeSource(obj) && isString(obj.dynamicReference);
111563
+ return isObject2(obj) && isOperationNodeSource(obj) && isString2(obj.dynamicReference);
111179
111564
  }
111180
111565
 
111181
111566
  // ../../node_modules/.pnpm/kysely@0.22.0/node_modules/kysely/dist/esm/parser/reference-parser.js
@@ -111187,7 +111572,7 @@ function parseReferenceExpressionOrList(arg) {
111187
111572
  }
111188
111573
  }
111189
111574
  function parseReferenceExpression(exp) {
111190
- if (isString(exp)) {
111575
+ if (isString2(exp)) {
111191
111576
  return parseStringReference(exp);
111192
111577
  } else if (isDynamicReferenceBuilder(exp)) {
111193
111578
  return exp.toOperationNode();
@@ -111337,7 +111722,7 @@ function parseIsFilter(left, op, right) {
111337
111722
  return FilterNode.create(parseReferenceExpression(left), parseFilterOperator(op), ValueNode.createImmediate(right));
111338
111723
  }
111339
111724
  function parseFilterOperator(op) {
111340
- if (isString(op) && OPERATORS.includes(op)) {
111725
+ if (isString2(op) && OPERATORS.includes(op)) {
111341
111726
  return OperatorNode.create(op);
111342
111727
  } else if (isOperationNodeSource(op)) {
111343
111728
  return op.toOperationNode();
@@ -111440,7 +111825,7 @@ function parseSelectExpressionOrList(selection) {
111440
111825
  }
111441
111826
  }
111442
111827
  function parseSelectExpression(selection) {
111443
- if (isString(selection)) {
111828
+ if (isString2(selection)) {
111444
111829
  return SelectionNode.create(parseAliasedStringReference(selection));
111445
111830
  } else if (isDynamicReferenceBuilder(selection)) {
111446
111831
  return SelectionNode.create(selection.toOperationNode());
@@ -111458,7 +111843,7 @@ function parseSelectAll(table) {
111458
111843
  }
111459
111844
  }
111460
111845
  function parseSelectAllArg(table) {
111461
- if (isString(table)) {
111846
+ if (isString2(table)) {
111462
111847
  return SelectionNode.createSelectAllFromTable(parseTable(table));
111463
111848
  }
111464
111849
  throw new Error(`invalid value selectAll expression: ${JSON.stringify(table)}`);
@@ -114388,7 +114773,7 @@ function parseTableExpressionOrList(table) {
114388
114773
  }
114389
114774
  }
114390
114775
  function parseTableExpression(table) {
114391
- if (isString(table)) {
114776
+ if (isString2(table)) {
114392
114777
  return parseAliasedTable(table);
114393
114778
  } else {
114394
114779
  return parseAliasedComplexExpression(table);
@@ -116703,7 +117088,7 @@ var DefaultQueryCompiler = class extends OperationNodeVisitor {
116703
117088
  this.append(this.getRightIdentifierWrapper());
116704
117089
  }
116705
117090
  compileUnwrappedIdentifier(node) {
116706
- if (!isString(node.name)) {
117091
+ if (!isString2(node.name)) {
116707
117092
  throw new Error("a non-string identifier was passed to compileUnwrappedIdentifier.");
116708
117093
  }
116709
117094
  this.append(this.sanitizeIdentifier(node.name));
@@ -117402,7 +117787,7 @@ var DefaultQueryCompiler = class extends OperationNodeVisitor {
117402
117787
  this.#parameters.push(parameter);
117403
117788
  }
117404
117789
  appendImmediateValue(value) {
117405
- if (isString(value)) {
117790
+ if (isString2(value)) {
117406
117791
  this.append(`'${value}'`);
117407
117792
  } else if (isNumber(value) || isBoolean(value)) {
117408
117793
  this.append(value.toString());
@@ -117839,7 +118224,7 @@ ${stackExtension}`;
117839
118224
  return err;
117840
118225
  }
117841
118226
  function isStackHolder(obj) {
117842
- return isObject2(obj) && isString(obj.stack);
118227
+ return isObject2(obj) && isString2(obj.stack);
117843
118228
  }
117844
118229
 
117845
118230
  // ../../node_modules/.pnpm/kysely@0.22.0/node_modules/kysely/dist/esm/dialect/postgres/postgres-driver.js
@@ -120887,7 +121272,7 @@ var schemaDict2 = {
120887
121272
  defs: {
120888
121273
  main: {
120889
121274
  type: "query",
120890
- description: "Provides the DID of a repo.",
121275
+ description: "Resolves a handle (domain name) to a DID.",
120891
121276
  parameters: {
120892
121277
  type: "params",
120893
121278
  required: ["handle"],
@@ -120921,7 +121306,7 @@ var schemaDict2 = {
120921
121306
  defs: {
120922
121307
  main: {
120923
121308
  type: "procedure",
120924
- description: "Updates the handle of the account.",
121309
+ description: "Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth.",
120925
121310
  input: {
120926
121311
  encoding: "application/json",
120927
121312
  schema: {
@@ -120930,7 +121315,8 @@ var schemaDict2 = {
120930
121315
  properties: {
120931
121316
  handle: {
120932
121317
  type: "string",
120933
- format: "handle"
121318
+ format: "handle",
121319
+ description: "The new handle."
120934
121320
  }
120935
121321
  }
120936
121322
  }
@@ -121013,7 +121399,7 @@ var schemaDict2 = {
121013
121399
  defs: {
121014
121400
  main: {
121015
121401
  type: "query",
121016
- description: "Find labels relevant to the provided URI patterns.",
121402
+ description: "Find labels relevant to the provided AT-URI patterns. Public endpoint for moderation services, though may return different or additional results with auth.",
121017
121403
  parameters: {
121018
121404
  type: "params",
121019
121405
  required: ["uriPatterns"],
@@ -121072,13 +121458,13 @@ var schemaDict2 = {
121072
121458
  defs: {
121073
121459
  main: {
121074
121460
  type: "subscription",
121075
- description: "Subscribe to label updates.",
121461
+ description: "Subscribe to stream of labels (and negations). Public endpoint implemented by mod services. Uses same sequencing scheme as repo event stream.",
121076
121462
  parameters: {
121077
121463
  type: "params",
121078
121464
  properties: {
121079
121465
  cursor: {
121080
121466
  type: "integer",
121081
- description: "The last known event to backfill from."
121467
+ description: "The last known event seq number to backfill from."
121082
121468
  }
121083
121469
  }
121084
121470
  },
@@ -121134,7 +121520,7 @@ var schemaDict2 = {
121134
121520
  defs: {
121135
121521
  main: {
121136
121522
  type: "procedure",
121137
- description: "Report a repo or a record.",
121523
+ description: "Submit a moderation report regarding an atproto account or record. Implemented by moderation services (with PDS proxying), and requires auth.",
121138
121524
  input: {
121139
121525
  encoding: "application/json",
121140
121526
  schema: {
@@ -121143,10 +121529,12 @@ var schemaDict2 = {
121143
121529
  properties: {
121144
121530
  reasonType: {
121145
121531
  type: "ref",
121532
+ description: "Indicates the broad category of violation the report is for.",
121146
121533
  ref: "lex:com.atproto.moderation.defs#reasonType"
121147
121534
  },
121148
121535
  reason: {
121149
- type: "string"
121536
+ type: "string",
121537
+ description: "Additional context about the content and violation."
121150
121538
  },
121151
121539
  subject: {
121152
121540
  type: "union",
@@ -121255,7 +121643,7 @@ var schemaDict2 = {
121255
121643
  defs: {
121256
121644
  main: {
121257
121645
  type: "procedure",
121258
- description: "Apply a batch transaction of creates, updates, and deletes.",
121646
+ description: "Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.",
121259
121647
  input: {
121260
121648
  encoding: "application/json",
121261
121649
  schema: {
@@ -121265,12 +121653,12 @@ var schemaDict2 = {
121265
121653
  repo: {
121266
121654
  type: "string",
121267
121655
  format: "at-identifier",
121268
- description: "The handle or DID of the repo."
121656
+ description: "The handle or DID of the repo (aka, current account)."
121269
121657
  },
121270
121658
  validate: {
121271
121659
  type: "boolean",
121272
121660
  default: true,
121273
- description: "Flag for validating the records."
121661
+ description: "Can be set to 'false' to skip Lexicon schema validation of record data, for all operations."
121274
121662
  },
121275
121663
  writes: {
121276
121664
  type: "array",
@@ -121286,6 +121674,7 @@ var schemaDict2 = {
121286
121674
  },
121287
121675
  swapCommit: {
121288
121676
  type: "string",
121677
+ description: "If provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations.",
121289
121678
  format: "cid"
121290
121679
  }
121291
121680
  }
@@ -121293,13 +121682,14 @@ var schemaDict2 = {
121293
121682
  },
121294
121683
  errors: [
121295
121684
  {
121296
- name: "InvalidSwap"
121685
+ name: "InvalidSwap",
121686
+ description: "Indicates that the 'swapCommit' parameter did not match current commit."
121297
121687
  }
121298
121688
  ]
121299
121689
  },
121300
121690
  create: {
121301
121691
  type: "object",
121302
- description: "Create a new record.",
121692
+ description: "Operation which creates a new record.",
121303
121693
  required: ["collection", "value"],
121304
121694
  properties: {
121305
121695
  collection: {
@@ -121317,7 +121707,7 @@ var schemaDict2 = {
121317
121707
  },
121318
121708
  update: {
121319
121709
  type: "object",
121320
- description: "Update an existing record.",
121710
+ description: "Operation which updates an existing record.",
121321
121711
  required: ["collection", "rkey", "value"],
121322
121712
  properties: {
121323
121713
  collection: {
@@ -121334,7 +121724,7 @@ var schemaDict2 = {
121334
121724
  },
121335
121725
  delete: {
121336
121726
  type: "object",
121337
- description: "Delete an existing record.",
121727
+ description: "Operation which deletes an existing record.",
121338
121728
  required: ["collection", "rkey"],
121339
121729
  properties: {
121340
121730
  collection: {
@@ -121354,7 +121744,7 @@ var schemaDict2 = {
121354
121744
  defs: {
121355
121745
  main: {
121356
121746
  type: "procedure",
121357
- description: "Create a new record.",
121747
+ description: "Create a single new repository record. Requires auth, implemented by PDS.",
121358
121748
  input: {
121359
121749
  encoding: "application/json",
121360
121750
  schema: {
@@ -121364,7 +121754,7 @@ var schemaDict2 = {
121364
121754
  repo: {
121365
121755
  type: "string",
121366
121756
  format: "at-identifier",
121367
- description: "The handle or DID of the repo."
121757
+ description: "The handle or DID of the repo (aka, current account)."
121368
121758
  },
121369
121759
  collection: {
121370
121760
  type: "string",
@@ -121373,17 +121763,17 @@ var schemaDict2 = {
121373
121763
  },
121374
121764
  rkey: {
121375
121765
  type: "string",
121376
- description: "The key of the record.",
121766
+ description: "The Record Key.",
121377
121767
  maxLength: 15
121378
121768
  },
121379
121769
  validate: {
121380
121770
  type: "boolean",
121381
121771
  default: true,
121382
- description: "Flag for validating the record."
121772
+ description: "Can be set to 'false' to skip Lexicon schema validation of record data."
121383
121773
  },
121384
121774
  record: {
121385
121775
  type: "unknown",
121386
- description: "The record to create."
121776
+ description: "The record itself. Must contain a $type field."
121387
121777
  },
121388
121778
  swapCommit: {
121389
121779
  type: "string",
@@ -121412,7 +121802,8 @@ var schemaDict2 = {
121412
121802
  },
121413
121803
  errors: [
121414
121804
  {
121415
- name: "InvalidSwap"
121805
+ name: "InvalidSwap",
121806
+ description: "Indicates that 'swapCommit' didn't match current repo commit."
121416
121807
  }
121417
121808
  ]
121418
121809
  }
@@ -121424,7 +121815,7 @@ var schemaDict2 = {
121424
121815
  defs: {
121425
121816
  main: {
121426
121817
  type: "procedure",
121427
- description: "Delete a record, or ensure it doesn't exist.",
121818
+ description: "Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS.",
121428
121819
  input: {
121429
121820
  encoding: "application/json",
121430
121821
  schema: {
@@ -121434,7 +121825,7 @@ var schemaDict2 = {
121434
121825
  repo: {
121435
121826
  type: "string",
121436
121827
  format: "at-identifier",
121437
- description: "The handle or DID of the repo."
121828
+ description: "The handle or DID of the repo (aka, current account)."
121438
121829
  },
121439
121830
  collection: {
121440
121831
  type: "string",
@@ -121443,7 +121834,7 @@ var schemaDict2 = {
121443
121834
  },
121444
121835
  rkey: {
121445
121836
  type: "string",
121446
- description: "The key of the record."
121837
+ description: "The Record Key."
121447
121838
  },
121448
121839
  swapRecord: {
121449
121840
  type: "string",
@@ -121472,7 +121863,7 @@ var schemaDict2 = {
121472
121863
  defs: {
121473
121864
  main: {
121474
121865
  type: "query",
121475
- description: "Get information about the repo, including the list of collections.",
121866
+ description: "Get information about an account and repository, including the list of collections. Does not require auth.",
121476
121867
  parameters: {
121477
121868
  type: "params",
121478
121869
  required: ["repo"],
@@ -121505,17 +121896,20 @@ var schemaDict2 = {
121505
121896
  format: "did"
121506
121897
  },
121507
121898
  didDoc: {
121508
- type: "unknown"
121899
+ type: "unknown",
121900
+ description: "The complete DID document for this account."
121509
121901
  },
121510
121902
  collections: {
121511
121903
  type: "array",
121904
+ description: "List of all the collections (NSIDs) for which this repo contains at least one record.",
121512
121905
  items: {
121513
121906
  type: "string",
121514
121907
  format: "nsid"
121515
121908
  }
121516
121909
  },
121517
121910
  handleIsCorrect: {
121518
- type: "boolean"
121911
+ type: "boolean",
121912
+ description: "Indicates if handle is currently valid (resolves bi-directionally)"
121519
121913
  }
121520
121914
  }
121521
121915
  }
@@ -121529,7 +121923,7 @@ var schemaDict2 = {
121529
121923
  defs: {
121530
121924
  main: {
121531
121925
  type: "query",
121532
- description: "Get a record.",
121926
+ description: "Get a single record from a repository. Does not require auth.",
121533
121927
  parameters: {
121534
121928
  type: "params",
121535
121929
  required: ["repo", "collection", "rkey"],
@@ -121546,7 +121940,7 @@ var schemaDict2 = {
121546
121940
  },
121547
121941
  rkey: {
121548
121942
  type: "string",
121549
- description: "The key of the record."
121943
+ description: "The Record Key."
121550
121944
  },
121551
121945
  cid: {
121552
121946
  type: "string",
@@ -121584,7 +121978,7 @@ var schemaDict2 = {
121584
121978
  defs: {
121585
121979
  main: {
121586
121980
  type: "query",
121587
- description: "List a range of records in a collection.",
121981
+ description: "List a range of records in a repository, matching a specific collection. Does not require auth.",
121588
121982
  parameters: {
121589
121983
  type: "params",
121590
121984
  required: ["repo", "collection"],
@@ -121668,7 +122062,7 @@ var schemaDict2 = {
121668
122062
  defs: {
121669
122063
  main: {
121670
122064
  type: "procedure",
121671
- description: "Write a record, creating or updating it as needed.",
122065
+ description: "Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS.",
121672
122066
  input: {
121673
122067
  encoding: "application/json",
121674
122068
  schema: {
@@ -121679,7 +122073,7 @@ var schemaDict2 = {
121679
122073
  repo: {
121680
122074
  type: "string",
121681
122075
  format: "at-identifier",
121682
- description: "The handle or DID of the repo."
122076
+ description: "The handle or DID of the repo (aka, current account)."
121683
122077
  },
121684
122078
  collection: {
121685
122079
  type: "string",
@@ -121688,13 +122082,13 @@ var schemaDict2 = {
121688
122082
  },
121689
122083
  rkey: {
121690
122084
  type: "string",
121691
- description: "The key of the record.",
122085
+ description: "The Record Key.",
121692
122086
  maxLength: 15
121693
122087
  },
121694
122088
  validate: {
121695
122089
  type: "boolean",
121696
122090
  default: true,
121697
- description: "Flag for validating the record."
122091
+ description: "Can be set to 'false' to skip Lexicon schema validation of record data."
121698
122092
  },
121699
122093
  record: {
121700
122094
  type: "unknown",
@@ -121703,7 +122097,7 @@ var schemaDict2 = {
121703
122097
  swapRecord: {
121704
122098
  type: "string",
121705
122099
  format: "cid",
121706
- description: "Compare and swap with the previous record by CID."
122100
+ description: "Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation"
121707
122101
  },
121708
122102
  swapCommit: {
121709
122103
  type: "string",
@@ -121765,7 +122159,7 @@ var schemaDict2 = {
121765
122159
  defs: {
121766
122160
  main: {
121767
122161
  type: "procedure",
121768
- description: "Upload a new blob to be added to repo in a later request.",
122162
+ description: "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.",
121769
122163
  input: {
121770
122164
  encoding: "*/*"
121771
122165
  },
@@ -121829,7 +122223,7 @@ var schemaDict2 = {
121829
122223
  defs: {
121830
122224
  main: {
121831
122225
  type: "procedure",
121832
- description: "Create an account.",
122226
+ description: "Create an account. Implemented by PDS.",
121833
122227
  input: {
121834
122228
  encoding: "application/json",
121835
122229
  schema: {
@@ -121841,11 +122235,13 @@ var schemaDict2 = {
121841
122235
  },
121842
122236
  handle: {
121843
122237
  type: "string",
121844
- format: "handle"
122238
+ format: "handle",
122239
+ description: "Requested handle for the account."
121845
122240
  },
121846
122241
  did: {
121847
122242
  type: "string",
121848
- format: "did"
122243
+ format: "did",
122244
+ description: "Pre-existing atproto DID, being imported to a new account."
121849
122245
  },
121850
122246
  inviteCode: {
121851
122247
  type: "string"
@@ -121857,13 +122253,16 @@ var schemaDict2 = {
121857
122253
  type: "string"
121858
122254
  },
121859
122255
  password: {
121860
- type: "string"
122256
+ type: "string",
122257
+ description: "Initial account password. May need to meet instance-specific password strength requirements."
121861
122258
  },
121862
122259
  recoveryKey: {
121863
- type: "string"
122260
+ type: "string",
122261
+ description: "DID PLC rotation key (aka, recovery key) to be included in PLC creation operation."
121864
122262
  },
121865
122263
  plcOp: {
121866
- type: "unknown"
122264
+ type: "unknown",
122265
+ description: "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."
121867
122266
  }
121868
122267
  }
121869
122268
  }
@@ -121872,6 +122271,7 @@ var schemaDict2 = {
121872
122271
  encoding: "application/json",
121873
122272
  schema: {
121874
122273
  type: "object",
122274
+ description: "Account login session returned on successful account creation.",
121875
122275
  required: ["accessJwt", "refreshJwt", "handle", "did"],
121876
122276
  properties: {
121877
122277
  accessJwt: {
@@ -121886,10 +122286,12 @@ var schemaDict2 = {
121886
122286
  },
121887
122287
  did: {
121888
122288
  type: "string",
121889
- format: "did"
122289
+ format: "did",
122290
+ description: "The DID of the new account."
121890
122291
  },
121891
122292
  didDoc: {
121892
- type: "unknown"
122293
+ type: "unknown",
122294
+ description: "Complete DID document."
121893
122295
  }
121894
122296
  }
121895
122297
  }
@@ -121934,7 +122336,8 @@ var schemaDict2 = {
121934
122336
  required: ["name"],
121935
122337
  properties: {
121936
122338
  name: {
121937
- type: "string"
122339
+ type: "string",
122340
+ description: "A short name for the App Password, to help distinguish them."
121938
122341
  }
121939
122342
  }
121940
122343
  }
@@ -122201,7 +122604,7 @@ var schemaDict2 = {
122201
122604
  defs: {
122202
122605
  main: {
122203
122606
  type: "procedure",
122204
- description: "Delete an actor's account with a token and password.",
122607
+ description: "Delete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth.",
122205
122608
  input: {
122206
122609
  encoding: "application/json",
122207
122610
  schema: {
@@ -122238,7 +122641,7 @@ var schemaDict2 = {
122238
122641
  defs: {
122239
122642
  main: {
122240
122643
  type: "procedure",
122241
- description: "Delete the current session."
122644
+ description: "Delete the current session. Requires auth."
122242
122645
  }
122243
122646
  }
122244
122647
  },
@@ -122248,7 +122651,7 @@ var schemaDict2 = {
122248
122651
  defs: {
122249
122652
  main: {
122250
122653
  type: "query",
122251
- description: "Get a document describing the service's accounts configuration.",
122654
+ description: "Describes the server's account creation requirements and capabilities. Implemented by PDS.",
122252
122655
  output: {
122253
122656
  encoding: "application/json",
122254
122657
  schema: {
@@ -122256,19 +122659,23 @@ var schemaDict2 = {
122256
122659
  required: ["availableUserDomains"],
122257
122660
  properties: {
122258
122661
  inviteCodeRequired: {
122259
- type: "boolean"
122662
+ type: "boolean",
122663
+ description: "If true, an invite code must be supplied to create an account on this instance."
122260
122664
  },
122261
122665
  phoneVerificationRequired: {
122262
- type: "boolean"
122666
+ type: "boolean",
122667
+ description: "If true, a phone verification token must be supplied to create an account on this instance."
122263
122668
  },
122264
122669
  availableUserDomains: {
122265
122670
  type: "array",
122671
+ description: "List of domain suffixes that can be used in account handles.",
122266
122672
  items: {
122267
122673
  type: "string"
122268
122674
  }
122269
122675
  },
122270
122676
  links: {
122271
122677
  type: "ref",
122678
+ description: "URLs of service policy documents.",
122272
122679
  ref: "lex:com.atproto.server.describeServer#links"
122273
122680
  }
122274
122681
  }
@@ -122294,7 +122701,7 @@ var schemaDict2 = {
122294
122701
  defs: {
122295
122702
  main: {
122296
122703
  type: "query",
122297
- description: "Get all invite codes for a given account.",
122704
+ description: "Get all invite codes for the current account. Requires auth.",
122298
122705
  parameters: {
122299
122706
  type: "params",
122300
122707
  properties: {
@@ -122304,7 +122711,8 @@ var schemaDict2 = {
122304
122711
  },
122305
122712
  createAvailable: {
122306
122713
  type: "boolean",
122307
- default: true
122714
+ default: true,
122715
+ description: "Controls whether any new 'earned' but not 'created' invites should be created."
122308
122716
  }
122309
122717
  }
122310
122718
  },
@@ -122338,7 +122746,7 @@ var schemaDict2 = {
122338
122746
  defs: {
122339
122747
  main: {
122340
122748
  type: "query",
122341
- description: "Get information about the current session.",
122749
+ description: "Get information about the current auth session. Requires auth.",
122342
122750
  output: {
122343
122751
  encoding: "application/json",
122344
122752
  schema: {
@@ -122418,7 +122826,7 @@ var schemaDict2 = {
122418
122826
  defs: {
122419
122827
  main: {
122420
122828
  type: "procedure",
122421
- description: "Refresh an authentication session.",
122829
+ description: "Refresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt').",
122422
122830
  output: {
122423
122831
  encoding: "application/json",
122424
122832
  schema: {
@@ -122523,7 +122931,7 @@ var schemaDict2 = {
122523
122931
  defs: {
122524
122932
  main: {
122525
122933
  type: "procedure",
122526
- description: "Reserve a repo signing key for account creation.",
122934
+ description: "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.",
122527
122935
  input: {
122528
122936
  encoding: "application/json",
122529
122937
  schema: {
@@ -122531,7 +122939,8 @@ var schemaDict2 = {
122531
122939
  properties: {
122532
122940
  did: {
122533
122941
  type: "string",
122534
- description: "The did to reserve a new did:key for"
122942
+ format: "did",
122943
+ description: "The DID to reserve a key for."
122535
122944
  }
122536
122945
  }
122537
122946
  }
@@ -122544,7 +122953,7 @@ var schemaDict2 = {
122544
122953
  properties: {
122545
122954
  signingKey: {
122546
122955
  type: "string",
122547
- description: "Public signing key in the form of a did:key."
122956
+ description: "The public key for the reserved signing key, in did:key serialization."
122548
122957
  }
122549
122958
  }
122550
122959
  }
@@ -122650,7 +123059,7 @@ var schemaDict2 = {
122650
123059
  defs: {
122651
123060
  main: {
122652
123061
  type: "query",
122653
- description: "Get a blob associated with a given repo.",
123062
+ description: "Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS.",
122654
123063
  parameters: {
122655
123064
  type: "params",
122656
123065
  required: ["did", "cid"],
@@ -122658,7 +123067,7 @@ var schemaDict2 = {
122658
123067
  did: {
122659
123068
  type: "string",
122660
123069
  format: "did",
122661
- description: "The DID of the repo."
123070
+ description: "The DID of the account."
122662
123071
  },
122663
123072
  cid: {
122664
123073
  type: "string",
@@ -122679,7 +123088,7 @@ var schemaDict2 = {
122679
123088
  defs: {
122680
123089
  main: {
122681
123090
  type: "query",
122682
- description: "Get blocks from a given repo.",
123091
+ description: "Get data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS.",
122683
123092
  parameters: {
122684
123093
  type: "params",
122685
123094
  required: ["did", "cids"],
@@ -122773,7 +123182,7 @@ var schemaDict2 = {
122773
123182
  defs: {
122774
123183
  main: {
122775
123184
  type: "query",
122776
- description: "Get the current commit CID & revision of the repo.",
123185
+ description: "Get the current commit CID & revision of the specified repo. Does not require auth.",
122777
123186
  parameters: {
122778
123187
  type: "params",
122779
123188
  required: ["did"],
@@ -122815,7 +123224,7 @@ var schemaDict2 = {
122815
123224
  defs: {
122816
123225
  main: {
122817
123226
  type: "query",
122818
- description: "Get blocks needed for existence or non-existence of record.",
123227
+ description: "Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth.",
122819
123228
  parameters: {
122820
123229
  type: "params",
122821
123230
  required: ["did", "collection", "rkey"],
@@ -122830,7 +123239,8 @@ var schemaDict2 = {
122830
123239
  format: "nsid"
122831
123240
  },
122832
123241
  rkey: {
122833
- type: "string"
123242
+ type: "string",
123243
+ description: "Record Key"
122834
123244
  },
122835
123245
  commit: {
122836
123246
  type: "string",
@@ -122851,7 +123261,7 @@ var schemaDict2 = {
122851
123261
  defs: {
122852
123262
  main: {
122853
123263
  type: "query",
122854
- description: "Gets the DID's repo, optionally catching up from a specific revision.",
123264
+ description: "Download a repository export as CAR file. Optionally only a 'diff' since a previous revision. Does not require auth; implemented by PDS.",
122855
123265
  parameters: {
122856
123266
  type: "params",
122857
123267
  required: ["did"],
@@ -122863,7 +123273,7 @@ var schemaDict2 = {
122863
123273
  },
122864
123274
  since: {
122865
123275
  type: "string",
122866
- description: "The revision of the repo to catch up from."
123276
+ description: "The revision ('rev') of the repo to create a diff from."
122867
123277
  }
122868
123278
  }
122869
123279
  },
@@ -122879,7 +123289,7 @@ var schemaDict2 = {
122879
123289
  defs: {
122880
123290
  main: {
122881
123291
  type: "query",
122882
- description: "List blob CIDs since some revision.",
123292
+ description: "List blob CIDso for an account, since some repo revision. Does not require auth; implemented by PDS.",
122883
123293
  parameters: {
122884
123294
  type: "params",
122885
123295
  required: ["did"],
@@ -122932,7 +123342,7 @@ var schemaDict2 = {
122932
123342
  defs: {
122933
123343
  main: {
122934
123344
  type: "query",
122935
- description: "List DIDs and root CIDs of hosted repos.",
123345
+ description: "Enumerates all the DID, rev, and commit CID for all repos hosted by this service. Does not require auth; implemented by PDS and Relay.",
122936
123346
  parameters: {
122937
123347
  type: "params",
122938
123348
  properties: {
@@ -122977,7 +123387,8 @@ var schemaDict2 = {
122977
123387
  },
122978
123388
  head: {
122979
123389
  type: "string",
122980
- format: "cid"
123390
+ format: "cid",
123391
+ description: "Current repo commit CID"
122981
123392
  },
122982
123393
  rev: {
122983
123394
  type: "string"
@@ -122992,7 +123403,7 @@ var schemaDict2 = {
122992
123403
  defs: {
122993
123404
  main: {
122994
123405
  type: "procedure",
122995
- description: "Notify a crawling service of a recent update; often when a long break between updates causes the connection with the crawling service to break.",
123406
+ description: "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.",
122996
123407
  input: {
122997
123408
  encoding: "application/json",
122998
123409
  schema: {
@@ -123001,7 +123412,7 @@ var schemaDict2 = {
123001
123412
  properties: {
123002
123413
  hostname: {
123003
123414
  type: "string",
123004
- description: "Hostname of the service that is notifying of update."
123415
+ description: "Hostname of the current service (usually a PDS) that is notifying of update."
123005
123416
  }
123006
123417
  }
123007
123418
  }
@@ -123015,7 +123426,7 @@ var schemaDict2 = {
123015
123426
  defs: {
123016
123427
  main: {
123017
123428
  type: "procedure",
123018
- description: "Request a service to persistently crawl hosted repos.",
123429
+ description: "Request a service to persistently crawl hosted repos. Expected use is new PDS instances declaring their existence to Relays. Does not require auth.",
123019
123430
  input: {
123020
123431
  encoding: "application/json",
123021
123432
  schema: {
@@ -123024,7 +123435,7 @@ var schemaDict2 = {
123024
123435
  properties: {
123025
123436
  hostname: {
123026
123437
  type: "string",
123027
- description: "Hostname of the service that is requesting to be crawled."
123438
+ description: "Hostname of the current service (eg, PDS) that is requesting to be crawled."
123028
123439
  }
123029
123440
  }
123030
123441
  }
@@ -123038,13 +123449,13 @@ var schemaDict2 = {
123038
123449
  defs: {
123039
123450
  main: {
123040
123451
  type: "subscription",
123041
- description: "Subscribe to repo updates.",
123452
+ description: "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.",
123042
123453
  parameters: {
123043
123454
  type: "params",
123044
123455
  properties: {
123045
123456
  cursor: {
123046
123457
  type: "integer",
123047
- description: "The last known event to backfill from."
123458
+ description: "The last known event seq number to backfill from."
123048
123459
  }
123049
123460
  }
123050
123461
  },
@@ -123065,12 +123476,14 @@ var schemaDict2 = {
123065
123476
  name: "FutureCursor"
123066
123477
  },
123067
123478
  {
123068
- name: "ConsumerTooSlow"
123479
+ name: "ConsumerTooSlow",
123480
+ description: "If the consumer of the stream can not keep up with events, and a backlog gets too large, the server will drop the connection."
123069
123481
  }
123070
123482
  ]
123071
123483
  },
123072
123484
  commit: {
123073
123485
  type: "object",
123486
+ description: "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.",
123074
123487
  required: [
123075
123488
  "seq",
123076
123489
  "rebase",
@@ -123087,59 +123500,69 @@ var schemaDict2 = {
123087
123500
  nullable: ["prev", "since"],
123088
123501
  properties: {
123089
123502
  seq: {
123090
- type: "integer"
123503
+ type: "integer",
123504
+ description: "The stream sequence number of this message."
123091
123505
  },
123092
123506
  rebase: {
123093
- type: "boolean"
123507
+ type: "boolean",
123508
+ description: "DEPRECATED -- unused"
123094
123509
  },
123095
123510
  tooBig: {
123096
- type: "boolean"
123511
+ type: "boolean",
123512
+ description: "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."
123097
123513
  },
123098
123514
  repo: {
123099
123515
  type: "string",
123100
- format: "did"
123516
+ format: "did",
123517
+ description: "The repo this event comes from."
123101
123518
  },
123102
123519
  commit: {
123103
- type: "cid-link"
123520
+ type: "cid-link",
123521
+ description: "Repo commit object CID."
123104
123522
  },
123105
123523
  prev: {
123106
- type: "cid-link"
123524
+ type: "cid-link",
123525
+ description: "DEPRECATED -- unused. WARNING -- nullable and optional; stick with optional to ensure golang interoperability."
123107
123526
  },
123108
123527
  rev: {
123109
123528
  type: "string",
123110
- description: "The rev of the emitted commit."
123529
+ description: "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."
123111
123530
  },
123112
123531
  since: {
123113
123532
  type: "string",
123114
- description: "The rev of the last emitted commit from this repo."
123533
+ description: "The rev of the last emitted commit from this repo (if any)."
123115
123534
  },
123116
123535
  blocks: {
123117
123536
  type: "bytes",
123118
- description: "CAR file containing relevant blocks.",
123537
+ description: "CAR file containing relevant blocks, as a diff since the previous repo state.",
123119
123538
  maxLength: 1e6
123120
123539
  },
123121
123540
  ops: {
123122
123541
  type: "array",
123123
123542
  items: {
123124
123543
  type: "ref",
123125
- ref: "lex:com.atproto.sync.subscribeRepos#repoOp"
123544
+ ref: "lex:com.atproto.sync.subscribeRepos#repoOp",
123545
+ description: "List of repo mutation operations in this commit (eg, records created, updated, or deleted)."
123126
123546
  },
123127
123547
  maxLength: 200
123128
123548
  },
123129
123549
  blobs: {
123130
123550
  type: "array",
123131
123551
  items: {
123132
- type: "cid-link"
123552
+ type: "cid-link",
123553
+ description: "List of new blobs (by CID) referenced by records in this commit."
123133
123554
  }
123134
123555
  },
123135
123556
  time: {
123136
123557
  type: "string",
123137
- format: "datetime"
123558
+ format: "datetime",
123559
+ description: "Timestamp of when this message was originally broadcast."
123138
123560
  }
123139
123561
  }
123140
123562
  },
123141
123563
  handle: {
123142
123564
  type: "object",
123565
+ description: "Represents an update of the account's handle, or transition to/from invalid state.",
123143
123566
  required: ["seq", "did", "handle", "time"],
123144
123567
  properties: {
123145
123568
  seq: {
@@ -123161,6 +123584,7 @@ var schemaDict2 = {
123161
123584
  },
123162
123585
  migrate: {
123163
123586
  type: "object",
123587
+ description: "Represents an account moving from one PDS instance to another. NOTE: not implemented; full account migration may introduce a new message instead.",
123164
123588
  required: ["seq", "did", "migrateTo", "time"],
123165
123589
  nullable: ["migrateTo"],
123166
123590
  properties: {
@@ -123182,6 +123606,7 @@ var schemaDict2 = {
123182
123606
  },
123183
123607
  tombstone: {
123184
123608
  type: "object",
123609
+ description: "Indicates that an account has been deleted.",
123185
123610
  required: ["seq", "did", "time"],
123186
123611
  properties: {
123187
123612
  seq: {
@@ -123212,7 +123637,7 @@ var schemaDict2 = {
123212
123637
  },
123213
123638
  repoOp: {
123214
123639
  type: "object",
123215
- description: "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.",
123640
+ description: "A repo operation, ie a mutation of a single record.",
123216
123641
  required: ["action", "path", "cid"],
123217
123642
  nullable: ["cid"],
123218
123643
  properties: {
@@ -123224,7 +123649,8 @@ var schemaDict2 = {
123224
123649
  type: "string"
123225
123650
  },
123226
123651
  cid: {
123227
- type: "cid-link"
123652
+ type: "cid-link",
123653
+ description: "For creates and updates, the new record CID. For deletions, null."
123228
123654
  }
123229
123655
  }
123230
123656
  }
@@ -123264,7 +123690,7 @@ var schemaDict2 = {
123264
123690
  defs: {
123265
123691
  main: {
123266
123692
  type: "query",
123267
- description: "Fetch all labels from a labeler created after a certain date.",
123693
+ description: "Fetch all labels from a labeler created after a certain date. DEPRECATED: use queryLabels or subscribeLabels instead",
123268
123694
  parameters: {
123269
123695
  type: "params",
123270
123696
  properties: {
@@ -123377,7 +123803,7 @@ var schemaDict2 = {
123377
123803
  defs: {
123378
123804
  main: {
123379
123805
  type: "procedure",
123380
- description: "Transfer an account.",
123806
+ description: "Transfer an account. NOTE: temporary method, necessarily how account migration will be implemented.",
123381
123807
  input: {
123382
123808
  encoding: "application/json",
123383
123809
  schema: {
@@ -123450,7 +123876,6 @@ var schemaDict2 = {
123450
123876
  AppBskyActorDefs: {
123451
123877
  lexicon: 1,
123452
123878
  id: "app.bsky.actor.defs",
123453
- description: "A reference to an actor in the network.",
123454
123879
  defs: {
123455
123880
  profileViewBasic: {
123456
123881
  type: "object",
@@ -123583,6 +124008,7 @@ var schemaDict2 = {
123583
124008
  },
123584
124009
  viewerState: {
123585
124010
  type: "object",
124011
+ description: "Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.",
123586
124012
  properties: {
123587
124013
  muted: {
123588
124014
  type: "boolean"
@@ -123667,6 +124093,9 @@ var schemaDict2 = {
123667
124093
  type: "string",
123668
124094
  format: "at-uri"
123669
124095
  }
124096
+ },
124097
+ timelineIndex: {
124098
+ type: "integer"
123670
124099
  }
123671
124100
  }
123672
124101
  },
@@ -123748,7 +124177,7 @@ var schemaDict2 = {
123748
124177
  defs: {
123749
124178
  main: {
123750
124179
  type: "query",
123751
- description: "Get private preferences attached to the account.",
124180
+ description: "Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.",
123752
124181
  parameters: {
123753
124182
  type: "params",
123754
124183
  properties: {}
@@ -123775,14 +124204,15 @@ var schemaDict2 = {
123775
124204
  defs: {
123776
124205
  main: {
123777
124206
  type: "query",
123778
- description: "Get detailed profile view of an actor.",
124207
+ description: "Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth.",
123779
124208
  parameters: {
123780
124209
  type: "params",
123781
124210
  required: ["actor"],
123782
124211
  properties: {
123783
124212
  actor: {
123784
124213
  type: "string",
123785
- format: "at-identifier"
124214
+ format: "at-identifier",
124215
+ description: "Handle or DID of account to fetch profile of."
123786
124216
  }
123787
124217
  }
123788
124218
  },
@@ -123842,7 +124272,7 @@ var schemaDict2 = {
123842
124272
  defs: {
123843
124273
  main: {
123844
124274
  type: "query",
123845
- description: "Get a list of suggested actors, used for discovery.",
124275
+ description: "Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding.",
123846
124276
  parameters: {
123847
124277
  type: "params",
123848
124278
  properties: {
@@ -123885,7 +124315,7 @@ var schemaDict2 = {
123885
124315
  defs: {
123886
124316
  main: {
123887
124317
  type: "record",
123888
- description: "A declaration of a profile.",
124318
+ description: "A declaration of a Bluesky account profile.",
123889
124319
  key: "literal:self",
123890
124320
  record: {
123891
124321
  type: "object",
@@ -123897,21 +124327,25 @@ var schemaDict2 = {
123897
124327
  },
123898
124328
  description: {
123899
124329
  type: "string",
124330
+ description: "Free-form profile description text.",
123900
124331
  maxGraphemes: 256,
123901
124332
  maxLength: 2560
123902
124333
  },
123903
124334
  avatar: {
123904
124335
  type: "blob",
124336
+ description: "Small image to be displayed next to posts from account. AKA, 'profile picture'",
123905
124337
  accept: ["image/png", "image/jpeg"],
123906
124338
  maxSize: 1e6
123907
124339
  },
123908
124340
  banner: {
123909
124341
  type: "blob",
124342
+ description: "Larger horizontal image to display behind profile view.",
123910
124343
  accept: ["image/png", "image/jpeg"],
123911
124344
  maxSize: 1e6
123912
124345
  },
123913
124346
  labels: {
123914
124347
  type: "union",
124348
+ description: "Self-label values, specific to the Bluesky application, on the overall account.",
123915
124349
  refs: ["lex:com.atproto.label.defs#selfLabels"]
123916
124350
  }
123917
124351
  }
@@ -123948,7 +124382,7 @@ var schemaDict2 = {
123948
124382
  defs: {
123949
124383
  main: {
123950
124384
  type: "query",
123951
- description: "Find actors (profiles) matching search criteria.",
124385
+ description: "Find actors (profiles) matching search criteria. Does not require auth.",
123952
124386
  parameters: {
123953
124387
  type: "params",
123954
124388
  properties: {
@@ -123999,7 +124433,7 @@ var schemaDict2 = {
123999
124433
  defs: {
124000
124434
  main: {
124001
124435
  type: "query",
124002
- description: "Find actor suggestions for a prefix search term.",
124436
+ description: "Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth.",
124003
124437
  parameters: {
124004
124438
  type: "params",
124005
124439
  properties: {
@@ -124041,10 +124475,10 @@ var schemaDict2 = {
124041
124475
  AppBskyEmbedExternal: {
124042
124476
  lexicon: 1,
124043
124477
  id: "app.bsky.embed.external",
124044
- description: "A representation of some externally linked content, embedded in another form of content.",
124045
124478
  defs: {
124046
124479
  main: {
124047
124480
  type: "object",
124481
+ description: "A representation of some externally linked content (eg, a URL and 'card'), embedded in a Bluesky record (eg, a post).",
124048
124482
  required: ["external"],
124049
124483
  properties: {
124050
124484
  external: {
@@ -124108,7 +124542,7 @@ var schemaDict2 = {
124108
124542
  AppBskyEmbedImages: {
124109
124543
  lexicon: 1,
124110
124544
  id: "app.bsky.embed.images",
124111
- description: "A set of images embedded in some other form of content.",
124545
+ description: "A set of images embedded in a Bluesky record (eg, a post).",
124112
124546
  defs: {
124113
124547
  main: {
124114
124548
  type: "object",
@@ -124134,7 +124568,8 @@ var schemaDict2 = {
124134
124568
  maxSize: 1e6
124135
124569
  },
124136
124570
  alt: {
124137
- type: "string"
124571
+ type: "string",
124572
+ description: "Alt text description of the image, for accessibility."
124138
124573
  },
124139
124574
  aspectRatio: {
124140
124575
  type: "ref",
@@ -124176,13 +124611,16 @@ var schemaDict2 = {
124176
124611
  required: ["thumb", "fullsize", "alt"],
124177
124612
  properties: {
124178
124613
  thumb: {
124179
- type: "string"
124614
+ type: "string",
124615
+ description: "Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View."
124180
124616
  },
124181
124617
  fullsize: {
124182
- type: "string"
124618
+ type: "string",
124619
+ description: "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."
124183
124620
  },
124184
124621
  alt: {
124185
- type: "string"
124622
+ type: "string",
124623
+ description: "Alt text description of the image, for accessibility."
124186
124624
  },
124187
124625
  aspectRatio: {
124188
124626
  type: "ref",
@@ -124195,7 +124633,7 @@ var schemaDict2 = {
124195
124633
  AppBskyEmbedRecord: {
124196
124634
  lexicon: 1,
124197
124635
  id: "app.bsky.embed.record",
124198
- description: "A representation of a record embedded in another form of content.",
124636
+ description: "A representation of a record embedded in a Bluesky record (eg, a post). For example, a quote-post, or sharing a feed generator record.",
124199
124637
  defs: {
124200
124638
  main: {
124201
124639
  type: "object",
@@ -124240,7 +124678,8 @@ var schemaDict2 = {
124240
124678
  ref: "lex:app.bsky.actor.defs#profileViewBasic"
124241
124679
  },
124242
124680
  value: {
124243
- type: "unknown"
124681
+ type: "unknown",
124682
+ description: "The record data itself."
124244
124683
  },
124245
124684
  labels: {
124246
124685
  type: "array",
@@ -124304,7 +124743,7 @@ var schemaDict2 = {
124304
124743
  AppBskyEmbedRecordWithMedia: {
124305
124744
  lexicon: 1,
124306
124745
  id: "app.bsky.embed.recordWithMedia",
124307
- description: "A representation of a record embedded in another form of content, alongside other compatible embeds.",
124746
+ description: "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.",
124308
124747
  defs: {
124309
124748
  main: {
124310
124749
  type: "object",
@@ -124403,6 +124842,7 @@ var schemaDict2 = {
124403
124842
  },
124404
124843
  viewerState: {
124405
124844
  type: "object",
124845
+ description: "Metadata about the requesting account's relationship with the subject content. Only has meaningful content for authed requests.",
124406
124846
  properties: {
124407
124847
  repost: {
124408
124848
  type: "string",
@@ -124662,7 +125102,7 @@ var schemaDict2 = {
124662
125102
  defs: {
124663
125103
  main: {
124664
125104
  type: "query",
124665
- description: "Get information about a feed generator, including policies and offered feed URIs.",
125105
+ description: "Get information about a feed generator, including policies and offered feed URIs. Does not require auth; implemented by Feed Generator services (not App View).",
124666
125106
  output: {
124667
125107
  encoding: "application/json",
124668
125108
  schema: {
@@ -124717,7 +125157,7 @@ var schemaDict2 = {
124717
125157
  defs: {
124718
125158
  main: {
124719
125159
  type: "record",
124720
- description: "A declaration of the existence of a feed generator.",
125160
+ description: "Record declaring of the existence of a feed generator, and containing metadata about it. The record can exist in any repository.",
124721
125161
  key: "any",
124722
125162
  record: {
124723
125163
  type: "object",
@@ -124751,6 +125191,7 @@ var schemaDict2 = {
124751
125191
  },
124752
125192
  labels: {
124753
125193
  type: "union",
125194
+ description: "Self-label values",
124754
125195
  refs: ["lex:com.atproto.label.defs#selfLabels"]
124755
125196
  },
124756
125197
  createdAt: {
@@ -124768,7 +125209,7 @@ var schemaDict2 = {
124768
125209
  defs: {
124769
125210
  main: {
124770
125211
  type: "query",
124771
- description: "Get a list of feeds created by the actor.",
125212
+ description: "Get a list of feeds (feed generator records) created by the actor (in the actor's repo).",
124772
125213
  parameters: {
124773
125214
  type: "params",
124774
125215
  required: ["actor"],
@@ -124816,7 +125257,7 @@ var schemaDict2 = {
124816
125257
  defs: {
124817
125258
  main: {
124818
125259
  type: "query",
124819
- description: "Get a list of posts liked by an actor.",
125260
+ description: "Get a list of posts liked by an actor. Does not require auth.",
124820
125261
  parameters: {
124821
125262
  type: "params",
124822
125263
  required: ["actor"],
@@ -124872,7 +125313,7 @@ var schemaDict2 = {
124872
125313
  defs: {
124873
125314
  main: {
124874
125315
  type: "query",
124875
- description: "Get a view of an actor's feed.",
125316
+ description: "Get a view of an actor's 'author feed' (post and reposts by the author). Does not require auth.",
124876
125317
  parameters: {
124877
125318
  type: "params",
124878
125319
  required: ["actor"],
@@ -124892,6 +125333,7 @@ var schemaDict2 = {
124892
125333
  },
124893
125334
  filter: {
124894
125335
  type: "string",
125336
+ description: "Combinations of post/repost types to include in response.",
124895
125337
  knownValues: [
124896
125338
  "posts_with_replies",
124897
125339
  "posts_no_replies",
@@ -124938,7 +125380,7 @@ var schemaDict2 = {
124938
125380
  defs: {
124939
125381
  main: {
124940
125382
  type: "query",
124941
- description: "Get a hydrated feed from an actor's selected feed generator.",
125383
+ description: "Get a hydrated feed from an actor's selected feed generator. Implemented by App View.",
124942
125384
  parameters: {
124943
125385
  type: "params",
124944
125386
  required: ["feed"],
@@ -124991,14 +125433,15 @@ var schemaDict2 = {
124991
125433
  defs: {
124992
125434
  main: {
124993
125435
  type: "query",
124994
- description: "Get information about a feed generator.",
125436
+ description: "Get information about a feed generator. Implemented by AppView.",
124995
125437
  parameters: {
124996
125438
  type: "params",
124997
125439
  required: ["feed"],
124998
125440
  properties: {
124999
125441
  feed: {
125000
125442
  type: "string",
125001
- format: "at-uri"
125443
+ format: "at-uri",
125444
+ description: "AT-URI of the feed generator record."
125002
125445
  }
125003
125446
  }
125004
125447
  },
@@ -125013,10 +125456,12 @@ var schemaDict2 = {
125013
125456
  ref: "lex:app.bsky.feed.defs#generatorView"
125014
125457
  },
125015
125458
  isOnline: {
125016
- type: "boolean"
125459
+ type: "boolean",
125460
+ description: "Indicates whether the feed generator service has been online recently, or else seems to be inactive."
125017
125461
  },
125018
125462
  isValid: {
125019
- type: "boolean"
125463
+ type: "boolean",
125464
+ description: "Indicates whether the feed generator service is compatible with the record declaration."
125020
125465
  }
125021
125466
  }
125022
125467
  }
@@ -125069,14 +125514,15 @@ var schemaDict2 = {
125069
125514
  defs: {
125070
125515
  main: {
125071
125516
  type: "query",
125072
- description: "Get a skeleton of a feed provided by a feed generator.",
125517
+ description: "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.",
125073
125518
  parameters: {
125074
125519
  type: "params",
125075
125520
  required: ["feed"],
125076
125521
  properties: {
125077
125522
  feed: {
125078
125523
  type: "string",
125079
- format: "at-uri"
125524
+ format: "at-uri",
125525
+ description: "Reference to feed generator record describing the specific feed being requested."
125080
125526
  },
125081
125527
  limit: {
125082
125528
  type: "integer",
@@ -125122,18 +125568,20 @@ var schemaDict2 = {
125122
125568
  defs: {
125123
125569
  main: {
125124
125570
  type: "query",
125125
- description: "Get the list of likes.",
125571
+ description: "Get like records which reference a subject (by AT-URI and CID).",
125126
125572
  parameters: {
125127
125573
  type: "params",
125128
125574
  required: ["uri"],
125129
125575
  properties: {
125130
125576
  uri: {
125131
125577
  type: "string",
125132
- format: "at-uri"
125578
+ format: "at-uri",
125579
+ description: "AT-URI of the subject (eg, a post record)."
125133
125580
  },
125134
125581
  cid: {
125135
125582
  type: "string",
125136
- format: "cid"
125583
+ format: "cid",
125584
+ description: "CID of the subject record (aka, specific version of record), to filter likes."
125137
125585
  },
125138
125586
  limit: {
125139
125587
  type: "integer",
@@ -125200,14 +125648,15 @@ var schemaDict2 = {
125200
125648
  defs: {
125201
125649
  main: {
125202
125650
  type: "query",
125203
- description: "Get a view of a recent posts from actors in a list.",
125651
+ description: "Get a feed of recent posts from a list (posts and reposts from any actors on the list). Does not require auth.",
125204
125652
  parameters: {
125205
125653
  type: "params",
125206
125654
  required: ["list"],
125207
125655
  properties: {
125208
125656
  list: {
125209
125657
  type: "string",
125210
- format: "at-uri"
125658
+ format: "at-uri",
125659
+ description: "Reference (AT-URI) to the list record."
125211
125660
  },
125212
125661
  limit: {
125213
125662
  type: "integer",
@@ -125253,23 +125702,26 @@ var schemaDict2 = {
125253
125702
  defs: {
125254
125703
  main: {
125255
125704
  type: "query",
125256
- description: "Get posts in a thread.",
125705
+ description: "Get posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests.",
125257
125706
  parameters: {
125258
125707
  type: "params",
125259
125708
  required: ["uri"],
125260
125709
  properties: {
125261
125710
  uri: {
125262
125711
  type: "string",
125263
- format: "at-uri"
125712
+ format: "at-uri",
125713
+ description: "Reference (AT-URI) to post record."
125264
125714
  },
125265
125715
  depth: {
125266
125716
  type: "integer",
125717
+ description: "How many levels of reply depth should be included in response.",
125267
125718
  default: 6,
125268
125719
  minimum: 0,
125269
125720
  maximum: 1e3
125270
125721
  },
125271
125722
  parentHeight: {
125272
125723
  type: "integer",
125724
+ description: "How many levels of parent (and grandparent, etc) post to include.",
125273
125725
  default: 80,
125274
125726
  minimum: 0,
125275
125727
  maximum: 1e3
@@ -125307,13 +125759,14 @@ var schemaDict2 = {
125307
125759
  defs: {
125308
125760
  main: {
125309
125761
  type: "query",
125310
- description: "Get a view of an actor's feed.",
125762
+ description: "Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'.",
125311
125763
  parameters: {
125312
125764
  type: "params",
125313
125765
  required: ["uris"],
125314
125766
  properties: {
125315
125767
  uris: {
125316
125768
  type: "array",
125769
+ description: "List of post AT-URIs to return hydrated views for.",
125317
125770
  items: {
125318
125771
  type: "string",
125319
125772
  format: "at-uri"
@@ -125347,18 +125800,20 @@ var schemaDict2 = {
125347
125800
  defs: {
125348
125801
  main: {
125349
125802
  type: "query",
125350
- description: "Get a list of reposts.",
125803
+ description: "Get a list of reposts for a given post.",
125351
125804
  parameters: {
125352
125805
  type: "params",
125353
125806
  required: ["uri"],
125354
125807
  properties: {
125355
125808
  uri: {
125356
125809
  type: "string",
125357
- format: "at-uri"
125810
+ format: "at-uri",
125811
+ description: "Reference (AT-URI) of post record"
125358
125812
  },
125359
125813
  cid: {
125360
125814
  type: "string",
125361
- format: "cid"
125815
+ format: "cid",
125816
+ description: "If supplied, filters to reposts of specific version (by CID) of the post record."
125362
125817
  },
125363
125818
  limit: {
125364
125819
  type: "integer",
@@ -125407,7 +125862,7 @@ var schemaDict2 = {
125407
125862
  defs: {
125408
125863
  main: {
125409
125864
  type: "query",
125410
- description: "Get a list of suggested feeds for the viewer.",
125865
+ description: "Get a list of suggested feeds (feed generators) for the requesting account.",
125411
125866
  parameters: {
125412
125867
  type: "params",
125413
125868
  properties: {
@@ -125450,12 +125905,13 @@ var schemaDict2 = {
125450
125905
  defs: {
125451
125906
  main: {
125452
125907
  type: "query",
125453
- description: "Get a view of the actor's home timeline.",
125908
+ description: "Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed.",
125454
125909
  parameters: {
125455
125910
  type: "params",
125456
125911
  properties: {
125457
125912
  algorithm: {
125458
- type: "string"
125913
+ type: "string",
125914
+ description: "Variant 'algorithm' for timeline. Implementation-specific. NOTE: most feed flexibility has been moved to feed generator mechanism."
125459
125915
  },
125460
125916
  limit: {
125461
125917
  type: "integer",
@@ -125496,7 +125952,7 @@ var schemaDict2 = {
125496
125952
  defs: {
125497
125953
  main: {
125498
125954
  type: "record",
125499
- description: "A declaration of a like.",
125955
+ description: "Record declaring a 'like' of a piece of subject content.",
125500
125956
  key: "tid",
125501
125957
  record: {
125502
125958
  type: "object",
@@ -125521,7 +125977,7 @@ var schemaDict2 = {
125521
125977
  defs: {
125522
125978
  main: {
125523
125979
  type: "record",
125524
- description: "A declaration of a post.",
125980
+ description: "Record containing a Bluesky post.",
125525
125981
  key: "tid",
125526
125982
  record: {
125527
125983
  type: "object",
@@ -125530,11 +125986,12 @@ var schemaDict2 = {
125530
125986
  text: {
125531
125987
  type: "string",
125532
125988
  maxLength: 3e3,
125533
- maxGraphemes: 300
125989
+ maxGraphemes: 300,
125990
+ description: "The primary post content. May be an empty string, if there are embeds."
125534
125991
  },
125535
125992
  entities: {
125536
125993
  type: "array",
125537
- description: "Deprecated: replaced by app.bsky.richtext.facet.",
125994
+ description: "DEPRECATED: replaced by app.bsky.richtext.facet.",
125538
125995
  items: {
125539
125996
  type: "ref",
125540
125997
  ref: "lex:app.bsky.feed.post#entity"
@@ -125542,6 +125999,7 @@ var schemaDict2 = {
125542
125999
  },
125543
126000
  facets: {
125544
126001
  type: "array",
126002
+ description: "Annotations of text (mentions, URLs, hashtags, etc)",
125545
126003
  items: {
125546
126004
  type: "ref",
125547
126005
  ref: "lex:app.bsky.richtext.facet"
@@ -125562,6 +126020,7 @@ var schemaDict2 = {
125562
126020
  },
125563
126021
  langs: {
125564
126022
  type: "array",
126023
+ description: "Indicates human language of post primary text content.",
125565
126024
  maxLength: 3,
125566
126025
  items: {
125567
126026
  type: "string",
@@ -125570,21 +126029,23 @@ var schemaDict2 = {
125570
126029
  },
125571
126030
  labels: {
125572
126031
  type: "union",
126032
+ description: "Self-label values for this post. Effectively content warnings.",
125573
126033
  refs: ["lex:com.atproto.label.defs#selfLabels"]
125574
126034
  },
125575
126035
  tags: {
125576
126036
  type: "array",
126037
+ description: "Additional non-inline tags describing this post.",
125577
126038
  maxLength: 8,
125578
126039
  items: {
125579
126040
  type: "string",
125580
126041
  maxLength: 640,
125581
126042
  maxGraphemes: 64
125582
- },
125583
- description: "Additional non-inline tags describing this post."
126043
+ }
125584
126044
  },
125585
126045
  createdAt: {
125586
126046
  type: "string",
125587
- format: "datetime"
126047
+ format: "datetime",
126048
+ description: "Client-declared timestamp when this post was originally created."
125588
126049
  }
125589
126050
  }
125590
126051
  }
@@ -125643,7 +126104,7 @@ var schemaDict2 = {
125643
126104
  id: "app.bsky.feed.repost",
125644
126105
  defs: {
125645
126106
  main: {
125646
- description: "A declaration of a repost.",
126107
+ description: "Record representing a 'repost' of an existing Bluesky post.",
125647
126108
  type: "record",
125648
126109
  key: "tid",
125649
126110
  record: {
@@ -125669,7 +126130,7 @@ var schemaDict2 = {
125669
126130
  defs: {
125670
126131
  main: {
125671
126132
  type: "query",
125672
- description: "Find posts matching search criteria.",
126133
+ description: "Find posts matching search criteria, returning views of those posts.",
125673
126134
  parameters: {
125674
126135
  type: "params",
125675
126136
  required: ["q"],
@@ -125728,14 +126189,15 @@ var schemaDict2 = {
125728
126189
  main: {
125729
126190
  type: "record",
125730
126191
  key: "tid",
125731
- description: "Defines interaction gating rules for a thread. The rkey of the threadgate record should match the rkey of the thread's root post.",
126192
+ description: "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..",
125732
126193
  record: {
125733
126194
  type: "object",
125734
126195
  required: ["post", "createdAt"],
125735
126196
  properties: {
125736
126197
  post: {
125737
126198
  type: "string",
125738
- format: "at-uri"
126199
+ format: "at-uri",
126200
+ description: "Reference (AT-URI) to the post record."
125739
126201
  },
125740
126202
  allow: {
125741
126203
  type: "array",
@@ -125785,7 +126247,7 @@ var schemaDict2 = {
125785
126247
  defs: {
125786
126248
  main: {
125787
126249
  type: "record",
125788
- description: "A declaration of a block.",
126250
+ description: "Record declaring a 'block' relationship against another account. NOTE: blocks are public in Bluesky; see blog posts for details.",
125789
126251
  key: "tid",
125790
126252
  record: {
125791
126253
  type: "object",
@@ -125793,7 +126255,8 @@ var schemaDict2 = {
125793
126255
  properties: {
125794
126256
  subject: {
125795
126257
  type: "string",
125796
- format: "did"
126258
+ format: "did",
126259
+ description: "DID of the account to be blocked."
125797
126260
  },
125798
126261
  createdAt: {
125799
126262
  type: "string",
@@ -125977,7 +126440,7 @@ var schemaDict2 = {
125977
126440
  defs: {
125978
126441
  main: {
125979
126442
  type: "record",
125980
- description: "A declaration of a social follow.",
126443
+ description: "Record declaring a social 'follow' relationship of another account. Duplicate follows will be ignored by the AppView.",
125981
126444
  key: "tid",
125982
126445
  record: {
125983
126446
  type: "object",
@@ -126002,7 +126465,7 @@ var schemaDict2 = {
126002
126465
  defs: {
126003
126466
  main: {
126004
126467
  type: "query",
126005
- description: "Get a list of who the actor is blocking.",
126468
+ description: "Enumerates which accounts the requesting account is currently blocking. Requires auth.",
126006
126469
  parameters: {
126007
126470
  type: "params",
126008
126471
  properties: {
@@ -126045,7 +126508,7 @@ var schemaDict2 = {
126045
126508
  defs: {
126046
126509
  main: {
126047
126510
  type: "query",
126048
- description: "Get a list of an actor's followers.",
126511
+ description: "Enumerates accounts which follow a specified account (actor).",
126049
126512
  parameters: {
126050
126513
  type: "params",
126051
126514
  required: ["actor"],
@@ -126097,7 +126560,7 @@ var schemaDict2 = {
126097
126560
  defs: {
126098
126561
  main: {
126099
126562
  type: "query",
126100
- description: "Get a list of who the actor follows.",
126563
+ description: "Enumerates accounts which a specified account (actor) follows.",
126101
126564
  parameters: {
126102
126565
  type: "params",
126103
126566
  required: ["actor"],
@@ -126149,14 +126612,15 @@ var schemaDict2 = {
126149
126612
  defs: {
126150
126613
  main: {
126151
126614
  type: "query",
126152
- description: "Get a list of actors.",
126615
+ description: "Gets a 'view' (with additional context) of a specified list.",
126153
126616
  parameters: {
126154
126617
  type: "params",
126155
126618
  required: ["list"],
126156
126619
  properties: {
126157
126620
  list: {
126158
126621
  type: "string",
126159
- format: "at-uri"
126622
+ format: "at-uri",
126623
+ description: "Reference (AT-URI) of the list record to hydrate."
126160
126624
  },
126161
126625
  limit: {
126162
126626
  type: "integer",
@@ -126201,7 +126665,7 @@ var schemaDict2 = {
126201
126665
  defs: {
126202
126666
  main: {
126203
126667
  type: "query",
126204
- description: "Get lists that the actor is blocking.",
126668
+ description: "Get mod lists that the requesting account (actor) is blocking. Requires auth.",
126205
126669
  parameters: {
126206
126670
  type: "params",
126207
126671
  properties: {
@@ -126244,7 +126708,7 @@ var schemaDict2 = {
126244
126708
  defs: {
126245
126709
  main: {
126246
126710
  type: "query",
126247
- description: "Get lists that the actor is muting.",
126711
+ description: "Enumerates mod lists that the requesting account (actor) currently has muted. Requires auth.",
126248
126712
  parameters: {
126249
126713
  type: "params",
126250
126714
  properties: {
@@ -126287,14 +126751,15 @@ var schemaDict2 = {
126287
126751
  defs: {
126288
126752
  main: {
126289
126753
  type: "query",
126290
- description: "Get a list of lists that belong to an actor.",
126754
+ description: "Enumerates the lists created by a specified account (actor).",
126291
126755
  parameters: {
126292
126756
  type: "params",
126293
126757
  required: ["actor"],
126294
126758
  properties: {
126295
126759
  actor: {
126296
126760
  type: "string",
126297
- format: "at-identifier"
126761
+ format: "at-identifier",
126762
+ description: "The account (actor) to enumerate lists from."
126298
126763
  },
126299
126764
  limit: {
126300
126765
  type: "integer",
@@ -126335,7 +126800,7 @@ var schemaDict2 = {
126335
126800
  defs: {
126336
126801
  main: {
126337
126802
  type: "query",
126338
- description: "Get a list of who the actor mutes.",
126803
+ description: "Enumerates accounts that the requesting account (actor) currently has muted. Requires auth.",
126339
126804
  parameters: {
126340
126805
  type: "params",
126341
126806
  properties: {
@@ -126378,17 +126843,19 @@ var schemaDict2 = {
126378
126843
  defs: {
126379
126844
  main: {
126380
126845
  type: "query",
126381
- description: "Enumerates public relationships between one account, and a list of other accounts",
126846
+ description: "Enumerates public relationships between one account, and a list of other accounts. Does not require auth.",
126382
126847
  parameters: {
126383
126848
  type: "params",
126384
126849
  required: ["actor"],
126385
126850
  properties: {
126386
126851
  actor: {
126387
126852
  type: "string",
126388
- format: "at-identifier"
126853
+ format: "at-identifier",
126854
+ description: "Primary account requesting relationships for."
126389
126855
  },
126390
126856
  others: {
126391
126857
  type: "array",
126858
+ description: "List of 'other' accounts to be related back to the primary.",
126392
126859
  maxLength: 30,
126393
126860
  items: {
126394
126861
  type: "string",
@@ -126435,7 +126902,7 @@ var schemaDict2 = {
126435
126902
  defs: {
126436
126903
  main: {
126437
126904
  type: "query",
126438
- description: "Get suggested follows related to a given actor.",
126905
+ description: "Enumerates follows similar to a given account (actor). Expected use is to recommend additional accounts immediately after following one account.",
126439
126906
  parameters: {
126440
126907
  type: "params",
126441
126908
  required: ["actor"],
@@ -126471,7 +126938,7 @@ var schemaDict2 = {
126471
126938
  defs: {
126472
126939
  main: {
126473
126940
  type: "record",
126474
- description: "A declaration of a list of actors.",
126941
+ description: "Record representing a list of accounts (actors). Scope includes both moderation-oriented lists and curration-oriented lists.",
126475
126942
  key: "tid",
126476
126943
  record: {
126477
126944
  type: "object",
@@ -126479,12 +126946,14 @@ var schemaDict2 = {
126479
126946
  properties: {
126480
126947
  purpose: {
126481
126948
  type: "ref",
126949
+ description: "Defines the purpose of the list (aka, moderation-oriented or curration-oriented)",
126482
126950
  ref: "lex:app.bsky.graph.defs#listPurpose"
126483
126951
  },
126484
126952
  name: {
126485
126953
  type: "string",
126486
126954
  maxLength: 64,
126487
- minLength: 1
126955
+ minLength: 1,
126956
+ description: "Display name for list; can not be empty."
126488
126957
  },
126489
126958
  description: {
126490
126959
  type: "string",
@@ -126522,7 +126991,7 @@ var schemaDict2 = {
126522
126991
  defs: {
126523
126992
  main: {
126524
126993
  type: "record",
126525
- description: "A block of an entire list of actors.",
126994
+ description: "Record representing a block relationship against an entire an entire list of accounts (actors).",
126526
126995
  key: "tid",
126527
126996
  record: {
126528
126997
  type: "object",
@@ -126530,7 +126999,8 @@ var schemaDict2 = {
126530
126999
  properties: {
126531
127000
  subject: {
126532
127001
  type: "string",
126533
- format: "at-uri"
127002
+ format: "at-uri",
127003
+ description: "Reference (AT-URI) to the mod list record."
126534
127004
  },
126535
127005
  createdAt: {
126536
127006
  type: "string",
@@ -126547,7 +127017,7 @@ var schemaDict2 = {
126547
127017
  defs: {
126548
127018
  main: {
126549
127019
  type: "record",
126550
- description: "An item under a declared list of actors.",
127020
+ description: "Record representing an account's inclusion on a specific list. The AppView will ignore duplicate listitem records.",
126551
127021
  key: "tid",
126552
127022
  record: {
126553
127023
  type: "object",
@@ -126555,11 +127025,13 @@ var schemaDict2 = {
126555
127025
  properties: {
126556
127026
  subject: {
126557
127027
  type: "string",
126558
- format: "did"
127028
+ format: "did",
127029
+ description: "The account which is included on the list."
126559
127030
  },
126560
127031
  list: {
126561
127032
  type: "string",
126562
- format: "at-uri"
127033
+ format: "at-uri",
127034
+ description: "Reference (AT-URI) to the list record (app.bsky.graph.list)."
126563
127035
  },
126564
127036
  createdAt: {
126565
127037
  type: "string",
@@ -126576,7 +127048,7 @@ var schemaDict2 = {
126576
127048
  defs: {
126577
127049
  main: {
126578
127050
  type: "procedure",
126579
- description: "Mute an actor by DID or handle.",
127051
+ description: "Creates a mute relationship for the specified account. Mutes are private in Bluesky. Requires auth.",
126580
127052
  input: {
126581
127053
  encoding: "application/json",
126582
127054
  schema: {
@@ -126599,7 +127071,7 @@ var schemaDict2 = {
126599
127071
  defs: {
126600
127072
  main: {
126601
127073
  type: "procedure",
126602
- description: "Mute a list of actors.",
127074
+ description: "Creates a mute relationship for the specified list of accounts. Mutes are private in Bluesky. Requires auth.",
126603
127075
  input: {
126604
127076
  encoding: "application/json",
126605
127077
  schema: {
@@ -126622,7 +127094,7 @@ var schemaDict2 = {
126622
127094
  defs: {
126623
127095
  main: {
126624
127096
  type: "procedure",
126625
- description: "Unmute an actor by DID or handle.",
127097
+ description: "Unmutes the specified account. Requires auth.",
126626
127098
  input: {
126627
127099
  encoding: "application/json",
126628
127100
  schema: {
@@ -126645,7 +127117,7 @@ var schemaDict2 = {
126645
127117
  defs: {
126646
127118
  main: {
126647
127119
  type: "procedure",
126648
- description: "Unmute a list of actors.",
127120
+ description: "Unmutes the specified list of accounts. Requires auth.",
126649
127121
  input: {
126650
127122
  encoding: "application/json",
126651
127123
  schema: {
@@ -126668,7 +127140,7 @@ var schemaDict2 = {
126668
127140
  defs: {
126669
127141
  main: {
126670
127142
  type: "query",
126671
- description: "Get the count of unread notifications.",
127143
+ description: "Count the number of unread notifications for the requesting account. Requires auth.",
126672
127144
  parameters: {
126673
127145
  type: "params",
126674
127146
  properties: {
@@ -126699,7 +127171,7 @@ var schemaDict2 = {
126699
127171
  defs: {
126700
127172
  main: {
126701
127173
  type: "query",
126702
- description: "Get a list of notifications.",
127174
+ description: "Enumerate notifications for the requesting account. Requires auth.",
126703
127175
  parameters: {
126704
127176
  type: "params",
126705
127177
  properties: {
@@ -126809,7 +127281,7 @@ var schemaDict2 = {
126809
127281
  defs: {
126810
127282
  main: {
126811
127283
  type: "procedure",
126812
- description: "Register for push notifications with a service.",
127284
+ description: "Register to receive push notifications, via a specified service, for the requesting account. Requires auth.",
126813
127285
  input: {
126814
127286
  encoding: "application/json",
126815
127287
  schema: {
@@ -126842,7 +127314,7 @@ var schemaDict2 = {
126842
127314
  defs: {
126843
127315
  main: {
126844
127316
  type: "procedure",
126845
- description: "Notify server that the user has seen notifications.",
127317
+ description: "Notify server that the requesting account has seen notifications. Requires auth.",
126846
127318
  input: {
126847
127319
  encoding: "application/json",
126848
127320
  schema: {
@@ -126865,6 +127337,7 @@ var schemaDict2 = {
126865
127337
  defs: {
126866
127338
  main: {
126867
127339
  type: "object",
127340
+ description: "Annotation of a sub-string within rich text.",
126868
127341
  required: ["index", "features"],
126869
127342
  properties: {
126870
127343
  index: {
@@ -126886,7 +127359,7 @@ var schemaDict2 = {
126886
127359
  },
126887
127360
  mention: {
126888
127361
  type: "object",
126889
- description: "A facet feature for actor mentions.",
127362
+ description: "Facet feature for mention of another account. The text is usually a handle, including a '@' prefix, but the facet reference is a DID.",
126890
127363
  required: ["did"],
126891
127364
  properties: {
126892
127365
  did: {
@@ -126897,7 +127370,7 @@ var schemaDict2 = {
126897
127370
  },
126898
127371
  link: {
126899
127372
  type: "object",
126900
- description: "A facet feature for links.",
127373
+ description: "Facet feature for a URL. The text URL may have been simplified or truncated, but the facet reference should be a complete URL.",
126901
127374
  required: ["uri"],
126902
127375
  properties: {
126903
127376
  uri: {
@@ -126908,7 +127381,7 @@ var schemaDict2 = {
126908
127381
  },
126909
127382
  tag: {
126910
127383
  type: "object",
126911
- description: "A hashtag.",
127384
+ description: "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').",
126912
127385
  required: ["tag"],
126913
127386
  properties: {
126914
127387
  tag: {
@@ -126920,7 +127393,7 @@ var schemaDict2 = {
126920
127393
  },
126921
127394
  byteSlice: {
126922
127395
  type: "object",
126923
- description: "A text segment. Start is inclusive, end is exclusive. Indices are for utf8-encoded strings.",
127396
+ description: "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.",
126924
127397
  required: ["byteStart", "byteEnd"],
126925
127398
  properties: {
126926
127399
  byteStart: {