SK-2134 include file path and file object in request response

* SK-2134 include file path and file object in request response (#232)

* [AUTOMATED] Private Release 2.1.0-beta.1-dev.981921e

* SK-2134 include file path and file object in request response

* [AUTOMATED] Private Release 2.1.0-beta.1-dev.84fb37c

* SK-2134 throw error when both file and filepath are provided (#234)

* [AUTOMATED] Private Release 2.1.0-beta.1-dev.58e3761

* SK-2134 change error message and file input type

* SK-2134 change error message and file input type

* [AUTOMATED] Private Release 2.1.0-beta.1-dev.956e5c7

---------

Co-authored-by: skyflow-shravan <skyflow-shravan@users.noreply.github.com>

Author: skyflow-shravan

package.json

@@ -1,6 +1,6 @@
 {
   "name": "skyflow-node",
-  "version": "2.1.0-beta.1",
+  "version": "2.1.0-beta.1-dev.956e5c7",
   "description": "Skyflow SDK for Node.js",
   "main": "./lib/index.js",
   "module": "./lib/index.js",

src/error/codes/index.ts

@@ -16,7 +16,7 @@ const SKYFLOW_ERROR_CODE = {
     INVALID_BEARER_TOKEN: { http_code: 400, message: errorMessages.INVALID_BEARER_TOKEN },
     INVALID_PARSED_CREDENTIALS_STRING: { http_code: 400, message: errorMessages.INVALID_PARSED_CREDENTIALS_STRING },
     INVALID_API_KEY: { http_code: 400, message: errorMessages.INVALID_API_KEY },
-    INVALID_FILE_PATH: { http_code: 400, message: errorMessages.INVALID_FILE_PATH },
+    INVALID_CREDENTIALS_FILE_PATH: { http_code: 400, message: errorMessages.INVALID_CREDENTIALS_FILE_PATH },
 
     INVALID_BEARER_TOKEN_WITH_ID: { http_code: 400, message: errorMessages.INVALID_BEARER_TOKEN_WITH_ID },
     INVALID_PARSED_CREDENTIALS_STRING_WITH_ID: { http_code: 400, message: errorMessages.INVALID_PARSED_CREDENTIALS_STRING_WITH_ID },
@@ -204,6 +204,7 @@ const SKYFLOW_ERROR_CODE = {
     INVALID_PLAIN_TEXT_ENTITIES_IN_REIDENTIFY: { http_code: 400, message: errorMessages.INVALID_PLAIN_TEXT_ENTITIES_IN_REIDENTIFY },
 
     INVALID_DEIDENTIFY_FILE_REQUEST: { http_code: 400, message: errorMessages.INVALID_DEIDENTIFY_FILE_REQUEST },
+    INVALID_DEIDENTIFY_FILE_INPUT: { http_code: 400, message: errorMessages.INVALID_DEIDENTIFY_FILE_INPUT },
     EMPTY_FILE_OBJECT:{ http_code: 400, message: errorMessages.EMPTY_FILE_OBJECT },
     INVALID_FILE_FORMAT: { http_code: 400, message: errorMessages.INVALID_FILE_FORMAT },
     MISSING_FILE_SOURCE: { http_code: 400, message: errorMessages.MISSING_FILE_SOURCE },
@@ -220,6 +221,7 @@ const SKYFLOW_ERROR_CODE = {
     INVALID_BLEEP:{ http_code: 400, message: errorMessages.INVALID_BLEEP },
     INVALID_FILE_OR_ENCODED_FILE:{ http_code: 400, message: errorMessages.INVALID_FILE_OR_ENCODED_FILE },
     INVALID_FILE_TYPE:{ http_code: 400, message: errorMessages.INVALID_FILE_TYPE },
+    INVALID_DEIDENTIFY_FILE_PATH:{ http_code: 400, message: errorMessages.INVALID_DEIDENTIFY_FILE_PATH },
     FILE_READ_ERROR:{ http_code: 400, message: errorMessages.FILE_READ_ERROR },
     INVALID_BASE64_HEADER:{ http_code: 400, message: errorMessages.INVALID_BASE64_HEADER },
     INVALID_WAIT_TIME:{ http_code: 400, message: errorMessages.INVALID_WAIT_TIME },

src/error/messages/index.ts

@@ -21,7 +21,7 @@ const errorMessages = {
     EMPTY_CREDENTIAL_FILE_PATH: `${errorPrefix} Initialization failed. Invalid credentials. Specify a valid file path.`,
     INVALID_CREDENTIAL_FILE_PATH: `${errorPrefix} Initialization failed. Invalid credentials. Expected file path to be a string.`,
 
-    INVALID_FILE_PATH: `${errorPrefix} Initialization failed. Invalid skyflow credentials. Expected file path to exists.`,
+    INVALID_CREDENTIALS_FILE_PATH: `${errorPrefix} Initialization failed. Invalid skyflow credentials. Expected file path to exists.`,
     INVALID_API_KEY: `${errorPrefix} Initialization failed. Invalid skyflow credentials. Specify a valid api key.`,
     INVALID_PARSED_CREDENTIALS_STRING: `${errorPrefix} Initialization failed. Invalid skyflow credentials. Specify a valid credentials string.`,
     INVALID_BEARER_TOKEN: `${errorPrefix} Initialization failed. Invalid skyflow credentials. Specify a valid token.`,
@@ -210,6 +210,7 @@ const errorMessages = {
     INVALID_PLAIN_TEXT_ENTITIES_IN_REIDENTIFY: `${errorPrefix} Validation error. The plainTextEntities field must be an array of DetectEntities enums. Specify a valid plainTextEntities.`,
 
     INVALID_DEIDENTIFY_FILE_REQUEST: `${errorPrefix} Validation error. Invalid deidentify file request. Specify a valid deidentify file request.`,
+    INVALID_DEIDENTIFY_FILE_INPUT: `${errorPrefix} Validation error. Invalid deidentify file input. Please provide either a file or a file path.`,
     EMPTY_FILE_OBJECT: `${errorPrefix} Validation error. File object cannot be empty. Specify a valid file object.`,
     INVALID_FILE_FORMAT: `${errorPrefix} Validation error. Invalid file format. Specify a valid file format.`,
     MISSING_FILE_SOURCE: `${errorPrefix} Validation error. Provide exactly one of filePath, base64, or fileObject.`,
@@ -232,6 +233,7 @@ const errorMessages = {
     INVALID_BLEEP: `${errorPrefix} Validation error. Invalid bleep. Specify valid bleep as object.`,
     INVALID_FILE_OR_ENCODED_FILE: `${errorPrefix} . Error while decoding base64 and saving file`,
     INVALID_FILE_TYPE : `${errorPrefix} Validation error. Invalid file type. Specify a valid file type.`,
+    INVALID_DEIDENTIFY_FILE_PATH: `${errorPrefix} Validation error. Invalid file path. Specify a valid file path.`,
     INVALID_FILE_NAME: `${errorPrefix} Validation error. Invalid file name. Specify a valid file name.`,
     FILE_READ_ERROR: `${errorPrefix} Validation error. Unable to read file. Verify the file path.`, 
     INVALID_BASE64_HEADER: `${errorPrefix} Validation error. Invalid base64 header. Specify a valid base64 header.`,

src/index.ts

@@ -28,7 +28,7 @@ import UpdateResponse from './vault/model/response/update';
 import FileUploadResponse from './vault/model/response/file-upload';
 import QueryResponse from './vault/model/response/query';
 import InvokeConnectionResponse from './vault/model/response/invoke/invoke';
-import { SkyflowConfig, TokenizeRequestType, DetokenizeData, InsertResponseType, GetResponseData, QueryResponseType, IndexRange } from './vault/types';
+import { SkyflowConfig, TokenizeRequestType, DetokenizeData, InsertResponseType, GetResponseData, QueryResponseType, IndexRange, FileInput, StringKeyValueMapType } from './vault/types';
 import VaultConfig from './vault/config/vault';
 import SkyflowError from './error';
 import ConnectionConfig from './vault/config/connection';
@@ -119,5 +119,7 @@ export {
     InsertResponseType,
     GetResponseData,
     QueryResponseType,
-    IndexRange
+    IndexRange,
+    StringKeyValueMapType,
+    FileInput
 };

src/utils/validations/index.ts

@@ -290,7 +290,7 @@ export const validateSkyflowCredentials = (credentials: Credentials, logLevel: L
         const pathCred = credentials as PathCredentials;
         if (typeof pathCred.path !== 'string' || !isValidPath(pathCred.path)) {
             printLog(logs.errorLogs.EMPTY_CREDENTIALS_PATH, MessageType.ERROR, logLevel);
-            throw new SkyflowError(SKYFLOW_ERROR_CODE.INVALID_FILE_PATH);
+            throw new SkyflowError(SKYFLOW_ERROR_CODE.INVALID_CREDENTIALS_FILE_PATH);
         }
         if (pathCred.roles !== undefined && !Array.isArray(pathCred.roles)) {
             throw new SkyflowError(SKYFLOW_ERROR_CODE.INVALID_ROLES_KEY_TYPE);
@@ -1057,25 +1057,37 @@ export const validateDeidentifyFileRequest = (deidentifyFileRequest: DeidentifyF
         throw new SkyflowError(SKYFLOW_ERROR_CODE.INVALID_DEIDENTIFY_FILE_REQUEST);
     }
 
-    // Validate file object
-    const file = deidentifyFileRequest.getFile();
+    const fileType = deidentifyFileRequest.getFile();
 
-    // Check if the file is a valid File (browser) or Buffer (Node.js)
-    if (!(file instanceof File)) {
-        throw new SkyflowError(SKYFLOW_ERROR_CODE.INVALID_FILE_TYPE);
+    const hasFile = 'file' in fileType && fileType.file;
+    const hasFilePath = 'filePath' in fileType && fileType.filePath;
+
+    // Must provide exactly one of file or filePath
+    if ((hasFile && hasFilePath) || (!hasFile && !hasFilePath)) {
+        throw new SkyflowError(SKYFLOW_ERROR_CODE.INVALID_DEIDENTIFY_FILE_INPUT);
     }
 
-    // Additional validation for File
-    if (file instanceof File) {
+    if (hasFile) {
+        const file = fileType.file;
+        if (!(file instanceof File)) {
+            throw new SkyflowError(SKYFLOW_ERROR_CODE.INVALID_FILE_TYPE);
+        }
         if (!file.name || typeof file.name !== 'string' || file.name.trim().length === 0) {
             throw new SkyflowError(SKYFLOW_ERROR_CODE.INVALID_FILE_TYPE);
         }
-        // Validate fileBaseName
         const fileBaseName = path.parse(file.name).name;
         if (!fileBaseName || typeof fileBaseName !== 'string' || fileBaseName.trim().length === 0) {
             throw new SkyflowError(SKYFLOW_ERROR_CODE.INVALID_FILE_TYPE);
         }
-  }
+    } else if (hasFilePath) {
+        const filePath = fileType.filePath;
+        if (typeof filePath !== 'string' || filePath.trim().length === 0) {
+            throw new SkyflowError(SKYFLOW_ERROR_CODE.INVALID_DEIDENTIFY_FILE_PATH);
+        }
+        if (!fs.existsSync(filePath) || !fs.lstatSync(filePath).isFile()) {
+            throw new SkyflowError(SKYFLOW_ERROR_CODE.INVALID_DEIDENTIFY_FILE_PATH);
+        }
+    }
 
     // Validate options if provided
     if (deidentifyFileOptions) {