newspack-components 2.0.3 → 2.2.0

package/dist/cjs/with-wizard-screen/index.js

@@ -1,31 +1,27 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = withWizardScreen;
-
 var _i18n = require("@wordpress/i18n");
-
 var _icons = require("@wordpress/icons");
-
 var _ = require("../");
-
 var _js = require("../../../shared/js/");
-
 require("./style.scss");
-
 var _classnames = _interopRequireDefault(require("classnames"));
-
 var _jsxRuntime = require("@emotion/react/jsx-runtime");
-
 /**
  * WordPress dependencies.
  */
 const __ = _i18n.__;
-
+/**
+ * Internal dependencies
+ */
+/**
+ * External dependencies
+ */
 /**
  * Higher-Order Component to provide plugin management and error handling to Newspack Wizards.
  */
@@ -33,7 +29,6 @@ function withWizardScreen(WrappedComponent) {
   let {
     hidePrimaryButton
   } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-
   const WrappedWithWizardScreen = props => {
     const {
       className,
@@ -45,15 +40,14 @@ function withWizardScreen(WrappedComponent) {
       tabbedNavigation,
       secondaryButtonText,
       secondaryButtonAction,
-      routes,
-      renderAboveContent
+      renderAboveContent,
+      disableUpcomingInTabbedNavigation
     } = props;
     const retrievedButtonProps = (0, _js.buttonProps)(buttonAction);
     const retrievedSecondaryButtonProps = (0, _js.buttonProps)(secondaryButtonAction);
     const SecondaryCTAComponent = retrievedSecondaryButtonProps.plugin ? _.Handoff : _.Button;
     const shouldRenderPrimaryButton = buttonText && buttonAction;
     const shouldRenderSecondaryButton = secondaryButtonText && secondaryButtonAction;
-
     const renderPrimaryButton = function () {
       let overridingProps = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       return retrievedButtonProps.plugin ? (0, _jsxRuntime.jsx)(_.Handoff, {
@@ -64,7 +58,8 @@ function withWizardScreen(WrappedComponent) {
       }) : (0, _jsxRuntime.jsx)(_.Button, {
         isPrimary: !buttonDisabled,
         isSecondary: !!buttonDisabled,
-        disabled: buttonDisabled // Allow overridingProps to set children.
+        disabled: buttonDisabled
+        // Allow overridingProps to set children.
         // eslint-disable-next-line react/no-children-prop
         ,
         children: buttonText,
@@ -72,17 +67,14 @@ function withWizardScreen(WrappedComponent) {
         ...overridingProps
       });
     };
-
     return (0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
       children: [newspack_aux_data.is_debug_mode && (0, _jsxRuntime.jsx)(_.Notice, {
-        isWarning: true,
-        className: "newspack-wizard__above-header",
-        noticeText: __('Newspack is in debug mode.', 'newspack')
-      }), (0, _jsxRuntime.jsxs)("div", {
+        debugMode: true
+      }), (0, _jsxRuntime.jsx)("div", {
         className: "newspack-wizard__header",
-        children: [(0, _jsxRuntime.jsxs)("div", {
+        children: (0, _jsxRuntime.jsx)("div", {
           className: "newspack-wizard__header__inner",
-          children: [(0, _jsxRuntime.jsxs)("div", {
+          children: (0, _jsxRuntime.jsxs)("div", {
             className: "newspack-wizard__title",
             children: [(0, _jsxRuntime.jsx)(_.Button, {
               isLink: true,
@@ -94,23 +86,22 @@ function withWizardScreen(WrappedComponent) {
               children: (0, _jsxRuntime.jsx)(_.NewspackIcon, {
                 size: 36
               })
-            }), headerText && (0, _jsxRuntime.jsx)("h1", {
-              children: headerText
-            }), subHeaderText && (0, _jsxRuntime.jsx)("p", {
-              className: "screen-reader-text",
-              children: subHeaderText
+            }), (0, _jsxRuntime.jsxs)("div", {
+              children: [headerText && (0, _jsxRuntime.jsx)("h2", {
+                children: headerText
+              }), subHeaderText && (0, _jsxRuntime.jsx)("span", {
+                children: subHeaderText
+              })]
             })]
-          }), tabbedNavigation && (0, _jsxRuntime.jsx)(_jsxRuntime.Fragment, {
-            children: (0, _jsxRuntime.jsx)(_.TabbedNavigation, {
-              items: tabbedNavigation
-            })
-          })]
-        }), routes && (0, _jsxRuntime.jsx)(_.WizardPagination, {
-          routes: routes
-        })]
-      }), (0, _jsxRuntime.jsxs)("div", {
+          })
+        })
+      }), tabbedNavigation && (0, _jsxRuntime.jsx)(_.TabbedNavigation, {
+        disableUpcoming: disableUpcomingInTabbedNavigation,
+        items: tabbedNavigation.filter(item => !item.isHiddenInNav)
+      }), (0, _jsxRuntime.jsx)(_.HandoffMessage, {}), (0, _jsxRuntime.jsxs)("div", {
         className: (0, _classnames.default)('newspack-wizard newspack-wizard__content', className),
-        children: [typeof renderAboveContent === 'function' ? renderAboveContent() : null, (0, _jsxRuntime.jsx)(WrappedComponent, { ...props,
+        children: [typeof renderAboveContent === 'function' ? renderAboveContent() : null, (0, _jsxRuntime.jsx)(WrappedComponent, {
+          ...props,
           renderPrimaryButton: renderPrimaryButton
         }), (shouldRenderPrimaryButton || shouldRenderSecondaryButton) && (0, _jsxRuntime.jsxs)("div", {
           className: "newspack-buttons-card",
@@ -123,6 +114,5 @@ function withWizardScreen(WrappedComponent) {
       })]
     });
   };
-
   return WrappedWithWizardScreen;
 }

package/dist/cjs/with-wizard-screen/style.scss

@@ -2,25 +2,75 @@
  * With Wizard Screen
  */
 
-@import '~@wordpress/base-styles/colors';
-@import '../../../shared/scss/colors';
+@use '~@wordpress/base-styles/colors' as wp-colors;
+@use '../../../shared/scss/colors';
 
 .newspack-wizard {
+	// Color
+	--wp-admin-theme-color: #{colors.$primary-500};
+	--wp-admin-theme-color--rgb: #{colors.$primary-500--rgb};
+	--wp-admin-theme-color-darker-10: #{colors.$primary-600};
+	--wp-admin-theme-color-darker-10--rgb: #{colors.$primary-600--rgb};
+	--wp-admin-theme-color-darker-20: #{colors.$primary-700};
+	--wp-admin-theme-color-darker-20--rgb: #{colors.$primary-700--rgb};
+
+	color: wp-colors.$gray-900;
+
+	// Headings
+	h1,
+	h2,
+	h3 {
+		color: inherit;
+	}
+
+	h1 {
+		line-height: 1.4;
+	}
+
+	// Links
+	a {
+		color: var( --wp-admin-theme-color );
+
+		&:active,
+		&:focus,
+		&:hover {
+			color: var( --wp-admin-theme-color-darker-10 );
+		}
+
+		&:focus {
+			box-shadow: 0 0 0 var( --wp-admin-border-width-focus ) var( --wp-admin-theme-color );
+			outline: 3px solid transparent;
+		}
+	}
+
 	&__header {
 		background: white;
 	}
 
 	&__title {
 		align-items: center;
-		border-bottom: 1px solid $gray-300;
+		border-bottom: 1px solid wp-colors.$gray-300;
 		display: flex;
 
-		h1 {
-			color: $gray-900;
-			font-size: 21px;
-			line-height: 30px;
+		h2 {
 			margin: 0;
+			padding: 0;
+		}
+
+		> div {
+			align-items: baseline;
+			display: flex;
 			padding: 0 24px;
+
+			span {
+				color: wp-colors.$gray-700;
+				display: none;
+				margin-left: 8px;
+
+				@media screen and ( min-width: 744px ) {
+					display: block;
+				}
+			}
 		}
 
 		svg {
@@ -33,17 +83,19 @@
 			}
 
 			&:not( .newspack-icon ) {
-				background: $primary-500;
+				background: colors.$primary-500;
 				left: 50%;
-				margin: -18px 0 0 -18px !important;
+				margin: -28px 0 0 -28px !important;
 				opacity: 0;
+				padding: 10px;
 				position: absolute;
 				top: 50%;
 				transition: opacity 125ms ease-in-out;
 			}
 		}
 
-		a {
+		.components-button.has-icon {
+			padding: 0;
 			position: relative;
 
 			&:hover {
@@ -51,29 +103,23 @@
 					opacity: 1;
 				}
 			}
-		}
 
-		a:focus-visible {
-			outline: none !important;
+			&:focus-visible {
+				outline: none !important;
 
-			&::before {
-				border: 2px solid white;
-				border-radius: 3px;
-				bottom: 5px;
-				content: '';
-				display: block;
-				left: 6px;
-				position: absolute;
-				right: 6px;
-				top: 6px;
+				&::before {
+					border: 2px solid white;
+					border-radius: 2px;
+					content: '';
+					display: block;
+					inset: 6px 6px 5px;
+					position: absolute;
+				}
 			}
 		}
 	}
 
 	&__content {
-		color: $gray-700;
-		font-size: 14px;
-		line-height: 24px;
 		margin: 0 auto;
 		max-width: 1208px;
 		padding: 0 16px;
@@ -84,55 +130,19 @@
 
 		// Typography
 
-		h1,
-		h2,
-		h3,
-		p {
-			line-height: 24px;
-			margin: 32px 0;
-			padding: 0;
-		}
-
-		h1 {
-			color: $gray-900;
-			font-size: 21px;
-			font-weight: bold;
-			line-height: 32px;
-		}
-
-		h2 {
-			color: $gray-900;
-			font-size: 17px;
-			font-weight: bold;
-		}
-
-		h3 {
-			color: $gray-900;
-			font-size: 14px;
-			font-weight: bold;
-		}
-
-		p {
-			font-size: 14px;
-
-			&.is-dark {
-				color: $gray-900;
-			}
-		}
-
 		strong {
 			font-weight: bold;
 		}
 
 		small {
 			font-size: 12px;
-			line-height: 16px;
+			line-height: 1.4;
 		}
 
 		// Thematic Break
 
 		hr {
-			background: $gray-300;
+			background: wp-colors.$gray-300;
 			border: 0;
 			height: 1px;
 			margin: 48px 0;
@@ -141,70 +151,10 @@
 				margin: 64px 0;
 			}
 		}
-
-		// Links
-
-		a {
-			color: $primary-500;
-
-			&:active,
-			&:focus,
-			&:hover {
-				color: $primary-600;
-				text-decoration: none;
-			}
-
-			&:focus {
-				box-shadow: none;
-				outline: 2px solid $primary-500;
-				outline-offset: 2px;
-			}
-		}
 	}
 
 	&__above-header {
+		border-radius: 0;
 		margin: 0;
 	}
 }
-
-// Buttons Card
-
-.newspack-buttons-card {
-	display: flex;
-	flex-direction: row-reverse;
-	justify-content: flex-start;
-	align-items: center;
-	margin: 64px 0 32px;
-
-	&:empty {
-		display: none;
-	}
-
-	.newspack-button {
-		margin-left: 16px;
-	}
-}
-
-// Checkbox Icon
-
-.newspack-checkbox-icon {
-	background: white;
-	border-radius: 50%;
-	box-shadow: inset 0 0 0 1px $gray-300;
-	display: block;
-	height: 24px;
-	width: 24px;
-
-	svg {
-		fill: $gray-700;
-	}
-
-	&--checked {
-		background: $alert-green;
-		box-shadow: none;
-
-		svg {
-			fill: white;
-		}
-	}
-}

package/dist/cjs/wizard/components/WizardError.js

@@ -0,0 +1,74 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _i18n = require("@wordpress/i18n");
+var _data = require("@wordpress/data");
+var _ = require("../..");
+var _store = require("../store");
+var _jsxRuntime = require("@emotion/react/jsx-runtime");
+/**
+ * WordPress dependencies.
+ */
+const __ = _i18n.__;
+/**
+ * Internal dependencies.
+ */
+const parseError = _ref => {
+  let {
+    data,
+    message,
+    code
+  } = _ref;
+  let level = 'fatal';
+  if (!!data && 'level' in data) {
+    level = data.level;
+  } else if ('rest_invalid_param' === code) {
+    level = 'notice';
+  }
+  return {
+    message,
+    level
+  };
+};
+const WizardError = () => {
+  const error = (0, _data.useSelect)(select => select(_store.WIZARD_STORE_NAMESPACE).getError());
+  if (!error) {
+    return null;
+  }
+  const {
+    level,
+    message
+  } = parseError(error);
+  if ('fatal' === level) {
+    const fallbackURL = typeof newspack_urls !== 'undefined' && newspack_urls.dashboard;
+    return (0, _jsxRuntime.jsxs)(_.Modal, {
+      title: __('Unrecoverable error'),
+      onRequestClose: fallbackURL ? () => window.location = fallbackURL : undefined,
+      children: [(0, _jsxRuntime.jsx)(_.Notice, {
+        noticeText: message,
+        isError: true,
+        rawHTML: true
+      }), fallbackURL && (0, _jsxRuntime.jsx)(_.Card, {
+        buttonsCard: true,
+        noBorder: true,
+        className: "justify-end",
+        children: (0, _jsxRuntime.jsx)(_.Button, {
+          isPrimary: true,
+          href: fallbackURL,
+          children: __('Return to Dashboard', 'newspack')
+        })
+      })]
+    });
+  }
+  return (0, _jsxRuntime.jsx)(_.Notice, {
+    isError: true,
+    className: "newspack-wizard__above-header",
+    noticeText: message,
+    rawHTML: true
+  });
+};
+var _default = WizardError;
+exports.default = _default;

package/dist/cjs/wizard/index.js

@@ -0,0 +1,131 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _classnames = _interopRequireDefault(require("classnames"));
+var _data = require("@wordpress/data");
+var _element = require("@wordpress/element");
+var _i18n = require("@wordpress/i18n");
+var _icons = require("@wordpress/icons");
+var _ = require("../");
+var _router = _interopRequireDefault(require("../proxied-imports/router"));
+var _store = _interopRequireWildcard(require("./store"));
+var _utils = require("./store/utils");
+var _WizardError = _interopRequireDefault(require("./components/WizardError"));
+var _jsxRuntime = require("@emotion/react/jsx-runtime");
+/**
+ * External dependencies.
+ */
+/**
+ * WordPress dependencies.
+ */
+const __ = _i18n.__;
+/**
+ * Internal dependencies
+ */
+(0, _store.default)();
+const {
+  HashRouter,
+  Redirect,
+  Route,
+  Switch
+} = _router.default;
+const Wizard = _ref => {
+  let {
+    sections = [],
+    apiSlug,
+    headerText,
+    subHeaderText,
+    hasSimpleFooter,
+    className,
+    renderAboveSections,
+    requiredPlugins = []
+  } = _ref;
+  const isLoading = (0, _data.useSelect)(select => select(_store.WIZARD_STORE_NAMESPACE).isLoading());
+  const isQuietLoading = (0, _data.useSelect)(select => select(_store.WIZARD_STORE_NAMESPACE).isQuietLoading());
+
+  // Trigger initial data fetch. Some sections might not use the wizard data,
+  // but for consistency, fetching is triggered regardless of the section.
+  (0, _data.useSelect)(select => select(_store.WIZARD_STORE_NAMESPACE).getWizardAPIData(apiSlug));
+  let displayedSections = sections.filter(section => !section.isHidden);
+  const [pluginRequirementsSatisfied, setPluginRequirementsSatisfied] = (0, _element.useState)(requiredPlugins.length === 0);
+  if (!pluginRequirementsSatisfied) {
+    headerText = requiredPlugins.length > 1 ? __('Required plugins', 'newspack') : __('Required plugin', 'newspack');
+    displayedSections = [{
+      path: '/',
+      render: () => (0, _jsxRuntime.jsx)(_.PluginInstaller, {
+        plugins: requiredPlugins,
+        onStatus: _ref2 => {
+          let {
+            complete
+          } = _ref2;
+          return setPluginRequirementsSatisfied(complete);
+        }
+      })
+    }];
+  }
+  return (0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
+    children: [(0, _jsxRuntime.jsx)("div", {
+      className: (0, _classnames.default)(isLoading ? 'newspack-wizard__is-loading' : 'newspack-wizard__is-loaded', {
+        'newspack-wizard__is-loading-quiet': isQuietLoading
+      }),
+      children: (0, _jsxRuntime.jsxs)(HashRouter, {
+        hashType: "slash",
+        children: [newspack_aux_data.is_debug_mode && (0, _jsxRuntime.jsx)(_.Notice, {
+          debugMode: true
+        }), (0, _jsxRuntime.jsx)("div", {
+          className: "bg-white",
+          children: (0, _jsxRuntime.jsx)("div", {
+            className: "newspack-wizard__header__inner",
+            children: (0, _jsxRuntime.jsxs)("div", {
+              className: "newspack-wizard__title",
+              children: [(0, _jsxRuntime.jsx)(_.Button, {
+                isLink: true,
+                href: newspack_urls.dashboard,
+                label: __('Return to Dashboard', 'newspack'),
+                showTooltip: true,
+                icon: _icons.category,
+                iconSize: 36,
+                children: (0, _jsxRuntime.jsx)(_.NewspackIcon, {
+                  size: 36
+                })
+              }), (0, _jsxRuntime.jsxs)("div", {
+                children: [headerText && (0, _jsxRuntime.jsx)("h2", {
+                  children: headerText
+                }), subHeaderText && (0, _jsxRuntime.jsx)("span", {
+                  children: subHeaderText
+                })]
+              })]
+            })
+          })
+        }), displayedSections.length > 1 && (0, _jsxRuntime.jsx)(_.TabbedNavigation, {
+          items: displayedSections,
+          children: (0, _jsxRuntime.jsx)(_WizardError.default, {})
+        }), (0, _jsxRuntime.jsx)(_.HandoffMessage, {}), (0, _jsxRuntime.jsxs)(Switch, {
+          children: [displayedSections.map((section, index) => {
+            const SectionComponent = section.render;
+            return (0, _jsxRuntime.jsx)(Route, {
+              path: section.path,
+              children: (0, _jsxRuntime.jsxs)("div", {
+                className: (0, _classnames.default)('newspack-wizard newspack-wizard__content', className),
+                children: ['function' === typeof renderAboveSections ? renderAboveSections() : null, (0, _jsxRuntime.jsx)(SectionComponent, {})]
+              })
+            }, index);
+          }), (0, _jsxRuntime.jsx)(Redirect, {
+            to: displayedSections[0].path
+          })]
+        })]
+      })
+    }), !isLoading && (0, _jsxRuntime.jsx)(_.Footer, {
+      simple: hasSimpleFooter
+    })]
+  });
+};
+Wizard.useWizardData = _utils.useWizardData;
+Wizard.STORE_NAMESPACE = _store.WIZARD_STORE_NAMESPACE;
+var _default = Wizard;
+exports.default = _default;