@verdaccio/web 6.0.0-6-next.45 → 6.0.0-6-next.47

package/build/web-middleware.js

@@ -1,21 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _express = _interopRequireDefault(require("express"));
-var _renderWeb = require("./middleware/render-web");
-var _webApi = require("./middleware/web-api");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-var _default = async (config, auth, storage) => {
-  // eslint-disable-next-line new-cap
-  const app = _express.default.Router();
-  // load application
-  app.use('/', await (0, _renderWeb.renderWebMiddleware)(config, auth));
-  // web endpoints, search, packages, etc
-  app.use('/-/verdaccio/', (0, _webApi.webAPI)(config, auth, storage));
-  return app;
-};
-exports.default = _default;
-//# sourceMappingURL=web-middleware.js.map

package/build/web-middleware.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"web-middleware.js","names":["config","auth","storage","app","express","Router","use","renderWebMiddleware","webAPI"],"sources":["../src/web-middleware.ts"],"sourcesContent":["import express from 'express';\n\nimport { renderWebMiddleware } from './middleware/render-web';\nimport { webAPI } from './middleware/web-api';\n\nexport default async (config, auth, storage) => {\n  // eslint-disable-next-line new-cap\n  const app = express.Router();\n  // load application\n  app.use('/', await renderWebMiddleware(config, auth));\n  // web endpoints, search, packages, etc\n  app.use('/-/verdaccio/', webAPI(config, auth, storage));\n  return app;\n};\n"],"mappings":";;;;;;AAAA;AAEA;AACA;AAA8C;AAAA,eAE/B,OAAOA,MAAM,EAAEC,IAAI,EAAEC,OAAO,KAAK;EAC9C;EACA,MAAMC,GAAG,GAAGC,gBAAO,CAACC,MAAM,EAAE;EAC5B;EACAF,GAAG,CAACG,GAAG,CAAC,GAAG,EAAE,MAAM,IAAAC,8BAAmB,EAACP,MAAM,EAAEC,IAAI,CAAC,CAAC;EACrD;EACAE,GAAG,CAACG,GAAG,CAAC,eAAe,EAAE,IAAAE,cAAM,EAACR,MAAM,EAAEC,IAAI,EAAEC,OAAO,CAAC,CAAC;EACvD,OAAOC,GAAG;AACZ,CAAC;AAAA"}

package/src/middleware/render-web.ts

@@ -1,91 +0,0 @@
-import buildDebug from 'debug';
-import express from 'express';
-import _ from 'lodash';
-import path from 'path';
-
-import { HTTP_STATUS } from '@verdaccio/core';
-import { asyncLoadPlugin } from '@verdaccio/loaders';
-import { logger } from '@verdaccio/logger';
-import { isURLhasValidProtocol } from '@verdaccio/url';
-
-import renderHTML from '../renderHTML';
-import { setSecurityWebHeaders } from './security';
-
-const debug = buildDebug('verdaccio:web:render');
-
-export async function loadTheme(config: any) {
-  if (_.isNil(config.theme) === false) {
-    const plugin = await asyncLoadPlugin(
-      config.theme,
-      { config, logger },
-      // TODO: add types { staticPath: string; manifest: unknown; manifestFiles: unknown }
-      function (plugin: any) {
-        return plugin.staticPath && plugin.manifest && plugin.manifestFiles;
-      },
-      config?.serverSettings?.pluginPrefix ?? 'verdaccio-theme'
-    );
-    if (plugin.length > 1) {
-      logger.warn(
-        'multiple ui themes has been detected and is not supported, only the first one will be used'
-      );
-    }
-
-    return _.head(plugin);
-  }
-}
-
-const sendFileCallback = (next) => (err) => {
-  if (!err) {
-    return;
-  }
-  if (err.status === HTTP_STATUS.NOT_FOUND) {
-    next();
-  } else {
-    next(err);
-  }
-};
-
-export async function renderWebMiddleware(config, auth): Promise<any> {
-  const { staticPath, manifest, manifestFiles } =
-    (await loadTheme(config)) || require('@verdaccio/ui-theme')();
-  debug('static path %o', staticPath);
-
-  /* eslint new-cap:off */
-  const router = express.Router();
-  router.use(auth.webUIJWTmiddleware());
-  router.use(setSecurityWebHeaders);
-
-  // Logo
-  let logoURI = config?.web?.logo ?? '';
-  if (logoURI && !isURLhasValidProtocol(logoURI)) {
-    // URI related to a local file
-
-    // Note: `path.join` will break on Windows, because it transforms `/` to `\`
-    // Use POSIX version `path.posix.join` instead.
-    logoURI = path.posix.join('/-/static/', path.basename(logoURI));
-    router.get(logoURI, function (req, res, next) {
-      res.sendFile(path.resolve(config.web.logo), sendFileCallback(next));
-      debug('render static');
-    });
-  }
-
-  // Static
-  router.get('/-/static/*', function (req, res, next) {
-    const filename = req.params[0];
-    const file = `${staticPath}/${filename}`;
-    debug('render static file %o', file);
-    res.sendFile(file, sendFileCallback(next));
-  });
-
-  router.get('/-/web/:section/*', function (req, res) {
-    renderHTML(config, manifest, manifestFiles, req, res);
-    debug('render html section');
-  });
-
-  router.get('/', function (req, res) {
-    renderHTML(config, manifest, manifestFiles, req, res);
-    debug('render root');
-  });
-
-  return router;
-}

package/src/middleware/security.ts

@@ -1,18 +0,0 @@
-import { HEADERS } from '@verdaccio/core';
-import { $NextFunctionVer, $RequestExtend, $ResponseExtend } from '@verdaccio/middleware';
-
-export function setSecurityWebHeaders(
-  req: $RequestExtend,
-  res: $ResponseExtend,
-  next: $NextFunctionVer
-): void {
-  // disable loading in frames (clickjacking, etc.)
-  res.header(HEADERS.FRAMES_OPTIONS, 'deny');
-  // avoid stablish connections outside of domain
-  res.header(HEADERS.CSP, "connect-src 'self'");
-  // https://stackoverflow.com/questions/18337630/what-is-x-content-type-options-nosniff
-  res.header(HEADERS.CTO, 'nosniff');
-  // https://stackoverflow.com/questions/9090577/what-is-the-http-header-x-xss-protection
-  res.header(HEADERS.XSS, '1; mode=block');
-  next();
-}

package/src/middleware/web-api.ts

@@ -1,25 +0,0 @@
-import bodyParser from 'body-parser';
-import { Router } from 'express';
-
-import { Auth } from '@verdaccio/auth';
-import { validateName, validatePackage } from '@verdaccio/middleware';
-import { Storage } from '@verdaccio/store';
-import { Config } from '@verdaccio/types';
-
-import webEndpointsApi from '../api';
-import { setSecurityWebHeaders } from './security';
-
-export function webAPI(config: Config, auth: Auth, storage: Storage): Router {
-  // eslint-disable-next-line new-cap
-  const route = Router();
-  // validate all of these params as a package name
-  // this might be too harsh, so ask if it causes trouble=
-  route.param('package', validatePackage);
-  route.param('filename', validateName);
-  route.param('version', validateName);
-  route.use(bodyParser.urlencoded({ extended: false }));
-  route.use(auth.webUIJWTmiddleware());
-  route.use(setSecurityWebHeaders);
-  route.use(webEndpointsApi(auth, storage, config));
-  return route;
-}

package/src/renderHTML.ts

@@ -1,112 +0,0 @@
-import buildDebug from 'debug';
-import LRU from 'lru-cache';
-import { URL } from 'url';
-
-import { WEB_TITLE } from '@verdaccio/config';
-import { HEADERS } from '@verdaccio/core';
-import { TemplateUIOptions } from '@verdaccio/types';
-import { getPublicUrl } from '@verdaccio/url';
-
-import renderTemplate from './template';
-import { hasLogin, validatePrimaryColor } from './utils/web-utils';
-
-const pkgJSON = require('../package.json');
-const DEFAULT_LANGUAGE = 'es-US';
-const cache = new LRU({ max: 500, ttl: 1000 * 60 * 60 });
-
-const debug = buildDebug('verdaccio:web:render');
-
-const defaultManifestFiles = {
-  js: ['runtime.js', 'vendors.js', 'main.js'],
-  ico: 'favicon.ico',
-};
-
-export default function renderHTML(config, manifest, manifestFiles, req, res) {
-  const { url_prefix } = config;
-  const base = getPublicUrl(config?.url_prefix, req);
-  const basename = new URL(base).pathname;
-  const language = config?.i18n?.web ?? DEFAULT_LANGUAGE;
-  const needHtmlCache = [undefined, null].includes(config?.web?.html_cache)
-    ? true
-    : config.web.html_cache;
-  const darkMode = config?.web?.darkMode ?? false;
-  const title = config?.web?.title ?? WEB_TITLE;
-  const login = hasLogin(config);
-  const scope = config?.web?.scope ?? '';
-  const logoURI = config?.web?.logo ?? '';
-  const pkgManagers = config?.web?.pkgManagers ?? ['yarn', 'pnpm', 'npm'];
-  const version = pkgJSON.version;
-  const flags = {
-    ...config.flags,
-  };
-  const primaryColor = validatePrimaryColor(config?.web?.primary_color) ?? '#4b5e40';
-  const {
-    scriptsBodyAfter,
-    metaScripts,
-    scriptsbodyBefore,
-    showInfo,
-    showSettings,
-    showThemeSwitch,
-    showFooter,
-    showSearch,
-    showDownloadTarball,
-  } = Object.assign(
-    {},
-    {
-      scriptsBodyAfter: [],
-      bodyBefore: [],
-      metaScripts: [],
-    },
-    config?.web
-  );
-  const options: TemplateUIOptions = {
-    showInfo,
-    showSettings,
-    showThemeSwitch,
-    showFooter,
-    showSearch,
-    showDownloadTarball,
-    darkMode,
-    url_prefix,
-    basename,
-    base,
-    primaryColor,
-    version,
-    logoURI,
-    flags,
-    login,
-    pkgManagers,
-    title,
-    scope,
-    language,
-  };
-
-  let webPage;
-
-  try {
-    webPage = cache.get('template');
-    if (!webPage) {
-      webPage = renderTemplate(
-        {
-          manifest: manifestFiles ?? defaultManifestFiles,
-          options,
-          scriptsBodyAfter,
-          metaScripts,
-          scriptsbodyBefore,
-        },
-        manifest
-      );
-      if (needHtmlCache) {
-        cache.set('template', webPage);
-        debug('set template cache');
-      }
-    } else {
-      debug('reuse template cache');
-    }
-  } catch (error: any) {
-    throw new Error(`theme could not be load, stack ${error.stack}`);
-  }
-  res.setHeader('Content-Type', HEADERS.TEXT_HTML);
-  res.send(webPage);
-  debug('web rendered');
-}

package/src/template.ts

@@ -1,50 +0,0 @@
-import buildDebug from 'debug';
-
-import { TemplateUIOptions } from '@verdaccio/types';
-
-import { Manifest, getManifestValue } from './utils/manifest';
-
-const debug = buildDebug('verdaccio:web:render:template');
-
-export type Template = {
-  manifest: Manifest;
-  options: TemplateUIOptions;
-  metaScripts?: string[];
-  scriptsBodyAfter?: string[];
-  scriptsbodyBefore?: string[];
-};
-
-// the outcome of the Webpack Manifest Plugin
-export interface WebpackManifest {
-  [key: string]: string;
-}
-
-export default function renderTemplate(template: Template, manifest: WebpackManifest) {
-  debug('template %o', template);
-  debug('manifest %o', manifest);
-
-  return `
-    <!DOCTYPE html>
-      <html lang="en-us"> 
-      <head>
-        <meta charset="utf-8">
-        <base href="${template?.options.base}">
-        <title>${template?.options?.title ?? ''}</title>        
-        <link rel="icon" href="${template?.options.base}-/static/favicon.ico"/>
-        <meta name="viewport" content="width=device-width, initial-scale=1" /> 
-        <script>
-            window.__VERDACCIO_BASENAME_UI_OPTIONS=${JSON.stringify(template.options)}
-        </script>
-        ${template?.metaScripts ? template.metaScripts.join('') : ''}
-      </head>    
-      <body class="body">
-      ${template?.scriptsbodyBefore ? template.scriptsbodyBefore.join('') : ''}
-        <div id="root"></div>
-        ${getManifestValue(template.manifest.js, manifest, template?.options.base)
-          .map((item) => `<script defer="defer" src="${item}"></script>`)
-          .join('')}
-        ${template?.scriptsBodyAfter ? template.scriptsBodyAfter.join('') : ''}
-      </body>
-    </html>
-  `;
-}

package/src/utils/manifest.ts

@@ -1,23 +0,0 @@
-import buildDebug from 'debug';
-
-export type Manifest = {
-  // goes on first place at the header
-  ico: string;
-  css: string[];
-  js: string[];
-};
-
-const debug = buildDebug('verdaccio:web:render:manifest');
-
-export function getManifestValue(
-  manifestItems: string[],
-  manifest,
-  basePath: string = ''
-): string[] {
-  return manifestItems?.map((item) => {
-    debug('resolve item %o', item);
-    const resolvedItem = `${basePath}${manifest[item]}`;
-    debug('resolved item %o', resolvedItem);
-    return resolvedItem;
-  });
-}

package/src/web-middleware.ts

@@ -1,14 +0,0 @@
-import express from 'express';
-
-import { renderWebMiddleware } from './middleware/render-web';
-import { webAPI } from './middleware/web-api';
-
-export default async (config, auth, storage) => {
-  // eslint-disable-next-line new-cap
-  const app = express.Router();
-  // load application
-  app.use('/', await renderWebMiddleware(config, auth));
-  // web endpoints, search, packages, etc
-  app.use('/-/verdaccio/', webAPI(config, auth, storage));
-  return app;
-};

package/test/__snapshots__/template.test.ts.snap

@@ -1,151 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`template custom body after 1`] = `
-"
-    <!DOCTYPE html>
-      <html lang="en-us"> 
-      <head>
-        <meta charset="utf-8">
-        <base href="http://domain.com">
-        <title></title>        
-        <link rel="icon" href="http://domain.com-/static/favicon.ico"/>
-        <meta name="viewport" content="width=device-width, initial-scale=1" /> 
-        <script>
-            window.__VERDACCIO_BASENAME_UI_OPTIONS={"base":"http://domain.com"}
-        </script>
-        
-      </head>    
-      <body class="body">
-      
-        <div id="root"></div>
-        <script defer="defer" src="http://domain.com/-/static/runtime.6126058572f989c948b1.js"></script><script defer="defer" src="http://domain.com/-/static/main.6126058572f989c948b1.js"></script>
-        <script src="foo"/>
-      </body>
-    </html>
-  "
-`;
-
-exports[`template custom body before 1`] = `
-"
-    <!DOCTYPE html>
-      <html lang="en-us"> 
-      <head>
-        <meta charset="utf-8">
-        <base href="http://domain.com">
-        <title></title>        
-        <link rel="icon" href="http://domain.com-/static/favicon.ico"/>
-        <meta name="viewport" content="width=device-width, initial-scale=1" /> 
-        <script>
-            window.__VERDACCIO_BASENAME_UI_OPTIONS={"base":"http://domain.com"}
-        </script>
-        
-      </head>    
-      <body class="body">
-      <script src="fooBefore"/><script src="barBefore"/>
-        <div id="root"></div>
-        <script defer="defer" src="http://domain.com/-/static/runtime.6126058572f989c948b1.js"></script><script defer="defer" src="http://domain.com/-/static/main.6126058572f989c948b1.js"></script>
-        
-      </body>
-    </html>
-  "
-`;
-
-exports[`template custom render 1`] = `
-"
-    <!DOCTYPE html>
-      <html lang="en-us"> 
-      <head>
-        <meta charset="utf-8">
-        <base href="http://domain.com">
-        <title></title>        
-        <link rel="icon" href="http://domain.com-/static/favicon.ico"/>
-        <meta name="viewport" content="width=device-width, initial-scale=1" /> 
-        <script>
-            window.__VERDACCIO_BASENAME_UI_OPTIONS={"base":"http://domain.com"}
-        </script>
-        
-      </head>    
-      <body class="body">
-      
-        <div id="root"></div>
-        <script defer="defer" src="http://domain.com/-/static/runtime.6126058572f989c948b1.js"></script><script defer="defer" src="http://domain.com/-/static/main.6126058572f989c948b1.js"></script>
-        
-      </body>
-    </html>
-  "
-`;
-
-exports[`template custom title 1`] = `
-"
-    <!DOCTYPE html>
-      <html lang="en-us"> 
-      <head>
-        <meta charset="utf-8">
-        <base href="http://domain.com">
-        <title>foo title</title>        
-        <link rel="icon" href="http://domain.com-/static/favicon.ico"/>
-        <meta name="viewport" content="width=device-width, initial-scale=1" /> 
-        <script>
-            window.__VERDACCIO_BASENAME_UI_OPTIONS={"base":"http://domain.com","title":"foo title"}
-        </script>
-        
-      </head>    
-      <body class="body">
-      
-        <div id="root"></div>
-        <script defer="defer" src="http://domain.com/-/static/runtime.6126058572f989c948b1.js"></script><script defer="defer" src="http://domain.com/-/static/main.6126058572f989c948b1.js"></script>
-        
-      </body>
-    </html>
-  "
-`;
-
-exports[`template custom title 2`] = `
-"
-    <!DOCTYPE html>
-      <html lang="en-us"> 
-      <head>
-        <meta charset="utf-8">
-        <base href="http://domain.com">
-        <title>foo title</title>        
-        <link rel="icon" href="http://domain.com-/static/favicon.ico"/>
-        <meta name="viewport" content="width=device-width, initial-scale=1" /> 
-        <script>
-            window.__VERDACCIO_BASENAME_UI_OPTIONS={"base":"http://domain.com","title":"foo title"}
-        </script>
-        
-      </head>    
-      <body class="body">
-      
-        <div id="root"></div>
-        <script defer="defer" src="http://domain.com/-/static/runtime.6126058572f989c948b1.js"></script><script defer="defer" src="http://domain.com/-/static/main.6126058572f989c948b1.js"></script>
-        
-      </body>
-    </html>
-  "
-`;
-
-exports[`template meta scripts 1`] = `
-"
-    <!DOCTYPE html>
-      <html lang="en-us"> 
-      <head>
-        <meta charset="utf-8">
-        <base href="http://domain.com">
-        <title></title>        
-        <link rel="icon" href="http://domain.com-/static/favicon.ico"/>
-        <meta name="viewport" content="width=device-width, initial-scale=1" /> 
-        <script>
-            window.__VERDACCIO_BASENAME_UI_OPTIONS={"base":"http://domain.com"}
-        </script>
-        <style>.someclass{font-size:10px;}</style>
-      </head>    
-      <body class="body">
-      
-        <div id="root"></div>
-        <script defer="defer" src="http://domain.com/-/static/runtime.6126058572f989c948b1.js"></script><script defer="defer" src="http://domain.com/-/static/main.6126058572f989c948b1.js"></script>
-        
-      </body>
-    </html>
-  "
-`;

package/test/manifest.test.ts

@@ -1,11 +0,0 @@
-import { getManifestValue } from '../src/utils/manifest';
-
-const manifest = require('./partials/manifest/manifest.json');
-
-describe('manifest', () => {
-  test('getManifestValue', () => {
-    expect(getManifestValue(['main.js'], manifest)).toEqual([
-      '/-/static/main.6126058572f989c948b1.js',
-    ]);
-  });
-});

package/test/render.test.ts

@@ -1,108 +0,0 @@
-import { JSDOM } from 'jsdom';
-import path from 'path';
-import supertest from 'supertest';
-
-import { HEADERS, HEADER_TYPE, HTTP_STATUS } from '@verdaccio/core';
-import { setup } from '@verdaccio/logger';
-
-import { initializeServer } from './helper';
-
-setup([]);
-
-const mockManifest = jest.fn();
-jest.mock('@verdaccio/ui-theme', () => mockManifest());
-
-describe('test web server', () => {
-  beforeAll(() => {
-    mockManifest.mockReturnValue(() => ({
-      manifestFiles: {
-        js: ['runtime.js', 'vendors.js', 'main.js'],
-      },
-      staticPath: path.join(__dirname, 'static'),
-      manifest: require('./partials/manifest/manifest.json'),
-    }));
-  });
-
-  afterEach(() => {
-    jest.clearAllMocks();
-    mockManifest.mockClear();
-  });
-
-  describe('render', () => {
-    describe('output', () => {
-      const render = async (config = 'default-test.yaml') => {
-        const response = await supertest(await initializeServer(config))
-          .get('/')
-          .set('Accept', HEADERS.TEXT_HTML)
-          .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8)
-          .expect(HTTP_STATUS.OK);
-        return new JSDOM(response.text, { runScripts: 'dangerously' });
-      };
-
-      test('should match render set ui properties', async () => {
-        const {
-          window: { __VERDACCIO_BASENAME_UI_OPTIONS },
-        } = await render('web.yaml');
-        expect(__VERDACCIO_BASENAME_UI_OPTIONS).toEqual(
-          expect.objectContaining({
-            showInfo: true,
-            showSettings: true,
-            showThemeSwitch: true,
-            showFooter: true,
-            showSearch: true,
-            showDownloadTarball: true,
-            darkMode: false,
-            url_prefix: '/prefix',
-            basename: '/prefix/',
-            primaryColor: '#ffffff',
-            // FIXME: mock these values, avoid random
-            // base: 'http://127.0.0.1:60864/prefix/',
-            // version: '6.0.0-6-next.28',
-            logoURI: '',
-            flags: { searchRemote: true },
-            login: true,
-            pkgManagers: ['pnpm', 'yarn'],
-            title: 'verdaccio web',
-            scope: '@scope',
-            language: 'es-US',
-          })
-        );
-      });
-
-      test.todo('should default title');
-      test.todo('should need html cache');
-    });
-
-    describe('status', () => {
-      test('should return the http status 200 for root', async () => {
-        return supertest(await initializeServer('default-test.yaml'))
-          .get('/')
-          .set('Accept', HEADERS.TEXT_HTML)
-          .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8)
-          .expect(HTTP_STATUS.OK);
-      });
-
-      test('should return the body for a package detail page', async () => {
-        return supertest(await initializeServer('default-test.yaml'))
-          .get('/-/web/section/some-package')
-          .set('Accept', HEADERS.TEXT_HTML)
-          .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8)
-          .expect(HTTP_STATUS.OK);
-      });
-
-      test('should static file not found', async () => {
-        return supertest(await initializeServer('default-test.yaml'))
-          .get('/-/static/not-found.js')
-          .set('Accept', HEADERS.TEXT_HTML)
-          .expect(HTTP_STATUS.NOT_FOUND);
-      });
-
-      test('should static file found', async () => {
-        return supertest(await initializeServer('default-test.yaml'))
-          .get('/-/static/main.js')
-          .set('Accept', HEADERS.TEXT_HTML)
-          .expect(HTTP_STATUS.OK);
-      });
-    });
-  });
-});