agentframework / Agentframework

An elegant & efficient TypeScript metaprogramming API to build software agents

🍭 Modernize: 100% for TypeScript. Compatible with ES2015.

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

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

♻️ Clean: No prototype pollution. No polyfill. No nodejs/npm dependencies.

Changelog

Install

npm i agentframework

Example code

import { agent, transit } from 'agentframework';

class ComponentA {
	name = 'Agent Framework';
}

@agent()
class ProjectA {
	@transit()
	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

Concepts

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

• [x] Breaking change: Remove I from interface name
• [x] Breaking change: Remove Intializer. Use Interceptor instead
• [x] MVP: Dependency injection/dependency lookup and Domain driven design support
• [x] MVP: Improve unit test coverage rate
• [ ] COMPATIBILITY: Revise error types and message
• [ ] COMPATIBILITY: Revise Domain interface
• [ ] COMPATIBILITY: Revise embedded decorators
• [ ] EPIC: Abstract data layer - mongodb 4.x
• [ ] EPIC: Cross architecture web application development (Server, Serverless)
• [ ] EPIC: Serverless support - AWS Lambda, Google Cloud Function, Azure Function, Alicloud Function Computing
• [ ] EPIC: Bot development (Telegram)
• [ ] Other: Example and references
• [ ] Other: docs.agentframework.com
• [ ] Other: agentframework.com

Agentframework 1.x milestones

• [x] MVP: Reflection can access type information generated by tsc. tsc --emitDecoratorMetadata
• [x] MVP: Reflection support both ES6 and ES2017 (Reflect.metadata)
• [x] MVP: Share metadata across different agentframework library of same application
• [x] MVP: Both agent or normal class can be used for dependence injection
• [x] MVP: Add IInitializer to init a field property
• [x] MVP: Interceptor can work with Initializer during dependence injection
• [x] EPIC: Create agent without domain
• [x] EPIC: Provide access to intercepted property value in constructor
• [x] PERFORMANCE: Metadata only attribute, attribute without interceptor
• [x] PERFORMANCE: Pre-compile class member interceptors to improve method call performance
• [x] PERFORMANCE: Cache class constructor interceptors to faster initialize new class instance staring from second time.
• [x] PERFORMANCE: Remove interceptor for @agent attribute to improve performance
• [x] PERFORMANCE: Do not add proxy if the agent don't have interceptor
• [x] PERFORMANCE: Remove ES6 Proxy if don't have field interceptor
• [x] COMPATIBILITY: Move @inject and @ready decorator out from core
• [x] COMPATIBILITY: GetPrototypeOf should return origin prototype
• [x] COMPATIBILITY: Agent should works in extended classes
• [x] COMPATIBILITY: instanceOf should works when compile to proxy
• [x] COMPATIBILITY: Revise IInvocation Interface
• [x] COMPATIBILITY: Revise IInitializer Interface
• [x] COMPATIBILITY: Revise IInterceptor Interface
• [x] COMPATIBILITY: Revise IAttribute Interface
• [x] COMPATIBILITY: Revise Reflection Interface
• [x] COMPATIBILITY: Revise Reflector Interface
• [x] COMPATIBILITY: Revise Agent Options
• [x] COMPATIBILITY: Revise Domain Interface (Domain is been completely moved to 2.0)

License

Copyright 2021 Ling Zhang

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.