@verdaccio/types 9.7.2 → 11.0.0-6-next.9

package/README.md

@@ -3,6 +3,7 @@
 Typescript definitions for verdaccio plugins and internal code
 
 # Typescript
+
 For usage with the library, the `tsconfig.json` should looks like this.
 
 ```
@@ -44,5 +45,3 @@ import type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types';
   ...
 }
 ```
-
-

package/index.d.ts

@@ -1,5 +1,6 @@
-import { PassThrough } from 'stream';
+/// <reference types="node" />
 
+import { PassThrough } from 'stream';
 declare module '@verdaccio/types' {
   type StringValue = string | void | null;
 
@@ -7,13 +8,58 @@ declare module '@verdaccio/types' {
   type Callback = Function;
   // FIXME: err should be something flexible enough for any implementation
   type CallbackAction = (err: any | null) => void;
-  type CallbackError = (err: NodeJS.ErrnoException) => void;
   interface Author {
+    username?: string;
     name: string;
     email?: string;
     url?: string;
   }
 
+  type PackageManagers = 'pnpm' | 'yarn' | 'npm';
+
+  // FUTURE: WebConf and TemplateUIOptions should be merged .
+  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;
+    base: string;
+    primaryColor?: string;
+    version?: string;
+    logoURI?: string;
+  } & CommonWebConf;
+
+  /**
+   * Options on config.yaml for web
+   */
+  type WebConf = {
+    // FIXME: rename to primaryColor and move it to CommonWebConf
+    primary_color?: string;
+    enable?: boolean;
+    scriptsHead?: string[];
+    scriptsBodyAfter?: string[];
+    metaScripts?: string[];
+    bodyBefore?: string[];
+    bodyAfter?: string[];
+  } & CommonWebConf;
+
   interface Dist {
     integrity?: string;
     shasum: string;
@@ -136,7 +182,7 @@ declare module '@verdaccio/types' {
     name: string;
     versions: Versions;
     'dist-tags': GenericBody;
-    time?: GenericBody;
+    time: GenericBody;
     readme?: string;
     users?: PackageUsers;
     _distfiles: DistFiles;
@@ -145,12 +191,12 @@ declare module '@verdaccio/types' {
     _rev: string;
   }
 
-  class IUploadTarball extends PassThrough {
+  interface IUploadTarball extends PassThrough {
     abort(): void;
     done(): void;
   }
 
-  class IReadTarball extends PassThrough {
+  interface IReadTarball extends PassThrough {
     abort(): void;
   }
 
@@ -185,8 +231,18 @@ declare module '@verdaccio/types' {
     publish?: string[];
     proxy?: string[];
     access?: string[];
+    unpublish: string[];
+  }
+
+  // info passed to the auth plugin when a package is package is being published
+  interface AllowAccess {
+    name: string;
+    version?: string;
+    tag?: string;
   }
 
+  interface AuthPackageAllow extends PackageAccess, AllowAccess {}
+
   interface PackageList {
     [key: string]: PackageAccess;
   }
@@ -216,6 +272,7 @@ declare module '@verdaccio/types' {
     max_users: number;
   }
 
+  // FUTURE: rename to Notification
   interface Notifications {
     method: string;
     packagePattern: RegExp;
@@ -225,25 +282,7 @@ declare module '@verdaccio/types' {
     headers: Headers;
   }
 
-  interface ConfigFile {
-    storage: string;
-    plugins: string;
-    self_path: string;
-    packages: PackageList;
-    uplinks: UpLinksConfList;
-    logs: LoggerConf[];
-    web: WebConf;
-    auth: AuthConf;
-    publish?: PublishOptions;
-    url_prefix?: string;
-    listen?: ListenAddress;
-    https?: HttpsConf;
-    http_proxy?: string;
-    https_proxy?: string;
-    no_proxy?: string;
-    max_body_size?: string;
-    notifications: Notifications;
-  }
+  type Notification = Notifications;
 
   interface Token {
     user: string;
@@ -259,7 +298,6 @@ declare module '@verdaccio/types' {
     user: string;
   }
 
-  type SyncReturn = Error | void;
   type IPackageStorage = ILocalPackageManager | void;
   type IPackageStorageManager = ILocalPackageManager;
   type IPluginStorage<T> = ILocalData<T>;
@@ -283,16 +321,6 @@ declare module '@verdaccio/types' {
   interface ListenAddress {
     [key: string]: string;
   }
-
-  interface WebConf {
-    enable?: boolean;
-    title?: string;
-    logo?: string;
-    favicon?: string;
-    gravatar?: boolean;
-    sort_packages?: string;
-  }
-
   interface HttpsConfKeyCert {
     key: string;
     cert: string;
@@ -339,32 +367,71 @@ declare module '@verdaccio/types' {
     api: APITokenOptions;
   }
 
-  interface Config {
-    user_agent: string;
-    server_id: any;
+  interface ConfigFlags {
+    token?: boolean;
+    search?: boolean;
+    changePassword?: boolean;
+  }
+  export type RateLimit = {
+    windowMs: number;
+    max: number;
+  };
+
+  export type ServerSettingsConf = {
+    // express-rate-limit settings
+    rateLimit: RateLimit;
+    keepAliveTimeout?: number;
+    // force http2 if https is defined
+    http2?: boolean;
+  };
+
+  type URLPrefix = {
+    // if is false, it would be relative by default
+    absolute: boolean;
+    // base path
+    // eg: absolute: true, https://somedomain.com/xxx/
+    // eg: absolute: false, /xxx/ (default) if url_prefix is an string instead an object
+    basePath: string;
+  };
+
+  interface ConfigYaml {
     _debug?: boolean;
     storage?: string | void;
-    plugins?: string | void;
-    secret: string;
-    self_path: string;
     packages: PackageList;
     uplinks: UpLinksConfList;
+    // @deprecated in favor of log
     logs?: LoggerConf[];
+    log?: LoggerConf[];
     web?: WebConf;
     auth?: AuthConf;
     security: Security;
     publish?: PublishOptions;
-    url_prefix?: string;
     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?: ConfigFlags;
+  }
+
+  interface ConfigRuntime extends ConfigYaml {
+    config_path: string;
+  }
+
+  interface Config extends ConfigYaml, ConfigRuntime {
+    user_agent: string;
+    server_id: string;
+    secret: string;
+    // deprecated
     checkSecretKey(token: string): string;
     getMatchedPackagesSpec(storage: string): PackageAccess | void;
     [key: string]: any;
@@ -374,41 +441,25 @@ declare module '@verdaccio/types' {
     https: HttpsConf;
   }
 
-  interface ITokenActions {
+  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
+   * @deprecated use @verdaccio/core pluginUtils instead
    */
-  type onSearchPackage = (item: Package, cb: CallbackAction) => void;
-  // FIXME: error should be export type `VerdaccioError = HttpError & { code: number };`
-  // but this type is on @verdaccio/commons-api and cannot be used here yet
-  type onEndSearchPackage = (error?: any) => void;
-  type onValidatePackage = (name: string) => boolean;
-
   interface ILocalData<T> extends IPlugin<T>, ITokenActions {
     logger: Logger;
     config: T & Config;
-    add(name: string, callback: Callback): void;
-    remove(name: string, callback: Callback): void;
-    get(callback: Callback): void;
+    add(name: string): Promise<void>;
+    remove(name: string): Promise<void>;
+    get(): Promise<any>;
+    init(): Promise<void>;
     getSecret(): Promise<string>;
     setSecret(secret: string): Promise<any>;
     getPackageStorage(packageInfo: string): IPackageStorage;
-    search(onPackage: onSearchPackage, onEnd: onEndSearchPackage, validateName: onValidatePackage): void;
   }
 
   type StorageUpdateCallback = (data: Package, cb: CallbackAction) => void;
@@ -423,14 +474,14 @@ declare module '@verdaccio/types' {
     readTarball(pkgName: string): IReadTarball;
     readPackage(fileName: string, callback: ReadPackageCallback): void;
     createPackage(pkgName: string, value: Package, cb: CallbackAction): void;
-    deletePackage(fileName: string, callback: CallbackAction): void;
-    removePackage(callback: CallbackAction): void;
+    deletePackage(fileName: string): Promise<void>;
+    removePackage(): Promise<void>;
     updatePackage(
       pkgFileName: string,
       updateHandler: StorageUpdateCallback,
       onWrite: StorageWriteCallback,
       transformPackage: PackageTransformer,
-      onEnd: CallbackAction
+      onEnd: Callback
     ): void;
     savePackage(fileName: string, json: Package, callback: CallbackAction): void;
   }
@@ -442,41 +493,30 @@ declare module '@verdaccio/types' {
   }
 
   interface StoragePackageActions extends TarballActions {
-    addVersion(name: string, version: string, metadata: Version, tag: StringValue, callback: Callback): void;
+    addVersion(
+      name: string,
+      version: string,
+      metadata: Version,
+      tag: StringValue,
+      callback: Callback
+    ): void;
     mergeTags(name: string, tags: MergeTags, callback: Callback): void;
     removePackage(name: string, callback: Callback): void;
     changePackage(name: string, metadata: Package, revision: string, callback: Callback): void;
   }
 
-  interface IStorageManager<T> extends StoragePackageActions {
-    config: T & Config;
-    logger: Logger;
-    init(config: T & Config, filters: any): Promise<any>;
-    addPackage(name: string, metadata: any, callback: Callback): Promise<any>;
-    getPackage(options: any): void;
-    search(startkey: string, options: any): IReadTarball;
-    getLocalDatabase(callback: Callback): void;
-  }
-
-  interface IBasicStorage<T> extends StoragePackageActions {
-    addPackage(name: string, info: Package, callback: Callback): void;
-    updateVersions(name: string, packageInfo: Package, callback: Callback): void;
-    getPackageMetadata(name: string, callback: Callback): void;
-    search(startKey: string, options: any): IReadTarball;
-    getSecret(config: T & Config): Promise<any>;
-  }
-
+  // @deprecated use IBasicAuth from @verdaccio/auth
   interface IBasicAuth<T> {
     config: T & Config;
-    aesEncrypt(buf: Buffer): Buffer;
+    aesEncrypt(buf: string): string;
     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;
   }
 
-  class Plugin<T> {
-    constructor(config: T, options: PluginOptions<T>);
+  export interface Plugin<T> {
+    new (config: T, options: PluginOptions<T>): T;
   }
 
   interface IPlugin<T> {
@@ -490,14 +530,9 @@ declare module '@verdaccio/types' {
     logger: Logger;
   }
 
-  interface AllowAccess {
-    name: string;
-    version?: string;
-    tag?: string;
-  }
-
-  // FIXME: error should be export type `VerdaccioError = HttpError & { code: number };` instead of AuthError
-  // but this type is on @verdaccio/commons-api and cannot be used here yet (I don't know why)
+  // FIXME: error should be export type `VerdaccioError = HttpError & { code: number };`
+  // instead of AuthError
+  // but this type is on @verdaccio/core and cannot be used here yet (I don't know why)
   interface HttpError extends Error {
     status: number;
     statusCode: number;
@@ -516,17 +551,26 @@ declare module '@verdaccio/types' {
     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_publish?(user: RemoteUser, pkg: T & AuthPackageAllow, 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_unpublish?(user: RemoteUser, pkg: T & AuthPackageAllow, 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;
+    allow_unpublish?(
+      user: RemoteUser,
+      pkg: AllowAccess & PackageAccess,
+      cb: AuthAccessCallback
+    ): void;
     apiJWTmiddleware?(helpers: any): Function;
   }
 
+  // @deprecated use @verdaccio/server
   interface IPluginMiddleware<T> extends IPlugin<T> {
-    register_middlewares(app: any, auth: IBasicAuth<T>, storage: IStorageManager<T>): void;
+    register_middlewares(app: any, auth: IBasicAuth<T>, storage: any): void;
   }
 
   interface IPluginStorageFilter<T> extends IPlugin<T> {

package/package.json

@@ -1,22 +1,32 @@
 {
   "name": "@verdaccio/types",
-  "version": "9.7.2",
+  "version": "11.0.0-6-next.9",
   "description": "verdaccio types definitions",
   "keywords": [
-    "verdaccio",
-    "typescript",
-    "types"
+    "private",
+    "package",
+    "repository",
+    "registry",
+    "enterprise",
+    "modules",
+    "proxy",
+    "server",
+    "verdaccio"
   ],
   "author": "Juan Picado <juanpicado19@gmail.com>",
   "license": "MIT",
   "homepage": "https://verdaccio.org",
+  "engines": {
+    "node": ">=14",
+    "npm": ">=6"
+  },
   "repository": {
-    "type": "git",
-    "url": "https://github.com/verdaccio/monorepo",
-    "directory": "core/types"
+    "type": "https",
+    "url": "https://github.com/verdaccio/verdaccio",
+    "directory": "packages/core/types"
   },
   "bugs": {
-    "url": "https://github.com/verdaccio/monorepo/issues"
+    "url": "https://github.com/verdaccio/verdaccio/issues"
   },
   "publishConfig": {
     "access": "public"
@@ -24,13 +34,14 @@
   "main": "index.d.ts",
   "types": "index.d.ts",
   "scripts": {
-    "lint": "eslint \"**/*.{js,ts}\"",
-    "lint:stage": "lint-staged",
-    "test": "tsc --noEmit"
+    "test": "exit 0",
+    "build": "exit 0"
+  },
+  "devDependencies": {
+    "@types/node": "14.6.0"
   },
   "funding": {
     "type": "opencollective",
     "url": "https://opencollective.com/verdaccio"
-  },
-  "gitHead": "5c7d3c5af1bf28da8ffe61f73dfc6380b5e91679"
+  }
 }

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-  "compilerOptions": {
-      "target": "esnext",
-      "module": "commonjs",
-      "noImplicitAny": true,
-      "noImplicitThis": true,
-      "strictNullChecks": true,
-      "strictFunctionTypes": true,
-      "noEmit": true,
-      "forceConsistentCasingInFileNames": true
-  },
-  "typeRoots": [
-     "./node_modules/@types",
-      "./index.d.ts"
-  ],
-  "includes": [
-    "./index.d.ts"
-  ]
-}