scrod-0.2026.2.21: source/library/Scrod/Core/NumberedItem.hs

{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DerivingVia #-}

module Scrod.Core.NumberedItem where

import qualified GHC.Generics as Generics
import qualified Scrod.Json.ToJson as ToJson
import qualified Scrod.Schema as Schema

-- | An item in an ordered list, with its 1-based index.
data NumberedItem doc = MkNumberedItem
  { index :: Int,
    item :: doc
  }
  deriving (Eq, Generics.Generic, Ord, Show)
  deriving (ToJson.ToJson, Schema.ToSchema) via Generics.Generically (NumberedItem doc)