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

package/CHANGELOG.md

@@ -1,5 +1,89 @@
 # Change Log
 
+## 11.0.0-6-next.12
+
+### Minor Changes
+
+- d43894e8: feat: rework web header for mobile, add new settings and raw manifest button
+
+  ### New set of variables to hide features
+
+  Add set of new variables that allow hide different parts of the UI, buttons, footer or download tarballs. _All are
+  enabled by default_.
+
+  ```yaml
+  # login: true <-- already exist but worth the reminder
+  # showInfo: true
+  # showSettings: true
+  # In combination with darkMode you can force specific theme
+  # showThemeSwitch: true
+  # showFooter: true
+  # showSearch: true
+  # showDownloadTarball: true
+  ```
+
+  > If you disable `showThemeSwitch` and force `darkMode: true` the local storage settings would be
+  > ignored and force all themes to the one in the configuration file.
+
+  Future could be extended to
+
+  ### Raw button to display manifest package
+
+  A new experimental feature (enabled by default), button named RAW to be able navigate on the package manifest directly on the ui, kudos to [react-json-view](https://www.npmjs.com/package/react-json-view) that allows an easy integration, not configurable yet until get more feedback.
+
+  ```yaml
+  showRaw: true
+  ```
+
+  #### Rework header buttons
+
+  - The header has been rework, the mobile was not looking broken.
+  - Removed info button in the header and moved to a dialog
+  - Info dialog now contains more information about the project, license and the aid content for Ukrania now is inside of the info modal.
+  - Separate settings and info to avoid collapse too much info (for mobile still need some work)
+
+## 11.0.0-6-next.11
+
+### Major Changes
+
+- 82cb0f2b: feat!: config.logs throw an error, logging config not longer accept array or logs property
+
+  ### 💥 Breaking change
+
+  This is valid
+
+  ```yaml
+  log: { type: stdout, format: pretty, level: http }
+  ```
+
+  This is invalid
+
+  ```yaml
+  logs: { type: stdout, format: pretty, level: http }
+  ```
+
+  or
+
+  ```yaml
+  logs:
+    - [{ type: stdout, format: pretty, level: http }]
+  ```
+
+### Minor Changes
+
+- 5167bb52: feat: ui search support for remote, local and private packages
+
+  The command `npm search` search globally and return all matches, with this improvement the user interface
+  is powered with the same capabilities.
+
+  The UI also tag where is the origin the package with a tag, also provide the latest version and description of the package.
+
+## 11.0.0-6-next.10
+
+### Major Changes
+
+- 000d4374: feat: upgrade to material ui 5
+
 ## 11.0.0-6-next.9
 
 ### Major Changes

package/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
-
 import { PassThrough } from 'stream';
+
 declare module '@verdaccio/types' {
   type StringValue = string | void | null;
 
@@ -40,10 +40,21 @@ declare module '@verdaccio/types' {
     darkMode?: boolean;
     protocol?: string;
     host?: string;
+    // deprecated
+    basename?: string;
+    scope?: string;
+    showInfo?: boolean;
+    showSettings?: boolean;
+    showSearch?: boolean;
+    showFooter?: boolean;
+    showThemeSwitch?: boolean;
+    showDownloadTarball?: boolean;
+    showRaw?: boolean;
     base: string;
     primaryColor?: string;
     version?: string;
     logoURI?: string;
+    flags: FlagsConfig;
   } & CommonWebConf;
 
   /**
@@ -177,6 +188,9 @@ declare module '@verdaccio/types' {
     [key: string]: boolean;
   }
 
+  /**
+   * @deprecated use Manifest instead
+   */
   interface Package {
     _id?: string;
     name: string;
@@ -191,6 +205,20 @@ declare module '@verdaccio/types' {
     _rev: string;
   }
 
+  interface Manifest {
+    _id?: string;
+    name: string;
+    versions: Versions;
+    'dist-tags': GenericBody;
+    time: GenericBody;
+    readme?: string;
+    users?: PackageUsers;
+    _distfiles: DistFiles;
+    _attachments: AttachMents;
+    _uplinks: UpLinks;
+    _rev: string;
+  }
+
   interface IUploadTarball extends PassThrough {
     abort(): void;
     done(): void;
@@ -314,10 +342,6 @@ declare module '@verdaccio/types' {
     sync(): void;
   }
 
-  interface LoggerConf {
-    [key: string]: LoggerConfItem;
-  }
-
   interface ListenAddress {
     [key: string]: string;
   }
@@ -367,11 +391,11 @@ declare module '@verdaccio/types' {
     api: APITokenOptions;
   }
 
-  interface ConfigFlags {
-    token?: boolean;
-    search?: boolean;
+  export type FlagsConfig = {
+    searchRemote?: boolean;
     changePassword?: boolean;
-  }
+  };
+
   export type RateLimit = {
     windowMs: number;
     max: number;
@@ -399,9 +423,8 @@ declare module '@verdaccio/types' {
     storage?: string | void;
     packages: PackageList;
     uplinks: UpLinksConfList;
-    // @deprecated in favor of log
-    logs?: LoggerConf[];
-    log?: LoggerConf[];
+    // FUTURE: log should be mandatory
+    log?: LoggerConfItem;
     web?: WebConf;
     auth?: AuthConf;
     security: Security;
@@ -420,7 +443,7 @@ declare module '@verdaccio/types' {
     filters?: any;
     url_prefix?: string;
     server?: ServerSettingsConf;
-    flags?: ConfigFlags;
+    flags?: FlagsConfig;
   }
 
   interface ConfigRuntime extends ConfigYaml {
@@ -437,6 +460,29 @@ declare module '@verdaccio/types' {
     [key: string]: any;
   }
 
+  type PublisherMaintainer = {
+    username: string;
+    email: string;
+  };
+
+  type SearchPackageBody = {
+    name: string;
+    scope: string;
+    description: string;
+    author: string | PublisherMaintainer;
+    version: string;
+    keywords: string | string[] | undefined;
+    date: string;
+    links?: {
+      npm: string; // only include placeholder for URL eg: {url}/{packageName}
+      homepage?: string;
+      repository?: string;
+      bugs?: string;
+    };
+    publisher?: any;
+    maintainers?: PublisherMaintainer[];
+  };
+
   interface ConfigWithHttps extends Config {
     https: HttpsConf;
   }
@@ -476,6 +522,7 @@ declare module '@verdaccio/types' {
     createPackage(pkgName: string, value: Package, cb: CallbackAction): void;
     deletePackage(fileName: string): Promise<void>;
     removePackage(): Promise<void>;
+    // @deprecated
     updatePackage(
       pkgFileName: string,
       updateHandler: StorageUpdateCallback,
@@ -483,7 +530,14 @@ declare module '@verdaccio/types' {
       transformPackage: PackageTransformer,
       onEnd: Callback
     ): void;
+    // @deprecated
     savePackage(fileName: string, json: Package, callback: CallbackAction): void;
+    //  next packages migration (this list is meant to replace the callback parent functions)
+    updatePackageNext(
+      packageName: string,
+      handleUpdate: (manifest: Package) => Promise<Package>
+    ): Promise<Package>;
+    savePackageNext(name: string, value: Package): Promise<void>;
   }
 
   interface TarballActions {
@@ -576,4 +630,10 @@ declare module '@verdaccio/types' {
   interface IPluginStorageFilter<T> extends IPlugin<T> {
     filter_metadata(packageInfo: Package): Promise<Package>;
   }
+
+  export type SearchResultWeb = {
+    name: string;
+    version: string;
+    description: string;
+  };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdaccio/types",
-  "version": "11.0.0-6-next.9",
+  "version": "11.0.0-6-next.12",
   "description": "verdaccio types definitions",
   "keywords": [
     "private",
@@ -38,7 +38,8 @@
     "build": "exit 0"
   },
   "devDependencies": {
-    "@types/node": "14.6.0"
+    "@types/node": "16.11.21",
+    "tsd": "0.19.1"
   },
   "funding": {
     "type": "opencollective",