stbx-core: Move Firing, Initial, Common submodules out of Statebox.Core.Types. #331

Author: epost

stbx-core/src/Statebox/Core/Common.purs

@@ -0,0 +1,15 @@
+module Statebox.Core.Common
+  ( HexStr
+  , Message
+  , TxId
+  ) where
+
+-- | This tags an Array that is expected (but not guaranteed) to have exactly one element. (TODO: newtype.)
+type Singleton = NonEmpty Array
+
+type TxId = String
+
+type HexStr = String
+
+-- | Some transaction data has a 'message' field, and they have this type.
+type Message = String

stbx-core/src/Statebox/Core/Firing.purs

@@ -0,0 +1,34 @@
+module Statebox.Core.Firing
+  ( Firing
+  , GluedTransitionIdRaw
+  , GluedTransitionId(..)
+  , Singleton
+  ) where
+
+import Prelude (class Eq, class Show, show, (<>))
+import Data.Maybe (Maybe)
+import Data.Newtype (class Newtype)
+import Data.NonEmpty (NonEmpty)
+
+import Statebox.Core.Net (TID)
+import Statebox.Core.Common (Message, TxId)
+
+type Firing =
+  { message   :: Maybe Message
+  , execution :: Maybe TxId                     -- ^ The execution that this firing is a descendent of.
+  , path      :: Singleton GluedTransitionIdRaw -- ^ The net and transition to fire.
+  }
+
+-- TODO This should be the newtype GluedTransitionId.
+type GluedTransitionIdRaw = Int
+
+--------------------------------------------------------------------------------
+
+newtype GluedTransitionId = GluedTransitionId TID
+
+derive instance newtypeGluedTransitionId :: Newtype GluedTransitionId _
+
+derive instance eqGluedTransitionId :: Eq GluedTransitionId
+
+instance showGluedTransitionId :: Show GluedTransitionId where
+  show (GluedTransitionId i) = "(GluedTransitionId " <> show i <> ")"

stbx-core/src/Statebox/Core/Initial.purs

@@ -0,0 +1,10 @@
+module Statebox.Core.Initial
+  ( Initial
+  ) where
+
+import Statebox.Core.Common (Message)
+
+-- | Initial (aka root or namespace or genesis) transaction data.
+type Initial =
+  { message :: Message
+  }

stbx-core/src/Statebox/Core/Types.purs

@@ -1,60 +1,15 @@
 module Statebox.Core.Types
-  ( module Statebox.Core.Wiring
-  , module Statebox.Core.Net
+  ( module Statebox.Core.Net
   , module Statebox.Core.Diagram
-  , Firing
-  , GluedTransitionIdRaw
-  , GluedTransitionId(..)
-  , HexStr
-  , Initial(..)
-  , Message
-  , Singleton
-  , TxId
+  , module Statebox.Core.Wiring
+  , module Statebox.Core.Firing
+  , module Statebox.Core.Initial
+  , module Statebox.Core.Common
   ) where
 
-import Prelude
-import Data.Maybe (Maybe)
-import Data.Newtype (class Newtype)
-import Data.NonEmpty (NonEmpty)
-
-import Statebox.Core.Net (Net, PID, TID, unTID)
-import Statebox.Core.Diagram (Diagram)
-import Statebox.Core.Wiring (Wiring)
-
---------------------------------------------------------------------------------
-
-type Initial =
-  { message :: Message
-  }
-
--- | Some transaction types have a 'message' field, and they have this type.
-type Message = String
-
---------------------------------------------------------------------------------
-
-type Firing =
-  { message   :: Maybe Message
-  , execution :: Maybe TxId                     -- ^ The execution that this firing is a descendent of.
-  , path      :: Singleton GluedTransitionIdRaw -- ^ The net and transition to fire.
-  }
-
-type TxId = String
-
-type HexStr = String
-
--- | This tags an Array that is expected (but not guaranteed) to have exactly one element. (TODO: newtype.)
-type Singleton = NonEmpty Array
-
--- TODO This should be the newtype GluedTransitionId.
-type GluedTransitionIdRaw = Int
-
---------------------------------------------------------------------------------
-
-newtype GluedTransitionId = GluedTransitionId TID
-
-derive instance newtypeGluedTransitionId :: Newtype GluedTransitionId _
-
-derive instance eqGluedTransitionId :: Eq GluedTransitionId
-
-instance showGluedTransitionId :: Show GluedTransitionId where
-  show (GluedTransitionId i) = "(GluedTransitionId " <> show i <> ")"
+import Statebox.Core.Net
+import Statebox.Core.Diagram
+import Statebox.Core.Wiring
+import Statebox.Core.Firing
+import Statebox.Core.Initial
+import Statebox.Core.Common