Update local validation export and implementation (#60)

Signed-off-by: Michiel Mulders <[email protected]>

README.md

@@ -263,10 +263,10 @@ Import the package into your project and get the `localValidation` function.
 const { localValidation } = require('@hashgraph/hedera-nft-sdk');
 ```
 
-The `localValidation` expects an absolute path to your metadata files to verify them. The function prints the warnings and errors for all JSON files it finds in the provided folder path. It also returns the validation results as an object in case you want to use the results in your code.
+The `localValidation` expects a relative path to your metadata files to verify them. The function prints the warnings and errors for all JSON files it finds in the provided folder path. It also returns the validation results as an object in case you want to use the results in your code.
 
 ```js
-localValidation('/Users/projects/nft/files');
+const issues = localValidation('/Users/projects/nft/files');
 ```
 
 This package uses the `Validator` class explained in the [previous section](#token-metadata-validator).

examples/local-metadata-validator/index.js

@@ -17,19 +17,18 @@
  * limitations under the License.
  *
  */
-const { localValidation } = require('../../local-validation');
+const { localValidation } = require('../../dist/local-validation');
 
 function main() {
-  // Replace with absolute path to files folder
-  const absolutePathToFiles = '/Users/myUser/hedera-nft-sdk/examples/local-metadata-validator/files';
+  // Replace with relative path to files folder
+  const relativePathToFiles = './examples/local-metadata-validator/files';
 
   // Looks for JSON files and uses validator package to verify each metadata file (notjson.md file will be ignored)
   // files/nft2.json has mistakes: no image and type properties
-  localValidation(absolutePathToFiles);
+  const issues = localValidation(relativePathToFiles);
+  console.log(issues);
 
   /* Output:
-        Found 6 for directory: /Users/myUser/hedera-nft-sdk/examples/local-metadata-validator/files
-        Found 5 files with the .json extension
         { 
             "nft1.json": {"errors":[],"warnings":[]},
             "nft2.json":{"errors":[{"type":"schema","msg":"requires property 'image'","path":"instance"},{"type":"schema","msg":"requires property 'type'","path":"instance"}],"warnings":[]},

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hashgraph/hedera-nft-sdk",
-  "version": "3.0.7",
+  "version": "3.1.0",
   "description": "NFT SDK for Hedera Hashgraph",
   "author": "Michiel Mulders",
   "license": "Apache License",

src/index.ts

@@ -18,7 +18,7 @@
  *
  */
 import { Validator, defaultSchemaVersion } from './validator';
-import localValidation from './local-validation';
+import { localValidation } from './local-validation';
 import { defaultWeights, defaultRiskLevels, calculateRiskScoreFromData, calculateRiskScoreFromTokenId, calculateRiskLevel } from './risk';
 import { calculateRarity, calculateRarityFromData, calculateTraitOccurrenceFromData, calculateRarityFromOnChainData } from './rarity';
 

src/local-validation/index.ts

@@ -17,6 +17,7 @@
  * limitations under the License.
  *
  */
+import path from 'path';
 import { Validator } from '../validator/index';
 import { readFiles, getJSONFilesForDir } from '../helpers/files';
 
@@ -46,21 +47,18 @@ const validateFiles = (files: File[]): ValidationResults => {
 /**
  * Validate files locally
  *
- * @param {string} path Absolute path to folder containing files
+ * @param {string} relative Relative path to folder containing files
  * @returns {Object<filename<string>, validationResults<Object>>}
  */
-const localValidation = (path: string): ValidationResults => {
-  const filenames = getJSONFilesForDir(path);
-  const filedata = readFiles(path, filenames);
+const localValidation = (relativePath: string): ValidationResults => {
+  const absolutePath = path.resolve(relativePath); // convert relative path to absolute path
+  const filenames = getJSONFilesForDir(absolutePath);
+  const filedata = readFiles(absolutePath, filenames);
   const validationResults = validateFiles(filedata);
 
-  // Print results for the user
-  // eslint-disable-next-line no-console
-  console.log(JSON.stringify(validationResults));
-
   return validationResults;
 };
 
-export default {
+export {
   localValidation,
 };

src/services/csv-file-reader.ts

@@ -64,11 +64,11 @@ function processHeader(
   attributesIndex: number,
   refToErrorArray: string[]
 ): {
-  result: string | null;
-  currentType: CurrentType;
-  propertyIndex: number;
-  attributesIndex: number;
-} {
+    result: string | null;
+    currentType: CurrentType;
+    propertyIndex: number;
+    attributesIndex: number;
+  } {
   let result: string | null = null;
 
   // TODO: try to simplyfy this

src/services/file-storages/pinata/pinata-service.ts

@@ -67,12 +67,12 @@ export class PinataService implements FileStorage {
 
     const authorization = this.pinataJwtKey
       ? {
-          Authorization: `Bearer ${this.pinataJwtKey}`,
-        }
+        Authorization: `Bearer ${this.pinataJwtKey}`,
+      }
       : {
-          pinata_api_key: this.pinataApiKey,
-          pinata_secret_api_key: this.pinataSecretApiKey,
-        };
+        pinata_api_key: this.pinataApiKey,
+        pinata_secret_api_key: this.pinataSecretApiKey,
+      };
 
     const res = await this.instance.post(this.uploadUrl, formData, {
       headers: {