@atproto/api 0.6.19 → 0.6.20

package/dist/types.d.ts

@@ -6,6 +6,7 @@ export interface AtpSessionData {
     handle: string;
     did: string;
     email?: string;
+    emailConfirmed?: boolean;
 }
 export declare type AtpPersistSessionHandler = (evt: AtpSessionEvent, session: AtpSessionData | undefined) => void | Promise<void>;
 export interface AtpAgentOpts {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/api",
-  "version": "0.6.19",
+  "version": "0.6.20",
   "license": "MIT",
   "description": "Client library for atproto and Bluesky",
   "keywords": [
@@ -19,15 +19,15 @@
     "multiformats": "^9.9.0",
     "tlds": "^1.234.0",
     "typed-emitter": "^2.1.0",
-    "@atproto/common-web": "^0.2.0",
-    "@atproto/lexicon": "^0.2.1",
-    "@atproto/syntax": "^0.1.1",
-    "@atproto/xrpc": "^0.3.1"
+    "@atproto/common-web": "^0.2.1",
+    "@atproto/lexicon": "^0.2.2",
+    "@atproto/syntax": "^0.1.2",
+    "@atproto/xrpc": "^0.3.2"
   },
   "devDependencies": {
     "common-tags": "^1.8.2",
-    "@atproto/lex-cli": "^0.2.1",
-    "@atproto/pds": "^0.1.19"
+    "@atproto/lex-cli": "^0.2.2",
+    "@atproto/pds": "^0.1.20"
   },
   "scripts": {
     "codegen": "pnpm docgen && node ./scripts/generate-code.mjs && lex gen-api ./src/client ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/*",

package/src/agent.ts

@@ -95,6 +95,7 @@ export class AtpAgent {
         handle: res.data.handle,
         did: res.data.did,
         email: opts.email,
+        emailConfirmed: false,
       }
       return res
     } catch (e) {
@@ -126,6 +127,7 @@ export class AtpAgent {
         handle: res.data.handle,
         did: res.data.did,
         email: res.data.email,
+        emailConfirmed: res.data.emailConfirmed,
       }
       return res
     } catch (e) {
@@ -154,6 +156,7 @@ export class AtpAgent {
       }
       this.session.email = res.data.email
       this.session.handle = res.data.handle
+      this.session.emailConfirmed = res.data.emailConfirmed
       return res
     } catch (e) {
       this.session = undefined
@@ -268,6 +271,7 @@ export class AtpAgent {
     } else if (isNewSessionObject(this._baseClient, res.body)) {
       // succeeded, update the session
       this.session = {
+        ...(this.session || {}),
         accessJwt: res.body.accessJwt,
         refreshJwt: res.body.refreshJwt,
         handle: res.body.handle,

package/src/client/index.ts

@@ -41,6 +41,7 @@ import * as ComAtprotoRepoListRecords from './types/com/atproto/repo/listRecords
 import * as ComAtprotoRepoPutRecord from './types/com/atproto/repo/putRecord'
 import * as ComAtprotoRepoStrongRef from './types/com/atproto/repo/strongRef'
 import * as ComAtprotoRepoUploadBlob from './types/com/atproto/repo/uploadBlob'
+import * as ComAtprotoServerConfirmEmail from './types/com/atproto/server/confirmEmail'
 import * as ComAtprotoServerCreateAccount from './types/com/atproto/server/createAccount'
 import * as ComAtprotoServerCreateAppPassword from './types/com/atproto/server/createAppPassword'
 import * as ComAtprotoServerCreateInviteCode from './types/com/atproto/server/createInviteCode'
@@ -55,9 +56,12 @@ import * as ComAtprotoServerGetSession from './types/com/atproto/server/getSessi
 import * as ComAtprotoServerListAppPasswords from './types/com/atproto/server/listAppPasswords'
 import * as ComAtprotoServerRefreshSession from './types/com/atproto/server/refreshSession'
 import * as ComAtprotoServerRequestAccountDelete from './types/com/atproto/server/requestAccountDelete'
+import * as ComAtprotoServerRequestEmailConfirmation from './types/com/atproto/server/requestEmailConfirmation'
+import * as ComAtprotoServerRequestEmailUpdate from './types/com/atproto/server/requestEmailUpdate'
 import * as ComAtprotoServerRequestPasswordReset from './types/com/atproto/server/requestPasswordReset'
 import * as ComAtprotoServerResetPassword from './types/com/atproto/server/resetPassword'
 import * as ComAtprotoServerRevokeAppPassword from './types/com/atproto/server/revokeAppPassword'
+import * as ComAtprotoServerUpdateEmail from './types/com/atproto/server/updateEmail'
 import * as ComAtprotoSyncGetBlob from './types/com/atproto/sync/getBlob'
 import * as ComAtprotoSyncGetBlocks from './types/com/atproto/sync/getBlocks'
 import * as ComAtprotoSyncGetCheckout from './types/com/atproto/sync/getCheckout'
@@ -170,6 +174,7 @@ export * as ComAtprotoRepoListRecords from './types/com/atproto/repo/listRecords
 export * as ComAtprotoRepoPutRecord from './types/com/atproto/repo/putRecord'
 export * as ComAtprotoRepoStrongRef from './types/com/atproto/repo/strongRef'
 export * as ComAtprotoRepoUploadBlob from './types/com/atproto/repo/uploadBlob'
+export * as ComAtprotoServerConfirmEmail from './types/com/atproto/server/confirmEmail'
 export * as ComAtprotoServerCreateAccount from './types/com/atproto/server/createAccount'
 export * as ComAtprotoServerCreateAppPassword from './types/com/atproto/server/createAppPassword'
 export * as ComAtprotoServerCreateInviteCode from './types/com/atproto/server/createInviteCode'
@@ -184,9 +189,12 @@ export * as ComAtprotoServerGetSession from './types/com/atproto/server/getSessi
 export * as ComAtprotoServerListAppPasswords from './types/com/atproto/server/listAppPasswords'
 export * as ComAtprotoServerRefreshSession from './types/com/atproto/server/refreshSession'
 export * as ComAtprotoServerRequestAccountDelete from './types/com/atproto/server/requestAccountDelete'
+export * as ComAtprotoServerRequestEmailConfirmation from './types/com/atproto/server/requestEmailConfirmation'
+export * as ComAtprotoServerRequestEmailUpdate from './types/com/atproto/server/requestEmailUpdate'
 export * as ComAtprotoServerRequestPasswordReset from './types/com/atproto/server/requestPasswordReset'
 export * as ComAtprotoServerResetPassword from './types/com/atproto/server/resetPassword'
 export * as ComAtprotoServerRevokeAppPassword from './types/com/atproto/server/revokeAppPassword'
+export * as ComAtprotoServerUpdateEmail from './types/com/atproto/server/updateEmail'
 export * as ComAtprotoSyncGetBlob from './types/com/atproto/sync/getBlob'
 export * as ComAtprotoSyncGetBlocks from './types/com/atproto/sync/getBlocks'
 export * as ComAtprotoSyncGetCheckout from './types/com/atproto/sync/getCheckout'
@@ -712,6 +720,17 @@ export class ServerNS {
     this._service = service
   }
 
+  confirmEmail(
+    data?: ComAtprotoServerConfirmEmail.InputSchema,
+    opts?: ComAtprotoServerConfirmEmail.CallOptions,
+  ): Promise<ComAtprotoServerConfirmEmail.Response> {
+    return this._service.xrpc
+      .call('com.atproto.server.confirmEmail', opts?.qp, data, opts)
+      .catch((e) => {
+        throw ComAtprotoServerConfirmEmail.toKnownErr(e)
+      })
+  }
+
   createAccount(
     data?: ComAtprotoServerCreateAccount.InputSchema,
     opts?: ComAtprotoServerCreateAccount.CallOptions,
@@ -855,6 +874,28 @@ export class ServerNS {
       })
   }
 
+  requestEmailConfirmation(
+    data?: ComAtprotoServerRequestEmailConfirmation.InputSchema,
+    opts?: ComAtprotoServerRequestEmailConfirmation.CallOptions,
+  ): Promise<ComAtprotoServerRequestEmailConfirmation.Response> {
+    return this._service.xrpc
+      .call('com.atproto.server.requestEmailConfirmation', opts?.qp, data, opts)
+      .catch((e) => {
+        throw ComAtprotoServerRequestEmailConfirmation.toKnownErr(e)
+      })
+  }
+
+  requestEmailUpdate(
+    data?: ComAtprotoServerRequestEmailUpdate.InputSchema,
+    opts?: ComAtprotoServerRequestEmailUpdate.CallOptions,
+  ): Promise<ComAtprotoServerRequestEmailUpdate.Response> {
+    return this._service.xrpc
+      .call('com.atproto.server.requestEmailUpdate', opts?.qp, data, opts)
+      .catch((e) => {
+        throw ComAtprotoServerRequestEmailUpdate.toKnownErr(e)
+      })
+  }
+
   requestPasswordReset(
     data?: ComAtprotoServerRequestPasswordReset.InputSchema,
     opts?: ComAtprotoServerRequestPasswordReset.CallOptions,
@@ -887,6 +928,17 @@ export class ServerNS {
         throw ComAtprotoServerRevokeAppPassword.toKnownErr(e)
       })
   }
+
+  updateEmail(
+    data?: ComAtprotoServerUpdateEmail.InputSchema,
+    opts?: ComAtprotoServerUpdateEmail.CallOptions,
+  ): Promise<ComAtprotoServerUpdateEmail.Response> {
+    return this._service.xrpc
+      .call('com.atproto.server.updateEmail', opts?.qp, data, opts)
+      .catch((e) => {
+        throw ComAtprotoServerUpdateEmail.toKnownErr(e)
+      })
+  }
 }
 
 export class SyncNS {

package/src/client/lexicons.ts

@@ -2242,6 +2242,46 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoServerConfirmEmail: {
+    lexicon: 1,
+    id: 'com.atproto.server.confirmEmail',
+    defs: {
+      main: {
+        type: 'procedure',
+        description:
+          'Confirm an email using a token from com.atproto.server.requestEmailConfirmation.',
+        input: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['email', 'token'],
+            properties: {
+              email: {
+                type: 'string',
+              },
+              token: {
+                type: 'string',
+              },
+            },
+          },
+        },
+        errors: [
+          {
+            name: 'AccountNotFound',
+          },
+          {
+            name: 'ExpiredToken',
+          },
+          {
+            name: 'InvalidToken',
+          },
+          {
+            name: 'InvalidEmail',
+          },
+        ],
+      },
+    },
+  },
   ComAtprotoServerCreateAccount: {
     lexicon: 1,
     id: 'com.atproto.server.createAccount',
@@ -2526,6 +2566,9 @@ export const schemaDict = {
               email: {
                 type: 'string',
               },
+              emailConfirmed: {
+                type: 'boolean',
+              },
             },
           },
         },
@@ -2756,6 +2799,9 @@ export const schemaDict = {
               email: {
                 type: 'string',
               },
+              emailConfirmed: {
+                type: 'boolean',
+              },
             },
           },
         },
@@ -2854,6 +2900,39 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoServerRequestEmailConfirmation: {
+    lexicon: 1,
+    id: 'com.atproto.server.requestEmailConfirmation',
+    defs: {
+      main: {
+        type: 'procedure',
+        description:
+          'Request an email with a code to confirm ownership of email',
+      },
+    },
+  },
+  ComAtprotoServerRequestEmailUpdate: {
+    lexicon: 1,
+    id: 'com.atproto.server.requestEmailUpdate',
+    defs: {
+      main: {
+        type: 'procedure',
+        description: 'Request a token in order to update email.',
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['tokenRequired'],
+            properties: {
+              tokenRequired: {
+                type: 'boolean',
+              },
+            },
+          },
+        },
+      },
+    },
+  },
   ComAtprotoServerRequestPasswordReset: {
     lexicon: 1,
     id: 'com.atproto.server.requestPasswordReset',
@@ -2931,6 +3010,44 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoServerUpdateEmail: {
+    lexicon: 1,
+    id: 'com.atproto.server.updateEmail',
+    defs: {
+      main: {
+        type: 'procedure',
+        description: "Update an account's email.",
+        input: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['email'],
+            properties: {
+              email: {
+                type: 'string',
+              },
+              token: {
+                type: 'string',
+                description:
+                  "Requires a token from com.atproto.sever.requestEmailUpdate if the account's email has been confirmed.",
+              },
+            },
+          },
+        },
+        errors: [
+          {
+            name: 'ExpiredToken',
+          },
+          {
+            name: 'InvalidToken',
+          },
+          {
+            name: 'TokenRequired',
+          },
+        ],
+      },
+    },
+  },
   ComAtprotoSyncGetBlob: {
     lexicon: 1,
     id: 'com.atproto.sync.getBlob',
@@ -7240,6 +7357,7 @@ export const ids = {
   ComAtprotoRepoPutRecord: 'com.atproto.repo.putRecord',
   ComAtprotoRepoStrongRef: 'com.atproto.repo.strongRef',
   ComAtprotoRepoUploadBlob: 'com.atproto.repo.uploadBlob',
+  ComAtprotoServerConfirmEmail: 'com.atproto.server.confirmEmail',
   ComAtprotoServerCreateAccount: 'com.atproto.server.createAccount',
   ComAtprotoServerCreateAppPassword: 'com.atproto.server.createAppPassword',
   ComAtprotoServerCreateInviteCode: 'com.atproto.server.createInviteCode',
@@ -7256,10 +7374,14 @@ export const ids = {
   ComAtprotoServerRefreshSession: 'com.atproto.server.refreshSession',
   ComAtprotoServerRequestAccountDelete:
     'com.atproto.server.requestAccountDelete',
+  ComAtprotoServerRequestEmailConfirmation:
+    'com.atproto.server.requestEmailConfirmation',
+  ComAtprotoServerRequestEmailUpdate: 'com.atproto.server.requestEmailUpdate',
   ComAtprotoServerRequestPasswordReset:
     'com.atproto.server.requestPasswordReset',
   ComAtprotoServerResetPassword: 'com.atproto.server.resetPassword',
   ComAtprotoServerRevokeAppPassword: 'com.atproto.server.revokeAppPassword',
+  ComAtprotoServerUpdateEmail: 'com.atproto.server.updateEmail',
   ComAtprotoSyncGetBlob: 'com.atproto.sync.getBlob',
   ComAtprotoSyncGetBlocks: 'com.atproto.sync.getBlocks',
   ComAtprotoSyncGetCheckout: 'com.atproto.sync.getCheckout',

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

@@ -0,0 +1,61 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { Headers, XRPCError } from '@atproto/xrpc'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+import { CID } from 'multiformats/cid'
+
+export interface QueryParams {}
+
+export interface InputSchema {
+  email: string
+  token: string
+  [k: string]: unknown
+}
+
+export interface CallOptions {
+  headers?: Headers
+  qp?: QueryParams
+  encoding: 'application/json'
+}
+
+export interface Response {
+  success: boolean
+  headers: Headers
+}
+
+export class AccountNotFoundError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers)
+  }
+}
+
+export class ExpiredTokenError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers)
+  }
+}
+
+export class InvalidTokenError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers)
+  }
+}
+
+export class InvalidEmailError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers)
+  }
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+    if (e.error === 'AccountNotFound') return new AccountNotFoundError(e)
+    if (e.error === 'ExpiredToken') return new ExpiredTokenError(e)
+    if (e.error === 'InvalidToken') return new InvalidTokenError(e)
+    if (e.error === 'InvalidEmail') return new InvalidEmailError(e)
+  }
+  return e
+}

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

@@ -22,6 +22,7 @@ export interface OutputSchema {
   handle: string
   did: string
   email?: string
+  emailConfirmed?: boolean
   [k: string]: unknown
 }
 

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

@@ -15,6 +15,7 @@ export interface OutputSchema {
   handle: string
   did: string
   email?: string
+  emailConfirmed?: boolean
   [k: string]: unknown
 }
 

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

@@ -0,0 +1,28 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { Headers, XRPCError } from '@atproto/xrpc'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+import { CID } from 'multiformats/cid'
+
+export interface QueryParams {}
+
+export type InputSchema = undefined
+
+export interface CallOptions {
+  headers?: Headers
+  qp?: QueryParams
+}
+
+export interface Response {
+  success: boolean
+  headers: Headers
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+  }
+  return e
+}

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

@@ -0,0 +1,34 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { Headers, XRPCError } from '@atproto/xrpc'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+import { CID } from 'multiformats/cid'
+
+export interface QueryParams {}
+
+export type InputSchema = undefined
+
+export interface OutputSchema {
+  tokenRequired: boolean
+  [k: string]: unknown
+}
+
+export interface CallOptions {
+  headers?: Headers
+  qp?: QueryParams
+}
+
+export interface Response {
+  success: boolean
+  headers: Headers
+  data: OutputSchema
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+  }
+  return e
+}

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

@@ -0,0 +1,55 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { Headers, XRPCError } from '@atproto/xrpc'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+import { CID } from 'multiformats/cid'
+
+export interface QueryParams {}
+
+export interface InputSchema {
+  email: string
+  /** Requires a token from com.atproto.sever.requestEmailUpdate if the account's email has been confirmed. */
+  token?: string
+  [k: string]: unknown
+}
+
+export interface CallOptions {
+  headers?: Headers
+  qp?: QueryParams
+  encoding: 'application/json'
+}
+
+export interface Response {
+  success: boolean
+  headers: Headers
+}
+
+export class ExpiredTokenError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers)
+  }
+}
+
+export class InvalidTokenError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers)
+  }
+}
+
+export class TokenRequiredError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers)
+  }
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+    if (e.error === 'ExpiredToken') return new ExpiredTokenError(e)
+    if (e.error === 'InvalidToken') return new InvalidTokenError(e)
+    if (e.error === 'TokenRequired') return new TokenRequiredError(e)
+  }
+  return e
+}

package/src/types.ts

@@ -14,6 +14,7 @@ export interface AtpSessionData {
   handle: string
   did: string
   email?: string
+  emailConfirmed?: boolean
 }
 
 /**

package/tests/agent.test.ts

@@ -48,6 +48,7 @@ describe('agent', () => {
     expect(agent.session?.handle).toEqual(res.data.handle)
     expect(agent.session?.did).toEqual(res.data.did)
     expect(agent.session?.email).toEqual('user1@test.com')
+    expect(agent.session?.emailConfirmed).toEqual(false)
 
     const { data: sessionInfo } = await agent.api.com.atproto.server.getSession(
       {},
@@ -56,6 +57,7 @@ describe('agent', () => {
       did: res.data.did,
       handle: res.data.handle,
       email: 'user1@test.com',
+      emailConfirmed: false,
     })
 
     expect(events.length).toEqual(1)
@@ -93,6 +95,7 @@ describe('agent', () => {
     expect(agent2.session?.handle).toEqual(res1.data.handle)
     expect(agent2.session?.did).toEqual(res1.data.did)
     expect(agent2.session?.email).toEqual('user2@test.com')
+    expect(agent2.session?.emailConfirmed).toEqual(false)
 
     const { data: sessionInfo } =
       await agent2.api.com.atproto.server.getSession({})
@@ -100,6 +103,7 @@ describe('agent', () => {
       did: res1.data.did,
       handle: res1.data.handle,
       email,
+      emailConfirmed: false,
     })
 
     expect(events.length).toEqual(2)
@@ -142,6 +146,7 @@ describe('agent', () => {
       did: res1.data.did,
       handle: res1.data.handle,
       email: res1.data.email,
+      emailConfirmed: false,
     })
 
     expect(events.length).toEqual(2)
@@ -206,6 +211,8 @@ describe('agent', () => {
     expect(agent.session?.refreshJwt).not.toEqual(session1.refreshJwt)
     expect(agent.session?.handle).toEqual(session1.handle)
     expect(agent.session?.did).toEqual(session1.did)
+    expect(agent.session?.email).toEqual(session1.email)
+    expect(agent.session?.emailConfirmed).toEqual(session1.emailConfirmed)
 
     expect(events.length).toEqual(2)
     expect(events[0]).toEqual('create')
@@ -283,6 +290,8 @@ describe('agent', () => {
     expect(agent.session?.refreshJwt).not.toEqual(session1.refreshJwt)
     expect(agent.session?.handle).toEqual(session1.handle)
     expect(agent.session?.did).toEqual(session1.did)
+    expect(agent.session?.email).toEqual(session1.email)
+    expect(agent.session?.emailConfirmed).toEqual(session1.emailConfirmed)
 
     expect(events.length).toEqual(2)
     expect(events[0]).toEqual('create')