@atproto/api 0.18.15 → 0.18.16

package/src/client/lexicons.ts

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

package/src/client/types/app/bsky/draft/createDraft.ts

@@ -0,0 +1,55 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { HeadersMap, XRPCError } from '@atproto/xrpc'
+import { type ValidationResult, BlobRef } from '@atproto/lexicon'
+import { CID } from 'multiformats/cid'
+import { validate as _validate } from '../../../../lexicons'
+import {
+  type $Typed,
+  is$typed as _is$typed,
+  type OmitKey,
+} from '../../../../util'
+import type * as AppBskyDraftDefs from './defs.js'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'app.bsky.draft.createDraft'
+
+export type QueryParams = {}
+
+export interface InputSchema {
+  draft: AppBskyDraftDefs.Draft
+}
+
+export interface OutputSchema {
+  /** The ID of the created draft. */
+  id: string
+}
+
+export interface CallOptions {
+  signal?: AbortSignal
+  headers?: HeadersMap
+  qp?: QueryParams
+  encoding?: 'application/json'
+}
+
+export interface Response {
+  success: boolean
+  headers: HeadersMap
+  data: OutputSchema
+}
+
+export class DraftLimitReachedError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers, { cause: src })
+  }
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+    if (e.error === 'DraftLimitReached') return new DraftLimitReachedError(e)
+  }
+
+  return e
+}

package/src/client/types/app/bsky/draft/defs.ts

@@ -0,0 +1,208 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { type ValidationResult, BlobRef } from '@atproto/lexicon'
+import { CID } from 'multiformats/cid'
+import { validate as _validate } from '../../../../lexicons'
+import {
+  type $Typed,
+  is$typed as _is$typed,
+  type OmitKey,
+} from '../../../../util'
+import type * as AppBskyFeedPostgate from '../feed/postgate.js'
+import type * as AppBskyFeedThreadgate from '../feed/threadgate.js'
+import type * as ComAtprotoLabelDefs from '../../../com/atproto/label/defs.js'
+import type * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef.js'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'app.bsky.draft.defs'
+
+/** A draft with an identifier, used to store drafts in private storage (stash). */
+export interface DraftWithId {
+  $type?: 'app.bsky.draft.defs#draftWithId'
+  /** A TID to be used as a draft identifier. */
+  id: string
+  draft: Draft
+}
+
+const hashDraftWithId = 'draftWithId'
+
+export function isDraftWithId<V>(v: V) {
+  return is$typed(v, id, hashDraftWithId)
+}
+
+export function validateDraftWithId<V>(v: V) {
+  return validate<DraftWithId & V>(v, id, hashDraftWithId)
+}
+
+/** A draft containing an array of draft posts. */
+export interface Draft {
+  $type?: 'app.bsky.draft.defs#draft'
+  /** Array of draft posts that compose this draft. */
+  posts: DraftPost[]
+  /** Indicates human language of posts primary text content. */
+  langs?: string[]
+  /** Embedding rules for the postgates to be created when this draft is published. */
+  postgateEmbeddingRules?: (
+    | $Typed<AppBskyFeedPostgate.DisableRule>
+    | { $type: string }
+  )[]
+  /** Allow-rules for the threadgate to be created when this draft is published. */
+  threadgateAllow?: (
+    | $Typed<AppBskyFeedThreadgate.MentionRule>
+    | $Typed<AppBskyFeedThreadgate.FollowerRule>
+    | $Typed<AppBskyFeedThreadgate.FollowingRule>
+    | $Typed<AppBskyFeedThreadgate.ListRule>
+    | { $type: string }
+  )[]
+}
+
+const hashDraft = 'draft'
+
+export function isDraft<V>(v: V) {
+  return is$typed(v, id, hashDraft)
+}
+
+export function validateDraft<V>(v: V) {
+  return validate<Draft & V>(v, id, hashDraft)
+}
+
+/** One of the posts that compose a draft. */
+export interface DraftPost {
+  $type?: 'app.bsky.draft.defs#draftPost'
+  /** The primary post content. */
+  text: string
+  labels?: $Typed<ComAtprotoLabelDefs.SelfLabels> | { $type: string }
+  embedImages?: DraftEmbedImage[]
+  embedVideos?: DraftEmbedVideo[]
+  embedExternals?: DraftEmbedExternal[]
+  embedRecords?: DraftEmbedRecord[]
+}
+
+const hashDraftPost = 'draftPost'
+
+export function isDraftPost<V>(v: V) {
+  return is$typed(v, id, hashDraftPost)
+}
+
+export function validateDraftPost<V>(v: V) {
+  return validate<DraftPost & V>(v, id, hashDraftPost)
+}
+
+/** View to present drafts data to users. */
+export interface DraftView {
+  $type?: 'app.bsky.draft.defs#draftView'
+  /** A TID to be used as a draft identifier. */
+  id: string
+  draft: Draft
+  /** The time the draft was created. */
+  createdAt: string
+  /** The time the draft was last updated. */
+  updatedAt: string
+}
+
+const hashDraftView = 'draftView'
+
+export function isDraftView<V>(v: V) {
+  return is$typed(v, id, hashDraftView)
+}
+
+export function validateDraftView<V>(v: V) {
+  return validate<DraftView & V>(v, id, hashDraftView)
+}
+
+export interface DraftEmbedLocalRef {
+  $type?: 'app.bsky.draft.defs#draftEmbedLocalRef'
+  /** Local, on-device ref to file to be embedded. Embeds are currently device-bound for drafts. */
+  path: string
+}
+
+const hashDraftEmbedLocalRef = 'draftEmbedLocalRef'
+
+export function isDraftEmbedLocalRef<V>(v: V) {
+  return is$typed(v, id, hashDraftEmbedLocalRef)
+}
+
+export function validateDraftEmbedLocalRef<V>(v: V) {
+  return validate<DraftEmbedLocalRef & V>(v, id, hashDraftEmbedLocalRef)
+}
+
+export interface DraftEmbedCaption {
+  $type?: 'app.bsky.draft.defs#draftEmbedCaption'
+  lang: string
+  content: string
+}
+
+const hashDraftEmbedCaption = 'draftEmbedCaption'
+
+export function isDraftEmbedCaption<V>(v: V) {
+  return is$typed(v, id, hashDraftEmbedCaption)
+}
+
+export function validateDraftEmbedCaption<V>(v: V) {
+  return validate<DraftEmbedCaption & V>(v, id, hashDraftEmbedCaption)
+}
+
+export interface DraftEmbedImage {
+  $type?: 'app.bsky.draft.defs#draftEmbedImage'
+  localRef: DraftEmbedLocalRef
+  alt?: string
+}
+
+const hashDraftEmbedImage = 'draftEmbedImage'
+
+export function isDraftEmbedImage<V>(v: V) {
+  return is$typed(v, id, hashDraftEmbedImage)
+}
+
+export function validateDraftEmbedImage<V>(v: V) {
+  return validate<DraftEmbedImage & V>(v, id, hashDraftEmbedImage)
+}
+
+export interface DraftEmbedVideo {
+  $type?: 'app.bsky.draft.defs#draftEmbedVideo'
+  localRef: DraftEmbedLocalRef
+  alt?: string
+  captions?: DraftEmbedCaption[]
+}
+
+const hashDraftEmbedVideo = 'draftEmbedVideo'
+
+export function isDraftEmbedVideo<V>(v: V) {
+  return is$typed(v, id, hashDraftEmbedVideo)
+}
+
+export function validateDraftEmbedVideo<V>(v: V) {
+  return validate<DraftEmbedVideo & V>(v, id, hashDraftEmbedVideo)
+}
+
+export interface DraftEmbedExternal {
+  $type?: 'app.bsky.draft.defs#draftEmbedExternal'
+  uri: string
+}
+
+const hashDraftEmbedExternal = 'draftEmbedExternal'
+
+export function isDraftEmbedExternal<V>(v: V) {
+  return is$typed(v, id, hashDraftEmbedExternal)
+}
+
+export function validateDraftEmbedExternal<V>(v: V) {
+  return validate<DraftEmbedExternal & V>(v, id, hashDraftEmbedExternal)
+}
+
+export interface DraftEmbedRecord {
+  $type?: 'app.bsky.draft.defs#draftEmbedRecord'
+  record: ComAtprotoRepoStrongRef.Main
+}
+
+const hashDraftEmbedRecord = 'draftEmbedRecord'
+
+export function isDraftEmbedRecord<V>(v: V) {
+  return is$typed(v, id, hashDraftEmbedRecord)
+}
+
+export function validateDraftEmbedRecord<V>(v: V) {
+  return validate<DraftEmbedRecord & V>(v, id, hashDraftEmbedRecord)
+}

package/src/client/types/app/bsky/draft/deleteDraft.ts

@@ -0,0 +1,38 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { HeadersMap, XRPCError } from '@atproto/xrpc'
+import { type ValidationResult, BlobRef } from '@atproto/lexicon'
+import { CID } from 'multiformats/cid'
+import { validate as _validate } from '../../../../lexicons'
+import {
+  type $Typed,
+  is$typed as _is$typed,
+  type OmitKey,
+} from '../../../../util'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'app.bsky.draft.deleteDraft'
+
+export type QueryParams = {}
+
+export interface InputSchema {
+  id: string
+}
+
+export interface CallOptions {
+  signal?: AbortSignal
+  headers?: HeadersMap
+  qp?: QueryParams
+  encoding?: 'application/json'
+}
+
+export interface Response {
+  success: boolean
+  headers: HeadersMap
+}
+
+export function toKnownErr(e: any) {
+  return e
+}