Email confirmation/update

.changeset/little-fans-obey.md

@@ -0,0 +1,7 @@
+---
+'@atproto/dev-env': patch
+'@atproto/api': patch
+'@atproto/pds': patch
+---
+
+Added email verification and update flows

.changeset/witty-islands-burn.md

@@ -0,0 +1,5 @@
+---
+'@atproto/common-web': patch
+---
+
+Added lessThanAgoMs utility

lexicons/com/atproto/server/confirmEmail.json

@@ -0,0 +1,27 @@
+{
+  "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" }
+      ]
+    }
+  }
+}

lexicons/com/atproto/server/createSession.json

@@ -29,7 +29,8 @@
             "refreshJwt": { "type": "string" },
             "handle": { "type": "string", "format": "handle" },
             "did": { "type": "string", "format": "did" },
-            "email": { "type": "string" }
+            "email": { "type": "string" },
+            "emailConfirmed": { "type": "boolean" }
           }
         }
       },

lexicons/com/atproto/server/getSession.json

@@ -13,7 +13,8 @@
           "properties": {
             "handle": { "type": "string", "format": "handle" },
             "did": { "type": "string", "format": "did" },
-            "email": { "type": "string" }
+            "email": { "type": "string" },
+            "emailConfirmed": { "type": "boolean" }
           }
         }
       }

lexicons/com/atproto/server/requestEmailConfirmation.json

@@ -0,0 +1,10 @@
+{
+  "lexicon": 1,
+  "id": "com.atproto.server.requestEmailConfirmation",
+  "defs": {
+    "main": {
+      "type": "procedure",
+      "description": "Request an email with a code to confirm ownership of email"
+    }
+  }
+}

lexicons/com/atproto/server/requestEmailUpdate.json

@@ -0,0 +1,20 @@
+{
+  "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" }
+          }
+        }
+      }
+    }
+  }
+}

lexicons/com/atproto/server/updateEmail.json

@@ -0,0 +1,29 @@
+{
+  "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" }
+      ]
+    }
+  }
+}

packages/api/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,

packages/api/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 {