@terzogenito/json-utils 1.0.8 → 1.0.9

package/README.md

@@ -1 +1,192 @@
-# json-utils
+# Documentation
+
+## Overview
+This module provides various functions for reading, validating, and processing JSON files and URL content.
+
+## Function List
+
+### 1. `getData(path)`
+```javascript
+console.log(await app.getData('./test-data.json'));
+```
+
+**Description**: Reads and returns data from a file asynchronously.
+
+**Parameters**:
+- `path` (String): Path to the file to be read
+
+---
+
+### 2. `getString(path)`
+```javascript
+console.log(app.getString('test-data.json'));
+```
+
+**Description**: Reads a file and returns its content as a string.
+
+**Parameters**:
+- `path` (String): Path to the file to be read
+
+---
+
+### 3. `getFile(path, callback)`
+```javascript
+app.getFile('test-data.json', data => {
+    console.log(app.isValid(data));
+});
+```
+
+**Description**: Reads a file and processes the data using a callback function.
+
+**Parameters**:
+- `path` (String): Path to the file to be read
+- `callback` (Function): Function to be called with the file data
+
+---
+
+### 4. `isValid(data)`
+```javascript
+app.getFile('test-data.json', data => {
+    console.log(app.isValid(data));
+});
+```
+
+**Description**: Validates whether the data is valid JSON.
+
+**Parameters**:
+- `data` (Any): Data to be validated
+
+---
+
+### 5. `toString(data)`
+```javascript
+app.getFile('test-data.json', data => {
+    console.log(app.toString(data));
+});
+```
+
+**Description**: Converts JSON data to a string.
+
+**Parameters**:
+- `data` (Object): JSON data to be converted
+
+---
+
+### 6. `readJSON(jsonString)`
+```javascript
+console.log(app.readJSON('{"name":"John","age":30,"isActive":true}'));
+```
+
+**Description**: Reads and parses a JSON string into a JavaScript object.
+
+**Parameters**:
+- `jsonString` (String): JSON string to be parsed
+
+---
+
+### 7. `isJSON(jsonString)`
+```javascript
+console.log(app.isJSON('{"name":"John","age":30,"isActive":true}'));
+```
+
+**Description**: Checks if a string is valid JSON.
+
+**Parameters**:
+- `jsonString` (String): String to be checked
+
+---
+
+### 8. `isJSONObject(obj)`
+```javascript
+console.log(app.isJSONObject({"name": "John","age": 30,"isActive": true}));
+```
+
+**Description**: Checks if an object is a valid JSON object.
+
+**Parameters**:
+- `obj` (Object): Object to be checked
+
+---
+
+### 9. `beautifyJSON(jsonString, indent)`
+```javascript
+console.log(app.beautifyJSON(jsonString));
+console.log(app.beautifyJSON(jsonString, 4));
+```
+
+**Description**: Formats a JSON string with customizable indentation.
+
+**Parameters**:
+- `jsonString` (String): JSON string to be formatted
+- `indent` (Number, optional): Number of spaces for indentation (default: 2)
+
+---
+
+### 10. `beautify(jsonObject)`
+```javascript
+console.log(app.beautify(sampleJSONObject));
+```
+
+**Description**: Formats a JSON object into a readable string.
+
+**Parameters**:
+- `jsonObject` (Object): JSON object to be formatted
+
+---
+
+### 11. `getURL(url, callback)`
+```javascript
+app.getURL("https://example.com/data.txt", data => {
+    console.log(data);
+});
+```
+
+**Description**: Fetches string content from a URL.
+
+**Parameters**:
+- `url` (String): Target URL
+- `callback` (Function): Callback function that receives the data
+
+---
+
+### 12. `getJSON(url, callback)`
+```javascript
+app.getJSON("https://example.com/data.json", data => {
+    console.log(data);
+});
+```
+
+**Description**: Fetches and parses JSON content from a URL.
+
+**Parameters**:
+- `url` (String): URL pointing to JSON file
+- `callback` (Function): Callback function that receives JSON data
+
+## Usage Examples
+
+```javascript
+const app = require('./index');
+
+// Reading local file
+const data = await app.getData('./data.json');
+
+// Validating JSON
+const isValid = app.isJSON('{"key": "value"}');
+
+// Formatting JSON
+const beautified = app.beautifyJSON('{"key":"value"}', 4);
+
+// Fetching data from URL
+app.getJSON("https://api.example.com/data", jsonData => {
+    console.log(jsonData);
+});
+```
+
+## Installation
+```bash
+npm install @terzogenito/json-utils
+```
+
+## Requirements
+- Node.js 12 or higher
+- Internet connection (for URL functions)

package/index.js

@@ -1,4 +1,67 @@
-const fileUtils = require('@terzogenito/file-utils');
+const fs = require('fs');
+const https = require('https');
+
+function getString(filePath) {
+  return fs.readFileSync(filePath, 'utf-8');
+}
+
+function getFile(filePath, callback) {
+  fs.readFile(filePath, 'utf8', (err, data) => {
+    if (err) {
+      return;
+    } else {
+      callback(data);
+    }
+  });
+}
+
+function loadFile(filePath) {
+  return new Promise((resolve, reject) => {
+    fs.readFile(filePath, 'utf8', (err, data) => {
+      if (err) {
+        reject(err);
+      } else {
+        resolve(data);
+      }
+    });
+  });
+}
+
+async function getData(filePath) {
+  try {
+    const data = await loadFile(filePath);
+    return data;
+  } catch {
+    return null;
+  }
+}
+
+function getURL(url, callback) {
+  https.get(url, (response) => {
+    let data = '';
+    response.on('data', chunk => {
+      data += chunk;
+    });
+    response.on('end', () => {
+      callback(data || null);
+    });
+  }).on('error', (err) => {
+    callback(null);
+  });
+}
+
+function isUrl(input) {
+  const urlPattern = /^(https?:\/\/|ftp:\/\/|www\.)/i;
+  return urlPattern.test(input);
+}
+
+function getContent(target, callback) {
+  if (isUrl(target)) {
+    getURL(target, callback);
+  } else {
+    getFile(target, callback);
+  }
+}
 
 function readJSON(jsonString) {
   return JSON.parse(jsonString);
@@ -12,8 +75,7 @@ function isValid(jsonString) {
   try {
     JSON.parse(jsonString);
     return true;
-  } catch (error) {
-    console.log("The string is not valid JSON.");
+  } catch {
     return false;
   }
 }
@@ -27,30 +89,61 @@ function isJSON(jsonObject) {
   }
 }
 
+function isJSONObject(jsonObject) {
+  try {
+    return typeof jsonObject === 'object' && jsonObject !== null && jsonObject !== undefined;
+  } catch (error) {
+    return false;
+  }
+}
+
 function getJSON(target, callback) {
-  fileUtils.getContent(target, data => {
-    if (isValid(data)) {
+  getContent(target, data => {
+    if (!data) {
+      return callback(null);
+    }
+    if (!isValid(data)) {
+      return callback(null);
+    }
+    try {
       callback(readJSON(data));
+    } catch {
+      callback(null);
     }
   });
 }
 
-function beautifyJSON(jsonString, indent) {
+function beautifyJSON(jsonString, indent = 2) {
   try {
+    if (typeof jsonString !== 'string') return null;
     const jsonObject = JSON.parse(jsonString);
+    return JSON.stringify(jsonObject, null, indent);
+  } catch {
+    return null;
+  }
+}
+
+function beautify(jsonObject, indent) {
+  try {
     if (!indent) indent = 2;
     return JSON.stringify(jsonObject, null, indent);
   } catch (error) {
-    console.error("Invalid JSON string:", error);
     return null;
   }
 }
 
 module.exports = {
+  getString,
+  getFile,
+  getData,
+  getURL,
+  getContent,
   readJSON,
   toString,
   isValid,
   isJSON,
+  isJSONObject,
   getJSON,
   beautifyJSON,
+  beautify,
 };

package/package.json

@@ -1,31 +1,28 @@
-{
-  "name": "@terzogenito/json-utils",
-  "version": "1.0.8",
-  "description": "Check JSON Format",
-  "main": "index.js",
-  "files": [
-    "index.js"
-  ],
-  "scripts": {
-    "start": "node test.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "engines": {
-    "node": ">=21.6.1"
-  },
-  "keywords": [
-    "nodejs",
-    "module",
-    "json",
-    "check",
-    "utils"
-  ],
-  "author": "Terzogenito",
-  "license": "MIT",
-  "dependencies": {
-    "@terzogenito/file-utils": "^1.0.0"
-  }
-}
+{
+  "name": "@terzogenito/json-utils",
+  "version": "1.0.9",
+  "description": "Check JSON Format",
+  "main": "index.js",
+  "files": [
+    "index.js"
+  ],
+  "scripts": {
+    "start": "node test.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=21.6.1"
+  },
+  "keywords": [
+    "nodejs",
+    "module",
+    "json",
+    "check",
+    "utils"
+  ],
+  "author": "Terzogenito",
+  "license": "MIT"
+}