@atproto/api 0.18.15 → 0.18.16

package/dist/client/lexicons.d.ts

@@ -2058,6 +2058,359 @@ export declare const schemaDict: {
             };
         };
     };
+    readonly AppBskyDraftCreateDraft: {
+        readonly lexicon: 1;
+        readonly id: "app.bsky.draft.createDraft";
+        readonly defs: {
+            readonly main: {
+                readonly type: "procedure";
+                readonly description: "Inserts a draft using private storage (stash). An upper limit of drafts might be enforced. Requires authentication.";
+                readonly input: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly required: ["draft"];
+                        readonly properties: {
+                            readonly draft: {
+                                readonly type: "ref";
+                                readonly ref: "lex:app.bsky.draft.defs#draft";
+                            };
+                        };
+                    };
+                };
+                readonly output: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly required: ["id"];
+                        readonly properties: {
+                            readonly id: {
+                                readonly type: "string";
+                                readonly description: "The ID of the created draft.";
+                            };
+                        };
+                    };
+                };
+                readonly errors: [{
+                    readonly name: "DraftLimitReached";
+                    readonly description: "Trying to insert a new draft when the limit was already reached.";
+                }];
+            };
+        };
+    };
+    readonly AppBskyDraftDefs: {
+        readonly lexicon: 1;
+        readonly id: "app.bsky.draft.defs";
+        readonly defs: {
+            readonly draftWithId: {
+                readonly description: "A draft with an identifier, used to store drafts in private storage (stash).";
+                readonly type: "object";
+                readonly required: ["id", "draft"];
+                readonly properties: {
+                    readonly id: {
+                        readonly description: "A TID to be used as a draft identifier.";
+                        readonly type: "string";
+                        readonly format: "tid";
+                    };
+                    readonly draft: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.draft.defs#draft";
+                    };
+                };
+            };
+            readonly draft: {
+                readonly description: "A draft containing an array of draft posts.";
+                readonly type: "object";
+                readonly required: ["posts"];
+                readonly properties: {
+                    readonly posts: {
+                        readonly description: "Array of draft posts that compose this draft.";
+                        readonly type: "array";
+                        readonly minLength: 1;
+                        readonly maxLength: 100;
+                        readonly items: {
+                            readonly type: "ref";
+                            readonly ref: "lex:app.bsky.draft.defs#draftPost";
+                        };
+                    };
+                    readonly langs: {
+                        readonly type: "array";
+                        readonly description: "Indicates human language of posts primary text content.";
+                        readonly maxLength: 3;
+                        readonly items: {
+                            readonly type: "string";
+                            readonly format: "language";
+                        };
+                    };
+                    readonly postgateEmbeddingRules: {
+                        readonly description: "Embedding rules for the postgates to be created when this draft is published.";
+                        readonly type: "array";
+                        readonly maxLength: 5;
+                        readonly items: {
+                            readonly type: "union";
+                            readonly refs: ["lex:app.bsky.feed.postgate#disableRule"];
+                        };
+                    };
+                    readonly threadgateAllow: {
+                        readonly description: "Allow-rules for the threadgate to be created when this draft is published.";
+                        readonly type: "array";
+                        readonly maxLength: 5;
+                        readonly items: {
+                            readonly type: "union";
+                            readonly refs: ["lex:app.bsky.feed.threadgate#mentionRule", "lex:app.bsky.feed.threadgate#followerRule", "lex:app.bsky.feed.threadgate#followingRule", "lex:app.bsky.feed.threadgate#listRule"];
+                        };
+                    };
+                };
+            };
+            readonly draftPost: {
+                readonly description: "One of the posts that compose a draft.";
+                readonly type: "object";
+                readonly required: ["text"];
+                readonly properties: {
+                    readonly text: {
+                        readonly type: "string";
+                        readonly maxLength: 3000;
+                        readonly maxGraphemes: 300;
+                        readonly description: "The primary post content.";
+                    };
+                    readonly labels: {
+                        readonly type: "union";
+                        readonly description: "Self-label values for this post. Effectively content warnings.";
+                        readonly refs: ["lex:com.atproto.label.defs#selfLabels"];
+                    };
+                    readonly embedImages: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "ref";
+                            readonly ref: "lex:app.bsky.draft.defs#draftEmbedImage";
+                        };
+                        readonly maxLength: 4;
+                    };
+                    readonly embedVideos: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "ref";
+                            readonly ref: "lex:app.bsky.draft.defs#draftEmbedVideo";
+                        };
+                        readonly maxLength: 1;
+                    };
+                    readonly embedExternals: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "ref";
+                            readonly ref: "lex:app.bsky.draft.defs#draftEmbedExternal";
+                        };
+                        readonly maxLength: 1;
+                    };
+                    readonly embedRecords: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "ref";
+                            readonly ref: "lex:app.bsky.draft.defs#draftEmbedRecord";
+                        };
+                        readonly maxLength: 1;
+                    };
+                };
+            };
+            readonly draftView: {
+                readonly description: "View to present drafts data to users.";
+                readonly type: "object";
+                readonly required: ["id", "draft", "createdAt", "updatedAt"];
+                readonly properties: {
+                    readonly id: {
+                        readonly description: "A TID to be used as a draft identifier.";
+                        readonly type: "string";
+                        readonly format: "tid";
+                    };
+                    readonly draft: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.draft.defs#draft";
+                    };
+                    readonly createdAt: {
+                        readonly description: "The time the draft was created.";
+                        readonly type: "string";
+                        readonly format: "datetime";
+                    };
+                    readonly updatedAt: {
+                        readonly description: "The time the draft was last updated.";
+                        readonly type: "string";
+                        readonly format: "datetime";
+                    };
+                };
+            };
+            readonly draftEmbedLocalRef: {
+                readonly type: "object";
+                readonly required: ["path"];
+                readonly properties: {
+                    readonly path: {
+                        readonly type: "string";
+                        readonly description: "Local, on-device ref to file to be embedded. Embeds are currently device-bound for drafts.";
+                        readonly minLength: 1;
+                        readonly maxLength: 1024;
+                    };
+                };
+            };
+            readonly draftEmbedCaption: {
+                readonly type: "object";
+                readonly required: ["lang", "content"];
+                readonly properties: {
+                    readonly lang: {
+                        readonly type: "string";
+                        readonly format: "language";
+                    };
+                    readonly content: {
+                        readonly type: "string";
+                        readonly maxLength: 10000;
+                    };
+                };
+            };
+            readonly draftEmbedImage: {
+                readonly type: "object";
+                readonly required: ["localRef"];
+                readonly properties: {
+                    readonly localRef: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.draft.defs#draftEmbedLocalRef";
+                    };
+                    readonly alt: {
+                        readonly type: "string";
+                        readonly maxGraphemes: 2000;
+                    };
+                };
+            };
+            readonly draftEmbedVideo: {
+                readonly type: "object";
+                readonly required: ["localRef"];
+                readonly properties: {
+                    readonly localRef: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.draft.defs#draftEmbedLocalRef";
+                    };
+                    readonly alt: {
+                        readonly type: "string";
+                        readonly maxGraphemes: 2000;
+                    };
+                    readonly captions: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "ref";
+                            readonly ref: "lex:app.bsky.draft.defs#draftEmbedCaption";
+                        };
+                        readonly maxLength: 20;
+                    };
+                };
+            };
+            readonly draftEmbedExternal: {
+                readonly type: "object";
+                readonly required: ["uri"];
+                readonly properties: {
+                    readonly uri: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                    };
+                };
+            };
+            readonly draftEmbedRecord: {
+                readonly type: "object";
+                readonly required: ["record"];
+                readonly properties: {
+                    readonly record: {
+                        readonly type: "ref";
+                        readonly ref: "lex:com.atproto.repo.strongRef";
+                    };
+                };
+            };
+        };
+    };
+    readonly AppBskyDraftDeleteDraft: {
+        readonly lexicon: 1;
+        readonly id: "app.bsky.draft.deleteDraft";
+        readonly defs: {
+            readonly main: {
+                readonly type: "procedure";
+                readonly description: "Deletes a draft by ID. Requires authentication.";
+                readonly input: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly required: ["id"];
+                        readonly properties: {
+                            readonly id: {
+                                readonly type: "string";
+                                readonly format: "tid";
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+    readonly AppBskyDraftGetDrafts: {
+        readonly lexicon: 1;
+        readonly id: "app.bsky.draft.getDrafts";
+        readonly defs: {
+            readonly main: {
+                readonly type: "query";
+                readonly description: "Gets views of user drafts. Requires authentication.";
+                readonly parameters: {
+                    readonly type: "params";
+                    readonly properties: {
+                        readonly limit: {
+                            readonly type: "integer";
+                            readonly minimum: 1;
+                            readonly maximum: 100;
+                            readonly default: 50;
+                        };
+                        readonly cursor: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+                readonly output: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly required: ["drafts"];
+                        readonly properties: {
+                            readonly cursor: {
+                                readonly type: "string";
+                            };
+                            readonly drafts: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "ref";
+                                    readonly ref: "lex:app.bsky.draft.defs#draftView";
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+    readonly AppBskyDraftUpdateDraft: {
+        readonly lexicon: 1;
+        readonly id: "app.bsky.draft.updateDraft";
+        readonly defs: {
+            readonly main: {
+                readonly type: "procedure";
+                readonly description: "Updates a draft using private storage (stash). If the draft ID points to a non-existing ID, the update will be silently ignored. This is done because updates don't enforce draft limit, so it accepts all writes, but will ignore invalid ones. Requires authentication.";
+                readonly input: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly required: ["draft"];
+                        readonly properties: {
+                            readonly draft: {
+                                readonly type: "ref";
+                                readonly ref: "lex:app.bsky.draft.defs#draftWithId";
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
     readonly AppBskyEmbedDefs: {
         readonly lexicon: 1;
         readonly id: "app.bsky.embed.defs";
@@ -20448,6 +20801,354 @@ export declare const schemas: ({
             }];
         };
     };
+} | {
+    readonly lexicon: 1;
+    readonly id: "app.bsky.draft.createDraft";
+    readonly defs: {
+        readonly main: {
+            readonly type: "procedure";
+            readonly description: "Inserts a draft using private storage (stash). An upper limit of drafts might be enforced. Requires authentication.";
+            readonly input: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly required: ["draft"];
+                    readonly properties: {
+                        readonly draft: {
+                            readonly type: "ref";
+                            readonly ref: "lex:app.bsky.draft.defs#draft";
+                        };
+                    };
+                };
+            };
+            readonly output: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly required: ["id"];
+                    readonly properties: {
+                        readonly id: {
+                            readonly type: "string";
+                            readonly description: "The ID of the created draft.";
+                        };
+                    };
+                };
+            };
+            readonly errors: [{
+                readonly name: "DraftLimitReached";
+                readonly description: "Trying to insert a new draft when the limit was already reached.";
+            }];
+        };
+    };
+} | {
+    readonly lexicon: 1;
+    readonly id: "app.bsky.draft.defs";
+    readonly defs: {
+        readonly draftWithId: {
+            readonly description: "A draft with an identifier, used to store drafts in private storage (stash).";
+            readonly type: "object";
+            readonly required: ["id", "draft"];
+            readonly properties: {
+                readonly id: {
+                    readonly description: "A TID to be used as a draft identifier.";
+                    readonly type: "string";
+                    readonly format: "tid";
+                };
+                readonly draft: {
+                    readonly type: "ref";
+                    readonly ref: "lex:app.bsky.draft.defs#draft";
+                };
+            };
+        };
+        readonly draft: {
+            readonly description: "A draft containing an array of draft posts.";
+            readonly type: "object";
+            readonly required: ["posts"];
+            readonly properties: {
+                readonly posts: {
+                    readonly description: "Array of draft posts that compose this draft.";
+                    readonly type: "array";
+                    readonly minLength: 1;
+                    readonly maxLength: 100;
+                    readonly items: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.draft.defs#draftPost";
+                    };
+                };
+                readonly langs: {
+                    readonly type: "array";
+                    readonly description: "Indicates human language of posts primary text content.";
+                    readonly maxLength: 3;
+                    readonly items: {
+                        readonly type: "string";
+                        readonly format: "language";
+                    };
+                };
+                readonly postgateEmbeddingRules: {
+                    readonly description: "Embedding rules for the postgates to be created when this draft is published.";
+                    readonly type: "array";
+                    readonly maxLength: 5;
+                    readonly items: {
+                        readonly type: "union";
+                        readonly refs: ["lex:app.bsky.feed.postgate#disableRule"];
+                    };
+                };
+                readonly threadgateAllow: {
+                    readonly description: "Allow-rules for the threadgate to be created when this draft is published.";
+                    readonly type: "array";
+                    readonly maxLength: 5;
+                    readonly items: {
+                        readonly type: "union";
+                        readonly refs: ["lex:app.bsky.feed.threadgate#mentionRule", "lex:app.bsky.feed.threadgate#followerRule", "lex:app.bsky.feed.threadgate#followingRule", "lex:app.bsky.feed.threadgate#listRule"];
+                    };
+                };
+            };
+        };
+        readonly draftPost: {
+            readonly description: "One of the posts that compose a draft.";
+            readonly type: "object";
+            readonly required: ["text"];
+            readonly properties: {
+                readonly text: {
+                    readonly type: "string";
+                    readonly maxLength: 3000;
+                    readonly maxGraphemes: 300;
+                    readonly description: "The primary post content.";
+                };
+                readonly labels: {
+                    readonly type: "union";
+                    readonly description: "Self-label values for this post. Effectively content warnings.";
+                    readonly refs: ["lex:com.atproto.label.defs#selfLabels"];
+                };
+                readonly embedImages: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.draft.defs#draftEmbedImage";
+                    };
+                    readonly maxLength: 4;
+                };
+                readonly embedVideos: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.draft.defs#draftEmbedVideo";
+                    };
+                    readonly maxLength: 1;
+                };
+                readonly embedExternals: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.draft.defs#draftEmbedExternal";
+                    };
+                    readonly maxLength: 1;
+                };
+                readonly embedRecords: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.draft.defs#draftEmbedRecord";
+                    };
+                    readonly maxLength: 1;
+                };
+            };
+        };
+        readonly draftView: {
+            readonly description: "View to present drafts data to users.";
+            readonly type: "object";
+            readonly required: ["id", "draft", "createdAt", "updatedAt"];
+            readonly properties: {
+                readonly id: {
+                    readonly description: "A TID to be used as a draft identifier.";
+                    readonly type: "string";
+                    readonly format: "tid";
+                };
+                readonly draft: {
+                    readonly type: "ref";
+                    readonly ref: "lex:app.bsky.draft.defs#draft";
+                };
+                readonly createdAt: {
+                    readonly description: "The time the draft was created.";
+                    readonly type: "string";
+                    readonly format: "datetime";
+                };
+                readonly updatedAt: {
+                    readonly description: "The time the draft was last updated.";
+                    readonly type: "string";
+                    readonly format: "datetime";
+                };
+            };
+        };
+        readonly draftEmbedLocalRef: {
+            readonly type: "object";
+            readonly required: ["path"];
+            readonly properties: {
+                readonly path: {
+                    readonly type: "string";
+                    readonly description: "Local, on-device ref to file to be embedded. Embeds are currently device-bound for drafts.";
+                    readonly minLength: 1;
+                    readonly maxLength: 1024;
+                };
+            };
+        };
+        readonly draftEmbedCaption: {
+            readonly type: "object";
+            readonly required: ["lang", "content"];
+            readonly properties: {
+                readonly lang: {
+                    readonly type: "string";
+                    readonly format: "language";
+                };
+                readonly content: {
+                    readonly type: "string";
+                    readonly maxLength: 10000;
+                };
+            };
+        };
+        readonly draftEmbedImage: {
+            readonly type: "object";
+            readonly required: ["localRef"];
+            readonly properties: {
+                readonly localRef: {
+                    readonly type: "ref";
+                    readonly ref: "lex:app.bsky.draft.defs#draftEmbedLocalRef";
+                };
+                readonly alt: {
+                    readonly type: "string";
+                    readonly maxGraphemes: 2000;
+                };
+            };
+        };
+        readonly draftEmbedVideo: {
+            readonly type: "object";
+            readonly required: ["localRef"];
+            readonly properties: {
+                readonly localRef: {
+                    readonly type: "ref";
+                    readonly ref: "lex:app.bsky.draft.defs#draftEmbedLocalRef";
+                };
+                readonly alt: {
+                    readonly type: "string";
+                    readonly maxGraphemes: 2000;
+                };
+                readonly captions: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.draft.defs#draftEmbedCaption";
+                    };
+                    readonly maxLength: 20;
+                };
+            };
+        };
+        readonly draftEmbedExternal: {
+            readonly type: "object";
+            readonly required: ["uri"];
+            readonly properties: {
+                readonly uri: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                };
+            };
+        };
+        readonly draftEmbedRecord: {
+            readonly type: "object";
+            readonly required: ["record"];
+            readonly properties: {
+                readonly record: {
+                    readonly type: "ref";
+                    readonly ref: "lex:com.atproto.repo.strongRef";
+                };
+            };
+        };
+    };
+} | {
+    readonly lexicon: 1;
+    readonly id: "app.bsky.draft.deleteDraft";
+    readonly defs: {
+        readonly main: {
+            readonly type: "procedure";
+            readonly description: "Deletes a draft by ID. Requires authentication.";
+            readonly input: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly required: ["id"];
+                    readonly properties: {
+                        readonly id: {
+                            readonly type: "string";
+                            readonly format: "tid";
+                        };
+                    };
+                };
+            };
+        };
+    };
+} | {
+    readonly lexicon: 1;
+    readonly id: "app.bsky.draft.getDrafts";
+    readonly defs: {
+        readonly main: {
+            readonly type: "query";
+            readonly description: "Gets views of user drafts. Requires authentication.";
+            readonly parameters: {
+                readonly type: "params";
+                readonly properties: {
+                    readonly limit: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly maximum: 100;
+                        readonly default: 50;
+                    };
+                    readonly cursor: {
+                        readonly type: "string";
+                    };
+                };
+            };
+            readonly output: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly required: ["drafts"];
+                    readonly properties: {
+                        readonly cursor: {
+                            readonly type: "string";
+                        };
+                        readonly drafts: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "ref";
+                                readonly ref: "lex:app.bsky.draft.defs#draftView";
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+} | {
+    readonly lexicon: 1;
+    readonly id: "app.bsky.draft.updateDraft";
+    readonly defs: {
+        readonly main: {
+            readonly type: "procedure";
+            readonly description: "Updates a draft using private storage (stash). If the draft ID points to a non-existing ID, the update will be silently ignored. This is done because updates don't enforce draft limit, so it accepts all writes, but will ignore invalid ones. Requires authentication.";
+            readonly input: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly required: ["draft"];
+                    readonly properties: {
+                        readonly draft: {
+                            readonly type: "ref";
+                            readonly ref: "lex:app.bsky.draft.defs#draftWithId";
+                        };
+                    };
+                };
+            };
+        };
+    };
 } | {
     readonly lexicon: 1;
     readonly id: "app.bsky.embed.defs";
@@ -36566,6 +37267,11 @@ export declare const ids: {
     readonly AppBskyContactSendNotification: "app.bsky.contact.sendNotification";
     readonly AppBskyContactStartPhoneVerification: "app.bsky.contact.startPhoneVerification";
     readonly AppBskyContactVerifyPhone: "app.bsky.contact.verifyPhone";
+    readonly AppBskyDraftCreateDraft: "app.bsky.draft.createDraft";
+    readonly AppBskyDraftDefs: "app.bsky.draft.defs";
+    readonly AppBskyDraftDeleteDraft: "app.bsky.draft.deleteDraft";
+    readonly AppBskyDraftGetDrafts: "app.bsky.draft.getDrafts";
+    readonly AppBskyDraftUpdateDraft: "app.bsky.draft.updateDraft";
     readonly AppBskyEmbedDefs: "app.bsky.embed.defs";
     readonly AppBskyEmbedExternal: "app.bsky.embed.external";
     readonly AppBskyEmbedImages: "app.bsky.embed.images";