README.md

Unmaintained: this plugin needs a maintainer.

@elizaos/plugin-di - Dependency Injection Plugin for Eliza

This plugin provides a dependency injection system for Eliza plugins.

What is Dependency Injection?

Dependency Injection is a design pattern that allows you to inject dependencies into a class or function. This pattern is useful for decoupling components and making your code more modular and testable.

Examples of How to build a Plugin using Dependency Injection

Check the example folder for a simple example of how to create a plugin using Dependency Injection.

Where can I use Dependency Injection?

You can use Dependency Injection in any part of your Eliza plugin, including actions, evaluators, providers, services, and clients.

• Actions: Inject services or providers to interact with external APIs or services. Example
• Evaluators: Inject services or providers to evaluate conditions or perform calculations. Example
• Providers: Inject services or providers to provide data or resources. Example
• Services: Inject other services to perform business logic. Example
• Clients: Inject services to interact with external APIs or services. Lack of examples, but you can refer to the services example.

Decorators for Dependency Injection

This plugin provides a set of decorators that you can use to inject dependencies into your classes or functions.

From inversify

We use the inversify library to provide the dependency injection system. The following decorators are provided by the inversify library.

@injectable

Category: Class Decorator

This decorator marks a class as injectable. This means that you can inject this class into other classes using the @inject decorator.

import { injectable } from "inversify";

@injectable()
class SampleClass {
}

Remember to register the class with the container before injecting it into other classes.

import { globalContainer } from "@elizaos/plugin-di";

// Register the class with the container as a singleton, this means that the class will be instantiated only once.
globalContainer.bind(SingletonClass).toSelf().inSingletonScope();
// Register the class with the container as a request context, this means that the class will be instantiated for each request(in this case means each Character).
globalContainer.bind(CharactorContextClass).toSelf().inRequestScope();

@inject

Category: Parameter Decorator

This decorator marks a parameter as an injection target. This means that the parameter will be injected with the appropriate dependency when the class is instantiated.

import { injectable, inject } from "inversify";

@injectable()
class SampleClass {
  constructor(
    // Inject the SampleDependency as a public property of the class.
    @inject("SampleDependency") public sampleDependency: SampleDependency
  ) {}
}

From di plugin (used for BaseInjectableAction)

DI plugin provides abstract classes that you can extend to create Injectable actions. And that provides the following decorators to improve the readability of the code.

@property

Category: Property Decorator

This decorator is used to define a property in an action content class which will be used to generate the action content object Schema and content description template for LLM object generation.

import { z } from 'zod';
import { property } from "@elizaos/plugin-di";

class SampleActionContent {
  @property({
    description: "Sample property description",
    schema: z.string(),
  })
  sampleProperty: string;
}

Abstract Classes provided by this plugin

This plugin provides the following abstract classes that you can extend to create Injectable classes:

• BaseInjectableAction
• BaseInjectableEvaluator

Note: This is optional, you can create your own classes to create injectable actions.

BaseInjectableAction

This abstract class simplify the creation of injectable actions. You don't need to think about the template for content generation, it will be generated automatically based on the properties of the content Class. What you need to implement is the execute method.

import { injectable } from "inversify";
import { BaseInjectableAction } from "@elizaos/plugin-di";

class SampleActionContent {
    @property({
        description: "Sample property description",
        schema: z.string(),
    })
    property1: string;
}

@injectable()
class SampleAction extends BaseInjectableAction<SampleActionContent> {
    constructor() {
        super({
            /** general action constent options */
            contentClass: SampleActionContent,
        });
    }

    /**
     * It will be called by `handler` function when the action is triggered.
     */
    async execute(
        content: SampleActionContent | null,
        runtime: IAgentRuntime,
        message: Memory,
        state: State,
        callback?: HandlerCallback
    ): Promise<void> {
        // Your action logic here
    }
}