@verdaccio/server-fastify/src/routes/web/api/readme.ts

fastify server api implementation

import buildDebug from 'debug';
import { FastifyInstance } from 'fastify';

import { Manifest } from '@verdaccio/types';

const debug = buildDebug('verdaccio:fastify:web:readme');
export const NOT_README_FOUND = 'ERROR: No README data found!';

async function readmeRoute(fastify: FastifyInstance) {
  fastify.get('/package/readme/:packageName', async (request, reply) => {
    // @ts-ignore
    const { version, packageName } = request.params;
    debug('readme name %s   version: %s', packageName, version);
    const manifest = (await fastify.storage?.getPackageByOptions({
      name: packageName,
      // remove on refactor getPackageByOptions
      // @ts-ignore
      req: request.raw,
      version,
      uplinksLook: true,
      requestOptions: {
        protocol: request.protocol,
        headers: request.headers as any,
        host: request.hostname,
      },
    })) as Manifest;
    try {
      const parsedReadme = manifest.readme;
      reply.code(fastify.statusCode.OK).send(parsedReadme);
    } catch {
      reply.code(fastify.statusCode.OK).send(NOT_README_FOUND);
    }
  });

  fastify.get('/package/readme/:scope/:packageName', async (request, reply) => {
    // @ts-ignore
    const { version, packageName } = request.params;
    debug('readme name %s   version: %s', packageName, version);
    const manifest = (await fastify.storage?.getPackageByOptions({
      name: packageName,
      // remove on refactor getPackageByOptions
      // @ts-ignore
      req: request.raw,
      version,
      uplinksLook: true,
      requestOptions: {
        protocol: request.protocol,
        headers: request.headers as any,
        host: request.hostname,
      },
    })) as Manifest;
    try {
      reply.code(fastify.statusCode.OK).send(manifest.readme);
    } catch {
      reply.code(fastify.statusCode.OK).send(NOT_README_FOUND);
    }
  });
}

export default readmeRoute;