Merge branch 'development' into main

Author: maradotwebp

src/api/cfclient.nim

@@ -1,37 +1,43 @@
-## Provides functions for connecting to the unofficial curseforge api.
+## Provides functions for connecting to the CF proxy [https://github.com/bmpm-mc/cfproxy].
 ## 
-## The unofficial API has capabilities like:
+## The proxy connects to the official API internally, and has capabilities like:
 ## - Searching for a addon.
 ## - Retrieving an addon by their project id.
 ## - Retrieving the files of an given addon.
 ## 
-## Some docs for the unofficial API are available at https://gaz492.github.io/.
+## Docs for the official API are available at https://docs.curseforge.com.
+## Requests to the proxy stay the same, except the base URL is switched out.
 
 import asyncdispatch, json, options, strutils
 import uri except Url
 import cfcore, http
 
 const
-  ## base url of the forgesvc endpoint
-  addonsBaseUrl = "https://addons-ecs.forgesvc.net/api/v2"
+  ## base url of the cfproxy endpoint
+  addonsBaseUrl = "https://cfproxy.fly.dev"
   ## base url of the curse metadata api endpoint
   ## used for retrieving mods by their slug, which isn't possible with the curse api
   addonsSlugBaseUrl = "https://curse.nikky.moe/graphql"
 
-proc fetchAddonsByQuery*(query: string, category = CfAddonGameCategory.Mod): Future[seq[CfAddon]] {.async.} =
+proc fetchAddonsByQuery*(query: string, category: Option[CfAddonGameCategory]): Future[seq[CfAddon]] {.async.} =
   ## retrieves all addons that match the given `query` search and `category`.
   let encodedQuery = encodeUrl(query, usePlus = false)
-  let url = addonsBaseUrl & "/addon/search?gameId=432&sectionId=" & $category & "&pageSize=50&searchFilter=" & encodedQuery
+  var url = addonsBaseUrl & "/v1/mods/search?gameId=432&pageSize=50&sortField=6&sortOrder=desc&searchFilter=" & encodedQuery
+  if category.isSome:
+    url = url & "&classId=" & $ord(category.get())
   try:
-    return get(url.Url).await.parseJson.addonsFromForgeSvc
+    return get(url.Url).await.parseJson["data"].addonsFromForgeSvc
   except HttpRequestError:
     return @[]
 
+proc fetchAddonsByQuery*(query: string): Future[seq[CfAddon]] {.async.} =
+  return await fetchAddonsByQuery(query, category = none[CfAddonGameCategory]())
+
 proc fetchAddon*(projectId: int): Future[Option[CfAddon]] {.async.} =
   ## get the addon with the given `projectId`.
-  let url = addonsBaseUrl & "/addon/" & $projectId
+  let url = addonsBaseUrl & "/v1/mods/" & $projectId
   try:
-    return get(url.Url).await.parseJson.addonFromForgeSvc.some
+    return get(url.Url).await.parseJson["data"].addonFromForgeSvc.some
   except HttpRequestError:
     return none[CfAddon]()
 
@@ -53,16 +59,16 @@ proc fetchAddon*(slug: string): Future[Option[CfAddon]] {.async.} =
 
 proc fetchAddonFiles*(projectId: int): Future[seq[CfAddonFile]] {.async.} =
   ## get all addon files associated with the given `projectId`.
-  let url = addonsBaseUrl & "/addon/" & $projectId & "/files"
+  let url = addonsBaseUrl & "/v1/mods/" & $projectId & "/files?pageSize=10000"
   try:
-    return get(url.Url).await.parseJson.addonFilesFromForgeSvc
+    return get(url.Url).await.parseJson["data"].addonFilesFromForgeSvc
   except HttpRequestError:
     return @[]
 
 proc fetchAddonFile*(projectId: int, fileId: int): Future[Option[CfAddonFile]] {.async.} =
   ## get the addon file with the given `fileId` & `projectId`.
-  let url = addonsBaseUrl & "/addon/" & $projectId & "/file/" & $fileId
+  let url = addonsBaseUrl & "/v1/mods/" & $projectId & "/files/" & $fileId
   try:
-    return get(url.Url).await.parseJson.addonFileFromForgeSvc.some
+    return get(url.Url).await.parseJson["data"].addonFileFromForgeSvc.some
   except HttpRequestError:
     return none[CfAddonFile]()

src/api/cfcore.nim

@@ -49,11 +49,11 @@ converter addonFileFromForgeSvc*(json: JsonNode): CfAddonFile =
   result.name = json["displayName"].getStr()
   result.releaseType = json["releaseType"].getInt().CfAddonFileReleaseType
   result.downloadUrl = json["downloadUrl"].getStr()
-  result.gameVersions = json["gameVersion"].getElems().map((x) => x.getStr().Version)
+  result.gameVersions = json["gameVersions"].getElems().map((x) => x.getStr().Version)
   result.dependencies = collect(newSeq):
     for depends in json["dependencies"].getElems():
-      if depends["type"].getInt() == RequiredDependencyType:
-        depends["addonId"].getInt()
+      if depends["relationType"].getInt() == RequiredDependencyType:
+        depends["modId"].getInt()
 
 converter addonFilesFromForgeSvc*(json: JsonNode): seq[CfAddonFile] =
   ## creates addon files from json retrieved by an forgesvc endpoint
@@ -65,15 +65,15 @@ converter addonFromForgeSvc*(json: JsonNode): CfAddon =
   result.projectId = json["id"].getInt()
   result.name = json["name"].getStr()
   result.description = json["summary"].getStr()
-  result.websiteUrl = json["websiteUrl"].getStr()
+  result.websiteUrl = json["links"]{"websiteUrl"}.getStr()
   result.authors = json["authors"].getElems().map((x) => x["name"].getStr())
   result.downloads = json["downloadCount"].getFloat().int
-  result.popularity = json["popularityScore"].getFloat()
+  result.popularity = json["gamePopularityRank"].getFloat()
   result.latestFiles = json["latestFiles"].getElems().map(addonFileFromForgeSvc)
   result.gameVersionLatestFiles = collect(newSeq):
-    for file in json["gameVersionLatestFiles"].getElems():
+    for file in json["latestFilesIndexes"].getElems():
       let version = file["gameVersion"].getStr().Version
-      let fileId = file["projectFileId"].getInt()
+      let fileId = file["fileId"].getInt()
       (version: version, fileId: fileId)
 
 converter addonsFromForgeSvc*(json: JsonNode): seq[CfAddon] =

src/cmd/add.nim

@@ -38,7 +38,7 @@ proc strScan(input: string, strVal: var string, start: int): int =
     inc result
   strVal = input.substr(start, start+result-1)
 
-proc paxAdd*(input: string, noDepends: bool, strategy: string): void =
+proc paxAdd*(input: string, noDepends: bool, strategy: string, addonType: string): void =
   ## add a new mod
   requirePaxProject()
 
@@ -116,7 +116,14 @@ proc paxAdd*(input: string, noDepends: bool, strategy: string): void =
 
   else:
     ## Just search normally
-    let mcMods = waitFor(fetchAddonsByQuery(input))
+    let addonType: Option[CfAddonGameCategory] = case addonType:
+      of "mod":
+        some(CfAddonGameCategory.Mod)
+      of "resourcepack":
+        some(CfAddonGameCategory.Resourcepack)
+      else:
+        none[CfAddonGameCategory]()
+    let mcMods = waitFor(fetchAddonsByQuery(input, addonType))
     let mcModOption = manifest.promptAddonChoice(mcMods, selectInstalled = false)
     if mcModOption.isNone:
       echoError "No mods found for your search."

src/pax.nim

@@ -60,6 +60,10 @@ let addCmd = (
   noDepends: newCountArg(@["--no-deps"],
     help = "don't install dependencies"
   ),
+  addonType: newStringArg(@["-t", "--type"],
+    choices = @["mod", "resourcepack"],
+    help = "restrict search to a certain addon type"
+  ),
   strategy: commonArgs.strategy,
   yes: commonArgs.yes,
   noColor: commonArgs.noColor,
@@ -209,8 +213,12 @@ if spec.init.seen:
 elif spec.list.seen:
   paxList(status = listCmd.status.seen, info = listCmd.info.seen)
 elif spec.add.seen:
-  paxAdd(input = addCmd.input.value, noDepends = addCmd.noDepends.seen,
-      strategy = addCmd.strategy.value)
+  paxAdd(
+    input = addCmd.input.value,
+    noDepends = addCmd.noDepends.seen,
+    strategy = addCmd.strategy.value,
+    addonType = addCmd.addonType.value
+  )
 elif spec.remove.seen:
   paxRemove(name = removeCmd.name.value, strategy = removeCmd.strategy.value)
 elif spec.pin.seen:

tests/api/tcfclient.nim

@@ -1,16 +1,23 @@
 discard """
   cmd: "nim $target --hints:on -d:testing -d:ssl --nimblePath:tests/deps $options $file"
-  disabled: "win"
 """
 
-import asyncdispatch, options, sequtils, sugar
+import asyncdispatch, options, sequtils, strutils, sugar
 import api/cfclient, api/cfcore
 
 block: # fetch by query
   let mods = waitFor(fetchAddonsByQuery("jei"))
   doAssert mods[0].projectId == 238222
   doAssert mods[0].name == "Just Enough Items (JEI)"
 
+block: # fetch mods by query
+  let mods = waitFor(fetchAddonsByQuery("jei", some(CfAddonGameCategory.Mod)))
+  doAssert mods.all(m => m.websiteUrl.contains("/mc-mods/"))
+
+block: # fetch resource packs  by query
+  let mods = waitFor(fetchAddonsByQuery("jei", some(CfAddonGameCategory.Resourcepack)))
+  doAssert mods.all(m => m.websiteUrl.contains("/texture-packs/"))
+
 block: # fetch mod by id
   let mcMod = waitFor(fetchAddon(220318)).get()
   doAssert mcMod.projectId == 220318