notes

1 files changed, 64 insertions, 12 deletions

diff --git a/types.hs b/types.hs
index bf2b4c4..0021599 100644
--- a/types.hs
+++ b/types.hs
@@ -8,12 +8,39 @@ createInvitation (CreateInvitation u e t) = do
 type Username = Text
 data User = User UserID Username
 
+-- These ID types use a type parameter "trick." The type parameter is
+-- instantiated twice; once with () for its id field type, and once with an
+-- actual data type there. This allows the "nulled" version to be used to
+-- represent database field inputs; and the "indexed" version to represent
+-- corresponding outputs.
+
+newtype UserAccountID   = UserAccountID   UserID
+newtype SheetID         = SheetID         (UserID, Integer)
+newtype SignupCodeID    = SignupCodeID    Text -- short code for typing
+newtype InvitationID    = InvitationID    UUID
+newtype PasswordResetID = PasswordResetID UUID
+
+data UserAccount' id = UserAccount'
+  { userAccountID           :: id
+  , userAccountInvitation   :: Invitation' InvitationID -- Contains inviter
+  , userAccountEmail        :: EmailAddress
+  , userAccountCreationTime :: UTCTime
+  }
+type CreateUserAccount = UserAccount' ()
+type UserAccount = UserAccount' UserID
+
+-- A Sheet contains a Set of SignupCodes.  SignupCode converts to
+-- an Invitation after user supplies Email address.  An Invitation
+-- submitted to the web server initiates a verification email which must
+-- be submitted with the InvitationID to initiate the password reset in
+-- the browser.
+
 data Provenance = ProvenanceSheet Sheet | ProvenanceUser User
 data Invitation' id = Invitation'
   { invitationID           :: id
   , invitationCreationTime :: UTCTime
   , invitationEmailAddress :: EmailAddress -- invited user
-  , invitationProvenance   :: Provenance     -- inviting user
+  , invitationProvenance   :: Provenance   -- inviting user
   }
 type CreateInvitation = Invitation' ()
 type       Invitation = Invitation' UUID
@@ -24,21 +51,25 @@ createInvitation (CreateInvitation () t e (ProvenanceUser  u) = do
   -- record invitation code and shared secret in database
   -- send email containing shared secret
 
--- preinvitations can be used to create invitations,
--- when email addresses are added
-data PreInvitation' id = PreInvitation'
-  { preInvitationID :: id
-  , preInvitationSheetID :: Sheet
+-- signupcodes can be used to create self-invitations. the user must
+-- supply a signupcode and their email address. a secret code will be
+-- sent to the email address.
+data SignupCode' id = SignupCode'
+  { signupCodeID      :: id
+  , signupCodeSheetID :: Sheet
   }
-type CreatePreInvitation = PreInvitation' ()
-type       PreInvitation = PreInvitation' PreInvitationCode
-createPreInvitation :: CreatePreInvitation -> PreInvitation
+type CreateSignupCode = SignupCode' ()
+type       SignupCode = SignupCode' SignupCodeCode
+createSignupCode :: CreateSignupCode -> SignupCode
 
--- A sheet containing preinvitations.
--- The preinvitations link up to their creating sheet.
+-- A sheet containing signupcodes.
+-- The signupcodes link up to their creating sheet. Since the real purpose is to
+-- get the Username, it is kept as a Sheet rather than SheetID. If the username
+-- changes for the UserID then we have retained a record of the inviting
+-- username at the time.
 data Sheet' id = Sheet'
   { sheetID           :: id
-  , sheetCreator      :: User
+  , sheetCreator      :: UserAccount' () -- Stores the data! Not the database record ID!
   , sheetCreationTime :: UTCTime
   }
 type CreateSheet = Sheet' ()
@@ -46,3 +77,24 @@ type Sheet       = Sheet' SheetID
 type SheetID     = UUID
 createSheet :: CreateSheet -> m Sheet
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-- The browser is expected to generate a secure password that will be
+-- stored within the browser. Do not re-use passwords! Password re-use
+-- causes a compromise at one site of password-collection to yield
+-- information compromising password-protected barriers at other sites.