@verdaccio/ui-components 4.0.0-next-8.7 → 4.0.0-next-8.8

package/src/store/models/login.ts

@@ -1,104 +0,0 @@
-import { createModel } from '@rematch/core';
-import i18next from 'i18next';
-
-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',
-};
-
-export type LoginError = {
-  type: string;
-  description: string;
-};
-
-export type LoginResponse = {
-  username: string | null;
-  token: string | null;
-};
-
-export type LoginBody = {
-  error?: LoginError;
-} & LoginResponse;
-
-export function getDefaultUserState(): LoginBody {
-  const token = storage.getItem('token');
-  const username = storage.getItem('username');
-  const defaultUserState = isTokenExpire(token)
-    ? { token: null, username: null }
-    : { token, username };
-
-  return defaultUserState;
-}
-
-const defaultUserState: LoginBody = getDefaultUserState();
-
-/**
- *
- * @category Model
- */
-export const login = createModel<RootModel>()({
-  state: {
-    username: defaultUserState.username,
-    token: defaultUserState.token,
-  },
-  reducers: {
-    logOutUser(state) {
-      storage.removeItem('username');
-      storage.removeItem('token');
-      return {
-        ...state,
-        username: null,
-        token: null,
-      };
-    },
-    addError(state, error: LoginError) {
-      return {
-        ...state,
-        error,
-      };
-    },
-    clearError(state) {
-      return {
-        ...state,
-        error: undefined,
-      };
-    },
-    logInUser(state, response: LoginResponse) {
-      // we might persist this in another way with
-      storage.setItem('username', response.username as string);
-      storage.setItem('token', response.token as string);
-      return {
-        ...state,
-        token: response.token as string,
-        username: response.username as string,
-      };
-    },
-  },
-  effects: (dispatch) => ({
-    async getUser({ username, password }, state) {
-      const basePath = stripTrailingSlash(state.configuration.config.base);
-      try {
-        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) {
-        dispatch.login.addError({
-          type: 'error',
-          description: i18next.t('form-validation.unable-to-sign-in'),
-        });
-      }
-    },
-  }),
-});

package/src/store/models/manifest.ts

@@ -1,117 +0,0 @@
-import { createModel } from '@rematch/core';
-
-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>,
-  packageVersion?: string
-): boolean {
-  if (!packageVersion || typeof packageVersion === 'undefined') {
-    // if is undefined, that means versions does not exist, we continue
-    return true;
-  }
-
-  if (packageMeta.versions) {
-    return Object.keys(packageMeta.versions).includes(packageVersion);
-  }
-
-  return false;
-}
-
-/**
- *
- * @category Model
- */
-export const manifest = createModel<RootModel>()({
-  state: {},
-  reducers: {
-    notFound(state) {
-      return {
-        ...state,
-        hasNotBeenFound: true,
-        forbidden: false,
-        manifest: undefined,
-        packageName: undefined,
-        packageVersion: undefined,
-        readme: undefined,
-      };
-    },
-    forbidden(state) {
-      return {
-        ...state,
-        forbidden: true,
-        hasNotBeenFound: false,
-        manifest: undefined,
-        packageName: undefined,
-        packageVersion: undefined,
-        readme: undefined,
-      };
-    },
-    clearError(state) {
-      return {
-        ...state,
-        isError: null,
-      };
-    },
-    isError(state) {
-      return {
-        ...state,
-        isError: true,
-        hasNotBeenFound: false,
-        forbidden: false,
-        manifest: undefined,
-        packageName: undefined,
-        packageVersion: undefined,
-        readme: undefined,
-      };
-    },
-    saveManifest(state, { packageName, packageVersion, manifest, readme }) {
-      return {
-        ...state,
-        manifest,
-        packageName,
-        packageVersion,
-        readme,
-        hasNotBeenFound: false,
-        forbidden: false,
-      };
-    },
-  },
-  effects: (dispatch) => ({
-    async getManifest({ packageName, packageVersion }, state) {
-      const basePath = stripTrailingSlash(state.configuration.config.base);
-      try {
-        const manifest: Manifest = await API.request(
-          `${basePath}${APIRoute.SIDEBAR}${packageName}${
-            packageVersion ? `?v=${packageVersion}` : ''
-          }`
-        );
-
-        // FIXME: update types accordingly
-        // @ts-ignore
-        if (!isPackageVersionValid(manifest, packageVersion)) {
-          throw new Error('not found');
-        }
-
-        const readme: string = await API.request<string>(
-          `${basePath}${APIRoute.README}${packageName}${
-            packageVersion ? `?v=${packageVersion}` : ''
-          }`
-        );
-        dispatch.manifest.saveManifest({ packageName, packageVersion, manifest, readme });
-      } catch (error: any) {
-        if (error.code === 404) {
-          dispatch.manifest.notFound();
-        } else {
-          dispatch.manifest.forbidden();
-        }
-      }
-    },
-  }),
-});

package/src/store/models/packages.ts

@@ -1,42 +0,0 @@
-import { createModel } from '@rematch/core';
-
-import { Manifest } from '@verdaccio/types';
-
-import type { RootModel } from '.';
-import API from '../api';
-import { APIRoute } from './routes';
-import { stripTrailingSlash } from './utils';
-
-/**
- *
- * @category Model
- */
-export const packages = createModel<RootModel>()({
-  state: {
-    response: [] as Manifest[],
-  },
-  reducers: {
-    savePackages(state, response: Manifest[]) {
-      return {
-        ...state,
-        response,
-      };
-    },
-  },
-  effects: (dispatch) => ({
-    async getPackages(_payload, state) {
-      const basePath = stripTrailingSlash(state.configuration.config.base);
-      try {
-        const payload: Manifest[] = await API.request(`${basePath}${APIRoute.PACKAGES}`);
-        dispatch.packages.savePackages(payload);
-      } catch (error: any) {
-        // eslint-disable-next-line no-console
-        console.error({
-          title: 'Warning',
-          message: `Unable to load package list: ${error.message}`,
-        });
-        // TODO: handle error, display something retry or something
-      }
-    },
-  }),
-});

package/src/store/models/routes.ts

@@ -1,10 +0,0 @@
-// 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

@@ -1,88 +0,0 @@
-import { createModel } from '@rematch/core';
-import orderBy from 'lodash/orderBy';
-
-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,
-  ABORT_ERROR: 'AbortError',
-};
-
-type SearchState = {
-  suggestions: SearchResultWeb[];
-  controller: AbortController[];
-};
-
-export const search = createModel<RootModel>()({
-  state: {
-    suggestions: [],
-    controller: [],
-  } as SearchState,
-  reducers: {
-    clearRequestQueue(state) {
-      const controllers = state.controller;
-      controllers.forEach((request) => {
-        request?.abort();
-      });
-      return {
-        ...state,
-        controller: [],
-      };
-    },
-    addControllerToQueue(state, { controller }: { controller: AbortController }) {
-      const currentControllers = state.controller;
-      return {
-        ...state,
-        controller: [...currentControllers, controller],
-      };
-    },
-    setError(state) {
-      return {
-        ...state,
-        isError: true,
-      };
-    },
-    saveSearch(state, { suggestions }: { suggestions: SearchResultWeb[] }) {
-      return {
-        ...state,
-        suggestions,
-        isError: null,
-      };
-    },
-  },
-  effects: (dispatch) => ({
-    async getSuggestions({ value }, state) {
-      const basePath = stripTrailingSlash(state.configuration.config.base);
-      try {
-        const controller = new window.AbortController();
-        dispatch.search.addControllerToQueue({ controller });
-        const signal = controller.signal;
-        // 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}${APIRoute.SEARCH}${encodeURIComponent(value)}`,
-          'GET',
-          {
-            signal,
-            headers: {},
-          }
-        );
-        const orderedSuggestions = orderBy(suggestions, ['verdaccioPrivate'], ['desc']);
-        dispatch.search.saveSearch({
-          suggestions: orderedSuggestions,
-        });
-      } catch (error: any) {
-        if (error.name === CONSTANTS.ABORT_ERROR) {
-          dispatch.search.saveSearch({ suggestions: [] });
-        } else {
-          dispatch.search.setError();
-        }
-      }
-    },
-  }),
-});

package/src/store/models/utils.ts

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

package/src/store/storage.ts

@@ -1,12 +0,0 @@
-import memoryStorage from 'localstorage-memory';
-
-let storage: Storage;
-try {
-  localStorage.setItem('__TEST__', '');
-  localStorage.removeItem('__TEST__');
-  storage = localStorage;
-} catch (err: any) {
-  storage = memoryStorage;
-}
-
-export default storage;

package/src/store/store.ts

@@ -1,15 +0,0 @@
-import { RematchDispatch, RematchRootState, init } from '@rematch/core';
-import loadingPlugin, { ExtraModelsFromLoading } from '@rematch/loading';
-
-import { RootModel, models } from './models';
-
-type FullModel = ExtraModelsFromLoading<RootModel>;
-
-export const store = init<RootModel, FullModel>({
-  models,
-  plugins: [loadingPlugin()],
-});
-
-export type Store = typeof store;
-export type Dispatch = RematchDispatch<RootModel>;
-export type RootState = RematchRootState<RootModel, FullModel>;

package/src/test/i18n-config.ts

@@ -1,19 +0,0 @@
-import i18n from 'i18next';
-import { initReactI18next } from 'react-i18next';
-
-i18n.use(initReactI18next).init({
-  lng: 'en-US',
-  whitelist: ['en-US'],
-  load: 'currentOnly',
-  resources: {
-    'en-US': {
-      translation: {},
-    },
-  },
-  debug: false,
-  interpolation: {
-    escapeValue: false, // react already safes from xss
-  },
-});
-
-export default i18n;

package/src/test/test-react-testing-library.tsx

@@ -1,45 +0,0 @@
-import { StyledEngineProvider } from '@mui/material/styles';
-import { render } from '@testing-library/react';
-import React from 'react';
-import { I18nextProvider } from 'react-i18next';
-import { Provider } from 'react-redux';
-
-import { ThemeProvider } from '../Theme';
-import AppConfigurationProvider from '../providers/AppConfigurationProvider';
-import PersistenceSettingProvider from '../providers/PersistenceSettingProvider';
-import { Store } from '../store/store';
-import i18nConfig from './i18n-config';
-
-const renderWithStore = (ui: React.ReactElement<any>, store: Store) =>
-  render(ui, {
-    wrapper: ({ children }) => (
-      <Provider store={store}>
-        <PersistenceSettingProvider>
-          <AppConfigurationProvider>
-            <StyledEngineProvider injectFirst={true}>
-              <ThemeProvider>
-                <I18nextProvider i18n={i18nConfig}>{children}</I18nextProvider>
-              </ThemeProvider>
-            </StyledEngineProvider>
-          </AppConfigurationProvider>
-        </PersistenceSettingProvider>
-      </Provider>
-    ),
-  });
-
-const customRender = (node: React.ReactElement, ...options: any) => {
-  return render(
-    <AppConfigurationProvider>
-      <PersistenceSettingProvider>
-        <ThemeProvider>
-          <I18nextProvider i18n={i18nConfig}>{node}</I18nextProvider>
-        </ThemeProvider>
-      </PersistenceSettingProvider>
-    </AppConfigurationProvider>,
-    ...options
-  );
-};
-
-export * from '@testing-library/react';
-export { customRender as render };
-export { customRender, renderWithStore };

package/src/types/external-modules.d.ts

@@ -1,2 +0,0 @@
-declare module 'unist';
-declare module 'hast';

package/src/types/index.ts

@@ -1,11 +0,0 @@
-import { TemplateUIOptions } from '@verdaccio/types';
-
-declare global {
-  interface Window {
-    /**
-     * __VERDACCIO_BASENAME_UI_OPTIONS is a global object available in the
-     * browser.
-     */
-    __VERDACCIO_BASENAME_UI_OPTIONS: TemplateUIOptions;
-  }
-}

package/src/types/packageMeta.ts

@@ -1,95 +0,0 @@
-export type ModuleType = 'commonjs' | 'module';
-
-export type Latest = {
-  author?: string | Author;
-  deprecated?: string;
-  name: string;
-  dist?: {
-    fileCount: number;
-    unpackedSize: number;
-    tarball?: string;
-  };
-  engines?: {
-    node?: string;
-    npm?: string;
-    pnpm?: string;
-    yarn?: string;
-  };
-  license?: string | LicenseInterface;
-  version: string;
-  homepage?: string;
-  bugs?: {
-    url: string;
-  };
-  repository?: {
-    type?: string;
-    url?: string;
-  };
-  main?: string;
-  type?: ModuleType;
-  types?: string;
-  description?: string;
-  funding?: Funding;
-  maintainers?: Developer[];
-  contributors?: Developer[];
-  keywords?: string | string[];
-};
-
-export interface PackageMetaInterface {
-  versions?: Versions;
-  'dist-tags'?: DistTags;
-  time?: Time;
-  latest: Latest;
-  _uplinks?: Record<string, { fetched: number }>;
-}
-
-export interface Developer {
-  name: string;
-  email?: string;
-  url?: string;
-  avatar?: string;
-}
-
-interface Funding {
-  type?: string;
-  url?: string;
-}
-
-export interface LicenseInterface {
-  type?: string;
-  url?: string;
-}
-
-export interface DistTags {
-  [key: string]: string;
-}
-
-export interface Time {
-  [key: string]: string;
-}
-
-export interface Versions {
-  [key: string]: Version;
-}
-
-export interface Version {
-  name: string;
-  version: string;
-  author?: string | Author;
-  description?: string;
-  license?: string | LicenseInterface;
-  main?: string;
-  keywords?: string[];
-  deprecated?: string;
-}
-
-export interface Author {
-  name?: string;
-  email?: string;
-  url?: string;
-  avatar?: string;
-}
-
-export interface PackageDependencies {
-  [key: string]: string;
-}

package/src/utils/.eslintrc

@@ -1,5 +0,0 @@
-{
-    "rules": {
-        "no-invalid-this": 0
-    }
-}

package/src/utils/cli-utils.test.ts

@@ -1,67 +0,0 @@
-import { SyntheticEvent } from 'react';
-import { vi } from 'vitest';
-
-import { copyToClipBoardUtility, getCLISetConfigRegistry } from './cli-utils';
-
-describe('copyToClipBoardUtility', () => {
-  let originalGetSelection: typeof window.getSelection;
-
-  const mockGetSelectionResult = {
-    removeAllRanges: vi.fn(),
-    addRange: vi.fn(),
-  };
-  beforeEach(() => {
-    originalGetSelection = window.getSelection;
-
-    window.getSelection = vi.fn().mockReturnValue(mockGetSelectionResult);
-  });
-  afterEach(() => {
-    window.getSelection = originalGetSelection;
-    vi.restoreAllMocks();
-  });
-
-  test('should call the DOM APIs', () => {
-    // Given
-    const testEvent: { preventDefault: Function } = {
-      preventDefault: vi.fn(),
-    };
-    const testCopy = 'copy text';
-    const spys = {
-      createElement: vi.spyOn(document, 'createElement'),
-      execCommand: vi.spyOn(document, 'execCommand'),
-      appendChild: vi.spyOn(document.body, 'appendChild'),
-      removeChild: vi.spyOn(document.body, 'removeChild'),
-    };
-    const expectedDiv = document.createElement('div');
-    expectedDiv.innerText = testCopy;
-
-    // When
-    const copyFunc = copyToClipBoardUtility(testCopy);
-    copyFunc(testEvent as SyntheticEvent<HTMLElement>);
-
-    // Then
-    expect(mockGetSelectionResult.removeAllRanges).toHaveBeenCalledWith();
-    expect(mockGetSelectionResult.addRange).toHaveBeenCalled();
-    expect(spys.createElement).toHaveBeenCalledWith('div');
-    expect(spys.appendChild).toHaveBeenCalledWith(expectedDiv);
-    expect(spys.execCommand).toHaveBeenCalledWith('copy');
-    expect(spys.removeChild).toHaveBeenCalledWith(expectedDiv);
-  });
-});
-
-describe('getCLISetRegistry', () => {
-  const command = 'npm set';
-  const scope = '@testscope';
-  const blankScope = '';
-  const url = 'https://test.local';
-
-  test('should return ":" separated string when scope is set', () => {
-    expect(getCLISetConfigRegistry(command, scope, url)).toEqual(
-      `${command} ${scope}:registry ${url}`
-    );
-  });
-
-  test('should not output scope when scope is not set', () => {
-    expect(getCLISetConfigRegistry(command, blankScope, url)).toEqual(`${command} registry ${url}`);
-  });
-});