json-storage-formatter 2.0.4 → 2.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-storage-formatter",
-  "version": "2.0.4",
+  "version": "2.0.6",
   "description": "Package for json stringify objects without losing data types",
   "main": "./bundle.js",
   "types": "./index.d.ts",
@@ -78,7 +78,8 @@
     "build": "webpack --config webpack.config.js",
     "prepare": "npm run build",
     "version": "npm run format && git add -A src",
-    "postversion": "git push && git push --tags"
+    "postversion": "git push && git push --tags",
+    "clean": "find . -maxdepth 1 -type f \\( -name '*.js' -o -name '*.d.ts' \\) ! -name 'webpack.config.js' -exec rm {} +"
   },
   "repository": {
     "type": "git",

package/clone.d.ts

@@ -1,12 +0,0 @@
-/**
- * Deep clone an object, it also support Map, Set, Arrays
- * @param value
- * @returns
- * A deep clone of the object
- * */
-export declare const clone: <T>(value: T, { shallow, }?: {
-    /**
-     * If true, it will only clone the first level of the object
-     */
-    shallow?: boolean;
-}) => T;

package/formatFromStore.d.ts

@@ -1,11 +0,0 @@
-/**
- * Format an value with possible metadata to his original form, it also supports Map, Set, Arrays
- * @param value
- * @returns
- * Original form of the value
- */
-export declare const formatFromStore: <T = unknown>(value: unknown, { jsonParse, sortKeys, }?: {
-    /** If the value should be parsed from json before formatting */
-    jsonParse?: boolean;
-    sortKeys?: boolean | ((a: string, b: string) => number);
-}) => T;

package/formatToStore.d.ts

@@ -1,24 +0,0 @@
-import { TPrimitives } from "./types";
-/**
- * Add metadata to a value to store it as json, it also supports Map, Set, Arrays,
- * 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, validator, excludeTypes, excludeKeys, sortKeys, }?: {
-    stringify?: TStringify;
-    excludeTypes?: TPrimitives[] | Set<TPrimitives>;
-    excludeKeys?: string[] | Set<string>;
-    sortKeys?: boolean | ((a: string, b: string) => number);
-    /**
-     * 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: unknown;
-    }) => boolean | undefined;
-}) => TStringify extends true ? string : unknown;

package/index.d.ts

@@ -1,12 +0,0 @@
-export { clone } from "./clone";
-export { isNil } from "./isNil";
-export { isNumber } from "./isNumber";
-export { isBoolean } from "./isBoolean";
-export { isString } from "./isString";
-export { isDate } from "./isDate";
-export { isRegex } from "./isRegex";
-export { isFunction } from "./isFunction";
-export { isPrimitive } from "./isPrimitive";
-export { TPrimitives, IValueWithMetaData } from "./types";
-export { formatFromStore } from "./formatFromStore";
-export { formatToStore } from "./formatToStore";

package/isBoolean.d.ts

@@ -1,8 +0,0 @@
-/**
- * Check if a value is a boolean
- * @param value
- * @returns
- * true if the value is a boolean
- * false otherwise
- * */
-export declare const isBoolean: (value: unknown) => value is boolean;

package/isDate.d.ts

@@ -1,7 +0,0 @@
-/** Check if a value is a Date
- * @param value
- * @returns
- * true if the value is a Date
- * false otherwise
- */
-export declare const isDate: (value: unknown) => value is Date;

package/isFunction.d.ts

@@ -1,6 +0,0 @@
-/**
- * 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: <T extends (...args: Parameters<T>) => ReturnType<T>>(value: unknown) => value is NonNullable<T>;

package/isNil.d.ts

@@ -1,8 +0,0 @@
-/**
- * Check if a value is null or undefined
- * @param value
- * @returns
- * true if the value is null or undefined
- * false otherwise
- * */
-export declare const isNil: (value: unknown) => value is null | undefined;

package/isNumber.d.ts

@@ -1,8 +0,0 @@
-/**
- * Check if a value is a number
- * @param value
- * @returns
- *  true if the value is a number
- * false otherwise
- *  */
-export declare const isNumber: (value: unknown) => value is number;

package/isPrimitive.d.ts

@@ -1,9 +0,0 @@
-/**
- * Check if a value is a primitive
- * @param value
- * @returns
- * true if the value is a primitive
- * false otherwise
- * null, number, boolean, string, symbol
- */
-export declare const isPrimitive: (value: unknown) => value is string | number | boolean | symbol;

package/isRegex.d.ts

@@ -1,6 +0,0 @@
-/**
- * Check if a value is a RegExp
- * @param value The value to check
- * @returns true if the value is a RegExp, false otherwise
- * */
-export declare const isRegex: (value: unknown) => value is RegExp;

package/isString.d.ts

@@ -1,8 +0,0 @@
-/**
- * Check if a value is a string
- * @param value
- * @returns
- * true if the value is a string
- * false otherwise
- * */
-export declare const isString: (value: unknown) => value is string;

package/types.d.ts

@@ -1,5 +0,0 @@
-export type IValueWithMetaData = {
-    $t?: 'map' | 'set' | 'date' | 'regex' | 'error' | 'function';
-    $v?: unknown;
-};
-export type TPrimitives = 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'function' | 'object';

package/webpack.config.js

@@ -1,66 +0,0 @@
-const path = require('path');
-
-module.exports = {
-  mode: 'production',
-  entry: {
-    bundle: "./src/index.ts",
-    clone: "./src/clone.ts",
-    isNil: "./src/isNil.ts",
-    isNumber: "./src/isNumber.ts",
-    isBoolean: "./src/isBoolean.ts",
-    isString: "./src/isString.ts",
-    isDate: "./src/isDate.ts",
-    isRegex: "./src/isRegex.ts",
-    isFunction: "./src/isFunction.ts",
-    isPrimitive: "./src/isPrimitive.ts",
-    types: "./src/types.ts",
-    formatFromStore: "./src/formatFromStore.ts",
-    formatToStore: "./src/formatToStore.ts",
-  },
-  output: {
-    path: path.resolve(__dirname, 'lib'),
-    filename: ({ chunk: { name } }) => {
-      if (name.includes('worker')) {
-        return `${name}.worker.js`;
-      }
-
-      return `${name}.js`;
-    },
-    libraryTarget: 'umd',
-    library: 'json-storage-formatter',
-    globalObject: 'this',
-  },
-  resolve: {
-    extensions: ['.ts', '.js'],
-    alias: {
-      'json-storage-formatter': path.resolve(
-        __dirname,
-        'node_modules/json-storage-formatter/package.json'
-      ),
-    },
-  },
-  module: {
-    rules: [
-      {
-        test: /\.ts$/,
-        use: [
-          {
-            loader: 'babel-loader',
-            options: {
-              presets: ['@babel/preset-env', '@babel/preset-typescript'],
-              plugins: [
-                '@babel/plugin-transform-modules-commonjs',
-                '@babel/plugin-proposal-class-properties',
-                '@babel/plugin-proposal-export-namespace-from',
-              ],
-            },
-          },
-          {
-            loader: 'ts-loader',
-          },
-        ],
-        exclude: /node_modules/,
-      },
-    ],
-  },
-};