rework plugin init functions

Author: Syndesi

core/src/Type/Definition/PluginInit.ts

@@ -0,0 +1,13 @@
+import { ServiceResolver } from '../../Service/index.js';
+
+/**
+ * Function which every Ember Nexus compatible plugin must expose as its top level `init` export.
+ */
+type pluginInit = (serviceResolver: ServiceResolver) => Promise<void>;
+
+/**
+ * Function which every Ember Nexus compatible plugin must expose as its top level `optimizeDynamicConfigurations` export.
+ */
+type pluginOptimizeDynamicConfigurations = (serviceResolver: ServiceResolver) => Promise<void>;
+
+export { pluginInit, pluginOptimizeDynamicConfigurations };

core/src/Type/Definition/index.ts

@@ -15,6 +15,7 @@ export * from './Node.js';
 export * from './NodeWithOptionalId.js';
 export * from './OptionalPromise.js';
 export * from './PluginIdentifier.js';
+export * from './PluginInit.js';
 export * from './PriorityRegistry.js';
 export * from './Proxy.js';
 export * from './Registry.js';

core/src/index.ts

@@ -6,7 +6,9 @@ export * as Endpoint from './Endpoint/index.js';
 export * as Error from './Error/index.js';
 export * as Event from './Event/index.js';
 export * as EventListener from './EventListener/index.js';
-export * from './Init.js';
+export * from './init.js';
+export * from './initEventListeners.js';
+export * from './optimizeDynamicConfigurations.js';
 
 export * as Service from './Service/index.js';
 export * as Type from './Type/index.js';

core/src/Init.ts core/src/init.tscore/src/Init.ts renamed to core/src/init.ts

@@ -1,6 +1,5 @@
 import { Logger } from 'tslog';
 
-import { GetServiceResolverEvent } from './BrowserEvent/index.js';
 import {
   ElementCache,
   ElementChildrenCache,
@@ -40,18 +39,13 @@ import {
   ServiceResolver,
   TokenParser,
 } from './Service/index.js';
-import { PriorityRegistry, Registry } from './Type/Definition/index.js';
-import { BrowserEventIdentifier, ServiceIdentifier } from './Type/Enum/index.js';
-
-function init(rootNode: HTMLElement): ServiceResolver {
-  const serviceResolver = new ServiceResolver();
+import { PriorityRegistry, Registry, pluginInit } from './Type/Definition/index.js';
+import { ServiceIdentifier } from './Type/Enum/index.js';
 
+const init: pluginInit = (serviceResolver: ServiceResolver) => {
   serviceResolver.setService(ServiceIdentifier.action, new PriorityRegistry());
-
   serviceResolver.setService(ServiceIdentifier.setting, new Registry());
-
   serviceResolver.setService(ServiceIdentifier.icon, new Registry());
-
   serviceResolver.setService(ServiceIdentifier.routeResolver, new RouteResolver());
 
   const logger = new Logger({
@@ -106,12 +100,7 @@ function init(rootNode: HTMLElement): ServiceResolver {
   // event listeners
   initEventListener(serviceResolver);
 
-  rootNode.addEventListener(BrowserEventIdentifier.GetServiceResolver, (event: GetServiceResolverEvent) => {
-    event.setServiceResolver(serviceResolver);
-    event.stopPropagation();
-  });
-
-  return serviceResolver;
-}
+  return Promise.resolve();
+};
 
 export { init };

core/src/initEventListeners.ts

@@ -0,0 +1,12 @@
+import { GetServiceResolverEvent } from './BrowserEvent/index.js';
+import { ServiceResolver } from './Service/index.js';
+import { BrowserEventIdentifier } from './Type/Enum/index.js';
+
+function initEventListeners(rootNode: HTMLElement, serviceResolver: ServiceResolver): void {
+  rootNode.addEventListener(BrowserEventIdentifier.GetServiceResolver, (event: GetServiceResolverEvent) => {
+    event.setServiceResolver(serviceResolver);
+    event.stopPropagation();
+  });
+}
+
+export { initEventListeners };

core/src/optimizeDynamicConfigurations.ts

@@ -0,0 +1,7 @@
+import { pluginOptimizeDynamicConfigurations } from './Type/Definition/index.js';
+
+const optimizeDynamicConfigurations: pluginOptimizeDynamicConfigurations = () => {
+  return Promise.resolve();
+};
+
+export { optimizeDynamicConfigurations };

core/test/Unit/Init.test.ts

@@ -36,6 +36,14 @@ test('configured route resolver can resolve index route', async () => {
   expect(await routeResolver.findRouteConfiguration('/')).toEqual(routeConfiguration);
 });
 
+test('configured route resolver can resolve index route (2)', async () => {
+  const routeConfiguration = buildRouteConfiguration('test-route', '/');
+
+  const routeResolver = new RouteResolver().addRouteConfiguration(routeConfiguration);
+
+  expect(await routeResolver.findRouteConfiguration('')).toEqual(routeConfiguration);
+});
+
 test('priority of configured routes is respected', async () => {
   const routeConfiguration1 = buildRouteConfiguration('test-route-1', '/', 1);
   const routeConfiguration2 = buildRouteConfiguration('test-route-2', '/', 2);