@atproto/bsky 0.0.173 → 0.0.174

package/src/lexicon/lexicons.ts

@@ -7282,6 +7282,48 @@ export const schemaDict = {
       },
     },
   },
+  AppBskyFeedGetPosts: {
+    lexicon: 1,
+    id: 'app.bsky.feed.getPosts',
+    defs: {
+      main: {
+        type: 'query',
+        description:
+          "Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'.",
+        parameters: {
+          type: 'params',
+          required: ['uris'],
+          properties: {
+            uris: {
+              type: 'array',
+              description: 'List of post AT-URIs to return hydrated views for.',
+              items: {
+                type: 'string',
+                format: 'at-uri',
+              },
+              maxLength: 25,
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['posts'],
+            properties: {
+              posts: {
+                type: 'array',
+                items: {
+                  type: 'ref',
+                  ref: 'lex:app.bsky.feed.defs#postView',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
   AppBskyFeedGetPostThread: {
     lexicon: 1,
     id: 'app.bsky.feed.getPostThread',
@@ -7346,48 +7388,6 @@ export const schemaDict = {
       },
     },
   },
-  AppBskyFeedGetPosts: {
-    lexicon: 1,
-    id: 'app.bsky.feed.getPosts',
-    defs: {
-      main: {
-        type: 'query',
-        description:
-          "Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'.",
-        parameters: {
-          type: 'params',
-          required: ['uris'],
-          properties: {
-            uris: {
-              type: 'array',
-              description: 'List of post AT-URIs to return hydrated views for.',
-              items: {
-                type: 'string',
-                format: 'at-uri',
-              },
-              maxLength: 25,
-            },
-          },
-        },
-        output: {
-          encoding: 'application/json',
-          schema: {
-            type: 'object',
-            required: ['posts'],
-            properties: {
-              posts: {
-                type: 'array',
-                items: {
-                  type: 'ref',
-                  ref: 'lex:app.bsky.feed.defs#postView',
-                },
-              },
-            },
-          },
-        },
-      },
-    },
-  },
   AppBskyFeedGetQuotes: {
     lexicon: 1,
     id: 'app.bsky.feed.getQuotes',
@@ -10511,6 +10511,104 @@ export const schemaDict = {
       },
     },
   },
+  AppBskyUnspeccedCheckHandleAvailability: {
+    lexicon: 1,
+    id: 'app.bsky.unspecced.checkHandleAvailability',
+    defs: {
+      main: {
+        type: 'query',
+        description:
+          'Checks whether the provided handle is available. If the handle is not available, available suggestions will be returned. Optional inputs will be used to generate suggestions.',
+        parameters: {
+          type: 'params',
+          required: ['handle'],
+          properties: {
+            handle: {
+              type: 'string',
+              format: 'handle',
+              description:
+                'Tentative handle. Will be checked for availability or used to build handle suggestions.',
+            },
+            email: {
+              type: 'string',
+              description:
+                'User-provided email. Might be used to build handle suggestions.',
+            },
+            birthDate: {
+              type: 'string',
+              format: 'datetime',
+              description:
+                'User-provided birth date. Might be used to build handle suggestions.',
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['handle', 'result'],
+            properties: {
+              handle: {
+                type: 'string',
+                format: 'handle',
+                description: 'Echo of the input handle.',
+              },
+              result: {
+                type: 'union',
+                refs: [
+                  'lex:app.bsky.unspecced.checkHandleAvailability#resultAvailable',
+                  'lex:app.bsky.unspecced.checkHandleAvailability#resultUnavailable',
+                ],
+              },
+            },
+          },
+        },
+        errors: [
+          {
+            name: 'InvalidEmail',
+            description: 'An invalid email was provided.',
+          },
+        ],
+      },
+      resultAvailable: {
+        type: 'object',
+        description: 'Indicates the provided handle is available.',
+        properties: {},
+      },
+      resultUnavailable: {
+        type: 'object',
+        description:
+          'Indicates the provided handle is unavailable and gives suggestions of available handles.',
+        required: ['suggestions'],
+        properties: {
+          suggestions: {
+            type: 'array',
+            description:
+              'List of suggested handles based on the provided inputs.',
+            items: {
+              type: 'ref',
+              ref: 'lex:app.bsky.unspecced.checkHandleAvailability#suggestion',
+            },
+          },
+        },
+      },
+      suggestion: {
+        type: 'object',
+        required: ['handle', 'method'],
+        properties: {
+          handle: {
+            type: 'string',
+            format: 'handle',
+          },
+          method: {
+            type: 'string',
+            description:
+              'Method used to build this suggestion. Should be considered opaque to clients. Can be used for metrics.',
+          },
+        },
+      },
+    },
+  },
   AppBskyUnspeccedDefs: {
     lexicon: 1,
     id: 'app.bsky.unspecced.defs',
@@ -11596,6 +11694,9 @@ export const schemaDict = {
           {
             name: 'DidTooLong',
           },
+          {
+            name: 'InvalidInitiation',
+          },
         ],
       },
     },
@@ -13468,8 +13569,8 @@ export const ids = {
   AppBskyFeedGetFeedSkeleton: 'app.bsky.feed.getFeedSkeleton',
   AppBskyFeedGetLikes: 'app.bsky.feed.getLikes',
   AppBskyFeedGetListFeed: 'app.bsky.feed.getListFeed',
-  AppBskyFeedGetPostThread: 'app.bsky.feed.getPostThread',
   AppBskyFeedGetPosts: 'app.bsky.feed.getPosts',
+  AppBskyFeedGetPostThread: 'app.bsky.feed.getPostThread',
   AppBskyFeedGetQuotes: 'app.bsky.feed.getQuotes',
   AppBskyFeedGetRepostedBy: 'app.bsky.feed.getRepostedBy',
   AppBskyFeedGetSuggestedFeeds: 'app.bsky.feed.getSuggestedFeeds',
@@ -13530,6 +13631,8 @@ export const ids = {
   AppBskyNotificationUnregisterPush: 'app.bsky.notification.unregisterPush',
   AppBskyNotificationUpdateSeen: 'app.bsky.notification.updateSeen',
   AppBskyRichtextFacet: 'app.bsky.richtext.facet',
+  AppBskyUnspeccedCheckHandleAvailability:
+    'app.bsky.unspecced.checkHandleAvailability',
   AppBskyUnspeccedDefs: 'app.bsky.unspecced.defs',
   AppBskyUnspeccedGetAgeAssuranceState:
     'app.bsky.unspecced.getAgeAssuranceState',

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

@@ -0,0 +1,99 @@
+/**
+ * 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.unspecced.checkHandleAvailability'
+
+export type QueryParams = {
+  /** Tentative handle. Will be checked for availability or used to build handle suggestions. */
+  handle: string
+  /** User-provided email. Might be used to build handle suggestions. */
+  email?: string
+  /** User-provided birth date. Might be used to build handle suggestions. */
+  birthDate?: string
+}
+export type InputSchema = undefined
+
+export interface OutputSchema {
+  /** Echo of the input handle. */
+  handle: string
+  result:
+    | $Typed<ResultAvailable>
+    | $Typed<ResultUnavailable>
+    | { $type: string }
+}
+
+export type HandlerInput = void
+
+export interface HandlerSuccess {
+  encoding: 'application/json'
+  body: OutputSchema
+  headers?: { [key: string]: string }
+}
+
+export interface HandlerError {
+  status: number
+  message?: string
+  error?: 'InvalidEmail'
+}
+
+export type HandlerOutput = HandlerError | HandlerSuccess
+
+/** Indicates the provided handle is available. */
+export interface ResultAvailable {
+  $type?: 'app.bsky.unspecced.checkHandleAvailability#resultAvailable'
+}
+
+const hashResultAvailable = 'resultAvailable'
+
+export function isResultAvailable<V>(v: V) {
+  return is$typed(v, id, hashResultAvailable)
+}
+
+export function validateResultAvailable<V>(v: V) {
+  return validate<ResultAvailable & V>(v, id, hashResultAvailable)
+}
+
+/** Indicates the provided handle is unavailable and gives suggestions of available handles. */
+export interface ResultUnavailable {
+  $type?: 'app.bsky.unspecced.checkHandleAvailability#resultUnavailable'
+  /** List of suggested handles based on the provided inputs. */
+  suggestions: Suggestion[]
+}
+
+const hashResultUnavailable = 'resultUnavailable'
+
+export function isResultUnavailable<V>(v: V) {
+  return is$typed(v, id, hashResultUnavailable)
+}
+
+export function validateResultUnavailable<V>(v: V) {
+  return validate<ResultUnavailable & V>(v, id, hashResultUnavailable)
+}
+
+export interface Suggestion {
+  $type?: 'app.bsky.unspecced.checkHandleAvailability#suggestion'
+  handle: string
+  /** Method used to build this suggestion. Should be considered opaque to clients. Can be used for metrics. */
+  method: string
+}
+
+const hashSuggestion = 'suggestion'
+
+export function isSuggestion<V>(v: V) {
+  return is$typed(v, id, hashSuggestion)
+}
+
+export function validateSuggestion<V>(v: V) {
+  return validate<Suggestion & V>(v, id, hashSuggestion)
+}

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

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

package/tests/views/age-assurance.test.ts

@@ -189,6 +189,50 @@ describe('age assurance views', () => {
     )
   })
 
+  it('ensures user cannot re-init flow from terminal state', async () => {
+    const actor = sc.dids.bob
+    const state0 = await getAgeAssurance(actor)
+    expect(state0).toStrictEqual({
+      status: 'unknown',
+    })
+
+    const init1 = await initAgeAssurance(actor)
+    expect(init1).toStrictEqual({
+      status: 'pending',
+      lastInitiatedAt: expect.any(String),
+    })
+
+    const init2 = await initAgeAssurance(actor)
+    expect(init2).toStrictEqual({
+      status: 'pending',
+      lastInitiatedAt: expect.any(String),
+    })
+
+    /**
+     * Can re-init flow if the state is pending.
+     */
+    expect(sendEmailMock).toHaveBeenCalledTimes(2)
+
+    const externalPayload: KwsExternalPayload = {
+      actorDid: actor,
+      attemptId,
+    }
+    const status = { verified: true }
+    await kwsServer.callVerificationResponse(network.bsky.url, {
+      externalPayload,
+      status,
+    })
+    const finalizedState = await getAgeAssurance(actor)
+    expect(finalizedState).toStrictEqual({
+      status: 'assured',
+      lastInitiatedAt: expect.any(String),
+    })
+
+    await expect(initAgeAssurance(actor)).rejects.toThrowError(
+      `Cannot initiate age assurance flow from current state: assured`,
+    )
+  })
+
   describe('verification response flow', () => {
     it('performs the AA flow', async () => {
       const state0 = await getAgeAssurance(actorDid)

package/tests/views/handle-availability.test.ts

@@ -0,0 +1,294 @@
+import assert from 'node:assert'
+import {
+  $Typed,
+  AppBskyUnspeccedCheckHandleAvailability,
+  AtpAgent,
+} from '@atproto/api'
+import { InvalidEmailError } from '@atproto/api/dist/client/types/app/bsky/unspecced/checkHandleAvailability'
+import { SeedClient, TestNetwork, basicSeed } from '@atproto/dev-env'
+import {
+  OutputSchema,
+  ResultAvailable,
+  ResultUnavailable,
+} from '../../src/lexicon/types/app/bsky/unspecced/checkHandleAvailability'
+
+describe('handle availability', () => {
+  let network: TestNetwork
+  let agent: AtpAgent
+  let sc: SeedClient
+
+  let did: string
+  let handle: string
+  let handleSubdomain: string
+  const birthDate = '1980-09-11T18:05:42.556Z'
+
+  beforeAll(async () => {
+    network = await TestNetwork.create({
+      dbPostgresSchema: 'bsky_handle_availability',
+    })
+    agent = network.bsky.getClient()
+    sc = network.getSeedClient()
+    await basicSeed(sc)
+    await network.processAll()
+    did = sc.dids.alice
+    handle = sc.accounts[did].handle
+    handleSubdomain = handle.split('.')[0]
+  })
+
+  afterEach(() => {
+    jest.resetAllMocks()
+  })
+
+  afterAll(async () => {
+    await network.close()
+  })
+
+  describe('validation', () => {
+    it('throws if email passed is invalid', async () => {
+      await expect(
+        agent.app.bsky.unspecced.checkHandleAvailability({
+          handle,
+          email: 'not-an-email',
+        }),
+      ).rejects.toThrow(InvalidEmailError)
+    })
+
+    it(`returns unavailable with empty suggestions input is already a slur`, async () => {
+      const {
+        data: { result },
+      } = await agent.app.bsky.unspecced.checkHandleAvailability({
+        handle: 'shit.test',
+      })
+
+      assertUnavailable(result)
+      expect(result.suggestions).toStrictEqual([])
+    })
+  })
+
+  describe('available handle', () => {
+    it('returns available when trying a non-existing handle', async () => {
+      const handle = 'a5cc0a41-f9a3-4351-b9ec-1462f255fb0a.test'
+      const { data } = await agent.app.bsky.unspecced.checkHandleAvailability({
+        handle,
+      })
+
+      expect(data.handle).toBe(handle)
+      assertAvailable(data.result)
+    })
+  })
+
+  describe('unavailable handle', () => {
+    it('returns unavailable when trying an existing handle', async () => {
+      const { data } = await agent.app.bsky.unspecced.checkHandleAvailability({
+        handle,
+      })
+
+      expect(data.handle).toBe(handle)
+      assertUnavailable(data.result)
+    })
+
+    describe('suggestions', () => {
+      it(`returns empty list if can't create suggestions`, async () => {
+        // This handle has the maximum allowed length. Suggestions are additive,
+        // so no valid suggestion can be made by adding characters.
+        const longestAllowedHandle = 'abcdefghijklmnopqr.test'
+        const userMaxLength = {
+          email: 'usermaxlength@mail.com',
+          handle: longestAllowedHandle,
+          password: 'hunter2',
+        }
+        await sc.createAccount('userMaxLength', userMaxLength)
+        await network.processAll()
+        const { data } = await agent.app.bsky.unspecced.checkHandleAvailability(
+          {
+            handle: longestAllowedHandle,
+          },
+        )
+
+        expect(data.handle).toBe(longestAllowedHandle)
+        assertUnavailable(data.result)
+        expect(data.result.suggestions).toHaveLength(0)
+      })
+
+      it('suggests appending YOB to tentative handle', async () => {
+        const {
+          data: { result },
+        } = await agent.app.bsky.unspecced.checkHandleAvailability({
+          handle,
+          birthDate,
+        })
+
+        assertUnavailable(result)
+        const suggestion = result.suggestions.find(
+          (s) => s.method === 'handle_yob',
+        )
+        expect(suggestion?.handle).toBe(`${handleSubdomain}80.test`)
+      })
+
+      it('suggests appending YOB to tentative handle, with hyphen if label ends with digits', async () => {
+        const user1 = {
+          email: 'user1@mail.com',
+          handle: 'user1.test',
+          password: 'hunter2',
+        }
+        await sc.createAccount('user1', user1)
+        await network.processAll()
+
+        const {
+          data: { result },
+        } = await agent.app.bsky.unspecced.checkHandleAvailability({
+          handle: user1.handle,
+          birthDate,
+        })
+
+        assertUnavailable(result)
+        const suggestion = result.suggestions.find(
+          (s) => s.method === 'handle_yob',
+        )
+        expect(suggestion?.handle).toBe('user1-80.test')
+      })
+
+      it('suggests using email', async () => {
+        const {
+          data: { result },
+        } = await agent.app.bsky.unspecced.checkHandleAvailability({
+          handle,
+          email: 'email@mail.com',
+        })
+
+        assertUnavailable(result)
+        const suggestion = result.suggestions.find((s) => s.method === 'email')
+        expect(suggestion?.handle).toBe('email.test')
+      })
+
+      it('suggests user email with and without YOB', async () => {
+        const {
+          data: { result },
+        } = await agent.app.bsky.unspecced.checkHandleAvailability({
+          handle,
+          email: 'email@mail.com',
+          birthDate,
+        })
+
+        assertUnavailable(result)
+
+        const suggestion0 = result.suggestions.find((s) => s.method === 'email')
+        expect(suggestion0?.handle).toBe('email.test')
+
+        const suggestion1 = result.suggestions.find(
+          (s) => s.method === 'email_yob',
+        )
+        expect(suggestion1?.handle).toBe('email80.test')
+      })
+
+      it('does not suggest email if it is unavailable as handle', async () => {
+        const user2 = {
+          email: 'user2@mail.com',
+          handle: 'some-name.test', // NOTE: this handle is taken.
+          password: 'hunter2',
+        }
+        await sc.createAccount('user2', user2)
+        await network.processAll()
+
+        const {
+          data: { result },
+        } = await agent.app.bsky.unspecced.checkHandleAvailability({
+          handle,
+          email: 'some.name@mail.com', // NOTE: would suggest 'some-name.test' from the email, but it is taken.
+          birthDate,
+        })
+
+        assertUnavailable(result)
+
+        const suggestion0 = result.suggestions.find((s) => s.method === 'email')
+        expect(suggestion0).toBeUndefined()
+
+        const suggestion1 = result.suggestions.find(
+          (s) => s.method === 'email_yob',
+        )
+        expect(suggestion1?.handle).toBe('some-name80.test')
+      })
+
+      it('suggests random hyphens in the middle of handle', async () => {
+        const {
+          data: { result },
+        } = await agent.app.bsky.unspecced.checkHandleAvailability({
+          handle,
+        })
+
+        assertUnavailable(result)
+        const suggestion = result.suggestions.find((s) => s.method === 'hyphen')
+        expect(suggestion?.handle).not.toBe(handle)
+        expect(suggestion?.handle.replace('-', '')).toBe(handle)
+      })
+
+      it('suggests random digits at the end of handle', async () => {
+        const {
+          data: { result },
+        } = await agent.app.bsky.unspecced.checkHandleAvailability({
+          handle,
+        })
+
+        assertUnavailable(result)
+        const suggestion = result.suggestions.find(
+          (s) => s.method === 'random_digits',
+        )
+        expect(suggestion?.handle).not.toBe(handle)
+        expect(suggestion?.handle.replace(/\d+/, '')).toBe(handle)
+      })
+
+      it('dedupes suggestions', async () => {
+        jest.spyOn(global.Math, 'random').mockReturnValue(0)
+
+        const {
+          data: { result },
+        } = await agent.app.bsky.unspecced.checkHandleAvailability({
+          handle,
+        })
+
+        assertUnavailable(result)
+        expect(result.suggestions).toStrictEqual([
+          { handle: 'a-lice.test', method: 'hyphen' },
+          { handle: 'al-ice.test', method: 'hyphen' },
+          { handle: 'alice0.test', method: 'random_digits' },
+        ])
+      })
+
+      it(`avoids slurs`, async () => {
+        jest.spyOn(global.Math, 'random').mockReturnValue(0)
+
+        const bass = {
+          email: 'bass@mail.com',
+          handle: 'bass.test',
+          password: 'hunter2',
+        }
+        await sc.createAccount('bass', bass)
+        await network.processAll()
+
+        const {
+          data: { result },
+        } = await agent.app.bsky.unspecced.checkHandleAvailability({
+          handle: bass.handle,
+        })
+
+        assertUnavailable(result)
+        const suggestion = result.suggestions.find(
+          (s) => s.handle === 'b-ass.test',
+        )
+        expect(suggestion).toBeUndefined()
+      })
+    })
+  })
+})
+
+function assertAvailable(
+  r: OutputSchema['result'],
+): asserts r is $Typed<ResultAvailable> {
+  assert(AppBskyUnspeccedCheckHandleAvailability.isResultAvailable(r))
+}
+
+function assertUnavailable(
+  r: OutputSchema['result'],
+): asserts r is $Typed<ResultUnavailable> {
+  assert(AppBskyUnspeccedCheckHandleAvailability.isResultUnavailable(r))
+}