shields/services/bundlephobia/bundlephobia.service.js

import Joi from 'joi'
import { renderSizeBadge } from '../size.js'
import { nonNegativeInteger } from '../validators.js'
import { BaseJsonService, pathParams } from '../index.js'

const schema = Joi.object({
  size: nonNegativeInteger,
  gzip: nonNegativeInteger,
}).required()

const description =
  '[Bundlephobia](https://bundlephobia.com) lets you understand the size of a javascript package from NPM before it becomes a part of your bundle.'

export default class Bundlephobia extends BaseJsonService {
  static category = 'size'

  static route = {
    base: 'bundlephobia',
    pattern: ':format(min|minzip)/:scope(@[^/]+)?/:packageName/:version?',
  }

  static openApi = {
    '/bundlephobia/{format}/{packageName}': {
      get: {
        summary: 'npm bundle size',
        description,
        parameters: pathParams(
          {
            name: 'format',
            schema: { type: 'string', enum: this.getEnum('format') },
            example: 'min',
          },
          {
            name: 'packageName',
            example: 'react',
          },
        ),
      },
    },
    '/bundlephobia/{format}/{scope}/{packageName}': {
      get: {
        summary: 'npm bundle size (scoped)',
        description,
        parameters: pathParams(
          {
            name: 'format',
            schema: { type: 'string', enum: this.getEnum('format') },
            example: 'min',
          },
          {
            name: 'scope',
            example: '@cycle',
          },
          {
            name: 'packageName',
            example: 'core',
          },
        ),
      },
    },
    '/bundlephobia/{format}/{packageName}/{version}': {
      get: {
        summary: 'npm bundle size (version)',
        description,
        parameters: pathParams(
          {
            name: 'format',
            schema: { type: 'string', enum: this.getEnum('format') },
            example: 'min',
          },
          {
            name: 'packageName',
            example: 'react',
          },
          {
            name: 'version',
            example: '15.0.0',
          },
        ),
      },
    },
    '/bundlephobia/{format}/{scope}/{packageName}/{version}': {
      get: {
        summary: 'npm bundle size (scoped version)',
        description,
        parameters: pathParams(
          {
            name: 'format',
            schema: { type: 'string', enum: this.getEnum('format') },
            example: 'min',
          },
          {
            name: 'scope',
            example: '@cycle',
          },
          {
            name: 'packageName',
            example: 'core',
          },
          {
            name: 'version',
            example: '7.0.0',
          },
        ),
      },
    },
  }

  static _cacheLength = 900

  static defaultBadgeData = { label: 'bundlephobia', color: 'informational' }

  static render({ format, size }) {
    const label = format === 'min' ? 'minified size' : 'minzipped size'
    return renderSizeBadge(size, 'iec', label)
  }

  async fetch({ scope, packageName, version }) {
    const packageQuery = `${scope ? `${scope}/` : ''}${packageName}${
      version ? `@${version}` : ''
    }`
    const options = { searchParams: { package: packageQuery } }
    return this._requestJson({
      schema,
      url: 'https://bundlephobia.com/api/size',
      options,
      httpErrors: {
        404: 'package or version not found',
      },
    })
  }

  async handle({ format, scope, packageName, version }) {
    const json = await this.fetch({ scope, packageName, version })
    const size = format === 'min' ? json.size : json.gzip
    return this.constructor.render({ format, size })
  }
}