@elliemae/ds-props-helpers 2.2.0-alpha.1 → 2.2.0-alpha.5

package/esm/validation/typescriptValidator.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../../scripts/build/transpile/react-shim.js", "../../../src/validation/typescriptValidator.ts"],
+  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "/* eslint-disable complexity */\n/* eslint-disable max-lines */\n/* eslint-disable max-params */\nimport { describe } from 'react-desc';\nimport React, { PropsWithChildren, useMemo, useState } from 'react';\nimport { throwRequiredError, throwTypeError } from './errorTemplates';\nimport {\n  isArray,\n  isFunction,\n  isJSXorNode,\n  isObject,\n  isPrimitiveType,\n  isSomethingWithParenthesis,\n  isString,\n  isUnion,\n  isUndefined,\n  isNull,\n} from './typescriptGuards';\nimport { typescriptObjectParser } from './typescriptParsers';\n\ninterface TypescriptSchema {\n  description: string;\n  name: string;\n  properties: { name: string; description: string; defaultValue?: unknown; format: string; required?: boolean }[];\n}\n\ntype ValidatorFn = (\n  schemaName: string,\n  key: string,\n  value: unknown,\n  format: string,\n  validationsMemo: Record<symbol, string>,\n  nextValidationsMemo: Record<symbol, string>,\n) => void;\n\n// =============================================================================\n// Atom Validators\n// =============================================================================\n\n// This functions will validate something from the data\n// and optionally recursively apply `validateValueWithFormat`\n// in smaller parts\n\nconst validateUndefined: ValidatorFn = (schemaName, key, value, format) => {\n  if (value !== undefined || value === 'undefined') {\n    throwTypeError(schemaName, key, value, format);\n  }\n};\nconst validateNull: ValidatorFn = (schemaName, key, value, format) => {\n  if (value !== null || value === 'null') {\n    throwTypeError(schemaName, key, value, format);\n  }\n};\nconst validatePrimitiveType: ValidatorFn = (schemaName, key, value, format) => {\n  if (typeof value !== format) {\n    throwTypeError(schemaName, key, value, format);\n  }\n};\n\nconst validateString: ValidatorFn = (schemaName, key, value, format) => {\n  if (value !== format.slice(1, -1)) {\n    throwTypeError(schemaName, key, value, format);\n  }\n};\n\nconst validateArray: ValidatorFn = (schemaName, key, value, format, validationsMemo, nextValidationsMemo) => {\n  // Check that we have an array\n  if (!Array.isArray(value)) {\n    throwTypeError(schemaName, key, value, format);\n  }\n\n  // Check that each element inside satisfies the format\n  (value as unknown[]).forEach((val, index) => {\n    // this is a recursive func, we need to invoke it before it's defined.\n    // eslint-disable-next-line @typescript-eslint/no-use-before-define\n    validateValueWithFormat(\n      schemaName,\n      `${key}[${index}]`,\n      val,\n      format.slice(0, -2),\n      validationsMemo,\n      nextValidationsMemo,\n    );\n  });\n};\nfunction isObjectType(value: unknown | Record<string, unknown>): value is Record<string, unknown> {\n  return !(typeof value !== 'object' || Array.isArray(value));\n}\nconst validateObject: ValidatorFn = (schemaName, key, value, format, validationsMemo, nextValidationsMemo) => {\n  const valuesIsObject = isObjectType(value);\n  // Check that we have an object\n  if (!valuesIsObject) {\n    throwTypeError(schemaName, key, value, format);\n    return;\n  }\n\n  if (format === 'object') return;\n\n  const keyValuePairs = typescriptObjectParser(format);\n  // Now we have the key - value pairs\n  // Each key could either be required or not\n  // Just recursively check the object\n\n  keyValuePairs.forEach(([objectKey, objectValue]) => {\n    const trueKey = objectKey.slice(-1) === '?' ? objectKey.slice(0, -1) : objectKey;\n\n    if (trueKey === objectKey && !(trueKey in value)) {\n      throwRequiredError(schemaName, key);\n    }\n\n    if (trueKey in value) {\n      // this is a recursive func, we need to invoke it before it's defined.\n      // eslint-disable-next-line @typescript-eslint/no-use-before-define\n      validateValueWithFormat(\n        schemaName,\n        `${key}[${trueKey}]`,\n        value[trueKey],\n        objectValue,\n        validationsMemo,\n        nextValidationsMemo,\n      );\n    }\n  });\n};\n\nconst validateUnion: ValidatorFn = (schemaName, key, value, format, validationsMemo, nextValidationsMemo) => {\n  const possibilities = format.split(/\\s?\\|\\s?/);\n\n  const errors = [];\n\n  possibilities.forEach((possibility) => {\n    try {\n      // this is a recursive func, we need to invoke it before it's defined.\n      // eslint-disable-next-line @typescript-eslint/no-use-before-define\n      validateValueWithFormat(schemaName, key, value, possibility, validationsMemo, nextValidationsMemo);\n    } catch (e) {\n      errors.push(e);\n    }\n  });\n\n  if (errors.length === possibilities.length) {\n    throwTypeError(schemaName, key, value, format);\n  }\n};\n\nconst validateFunction: ValidatorFn = (schemaName, key, value, format) => {\n  // Check that we have a function\n  if (typeof value !== 'function') {\n    throwTypeError(schemaName, key, value, format);\n  }\n};\n\nfunction isJSXElement(value: unknown | JSX.Element): value is JSX.Element {\n  return value === null || (typeof value === 'object' && value !== null && '$$typeof' in value);\n}\nconst validateJSXorNode: ValidatorFn = (schemaName, key, value, format) => {\n  const valueIsJSX = isJSXElement(value);\n  if (format === 'JSX.Element' && !valueIsJSX) {\n    throwTypeError(schemaName, key, value, format);\n  }\n};\n\n// =============================================================================\n// Schema validator\n// =============================================================================\n\nconst validateValueWithFormat: ValidatorFn = (schemaName, key, value, format, validationsMemo, nextValidationsMemo) => {\n  nextValidationsMemo[value as symbol] = format;\n\n  if ((value as symbol) in validationsMemo) {\n    // We already validated this value on this format\n    return;\n  }\n\n  if (isUndefined(format)) {\n    validateUndefined(schemaName, key, value, format, validationsMemo, nextValidationsMemo);\n  } else if (isNull(format)) {\n    validateNull(schemaName, key, value, format, validationsMemo, nextValidationsMemo);\n  } else if (isPrimitiveType(format)) {\n    validatePrimitiveType(schemaName, key, value, format, validationsMemo, nextValidationsMemo);\n  } else if (isUnion(format)) {\n    validateUnion(schemaName, key, value, format, validationsMemo, nextValidationsMemo);\n  } else if (isString(format)) {\n    validateString(schemaName, key, value, format, validationsMemo, nextValidationsMemo);\n  } else if (isArray(format)) {\n    validateArray(schemaName, key, value, format, validationsMemo, nextValidationsMemo);\n  } else if (isObject(format)) {\n    validateObject(schemaName, key, value, format, validationsMemo, nextValidationsMemo);\n  } else if (isFunction(format)) {\n    validateFunction(schemaName, key, value, format, validationsMemo, nextValidationsMemo);\n  } else if (isJSXorNode(format)) {\n    validateJSXorNode(schemaName, key, value, format, validationsMemo, nextValidationsMemo);\n  } else if (isSomethingWithParenthesis(format)) {\n    validateValueWithFormat(schemaName, key, value, format.slice(1, -1), validationsMemo, nextValidationsMemo);\n  }\n};\n\nexport const validateTypescriptPropTypesImplementation = (\n  props: PropsWithChildren<Record<string, unknown>>,\n  schema: TypescriptSchema,\n  validationsMemo: Record<string, string> = {},\n  nextValidationsMemo: Record<string, string> = {},\n): void => {\n  const { properties, name: schemaName } = schema;\n\n  properties.forEach((property) => {\n    const { name, format, required } = property;\n\n    if (required && !(name in props)) {\n      throwRequiredError(schema.name, name);\n    }\n\n    if (name in props && (props[name] !== undefined || required)) {\n      validateValueWithFormat(schemaName, name, props[name], format, validationsMemo, nextValidationsMemo);\n    }\n  });\n};\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport const useValidateTypescriptPropTypes = <T = Record<string, any>>(\n  props: PropsWithChildren<T>,\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  propTypes: any,\n): void => {\n  const [validationsMemo, setValidationsMemo] = useState({});\n\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n  const ComponentWithSchema = useMemo(() => {\n    const Component = () => {};\n\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call\n    return describe(Component);\n  }, []);\n\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access,  @typescript-eslint/no-unsafe-assignment\n  ComponentWithSchema.propTypes = propTypes;\n\n  useMemo(() => {\n    const nextValidationsMemo = {};\n\n    validateTypescriptPropTypesImplementation(\n      props,\n      // eslint-disable-next-line  @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call\n      ComponentWithSchema.toTypescript(),\n      validationsMemo,\n      nextValidationsMemo,\n    );\n\n    setValidationsMemo(nextValidationsMemo);\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [props]);\n};\n"],
+  "mappings": "AAAA;ACGA;AACA;AACA;AACA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAYA;AAyBA,MAAM,oBAAiC,CAAC,YAAY,KAAK,OAAO,WAAW;AACzE,MAAI,UAAU,UAAa,UAAU,aAAa;AAChD,mBAAe,YAAY,KAAK,OAAO;AAAA;AAAA;AAG3C,MAAM,eAA4B,CAAC,YAAY,KAAK,OAAO,WAAW;AACpE,MAAI,UAAU,QAAQ,UAAU,QAAQ;AACtC,mBAAe,YAAY,KAAK,OAAO;AAAA;AAAA;AAG3C,MAAM,wBAAqC,CAAC,YAAY,KAAK,OAAO,WAAW;AAC7E,MAAI,OAAO,UAAU,QAAQ;AAC3B,mBAAe,YAAY,KAAK,OAAO;AAAA;AAAA;AAI3C,MAAM,iBAA8B,CAAC,YAAY,KAAK,OAAO,WAAW;AACtE,MAAI,UAAU,OAAO,MAAM,GAAG,KAAK;AACjC,mBAAe,YAAY,KAAK,OAAO;AAAA;AAAA;AAI3C,MAAM,gBAA6B,CAAC,YAAY,KAAK,OAAO,QAAQ,iBAAiB,wBAAwB;AAE3G,MAAI,CAAC,MAAM,QAAQ,QAAQ;AACzB,mBAAe,YAAY,KAAK,OAAO;AAAA;AAIzC,EAAC,MAAoB,QAAQ,CAAC,KAAK,UAAU;AAG3C,4BACE,YACA,GAAG,OAAO,UACV,KACA,OAAO,MAAM,GAAG,KAChB,iBACA;AAAA;AAAA;AAIN,sBAAsB,OAA4E;AAChG,SAAO,CAAE,QAAO,UAAU,YAAY,MAAM,QAAQ;AAAA;AAEtD,MAAM,iBAA8B,CAAC,YAAY,KAAK,OAAO,QAAQ,iBAAiB,wBAAwB;AAC5G,QAAM,iBAAiB,aAAa;AAEpC,MAAI,CAAC,gBAAgB;AACnB,mBAAe,YAAY,KAAK,OAAO;AACvC;AAAA;AAGF,MAAI,WAAW;AAAU;AAEzB,QAAM,gBAAgB,uBAAuB;AAK7C,gBAAc,QAAQ,CAAC,CAAC,WAAW,iBAAiB;AAClD,UAAM,UAAU,UAAU,MAAM,QAAQ,MAAM,UAAU,MAAM,GAAG,MAAM;AAEvE,QAAI,YAAY,aAAa,CAAE,YAAW,QAAQ;AAChD,yBAAmB,YAAY;AAAA;AAGjC,QAAI,WAAW,OAAO;AAGpB,8BACE,YACA,GAAG,OAAO,YACV,MAAM,UACN,aACA,iBACA;AAAA;AAAA;AAAA;AAMR,MAAM,gBAA6B,CAAC,YAAY,KAAK,OAAO,QAAQ,iBAAiB,wBAAwB;AAC3G,QAAM,gBAAgB,OAAO,MAAM;AAEnC,QAAM,SAAS;AAEf,gBAAc,QAAQ,CAAC,gBAAgB;AACrC,QAAI;AAGF,8BAAwB,YAAY,KAAK,OAAO,aAAa,iBAAiB;AAAA,aACvE,GAAP;AACA,aAAO,KAAK;AAAA;AAAA;AAIhB,MAAI,OAAO,WAAW,cAAc,QAAQ;AAC1C,mBAAe,YAAY,KAAK,OAAO;AAAA;AAAA;AAI3C,MAAM,mBAAgC,CAAC,YAAY,KAAK,OAAO,WAAW;AAExE,MAAI,OAAO,UAAU,YAAY;AAC/B,mBAAe,YAAY,KAAK,OAAO;AAAA;AAAA;AAI3C,sBAAsB,OAAoD;AACxE,SAAO,UAAU,QAAS,OAAO,UAAU,YAAY,UAAU,QAAQ,cAAc;AAAA;AAEzF,MAAM,oBAAiC,CAAC,YAAY,KAAK,OAAO,WAAW;AACzE,QAAM,aAAa,aAAa;AAChC,MAAI,WAAW,iBAAiB,CAAC,YAAY;AAC3C,mBAAe,YAAY,KAAK,OAAO;AAAA;AAAA;AAQ3C,MAAM,0BAAuC,CAAC,YAAY,KAAK,OAAO,QAAQ,iBAAiB,wBAAwB;AACrH,sBAAoB,SAAmB;AAEvC,MAAK,SAAoB,iBAAiB;AAExC;AAAA;AAGF,MAAI,YAAY,SAAS;AACvB,sBAAkB,YAAY,KAAK,OAAO,QAAQ,iBAAiB;AAAA,aAC1D,OAAO,SAAS;AACzB,iBAAa,YAAY,KAAK,OAAO,QAAQ,iBAAiB;AAAA,aACrD,gBAAgB,SAAS;AAClC,0BAAsB,YAAY,KAAK,OAAO,QAAQ,iBAAiB;AAAA,aAC9D,QAAQ,SAAS;AAC1B,kBAAc,YAAY,KAAK,OAAO,QAAQ,iBAAiB;AAAA,aACtD,SAAS,SAAS;AAC3B,mBAAe,YAAY,KAAK,OAAO,QAAQ,iBAAiB;AAAA,aACvD,QAAQ,SAAS;AAC1B,kBAAc,YAAY,KAAK,OAAO,QAAQ,iBAAiB;AAAA,aACtD,SAAS,SAAS;AAC3B,mBAAe,YAAY,KAAK,OAAO,QAAQ,iBAAiB;AAAA,aACvD,WAAW,SAAS;AAC7B,qBAAiB,YAAY,KAAK,OAAO,QAAQ,iBAAiB;AAAA,aACzD,YAAY,SAAS;AAC9B,sBAAkB,YAAY,KAAK,OAAO,QAAQ,iBAAiB;AAAA,aAC1D,2BAA2B,SAAS;AAC7C,4BAAwB,YAAY,KAAK,OAAO,OAAO,MAAM,GAAG,KAAK,iBAAiB;AAAA;AAAA;AAInF,MAAM,4CAA4C,CACvD,OACA,QACA,kBAA0C,IAC1C,sBAA8C,OACrC;AACT,QAAM,EAAE,YAAY,MAAM,eAAe;AAEzC,aAAW,QAAQ,CAAC,aAAa;AAC/B,UAAM,EAAE,MAAM,QAAQ,aAAa;AAEnC,QAAI,YAAY,CAAE,SAAQ,QAAQ;AAChC,yBAAmB,OAAO,MAAM;AAAA;AAGlC,QAAI,QAAQ,SAAU,OAAM,UAAU,UAAa,WAAW;AAC5D,8BAAwB,YAAY,MAAM,MAAM,OAAO,QAAQ,iBAAiB;AAAA;AAAA;AAAA;AAM/E,MAAM,iCAAiC,CAC5C,OAEA,cACS;AACT,QAAM,CAAC,iBAAiB,sBAAsB,SAAS;AAGvD,QAAM,sBAAsB,QAAQ,MAAM;AACxC,UAAM,YAAY,MAAM;AAAA;AAGxB,WAAO,SAAS;AAAA,KACf;AAGH,sBAAoB,YAAY;AAEhC,UAAQ,MAAM;AACZ,UAAM,sBAAsB;AAE5B,8CACE,OAEA,oBAAoB,gBACpB,iBACA;AAGF,uBAAmB;AAAA,KAElB,CAAC;AAAA;",
+  "names": []
+}

package/esm/validation/validator.js

@@ -1,32 +1,26 @@
-import 'core-js/modules/esnext.async-iterator.for-each.js';
-import 'core-js/modules/esnext.iterator.constructor.js';
-import 'core-js/modules/esnext.iterator.for-each.js';
-import { throwRequiredError, throwTypeError } from './errorTemplates.js';
-
+import * as React from "react";
+import { throwRequiredError, throwTypeError } from "./errorTemplates";
 const useValidatePropTypes = (props, schema) => {
-  schema.properties.forEach(property => {
+  schema.properties.forEach((property) => {
     const propertyName = property.name;
     const currentProp = props[propertyName];
-    const currentPropTypeOf = typeof currentProp; // eslint-disable-next-line max-len
-
-    const currentFormat = property.format; // this is csv representing types e.g.: "string"/"string,number"/"[object],string"
-
-    let isValidReactElement = false; // this depends on react desc definition
-
+    const currentPropTypeOf = typeof currentProp;
+    const currentFormat = property.format;
+    let isValidReactElement = false;
     if (property.required && !Object.prototype.hasOwnProperty.call(props, property.name)) {
       throwRequiredError(schema.name, property.name);
     }
-
-    if (currentPropTypeOf !== 'undefined' && currentProp !== null) {
-      if (currentPropTypeOf === 'object' && Object.prototype.hasOwnProperty.call(currentProp, '$$typeof') && (currentFormat.includes('node') || currentFormat.includes('element'))) {
+    if (currentPropTypeOf !== "undefined" && currentProp !== null) {
+      if (currentPropTypeOf === "object" && Object.prototype.hasOwnProperty.call(currentProp, "$$typeof") && (currentFormat.includes("node") || currentFormat.includes("element"))) {
         isValidReactElement = true;
       }
-
       if (!currentFormat.includes(currentPropTypeOf) && !currentFormat.includes(currentProp) && !isValidReactElement) {
         throwTypeError(schema.name, propertyName, currentProp, currentFormat);
       }
     }
   });
 };
-
-export { useValidatePropTypes };
+export {
+  useValidatePropTypes
+};
+//# sourceMappingURL=validator.js.map

package/esm/validation/validator.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../../scripts/build/transpile/react-shim.js", "../../../src/validation/validator.ts"],
+  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "/* eslint-disable complexity */\n/* eslint-disable @typescript-eslint/explicit-module-boundary-types */\nimport { throwRequiredError, throwTypeError } from './errorTemplates';\n\nexport const useValidatePropTypes = (props: Record<string, unknown>, schema): void => {\n  schema.properties.forEach((property) => {\n    const propertyName = property.name;\n    const currentProp = props[propertyName];\n    const currentPropTypeOf = typeof currentProp;\n    // eslint-disable-next-line max-len\n    const currentFormat = property.format; // this is csv representing types e.g.: \"string\"/\"string,number\"/\"[object],string\"\n    let isValidReactElement = false;\n    // this depends on react desc definition\n    if (property.required && !Object.prototype.hasOwnProperty.call(props, property.name)) {\n      throwRequiredError(schema.name, property.name);\n    }\n    if (currentPropTypeOf !== 'undefined' && currentProp !== null) {\n      if (\n        currentPropTypeOf === 'object' &&\n        Object.prototype.hasOwnProperty.call(currentProp, '$$typeof') &&\n        (currentFormat.includes('node') || currentFormat.includes('element'))\n      ) {\n        isValidReactElement = true;\n      }\n\n      if (!currentFormat.includes(currentPropTypeOf) && !currentFormat.includes(currentProp) && !isValidReactElement) {\n        throwTypeError(schema.name, propertyName, currentProp, currentFormat);\n      }\n    }\n  });\n};\n"],
+  "mappings": "AAAA;ACEA;AAEO,MAAM,uBAAuB,CAAC,OAAgC,WAAiB;AACpF,SAAO,WAAW,QAAQ,CAAC,aAAa;AACtC,UAAM,eAAe,SAAS;AAC9B,UAAM,cAAc,MAAM;AAC1B,UAAM,oBAAoB,OAAO;AAEjC,UAAM,gBAAgB,SAAS;AAC/B,QAAI,sBAAsB;AAE1B,QAAI,SAAS,YAAY,CAAC,OAAO,UAAU,eAAe,KAAK,OAAO,SAAS,OAAO;AACpF,yBAAmB,OAAO,MAAM,SAAS;AAAA;AAE3C,QAAI,sBAAsB,eAAe,gBAAgB,MAAM;AAC7D,UACE,sBAAsB,YACtB,OAAO,UAAU,eAAe,KAAK,aAAa,eACjD,eAAc,SAAS,WAAW,cAAc,SAAS,aAC1D;AACA,8BAAsB;AAAA;AAGxB,UAAI,CAAC,cAAc,SAAS,sBAAsB,CAAC,cAAc,SAAS,gBAAgB,CAAC,qBAAqB;AAC9G,uBAAe,OAAO,MAAM,cAAc,aAAa;AAAA;AAAA;AAAA;AAAA;",
+  "names": []
+}

package/package.json

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

package/types/validation/typescriptValidator.d.ts

@@ -1,4 +1,4 @@
-import { PropsWithChildren } from 'react';
+import React, { 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: PropsWithChildren<T>, propTypes: any) => void;
+export declare const useValidateTypescriptPropTypes: <T = Record<string, any>>(props: React.PropsWithChildren<T>, propTypes: any) => void;
 export {};