fix: added experimental plugin exports

packages/core/src/index.ts

@@ -25,5 +25,6 @@ export const MINUTE_IN_MS = 60 * SECOND_IN_MS;
 export const HOUR_IN_MS = 60 * MINUTE_IN_MS;
 export const DAY_IN_MS = 24 * HOUR_IN_MS;
 
-export type { Logger } from './logger/logger.interface';
-export type { MetricsRecorder } from './metric-recorder/metricsRecorder.interface';
+export type { Log, Logger } from './logger/logger.interface';
+export type { Metric, MetricsRecorder } from './metricRecorder/metricsRecorder.interface';
+export { registerPlugin, getPlugin } from './plugins/pluginsRegistry';

packages/core/src/logger/logger.interface.ts

@@ -1,7 +1,7 @@
 /**
  * Log represents a single event message to record.
  */
-type Log = {
+export type Log = {
   /**
    * Additional contexts to include.
    */

packages/core/src/metric-recorder/metricsRecorder.interface.ts → packages/core/src/metricRecorder/metricsRecorder.interface.ts

@@ -38,7 +38,7 @@
  *   metricValue: 2,
  * };
  */
-type Metric = {
+export type Metric = {
   /**
    * Additional contexts to separate the metricName.
    */

packages/core/src/plugins/loggerSettings.ts

@@ -1,3 +1,3 @@
 import type { Logger } from '../logger/logger.interface';
 
-export type LoggerSettings = { provider: () => Logger };
+export type LoggerSettings = { provider: () => Logger | undefined };

packages/core/src/plugins/metricsRecorderSettings.ts

@@ -1,3 +1,3 @@
-import type { MetricsRecorder } from '../metric-recorder/metricsRecorder.interface';
+import type { MetricsRecorder } from '../metricRecorder/metricsRecorder.interface';
 
-export type MetricsRecorderSettings = { provider: () => MetricsRecorder };
+export type MetricsRecorderSettings = { provider: () => MetricsRecorder | undefined };

packages/core/src/plugins/pluginsRegistry.spec.ts

@@ -1,6 +1,6 @@
 import type { Logger } from '../logger/logger.interface';
-import type { MetricsRecorder } from '../metric-recorder/metricsRecorder.interface';
-import { getLogger, getMetricsRecorder, registerLogger, registerMetricsRecorder } from './pluginsRegistry';
+import type { MetricsRecorder } from '../metricRecorder/metricsRecorder.interface';
+import { registerPlugin, getPlugin } from './pluginsRegistry';
 
 describe('Logger registry', () => {
   class MockLogClient implements Logger {
@@ -10,7 +10,7 @@ describe('Logger registry', () => {
   }
 
   test('does not provide logger by default', () => {
-    const logger = getLogger();
+    const logger = getPlugin('logger');
 
     expect(logger).toBeUndefined();
   });
@@ -19,10 +19,10 @@ describe('Logger registry', () => {
     const mockLogClient = new MockLogClient();
     const mockProvider = jest.fn().mockReturnValue(mockLogClient);
 
-    registerLogger({
+    registerPlugin('logger', {
       provider: mockProvider,
     });
-    const logger = getLogger();
+    const logger = getPlugin('logger');
 
     expect(logger).toBe(mockLogClient);
     expect(mockProvider).toBeCalled();
@@ -35,7 +35,7 @@ describe('MetricsRecorder registry', () => {
   }
 
   test('does not provide MetricsRecorder by default', () => {
-    const metricsRecorder = getMetricsRecorder();
+    const metricsRecorder = getPlugin('metricsRecorder');
 
     expect(metricsRecorder).toBeUndefined();
   });
@@ -44,10 +44,10 @@ describe('MetricsRecorder registry', () => {
     const mockMetricsRecorder = new MockMetricsRecorder();
     const mockProvider = jest.fn().mockReturnValue(mockMetricsRecorder);
 
-    registerMetricsRecorder({
+    registerPlugin('metricsRecorder', {
       provider: mockProvider,
     });
-    const metricsRecorder = getMetricsRecorder();
+    const metricsRecorder = getPlugin('metricsRecorder');
 
     expect(metricsRecorder).toBe(mockMetricsRecorder);
     expect(mockProvider).toBeCalled();

packages/core/src/plugins/pluginsRegistry.ts

@@ -1,44 +1,66 @@
 import type { LoggerSettings } from './loggerSettings';
 import type { MetricsRecorderSettings } from './metricsRecorderSettings';
 
+interface PluginsRegistry {
+  logger: LoggerSettings;
+  metricsRecorder: MetricsRecorderSettings;
+}
+
 /**
  * Internal object to hold all of the plugins.
  *
  * @emarks Not exported to encapsulate the registry
  */
-const pluginsRegistry: {
-  loggerSettings?: LoggerSettings;
-  metricsRecorderSettings?: MetricsRecorderSettings;
-} = {};
-
-/**
- * Register a Logger for logging AppKit logs.
- * @param param0 settings for Logger
- * @alpha
- */
-export const registerLogger = (settings: LoggerSettings) => {
-  pluginsRegistry.loggerSettings = settings;
+const pluginsRegistry: PluginsRegistry = {
+  logger: {
+    provider: () => undefined,
+  },
+  metricsRecorder: {
+    provider: () => undefined,
+  },
 };
 
 /**
- * Return the registered Logger.
- * @returns the registered Logger.
- * @alpha
+ * Registers a plugin under a namespace.
+ * @param namespace the namespace to register the plugin
+ * @param pluginSetting the setting object of the plugin to register
+ *
+ * @example
+ * // example of a registration and usage of metricsRecorder plugin
+ * registerPlugin('metricsRecorder', {
+ *   provider: () => ({
+ *     // record and console log all metrics
+ *     record: (metric) => {
+ *       console.log(metric);
+ *     },
+ *   }),
+ * });
  */
-export const getLogger = () => pluginsRegistry.loggerSettings?.provider();
+export function registerPlugin<
+  Namespace extends keyof PluginsRegistry,
+  PluginSetting extends PluginsRegistry[Namespace]
+>(namespace: Namespace, pluginSetting: PluginSetting): void {
+  pluginsRegistry[namespace] = pluginSetting;
+}
 
 /**
- * Register a MetricsRecorder for recording AppKit metrics.
- * @param param0 settings for MetricsRecorder
- * @alpha
+ * Returns the plugin of the given namespace.
+ * @param namespace the namespace of the plugin to retrieve
+ * @returns the plugin matching the given namespace
+ *
+ * @example
+ * // example of getting metricsRecorder plugin
+ * const metricsRecorder = getPlugin('metricsRecorder');
+ *
+ * metricsRecorder?.record({
+ *   metricName: 'test',
+ *   metricValue: 123
+ * });
  */
-export const registerMetricsRecorder = (settings: MetricsRecorderSettings) => {
-  pluginsRegistry.metricsRecorderSettings = settings;
-};
+export function getPlugin<Namespace extends keyof PluginsRegistry>(
+  namespace: Namespace
+): ReturnType<PluginsRegistry[Namespace]['provider']> {
+  const plugin = pluginsRegistry[namespace].provider() as ReturnType<PluginsRegistry[Namespace]['provider']>;
 
-/**
- * Return the registered MetricsRecorder.
- * @returns the registered MetricsRecorder.
- * @alpha
- */
-export const getMetricsRecorder = () => pluginsRegistry.metricsRecorderSettings?.provider();
+  return plugin;
+}