Merge pull request #815 from verdaccio/refactor-flow

refactor: flow 0.7x.0

.babelrc

@@ -38,7 +38,6 @@
       ]
     },
     "testOldEnv": {
-      /** FIXME: for an issue on jest env we need to use es2015-node4 **/
       "presets": [ "es2015-node4", "flow"],
       "plugins": [
         "transform-class-properties",

flow-typed/npm/express_v4.16.x.js

@@ -1,5 +1,5 @@
-// flow-typed signature: 41a220e96fcef89a09244ac3797039e8
-// flow-typed version: 9f7cf2ab0c/express_v4.16.x/flow_>=v0.32.x
+// flow-typed signature: cc24a4e737d9dfb8e1381c3bd4ebaa65
+// flow-typed version: d11eab7bb5/express_v4.16.x/flow_>=v0.32.x
 
 import type { Server } from "http";
 import type { Socket } from "net";
@@ -195,13 +195,11 @@ declare class express$Router extends express$Route {
       id: string
     ) => mixed
   ): void;
-
-  // Can't use regular callable signature syntax due to https://github.com/facebook/flow/issues/3084
-  $call: (
+  (
     req: http$IncomingMessage,
     res: http$ServerResponse,
     next?: ?express$NextFunction
-  ) => void;
+  ): void;
 }
 
 /*
@@ -250,6 +248,12 @@ declare class express$Application extends express$Router mixins events$EventEmit
     res: http$ServerResponse,
     next?: ?express$NextFunction
   ): void;
+  // callable signature is not inherited
+  (
+    req: http$IncomingMessage,
+    res: http$ServerResponse,
+    next?: ?express$NextFunction
+  ): void;
 }
 
 declare type JsonOptions = {
@@ -266,6 +270,20 @@ declare type JsonOptions = {
   ) => mixed
 };
 
+declare type express$UrlEncodedOptions = {
+  extended?: boolean,
+  inflate?: boolean,
+  limit?: string | number,
+  parameterLimit?: number,
+  type?: string | Array<string> | ((req: express$Request) => boolean),
+  verify?: (
+    req: express$Request,
+    res: express$Response,
+    buf: Buffer,
+    encoding: string
+  ) => mixed,
+}
+
 declare module "express" {
   declare export type RouterOptions = express$RouterOptions;
   declare export type CookieOptions = express$CookieOptions;
@@ -280,6 +298,7 @@ declare module "express" {
     (): express$Application, // If you try to call like a function, it will use this signature
     json: (opts: ?JsonOptions) => express$Middleware,
     static: (root: string, options?: Object) => express$Middleware, // `static` property on the function
-    Router: typeof express$Router // `Router` property on the function
+    Router: typeof express$Router, // `Router` property on the function
+    urlencoded: (opts: ?express$UrlEncodedOptions) => express$Middleware,
   };
 }

package.json

@@ -16,7 +16,7 @@
   },
   "dependencies": {
     "@verdaccio/file-locking": "0.0.7",
-    "@verdaccio/local-storage": "1.1.2",
+    "@verdaccio/local-storage": "1.1.3",
     "@verdaccio/streams": "1.0.0",
     "JSONStream": "1.3.2",
     "asciidoctor.js": "1.5.6",
@@ -52,7 +52,7 @@
   "devDependencies": {
     "@commitlint/cli": "6.1.3",
     "@commitlint/config-conventional": "6.1.3",
-    "@verdaccio/types": "3.0.1",
+    "@verdaccio/types": "3.4.1",
     "babel-cli": "6.26.0",
     "babel-core": "6.26.0",
     "babel-eslint": "8.2.2",
@@ -91,7 +91,7 @@
     "eslint-plugin-jest": "21.17.0",
     "eslint-plugin-react": "7.10.0",
     "file-loader": "1.1.11",
-    "flow-bin": "0.69.0",
+    "flow-bin": "0.76.0",
     "flow-runtime": "0.17.0",
     "friendly-errors-webpack-plugin": "1.7.0",
     "github-markdown-css": "2.10.0",

src/api/index.js

@@ -5,18 +5,26 @@ import express from 'express';
 import compression from 'compression';
 import cors from 'cors';
 import Storage from '../lib/storage';
-import {loadPlugin} from '../lib/plugin-loader';
+import loadPlugin from '../lib/plugin-loader';
 import hookDebug from './debug';
 import Auth from '../lib/auth';
 import apiEndpoint from './endpoint';
-
-import type {$Application} from 'express';
-import type {$ResponseExtend, $RequestExtend, $NextFunctionVer, IStorageHandler, IAuth} from '../../types';
-import type {Config as IConfig} from '@verdaccio/types';
 import {ErrorCode} from '../lib/utils';
 import {API_ERROR, HTTP_STATUS} from '../lib/constants';
 import AppConfig from '../lib/config';
 
+import type {$Application} from 'express';
+import type {
+  $ResponseExtend,
+  $RequestExtend,
+  $NextFunctionVer,
+  IStorageHandler,
+  IAuth} from '../../types';
+import type {
+  Config as IConfig,
+  IPluginMiddleware,
+} from '@verdaccio/types';
+
 const LoggerApp = require('../lib/logger');
 const Middleware = require('./middleware');
 const Cats = require('../lib/status-cats');
@@ -54,10 +62,10 @@ const defineAPI = function(config: IConfig, storage: IStorageHandler) {
     config: config,
     logger: LoggerApp.logger,
   };
-  const plugins = loadPlugin(config, config.middlewares, plugin_params, function(plugin) {
+  const plugins = loadPlugin(config, config.middlewares, plugin_params, function(plugin: IPluginMiddleware) {
     return plugin.register_middlewares;
   });
-  plugins.forEach(function(plugin) {
+  plugins.forEach((plugin) => {
     plugin.register_middlewares(app, auth, storage);
   });
 

src/lib/auth-utils.js

@@ -1,8 +1,12 @@
+// @flow
+
 import {ErrorCode} from './utils';
 import {API_ERROR} from './constants';
 
-export function allow_action(action) {
-  return function(user, pkg, callback) {
+import type {RemoteUser, Package, Callback} from '@verdaccio/types';
+
+export function allow_action(action: string) {
+  return function(user: RemoteUser, pkg: Package, callback: Callback) {
     const {name, groups} = user;
     const hasPermission = pkg[action].some((group) => name === group || groups.includes(group));
 
@@ -20,11 +24,11 @@ export function allow_action(action) {
 
 export function getDefaultPlugins() {
   return {
-    authenticate(user, password, cb) {
+    authenticate(user: string, password: string, cb: Callback) {
       cb(ErrorCode.getForbidden(API_ERROR.BAD_USERNAME_PASSWORD));
     },
 
-    add_user(user, password, cb) {
+    add_user(user: string, password: string, cb: Callback) {
       return cb(ErrorCode.getConflict(API_ERROR.BAD_USERNAME_PASSWORD));
     },
 

src/lib/auth.js

@@ -1,17 +1,20 @@
 // @flow
 
 import _ from 'lodash';
-import {loadPlugin} from '../lib/plugin-loader';
+
+import {API_ERROR, HTTP_STATUS, ROLES, TOKEN_BASIC, TOKEN_BEARER} from './constants';
+import loadPlugin from '../lib/plugin-loader';
 import {buildBase64Buffer, ErrorCode} from './utils';
 import {aesDecrypt, aesEncrypt, signPayload, verifyPayload} from './crypto-utils';
+import {getDefaultPlugins} from './auth-utils';
 
-import type {Config, Logger, Callback} from '@verdaccio/types';
+import {getMatchedPackagesSpec} from './config-utils';
+
+import type {Config, Logger, Callback, IPluginAuth, RemoteUser} from '@verdaccio/types';
 import type {$Response, NextFunction} from 'express';
 import type {$RequestExtend, JWTPayload} from '../../types';
-import {API_ERROR, HTTP_STATUS, ROLES, TOKEN_BASIC, TOKEN_BEARER} from './constants';
-import {getMatchedPackagesSpec} from './config-utils';
 import type {IAuth} from '../../types';
-import {getDefaultPlugins} from './auth-utils';
+
 
 const LoggerApi = require('./logger');
 
@@ -36,7 +39,7 @@ class Auth implements IAuth {
       logger: this.logger,
     };
 
-    return loadPlugin(config, config.auth, pluginOptions, (plugin) => {
+    return loadPlugin(config, config.auth, pluginOptions, (plugin: IPluginAuth) => {
       const {authenticate, allow_access, allow_publish} = plugin;
 
       return authenticate || allow_access || allow_publish;
@@ -115,7 +118,7 @@ class Auth implements IAuth {
   /**
    * Allow user to access a package.
    */
-  allow_access(packageName: string, user: string, callback: Callback) {
+  allow_access(packageName: string, user: RemoteUser, callback: Callback) {
     let plugins = this.plugins.slice(0);
     // $FlowFixMe
     let pkg = Object.assign({name: packageName}, getMatchedPackagesSpec(packageName, this.config.packages));
@@ -123,11 +126,11 @@ class Auth implements IAuth {
     (function next() {
       const plugin = plugins.shift();
 
-      if (typeof(plugin.allow_access) !== 'function') {
+      if (_.isFunction(plugin.allow_access) === false) {
         return next();
       }
 
-      plugin.allow_access(user, pkg, function(err, ok) {
+      plugin.allow_access(user, pkg, function(err, ok: boolean) {
         if (err) {
           return callback(err);
         }
@@ -152,11 +155,11 @@ class Auth implements IAuth {
     (function next() {
       const plugin = plugins.shift();
 
-      if (typeof(plugin.allow_publish) !== 'function') {
+      if (_.isFunction(plugin.allow_publish) === false) {
         return next();
       }
 
-      plugin.allow_publish(user, pkg, (err, ok) => {
+      plugin.allow_publish(user, pkg, (err, ok: boolean) => {
         if (err) {
           return callback(err);
         }
@@ -185,7 +188,8 @@ class Auth implements IAuth {
         return _next();
       };
 
-      if (req.remote_user != null && req.remote_user.name !== undefined) {
+      if (_.isUndefined(req.remote_user) === false
+          && _.isUndefined(req.remote_user.name) === false) {
         return next();
       }
       req.remote_user = buildAnonymousUser();
@@ -201,7 +205,6 @@ class Auth implements IAuth {
       }
 
       const credentials = this._parseCredentials(parts);
-
       if (!credentials) {
         return next();
       }

src/lib/constants.js

@@ -67,7 +67,7 @@ export const API_MESSAGE = {
 };
 
 export const API_ERROR = {
-  BAD_USERNAME_PASSWORD: 'bad username/password, access denied {APP}',
+  BAD_USERNAME_PASSWORD: 'bad username/password, access denied',
   NO_PACKAGE: 'no such package available',
   NOT_ALLOWED: 'not allowed to access package',
   INTERNAL_SERVER_ERROR: 'internal server error',
@@ -93,7 +93,7 @@ export const APP_ERROR = {
 };
 
 export const DEFAULT_NO_README = 'ERROR: No README data found!';
-
+export const MODULE_NOT_FOUND = 'MODULE_NOT_FOUND';
 
 export const WEB_TITLE = 'Verdaccio';
 

src/lib/local-storage.js

@@ -13,7 +13,7 @@ fileExist, noSuchFile, DEFAULT_REVISION, pkgFileName,
 } from './storage-utils';
 import {createTarballHash} from './crypto-utils';
 import {prepareSearchPackage} from './storage-utils';
-import {loadPlugin} from '../lib/plugin-loader';
+import loadPlugin from '../lib/plugin-loader';
 import LocalDatabase from '@verdaccio/local-storage';
 import {UploadTarball, ReadTarball} from '@verdaccio/streams';
 import type {
@@ -396,8 +396,8 @@ class LocalStorage implements IStorage {
     const _transform = uploadStream._transform;
     const storage = this._getLocalStorage(name);
 
-    uploadStream.abort = function() {};
-    uploadStream.done = function() {};
+    (uploadStream: any).abort = function() {};
+    (uploadStream: any).done = function() {};
 
     uploadStream._transform = function(data) {
       shaOneHash.update(data);
@@ -459,11 +459,11 @@ class LocalStorage implements IStorage {
       });
     });
 
-    uploadStream.abort = function() {
+    (uploadStream: any).abort = function() {
       writeStream.abort();
     };
 
-    uploadStream.done = function() {
+    (uploadStream: any).done = function() {
       if (!length) {
         uploadStream.emit('error', ErrorCode.getBadData('refusing to accept zero-length file'));
         writeStream.abort();
@@ -521,7 +521,7 @@ class LocalStorage implements IStorage {
     const readTarballStream = storage.readTarball(filename);
     const e404 = ErrorCode.getNotFound;
 
-    stream.abort = function() {
+    (stream: any).abort = function() {
       if (_.isNil(readTarballStream) === false) {
         readTarballStream.abort();
       }
@@ -570,7 +570,7 @@ class LocalStorage implements IStorage {
    * @return {Function}
    */
   search(startKey: string, options: any) {
-    const stream = new UploadTarball({objectMode: true});
+    const stream = new ReadTarball({objectMode: true});
 
     this._searchEachPackage((item, cb) => {
       if (item.time > parseInt(startKey, 10)) {
@@ -800,7 +800,7 @@ class LocalStorage implements IStorage {
     return this.localData.setSecret(config.checkSecretKey(secretKey));
   }
 
-  _loadStorage(config: Config, logger: Logger) {
+  _loadStorage(config: Config, logger: Logger): ILocalData {
     const Storage = this._loadStorePlugin();
 
     if (_.isNil(Storage)) {
@@ -811,13 +811,13 @@ class LocalStorage implements IStorage {
     }
   }
 
-  _loadStorePlugin() {
+  _loadStorePlugin(): ILocalData {
     const plugin_params = {
       config: this.config,
       logger: this.logger,
     };
 
-    return _.head(loadPlugin(this.config, this.config.store, plugin_params, function(plugin) {
+    return _.head(loadPlugin(this.config, this.config.store, plugin_params, (plugin) => {
       return plugin.getPackageStorage;
     }));
   }

src/lib/plugin-loader.js

@@ -4,6 +4,7 @@ import Path from 'path';
 import _ from 'lodash';
 import logger from './logger';
 import type {Config} from '@verdaccio/types';
+import {MODULE_NOT_FOUND} from './constants';
 
 /**
  * Requires a module.
@@ -14,7 +15,7 @@ function tryLoad(path: string) {
   try {
     return require(path);
   } catch (err) {
-    if (err.code === 'MODULE_NOT_FOUND') {
+    if (err.code === MODULE_NOT_FOUND) {
       return null;
     }
     throw err;
@@ -44,8 +45,12 @@ function isES6(plugin) {
  * @param {*} sanityCheck callback that check the shape that should fulfill the plugin
  * @return {Array} list of plugins
  */
-function loadPlugin(config: Config, pluginConfigs: any, params: any, sanityCheck: Function) {
-  return Object.keys(pluginConfigs || {}).map(function(pluginId) {
+export default function loadPlugin<T>(
+        config: Config,
+        pluginConfigs: any = {},
+        params: any,
+        sanityCheck: Function): T[] {
+  return Object.keys(pluginConfigs).map((pluginId: string) => {
     let plugin;
 
     // try local plugins first
@@ -79,7 +84,9 @@ function loadPlugin(config: Config, pluginConfigs: any, params: any, sanityCheck
       throw Error('"' + pluginId + '" doesn\'t look like a valid plugin');
     }
     /* eslint new-cap:off */
-    plugin = isES6(plugin) ? new plugin.default(mergeConfig(config, pluginConfigs[pluginId]), params) : plugin(pluginConfigs[pluginId], params);
+    plugin = isES6(plugin)
+      ? new plugin.default(mergeConfig(config, pluginConfigs[pluginId]), params)
+      : plugin(pluginConfigs[pluginId], params);
     /* eslint new-cap:off */
 
     if (plugin === null || !sanityCheck(plugin)) {
@@ -90,5 +97,3 @@ function loadPlugin(config: Config, pluginConfigs: any, params: any, sanityCheck
     return plugin;
   });
 }
-
-export {loadPlugin};

src/lib/storage.js

@@ -136,7 +136,7 @@ class Storage implements IStorageHandler {
    */
   getTarball(name: string, filename: string) {
     let readStream = new ReadTarball();
-    readStream.abort = function() {};
+    (readStream: any).abort = function() {};
 
     let self = this;
 

src/lib/up-storage.js

@@ -430,7 +430,7 @@ class ProxyStorage implements IProxy {
     let current_length = 0;
     let expected_length;
 
-    stream.abort = () => {};
+    (stream: any).abort = () => {};
     const readStream = this.request({
       uri_full: url,
       encoding: null,

src/lib/utils.js

@@ -253,7 +253,7 @@ function parse_address(urlAddress: any) {
  * Function filters out bad semver versions and sorts the array.
  * @return {Array} sorted Array
  */
-function semverSort(listVersions: Array<string>) {
+function semverSort(listVersions: Array<string>): string[] {
   return listVersions.filter(function(x) {
       if (!semver.parse(x, true)) {
         Logger.logger.warn( {ver: x}, 'ignoring bad version @{ver}' );
@@ -409,7 +409,7 @@ function fileExists(path: string) {
   }
 }
 
-function sortByName(packages: Array<any>) {
+function sortByName(packages: Array<any>): string[] {
   return packages.sort(function(a, b) {
     if (a.name < b.name) {
       return -1;

test/flow/plugins/auth/example.auth.plugin.js

@@ -0,0 +1,96 @@
+// @flow
+
+// this file is not aim to be tested, just to check flow definitions
+
+import Config from '../../../../src/lib/config';
+import LoggerApi from '../../../../src/lib/logger';
+
+import type {
+	Config as AppConfig,
+	PackageAccess,
+	IPluginAuth,
+	RemoteUser,
+	Logger,
+	PluginOptions
+	} from '@verdaccio/types';
+
+class ExampleAuthPlugin implements IPluginAuth {
+	config: AppConfig;
+	logger: Logger;
+
+	constructor(config: AppConfig, options: PluginOptions) {
+			this.config = config;
+			this.logger = options.logger;
+	}
+
+	adduser(user: string, password: string, cb: verdaccio$Callback): void {
+		cb();
+	}
+
+	authenticate(user: string, password: string, cb: verdaccio$Callback): void {
+		cb();
+	}
+
+  allow_access(user: RemoteUser, pkg: PackageAccess, cb: verdaccio$Callback): void {
+		cb();
+	}
+
+  allow_publish(user: RemoteUser, pkg: PackageAccess, cb: verdaccio$Callback): void {
+		cb();
+	}
+}
+
+type SubTypePackageAccess = PackageAccess & {
+	sub?: boolean
+}
+
+class ExampleAuthCustomPlugin implements IPluginAuth {
+	config: AppConfig;
+	logger: Logger;
+
+	constructor(config: AppConfig, options: PluginOptions) {
+			this.config = config;
+			this.logger = options.logger;
+	}
+
+	adduser(user: string, password: string, cb: verdaccio$Callback): void {
+		cb();
+	}
+
+	authenticate(user: string, password: string, cb: verdaccio$Callback): void {
+		cb();
+	}
+
+  allow_access(user: RemoteUser, pkg: SubTypePackageAccess, cb: verdaccio$Callback): void {
+		cb();
+	}
+
+  allow_publish(user: RemoteUser, pkg: SubTypePackageAccess, cb: verdaccio$Callback): void {
+		cb();
+	}
+}
+
+const config1: AppConfig = new Config({
+	storage: './storage',
+	self_path: '/home/sotrage'
+});
+
+const options: PluginOptions = {
+	config: config1,
+	logger: LoggerApi.logger.child()
+}
+
+const auth = new ExampleAuthPlugin(config1, options);
+const authSub = new ExampleAuthCustomPlugin(config1, options);
+const remoteUser: RemoteUser = {
+	groups: [],
+	real_groups: [],
+	name: 'test'
+};
+
+auth.authenticate('user', 'pass', () => {});
+auth.allow_access(remoteUser, {}, () => {});
+auth.allow_publish(remoteUser, {}, () => {});
+authSub.authenticate('user', 'pass', () => {});
+authSub.allow_access(remoteUser, {sub: true}, () => {});
+authSub.allow_publish(remoteUser, {sub: true}, () => {});

test/flow/plugins/middleware/example.middleware.plugin.js

@@ -0,0 +1,50 @@
+// @flow
+
+// this file is not aim to be tested, just to check flow definitions
+import Config from '../../../../src/lib/config';
+import {generatePackageTemplate} from '../../../../src/lib/storage-utils';
+import {readFile} from '../../../functional/lib/test.utils';
+
+const readMetadata = (fileName: string = 'metadata') => readFile(`../../unit/partials/${fileName}`);
+
+import type {
+	Config as AppConfig,
+	IPluginMiddleware,
+	IStorageManager,
+	RemoteUser,
+	IBasicAuth,
+} from '@verdaccio/types';
+import type { IUploadTarball, IReadTarball } from '@verdaccio/streams';
+
+export default class ExampleMiddlewarePlugin implements IPluginMiddleware {
+	register_middlewares(app: any, auth: IBasicAuth, storage: IStorageManager): void {
+		const remoteUser: RemoteUser = {
+			groups: [],
+			real_groups: [],
+			name: 'test'
+		};
+		auth.authenticate('user', 'password', () => {});
+		auth.allow_access('packageName', remoteUser, () => {});
+		auth.add_user('user', 'password', () => {});
+		auth.aesEncrypt(new Buffer('pass'));
+		// storage
+		storage.addPackage('name', generatePackageTemplate('test'), () => {});
+		storage.addVersion('name', 'version', readMetadata(), 'tag', () => {});
+		storage.mergeTags('name', {'latest': '1.0.0'}, () => {});
+		storage.changePackage('name', readMetadata(), 'revision', () => {});
+		storage.removePackage('name', () => {});
+		storage.mergeTags('name', {'latest': '1.0.0'}, () => {});
+		storage.removeTarball('name', 'filename', 'revision', () => {});
+		/* eslint no-unused-vars: 0 */
+		const config1: AppConfig = new Config({
+			storage: './storage',
+			self_path: '/home/sotrage'
+		});
+		const add: IUploadTarball = storage.addTarball('name', 'filename');
+		storage.getTarball('name', 'filename');
+		const read: IReadTarball = storage.getTarball('name', 'filename');
+		const search: IReadTarball = storage.search('test');
+		/* eslint no-unused-vars: 0 */
+	}
+}
+

test/flow/plugins/storage/example.storage.plugin.js

@@ -0,0 +1,139 @@
+// @flow
+
+// this file is not aim to be tested, just to check flow definitions
+
+import Config from '../../../../src/lib/config';
+import LoggerApi from '../../../../src/lib/logger';
+import {generatePackageTemplate} from '../../../../src/lib/storage-utils';
+import { UploadTarball, ReadTarball } from '@verdaccio/streams';
+
+import type {
+	Callback,
+	Config as AppConfig,
+	Logger,
+	Package,
+	// PluginOptions
+} from '@verdaccio/types';
+
+import type {
+	IPluginStorage,
+	IPackageStorageManager,
+	IPackageStorage
+} from '@verdaccio/local-storage';
+import type { IUploadTarball, IReadTarball } from '@verdaccio/streams';
+
+class PackageStorage implements IPackageStorageManager {
+	path: string;
+	logger: Logger;
+
+	constructor(path: string, logger: Logger) {
+		this.path = path;
+		this.logger = logger;
+	}
+
+	updatePackage(name: string, updateHandler: Callback,
+		onWrite: Callback,
+		transformPackage: Function,
+		onEnd: Callback) {
+		onEnd();
+	}
+
+	deletePackage(fileName: string, callback: Callback) {
+		callback();
+	}
+
+	removePackage(callback: Callback): void {
+		callback();
+	}
+
+	createPackage(name: string, value: Package, cb: Callback) {
+		cb();
+	}
+
+	savePackage(name: string, value: Package, cb: Callback) {
+		cb();
+	}
+
+	readPackage(name: string, cb: Callback) {
+		cb();
+	}
+
+	writeTarball(name: string): IUploadTarball {
+		const uploadStream = new UploadTarball();
+
+		return uploadStream;
+	}
+
+	readTarball(name: string): IReadTarball {
+		const readTarballStream: IReadTarball = new ReadTarball();
+
+		return readTarballStream;
+	}
+}
+
+class ExampleStoragePlugin implements IPluginStorage {
+	logger: Logger;
+	config: AppConfig;
+
+	constructor(config: AppConfig, logger: Logger) {
+    this.config = config;
+    this.logger = logger;
+  }
+
+	getSecret(): Promise<any> {
+		return Promise.resolve();
+	}
+
+	setSecret(secret: string): Promise<any> {
+		return Promise.resolve();
+	}
+
+	add(name: string, cb: Callback) {
+		cb();
+	}
+
+	remove(name: string, cb: Callback) {
+		cb();
+	}
+
+	get(cb: Callback) {
+		cb();
+	}
+
+	getPackageStorage(packageInfo: string): IPackageStorage {
+		return new PackageStorage(packageInfo, this.logger);
+	}
+
+	search(onPackage: Callback, onEnd: Callback, validateName: any): void {
+		onPackage(onEnd());
+	}
+}
+
+export default ExampleStoragePlugin;
+
+const config1: AppConfig = new Config({
+	storage: './storage',
+	self_path: '/home/sotrage'
+});
+
+
+const storage = new ExampleStoragePlugin(config1, LoggerApi.logger.child());
+
+storage.add('test', () => {});
+storage.remove('test', () => {});
+storage.getSecret().then(() => {});
+storage.setSecret('newSecret').then(() => {});
+storage.search(() => {}, () => {}, 'validateName');
+storage.get(() => {});
+
+const storageManager: IPackageStorage = storage.getPackageStorage('test');
+
+if (storageManager) {
+	storageManager.createPackage('test', generatePackageTemplate('test'), () => {});
+	storageManager.savePackage('fileName', generatePackageTemplate('test'), () => {});
+	storageManager.updatePackage('pkgFileName', () =>{}, () => {}, () => {}, () => {});
+	storageManager.deletePackage('test', () => {});
+	storageManager.removePackage(() => {});
+	storageManager.readPackage('test', () => {});
+	storageManager.writeTarball('test');
+}

test/unit/api/plugin_loader.spec.js

@@ -1,5 +1,5 @@
 import path from 'path';
-import {loadPlugin} from '../../../src/lib/plugin-loader';
+import loadPlugin from '../../../src/lib/plugin-loader';
 import logger from '../../../src/lib/logger';
 
 logger.setup([]);

test/unit/partials/plugin/authenticate.js

@@ -1,7 +1,7 @@
 
 module.exports = function ( ) {
   return {
-    authenticate ( user, pass, callback ) {
+    authenticate( user, pass, callback ) {
       /* user and pass are used here to forward errors
       and success types respectively for testing purposes */
       callback(user, pass);

types/index.js

@@ -1,36 +1,76 @@
 // @flow
 
 import type {
+  IBasicAuth,
+  IBasicStorage,
+  IStorageManager,
   UpLinkConf,
   Callback,
   Versions,
   Version,
-  MergeTags,
   Config,
   Logger,
   PackageAccess,
+  StringValue as verdaccio$StringValue,
   Package} from '@verdaccio/types';
 import type {
-  IUploadTarball,
   IReadTarball,
 } from '@verdaccio/streams';
 import type {ILocalData} from '@verdaccio/local-storage';
 import type {NextFunction, $Request, $Response} from 'request';
 
-export type StringValue = string | void | null;
+export type StringValue = verdaccio$StringValue;
 
-export interface IAuth {
-  config: Config;
-  logger: Logger;
-  secret: string;
-  plugins: Array<any>;
-  aesEncrypt(buf: Buffer): Buffer;
+export type StartUpConfig = {
+  storage: string;
+  self_path: string;
+}
+
+export type MatchedPackage = PackageAccess | void;
+
+export type JWTPayload = {
+  user: string;
+  group: string | void;
+}
+
+export type JWTSignOptions = {
+  expiresIn: string;
+}
+
+export type ProxyList = {
+  [key: string]: IProxy;
+}
+
+export type Utils = {
+  ErrorCode: any;
+  getLatestVersion: Callback;
+  isObject: (value: any) => boolean;
+  validate_name: (value: any) => boolean;
+  tag_version: (value: any, version: string, tag: string) => void;
+  normalizeDistTags: (pkg: Package) => void;
+  semverSort: (keys: Array<string>) => Array<string>;
+}
+
+export type $RequestExtend = $Request & {remote_user?: any}
+export type $ResponseExtend = $Response & {cookies?: any}
+export type $NextFunctionVer = NextFunction & mixed;
+export type $SidebarPackage = Package & {latest: mixed}
+
+
+interface IAuthWebUI {
+  issueUIjwt(user: string, time: string): string;
+}
+
+interface IAuthMiddleware {
   apiJWTmiddleware(): $NextFunctionVer;
   webUIJWTmiddleware(): $NextFunctionVer;
-  authenticate(user: string, password: string, cb: Callback): void;
-  allow_access(packageName: string, user: string, callback: Callback): void;
-  issueUIjwt(user: string, time: string): string;
-  add_user(user: string, password: string, cb: Callback): any;
+}
+
+export interface IAuth extends IBasicAuth, IAuthMiddleware, IAuthWebUI {
+  config: verdaccio$Config;
+  logger: verdaccio$Logger;
+  secret: string;
+  plugins: Array<any>;
 }
 
 export interface IWebSearch {
@@ -61,76 +101,15 @@ export interface IProxy {
   getRemoteMetadata(name: string, options: any, callback: Callback): void;
 }
 
-export type ProxyList = {
-  [key: string]: IProxy;
-}
-
-export type Utils = {
-  ErrorCode: any;
-  getLatestVersion: Callback;
-  isObject: (value: any) => boolean;
-  validate_name: (value: any) => boolean;
-  tag_version: (value: any, version: string, tag: string) => void;
-  normalizeDistTags: (pkg: Package) => void;
-  semverSort: (keys: Array<string>) => Array<string>;
-}
-
-export interface IStorageHandler {
-  config: Config;
-  localStorage: IStorage;
-  logger: Logger;
-  uplinks: ProxyList;
-  addPackage(name: string, metadata: any, callback: Function): Promise<any>;
-  init(config: Config): Promise<any>;
-  addVersion(name: string, version: string, metadata: Version, tag: StringValue, callback: Callback): void;
-  mergeTags(name: string, tagHash: MergeTags, callback: Callback): void;
-  changePackage(name: string, metadata: Package, revision: string, callback: Callback): void;
-  removePackage(name: string, callback: Callback): void;
-  removeTarball(name: string, filename: string, revision: string, callback: Callback): void;
-  addTarball(name: string, filename: string): IUploadTarball;
-  getTarball(name: string, filename: string): IReadTarball;
-  getPackage(options: any): void;
-  search(startkey: string, options: any): void;
-  getLocalDatabase(callback: Callback): void;
-  _syncUplinksMetadata(name: string, packageInfo: Package, options: any, callback: Callback): void;
-  _updateVersionsHiddenUpLink(versions: Versions, upLink: IProxy): void;
-}
-
-export type StartUpConfig = {
-  storage: string;
-  self_path: string;
-}
-
-export type MatchedPackage = PackageAccess | void;
-
-export interface IStorage {
+export interface IStorage extends IBasicStorage {
   config: Config;
   localData: ILocalData;
   logger: Logger;
-  addPackage(name: string, info: Package, callback: Callback): void;
-  removePackage(name: string, callback: Callback): void;
-  updateVersions(name: string, packageInfo: Package, callback: Callback): void;
-  addVersion(name: string, version: string, metadata: Version, tag: StringValue, callback: Callback): void;
-  mergeTags(name: string, tags: MergeTags, callback: Callback): void;
-  changePackage(name: string, metadata: Package, revision: string, callback: Callback): void;
-  removeTarball(name: string, filename: string, revision: string, callback: Callback): void;
-  addTarball(name: string, filename: string): IUploadTarball;
-  getTarball(name: string, filename: string): IReadTarball;
-  getPackageMetadata(name: string, callback: Callback): void;
-  search(startKey: string, options: any): IUploadTarball;
-  getSecret(config: Config): Promise<any>;
 }
 
-export type JWTPayload = {
-  user: string;
-  group: string | void;
+export interface IStorageHandler extends IStorageManager {
+  localStorage: IStorage;
+  uplinks: ProxyList;
+  _syncUplinksMetadata(name: string, packageInfo: Package, options: any, callback: Callback): void;
+  _updateVersionsHiddenUpLink(versions: Versions, upLink: IProxy): void;
 }
-
-export type JWTSignOptions = {
-  expiresIn: string;
-}
-
-export type $RequestExtend = $Request & {remote_user?: any}
-export type $ResponseExtend = $Response & {cookies?: any}
-export type $NextFunctionVer = NextFunction & mixed;
-export type $SidebarPackage = Package & {latest: mixed}

yarn.lock

@@ -219,9 +219,9 @@
     lockfile "1.0.3"
     lodash "4.17.10"
 
-"@verdaccio/local-storage@1.1.2":
-  version "1.1.2"
-  resolved "https://registry.npmjs.org/@verdaccio/local-storage/-/local-storage-1.1.2.tgz#938f1da741d148db020bbe68bfb21e86d38e3177"
+"@verdaccio/local-storage@1.1.3":
+  version "1.1.3"
+  resolved "https://registry.npmjs.org/@verdaccio/local-storage/-/local-storage-1.1.3.tgz#2c1e5b830f69a6ade5a855aea581f3ba96a37cfd"
   dependencies:
     "@verdaccio/file-locking" "0.0.7"
     "@verdaccio/streams" "1.0.0"
@@ -234,9 +234,9 @@
   version "1.0.0"
   resolved "https://registry.npmjs.org/@verdaccio/streams/-/streams-1.0.0.tgz#d5d24c6747208728b9fd16b908e3932c3fb1f864"
 
-"@verdaccio/types@3.0.1":
-  version "3.0.1"
-  resolved "https://registry.npmjs.org/@verdaccio/types/-/types-3.0.1.tgz#8cdfd74a8a070ad797a056652f257f9ead3717f9"
+"@verdaccio/types@3.4.1":
+  version "3.4.1"
+  resolved "https://registry.npmjs.org/@verdaccio/types/-/types-3.4.1.tgz#be18fb695bcd014c94c89b7805ace36dc9da2636"
 
 "@webassemblyjs/ast@1.5.9":
   version "1.5.9"
@@ -3833,9 +3833,9 @@ flatten@^1.0.2:
   version "1.0.2"
   resolved "https://registry.npmjs.org/flatten/-/flatten-1.0.2.tgz#dae46a9d78fbe25292258cc1e780a41d95c03782"
 
-flow-bin@0.69.0:
-  version "0.69.0"
-  resolved "https://registry.npmjs.org/flow-bin/-/flow-bin-0.69.0.tgz#053159a684a6051fcbf0b71a2eb19a9679082da6"
+flow-bin@0.76.0:
+  version "0.76.0"
+  resolved "https://registry.npmjs.org/flow-bin/-/flow-bin-0.76.0.tgz#eb00036991c3abc106743fcbc7ee321f02aa4faa"
 
 flow-config-parser@^0.3.0:
   version "0.3.0"