@atproto/bsky 0.0.202 → 0.0.204

package/src/api/app/bsky/contact/util.ts

@@ -1,4 +1,9 @@
-import { MethodNotImplementedError } from '@atproto/xrpc-server'
+import { ConnectError } from '@connectrpc/connect'
+import {
+  InternalServerError,
+  InvalidRequestError,
+  MethodNotImplementedError,
+} from '@atproto/xrpc-server'
 import { AppContext } from '../../../..'
 import { RolodexClient } from '../../../../rolodex'
 
@@ -11,3 +16,77 @@ export function assertRolodexOrThrowUnimplemented(
     )
   }
 }
+
+/**
+ * Converts UPPERCASE_ERROR from Rolodex to PascalCase for XRPC.
+ */
+function convertErrorName(reason: string): string {
+  switch (reason) {
+    case 'INVALID_DID':
+      return 'InvalidDid'
+    case 'INVALID_LIMIT':
+      return 'InvalidLimit'
+    case 'INVALID_CURSOR':
+      return 'InvalidCursor'
+    case 'INVALID_CONTACTS':
+      return 'InvalidContacts'
+    case 'TOO_MANY_CONTACTS':
+      return 'TooManyContacts'
+    case 'INVALID_TOKEN':
+      return 'InvalidToken'
+    case 'RATE_LIMIT_EXCEEDED':
+      return 'RateLimitExceeded'
+    case 'INVALID_PHONE':
+      return 'InvalidPhone'
+    case 'INVALID_CODE':
+      return 'InvalidCode'
+    case 'INTERNAL_ERROR':
+      return 'InternalError'
+    default:
+      return reason
+  }
+}
+
+/**
+ * Helper to call Rolodex client methods and translate RPC errors to XRPC
+ * errors.
+ *
+ * These `reason` values need to stay in sync with the Rolodex service
+ */
+export async function callRolodexClient<T>(caller: T) {
+  try {
+    return await caller
+  } catch (e) {
+    // might be something we want to handle
+    if (e instanceof ConnectError) {
+      /**
+       * https://connectrpc.com/docs/protocol#error-end-stream
+       */
+      const details = e.details?.at(0) as
+        | {
+            debug: {
+              reason: string
+              message: string
+            }
+          }
+        | undefined
+      const reason = details?.debug?.reason // e.g. INVALID_DID
+      // Handle known error reasons
+      if (reason) {
+        const errorName = convertErrorName(reason)
+        // NOTE: Don't leak e.message to the response.
+
+        if (reason === 'INTERNAL_ERROR') {
+          throw new InternalServerError('Upstream error', errorName, {
+            cause: e,
+          })
+        } else {
+          throw new InvalidRequestError('An error occurred', errorName, {
+            cause: e,
+          })
+        }
+      }
+    }
+    throw e
+  }
+}

package/src/api/app/bsky/contact/verifyPhone.ts

@@ -1,6 +1,6 @@
 import { AppContext } from '../../../../context'
 import { Server } from '../../../../lexicon'
-import { assertRolodexOrThrowUnimplemented } from './util'
+import { assertRolodexOrThrowUnimplemented, callRolodexClient } from './util'
 
 export default function (server: Server, ctx: AppContext) {
   server.app.bsky.contact.verifyPhone({
@@ -9,12 +9,13 @@ export default function (server: Server, ctx: AppContext) {
       assertRolodexOrThrowUnimplemented(ctx)
 
       const actor = auth.credentials.iss
-      // TODO: Error handling.
-      const res = await ctx.rolodexClient.verifyPhone({
-        actor,
-        verificationCode: input.body.code,
-        phone: input.body.phone,
-      })
+      const res = await callRolodexClient(
+        ctx.rolodexClient.verifyPhone({
+          actor,
+          verificationCode: input.body.code,
+          phone: input.body.phone,
+        }),
+      )
 
       return {
         encoding: 'application/json',

package/src/api/index.ts

@@ -16,6 +16,7 @@ import getMatches from './app/bsky/contact/getMatches'
 import getSyncStatus from './app/bsky/contact/getSyncStatus'
 import importContacts from './app/bsky/contact/importContacts'
 import removeData from './app/bsky/contact/removeData'
+import sendNotification from './app/bsky/contact/sendNotification'
 import startPhoneVerification from './app/bsky/contact/startPhoneVerification'
 import verifyPhone from './app/bsky/contact/verifyPhone'
 import getActorFeeds from './app/bsky/feed/getActorFeeds'
@@ -108,6 +109,7 @@ export default function (server: Server, ctx: AppContext) {
   getSyncStatus(server, ctx)
   importContacts(server, ctx)
   removeData(server, ctx)
+  sendNotification(server, ctx)
   startPhoneVerification(server, ctx)
   verifyPhone(server, ctx)
   getActorFeeds(server, ctx)

package/src/hydration/actor.ts

@@ -273,7 +273,7 @@ export class ActorHydrator {
     includeTakedowns = false,
   ): Promise<NotificationDeclarations> {
     if (!uris.length) return new HydrationMap<NotificationDeclaration>()
-    const res = await this.dataplane.getActorChatDeclarationRecords({ uris })
+    const res = await this.dataplane.getNotificationDeclarationRecords({ uris })
     return uris.reduce((acc, uri, i) => {
       const record = parseRecord<NotificationDeclarationRecord>(
         res.records[i],

package/src/lexicon/lexicons.ts

@@ -1826,7 +1826,7 @@ export const schemaDict = {
       main: {
         type: 'procedure',
         description:
-          "WARNING: This is unstable and under active development, don't use it while this warning is here. Removes a match that was found via contact import. It shouldn't appear again if the same contact is re-imported. Requires authentication.",
+          "Removes a match that was found via contact import. It shouldn't appear again if the same contact is re-imported. Requires authentication.",
         input: {
           encoding: 'application/json',
           schema: {
@@ -1850,8 +1850,10 @@ export const schemaDict = {
         },
         errors: [
           {
-            name: 'TODO',
-            description: 'TODO',
+            name: 'InvalidDid',
+          },
+          {
+            name: 'InternalError',
           },
         ],
       },
@@ -1864,7 +1866,7 @@ export const schemaDict = {
       main: {
         type: 'query',
         description:
-          "WARNING: This is unstable and under active development, don't use it while this warning is here. Returns the matched contacts (contacts that were mutually imported). Excludes dismissed matches. Requires authentication.",
+          'Returns the matched contacts (contacts that were mutually imported). Excludes dismissed matches. Requires authentication.',
         parameters: {
           type: 'params',
           properties: {
@@ -1900,8 +1902,16 @@ export const schemaDict = {
         },
         errors: [
           {
-            name: 'TODO',
-            description: 'TODO',
+            name: 'InvalidDid',
+          },
+          {
+            name: 'InvalidLimit',
+          },
+          {
+            name: 'InvalidCursor',
+          },
+          {
+            name: 'InternalError',
           },
         ],
       },
@@ -1914,7 +1924,7 @@ export const schemaDict = {
       main: {
         type: 'query',
         description:
-          "WARNING: This is unstable and under active development, don't use it while this warning is here. Gets the user's current contact import status. Requires authentication.",
+          "Gets the user's current contact import status. Requires authentication.",
         parameters: {
           type: 'params',
           properties: {},
@@ -1935,8 +1945,10 @@ export const schemaDict = {
         },
         errors: [
           {
-            name: 'TODO',
-            description: 'TODO',
+            name: 'InvalidDid',
+          },
+          {
+            name: 'InternalError',
           },
         ],
       },
@@ -1949,7 +1961,7 @@ export const schemaDict = {
       main: {
         type: 'procedure',
         description:
-          "WARNING: This is unstable and under active development, don't use it while this warning is here. Import contacts for securely matching with other users. This follows the protocol explained in https://docs.bsky.app/blog/contact-import-rfc. Requires authentication.",
+          'Import contacts for securely matching with other users. This follows the protocol explained in https://docs.bsky.app/blog/contact-import-rfc. Requires authentication.',
         input: {
           encoding: 'application/json',
           schema: {
@@ -1994,8 +2006,19 @@ export const schemaDict = {
         },
         errors: [
           {
-            name: 'TODO',
-            description: 'TODO',
+            name: 'InvalidDid',
+          },
+          {
+            name: 'InvalidContacts',
+          },
+          {
+            name: 'TooManyContacts',
+          },
+          {
+            name: 'InvalidToken',
+          },
+          {
+            name: 'InternalError',
           },
         ],
       },
@@ -2008,7 +2031,7 @@ export const schemaDict = {
       main: {
         type: 'procedure',
         description:
-          "WARNING: This is unstable and under active development, don't use it while this warning is here. Removes all stored hashes used for contact matching, existing matches, and sync status. Requires authentication.",
+          'Removes all stored hashes used for contact matching, existing matches, and sync status. Requires authentication.',
         input: {
           encoding: 'application/json',
           schema: {
@@ -2025,8 +2048,10 @@ export const schemaDict = {
         },
         errors: [
           {
-            name: 'TODO',
-            description: 'TODO',
+            name: 'InvalidDid',
+          },
+          {
+            name: 'InternalError',
           },
         ],
       },
@@ -2039,7 +2064,7 @@ export const schemaDict = {
       main: {
         type: 'procedure',
         description:
-          "WARNING: This is unstable and under active development, don't use it while this warning is here. System endpoint to send notifications related to contact imports. Requires role authentication.",
+          'System endpoint to send notifications related to contact imports. Requires role authentication.',
         input: {
           encoding: 'application/json',
           schema: {
@@ -2076,7 +2101,7 @@ export const schemaDict = {
       main: {
         type: 'procedure',
         description:
-          "WARNING: This is unstable and under active development, don't use it while this warning is here. Starts a phone verification flow. The phone passed will receive a code via SMS that should be passed to `app.bsky.contact.verifyPhone`. Requires authentication.",
+          'Starts a phone verification flow. The phone passed will receive a code via SMS that should be passed to `app.bsky.contact.verifyPhone`. Requires authentication.',
         input: {
           encoding: 'application/json',
           schema: {
@@ -2099,8 +2124,16 @@ export const schemaDict = {
         },
         errors: [
           {
-            name: 'TODO',
-            description: 'TODO',
+            name: 'RateLimitExceeded',
+          },
+          {
+            name: 'InvalidDid',
+          },
+          {
+            name: 'InvalidPhone',
+          },
+          {
+            name: 'InternalError',
           },
         ],
       },
@@ -2113,7 +2146,7 @@ export const schemaDict = {
       main: {
         type: 'procedure',
         description:
-          "WARNING: This is unstable and under active development, don't use it while this warning is here. Verifies control over a phone number with a code received via SMS and starts a contact import session. Requires authentication.",
+          'Verifies control over a phone number with a code received via SMS and starts a contact import session. Requires authentication.',
         input: {
           encoding: 'application/json',
           schema: {
@@ -2149,8 +2182,19 @@ export const schemaDict = {
         },
         errors: [
           {
-            name: 'TODO',
-            description: 'TODO',
+            name: 'RateLimitExceeded',
+          },
+          {
+            name: 'InvalidDid',
+          },
+          {
+            name: 'InvalidPhone',
+          },
+          {
+            name: 'InvalidCode',
+          },
+          {
+            name: 'InternalError',
           },
         ],
       },
@@ -12975,7 +13019,16 @@ export const schemaDict = {
     defs: {
       main: {
         type: 'procedure',
-        description: 'Delete the current session. Requires auth.',
+        description:
+          "Delete the current session. Requires auth using the 'refreshJwt' (not the 'accessJwt').",
+        errors: [
+          {
+            name: 'InvalidToken',
+          },
+          {
+            name: 'ExpiredToken',
+          },
+        ],
       },
     },
   },
@@ -13174,6 +13227,9 @@ export const schemaDict = {
                 type: 'string',
                 format: 'did',
               },
+              didDoc: {
+                type: 'unknown',
+              },
               email: {
                 type: 'string',
               },
@@ -13183,9 +13239,6 @@ export const schemaDict = {
               emailAuthFactor: {
                 type: 'boolean',
               },
-              didDoc: {
-                type: 'unknown',
-              },
               active: {
                 type: 'boolean',
               },
@@ -13279,6 +13332,15 @@ export const schemaDict = {
               didDoc: {
                 type: 'unknown',
               },
+              email: {
+                type: 'string',
+              },
+              emailConfirmed: {
+                type: 'boolean',
+              },
+              emailAuthFactor: {
+                type: 'boolean',
+              },
               active: {
                 type: 'boolean',
               },
@@ -13295,6 +13357,12 @@ export const schemaDict = {
           {
             name: 'AccountTakedown',
           },
+          {
+            name: 'InvalidToken',
+          },
+          {
+            name: 'ExpiredToken',
+          },
         ],
       },
     },

package/src/lexicon/types/app/bsky/contact/dismissMatch.ts

@@ -37,7 +37,7 @@ export interface HandlerSuccess {
 export interface HandlerError {
   status: number
   message?: string
-  error?: 'TODO'
+  error?: 'InvalidDid' | 'InternalError'
 }
 
 export type HandlerOutput = HandlerError | HandlerSuccess

package/src/lexicon/types/app/bsky/contact/getMatches.ts

@@ -37,7 +37,7 @@ export interface HandlerSuccess {
 export interface HandlerError {
   status: number
   message?: string
-  error?: 'TODO'
+  error?: 'InvalidDid' | 'InvalidLimit' | 'InvalidCursor' | 'InternalError'
 }
 
 export type HandlerOutput = HandlerError | HandlerSuccess

package/src/lexicon/types/app/bsky/contact/getSyncStatus.ts

@@ -33,7 +33,7 @@ export interface HandlerSuccess {
 export interface HandlerError {
   status: number
   message?: string
-  error?: 'TODO'
+  error?: 'InvalidDid' | 'InternalError'
 }
 
 export type HandlerOutput = HandlerError | HandlerSuccess

package/src/lexicon/types/app/bsky/contact/importContacts.ts

@@ -43,7 +43,12 @@ export interface HandlerSuccess {
 export interface HandlerError {
   status: number
   message?: string
-  error?: 'TODO'
+  error?:
+    | 'InvalidDid'
+    | 'InvalidContacts'
+    | 'TooManyContacts'
+    | 'InvalidToken'
+    | 'InternalError'
 }
 
 export type HandlerOutput = HandlerError | HandlerSuccess

package/src/lexicon/types/app/bsky/contact/removeData.ts

@@ -34,7 +34,7 @@ export interface HandlerSuccess {
 export interface HandlerError {
   status: number
   message?: string
-  error?: 'TODO'
+  error?: 'InvalidDid' | 'InternalError'
 }
 
 export type HandlerOutput = HandlerError | HandlerSuccess

package/src/lexicon/types/app/bsky/contact/startPhoneVerification.ts

@@ -37,7 +37,7 @@ export interface HandlerSuccess {
 export interface HandlerError {
   status: number
   message?: string
-  error?: 'TODO'
+  error?: 'RateLimitExceeded' | 'InvalidDid' | 'InvalidPhone' | 'InternalError'
 }
 
 export type HandlerOutput = HandlerError | HandlerSuccess

package/src/lexicon/types/app/bsky/contact/verifyPhone.ts

@@ -42,7 +42,12 @@ export interface HandlerSuccess {
 export interface HandlerError {
   status: number
   message?: string
-  error?: 'TODO'
+  error?:
+    | 'RateLimitExceeded'
+    | 'InvalidDid'
+    | 'InvalidPhone'
+    | 'InvalidCode'
+    | 'InternalError'
 }
 
 export type HandlerOutput = HandlerError | HandlerSuccess

package/src/lexicon/types/com/atproto/server/deleteSession.ts

@@ -21,6 +21,7 @@ export type HandlerInput = void
 export interface HandlerError {
   status: number
   message?: string
+  error?: 'InvalidToken' | 'ExpiredToken'
 }
 
 export type HandlerOutput = HandlerError | void

package/src/lexicon/types/com/atproto/server/getSession.ts

@@ -20,10 +20,10 @@ export type InputSchema = undefined
 export interface OutputSchema {
   handle: string
   did: string
+  didDoc?: { [_ in string]: unknown }
   email?: string
   emailConfirmed?: boolean
   emailAuthFactor?: boolean
-  didDoc?: { [_ in string]: unknown }
   active?: boolean
   /** 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. */
   status?: 'takendown' | 'suspended' | 'deactivated' | (string & {})

package/src/lexicon/types/com/atproto/server/refreshSession.ts

@@ -23,6 +23,9 @@ export interface OutputSchema {
   handle: string
   did: string
   didDoc?: { [_ in string]: unknown }
+  email?: string
+  emailConfirmed?: boolean
+  emailAuthFactor?: boolean
   active?: boolean
   /** Hosting status of the account. If not specified, then assume 'active'. */
   status?: 'takendown' | 'suspended' | 'deactivated' | (string & {})
@@ -39,7 +42,7 @@ export interface HandlerSuccess {
 export interface HandlerError {
   status: number
   message?: string
-  error?: 'AccountTakedown'
+  error?: 'AccountTakedown' | 'InvalidToken' | 'ExpiredToken'
 }
 
 export type HandlerOutput = HandlerError | HandlerSuccess