@elliemae/ds-props-helpers 2.2.0 → 2.2.2

package/cjs/propTypes/describe.js

@@ -0,0 +1,64 @@
+'use strict';
+
+require('core-js/modules/esnext.async-iterator.for-each.js');
+require('core-js/modules/esnext.iterator.constructor.js');
+require('core-js/modules/esnext.iterator.for-each.js');
+var describeConversions = require('./describeConversions.js');
+var toTypescript = require('./toTypescript.js');
+
+function describe(ComponentInstance) {
+  if (!ComponentInstance) {
+    throw new Error('react-desc: component is required');
+  }
+
+  const documentation = {
+    propTypes: {}
+  };
+  const DocumentedComponent = ComponentInstance;
+
+  const addDocumentationProp = propName => {
+    const func = value => {
+      documentation[propName] = value;
+      return DocumentedComponent;
+    };
+
+    return func;
+  };
+
+  DocumentedComponent.availableAt = addDocumentationProp('availableAt');
+  DocumentedComponent.description = addDocumentationProp('description');
+  DocumentedComponent.details = addDocumentationProp('details');
+  DocumentedComponent.deprecated = addDocumentationProp('deprecated');
+  DocumentedComponent.usage = addDocumentationProp('usage');
+  DocumentedComponent.intrinsicElement = addDocumentationProp('intrinsicElement');
+
+  DocumentedComponent.toTypescript = () => toTypescript(ComponentInstance, documentation);
+
+  Object.defineProperty(DocumentedComponent, 'propTypes', {
+    get: () => DocumentedComponent.propTypesValue,
+    set: value => {
+      if (!DocumentedComponent.propTypesValue) {
+        DocumentedComponent.propTypesValue = {};
+      }
+
+      Object.keys(value).forEach(name => {
+        const propType = value[name];
+        let realPropType;
+        documentation.propTypes[name] = propType;
+        realPropType = describeConversions.convertPropType(propType);
+
+        if (value[name].reactDesc.required) {
+          realPropType = realPropType.isRequired;
+        }
+
+        DocumentedComponent.propTypesValue[name] = realPropType;
+        return propType;
+      });
+    },
+    enumerable: true,
+    configurable: true
+  });
+  return DocumentedComponent;
+}
+
+module.exports = describe;

package/cjs/propTypes/describeConversions.js

@@ -0,0 +1,104 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+require('core-js/modules/web.dom-collections.iterator.js');
+require('core-js/modules/esnext.async-iterator.map.js');
+require('core-js/modules/esnext.iterator.map.js');
+require('core-js/modules/esnext.async-iterator.for-each.js');
+require('core-js/modules/esnext.iterator.constructor.js');
+require('core-js/modules/esnext.iterator.for-each.js');
+var PropTypes = require('prop-types');
+var customPropTypes = require('./customPropTypes.js');
+var describeGuards = require('./describeGuards.js');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var PropTypes__default = /*#__PURE__*/_interopDefaultLegacy(PropTypes);
+
+const enrichPropType = (propType, reactDesc) => {
+  const func = function (props, propName, componentName) {
+    if (reactDesc && reactDesc.deprecated && propName in props && !reactDesc.warned) {
+      const {
+        version = '',
+        message = ''
+      } = reactDesc.deprecated;
+      const warning = "\"".concat(propName, "\" property of \"").concat(componentName, "\" will be deprecated on VERSION: ").concat(version, ".\n").concat(message);
+      console.warn(warning);
+      reactDesc.warned = true;
+    }
+
+    for (var _len = arguments.length, rest = new Array(_len > 3 ? _len - 3 : 0), _key = 3; _key < _len; _key++) {
+      rest[_key - 3] = arguments[_key];
+    }
+
+    return propType(props, propName, componentName, ...rest);
+  };
+
+  Object.defineProperty(func, 'isRequired', Object.getOwnPropertyDescriptor(propType, 'isRequired'));
+  return func;
+};
+
+const convertArray = array => array.map(type => convertPropType(type));
+
+const convertShape = _shape => {
+  const result = {};
+  Object.keys(_shape).forEach(key => {
+    result[key] = convertPropType(_shape[key]);
+  });
+  return result;
+};
+
+const convertPropType = propType => {
+  if (!propType || !propType.type) {
+    throw new Error("react-desc: unknown error -- proptype is not well defined");
+  } // DimSum PropTypes conversion
+
+
+  if (propType.type === 'tuple') {
+    return enrichPropType(PropTypes__default["default"].arrayOf(customPropTypes.tupleValidator(convertArray(propType.args))), propType.reactDesc);
+  } // Default PropType conversion
+
+
+  const realPropType = PropTypes__default["default"][propType.type];
+
+  if (!realPropType) {
+    throw new Error("react-desc: unknown type ".concat(propType.type));
+  }
+
+  if (describeGuards.hasArguments(propType)) {
+    if (describeGuards.isOneOfType(propType)) {
+      return enrichPropType(realPropType(convertArray(propType.args)), propType.reactDesc);
+    }
+
+    if (describeGuards.isArrayOf(propType)) {
+      return enrichPropType(realPropType(convertPropType(propType.args)), propType.reactDesc);
+    }
+
+    if (describeGuards.isShape(propType)) {
+      return enrichPropType(realPropType(convertShape(propType.args)), propType.reactDesc);
+    }
+
+    if (describeGuards.isInstanceOf(propType)) {
+      return enrichPropType(realPropType(propType.args), propType.reactDesc);
+    }
+
+    if (describeGuards.isOneOf(propType)) {
+      return enrichPropType(realPropType(propType.args), propType.reactDesc);
+    }
+
+    if (describeGuards.isObjectOf(propType)) {
+      return enrichPropType(realPropType(propType.args), propType.reactDesc);
+    }
+
+    if (describeGuards.isExact(propType)) {
+      return enrichPropType(realPropType(propType.args), propType.reactDesc);
+    }
+
+    throw new Error("react-desc: unknown error -- proptype with args is not matching");
+  }
+
+  return enrichPropType(realPropType, propType.reactDesc);
+};
+
+exports.convertPropType = convertPropType;

package/cjs/propTypes/describeGuards.js

@@ -0,0 +1,21 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const hasArguments = (propType, realPropType) => !!propType.args;
+const isOneOfType = (propType, realPropType) => propType.type === 'oneOfType';
+const isArrayOf = (propType, realPropType) => propType.type === 'arrayOf';
+const isShape = (propType, realPropType) => propType.type === 'shape';
+const isInstanceOf = (propType, realPropType) => propType.type === 'instanceOf';
+const isOneOf = (propType, realPropType) => propType.type === 'oneOf';
+const isObjectOf = (propType, realPropType) => propType.type === 'objectOf';
+const isExact = (propType, realPropType) => propType.type === 'exact';
+
+exports.hasArguments = hasArguments;
+exports.isArrayOf = isArrayOf;
+exports.isExact = isExact;
+exports.isInstanceOf = isInstanceOf;
+exports.isObjectOf = isObjectOf;
+exports.isOneOf = isOneOf;
+exports.isOneOfType = isOneOfType;
+exports.isShape = isShape;

package/cjs/propTypes/index.js

@@ -0,0 +1,11 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var PropTypes = require('./PropTypes.js');
+var describe = require('./describe.js');
+
+
+
+exports.PropTypes = PropTypes;
+exports.describe = describe;

package/cjs/propTypes/toTypescript.js

@@ -0,0 +1,160 @@
+'use strict';
+
+var _defineProperty = require('@babel/runtime/helpers/defineProperty');
+require('core-js/modules/esnext.async-iterator.map.js');
+require('core-js/modules/esnext.iterator.map.js');
+require('core-js/modules/esnext.async-iterator.for-each.js');
+require('core-js/modules/esnext.iterator.constructor.js');
+require('core-js/modules/esnext.iterator.for-each.js');
+require('core-js/modules/esnext.async-iterator.filter.js');
+require('core-js/modules/esnext.iterator.filter.js');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var _defineProperty__default = /*#__PURE__*/_interopDefaultLegacy(_defineProperty);
+
+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 = 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 @typescript-eslint/restrict-template-expressions */
+
+/* eslint-disable @typescript-eslint/no-use-before-define */
+
+/* eslint-disable complexity */
+
+/* eslint-disable react/forbid-foreign-prop-types */
+const arrayFormat = array => array.map(propType => propTypeFormat(propType));
+
+const shapeFormat = shape => {
+  const props = Object.keys(shape).map(key => {
+    const value = shape[key];
+    let valueFormat;
+
+    if (value.type && (value.type === 'arrayOf' || value.type === 'oneOfType' || value.type === 'oneOf') && Array.isArray(value.args)) {
+      valueFormat = "".concat(propTypeFormat(value));
+    } else if (value.type === 'shape') {
+      valueFormat = "".concat(propTypeFormat(value));
+    } else {
+      valueFormat = propTypeFormat(value);
+    }
+
+    return "".concat(key).concat(value.reactDesc && value.reactDesc.required ? '' : '?', ": ").concat(valueFormat);
+  });
+  return "{".concat(props.join(','), "}");
+};
+
+const propTypeFormat = function (propType) {
+  let joinWith = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
+  let result;
+
+  if (Array.isArray(propType)) {
+    result = arrayFormat(propType).join(joinWith);
+  } else if (typeof propType !== 'function' && propType.type) {
+    switch (propType.type) {
+      case 'array':
+        result = 'any[]';
+        break;
+
+      case 'arrayOf':
+        if (propType.args.type === 'oneOfType') {
+          result = "(".concat(propTypeFormat(propType.args, ' | '), ")[]");
+        } else {
+          result = "".concat(propTypeFormat(propType.args, '\n'), "[]");
+        }
+
+        break;
+
+      case 'tuple':
+        result = "[".concat(propTypeFormat(propType.args, ', '), "]");
+        break;
+
+      case 'bool':
+        result = 'boolean';
+        break;
+
+      case 'func':
+        result = '((...args: any[]) => any)';
+        break;
+
+      case 'node':
+        result = 'React.ReactNode';
+        break;
+
+      case 'element':
+        result = 'JSX.Element';
+        break;
+
+      case 'instanceOf':
+        result = 'any';
+        break;
+
+      case 'symbol':
+        result = 'any';
+        break;
+
+      case 'objectOf':
+        result = "{ [key: string]: ".concat(propTypeFormat(propType.args), " }");
+        break;
+
+      case 'oneOf':
+        result = propType.args.map(a => "\"".concat(a, "\"")).join(' | ');
+        break;
+
+      case 'oneOfType':
+        result = "".concat(propTypeFormat(propType.args, ' | '));
+        break;
+
+      case 'shape':
+        result = "".concat(shapeFormat(propType.args));
+        break;
+
+      default:
+        result = "".concat(propType.type);
+        break;
+    }
+  } else {
+    result = 'any';
+  }
+
+  return result;
+};
+
+const propTypeAsTypescript = (propType, propName) => {
+  const documentation = _objectSpread(_objectSpread({}, propType.reactDesc), {}, {
+    name: propName
+  });
+
+  documentation.format = propTypeFormat(propType);
+  return documentation;
+};
+
+function descToTypescript(component, reactDesc) {
+  if (!component) {
+    throw new Error('react-desc: component is required');
+  }
+
+  const documentation = _objectSpread({
+    name: component.displayName || component.name
+  }, reactDesc);
+
+  if (reactDesc) {
+    delete documentation.propTypes;
+
+    if (reactDesc.propTypes) {
+      const propTypes = [];
+      Object.keys(reactDesc.propTypes).forEach(propName => {
+        const propType = reactDesc.propTypes[propName];
+        propTypes.push(propTypeAsTypescript(propType, propName));
+      });
+
+      if (propTypes.length > 0) {
+        documentation.properties = propTypes;
+      }
+    }
+  }
+
+  return documentation;
+}
+
+module.exports = descToTypescript;

package/cjs/propTypes/types.js

@@ -0,0 +1,2 @@
+'use strict';
+

package/cjs/validation/typescriptValidator.js

@@ -6,8 +6,9 @@ require('core-js/modules/esnext.async-iterator.for-each.js');
 require('core-js/modules/esnext.iterator.constructor.js');
 require('core-js/modules/esnext.iterator.for-each.js');
 require('core-js/modules/web.dom-collections.iterator.js');
-var reactDesc = require('react-desc');
 var react = require('react');
+require('../propTypes/PropTypes.js');
+var describe = require('../propTypes/describe.js');
 var errorTemplates = require('./errorTemplates.js');
 var typescriptGuards = require('./typescriptGuards.js');
 var typescriptParsers = require('./typescriptParsers.js');
@@ -191,7 +192,7 @@ const useValidateTypescriptPropTypes = (props, propTypes) => {
     const Component = () => {}; // eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call
 
 
-    return reactDesc.describe(Component);
+    return describe(Component);
   }, []); // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access,  @typescript-eslint/no-unsafe-assignment
 
   ComponentWithSchema.propTypes = propTypes;

package/esm/globalProps/constants.js

@@ -0,0 +1,11 @@
+import 'core-js/modules/esnext.async-iterator.map.js';
+import 'core-js/modules/esnext.iterator.map.js';
+import 'core-js/modules/web.dom-collections.iterator.js';
+
+/* eslint-disable max-lines */
+const ariaAttributes = ['aria-activedescendant', 'aria-atomic', 'aria-autocomplete', 'aria-busy', 'aria-checked', 'aria-colcount', 'aria-colindex', 'aria-colspan', 'aria-controls', 'aria-current', 'aria-describedby', 'aria-details', 'aria-disabled', 'aria-dropeffect', 'aria-errormessage', 'aria-expanded', 'aria-flowto', 'aria-grabbed', 'aria-haspopup', 'aria-hidden', 'aria-invalid', 'aria-keyshortcuts', 'aria-label', 'aria-labelledby', 'aria-level', 'aria-live', 'aria-modal', 'aria-multiline', 'aria-multiselectable', 'aria-orientation', 'aria-owns', 'aria-placeholder', 'aria-posinset', 'aria-pressed', 'aria-readonly', 'aria-relevant', 'aria-required', 'aria-roledescription', 'aria-rowcount', 'aria-rowindex', 'aria-rowspan', 'aria-selected', 'aria-setsize', 'aria-sort', 'aria-valuemax', 'aria-valuemin', 'aria-valuenow', 'aria-valuetext'];
+const domAttributes = ['onCopy', 'onCopyCapture', 'onCut', 'onCutCapture', 'onPaste', 'onPasteCapture', 'onCompositionEnd', 'onCompositionEndCapture', 'onCompositionStart', 'onCompositionStartCapture', 'onCompositionUpdate', 'onCompositionUpdateCapture', 'onFocus', 'onFocusCapture', 'onBlur', 'onBlurCapture', 'onChange', 'onChangeCapture', 'onBeforeInput', 'onBeforeInputCapture', 'onInput', 'onInputCapture', 'onReset', 'onResetCapture', 'onSubmit', 'onSubmitCapture', 'onInvalid', 'onInvalidCapture', 'onLoad', 'onLoadCapture', 'onError', 'onErrorCapture', 'onKeyDown', 'onKeyDownCapture', 'onKeyPress', 'onKeyPressCapture', 'onKeyUp', 'onKeyUpCapture', 'onAbort', 'onAbortCapture', 'onCanPlay', 'onCanPlayCapture', 'onCanPlayThrough', 'onCanPlayThroughCapture', 'onDurationChange', 'onDurationChangeCapture', 'onEmptied', 'onEmptiedCapture', 'onEncrypted', 'onEncryptedCapture', 'onEnded', 'onEndedCapture', 'onLoadedData', 'onLoadedDataCapture', 'onLoadedMetadata', 'onLoadedMetadataCapture', 'onLoadStart', 'onLoadStartCapture', 'onPause', 'onPauseCapture', 'onPlay', 'onPlayCapture', 'onPlaying', 'onPlayingCapture', 'onProgress', 'onProgressCapture', 'onRateChange', 'onRateChangeCapture', 'onSeeked', 'onSeekedCapture', 'onSeeking', 'onSeekingCapture', 'onStalled', 'onStalledCapture', 'onSuspend', 'onSuspendCapture', 'onTimeUpdate', 'onTimeUpdateCapture', 'onVolumeChange', 'onVolumeChangeCapture', 'onWaiting', 'onWaitingCapture', 'onAuxClick', 'onAuxClickCapture', 'onClick', 'onClickCapture', 'onContextMenu', 'onContextMenuCapture', 'onDoubleClick', 'onDoubleClickCapture', 'onDrag', 'onDragCapture', 'onDragEnd', 'onDragEndCapture', 'onDragEnter', 'onDragEnterCapture', 'onDragExit', 'onDragExitCapture', 'onDragLeave', 'onDragLeaveCapture', 'onDragOver', 'onDragOverCapture', 'onDragStart', 'onDragStartCapture', 'onDrop', 'onDropCapture', 'onMouseDown', 'onMouseDownCapture', 'onMouseEnter', 'onMouseLeave', 'onMouseMove', 'onMouseMoveCapture', 'onMouseOut', 'onMouseOutCapture', 'onMouseOver', 'onMouseOverCapture', 'onMouseUp', 'onMouseUpCapture', 'onSelect', 'onSelectCapture', 'onTouchCancel', 'onTouchCancelCapture', 'onTouchEnd', 'onTouchEndCapture', 'onTouchMove', 'onTouchMoveCapture', 'onTouchStart', 'onTouchStartCapture', 'onPointerDown', 'onPointerDownCapture', 'onPointerMove', 'onPointerMoveCapture', 'onPointerUp', 'onPointerUpCapture', 'onPointerCancel', 'onPointerCancelCapture', 'onPointerEnter', 'onPointerEnterCapture', 'onPointerLeave', 'onPointerLeaveCapture', 'onPointerOver', 'onPointerOverCapture', 'onPointerOut', 'onPointerOutCapture', 'onGotPointerCapture', 'onGotPointerCaptureCapture', 'onLostPointerCapture', 'onLostPointerCaptureCapture', 'onScroll', 'onScrollCapture', 'onWheel', 'onWheelCapture', 'onAnimationStart', 'onAnimationStartCapture', 'onAnimationEnd', 'onAnimationEndCapture', 'onAnimationIteration', 'onAnimationIterationCapture', 'onTransitionEnd', 'onTransitionEndCapture'];
+const htmlAttributes = ['about', 'accept', 'acceptCharset', 'accessKey', 'action', 'allowFullScreen', 'allowTransparency', 'alt', 'as', 'async', 'autoCapitalize', 'autoComplete', 'autoCorrect', 'autoFocus', 'autoPlay', 'autoSave', 'capture', 'cellPadding', 'cellSpacing', 'challenge', 'charSet', 'checked', 'cite', 'classID', 'className', 'color', 'cols', 'colSpan', 'content', 'contentEditable', 'contextMenu', 'controls', 'coords', 'crossOrigin', 'data', 'datatype', 'dateTime', 'default', 'defaultChecked', 'defaultValue', 'defer', 'dir', 'disabled', 'download', 'draggable', 'encType', 'form', 'formAction', 'formEncType', 'formMethod', 'formNoValidate', 'formTarget', 'frameBorder', 'headers', 'height', 'hidden', 'high', 'href', 'hrefLang', 'htmlFor', 'httpEquiv', 'id', 'inlist', 'inputMode', 'integrity', 'is', 'itemID', 'itemProp', 'itemRef', 'itemScope', 'itemType', 'keyParams', 'keyType', 'kind', 'label', 'lang', 'list', 'loop', 'low', 'manifest', 'marginHeight', 'marginWidth', 'max', 'maxLength', 'media', 'mediaGroup', 'method', 'min', 'minLength', 'multiple', 'muted', 'name', 'nonce', 'noValidate', 'open', 'optimum', 'pattern', 'placeholder', 'playsInline', 'poster', 'prefix', 'preload', 'property', 'radioGroup', 'readOnly', 'rel', 'required', 'resource', 'results', 'reversed', 'role', 'rows', 'rowSpan', 'sandbox', 'scope', 'scoped', 'scrolling', 'seamless', 'security', 'selected', 'shape', 'size', 'sizes', 'slot', 'span', 'spellCheck', 'src', 'srcDoc', 'srcLang', 'srcSet', 'start', 'step', 'style', 'summary', 'suppressContentEditableWarning', 'suppressHydrationWarning', 'tabIndex', 'target', 'title', 'translate', 'type', 'typeof', 'unselectable', 'useMap', 'value', 'vocab', 'width', 'wmode', 'wrap'];
+const globalAttributes = Object.fromEntries([...ariaAttributes, ...domAttributes, ...htmlAttributes].map(entry => [entry, true]));
+
+export { globalAttributes };