newspack-components 2.1.0 → 2.2.0

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

@@ -1,44 +1,35 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = withWizard;
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _element = require("@wordpress/element");
-
 var _i18n = require("@wordpress/i18n");
-
 var _apiFetch = _interopRequireDefault(require("@wordpress/api-fetch"));
-
 var _icons = require("@wordpress/icons");
-
 var _ = require("../");
-
 var _router = _interopRequireDefault(require("../proxied-imports/router"));
-
 var _footer = _interopRequireDefault(require("../footer"));
-
 require("./style.scss");
-
 var _jsxRuntime = require("@emotion/react/jsx-runtime");
-
 /**
  * WordPress dependencies.
  */
 const __ = _i18n.__;
+/**
+ * Internal dependencies.
+ */
 const {
   Redirect,
   Route
 } = _router.default;
+
 /**
  * Higher-Order Component to provide plugin management and error handling to Newspack Wizards.
  */
-
 function withWizard(WrappedComponent, requiredPlugins) {
   return class WrappedWithWizard extends _element.Component {
     constructor(props) {
@@ -46,11 +37,16 @@ function withWizard(WrappedComponent, requiredPlugins) {
       (0, _defineProperty2.default)(this, "componentDidMount", () => {
         // If there are no requiredPlugins, fire onWizardReady as soon as component mounts.
         if (!requiredPlugins) {
-          const instance = this.wrappedComponentRef.current; // eslint-disable-next-line no-unused-expressions
-
+          const instance = this.wrappedComponentRef.current;
+          // eslint-disable-next-line no-unused-expressions
           instance && instance.onWizardReady && instance.onWizardReady();
         }
       });
+      /**
+       * Set the error. Called by Wizards when an error occurs.
+       *
+       * @return {Promise} Resolved after state update
+       */
       (0, _defineProperty2.default)(this, "setError", error => {
         return new Promise(resolve => {
           this.setState({
@@ -58,26 +54,33 @@ function withWizard(WrappedComponent, requiredPlugins) {
           }, () => resolve());
         });
       });
+      /**
+       * Render any errors that need rendering.
+       *
+       * @return {Component} Error UI
+       */
       (0, _defineProperty2.default)(this, "getError", () => {
         const {
           error
         } = this.state;
-
         if (!error) {
           return null;
         }
-
         const parsedError = this.parseError(error);
         const {
           level
         } = parsedError;
-
         if ('fatal' === level) {
           return this.getFatalError(parsedError);
         }
-
         return this.getErrorNotice(parsedError);
       });
+      /**
+       * Get a notice-level error.
+       *
+       * @param {Error} error object already parsed by parseError
+       * @return {Component} Error notice
+       */
       (0, _defineProperty2.default)(this, "getErrorNotice", error => {
         const {
           message
@@ -89,13 +92,17 @@ function withWizard(WrappedComponent, requiredPlugins) {
           rawHTML: true
         });
       });
+      /**
+       * Get a fatal-level error.
+       *
+       * @param {Error} error object already parsed by parseError
+       * @return {Component} React object
+       */
       (0, _defineProperty2.default)(this, "getFatalError", error => {
         const fallbackURL = this.getFallbackURL();
-
         if (!fallbackURL) {
           return null;
         }
-
         const {
           message
         } = error;
@@ -118,6 +125,12 @@ function withWizard(WrappedComponent, requiredPlugins) {
           })]
         });
       });
+      /**
+       * Get all the relevant info out of a raw API error response.
+       *
+       * @param {Object} error error object
+       * @return {Object} Error object with relevant fields and defaults
+       */
       (0, _defineProperty2.default)(this, "parseError", error => {
         const {
           data,
@@ -125,27 +138,26 @@ function withWizard(WrappedComponent, requiredPlugins) {
           code
         } = error;
         let level = 'fatal';
-
         if (!!data && 'level' in data) {
           level = data.level;
         } else if ('rest_invalid_param' === code) {
           level = 'notice';
         }
-
         return {
           message,
           level
         };
       });
+      /**
+       * Called when plugin installation is complete. Updates state and calls onWizardReady on the wrapped component.
+       */
       (0, _defineProperty2.default)(this, "pluginInstallationStatus", _ref => {
         let {
           complete
         } = _ref;
-
         if (this.state.loading) {
           this.doneLoading();
         }
-
         const instance = this.wrappedComponentRef.current;
         this.setState({
           complete
@@ -154,6 +166,9 @@ function withWizard(WrappedComponent, requiredPlugins) {
           complete && instance && instance.onWizardReady && instance.onWizardReady();
         });
       });
+      /**
+       * Begin loading.
+       */
       (0, _defineProperty2.default)(this, "startLoading", quiet => {
         if (quiet) {
           this.setState(state => ({
@@ -165,6 +180,9 @@ function withWizard(WrappedComponent, requiredPlugins) {
           }));
         }
       });
+      /**
+       * End loading.
+       */
       (0, _defineProperty2.default)(this, "doneLoading", quiet => {
         if (quiet) {
           this.setState(state => ({
@@ -176,6 +194,9 @@ function withWizard(WrappedComponent, requiredPlugins) {
           }));
         }
       });
+      /**
+       * Replacement for core apiFetch that automatically manages wizard loading UI.
+       */
       (0, _defineProperty2.default)(this, "wizardApiFetch", args => {
         const {
           quiet
@@ -191,19 +212,22 @@ function withWizard(WrappedComponent, requiredPlugins) {
           });
         });
       });
+      /**
+       * Render a Route that checks for plugin installation requirements, and redirects to '/' when all are done.
+       *
+       * @return {void}
+       */
       (0, _defineProperty2.default)(this, "pluginRequirements", () => {
         const {
           complete
         } = this.state;
         /* After all plugins are loaded, redirect to / (this could be configurable) */
-
         if (complete) {
           return (0, _jsxRuntime.jsx)(Redirect, {
             from: "/plugin-requirements",
             to: "/"
           });
         }
-
         return (0, _jsxRuntime.jsx)(Route, {
           path: "/",
           render: () => (0, _jsxRuntime.jsxs)(_element.Fragment, {
@@ -253,7 +277,6 @@ function withWizard(WrappedComponent, requiredPlugins) {
       };
       this.wrappedComponentRef = (0, _element.createRef)();
     }
-
     /**
      * Render.
      */
@@ -267,11 +290,9 @@ function withWizard(WrappedComponent, requiredPlugins) {
         error
       } = this.state;
       const loadingClasses = [loading ? 'newspack-wizard__is-loading' : 'newspack-wizard__is-loaded'];
-
       if (quietLoading) {
         loadingClasses.push('newspack-wizard__is-loading-quiet');
       }
-
       return (0, _jsxRuntime.jsxs)(_element.Fragment, {
         children: [this.getError(), (0, _jsxRuntime.jsx)("div", {
           className: loadingClasses.join(' '),
@@ -293,6 +314,5 @@ function withWizard(WrappedComponent, requiredPlugins) {
         })]
       });
     }
-
   };
 }

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

@@ -2,8 +2,8 @@
  * With Wizard
  */
 
-@import '~@wordpress/base-styles/colors';
-@import '../../../shared/scss/colors';
+@use '~@wordpress/base-styles/colors' as wp-colors;
+@use '../../../shared/scss/colors';
 
 // Reset Padding of the Admin Page
 
@@ -32,11 +32,11 @@ body[class*='admin_page_newspack-'] {
 
 svg {
 	&.newspack--error {
-		fill: $alert-red;
+		fill: wp-colors.$alert-red;
 		transform: rotate( 180deg );
 	}
 	&.newspack--success {
-		fill: $alert-green;
+		fill: wp-colors.$alert-green;
 	}
 }
 
@@ -44,12 +44,12 @@ svg {
 
 .newspack-wizard__blue {
 	#wpwrap {
-		background: $primary-500;
+		background: colors.$primary-500;
 	}
 
 	.newspack-footer {
-		background: $primary-500;
-		border-color: $primary-500;
+		background: colors.$primary-500;
+		border-color: colors.$primary-500;
 		justify-content: center;
 
 		&__logo {
@@ -76,12 +76,9 @@ svg {
 
 .newspack-wizard__is-loading {
 	background: white;
-	bottom: 0;
 	cursor: wait;
-	left: 0;
+	inset: 0;
 	position: absolute;
-	right: 0;
-	top: 0;
 
 	> * {
 		display: none !important;
@@ -95,38 +92,39 @@ svg {
 	}
 
 	&::before {
-		background: $primary-500;
-		box-shadow: 24px 0 0 white, 69px 0 0 -15px $gray-900, 99px 0 0 -15px $gray-900,
-			129px 0 0 -15px $gray-900, 159px 0 0 -15px $gray-900, 189px 0 0 -15px $gray-900;
+		background: colors.$primary-500;
+		box-shadow: 24px 0 0 white, 69px 0 0 -15px wp-colors.$gray-900,
+			99px 0 0 -15px wp-colors.$gray-900, 129px 0 0 -15px wp-colors.$gray-900,
+			159px 0 0 -15px wp-colors.$gray-900, 189px 0 0 -15px wp-colors.$gray-900;
 		height: 60px;
 		width: 60px;
 	}
 
 	&::after {
-		background: $gray-900;
-		box-shadow: inset -40vw 0 0 0 white, 0 64px 0 0 $gray-700, 40vw 96px 0 0 white,
-			0 96px 0 0 $gray-700;
+		background: wp-colors.$gray-900;
+		box-shadow: inset -40vw 0 0 0 white, 0 64px 0 0 wp-colors.$gray-700, 40vw 96px 0 0 white,
+			0 96px 0 0 wp-colors.$gray-700;
 		height: 24px;
 		margin: 68px auto 0;
 		max-width: 1040px;
 		width: calc( 100% - ( 32px * 2 ) );
 
 		@media screen and ( min-width: 744px ) {
-			box-shadow: inset -400px 0 0 0 white, 0 64px 0 0 $gray-700, 200px 96px 0 0 white,
-				0 96px 0 0 $gray-700;
+			box-shadow: inset -400px 0 0 0 white, 0 64px 0 0 wp-colors.$gray-700, 200px 96px 0 0 white,
+				0 96px 0 0 wp-colors.$gray-700;
 			width: calc( 100% - ( 64px * 2 ) );
 		}
 
 		@media screen and ( min-width: 1224px ) {
-			box-shadow: inset -600px 0 0 0 white, 0 64px 0 0 $gray-700, 512px 96px 0 0 white,
-				0 96px 0 0 $gray-700;
+			box-shadow: inset -600px 0 0 0 white, 0 64px 0 0 wp-colors.$gray-700, 512px 96px 0 0 white,
+				0 96px 0 0 wp-colors.$gray-700;
 			width: calc( 100% - ( 64px * 2 ) );
 		}
 	}
 
 	// Blue Screen
 	.newspack-wizard__blue & {
-		background: $primary-500;
+		background: colors.$primary-500;
 
 		&::before {
 			animation: loading-quiet 1.25s ease-in-out infinite;
@@ -182,7 +180,7 @@ svg {
 
 		&::before {
 			animation: loading-quiet 1.25s ease-in-out infinite;
-			background: $primary-500;
+			background: colors.$primary-500;
 			height: 8px;
 			right: 100%;
 			z-index: 9999;
@@ -210,42 +208,42 @@ svg {
 		animation: loading 2s ease-in-out infinite;
 		content: '';
 		display: block;
-		background: $gray-900;
-		box-shadow: inset -40vw 0 0 0 white, 0 64px 0 0 $gray-700, 40vw 96px 0 0 white,
-			0 96px 0 0 $gray-700;
+		background: wp-colors.$gray-900;
+		box-shadow: inset -40vw 0 0 0 white, 0 64px 0 0 wp-colors.$gray-700, 40vw 96px 0 0 white,
+			0 96px 0 0 wp-colors.$gray-700;
 		height: 24px;
 		margin: 0 auto;
 		max-width: 1040px;
 		width: 100%;
 
 		@media screen and ( min-width: 744px ) {
-			box-shadow: inset -400px 0 0 0 white, 0 64px 0 0 $gray-700, 200px 96px 0 0 white,
-				0 96px 0 0 $gray-700;
+			box-shadow: inset -400px 0 0 0 white, 0 64px 0 0 wp-colors.$gray-700, 200px 96px 0 0 white,
+				0 96px 0 0 wp-colors.$gray-700;
 		}
 
 		@media screen and ( min-width: 1224px ) {
-			box-shadow: inset -600px 0 0 0 white, 0 64px 0 0 $gray-700, 520px 96px 0 0 white,
-				0 96px 0 0 $gray-700;
+			box-shadow: inset -600px 0 0 0 white, 0 64px 0 0 wp-colors.$gray-700, 520px 96px 0 0 white,
+				0 96px 0 0 wp-colors.$gray-700;
 		}
 	}
 }
 
 @keyframes loading {
-	from {
-		opacity: 100%;
+	0% {
+		opacity: 1;
 	}
 
 	50% {
-		opacity: 10%;
+		opacity: 0.1;
 	}
 
-	to {
-		opacity: 100%;
+	100% {
+		opacity: 1;
 	}
 }
 
 @keyframes loading-quiet {
-	from {
+	0% {
 		left: 0;
 		right: 100%;
 	}
@@ -255,7 +253,7 @@ svg {
 		right: 0;
 	}
 
-	to {
+	100% {
 		left: 100%;
 		right: 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,
@@ -53,7 +48,6 @@ function withWizardScreen(WrappedComponent) {
     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,7 +67,6 @@ function withWizardScreen(WrappedComponent) {
         ...overridingProps
       });
     };
-
     return (0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
       children: [newspack_aux_data.is_debug_mode && (0, _jsxRuntime.jsx)(_.Notice, {
         debugMode: true
@@ -104,9 +98,10 @@ function withWizardScreen(WrappedComponent) {
       }), tabbedNavigation && (0, _jsxRuntime.jsx)(_.TabbedNavigation, {
         disableUpcoming: disableUpcomingInTabbedNavigation,
         items: tabbedNavigation.filter(item => !item.isHiddenInNav)
-      }), (0, _jsxRuntime.jsxs)("div", {
+      }), (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",
@@ -119,6 +114,5 @@ function withWizardScreen(WrappedComponent) {
       })]
     });
   };
-
   return WrappedWithWizardScreen;
 }

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

@@ -2,19 +2,19 @@
  * 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: #{$primary-500};
-	--wp-admin-theme-color--rgb: #{$primary-500--rgb};
-	--wp-admin-theme-color-darker-10: #{$primary-600};
-	--wp-admin-theme-color-darker-10--rgb: #{$primary-600--rgb};
-	--wp-admin-theme-color-darker-20: #{$primary-700};
-	--wp-admin-theme-color-darker-20--rgb: #{$primary-700--rgb};
+	--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: $gray-900;
+	color: wp-colors.$gray-900;
 
 	// Headings
 	h1,
@@ -49,7 +49,7 @@
 
 	&__title {
 		align-items: center;
-		border-bottom: 1px solid $gray-300;
+		border-bottom: 1px solid wp-colors.$gray-300;
 		display: flex;
 
 		h2 {
@@ -63,7 +63,7 @@
 			padding: 0 24px;
 
 			span {
-				color: $gray-700;
+				color: wp-colors.$gray-700;
 				display: none;
 				margin-left: 8px;
 
@@ -83,7 +83,7 @@
 			}
 
 			&:not( .newspack-icon ) {
-				background: $primary-500;
+				background: colors.$primary-500;
 				left: 50%;
 				margin: -28px 0 0 -28px !important;
 				opacity: 0;
@@ -110,13 +110,10 @@
 				&::before {
 					border: 2px solid white;
 					border-radius: 2px;
-					bottom: 5px;
 					content: '';
 					display: block;
-					left: 6px;
+					inset: 6px 6px 5px;
 					position: absolute;
-					right: 6px;
-					top: 6px;
 				}
 			}
 		}
@@ -145,7 +142,7 @@
 		// Thematic Break
 
 		hr {
-			background: $gray-300;
+			background: wp-colors.$gray-300;
 			border: 0;
 			height: 1px;
 			margin: 48px 0;

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

@@ -4,22 +4,18 @@ 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,
@@ -27,31 +23,25 @@ const parseError = _ref => {
     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, {
@@ -73,7 +63,6 @@ const WizardError = () => {
       })]
     });
   }
-
   return (0, _jsxRuntime.jsx)(_.Notice, {
     isError: true,
     className: "newspack-wizard__above-header",
@@ -81,6 +70,5 @@ const WizardError = () => {
     rawHTML: true
   });
 };
-
 var _default = WizardError;
 exports.default = _default;