Add browser console plugin

src/plugins/browser-console/index.ts

@@ -0,0 +1,21 @@
+import { BasePlugin } from '../../base';
+import type { PluginFactory } from '../../types';
+import { BrowserConsolePublisher } from './publisher';
+
+/**
+ * Browser Console plugin
+ */
+export class BrowserConsolePlugin extends BasePlugin<never, never> {
+  name = 'browserConsole';
+  publishers = [new BrowserConsolePublisher()];
+}
+
+/**
+ * Browser Console plugin factory function
+ *
+ * Use this function to instantiate the BrowserConsolePlugin when registering
+ * this plugin within Stratum.
+ */
+export const BrowserConsolePluginFactory: PluginFactory<BrowserConsolePlugin> = () => new BrowserConsolePlugin();
+
+export * from './publisher';

src/plugins/browser-console/publisher.ts

@@ -0,0 +1,48 @@
+import { BaseEventModel, BasePublisher } from '../../base';
+import { StratumSnapshot } from '../../types';
+
+/**
+ * Browser Console Publisher
+ */
+export class BrowserConsolePublisher extends BasePublisher {
+  name = 'browserConsole';
+
+  /**
+   * Handle all event types generically, even those provided
+   * by a separate plugin.
+   */
+  shouldPublishEvent(): boolean {
+    return true;
+  }
+
+  /**
+   * Required
+   * Returns data from underlying events to utilize
+   * in the publish step.
+   */
+  getEventOutput(_event: BaseEventModel, snapshot: StratumSnapshot) {
+    return snapshot.data;
+  }
+
+  /**
+   * Required
+   * Check if your publisher source is available (aka scripts installed, environment
+   * is set up, etc.)
+   *
+   * In this case, we make sure that console.log() is accessible.
+   */
+  async isAvailable() {
+    return typeof console !== 'undefined';
+  }
+
+  /**
+   * Required
+   * Send your content to the external publisher
+   *
+   * In this, case we publish the snapshot data to the console log
+   */
+  /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
+  async publish(_content: any, snapshot: StratumSnapshot) {
+    console.log(snapshot.data);
+  }
+}

tests/plugins/browser-console.test.ts

@@ -0,0 +1,61 @@
+import { BasePublisher, StratumService } from '../../src';
+import {
+  BrowserConsolePlugin,
+  BrowserConsolePluginFactory,
+  BrowserConsolePublisher
+} from '../../src/plugins/browser-console';
+import { CATALOG_METADATA, PRODUCT_NAME, PRODUCT_VERSION } from '../utils/constants';
+import { getPublishers, restoreStratumMocks } from '../utils/helpers';
+import { BASE_CATALOG } from '../utils/catalog';
+
+describe('browser console plugin', () => {
+  let stratum: StratumService;
+  let plugin: BrowserConsolePlugin;
+  let publisher: BasePublisher;
+
+  beforeEach(() => {
+    plugin = BrowserConsolePluginFactory();
+    stratum = new StratumService({
+      catalog: { items: BASE_CATALOG, ...CATALOG_METADATA },
+      plugins: [plugin],
+      productName: PRODUCT_NAME,
+      productVersion: PRODUCT_VERSION
+    });
+    publisher = stratum.publishers[0];
+  });
+
+  afterEach(() => {
+    restoreStratumMocks();
+    jest.restoreAllMocks();
+  });
+
+  it('should successfully publish from catalog', async () => {
+    const result = await stratum.publish(1);
+    expect(result).toBe(true);
+  });
+
+  it('should initialize the BrowserConsole publisher', () => {
+    expect(getPublishers(stratum)[0]).toBeInstanceOf(BrowserConsolePublisher);
+  });
+
+  it('should publish and log events to the console', async () => {
+    expect(publisher).toBeInstanceOf(BrowserConsolePublisher);
+
+    const publishSpy = jest.spyOn(publisher, 'publish');
+    const consoleSpy = jest.spyOn(console, 'log');
+
+    let result = await stratum.publish(1);
+
+    expect(result).toBe(true);
+    expect(publishSpy).toHaveBeenCalledTimes(1);
+    expect(consoleSpy).toHaveBeenCalledWith(BASE_CATALOG[1]);
+
+    result = await stratum.publish(2);
+
+    expect(result).toBe(true);
+    expect(publishSpy).toHaveBeenCalledTimes(2);
+    expect(consoleSpy).toHaveBeenCalledWith(BASE_CATALOG[2]);
+
+    expect(consoleSpy).toHaveBeenCalledTimes(2);
+  });
+});