@atproto/api 0.1.2 → 0.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/api",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "main": "dist/index.js",
   "scripts": {
     "codegen": "lex gen-api ./src/client ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/*",

package/src/client/index.ts

@@ -49,11 +49,14 @@ import * as ComAtprotoSessionCreate from './types/com/atproto/session/create'
 import * as ComAtprotoSessionDelete from './types/com/atproto/session/delete'
 import * as ComAtprotoSessionGet from './types/com/atproto/session/get'
 import * as ComAtprotoSessionRefresh from './types/com/atproto/session/refresh'
+import * as ComAtprotoSyncGetBlocks from './types/com/atproto/sync/getBlocks'
 import * as ComAtprotoSyncGetCheckout from './types/com/atproto/sync/getCheckout'
 import * as ComAtprotoSyncGetCommitPath from './types/com/atproto/sync/getCommitPath'
 import * as ComAtprotoSyncGetHead from './types/com/atproto/sync/getHead'
 import * as ComAtprotoSyncGetRecord from './types/com/atproto/sync/getRecord'
 import * as ComAtprotoSyncGetRepo from './types/com/atproto/sync/getRepo'
+import * as ComAtprotoSyncNotifyOfUpdate from './types/com/atproto/sync/notifyOfUpdate'
+import * as ComAtprotoSyncRequestCrawl from './types/com/atproto/sync/requestCrawl'
 import * as ComAtprotoSyncSubscribeAllRepos from './types/com/atproto/sync/subscribeAllRepos'
 import * as AppBskyActorGetProfile from './types/app/bsky/actor/getProfile'
 import * as AppBskyActorGetProfiles from './types/app/bsky/actor/getProfiles'
@@ -65,6 +68,7 @@ import * as AppBskyActorSearchTypeahead from './types/app/bsky/actor/searchTypea
 import * as AppBskyActorUpdateProfile from './types/app/bsky/actor/updateProfile'
 import * as AppBskyEmbedExternal from './types/app/bsky/embed/external'
 import * as AppBskyEmbedImages from './types/app/bsky/embed/images'
+import * as AppBskyEmbedRecord from './types/app/bsky/embed/record'
 import * as AppBskyFeedFeedViewPost from './types/app/bsky/feed/feedViewPost'
 import * as AppBskyFeedGetAuthorFeed from './types/app/bsky/feed/getAuthorFeed'
 import * as AppBskyFeedGetPostThread from './types/app/bsky/feed/getPostThread'
@@ -135,11 +139,14 @@ export * as ComAtprotoSessionCreate from './types/com/atproto/session/create'
 export * as ComAtprotoSessionDelete from './types/com/atproto/session/delete'
 export * as ComAtprotoSessionGet from './types/com/atproto/session/get'
 export * as ComAtprotoSessionRefresh from './types/com/atproto/session/refresh'
+export * as ComAtprotoSyncGetBlocks from './types/com/atproto/sync/getBlocks'
 export * as ComAtprotoSyncGetCheckout from './types/com/atproto/sync/getCheckout'
 export * as ComAtprotoSyncGetCommitPath from './types/com/atproto/sync/getCommitPath'
 export * as ComAtprotoSyncGetHead from './types/com/atproto/sync/getHead'
 export * as ComAtprotoSyncGetRecord from './types/com/atproto/sync/getRecord'
 export * as ComAtprotoSyncGetRepo from './types/com/atproto/sync/getRepo'
+export * as ComAtprotoSyncNotifyOfUpdate from './types/com/atproto/sync/notifyOfUpdate'
+export * as ComAtprotoSyncRequestCrawl from './types/com/atproto/sync/requestCrawl'
 export * as ComAtprotoSyncSubscribeAllRepos from './types/com/atproto/sync/subscribeAllRepos'
 export * as AppBskyActorGetProfile from './types/app/bsky/actor/getProfile'
 export * as AppBskyActorGetProfiles from './types/app/bsky/actor/getProfiles'
@@ -151,6 +158,7 @@ export * as AppBskyActorSearchTypeahead from './types/app/bsky/actor/searchTypea
 export * as AppBskyActorUpdateProfile from './types/app/bsky/actor/updateProfile'
 export * as AppBskyEmbedExternal from './types/app/bsky/embed/external'
 export * as AppBskyEmbedImages from './types/app/bsky/embed/images'
+export * as AppBskyEmbedRecord from './types/app/bsky/embed/record'
 export * as AppBskyFeedFeedViewPost from './types/app/bsky/feed/feedViewPost'
 export * as AppBskyFeedGetAuthorFeed from './types/app/bsky/feed/getAuthorFeed'
 export * as AppBskyFeedGetPostThread from './types/app/bsky/feed/getPostThread'
@@ -695,6 +703,17 @@ export class SyncNS {
     this._service = service
   }
 
+  getBlocks(
+    params?: ComAtprotoSyncGetBlocks.QueryParams,
+    opts?: ComAtprotoSyncGetBlocks.CallOptions,
+  ): Promise<ComAtprotoSyncGetBlocks.Response> {
+    return this._service.xrpc
+      .call('com.atproto.sync.getBlocks', params, undefined, opts)
+      .catch((e) => {
+        throw ComAtprotoSyncGetBlocks.toKnownErr(e)
+      })
+  }
+
   getCheckout(
     params?: ComAtprotoSyncGetCheckout.QueryParams,
     opts?: ComAtprotoSyncGetCheckout.CallOptions,
@@ -749,6 +768,28 @@ export class SyncNS {
         throw ComAtprotoSyncGetRepo.toKnownErr(e)
       })
   }
+
+  notifyOfUpdate(
+    params?: ComAtprotoSyncNotifyOfUpdate.QueryParams,
+    opts?: ComAtprotoSyncNotifyOfUpdate.CallOptions,
+  ): Promise<ComAtprotoSyncNotifyOfUpdate.Response> {
+    return this._service.xrpc
+      .call('com.atproto.sync.notifyOfUpdate', params, undefined, opts)
+      .catch((e) => {
+        throw ComAtprotoSyncNotifyOfUpdate.toKnownErr(e)
+      })
+  }
+
+  requestCrawl(
+    params?: ComAtprotoSyncRequestCrawl.QueryParams,
+    opts?: ComAtprotoSyncRequestCrawl.CallOptions,
+  ): Promise<ComAtprotoSyncRequestCrawl.Response> {
+    return this._service.xrpc
+      .call('com.atproto.sync.requestCrawl', params, undefined, opts)
+      .catch((e) => {
+        throw ComAtprotoSyncRequestCrawl.toKnownErr(e)
+      })
+  }
 }
 
 export class AppNS {

package/src/client/lexicons.ts

@@ -2025,6 +2025,35 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoSyncGetBlocks: {
+    lexicon: 1,
+    id: 'com.atproto.sync.getBlocks',
+    defs: {
+      main: {
+        type: 'query',
+        description: 'Gets blocks from a given repo.',
+        parameters: {
+          type: 'params',
+          required: ['did', 'cids'],
+          properties: {
+            did: {
+              type: 'string',
+              description: 'The DID of the repo.',
+            },
+            cids: {
+              type: 'array',
+              items: {
+                type: 'string',
+              },
+            },
+          },
+        },
+        output: {
+          encoding: 'application/vnd.ipld.car',
+        },
+      },
+    },
+  },
   ComAtprotoSyncGetCheckout: {
     lexicon: 1,
     id: 'com.atproto.sync.getCheckout',
@@ -2195,6 +2224,38 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoSyncNotifyOfUpdate: {
+    lexicon: 1,
+    id: 'com.atproto.sync.notifyOfUpdate',
+    defs: {
+      main: {
+        type: 'query',
+        description:
+          'Notify a crawling service of a recent update. Often when a long break between updates causes the connection with the crawling service to break.',
+      },
+    },
+  },
+  ComAtprotoSyncRequestCrawl: {
+    lexicon: 1,
+    id: 'com.atproto.sync.requestCrawl',
+    defs: {
+      main: {
+        type: 'query',
+        description: 'Request a service to persistently crawl hosted repos.',
+        parameters: {
+          type: 'params',
+          required: ['hostname'],
+          properties: {
+            host: {
+              type: 'string',
+              description:
+                'Hostname of the service that is requesting to be crawled.',
+            },
+          },
+        },
+      },
+    },
+  },
   ComAtprotoSyncSubscribeAllRepos: {
     lexicon: 1,
     id: 'com.atproto.sync.subscribeAllRepos',
@@ -2205,68 +2266,68 @@ export const schemaDict = {
         parameters: {
           type: 'params',
           properties: {
-            backfillFrom: {
-              type: 'datetime',
-              description:
-                'The last known event to backfill from. Does not dedupe as there may be an overlap in timestamps.',
+            cursor: {
+              type: 'integer',
+              description: 'The last known event to backfill from.',
             },
           },
         },
         message: {
           schema: {
-            type: 'union',
-            refs: [
-              'lex:com.atproto.sync.subscribeAllRepos#repoAppend',
-              'lex:com.atproto.sync.subscribeAllRepos#repoRebase',
+            type: 'object',
+            required: [
+              'seq',
+              'event',
+              'repo',
+              'commit',
+              'prev',
+              'blocks',
+              'blobs',
+              'time',
             ],
-          },
-          codes: {
-            'lex:com.atproto.sync.subscribeAllRepos#repoAppend': 0,
-            'lex:com.atproto.sync.subscribeAllRepos#repoRebase': 1,
-          },
-        },
-      },
-      repoAppend: {
-        type: 'object',
-        required: ['time', 'repo', 'commit', 'blocks', 'blobs'],
-        properties: {
-          time: {
-            type: 'datetime',
-          },
-          repo: {
-            type: 'string',
-          },
-          commit: {
-            type: 'string',
-          },
-          prev: {
-            type: 'string',
-          },
-          blocks: {
-            type: 'unknown',
-          },
-          blobs: {
-            type: 'array',
-            items: {
-              type: 'string',
+            nullable: ['prev'],
+            properties: {
+              seq: {
+                type: 'integer',
+              },
+              event: {
+                type: 'string',
+                knownValues: ['repo_append', 'rebase'],
+              },
+              repo: {
+                type: 'string',
+              },
+              commit: {
+                type: 'string',
+              },
+              prev: {
+                type: 'string',
+              },
+              blocks: {
+                type: 'unknown',
+              },
+              blobs: {
+                type: 'array',
+                items: {
+                  type: 'string',
+                },
+              },
+              time: {
+                type: 'datetime',
+              },
             },
           },
         },
-      },
-      repoRebase: {
-        type: 'object',
-        required: ['time', 'repo', 'commit'],
-        properties: {
-          time: {
-            type: 'datetime',
-          },
-          repo: {
-            type: 'string',
+        infos: [
+          {
+            name: 'OutdatedCursor',
           },
-          commit: {
-            type: 'string',
+        ],
+        errors: [
+          {
+            name: 'FutureCursor',
           },
-        },
+        ],
       },
     },
   },
@@ -2694,6 +2755,7 @@ export const schemaDict = {
           encoding: 'application/json',
           schema: {
             type: 'object',
+            nullable: ['description', 'avatar', 'banner'],
             properties: {
               displayName: {
                 type: 'string',
@@ -2889,6 +2951,65 @@ export const schemaDict = {
       },
     },
   },
+  AppBskyEmbedRecord: {
+    lexicon: 1,
+    id: 'app.bsky.embed.record',
+    description:
+      'An representation of a record embedded in another form of content',
+    defs: {
+      main: {
+        type: 'object',
+        required: ['record'],
+        properties: {
+          record: {
+            type: 'ref',
+            ref: 'lex:com.atproto.repo.strongRef',
+          },
+        },
+      },
+      presented: {
+        type: 'object',
+        required: ['record'],
+        properties: {
+          record: {
+            type: 'union',
+            refs: [
+              'lex:app.bsky.embed.record#presentedRecord',
+              'lex:app.bsky.embed.record#presentedNotFound',
+            ],
+          },
+        },
+      },
+      presentedRecord: {
+        type: 'object',
+        required: ['uri', 'cid', 'author', 'record'],
+        properties: {
+          uri: {
+            type: 'string',
+          },
+          cid: {
+            type: 'string',
+          },
+          author: {
+            type: 'ref',
+            ref: 'lex:app.bsky.actor.ref#withInfo',
+          },
+          record: {
+            type: 'unknown',
+          },
+        },
+      },
+      presentedNotFound: {
+        type: 'object',
+        required: ['uri'],
+        properties: {
+          uri: {
+            type: 'string',
+          },
+        },
+      },
+    },
+  },
   AppBskyFeedFeedViewPost: {
     lexicon: 1,
     id: 'app.bsky.feed.feedViewPost',
@@ -3280,6 +3401,7 @@ export const schemaDict = {
               refs: [
                 'lex:app.bsky.embed.images',
                 'lex:app.bsky.embed.external',
+                'lex:app.bsky.embed.record',
               ],
             },
             createdAt: {
@@ -3368,6 +3490,7 @@ export const schemaDict = {
             refs: [
               'lex:app.bsky.embed.images#presented',
               'lex:app.bsky.embed.external#presented',
+              'lex:app.bsky.embed.record#presented',
             ],
           },
           replyCount: {
@@ -4023,11 +4146,14 @@ export const ids = {
   ComAtprotoSessionDelete: 'com.atproto.session.delete',
   ComAtprotoSessionGet: 'com.atproto.session.get',
   ComAtprotoSessionRefresh: 'com.atproto.session.refresh',
+  ComAtprotoSyncGetBlocks: 'com.atproto.sync.getBlocks',
   ComAtprotoSyncGetCheckout: 'com.atproto.sync.getCheckout',
   ComAtprotoSyncGetCommitPath: 'com.atproto.sync.getCommitPath',
   ComAtprotoSyncGetHead: 'com.atproto.sync.getHead',
   ComAtprotoSyncGetRecord: 'com.atproto.sync.getRecord',
   ComAtprotoSyncGetRepo: 'com.atproto.sync.getRepo',
+  ComAtprotoSyncNotifyOfUpdate: 'com.atproto.sync.notifyOfUpdate',
+  ComAtprotoSyncRequestCrawl: 'com.atproto.sync.requestCrawl',
   ComAtprotoSyncSubscribeAllRepos: 'com.atproto.sync.subscribeAllRepos',
   AppBskyActorGetProfile: 'app.bsky.actor.getProfile',
   AppBskyActorGetProfiles: 'app.bsky.actor.getProfiles',
@@ -4039,6 +4165,7 @@ export const ids = {
   AppBskyActorUpdateProfile: 'app.bsky.actor.updateProfile',
   AppBskyEmbedExternal: 'app.bsky.embed.external',
   AppBskyEmbedImages: 'app.bsky.embed.images',
+  AppBskyEmbedRecord: 'app.bsky.embed.record',
   AppBskyFeedFeedViewPost: 'app.bsky.feed.feedViewPost',
   AppBskyFeedGetAuthorFeed: 'app.bsky.feed.getAuthorFeed',
   AppBskyFeedGetPostThread: 'app.bsky.feed.getPostThread',

package/src/client/types/app/bsky/actor/updateProfile.ts

@@ -10,9 +10,9 @@ export interface QueryParams {}
 
 export interface InputSchema {
   displayName?: string
-  description?: string
-  avatar?: { cid: string; mimeType: string; [k: string]: unknown }
-  banner?: { cid: string; mimeType: string; [k: string]: unknown }
+  description?: string | null
+  avatar?: { cid: string; mimeType: string; [k: string]: unknown } | null
+  banner?: { cid: string; mimeType: string; [k: string]: unknown } | null
   [k: string]: unknown
 }
 

package/src/client/types/app/bsky/embed/record.ts

@@ -0,0 +1,83 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { ValidationResult } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+import * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef'
+import * as AppBskyActorRef from '../actor/ref'
+
+export interface Main {
+  record: ComAtprotoRepoStrongRef.Main
+  [k: string]: unknown
+}
+
+export function isMain(v: unknown): v is Main {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    (v.$type === 'app.bsky.embed.record#main' ||
+      v.$type === 'app.bsky.embed.record')
+  )
+}
+
+export function validateMain(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.embed.record#main', v)
+}
+
+export interface Presented {
+  record:
+    | PresentedRecord
+    | PresentedNotFound
+    | { $type: string; [k: string]: unknown }
+  [k: string]: unknown
+}
+
+export function isPresented(v: unknown): v is Presented {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.embed.record#presented'
+  )
+}
+
+export function validatePresented(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.embed.record#presented', v)
+}
+
+export interface PresentedRecord {
+  uri: string
+  cid: string
+  author: AppBskyActorRef.WithInfo
+  record: {}
+  [k: string]: unknown
+}
+
+export function isPresentedRecord(v: unknown): v is PresentedRecord {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.embed.record#presentedRecord'
+  )
+}
+
+export function validatePresentedRecord(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.embed.record#presentedRecord', v)
+}
+
+export interface PresentedNotFound {
+  uri: string
+  [k: string]: unknown
+}
+
+export function isPresentedNotFound(v: unknown): v is PresentedNotFound {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.embed.record#presentedNotFound'
+  )
+}
+
+export function validatePresentedNotFound(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.embed.record#presentedNotFound', v)
+}

package/src/client/types/app/bsky/feed/post.ts

@@ -6,6 +6,7 @@ import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
 import * as AppBskyEmbedImages from '../embed/images'
 import * as AppBskyEmbedExternal from '../embed/external'
+import * as AppBskyEmbedRecord from '../embed/record'
 import * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef'
 import * as AppBskyActorRef from '../actor/ref'
 
@@ -16,6 +17,7 @@ export interface Record {
   embed?:
     | AppBskyEmbedImages.Main
     | AppBskyEmbedExternal.Main
+    | AppBskyEmbedRecord.Main
     | { $type: string; [k: string]: unknown }
   createdAt: string
   [k: string]: unknown
@@ -94,6 +96,7 @@ export interface View {
   embed?:
     | AppBskyEmbedImages.Presented
     | AppBskyEmbedExternal.Presented
+    | AppBskyEmbedRecord.Presented
     | { $type: string; [k: string]: unknown }
   replyCount: number
   repostCount: number

package/src/client/types/com/atproto/sync/getBlocks.ts

@@ -0,0 +1,31 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { Headers, XRPCError } from '@atproto/xrpc'
+import { ValidationResult } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+
+export interface QueryParams {
+  /** The DID of the repo. */
+  did: string
+  cids: string[]
+}
+
+export type InputSchema = undefined
+
+export interface CallOptions {
+  headers?: Headers
+}
+
+export interface Response {
+  success: boolean
+  headers: Headers
+  data: Uint8Array
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+  }
+  return e
+}

package/src/client/types/com/atproto/sync/notifyOfUpdate.ts

@@ -0,0 +1,26 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { Headers, XRPCError } from '@atproto/xrpc'
+import { ValidationResult } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+
+export interface QueryParams {}
+
+export type InputSchema = undefined
+
+export interface CallOptions {
+  headers?: Headers
+}
+
+export interface Response {
+  success: boolean
+  headers: Headers
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+  }
+  return e
+}

package/src/client/types/com/atproto/sync/requestCrawl.ts

@@ -0,0 +1,29 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { Headers, XRPCError } from '@atproto/xrpc'
+import { ValidationResult } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+
+export interface QueryParams {
+  /** Hostname of the service that is requesting to be crawled. */
+  host?: string
+}
+
+export type InputSchema = undefined
+
+export interface CallOptions {
+  headers?: Headers
+}
+
+export interface Response {
+  success: boolean
+  headers: Headers
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+  }
+  return e
+}

package/src/client/types/com/atproto/sync/subscribeAllRepos.ts

@@ -5,44 +5,3 @@ import { Headers, XRPCError } from '@atproto/xrpc'
 import { ValidationResult } from '@atproto/lexicon'
 import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
-
-export interface RepoAppend {
-  time: string
-  repo: string
-  commit: string
-  prev?: string
-  blocks: {}
-  blobs: string[]
-  [k: string]: unknown
-}
-
-export function isRepoAppend(v: unknown): v is RepoAppend {
-  return (
-    isObj(v) &&
-    hasProp(v, '$type') &&
-    v.$type === 'com.atproto.sync.subscribeAllRepos#repoAppend'
-  )
-}
-
-export function validateRepoAppend(v: unknown): ValidationResult {
-  return lexicons.validate('com.atproto.sync.subscribeAllRepos#repoAppend', v)
-}
-
-export interface RepoRebase {
-  time: string
-  repo: string
-  commit: string
-  [k: string]: unknown
-}
-
-export function isRepoRebase(v: unknown): v is RepoRebase {
-  return (
-    isObj(v) &&
-    hasProp(v, '$type') &&
-    v.$type === 'com.atproto.sync.subscribeAllRepos#repoRebase'
-  )
-}
-
-export function validateRepoRebase(v: unknown): ValidationResult {
-  return lexicons.validate('com.atproto.sync.subscribeAllRepos#repoRebase', v)
-}