JSR

Built and signed on GitHub Actions

Works with

This package works with Deno

This package works with Deno

JSR Score88%

License

AGPL-3.0-only

Downloads85/wk

Published5 days ago (0.5.2)

A framework for creating ActivityPub bots

Options for creating a bot.

Type Parameters

Properties

The internal identifier of the bot. Since it is used for the actor URI, it should not be changed after the bot is federated.

If omitted, "bot" will be used.

The type of the bot actor. It should be either Service or Application.

If omitted, Service will be used.

The username of the bot. It will be a part of the fediverse handle. It can be changed after the bot is federated.

The display name of the bot. It can be changed after the bot is federated.

The description of the bot. It can be changed after the bot is federated.

The avatar URL of the bot. It can be changed after the bot is federated.

The header image URL of the bot. It can be changed after the bot is federated.

The custom properties of the bot. It can be changed after the bot is federated.

How to handle incoming follow requests. Note that this behavior can be overridden by manually invoking FollowRequest.accept or FollowRequest.reject in the Bot.onFollow event handler.

  • "accept" (default): Automatically accept all incoming follow requests.
  • "reject": Automatically reject all incoming follow requests.
  • "manual": Require manual handling of incoming follow requests.

Who can quote messages published by the bot.

This policy is advertised on outgoing messages and is used as the fallback for older messages that do not have a serialized quote policy.

The underlying key-value store to use for storing data.

The underlying repository to use for storing data. If omitted, KvRepository will be used.

The underlying message queue to use for handling incoming and outgoing activities. If omitted, incoming activities are processed immediately, and outgoing activities are sent immediately.

The software information of the bot. If omitted, the NodeInfo protocol will be unimplemented.

Whether to trust X-Forwarded-* headers. If your bot application is behind an L7 reverse proxy, turn it on.

Turned off by default.

The options for the web pages of the bot. If omitted, the default options will be used.

Read the original on jsr.io ↗