@verdaccio/types 11.0.0-6-next.16 → 11.0.0-6-next.17

package/CHANGELOG.md

@@ -1,5 +1,69 @@
 # Change Log
 
+## 11.0.0-6-next.17
+
+### Major Changes
+
+- 9fc2e796: feat(plugins): improve plugin loader
+
+  ### Changes
+
+  - Add scope plugin support to 6.x https://github.com/verdaccio/verdaccio/pull/3227
+  - Avoid config collisions https://github.com/verdaccio/verdaccio/issues/928
+  - https://github.com/verdaccio/verdaccio/issues/1394
+  - `config.plugins` plugin path validations
+  - Updated algorithm for plugin loader.
+  - improved documentation (included dev)
+
+  ## Features
+
+  - Add scope plugin support to 6.x https://github.com/verdaccio/verdaccio/pull/3227
+  - Custom prefix:
+
+  ```
+  // config.yaml
+  server:
+    pluginPrefix: mycompany
+  middleware:
+    audit:
+        foo: 1
+  ```
+
+  This configuration will look up for `mycompany-audit` instead `Verdaccio-audit`.
+
+  ## Breaking Changes
+
+  ### sinopia plugins
+
+  - `sinopia` fallback support is removed, but can be restored using `pluginPrefix`
+
+  ### plugin filter
+
+  - method rename `filter_metadata`->`filterMetadata`
+
+  ### Plugin constructor does not merge configs anymore https://github.com/verdaccio/verdaccio/issues/928
+
+  The plugin receives as first argument `config`, which represents the config of the plugin. Example:
+
+  ```
+  // config.yaml
+  auth:
+    plugin:
+       foo: 1
+       bar: 2
+
+  export class Plugin<T> {
+    public constructor(config: T, options: PluginOptions) {
+      console.log(config);
+      // {foo:1, bar: 2}
+   }
+  }
+  ```
+
+### Minor Changes
+
+- 62c24b63: feat: add passwordValidationRegex property
+
 ## 11.0.0-6-next.16
 
 ### Patch Changes

package/build/configuration.d.ts

@@ -180,6 +180,14 @@ export declare type Notification = Notifications;
 export declare type ServerSettingsConf = {
     rateLimit: RateLimit;
     keepAliveTimeout?: number;
+    /**
+     * Plugins should be prefixed verdaccio-XXXXXX by default.
+     * To override the default prefix, use this property without `-`
+     * If you set pluginPrefix: acme, the packages to resolve will be
+     * acme-XXXXXX
+     */
+    pluginPrefix?: string;
+    passwordValidationRegex?: RegExp;
 };
 /**
  * YAML configuration file available options.
@@ -198,7 +206,7 @@ export interface ConfigYaml {
     listen?: ListenAddress;
     https?: HttpsConf;
     http_proxy?: string;
-    plugins?: string | void;
+    plugins?: string | void | null;
     https_proxy?: string;
     no_proxy?: string;
     max_body_size?: string;
@@ -213,7 +221,7 @@ export interface ConfigYaml {
     configPath?: string;
 }
 /**
- * Configuration object with additonal methods for configuration, includes yaml and internal medatada.
+ * Configuration object with additional methods for configuration, includes yaml and internal medatada.
  * @interface Config
  * @extends {ConfigYaml}
  */

package/build/plugins/commons.d.ts

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

package/build/plugins/filter.d.ts

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

package/build/plugins/storage.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { Readable, Writable } from 'stream';
 import { Callback, CallbackAction } from '../commons';
-import { Config, Logger } from '../configuration';
+import { Logger } from '../configuration';
 import { Manifest, Token } from '../manifest';
 import { IPlugin } from './commons';
 export declare type StorageList = string[];
@@ -68,7 +68,7 @@ export declare type IPackageStorageManager = ILocalPackageManager;
  */
 interface ILocalData<T> extends IPlugin<T>, ITokenActions {
     logger: Logger;
-    config: T & Config;
+    config: T;
     add(name: string): Promise<void>;
     remove(name: string): Promise<void>;
     get(): Promise<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdaccio/types",
-  "version": "11.0.0-6-next.16",
+  "version": "11.0.0-6-next.17",
   "description": "verdaccio types definitions",
   "keywords": [
     "private",
@@ -34,7 +34,7 @@
   "main": "build/types.d.ts",
   "types": "build/types.d.ts",
   "devDependencies": {
-    "@types/node": "16.11.56",
+    "@types/node": "16.11.60",
     "typedoc": "beta",
     "typedoc-plugin-missing-exports": "1.0.0"
   },

package/src/configuration.ts

@@ -226,6 +226,14 @@ export type ServerSettingsConf = {
   // express-rate-limit settings
   rateLimit: RateLimit;
   keepAliveTimeout?: number;
+  /**
+   * Plugins should be prefixed verdaccio-XXXXXX by default.
+   * To override the default prefix, use this property without `-`
+   * If you set pluginPrefix: acme, the packages to resolve will be
+   * acme-XXXXXX
+   */
+  pluginPrefix?: string;
+  passwordValidationRegex?: RegExp;
 };
 
 /**
@@ -245,7 +253,7 @@ export interface ConfigYaml {
   listen?: ListenAddress;
   https?: HttpsConf;
   http_proxy?: string;
-  plugins?: string | void;
+  plugins?: string | void | null;
   https_proxy?: string;
   no_proxy?: string;
   max_body_size?: string;
@@ -264,7 +272,7 @@ export interface ConfigYaml {
 }
 
 /**
- * Configuration object with additonal methods for configuration, includes yaml and internal medatada.
+ * Configuration object with additional methods for configuration, includes yaml and internal medatada.
  * @interface Config
  * @extends {ConfigYaml}
  */

package/src/plugins/commons.ts

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

package/src/plugins/filter.ts

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

package/src/plugins/storage.ts

@@ -84,7 +84,7 @@ export type IPackageStorageManager = ILocalPackageManager;
  */
 interface ILocalData<T> extends IPlugin<T>, ITokenActions {
   logger: Logger;
-  config: T & Config;
+  config: T;
   add(name: string): Promise<void>;
   remove(name: string): Promise<void>;
   get(): Promise<any>;