@verdaccio/types 11.0.0-6-next.17 → 11.0.0-6-next.18

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Change Log
 
+## 11.0.0-6-next.18
+
+### Major Changes
+
+- 99978797: feat(web): components for custom user interfaces
+
+  Provides a package that includes all components from the user interface, instead being embedded at the `@verdaccio/ui-theme` package.
+
+  ```
+  npm i -D @verdaccio/ui-components
+  ```
+
+  The package contains
+
+  - Components
+  - Providers
+  - Redux Storage
+  - Layouts (precomposed layouts ready to use)
+  - Custom Material Theme
+
+  The `@verdaccio/ui-theme` will consume this package and will use only those are need it.
+
+  > Prerequisites are using Redux, Material-UI and Translations with `i18next`.
+
+  Users could have their own Material UI theme and build custom layouts, adding new features without the need to modify the default project.
+
 ## 11.0.0-6-next.17
 
 ### Major Changes

package/README.md

@@ -1,26 +1,3 @@
 # @verdaccio/types
 
 TypeScript definitions for Verdaccio plugins and internal code.
-
-### Usage
-
-```ts
-import type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types';
-
-class LocalData implements ILocalData {
-  path: string;
-  logger: Logger;
-  data: LocalStorage;
-  config: Config;
-  locked: boolean;
-  ...
-}
-```
-
-### Run docs
-
-Generate the package types documentation at `./docs` folder.
-
-```bash
- pnpm build:docs
-```

package/build/commons.d.ts

@@ -1,14 +1,14 @@
 /// <reference types="node" />
-export declare type Callback = Function;
-export declare type CallbackAction = (err: any | null) => void;
-export declare type CallbackError = (err: NodeJS.ErrnoException) => void;
+export type Callback = Function;
+export type CallbackAction = (err: any | null) => void;
+export type CallbackError = (err: NodeJS.ErrnoException) => void;
 export interface RemoteUser {
     real_groups: string[];
     groups: string[];
     name: string | void;
     error?: string;
 }
-export declare type StringValue = string | void | null;
+export type StringValue = string | void | null;
 export interface HttpError extends Error {
     status: number;
     statusCode: number;
@@ -18,7 +18,7 @@ export interface HttpError extends Error {
     };
     [key: string]: any;
 }
-export declare type URLPrefix = {
+export type URLPrefix = {
     absolute: boolean;
     basePath: string;
 };

package/build/configuration.d.ts

@@ -1,5 +1,5 @@
 import { PackageAccess, PackageList } from './manifest';
-export declare type TypeToken = 'Bearer' | 'Basic';
+export type TypeToken = 'Bearer' | 'Basic';
 export interface Logger {
     child: (conf: any) => any;
     debug: (conf: any, template?: string) => void;
@@ -9,10 +9,10 @@ export interface Logger {
     warn: (conf: any, template?: string) => void;
     info: (conf: any, template?: string) => void;
 }
-export declare type LoggerType = 'stdout' | 'file';
-export declare type LoggerFormat = 'pretty' | 'pretty-timestamped' | 'json';
-export declare type LoggerLevel = 'http' | 'fatal' | 'warn' | 'info' | 'debug' | 'trace';
-export declare type LoggerConfigItem = {
+export type LoggerType = 'stdout' | 'file';
+export type LoggerFormat = 'pretty' | 'pretty-timestamped' | 'json';
+export type LoggerLevel = 'http' | 'fatal' | 'warn' | 'info' | 'debug' | 'trace';
+export type LoggerConfigItem = {
     type?: LoggerType;
     /**
      * The format
@@ -59,16 +59,16 @@ export interface UpLinkConf {
     strict_ssl?: boolean | void;
     _autogenerated?: boolean;
 }
-export declare type RateLimit = {
+export type RateLimit = {
     windowMs?: number;
     max?: number;
 };
-export declare type FlagsConfig = {
+export type FlagsConfig = {
     searchRemote?: boolean;
     changePassword?: boolean;
 };
-export declare type PackageManagers = 'pnpm' | 'yarn' | 'npm';
-export declare type CommonWebConf = {
+export type PackageManagers = 'pnpm' | 'yarn' | 'npm';
+export type CommonWebConf = {
     title?: string;
     logo?: string;
     favicon?: string;
@@ -84,7 +84,7 @@ export declare type CommonWebConf = {
 /**
  * Options are passed to the index.html
  */
-export declare type TemplateUIOptions = {
+export type TemplateUIOptions = {
     uri?: string;
     darkMode?: boolean;
     protocol?: string;
@@ -99,7 +99,7 @@ export declare type TemplateUIOptions = {
     showDownloadTarball?: boolean;
     showRaw?: boolean;
     base: string;
-    primaryColor?: string;
+    primaryColor: string;
     version?: string;
     logoURI?: string;
     flags: FlagsConfig;
@@ -107,7 +107,7 @@ export declare type TemplateUIOptions = {
 /**
  * Options on config.yaml for web
  */
-export declare type WebConf = {
+export type WebConf = {
     primary_color?: string;
     enable?: boolean;
     scriptsHead?: string[];
@@ -123,7 +123,7 @@ export interface AuthHtpasswd {
     file: string;
     max_users: number;
 }
-export declare type AuthConf = any | AuthHtpasswd;
+export type AuthConf = any | AuthHtpasswd;
 export interface JWTOptions {
     sign: JWTSignOptions;
     verify: JWTVerifyOptions;
@@ -167,7 +167,7 @@ export interface HttpsConfPfx {
     pfx: string;
     passphrase?: string;
 }
-export declare type HttpsConf = HttpsConfKeyCert | HttpsConfPfx;
+export type HttpsConf = HttpsConfKeyCert | HttpsConfPfx;
 export interface Notifications {
     method: string;
     packagePattern: RegExp;
@@ -176,8 +176,8 @@ export interface Notifications {
     content: string;
     headers: Headers;
 }
-export declare type Notification = Notifications;
-export declare type ServerSettingsConf = {
+export type Notification = Notifications;
+export type ServerSettingsConf = {
     rateLimit: RateLimit;
     keepAliveTimeout?: number;
     /**

package/build/manifest.d.ts

@@ -194,14 +194,14 @@ 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 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'> & {
+export type AbbreviatedManifest = Pick<Manifest, 'name' | 'dist-tags' | 'time'> & {
     modified: string;
     versions: AbbreviatedVersions;
 };

package/build/plugins/index.d.ts

@@ -1,25 +1 @@
-import { RemoteUser } from '../commons';
-import { AllowAccess } from '../configuration';
-import { PackageAccess } from '../manifest';
-import { AuthAccessCallback, AuthCallback } from './auth';
-import { IPlugin } from './commons';
-export interface IPluginAuth<T> extends IPlugin<T> {
-    /**
-     * @param props user from Application component
-     */
-    authenticate(user: string, password: string, cb: AuthCallback): void;
-    adduser?(user: string, password: string, cb: AuthCallback): void;
-    changePassword?(user: string, password: string, newPassword: string, cb: AuthCallback): void;
-    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_access?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
-    allow_unpublish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
-    apiJWTmiddleware?(helpers: any): Function;
-}
-export * from './auth';
 export * from './storage';
-export * from './middleware';
-export * from './commons';
-export * from './filter';

package/build/plugins/storage.d.ts

@@ -1,14 +1,6 @@
-/// <reference types="node" />
-import { Readable, Writable } from 'stream';
 import { Callback, CallbackAction } from '../commons';
-import { Logger } from '../configuration';
 import { Manifest, Token } from '../manifest';
-import { IPlugin } from './commons';
-export declare type StorageList = string[];
-export interface LocalStorage {
-    list: any;
-    secret: string;
-}
+export type StorageList = string[];
 export interface ILocalStorage {
     add(name: string): void;
     remove(name: string): void;
@@ -36,45 +28,10 @@ export interface ITokenActions {
  *  - it might return object (truly)
  *  - it might reutrn null
  */
-export declare type onSearchPackage = (item: Manifest, cb: CallbackAction) => void;
-export declare type onEndSearchPackage = (error?: any) => void;
-export declare type onValidatePackage = (name: string) => boolean;
-export declare type StorageUpdateCallback = (data: Manifest, cb: CallbackAction) => void;
-export declare type StorageWriteCallback = (name: string, json: Manifest, callback: Callback) => void;
-export declare type PackageTransformer = (pkg: Manifest) => Manifest;
-export declare type ReadPackageCallback = (err: any | null, data?: Manifest) => void;
-export interface ILocalPackageManager {
-    logger: Logger;
-    deletePackage(fileName: string): Promise<void>;
-    removePackage(): Promise<void>;
-    updatePackage(packageName: string, handleUpdate: (manifest: Manifest) => Promise<Manifest>): Promise<Manifest>;
-    readPackage(name: string): Promise<Manifest>;
-    savePackage(pkgName: string, value: Manifest): Promise<void>;
-    readTarball(pkgName: string, { signal }: {
-        signal: any;
-    }): Promise<Readable>;
-    createPackage(name: string, manifest: Manifest): Promise<void>;
-    writeTarball(tarballName: string, { signal }: {
-        signal: any;
-    }): Promise<Writable>;
-    hasTarball(fileName: string): Promise<boolean>;
-    hasPackage(): Promise<boolean>;
-}
-export declare type IPackageStorage = ILocalPackageManager | void;
-export declare type IPluginStorage<T> = ILocalData<T>;
-export declare type IPackageStorageManager = ILocalPackageManager;
-/**
- * @deprecated use @verdaccio/core pluginUtils instead
- */
-interface ILocalData<T> extends IPlugin<T>, ITokenActions {
-    logger: Logger;
-    config: T;
-    add(name: string): Promise<void>;
-    remove(name: string): Promise<void>;
-    get(): Promise<any>;
-    init(): Promise<void>;
-    getSecret(): Promise<string>;
-    setSecret(secret: string): Promise<any>;
-    getPackageStorage(packageInfo: string): IPackageStorage;
-}
-export {};
+export type onSearchPackage = (item: Manifest, cb: CallbackAction) => void;
+export type onEndSearchPackage = (error?: any) => void;
+export type onValidatePackage = (name: string) => boolean;
+export type StorageUpdateCallback = (data: Manifest, cb: CallbackAction) => void;
+export type StorageWriteCallback = (name: string, json: Manifest, callback: Callback) => void;
+export type PackageTransformer = (pkg: Manifest) => Manifest;
+export type ReadPackageCallback = (err: any | null, data?: Manifest) => void;

package/build/search.d.ts

@@ -1,8 +1,8 @@
-export declare type PublisherMaintainer = {
+export type PublisherMaintainer = {
     username: string;
     email: string;
 };
-export declare type SearchPackageBody = {
+export type SearchPackageBody = {
     name: string;
     scope: string;
     description: string;
@@ -19,7 +19,7 @@ export declare type SearchPackageBody = {
     publisher?: any;
     maintainers?: PublisherMaintainer[];
 };
-export declare type SearchResultWeb = {
+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.17",
+  "version": "11.0.0-6-next.18",
   "description": "verdaccio types definitions",
   "keywords": [
     "private",
@@ -34,9 +34,8 @@
   "main": "build/types.d.ts",
   "types": "build/types.d.ts",
   "devDependencies": {
-    "@types/node": "16.11.60",
-    "typedoc": "beta",
-    "typedoc-plugin-missing-exports": "1.0.0"
+    "@types/node": "16.18.10",
+    "typedoc": "0.23.23"
   },
   "typedoc": {
     "entryPoint": "./src/types.ts",
@@ -50,9 +49,9 @@
   "scripts": {
     "clean": "rimraf ./build",
     "test": "pnpm type-check",
-    "build:docs": "typedoc --options ./typedoc.json --excludeExternals --tsconfig tsconfig.build.json",
+    "build:docs": "typedoc --options ./typedoc.json --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": "# @verdaccio/types\n\nTypeScript definitions for Verdaccio plugins and internal code.\n"
 }

package/src/commons.ts

@@ -15,7 +15,7 @@ export interface RemoteUser {
 export type StringValue = string | void | null;
 
 // FIXME: error should be export type `VerdaccioError = HttpError & { code: number };`
-// instead of AuthError
+// instead of VerdaccioError
 // but this type is on @verdaccio/core and cannot be used here yet (I don't know why)
 export interface HttpError extends Error {
   status: number;

package/src/configuration.ts

@@ -126,7 +126,7 @@ export type TemplateUIOptions = {
   showDownloadTarball?: boolean;
   showRaw?: boolean;
   base: string;
-  primaryColor?: string;
+  primaryColor: string;
   version?: string;
   logoURI?: string;
   flags: FlagsConfig;

package/src/plugins/index.ts

@@ -1,31 +1 @@
-import { RemoteUser } from '../commons';
-import { AllowAccess } from '../configuration';
-import { PackageAccess } from '../manifest';
-import { AuthAccessCallback, AuthCallback } from './auth';
-import { IPlugin } from './commons';
-
-export interface IPluginAuth<T> extends IPlugin<T> {
-  /**
-   * @param props user from Application component
-   */
-  authenticate(user: string, password: string, cb: AuthCallback): void;
-  adduser?(user: string, password: string, cb: AuthCallback): void;
-  changePassword?(user: string, password: string, newPassword: string, cb: AuthCallback): void;
-  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_access?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
-  allow_unpublish?(
-    user: RemoteUser,
-    pkg: AllowAccess & PackageAccess,
-    cb: AuthAccessCallback
-  ): void;
-  apiJWTmiddleware?(helpers: any): Function;
-}
-
-export * from './auth';
 export * from './storage';
-export * from './middleware';
-export * from './commons';
-export * from './filter';

package/src/plugins/storage.ts

@@ -1,17 +1,8 @@
-import { PassThrough, PipelinePromise, Readable, Stream, Writable } from 'stream';
-
-import { Callback, CallbackAction, StringValue } from '../commons';
-import { Config, Logger } from '../configuration';
-import { Manifest, MergeTags, Token, Version } from '../manifest';
-import { IPlugin } from './commons';
+import { Callback, CallbackAction } from '../commons';
+import { Manifest, Token } from '../manifest';
 
 export type StorageList = string[];
 
-export interface LocalStorage {
-  list: any;
-  secret: string;
-}
-
 export interface ILocalStorage {
   add(name: string): void;
   remove(name: string): void;
@@ -53,43 +44,3 @@ export type StorageUpdateCallback = (data: Manifest, cb: CallbackAction) => void
 export type StorageWriteCallback = (name: string, json: Manifest, callback: Callback) => void;
 export type PackageTransformer = (pkg: Manifest) => Manifest;
 export type ReadPackageCallback = (err: any | null, data?: Manifest) => void;
-
-export interface ILocalPackageManager {
-  logger: Logger;
-  deletePackage(fileName: string): Promise<void>;
-  removePackage(): Promise<void>;
-  //  next packages migration (this list is meant to replace the callback parent functions)
-  updatePackage(
-    packageName: string,
-    handleUpdate: (manifest: Manifest) => Promise<Manifest>
-  ): Promise<Manifest>;
-  readPackage(name: string): Promise<Manifest>;
-  savePackage(pkgName: string, value: Manifest): Promise<void>;
-  readTarball(pkgName: string, { signal }): Promise<Readable>;
-  createPackage(name: string, manifest: Manifest): Promise<void>;
-  writeTarball(tarballName: string, { signal }): Promise<Writable>;
-  // verify if tarball exist in the storage
-  hasTarball(fileName: string): Promise<boolean>;
-  // verify if package exist in the storage
-  hasPackage(): Promise<boolean>;
-}
-
-export type IPackageStorage = ILocalPackageManager | void;
-
-export type IPluginStorage<T> = ILocalData<T>;
-export type IPackageStorageManager = ILocalPackageManager;
-
-/**
- * @deprecated use @verdaccio/core pluginUtils instead
- */
-interface ILocalData<T> extends IPlugin<T>, ITokenActions {
-  logger: Logger;
-  config: T;
-  add(name: string): Promise<void>;
-  remove(name: string): Promise<void>;
-  get(): Promise<any>;
-  init(): Promise<void>;
-  getSecret(): Promise<string>;
-  setSecret(secret: string): Promise<any>;
-  getPackageStorage(packageInfo: string): IPackageStorage;
-}

package/tsconfig.build.json

@@ -2,7 +2,8 @@
   "extends": "../../../tsconfig.base.json",
   "compilerOptions": {
     "rootDir": "./src",
-    "outDir": "./build"
+    "outDir": "./build",
+    "noImplicitAny": true
   },
   "include": ["src/**/*"],
   "exclude": ["src/**/*.test.ts"]

package/tsconfig.json

@@ -2,7 +2,8 @@
   "extends": "../../../tsconfig.reference.json",
   "compilerOptions": {
     "rootDir": "./src",
-    "outDir": "./build"
+    "outDir": "./build",
+    "noImplicitAny": true
   },
   "include": ["src/**/*"],
   "exclude": ["src/**/*.test.ts"]

package/build/plugins/auth.d.ts

@@ -1,21 +0,0 @@
-/// <reference types="node" />
-import { Callback, HttpError, RemoteUser } from '../commons';
-import { Config } from '../configuration';
-export interface AuthPluginPackage {
-    packageName: string;
-    packageVersion?: string;
-    tag?: string;
-}
-export declare type AuthError = HttpError & {
-    code: number;
-};
-export declare type AuthAccessCallback = (error: AuthError | null, access: boolean) => void;
-export declare type AuthCallback = (error: AuthError | null, groups: string[] | false) => void;
-export interface IBasicAuth<T> {
-    config: T & Config;
-    aesEncrypt(buf: Buffer): Buffer;
-    authenticate(user: string, password: string, cb: Callback): void;
-    changePassword(user: string, password: string, newPassword: string, cb: Callback): void;
-    allow_access(pkg: AuthPluginPackage, user: RemoteUser, callback: Callback): void;
-    add_user(user: string, password: string, cb: Callback): any;
-}

package/build/plugins/commons.d.ts

@@ -1,11 +0,0 @@
-import { Config, Logger } from '../configuration';
-export declare class Plugin<T> {
-    constructor(config: T, options: PluginOptions);
-}
-export interface IPlugin<T> {
-    version?: string;
-}
-export interface PluginOptions {
-    config: Config;
-    logger: Logger;
-}

package/build/plugins/filter.d.ts

@@ -1,5 +0,0 @@
-import { Manifest } from '../manifest';
-import { IPlugin } from './commons';
-export interface IPluginStorageFilter<T> extends IPlugin<T> {
-    filterMetadata(packageInfo: Manifest): Promise<Manifest>;
-}

package/build/plugins/middleware.d.ts

@@ -1,5 +0,0 @@
-import { IBasicAuth } from './auth';
-import { IPlugin } from './commons';
-export interface IPluginMiddleware<T, K> extends IPlugin<T> {
-    register_middlewares(app: any, auth: IBasicAuth<T>, storage: K): void;
-}

package/src/plugins/auth.ts

@@ -1,22 +0,0 @@
-import { Callback, HttpError, RemoteUser } from '../commons';
-import { Config } from '../configuration';
-
-export interface AuthPluginPackage {
-  packageName: string;
-  packageVersion?: string;
-  tag?: string;
-}
-
-export type AuthError = HttpError & { code: number };
-export type AuthAccessCallback = (error: AuthError | null, access: boolean) => void;
-export type AuthCallback = (error: AuthError | null, groups: string[] | false) => void;
-
-// @deprecated use IBasicAuth from @verdaccio/auth
-export interface IBasicAuth<T> {
-  config: T & Config;
-  aesEncrypt(buf: Buffer): Buffer;
-  authenticate(user: string, password: string, cb: Callback): void;
-  changePassword(user: string, password: string, newPassword: string, cb: Callback): void;
-  allow_access(pkg: AuthPluginPackage, user: RemoteUser, callback: Callback): void;
-  add_user(user: string, password: string, cb: Callback): any;
-}

package/src/plugins/commons.ts

@@ -1,15 +0,0 @@
-import { Config, Logger } from '../configuration';
-
-export class Plugin<T> {
-  public constructor(config: T, options: PluginOptions) {}
-}
-
-export interface IPlugin<T> {
-  // TODO: not used on core yet
-  version?: string;
-}
-
-export interface PluginOptions {
-  config: Config;
-  logger: Logger;
-}

package/src/plugins/filter.ts

@@ -1,6 +0,0 @@
-import { Manifest } from '../manifest';
-import { IPlugin } from './commons';
-
-export interface IPluginStorageFilter<T> extends IPlugin<T> {
-  filterMetadata(packageInfo: Manifest): Promise<Manifest>;
-}

package/src/plugins/middleware.ts

@@ -1,8 +0,0 @@
-import { Config } from '../configuration';
-import { IBasicAuth } from './auth';
-import { IPlugin } from './commons';
-
-// TODO: convert to generic storage should come from implementation
-export interface IPluginMiddleware<T, K> extends IPlugin<T> {
-  register_middlewares(app: any, auth: IBasicAuth<T>, storage: K): void;
-}