Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ckgrafico/inversify-props
Wrapper of Inversify to inject your dependencies in the components, made with TypeScript and compatible with Vue, React and other component libraries.
https://github.com/ckgrafico/inversify-props
component dependency-injection injection lit-element polymer react vue
Last synced: 17 days ago
JSON representation
Wrapper of Inversify to inject your dependencies in the components, made with TypeScript and compatible with Vue, React and other component libraries.
- Host: GitHub
- URL: https://github.com/ckgrafico/inversify-props
- Owner: CKGrafico
- License: mit
- Created: 2019-03-03T17:21:38.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T03:34:54.000Z (over 1 year ago)
- Last Synced: 2024-10-15T03:23:59.642Z (29 days ago)
- Topics: component, dependency-injection, injection, lit-element, polymer, react, vue
- Language: TypeScript
- Homepage:
- Size: 6.77 MB
- Stars: 85
- Watchers: 3
- Forks: 9
- Open Issues: 53
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Inversify Props
This package is a wrapper of [Inversify](https://github.com/inversify) to simplify how inject your dependencies with property decorators in the components, made with TypeScript and compatible with Vue, React and other component libraries.
Do you use Hooks? You can try the experimental package [inversify-hooks](https://github.com/ckgrafico/inversify-hooks)
[](https://github.com/CKGrafico/inversify-props/blob/master/LICENSE)
[](https://github.com/CKGrafico/inversify-props/network)
[](https://github.com/CKGrafico/inversify-props/issues)
## Installation
```bash
$ npm install inversify-props reflect-metadata --save
```
The inversify-props type definitions are included in the inversify-props npm package.
## How to use
```ts
import 'reflect-metadata'; // Import only once
import { container, inject } from 'inversify-props';
container.addSingleton(Service1);
container.addSingleton(Service2);
container.addSingleton(Service3);
export default class extends Component {
@inject() service1: IService1;
@inject() _service2: IService2;
@inject() Service3: IService3;
}
```
> :warning: If you use a minifier or a obfuscator, you need to configure it to preserve the class and function names in the build output. See this [paragraph](https://github.com/CKGrafico/inversify-props#how-to-configure-uglify-or-terser) for more info.
## How to use this library outside of a component
```ts
import 'reflect-metadata'; // Import only once
import { cid, container, inject } from 'inversify-props';
container.addSingleton(Service1, 'MyService1');
// You can inject in other services as a Prop
export class MyOtherService {
@inject() private service1: IService1;
}
// Also in the constructor as a param
export class MyOtherService {
constructor(@inject() private exampleService: IExampleService) {}
}
// Or in any function as a variable
export function myHelper() {
const service1 = container.get(cid.IService1);
}
// camelCase, PascalCase and _ are allowed
export class MyOtherService {
@inject() private service1: IService1;
@inject() private _service1: IService1;
@inject() private Service1: IService1;
@inject() private _Service1: IService1;
}
```
## You can also use any ID that you prefer if you don't want to use auto generated ids
```ts
import 'reflect-metadata'; // Import only once
import { container, inject } from 'inversify-props';
container.addSingleton(Service1, 'MyService1');
export default class extends Component {
@inject('MyService1') service1: IService1;
}
```
## This library provides a container to make your experience easier, but you can create your own container.
```ts
import 'reflect-metadata'; // Import only once
import { Container, inject, setContainer } from 'inversify-props';
setContainer(new Container());
container.addSingleton(Service1, 'MyService1');
export default class extends Component {
@inject('MyService1') service1: IService1;
}
```
> :warning: **Important!** inversify-props requires TypeScript >= 2.0 and the `experimentalDecorators`, `emitDecoratorMetadata`, `types` and `lib`
> compilation options in your `tsconfig.json` file.
```json
{
"compilerOptions": {
"target": "es5",
"lib": ["es6"],
"types": ["reflect-metadata"],
"module": "commonjs",
"moduleResolution": "node",
"experimentalDecorators": true,
"emitDecoratorMetadata": true
}
}
```
## Why we made this package
The idea is to add a simple wrapper that helps us to inject dependencies in components using `property decorators`, we have also extend a little `inversify` adding some methods that make our experience injecting dependencies easier.
**You probably don't need this if:**
- You have experience using inversify and you don't need to simplify the process.
- You want to use all the power of inversify, we are only injecting dependencies like services, helpers, utils...
- You don't want to inject your dependencies as properties.
## How to register a dependency
Inversify needs an id to register our dependencies, this wrapper is going to do this for you 'magically' but if you want to uglify the code, keep reading the docs 🤓.
First of all create a class and an interface with the public methods of your class.
```ts
// iservice1.ts
export interface IService1 {
method1(): string;
}
// service.ts
export class Service1 implements IService1 {
method1(): string {
return 'method 1';
}
}
```
Now is time to register the service in the container, we usually do that in `app.container.ts` or `app.ts`.
```ts
container.addSingleton(Service1);
```
## How to test
There are some helper functions to test, the recommended way to test is beforeEach test:
1. Reset the Container
2. Register again all the dependencies of the container (this is your job)
3. Mock all the necessary dependencies for the test
```ts
beforeEach(() => {
resetContainer();
containerBuilder();
mockSingleton(cid.IHttpService, HttpServiceMock);
});
```
## Other ways to register a class
As [inversify accepts](https://github.com/inversify/InversifyJS/blob/master/wiki/scope.md), we have configured three types of registration.
- Singleton: The dependency will be created only once, one dependency - one object.
- Transient: The dependency will be created each time is injected, one dependency - one object per injection.
- Request: Special case of singleton, more info in [official docs](https://github.com/inversify/InversifyJS/blob/master/wiki/scope.md#about-inrequestscope).
## How to use in your components
Once your dependencies are registered in the container, is simple as create a property with the name and the interface.
```ts
export default class extends Component {
@inject() service1: IService1;
}
```
> Note: Part of the magic is that the name of the property has to be the name of the interface, this is how we don't need to add the `id`.
## Some examples
- [Basic example with Vue](https://github.com/CKGrafico/inversify-props/tree/master/examples/vue)
- [Basic example with LitElement](https://github.com/CKGrafico/inversify-props/tree/master/examples/lit-element)
- [Used in my Boilerplates](https://boilerplates.js.org)
## How to configure Uglify or Terser
If you want to use Uglify or Terser to obfuscate the code, you will need to add this options to preserve the names of the classes (we need them to generate the ids `magically` 😉).
```ts
new UglifyJSPlugin({
uglifyOptions: {
keep_classnames: true,
keep_fnames: true
}
});
```
```ts
new TerserPlugin({
terserOptions: {
keep_classnames: true,
keep_fnames: true
}
});
```
>Note: **Vue-cli** uses TerserPlugin under the hood.
You can configure the Terser plugin inside your *vue.config.js* file in `configureWebpack` node via the `optimization.minimizer` property.