@verdaccio/types 10.1.0 → 10.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 10.2.0
+
+### Minor Changes
+
+- 96b62c8: feat: add rate limit and convert user agent type to boolean
+
 ## 10.1.0
 
 ### Minor Changes

package/index.d.ts

@@ -293,6 +293,7 @@ declare module '@verdaccio/types' {
     favicon?: string;
     gravatar?: boolean;
     sort_packages?: string;
+    rateLimit?: RateLimit;
   }
 
   interface HttpsConfKeyCert {
@@ -336,15 +337,27 @@ declare module '@verdaccio/types' {
     jwt?: JWTOptions;
   }
 
+  type RateLimit = {
+    windowMs?: number;
+    max?: number;
+  };
+
   interface Security {
     web: JWTOptions;
     api: APITokenOptions;
+    userRateLimit: RateLimit;
   }
 
+  type Server = {
+    keepAliveTimeout?: number;
+    rateLimit: RateLimit;
+  };
+
   interface Config {
-    user_agent: string;
+    user_agent: boolean;
     server_id: any;
     _debug?: boolean;
+    server?: Server;
     storage?: string | void;
     plugins?: string | void;
     secret: string;
@@ -410,7 +423,11 @@ declare module '@verdaccio/types' {
     getSecret(): Promise<string>;
     setSecret(secret: string): Promise<any>;
     getPackageStorage(packageInfo: string): IPackageStorage;
-    search(onPackage: onSearchPackage, onEnd: onEndSearchPackage, validateName: onValidatePackage): void;
+    search(
+      onPackage: onSearchPackage,
+      onEnd: onEndSearchPackage,
+      validateName: onValidatePackage
+    ): void;
   }
 
   type StorageUpdateCallback = (data: Package, cb: CallbackAction) => void;
@@ -444,7 +461,13 @@ 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;
@@ -521,9 +544,17 @@ declare module '@verdaccio/types' {
     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_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;
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdaccio/types",
-  "version": "10.1.0",
+  "version": "10.2.0",
   "description": "verdaccio types definitions",
   "keywords": [
     "verdaccio",
@@ -33,5 +33,6 @@
   "scripts": {
     "test": "exit 0",
     "build": "exit 0"
-  }
+  },
+  "readme": "# Typescript types for Verdaccio\n\nTypescript definitions for verdaccio plugins and internal code\n\n# Typescript\nFor usage with the library, the `tsconfig.json` should looks like this.\n\n```\n//tsconfig.json\n{\n  \"compilerOptions\": {\n    \"target\": \"esnext\",\n    \"module\": \"commonjs\",\n    \"declaration\": true,\n    \"noImplicitAny\": false,\n    \"strict\": true,\n    \"outDir\": \"lib\",\n    \"allowSyntheticDefaultImports\": true,\n    \"esModuleInterop\": true,\n    \"typeRoots\": [\n      \"./node_modules/@verdaccio/types/lib/verdaccio\",\n      \"./node_modules/@types\"\n    ]\n  },\n  \"include\": [\n    \"src/*.ts\",\n    \"types/*.d.ts\"\n  ]\n}\n```\n\n### Imports\n\n```\nimport type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types';\n\n class LocalData implements ILocalData {\n\n  path: string;\n  logger: Logger;\n  data: LocalStorage;\n  config: Config;\n  locked: boolean;\n  ...\n}\n```\n\n\n"
 }