feat(adapter-koa): 🚀 添加 Koa 适配器及其示例项目

Author: Vanisper

examples/koa/.gitignore

@@ -0,0 +1 @@
+cert

examples/koa/index.js

@@ -0,0 +1,32 @@
+/* eslint-disable no-console */
+import { KoaHttpsAdapter } from '@https-enable/adapter-koa'
+import { HttpsEnabler } from '@https-enable/core'
+import Koa from 'koa'
+
+const app = new Koa()
+
+const HOST = '127.0.0.1'
+const PORT = 2333
+
+app.use(async (ctx) => {
+  ctx.body = 'Hello World'
+})
+
+const adapter = new KoaHttpsAdapter(app)
+const enabler = new HttpsEnabler({
+  adapter,
+  options: { host: HOST, port: PORT },
+  certificateOptions: { validity: 1, domains: HOST, base: 'cert' },
+})
+
+enabler.startServer().then((res) => {
+  console.log(`Server running in http://${res.host}:${res.port}`)
+})
+
+enabler.on('error', (err) => {
+  console.log('error:', err)
+})
+
+enabler.on('cert-renewed', (res) => {
+  console.log('cert-renewed:', res)
+})

examples/koa/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "koa-demo",
+  "type": "module",
+  "private": true,
+  "main": "index.js",
+  "scripts": {
+    "test": "node index.js"
+  },
+  "dependencies": {
+    "@https-enable/adapter-koa": "workspace:*",
+    "@https-enable/core": "workspace:*",
+    "koa": "^2.16.0"
+  },
+  "devDependencies": {
+    "@types/koa": "^2.15.0"
+  }
+}

packages/adapters/koa/build.config.ts

@@ -0,0 +1,12 @@
+import { defineBuildConfig } from 'unbuild'
+
+export default defineBuildConfig({
+  entries: ['src/index'],
+  declaration: true,
+  clean: true,
+  rollup: {
+    emitCJS: true,
+  },
+  failOnWarn: false,
+  externals: [],
+})

packages/adapters/koa/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@https-enable/adapter-koa",
+  "version": "0.1.0",
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "dev": "unbuild --stub",
+    "release": "npm run build && bumpp",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "@https-enable/core": "workspace:*",
+    "koa": "*"
+  },
+  "dependencies": {
+    "@https-enable/mkcert": "workspace:*"
+  },
+  "devDependencies": {
+    "@https-enable/tsconfig": "workspace:*",
+    "@https-enable/types": "workspace:*",
+    "@types/koa": "^2.15.0",
+    "@types/node": "^22.13.1",
+    "unbuild": "^3.3.1"
+  }
+}

packages/adapters/koa/src/index.ts

@@ -0,0 +1,18 @@
+import type { ServerOptions } from '@https-enable/core'
+import type { Certificate } from '@https-enable/mkcert'
+import type Koa from 'koa'
+import { HttpsAdapter } from '@https-enable/core'
+
+type KoaApp = Koa<Koa.DefaultState, Koa.DefaultContext>
+type Callback = ReturnType<KoaApp['callback']>
+
+export class KoaHttpsAdapter extends HttpsAdapter<Callback> {
+  constructor(app: KoaApp) {
+    super()
+    this.app = app.callback()
+  }
+
+  init?: () => Promise<Callback>
+  createMiddleware?: (options: ServerOptions) => any
+  onCertRenewed?: (certificate: Certificate) => any
+}

packages/adapters/koa/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "@https-enable/tsconfig/tsconfig.node.json",
+  "compilerOptions": {
+    "incremental": false,
+    "composite": false,
+    "module": "ESNext",
+    "moduleResolution": "Bundler"
+  },
+  "include": ["src/**/*.ts", "src/**/*.d.ts"],
+  "exclude": ["dist", "build", "node_modules"]
+}