@verdaccio/types 10.4.1 → 10.5.1

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change Log
 
+## 10.5.1
+
+### Patch Changes
+
+- 4643709: fix: wrong package configuration
+
+## 10.5.0
+
+### Minor Changes
+
+- b5cfaf6: feat: refactor types and typescript 4
+
+## 10.4.2
+
+### Patch Changes
+
+- 2d428b3: fix: user_agent property as boolean
+
 ## 10.4.1
 
 ### Patch Changes

package/README.md

@@ -1,8 +1,9 @@
-# Typescript types for Verdaccio
+# Typescript types
 
 Typescript definitions for verdaccio plugins and internal code
 
-# Typescript
+## Usage
+
 For usage with the library, the `tsconfig.json` should looks like this.
 
 ```
@@ -29,9 +30,9 @@ For usage with the library, the `tsconfig.json` should looks like this.
 }
 ```
 
-### Imports
+### Example
 
-```
+```typescript
 import type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types';
 
  class LocalData implements ILocalData {
@@ -45,4 +46,4 @@ import type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types';
 }
 ```
 
-
+#### Plugins

package/build/commons.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="node" />
+export declare type Callback = Function;
+export declare type CallbackAction = (err: any | null) => void;
+export declare type CallbackError = (err: NodeJS.ErrnoException) => void;
+export interface RemoteUser {
+    real_groups: string[];
+    groups: string[];
+    name: string | void;
+    error?: string;
+}
+export declare type StringValue = string | void | null;
+export interface HttpError extends Error {
+    status: number;
+    statusCode: number;
+    expose: boolean;
+    headers?: {
+        [key: string]: string;
+    };
+    [key: string]: any;
+}

package/build/configuration.d.ts

@@ -0,0 +1,156 @@
+import { PackageAccess, PackageList } from './manifest';
+export declare type TypeToken = 'Bearer' | 'Basic';
+export interface Logger {
+    child: (conf: any) => any;
+    debug: (conf: any, template?: string) => void;
+    error: (conf: any, template?: string) => void;
+    http: (conf: any, template?: string) => void;
+    trace: (conf: any, template?: string) => void;
+    warn: (conf: any, template?: string) => void;
+    info: (conf: any, template?: string) => void;
+}
+export declare type LoggerType = 'stdout' | 'stderr' | 'file';
+export declare type LoggerFormat = 'pretty' | 'pretty-timestamped' | 'file';
+export declare type LoggerLevel = 'http' | 'fatal' | 'warn' | 'info' | 'debug' | 'trace';
+export interface ConfigWithHttps extends Config {
+    https: HttpsConf;
+}
+export interface LoggerConfItem {
+    type: LoggerType;
+    format: LoggerFormat;
+    level: LoggerLevel;
+}
+export interface Headers {
+    [key: string]: string;
+}
+export interface UpLinkTokenConf {
+    type: TypeToken;
+    token?: string;
+    token_env?: boolean | string;
+}
+export interface UpLinkConf {
+    url: string;
+    ca?: string;
+    cache?: boolean;
+    timeout?: string | void;
+    maxage?: string | void;
+    max_fails?: number | void;
+    fail_timeout?: string | void;
+    headers?: Headers;
+    auth?: UpLinkTokenConf;
+    strict_ssl?: boolean | void;
+    _autogenerated?: boolean;
+}
+export declare type RateLimit = {
+    windowMs?: number;
+    max?: number;
+};
+export interface WebConf {
+    enable?: boolean;
+    title?: string;
+    logo?: string;
+    favicon?: string;
+    gravatar?: boolean;
+    sort_packages?: string;
+    rateLimit?: RateLimit;
+}
+export interface UpLinksConfList {
+    [key: string]: UpLinkConf;
+}
+export interface AuthHtpasswd {
+    file: string;
+    max_users: number;
+}
+export declare type AuthConf = any | AuthHtpasswd;
+export interface JWTOptions {
+    sign: JWTSignOptions;
+    verify: JWTVerifyOptions;
+}
+export interface JWTSignOptions {
+    algorithm?: string;
+    expiresIn?: string;
+    notBefore?: string;
+    ignoreExpiration?: boolean;
+    maxAge?: string | number;
+    clockTimestamp?: number;
+}
+export interface JWTVerifyOptions {
+    algorithm?: string;
+    expiresIn?: string;
+    notBefore?: string | number;
+    ignoreExpiration?: boolean;
+    maxAge?: string | number;
+    clockTimestamp?: number;
+}
+export interface APITokenOptions {
+    legacy: boolean;
+    jwt?: JWTOptions;
+}
+export interface Security {
+    web: JWTOptions;
+    api: APITokenOptions;
+}
+export interface PublishOptions {
+    allow_offline: boolean;
+}
+export interface ListenAddress {
+    [key: string]: string;
+}
+export interface HttpsConfKeyCert {
+    key: string;
+    cert: string;
+    ca?: string;
+}
+export interface HttpsConfPfx {
+    pfx: string;
+    passphrase?: string;
+}
+export declare type HttpsConf = HttpsConfKeyCert | HttpsConfPfx;
+export interface Notifications {
+    method: string;
+    packagePattern: RegExp;
+    packagePatternFlags: string;
+    endpoint: string;
+    content: string;
+    headers: Headers;
+}
+export declare type ServerSettingsConf = {
+    rateLimit: RateLimit;
+    keepAliveTimeout?: number;
+};
+export interface ConfigYaml {
+    _debug?: boolean;
+    storage?: string | void;
+    packages: PackageList;
+    uplinks: UpLinksConfList;
+    logs?: LoggerConfItem;
+    web?: WebConf;
+    auth?: AuthConf;
+    security: Security;
+    publish?: PublishOptions;
+    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;
+}
+export interface ConfigRuntime extends ConfigYaml {
+    self_path: string;
+}
+export interface Config extends ConfigYaml, ConfigRuntime {
+    user_agent?: string | boolean;
+    server_id: string;
+    secret: string;
+    checkSecretKey(token: string): string;
+    getMatchedPackagesSpec(storage: string): PackageAccess | void;
+    [key: string]: any;
+}

package/build/manifest.d.ts

@@ -0,0 +1,112 @@
+export interface PackageAccess {
+    storage?: string;
+    publish?: string[];
+    proxy?: string[];
+    access?: string[];
+}
+export interface PackageList {
+    [key: string]: PackageAccess;
+}
+export interface MergeTags {
+    [key: string]: string;
+}
+export interface DistFile {
+    url: string;
+    sha: string;
+    registry?: string;
+}
+export interface DistFiles {
+    [key: string]: DistFile;
+}
+export interface Token {
+    user: string;
+    token: string;
+    key: string;
+    cidr?: string[];
+    readonly: boolean;
+    created: number | string;
+    updated?: number | string;
+}
+export interface AttachMents {
+    [key: string]: AttachMentsItem;
+}
+export interface AttachMentsItem {
+    content_type?: string;
+    data?: string;
+    length?: number;
+    shasum?: string;
+    version?: string;
+}
+export interface GenericBody {
+    [key: string]: string;
+}
+export interface UpLinkMetadata {
+    etag: string;
+    fetched: number;
+}
+export interface UpLinks {
+    [key: string]: UpLinkMetadata;
+}
+export interface Dist {
+    integrity?: string;
+    shasum: string;
+    tarball: string;
+}
+export interface Author {
+    name: string;
+    email?: string;
+    url?: string;
+}
+export interface PackageUsers {
+    [key: string]: boolean;
+}
+export interface Version {
+    name: string;
+    version: string;
+    devDependencies?: string;
+    directories?: any;
+    dist: Dist;
+    author: string | Author;
+    main: string;
+    homemage?: string;
+    license?: string;
+    readme: string;
+    readmeFileName?: string;
+    readmeFilename?: string;
+    description: string;
+    bin?: string;
+    bugs?: any;
+    files?: string[];
+    gitHead?: string;
+    maintainers?: Author[];
+    contributors?: Author[];
+    repository?: string | any;
+    scripts?: any;
+    homepage?: string;
+    etag?: string;
+    dependencies: any;
+    keywords?: string | string[];
+    nodeVersion?: string;
+    _id: string;
+    _npmVersion?: string;
+    _npmUser: Author;
+    _hasShrinkwrap?: boolean;
+    deprecated?: string;
+}
+export interface Versions {
+    [key: string]: Version;
+}
+export declare type Package = Manifest;
+export interface Manifest {
+    _id?: string;
+    name: string;
+    versions: Versions;
+    'dist-tags': GenericBody;
+    time?: GenericBody;
+    readme?: string;
+    users?: PackageUsers;
+    _distfiles: DistFiles;
+    _attachments: AttachMents;
+    _uplinks: UpLinks;
+    _rev: string;
+}

package/build/plugins/auth.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Callback, HttpError, RemoteUser } from '../commons';
+import { Config } from '../configuration';
+export interface AuthPluginPackage {
+    packageName: string;
+    packageVersion?: string;
+    tag?: string;
+}
+export declare type AuthError = HttpError & {
+    code: number;
+};
+export declare type AuthAccessCallback = (error: AuthError | null, access: boolean) => void;
+export declare type AuthCallback = (error: AuthError | null, groups: string[] | false) => void;
+export interface IBasicAuth<T> {
+    config: T & Config;
+    aesEncrypt(buf: Buffer): Buffer;
+    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;
+}

package/build/plugins/commons.d.ts

@@ -0,0 +1,11 @@
+import { Config, Logger } from '../configuration';
+export declare class Plugin<T> {
+    constructor(config: T, options: PluginOptions<T>);
+}
+export interface IPlugin<T> {
+    version?: string;
+}
+export interface PluginOptions<T> {
+    config: T & Config;
+    logger: Logger;
+}

package/build/plugins/filter.d.ts

@@ -0,0 +1,5 @@
+import { Package } from '../manifest';
+import { IPlugin } from './commons';
+export interface IPluginStorageFilter<T> extends IPlugin<T> {
+    filter_metadata(packageInfo: Package): Promise<Package>;
+}

package/build/plugins/index.d.ts

@@ -0,0 +1,34 @@
+import { RemoteUser } from '../commons';
+import { PackageAccess } from '../manifest';
+import { AuthAccessCallback, AuthCallback } from './auth';
+import { IPlugin } from './commons';
+export interface AllowAccess {
+    name: string;
+    version?: string;
+    tag?: string;
+}
+/**
+ * ```typescript
+ *  dasdsadsa()
+ * ```
+ */
+export interface IPluginAuth<T> extends IPlugin<T> {
+    /**
+     * @param props user from Application component
+     */
+    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_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_access?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
+    allow_unpublish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
+    apiJWTmiddleware?(helpers: any): Function;
+}
+export * from './auth';
+export * from './storage';
+export * from './middleware';
+export * from './commons';
+export * from './filter';

package/build/plugins/middleware.d.ts

@@ -0,0 +1,6 @@
+import { IBasicAuth } from './auth';
+import { IPlugin } from './commons';
+import { IStorageManager } from './storage';
+export interface IPluginMiddleware<T> extends IPlugin<T> {
+    register_middlewares(app: any, auth: IBasicAuth<T>, storage: IStorageManager<T>): void;
+}

package/build/plugins/storage.d.ts

@@ -0,0 +1,105 @@
+/// <reference types="node" />
+import { PassThrough } from 'stream';
+import { Callback, CallbackAction, StringValue } from '../commons';
+import { Config, Logger } from '../configuration';
+import { MergeTags, Package, Token, Version } from '../manifest';
+import { IPlugin } from './commons';
+export declare class IUploadTarball extends PassThrough {
+    abort(): void;
+    done(): void;
+}
+export declare class IReadTarball extends PassThrough {
+    abort(): void;
+}
+export declare type StorageList = string[];
+export interface LocalStorage {
+    list: any;
+    secret: string;
+}
+export interface ILocalStorage {
+    add(name: string): void;
+    remove(name: string): void;
+    get(): StorageList;
+    sync(): void;
+}
+interface TarballActions {
+    addTarball(name: string, filename: string): IUploadTarball;
+    getTarball(name: string, filename: string): IReadTarball;
+    removeTarball(name: string, filename: string, revision: string, callback: Callback): void;
+}
+interface StoragePackageActions extends TarballActions {
+    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;
+}
+export 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;
+}
+export 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>;
+}
+export interface TokenFilter {
+    user: string;
+}
+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
+ */
+export declare type onSearchPackage = (item: Package, cb: CallbackAction) => void;
+export declare type onEndSearchPackage = (error?: any) => void;
+export declare type onValidatePackage = (name: string) => boolean;
+export declare type StorageUpdateCallback = (data: Package, cb: CallbackAction) => void;
+export declare type StorageWriteCallback = (name: string, json: Package, callback: Callback) => void;
+export declare type PackageTransformer = (pkg: Package) => Package;
+export declare type ReadPackageCallback = (err: any | null, data?: Package) => void;
+export interface ILocalPackageManager {
+    logger: Logger;
+    writeTarball(pkgName: string): IUploadTarball;
+    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;
+    updatePackage(pkgFileName: string, updateHandler: StorageUpdateCallback, onWrite: StorageWriteCallback, transformPackage: PackageTransformer, onEnd: CallbackAction): void;
+    savePackage(fileName: string, json: Package, callback: CallbackAction): void;
+}
+export declare type IPackageStorage = ILocalPackageManager | void;
+export declare type IPluginStorage<T> = ILocalData<T>;
+export declare type IPackageStorageManager = ILocalPackageManager;
+export 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;
+    getSecret(): Promise<string>;
+    setSecret(secret: string): Promise<any>;
+    getPackageStorage(packageInfo: string): IPackageStorage;
+    search(onPackage: onSearchPackage, onEnd: onEndSearchPackage, validateName: onValidatePackage): void;
+}
+export {};

package/build/types.d.ts

@@ -0,0 +1,4 @@
+export * from './plugins';
+export * from './manifest';
+export * from './commons';
+export * from './configuration';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdaccio/types",
-  "version": "10.4.1",
+  "version": "10.5.1",
   "description": "verdaccio types definitions",
   "keywords": [
     "verdaccio",
@@ -21,18 +21,23 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "index.d.ts",
-  "types": "index.d.ts",
+  "main": "build/types.d.ts",
+  "types": "build/types.d.ts",
   "devDependencies": {
-    "@types/node": "14.18.0"
+    "@types/node": "12.12.6",
+    "typedoc": "^0.22.17",
+    "typedoc-plugin-missing-exports": "^0.22.6",
+    "typedoc-umlclass": "^0.6.1"
   },
   "funding": {
     "type": "opencollective",
     "url": "https://opencollective.com/verdaccio"
   },
   "scripts": {
+    "clean": "rimraf ./build",
     "test": "exit 0",
-    "build": "exit 0"
+    "build": "tsc --emitDeclarationOnly -p tsconfig.json",
+    "docs": "typedoc --options ./typedoc.json --excludeExternals"
   },
-  "readme": "# Typescript types for Verdaccio\n\nTypescript definitions for verdaccio plugins and internal code\n\n# Typescript\nFor usage with the library, the `tsconfig.json` should looks like this.\n\n```\n//tsconfig.json\n{\n  \"compilerOptions\": {\n    \"target\": \"esnext\",\n    \"module\": \"commonjs\",\n    \"declaration\": true,\n    \"noImplicitAny\": false,\n    \"strict\": true,\n    \"outDir\": \"lib\",\n    \"allowSyntheticDefaultImports\": true,\n    \"esModuleInterop\": true,\n    \"typeRoots\": [\n      \"./node_modules/@verdaccio/types/lib/verdaccio\",\n      \"./node_modules/@types\"\n    ]\n  },\n  \"include\": [\n    \"src/*.ts\",\n    \"types/*.d.ts\"\n  ]\n}\n```\n\n### Imports\n\n```\nimport type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types';\n\n class LocalData implements ILocalData {\n\n  path: string;\n  logger: Logger;\n  data: LocalStorage;\n  config: Config;\n  locked: boolean;\n  ...\n}\n```\n\n\n"
+  "readme": "# Typescript types\n\nTypescript definitions for verdaccio plugins and internal code\n\n## Usage\n\nFor usage with the library, the `tsconfig.json` should looks like this.\n\n```\n//tsconfig.json\n{\n  \"compilerOptions\": {\n    \"target\": \"esnext\",\n    \"module\": \"commonjs\",\n    \"declaration\": true,\n    \"noImplicitAny\": false,\n    \"strict\": true,\n    \"outDir\": \"lib\",\n    \"allowSyntheticDefaultImports\": true,\n    \"esModuleInterop\": true,\n    \"typeRoots\": [\n      \"./node_modules/@verdaccio/types/lib/verdaccio\",\n      \"./node_modules/@types\"\n    ]\n  },\n  \"include\": [\n    \"src/*.ts\",\n    \"types/*.d.ts\"\n  ]\n}\n```\n\n### Example\n\n```typescript\nimport type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types';\n\n class LocalData implements ILocalData {\n\n  path: string;\n  logger: Logger;\n  data: LocalStorage;\n  config: Config;\n  locked: boolean;\n  ...\n}\n```\n\n#### Plugins\n"
 }

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "commonjs",
+    "noImplicitAny": false,
+    "strict": true,
+    "declaration": true,
+    "strictNullChecks": true,
+    "resolveJsonModule": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "rootDir": "./src",
+    "outDir": "./build"
+  }
+}

package/index.d.ts

@@ -1,578 +0,0 @@
-// <reference types="node" />
-
-import { PassThrough } from 'stream';
-
-declare module '@verdaccio/types' {
-  type StringValue = string | void | null;
-
-  type StorageList = string[];
-  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 {
-    name: string;
-    email?: string;
-    url?: string;
-  }
-
-  interface Dist {
-    integrity?: string;
-    shasum: string;
-    tarball: string;
-  }
-
-  interface RemoteUser {
-    real_groups: string[];
-    groups: string[];
-    name: string | void;
-    error?: string;
-  }
-
-  interface LocalStorage {
-    list: any;
-    secret: string;
-  }
-
-  interface Version {
-    name: string;
-    version: string;
-    devDependencies?: string;
-    directories?: any;
-    dist: Dist;
-    author: string | Author;
-    main: string;
-    homemage?: string;
-    license?: string;
-    readme: string;
-    readmeFileName?: string;
-    readmeFilename?: string;
-    description: string;
-    bin?: string;
-    bugs?: any;
-    files?: string[];
-    gitHead?: string;
-    maintainers?: Author[];
-    contributors?: Author[];
-    repository?: string | any;
-    scripts?: any;
-    homepage?: string;
-    etag?: string;
-    dependencies: any;
-    keywords?: string | string[];
-    nodeVersion?: string;
-    _id: string;
-    _npmVersion?: string;
-    _npmUser: Author;
-    _hasShrinkwrap?: boolean;
-    deprecated?: string;
-  }
-
-  interface Logger {
-    child: (conf: any) => any;
-    debug: (conf: any, template?: string) => void;
-    error: (conf: any, template?: string) => void;
-    http: (conf: any, template?: string) => void;
-    trace: (conf: any, template?: string) => void;
-    warn: (conf: any, template?: string) => void;
-    info: (conf: any, template?: string) => void;
-  }
-
-  interface Versions {
-    [key: string]: Version;
-  }
-
-  interface DistFile {
-    url: string;
-    sha: string;
-    registry?: string;
-  }
-
-  interface MergeTags {
-    [key: string]: string;
-  }
-
-  interface DistFiles {
-    [key: string]: DistFile;
-  }
-
-  interface AttachMents {
-    [key: string]: AttachMentsItem;
-  }
-
-  interface AttachMentsItem {
-    content_type?: string;
-    data?: string;
-    length?: number;
-    shasum?: string;
-    version?: string;
-  }
-
-  interface GenericBody {
-    [key: string]: string;
-  }
-
-  interface UpLinkMetadata {
-    etag: string;
-    fetched: number;
-  }
-
-  interface UpLinks {
-    [key: string]: UpLinkMetadata;
-  }
-
-  interface Tags {
-    [key: string]: Version;
-  }
-
-  interface Headers {
-    [key: string]: string;
-  }
-
-  interface PackageUsers {
-    [key: string]: boolean;
-  }
-
-  interface Package {
-    _id?: string;
-    name: string;
-    versions: Versions;
-    'dist-tags': GenericBody;
-    time?: GenericBody;
-    readme?: string;
-    users?: PackageUsers;
-    _distfiles: DistFiles;
-    _attachments: AttachMents;
-    _uplinks: UpLinks;
-    _rev: string;
-  }
-
-  class IUploadTarball extends PassThrough {
-    abort(): void;
-    done(): void;
-  }
-
-  class IReadTarball extends PassThrough {
-    abort(): void;
-  }
-
-  interface UpLinkTokenConf {
-    type: 'Bearer' | 'Basic';
-    token?: string;
-    token_env?: boolean | string;
-  }
-
-  interface UpLinkConf {
-    url: string;
-    ca?: string;
-    cache?: boolean;
-    timeout?: string | void;
-    maxage?: string | void;
-    max_fails?: number | void;
-    fail_timeout?: string | void;
-    headers?: Headers;
-    auth?: UpLinkTokenConf;
-    strict_ssl?: boolean | void;
-    _autogenerated?: boolean;
-  }
-
-  interface AuthPluginPackage {
-    packageName: string;
-    packageVersion?: string;
-    tag?: string;
-  }
-
-  interface PackageAccess {
-    storage?: string;
-    publish?: string[];
-    proxy?: string[];
-    access?: string[];
-  }
-
-  interface PackageList {
-    [key: string]: PackageAccess;
-  }
-
-  interface UpLinksConfList {
-    [key: string]: UpLinkConf;
-  }
-
-  type LoggerType = 'stdout' | 'stderr' | 'file';
-  type LoggerFormat = 'pretty' | 'pretty-timestamped' | 'file';
-  type LoggerLevel = 'http' | 'fatal' | 'warn' | 'info' | 'debug' | 'trace';
-
-  interface LoggerConfItem {
-    type: LoggerType;
-    format: LoggerFormat;
-    level: LoggerLevel;
-  }
-
-  interface PublishOptions {
-    allow_offline: boolean;
-  }
-
-  type AuthConf = any | AuthHtpasswd;
-
-  interface AuthHtpasswd {
-    file: string;
-    max_users: number;
-  }
-
-  interface Notifications {
-    method: string;
-    packagePattern: RegExp;
-    packagePatternFlags: string;
-    endpoint: string;
-    content: string;
-    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;
-  }
-
-  interface Token {
-    user: string;
-    token: string;
-    key: string;
-    cidr?: string[];
-    readonly: boolean;
-    created: number | string;
-    updated?: number | string;
-  }
-
-  interface TokenFilter {
-    user: string;
-  }
-
-  type SyncReturn = Error | void;
-  type IPackageStorage = ILocalPackageManager | void;
-  type IPackageStorageManager = ILocalPackageManager;
-  type IPluginStorage<T> = ILocalData<T>;
-
-  interface AuthHtpasswd {
-    file: string;
-    max_users: number;
-  }
-
-  interface ILocalStorage {
-    add(name: string): void;
-    remove(name: string): void;
-    get(): StorageList;
-    sync(): void;
-  }
-
-  interface LoggerConf {
-    [key: string]: LoggerConfItem;
-  }
-
-  interface ListenAddress {
-    [key: string]: string;
-  }
-
-  interface WebConf {
-    enable?: boolean;
-    title?: string;
-    logo?: string;
-    favicon?: string;
-    gravatar?: boolean;
-    sort_packages?: string;
-    rateLimit?: RateLimit;
-  }
-
-  interface HttpsConfKeyCert {
-    key: string;
-    cert: string;
-    ca?: string;
-  }
-
-  interface HttpsConfPfx {
-    pfx: string;
-    passphrase?: string;
-  }
-
-  type HttpsConf = HttpsConfKeyCert | HttpsConfPfx;
-
-  interface JWTOptions {
-    sign: JWTSignOptions;
-    verify: JWTVerifyOptions;
-  }
-
-  interface JWTVerifyOptions {
-    algorithm?: string;
-    expiresIn?: string;
-    notBefore?: string | number;
-    ignoreExpiration?: boolean;
-    maxAge?: string | number;
-    clockTimestamp?: number;
-  }
-
-  interface JWTSignOptions {
-    algorithm?: string;
-    expiresIn?: string;
-    notBefore?: string;
-    ignoreExpiration?: boolean;
-    maxAge?: string | number;
-    clockTimestamp?: number;
-  }
-
-  interface APITokenOptions {
-    legacy: boolean;
-    jwt?: JWTOptions;
-  }
-
-  type RateLimit = {
-    windowMs?: number;
-    max?: number;
-  };
-
-  interface Security {
-    web: JWTOptions;
-    api: APITokenOptions;
-  }
-
-  export type ServerSettingsConf = {
-    // express-rate-limit settings
-    rateLimit: RateLimit;
-    keepAliveTimeout?: number;
-  };
-
-  interface ConfigYaml {
-    _debug?: boolean;
-    storage?: string | void;
-    packages: PackageList;
-    uplinks: UpLinksConfList;
-    // FUTURE: log should be mandatory
-    logs?: LoggerConfItem;
-    web?: WebConf;
-    auth?: AuthConf;
-    security: Security;
-    publish?: PublishOptions;
-    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;
-  }
-
-  interface ConfigRuntime extends ConfigYaml {
-    // @deprecated on v6 this is config_path
-    self_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;
-  }
-
-  interface ConfigWithHttps extends Config {
-    https: HttpsConf;
-  }
-
-  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
-   */
-  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;
-    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;
-  type StorageUpdateHandler = (name: string, cb: StorageUpdateCallback) => void;
-  type StorageWriteCallback = (name: string, json: Package, callback: Callback) => void;
-  type PackageTransformer = (pkg: Package) => Package;
-  type ReadPackageCallback = (err: any | null, data?: Package) => void;
-
-  interface ILocalPackageManager {
-    logger: Logger;
-    writeTarball(pkgName: string): IUploadTarball;
-    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;
-    updatePackage(
-      pkgFileName: string,
-      updateHandler: StorageUpdateCallback,
-      onWrite: StorageWriteCallback,
-      transformPackage: PackageTransformer,
-      onEnd: CallbackAction
-    ): void;
-    savePackage(fileName: string, json: Package, callback: CallbackAction): void;
-  }
-
-  interface TarballActions {
-    addTarball(name: string, filename: string): IUploadTarball;
-    getTarball(name: string, filename: string): IReadTarball;
-    removeTarball(name: string, filename: string, revision: string, callback: Callback): void;
-  }
-
-  interface StoragePackageActions extends TarballActions {
-    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>;
-  }
-
-  interface IBasicAuth<T> {
-    config: T & Config;
-    aesEncrypt(buf: Buffer): Buffer;
-    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>);
-  }
-
-  interface IPlugin<T> {
-    version?: string;
-    // In case a plugin needs to be cleaned up/removed
-    close?(): void;
-  }
-
-  interface PluginOptions<T> {
-    config: T & Config;
-    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)
-  interface HttpError extends Error {
-    status: number;
-    statusCode: number;
-    expose: boolean;
-    headers?: {
-      [key: string]: string;
-    };
-    [key: string]: any;
-  }
-
-  type AuthError = HttpError & { code: number };
-  type AuthAccessCallback = (error: AuthError | null, access: boolean) => void;
-  type AuthCallback = (error: AuthError | null, groups: string[] | false) => void;
-
-  interface IPluginAuth<T> extends IPlugin<T> {
-    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_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_access?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
-    allow_unpublish?(
-      user: RemoteUser,
-      pkg: AllowAccess & PackageAccess,
-      cb: AuthAccessCallback
-    ): void;
-    apiJWTmiddleware?(helpers: any): Function;
-  }
-
-  interface IPluginMiddleware<T> extends IPlugin<T> {
-    register_middlewares(app: any, auth: IBasicAuth<T>, storage: IStorageManager<T>): void;
-  }
-
-  interface IPluginStorageFilter<T> extends IPlugin<T> {
-    filter_metadata(packageInfo: Package): Promise<Package>;
-  }
-}