@pristine-ts/file 0.0.348 → 0.0.350

package/dist/lib/cjs/file.module.js

@@ -17,15 +17,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileModule = void 0;
 const common_1 = require("@pristine-ts/common");
 const file_module_keyname_1 = require("./file.module.keyname");
+const data_mapping_1 = require("@pristine-ts/data-mapping");
 __exportStar(require("./enums/enums"), exports);
 __exportStar(require("./interfaces/interfaces"), exports);
 __exportStar(require("./managers/managers"), exports);
 __exportStar(require("./options/options"), exports);
+__exportStar(require("./resolvers/resolvers"), exports);
 exports.FileModule = {
     keyname: file_module_keyname_1.FileModuleKeyname,
     configurationDefinitions: [],
     importModules: [
         common_1.CommonModule,
+        data_mapping_1.DataMappingModule,
     ],
 };
 //# sourceMappingURL=file.module.js.map

package/dist/lib/cjs/file.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"file.module.js","sourceRoot":"","sources":["../../../src/file.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,gDAAkE;AAClE,+DAAwD;AAExD,gDAA8B;AAC9B,0DAAwC;AACxC,sDAAoC;AACpC,oDAAkC;AAErB,QAAA,UAAU,GAAoB;IACvC,OAAO,EAAE,uCAAiB;IAC1B,wBAAwB,EAAE,EACzB;IACD,aAAa,EAAE;QACX,qBAAY;KACf;CACJ,CAAA"}
+{"version":3,"file":"file.module.js","sourceRoot":"","sources":["../../../src/file.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,gDAAkE;AAClE,+DAAwD;AACxD,4DAA4D;AAE5D,gDAA8B;AAC9B,0DAAwC;AACxC,sDAAoC;AACpC,oDAAkC;AAClC,wDAAsC;AAEzB,QAAA,UAAU,GAAoB;IACvC,OAAO,EAAE,uCAAiB;IAC1B,wBAAwB,EAAE,EACzB;IACD,aAAa,EAAE;QACX,qBAAY;QACZ,gCAAiB;KACpB;CACJ,CAAA"}

package/dist/lib/cjs/resolvers/file.resolver.js

@@ -0,0 +1,73 @@
+"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.FileResolver = void 0;
+const promises_1 = require("fs/promises");
+const node_fs_1 = require("node:fs");
+const configuration_1 = require("@pristine-ts/configuration");
+/**
+ * This class is a resolver that is used to resolve the configuration coming from a file.
+
+ */
+class FileResolver {
+    constructor(options, dataMapper, validator) {
+        this.options = options;
+        this.dataMapper = dataMapper;
+        this.validator = validator;
+    }
+    resolveFilename(value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (typeof value === "string") {
+                return value;
+            }
+            if (typeof value === "object" && typeof value.resolve === "function") {
+                return this.resolveFilename(yield value.resolve());
+            }
+            throw new configuration_1.ConfigurationResolverError("Cannot resolve the value passed. It isn't of type string or ResolverInterface.", value);
+        });
+    }
+    resolve() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const filename = yield this.resolveFilename(this.options.filename);
+            if ((0, node_fs_1.existsSync)(filename) === false) {
+                throw new configuration_1.ConfigurationResolverError("The file doesn't exist.", filename);
+            }
+            const content = yield (0, promises_1.readFile)(filename, { encoding: "utf-8" });
+            let options;
+            try {
+                options = JSON.parse(content);
+            }
+            catch (error) {
+                throw new configuration_1.ConfigurationResolverError("Cannot JSON parse the content of this file", content);
+            }
+            if (this.dataMapper === undefined) {
+                return options;
+            }
+            try {
+                options = yield this.dataMapper.autoMap(JSON.parse(content), this.options.classType);
+            }
+            catch (error) {
+                throw new configuration_1.ConfigurationResolverError("The content of the file is not valid.", content);
+            }
+            if (this.validator === undefined) {
+                return options;
+            }
+            // Validate the options
+            const errors = yield this.validator.validate(options);
+            if (errors.length > 0) {
+                throw new configuration_1.ConfigurationResolverError("There are errors in the configuration.", content);
+            }
+            return options;
+        });
+    }
+}
+exports.FileResolver = FileResolver;
+//# sourceMappingURL=file.resolver.js.map

package/dist/lib/cjs/resolvers/file.resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/file.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;AAGA,0CAAqC;AACrC,qCAAmC;AAEnC,8DAAsE;AAEtE;;;GAGG;AACH,MAAa,YAAY;IACrB,YACqB,OAGpB,EACoB,UAAuB,EACvB,SAAqB;QALrB,YAAO,GAAP,OAAO,CAG3B;QACoB,eAAU,GAAV,UAAU,CAAa;QACvB,cAAS,GAAT,SAAS,CAAY;IAC1C,CAAC;IAEa,eAAe,CAAC,KAA0C;;YACpE,IAAG,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC3B,OAAO,KAAK,CAAC;YACjB,CAAC;YAED,IAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;gBAClE,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACvD,CAAC;YAED,MAAM,IAAI,0CAA0B,CAAC,gFAAgF,EAAE,KAAK,CAAC,CAAC;QAClI,CAAC;KAAA;IAEK,OAAO;;YACT,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAEnE,IAAG,IAAA,oBAAU,EAAC,QAAQ,CAAC,KAAK,KAAK,EAAE,CAAC;gBAChC,MAAM,IAAI,0CAA0B,CAAC,yBAAyB,EAAE,QAAQ,CAAC,CAAC;YAC9E,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,IAAA,mBAAQ,EAAC,QAAQ,EAAE,EAAC,QAAQ,EAAE,OAAO,EAAC,CAAC,CAAC;YAE9D,IAAI,OAAO,CAAC;YAEZ,IAAI,CAAC;gBACD,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAClC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,MAAM,IAAI,0CAA0B,CAAC,4CAA4C,EAAE,OAAO,CAAC,CAAA;YAC/F,CAAC;YAED,IAAG,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC/B,OAAO,OAAO,CAAC;YACnB,CAAC;YAED,IAAI,CAAC;gBACD,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACzF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,MAAM,IAAI,0CAA0B,CAAC,uCAAuC,EAAE,OAAO,CAAC,CAAC;YAC3F,CAAC;YAED,IAAG,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC9B,OAAO,OAAO,CAAC;YACnB,CAAC;YAED,uBAAuB;YACvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAEtD,IAAG,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnB,MAAM,IAAI,0CAA0B,CAAC,wCAAwC,EAAE,OAAO,CAAC,CAAC;YAC5F,CAAC;YAED,OAAO,OAAO,CAAC;QACnB,CAAC;KAAA;CACJ;AA9DD,oCA8DC"}

package/dist/lib/cjs/resolvers/resolvers.js

@@ -0,0 +1,18 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./file.resolver"), exports);
+//# sourceMappingURL=resolvers.js.map

package/dist/lib/cjs/resolvers/resolvers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvers.js","sourceRoot":"","sources":["../../../../src/resolvers/resolvers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAA+B"}

package/dist/lib/esm/file.module.js

@@ -1,14 +1,17 @@
 import { CommonModule } from "@pristine-ts/common";
 import { FileModuleKeyname } from "./file.module.keyname";
+import { DataMappingModule } from "@pristine-ts/data-mapping";
 export * from "./enums/enums";
 export * from "./interfaces/interfaces";
 export * from "./managers/managers";
 export * from "./options/options";
+export * from "./resolvers/resolvers";
 export const FileModule = {
     keyname: FileModuleKeyname,
     configurationDefinitions: [],
     importModules: [
         CommonModule,
+        DataMappingModule,
     ],
 };
 //# sourceMappingURL=file.module.js.map

package/dist/lib/esm/file.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"file.module.js","sourceRoot":"","sources":["../../../src/file.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAkB,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAExD,cAAc,eAAe,CAAC;AAC9B,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAElC,MAAM,CAAC,MAAM,UAAU,GAAoB;IACvC,OAAO,EAAE,iBAAiB;IAC1B,wBAAwB,EAAE,EACzB;IACD,aAAa,EAAE;QACX,YAAY;KACf;CACJ,CAAA"}
+{"version":3,"file":"file.module.js","sourceRoot":"","sources":["../../../src/file.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAkB,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAE5D,cAAc,eAAe,CAAC;AAC9B,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AAEtC,MAAM,CAAC,MAAM,UAAU,GAAoB;IACvC,OAAO,EAAE,iBAAiB;IAC1B,wBAAwB,EAAE,EACzB;IACD,aAAa,EAAE;QACX,YAAY;QACZ,iBAAiB;KACpB;CACJ,CAAA"}

package/dist/lib/esm/resolvers/file.resolver.js

@@ -0,0 +1,69 @@
+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());
+    });
+};
+import { readFile } from "fs/promises";
+import { existsSync } from "node:fs";
+import { ConfigurationResolverError } from "@pristine-ts/configuration";
+/**
+ * This class is a resolver that is used to resolve the configuration coming from a file.
+
+ */
+export class FileResolver {
+    constructor(options, dataMapper, validator) {
+        this.options = options;
+        this.dataMapper = dataMapper;
+        this.validator = validator;
+    }
+    resolveFilename(value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (typeof value === "string") {
+                return value;
+            }
+            if (typeof value === "object" && typeof value.resolve === "function") {
+                return this.resolveFilename(yield value.resolve());
+            }
+            throw new ConfigurationResolverError("Cannot resolve the value passed. It isn't of type string or ResolverInterface.", value);
+        });
+    }
+    resolve() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const filename = yield this.resolveFilename(this.options.filename);
+            if (existsSync(filename) === false) {
+                throw new ConfigurationResolverError("The file doesn't exist.", filename);
+            }
+            const content = yield readFile(filename, { encoding: "utf-8" });
+            let options;
+            try {
+                options = JSON.parse(content);
+            }
+            catch (error) {
+                throw new ConfigurationResolverError("Cannot JSON parse the content of this file", content);
+            }
+            if (this.dataMapper === undefined) {
+                return options;
+            }
+            try {
+                options = yield this.dataMapper.autoMap(JSON.parse(content), this.options.classType);
+            }
+            catch (error) {
+                throw new ConfigurationResolverError("The content of the file is not valid.", content);
+            }
+            if (this.validator === undefined) {
+                return options;
+            }
+            // Validate the options
+            const errors = yield this.validator.validate(options);
+            if (errors.length > 0) {
+                throw new ConfigurationResolverError("There are errors in the configuration.", content);
+            }
+            return options;
+        });
+    }
+}
+//# sourceMappingURL=file.resolver.js.map

package/dist/lib/esm/resolvers/file.resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/file.resolver.ts"],"names":[],"mappings":";;;;;;;;;AAGA,OAAO,EAAC,QAAQ,EAAC,MAAM,aAAa,CAAC;AACrC,OAAO,EAAC,UAAU,EAAC,MAAM,SAAS,CAAC;AAEnC,OAAO,EAAC,0BAA0B,EAAC,MAAM,4BAA4B,CAAC;AAEtE;;;GAGG;AACH,MAAM,OAAO,YAAY;IACrB,YACqB,OAGpB,EACoB,UAAuB,EACvB,SAAqB;QALrB,YAAO,GAAP,OAAO,CAG3B;QACoB,eAAU,GAAV,UAAU,CAAa;QACvB,cAAS,GAAT,SAAS,CAAY;IAC1C,CAAC;IAEa,eAAe,CAAC,KAA0C;;YACpE,IAAG,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC3B,OAAO,KAAK,CAAC;YACjB,CAAC;YAED,IAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;gBAClE,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACvD,CAAC;YAED,MAAM,IAAI,0BAA0B,CAAC,gFAAgF,EAAE,KAAK,CAAC,CAAC;QAClI,CAAC;KAAA;IAEK,OAAO;;YACT,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAEnE,IAAG,UAAU,CAAC,QAAQ,CAAC,KAAK,KAAK,EAAE,CAAC;gBAChC,MAAM,IAAI,0BAA0B,CAAC,yBAAyB,EAAE,QAAQ,CAAC,CAAC;YAC9E,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,EAAC,QAAQ,EAAE,OAAO,EAAC,CAAC,CAAC;YAE9D,IAAI,OAAO,CAAC;YAEZ,IAAI,CAAC;gBACD,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAClC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,MAAM,IAAI,0BAA0B,CAAC,4CAA4C,EAAE,OAAO,CAAC,CAAA;YAC/F,CAAC;YAED,IAAG,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC/B,OAAO,OAAO,CAAC;YACnB,CAAC;YAED,IAAI,CAAC;gBACD,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACzF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,MAAM,IAAI,0BAA0B,CAAC,uCAAuC,EAAE,OAAO,CAAC,CAAC;YAC3F,CAAC;YAED,IAAG,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC9B,OAAO,OAAO,CAAC;YACnB,CAAC;YAED,uBAAuB;YACvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAEtD,IAAG,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnB,MAAM,IAAI,0BAA0B,CAAC,wCAAwC,EAAE,OAAO,CAAC,CAAC;YAC5F,CAAC;YAED,OAAO,OAAO,CAAC;QACnB,CAAC;KAAA;CACJ"}

package/dist/lib/esm/resolvers/resolvers.js

@@ -0,0 +1,2 @@
+export * from "./file.resolver";
+//# sourceMappingURL=resolvers.js.map

package/dist/lib/esm/resolvers/resolvers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvers.js","sourceRoot":"","sources":["../../../../src/resolvers/resolvers.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA"}

package/dist/types/file.module.d.ts

@@ -3,4 +3,5 @@ export * from "./enums/enums";
 export * from "./interfaces/interfaces";
 export * from "./managers/managers";
 export * from "./options/options";
+export * from "./resolvers/resolvers";
 export declare const FileModule: ModuleInterface;

package/dist/types/resolvers/file.resolver.d.ts

@@ -0,0 +1,19 @@
+import { ResolverInterface } from "@pristine-ts/common";
+import { ClassConstructor } from "class-transformer";
+import { DataMapper } from "@pristine-ts/data-mapping-common";
+import { Validator } from "@pristine-ts/class-validator";
+/**
+ * This class is a resolver that is used to resolve the configuration coming from a file.
+
+ */
+export declare class FileResolver<Options> implements ResolverInterface<Options> {
+    private readonly options;
+    private readonly dataMapper?;
+    private readonly validator?;
+    constructor(options: {
+        filename: string | ResolverInterface<string>;
+        classType: ClassConstructor<Options>;
+    }, dataMapper?: DataMapper | undefined, validator?: Validator | undefined);
+    private resolveFilename;
+    resolve(): Promise<Options>;
+}

package/dist/types/resolvers/resolvers.d.ts

@@ -0,0 +1 @@
+export * from "./file.resolver";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pristine-ts/file",
-  "version": "0.0.348",
+  "version": "0.0.350",
   "description": "",
   "module": "dist/lib/esm/file.module.js",
   "main": "dist/lib/cjs/file.module.js",
@@ -20,7 +20,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@pristine-ts/common": "^0.0.348"
+    "@pristine-ts/class-validator": "^1.0.25",
+    "@pristine-ts/common": "^0.0.350",
+    "@pristine-ts/configuration": "^0.0.350",
+    "@pristine-ts/data-mapping": "^0.0.350",
+    "@pristine-ts/data-mapping-common": "^0.0.350"
   },
   "jest": {
     "transform": {
@@ -56,5 +60,5 @@
       "src/*.{js,ts}"
     ]
   },
-  "gitHead": "88a956b9b86d69bcb0e8464a660966846f8ae5fa"
+  "gitHead": "b6d399b8ad2862f654c86f911443ad90fe1205ca"
 }