@atproto/api 0.24.2 → 0.24.3

package/dist/client/lexicons.js

@@ -2837,6 +2837,318 @@ export const schemaDict = {
                     },
                 },
             },
+            viewArticle: {
+                type: 'object',
+                required: ['uri', 'title', 'description'],
+                properties: {
+                    uri: {
+                        type: 'string',
+                        format: 'uri',
+                    },
+                    title: {
+                        type: 'string',
+                    },
+                    description: {
+                        type: 'string',
+                    },
+                    createdAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    updatedAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    labels: {
+                        type: 'array',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:com.atproto.label.defs#label',
+                        },
+                    },
+                    associatedRefs: {
+                        type: 'array',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:com.atproto.repo.strongRef',
+                        },
+                    },
+                    associatedProfiles: {
+                        type: 'array',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:app.bsky.actor.defs#profileViewBasic',
+                        },
+                    },
+                    image: {
+                        type: 'string',
+                        format: 'uri',
+                    },
+                    publisher: {
+                        type: 'ref',
+                        ref: 'lex:app.bsky.embed.external#viewArticlePublication',
+                    },
+                    readingTime: {
+                        type: 'integer',
+                        minimum: 1,
+                    },
+                    likeCount: {
+                        type: 'integer',
+                        minimum: 0,
+                    },
+                    likers: {
+                        type: 'array',
+                        maxLength: 3,
+                        description: 'Available profile previews. Selected deterministically by DID; not a ranking.',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:app.bsky.actor.defs#profileViewBasic',
+                        },
+                    },
+                },
+            },
+            viewArticlePublication: {
+                type: 'object',
+                required: ['uri', 'title', 'description'],
+                properties: {
+                    uri: {
+                        type: 'string',
+                        format: 'uri',
+                    },
+                    title: {
+                        type: 'string',
+                    },
+                    description: {
+                        type: 'string',
+                    },
+                    createdAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    updatedAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    labels: {
+                        type: 'array',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:com.atproto.label.defs#label',
+                        },
+                    },
+                    associatedRefs: {
+                        type: 'array',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:com.atproto.repo.strongRef',
+                        },
+                    },
+                    associatedProfiles: {
+                        type: 'array',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:app.bsky.actor.defs#profileViewBasic',
+                        },
+                    },
+                    logo: {
+                        type: 'string',
+                        format: 'uri',
+                    },
+                    image: {
+                        type: 'string',
+                        format: 'uri',
+                    },
+                    theme: {
+                        type: 'ref',
+                        ref: 'lex:app.bsky.embed.external#viewArticlePublicationTheme',
+                    },
+                    subscriptionCount: {
+                        type: 'integer',
+                        minimum: 0,
+                    },
+                    subscribers: {
+                        type: 'array',
+                        maxLength: 3,
+                        description: 'Available profile previews. Selected deterministically by DID; not a ranking.',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:app.bsky.actor.defs#profileViewBasic',
+                        },
+                    },
+                },
+            },
+            viewArticlePublicationTheme: {
+                type: 'object',
+                properties: {
+                    background: {
+                        type: 'string',
+                        description: "Hex color string, if available. Example: '#ffffff'.",
+                    },
+                    foreground: {
+                        type: 'string',
+                        description: "Hex color string, if available. Example: '#ffffff'.",
+                    },
+                    accent: {
+                        type: 'string',
+                        description: "Hex color string, if available. Example: '#ffffff'.",
+                    },
+                    accentForeground: {
+                        type: 'string',
+                        description: "Hex color string, if available. Example: '#ffffff'.",
+                    },
+                },
+            },
+            viewGallery: {
+                type: 'object',
+                required: ['uri', 'title', 'description', 'items'],
+                properties: {
+                    uri: {
+                        type: 'string',
+                        format: 'uri',
+                    },
+                    title: {
+                        type: 'string',
+                    },
+                    description: {
+                        type: 'string',
+                    },
+                    createdAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    updatedAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    labels: {
+                        type: 'array',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:com.atproto.label.defs#label',
+                        },
+                    },
+                    associatedRefs: {
+                        type: 'array',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:com.atproto.repo.strongRef',
+                        },
+                    },
+                    associatedProfiles: {
+                        type: 'array',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:app.bsky.actor.defs#profileViewBasic',
+                        },
+                    },
+                    items: {
+                        type: 'array',
+                        items: {
+                            type: 'union',
+                            refs: ['lex:app.bsky.embed.external#viewGalleryImage'],
+                        },
+                        description: 'The media items in the gallery. Each item may be of a different type, but all types must be supported by the client.',
+                    },
+                    likeCount: {
+                        type: 'integer',
+                        minimum: 0,
+                    },
+                    likers: {
+                        type: 'array',
+                        maxLength: 3,
+                        description: 'Available profile previews. Selected deterministically by DID; not a ranking.',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:app.bsky.actor.defs#profileViewBasic',
+                        },
+                    },
+                },
+            },
+            viewGalleryImage: {
+                type: 'object',
+                required: ['thumbnail', 'fullsize'],
+                properties: {
+                    thumbnail: {
+                        type: 'string',
+                        format: 'uri',
+                        description: 'Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View.',
+                    },
+                    fullsize: {
+                        type: 'string',
+                        format: 'uri',
+                        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.',
+                    },
+                    alt: {
+                        type: 'string',
+                        description: 'Alt text description of the image, for accessibility.',
+                    },
+                    aspectRatio: {
+                        type: 'ref',
+                        ref: 'lex:app.bsky.embed.defs#aspectRatio',
+                    },
+                },
+            },
+            viewLivestream: {
+                type: 'object',
+                required: ['uri', 'title', 'description', 'active'],
+                properties: {
+                    uri: {
+                        type: 'string',
+                        format: 'uri',
+                    },
+                    title: {
+                        type: 'string',
+                    },
+                    description: {
+                        type: 'string',
+                    },
+                    createdAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    updatedAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    labels: {
+                        type: 'array',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:com.atproto.label.defs#label',
+                        },
+                    },
+                    associatedRefs: {
+                        type: 'array',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:com.atproto.repo.strongRef',
+                        },
+                    },
+                    associatedProfiles: {
+                        type: 'array',
+                        items: {
+                            type: 'ref',
+                            ref: 'lex:app.bsky.actor.defs#profileViewBasic',
+                        },
+                    },
+                    image: {
+                        type: 'string',
+                        format: 'uri',
+                    },
+                    active: {
+                        type: 'boolean',
+                        description: 'True if the livestream is currently active at the time this view is served, false if it has ended.',
+                    },
+                    startedAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                    endedAt: {
+                        type: 'string',
+                        format: 'datetime',
+                    },
+                },
+            },
         },
     },
     AppBskyEmbedGallery: {
@@ -2955,6 +3267,16 @@ export const schemaDict = {
                                 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.',
                             },
+                            data: {
+                                type: 'union',
+                                refs: [
+                                    'lex:app.bsky.embed.external#viewArticle',
+                                    'lex:app.bsky.embed.external#viewArticlePublication',
+                                    '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.',
+                            },
                             associatedRefs: {
                                 type: 'array',
                                 items: {
@@ -8935,6 +9257,223 @@ export const schemaDict = {
             },
         },
     },
+    AppBskyUnspeccedGetAtmosphereExploreTab: {
+        lexicon: 1,
+        id: 'app.bsky.unspecced.getAtmosphereExploreTab',
+        defs: {
+            main: {
+                type: 'query',
+                description: 'Get curated Atmosphere Explore content. Authentication is optional; authenticated requests include viewer-specific profile state.',
+                parameters: {
+                    type: 'params',
+                    properties: {
+                        langs: {
+                            type: 'array',
+                            description: 'Preferred languages. Currently ignored.',
+                            items: {
+                                type: 'string',
+                                format: 'language',
+                            },
+                        },
+                        countryCode: {
+                            type: 'string',
+                            description: 'The ISO 3166-1 alpha-2 country code used to select curated content.',
+                        },
+                        regionCode: {
+                            type: 'string',
+                            description: 'The ISO 3166-2 region code used to select curated content.',
+                        },
+                    },
+                },
+                output: {
+                    encoding: 'application/json',
+                    schema: {
+                        type: 'object',
+                        required: [
+                            'articles',
+                            'publications',
+                            'photos',
+                            'livestreams',
+                            'apps',
+                        ],
+                        properties: {
+                            announcementBanner: {
+                                type: 'ref',
+                                ref: 'lex:app.bsky.unspecced.getAtmosphereExploreTab#announcementBanner',
+                            },
+                            articles: {
+                                type: 'array',
+                                items: {
+                                    type: 'ref',
+                                    ref: 'lex:app.bsky.unspecced.getAtmosphereExploreTab#articleItem',
+                                },
+                            },
+                            publications: {
+                                type: 'array',
+                                items: {
+                                    type: 'ref',
+                                    ref: 'lex:app.bsky.unspecced.getAtmosphereExploreTab#publicationItem',
+                                },
+                            },
+                            photos: {
+                                type: 'array',
+                                items: {
+                                    type: 'ref',
+                                    ref: 'lex:app.bsky.unspecced.getAtmosphereExploreTab#galleryItem',
+                                },
+                            },
+                            livestreams: {
+                                type: 'array',
+                                items: {
+                                    type: 'ref',
+                                    ref: 'lex:app.bsky.unspecced.getAtmosphereExploreTab#livestreamItem',
+                                },
+                            },
+                            apps: {
+                                type: 'array',
+                                maxLength: 100,
+                                items: {
+                                    type: 'ref',
+                                    ref: 'lex:app.bsky.unspecced.getAtmosphereExploreTab#appCard',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            articleItem: {
+                type: 'object',
+                required: ['featured', 'view'],
+                properties: {
+                    featured: {
+                        type: 'boolean',
+                    },
+                    view: {
+                        type: 'ref',
+                        ref: 'lex:app.bsky.embed.external#viewArticle',
+                    },
+                },
+            },
+            publicationItem: {
+                type: 'object',
+                required: ['featured', 'view'],
+                properties: {
+                    featured: {
+                        type: 'boolean',
+                    },
+                    view: {
+                        type: 'ref',
+                        ref: 'lex:app.bsky.embed.external#viewArticlePublication',
+                    },
+                },
+            },
+            galleryItem: {
+                type: 'object',
+                required: ['featured', 'view'],
+                properties: {
+                    featured: {
+                        type: 'boolean',
+                    },
+                    view: {
+                        type: 'ref',
+                        ref: 'lex:app.bsky.embed.external#viewGallery',
+                    },
+                },
+            },
+            livestreamItem: {
+                type: 'object',
+                required: ['featured', 'view'],
+                properties: {
+                    featured: {
+                        type: 'boolean',
+                    },
+                    view: {
+                        type: 'ref',
+                        ref: 'lex:app.bsky.embed.external#viewLivestream',
+                    },
+                },
+            },
+            announcementBanner: {
+                type: 'object',
+                properties: {
+                    id: {
+                        type: 'string',
+                        maxLength: 4096,
+                    },
+                    title: {
+                        type: 'string',
+                        maxLength: 4096,
+                    },
+                    description: {
+                        type: 'string',
+                        maxLength: 4096,
+                    },
+                    url: {
+                        type: 'string',
+                        format: 'uri',
+                        maxLength: 4096,
+                    },
+                    image: {
+                        type: 'string',
+                        format: 'uri',
+                        maxLength: 4096,
+                    },
+                    overlayColor: {
+                        type: 'string',
+                        maxLength: 4096,
+                    },
+                    textColor: {
+                        type: 'string',
+                        maxLength: 4096,
+                    },
+                },
+            },
+            appCard: {
+                type: 'object',
+                properties: {
+                    id: {
+                        type: 'string',
+                        maxLength: 4096,
+                    },
+                    title: {
+                        type: 'string',
+                        maxLength: 4096,
+                    },
+                    description: {
+                        type: 'string',
+                        maxLength: 4096,
+                    },
+                    logo: {
+                        type: 'string',
+                        format: 'uri',
+                        maxLength: 4096,
+                    },
+                    backgroundImage: {
+                        type: 'string',
+                        format: 'uri',
+                        maxLength: 4096,
+                    },
+                    overlayColor: {
+                        type: 'string',
+                        maxLength: 4096,
+                    },
+                    textColor: {
+                        type: 'string',
+                        maxLength: 4096,
+                    },
+                    url: {
+                        type: 'string',
+                        format: 'uri',
+                        maxLength: 4096,
+                    },
+                    category: {
+                        type: 'string',
+                        maxLength: 4096,
+                    },
+                },
+            },
+        },
+    },
     AppBskyUnspeccedGetConfig: {
         lexicon: 1,
         id: 'app.bsky.unspecced.getConfig',
@@ -28627,6 +29166,7 @@ export const ids = {
     AppBskyRichtextFacet: 'app.bsky.richtext.facet',
     AppBskyUnspeccedDefs: 'app.bsky.unspecced.defs',
     AppBskyUnspeccedGetAgeAssuranceState: 'app.bsky.unspecced.getAgeAssuranceState',
+    AppBskyUnspeccedGetAtmosphereExploreTab: 'app.bsky.unspecced.getAtmosphereExploreTab',
     AppBskyUnspeccedGetConfig: 'app.bsky.unspecced.getConfig',
     AppBskyUnspeccedGetOnboardingSuggestedStarterPacks: 'app.bsky.unspecced.getOnboardingSuggestedStarterPacks',
     AppBskyUnspeccedGetOnboardingSuggestedStarterPacksSkeleton: 'app.bsky.unspecced.getOnboardingSuggestedStarterPacksSkeleton',