@verdaccio/types 11.0.0-6-next.23 → 11.0.0-6-next.25

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## 11.0.0-6-next.25
+
+### Minor Changes
+
+- 16e38df8: feat: trustProxy property
+
+## 11.0.0-6-next.24
+
+### Patch Changes
+
+- 7ef599cc: fix: missing version on footer
+
 ## 11.0.0-6-next.23
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdaccio/types",
-  "version": "11.0.0-6-next.23",
+  "version": "11.0.0-6-next.25",
   "description": "verdaccio types definitions",
   "keywords": [
     "private",
@@ -30,8 +30,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "build/types.d.ts",
-  "types": "build/types.d.ts",
+  "main": "src/types.ts",
+  "types": "src/types.ts",
   "devDependencies": {
     "@types/node": "16.18.10",
     "typedoc": "0.23.25"
@@ -50,7 +50,7 @@
     "test": "pnpm type-check",
     "build:docs": "typedoc --options ./typedoc.json --tsconfig tsconfig.build.json",
     "type-check": "tsc --noEmit -p tsconfig.build.json",
-    "build": "tsc --emitDeclarationOnly -p tsconfig.build.json"
+    "build": "echo 0"
   },
   "readme": "# @verdaccio/types\n\nTypeScript definitions for Verdaccio plugins and internal code.\n"
 }

package/src/configuration.ts

@@ -75,16 +75,6 @@ export type RateLimit = {
   max?: number;
 };
 
-// export interface WebConf {
-//   enable?: boolean;
-//   title?: string;
-//   logo?: string;
-//   favicon?: string;
-//   gravatar?: boolean;
-//   sort_packages?: string;
-//   rateLimit?: RateLimit;
-// }
-
 export type FlagsConfig = {
   searchRemote?: boolean;
   changePassword?: boolean;
@@ -105,6 +95,14 @@ export type CommonWebConf = {
   login?: boolean;
   scope?: string;
   pkgManagers?: PackageManagers[];
+  showInfo?: boolean;
+  showSettings?: boolean;
+  showSearch?: boolean;
+  showFooter?: boolean;
+  showThemeSwitch?: boolean;
+  showDownloadTarball?: boolean;
+  primaryColor: string;
+  showRaw?: boolean;
 };
 
 /**
@@ -112,21 +110,11 @@ export type CommonWebConf = {
  */
 export type TemplateUIOptions = {
   uri?: string;
-  darkMode?: boolean;
   protocol?: string;
   host?: string;
-  // deprecated
+  // @deprecated use base instead
   basename?: string;
-  scope?: string;
-  showInfo?: boolean;
-  showSettings?: boolean;
-  showSearch?: boolean;
-  showFooter?: boolean;
-  showThemeSwitch?: boolean;
-  showDownloadTarball?: boolean;
-  showRaw?: boolean;
   base: string;
-  primaryColor: string;
   version?: string;
   flags: FlagsConfig;
 } & CommonWebConf;
@@ -135,14 +123,18 @@ export type TemplateUIOptions = {
  * Options on config.yaml for web
  */
 export type WebConf = {
-  // FIXME: rename to primaryColor and move it to CommonWebConf
+  // @deprecated use primaryColor
   primary_color?: string;
+  primaryColor?: string;
   enable?: boolean;
   scriptsHead?: string[];
   scriptsBodyAfter?: string[];
+  scriptsbodyBefore?: string[];
   metaScripts?: string[];
   bodyBefore?: string[];
   bodyAfter?: string[];
+  rateLimit?: RateLimit;
+  html_cache?: boolean;
 } & CommonWebConf;
 
 export interface UpLinksConfList {
@@ -234,6 +226,8 @@ export type ServerSettingsConf = {
    */
   pluginPrefix?: string;
   passwordValidationRegex?: RegExp;
+  // docs on `trustProxy` can be found at: https://expressjs.com/en/guide/behind-proxies.html
+  trustProxy?: string;
 };
 
 /**
@@ -267,10 +261,13 @@ export interface ConfigYaml {
   url_prefix?: string;
   server?: ServerSettingsConf;
   flags?: FlagsConfig;
+  // @deprecated use flags instead
+  experiments?: FlagsConfig;
   userRateLimit?: RateLimit;
   // internal objects, added by internal yaml to JS config parser
   // save the configuration file path
   configPath?: string;
+  i18n?: { web: string };
 }
 
 /**

package/src/manifest.ts

@@ -89,6 +89,12 @@ export interface Tags {
   [key: string]: Version;
 }
 
+export interface PeerDependenciesMeta {
+  [dependencyName: string]: {
+    optional?: boolean;
+  };
+}
+
 export interface Version {
   name: string;
   version: string;
@@ -116,6 +122,7 @@ export interface Version {
   peerDependencies?: Dependencies;
   devDependencies?: Dependencies;
   optionalDependencies?: Dependencies;
+  peerDependenciesMeta?: PeerDependenciesMeta;
   bundleDependencies?: Dependencies;
   keywords?: string | string[];
   nodeVersion?: string;
@@ -127,6 +134,8 @@ export interface Version {
   funding?: { type: string; url: string };
   engines?: Engines;
   hasInstallScript?: boolean;
+  cpu?: string[];
+  os?: string[];
 }
 
 export interface Dependencies {

package/build/commons.d.ts

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

package/build/configuration.d.ts

@@ -1,247 +0,0 @@
-import { PackageAccess, PackageList } from '@verdaccio/types/src/manifest';
-export 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 type LoggerType = 'stdout' | 'file';
-export type LoggerFormat = 'pretty' | 'pretty-timestamped' | 'json';
-export type LoggerLevel = 'http' | 'fatal' | 'warn' | 'info' | 'debug' | 'trace';
-export 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 type RateLimit = {
-    windowMs?: number;
-    max?: number;
-};
-export type FlagsConfig = {
-    searchRemote?: boolean;
-    changePassword?: boolean;
-};
-export type PackageManagers = 'pnpm' | 'yarn' | 'npm';
-export 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 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;
-    flags: FlagsConfig;
-} & CommonWebConf;
-/**
- * Options on config.yaml for web
- */
-export 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 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 {
-    enhancedLegacySignature?: boolean;
-    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 type HttpsConf = HttpsConfKeyCert | HttpsConfPfx;
-export interface Notifications {
-    method: string;
-    packagePattern: RegExp;
-    packagePatternFlags: string;
-    endpoint: string;
-    content: string;
-    headers: Headers;
-}
-export type Notification = Notifications;
-export type ServerSettingsConf = {
-    rateLimit: RateLimit;
-    keepAliveTimeout?: number;
-    /**
-     * Plugins should be prefixed verdaccio-XXXXXX by default.
-     * To override the default prefix, use this property without `-`
-     * If you set pluginPrefix: acme, the packages to resolve will be
-     * acme-XXXXXX
-     */
-    pluginPrefix?: string;
-    passwordValidationRegex?: RegExp;
-};
-/**
- * YAML configuration file available options.
- */
-export interface ConfigYaml {
-    _debug?: boolean;
-    storage?: string | void;
-    packages: PackageList;
-    uplinks: UpLinksConfList;
-    log?: LoggerConfItem;
-    logs?: LoggerConfItem;
-    web?: WebConf;
-    auth?: AuthConf;
-    security: Security;
-    publish?: PublishOptions;
-    store?: any;
-    listen?: ListenAddress;
-    https?: HttpsConf;
-    user_agent?: string;
-    http_proxy?: string;
-    plugins?: string | void | null;
-    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;
-    userRateLimit?: RateLimit;
-    configPath?: string;
-}
-/**
- * Configuration object with additional methods for configuration, includes yaml and internal medatada.
- * @interface Config
- * @extends {ConfigYaml}
- */
-export interface Config extends Omit<ConfigYaml, 'packages' | 'security' | 'configPath'> {
-    server_id: string;
-    secret: string;
-    configPath: string;
-    self_path?: 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

@@ -1,228 +0,0 @@
-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;
-    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?: Dependencies;
-    peerDependencies?: Dependencies;
-    devDependencies?: Dependencies;
-    optionalDependencies?: Dependencies;
-    bundleDependencies?: Dependencies;
-    keywords?: string | string[];
-    nodeVersion?: string;
-    _id: string;
-    _npmVersion?: string;
-    _npmUser: Author;
-    _hasShrinkwrap?: boolean;
-    deprecated?: string;
-    funding?: {
-        type: string;
-        url: string;
-    };
-    engines?: Engines;
-    hasInstallScript?: boolean;
-}
-export interface Dependencies {
-    [key: string]: string;
-}
-export interface Engines {
-    [key: string]: 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[];
-    author?: string | Author;
-}
-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 type AbbreviatedVersion = Pick<Version, 'name' | 'version' | 'description' | 'dependencies' | 'devDependencies' | 'bin' | 'dist' | 'engines' | 'funding' | 'peerDependencies'>;
-export interface AbbreviatedVersions {
-    [key: string]: AbbreviatedVersion;
-}
-/**
- *
- */
-export type AbbreviatedManifest = Pick<Manifest, 'name' | 'dist-tags' | 'time'> & {
-    modified: string;
-    versions: AbbreviatedVersions;
-};
-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/index.d.ts

@@ -1 +0,0 @@
-export * from '@verdaccio/types/src/plugins/storage';

package/build/plugins/storage.d.ts

@@ -1,37 +0,0 @@
-import { Callback, CallbackAction } from '@verdaccio/types/src/commons';
-import { Manifest, Token } from '@verdaccio/types/src/manifest';
-export type StorageList = string[];
-export interface ILocalStorage {
-    add(name: string): void;
-    remove(name: string): void;
-    get(): StorageList;
-    sync(): void;
-}
-export interface TokenFilter {
-    user: string;
-}
-export interface ITokenActions {
-    saveToken(token: Token): Promise<any>;
-    deleteToken(user: string, tokenKey: string): Promise<any>;
-    readTokens(filter: TokenFilter): Promise<Token[]>;
-}
-/**
- * This method expect return a Package object
- * eg:
- * {
- *   name: string;
- *   time: number;
- *   ... and other props
- * }
- *
- * The `cb` callback object will be executed if:
- *  - it might return object (truly)
- *  - it might reutrn null
- */
-export type onSearchPackage = (item: Manifest, cb: CallbackAction) => void;
-export type onEndSearchPackage = (error?: any) => void;
-export type onValidatePackage = (name: string) => boolean;
-export type StorageUpdateCallback = (data: Manifest, cb: CallbackAction) => void;
-export type StorageWriteCallback = (name: string, json: Manifest, callback: Callback) => void;
-export type PackageTransformer = (pkg: Manifest) => Manifest;
-export type ReadPackageCallback = (err: any | null, data?: Manifest) => void;

package/build/search.d.ts

@@ -1,26 +0,0 @@
-export type PublisherMaintainer = {
-    username: string;
-    email: string;
-};
-export type SearchPackageBody = {
-    name: string;
-    scope: string;
-    description: string;
-    author: string | PublisherMaintainer;
-    version: string;
-    keywords: string | string[] | undefined;
-    date: string;
-    links?: {
-        npm: string;
-        homepage?: string;
-        repository?: string;
-        bugs?: string;
-    };
-    publisher?: any;
-    maintainers?: PublisherMaintainer[];
-};
-export type SearchResultWeb = {
-    name: string;
-    version: string;
-    description: string;
-};

package/build/types.d.ts

@@ -1,5 +0,0 @@
-export * from '@verdaccio/types/src/plugins';
-export * from '@verdaccio/types/src/manifest';
-export * from '@verdaccio/types/src/search';
-export * from '@verdaccio/types/src/commons';
-export * from '@verdaccio/types/src/configuration';