diff --git a/lib/experimental/content-guidelines/class-gutenberg-content-guidelines-post-type.php b/lib/experimental/content-guidelines/class-gutenberg-content-guidelines-post-type.php index 4b281db11bbce6..6758498bee6071 100644 --- a/lib/experimental/content-guidelines/class-gutenberg-content-guidelines-post-type.php +++ b/lib/experimental/content-guidelines/class-gutenberg-content-guidelines-post-type.php @@ -71,8 +71,8 @@ class Gutenberg_Content_Guidelines_Post_Type { public static function register() { $args = array( 'labels' => array( - 'name' => __( 'Content Guidelines', 'gutenberg' ), - 'singular_name' => __( 'Content Guidelines', 'gutenberg' ), + 'name' => __( 'Guidelines', 'gutenberg' ), + 'singular_name' => __( 'Guidelines', 'gutenberg' ), ), 'public' => false, 'publicly_queryable' => false, diff --git a/lib/experimental/content-guidelines/class-gutenberg-content-guidelines-rest-controller.php b/lib/experimental/content-guidelines/class-gutenberg-content-guidelines-rest-controller.php index f1d65ba4cf40fc..03d502f4001c21 100644 --- a/lib/experimental/content-guidelines/class-gutenberg-content-guidelines-rest-controller.php +++ b/lib/experimental/content-guidelines/class-gutenberg-content-guidelines-rest-controller.php @@ -111,7 +111,7 @@ public function get_guidelines_permissions_check( $request ) { // phpcs:ignore V if ( ! current_user_can( $post_type->cap->read ) ) { return new WP_Error( 'rest_forbidden', - __( 'Sorry, you are not allowed to view content guidelines.', 'gutenberg' ), + __( 'Sorry, you are not allowed to view the guidelines.', 'gutenberg' ), array( 'status' => rest_authorization_required_code() ) ); } @@ -161,14 +161,14 @@ public function create_item( $request ) { if ( $existing ) { return new WP_Error( 'rest_guidelines_exists', - __( 'Content guidelines already exist. Use PATCH to update.', 'gutenberg' ), + __( 'Guidelines already exist. Use PATCH to update.', 'gutenberg' ), array( 'status' => 400 ) ); } $prepared = $this->prepare_item_for_database( $request ); $prepared->post_type = $this->post_type; - $prepared->post_title = __( 'Content Guidelines', 'gutenberg' ); + $prepared->post_title = __( 'Guidelines', 'gutenberg' ); if ( ! isset( $prepared->post_status ) ) { $prepared->post_status = 'draft'; diff --git a/lib/experimental/content-guidelines/class-gutenberg-content-guidelines-revisions-controller.php b/lib/experimental/content-guidelines/class-gutenberg-content-guidelines-revisions-controller.php index a77e0bfcb2120f..4045f77eefe7e2 100644 --- a/lib/experimental/content-guidelines/class-gutenberg-content-guidelines-revisions-controller.php +++ b/lib/experimental/content-guidelines/class-gutenberg-content-guidelines-revisions-controller.php @@ -103,6 +103,15 @@ public function prepare_item_for_response( $item, $request ) { $response->set_data( $data ); } + // Add embeddable author link to get author name in revision history screen + if ( ! empty( $item->post_author ) ) { + $response->add_link( + 'author', + rest_url( 'wp/v2/users/' . $item->post_author ), + array( 'embeddable' => true ) + ); + } + return $response; } @@ -137,7 +146,7 @@ public function restore_revision_permissions_check( $request ) { if ( ! $parent || $this->parent_post_type !== $parent->post_type ) { return new WP_Error( 'rest_post_not_found', - __( 'Content guidelines not found.', 'gutenberg' ), + __( 'Guidelines not found.', 'gutenberg' ), array( 'status' => 404 ) ); } @@ -169,7 +178,7 @@ public function restore_revision( $request ) { if ( ! $parent || $this->parent_post_type !== $parent->post_type ) { return new WP_Error( 'rest_post_not_found', - __( 'Content guidelines not found.', 'gutenberg' ), + __( 'Guidelines not found.', 'gutenberg' ), array( 'status' => 404 ) ); } diff --git a/lib/experimental/content-guidelines/load.php b/lib/experimental/content-guidelines/load.php index e72f17eb4e42da..10447caf00c1a4 100644 --- a/lib/experimental/content-guidelines/load.php +++ b/lib/experimental/content-guidelines/load.php @@ -15,8 +15,8 @@ function gutenberg_register_content_guidelines_settings_submenu() { add_submenu_page( 'options-general.php', - __( 'Content Guidelines', 'gutenberg' ), - __( 'Content Guidelines', 'gutenberg' ), + __( 'Guidelines', 'gutenberg' ), + __( 'Guidelines', 'gutenberg' ), 'manage_options', 'content-guidelines-wp-admin', 'gutenberg_content_guidelines_wp_admin_render_page' diff --git a/lib/experiments-page.php b/lib/experiments-page.php index 99baa773955adf..c42e758ca02713 100644 --- a/lib/experiments-page.php +++ b/lib/experiments-page.php @@ -211,12 +211,12 @@ function gutenberg_initialize_experiments_settings() { add_settings_field( 'gutenberg-content-guidelines', - __( 'Content Guidelines', 'gutenberg' ), + __( 'Guidelines', 'gutenberg' ), 'gutenberg_display_experiment_field', 'gutenberg-experiments', 'gutenberg_experiments_section', array( - 'label' => __( 'Enables Content Guidelines feature for managing editorial voice and tone guidelines under Settings.', 'gutenberg' ), + 'label' => __( 'Enables guidelines feature for managing editorial voice and tone guidelines under Settings.', 'gutenberg' ), 'id' => 'gutenberg-content-guidelines', ) ); diff --git a/package-lock.json b/package-lock.json index f4b34748741872..f048abcce4b29a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -62987,11 +62987,13 @@ "@wordpress/admin-ui": "file:../../packages/admin-ui", "@wordpress/api-fetch": "file:../../packages/api-fetch", "@wordpress/base-styles": "file:../../packages/base-styles", + "@wordpress/blob": "file:../../packages/blob", "@wordpress/block-library": "file:../../packages/block-library", "@wordpress/blocks": "file:../../packages/blocks", "@wordpress/components": "file:../../packages/components", "@wordpress/data": "file:../../packages/data", "@wordpress/dataviews": "file:../../packages/dataviews", + "@wordpress/date": "file:../../packages/date", "@wordpress/element": "file:../../packages/element", "@wordpress/i18n": "file:../../packages/i18n", "@wordpress/icons": "file:../../packages/icons", diff --git a/routes/content-guidelines/api.ts b/routes/content-guidelines/api.ts index 32f38a5a010030..6e2b97af99b27c 100644 --- a/routes/content-guidelines/api.ts +++ b/routes/content-guidelines/api.ts @@ -2,13 +2,36 @@ * WordPress dependencies */ import apiFetch from '@wordpress/api-fetch'; +import { downloadBlob } from '@wordpress/blob'; import { dispatch, select } from '@wordpress/data'; +import { __ } from '@wordpress/i18n'; +import { store as noticesStore } from '@wordpress/notices'; /** * Internal dependencies */ import { STORE_NAME } from './store'; -import type { Categories, RestGuidelinesResponse } from './types'; +import type { + Categories, + RestGuidelinesResponse, + GuidelinesImportData, + ContentGuidelinesRevision, +} from './types'; + +const FLAT_CATEGORIES = [ 'site', 'copy', 'images', 'additional' ] as const; + +function isValidGuidelinesImport( + data: unknown +): data is GuidelinesImportData { + return ( + !! data && + typeof data === 'object' && + 'guideline_categories' in data && + typeof ( data as Record< string, unknown > ).guideline_categories === + 'object' && + ( data as Record< string, unknown > ).guideline_categories !== null + ); +} export async function fetchContentGuidelines(): Promise< RestGuidelinesResponse > { const { setFromResponse } = dispatch( STORE_NAME ) as { @@ -83,3 +106,164 @@ export async function saveContentGuidelines(): Promise< RestGuidelinesResponse > return response; } + +/** + * Opens file selector, reads the selected file and imports the content guidelines. + * @param file Content Guidelines JSON file + */ +export async function importContentGuidelines( file: File ): Promise< void > { + // @ts-ignore + const { setGuideline, setBlockGuideline } = dispatch( STORE_NAME ); + const { createSuccessNotice } = dispatch( noticesStore ); + + const parsed: unknown = JSON.parse( await file.text() ); + + if ( ! isValidGuidelinesImport( parsed ) ) { + throw new Error( + __( + 'Check that your file contains valid JSON markup and try again.' + ) + ); + } + + const guidelinesStore = select( STORE_NAME ) as unknown as { + getAllGuidelines: () => Categories; + getBlockGuidelines: () => Record< string, string >; + }; + const previousCategories = guidelinesStore.getAllGuidelines(); + const previousBlocks = { ...guidelinesStore.getBlockGuidelines() }; + + const { guideline_categories: contentGuidelinesCategories } = parsed; + + FLAT_CATEGORIES.forEach( ( guidelineCategory ) => { + const guidelines = + contentGuidelinesCategories[ guidelineCategory ]?.guidelines; + if ( typeof guidelines === 'string' ) { + setGuideline( guidelineCategory, guidelines ); + } + } ); + + const blocksData = contentGuidelinesCategories.blocks; + if ( blocksData && typeof blocksData === 'object' ) { + Object.entries( blocksData ).forEach( ( [ blockName, blockData ] ) => { + if ( blockData && typeof blockData.guidelines === 'string' ) { + setBlockGuideline( blockName, blockData.guidelines ); + } + } ); + } + + try { + await saveContentGuidelines(); + createSuccessNotice( __( 'Guidelines imported.' ), { + type: 'snackbar', + } ); + } catch ( error ) { + FLAT_CATEGORIES.forEach( ( cat ) => { + setGuideline( cat, previousCategories[ cat ] ?? '' ); + } ); + + const currentBlocks = guidelinesStore.getBlockGuidelines(); + Object.keys( currentBlocks ).forEach( ( blockName ) => + setBlockGuideline( blockName, '' ) + ); + Object.entries( previousBlocks ).forEach( ( [ blockName, value ] ) => + setBlockGuideline( blockName, value ) + ); + + throw error; + } +} + +/** + * Exports the content guidelines as a JSON file. + */ +export function exportContentGuidelines(): void { + const { createSuccessNotice } = dispatch( noticesStore ); + + const guidelinesStore = select( STORE_NAME ) as unknown as { + getAllGuidelines: () => Categories; + getBlockGuidelines: () => Record< string, string >; + }; + const contentGuidelinesCategories = guidelinesStore.getAllGuidelines(); + const blockGuidelines = guidelinesStore.getBlockGuidelines(); + + const data = { + guideline_categories: { + ...Object.fromEntries( + FLAT_CATEGORIES.map( ( guidelineCategory ) => [ + guidelineCategory, + { + guidelines: + contentGuidelinesCategories[ guidelineCategory ] ?? + '', + }, + ] ) + ), + blocks: Object.fromEntries( + Object.entries( blockGuidelines ).map( + ( [ blockName, guidelines ] ) => [ + blockName, + { guidelines }, + ] + ) + ), + }, + }; + + downloadBlob( + 'guidelines.json', + JSON.stringify( data, null, 2 ), + 'application/json' + ); + + createSuccessNotice( __( 'Guidelines exported.' ), { + type: 'snackbar', + } ); +} + +export async function fetchContentGuidelinesRevisions( { + guidelinesId, + page = 1, + perPage = 10, + search, +}: { + guidelinesId: number; + page?: number; + perPage?: number; + search?: string; +} ): Promise< { + revisions: ContentGuidelinesRevision[]; + total: number; + totalPages: number; +} > { + const params = new URLSearchParams( { + page: String( page ), + per_page: String( perPage ), + _embed: 'author', + ...( search ? { search } : {} ), + } ); + + const response = ( await apiFetch( { + path: `/wp/v2/content-guidelines/${ guidelinesId }/revisions?${ params }`, + parse: false, + } ) ) as Response; + + const revisions = ( await response.json() ) as ContentGuidelinesRevision[]; + const total = parseInt( response.headers.get( 'X-WP-Total' ) ?? '0', 10 ); + const totalPages = parseInt( + response.headers.get( 'X-WP-TotalPages' ) ?? '0', + 10 + ); + + return { revisions, total, totalPages }; +} + +export async function restoreContentGuidelinesRevision( + guidelinesId: number, + revisionId: number +): Promise< RestGuidelinesResponse > { + return ( await apiFetch( { + path: `/wp/v2/content-guidelines/${ guidelinesId }/revisions/${ revisionId }/restore`, + method: 'POST', + } ) ) as RestGuidelinesResponse; +} diff --git a/routes/content-guidelines/components/actions-section.tsx b/routes/content-guidelines/components/actions-section.tsx new file mode 100644 index 00000000000000..c2c681e48d1796 --- /dev/null +++ b/routes/content-guidelines/components/actions-section.tsx @@ -0,0 +1,252 @@ +/** + * WordPress dependencies + */ +import { + Button, + Card, + Modal, + useNavigator, + __experimentalText as Text, + __experimentalHeading as Heading, + __experimentalVStack as VStack, + __experimentalHStack as HStack, +} from '@wordpress/components'; +import { __, sprintf } from '@wordpress/i18n'; +import { useRef, useState } from '@wordpress/element'; +import { Notice } from '@wordpress/ui'; + +/** + * Internal dependencies + */ +import { importContentGuidelines, exportContentGuidelines } from '../api'; + +function getErrorMessage( error: unknown ): string { + if ( error instanceof Error ) { + return error.message; + } + if ( typeof error === 'object' && error !== null && 'message' in error ) { + return String( ( error as { message: unknown } ).message ); + } + return __( 'Unknown error.' ); +} + +const ACTIONS = [ + { + slug: 'import', + title: __( 'Import' ), + description: __( 'Upload a JSON file to import your guidelines.' ), + buttonLabel: __( 'Upload' ), + ariaLabel: __( 'Import guidelines' ), + }, + { + slug: 'export', + title: __( 'Export' ), + description: __( 'Export your guidelines to a JSON file.' ), + buttonLabel: __( 'Download' ), + ariaLabel: __( 'Export guidelines' ), + }, + { + slug: 'revert', + title: __( 'Revert' ), + description: __( 'Use a previous version of your guidelines.' ), + buttonLabel: __( 'View history' ), + ariaLabel: __( 'View history of guidelines' ), + }, +]; + +export default function ActionsSection() { + const { goTo } = useNavigator(); + const fileInputRef = useRef< HTMLInputElement >( null ); + const [ isImporting, setIsImporting ] = useState( false ); + const [ error, setError ] = useState< string | null >( null ); + const [ pendingImport, setPendingImport ] = useState< File | null >( null ); + + function handleImportClick() { + fileInputRef.current?.click(); + } + + function handleFileChange( event: React.ChangeEvent< HTMLInputElement > ) { + const file = event.target.files?.[ 0 ]; + event.target.value = ''; // allow re-selecting the same file + if ( ! file ) { + return; + } + setPendingImport( file ); + } + + async function handleModalContinue() { + if ( ! pendingImport ) { + return; + } + const file = pendingImport; + setPendingImport( null ); + setIsImporting( true ); + try { + await importContentGuidelines( file ); + setError( null ); + } catch ( importError ) { + setError( + sprintf( + /* translators: %s: Error message. */ + __( 'We ran into a problem importing your guidelines. %s' ), + getErrorMessage( importError ) + ) + ); + } finally { + setIsImporting( false ); + } + } + + async function handleExportClick() { + try { + exportContentGuidelines(); + setError( null ); + } catch ( exportError ) { + setError( + sprintf( + /* translators: %s: Error message. */ + __( 'We ran into a problem exporting your guidelines: %s' ), + getErrorMessage( exportError ) + ) + ); + } + } + + const buttonProps: Partial< + Record< + string, + { + onClick: () => void | Promise< void >; + isBusy?: boolean; + disabled?: boolean; + } + > + > = { + import: { + onClick: handleImportClick, + isBusy: isImporting, + disabled: isImporting || !! pendingImport, + }, + export: { onClick: handleExportClick }, + revert: { onClick: () => goTo( '/revision-history' ) }, + }; + + return ( + + + { __( 'Actions' ) } + + + { error && ( + + + { error } + + setError( null ) } /> + + ) } + + { /* + * Disable reason: The `list` ARIA role is redundant but + * Safari+VoiceOver won't announce the list otherwise. + */ + /* eslint-disable jsx-a11y/no-redundant-roles */ } + + { /* eslint-enable jsx-a11y/no-redundant-roles */ } + + { pendingImport && ( + setPendingImport( null ) } + size="medium" + > + + + { __( + 'Importing new guidelines will replace your current guidelines.' + ) } + + + { __( + 'This can be undone from revision history.' + ) } + + + + + + + + ) } + + ); +} diff --git a/routes/content-guidelines/components/block-guideline-modal.tsx b/routes/content-guidelines/components/block-guideline-modal.tsx index d3f649695dc34f..66897d0a55fdde 100644 --- a/routes/content-guidelines/components/block-guideline-modal.tsx +++ b/routes/content-guidelines/components/block-guideline-modal.tsx @@ -109,8 +109,8 @@ export default function BlockGuidelineModal( { setError( null ); createSuccessNotice( value - ? __( 'Block guideline saved.' ) - : __( 'Block guideline removed.' ), + ? __( 'Guidelines saved.' ) + : __( 'Guidelines removed.' ), { type: 'snackbar' } ); closeModal(); diff --git a/routes/content-guidelines/components/block-guidelines.tsx b/routes/content-guidelines/components/block-guidelines.tsx index 4416ac5e1429cd..c69ad8d5dda399 100644 --- a/routes/content-guidelines/components/block-guidelines.tsx +++ b/routes/content-guidelines/components/block-guidelines.tsx @@ -156,7 +156,7 @@ export default function BlockGuidelines() { saveContentGuidelines() .then( () => { setError( null ); - createSuccessNotice( __( 'Block guidelines removed.' ), { + createSuccessNotice( __( 'Guidelines removed.' ), { type: 'snackbar', } ); } ) diff --git a/routes/content-guidelines/components/guideline-accordion-form.tsx b/routes/content-guidelines/components/guideline-accordion-form.tsx index bf28046751a40e..0d64529d0c6c2d 100644 --- a/routes/content-guidelines/components/guideline-accordion-form.tsx +++ b/routes/content-guidelines/components/guideline-accordion-form.tsx @@ -80,7 +80,7 @@ export default function GuidelineAccordionForm( { saveContentGuidelines() .then( () => { setError( null ); - createSuccessNotice( __( 'Guideline category saved.' ), { + createSuccessNotice( __( 'Guidelines saved.' ), { type: 'snackbar', } ); } ) diff --git a/routes/content-guidelines/components/revision-history.tsx b/routes/content-guidelines/components/revision-history.tsx new file mode 100644 index 00000000000000..8c917b61f3b44b --- /dev/null +++ b/routes/content-guidelines/components/revision-history.tsx @@ -0,0 +1,270 @@ +/** + * WordPress dependencies + */ +import { + Button, + Modal, + Navigator, + __experimentalText as Text, + __experimentalVStack as VStack, + __experimentalHStack as HStack, +} from '@wordpress/components'; +import { DataViews, filterSortAndPaginate } from '@wordpress/dataviews'; +import { __, sprintf, isRTL } from '@wordpress/i18n'; +import { useEffect, useMemo, useState } from '@wordpress/element'; +import { useSelect, useDispatch } from '@wordpress/data'; +import { chevronLeft, chevronRight } from '@wordpress/icons'; +import { dateI18n, getDate, getSettings } from '@wordpress/date'; +import { store as noticesStore } from '@wordpress/notices'; +import type { View, Field, Action } from '@wordpress/dataviews'; + +/** + * Internal dependencies + */ +import { STORE_NAME } from '../store'; +import { + fetchContentGuidelinesRevisions, + restoreContentGuidelinesRevision, + fetchContentGuidelines, +} from '../api'; +import type { ContentGuidelinesRevision } from '../types'; + +const DEFAULT_VIEW: View = { + type: 'table' as const, + fields: [ 'date', 'author' ], + page: 1, + perPage: 10, + layout: { + enableMoving: false, + styles: { + author: { align: 'end' }, + }, + }, +}; + +export default function RevisionHistory() { + const [ view, setView ] = useState< View >( DEFAULT_VIEW ); + const [ revisions, setRevisions ] = useState< ContentGuidelinesRevision[] >( + [] + ); + const [ isLoading, setIsLoading ] = useState( false ); + const [ revisionToRestore, setRevisionToRestore ] = + useState< ContentGuidelinesRevision | null >( null ); + const [ isRestoring, setIsRestoring ] = useState( false ); + const [ refetchKey, setRefetchKey ] = useState( 0 ); + + const { createSuccessNotice, createErrorNotice } = + useDispatch( noticesStore ); + + const guidelinesId = useSelect( + ( select ) => + ( + select( STORE_NAME ) as unknown as { + getId: () => number | null; + } + ).getId(), + [] + ); + + useEffect( () => { + if ( ! guidelinesId ) { + return; + } + + async function loadRevisions() { + setIsLoading( true ); + try { + const result = await fetchContentGuidelinesRevisions( { + guidelinesId: guidelinesId!, + perPage: 100, + } ); + setRevisions( result.revisions ); + } catch { + createErrorNotice( + __( 'Could not load revision history. Please try again.' ), + { type: 'snackbar' } + ); + } finally { + setIsLoading( false ); + } + } + + loadRevisions(); + }, [ guidelinesId, refetchKey, createErrorNotice ] ); + + const authorElements = useMemo( () => { + return [ + ...new Set( + revisions.map( + ( r ) => r._embedded?.author?.[ 0 ]?.name ?? __( 'Unknown' ) + ) + ), + ].map( ( name ) => ( { value: name, label: name } ) ); + }, [ revisions ] ); + + const fields = useMemo< Field< ContentGuidelinesRevision >[] >( + () => [ + { + id: 'date', + type: 'date' as const, + label: __( 'Date' ), + getValue: ( { item } ) => item.date, + render: ( { item } ) => ( + + ), + enableSorting: false, + enableHiding: false, + filterBy: { + operators: [ 'before', 'after', 'between', 'inThePast' ], + }, + }, + { + id: 'author', + label: __( 'User' ), + getValue: ( { item } ) => + item._embedded?.author?.[ 0 ]?.name ?? __( 'Unknown' ), + render: ( { item } ) => ( + + { item._embedded?.author?.[ 0 ]?.name ?? + __( 'Unknown' ) } + + ), + enableSorting: false, + enableHiding: false, + enableGlobalSearch: true, + elements: authorElements, + filterBy: { + operators: [ 'isAny', 'isNone' ], + }, + }, + ], + [ authorElements ] + ); + + const { data: displayedRevisions, paginationInfo } = useMemo( + () => filterSortAndPaginate( revisions, view, fields ), + [ revisions, view, fields ] + ); + + const actions = useMemo< Action< ContentGuidelinesRevision >[] >( + () => [ + { + id: 'restore-revision', + label: __( 'Restore' ), + callback: ( items ) => setRevisionToRestore( items[ 0 ] ), + }, + ], + [ setRevisionToRestore ] + ); + + async function handleRestore() { + if ( ! guidelinesId || ! revisionToRestore ) { + return; + } + setIsRestoring( true ); + try { + await restoreContentGuidelinesRevision( + guidelinesId, + revisionToRestore.id + ); + await fetchContentGuidelines(); + setRevisionToRestore( null ); + setRefetchKey( ( k ) => k + 1 ); + createSuccessNotice( __( 'Revision restored.' ), { + type: 'snackbar', + } ); + } catch { + createErrorNotice( + __( 'Could not restore revision. Please try again.' ), + { type: 'snackbar' } + ); + } finally { + setIsRestoring( false ); + } + } + + return ( +
+ + { __( 'Revision history' ) } + + + + { __( 'Use a previous version of your guidelines.' ) } + + + String( item.id ) } + /> + + { revisionToRestore && ( + setRevisionToRestore( null ) } + size="medium" + > + + + { sprintf( + /* translators: %s: formatted revision date */ + __( + 'You are about to restore the guidelines from %s.' + ), + dateI18n( + getSettings().formats.datetimeAbbreviated, + getDate( revisionToRestore.date ) + ) + ) } + + + { __( + 'You can undo this anytime from revision history.' + ) } + + + + + + + + ) } +
+ ); +} diff --git a/routes/content-guidelines/package.json b/routes/content-guidelines/package.json index e41acb5e809101..edc0ffbed29d9d 100644 --- a/routes/content-guidelines/package.json +++ b/routes/content-guidelines/package.json @@ -11,9 +11,11 @@ "dependencies": { "@wordpress/admin-ui": "file:../../packages/admin-ui", "@wordpress/api-fetch": "file:../../packages/api-fetch", + "@wordpress/blob": "file:../../packages/blob", "@wordpress/base-styles": "file:../../packages/base-styles", "@wordpress/components": "file:../../packages/components", "@wordpress/data": "file:../../packages/data", + "@wordpress/date": "file:../../packages/date", "@wordpress/element": "file:../../packages/element", "@wordpress/i18n": "file:../../packages/i18n", "@wordpress/icons": "file:../../packages/icons", diff --git a/routes/content-guidelines/route.ts b/routes/content-guidelines/route.ts index 9c005bb96f646b..d901ef978291a4 100644 --- a/routes/content-guidelines/route.ts +++ b/routes/content-guidelines/route.ts @@ -10,5 +10,5 @@ import { bootstrapBlockRegistry } from './bootstrap-block-registry'; export const route = { beforeLoad: bootstrapBlockRegistry, - title: () => __( 'Content Guidelines' ), + title: () => __( 'Guidelines' ), }; diff --git a/routes/content-guidelines/stage.tsx b/routes/content-guidelines/stage.tsx index e418423cfe62a4..cca018a139f191 100644 --- a/routes/content-guidelines/stage.tsx +++ b/routes/content-guidelines/stage.tsx @@ -6,7 +6,11 @@ import { Page } from '@wordpress/admin-ui'; import { __, sprintf } from '@wordpress/i18n'; import { createElement, useEffect, useState } from '@wordpress/element'; -import { Spinner } from '@wordpress/components'; +import { + Spinner, + Navigator, + __experimentalVStack as VStack, +} from '@wordpress/components'; import { Notice } from '@wordpress/ui'; /** @@ -17,6 +21,8 @@ import GuidelineAccordion from './components/guideline-accordion'; import GuidelineAccordionForm from './components/guideline-accordion-form'; import { fetchContentGuidelines } from './api'; import BlockGuidelines from './components/block-guidelines'; +import ActionsSection from './components/actions-section'; +import RevisionHistory from './components/revision-history'; const GUIDELINE_ITEMS = [ { @@ -72,7 +78,7 @@ function ContentGuidelinesPage() { return ( { sprintf( /* translators: %s: Error message. */ - __( 'Error loading content guidelines: %s' ), + __( 'Error loading guidelines: %s' ), error ) } @@ -101,51 +107,73 @@ function ContentGuidelinesPage() { ) : ( ! error && ( -
- { /* - * Disable reason: The `list` ARIA role is redundant but - * Safari+VoiceOver won't announce the list otherwise. - */ - /* eslint-disable jsx-a11y/no-redundant-roles */ } -
+ > + { item.slug === + 'blocks' ? ( + + ) : ( + + ) } + + + + ); + } ) } + + { /* eslint-enable jsx-a11y/no-redundant-roles */ } + + + + + + + ) ) }
diff --git a/routes/content-guidelines/style.scss b/routes/content-guidelines/style.scss index 5fbd80103f250d..b21a97539ad3b6 100644 --- a/routes/content-guidelines/style.scss +++ b/routes/content-guidelines/style.scss @@ -1,3 +1,4 @@ +@use "sass:color"; @use "@wordpress/base-styles/colors" as *; @use "@wordpress/base-styles/variables" as *; @@ -27,3 +28,114 @@ align-items: center; margin-top: $grid-unit-20; } + +.content-guidelines__actions-notice { + border: none; + border-left: 4px solid $alert-yellow; + background-color: color.adjust($alert-yellow, $lightness: +35%); + border-radius: 0; +} + +.content-guidelines__actions-notice-title { + font-size: 13px; + font-weight: 400; +} + +.content-guidelines__actions { + width: min(680px, 100%); + margin: $grid-unit-20 auto 0; +} + +.content-guidelines__actions-card { + padding: 0; + overflow: hidden; +} + +.content-guidelines__actions-list { + list-style: none; + padding: 0; + margin: 0; +} + +.content-guidelines__action-list-item { + margin-bottom: 0; + position: relative; + + &:not(:first-child)::before { + content: ""; + position: absolute; + top: 0; + left: $grid-unit-30; + right: $grid-unit-30; + height: 1px; + background-color: $gray-100; + } +} + +.content-guidelines__action-row { + padding: $grid-unit-20 $grid-unit-30; + align-items: center; + width: 100%; + box-sizing: border-box; +} + +.content-guidelines__actions-card .content-guidelines__action-button { + min-width: 100px; + justify-content: center; + font-size: 13px; + font-weight: 400; +} + +.content-guidelines__action-title { + color: $gray-900; +} + +.content-guidelines__action-description { + color: $gray-700; +} + +.content-guidelines__revision-history { + padding: $grid-unit-30; + display: flex; + flex-direction: column; + gap: $grid-unit-20; + .dataviews__view-actions, + .dataviews-filters__container { + padding-left: $grid-unit-10; + padding-right: $grid-unit-10; + } + + .dataviews-view-table { + td:first-child { + padding-left: $grid-unit-10; + } + + td { + padding: $grid-unit-20 $grid-unit-10; + } + + thead th:has(.dataviews-view-table-header-button):first-child { + padding-left: 0; + } + + .dataviews-view-table__cell-content-wrapper { + max-width: 100%; + } + } +} + +.content-guidelines__revision-history-back { + align-self: flex-start; + margin-left: -$grid-unit-10; + font-weight: 500; + color: $gray-900; +} + +.content-guidelines__revision-description { + padding-left: $grid-unit-10; +} + +.content-guidelines__restore-modal-actions, +.content-guidelines__import-modal-actions { + margin-top: $grid-unit-30; +} diff --git a/routes/content-guidelines/types.ts b/routes/content-guidelines/types.ts index cca251c8b1b34f..140b49b515776c 100644 --- a/routes/content-guidelines/types.ts +++ b/routes/content-guidelines/types.ts @@ -28,6 +28,16 @@ export interface RestGuidelinesResponse { guideline_categories?: Record< string, BlockGuideline >; } +export interface GuidelinesImportData { + guideline_categories: { + site?: { guidelines?: string }; + copy?: { guidelines?: string }; + images?: { guidelines?: string }; + additional?: { guidelines?: string }; + blocks?: Record< string, { guidelines?: string } >; + }; +} + export interface GuidelineAccordionProps { title: string; description: string; @@ -37,6 +47,15 @@ export interface GuidelineAccordionProps { descriptionId?: string; } +export interface ContentGuidelinesRevision { + id: number; + date: string; + author: number; + _embedded?: { + author: Array< { name: string } >; + }; +} + export interface GuidelineAccordionFormProps { slug: string; contentId?: string; // Used for a11y.