[
{
"path": ".eslintrc",
"content": "{\n \"root\": true,\n \"parser\": \"@typescript-eslint/parser\",\n \"plugins\": [\n \"@typescript-eslint\",\n ],\n \"extends\": [\n \"eslint:recommended\",\n \"plugin:@typescript-eslint/eslint-recommended\",\n \"plugin:@typescript-eslint/recommended\",\n \"plugin:react-hooks/recommended\"\n ],\n \"rules\": {\n '@typescript-eslint/no-unused-vars': [\n 'error', {\n argsIgnorePattern: '^_',\n varsIgnorePattern: '^_',\n caughtErrorsIgnorePattern: '^_',\n },\n ],\n 'no-unused-vars': 0,\n '@typescript-eslint/no-explicit-any': 0,\n '@typescript-eslint/ban-ts-comment': 0,\n '@typescript-eslint/no-non-null-assertion': 0,\n '@typescript-eslint/no-empty-function': 0,\n 'no-underscore-dangle': 0,\n 'arrow-parens': 0,\n 'no-nested-ternary': 0,\n 'max-classes-per-file': 0,\n 'object-curly-newline': 0,\n 'max-len': 0,\n 'prefer-destructuring': 0,\n 'no-console': 0,\n \"no-constant-condition\": 0,\n \"prefer-const\": 0,\n }\n}\n"
},
{
"path": ".github/workflows/check.yml",
"content": "on:\n push:\n branches:\n - main\n pull_request:\n branches:\n - main\nname: Check\njobs:\n check:\n runs-on: ubuntu-latest\n steps:\n - name: Use Node.js ${{ matrix.node-version }}\n uses: actions/setup-node@v3\n with:\n node-version: 18.18.2\n - uses: actions/checkout@v3\n - run: yarn\n - run: yarn run compile\n"
},
{
"path": ".github/workflows/test.yml",
"content": "on:\n push:\n branches:\n - main\n pull_request:\n branches:\n - main\nname: Check\njobs:\n check:\n runs-on: ubuntu-latest\n steps:\n - name: Use Node.js ${{ matrix.node-version }}\n uses: actions/setup-node@v3\n with:\n node-version: 18.18.2\n - uses: actions/checkout@v3\n - run: yarn\n - run: yarn test\n - run: yarn run dep-check\n"
},
{
"path": ".gitignore",
"content": "# temp files\n.DS_Store\n\\#*\n.\\#*\n\n# npm\nnode_modules\nyarn-error.log\n\n# build artifacts\n/dist\n/docs\n\ntodos.txt\nnotes.txt\n**/scratch.*\n"
},
{
"path": ".mocharc.json.ignore",
"content": "{\n \"require\": [ \"ts-node/register\" ],\n \"loader\": \"ts-node/esm\",\n \"extensions\": [\"ts\", \"tsx\"],\n \"spec\": [\n \"src/test/**\"\n ]\n}\n"
},
{
"path": ".npmignore",
"content": "!/dist"
},
{
"path": "CHANGELOG.md",
"content": "# v0.2.14\n* Game elements now have next/previous selectors to find adjacent elements in\n the same space.\n* Invalid options in selections now retain their position\n* Corrected a bug with nested follow-ups\n\n# v0.2.13\n* Game settings provided now all accept an initial default value\n (e.g. numberSetting, etc)\n* The `everyPlayer` flow now passes the currently acting player to the flow\n args, just like `eachPlayer`\n* Corrected an issue with `everyPlayer` hanging when using an array `do` block\n* Corrected a bug with `layout.haphazardly`.\n\n# v0.2.12\n* Added action#confirm as an alternate means to add confirmation prompts\n* Providing a `validate` function in a `chooseFrom` now shows invalid choices\n with error messages if clicked\n\n# v0.2.11 Hideable Space Layouts\n* Added 3 new layouts for Spaces that save screen real estate\n* `element#layoutAsDrawer` puts Space in a expandable drawer (replaces the\n drawer 'attribute' in layout)\n* `element#layoutAsTabs` puts several Spaces into a switchable layout of tabs\n* `element#layoutAsPopout` hides a Space behind a button that opens it as a\n popout modal\n\n# v0.2.10\n* Fixed Info and Debug overlays\n\n# v0.2.9\n* Removed deprecated index.scss import\n\n# v0.2.8 Stack and Flippable\n* Added Stack class for decks within hidden elements and internal moves\n* Added Flippable component with back/front and animated flips\n\n# v0.2.7 Animation overhaul\n* Overhauled the animation logic that decides how elements move for various\n players, correcting several glitches\n* Pieces now animate on to and off of the board, into and out of the bottom of\n decks even if unrendered\n\n# v0.2.6 Subflows\n* Subflows allow you to define entire new flows that branch of your main flow,\n e.g. playing a particular Card causes a set of new actions to happen\n* Follow-ups are still available but these are now actually just Subflows under\n the hood that automatically perform only a single action\n* Some small flow and animation fixes included\n\n# v0.2.5\n* Added `action.swap` to allow players to exchange Pieces\n* Added `action.reorder` to allow players to reorder a collection of Pieces\n* Also made some improvements in the dragging and moving to remove flicker and\n quirkiness\n\n# v0.2.4 Component modules\n* Added Component modules. The `D6` class is the first example and it has been\n moved into a separate self-contained import. See\n https://docs.boardzilla.io/game/modules\n* It is no longer necessary to include `@boardzilla/core/index.css` in\n `ui/index.tsx`. This line can be removed.\n* Added `actionStep.continueIfImpossible` to allow a step to be skipped if no\n actions are valid\n* Added `actionStep.repeatUntil` to make a set of actions repeatable until a\n 'pass' action\n* Added `Player.hiddenAttributes` to make some attributes hidden from other\n players\n* Some consistency fixes to prompts.\n\n# v0.2.3\n* Board Sizes now accepts more detailed matchers, with a range of \"best fit\"\n aspect ratios, a setting to choose scrollbars or letterbox and mobile\n orientation fixing\n* Show/hide methods moved to Piece only\n* Space now has new convenience methods to attach content show/hide event\n handlers\n* Space now has \"screen\" methods to make contents completely invisible to\n players\n* Added Test Runner mocks and updatePlayers\n\n# v0.2 Grids\n* Added subclasses of `Space` for various grids, including more options for\n square, hex and the brand new PieceGrid. These replace `Space#createGrid`.\n* Grids can now be shaped, e.g. to create a hex grid in a square shape\n* `PieceGrid` allows the placement and tiling of irregular shapes, with an\n extendible grid that correctly sizes shaped pieces inside it.\n* Pieces now have a `setShape` and `setEdges` for adding irregular shapes and\n labelling the cells and edges for the purposes of adjacency.\n* Connecting spaces now allows bidirectional distances\n* Generics have been given a full rework, removing lots of unnecessary generics\n and making the importing of more game classes more straightfoward and\n extendable.\n* `createGameClasses` is gone. `Space` and `Piece` can be imported directly from\n core.\n* `Game#registerClasses` is no longer necessary and can be removed.\n* `Piece#putInto` now accepts `row`, `column`.\n* Now using incremental Typescript compilation for much faster rebuilds\n* History reprocessing in development has been completely reworked for much\n better performance\n* Added a new associated starter template using PieceGrid and irregular tiles.\n\n# v0.1 Lobby\n* Brand new lobby with seating controls, allowing self-seating, async game start\n and better UI.\n* renamed `Board` to `Game` and gave this class all exposed API methods that\n were previously in `Game`. `Game` renamed to `GameManager` and intended as an\n internal class.\n"
},
{
"path": "CLA.md",
"content": "# Contributor Agreement\n\n# Individual Contributor Exclusive License Agreement\n\nThank you for your interest in contributing to Boardzilla (\"We\" or \"Us\").\n\nThe purpose of this contributor agreement (\"Agreement\") is to clarify and\ndocument the rights granted to Us by contributors to the Boardzilla core\nlibrary. To make this document effective, please contact andrew@boardzilla.io.\n\n## How to use this Contributor Agreement\n\nIf You are an employee and have created the Contribution as part of your\nemployment, You need to have Your employer approve this Agreement or sign the\nEntity version of this document. If You do not own the Copyright in the entire\nwork of authorship, any other author of the Contribution should also sign this –\nin any event, please contact Us at andrew@boardzilla.io\n\n## 1. Definitions\n\n\"You\" means the individual Copyright owner who Submits a Contribution to Us.\n\n\"Contribution\" means any original work of authorship, including any original\nmodifications or additions to an existing work of authorship, Submitted by You\nto Us, in which You own the Copyright.\n\n\"Copyright\" means all rights protecting works of authorship, including\ncopyright, moral and neighboring rights, as appropriate, for the full term of\ntheir existence.\n\n\"Material\" means the software or documentation made available by Us to third\nparties. When this Agreement covers more than one software project, the Material\nmeans the software or documentation to which the Contribution was\nSubmitted. After You Submit the Contribution, it may be included in the\nMaterial.\n\n\"Submit\" means any act by which a Contribution is transferred to Us by You by\nmeans of tangible or intangible media, including but not limited to electronic\nmailing lists, source code control systems, and issue tracking systems that are\nmanaged by, or on behalf of, Us, but excluding any transfer that is\nconspicuously marked or otherwise designated in writing by You as \"Not a\nContribution.\"\n\n\"Documentation\" means any non-software portion of a Contribution.\n\n## 2. License grant\n\n### 2.1 Copyright license to Us\n\nSubject to the terms and conditions of this Agreement, You hereby grant to Us a\nworldwide, royalty-free, Exclusive, perpetual and irrevocable (except as stated\nin Section 8.2) license, with the right to transfer an unlimited number of\nnon-exclusive licenses or to grant sublicenses to third parties, under the\nCopyright covering the Contribution to use the Contribution by all means,\nincluding, but not limited to:\n\n- publish the Contribution,\n- modify the Contribution,\n- prepare derivative works based upon or containing the Contribution and/or to\n combine the Contribution with other Materials,\n- reproduce the Contribution in original or modified form, \n- distribute, to make the Contribution available to the public, display and\n publicly perform the Contribution in original or modified form.\n\n### 2.2 Moral rights\n\nMoral Rights remain unaffected to the extent they are recognized and not\nwaivable by applicable law. Notwithstanding, You may add your name to the\nattribution mechanism customary used in the Materials you Contribute to, such as\nthe header of the source code files of Your Contribution, and We will respect\nthis attribution when using Your Contribution.\n\n### 2.3 Copyright license back to You\n\nUpon such grant of rights to Us, We immediately grant to You a worldwide,\nroyalty-free, non-exclusive, perpetual and irrevocable license, with the right\nto transfer an unlimited number of non-exclusive licenses or to grant\nsublicenses to third parties, under the Copyright covering the Contribution to\nuse the Contribution by all means, including, but not limited to:\n\n- publish the Contribution,\n- modify the Contribution,\n- prepare derivative works based upon or containing the Contribution and/or to\n combine the Contribution with other Materials,\n- reproduce the Contribution in original or modified form,\n- distribute, to make the Contribution available to the public, display and\n publicly perform the Contribution in original or modified form. This license\n back is limited to the Contribution and does not provide any rights to the\n Material.\n\n## 3. Patents\n\n### 3.1 Patent license\n\nSubject to the terms and conditions of this Agreement You hereby grant to Us and\nto recipients of Materials distributed by Us a worldwide, royalty-free,\nnon-exclusive, perpetual and irrevocable (except as stated in Section 3.2)\npatent license, with the right to transfer an unlimited number of non-exclusive\nlicenses or to grant sublicenses to third parties, to make, have made, use,\nsell, offer for sale, import and otherwise transfer the Contribution and the\nContribution in combination with any Material (and portions of such\ncombination). This license applies to all patents owned or controlled by You,\nwhether already acquired or hereafter acquired, that would be infringed by\nmaking, having made, using, selling, offering for sale, importing or otherwise\ntransferring of Your Contribution(s) alone or by combination of Your\nContribution(s) with any Material.\n\n### 3.2 Revocation of patent license\n\nYou reserve the right to revoke the patent license stated in section 3.1 if We\nmake any infringement claim that is targeted at your Contribution and not\nasserted for a Defensive Purpose. An assertion of claims of the Patents shall be\nconsidered for a \"Defensive Purpose\" if the claims are asserted against an\nentity that has filed, maintained, threatened, or voluntarily participated in a\npatent infringement lawsuit against Us or any of Our licensees.\n\n## 4. License obligations by Us\n\nWe agree to license the Contribution only under the terms of the license or\nlicenses that We are using on the Submission Date for the Material (including\nany rights to adopt any future version of a license).\n\nWe agree to license patents owned or controlled by You only to the extent\nnecessary to (sub)license Your Contribution(s) and the combination of Your\nContribution(s) with the Material under the terms of the license or licenses\nthat We are using on the Submission Date.\n\n## 5. Disclaimer\n\nTHE CONTRIBUTION IS PROVIDED \"AS IS\". MORE PARTICULARLY, ALL EXPRESS OR IMPLIED\nWARRANTIES INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTY OF SATISFACTORY\nQUALITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE EXPRESSLY\nDISCLAIMED BY YOU TO US AND BY US TO YOU. TO THE EXTENT THAT ANY SUCH WARRANTIES\nCANNOT BE DISCLAIMED, SUCH WARRANTY IS LIMITED IN DURATION AND EXTENT TO THE\nMINIMUM PERIOD AND EXTENT PERMITTED BY LAW.\n\n## 6. Consequential damage waiver\n\nTO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL YOU OR WE BE\nLIABLE FOR ANY LOSS OF PROFITS, LOSS OF ANTICIPATED SAVINGS, LOSS OF DATA,\nINDIRECT, SPECIAL, INCIDENTAL, CONSEQUENTIAL AND EXEMPLARY DAMAGES ARISING OUT\nOF THIS AGREEMENT REGARDLESS OF THE LEGAL OR EQUITABLE THEORY (CONTRACT, TORT OR\nOTHERWISE) UPON WHICH THE CLAIM IS BASED.\n\n## 7. Approximation of disclaimer and damage waiver\n\nIF THE DISCLAIMER AND DAMAGE WAIVER MENTIONED IN SECTION 5. AND\nSECTION 6. CANNOT BE GIVEN LEGAL EFFECT UNDER APPLICABLE LOCAL LAW, REVIEWING\nCOURTS SHALL APPLY LOCAL LAW THAT MOST CLOSELY APPROXIMATES AN ABSOLUTE WAIVER\nOF ALL CIVIL OR CONTRACTUAL LIABILITY IN CONNECTION WITH THE CONTRIBUTION.\n\n## 8. Term\n\n8.1 This Agreement shall come into effect upon Your acceptance of the terms and\nconditions.\n\n8.2 This Agreement shall apply for the term of the copyright and patents\nlicensed here. However, You shall have the right to terminate the Agreement if\nWe do not fulfill the obligations as set forth in Section 4. Such termination\nmust be made in writing.\n\n8.3 In the event of a termination of this Agreement Sections 5, 6, 7, 8 and 9\nshall survive such termination and shall remain in full force thereafter. For\nthe avoidance of doubt, Free and Open Source Software (sub)licenses that have\nalready been granted for Contributions at the date of the termination shall\nremain in full force after the termination of this Agreement.\n\n## 9 Miscellaneous\n\n9.1 This Agreement and all disputes, claims, actions, suits or other proceedings\narising out of this agreement or relating in any way to it shall be governed by\nthe laws of Canada excluding its private international law provisions.\n\n9.2 This Agreement sets out the entire agreement between You and Us for Your\nContributions to Us and overrides all other agreements or understandings.\n\n9.3 In case of Your death, this agreement shall continue with Your heirs. In\ncase of more than one heir, all heirs must exercise their rights through a\ncommonly authorized person.\n\n9.4 If any provision of this Agreement is found void and unenforceable, such\nprovision will be replaced to the extent possible with a provision that comes\nclosest to the meaning of the original provision and that is enforceable. The\nterms and conditions set forth in this Agreement shall apply notwithstanding any\nfailure of essential purpose of this Agreement or any limited remedy to the\nmaximum extent possible under law.\n\n9.5 You agree to notify Us of any facts or circumstances of which you become\naware that would make this Agreement inaccurate in any respect.\n\nYou\nDate: ____________________________________________________\nName: ____________________________________________________\nTitle: ____________________________________________________\nAddress: ____________________________________________________\n\nUs\nDate: ____________________________________________________\nName: ____________________________________________________\nTitle: ____________________________________________________\nAddress: ____________________________________________________\n"
},
{
"path": "CONTRIBUTING.md",
"content": "# Contributing\n\nAny open source product is only as good as the community behind it. You can\nparticipate by sharing code, ideas, or simply helping others. No matter what\nyour skill level is, every contribution counts.\n\n## Games vs Core\n\nThese contributions guidelines do not apply in any way to games submitted to the\nBoardzilla platform. **You retain full copyright for your game code and\nassets.** This only only applies to code submitted to the actual Boardzilla\ncore library.\n\n## Copyright\n\n**IMPORTANT:** By supplying code to Boardzilla core in issues and pull requests,\nyou agree to assign copyright of that code to us, on the condition that we also\nrelease that code under the AGPL license.\n\nWe ask for this so that the ownership in the license is clear and unambiguous,\nand so that community involvement doesn't stop us from being able to sustain the\nproject by releasing this code under a permissive licenses in addition to the\nopen source AGPL license. This copyright assignment won't prevent you from using\nthe code in any way you see fit.\n\nSee our [Contributor License Agreement](CLA.md) for the legal details.\n\n"
},
{
"path": "LICENSE",
"content": " GNU AFFERO GENERAL PUBLIC LICENSE\n Version 3, 19 November 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. \n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU Affero General Public License is a free, copyleft license for\nsoftware and other kinds of works, specifically designed to ensure\ncooperation with the community in the case of network server software.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nour General Public Licenses are intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n Developers that use our General Public Licenses protect your rights\nwith two steps: (1) assert copyright on the software, and (2) offer\nyou this License which gives you legal permission to copy, distribute\nand/or modify the software.\n\n A secondary benefit of defending all users' freedom is that\nimprovements made in alternate versions of the program, if they\nreceive widespread use, become available for other developers to\nincorporate. Many developers of free software are heartened and\nencouraged by the resulting cooperation. However, in the case of\nsoftware used on network servers, this result may fail to come about.\nThe GNU General Public License permits making a modified version and\nletting the public access it on a server without ever releasing its\nsource code to the public.\n\n The GNU Affero General Public License is designed specifically to\nensure that, in such cases, the modified source code becomes available\nto the community. It requires the operator of a network server to\nprovide the source code of the modified version running there to the\nusers of that server. Therefore, public use of a modified version, on\na publicly accessible server, gives the public access to the source\ncode of the modified version.\n\n An older license, called the Affero General Public License and\npublished by Affero, was designed to accomplish similar goals. This is\na different license, not a version of the Affero GPL, but Affero has\nreleased a new version of the Affero GPL which permits relicensing under\nthis license.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU Affero General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Remote Network Interaction; Use with the GNU General Public License.\n\n Notwithstanding any other provision of this License, if you modify the\nProgram, your modified version must prominently offer all users\ninteracting with it remotely through a computer network (if your version\nsupports such interaction) an opportunity to receive the Corresponding\nSource of your version by providing access to the Corresponding Source\nfrom a network server at no charge, through some standard or customary\nmeans of facilitating copying of software. This Corresponding Source\nshall include the Corresponding Source for any work covered by version 3\nof the GNU General Public License that is incorporated pursuant to the\nfollowing paragraph.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the work with which it is combined will remain governed by version\n3 of the GNU General Public License.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU Affero General Public License from time to time. Such new versions\nwill be similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU Affero General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU Affero General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU Affero General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n \n Copyright (C) \n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If your software can interact with users remotely through a computer\nnetwork, you should also make sure that it provides a way for users to\nget its source. For example, if your program is a web application, its\ninterface could display a \"Source\" link that leads users to an archive\nof the code. There are many ways you could offer source, and different\nsolutions will be better for different programs; see section 13 for the\nspecific requirements.\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU AGPL, see\n."
},
{
"path": "README.md",
"content": "👋 This is Boardzilla, a framework to make writing a digital board game easy. Boardzilla takes care of\n\n- player management\n- structuring game rules\n- persisting game & player state\n- animations\n\nand much more!\n\nVisit us at https://boardzilla.io.\n\nSee documentation at https://docs.boardzilla.io.\n\n(c)2024 Andrew Hull\n"
},
{
"path": "decl.d.ts",
"content": "declare module \"*.ogg\";\n"
},
{
"path": "esbuild.mjs",
"content": "import * as esbuild from 'esbuild'\nimport {sassPlugin} from 'esbuild-sass-plugin'\n\nawait esbuild.build({\n entryPoints: ['./src/ui/assets/index.scss'],\n assetNames: '[name]',\n bundle: true,\n format: 'esm',\n outdir: 'dist/ui/assets/',\n loader: {\n '.ogg': 'dataurl',\n '.jpg': 'file',\n },\n sourcemap: 'inline',\n plugins: [sassPlugin()],\n})\n\nawait esbuild.build({\n entryPoints: ['./src/components/d6/index.ts'],\n assetNames: '[name]',\n bundle: true,\n format: 'esm',\n outdir: 'dist/components/d6/assets/',\n loader: {\n '.ogg': 'copy',\n },\n sourcemap: 'inline',\n plugins: [sassPlugin()],\n})\n\nawait esbuild.build({\n entryPoints: ['./src/components/flippable/index.ts'],\n assetNames: '[name]',\n bundle: true,\n format: 'esm',\n outdir: 'dist/components/flippable/assets/',\n sourcemap: 'inline',\n plugins: [sassPlugin()],\n})\n"
},
{
"path": "package.json",
"content": "{\n \"name\": \"@boardzilla/core\",\n \"version\": \"0.2.14\",\n \"author\": \"Andrew Hull \",\n \"license\": \"AGPL-3.0\",\n \"scripts\": {\n \"clean\": \"rm -rf dist docs\",\n \"build\": \"yarn build:test && rm -rf dist/test\",\n \"prepublish\": \"git diff-index --quiet HEAD || (echo 'git unclean' && exit 1)\",\n \"prepack\": \"./scripts/prepack\",\n \"postpack\": \"./scripts/postpack\",\n \"build:test\": \"yarn assets && yarn compile && find dist/ -type f|grep js$|xargs grep -l scss|xargs sed -i~ 's/\\\\.scss/.css/g' && find dist/ -type f|grep js~$|xargs rm\",\n \"assets\": \"node esbuild.mjs\",\n \"test\": \"NODE_ENV=test yarn run build:test && mocha src/test/setup.js dist/test/*_test.js\",\n \"test:debug\": \"NODE_ENV=test yarn run build:test && mocha --inspect-brk --timeout 3600000 src/test/setup-debug.js dist/test/*_test.js\",\n \"compile\": \"tsc\",\n \"docs\": \"typedoc\",\n \"lint\": \"eslint . --ext .ts\",\n \"dep-check\": \"dpdm --no-warning --no-tree -T ./src/index.ts\"\n },\n \"type\": \"module\",\n \"exports\": {\n \".\": \"./entry/index.js\",\n \"./components\": \"./entry/components/index.js\"\n },\n \"files\": [\n \"entry/**/*\"\n ],\n \"types\": \"entry/index.d.ts\",\n \"sideEffects\": [\n \"./src/ui/assets/index.scss\"\n ],\n \"dependencies\": {\n \"classnames\": \"^2.3.1\",\n \"graphology\": \"^0.25.4\",\n \"graphology-shortest-path\": \"^2.0.2\",\n \"graphology-traversal\": \"^0.3.1\",\n \"graphology-types\": \"^0.24.7\",\n \"random-seed\": \"^0.3.0\",\n \"react\": \"^18.2\",\n \"react-color\": \"^2.19.3\",\n \"react-dom\": \"^18.2\",\n \"react-draggable\": \"^4.4.5\",\n \"uuid-random\": \"^1.3.2\",\n \"zustand\": \"^4.4.0\"\n },\n \"devDependencies\": {\n \"@types/chai\": \"^4.3.1\",\n \"@types/chai-spies\": \"^1.0.3\",\n \"@types/jest\": \"^28.1.4\",\n \"@types/node\": \"^20.6.2\",\n \"@types/random-seed\": \"^0.3.3\",\n \"@types/react\": \"^18.2.25\",\n \"@types/react-color\": \"^3.0.6\",\n \"@types/react-dom\": \"^18.2.14\",\n \"@typescript-eslint/eslint-plugin\": \"^6.9.1\",\n \"@typescript-eslint/parser\": \"^6.9.1\",\n \"chai\": \"^4.3.8\",\n \"chai-spies\": \"^1.0.0\",\n \"dpdm\": \"^3.14.0\",\n \"esbuild\": \"^0.19.5\",\n \"esbuild-sass-plugin\": \"^2.16.0\",\n \"eslint\": \"^8.53.0\",\n \"eslint-plugin-react-hooks\": \"^4.6.0\",\n \"mocha\": \"^10.2.0\",\n \"ts-node\": \"^10.8.2\",\n \"typedoc\": \"^0.25.2\",\n \"typedoc-plugin-markdown\": \"^3.17.1\",\n \"typedoc-plugin-merge-modules\": \"^5.1.0\",\n \"typescript\": \"^5.2.0\"\n },\n \"typedocOptions\": {\n \"entryPoints\": [\n \"src\",\n \"src/game.ts\",\n \"src/board\",\n \"src/flow\",\n \"src/action\",\n \"src/player\",\n \"src/ui\"\n ],\n \"plugin\": [\n \"typedoc-plugin-markdown\",\n \"typedoc-plugin-merge-modules\"\n ],\n \"sort\": \"source-order\",\n \"categorizeByGroup\": false,\n \"excludeInternal\": true,\n \"excludeNotDocumented\": true,\n \"out\": \"docs\",\n \"name\": \"@boardzilla/core\"\n }\n}\n"
},
{
"path": "scripts/postpack",
"content": "#!/bin/bash\nset -e\n\nrm -r entry\nln -s src entry\n"
},
{
"path": "scripts/prepack",
"content": "#!/bin/bash\nset -e\n\nyarn clean\nyarn build\nrm -r entry\nmv dist entry\n"
},
{
"path": "src/action/action.ts",
"content": "import Selection from './selection.js';\nimport GameElement from '../board/element.js';\nimport Piece from '../board/piece.js';\nimport ElementCollection from '../board/element-collection.js';\nimport { n } from '../utils.js';\n\nimport type { ResolvedSelection, BoardQueryMulti } from './selection.js';\nimport type { Game, PieceGrid } from '../board/index.js';\nimport type { Player } from '../player/index.js';\nimport type { default as GameManager, ActionDebug, PendingMove } from '../game-manager.js';\n\n/**\n * A single argument\n * @category Actions\n */\nexport type SingleArgument = string | number | boolean | GameElement | Player;\n\n/**\n * An argument that can be added to an {@link Action}. Each value is chosen by\n * player or in some cases passed from a previous action. Arguments can be:\n * - a number\n * - a string\n * - a boolean\n * - a {@link GameElement}\n * - a {@link Player}\n * - an array of one these in the case of a multi-choice selection\n * @category Actions\n */\nexport type Argument = SingleArgument | SingleArgument[];\n\n/**\n * A follow-up action\n * @category Actions\n */\nexport type ActionStub = {\n /**\n * The name of the action, as defined in `{@link Game#defineactions}`.\n */\n name: string,\n /**\n * The player to take this action, if different than the current player\n */\n player?: Player,\n /**\n * Action prompt. If specified, overrides the `action.prompt` in `{@link\n * Game#defineactions}`.\n */\n prompt?: string,\n /**\n * Description of taking the action from a 3rd person perspective,\n * e.g. \"choosing a card\". The string will be automatically prefixed with the\n * player name and appropriate verb (\"is/are\"). If specified, this will be\n * used to convey to non-acting players what actions are happening.\n */\n description?: string,\n /**\n * An object containing arguments to be passed to the follow-up action. This\n * is useful if there are multiple ways to trigger this follow-up that have\n * variations.\n */\n args?: Record\n}\n\ntype Group = Record[1]?] |\n ['select', Parameters[1], Parameters[2]?] |\n ['text', Parameters[1]?]\n>\n\ntype ExpandGroup, R extends Group> = A & {[K in keyof R]:\n R[K][0] extends 'number' ? number :\n R[K][0] extends 'text' ? string :\n R[K][0] extends 'select' ? (R[K][1] extends Parameters>[1] ? E : never) :\n never\n}\n\n/**\n * Actions represent discreet moves players can make. These contain the choices\n * needed to take this action and the results of the action. Create Actions\n * using the {@link Game#action} function. Actions are evaluated at the time the\n * player has the option to perform the action, so any expressions that involve\n * game state will reflect the state at the time the player is performing the\n * action.\n *\n * @privateRemarks\n * The Action object is responsible for:\n * - providing Selection objects to players to aid in supplying appropriate Arguments\n * - validating player Arguments and returning any Selections needed to complete\n * - accepting player Arguments and altering board state\n *\n * @category Actions\n */\nexport default class Action = NonNullable> {\n name?: string;\n prompt?: string;\n description?: string;\n selections: Selection[] = [];\n moves: ((args: Record) => any)[] = [];\n condition?: ((args: A) => boolean) | boolean;\n messages: {text: string, args?: Record | ((a: A) => Record), position?: number}[] = [];\n order: ('move' | 'message')[] = [];\n mutated = false;\n\n gameManager: GameManager;\n\n constructor({ prompt, description, condition }: {\n prompt?: string,\n description?: string,\n condition?: ((args: A) => boolean) | boolean,\n }) {\n this.prompt = prompt;\n this.description = description;\n this.condition = condition;\n }\n\n isPossible(args: A): boolean {\n return typeof this.condition === 'function' ? this.condition(args) : this.condition ?? true;\n }\n\n // given a set of args, return sub-selections possible trying each possible next arg\n // return undefined if these args are impossible\n // return 0-length if these args are submittable\n // return array of follow-up selections if incomplete\n // skipping/expanding is very complex and this method runs all the rules for what should/must be combined, either as additional selections or as forced args\n // skippable options will still appear in order to present the choices to the user to select that tree. This will be the final selection if no other selection turned skipping off\n // TODO memoize\n _getPendingMoves(args: Record, debug?: ActionDebug): PendingMove[] | undefined {\n if (debug) {\n debug[this.name!] = { args: {} };\n for (const arg of Object.keys(args)) debug[this.name!].args[arg] = 'sel';\n }\n const moves = this._getPendingMovesInner(args, debug);\n // resolve any combined selections now with only args up until first choice\n if (moves?.length) {\n for (const move of moves) {\n if (debug) {\n debug[move.name].args[move.selections[0].name] = 'ask';\n }\n const combineWith = move.selections[0].clientContext?.combineWith; // guaranteed single selection\n let confirm: Selection['confirm'] | undefined = move.selections[0].confirm;\n let validation: Selection['validation'] | undefined = move.selections[0].validation;\n // look ahead for any selections that can/should be combined\n for (let i = this.selections.findIndex(s => s.name === move.selections[0].name) + 1; i !== this.selections.length; i++) {\n if (confirm) break; // do not skip an explicit confirm\n let selection: Selection | ResolvedSelection = this.selections[i];\n if (combineWith?.includes(selection.name)) selection = selection.resolve(move.args);\n if (!selection.isResolved()) break;\n const arg = selection.isForced();\n if (arg !== undefined) { // forced future args are added here to shorten the form and pre-prompt any confirmation\n move.args[selection.name] = arg;\n if (debug) {\n debug[move.name].args[selection.name] = 'forced';\n }\n } else if (combineWith?.includes(selection.name)) { // future combined selections are added as well\n move.selections.push(selection);\n if (debug) {\n debug[move.name].args[selection.name] = 'ask';\n }\n } else {\n break;\n }\n confirm = selection.confirm ?? confirm; // find latest confirm for the overall combination\n validation = selection.validation ?? validation;\n }\n if (confirm) move.selections[0].confirm = confirm; // and put it on top\n if (validation) move.selections[move.selections.length - 1].validation = validation; // on bottom\n }\n }\n return moves;\n }\n\n _getPendingMovesInner(args: Record, debug?: ActionDebug): PendingMove[] | undefined {\n let selection = this._nextSelection(args);\n if (!selection) return [];\n\n const move = {\n name: this.name!,\n prompt: this.prompt,\n description: this.description,\n args,\n selections: [selection]\n };\n\n if (!selection.isPossible()) {\n if (debug) {\n debug[this.name!].args[selection.name] ??= 'imp';\n }\n return;\n }\n if (!selection.isUnbounded()) {\n let possibleOptions: { choice: SingleArgument, error?: string, label?: string }[] = [];\n let anyValidOption = false;\n let pruned = false;\n let pendingMoves: PendingMove[] = [];\n let hasCompleteMove = false\n for (const option of selection.options()) {\n const allArgs = {...args, [selection.name]: option.choice};\n if (selection.validation && !selection.isMulti()) {\n const error = this._withDecoratedArgs(allArgs as A, args => selection!.error(args))\n if (error) {\n pruned = true;\n option.error = error;\n possibleOptions.push(option as { choice: SingleArgument, error?: string, label?: string })\n continue;\n }\n }\n const submoves = this._getPendingMovesInner(allArgs, debug);\n if (submoves === undefined) {\n pruned = true;\n } else {\n if (!selection.isMulti()) possibleOptions.push(option as { choice: SingleArgument, error?: string, label?: string });\n anyValidOption ||= true;\n hasCompleteMove ||= submoves.length === 0;\n pendingMoves = pendingMoves.concat(submoves);\n }\n }\n if (!anyValidOption) {\n if (debug) {\n debug[this.name!].args[selection.name] = 'tree';\n }\n return undefined;\n }\n if (pruned && !selection.isMulti()) {\n selection.resolvedChoices = possibleOptions;\n }\n\n // return the next selection(s) if skipIf, provided it exists for all possible choices\n // special case: do not skip \"apparent\" choices in group even if they are ultimately forced, in order to best present the limited options\n if (pendingMoves.length && (\n ((selection.skipIf === 'always' || selection.skipIf === true) && !hasCompleteMove) ||\n selection.skipIf === 'only-one' && possibleOptions.length === 1 && (!selection.clientContext?.combineWith || selection.options().length <= 1)\n )) {\n if (debug) {\n debug[this.name!].args[selection.name] = selection.skipIf === true ? 'skip' : selection.skipIf;\n }\n return pendingMoves;\n }\n }\n if (debug && (debug[this.name!].args[selection.name] ?? 'imp') === 'imp') {\n debug[this.name!].args[selection.name] ??= 'future';\n }\n\n return [move];\n }\n\n /**\n * given a partial arg list, returns a selection object for continuation if one exists.\n * @internal\n */\n _nextSelection(args: Record): ResolvedSelection | undefined {\n let nextSelection: ResolvedSelection | undefined = undefined;\n for (const s of this.selections) {\n const selection = s.resolve(args);\n if (selection.skipIf === true) continue;\n if (!(s.name in args)) {\n nextSelection = selection;\n break;\n }\n }\n return nextSelection;\n }\n\n /**\n * process this action with supplied args. returns error if any\n * @internal\n */\n _process(player: Player, args: Record): string | undefined {\n // truncate invalid args - is this needed?\n let error: string | undefined = undefined;\n if (!this.isPossible(args as A)) return `${this.name} action not possible`;\n for (const selection of this.selections) {\n if (args[selection.name] === undefined) {\n const arg = selection.resolve(args).isForced()\n if (arg) args[selection.name] = arg;\n }\n\n error = this._withDecoratedArgs(args as A, args => selection.error(args))\n if (error) {\n console.error(`Invalid choice for ${selection.name}. Got \"${args[selection.name]}\" ${error}`);\n break;\n }\n }\n if (error) return error;\n\n // revalidate on server. quite expensive. easier way? I think this might just be counting the args since the validation already passed ^^\n if (!globalThis.window) {\n const pendingMoves = this._getPendingMoves(args);\n if (!pendingMoves) {\n console.error('attempted to process invalid args', this.name, args);\n return error || 'unknown error during action._process';\n }\n if (pendingMoves.length) {\n return error || 'incomplete action';\n }\n }\n\n let moveIndex = 0;\n let messageIndex = 0;\n for (const seq of this.order) {\n if (seq === 'move') {\n this.moves[moveIndex++](args);\n } else {\n const message = this.messages[messageIndex++];\n const messageArgs = ((typeof message.args === 'function') ? message.args(args as A) : message.args);\n if (message.position) {\n this.gameManager.game.messageTo(message.position, message.text, {...args, player, ...messageArgs});\n } else {\n this.gameManager.game.message(message.text, {...args, player, ...messageArgs});\n }\n }\n }\n }\n\n _addSelection(selection: Selection) {\n if (this.selections.find(s => s.name === selection.name)) throw Error(`Duplicate selection name on action: ${selection.name}`);\n if (this.mutated) console.warn(`Adding a choice (\"${selection.name}\") after behavior in action is valid but players will need to perform the choices before the behavior.`);\n this.selections.push(selection);\n return selection;\n }\n\n // fn must be idempotent\n _withDecoratedArgs(args: A, fn: (args: A) => any) {\n if (args['__placement__']) {\n const placementSelection = this.selections.find(s => s.name === '__placement__');\n if (placementSelection && args[placementSelection.placePiece!]) {\n args = {...args};\n // temporarily set piece to place to access position properties\n const placePiece = (args[placementSelection.placePiece!] as Piece);\n const { row, column, _rotation } = placePiece;\n const [newColumn, newRow, newRotation] = args['__placement__'] as [number, number, number?];\n placePiece.column = newColumn;\n placePiece.row = newRow;\n placePiece.rotation = newRotation ?? 0;\n const result = fn(args);\n placePiece.column = column;\n placePiece.row = row;\n placePiece._rotation = _rotation;\n return result;\n }\n }\n return fn(args);\n }\n\n _getError(selection: ResolvedSelection, args: A) {\n return this._withDecoratedArgs(args, args => selection.error(args));\n }\n\n _getConfirmation(selection: ResolvedSelection, args: A) {\n if (!selection.confirm) return;\n const argList = selection.confirm[1];\n return n(\n selection.confirm[0],\n {...args, ...(typeof argList === 'function' ? this._withDecoratedArgs(args, argList) : argList)}\n );\n }\n\n /**\n * Add behaviour to this action to alter game state. After adding the choices\n * to an action, calling `do` causes Boardzilla to use the player choices to\n * actually do something with those choices. Call this method after all the\n * methods for player choices so that the choices are properly available to\n * the `do` function.\n *\n * @param move - The action to perform. This function accepts one argument\n * with key-value pairs for each choice added to the action using the provided\n * names.\n *\n * @example\n * player => action({\n * prompt: 'Take resources',\n * }).chooseFrom({\n * 'resource', ['lumber', 'steel'],\n * { prompt: 'Select resource' }\n * }).chooseNumber(\n * 'amount', {\n * prompt: 'Select amount',\n * max: 3\n * }).do(({ resource, amount }) => {\n * // the choices are automatically passed in with their proper type\n * game.firstN(amount, Resource, {resource}).putInto(\n * player.my('stockPile')\n * );\n * })\n * @category Behaviour\n */\n do(move: (args: A) => any): Action {\n this.mutated = true;\n this.moves.push(move);\n this.order.push('move');\n return this;\n }\n\n /**\n * Add a message to this action that will be broadcast in the chat. Call this\n * method after all the methods for player choices so that the choices are\n * properly available to the `message` function. However the message should be\n * called before or after any `do` behaviour depending on whether you want the\n * message to reflect the game state before or after the move is performs. The\n * action's `message` and `do` functions can be intermixed in this way to\n * generate messages at different points int the execution of a move.\n *\n * @param text - The text of the message to send. This can contain interpolated\n * strings with double braces just as when calling {@link Game#message}\n * directly. However when using this method, the player performing the action,\n * plus any choices made in the action are automatically made available.\n *\n * @param args - If additional strings are needed in the message besides\n * 'player' and the player choices, these can be specified here. This can also\n * be specified as a function that accepts the player choices and returns\n * key-value pairs of strings for interpolation.\n *\n * @example\n * action({\n * prompt: 'Say something',\n * }).enterText({\n * 'message',\n * }).message(\n * '{{player}} said {{message}}' // no args needed\n * ).message(\n * \"I said, {{player}} said {{loudMessage}}\",\n * ({ message }) => ({ loudMessage: message.toUpperCase() })\n * )\n * @category Behaviour\n */\n message(text: string, args?: Record | ((a: A) => Record)) {\n this.messages.push({text, args});\n this.order.push('message');\n return this;\n }\n\n /**\n * Add a message to this action that will be broadcast in the chat to the\n * specified player(s). Call this method after all the methods for player\n * choices so that the choices are properly available to the `message`\n * function. However the message should be called before or after any `do`\n * behaviour depending on whether you want the message to reflect the game\n * state before or after the move is performs. The action's `message` and `do`\n * functions can be intermixed in this way to generate messages at different\n * points int the execution of a move.\n *\n * @param player - Player or players to receive the message\n *\n * @param text - The text of the message to send. This can contain interpolated\n * strings with double braces just as when calling {@link Game#message}\n * directly. However when using this method, the player performing the action,\n * plus any choices made in the action are automatically made available.\n *\n * @param args - If additional strings are needed in the message besides\n * 'player' and the player choices, these can be specified here. This can also\n * be specified as a function that accepts the player choices and returns\n * key-value pairs of strings for interpolation.\n *\n * @example\n * action({\n * prompt: 'Say something',\n * }).enterText({\n * 'message',\n * }).message(\n * '{{player}} said {{message}}' // no args needed\n * ).message(\n * \"I said, {{player}} said {{loudMessage}}\",\n * ({ message }) => ({ loudMessage: message.toUpperCase() })\n * )\n * @category Behaviour\n */\n messageTo(player: (Player | number) | (Player | number)[], text: string, args?: Record | ((a: A) => Record)) {\n if (!(player instanceof Array)) player = [player];\n for (const p of player) {\n this.messages.push({position: typeof p === 'number' ? p : p.position, text, args});\n this.order.push('message');\n }\n return this;\n }\n\n /**\n * Add a choice to this action from a list of options. These choices will be\n * displayed as buttons in the UI.\n *\n * @param name - The name of this choice. This name will be used in all\n * functions that accept the player's choices\n *\n * @param choices - An array of choices. This may be an array of simple values\n * or an array of objects in the form: `{ label: string, choice: value }`\n * where value is the actual choice that will be passed to the rest of the\n * action, but label is the text presented to the player that they will be\n * prompted to click. Use the object style when you want player text to\n * contain additional logic or differ in some way from the choice, similiar to\n * `` in HTML. This can also be a\n * function that returns the choice array. This function will accept arguments\n * for each choice the player has made up to this point in the action.\n *\n * @param {Object} options\n * @param options.prompt - Prompt displayed to the user for this choice.\n * @param options.skipIf - One of 'always', 'never' or 'only-one' or a\n * function returning a boolean. (Default 'only-one').\n *\n *