@remix-run/node 1.19.3 → 2.0.0-pre.0

package/CHANGELOG.md

@@ -1,5 +1,91 @@
 # `@remix-run/node`
 
+## 2.0.0-pre.0
+
+### Major Changes
+
+- Require Node >=18.0.0 ([#6939](https://github.com/remix-run/remix/pull/6939))
+- We have made a few important changes to the route `meta` API as reflected in the v1 implementation when using the `future.v2_meta` config option. ([#6958](https://github.com/remix-run/remix/pull/6958))
+
+  - The `meta` function should no longer return an object, but an array of objects that map to the HTML tag's respective attributes. This provides more flexibility and control over how certain tags are rendered, and the order in which they appear.
+  - In most cases, `meta` descriptor objects render a `<meta>` tag. There are a few notable exceptions:
+    - `{ title: "My app" }` will render `<title>My app</title>`.
+    - `{ 'script:ld+json': { /* ... */ } }` will render `<script type="application/ld+json">/* ... */</script>`, where the value is serialized to JSON and rendered inside the `<script>` tag.
+    - `{ tagName: 'link', ...attributes }` will render `<link {...attributes} />`
+      - This is useful for things like setting canonical URLs. For loading assets, we encourage you to use the `links` export instead.
+      - It's important to note that `tagName` may only accept `meta` or `link`, so other arbitrary elements will be ignored.
+  - `<Meta />` will no longer render the `meta` output from the entire route hierarchy. Only the output from the leaf (current) route will be rendered unless that route does not export a `meta` function, in which case the output from the nearest ancestor route with `meta` will be rendered.
+    - This change comes from user feedback that auto-merging meta made effective SEO difficult to implement. Our goal is to give you as much control as you need over meta tags for each individual route.
+    - Our suggested approach is to **only export a `meta` function from leaf route modules**. However, if you do want to render a tag from another matched route, `meta` now accepts a `matches` argument for you to merge or override parent route meta as you'd like.
+    ```tsx
+    export function meta({ matches }) {
+      return [
+        // render all ancestor route meta except for title tags
+        ...matches
+          .flatMap((match) => match.meta)
+          .filter((match) => !("title" in match)),
+        { title: "Override the title!" },
+      ];
+    }
+    ```
+  - The `parentsData` argument has been removed. If you need to access data from a parent route, you can use `matches` instead.
+    ```tsx
+    // before
+    export function meta({ parentsData }) {
+      return [{ title: parentsData["routes/some-route"].title }];
+    }
+    // after
+    export function meta({ matches }) {
+      return [
+        {
+          title: matches.find((match) => match.id === "routes/some-route").data
+            .title,
+        },
+      ];
+    }
+    ```
+
+- For preparation of using Node's built in fetch implementation, installing the fetch globals is now a responsibility of the app server. If you are using `remix-serve`, nothing is required. If you are using your own app server, you will need to install the globals yourself. ([#7009](https://github.com/remix-run/remix/pull/7009))
+
+  ```js filename=server.js
+  import { installGlobals } from "@remix-run/node";
+
+  installGlobals();
+  ```
+
+  source-map-support is now a responsibility of the app server. If you are using `remix-serve`, nothing is required. If you are using your own app server, you will need to install [`source-map-support`](https://www.npmjs.com/package/source-map-support) yourself.
+
+  ```sh
+  npm i source-map-support
+  ```
+
+  ```js filename=server.js
+  import sourceMapSupport from "source-map-support";
+  sourceMapSupport.install();
+  ```
+
+- Removed support for "magic exports" from the `remix` package. This package can be removed from your `package.json` and you should update all imports to use the source `@remix-run/*` packages: ([#6895](https://github.com/remix-run/remix/pull/6895))
+
+  ```diff
+  - import type { ActionArgs } from "remix";
+  - import { json, useLoaderData } from "remix";
+  + import type { ActionArgs } from "@remix-run/node";
+  + import { json } from "@remix-run/node";
+  + import { useLoaderData } from "@remix-run/react";
+  ```
+
+### Minor Changes
+
+- Re-export new `redirectDocument` method from React Router ([#7040](https://github.com/remix-run/remix/pull/7040), [#6842](https://github.com/remix-run/remix/pull/6842)) ([#7040](https://github.com/remix-run/remix/pull/7040))
+
+### Patch Changes
+
+- Export proper `ErrorResponse` type for usage alongside `isRouteErrorResponse` ([#7244](https://github.com/remix-run/remix/pull/7244))
+- ensures fetch() return is instanceof global Response by removing extended classes for NodeRequest and NodeResponse in favor of custom interface type cast. ([#7109](https://github.com/remix-run/remix/pull/7109))
+- remove recursion from stream utilities ([#7245](https://github.com/remix-run/remix/pull/7245))
+- Updated dependencies:
+  - `@remix-run/server-runtime@2.0.0-pre.0`
+
 ## 1.19.3
 
 ### Patch Changes

package/dist/base64.js

@@ -1,5 +1,5 @@
 /**
- * @remix-run/node v1.19.3
+ * @remix-run/node v2.0.0-pre.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/crypto.js

@@ -1,5 +1,5 @@
 /**
- * @remix-run/node v1.19.3
+ * @remix-run/node v2.0.0-pre.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/fetch.d.ts

@@ -1,23 +1,25 @@
 /// <reference types="node" />
-import type { Readable } from "stream";
+import type { Readable } from "node:stream";
 import { fetch as webFetch, Headers as WebHeaders, Request as WebRequest, Response as WebResponse } from "@remix-run/web-fetch";
 export { FormData } from "@remix-run/web-fetch";
 export { File, Blob } from "@remix-run/web-file";
 type NodeHeadersInit = ConstructorParameters<typeof WebHeaders>[0];
+type NodeResponseInfo = ConstructorParameters<typeof WebResponse>[0];
 type NodeResponseInit = NonNullable<ConstructorParameters<typeof WebResponse>[1]>;
 type NodeRequestInfo = ConstructorParameters<typeof WebRequest>[0] | NodeRequest;
 type NodeRequestInit = Omit<NonNullable<ConstructorParameters<typeof WebRequest>[1]>, "body"> & {
     body?: NonNullable<ConstructorParameters<typeof WebRequest>[1]>["body"] | Readable;
 };
 export type { NodeHeadersInit as HeadersInit, NodeRequestInfo as RequestInfo, NodeRequestInit as RequestInit, NodeResponseInit as ResponseInit, };
-declare class NodeRequest extends WebRequest {
-    constructor(info: NodeRequestInfo, init?: NodeRequestInit);
+interface NodeRequest extends WebRequest {
     get headers(): WebHeaders;
     clone(): NodeRequest;
 }
-declare class NodeResponse extends WebResponse {
+interface NodeResponse extends WebResponse {
     get headers(): WebHeaders;
     clone(): NodeResponse;
 }
+declare const NodeRequest: new (info: NodeRequestInfo, init?: NodeRequestInit) => NodeRequest;
+declare const NodeResponse: new (info: NodeResponseInfo, init?: NodeResponseInit) => NodeResponse;
 export { WebHeaders as Headers, NodeRequest as Request, NodeResponse as Response, };
 export declare const fetch: typeof webFetch;

package/dist/fetch.js

@@ -1,5 +1,5 @@
 /**
- * @remix-run/node v1.19.3
+ * @remix-run/node v2.0.0-pre.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -15,25 +15,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var webFetch = require('@remix-run/web-fetch');
 var webFile = require('@remix-run/web-file');
 
-class NodeRequest extends webFetch.Request {
-  constructor(info, init) {
-    super(info, init);
-  }
-  get headers() {
-    return super.headers;
-  }
-  clone() {
-    return new NodeRequest(this);
-  }
-}
-class NodeResponse extends webFetch.Response {
-  get headers() {
-    return super.headers;
-  }
-  clone() {
-    return super.clone();
-  }
-}
+const NodeRequest = webFetch.Request;
+const NodeResponse = webFetch.Response;
 const fetch = (info, init) => {
   init = {
     // Disable compression handling so people can return the result of a fetch

package/dist/globals.d.ts

@@ -16,7 +16,6 @@ declare global {
             FormData: typeof FormData;
             ReadableStream: typeof ReadableStream;
             WritableStream: typeof WritableStream;
-            AbortController: typeof AbortController;
         }
     }
 }

package/dist/globals.js

@@ -1,5 +1,5 @@
 /**
- * @remix-run/node v1.19.3
+ * @remix-run/node v2.0.0-pre.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -13,7 +13,6 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var webStream = require('@remix-run/web-stream');
-var abortController = require('abort-controller');
 var base64 = require('./base64.js');
 var fetch = require('./fetch.js');
 var webFile = require('@remix-run/web-file');
@@ -31,7 +30,6 @@ function installGlobals() {
   global.FormData = webFetch.FormData;
   global.ReadableStream = webStream.ReadableStream;
   global.WritableStream = webStream.WritableStream;
-  global.AbortController = global.AbortController || abortController.AbortController;
 }
 
 exports.installGlobals = installGlobals;

package/dist/implementations.js

@@ -1,5 +1,5 @@
 /**
- * @remix-run/node v1.19.3
+ * @remix-run/node v2.0.0-pre.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-export { AbortController } from "abort-controller";
 export type { HeadersInit, RequestInfo, RequestInit, ResponseInit, } from "./fetch";
 export { fetch, FormData, Headers, Request, Response } from "./fetch";
 export { installGlobals } from "./globals";
@@ -6,5 +5,5 @@ export { createFileSessionStorage } from "./sessions/fileStorage";
 export { createFileUploadHandler as unstable_createFileUploadHandler, NodeOnDiskFile, } from "./upload/fileUploadHandler";
 export { createCookie, createCookieSessionStorage, createMemorySessionStorage, createSessionStorage, } from "./implementations";
 export { createReadableStreamFromReadable, readableStreamToString, writeAsyncIterableToWritable, writeReadableStreamToWritable, } from "./stream";
-export { createRequestHandler, createSession, defer, broadcastDevReady, logDevReady, isCookie, isSession, json, MaxPartSizeExceededError, redirect, unstable_composeUploadHandlers, unstable_createMemoryUploadHandler, unstable_parseMultipartFormData, } from "@remix-run/server-runtime";
-export type { ActionArgs, ActionFunction, AppData, AppLoadContext, Cookie, CookieOptions, CookieParseOptions, CookieSerializeOptions, CookieSignatureOptions, DataFunctionArgs, EntryContext, ErrorBoundaryComponent, HandleDataRequestFunction, HandleDocumentRequestFunction, HeadersArgs, HeadersFunction, HtmlLinkDescriptor, HtmlMetaDescriptor, JsonFunction, LinkDescriptor, LinksFunction, LoaderArgs, LoaderFunction, MemoryUploadHandlerFilterArgs, MemoryUploadHandlerOptions, MetaDescriptor, MetaFunction, HandleErrorFunction, PageLinkDescriptor, RequestHandler, RouteComponent, RouteHandle, SerializeFrom, ServerBuild, ServerEntryModule, V2_ServerRuntimeMetaArgs as V2_MetaArgs, V2_ServerRuntimeMetaDescriptor as V2_MetaDescriptor, V2_ServerRuntimeMetaDescriptor as V2_HtmlMetaDescriptor, V2_ServerRuntimeMetaFunction as V2_MetaFunction, Session, SessionData, SessionIdStorageStrategy, SessionStorage, SignFunction, TypedDeferredData, TypedResponse, UnsignFunction, UploadHandler, UploadHandlerPart, } from "@remix-run/server-runtime";
+export { createRequestHandler, createSession, defer, broadcastDevReady, logDevReady, isCookie, isSession, json, MaxPartSizeExceededError, redirect, redirectDocument, unstable_composeUploadHandlers, unstable_createMemoryUploadHandler, unstable_parseMultipartFormData, } from "@remix-run/server-runtime";
+export type { ActionArgs, ActionFunction, AppData, AppLoadContext, Cookie, CookieOptions, CookieParseOptions, CookieSerializeOptions, CookieSignatureOptions, DataFunctionArgs, EntryContext, ErrorResponse, HandleDataRequestFunction, HandleDocumentRequestFunction, HeadersArgs, HeadersFunction, HtmlLinkDescriptor, JsonFunction, LinkDescriptor, LinksFunction, LoaderArgs, LoaderFunction, MemoryUploadHandlerFilterArgs, MemoryUploadHandlerOptions, HandleErrorFunction, PageLinkDescriptor, RequestHandler, RouteHandle, SerializeFrom, ServerBuild, ServerEntryModule, ServerRuntimeMetaArgs as MetaArgs, ServerRuntimeMetaDescriptor as MetaDescriptor, ServerRuntimeMetaFunction as MetaFunction, Session, SessionData, SessionIdStorageStrategy, SessionStorage, SignFunction, TypedDeferredData, TypedResponse, UnsignFunction, UploadHandler, UploadHandlerPart, } from "@remix-run/server-runtime";

package/dist/index.js

@@ -1,5 +1,5 @@
 /**
- * @remix-run/node v1.19.3
+ * @remix-run/node v2.0.0-pre.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -12,8 +12,6 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var sourceMapSupport = require('source-map-support');
-var abortController = require('abort-controller');
 var fetch = require('./fetch.js');
 var globals = require('./globals.js');
 var fileStorage = require('./sessions/fileStorage.js');
@@ -23,16 +21,8 @@ var stream = require('./stream.js');
 var serverRuntime = require('@remix-run/server-runtime');
 var webFetch = require('@remix-run/web-fetch');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
-var sourceMapSupport__default = /*#__PURE__*/_interopDefaultLegacy(sourceMapSupport);
 
-sourceMapSupport__default["default"].install();
-
-Object.defineProperty(exports, 'AbortController', {
-  enumerable: true,
-  get: function () { return abortController.AbortController; }
-});
 exports.Request = fetch.Request;
 exports.Response = fetch.Response;
 exports.fetch = fetch.fetch;
@@ -88,6 +78,10 @@ Object.defineProperty(exports, 'redirect', {
   enumerable: true,
   get: function () { return serverRuntime.redirect; }
 });
+Object.defineProperty(exports, 'redirectDocument', {
+  enumerable: true,
+  get: function () { return serverRuntime.redirectDocument; }
+});
 Object.defineProperty(exports, 'unstable_composeUploadHandlers', {
   enumerable: true,
   get: function () { return serverRuntime.unstable_composeUploadHandlers; }

package/dist/sessions/fileStorage.d.ts

@@ -19,4 +19,5 @@ interface FileSessionStorageOptions {
  * @see https://remix.run/utils/sessions#createfilesessionstorage-node
  */
 export declare function createFileSessionStorage<Data = SessionData, FlashData = Data>({ cookie, dir, }: FileSessionStorageOptions): SessionStorage<Data, FlashData>;
+export declare function getFile(dir: string, id: string): string;
 export {};

package/dist/sessions/fileStorage.js

@@ -1,5 +1,5 @@
 /**
- * @remix-run/node v1.19.3
+ * @remix-run/node v2.0.0-pre.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -12,9 +12,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var crypto = require('crypto');
-var fs = require('fs');
-var path = require('path');
+var crypto = require('node:crypto');
+var node_fs = require('node:fs');
+var path = require('node:path');
 var implementations = require('../implementations.js');
 
 function _interopNamespace(e) {
@@ -58,8 +58,8 @@ function createFileSessionStorage({
         expires
       });
       while (true) {
-        // TODO: Once node v16 is available on AWS we should use the webcrypto
-        // API's crypto.getRandomValues() function here instead.
+        // TODO: Once Node v19 is supported we should use the globally provided
+        // Web Crypto API's crypto.getRandomValues() function here instead.
         let randomBytes = crypto__namespace.randomBytes(8);
         // This storage manages an id space of 2^64 ids, which is far greater
         // than the maximum number of files allowed on an NTFS or ext4 volume
@@ -68,10 +68,10 @@ function createFileSessionStorage({
         let id = Buffer.from(randomBytes).toString("hex");
         try {
           let file = getFile(dir, id);
-          await fs.promises.mkdir(path__namespace.dirname(file), {
+          await node_fs.promises.mkdir(path__namespace.dirname(file), {
             recursive: true
           });
-          await fs.promises.writeFile(file, content, {
+          await node_fs.promises.writeFile(file, content, {
             encoding: "utf-8",
             flag: "wx"
           });
@@ -84,7 +84,7 @@ function createFileSessionStorage({
     async readData(id) {
       try {
         let file = getFile(dir, id);
-        let content = JSON.parse(await fs.promises.readFile(file, "utf-8"));
+        let content = JSON.parse(await node_fs.promises.readFile(file, "utf-8"));
         let data = content.data;
         let expires = typeof content.expires === "string" ? new Date(content.expires) : null;
         if (!expires || expires > new Date()) {
@@ -92,7 +92,7 @@ function createFileSessionStorage({
         }
 
         // Remove expired session data.
-        if (expires) await fs.promises.unlink(file);
+        if (expires) await node_fs.promises.unlink(file);
         return null;
       } catch (error) {
         if (error.code !== "ENOENT") throw error;
@@ -105,10 +105,10 @@ function createFileSessionStorage({
         expires
       });
       let file = getFile(dir, id);
-      await fs.promises.mkdir(path__namespace.dirname(file), {
+      await node_fs.promises.mkdir(path__namespace.dirname(file), {
         recursive: true
       });
-      await fs.promises.writeFile(file, content, "utf-8");
+      await node_fs.promises.writeFile(file, content, "utf-8");
     },
     async deleteData(id) {
       // Return early if the id is empty, otherwise we'll end up trying to
@@ -117,7 +117,7 @@ function createFileSessionStorage({
         return;
       }
       try {
-        await fs.promises.unlink(getFile(dir, id));
+        await node_fs.promises.unlink(getFile(dir, id));
       } catch (error) {
         if (error.code !== "ENOENT") throw error;
       }
@@ -133,3 +133,4 @@ function getFile(dir, id) {
 }
 
 exports.createFileSessionStorage = createFileSessionStorage;
+exports.getFile = getFile;

package/dist/stream.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import type { Readable, Writable } from "stream";
+import type { Readable, Writable } from "node:stream";
 export declare function writeReadableStreamToWritable(stream: ReadableStream, writable: Writable): Promise<void>;
 export declare function writeAsyncIterableToWritable(iterable: AsyncIterable<Uint8Array>, writable: Writable): Promise<void>;
 export declare function readableStreamToString(stream: ReadableStream<Uint8Array>, encoding?: BufferEncoding): Promise<string>;

package/dist/stream.js

@@ -1,5 +1,5 @@
 /**
- * @remix-run/node v1.19.3
+ * @remix-run/node v2.0.0-pre.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -12,30 +12,26 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var stream = require('stream');
+var node_stream = require('node:stream');
 
 async function writeReadableStreamToWritable(stream, writable) {
   let reader = stream.getReader();
-  async function read() {
-    let {
-      done,
-      value
-    } = await reader.read();
-    if (done) {
-      writable.end();
-      return;
-    }
-    writable.write(value);
-
-    // If the stream is flushable, flush it to allow streaming to continue.
-    let flushable = writable;
-    if (typeof flushable.flush === "function") {
-      flushable.flush();
-    }
-    await read();
-  }
+  let flushable = writable;
   try {
-    await read();
+    while (true) {
+      let {
+        done,
+        value
+      } = await reader.read();
+      if (done) {
+        writable.end();
+        break;
+      }
+      writable.write(value);
+      if (typeof flushable.flush === "function") {
+        flushable.flush();
+      }
+    }
   } catch (error) {
     writable.destroy(error);
     throw error;
@@ -55,19 +51,18 @@ async function writeAsyncIterableToWritable(iterable, writable) {
 async function readableStreamToString(stream, encoding) {
   let reader = stream.getReader();
   let chunks = [];
-  async function read() {
+  while (true) {
     let {
       done,
       value
     } = await reader.read();
     if (done) {
-      return;
-    } else if (value) {
+      break;
+    }
+    if (value) {
       chunks.push(value);
     }
-    await read();
   }
-  await read();
   return Buffer.concat(chunks).toString(encoding);
 }
 const createReadableStreamFromReadable = source => {
@@ -76,10 +71,10 @@ const createReadableStreamFromReadable = source => {
   return stream;
 };
 class StreamPump {
-  constructor(stream$1) {
-    this.highWaterMark = stream$1.readableHighWaterMark || new stream.Stream.Readable().readableHighWaterMark;
+  constructor(stream) {
+    this.highWaterMark = stream.readableHighWaterMark || new node_stream.Stream.Readable().readableHighWaterMark;
     this.accumalatedSize = 0;
-    this.stream = stream$1;
+    this.stream = stream;
     this.enqueue = this.enqueue.bind(this);
     this.error = this.error.bind(this);
     this.close = this.close.bind(this);