Initial commit

Author: dahlia

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "denoland.vscode-deno",
+    "streetsidesoftware.code-spell-checker"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,61 @@
+{
+  "deno.enable": true,
+  "deno.unstable": true,
+  "editor.detectIndentation": false,
+  "editor.indentSize": 2,
+  "editor.insertSpaces": true,
+  "files.eol": "\n",
+  "files.insertFinalNewline": true,
+  "files.trimFinalNewlines": true,
+  "[javascript]": {
+    "editor.defaultFormatter": "denoland.vscode-deno",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.sortImports": "always"
+    }
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "denoland.vscode-deno",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.sortImports": "always"
+    }
+  },
+  "[json]": {
+    "editor.defaultFormatter": "vscode.json-language-features",
+    "editor.formatOnSave": true
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "vscode.json-language-features",
+    "editor.formatOnSave": true
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "denoland.vscode-deno",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.sortImports": "always"
+    }
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "denoland.vscode-deno",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.sortImports": "always"
+    }
+  },
+  "cSpell.words": [
+    "activitypub",
+    "botkit",
+    "denokv",
+    "Fedify",
+    "fediverse",
+    "halfyear",
+    "logtape",
+    "Minhee",
+    "multikey",
+    "nodeinfo",
+    "phensley",
+    "unfollowed",
+    "uuidv7"
+  ]
+}

LICENSE

@@ -0,0 +1,59 @@
+<img src="./logo.svg" alt="BotKit by Fedify" width="203" height="165">
+
+BotKit by Fedify
+================
+
+> [!NOTE]
+> BotKit is still in early development.  The API may change in the future.
+> Although it currently supports only Deno, it will support Node.js and Bun
+> later.
+
+BotKit is a framework for creating [ActivityPub] bots.  It is powered by
+[Fedify], a lower-level library for creating ActivityPub server applications.
+Unlike Mastodon bots, BotKit is designed to create a standalone ActivityPub bot,
+which is a complete ActivityPub server in itself and not limited to Mastodon's
+capabilities (such as the 500-character limit per post).
+
+BotKit's API is so simple and easy to use that you can create a complete bot in
+a single TypeScript file.  Here's an example of a simple bot that just greets:
+
+~~~~ typescript
+import { createBot, mention, text } from "@fedify/botkit";
+import { RedisKvStore } from "@fedify/redis";
+import { Redis } from "ioredis";
+
+// Create a bot instance:
+const bot = createBot<void>({
+  // The bot will have fediverse handle "@greetbot@mydomain":
+  username: "greetbot",
+  // Set the display name:
+  name: "Greet Bot",
+  // Set the profile icon (avatar):
+  icon: new URL("https://mydomain/icon.png"),
+  // Set the bio:
+  summary: text`Hi, there! I'm a simple fediverse bot created by ${
+    mention("@[email protected]")}.`,
+  // Use Redis as a key-value store:
+  kv: new RedisKvStore(new Redis()),
+  // Use Redis as a message queue:
+  queue: new RedisMessageQueue(() => new Redis()),
+});
+
+// A bot can respond to a mention:
+bot.onMention(/hi|hello|what'?s\s+up/i, async (message) => {
+  await message.reply(text`Hi, ${ctx.actor}!`);
+});
+
+// Or, a bot also can actively publish a post:
+const session = bot.getSession(new URL("https://mydomain/"));
+setInterval(async () => {
+  await session.publish(text`Hi, forks! It's an hourly greeting.`);
+}, 1000 * 60 * 60);
+
+export default bot;
+~~~~
+
+[ActivityPub]: https://activitypub.rocks/
+[Fedify]: https://fedify.dev/
+
+<!-- cSpell: ignore greetbot mydomain -->

README.md

@@ -0,0 +1,33 @@
+{
+  "name": "@fedify/botkit",
+  "version": "0.1.0",
+  "license": "AGPL-3.0-only",
+  "unstable": [
+    "kv",
+    "temporal"
+  ],
+  "exports": {
+    ".": "./src/mod.ts",
+    "./bot": "./src/bot.ts",
+    "./text": "./src/text.ts"
+  },
+  "imports": {
+    "@fedify/fedify": "jsr:@fedify/fedify@^1.3.3",
+    "@hongminhee/x-forwarded-fetch": "jsr:@hongminhee/x-forwarded-fetch@^0.2.0",
+    "@logtape/logtape": "jsr:@logtape/logtape@^0.8.0",
+    "@phensley/language-tag": "npm:@phensley/language-tag@^1.9.2",
+    "@std/assert": "jsr:@std/assert@^1.0.10",
+    "@std/html": "jsr:@std/html@^1.0.3",
+    "@std/uuid": "jsr:@std/uuid@^1.0.4",
+    "xss": "npm:xss@^1.0.15"
+  },
+  "exclude": [
+    "*.md",
+    ".github",
+    ".vscode"
+  ],
+  "tasks": {
+    "check": "deno check src/ && deno lint && deno fmt --check",
+    "test": "deno test --allow-net=hollo.social"
+  }
+}