board-game-engine 0.0.7 → 0.0.9

package/playwright.config.cjs

@@ -0,0 +1,23 @@
+const { devices } = require('@playwright/test')
+
+const PORT = 5174
+
+module.exports = {
+  testDir: 'e2e',
+  fullyParallel: false,
+  forbidOnly: !!process.env.CI,
+  retries: process.env.CI ? 2 : 0,
+  workers: 1,
+  reporter: 'html',
+  use: {
+    baseURL: `http://localhost:${PORT}`,
+    trace: 'on-first-retry',
+    viewport: { width: 800, height: 600 },
+  },
+  projects: [{ name: 'firefox', use: { ...devices['Desktop Firefox'] } }],
+  webServer: {
+    command: `npx http-server . -p ${PORT} -c-1`,
+    url: `http://localhost:${PORT}`,
+    reuseExistingServer: !process.env.CI,
+  },
+}

package/src/client/client.js

@@ -15,14 +15,13 @@ import createPayload from '../utils/create-payload.js';
 export class Client {
   constructor (options) {
     this.options = options
-    this.moveBuilder = {
-      targets: [],
-      stepIndex: 0,
-      eliminatedMoves: []
-    }
-    this.optimisticWinner = null
-    this.game = options.game
+    this.game = options.boardgameIOGame
       || gameFactory(JSON.parse(options.gameRules), options.gameName)
+
+    if (!options.boardgameIOGame) {
+      this.moveBuilder = { targets: [], stepIndex: 0, eliminatedMoves: [] }
+      this.optimisticWinner = null
+    }
   }
 
   connect () {
@@ -56,7 +55,8 @@ export class Client {
       this.client.start()
       return this
     } catch (error) {
-      console.error('Failed to join game:', error)
+      console.error('Failed to join game:', error?.message ?? error)
+      if (error?.stack) console.error(error.stack)
     }
   }
 
@@ -65,38 +65,45 @@ export class Client {
   }
 
   getState () {
-    let state
-    let moves
-    let gameover
-
     const clientState = this.client?.getState()
+    if (!clientState) return {}
 
-    if (clientState) {
-      state = {
-        ...clientState,
-        G: deserialize(JSON.stringify(clientState.G), registry),
-        originalG: clientState.G,
+    if (this.options.boardgameIOGame) {
+      return {
+        state: clientState,
+        gameover: clientState?.ctx?.gameover,
+        moves: this.client.moves,
       }
+    }
 
-      gameover = state?.ctx?.gameover
-
-      moves = !gameover
-        ? Object.entries(getCurrentMoves(state, this.client)).reduce((acc, [moveName, rawMove]) => {
-            const move = (payload) => {
-              this.client.moves[moveName](preparePayload(payload))
-            }
-            move.moveInstance = rawMove.moveInstance
-            return { ...acc, [moveName]: move }
-          }, {})
-        : []
+    const state = {
+      ...clientState,
+      G: deserialize(JSON.stringify(clientState.G), registry),
+      originalG: clientState.G,
     }
 
-    const { allClickable, possibleMoveMeta } = getPossibleMoves(state, moves, this.moveBuilder)
+    const gameover = state?.ctx?.gameover
+
+    const moves = !gameover
+      ? Object.entries(getCurrentMoves(state, this.client)).reduce((acc, [moveName, rawMove]) => {
+          const move = (payload) => {
+            this.client.moves[moveName](preparePayload(payload))
+          }
+          move.moveInstance = rawMove.moveInstance
+          return { ...acc, [moveName]: move }
+        }, {})
+      : []
+
+    const possibleMoves = getPossibleMoves(state, moves, this.moveBuilder)
+    const allClickable = possibleMoves.allClickable
+    const possibleMoveMeta = possibleMoves.possibleMoveMeta
 
     return { state, gameover, moves, allClickable, possibleMoveMeta }
   }
 
   doStep (_target) {
+    if (this.options.boardgameIOGame) return
+
     const { state, moves, possibleMoveMeta } = this.getState()
 
     const target = _target.abstract
@@ -141,12 +148,14 @@ export class Client {
   }
 
   reset () {
+    if (this.options.boardgameIOGame) return
     this.moveBuilder = { targets: [], stepIndex: 0, eliminatedMoves: [] };
     this.optimisticWinner = null
     this.update()
   }
 
   undoStep () {
+    if (this.options.boardgameIOGame) return
     if (this.moveBuilder.targets.length) {
       this.moveBuilder = {
         targets: this.moveBuilder.targets.slice(0, -1),

package/src/game-factory/bank/bank.js

@@ -12,7 +12,7 @@ class Bank {
   }
 
   createEntity (definition = {}, options) {
-    const entity = new (registry[definition.type || 'Entity'])(
+    const entity = new (registry[definition.entityType || 'Entity'])(
       {
         bank: this,
         fromBank: true,

package/src/game-factory/condition/is-full-condition.js

@@ -3,7 +3,7 @@ import Condition from "./condition.js";
 export default class IsFull extends Condition {
   checkCondition(bgioArguments, rule, payload, context) {
     return {
-      conditionIsMet: payload.target.spaces.every(space => space.entities.length)
+      conditionIsMet: payload.target.spaces.every(space => space?.entities.length)
     };
   }
 }

package/src/game-factory/condition/would-condition.js

@@ -17,7 +17,7 @@ export default class WouldCondition extends Condition {
     const payload = {
       arguments: targets.reduce((acc, target, i) => ({
         ...acc,
-        [argNameMap[context.moveInstance.rule.type][i]]: target
+        [argNameMap[context.moveInstance.rule.moveType][i]]: target
       }), {})
     }
 

package/src/game-factory/expand-game-rules.js

@@ -21,11 +21,11 @@ import transformJSON from "../utils/json-transformer.js";
 // want to treat as first-class citizens
 const invariantEntities = [
   {
-    type: "Space",
+    entityType: "Space",
     count: "Infinity",
   },
   {
-    type: "Board",
+    entityType: "Board",
     name: 'sharedBoard'
   },
   {
@@ -51,7 +51,7 @@ function expandInitialPlacements (rules, entities) {
 
   if (rules.personalBoard) {
     entities.push({
-      type: "Board",
+      entityType: "Board",
       name: 'personalBoard',
       perPlayer: true
     })
@@ -75,7 +75,7 @@ function expandInitialPlacements (rules, entities) {
       
       if (placement.destination.name === 'personalBoard') {
         return {
-          type: 'ForEach',
+          moveType: 'ForEach',
           arguments: {
             targets: {
               type: 'ctxPath',
@@ -83,7 +83,7 @@ function expandInitialPlacements (rules, entities) {
             }
           },
           move: {
-            type: 'PlaceNew',
+            moveType: 'PlaceNew',
             entity: {
               state,
               conditions: [{
@@ -120,7 +120,7 @@ function expandInitialPlacements (rules, entities) {
         }
       } else {
         return {
-          type: 'PlaceNew',
+          moveType: 'PlaceNew',
           entity: {
             state,
             conditions: [{
@@ -145,12 +145,7 @@ function expandInitialPlacements (rules, entities) {
   }
 }
 
-const keyMappings = [
-  ['thatMatches', 'conditions'],
-  ['entityType', 'type'],
-  ['moveType', 'type'],
-  ['endConditions', 'endIf'],
-]
+const keyMappings = []
 
 const simpleReplacements = [
   [

package/src/game-factory/move/move-factory.js

@@ -62,7 +62,7 @@ function revivePayload (serializablePayload, G) {
 }
 
 export function getMoveInstance (moveRule) {
-  switch (moveRule.type) {
+  switch (moveRule.moveType) {
     case 'MoveEntity':
       return new MoveEntity(moveRule);
     case 'PlaceNew':

package/src/game-factory/space-group/space-group.js

@@ -8,7 +8,7 @@ export default class SpaceGroup extends Entity {
 
   makeSpaces (bank) {
     return Array(this.getSpacesCount()).fill()
-      .map((_, i) => bank.createEntity({ type: 'Space', index: i }))
+      .map((_, i) => bank.createEntity({ entityType: 'Space', index: i }))
   }
 
   getEmptySpaces() {

package/src/index.js

@@ -1,2 +1,2 @@
-export { Client } from './client/client'
 export { default as gameFactory } from './game-factory/game-factory'
+export { Client } from './client/client'

package/src/utils/get-steps.js

@@ -9,7 +9,7 @@ const argNamesMap = {
 
 // this might not be where special handling for setstate wants to live
 export default function getSteps (bgioState, moveRule) {
-  return argNamesMap[moveRule.type]
+  return argNamesMap[moveRule.moveType]
     .filter(argName => moveRule.arguments[argName].playerChoice)
     .map(argName => ({
       argName,

package/test-results/.last-run.json

@@ -0,0 +1,4 @@
+{
+  "status": "passed",
+  "failedTests": []
+}

package/babel.config.js

@@ -1,6 +0,0 @@
-// only used for jest
-module.exports = {
-  presets: [
-    ['@babel/preset-env', { targets: { node: 'current' } }]
-  ]
-}

package/board-game-engine.test.js

@@ -1,7 +0,0 @@
-/* eslint-env jest */
-
-describe('functional test', () => {
-  test('should have a test', () => {
-    expect(true).toBe(true)
-  })
-})

package/jest.config.js

@@ -1,21 +0,0 @@
-module.exports = {
-  testEnvironment: 'node',
-  transform: {
-    '^.+\\.(js|ts)$': ['babel-jest', {
-      presets: [
-        '@babel/preset-typescript',
-        ['@babel/preset-env', {
-          modules: 'cjs',
-          targets: { node: 'current' }
-        }]
-      ],
-      plugins: ['add-module-exports']
-    }]
-  },
-  clearMocks: true,
-  moduleFileExtensions: ['js', 'ts', 'json'],
-  testMatch: [
-    '**/__tests__/**/*.(js|ts)',
-    '**/*.(test|spec).(js|ts)'
-  ]
-}

package/tic-tac-toe-verbose.json

@@ -1,54 +0,0 @@
-{
-  "playerCountRange": [2, 2],
-  "sharedBoard": {
-    "grid": {
-      "type": "grid",
-      "width": 3,
-      "height": 3
-    }
-  },
-  "pieces": [
-    {
-      "name": "playerMarker",
-      "perPlayer": true
-    }
-  ],
-  "winCondition": {
-    "type": "bingo",
-    "boardPath": ["sharedBoard", "grid"],
-    "piece": {
-      "name": "playerMarker"
-    }
-  },
-  "round": {
-    "loopUntil": false,
-    "phases": [
-      {
-        "type": "sequentialPlayerTurn",
-        "actions": [
-          {
-            "type": "movePiece",
-            "piece": {
-              "name": "playerMarker"
-            },
-            "from": "player",
-            "to": ["sharedBoard", "grid"],
-            "conditions": [
-              {
-                "type": "doesNotContain",
-                "piece": "any"
-              }
-            ]
-          }
-        ]
-      }
-    ]
-  },
-  "drawCondition": {
-    "type": "blackout",
-    "boardPath": ["sharedBoard", "grid"],
-    "piece": {
-      "name": "playerMarker"
-    }
-  }
-}