flex-json 0.0.1

package/FlexJsonConstants.js

@@ -0,0 +1,57 @@
+// jsonTypeEnum Values - Numeric representation of jsonType
+//NOTE: The NUMBER VALUES are critical to the SORT() routine
+//  So that FlexJson arrays get sorted in this order: NULL, Number, String, Boolean, Array, Object, Error
+const jsonTypeEnum_null = 0;
+const jsonTypeEnum_number = 1;
+const jsonTypeEnum_string = 2;
+const jsonTypeEnum_boolean = 3;
+const jsonTypeEnum_array = 10;
+const jsonTypeEnum_object = 11;
+const jsonTypeEnum_error = 90;
+const jsonTypeEnum_invalid = 99;
+
+// Indicates status of deserialize process.  
+// Order of numbers is important! (because we check for _status >= ST_STRING)
+const ST_BEFORE_ITEM=0;
+const ST_EOL_COMMENT=1;
+const ST_AST_COMMENT=2;
+const ST_EOL_COMMENT_POST=3;
+const ST_AST_COMMENT_POST=4;
+const ST_STRING=10;
+const ST_STRING_NO_QUOTE=12;
+const ST_AFTER_ITEM=99;
+
+const NEWLINE="\r\n";
+
+const typeObject = "object";
+const typeArray = "array";
+const typeString = "string";
+const typeNumber = "number";
+const typeBoolean = "boolean";
+const typeNull = "null";
+
+module.exports = {
+	jsonTypeEnum_null
+	,jsonTypeEnum_number
+	,jsonTypeEnum_string
+	,jsonTypeEnum_boolean
+	,jsonTypeEnum_array
+	,jsonTypeEnum_object
+	,jsonTypeEnum_error
+	,jsonTypeEnum_invalid
+	,ST_BEFORE_ITEM
+	,ST_EOL_COMMENT
+	,ST_AST_COMMENT
+	,ST_EOL_COMMENT_POST
+	,ST_AST_COMMENT_POST
+	,ST_STRING
+	,ST_STRING_NO_QUOTE
+	,ST_AFTER_ITEM
+	,NEWLINE
+	,typeObject
+	,typeArray
+	,typeString
+	,typeNumber
+	,typeBoolean
+	,typeNull
+}

package/FlexJsonMeta.js

@@ -0,0 +1,26 @@
+class FlexJsonMeta
+    {
+        statusMsg = null;
+        tmpStatusMsg = null;
+        msgLog = null;
+        msgLogOn = false;
+        errorPosition = null;  // indicator of error position during deserialization process
+        startPosition = null;  // indicator of start position during deserialization process
+        endPosition = null;  // indicator of final position during deserialization process
+
+        // When/if this object exists, it will include flags to indicate if the object is intended to keep spacing and/or comments
+        //   keepSpacing - false=DO NOT preserve spacing, true=Preserve spacing including carriage returns
+        //   keepComments - false=DO NOT preseerve comments, true=Preserve comments in Flex JSON
+        // NOTE: These flags only have an affect during the deserialize process.
+        // FUTURE: How to clear spacing/comments after the load?  (set _keep to null? or just keep/pre/post attributes) Make this recursive to sub-objects?
+        // FUTURE: Flag to keep double/single quotes or no-quotes for Flex JSON (and write back to file using same quotes or no-quote per item)
+        keepSpacing = false;
+        keepComments = false;
+        preSpace = null;
+        finalSpace = null;
+        preKey = null;
+        postKey = null;
+        stats = null;  // null indicates we are not tracking stats.  stats object will also be created if an error occurs - to hold the error message.
+    }
+	
+module.exports = FlexJsonMeta;

package/FlexJsonPosition.js

@@ -0,0 +1,32 @@
+class FlexJsonPosition
+    {
+        lineNumber;
+        linePosition;
+        absolutePosition;
+
+        constructor(initLineNumber, initLinePosition, initAbsolutePosition) {
+            this.lineNumber = initLineNumber;
+            this.linePosition = initLinePosition;
+            this.absolutePosition = initAbsolutePosition;
+        }
+            
+        increment(positionIncrement = 1) {
+            this.linePosition += positionIncrement;
+            this.absolutePosition += positionIncrement;
+        }
+
+        // IncrementLine() - tracks the occurrance of a line break.
+        // AbsoluteIncrement must be provided because on some systems line breaks are 2 characters
+        incrementLine(absoluteIncrement, lineIncrement = 1) {
+            this.lineNumber += lineIncrement;
+            this.linePosition = 0;
+            this.absolutePosition += absoluteIncrement;
+        }
+
+        clone() {
+            let newClone = new FlexJsonPosition(this.lineNumber,this.linePosition,this.absolutePosition);
+            return newClone;
+        }
+    }
+	
+module.exports = FlexJsonPosition;

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ted Tyree, Michael Njuguna
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,178 @@
+# FlexJson
+
+## Flexible JSON manipulation library for JavaScript.
+
+## Table of Contents
+
+- [Install](#install)
+- [Usage](#usage)
+- [Why flex-json](#why-flex-json)
+- [How the library works](#how-the-library-works)
+
+## Install
+
+```bash
+# NPM
+npm install flex-json
+
+#PNPM
+pnpm install flex-json
+
+# Yarn
+Yarn install flex-json
+
+```
+
+## Usage
+
+```javascript
+const  FlexJson  = require('flex-json');
+
+// Create a FlexJson object
+const myJson = new FlexJson('{"key": "value"}', true);
+
+// Access properties
+console.log(myJson.jsonString); // Get JSON string representation
+
+// Modify properties
+myJson.keepSpacing = true; // Preserve spacing during deserialization
+
+// Check status and type
+console.log(myJson.Status); // Get status
+console.log(myJson.jsonType); // Get JSON type
+
+// Manipulate JSON object
+myJson.i('key').thisValue = 'new value'; // Set a new value for a key
+
+// Convert JSON object to array
+myJson.ConvertToArray();
+
+// Access array elements
+console.log(myJson.item(0).thisValue); // Access first element in the array
+
+// Use new methods
+myJson.forEach(item => {
+    console.log(item.jsonString); // Iterate through each item and log JSON string
+});
+
+myJson.add('new item', 'newKey'); // Add a new item to the JSON object
+
+console.log(myJson.indexOfKey('newKey')); // Get the index of a key in the JSON object
+
+console.log(myJson.contains('key')); // Check if a key exists in the JSON object
+
+console.log(myJson.getStr('key', 'default')); // Get string value by key with a default value
+
+console.log(myJson.getNum('count', 0)); // Get numeric value by key with a default value
+
+console.log(myJson.getBool('flag', false)); // Get boolean value by key with a default value
+
+```
+
+Serialization and Deserialization examples
+
+```javascript
+const FlexJson = require("flex-json");
+
+// Create an instance of FlexJson
+const flexJson = new FlexJson();
+
+// Example: Deserialize JSON
+const jsonString = '{"name": "John", "age": 30, "city": "New York"}';
+flexJson.Deserialize(jsonString);
+
+// Example: Serialize to JSON
+flexJson.SerializeMe();
+
+// Access serialized JSON string
+const serializedJson = flexJson.SerializeMe();
+console.log(serializedJson);
+```
+
+## Why flex-json
+
+It is simply Json with comments! FlexJson was written to make JSON config files easy to manage and allow for comments. The library also makes it super easy to read a json file (often a config file), modify a single value, and save the file back to the file system without messing up the comments.
+
+- Easy config file formatting
+- Includes comments in both /* */ and // notation
+- Simple to edit Json files
+- Allows for other JavaScript like features such as using either single quotes or double quotes.
+- Can also be used within Node.js apps for other uses such as reading/writing JSON to/from database records and parsing loosely formattted Json in web page content.
+
+## How the library works
+
+### Flex-json syntax
+
+BTW FlexJson as a standard of syntax is not really all that new - it is very much in existence within JavaScript and other syntax standards. Here we just make it available in a library and to facilitate config file parsing and editing.
+
+### Strict Mode
+
+When in strict mode, the FlexJson library reads JSON files in standard JSON format. Comments are not valid and double quotes are required around strings.
+
+Note: If the library is flagged to preserve spacing, Json that has been read in from a file will be written with the same formatting. In other words, the carriage returns and white space are captured during the parsing process and used to re-format the output during the write process.
+
+### Flex Mode
+
+When in flex mode, the FlexJson library has the following features:
+
+- Like JavaScript, comments can be surrounded by /* (start of comment) and */ (end of comment)
+
+- Like Javasrcipt, when a "//" is encountered, the remainder of the line is considered to be a comment
+
+- Strings do not require quotes unless they contain special characters
+
+- Strings can be quoted using double quotes or single quotes
+  
+When in flex mode, all of the following examples of Json are valid:
+
+__example 1:__
+
+```javascript
+{apple: red, banana: yellow, 'sky': 'blue'}
+```
+
+__example 2:__
+
+```javascript
+{"apple": "red"
+ ,'banana': 'yellow'
+ // ,'sky': 'blue'  - this line is commented out
+}
+```
+
+__example 3:__
+
+```javascript
+[ "one, is first"
+  ,'two, is next'
+  /* comment out remainder of array
+  ,"three, is third"
+  ,'four', is last"
+  */
+]
+```
+
+__Note__ that {number:"2"} is not the same as {number:2} because FlexJson will see that the 2 without quotes is a valid number and load it as a numeric.
+
+### Contributing
+
+1. Fork this repository.
+2. Create new branch with feature name.
+3. Create your feature.
+4. Commit and set commit message with feature name.
+5. Push your code to your fork repository.
+6. Create pull request.
+
+### Support
+
+If you like this project, You can support us with starring ⭐ this repository or donate to [uO.heartofkenya.com](https://u0.heartofkenya.com/).
+
+### License
+
+[MIT](LICENSE.txt)
+
+Made with 💙
+
+### Acknowledgements
+
+Special thanks to [u0.heartofKenya.com](https://u0.heartofkenya.com/) and [ebiashararahisi](https://ebiashararahisi.com/) for their work in Machakos, Kenya.

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "flex-json",
+  "version": "0.0.1",
+  "description": "This is a library that makes each 'Node' in the JSON Object/Array a JSON Object with a Key/Value pair.",
+  "main": "FlexJsonClass.js",
+  "authors": "[michael njuguna michaelnjuguna184@gmail.com, ted tyree tedtyree@gmail.com]",
+  "keywords": [
+    "JSON",
+    "JSON Object",
+    "JSON Array",
+    "JSON Object Array",
+    "flexjson"
+  ],
+  "dependencies": {
+    "string-builder": "^0.1.8"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tedtyree/FlexJson.git"
+  },
+  "bugs": {
+    "url": "https://github.com/tedtyree/FlexJson/issues"
+  },
+  "homepage": "https://github.com/tedtyree/FlexJson",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "license": "MIT"
+}