npm - @geostrategists/react-router-aws - Versions diffs - 2.2.1 → 2.3.0-rc.0 - Mend

@geostrategists/react-router-aws 2.2.1 → 2.3.0-rc.0

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.

Files changed (22) hide show

package/README.md +67 -0
package/dist/index.cjs +352 -0
package/dist/index.cjs.map +1 -0
package/dist/index.d.cts +661 -0
package/dist/index.d.mts +583 -24
package/dist/index.mjs +302 -305
package/dist/index.mjs.map +1 -0
package/package.json +43 -82
package/biome.json +0 -47
package/dist/index.d.ts +0 -102
package/dist/index.js +0 -378
package/test/alb.test.ts +0 -95
package/test/apigw-v1.test.ts +0 -101
package/test/apigw-v2.test.ts +0 -107
package/test/function-url-streaming.test.ts +0 -107
package/test/function-url.test.ts +0 -107
package/test/lambda-stream/HttpResponseStream.ts +0 -34
package/test/lambda-stream/ResponseStream.ts +0 -44
package/test/lambda-stream/index.ts +0 -56
package/test/setup.ts +0 -7
package/test/utils.ts +0 -69
package/vitest.config.ts +0 -12

package/test/function-url-streaming.test.ts DELETED Viewed

@@ -1,107 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { htmlResponse, invokeHandlerWithRRMock, redirectResponse } from "./utils";
-import type { LambdaFunctionURLEvent } from "aws-lambda";
-function lambdaFunctionUrlEvent(
-  path: string,
-  method = "GET",
-  headers: Record<string, string> = {},
-  cookies?: string[],
-): LambdaFunctionURLEvent {
-  return {
-    requestContext: { http: { method } } as LambdaFunctionURLEvent["requestContext"],
-    rawPath: path,
-    rawQueryString: "",
-    headers: {
-      host: "example.com",
-      "x-forwarded-proto": "https",
-      ...headers,
-    },
-    cookies,
-    body: undefined,
-    isBase64Encoded: false,
-  } as Partial<LambdaFunctionURLEvent> as LambdaFunctionURLEvent;
-}
-describe("Function URL streaming request handling", () => {
-  it("parses Function URL event", async () => {
-    await invokeHandlerWithRRMock(
-      "createFunctionURLStreamingRequestHandler",
-      (request) => {
-        expect(request.url).toBe("https://example.com/test");
-        expect(request.method).toBe("POST");
-        expect(request.headers.get("x-custom-header")).toBe("a");
-        return new Response("ok");
-      },
-      lambdaFunctionUrlEvent("/test", "POST", { "x-custom-header": "a" }),
-    );
-  });
-});
-describe("Function URL streaming response handling", () => {
-  it("html without cookie", async () => {
-    const res = await invokeHandlerWithRRMock(
-      "createFunctionURLStreamingRequestHandler",
-      () => htmlResponse(),
-      lambdaFunctionUrlEvent("/html"),
-    );
-    expect(res).toStrictEqual({
-      statusCode: 200,
-      headers: {
-        "content-type": "text/html",
-      },
-      body: "<html>ok</html>",
-      cookies: [],
-    });
-  });
-  it("html with cookie", async () => {
-    const res = await invokeHandlerWithRRMock(
-      "createFunctionURLStreamingRequestHandler",
-      () => htmlResponse("a=1; Path=/"),
-      lambdaFunctionUrlEvent("/html"),
-    );
-    expect(res).toStrictEqual({
-      statusCode: 200,
-      headers: {
-        "content-type": "text/html",
-      },
-      body: "<html>ok</html>",
-      cookies: ["a=1; Path=/"],
-    });
-  });
-  it("redirect without cookie", async () => {
-    const res = await invokeHandlerWithRRMock(
-      "createFunctionURLStreamingRequestHandler",
-      () => redirectResponse(),
-      lambdaFunctionUrlEvent("/redir"),
-    );
-    expect(res).toStrictEqual({
-      statusCode: 302,
-      headers: {
-        location: "https://example.com/next",
-      },
-      cookies: [],
-      // empty body gets added to provoke a write on the stream
-      body: "",
-    });
-  });
-  it("redirect with cookie", async () => {
-    const res = await invokeHandlerWithRRMock(
-      "createFunctionURLStreamingRequestHandler",
-      () => redirectResponse("b=2; Path=/"),
-      lambdaFunctionUrlEvent("/redir"),
-    );
-    expect(res).toStrictEqual({
-      statusCode: 302,
-      headers: {
-        location: "https://example.com/next",
-      },
-      cookies: ["b=2; Path=/"],
-      // empty body gets added to provoke a write on the stream
-      body: "",
-    });
-  });
-});

package/test/function-url.test.ts DELETED Viewed

@@ -1,107 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { htmlResponse, invokeHandlerWithRRMock, redirectResponse } from "./utils";
-import type { LambdaFunctionURLEvent } from "aws-lambda";
-function lambdaFunctionUrlEvent(
-  path: string,
-  method = "GET",
-  headers: Record<string, string> = {},
-  cookies?: string[],
-): LambdaFunctionURLEvent {
-  return {
-    requestContext: { http: { method } } as LambdaFunctionURLEvent["requestContext"],
-    rawPath: path,
-    rawQueryString: "",
-    headers: {
-      host: "example.com",
-      "x-forwarded-proto": "https",
-      ...headers,
-    },
-    cookies,
-    body: undefined,
-    isBase64Encoded: false,
-  } as Partial<LambdaFunctionURLEvent> as LambdaFunctionURLEvent;
-}
-describe("Function URL request handling", () => {
-  it("parses Function URL event", async () => {
-    await invokeHandlerWithRRMock(
-      "createFunctionURLRequestHandler",
-      (request) => {
-        expect(request.url).toBe("https://example.com/test");
-        expect(request.method).toBe("POST");
-        expect(request.headers.get("x-custom-header")).toBe("a");
-        return new Response("ok");
-      },
-      lambdaFunctionUrlEvent("/test", "POST", { "x-custom-header": "a" }),
-    );
-  });
-});
-describe("Function URL buffered response handling", () => {
-  it("html without cookie", async () => {
-    const res = await invokeHandlerWithRRMock(
-      "createFunctionURLRequestHandler",
-      () => htmlResponse(),
-      lambdaFunctionUrlEvent("/html"),
-    );
-    expect(res).toStrictEqual({
-      statusCode: 200,
-      headers: {
-        "content-type": "text/html",
-      },
-      body: "<html>ok</html>",
-      isBase64Encoded: false,
-      cookies: [],
-    });
-  });
-  it("html with cookie", async () => {
-    const res = await invokeHandlerWithRRMock(
-      "createFunctionURLRequestHandler",
-      () => htmlResponse("a=1; Path=/"),
-      lambdaFunctionUrlEvent("/html"),
-    );
-    expect(res).toStrictEqual({
-      statusCode: 200,
-      headers: {
-        "content-type": "text/html",
-      },
-      body: "<html>ok</html>",
-      isBase64Encoded: false,
-      cookies: ["a=1; Path=/"],
-    });
-  });
-  it("redirect without cookie", async () => {
-    const res = await invokeHandlerWithRRMock(
-      "createFunctionURLRequestHandler",
-      () => redirectResponse(),
-      lambdaFunctionUrlEvent("/redir"),
-    );
-    expect(res).toStrictEqual({
-      statusCode: 302,
-      headers: {
-        location: "https://example.com/next",
-      },
-      isBase64Encoded: false,
-      cookies: [],
-    });
-  });
-  it("redirect with cookie", async () => {
-    const res = await invokeHandlerWithRRMock(
-      "createFunctionURLRequestHandler",
-      () => redirectResponse("b=2; Path=/"),
-      lambdaFunctionUrlEvent("/redir"),
-    );
-    expect(res).toStrictEqual({
-      statusCode: 302,
-      headers: {
-        location: "https://example.com/next",
-      },
-      isBase64Encoded: false,
-      cookies: ["b=2; Path=/"],
-    });
-  });
-});

package/test/lambda-stream/HttpResponseStream.ts DELETED Viewed

@@ -1,34 +0,0 @@
-// biome-ignore-all lint: keep close to upstream
-/**
- * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * HttpResponseStream is NOT used by the runtime.
- * It is only exposed in the `awslambda` variable for customers to use.
- */
-// based on https://github.com/aws/aws-lambda-nodejs-runtime-interface-client/blob/main/src/HttpResponseStream.js
-// which is licensed under Apache License 2.0
-import type { ResponseStream } from "./ResponseStream";
-const METADATA_PRELUDE_CONTENT_TYPE = "application/vnd.awslambda.http-integration-response";
-const DELIMITER_LEN = 8;
-// Implements the application/vnd.awslambda.http-integration-response content type.
-export class HttpResponseStream {
-  static from(underlyingStream: ResponseStream, prelude: unknown) {
-    underlyingStream.setContentType(METADATA_PRELUDE_CONTENT_TYPE);
-    // JSON.stringify is required. NULL byte is not allowed in metadataPrelude.
-    const metadataPrelude = JSON.stringify(prelude);
-    underlyingStream._onBeforeFirstWrite = (write) => {
-      write(metadataPrelude);
-      // Write 8 null bytes after the JSON prelude.
-      write(new Uint8Array(DELIMITER_LEN));
-    };
-    return underlyingStream;
-  }
-}

package/test/lambda-stream/ResponseStream.ts DELETED Viewed

@@ -1,44 +0,0 @@
-import { Stream } from "node:stream";
-// based on https://github.com/astuyve/lambda-stream/blob/main/src/ResponseStream.ts
-// which is MIT licensed according to https://www.npmjs.com/package/lambda-stream
-export class ResponseStream extends Stream.Writable {
-  private response: Buffer[];
-  _contentType?: string;
-  _isBase64Encoded?: boolean;
-  _onBeforeFirstWrite?: (write: (chunk: string | Uint8Array) => void) => void;
-  _firstWriteHappened?: boolean = false;
-  constructor() {
-    super();
-    this.response = [];
-  }
-  write(chunk: any, encoding: any, callback?: any): boolean {
-    if (!this._firstWriteHappened) {
-      this._firstWriteHappened = true;
-      this._onBeforeFirstWrite?.(super.write.bind(this));
-    }
-    return super.write(chunk, encoding, callback);
-  }
-  // @param chunk Chunk of data to unshift onto the read queue. For streams not operating in object mode, `chunk` must be a string, `Buffer`, `Uint8Array` or `null`. For object mode
-  // streams, `chunk` may be any JavaScript value.
-  _write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void {
-    this.response.push(Buffer.from(chunk, encoding));
-    callback();
-  }
-  getBufferedData(): Buffer {
-    return Buffer.concat(this.response);
-  }
-  setContentType(contentType: string) {
-    this._contentType = contentType;
-  }
-  setIsBase64Encoded(isBase64Encoded: boolean) {
-    this._isBase64Encoded = isBase64Encoded;
-  }
-}

package/test/lambda-stream/index.ts DELETED Viewed

@@ -1,56 +0,0 @@
-// based on https://github.com/astuyve/lambda-stream/blob/main/src/index.ts
-// which is MIT licensed according to https://www.npmjs.com/package/lambda-stream
-import type { StreamifyHandler } from "aws-lambda";
-import { ResponseStream } from "./ResponseStream";
-import { HttpResponseStream } from "./HttpResponseStream";
-export function streamifyResponse<TEvent = any, TResult = void>(
-  handler: StreamifyHandler<TEvent, TResult>,
-): StreamifyHandler<TEvent, TResult> {
-  // Check for global awslambda
-  return new Proxy(handler, {
-    apply: async (target, _, argList: Parameters<StreamifyHandler<TEvent, TResult>>) => {
-      const responseStream: ResponseStream = patchArgs(argList);
-      await target(...argList);
-      const bodyAndPrelude = responseStream._isBase64Encoded
-        ? responseStream.getBufferedData().toString("base64")
-        : responseStream.getBufferedData().toString();
-      const delim = "\0".repeat(8);
-      const delimPos = bodyAndPrelude.indexOf(delim);
-      if (delimPos === -1) {
-        return {
-          statusCode: 200,
-          headers: {
-            "content-type": responseStream._contentType ?? "application/json",
-          },
-          cookies: [],
-          body: bodyAndPrelude,
-        };
-      } else {
-        const prelude = bodyAndPrelude.slice(0, delimPos);
-        const body = bodyAndPrelude.slice(delimPos + delim.length);
-        const parsedPrelude = JSON.parse(prelude);
-        return {
-          ...parsedPrelude,
-          body,
-        };
-      }
-    },
-  });
-}
-function patchArgs(argList: any[]): ResponseStream {
-  if (!(argList[1] instanceof ResponseStream)) {
-    const responseStream = new ResponseStream();
-    argList.splice(1, 0, responseStream);
-  }
-  return argList[1];
-}
-export const awslambda = {
-  HttpResponseStream: HttpResponseStream,
-  streamifyResponse: streamifyResponse,
-};

package/test/setup.ts DELETED Viewed

@@ -1,7 +0,0 @@
-import { vi } from "vitest";
-import { awslambda } from "./lambda-stream";
-vi.mock("react", () => ({}));
-vi.mock("react/jsx-runtime", () => ({}));
-vi.stubGlobal("awslambda", awslambda);

package/test/utils.ts DELETED Viewed

@@ -1,69 +0,0 @@
-import { vi } from "vitest";
-import type { Context, Handler } from "aws-lambda";
-import type { ServerBuild } from "react-router";
-let currentRRHandler: RRHandler | null = null;
-export function setReactRouterHandler(fn: RRHandler) {
-  currentRRHandler = fn;
-}
-vi.mock("react-router", () => {
-  return {
-    createRequestHandler: () => {
-      if (!currentRRHandler) throw new Error("React Router handler not set");
-      return currentRRHandler;
-    },
-  };
-});
-type ReactRouterAws = typeof import("../src");
-type GatewayHandlers = Pick<
-  ReactRouterAws,
-  | "createALBRequestHandler"
-  | "createAPIGatewayV1RequestHandler"
-  | "createAPIGatewayV2RequestHandler"
-  | "createFunctionURLRequestHandler"
-  | "createFunctionURLStreamingRequestHandler"
->;
-type RRHandler = (request: Request) => Response | Promise<Response>;
-export async function createHandlerWithRRMock<T extends keyof GatewayHandlers>(
-  gatewayHandler: T,
-  handler: RRHandler,
-): Promise<GatewayHandlers[T]> {
-  setReactRouterHandler(handler);
-  const handlerFactory = (await import("../src"))[gatewayHandler] as any;
-  return handlerFactory({ build: {} as unknown as ServerBuild });
-}
-export async function invokeHandlerWithRRMock<T extends keyof GatewayHandlers>(
-  gatewayHandler: T,
-  rrHandler: RRHandler,
-  event: Parameters<ReturnType<GatewayHandlers[T]>>[0],
-) {
-  const handler = await createHandlerWithRRMock(gatewayHandler, rrHandler);
-  return invokeHandler(handler as any, event);
-}
-export async function invokeHandler<E, R>(handler: Handler<E, R>, event: E): Promise<R> {
-  return (await handler(event, {} as unknown as Context, () => {
-    throw new Error("Callback not supported");
-  })) as R;
-}
-export function htmlResponse(setCookie?: string) {
-  const headers = new Headers({ "Content-Type": "text/html" });
-  if (setCookie) {
-    headers.append("Set-Cookie", setCookie);
-  }
-  return new Response("<html>ok</html>", { status: 200, headers });
-}
-export function redirectResponse(setCookie?: string) {
-  const headers = new Headers({ Location: "https://example.com/next" });
-  if (setCookie) {
-    headers.append("Set-Cookie", setCookie);
-  }
-  return new Response(null, { status: 302, headers });
-}

package/vitest.config.ts DELETED Viewed

@@ -1,12 +0,0 @@
-import { defineConfig } from "vitest/config";
-export default defineConfig({
-  test: {
-    environment: "node",
-    include: ["test/**/*.test.ts"],
-    setupFiles: ["./test/setup.ts"],
-    coverage: {
-      reporter: ["text", "lcov"],
-    },
-  },
-});