agentframework / agentframework Goto Github PK

An elegant & efficient TypeScript metaprogramming API to build software agents

License: Apache License 2.0

TypeScript 100.00%

dependency-injection aop typescript interceptor reflection metadata proxy es6 aspect-oriented-framework agent-oriented-programming serverless

agentframework's Introduction

An elegant & efficient TypeScript metaprogramming API to build software agents

🍭 Modernize: 100% for TypeScript. Side-effect free tree shaking compatible with ES2015.

⚡ Fast: Use CodeGen to minimize overheads. Faster than es6 Proxy.

🎯 Efficient: Well-designed and crafted api only has 1300 SLOC and 5.6kb after minzipped.

♻️ Clean: Transparent dynamic proxy. No prototype pollution. No reflect-metadata or any npm dependencies.

Supported Environment

Platform	Version
Node.js	18, 16, 14, 12, 10, 8
TypeScript	4.7, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.9, 3.8, 3.7, 3.6, 3.5, 3.4, 3.3, 3.2, 3.1, 3.0

Changelog

Date	Version	Status
2022-03-11	2.0.2	Stable
2019-02-27	1.0.0	Maintenance
2018-12-21	0.9.23	EOL
2017-06-30	0.5.12	EOL
2016-11-03	0.2.28	EOL

Install

npm i agentframework

Example code

import { agent, singleton } from 'agentframework';

class ComponentA {
	name = 'Agent Framework';
}

@agent()
class ProjectA {
	@singleton()
	private component!: ComponentA;

	constructor() {
		console.log(`WOW! You working on project ${this.component.name}!`);
	}
}

const project = new ProjectA();

console.log('Is it create from the ProjectA class?', project instanceof ProjectA);

Features

Add metadata to your code at design-time (using @decorator) or runtime (using Reflector api)
Access the metadata at runtime (using Reflector api)
AOP, dependence injection and dependence lookup

Projects

Hello World! Your first AgentFramework project.

Agent Oriented Programming

Principle

PARADIGM	INSPIRATION	PRINCIPLE
Function Programming	Math	It transform data
OOP	The world	It describe things and the relationships between them
Agent Oriented Programming	Human	It actions like a human (AI)

Concepts

HUMAN	AGENT FRAMEWORK	DESCRIPTION
People	Agent	A class decorate with @agent attribute
Action	Behavior	Class method decorate with @action, @method or @behavior attribute
Belief	Memory	Private class field decorated with @state, @remember, @memory attribute
Environment	Domain	A container for agents, entities, services or artifacts
Autonomy	Activation	Timer, scheduler which based on environment conditions
Sociality	Message	Agent can communicate with other agent
Mobility	Mobile Agent	An agent can move from domain to domain with their belief unchanged

When use Agent Framework

You want to build software agents.
You want to use dependence injection or dependence lookup.
You want to build a framework which similar to Spring Framework but in JavaScript.
You want to build an abstract layer for a specific business domain in your organization.
You want to remove duplicated code and keep project codebase small and clean.
You need a powerful method to pre-process, post-process or modify system behaviors without touching existing code.

Agentframework 2.x milestones

Agentframework 1.x milestones

Special Thanks To:

JetBrains, creators of the IntelliJ IDEA, supports AgentFramework with one of their Open Source Licenses. IntelliJ IDEA is the recommended IDE for working with AgentFramework.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

agentframework's People

Contributors

Stargazers

Watchers

Forkers

ahmedshuhel vadkasevas

class Agent {
}

Reflector(Agent).addAttribute(new Attribute())

branch v2.1

Add browser support

Some webpage may have strict CSP policy which not allow eval.

EvalError: Refused to evaluate a string as JavaScript because 'unsafe-eval' is not an allowed source of script in the following Content Security Policy directive:

Need remove all eval code

@ready invokes before @inject

bug

Error: Invalid "exports" main target "lib/index.js" defined in the package config

Latest verison 2.0.2 in npm repository adds exports key to package.json file:

  "exports": {
    ".": {
      "import": "lib/index.mjs",
      "require": "lib/index.js",
      "types": "lib/index.d.ts"
    }

which throws error on usage:

Error: Invalid "exports" main target "lib/index.js" defined in the package config /home/retreat/projects/agent-hello-world/node_modules/agentframework/package.json; targets must start with "./"

Downgrading to node v12.14.1 (npm v6.13.4) solves the issue.

version 2.0.1 works fine on both v16.13.0 and 12.14.1.

using:

Ubuntu 18.04.6 LTS
tsmon v0.9.1
typescript v4.4.4
node v16.13.0

Add documentation for @inject decorator

@Inject will do dependency injection when user create a new agent class.

e.g

class Calculator {
   add(left:number, right: number): number {
     return left + right;
   }
}

@agent('awesome')
class MyAgent {

   @inject(Calculator)
   calculator: Calculator

}


const agent = new MyAgent();

console.log(agent.calculator.add(1,3));
// 4