@verdaccio/types

@verdaccio/types - Verdaccio Type Definitions

Note: This package is mostly for internal use by Verdaccio and is only intended to be used with Verdaccio 6.x.

Overview

The @verdaccio/types package provides all TypeScript type definitions used throughout the Verdaccio ecosystem. It serves as the single entry point for types related to plugins, manifests, configuration, search, and common interfaces.

Installation

npm install @verdaccio/types

Usage

import type {
  Config,
  JWTSignOptions,
  Logger,
  Manifest,
  Package,
  PackageAccess,
  RemoteUser,
  SearchQuery,
  SearchResults,
  Version,
} from '@verdaccio/types';

Type Categories

Plugin Types

• Auth - Authentication plugin interface
• Storage - Storage plugin interface
• ExpressMiddleware - Middleware plugin interface

Manifest Types

• Manifest - Package manifest definition
• Version - Package version metadata
• Package - Package information

Configuration Types

• Config - Verdaccio configuration object
• PackageAccess - Package access rules
• AuthPackageAllow - Auth-level package permissions

Common Types

• RemoteUser - Authenticated user information
• Logger - Logger interface
• JWTSignOptions - JWT signing options

Search Types

• SearchQuery - Search query parameters
• SearchResults - Search result format

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 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.

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]

Open Collective Backers

Thank you to all our backers! [Become a backer]

Special Thanks

Thanks to the following companies to help us to achieve our goals providing free open source licenses.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

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
• Donations
• Reporting an issue
• Running discussions
• Chat
• Logos
• Docker Examples
• FAQ

License

Verdaccio is MIT licensed

The Verdaccio documentation and logos (excluding /thanks, e.g., .md, .png, .sketch files within the /assets folder) are Creative Commons licensed.