newspack-components 2.0.1 → 2.1.0

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

@@ -6,6 +6,43 @@
 @import '../../../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};
+
+	color: $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;
 	}
@@ -15,12 +52,25 @@
 		border-bottom: 1px solid $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: $gray-700;
+				display: none;
+				margin-left: 8px;
+
+				@media screen and ( min-width: 744px ) {
+					display: block;
+				}
+			}
 		}
 
 		svg {
@@ -35,15 +85,17 @@
 			&:not( .newspack-icon ) {
 				background: $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,26 @@
 					opacity: 1;
 				}
 			}
-		}
-
-		a: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;
+			&:focus-visible {
+				outline: none !important;
+
+				&::before {
+					border: 2px solid white;
+					border-radius: 2px;
+					bottom: 5px;
+					content: '';
+					display: block;
+					left: 6px;
+					position: absolute;
+					right: 6px;
+					top: 6px;
+				}
 			}
 		}
 	}
 
 	&__content {
-		color: $gray-700;
-		font-size: 14px;
-		line-height: 24px;
 		margin: 0 auto;
 		max-width: 1208px;
 		padding: 0 16px;
@@ -84,49 +133,13 @@
 
 		// 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
@@ -141,70 +154,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,86 @@
+"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.__;
+
+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,145 @@
+"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.__;
+(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)(_WizardError.default, {}), (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
+        }), (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;

package/dist/cjs/wizard/store/index.js

@@ -0,0 +1,178 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.WIZARD_STORE_NAMESPACE = void 0;
+
+var _lodash = require("lodash");
+
+var _apiFetch = _interopRequireDefault(require("@wordpress/api-fetch"));
+
+var _data = require("@wordpress/data");
+
+var _utils = require("./utils.js");
+
+/**
+ * External dependencies.
+ */
+
+/**
+ * WordPress dependencies.
+ */
+const WIZARD_STORE_NAMESPACE = 'newspack/wizards';
+exports.WIZARD_STORE_NAMESPACE = WIZARD_STORE_NAMESPACE;
+const DEFAULT_STATE = {
+  isLoading: true,
+  isQuietLoading: false,
+  apiData: {},
+  error: null
+};
+/**
+ * wordpress/data does not trigger a component re-render
+ * on deep state change (via lodash's set function)
+ * unless the state was cloned first.
+ */
+
+const clone = objectToClone => JSON.parse(JSON.stringify(objectToClone));
+
+const reducer = function () {
+  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : DEFAULT_STATE;
+  let {
+    type,
+    payload = {}
+  } = arguments.length > 1 ? arguments[1] : undefined;
+
+  switch (type) {
+    case 'START_LOADING_DATA':
+      if (payload.isQuietLoading) {
+        return { ...state,
+          isQuietLoading: true
+        };
+      }
+
+      return { ...state,
+        isLoading: true
+      };
+
+    case 'FINISH_LOADING_DATA':
+      return { ...state,
+        isLoading: false,
+        isQuietLoading: false
+      };
+
+    case 'SET_API_DATA':
+      return (0, _lodash.set)(clone(state), ['apiData', payload.slug], payload.data);
+
+    case 'UPDATE_WIZARD_SETTINGS':
+      return (0, _lodash.set)(clone(state), ['apiData', payload.slug, ...payload.path], payload.value);
+
+    case 'SET_ERROR':
+      return { ...state,
+        error: payload
+      };
+
+    default:
+      return state;
+  }
+};
+
+const actions = {
+  // Regular actions.
+  startLoadingData: (0, _utils.createAction)('START_LOADING_DATA'),
+  finishLoadingData: (0, _utils.createAction)('FINISH_LOADING_DATA'),
+  fetchFromAPI: (0, _utils.createAction)('FETCH_FROM_API'),
+  setAPIDataForWizard: (0, _utils.createAction)('SET_API_DATA'),
+  updateWizardSettings: (0, _utils.createAction)('UPDATE_WIZARD_SETTINGS'),
+  setError: (0, _utils.createAction)('SET_ERROR'),
+
+  // Async actions. These will not show up in Redux devtools.
+  *saveWizardSettings(_ref) {
+    let {
+      slug,
+      section = '',
+      payloadPath = false,
+      updatePayload = null
+    } = _ref;
+
+    // Optionally data can be updated before saving - an immediate update case
+    // (without an explicit "save" action).
+    if (updatePayload) {
+      yield actions.updateWizardSettings({
+        slug,
+        ...updatePayload
+      });
+    }
+
+    const wizardState = (0, _data.select)(WIZARD_STORE_NAMESPACE).getWizardAPIData(slug);
+    const updatedData = yield actions.fetchFromAPI({
+      path: `/newspack/v1/wizard/${slug}/${section}`,
+      method: 'POST',
+      data: payloadPath ? (0, _lodash.get)(wizardState, payloadPath) : wizardState,
+      isQuietFetch: true
+    });
+
+    if (!(0, _lodash.isEmpty)(updatedData)) {
+      return actions.setAPIDataForWizard({
+        slug,
+        data: updatedData
+      });
+    }
+  },
+
+  *wizardApiFetch(fetchConfig) {
+    // Just a proxy to fetchFromAPI, but it has to be a generator.
+    const result = yield actions.fetchFromAPI(fetchConfig);
+    return result;
+  }
+
+};
+const selectors = {
+  isLoading: state => state.isLoading,
+  isQuietLoading: state => state.isQuietLoading,
+  getWizardAPIData: (state, slug) => state.apiData[slug] || {},
+  getError: state => state.error
+};
+const store = (0, _data.createReduxStore)(WIZARD_STORE_NAMESPACE, {
+  reducer,
+  actions,
+  selectors,
+  controls: {
+    FETCH_FROM_API: action => {
+      (0, _data.dispatch)(WIZARD_STORE_NAMESPACE).startLoadingData({
+        isQuietLoading: Boolean(action.payload.isQuietFetch)
+      });
+      return (0, _apiFetch.default)(action.payload).catch(error => {
+        (0, _data.dispatch)(WIZARD_STORE_NAMESPACE).setError(error);
+        return {
+          error
+        };
+      }).finally(result => {
+        (0, _data.dispatch)(WIZARD_STORE_NAMESPACE).finishLoadingData();
+        return result;
+      });
+    }
+  },
+  resolvers: {
+    *getWizardAPIData(slug) {
+      if (slug) {
+        const data = yield actions.fetchFromAPI({
+          path: `/newspack/v1/wizard/${slug}`
+        });
+        return actions.setAPIDataForWizard({
+          slug,
+          data
+        });
+      }
+
+      return actions.finishLoadingData();
+    }
+
+  }
+});
+
+var _default = () => (0, _data.register)(store);
+
+exports.default = _default;

package/dist/cjs/wizard/store/utils.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useWizardData = exports.createAction = void 0;
+
+var _data = require("@wordpress/data");
+
+var _ = require(".");
+
+/**
+ * WordPress dependencies.
+ */
+
+/**
+ * Internal dependencies
+ */
+const createAction = type => payload => ({
+  type,
+  payload
+});
+
+exports.createAction = createAction;
+
+const useWizardData = function (wizardName) {
+  let defaultValue = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return (0, _data.useSelect)(select => select(_.WIZARD_STORE_NAMESPACE).getWizardAPIData(`newspack-${wizardName}-wizard`)) || defaultValue;
+};
+
+exports.useWizardData = useWizardData;