@elliemae/ds-props-helpers 2.3.1-rc.0 → 2.3.2-next.0

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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-props-helpers",
-  "version": "2.3.1-rc.0",
+  "version": "2.3.2-next.0",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Props Helpers",
   "module": "./esm/index.js",
@@ -51,6 +51,10 @@
       "import": "./esm/validation/errorTemplates.js",
       "require": "./cjs/validation/errorTemplates.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"
@@ -139,11 +143,14 @@
     "build": "node ../../scripts/build/build.js"
   },
   "dependencies": {
+    "@xstyled/styled-components": "~3.1.1",
     "fast-deep-equal": "~3.1.3",
+    "prop-types": "~15.7.2",
     "react-desc": "^4.1.3"
   },
   "devDependencies": {
-    "@testing-library/jest-dom": "~5.15.0"
+    "@testing-library/jest-dom": "~5.15.0",
+    "@testing-library/react": "~12.1.2"
   },
   "peerDependencies": {
     "react": "~17.0.2",

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/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 {};