@atproto/api 0.3.3 → 0.3.5

package/jest.bench.config.js

@@ -0,0 +1,8 @@
+const base = require('./jest.config')
+
+module.exports = {
+  ...base,
+  roots: ['<rootDir>/bench'],
+  testRegex: '(.*.bench.ts)',
+  testTimeout: 3000000,
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/api",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "main": "dist/index.js",
   "scripts": {
     "codegen": "lex gen-api ./src/client ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/*",
@@ -10,7 +10,9 @@
     "update-main-to-src": "node ./update-pkg.js --update-main-to-src",
     "prepublish": "npm run update-main-to-dist",
     "postpublish": "npm run update-main-to-src",
-    "test": "jest"
+    "test": "jest",
+    "bench": "jest --config jest.bench.config.js",
+    "bench:profile": "node --inspect-brk ../../node_modules/.bin/jest --config jest.bench.config.js"
   },
   "license": "MIT",
   "repository": {

package/src/client/lexicons.ts

@@ -100,7 +100,9 @@ export const schemaDict = {
             type: 'union',
             refs: [
               'lex:com.atproto.admin.defs#repoView',
+              'lex:com.atproto.admin.defs#repoViewNotFound',
               'lex:com.atproto.admin.defs#recordView',
+              'lex:com.atproto.admin.defs#recordViewNotFound',
             ],
           },
           subjectBlobs: {
@@ -274,7 +276,9 @@ export const schemaDict = {
             type: 'union',
             refs: [
               'lex:com.atproto.admin.defs#repoView',
+              'lex:com.atproto.admin.defs#repoViewNotFound',
               'lex:com.atproto.admin.defs#recordView',
+              'lex:com.atproto.admin.defs#recordViewNotFound',
             ],
           },
           reportedBy: {
@@ -396,6 +400,16 @@ export const schemaDict = {
           },
         },
       },
+      repoViewNotFound: {
+        type: 'object',
+        required: ['did'],
+        properties: {
+          did: {
+            type: 'string',
+            format: 'did',
+          },
+        },
+      },
       repoRef: {
         type: 'object',
         required: ['did'],
@@ -501,6 +515,16 @@ export const schemaDict = {
           },
         },
       },
+      recordViewNotFound: {
+        type: 'object',
+        required: ['uri'],
+        properties: {
+          uri: {
+            type: 'string',
+            format: 'at-uri',
+          },
+        },
+      },
       moderation: {
         type: 'object',
         required: [],
@@ -835,6 +859,15 @@ export const schemaDict = {
             resolved: {
               type: 'boolean',
             },
+            actionType: {
+              type: 'string',
+              knownValues: [
+                'com.atproto.admin.defs#takedown',
+                'com.atproto.admin.defs#flag',
+                'com.atproto.admin.defs#acknowledge',
+                'com.atproto.admin.defs#escalate',
+              ],
+            },
             limit: {
               type: 'integer',
               minimum: 1,
@@ -896,6 +929,11 @@ export const schemaDict = {
             ref: 'lex:com.atproto.admin.defs#recordViewDetail',
           },
         },
+        errors: [
+          {
+            name: 'RecordNotFound',
+          },
+        ],
       },
     },
   },
@@ -923,6 +961,11 @@ export const schemaDict = {
             ref: 'lex:com.atproto.admin.defs#repoViewDetail',
           },
         },
+        errors: [
+          {
+            name: 'RepoNotFound',
+          },
+        ],
       },
     },
   },
@@ -1576,6 +1619,7 @@ export const schemaDict = {
           },
           rkey: {
             type: 'string',
+            maxLength: 15,
           },
           value: {
             type: 'unknown',
@@ -1641,6 +1685,7 @@ export const schemaDict = {
               rkey: {
                 type: 'string',
                 description: 'The key of the record.',
+                maxLength: 15,
               },
               validate: {
                 type: 'boolean',
@@ -1962,6 +2007,7 @@ export const schemaDict = {
               rkey: {
                 type: 'string',
                 description: 'The key of the record.',
+                maxLength: 15,
               },
               validate: {
                 type: 'boolean',
@@ -2114,6 +2160,10 @@ export const schemaDict = {
                 type: 'string',
                 format: 'handle',
               },
+              did: {
+                type: 'string',
+                format: 'did',
+              },
               inviteCode: {
                 type: 'string',
               },
@@ -2165,6 +2215,12 @@ export const schemaDict = {
           {
             name: 'UnsupportedDomain',
           },
+          {
+            name: 'UnresolvableDid',
+          },
+          {
+            name: 'IncompatibleDidDoc',
+          },
         ],
       },
     },

package/src/client/types/com/atproto/admin/defs.ts

@@ -43,7 +43,12 @@ export function validateActionView(v: unknown): ValidationResult {
 export interface ActionViewDetail {
   id: number
   action: ActionType
-  subject: RepoView | RecordView | { $type: string; [k: string]: unknown }
+  subject:
+    | RepoView
+    | RepoViewNotFound
+    | RecordView
+    | RecordViewNotFound
+    | { $type: string; [k: string]: unknown }
   subjectBlobs: BlobView[]
   createLabelVals?: string[]
   negateLabelVals?: string[]
@@ -150,7 +155,12 @@ export interface ReportViewDetail {
   id: number
   reasonType: ComAtprotoModerationDefs.ReasonType
   reason?: string
-  subject: RepoView | RecordView | { $type: string; [k: string]: unknown }
+  subject:
+    | RepoView
+    | RepoViewNotFound
+    | RecordView
+    | RecordViewNotFound
+    | { $type: string; [k: string]: unknown }
   reportedBy: string
   createdAt: string
   resolvedByActions: ActionView[]
@@ -219,6 +229,23 @@ export function validateRepoViewDetail(v: unknown): ValidationResult {
   return lexicons.validate('com.atproto.admin.defs#repoViewDetail', v)
 }
 
+export interface RepoViewNotFound {
+  did: string
+  [k: string]: unknown
+}
+
+export function isRepoViewNotFound(v: unknown): v is RepoViewNotFound {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.admin.defs#repoViewNotFound'
+  )
+}
+
+export function validateRepoViewNotFound(v: unknown): ValidationResult {
+  return lexicons.validate('com.atproto.admin.defs#repoViewNotFound', v)
+}
+
 export interface RepoRef {
   did: string
   [k: string]: unknown
@@ -283,6 +310,23 @@ export function validateRecordViewDetail(v: unknown): ValidationResult {
   return lexicons.validate('com.atproto.admin.defs#recordViewDetail', v)
 }
 
+export interface RecordViewNotFound {
+  uri: string
+  [k: string]: unknown
+}
+
+export function isRecordViewNotFound(v: unknown): v is RecordViewNotFound {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.admin.defs#recordViewNotFound'
+  )
+}
+
+export function validateRecordViewNotFound(v: unknown): ValidationResult {
+  return lexicons.validate('com.atproto.admin.defs#recordViewNotFound', v)
+}
+
 export interface Moderation {
   currentAction?: ActionViewCurrent
   [k: string]: unknown

package/src/client/types/com/atproto/admin/getModerationReports.ts

@@ -11,6 +11,12 @@ import * as ComAtprotoAdminDefs from './defs'
 export interface QueryParams {
   subject?: string
   resolved?: boolean
+  actionType?:
+    | 'com.atproto.admin.defs#takedown'
+    | 'com.atproto.admin.defs#flag'
+    | 'com.atproto.admin.defs#acknowledge'
+    | 'com.atproto.admin.defs#escalate'
+    | (string & {})
   limit?: number
   cursor?: string
 }

package/src/client/types/com/atproto/admin/getRecord.ts

@@ -26,8 +26,15 @@ export interface Response {
   data: OutputSchema
 }
 
+export class RecordNotFoundError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message)
+  }
+}
+
 export function toKnownErr(e: any) {
   if (e instanceof XRPCError) {
+    if (e.error === 'RecordNotFound') return new RecordNotFoundError(e)
   }
   return e
 }

package/src/client/types/com/atproto/admin/getRepo.ts

@@ -25,8 +25,15 @@ export interface Response {
   data: OutputSchema
 }
 
+export class RepoNotFoundError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message)
+  }
+}
+
 export function toKnownErr(e: any) {
   if (e instanceof XRPCError) {
+    if (e.error === 'RepoNotFound') return new RepoNotFoundError(e)
   }
   return e
 }

package/src/client/types/com/atproto/server/createAccount.ts

@@ -12,6 +12,7 @@ export interface QueryParams {}
 export interface InputSchema {
   email: string
   handle: string
+  did?: string
   inviteCode?: string
   password: string
   recoveryKey?: string
@@ -68,6 +69,18 @@ export class UnsupportedDomainError extends XRPCError {
   }
 }
 
+export class UnresolvableDidError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message)
+  }
+}
+
+export class IncompatibleDidDocError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message)
+  }
+}
+
 export function toKnownErr(e: any) {
   if (e instanceof XRPCError) {
     if (e.error === 'InvalidHandle') return new InvalidHandleError(e)
@@ -75,6 +88,8 @@ export function toKnownErr(e: any) {
     if (e.error === 'InvalidInviteCode') return new InvalidInviteCodeError(e)
     if (e.error === 'HandleNotAvailable') return new HandleNotAvailableError(e)
     if (e.error === 'UnsupportedDomain') return new UnsupportedDomainError(e)
+    if (e.error === 'UnresolvableDid') return new UnresolvableDidError(e)
+    if (e.error === 'IncompatibleDidDoc') return new IncompatibleDidDocError(e)
   }
   return e
 }

package/tests/agent.test.ts

@@ -398,4 +398,67 @@ describe('agent', () => {
     expect(sessions.length).toEqual(1)
     expect(sessions[0]?.accessJwt).toEqual(origAccessJwt)
   })
+
+  describe('setPersistSessionHandler', () => {
+    it('sets persist session handler', async () => {
+      let originalHandlerCallCount = 0
+      let newHandlerCallCount = 0
+
+      const persistSession = () => {
+        originalHandlerCallCount++
+      }
+      const newPersistSession = () => {
+        newHandlerCallCount++
+      }
+
+      const agent = new AtpAgent({ service: server.url, persistSession })
+
+      await agent.createAccount({
+        handle: 'user7.test',
+        email: 'user7@test.com',
+        password: 'password',
+      })
+
+      expect(originalHandlerCallCount).toEqual(1)
+
+      agent.setPersistSessionHandler(newPersistSession)
+
+      await agent.createAccount({
+        handle: 'user8.test',
+        email: 'user8@test.com',
+        password: 'password',
+      })
+
+      expect(originalHandlerCallCount).toEqual(1)
+      expect(newHandlerCallCount).toEqual(1)
+    })
+  })
+
+  describe('createAccount', () => {
+    it('persists an empty session on failure', async () => {
+      const events: string[] = []
+      const sessions: (AtpSessionData | undefined)[] = []
+      const persistSession = (evt: AtpSessionEvent, sess?: AtpSessionData) => {
+        events.push(evt)
+        sessions.push(sess)
+      }
+
+      const agent = new AtpAgent({ service: server.url, persistSession })
+
+      await expect(
+        agent.createAccount({
+          handle: '',
+          email: '',
+          password: 'password',
+        }),
+      ).rejects.toThrow()
+
+      expect(agent.hasSession).toEqual(false)
+      expect(agent.session).toEqual(undefined)
+      expect(events.length).toEqual(1)
+      expect(events[0]).toEqual('create-failed')
+      expect(sessions.length).toEqual(1)
+      expect(sessions[0]).toEqual(undefined)
+    })
+  })
 })

package/tests/bsky-agent.test.ts

@@ -137,4 +137,67 @@ describe('agent', () => {
     })
     await expect(p).rejects.toThrow('Record/displayName must be a string')
   })
+
+  describe('app', () => {
+    it('should retrieve the api app', () => {
+      const agent = new BskyAgent({ service: server.url })
+      expect(agent.app).toBe(agent.api.app)
+    })
+  })
+
+  describe('post', () => {
+    it('should throw if no session', async () => {
+      const agent = new BskyAgent({ service: server.url })
+      await expect(agent.post({ text: 'foo' })).rejects.toThrow('Not logged in')
+    })
+  })
+
+  describe('deletePost', () => {
+    it('should throw if no session', async () => {
+      const agent = new BskyAgent({ service: server.url })
+      await expect(agent.deletePost('foo')).rejects.toThrow('Not logged in')
+    })
+  })
+
+  describe('like', () => {
+    it('should throw if no session', async () => {
+      const agent = new BskyAgent({ service: server.url })
+      await expect(agent.like('foo', 'bar')).rejects.toThrow('Not logged in')
+    })
+  })
+
+  describe('deleteLike', () => {
+    it('should throw if no session', async () => {
+      const agent = new BskyAgent({ service: server.url })
+      await expect(agent.deleteLike('foo')).rejects.toThrow('Not logged in')
+    })
+  })
+
+  describe('repost', () => {
+    it('should throw if no session', async () => {
+      const agent = new BskyAgent({ service: server.url })
+      await expect(agent.repost('foo', 'bar')).rejects.toThrow('Not logged in')
+    })
+  })
+
+  describe('deleteRepost', () => {
+    it('should throw if no session', async () => {
+      const agent = new BskyAgent({ service: server.url })
+      await expect(agent.deleteRepost('foo')).rejects.toThrow('Not logged in')
+    })
+  })
+
+  describe('follow', () => {
+    it('should throw if no session', async () => {
+      const agent = new BskyAgent({ service: server.url })
+      await expect(agent.follow('foo')).rejects.toThrow('Not logged in')
+    })
+  })
+
+  describe('deleteFollow', () => {
+    it('should throw if no session', async () => {
+      const agent = new BskyAgent({ service: server.url })
+      await expect(agent.deleteFollow('foo')).rejects.toThrow('Not logged in')
+    })
+  })
 })