@pingux/astro 1.14.0-alpha.0 → 1.14.0-alpha.3

package/lib/cjs/hooks/useAriaLabelWarning/useAriaLabelWarning.js

@@ -1,5 +1,7 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+
 var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
 
 _Object$defineProperty(exports, "__esModule", {
@@ -8,22 +10,19 @@ _Object$defineProperty(exports, "__esModule", {
 
 exports["default"] = void 0;
 
-var _react = require("react");
+var _useDevelopmentWarning = _interopRequireDefault(require("../useDevelopmentWarning"));
 
 /**
  * Provides a development-only console warning when a component
  * that needs an aria-label is mounted without one.
- *
- * e.g. "\`Component\` requires an aria-label."
 */
 var useAriaLabelWarning = function useAriaLabelWarning(component, ariaLabel) {
-  var condition = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
-  (0, _react.useEffect)(function () {
-    if (process.env.NODE_ENV === 'development' && condition && !ariaLabel) {
-      // eslint-disable-next-line no-console
-      console.warn("".concat(component, " requires an aria-label"), '\n', '\n', 'NOTE: This is a development-only warning and will not display in production.');
-    }
-  }, []);
+  var shouldTrigger = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
+  var message = "".concat(component, " has an undefined aria-label. If the surrounding content sufficiently labels this component instance, you may disable this warning by setting the prop to `null`. Otherwise, please provide an appropriate aria-label. See more info here: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label");
+  (0, _useDevelopmentWarning["default"])({
+    message: message,
+    shouldTrigger: shouldTrigger && ariaLabel === undefined
+  });
 };
 
 var _default = useAriaLabelWarning;

package/lib/cjs/hooks/useAriaLabelWarning/useAriaLabelWarning.test.js

@@ -28,7 +28,7 @@ test('default useAriaLabelWarning', function () {
   expect(spy).toHaveBeenCalledTimes(1);
 });
 test('useAriaLabelWarning with string', function () {
-  var compound = "".concat(component, " requires an aria-label");
+  var compound = "".concat(component, " has an undefined aria-label. If the surrounding content sufficiently labels this component instance, you may disable this warning by setting the prop to `null`. Otherwise, please provide an appropriate aria-label. See more info here: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label");
   var spy = jest.spyOn(console, 'warn');
   expect(spy).not.toHaveBeenCalled();
   (0, _reactHooks.renderHook)(function () {

package/lib/cjs/hooks/useDevelopmentWarning/index.js

@@ -0,0 +1,18 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
+
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+
+_Object$defineProperty(exports, "default", {
+  enumerable: true,
+  get: function get() {
+    return _useDevelopmentWarning["default"];
+  }
+});
+
+var _useDevelopmentWarning = _interopRequireDefault(require("./useDevelopmentWarning"));

package/lib/cjs/hooks/useDevelopmentWarning/useDevelopmentWarning.js

@@ -0,0 +1,28 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
+
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+
+exports["default"] = void 0;
+
+var _react = require("react");
+
+/**
+ * Provides a development-only console warning.
+*/
+var useDevelopmentWarning = function useDevelopmentWarning(_ref) {
+  var message = _ref.message,
+      shouldTrigger = _ref.shouldTrigger;
+  (0, _react.useMemo)(function () {
+    if (process.env.NODE_ENV === 'development' && shouldTrigger) {
+      // eslint-disable-next-line no-console
+      console.warn("".concat(message), '\n', '\n', 'NOTE: This is a development-only warning and will not display in production.');
+    }
+  }, [message, shouldTrigger]);
+};
+
+var _default = useDevelopmentWarning;
+exports["default"] = _default;

package/lib/cjs/hooks/useDevelopmentWarning/useDevelopmentWarning.test.js

@@ -0,0 +1,43 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+
+var _reactHooks = require("@testing-library/react-hooks");
+
+var _useDevelopmentWarning = _interopRequireDefault(require("./useDevelopmentWarning"));
+
+var message = 'This is test message';
+beforeEach(function () {
+  process.env.NODE_ENV = 'development';
+
+  global.console.warn = function () {
+    return jest.mock();
+  }; // eslint-disable-line no-console
+
+});
+afterEach(function () {
+  process.env.NODE_ENV = 'test';
+  jest.restoreAllMocks();
+});
+test('useDevelopmentWarning with message and trigger false', function () {
+  var spy = jest.spyOn(console, 'warn');
+  expect(spy).not.toHaveBeenCalled();
+  (0, _reactHooks.renderHook)(function () {
+    return (0, _useDevelopmentWarning["default"])({
+      message: message,
+      shouldTrigger: false
+    });
+  });
+  expect(spy).not.toHaveBeenCalled();
+});
+test('useDevelopmentWarning with message and trigger true', function () {
+  var spy = jest.spyOn(console, 'warn');
+  expect(spy).not.toHaveBeenCalled();
+  (0, _reactHooks.renderHook)(function () {
+    return (0, _useDevelopmentWarning["default"])({
+      message: message,
+      shouldTrigger: true
+    });
+  });
+  expect(spy).toHaveBeenNthCalledWith(1, expect.stringMatching(message), expect.any(String), expect.any(String), expect.any(String));
+});

package/lib/hooks/useAriaLabelWarning/useAriaLabelWarning.js

@@ -1,19 +1,16 @@
-import { useEffect } from 'react';
+import useDevelopmentWarning from '../useDevelopmentWarning';
 /**
  * Provides a development-only console warning when a component
  * that needs an aria-label is mounted without one.
- *
- * e.g. "\`Component\` requires an aria-label."
 */
 
 var useAriaLabelWarning = function useAriaLabelWarning(component, ariaLabel) {
-  var condition = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
-  useEffect(function () {
-    if (process.env.NODE_ENV === 'development' && condition && !ariaLabel) {
-      // eslint-disable-next-line no-console
-      console.warn("".concat(component, " requires an aria-label"), '\n', '\n', 'NOTE: This is a development-only warning and will not display in production.');
-    }
-  }, []);
+  var shouldTrigger = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
+  var message = "".concat(component, " has an undefined aria-label. If the surrounding content sufficiently labels this component instance, you may disable this warning by setting the prop to `null`. Otherwise, please provide an appropriate aria-label. See more info here: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label");
+  useDevelopmentWarning({
+    message: message,
+    shouldTrigger: shouldTrigger && ariaLabel === undefined
+  });
 };
 
 export default useAriaLabelWarning;

package/lib/hooks/useAriaLabelWarning/useAriaLabelWarning.test.js

@@ -22,7 +22,7 @@ test('default useAriaLabelWarning', function () {
   expect(spy).toHaveBeenCalledTimes(1);
 });
 test('useAriaLabelWarning with string', function () {
-  var compound = "".concat(component, " requires an aria-label");
+  var compound = "".concat(component, " has an undefined aria-label. If the surrounding content sufficiently labels this component instance, you may disable this warning by setting the prop to `null`. Otherwise, please provide an appropriate aria-label. See more info here: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label");
   var spy = jest.spyOn(console, 'warn');
   expect(spy).not.toHaveBeenCalled();
   renderHook(function () {

package/lib/hooks/useDevelopmentWarning/index.js

@@ -0,0 +1 @@
+export { default } from './useDevelopmentWarning';

package/lib/hooks/useDevelopmentWarning/useDevelopmentWarning.js

@@ -0,0 +1,17 @@
+import { useMemo } from 'react';
+/**
+ * Provides a development-only console warning.
+*/
+
+var useDevelopmentWarning = function useDevelopmentWarning(_ref) {
+  var message = _ref.message,
+      shouldTrigger = _ref.shouldTrigger;
+  useMemo(function () {
+    if (process.env.NODE_ENV === 'development' && shouldTrigger) {
+      // eslint-disable-next-line no-console
+      console.warn("".concat(message), '\n', '\n', 'NOTE: This is a development-only warning and will not display in production.');
+    }
+  }, [message, shouldTrigger]);
+};
+
+export default useDevelopmentWarning;

package/lib/hooks/useDevelopmentWarning/useDevelopmentWarning.test.js

@@ -0,0 +1,37 @@
+import { renderHook } from '@testing-library/react-hooks';
+import useDevelopmentWarning from './useDevelopmentWarning';
+var message = 'This is test message';
+beforeEach(function () {
+  process.env.NODE_ENV = 'development';
+
+  global.console.warn = function () {
+    return jest.mock();
+  }; // eslint-disable-line no-console
+
+});
+afterEach(function () {
+  process.env.NODE_ENV = 'test';
+  jest.restoreAllMocks();
+});
+test('useDevelopmentWarning with message and trigger false', function () {
+  var spy = jest.spyOn(console, 'warn');
+  expect(spy).not.toHaveBeenCalled();
+  renderHook(function () {
+    return useDevelopmentWarning({
+      message: message,
+      shouldTrigger: false
+    });
+  });
+  expect(spy).not.toHaveBeenCalled();
+});
+test('useDevelopmentWarning with message and trigger true', function () {
+  var spy = jest.spyOn(console, 'warn');
+  expect(spy).not.toHaveBeenCalled();
+  renderHook(function () {
+    return useDevelopmentWarning({
+      message: message,
+      shouldTrigger: true
+    });
+  });
+  expect(spy).toHaveBeenNthCalledWith(1, expect.stringMatching(message), expect.any(String), expect.any(String), expect.any(String));
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pingux/astro",
-  "version": "1.14.0-alpha.0",
+  "version": "1.14.0-alpha.3",
   "description": "PingUX themeable React component library",
   "author": "ux-development@pingidentity.com",
   "license": "Apache-2.0",