Research
Security News
Malicious npm Packages Inject SSH Backdoors via Typosquatted Libraries
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
A very opinionated and different inversion of control container and dependency injector for Typescript, Node.js or browser apps
A very opinionated and lightweight (under 2kB minified and gzipped) inversion of control container and dependency injector for Node.js or browser apps. It is available for vanilla Javascript usage but its true power will be shown by building Typescript apps.
Quick Start Guide | Documentation | Contributing
💡 Do not want to waste your time on unnecessary documentation? Jump to the Quick Start Guide.
These are the reasons that have led me to reinvent the wheel and create DIOD:
Both reasons are related to some TypeScript constraints: whenever you want to work with type information in runtime (in compiled JS), you inevitably need to use decorators. Even so, you won't be able to have information about interfaces at runtime.
It might sound ridiculous but Typescript needs types.
Read this article in my blog if you want more context about the reasons behind DIOD.
npm install diod
# or
yarn add diod
# or
pnpm add diod
Modify your tsconfig.json
to include the following settings
{
"compilerOptions": {
"experimentalDecorators": true,
"emitDecoratorMetadata": true
}
}
Add a polyfill for the Reflect API (the example below uses reflect-metadata
). You can use:
The Reflect polyfill import should be added only once in your code base and before DIOD is used:
npm install reflect-metadata
# or
yarn add reflect-metadata
# or
pnpm add reflect-metadata
// main.ts
import 'reflect-metadata'
// Your code here...
All the registered services must be decorated because this is the only way to make type metadata available at runtime in Typescript. DIOD provides the @Service()
decorator for ease of usage, but you can create your own decorator to avoid coupling your inner architecture layers with DIOD.
Imagine that you want to have a class like this:
// application/use-cases/SignUpUseCase.ts
import { Service } from 'diod'
@Service()
export class SignUpUseCase {
constructor(
private readonly userRepository: UserRepository,
private readonly mailer: Mailer,
) {}
execute(userData: UserDto): void {
const user = this.userRepository.create(userData)
this.mailer.sendConfirmationEmail(user)
}
}
The D of the SOLID principles refers to dependency inversion. This principle encourages developers to use abstractions to define dependencies in certain situations. Abstractions are usually defined with interfaces in other languages, but Typescript interfaces are not available at runtime and that's why DIOD requires abstract classes for abstractions if you want them to be autowired. There is more information available in the Motivation section.
// application/services/Mailer.ts
export abstract class Mailer {
sendConfirmationEmail(userData: user): void
sendResetPasswordEmail(userData: user): void
}
// domain/UserRepository.ts
export abstract class UserRepository {
create(userData: UserDto): User
findBy(userData: UserCriteria): User[]
}
Finally, we need to create a configuration file where we will register every dependency of our app. This should be the only place where our dependencies will be coupled with a concrete implementation. We use to name this file diod.config.ts
.
// infrastructure/diod.config.ts
import { ContainerBuilder } from 'diod'
// Other imports...
const builder = new ContainerBuilder()
builder.register(Mailer).use(AcmeMailer)
builder.register(UserRepository).use(SqliteUserRepository)
builder.registerAndUse(SignUpUseCase) // This is an alias of builder.register(SignUpUseCase).use(SignUpUseCase)
const container = builder.build()
const signUpUseCase = container.get(SignUpUseCase)
signUpUseCase.execute({
/* ... */
})
The previous usage example assumes that you have some concrete implementations of the Mailer
and the UserRepository
abstractions. Note that abstract classes do not need to be extended and can be implemented just like an interface.
// infrastructure/AcmeMailer.ts
import { Service } from 'diod'
import { Mailer } from '../application/services/Mailer'
@Service()
export class AcmeMailer implements Mailer {
sendConfirmationEmail(userData: user): void {
// ...
}
sendResetPasswordEmail(userData: user): void {
// ...
}
}
// domain/SqliteUserRepository.ts
import { Service } from 'diod'
import { UserRepository } from '../domain/UserRepository'
@Service()
export class SqliteUserRepository implements UserRepository {
create(userData: UserDto): User {
// ...
}
findBy(userData: UserCriteria): User[] {
// ...
}
}
There is more useful information in the official documentation.
A special thanks to every open source contributor that helped or inspired me to create DIOD, including but not limited to all the contributors of the following libraries: InversifyJS, Node Dependency Injection, TSyringe, Autofac, Ninject and the Symfony DependencyInjection Component
DIOD will be pronounced like the English word 'diode' /ˈdaɪəʊd/. DIOD is the abbreviation of Dependency Injection On Demand, which is the first I was able to elaborate after I realized that the short diod
package name was free on the NPM registry.
DIOD is released under the MIT license:
MIT License
Copyright (c) 2021 Alberto Varela Sánchez
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[3.0.0] - 2024-10-04
FAQs
A very opinionated and different inversion of control container and dependency injector for Typescript, Node.js or browser apps
The npm package diod receives a total of 4,161 weekly downloads. As such, diod popularity was classified as popular.
We found that diod demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.