api-tools.cabal

Name:                api-tools
Version:             0.11.0.0
Synopsis:            DSL for generating API boilerplate and docs
Description:         api-tools provides a compact DSL for describing an API.
                     It uses Template Haskell to generate the
                     corresponding data types and assorted tools for
                     working with it, including Aeson and QuickCheck
                     instances for converting between JSON and the
                     generated types and writing unit tests.
Homepage:            http://github.com/iconnect/api-tools
License:             BSD3
License-file:        LICENSE
Author:              Chris Dornan <chrisd@irisconnect.co.uk> and Adam Gundry <adam@well-typed.com>
Maintainer:          Adam Gundry <adam@well-typed.com>
Copyright:           (c) Iris Connect 2013-2026
Category:            Network, Web, Cloud, Distributed Computing
Build-type:          Simple
Extra-source-files:  changelog
Cabal-version:       >=1.10
Tested-with:         GHC == 9.6.7, GHC == 9.8.4, GHC == 9.10.3, GHC == 9.12.4, GHC == 9.14.1

Source-Repository head
  Type:              git
  Location:          https://github.com/iconnect/api-tools.git

flag use-attoparsec-aeson
  description: Depend on Data.Aeson.Parser from attoparsec-aeson
  default: True
  manual: False

Library
  Hs-Source-Dirs:    src

  Exposed-modules:
        Data.API.API
        Data.API.API.DSL
        Data.API.API.Gen
        Data.API.Changes
        Data.API.Changes.Types
        Data.API.Doc
        Data.API.Doc.Subst
        Data.API.Error
        Data.API.JSON
        Data.API.JSON.Compat
        Data.API.JSONToCBOR
        Data.API.Markdown
        Data.API.NormalForm
        Data.API.Parse
        Data.API.PP
        Data.API.TH
        Data.API.Time
        Data.API.Tools
        Data.API.Tools.CBOR
        Data.API.Tools.Combinators
        Data.API.Tools.Datatypes
        Data.API.Tools.DeepSeq
        Data.API.Tools.Enum
        Data.API.Tools.Example
        Data.API.Tools.JSON
        Data.API.Tools.JSONTests
        Data.API.Tools.Lens
        Data.API.Tools.QuickCheck
        Data.API.Tools.SafeCopy
        Data.API.Tools.Traversal
        Data.API.Tutorial
        Data.API.Types
        Data.API.Utils
        Data.API.Value
        Data.Binary.Serialise.CBOR.Extra
        Data.Binary.Serialise.CBOR.JSON

  Other-modules:
        Data.API.Doc.Call
        Data.API.Doc.Dir
        Data.API.Doc.Types
        Data.API.Scan
        Data.API.TH.Compat
        Text.Regex

  Build-depends:
        QuickCheck           >= 2.5.1    && < 2.19 ,
        aeson-pretty         >= 0.1      && < 0.9  ,
        array                >= 0.4      && < 0.6  ,
        attoparsec           >= 0.10.4   && < 0.15 ,
        base                 >= 4.9      && < 5    ,
        base16-bytestring    >= 0.1      && < 1.1  ,
        base64-bytestring    >= 1.0      && < 1.3  ,
        bytestring           >= 0.9      && < 0.13 ,
        case-insensitive     >= 1.0      && < 1.3  ,
        cborg                >= 0.1.1.0  && < 0.3  ,
        containers           >= 0.5      && < 0.9  ,
        deepseq              >= 1.1      && < 1.7  ,
        lens                 >= 3.8.7    && < 5.4  ,
        regex-base           >= 0.93     && < 0.95 ,
        regex-tdfa           >= 1.1.0    && < 1.4  ,
        safe                 >= 0.3.3    && < 0.4  ,
        safecopy             >= 0.8.1    && < 0.11 ,
        scientific           >= 0.3      && < 0.4  ,
        serialise            >= 0.1.0.0  && < 0.3  ,
        template-haskell     >= 2.7      && < 2.25 ,
        text                 >= 0.11.3   && < 2.2  ,
        time                 >= 1.5.0    && < 1.17 ,
        unordered-containers >= 0.2.3.0  && < 0.3  ,
        vector               >= 0.10.0.1 && < 0.14

  if flag(use-attoparsec-aeson)
    Build-Depends:
        aeson                >= 2.2      && < 2.4  ,
        attoparsec-aeson     >= 2.1      && < 2.3
  else
    Build-Depends:
        aeson                >= 0.10 && < 1.6 || >= 2.0 && < 2.2

  Build-tools:
        alex,
        happy

  GHC-Options:
        -Wall
        -fwarn-tabs

  Default-Language: GHC2021


Executable migration-tool
  Hs-Source-Dirs:    main

  Main-is:    MigrationTool.hs

  Build-depends:
        api-tools,
        aeson,
        aeson-pretty,
        base,
        bytestring

  GHC-Options:
        -Wall
        -fwarn-tabs

  Default-Language: GHC2021


Executable perf-test
  Hs-Source-Dirs:    main

  Main-is:    PerfTest.hs

  Build-depends:
        api-tools,
        QuickCheck,
        aeson,
        base,
        deepseq,
        serialise

  GHC-Options:
        -Wall
        -fwarn-tabs
        -rtsopts

  Default-Language: GHC2021


Test-Suite test-api-tools
  Hs-Source-Dirs:    tests

  Type:       exitcode-stdio-1.0

  Main-is:    Data/API/Test/Main.hs

  Other-modules:
        Data.API.Test.DSL
        Data.API.Test.Gen
        Data.API.Test.JSON
        Data.API.Test.Migration
        Data.API.Test.MigrationData
        Data.API.Test.Time
        Data.API.Test.UnionMigration
        Data.API.Test.UnionMigrationData

  Build-depends:
        api-tools,
        QuickCheck,
        aeson,
        aeson-pretty,
        base,
        base64-bytestring,
        bytestring,
        cborg,
        containers,
        safecopy,
        serialise,
        tasty                >= 0.10.1   && < 1.6 ,
        tasty-hunit          >= 0.2      && < 0.11,
        tasty-quickcheck     >= 0.3      && < 0.12,
        time,
        template-haskell,
        text,
        unordered-containers

  GHC-Options:
        -Wall

  Default-Language: GHC2021

Benchmark bench-time
  Hs-Source-Dirs:   bench

  Type: exitcode-stdio-1.0

  Main-is: Main.hs

  Build-depends:
       api-tools,
       base,
       criterion,
       text,
       time

  GHC-Options:
        -Wall

  Default-Language: GHC2021