newspack-components 2.0.3 → 2.1.0

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

@@ -0,0 +1,78 @@
+/**
+ * WordPress dependencies.
+ */
+import { __ as alias__ } from '@wordpress/i18n';
+const __ = alias__;
+import { useSelect } from '@wordpress/data';
+/**
+ * Internal dependencies.
+ */
+
+import { Button, Card, Modal, Notice } from '../..';
+import { WIZARD_STORE_NAMESPACE } from '../store';
+import { jsx as _jsx } from "@emotion/react/jsx-runtime";
+import { jsxs as _jsxs } from "@emotion/react/jsx-runtime";
+
+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 = useSelect(select => select(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 _jsxs(Modal, {
+      title: __('Unrecoverable error'),
+      onRequestClose: fallbackURL ? () => window.location = fallbackURL : undefined,
+      children: [_jsx(Notice, {
+        noticeText: message,
+        isError: true,
+        rawHTML: true
+      }), fallbackURL && _jsx(Card, {
+        buttonsCard: true,
+        noBorder: true,
+        className: "justify-end",
+        children: _jsx(Button, {
+          isPrimary: true,
+          href: fallbackURL,
+          children: __('Return to Dashboard', 'newspack')
+        })
+      })]
+    });
+  }
+
+  return _jsx(Notice, {
+    isError: true,
+    className: "newspack-wizard__above-header",
+    noticeText: message,
+    rawHTML: true
+  });
+};
+
+export default WizardError;

package/dist/esm/wizard/index.js

@@ -0,0 +1,128 @@
+/**
+ * External dependencies.
+ */
+import classnames from 'classnames';
+/**
+ * WordPress dependencies.
+ */
+
+import { useSelect } from '@wordpress/data';
+import { useState } from '@wordpress/element';
+import { __ as alias__ } from '@wordpress/i18n';
+const __ = alias__;
+import { category } from '@wordpress/icons';
+/**
+ * Internal dependencies
+ */
+
+import { Footer, Notice, Button, NewspackIcon, TabbedNavigation, PluginInstaller } from '../';
+import Router from '../proxied-imports/router';
+import registerStore, { WIZARD_STORE_NAMESPACE } from './store';
+import { useWizardData } from './store/utils';
+import WizardError from './components/WizardError';
+import { jsx as _jsx } from "@emotion/react/jsx-runtime";
+import { jsxs as _jsxs } from "@emotion/react/jsx-runtime";
+import { Fragment as _Fragment } from "@emotion/react/jsx-runtime";
+registerStore();
+const {
+  HashRouter,
+  Redirect,
+  Route,
+  Switch
+} = Router;
+
+const Wizard = _ref => {
+  let {
+    sections = [],
+    apiSlug,
+    headerText,
+    subHeaderText,
+    hasSimpleFooter,
+    className,
+    renderAboveSections,
+    requiredPlugins = []
+  } = _ref;
+  const isLoading = useSelect(select => select(WIZARD_STORE_NAMESPACE).isLoading());
+  const isQuietLoading = useSelect(select => select(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.
+
+  useSelect(select => select(WIZARD_STORE_NAMESPACE).getWizardAPIData(apiSlug));
+  let displayedSections = sections.filter(section => !section.isHidden);
+  const [pluginRequirementsSatisfied, setPluginRequirementsSatisfied] = useState(requiredPlugins.length === 0);
+
+  if (!pluginRequirementsSatisfied) {
+    headerText = requiredPlugins.length > 1 ? __('Required plugins', 'newspack') : __('Required plugin', 'newspack');
+    displayedSections = [{
+      path: '/',
+      render: () => _jsx(PluginInstaller, {
+        plugins: requiredPlugins,
+        onStatus: _ref2 => {
+          let {
+            complete
+          } = _ref2;
+          return setPluginRequirementsSatisfied(complete);
+        }
+      })
+    }];
+  }
+
+  return _jsxs(_Fragment, {
+    children: [_jsx(WizardError, {}), _jsx("div", {
+      className: classnames(isLoading ? 'newspack-wizard__is-loading' : 'newspack-wizard__is-loaded', {
+        'newspack-wizard__is-loading-quiet': isQuietLoading
+      }),
+      children: _jsxs(HashRouter, {
+        hashType: "slash",
+        children: [newspack_aux_data.is_debug_mode && _jsx(Notice, {
+          debugMode: true
+        }), _jsx("div", {
+          className: "bg-white",
+          children: _jsx("div", {
+            className: "newspack-wizard__header__inner",
+            children: _jsxs("div", {
+              className: "newspack-wizard__title",
+              children: [_jsx(Button, {
+                isLink: true,
+                href: newspack_urls.dashboard,
+                label: __('Return to Dashboard', 'newspack'),
+                showTooltip: true,
+                icon: category,
+                iconSize: 36,
+                children: _jsx(NewspackIcon, {
+                  size: 36
+                })
+              }), _jsxs("div", {
+                children: [headerText && _jsx("h2", {
+                  children: headerText
+                }), subHeaderText && _jsx("span", {
+                  children: subHeaderText
+                })]
+              })]
+            })
+          })
+        }), displayedSections.length > 1 && _jsx(TabbedNavigation, {
+          items: displayedSections
+        }), _jsxs(Switch, {
+          children: [displayedSections.map((section, index) => {
+            const SectionComponent = section.render;
+            return _jsx(Route, {
+              path: section.path,
+              children: _jsxs("div", {
+                className: classnames('newspack-wizard newspack-wizard__content', className),
+                children: ['function' === typeof renderAboveSections ? renderAboveSections() : null, _jsx(SectionComponent, {})]
+              })
+            }, index);
+          }), _jsx(Redirect, {
+            to: displayedSections[0].path
+          })]
+        })]
+      })
+    }), !isLoading && _jsx(Footer, {
+      simple: hasSimpleFooter
+    })]
+  });
+};
+
+Wizard.useWizardData = useWizardData;
+Wizard.STORE_NAMESPACE = WIZARD_STORE_NAMESPACE;
+export default Wizard;

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

@@ -0,0 +1,161 @@
+/**
+ * External dependencies.
+ */
+import { set, get, isEmpty } from 'lodash';
+/**
+ * WordPress dependencies.
+ */
+
+import apiFetch from '@wordpress/api-fetch';
+import { createReduxStore, register, dispatch, select } from '@wordpress/data';
+import { createAction } from './utils.js';
+export const WIZARD_STORE_NAMESPACE = 'newspack/wizards';
+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 set(clone(state), ['apiData', payload.slug], payload.data);
+
+    case 'UPDATE_WIZARD_SETTINGS':
+      return 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: createAction('START_LOADING_DATA'),
+  finishLoadingData: createAction('FINISH_LOADING_DATA'),
+  fetchFromAPI: createAction('FETCH_FROM_API'),
+  setAPIDataForWizard: createAction('SET_API_DATA'),
+  updateWizardSettings: createAction('UPDATE_WIZARD_SETTINGS'),
+  setError: 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 = select(WIZARD_STORE_NAMESPACE).getWizardAPIData(slug);
+    const updatedData = yield actions.fetchFromAPI({
+      path: `/newspack/v1/wizard/${slug}/${section}`,
+      method: 'POST',
+      data: payloadPath ? get(wizardState, payloadPath) : wizardState,
+      isQuietFetch: true
+    });
+
+    if (!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 = createReduxStore(WIZARD_STORE_NAMESPACE, {
+  reducer,
+  actions,
+  selectors,
+  controls: {
+    FETCH_FROM_API: action => {
+      dispatch(WIZARD_STORE_NAMESPACE).startLoadingData({
+        isQuietLoading: Boolean(action.payload.isQuietFetch)
+      });
+      return apiFetch(action.payload).catch(error => {
+        dispatch(WIZARD_STORE_NAMESPACE).setError(error);
+        return {
+          error
+        };
+      }).finally(result => {
+        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();
+    }
+
+  }
+});
+export default (() => register(store));

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

@@ -0,0 +1,17 @@
+/**
+ * WordPress dependencies.
+ */
+import { useSelect } from '@wordpress/data';
+/**
+ * Internal dependencies
+ */
+
+import { WIZARD_STORE_NAMESPACE } from '.';
+export const createAction = type => payload => ({
+  type,
+  payload
+});
+export const useWizardData = function (wizardName) {
+  let defaultValue = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return useSelect(select => select(WIZARD_STORE_NAMESPACE).getWizardAPIData(`newspack-${wizardName}-wizard`)) || defaultValue;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "newspack-components",
-	"version": "2.0.3",
+	"version": "2.1.0",
 	"description": "Newspack design system components",
 	"author": "Automattic",
 	"license": "GPL-2.0-or-later",

package/shared/scss/_colors.scss

@@ -1,3 +1,4 @@
+// HEX
 $primary-000: #f5fdff;
 $primary-050: #d6f6ff;
 $primary-100: #b4e4ff;
@@ -10,3 +11,17 @@ $primary-700: #1522af;
 $primary-800: #0b0b8d;
 $primary-900: #0d046e;
 $primary-950: #0e0052;
+
+// RGB
+$primary-000--rgb: 245, 253, 255;
+$primary-050--rgb: 214, 246, 255;
+$primary-100--rgb: 180, 228, 255;
+$primary-200--rgb: 147, 204, 253;
+$primary-300--rgb: 114, 175, 251;
+$primary-400--rgb: 82, 141, 252;
+$primary-500--rgb: 51, 102, 255;
+$primary-600--rgb: 34, 64, 213;
+$primary-700--rgb: 21, 34, 175;
+$primary-800--rgb: 11, 11, 141;
+$primary-900--rgb: 13, 4, 110;
+$primary-950--rgb: 14, 0, 82;

package/src/action-card/index.js

@@ -6,13 +6,13 @@
  * WordPress dependencies
  */
 import { Component } from '@wordpress/element';
-import { ExternalLink } from '@wordpress/components';
+import { ExternalLink, ToggleControl } from '@wordpress/components';
 import { Icon, check } from '@wordpress/icons';
 
 /**
  * Internal dependencies
  */
-import { Button, Card, Handoff, Notice, ToggleControl, Waiting } from '../';
+import { Button, Card, Grid, Handoff, Notice, Waiting } from '../';
 import './style.scss';
 
 /**
@@ -46,8 +46,10 @@ class ActionCard extends Component {
 			actionContent,
 			actionText,
 			secondaryActionText,
+			secondaryDestructive,
 			image,
 			imageLink,
+			indent,
 			isSmall,
 			isMedium,
 			simple,
@@ -58,6 +60,7 @@ class ActionCard extends Component {
 			toggleChecked,
 			toggleOnChange,
 			hasGreyHeader,
+			isPending,
 		} = this.props;
 		const hasChildren = notification || children;
 		const classes = classnames(
@@ -65,6 +68,7 @@ class ActionCard extends Component {
 			simple && 'newspack-card--is-clickable',
 			hasGreyHeader && 'newspack-card--has-grey-header',
 			hasChildren && 'newspack-card--has-children',
+			indent && 'newspack-card--indent',
 			isSmall && 'is-small',
 			isMedium && 'is-medium',
 			className
@@ -102,7 +106,8 @@ class ActionCard extends Component {
 								className={ classnames(
 									'newspack-checkbox-icon',
 									'is-primary',
-									'checked' === checkbox && 'newspack-checkbox-icon--checked'
+									'checked' === checkbox && 'newspack-checkbox-icon--checked',
+									isPending && 'newspack-checkbox-icon--pending'
 								) }
 							>
 								{ 'checked' === checkbox && <Icon icon={ check } /> }
@@ -110,21 +115,25 @@ class ActionCard extends Component {
 						</div>
 					) }
 					<div className="newspack-action-card__region newspack-action-card__region-center">
-						<h2>
-							<span className="newspack-action-card__title" { ...titleProps }>
-								{ titleLink ? <a href={ titleLink }>{ title }</a> : title }
-							</span>
-							{ badges?.length &&
-								badges.map( ( badgeText, i ) => (
-									<span key={ `badge-${ i }` } className="newspack-action-card__badge">
-										{ badgeText }
-									</span>
-								) ) }
-						</h2>
-						<p>
-							{ typeof description === 'string' && description }
-							{ typeof description === 'function' && description() }
-						</p>
+						<Grid columns={ 1 } gutter={ 8 } noMargin>
+							<h2>
+								<span className="newspack-action-card__title" { ...titleProps }>
+									{ titleLink ? <a href={ titleLink }>{ title }</a> : title }
+								</span>
+								{ badges?.length &&
+									badges.map( ( badgeText, i ) => (
+										<span key={ `badge-${ i }` } className="newspack-action-card__badge">
+											{ badgeText }
+										</span>
+									) ) }
+							</h2>
+							{ description && (
+								<p>
+									{ typeof description === 'string' && description }
+									{ typeof description === 'function' && description() }
+								</p>
+							) }
+						</Grid>
 					</div>
 					{ ( actionText || isDisplayingSecondaryAction || actionContent ) && (
 						<div className="newspack-action-card__region newspack-action-card__region-right">
@@ -160,6 +169,7 @@ class ActionCard extends Component {
 									isLink
 									onClick={ onSecondaryActionClick }
 									className="newspack-action-card__secondary_button"
+									isDestructive={ secondaryDestructive }
 								>
 									{ secondaryActionText }
 								</Button>

package/src/action-card/style.scss

@@ -3,7 +3,6 @@
  */
 
 @import '~@wordpress/base-styles/colors';
-@import '../../../shared/scss/colors';
 
 .newspack-card.newspack-action-card {
 	padding: 0;
@@ -34,7 +33,7 @@
 	}
 
 	&.newspack-card__is-primary {
-		box-shadow: inset 4px 0 0 $primary-500;
+		box-shadow: inset 4px 0 0 var( --wp-admin-theme-color );
 	}
 
 	&.newspack-card__is-secondary {
@@ -150,20 +149,49 @@
 
 	&.newspack-card--has-grey-header {
 		overflow: hidden;
+
 		&.newspack-card--has-children {
 			.newspack-action-card__region-top {
 				border-bottom: 1px solid $gray-300;
 			}
 		}
+
 		.newspack-action-card__region-top {
-			background-color: $gray-100;
+			background-color: rgba( black, 0.025 );
+		}
+
+		.newspack-action-card__region-center {
+			p {
+				color: darken( $gray-700, 0.75% );
+			}
+		}
+	}
+
+	// Indent
+
+	&.newspack-card--indent {
+		margin-left: 56px;
+		position: relative;
+
+		&::before {
+			border: 0 solid $gray-300;
+			border-left-width: 1px;
+			border-bottom-width: 1px;
+			border-radius: 0 0 0 2px;
+			bottom: 50%;
+			content: '';
+			display: block;
+			left: -28px;
+			position: absolute;
+			right: 100%;
+			top: -17px;
 		}
 	}
 
 	// Typography
 
 	h2,
-	p {
+	p:not( [class*='components-base-control'] ) {
 		margin: 0;
 		max-width: 100%;
 		width: 100%;
@@ -186,7 +214,7 @@
 			&:active,
 			&:focus,
 			&:hover {
-				color: $primary-500;
+				color: var( --wp-admin-theme-color );
 			}
 		}
 	}
@@ -270,6 +298,14 @@
 		align-items: flex-start;
 		flex: 1 1 auto;
 		flex-wrap: wrap;
+
+		.newspack-grid {
+			width: 100%;
+		}
+
+		p {
+			color: $gray-700;
+		}
 	}
 
 	.newspack-action-card__region-right {
@@ -289,6 +325,10 @@
 		> * {
 			text-align: inherit;
 		}
+
+		.newspack-action-card__secondary_button {
+			margin-top: 8px;
+		}
 	}
 
 	// Waiting
@@ -326,34 +366,19 @@
 		margin: 0;
 	}
 
-	// Buttons
-
-	.newspack-button {
-		&.newspack-action-card__secondary_button {
-			&.is-link {
-				color: $alert-red;
-
-				&:active,
-				&:focus,
-				&:hover {
-					color: darken( $alert-red, 20% );
-				}
-			}
-		}
-	}
-
 	// Badge
 
 	.newspack-action-card__badge {
-		border: 1px solid $gray-300;
-		border-radius: 12px;
+		background: $gray-100;
+		border-radius: 2px;
+		color: $gray-900;
 		display: block;
 		flex: 0 0 auto;
-		font-size: 12px;
+		font-size: 10px;
 		font-weight: bold;
-		line-height: 16px;
-		margin: 3px 8px 3px 0;
-		padding: 0 8px;
+		line-height: 1.4;
+		margin: 0 8px 0 0;
+		padding: 2px 8px;
 		text-transform: uppercase;
 
 		+ .newspack-action-card__badge {

package/src/autocomplete-tokenfield/style.scss

@@ -2,16 +2,16 @@
  * Autocomplete Token Field
  */
 
-@import '../../../shared/scss/colors';
 @import '~@wordpress/base-styles/colors';
 
 .newspack-autocomplete-tokenfield {
 	position: relative;
 
 	.components-spinner {
+		margin: 8px;
 		position: absolute;
-		right: 1rem;
-		top: 1rem;
+		right: 0;
+		top: calc( 1.4em + 8px );
 	}
 
 	/* Workaround for hard-coded help text in FormTokenField. */
@@ -38,6 +38,6 @@
 	}
 
 	.components-button:focus:not( :disabled ) {
-		box-shadow: inset 0 0 0 2px $primary-500;
+		box-shadow: inset 0 0 0 var( --wp-admin-border-width-focus ) var( --wp-admin-theme-color );
 	}
 }