@atproto/api 0.24.3 → 0.26.0

package/dist/client/lexicons.js

@@ -229,6 +229,14 @@ export const schemaDict = {
                         type: 'ref',
                         ref: 'lex:com.atproto.repo.strongRef',
                     },
+                    links: {
+                        type: 'array',
+                        description: "The profile's links, in display order. Links that were taken down or don't resolve are left out.",
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:app.bsky.actor.defs#profileLinkView',
+                        },
+                    },
                     verification: {
                         type: 'ref',
                         ref: 'lex:app.bsky.actor.defs#verificationState',
@@ -300,6 +308,43 @@ export const schemaDict = {
                     },
                 },
             },
+            profileLinkView: {
+                type: 'object',
+                required: ['uri', 'cid', 'url'],
+                properties: {
+                    uri: {
+                        type: 'string',
+                        format: 'at-uri',
+                        description: 'The app.bsky.actor.link record, e.g. for reporting the link.',
+                    },
+                    cid: {
+                        type: 'string',
+                        format: 'cid',
+                    },
+                    url: {
+                        type: 'string',
+                        format: 'uri',
+                        description: 'The link destination.',
+                    },
+                    title: {
+                        type: 'string',
+                        maxGraphemes: 40,
+                        maxLength: 320,
+                    },
+                    icon: {
+                        type: 'string',
+                        format: 'uri',
+                        description: "Image URL for the destination site's icon.",
+                    },
+                    labels: {
+                        type: 'array',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:com.atproto.label.defs#label',
+                        },
+                    },
+                },
+            },
             profileAssociatedActivitySubscription: {
                 type: 'object',
                 required: ['allowSubscriptions'],
@@ -1059,6 +1104,49 @@ export const schemaDict = {
             },
         },
     },
+    AppBskyActorLink: {
+        lexicon: 1,
+        id: 'app.bsky.actor.link',
+        defs: {
+            main: {
+                type: 'record',
+                description: "A link shown on the account's profile. The profile record's links field sets which links are shown, and in what order.",
+                key: 'tid',
+                record: {
+                    type: 'object',
+                    required: ['url', 'createdAt'],
+                    properties: {
+                        url: {
+                            type: 'string',
+                            format: 'uri',
+                            description: 'The link destination, an https URL.',
+                        },
+                        title: {
+                            type: 'string',
+                            description: "Optional label for the link. Clients can fall back to the destination's domain.",
+                            maxGraphemes: 40,
+                            maxLength: 320,
+                        },
+                        icon: {
+                            type: 'blob',
+                            description: "The destination site's icon, uploaded when the link is saved.",
+                            accept: ['image/png', 'image/jpeg', 'image/webp'],
+                            maxSize: 100000,
+                        },
+                        createdAt: {
+                            type: 'string',
+                            format: 'datetime',
+                        },
+                        labels: {
+                            type: 'union',
+                            description: 'Self-label values for this link.',
+                            refs: ['lex:com.atproto.label.defs#selfLabels'],
+                        },
+                    },
+                },
+            },
+        },
+    },
     AppBskyActorProfile: {
         lexicon: 1,
         id: 'app.bsky.actor.profile',
@@ -1116,6 +1204,15 @@ export const schemaDict = {
                             type: 'ref',
                             ref: 'lex:com.atproto.repo.strongRef',
                         },
+                        links: {
+                            type: 'array',
+                            description: 'Links shown on the profile, in display order. Each ref points to an app.bsky.actor.link record in this repo.',
+                            maxLength: 10,
+                            items: {
+                                type: 'ref',
+                                ref: 'lex:com.atproto.repo.strongRef',
+                            },
+                        },
                         createdAt: {
                             type: 'string',
                             format: 'datetime',
@@ -3236,19 +3333,24 @@ export const schemaDict = {
         defs: {
             main: {
                 type: 'query',
-                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.",
+                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.",
                 parameters: {
                     type: 'params',
-                    required: ['url', 'uris'],
+                    required: ['url'],
                     properties: {
                         url: {
                             type: 'string',
                             format: 'uri',
-                            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.",
+                            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.",
+                        },
+                        canonicalUri: {
+                            type: 'string',
+                            format: 'at-uri',
+                            description: 'The canonical AT URI of the atproto record found on the webpage. When provided, takes precedence over `uris`, which is then ignored.',
                         },
                         uris: {
                             type: 'array',
-                            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.',
+                            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.",
                             items: {
                                 type: 'string',
                                 format: 'at-uri',
@@ -3265,7 +3367,7 @@ export const schemaDict = {
                             view: {
                                 type: 'ref',
                                 ref: 'lex:app.bsky.embed.external#view',
-                                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.',
+                                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.',
                             },
                             data: {
                                 type: 'union',
@@ -3275,7 +3377,7 @@ export const schemaDict = {
                                     'lex:app.bsky.embed.external#viewGallery',
                                     'lex:app.bsky.embed.external#viewLivestream',
                                 ],
-                                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.',
+                                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.',
                             },
                             associatedRefs: {
                                 type: 'array',
@@ -3283,13 +3385,28 @@ export const schemaDict = {
                                     type: 'ref',
                                     ref: 'lex:com.atproto.repo.strongRef',
                                 },
-                                description: "StrongRefs (URI+CID) of the Atmosphere records that backed this view, suitable for embedding into a post's external.associatedRefs.",
+                                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`.',
                             },
                             associatedRecords: {
                                 type: 'array',
                                 items: {
                                     type: 'unknown',
-                                    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.',
+                                    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.',
+                                },
+                            },
+                            unverifiedAssociatedRefs: {
+                                type: 'array',
+                                items: {
+                                    type: 'ref',
+                                    ref: 'lex:com.atproto.repo.strongRef',
+                                },
+                                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`.',
+                            },
+                            unverifiedAssociatedRecords: {
+                                type: 'array',
+                                items: {
+                                    type: 'unknown',
+                                    description: 'The raw record data of the persistence-selected Atmosphere records, index-aligned with `unverifiedAssociatedRefs`. Present only when validation failed.',
                                 },
                             },
                         },
@@ -7995,12 +8112,12 @@ export const schemaDict = {
                                 items: {
                                     type: 'union',
                                     refs: [
-                                        'lex:app.bsky.actor.defs#profileViewDetailed',
+                                        'lex:app.bsky.actor.defs#profileViewBasic',
                                         'lex:app.bsky.feed.defs#blockedPost',
                                         'lex:app.bsky.feed.defs#generatorView',
                                         'lex:app.bsky.feed.defs#notFoundPost',
                                         'lex:app.bsky.feed.defs#postView',
-                                        'lex:app.bsky.graph.defs#starterPackView',
+                                        'lex:app.bsky.graph.defs#starterPackViewBasic',
                                     ],
                                 },
                             },
@@ -8033,6 +8150,9 @@ export const schemaDict = {
                         refs: [
                             'lex:app.bsky.notification.getGroupedNotifications#likeGroup',
                             'lex:app.bsky.notification.getGroupedNotifications#multiPostLikeGroup',
+                            'lex:app.bsky.notification.getGroupedNotifications#multiPostRepostGroup',
+                            'lex:app.bsky.notification.getGroupedNotifications#multiPostLikeViaRepostGroup',
+                            'lex:app.bsky.notification.getGroupedNotifications#multiPostRepostViaRepostGroup',
                             'lex:app.bsky.notification.getGroupedNotifications#repostGroup',
                             'lex:app.bsky.notification.getGroupedNotifications#likeViaRepostGroup',
                             'lex:app.bsky.notification.getGroupedNotifications#repostViaRepostGroup',
@@ -8111,6 +8231,104 @@ export const schemaDict = {
                     },
                 },
             },
+            multiPostRepostGroup: {
+                type: 'object',
+                description: 'Group of reposts by the same actor of different posts.',
+                required: ['actor', 'items'],
+                properties: {
+                    actor: {
+                        type: 'string',
+                        format: 'did',
+                    },
+                    items: {
+                        type: 'array',
+                        minLength: 2,
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:app.bsky.notification.getGroupedNotifications#multiPostRepostItem',
+                        },
+                    },
+                },
+            },
+            multiPostRepostItem: {
+                type: 'object',
+                description: "One post which was reposted by the group's actor.",
+                required: ['post'],
+                properties: {
+                    post: {
+                        type: 'string',
+                        format: 'at-uri',
+                    },
+                },
+            },
+            multiPostLikeViaRepostGroup: {
+                type: 'object',
+                description: "Group of likes by the same actor on different posts via the requesting account's reposts.",
+                required: ['actor', 'items'],
+                properties: {
+                    actor: {
+                        type: 'string',
+                        format: 'did',
+                    },
+                    items: {
+                        type: 'array',
+                        minLength: 2,
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:app.bsky.notification.getGroupedNotifications#multiPostLikeViaRepostItem',
+                        },
+                    },
+                },
+            },
+            multiPostLikeViaRepostItem: {
+                type: 'object',
+                description: "One post which was liked by the group's actor via the requesting account's repost.",
+                required: ['post', 'viaRepost'],
+                properties: {
+                    post: {
+                        type: 'string',
+                        format: 'at-uri',
+                    },
+                    viaRepost: {
+                        type: 'string',
+                        format: 'at-uri',
+                    },
+                },
+            },
+            multiPostRepostViaRepostGroup: {
+                type: 'object',
+                description: "Group of reposts by the same actor of different posts via the requesting account's reposts.",
+                required: ['actor', 'items'],
+                properties: {
+                    actor: {
+                        type: 'string',
+                        format: 'did',
+                    },
+                    items: {
+                        type: 'array',
+                        minLength: 2,
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:app.bsky.notification.getGroupedNotifications#multiPostRepostViaRepostItem',
+                        },
+                    },
+                },
+            },
+            multiPostRepostViaRepostItem: {
+                type: 'object',
+                description: "One post which was reposted by the group's actor via the requesting account's repost.",
+                required: ['post', 'viaRepost'],
+                properties: {
+                    post: {
+                        type: 'string',
+                        format: 'at-uri',
+                    },
+                    viaRepost: {
+                        type: 'string',
+                        format: 'at-uri',
+                    },
+                },
+            },
             repostGroup: {
                 type: 'object',
                 description: 'Group of reposts by different actors of the same post.',
@@ -21538,10 +21756,20 @@ export const schemaDict = {
             },
             notificationPreferences: {
                 type: 'object',
-                required: ['push'],
+                description: 'Push notification preferences by moderation notification category. These preferences do not hide in-app inbox activity. Each category defaults to enabled.',
+                required: ['reports', 'account', 'labels'],
                 properties: {
-                    push: {
+                    reports: {
+                        type: 'boolean',
+                        description: 'Notify about outcomes of reports filed by the account (reportResolved and reportReopened).',
+                    },
+                    account: {
+                        type: 'boolean',
+                        description: 'Notify about moderation actions against the account or its content, action reversals, appeal outcomes, and standing changes. Label application and removal are controlled by labels.',
+                    },
+                    labels: {
                         type: 'boolean',
+                        description: 'Notify when labels are applied to or removed from the account or its content (labelApplied and labelRemoved actions).',
                     },
                 },
             },
@@ -21705,6 +21933,7 @@ export const schemaDict = {
         defs: {
             main: {
                 type: 'query',
+                description: 'Get moderation push notification preferences for report outcomes, account actions, and labeling. Returns all three categories, defaulting to enabled for an account without saved preferences.',
                 parameters: {
                     type: 'params',
                     properties: {
@@ -22188,14 +22417,23 @@ export const schemaDict = {
         defs: {
             main: {
                 type: 'procedure',
+                description: "Update the authenticated account's moderation push notification preferences. Only provided categories are updated; omitted categories retain their values. At least one category must be provided. Returns all three preferences. These preferences do not hide in-app inbox activity.",
                 input: {
                     encoding: 'application/json',
                     schema: {
                         type: 'object',
-                        required: ['push'],
                         properties: {
-                            push: {
+                            reports: {
+                                type: 'boolean',
+                                description: 'Notify about outcomes of reports filed by the account.',
+                            },
+                            account: {
+                                type: 'boolean',
+                                description: 'Notify about moderation actions against the account or its content, excluding labeling.',
+                            },
+                            labels: {
                                 type: 'boolean',
+                                description: 'Notify about labels applied to or removed from the account or its content.',
                             },
                         },
                     },
@@ -29053,6 +29291,7 @@ export const ids = {
     AppBskyActorGetProfile: 'app.bsky.actor.getProfile',
     AppBskyActorGetProfiles: 'app.bsky.actor.getProfiles',
     AppBskyActorGetSuggestions: 'app.bsky.actor.getSuggestions',
+    AppBskyActorLink: 'app.bsky.actor.link',
     AppBskyActorProfile: 'app.bsky.actor.profile',
     AppBskyActorPutPreferences: 'app.bsky.actor.putPreferences',
     AppBskyActorSearchActors: 'app.bsky.actor.searchActors',