sync lex: #account firehose event; account status errors; and getAccountStatus endpoint

lexicons/com/atproto/sync/defs.json

@@ -0,0 +1,22 @@
+{
+  "lexicon": 1,
+  "id": "com.atproto.sync.defs",
+  "defs": {
+    "takendown": {
+      "type": "token",
+      "description": "Repo hosting status indicating that an administrator has taken down the repo, for a permanent period (though this may be reversed)."
+    },
+    "suspended": {
+      "type": "token",
+      "description": "Repo hosting status indicating that an administrator has taken down the repo, for a limited (but possibly indefinite) time period."
+    },
+    "deleted": {
+      "type": "token",
+      "description": "Repo hosting status indicating that the repository has been removed. The repo may be re-opened or migrated back to this host in the future, but the contents have been deleted for now. Does not clarify if the account self-deleted or an administrator or operator intervened."
+    },
+    "deactivated": {
+      "type": "token",
+      "description": "Repo hosting status indicating that the repository has been pause and should not be re-distributed, usually on request of the account holder. This may be temporary or indefinite."
+    }
+  }
+}

lexicons/com/atproto/sync/getBlob.json

@@ -23,7 +23,14 @@
       },
       "output": {
         "encoding": "*/*"
-      }
+      },
+      "errors": [
+        { "name": "BlobNotFound" },
+        { "name": "RepoNotFound" },
+        { "name": "RepoTakendown" },
+        { "name": "RepoSuspended" },
+        { "name": "RepoDeactivated" }
+      ]
     }
   }
 }

lexicons/com/atproto/sync/getBlocks.json

@@ -22,7 +22,14 @@
       },
       "output": {
         "encoding": "application/vnd.ipld.car"
-      }
+      },
+      "errors": [
+        { "name": "BlockNotFound" },
+        { "name": "RepoNotFound" },
+        { "name": "RepoTakendown" },
+        { "name": "RepoSuspended" },
+        { "name": "RepoDeactivated" }
+      ]
     }
   }
 }

lexicons/com/atproto/sync/getLatestCommit.json

@@ -27,7 +27,12 @@
           }
         }
       },
-      "errors": [{ "name": "RepoNotFound" }]
+      "errors": [
+        { "name": "RepoNotFound" },
+        { "name": "RepoTakendown" },
+        { "name": "RepoSuspended" },
+        { "name": "RepoDeactivated" }
+      ]
     }
   }
 }

lexicons/com/atproto/sync/getRecord.json

@@ -25,7 +25,14 @@
       },
       "output": {
         "encoding": "application/vnd.ipld.car"
-      }
+      },
+      "errors": [
+        { "name": "RecordNotFound" },
+        { "name": "RepoNotFound" },
+        { "name": "RepoTakendown" },
+        { "name": "RepoSuspended" },
+        { "name": "RepoDeactivated" }
+      ]
     }
   }
 }

lexicons/com/atproto/sync/getRepo.json

@@ -22,7 +22,13 @@
       },
       "output": {
         "encoding": "application/vnd.ipld.car"
-      }
+      },
+      "errors": [
+        { "name": "RepoNotFound" },
+        { "name": "RepoTakendown" },
+        { "name": "RepoSuspended" },
+        { "name": "RepoDeactivated" }
+      ]
     }
   }
 }

lexicons/com/atproto/sync/getRepoStatus.json

@@ -0,0 +1,46 @@
+{
+  "lexicon": 1,
+  "id": "com.atproto.sync.getRepoStatus",
+  "defs": {
+    "main": {
+      "type": "query",
+      "description": "Get the hosting status for a repository, on this server. Expected to be implemented by PDS and Relay.",
+      "parameters": {
+        "type": "params",
+        "required": ["did"],
+        "properties": {
+          "did": {
+            "type": "string",
+            "format": "did",
+            "description": "The handle or DID of the repo."
+          }
+        }
+      },
+      "output": {
+        "encoding": "application/json",
+        "schema": {
+          "type": "object",
+          "required": ["did", "active"],
+          "properties": {
+            "did": { "type": "string", "format": "did" },
+            "active": { "type": "boolean" },
+            "status": {
+              "type": "string",
+              "description": "If active=false, this optional field indicates a reason for why the account is not active.",
+              "knownValues": [
+                "com.atproto.sync.defs#takendown",
+                "com.atproto.sync.defs#suspended",
+                "com.atproto.sync.defs#deactivated"
+              ]
+            },
+            "rev": {
+              "type": "string",
+              "description": "Optional field, the current rev of the repo, if active=true"
+            }
+          }
+        }
+      },
+      "errors": [{ "name": "RepoNotFound" }]
+    }
+  }
+}

lexicons/com/atproto/sync/listBlobs.json

@@ -40,7 +40,13 @@
             }
           }
         }
-      }
+      },
+      "errors": [
+        { "name": "RepoNotFound" },
+        { "name": "RepoTakendown" },
+        { "name": "RepoSuspended" },
+        { "name": "RepoDeactivated" }
+      ]
     }
   }
 }

lexicons/com/atproto/sync/subscribeRepos.json

@@ -20,6 +20,7 @@
           "refs": [
             "#commit",
             "#identity",
+            "#account",
             "#handle",
             "#migrate",
             "#tombstone",
@@ -121,6 +122,30 @@
         "time": { "type": "string", "format": "datetime" }
       }
     },
+    "account": {
+      "type": "object",
+      "description": "Represents a change to an account's status on a host (eg, PDS or Relay). The semantics of this event are that the status is at the host which emitted the event, not necessarily that at the currently active PDS. Eg, a Relay takedown would emit a takedown with active=false, even if the PDS is still active.",
+      "required": ["seq", "did", "time", "active"],
+      "properties": {
+        "seq": { "type": "integer" },
+        "did": { "type": "string", "format": "did" },
+        "time": { "type": "string", "format": "datetime" },
+        "active": {
+          "type": "boolean",
+          "description": "Indicates that the account has a repository which can be fetched from the host that emitted this event."
+        },
+        "status": {
+          "type": "string",
+          "description": "If active=false, this optional field indicates a reason for why the account is not active.",
+          "knownValues": [
+            "com.atproto.sync.defs#takendown",
+            "com.atproto.sync.defs#suspended",
+            "com.atproto.sync.defs#deleted",
+            "com.atproto.sync.defs#deactivated"
+          ]
+        }
+      }
+    },
     "handle": {
       "type": "object",
       "description": "Represents an update of the account's handle, or transition to/from invalid state. NOTE: Will be deprecated in favor of #identity.",

packages/api/src/client/index.ts

@@ -80,13 +80,15 @@ import * as ComAtprotoServerReserveSigningKey from './types/com/atproto/server/r
 import * as ComAtprotoServerResetPassword from './types/com/atproto/server/resetPassword'
 import * as ComAtprotoServerRevokeAppPassword from './types/com/atproto/server/revokeAppPassword'
 import * as ComAtprotoServerUpdateEmail from './types/com/atproto/server/updateEmail'
+import * as ComAtprotoSyncDefs from './types/com/atproto/sync/defs'
 import * as ComAtprotoSyncGetBlob from './types/com/atproto/sync/getBlob'
 import * as ComAtprotoSyncGetBlocks from './types/com/atproto/sync/getBlocks'
 import * as ComAtprotoSyncGetCheckout from './types/com/atproto/sync/getCheckout'
 import * as ComAtprotoSyncGetHead from './types/com/atproto/sync/getHead'
 import * as ComAtprotoSyncGetLatestCommit from './types/com/atproto/sync/getLatestCommit'
 import * as ComAtprotoSyncGetRecord from './types/com/atproto/sync/getRecord'
 import * as ComAtprotoSyncGetRepo from './types/com/atproto/sync/getRepo'
+import * as ComAtprotoSyncGetRepoStatus from './types/com/atproto/sync/getRepoStatus'
 import * as ComAtprotoSyncListBlobs from './types/com/atproto/sync/listBlobs'
 import * as ComAtprotoSyncListRepos from './types/com/atproto/sync/listRepos'
 import * as ComAtprotoSyncNotifyOfUpdate from './types/com/atproto/sync/notifyOfUpdate'
@@ -234,13 +236,15 @@ export * as ComAtprotoServerReserveSigningKey from './types/com/atproto/server/r
 export * as ComAtprotoServerResetPassword from './types/com/atproto/server/resetPassword'
 export * as ComAtprotoServerRevokeAppPassword from './types/com/atproto/server/revokeAppPassword'
 export * as ComAtprotoServerUpdateEmail from './types/com/atproto/server/updateEmail'
+export * as ComAtprotoSyncDefs from './types/com/atproto/sync/defs'
 export * as ComAtprotoSyncGetBlob from './types/com/atproto/sync/getBlob'
 export * as ComAtprotoSyncGetBlocks from './types/com/atproto/sync/getBlocks'
 export * as ComAtprotoSyncGetCheckout from './types/com/atproto/sync/getCheckout'
 export * as ComAtprotoSyncGetHead from './types/com/atproto/sync/getHead'
 export * as ComAtprotoSyncGetLatestCommit from './types/com/atproto/sync/getLatestCommit'
 export * as ComAtprotoSyncGetRecord from './types/com/atproto/sync/getRecord'
 export * as ComAtprotoSyncGetRepo from './types/com/atproto/sync/getRepo'
+export * as ComAtprotoSyncGetRepoStatus from './types/com/atproto/sync/getRepoStatus'
 export * as ComAtprotoSyncListBlobs from './types/com/atproto/sync/listBlobs'
 export * as ComAtprotoSyncListRepos from './types/com/atproto/sync/listRepos'
 export * as ComAtprotoSyncNotifyOfUpdate from './types/com/atproto/sync/notifyOfUpdate'
@@ -329,6 +333,12 @@ export const COM_ATPROTO_MODERATION = {
   DefsReasonOther: 'com.atproto.moderation.defs#reasonOther',
   DefsReasonAppeal: 'com.atproto.moderation.defs#reasonAppeal',
 }
+export const COM_ATPROTO_SYNC = {
+  DefsTakendown: 'com.atproto.sync.defs#takendown',
+  DefsSuspended: 'com.atproto.sync.defs#suspended',
+  DefsDeleted: 'com.atproto.sync.defs#deleted',
+  DefsDeactivated: 'com.atproto.sync.defs#deactivated',
+}
 export const APP_BSKY_GRAPH = {
   DefsModlist: 'app.bsky.graph.defs#modlist',
   DefsCuratelist: 'app.bsky.graph.defs#curatelist',
@@ -1302,6 +1312,17 @@ export class ComAtprotoSyncNS {
       })
   }
 
+  getRepoStatus(
+    params?: ComAtprotoSyncGetRepoStatus.QueryParams,
+    opts?: ComAtprotoSyncGetRepoStatus.CallOptions,
+  ): Promise<ComAtprotoSyncGetRepoStatus.Response> {
+    return this._service.xrpc
+      .call('com.atproto.sync.getRepoStatus', params, undefined, opts)
+      .catch((e) => {
+        throw ComAtprotoSyncGetRepoStatus.toKnownErr(e)
+      })
+  }
+
   listBlobs(
     params?: ComAtprotoSyncListBlobs.QueryParams,
     opts?: ComAtprotoSyncListBlobs.CallOptions,