sotobot 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 James Garbutt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/bot.d.ts

@@ -0,0 +1,22 @@
+import { App } from '@octokit/app';
+import type { Octokit } from '@octokit/core';
+import type { EmitterWebhookEvent } from '@octokit/webhooks/types';
+type IssueCommentEvent = EmitterWebhookEvent<'issue_comment.created'> & {
+    octokit: Octokit;
+};
+export interface CommandContext {
+    octokit: Octokit;
+    payload: IssueCommentEvent['payload'];
+    args: string[];
+}
+export type CommandHandler = (context: CommandContext) => Promise<void>;
+export interface BotOptions {
+    name: string;
+}
+export declare class Bot {
+    #private;
+    constructor(app: App, options: BotOptions);
+    addCommand(name: string | string[], fn: CommandHandler): void;
+    handleRequest(request: Request): Promise<Response>;
+}
+export {};

package/lib/bot.js

@@ -0,0 +1,57 @@
+import { createWebMiddleware } from '@octokit/webhooks';
+import { parseCommand } from './comments.js';
+import { WEBHOOK_PATH } from './constants.js';
+import { hasWriteAccess } from './octokit.js';
+export class Bot {
+    #app;
+    #middleware;
+    #commands = new Map();
+    #options;
+    constructor(app, options) {
+        this.#options = options;
+        this.#app = app;
+        this.#app.webhooks.onError(this.#onError);
+        this.#app.webhooks.on('issue_comment.created', this.#onIssueComment);
+        this.#middleware = createWebMiddleware(this.#app.webhooks, {
+            path: WEBHOOK_PATH,
+        });
+    }
+    addCommand(name, fn) {
+        if (Array.isArray(name)) {
+            for (const n of name) {
+                this.#commands.set(n, fn);
+            }
+        }
+        else {
+            this.#commands.set(name, fn);
+        }
+    }
+    handleRequest(request) {
+        return this.#middleware(request);
+    }
+    #onIssueComment = async ({ octokit, payload, }) => {
+        if (!payload.issue.pull_request) {
+            return;
+        }
+        const command = parseCommand(this.#options.name, payload.comment.body);
+        if (!command) {
+            return;
+        }
+        const handler = this.#commands.get(command.name);
+        if (!handler) {
+            return;
+        }
+        const username = payload.comment.user?.login;
+        if (!username) {
+            return;
+        }
+        const allowed = await hasWriteAccess(octokit, payload.repository.owner.login, payload.repository.name, username);
+        if (!allowed) {
+            return;
+        }
+        await handler({ octokit, payload, args: command.args });
+    };
+    #onError = (error) => {
+        console.error('Webhook handler error', error);
+    };
+}

package/lib/cloudflare.d.ts

@@ -0,0 +1,9 @@
+import { Bot } from './bot.js';
+export interface ServerOptions {
+    privateKey: string;
+    appId: string;
+    webhookSecret: string;
+}
+export declare function createServer(bot: Bot): {
+    fetch(request: Request): Promise<Response>;
+};

package/lib/cloudflare.js

@@ -0,0 +1,12 @@
+import { WEBHOOK_PATH } from './constants.js';
+export function createServer(bot) {
+    return {
+        async fetch(request) {
+            const { pathname } = new URL(request.url);
+            if (request.method === 'POST' && pathname === WEBHOOK_PATH) {
+                return bot.handleRequest(request);
+            }
+            return new Response('Not found', { status: 404 });
+        },
+    };
+}

package/lib/comments.d.ts

@@ -0,0 +1,5 @@
+export interface ParsedCommand {
+    name: string;
+    args: string[];
+}
+export declare function parseCommand(botName: string, body: string): ParsedCommand | null;

package/lib/comments.js

@@ -0,0 +1,16 @@
+export function parseCommand(botName, body) {
+    const mention = `!${botName}`;
+    for (const rawLine of body.split('\n')) {
+        const line = rawLine.trim();
+        if (!line.startsWith(mention)) {
+            continue;
+        }
+        const parts = line.slice(mention.length).trim().split(/\s+/);
+        const [name, ...args] = parts;
+        if (!name) {
+            continue;
+        }
+        return { name, args };
+    }
+    return null;
+}

package/lib/constants.d.ts

@@ -0,0 +1 @@
+export declare const WEBHOOK_PATH = "/webhook";

package/lib/constants.js

@@ -0,0 +1 @@
+export const WEBHOOK_PATH = '/webhook';

package/lib/main.d.ts

@@ -0,0 +1,8 @@
+import { Bot, BotOptions } from './bot.js';
+export interface CreateBotOptions {
+    privateKey: string;
+    appId: string;
+    webhookSecret: string;
+    bot: BotOptions;
+}
+export declare function createBot(options: CreateBotOptions): Bot;

package/lib/main.js

@@ -0,0 +1,20 @@
+import { App } from '@octokit/app';
+import { Bot } from './bot.js';
+const botCache = new WeakMap();
+export function createBot(options) {
+    const cachedBot = botCache.get(options);
+    if (cachedBot) {
+        return cachedBot;
+    }
+    const { privateKey, appId, webhookSecret } = options;
+    const app = new App({
+        appId,
+        privateKey,
+        webhooks: {
+            secret: webhookSecret,
+        },
+    });
+    const bot = new Bot(app, options.bot);
+    botCache.set(options, bot);
+    return bot;
+}

package/lib/octokit.d.ts

@@ -0,0 +1,2 @@
+import type { Octokit } from '@octokit/core';
+export declare function hasWriteAccess(octokit: Octokit, owner: string, repo: string, username: string): Promise<boolean>;

package/lib/octokit.js

@@ -0,0 +1,4 @@
+export async function hasWriteAccess(octokit, owner, repo, username) {
+    const { data } = await octokit.request('GET /repos/{owner}/{repo}/collaborators/{username}/permission', { owner, repo, username });
+    return data.permission === 'admin' || data.permission === 'write';
+}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "sotobot",
+  "version": "0.2.0",
+  "description": "A serverless-focused GitHub bot framework.",
+  "keywords": [
+    "github",
+    "bot",
+    "probot",
+    "ci"
+  ],
+  "homepage": "https://github.com/43081j/sotobot#readme",
+  "bugs": {
+    "url": "https://github.com/43081j/sotobot/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/43081j/sotobot.git"
+  },
+  "license": "MIT",
+  "author": "James Garbutt (https://github.com/43081j)",
+  "type": "module",
+  "main": "lib/main.js",
+  "exports": {
+    ".": {
+      "types": "./lib/main.d.ts",
+      "default": "./lib/main.js"
+    },
+    "./cloudflare.js": {
+      "types": "./lib/cloudflare.d.ts",
+      "default": "./lib/cloudflare.js"
+    },
+    "./lib/cloudflare.js": {
+      "types": "./lib/cloudflare.d.ts",
+      "default": "./lib/cloudflare.js"
+    }
+  },
+  "files": [
+    "lib",
+    "!lib/**/*.test.js",
+    "!lib/**/*.test.d.ts"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build:clean": "node -e \"require('fs').rmSync('./lib', { recursive: true, force: true })\"",
+    "build": "npm run build:clean && tsgo",
+    "lint:js": "oxlint src",
+    "lint:format": "oxfmt --check src",
+    "lint": "npm run lint:js && npm run lint:format",
+    "format": "oxfmt --write src",
+    "test": "vitest run"
+  },
+  "devDependencies": {
+    "@typescript/native-preview": "^7.0.0-dev.20260615.1",
+    "@vitest/coverage-v8": "^4.1.9",
+    "oxfmt": "^0.54.0",
+    "oxlint": "^1.69.0",
+    "vitest": "^4.1.9"
+  },
+  "dependencies": {
+    "@octokit/app": "^16.1.2",
+    "@octokit/core": "^7.0.6",
+    "@octokit/webhooks": "^14.2.0"
+  }
+}