-- SPDX-FileCopyrightText: 2026 Alexandra de Wit
--
-- SPDX-License-Identifier: MIT

-- | npm field events and retained field names shared by native reads and their reference oracle.
module Ecluse.Core.Registry.Npm.Streaming (
    NpmFieldOf (..),
    NpmField,
    NpmContainer (..),
    versionFields,
    versionListFields,
) where

import Data.Aeson (Value)

-- | Independent top-level maps, with first-container precedence retained by their consumer.
data NpmContainer = VersionsContainer | TimeContainer | TagsContainer
    deriving stock (NpmContainer -> NpmContainer -> Bool
(NpmContainer -> NpmContainer -> Bool)
-> (NpmContainer -> NpmContainer -> Bool) -> Eq NpmContainer
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: NpmContainer -> NpmContainer -> Bool
== :: NpmContainer -> NpmContainer -> Bool
$c/= :: NpmContainer -> NpmContainer -> Bool
/= :: NpmContainer -> NpmContainer -> Bool
Eq, Eq NpmContainer
Eq NpmContainer =>
(NpmContainer -> NpmContainer -> Ordering)
-> (NpmContainer -> NpmContainer -> Bool)
-> (NpmContainer -> NpmContainer -> Bool)
-> (NpmContainer -> NpmContainer -> Bool)
-> (NpmContainer -> NpmContainer -> Bool)
-> (NpmContainer -> NpmContainer -> NpmContainer)
-> (NpmContainer -> NpmContainer -> NpmContainer)
-> Ord NpmContainer
NpmContainer -> NpmContainer -> Bool
NpmContainer -> NpmContainer -> Ordering
NpmContainer -> NpmContainer -> NpmContainer
forall a.
Eq a =>
(a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
$ccompare :: NpmContainer -> NpmContainer -> Ordering
compare :: NpmContainer -> NpmContainer -> Ordering
$c< :: NpmContainer -> NpmContainer -> Bool
< :: NpmContainer -> NpmContainer -> Bool
$c<= :: NpmContainer -> NpmContainer -> Bool
<= :: NpmContainer -> NpmContainer -> Bool
$c> :: NpmContainer -> NpmContainer -> Bool
> :: NpmContainer -> NpmContainer -> Bool
$c>= :: NpmContainer -> NpmContainer -> Bool
>= :: NpmContainer -> NpmContainer -> Bool
$cmax :: NpmContainer -> NpmContainer -> NpmContainer
max :: NpmContainer -> NpmContainer -> NpmContainer
$cmin :: NpmContainer -> NpmContainer -> NpmContainer
min :: NpmContainer -> NpmContainer -> NpmContainer
Ord, Int -> NpmContainer -> ShowS
[NpmContainer] -> ShowS
NpmContainer -> String
(Int -> NpmContainer -> ShowS)
-> (NpmContainer -> String)
-> ([NpmContainer] -> ShowS)
-> Show NpmContainer
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> NpmContainer -> ShowS
showsPrec :: Int -> NpmContainer -> ShowS
$cshow :: NpmContainer -> String
show :: NpmContainer -> String
$cshowList :: [NpmContainer] -> ShowS
showList :: [NpmContainer] -> ShowS
Show)

-- | Each field retains its source coordinate. Skipped releases still count towards the version cap.
data NpmFieldOf release
    = IgnoredField
    | BeginContainer NpmContainer
    | InvalidContainer NpmContainer
    | NameField Value
    | VersionField Text (Maybe release)
    | TimeField Text Value
    | TagField Text Value
    deriving stock (NpmFieldOf release -> NpmFieldOf release -> Bool
(NpmFieldOf release -> NpmFieldOf release -> Bool)
-> (NpmFieldOf release -> NpmFieldOf release -> Bool)
-> Eq (NpmFieldOf release)
forall release.
Eq release =>
NpmFieldOf release -> NpmFieldOf release -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: forall release.
Eq release =>
NpmFieldOf release -> NpmFieldOf release -> Bool
== :: NpmFieldOf release -> NpmFieldOf release -> Bool
$c/= :: forall release.
Eq release =>
NpmFieldOf release -> NpmFieldOf release -> Bool
/= :: NpmFieldOf release -> NpmFieldOf release -> Bool
Eq, Int -> NpmFieldOf release -> ShowS
[NpmFieldOf release] -> ShowS
NpmFieldOf release -> String
(Int -> NpmFieldOf release -> ShowS)
-> (NpmFieldOf release -> String)
-> ([NpmFieldOf release] -> ShowS)
-> Show (NpmFieldOf release)
forall release. Show release => Int -> NpmFieldOf release -> ShowS
forall release. Show release => [NpmFieldOf release] -> ShowS
forall release. Show release => NpmFieldOf release -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: forall release. Show release => Int -> NpmFieldOf release -> ShowS
showsPrec :: Int -> NpmFieldOf release -> ShowS
$cshow :: forall release. Show release => NpmFieldOf release -> String
show :: NpmFieldOf release -> String
$cshowList :: forall release. Show release => [NpmFieldOf release] -> ShowS
showList :: [NpmFieldOf release] -> ShowS
Show)

-- | A field whose release is aeson's tree.
type NpmField = NpmFieldOf Value

-- | Supported release fields for installation, runtime resolution, policy and mirrored publication.
versionFields :: [Text]
versionFields :: [Text]
versionFields =
    [Text]
versionListFields
        [Text] -> [Text] -> [Text]
forall a. Semigroup a => a -> a -> a
<> [ Text
"dependencies"
           , Text
"dependenciesMeta"
           , Text
"acceptDependencies"
           , Text
"_hasShrinkwrap"
           , Text
"devDependencies"
           , Text
"optionalDependencies"
           , Text
"peerDependencies"
           , Text
"peerDependenciesMeta"
           , Text
"bundleDependencies"
           , Text
"bundledDependencies"
           , Text
"engines"
           , Text
"engineStrict"
           , Text
"os"
           , Text
"cpu"
           , Text
"libc"
           , Text
"bin"
           , Text
"man"
           , Text
"directories"
           , Text
"main"
           , Text
"module"
           , Text
"browser"
           , Text
"exports"
           , Text
"imports"
           , Text
"type"
           , Text
"types"
           , Text
"typings"
           , Text
"typesVersions"
           , Text
"files"
           , Text
"gypfile"
           , Text
"preferGlobal"
           , Text
"config"
           , Text
"workspaces"
           , Text
"packageManager"
           , Text
"devEngines"
           , Text
"publishConfig"
           , Text
"sideEffects"
           ]

-- | VersionEntry's required fields and optional discriminators, excluding installer-only fields.
versionListFields :: [Text]
versionListFields :: [Text]
versionListFields = [Text
"name", Text
"version", Text
"dist", Text
"deprecated", Text
"hasInstallScript", Text
"scripts", Text
"license", Text
"_npmUser"]