react-obsidian 0.0.23 → 0.0.24

package/README.md

@@ -32,8 +32,10 @@ React Obsidian is guided by the principles of the Dependency Injection pattern,
 * [Advance usage](https://github.com/wix-incubator/react-obsidian#advance-usage)
   * [Accessing props in graphs](https://github.com/wix-incubator/react-obsidian#accessing-props-in-graphs)
   * [Singleton graphs and providers](https://github.com/wix-incubator/react-obsidian#singleton-graphs-and-providers)
+  * [Lazy property injection](https://github.com/wix-incubator/react-obsidian#lazy-property-injection)
+  * [Typing graphs](https://github.com/wix-incubator/react-obsidian#typing-graphs)
   * [Graph middleware](https://github.com/wix-incubator/react-obsidian#graph-middleware)
-  * [Clear graphs](https://github.com/wix-incubator/react-obsidian#clear-graphs)
+  * [Clearing graphs](https://github.com/wix-incubator/react-obsidian#clearing-graphs)
 
 
 
@@ -222,6 +224,63 @@ class ApplicationGraph {
 }
 ```
 
+### Lazy property injection
+Class properties can be injected lazily by using the `@LazyInject()` decorator. This is useful when the injection should be done in a lifecycle method instead of in the class constructor. 
+
+```ts
+@Injectable(ApplicationGraph)
+class Foo {
+  @LazyInject() private bar!: Bar;
+
+  constructor() {
+    console.log(bar) // undefined
+    Obsidian.inject(this);
+    console.log(bar) // Bar {}
+  }
+}
+```
+
+In the example above, the dependencies are resolved from the graph declared in the `@Injectable()` decorator. Declaring the graph in advance isn't always desirable. When using the `@LazyInject()` decorator, we can omit the `@Injectable()` decorator and specify the graph to inject from in the call to ``Obsidian.inject()`.
+
+```ts
+class Foo {
+  @LazyInject() private bar!: Bar;
+
+  constructor() {
+    console.log(bar) // undefined
+    Obsidian.inject(this, () => new ApplicationGraph());
+    console.log(bar) // Bar {}
+  }
+}
+```
+
+### Typing graphs
+Obsidian exposes a utility `type` that represents the dependencies provided by a graph. This type is useful when typing props passed to components or hooks. It's especially useful when you need to differentiate between "own" props and injected props.
+
+```ts
+type InjectedDependencies = DependenciesOf<ApplicationGraph> // { biLogger: BiLogger, httpClient: HttpClient }
+
+// These are props our hook requires from the calling scope
+interface OwnProps {
+  someArgs: string
+}
+
+// This interface represents the object returned from the hook
+interface Result {
+  //
+}
+
+// Our hook requires two dependencies:
+// 1. someArg - passed down from the calling scope
+// 2. biLogger - injected from the ApplicationGraph
+const hook = ({someArg, biLogger}: OwnProps & InjectedDependencies): Result => {
+  // ...
+}
+
+// When invoking the hook, it must be provided with `someArg` since OwnProps aren't optional
+const injectedHook: (props: OwnProps & Partial<InjectedDependencies>) => Result = injectHookWithArguments<InjectedDependencies, OwnProps, Result>(hook, MainApplication);
+```
+
 ### Graph middleware
 When working on large scale applications, we often need to to hook into various low level operations. Obsidian lets you hook into the graph creation process by adding middleware(s).
 
@@ -249,7 +308,7 @@ const loggingMiddleware = new class extends GraphMiddleware {
     Obsidian.addGraphMiddleware(loggingMiddleware);
 ```
 
-### Clear graphs
+### Clearing graphs
 Graphs can be cleared by invoking `Obsidian.clearGraphs()`. This is useful in tests or when you need to reset the system to it's original state, for example when a user logs out.
 
 #### Clearing graphs automatically during execution of Jest tests

package/dist/src/injectors/hooks/InjectHook.d.ts

@@ -1,5 +1,5 @@
 import { ObjectGraph } from '../../graph/ObjectGraph';
 import { Constructable } from '../../types';
-export declare function injectHookWithArguments<Result, Injected, Args>(hook: (args: Injected & Args) => Result, Graph: Constructable<ObjectGraph>): (props: Args & Partial<Injected>) => Result;
-export declare function injectHook<Result, Injected>(hook: (args: Injected) => Result, Graph: Constructable<ObjectGraph>): (props?: Partial<Injected>) => Result;
+export declare function injectHookWithArguments<Injected, Own, Result = {}>(hook: (args: Injected & Own) => Result, Graph: Constructable<ObjectGraph>): (props: Own & Partial<Injected>) => Result;
+export declare function injectHook<Injected, Result = {}>(hook: (args: Injected) => Result, Graph: Constructable<ObjectGraph>): (props?: Partial<Injected>) => Result;
 //# sourceMappingURL=InjectHook.d.ts.map

package/dist/src/injectors/hooks/InjectHook.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InjectHook.d.ts","sourceRoot":"","sources":["../../../../src/injectors/hooks/InjectHook.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAU5C,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAC5D,IAAI,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,KAAK,MAAM,EACvC,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,GAChC,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,MAAM,CAE7C;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,QAAQ,EACzC,IAAI,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,MAAM,EAChC,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,GAChC,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK,MAAM,CAEvC"}
+{"version":3,"file":"InjectHook.d.ts","sourceRoot":"","sources":["../../../../src/injectors/hooks/InjectHook.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAU5C,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,EAAE,EAChE,IAAI,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,GAAG,KAAK,MAAM,EACtC,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,GAChC,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,MAAM,CAE5C;AAED,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,EAAE,EAC9C,IAAI,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,MAAM,EAChC,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,GAChC,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK,MAAM,CAEvC"}

package/dist/src/injectors/hooks/InjectHook.js.map

@@ -1 +1 @@
-{"version":3,"file":"InjectHook.js","sourceRoot":"","sources":["../../../../src/injectors/hooks/InjectHook.ts"],"names":[],"mappings":";;;;;;AAGA,gEAA0C;AAE1C,IAAM,YAAY,GAAG,IAAI,sBAAY,EAAE,CAAC;AAExC,6HAA6H;AAC7H,0FAA0F;AAC1F,uHAAuH;AACvH,yEAAyE;AAEzE,SAAgB,uBAAuB,CACrC,IAAuC,EACvC,KAAiC;IAEjC,OAAO,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC1C,CAAC;AALD,0DAKC;AAED,SAAgB,UAAU,CACxB,IAAgC,EAChC,KAAiC;IAEjC,OAAO,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC1C,CAAC;AALD,gCAKC"}
+{"version":3,"file":"InjectHook.js","sourceRoot":"","sources":["../../../../src/injectors/hooks/InjectHook.ts"],"names":[],"mappings":";;;;;;AAGA,gEAA0C;AAE1C,IAAM,YAAY,GAAG,IAAI,sBAAY,EAAE,CAAC;AAExC,6HAA6H;AAC7H,0FAA0F;AAC1F,uHAAuH;AACvH,yEAAyE;AAEzE,SAAgB,uBAAuB,CACrC,IAAsC,EACtC,KAAiC;IAEjC,OAAO,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC1C,CAAC;AALD,0DAKC;AAED,SAAgB,UAAU,CACxB,IAAgC,EAChC,KAAiC;IAEjC,OAAO,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC1C,CAAC;AALD,gCAKC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-obsidian",
-  "version": "0.0.23",
+  "version": "0.0.24",
   "description": "Dependency injection framework for React and React Native applications",
   "scripts": {
     "prepack": "npm run lint && tsc --project tsconfig.prod.json",

package/src/injectors/hooks/InjectHook.ts

@@ -10,14 +10,14 @@ const hookInjector = new HookInjector();
 // 1. injectHookWithArguments: Should be used when a hook requires parameters in addition to the injected dependencies.
 // 2. injectHook: Should be used when a hook does not require parameters.
 
-export function injectHookWithArguments<Result, Injected, Args>(
-  hook: (args: Injected & Args) => Result,
+export function injectHookWithArguments<Injected, Own, Result = {}>(
+  hook: (args: Injected & Own) => Result,
   Graph: Constructable<ObjectGraph>,
-): (props: Args & Partial<Injected>) => Result {
+): (props: Own & Partial<Injected>) => Result {
   return hookInjector.inject(hook, Graph);
 }
 
-export function injectHook<Result, Injected>(
+export function injectHook<Injected, Result = {}>(
   hook: (args: Injected) => Result,
   Graph: Constructable<ObjectGraph>,
 ): (props?: Partial<Injected>) => Result {