@types - AuthCallback: Incorrect definition

https://github.com/verdaccio/monorepo/blob/9.x/core/types/index.d.ts defines

type AuthAccessCallback = (error: string | null, access: boolean) => void;

interface IPluginAuth<T> extends IPlugin<T> {
  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;
}

However, the server seems to be expecting an object when there is an error for the callback, not a string.

When I try to pass an error: string the server throws an error, it seems to be expecting an object. I have to pass null to prevent the server from throwing an error.

Example Code

public authenticate(username: string, password: string, cb: AuthCallback): void {

  // fetch the user and set validPassword

  return validPassword ? cb(null, fetchedUser.groups) : cb('user not found', false);
}

Output from server

npm ERR! Unexpected token u in JSON at position 0 while parsing near 'user not found'

[haquezameer]

I would like to take this up @juanpicado

[juanpicado]

@haquezameer awesome, my comment from 2020, back then the master branch did not have the current structure. In master branch you can find all the modules and this file https://github.com/verdaccio/monorepo/blob/9.x/core/types/index.d.ts is located here https://github.com/verdaccio/verdaccio/tree/master/packages/types so you have all required pieces on this repo.

Feel free to ask me all you need to know to move this on.

tip: @verdaccio/types are used in most of the packages, thus after change to verify all types are correct, run from the root. pnpm build if any module fails you will see why and where should be adapted. As far I know this might affect all auth plugins on this repo, which are like 3.

Reminder, breaking changes are allowed, in such case any breaking change should be documented properly here https://github.com/verdaccio/verdaccio/blob/master/docs/migration-v5-to-v6.md