boma 1.0.0 → 2.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Gratio-tech
+Copyright (c) 2025 Nick G.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/index.d.ts

@@ -9,6 +9,18 @@ export interface ReadJSONProps {
     parseJSON?: boolean;
     createIfNotFound?: boolean | SerializableObject | SerializableArray;
 }
+export interface SaveJSONProps {
+    filePath: string;
+    objToSave: Serializable;
+    format?: boolean;
+    logSaving?: boolean;
+}
+export interface addToJSONProps {
+    filePath: string;
+    dataToAdd: SerializableObject | SerializableArray;
+    format?: boolean;
+    logSaving?: boolean;
+}
 export type ErrorWithCode = Error & {
     code: string;
 };
@@ -18,6 +30,7 @@ export type ErrorWithMessage = Error & {
 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 isSerializable: (value: unknown, seen?: WeakSet<object>) => value is Serializable;
+export declare const saveJSON: (saveInput: SaveJSONProps) => void;
 export declare const readJSON: (props: ReadJSONProps) => any;
-export declare const addToJSON: (filePath: string, objToAdd: SerializableObject | SerializableArray) => void;
+export declare const addToJSON: (saveInput: addToJSONProps) => void;

package/dist/index.js

@@ -8,14 +8,51 @@ export const isErrorWithMessage = (error) => {
 export const isSyntaxError = (error) => {
     return error instanceof SyntaxError;
 };
-export const saveJSON = (filePath, objToSave, format) => {
+const getDate = () => {
+    const castedDate = new Date();
+    return castedDate.toLocaleTimeString('ru-RU', { hour: '2-digit', minute: '2-digit' });
+};
+export const isSerializable = (value, seen = new WeakSet()) => {
+    if (value === null || typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
+        return true;
+    }
+    if (Array.isArray(value)) {
+        for (const el of value) {
+            if (!isSerializable(el, seen)) {
+                return false;
+            }
+        }
+        return true;
+    }
+    if (typeof value === "object") {
+        if (seen.has(value)) {
+            return false;
+        }
+        seen.add(value);
+        const obj = value;
+        for (const key in obj) {
+            if (!isSerializable(obj[key], seen)) {
+                return false;
+            }
+        }
+        return true;
+    }
+    return false;
+};
+export const saveJSON = (saveInput) => {
+    const { filePath, objToSave, format = false, logSaving = false } = saveInput;
+    if (!isSerializable(objToSave)) {
+        console.error(`[${getDate()}] Boma get non JSON-serializable object at saveJSON!`);
+        throw new Error(`[${getDate()}] Boma get non JSON-serializable object at saveJSON!`);
+    }
     try {
         const json = format ? JSON.stringify(objToSave, null, 2) : JSON.stringify(objToSave);
         writeFileSync(filePath, json, 'utf8');
+        logSaving && console.log(`[${getDate()}] Write file ${filePath} successfully`);
     }
     catch (error) {
         if (isErrorWithCode(error)) {
-            console.error(`Filesystem error for ${filePath}:`, error);
+            console.error(`[${getDate()}] Boma get filesystem error for ${filePath}:`, error);
         }
         throw error;
     }
@@ -62,19 +99,20 @@ export const readJSON = (props) => {
         return null;
     }
 };
-export const addToJSON = (filePath, objToAdd) => {
+export const addToJSON = (saveInput) => {
+    const { filePath, dataToAdd, format = false, logSaving = false } = saveInput;
     const oldJSON = readJSON({ filePath, createIfNotFound: true });
     if (oldJSON === null || typeof oldJSON !== 'object') {
-        return saveJSON(filePath, objToAdd);
+        return saveJSON({ filePath, objToSave: dataToAdd, logSaving });
     }
-    if (Array.isArray(oldJSON) && Array.isArray(objToAdd)) {
-        saveJSON(filePath, [...oldJSON, ...objToAdd]);
+    if (Array.isArray(oldJSON) && Array.isArray(dataToAdd)) {
+        saveJSON({ filePath, objToSave: [...oldJSON, ...dataToAdd], format, logSaving });
     }
-    else if (!Array.isArray(oldJSON) && !Array.isArray(objToAdd)) {
-        saveJSON(filePath, { ...oldJSON, ...objToAdd });
+    else if (!Array.isArray(oldJSON) && !Array.isArray(dataToAdd)) {
+        saveJSON({ filePath, objToSave: { ...oldJSON, ...dataToAdd }, format, logSaving });
     }
-    else if (Array.isArray(objToAdd) && Object.keys(oldJSON).length === 0) {
-        saveJSON(filePath, [...objToAdd]);
+    else if (Array.isArray(dataToAdd) && Object.keys(oldJSON).length === 0) {
+        saveJSON({ filePath, objToSave: [...dataToAdd], format, logSaving });
     }
     else {
         throw new Error('Cannot merge array with object');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "boma",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Primitive JSON helper",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -21,12 +21,13 @@
       }
     }
   },
-  "author": "Nick",
+  "author": "Nick G.",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/Psychosynthesis/Boma/issues"
   },
   "homepage": "https://github.com/Psychosynthesis/Boma#readme",
+  "keywords": [ "json", "helper" ],
   "devDependencies": {
     "@types/node": "^22.13.10",
     "typescript": "^5.8.x"

package/readme.md

@@ -1,2 +1,23 @@
 # Boma JSON helper
  Super-simple helper for working with JSON
+
+ Work only in synchronous mode.
+
+# Usage
+
+```JS
+const logs = readJSON({ filePath: '/support.log', createIfNotFound: {}, parseJSON: true });
+/*
+logs = {
+  any: {}, //
+  key: {}
+}
+*/
+
+saveJSON(filePath: string, objToSave: Serializable, format?: boolean); // Format for save line break's
+
+addToJSON('/support.log', { 6sdf89g7dghg: { any: "data" } });
+/* Will save:
+"{ "any": {}, "key": {}, "6sdf89g7dghg": { "any": "data" } }"
+*/
+```