@joist/di 4.0.0-next.4 → 4.0.0-next.40

package/README.md

@@ -16,10 +16,10 @@ Allows you to inject services into other class instances (including custom eleme
 - [Hierarchical Injectors](#hierarchical-injectors)
 - [Custom Elements](#custom-elements)
 
-## Installation:
+## Installation
 
 ```BASH
-npm i @joist/di
+npm i @joist/di@next
 ```
 
 ## Injectors
@@ -102,7 +102,9 @@ test('should return json', async () => {
     }
   }
 
-  const app = new Injector([{ provide: HttpService, use: MockHttpService }]);
+  const app = new Injector({
+    providers: [[HttpService, { use: MockHttpService }]]
+  });
   const api = app.inject(ApiService);
 
   const res = await api.getData();
@@ -130,7 +132,7 @@ class ConsoleLogger implements Logger {
 }
 
 @injectable({
-  providers: [{ provide: Logger, use: ConsoleLogger }]
+  providers: [[Logger, { use: ConsoleLogger }]]
 })
 class MyService {}
 ```
@@ -180,14 +182,16 @@ class Feature {
 }
 
 const app = new Injector([
-  {
-    provide: Feature,
-    factory(i) {
-      const logger = i.inject(Logger);
+  [
+    Feature,
+    {
+      factory(i) {
+        const logger = i.inject(Logger);
 
-      return new Feature(logger);
+        return new Feature(logger);
+      }
     }
-  }
+  ]
 ]);
 ```
 
@@ -200,10 +204,12 @@ In most cases a token is any constructable class. There are cases where you migh
 const URL_TOKEN = new StaticToken<string>('app_url');
 
 const app = new Injector([
-  {
-    provide: URL_TOKEN,
-    factory: () => '/my-app-url/'
-  }
+  [
+    URL_TOKEN,
+    {
+      factory: () => '/my-app-url/'
+    }
+  ]
 ]);
 ```
 
@@ -228,17 +234,43 @@ const app = new Injector();
 const url: string = await app.inject(URL_TOKEN);
 ```
 
+This allows you to dynamically import services
+
+```ts
+const HttpService = new StaticToken('HTTP_SERVICE', () => {
+  return import('./http.service.js').then((m) => new m.HttpService());
+});
+
+class HackerNewsService {
+  #http = inject(HttpService);
+
+  async getData() {
+    const http = await this.#http();
+
+    const url = new URL('https://hacker-news.firebaseio.com/v0/beststories.json');
+    url.searchParams.set('limitToFirst', count.toString());
+    url.searchParams.set('orderBy', '"$key"');
+
+    return http.fetchJson<string[]>(url);
+  }
+}
+
+const url: string = await app.inject(URL_TOKEN);
+```
+
 ## LifeCycle
 
 To help provide more information to services that are being created, joist will call several life cycle hooks as services are created. These hooks are defined using the provided symbols so there is no risk of naming colisions.
 
 ```ts
 class MyService {
-  [LifeCycle.onInit]() {
+  @created()
+  onCreated() {
     // called the first time a service is created. (not pulled from cache)
   }
 
-  [LifeCycle.onInject]() {
+  @injected()
+  onInjected() {
     // called every time a service is returned, whether it is from cache or not
   }
 }
@@ -246,12 +278,16 @@ class MyService {
 
 ## Hierarchical Injectors
 
-Injectors can be defined with a parent element. The top most parent will (by default) be where services are constructed and cached. Only if manually defined providers are found earlier in the chain will services be constructed lower. The injector resolution algorithm behaves as following.
+Injectors can be defined with a parent. The top most parent will (by default) be where services are constructed and cached. Only if manually defined providers are found earlier in the chain will services be constructed lower. The injector resolution algorithm behaves as following.
 
 1. Do I have a cached instance locally?
 2. Do I have a local provider definition for the token?
-3. Do I have a parent? Check parent for 1 and 2
-4. All clear, go ahead and construct and cache the requested service
+3. Do I have a parent?
+4. Does parent have a local instance or provider definition?
+5. If parent exists but no instance found, create instance in parent.
+6. If not parent, All clear, go ahead and construct and cache the requested service.
+
+Having injectors resolve this way means that all children have access to services created by their parents.
 
 ```mermaid
 graph TD

package/package.json

@@ -1,16 +1,13 @@
 {
   "name": "@joist/di",
-  "version": "4.0.0-next.4",
+  "version": "4.0.0-next.40",
   "type": "module",
   "main": "./target/lib.js",
   "module": "./target/lib.js",
   "exports": {
-    ".": {
-      "import": "./target/lib.js"
-    },
-    "./*": {
-      "import": "./target/lib/*"
-    }
+    ".": "./target/lib.js",
+    "./*": "./target/lib/*",
+    "./package.json": "./package.json"
   },
   "files": [
     "src",
@@ -20,7 +17,7 @@
   "description": "Dependency Injection for Vanilla JS classes",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/deebloo/joist.git"
+    "url": "git+https://github.com/joist-framework/joist.git"
   },
   "keywords": [
     "TypeScript",
@@ -31,7 +28,7 @@
   "author": "deebloo",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/deebloo/joist/issues"
+    "url": "https://github.com/joist-framework/joist/issues"
   },
   "publishConfig": {
     "access": "public"
@@ -57,17 +54,7 @@
     "test": {
       "command": "wtr --config wtr.config.mjs",
       "files": [
-        "target/**"
-      ],
-      "output": [],
-      "dependencies": [
-        "build",
-        "test:node"
-      ]
-    },
-    "test:node": {
-      "command": "node --test target/**/*.test-node.js",
-      "files": [
+        "wtr.config.mjs",
         "target/**"
       ],
       "output": [],

package/src/lib/context/injector.ts

@@ -0,0 +1,4 @@
+import { Injector } from '../injector.js';
+import { Context, createContext } from './protocol.js';
+
+export const INJECTOR_CTX: Context<'injector', Injector> = createContext('injector');

package/src/lib/context/protocol.ts

@@ -0,0 +1,66 @@
+/**
+ * A context key.
+ *
+ * A context key can be any type of object, including strings and symbols. The
+ *  Context type brands the key type with the `__context__` property that
+ * carries the type of the value the context references.
+ */
+export type Context<KeyType, ValueType> = KeyType & { __context__: ValueType };
+
+/**
+ * An unknown context type
+ */
+export type UnknownContext = Context<unknown, unknown>;
+
+/**
+ * A helper type which can extract a Context value type from a Context type
+ */
+export type ContextType<T extends UnknownContext> = T extends Context<infer _, infer V> ? V : never;
+
+/**
+ * A function which creates a Context value object
+ */
+
+export function createContext<KeyType, ValueType>(key: KeyType) {
+  return key as Context<KeyType, ValueType>;
+}
+
+/**
+ * A callback which is provided by a context requester and is called with the value satisfying the request.
+ * This callback can be called multiple times by context providers as the requested value is changed.
+ */
+export type ContextCallback<ValueType> = (value: ValueType, unsubscribe?: () => void) => void;
+
+/**
+ * An event fired by a context requester to signal it desires a named context.
+ *
+ * A provider should inspect the `context` property of the event to determine if it has a value that can
+ * satisfy the request, calling the `callback` with the requested value if so.
+ *
+ * If the requested context event contains a truthy `subscribe` value, then a provider can call the callback
+ * multiple times if the value is changed, if this is the case the provider should pass an `unsubscribe`
+ * function to the callback which requesters can invoke to indicate they no longer wish to receive these updates.
+ */
+export class ContextRequestEvent<T extends UnknownContext> extends Event {
+  context: T;
+  callback: ContextCallback<ContextType<T>>;
+  subscribe?: boolean;
+
+  public constructor(context: T, callback: ContextCallback<ContextType<T>>, subscribe?: boolean) {
+    super('context-request', { bubbles: true, composed: true });
+
+    this.context = context;
+    this.callback = callback;
+    this.subscribe = subscribe;
+  }
+}
+
+declare global {
+  interface HTMLElementEventMap {
+    /**
+     * A 'context-request' event can be emitted by any element which desires
+     * a context value to be injected by an external provider.
+     */
+    'context-request': ContextRequestEvent<Context<unknown, unknown>>;
+  }
+}

package/src/lib/dom-injector.test.ts

@@ -1,30 +1,48 @@
-import { expect } from '@open-wc/testing';
-
+import { assert } from 'chai';
 import { DOMInjector } from './dom-injector.js';
-import { Injectables } from './injector.js';
+import { INJECTOR_CTX } from './context/injector.js';
+import { Injector } from './injector.js';
+import { ContextRequestEvent } from './context/protocol.js';
 
 describe('DOMInjector', () => {
-  it('should attach an injector to a dom element', () => {
-    const root = document.createElement('div');
-    const app = new DOMInjector();
+  it('should respond to elements looking for an injector', () => {
+    const injector = new DOMInjector();
+    injector.attach(document.body);
+
+    const host = document.createElement('div');
+    document.body.append(host);
 
-    app.attach(root);
+    let parent: Injector | null = null;
 
-    const injector = Injectables.get(root);
+    host.dispatchEvent(
+      new ContextRequestEvent(INJECTOR_CTX, (i) => {
+        parent = i;
+      })
+    );
 
-    expect(injector).to.equal(app);
+    assert.equal(parent, injector);
+
+    injector.detach();
+    host.remove();
   });
 
-  it('should remove an injector associated with a dom element', () => {
-    const root = document.createElement('div');
-    const app = new DOMInjector();
+  it('should send request looking for other injector contexts', () => {
+    const parent = new Injector();
+    const injector = new DOMInjector();
+
+    const cb = (e: any) => {
+      if (e.context === INJECTOR_CTX) {
+        e.callback(parent);
+      }
+    };
 
-    app.attach(root);
+    document.body.addEventListener('context-request', cb);
 
-    expect(Injectables.get(root)).to.equal(app);
+    injector.attach(document.body);
 
-    app.detach(root);
+    assert.equal(injector.parent, parent);
 
-    expect(Injectables.get(root)).to.equal(undefined);
+    injector.detach();
+    document.body.removeEventListener('context-request', cb);
   });
 });

package/src/lib/dom-injector.ts

@@ -1,11 +1,35 @@
-import { Injectables, Injector } from './injector.js';
+import { ContextRequestEvent } from './context/protocol.js';
+import { INJECTOR_CTX } from './context/injector.js';
+import { Injector } from './injector.js';
 
 export class DOMInjector extends Injector {
-  attach(root: HTMLElement) {
-    Injectables.set(root, this);
+  #contextCallback = (e: ContextRequestEvent<{ __context__: unknown }>) => {
+    if (e.context === INJECTOR_CTX) {
+      if (e.target !== this.#element) {
+        e.stopPropagation();
+
+        e.callback(this);
+      }
+    }
+  };
+
+  #element: HTMLElement | null = null;
+
+  attach(element: HTMLElement): void {
+    this.#element = element;
+
+    this.#element.addEventListener('context-request', this.#contextCallback);
+
+    this.#element.dispatchEvent(
+      new ContextRequestEvent(INJECTOR_CTX, (parent) => {
+        this.setParent(parent);
+      })
+    );
   }
 
-  detach(root: HTMLElement) {
-    Injectables.delete(root);
+  detach(): void {
+    if (this.#element) {
+      this.#element.removeEventListener('context-request', this.#contextCallback);
+    }
   }
 }

package/src/lib/inject.test.ts

@@ -1,25 +1,12 @@
-import { expect } from '@open-wc/testing';
+import { assert } from 'chai';
 
 import { inject } from './inject.js';
 import { injectable } from './injectable.js';
 import { Injector } from './injector.js';
 import { StaticToken } from './provider.js';
 
-describe('inject', () => {
-  it('should work', () => {
-    class HelloService {}
-
-    @injectable()
-    class HelloWorld extends HTMLElement {
-      hello = inject(HelloService);
-    }
-
-    customElements.define('inject-1', HelloWorld);
-
-    expect(new HelloWorld().hello()).to.be.instanceOf(HelloService);
-  });
-
-  it('should throw error if called in constructor', () => {
+it('should throw error if called in constructor', () => {
+  assert.throws(() => {
     class FooService {
       value = '1';
     }
@@ -35,49 +22,53 @@ describe('inject', () => {
 
     const parent = new Injector();
 
-    try {
-      parent.inject(BarService);
-
-      throw new Error('Should not succeed');
-    } catch (err) {
-      const error = err as Error;
+    parent.inject(BarService);
+  }, 'BarService is either not injectable or a service is being called in the constructor.');
+});
 
-      expect(error.message).to.equal(
-        `BarService is either not injectable or a service is being called in the constructor. \n Either add the @injectable() to your class or use the [LifeCycle.onInject] callback method.`
-      );
-    }
-  });
+it('should throw error if static token is unavailable', () => {
+  assert.throws(() => {
+    const TOKEN = new StaticToken('test');
 
-  it('should use the calling injector as parent', () => {
-    class FooService {
-      value = '1';
-    }
+    const parent = new Injector();
 
-    @injectable()
-    class BarService {
-      foo = inject(FooService);
-    }
+    parent.inject(TOKEN);
+  }, 'Provider not found for "test"');
+});
 
-    const parent = new Injector([
-      {
-        provide: FooService,
-        use: class extends FooService {
-          value = '100';
+it('should use the calling injector as parent', () => {
+  class FooService {
+    value = '1';
+  }
+
+  @injectable()
+  class BarService {
+    foo = inject(FooService);
+  }
+
+  const parent = new Injector({
+    providers: [
+      [
+        FooService,
+        {
+          use: class extends FooService {
+            value = '100';
+          }
         }
-      }
-    ]);
-
-    expect(parent.inject(BarService).foo().value).to.equal('100');
+      ]
+    ]
   });
 
-  it('should inject a static token', () => {
-    const TOKEN = new StaticToken('test', () => 'Hello World');
+  assert.strictEqual(parent.inject(BarService).foo().value, '100');
+});
 
-    @injectable()
-    class HelloWorld {
-      hello = inject(TOKEN);
-    }
+it('should inject a static token', () => {
+  const TOKEN = new StaticToken('test', () => 'Hello World');
 
-    expect(new HelloWorld().hello()).to.equal('Hello World');
-  });
+  @injectable()
+  class HelloWorld {
+    hello = inject(TOKEN);
+  }
+
+  assert.strictEqual(new HelloWorld().hello(), 'Hello World');
 });

package/src/lib/inject.ts

@@ -1,18 +1,17 @@
 import { InjectionToken } from './provider.js';
-
-import { Injectables } from './injector.js';
+import { injectables } from './injector.js';
 
 export type Injected<T> = () => T;
 
 export function inject<This extends object, T>(token: InjectionToken<T>): Injected<T> {
   return function (this: This) {
-    const injector = Injectables.get(this);
+    const injector = injectables.get(this);
 
     if (injector === undefined) {
-      const name = Object.getPrototypeOf(this.constructor).name;
+      const name = this.constructor.name;
 
       throw new Error(
-        `${name} is either not injectable or a service is being called in the constructor. \n Either add the @injectable() to your class or use the [LifeCycle.onInject] callback method.`
+        `${name} is either not injectable or a service is being called in the constructor. \n Either add the @injectable() to your class or use the @injected callback method.`
       );
     }
 

package/src/lib/injectable-el.test.ts

@@ -0,0 +1,130 @@
+import { assert } from 'chai';
+
+import { inject } from './inject.js';
+import { injectable } from './injectable.js';
+
+it('should allow services to be injected into custom element', () => {
+  class Foo {}
+
+  @injectable()
+  class MyElement extends HTMLElement {
+    foo = inject(Foo);
+  }
+
+  customElements.define('injectable-1', MyElement);
+
+  const el = new MyElement();
+
+  assert.instanceOf(el.foo(), Foo);
+});
+
+it('should allow services to be injected into custom elements that has been extended', () => {
+  class Foo {}
+
+  class MyBaseElement extends HTMLElement {}
+
+  @injectable()
+  class MyElement extends MyBaseElement {
+    foo = inject(Foo);
+  }
+
+  customElements.define('injectable-2', MyElement);
+
+  const el = new MyElement();
+
+  assert.instanceOf(el.foo(), Foo);
+});
+
+it('should handle parent HTML Injectors', async () => {
+  @injectable()
+  class A {}
+
+  @injectable()
+  class B {
+    a = inject(A);
+  }
+
+  class AltA implements A {}
+
+  @injectable({
+    providers: [
+      [B, { use: B }],
+      [A, { use: AltA }]
+    ]
+  })
+  class Parent extends HTMLElement {}
+
+  @injectable()
+  class Child extends HTMLElement {
+    b = inject(B);
+  }
+
+  customElements.define('injectable-parent-1', Parent);
+  customElements.define('injectable-child-1', Child);
+
+  const el = document.createElement('div');
+  el.innerHTML = /*html*/ `
+    <injectable-parent-1>
+      <injectable-child-1></injectable-child-1>
+    </injectable-parent-1>
+  `;
+
+  document.body.append(el);
+
+  const child = el.querySelector<Child>('injectable-child-1')!;
+
+  assert.instanceOf(child.b().a(), AltA);
+
+  el.remove();
+});
+
+it('should handle changing contexts', async () => {
+  class A {}
+  class AltA implements A {}
+
+  @injectable({
+    providers: [[A, { use: A }]]
+  })
+  class Ctx1 extends HTMLElement {}
+
+  @injectable({
+    providers: [[A, { use: AltA }]]
+  })
+  class Ctx2 extends HTMLElement {}
+
+  @injectable()
+  class Child extends HTMLElement {
+    a = inject(A);
+  }
+
+  customElements.define('ctx-1', Ctx1);
+  customElements.define('ctx-2', Ctx2);
+  customElements.define('ctx-child', Child);
+
+  const el = document.createElement('div');
+  el.innerHTML = /*html*/ `
+    <div>
+      <ctx-1>
+        <ctx-child></ctx-child>
+      </ctx-1>
+
+      <ctx-2></ctx-2>
+    </div>
+  `;
+
+  document.body.append(el);
+
+  const ctx2 = el.querySelector('ctx-2')!;
+
+  let child = el.querySelector<Child>('ctx-child')!;
+
+  assert.instanceOf(child.a(), A);
+
+  child.remove();
+
+  ctx2.append(child);
+
+  child = el.querySelector<Child>('ctx-child')!;
+
+  assert.instanceOf(child.a(), AltA);
+});