@verdaccio/types 11.0.0-6-next.13 → 11.0.0-6-next.14

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Change Log
 
+## 11.0.0-6-next.14
+
+### Minor Changes
+
+- 37274e4c: feat: implement abbreviated manifest
+
+  Enable abbreviated manifest data by adding the header:
+
+  ```
+  curl -H "Accept: application/vnd.npm.install-v1+json" https://registry.npmjs.org/verdaccio
+  ```
+
+  It returns a filtered manifest, additionally includes the [time](https://github.com/pnpm/rfcs/pull/2) field by request.
+
+  Current support for packages managers:
+
+  - npm: yes
+  - pnpm: yes
+  - yarn classic: yes
+  - yarn modern (+2.x): [no](https://github.com/yarnpkg/berry/pull/3981#issuecomment-1076566096)
+
+  https://github.com/npm/registry/blob/master/docs/responses/package-metadata.md#abbreviated-metadata-format
+
 ## 11.0.0-6-next.13
 
 ### Major Changes

package/build/manifest.d.ts

@@ -76,7 +76,6 @@ export interface Tags {
 export interface Version {
     name: string;
     version: string;
-    devDependencies?: string;
     directories?: any;
     dist: Dist;
     author: string | Author;
@@ -97,7 +96,11 @@ export interface Version {
     scripts?: any;
     homepage?: string;
     etag?: string;
-    dependencies: any;
+    dependencies?: Dependencies;
+    peerDependencies?: Dependencies;
+    devDependencies?: Dependencies;
+    optionalDependencies?: Dependencies;
+    bundleDependencies?: Dependencies;
     keywords?: string | string[];
     nodeVersion?: string;
     _id: string;
@@ -105,6 +108,18 @@ export interface Version {
     _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;
@@ -178,6 +193,17 @@ export interface Manifest extends FullRemoteManifest, PublishManifest {
      */
     _rev: string;
 }
+export declare type AbbreviatedVersion = Pick<Version, 'name' | 'version' | 'description' | 'dependencies' | 'devDependencies' | 'bin' | 'dist' | 'engines' | 'funding' | 'peerDependencies'>;
+export interface AbbreviatedVersions {
+    [key: string]: AbbreviatedVersion;
+}
+/**
+ *
+ */
+export declare type AbbreviatedManifest = Pick<Manifest, 'name' | 'dist-tags' | 'time'> & {
+    modified: string;
+    versions: AbbreviatedVersions;
+};
 export interface PublishManifest {
     /**
      * The `_attachments` object has different usages:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdaccio/types",
-  "version": "11.0.0-6-next.13",
+  "version": "11.0.0-6-next.14",
   "description": "verdaccio types definitions",
   "keywords": [
     "private",
@@ -34,7 +34,7 @@
   "main": "build/types.d.ts",
   "types": "build/types.d.ts",
   "devDependencies": {
-    "@types/node": "16.11.47",
+    "@types/node": "16.11.51",
     "typedoc": "beta",
     "typedoc-plugin-missing-exports": "1.0.0"
   },

package/src/manifest.ts

@@ -92,7 +92,6 @@ export interface Tags {
 export interface Version {
   name: string;
   version: string;
-  devDependencies?: string;
   directories?: any;
   dist: Dist;
   author: string | Author;
@@ -113,7 +112,11 @@ export interface Version {
   scripts?: any;
   homepage?: string;
   etag?: string;
-  dependencies: any;
+  dependencies?: Dependencies;
+  peerDependencies?: Dependencies;
+  devDependencies?: Dependencies;
+  optionalDependencies?: Dependencies;
+  bundleDependencies?: Dependencies;
   keywords?: string | string[];
   nodeVersion?: string;
   _id: string;
@@ -121,6 +124,17 @@ export interface Version {
   _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 {
@@ -194,6 +208,32 @@ export interface Manifest extends FullRemoteManifest, PublishManifest {
    */
   _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: