Files
shields/services/github/github-release-date.service.js
Paula Barszcz a251357881 [GitHubReleaseDate] - published_at field (#8543)
* gh release date - published at

* example correction

* change published_at query param to display_date

* simplify the  statement
2022-10-20 19:52:44 +01:00

103 lines
2.7 KiB
JavaScript

import dayjs from 'dayjs'
import Joi from 'joi'
import { age } from '../color-formatters.js'
import { formatDate } from '../text-formatters.js'
import { GithubAuthV3Service } from './github-auth-service.js'
import { documentation, errorMessagesFor } from './github-helpers.js'
const schema = Joi.alternatives(
Joi.object({
created_at: Joi.date().required(),
published_at: Joi.date().required(),
}).required(),
Joi.array()
.items(
Joi.object({
created_at: Joi.date().required(),
published_at: Joi.date().required(),
}).required()
)
.min(1)
)
const queryParamSchema = Joi.object({
display_date: Joi.string()
.valid('created_at', 'published_at')
.default('created_at'),
}).required()
export default class GithubReleaseDate extends GithubAuthV3Service {
static category = 'activity'
static route = {
base: 'github',
pattern: ':variant(release-date|release-date-pre)/:user/:repo',
queryParamSchema,
}
static examples = [
{
title: 'GitHub Release Date',
pattern: 'release-date/:user/:repo',
namedParams: {
user: 'SubtitleEdit',
repo: 'subtitleedit',
},
staticPreview: this.render({ date: '2017-04-13T07:50:27.000Z' }),
documentation,
},
{
title: 'GitHub (Pre-)Release Date',
pattern: 'release-date-pre/:user/:repo',
namedParams: {
user: 'Cockatrice',
repo: 'Cockatrice',
},
staticPreview: this.render({ date: '2017-04-13T07:50:27.000Z' }),
documentation,
},
{
title: 'GitHub Release Date - Published_At',
pattern: 'release-date/:user/:repo',
namedParams: {
user: 'microsoft',
repo: 'vscode',
},
queryParams: { display_date: 'published_at' },
staticPreview: this.render({ date: '2022-10-17T07:50:27.000Z' }),
documentation,
},
]
static defaultBadgeData = { label: 'release date' }
static render({ date }) {
const releaseDate = dayjs(date)
return {
message: formatDate(releaseDate),
color: age(releaseDate),
}
}
async fetch({ variant, user, repo }) {
const url =
variant === 'release-date'
? `/repos/${user}/${repo}/releases/latest`
: `/repos/${user}/${repo}/releases`
return this._requestJson({
url,
schema,
errorMessages: errorMessagesFor('no releases or repo not found'),
})
}
async handle({ variant, user, repo }, queryParams) {
const body = await this.fetch({ variant, user, repo })
if (Array.isArray(body)) {
return this.constructor.render({
date: body[0][queryParams.display_date],
})
}
return this.constructor.render({ date: body[queryParams.display_date] })
}
}