Files
shields/services/bundlejs/bundlejs-package.service.js
2026-07-26 07:39:38 +08:00

157 lines
4.5 KiB
JavaScript

import Joi from 'joi'
import byteSize from 'byte-size'
import { BaseJsonService, pathParam, queryParam } from '../index.js'
import { renderSizeBadge } from '../size.js'
import { nonNegativeInteger } from '../validators.js'
const schema = Joi.object({
size: Joi.object({
rawCompressedSize: nonNegativeInteger,
rawUncompressedSize: nonNegativeInteger,
}).required(),
}).required()
const queryParamSchema = Joi.object({
exports: Joi.string(),
externals: Joi.string(),
format: Joi.string().valid('min', 'minzip', 'both'),
}).required()
const esbuild =
'<a href="https://github.com/evanw/esbuild" target="_blank" rel="noopener">esbuild</a>'
const denoflate =
'<a href="https://github.com/hazae41/denoflate" target="_blank" rel="noopener">denoflate</a>'
const bundlejs =
'<a href="https://bundlejs.com/" target="_blank" rel="noopener">bundlejs</a>'
const description = `
View ${esbuild} minified and ${denoflate} gzipped size of a javascript package or selected exports, via ${bundlejs}.
`
export default class BundlejsPackage extends BaseJsonService {
static category = 'size'
static route = {
base: 'bundlejs/size',
pattern: ':scope(@[^/]+)?/:packageName+',
queryParamSchema,
}
static openApi = {
'/bundlejs/size/{packageName}': {
get: {
summary: 'npm package minimized gzipped size',
description,
parameters: [
pathParam({
name: 'packageName',
example: 'value-enhancer@3.1.2',
description:
'This can either be a package name e.g: `value-enhancer`, or a package name and version e.g: `value-enhancer@3.1.2`',
}),
queryParam({
name: 'exports',
example: 'isVal,val',
}),
queryParam({
name: 'externals',
example: 'lodash,axios',
}),
queryParam({
name: 'format',
schema: { type: 'string', enum: ['min', 'minzip', 'both'] },
example: 'minzip',
}),
],
},
},
'/bundlejs/size/{scope}/{packageName}': {
get: {
summary: 'npm package minimized gzipped size (scoped)',
description,
parameters: [
pathParam({
name: 'scope',
example: '@ngneat',
}),
pathParam({
name: 'packageName',
example: 'falso@6.4.0',
description:
'This can either be a package name e.g: `falso`, or a package name and version e.g: `falso@6.4.0`',
}),
queryParam({
name: 'exports',
example: 'randEmail,randFullName',
}),
queryParam({
name: 'externals',
example: 'lodash,axios',
}),
queryParam({
name: 'format',
schema: { type: 'string', enum: ['min', 'minzip', 'both'] },
example: 'minzip',
}),
],
},
},
}
static defaultBadgeData = { label: 'bundlejs', color: 'informational' }
async fetch({ scope, packageName, exports, externals }) {
const searchParams = {
q: `${scope ? `${scope}/` : ''}${packageName}`,
}
if (exports) {
searchParams.treeshake = `[{${exports}}]`
}
if (externals) {
searchParams.config = JSON.stringify({
esbuild: { external: externals.split(',') },
})
}
return this._requestJson({
schema,
url: 'https://deno.bundlejs.com',
options: {
searchParams,
timeout: 3500,
},
systemErrors: {
ETIMEDOUT: { prettyMessage: 'timeout', cacheSeconds: 10 },
},
httpErrors: {
404: 'package or version not found',
},
})
}
async handle({ scope, packageName }, { exports, externals, format }) {
const json = await this.fetch({ scope, packageName, exports, externals })
switch (format) {
case 'min':
return renderSizeBadge(
json.size.rawUncompressedSize,
'metric',
'minified size',
)
case 'both':
return {
label: 'size',
message: `${byteSize(json.size.rawUncompressedSize, { units: 'metric' })} (gzip: ${byteSize(json.size.rawCompressedSize, { units: 'metric' })})`,
color: 'blue',
}
default:
// by default use format === 'minzip'
// because that's how it used to be before the format query param was added
return renderSizeBadge(
json.size.rawCompressedSize,
'metric',
'minified size (gzip)',
)
}
}
}