@verdaccio/types - npm Package Compare versions

Comparing version 10.1.0 to 10.2.0

CHANGELOG.md

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

index.d.ts

@@ -296,2 +296,3 @@ // <reference types="node" />
     sort_packages?: string;
+    rateLimit?: RateLimit;
   }
@@ -340,11 +341,23 @@
 
+  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;
@@ -415,3 +428,7 @@ plugins?: string | void;
     getPackageStorage(packageInfo: string): IPackageStorage;
-    search(onPackage: onSearchPackage, onEnd: onEndSearchPackage, validateName: onValidatePackage): void;
+    search(
+      onPackage: onSearchPackage,
+      onEnd: onEndSearchPackage,
+      validateName: onValidatePackage
+    ): void;
   }
@@ -450,3 +467,9 @@
   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;
@@ -528,5 +551,13 @@ removePackage(name: string, callback: Callback): 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;
@@ -533,0 +564,0 @@ }

package.json

 {
   "name": "@verdaccio/types",
-  "version": "10.1.0",
+  "version": "10.2.0",
   "description": "verdaccio types definitions",
@@ -36,3 +36,4 @@ "keywords": [
     "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"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

39473

increased by3.69%

Lines of code

493

increased by6.25%

Worsened metrics

Published versions last two months

1

decreased by-50%

No dependency changes