@verdaccio/ui-components 3.0.0-next-7.6 → 3.0.0-next-7.8

package/src/sections/Header/HeaderRight.tsx

@@ -1,11 +1,11 @@
 import Button from '@mui/material/Button';
+import Toolbar from '@mui/material/Toolbar';
 import React, { MouseEvent, useEffect, useState } from 'react';
 import { useTranslation } from 'react-i18next';
 
 import { useCustomTheme } from '../../';
 import HeaderMenu from './HeaderMenu';
 import HeaderToolTip from './HeaderToolTip';
-import { RightSide } from './styles';
 
 interface Props {
   showSearch?: boolean;
@@ -75,7 +75,18 @@ const HeaderRight: React.FC<Props> = ({
   };
 
   return (
-    <RightSide data-testid="header-right">
+    <Toolbar
+      data-testid="header-right"
+      sx={{
+        display: 'flex',
+        padding: 0,
+        marginRight: 0,
+        '@media (min-width: 600px)': {
+          padding: 0,
+          marginRight: 0,
+        },
+      }}
+    >
       {showSearch === true && (
         <HeaderToolTip
           onClick={onToggleMobileNav}
@@ -124,7 +135,7 @@ const HeaderRight: React.FC<Props> = ({
           )}
         </>
       )}
-    </RightSide>
+    </Toolbar>
   );
 };
 

package/src/sections/Header/HeaderSettingsDialog.tsx

@@ -9,9 +9,9 @@ import ReactMarkdown from 'react-markdown';
 import { useSelector } from 'react-redux';
 
 import { RootState, Theme } from '../../';
+import RegistryInfoDialog from '../../components/RegistryInfoDialog';
 import LanguageSwitch from './LanguageSwitch';
 import RegistryInfoContent from './RegistryInfoContent';
-import RegistryInfoDialog from './RegistryInfoDialog';
 
 interface Props {
   isOpen: boolean;

package/src/sections/Header/RegistryInfoContent/RegistryInfoContent.test.tsx

@@ -13,7 +13,7 @@ describe('<RegistryInfoContent /> component', () => {
     expect(screen.getByText('packageManagers.description')).toBeInTheDocument();
   });
 
-  test('should load the appropiate tab content when the tab is clicked', () => {
+  test('should load the appropiate tab content when the tab is clicked', () => {
     const props = { registryUrl: 'http://localhost:4872', scope: '@' };
     render(<RegistryInfoContent registryUrl={props.registryUrl} scope={props.scope} />);
 

package/src/sections/Header/styles.ts

@@ -4,27 +4,18 @@ import AppBar from '@mui/material/AppBar';
 import IconButton from '@mui/material/IconButton';
 import Toolbar from '@mui/material/Toolbar';
 
-import { Link, Theme } from '../../';
+import { Theme } from '../../Theme';
 
 export const InnerNavBar = styled(Toolbar)({
   justifyContent: 'space-between',
   alignItems: 'center',
-  padding: '0 15px',
+  padding: 0,
 });
 
 export const Greetings = styled('span')({
   margin: '0 5px 0 0',
 });
 
-export const RightSide = styled(Toolbar)({
-  display: 'flex',
-  padding: 0,
-});
-
-export const LeftSide = styled(RightSide)({
-  flex: 1,
-});
-
 export const MobileNavBar = styled('div')<{ theme?: Theme }>((props) => ({
   alignItems: 'center',
   display: 'flex',
@@ -50,6 +41,7 @@ export const SettingsButtom = styled(IconButton)({});
 export const SearchWrapper = styled('div')({
   display: 'none',
   width: '100%',
+  marginLeft: 20,
 });
 
 export const NavBar = styled(AppBar)<{ theme?: Theme }>(({ theme }) => ({
@@ -83,7 +75,7 @@ export const NavBar = styled(AppBar)<{ theme?: Theme }>(({ theme }) => ({
   `,
   [`@media (min-width: ${theme?.breakPoints.large}px)`]: css`
     ${InnerNavBar} {
-      padding: 0 20px;
+      padding: 0 16px;
     }
   `,
   [`@media (min-width: ${theme?.breakPoints.xlarge}px)`]: css`
@@ -94,7 +86,3 @@ export const NavBar = styled(AppBar)<{ theme?: Theme }>(({ theme }) => ({
     }
   `,
 }));
-
-export const StyledLink = styled(Link)<{ theme?: Theme }>(({ theme }) => ({
-  color: theme?.palette.white,
-}));

package/src/sections/Home/Home.test.tsx

@@ -2,7 +2,7 @@ import React from 'react';
 import { MemoryRouter } from 'react-router';
 
 import { store } from '../../store';
-import { renderWithStore, screen, waitFor } from '../../test/test-react-testing-library';
+import { act, renderWithStore, screen, waitFor } from '../../test/test-react-testing-library';
 import Home from './Home';
 
 // force the windows to expand to display items
@@ -10,20 +10,28 @@ import Home from './Home';
 jest.spyOn(HTMLElement.prototype, 'offsetHeight', 'get').mockReturnValue(600);
 jest.spyOn(HTMLElement.prototype, 'offsetWidth', 'get').mockReturnValue(600);
 
-const ComponentSideBar: React.FC = () => (
+const ComponentHome: React.FC = () => (
   <MemoryRouter>
     <Home />
   </MemoryRouter>
 );
 
 describe('Home', () => {
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
   test('should render titles', async () => {
-    renderWithStore(<ComponentSideBar />, store);
+    act(() => {
+      renderWithStore(<ComponentHome />, store);
+    });
     await waitFor(() => expect(screen.getAllByTestId('package-item-list')).toHaveLength(5));
   });
 
   test('should render loading', async () => {
-    renderWithStore(<ComponentSideBar />, store);
+    act(() => {
+      renderWithStore(<ComponentHome />, store);
+    });
     await waitFor(() => expect(screen.getByTestId('loading')).toBeInTheDocument());
   });
 });

package/src/sections/SideBar/Sidebar.test.tsx

@@ -3,7 +3,7 @@ import { MemoryRouter } from 'react-router';
 
 import { VersionProvider } from '../../providers';
 import { store } from '../../store';
-import { renderWithStore, screen, waitFor } from '../../test/test-react-testing-library';
+import { act, renderWithStore, screen, waitFor } from '../../test/test-react-testing-library';
 import Sidebar from './Sidebar';
 
 jest.mock('marked');
@@ -31,37 +31,44 @@ describe('Sidebar', () => {
     jest.clearAllMocks();
   });
   test('should render titles', async () => {
-    renderWithStore(<ComponentSideBar />, store);
-    await waitFor(() => expect(screen.getByText('jquery')).toBeInTheDocument());
+    act(() => {
+      renderWithStore(<ComponentSideBar />, store);
+    });
+    await waitFor(() => expect(screen.getAllByText('jquery')).toHaveLength(2));
 
-    expect(screen.getByText(`jquery`)).toBeInTheDocument();
     expect(screen.getByText(`sidebar.detail.latest-version`, { exact: false })).toBeInTheDocument();
     expect(
-      screen.getByText(`sidebar.detail.published a year ago`, { exact: false })
+      screen.getByText(/sidebar.detail.published .*years? ago/i, { exact: false })
     ).toBeInTheDocument();
     expect(screen.getByText(`sidebar.installation.title`, { exact: false })).toBeInTheDocument();
   });
 
   test('should render commonJS', async () => {
-    renderWithStore(<ComponentSideBar />, store);
-
-    await waitFor(() => expect(screen.getByText('jquery')).toBeInTheDocument());
+    act(() => {
+      renderWithStore(<ComponentSideBar />, store);
+    });
+    // package name + keyword
+    await waitFor(() => expect(screen.getAllByText('jquery')).toHaveLength(2));
     expect(screen.getByAltText('commonjs')).toBeInTheDocument();
   });
 
   test('should render typescript', async () => {
     mockPkgName.mockReturnValue('glob');
-    renderWithStore(<ComponentSideBar />, store);
-
+    act(() => {
+      renderWithStore(<ComponentSideBar />, store);
+    });
+    // just package name
     await waitFor(() => expect(screen.getByText('glob')).toBeInTheDocument());
     expect(screen.getByAltText('typescript')).toBeInTheDocument();
   });
 
   test('should render es modules', async () => {
     mockPkgName.mockReturnValue('got');
-    renderWithStore(<ComponentSideBar />, store);
-
-    await waitFor(() => expect(screen.getByText('got')).toBeInTheDocument());
+    act(() => {
+      renderWithStore(<ComponentSideBar />, store);
+    });
+    // package name + keyword
+    await waitFor(() => expect(screen.getAllByText('got')).toHaveLength(2));
     expect(screen.getByAltText('es6 modules')).toBeInTheDocument();
   });
 });

package/src/sections/SideBar/Sidebar.tsx

@@ -1,8 +1,6 @@
-import styled from '@emotion/styled';
 import Paper from '@mui/material/Paper';
 import React from 'react';
 
-import { Theme } from '../../Theme';
 import ActionBar from '../../components/ActionBar';
 import Author from '../../components/Author';
 import Developers, { DeveloperType } from '../../components/Developers';
@@ -10,6 +8,7 @@ import Dist from '../../components/Distribution';
 import Engines from '../../components/Engines';
 import FundButton from '../../components/FundButton';
 import Install from '../../components/Install';
+import Keywords from '../../components/Keywords';
 import Repository from '../../components/Repository';
 import SideBarTitle from '../../components/SideBarTitle';
 import { useConfig } from '../../providers';
@@ -35,7 +34,7 @@ const DetailSidebar: React.FC = () => {
   }
 
   return (
-    <StyledPaper sx={{ position: 'sticky', top: 0 }}>
+    <Paper data-testid="sidebar" sx={{ position: 'sticky', top: 0, p: 2, ml: 2 }}>
       <SideBarTitle
         description={packageMeta.latest?.description}
         hasTypes={typeof packageMeta.latest?.types === 'string'}
@@ -50,20 +49,17 @@ const DetailSidebar: React.FC = () => {
         showDownloadTarball={configOptions.showDownloadTarball}
         showRaw={configOptions.showRaw}
       />
-      <Install configOptions={configOptions} packageMeta={packageMeta} packageName={packageName} />
       <FundButton packageMeta={packageMeta} />
+      <Install configOptions={configOptions} packageMeta={packageMeta} packageName={packageName} />
       <Repository packageMeta={packageMeta} />
       <Engines packageMeta={packageMeta} />
       <Dist packageMeta={packageMeta} />
+      <Keywords packageMeta={packageMeta} />
       <Author packageMeta={packageMeta} />
       <Developers packageMeta={packageMeta} type={DeveloperType.MAINTAINERS} />
       <Developers packageMeta={packageMeta} type={DeveloperType.CONTRIBUTORS} />
-    </StyledPaper>
+    </Paper>
   );
 };
 
 export default DetailSidebar;
-
-const StyledPaper = styled(Paper)<{ theme?: Theme }>(({ theme }) => ({
-  padding: theme?.spacing(3, 2),
-}));

package/src/store/api.test.ts

@@ -31,6 +31,22 @@ describe('api', () => {
 
       expect(handled).toEqual([true, blob]);
     });
+
+    test('should test pdf scenario', async () => {
+      const blob = new Blob(['foo']);
+      const blobPromise = Promise.resolve<Blob>(blob);
+      const response: Response = {
+        url: 'http://localhost:8080/test.pdf',
+        blob: () => blobPromise,
+        ok: true,
+        headers: new Headers({
+          'Content-Type': 'application/pdf',
+        }),
+      } as Response;
+      const handled = await handleResponseType(response);
+
+      expect(handled).toEqual([true, blob]);
+    });
   });
 
   describe('api client', () => {

package/src/store/models/configuration.ts

@@ -7,6 +7,7 @@ import { Manifest, TemplateUIOptions } from '@verdaccio/types';
 import type { RootModel } from '.';
 import { colors } from '../../Theme';
 import API from '../api';
+import { APIRoute } from './routes';
 
 const defaultValues: TemplateUIOptions = {
   primaryColor: colors.PRIMARY_COLOR,
@@ -39,7 +40,7 @@ export const configuration = createModel<RootModel>()({
   },
   effects: (dispatch) => ({
     async getPackages() {
-      const payload: Manifest[] = await API.request(`/-/verdaccio/packages`, 'GET');
+      const payload: Manifest[] = await API.request(APIRoute.CONFIG, 'GET');
       dispatch.packages.savePackages(payload);
     },
   }),

package/src/store/models/login.ts

@@ -5,6 +5,8 @@ import type { RootModel } from '.';
 import { isTokenExpire } from '../../utils';
 import API from '../api';
 import storage from '../storage';
+import { APIRoute } from './routes';
+import { stripTrailingSlash } from './utils';
 
 export const HEADERS = {
   JSON: 'application/json',
@@ -80,19 +82,15 @@ export const login = createModel<RootModel>()({
   },
   effects: (dispatch) => ({
     async getUser({ username, password }, state) {
-      const basePath = state.configuration.config.base;
+      const basePath = stripTrailingSlash(state.configuration.config.base);
       try {
-        const payload: LoginResponse = await API.request(
-          `${basePath}-/verdaccio/sec/login`,
-          'POST',
-          {
-            body: JSON.stringify({ username, password }),
-            headers: {
-              Accept: HEADERS.JSON,
-              'Content-Type': HEADERS.JSON,
-            },
-          }
-        );
+        const payload: LoginResponse = await API.request(`${basePath}${APIRoute.LOGIN}`, 'POST', {
+          body: JSON.stringify({ username, password }),
+          headers: {
+            Accept: HEADERS.JSON,
+            'Content-Type': HEADERS.JSON,
+          },
+        });
         dispatch.login.logInUser(payload);
         dispatch.packages.getPackages(undefined);
       } catch (error: any) {

package/src/store/models/manifest.ts

@@ -5,6 +5,8 @@ import { Manifest } from '@verdaccio/types';
 import type { RootModel } from '.';
 import { PackageMetaInterface } from '../../types/packageMeta';
 import API from '../api';
+import { APIRoute } from './routes';
+import { stripTrailingSlash } from './utils';
 
 function isPackageVersionValid(
   packageMeta: Partial<PackageMetaInterface>,
@@ -83,10 +85,10 @@ export const manifest = createModel<RootModel>()({
   },
   effects: (dispatch) => ({
     async getManifest({ packageName, packageVersion }, state) {
-      const basePath = state.configuration.config.base;
+      const basePath = stripTrailingSlash(state.configuration.config.base);
       try {
         const manifest: Manifest = await API.request(
-          `${basePath}-/verdaccio/data/sidebar/${packageName}${
+          `${basePath}${APIRoute.SIDEBAR}${packageName}${
             packageVersion ? `?v=${packageVersion}` : ''
           }`
         );
@@ -98,10 +100,9 @@ export const manifest = createModel<RootModel>()({
         }
 
         const readme: string = await API.request<string>(
-          `${basePath}-/verdaccio/data/package/readme/${packageName}${
+          `${basePath}${APIRoute.README}${packageName}${
             packageVersion ? `?v=${packageVersion}` : ''
-          }`,
-          'GET'
+          }`
         );
         dispatch.manifest.saveManifest({ packageName, packageVersion, manifest, readme });
       } catch (error: any) {

package/src/store/models/packages.ts

@@ -4,6 +4,8 @@ import { Manifest } from '@verdaccio/types';
 
 import type { RootModel } from '.';
 import API from '../api';
+import { APIRoute } from './routes';
+import { stripTrailingSlash } from './utils';
 
 /**
  *
@@ -23,12 +25,9 @@ export const packages = createModel<RootModel>()({
   },
   effects: (dispatch) => ({
     async getPackages(_payload, state) {
-      const basePath = state.configuration.config.base;
+      const basePath = stripTrailingSlash(state.configuration.config.base);
       try {
-        const payload: Manifest[] = await API.request(
-          `${basePath}-/verdaccio/data/packages`,
-          'GET'
-        );
+        const payload: Manifest[] = await API.request(`${basePath}${APIRoute.PACKAGES}`);
         dispatch.packages.savePackages(payload);
       } catch (error: any) {
         // eslint-disable-next-line no-console

package/src/store/models/routes.ts

@@ -0,0 +1,10 @@
+// Example API request:
+// http://localhost:8000/-/verdaccio/data/package/readme/jquery
+export enum APIRoute {
+  LOGIN = '/-/verdaccio/sec/login',
+  CONFIG = '/-/verdaccio/packages',
+  PACKAGES = '/-/verdaccio/data/packages',
+  SEARCH = '/-/verdaccio/data/search/', // :value
+  SIDEBAR = '/-/verdaccio/data/sidebar/', // :packageName?v=version
+  README = '/-/verdaccio/data/package/readme/', // :packageName?v=version
+}

package/src/store/models/search.ts

@@ -5,6 +5,8 @@ import { SearchResultWeb } from '@verdaccio/types';
 
 import type { RootModel } from '.';
 import API from '../api';
+import { APIRoute } from './routes';
+import { stripTrailingSlash } from './utils';
 
 const CONSTANTS = {
   API_DELAY: 300,
@@ -55,7 +57,7 @@ export const search = createModel<RootModel>()({
   },
   effects: (dispatch) => ({
     async getSuggestions({ value }, state) {
-      const basePath = state.configuration.config.base;
+      const basePath = stripTrailingSlash(state.configuration.config.base);
       try {
         const controller = new window.AbortController();
         dispatch.search.addControllerToQueue({ controller });
@@ -63,7 +65,7 @@ export const search = createModel<RootModel>()({
         // https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API#Browser_compatibility
         // FUTURE: signal is not well supported for IE and Samsung Browser
         const suggestions: SearchResultWeb[] = await API.request(
-          `${basePath}-/verdaccio/data/search/${encodeURIComponent(value)}`,
+          `${basePath}${APIRoute.SEARCH}${encodeURIComponent(value)}`,
           'GET',
           {
             signal,

package/src/store/models/utils.ts

@@ -0,0 +1,3 @@
+export function stripTrailingSlash(url: string): string {
+  return url.replace(/\/$/, '');
+}

package/src/types/packageMeta.ts

@@ -1,7 +1,7 @@
 export type ModuleType = 'commonjs' | 'module';
 
 export type Latest = {
-  author?: Author;
+  author?: string | Author;
   deprecated?: string;
   name: string;
   dist?: {
@@ -15,7 +15,7 @@ export type Latest = {
     pnpm?: string;
     yarn?: string;
   };
-  license?: undefined | LicenseInterface | string;
+  license?: string | LicenseInterface;
   version: string;
   homepage?: string;
   bugs?: {
@@ -32,6 +32,7 @@ export type Latest = {
   funding?: Funding;
   maintainers?: Developer[];
   contributors?: Developer[];
+  keywords?: string | string[];
 };
 
 export interface PackageMetaInterface {
@@ -44,8 +45,9 @@ export interface PackageMetaInterface {
 
 export interface Developer {
   name: string;
-  email: string;
-  avatar: string;
+  email?: string;
+  url?: string;
+  avatar?: string;
 }
 
 interface Funding {
@@ -75,7 +77,7 @@ export interface Version {
   version: string;
   author?: string | Author;
   description?: string;
-  license?: string;
+  license?: string | LicenseInterface;
   main?: string;
   keywords?: string[];
   deprecated?: string;

package/src/utils/routes.ts

@@ -1,5 +1,6 @@
 export enum Route {
   ROOT = '/',
+  DETAIL = '/-/web/detail/',
   SCOPE_PACKAGE = '/-/web/detail/@:scope/:package',
   SCOPE_PACKAGE_VERSION = '/-/web/detail/@:scope/:package/v/:version',
   PACKAGE = '/-/web/detail/:package',

package/src/utils/utils.test.ts

@@ -2,12 +2,14 @@ import MockDate from 'mockdate';
 
 import { packageMeta } from './__partials__/packageMeta';
 import {
+  fileSizeSI,
   formatDate,
   formatDateDistance,
   formatLicense,
   formatRepository,
   getLastUpdatedPackageTime,
   getRecentReleases,
+  getUplink,
 } from './utils';
 
 // jest.useFakeTimers().setSystemTime(new Date('2020-01-01'));
@@ -111,3 +113,35 @@ describe('getRecentReleases', (): void => {
     expect(getRecentReleases()).toEqual([]);
   });
 });
+
+describe('getUplink', (): void => {
+  test('getUplink for npmjs', () => {
+    expect(getUplink('npmjs', 'semver')).toEqual('https://www.npmjs.com/package/semver');
+  });
+
+  test('getUplink for server1', () => {
+    expect(getUplink('server1', 'semver')).toEqual(null);
+  });
+});
+
+describe('fileSizeSI', (): void => {
+  test('fileSizeSI as number 1234567', () => {
+    expect(fileSizeSI(1234567)).toEqual('1.2 MB');
+  });
+
+  test('fileSizeSI as number 9876', () => {
+    expect(fileSizeSI(9876)).toEqual('9.9 kB');
+  });
+
+  test('fileSizeSI as number 1000', () => {
+    expect(fileSizeSI(1000)).toEqual('1.0 kB');
+  });
+
+  test('fileSizeSI as number 123', () => {
+    expect(fileSizeSI(123)).toEqual('123 Bytes');
+  });
+
+  test('fileSizeSI as number 0', () => {
+    expect(fileSizeSI(0)).toEqual('0 Bytes');
+  });
+});

package/src/utils/utils.ts

@@ -105,6 +105,15 @@ export function getAuthorName(authorName?: string): string {
   return authorName;
 }
 
+export function getUplink(upLinkName: string, packageName: string): string | null {
+  // TODO: make this a config like "uplinks: npmjs: web: https://www.npmjs.com/package/"
+  switch (upLinkName) {
+    case 'npmjs':
+      return `https://www.npmjs.com/package/${packageName}`;
+  }
+  return null;
+}
+
 export function fileSizeSI(
   a: number,
   b?: typeof Math,
@@ -112,9 +121,15 @@ export function fileSizeSI(
   d?: number,
   e?: number
 ): string {
-  return (
-    ((b = Math), (c = b.log), (d = 1e3), (e = (c(a) / c(d)) | 0), a / b.pow(d, e)).toFixed(2) +
-    ' ' +
-    (e ? 'kMGTPEZY'[--e] + 'B' : 'Bytes')
-  );
+  b = Math;
+  c = b.log;
+  d = 1e3;
+  e = (c(a) / c(d)) | 0;
+  let size = a / b.pow(d, e);
+  // no decimals for Bytes
+  if (e === 0) {
+    return Math.floor(size) + ' Bytes';
+  } else {
+    return size.toFixed(1) + ' ' + 'kMGTPEZY'[--e] + 'B';
+  }
 }

package/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../../tsconfig.reference.json",
+  "extends": "../../tsconfig.reference.json",
   "compilerOptions": {
     "module": "esnext",
     "moduleResolution": "node",