generator-verdaccio-plugin 6.0.0-next-8.27 → 6.0.0

package/LICENSE

@@ -1,6 +1,6 @@
-MIT License
+The MIT License (MIT)
 
-Copyright (c) 2025 Verdaccio contributors
+Copyright (c) 2024 Juan Picado <@jotadeveloper> <juanpicado19@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,19 +1,9 @@
-# generator-verdaccio-plugin - Plugin Generator for Verdaccio
+# generator-verdaccio-plugin
 
-[![Verdaccio Home](https://img.shields.io/badge/Homepage-Verdaccio-405236?style=flat)](https://verdaccio.org)
-[![MIT License](https://img.shields.io/github/license/verdaccio/verdaccio?label=License&color=405236)](https://github.com/verdaccio/verdaccio/blob/master/LICENSE)
-[![Verdaccio Latest](https://img.shields.io/npm/v/verdaccio?label=Latest%20Version&color=405236)](https://github.com/verdaccio/verdaccio)
-[![This Package Latest](https://img.shields.io/npm/v/generator-verdaccio-plugin?label=generator-verdaccio-plugin&color=405236)](https://npmjs.com/package/generator-verdaccio-plugin)
-
-[![Documentation](https://img.shields.io/badge/Help-Verdaccio?style=flat&logo=Verdaccio&label=Verdaccio&color=cd4000)](https://verdaccio.org/docs)
-[![Discord](https://img.shields.io/badge/Chat-Discord?style=flat&logo=Discord&label=Discord&color=cd4000)](https://discord.com/channels/388674437219745793)
-[![Bluesky](https://img.shields.io/badge/Follow-Bluesky?style=flat&logo=Bluesky&label=Bluesky&color=cd4000)](https://bsky.app/profile/verdaccio.org)
-[![Backers](https://img.shields.io/opencollective/backers/verdaccio?style=flat&logo=opencollective&label=Join%20Backers&color=cd4000)](https://opencollective.com/verdaccio/contribute)
-[![Sponsors](https://img.shields.io/opencollective/sponsors/verdaccio?style=flat&logo=opencollective&label=Sponsor%20Us&color=cd4000)](https://opencollective.com/verdaccio/contribute)
-
-[![Verdaccio Downloads](https://img.shields.io/npm/dm/verdaccio?style=flat&logo=npm&label=Npm%20Downloads&color=lightgrey)](https://www.npmjs.com/package/verdaccio)
-[![Docker Pulls](https://img.shields.io/docker/pulls/verdaccio/verdaccio?style=flat&logo=docker&label=Docker%20Pulls&color=lightgrey)](https://hub.docker.com/r/verdaccio/verdaccio)
-[![GitHub Stars](https://img.shields.io/github/stars/verdaccio?style=flat&logo=github&label=GitHub%20Stars%20%E2%AD%90&color=lightgrey)](https://github.com/verdaccio/verdaccio/stargazers)
+[![verdaccio (latest)](https://img.shields.io/npm/v/generator-verdaccio-plugin/latest.svg)](https://www.npmjs.com/package/generator-verdaccio-plugin)
+[![verdaccio (downloads)](https://img.shields.io/npm/dy/generator-verdaccio-plugin.svg)](https://www.npmjs.com/package/generator-verdaccio-plugin)
+[![Backers](https://opencollective.com/verdaccio/tiers/backer/badge.svg?label=Backer&color=brightgreen)](https://opencollective.com/verdaccio)
+[![Discord](https://img.shields.io/discord/388674437219745793?logo=discord)](http://chat.verdaccio.org/)
 
 Verdaccio plugin generator based in [Yeoman](http://yeoman.io) aims to help to scaffold plugins development
 
@@ -43,66 +33,6 @@ yo verdaccio-plugin
 - [Anix](https://github.com/anikethsaha)
 - [Juan Picado](https://github.com/juanpicado)
 
-## Donations
-
-Verdaccio is run by **volunteers**; nobody is working full-time on it. If you find this project to be useful and would like to support its development, consider making a donation - **your logo might end up in this readme.** 😉
-
-**[Donate](https://opencollective.com/verdaccio)** 💵👍🏻 starting from _\$1/month_ or just one single contribution.
-
-## Report a vulnerability
-
-If you want to report a security vulnerability, please follow the steps which we have defined for you in our [security policy](https://github.com/verdaccio/verdaccio/security/policy).
-
-## Open Collective Sponsors
-
-Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/verdaccio/contribute)]
-
-[![sponsor](https://opencollective.com/verdaccio/sponsor/0/avatar.svg)](https://opencollective.com/verdaccio/sponsor/0/website)
-[![sponsor](https://opencollective.com/verdaccio/sponsor/1/avatar.svg)](https://opencollective.com/verdaccio/sponsor/1/website)
-[![sponsor](https://opencollective.com/verdaccio/sponsor/2/avatar.svg)](https://opencollective.com/verdaccio/sponsor/2/website)
-[![sponsor](https://opencollective.com/verdaccio/sponsor/3/avatar.svg)](https://opencollective.com/verdaccio/sponsor/3/website)
-[![sponsor](https://opencollective.com/verdaccio/sponsor/4/avatar.svg)](https://opencollective.com/verdaccio/sponsor/4/website)
-[![sponsor](https://opencollective.com/verdaccio/sponsor/5/avatar.svg)](https://opencollective.com/verdaccio/sponsor/5/website)
-[![sponsor](https://opencollective.com/verdaccio/sponsor/6/avatar.svg)](https://opencollective.com/verdaccio/sponsor/6/website)
-[![sponsor](https://opencollective.com/verdaccio/sponsor/7/avatar.svg)](https://opencollective.com/verdaccio/sponsor/7/website)
-[![sponsor](https://opencollective.com/verdaccio/sponsor/8/avatar.svg)](https://opencollective.com/verdaccio/sponsor/8/website)
-[![sponsor](https://opencollective.com/verdaccio/sponsor/9/avatar.svg)](https://opencollective.com/verdaccio/sponsor/9/website)
-
-## Open Collective Backers
-
-Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/verdaccio/contribute)]
-
-[![backers](https://opencollective.com/verdaccio/backers.svg?width=890)](https://opencollective.com/verdaccio/contributes)
-
-## Special Thanks
-
-Thanks to the following companies to help us to achieve our goals providing free open source licenses.
-
-[![jetbrains](https://github.com/verdaccio/verdaccio/blob/master/assets/thanks/jetbrains/logo.jpg?raw=true)](https://www.jetbrains.com/)
-[![crowdin](https://github.com/verdaccio/verdaccio/blob/master/assets/thanks/crowdin/logo.png?raw=true)](https://crowdin.com/)
-
-## Contributors
-
-This project exists thanks to all the people who contribute. [[Contribute](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md)].
-
-[![contributors](https://opencollective.com/verdaccio/contributors.svg?width=890&button=true)](https://github.com/verdaccio/verdaccio/graphs/contributors)
-
-## FAQ / Contact / Troubleshoot
-
-If you have any issue you can try the following options. Do not hesitate to ask or check our issues database. Perhaps someone has asked already what you are looking for.
-
-- [Blog](https://verdaccio.org/blog/)
-- [Donations](https://opencollective.com/verdaccio)
-- [Reporting an issue](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md#reporting-a-bug)
-- [Running discussions](https://github.com/orgs/verdaccio/discussions)
-- [Chat](https://discord.com/channels/388674437219745793)
-- [Logos](https://verdaccio.org/docs/logo)
-- [Docker Examples](https://github.com/verdaccio/verdaccio/tree/master/docker-examples)
-- [FAQ](https://github.com/verdaccio/verdaccio/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Aquestion%20)
-
 ## License
 
-Verdaccio is [MIT licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE)
-
-The Verdaccio documentation and logos (excluding /thanks, e.g., .md, .png, .sketch files within the /assets folder) are
-[Creative Commons licensed](https://creativecommons.org/licenses/by/4.0/).
+MIT © [Juan Picado <@jotadeveloper>]()

package/generators/app/index.d.ts

@@ -0,0 +1,11 @@
+import Generator from 'yeoman-generator';
+export default class PluginGenerator extends Generator {
+    private props;
+    private projectName;
+    private destinationPathName;
+    constructor(args: string | string[], opts: Record<string, unknown>);
+    prompting(): Promise<void>;
+    packageJSON(): void;
+    writing(): void;
+    install(): void;
+}

package/generators/app/index.js

@@ -1,125 +1,134 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _chalk = _interopRequireDefault(require("chalk"));
-var _lodash = _interopRequireDefault(require("lodash"));
-var _nodePath = require("node:path");
-var _yeomanGenerator = _interopRequireDefault(require("yeoman-generator"));
-var _yosay = _interopRequireDefault(require("yosay"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-class PluginGenerator extends _yeomanGenerator.default {
-  projectName = 'verdaccio-';
-  destinationPathName = 'verdaccio-';
-  constructor(args, opts) {
-    super(args, opts);
-    this.props = {};
-  }
-  prompting() {
-    this.log((0, _yosay.default)(`Welcome to ${_chalk.default.red('generator-verdaccio-plugin')} plugin generator!`));
-    const prompts = [{
-      type: 'list',
-      name: 'pluginType',
-      require: true,
-      message: 'What kind of plugin you want to create?',
-      store: true,
-      choices: [{
-        value: 'auth'
-      }, {
-        value: 'storage'
-      }, {
-        value: 'middleware'
-      }]
-    }, {
-      type: 'input',
-      name: 'name',
-      require: true,
-      message: `What's the plugin name? The prefix (verdaccio-xxx) will be added automatically`,
-      default: 'customname',
-      validate: function (input) {
-        if (input.startsWith('verdaccio-')) {
-          return false;
-        } else if (input === '') {
-          return false;
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const lodash_1 = __importDefault(require("lodash"));
+const node_path_1 = require("node:path");
+const yeoman_generator_1 = __importDefault(require("yeoman-generator"));
+const yosay_1 = __importDefault(require("yosay"));
+const package_json_1 = __importDefault(require("../../package.json"));
+class PluginGenerator extends yeoman_generator_1.default {
+    props = {};
+    projectName = 'verdaccio-';
+    destinationPathName = '';
+    constructor(args, opts) {
+        super(args, opts);
+    }
+    async prompting() {
+        this.log((0, yosay_1.default)(`Welcome to ${chalk_1.default.red('generator-verdaccio-plugin')} plugin generator!`));
+        const answers = await this.prompt([
+            {
+                type: 'list',
+                name: 'pluginType',
+                message: 'What kind of plugin do you want to create?',
+                default: process.env.PLUGIN_TYPE ?? 'auth',
+                choices: [
+                    { name: 'Auth', value: 'auth' },
+                    { name: 'Storage', value: 'storage' },
+                    { name: 'Middleware', value: 'middleware' },
+                ],
+            },
+            {
+                type: 'input',
+                name: 'name',
+                message: 'What\'s the plugin name? The prefix (verdaccio-xxx) will be added automatically',
+                default: process.env.PLUGIN_NAME ?? 'my-plugin',
+                validate: (input) => {
+                    if (!input) {
+                        return 'Name cannot be empty';
+                    }
+                    if (input.startsWith('verdaccio-')) {
+                        return 'Do not include the verdaccio- prefix';
+                    }
+                    return true;
+                },
+            },
+            {
+                type: 'input',
+                name: 'description',
+                message: 'Please, describe your plugin',
+                default: 'An amazing verdaccio plugin',
+            },
+            {
+                type: 'input',
+                name: 'githubUsername',
+                message: 'GitHub username or Organization',
+                validate: (input) => Boolean(input) || 'GitHub username is required',
+            },
+            {
+                type: 'input',
+                name: 'authorName',
+                message: 'Author\'s Name',
+                store: true,
+            },
+            {
+                type: 'input',
+                name: 'authorEmail',
+                message: 'Author\'s Email',
+                store: true,
+            },
+            {
+                type: 'input',
+                name: 'keywords',
+                message: 'Type your keywords (comma separated)',
+                filter: (keywords) => lodash_1.default.uniq(lodash_1.default.words(keywords).concat(['verdaccio'])),
+            },
+        ]);
+        this.props = {
+            ...answers,
+            license: 'MIT',
+        };
+        this.projectName = `verdaccio-${answers.name}`;
+        this.destinationPathName = (0, node_path_1.resolve)(this.projectName);
+        this.props.name = this.projectName;
+        if (answers.githubUsername) {
+            this.props.repository = `${answers.githubUsername}/${answers.name}`;
         }
-        return true;
-      }
-    }, {
-      type: 'input',
-      name: 'description',
-      message: 'Please, describe your plugin',
-      default: 'An amazing verdaccio plugin'
-    }, {
-      name: 'githubUsername',
-      message: 'GitHub username or Organization',
-      validate: function (input) {
-        return input !== '';
-      }
-    }, {
-      name: 'authorName',
-      message: "Author's Name",
-      store: true
-    }, {
-      name: 'authorEmail',
-      message: "Author's Email",
-      store: true
-    }, {
-      name: 'keywords',
-      message: 'Key your keywords (comma to split)',
-      filter: function (keywords) {
-        return _lodash.default.uniq(_lodash.default.words(keywords).concat(['verdaccio-']));
-      }
-    }];
-    return this.prompt(prompts).then(function (_props) {
-      // To access props later use this.props.someAnswer;
-      // @ts-ignore
-      this.props = _props;
-      const {
-        name,
-        githubUsername
-      } = _props;
-      // @ts-ignore
-      this.props.license = 'MIT';
-      if (githubUsername) {
-        // @ts-ignore
-        this.props.repository = githubUsername + '/' + name;
-      }
-
-      // @ts-ignore
-      this.projectName = `verdaccio-${name}`;
-
-      // @ts-ignore
-      this.destinationPathName = (0, _nodePath.resolve)(this.projectName);
-      // @ts-ignore
-      this.props.name = this.projectName;
-    }.bind(this));
-  }
-  packageJSON() {
-    const {
-      pluginType
-    } = this.props;
-    const pkgJsonLocation = `${pluginType}/_package.json`;
-    this.fs.copyTpl(this.templatePath(pkgJsonLocation), this.destinationPath((0, _nodePath.resolve)(this.destinationPathName, 'package.json')), this.props);
-  }
-  writing() {
-    this.fs.copy(this.templatePath(`common/gitignore`), this.destinationPath((0, _nodePath.resolve)(this.destinationPathName, '.gitignore')));
-    this.fs.copy(this.templatePath(`common/npmignore`), this.destinationPath((0, _nodePath.resolve)(this.destinationPathName, '.npmignore')));
-    this.fs.copy(this.templatePath(`common/jest.config.js`), this.destinationPath((0, _nodePath.resolve)(this.destinationPathName, 'jest.config.js')));
-    this.fs.copyTpl(this.templatePath(`common/README.md`), this.destinationPath((0, _nodePath.resolve)(this.destinationPathName, 'README.md')), this.props);
-    this.fs.copyTpl(this.templatePath(`common/eslintrc`), this.destinationPath((0, _nodePath.resolve)(this.destinationPathName, '.eslintrc')), this.props);
-    this.fs.copyTpl(this.templatePath(`common/eslintignore`), this.destinationPath((0, _nodePath.resolve)(this.destinationPathName, '.eslintignore')), this.props);
-    this.fs.copy(this.templatePath(`${this.props.pluginType}/src`), this.destinationPath((0, _nodePath.resolve)(this.destinationPathName, 'src')));
-    this.fs.copy(this.templatePath(`common/index.js`), this.destinationPath((0, _nodePath.resolve)(this.destinationPathName, `index.js`)));
-    this.fs.copy(this.templatePath(`common/tsconfig.json`), this.destinationPath((0, _nodePath.resolve)(this.destinationPathName, 'tsconfig.json')));
-    this.fs.copy(this.templatePath(`${this.props.pluginType}/types`), this.destinationPath((0, _nodePath.resolve)(this.destinationPathName, 'types')));
-    this.fs.copy(this.templatePath(`common/editorconfig`), this.destinationPath((0, _nodePath.resolve)(this.destinationPathName, '.editorconfig')));
-  }
-  install() {
-    process.chdir(this.projectName);
-    // this.installDependencies({ npm: true, bower: false });
-  }
+    }
+    packageJSON() {
+        const { pluginType } = this.props;
+        if (!pluginType) {
+            this.log.error('pluginType is required');
+            return;
+        }
+        const pkg = this.fs.readJSON(this.templatePath(`${pluginType}/_package.json`));
+        // devDependencies
+        pkg.devDependencies['@types/node'] = package_json_1.default.devDependencies['@types/node'];
+        pkg.devDependencies['@types/express'] = package_json_1.default.devDependencies['@types/express'];
+        pkg.devDependencies['@types/debug'] = package_json_1.default.devDependencies['@types/debug'];
+        pkg.devDependencies['typescript'] = package_json_1.default.devDependencies['typescript'];
+        pkg.devDependencies['@verdaccio/types'] = package_json_1.default.devDependencies['@verdaccio/types'];
+        // required by verdaccio types
+        pkg.devDependencies['@types/jsonwebtoken'] = package_json_1.default.devDependencies['@types/jsonwebtoken'];
+        // dependencies
+        pkg.dependencies['@verdaccio/core'] = package_json_1.default.dependencies['@verdaccio/core'];
+        pkg.dependencies['@verdaccio/config'] = package_json_1.default.dependencies['@verdaccio/config'];
+        pkg.dependencies['debug'] = package_json_1.default.dependencies['debug'];
+        if (pluginType === 'auth') {
+            pkg.devDependencies['@verdaccio/auth'] = package_json_1.default.devDependencies['@verdaccio/auth'];
+        }
+        else if (pluginType === 'middleware') {
+            pkg.dependencies['express'] = package_json_1.default.dependencies['express'];
+        }
+        this.fs.writeJSON(this.templatePath(`${pluginType}/_package.json`), pkg);
+        this.fs.copyTpl(this.templatePath(`${pluginType}/_package.json`), this.destinationPath((0, node_path_1.resolve)(this.destinationPathName, 'package.json')), this.props);
+    }
+    writing() {
+        const dest = (path) => this.destinationPath((0, node_path_1.resolve)(this.destinationPathName, path));
+        this.fs.copy(this.templatePath('common/gitignore'), dest('.gitignore'));
+        this.fs.copy(this.templatePath('common/npmignore'), dest('.npmignore'));
+        this.fs.copy(this.templatePath('common/nvmrc'), dest('.nvmrc'));
+        this.fs.copyTpl(this.templatePath('common/README.md'), dest('README.md'), this.props);
+        this.fs.copy(this.templatePath(`${this.props.pluginType}/src`), dest('src'));
+        // this.fs.copy(this.templatePath('common/index.ts'), dest('index.ts'));
+        this.fs.copy(this.templatePath('common/tsconfig.json'), dest('tsconfig.json'));
+        this.fs.copy(this.templatePath(`${this.props.pluginType}/types`), dest('types'));
+        this.fs.copy(this.templatePath('common/editorconfig'), dest('.editorconfig'));
+    }
+    install() {
+        this.destinationRoot(this.projectName);
+    }
 }
-var _default = exports.default = PluginGenerator;
-//# sourceMappingURL=index.js.map
+exports.default = PluginGenerator;

package/generators/app/templates/auth/_package.json

@@ -7,27 +7,14 @@
   "engines": {
     "node": ">=18"
   },
-  "dependencies": {
-    "@verdaccio/commons-api": "10.2.0"
-  },
-  "devDependencies": {
-    "@types/jest": "27.5.1",
-    "@types/node": "12.12.5",
-    "@types/express": "4.17.13",
-    "@typescript-eslint/eslint-plugin": "5.26.0",
-    "@typescript-eslint/parser": "5.26.0",
-    "@verdaccio/types": "10.5.2",
-    "eslint": "8.21.0",
-    "jest": "28.1.3",
-    "typescript": "4.7.4"
-  },
+  "dependencies": {},
+  "devDependencies": {},
   "keywords": ["<%= keywords %>]"],
   "license": "<%= license %>",
   "repository": "<%= repository %>",
   "author": "<%= authorName %> <<%= authorEmail %>>",
   "scripts": {
     "build": "tsc",
-    "test": "jest .",
-    "lint": "eslint \"**/*.{js,ts}\""
+    "test": "echo \"Error: no test specified\" && exit 1"
   }
 }

package/generators/app/templates/auth/src/auth-plugin.ts

@@ -0,0 +1,102 @@
+import debugCore from 'debug';
+
+import {API_ERROR, errorUtils, pluginUtils} from '@verdaccio/core';
+import {Config, Logger, PackageAccess, RemoteUser} from '@verdaccio/types';
+
+import {CustomConfig} from '../types/index';
+
+const {Plugin} = pluginUtils;
+
+// Initialize debug logging
+// Replace 'custom-auth-plugin' with your plugin name
+// This code is meant to help during development and debugging
+const debug = debugCore('verdaccio:plugin:custom-auth-plugin');
+
+/**
+ * Custom Verdaccio Authenticate Plugin.
+ */
+export default class AuthCustomPlugin
+  extends Plugin<CustomConfig>
+  implements pluginUtils.Auth<CustomConfig> {
+  private _logger: Logger;
+  private _config: {};
+  private _app_config: Config;
+  public constructor(config: CustomConfig, appOptions: pluginUtils.PluginOptions) {
+    super(config, appOptions);
+    this._config = config;
+    this._logger = appOptions.logger;
+    this._app_config = appOptions.config;
+    debug('AuthCustomPlugin config: %o', this._config);
+    debug('App Config: %o', this._app_config);
+  }
+  /**
+   * Authenticate an user.
+   * @param user user to log
+   * @param password provided password
+   * @param cb callback function
+   */
+  public authenticate(user: string, password: string, cb: pluginUtils.AuthCallback): void {
+    debug('Authenticating user: %o', user);
+    debug('Password: %o', password);
+
+    // TODO: replace this code with your own authentication logic
+    // TODO: replace this code with your own authentication logic
+    // TODO: replace this code with your own authentication logic
+    if (password === 'verdaccio') {
+      this._logger.info(`User @{user} authenticated successfully`);
+      debug('User @{user} authenticated successfully', {user});
+      return cb(null, [user]);
+    } else {
+      this._logger.error(`User @{user} authentication failed`);
+      return cb(errorUtils.getUnauthorized(API_ERROR.BAD_USERNAME_PASSWORD));
+    }
+    // TODO: replace this code with your own authentication logic
+    // TODO: replace this code with your own authentication logic
+    // TODO: replace this code with your own authentication logic
+  }
+
+  public allow_access(user: RemoteUser, pkg: PackageAccess, cb: pluginUtils.AccessCallback): void {
+    debug('allow access for %o', user);
+    debug('package access list %o', pkg?.access);
+    // TODO: replace this code with your own access logic
+    // TODO: replace this code with your own access logic
+    // TODO: replace this code with your own access logic
+    if (pkg?.access?.includes('$anonymous')) {
+      debug('%o has been granted access', user?.name);
+      this._logger.info('Anonymous user granted access to package');
+      return cb(null, true);
+    } else if (pkg?.access?.includes('$all')) {
+      debug('%o has been granted access', user?.name);
+      this._logger.info('All users granted access to package');
+      return cb(null, false);
+    }
+    // TODO: replace this code with your own access logic
+    // TODO: replace this code with your own access logic
+    // TODO: replace this code with your own access logic
+  }
+
+  public allow_publish(
+      user: RemoteUser,
+      pkg: PackageAccess,
+      cb: pluginUtils.AuthAccessCallback,
+  ): void {
+    // TODO: replace this code with your own publish logic
+    // TODO: replace this code with your own publish logic
+    // TODO: replace this code with your own publish logic
+    // TODO: replace this code with your own publish logic
+    debug('allow publish for %o', user);
+    debug('package publish access list %o', pkg?.publish);
+    if (user?.name === 'verdaccio') {
+      debug('%o has been granted to publish', user?.name);
+      return cb(null, true);
+    } else {
+      const err = errorUtils.getForbidden('not allowed to publish package');
+      this._logger.error('%o not allowed to publish package');
+      debug('%o not allowed to publish package err %o', user?.name, err.message);
+      return cb(err);
+    }
+    // TODO: replace this code with your own publish logic
+    // TODO: replace this code with your own publish logic
+    // TODO: replace this code with your own publish logic
+  }
+}

package/generators/app/templates/auth/src/index.ts

@@ -1,92 +1,5 @@
-import { getInternalError } from '@verdaccio/commons-api';
-import {
-  AuthAccessCallback,
-  AuthCallback,
-  IPluginAuth,
-  Logger,
-  PackageAccess,
-  PluginOptions,
-  RemoteUser,
-} from '@verdaccio/types';
+import AuthPlugin from './auth-plugin';
 
-import { CustomConfig } from '../types/index';
+export {AuthPlugin};
 
-/**
- * Custom Verdaccio Authenticate Plugin.
- */
-export default class AuthCustomPlugin implements IPluginAuth<CustomConfig> {
-  public logger: Logger;
-  private foo: string;
-  public constructor(config: CustomConfig, options: PluginOptions<CustomConfig>) {
-    this.logger = options.logger;
-    this.foo = config.foo;
-    return this;
-  }
-  /**
-   * Authenticate an user.
-   * @param user user to log
-   * @param password provided password
-   * @param cb callback function
-   */
-  public authenticate(user: string, password: string, cb: AuthCallback): void {
-    /**
-     * This code is just an example for demostration purpose
-      if (this.foo) {
-        cb(null, ['group-foo', 'group-bar']);
-      } else {
-        cb(getInternalError("error, try again"), false);
-      }
-    */
-  }
-
-  /**
-   * Triggered on each access request
-   * @param user
-   * @param pkg
-   * @param cb
-   */
-  public allow_access(user: RemoteUser, pkg: PackageAccess, cb: AuthAccessCallback): void {
-    /**
-     * This code is just an example for demostration purpose
-    if (user.name === this.foo && pkg?.access?.includes[user.name]) {
-      this.logger.debug({name: user.name}, 'your package has been granted for @{name}');
-      cb(null, true)
-    } else {
-      this.logger.error({name: user.name}, '@{name} is not allowed to access this package');
-       cb(getInternalError("error, try again"), false);
-    }
-     */
-  }
-
-  /**
-   * Triggered on each publish request
-   * @param user
-   * @param pkg
-   * @param cb
-   */
-  public allow_publish(user: RemoteUser, pkg: PackageAccess, cb: AuthAccessCallback): void {
-    /**
-     * This code is just an example for demostration purpose
-    if (user.name === this.foo && pkg?.access?.includes[user.name]) {
-      this.logger.debug({name: user.name}, '@{name} has been granted to publish');
-      cb(null, true)
-    } else {
-      this.logger.error({name: user.name}, '@{name} is not allowed to publish this package');
-       cb(getInternalError("error, try again"), false);
-    }
-     */
-  }
-
-  public allow_unpublish(user: RemoteUser, pkg: PackageAccess, cb: AuthAccessCallback): void {
-    /**
-     * This code is just an example for demostration purpose
-    if (user.name === this.foo && pkg?.access?.includes[user.name]) {
-      this.logger.debug({name: user.name}, '@{name} has been granted to unpublish');
-      cb(null, true)
-    } else {
-      this.logger.error({name: user.name}, '@{name} is not allowed to publish this package');
-      cb(getInternalError("error, try again"), false);
-    }
-     */
-  }
-}
+export default AuthPlugin;

package/generators/app/templates/auth/types/index.ts

@@ -1,4 +1,4 @@
-import { Config } from '@verdaccio/types';
+import {Config} from '@verdaccio/types';
 
 export interface CustomConfig extends Config {
   foo: string;