@elliemae/ds-props-helpers 2.0.1 → 2.1.0-rc.0

package/cjs/defaultProps/useMemoMergePropsWithDefault.js

@@ -16,9 +16,9 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 var _defineProperty__default = /*#__PURE__*/_interopDefaultLegacy(_defineProperty);
 var deepequal__default = /*#__PURE__*/_interopDefaultLegacy(deepequal);
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty__default["default"](target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty__default["default"](target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 
 const useMemoCompare = (next, compare) => {

package/cjs/validation/typescriptGuards.js

@@ -8,6 +8,7 @@ require('core-js/modules/esnext.iterator.for-each.js');
 
 const isPrimitiveType = format => ['string', 'number', 'boolean'].includes(format);
 const isUndefined = format => format === '"undefined"';
+const isNull = format => format === '"null"';
 const isUnion = format => {
   let depth = 0;
   let satisfies = false;
@@ -26,6 +27,7 @@ const isSomethingWithParenthesis = format => !isUnion(format) && format[0] === '
 exports.isArray = isArray;
 exports.isFunction = isFunction;
 exports.isJSXorNode = isJSXorNode;
+exports.isNull = isNull;
 exports.isObject = isObject;
 exports.isPrimitiveType = isPrimitiveType;
 exports.isSomethingWithParenthesis = isSomethingWithParenthesis;

package/cjs/validation/typescriptValidator.js

@@ -19,7 +19,13 @@ var typescriptParsers = require('./typescriptParsers.js');
 // and optionally recursively apply `validateValueWithFormat`
 // in smaller parts
 const validateUndefined = (schemaName, key, value, format) => {
-  if (value !== undefined) {
+  if (value !== undefined || value === 'undefined') {
+    errorTemplates.throwTypeError(schemaName, key, value, format);
+  }
+};
+
+const validateNull = (schemaName, key, value, format) => {
+  if (value !== null || value === 'null') {
     errorTemplates.throwTypeError(schemaName, key, value, format);
   }
 };
@@ -44,14 +50,22 @@ const validateArray = (schemaName, key, value, format, validationsMemo, nextVali
 
 
   value.forEach((val, index) => {
+    // this is a recursive func, we need to invoke it before it's defined.
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
     validateValueWithFormat(schemaName, "".concat(key, "[").concat(index, "]"), val, format.slice(0, -2), validationsMemo, nextValidationsMemo);
   });
 };
 
+function isObjectType(value) {
+  return !(typeof value !== 'object' || Array.isArray(value));
+}
+
 const validateObject = (schemaName, key, value, format, validationsMemo, nextValidationsMemo) => {
-  // Check that we have an object
-  if (typeof value !== 'object' || Array.isArray(value)) {
+  const valuesIsObject = isObjectType(value); // Check that we have an object
+
+  if (!valuesIsObject) {
     errorTemplates.throwTypeError(schemaName, key, value, format);
+    return;
   }
 
   if (format === 'object') return;
@@ -68,16 +82,20 @@ const validateObject = (schemaName, key, value, format, validationsMemo, nextVal
     }
 
     if (trueKey in value) {
+      // this is a recursive func, we need to invoke it before it's defined.
+      // eslint-disable-next-line @typescript-eslint/no-use-before-define
       validateValueWithFormat(schemaName, "".concat(key, "[").concat(trueKey, "]"), value[trueKey], objectValue, validationsMemo, nextValidationsMemo);
     }
   });
 };
 
 const validateUnion = (schemaName, key, value, format, validationsMemo, nextValidationsMemo) => {
-  const possibilities = format.split(' | ');
+  const possibilities = format.split(/\s?\|\s?/);
   const errors = [];
   possibilities.forEach(possibility => {
     try {
+      // this is a recursive func, we need to invoke it before it's defined.
+      // eslint-disable-next-line @typescript-eslint/no-use-before-define
       validateValueWithFormat(schemaName, key, value, possibility, validationsMemo, nextValidationsMemo);
     } catch (e) {
       errors.push(e);
@@ -96,8 +114,14 @@ const validateFunction = (schemaName, key, value, format) => {
   }
 };
 
+function isJSXElement(value) {
+  return value === null || typeof value === 'object' && value !== null && '$$typeof' in value;
+}
+
 const validateJSXorNode = (schemaName, key, value, format) => {
-  if (format === 'JSX.Element' && (typeof value !== 'object' || !('$$typeof' in value))) {
+  const valueIsJSX = isJSXElement(value);
+
+  if (format === 'JSX.Element' && !valueIsJSX) {
     errorTemplates.throwTypeError(schemaName, key, value, format);
   }
 }; // =============================================================================
@@ -115,6 +139,8 @@ const validateValueWithFormat = (schemaName, key, value, format, validationsMemo
 
   if (typescriptGuards.isUndefined(format)) {
     validateUndefined(schemaName, key, value, format);
+  } else if (typescriptGuards.isNull(format)) {
+    validateNull(schemaName, key, value, format);
   } else if (typescriptGuards.isPrimitiveType(format)) {
     validatePrimitiveType(schemaName, key, value, format);
   } else if (typescriptGuards.isUnion(format)) {

package/esm/defaultProps/useMemoMergePropsWithDefault.js

@@ -7,9 +7,9 @@ import _defineProperty from '@babel/runtime/helpers/esm/defineProperty';
 import { useRef } from 'react';
 import deepequal from 'fast-deep-equal/react';
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 
 const useMemoCompare = (next, compare) => {

package/esm/validation/typescriptGuards.js

@@ -4,6 +4,7 @@ import 'core-js/modules/esnext.iterator.for-each.js';
 
 const isPrimitiveType = format => ['string', 'number', 'boolean'].includes(format);
 const isUndefined = format => format === '"undefined"';
+const isNull = format => format === '"null"';
 const isUnion = format => {
   let depth = 0;
   let satisfies = false;
@@ -19,4 +20,4 @@ const isFunction = format => !isUnion(format) && format === '((...args: any[]) =
 const isJSXorNode = format => !isUnion(format) && ['React.ReactNode', 'JSX.Element'].includes(format);
 const isSomethingWithParenthesis = format => !isUnion(format) && format[0] === '(' && format.slice(-1) === ')';
 
-export { isArray, isFunction, isJSXorNode, isObject, isPrimitiveType, isSomethingWithParenthesis, isString, isUndefined, isUnion };
+export { isArray, isFunction, isJSXorNode, isNull, isObject, isPrimitiveType, isSomethingWithParenthesis, isString, isUndefined, isUnion };

package/esm/validation/typescriptValidator.js

@@ -5,7 +5,7 @@ import 'core-js/modules/web.dom-collections.iterator.js';
 import { describe } from 'react-desc';
 import { useState, useMemo } from 'react';
 import { throwRequiredError, throwTypeError } from './errorTemplates.js';
-import { isUndefined, isPrimitiveType, isUnion, isString, isArray, isObject, isFunction, isJSXorNode, isSomethingWithParenthesis } from './typescriptGuards.js';
+import { isUndefined, isNull, isPrimitiveType, isUnion, isString, isArray, isObject, isFunction, isJSXorNode, isSomethingWithParenthesis } from './typescriptGuards.js';
 import { typescriptObjectParser } from './typescriptParsers.js';
 
 // =============================================================================
@@ -15,7 +15,13 @@ import { typescriptObjectParser } from './typescriptParsers.js';
 // and optionally recursively apply `validateValueWithFormat`
 // in smaller parts
 const validateUndefined = (schemaName, key, value, format) => {
-  if (value !== undefined) {
+  if (value !== undefined || value === 'undefined') {
+    throwTypeError(schemaName, key, value, format);
+  }
+};
+
+const validateNull = (schemaName, key, value, format) => {
+  if (value !== null || value === 'null') {
     throwTypeError(schemaName, key, value, format);
   }
 };
@@ -40,14 +46,22 @@ const validateArray = (schemaName, key, value, format, validationsMemo, nextVali
 
 
   value.forEach((val, index) => {
+    // this is a recursive func, we need to invoke it before it's defined.
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
     validateValueWithFormat(schemaName, "".concat(key, "[").concat(index, "]"), val, format.slice(0, -2), validationsMemo, nextValidationsMemo);
   });
 };
 
+function isObjectType(value) {
+  return !(typeof value !== 'object' || Array.isArray(value));
+}
+
 const validateObject = (schemaName, key, value, format, validationsMemo, nextValidationsMemo) => {
-  // Check that we have an object
-  if (typeof value !== 'object' || Array.isArray(value)) {
+  const valuesIsObject = isObjectType(value); // Check that we have an object
+
+  if (!valuesIsObject) {
     throwTypeError(schemaName, key, value, format);
+    return;
   }
 
   if (format === 'object') return;
@@ -64,16 +78,20 @@ const validateObject = (schemaName, key, value, format, validationsMemo, nextVal
     }
 
     if (trueKey in value) {
+      // this is a recursive func, we need to invoke it before it's defined.
+      // eslint-disable-next-line @typescript-eslint/no-use-before-define
       validateValueWithFormat(schemaName, "".concat(key, "[").concat(trueKey, "]"), value[trueKey], objectValue, validationsMemo, nextValidationsMemo);
     }
   });
 };
 
 const validateUnion = (schemaName, key, value, format, validationsMemo, nextValidationsMemo) => {
-  const possibilities = format.split(' | ');
+  const possibilities = format.split(/\s?\|\s?/);
   const errors = [];
   possibilities.forEach(possibility => {
     try {
+      // this is a recursive func, we need to invoke it before it's defined.
+      // eslint-disable-next-line @typescript-eslint/no-use-before-define
       validateValueWithFormat(schemaName, key, value, possibility, validationsMemo, nextValidationsMemo);
     } catch (e) {
       errors.push(e);
@@ -92,8 +110,14 @@ const validateFunction = (schemaName, key, value, format) => {
   }
 };
 
+function isJSXElement(value) {
+  return value === null || typeof value === 'object' && value !== null && '$$typeof' in value;
+}
+
 const validateJSXorNode = (schemaName, key, value, format) => {
-  if (format === 'JSX.Element' && (typeof value !== 'object' || !('$$typeof' in value))) {
+  const valueIsJSX = isJSXElement(value);
+
+  if (format === 'JSX.Element' && !valueIsJSX) {
     throwTypeError(schemaName, key, value, format);
   }
 }; // =============================================================================
@@ -111,6 +135,8 @@ const validateValueWithFormat = (schemaName, key, value, format, validationsMemo
 
   if (isUndefined(format)) {
     validateUndefined(schemaName, key, value, format);
+  } else if (isNull(format)) {
+    validateNull(schemaName, key, value, format);
   } else if (isPrimitiveType(format)) {
     validatePrimitiveType(schemaName, key, value, format);
   } else if (isUnion(format)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-props-helpers",
-  "version": "2.0.1",
+  "version": "2.1.0-rc.0",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Props Helpers",
   "module": "./esm/index.js",

package/types/validation/typescriptGuards.d.ts

@@ -1,11 +1,12 @@
-declare type guardFn = (format: string) => boolean;
-export declare const isPrimitiveType: guardFn;
-export declare const isUndefined: guardFn;
-export declare const isUnion: guardFn;
-export declare const isString: guardFn;
-export declare const isArray: guardFn;
-export declare const isObject: guardFn;
-export declare const isFunction: guardFn;
-export declare const isJSXorNode: guardFn;
-export declare const isSomethingWithParenthesis: guardFn;
+declare type GuardFn = (format: string) => boolean;
+export declare const isPrimitiveType: GuardFn;
+export declare const isUndefined: GuardFn;
+export declare const isNull: GuardFn;
+export declare const isUnion: GuardFn;
+export declare const isString: GuardFn;
+export declare const isArray: GuardFn;
+export declare const isObject: GuardFn;
+export declare const isFunction: GuardFn;
+export declare const isJSXorNode: GuardFn;
+export declare const isSomethingWithParenthesis: GuardFn;
 export {};

package/types/validation/typescriptValidator.d.ts

@@ -1,4 +1,4 @@
-import React, { PropsWithChildren } from 'react';
+import { PropsWithChildren } from 'react';
 interface TypescriptSchema {
     description: string;
     name: string;
@@ -11,5 +11,5 @@ interface TypescriptSchema {
     }[];
 }
 export declare const validateTypescriptPropTypesImplementation: (props: PropsWithChildren<Record<string, unknown>>, schema: TypescriptSchema, validationsMemo?: Record<string, string>, nextValidationsMemo?: Record<string, string>) => void;
-export declare const useValidateTypescriptPropTypes: <T = Record<string, any>>(props: React.PropsWithChildren<T>, propTypes: any) => void;
+export declare const useValidateTypescriptPropTypes: <T = Record<string, any>>(props: PropsWithChildren<T>, propTypes: any) => void;
 export {};