@mokup/server 1.1.1 → 1.1.3

package/README.md

@@ -5,3 +5,12 @@ English | [Chinese](./README.zh-CN.md)
 ## Overview
 
 Server adapters for Mokup that integrate the runtime with popular Node frameworks and Workers. For detailed usage, see https://mokup.icebreaker.top.
+
+This package is used internally by `mokup`. Prefer the public entrypoints below.
+
+## Entrypoints
+
+- `mokup/server`: Node adapters and dev server helpers
+- `mokup/server/node`: Node `serve` helper
+- `mokup/server/fetch`: runtime-agnostic fetch handler + types
+- `mokup/server/worker`: Worker helper that wraps `createFetchHandler` and returns 404 on `null`

package/README.zh-CN.md

@@ -5,3 +5,12 @@
 ## 概览
 
 Mokup 的 Server 适配器集合，用于把运行时接入各类 Node 框架与 Worker。完整文档见 https://mokup.icebreaker.top。
+
+该包为 `mokup` 内部依赖，建议使用下方公开入口。
+
+## 入口说明
+
+- `mokup/server`：Node 适配器与开发服务器
+- `mokup/server/node`：Node `serve` 入口
+- `mokup/server/fetch`：运行时无关的 fetch 入口 + 类型
+- `mokup/server/worker`：Worker helper，封装 `createFetchHandler` 并在 `null` 时返回 404

package/dist/connect.cjs

@@ -0,0 +1,25 @@
+'use strict';
+
+const runtime = require('@mokup/runtime');
+const runtime$1 = require('./shared/server.aaygIV2Q.cjs');
+
+function createConnectMiddleware(options) {
+  const runtime$2 = runtime.createRuntime(runtime$1.toRuntimeOptions(options));
+  const onNotFound = options.onNotFound ?? "next";
+  return async (req, res, next) => {
+    const runtimeRequest = await runtime$1.toRuntimeRequestFromNode(req);
+    const result = await runtime$2.handle(runtimeRequest);
+    if (!result) {
+      if (onNotFound === "response") {
+        res.statusCode = 404;
+        res.end();
+        return;
+      }
+      next();
+      return;
+    }
+    runtime$1.applyRuntimeResultToNode(res, result);
+  };
+}
+
+exports.createConnectMiddleware = createConnectMiddleware;

package/dist/connect.d.cts

@@ -0,0 +1,19 @@
+import { N as NodeRequestLike, a as NodeResponseLike } from './shared/server.D0gAciOr.cjs';
+import { S as ServerOptions } from './shared/server.DkerfsA-.cjs';
+import '@mokup/runtime';
+
+type NextFunction = (error?: unknown) => void;
+/**
+ * Create a Connect-style middleware from server options.
+ *
+ * @param options - Server options.
+ * @returns Connect middleware handler.
+ *
+ * @example
+ * import { createConnectMiddleware } from '@mokup/server'
+ *
+ * const middleware = createConnectMiddleware({ manifest: { version: 1, routes: [] } })
+ */
+declare function createConnectMiddleware(options: ServerOptions): (req: NodeRequestLike, res: NodeResponseLike, next: NextFunction) => Promise<void>;
+
+export { createConnectMiddleware };

package/dist/connect.d.mts

@@ -0,0 +1,19 @@
+import { N as NodeRequestLike, a as NodeResponseLike } from './shared/server.D0gAciOr.mjs';
+import { S as ServerOptions } from './shared/server.DkerfsA-.mjs';
+import '@mokup/runtime';
+
+type NextFunction = (error?: unknown) => void;
+/**
+ * Create a Connect-style middleware from server options.
+ *
+ * @param options - Server options.
+ * @returns Connect middleware handler.
+ *
+ * @example
+ * import { createConnectMiddleware } from '@mokup/server'
+ *
+ * const middleware = createConnectMiddleware({ manifest: { version: 1, routes: [] } })
+ */
+declare function createConnectMiddleware(options: ServerOptions): (req: NodeRequestLike, res: NodeResponseLike, next: NextFunction) => Promise<void>;
+
+export { createConnectMiddleware };

package/dist/connect.d.ts

@@ -0,0 +1,19 @@
+import { N as NodeRequestLike, a as NodeResponseLike } from './shared/server.D0gAciOr.js';
+import { S as ServerOptions } from './shared/server.DkerfsA-.js';
+import '@mokup/runtime';
+
+type NextFunction = (error?: unknown) => void;
+/**
+ * Create a Connect-style middleware from server options.
+ *
+ * @param options - Server options.
+ * @returns Connect middleware handler.
+ *
+ * @example
+ * import { createConnectMiddleware } from '@mokup/server'
+ *
+ * const middleware = createConnectMiddleware({ manifest: { version: 1, routes: [] } })
+ */
+declare function createConnectMiddleware(options: ServerOptions): (req: NodeRequestLike, res: NodeResponseLike, next: NextFunction) => Promise<void>;
+
+export { createConnectMiddleware };

package/dist/connect.mjs

@@ -0,0 +1,23 @@
+import { createRuntime } from '@mokup/runtime';
+import { t as toRuntimeOptions, a as toRuntimeRequestFromNode, b as applyRuntimeResultToNode } from './shared/server.LbftO9Jh.mjs';
+
+function createConnectMiddleware(options) {
+  const runtime = createRuntime(toRuntimeOptions(options));
+  const onNotFound = options.onNotFound ?? "next";
+  return async (req, res, next) => {
+    const runtimeRequest = await toRuntimeRequestFromNode(req);
+    const result = await runtime.handle(runtimeRequest);
+    if (!result) {
+      if (onNotFound === "response") {
+        res.statusCode = 404;
+        res.end();
+        return;
+      }
+      next();
+      return;
+    }
+    applyRuntimeResultToNode(res, result);
+  };
+}
+
+export { createConnectMiddleware };

package/dist/express.cjs

@@ -0,0 +1,11 @@
+'use strict';
+
+const connect = require('./connect.cjs');
+require('@mokup/runtime');
+require('./shared/server.aaygIV2Q.cjs');
+
+function createExpressMiddleware(options) {
+  return connect.createConnectMiddleware(options);
+}
+
+exports.createExpressMiddleware = createExpressMiddleware;

package/dist/express.d.cts

@@ -0,0 +1,18 @@
+import { N as NodeRequestLike, a as NodeResponseLike } from './shared/server.D0gAciOr.cjs';
+import { S as ServerOptions } from './shared/server.DkerfsA-.cjs';
+import '@mokup/runtime';
+
+/**
+ * Create an Express middleware from server options.
+ *
+ * @param options - Server options.
+ * @returns Express middleware handler.
+ *
+ * @example
+ * import { createExpressMiddleware } from '@mokup/server'
+ *
+ * const middleware = createExpressMiddleware({ manifest: { version: 1, routes: [] } })
+ */
+declare function createExpressMiddleware(options: ServerOptions): (req: NodeRequestLike, res: NodeResponseLike, next: (error?: unknown) => void) => Promise<void>;
+
+export { createExpressMiddleware };

package/dist/express.d.mts

@@ -0,0 +1,18 @@
+import { N as NodeRequestLike, a as NodeResponseLike } from './shared/server.D0gAciOr.mjs';
+import { S as ServerOptions } from './shared/server.DkerfsA-.mjs';
+import '@mokup/runtime';
+
+/**
+ * Create an Express middleware from server options.
+ *
+ * @param options - Server options.
+ * @returns Express middleware handler.
+ *
+ * @example
+ * import { createExpressMiddleware } from '@mokup/server'
+ *
+ * const middleware = createExpressMiddleware({ manifest: { version: 1, routes: [] } })
+ */
+declare function createExpressMiddleware(options: ServerOptions): (req: NodeRequestLike, res: NodeResponseLike, next: (error?: unknown) => void) => Promise<void>;
+
+export { createExpressMiddleware };

package/dist/express.d.ts

@@ -0,0 +1,18 @@
+import { N as NodeRequestLike, a as NodeResponseLike } from './shared/server.D0gAciOr.js';
+import { S as ServerOptions } from './shared/server.DkerfsA-.js';
+import '@mokup/runtime';
+
+/**
+ * Create an Express middleware from server options.
+ *
+ * @param options - Server options.
+ * @returns Express middleware handler.
+ *
+ * @example
+ * import { createExpressMiddleware } from '@mokup/server'
+ *
+ * const middleware = createExpressMiddleware({ manifest: { version: 1, routes: [] } })
+ */
+declare function createExpressMiddleware(options: ServerOptions): (req: NodeRequestLike, res: NodeResponseLike, next: (error?: unknown) => void) => Promise<void>;
+
+export { createExpressMiddleware };

package/dist/express.mjs

@@ -0,0 +1,9 @@
+import { createConnectMiddleware } from './connect.mjs';
+import '@mokup/runtime';
+import './shared/server.LbftO9Jh.mjs';
+
+function createExpressMiddleware(options) {
+  return createConnectMiddleware(options);
+}
+
+export { createExpressMiddleware };

package/dist/fastify.cjs

@@ -0,0 +1,39 @@
+'use strict';
+
+const runtime = require('@mokup/runtime');
+const runtime$1 = require('./shared/server.aaygIV2Q.cjs');
+
+function createFastifyPlugin(options) {
+  const runtime$2 = runtime.createRuntime(runtime$1.toRuntimeOptions(options));
+  const onNotFound = options.onNotFound ?? "next";
+  return async (instance) => {
+    instance.addHook("onRequest", async (request, reply) => {
+      const runtimeRequest = await runtime$1.toRuntimeRequestFromNode(
+        request.raw ?? request,
+        request.body
+      );
+      const result = await runtime$2.handle(runtimeRequest);
+      if (!result) {
+        if (onNotFound === "response") {
+          reply.status(404).send();
+        }
+        return;
+      }
+      reply.status(result.status);
+      for (const [key, value] of Object.entries(result.headers)) {
+        reply.header(key, value);
+      }
+      if (result.body === null) {
+        reply.send();
+        return;
+      }
+      if (typeof result.body === "string") {
+        reply.send(result.body);
+        return;
+      }
+      reply.send(runtime$1.toBinaryBody(result.body));
+    });
+  };
+}
+
+exports.createFastifyPlugin = createFastifyPlugin;

package/dist/fastify.d.cts

@@ -0,0 +1,29 @@
+import { N as NodeRequestLike } from './shared/server.D0gAciOr.cjs';
+import { S as ServerOptions } from './shared/server.DkerfsA-.cjs';
+import '@mokup/runtime';
+
+interface FastifyRequestLike extends NodeRequestLike {
+    raw?: NodeRequestLike;
+}
+interface FastifyReplyLike {
+    status: (code: number) => FastifyReplyLike;
+    header: (name: string, value: string) => FastifyReplyLike;
+    send: (payload?: unknown) => void;
+}
+interface FastifyInstanceLike {
+    addHook: (name: 'onRequest' | 'preHandler', handler: (request: FastifyRequestLike, reply: FastifyReplyLike) => Promise<void> | void) => void;
+}
+/**
+ * Create a Fastify plugin from server options.
+ *
+ * @param options - Server options.
+ * @returns Fastify plugin handler.
+ *
+ * @example
+ * import { createFastifyPlugin } from '@mokup/server'
+ *
+ * const plugin = createFastifyPlugin({ manifest: { version: 1, routes: [] } })
+ */
+declare function createFastifyPlugin(options: ServerOptions): (instance: FastifyInstanceLike) => Promise<void>;
+
+export { createFastifyPlugin };

package/dist/fastify.d.mts

@@ -0,0 +1,29 @@
+import { N as NodeRequestLike } from './shared/server.D0gAciOr.mjs';
+import { S as ServerOptions } from './shared/server.DkerfsA-.mjs';
+import '@mokup/runtime';
+
+interface FastifyRequestLike extends NodeRequestLike {
+    raw?: NodeRequestLike;
+}
+interface FastifyReplyLike {
+    status: (code: number) => FastifyReplyLike;
+    header: (name: string, value: string) => FastifyReplyLike;
+    send: (payload?: unknown) => void;
+}
+interface FastifyInstanceLike {
+    addHook: (name: 'onRequest' | 'preHandler', handler: (request: FastifyRequestLike, reply: FastifyReplyLike) => Promise<void> | void) => void;
+}
+/**
+ * Create a Fastify plugin from server options.
+ *
+ * @param options - Server options.
+ * @returns Fastify plugin handler.
+ *
+ * @example
+ * import { createFastifyPlugin } from '@mokup/server'
+ *
+ * const plugin = createFastifyPlugin({ manifest: { version: 1, routes: [] } })
+ */
+declare function createFastifyPlugin(options: ServerOptions): (instance: FastifyInstanceLike) => Promise<void>;
+
+export { createFastifyPlugin };

package/dist/fastify.d.ts

@@ -0,0 +1,29 @@
+import { N as NodeRequestLike } from './shared/server.D0gAciOr.js';
+import { S as ServerOptions } from './shared/server.DkerfsA-.js';
+import '@mokup/runtime';
+
+interface FastifyRequestLike extends NodeRequestLike {
+    raw?: NodeRequestLike;
+}
+interface FastifyReplyLike {
+    status: (code: number) => FastifyReplyLike;
+    header: (name: string, value: string) => FastifyReplyLike;
+    send: (payload?: unknown) => void;
+}
+interface FastifyInstanceLike {
+    addHook: (name: 'onRequest' | 'preHandler', handler: (request: FastifyRequestLike, reply: FastifyReplyLike) => Promise<void> | void) => void;
+}
+/**
+ * Create a Fastify plugin from server options.
+ *
+ * @param options - Server options.
+ * @returns Fastify plugin handler.
+ *
+ * @example
+ * import { createFastifyPlugin } from '@mokup/server'
+ *
+ * const plugin = createFastifyPlugin({ manifest: { version: 1, routes: [] } })
+ */
+declare function createFastifyPlugin(options: ServerOptions): (instance: FastifyInstanceLike) => Promise<void>;
+
+export { createFastifyPlugin };

package/dist/fastify.mjs

@@ -0,0 +1,37 @@
+import { createRuntime } from '@mokup/runtime';
+import { t as toRuntimeOptions, a as toRuntimeRequestFromNode, c as toBinaryBody } from './shared/server.LbftO9Jh.mjs';
+
+function createFastifyPlugin(options) {
+  const runtime = createRuntime(toRuntimeOptions(options));
+  const onNotFound = options.onNotFound ?? "next";
+  return async (instance) => {
+    instance.addHook("onRequest", async (request, reply) => {
+      const runtimeRequest = await toRuntimeRequestFromNode(
+        request.raw ?? request,
+        request.body
+      );
+      const result = await runtime.handle(runtimeRequest);
+      if (!result) {
+        if (onNotFound === "response") {
+          reply.status(404).send();
+        }
+        return;
+      }
+      reply.status(result.status);
+      for (const [key, value] of Object.entries(result.headers)) {
+        reply.header(key, value);
+      }
+      if (result.body === null) {
+        reply.send();
+        return;
+      }
+      if (typeof result.body === "string") {
+        reply.send(result.body);
+        return;
+      }
+      reply.send(toBinaryBody(result.body));
+    });
+  };
+}
+
+export { createFastifyPlugin };