@atproto/api 0.20.1 → 0.20.3

package/dist/client/lexicons.d.ts

@@ -2509,13 +2509,13 @@ export declare const schemaDict: {
                         readonly accept: ["image/*"];
                         readonly maxSize: 1000000;
                     };
-                    readonly associatedRecords: {
+                    readonly associatedRefs: {
                         readonly type: "array";
                         readonly items: {
                             readonly type: "ref";
                             readonly ref: "lex:com.atproto.repo.strongRef";
                         };
-                        readonly description: "The URI of the Atmosphere record representing this external content, if it exists. Example: a site.standard.document record.";
+                        readonly description: "StrongRefs (uri+cid) of the Atmosphere records that backed this view.";
                     };
                 };
             };
@@ -2547,6 +2547,168 @@ export declare const schemaDict: {
                         readonly type: "string";
                         readonly format: "uri";
                     };
+                    readonly createdAt: {
+                        readonly type: "string";
+                        readonly format: "datetime";
+                        readonly description: "When the external content was created, if available. Example: a publication date, for an article.";
+                    };
+                    readonly updatedAt: {
+                        readonly type: "string";
+                        readonly format: "datetime";
+                        readonly description: "When the external content was updated, if available.";
+                    };
+                    readonly readingTime: {
+                        readonly type: "integer";
+                        readonly description: "Estimated reading time in minutes, if applicable and available.";
+                    };
+                    readonly labels: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "ref";
+                            readonly ref: "lex:com.atproto.label.defs#label";
+                        };
+                    };
+                    readonly source: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.embed.external#viewExternalSource";
+                    };
+                    readonly associatedRefs: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "ref";
+                            readonly ref: "lex:com.atproto.repo.strongRef";
+                        };
+                        readonly description: "StrongRefs (uri+cid) of the Atmosphere records that backed this view.";
+                    };
+                };
+            };
+            readonly viewExternalSource: {
+                readonly type: "object";
+                readonly description: "The source of an external embed, such as a standard.site publication.";
+                readonly required: ["uri", "title"];
+                readonly properties: {
+                    readonly uri: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly description: "URI of the source, if available. Example: the https:// URL of a site.standard.publication record.";
+                    };
+                    readonly icon: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly description: "Fully-qualified URL where an icon representing the source can be fetched. For example, CDN location provided by the App View.";
+                    };
+                    readonly title: {
+                        readonly type: "string";
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                    };
+                    readonly theme: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.embed.external#viewExternalSourceTheme";
+                    };
+                };
+            };
+            readonly viewExternalSourceTheme: {
+                readonly type: "object";
+                readonly description: "The theme colors of an external source, such as a site.standard.publication. These colors may be used when rendering an embed from that source.";
+                readonly properties: {
+                    readonly backgroundRGB: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.embed.external#colorRGB";
+                    };
+                    readonly foregroundRGB: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.embed.external#colorRGB";
+                    };
+                    readonly accentRGB: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.embed.external#colorRGB";
+                    };
+                    readonly accentForegroundRGB: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.embed.external#colorRGB";
+                    };
+                };
+            };
+            readonly colorRGB: {
+                readonly type: "object";
+                readonly description: "RGB color definition, inspired by site.standard.theme.color#rgb";
+                readonly required: ["r", "g", "b"];
+                readonly properties: {
+                    readonly r: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly maximum: 255;
+                    };
+                    readonly g: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly maximum: 255;
+                    };
+                    readonly b: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly maximum: 255;
+                    };
+                };
+            };
+        };
+    };
+    readonly AppBskyEmbedGetEmbedExternalView: {
+        readonly lexicon: 1;
+        readonly id: "app.bsky.embed.getEmbedExternalView";
+        readonly defs: {
+            readonly main: {
+                readonly type: "query";
+                readonly 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.";
+                readonly parameters: {
+                    readonly type: "params";
+                    readonly required: ["url", "uris"];
+                    readonly properties: {
+                        readonly url: {
+                            readonly type: "string";
+                            readonly format: "uri";
+                            readonly 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.";
+                        };
+                        readonly uris: {
+                            readonly type: "array";
+                            readonly 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.";
+                            readonly items: {
+                                readonly type: "string";
+                                readonly format: "at-uri";
+                            };
+                            readonly maxLength: 4;
+                        };
+                    };
+                };
+                readonly output: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly view: {
+                                readonly type: "ref";
+                                readonly ref: "lex:app.bsky.embed.external#view";
+                                readonly 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.";
+                            };
+                            readonly associatedRefs: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "ref";
+                                    readonly ref: "lex:com.atproto.repo.strongRef";
+                                };
+                                readonly description: "StrongRefs (URI+CID) of the Atmosphere records that backed this view, suitable for embedding into a post's external.associatedRefs.";
+                            };
+                            readonly associatedRecords: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "unknown";
+                                    readonly 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.";
+                                };
+                            };
+                        };
+                    };
                 };
             };
         };
@@ -9181,6 +9343,33 @@ export declare const schemaDict: {
             };
         };
     };
+    readonly ChatBskyActorGetStatus: {
+        readonly lexicon: 1;
+        readonly id: "chat.bsky.actor.getStatus";
+        readonly defs: {
+            readonly main: {
+                readonly type: "query";
+                readonly description: "Get the authenticated viewer's chat status: whether their account is chat-disabled and whether their group-membership additions are restricted to accounts they follow.";
+                readonly output: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly required: ["chatDisabled", "canCreateGroups"];
+                        readonly properties: {
+                            readonly chatDisabled: {
+                                readonly type: "boolean";
+                                readonly description: "True when the viewer's account is disabled and cannot actively participate in chat.";
+                            };
+                            readonly canCreateGroups: {
+                                readonly type: "boolean";
+                                readonly description: "Whether the viewer's account is allowed to create group chats. New accounts are restricted from creating groups.";
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
     readonly ChatBskyConvoAcceptConvo: {
         readonly lexicon: 1;
         readonly id: "chat.bsky.convo.acceptConvo";
@@ -11110,8 +11299,6 @@ export declare const schemaDict: {
                     readonly name: "AccountSuspended";
                 }, {
                     readonly name: "BlockedActor";
-                }, {
-                    readonly name: "UserForbidsGroups";
                 }, {
                     readonly name: "ConvoLocked";
                 }, {
@@ -11124,6 +11311,8 @@ export declare const schemaDict: {
                     readonly name: "NotFollowedBySender";
                 }, {
                     readonly name: "RecipientNotFound";
+                }, {
+                    readonly name: "UserForbidsGroups";
                 }];
                 readonly input: {
                     readonly encoding: "application/json";
@@ -11226,11 +11415,13 @@ export declare const schemaDict: {
                 }, {
                     readonly name: "BlockedActor";
                 }, {
-                    readonly name: "UserForbidsGroups";
+                    readonly name: "NewAccountCannotCreateGroup";
                 }, {
                     readonly name: "NotFollowedBySender";
                 }, {
                     readonly name: "RecipientNotFound";
+                }, {
+                    readonly name: "UserForbidsGroups";
                 }];
                 readonly input: {
                     readonly encoding: "application/json";
@@ -25578,13 +25769,13 @@ export declare const schemas: ({
                     readonly accept: ["image/*"];
                     readonly maxSize: 1000000;
                 };
-                readonly associatedRecords: {
+                readonly associatedRefs: {
                     readonly type: "array";
                     readonly items: {
                         readonly type: "ref";
                         readonly ref: "lex:com.atproto.repo.strongRef";
                     };
-                    readonly description: "The URI of the Atmosphere record representing this external content, if it exists. Example: a site.standard.document record.";
+                    readonly description: "StrongRefs (uri+cid) of the Atmosphere records that backed this view.";
                 };
             };
         };
@@ -25616,6 +25807,167 @@ export declare const schemas: ({
                     readonly type: "string";
                     readonly format: "uri";
                 };
+                readonly createdAt: {
+                    readonly type: "string";
+                    readonly format: "datetime";
+                    readonly description: "When the external content was created, if available. Example: a publication date, for an article.";
+                };
+                readonly updatedAt: {
+                    readonly type: "string";
+                    readonly format: "datetime";
+                    readonly description: "When the external content was updated, if available.";
+                };
+                readonly readingTime: {
+                    readonly type: "integer";
+                    readonly description: "Estimated reading time in minutes, if applicable and available.";
+                };
+                readonly labels: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "ref";
+                        readonly ref: "lex:com.atproto.label.defs#label";
+                    };
+                };
+                readonly source: {
+                    readonly type: "ref";
+                    readonly ref: "lex:app.bsky.embed.external#viewExternalSource";
+                };
+                readonly associatedRefs: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "ref";
+                        readonly ref: "lex:com.atproto.repo.strongRef";
+                    };
+                    readonly description: "StrongRefs (uri+cid) of the Atmosphere records that backed this view.";
+                };
+            };
+        };
+        readonly viewExternalSource: {
+            readonly type: "object";
+            readonly description: "The source of an external embed, such as a standard.site publication.";
+            readonly required: ["uri", "title"];
+            readonly properties: {
+                readonly uri: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly description: "URI of the source, if available. Example: the https:// URL of a site.standard.publication record.";
+                };
+                readonly icon: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly description: "Fully-qualified URL where an icon representing the source can be fetched. For example, CDN location provided by the App View.";
+                };
+                readonly title: {
+                    readonly type: "string";
+                };
+                readonly description: {
+                    readonly type: "string";
+                };
+                readonly theme: {
+                    readonly type: "ref";
+                    readonly ref: "lex:app.bsky.embed.external#viewExternalSourceTheme";
+                };
+            };
+        };
+        readonly viewExternalSourceTheme: {
+            readonly type: "object";
+            readonly description: "The theme colors of an external source, such as a site.standard.publication. These colors may be used when rendering an embed from that source.";
+            readonly properties: {
+                readonly backgroundRGB: {
+                    readonly type: "ref";
+                    readonly ref: "lex:app.bsky.embed.external#colorRGB";
+                };
+                readonly foregroundRGB: {
+                    readonly type: "ref";
+                    readonly ref: "lex:app.bsky.embed.external#colorRGB";
+                };
+                readonly accentRGB: {
+                    readonly type: "ref";
+                    readonly ref: "lex:app.bsky.embed.external#colorRGB";
+                };
+                readonly accentForegroundRGB: {
+                    readonly type: "ref";
+                    readonly ref: "lex:app.bsky.embed.external#colorRGB";
+                };
+            };
+        };
+        readonly colorRGB: {
+            readonly type: "object";
+            readonly description: "RGB color definition, inspired by site.standard.theme.color#rgb";
+            readonly required: ["r", "g", "b"];
+            readonly properties: {
+                readonly r: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly maximum: 255;
+                };
+                readonly g: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly maximum: 255;
+                };
+                readonly b: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly maximum: 255;
+                };
+            };
+        };
+    };
+} | {
+    readonly lexicon: 1;
+    readonly id: "app.bsky.embed.getEmbedExternalView";
+    readonly defs: {
+        readonly main: {
+            readonly type: "query";
+            readonly 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.";
+            readonly parameters: {
+                readonly type: "params";
+                readonly required: ["url", "uris"];
+                readonly properties: {
+                    readonly url: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly 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.";
+                    };
+                    readonly uris: {
+                        readonly type: "array";
+                        readonly 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.";
+                        readonly items: {
+                            readonly type: "string";
+                            readonly format: "at-uri";
+                        };
+                        readonly maxLength: 4;
+                    };
+                };
+            };
+            readonly output: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly view: {
+                            readonly type: "ref";
+                            readonly ref: "lex:app.bsky.embed.external#view";
+                            readonly 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.";
+                        };
+                        readonly associatedRefs: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "ref";
+                                readonly ref: "lex:com.atproto.repo.strongRef";
+                            };
+                            readonly description: "StrongRefs (URI+CID) of the Atmosphere records that backed this view, suitable for embedding into a post's external.associatedRefs.";
+                        };
+                        readonly associatedRecords: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "unknown";
+                                readonly 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.";
+                            };
+                        };
+                    };
+                };
             };
         };
     };
@@ -32134,6 +32486,32 @@ export declare const schemas: ({
             };
         };
     };
+} | {
+    readonly lexicon: 1;
+    readonly id: "chat.bsky.actor.getStatus";
+    readonly defs: {
+        readonly main: {
+            readonly type: "query";
+            readonly description: "Get the authenticated viewer's chat status: whether their account is chat-disabled and whether their group-membership additions are restricted to accounts they follow.";
+            readonly output: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly required: ["chatDisabled", "canCreateGroups"];
+                    readonly properties: {
+                        readonly chatDisabled: {
+                            readonly type: "boolean";
+                            readonly description: "True when the viewer's account is disabled and cannot actively participate in chat.";
+                        };
+                        readonly canCreateGroups: {
+                            readonly type: "boolean";
+                            readonly description: "Whether the viewer's account is allowed to create group chats. New accounts are restricted from creating groups.";
+                        };
+                    };
+                };
+            };
+        };
+    };
 } | {
     readonly lexicon: 1;
     readonly id: "chat.bsky.convo.acceptConvo";
@@ -34041,8 +34419,6 @@ export declare const schemas: ({
                 readonly name: "AccountSuspended";
             }, {
                 readonly name: "BlockedActor";
-            }, {
-                readonly name: "UserForbidsGroups";
             }, {
                 readonly name: "ConvoLocked";
             }, {
@@ -34055,6 +34431,8 @@ export declare const schemas: ({
                 readonly name: "NotFollowedBySender";
             }, {
                 readonly name: "RecipientNotFound";
+            }, {
+                readonly name: "UserForbidsGroups";
             }];
             readonly input: {
                 readonly encoding: "application/json";
@@ -34155,11 +34533,13 @@ export declare const schemas: ({
             }, {
                 readonly name: "BlockedActor";
             }, {
-                readonly name: "UserForbidsGroups";
+                readonly name: "NewAccountCannotCreateGroup";
             }, {
                 readonly name: "NotFollowedBySender";
             }, {
                 readonly name: "RecipientNotFound";
+            }, {
+                readonly name: "UserForbidsGroups";
             }];
             readonly input: {
                 readonly encoding: "application/json";
@@ -45888,6 +46268,7 @@ export declare const ids: {
     readonly AppBskyDraftUpdateDraft: "app.bsky.draft.updateDraft";
     readonly AppBskyEmbedDefs: "app.bsky.embed.defs";
     readonly AppBskyEmbedExternal: "app.bsky.embed.external";
+    readonly AppBskyEmbedGetEmbedExternalView: "app.bsky.embed.getEmbedExternalView";
     readonly AppBskyEmbedImages: "app.bsky.embed.images";
     readonly AppBskyEmbedRecord: "app.bsky.embed.record";
     readonly AppBskyEmbedRecordWithMedia: "app.bsky.embed.recordWithMedia";
@@ -46003,6 +46384,7 @@ export declare const ids: {
     readonly ChatBskyActorDefs: "chat.bsky.actor.defs";
     readonly ChatBskyActorDeleteAccount: "chat.bsky.actor.deleteAccount";
     readonly ChatBskyActorExportAccountData: "chat.bsky.actor.exportAccountData";
+    readonly ChatBskyActorGetStatus: "chat.bsky.actor.getStatus";
     readonly ChatBskyConvoAcceptConvo: "chat.bsky.convo.acceptConvo";
     readonly ChatBskyConvoAddReaction: "chat.bsky.convo.addReaction";
     readonly ChatBskyConvoDefs: "chat.bsky.convo.defs";