boma 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Gratio-tech
+
+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/dist/index.d.ts

@@ -0,0 +1,23 @@
+export type SerializablePrimitive = string | number | boolean | null;
+export type SerializableArray = Serializable[];
+export type SerializableObject = {
+    [key: string]: Serializable;
+};
+export type Serializable = SerializablePrimitive | SerializableArray | SerializableObject;
+export interface ReadJSONProps {
+    filePath: string;
+    parseJSON?: boolean;
+    createIfNotFound?: boolean | SerializableObject | SerializableArray;
+}
+export type ErrorWithCode = Error & {
+    code: string;
+};
+export type ErrorWithMessage = Error & {
+    message: any;
+};
+export declare const isErrorWithCode: (error: unknown) => error is ErrorWithCode;
+export declare const isErrorWithMessage: (error: unknown) => error is ErrorWithMessage;
+export declare const isSyntaxError: (error: unknown) => error is SyntaxError;
+export declare const saveJSON: (filePath: string, objToSave: Serializable, format?: boolean) => void;
+export declare const readJSON: (props: ReadJSONProps) => any;
+export declare const addToJSON: (filePath: string, objToAdd: SerializableObject | SerializableArray) => void;

package/dist/index.js

@@ -0,0 +1,82 @@
+import { readFileSync, writeFileSync } from 'fs';
+export const isErrorWithCode = (error) => {
+    return error instanceof Error && 'code' in error;
+};
+export const isErrorWithMessage = (error) => {
+    return error instanceof Error && 'message' in error;
+};
+export const isSyntaxError = (error) => {
+    return error instanceof SyntaxError;
+};
+export const saveJSON = (filePath, objToSave, format) => {
+    try {
+        const json = format ? JSON.stringify(objToSave, null, 2) : JSON.stringify(objToSave);
+        writeFileSync(filePath, json, 'utf8');
+    }
+    catch (error) {
+        if (isErrorWithCode(error)) {
+            console.error(`Filesystem error for ${filePath}:`, error);
+        }
+        throw error;
+    }
+};
+export const readJSON = (props) => {
+    const { filePath, createIfNotFound = false, parseJSON = true } = props;
+    try {
+        const savedfile = readFileSync(filePath, 'utf8');
+        if (parseJSON) {
+            return savedfile.trim() === "" ? null : JSON.parse(savedfile);
+        }
+        return savedfile;
+    }
+    catch (err) {
+        if (isErrorWithCode(err)) {
+            switch (err.code) {
+                case 'ENOENT':
+                    if (createIfNotFound) {
+                        console.log('Try to create: ', filePath);
+                        try {
+                            const initialContent = typeof createIfNotFound === 'boolean' ? '{}' : JSON.stringify(createIfNotFound);
+                            writeFileSync(filePath, initialContent, 'utf8');
+                        }
+                        catch (writeErr) {
+                            console.error(`Error creating file ${filePath}: `, writeErr, '\n');
+                        }
+                        return typeof createIfNotFound === 'boolean' ? {} : createIfNotFound;
+                    }
+                    console.log('File not found: ', filePath);
+                    return parseJSON ? {} : null;
+                case 'EACCES':
+                    console.error(`Access denied for ${filePath}`);
+                    return null;
+                default:
+                    console.error(`Some filesystem error when try readJSON: ${filePath}`);
+                    return null;
+            }
+        }
+        if (isSyntaxError(err)) {
+            console.error('File ', filePath, ' has incorrect JSON syntax', '\n');
+            return null;
+        }
+        console.error('Function readJSON error:', err, '\n');
+        return null;
+    }
+};
+export const addToJSON = (filePath, objToAdd) => {
+    const oldJSON = readJSON({ filePath, createIfNotFound: true });
+    if (oldJSON === null || typeof oldJSON !== 'object') {
+        return saveJSON(filePath, objToAdd);
+    }
+    if (Array.isArray(oldJSON) && Array.isArray(objToAdd)) {
+        saveJSON(filePath, [...oldJSON, ...objToAdd]);
+    }
+    else if (!Array.isArray(oldJSON) && !Array.isArray(objToAdd)) {
+        saveJSON(filePath, { ...oldJSON, ...objToAdd });
+    }
+    else if (Array.isArray(objToAdd) && Object.keys(oldJSON).length === 0) {
+        saveJSON(filePath, [...objToAdd]);
+    }
+    else {
+        throw new Error('Cannot merge array with object');
+    }
+};

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "boma",
+  "version": "1.0.0",
+  "description": "Primitive JSON helper",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Psychosynthesis/Boma.git"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "default": "./dist/index.js",
+        "types": "./dist/index.d.ts"
+      }
+    }
+  },
+  "author": "Nick",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Psychosynthesis/Boma/issues"
+  },
+  "homepage": "https://github.com/Psychosynthesis/Boma#readme",
+  "devDependencies": {
+    "@types/node": "^22.13.10",
+    "typescript": "^5.8.x"
+  }
+}

package/readme.md

@@ -0,0 +1,2 @@
+# Boma JSON helper
+ Super-simple helper for working with JSON