@verdaccio/types 11.0.0-6-next.12 → 11.0.0-6-next.13

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # Change Log
 
+## 11.0.0-6-next.13
+
+### Major Changes
+
+- 292c0a37: feat!: replace deprecated request dependency by got
+
+  This is a big refactoring of the core, fetching dependencies, improve code, more tests and better stability. This is essential for the next release, will take some time but would allow modularize more the core.
+
+  ## Notes
+
+  - Remove deprecated `request` by other `got`, retry improved, custom Agent ( got does not include it built-in)
+  - Remove `async` dependency from storage (used by core) it was linked with proxy somehow safe to remove now
+  - Refactor with promises instead callback wherever is possible
+  - ~Document the API~
+  - Improve testing, integration tests
+  - Bugfix
+  - Clean up old validations
+  - Improve performance
+
+  ## 💥 Breaking changes
+
+  - Plugin API methods were callbacks based are returning promises, this will break current storage plugins, check documentation for upgrade.
+  - Write Tarball, Read Tarball methods parameters change, a new set of options like `AbortController` signals are being provided to the `addAbortSignal` can be internally used with Streams when a request is aborted. eg: `addAbortSignal(signal, fs.createReadStream(pathName));`
+  - `@verdaccio/streams` stream abort support is legacy is being deprecated removed
+  - Remove AWS and Google Cloud packages for future refactoring [#2574](https://github.com/verdaccio/verdaccio/pull/2574).
+
+- a3a209b5: feat: migrate to pino.js 8
+
+### Minor Changes
+
+- 5cf041a1: feat: add dist.signatures to core/types
+
+  According to [`npm`](https://docs.npmjs.com/about-registry-signatures): _"Signatures are provided in the package's `packument` in each published version within the `dist` object"_
+
+  Here's an [example of a package version from the public npm registry with `dist.signatures`](https://registry.npmjs.org/light-cycle/1.4.3).
+
 ## 11.0.0-6-next.12
 
 ### Minor Changes

package/README.md

@@ -1,42 +1,13 @@
-# Typescript types for Verdaccio
+# @verdaccio/types
 
-Typescript definitions for verdaccio plugins and internal code
+TypeScript definitions for Verdaccio plugins and internal code.
 
-# Typescript
+### Usage
 
-For usage with the library, the `tsconfig.json` should looks like this.
-
-```
-//tsconfig.json
-{
-  "compilerOptions": {
-    "target": "esnext",
-    "module": "commonjs",
-    "declaration": true,
-    "noImplicitAny": false,
-    "strict": true,
-    "outDir": "lib",
-    "allowSyntheticDefaultImports": true,
-    "esModuleInterop": true,
-    "typeRoots": [
-      "./node_modules/@verdaccio/types/lib/verdaccio",
-      "./node_modules/@types"
-    ]
-  },
-  "include": [
-    "src/*.ts",
-    "types/*.d.ts"
-  ]
-}
-```
-
-### Imports
-
-```
+```ts
 import type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types';
 
- class LocalData implements ILocalData {
-
+class LocalData implements ILocalData {
   path: string;
   logger: Logger;
   data: LocalStorage;
@@ -45,3 +16,11 @@ import type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types';
   ...
 }
 ```
+
+### Run docs
+
+Generate the package types documentation at `./docs` folder.
+
+```bash
+ pnpm build:docs
+```

package/build/commons.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="node" />
+export declare type Callback = Function;
+export declare type CallbackAction = (err: any | null) => void;
+export declare type CallbackError = (err: NodeJS.ErrnoException) => void;
+export interface RemoteUser {
+    real_groups: string[];
+    groups: string[];
+    name: string | void;
+    error?: string;
+}
+export declare type StringValue = string | void | null;
+export interface HttpError extends Error {
+    status: number;
+    statusCode: number;
+    expose: boolean;
+    headers?: {
+        [key: string]: string;
+    };
+    [key: string]: any;
+}
+export declare type URLPrefix = {
+    absolute: boolean;
+    basePath: string;
+};

package/build/configuration.d.ts

@@ -0,0 +1,237 @@
+import { PackageAccess, PackageList } from './manifest';
+export declare type TypeToken = 'Bearer' | 'Basic';
+export interface Logger {
+    child: (conf: any) => any;
+    debug: (conf: any, template?: string) => void;
+    error: (conf: any, template?: string) => void;
+    http: (conf: any, template?: string) => void;
+    trace: (conf: any, template?: string) => void;
+    warn: (conf: any, template?: string) => void;
+    info: (conf: any, template?: string) => void;
+}
+export declare type LoggerType = 'stdout' | 'file';
+export declare type LoggerFormat = 'pretty' | 'pretty-timestamped' | 'json';
+export declare type LoggerLevel = 'http' | 'fatal' | 'warn' | 'info' | 'debug' | 'trace';
+export declare type LoggerConfigItem = {
+    type?: LoggerType;
+    /**
+     * The format
+     */
+    format?: LoggerFormat;
+    path?: string;
+    level?: string;
+    colors?: boolean;
+    async?: boolean;
+};
+export interface ConfigWithHttps extends Config {
+    https: HttpsConf;
+}
+export interface PackageAccessYaml {
+    storage?: string;
+    publish?: string;
+    proxy?: string;
+    access?: string;
+    unpublish?: string;
+}
+export interface LoggerConfItem {
+    type: LoggerType;
+    format: LoggerFormat;
+    level: LoggerLevel;
+}
+export interface Headers {
+    [key: string]: string;
+}
+export interface UpLinkTokenConf {
+    type: TypeToken;
+    token?: string;
+    token_env?: boolean | string;
+}
+export interface UpLinkConf {
+    url: string;
+    ca?: string;
+    cache?: boolean;
+    timeout?: string | void;
+    maxage?: string | void;
+    max_fails?: number | void;
+    fail_timeout?: string | void;
+    headers?: Headers;
+    auth?: UpLinkTokenConf;
+    strict_ssl?: boolean | void;
+    _autogenerated?: boolean;
+}
+export declare type RateLimit = {
+    windowMs?: number;
+    max?: number;
+};
+export declare type FlagsConfig = {
+    searchRemote?: boolean;
+    changePassword?: boolean;
+};
+export declare type PackageManagers = 'pnpm' | 'yarn' | 'npm';
+export declare type CommonWebConf = {
+    title?: string;
+    logo?: string;
+    favicon?: string;
+    gravatar?: boolean;
+    sort_packages?: string;
+    darkMode?: boolean;
+    url_prefix?: string;
+    language?: string;
+    login?: boolean;
+    scope?: string;
+    pkgManagers?: PackageManagers[];
+};
+/**
+ * Options are passed to the index.html
+ */
+export declare type TemplateUIOptions = {
+    uri?: string;
+    darkMode?: boolean;
+    protocol?: string;
+    host?: string;
+    basename?: string;
+    scope?: string;
+    showInfo?: boolean;
+    showSettings?: boolean;
+    showSearch?: boolean;
+    showFooter?: boolean;
+    showThemeSwitch?: boolean;
+    showDownloadTarball?: boolean;
+    showRaw?: boolean;
+    base: string;
+    primaryColor?: string;
+    version?: string;
+    logoURI?: string;
+    flags: FlagsConfig;
+} & CommonWebConf;
+/**
+ * Options on config.yaml for web
+ */
+export declare type WebConf = {
+    primary_color?: string;
+    enable?: boolean;
+    scriptsHead?: string[];
+    scriptsBodyAfter?: string[];
+    metaScripts?: string[];
+    bodyBefore?: string[];
+    bodyAfter?: string[];
+} & CommonWebConf;
+export interface UpLinksConfList {
+    [key: string]: UpLinkConf;
+}
+export interface AuthHtpasswd {
+    file: string;
+    max_users: number;
+}
+export declare type AuthConf = any | AuthHtpasswd;
+export interface JWTOptions {
+    sign: JWTSignOptions;
+    verify: JWTVerifyOptions;
+}
+export interface JWTSignOptions {
+    algorithm?: string;
+    expiresIn?: string;
+    notBefore?: string;
+    ignoreExpiration?: boolean;
+    maxAge?: string | number;
+    clockTimestamp?: number;
+}
+export interface JWTVerifyOptions {
+    algorithm?: string;
+    expiresIn?: string;
+    notBefore?: string | number;
+    ignoreExpiration?: boolean;
+    maxAge?: string | number;
+    clockTimestamp?: number;
+}
+export interface APITokenOptions {
+    legacy: boolean;
+    jwt?: JWTOptions;
+}
+export interface Security {
+    web: JWTOptions;
+    api: APITokenOptions;
+}
+export interface PublishOptions {
+    allow_offline: boolean;
+}
+export interface ListenAddress {
+    [key: string]: string;
+}
+export interface HttpsConfKeyCert {
+    key: string;
+    cert: string;
+    ca?: string;
+}
+export interface HttpsConfPfx {
+    pfx: string;
+    passphrase?: string;
+}
+export declare type HttpsConf = HttpsConfKeyCert | HttpsConfPfx;
+export interface Notifications {
+    method: string;
+    packagePattern: RegExp;
+    packagePatternFlags: string;
+    endpoint: string;
+    content: string;
+    headers: Headers;
+}
+export declare type Notification = Notifications;
+export declare type ServerSettingsConf = {
+    rateLimit: RateLimit;
+    keepAliveTimeout?: number;
+};
+/**
+ * YAML configuration file available options.
+ */
+export interface ConfigYaml {
+    _debug?: boolean;
+    storage?: string | void;
+    packages: PackageList;
+    uplinks: UpLinksConfList;
+    log?: LoggerConfItem;
+    web?: WebConf;
+    auth?: AuthConf;
+    security: Security;
+    publish?: PublishOptions;
+    store?: any;
+    listen?: ListenAddress;
+    https?: HttpsConf;
+    http_proxy?: string;
+    plugins?: string | void;
+    https_proxy?: string;
+    no_proxy?: string;
+    max_body_size?: string;
+    notifications?: Notifications;
+    notify?: Notifications | Notifications[];
+    middlewares?: any;
+    filters?: any;
+    url_prefix?: string;
+    server?: ServerSettingsConf;
+    flags?: FlagsConfig;
+    config_path?: string;
+    configPath?: string;
+}
+/**
+ * Configuration object with additonal methods for configuration, includes yaml and internal medatada.
+ * @interface Config
+ * @extends {ConfigYaml}
+ */
+export interface Config extends Omit<ConfigYaml, 'packages' | 'security' | 'configPath'> {
+    user_agent: string;
+    server_id: string;
+    secret: string;
+    configPath: string;
+    packages: PackageList;
+    security: Security;
+    checkSecretKey(token: string): string;
+    getMatchedPackagesSpec(storage: string): PackageAccess | void;
+    [key: string]: any;
+}
+export interface AllowAccess {
+    name: string;
+    version?: string;
+    tag?: string;
+}
+export interface AuthPackageAllow extends PackageAccess, AllowAccess {
+}

package/build/manifest.d.ts

@@ -0,0 +1,201 @@
+export interface PackageAccess {
+    storage?: string;
+    publish?: string[];
+    proxy?: string[];
+    access?: string[];
+    unpublish: string[];
+}
+export interface PackageList {
+    [key: string]: PackageAccess;
+}
+export interface MergeTags {
+    [key: string]: string;
+}
+export interface DistFile {
+    url: string;
+    sha: string;
+    registry?: string;
+}
+export interface DistFiles {
+    [key: string]: DistFile;
+}
+export interface Token {
+    user: string;
+    token: string;
+    key: string;
+    cidr?: string[];
+    readonly: boolean;
+    created: number | string;
+    updated?: number | string;
+}
+export interface AttachMents {
+    [key: string]: AttachMentsItem;
+}
+export interface AttachMentsItem {
+    content_type?: string;
+    data?: string;
+    length?: number;
+    shasum?: string;
+    version?: string;
+}
+export interface GenericBody {
+    [key: string]: string;
+}
+export interface UpLinkMetadata {
+    etag: string;
+    fetched: number;
+}
+export interface UpLinks {
+    [key: string]: UpLinkMetadata;
+}
+export interface Signatures {
+    keyid: string;
+    sig: string;
+}
+export interface Dist {
+    'npm-signature'?: string;
+    signatures?: Signatures[];
+    fileCount?: number;
+    integrity?: string;
+    shasum: string;
+    unpackedSize?: number;
+    tarball: string;
+}
+export interface Author {
+    username?: string;
+    name: string;
+    email?: string;
+    url?: string;
+}
+export interface PackageUsers {
+    [key: string]: boolean;
+}
+export interface Tags {
+    [key: string]: Version;
+}
+export interface Version {
+    name: string;
+    version: string;
+    devDependencies?: string;
+    directories?: any;
+    dist: Dist;
+    author: string | Author;
+    main: string;
+    homemage?: string;
+    license?: string;
+    readme: string;
+    readmeFileName?: string;
+    readmeFilename?: string;
+    description: string;
+    bin?: string;
+    bugs?: any;
+    files?: string[];
+    gitHead?: string;
+    maintainers?: Author[];
+    contributors?: Author[];
+    repository?: string | any;
+    scripts?: any;
+    homepage?: string;
+    etag?: string;
+    dependencies: any;
+    keywords?: string | string[];
+    nodeVersion?: string;
+    _id: string;
+    _npmVersion?: string;
+    _npmUser: Author;
+    _hasShrinkwrap?: boolean;
+    deprecated?: string;
+}
+export interface Versions {
+    [key: string]: Version;
+}
+/**
+ * @deprecated use Manifest instead
+ */
+export interface Package {
+    _id?: string;
+    name: string;
+    versions: Versions;
+    'dist-tags': GenericBody;
+    time: GenericBody;
+    readme?: string;
+    users?: PackageUsers;
+    _distfiles: DistFiles;
+    _attachments: AttachMents;
+    _uplinks: UpLinks;
+    _rev: string;
+}
+/**
+ * Represents upstream manifest from another registry
+ */
+export interface FullRemoteManifest {
+    _id?: string;
+    _rev?: string;
+    name: string;
+    description?: string;
+    'dist-tags': GenericBody;
+    time: GenericBody;
+    versions: Versions;
+    maintainers?: Author[];
+    /** store the latest readme **/
+    readme?: string;
+    /** store star assigned to this packages by users */
+    users?: PackageUsers;
+    access?: any;
+    bugs?: {
+        url: string;
+    };
+    license?: string;
+    homepage?: string;
+    repository?: string | {
+        type?: string;
+        url: string;
+        directory?: string;
+    };
+    keywords?: string[];
+}
+export interface Manifest extends FullRemoteManifest, PublishManifest {
+    /**
+     * store fast access to the dist url of an specific tarball, instead search version
+     * by id, just the tarball id is faster.
+     *
+     * The _distfiles is created only when a package is being sync from an upstream.
+     * also used to fetch tarballs from upstream, the private publish tarballs are not stored in
+     * this object because they are not published in the upstream registry.
+     */
+    _distfiles: DistFiles;
+    /**
+     * Store access cache metadata, to avoid to fetch the same metadata multiple times.
+     *
+     * The key represents the uplink id which is composed of a etag and a fetched timestamp.
+     *
+     * The fetched timestamp is the time when the metadata was fetched, used to avoid to fetch the
+     * same metadata until the metadata is older than the last fetch.
+     */
+    _uplinks: UpLinks;
+    /**
+     * store the revision of the manifest
+     */
+    _rev: string;
+}
+export interface PublishManifest {
+    /**
+     * The `_attachments` object has different usages:
+     *
+     * - When a package is published, it contains the tarball as an string, this string is used to be
+     * converted as a tarball, usually attached to the package but not stored in the database.
+     * - If user runs `npm star` the _attachments will be at the manifest body but empty.
+     *
+     * It has also an internal usage:
+     *
+     * - Used as a cache for the tarball, quick access to the tarball shasum, etc. Instead
+     * iterate versions and find the right one, just using the tarball as a key which is what
+     * the package manager sends to the registry.
+     *
+     * - A `_attachments` object is added every time a private tarball is published, upstream cached tarballs are
+     * not being part of this object, only for published private packages.
+     *
+     * Note: This field is removed when the package is accesed through the web user interface.
+     * */
+    _attachments: AttachMents;
+}

package/build/plugins/auth.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="node" />
+import { Callback, HttpError, RemoteUser } from '../commons';
+import { Config } from '../configuration';
+export interface AuthPluginPackage {
+    packageName: string;
+    packageVersion?: string;
+    tag?: string;
+}
+export declare type AuthError = HttpError & {
+    code: number;
+};
+export declare type AuthAccessCallback = (error: AuthError | null, access: boolean) => void;
+export declare type AuthCallback = (error: AuthError | null, groups: string[] | false) => void;
+export interface IBasicAuth<T> {
+    config: T & Config;
+    aesEncrypt(buf: Buffer): Buffer;
+    authenticate(user: string, password: string, cb: Callback): void;
+    changePassword(user: string, password: string, newPassword: string, cb: Callback): void;
+    allow_access(pkg: AuthPluginPackage, user: RemoteUser, callback: Callback): void;
+    add_user(user: string, password: string, cb: Callback): any;
+}

package/build/plugins/commons.d.ts

@@ -0,0 +1,11 @@
+import { Config, Logger } from '../configuration';
+export declare class Plugin<T> {
+    constructor(config: T, options: PluginOptions<T>);
+}
+export interface IPlugin<T> {
+    version?: string;
+}
+export interface PluginOptions<T> {
+    config: T & Config;
+    logger: Logger;
+}

package/build/plugins/filter.d.ts

@@ -0,0 +1,5 @@
+import { Manifest } from '../manifest';
+import { IPlugin } from './commons';
+export interface IPluginStorageFilter<T> extends IPlugin<T> {
+    filter_metadata(packageInfo: Manifest): Promise<Manifest>;
+}

package/build/plugins/index.d.ts

@@ -0,0 +1,25 @@
+import { RemoteUser } from '../commons';
+import { AllowAccess } from '../configuration';
+import { PackageAccess } from '../manifest';
+import { AuthAccessCallback, AuthCallback } from './auth';
+import { IPlugin } from './commons';
+export interface IPluginAuth<T> extends IPlugin<T> {
+    /**
+     * @param props user from Application component
+     */
+    authenticate(user: string, password: string, cb: AuthCallback): void;
+    adduser?(user: string, password: string, cb: AuthCallback): void;
+    changePassword?(user: string, password: string, newPassword: string, cb: AuthCallback): void;
+    allow_publish?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;
+    allow_access?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;
+    allow_unpublish?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;
+    allow_publish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
+    allow_access?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
+    allow_unpublish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
+    apiJWTmiddleware?(helpers: any): Function;
+}
+export * from './auth';
+export * from './storage';
+export * from './middleware';
+export * from './commons';
+export * from './filter';

package/build/plugins/middleware.d.ts

@@ -0,0 +1,5 @@
+import { IBasicAuth } from './auth';
+import { IPlugin } from './commons';
+export interface IPluginMiddleware<T, K> extends IPlugin<T> {
+    register_middlewares(app: any, auth: IBasicAuth<T>, storage: K): void;
+}