Add @bull-board/ui as peerDep of @bull-board/api

[JasonMan34]

This closes #564

[felixmosh]

lets not restrict the version here, make it *

[JasonMan34]

Wasn't sure about compatibility issues so I copied the version from the inverse dependency (ui's dependency on [email protected])

Changed to *

[felixmosh]

Released in v5.1.2, can you try this version?

[JasonMan34]

Works now :)

Although the solution feels off to me. ui's dependency of api is obvious, but the reverse dependency only exists because of this code:

export function createBullBoard({
  queues,
  serverAdapter,
  options = { uiConfig: {} },
}: {
  queues: ReadonlyArray<BaseAdapter>;
  serverAdapter: IServerAdapter;
  options?: BoardOptions;
}) {
  const { bullBoardQueues, setQueues, replaceQueues, addQueue, removeQueue } = getQueuesApi(queues);
  const uiBasePath = path.dirname(eval(`require.resolve('@bull-board/ui/package.json')`));

  serverAdapter
    .setQueues(bullBoardQueues)
    .setViewsPath(path.join(uiBasePath, 'dist'))
    .setStaticPath('/static', path.join(uiBasePath, 'dist/static'))
    .setUIConfig(options.uiConfig)
    .setEntryRoute(appRoutes.entryPoint)
    .setErrorHandler(errorHandler)
    .setApiRoutes(appRoutes.api);

  return { setQueues, replaceQueues, addQueue, removeQueue };
}

I think there are a few approaches that would be better than the current peerDep solution:

1. Perhaps if createBullBoard is inherently coupled with @bull-board/ui, it should be exported from there? That would remove the cyclic dependency and resolve the issue in a more elegant way
2. Decouple createBullBoardcompletely from @bull-board/ui entirely, and accept another required parameter uiBasePath. Then @bull-board/ui could export a uiBasePath to be used when calling createBullBoard
3. Export shared dependencies (KeyOf, STATUSES, AppQueue, etc.) to a @bull-board/core package and have both ui and api depend on core (Remove ui's dependency on api). Then have api rely on ui directly (Regular dependency over peerDependency)

[felixmosh]

Thanx for the feedback.

1. createBullBoard is a builder of api, it should be on the server side part.
2. I've thought about it, but then each user of the lib will need to pass the same piece of code
3. Good possible solution, I'll consider this refactor, thanx