@opennextjs/aws 4.1.11 → 4.1.13

package/dist/build/helper.d.ts

@@ -66,7 +66,10 @@ export type { SemverOp } from "../utils/semver.js";
 export { compareSemver } from "../utils/semver.js";
 /**
  * Check if a Next.js version is supported by the Next.js team.
+ *
  * Major versions are supported for 2 years following their initial release.
+ * A major version is also considered supported as long as it is the Active or Maintenance LTS,
+ * that is until the second next major version is released (i.e. 15 is supported until 17 is released).
  *
  * @param version - The Next.js version to check (semver format)
  * @returns true if the version is currently supported, false otherwise

package/dist/build/helper.js

@@ -235,7 +235,10 @@ const NEXT_RELEASE_DATES = {
 };
 /**
  * Check if a Next.js version is supported by the Next.js team.
+ *
  * Major versions are supported for 2 years following their initial release.
+ * A major version is also considered supported as long as it is the Active or Maintenance LTS,
+ * that is until the second next major version is released (i.e. 15 is supported until 17 is released).
  *
  * @param version - The Next.js version to check (semver format)
  * @returns true if the version is currently supported, false otherwise
@@ -245,10 +248,14 @@ export function isNextVersionSupported(version) {
     if (!match) {
         return false;
     }
-    const releaseDateStr = NEXT_RELEASE_DATES[Number(match[0])];
+    const major = Number(match[0]);
+    const releaseDateStr = NEXT_RELEASE_DATES[major];
     if (!releaseDateStr) {
         return false;
     }
+    if (!NEXT_RELEASE_DATES[major + 2]) {
+        return true;
+    }
     const releaseDate = new Date(releaseDateStr);
     const supportEndDate = new Date(releaseDate);
     supportEndDate.setFullYear(supportEndDate.getFullYear() + 2);

package/dist/build/patch/testUtils.d.ts

@@ -0,0 +1,49 @@
+import { type CodePatcher } from "./codePatcher.js";
+/**
+ * A Next.js package installed on disk.
+ */
+export interface NextPackage {
+    /** Directory of the package, i.e. the directory of its `package.json`. */
+    dir: string;
+    /** Version of the package. */
+    version: string;
+}
+/**
+ * Compute the diff resulting of applying the `rule` to `src`.
+ *
+ * `diff` is an optional peer dependency of `@opennextjs/aws`: it must be installed to call this function.
+ *
+ * @param filename Filename used in the patch output
+ * @param src Content of the source code
+ * @param rule ASTgrep rule
+ * @returns diff in unified diff format
+ * @throws When the `diff` package is not installed
+ */
+export declare function computePatchDiff(filename: string, src: string, rule: string): string;
+/**
+ * Get the Next.js packages installed for some applications.
+ *
+ * Packages are deduplicated by version: a package manager can install the same version in multiple
+ * directories (i.e. pnpm when the peer dependencies differ).
+ *
+ * @param appDirs Directories of the applications (absolute or relative to the current working directory),
+ *                `next` is resolved from their `package.json`
+ * @returns the path and version of the Next.js packages
+ * @throws When `next` can not be resolved from one of the applications
+ */
+export declare function getInstalledNextPackages(appDirs: string[]): NextPackage[];
+/**
+ * Get the files of a Next.js package that a code patcher applies to.
+ *
+ * It selects the files the same way `applyCodePatches` does at build time,
+ * i.e. using the `versions`, the `pathFilter` and the `contentFilter` of the patches.
+ *
+ * @param next A Next.js package, see `getInstalledNextPackages`
+ * @param codePatcher The code patcher
+ * @returns the files (path relative to the package) with their content and the patches to apply
+ */
+export declare function getNextFilesToPatch(next: NextPackage, codePatcher: CodePatcher): {
+    name: string;
+    code: string;
+    patches: CodePatcher["patches"];
+}[];

package/dist/build/patch/testUtils.js

@@ -0,0 +1,78 @@
+/**
+ * Utilities to test code patches.
+ *
+ * They are used by the OpenNext adapters to test their patches against frozen snippets and against
+ * the files of the Next.js versions they are installed with.
+ * This module is not used at build time or at runtime.
+ */
+import { readFileSync, readdirSync } from "node:fs";
+import { createRequire } from "node:module";
+import path from "node:path";
+import { patchCode } from "./astCodePatcher.js";
+import { isVersionInRange } from "./codePatcher.js";
+const require = createRequire(import.meta.url);
+/**
+ * Compute the diff resulting of applying the `rule` to `src`.
+ *
+ * `diff` is an optional peer dependency of `@opennextjs/aws`: it must be installed to call this function.
+ *
+ * @param filename Filename used in the patch output
+ * @param src Content of the source code
+ * @param rule ASTgrep rule
+ * @returns diff in unified diff format
+ * @throws When the `diff` package is not installed
+ */
+export function computePatchDiff(filename, src, rule) {
+    // Loaded lazily so that the other utilities can be used without `diff`.
+    const { createPatch } = require("diff");
+    const dst = patchCode(src, rule);
+    return createPatch(filename, src, dst);
+}
+/**
+ * Get the Next.js packages installed for some applications.
+ *
+ * Packages are deduplicated by version: a package manager can install the same version in multiple
+ * directories (i.e. pnpm when the peer dependencies differ).
+ *
+ * @param appDirs Directories of the applications (absolute or relative to the current working directory),
+ *                `next` is resolved from their `package.json`
+ * @returns the path and version of the Next.js packages
+ * @throws When `next` can not be resolved from one of the applications
+ */
+export function getInstalledNextPackages(appDirs) {
+    const packages = new Map();
+    for (const appDir of appDirs) {
+        const appRequire = createRequire(path.join(path.resolve(appDir), "package.json"));
+        const dir = path.dirname(appRequire.resolve("next/package.json"));
+        const { version } = JSON.parse(readFileSync(path.join(dir, "package.json"), "utf-8"));
+        if (!packages.has(version)) {
+            packages.set(version, dir);
+        }
+    }
+    return [...packages].map(([version, dir]) => ({ dir, version }));
+}
+/**
+ * Get the files of a Next.js package that a code patcher applies to.
+ *
+ * It selects the files the same way `applyCodePatches` does at build time,
+ * i.e. using the `versions`, the `pathFilter` and the `contentFilter` of the patches.
+ *
+ * @param next A Next.js package, see `getInstalledNextPackages`
+ * @param codePatcher The code patcher
+ * @returns the files (path relative to the package) with their content and the patches to apply
+ */
+export function getNextFilesToPatch(next, codePatcher) {
+    const patches = codePatcher.patches.filter(({ versions }) => isVersionInRange(next.version, versions));
+    return readdirSync(next.dir, { recursive: true }).flatMap((name) => {
+        const filePath = path.join(next.dir, name);
+        const matchingPath = patches.filter(({ pathFilter }) => filePath.match(pathFilter));
+        if (matchingPath.length === 0) {
+            return [];
+        }
+        const code = readFileSync(filePath, "utf-8");
+        const matchingContent = matchingPath.filter(({ contentFilter }) => !contentFilter || code.match(contentFilter));
+        return matchingContent.length === 0
+            ? []
+            : [{ name, code, patches: matchingContent }];
+    });
+}

package/dist/index.js

@@ -1,29 +1,13 @@
 #!/usr/bin/env node
 import { build } from "./build.js";
+import { parseArgs } from "./utils/args.js";
 const command = process.argv[2];
 if (command !== "build")
     printHelp();
-const args = parseArgs();
-if (Object.keys(args).includes("--help"))
+const args = parseArgs(process.argv.slice(2));
+if (args.help)
     printHelp();
-await build(args["--config-path"], args["--node-externals"], args["--dangerously-use-unsupported-next-version"] !== undefined);
-function parseArgs() {
-    return process.argv.slice(2).reduce((acc, key, ind, self) => {
-        if (key.startsWith("--")) {
-            if (self[ind + 1] && self[ind + 1].startsWith("-")) {
-                acc[key] = undefined;
-            }
-            else if (self[ind + 1]) {
-                acc[key] = self[ind + 1];
-                // eslint-disable-next-line sonarjs/elseif-without-else
-            }
-            else if (!self[ind + 1]) {
-                acc[key] = undefined;
-            }
-        }
-        return acc;
-    }, {});
-}
+await build(args.configPath, args.nodeExternals, args.dangerouslyUseUnsupportedNextVersion);
 function printHelp() {
     console.log(`Unknown command
 
@@ -33,6 +17,8 @@ You can use a custom config path here
   npx open-next build --config-path ./path/to/open-next.config.ts
 You can configure externals for the esbuild compilation of the open-next.config.ts file
   npx open-next build --node-externals aws-sdk,sharp,sqlite3
+You can build with a Next.js version that is not supported by the Next.js team anymore
+  npx open-next build --dangerously-use-unsupported-next-version
 `);
     process.exit(1);
 }

package/dist/overrides/wrappers/aws-lambda-compressed.js

@@ -1,6 +1,7 @@
 import { Readable, Writable } from "node:stream";
 import zlib from "node:zlib";
 import { error } from "../../adapters/logger";
+import { getBrotliQuality } from "../../utils/compression";
 import { formatWarmerResponse } from "./aws-lambda";
 const handler = async (handler, converter) => async (event) => {
     // Handle warmer event
@@ -70,10 +71,7 @@ function compressBody(body, encoding) {
             case "br":
                 transform = zlib.createBrotliCompress({
                     params: {
-                        // This is a compromise between speed and compression ratio.
-                        // The default one will most likely timeout an AWS Lambda with default configuration on large bodies (>6mb).
-                        // Therefore we set it to 6, which is a good compromise.
-                        [zlib.constants.BROTLI_PARAM_QUALITY]: Number(process.env.BROTLI_QUALITY) ?? 6,
+                        [zlib.constants.BROTLI_PARAM_QUALITY]: getBrotliQuality(),
                     },
                 });
                 break;

package/dist/overrides/wrappers/aws-lambda-streaming.js

@@ -1,6 +1,7 @@
 import { Readable } from "node:stream";
 import zlib from "node:zlib";
 import { debug, error } from "../../adapters/logger";
+import { getBrotliQuality } from "../../utils/compression";
 import { DetachedPromiseRunner } from "../../utils/promise";
 function formatWarmerResponse(event) {
     const result = new Promise((resolve) => {
@@ -34,6 +35,9 @@ const handler = async (handler, converter) => awslambda.streamifyResponse(async
         compressedStream = zlib.createBrotliCompress({
             flush: zlib.constants.BROTLI_OPERATION_FLUSH,
             finishFlush: zlib.constants.BROTLI_OPERATION_FINISH,
+            params: {
+                [zlib.constants.BROTLI_PARAM_QUALITY]: getBrotliQuality(),
+            },
         });
         compressedStream.pipe(responseStream);
     }

package/dist/utils/args.d.ts

@@ -0,0 +1,20 @@
+export interface CliArgs {
+    /** Value of `--config-path` */
+    configPath?: string;
+    /** Value of `--node-externals` */
+    nodeExternals?: string;
+    /** Whether `--help` is present */
+    help: boolean;
+    /** Whether `--dangerously-use-unsupported-next-version` is present */
+    dangerouslyUseUnsupportedNextVersion: boolean;
+}
+/**
+ * Parses the command line arguments of the `open-next` CLI.
+ *
+ * Boolean flags (i.e. `--help`) are `true` when present and never consume the following argument.
+ * Other flags take the following argument as their value unless it starts with `-`.
+ *
+ * @param argv - The CLI arguments, without the node executable and script path (i.e. `process.argv.slice(2)`)
+ * @returns The parsed arguments
+ */
+export declare function parseArgs(argv: string[]): CliArgs;

package/dist/utils/args.js

@@ -0,0 +1,44 @@
+/**
+ * Flags that do not take a value. They are `true` when present and never consume the next argument.
+ */
+const BOOLEAN_FLAGS = new Set([
+    "--help",
+    "--dangerously-use-unsupported-next-version",
+]);
+/**
+ * Parses the command line arguments of the `open-next` CLI.
+ *
+ * Boolean flags (i.e. `--help`) are `true` when present and never consume the following argument.
+ * Other flags take the following argument as their value unless it starts with `-`.
+ *
+ * @param argv - The CLI arguments, without the node executable and script path (i.e. `process.argv.slice(2)`)
+ * @returns The parsed arguments
+ */
+export function parseArgs(argv) {
+    const flags = new Set();
+    const values = {};
+    for (let i = 0; i < argv.length; i++) {
+        const key = argv[i];
+        if (!key.startsWith("--")) {
+            continue;
+        }
+        if (BOOLEAN_FLAGS.has(key)) {
+            flags.add(key);
+            continue;
+        }
+        const next = argv[i + 1];
+        if (next && !next.startsWith("-")) {
+            values[key] = next;
+            i++;
+        }
+        else {
+            values[key] = undefined;
+        }
+    }
+    return {
+        configPath: values["--config-path"],
+        nodeExternals: values["--node-externals"],
+        help: flags.has("--help"),
+        dangerouslyUseUnsupportedNextVersion: flags.has("--dangerously-use-unsupported-next-version"),
+    };
+}

package/dist/utils/compression.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Brotli quality used by the compressing wrappers.
+ *
+ * It can be set with the `BROTLI_QUALITY` environment variable (0 to 11) and defaults to 6.
+ * Quality 10 and 11 cost an order of magnitude more CPU than 6 for a few percent smaller output,
+ * which delays every streamed response.
+ */
+export declare function getBrotliQuality(): number;

package/dist/utils/compression.js

@@ -0,0 +1,16 @@
+import zlib from "node:zlib";
+const DEFAULT_BROTLI_QUALITY = 6;
+/**
+ * Brotli quality used by the compressing wrappers.
+ *
+ * It can be set with the `BROTLI_QUALITY` environment variable (0 to 11) and defaults to 6.
+ * Quality 10 and 11 cost an order of magnitude more CPU than 6 for a few percent smaller output,
+ * which delays every streamed response.
+ */
+export function getBrotliQuality() {
+    const quality = Number.parseInt(process.env.BROTLI_QUALITY ?? "", 10);
+    return quality >= zlib.constants.BROTLI_MIN_QUALITY &&
+        quality <= zlib.constants.BROTLI_MAX_QUALITY
+        ? quality
+        : DEFAULT_BROTLI_QUALITY;
+}

package/package.json

@@ -3,7 +3,7 @@
     "access": "public"
   },
   "name": "@opennextjs/aws",
-  "version": "4.1.11",
+  "version": "4.1.13",
   "bin": {
     "open-next": "./dist/index.js"
   },
@@ -56,13 +56,20 @@
     "@types/express": "5.0.6",
     "@types/node": "20.17.6",
     "concurrently": "^9.2.4",
+    "diff": "^9.0.0",
     "next": "16.4.1",
     "tsc-alias": "^1.9.7",
     "typescript": "5.9.3"
   },
   "peerDependencies": {
+    "diff": "^9.0.0",
     "next": ">=15.5.28 <16 || >=16.4.1"
   },
+  "peerDependenciesMeta": {
+    "diff": {
+      "optional": true
+    }
+  },
   "bugs": {
     "url": "https://github.com/opennextjs/opennextjs-aws/issues"
   },