restructure propTypes api

Author: oliverlaz

src/index.js

@@ -4,4 +4,5 @@
 export { Provider } from './lib/MessageSourceContext';
 export { FetchingProvider } from './lib/FetchingProvider';
 export { useMessageSource } from './lib/useMessageSource';
-export { withMessages, propTypes } from './lib/withMessages';
+export { withMessages } from './lib/withMessages';
+export { propTypes } from './lib/propTypes';

src/lib/propTypes.js

@@ -0,0 +1,12 @@
+import PropTypes from 'prop-types';
+
+/**
+ * Example usage:
+ *
+ * Exported just for convenience, in case you want to run propType checks on your component.
+ * Note: some bundlers might remove these definitions during build time.
+ */
+export const propTypes = {
+  getMessage: PropTypes.func,
+  getMessageWithNamedParams: PropTypes.func,
+};

src/lib/useMessageSource.test.js

@@ -2,6 +2,7 @@ import React from 'react';
 import TestRenderer from 'react-test-renderer';
 import { useMessageSource } from './useMessageSource';
 import { Provider as MessageSourceProvider } from './MessageSourceContext';
+import { propTypes as MessageSourceApi } from './propTypes';
 
 describe('useMessageSource', () => {
   const translations = {
@@ -10,6 +11,23 @@ describe('useMessageSource', () => {
     'greeting.named': 'Hello {name}',
   };
 
+  it('exposes the correct api', () => {
+    function AssertApi() {
+      const hooksApi = useMessageSource();
+      Object.keys(MessageSourceApi).forEach(api => {
+        expect(hooksApi[api]).toBeDefined();
+      });
+
+      return null;
+    }
+
+    TestRenderer.create(
+      <MessageSourceProvider value={translations}>
+        <AssertApi />
+      </MessageSourceProvider>,
+    );
+  });
+
   it('retrieves the correct translated value with named parameters', () => {
     function Nested() {
       const { getMessageWithNamedParams } = useMessageSource();

src/lib/withMessages.js

@@ -1,5 +1,4 @@
 import React from 'react';
-import PropTypes from 'prop-types';
 import invariant from 'invariant';
 import hoistNonReactStatics from 'hoist-non-react-statics';
 import { useMessageSource } from './useMessageSource';
@@ -59,14 +58,3 @@ function internalWithMessages(keyPrefixOrComponent) {
  * 4. compose(MessageSource.withMessages)(Component)
  */
 export const withMessages = internalWithMessages;
-
-/**
- * Example usage:
- *
- * Exported just for convenience, in case you want to run propType checks on your component.
- * Note: some bundlers might remove these definitions during build time.
- */
-export const propTypes = {
-  getMessage: PropTypes.func,
-  getMessageWithNamedParams: PropTypes.func,
-};

src/lib/withMessages.test.js

@@ -1,9 +1,8 @@
 import React from 'react';
 import TestRenderer from 'react-test-renderer';
 import { Provider as MessageSourceProvider } from './MessageSourceContext';
-import * as MessageSource from './messageSource';
-
-/* eslint-disable react/prop-types */
+import * as MessageSource from './withMessages';
+import { propTypes as MessageSourceApi } from './propTypes';
 
 describe('withMessages', () => {
   const translations = {
@@ -20,8 +19,9 @@ describe('withMessages', () => {
     const { root } = renderer;
 
     const captorInstance = root.findByType(PropsCaptor);
-    expect(captorInstance.props.getMessage).toBeDefined();
-    expect(captorInstance.props.getMessageWithNamedParams).toBeDefined();
+    Object.keys(MessageSourceApi).forEach(api => {
+      expect(captorInstance.props[api]).toBeDefined();
+    });
   });
 
   it('retrieves the correct translated value with named parameters', () => {
@@ -108,7 +108,7 @@ describe('withMessages', () => {
 
   it('[curried] retrieves the correct translated value in mixed mode', () => {
     function Nested(props) {
-      const { getMessage } = props;
+      const { getMessage } = props; // eslint-disable-line react/prop-types
       return (
         <React.Fragment>
           {getMessage('world')}
@@ -164,9 +164,4 @@ describe('withMessages', () => {
     expect(levelOneComponent.children[0]).toBe('Hello World');
     expect(levelTwoComponent.children[0]).toBe('Hallo Welt');
   });
-
-  it('propTypes are exported', () => {
-    // eslint-disable-next-line react/forbid-foreign-prop-types
-    expect(MessageSource.propTypes).toBeDefined();
-  });
 });