@verdaccio/types - npm Package Compare versions

Comparing version 11.0.0-6-next.12 to 11.0.0-6-next.13

CHANGELOG.md

 # 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
@@ -4,0 +40,0 @@

package.json

 {
   "name": "@verdaccio/types",
-  "version": "11.0.0-6-next.12",
+  "version": "11.0.0-6-next.13",
   "description": "verdaccio types definitions",
@@ -34,16 +34,26 @@ "keywords": [
   },
-  "main": "index.d.ts",
-  "types": "index.d.ts",
-  "scripts": {
-    "test": "exit 0",
-    "build": "exit 0"
-  },
+  "main": "build/types.d.ts",
+  "types": "build/types.d.ts",
   "devDependencies": {
-    "@types/node": "16.11.21",
-    "tsd": "0.19.1"
+    "@types/node": "16.11.47",
+    "typedoc": "beta",
+    "typedoc-plugin-missing-exports": "1.0.0"
   },
+  "typedoc": {
+    "entryPoint": "./src/types.ts",
+    "readmeFile": "./README.md",
+    "displayName": "@verdaccio/types"
+  },
   "funding": {
     "type": "opencollective",
     "url": "https://opencollective.com/verdaccio"
-  }
-}
+  },
+  "scripts": {
+    "clean": "rimraf ./build",
+    "test": "pnpm type-check",
+    "build:docs": "typedoc --options ./typedoc.json --excludeExternals --tsconfig tsconfig.build.json",
+    "type-check": "tsc --noEmit -p tsconfig.build.json",
+    "build": "tsc --emitDeclarationOnly -p tsconfig.build.json"
+  },
+  "readme": "# @verdaccio/types\n\nTypeScript definitions for Verdaccio plugins and internal code.\n\n### Usage\n\n```ts\nimport type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types';\n\nclass LocalData implements ILocalData {\n  path: string;\n  logger: Logger;\n  data: LocalStorage;\n  config: Config;\n  locked: boolean;\n  ...\n}\n```\n\n### Run docs\n\nGenerate the package types documentation at `./docs` folder.\n\n```bash\n pnpm build:docs\n```\n"
+}

README.md

@@ -1,40 +0,11 @@
-# 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;
@@ -48,1 +19,9 @@ logger: Logger;
 ```
+
+### Run docs
+
+Generate the package types documentation at `./docs` folder.
+
+```bash
+ pnpm build:docs
+```

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

74388

increased by52.35%

Number of package files

32

increased by433.33%

Lines of code

1346

increased by136.97%

Worsened metrics

Dev dependency count

3

increased by50%

Number of lines in readme file

27

decreased by-43.75%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes