Extract commands into a dedicated package

packages/command/package.json

@@ -31,6 +31,7 @@
   },
   "dependencies": {
     "@wimaengine/app": "0.3.0",
+    "@wimaengine/core": "0.3.0",
     "@wimaengine/ecs": "0.3.0"
   },
   "types": "./dist/index.d.ts"

packages/command/src/core/command.js

@@ -1,4 +1,4 @@
-import { World } from '@wimaengine/ecs'
+/** @import { World } from '@wimaengine/ecs' */
 
 export class Command {
 

packages/command/src/index.js

@@ -1,4 +1,5 @@
 export * from './plugin'
 export * from './core'
 export * from './resources'
+export * from './systems'
 export * from './typedef'

packages/command/src/plugin.js

@@ -1,5 +1,8 @@
-import { App, Plugin } from '@wimaengine/app'
+/** @import { App } from '@wimaengine/app' */
+import { Plugin } from '@wimaengine/app'
+import { AppSchedule, CoreSystems } from '@wimaengine/core'
 import { CommandQueue } from './resources'
+import { executeCommands } from './systems'
 
 export class CommandsPlugin extends Plugin {
 
@@ -9,5 +12,15 @@ export class CommandsPlugin extends Plugin {
   register(app) {
     app
       .setResource(new CommandQueue())
+      .registerSystem({
+        schedule: AppSchedule.Startup,
+        systemGroup: CoreSystems.End,
+        system: executeCommands
+      })
+      .registerSystem({
+        schedule: AppSchedule.Update,
+        systemGroup: CoreSystems.End,
+        system: executeCommands
+      })
   }
 }

packages/core/src/systems/commands.js → packages/command/src/systems/commands.js

@@ -1,5 +1,5 @@
-import { CommandQueue } from '@wimaengine/command'
-import { World } from '@wimaengine/ecs'
+/** @import { World } from '@wimaengine/ecs' */
+import { CommandQueue } from '../resources'
 
 /**
  * @param {World} world

packages/command/src/systems/index.js

@@ -0,0 +1 @@
+export * from './commands'

packages/command/tests/executecommands.test.js

@@ -0,0 +1,31 @@
+import { strictEqual } from 'node:assert'
+import { describe, test } from 'vitest'
+import { Command, CommandQueue, executeCommands } from '@wimaengine/command'
+import { World } from '@wimaengine/ecs'
+
+class TestCommand extends Command {
+  /**
+   * @param {World} world
+   */
+  execute(world) {
+    world.setResource(new TestResource())
+  }
+}
+
+class TestResource { }
+
+describe('Testing `executeCommands`', () => {
+  test('drains and executes queued commands', () => {
+    const world = new World()
+    const queue = new CommandQueue()
+    const command = new TestCommand()
+
+    queue.add(command)
+    world.setResource(queue)
+
+    executeCommands(world)
+
+    strictEqual(world.hasResource(TestResource), true)
+    strictEqual(queue.size(), 0)
+  })
+})

packages/commands/index.js

@@ -0,0 +1 @@
+export * from './src'

packages/commands/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@wimaengine/commands",
+  "description": "Wima engine high-level commands package.",
+  "version": "0.3.0",
+  "type": "module",
+  "license": "SEE LICENSE in LICENSE.txt",
+  "author": "Wima engine contributors",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wimaengine/wima.git"
+  },
+  "homepage": "https://wimaengine.org",
+  "bugs": {
+    "url": "https://github.com/wimaengine/wima/issues"
+  },
+  "main": "./dist/index.umd.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.module.js",
+      "require": "./dist/index.umd.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "vite build --config ../../.config/vite.config.js",
+    "test": "vitest run --dir tests --passWithNoTests",
+    "types": "tsc -p ./tsc.type.json"
+  },
+  "dependencies": {
+    "@wimaengine/command": "0.3.0",
+    "@wimaengine/ecs": "0.3.0",
+    "@wimaengine/logger": "0.3.0",
+    "@wimaengine/type": "0.3.0"
+  },
+  "types": "./dist/index.d.ts"
+}

packages/core/src/commands/addresource.js → packages/commands/src/commands/addresource.js

@@ -1,5 +1,5 @@
+/** @import { World } from '@wimaengine/ecs' */
 import { Command } from '@wimaengine/command'
-import { World } from '@wimaengine/ecs'
 
 export class AddResourceCommand extends Command {
 

packages/core/src/commands/despawn.js → packages/commands/src/commands/despawn.js

@@ -1,6 +1,5 @@
-/** @import { EntityHandle } from '@wimaengine/ecs' */
+/** @import { EntityHandle, World } from '@wimaengine/ecs' */
 import { Command } from '@wimaengine/command'
-import { World } from '@wimaengine/ecs'
 
 export class DespawnCommand extends Command {
 

packages/core/src/commands/removeresource.js → packages/commands/src/commands/removeresource.js

@@ -1,6 +1,5 @@
 /** @import {Constructor} from '@wimaengine/type' */
 import { Command } from '@wimaengine/command'
-import { World } from '@wimaengine/ecs'
 
 export class RemoveResourceCommand extends Command {
 
@@ -19,7 +18,7 @@ export class RemoveResourceCommand extends Command {
   }
 
   /**
-   * @param {World} world
+   * @param {import('@wimaengine/ecs').World} world
    */
   execute(world) {
     world.removeResource(this.resourceType)

packages/core/src/commands/setresourcealias.js → packages/commands/src/commands/setresourcealias.js

@@ -1,6 +1,5 @@
 /** @import {Constructor, TypeId} from '@wimaengine/type' */
 import { Command } from '@wimaengine/command'
-import { World } from '@wimaengine/ecs'
 
 export class SetResourceAliasCommand extends Command {
 
@@ -27,7 +26,7 @@ export class SetResourceAliasCommand extends Command {
   }
 
   /**
-   * @param {World} world
+   * @param {import('@wimaengine/ecs').World} world
    */
   execute(world) {
     world.setResourceAlias(this.id, this.alias)

packages/core/src/commands/spawn.js → packages/commands/src/commands/spawn.js

@@ -1,5 +1,5 @@
+/** @import { EntityHandle, World } from '@wimaengine/ecs' */
 import { Command } from '@wimaengine/command'
-import { World, EntityHandle } from '@wimaengine/ecs'
 
 export class SpawnCommand extends Command {
 

packages/core/src/core/entity.js → packages/commands/src/core/entity.js

@@ -1,6 +1,5 @@
-/** @import { EntityHandle } from '@wimaengine/ecs' */
+/** @import { EntityHandle, World } from '@wimaengine/ecs' */
 import { CommandQueue } from '@wimaengine/command'
-import { World } from '@wimaengine/ecs'
 import { assert } from '@wimaengine/logger'
 import { SpawnCommand, DespawnCommand } from '../commands'
 

packages/commands/src/core/index.js

@@ -0,0 +1,2 @@
+export * from './entity'
+export * from './resourcecommands'

packages/core/src/core/resourcecommands.js → packages/commands/src/core/resourcecommands.js

@@ -1,6 +1,5 @@
 /** @import {Constructor, TypeId} from '@wimaengine/type' */
 import { CommandQueue } from '@wimaengine/command'
-import { World } from '@wimaengine/ecs'
 import { AddResourceCommand, RemoveResourceCommand, SetResourceAliasCommand } from '../commands'
 
 export class ResourceCommands {
@@ -12,7 +11,7 @@ export class ResourceCommands {
   buffer
 
   /**
-   * @param {World} world
+   * @param {import('@wimaengine/ecs').World} world
    */
   constructor(world) {
     this.buffer = world.getResource(CommandQueue)

packages/commands/src/index.js

@@ -0,0 +1,2 @@
+export * from './commands'
+export * from './core'

packages/core/tests/resourcecommands.test.js → packages/commands/tests/resourcecommands.test.js

@@ -1,10 +1,9 @@
 import { strictEqual } from 'node:assert'
 import { describe, test } from 'vitest'
-import { CommandQueue } from '@wimaengine/command'
+import { CommandQueue, executeCommands } from '@wimaengine/command'
 import { World } from '@wimaengine/ecs'
 import { typeid } from '@wimaengine/type'
 import { ResourceCommands } from '../src/index.js'
-import { executeCommands } from '../src/systems/index.js'
 
 class TestResource { }
 class TestAlias extends TestResource { }

packages/commands/tsc.type.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../.config/tsc.type.base.json",
+  "include": [
+    "index.js"
+  ],
+  "exclude": [
+    "dist/**",
+    "types/**",
+    "tests/**"
+  ],
+  "compilerOptions": {
+    "declarationDir": "./types",
+    "rootDir": "."
+  }
+}

packages/core/package.json

@@ -31,7 +31,6 @@
   },
   "dependencies": {
     "@wimaengine/app": "0.3.0",
-    "@wimaengine/command": "0.3.0",
     "@wimaengine/ecs": "0.3.0",
     "@wimaengine/logger": "0.3.0",
     "@wimaengine/reflect": "0.3.0",

packages/core/src/core/index.js

@@ -1,7 +1,5 @@
 export * from './schedules'
 export * from './runner'
-export * from './entity'
-export * from './resourcecommands'
 export * from './systemgroups'
 export * from './snapshot'
 export * from './worlds'

packages/core/src/index.js

@@ -1,3 +1,2 @@
-export * from './commands'
 export * from './core'
 export * from './plugin'

packages/core/src/plugin.js

@@ -1,7 +1,8 @@
-import { App, Plugin } from '@wimaengine/app'
+/** @import { App } from '@wimaengine/app' */
+import { Plugin } from '@wimaengine/app'
 import { SchedulerBuilder } from '@wimaengine/schedule'
 import { AppSchedule, CoreSystems, MainWorld, defaultRunner } from './core'
-import { executeCommands, registerCoreTypes, registerPrimitiveTypes } from './systems'
+import { registerCoreTypes, registerPrimitiveTypes } from './systems'
 
 export class CorePlugin extends Plugin {
 
@@ -81,15 +82,5 @@ export class CorePlugin extends Plugin {
         schedule: AppSchedule.Startup,
         system: registerPrimitiveTypes
       })
-      .registerSystem({
-        schedule: AppSchedule.Startup,
-        systemGroup: CoreSystems.End,
-        system: executeCommands
-      })
-      .registerSystem({
-        schedule: AppSchedule.Update,
-        systemGroup: CoreSystems.End,
-        system: executeCommands
-      })
   }
 }

packages/core/src/systems/index.js

@@ -1,2 +1 @@
 export * from './types'
-export * from './commands'

packages/core/src/systems/types.js

@@ -1,4 +1,5 @@
-import { EntityHandle, World } from '@wimaengine/ecs'
+/** @import { World } from '@wimaengine/ecs' */
+import { EntityHandle } from '@wimaengine/ecs'
 import { ArrayInfo, Field, MapInfo, MethodEntry, OpaqueInfo, StructInfo, TypeEntry, TypeRegistry } from '@wimaengine/reflect'
 import { setTypeId, typeid, typeidGeneric } from '@wimaengine/type'
 

packages/emitter/package.json

@@ -31,6 +31,7 @@
   },
   "dependencies": {
     "@wimaengine/app": "0.3.0",
+    "@wimaengine/commands": "0.3.0",
     "@wimaengine/core": "0.3.0",
     "@wimaengine/datastructures": "0.3.0",
     "@wimaengine/ecs": "0.3.0",

packages/emitter/src/components/emitter.js

@@ -1,4 +1,4 @@
-import { EntityCommands } from '@wimaengine/core'
+/** @import { EntityCommands } from '@wimaengine/commands' */
 import { Range } from '@wimaengine/datastructures'
 import { EntityHandle } from '@wimaengine/ecs'
 

packages/emitter/src/systems/index.js

@@ -1,4 +1,4 @@
-import { EntityCommands } from '@wimaengine/core'
+import { EntityCommands } from '@wimaengine/commands'
 import { EntityHandle, has, Query, World } from '@wimaengine/ecs'
 import { Timer } from '@wimaengine/time'
 import { Position2D, Orientation2D, GlobalTransform2D, GlobalTransform3D, Orientation3D, Position3D, Scale3D } from '@wimaengine/transform'

packages/window/package.json

@@ -31,6 +31,7 @@
   },
   "dependencies": {
     "@wimaengine/app": "0.3.0",
+    "@wimaengine/commands": "0.3.0",
     "@wimaengine/command": "0.3.0",
     "@wimaengine/core": "0.3.0",
     "@wimaengine/ecs": "0.3.0",

packages/window/src/plugin.js

@@ -1,6 +1,7 @@
 /** @import {WindowOptions} from './components' */
 import { App, Plugin } from '@wimaengine/app'
-import { AppSchedule, CoreSystems, EntityCommands } from '@wimaengine/core'
+import { EntityCommands } from '@wimaengine/commands'
+import { AppSchedule, CoreSystems } from '@wimaengine/core'
 import { EventPlugin } from '@wimaengine/event'
 import { Window, MainWindow } from './components'
 import {

src/index.js

@@ -5,6 +5,7 @@ export * from '@wimaengine/audio'
 export * from '@wimaengine/broadphase'
 export * from '@wimaengine/color'
 export * from '@wimaengine/command'
+export * from '@wimaengine/commands'
 export * from '@wimaengine/core'
 export * from '@wimaengine/damping'
 export * from '@wimaengine/datastructures'