quidproquo-actionprocessor-awslambda 0.0.234 → 0.0.235

package/lib/commonjs/getActionProcessor/core/file/getFileIsColdStorageActionProcessor.d.ts

@@ -0,0 +1,2 @@
+import { ActionProcessorListResolver } from 'quidproquo-core';
+export declare const getFileIsColdStorageActionProcessor: ActionProcessorListResolver;

package/lib/commonjs/getActionProcessor/core/file/getFileIsColdStorageActionProcessor.js

@@ -0,0 +1,29 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFileIsColdStorageActionProcessor = void 0;
+const quidproquo_config_aws_1 = require("quidproquo-config-aws");
+const quidproquo_core_1 = require("quidproquo-core");
+const getObjectStorageClass_1 = require("../../../logic/s3/getObjectStorageClass");
+const utils_1 = require("./utils");
+const getProcessFileIsColdStorage = (qpqConfig) => {
+    return ({ drive, filepath }) => __awaiter(void 0, void 0, void 0, function* () {
+        const s3BucketName = (0, utils_1.resolveStorageDriveBucketName)(drive, qpqConfig);
+        const isColdStorage = (yield (0, getObjectStorageClass_1.getObjectStorageClass)(s3BucketName, filepath, quidproquo_config_aws_1.qpqConfigAwsUtils.getApplicationModuleDeployRegion(qpqConfig))) === 'cold_storage';
+        return (0, quidproquo_core_1.actionResult)(isColdStorage);
+    });
+};
+const getFileIsColdStorageActionProcessor = (qpqConfig) => __awaiter(void 0, void 0, void 0, function* () {
+    return ({
+        [quidproquo_core_1.FileActionType.IsColdStorage]: getProcessFileIsColdStorage(qpqConfig),
+    });
+});
+exports.getFileIsColdStorageActionProcessor = getFileIsColdStorageActionProcessor;

package/lib/commonjs/getActionProcessor/core/file/getFileReadTextContentsActionProcessor.js

@@ -16,8 +16,15 @@ const s3Utils_1 = require("../../../logic/s3/s3Utils");
 const utils_1 = require("./utils");
 const getProcessFileReadTextContents = (qpqConfig) => {
     return ({ drive, filepath }) => __awaiter(void 0, void 0, void 0, function* () {
-        const s3BucketName = (0, utils_1.resolveStorageDriveBucketName)(drive, qpqConfig);
-        return (0, quidproquo_core_1.actionResult)(yield (0, s3Utils_1.readTextFile)(s3BucketName, filepath, quidproquo_config_aws_1.qpqConfigAwsUtils.getApplicationModuleDeployRegion(qpqConfig)));
+        try {
+            const s3BucketName = (0, utils_1.resolveStorageDriveBucketName)(drive, qpqConfig);
+            return (0, quidproquo_core_1.actionResult)(yield (0, s3Utils_1.readTextFile)(s3BucketName, filepath, quidproquo_config_aws_1.qpqConfigAwsUtils.getApplicationModuleDeployRegion(qpqConfig)));
+        }
+        catch (error) {
+            return (0, quidproquo_core_1.actionResultErrorFromCaughtError)(error, {
+                InvalidObjectState: () => (0, quidproquo_core_1.actionResultError)(quidproquo_core_1.FileReadTextContentsErrorTypeEnum.InvalidStorageClass, 'File is in the wrong storage class'),
+            });
+        }
     });
 };
 const getFileReadTextContentsActionProcessor = (qpqConfig) => __awaiter(void 0, void 0, void 0, function* () {

package/lib/commonjs/getActionProcessor/core/file/index.js

@@ -13,12 +13,13 @@ exports.getFileActionProcessor = void 0;
 const getFileDeleteActionProcessor_1 = require("./getFileDeleteActionProcessor");
 const getFileExistsActionProcessor_1 = require("./getFileExistsActionProcessor");
 const getFileGenerateTemporarySecureUrlActionProcessor_1 = require("./getFileGenerateTemporarySecureUrlActionProcessor");
+const getFileIsColdStorageActionProcessor_1 = require("./getFileIsColdStorageActionProcessor");
 const getFileListDirectoryActionProcessor_1 = require("./getFileListDirectoryActionProcessor");
 const getFileReadBinaryContentsActionProcessor_1 = require("./getFileReadBinaryContentsActionProcessor");
 const getFileReadTextContentsActionProcessor_1 = require("./getFileReadTextContentsActionProcessor");
 const getFileWriteBinaryContentsActionProcessor_1 = require("./getFileWriteBinaryContentsActionProcessor");
 const getFileWriteTextContentsActionProcessor_1 = require("./getFileWriteTextContentsActionProcessor");
 const getFileActionProcessor = (qpqConfig, dynamicModuleLoader) => __awaiter(void 0, void 0, void 0, function* () {
-    return (Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, (yield (0, getFileDeleteActionProcessor_1.getFileDeleteActionProcessor)(qpqConfig, dynamicModuleLoader))), (yield (0, getFileExistsActionProcessor_1.getFileExistsActionProcessor)(qpqConfig, dynamicModuleLoader))), (yield (0, getFileGenerateTemporarySecureUrlActionProcessor_1.getFileGenerateTemporarySecureUrlActionProcessor)(qpqConfig, dynamicModuleLoader))), (yield (0, getFileListDirectoryActionProcessor_1.getFileListDirectoryActionProcessor)(qpqConfig, dynamicModuleLoader))), (yield (0, getFileReadTextContentsActionProcessor_1.getFileReadTextContentsActionProcessor)(qpqConfig, dynamicModuleLoader))), (yield (0, getFileWriteTextContentsActionProcessor_1.getFileWriteTextContentsActionProcessor)(qpqConfig, dynamicModuleLoader))), (yield (0, getFileReadBinaryContentsActionProcessor_1.getFileReadBinaryContentsActionProcessor)(qpqConfig, dynamicModuleLoader))), (yield (0, getFileWriteBinaryContentsActionProcessor_1.getFileWriteBinaryContentsActionProcessor)(qpqConfig, dynamicModuleLoader))));
+    return (Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, (yield (0, getFileDeleteActionProcessor_1.getFileDeleteActionProcessor)(qpqConfig, dynamicModuleLoader))), (yield (0, getFileExistsActionProcessor_1.getFileExistsActionProcessor)(qpqConfig, dynamicModuleLoader))), (yield (0, getFileGenerateTemporarySecureUrlActionProcessor_1.getFileGenerateTemporarySecureUrlActionProcessor)(qpqConfig, dynamicModuleLoader))), (yield (0, getFileIsColdStorageActionProcessor_1.getFileIsColdStorageActionProcessor)(qpqConfig, dynamicModuleLoader))), (yield (0, getFileListDirectoryActionProcessor_1.getFileListDirectoryActionProcessor)(qpqConfig, dynamicModuleLoader))), (yield (0, getFileReadTextContentsActionProcessor_1.getFileReadTextContentsActionProcessor)(qpqConfig, dynamicModuleLoader))), (yield (0, getFileWriteTextContentsActionProcessor_1.getFileWriteTextContentsActionProcessor)(qpqConfig, dynamicModuleLoader))), (yield (0, getFileReadBinaryContentsActionProcessor_1.getFileReadBinaryContentsActionProcessor)(qpqConfig, dynamicModuleLoader))), (yield (0, getFileWriteBinaryContentsActionProcessor_1.getFileWriteBinaryContentsActionProcessor)(qpqConfig, dynamicModuleLoader))));
 });
 exports.getFileActionProcessor = getFileActionProcessor;

package/lib/commonjs/logic/s3/getObjectStorageClass.d.ts

@@ -0,0 +1 @@
+export declare const getObjectStorageClass: (bucketName: string, key: string, region: string) => Promise<'cold_storage' | 'standard'>;

package/lib/commonjs/logic/s3/getObjectStorageClass.js

@@ -0,0 +1,39 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getObjectStorageClass = void 0;
+const client_s3_1 = require("@aws-sdk/client-s3");
+const createAwsClient_1 = require("../createAwsClient");
+const getObjectStorageClass = (bucketName, key, region) => __awaiter(void 0, void 0, void 0, function* () {
+    const s3Client = (0, createAwsClient_1.createAwsClient)(client_s3_1.S3Client, { region });
+    const response = yield s3Client.send(new client_s3_1.HeadObjectCommand({
+        Key: key,
+        Bucket: bucketName,
+    }));
+    // Map AWS StorageClass to our custom labels
+    switch (response.StorageClass) {
+        case 'GLACIER':
+        case 'GLACIER_IR':
+        case 'DEEP_ARCHIVE':
+        case 'ONEZONE_IA':
+        case 'EXPRESS_ONEZONE':
+        case 'OUTPOSTS':
+        case 'SNOW':
+            return 'cold_storage';
+        case 'STANDARD_IA':
+        case 'STANDARD':
+        case 'INTELLIGENT_TIERING':
+        case 'REDUCED_REDUNDANCY':
+        default:
+            return 'standard';
+    }
+});
+exports.getObjectStorageClass = getObjectStorageClass;

package/lib/esm/getActionProcessor/core/file/getFileIsColdStorageActionProcessor.d.ts

@@ -0,0 +1,2 @@
+import { ActionProcessorListResolver } from 'quidproquo-core';
+export declare const getFileIsColdStorageActionProcessor: ActionProcessorListResolver;

package/lib/esm/getActionProcessor/core/file/getFileIsColdStorageActionProcessor.js

@@ -0,0 +1,14 @@
+import { qpqConfigAwsUtils } from 'quidproquo-config-aws';
+import { actionResult, FileActionType, } from 'quidproquo-core';
+import { getObjectStorageClass } from '../../../logic/s3/getObjectStorageClass';
+import { resolveStorageDriveBucketName } from './utils';
+const getProcessFileIsColdStorage = (qpqConfig) => {
+    return async ({ drive, filepath }) => {
+        const s3BucketName = resolveStorageDriveBucketName(drive, qpqConfig);
+        const isColdStorage = (await getObjectStorageClass(s3BucketName, filepath, qpqConfigAwsUtils.getApplicationModuleDeployRegion(qpqConfig))) === 'cold_storage';
+        return actionResult(isColdStorage);
+    };
+};
+export const getFileIsColdStorageActionProcessor = async (qpqConfig) => ({
+    [FileActionType.IsColdStorage]: getProcessFileIsColdStorage(qpqConfig),
+});

package/lib/esm/getActionProcessor/core/file/getFileReadTextContentsActionProcessor.js

@@ -1,11 +1,18 @@
 import { qpqConfigAwsUtils } from 'quidproquo-config-aws';
-import { actionResult, FileActionType, } from 'quidproquo-core';
+import { actionResult, actionResultError, actionResultErrorFromCaughtError, FileActionType, FileReadTextContentsErrorTypeEnum, } from 'quidproquo-core';
 import { readTextFile } from '../../../logic/s3/s3Utils';
 import { resolveStorageDriveBucketName } from './utils';
 const getProcessFileReadTextContents = (qpqConfig) => {
     return async ({ drive, filepath }) => {
-        const s3BucketName = resolveStorageDriveBucketName(drive, qpqConfig);
-        return actionResult(await readTextFile(s3BucketName, filepath, qpqConfigAwsUtils.getApplicationModuleDeployRegion(qpqConfig)));
+        try {
+            const s3BucketName = resolveStorageDriveBucketName(drive, qpqConfig);
+            return actionResult(await readTextFile(s3BucketName, filepath, qpqConfigAwsUtils.getApplicationModuleDeployRegion(qpqConfig)));
+        }
+        catch (error) {
+            return actionResultErrorFromCaughtError(error, {
+                InvalidObjectState: () => actionResultError(FileReadTextContentsErrorTypeEnum.InvalidStorageClass, 'File is in the wrong storage class'),
+            });
+        }
     };
 };
 export const getFileReadTextContentsActionProcessor = async (qpqConfig) => ({

package/lib/esm/getActionProcessor/core/file/index.js

@@ -1,6 +1,7 @@
 import { getFileDeleteActionProcessor } from './getFileDeleteActionProcessor';
 import { getFileExistsActionProcessor } from './getFileExistsActionProcessor';
 import { getFileGenerateTemporarySecureUrlActionProcessor } from './getFileGenerateTemporarySecureUrlActionProcessor';
+import { getFileIsColdStorageActionProcessor } from './getFileIsColdStorageActionProcessor';
 import { getFileListDirectoryActionProcessor } from './getFileListDirectoryActionProcessor';
 import { getFileReadBinaryContentsActionProcessor } from './getFileReadBinaryContentsActionProcessor';
 import { getFileReadTextContentsActionProcessor } from './getFileReadTextContentsActionProcessor';
@@ -10,6 +11,7 @@ export const getFileActionProcessor = async (qpqConfig, dynamicModuleLoader) =>
     ...(await getFileDeleteActionProcessor(qpqConfig, dynamicModuleLoader)),
     ...(await getFileExistsActionProcessor(qpqConfig, dynamicModuleLoader)),
     ...(await getFileGenerateTemporarySecureUrlActionProcessor(qpqConfig, dynamicModuleLoader)),
+    ...(await getFileIsColdStorageActionProcessor(qpqConfig, dynamicModuleLoader)),
     ...(await getFileListDirectoryActionProcessor(qpqConfig, dynamicModuleLoader)),
     ...(await getFileReadTextContentsActionProcessor(qpqConfig, dynamicModuleLoader)),
     ...(await getFileWriteTextContentsActionProcessor(qpqConfig, dynamicModuleLoader)),

package/lib/esm/logic/s3/getObjectStorageClass.d.ts

@@ -0,0 +1 @@
+export declare const getObjectStorageClass: (bucketName: string, key: string, region: string) => Promise<'cold_storage' | 'standard'>;

package/lib/esm/logic/s3/getObjectStorageClass.js

@@ -0,0 +1,26 @@
+import { HeadObjectCommand, S3Client } from '@aws-sdk/client-s3';
+import { createAwsClient } from '../createAwsClient';
+export const getObjectStorageClass = async (bucketName, key, region) => {
+    const s3Client = createAwsClient(S3Client, { region });
+    const response = await s3Client.send(new HeadObjectCommand({
+        Key: key,
+        Bucket: bucketName,
+    }));
+    // Map AWS StorageClass to our custom labels
+    switch (response.StorageClass) {
+        case 'GLACIER':
+        case 'GLACIER_IR':
+        case 'DEEP_ARCHIVE':
+        case 'ONEZONE_IA':
+        case 'EXPRESS_ONEZONE':
+        case 'OUTPOSTS':
+        case 'SNOW':
+            return 'cold_storage';
+        case 'STANDARD_IA':
+        case 'STANDARD':
+        case 'INTELLIGENT_TIERING':
+        case 'REDUCED_REDUNDANCY':
+        default:
+            return 'standard';
+    }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quidproquo-actionprocessor-awslambda",
-  "version": "0.0.234",
+  "version": "0.0.235",
   "description": "",
   "main": "./lib/commonjs/index.js",
   "module": "./lib/esm/index.js",
@@ -55,9 +55,9 @@
     "lodash": "^4.17.21",
     "node-cache": "^5.1.2",
     "node-match-path": "^0.6.3",
-    "quidproquo-config-aws": "0.0.234",
-    "quidproquo-core": "0.0.234",
-    "quidproquo-webserver": "0.0.234"
+    "quidproquo-config-aws": "0.0.235",
+    "quidproquo-core": "0.0.235",
+    "quidproquo-webserver": "0.0.235"
   },
   "devDependencies": {
     "@types/aws-lambda": "^8.10.109",
@@ -65,7 +65,7 @@
     "@types/jsonwebtoken": "^9.0.2",
     "@types/lodash": "^4.14.194",
     "@types/node": "^18.11.9",
-    "quidproquo-tsconfig": "0.0.234",
+    "quidproquo-tsconfig": "0.0.235",
     "typescript": "^4.9.3"
   }
 }