json-storage-formatter 1.0.6 → 1.0.8

package/lib/bundle.js

@@ -0,0 +1 @@
+!function(r,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports["json-storage-formatter"]=t():r["json-storage-formatter"]=t()}(this,(()=>(()=>{"use strict";var r={991:(r,t,e)=>{var n=Object.create?function(r,t,e,n){void 0===n&&(n=e);var o=Object.getOwnPropertyDescriptor(t,e);o&&!("get"in o?!t.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return t[e]}}),Object.defineProperty(r,n,o)}:function(r,t,e,n){void 0===n&&(n=e),r[n]=t[e]};Object.defineProperty(t,"__esModule",{value:!0}),function(r,t){for(var e in r)"default"===e||Object.prototype.hasOwnProperty.call(t,e)||n(t,r,e)}(e(729),t)},729:(r,t)=>{function e(r){return e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(r){return typeof r}:function(r){return r&&"function"==typeof Symbol&&r.constructor===Symbol&&r!==Symbol.prototype?"symbol":typeof r},e(r)}function n(r,t,n){return(t=function(r){var t=function(r,t){if("object"!==e(r)||null===r)return r;var n=r[Symbol.toPrimitive];if(void 0!==n){var o=n.call(r,"string");if("object"!==e(o))return o;throw new TypeError("@@toPrimitive must return a primitive value.")}return String(r)}(r);return"symbol"===e(t)?t:String(t)}(t))in r?Object.defineProperty(r,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):r[t]=n,r}function o(r,t){if(r){if("string"==typeof r)return i(r,t);var e=Object.prototype.toString.call(r).slice(8,-1);return"Object"===e&&r.constructor&&(e=r.constructor.name),"Map"===e||"Set"===e?Array.from(r):"Arguments"===e||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(e)?i(r,t):void 0}}function i(r,t){(null==t||t>r.length)&&(t=r.length);for(var e=0,n=new Array(t);e<t;e++)n[e]=r[e];return n}Object.defineProperty(t,"__esModule",{value:!0}),t.formatToStore=t.formatFromStore=t.isPrimitive=t.isFunction=t.isRegex=t.isDate=t.isString=t.isBoolean=t.isNumber=t.isNil=t.clone=void 0,t.clone=function(r){var e,u=(arguments.length>1&&void 0!==arguments[1]?arguments[1]:{}).shallow;if((0,t.isPrimitive)(r)||(0,t.isDate)(r))return r;if(Array.isArray(r))return u?function(r){if(Array.isArray(r))return i(r)}(e=r)||function(r){if("undefined"!=typeof Symbol&&null!=r[Symbol.iterator]||null!=r["@@iterator"])return Array.from(r)}(e)||o(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}():r.map((function(r){return(0,t.clone)(r)}));if(r instanceof Map){var a=Array.from(r.entries());return u?new Map(a):new Map(a.map((function(r){return(0,t.clone)(r)})))}if(r instanceof Set){var f=Array.from(r.values());return u?new Set(f):new Set(f.map((function(r){return(0,t.clone)(r)})))}return r instanceof RegExp?new RegExp(r.toString()):(0,t.isFunction)(r)?u?r:Object.create(r):u?Object.assign({},r):r instanceof Error?new Error(r.message):Object.keys(r).reduce((function(e,o){var i=r[o];return Object.assign(Object.assign({},e),n({},o,(0,t.clone)(i)))}),{})},t.isNil=function(r){return null==r},t.isNumber=function(r){return"number"==typeof r},t.isBoolean=function(r){return"boolean"==typeof r},t.isString=function(r){return"string"==typeof r},t.isDate=function(r){return r instanceof Date},t.isRegex=function(r){return r instanceof RegExp},t.isFunction=function(r){return"function"==typeof r||r instanceof Function},t.isPrimitive=function(r){return(0,t.isNil)(r)||(0,t.isNumber)(r)||(0,t.isBoolean)(r)||(0,t.isString)(r)||"symbol"===e(r)},t.formatFromStore=function(r){return function(r){var e,i;if((0,t.isPrimitive)(r))return r;if("date"===(null==r?void 0:r.$t))return new Date(r.$v);if("map"===(null==r?void 0:r.$t)){var u=(null!==(e=r.$v)&&void 0!==e?e:[]).map((function(r){var e,n,i=(n=2,function(r){if(Array.isArray(r))return r}(e=r)||function(r,t){var e=null==r?null:"undefined"!=typeof Symbol&&r[Symbol.iterator]||r["@@iterator"];if(null!=e){var n,o,i,u,a=[],f=!0,c=!1;try{if(i=(e=e.call(r)).next,0===t){if(Object(e)!==e)return;f=!1}else for(;!(f=(n=i.call(e)).done)&&(a.push(n.value),a.length!==t);f=!0);}catch(r){c=!0,o=r}finally{try{if(!f&&null!=e.return&&(u=e.return(),Object(u)!==u))return}finally{if(c)throw o}}return a}}(e,n)||o(e,n)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()),u=i[0],a=i[1];return[u,(0,t.formatFromStore)(a)]}));return new Map(u)}if("set"===(null==r?void 0:r.$t)){var a=null!==(i=r.$v)&&void 0!==i?i:[].map((function(r){return(0,t.formatFromStore)(r)}));return new Set(a)}return"regex"===(null==r?void 0:r.$t)?new RegExp(r.$v):"error"===(null==r?void 0:r.$t)?new Error(r.$v):Array.isArray(r)?r.map((function(r){return(0,t.formatFromStore)(r)})):"function"===(null==r?void 0:r.$t)?Function("(".concat(r.$v,")(...arguments)")):Object.keys(r).reduce((function(e,o){var i=r[o];return Object.assign(Object.assign({},e),n({},o,(0,t.formatFromStore)(i)))}),{})}((arguments.length>1&&void 0!==arguments[1]?arguments[1]:{}).jsonParse?JSON.parse(r):(0,t.clone)(r))},t.formatToStore=function(r){var o=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{stringify:!1},i=o.stringify,u=o.validator,a=o.excludeTypes,f=o.excludeKeys,c=new Set(null!=a?a:[]),s=new Set(null!=f?f:[]),l=c.size||s.size,m=null!=u?u:function(r){var t=r.key,n=r.value;if(!l)return!0;var o=s.has(t),i=c.has(e(n));return!o&&!i},v=function r(e){if((0,t.isPrimitive)(e))return e;if(Array.isArray(e))return e.map((function(t){return r(t)}));if(e instanceof Map)return{$t:"map",$v:Array.from(e.entries()).map((function(t){return r(t)}))};if(e instanceof Set)return{$t:"set",$v:Array.from(e.values()).map((function(t){return r(t)}))};if((0,t.isDate)(e))return{$t:"date",$v:e.toISOString()};if((0,t.isRegex)(e))return{$t:"regex",$v:e.toString()};if((0,t.isFunction)(e)){var o;try{o={$t:"function",$v:e.toString()}}catch(r){o={$t:"error",$v:"Error: Could not serialize function"}}return o}return e instanceof Error?{$t:"error",$v:e.message}:Object.keys(e).reduce((function(t,o){var i=e[o],u=r(i);return m({obj:e,key:o,value:u})?Object.assign(Object.assign({},t),n({},o,r(i))):t}),{})}((0,t.clone)(r));return i?JSON.stringify(v):v}}},t={};return function e(n){var o=t[n];if(void 0!==o)return o.exports;var i=t[n]={exports:{}};return r[n](i,i.exports,e),i.exports}(991)})()));

package/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './json-storage-formatter';

package/lib/json-storage-formatter.d.ts

@@ -1,14 +1,19 @@
-export type IValueWithMedaData = {
-    $t?: 'map' | 'set' | 'date' | 'regex' | 'error';
+export type IValueWithMetaData = {
+    $t?: 'map' | 'set' | 'date' | 'regex' | 'error' | 'function';
     $v?: unknown;
 };
 /**
  * Deep clone an object, it also suppors Map, Set, Arrays
- * @param obj
+ * @param value
  * @returns
  * A deep clone of the object
  * */
-export declare const clone: <T>(obj: T) => T;
+export declare const clone: <T>(value: T, { shallow, }?: {
+    /**
+     * If true, it will only clone the first level of the object
+     */
+    shallow?: boolean;
+}) => T;
 /**
  * Check if a value is null or undefined
  * @param value
@@ -54,6 +59,12 @@ export declare const isDate: (value: unknown) => boolean;
  * @returns true if the value is a RegExp, false otherwise
  * */
 export declare const isRegex: (value: unknown) => boolean;
+/**
+ * Check if a value is a function
+ * @param value The value to check
+ * @returns true if the value is a function, false otherwise
+ * */
+export declare const isFunction: (value: unknown) => boolean;
 /**
  * Check if a value is a primitive
  * @param value
@@ -67,18 +78,32 @@ export declare const isPrimitive: (value: unknown) => boolean;
  * Format an value with possible metadata to his original form, it also supports Map, Set, Arrays
  * @param value
  * @returns
- * Orinal form of the value
+ * Original form of the value
  */
-export declare const formatFromStore: <T = unknown>(value: unknown) => T;
+export declare const formatFromStore: <T = unknown>(value: unknown, { jsonParse, }?: {
+    /** If the value should be parsed from json before formatting */
+    jsonParse?: boolean;
+}) => T;
+export type TPrimitives = 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'function' | 'object';
 /**
  * Add metadata to a value to store it as json, it also supports Map, Set, Arrays,
- * Returns a new object wich is a clone of the original object with metadata
+ * Returns a new object which is a clone of the original object with metadata
  * @template {TValue} The type of the value to format
  * @template {TStringify} If the value should be stringified
  * @param {TValue} value The value to format
  * @param {{ stringify: TStringify }} { stringify: boolean } If the value should be stringified
  */
-export declare const formatToStore: <TValue, TStringify extends boolean = false>(value: TValue, { stringify }?: {
-    stringify: TStringify;
+export declare const formatToStore: <TValue, TStringify extends boolean = false>(value: TValue, { stringify, validator, excludeTypes, excludeKeys, }?: {
+    stringify?: TStringify;
+    excludeTypes?: TPrimitives[] | Set<TPrimitives>;
+    excludeKeys?: string[] | Set<string>;
+    /**
+     * Returns true if the value should be included in the stringified version,
+     * if provided it will override the default validator and the excludesTypes and excludeKeys
+     */
+    validator?: ({ obj, key, value, }: {
+        obj: unknown;
+        key: string;
+        value: any;
+    }) => boolean | undefined;
 }) => TStringify extends true ? string : unknown;
-//# sourceMappingURL=json-storage-formatter.d.ts.map

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "json-storage-formatter",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Package for json stringify objects without losing data types",
-  "main": "lib/json-storage-formatter.js",
+  "main": "lib/bundle.js",
+  "types": "lib/index.d.ts",
   "files": [
     "lib"
   ],
@@ -10,7 +11,7 @@
     "test:debug": "node --inspect-brk node_modules/.bin/jest --watch --runInBand",
     "test:quick": "jest --maxWorkers=4 -c --no-watchman -u",
     "test:coverage": "jest --maxWorkers=4 -c --colors --no-watchman --verbose --coverage",
-    "build": "tsc",
+    "build": "webpack --config webpack.config.js",
     "prepare": "npm run build",
     "version": "npm run format && git add -A src",
     "postversion": "git push && git push --tags"
@@ -34,10 +35,18 @@
   },
   "homepage": "https://github.com/johnny-quesada-developer/json-storage-formatter#readme",
   "devDependencies": {
+    "@babel/core": "^7.21.3",
+    "@babel/plugin-transform-modules-commonjs": "^7.21.2",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/preset-typescript": "^7.21.0",
     "@types/jest": "^26.0.17",
     "@types/lodash": "^4.14.165",
+    "babel-loader": "^9.1.2",
     "jest": "^29.3.1",
     "ts-jest": "^29.0.3",
-    "typescript": "^4.1.2"
+    "ts-loader": "^9.4.2",
+    "typescript": "^4.1.2",
+    "webpack": "^5.76.3",
+    "webpack-cli": "^5.0.1"
   }
 }

package/lib/json-storage-formatter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"json-storage-formatter.d.ts","sourceRoot":"","sources":["../src/json-storage-formatter.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;IAChD,EAAE,CAAC,EAAE,OAAO,CAAC;CACd,CAAC;AAEF;;;;;KAKK;AACL,eAAO,MAAM,KAAK,kBAiDjB,CAAC;AAEF;;;;;;KAMK;AACL,eAAO,MAAM,KAAK,UAAW,OAAO,YAA0C,CAAC;AAE/E;;;;;;MAMM;AACN,eAAO,MAAM,QAAQ,UAAW,OAAO,YAA8B,CAAC;AAEtE;;;;;;KAMK;AACL,eAAO,MAAM,SAAS,UAAW,OAAO,YAA+B,CAAC;AAExE;;;;;;KAMK;AACL,eAAO,MAAM,QAAQ,UAAW,OAAO,YAA8B,CAAC;AAEtE;;;;;GAKG;AACH,eAAO,MAAM,MAAM,UAAW,OAAO,YAA0B,CAAC;AAEhE;;;;KAIK;AACL,eAAO,MAAM,OAAO,UAAW,OAAO,YAA4B,CAAC;AAEnE;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,UAAW,OAAO,YAKf,CAAC;AAE5B;;;;;GAKG;AACH,eAAO,MAAM,eAAe,uBAAwB,OAAO,MAgE1D,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa;;gDA2FzB,CAAC"}

package/lib/json-storage-formatter.js

@@ -1,224 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatToStore = exports.formatFromStore = exports.isPrimitive = exports.isRegex = exports.isDate = exports.isString = exports.isBoolean = exports.isNumber = exports.isNil = exports.clone = void 0;
-/**
- * Deep clone an object, it also suppors Map, Set, Arrays
- * @param obj
- * @returns
- * A deep clone of the object
- * */
-const clone = (obj) => {
-    if ((0, exports.isPrimitive)(obj) || (0, exports.isDate)(obj)) {
-        return obj;
-    }
-    const isArray = Array.isArray(obj);
-    if (isArray) {
-        return obj.map((item) => (0, exports.clone)(item));
-    }
-    const isMap = obj instanceof Map;
-    if (isMap) {
-        const pairs = Array.from(obj.entries());
-        return new Map(pairs.map((pair) => (0, exports.clone)(pair)));
-    }
-    const isSet = obj instanceof Set;
-    if (isSet) {
-        const values = Array.from(obj.values());
-        return new Set(values.map((value) => (0, exports.clone)(value)));
-    }
-    const isReg = obj instanceof RegExp;
-    if (isReg) {
-        return new RegExp(obj.toString());
-    }
-    const isError = obj instanceof Error;
-    if (isError) {
-        return new Error(obj.message);
-    }
-    const keys = Object.keys(obj);
-    return keys.reduce((acumulator, key) => {
-        const value = obj[key];
-        return Object.assign(Object.assign({}, acumulator), { [key]: (0, exports.clone)(value) });
-    }, {});
-};
-exports.clone = clone;
-/**
- * Check if a value is null or undefined
- * @param value
- * @returns
- * true if the value is null or undefined
- * false otherwise
- * */
-const isNil = (value) => value === null || value === undefined;
-exports.isNil = isNil;
-/**
- * Check if a value is a number
- * @param value
- * @returns
- *  true if the value is a number
- * false otherwise
- *  */
-const isNumber = (value) => typeof value === 'number';
-exports.isNumber = isNumber;
-/**
- * Check if a value is a boolean
- * @param value
- * @returns
- * true if the value is a boolean
- * false otherwise
- * */
-const isBoolean = (value) => typeof value === 'boolean';
-exports.isBoolean = isBoolean;
-/**
- * Check if a value is a string
- * @param value
- * @returns
- * true if the value is a string
- * false otherwise
- * */
-const isString = (value) => typeof value === 'string';
-exports.isString = isString;
-/** Check if a value is a Date
- * @param value
- * @returns
- * true if the value is a Date
- * false otherwise
- */
-const isDate = (value) => value instanceof Date;
-exports.isDate = isDate;
-/**
- * Check if a value is a RegExp
- * @param value The value to check
- * @returns true if the value is a RegExp, false otherwise
- * */
-const isRegex = (value) => value instanceof RegExp;
-exports.isRegex = isRegex;
-/**
- * Check if a value is a primitive
- * @param value
- * @returns
- * true if the value is a primitive
- * false otherwise
- * null, number, boolean, string, symbol
- */
-const isPrimitive = (value) => (0, exports.isNil)(value) ||
-    (0, exports.isNumber)(value) ||
-    (0, exports.isBoolean)(value) ||
-    (0, exports.isString)(value) ||
-    typeof value === 'symbol';
-exports.isPrimitive = isPrimitive;
-/**
- * Format an value with possible metadata to his original form, it also supports Map, Set, Arrays
- * @param value
- * @returns
- * Orinal form of the value
- */
-const formatFromStore = (value) => {
-    const format = (obj) => {
-        var _a, _b;
-        if ((0, exports.isPrimitive)(obj)) {
-            return obj;
-        }
-        const isMetaDate = (obj === null || obj === void 0 ? void 0 : obj.$t) === 'date';
-        if (isMetaDate) {
-            return new Date(obj.$v);
-        }
-        const isMetaMap = (obj === null || obj === void 0 ? void 0 : obj.$t) === 'map';
-        if (isMetaMap) {
-            const mapData = ((_a = obj.$v) !== null && _a !== void 0 ? _a : []).map(([key, item]) => [key, (0, exports.formatFromStore)(item)]);
-            return new Map(mapData);
-        }
-        const isMetaSet = (obj === null || obj === void 0 ? void 0 : obj.$t) === 'set';
-        if (isMetaSet) {
-            const setData = (_b = obj.$v) !== null && _b !== void 0 ? _b : [].map((item) => (0, exports.formatFromStore)(item));
-            return new Set(setData);
-        }
-        const isMetaReg = (obj === null || obj === void 0 ? void 0 : obj.$t) === 'regex';
-        if (isMetaReg) {
-            return new RegExp(obj.$v);
-        }
-        const isMetaError = (obj === null || obj === void 0 ? void 0 : obj.$t) === 'error';
-        if (isMetaError) {
-            return new Error(obj.$v);
-        }
-        const isArray = Array.isArray(obj);
-        if (isArray) {
-            return obj.map((item) => (0, exports.formatFromStore)(item));
-        }
-        const keys = Object.keys(obj);
-        return keys.reduce((acumulator, key) => {
-            const unformatedValue = obj[key];
-            return Object.assign(Object.assign({}, acumulator), { [key]: (0, exports.formatFromStore)(unformatedValue) });
-        }, {});
-    };
-    return format((0, exports.clone)(value));
-};
-exports.formatFromStore = formatFromStore;
-/**
- * Add metadata to a value to store it as json, it also supports Map, Set, Arrays,
- * Returns a new object wich is a clone of the original object with metadata
- * @template {TValue} The type of the value to format
- * @template {TStringify} If the value should be stringified
- * @param {TValue} value The value to format
- * @param {{ stringify: TStringify }} { stringify: boolean } If the value should be stringified
- */
-const formatToStore = (value, { stringify } = { stringify: false }) => {
-    const format = (obj) => {
-        if ((0, exports.isPrimitive)(obj)) {
-            return obj;
-        }
-        const isArray = Array.isArray(obj);
-        if (isArray) {
-            return obj.map((item) => (0, exports.formatToStore)(item));
-        }
-        const isMap = obj instanceof Map;
-        if (isMap) {
-            const pairs = Array.from(obj.entries());
-            const value = {
-                $t: 'map',
-                $v: pairs.map((pair) => (0, exports.formatToStore)(pair)),
-            };
-            return value;
-        }
-        const isSet = obj instanceof Set;
-        if (isSet) {
-            const values = Array.from(obj.values());
-            const value = {
-                $t: 'set',
-                $v: values.map((item) => (0, exports.formatToStore)(item)),
-            };
-            return value;
-        }
-        if ((0, exports.isDate)(obj)) {
-            const value = {
-                $t: 'date',
-                $v: obj.toISOString(),
-            };
-            return value;
-        }
-        if ((0, exports.isRegex)(obj)) {
-            const value = {
-                $t: 'regex',
-                $v: obj.toString(),
-            };
-            return value;
-        }
-        const isError = obj instanceof Error;
-        if (isError) {
-            const value = {
-                $t: 'error',
-                $v: obj.message,
-            };
-            return value;
-        }
-        const keys = Object.keys(obj);
-        return keys.reduce((acumulator, key) => {
-            const prop = obj[key];
-            return Object.assign(Object.assign({}, acumulator), { [key]: (0, exports.formatToStore)(prop) });
-        }, {});
-    };
-    const objectWithMetadata = format((0, exports.clone)(value));
-    const result = stringify
-        ? JSON.stringify(objectWithMetadata)
-        : objectWithMetadata;
-    return result;
-};
-exports.formatToStore = formatToStore;