]> git.sesse.net Git - remoteglot/blob - www/js/chessboard-0.3.0.js
Add a Firefox workaround for animations.
[remoteglot] / www / js / chessboard-0.3.0.js
1 /*!
2  * chessboard.js v0.3.0+asn
3  *
4  * Copyright 2013 Chris Oakman
5  * Portions copyright 2022 Steinar H. Gunderson
6  * Released under the MIT license
7  * http://chessboardjs.com/license
8  *
9  * Date: 10 Aug 2013
10  */
11
12 // start anonymous scope
13 ;(function() {
14 'use strict';
15
16 //------------------------------------------------------------------------------
17 // Chess Util Functions
18 //------------------------------------------------------------------------------
19 var COLUMNS = 'abcdefgh'.split('');
20
21 function validMove(move) {
22   // move should be a string
23   if (typeof move !== 'string') return false;
24
25   // move should be in the form of "e2-e4", "f6-d5"
26   var tmp = move.split('-');
27   if (tmp.length !== 2) return false;
28
29   return (validSquare(tmp[0]) === true && validSquare(tmp[1]) === true);
30 }
31
32 function validSquare(square) {
33   if (typeof square !== 'string') return false;
34   return (square.search(/^[a-h][1-8]$/) !== -1);
35 }
36
37 function validPieceCode(code) {
38   if (typeof code !== 'string') return false;
39   return (code.search(/^[bw][KQRNBP]$/) !== -1);
40 }
41
42 // TODO: this whole function could probably be replaced with a single regex
43 function validFen(fen) {
44   if (typeof fen !== 'string') return false;
45
46   // cut off any move, castling, etc info from the end
47   // we're only interested in position information
48   fen = fen.replace(/ .+$/, '');
49
50   // FEN should be 8 sections separated by slashes
51   var chunks = fen.split('/');
52   if (chunks.length !== 8) return false;
53
54   // check the piece sections
55   for (var i = 0; i < 8; i++) {
56     if (chunks[i] === '' ||
57         chunks[i].length > 8 ||
58         chunks[i].search(/[^kqrbnpKQRNBP1-8]/) !== -1) {
59       return false;
60     }
61   }
62
63   return true;
64 }
65
66 function validPositionObject(pos) {
67   if (typeof pos !== 'object') return false;
68
69   for (var i in pos) {
70     if (pos.hasOwnProperty(i) !== true) continue;
71
72     if (validSquare(i) !== true || validPieceCode(pos[i]) !== true) {
73       return false;
74     }
75   }
76
77   return true;
78 }
79
80 // convert FEN piece code to bP, wK, etc
81 function fenToPieceCode(piece) {
82   // black piece
83   if (piece.toLowerCase() === piece) {
84     return 'b' + piece.toUpperCase();
85   }
86
87   // white piece
88   return 'w' + piece.toUpperCase();
89 }
90
91 // convert bP, wK, etc code to FEN structure
92 function pieceCodeToFen(piece) {
93   var tmp = piece.split('');
94
95   // white piece
96   if (tmp[0] === 'w') {
97     return tmp[1].toUpperCase();
98   }
99
100   // black piece
101   return tmp[1].toLowerCase();
102 }
103
104 // convert FEN string to position object
105 // returns false if the FEN string is invalid
106 function fenToObj(fen) {
107   if (validFen(fen) !== true) {
108     return false;
109   }
110
111   // cut off any move, castling, etc info from the end
112   // we're only interested in position information
113   fen = fen.replace(/ .+$/, '');
114
115   var rows = fen.split('/');
116   var position = {};
117
118   var currentRow = 8;
119   for (var i = 0; i < 8; i++) {
120     var row = rows[i].split('');
121     var colIndex = 0;
122
123     // loop through each character in the FEN section
124     for (var j = 0; j < row.length; j++) {
125       // number / empty squares
126       if (row[j].search(/[1-8]/) !== -1) {
127         var emptySquares = parseInt(row[j], 10);
128         colIndex += emptySquares;
129       }
130       // piece
131       else {
132         var square = COLUMNS[colIndex] + currentRow;
133         position[square] = fenToPieceCode(row[j]);
134         colIndex++;
135       }
136     }
137
138     currentRow--;
139   }
140
141   return position;
142 }
143
144 // position object to FEN string
145 // returns false if the obj is not a valid position object
146 function objToFen(obj) {
147   if (validPositionObject(obj) !== true) {
148     return false;
149   }
150
151   var fen = '';
152
153   var currentRow = 8;
154   for (var i = 0; i < 8; i++) {
155     for (var j = 0; j < 8; j++) {
156       var square = COLUMNS[j] + currentRow;
157
158       // piece exists
159       if (obj.hasOwnProperty(square) === true) {
160         fen += pieceCodeToFen(obj[square]);
161       }
162
163       // empty space
164       else {
165         fen += '1';
166       }
167     }
168
169     if (i !== 7) {
170       fen += '/';
171     }
172
173     currentRow--;
174   }
175
176   // squeeze the numbers together
177   // haha, I love this solution...
178   fen = fen.replace(/11111111/g, '8');
179   fen = fen.replace(/1111111/g, '7');
180   fen = fen.replace(/111111/g, '6');
181   fen = fen.replace(/11111/g, '5');
182   fen = fen.replace(/1111/g, '4');
183   fen = fen.replace(/111/g, '3');
184   fen = fen.replace(/11/g, '2');
185
186   return fen;
187 }
188
189 /** @struct */
190 var cfg;
191
192 /** @constructor */
193 window.ChessBoard = function(containerElOrId, cfg) {
194 'use strict';
195
196 cfg = cfg || {};
197
198 //------------------------------------------------------------------------------
199 // Constants
200 //------------------------------------------------------------------------------
201
202 var MINIMUM_JQUERY_VERSION = '1.7.0',
203   START_FEN = 'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR',
204   START_POSITION = fenToObj(START_FEN);
205
206 // use unique class names to prevent clashing with anything else on the page
207 // and simplify selectors
208 var CSS = {
209   alpha: 'alpha-d2270',
210   board: 'board-b72b1',
211   chessboard: 'chessboard-63f37',
212   clearfix: 'clearfix-7da63',
213   highlight1: 'highlight1-32417',
214   highlight2: 'highlight2-9c5d2',
215   notation: 'notation-322f9',
216   numeric: 'numeric-fc462',
217   piece: 'piece-417db',
218   row: 'row-5277c',
219   sparePieces: 'spare-pieces-7492f',
220   sparePiecesBottom: 'spare-pieces-bottom-ae20f',
221   sparePiecesTop: 'spare-pieces-top-4028b',
222   square: 'square-55d63'
223 };
224 var CSSColor = {};
225 CSSColor['white'] = 'white-1e1d7';
226 CSSColor['black'] = 'black-3c85d';
227
228 //------------------------------------------------------------------------------
229 // Module Scope Variables
230 //------------------------------------------------------------------------------
231
232 // DOM elements
233 var containerEl,
234   boardEl,
235   draggedPieceEl,
236   sparePiecesTopEl,
237   sparePiecesBottomEl;
238
239 // constructor return object
240 var widget = {};
241
242 //------------------------------------------------------------------------------
243 // Stateful
244 //------------------------------------------------------------------------------
245
246 var ANIMATION_HAPPENING = false,
247   BOARD_BORDER_SIZE = 2,
248   CURRENT_ORIENTATION = 'white',
249   CURRENT_POSITION = {},
250   SQUARE_SIZE,
251   DRAGGED_PIECE,
252   DRAGGED_PIECE_LOCATION,
253   DRAGGED_PIECE_SOURCE,
254   DRAGGING_A_PIECE = false,
255   SPARE_PIECE_ELS_IDS = {},
256   SQUARE_ELS_IDS = {},
257   SQUARE_ELS_OFFSETS;
258
259 //------------------------------------------------------------------------------
260 // JS Util Functions
261 //------------------------------------------------------------------------------
262
263 // http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript
264 function createId() {
265   return 'xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx'.replace(/x/g, function(c) {
266     var r = Math.random() * 16 | 0;
267     return r.toString(16);
268   });
269 }
270
271 function deepCopy(thing) {
272   return JSON.parse(JSON.stringify(thing));
273 }
274
275 function parseSemVer(version) {
276   var tmp = version.split('.');
277   return {
278     major: parseInt(tmp[0], 10),
279     minor: parseInt(tmp[1], 10),
280     patch: parseInt(tmp[2], 10)
281   };
282 }
283
284 // returns true if version is >= minimum
285 function compareSemVer(version, minimum) {
286   version = parseSemVer(version);
287   minimum = parseSemVer(minimum);
288
289   var versionNum = (version.major * 10000 * 10000) +
290     (version.minor * 10000) + version.patch;
291   var minimumNum = (minimum.major * 10000 * 10000) +
292     (minimum.minor * 10000) + minimum.patch;
293
294   return (versionNum >= minimumNum);
295 }
296
297 //------------------------------------------------------------------------------
298 // Validation / Errors
299 //------------------------------------------------------------------------------
300
301 /**
302  * @param {!number} code
303  * @param {!string} msg
304  * @param {Object=} obj
305  */
306 function error(code, msg, obj) {
307   // do nothing if showErrors is not set
308   if (cfg.hasOwnProperty('showErrors') !== true ||
309       cfg.showErrors === false) {
310     return;
311   }
312
313   var errorText = 'ChessBoard Error ' + code + ': ' + msg;
314
315   // print to console
316   if (cfg.showErrors === 'console' &&
317       typeof console === 'object' &&
318       typeof console.log === 'function') {
319     console.log(errorText);
320     if (arguments.length >= 2) {
321       console.log(obj);
322     }
323     return;
324   }
325
326   // alert errors
327   if (cfg.showErrors === 'alert') {
328     if (obj) {
329       errorText += '\n\n' + JSON.stringify(obj);
330     }
331     window.alert(errorText);
332     return;
333   }
334
335   // custom function
336   if (typeof cfg.showErrors === 'function') {
337     cfg.showErrors(code, msg, obj);
338   }
339 }
340
341 // check dependencies
342 function checkDeps() {
343   // if containerId is a string, it must be the ID of a DOM node
344   if (typeof containerElOrId === 'string') {
345     // cannot be empty
346     if (containerElOrId === '') {
347       window.alert('ChessBoard Error 1001: ' +
348         'The first argument to ChessBoard() cannot be an empty string.' +
349         '\n\nExiting...');
350       return false;
351     }
352
353     // make sure the container element exists in the DOM
354     var el = document.getElementById(containerElOrId);
355     if (! el) {
356       window.alert('ChessBoard Error 1002: Element with id "' +
357         containerElOrId + '" does not exist in the DOM.' +
358         '\n\nExiting...');
359       return false;
360     }
361
362     // set the containerEl
363     containerEl = el;
364   }
365
366   // else it must be a DOM node
367   else {
368     containerEl = containerElOrId;
369   }
370
371   return true;
372 }
373
374 function validAnimationSpeed(speed) {
375   if (speed === 'fast' || speed === 'slow') {
376     return true;
377   }
378
379   if ((parseInt(speed, 10) + '') !== (speed + '')) {
380     return false;
381   }
382
383   return (speed >= 0);
384 }
385
386 // validate config / set default options
387 function expandConfig() {
388   if (typeof cfg === 'string' || validPositionObject(cfg) === true) {
389     cfg = {
390       position: cfg
391     };
392   }
393
394   // default for orientation is white
395   if (cfg.orientation !== 'black') {
396     cfg.orientation = 'white';
397   }
398   CURRENT_ORIENTATION = cfg.orientation;
399
400   // default for showNotation is true
401   if (cfg.showNotation !== false) {
402     cfg.showNotation = true;
403   }
404
405   // default for draggable is false
406   if (cfg.draggable !== true) {
407     cfg.draggable = false;
408   }
409
410   // default for dropOffBoard is 'snapback'
411   if (cfg.dropOffBoard !== 'trash') {
412     cfg.dropOffBoard = 'snapback';
413   }
414
415   // default for sparePieces is false
416   if (cfg.sparePieces !== true) {
417     cfg.sparePieces = false;
418   }
419
420   // draggable must be true if sparePieces is enabled
421   if (cfg.sparePieces === true) {
422     cfg.draggable = true;
423   }
424
425   // default piece theme is wikipedia
426   if (cfg.hasOwnProperty('pieceTheme') !== true ||
427       (typeof cfg.pieceTheme !== 'string' &&
428        typeof cfg.pieceTheme !== 'function')) {
429     cfg.pieceTheme = 'img/chesspieces/wikipedia/{piece}.png';
430   }
431
432   // animation speeds
433   if (cfg.hasOwnProperty('appearSpeed') !== true ||
434       validAnimationSpeed(cfg.appearSpeed) !== true) {
435     cfg.appearSpeed = 200;
436   }
437   if (cfg.hasOwnProperty('moveSpeed') !== true ||
438       validAnimationSpeed(cfg.moveSpeed) !== true) {
439     cfg.moveSpeed = 200;
440   }
441   if (cfg.hasOwnProperty('snapbackSpeed') !== true ||
442       validAnimationSpeed(cfg.snapbackSpeed) !== true) {
443     cfg.snapbackSpeed = 50;
444   }
445   if (cfg.hasOwnProperty('snapSpeed') !== true ||
446       validAnimationSpeed(cfg.snapSpeed) !== true) {
447     cfg.snapSpeed = 25;
448   }
449   if (cfg.hasOwnProperty('trashSpeed') !== true ||
450       validAnimationSpeed(cfg.trashSpeed) !== true) {
451     cfg.trashSpeed = 100;
452   }
453
454   // make sure position is valid
455   if (cfg.hasOwnProperty('position') === true) {
456     if (cfg.position === 'start') {
457       CURRENT_POSITION = deepCopy(START_POSITION);
458     }
459
460     else if (validFen(cfg.position) === true) {
461       CURRENT_POSITION = fenToObj(cfg.position);
462     }
463
464     else if (validPositionObject(cfg.position) === true) {
465       CURRENT_POSITION = deepCopy(cfg.position);
466     }
467
468     else {
469       error(7263, 'Invalid value passed to config.position.', cfg.position);
470     }
471   }
472
473   return true;
474 }
475
476 //------------------------------------------------------------------------------
477 // DOM Misc
478 //------------------------------------------------------------------------------
479
480 // calculates square size based on the width of the container
481 // got a little CSS black magic here, so let me explain:
482 // get the width of the container element (could be anything), reduce by 1 for
483 // fudge factor, and then keep reducing until we find an exact mod 8 for
484 // our square size
485 function calculateSquareSize() {
486   var containerWidth = parseInt(getComputedStyle(containerEl).width, 10);
487
488   // defensive, prevent infinite loop
489   if (! containerWidth || containerWidth <= 0) {
490     return 0;
491   }
492
493   // pad one pixel
494   var boardWidth = containerWidth - 1;
495
496   while (boardWidth % 8 !== 0 && boardWidth > 0) {
497     boardWidth--;
498   }
499
500   return (boardWidth / 8);
501 }
502
503 // create random IDs for elements
504 function createElIds() {
505   // squares on the board
506   for (var i = 0; i < COLUMNS.length; i++) {
507     for (var j = 1; j <= 8; j++) {
508       var square = COLUMNS[i] + j;
509       SQUARE_ELS_IDS[square] = square + '-' + createId();
510     }
511   }
512
513   // spare pieces
514   var pieces = 'KQRBNP'.split('');
515   for (var i = 0; i < pieces.length; i++) {
516     var whitePiece = 'w' + pieces[i];
517     var blackPiece = 'b' + pieces[i];
518     SPARE_PIECE_ELS_IDS[whitePiece] = whitePiece + '-' + createId();
519     SPARE_PIECE_ELS_IDS[blackPiece] = blackPiece + '-' + createId();
520   }
521 }
522
523 //------------------------------------------------------------------------------
524 // Markup Building
525 //------------------------------------------------------------------------------
526
527 function buildBoardContainer() {
528   var html = '<div class="' + CSS.chessboard + '">';
529
530   if (cfg.sparePieces === true) {
531     html += '<div class="' + CSS.sparePieces + ' ' +
532       CSS.sparePiecesTop + '"></div>';
533   }
534
535   html += '<div class="' + CSS.board + '"></div>';
536
537   if (cfg.sparePieces === true) {
538     html += '<div class="' + CSS.sparePieces + ' ' +
539       CSS.sparePiecesBottom + '"></div>';
540   }
541
542   html += '</div>';
543
544   return html;
545 }
546
547 /*
548 var buildSquare = function(color, size, id) {
549   var html = '<div class="' + CSS.square + ' ' + CSSColor[color] + '" ' +
550   'style="width: ' + size + 'px; height: ' + size + 'px" ' +
551   'id="' + id + '">';
552
553   if (cfg.showNotation === true) {
554
555   }
556
557   html += '</div>';
558
559   return html;
560 };
561 */
562
563 function buildBoard(orientation) {
564   if (orientation !== 'black') {
565     orientation = 'white';
566   }
567
568   var html = '';
569
570   // algebraic notation / orientation
571   var alpha = deepCopy(COLUMNS);
572   var row = 8;
573   if (orientation === 'black') {
574     alpha.reverse();
575     row = 1;
576   }
577
578   var squareColor = 'white';
579   for (var i = 0; i < 8; i++) {
580     html += '<div class="' + CSS.row + '">';
581     for (var j = 0; j < 8; j++) {
582       var square = alpha[j] + row;
583
584       html += '<div class="' + CSS.square + ' ' + CSSColor[squareColor] + ' ' +
585         'square-' + square + '" ' +
586         'style="width: ' + SQUARE_SIZE + 'px; height: ' + SQUARE_SIZE + 'px" ' +
587         'id="' + SQUARE_ELS_IDS[square] + '" ' +
588         'data-square="' + square + '">';
589
590       if (cfg.showNotation === true) {
591         // alpha notation
592         if ((orientation === 'white' && row === 1) ||
593             (orientation === 'black' && row === 8)) {
594           html += '<div class="' + CSS.notation + ' ' + CSS.alpha + '">' +
595             alpha[j] + '</div>';
596         }
597
598         // numeric notation
599         if (j === 0) {
600           html += '<div class="' + CSS.notation + ' ' + CSS.numeric + '">' +
601             row + '</div>';
602         }
603       }
604
605       html += '</div>'; // end .square
606
607       squareColor = (squareColor === 'white' ? 'black' : 'white');
608     }
609     html += '<div class="' + CSS.clearfix + '"></div></div>';
610
611     squareColor = (squareColor === 'white' ? 'black' : 'white');
612
613     if (orientation === 'white') {
614       row--;
615     }
616     else {
617       row++;
618     }
619   }
620
621   return html;
622 }
623
624 function buildPieceImgSrc(piece) {
625   if (typeof cfg.pieceTheme === 'function') {
626     return cfg.pieceTheme(piece);
627   }
628
629   if (typeof cfg.pieceTheme === 'string') {
630     return cfg.pieceTheme.replace(/{piece}/g, piece);
631   }
632
633   // NOTE: this should never happen
634   error(8272, 'Unable to build image source for cfg.pieceTheme.');
635   return '';
636 }
637
638 /**
639  * @param {!string} piece
640  * @param {boolean=} hidden
641  * @param {!string=} id
642  */
643 function buildPiece(piece, hidden, id) {
644   var html = '<img src="' + buildPieceImgSrc(piece) + '" ';
645   if (id && typeof id === 'string') {
646     html += 'id="' + id + '" ';
647   }
648   html += 'alt="" ' +
649   'class="' + CSS.piece + '" ' +
650   'data-piece="' + piece + '" ' +
651   'style="width: ' + SQUARE_SIZE + 'px;' +
652   'height: ' + SQUARE_SIZE + 'px;';
653   if (hidden === true) {
654     html += 'display:none;';
655   }
656   html += '" />';
657
658   let elem = document.createElement('template');
659   elem.innerHTML = html;
660   return elem.content;
661 }
662
663 function buildSparePieces(color) {
664   var pieces = ['wK', 'wQ', 'wR', 'wB', 'wN', 'wP'];
665   if (color === 'black') {
666     pieces = ['bK', 'bQ', 'bR', 'bB', 'bN', 'bP'];
667   }
668
669   var html = '';
670   for (var i = 0; i < pieces.length; i++) {
671     html += buildPiece(pieces[i], false, SPARE_PIECE_ELS_IDS[pieces[i]]);
672   }
673
674   return html;
675 }
676
677 //------------------------------------------------------------------------------
678 // Animations
679 //------------------------------------------------------------------------------
680
681 function offset(el) {  // From https://youmightnotneedjquery.com/.
682   let box = el.getBoundingClientRect();
683   let docElem = document.documentElement;
684   return {
685     top: box.top + window.pageYOffset - docElem.clientTop,
686     left: box.left + window.pageXOffset - docElem.clientLeft
687   };
688 }
689
690 function animateSquareToSquare(src, dest, piece, completeFn) {
691   // get information about the source and destination squares
692   var srcSquareEl = document.getElementById(SQUARE_ELS_IDS[src]);
693   var srcSquarePosition = offset(srcSquareEl);
694   var destSquareEl = document.getElementById(SQUARE_ELS_IDS[dest]);
695   var destSquarePosition = offset(destSquareEl);
696
697   // create the animated piece and absolutely position it
698   // over the source square
699   var animatedPieceId = createId();
700   document.body.append(buildPiece(piece, true, animatedPieceId));
701   var animatedPieceEl = document.getElementById(animatedPieceId);
702   animatedPieceEl.style.display = null;
703   animatedPieceEl.style.position = 'absolute';
704   animatedPieceEl.style.top = srcSquarePosition.top + 'px';
705   animatedPieceEl.style.left = srcSquarePosition.left + 'px';
706
707   // remove original piece(s) from source square
708   // TODO: multiple pieces should never really happen, but it will if we are moving
709   // while another animation still isn't done
710   srcSquareEl.querySelectorAll('.' + CSS.piece).forEach((piece) => piece.remove());
711
712   // on complete
713   var complete = function() {
714     // add the "real" piece to the destination square
715     destSquareEl.append(buildPiece(piece));
716
717     // remove the animated piece
718     animatedPieceEl.remove();
719
720     // run complete function
721     if (typeof completeFn === 'function') {
722       completeFn();
723     }
724   };
725
726   // animate the piece to the destination square
727   animatedPieceEl.addEventListener('transitionend', complete, {once: true});
728   requestAnimationFrame(() => {
729     animatedPieceEl.style.transitionProperty = 'top, left';
730     animatedPieceEl.style.transitionDuration = cfg.moveSpeed + 'ms';
731     animatedPieceEl.style.top = destSquarePosition.top + 'px';
732     animatedPieceEl.style.left = destSquarePosition.left + 'px';
733   });
734 }
735
736 function animateSparePieceToSquare(piece, dest, completeFn) {
737   var srcOffset = offset(document.getelementById(SPARE_PIECE_ELS_IDS[piece]));
738   var destSquareEl = document.getElementById(SQUARE_ELS_IDS[dest]);
739   var destOffset = offset(destSquareEl);
740
741   // create the animate piece
742   var pieceId = createId();
743   document.body.append(buildPiece(piece, true, pieceId));
744   var animatedPieceEl = document.getElementById(pieceId);
745   animatedPieceEl.style.display = '';
746   animatedPieceEl.style.position = 'absolute';
747   animatedPieceEl.style.left = srcOffset.left;
748   animatedPieceEl.style.top = srcOffset.top;
749
750   // on complete
751   var complete = function() {
752     // add the "real" piece to the destination square
753     destSquareEl.querySelector('.' + CSS.piece).remove();
754     destSquareEl.append(buildPiece(piece));
755
756     // remove the animated piece
757     animatedPieceEl.remove();
758
759     // run complete function
760     if (typeof completeFn === 'function') {
761       completeFn();
762     }
763   };
764
765   // animate the piece to the destination square
766   // FIXME: support this for non-jquery
767   var opts = {
768     duration: cfg.moveSpeed,
769     complete: complete
770   };
771   //$(animatedPieceEl).animate(destOffset, opts);
772 }
773
774 function fadeIn(piece, onFinish) {
775   piece.style.opacity = 0;
776   piece.style.display = null;
777   piece.addEventListener('transitionend', onFinish, {once: true});
778   requestAnimationFrame(() => {
779     piece.style.transitionProperty = 'opacity';
780     piece.style.transitionDuration = cfg.appearSpeed + 'ms';
781     piece.style.opacity = 1;
782   });
783 }
784
785 function fadeOut(piece, onFinish) {
786   piece.style.opacity = 1;
787   piece.style.display = null;
788   piece.addEventListener('transitionend', onFinish, {once: true});
789   requestAnimationFrame(() => {
790     piece.style.transitionProperty = 'opacity';
791     piece.style.transitionDuration = cfg.trashSpeed + 'ms';
792     piece.style.opacity = 0;
793   });
794 }
795
796 // execute an array of animations
797 function doAnimations(a, oldPos, newPos) {
798   ANIMATION_HAPPENING = true;
799
800   var numFinished = 0;
801   function onFinish(e) {
802     if (e && e.target) {
803       e.target.transitionProperty = null;
804     }
805
806     numFinished++;
807
808     // exit if all the animations aren't finished
809     if (numFinished !== a.length) return;
810
811     drawPositionInstant();
812     ANIMATION_HAPPENING = false;
813
814     // run their onMoveEnd function
815     if (cfg.hasOwnProperty('onMoveEnd') === true &&
816       typeof cfg.onMoveEnd === 'function') {
817       cfg.onMoveEnd(deepCopy(oldPos), deepCopy(newPos));
818     }
819   }
820
821   requestAnimationFrame(() => {  // Firefox workaround.
822     for (var i = 0; i < a.length; i++) {
823       // clear a piece
824       if (a[i].type === 'clear') {
825         document.getElementById(SQUARE_ELS_IDS[a[i].square]).querySelectorAll('.' + CSS.piece).forEach(
826           (piece) => fadeOut(piece, onFinish)
827         );
828       }
829
830       // add a piece (no spare pieces)
831       if (a[i].type === 'add' && cfg.sparePieces !== true) {
832         let square = document.getElementById(SQUARE_ELS_IDS[a[i].square]);
833         square.append(buildPiece(a[i].piece, true));
834         let piece = square.querySelector('.' + CSS.piece);
835         fadeIn(piece, onFinish);
836       }
837
838       // add a piece from a spare piece
839       if (a[i].type === 'add' && cfg.sparePieces === true) {
840         animateSparePieceToSquare(a[i].piece, a[i].square, onFinish);
841       }
842
843       // move a piece
844       if (a[i].type === 'move') {
845         animateSquareToSquare(a[i].source, a[i].destination, a[i].piece,
846           onFinish);
847       }
848     }
849   });
850 }
851
852 // returns the distance between two squares
853 function squareDistance(s1, s2) {
854   s1 = s1.split('');
855   var s1x = COLUMNS.indexOf(s1[0]) + 1;
856   var s1y = parseInt(s1[1], 10);
857
858   s2 = s2.split('');
859   var s2x = COLUMNS.indexOf(s2[0]) + 1;
860   var s2y = parseInt(s2[1], 10);
861
862   var xDelta = Math.abs(s1x - s2x);
863   var yDelta = Math.abs(s1y - s2y);
864
865   if (xDelta >= yDelta) return xDelta;
866   return yDelta;
867 }
868
869 // returns an array of closest squares from square
870 function createRadius(square) {
871   var squares = [];
872
873   // calculate distance of all squares
874   for (var i = 0; i < 8; i++) {
875     for (var j = 0; j < 8; j++) {
876       var s = COLUMNS[i] + (j + 1);
877
878       // skip the square we're starting from
879       if (square === s) continue;
880
881       squares.push({
882         square: s,
883         distance: squareDistance(square, s)
884       });
885     }
886   }
887
888   // sort by distance
889   squares.sort(function(a, b) {
890     return a.distance - b.distance;
891   });
892
893   // just return the square code
894   var squares2 = [];
895   for (var i = 0; i < squares.length; i++) {
896     squares2.push(squares[i].square);
897   }
898
899   return squares2;
900 }
901
902 // returns the square of the closest instance of piece
903 // returns false if no instance of piece is found in position
904 function findClosestPiece(position, piece, square) {
905   // create array of closest squares from square
906   var closestSquares = createRadius(square);
907
908   // search through the position in order of distance for the piece
909   for (var i = 0; i < closestSquares.length; i++) {
910     var s = closestSquares[i];
911
912     if (position.hasOwnProperty(s) === true && position[s] === piece) {
913       return s;
914     }
915   }
916
917   return false;
918 }
919
920 // calculate an array of animations that need to happen in order to get
921 // from pos1 to pos2
922 function calculateAnimations(pos1, pos2) {
923   // make copies of both
924   pos1 = deepCopy(pos1);
925   pos2 = deepCopy(pos2);
926
927   var animations = [];
928   var squaresMovedTo = {};
929
930   // remove pieces that are the same in both positions
931   for (var i in pos2) {
932     if (pos2.hasOwnProperty(i) !== true) continue;
933
934     if (pos1.hasOwnProperty(i) === true && pos1[i] === pos2[i]) {
935       delete pos1[i];
936       delete pos2[i];
937     }
938   }
939
940   // find all the "move" animations
941   for (var i in pos2) {
942     if (pos2.hasOwnProperty(i) !== true) continue;
943
944     var closestPiece = findClosestPiece(pos1, pos2[i], i);
945     if (closestPiece !== false) {
946       animations.push({
947         type: 'move',
948         source: closestPiece,
949         destination: i,
950         piece: pos2[i]
951       });
952
953       delete pos1[closestPiece];
954       delete pos2[i];
955       squaresMovedTo[i] = true;
956     }
957   }
958
959   // add pieces to pos2
960   for (var i in pos2) {
961     if (pos2.hasOwnProperty(i) !== true) continue;
962
963     animations.push({
964       type: 'add',
965       square: i,
966       piece: pos2[i]
967     })
968
969     delete pos2[i];
970   }
971
972   // clear pieces from pos1
973   for (var i in pos1) {
974     if (pos1.hasOwnProperty(i) !== true) continue;
975
976     // do not clear a piece if it is on a square that is the result
977     // of a "move", ie: a piece capture
978     if (squaresMovedTo.hasOwnProperty(i) === true) continue;
979
980     animations.push({
981       type: 'clear',
982       square: i,
983       piece: pos1[i]
984     });
985
986     delete pos1[i];
987   }
988
989   return animations;
990 }
991
992 //------------------------------------------------------------------------------
993 // Control Flow
994 //------------------------------------------------------------------------------
995
996 function drawPositionInstant() {
997   // clear the board
998   boardEl.querySelectorAll('.' + CSS.piece).forEach((piece) => piece.remove());
999
1000   // add the pieces
1001   for (var i in CURRENT_POSITION) {
1002     if (CURRENT_POSITION.hasOwnProperty(i) !== true) continue;
1003
1004     document.getElementById(SQUARE_ELS_IDS[i]).append(buildPiece(CURRENT_POSITION[i]));
1005   }
1006 }
1007
1008 function drawBoard() {
1009   boardEl.innerHTML = buildBoard(CURRENT_ORIENTATION);
1010   drawPositionInstant();
1011
1012   if (cfg.sparePieces === true) {
1013     if (CURRENT_ORIENTATION === 'white') {
1014       sparePiecesTopEl.innerHTML = buildSparePieces('black');
1015       sparePiecesBottomEl.innerHTML = buildSparePieces('white');
1016     }
1017     else {
1018       sparePiecesTopEl.innerHTML = buildSparePieces('white');
1019       sparePiecesBottomEl.innerHTML = buildSparePieces('black');
1020     }
1021   }
1022 }
1023
1024 // given a position and a set of moves, return a new position
1025 // with the moves executed
1026 function calculatePositionFromMoves(position, moves) {
1027   position = deepCopy(position);
1028
1029   for (var i in moves) {
1030     if (moves.hasOwnProperty(i) !== true) continue;
1031
1032     // skip the move if the position doesn't have a piece on the source square
1033     if (position.hasOwnProperty(i) !== true) continue;
1034
1035     var piece = position[i];
1036     delete position[i];
1037     position[moves[i]] = piece;
1038   }
1039
1040   return position;
1041 }
1042
1043 function setCurrentPosition(position) {
1044   var oldPos = deepCopy(CURRENT_POSITION);
1045   var newPos = deepCopy(position);
1046   var oldFen = objToFen(oldPos);
1047   var newFen = objToFen(newPos);
1048
1049   // do nothing if no change in position
1050   if (oldFen === newFen) return;
1051
1052   // run their onChange function
1053   if (cfg.hasOwnProperty('onChange') === true &&
1054     typeof cfg.onChange === 'function') {
1055     cfg.onChange(oldPos, newPos);
1056   }
1057
1058   // update state
1059   CURRENT_POSITION = position;
1060 }
1061
1062 function isXYOnSquare(x, y) {
1063   for (var i in SQUARE_ELS_OFFSETS) {
1064     if (SQUARE_ELS_OFFSETS.hasOwnProperty(i) !== true) continue;
1065
1066     var s = SQUARE_ELS_OFFSETS[i];
1067     if (x >= s.left && x < s.left + SQUARE_SIZE &&
1068         y >= s.top && y < s.top + SQUARE_SIZE) {
1069       return i;
1070     }
1071   }
1072
1073   return 'offboard';
1074 }
1075
1076 // records the XY coords of every square into memory
1077 function captureSquareOffsets() {
1078   SQUARE_ELS_OFFSETS = {};
1079
1080   for (var i in SQUARE_ELS_IDS) {
1081     if (SQUARE_ELS_IDS.hasOwnProperty(i) !== true) continue;
1082
1083     SQUARE_ELS_OFFSETS[i] = offset(document.getElementById(SQUARE_ELS_IDS[i]));
1084   }
1085 }
1086
1087 function removeSquareHighlights() {
1088   boardEl.querySelectorAll('.' + CSS.square).forEach((piece) => {
1089     piece.classList.remove(CSS.highlight1);
1090     piece.classList.remove(CSS.highlight2);
1091   });
1092 }
1093
1094 function snapbackDraggedPiece() {
1095   // there is no "snapback" for spare pieces
1096   if (DRAGGED_PIECE_SOURCE === 'spare') {
1097     trashDraggedPiece();
1098     return;
1099   }
1100
1101   removeSquareHighlights();
1102
1103   // animation complete
1104   function complete() {
1105     drawPositionInstant();
1106     draggedPieceEl.style.display = 'none';
1107
1108     // run their onSnapbackEnd function
1109     if (cfg.hasOwnProperty('onSnapbackEnd') === true &&
1110       typeof cfg.onSnapbackEnd === 'function') {
1111       cfg.onSnapbackEnd(DRAGGED_PIECE, DRAGGED_PIECE_SOURCE,
1112         deepCopy(CURRENT_POSITION), CURRENT_ORIENTATION);
1113     }
1114   }
1115
1116   // get source square position
1117   var sourceSquarePosition =
1118     offset(document.getElementById(SQUARE_ELS_IDS[DRAGGED_PIECE_SOURCE]));
1119
1120   // animate the piece to the target square
1121   draggedPieceEl.addEventListener('transitionend', complete, {once: true});
1122   requestAnimationFrame(() => {
1123     draggedPieceEl.style.transitionProperty = 'top, left';
1124     draggedPieceEl.style.transitionDuration = cfg.snapbackSpeed + 'ms';
1125     draggedPieceEl.style.top = sourceSquarePosition.top + 'px';
1126     draggedPieceEl.style.left = sourceSquarePosition.left + 'px';
1127   });
1128
1129   // set state
1130   DRAGGING_A_PIECE = false;
1131 }
1132
1133 function trashDraggedPiece() {
1134   removeSquareHighlights();
1135
1136   // remove the source piece
1137   var newPosition = deepCopy(CURRENT_POSITION);
1138   delete newPosition[DRAGGED_PIECE_SOURCE];
1139   setCurrentPosition(newPosition);
1140
1141   // redraw the position
1142   drawPositionInstant();
1143
1144   // hide the dragged piece
1145   // FIXME: support this for non-jquery
1146   //$(draggedPieceEl).fadeOut(cfg.trashSpeed);
1147
1148   // set state
1149   DRAGGING_A_PIECE = false;
1150 }
1151
1152 function dropDraggedPieceOnSquare(square) {
1153   removeSquareHighlights();
1154
1155   // update position
1156   var newPosition = deepCopy(CURRENT_POSITION);
1157   delete newPosition[DRAGGED_PIECE_SOURCE];
1158   newPosition[square] = DRAGGED_PIECE;
1159   setCurrentPosition(newPosition);
1160
1161   // get target square information
1162   var targetSquarePosition = offset(document.getElementById(SQUARE_ELS_IDS[square]));
1163
1164   // animation complete
1165   var complete = function() {
1166     drawPositionInstant();
1167     draggedPieceEl.style.display = 'none';
1168
1169     // execute their onSnapEnd function
1170     if (cfg.hasOwnProperty('onSnapEnd') === true &&
1171       typeof cfg.onSnapEnd === 'function') {
1172       requestAnimationFrame(() => {  // HACK: so that we don't add event handlers from the callback...
1173         cfg.onSnapEnd(DRAGGED_PIECE_SOURCE, square, DRAGGED_PIECE);
1174       });
1175     }
1176   };
1177
1178   // snap the piece to the target square
1179   draggedPieceEl.addEventListener('transitionend', complete, {once: true});
1180   requestAnimationFrame(() => {
1181     draggedPieceEl.style.transitionProperty = 'top, left';
1182     draggedPieceEl.style.transitionDuration = cfg.snapSpeed + 'ms';
1183     draggedPieceEl.style.top = targetSquarePosition.top + 'px';
1184     draggedPieceEl.style.left = targetSquarePosition.left + 'px';
1185   });
1186
1187   // set state
1188   DRAGGING_A_PIECE = false;
1189 }
1190
1191 function beginDraggingPiece(source, piece, x, y) {
1192   // run their custom onDragStart function
1193   // their custom onDragStart function can cancel drag start
1194   if (typeof cfg.onDragStart === 'function' &&
1195       cfg.onDragStart(source, piece,
1196         deepCopy(CURRENT_POSITION), CURRENT_ORIENTATION) === false) {
1197     return;
1198   }
1199
1200   // set state
1201   DRAGGING_A_PIECE = true;
1202   DRAGGED_PIECE = piece;
1203   DRAGGED_PIECE_SOURCE = source;
1204
1205   // if the piece came from spare pieces, location is offboard
1206   if (source === 'spare') {
1207     DRAGGED_PIECE_LOCATION = 'offboard';
1208   }
1209   else {
1210     DRAGGED_PIECE_LOCATION = source;
1211   }
1212
1213   // capture the x, y coords of all squares in memory
1214   captureSquareOffsets();
1215
1216   // create the dragged piece
1217   draggedPieceEl.setAttribute('src', buildPieceImgSrc(piece));
1218   draggedPieceEl.style.display = null;
1219   draggedPieceEl.style.position = 'absolute';
1220   draggedPieceEl.style.left = (x - (SQUARE_SIZE / 2)) + 'px';
1221   draggedPieceEl.style.top = (y - (SQUARE_SIZE / 2)) + 'px';
1222
1223   if (source !== 'spare') {
1224     // highlight the source square and hide the piece
1225     let square = document.getElementById(SQUARE_ELS_IDS[source]);
1226     square.classList.add(CSS.highlight1);
1227     square.querySelector('.' + CSS.piece).style.display = 'none';
1228   }
1229 }
1230
1231 function updateDraggedPiece(x, y) {
1232   // put the dragged piece over the mouse cursor
1233   draggedPieceEl.style.left = (x - (SQUARE_SIZE / 2)) + 'px';
1234   draggedPieceEl.style.top = (y - (SQUARE_SIZE / 2)) + 'px';
1235
1236   // get location
1237   var location = isXYOnSquare(x, y);
1238
1239   // do nothing if the location has not changed
1240   if (location === DRAGGED_PIECE_LOCATION) return;
1241
1242   // remove highlight from previous square
1243   if (validSquare(DRAGGED_PIECE_LOCATION) === true) {
1244     document.getElementById(SQUARE_ELS_IDS[DRAGGED_PIECE_LOCATION])
1245       .classList.remove(CSS.highlight2);
1246   }
1247
1248   // add highlight to new square
1249   if (validSquare(location) === true) {
1250     document.getElementById(SQUARE_ELS_IDS[location]).classList.add(CSS.highlight2);
1251   }
1252
1253   // run onDragMove
1254   if (typeof cfg.onDragMove === 'function') {
1255     cfg.onDragMove(location, DRAGGED_PIECE_LOCATION,
1256       DRAGGED_PIECE_SOURCE, DRAGGED_PIECE,
1257       deepCopy(CURRENT_POSITION), CURRENT_ORIENTATION);
1258   }
1259
1260   // update state
1261   DRAGGED_PIECE_LOCATION = location;
1262 }
1263
1264 function stopDraggedPiece(location) {
1265   // determine what the action should be
1266   var action = 'drop';
1267   if (location === 'offboard' && cfg.dropOffBoard === 'snapback') {
1268     action = 'snapback';
1269   }
1270   if (location === 'offboard' && cfg.dropOffBoard === 'trash') {
1271     action = 'trash';
1272   }
1273
1274   // run their onDrop function, which can potentially change the drop action
1275   if (cfg.hasOwnProperty('onDrop') === true &&
1276     typeof cfg.onDrop === 'function') {
1277     var newPosition = deepCopy(CURRENT_POSITION);
1278
1279     // source piece is a spare piece and position is off the board
1280     //if (DRAGGED_PIECE_SOURCE === 'spare' && location === 'offboard') {...}
1281     // position has not changed; do nothing
1282
1283     // source piece is a spare piece and position is on the board
1284     if (DRAGGED_PIECE_SOURCE === 'spare' && validSquare(location) === true) {
1285       // add the piece to the board
1286       newPosition[location] = DRAGGED_PIECE;
1287     }
1288
1289     // source piece was on the board and position is off the board
1290     if (validSquare(DRAGGED_PIECE_SOURCE) === true && location === 'offboard') {
1291       // remove the piece from the board
1292       delete newPosition[DRAGGED_PIECE_SOURCE];
1293     }
1294
1295     // source piece was on the board and position is on the board
1296     if (validSquare(DRAGGED_PIECE_SOURCE) === true &&
1297       validSquare(location) === true) {
1298       // move the piece
1299       delete newPosition[DRAGGED_PIECE_SOURCE];
1300       newPosition[location] = DRAGGED_PIECE;
1301     }
1302
1303     var oldPosition = deepCopy(CURRENT_POSITION);
1304
1305     var result = cfg.onDrop(DRAGGED_PIECE_SOURCE, location, DRAGGED_PIECE,
1306       newPosition, oldPosition, CURRENT_ORIENTATION);
1307     if (result === 'snapback' || result === 'trash') {
1308       action = result;
1309     }
1310   }
1311
1312   // do it!
1313   if (action === 'snapback') {
1314     snapbackDraggedPiece();
1315   }
1316   else if (action === 'trash') {
1317     trashDraggedPiece();
1318   }
1319   else if (action === 'drop') {
1320     dropDraggedPieceOnSquare(location);
1321   }
1322 }
1323
1324 //------------------------------------------------------------------------------
1325 // Public Methods
1326 //------------------------------------------------------------------------------
1327
1328 // clear the board
1329 widget.clear = function(useAnimation) {
1330   widget.position({}, useAnimation);
1331 };
1332
1333 /*
1334 // get or set config properties
1335 // TODO: write this, GitHub Issue #1
1336 widget.config = function(arg1, arg2) {
1337   // get the current config
1338   if (arguments.length === 0) {
1339     return deepCopy(cfg);
1340   }
1341 };
1342 */
1343
1344 // remove the widget from the page
1345 widget.destroy = function() {
1346   // remove markup
1347   containerEl.innerHTML = '';
1348   draggedPieceEl.remove();
1349 };
1350
1351 // shorthand method to get the current FEN
1352 widget.fen = function() {
1353   return widget.position('fen');
1354 };
1355
1356 // flip orientation
1357 widget.flip = function() {
1358   widget.orientation('flip');
1359 };
1360
1361 /*
1362 // TODO: write this, GitHub Issue #5
1363 widget.highlight = function() {
1364
1365 };
1366 */
1367
1368 // move pieces
1369 widget.move = function() {
1370   // no need to throw an error here; just do nothing
1371   if (arguments.length === 0) return;
1372
1373   var useAnimation = true;
1374
1375   // collect the moves into an object
1376   var moves = {};
1377   for (var i = 0; i < arguments.length; i++) {
1378     // any "false" to this function means no animations
1379     if (arguments[i] === false) {
1380       useAnimation = false;
1381       continue;
1382     }
1383
1384     // skip invalid arguments
1385     if (validMove(arguments[i]) !== true) {
1386       error(2826, 'Invalid move passed to the move method.', arguments[i]);
1387       continue;
1388     }
1389
1390     var tmp = arguments[i].split('-');
1391     moves[tmp[0]] = tmp[1];
1392   }
1393
1394   // calculate position from moves
1395   var newPos = calculatePositionFromMoves(CURRENT_POSITION, moves);
1396
1397   // update the board
1398   widget.position(newPos, useAnimation);
1399
1400   // return the new position object
1401   return newPos;
1402 };
1403
1404 widget.orientation = function(arg) {
1405   // no arguments, return the current orientation
1406   if (arguments.length === 0) {
1407     return CURRENT_ORIENTATION;
1408   }
1409
1410   // set to white or black
1411   if (arg === 'white' || arg === 'black') {
1412     CURRENT_ORIENTATION = arg;
1413     drawBoard();
1414     return;
1415   }
1416
1417   // flip orientation
1418   if (arg === 'flip') {
1419     CURRENT_ORIENTATION = (CURRENT_ORIENTATION === 'white') ? 'black' : 'white';
1420     drawBoard();
1421     return;
1422   }
1423
1424   error(5482, 'Invalid value passed to the orientation method.', arg);
1425 };
1426
1427 /**
1428  * @param {!string|!Object} position
1429  * @param {boolean=} useAnimation
1430  */
1431 widget.position = function(position, useAnimation) {
1432   // no arguments, return the current position
1433   if (arguments.length === 0) {
1434     return deepCopy(CURRENT_POSITION);
1435   }
1436
1437   // get position as FEN
1438   if (typeof position === 'string' && position.toLowerCase() === 'fen') {
1439     return objToFen(CURRENT_POSITION);
1440   }
1441
1442   // default for useAnimations is true
1443   if (useAnimation !== false) {
1444     useAnimation = true;
1445   }
1446
1447   // start position
1448   if (typeof position === 'string' && position.toLowerCase() === 'start') {
1449     position = deepCopy(START_POSITION);
1450   }
1451
1452   // convert FEN to position object
1453   if (validFen(position) === true) {
1454     position = fenToObj(position);
1455   }
1456
1457   // validate position object
1458   if (validPositionObject(position) !== true) {
1459     error(6482, 'Invalid value passed to the position method.', position);
1460     return;
1461   }
1462
1463   if (useAnimation === true) {
1464     // start the animations
1465     doAnimations(calculateAnimations(CURRENT_POSITION, position),
1466       CURRENT_POSITION, position);
1467
1468     // set the new position
1469     setCurrentPosition(position);
1470   }
1471   // instant update
1472   else {
1473     setCurrentPosition(position);
1474     drawPositionInstant();
1475   }
1476 };
1477
1478 widget.resize = function() {
1479   // calulate the new square size
1480   SQUARE_SIZE = calculateSquareSize();
1481
1482   // set board width
1483   boardEl.style.width = (SQUARE_SIZE * 8) + 'px';
1484
1485   // set drag piece size
1486   if (draggedPieceEl !== null) {
1487     draggedPieceEl.style.height = SQUARE_SIZE + 'px';
1488     draggedPieceEl.style.width = SQUARE_SIZE + 'px';
1489   }
1490
1491   // spare pieces
1492   if (cfg.sparePieces === true) {
1493     containerEl.querySelector('.' + CSS.sparePieces)
1494       .style.paddingLeft = (SQUARE_SIZE + BOARD_BORDER_SIZE) + 'px';
1495   }
1496
1497   // redraw the board
1498   drawBoard();
1499 };
1500
1501 // set the starting position
1502 widget.start = function(useAnimation) {
1503   widget.position('start', useAnimation);
1504 };
1505
1506 //------------------------------------------------------------------------------
1507 // Browser Events
1508 //------------------------------------------------------------------------------
1509
1510 function isTouchDevice() {
1511   return ('ontouchstart' in document.documentElement);
1512 }
1513
1514 function mousedownSquare(e) {
1515   let target = e.target.closest('.' + CSS.square);
1516   if (!target) {
1517     return;
1518   }
1519
1520   // do nothing if we're not draggable
1521   if (cfg.draggable !== true) return;
1522
1523   var square = target.getAttribute('data-square');
1524
1525   // no piece on this square
1526   if (validSquare(square) !== true ||
1527       CURRENT_POSITION.hasOwnProperty(square) !== true) {
1528     return;
1529   }
1530
1531   beginDraggingPiece(square, CURRENT_POSITION[square], e.pageX, e.pageY);
1532 }
1533
1534 function touchstartSquare(e) {
1535   let target = e.target.closest('.' + CSS.square);
1536   if (!target) {
1537     return;
1538   }
1539
1540   // do nothing if we're not draggable
1541   if (cfg.draggable !== true) return;
1542
1543   var square = target.getAttribute('data-square');
1544
1545   // no piece on this square
1546   if (validSquare(square) !== true ||
1547       CURRENT_POSITION.hasOwnProperty(square) !== true) {
1548     return;
1549   }
1550
1551   e = e.originalEvent;
1552   beginDraggingPiece(square, CURRENT_POSITION[square],
1553     e.changedTouches[0].pageX, e.changedTouches[0].pageY);
1554 }
1555
1556 function mousedownSparePiece(e) {
1557   if (!e.target.matches('.' + CSS.sparePieces + ' .' + CSS.piece)) {
1558     return;
1559   }
1560
1561   // do nothing if sparePieces is not enabled
1562   if (cfg.sparePieces !== true) return;
1563
1564   var piece = e.target.getAttribute('data-piece');
1565
1566   beginDraggingPiece('spare', piece, e.pageX, e.pageY);
1567 }
1568
1569 function touchstartSparePiece(e) {
1570   if (!e.target.matches('.' + CSS.sparePieces + ' .' + CSS.piece)) {
1571     return;
1572   }
1573
1574   // do nothing if sparePieces is not enabled
1575   if (cfg.sparePieces !== true) return;
1576
1577   var piece = e.target.getAttribute('data-piece');
1578
1579   e = e.originalEvent;
1580   beginDraggingPiece('spare', piece,
1581     e.changedTouches[0].pageX, e.changedTouches[0].pageY);
1582 }
1583
1584 function mousemoveWindow(e) {
1585   // do nothing if we are not dragging a piece
1586   if (DRAGGING_A_PIECE !== true) return;
1587
1588   updateDraggedPiece(e.pageX, e.pageY);
1589 }
1590
1591 function touchmoveWindow(e) {
1592   // do nothing if we are not dragging a piece
1593   if (DRAGGING_A_PIECE !== true) return;
1594
1595   // prevent screen from scrolling
1596   e.preventDefault();
1597
1598   updateDraggedPiece(e.originalEvent.changedTouches[0].pageX,
1599     e.originalEvent.changedTouches[0].pageY);
1600 }
1601
1602 function mouseupWindow(e) {
1603   // do nothing if we are not dragging a piece
1604   if (DRAGGING_A_PIECE !== true) return;
1605
1606   // get the location
1607   var location = isXYOnSquare(e.pageX, e.pageY);
1608
1609   stopDraggedPiece(location);
1610 }
1611
1612 function touchendWindow(e) {
1613   // do nothing if we are not dragging a piece
1614   if (DRAGGING_A_PIECE !== true) return;
1615
1616   // get the location
1617   var location = isXYOnSquare(e.originalEvent.changedTouches[0].pageX,
1618     e.originalEvent.changedTouches[0].pageY);
1619
1620   stopDraggedPiece(location);
1621 }
1622
1623 function mouseenterSquare(e) {
1624   let target = e.target.closest('.' + CSS.square);
1625   if (!target) {
1626     return;
1627   }
1628
1629   // do not fire this event if we are dragging a piece
1630   // NOTE: this should never happen, but it's a safeguard
1631   if (DRAGGING_A_PIECE !== false) return;
1632
1633   if (cfg.hasOwnProperty('onMouseoverSquare') !== true ||
1634     typeof cfg.onMouseoverSquare !== 'function') return;
1635
1636   // get the square
1637   var square = target.getAttribute('data-square');
1638
1639   // NOTE: this should never happen; defensive
1640   if (validSquare(square) !== true) return;
1641
1642   // get the piece on this square
1643   var piece = false;
1644   if (CURRENT_POSITION.hasOwnProperty(square) === true) {
1645     piece = CURRENT_POSITION[square];
1646   }
1647
1648   // execute their function
1649   cfg.onMouseoverSquare(square, piece, deepCopy(CURRENT_POSITION),
1650     CURRENT_ORIENTATION);
1651 }
1652
1653 function mouseleaveSquare(e) {
1654   let target = e.target.closest('.' + CSS.square);
1655   if (!target) {
1656     return;
1657   }
1658
1659   // do not fire this event if we are dragging a piece
1660   // NOTE: this should never happen, but it's a safeguard
1661   if (DRAGGING_A_PIECE !== false) return;
1662
1663   if (cfg.hasOwnProperty('onMouseoutSquare') !== true ||
1664     typeof cfg.onMouseoutSquare !== 'function') return;
1665
1666   // get the square
1667   var square = target.getAttribute('data-square');
1668
1669   // NOTE: this should never happen; defensive
1670   if (validSquare(square) !== true) return;
1671
1672   // get the piece on this square
1673   var piece = false;
1674   if (CURRENT_POSITION.hasOwnProperty(square) === true) {
1675     piece = CURRENT_POSITION[square];
1676   }
1677
1678   // execute their function
1679   cfg.onMouseoutSquare(square, piece, deepCopy(CURRENT_POSITION),
1680     CURRENT_ORIENTATION);
1681 }
1682
1683 //------------------------------------------------------------------------------
1684 // Initialization
1685 //------------------------------------------------------------------------------
1686
1687 function addEvents() {
1688   // prevent browser "image drag"
1689   let stopDefault = (e) => {
1690     if (e.target.matches('.' + CSS.piece)) {
1691       e.preventDefault();
1692     }
1693   };
1694   document.body.addEventListener('mousedown', stopDefault);
1695   document.body.addEventListener('mousemove', stopDefault);
1696
1697   // mouse drag pieces
1698   boardEl.addEventListener('mousedown', mousedownSquare);
1699   containerEl.addEventListener('mousedown', mousedownSparePiece);
1700
1701   // mouse enter / leave square
1702   boardEl.addEventListener('mouseenter', mouseenterSquare);
1703   boardEl.addEventListener('mouseleave', mouseleaveSquare);
1704
1705   window.addEventListener('mousemove', mousemoveWindow);
1706   window.addEventListener('mouseup', mouseupWindow);
1707
1708   // touch drag pieces
1709   if (isTouchDevice() === true) {
1710     boardEl.addEventListener('touchstart', touchstartSquare);
1711     containerEl.addEventListener('touchstart', touchstartSparePiece);
1712     window.addEventListener('touchmove', touchmoveWindow);
1713     window.addEventListener('touchend', touchendWindow);
1714   }
1715 }
1716
1717 function initDom() {
1718   // build board and save it in memory
1719   containerEl.innerHTML = buildBoardContainer();
1720   boardEl = containerEl.querySelector('.' + CSS.board);
1721
1722   if (cfg.sparePieces === true) {
1723     sparePiecesTopEl = containerEl.querySelector('.' + CSS.sparePiecesTop);
1724     sparePiecesBottomEl = containerEl.querySelector('.' + CSS.sparePiecesBottom);
1725   }
1726
1727   // create the drag piece
1728   var draggedPieceId = createId();
1729   document.body.append(buildPiece('wP', true, draggedPieceId));
1730   draggedPieceEl = document.getElementById(draggedPieceId);
1731
1732   // get the border size
1733   BOARD_BORDER_SIZE = parseInt(boardEl.style.borderLeftWidth, 10);
1734
1735   // set the size and draw the board
1736   widget.resize();
1737 }
1738
1739 function init() {
1740   if (checkDeps() !== true ||
1741       expandConfig() !== true) return;
1742
1743   // create unique IDs for all the elements we will create
1744   createElIds();
1745
1746   initDom();
1747   addEvents();
1748 }
1749
1750 // go time
1751 init();
1752
1753 // return the widget object
1754 return widget;
1755
1756 }; // end window.ChessBoard
1757
1758 // expose util functions
1759 window.ChessBoard.fenToObj = fenToObj;
1760 window.ChessBoard.objToFen = objToFen;
1761
1762 })(); // end anonymous wrapper