Note.hs

{-# LANGUAGE StrictData #-}

{- |
Module      : Network.HStratus.Internal.Notes.Note
Copyright   : (c) 2026 Tim Emiola
Maintainer  : Tim Emiola <adetokunbo@emio.la>
SPDX-License-Identifier: BSD-3-Clause

Domain types for iCloud Notes: note and folder identifiers, note summaries
and full notes, and the structured note-body representation ('NoteText',
'NoteRun', 'NoteStyle').
-}
module Network.HStratus.Internal.Notes.Note
  ( NoteId (..)
  , FolderId (..)
  , NoteSummary (..)
  , NoteFolder (..)
  , Note (..)
  , NoteText (..)
  , NoteRun (..)
  , NoteStyle (..)
  )
where

import Data.ByteString (ByteString)
import Data.Int (Int32)
import Data.Text (Text)
import Data.Time (UTCTime)


-- | CloudKit record name for a note (e.g. @\"68567409-5528-458C-9A00-7A2AB485CAD6\"@).
newtype NoteId = NoteId
  { unNoteId :: Text
  -- ^ The raw CloudKit record name.
  }
  deriving (Eq, Ord, Show)


-- | CloudKit record name for a folder (e.g. @\"4C3FC840-3B07-4215-8E61-128AB3EB425E\"@).
newtype FolderId = FolderId
  { unFolderId :: Text
  -- ^ The raw CloudKit record name.
  }
  deriving (Eq, Ord, Show)


-- | Lightweight summary of a note returned by list and query operations.
data NoteSummary = NoteSummary
  { nsId :: NoteId
  -- ^ Stable CloudKit record identifier.
  , nsTitle :: Maybe Text
  -- ^ Decrypted title; 'Nothing' when the field is absent or unreadable.
  , nsSnippet :: Maybe Text
  -- ^ Decrypted snippet; 'Nothing' when absent or unreadable.
  , nsModified :: Maybe UTCTime
  -- ^ Last-modified timestamp from the @ModificationDate@ field.
  , nsFolderId :: Maybe FolderId
  -- ^ Containing folder; 'Nothing' for notes in the default folder.
  , nsDeleted :: Bool
  -- ^ 'True' when the note has been moved to the trash.
  , nsLocked :: Bool
  -- ^ 'True' when the record type is @PasswordProtectedNote@.
  }
  deriving (Eq, Ord, Show)


-- | A Notes folder returned by 'Network.HStratus.Notes.noteFolders'.
data NoteFolder = NoteFolder
  { nfId :: FolderId
  -- ^ Stable CloudKit record identifier.
  , nfName :: Maybe Text
  -- ^ Decrypted folder name; 'Nothing' when absent or unreadable.
  }
  deriving (Eq, Ord, Show)


-- | A full note including its raw (compressed protobuf) body bytes.
data Note = Note
  { noteInfo :: NoteSummary
  -- ^ Summary metadata for this note.
  , noteBodyBytes :: ByteString
  {- ^ Raw @TextDataEncrypted@ bytes (gzip- or zlib-compressed protobuf).
  Pass to 'Network.HStratus.Notes.decodeNoteBody' to get 'NoteText'.
  -}
  }
  deriving (Eq, Ord, Show)


-- | Decoded plain-text content of a note with formatting runs.
data NoteText = NoteText
  { ntText :: Text
  -- ^ Full plain-text content of the note.
  , ntRuns :: [NoteRun]
  -- ^ Formatting runs parallel to 'ntText'.
  }
  deriving (Eq, Ord, Show)


-- | A single formatting run within a 'NoteText'.
data NoteRun = NoteRun
  { nrLength :: Int32
  -- ^ Number of characters this run covers in 'ntText'.
  , nrStyle :: Maybe NoteStyle
  -- ^ Paragraph style, if any.
  , nrBold :: Bool
  -- ^ 'True' when the run is bold.
  , nrItalic :: Bool
  -- ^ 'True' when the run is italic.
  , nrUnderline :: Bool
  -- ^ 'True' when the run is underlined.
  , nrStrikethrough :: Bool
  -- ^ 'True' when the run is struck through.
  , nrAttachmentId :: Maybe Text
  -- ^ CloudKit attachment identifier, present when the run covers a @\xFFFC@ placeholder.
  , nrLink :: Maybe Text
  -- ^ Hyperlink URL, if any.
  }
  deriving (Eq, Ord, Show)


-- | Paragraph style variants that can appear in a 'NoteRun'.
data NoteStyle
  = StyleTitle
  | StyleHeading
  | StyleSubheading
  | StyleMonospaced
  | -- | Plain body paragraph. 'True' when the paragraph is a blockquote.
    StyleBody Bool
  | -- | Bullet list item. Argument is the indent level (0 = top).
    StyleBullet Int
  | -- | Dash list item. Argument is the indent level (0 = top).
    StyleDash Int
  | {- | Numbered list item. Arguments are indent level and optional
    list-start override (@'Nothing'@ means continue from current counter).
    -}
    StyleNumbered Int (Maybe Int)
  | -- | Checklist item. Arguments are indent level and checked state.
    StyleChecklist Int Bool
  deriving (Eq, Ord, Show)