verdaccio/website/translated_docs/ru/dev-plugins.md

id	title
dev-plugins	Разработка плагинов

Есть много способов расширить verdaccio, поддерживаются следующие типы плагинов:

• Плагин аутентификации
• Middleware плагины (начиная с v2.7.0)
• Плагины для хранения с (v3.x)

Мы рекомендуем разрабатывать плагины с использованием flow type definitions.

Плагин аутентификации

В основном мы должны возвращать объект с помощью одного метода, называемого authenticate, который должен принимать три аругмента (user, password, callback).

API

interface IPluginAuth extends IPlugin {
  login_url?: string;
  authenticate(user: string, password: string, cb: Callback): void;
  adduser(user: string, password: string, cb: Callback): void;
  allow_access(user: RemoteUser, pkg: $Subtype<PackageAccess>, cb: Callback): void;
  allow_publish(user: RemoteUser, pkg: $Subtype<PackageAccess>, cb: Callback): void;
}

Необязательными являются только adduser, allow_access и allow_publish, verdaccio предоставляет запасной вариант в этих случаях.

Callback

После того как аутентификация была выполнена, verdaccio может быть возвращено только два ответа.

OnError

Либо что-то пошло не так, либо аутентификация была не удачной.

callback(null, false)

OnSuccess

Аутентификация прошла успешно.

groups это массив строк с именами групп, в которых пользователь состоит.

 callback(null, groups);

Пример

function Auth(config, stuff) {
  var self = Object.create(Auth.prototype);
  self._users = {};

  // конфигурация для этого модуля
  self._config = config;

  // verdaccio logger
  self._logger = stuff.logger;

  // pass verdaccio logger to ldapauth
  self._config.client_options.log = stuff.logger;

  return self;
}

Auth.prototype.authenticate = function (user, password, callback) {
  var LdapClient = new LdapAuth(self._config.client_options);
  ....
  LdapClient.authenticate(user, password, function (err, ldapUser) {
    ...
    var groups;
     ...
    callback(null, groups);
  });
};

module.exports = Auth;

И конфигурация будет выглядеть как-то так:

auth:
  htpasswd:
    file: ./htpasswd

Где htpasswd это суфикс имени плагина. Например: verdaccio-htpasswd и остальная часть тела должна быть конфигурацией плагина.

Middleware плагин

Middleware плагины могут менять API, добавляя конечные обработчики или перехватывая запросы.

interface verdaccio$IPluginMiddleware extends verdaccio$IPlugin {
  register_middlewares(app: any, auth: IBasicAuth, storage: IStorageManager): void;
}

register_middlewares

Метод предоставляет полный доступ к аутентификации и хранилищу через auth и storage. app это приложение express, которое позволяет добавлять новые обработчики запросов (так называемые endpoint).

Очень хорошим примером middleware-плагина является sinopia-github-oauth и verdaccio-audit.

API

function register_middlewares(expressApp, authInstance, storageInstance) {
   /* реализация плагина */
}

Для регистрации плагина, нам нужен объект с единственным методом, называемым register_middlewares, который принимает три аргумента (expressApp, auth, storage). Auth это экземпляр авторизации и storage так же является экземпляром главного хранилища, который предоставит доступ ко всем действиям над ним.

Плагин хранилища

По умолчанию Verdaccio использует плагин хранилища в файловой системе local-storage, но, начиная с verdaccio@3.x вы можете устновить свой плагин хранлища, заменив тем самым поведение по умолчанию.

API

API хранилища немного сложнее, вам потребуется создать класс, реализующий интерфейс IPluginStorage. Детали представлены ниже.

class LocalDatabase<IPluginStorage>{
  constructor(config: $Subtype<verdaccio$Config>, logger: verdaccio$Logger): ILocalData;
}

interface IPluginStorage {
  logger: verdaccio$Logger;
    config: $Subtype<verdaccio$Config>;
  add(name: string, callback: verdaccio$Callback): void;
  remove(name: string, callback: verdaccio$Callback): void;
  get(callback: verdaccio$Callback): void;
  getSecret(): Promise<string>;
  setSecret(secret: string): Promise<any>;
  getPackageStorage(packageInfo: string): verdaccio$IPackageStorage;
  search(onPackage: verdaccio$Callback, onEnd: verdaccio$Callback, validateName: Function): void;
}

interface IPackageStorageManager {
  path: string;
  logger: verdaccio$Logger;
  writeTarball(name: string): verdaccio$IUploadTarball;
  readTarball(name: string): verdaccio$IReadTarball;
  readPackage(fileName: string, callback: verdaccio$Callback): void;
  createPackage(name: string, value: verdaccio$Package, cb: verdaccio$Callback): void;
  deletePackage(fileName: string, callback: verdaccio$Callback): void;
  removePackage(callback: verdaccio$Callback): void;
  updatePackage(pkgFileName: string,
                updateHandler: verdaccio$Callback,
                onWrite: verdaccio$Callback,
                transformPackage: Function,
                onEnd: verdaccio$Callback): void;
  savePackage(fileName: string, json: verdaccio$Package, callback: verdaccio$Callback): void;
}

class verdaccio$IUploadTarball extends stream$PassThrough {
  abort: Function;
  done: Function;
  _transform: Function;
  abort(): void;
  done(): void;
}

class verdaccio$IReadTarball extends stream$PassThrough {
  abort: Function;
  abort(): void;
}

API хранилища всё ещё остаётся экспериментальным и может измениться в следующих минорных версиях. Для получения актуальной информации о API Хранилища пожалуйста перейдите к типам определённым в нашем репозитории.

Пример плагина хранилища

Данный список плагинов реализует API Хранилища и может использоваться вами как пример.

• verdaccio-memory
• local-storage
• verdaccio-google-cloud
• verdaccio-s3-storage

Вы собираетесь способствовать разработке нового плагина хранилища? Загляните сюда.