PPAgent 文档

Appearance

ppagent / PPAgent

Class: PPAgent ​

Defined in: src/pp.agent.ts:54

Extends ​

  • default

Constructors ​

Constructor ​

new PPAgent(_options): PPAgent

Defined in: src/pp.agent.ts:59

Parameters ​

_options ​

IPPAgentOptions = ...

Returns ​

PPAgent

Overrides ​

Emittery.constructor

Properties ​

debug ​

debug: DebugOptions<Record<PropertyKey, any>>

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:308

Debugging options for the current instance.

Inherited from ​

Emittery.debug

EventNames ​

static EventNames: object

Defined in: src/pp.agent.ts:55

ERROR ​

ERROR: string = "error"

isDebugEnabled ​

static isDebugEnabled: boolean

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:229

Toggle debug mode for all instances.

Default: true if the DEBUG environment variable is set to emittery or *, otherwise false.

Example ​

import Emittery from 'emittery';

Emittery.isDebugEnabled = true;

const emitter1 = new Emittery({debug: {name: 'myEmitter1'}});
const emitter2 = new Emittery({debug: {name: 'myEmitter2'}});

emitter1.on('test', data => {
	// …
});

emitter2.on('otherTest', data => {
	// …
});

emitter1.emit('test');
//=> [16:43:20.417][emittery:subscribe][myEmitter1] Event Name: test
//	data: undefined

emitter2.emit('otherTest');
//=> [16:43:20.417][emittery:subscribe][myEmitter2] Event Name: otherTest
//	data: undefined

Inherited from ​

Emittery.isDebugEnabled

listenerAdded ​

readonly static listenerAdded: typeof listenerAdded

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:255

Fires when an event listener was added.

An object with listener and eventName (if on or off was used) is provided as event data.

Example ​

import Emittery from 'emittery';

const emitter = new Emittery();

emitter.on(Emittery.listenerAdded, ({listener, eventName}) => {
	console.log(listener);
	//=> data => {}

	console.log(eventName);
	//=> '🦄'
});

emitter.on('🦄', data => {
	// Handle data
});

Inherited from ​

Emittery.listenerAdded

listenerRemoved ​

readonly static listenerRemoved: typeof listenerRemoved

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:283

Fires when an event listener was removed.

An object with listener and eventName (if on or off was used) is provided as event data.

Example ​

import Emittery from 'emittery';

const emitter = new Emittery();

const off = emitter.on('🦄', data => {
	// Handle data
});

emitter.on(Emittery.listenerRemoved, ({listener, eventName}) => {
	console.log(listener);
	//=> data => {}

	console.log(eventName);
	//=> '🦄'
});

off();

Inherited from ​

Emittery.listenerRemoved

Accessors ​

agentService ​

Get Signature ​

get agentService(): AgentService

Defined in: src/pp.agent.ts:116

Returns ​

AgentService

botManager ​

Get Signature ​

get botManager(): BotManager

Defined in: src/pp.agent.ts:104

Returns ​

BotManager

client ​

Get Signature ​

get client(): AuthenticationClient<any> & RestClient<any>

Defined in: src/pp.agent.ts:132

Returns ​

AuthenticationClient<any> & RestClient<any>

globalEvent ​

Get Signature ​

get globalEvent(): GlobalEvent

Defined in: src/pp.agent.ts:147

Returns ​

GlobalEvent

me ​

Get Signature ​

get me(): object

Defined in: src/pp.agent.ts:155

Returns ​

object

appearance ​

appearance: string

auth_data ​

auth_data: Record<string, any>

avatar ​

avatar: string | { charset: string; description: string; duration: number; embed: unknown; filename_disk: string; filename_download: string; filesize: string; focal_point_x: number; focal_point_y: number; folder: string | { id: string; name: string; parent: string | { id: string; name: string; parent: string | ...; }; }; height: number; id: string; location: string; metadata: Record<string, any>; modified_by: string | { id: string; first_name: string; last_name: string; email: string; password: string; location: string; title: string; description: string; tags: string[]; avatar: string | { id: string; storage: string; ... 20 more ...; focal_point_y: number; }; ... 17 more ...; policies: string[] | { ...; }[]; }; modified_on: "datetime"; storage: string; tags: string[]; title: string; type: string; uploaded_by: string | { id: string; first_name: string; last_name: string; email: string; password: string; location: string; title: string; description: string; tags: string[]; avatar: string | { id: string; storage: string; ... 20 more ...; focal_point_y: number; }; ... 17 more ...; policies: string[] | { ...; }[]; }; uploaded_on: "datetime"; width: number; }

description ​

description: string

email ​

email: string

email_notifications ​

email_notifications: boolean

external_identifier ​

external_identifier: string

first_name ​

first_name: string

id ​

id: string

language ​

language: string

last_access ​

last_access: "datetime"

last_name ​

last_name: string

last_page ​

last_page: string

location ​

location: string

password ​

password: string

policies ​

policies: string[] | object[]

provider ​

provider: string

role ​

role: string | { children: string[] | { id: string; name: string; icon: string; description: string; parent: string | ...; children: string[] | ...[]; policies: string[] | { id: string; role: string | ...; user: string | { id: string; ... 26 more ...; policies: string[] | { ...; }[]; }; policy: string | { ...; }; sort: number; }[]; users: string[] | { ....[]; description: string; icon: string; id: string; name: string; parent: string | { id: string; name: string; icon: string; description: string; parent: string | ...; children: string[] | ...[]; policies: string[] | { id: string; role: string | ...; user: string | { ...; }; policy: string | { ...; }; sort: number; }[]; users: string[] | { ...; }[]; }; policies: string[] | object[]; users: string[] | { id: string; first_name: string; last_name: string; email: string; password: string; location: string; title: string; description: string; tags: string[]; avatar: string | { id: string; storage: string; ... 20 more ...; focal_point_y: number; }; ... 17 more ...; policies: string[] | { ...; }[]; }[]; }

status ​

status: string

tags ​

tags: string[]

tfa_secret ​

tfa_secret: string

theme ​

theme: string

theme_dark ​

theme_dark: string

theme_dark_overrides ​

theme_dark_overrides: Record<string, unknown>

theme_light ​

theme_light: string

theme_light_overrides ​

theme_light_overrides: Record<string, unknown>

title ​

title: string

token ​

token: string

offlineMode ​

Get Signature ​

get offlineMode(): boolean

Defined in: src/pp.agent.ts:120

Returns ​

boolean

onlinePlugins ​

Get Signature ​

get onlinePlugins(): MapIterator<IOnlinePluginInfo>

Defined in: src/pp.agent.ts:159

Returns ​

MapIterator<IOnlinePluginInfo>

options ​

Get Signature ​

get options(): IPPAgentOptions

Defined in: src/pp.agent.ts:139

Returns ​

IPPAgentOptions

plugins ​

Get Signature ​

get plugins(): IPPAgentPluginHandler[]

Defined in: src/pp.agent.ts:151

Returns ​

IPPAgentPluginHandler[]

running ​

Get Signature ​

get running(): boolean

Defined in: src/pp.agent.ts:163

Returns ​

boolean

server ​

Get Signature ​

get server(): FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>

Defined in: src/pp.agent.ts:92

Returns ​

FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>

services ​

Get Signature ​

get services(): Map<string, any>

Defined in: src/pp.agent.ts:167

Returns ​

Map<string, any>

sharedCover ​

Get Signature ​

get sharedCover(): IAsyncFile

Defined in: src/pp.agent.ts:124

Returns ​

IAsyncFile

Get Signature ​

get sharedLogo(): IAsyncFile

Defined in: src/pp.agent.ts:128

Returns ​

IAsyncFile

skillManager ​

Get Signature ​

get skillManager(): SkillManager

Defined in: src/pp.agent.ts:96

Returns ​

SkillManager

sourceManager ​

Get Signature ​

get sourceManager(): SourceManager

Defined in: src/pp.agent.ts:100

Returns ​

SourceManager

taskRunnerManager ​

Get Signature ​

get taskRunnerManager(): TaskRunnerManager

Defined in: src/pp.agent.ts:112

Returns ​

TaskRunnerManager

taskService ​

Get Signature ​

get taskService(): TaskService

Defined in: src/pp.agent.ts:143

Returns ​

TaskService

taskTriggerManager ​

Get Signature ​

get taskTriggerManager(): TaskTriggerManager

Defined in: src/pp.agent.ts:108

Returns ​

TaskTriggerManager

Methods ​

anyEvent() ​

anyEvent(): AsyncIterableIterator<[PropertyKey, any]>

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:562

Get an async iterator which buffers a tuple of an event name and data each time an event is emitted.

Call return() on the iterator to remove the subscription.

In the same way as for events, you can subscribe by using the for await statement.

Returns ​

AsyncIterableIterator<[PropertyKey, any]>

Example ​

import Emittery from 'emittery';

const emitter = new Emittery();
const iterator = emitter.anyEvent();

emitter.emit('🦄', '🌈1'); // Buffered
emitter.emit('🌟', '🌈2'); // Buffered

iterator.next()
	.then(({value, done}) => {
		// done is false
		// value is ['🦄', '🌈1']
		return iterator.next();
	})
	.then(({value, done}) => {
		// done is false
		// value is ['🌟', '🌈2']
		// revoke subscription
		return iterator.return();
	})
	.then(({done}) => {
		// done is true
	});

Inherited from ​

Emittery.anyEvent

bindMethods() ​

bindMethods(target, methodNames?): void

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:602

Bind the given methodNames, or all Emittery methods if methodNames is not defined, into the target object.

Parameters ​

target ​

Record<string, unknown>

methodNames? ​

readonly string[]

Returns ​

void

Example ​

import Emittery from 'emittery';

const object = {};

new Emittery().bindMethods(object);

object.emit('event');

Inherited from ​

Emittery.bindMethods

clearListeners() ​

clearListeners<Name>(eventName?): void

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:581

Clear all event listeners on the instance.

If eventName is given, only the listeners for that event are cleared.

Type Parameters ​

Name ​

Name extends PropertyKey

Parameters ​

eventName? ​

Name | readonly Name[]

Returns ​

void

Inherited from ​

Emittery.clearListeners

emit() ​

Call Signature ​

emit<Name>(eventName): Promise<void>

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:496

Trigger an event asynchronously, optionally with some data. Listeners are called in the order they were added, but executed concurrently.

Type Parameters ​
Name ​

Name extends DatalessEventNames<Record<PropertyKey, any>>

Parameters ​
eventName ​

Name

Returns ​

Promise<void>

A promise that resolves when all the event listeners are done. Done meaning executed if synchronous or resolved when an async/promise-returning function. You usually wouldn't want to wait for this, but you could for example catch possible errors. If any of the listeners throw/reject, the returned promise will be rejected with the error, but the other listeners will not be affected.

Inherited from ​

Emittery.emit

Call Signature ​

emit<Name>(eventName, eventData): Promise<void>

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:497

Trigger an event asynchronously, optionally with some data. Listeners are called in the order they were added, but executed concurrently.

Type Parameters ​
Name ​

Name extends PropertyKey

Parameters ​
eventName ​

Name

eventData ​

Record<PropertyKey, any>[Name]

Returns ​

Promise<void>

A promise that resolves when all the event listeners are done. Done meaning executed if synchronous or resolved when an async/promise-returning function. You usually wouldn't want to wait for this, but you could for example catch possible errors. If any of the listeners throw/reject, the returned promise will be rejected with the error, but the other listeners will not be affected.

Inherited from ​

Emittery.emit

emitSerial() ​

Call Signature ​

emitSerial<Name>(eventName): Promise<void>

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:509

Same as emit(), but it waits for each listener to resolve before triggering the next one. This can be useful if your events depend on each other. Although ideally they should not. Prefer emit() whenever possible.

If any of the listeners throw/reject, the returned promise will be rejected with the error and the remaining listeners will not be called.

Type Parameters ​
Name ​

Name extends DatalessEventNames<Record<PropertyKey, any>>

Parameters ​
eventName ​

Name

Returns ​

Promise<void>

A promise that resolves when all the event listeners are done.

Inherited from ​

Emittery.emitSerial

Call Signature ​

emitSerial<Name>(eventName, eventData): Promise<void>

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:510

Same as emit(), but it waits for each listener to resolve before triggering the next one. This can be useful if your events depend on each other. Although ideally they should not. Prefer emit() whenever possible.

If any of the listeners throw/reject, the returned promise will be rejected with the error and the remaining listeners will not be called.

Type Parameters ​
Name ​

Name extends PropertyKey

Parameters ​
eventName ​

Name

eventData ​

Record<PropertyKey, any>[Name]

Returns ​

Promise<void>

A promise that resolves when all the event listeners are done.

Inherited from ​

Emittery.emitSerial

events() ​

events<Name>(eventName): AsyncIterableIterator<Record<PropertyKey, any>[Name]>

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:431

Get an async iterator which buffers data each time an event is emitted.

Call return() on the iterator to remove the subscription.

Type Parameters ​

Name ​

Name extends PropertyKey

Parameters ​

eventName ​

Name | readonly Name[]

Returns ​

AsyncIterableIterator<Record<PropertyKey, any>[Name]>

Examples ​

import Emittery from 'emittery';

const emitter = new Emittery();
const iterator = emitter.events('🦄');

emitter.emit('🦄', '🌈1'); // Buffered
emitter.emit('🦄', '🌈2'); // Buffered

iterator
	.next()
	.then(({value, done}) => {
		// done === false
		// value === '🌈1'
		return iterator.next();
	})
	.then(({value, done}) => {
		// done === false
		// value === '🌈2'
		// Revoke subscription
		return iterator.return();
	})
	.then(({done}) => {
		// done === true
	});

In practice you would usually consume the events using the for await statement. In that case, to revoke the subscription simply break the loop.

import Emittery from 'emittery';

const emitter = new Emittery();
const iterator = emitter.events('🦄');

emitter.emit('🦄', '🌈1'); // Buffered
emitter.emit('🦄', '🌈2'); // Buffered

// In an async context.
for await (const data of iterator) {
	if (data === '🌈2') {
		break; // Revoke the subscription when we see the value `🌈2`.
	}
}

It accepts multiple event names.

import Emittery from 'emittery';

const emitter = new Emittery();
const iterator = emitter.events(['🦄', '🦊']);

emitter.emit('🦄', '🌈1'); // Buffered
emitter.emit('🦊', '🌈2'); // Buffered

iterator
	.next()
	.then(({value, done}) => {
		// done === false
		// value === '🌈1'
		return iterator.next();
	})
	.then(({value, done}) => {
		// done === false
		// value === '🌈2'
		// Revoke subscription
		return iterator.return();
	})
	.then(({done}) => {
		// done === true
	});

Inherited from ​

Emittery.events

listenerCount() ​

listenerCount<Name>(eventName?): number

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:586

The number of listeners for the eventName or all events if not specified.

Type Parameters ​

Name ​

Name extends PropertyKey

Parameters ​

eventName? ​

Name | readonly Name[]

Returns ​

number

Inherited from ​

Emittery.listenerCount

off() ​

off<Name>(eventName, listener): void

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:459

Remove one or more event subscriptions.

Type Parameters ​

Name ​

Name extends string | number | symbol

Parameters ​

eventName ​

Name | readonly Name[]

listener ​

(eventData) => void | Promise<void>

Returns ​

void

Example ​

import Emittery from 'emittery';

const emitter = new Emittery();

const listener = data => {
	console.log(data);
};

emitter.on(['🦄', '🐶', '🦊'], listener);
await emitter.emit('🦄', 'a');
await emitter.emit('🐶', 'b');
await emitter.emit('🦊', 'c');
emitter.off('🦄', listener);
emitter.off(['🐶', '🦊'], listener);
await emitter.emit('🦄', 'a'); // nothing happens
await emitter.emit('🐶', 'b'); // nothing happens
await emitter.emit('🦊', 'c'); // nothing happens

Inherited from ​

Emittery.off

offAny() ​

offAny(listener): void

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:569

Remove an onAny subscription.

Parameters ​

listener ​

(eventName, eventData) => void | Promise<void>

Returns ​

void

Inherited from ​

Emittery.offAny

on() ​

on<Name>(eventName, listener, options?): UnsubscribeFunction

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:342

Subscribe to one or more events.

Using the same listener multiple times for the same event will result in only one method call per emitted event.

Type Parameters ​

Name ​

Name extends string | number | symbol

Parameters ​

eventName ​

Name | readonly Name[]

listener ​

(eventData) => void | Promise<void>

options? ​
signal? ​

AbortSignal

Returns ​

UnsubscribeFunction

An unsubscribe method.

Example ​

import Emittery from 'emittery';

const emitter = new Emittery();

emitter.on('🦄', data => {
	console.log(data);
});

emitter.on(['🦄', '🐶'], data => {
	console.log(data);
});

emitter.emit('🦄', '🌈'); // log => '🌈' x2
emitter.emit('🐶', '🍖'); // log => '🍖'

Inherited from ​

Emittery.on

onAny() ​

onAny(listener, options?): UnsubscribeFunction

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:520

Subscribe to be notified about any event.

Parameters ​

listener ​

(eventName, eventData) => void | Promise<void>

options? ​
signal? ​

AbortSignal

Returns ​

UnsubscribeFunction

A method to unsubscribe.

Inherited from ​

Emittery.onAny

once() ​

once<Name>(eventName): EmitteryOncePromise<Record<PropertyKey, any> & OmnipresentEventData[Name]>

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:489

Subscribe to one or more events only once. It will be unsubscribed after the first event.

Type Parameters ​

Name ​

Name extends string | number | symbol

Parameters ​

eventName ​

Name | readonly Name[]

Returns ​

EmitteryOncePromise<Record<PropertyKey, any> & OmnipresentEventData[Name]>

The promise of event data when eventName is emitted. This promise is extended with an off method.

Example ​

import Emittery from 'emittery';

const emitter = new Emittery();

emitter.once('🦄').then(data => {
	console.log(data);
	//=> '🌈'
});

emitter.once(['🦄', '🐶']).then(data => {
	console.log(data);
});

emitter.emit('🦄', '🌈'); // Logs `🌈` twice
emitter.emit('🐶', '🍖'); // Nothing happens

Inherited from ​

Emittery.once

registerRoutes() ​

registerRoutes(instanceName, info): void

Defined in: src/pp.agent.ts:619

API路由动态注册。由框架统一注册，source类只需要按接口要求返回相应路由信息。

  • 如果使用文本进行交互，type可以设置为normal，这样只要handler直接返回相应的文本即可。
  • 如果需要完全自己控制返回内容，如二进制等，可以设置为custom，需要自行调用reply中的send方法返回内容。
  • 如果遇到异常将在外层被捕获后，根据异常类型进行返回。

由于不同的外部请求认证方式不一（如不同来源的回调），因此有需要实现认证的时候，需要action自行实现

Parameters ​

instanceName ​

string

消息源实例的key

info ​

ISourceActionInfo

Returns ​

void

registerWSHandler() ​

registerWSHandler(instanceName, info): void

Defined in: src/pp.agent.ts:641

WS处理器注册。由框架统一注册，source类只需要按接口要求返回相应处理行器信息。 如果使用JSON进行交互，建议客户端连接的时候直接连接ws/normal端点，然后使用标准的ISourceWSNormalInMessage格式传入数据，此时handler只要处理好数据返回纯数据即可，框架会包裹为ISourceWSNormalOutMessage返回给客户端。如果不需要返回数据，返回void即可。 如果希望完全自定义，可以让客户端连接到ws/instanceName/action端点，此时所有消息将原封不动的传给handler进行处理，handler可以返回处理好的内容由框架发送，或者自行调用socket.send进行发送，自行发送时，处理方法返回void即可。

由于不同的外部请求认证方式不一（如不同来源的回调），因此有需要实现认证的时候，需要action自行实现

Parameters ​

instanceName ​

string

消息源实例的key

info ​

ISourceActionInfo

Returns ​

void

reload() ​

reload(): Promise<void>

Defined in: src/pp.agent.ts:572

Returns ​

Promise<void>

start() ​

start(): Promise<void>

Defined in: src/pp.agent.ts:490

Returns ​

Promise<void>

stop() ​

stop(signal?): Promise<void>

Defined in: src/pp.agent.ts:581

Parameters ​

signal? ​

string

Returns ​

Promise<void>

use() ​

use(plugin, info?): Promise<IPPAgentPluginHandler>

Defined in: src/pp.agent.ts:457

请在start之前调用

Parameters ​

plugin ​

IPPAgentPlugin

info? ​

IOnlinePluginInfo

Returns ​

Promise<IPPAgentPluginHandler>

mixin() ​

static mixin(emitteryPropertyName, methodNames?): <T>(klass) => T

Defined in: node_modules/.pnpm/emittery@1.1.0/node_modules/emittery/index.d.ts:300

In TypeScript, it returns a decorator which mixins Emittery as property emitteryPropertyName and methodNames, or all Emittery methods if methodNames is not defined, into the target class.

Parameters ​

emitteryPropertyName ​

string | symbol

methodNames? ​

readonly string[]

Returns ​

<T>(klass): T

Type Parameters ​
T ​

T extends (...arguments_) => any

Parameters ​
klass ​

T

Returns ​

T

Example ​

import Emittery from 'emittery';

@Emittery.mixin('emittery')
class MyClass {}

const instance = new MyClass();

instance.emit('event');

Inherited from ​

Emittery.mixin