bfa712469a
* migrate some services from examples to openApi * always use capitals in period/interval description
83 lines
2.3 KiB
JavaScript
83 lines
2.3 KiB
JavaScript
import Joi from 'joi'
|
|
import dayjs from 'dayjs'
|
|
import { nonNegativeInteger } from '../validators.js'
|
|
import { BaseJsonService, pathParams } from '../index.js'
|
|
import { renderDownloadsBadge } from '../downloads.js'
|
|
|
|
const schema = Joi.object()
|
|
.pattern(Joi.string(), Joi.object().pattern(Joi.string(), nonNegativeInteger))
|
|
.required()
|
|
|
|
const intervalMap = {
|
|
dw: { interval: 'week' },
|
|
dm: { interval: 'month' },
|
|
dy: { interval: 'year' },
|
|
}
|
|
|
|
export default class NpmStatDownloads extends BaseJsonService {
|
|
static category = 'downloads'
|
|
|
|
static route = {
|
|
base: 'npm-stat',
|
|
pattern: ':interval(dw|dm|dy)/:author',
|
|
}
|
|
|
|
static openApi = {
|
|
'/npm-stat/{interval}/{author}': {
|
|
get: {
|
|
summary: 'NPM Downloads by package author',
|
|
description:
|
|
'The total number of downloads of npm packages published by the specified author from [npm-stat](https://npm-stat.com).',
|
|
parameters: pathParams(
|
|
{
|
|
name: 'interval',
|
|
example: 'dw',
|
|
schema: { type: 'string', enum: this.getEnum('interval') },
|
|
description: 'Downloads per Week, Month or Year',
|
|
},
|
|
{
|
|
name: 'author',
|
|
example: 'dukeluo',
|
|
},
|
|
),
|
|
},
|
|
},
|
|
}
|
|
|
|
static _cacheLength = 21600
|
|
|
|
static defaultBadgeData = { label: 'downloads' }
|
|
|
|
static getTotalDownloads(data) {
|
|
const add = (x, y) => x + y
|
|
const sum = nums => nums.reduce(add, 0)
|
|
|
|
return Object.values(data).reduce(
|
|
(count, packageDownloads) => count + sum(Object.values(packageDownloads)),
|
|
0,
|
|
)
|
|
}
|
|
|
|
static render({ interval, downloads }) {
|
|
return renderDownloadsBadge({
|
|
downloads,
|
|
interval: intervalMap[interval].interval,
|
|
colorOverride: downloads > 0 ? 'brightgreen' : 'red',
|
|
})
|
|
}
|
|
|
|
async handle({ interval, author }) {
|
|
const unit = intervalMap[interval].interval
|
|
const today = dayjs()
|
|
const until = today.format('YYYY-MM-DD')
|
|
const from = today.subtract(1, unit).format('YYYY-MM-DD')
|
|
const data = await this._requestJson({
|
|
url: `https://npm-stat.com/api/download-counts?author=${author}&from=${from}&until=${until}`,
|
|
schema,
|
|
})
|
|
const downloads = this.constructor.getTotalDownloads(data)
|
|
|
|
return this.constructor.render({ interval, downloads })
|
|
}
|
|
}
|