@atproto/bsky 0.0.171 → 0.0.173

package/src/api/app/bsky/unspecced/initAgeAssurance.ts

@@ -8,7 +8,10 @@ import {
 } from '@atproto/xrpc-server'
 import { AppContext } from '../../../../context'
 import { GateID } from '../../../../feature-gates'
+import { KwsExternalPayloadError } from '../../../../kws'
 import { Server } from '../../../../lexicon'
+import { InputSchema } from '../../../../lexicon/types/app/bsky/unspecced/initAgeAssurance'
+import { httpLogger as log } from '../../../../logger'
 import { KwsExternalPayload } from '../../../kws/types'
 import { createStashEvent, getClientUa } from '../../../kws/util'
 
@@ -30,12 +33,7 @@ export default function (server: Server, ctx: AppContext) {
         throw new ForbiddenError()
       }
 
-      const { email, language, countryCode } = input.body
-      if (!isEmailValid(email) || isDisposableEmail(email)) {
-        throw new InvalidRequestError(
-          'This email address is not supported, please use a different email.',
-        )
-      }
+      const { countryCode, email, language } = validateInput(input.body)
 
       const attemptId = crypto.randomUUID()
       // Assumes `app.set('trust proxy', ...)` configured with `true` or specific values.
@@ -43,12 +41,26 @@ export default function (server: Server, ctx: AppContext) {
       const initUa = getClientUa(req)
       const externalPayload: KwsExternalPayload = { actorDid, attemptId }
 
-      await ctx.kwsClient.sendEmail({
-        countryCode,
-        email,
-        externalPayload,
-        language,
-      })
+      try {
+        await ctx.kwsClient.sendEmail({
+          countryCode: countryCode.toUpperCase(),
+          email,
+          externalPayload,
+          language,
+        })
+      } catch (err) {
+        if (err instanceof KwsExternalPayloadError) {
+          log.error(
+            { externalPayload },
+            'Age Assurance flow failed because external payload got too long, which is caused by the DID being too long',
+          )
+          throw new InvalidRequestError(
+            'Age Assurance flow failed because DID is too long',
+            'DidTooLong',
+          )
+        }
+        throw err
+      }
 
       const event = await createStashEvent(ctx, {
         actorDid,
@@ -69,3 +81,44 @@ export default function (server: Server, ctx: AppContext) {
     },
   })
 }
+
+// Supported languages for KWS Adult Verification.
+// This list comes from KWS's AV Developer Guide PDF doc.
+const kwsAvSupportedLanguages = [
+  'en',
+  'ar',
+  'zh-Hans',
+  'nl',
+  'tl',
+  'fr',
+  'de',
+  'id',
+  'it',
+  'ja',
+  'ko',
+  'pl',
+  'pt-BR',
+  'pt',
+  'ru',
+  'es',
+  'th',
+  'tr',
+  'vi',
+]
+
+const validateInput = (input: InputSchema): InputSchema => {
+  const { countryCode, email, language } = input
+
+  if (!isEmailValid(email) || isDisposableEmail(email)) {
+    throw new InvalidRequestError(
+      'This email address is not supported, please use a different email.',
+      'InvalidEmail',
+    )
+  }
+
+  return {
+    countryCode,
+    email,
+    language: kwsAvSupportedLanguages.includes(language) ? language : 'en',
+  }
+}

package/src/config.ts

@@ -242,7 +242,7 @@ export class ServerConfig {
     const kwsRedirectUrl = process.env.BSKY_KWS_REDIRECT_URL
     const kwsUserAgent = process.env.BSKY_KWS_USER_AGENT
     const kwsVerificationSecret = process.env.BSKY_KWS_VERIFICATION_SECRET
-    const kwsWebhookSecret = process.env.BSKY_KWS_WEBHOOK_SIGNING_KEY
+    const kwsWebhookSecret = process.env.BSKY_KWS_WEBHOOK_SECRET
     if (
       kwsApiKey ||
       kwsApiOrigin ||

package/src/kws.ts

@@ -14,6 +14,9 @@ const authResponseSchema = z.object({
   access_token: z.string(),
 })
 
+const EXTERNAL_PAYLOAD_CHAR_LIMIT = 200
+export class KwsExternalPayloadError extends Error {}
+
 export class KwsClient {
   constructor(public cfg: KwsConfig) {}
 
@@ -76,6 +79,11 @@ export class KwsClient {
     externalPayload: KwsExternalPayload
     language: string
   }) {
+    const serializedExternalPayload = serializeExternalPayload(externalPayload)
+    if (serializedExternalPayload.length > EXTERNAL_PAYLOAD_CHAR_LIMIT) {
+      throw new KwsExternalPayloadError()
+    }
+
     const res = await this.fetchWithAuth(
       `${this.cfg.apiOrigin}/v1/verifications/send-email`,
       {
@@ -86,7 +94,7 @@ export class KwsClient {
         },
         body: JSON.stringify({
           email,
-          externalPayload: serializeExternalPayload(externalPayload),
+          externalPayload: serializedExternalPayload,
           language,
           location: countryCode,
           userContext: 'adult',

package/src/lexicon/index.ts

@@ -147,6 +147,7 @@ import * as AppBskyNotificationPutActivitySubscription from './types/app/bsky/no
 import * as AppBskyNotificationPutPreferences from './types/app/bsky/notification/putPreferences.js'
 import * as AppBskyNotificationPutPreferencesV2 from './types/app/bsky/notification/putPreferencesV2.js'
 import * as AppBskyNotificationRegisterPush from './types/app/bsky/notification/registerPush.js'
+import * as AppBskyNotificationUnregisterPush from './types/app/bsky/notification/unregisterPush.js'
 import * as AppBskyNotificationUpdateSeen from './types/app/bsky/notification/updateSeen.js'
 import * as AppBskyUnspeccedGetAgeAssuranceState from './types/app/bsky/unspecced/getAgeAssuranceState.js'
 import * as AppBskyUnspeccedGetConfig from './types/app/bsky/unspecced/getConfig.js'
@@ -2079,6 +2080,18 @@ export class AppBskyNotificationNS {
     return this._server.xrpc.method(nsid, cfg)
   }
 
+  unregisterPush<A extends Auth = void>(
+    cfg: MethodConfigOrHandler<
+      A,
+      AppBskyNotificationUnregisterPush.QueryParams,
+      AppBskyNotificationUnregisterPush.HandlerInput,
+      AppBskyNotificationUnregisterPush.HandlerOutput
+    >,
+  ) {
+    const nsid = 'app.bsky.notification.unregisterPush' // @ts-ignore
+    return this._server.xrpc.method(nsid, cfg)
+  }
+
   updateSeen<A extends Auth = void>(
     cfg: MethodConfigOrHandler<
       A,

package/src/lexicon/lexicons.ts

@@ -10372,6 +10372,40 @@ export const schemaDict = {
       },
     },
   },
+  AppBskyNotificationUnregisterPush: {
+    lexicon: 1,
+    id: 'app.bsky.notification.unregisterPush',
+    defs: {
+      main: {
+        type: 'procedure',
+        description:
+          'The inverse of registerPush - inform a specified service that push notifications should no longer be sent to the given token for the requesting account. Requires auth.',
+        input: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['serviceDid', 'token', 'platform', 'appId'],
+            properties: {
+              serviceDid: {
+                type: 'string',
+                format: 'did',
+              },
+              token: {
+                type: 'string',
+              },
+              platform: {
+                type: 'string',
+                knownValues: ['ios', 'android', 'web'],
+              },
+              appId: {
+                type: 'string',
+              },
+            },
+          },
+        },
+      },
+    },
+  },
   AppBskyNotificationUpdateSeen: {
     lexicon: 1,
     id: 'app.bsky.notification.updateSeen',
@@ -11555,6 +11589,14 @@ export const schemaDict = {
             ref: 'lex:app.bsky.unspecced.defs#ageAssuranceState',
           },
         },
+        errors: [
+          {
+            name: 'InvalidEmail',
+          },
+          {
+            name: 'DidTooLong',
+          },
+        ],
       },
     },
   },
@@ -13485,6 +13527,7 @@ export const ids = {
   AppBskyNotificationPutPreferences: 'app.bsky.notification.putPreferences',
   AppBskyNotificationPutPreferencesV2: 'app.bsky.notification.putPreferencesV2',
   AppBskyNotificationRegisterPush: 'app.bsky.notification.registerPush',
+  AppBskyNotificationUnregisterPush: 'app.bsky.notification.unregisterPush',
   AppBskyNotificationUpdateSeen: 'app.bsky.notification.updateSeen',
   AppBskyRichtextFacet: 'app.bsky.richtext.facet',
   AppBskyUnspeccedDefs: 'app.bsky.unspecced.defs',

package/src/lexicon/types/app/bsky/notification/unregisterPush.ts

@@ -0,0 +1,36 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { type ValidationResult, BlobRef } from '@atproto/lexicon'
+import { CID } from 'multiformats/cid'
+import { validate as _validate } from '../../../../lexicons'
+import {
+  type $Typed,
+  is$typed as _is$typed,
+  type OmitKey,
+} from '../../../../util'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'app.bsky.notification.unregisterPush'
+
+export type QueryParams = {}
+
+export interface InputSchema {
+  serviceDid: string
+  token: string
+  platform: 'ios' | 'android' | 'web' | (string & {})
+  appId: string
+}
+
+export interface HandlerInput {
+  encoding: 'application/json'
+  body: InputSchema
+}
+
+export interface HandlerError {
+  status: number
+  message?: string
+}
+
+export type HandlerOutput = HandlerError | void

package/src/lexicon/types/app/bsky/unspecced/initAgeAssurance.ts

@@ -42,6 +42,7 @@ export interface HandlerSuccess {
 export interface HandlerError {
   status: number
   message?: string
+  error?: 'InvalidEmail' | 'DidTooLong'
 }
 
 export type HandlerOutput = HandlerError | HandlerSuccess

package/src/proto/bsky_pb.ts

@@ -5752,6 +5752,11 @@ export class AgeAssuranceStatus extends Message<AgeAssuranceStatus> {
    */
   lastInitiatedAt?: Timestamp
 
+  /**
+   * @generated from field: bool override_applied = 3;
+   */
+  overrideApplied = false
+
   constructor(data?: PartialMessage<AgeAssuranceStatus>) {
     super()
     proto3.util.initPartial(data, this)
@@ -5762,6 +5767,12 @@ export class AgeAssuranceStatus extends Message<AgeAssuranceStatus> {
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: 'status', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
     { no: 2, name: 'last_initiated_at', kind: 'message', T: Timestamp },
+    {
+      no: 3,
+      name: 'override_applied',
+      kind: 'scalar',
+      T: 8 /* ScalarType.BOOL */,
+    },
   ])
 
   static fromBinary(

package/src/proto/courier_connect.ts

@@ -10,6 +10,10 @@ import {
   PushNotificationsResponse,
   RegisterDeviceTokenRequest,
   RegisterDeviceTokenResponse,
+  SetAgeRestrictedRequest,
+  SetAgeRestrictedResponse,
+  UnregisterDeviceTokenRequest,
+  UnregisterDeviceTokenResponse,
 } from './courier_pb'
 import { MethodKind } from '@bufbuild/protobuf'
 
@@ -46,5 +50,23 @@ export const Service = {
       O: RegisterDeviceTokenResponse,
       kind: MethodKind.Unary,
     },
+    /**
+     * @generated from rpc courier.Service.UnregisterDeviceToken
+     */
+    unregisterDeviceToken: {
+      name: 'UnregisterDeviceToken',
+      I: UnregisterDeviceTokenRequest,
+      O: UnregisterDeviceTokenResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc courier.Service.SetAgeRestricted
+     */
+    setAgeRestricted: {
+      name: 'SetAgeRestricted',
+      I: SetAgeRestrictedRequest,
+      O: SetAgeRestrictedResponse,
+      kind: MethodKind.Unary,
+    },
   },
 } as const

package/src/proto/courier_pb.ts

@@ -493,3 +493,249 @@ export class RegisterDeviceTokenResponse extends Message<RegisterDeviceTokenResp
     return proto3.util.equals(RegisterDeviceTokenResponse, a, b)
   }
 }
+
+/**
+ * @generated from message courier.UnregisterDeviceTokenRequest
+ */
+export class UnregisterDeviceTokenRequest extends Message<UnregisterDeviceTokenRequest> {
+  /**
+   * @generated from field: string did = 1;
+   */
+  did = ''
+
+  /**
+   * @generated from field: string token = 2;
+   */
+  token = ''
+
+  /**
+   * @generated from field: string app_id = 3;
+   */
+  appId = ''
+
+  /**
+   * @generated from field: courier.AppPlatform platform = 4;
+   */
+  platform = AppPlatform.UNSPECIFIED
+
+  constructor(data?: PartialMessage<UnregisterDeviceTokenRequest>) {
+    super()
+    proto3.util.initPartial(data, this)
+  }
+
+  static readonly runtime: typeof proto3 = proto3
+  static readonly typeName = 'courier.UnregisterDeviceTokenRequest'
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: 'did', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: 'token', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: 'app_id', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    {
+      no: 4,
+      name: 'platform',
+      kind: 'enum',
+      T: proto3.getEnumType(AppPlatform),
+    },
+  ])
+
+  static fromBinary(
+    bytes: Uint8Array,
+    options?: Partial<BinaryReadOptions>,
+  ): UnregisterDeviceTokenRequest {
+    return new UnregisterDeviceTokenRequest().fromBinary(bytes, options)
+  }
+
+  static fromJson(
+    jsonValue: JsonValue,
+    options?: Partial<JsonReadOptions>,
+  ): UnregisterDeviceTokenRequest {
+    return new UnregisterDeviceTokenRequest().fromJson(jsonValue, options)
+  }
+
+  static fromJsonString(
+    jsonString: string,
+    options?: Partial<JsonReadOptions>,
+  ): UnregisterDeviceTokenRequest {
+    return new UnregisterDeviceTokenRequest().fromJsonString(
+      jsonString,
+      options,
+    )
+  }
+
+  static equals(
+    a:
+      | UnregisterDeviceTokenRequest
+      | PlainMessage<UnregisterDeviceTokenRequest>
+      | undefined,
+    b:
+      | UnregisterDeviceTokenRequest
+      | PlainMessage<UnregisterDeviceTokenRequest>
+      | undefined,
+  ): boolean {
+    return proto3.util.equals(UnregisterDeviceTokenRequest, a, b)
+  }
+}
+
+/**
+ * @generated from message courier.UnregisterDeviceTokenResponse
+ */
+export class UnregisterDeviceTokenResponse extends Message<UnregisterDeviceTokenResponse> {
+  constructor(data?: PartialMessage<UnregisterDeviceTokenResponse>) {
+    super()
+    proto3.util.initPartial(data, this)
+  }
+
+  static readonly runtime: typeof proto3 = proto3
+  static readonly typeName = 'courier.UnregisterDeviceTokenResponse'
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [])
+
+  static fromBinary(
+    bytes: Uint8Array,
+    options?: Partial<BinaryReadOptions>,
+  ): UnregisterDeviceTokenResponse {
+    return new UnregisterDeviceTokenResponse().fromBinary(bytes, options)
+  }
+
+  static fromJson(
+    jsonValue: JsonValue,
+    options?: Partial<JsonReadOptions>,
+  ): UnregisterDeviceTokenResponse {
+    return new UnregisterDeviceTokenResponse().fromJson(jsonValue, options)
+  }
+
+  static fromJsonString(
+    jsonString: string,
+    options?: Partial<JsonReadOptions>,
+  ): UnregisterDeviceTokenResponse {
+    return new UnregisterDeviceTokenResponse().fromJsonString(
+      jsonString,
+      options,
+    )
+  }
+
+  static equals(
+    a:
+      | UnregisterDeviceTokenResponse
+      | PlainMessage<UnregisterDeviceTokenResponse>
+      | undefined,
+    b:
+      | UnregisterDeviceTokenResponse
+      | PlainMessage<UnregisterDeviceTokenResponse>
+      | undefined,
+  ): boolean {
+    return proto3.util.equals(UnregisterDeviceTokenResponse, a, b)
+  }
+}
+
+/**
+ * @generated from message courier.SetAgeRestrictedRequest
+ */
+export class SetAgeRestrictedRequest extends Message<SetAgeRestrictedRequest> {
+  /**
+   * @generated from field: string did = 1;
+   */
+  did = ''
+
+  /**
+   * @generated from field: bool age_restricted = 2;
+   */
+  ageRestricted = false
+
+  constructor(data?: PartialMessage<SetAgeRestrictedRequest>) {
+    super()
+    proto3.util.initPartial(data, this)
+  }
+
+  static readonly runtime: typeof proto3 = proto3
+  static readonly typeName = 'courier.SetAgeRestrictedRequest'
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: 'did', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    {
+      no: 2,
+      name: 'age_restricted',
+      kind: 'scalar',
+      T: 8 /* ScalarType.BOOL */,
+    },
+  ])
+
+  static fromBinary(
+    bytes: Uint8Array,
+    options?: Partial<BinaryReadOptions>,
+  ): SetAgeRestrictedRequest {
+    return new SetAgeRestrictedRequest().fromBinary(bytes, options)
+  }
+
+  static fromJson(
+    jsonValue: JsonValue,
+    options?: Partial<JsonReadOptions>,
+  ): SetAgeRestrictedRequest {
+    return new SetAgeRestrictedRequest().fromJson(jsonValue, options)
+  }
+
+  static fromJsonString(
+    jsonString: string,
+    options?: Partial<JsonReadOptions>,
+  ): SetAgeRestrictedRequest {
+    return new SetAgeRestrictedRequest().fromJsonString(jsonString, options)
+  }
+
+  static equals(
+    a:
+      | SetAgeRestrictedRequest
+      | PlainMessage<SetAgeRestrictedRequest>
+      | undefined,
+    b:
+      | SetAgeRestrictedRequest
+      | PlainMessage<SetAgeRestrictedRequest>
+      | undefined,
+  ): boolean {
+    return proto3.util.equals(SetAgeRestrictedRequest, a, b)
+  }
+}
+
+/**
+ * @generated from message courier.SetAgeRestrictedResponse
+ */
+export class SetAgeRestrictedResponse extends Message<SetAgeRestrictedResponse> {
+  constructor(data?: PartialMessage<SetAgeRestrictedResponse>) {
+    super()
+    proto3.util.initPartial(data, this)
+  }
+
+  static readonly runtime: typeof proto3 = proto3
+  static readonly typeName = 'courier.SetAgeRestrictedResponse'
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [])
+
+  static fromBinary(
+    bytes: Uint8Array,
+    options?: Partial<BinaryReadOptions>,
+  ): SetAgeRestrictedResponse {
+    return new SetAgeRestrictedResponse().fromBinary(bytes, options)
+  }
+
+  static fromJson(
+    jsonValue: JsonValue,
+    options?: Partial<JsonReadOptions>,
+  ): SetAgeRestrictedResponse {
+    return new SetAgeRestrictedResponse().fromJson(jsonValue, options)
+  }
+
+  static fromJsonString(
+    jsonString: string,
+    options?: Partial<JsonReadOptions>,
+  ): SetAgeRestrictedResponse {
+    return new SetAgeRestrictedResponse().fromJsonString(jsonString, options)
+  }
+
+  static equals(
+    a:
+      | SetAgeRestrictedResponse
+      | PlainMessage<SetAgeRestrictedResponse>
+      | undefined,
+    b:
+      | SetAgeRestrictedResponse
+      | PlainMessage<SetAgeRestrictedResponse>
+      | undefined,
+  ): boolean {
+    return proto3.util.equals(SetAgeRestrictedResponse, a, b)
+  }
+}