@verdaccio/web/src/api/sidebar.ts

web ui middleware

import buildDebug from 'debug';
import { Router } from 'express';

import { Auth } from '@verdaccio/auth';
import { DIST_TAGS, HTTP_STATUS } from '@verdaccio/core';
import { logger } from '@verdaccio/logger';
import { $NextFunctionVer, $RequestExtend, $ResponseExtend, allow } from '@verdaccio/middleware';
import { Storage } from '@verdaccio/store';
import { convertDistRemoteToLocalTarballUrls } from '@verdaccio/tarball';
import { Config, Manifest, Version } from '@verdaccio/types';
import { addGravatarSupport, formatAuthor, isVersionValid } from '@verdaccio/utils';

import { AuthorAvatar, addScope, deleteProperties } from '../web-utils';

export { $RequestExtend, $ResponseExtend, $NextFunctionVer }; // Was required by other packages

export type PackageExt = Manifest & { author: AuthorAvatar; dist?: { tarball: string } };

export type $SidebarPackage = Manifest & { latest: Version };
const debug = buildDebug('verdaccio:web:api:sidebar');

function addSidebarWebApi(config: Config, storage: Storage, auth: Auth): Router {
  debug('initialized sidebar web api');
  const router = Router(); /* eslint new-cap: 0 */
  const can = allow(auth, {
    beforeAll: (a, b) => logger.trace(a, b),
    afterAll: (a, b) => logger.trace(a, b),
  });
  // Get package readme
  router.get(
    '/sidebar/(@:scope/)?:package',
    can('access'),
    async function (
      req: $RequestExtend,
      res: $ResponseExtend,
      next: $NextFunctionVer
    ): Promise<void> {
      const name: string = req.params.scope
        ? addScope(req.params.scope, req.params.package)
        : req.params.package;
      const requestOptions = {
        protocol: req.protocol,
        headers: req.headers as any,
        // FIXME: if we migrate to req.hostname, the port is not longer included.
        host: req.host,
        remoteAddress: req.socket.remoteAddress,
      };
      try {
        const info = (await storage.getPackageByOptions({
          name,
          uplinksLook: true,
          keepUpLinkData: true,
          requestOptions,
        })) as Manifest;
        const { v } = req.query;
        let sideBarInfo = { ...info };
        sideBarInfo.versions = convertDistRemoteToLocalTarballUrls(
          info,
          { protocol: req.protocol, headers: req.headers as any, host: req.hostname },
          config.url_prefix
        ).versions;
        // TODO: review this implementation
        if (typeof v === 'string' && isVersionValid(info, v)) {
          // @ts-ignore
          sideBarInfo.latest = sideBarInfo.versions[v];
          // @ts-ignore
          sideBarInfo.latest.author = formatAuthor(sideBarInfo.latest.author);
        } else {
          // @ts-ignore
          sideBarInfo.latest = sideBarInfo.versions[info[DIST_TAGS].latest];
          // @ts-ignore
          sideBarInfo.latest.author = formatAuthor(sideBarInfo.latest.author);
        }
        sideBarInfo = deleteProperties(['readme', '_attachments', '_rev', 'name'], sideBarInfo);
        const authorAvatar = config.web
          ? addGravatarSupport(sideBarInfo, config.web.gravatar)
          : addGravatarSupport(sideBarInfo);
        next(authorAvatar);
      } catch (err) {
        res.status(HTTP_STATUS.NOT_FOUND);
        res.end();
      }
    }
  );

  return router;
}

export default addSidebarWebApi;