File size: 4,436 Bytes
1e92f2d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 | import { HelpCenterSelect } from '@automattic/data-stores';
import apiFetch from '@wordpress/api-fetch';
import { useSelect } from '@wordpress/data';
import { Action, Location } from 'history';
import { useState, useEffect, useLayoutEffect } from 'react';
import wpcomRequest, { canAccessWpcomApis } from 'wpcom-proxy-request';
import { HELP_CENTER_STORE } from '../stores';
export interface HistoryEvent {
action: Action;
location: Location;
}
/**
* This is a custom implementation of the MemoryHistory class from the history package.
* It is used to persist the navigation history of the help center.
* It persists the history to the server using user preferences.
*/
class MemoryHistory {
private entries: Location[] = [];
private index: number = -1;
private listeners: ( ( event: HistoryEvent ) => void )[] = [];
constructor(
initialEntries: Location[] = [
{ pathname: '/', search: '', hash: '', key: 'default', state: null },
],
initialIndex = 0
) {
this.entries = initialEntries;
this.index = initialIndex;
this.push = this.push.bind( this );
this.replace = this.replace.bind( this );
this.go = this.go.bind( this );
this.goBack = this.goBack.bind( this );
this.goForward = this.goForward.bind( this );
this.listen = this.listen.bind( this );
this.createLocation = this.createLocation.bind( this );
}
get length(): number {
return this.entries.length;
}
get action(): Action {
if ( this.index === 0 ) {
return Action.Pop;
}
if ( this.index === this.entries.length - 1 ) {
return Action.Push;
}
return Action.Replace;
}
get location(): Location {
return this.entries[ this.index ];
}
createHref( to: Location ): string {
return to.pathname + to.search + to.hash;
}
push( path: Location, state?: any ) {
const location = this.createLocation( path.pathname + path.search + path.hash, state );
this.entries = this.entries.slice( 0, this.index + 1 );
this.entries.push( location );
this.index++;
this.notifyListeners( Action.Push );
}
replace( path: string, state?: any ) {
const location = this.createLocation( path, state );
this.entries[ this.index ] = location;
this.notifyListeners( Action.Replace );
}
go( n: number ) {
const newIndex = this.index + n;
if ( newIndex >= 0 && newIndex < this.entries.length ) {
this.index = newIndex;
this.notifyListeners( Action.Pop );
}
}
goBack() {
this.go( -1 );
}
goForward() {
this.go( 1 );
}
listen( listener: ( event: HistoryEvent ) => void ) {
this.listeners.push( listener );
return () => {
this.listeners = this.listeners.filter( ( l ) => l !== listener );
};
}
private createLocation( path: string, state?: any ): Location {
const [ pathname, search = '', hash = '' ] = path.split( /[?#]/ );
return {
pathname,
search: search ? `?${ search }` : '',
hash: hash ? `#${ hash }` : '',
state,
key: crypto.randomUUID(),
};
}
private notifyListeners( action: Action ) {
const event = { action, location: this.location };
this.listeners.forEach( ( listener ) => listener( event ) );
if ( canAccessWpcomApis() ) {
wpcomRequest( {
path: '/me/preferences',
apiNamespace: 'wpcom/v2',
method: 'PUT',
body: {
calypso_preferences: {
help_center_router_history: { entries: this.entries, index: this.index },
},
},
} ).catch( () => {} );
} else {
apiFetch( {
global: true,
path: '/help-center/open-state',
method: 'PUT',
data: {
help_center_router_history: { entries: this.entries, index: this.index },
},
} as Parameters< typeof apiFetch >[ 0 ] ).catch( () => {} );
}
}
}
export const usePersistedHistory = () => {
const [ history, setHistory ] = useState< MemoryHistory >( new MemoryHistory() );
const [ state, setState ] = useState< HistoryEvent >( {
action: history.action,
location: history.location,
} );
const persistedHistory = useSelect(
( select ) => ( select( HELP_CENTER_STORE ) as HelpCenterSelect ).getHelpCenterRouterHistory(),
[]
);
useLayoutEffect( () => {
return history.listen( setState );
}, [ history ] );
useEffect( () => {
if ( persistedHistory ) {
const history = new MemoryHistory( persistedHistory.entries, persistedHistory.index );
setHistory( history );
setState( {
action: history.action,
location: history.location,
} );
}
}, [ persistedHistory ] );
return { history, state };
};
|