@atproto/api 0.24.3 → 0.25.0

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 (28) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/client/index.d.ts +28 -0
  3. package/dist/client/index.d.ts.map +1 -1
  4. package/dist/client/index.js +35 -0
  5. package/dist/client/index.js.map +1 -1
  6. package/dist/client/lexicons.d.ts +426 -20
  7. package/dist/client/lexicons.d.ts.map +1 -1
  8. package/dist/client/lexicons.js +217 -10
  9. package/dist/client/lexicons.js.map +1 -1
  10. package/dist/client/types/app/bsky/actor/defs.d.ts +15 -0
  11. package/dist/client/types/app/bsky/actor/defs.d.ts.map +1 -1
  12. package/dist/client/types/app/bsky/actor/defs.js +7 -0
  13. package/dist/client/types/app/bsky/actor/defs.js.map +1 -1
  14. package/dist/client/types/app/bsky/actor/link.d.ts +19 -0
  15. package/dist/client/types/app/bsky/actor/link.d.ts.map +1 -0
  16. package/dist/client/types/app/bsky/actor/link.js +18 -0
  17. package/dist/client/types/app/bsky/actor/link.js.map +1 -0
  18. package/dist/client/types/app/bsky/actor/profile.d.ts +2 -0
  19. package/dist/client/types/app/bsky/actor/profile.d.ts.map +1 -1
  20. package/dist/client/types/app/bsky/actor/profile.js.map +1 -1
  21. package/dist/client/types/app/bsky/embed/getEmbedExternalView.d.ts +11 -4
  22. package/dist/client/types/app/bsky/embed/getEmbedExternalView.d.ts.map +1 -1
  23. package/dist/client/types/app/bsky/embed/getEmbedExternalView.js.map +1 -1
  24. package/dist/client/types/app/bsky/notification/getGroupedNotifications.d.ts +49 -2
  25. package/dist/client/types/app/bsky/notification/getGroupedNotifications.d.ts.map +1 -1
  26. package/dist/client/types/app/bsky/notification/getGroupedNotifications.js +42 -0
  27. package/dist/client/types/app/bsky/notification/getGroupedNotifications.js.map +1 -1
  28. package/package.json +3 -3
@@ -229,6 +229,14 @@ export const schemaDict = {
229
229
  type: 'ref',
230
230
  ref: 'lex:com.atproto.repo.strongRef',
231
231
  },
232
+ links: {
233
+ type: 'array',
234
+ description: "The profile's links, in display order. Links that were taken down or don't resolve are left out.",
235
+ items: {
236
+ type: 'ref',
237
+ ref: 'lex:app.bsky.actor.defs#profileLinkView',
238
+ },
239
+ },
232
240
  verification: {
233
241
  type: 'ref',
234
242
  ref: 'lex:app.bsky.actor.defs#verificationState',
@@ -300,6 +308,36 @@ export const schemaDict = {
300
308
  },
301
309
  },
302
310
  },
311
+ profileLinkView: {
312
+ type: 'object',
313
+ required: ['uri', 'cid', 'url'],
314
+ properties: {
315
+ uri: {
316
+ type: 'string',
317
+ format: 'at-uri',
318
+ description: 'The app.bsky.actor.link record, e.g. for reporting the link.',
319
+ },
320
+ cid: {
321
+ type: 'string',
322
+ format: 'cid',
323
+ },
324
+ url: {
325
+ type: 'string',
326
+ format: 'uri',
327
+ description: 'The link destination.',
328
+ },
329
+ title: {
330
+ type: 'string',
331
+ maxGraphemes: 40,
332
+ maxLength: 320,
333
+ },
334
+ icon: {
335
+ type: 'string',
336
+ format: 'uri',
337
+ description: "Image URL for the destination site's icon.",
338
+ },
339
+ },
340
+ },
303
341
  profileAssociatedActivitySubscription: {
304
342
  type: 'object',
305
343
  required: ['allowSubscriptions'],
@@ -1059,6 +1097,44 @@ export const schemaDict = {
1059
1097
  },
1060
1098
  },
1061
1099
  },
1100
+ AppBskyActorLink: {
1101
+ lexicon: 1,
1102
+ id: 'app.bsky.actor.link',
1103
+ defs: {
1104
+ main: {
1105
+ type: 'record',
1106
+ description: "A link shown on the account's profile. The profile record's links field sets which links are shown, and in what order.",
1107
+ key: 'tid',
1108
+ record: {
1109
+ type: 'object',
1110
+ required: ['url', 'createdAt'],
1111
+ properties: {
1112
+ url: {
1113
+ type: 'string',
1114
+ format: 'uri',
1115
+ description: 'The link destination, an https URL.',
1116
+ },
1117
+ title: {
1118
+ type: 'string',
1119
+ description: "Optional label for the link. Clients can fall back to the destination's domain.",
1120
+ maxGraphemes: 40,
1121
+ maxLength: 320,
1122
+ },
1123
+ icon: {
1124
+ type: 'blob',
1125
+ description: "The destination site's icon, uploaded when the link is saved.",
1126
+ accept: ['image/png', 'image/jpeg', 'image/webp'],
1127
+ maxSize: 100000,
1128
+ },
1129
+ createdAt: {
1130
+ type: 'string',
1131
+ format: 'datetime',
1132
+ },
1133
+ },
1134
+ },
1135
+ },
1136
+ },
1137
+ },
1062
1138
  AppBskyActorProfile: {
1063
1139
  lexicon: 1,
1064
1140
  id: 'app.bsky.actor.profile',
@@ -1116,6 +1192,15 @@ export const schemaDict = {
1116
1192
  type: 'ref',
1117
1193
  ref: 'lex:com.atproto.repo.strongRef',
1118
1194
  },
1195
+ links: {
1196
+ type: 'array',
1197
+ description: 'Links shown on the profile, in display order. Each ref points to an app.bsky.actor.link record in this repo.',
1198
+ maxLength: 10,
1199
+ items: {
1200
+ type: 'ref',
1201
+ ref: 'lex:com.atproto.repo.strongRef',
1202
+ },
1203
+ },
1119
1204
  createdAt: {
1120
1205
  type: 'string',
1121
1206
  format: 'datetime',
@@ -3236,19 +3321,24 @@ export const schemaDict = {
3236
3321
  defs: {
3237
3322
  main: {
3238
3323
  type: 'query',
3239
- description: "Resolve one or more AT-URIs into the data needed to render an enhanced external embed. Returns `associatedRefs` (strongRefs to embed into a post's external.associatedRefs), the raw `associatedRecords`, and a hydrated `view`. The response is empty (`{}`) when no records were resolvable, or when validation determined the resolved records don't actually back the requested URL; clients should fall back to their own link-card rendering in that case and skip writing strongRefs to the post.",
3324
+ description: "Resolve one AT-URI record into the data needed to render an enhanced external embed. The records are validated against the requested `url` before any view is built. When validation passes, returns `data`, `associatedRefs` (strongRefs to embed into a post's external.associatedRefs) and the raw `associatedRecords`, plus a legacy `view` for Standard.site records only. When validation fails, only `unverifiedAssociatedRefs` and `unverifiedAssociatedRecords` are returned and no view or data is built. The response is empty (`{}`) when no record URI was usable or the record could not be resolved; clients should fall back to their own link-card rendering in that case and skip writing strongRefs to the post.",
3240
3325
  parameters: {
3241
3326
  type: 'params',
3242
- required: ['url', 'uris'],
3327
+ required: ['url'],
3243
3328
  properties: {
3244
3329
  url: {
3245
3330
  type: 'string',
3246
3331
  format: 'uri',
3247
- description: "The canonical web URL the embed represents (typically the URL the user pasted into the composer). Used as the returned view's `uri`. May be used for validation in the future.",
3332
+ description: "The canonical web URL the embed represents (typically the URL the user pasted into the composer). Used as the returned view's `uri`, and validated against the resolved records.",
3333
+ },
3334
+ canonicalUri: {
3335
+ type: 'string',
3336
+ format: 'at-uri',
3337
+ description: 'The canonical AT URI of the atproto record found on the webpage. When provided, takes precedence over `uris`, which is then ignored.',
3248
3338
  },
3249
3339
  uris: {
3250
3340
  type: 'array',
3251
- description: 'AT-URIs of any Atmosphere records that can be resolved and used to construct #externalView views. Example: a site.standard.document and optionally its associated site.standard.publication.',
3341
+ description: "Legacy input for Standard.site callers, ignored when `canonicalUri` is provided. A single record is selected from it: the first site.standard.document URI, otherwise the first site.standard.publication URI. Other entries are ignored; a document's publication is discovered from the document itself.",
3252
3342
  items: {
3253
3343
  type: 'string',
3254
3344
  format: 'at-uri',
@@ -3265,7 +3355,7 @@ export const schemaDict = {
3265
3355
  view: {
3266
3356
  type: 'ref',
3267
3357
  ref: 'lex:app.bsky.embed.external#view',
3268
- description: 'Hydrated view of the embed. Present only when the resolved records back the requested URL and supply enough information to populate the required `viewExternal` fields. Omitted alongside the rest of the response when no records resolved or validation failed.',
3358
+ description: 'Legacy hydrated view of the embed, returned for Standard.site records only. Present only when validation passed and the records supply enough information to populate the required `viewExternal` fields.',
3269
3359
  },
3270
3360
  data: {
3271
3361
  type: 'union',
@@ -3275,7 +3365,7 @@ export const schemaDict = {
3275
3365
  'lex:app.bsky.embed.external#viewGallery',
3276
3366
  'lex:app.bsky.embed.external#viewLivestream',
3277
3367
  ],
3278
- description: 'Preferred to #view. Hydrated data of the embed. Present only when the resolved records back the requested URL and supply enough information to populate the required fields. Omitted alongside the rest of the response when no records resolved or validation failed.',
3368
+ description: 'Preferred to #view. Hydrated data of the embed. Present only when validation passed and the records supply enough information to populate the required fields.',
3279
3369
  },
3280
3370
  associatedRefs: {
3281
3371
  type: 'array',
@@ -3283,13 +3373,28 @@ export const schemaDict = {
3283
3373
  type: 'ref',
3284
3374
  ref: 'lex:com.atproto.repo.strongRef',
3285
3375
  },
3286
- description: "StrongRefs (URI+CID) of the Atmosphere records that backed this view, suitable for embedding into a post's external.associatedRefs.",
3376
+ description: 'StrongRefs (URI+CID) of the Atmosphere records selected for persistence in a post, suitable for embedding into its external.associatedRefs: the canonical record, plus only the additional records the service chooses to persist for its collection. This can be a subset of the records used to render `data`, which may also draw on other hydrated records such as recommendations, subscriptions, or favorites. Present only when validation passed. Index-aligned with `associatedRecords`.',
3287
3377
  },
3288
3378
  associatedRecords: {
3289
3379
  type: 'array',
3290
3380
  items: {
3291
3381
  type: 'unknown',
3292
- description: 'The raw record data of the Atmosphere records that backed this view. This is returned for convenience, to avoid the need for the client to separately fetch the record data for the associatedRefs. Example: the site.standard.document and site.standard.publication records that backed this view.',
3382
+ description: 'The raw record data of the Atmosphere records selected for persistence, index-aligned with `associatedRefs`. Returned for convenience, to avoid the client separately fetching them. Present only when validation passed.',
3383
+ },
3384
+ },
3385
+ unverifiedAssociatedRefs: {
3386
+ type: 'array',
3387
+ items: {
3388
+ type: 'ref',
3389
+ ref: 'lex:com.atproto.repo.strongRef',
3390
+ },
3391
+ description: 'StrongRefs (URI+CID) of the same persistence-selected Atmosphere records (the canonical record plus chosen additional records) when validation of the requested `url` failed. These must not be written to a post. Index-aligned with `unverifiedAssociatedRecords`.',
3392
+ },
3393
+ unverifiedAssociatedRecords: {
3394
+ type: 'array',
3395
+ items: {
3396
+ type: 'unknown',
3397
+ description: 'The raw record data of the persistence-selected Atmosphere records, index-aligned with `unverifiedAssociatedRefs`. Present only when validation failed.',
3293
3398
  },
3294
3399
  },
3295
3400
  },
@@ -7995,12 +8100,12 @@ export const schemaDict = {
7995
8100
  items: {
7996
8101
  type: 'union',
7997
8102
  refs: [
7998
- 'lex:app.bsky.actor.defs#profileViewDetailed',
8103
+ 'lex:app.bsky.actor.defs#profileViewBasic',
7999
8104
  'lex:app.bsky.feed.defs#blockedPost',
8000
8105
  'lex:app.bsky.feed.defs#generatorView',
8001
8106
  'lex:app.bsky.feed.defs#notFoundPost',
8002
8107
  'lex:app.bsky.feed.defs#postView',
8003
- 'lex:app.bsky.graph.defs#starterPackView',
8108
+ 'lex:app.bsky.graph.defs#starterPackViewBasic',
8004
8109
  ],
8005
8110
  },
8006
8111
  },
@@ -8033,6 +8138,9 @@ export const schemaDict = {
8033
8138
  refs: [
8034
8139
  'lex:app.bsky.notification.getGroupedNotifications#likeGroup',
8035
8140
  'lex:app.bsky.notification.getGroupedNotifications#multiPostLikeGroup',
8141
+ 'lex:app.bsky.notification.getGroupedNotifications#multiPostRepostGroup',
8142
+ 'lex:app.bsky.notification.getGroupedNotifications#multiPostLikeViaRepostGroup',
8143
+ 'lex:app.bsky.notification.getGroupedNotifications#multiPostRepostViaRepostGroup',
8036
8144
  'lex:app.bsky.notification.getGroupedNotifications#repostGroup',
8037
8145
  'lex:app.bsky.notification.getGroupedNotifications#likeViaRepostGroup',
8038
8146
  'lex:app.bsky.notification.getGroupedNotifications#repostViaRepostGroup',
@@ -8111,6 +8219,104 @@ export const schemaDict = {
8111
8219
  },
8112
8220
  },
8113
8221
  },
8222
+ multiPostRepostGroup: {
8223
+ type: 'object',
8224
+ description: 'Group of reposts by the same actor of different posts.',
8225
+ required: ['actor', 'items'],
8226
+ properties: {
8227
+ actor: {
8228
+ type: 'string',
8229
+ format: 'did',
8230
+ },
8231
+ items: {
8232
+ type: 'array',
8233
+ minLength: 2,
8234
+ items: {
8235
+ type: 'ref',
8236
+ ref: 'lex:app.bsky.notification.getGroupedNotifications#multiPostRepostItem',
8237
+ },
8238
+ },
8239
+ },
8240
+ },
8241
+ multiPostRepostItem: {
8242
+ type: 'object',
8243
+ description: "One post which was reposted by the group's actor.",
8244
+ required: ['post'],
8245
+ properties: {
8246
+ post: {
8247
+ type: 'string',
8248
+ format: 'at-uri',
8249
+ },
8250
+ },
8251
+ },
8252
+ multiPostLikeViaRepostGroup: {
8253
+ type: 'object',
8254
+ description: "Group of likes by the same actor on different posts via the requesting account's reposts.",
8255
+ required: ['actor', 'items'],
8256
+ properties: {
8257
+ actor: {
8258
+ type: 'string',
8259
+ format: 'did',
8260
+ },
8261
+ items: {
8262
+ type: 'array',
8263
+ minLength: 2,
8264
+ items: {
8265
+ type: 'ref',
8266
+ ref: 'lex:app.bsky.notification.getGroupedNotifications#multiPostLikeViaRepostItem',
8267
+ },
8268
+ },
8269
+ },
8270
+ },
8271
+ multiPostLikeViaRepostItem: {
8272
+ type: 'object',
8273
+ description: "One post which was liked by the group's actor via the requesting account's repost.",
8274
+ required: ['post', 'viaRepost'],
8275
+ properties: {
8276
+ post: {
8277
+ type: 'string',
8278
+ format: 'at-uri',
8279
+ },
8280
+ viaRepost: {
8281
+ type: 'string',
8282
+ format: 'at-uri',
8283
+ },
8284
+ },
8285
+ },
8286
+ multiPostRepostViaRepostGroup: {
8287
+ type: 'object',
8288
+ description: "Group of reposts by the same actor of different posts via the requesting account's reposts.",
8289
+ required: ['actor', 'items'],
8290
+ properties: {
8291
+ actor: {
8292
+ type: 'string',
8293
+ format: 'did',
8294
+ },
8295
+ items: {
8296
+ type: 'array',
8297
+ minLength: 2,
8298
+ items: {
8299
+ type: 'ref',
8300
+ ref: 'lex:app.bsky.notification.getGroupedNotifications#multiPostRepostViaRepostItem',
8301
+ },
8302
+ },
8303
+ },
8304
+ },
8305
+ multiPostRepostViaRepostItem: {
8306
+ type: 'object',
8307
+ description: "One post which was reposted by the group's actor via the requesting account's repost.",
8308
+ required: ['post', 'viaRepost'],
8309
+ properties: {
8310
+ post: {
8311
+ type: 'string',
8312
+ format: 'at-uri',
8313
+ },
8314
+ viaRepost: {
8315
+ type: 'string',
8316
+ format: 'at-uri',
8317
+ },
8318
+ },
8319
+ },
8114
8320
  repostGroup: {
8115
8321
  type: 'object',
8116
8322
  description: 'Group of reposts by different actors of the same post.',
@@ -29053,6 +29259,7 @@ export const ids = {
29053
29259
  AppBskyActorGetProfile: 'app.bsky.actor.getProfile',
29054
29260
  AppBskyActorGetProfiles: 'app.bsky.actor.getProfiles',
29055
29261
  AppBskyActorGetSuggestions: 'app.bsky.actor.getSuggestions',
29262
+ AppBskyActorLink: 'app.bsky.actor.link',
29056
29263
  AppBskyActorProfile: 'app.bsky.actor.profile',
29057
29264
  AppBskyActorPutPreferences: 'app.bsky.actor.putPreferences',
29058
29265
  AppBskyActorSearchActors: 'app.bsky.actor.searchActors',