[factorio-mod-portal] services #8625
Conversation
chris48s
added
the
service-badge
| import { renderVersionBadge } from '../version.js' | ||
|
|
||
| const schema = Joi.object({ | ||
| downloads_count: Joi.number().required(), |
There was a problem hiding this comment.
Lets validate this using nonNegativeInteger
| }).required() | ||
|
|
||
| // Factorio Mod portal API | ||
| // @see https://wiki.factorio.com/Mod_portal_API |
| // Badge for mod's latest compatible Factorio version | ||
| // Query 'range' to display range of compatible versions | ||
| class FactorioModPortalFactorioVersions extends BaseFactorioModPortalService { | ||
| static category = 'version' |
There was a problem hiding this comment.
Category for this one should be static category = 'platform-support'
| static category = 'version' | ||
|
|
||
| static route = { | ||
| base: 'factorio-mod-portal/latest-version', |
There was a problem hiding this comment.
Normally we use /v as the route for version badges - see https://github.com/badges/shields/blob/master/doc/badge-urls.md
| static category = 'downloads' | ||
|
|
||
| static route = { | ||
| base: 'factorio-mod-portal/downloads', |
There was a problem hiding this comment.
Normally we use /dt as the route for a badge showing total downloads - see https://github.com/badges/shields/blob/master/doc/badge-urls.md
| @@ -0,0 +1,50 @@ | |||
| import { | |||
| isComposerVersion, | |||
There was a problem hiding this comment.
isComposerVersion is a fairly specific validator for PHP package ranges. It looks like what you really want here is probably isVPlusDottedVersionNClauses or isVPlusDottedVersionAtLeastOne.
|
|
||
| async handle({ modName }, queryParams) { | ||
| const { first_release, latest_release } = await this.fetch({ modName }) | ||
| const range = queryParams.range !== undefined |
There was a problem hiding this comment.
Generally for platform & version support badges, we just show compatibility with the base platform for the latest release of the target package/plugin/whatever (in this case, the factorio version(s) that the latest release of the mod is compatible with). I think I'd be in favour of dropping the range param and sticking with that here.
| return { | ||
| downloads_count, | ||
| first_release: releases[0], | ||
| latest_release: releases[releases.length - 1], |
There was a problem hiding this comment.
Do we have complete confidence this array is sorted by version? The docs aren't completely clear.
There was a problem hiding this comment.
I couldn't find in the docs or anywhere else that explicitly says it's sorted by version, but I made a small script to run through every mod listed and can confirm that the releases array is always sorted by version.
Saw this #8582 issue and thought I'd take a crack at closing it. I'm new to open-source contributions so I'm eager to hear any feedback/changes.
API:
https://mods.factorio.com/api/mods/{name}where {name} is the name of the mod, e.g.https://mods.factorio.com/api/mods/rso-mod
No authentication is required.
API is documented here: https://wiki.factorio.com/Mod_portal_API#/api/mods/