@verdaccio/core 6.0.0-6-next.48 → 6.0.0-6-next.50

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @verdaccio/core
 
+## 6.0.0-6-next.50
+
+## 6.0.0-6-next.49
+
 ## 6.0.0-6-next.48
 
 ### Minor Changes

package/build/plugin-utils.d.ts

@@ -1,21 +1,137 @@
-import { Config, IPackageStorage, Token, TokenFilter } from '@verdaccio/types';
-import { searchUtils } from '.';
-interface IPlugin {
-    version?: string;
-    close?(): void;
-}
-export interface IPluginStorage<T> extends IPlugin {
-    config: T & Config;
+/// <reference types="node" />
+import { Express, RequestHandler } from 'express';
+import { Readable, Writable } from 'stream';
+import { AllowAccess, Callback, Config, Logger, Manifest, PackageAccess, RemoteUser, Token, TokenFilter } from '@verdaccio/types';
+import { VerdaccioError, searchUtils } from '.';
+export interface AuthPluginPackage {
+    packageName: string;
+    packageVersion?: string;
+    tag?: string;
+}
+export interface PluginOptions {
+    config: Config;
+    logger: Logger;
+}
+/**
+ * The base plugin class, set of utilities for developing
+ * plugins.
+ * @alpha
+ * */
+export declare class Plugin<PluginConfig> {
+    static version: number;
+    readonly version: number;
+    readonly config: PluginConfig | unknown;
+    readonly options: PluginOptions;
+    constructor(config: PluginConfig, options: PluginOptions);
+    getVersion(): number;
+}
+export interface StorageHandler {
+    logger: Logger;
+    deletePackage(fileName: string): Promise<void>;
+    removePackage(): Promise<void>;
+    updatePackage(packageName: string, handleUpdate: (manifest: Manifest) => Promise<Manifest>): Promise<Manifest>;
+    readPackage(name: string): Promise<Manifest>;
+    savePackage(pkgName: string, value: Manifest): Promise<void>;
+    readTarball(pkgName: string, { signal }: {
+        signal: AbortSignal;
+    }): Promise<Readable>;
+    createPackage(name: string, manifest: Manifest): Promise<void>;
+    writeTarball(tarballName: string, { signal }: {
+        signal: AbortSignal;
+    }): Promise<Writable>;
+    hasTarball(fileName: string): Promise<boolean>;
+    hasPackage(): Promise<boolean>;
+}
+export interface Storage<PluginConfig> extends Plugin<PluginConfig> {
     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;
+    getPackageStorage(packageInfo: string): StorageHandler;
     search(query: searchUtils.SearchQuery): Promise<searchUtils.SearchItem[]>;
     saveToken(token: Token): Promise<any>;
     deleteToken(user: string, tokenKey: string): Promise<any>;
     readTokens(filter: TokenFilter): Promise<Token[]>;
 }
-export {};
+/**
+ * This function allow add additional middleware to the application.
+ *
+ *  ```ts
+ *  import express, { Request, Response } from 'express';
+ *
+ *  class Middleware extends Plugin {
+ *    // instances of auth and storage are injected
+ *    register_middlewares(app, auth, storage) {
+ *      const router = express.Router();
+ *      router.post('/my-endpoint', (req: Request, res: Response): void => {
+        res.status(200).end();
+      });
+ *    }
+ *  }
+ *
+ *
+ *  const [plugin] = await asyncLoadPlugin(...);
+ *  plugin.register_middlewares(app, auth, storage);
+ *  ```
+ */
+export interface ExpressMiddleware<PluginConfig, Storage, Auth> extends Plugin<PluginConfig> {
+    register_middlewares(app: Express, auth: Auth, storage: Storage): void;
+}
+/**
+ * dasdsa
+ */
+export declare type AuthCallback = (error: VerdaccioError | null, groups?: string[] | false) => void;
+export declare type AuthAccessCallback = (error: VerdaccioError | null, access?: boolean) => void;
+export declare type AuthUserCallback = (error: VerdaccioError | null, access?: boolean | string) => void;
+export declare type AuthChangePasswordCallback = (error: VerdaccioError | null, access?: boolean) => void;
+export declare type AccessCallback = (error: VerdaccioError | null, ok?: boolean) => void;
+export interface Auth<T> extends Plugin<T> {
+    /**
+     * Handles the authenticated method.
+     * ```ts
+     *  class Auth {
+        public authenticate(user: string, password: string, done: AuthCallback): void {
+          if (!password) {
+            return done(errorUtils.getUnauthorized(API_ERROR.BAD_USERNAME_PASSWORD));
+          }
+          // always return an array of users
+          return done(null, [user]);
+     *  }
+     * ```
+     */
+    authenticate(user: string, password: string, cb: AuthCallback): void;
+    /**
+     * Handles the authenticated method.
+     * ```ts
+     *  class Auth {
+        public adduser(user: string, password: string, done: AuthCallback): void {
+          if (!password) {
+            return done(errorUtils.getUnauthorized(API_ERROR.BAD_USERNAME_PASSWORD));
+          }
+          // return boolean
+          return done(null, true);
+     *  }
+     * ```
+     */
+    adduser?(user: string, password: string, cb: AuthUserCallback): void;
+    changePassword?(user: string, password: string, newPassword: string, cb: AuthChangePasswordCallback): void;
+    allow_publish?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;
+    allow_publish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
+    allow_access?(user: RemoteUser, pkg: T & PackageAccess, cb: AccessCallback): void;
+    allow_access?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AccessCallback): void;
+    allow_unpublish?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;
+    allow_unpublish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
+    apiJWTmiddleware?(helpers: any): RequestHandler;
+}
+export interface IBasicAuth {
+    authenticate(user: string, password: string, cb: Callback): void;
+    invalidateToken?(token: string): Promise<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;
+}
+export interface ManifestFilter<T> extends Plugin<T> {
+    filterMetadata(packageInfo: Manifest): Promise<Manifest>;
+}

package/build/plugin-utils.js

@@ -3,4 +3,27 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.Plugin = void 0;
+
+/**
+ * The base plugin class, set of utilities for developing
+ * plugins.
+ * @alpha
+ * */
+class Plugin {
+  static version = 1;
+
+  constructor(config, options) {
+    this.version = Plugin.version;
+    this.config = config;
+    this.options = options;
+  }
+
+  getVersion() {
+    return this.version;
+  }
+
+}
+
+exports.Plugin = Plugin;
 //# sourceMappingURL=plugin-utils.js.map

package/build/plugin-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin-utils.js","names":[],"sources":["../src/plugin-utils.ts"],"sourcesContent":["import { Config, IPackageStorage, Token, TokenFilter } from '@verdaccio/types';\n\nimport { searchUtils } from '.';\n\ninterface IPlugin {\n  version?: string;\n  // In case a plugin needs to be cleaned up/removed\n  close?(): void;\n}\n\nexport interface IPluginStorage<T> extends IPlugin {\n  config: T & Config;\n  add(name: string): Promise<void>;\n  remove(name: string): Promise<void>;\n  get(): Promise<any>;\n  init(): Promise<void>;\n  getSecret(): Promise<string>;\n  setSecret(secret: string): Promise<any>;\n  getPackageStorage(packageInfo: string): IPackageStorage;\n  search(query: searchUtils.SearchQuery): Promise<searchUtils.SearchItem[]>;\n  saveToken(token: Token): Promise<any>;\n  deleteToken(user: string, tokenKey: string): Promise<any>;\n  readTokens(filter: TokenFilter): Promise<Token[]>;\n}\n"],"mappings":""}
+{"version":3,"file":"plugin-utils.js","names":["Plugin","version","constructor","config","options","getVersion"],"sources":["../src/plugin-utils.ts"],"sourcesContent":["import { Express, RequestHandler } from 'express';\nimport { Readable, Writable } from 'stream';\n\nimport {\n  AllowAccess,\n  Callback,\n  Config,\n  Logger,\n  Manifest,\n  PackageAccess,\n  RemoteUser,\n  Token,\n  TokenFilter,\n} from '@verdaccio/types';\n\nimport { VerdaccioError, searchUtils } from '.';\n\nexport interface AuthPluginPackage {\n  packageName: string;\n  packageVersion?: string;\n  tag?: string;\n}\nexport interface PluginOptions {\n  config: Config;\n  logger: Logger;\n}\n\n/**\n * The base plugin class, set of utilities for developing\n * plugins.\n * @alpha\n * */\nexport class Plugin<PluginConfig> {\n  static version = 1;\n  public readonly version: number;\n  public readonly config: PluginConfig | unknown;\n  public readonly options: PluginOptions;\n  public constructor(config: PluginConfig, options: PluginOptions) {\n    this.version = Plugin.version;\n    this.config = config;\n    this.options = options;\n  }\n\n  public getVersion() {\n    return this.version;\n  }\n}\nexport interface StorageHandler {\n  logger: Logger;\n  deletePackage(fileName: string): Promise<void>;\n  removePackage(): Promise<void>;\n  //  next packages migration (this list is meant to replace the callback parent functions)\n  updatePackage(\n    packageName: string,\n    handleUpdate: (manifest: Manifest) => Promise<Manifest>\n  ): Promise<Manifest>;\n  readPackage(name: string): Promise<Manifest>;\n  savePackage(pkgName: string, value: Manifest): Promise<void>;\n  readTarball(pkgName: string, { signal }: { signal: AbortSignal }): Promise<Readable>;\n  createPackage(name: string, manifest: Manifest): Promise<void>;\n  writeTarball(tarballName: string, { signal }: { signal: AbortSignal }): Promise<Writable>;\n  // verify if tarball exist in the storage\n  hasTarball(fileName: string): Promise<boolean>;\n  // verify if package exist in the storage\n  hasPackage(): Promise<boolean>;\n}\n\nexport interface Storage<PluginConfig> extends Plugin<PluginConfig> {\n  add(name: string): Promise<void>;\n  remove(name: string): Promise<void>;\n  get(): Promise<any>;\n  init(): Promise<void>;\n  getSecret(): Promise<string>;\n  setSecret(secret: string): Promise<any>;\n  getPackageStorage(packageInfo: string): StorageHandler;\n  search(query: searchUtils.SearchQuery): Promise<searchUtils.SearchItem[]>;\n  saveToken(token: Token): Promise<any>;\n  deleteToken(user: string, tokenKey: string): Promise<any>;\n  readTokens(filter: TokenFilter): Promise<Token[]>;\n}\n\n/**\n * This function allow add additional middleware to the application.\n *\n *  ```ts\n *  import express, { Request, Response } from 'express';\n * \n *  class Middleware extends Plugin {\n *    // instances of auth and storage are injected\n *    register_middlewares(app, auth, storage) {\n *      const router = express.Router();\n *      router.post('/my-endpoint', (req: Request, res: Response): void => {\n        res.status(200).end();\n      });\n *    }\n *  }\n * \n *  \n *  const [plugin] = await asyncLoadPlugin(...);\n *  plugin.register_middlewares(app, auth, storage);\n *  ```\n */\nexport interface ExpressMiddleware<PluginConfig, Storage, Auth> extends Plugin<PluginConfig> {\n  register_middlewares(app: Express, auth: Auth, storage: Storage): void;\n}\n\n/**\n * dasdsa\n */\nexport type AuthCallback = (error: VerdaccioError | null, groups?: string[] | false) => void;\n\nexport type AuthAccessCallback = (error: VerdaccioError | null, access?: boolean) => void;\nexport type AuthUserCallback = (error: VerdaccioError | null, access?: boolean | string) => void;\nexport type AuthChangePasswordCallback = (error: VerdaccioError | null, access?: boolean) => void;\nexport type AccessCallback = (error: VerdaccioError | null, ok?: boolean) => void;\nexport interface Auth<T> extends Plugin<T> {\n  /**\n   * Handles the authenticated method.\n   * ```ts\n   *  class Auth {\n      public authenticate(user: string, password: string, done: AuthCallback): void {\n        if (!password) {\n          return done(errorUtils.getUnauthorized(API_ERROR.BAD_USERNAME_PASSWORD));\n        }\n        // always return an array of users\n        return done(null, [user]);      \n   *  }\n   * ```\n   */\n  authenticate(user: string, password: string, cb: AuthCallback): void;\n  /**\n   * Handles the authenticated method.\n   * ```ts\n   *  class Auth {\n      public adduser(user: string, password: string, done: AuthCallback): void {\n        if (!password) {\n          return done(errorUtils.getUnauthorized(API_ERROR.BAD_USERNAME_PASSWORD));\n        }\n        // return boolean\n        return done(null, true);      \n   *  }\n   * ```\n   */\n  adduser?(user: string, password: string, cb: AuthUserCallback): void;\n  changePassword?(\n    user: string,\n    password: string,\n    newPassword: string,\n    cb: AuthChangePasswordCallback\n  ): void;\n  allow_publish?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;\n  allow_publish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;\n  allow_access?(user: RemoteUser, pkg: T & PackageAccess, cb: AccessCallback): void;\n  allow_access?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AccessCallback): void;\n  allow_unpublish?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;\n  allow_unpublish?(\n    user: RemoteUser,\n    pkg: AllowAccess & PackageAccess,\n    cb: AuthAccessCallback\n  ): void;\n  apiJWTmiddleware?(helpers: any): RequestHandler;\n}\n\nexport interface IBasicAuth {\n  authenticate(user: string, password: string, cb: Callback): void;\n  invalidateToken?(token: string): Promise<void>;\n  changePassword(user: string, password: string, newPassword: string, cb: Callback): void;\n  allow_access(pkg: AuthPluginPackage, user: RemoteUser, callback: Callback): void;\n  add_user(user: string, password: string, cb: Callback): any;\n}\n\nexport interface ManifestFilter<T> extends Plugin<T> {\n  filterMetadata(packageInfo: Manifest): Promise<Manifest>;\n}\n"],"mappings":";;;;;;;AA2BA;AACA;AACA;AACA;AACA;AACO,MAAMA,MAAN,CAA2B;EAClB,OAAPC,OAAO,GAAG,CAAH;;EAIPC,WAAW,CAACC,MAAD,EAAuBC,OAAvB,EAA+C;IAC/D,KAAKH,OAAL,GAAeD,MAAM,CAACC,OAAtB;IACA,KAAKE,MAAL,GAAcA,MAAd;IACA,KAAKC,OAAL,GAAeA,OAAf;EACD;;EAEMC,UAAU,GAAG;IAClB,OAAO,KAAKJ,OAAZ;EACD;;AAb+B"}

package/build/stream-utils.d.ts

@@ -1,45 +1,11 @@
 /// <reference types="node" />
-import { PassThrough, Transform, TransformOptions } from 'stream';
-export interface IReadTarball {
-    abort?: () => void;
-}
-export interface IUploadTarball {
-    done?: () => void;
-    abort?: () => void;
-}
-/**
- * This stream is used to read tarballs from repository.
- * @param {*} options
- * @return {Stream}
- */
-declare class ReadTarball extends PassThrough implements IReadTarball {
-    /**
-     *
-     * @param {Object} options
-     */
-    constructor(options: TransformOptions);
-    abort(): void;
-}
-/**
- * This stream is used to upload tarballs to a repository.
- * @param {*} options
- * @return {Stream}
- */
-declare class UploadTarball extends PassThrough implements IUploadTarball {
-    /**
-     *
-     * @param {Object} options
-     */
-    constructor(options: any);
-    abort(): void;
-    done(): void;
-}
+import { Readable, Transform } from 'stream';
 /**
  * Converts a buffer stream to a string.
  */
-declare const readableToString: (stream: any) => Promise<string>;
+declare const readableToString: (stream: Readable) => Promise<string>;
 /**
  * Transform stream object  mode to string
  **/
 declare const transformObjectToString: () => Transform;
-export { ReadTarball, UploadTarball, readableToString, transformObjectToString };
+export { readableToString, transformObjectToString };

package/build/stream-utils.js

@@ -3,91 +3,13 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.transformObjectToString = exports.readableToString = exports.UploadTarball = exports.ReadTarball = void 0;
+exports.transformObjectToString = exports.readableToString = void 0;
 
 var _stream = require("stream");
 
-/**
- * This stream is used to read tarballs from repository.
- * @param {*} options
- * @return {Stream}
- */
-class ReadTarball extends _stream.PassThrough {
-  /**
-   *
-   * @param {Object} options
-   */
-  constructor(options) {
-    super(options); // called when data is not needed anymore
-
-    addAbstractMethods(this, 'abort');
-  }
-
-  abort() {}
-
-}
-/**
- * This stream is used to upload tarballs to a repository.
- * @param {*} options
- * @return {Stream}
- */
-
-
-exports.ReadTarball = ReadTarball;
-
-class UploadTarball extends _stream.PassThrough {
-  /**
-   *
-   * @param {Object} options
-   */
-  constructor(options) {
-    super(options); // called when user closes connection before upload finishes
-
-    addAbstractMethods(this, 'abort'); // called when upload finishes successfully
-
-    addAbstractMethods(this, 'done');
-  }
-
-  abort() {}
-
-  done() {}
-
-}
-/**
- * This function intercepts abstract calls and replays them allowing.
- * us to attach those functions after we are ready to do so
- * @param {*} self
- * @param {*} name
- */
-// Perhaps someone knows a better way to write this
-
-
-exports.UploadTarball = UploadTarball;
-
-function addAbstractMethods(self, name) {
-  self._called_methods = self._called_methods || {};
-
-  self.__defineGetter__(name, function () {
-    return function () {
-      self._called_methods[name] = true;
-    };
-  });
-
-  self.__defineSetter__(name, function (fn) {
-    delete self[name];
-    self[name] = fn; // eslint-disable-next-line @typescript-eslint/prefer-optional-chain
-
-    if (self._called_methods && self._called_methods[name]) {
-      delete self._called_methods[name];
-      self[name]();
-    }
-  });
-}
 /**
  * Converts a buffer stream to a string.
  */
-
-
 const readableToString = async stream => {
   const chunks = [];
 

package/build/stream-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"stream-utils.js","names":["ReadTarball","PassThrough","constructor","options","addAbstractMethods","abort","UploadTarball","done","self","name","_called_methods","__defineGetter__","__defineSetter__","fn","readableToString","stream","chunks","chunk","push","Buffer","from","buffer","concat","str","toString","transformObjectToString","Transform","objectMode","transform","encoding","callback","JSON","stringify"],"sources":["../src/stream-utils.ts"],"sourcesContent":["import { PassThrough, Transform, TransformOptions } from 'stream';\n\nexport interface IReadTarball {\n  abort?: () => void;\n}\n\nexport interface IUploadTarball {\n  done?: () => void;\n  abort?: () => void;\n}\n\n/**\n * This stream is used to read tarballs from repository.\n * @param {*} options\n * @return {Stream}\n */\nclass ReadTarball extends PassThrough implements IReadTarball {\n  /**\n   *\n   * @param {Object} options\n   */\n  public constructor(options: TransformOptions) {\n    super(options);\n    // called when data is not needed anymore\n    addAbstractMethods(this, 'abort');\n  }\n\n  public abort(): void {}\n}\n\n/**\n * This stream is used to upload tarballs to a repository.\n * @param {*} options\n * @return {Stream}\n */\nclass UploadTarball extends PassThrough implements IUploadTarball {\n  /**\n   *\n   * @param {Object} options\n   */\n  public constructor(options: any) {\n    super(options);\n    // called when user closes connection before upload finishes\n    addAbstractMethods(this, 'abort');\n\n    // called when upload finishes successfully\n    addAbstractMethods(this, 'done');\n  }\n\n  public abort(): void {}\n  public done(): void {}\n}\n\n/**\n * This function intercepts abstract calls and replays them allowing.\n * us to attach those functions after we are ready to do so\n * @param {*} self\n * @param {*} name\n */\n// Perhaps someone knows a better way to write this\nfunction addAbstractMethods(self: any, name: any): void {\n  self._called_methods = self._called_methods || {};\n\n  self.__defineGetter__(name, function () {\n    return function (): void {\n      self._called_methods[name] = true;\n    };\n  });\n\n  self.__defineSetter__(name, function (fn: any) {\n    delete self[name];\n\n    self[name] = fn;\n\n    // eslint-disable-next-line @typescript-eslint/prefer-optional-chain\n    if (self._called_methods && self._called_methods[name]) {\n      delete self._called_methods[name];\n\n      self[name]();\n    }\n  });\n}\n\n/**\n * Converts a buffer stream to a string.\n */\nconst readableToString = async (stream) => {\n  const chunks: Buffer[] = [];\n  for await (let chunk of stream) {\n    chunks.push(Buffer.from(chunk));\n  }\n  const buffer = Buffer.concat(chunks);\n  const str = buffer.toString('utf-8');\n  return str;\n};\n\n/**\n * Transform stream object  mode to string\n **/\nconst transformObjectToString = () => {\n  return new Transform({\n    objectMode: true,\n    transform: (chunk, encoding, callback) => {\n      callback(null, JSON.stringify(chunk));\n    },\n  });\n};\n\nexport { ReadTarball, UploadTarball, readableToString, transformObjectToString };\n"],"mappings":";;;;;;;AAAA;;AAWA;AACA;AACA;AACA;AACA;AACA,MAAMA,WAAN,SAA0BC,mBAA1B,CAA8D;EAC5D;AACF;AACA;AACA;EACSC,WAAW,CAACC,OAAD,EAA4B;IAC5C,MAAMA,OAAN,EAD4C,CAE5C;;IACAC,kBAAkB,CAAC,IAAD,EAAO,OAAP,CAAlB;EACD;;EAEMC,KAAK,GAAS,CAAE;;AAXqC;AAc9D;AACA;AACA;AACA;AACA;;;;;AACA,MAAMC,aAAN,SAA4BL,mBAA5B,CAAkE;EAChE;AACF;AACA;AACA;EACSC,WAAW,CAACC,OAAD,EAAe;IAC/B,MAAMA,OAAN,EAD+B,CAE/B;;IACAC,kBAAkB,CAAC,IAAD,EAAO,OAAP,CAAlB,CAH+B,CAK/B;;IACAA,kBAAkB,CAAC,IAAD,EAAO,MAAP,CAAlB;EACD;;EAEMC,KAAK,GAAS,CAAE;;EAChBE,IAAI,GAAS,CAAE;;AAf0C;AAkBlE;AACA;AACA;AACA;AACA;AACA;AACA;;;;;AACA,SAASH,kBAAT,CAA4BI,IAA5B,EAAuCC,IAAvC,EAAwD;EACtDD,IAAI,CAACE,eAAL,GAAuBF,IAAI,CAACE,eAAL,IAAwB,EAA/C;;EAEAF,IAAI,CAACG,gBAAL,CAAsBF,IAAtB,EAA4B,YAAY;IACtC,OAAO,YAAkB;MACvBD,IAAI,CAACE,eAAL,CAAqBD,IAArB,IAA6B,IAA7B;IACD,CAFD;EAGD,CAJD;;EAMAD,IAAI,CAACI,gBAAL,CAAsBH,IAAtB,EAA4B,UAAUI,EAAV,EAAmB;IAC7C,OAAOL,IAAI,CAACC,IAAD,CAAX;IAEAD,IAAI,CAACC,IAAD,CAAJ,GAAaI,EAAb,CAH6C,CAK7C;;IACA,IAAIL,IAAI,CAACE,eAAL,IAAwBF,IAAI,CAACE,eAAL,CAAqBD,IAArB,CAA5B,EAAwD;MACtD,OAAOD,IAAI,CAACE,eAAL,CAAqBD,IAArB,CAAP;MAEAD,IAAI,CAACC,IAAD,CAAJ;IACD;EACF,CAXD;AAYD;AAED;AACA;AACA;;;AACA,MAAMK,gBAAgB,GAAG,MAAOC,MAAP,IAAkB;EACzC,MAAMC,MAAgB,GAAG,EAAzB;;EACA,WAAW,IAAIC,KAAf,IAAwBF,MAAxB,EAAgC;IAC9BC,MAAM,CAACE,IAAP,CAAYC,MAAM,CAACC,IAAP,CAAYH,KAAZ,CAAZ;EACD;;EACD,MAAMI,MAAM,GAAGF,MAAM,CAACG,MAAP,CAAcN,MAAd,CAAf;EACA,MAAMO,GAAG,GAAGF,MAAM,CAACG,QAAP,CAAgB,OAAhB,CAAZ;EACA,OAAOD,GAAP;AACD,CARD;AAUA;AACA;AACA;;;;;AACA,MAAME,uBAAuB,GAAG,MAAM;EACpC,OAAO,IAAIC,iBAAJ,CAAc;IACnBC,UAAU,EAAE,IADO;IAEnBC,SAAS,EAAE,CAACX,KAAD,EAAQY,QAAR,EAAkBC,QAAlB,KAA+B;MACxCA,QAAQ,CAAC,IAAD,EAAOC,IAAI,CAACC,SAAL,CAAef,KAAf,CAAP,CAAR;IACD;EAJkB,CAAd,CAAP;AAMD,CAPD"}
+{"version":3,"file":"stream-utils.js","names":["readableToString","stream","chunks","chunk","push","Buffer","from","buffer","concat","str","toString","transformObjectToString","Transform","objectMode","transform","encoding","callback","JSON","stringify"],"sources":["../src/stream-utils.ts"],"sourcesContent":["import { Readable, Transform } from 'stream';\n\n/**\n * Converts a buffer stream to a string.\n */\nconst readableToString = async (stream: Readable) => {\n  const chunks: Buffer[] = [];\n  for await (let chunk of stream) {\n    chunks.push(Buffer.from(chunk));\n  }\n  const buffer = Buffer.concat(chunks);\n  const str = buffer.toString('utf-8');\n  return str;\n};\n\n/**\n * Transform stream object  mode to string\n **/\nconst transformObjectToString = () => {\n  return new Transform({\n    objectMode: true,\n    transform: (chunk, encoding, callback) => {\n      callback(null, JSON.stringify(chunk));\n    },\n  });\n};\n\nexport { readableToString, transformObjectToString };\n"],"mappings":";;;;;;;AAAA;;AAEA;AACA;AACA;AACA,MAAMA,gBAAgB,GAAG,MAAOC,MAAP,IAA4B;EACnD,MAAMC,MAAgB,GAAG,EAAzB;;EACA,WAAW,IAAIC,KAAf,IAAwBF,MAAxB,EAAgC;IAC9BC,MAAM,CAACE,IAAP,CAAYC,MAAM,CAACC,IAAP,CAAYH,KAAZ,CAAZ;EACD;;EACD,MAAMI,MAAM,GAAGF,MAAM,CAACG,MAAP,CAAcN,MAAd,CAAf;EACA,MAAMO,GAAG,GAAGF,MAAM,CAACG,QAAP,CAAgB,OAAhB,CAAZ;EACA,OAAOD,GAAP;AACD,CARD;AAUA;AACA;AACA;;;;;AACA,MAAME,uBAAuB,GAAG,MAAM;EACpC,OAAO,IAAIC,iBAAJ,CAAc;IACnBC,UAAU,EAAE,IADO;IAEnBC,SAAS,EAAE,CAACX,KAAD,EAAQY,QAAR,EAAkBC,QAAlB,KAA+B;MACxCA,QAAQ,CAAC,IAAD,EAAOC,IAAI,CAACC,SAAL,CAAef,KAAf,CAAP,CAAR;IACD;EAJkB,CAAd,CAAP;AAMD,CAPD"}

package/build/string-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"string-utils.js","names":["getByQualityPriorityValue","headerValue","split","length","qList","header","reduce","acc","item","accept","q","query","push","trim","sort","a","b"],"sources":["../src/string-utils.ts"],"sourcesContent":["/**\n * Quality values, or q-values and q-factors, are used to describe the order\n * of priority of values in a comma-separated list.\n * It is a special syntax allowed in some HTTP headers and in HTML.\n * https://developer.mozilla.org/en-US/docs/Glossary/Quality_values\n * @param headerValue\n */\nexport function getByQualityPriorityValue(headerValue: string | undefined | null): string {\n  if (typeof headerValue !== 'string') {\n    return '';\n  }\n\n  const split = headerValue.split(',');\n\n  if (split.length <= 1) {\n    const qList = split[0].split(';');\n    return qList[0];\n  }\n\n  let [header] = split\n    .reduce((acc, item: string) => {\n      const qList = item.split(';');\n      if (qList.length > 1) {\n        const [accept, q] = qList;\n        const [, query] = q.split('=');\n        acc.push([accept.trim(), query ? query : 0]);\n      } else {\n        acc.push([qList[0], 0]);\n      }\n      return acc;\n    }, [] as any)\n    .sort(function (a, b) {\n      return b[1] - a[1];\n    });\n  return header[0];\n}\n"],"mappings":";;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,yBAAT,CAAmCC,WAAnC,EAAmF;EACxF,IAAI,OAAOA,WAAP,KAAuB,QAA3B,EAAqC;IACnC,OAAO,EAAP;EACD;;EAED,MAAMC,KAAK,GAAGD,WAAW,CAACC,KAAZ,CAAkB,GAAlB,CAAd;;EAEA,IAAIA,KAAK,CAACC,MAAN,IAAgB,CAApB,EAAuB;IACrB,MAAMC,KAAK,GAAGF,KAAK,CAAC,CAAD,CAAL,CAASA,KAAT,CAAe,GAAf,CAAd;IACA,OAAOE,KAAK,CAAC,CAAD,CAAZ;EACD;;EAED,IAAI,CAACC,MAAD,IAAWH,KAAK,CACjBI,MADY,CACL,CAACC,GAAD,EAAMC,IAAN,KAAuB;IAC7B,MAAMJ,KAAK,GAAGI,IAAI,CAACN,KAAL,CAAW,GAAX,CAAd;;IACA,IAAIE,KAAK,CAACD,MAAN,GAAe,CAAnB,EAAsB;MACpB,MAAM,CAACM,MAAD,EAASC,CAAT,IAAcN,KAApB;MACA,MAAM,GAAGO,KAAH,IAAYD,CAAC,CAACR,KAAF,CAAQ,GAAR,CAAlB;MACAK,GAAG,CAACK,IAAJ,CAAS,CAACH,MAAM,CAACI,IAAP,EAAD,EAAgBF,KAAK,GAAGA,KAAH,GAAW,CAAhC,CAAT;IACD,CAJD,MAIO;MACLJ,GAAG,CAACK,IAAJ,CAAS,CAACR,KAAK,CAAC,CAAD,CAAN,EAAW,CAAX,CAAT;IACD;;IACD,OAAOG,GAAP;EACD,CAXY,EAWV,EAXU,EAYZO,IAZY,CAYP,UAAUC,CAAV,EAAaC,CAAb,EAAgB;IACpB,OAAOA,CAAC,CAAC,CAAD,CAAD,GAAOD,CAAC,CAAC,CAAD,CAAf;EACD,CAdY,CAAf;EAeA,OAAOV,MAAM,CAAC,CAAD,CAAb;AACD"}
+{"version":3,"file":"string-utils.js","names":["getByQualityPriorityValue","headerValue","split","length","qList","header","reduce","acc","item","accept","q","query","push","trim","sort","a","b"],"sources":["../src/string-utils.ts"],"sourcesContent":["/**\n * Quality values, or q-values and q-factors, are used to describe the order\n * of priority of values in a comma-separated list.\n * It is a special syntax allowed in some HTTP headers and in HTML.\n * https://developer.mozilla.org/en-US/docs/Glossary/Quality_values\n * @param headerValue\n */\nexport function getByQualityPriorityValue(headerValue: string | undefined | null): string {\n  if (typeof headerValue !== 'string') {\n    return '';\n  }\n\n  const split = headerValue.split(',');\n\n  if (split.length <= 1) {\n    const qList = split[0].split(';');\n    return qList[0];\n  }\n\n  let [header] = split\n    .reduce((acc, item: string) => {\n      const qList = item.split(';');\n      if (qList.length > 1) {\n        const [accept, q] = qList;\n        const [, query] = q.split('=');\n        acc.push([accept.trim(), query ? query : 0]);\n      } else {\n        acc.push([qList[0], 0]);\n      }\n      return acc;\n    }, [] as any)\n    .sort(function (a: number[], b: number[]) {\n      return b[1] - a[1];\n    });\n  return header[0];\n}\n"],"mappings":";;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,yBAAT,CAAmCC,WAAnC,EAAmF;EACxF,IAAI,OAAOA,WAAP,KAAuB,QAA3B,EAAqC;IACnC,OAAO,EAAP;EACD;;EAED,MAAMC,KAAK,GAAGD,WAAW,CAACC,KAAZ,CAAkB,GAAlB,CAAd;;EAEA,IAAIA,KAAK,CAACC,MAAN,IAAgB,CAApB,EAAuB;IACrB,MAAMC,KAAK,GAAGF,KAAK,CAAC,CAAD,CAAL,CAASA,KAAT,CAAe,GAAf,CAAd;IACA,OAAOE,KAAK,CAAC,CAAD,CAAZ;EACD;;EAED,IAAI,CAACC,MAAD,IAAWH,KAAK,CACjBI,MADY,CACL,CAACC,GAAD,EAAMC,IAAN,KAAuB;IAC7B,MAAMJ,KAAK,GAAGI,IAAI,CAACN,KAAL,CAAW,GAAX,CAAd;;IACA,IAAIE,KAAK,CAACD,MAAN,GAAe,CAAnB,EAAsB;MACpB,MAAM,CAACM,MAAD,EAASC,CAAT,IAAcN,KAApB;MACA,MAAM,GAAGO,KAAH,IAAYD,CAAC,CAACR,KAAF,CAAQ,GAAR,CAAlB;MACAK,GAAG,CAACK,IAAJ,CAAS,CAACH,MAAM,CAACI,IAAP,EAAD,EAAgBF,KAAK,GAAGA,KAAH,GAAW,CAAhC,CAAT;IACD,CAJD,MAIO;MACLJ,GAAG,CAACK,IAAJ,CAAS,CAACR,KAAK,CAAC,CAAD,CAAN,EAAW,CAAX,CAAT;IACD;;IACD,OAAOG,GAAP;EACD,CAXY,EAWV,EAXU,EAYZO,IAZY,CAYP,UAAUC,CAAV,EAAuBC,CAAvB,EAAoC;IACxC,OAAOA,CAAC,CAAC,CAAD,CAAD,GAAOD,CAAC,CAAC,CAAD,CAAf;EACD,CAdY,CAAf;EAeA,OAAOV,MAAM,CAAC,CAAD,CAAb;AACD"}

package/build/warning-utils.d.ts

@@ -5,4 +5,4 @@ export declare enum Codes {
     VERWAR004 = "VERWAR004",
     VERDEP003 = "VERDEP003"
 }
-export declare function emit(code: any, a?: string, b?: string, c?: string): void;
+export declare function emit(code: string, a?: string, b?: string, c?: string): void;

package/build/warning-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"warning-utils.js","names":["warningInstance","warning","verdaccioWarning","verdaccioDeprecation","Codes","create","VERWAR002","VERWAR001","VERWAR003","VERWAR004","VERDEP003","emit","code","a","b","c"],"sources":["../src/warning-utils.ts"],"sourcesContent":["import warning from 'process-warning';\n\nconst warningInstance = warning();\nconst verdaccioWarning = 'VerdaccioWarning';\nconst verdaccioDeprecation = 'VerdaccioDeprecation';\n\nexport enum Codes {\n  VERWAR001 = 'VERWAR001',\n  VERWAR002 = 'VERWAR002',\n  VERWAR003 = 'VERWAR003',\n  VERWAR004 = 'VERWAR004',\n  // deprecation warnings\n  VERDEP003 = 'VERDEP003',\n}\n\nwarningInstance.create(\n  verdaccioWarning,\n  Codes.VERWAR002,\n  `The property config \"logs\" property is longer supported, rename to \"log\" and use object instead`\n);\n\nwarningInstance.create(\n  verdaccioWarning,\n  Codes.VERWAR001,\n  `Verdaccio doesn't need superuser privileges. don't run it under root`\n);\n\nwarningInstance.create(\n  verdaccioWarning,\n  Codes.VERWAR003,\n  'rotating-file type is not longer supported, consider use [logrotate] instead'\n);\n\nwarningInstance.create(\n  verdaccioWarning,\n  Codes.VERWAR004,\n  `invalid address - %s, we expect a port (e.g. \"4873\"), \nhost:port (e.g. \"localhost:4873\") or full url '(e.g. \"http://localhost:4873/\")\nhttps://verdaccio.org/docs/en/configuration#listen-port`\n);\n\nwarningInstance.create(\n  verdaccioDeprecation,\n  Codes.VERDEP003,\n  'multiple addresses will be deprecated in the next major, only use one'\n);\n\nexport function emit(code, a?: string, b?: string, c?: string) {\n  warningInstance.emit(code, a, b, c);\n}\n"],"mappings":";;;;;;;;AAAA;;;;AAEA,MAAMA,eAAe,GAAG,IAAAC,uBAAA,GAAxB;AACA,MAAMC,gBAAgB,GAAG,kBAAzB;AACA,MAAMC,oBAAoB,GAAG,sBAA7B;IAEYC,K;;;WAAAA,K;EAAAA,K;EAAAA,K;EAAAA,K;EAAAA,K;EAAAA,K;GAAAA,K,qBAAAA,K;;AASZJ,eAAe,CAACK,MAAhB,CACEH,gBADF,EAEEE,KAAK,CAACE,SAFR,EAGG,iGAHH;AAMAN,eAAe,CAACK,MAAhB,CACEH,gBADF,EAEEE,KAAK,CAACG,SAFR,EAGG,sEAHH;AAMAP,eAAe,CAACK,MAAhB,CACEH,gBADF,EAEEE,KAAK,CAACI,SAFR,EAGE,8EAHF;AAMAR,eAAe,CAACK,MAAhB,CACEH,gBADF,EAEEE,KAAK,CAACK,SAFR,EAGG;AACH;AACA,wDALA;AAQAT,eAAe,CAACK,MAAhB,CACEF,oBADF,EAEEC,KAAK,CAACM,SAFR,EAGE,uEAHF;;AAMO,SAASC,IAAT,CAAcC,IAAd,EAAoBC,CAApB,EAAgCC,CAAhC,EAA4CC,CAA5C,EAAwD;EAC7Df,eAAe,CAACW,IAAhB,CAAqBC,IAArB,EAA2BC,CAA3B,EAA8BC,CAA9B,EAAiCC,CAAjC;AACD"}
+{"version":3,"file":"warning-utils.js","names":["warningInstance","warning","verdaccioWarning","verdaccioDeprecation","Codes","create","VERWAR002","VERWAR001","VERWAR003","VERWAR004","VERDEP003","emit","code","a","b","c"],"sources":["../src/warning-utils.ts"],"sourcesContent":["import warning from 'process-warning';\n\nconst warningInstance = warning();\nconst verdaccioWarning = 'VerdaccioWarning';\nconst verdaccioDeprecation = 'VerdaccioDeprecation';\n\nexport enum Codes {\n  VERWAR001 = 'VERWAR001',\n  VERWAR002 = 'VERWAR002',\n  VERWAR003 = 'VERWAR003',\n  VERWAR004 = 'VERWAR004',\n  // deprecation warnings\n  VERDEP003 = 'VERDEP003',\n}\n\nwarningInstance.create(\n  verdaccioWarning,\n  Codes.VERWAR002,\n  `The property config \"logs\" property is longer supported, rename to \"log\" and use object instead`\n);\n\nwarningInstance.create(\n  verdaccioWarning,\n  Codes.VERWAR001,\n  `Verdaccio doesn't need superuser privileges. don't run it under root`\n);\n\nwarningInstance.create(\n  verdaccioWarning,\n  Codes.VERWAR003,\n  'rotating-file type is not longer supported, consider use [logrotate] instead'\n);\n\nwarningInstance.create(\n  verdaccioWarning,\n  Codes.VERWAR004,\n  `invalid address - %s, we expect a port (e.g. \"4873\"), \nhost:port (e.g. \"localhost:4873\") or full url '(e.g. \"http://localhost:4873/\")\nhttps://verdaccio.org/docs/en/configuration#listen-port`\n);\n\nwarningInstance.create(\n  verdaccioDeprecation,\n  Codes.VERDEP003,\n  'multiple addresses will be deprecated in the next major, only use one'\n);\n\nexport function emit(code: string, a?: string, b?: string, c?: string) {\n  warningInstance.emit(code, a, b, c);\n}\n"],"mappings":";;;;;;;;AAAA;;;;AAEA,MAAMA,eAAe,GAAG,IAAAC,uBAAA,GAAxB;AACA,MAAMC,gBAAgB,GAAG,kBAAzB;AACA,MAAMC,oBAAoB,GAAG,sBAA7B;IAEYC,K;;;WAAAA,K;EAAAA,K;EAAAA,K;EAAAA,K;EAAAA,K;EAAAA,K;GAAAA,K,qBAAAA,K;;AASZJ,eAAe,CAACK,MAAhB,CACEH,gBADF,EAEEE,KAAK,CAACE,SAFR,EAGG,iGAHH;AAMAN,eAAe,CAACK,MAAhB,CACEH,gBADF,EAEEE,KAAK,CAACG,SAFR,EAGG,sEAHH;AAMAP,eAAe,CAACK,MAAhB,CACEH,gBADF,EAEEE,KAAK,CAACI,SAFR,EAGE,8EAHF;AAMAR,eAAe,CAACK,MAAhB,CACEH,gBADF,EAEEE,KAAK,CAACK,SAFR,EAGG;AACH;AACA,wDALA;AAQAT,eAAe,CAACK,MAAhB,CACEF,oBADF,EAEEC,KAAK,CAACM,SAFR,EAGE,uEAHF;;AAMO,SAASC,IAAT,CAAcC,IAAd,EAA4BC,CAA5B,EAAwCC,CAAxC,EAAoDC,CAApD,EAAgE;EACrEf,eAAe,CAACW,IAAhB,CAAqBC,IAArB,EAA2BC,CAA3B,EAA8BC,CAA9B,EAAiCC,CAAjC;AACD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdaccio/core",
-  "version": "6.0.0-6-next.48",
+  "version": "6.0.0-6-next.50",
   "description": "core utilities",
   "keywords": [
     "private",
@@ -36,13 +36,15 @@
   "dependencies": {
     "http-errors": "1.8.1",
     "http-status-codes": "2.2.0",
-    "semver": "7.3.7",
+    "semver": "7.3.8",
     "ajv": "8.11.0",
     "process-warning": "1.0.0",
-    "core-js": "3.25.2"
+    "core-js": "3.25.5"
   },
   "devDependencies": {
     "lodash": "4.17.21",
+    "typedoc": "0.23.16",
+    "typedoc-plugin-missing-exports": "latest",
     "@verdaccio/types": "11.0.0-6-next.17"
   },
   "funding": {
@@ -53,6 +55,7 @@
     "clean": "rimraf ./build",
     "test": "jest",
     "type-check": "tsc --noEmit -p tsconfig.build.json",
+    "build:docs": "typedoc --options ./typedoc.json --tsconfig tsconfig.build.json",
     "build:types": "tsc --emitDeclarationOnly -p tsconfig.build.json",
     "build:js": "babel src/ --out-dir build/ --copy-files --extensions \".ts,.tsx\" --source-maps",
     "watch": "pnpm build:js -- --watch",

package/src/plugin-utils.ts

@@ -1,24 +1,174 @@
-import { Config, IPackageStorage, Token, TokenFilter } from '@verdaccio/types';
+import { Express, RequestHandler } from 'express';
+import { Readable, Writable } from 'stream';
 
-import { searchUtils } from '.';
+import {
+  AllowAccess,
+  Callback,
+  Config,
+  Logger,
+  Manifest,
+  PackageAccess,
+  RemoteUser,
+  Token,
+  TokenFilter,
+} from '@verdaccio/types';
 
-interface IPlugin {
-  version?: string;
-  // In case a plugin needs to be cleaned up/removed
-  close?(): void;
+import { VerdaccioError, searchUtils } from '.';
+
+export interface AuthPluginPackage {
+  packageName: string;
+  packageVersion?: string;
+  tag?: string;
+}
+export interface PluginOptions {
+  config: Config;
+  logger: Logger;
+}
+
+/**
+ * The base plugin class, set of utilities for developing
+ * plugins.
+ * @alpha
+ * */
+export class Plugin<PluginConfig> {
+  static version = 1;
+  public readonly version: number;
+  public readonly config: PluginConfig | unknown;
+  public readonly options: PluginOptions;
+  public constructor(config: PluginConfig, options: PluginOptions) {
+    this.version = Plugin.version;
+    this.config = config;
+    this.options = options;
+  }
+
+  public getVersion() {
+    return this.version;
+  }
+}
+export interface StorageHandler {
+  logger: Logger;
+  deletePackage(fileName: string): Promise<void>;
+  removePackage(): Promise<void>;
+  //  next packages migration (this list is meant to replace the callback parent functions)
+  updatePackage(
+    packageName: string,
+    handleUpdate: (manifest: Manifest) => Promise<Manifest>
+  ): Promise<Manifest>;
+  readPackage(name: string): Promise<Manifest>;
+  savePackage(pkgName: string, value: Manifest): Promise<void>;
+  readTarball(pkgName: string, { signal }: { signal: AbortSignal }): Promise<Readable>;
+  createPackage(name: string, manifest: Manifest): Promise<void>;
+  writeTarball(tarballName: string, { signal }: { signal: AbortSignal }): Promise<Writable>;
+  // verify if tarball exist in the storage
+  hasTarball(fileName: string): Promise<boolean>;
+  // verify if package exist in the storage
+  hasPackage(): Promise<boolean>;
 }
 
-export interface IPluginStorage<T> extends IPlugin {
-  config: T & Config;
+export interface Storage<PluginConfig> extends Plugin<PluginConfig> {
   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;
+  getPackageStorage(packageInfo: string): StorageHandler;
   search(query: searchUtils.SearchQuery): Promise<searchUtils.SearchItem[]>;
   saveToken(token: Token): Promise<any>;
   deleteToken(user: string, tokenKey: string): Promise<any>;
   readTokens(filter: TokenFilter): Promise<Token[]>;
 }
+
+/**
+ * This function allow add additional middleware to the application.
+ *
+ *  ```ts
+ *  import express, { Request, Response } from 'express';
+ * 
+ *  class Middleware extends Plugin {
+ *    // instances of auth and storage are injected
+ *    register_middlewares(app, auth, storage) {
+ *      const router = express.Router();
+ *      router.post('/my-endpoint', (req: Request, res: Response): void => {
+        res.status(200).end();
+      });
+ *    }
+ *  }
+ * 
+ *  
+ *  const [plugin] = await asyncLoadPlugin(...);
+ *  plugin.register_middlewares(app, auth, storage);
+ *  ```
+ */
+export interface ExpressMiddleware<PluginConfig, Storage, Auth> extends Plugin<PluginConfig> {
+  register_middlewares(app: Express, auth: Auth, storage: Storage): void;
+}
+
+/**
+ * dasdsa
+ */
+export type AuthCallback = (error: VerdaccioError | null, groups?: string[] | false) => void;
+
+export type AuthAccessCallback = (error: VerdaccioError | null, access?: boolean) => void;
+export type AuthUserCallback = (error: VerdaccioError | null, access?: boolean | string) => void;
+export type AuthChangePasswordCallback = (error: VerdaccioError | null, access?: boolean) => void;
+export type AccessCallback = (error: VerdaccioError | null, ok?: boolean) => void;
+export interface Auth<T> extends Plugin<T> {
+  /**
+   * Handles the authenticated method.
+   * ```ts
+   *  class Auth {
+      public authenticate(user: string, password: string, done: AuthCallback): void {
+        if (!password) {
+          return done(errorUtils.getUnauthorized(API_ERROR.BAD_USERNAME_PASSWORD));
+        }
+        // always return an array of users
+        return done(null, [user]);      
+   *  }
+   * ```
+   */
+  authenticate(user: string, password: string, cb: AuthCallback): void;
+  /**
+   * Handles the authenticated method.
+   * ```ts
+   *  class Auth {
+      public adduser(user: string, password: string, done: AuthCallback): void {
+        if (!password) {
+          return done(errorUtils.getUnauthorized(API_ERROR.BAD_USERNAME_PASSWORD));
+        }
+        // return boolean
+        return done(null, true);      
+   *  }
+   * ```
+   */
+  adduser?(user: string, password: string, cb: AuthUserCallback): void;
+  changePassword?(
+    user: string,
+    password: string,
+    newPassword: string,
+    cb: AuthChangePasswordCallback
+  ): void;
+  allow_publish?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;
+  allow_publish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
+  allow_access?(user: RemoteUser, pkg: T & PackageAccess, cb: AccessCallback): void;
+  allow_access?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AccessCallback): void;
+  allow_unpublish?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;
+  allow_unpublish?(
+    user: RemoteUser,
+    pkg: AllowAccess & PackageAccess,
+    cb: AuthAccessCallback
+  ): void;
+  apiJWTmiddleware?(helpers: any): RequestHandler;
+}
+
+export interface IBasicAuth {
+  authenticate(user: string, password: string, cb: Callback): void;
+  invalidateToken?(token: string): Promise<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;
+}
+
+export interface ManifestFilter<T> extends Plugin<T> {
+  filterMetadata(packageInfo: Manifest): Promise<Manifest>;
+}

package/src/stream-utils.ts

@@ -1,90 +1,9 @@
-import { PassThrough, Transform, TransformOptions } from 'stream';
-
-export interface IReadTarball {
-  abort?: () => void;
-}
-
-export interface IUploadTarball {
-  done?: () => void;
-  abort?: () => void;
-}
-
-/**
- * This stream is used to read tarballs from repository.
- * @param {*} options
- * @return {Stream}
- */
-class ReadTarball extends PassThrough implements IReadTarball {
-  /**
-   *
-   * @param {Object} options
-   */
-  public constructor(options: TransformOptions) {
-    super(options);
-    // called when data is not needed anymore
-    addAbstractMethods(this, 'abort');
-  }
-
-  public abort(): void {}
-}
-
-/**
- * This stream is used to upload tarballs to a repository.
- * @param {*} options
- * @return {Stream}
- */
-class UploadTarball extends PassThrough implements IUploadTarball {
-  /**
-   *
-   * @param {Object} options
-   */
-  public constructor(options: any) {
-    super(options);
-    // called when user closes connection before upload finishes
-    addAbstractMethods(this, 'abort');
-
-    // called when upload finishes successfully
-    addAbstractMethods(this, 'done');
-  }
-
-  public abort(): void {}
-  public done(): void {}
-}
-
-/**
- * This function intercepts abstract calls and replays them allowing.
- * us to attach those functions after we are ready to do so
- * @param {*} self
- * @param {*} name
- */
-// Perhaps someone knows a better way to write this
-function addAbstractMethods(self: any, name: any): void {
-  self._called_methods = self._called_methods || {};
-
-  self.__defineGetter__(name, function () {
-    return function (): void {
-      self._called_methods[name] = true;
-    };
-  });
-
-  self.__defineSetter__(name, function (fn: any) {
-    delete self[name];
-
-    self[name] = fn;
-
-    // eslint-disable-next-line @typescript-eslint/prefer-optional-chain
-    if (self._called_methods && self._called_methods[name]) {
-      delete self._called_methods[name];
-
-      self[name]();
-    }
-  });
-}
+import { Readable, Transform } from 'stream';
 
 /**
  * Converts a buffer stream to a string.
  */
-const readableToString = async (stream) => {
+const readableToString = async (stream: Readable) => {
   const chunks: Buffer[] = [];
   for await (let chunk of stream) {
     chunks.push(Buffer.from(chunk));
@@ -106,4 +25,4 @@ const transformObjectToString = () => {
   });
 };
 
-export { ReadTarball, UploadTarball, readableToString, transformObjectToString };
+export { readableToString, transformObjectToString };

package/src/string-utils.ts

@@ -29,7 +29,7 @@ export function getByQualityPriorityValue(headerValue: string | undefined | null
       }
       return acc;
     }, [] as any)
-    .sort(function (a, b) {
+    .sort(function (a: number[], b: number[]) {
       return b[1] - a[1];
     });
   return header[0];

package/src/warning-utils.ts

@@ -45,6 +45,6 @@ warningInstance.create(
   'multiple addresses will be deprecated in the next major, only use one'
 );
 
-export function emit(code, a?: string, b?: string, c?: string) {
+export function emit(code: string, a?: string, b?: string, c?: string) {
   warningInstance.emit(code, a, b, c);
 }

package/test/mystreams.spec.ts

@@ -1,34 +1,8 @@
 import { Stream } from 'stream';
 
-import { ReadTarball, UploadTarball, readableToString } from '../src/stream-utils';
+import { readableToString } from '../src/stream-utils';
 
 describe('mystreams', () => {
-  test('should delay events on ReadTarball abort', (cb) => {
-    const readTballStream = new ReadTarball({});
-    readTballStream.abort();
-    setTimeout(function () {
-      readTballStream.abort = function (): void {
-        cb();
-      };
-      readTballStream.abort = function (): never {
-        throw Error('fail');
-      };
-    }, 10);
-  });
-
-  test('should delay events on UploadTarball abort', (cb) => {
-    const uploadTballStream = new UploadTarball({});
-    uploadTballStream.abort();
-    setTimeout(function () {
-      uploadTballStream.abort = function (): void {
-        cb();
-      };
-      uploadTballStream.abort = function (): never {
-        throw Error('fail');
-      };
-    }, 10);
-  });
-
   test('readableToString single string', async () => {
     expect(await readableToString(Stream.Readable.from('foo'))).toEqual('foo');
   });

package/tsconfig.build.json

@@ -2,7 +2,8 @@
   "extends": "../../../tsconfig.base.json",
   "compilerOptions": {
     "rootDir": "./src",
-    "outDir": "./build"
+    "outDir": "./build",
+    "noImplicitAny": true
   },
   "include": ["src/**/*"],
   "exclude": ["src/**/*.test.ts"]

package/tsconfig.json

@@ -4,7 +4,8 @@
     "rootDir": "./src",
     "outDir": "./build",
     "composite": true,
-    "declaration": true
+    "declaration": true,
+    "noImplicitAny": true
   },
   "include": ["src/**/*.ts"],
   "exclude": ["src/**/*.test.ts"]

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["src/index.ts"],
+  "sort": ["source-order"]
+}