@elliemae/ds-props-helpers 2.3.2 → 2.4.0-rc.1

package/cjs/index.js

@@ -13,6 +13,7 @@ var errorTemplates = require('./validation/errorTemplates.js');
 var typescriptValidator = require('./validation/typescriptValidator.js');
 var useGetXstyledProps = require('./xstyledProps/useGetXstyledProps.js');
 var xstyledPropTypes = require('./xstyledProps/xstyledPropTypes.js');
+var index$1 = require('./useDeprecateComponent/index.js');
 
 
 
@@ -30,3 +31,4 @@ exports.useValidateTypescriptPropTypes = typescriptValidator.useValidateTypescri
 exports.validateTypescriptPropTypesImplementation = typescriptValidator.validateTypescriptPropTypesImplementation;
 exports.useGetXstyledProps = useGetXstyledProps.useGetXstyledProps;
 exports.xstyledPropTypes = xstyledPropTypes.xstyledPropTypes;
+exports.useDeprecateComponent = index$1.useDeprecateComponent;

package/cjs/propTypes/PropTypes.js

@@ -33,7 +33,7 @@ const documentedPropType = {
   format: addPropTypeDocumentationField('format'),
   global: addPropTypeDocumentationField('global'),
   hidden: addPropTypeDocumentationField('hidden'),
-  xstyled: addPropTypeDocumentationField('hidden')
+  xstyled: addPropTypeDocumentationField('xstyled')
 };
 
 const createPropType = type => {

package/cjs/propTypes/describeConversions.js

@@ -23,8 +23,8 @@ const enrichPropType = (propType, reactDesc) => {
         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);
+      const error = "Warning: \"".concat(propName, "\" property of \"").concat(componentName, "\" will be deprecated in version: ").concat(version, ".\n").concat(message);
+      console.error(error);
       reactDesc.warned = true;
     }
 

package/cjs/useDeprecateComponent/index.js

@@ -0,0 +1,18 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var react = require('react');
+
+/* eslint-disable no-console */
+const useDeprecateComponent = _ref => {
+  let {
+    componentName,
+    version
+  } = _ref;
+  react.useEffect(() => {
+    console.error("Warning: ".concat(componentName, ":: this component will be deprecated in version: ").concat(version, "."));
+  }, [componentName, version]);
+};
+
+exports.useDeprecateComponent = useDeprecateComponent;

package/esm/index.js

@@ -9,3 +9,4 @@ export { throwRequiredError, throwTypeError } from './validation/errorTemplates.
 export { useValidateTypescriptPropTypes, validateTypescriptPropTypesImplementation } from './validation/typescriptValidator.js';
 export { useGetXstyledProps } from './xstyledProps/useGetXstyledProps.js';
 export { xstyledPropTypes } from './xstyledProps/xstyledPropTypes.js';
+export { useDeprecateComponent } from './useDeprecateComponent/index.js';

package/esm/propTypes/PropTypes.js

@@ -27,7 +27,7 @@ const documentedPropType = {
   format: addPropTypeDocumentationField('format'),
   global: addPropTypeDocumentationField('global'),
   hidden: addPropTypeDocumentationField('hidden'),
-  xstyled: addPropTypeDocumentationField('hidden')
+  xstyled: addPropTypeDocumentationField('xstyled')
 };
 
 const createPropType = type => {

package/esm/propTypes/describeConversions.js

@@ -15,8 +15,8 @@ const enrichPropType = (propType, reactDesc) => {
         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);
+      const error = "Warning: \"".concat(propName, "\" property of \"").concat(componentName, "\" will be deprecated in version: ").concat(version, ".\n").concat(message);
+      console.error(error);
       reactDesc.warned = true;
     }
 

package/esm/useDeprecateComponent/index.js

@@ -0,0 +1,14 @@
+import { useEffect } from 'react';
+
+/* eslint-disable no-console */
+const useDeprecateComponent = _ref => {
+  let {
+    componentName,
+    version
+  } = _ref;
+  useEffect(() => {
+    console.error("Warning: ".concat(componentName, ":: this component will be deprecated in version: ").concat(version, "."));
+  }, [componentName, version]);
+};
+
+export { useDeprecateComponent };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-props-helpers",
-  "version": "2.3.2",
+  "version": "2.4.0-rc.1",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Props Helpers",
   "module": "./esm/index.js",
@@ -51,6 +51,14 @@
       "import": "./esm/validation/errorTemplates.js",
       "require": "./cjs/validation/errorTemplates.js"
     },
+    "./useDeprecateComponent": {
+      "import": "./esm/useDeprecateComponent/index.js",
+      "require": "./cjs/useDeprecateComponent/index.js"
+    },
+    "./tests/xstyledProps/TestComponent": {
+      "import": "./esm/tests/xstyledProps/TestComponent.js",
+      "require": "./cjs/tests/xstyledProps/TestComponent.js"
+    },
     "./tests/validation/test.schema": {
       "import": "./esm/tests/validation/test.schema.js",
       "require": "./cjs/tests/validation/test.schema.js"

package/types/index.d.ts

@@ -4,3 +4,4 @@ export * from './globalProps';
 export * from './propTypes';
 export * from './validation';
 export * from './xstyledProps';
+export * from './useDeprecateComponent';

package/types/propTypes/describe.d.ts

@@ -1,3 +1,3 @@
 import React from 'react';
-import { DocumentedReactComponent } from './types';
-export default function describe<C>(ComponentInstance: React.ComponentType<C>): DocumentedReactComponent<C>;
+import { Hook, DocumentedReactComponent } from './types';
+export default function describe<C, R>(ComponentInstance: React.ComponentType<C> | Hook<C, R>): DocumentedReactComponent<C>;

package/types/propTypes/toTypescript.d.ts

@@ -1,3 +1,3 @@
 import React from 'react';
-import { ComponentDocumentation, TypescriptDocumentation } from './types';
-export default function descToTypescript<C>(component: React.ComponentType<C>, reactDesc: ComponentDocumentation): TypescriptDocumentation;
+import { ComponentDocumentation, Hook, TypescriptDocumentation } from './types';
+export default function descToTypescript<C, R>(component: React.ComponentType<C> | Hook<C, R>, reactDesc: ComponentDocumentation): TypescriptDocumentation;

package/types/propTypes/types.d.ts

@@ -75,6 +75,10 @@ export declare type DocumentedReactComponent<T> = React.ComponentType<T> & {
     toTypescript: unknown;
     propTypesValue: ValidationMap<Record<string, unknown>>;
 };
+export declare type Hook<T = unknown, S = unknown> = ((props: T) => S) & {
+    displayName?: string;
+    name?: string;
+};
 export declare type DocumentedPropType = ReactDescT;
 export declare type PropTypesObj = {
     any: DocumentedPropType;

package/types/tests/xstyledProps/TestComponent.d.ts

@@ -0,0 +1 @@
+export function TestComponent(props: any): JSX.Element;

package/types/tests/xstyledProps/xstyledProps.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/useDeprecateComponent/index.d.ts

@@ -0,0 +1,6 @@
+interface Props {
+    componentName: string;
+    version: string;
+}
+export declare const useDeprecateComponent: ({ componentName, version }: Props) => void;
+export {};

package/types/xstyledProps/useGetXstyledProps.d.ts

@@ -1,5 +1,5 @@
 import type { SizingProps, SpaceProps, LayoutProps } from '@xstyled/styled-components';
-declare type XstyledProps = SpaceProps & SizingProps & LayoutProps;
+export declare type XstyledProps = SpaceProps & SizingProps & LayoutProps;
 declare type PropsWithXstyled<T> = T & XstyledProps;
 export declare const useGetXstyledProps: <T>(props: PropsWithXstyled<T>) => XstyledProps;
 export {};