@opennextjs/aws 3.3.0 → 3.4.0

package/dist/overrides/wrappers/express-dev.js

@@ -0,0 +1,43 @@
+import express from "express";
+const wrapper = async (handler, converter) => {
+    const app = express();
+    // To serve static assets
+    app.use(express.static("../../assets"));
+    const imageHandlerPath = "../../image-optimization-function/index.mjs";
+    const imageHandler = await import(imageHandlerPath).then((m) => m.handler);
+    app.all("/_next/image", async (req, res) => {
+        const internalEvent = await converter.convertFrom(req);
+        const _res = {
+            writeHeaders: (prelude) => {
+                res.writeHead(prelude.statusCode, prelude.headers);
+                return res;
+            },
+        };
+        await imageHandler(internalEvent, _res);
+    });
+    app.all("*paths", async (req, res) => {
+        const internalEvent = await converter.convertFrom(req);
+        const _res = {
+            writeHeaders: (prelude) => {
+                res.writeHead(prelude.statusCode, prelude.headers);
+                return res;
+            },
+            onFinish: () => { },
+        };
+        await handler(internalEvent, _res);
+    });
+    const server = app.listen(Number.parseInt(process.env.PORT ?? "3000", 10), () => {
+        console.log(`Server running on port ${process.env.PORT ?? 3000}`);
+    });
+    app.on("error", (err) => {
+        console.error("error", err);
+    });
+    return () => {
+        server.close();
+    };
+};
+export default {
+    wrapper,
+    name: "expresss-dev",
+    supportStreaming: true,
+};

package/dist/plugins/edge.js

@@ -1,8 +1,9 @@
 import { readFileSync } from "node:fs";
 import path from "node:path";
 import chalk from "chalk";
-import { loadAppPathsManifestKeys, loadBuildId, loadConfig, loadConfigHeaders, loadHtmlPages, loadMiddlewareManifest, loadPrerenderManifest, loadRoutesManifest, } from "../adapters/config/util.js";
+import { loadAppPathRoutesManifest, loadAppPathsManifest, loadAppPathsManifestKeys, loadBuildId, loadConfig, loadConfigHeaders, loadHtmlPages, loadMiddlewareManifest, loadPrerenderManifest, loadRoutesManifest, } from "../adapters/config/util.js";
 import logger from "../logger.js";
+import { getCrossPlatformPathRegex } from "../utils/regex.js";
 /**
  * @param opts.nextDir - The path to the .next directory
  * @param opts.edgeFunctionHandlerPath - The path to the edgeFunctionHandler.js file that we'll use to bundle the routing
@@ -28,7 +29,7 @@ export function openNextEdgePlugins({ nextDir, edgeFunctionHandlerPath, middlewa
             logger.debug(chalk.blue("OpenNext Edge plugin"));
             if (edgeFunctionHandlerPath) {
                 // If we bundle the routing, we need to resolve the middleware
-                build.onResolve({ filter: /\.\/middleware.mjs/g }, () => {
+                build.onResolve({ filter: getCrossPlatformPathRegex("./middleware.mjs") }, () => {
                     return {
                         path: edgeFunctionHandlerPath,
                     };
@@ -55,7 +56,7 @@ export function openNextEdgePlugins({ nextDir, edgeFunctionHandlerPath, middlewa
                 loader: "js",
             }));
             // We inject the entry files into the edgeFunctionHandler
-            build.onLoad({ filter: /\/edgeFunctionHandler.js/g }, async (args) => {
+            build.onLoad({ filter: getCrossPlatformPathRegex("/edgeFunctionHandler.js") }, async (args) => {
                 let contents = readFileSync(args.path, "utf-8");
                 contents = `
 globalThis._ENTRIES = {};
@@ -117,7 +118,7 @@ ${contents}
                     contents,
                 };
             });
-            build.onLoad({ filter: /adapters\/config\/index/g }, async () => {
+            build.onLoad({ filter: getCrossPlatformPathRegex("adapters/config/index") }, async () => {
                 const NextConfig = loadConfig(nextDir);
                 const BuildId = loadBuildId(nextDir);
                 const HtmlPages = loadHtmlPages(nextDir);
@@ -126,6 +127,8 @@ ${contents}
                 const PrerenderManifest = loadPrerenderManifest(nextDir);
                 const AppPathsManifestKeys = loadAppPathsManifestKeys(nextDir);
                 const MiddlewareManifest = loadMiddlewareManifest(nextDir);
+                const AppPathsManifest = loadAppPathsManifest(nextDir);
+                const AppPathRoutesManifest = loadAppPathRoutesManifest(nextDir);
                 const contents = `
   import path from "node:path";
 
@@ -146,6 +149,9 @@ ${contents}
   export const PrerenderManifest = ${JSON.stringify(PrerenderManifest)};
   export const AppPathsManifestKeys = ${JSON.stringify(AppPathsManifestKeys)};
   export const MiddlewareManifest = ${JSON.stringify(MiddlewareManifest)};
+  export const AppPathsManifest = ${JSON.stringify(AppPathsManifest)};
+  export const AppPathRoutesManifest = ${JSON.stringify(AppPathRoutesManifest)};
+
 
   process.env.NEXT_BUILD_ID = BuildId;
 `;

package/dist/plugins/replacement.d.ts

@@ -8,7 +8,7 @@ export interface IPluginSettings {
 /**
  *
  * openNextPlugin({
- *   target: /plugins\/default\.js/g,
+ *   target: /plugins(\/|\\)default\.js/g,
  *   replacements: [require.resolve("./plugins/default.js")],
  *   deletes: ["id1"],
  * })

package/dist/plugins/replacement.js

@@ -6,7 +6,7 @@ const importPattern = /\/\/#import([\s\S]*?)\n\/\/#endImport/gm;
 /**
  *
  * openNextPlugin({
- *   target: /plugins\/default\.js/g,
+ *   target: /plugins(\/|\\)default\.js/g,
  *   replacements: [require.resolve("./plugins/default.js")],
  *   deletes: ["id1"],
  * })

package/dist/plugins/resolve.d.ts

@@ -12,6 +12,7 @@ export interface IPluginSettings {
         originResolver?: LazyLoadedOverride<OriginResolver> | IncludedOriginResolver;
         warmer?: LazyLoadedOverride<Warmer> | IncludedWarmer;
         proxyExternalRequest?: OverrideOptions["proxyExternalRequest"];
+        cdnInvalidation?: OverrideOptions["cdnInvalidation"];
     };
     fnName?: string;
 }

package/dist/plugins/resolve.js

@@ -1,6 +1,7 @@
 import { readFileSync } from "node:fs";
 import chalk from "chalk";
 import logger from "../logger.js";
+import { getCrossPlatformPathRegex } from "../utils/regex.js";
 function getOverrideOrDummy(override) {
     if (typeof override === "string") {
         return override;
@@ -19,6 +20,7 @@ const nameToFolder = {
     originResolver: "originResolver",
     warmer: "warmer",
     proxyExternalRequest: "proxyExternalRequest",
+    cdnInvalidation: "cdnInvalidation",
 };
 const defaultOverrides = {
     wrapper: "aws-lambda",
@@ -30,6 +32,7 @@ const defaultOverrides = {
     originResolver: "pattern-env",
     warmer: "aws-lambda",
     proxyExternalRequest: "node",
+    cdnInvalidation: "dummy",
 };
 /**
  * @param opts.overrides - The name of the overrides to use
@@ -40,7 +43,7 @@ export function openNextResolvePlugin({ overrides, fnName, }) {
         name: "opennext-resolve",
         setup(build) {
             logger.debug(chalk.blue("OpenNext Resolve plugin"), fnName ? `for ${fnName}` : "");
-            build.onLoad({ filter: /core(\/|\\)resolve\.js/g }, async (args) => {
+            build.onLoad({ filter: getCrossPlatformPathRegex("core/resolve.js") }, async (args) => {
                 let contents = readFileSync(args.path, "utf-8");
                 const overridesEntries = Object.entries(overrides ?? {});
                 for (let [overrideName, overrideValue] of overridesEntries) {

package/dist/types/global.d.ts

@@ -1,6 +1,6 @@
 import type { AsyncLocalStorage } from "node:async_hooks";
 import type { OutgoingHttpHeaders } from "node:http";
-import type { IncrementalCache, ProxyExternalRequest, Queue, TagCache } from "./overrides";
+import type { CDNInvalidationHandler, IncrementalCache, ProxyExternalRequest, Queue, TagCache } from "./overrides";
 import type { DetachedPromiseRunner } from "../utils/promise";
 import type { OpenNextConfig } from "./open-next";
 export interface RequestData {
@@ -184,5 +184,11 @@ declare global {
      * Defined in `createMainHandler`.
      */
     var proxyExternalRequest: ProxyExternalRequest;
+    /**
+     * The function that will be called when the CDN needs invalidating (either from `revalidateTag` or from `res.revalidate`)
+     * Available in main functions
+     * Defined in `createMainHandler`
+     */
+    var cdnInvalidationHandler: CDNInvalidationHandler;
 }
 export {};

package/dist/types/open-next.d.ts

@@ -1,7 +1,7 @@
 import type { ReadableStream } from "node:stream/web";
 import type { Writable } from "node:stream";
 import type { WarmerEvent, WarmerResponse } from "../adapters/warmer-function";
-import type { Converter, ImageLoader, IncrementalCache, OriginResolver, ProxyExternalRequest, Queue, TagCache, Warmer, Wrapper } from "./overrides";
+import type { CDNInvalidationHandler, Converter, ImageLoader, IncrementalCache, OriginResolver, ProxyExternalRequest, Queue, TagCache, Warmer, Wrapper } from "./overrides";
 export type BaseEventOrResult<T extends string = string> = {
     type: T;
 };
@@ -66,23 +66,31 @@ export interface Origin {
     port?: number;
     customHeaders?: Record<string, string>;
 }
-export type IncludedWrapper = "aws-lambda" | "aws-lambda-streaming" | "node" | "cloudflare" | "cloudflare-edge" | "cloudflare-node" | "dummy";
+export type IncludedWrapper = "aws-lambda" | "aws-lambda-streaming" | "node" | "cloudflare" | "cloudflare-edge" | "cloudflare-node" | "express-dev" | "dummy";
 export type IncludedConverter = "aws-apigw-v2" | "aws-apigw-v1" | "aws-cloudfront" | "edge" | "node" | "sqs-revalidate" | "dummy";
+export type RouteType = "route" | "page" | "app";
+export interface ResolvedRoute {
+    route: string;
+    type: RouteType;
+}
 export interface RoutingResult {
     internalEvent: InternalEvent;
     isExternalRewrite: boolean;
     origin: Origin | false;
     isISR: boolean;
+    initialPath: string;
+    resolvedRoutes: ResolvedRoute[];
 }
 export interface MiddlewareResult extends RoutingResult, BaseEventOrResult<"middleware"> {
 }
-export type IncludedQueue = "sqs" | "sqs-lite" | "dummy";
-export type IncludedIncrementalCache = "s3" | "s3-lite" | "dummy";
-export type IncludedTagCache = "dynamodb" | "dynamodb-lite" | "dummy";
-export type IncludedImageLoader = "s3" | "host" | "dummy";
+export type IncludedQueue = "sqs" | "sqs-lite" | "direct" | "dummy";
+export type IncludedIncrementalCache = "s3" | "s3-lite" | "multi-tier-ddb-s3" | "fs-dev" | "dummy";
+export type IncludedTagCache = "dynamodb" | "dynamodb-lite" | "fs-dev" | "dummy";
+export type IncludedImageLoader = "s3" | "host" | "fs-dev" | "dummy";
 export type IncludedOriginResolver = "pattern-env" | "dummy";
 export type IncludedWarmer = "aws-lambda" | "dummy";
 export type IncludedProxyExternalRequest = "node" | "fetch" | "dummy";
+export type IncludedCDNInvalidationHandler = "cloudfront" | "dummy";
 export interface DefaultOverrideOptions<E extends BaseEventOrResult = InternalEvent, R extends BaseEventOrResult = InternalResult> {
     /**
      * This is the main entrypoint of your app.
@@ -122,6 +130,11 @@ export interface OverrideOptions extends DefaultOverrideOptions {
      * @default "node"
      */
     proxyExternalRequest?: IncludedProxyExternalRequest | LazyLoadedOverride<ProxyExternalRequest>;
+    /**
+     * Add possibility to override the default cdn invalidation for On Demand Revalidation
+     * @default "dummy"
+     */
+    cdnInvalidation?: IncludedCDNInvalidationHandler | LazyLoadedOverride<CDNInvalidationHandler>;
 }
 export interface InstallOptions {
     /**

package/dist/types/overrides.d.ts

@@ -1,6 +1,6 @@
 import type { Readable } from "node:stream";
 import type { Meta } from "./cache";
-import type { BaseEventOrResult, BaseOverride, InternalEvent, InternalResult, Origin, StreamCreator } from "./open-next";
+import type { BaseEventOrResult, BaseOverride, InternalEvent, InternalResult, Origin, ResolvedRoute, StreamCreator } from "./open-next";
 export interface QueueMessage {
     MessageDeduplicationId: string;
     MessageBody: {
@@ -13,7 +13,7 @@ export interface Queue {
     send(message: QueueMessage): Promise<void>;
     name: string;
 }
-export type S3CachedFile = {
+export type CachedFile = {
     type: "redirect";
     props?: Object;
     meta?: Meta;
@@ -32,12 +32,12 @@ export type S3CachedFile = {
     body: string;
     meta?: Meta;
 };
-export type S3FetchCache = Object;
+export type FetchCache = Object;
 export type WithLastModified<T> = {
     lastModified?: number;
     value?: T;
 };
-export type CacheValue<IsFetch extends boolean> = (IsFetch extends true ? S3FetchCache : S3CachedFile) & {
+export type CacheValue<IsFetch extends boolean> = (IsFetch extends true ? FetchCache : CachedFile) & {
     revalidate?: number | false;
 };
 export type IncrementalCache = {
@@ -84,3 +84,12 @@ export type OriginResolver = BaseOverride & {
 export type ProxyExternalRequest = BaseOverride & {
     proxy: (event: InternalEvent) => Promise<InternalResult>;
 };
+type CDNPath = {
+    initialPath: string;
+    rawPath: string;
+    resolvedRoutes: ResolvedRoute[];
+};
+export type CDNInvalidationHandler = BaseOverride & {
+    invalidatePaths: (paths: CDNPath[]) => Promise<void>;
+};
+export {};

package/dist/utils/lru.d.ts

@@ -0,0 +1,8 @@
+export declare class LRUCache<T> {
+    private maxSize;
+    private cache;
+    constructor(maxSize: number);
+    get(key: string): T | undefined;
+    set(key: string, value: any): void;
+    delete(key: string): void;
+}

package/dist/utils/lru.js

@@ -0,0 +1,29 @@
+export class LRUCache {
+    maxSize;
+    cache = new Map();
+    constructor(maxSize) {
+        this.maxSize = maxSize;
+    }
+    get(key) {
+        const result = this.cache.get(key);
+        // We could have used .has to allow for nullish value to be stored but we don't need that right now
+        if (result) {
+            // By removing and setting the key again we ensure it's the most recently used
+            this.cache.delete(key);
+            this.cache.set(key, result);
+        }
+        return result;
+    }
+    set(key, value) {
+        if (this.cache.size >= this.maxSize) {
+            const firstKey = this.cache.keys().next().value;
+            if (firstKey !== undefined) {
+                this.cache.delete(firstKey);
+            }
+        }
+        this.cache.set(key, value);
+    }
+    delete(key) {
+        this.cache.delete(key);
+    }
+}

package/dist/utils/regex.d.ts

@@ -0,0 +1,18 @@
+type Options = {
+    escape?: boolean;
+    flags?: string;
+};
+/**
+ * Constructs a regular expression for a path that supports separators for multiple platforms
+ *  - Uses posix separators (`/`) as the input that should be made cross-platform.
+ *  - Special characters are escaped by default but can be controlled through opts.escape.
+ *  - Posix separators are always escaped.
+ *
+ * @example
+ * ```ts
+ * getCrossPlatformPathRegex("./middleware.mjs")
+ * getCrossPlatformPathRegex(String.raw`\./middleware\.(mjs|cjs)`, { escape: false })
+ * ```
+ */
+export declare function getCrossPlatformPathRegex(regex: string, { escape: shouldEscape, flags }?: Options): RegExp;
+export {};

package/dist/utils/regex.js

@@ -0,0 +1,16 @@
+/**
+ * Constructs a regular expression for a path that supports separators for multiple platforms
+ *  - Uses posix separators (`/`) as the input that should be made cross-platform.
+ *  - Special characters are escaped by default but can be controlled through opts.escape.
+ *  - Posix separators are always escaped.
+ *
+ * @example
+ * ```ts
+ * getCrossPlatformPathRegex("./middleware.mjs")
+ * getCrossPlatformPathRegex(String.raw`\./middleware\.(mjs|cjs)`, { escape: false })
+ * ```
+ */
+export function getCrossPlatformPathRegex(regex, { escape: shouldEscape = true, flags = "g" } = {}) {
+    const newExpr = (shouldEscape ? regex.replace(/([[\]().*+?^$|{}\\])/g, "\\$1") : regex).replaceAll("/", String.raw `(?:\/|\\)`);
+    return new RegExp(newExpr, flags);
+}

package/package.json

@@ -3,7 +3,7 @@
     "access": "public"
   },
   "name": "@opennextjs/aws",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "bin": {
     "open-next": "./dist/index.js"
   },
@@ -30,6 +30,7 @@
     "README.md"
   ],
   "dependencies": {
+    "@aws-sdk/client-cloudfront": "3.398.0",
     "@aws-sdk/client-dynamodb": "^3.398.0",
     "@aws-sdk/client-lambda": "^3.398.0",
     "@aws-sdk/client-s3": "^3.398.0",
@@ -41,12 +42,14 @@
     "aws4fetch": "^1.0.18",
     "chalk": "^5.3.0",
     "esbuild": "0.19.2",
+    "express": "5.0.1",
     "path-to-regexp": "^6.3.0",
     "promise.series": "^0.2.0",
     "urlpattern-polyfill": "^10.0.0"
   },
   "devDependencies": {
     "@types/aws-lambda": "^8.10.109",
+    "@types/express": "5.0.0",
     "@types/node": "20.17.6",
     "tsc-alias": "^1.8.8",
     "typescript": "5.6.3"