boma 2.0.4 → 2.0.6

package/dist/index.d.ts

@@ -10,6 +10,7 @@ export interface ReadJSONProps {
     filePath: string;
     parseJSON?: boolean;
     createIfNotFound?: boolean | SerializableObject | SerializableArray;
+    silent?: boolean;
 }
 export interface SaveJSONProps {
     filePath: string;
@@ -17,6 +18,7 @@ export interface SaveJSONProps {
     format?: boolean;
     logSaving?: boolean;
     replaceNonSerializable?: boolean;
+    silent?: boolean;
 }
 export interface addToJSONProps {
     filePath: string;
@@ -24,6 +26,7 @@ export interface addToJSONProps {
     format?: boolean;
     logSaving?: boolean;
     replaceNonSerializable?: boolean;
+    silent?: boolean;
 }
 export type ErrorWithCode = Error & {
     code: string;
@@ -41,6 +44,8 @@ export interface SerializationIssue {
 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 isObjectLike: (value: unknown) => value is object;
+export declare const isPlainMergeableObject: (value: unknown) => value is Record<string, unknown>;
 export declare const getSerializationIssues: (value: unknown, path?: string, ancestors?: WeakMap<object, string>, issues?: SerializationIssue[]) => SerializationIssue[];
 export declare const isSerializable: (value: unknown) => value is Serializable;
 export declare const sanitizeNonSerializable: (value: unknown, path?: string, ancestors?: WeakMap<object, string>) => Serializable;

package/dist/index.js

@@ -12,10 +12,10 @@ const getDate = () => {
     const castedDate = new Date();
     return castedDate.toLocaleTimeString('ru-RU', { hour: '2-digit', minute: '2-digit' });
 };
-const isObjectLike = (value) => {
+export const isObjectLike = (value) => {
     return typeof value === 'object' && value !== null;
 };
-const isPlainMergeableObject = (value) => {
+export const isPlainMergeableObject = (value) => {
     return typeof value === 'object' && value !== null && !Array.isArray(value);
 };
 const pathJoin = (basePath, key) => {
@@ -35,7 +35,7 @@ const getIssueMessage = (issue) => {
     }
     return `Field "${issue.path}" has non-serializable value of type "${issue.kind}"`;
 };
-export const getSerializationIssues = (value, path = '$', ancestors = new WeakMap(), issues = []) => {
+export const getSerializationIssues = (value, path = '[OBJECT]', ancestors = new WeakMap(), issues = []) => {
     if (value === null) {
         return issues;
     }
@@ -150,10 +150,7 @@ export const sanitizeNonSerializable = (value, path = '$', ancestors = new WeakM
     if (typeof value === 'number') {
         return Number.isFinite(value) ? value : 'non-finite-number';
     }
-    if (typeof value === 'undefined' ||
-        typeof value === 'function' ||
-        typeof value === 'symbol' ||
-        typeof value === 'bigint') {
+    if (['undefined', 'function', 'symbol', 'bigint'].includes(typeof value)) {
         return typeFlagFromValue(value);
     }
     if (Array.isArray(value)) {
@@ -185,11 +182,11 @@ const logSerializationIssues = (issues) => {
     }
 };
 export const saveJSON = (saveInput) => {
-    const { filePath, objToSave, format = false, logSaving = false, replaceNonSerializable = false, } = saveInput;
+    const { filePath, objToSave, format = false, logSaving = false, replaceNonSerializable = false, silent = true, } = saveInput;
     const issues = getSerializationIssues(objToSave);
     if (issues.length > 0) {
-        logSerializationIssues(issues);
-        if (!replaceNonSerializable) {
+        !silent && logSerializationIssues(issues);
+        if (!replaceNonSerializable && !silent) {
             const firstIssue = issues[0];
             const errorMessage = `[${getDate()}] Boma got non JSON-serializable object at saveJSON! ${getIssueMessage(firstIssue)}`;
             console.error(errorMessage);
@@ -202,7 +199,7 @@ export const saveJSON = (saveInput) => {
     try {
         const json = format ? JSON.stringify(valueToSave, null, 2) : JSON.stringify(valueToSave);
         writeFileSync(filePath, json, 'utf8');
-        logSaving && console.log(`[${getDate()}] Write file ${filePath} successfully`);
+        !silent && logSaving && console.log(`[${getDate()}] Write file ${filePath} successfully`);
     }
     catch (error) {
         if (isErrorWithCode(error)) {
@@ -212,7 +209,7 @@ export const saveJSON = (saveInput) => {
     }
 };
 export const readJSON = (props) => {
-    const { filePath, createIfNotFound = false, parseJSON = true } = props;
+    const { filePath, createIfNotFound = false, parseJSON = true, silent = true } = props;
     try {
         const savedfile = readFileSync(filePath, 'utf8');
         if (parseJSON) {
@@ -225,7 +222,7 @@ export const readJSON = (props) => {
             switch (err.code) {
                 case 'ENOENT':
                     if (createIfNotFound) {
-                        console.log('Try to create: ', filePath);
+                        !silent && console.log('Try to create: ', filePath);
                         try {
                             const initialContent = typeof createIfNotFound === 'boolean' ? '{}' : JSON.stringify(createIfNotFound);
                             writeFileSync(filePath, initialContent, 'utf8');
@@ -235,7 +232,7 @@ export const readJSON = (props) => {
                         }
                         return typeof createIfNotFound === 'boolean' ? {} : createIfNotFound;
                     }
-                    console.log('File not found: ', filePath);
+                    console.info("Boma can't find file: ", filePath);
                     return parseJSON ? {} : null;
                 case 'EACCES':
                     console.error(`Access denied for ${filePath}`);
@@ -254,8 +251,8 @@ export const readJSON = (props) => {
     }
 };
 export const addToJSON = (saveInput) => {
-    const { filePath, dataToAdd, format = false, logSaving = false, replaceNonSerializable = false, } = saveInput;
-    const oldJSON = readJSON({ filePath, createIfNotFound: true });
+    const { filePath, dataToAdd, format = false, logSaving = false, replaceNonSerializable = false, silent = true, } = saveInput;
+    const oldJSON = readJSON({ filePath, createIfNotFound: true, silent });
     if (oldJSON === null || typeof oldJSON !== 'object') {
         return saveJSON({
             filePath,
@@ -263,6 +260,7 @@ export const addToJSON = (saveInput) => {
             format,
             logSaving,
             replaceNonSerializable,
+            silent
         });
     }
     if (Array.isArray(oldJSON) && Array.isArray(dataToAdd)) {
@@ -272,6 +270,7 @@ export const addToJSON = (saveInput) => {
             format,
             logSaving,
             replaceNonSerializable,
+            silent
         });
         return;
     }
@@ -282,6 +281,7 @@ export const addToJSON = (saveInput) => {
             format,
             logSaving,
             replaceNonSerializable,
+            silent
         });
         return;
     }
@@ -292,6 +292,7 @@ export const addToJSON = (saveInput) => {
             format,
             logSaving,
             replaceNonSerializable,
+            silent
         });
         return;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "boma",
-  "version": "2.0.4",
+  "version": "2.0.6",
   "description": "Primitive JSON helper",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/readme.md

@@ -6,7 +6,12 @@
 # Usage
 
 ```JS
-const logs = readJSON({ filePath: '/support.log', createIfNotFound: {}, parseJSON: true });
+const logs = readJSON({
+  filePath: '/support.log',
+  createIfNotFound: {},
+  parseJSON: true,
+  silent: true, // Do not log warnings (only file not found will be logged)
+});
 /*
 logs = {
   any: {}, //
@@ -18,7 +23,8 @@ saveJSON({
   filePath: '/test.json',
   objToSave: { any: {}, key: {} },
   format: true,
-  logSaving: false
+  logSaving: false,
+  silent: true, // Do not log warnings
 }); // Format for save line break's
 /* Will save:
 {
@@ -40,6 +46,8 @@ addToJSON({
 ```
 
 ## Types
+Main types:
+
 ```typescript
 export type SerializablePrimitive = string | number | boolean | null;
 export type SerializableArray = Serializable[];
@@ -58,6 +66,7 @@ export interface SaveJSONProps {
   format?: boolean
   logSaving?: boolean;
   replaceNonSerializable?: boolean; // Заменять несереализуемые значения их типом
+  silent?: boolean; // Не выводим предупреждения
 }
 
 export interface addToJSONProps {
@@ -65,5 +74,15 @@ export interface addToJSONProps {
   dataToAdd: SerializableObject | SerializableArray;
   format?: boolean
   logSaving?: boolean;
+  silent?: boolean; // Не выводим предупреждения
 }
+
+// We also export some helpers:
+export const isSerializable = (value: unknown) => boolean;
+export const isObjectLike = (value: unknown) => boolean;
+export const isPlainMergeableObject = (value: unknown) => boolean;
+
+export const isErrorWithCode = (error: unknown) => boolean;
+export const isErrorWithMessage = (error: unknown) => boolean;
+export const isSyntaxError = (error: unknown) => boolean;
 ```