transfer repo

.eslintrc

@@ -0,0 +1,5 @@
+{
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"]
+}

.github/workflows/ci.yml

@@ -0,0 +1,12 @@
+name: CI
+
+on: push
+
+jobs:
+  lint:
+    uses: jill64/workflows/.github/workflows/lint.yml@main
+    secrets:
+      APP_ID: ${{ secrets.APP_ID }}
+      APP_PEM: ${{ secrets.APP_PEM }}
+  build:
+    uses: jill64/workflows/.github/workflows/build.yml@main

.github/workflows/pr.yml

@@ -0,0 +1,7 @@
+name: CI
+
+on: pull_request
+
+jobs:
+  version-check:
+    uses: jill64/semantic-manager/.github/workflows/version-check.yml@main

.github/workflows/release.yml

@@ -0,0 +1,10 @@
+name: Release
+
+on:
+  push:
+    branches: main
+
+jobs:
+  release:
+    uses: jill64/semantic-manager/.github/workflows/release-npm.yml@main
+    secrets: inherit

.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+node_modules
+pnpm-lock.yaml
+/dist

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none"
+}

README.md

@@ -1,2 +1,30 @@
 # octoflare
+
 A framework for building GitHub Apps with Cloudflare Worker
+
+## Installation
+
+```sh
+npm i octoflare-app
+```
+
+## Example
+
+```js
+// src/index.js
+import { octoflare } from 'octoflare-app'
+
+export default octoflare((request, env, { app, payload }) => {
+  // Application Code
+})
+```
+
+```toml
+# wrangler.toml
+name = "YOUR_APP_NAME"
+main = "src/index.js"
+compatibility_date = "YYYY-MM-DD"
+compatibility_flags = ["nodejs_compat"]
+```
+
+[Type Definition](./src/types/OctoflareApp.ts)

package.json

@@ -0,0 +1,54 @@
+{
+  "name": "octoflare",
+  "version": "0.0.0",
+  "description": "A framework for building GitHub Apps with Cloudflare Worker",
+  "type": "module",
+  "main": "dist/index.js",
+  "license": "MIT",
+  "author": "jill64 <intents.turrets0h@icloud.com> (https://github.com/jill64)",
+  "bugs": "https://github.com/jill64/octoflare/issues",
+  "homepage": "https://github.com/jill64/octoflare#readme",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "cloudflare",
+    "workers",
+    "github",
+    "app"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./workers": {
+      "types": "./dist/workers/index.d.ts",
+      "default": "./dist/workers/index.js"
+    },
+    "./octokit": {
+      "types": "./dist/octokit/index.d.ts",
+      "default": "./dist/octokit/index.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jill64/octoflare.git"
+  },
+  "scripts": {
+    "build": "tsc && npx publint",
+    "lint": "npx prettier --check . && npx eslint && tsc",
+    "format": "npx prettier --write ."
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "6.7.4",
+    "@typescript-eslint/parser": "6.7.4",
+    "typescript": "5.2.2",
+    "@types/node": "20.8.2"
+  },
+  "dependencies": {
+    "@cloudflare/workers-types": "4.20231002.0",
+    "@octokit/webhooks-types": "7.3.1",
+    "octokit": "3.1.1"
+  }
+}

renovate.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["config:best-practices", ":pinDependencies"]
+}

src/index.ts

@@ -0,0 +1 @@
+export { octoflare } from './octoflare.js'

src/octoflare.ts

@@ -0,0 +1,43 @@
+import { WebhookEvent } from '@octokit/webhooks-types'
+import { App } from 'octokit'
+import { InternalEnv } from './types/InternalEnv.js'
+import { OctoflareHandler } from './types/OctoflareHandler.js'
+import { verifyRequest } from './verifyRequest.js'
+
+export const octoflare = <Env extends InternalEnv>(
+  handler: OctoflareHandler<Env>
+) => ({
+  async fetch(request: Request, env: Env): Promise<Response> {
+    const body = await request.text()
+
+    const invalidResponse = verifyRequest({ body, request, env })
+
+    if (invalidResponse) {
+      return invalidResponse
+    }
+
+    const payload = JSON.parse(body) as WebhookEvent
+
+    const app = new App({
+      appId: env.OCTOFLARE_APP_ID,
+      privateKey: env.OCTOFLARE_APP_PRIVATE_KEY_PKCS8
+    })
+
+    try {
+      const response = await handler({ request, env, app, payload })
+
+      return response
+        ? response
+        : new Response(null, {
+            status: 204
+          })
+    } catch (e) {
+      return new Response(
+        JSON.stringify(e instanceof Error ? e.message : String(e), null, 2),
+        {
+          status: 500
+        }
+      )
+    }
+  }
+})

src/octokit/index.ts

@@ -0,0 +1 @@
+export * from '@octokit/webhooks-types'

src/types/InternalEnv.ts

@@ -0,0 +1,5 @@
+export type InternalEnv = {
+  OCTOFLARE_APP_ID: string
+  OCTOFLARE_APP_PRIVATE_KEY_PKCS8: string
+  OCTOFLARE_APP_WEBHOOK_SECRET: string
+}

src/types/OctoflareHandler.ts

@@ -0,0 +1,10 @@
+import { WebhookEvent } from '@octokit/webhooks-types'
+import { App } from 'octokit'
+import { InternalEnv } from './InternalEnv.js'
+
+export type OctoflareHandler<Env extends InternalEnv> = (context: {
+  request: Request
+  env: Env
+  app: App
+  payload: WebhookEvent
+}) => Promise<Response | void> | Response | void

src/verifyRequest.ts

@@ -0,0 +1,50 @@
+import crypto from 'node:crypto'
+import { InternalEnv } from './types/InternalEnv.js'
+
+export const verifyRequest = ({
+  request,
+  body,
+  env
+}: {
+  request: Request
+  body: string
+  env: InternalEnv
+}): Response | null => {
+  const { headers, method } = request
+
+  if (method === 'GET' || method === 'HEAD') {
+    return new Response(null, {
+      status: 204
+    })
+  }
+
+  if (method !== 'POST') {
+    return new Response(null, {
+      status: 405,
+      headers: {
+        Allow: 'GET, HEAD, POST'
+      }
+    })
+  }
+
+  const headerSignature = headers.get('X-Hub-Signature-256')
+
+  if (!headerSignature) {
+    return new Response(null, {
+      status: 403
+    })
+  }
+
+  const signature = crypto
+    .createHmac('sha256', env.OCTOFLARE_APP_WEBHOOK_SECRET)
+    .update(body)
+    .digest('hex')
+
+  if (`sha256=${signature}` !== headerSignature) {
+    return new Response(null, {
+      status: 403
+    })
+  }
+
+  return null
+}

src/workers/index.ts

@@ -0,0 +1 @@
+export * from '@cloudflare/workers-types'

tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "outDir": "dist",
+    "declaration": true
+  }
+}