sketches of types, thoughts on vmail

1 files changed, 48 insertions, 0 deletions

diff --git a/types.hs b/types.hs
new file mode 100644
index 0000000..bf2b4c4
--- /dev/null
+++ b/types.hs
@@ -0,0 +1,48 @@
+
+-- Invite a user by email address.
+-- Records the username of the inviting user and the time of the
+-- request.
+data CreateInvitation = CreateInvitation Username Email UTCTime
+createInvitation (CreateInvitation u e t) = do
+    x...
+type Username = Text
+data User = User UserID Username
+
+data Provenance = ProvenanceSheet Sheet | ProvenanceUser User
+data Invitation' id = Invitation'
+  { invitationID           :: id
+  , invitationCreationTime :: UTCTime
+  , invitationEmailAddress :: EmailAddress -- invited user
+  , invitationProvenance   :: Provenance     -- inviting user
+  }
+type CreateInvitation = Invitation' ()
+type       Invitation = Invitation' UUID
+createInvitation :: CreateInvitation -> m Invitation
+createInvitation (CreateInvitation () t e (ProvenanceSheet s) = do
+createInvitation (CreateInvitation () t e (ProvenanceUser  u) = do
+  -- validate inviting user/sheet
+  -- 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
+  }
+type CreatePreInvitation = PreInvitation' ()
+type       PreInvitation = PreInvitation' PreInvitationCode
+createPreInvitation :: CreatePreInvitation -> PreInvitation
+
+-- A sheet containing preinvitations.
+-- The preinvitations link up to their creating sheet.
+data Sheet' id = Sheet'
+  { sheetID           :: id
+  , sheetCreator      :: User
+  , sheetCreationTime :: UTCTime
+  }
+type CreateSheet = Sheet' ()
+type Sheet       = Sheet' SheetID
+type SheetID     = UUID
+createSheet :: CreateSheet -> m Sheet
+