feat: implement provideLumberjackCustomDrivers to allow the angular c…

…lient to use agnostic drivers

packages/examples/lumberjack-app/src/main.ts

@@ -3,8 +3,9 @@ import { inject, InjectionToken } from '@angular/core';
 import { bootstrapApplication } from '@angular/platform-browser';
 
 import { provideLumberjackAngularHttpDriver, withHttpOptions } from '@lumberjackjs/angular-http-driver';
-import { provideLumberjack } from '@lumberjackjs/angular';
-import { LumberjackLog, LumberjackOptions } from '@lumberjackjs/core';
+import { provideLumberjack, provideLumberjackCustomDrivers } from '@lumberjackjs/angular';
+import { LumberjackLevel, LumberjackLog, LumberjackOptions } from '@lumberjackjs/core';
+import { LumberjackConsoleDriver } from '@lumberjackjs/core/console-driver';
 
 import { AppComponent } from './app/app.component';
 
@@ -20,13 +21,16 @@ const cypressLumberjackOptions: LumberjackOptions = {
 
 const easyToken = new InjectionToken('easy-provider');
 
+const consoleDriver = new LumberjackConsoleDriver({ levels: [LumberjackLevel.Verbose] });
+
 bootstrapApplication(AppComponent, {
   providers: [
     {
       provide: easyToken,
       useValue: 'provider-easy',
     },
     provideLumberjack('Cypress' in window ? cypressLumberjackOptions : undefined),
+    provideLumberjackCustomDrivers(consoleDriver),
     provideLumberjackAngularHttpDriver(
       withHttpOptions({
         origin: 'ForestApp',

packages/examples/lumberjack-app/tsconfig.app.json

@@ -7,7 +7,7 @@
       "@lumberjackjs/angular": ["dist/packages/lumberjackjs/angular"],
       "@lumberjackjs/angular-http-driver": ["dist/packages/lumberjackjs/angular-http-driver"],
       "@lumberjackjs/core": ["dist/packages/lumberjackjs/core"],
-      "@lumberjackjs/core/console-driver": ["dist/packages/lumberjackjs/core/console-driver"]
+      "@lumberjackjs/core/console-driver": ["dist/packages/lumberjackjs/core/console-driver/src"]
     }
   },
   "files": ["src/main.ts"],

packages/lumberjackjs/angular/src/configuration-api.spec.ts

@@ -8,6 +8,7 @@ import {
   LumberjackModule,
   LumberjackRootModule,
   provideLumberjack,
+  provideLumberjackCustomDrivers,
 } from './index';
 
 describe('Configuration API', () => {
@@ -31,6 +32,12 @@ describe('Configuration API', () => {
 
       expect(isFunction(sut)).toBeTruthy();
     });
+
+    it(`exposes ${provideLumberjackCustomDrivers.name}`, () => {
+      const sut = provideLumberjackCustomDrivers;
+
+      expect(isFunction(sut)).toBeTruthy();
+    });
   });
 
   describe('Dependency injection tokens', () => {

packages/lumberjackjs/angular/src/index.ts

@@ -8,6 +8,7 @@ export { lumberjackLogDriverConfigToken } from './lib/configuration/lumberjack-l
 export { LumberjackModule } from './lib/configuration/lumberjack.module';
 export { LumberjackRootModule } from './lib/configuration/lumberjack-root.module';
 export { provideLumberjack } from './lib/configuration/provide-lumberjack';
+export { provideLumberjackCustomDrivers } from './lib/configuration/provide-custom-drivers';
 
 // Logging
 export { LumberjackLogger } from './lib/logging/lumberjack-logger.service';

packages/lumberjackjs/angular/src/lib/configuration/provide-custom-drivers.spec.ts

@@ -0,0 +1,35 @@
+import { TestBed } from '@angular/core/testing';
+
+import { createNoopDriver } from '@internal/core/test-util';
+import { LumberjackLevel } from '@lumberjackjs/core';
+import { LumberjackConsoleDriver } from '@lumberjackjs/core/console-driver';
+
+import { lumberjackLogDriverToken } from '../log-drivers/lumberjack-log-driver.token';
+
+import { provideLumberjackCustomDrivers } from './provide-custom-drivers';
+
+describe(provideLumberjackCustomDrivers.name, () => {
+  const consoleDriver = new LumberjackConsoleDriver({ levels: [LumberjackLevel.Verbose] });
+  const noopDriver = createNoopDriver({ levels: [LumberjackLevel.Verbose] });
+
+  it('provides the custom driver', () => {
+    TestBed.configureTestingModule({
+      providers: [provideLumberjackCustomDrivers(consoleDriver)],
+    });
+    const customDriver = TestBed.inject(lumberjackLogDriverToken);
+
+    expect(customDriver).toBeDefined();
+    expect(customDriver).toEqual([consoleDriver]);
+  });
+
+  it('provides the multiple custom drivers', () => {
+    TestBed.configureTestingModule({
+      providers: [provideLumberjackCustomDrivers([consoleDriver, noopDriver])],
+    });
+    const customDrivers = TestBed.inject(lumberjackLogDriverToken);
+
+    expect(customDrivers).toBeDefined();
+    expect(customDrivers.length).toBe(2);
+    expect(customDrivers).toEqual([consoleDriver, noopDriver]);
+  });
+});

packages/lumberjackjs/angular/src/lib/configuration/provide-custom-drivers.ts

@@ -0,0 +1,48 @@
+import { Provider } from '@angular/core';
+
+import { LumberjackLogDriver } from '@lumberjackjs/core';
+
+import { lumberjackLogDriverToken } from '../log-drivers/lumberjack-log-driver.token';
+
+/**
+ * Returns the [dependency-injection providers](https://angular.io/guide/glossary#provider)
+ *
+ * for one or more custom/agnostic `LumberjackDriver` and its `LumberjackDriverConfig`.
+ * @usageNotes
+ *
+ * The function is useful when you want to bootstrap an application using
+ * the `bootstrapApplication` function and want to make available the `LumberjackDriver` providers.
+ *
+ * ```typescript
+ * bootstrapApplication(RootComponent, {
+ *   providers: [
+ *    provideLumberjack({...}),
+ *    provideLumberjackCustomDriver({...})
+ *   ]
+ * });
+ * ```
+ *
+ * @publicApi
+ */
+export function provideLumberjackCustomDrivers<Driver extends LumberjackLogDriver>(driver: Driver): Provider[];
+export function provideLumberjackCustomDrivers<Driver extends LumberjackLogDriver>(drivers: Driver[]): Provider[];
+
+export function provideLumberjackCustomDrivers<Driver extends LumberjackLogDriver>(
+  drivers: Driver | Driver[]
+): Provider[] {
+  if (Array.isArray(drivers)) {
+    return drivers.map((driver) => ({
+      provide: lumberjackLogDriverToken,
+      useValue: driver,
+      multi: true,
+    }));
+  }
+
+  return [
+    {
+      provide: lumberjackLogDriverToken,
+      useValue: drivers,
+      multi: true,
+    },
+  ];
+}

packages/lumberjackjs/angular/src/lib/log-drivers/lumberjack-log-driver.token.ts

@@ -5,6 +5,6 @@ import { LumberjackLogDriver } from '@lumberjackjs/core';
 /**
  * A multi-provider token which log drivers use to register with Lumberjack.
  */
-export const lumberjackLogDriverToken: InjectionToken<LumberjackLogDriver> = new InjectionToken(
+export const lumberjackLogDriverToken: InjectionToken<LumberjackLogDriver[]> = new InjectionToken(
   '__LUMBERJACK_LOG_DRIVER_TOKEN__'
 );