@joist/di 3.0.0-next.10 → 3.0.0-next.11

package/README.md

@@ -1,7 +1,6 @@
 # Di
 
-Dependency Injection in ~800 bytes. The Joist Dependency Injector is a small inversion of control (IOC) container that resolves dependencies lazyily.
-This means that it passes functions around and that dependencies are not initialized untill they are called.
+Dependency Injection in ~800 bytes. This allows you to inject services into other class instances (including custom elements).
 
 #### Installation:
 
@@ -12,191 +11,43 @@ npm i @joist/di
 #### Example:
 
 ```TS
-import { Injector, Injected } from '@joist/di';
+import { Injector, injectable, inject } from '@joist/di';
 
+// Any class can be injected
 class FooService {
   sayHello() {
     return 'Hello From FooService';
   }
 }
 
+// classes must be decorated with @injectable to use the inject function
+@injectable
 class BarService {
-  static inject = [FooService];
-
-  constructor(public foo: Injected<FooService>) { }
+  foo = inject(FooService);
 
   sayHello() {
     return this.foo().sayHello();
   }
 }
 
-const app = new Injector();
-
-app.get(BarService).sayHello(); // Hello from BarService and Hello from FooService
-```
-
-#### Override A Service:
-
-```TS
-import { Injector, inject, Injected } from '@joist/di';
-
-class FooService {
-  sayHello() {
-    return 'Hello From FooService';
-  }
-}
-
-class BarService {
-  static inject = [FooService];
-
-  constructor(public foo: Injected<FooService>) {}
-
-  sayHello() {
-    return 'Hello From BarService and ' + this.foo().sayHello();
-  }
-}
-
-// Override FooService with an alternate implementation
-const app = new Injector([
-  {
-    provide: FooService,
-    use: class extends FooService {
-      sayHello() {
-        return 'IT HAS BEEN OVERRIDEN'
-      }
-    }
-  }
-]);
-
-app.get(BarService).sayHello(); // Hello from BarService and IT HAS BEEN OVERRIDEN
-```
-
-#### Root Service
-
-If you have nested injectors and you want to make sure the same instance is provided to all you can mark your class as a "service".
-
-```TS
-class FooService {
-  static service = true;
-
-  sayHello() {
-    return 'Hello From FooService';
-  }
-}
-```
-
-## Custom Elements
-
-Joist DI was built with custom elements in mind. Custom elements are an example where you do not have direct control over how your classes are instantiated.
-
-Since the browser will be what initializes your custom elements we need to be able to tell the browser how to pass arguments.
-
-The `@injectable` decorator allows the Joist Dependency Injector to pass arguments to your custom element when instances of your element is created.
-
-#### Inject dependency into your custom element constructor
-
-```TS
-import { injectable, Injected } from '@joist/di';
-
-class MyService {}
-
-@injectable
-class MyElement extends HTMLElement {
-  static inject = [MyService];
-
-  constructor(public myService: Injected<MyService>) {}
-}
-
-customElements.define('my-element', MyElement);
-```
-
-#### Define global providers and overrides
-
-This allows your to override services for different environments or scenarios
-
-```TS
-import { environment, injectable, Injected } from '@joist/di';
-
-class Config {
-  apiUrl = 'http://localhost:4000/api/'
-}
-
-environment().providers.push({
-  provide: Config,
-  use: class {
-    apiUrl = 'http://real-api/api/'
-  }
-});
-
-@injectable
-class MyElement extends HTMLElement {
-  static inject = [Config];
-
-  constructor(config: Injected<Config>) {
-    console.log(config().apiUrl); // http://real-api/api/
-  }
-}
-
-customElements.define('my-element', MyElement);
-```
-
-## Context
-
-The Joist injector is hierarchical meaning that you can define context for just one part of the DOM tree.
-
-### NOTE:
-
-When using context elements it is important that they are registered BEFORE your other elements.
-If child elements are upgraded before the context element they won't be able to find the context scope.
-If you plan on using context elements you will need to wait until the element has been attached so it can find any potential parent injectors.
-
-```TS
-import { injectable, Injected } from '@joist/di';
-
-class Colors {
-  primary = 'red';
-  secodnary = 'green';
-}
-
-@injectable
-class ColorCtx extends HTMLElement {
-  static providers = [
-    {
-      provide: Colors,
-      use: class implements Colors {
-        primary = 'orange';
-        secondary = 'purple';
-      },
-    },
-  ];
-}
-
 @injectable
-class MyElement extends HTMLElement {
-  static inject = [Colors];
+class BazService {
+  #bar = inject(BarService);
 
-  constructor(public colors: Injected<Colors>) {
-    super();
+  constructor() {
+    // will throw error
+    console.log(this.bar().sayHello())
   }
 
-  connectedCallback() {
-    // run in connected callback so your element can check its parents
-    const { primary } = this.colors();
-
-    this.style.background = primary;
+  // services cannot be accessed in the constructor.
+  // the onInject callback will be called when injectors have resolved
+  onInject() {
+    console.log(this.bar().sayHello())
   }
 }
 
-customElements.define('color-ctx', ColorCtx);
-customElements.define('my-element', MyElement);
-```
 
-```HTML
-<!-- Default Colors -->
-<my-element></my-element>
+const app = new Injector();
 
-<!-- Special color ctx -->
-<color-ctx>
-  <my-element></my-element>
-</color-ctx>
+app.get(BazService);
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@joist/di",
-  "version": "3.0.0-next.10",
+  "version": "3.0.0-next.11",
   "main": "./target/lib.js",
   "module": "./target/lib.js",
   "exports": {
@@ -35,17 +35,10 @@
     "access": "public"
   },
   "scripts": {
-    "prepare": "wireit",
     "test": "wireit",
     "build": "wireit"
   },
   "wireit": {
-    "prepare": {
-      "dependencies": [
-        "build",
-        "test"
-      ]
-    },
     "build": {
       "command": "tsc --build --pretty",
       "clean": "if-file-deleted",

package/target/lib/environment.js

@@ -5,6 +5,6 @@ export function environment() {
 }
 export function clearEnvironment() {
     rootInjector.providers = [];
-    rootInjector.instances = new WeakMap();
+    rootInjector.clear();
 }
 //# sourceMappingURL=environment.js.map

package/target/lib/environment.js.map

@@ -1 +1 @@
-{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../src/lib/environment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,MAAM,YAAY,GAAG,IAAI,QAAQ,EAAE,CAAC;AAEpC,MAAM,UAAU,WAAW;IACzB,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,YAAY,CAAC,SAAS,GAAG,EAAE,CAAC;IAC5B,YAAY,CAAC,SAAS,GAAG,IAAI,OAAO,EAAE,CAAC;AACzC,CAAC"}
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../src/lib/environment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,MAAM,YAAY,GAAG,IAAI,QAAQ,EAAE,CAAC;AAEpC,MAAM,UAAU,WAAW;IACzB,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,YAAY,CAAC,SAAS,GAAG,EAAE,CAAC;IAC5B,YAAY,CAAC,KAAK,EAAE,CAAC;AACvB,CAAC"}

package/target/lib/environment.test.js

@@ -3,6 +3,7 @@ import { expect } from '@open-wc/testing';
 import { Injector } from './injector.js';
 import { environment, clearEnvironment } from './environment.js';
 import { injectable } from './injectable.js';
+import { inject } from './inject.js';
 describe('environment', () => {
     afterEach(clearEnvironment);
     it('should create a global Injector instance', () => {
@@ -21,16 +22,9 @@ describe('environment', () => {
                 static {
                     __esDecorate(null, _classDescriptor = { value: this }, _classDecorators, { kind: "class", name: this.name }, null, _classExtraInitializers);
                     MyElement = _classThis = _classDescriptor.value;
-                }
-                my;
-                static inject = [MyService];
-                constructor(my) {
-                    super();
-                    this.my = my;
-                }
-                static {
                     __runInitializers(_classThis, _classExtraInitializers);
                 }
+                my = inject(MyService);
             };
             return MyElement = _classThis;
         })();

package/target/lib/environment.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"environment.test.js","sourceRoot":"","sources":["../../src/lib/environment.test.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EAAE,QAAQ,EAAY,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAE5B,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,SAAS;YACb,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;;YAIlB,SAAS;oCADd,UAAU;;;;gBACL,SAAS,QAAC,SAAQ,WAAW;;oBAAnC,4IAMC;oBANK,SAAS;;gBAGM,EAAE;gBAFrB,MAAM,CAAC,MAAM,GAAG,CAAC,SAAS,CAAC,CAAC;gBAE5B,YAAmB,EAAuB;oBACxC,KAAK,EAAE,CAAC;oBADS,OAAE,GAAF,EAAE,CAAqB;gBAE1C,CAAC;;oBALG,uDAAS;;;mBAAT,SAAS;;QAQf,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAE1C,MAAM,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAc,CAAC;QAExD,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"environment.test.js","sourceRoot":"","sources":["../../src/lib/environment.test.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAE5B,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,SAAS;YACb,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;;YAIlB,SAAS;oCADd,UAAU;;;;gBACL,SAAS,QAAC,SAAQ,WAAW;;oBAAnC,4IAEC;oBAFK,SAAS;oBAAT,uDAAS;;gBACb,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;;mBADnB,SAAS;;QAIf,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAE1C,MAAM,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAc,CAAC;QAExD,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/target/lib/inject.d.ts

@@ -0,0 +1,3 @@
+import { ProviderToken } from './provider.js';
+import { Injectable, Injected } from './injector.js';
+export declare function inject<This extends Injectable, T extends object>(token: ProviderToken<T>): Injected<T>;

package/target/lib/inject.js

@@ -0,0 +1,10 @@
+export function inject(token) {
+    return function () {
+        if (this.injector$$ === undefined) {
+            const name = Object.getPrototypeOf(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 onInject callback method.`);
+        }
+        return this.injector$$.get(token);
+    };
+}
+//# sourceMappingURL=inject.js.map

package/target/lib/inject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inject.js","sourceRoot":"","sources":["../../src/lib/inject.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,MAAM,CACpB,KAAuB;IAEvB,OAAO;QACL,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;YACjC,MAAM,IAAI,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC;YAE1D,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,6JAA6J,CACrK,CAAC;SACH;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC,CAAC;AACJ,CAAC"}

package/target/lib/inject.test.d.ts

@@ -0,0 +1 @@
+export {};

package/target/lib/inject.test.js

@@ -0,0 +1,90 @@
+import { __esDecorate, __runInitializers } from "tslib";
+import { expect } from '@open-wc/testing';
+import { inject } from './inject.js';
+import { injectable } from './injectable.js';
+import { Injector } from './injector.js';
+describe('inject', () => {
+    it('should work', () => {
+        class HelloService {
+        }
+        let HelloWorld = (() => {
+            let _classDecorators = [injectable];
+            let _classDescriptor;
+            let _classExtraInitializers = [];
+            let _classThis;
+            var HelloWorld = class extends HTMLElement {
+                static {
+                    __esDecorate(null, _classDescriptor = { value: this }, _classDecorators, { kind: "class", name: this.name }, null, _classExtraInitializers);
+                    HelloWorld = _classThis = _classDescriptor.value;
+                    __runInitializers(_classThis, _classExtraInitializers);
+                }
+                hello = inject(HelloService);
+            };
+            return HelloWorld = _classThis;
+        })();
+        customElements.define('inject-1', HelloWorld);
+        expect(new HelloWorld().hello()).to.be.instanceOf(HelloService);
+    });
+    it('should throw error if called in constructor', () => {
+        class FooService {
+            value = '1';
+        }
+        let BarService = (() => {
+            let _classDecorators_1 = [injectable];
+            let _classDescriptor_1;
+            let _classExtraInitializers_1 = [];
+            let _classThis_1;
+            var BarService = class {
+                static {
+                    __esDecorate(null, _classDescriptor_1 = { value: this }, _classDecorators_1, { kind: "class", name: this.name }, null, _classExtraInitializers_1);
+                    BarService = _classThis_1 = _classDescriptor_1.value;
+                    __runInitializers(_classThis_1, _classExtraInitializers_1);
+                }
+                foo = inject(FooService);
+                constructor() {
+                    this.foo();
+                }
+            };
+            return BarService = _classThis_1;
+        })();
+        const parent = new Injector();
+        try {
+            parent.get(BarService);
+            throw new Error('Should not succeed');
+        }
+        catch (err) {
+            const error = err;
+            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 onInject callback method.`);
+        }
+    });
+    it('should use the calling injector as parent', () => {
+        class FooService {
+            value = '1';
+        }
+        let BarService = (() => {
+            let _classDecorators_2 = [injectable];
+            let _classDescriptor_2;
+            let _classExtraInitializers_2 = [];
+            let _classThis_2;
+            var BarService = class {
+                static {
+                    __esDecorate(null, _classDescriptor_2 = { value: this }, _classDecorators_2, { kind: "class", name: this.name }, null, _classExtraInitializers_2);
+                    BarService = _classThis_2 = _classDescriptor_2.value;
+                    __runInitializers(_classThis_2, _classExtraInitializers_2);
+                }
+                foo = inject(FooService);
+            };
+            return BarService = _classThis_2;
+        })();
+        const parent = new Injector([
+            {
+                provide: FooService,
+                use: class extends FooService {
+                    value = '100';
+                },
+            },
+        ]);
+        expect(parent.get(BarService).foo().value).to.equal('100');
+    });
+});
+//# sourceMappingURL=inject.test.js.map

package/target/lib/inject.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inject.test.js","sourceRoot":"","sources":["../../src/lib/inject.test.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE;QACrB,MAAM,YAAY;SAAG;YAGf,UAAU;oCADf,UAAU;;;;gBACL,UAAU,QAAC,SAAQ,WAAW;;oBAApC,4IAEC;oBAFK,UAAU;oBAAV,uDAAU;;gBACd,KAAK,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;;mBADzB,UAAU;;QAIhB,cAAc,CAAC,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAE9C,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,UAAU;YACd,KAAK,GAAG,GAAG,CAAC;SACb;YAGK,UAAU;sCADf,UAAU;;;;gBACL,UAAU;;oBAAhB,kJAMC;oBANK,UAAU;oBAAV,2DAAU;;gBACd,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;gBAEzB;oBACE,IAAI,CAAC,GAAG,EAAE,CAAC;gBACb,CAAC;;mBALG,UAAU;;QAQhB,MAAM,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QAE9B,IAAI;YACF,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAEvB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;SACvC;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,KAAK,GAAG,GAAY,CAAC;YAE3B,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAC5B,uKAAuK,CACxK,CAAC;SACH;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,UAAU;YACd,KAAK,GAAG,GAAG,CAAC;SACb;YAGK,UAAU;sCADf,UAAU;;;;gBACL,UAAU;;oBAAhB,kJAEC;oBAFK,UAAU;oBAAV,2DAAU;;gBACd,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;;mBADrB,UAAU;;QAIhB,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAC;YAC1B;gBACE,OAAO,EAAE,UAAU;gBACnB,GAAG,EAAE,KAAM,SAAQ,UAAU;oBAC3B,KAAK,GAAG,KAAK,CAAC;iBACf;aACF;SACF,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}