@63klabs/cache-data 1.2.3 → 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

@@ -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
+
+          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)
-          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
-
+          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 --
 
@@ -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
 						}
 					]
 				);
@@ -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
 						}
 					]
 				);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@63klabs/cache-data",
-  "version": "1.2.3",
+  "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
 	 *      }
 	 *  ]
 	 * );