woocommerce/plugins/woocommerce-admin/client/customize-store/assembler-hub/sidebar/save-hub.tsx

241 lines
6.0 KiB
TypeScript
Raw Normal View History

// Reference: https://github.com/WordPress/gutenberg/blob/v16.4.0/packages/edit-site/src/components/save-hub/index.js
/* eslint-disable @woocommerce/dependency-group */
/* eslint-disable @typescript-eslint/ban-ts-comment */
/**
* External dependencies
*/
import { useContext, useEffect, useState } from '@wordpress/element';
import { useQuery } from '@woocommerce/navigation';
import { useSelect, useDispatch } from '@wordpress/data';
import {
// @ts-ignore No types for this exist yet.
__experimentalHStack as HStack,
Button,
Spinner,
} from '@wordpress/components';
import { __ } from '@wordpress/i18n';
// @ts-ignore No types for this exist yet.
import { store as coreStore } from '@wordpress/core-data';
// @ts-ignore No types for this exist yet.
import { store as blockEditorStore } from '@wordpress/block-editor';
// @ts-ignore No types for this exist yet.
import { store as noticesStore } from '@wordpress/notices';
// @ts-ignore No types for this exist yet.
import { useEntitiesSavedStatesIsDirty as useIsDirty } from '@wordpress/editor';
import { recordEvent } from '@woocommerce/tracks';
/**
* Internal dependencies
*/
import { CustomizeStoreContext } from '../';
const PUBLISH_ON_SAVE_ENTITIES = [
{
kind: 'postType',
name: 'wp_navigation',
},
];
export const SaveHub = () => {
const saveNoticeId = 'site-edit-save-notice';
const urlParams = useQuery();
const { sendEvent } = useContext( CustomizeStoreContext );
const [ isResolving, setIsResolving ] = useState< boolean >( false );
// @ts-ignore No types for this exist yet.
const { __unstableMarkLastChangeAsPersistent } =
useDispatch( blockEditorStore );
const { createSuccessNotice, createErrorNotice, removeNotice } =
useDispatch( noticesStore );
const {
dirtyEntityRecords,
isDirty,
}: {
dirtyEntityRecords: {
key?: string | number;
kind: string;
name: string;
property?: string;
title: string;
}[];
isDirty: boolean;
} = useIsDirty();
const { isSaving } = useSelect(
( select ) => {
return {
isSaving: dirtyEntityRecords.some( ( record ) =>
// @ts-ignore No types for this exist yet.
select( coreStore ).isSavingEntityRecord(
record.kind,
record.name,
record.key
)
),
};
},
[ dirtyEntityRecords ]
);
const {
// @ts-ignore No types for this exist yet.
editEntityRecord,
// @ts-ignore No types for this exist yet.
saveEditedEntityRecord,
// @ts-ignore No types for this exist yet.
__experimentalSaveSpecifiedEntityEdits: saveSpecifiedEntityEdits,
} = useDispatch( coreStore );
useEffect( () => {
dirtyEntityRecords.forEach( ( entity ) => {
/* This is a hack to reset the entity record when the user navigates away from editing page to main page.
This is needed because Gutenberg does not provide a way to reset the entity record. Replace this when we have a better way to do this.
We will need to add different conditions here when we implement editing for other entities.
*/
if (
entity.kind === 'root' &&
entity.name === 'site' &&
entity.property
) {
// Reset site icon edit
editEntityRecord(
'root',
'site',
undefined,
{
[ entity.property ]: undefined,
},
{ undoIgnore: true }
);
} else if (
entity.kind === 'root' &&
entity.name === 'globalStyles'
) {
editEntityRecord(
entity.kind,
entity.name,
entity.key,
{
styles: undefined,
settings: undefined,
},
{ undoIgnore: true }
);
} else {
editEntityRecord(
entity.kind,
entity.name,
entity.key,
{
selection: undefined,
blocks: undefined,
content: undefined,
},
{ undoIgnore: true }
);
}
} );
// Only run when path changes.
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [ urlParams.path ] );
const save = async () => {
const source = `${ urlParams.path.replace(
'/customize-store/assembler-hub/',
''
) }`;
recordEvent( 'customize_your_store_assembler_hub_save_click', {
source,
} );
removeNotice( saveNoticeId );
try {
for ( const { kind, name, key, property } of dirtyEntityRecords ) {
if ( kind === 'root' && name === 'site' ) {
await saveSpecifiedEntityEdits( 'root', 'site', undefined, [
property,
] );
} else {
if (
PUBLISH_ON_SAVE_ENTITIES.some(
( typeToPublish ) =>
typeToPublish.kind === kind &&
typeToPublish.name === name
)
) {
editEntityRecord( kind, name, key, {
status: 'publish',
} );
}
await saveEditedEntityRecord( kind, name, key );
__unstableMarkLastChangeAsPersistent();
}
}
createSuccessNotice( __( 'Site updated.', 'woocommerce' ), {
type: 'snackbar',
id: saveNoticeId,
} );
} catch ( error ) {
createErrorNotice(
`${ __( 'Saving failed.', 'woocommerce' ) } ${ error }`
);
}
};
const renderButton = () => {
if ( urlParams.path === '/customize-store/assembler-hub' ) {
return (
<Button
variant="primary"
onClick={ () => {
recordEvent(
'customize_your_store_assembler_hub_done_click'
);
setIsResolving( true );
sendEvent( 'FINISH_CUSTOMIZATION' );
} }
className="edit-site-save-hub__button"
// @ts-ignore No types for this exist yet.
__next40pxDefaultSize
>
{ isResolving ? <Spinner /> : __( 'Done', 'woocommerce' ) }
</Button>
);
}
// if we have only one unsaved change and it matches current context, we can show a more specific label
const label = isSaving
? __( 'Saving', 'woocommerce' )
: __( 'Save', 'woocommerce' );
const isDisabled = ! isDirty || isSaving;
return (
<Button
variant="primary"
onClick={ save }
isBusy={ isSaving }
disabled={ isDisabled }
aria-disabled={ isDisabled }
className="edit-site-save-hub__button"
// @ts-ignore No types for this exist yet.
__next40pxDefaultSize
>
{ label }
</Button>
);
};
return (
<HStack className="edit-site-save-hub" alignment="right" spacing={ 4 }>
{ renderButton() }
</HStack>
);
};