@react-router/express 0.0.0-experimental-7c6c0664d → 0.0.0-experimental-9f7fdccd4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,25 @@
1
+ import * as express from 'express';
2
+ import { AppLoadContext, ServerBuild } from 'react-router';
3
+
4
+ /// <reference lib="dom.iterable" />
5
+
6
+ /**
7
+ * A function that returns the value to use as `context` in route `loader` and
8
+ * `action` functions.
9
+ *
10
+ * You can think of this as an escape hatch that allows you to pass
11
+ * environment/platform-specific values through to your loader/action, such as
12
+ * values that are generated by Express middleware like `req.session`.
13
+ */
14
+ type GetLoadContextFunction = (req: express.Request, res: express.Response) => Promise<AppLoadContext> | AppLoadContext;
15
+ type RequestHandler = (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<void>;
16
+ /**
17
+ * Returns a request handler for Express that serves the response using Remix.
18
+ */
19
+ declare function createRequestHandler({ build, getLoadContext, mode, }: {
20
+ build: ServerBuild | (() => Promise<ServerBuild>);
21
+ getLoadContext?: GetLoadContextFunction;
22
+ mode?: string;
23
+ }): RequestHandler;
24
+
25
+ export { type GetLoadContextFunction, type RequestHandler, createRequestHandler };
package/dist/index.d.ts CHANGED
@@ -1,2 +1,25 @@
1
- export type { GetLoadContextFunction, RequestHandler } from "./server";
2
- export { createRequestHandler } from "./server";
1
+ import * as express from 'express';
2
+ import { AppLoadContext, ServerBuild } from 'react-router';
3
+
4
+ /// <reference lib="dom.iterable" />
5
+
6
+ /**
7
+ * A function that returns the value to use as `context` in route `loader` and
8
+ * `action` functions.
9
+ *
10
+ * You can think of this as an escape hatch that allows you to pass
11
+ * environment/platform-specific values through to your loader/action, such as
12
+ * values that are generated by Express middleware like `req.session`.
13
+ */
14
+ type GetLoadContextFunction = (req: express.Request, res: express.Response) => Promise<AppLoadContext> | AppLoadContext;
15
+ type RequestHandler = (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<void>;
16
+ /**
17
+ * Returns a request handler for Express that serves the response using Remix.
18
+ */
19
+ declare function createRequestHandler({ build, getLoadContext, mode, }: {
20
+ build: ServerBuild | (() => Promise<ServerBuild>);
21
+ getLoadContext?: GetLoadContextFunction;
22
+ mode?: string;
23
+ }): RequestHandler;
24
+
25
+ export { type GetLoadContextFunction, type RequestHandler, createRequestHandler };
package/dist/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @react-router/express v0.0.0-experimental-7c6c0664d
2
+ * @react-router/express v0.0.0-experimental-9f7fdccd4
3
3
  *
4
4
  * Copyright (c) Remix Software Inc.
5
5
  *
@@ -8,12 +8,103 @@
8
8
  *
9
9
  * @license MIT
10
10
  */
11
- 'use strict';
11
+ "use strict";
12
+ var __defProp = Object.defineProperty;
13
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
14
+ var __getOwnPropNames = Object.getOwnPropertyNames;
15
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
16
+ var __export = (target, all) => {
17
+ for (var name in all)
18
+ __defProp(target, name, { get: all[name], enumerable: true });
19
+ };
20
+ var __copyProps = (to, from, except, desc) => {
21
+ if (from && typeof from === "object" || typeof from === "function") {
22
+ for (let key of __getOwnPropNames(from))
23
+ if (!__hasOwnProp.call(to, key) && key !== except)
24
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
25
+ }
26
+ return to;
27
+ };
28
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
12
29
 
13
- Object.defineProperty(exports, '__esModule', { value: true });
30
+ // index.ts
31
+ var react_router_express_exports = {};
32
+ __export(react_router_express_exports, {
33
+ createRequestHandler: () => createRequestHandler
34
+ });
35
+ module.exports = __toCommonJS(react_router_express_exports);
14
36
 
15
- var server = require('./server.js');
16
-
17
-
18
-
19
- exports.createRequestHandler = server.createRequestHandler;
37
+ // server.ts
38
+ var import_react_router = require("react-router");
39
+ var import_node = require("@react-router/node");
40
+ function createRequestHandler({
41
+ build,
42
+ getLoadContext,
43
+ mode = process.env.NODE_ENV
44
+ }) {
45
+ let handleRequest = (0, import_react_router.createRequestHandler)(build, mode);
46
+ return async (req, res, next) => {
47
+ try {
48
+ let request = createRemixRequest(req, res);
49
+ let loadContext = await getLoadContext?.(req, res);
50
+ let response = await handleRequest(request, loadContext);
51
+ await sendRemixResponse(res, response);
52
+ } catch (error) {
53
+ next(error);
54
+ }
55
+ };
56
+ }
57
+ function createRemixHeaders(requestHeaders) {
58
+ let headers = new Headers();
59
+ for (let [key, values] of Object.entries(requestHeaders)) {
60
+ if (values) {
61
+ if (Array.isArray(values)) {
62
+ for (let value of values) {
63
+ headers.append(key, value);
64
+ }
65
+ } else {
66
+ headers.set(key, values);
67
+ }
68
+ }
69
+ }
70
+ return headers;
71
+ }
72
+ function createRemixRequest(req, res) {
73
+ let [, hostnamePort] = req.get("X-Forwarded-Host")?.split(":") ?? [];
74
+ let [, hostPort] = req.get("host")?.split(":") ?? [];
75
+ let port = hostnamePort || hostPort;
76
+ let resolvedHost = `${req.hostname}${port ? `:${port}` : ""}`;
77
+ let url = new URL(`${req.protocol}://${resolvedHost}${req.originalUrl}`);
78
+ let controller = new AbortController();
79
+ let init = {
80
+ method: req.method,
81
+ headers: createRemixHeaders(req.headers),
82
+ signal: controller.signal
83
+ };
84
+ res.on("finish", () => controller = null);
85
+ res.on("close", () => controller?.abort());
86
+ if (req.method !== "GET" && req.method !== "HEAD") {
87
+ init.body = (0, import_node.createReadableStreamFromReadable)(req);
88
+ init.duplex = "half";
89
+ }
90
+ return new Request(url.href, init);
91
+ }
92
+ async function sendRemixResponse(res, nodeResponse) {
93
+ res.statusMessage = nodeResponse.statusText;
94
+ res.status(nodeResponse.status);
95
+ for (let [key, value] of nodeResponse.headers.entries()) {
96
+ res.append(key, value);
97
+ }
98
+ if (nodeResponse.headers.get("Content-Type")?.match(/text\/event-stream/i)) {
99
+ res.flushHeaders();
100
+ }
101
+ if (nodeResponse.body) {
102
+ await (0, import_node.writeReadableStreamToWritable)(nodeResponse.body, res);
103
+ } else {
104
+ res.end();
105
+ }
106
+ }
107
+ // Annotate the CommonJS export names for ESM import in node:
108
+ 0 && (module.exports = {
109
+ createRequestHandler
110
+ });
package/dist/index.mjs ADDED
@@ -0,0 +1,87 @@
1
+ /**
2
+ * @react-router/express v0.0.0-experimental-9f7fdccd4
3
+ *
4
+ * Copyright (c) Remix Software Inc.
5
+ *
6
+ * This source code is licensed under the MIT license found in the
7
+ * LICENSE.md file in the root directory of this source tree.
8
+ *
9
+ * @license MIT
10
+ */
11
+
12
+ // server.ts
13
+ import { createRequestHandler as createRemixRequestHandler } from "react-router";
14
+ import {
15
+ createReadableStreamFromReadable,
16
+ writeReadableStreamToWritable
17
+ } from "@react-router/node";
18
+ function createRequestHandler({
19
+ build,
20
+ getLoadContext,
21
+ mode = process.env.NODE_ENV
22
+ }) {
23
+ let handleRequest = createRemixRequestHandler(build, mode);
24
+ return async (req, res, next) => {
25
+ try {
26
+ let request = createRemixRequest(req, res);
27
+ let loadContext = await getLoadContext?.(req, res);
28
+ let response = await handleRequest(request, loadContext);
29
+ await sendRemixResponse(res, response);
30
+ } catch (error) {
31
+ next(error);
32
+ }
33
+ };
34
+ }
35
+ function createRemixHeaders(requestHeaders) {
36
+ let headers = new Headers();
37
+ for (let [key, values] of Object.entries(requestHeaders)) {
38
+ if (values) {
39
+ if (Array.isArray(values)) {
40
+ for (let value of values) {
41
+ headers.append(key, value);
42
+ }
43
+ } else {
44
+ headers.set(key, values);
45
+ }
46
+ }
47
+ }
48
+ return headers;
49
+ }
50
+ function createRemixRequest(req, res) {
51
+ let [, hostnamePort] = req.get("X-Forwarded-Host")?.split(":") ?? [];
52
+ let [, hostPort] = req.get("host")?.split(":") ?? [];
53
+ let port = hostnamePort || hostPort;
54
+ let resolvedHost = `${req.hostname}${port ? `:${port}` : ""}`;
55
+ let url = new URL(`${req.protocol}://${resolvedHost}${req.originalUrl}`);
56
+ let controller = new AbortController();
57
+ let init = {
58
+ method: req.method,
59
+ headers: createRemixHeaders(req.headers),
60
+ signal: controller.signal
61
+ };
62
+ res.on("finish", () => controller = null);
63
+ res.on("close", () => controller?.abort());
64
+ if (req.method !== "GET" && req.method !== "HEAD") {
65
+ init.body = createReadableStreamFromReadable(req);
66
+ init.duplex = "half";
67
+ }
68
+ return new Request(url.href, init);
69
+ }
70
+ async function sendRemixResponse(res, nodeResponse) {
71
+ res.statusMessage = nodeResponse.statusText;
72
+ res.status(nodeResponse.status);
73
+ for (let [key, value] of nodeResponse.headers.entries()) {
74
+ res.append(key, value);
75
+ }
76
+ if (nodeResponse.headers.get("Content-Type")?.match(/text\/event-stream/i)) {
77
+ res.flushHeaders();
78
+ }
79
+ if (nodeResponse.body) {
80
+ await writeReadableStreamToWritable(nodeResponse.body, res);
81
+ } else {
82
+ res.end();
83
+ }
84
+ }
85
+ export {
86
+ createRequestHandler
87
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@react-router/express",
3
- "version": "0.0.0-experimental-7c6c0664d",
3
+ "version": "0.0.0-experimental-9f7fdccd4",
4
4
  "description": "Express server request handler for React Router",
5
5
  "bugs": {
6
6
  "url": "https://github.com/remix-run/react-router/issues"
@@ -15,13 +15,37 @@
15
15
  "typings": "dist/index.d.ts",
16
16
  "exports": {
17
17
  ".": {
18
- "types": "./dist/index.d.ts",
19
- "default": "./dist/index.js"
18
+ "node": {
19
+ "types": "./dist/index.d.ts",
20
+ "module-sync": "./dist/index.mjs",
21
+ "default": "./dist/index.js"
22
+ },
23
+ "import": {
24
+ "types": "./dist/index.d.mts",
25
+ "default": "./dist/index.mjs"
26
+ },
27
+ "default": {
28
+ "types": "./dist/index.d.ts",
29
+ "default": "./dist/index.js"
30
+ }
20
31
  },
21
32
  "./package.json": "./package.json"
22
33
  },
34
+ "wireit": {
35
+ "build": {
36
+ "command": "tsup",
37
+ "files": [
38
+ "*.ts",
39
+ "tsconfig.json",
40
+ "package.json"
41
+ ],
42
+ "output": [
43
+ "dist/**"
44
+ ]
45
+ }
46
+ },
23
47
  "dependencies": {
24
- "@react-router/node": "0.0.0-experimental-7c6c0664d"
48
+ "@react-router/node": "0.0.0-experimental-9f7fdccd4"
25
49
  },
26
50
  "devDependencies": {
27
51
  "@types/express": "^4.17.9",
@@ -30,12 +54,14 @@
30
54
  "express": "^4.19.2",
31
55
  "node-mocks-http": "^1.10.1",
32
56
  "supertest": "^6.3.3",
33
- "typescript": "^5.1.6"
57
+ "tsup": "^8.3.0",
58
+ "typescript": "^5.1.6",
59
+ "wireit": "0.14.9"
34
60
  },
35
61
  "peerDependencies": {
36
62
  "express": "^4.17.1",
37
63
  "typescript": "^5.1.0",
38
- "react-router": "0.0.0-experimental-7c6c0664d"
64
+ "react-router": "0.0.0-experimental-9f7fdccd4"
39
65
  },
40
66
  "peerDependenciesMeta": {
41
67
  "typescript": {
@@ -52,6 +78,6 @@
52
78
  "README.md"
53
79
  ],
54
80
  "scripts": {
55
- "tsc": "tsc"
81
+ "build": "wireit"
56
82
  }
57
83
  }
package/dist/server.d.ts DELETED
@@ -1,24 +0,0 @@
1
- /// <reference lib="dom.iterable" />
2
- import type * as express from "express";
3
- import type { AppLoadContext, ServerBuild } from "react-router";
4
- /**
5
- * A function that returns the value to use as `context` in route `loader` and
6
- * `action` functions.
7
- *
8
- * You can think of this as an escape hatch that allows you to pass
9
- * environment/platform-specific values through to your loader/action, such as
10
- * values that are generated by Express middleware like `req.session`.
11
- */
12
- export type GetLoadContextFunction = (req: express.Request, res: express.Response) => Promise<AppLoadContext> | AppLoadContext;
13
- export type RequestHandler = (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<void>;
14
- /**
15
- * Returns a request handler for Express that serves the response using Remix.
16
- */
17
- export declare function createRequestHandler({ build, getLoadContext, mode, }: {
18
- build: ServerBuild | (() => Promise<ServerBuild>);
19
- getLoadContext?: GetLoadContextFunction;
20
- mode?: string;
21
- }): RequestHandler;
22
- export declare function createRemixHeaders(requestHeaders: express.Request["headers"]): Headers;
23
- export declare function createRemixRequest(req: express.Request, res: express.Response): Request;
24
- export declare function sendRemixResponse(res: express.Response, nodeResponse: Response): Promise<void>;
package/dist/server.js DELETED
@@ -1,121 +0,0 @@
1
- /**
2
- * @react-router/express v0.0.0-experimental-7c6c0664d
3
- *
4
- * Copyright (c) Remix Software Inc.
5
- *
6
- * This source code is licensed under the MIT license found in the
7
- * LICENSE.md file in the root directory of this source tree.
8
- *
9
- * @license MIT
10
- */
11
- 'use strict';
12
-
13
- Object.defineProperty(exports, '__esModule', { value: true });
14
-
15
- var reactRouter = require('react-router');
16
- var node = require('@react-router/node');
17
-
18
- // IDK why this is needed when it's in the tsconfig..........
19
-
20
- /**
21
- * A function that returns the value to use as `context` in route `loader` and
22
- * `action` functions.
23
- *
24
- * You can think of this as an escape hatch that allows you to pass
25
- * environment/platform-specific values through to your loader/action, such as
26
- * values that are generated by Express middleware like `req.session`.
27
- */
28
-
29
- /**
30
- * Returns a request handler for Express that serves the response using Remix.
31
- */
32
- function createRequestHandler({
33
- build,
34
- getLoadContext,
35
- mode = process.env.NODE_ENV
36
- }) {
37
- let handleRequest = reactRouter.createRequestHandler(build, mode);
38
- return async (req, res, next) => {
39
- try {
40
- let request = createRemixRequest(req, res);
41
- let loadContext = await (getLoadContext === null || getLoadContext === void 0 ? void 0 : getLoadContext(req, res));
42
- let response = await handleRequest(request, loadContext);
43
- await sendRemixResponse(res, response);
44
- } catch (error) {
45
- // Express doesn't support async functions, so we have to pass along the
46
- // error manually using next().
47
- next(error);
48
- }
49
- };
50
- }
51
- function createRemixHeaders(requestHeaders) {
52
- let headers = new Headers();
53
- for (let [key, values] of Object.entries(requestHeaders)) {
54
- if (values) {
55
- if (Array.isArray(values)) {
56
- for (let value of values) {
57
- headers.append(key, value);
58
- }
59
- } else {
60
- headers.set(key, values);
61
- }
62
- }
63
- }
64
- return headers;
65
- }
66
- function createRemixRequest(req, res) {
67
- var _req$get, _req$get2;
68
- // req.hostname doesn't include port information so grab that from
69
- // `X-Forwarded-Host` or `Host`
70
- let [, hostnamePort] = ((_req$get = req.get("X-Forwarded-Host")) === null || _req$get === void 0 ? void 0 : _req$get.split(":")) ?? [];
71
- let [, hostPort] = ((_req$get2 = req.get("host")) === null || _req$get2 === void 0 ? void 0 : _req$get2.split(":")) ?? [];
72
- let port = hostnamePort || hostPort;
73
- // Use req.hostname here as it respects the "trust proxy" setting
74
- let resolvedHost = `${req.hostname}${port ? `:${port}` : ""}`;
75
- // Use `req.originalUrl` so Remix is aware of the full path
76
- let url = new URL(`${req.protocol}://${resolvedHost}${req.originalUrl}`);
77
-
78
- // Abort action/loaders once we can no longer write a response
79
- let controller = new AbortController();
80
- let init = {
81
- method: req.method,
82
- headers: createRemixHeaders(req.headers),
83
- signal: controller.signal
84
- };
85
-
86
- // Abort action/loaders once we can no longer write a response iff we have
87
- // not yet sent a response (i.e., `close` without `finish`)
88
- // `finish` -> done rendering the response
89
- // `close` -> response can no longer be written to
90
- res.on("finish", () => controller = null);
91
- res.on("close", () => {
92
- var _controller;
93
- return (_controller = controller) === null || _controller === void 0 ? void 0 : _controller.abort();
94
- });
95
- if (req.method !== "GET" && req.method !== "HEAD") {
96
- init.body = node.createReadableStreamFromReadable(req);
97
- init.duplex = "half";
98
- }
99
- return new Request(url.href, init);
100
- }
101
- async function sendRemixResponse(res, nodeResponse) {
102
- var _nodeResponse$headers;
103
- res.statusMessage = nodeResponse.statusText;
104
- res.status(nodeResponse.status);
105
- for (let [key, value] of nodeResponse.headers.entries()) {
106
- res.append(key, value);
107
- }
108
- if ((_nodeResponse$headers = nodeResponse.headers.get("Content-Type")) !== null && _nodeResponse$headers !== void 0 && _nodeResponse$headers.match(/text\/event-stream/i)) {
109
- res.flushHeaders();
110
- }
111
- if (nodeResponse.body) {
112
- await node.writeReadableStreamToWritable(nodeResponse.body, res);
113
- } else {
114
- res.end();
115
- }
116
- }
117
-
118
- exports.createRemixHeaders = createRemixHeaders;
119
- exports.createRemixRequest = createRemixRequest;
120
- exports.createRequestHandler = createRequestHandler;
121
- exports.sendRemixResponse = sendRemixResponse;