@kubun/plugin-http 0.8.0

package/LICENSE.md

@@ -0,0 +1,57 @@
+# The Prosperity Public License 3.0.0
+
+Contributor: Paul Le Cam
+
+Source Code: https://github.com/PaulLeCam/kubun
+
+## Purpose
+
+This license allows you to use and share this software for noncommercial purposes for free and to try this software for commercial purposes for thirty days.
+
+## Agreement
+
+In order to receive this license, you have to agree to its rules.  Those rules are both obligations under that agreement and conditions to your license.  Don't do anything with this software that triggers a rule you can't or won't follow.
+
+## Notices
+
+Make sure everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license and the contributor and source code lines above.
+
+## Commercial Trial
+
+Limit your use of this software for commercial purposes to a thirty-day trial period.  If you use this software for work, your company gets one trial period for all personnel, not one trial per person.
+
+## Contributions Back
+
+Developing feedback, changes, or additions that you contribute back to the contributor on the terms of a standardized public software license such as [the Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0), [the Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html), [the MIT license](https://spdx.org/licenses/MIT.html), or [the two-clause BSD license](https://spdx.org/licenses/BSD-2-Clause.html) doesn't count as use for a commercial purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, doesn't count as use for a commercial purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution doesn't count as use for a commercial purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Defense
+
+Don't make any legal claim against anyone accusing this software, with or without changes, alone or with other technology, of infringing any patent.
+
+## Copyright
+
+The contributor licenses you to do everything with this software that would otherwise infringe their copyright in it.
+
+## Patent
+
+The contributor licenses you to do everything with this software that would otherwise infringe any patents they can license or become able to license.
+
+## Reliability
+
+The contributor can't revoke this license.
+
+## Excuse
+
+You're excused for unknowingly breaking [Notices](#notices) if you take all practical steps to comply within thirty days of learning you broke the rule.
+
+## No Liability
+
+***As far as the law allows, this software comes as is, without any warranty or condition, and the contributor won't be liable to anyone for any damages related to this software or this license, under any kind of legal claim.***

package/lib/index.d.ts

@@ -0,0 +1,64 @@
+import type { KubunPlugin, PluginFactoryParams } from '@kubun/engine';
+import type { RPCPluginAPI } from '@kubun/plugin-rpc';
+import { Hono } from 'hono';
+/**
+ * Options for the HTTP infrastructure plugin.
+ */
+export type HTTPPluginOptions = {
+    /** Port to listen on. Default: 4321 (falls back to a random available port). */
+    port?: number;
+    /** Allowed CORS origin(s). Default: ['*']. Comma-separated strings are split. */
+    allowedOrigin?: string | Array<string>;
+    /** Namespace prefix for all plugin-managed routes (health, info, protocols). Default: '/'. */
+    prefix?: string;
+    /** Enkaku protocol access control. Default: true (Server verifies message signatures). */
+    accessControl?: false | true | Record<string, boolean | Array<string>>;
+};
+/**
+ * API provided by the HTTP infrastructure plugin.
+ * Provides a shared routing surface for other plugins to register routes on.
+ */
+export type HTTPPluginAPI = {
+    /** Resolves when the HTTP server is accepting connections. */
+    listening: Promise<void>;
+    registerRoute: (method: string, path: string, handler: (c: unknown) => unknown) => void;
+    registerProtocol: (name: string, fetch: (req: Request) => Response | Promise<Response>) => void;
+    getPort: () => number;
+    getURL: () => string;
+};
+/**
+ * Options for creating a standalone graph protocol Hono app.
+ */
+export type GraphAppOptions = {
+    /** The RPC plugin API (already resolved). */
+    rpc: RPCPluginAPI;
+    /** Allowed CORS origin(s). Default: ['*']. */
+    allowedOrigin?: string | Array<string>;
+};
+/**
+ * A mountable Hono sub-app with graph protocol routes.
+ */
+export type GraphApp = {
+    app: Hono;
+    dispose: () => Promise<void>;
+};
+/**
+ * Creates a standalone Hono app with graph protocol routes.
+ *
+ * Unlike createHTTPPlugin, this does NOT start an HTTP server or bind a port.
+ * The returned app is meant to be mounted on an existing Hono app via `parent.route(prefix, graphApp.app)`.
+ *
+ * The caller is responsible for:
+ * - Creating and awaiting the KubunEngine
+ * - Resolving the RPCPluginAPI via engine.getAPI('rpc')
+ * - Mounting the returned app and managing the HTTP server lifecycle
+ */
+export declare function createGraphApp(options: GraphAppOptions): GraphApp;
+/**
+ * Creates the HTTP infrastructure plugin.
+ *
+ * Wraps a Hono app instance, binds it to a port using @hono/node-server,
+ * and serves Enkaku protocol handlers over HTTP via ServerTransport.
+ * Other plugins can register additional routes via the API.
+ */
+export declare function createHTTPPlugin(options?: HTTPPluginOptions): (params: PluginFactoryParams) => KubunPlugin;

package/lib/index.js

@@ -0,0 +1 @@
+import{defer as t}from"@enkaku/async";import{ServerTransport as e}from"@enkaku/http-server-transport";import{serve as r}from"@hono/node-server";import o from"get-port";import{Hono as n}from"hono";function i(t){return null==t?["*"]:"string"==typeof t?t.split(",").map(t=>t.trim()):t}function s(t){return async e=>t(e.req.raw)}export function createGraphApp(t){let r=new n,o=new e({allowedOrigin:i(t.allowedOrigin)}),p=s(o.fetch.bind(o)),a=t.rpc.serve(o);return r.post("/graph",p),r.post("/graph/*",p),r.options("/graph",p),r.options("/graph/*",p),{app:r,async dispose(){await a.dispose()}}}export function createHTTPPlugin(p){return a=>{let l,g,c,h,u=new n,f=t(),w=i(p?.allowedOrigin),d=p?.prefix??"/",m="/"===d?"":d.endsWith("/")?d.slice(0,-1):d,y=new Map;u.get(`${m}/health`,t=>t.json({status:"ok"})),u.get(`${m}/info`,t=>{let e={};for(let[t,r]of y)e[t]=r;return t.json({did:a.identity.id,protocols:e})});let P={listening:null,registerRoute(t,e,r){u[t.toLowerCase()](e,r)},registerProtocol(t,e){let r=`${m}/${t}`;y.set(t,r);let o=s(e);u.post(r,o),u.post(`${r}/*`,o),u.options(r,o),u.options(`${r}/*`,o)},getPort(){if(null==l)throw Error("HTTP server is not listening yet");return l},getURL(){if(null==g)throw Error("HTTP server is not listening yet");return g}},v=(async()=>{await a.engine.ready;let t=p?.port??await o({port:4321}),n=new e({allowedOrigin:w});P.registerProtocol("graph",n.fetch.bind(n)),h=(await a.engine.getAPI("rpc")).serve(n),c=r({fetch:u.fetch,port:t},t=>{l=t.port,g=`http://localhost:${t.port}`,f.resolve()}),await f.promise})();return P.listening=v,{name:"http",api:P,async dispose(){await h?.dispose(),c?.close()}}}}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@kubun/plugin-http",
+  "version": "0.8.0",
+  "license": "see LICENSE.md",
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "files": [
+    "lib/*",
+    "LICENSE.md"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@enkaku/async": "^0.14.0",
+    "@enkaku/http-server-transport": "^0.14.2",
+    "@enkaku/protocol": "^0.14.0",
+    "@enkaku/server": "^0.14.3",
+    "@hono/node-server": "^1.19.12",
+    "get-port": "^7.2.0",
+    "hono": "^4.12.9",
+    "@kubun/engine": "^0.8.0"
+  },
+  "devDependencies": {
+    "@enkaku/http-client-transport": "^0.14.3",
+    "@kubun/protocol": "^0.8.0",
+    "@kubun/plugin-rpc": "^0.8.0",
+    "@kubun/test-utils": "^0.8.0",
+    "@kubun/client": "^0.8.0"
+  },
+  "scripts": {
+    "build:clean": "del lib",
+    "build:js": "swc src -d ./lib --config-file ../../swc.json --strip-leading-paths",
+    "build:types": "tsc --emitDeclarationOnly --skipLibCheck",
+    "build": "pnpm run build:clean && pnpm run build:js && pnpm run build:types",
+    "test:types": "tsc --noEmit -p tsconfig.test.json",
+    "test:unit": "vitest run",
+    "test": "pnpm run test:types && pnpm run test:unit"
+  }
+}