@verdaccio/config 7.0.0-next-7.12 → 7.0.0-next-7.14

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @verdaccio/config
 
+## 7.0.0-next-7.14
+
+### Patch Changes
+
+- @verdaccio/core@7.0.0-next-7.14
+- @verdaccio/utils@7.0.0-next-7.14
+
+## 7.0.0-next-7.13
+
+### Patch Changes
+
+- a99a4bb: fix config builder erroring when passed partial config
+  - @verdaccio/core@7.0.0-next-7.13
+  - @verdaccio/utils@7.0.0-next-7.13
+
 ## 7.0.0-next-7.12
 
 ### Patch Changes

package/README.md

@@ -1,5 +1,74 @@
 # @verdaccio/config
 
+## Overview
+
+The `@verdaccio/config` package provides a powerful configuration builder constructor for programmatically creating configuration objects for Verdaccio, a lightweight private npm proxy registry. With this package, users can easily manage various configuration aspects such as package access, uplinks, security settings, authentication, logging, and storage options.
+
+## Installation
+
+You can install via npm:
+
+```bash
+npm install @verdaccio/config
+```
+
+## Usage
+
+To start using `@verdaccio/config`, import the `ConfigBuilder` class and begin constructing your configuration object:
+
+## `ConfigBuilder` constructor
+
+The `ConfigBuilder` class is a helper configuration builder constructor used to programmatically create configuration objects for testing or other purposes.
+
+```typescript
+
+import { ConfigBuilder } from '@verdaccio/config';
+
+// Create a new configuration builder instance
+const config = ConfigBuilder.build({ security: { api: { legacy: false } } });
+
+// Add package access configuration
+configBuilder.addPackageAccess('@scope/*', { access: 'read', publish: 'write' });
+
+// Add an uplink configuration
+configBuilder.addUplink('npmjs', { url: 'https://registry.npmjs.org/' });
+
+// Add security configuration
+configBuilder.addSecurity({ allow_offline: true });
+
+// Get the configuration object
+const config = configBuilder.getConfig();
+
+// Get the configuration yaml text
+const config = configBuilder.getAsYaml();
+```
+
+### Methods
+
+- `addPackageAccess(pattern: string, pkgAccess: PackageAccessYaml)`: Adds package access configuration.
+- `addUplink(id: string, uplink: UpLinkConf)`: Adds an uplink configuration.
+- `addSecurity(security: Partial<Security>)`: Adds security configuration.
+- `addAuth(auth: Partial<AuthConf>)`: Adds authentication configuration.
+- `addLogger(log: LoggerConfItem)`: Adds logger configuration.
+- `addStorage(storage: string | object)`: Adds storage configuration.
+- `getConfig(): ConfigYaml`: Retrieves the configuration object.
+- `getAsYaml(): string`: Retrieves the configuration object as YAML format.
+
+## `getDefaultConfig`
+
+This method is available in the package's index and retrieves the default configuration object.
+
+```typescript
+import { getDefaultConfig } from '@verdaccio/config';
+
+const defaultConfig = getDefaultConfig();
+```
+
+## Other Methods
+
+- `fromJStoYAML(config: ConfigYaml): string`: Converts a JavaScript configuration object to YAML format.
+- `parseConfigFile(filePath: string): ConfigYaml`: Parses a configuration file from the specified path and returns the configuration object.
+
 ### License
 
 Verdaccio is [MIT licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE)

package/build/builder.js

@@ -12,12 +12,11 @@ var _ = require(".");
  */
 class ConfigBuilder {
   constructor(config) {
-    // @ts-ignore
-    this.config = config !== null && config !== void 0 ? config : {
+    this.config = (0, _lodash.merge)(config, {
       uplinks: {},
       packages: {},
       security: {}
-    };
+    });
   }
   static build(config) {
     return new ConfigBuilder(config);

package/build/builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"builder.js","names":["_lodash","require","_","ConfigBuilder","constructor","config","uplinks","packages","security","build","addPackageAccess","pattern","pkgAccess","addUplink","id","uplink","addSecurity","merge","addAuth","auth","addLogger","log","addStorage","storage","store","getConfig","getAsYaml","fromJStoYAML","exports","default"],"sources":["../src/builder.ts"],"sourcesContent":["import { merge } from 'lodash';\n\nimport {\n  AuthConf,\n  ConfigYaml,\n  LoggerConfItem,\n  PackageAccessYaml,\n  Security,\n  UpLinkConf,\n} from '@verdaccio/types';\n\nimport { fromJStoYAML } from '.';\n\n/**\n * Helper configuration builder constructor, used to build the configuration for testing or\n * programatically creating a configuration.\n */\nexport default class ConfigBuilder {\n  private config: ConfigYaml;\n\n  public constructor(config?: Partial<ConfigYaml>) {\n    // @ts-ignore\n    this.config = config ?? { uplinks: {}, packages: {}, security: {} };\n  }\n\n  public static build(config?: Partial<ConfigYaml>): ConfigBuilder {\n    return new ConfigBuilder(config);\n  }\n\n  public addPackageAccess(pattern: string, pkgAccess: PackageAccessYaml) {\n    // @ts-ignore\n    this.config.packages[pattern] = pkgAccess;\n    return this;\n  }\n\n  public addUplink(id: string, uplink: UpLinkConf) {\n    this.config.uplinks[id] = uplink;\n    return this;\n  }\n\n  public addSecurity(security: Partial<Security>) {\n    this.config.security = merge(this.config.security, security);\n    return this;\n  }\n\n  public addAuth(auth: Partial<AuthConf>) {\n    this.config.auth = merge(this.config.auth, auth);\n    return this;\n  }\n\n  public addLogger(log: LoggerConfItem) {\n    this.config.log = log;\n    return this;\n  }\n\n  public addStorage(storage: string | object) {\n    if (typeof storage === 'string') {\n      this.config.storage = storage;\n    } else {\n      this.config.store = storage;\n    }\n    return this;\n  }\n\n  public getConfig(): ConfigYaml {\n    return this.config;\n  }\n\n  public getAsYaml(): string {\n    return fromJStoYAML(this.config) as string;\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAWA,IAAAC,CAAA,GAAAD,OAAA;AAEA;AACA;AACA;AACA;AACe,MAAME,aAAa,CAAC;EAG1BC,WAAWA,CAACC,MAA4B,EAAE;IAC/C;IACA,IAAI,CAACA,MAAM,GAAGA,MAAM,aAANA,MAAM,cAANA,MAAM,GAAI;MAAEC,OAAO,EAAE,CAAC,CAAC;MAAEC,QAAQ,EAAE,CAAC,CAAC;MAAEC,QAAQ,EAAE,CAAC;IAAE,CAAC;EACrE;EAEA,OAAcC,KAAKA,CAACJ,MAA4B,EAAiB;IAC/D,OAAO,IAAIF,aAAa,CAACE,MAAM,CAAC;EAClC;EAEOK,gBAAgBA,CAACC,OAAe,EAAEC,SAA4B,EAAE;IACrE;IACA,IAAI,CAACP,MAAM,CAACE,QAAQ,CAACI,OAAO,CAAC,GAAGC,SAAS;IACzC,OAAO,IAAI;EACb;EAEOC,SAASA,CAACC,EAAU,EAAEC,MAAkB,EAAE;IAC/C,IAAI,CAACV,MAAM,CAACC,OAAO,CAACQ,EAAE,CAAC,GAAGC,MAAM;IAChC,OAAO,IAAI;EACb;EAEOC,WAAWA,CAACR,QAA2B,EAAE;IAC9C,IAAI,CAACH,MAAM,CAACG,QAAQ,GAAG,IAAAS,aAAK,EAAC,IAAI,CAACZ,MAAM,CAACG,QAAQ,EAAEA,QAAQ,CAAC;IAC5D,OAAO,IAAI;EACb;EAEOU,OAAOA,CAACC,IAAuB,EAAE;IACtC,IAAI,CAACd,MAAM,CAACc,IAAI,GAAG,IAAAF,aAAK,EAAC,IAAI,CAACZ,MAAM,CAACc,IAAI,EAAEA,IAAI,CAAC;IAChD,OAAO,IAAI;EACb;EAEOC,SAASA,CAACC,GAAmB,EAAE;IACpC,IAAI,CAAChB,MAAM,CAACgB,GAAG,GAAGA,GAAG;IACrB,OAAO,IAAI;EACb;EAEOC,UAAUA,CAACC,OAAwB,EAAE;IAC1C,IAAI,OAAOA,OAAO,KAAK,QAAQ,EAAE;MAC/B,IAAI,CAAClB,MAAM,CAACkB,OAAO,GAAGA,OAAO;IAC/B,CAAC,MAAM;MACL,IAAI,CAAClB,MAAM,CAACmB,KAAK,GAAGD,OAAO;IAC7B;IACA,OAAO,IAAI;EACb;EAEOE,SAASA,CAAA,EAAe;IAC7B,OAAO,IAAI,CAACpB,MAAM;EACpB;EAEOqB,SAASA,CAAA,EAAW;IACzB,OAAO,IAAAC,cAAY,EAAC,IAAI,CAACtB,MAAM,CAAC;EAClC;AACF;AAACuB,OAAA,CAAAC,OAAA,GAAA1B,aAAA"}
+{"version":3,"file":"builder.js","names":["_lodash","require","_","ConfigBuilder","constructor","config","merge","uplinks","packages","security","build","addPackageAccess","pattern","pkgAccess","addUplink","id","uplink","addSecurity","addAuth","auth","addLogger","log","addStorage","storage","store","getConfig","getAsYaml","fromJStoYAML","exports","default"],"sources":["../src/builder.ts"],"sourcesContent":["import { merge } from 'lodash';\n\nimport {\n  AuthConf,\n  ConfigYaml,\n  LoggerConfItem,\n  PackageAccessYaml,\n  Security,\n  UpLinkConf,\n} from '@verdaccio/types';\n\nimport { fromJStoYAML } from '.';\n\n/**\n * Helper configuration builder constructor, used to build the configuration for testing or\n * programatically creating a configuration.\n */\nexport default class ConfigBuilder {\n  private config: ConfigYaml;\n\n  public constructor(config?: Partial<ConfigYaml>) {\n    this.config = merge(config, { uplinks: {}, packages: {}, security: {} });\n  }\n\n  public static build(config?: Partial<ConfigYaml>): ConfigBuilder {\n    return new ConfigBuilder(config);\n  }\n\n  public addPackageAccess(pattern: string, pkgAccess: PackageAccessYaml) {\n    // @ts-ignore\n    this.config.packages[pattern] = pkgAccess;\n    return this;\n  }\n\n  public addUplink(id: string, uplink: UpLinkConf) {\n    this.config.uplinks[id] = uplink;\n    return this;\n  }\n\n  public addSecurity(security: Partial<Security>) {\n    this.config.security = merge(this.config.security, security);\n    return this;\n  }\n\n  public addAuth(auth: Partial<AuthConf>) {\n    this.config.auth = merge(this.config.auth, auth);\n    return this;\n  }\n\n  public addLogger(log: LoggerConfItem) {\n    this.config.log = log;\n    return this;\n  }\n\n  public addStorage(storage: string | object) {\n    if (typeof storage === 'string') {\n      this.config.storage = storage;\n    } else {\n      this.config.store = storage;\n    }\n    return this;\n  }\n\n  public getConfig(): ConfigYaml {\n    return this.config;\n  }\n\n  public getAsYaml(): string {\n    return fromJStoYAML(this.config) as string;\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAWA,IAAAC,CAAA,GAAAD,OAAA;AAEA;AACA;AACA;AACA;AACe,MAAME,aAAa,CAAC;EAG1BC,WAAWA,CAACC,MAA4B,EAAE;IAC/C,IAAI,CAACA,MAAM,GAAG,IAAAC,aAAK,EAACD,MAAM,EAAE;MAAEE,OAAO,EAAE,CAAC,CAAC;MAAEC,QAAQ,EAAE,CAAC,CAAC;MAAEC,QAAQ,EAAE,CAAC;IAAE,CAAC,CAAC;EAC1E;EAEA,OAAcC,KAAKA,CAACL,MAA4B,EAAiB;IAC/D,OAAO,IAAIF,aAAa,CAACE,MAAM,CAAC;EAClC;EAEOM,gBAAgBA,CAACC,OAAe,EAAEC,SAA4B,EAAE;IACrE;IACA,IAAI,CAACR,MAAM,CAACG,QAAQ,CAACI,OAAO,CAAC,GAAGC,SAAS;IACzC,OAAO,IAAI;EACb;EAEOC,SAASA,CAACC,EAAU,EAAEC,MAAkB,EAAE;IAC/C,IAAI,CAACX,MAAM,CAACE,OAAO,CAACQ,EAAE,CAAC,GAAGC,MAAM;IAChC,OAAO,IAAI;EACb;EAEOC,WAAWA,CAACR,QAA2B,EAAE;IAC9C,IAAI,CAACJ,MAAM,CAACI,QAAQ,GAAG,IAAAH,aAAK,EAAC,IAAI,CAACD,MAAM,CAACI,QAAQ,EAAEA,QAAQ,CAAC;IAC5D,OAAO,IAAI;EACb;EAEOS,OAAOA,CAACC,IAAuB,EAAE;IACtC,IAAI,CAACd,MAAM,CAACc,IAAI,GAAG,IAAAb,aAAK,EAAC,IAAI,CAACD,MAAM,CAACc,IAAI,EAAEA,IAAI,CAAC;IAChD,OAAO,IAAI;EACb;EAEOC,SAASA,CAACC,GAAmB,EAAE;IACpC,IAAI,CAAChB,MAAM,CAACgB,GAAG,GAAGA,GAAG;IACrB,OAAO,IAAI;EACb;EAEOC,UAAUA,CAACC,OAAwB,EAAE;IAC1C,IAAI,OAAOA,OAAO,KAAK,QAAQ,EAAE;MAC/B,IAAI,CAAClB,MAAM,CAACkB,OAAO,GAAGA,OAAO;IAC/B,CAAC,MAAM;MACL,IAAI,CAAClB,MAAM,CAACmB,KAAK,GAAGD,OAAO;IAC7B;IACA,OAAO,IAAI;EACb;EAEOE,SAASA,CAAA,EAAe;IAC7B,OAAO,IAAI,CAACpB,MAAM;EACpB;EAEOqB,SAASA,CAAA,EAAW;IACzB,OAAO,IAAAC,cAAY,EAAC,IAAI,CAACtB,MAAM,CAAC;EAClC;AACF;AAACuB,OAAA,CAAAC,OAAA,GAAA1B,aAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdaccio/config",
-  "version": "7.0.0-next-7.12",
+  "version": "7.0.0-next-7.14",
   "description": "logger",
   "main": "./build/index.js",
   "types": "build/index.d.ts",
@@ -29,8 +29,8 @@
     "node": ">=12"
   },
   "dependencies": {
-    "@verdaccio/core": "7.0.0-next-7.12",
-    "@verdaccio/utils": "7.0.0-next-7.12",
+    "@verdaccio/core": "7.0.0-next-7.14",
+    "@verdaccio/utils": "7.0.0-next-7.14",
     "debug": "4.3.4",
     "js-yaml": "4.1.0",
     "lodash": "4.17.21",

package/src/builder.ts

@@ -19,8 +19,7 @@ export default class ConfigBuilder {
   private config: ConfigYaml;
 
   public constructor(config?: Partial<ConfigYaml>) {
-    // @ts-ignore
-    this.config = config ?? { uplinks: {}, packages: {}, security: {} };
+    this.config = merge(config, { uplinks: {}, packages: {}, security: {} });
   }
 
   public static build(config?: Partial<ConfigYaml>): ConfigBuilder {

package/test/builder.spec.ts

@@ -67,5 +67,58 @@ describe('Config builder', () => {
       .addStorage('/tmp/verdaccio')
       .addSecurity({ api: { legacy: true } });
     expect(config.getAsYaml()).toMatchSnapshot();
+
+    expect(config.getConfig()).toEqual({
+      uplinks: {
+        upstream: {
+          url: 'https://registry.verdaccio.org',
+        },
+        upstream2: {
+          url: 'https://registry.verdaccio.org',
+        },
+      },
+      packages: {
+        'upstream/*': {
+          access: 'public',
+          publish: 'foo, bar',
+          unpublish: 'foo, bar',
+          proxy: 'some',
+        },
+      },
+      security: {
+        api: {
+          legacy: true,
+        },
+      },
+      log: {
+        level: 'info',
+        type: 'stdout',
+        format: 'json',
+      },
+      storage: '/tmp/verdaccio',
+    });
+  });
+
+  test('should merge configurations', () => {
+    // @ts-expect-error
+    const config = ConfigBuilder.build({ security: { api: { legacy: false } } });
+    config.addSecurity({ web: { verify: {}, sign: { algorithm: 'ES256' } } });
+    config.addStorage('/tmp/verdaccio');
+    expect(config.getConfig()).toEqual({
+      security: {
+        api: {
+          legacy: false,
+        },
+        web: {
+          verify: {},
+          sign: {
+            algorithm: 'ES256',
+          },
+        },
+      },
+      uplinks: {},
+      packages: {},
+      storage: '/tmp/verdaccio',
+    });
   });
 });