Skip to main content

mix.exs

defmodule Solaris.MixProject do
  use Mix.Project

  @version "1.0.0"
  @source_url "https://github.com/iamkanishka/solaris"

  def project do
    [
      app: :solaris,
      version: @version,
      elixir: "~> 1.18",
      elixirc_paths: elixirc_paths(Mix.env()),
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      aliases: aliases(),

      # Hex
      description: description(),
      package: package(),
      name: "Solaris",
      source_url: @source_url,
      homepage_url: "https://solarisgroup.com",
      docs: docs(),

      # Test coverage
      test_coverage: [tool: ExCoveralls],
      preferred_cli_env: [
        coveralls: :test,
        "coveralls.detail": :test,
        "coveralls.html": :test,
        "coveralls.json": :test
      ],

      # Dialyzer
      dialyzer: [
        plt_file: {:no_warn, "priv/plts/dialyzer.plt"},
        plt_add_apps: [:ex_unit, :req, :jason, :telemetry],
        flags: [
          :error_handling,
          :missing_return,
          :underspecs,
          :unknown
        ],
        ignore_warnings: ".dialyzer_ignore.exs",
        list_unused_filters: true
      ]
    ]
  end

  def application do
    [
      extra_applications: [:logger, :crypto],
      mod: {Solaris.Application, []}
    ]
  end

  defp elixirc_paths(:test), do: ["lib", "test/support"]
  defp elixirc_paths(_env), do: ["lib"]

  defp deps do
    [
      # HTTP client
      {:req, "~> 0.4"},

      # JSON
      {:jason, "~> 1.4"},

      # Observability
      {:telemetry, "~> 1.2"},
      {:telemetry_metrics, "~> 0.6"},

      # Rate limiting
      {:hammer, "~> 6.1"},

      # Plug — optional; only needed when using Solaris.Webhooks.Plug
      {:plug, "~> 1.15", optional: true},
      {:plug_crypto, "~> 2.0", optional: true},

      # Dev / test
      {:ex_doc, "~> 0.31", only: :dev, runtime: false},
      {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
      {:excoveralls, "~> 0.18", only: :test},
      {:bypass, "~> 2.1", only: :test},
      {:mox, "~> 1.1", only: :test},
      {:stream_data, "~> 0.6", only: :test}
    ]
  end

  defp aliases do
    [
      # Run all quality checks
      qa: ["format --check-formatted", "credo --strict", "dialyzer"],
      # Run tests with coverage
      "test.ci": ["coveralls.json"],
      # Format, lint, type-check
      lint: ["format", "credo --strict"],
      # Type check only
      typecheck: ["dialyzer"]
    ]
  end

  defp description do
    """
    Production-grade Elixir client for the Solaris Embedded Finance API.
    Covers Onboarding (Persons & Businesses), KYC, Digital Banking, SEPA
    Transfers, Cards, Lending, and Webhooks with full telemetry, retries,
    rate-limiting, OAuth2 token management, and typed error handling.
    """
  end

  defp package do
    [
      maintainers: ["Kanishka Naik"],
      licenses: ["MIT"],
      links: %{
        "GitHub" => @source_url,
        "Solaris API Docs" => "https://docs.solarisgroup.com"
      },
      files: ~w(lib .formatter.exs mix.exs README.md LICENSE CHANGELOG.md)
    ]
  end

  defp docs do
    [
      main: "readme",
      source_ref: "v#{@version}",
      source_url: @source_url,
      extras: ["README.md", "CHANGELOG.md", "LICENSE"],
      groups_for_modules: [
        Core: [
          Solaris,
          Solaris.Auth,
          Solaris.Client,
          Solaris.Config,
          Solaris.Error,
          Solaris.Pagination,
          Solaris.RateLimiter,
          Solaris.Telemetry,
          Solaris.ChangeRequests
        ],
        Onboarding: [
          Solaris.Onboarding.Persons,
          Solaris.Onboarding.Businesses,
          Solaris.Onboarding.KYC
        ],
        "Digital Banking": [
          Solaris.Banking.Accounts,
          Solaris.Banking.SEPA,
          Solaris.Banking.Transactions
        ],
        Cards: [Solaris.Cards],
        Lending: [
          Solaris.Lending.Loans,
          Solaris.Lending.ConsumerLoans,
          Solaris.Lending.Overdraft,
          Solaris.Lending.Splitpay,
          Solaris.Lending.AccountSnapshots,
          Solaris.Lending.TradeFinance
        ],
        Webhooks: [
          Solaris.Webhooks,
          Solaris.Webhooks.Handler,
          Solaris.Webhooks.LoggingHandler,
          Solaris.Webhooks.Plug,
          Solaris.Webhooks.Plug.BodyReader
        ]
      ]
    ]
  end
end