@63klabs/cache-data 1.2.2 → 1.2.5

package/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 > Note: This project is still in beta. Even though changes are tested and breaking changes are avoided, things may break. The latest 1.1.x version is stable.
 
+## 1.2.5 (2025-06-23)
+
+- Updated suggested Lambda environment variables to uppercase: `CACHE_DATA_`
+- Added check for environment variable `DEPLOY_ENVIRONMENT` among current list of variables checked to determine environment.
+
 ## 1.1.6 (2025-05-05) Moving to @63Klabs
 
 This package has come a long way and is stable. To enhance its longevity I am moving it out of my personal GitHub and NPM accounts an into an organizational account managed by me (chadkluck).

package/README.md

@@ -2,9 +2,9 @@
 
 A package for node.js applications to access and cache data from remote API endpoints or other sources using AWS S3 and DynamoDb. 
 
-> Note: This repository and package is moving to 63Klabs
+> Note: This repository and package has moved from chadkluck to 63Klabs but is still managed by the same developer.
 
-[@chadkluck/cache-data on npmjs.com](https://www.npmjs.com/package/@chadkluck/cache-data)
+[@63klabs/cache-data on npmjs.com](https://www.npmjs.com/package/@63klabs/cache-data)
 
 ## Description
 
@@ -29,7 +29,7 @@ This package has been used in production for applications receiving over 1 milli
 1. Make sure your function is using an AWS Lambda supported version of Node and has at least 256MB allocated (512-1024MB recommended).
 2. Add the cache-data environment variables to your Lambda function. Also update your Lambda's execution role to access your S3 and DynamoDb.
 3. Add an S3 bucket and DynamoDb table to store your cache either in the application CloudFormation template or as separate infrastructure.
-4. Install the @chadkluck/cache-data package `npm install @chadkluck/cache-data`
+4. Install the @63klabs/cache-data package `npm install @63klabs/cache-data`
 5. Add the cache code to your Lambda function
 
 #### Lambda Memory Allocation
@@ -81,21 +81,22 @@ Resources:
 
       Environment:
         Variables:
-          detailedLogs: "5" # Use "0" for production
-          deployEnvironment: "TEST" # "PROD"
-          paramStore: "/" # SSM Parameter store can use a hierarchy to organize your apps parameters
-          
-          # Cache-Data settings (from: https://www.npmjs.com/package/@chadkluck/cache-data)
-          CacheData_DynamoDbTable: !Ref CacheDataDynamoDbTable
-          CacheData_S3Bucket: !Ref CacheDataS3Bucket
-          CacheData_CryptSecureDataAlgorithm: !Ref CacheDataCryptSecureDataAlg
-          CacheData_CryptIdHashAlgorithm: !Ref CacheDataCryptIdHashAlgorithm
-          CacheData_DynamoDb_maxCacheSize_kb: !Ref CacheDataDbMaxCacheSizeInKB
-          CacheData_PurgeExpiredCacheEntriesAfterXHours: !Ref CacheDataPurgeExpiredCacheEntriesInHours
-          CacheData_ErrorExpirationInSeconds: !Ref CacheDataErrorExpirationInSeconds
-          CacheData_TimeZoneForInterval: !Ref CacheDataTimeZoneForInterval
-          CacheData_AWSXRayOn: !Ref CacheDataAWSXRayOn
 
+          NODE_ENV: !If [ IsProduction, "production",  "development"] # Note we are past the build installation phase so devDependencies are not installed, however, we can utilize certain tools in development mode
+          DEPLOY_ENVIRONMENT: !Ref DeployEnvironment # PROD, TEST, DEV - a different category of environment
+          LOG_LEVEL: !If [ IsProduction, "0",  "5"] # 0 for prod, 2-5 for non-prod
+          PARAM_STORE_PATH: "/" # SSM Parameter store can use a hierarchy to organize your apps parameters
+          
+          # Cache-Data settings (from: https://www.npmjs.com/package/@63klabs/cache-data)
+          CACHE_DATA_DYNAMO_DB_TABLE: !Ref CacheDataDynamoDbTable
+          CACHE_DATA_S3_BUCKET: !Ref CacheDataS3Bucket
+          CACHE_DATA_SECURE_DATA_ALGORITHM: !Ref CacheDataCryptSecureDataAlg
+          CACHE_DATA_ID_HASH_ALGORITHM: !Ref CacheDataCryptIdHashAlgorithm
+          CACHE_DATA_DYNAMO_DB_MAX_CACHE_SIZE_KB: !Ref CacheDataDbMaxCacheSizeInKB
+          CACHE_DATA_PURGE_EXPIRED_CACHE_ENTRIES_AFTER_X_HRS: !Ref CacheDataPurgeExpiredCacheEntriesInHours
+          CACHE_DATA_ERROR_EXP_IN_SECONDS: !Ref CacheDataErrorExpirationInSeconds
+          CACHE_DATA_TIME_ZONE_FOR_INTERVAL: !Ref CacheDataTimeZoneForInterval
+          CACHE_DATA_AWS_X_RAY_ON: !Ref CacheDataAWSXRayOn
 
   # -- LambdaFunction Execution Role --
 
@@ -134,7 +135,7 @@ Resources:
             Effect: Allow
             Resource: !GetAtt AppLogGroup.Arn
 
-          # cache-data Parameter Read Access (from: https://www.npmjs.com/package/@chadkluck/cache-data)
+          # cache-data Parameter Read Access (from: https://www.npmjs.com/package/@63klabs/cache-data)
           - Sid: LambdaAccessToSSMParameters
             Action:
             - ssm:DescribeParameters
@@ -145,7 +146,7 @@ Resources:
             Resource: 
             - !Sub "arn:aws:ssm:${AWS::Region}:${AWS::AccountId}:parameter${ParameterStoreHierarchy}*"
 
-          # cache-data S3 bucket (from: https://www.npmjs.com/package/@chadkluck/cache-data)
+          # cache-data S3 bucket (from: https://www.npmjs.com/package/@63klabs/cache-data)
           - Sid: LambdaAccessToS3BucketCacheData
             Action:
             - s3:PutObject
@@ -154,7 +155,7 @@ Resources:
             Effect: Allow
             Resource: !Join [ '', [ !GetAtt CacheDataS3Bucket.Arn, '/cache/*' ] ]
 
-          # cache-data DynamoDb table (from: https://www.npmjs.com/package/@chadkluck/cache-data)
+          # cache-data DynamoDb table (from: https://www.npmjs.com/package/@63klabs/cache-data)
           - Sid: LambdaAccessToDynamoDBTableCacheData
             Action:
             - dynamodb:GetItem
@@ -177,7 +178,7 @@ Parameters:
 
   # ---------------------------------------------------------------------------
   # Cache-Data Parameters
-  # From: https://www.npmjs.com/package/@chadkluck/cache-data
+  # From: https://www.npmjs.com/package/@63klabs/cache-data
 
   CacheDataDbMaxCacheSizeInKB:
     Type: Number
@@ -244,7 +245,7 @@ Resources:
 
   # ---------------------------------------------------------------------------
   # Cache-Data
-  # From: https://www.npmjs.com/package/@chadkluck/cache-data
+  # From: https://www.npmjs.com/package/@63klabs/cache-data
   # Your Lambda function will need access via the Execution Role
 
   # -- Cache-Data DynamoDb Table --
@@ -318,14 +319,14 @@ Resources:
 #### Install npm Package and Add Starter Code
 
 1. Go to your application directory
-2. Run the command `npm i @chadkluck/cache-data`
-3. Add `const { tools, cache, endpoint } = require('@chadkluck/cache-data');` to your script
+2. Run the command `npm i @63klabs/cache-data`
+3. Add `const { tools, cache, endpoint } = require('@63klabs/cache-data');` to your script
 4. Add a Config class to your script. This should be placed before the handler so it only is defined during cold starts. This can also be imported from a separate script.
 5. Add `Config.init()` after the Config class but before the handler.
 5. Add `await tools.Config.promise();` in the handler to make sure the Config has completed.
 
 ```javascript
-const { tools, cache, endpoint } = require('@chadkluck/cache-data');
+const { tools, cache, endpoint } = require('@63klabs/cache-data');
 
 class Config extends tools._ConfigSuperClass {
 	static async init() {
@@ -386,7 +387,7 @@ class Config extends tools._ConfigSuperClass {
 					[
 						{
 							"group": "app", // so we can do params.app.weatherapikey later
-							"path": process.env.paramStore
+							"path": process.env.PARAM_STORE_PATH
 						}
 					]
 				);
@@ -487,7 +488,7 @@ This code can be put into a separate file and brought in using a `require` state
 /* EXAMPLE USING the this._initParameters method of obtaining parameters during Config.init() */
 
 // require cache-data
-const { tools, cache, endpoint } = require('@chadkluck/cache-data');
+const { tools, cache, endpoint } = require('@63klabs/cache-data');
 
 /**
  * Extends tools._ConfigSuperClass
@@ -516,7 +517,7 @@ class Config extends tools._ConfigSuperClass {
 					[
 						{
 							"group": "app", // so we can do params.app.weatherapikey later
-							"path": "/apps/my_cool_app/" // process.env.paramStorePath // or store as a Lambda environment variable
+							"path": "/apps/my_cool_app/" // process.env.PARAM_STORE_PATH // or store as a Lambda environment variable
 						}
 					]
 				);
@@ -634,7 +635,7 @@ Once the `Config` object is initialized, the following code can be used to acces
 /*
 Note that cache object was already set by the require statement
 assuming: 
-const { tools, cache, endpoint } = require('@chadkluck/cache-data');
+const { tools, cache, endpoint } = require('@63klabs/cache-data');
 */
 
 let connection = Config.getConnection("demo"); // corresponds with the name we gave it during connections.add()
@@ -886,7 +887,7 @@ In its simplist form we can do the following:
 ```js
 /*
 Assuming: 
-const { tools, cache, endpoint } = require('@chadkluck/cache-data');
+const { tools, cache, endpoint } = require('@63klabs/cache-data');
 */
 
 const timerTaskGetGames = new tools.Timer("Getting games", true); // We give it a name for logging, and we set to true so the timer starts right away
@@ -911,7 +912,7 @@ You are able to get the current time elapsed in milliseconds from a running Time
 ```js
 /*
 Assuming: 
-const { tools, cache, endpoint } = require('@chadkluck/cache-data');
+const { tools, cache, endpoint } = require('@63klabs/cache-data');
 */
 
 /* increase the log level - comment out when not needed  */
@@ -1044,13 +1045,13 @@ console.log( tools.obfuscate(str, opt) );
 
 ### AWS-SDK
 
-The @chadkluck/cache-data package will automatically detect and use the correct AWS SDK based on the version of Node.
+The @63klabs/cache-data package will automatically detect and use the correct AWS SDK based on the version of Node.
 
 Node 16 environments will use AWS-SDK version 2.
 
 Node 18+ environments will use AWS-SDK version 3.
 
-Note that `package.json` for @chadkluck/cache-data only installs the AWS-SDK on dev environments. This is because AWS Lambda already includes the AWS-SDK  without requiring installs. This makes your application lighter and ensures you are always running the most recent SDK release. Given this, that means that AWS SDK v3 is not available in Lambda functions using Node 16, and v2 is not available in Lambda Node >=18 environments.
+Note that `package.json` for @63klabs/cache-data only installs the AWS-SDK on dev environments. This is because AWS Lambda already includes the AWS-SDK  without requiring installs. This makes your application lighter and ensures you are always running the most recent SDK release. Given this, that means that AWS SDK v3 is not available in Lambda functions using Node 16, and v2 is not available in Lambda Node >=18 environments.
 
 Because DynamoDb, S3, and SSM Parameter store are used by cache-data, only those SDKs are included. A client is provided for each along with limited number of commands. To make gets and puts easier a get and put command is mapped for DynamoDb and S3. (Uses appropriate commands underneath for V2 and V3 so your code wouldn't need to change.)
 
@@ -1059,7 +1060,7 @@ Because DynamoDb, S3, and SSM Parameter store are used by cache-data, only those
 When `tools` is imported, you can use the `tools.AWS` object to perform common read/write operations on S3, DynamoDb, and SSM Parameter Store.
 
 ```javascript
-const { tools } = require('@chadkluck/cache-data');
+const { tools } = require('@63klabs/cache-data');
 
 console.log(`NODE VERSION ${tools.AWS.NODE_VER} USING AWS SDK ${tools.AWS.SDK_VER}`);
 console.log(`REGION: ${tools.AWS.REGION}`); // set from Lambda environment variable AWS_REGION
@@ -1184,7 +1185,7 @@ const dbGetResult = await dbDocClient.send(GetCommand(paramsForGetRecord));
 
 ```javascript
 // Using tools to handle the SDK version and basic calls for you
-const { tools } = require('@chadkluck/cache-data');
+const { tools } = require('@63klabs/cache-data');
 
 const dbPutResult = await tools.AWS.dynamodb.put(paramsForNewRecord);
 const dbGetResult = await tools.AWS.dynamodb.get(paramsForGetRecrod);
@@ -1203,7 +1204,7 @@ For more on creating parameter/query objects for S3, DynamoDb, and SSM Parameter
 When using AWS SDK version 3, you can import additional commands and use them with the client provided by `tools.AWS`.
 
 ```javascript
-const { tools } = require('@chadkluck/cache-data');
+const { tools } = require('@63klabs/cache-data');
 const { DeleteObjectCommand } = require('@aws-sdk/client-s3'); // AWS SDK v3
 
 const command = new DeleteObjectCommand({
@@ -1220,7 +1221,7 @@ Because Node 16 and the AWS SDK v2 is being deprecated, this documentation will
 
 ```js
 // NodeJS 16 using AWS SDK v2
-const {tools} = require("@chadkluck/cache-data");
+const {tools} = require("@63klabs/cache-data");
 
 // using the provided S3 client
 const s3result1 = await tools.AWS.s3.client.putObject(params).promise();
@@ -1253,7 +1254,7 @@ Make sure you have your S3 bucket, DynamoDb table, and SSM Parameter store set u
 
 - [Website](https://chadkluck.me/)
 - [GitHub](https://github.com/chadkluck)
-- [Mastodon: @chadkluck@universeodon.com](https://universeodon.com/@chadkluck)
+- [Mastodon: @63klabs@universeodon.com](https://universeodon.com/@63klabs)
 - [X: @ChadKluck](https://x.com/chadkluck)
 
 ## Version History

package/SECURITY.md

@@ -2,4 +2,4 @@
 
 ## Reporting a Vulnerability
 
-Report all vulnerabilities under the [Security menu in the Cache-Data GitHub repository](https://github.com/chadkluck/npm-chadkluck-cache-data/security/advisories).
+Report all vulnerabilities under the [Security menu in the Cache-Data GitHub repository](https://github.com/63klabs/npm-cache-data/security/advisories).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@63klabs/cache-data",
-  "version": "1.2.2",
+  "version": "1.2.5",
   "description": "Cache data from an API endpoint or application process using AWS S3 and DynamoDb",
   "author": "Chad Leigh Kluck (https://chadkluck.me)",
   "license": "MIT",
@@ -17,7 +17,7 @@
   },
   "dependencies": {
     "aws-xray-sdk-core": "^3.6.0",
-    "moment-timezone": "^0.5.43",
+    "moment-timezone": "^0.6.0",
     "object-hash": "^3.0.0"
   },
   "devDependencies": {
@@ -30,7 +30,7 @@
     "chai-http": "^5.1.1",
     "lambda-tester": "^4.0.1",
     "mocha": "^11.1.0",
-    "sinon": "^20.0.0"
+    "sinon": "^21.0.0"
   },
   "scripts": {
     "test": "mocha 'test/**/*-tests.mjs'",
@@ -54,5 +54,5 @@
   "bugs": {
     "url": "https://github.com/63klabs/npm-cache-data/issues"
   },
-  "homepage": "https://github.com/chadkluck/npm-chadkluck-cache-data#readme"
+  "homepage": "https://github.com/63klabs/npm-cache-data#readme"
 }

package/src/lib/dao-cache.js

@@ -1054,14 +1054,14 @@ class Cache {
 	 * Sample param object:
 	 * @example
 	 * cache.Cache.init({
-	 *		dynamoDbTable: process.env.CacheData_DynamoDbTable,
-	 *		s3Bucket: process.env.CacheData_S3Bucket,
-	 *		secureDataAlgorithm: process.env.CacheData_CryptSecureDataAlgorithm,
+	 *		dynamoDbTable: process.env.CACHE_DATA_DYNAMO_DB_TABLE,
+	 *		s3Bucket: process.env.CACHE_DATA_S3_BUCKET,
+	 *		secureDataAlgorithm: process.env.CACHE_DATA_SECURE_DATA_ALGORITHM,
 	 *		secureDataKey: Buffer.from(params.app.crypt_secureDataKey, cache.Cache.CRYPT_ENCODING),
-	 *		idHashAlgorithm: process.env.CacheData_CryptIdHashAlgorithm,
-	 *		DynamoDbMaxCacheSize_kb: parseInt(process.env.CacheData_DynamoDb_maxCacheSize_kb, 10),
-	 *		purgeExpiredCacheEntriesAfterXHours: parseInt(process.env.CacheData_PurgeExpiredCacheEntriesAfterXHours, 10),
-	 * 		timeZoneForInterval: process.env.CacheData_TimeZoneForInterval // if caching on interval, we need a timezone to account for calculating hours, days, and weeks. List: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+	 *		idHashAlgorithm: process.env.CACHE_DATA_ID_HASH_ALGORITHM, // sha1, sha256, sha512, etc.
+	 *		DynamoDbMaxCacheSize_kb: parseInt(process.env.CACHE_DATA_DYNAMO_DB_MAX_CACHE_SIZE_KB, 10),
+	 *		purgeExpiredCacheEntriesAfterXHours: parseInt(process.env.CACHE_DATA_PURGE_EXPIRED_CACHE_ENTRIES_AFTER_X_HRS, 10),
+	 * 		timeZoneForInterval: process.env.CACHE_DATA_TIME_ZONE_FOR_INTERVAL // if caching on interval, we need a timezone to account for calculating hours, days, and weeks. List: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
 	 *	});
 	 * 
 	 * @param {Object} parameters

package/src/lib/tools/DebugAndLog.class.js

@@ -104,8 +104,8 @@ class DebugAndLog {
 	 * @returns {string} The current environment.
 	 */
 	static getEnv() {
-		var possibleVars = ["env", "deployEnvironment", "environment", "stage"]; // this is the application env, not the NODE_ENV
-		var env = DebugAndLog.PROD; // if env or deployEnvironment not set, fail to safe
+		var possibleVars = ["env", "deployEnvironment", "environment", "stage, deploy_environment"]; // this is the application env, not the NODE_ENV
+		var env = (process.env?.NODE_ENV === "development" ? DebugAndLog.DEV : DebugAndLog.PROD); // if env or deployEnvironment not set, fail to safe
 
 		if ( "env" in process ) {
 			for (let i in possibleVars) {

package/src/lib/tools/index.js

@@ -249,18 +249,18 @@ class _ConfigSuperClass {
 	 * let params = await this._initParameters(
 	 *  [
 	 *      {
-	 *          "group": "appone", // so we can do params.app.authOSTActionsUsername later
-	 *          "path": process.env.paramStorePath, // Lambda environment variable
+	 *          "group": "appone", // so we can do params.app.authUsername later
+	 *          "path": process.env.PARAM_STORE_PATH, // Lambda environment variable
 	 *          "names": [
-	 *              "authOSTActionsUsername",
-	 *              "authOSTActionsPassword",
-	 *              "authExLibrisAPIkey",
+	 *              "authUsername",
+	 *              "authPassword",
+	 *              "authAPIkey",
 	 *              "crypt_secureDataKey"
 	 *          ]
 	 *      }, // OR get all under a single path
 	 *      {
-	 *          "group": "app", // so we can do params.app.authOSTActionsUsername later
-	 *          "path": process.env.paramStorePath // Lambda environment variable
+	 *          "group": "app", // so we can do params.app.authUsername later
+	 *          "path": process.env.PARAM_STORE_PATH // Lambda environment variable
 	 *      }
 	 *  ]
 	 * );

package/src/lib/tools/vars.js

@@ -22,7 +22,7 @@ const nodeVerMinor = AWS.NODE_VER_MINOR;
 const nodeVerMajorMinor = AWS.NODE_VER_MAJOR_MINOR;
 
 if (nodeVerMajor < 16) {
-	console.error(`Node.js version 16 or higher is required for @chadkluck/cache-data. Version ${nodeVer} detected. Please install at least Node version 16 (>18 preferred) in your environment.`);
+	console.error(`Node.js version 16 or higher is required for @63klabs/cache-data. Version ${nodeVer} detected. Please install at least Node version 16 (>18 preferred) in your environment.`);
 	process.exit(1);
 }