@atproto/pds 0.4.28 → 0.4.29

package/src/api/com/atproto/sync/getLatestCommit.ts

@@ -1,22 +1,19 @@
 import { InvalidRequestError } from '@atproto/xrpc-server'
 import { Server } from '../../../../lexicon'
 import AppContext from '../../../../context'
+import { assertRepoAvailability } from './util'
 
 export default function (server: Server, ctx: AppContext) {
   server.com.atproto.sync.getLatestCommit({
     auth: ctx.authVerifier.optionalAccessOrAdminToken,
     handler: async ({ params, auth }) => {
       const { did } = params
-      // takedown check for anyone other than an admin or the user
-      if (!ctx.authVerifier.isUserOrAdmin(auth, did)) {
-        const available = await ctx.accountManager.isRepoAvailable(did)
-        if (!available) {
-          throw new InvalidRequestError(
-            `Could not find root for DID: ${did}`,
-            'RepoNotFound',
-          )
-        }
-      }
+      await assertRepoAvailability(
+        ctx,
+        did,
+        ctx.authVerifier.isUserOrAdmin(auth, did),
+      )
+
       const root = await ctx.actorStore.read(did, (store) =>
         store.repo.storage.getRootDetailed(),
       )

package/src/api/com/atproto/sync/getRecord.ts

@@ -6,19 +6,19 @@ import { Server } from '../../../../lexicon'
 import AppContext from '../../../../context'
 import { byteIterableToStream } from '@atproto/common'
 import { SqlRepoReader } from '../../../../actor-store/repo/sql-repo-reader'
+import { assertRepoAvailability } from './util'
 
 export default function (server: Server, ctx: AppContext) {
   server.com.atproto.sync.getRecord({
     auth: ctx.authVerifier.optionalAccessOrAdminToken,
     handler: async ({ params, auth }) => {
       const { did, collection, rkey } = params
-      // takedown check for anyone other than an admin or the user
-      if (!ctx.authVerifier.isUserOrAdmin(auth, did)) {
-        const available = await ctx.accountManager.isRepoAvailable(did)
-        if (!available) {
-          throw new InvalidRequestError(`Could not find repo for DID: ${did}`)
-        }
-      }
+      await assertRepoAvailability(
+        ctx,
+        did,
+        ctx.authVerifier.isUserOrAdmin(auth, did),
+      )
+
       // must open up the db outside of store interface so that we can close the file handle after finished streaming
       const actorDb = await ctx.actorStore.openDb(did)
 

package/src/api/com/atproto/sync/getRepo.ts

@@ -6,19 +6,18 @@ import {
   RepoRootNotFoundError,
   SqlRepoReader,
 } from '../../../../actor-store/repo/sql-repo-reader'
+import { assertRepoAvailability } from './util'
 
 export default function (server: Server, ctx: AppContext) {
   server.com.atproto.sync.getRepo({
     auth: ctx.authVerifier.optionalAccessOrAdminToken,
     handler: async ({ params, auth }) => {
       const { did, since } = params
-      // takedown check for anyone other than an admin or the user
-      if (!ctx.authVerifier.isUserOrAdmin(auth, did)) {
-        const available = await ctx.accountManager.isRepoAvailable(did)
-        if (!available) {
-          throw new InvalidRequestError(`Could not find repo for DID: ${did}`)
-        }
-      }
+      await assertRepoAvailability(
+        ctx,
+        did,
+        ctx.authVerifier.isUserOrAdmin(auth, did),
+      )
 
       const carStream = await getCarStream(ctx, did, since)
 

package/src/api/com/atproto/sync/getRepoStatus.ts

@@ -0,0 +1,31 @@
+import { Server } from '../../../../lexicon'
+import AppContext from '../../../../context'
+import { assertRepoAvailability, formatAccountStatus } from './util'
+
+export default function (server: Server, ctx: AppContext) {
+  server.com.atproto.sync.getRepoStatus({
+    handler: async ({ params }) => {
+      const { did } = params
+      const account = await assertRepoAvailability(ctx, did, true)
+      const { active, status } = formatAccountStatus(account)
+
+      let rev: string | undefined = undefined
+      if (active) {
+        const root = await ctx.actorStore.read(did, (store) =>
+          store.repo.storage.getRootDetailed(),
+        )
+        rev = root.rev
+      }
+
+      return {
+        encoding: 'application/json',
+        body: {
+          did,
+          active,
+          status,
+          rev,
+        },
+      }
+    },
+  })
+}

package/src/api/com/atproto/sync/index.ts

@@ -3,6 +3,7 @@ import AppContext from '../../../../context'
 import getBlob from './getBlob'
 import getBlocks from './getBlocks'
 import getLatestCommit from './getLatestCommit'
+import getRepoStatus from './getRepoStatus'
 import getRecord from './getRecord'
 import getRepo from './getRepo'
 import subscribeRepos from './subscribeRepos'
@@ -15,6 +16,7 @@ export default function (server: Server, ctx: AppContext) {
   getBlob(server, ctx)
   getBlocks(server, ctx)
   getLatestCommit(server, ctx)
+  getRepoStatus(server, ctx)
   getRecord(server, ctx)
   getRepo(server, ctx)
   subscribeRepos(server, ctx)

package/src/api/com/atproto/sync/listBlobs.ts

@@ -1,19 +1,17 @@
-import { InvalidRequestError } from '@atproto/xrpc-server'
 import { Server } from '../../../../lexicon'
 import AppContext from '../../../../context'
+import { assertRepoAvailability } from './util'
 
 export default function (server: Server, ctx: AppContext) {
   server.com.atproto.sync.listBlobs({
     auth: ctx.authVerifier.optionalAccessOrAdminToken,
     handler: async ({ params, auth }) => {
       const { did, since, limit, cursor } = params
-      // takedown check for anyone other than an admin or the user
-      if (!ctx.authVerifier.isUserOrAdmin(auth, did)) {
-        const available = await ctx.accountManager.isRepoAvailable(did)
-        if (!available) {
-          throw new InvalidRequestError(`Could not find root for DID: ${did}`)
-        }
-      }
+      await assertRepoAvailability(
+        ctx,
+        did,
+        ctx.authVerifier.isUserOrAdmin(auth, did),
+      )
 
       const blobCids = await ctx.actorStore.read(did, (store) =>
         store.repo.blob.listBlobs({ since, limit, cursor }),

package/src/api/com/atproto/sync/listRepos.ts

@@ -2,7 +2,7 @@ import { InvalidRequestError } from '@atproto/xrpc-server'
 import { Server } from '../../../../lexicon'
 import AppContext from '../../../../context'
 import { Cursor, GenericKeyset, paginate } from '../../../../db/pagination'
-import { notSoftDeletedClause } from '../../../../db/util'
+import { formatAccountStatus } from './util'
 
 export default function (server: Server, ctx: AppContext) {
   server.com.atproto.sync.listRepos(async ({ params }) => {
@@ -12,13 +12,13 @@ export default function (server: Server, ctx: AppContext) {
     let builder = db.db
       .selectFrom('actor')
       .innerJoin('repo_root', 'repo_root.did', 'actor.did')
-      .where(notSoftDeletedClause(ref('actor')))
-      .where('actor.deactivatedAt', 'is', null)
       .select([
         'actor.did as did',
         'repo_root.cid as head',
         'repo_root.rev as rev',
         'actor.createdAt as createdAt',
+        'actor.deactivatedAt as deactivatedAt',
+        'actor.takedownRef as takedownRef',
       ])
     const keyset = new TimeDidKeyset(ref('actor.createdAt'), ref('actor.did'))
     builder = paginate(builder, {
@@ -29,11 +29,16 @@ export default function (server: Server, ctx: AppContext) {
       tryIndex: true,
     })
     const res = await builder.execute()
-    const repos = res.map((row) => ({
-      did: row.did,
-      head: row.head,
-      rev: row.rev ?? '',
-    }))
+    const repos = res.map((row) => {
+      const { active, status } = formatAccountStatus(row)
+      return {
+        did: row.did,
+        head: row.head,
+        rev: row.rev ?? '',
+        active,
+        status,
+      }
+    })
     return {
       encoding: 'application/json',
       body: {

package/src/api/com/atproto/sync/subscribeRepos.ts

@@ -59,6 +59,13 @@ export default function (server: Server, ctx: AppContext) {
           time: evt.time,
           ...evt.evt,
         }
+      } else if (evt.type === 'account') {
+        yield {
+          $type: '#account',
+          seq: evt.seq,
+          time: evt.time,
+          ...evt.evt,
+        }
       } else if (evt.type === 'tombstone') {
         yield {
           $type: '#tombstone',

package/src/api/com/atproto/sync/util.ts

@@ -0,0 +1,59 @@
+import { InvalidRequestError } from '@atproto/xrpc-server'
+import {
+  AccountStatus,
+  ActorAccount,
+} from '../../../../account-manager/helpers/account'
+import AppContext from '../../../../context'
+
+export const assertRepoAvailability = async (
+  ctx: AppContext,
+  did: string,
+  isAdminOrSelf: boolean,
+): Promise<ActorAccount> => {
+  const account = await ctx.accountManager.getAccount(did, {
+    includeDeactivated: true,
+    includeTakenDown: true,
+  })
+  if (!account) {
+    throw new InvalidRequestError(
+      `Could not find repo for DID: ${did}`,
+      'RepoNotFound',
+    )
+  }
+  if (isAdminOrSelf) {
+    return account
+  }
+  if (account.takedownRef) {
+    throw new InvalidRequestError(
+      `Repo has been takendown: ${did}`,
+      'RepoTakendown',
+    )
+  }
+  if (account.deactivatedAt) {
+    throw new InvalidRequestError(
+      `Repo has been deactivated: ${did}`,
+      'RepoDeactivated',
+    )
+  }
+  return account
+}
+
+export const formatAccountStatus = (account: {
+  takedownRef: string | null
+  deactivatedAt: string | null
+}): {
+  active: boolean
+  status?: AccountStatus
+} => {
+  let status: AccountStatus | undefined = undefined
+  if (account.takedownRef) {
+    status = AccountStatus.Takendown
+  } else if (account.deactivatedAt) {
+    status = AccountStatus.Deactivated
+  }
+  const active = !status
+  return {
+    active,
+    status,
+  }
+}

package/src/index.ts

@@ -33,6 +33,7 @@ export { createServer as createLexiconServer } from './lexicon'
 export * as sequencer from './sequencer'
 export { type PreparedWrite } from './repo'
 export * as repoPrepare from './repo/prepare'
+export { scripts } from './scripts'
 
 export class PDS {
   public ctx: AppContext

package/src/lexicon/index.ts

@@ -73,6 +73,7 @@ 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'
@@ -1009,6 +1010,17 @@ export class ComAtprotoSyncNS {
     return this._server.xrpc.method(nsid, cfg)
   }
 
+  getRepoStatus<AV extends AuthVerifier>(
+    cfg: ConfigOf<
+      AV,
+      ComAtprotoSyncGetRepoStatus.Handler<ExtractAuth<AV>>,
+      ComAtprotoSyncGetRepoStatus.HandlerReqCtx<ExtractAuth<AV>>
+    >,
+  ) {
+    const nsid = 'com.atproto.sync.getRepoStatus' // @ts-ignore
+    return this._server.xrpc.method(nsid, cfg)
+  }
+
   listBlobs<AV extends AuthVerifier>(
     cfg: ConfigOf<
       AV,

package/src/lexicon/lexicons.ts

@@ -2912,6 +2912,23 @@ export const schemaDict = {
         output: {
           encoding: '*/*',
         },
+        errors: [
+          {
+            name: 'BlobNotFound',
+          },
+          {
+            name: 'RepoNotFound',
+          },
+          {
+            name: 'RepoTakendown',
+          },
+          {
+            name: 'RepoSuspended',
+          },
+          {
+            name: 'RepoDeactivated',
+          },
+        ],
       },
     },
   },
@@ -2944,6 +2961,23 @@ export const schemaDict = {
         output: {
           encoding: 'application/vnd.ipld.car',
         },
+        errors: [
+          {
+            name: 'BlockNotFound',
+          },
+          {
+            name: 'RepoNotFound',
+          },
+          {
+            name: 'RepoTakendown',
+          },
+          {
+            name: 'RepoSuspended',
+          },
+          {
+            name: 'RepoDeactivated',
+          },
+        ],
       },
     },
   },
@@ -3050,6 +3084,15 @@ export const schemaDict = {
           {
             name: 'RepoNotFound',
           },
+          {
+            name: 'RepoTakendown',
+          },
+          {
+            name: 'RepoSuspended',
+          },
+          {
+            name: 'RepoDeactivated',
+          },
         ],
       },
     },
@@ -3090,6 +3133,23 @@ export const schemaDict = {
         output: {
           encoding: 'application/vnd.ipld.car',
         },
+        errors: [
+          {
+            name: 'RecordNotFound',
+          },
+          {
+            name: 'RepoNotFound',
+          },
+          {
+            name: 'RepoTakendown',
+          },
+          {
+            name: 'RepoSuspended',
+          },
+          {
+            name: 'RepoDeactivated',
+          },
+        ],
       },
     },
   },
@@ -3120,6 +3180,74 @@ export const schemaDict = {
         output: {
           encoding: 'application/vnd.ipld.car',
         },
+        errors: [
+          {
+            name: 'RepoNotFound',
+          },
+          {
+            name: 'RepoTakendown',
+          },
+          {
+            name: 'RepoSuspended',
+          },
+          {
+            name: 'RepoDeactivated',
+          },
+        ],
+      },
+    },
+  },
+  ComAtprotoSyncGetRepoStatus: {
+    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 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 possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.',
+                knownValues: ['takendown', 'suspended', 'deactivated'],
+              },
+              rev: {
+                type: 'string',
+                description:
+                  'Optional field, the current rev of the repo, if active=true',
+              },
+            },
+          },
+        },
+        errors: [
+          {
+            name: 'RepoNotFound',
+          },
+        ],
       },
     },
   },
@@ -3174,6 +3302,20 @@ export const schemaDict = {
             },
           },
         },
+        errors: [
+          {
+            name: 'RepoNotFound',
+          },
+          {
+            name: 'RepoTakendown',
+          },
+          {
+            name: 'RepoSuspended',
+          },
+          {
+            name: 'RepoDeactivated',
+          },
+        ],
       },
     },
   },
@@ -3235,6 +3377,15 @@ export const schemaDict = {
           rev: {
             type: 'string',
           },
+          active: {
+            type: 'boolean',
+          },
+          status: {
+            type: 'string',
+            description:
+              'If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.',
+            knownValues: ['takendown', 'suspended', 'deactivated'],
+          },
         },
       },
     },
@@ -3312,6 +3463,7 @@ export const schemaDict = {
             refs: [
               'lex:com.atproto.sync.subscribeRepos#commit',
               'lex:com.atproto.sync.subscribeRepos#identity',
+              'lex:com.atproto.sync.subscribeRepos#account',
               'lex:com.atproto.sync.subscribeRepos#handle',
               'lex:com.atproto.sync.subscribeRepos#migrate',
               'lex:com.atproto.sync.subscribeRepos#tombstone',
@@ -3435,12 +3587,47 @@ export const schemaDict = {
             type: 'string',
             format: 'datetime',
           },
+          handle: {
+            type: 'string',
+            format: 'handle',
+            description:
+              "The current handle for the account, or 'handle.invalid' if validation fails. This field is optional, might have been validated or passed-through from an upstream source. Semantics and behaviors for PDS vs Relay may evolve in the future; see atproto specs for more details.",
+          },
         },
       },
-      handle: {
+      account: {
         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.",
+          "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: ['takendown', 'suspended', 'deleted', 'deactivated'],
+          },
+        },
+      },
+      handle: {
+        type: 'object',
+        description: 'DEPRECATED -- Use #identity event instead',
         required: ['seq', 'did', 'handle', 'time'],
         properties: {
           seq: {
@@ -3462,8 +3649,7 @@ export const schemaDict = {
       },
       migrate: {
         type: 'object',
-        description:
-          'Represents an account moving from one PDS instance to another. NOTE: not implemented; account migration uses #identity instead',
+        description: 'DEPRECATED -- Use #account event instead',
         required: ['seq', 'did', 'migrateTo', 'time'],
         nullable: ['migrateTo'],
         properties: {
@@ -3485,8 +3671,7 @@ export const schemaDict = {
       },
       tombstone: {
         type: 'object',
-        description:
-          'Indicates that an account has been deleted. NOTE: may be deprecated in favor of #identity or a future #account event',
+        description: 'DEPRECATED -- Use #account event instead',
         required: ['seq', 'did', 'time'],
         properties: {
           seq: {
@@ -8379,7 +8564,7 @@ export const schemaDict = {
           },
           embed: {
             type: 'union',
-            refs: ['lex:app.bsky.embed.record'],
+            refs: ['lex:app.bsky.embed.record#view'],
           },
           sender: {
             type: 'ref',
@@ -10624,6 +10809,7 @@ export const ids = {
   ComAtprotoSyncGetLatestCommit: 'com.atproto.sync.getLatestCommit',
   ComAtprotoSyncGetRecord: 'com.atproto.sync.getRecord',
   ComAtprotoSyncGetRepo: 'com.atproto.sync.getRepo',
+  ComAtprotoSyncGetRepoStatus: 'com.atproto.sync.getRepoStatus',
   ComAtprotoSyncListBlobs: 'com.atproto.sync.listBlobs',
   ComAtprotoSyncListRepos: 'com.atproto.sync.listRepos',
   ComAtprotoSyncNotifyOfUpdate: 'com.atproto.sync.notifyOfUpdate',

package/src/lexicon/types/chat/bsky/convo/defs.ts

@@ -54,7 +54,7 @@ export interface MessageView {
   text: string
   /** Annotations of text (mentions, URLs, hashtags, etc) */
   facets?: AppBskyRichtextFacet.Main[]
-  embed?: AppBskyEmbedRecord.Main | { $type: string; [k: string]: unknown }
+  embed?: AppBskyEmbedRecord.View | { $type: string; [k: string]: unknown }
   sender: MessageViewSender
   sentAt: string
   [k: string]: unknown

package/src/lexicon/types/com/atproto/sync/getBlob.ts

@@ -28,6 +28,12 @@ export interface HandlerSuccess {
 export interface HandlerError {
   status: number
   message?: string
+  error?:
+    | 'BlobNotFound'
+    | 'RepoNotFound'
+    | 'RepoTakendown'
+    | 'RepoSuspended'
+    | 'RepoDeactivated'
 }
 
 export type HandlerOutput = HandlerError | HandlerSuccess | HandlerPipeThrough

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

@@ -27,6 +27,12 @@ export interface HandlerSuccess {
 export interface HandlerError {
   status: number
   message?: string
+  error?:
+    | 'BlockNotFound'
+    | 'RepoNotFound'
+    | 'RepoTakendown'
+    | 'RepoSuspended'
+    | 'RepoDeactivated'
 }
 
 export type HandlerOutput = HandlerError | HandlerSuccess | HandlerPipeThrough

package/src/lexicon/types/com/atproto/sync/getLatestCommit.ts

@@ -32,7 +32,7 @@ export interface HandlerSuccess {
 export interface HandlerError {
   status: number
   message?: string
-  error?: 'RepoNotFound'
+  error?: 'RepoNotFound' | 'RepoTakendown' | 'RepoSuspended' | 'RepoDeactivated'
 }
 
 export type HandlerOutput = HandlerError | HandlerSuccess | HandlerPipeThrough

package/src/lexicon/types/com/atproto/sync/getRecord.ts

@@ -31,6 +31,12 @@ export interface HandlerSuccess {
 export interface HandlerError {
   status: number
   message?: string
+  error?:
+    | 'RecordNotFound'
+    | 'RepoNotFound'
+    | 'RepoTakendown'
+    | 'RepoSuspended'
+    | 'RepoDeactivated'
 }
 
 export type HandlerOutput = HandlerError | HandlerSuccess | HandlerPipeThrough

package/src/lexicon/types/com/atproto/sync/getRepo.ts

@@ -28,6 +28,7 @@ export interface HandlerSuccess {
 export interface HandlerError {
   status: number
   message?: string
+  error?: 'RepoNotFound' | 'RepoTakendown' | 'RepoSuspended' | 'RepoDeactivated'
 }
 
 export type HandlerOutput = HandlerError | HandlerSuccess | HandlerPipeThrough