@verdaccio/types 10.1.0 → 11.0.0-6-next.10

package/.eslintrc.json

@@ -0,0 +1,10 @@
+{
+  "rules": {
+    "spaced-comment": 0,
+    "@typescript-eslint/adjacent-overload-signatures": "off",
+    "@typescript-eslint/explicit-member-accessibility": "off",
+    "@typescript-eslint/interface-name-prefix": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-unused-vars": "off"
+  }
+}

package/CHANGELOG.md

@@ -1,27 +1,231 @@
 # Change Log
 
-## 10.1.0
+## 11.0.0-6-next.10
+
+### Major Changes
+
+- 000d4374: feat: upgrade to material ui 5
+
+## 11.0.0-6-next.9
+
+### Major Changes
+
+- 794af76c: Remove Node 12 support
+
+  - We need move to the new `undici` and does not support Node.js 12
+
+### Minor Changes
+
+- 154b2ecd: refactor: remove @verdaccio/commons-api in favor @verdaccio/core and remove duplications
+
+## 11.0.0-6-next.8
+
+### Major Changes
+
+- 459b6fa7: refactor: search v1 endpoint and local-database
+
+  - refactor search `api v1` endpoint, improve performance
+  - remove usage of `async` dependency https://github.com/verdaccio/verdaccio/issues/1225
+  - refactor method storage class
+  - create new module `core` to reduce the ammount of modules with utilities
+  - use `undici` instead `node-fetch`
+  - use `fastify` instead `express` for functional test
+
+  ### Breaking changes
+
+  - plugin storage API changes
+  - remove old search endpoint (return 404)
+  - filter local private packages at plugin level
+
+  The storage api changes for methods `get`, `add`, `remove` as promise base. The `search` methods also changes and recieves a `query` object that contains all query params from the client.
+
+  ```ts
+  export interface IPluginStorage<T> extends IPlugin {
+    add(name: string): Promise<void>;
+    remove(name: string): Promise<void>;
+    get(): Promise<any>;
+    init(): Promise<void>;
+    getSecret(): Promise<string>;
+    setSecret(secret: string): Promise<any>;
+    getPackageStorage(packageInfo: string): IPackageStorage;
+    search(query: searchUtils.SearchQuery): Promise<searchUtils.SearchItem[]>;
+    saveToken(token: Token): Promise<any>;
+    deleteToken(user: string, tokenKey: string): Promise<any>;
+    readTokens(filter: TokenFilter): Promise<Token[]>;
+  }
+  ```
+
+## 11.0.0-6-next.7
 
 ### Minor Changes
 
-- 4e9a3d0: feat: remove core-js from bundle
+- 0da7031e: allow disable login on ui and endpoints
 
-  By using babel.js core-js injects some requires that are not necessarily dependencies and fails on pnpm and yarn 2 due are strict. No need to add this feature so is removed.
+  To be able disable the login, set `login: false`, anything else would enable login. This flag will disable access via UI and web endpoints.
 
-  - https://babeljs.io/docs/en/babel-preset-env#usebuiltins
+  ```yml
+  web:
+    title: verdaccio
+    login: false
+  ```
 
-## 10.0.1
+## 11.0.0-6-next.6
+
+### Minor Changes
+
+- aecbd226: web: allow ui hide package managers on sidebar
+
+  If there is a package manager of preference over others, you can define the package managers to be displayed on the detail page and sidebar, just define in the `config.yaml` and web section the list of package managers to be displayed.
+
+  ```
+  web:
+    title: Verdaccio
+    sort_packages: asc
+    primary_color: #cccccc
+    pkgManagers:
+      - pnpm
+      - yarn
+      # - npm
+  ```
+
+  To disable all package managers, just define empty:
+
+  ```
+  web:
+    title: Verdaccio
+    sort_packages: asc
+    primary_color: #cccccc
+    pkgManagers:
+  ```
+
+  and the section would be hidden.
+
+## 11.0.0-6-next.5
 
 ### Patch Changes
 
-- 6134415: fix: update dependencies
+- 19d272d1: fix: restore logger on init
 
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+  Enable logger after parse configuration and log the very first step on startup phase.
 
-# [10.0.0](https://github.com/verdaccio/monorepo/compare/v9.7.5...v10.0.0) (2021-03-29)
+  ```bash
+   warn --- experiments are enabled, it is recommended do not use experiments in production comment out this section to disable it
+   info --- support for experiment [token]  is disabled
+   info --- support for experiment [search]  is disabled
+  (node:50831) Warning: config.logs is deprecated, rename configuration to "config.log"
+  (Use `node --trace-warnings ...` to show where the warning was created)
+   info --- http address http://localhost:4873/
+   info --- version: 6.0.0-6-next.11
+   info --- server started
+  ```
 
-**Note:** Version bump only for package @verdaccio/types
+## 11.0.0-6-next.4
+
+### Major Changes
+
+- 5c5057fc: feat: node api new structure based on promise
+
+  ```js
+  import { runServer } from '@verdaccio/node-api';
+  // or
+  import { runServer } from 'verdaccio';
+
+  const app = await runServer(); // default configuration
+  const app = await runServer('./config/config.yaml');
+  const app = await runServer({ configuration });
+  app.listen(4000, event => {
+    // do something
+  });
+  ```
+
+  ### Breaking Change
+
+  If you are using the node-api, the new structure is Promise based and less arguments.
+
+## 10.0.0-alpha.3
+
+### Patch Changes
+
+- fecbb9be: chore: add release step to private regisry on merge changeset pr
+
+## 10.0.0-alpha.2
+
+### Minor Changes
+
+- 54c58d1e: feat: add server rate limit protection to all request
+
+  To modify custom values, use the server settings property.
+
+  ```markdown
+  server:
+
+  ## https://www.npmjs.com/package/express-rate-limit#configuration-options
+
+  rateLimit:
+  windowMs: 1000
+  max: 10000
+  ```
+
+  The values are intended to be high, if you want to improve security of your server consider
+  using different values.
+
+## 10.0.0-alpha.1
+
+### Major Changes
+
+- d87fa026: feat!: experiments config renamed to flags
+
+  - The `experiments` configuration is renamed to `flags`. The functionality is exactly the same.
+
+  ```js
+  flags: token: false;
+  search: false;
+  ```
+
+  - The `self_path` property from the config file is being removed in favor of `config_file` full path.
+  - Refactor `config` module, better types and utilities
+
+- da1ee9c8: - Replace signature handler for legacy tokens by removing deprecated crypto.createDecipher by createCipheriv
+
+  - Introduce environment variables for legacy tokens
+
+  ### Code Improvements
+
+  - Add debug library for improve developer experience
+
+  ### Breaking change
+
+  - The new signature invalidates all previous tokens generated by Verdaccio 4 or previous versions.
+  - The secret key must have 32 characters long.
+
+  ### New environment variables
+
+  - `VERDACCIO_LEGACY_ALGORITHM`: Allows to define the specific algorithm for the token signature which by default is `aes-256-ctr`
+  - `VERDACCIO_LEGACY_ENCRYPTION_KEY`: By default, the token stores in the database, but using this variable allows to get it from memory
+
+### Minor Changes
+
+- 26b494cb: feat: add typescript project references settings
+
+  Reading https://ebaytech.berlin/optimizing-multi-package-apps-with-typescript-project-references-d5c57a3b4440 I realized I can use project references to solve the issue to pre-compile modules on develop mode.
+
+  It allows to navigate (IDE) trough the packages without need compile the packages.
+
+  Add two `tsconfig`, one using the previous existing configuration that is able to produce declaration files (`tsconfig.build`) and a new one `tsconfig` which is enables [_projects references_](https://www.typescriptlang.org/docs/handbook/project-references.html).
+
+### Patch Changes
+
+- b57b4338: Enable prerelease mode with **changesets**
+- 31af0164: ESLint Warnings Fixed
+
+  Related to issue #1461
+
+  - max-len: most of the sensible max-len errors are fixed
+  - no-unused-vars: most of these types of errors are fixed by deleting not needed declarations
+  - @typescript-eslint/no-unused-vars: same as above
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
 ## [9.7.2](https://github.com/verdaccio/monorepo/compare/v9.7.1...v9.7.2) (2020-07-20)
 

package/README.md

@@ -3,6 +3,7 @@
 Typescript definitions for verdaccio plugins and internal code
 
 # Typescript
+
 For usage with the library, the `tsconfig.json` should looks like this.
 
 ```
@@ -44,5 +45,3 @@ import type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types';
   ...
 }
 ```
-
-

package/index.d.ts

@@ -1,5 +1,4 @@
-// <reference types="node" />
-
+/// <reference types="node" />
 import { PassThrough } from 'stream';
 
 declare module '@verdaccio/types' {
@@ -9,13 +8,59 @@ declare module '@verdaccio/types' {
   type Callback = Function;
   // FIXME: err should be something flexible enough for any implementation
   type CallbackAction = (err: any | null) => void;
-  type CallbackError = (err: NodeJS.ErrnoException) => void;
   interface Author {
+    username?: string;
     name: string;
     email?: string;
     url?: string;
   }
 
+  type PackageManagers = 'pnpm' | 'yarn' | 'npm';
+
+  // FUTURE: WebConf and TemplateUIOptions should be merged .
+  type CommonWebConf = {
+    title?: string;
+    logo?: string;
+    favicon?: string;
+    gravatar?: boolean;
+    sort_packages?: string;
+    darkMode?: boolean;
+    url_prefix?: string;
+    language?: string;
+    login?: boolean;
+    scope?: string;
+    pkgManagers?: PackageManagers[];
+  };
+
+  /**
+   * Options are passed to the index.html
+   */
+  export type TemplateUIOptions = {
+    uri?: string;
+    darkMode?: boolean;
+    protocol?: string;
+    host?: string;
+    scope?: string;
+    base: string;
+    primaryColor?: string;
+    version?: string;
+    logoURI?: string;
+  } & CommonWebConf;
+
+  /**
+   * Options on config.yaml for web
+   */
+  type WebConf = {
+    // FIXME: rename to primaryColor and move it to CommonWebConf
+    primary_color?: string;
+    enable?: boolean;
+    scriptsHead?: string[];
+    scriptsBodyAfter?: string[];
+    metaScripts?: string[];
+    bodyBefore?: string[];
+    bodyAfter?: string[];
+  } & CommonWebConf;
+
   interface Dist {
     integrity?: string;
     shasum: string;
@@ -138,7 +183,7 @@ declare module '@verdaccio/types' {
     name: string;
     versions: Versions;
     'dist-tags': GenericBody;
-    time?: GenericBody;
+    time: GenericBody;
     readme?: string;
     users?: PackageUsers;
     _distfiles: DistFiles;
@@ -147,12 +192,12 @@ declare module '@verdaccio/types' {
     _rev: string;
   }
 
-  class IUploadTarball extends PassThrough {
+  interface IUploadTarball extends PassThrough {
     abort(): void;
     done(): void;
   }
 
-  class IReadTarball extends PassThrough {
+  interface IReadTarball extends PassThrough {
     abort(): void;
   }
 
@@ -187,8 +232,18 @@ declare module '@verdaccio/types' {
     publish?: string[];
     proxy?: string[];
     access?: string[];
+    unpublish: string[];
   }
 
+  // info passed to the auth plugin when a package is package is being published
+  interface AllowAccess {
+    name: string;
+    version?: string;
+    tag?: string;
+  }
+
+  interface AuthPackageAllow extends PackageAccess, AllowAccess {}
+
   interface PackageList {
     [key: string]: PackageAccess;
   }
@@ -218,6 +273,7 @@ declare module '@verdaccio/types' {
     max_users: number;
   }
 
+  // FUTURE: rename to Notification
   interface Notifications {
     method: string;
     packagePattern: RegExp;
@@ -227,25 +283,7 @@ declare module '@verdaccio/types' {
     headers: Headers;
   }
 
-  interface ConfigFile {
-    storage: string;
-    plugins: string;
-    self_path: string;
-    packages: PackageList;
-    uplinks: UpLinksConfList;
-    logs: LoggerConf[];
-    web: WebConf;
-    auth: AuthConf;
-    publish?: PublishOptions;
-    url_prefix?: string;
-    listen?: ListenAddress;
-    https?: HttpsConf;
-    http_proxy?: string;
-    https_proxy?: string;
-    no_proxy?: string;
-    max_body_size?: string;
-    notifications: Notifications;
-  }
+  type Notification = Notifications;
 
   interface Token {
     user: string;
@@ -261,7 +299,6 @@ declare module '@verdaccio/types' {
     user: string;
   }
 
-  type SyncReturn = Error | void;
   type IPackageStorage = ILocalPackageManager | void;
   type IPackageStorageManager = ILocalPackageManager;
   type IPluginStorage<T> = ILocalData<T>;
@@ -285,16 +322,6 @@ declare module '@verdaccio/types' {
   interface ListenAddress {
     [key: string]: string;
   }
-
-  interface WebConf {
-    enable?: boolean;
-    title?: string;
-    logo?: string;
-    favicon?: string;
-    gravatar?: boolean;
-    sort_packages?: string;
-  }
-
   interface HttpsConfKeyCert {
     key: string;
     cert: string;
@@ -341,32 +368,71 @@ declare module '@verdaccio/types' {
     api: APITokenOptions;
   }
 
-  interface Config {
-    user_agent: string;
-    server_id: any;
+  interface ConfigFlags {
+    token?: boolean;
+    search?: boolean;
+    changePassword?: boolean;
+  }
+  export type RateLimit = {
+    windowMs: number;
+    max: number;
+  };
+
+  export type ServerSettingsConf = {
+    // express-rate-limit settings
+    rateLimit: RateLimit;
+    keepAliveTimeout?: number;
+    // force http2 if https is defined
+    http2?: boolean;
+  };
+
+  type URLPrefix = {
+    // if is false, it would be relative by default
+    absolute: boolean;
+    // base path
+    // eg: absolute: true, https://somedomain.com/xxx/
+    // eg: absolute: false, /xxx/ (default) if url_prefix is an string instead an object
+    basePath: string;
+  };
+
+  interface ConfigYaml {
     _debug?: boolean;
     storage?: string | void;
-    plugins?: string | void;
-    secret: string;
-    self_path: string;
     packages: PackageList;
     uplinks: UpLinksConfList;
+    // @deprecated in favor of log
     logs?: LoggerConf[];
+    log?: LoggerConf[];
     web?: WebConf;
     auth?: AuthConf;
     security: Security;
     publish?: PublishOptions;
-    url_prefix?: string;
     store?: any;
     listen?: ListenAddress;
     https?: HttpsConf;
     http_proxy?: string;
+    plugins?: string | void;
     https_proxy?: string;
     no_proxy?: string;
     max_body_size?: string;
     notifications?: Notifications;
+    notify?: Notifications | Notifications[];
     middlewares?: any;
     filters?: any;
+    url_prefix?: string;
+    server?: ServerSettingsConf;
+    flags?: ConfigFlags;
+  }
+
+  interface ConfigRuntime extends ConfigYaml {
+    config_path: string;
+  }
+
+  interface Config extends ConfigYaml, ConfigRuntime {
+    user_agent: string;
+    server_id: string;
+    secret: string;
+    // deprecated
     checkSecretKey(token: string): string;
     getMatchedPackagesSpec(storage: string): PackageAccess | void;
     [key: string]: any;
@@ -376,41 +442,25 @@ declare module '@verdaccio/types' {
     https: HttpsConf;
   }
 
-  interface ITokenActions {
+  export interface ITokenActions {
     saveToken(token: Token): Promise<any>;
     deleteToken(user: string, tokenKey: string): Promise<any>;
     readTokens(filter: TokenFilter): Promise<Token[]>;
   }
 
   /**
-   * This method expect return a Package object
-   * eg:
-   * {
-   *   name: string;
-   *   time: number;
-   *   ... and other props
-   * }
-   *
-   * The `cb` callback object will be executed if:
-   *  - it might return object (truly)
-   *  - it might reutrn null
+   * @deprecated use @verdaccio/core pluginUtils instead
    */
-  type onSearchPackage = (item: Package, cb: CallbackAction) => void;
-  // FIXME: error should be export type `VerdaccioError = HttpError & { code: number };`
-  // but this type is on @verdaccio/commons-api and cannot be used here yet
-  type onEndSearchPackage = (error?: any) => void;
-  type onValidatePackage = (name: string) => boolean;
-
   interface ILocalData<T> extends IPlugin<T>, ITokenActions {
     logger: Logger;
     config: T & Config;
-    add(name: string, callback: Callback): void;
-    remove(name: string, callback: Callback): void;
-    get(callback: Callback): void;
+    add(name: string): Promise<void>;
+    remove(name: string): Promise<void>;
+    get(): Promise<any>;
+    init(): Promise<void>;
     getSecret(): Promise<string>;
     setSecret(secret: string): Promise<any>;
     getPackageStorage(packageInfo: string): IPackageStorage;
-    search(onPackage: onSearchPackage, onEnd: onEndSearchPackage, validateName: onValidatePackage): void;
   }
 
   type StorageUpdateCallback = (data: Package, cb: CallbackAction) => void;
@@ -425,14 +475,14 @@ declare module '@verdaccio/types' {
     readTarball(pkgName: string): IReadTarball;
     readPackage(fileName: string, callback: ReadPackageCallback): void;
     createPackage(pkgName: string, value: Package, cb: CallbackAction): void;
-    deletePackage(fileName: string, callback: CallbackAction): void;
-    removePackage(callback: CallbackAction): void;
+    deletePackage(fileName: string): Promise<void>;
+    removePackage(): Promise<void>;
     updatePackage(
       pkgFileName: string,
       updateHandler: StorageUpdateCallback,
       onWrite: StorageWriteCallback,
       transformPackage: PackageTransformer,
-      onEnd: CallbackAction
+      onEnd: Callback
     ): void;
     savePackage(fileName: string, json: Package, callback: CallbackAction): void;
   }
@@ -444,41 +494,30 @@ declare module '@verdaccio/types' {
   }
 
   interface StoragePackageActions extends TarballActions {
-    addVersion(name: string, version: string, metadata: Version, tag: StringValue, callback: Callback): void;
+    addVersion(
+      name: string,
+      version: string,
+      metadata: Version,
+      tag: StringValue,
+      callback: Callback
+    ): void;
     mergeTags(name: string, tags: MergeTags, callback: Callback): void;
     removePackage(name: string, callback: Callback): void;
     changePackage(name: string, metadata: Package, revision: string, callback: Callback): void;
   }
 
-  interface IStorageManager<T> extends StoragePackageActions {
-    config: T & Config;
-    logger: Logger;
-    init(config: T & Config, filters: any): Promise<any>;
-    addPackage(name: string, metadata: any, callback: Callback): Promise<any>;
-    getPackage(options: any): void;
-    search(startkey: string, options: any): IReadTarball;
-    getLocalDatabase(callback: Callback): void;
-  }
-
-  interface IBasicStorage<T> extends StoragePackageActions {
-    addPackage(name: string, info: Package, callback: Callback): void;
-    updateVersions(name: string, packageInfo: Package, callback: Callback): void;
-    getPackageMetadata(name: string, callback: Callback): void;
-    search(startKey: string, options: any): IReadTarball;
-    getSecret(config: T & Config): Promise<any>;
-  }
-
+  // @deprecated use IBasicAuth from @verdaccio/auth
   interface IBasicAuth<T> {
     config: T & Config;
-    aesEncrypt(buf: Buffer): Buffer;
+    aesEncrypt(buf: string): string;
     authenticate(user: string, password: string, cb: Callback): void;
     changePassword(user: string, password: string, newPassword: string, cb: Callback): void;
     allow_access(pkg: AuthPluginPackage, user: RemoteUser, callback: Callback): void;
     add_user(user: string, password: string, cb: Callback): any;
   }
 
-  class Plugin<T> {
-    constructor(config: T, options: PluginOptions<T>);
+  export interface Plugin<T> {
+    new (config: T, options: PluginOptions<T>): T;
   }
 
   interface IPlugin<T> {
@@ -492,14 +531,9 @@ declare module '@verdaccio/types' {
     logger: Logger;
   }
 
-  interface AllowAccess {
-    name: string;
-    version?: string;
-    tag?: string;
-  }
-
-  // FIXME: error should be export type `VerdaccioError = HttpError & { code: number };` instead of AuthError
-  // but this type is on @verdaccio/commons-api and cannot be used here yet (I don't know why)
+  // FIXME: error should be export type `VerdaccioError = HttpError & { code: number };`
+  // instead of AuthError
+  // but this type is on @verdaccio/core and cannot be used here yet (I don't know why)
   interface HttpError extends Error {
     status: number;
     statusCode: number;
@@ -518,20 +552,35 @@ declare module '@verdaccio/types' {
     authenticate(user: string, password: string, cb: AuthCallback): void;
     adduser?(user: string, password: string, cb: AuthCallback): void;
     changePassword?(user: string, password: string, newPassword: string, cb: AuthCallback): void;
-    allow_publish?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;
+    allow_publish?(user: RemoteUser, pkg: T & AuthPackageAllow, cb: AuthAccessCallback): void;
     allow_access?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;
-    allow_unpublish?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;
-    allow_publish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
+    allow_unpublish?(user: RemoteUser, pkg: T & AuthPackageAllow, cb: AuthAccessCallback): void;
+    allow_publish?(
+      user: RemoteUser,
+      pkg: AllowAccess & PackageAccess,
+      cb: AuthAccessCallback
+    ): void;
     allow_access?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
-    allow_unpublish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
+    allow_unpublish?(
+      user: RemoteUser,
+      pkg: AllowAccess & PackageAccess,
+      cb: AuthAccessCallback
+    ): void;
     apiJWTmiddleware?(helpers: any): Function;
   }
 
+  // @deprecated use @verdaccio/server
   interface IPluginMiddleware<T> extends IPlugin<T> {
-    register_middlewares(app: any, auth: IBasicAuth<T>, storage: IStorageManager<T>): void;
+    register_middlewares(app: any, auth: IBasicAuth<T>, storage: any): void;
   }
 
   interface IPluginStorageFilter<T> extends IPlugin<T> {
     filter_metadata(packageInfo: Package): Promise<Package>;
   }
+
+  export type SearchResultWeb = {
+    name: string;
+    version: string;
+    description: string;
+  };
 }

package/package.json

@@ -1,37 +1,48 @@
 {
   "name": "@verdaccio/types",
-  "version": "10.1.0",
+  "version": "11.0.0-6-next.10",
   "description": "verdaccio types definitions",
   "keywords": [
-    "verdaccio",
-    "typescript",
-    "types"
+    "private",
+    "package",
+    "repository",
+    "registry",
+    "enterprise",
+    "modules",
+    "proxy",
+    "server",
+    "verdaccio"
   ],
   "author": "Juan Picado <juanpicado19@gmail.com>",
   "license": "MIT",
   "homepage": "https://verdaccio.org",
+  "engines": {
+    "node": ">=14",
+    "npm": ">=6"
+  },
   "repository": {
-    "type": "git",
-    "url": "https://github.com/verdaccio/monorepo",
-    "directory": "core/types"
+    "type": "https",
+    "url": "https://github.com/verdaccio/verdaccio",
+    "directory": "packages/core/types"
   },
   "bugs": {
-    "url": "https://github.com/verdaccio/monorepo/issues"
+    "url": "https://github.com/verdaccio/verdaccio/issues"
   },
   "publishConfig": {
     "access": "public"
   },
   "main": "index.d.ts",
   "types": "index.d.ts",
+  "scripts": {
+    "test": "exit 0",
+    "build": "exit 0"
+  },
   "devDependencies": {
-    "@types/node": "14.18.0"
+    "@types/node": "14.6.0",
+    "tsd": "0.18.0"
   },
   "funding": {
     "type": "opencollective",
     "url": "https://opencollective.com/verdaccio"
-  },
-  "scripts": {
-    "test": "exit 0",
-    "build": "exit 0"
   }
-}
+}