@yamato-daiwa/es-extensions-nodejs 1.5.1 → 1.6.0-alpha.0

package/Distributable/Errors/DesiredFileActuallyIsDirectoryError/DesiredFileActuallyIsDirectoryError.d.ts

@@ -0,0 +1,21 @@
+declare class DesiredFileActuallyIsDirectoryError extends Error {
+    static readonly NAME: string;
+    static localization: DesiredFileActuallyIsDirectoryError.Localization;
+    constructor(namedParameters: DesiredFileActuallyIsDirectoryError.ConstructorNamedParameters);
+}
+declare namespace DesiredFileActuallyIsDirectoryError {
+    type ConstructorNamedParameters = Localization.DescriptionTemplateNamedParameters | Readonly<{
+        customMessage: string;
+    }>;
+    type Localization = Readonly<{
+        defaultTitle: string;
+        genericDescription: (namedParameters: Localization.DescriptionTemplateNamedParameters) => string;
+    }>;
+    namespace Localization {
+        type DescriptionTemplateNamedParameters = Readonly<{
+            targetPath: string;
+            messageSpecificPart?: string;
+        }>;
+    }
+}
+export default DesiredFileActuallyIsDirectoryError;

package/Distributable/Errors/DesiredFileActuallyIsDirectoryError/DesiredFileActuallyIsDirectoryError.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const DesiredFileActuallyIsDirectoryErrorLocalization_english_1 = __importDefault(require("./DesiredFileActuallyIsDirectoryErrorLocalization.english"));
+class DesiredFileActuallyIsDirectoryError extends Error {
+    constructor(namedParameters) {
+        super();
+        this.name = DesiredFileActuallyIsDirectoryError.NAME;
+        if ("customMessage" in namedParameters) {
+            this.message = namedParameters.customMessage;
+        }
+        else {
+            this.message = DesiredFileActuallyIsDirectoryError.localization.genericDescription(namedParameters);
+        }
+    }
+}
+DesiredFileActuallyIsDirectoryError.NAME = "DesiredFileActuallyIsDirectoryError";
+DesiredFileActuallyIsDirectoryError.localization = DesiredFileActuallyIsDirectoryErrorLocalization_english_1.default;
+exports.default = DesiredFileActuallyIsDirectoryError;

package/Distributable/Errors/DesiredFileActuallyIsDirectoryError/DesiredFileActuallyIsDirectoryErrorLocalization.english.d.ts

@@ -0,0 +1,3 @@
+import type DesiredFileActuallyIsDirectoryError from "./DesiredFileActuallyIsDirectoryError";
+declare const DesiredFileActuallyIsDirectoryErrorLocalization__English: DesiredFileActuallyIsDirectoryError.Localization;
+export default DesiredFileActuallyIsDirectoryErrorLocalization__English;

package/Distributable/Errors/DesiredFileActuallyIsDirectoryError/DesiredFileActuallyIsDirectoryErrorLocalization.english.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const es_extensions_1 = require("@yamato-daiwa/es-extensions");
+const DesiredFileActuallyIsDirectoryErrorLocalization__English = {
+    defaultTitle: "Desired file actually is the directory",
+    genericDescription: (namedParameters) => `Contrary to expectations, path '${namedParameters.targetPath}' refers to directory, not file.` +
+        `${(0, es_extensions_1.insertSubstring)(namedParameters.messageSpecificPart, {
+            modifier: (messageSpecificPart) => `\n${messageSpecificPart}`
+        })}`
+};
+exports.default = DesiredFileActuallyIsDirectoryErrorLocalization__English;

package/Distributable/Errors/FileNotFoundError/FileNotFoundError.d.ts

@@ -0,0 +1,21 @@
+declare class FileNotFoundError extends Error {
+    static readonly NAME: string;
+    static localization: FileNotFoundError.Localization;
+    constructor(namedParameters: FileNotFoundError.ConstructorNamedParameters);
+}
+declare namespace FileNotFoundError {
+    type ConstructorNamedParameters = Localization.DescriptionTemplateNamedParameters | Readonly<{
+        customMessage: string;
+    }>;
+    type Localization = Readonly<{
+        readonly defaultTitle: string;
+        readonly genericDescription: (namedParameters: Localization.DescriptionTemplateNamedParameters) => string;
+    }>;
+    namespace Localization {
+        type DescriptionTemplateNamedParameters = Readonly<{
+            filePath: string;
+            messageSpecificPart?: string;
+        }>;
+    }
+}
+export default FileNotFoundError;

package/Distributable/Errors/FileNotFoundError/FileNotFoundError.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const FileNotFoundErrorLocalization_english_1 = __importDefault(require("./FileNotFoundErrorLocalization.english"));
+class FileNotFoundError extends Error {
+    constructor(namedParameters) {
+        super();
+        this.name = FileNotFoundError.NAME;
+        if ("customMessage" in namedParameters) {
+            this.message = namedParameters.customMessage;
+        }
+        else {
+            this.message = FileNotFoundError.localization.genericDescription(namedParameters);
+        }
+    }
+}
+FileNotFoundError.NAME = "FileNotFoundError";
+FileNotFoundError.localization = FileNotFoundErrorLocalization_english_1.default;
+exports.default = FileNotFoundError;

package/Distributable/Errors/FileNotFoundError/FileNotFoundErrorLocalization.english.d.ts

@@ -0,0 +1,3 @@
+import type FileNotFoundError from "./FileNotFoundError";
+declare const FileNotFoundErrorLocalization__English: FileNotFoundError.Localization;
+export default FileNotFoundErrorLocalization__English;

package/Distributable/Errors/FileNotFoundError/FileNotFoundErrorLocalization.english.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const es_extensions_1 = require("@yamato-daiwa/es-extensions");
+const FileNotFoundErrorLocalization__English = {
+    defaultTitle: "File not found error",
+    genericDescription: (parametersObject) => `File with path '${parametersObject.filePath}' not found.` +
+        `${(0, es_extensions_1.insertSubstring)(parametersObject.messageSpecificPart, {
+            modifier: (messageSpecificPart) => `\n${messageSpecificPart}`
+        })}`
+};
+exports.default = FileNotFoundErrorLocalization__English;

package/Distributable/Errors/InterProcessInteractionFailed/InterProcessInteractionFailedError.d.ts

@@ -4,8 +4,8 @@ declare class InterProcessInteractionFailedError extends Error {
     constructor(message: string);
 }
 declare namespace InterProcessInteractionFailedError {
-    type Localization = {
-        readonly defaultTitle: string;
-    };
+    type Localization = Readonly<{
+        defaultTitle: string;
+    }>;
 }
 export default InterProcessInteractionFailedError;

package/Distributable/Errors/InvalidConsoleCommand/InvalidConsoleCommandError.d.ts

@@ -7,15 +7,15 @@ declare namespace InvalidConsoleCommandError {
     type ConstructorParametersObject = Localization.DescriptionTemplateNamedParameters | {
         readonly customMessage: string;
     };
-    type Localization = {
-        readonly defaultTitle: string;
-        readonly generateDescription: (parametersObject: Localization.DescriptionTemplateNamedParameters) => string;
-    };
+    type Localization = Readonly<{
+        defaultTitle: string;
+        generateDescription: (namedParameters: Localization.DescriptionTemplateNamedParameters) => string;
+    }>;
     namespace Localization {
-        type DescriptionTemplateNamedParameters = {
-            readonly applicationName: string;
-            readonly messageSpecificPart?: string;
-        };
+        type DescriptionTemplateNamedParameters = Readonly<{
+            applicationName: string;
+            messageSpecificPart?: string;
+        }>;
     }
 }
 export default InvalidConsoleCommandError;

package/Distributable/ObjectDataFilesProcessor/ObjectDataFilesProcessor.d.ts

@@ -0,0 +1,17 @@
+import { RawObjectDataProcessor } from "@yamato-daiwa/es-extensions";
+import type { ArbitraryObject } from "@yamato-daiwa/es-extensions";
+declare class ObjectDataFilesProcessor {
+    static processFile<ValidData extends ArbitraryObject>(namedParameters: {
+        filePath: string;
+        validDataSpecification: RawObjectDataProcessor.ObjectDataSpecification;
+        schema?: ObjectDataFilesProcessor.SupportedSchemas;
+    }): ValidData;
+}
+declare namespace ObjectDataFilesProcessor {
+    enum SupportedSchemas {
+        JSON = "JSON",
+        YAML = "YAML",
+        DOTENV = "DOTENV"
+    }
+}
+export default ObjectDataFilesProcessor;

package/Distributable/ObjectDataFilesProcessor/ObjectDataFilesProcessor.js

@@ -0,0 +1,167 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const yamljs_1 = __importDefault(require("yamljs"));
+const dotenv_1 = __importDefault(require("dotenv"));
+const es_extensions_1 = require("@yamato-daiwa/es-extensions");
+const isErrnoException_1 = __importDefault(require("../isErrnoException"));
+const FileNotFoundError_1 = __importDefault(require("../Errors/FileNotFoundError/FileNotFoundError"));
+const DesiredFileActuallyIsDirectoryError_1 = __importDefault(require("../Errors/DesiredFileActuallyIsDirectoryError/DesiredFileActuallyIsDirectoryError"));
+const Path = __importStar(require("path"));
+class ObjectDataFilesProcessor {
+    static processFile(namedParameters) {
+        const filePath = namedParameters.filePath;
+        let dataSchema;
+        if ((0, es_extensions_1.isNotUndefined)(namedParameters.schema)) {
+            dataSchema = namedParameters.schema;
+        }
+        else {
+            const fileNameLastExtensionWithLeadingPeriod = Path.extname(filePath);
+            if (fileNameLastExtensionWithLeadingPeriod.length === 0) {
+                es_extensions_1.Logger.throwErrorAndLog({
+                    errorInstance: new es_extensions_1.InvalidParameterValueError({
+                        parameterName: "namedParameters.filePath",
+                        messageSpecificPart: "Unable to decide the data parsing algorithm because target file " +
+                            `'${namedParameters.filePath}' has no explicit filename extension. If it is intentional, ` +
+                            "specify 'namedParameters.dataSchema' with desired element of 'ObjectDataFilesProcessor.SupportedSchemas'" +
+                            "enumeration."
+                    }),
+                    title: es_extensions_1.InvalidParameterValueError.localization.defaultTitle,
+                    occurrenceLocation: "ObjectDataFilesProcessor.processFile(namedParameters)"
+                });
+            }
+            switch (fileNameLastExtensionWithLeadingPeriod) {
+                case ".json": {
+                    dataSchema = ObjectDataFilesProcessor.SupportedSchemas.JSON;
+                    break;
+                }
+                case ".yaml":
+                case ".yml": {
+                    dataSchema = ObjectDataFilesProcessor.SupportedSchemas.YAML;
+                    break;
+                }
+                case ".env": {
+                    dataSchema = ObjectDataFilesProcessor.SupportedSchemas.DOTENV;
+                    break;
+                }
+                default: {
+                    es_extensions_1.Logger.throwErrorAndLog({
+                        errorInstance: new es_extensions_1.InvalidParameterValueError({
+                            parameterName: "namedParameters.filePath",
+                            messageSpecificPart: `Target file '${namedParameters.filePath}' has unsupported filename extension ` +
+                                `'${fileNameLastExtensionWithLeadingPeriod}'. If this file including the data of known for ` +
+                                "'ObjectDataFilesProcessor' schema, specify 'namedParameters.dataSchema' with desired element of " +
+                                "'ObjectDataFilesProcessor.SupportedSchemas' enumeration"
+                        }),
+                        title: es_extensions_1.InvalidParameterValueError.localization.defaultTitle,
+                        occurrenceLocation: "ObjectDataFilesProcessor.processFile(namedParameters)"
+                    });
+                }
+            }
+        }
+        let targetFileStatistics;
+        try {
+            targetFileStatistics = fs_1.default.statSync(filePath);
+        }
+        catch (error) {
+            if ((0, isErrnoException_1.default)(error) && error.code === "ENOENT") {
+                es_extensions_1.Logger.throwErrorAndLog({
+                    errorInstance: new FileNotFoundError_1.default({ filePath }),
+                    title: FileNotFoundError_1.default.localization.defaultTitle,
+                    occurrenceLocation: "ObjectDataFilesProcessor.processFile(namedParameters)",
+                    wrappableError: error
+                });
+            }
+            throw error;
+        }
+        if (!targetFileStatistics.isFile()) {
+            es_extensions_1.Logger.throwErrorAndLog({
+                errorInstance: new DesiredFileActuallyIsDirectoryError_1.default({ targetPath: filePath }),
+                title: DesiredFileActuallyIsDirectoryError_1.default.localization.defaultTitle,
+                occurrenceLocation: "ObjectDataFilesProcessor.processFile(namedParameters)"
+            });
+        }
+        let rawData;
+        try {
+            rawData = fs_1.default.readFileSync(filePath, "utf-8");
+        }
+        catch (error) {
+            es_extensions_1.Logger.throwErrorAndLog({
+                errorInstance: new es_extensions_1.FileReadingFailedError({ filePath }),
+                title: es_extensions_1.FileReadingFailedError.localization.defaultTitle,
+                occurrenceLocation: "ObjectDataFilesProcessor.processFile(namedParameters)"
+            });
+        }
+        let parsedData;
+        try {
+            switch (dataSchema) {
+                case ObjectDataFilesProcessor.SupportedSchemas.JSON: {
+                    parsedData = JSON.parse(rawData);
+                    break;
+                }
+                case ObjectDataFilesProcessor.SupportedSchemas.YAML: {
+                    parsedData = yamljs_1.default.parse(rawData);
+                    break;
+                }
+                case ObjectDataFilesProcessor.SupportedSchemas.DOTENV: {
+                    parsedData = dotenv_1.default.parse(rawData);
+                }
+            }
+        }
+        catch (error) {
+            es_extensions_1.Logger.throwErrorAndLog({
+                errorInstance: new es_extensions_1.InvalidExternalDataError({ mentionToExpectedData: filePath }),
+                title: es_extensions_1.InvalidExternalDataError.localization.defaultTitle,
+                occurrenceLocation: "ObjectDataFilesProcessor.processFile(namedParameters)",
+                wrappableError: error
+            });
+        }
+        const processingResult = es_extensions_1.RawObjectDataProcessor.process(parsedData, namedParameters.validDataSpecification);
+        if (processingResult.rawDataIsInvalid) {
+            es_extensions_1.Logger.throwErrorAndLog({
+                errorInstance: new es_extensions_1.InvalidExternalDataError({
+                    customMessage: `The contents of file '${filePath}' does not matching with valid data specification:\n` +
+                        `${es_extensions_1.RawObjectDataProcessor.formatValidationErrorsList(processingResult.validationErrorsMessages)}`
+                }),
+                title: es_extensions_1.InvalidExternalDataError.localization.defaultTitle,
+                occurrenceLocation: "ObjectDataFilesProcessor.processFile(namedParameters)"
+            });
+        }
+        return processingResult.processedData;
+    }
+}
+(function (ObjectDataFilesProcessor) {
+    let SupportedSchemas;
+    (function (SupportedSchemas) {
+        SupportedSchemas["JSON"] = "JSON";
+        SupportedSchemas["YAML"] = "YAML";
+        SupportedSchemas["DOTENV"] = "DOTENV";
+    })(SupportedSchemas = ObjectDataFilesProcessor.SupportedSchemas || (ObjectDataFilesProcessor.SupportedSchemas = {}));
+})(ObjectDataFilesProcessor || (ObjectDataFilesProcessor = {}));
+exports.default = ObjectDataFilesProcessor;

package/Distributable/index.d.ts

@@ -6,6 +6,11 @@
 export { default as NodeJS_Timer } from "./DateTime/NodeJS_Timer";
 export { default as ConsoleApplicationLogger } from "./ConsoleApplicationLogger";
 export { default as ConsoleCommandsParser } from "./ConsoleCommandsParser/ConsoleCommandsParser";
+export { default as DesiredFileActuallyIsDirectoryError } from "./Errors/DesiredFileActuallyIsDirectoryError/DesiredFileActuallyIsDirectoryError";
+export { default as DesiredFileActuallyIsDirectoryErrorLocalization__English } from "./Errors/DesiredFileActuallyIsDirectoryError/DesiredFileActuallyIsDirectoryErrorLocalization.english";
+export { default as FileNotFoundError } from "./Errors/FileNotFoundError/FileNotFoundError";
+export { default as FileNotFoundErrorLocalization__English } from "./Errors/FileNotFoundError/FileNotFoundErrorLocalization.english";
 export { default as InvalidConsoleCommandError } from "./Errors/InvalidConsoleCommand/InvalidConsoleCommandError";
 export { default as InterProcessInteractionFailedError } from "./Errors/InterProcessInteractionFailed/InterProcessInteractionFailedError";
+export { default as ObjectDataFilesProcessor } from "./ObjectDataFilesProcessor/ObjectDataFilesProcessor";
 export { default as isErrnoException } from "./isErrnoException";

package/Distributable/index.js

@@ -8,16 +8,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isErrnoException = exports.InterProcessInteractionFailedError = exports.InvalidConsoleCommandError = exports.ConsoleCommandsParser = exports.ConsoleApplicationLogger = exports.NodeJS_Timer = void 0;
+exports.isErrnoException = exports.ObjectDataFilesProcessor = exports.InterProcessInteractionFailedError = exports.InvalidConsoleCommandError = exports.FileNotFoundErrorLocalization__English = exports.FileNotFoundError = exports.DesiredFileActuallyIsDirectoryErrorLocalization__English = exports.DesiredFileActuallyIsDirectoryError = exports.ConsoleCommandsParser = exports.ConsoleApplicationLogger = exports.NodeJS_Timer = void 0;
 var NodeJS_Timer_1 = require("./DateTime/NodeJS_Timer");
 Object.defineProperty(exports, "NodeJS_Timer", { enumerable: true, get: function () { return __importDefault(NodeJS_Timer_1).default; } });
 var ConsoleApplicationLogger_1 = require("./ConsoleApplicationLogger");
 Object.defineProperty(exports, "ConsoleApplicationLogger", { enumerable: true, get: function () { return __importDefault(ConsoleApplicationLogger_1).default; } });
 var ConsoleCommandsParser_1 = require("./ConsoleCommandsParser/ConsoleCommandsParser");
 Object.defineProperty(exports, "ConsoleCommandsParser", { enumerable: true, get: function () { return __importDefault(ConsoleCommandsParser_1).default; } });
+var DesiredFileActuallyIsDirectoryError_1 = require("./Errors/DesiredFileActuallyIsDirectoryError/DesiredFileActuallyIsDirectoryError");
+Object.defineProperty(exports, "DesiredFileActuallyIsDirectoryError", { enumerable: true, get: function () { return __importDefault(DesiredFileActuallyIsDirectoryError_1).default; } });
+var DesiredFileActuallyIsDirectoryErrorLocalization_english_1 = require("./Errors/DesiredFileActuallyIsDirectoryError/DesiredFileActuallyIsDirectoryErrorLocalization.english");
+Object.defineProperty(exports, "DesiredFileActuallyIsDirectoryErrorLocalization__English", { enumerable: true, get: function () { return __importDefault(DesiredFileActuallyIsDirectoryErrorLocalization_english_1).default; } });
+var FileNotFoundError_1 = require("./Errors/FileNotFoundError/FileNotFoundError");
+Object.defineProperty(exports, "FileNotFoundError", { enumerable: true, get: function () { return __importDefault(FileNotFoundError_1).default; } });
+var FileNotFoundErrorLocalization_english_1 = require("./Errors/FileNotFoundError/FileNotFoundErrorLocalization.english");
+Object.defineProperty(exports, "FileNotFoundErrorLocalization__English", { enumerable: true, get: function () { return __importDefault(FileNotFoundErrorLocalization_english_1).default; } });
 var InvalidConsoleCommandError_1 = require("./Errors/InvalidConsoleCommand/InvalidConsoleCommandError");
 Object.defineProperty(exports, "InvalidConsoleCommandError", { enumerable: true, get: function () { return __importDefault(InvalidConsoleCommandError_1).default; } });
 var InterProcessInteractionFailedError_1 = require("./Errors/InterProcessInteractionFailed/InterProcessInteractionFailedError");
 Object.defineProperty(exports, "InterProcessInteractionFailedError", { enumerable: true, get: function () { return __importDefault(InterProcessInteractionFailedError_1).default; } });
+var ObjectDataFilesProcessor_1 = require("./ObjectDataFilesProcessor/ObjectDataFilesProcessor");
+Object.defineProperty(exports, "ObjectDataFilesProcessor", { enumerable: true, get: function () { return __importDefault(ObjectDataFilesProcessor_1).default; } });
 var isErrnoException_1 = require("./isErrnoException");
 Object.defineProperty(exports, "isErrnoException", { enumerable: true, get: function () { return __importDefault(isErrnoException_1).default; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yamato-daiwa/es-extensions-nodejs",
-  "version": "1.5.1",
+  "version": "1.6.0-alpha.0",
   "description": "Additional to @yamato-daiwa/es-extensions functionality for Node.js environment. Helper functions and classes aimed to reduce the routine code. Build-in TypeScript type safety.",
   "keywords": [
     "nodejs",
@@ -30,6 +30,7 @@
     "@types/json5": "0.0.30",
     "@types/mocha": "9.1.1",
     "@types/node": "16.10.2",
+    "@types/yamljs": "0.2.31",
     "@yamato-daiwa/style_guides": "0.0.16",
     "mocha": "10.0.0",
     "rimraf": "3.0.2",
@@ -37,8 +38,10 @@
     "typescript": "4.7.4"
   },
   "dependencies": {
-    "@yamato-daiwa/es-extensions": "1.5.1",
-    "json5": "2.2.1"
+    "@yamato-daiwa/es-extensions": ">=1.5.0 <1.6.0",
+    "dotenv": "16.0.1",
+    "json5": "2.2.1",
+    "yamljs": "0.3.0"
   },
   "peerDependencies": {
     "@yamato-daiwa/es-extensions": ">=1.5.0 <1.6.0"
@@ -49,6 +52,6 @@
   "scripts": {
     "Rebuild distributable": "rimraf Distributable & tsc",
     "Lint": "eslint Source Tests",
-    "Rebuild distributable and realize alpha":  "npm run \"Rebuild distributable\" && npm publish --tag alpha"
+    "Rebuild distributable and realize alpha": "npm run \"Rebuild distributable\" && npm publish --tag alpha"
   }
 }