@verdaccio/types 13.0.0-next-8.12 → 13.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +60 -0
- package/package.json +1 -1
- package/src/configuration.ts +2 -0
package/README.md
CHANGED
|
@@ -15,6 +15,66 @@
|
|
|
15
15
|
[](https://hub.docker.com/r/verdaccio/verdaccio)
|
|
16
16
|
[](https://github.com/verdaccio/verdaccio/stargazers)
|
|
17
17
|
|
|
18
|
+
> **Note:** This package is mostly for internal use by Verdaccio and is only intended to be used with Verdaccio 6.x.
|
|
19
|
+
|
|
20
|
+
## Overview
|
|
21
|
+
|
|
22
|
+
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.
|
|
23
|
+
|
|
24
|
+
## Installation
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npm install @verdaccio/types
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Usage
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
import type {
|
|
34
|
+
Config,
|
|
35
|
+
JWTSignOptions,
|
|
36
|
+
Logger,
|
|
37
|
+
Manifest,
|
|
38
|
+
Package,
|
|
39
|
+
PackageAccess,
|
|
40
|
+
RemoteUser,
|
|
41
|
+
SearchQuery,
|
|
42
|
+
SearchResults,
|
|
43
|
+
Version,
|
|
44
|
+
} from '@verdaccio/types';
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Type Categories
|
|
48
|
+
|
|
49
|
+
#### Plugin Types
|
|
50
|
+
|
|
51
|
+
- **`Auth`** - Authentication plugin interface
|
|
52
|
+
- **`Storage`** - Storage plugin interface
|
|
53
|
+
- **`ExpressMiddleware`** - Middleware plugin interface
|
|
54
|
+
|
|
55
|
+
#### Manifest Types
|
|
56
|
+
|
|
57
|
+
- **`Manifest`** - Package manifest definition
|
|
58
|
+
- **`Version`** - Package version metadata
|
|
59
|
+
- **`Package`** - Package information
|
|
60
|
+
|
|
61
|
+
#### Configuration Types
|
|
62
|
+
|
|
63
|
+
- **`Config`** - Verdaccio configuration object
|
|
64
|
+
- **`PackageAccess`** - Package access rules
|
|
65
|
+
- **`AuthPackageAllow`** - Auth-level package permissions
|
|
66
|
+
|
|
67
|
+
#### Common Types
|
|
68
|
+
|
|
69
|
+
- **`RemoteUser`** - Authenticated user information
|
|
70
|
+
- **`Logger`** - Logger interface
|
|
71
|
+
- **`JWTSignOptions`** - JWT signing options
|
|
72
|
+
|
|
73
|
+
#### Search Types
|
|
74
|
+
|
|
75
|
+
- **`SearchQuery`** - Search query parameters
|
|
76
|
+
- **`SearchResults`** - Search result format
|
|
77
|
+
|
|
18
78
|
## Donations
|
|
19
79
|
|
|
20
80
|
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.** 😉
|
package/package.json
CHANGED
package/src/configuration.ts
CHANGED
|
@@ -285,6 +285,8 @@ export type ServerSettingsConf = {
|
|
|
285
285
|
passwordValidationRegex?: RegExp;
|
|
286
286
|
// docs on `trustProxy` can be found at: https://expressjs.com/en/guide/behind-proxies.html
|
|
287
287
|
trustProxy?: string;
|
|
288
|
+
// Enable remote search on uplinks for the web UI search endpoint
|
|
289
|
+
searchRemote?: boolean;
|
|
288
290
|
};
|
|
289
291
|
|
|
290
292
|
/**
|