@leanstacks/lambda-utils 0.1.0 → 0.2.0-alpha.3

package/dist/index.d.ts

@@ -1 +1,2 @@
 export { Logger, LoggerConfig, withRequestTracking } from './logging/logger';
+export { createResponse, ok, created, noContent, badRequest, notFound, internalServerError, httpHeaders, Headers, } from './utils/apigateway-response';

package/dist/index.esm.js

@@ -1,2 +1,2 @@
-import e from"pino";import{lambdaRequestTracker as n,StructuredLogFormatter as t,CloudwatchLogFormatter as o,pinoLambdaDestination as i}from"pino-lambda";const l=n();class r{constructor(n){this._loggerConfig={enabled:!0,level:"info",format:"json"},this._instance=null,this._createLogger=()=>{const n="json"===this._loggerConfig.format?new t:new o,l=i({formatter:n});return e({enabled:this._loggerConfig.enabled,level:this._loggerConfig.level},l)},n&&(this._loggerConfig={enabled:n.enabled??!0,level:n.level??"info",format:n.format??"json"})}get instance(){return null===this._instance&&(this._instance=this._createLogger()),this._instance}}export{r as Logger,l as withRequestTracking};
+import e from"pino";import{lambdaRequestTracker as n,StructuredLogFormatter as o,CloudwatchLogFormatter as t,pinoLambdaDestination as s}from"pino-lambda";const r=n();class i{constructor(n){this._loggerConfig={enabled:!0,level:"info",format:"json"},this._instance=null,this._createLogger=()=>{const n="json"===this._loggerConfig.format?new o:new t,r=s({formatter:n});return e({enabled:this._loggerConfig.enabled,level:this._loggerConfig.level},r)},n&&(this._loggerConfig={enabled:n.enabled??!0,level:n.level??"info",format:n.format??"json"})}get instance(){return null===this._instance&&(this._instance=this._createLogger()),this._instance}}const l={contentType:e=>({"Content-Type":e}),json:{"Content-Type":"application/json"},cors:(e="*")=>({"Access-Control-Allow-Origin":e})},a=(e,n,o={})=>({statusCode:e,headers:{...o},body:JSON.stringify(n)}),g=(e,n={})=>a(200,e,n),c=(e,n={})=>a(201,e,n),f=(e={})=>a(204,{},e),m=(e="Bad Request",n={})=>a(400,{message:e},n),h=(e="Not Found",n={})=>a(404,{message:e},n),d=(e="Internal Server Error",n={})=>a(500,{message:e},n);export{i as Logger,m as badRequest,a as createResponse,c as created,l as httpHeaders,d as internalServerError,f as noContent,h as notFound,g as ok,r as withRequestTracking};
 //# sourceMappingURL=index.esm.js.map

package/dist/index.js

@@ -1,2 +1,2 @@
-"use strict";var e=require("pino"),t=require("pino-lambda");const n=t.lambdaRequestTracker();exports.Logger=class{constructor(n){this._loggerConfig={enabled:!0,level:"info",format:"json"},this._instance=null,this._createLogger=()=>{const n="json"===this._loggerConfig.format?new t.StructuredLogFormatter:new t.CloudwatchLogFormatter,r=t.pinoLambdaDestination({formatter:n});return e({enabled:this._loggerConfig.enabled,level:this._loggerConfig.level},r)},n&&(this._loggerConfig={enabled:n.enabled??!0,level:n.level??"info",format:n.format??"json"})}get instance(){return null===this._instance&&(this._instance=this._createLogger()),this._instance}},exports.withRequestTracking=n;
+"use strict";var e=require("pino"),t=require("pino-lambda");const o=t.lambdaRequestTracker();const r=(e,t,o={})=>({statusCode:e,headers:{...o},body:JSON.stringify(t)});exports.Logger=class{constructor(o){this._loggerConfig={enabled:!0,level:"info",format:"json"},this._instance=null,this._createLogger=()=>{const o="json"===this._loggerConfig.format?new t.StructuredLogFormatter:new t.CloudwatchLogFormatter,r=t.pinoLambdaDestination({formatter:o});return e({enabled:this._loggerConfig.enabled,level:this._loggerConfig.level},r)},o&&(this._loggerConfig={enabled:o.enabled??!0,level:o.level??"info",format:o.format??"json"})}get instance(){return null===this._instance&&(this._instance=this._createLogger()),this._instance}},exports.badRequest=(e="Bad Request",t={})=>r(400,{message:e},t),exports.createResponse=r,exports.created=(e,t={})=>r(201,e,t),exports.httpHeaders={contentType:e=>({"Content-Type":e}),json:{"Content-Type":"application/json"},cors:(e="*")=>({"Access-Control-Allow-Origin":e})},exports.internalServerError=(e="Internal Server Error",t={})=>r(500,{message:e},t),exports.noContent=(e={})=>r(204,{},e),exports.notFound=(e="Not Found",t={})=>r(404,{message:e},t),exports.ok=(e,t={})=>r(200,e,t),exports.withRequestTracking=o;
 //# sourceMappingURL=index.js.map

package/dist/utils/apigateway-response.d.ts

@@ -0,0 +1,100 @@
+import { APIGatewayProxyResult } from 'aws-lambda';
+/**
+ * Represents the headers for an API Gateway response
+ */
+export type Headers = Record<string, string | number | boolean>;
+/**
+ * Commonly used headers for API Gateway responses
+ */
+export declare const httpHeaders: {
+    /** Content-Type: <type> */
+    contentType: (type: string) => {
+        'Content-Type': string;
+    };
+    /** Content-Type: application/json */
+    json: {
+        'Content-Type': string;
+    };
+    /** Access-Control-Allow-Origin: <origin> */
+    cors: (origin?: string) => {
+        'Access-Control-Allow-Origin': string;
+    };
+};
+/**
+ * Creates a standardized API Gateway response.
+ * @param statusCode The HTTP status code of the response
+ * @param body The body of the response
+ * @param headers Optional headers to include in the response
+ * @returns An API Gateway proxy result
+ *
+ * @example
+ * ```ts
+ * const response = createResponse(200, { message: 'Success' }, httpHeaders.json);
+ * ```
+ */
+export declare const createResponse: (statusCode: number, body: unknown, headers?: Headers) => APIGatewayProxyResult;
+/**
+ * Creates a 200 OK API Gateway response
+ * @param body The body of the response
+ * @param headers Optional headers to include in the response
+ * @returns An API Gateway proxy result
+ * @example
+ * ```ts
+ * const response = ok({ message: 'Success' }, httpHeaders.json);
+ * ```
+ */
+export declare const ok: (body: unknown, headers?: Headers) => APIGatewayProxyResult;
+/**
+ * Creates a 201 Created API Gateway response
+ * @param body The body of the response
+ * @param headers Optional headers to include in the response
+ * @returns An API Gateway proxy result
+ * @example
+ * ```ts
+ * const response = created({ message: 'Resource created' }, httpHeaders.json);
+ * ```
+ */
+export declare const created: (body: unknown, headers?: Headers) => APIGatewayProxyResult;
+/**
+ * Creates a 204 No Content API Gateway response
+ * @param headers Optional headers to include in the response
+ * @returns An API Gateway proxy result
+ * @example
+ * ```ts
+ * const response = noContent(httpHeaders.cors());
+ * ```
+ */
+export declare const noContent: (headers?: Headers) => APIGatewayProxyResult;
+/**
+ * Creates a 400 Bad Request API Gateway response
+ * @param message The error message to include in the response
+ * @param headers Optional headers to include in the response
+ * @returns An API Gateway proxy result
+ * @example
+ * ```ts
+ * const response = badRequest('Invalid input', httpHeaders.json);
+ * ```
+ */
+export declare const badRequest: (message?: string, headers?: Headers) => APIGatewayProxyResult;
+/**
+ * Creates a 404 Not Found API Gateway response
+ * @param message The error message to include in the response
+ * @param headers Optional headers to include in the response
+ * @returns An API Gateway proxy result
+ * @example
+ * ```ts
+ * const response = notFound('Resource not found', httpHeaders.json);
+ * ```
+ */
+export declare const notFound: (message?: string, headers?: Headers) => APIGatewayProxyResult;
+/**
+ * Creates a 500 Internal Server Error API Gateway response
+ * @param message The error message to include in the response
+ * @param headers Optional headers to include in the response
+ * @returns An API Gateway proxy result
+ * @example
+ * ```ts
+ * const response = internalServerError('Something went wrong', httpHeaders.json);
+ * ```
+ */
+export declare const internalServerError: (message?: string, headers?: Headers) => APIGatewayProxyResult;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leanstacks/lambda-utils",
-  "version": "0.1.0",
+  "version": "0.2.0-alpha.3",
   "description": "A collection of utilities and helper functions designed to streamline the development of AWS Lambda functions using TypeScript.",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -35,6 +35,7 @@
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",
     "prepare": "husky",
+    "prepublish": "npm run clean && npm run build",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage"