UNPKG

undo-redo-vuex

Version:

A Vuex plugin for module namespaced undo and redo functionality. This plugin takes inspiration from and extends the work of [vuex-undo-redo](https://github.com/anthonygore/vuex-undo-redo).

390 lines (389 loc) 11.4 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for src/undo.ts</title> <meta charset="utf-8" /> <link rel="stylesheet" href="../prettify.css" /> <link rel="stylesheet" href="../base.css" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <style type='text/css'> .coverage-summary .sorter { background-image: url(../sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1> <a href="../index.html">All files</a> / <a href="index.html">src</a> undo.ts </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Statements</span> <span class='fraction'>32/32</span> </div> <div class='fl pad1y space-right2'> <span class="strong">83.33% </span> <span class="quiet">Branches</span> <span class='fraction'>15/18</span> </div> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Functions</span> <span class='fraction'>5/5</span> </div> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Lines</span> <span class='fraction'>31/31</span> </div> </div> </div> <div class='status-line high'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">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</td><td class="line-coverage quiet"><span class="cline-any cline-yes">5x</span> <span class="cline-any cline-yes">5x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">5x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">51x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-yes">36x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">20x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">16x</span> <span class="cline-any cline-yes">16x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">16x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">16x</span> <span class="cline-any cline-yes">16x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">51x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">24x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-yes">27x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">27x</span> <span class="cline-any cline-yes">27x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { EMPTY_STATE } from "./constants"; import { getConfig, pipeActions, setConfig, updateCanUndoRedo } from "./utils-undo-redo"; &nbsp; /** * The Undo function - pushes the latest done mutation to the top of the undone * stack by popping the done stack and 'replays' all mutations in the done stack * * @module store/plugins/undoRedo:undo * @function */ export default ({ paths, store }: { paths: UndoRedoOptions[]; store: any; }) =&gt; async (namespace: string) =&gt; { const config = getConfig(paths)(namespace); &nbsp; <span class="missing-if-branch" title="else path not taken" >E</span>if (Object.keys(config).length) { /** * @var {Array} done - The updated done stack * @var {Array} commits - The list of mutations which are undone * NB: The reduceRight operation is used to identify the mutation(s) from the * top of the done stack to be undone */ const { done, commits } = config.done.reduceRight( ( { commits, done, proceed }: { commits: Array&lt;Mutation&gt; | []; done: Array&lt;Mutation&gt; | []; proceed: boolean; }, m: Mutation ) =&gt; { if (!commits.length) { // The "topmost" mutation from the done stack commits = [m]; // Do not find more mutations if the mutations does not belong to a group proceed = !!m.payload.actionGroup; } else if (!proceed) { // Unshift the mutation to the done stack done = [m, ...done]; } else { const lastUndone = commits[commits.length - 1]; const { actionGroup } = lastUndone.payload; // Unshift to commits if mutation belongs to the same actionGroup, // otherwise unshift to the done stack proceed = m.payload.actionGroup &amp;&amp; m.payload.actionGroup === actionGroup; commits = [...(proceed ? [m] : []), ...commits]; done = [...(proceed ? [] : [m]), ...done]; } &nbsp; return { done, commits, proceed }; }, { done: [], commits: [], proceed: true } ); &nbsp; // Check if there are any undo callback actions const undoCallbacks = commits.map(({ payload }: { payload: any }) =&gt; ({ action: payload.undoCallback ? `${namespace}${payload.undoCallback}` : "", payload })); await pipeActions(store)(undoCallbacks); &nbsp; const undone = [...config.undone, ...commits]; config.newMutation = false; store.commit(`${namespace}${EMPTY_STATE}`); const redoCallbacks = done.map(async (mutation: Mutation) =&gt; { store.commit( mutation.type, Array.isArray(mutation.payload) ? <span class="branch-0 cbranch-no" title="branch not covered" >[...mutation.payload]</span> : mutation.payload.constructor(mutation.payload) ); &nbsp; // Check if there is an undo callback action const { redoCallback } = mutation.payload; return { action: redoCallback ? <span class="branch-0 cbranch-no" title="branch not covered" >`${namespace}${redoCallback}` </span>: "", payload: mutation.payload }; }); await pipeActions(store)(await Promise.all(redoCallbacks)); config.newMutation = true; setConfig(paths)(namespace, { ...config, done, undone }); &nbsp; updateCanUndoRedo({ paths, store })(namespace); } }; &nbsp;</pre></td></tr> </table></pre> <div class='push'></div><!-- for sticky footer --> </div><!-- /wrapper --> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Tue Aug 13 2019 14:19:58 GMT+0200 (Central European Summer Time) </div> </div> <script src="../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../sorter.js"></script> </body> </html>