Package.elm-lang.org api

DullBananas · November 24, 2020, 6:46pm

is there any docs for the package.elm-lang.org api?

DullBananas · November 25, 2020, 3:41pm

so far i only found this endpoint https://package.elm-lang.org/all-packages

Sidney · November 25, 2020, 11:59pm

Your best bet is to take a look at the backend for the package site. Here’s the main routing logic:

elm/package.elm-lang.org/blob/master/src/backend/Main.hs#L94-L133


serve :: Artifacts.Artifacts -> GitHub.Token -> Memory.Memory -> S.Snap ()
serve artifacts token memory =
  asum
    [
      -- LEGACY USERS (<0.19)
      Legacy.getElmVersion >>= Legacy.serve
    ,
      -- NORMAL ROUTES
      Router.serve $ Router.oneOf $
        [ top ==> ServeFile.misc artifacts "Elm Packages"
        , s "packages" ==> S.redirect' "/" 301
        , s "packages" </> bytes </> bytes </> packageRoute ==> servePackageInfo artifacts memory
        , s "all-packages" ==> serveFile "all-packages.json"
        , s "all-packages" </> s "since" </> int ==> serveNewPackages memory
        , s "register" ==> Register.register token memory
        , s "artifacts" </> bytes ==> Artifacts.serve artifacts
        , s "assets" </> s "fonts.css" ==> serveFonts
        , s "help" </>
            Router.oneOf
              [ s "design-guidelines" ==> ServeFile.misc artifacts "Design Guidelines"

This file has been truncated. show original

DullBananas · November 26, 2020, 3:14am

thank you. i also found this which helped me

github.com

elm/compiler/blob/3c618045431de75d6029cb65997113247e4a23f7/builder/src/Elm/Details.hs#L748


    RLocal _ _ docs -> docs
    RForeign _      -> Nothing
    RKernelLocal _  -> Nothing
    RKernelForeign  -> Nothing
-- DOWNLOAD PACKAGE
downloadPackage :: Stuff.PackageCache -> Http.Manager -> Pkg.Name -> V.Version -> IO (Either Exit.PackageProblem ())
downloadPackage cache manager pkg vsn =
  let
    url = Website.metadata pkg vsn "endpoint.json"
  in
  do  eitherByteString <-
        Http.get manager url [] id (return . Right)
      case eitherByteString of
        Left err ->
          return $ Left $ Exit.PP_BadEndpointRequest err

example https://package.elm-lang.org/packages/elm/core/1.0.5/endpoint.json

the hash is sha1

Topic		Replies	Views
Local access to elm documentation? Learn	13	1317	October 15, 2020
Packages for elm 0.18 Learn	2	932	September 1, 2018
Elm Packages Sublime Text package :) Show and Tell	9	848	April 28, 2022
Where did the reference for package SemVer go? Learn	3	671	April 4, 2021
Elm-help, a tool to read packages docs from the command line Show and Tell	3	1017	January 26, 2018

Package.elm-lang.org api

Related topics