chore: linting / typedoc

Author: dreamorosi

packages/event-handler/src/rest/converters.ts

@@ -29,9 +29,7 @@ const createBody = (body: string | null, isBase64Encoded: boolean) => {
  * @param event - The API Gateway proxy event
  * @returns A Web API Request object
  */
-export const proxyEventToWebRequest = (
-  event: APIGatewayProxyEvent
-): Request => {
+const proxyEventToWebRequest = (event: APIGatewayProxyEvent): Request => {
   const { httpMethod, path } = event;
   const { domainName } = event.requestContext;
 
@@ -79,7 +77,7 @@ export const proxyEventToWebRequest = (
  * @param response - The Web API Response object
  * @returns An API Gateway proxy result
  */
-export const webResponseToProxyResult = async (
+const webResponseToProxyResult = async (
   response: Response
 ): Promise<APIGatewayProxyResult> => {
   const headers: Record<string, string> = {};
@@ -136,10 +134,9 @@ export const webResponseToProxyResult = async (
  * Handles APIGatewayProxyResult, Response objects, and plain objects.
  *
  * @param response - The handler response (APIGatewayProxyResult, Response, or plain object)
- * @param headers - Optional headers to be included in the response
- * @returns A Web API Response object
+ * @param resHeaders - Optional headers to be included in the response
  */
-export const handlerResultToWebResponse = (
+const handlerResultToWebResponse = (
   response: HandlerResponse,
   resHeaders?: Headers
 ): Response => {
@@ -188,7 +185,7 @@ export const handlerResultToWebResponse = (
  * @param statusCode - The response status code to return
  * @returns An API Gateway proxy result
  */
-export const handlerResultToProxyResult = async (
+const handlerResultToProxyResult = async (
   response: HandlerResponse,
   statusCode: HttpStatusCode = HttpStatusCodes.OK
 ): Promise<APIGatewayProxyResult> => {
@@ -205,3 +202,10 @@ export const handlerResultToProxyResult = async (
     isBase64Encoded: false,
   };
 };
+
+export {
+  proxyEventToWebRequest,
+  webResponseToProxyResult,
+  handlerResultToWebResponse,
+  handlerResultToProxyResult,
+};

packages/event-handler/src/types/rest.ts

@@ -30,7 +30,7 @@ interface ErrorConstructor<T extends Error = Error> {
 }
 
 /**
- * Options for the {@link Router} class
+ * Options for the {@link Router | `Router``} class
  */
 type RestRouterOptions = {
   /**

packages/event-handler/typedoc.json

@@ -4,6 +4,7 @@
     "./src/appsync-events/index.ts",
     "./src/appsync-graphql/index.ts",
     "./src/bedrock-agent/index.ts",
+    "./src/rest/index.ts",
     "./src/types/index.ts"
   ],
   "readme": "README.md"

packages/idempotency/src/makeIdempotent.ts

@@ -51,7 +51,7 @@ const isOptionsWithDataIndexArgument = (
  *
  * By default, the entire first argument is hashed to create the idempotency key. You can customize this behavior:
  * - Use {@link IdempotencyConfig.eventKeyJmesPath | `eventKeyJmesPath`} to hash only a subset of the payload
- * - Use {@link ItempotentFunctionOptions.dataIndexArgument | `dataIndexArgument`} to hash a different function argument
+ * - Use {@link ItempotentFunctionOptions | `ItempotentFunctionOptions`}`.dataIndexArgument` to hash a different function argument
  *
  *
  * **Using a subset of the payload**

packages/idempotency/src/types/IdempotencyOptions.ts

@@ -10,8 +10,6 @@ import type { IdempotencyRecord } from '../persistence/IdempotencyRecord.js';
  *
  * When making a function idempotent you should always set a persistence store.
  *
- * @see {@link persistence/DynamoDBPersistenceLayer.DynamoDBPersistenceLayer | DynamoDBPersistenceLayer}
- *
  * Optionally, you can also pass a custom configuration object,
  * this allows you to customize the behavior of the idempotency utility.
  *