quidproquo-actionprocessor-awslambda 0.0.172 → 0.0.174

package/README.md

@@ -1,7 +1,118 @@
 # quidproquo-actionprocessor-awslambda
 
-generic action processors for awslambda
+The `quidproquo-actionprocessor-awslambda` library is a key component of the quidproquo framework,
+providing a set of generic action processors for AWS Lambda. This library serves as the bridge
+between the core quidproquo functionality and the AWS Lambda runtime, enabling the execution of
+quidproquo-based applications on the AWS Lambda platform.
 
-### Note
+## WARNING: NOT FOR PRODUCTION
 
-Currently under development ~ Not for production
+**This project is currently under active development and should not be used in production
+environments. The APIs and functionality are subject to change without notice.**
+
+## Key Features
+
+1. **Action-Oriented Architecture**: The `quidproquo-actionprocessor-awslambda` library aligns with
+   the action-oriented architecture of the quidproquo framework, allowing for the seamless execution
+   of quidproquo actions within the AWS Lambda environment.
+
+2. **Event Handling**: The library provides specialized action processors for handling various event
+   types, such as API Gateway events, CloudFront events, SQS events, and more. This enables the
+   integration of quidproquo-based applications with a wide range of AWS services.
+
+3. **Configuration Management**: The library includes action processors for managing quidproquo
+   configuration, including the retrieval of secrets, parameters, and global values from AWS
+   services like Secrets Manager and Systems Manager Parameter Store.
+
+4. **File Management**: The library offers action processors for interacting with Amazon S3,
+   allowing for the reading, writing, and management of files and directories within the quidproquo
+   application.
+
+5. **User Directory Integration**: The library includes action processors for integrating with
+   Amazon Cognito, enabling user authentication, user management, and access control within
+   quidproquo-based applications.
+
+6. **Event Bus Integration**: The library provides action processors for publishing and subscribing
+   to events using Amazon EventBridge, facilitating cross-service communication and event-driven
+   architectures.
+
+7. **Key-Value Store Integration**: The library includes action processors for interacting with
+   Amazon DynamoDB, enabling the use of key-value stores within quidproquo applications.
+
+8. **Logging and Observability**: The library integrates with the quidproquo logging and
+   observability features, ensuring that application logs and metrics are captured and made
+   available for monitoring and troubleshooting.
+
+9. **Extensibility**: The library is designed to be highly extensible, allowing developers to create
+   custom action processors to meet their specific requirements.
+
+## Key Concepts
+
+1. **Action Processors**: Action processors are the core components of the
+   `quidproquo-actionprocessor-awslambda` library, responsible for executing quidproquo actions
+   within the AWS Lambda environment. These processors handle the integration with various AWS
+   services and ensure the correct execution of quidproquo actions.
+
+2. **Event Handling**: The library provides specialized action processors for handling different
+   event types, such as API Gateway events, CloudFront events, SQS events, and more. These
+   processors transform the event data into a format that can be consumed by the quidproquo runtime
+   and execute the appropriate quidproquo actions.
+
+3. **Configuration Management**: The library includes action processors for retrieving and managing
+   quidproquo configuration data, such as secrets, parameters, and global values, from AWS services
+   like Secrets Manager and Systems Manager Parameter Store.
+
+4. **File Management**: The file management action processors enable the reading, writing, and
+   management of files and directories within the quidproquo application, using Amazon S3 as the
+   underlying storage service.
+
+5. **User Directory Integration**: The user directory integration action processors handle the
+   integration with Amazon Cognito, allowing for user authentication, user management, and access
+   control within quidproquo-based applications.
+
+6. **Event Bus Integration**: The event bus integration action processors facilitate the publishing
+   and subscribing of events using Amazon EventBridge, enabling cross-service communication and
+   event-driven architectures within quidproquo applications.
+
+7. **Key-Value Store Integration**: The key-value store integration action processors provide the
+   ability to interact with Amazon DynamoDB, allowing quidproquo applications to leverage key-value
+   stores for data storage and retrieval.
+
+8. **Logging and Observability**: The library integrates with the quidproquo logging and
+   observability features, ensuring that application logs and metrics are captured and made
+   available for monitoring and troubleshooting.
+
+9. **Extensibility**: The `quidproquo-actionprocessor-awslambda` library is designed to be highly
+   extensible, allowing developers to create custom action processors to meet their specific
+   requirements. This enables the integration of quidproquo-based applications with a wide range of
+   AWS services and third-party tools.
+
+## Getting Started
+
+To use the `quidproquo-actionprocessor-awslambda` library, you'll need to install the package and
+its dependencies. You can do this using your preferred package manager, such as npm or yarn:
+
+```
+npm install quidproquo-actionprocessor-awslambda
+```
+
+Once you have the package installed, you can start building your quidproquo-based applications on
+the AWS Lambda platform, leveraging the action processors provided by this library.
+
+## Documentation
+
+For more detailed information on using the `quidproquo-actionprocessor-awslambda` library, please
+refer to the
+[quidproquo-actionprocessor-awslambda documentation](https://github.com/joe-coady/quidproquo/tree/main/packages/quidproquo-actionprocessor-awslambda).
+
+## Contributing
+
+If you'd like to contribute to the development of `quidproquo-actionprocessor-awslambda`, please
+refer to the
+[contributing guidelines](https://github.com/joe-coady/quidproquo/blob/main/CONTRIBUTING.md) for
+more information.
+
+## License
+
+`quidproquo-actionprocessor-awslambda` is licensed under the
+[MIT License](https://github.com/joe-coady/quidproquo/blob/main/LICENSE).

package/lib/commonjs/awsNamingUtils.d.ts

@@ -2,7 +2,9 @@ import { QPQConfig, ResourceName } from 'quidproquo-core';
 export declare const getGlobalConfigRuntimeResourceName: (resourceName: string, application: string, environment: string, feature?: string) => string;
 export declare const getGlobalQpqRuntimeResourceName: (resourceName: string, application: string, environment: string, feature?: string, resourceType?: string) => string;
 export declare const getConfigRuntimeResourceName: (resourceName: string, application: string, service: string, environment: string, feature?: string) => string;
+export declare const getConfigRuntimeBootstrapResourceName: (resourceName: string, application: string, environment: string, feature?: string) => string;
 export declare const getConfigRuntimeResourceNameFromConfig: (resourceName: string, qpqConfig: QPQConfig) => string;
+export declare const getConfigRuntimeBootstrapResourceNameFromConfig: (resourceName: string, qpqConfig: QPQConfig) => string;
 export declare const getConfigRuntimeResourceNameFromConfigWithServiceOverride: (resourceName: string, qpqConfig: QPQConfig, serviceOverride?: string) => string;
 export declare const getQpqRuntimeResourceName: (resourceName: string, application: string, service: string, environment: string, feature?: string, resourceType?: string) => string;
 export declare const getQpqRuntimeResourceNameFromConfig: (resourceName: ResourceName, qpqConfig: QPQConfig, resourceType?: string) => string;

package/lib/commonjs/awsNamingUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBootstrapStackName = exports.getApiStackName = exports.getWebStackName = exports.getInfStackName = exports.getBaseStackName = exports.getEventBusSnsTopicArn = exports.getCFExportNameWebsocketApiIdFromConfig = exports.getCFExportNameDistributionIdArnFromConfig = exports.getCFExportNameSnsTopicArnFromConfig = exports.getCFExportNameApiKeyIdFromConfig = exports.getCFExportNameUserPoolClientIdFromConfig = exports.getCFExportNameCachePolicyIdFromConfig = exports.getCFExportNameUserPoolIdFromConfig = exports.getKvsDynamoTableNameFromConfig = exports.getQpqRuntimeResourceNameFromConfig = exports.getQpqRuntimeResourceName = exports.getConfigRuntimeResourceNameFromConfigWithServiceOverride = exports.getConfigRuntimeResourceNameFromConfig = exports.getConfigRuntimeResourceName = exports.getGlobalQpqRuntimeResourceName = exports.getGlobalConfigRuntimeResourceName = void 0;
+exports.getBootstrapStackName = exports.getApiStackName = exports.getWebStackName = exports.getInfStackName = exports.getBaseStackName = exports.getEventBusSnsTopicArn = exports.getCFExportNameWebsocketApiIdFromConfig = exports.getCFExportNameDistributionIdArnFromConfig = exports.getCFExportNameSnsTopicArnFromConfig = exports.getCFExportNameApiKeyIdFromConfig = exports.getCFExportNameUserPoolClientIdFromConfig = exports.getCFExportNameCachePolicyIdFromConfig = exports.getCFExportNameUserPoolIdFromConfig = exports.getKvsDynamoTableNameFromConfig = exports.getQpqRuntimeResourceNameFromConfig = exports.getQpqRuntimeResourceName = exports.getConfigRuntimeResourceNameFromConfigWithServiceOverride = exports.getConfigRuntimeBootstrapResourceNameFromConfig = exports.getConfigRuntimeResourceNameFromConfig = exports.getConfigRuntimeBootstrapResourceName = exports.getConfigRuntimeResourceName = exports.getGlobalQpqRuntimeResourceName = exports.getGlobalConfigRuntimeResourceName = void 0;
 const quidproquo_core_1 = require("quidproquo-core");
 const quidproquo_config_aws_1 = require("quidproquo-config-aws");
 const getGlobalConfigRuntimeResourceName = (resourceName, application, environment, feature) => {
@@ -24,6 +24,14 @@ const getConfigRuntimeResourceName = (resourceName, application, service, enviro
     return baseName;
 };
 exports.getConfigRuntimeResourceName = getConfigRuntimeResourceName;
+const getConfigRuntimeBootstrapResourceName = (resourceName, application, environment, feature) => {
+    const baseName = `${resourceName}-${application}-${environment}`;
+    if (feature) {
+        return `${baseName}-${feature}`;
+    }
+    return baseName;
+};
+exports.getConfigRuntimeBootstrapResourceName = getConfigRuntimeBootstrapResourceName;
 const getConfigRuntimeResourceNameFromConfig = (resourceName, qpqConfig) => {
     const application = quidproquo_core_1.qpqCoreUtils.getApplicationName(qpqConfig);
     const service = quidproquo_core_1.qpqCoreUtils.getApplicationModuleName(qpqConfig);
@@ -32,6 +40,13 @@ const getConfigRuntimeResourceNameFromConfig = (resourceName, qpqConfig) => {
     return (0, exports.getConfigRuntimeResourceName)(resourceName, application, service, environment, feature);
 };
 exports.getConfigRuntimeResourceNameFromConfig = getConfigRuntimeResourceNameFromConfig;
+const getConfigRuntimeBootstrapResourceNameFromConfig = (resourceName, qpqConfig) => {
+    const application = quidproquo_core_1.qpqCoreUtils.getApplicationName(qpqConfig);
+    const environment = quidproquo_core_1.qpqCoreUtils.getApplicationModuleEnvironment(qpqConfig);
+    const feature = quidproquo_core_1.qpqCoreUtils.getApplicationModuleFeature(qpqConfig);
+    return (0, exports.getConfigRuntimeBootstrapResourceName)(resourceName, application, environment, feature);
+};
+exports.getConfigRuntimeBootstrapResourceNameFromConfig = getConfigRuntimeBootstrapResourceNameFromConfig;
 const getConfigRuntimeResourceNameFromConfigWithServiceOverride = (resourceName, qpqConfig, serviceOverride) => {
     const application = quidproquo_core_1.qpqCoreUtils.getApplicationName(qpqConfig);
     const service = serviceOverride || quidproquo_core_1.qpqCoreUtils.getApplicationModuleName(qpqConfig);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quidproquo-actionprocessor-awslambda",
-  "version": "0.0.172",
+  "version": "0.0.174",
   "description": "",
   "main": "./lib/commonjs/index.js",
   "types": "./lib/commonjs/index.d.ts",
@@ -9,7 +9,7 @@
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "clean": "npx rimraf lib",
+    "clean": "npx rimraf lib && npx rimraf node_modules",
     "build": "npm run clean && tsc -p tsconfig.commonjs.json",
     "watch": "tsc -p tsconfig.commonjs.json -w"
   },
@@ -47,9 +47,9 @@
     "lodash": "^4.17.21",
     "node-cache": "^5.1.2",
     "node-match-path": "^0.6.3",
-    "quidproquo-config-aws": "0.0.172",
-    "quidproquo-core": "0.0.172",
-    "quidproquo-webserver": "0.0.172"
+    "quidproquo-config-aws": "0.0.174",
+    "quidproquo-core": "0.0.174",
+    "quidproquo-webserver": "0.0.174"
   },
   "devDependencies": {
     "@types/aws-lambda": "^8.10.109",
@@ -57,7 +57,7 @@
     "@types/jsonwebtoken": "^9.0.2",
     "@types/lodash": "^4.14.194",
     "@types/node": "^18.11.9",
-    "quidproquo-tsconfig": "0.0.172",
+    "quidproquo-tsconfig": "0.0.174",
     "typescript": "^4.9.3"
   }
 }