@ttoss/lambda-postgres-query 0.2.13 → 0.2.15

package/dist/cloudformation/index.d.mts

@@ -0,0 +1,18 @@
+import { CloudFormationTemplate } from '@ttoss/cloudformation';
+export { CloudFormationTemplate } from '@ttoss/cloudformation';
+import { Handler } from 'aws-lambda';
+import { QueryParams } from '../index.mjs';
+import 'pg';
+
+declare const HANDLER_DEFAULT = "handler.handler";
+declare const MEMORY_SIZE_DEFAULT = 128;
+declare const TIMEOUT_DEFAULT = 30;
+declare const createLambdaPostgresQueryTemplate: ({ handler, memorySize, timeout, }?: {
+    handler?: string;
+    memorySize?: number;
+    timeout?: number;
+}) => CloudFormationTemplate;
+
+declare const handler: Handler<QueryParams>;
+
+export { HANDLER_DEFAULT, MEMORY_SIZE_DEFAULT, TIMEOUT_DEFAULT, createLambdaPostgresQueryTemplate, handler };

package/dist/cloudformation/index.d.ts

@@ -0,0 +1,18 @@
+import { CloudFormationTemplate } from '@ttoss/cloudformation';
+export { CloudFormationTemplate } from '@ttoss/cloudformation';
+import { Handler } from 'aws-lambda';
+import { QueryParams } from '../index.js';
+import 'pg';
+
+declare const HANDLER_DEFAULT = "handler.handler";
+declare const MEMORY_SIZE_DEFAULT = 128;
+declare const TIMEOUT_DEFAULT = 30;
+declare const createLambdaPostgresQueryTemplate: ({ handler, memorySize, timeout, }?: {
+    handler?: string;
+    memorySize?: number;
+    timeout?: number;
+}) => CloudFormationTemplate;
+
+declare const handler: Handler<QueryParams>;
+
+export { HANDLER_DEFAULT, MEMORY_SIZE_DEFAULT, TIMEOUT_DEFAULT, createLambdaPostgresQueryTemplate, handler };

package/dist/cloudformation/index.js

@@ -0,0 +1,224 @@
+/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
+"use strict";
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all) __defProp(target, name, {
+    get: all[name],
+    enumerable: true
+  });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from)) if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+      get: () => from[key],
+      enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+    });
+  }
+  return to;
+};
+var __toCommonJS = mod => __copyProps(__defProp({}, "__esModule", {
+  value: true
+}), mod);
+
+// src/cloudformation/index.ts
+var cloudformation_exports = {};
+__export(cloudformation_exports, {
+  HANDLER_DEFAULT: () => HANDLER_DEFAULT,
+  MEMORY_SIZE_DEFAULT: () => MEMORY_SIZE_DEFAULT,
+  TIMEOUT_DEFAULT: () => TIMEOUT_DEFAULT,
+  createLambdaPostgresQueryTemplate: () => createLambdaPostgresQueryTemplate,
+  handler: () => handler
+});
+module.exports = __toCommonJS(cloudformation_exports);
+
+// src/cloudformation/createLambdaPostgresQueryTemplate.ts
+var HANDLER_DEFAULT = "handler.handler";
+var MEMORY_SIZE_DEFAULT = 128;
+var TIMEOUT_DEFAULT = 30;
+var createLambdaPostgresQueryTemplate = ({
+  handler: handler2 = HANDLER_DEFAULT,
+  memorySize = 128,
+  timeout = 30
+} = {}) => {
+  return {
+    AWSTemplateFormatVersion: "2010-09-09",
+    Description: "A Lambda function to query PostgreSQL.",
+    Parameters: {
+      DatabaseHost: {
+        Type: "String",
+        Description: "Database host."
+      },
+      DatabaseHostReadOnly: {
+        Type: "String",
+        Description: "Database host read only."
+      },
+      DatabaseName: {
+        Type: "String",
+        Description: "Database name."
+      },
+      DatabaseUsername: {
+        Type: "String",
+        Description: "Database username."
+      },
+      DatabasePassword: {
+        Type: "String",
+        Description: "Database password."
+      },
+      DatabasePort: {
+        Type: "String",
+        Default: "5432",
+        Description: "Database port."
+      },
+      LambdaS3Bucket: {
+        Type: "String",
+        Description: "The S3 bucket where the Lambda code is stored."
+      },
+      LambdaS3Key: {
+        Type: "String",
+        Description: "The S3 key where the Lambda code is stored."
+      },
+      LambdaS3ObjectVersion: {
+        Type: "String",
+        Description: "The S3 object version of the Lambda code."
+      },
+      SecurityGroupIds: {
+        Description: "Security Group IDs",
+        Type: "List<AWS::EC2::SecurityGroup::Id>"
+      },
+      SubnetIds: {
+        Description: "Subnet IDs",
+        Type: "List<AWS::EC2::Subnet::Id>"
+      }
+    },
+    Resources: {
+      LambdaQueryExecutionRole: {
+        Type: "AWS::IAM::Role",
+        Properties: {
+          AssumeRolePolicyDocument: {
+            Version: "2012-10-17",
+            Statement: [{
+              Effect: "Allow",
+              Principal: {
+                Service: "lambda.amazonaws.com"
+              },
+              Action: "sts:AssumeRole"
+            }]
+          },
+          ManagedPolicyArns: ["arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole", "arn:aws:iam::aws:policy/service-role/AWSLambdaVPCAccessExecutionRole"]
+        }
+      },
+      LambdaQueryFunction: {
+        Type: "AWS::Lambda::Function",
+        Properties: {
+          Code: {
+            S3Bucket: {
+              Ref: "LambdaS3Bucket"
+            },
+            S3Key: {
+              Ref: "LambdaS3Key"
+            },
+            S3ObjectVersion: {
+              Ref: "LambdaS3ObjectVersion"
+            }
+          },
+          MemorySize: memorySize,
+          Timeout: timeout,
+          Handler: handler2,
+          Role: {
+            "Fn::GetAtt": ["LambdaQueryExecutionRole", "Arn"]
+          },
+          Runtime: "nodejs20.x",
+          Environment: {
+            Variables: {
+              DATABASE_HOST: {
+                Ref: "DatabaseHost"
+              },
+              DATABASE_HOST_READ_ONLY: {
+                Ref: "DatabaseHostReadOnly"
+              },
+              DATABASE_NAME: {
+                Ref: "DatabaseName"
+              },
+              DATABASE_USERNAME: {
+                Ref: "DatabaseUsername"
+              },
+              DATABASE_PASSWORD: {
+                Ref: "DatabasePassword"
+              },
+              DATABASE_PORT: {
+                Ref: "DatabasePort"
+              }
+            }
+          },
+          VpcConfig: {
+            SecurityGroupIds: {
+              Ref: "SecurityGroupIds"
+            },
+            SubnetIds: {
+              Ref: "SubnetIds"
+            }
+          }
+        }
+      }
+    },
+    Outputs: {
+      LambdaPostgresQueryFunction: {
+        Description: "Lambda function to query PostgreSQL.",
+        Value: {
+          Ref: "LambdaQueryFunction"
+        }
+      },
+      LambdaPostgresQueryFunctionArn: {
+        Description: "Lambda function to query PostgreSQL ARN.",
+        Value: {
+          "Fn::GetAtt": ["LambdaQueryFunction", "Arn"]
+        }
+      }
+    }
+  };
+};
+
+// src/cloudformation/lambdaQueryHandler.ts
+var import_pg = require("pg");
+var database = process.env.DATABASE_NAME;
+var username = process.env.DATABASE_USERNAME;
+var password = process.env.DATABASE_PASSWORD;
+var host = process.env.DATABASE_HOST;
+var hostReadOnly = process.env.DATABASE_HOST_READ_ONLY;
+var port = process.env.DATABASE_PORT;
+var handler = async event => {
+  try {
+    const client = new import_pg.Client({
+      database,
+      user: username,
+      password,
+      host: event.readOnly && hostReadOnly ? hostReadOnly : host,
+      port: Number(port)
+    });
+    await client.connect();
+    try {
+      const res = await client.query(event);
+      return res;
+    } finally {
+      await client.end();
+    }
+  } catch (error) {
+    console.error("Error running query", {
+      error,
+      event
+    });
+    throw error;
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  HANDLER_DEFAULT,
+  MEMORY_SIZE_DEFAULT,
+  TIMEOUT_DEFAULT,
+  createLambdaPostgresQueryTemplate,
+  handler
+});

package/dist/esm/cloudformation/index.js

@@ -0,0 +1,182 @@
+/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
+
+// src/cloudformation/createLambdaPostgresQueryTemplate.ts
+var HANDLER_DEFAULT = "handler.handler";
+var MEMORY_SIZE_DEFAULT = 128;
+var TIMEOUT_DEFAULT = 30;
+var createLambdaPostgresQueryTemplate = ({
+  handler: handler2 = HANDLER_DEFAULT,
+  memorySize = 128,
+  timeout = 30
+} = {}) => {
+  return {
+    AWSTemplateFormatVersion: "2010-09-09",
+    Description: "A Lambda function to query PostgreSQL.",
+    Parameters: {
+      DatabaseHost: {
+        Type: "String",
+        Description: "Database host."
+      },
+      DatabaseHostReadOnly: {
+        Type: "String",
+        Description: "Database host read only."
+      },
+      DatabaseName: {
+        Type: "String",
+        Description: "Database name."
+      },
+      DatabaseUsername: {
+        Type: "String",
+        Description: "Database username."
+      },
+      DatabasePassword: {
+        Type: "String",
+        Description: "Database password."
+      },
+      DatabasePort: {
+        Type: "String",
+        Default: "5432",
+        Description: "Database port."
+      },
+      LambdaS3Bucket: {
+        Type: "String",
+        Description: "The S3 bucket where the Lambda code is stored."
+      },
+      LambdaS3Key: {
+        Type: "String",
+        Description: "The S3 key where the Lambda code is stored."
+      },
+      LambdaS3ObjectVersion: {
+        Type: "String",
+        Description: "The S3 object version of the Lambda code."
+      },
+      SecurityGroupIds: {
+        Description: "Security Group IDs",
+        Type: "List<AWS::EC2::SecurityGroup::Id>"
+      },
+      SubnetIds: {
+        Description: "Subnet IDs",
+        Type: "List<AWS::EC2::Subnet::Id>"
+      }
+    },
+    Resources: {
+      LambdaQueryExecutionRole: {
+        Type: "AWS::IAM::Role",
+        Properties: {
+          AssumeRolePolicyDocument: {
+            Version: "2012-10-17",
+            Statement: [{
+              Effect: "Allow",
+              Principal: {
+                Service: "lambda.amazonaws.com"
+              },
+              Action: "sts:AssumeRole"
+            }]
+          },
+          ManagedPolicyArns: ["arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole", "arn:aws:iam::aws:policy/service-role/AWSLambdaVPCAccessExecutionRole"]
+        }
+      },
+      LambdaQueryFunction: {
+        Type: "AWS::Lambda::Function",
+        Properties: {
+          Code: {
+            S3Bucket: {
+              Ref: "LambdaS3Bucket"
+            },
+            S3Key: {
+              Ref: "LambdaS3Key"
+            },
+            S3ObjectVersion: {
+              Ref: "LambdaS3ObjectVersion"
+            }
+          },
+          MemorySize: memorySize,
+          Timeout: timeout,
+          Handler: handler2,
+          Role: {
+            "Fn::GetAtt": ["LambdaQueryExecutionRole", "Arn"]
+          },
+          Runtime: "nodejs20.x",
+          Environment: {
+            Variables: {
+              DATABASE_HOST: {
+                Ref: "DatabaseHost"
+              },
+              DATABASE_HOST_READ_ONLY: {
+                Ref: "DatabaseHostReadOnly"
+              },
+              DATABASE_NAME: {
+                Ref: "DatabaseName"
+              },
+              DATABASE_USERNAME: {
+                Ref: "DatabaseUsername"
+              },
+              DATABASE_PASSWORD: {
+                Ref: "DatabasePassword"
+              },
+              DATABASE_PORT: {
+                Ref: "DatabasePort"
+              }
+            }
+          },
+          VpcConfig: {
+            SecurityGroupIds: {
+              Ref: "SecurityGroupIds"
+            },
+            SubnetIds: {
+              Ref: "SubnetIds"
+            }
+          }
+        }
+      }
+    },
+    Outputs: {
+      LambdaPostgresQueryFunction: {
+        Description: "Lambda function to query PostgreSQL.",
+        Value: {
+          Ref: "LambdaQueryFunction"
+        }
+      },
+      LambdaPostgresQueryFunctionArn: {
+        Description: "Lambda function to query PostgreSQL ARN.",
+        Value: {
+          "Fn::GetAtt": ["LambdaQueryFunction", "Arn"]
+        }
+      }
+    }
+  };
+};
+
+// src/cloudformation/lambdaQueryHandler.ts
+import { Client } from "pg";
+var database = process.env.DATABASE_NAME;
+var username = process.env.DATABASE_USERNAME;
+var password = process.env.DATABASE_PASSWORD;
+var host = process.env.DATABASE_HOST;
+var hostReadOnly = process.env.DATABASE_HOST_READ_ONLY;
+var port = process.env.DATABASE_PORT;
+var handler = async event => {
+  try {
+    const client = new Client({
+      database,
+      user: username,
+      password,
+      host: event.readOnly && hostReadOnly ? hostReadOnly : host,
+      port: Number(port)
+    });
+    await client.connect();
+    try {
+      const res = await client.query(event);
+      return res;
+    } finally {
+      await client.end();
+    }
+  } catch (error) {
+    console.error("Error running query", {
+      error,
+      event
+    });
+    throw error;
+  }
+};
+export { HANDLER_DEFAULT, MEMORY_SIZE_DEFAULT, TIMEOUT_DEFAULT, createLambdaPostgresQueryTemplate, handler };

package/dist/esm/index.js

@@ -0,0 +1,56 @@
+/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
+
+// src/query.ts
+import { InvokeCommand, LambdaClient } from "@aws-sdk/client-lambda";
+import camelcaseKeys from "camelcase-keys";
+var lambdaClient = new LambdaClient();
+var asciiDecoder = new TextDecoder("ascii");
+var query = async params => {
+  try {
+    const {
+      readOnly = true,
+      // eslint-disable-next-line turbo/no-undeclared-env-vars
+      lambdaPostgresQueryFunction = process.env.LAMBDA_POSTGRES_QUERY_FUNCTION,
+      ...pgParams
+    } = typeof params === "string" ? {
+      text: params
+    } : params;
+    const input = {
+      FunctionName: lambdaPostgresQueryFunction,
+      Payload: JSON.stringify({
+        readOnly,
+        ...pgParams
+      })
+    };
+    const {
+      Payload
+    } = await lambdaClient.send(new InvokeCommand(input));
+    if (!Payload) {
+      console.error("No payload returned from lambda query", {
+        input
+      });
+      throw new Error("No payload returned from lambda query");
+    }
+    const data = asciiDecoder.decode(Payload);
+    const result = JSON.parse(data);
+    if ("errorType" in result) {
+      throw result;
+    }
+    return {
+      ...result,
+      rows: result.rows.map(row => {
+        return {
+          ...row,
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          ...camelcaseKeys(row, {
+            deep: true
+          })
+        };
+      })
+    };
+  } catch (error) {
+    console.error("Error invoking Lambda: ", error);
+    throw error;
+  }
+};
+export { query };

package/dist/index.d.mts

@@ -0,0 +1,21 @@
+import * as pg from 'pg';
+import { QueryConfig, QueryResultRow } from 'pg';
+
+type QueryParams = {
+    readOnly?: boolean;
+    lambdaPostgresQueryFunction?: string;
+} & QueryConfig;
+type LambdaError = {
+    errorType: 'Error';
+    errorMessage: string;
+    trace: string[];
+};
+declare const query: <Rows extends QueryResultRow = any>(params: QueryParams | string) => Promise<{
+    rows: any[];
+    command: string;
+    rowCount: number | null;
+    oid: number;
+    fields: pg.FieldDef[];
+}>;
+
+export { type LambdaError, type QueryParams, query };

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import * as pg from 'pg';
+import { QueryConfig, QueryResultRow } from 'pg';
+
+type QueryParams = {
+    readOnly?: boolean;
+    lambdaPostgresQueryFunction?: string;
+} & QueryConfig;
+type LambdaError = {
+    errorType: 'Error';
+    errorMessage: string;
+    trace: string[];
+};
+declare const query: <Rows extends QueryResultRow = any>(params: QueryParams | string) => Promise<{
+    rows: any[];
+    command: string;
+    rowCount: number | null;
+    oid: number;
+    fields: pg.FieldDef[];
+}>;
+
+export { type LambdaError, type QueryParams, query };

package/dist/index.js

@@ -0,0 +1,101 @@
+/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
+"use strict";
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all) __defProp(target, name, {
+    get: all[name],
+    enumerable: true
+  });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from)) if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+      get: () => from[key],
+      enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+    });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+// If the importer is in node compatibility mode or this is not an ESM
+// file that has been converted to a CommonJS file using a Babel-
+// compatible transform (i.e. "__esModule" has not been set), then set
+// "default" to the CommonJS "module.exports" for node compatibility.
+isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+  value: mod,
+  enumerable: true
+}) : target, mod));
+var __toCommonJS = mod => __copyProps(__defProp({}, "__esModule", {
+  value: true
+}), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  query: () => query
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/query.ts
+var import_client_lambda = require("@aws-sdk/client-lambda");
+var import_camelcase_keys = __toESM(require("camelcase-keys"));
+var lambdaClient = new import_client_lambda.LambdaClient();
+var asciiDecoder = new TextDecoder("ascii");
+var query = async params => {
+  try {
+    const {
+      readOnly = true,
+      // eslint-disable-next-line turbo/no-undeclared-env-vars
+      lambdaPostgresQueryFunction = process.env.LAMBDA_POSTGRES_QUERY_FUNCTION,
+      ...pgParams
+    } = typeof params === "string" ? {
+      text: params
+    } : params;
+    const input = {
+      FunctionName: lambdaPostgresQueryFunction,
+      Payload: JSON.stringify({
+        readOnly,
+        ...pgParams
+      })
+    };
+    const {
+      Payload
+    } = await lambdaClient.send(new import_client_lambda.InvokeCommand(input));
+    if (!Payload) {
+      console.error("No payload returned from lambda query", {
+        input
+      });
+      throw new Error("No payload returned from lambda query");
+    }
+    const data = asciiDecoder.decode(Payload);
+    const result = JSON.parse(data);
+    if ("errorType" in result) {
+      throw result;
+    }
+    return {
+      ...result,
+      rows: result.rows.map(row => {
+        return {
+          ...row,
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          ...(0, import_camelcase_keys.default)(row, {
+            deep: true
+          })
+        };
+      })
+    };
+  } catch (error) {
+    console.error("Error invoking Lambda: ", error);
+    throw error;
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  query
+});

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@ttoss/lambda-postgres-query",
-  "version": "0.2.13",
+  "version": "0.2.15",
   "description": "Create a Lambda function that queries a PostgreSQL database.",
+  "license": "MIT",
   "author": "ttoss",
   "contributors": [
     "Pedro Arantes <pedro@arantespp.com> (https://arantespp.com)"
@@ -25,14 +26,13 @@
     }
   },
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "dependencies": {
     "@aws-sdk/client-lambda": "^3.624.0",
     "camelcase-keys": "^7.0.2",
     "pg": "^8.12.0",
-    "@ttoss/cloudformation": "^0.10.9"
+    "@ttoss/cloudformation": "^0.10.11"
   },
   "devDependencies": {
     "@types/jest": "^29.5.13",
@@ -40,8 +40,8 @@
     "aws-sdk-client-mock": "^4.0.1",
     "jest": "^29.7.0",
     "tsup": "^8.3.0",
-    "@ttoss/config": "^1.33.0",
-    "@ttoss/test-utils": "^2.1.15"
+    "@ttoss/config": "^1.34.1",
+    "@ttoss/test-utils": "^2.1.17"
   },
   "keywords": [
     "aws",