Noncommital Premarital Mischief

npm

npm’s 2019 JavaScript ecosystem survey analysis is now available!Get your copy here »

agentframework

1.0.0 • Public • Published

AgentFramework

An elegant & efficient TypeScript metaprogramming API to build software agents

gzip size


🍭 Modernize: 100% for TypeScript. Support class and es6 module.

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

🎯 Efficient: Well-designed and crafted api only has 600 SLOC and 4.3kb after gzipped.

♻️ Productive: AOP as easy as function calls. Stop using overweight Before/After/Aware hooks.

Features

  • Add metadata to your code at design-time (using @decorator) or runtime (using Reflector api)
  • Access the metadata at runtime (using Reflector api)
  • Customizable initializer for class fields and arguments
  • Customizable interceptor for injected value, class method, getter, setter and arguments

Projects

Changelog

Date Version Status
2019-02-27 1.0.0 Stable
2018-12-21 0.9.23 Maintenance

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 set of agents, components, services, 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.

Show me the example

Only 3 lines before you get powerful dependency injection for your code

import { agent, transit } from '@agentframework/domain';
 
class Project {
    name = 'Agent Framework';
}
 
@agent()
class Developer {
  
    @transit()
    private project: Project;
    
    constructor() {
        console.log(`WOW! You working on project ${this.project.name}!`);
    }
}
 
const you = new Developer();
console.log('Is it create from the Developer class?', you instanceof Developer);

Road to v1.0

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

License

Copyright 2016 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.

install

npm i agentframework

Downloadsweekly downloads

98

version

1.0.0

license

Apache-2.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability