feat: support for an IPluginStorageFilter (#58)

feat: support for an IPluginStorageFilter @mlucool

Author: mlucool

core/types/index.d.ts

@@ -339,6 +339,7 @@ type StringValue = string | void | null;
 		max_body_size?: string;
 		notifications?: Notifications;
 		middlewares?: any;
+		storage_filters?: any;
 		checkSecretKey(token: string): string;
 		getMatchedPackagesSpec(storage: string): PackageAccess | void;
 		[key: string]: any;
@@ -388,7 +389,7 @@ type StringValue = string | void | null;
 	interface IStorageManager<T> extends StoragePackageActions {
 		config: T & Config;
 		logger: Logger;
-		init(config: T & Config): Promise<any>;
+		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;
@@ -418,6 +419,8 @@ type StringValue = string | void | null;
 
 	interface IPlugin<T> {
 		version?: string;
+		// In case a plugin needs to be cleaned up/removed
+		close?(): void;
 	}
 
 	type PluginOptions<T> = {
@@ -437,4 +440,8 @@ type StringValue = string | void | null;
 	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, cb: Callback): void;
+	}
 }

core/types/src/flow/types.js

@@ -1,5 +1,7 @@
 /* @flow */
 
+import {Callback, IBasicAuth, IPlugin, IStorageManager, Package} from '@verdaccio/types';
+
 declare type verdaccio$StringValue = string | void | null;
 
 declare type verdaccio$Callback = Function;
@@ -330,6 +332,7 @@ declare interface verdaccio$Config {
   max_body_size?: string;
   notifications?: verdaccio$Notifications;
   middlewares?: any;
+  storage_filters?: any;
   checkSecretKey(token: string): string;
   getMatchedPackagesSpec(storage: string): verdaccio$PackageAccess | void;
   [key: string]: any;
@@ -380,7 +383,7 @@ declare interface verdaccio$StoragePackageActions extends verdaccio$TarballActio
 declare interface verdaccio$IStorageManager extends verdaccio$StoragePackageActions {
   config: $Subtype<verdaccio$Config>;
   logger: verdaccio$Logger;
-  init(config: $Subtype<verdaccio$Config>): Promise<any>;
+  init(config: $Subtype<verdaccio$Config>, filters: any): Promise<any>;
   addPackage(name: string, metadata: any, callback: verdaccio$Callback): Promise<any>;
   getPackage(options: any): void;
   search(startkey: string, options: any): verdaccio$IReadTarball;
@@ -406,6 +409,7 @@ declare interface verdaccio$IBasicAuth {
 
 declare interface verdaccio$IPlugin {
   version?: string;
+  close(): void;
 }
 
 declare type verdaccio$PluginOptions = {
@@ -426,6 +430,10 @@ declare interface verdaccio$IPluginMiddleware extends verdaccio$IPlugin {
   register_middlewares(app: any, auth: verdaccio$IBasicAuth, storage: verdaccio$IStorageManager): void;
 }
 
+declare interface verdaccio$IPluginStorageFilter extends verdaccio$IPlugin {
+  filter_metadata(packageInfo: verdaccio$Package, cb: verdaccio$Callback): void;
+}
+
 declare module "@verdaccio/local-storage" {
   declare export type ILocalData =  verdaccio$ILocalData;
   declare export type IPluginStorage =  verdaccio$ILocalData;
@@ -470,6 +478,7 @@ declare module "@verdaccio/types" {
   declare export type IBasicAuth = verdaccio$IBasicAuth;
   declare export type IPluginAuth = verdaccio$IPluginAuth;
   declare export type IPluginMiddleware = verdaccio$IPluginMiddleware;
+  declare export type IPluginStorageFilter = verdaccio$IPluginStorageFilter;
   declare export type PluginOptions = verdaccio$PluginOptions;
   declare export type Stdout = stream$Writable | tty$WriteStream;
   declare export type Stdin = stream$Readable | tty$ReadStream;