@atproto/api 0.9.6 → 0.9.7

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

@@ -7,21 +7,29 @@ import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
 
+/** Represents an update of repository state. Note that empty commits are allowed, which include no repo data changes, but an update to rev and signature. */
 export interface Commit {
+  /** The stream sequence number of this message. */
   seq: number
+  /** DEPRECATED -- unused */
   rebase: boolean
+  /** Indicates that this commit contained too many ops, or data size was too large. Consumers will need to make a separate request to get missing data. */
   tooBig: boolean
+  /** The repo this event comes from. */
   repo: string
+  /** Repo commit object CID. */
   commit: CID
+  /** DEPRECATED -- unused. WARNING -- nullable and optional; stick with optional to ensure golang interoperability. */
   prev?: CID | null
-  /** The rev of the emitted commit. */
+  /** The rev of the emitted commit. Note that this information is also in the commit object included in blocks, unless this is a tooBig event. */
   rev: string
-  /** The rev of the last emitted commit from this repo. */
+  /** The rev of the last emitted commit from this repo (if any). */
   since: string | null
-  /** CAR file containing relevant blocks. */
+  /** CAR file containing relevant blocks, as a diff since the previous repo state. */
   blocks: Uint8Array
   ops: RepoOp[]
   blobs: CID[]
+  /** Timestamp of when this message was originally broadcast. */
   time: string
   [k: string]: unknown
 }
@@ -38,6 +46,7 @@ export function validateCommit(v: unknown): ValidationResult {
   return lexicons.validate('com.atproto.sync.subscribeRepos#commit', v)
 }
 
+/** Represents an update of the account's handle, or transition to/from invalid state. */
 export interface Handle {
   seq: number
   did: string
@@ -58,6 +67,7 @@ export function validateHandle(v: unknown): ValidationResult {
   return lexicons.validate('com.atproto.sync.subscribeRepos#handle', v)
 }
 
+/** Represents an account moving from one PDS instance to another. NOTE: not implemented; full account migration may introduce a new message instead. */
 export interface Migrate {
   seq: number
   did: string
@@ -78,6 +88,7 @@ export function validateMigrate(v: unknown): ValidationResult {
   return lexicons.validate('com.atproto.sync.subscribeRepos#migrate', v)
 }
 
+/** Indicates that an account has been deleted. */
 export interface Tombstone {
   seq: number
   did: string
@@ -115,10 +126,11 @@ export function validateInfo(v: unknown): ValidationResult {
   return lexicons.validate('com.atproto.sync.subscribeRepos#info', v)
 }
 
-/** A repo operation, ie a write of a single record. For creates and updates, CID is the record's CID as of this operation. For deletes, it's null. */
+/** A repo operation, ie a mutation of a single record. */
 export interface RepoOp {
   action: 'create' | 'update' | 'delete' | (string & {})
   path: string
+  /** For creates and updates, the new record CID. For deletions, null. */
   cid: CID | null
   [k: string]: unknown
 }