@antha/engine 0.0.8 → 0.1.1

package/README.md

@@ -1,11 +1,38 @@
-# Antha
+# @antha/engine
 
-The Antha game engine (for the web), where everything is a mod! The only thing this engine core includes is a framework for flexibly defining and inserting mods with all the tools they need to be successful.
+The Antha game engine (for the web), where everything is a mod! This engine core package only includes a lightweight framework for flexibly defining, inserting, and running the engine mods.
 
 -   Demo: https://electrovir.github.io/antha/demo
 
 ## Install
 
 ```sh
-npm i antha
+npm i @antha/engine
+```
+
+## Usage
+
+<!-- example-link: src/readme-examples/creating-engine.example.ts -->
+
+```TypeScript
+import {AnthaEngine, defineAnthaMod} from '@antha/engine';
+
+const engine = new AnthaEngine<{
+    count: number;
+}>({
+    mods: [
+        defineAnthaMod<{
+            count: number;
+        }>({
+            modName: 'counter',
+            execute({state}) {
+                state.count = (state.count ?? 0) + 1;
+
+                return `Count: ${state.count}`;
+            },
+        }),
+    ],
+});
+
+engine.startLoop();
 ```

package/dist/antha-engine.d.ts

@@ -1,7 +1,6 @@
-import { type AnyObject, type Branded, type MaybePromise, type PartialWithUndefined, type RequiredAndNotNull } from '@augment-vir/common';
+import { type AnyObject, type Branded, type MaybePromise, type PartialWithUndefined, type RequiredAndNotNull, type RequireExactlyOne } from '@augment-vir/common';
 import { type HtmlInterpolation } from 'element-vir';
 import { Observable } from 'observavir';
-import { type RequireExactlyOne } from 'type-fest';
 import { type AnthaLogger } from './logger/antha-logger.js';
 /**
  * A string type used for mod instances. In reality these are just strings, but this branded type
@@ -37,10 +36,10 @@ export type ModCleanupParams<State extends AnyObject> = {
     modInstanceId: ModInstanceId;
 } & ModOptions;
 /**
- * Return this from a mod's {@link AnthaMod.execute} callback to instruct {@link AnthaEngine} that the
- * mod's current execution should not count toward the mod's frequency schedule. This is useful when
- * a mod needs a dependency (such as a canvas or external resource) that isn't ready yet so that the
- * engine will keep retrying on subsequent ticks, even if the mod has a low execution frequency.
+ * Return this from a mod's `execute` callback to instruct {@link AnthaEngine} that the mod's current
+ * execution should not count toward the mod's frequency schedule. This is useful when a mod needs a
+ * dependency (such as a canvas or external resource) that isn't ready yet so that the engine will
+ * keep retrying on subsequent ticks, even if the mod has a low execution frequency.
  *
  * @category Mod
  */

package/dist/antha-engine.js

@@ -6,10 +6,10 @@ import { Observable } from 'observavir';
 import { AnthaUi } from './antha-ui.element.js';
 import { browserAnthaLogger } from './logger/browser-antha-logger.js';
 /**
- * Return this from a mod's {@link AnthaMod.execute} callback to instruct {@link AnthaEngine} that the
- * mod's current execution should not count toward the mod's frequency schedule. This is useful when
- * a mod needs a dependency (such as a canvas or external resource) that isn't ready yet so that the
- * engine will keep retrying on subsequent ticks, even if the mod has a low execution frequency.
+ * Return this from a mod's `execute` callback to instruct {@link AnthaEngine} that the mod's current
+ * execution should not count toward the mod's frequency schedule. This is useful when a mod needs a
+ * dependency (such as a canvas or external resource) that isn't ready yet so that the engine will
+ * keep retrying on subsequent ticks, even if the mod has a low execution frequency.
  *
  * @category Mod
  */
@@ -174,7 +174,9 @@ export class AnthaEngine {
             await mod.cleanup?.({
                 engine: this,
                 hostElement: this.getEnsuredHostElement(),
-                modInstanceId: getOrSetFromMap(this.modInstanceIdMap, mod, () => applyBrand(createId())),
+                modInstanceId: getOrSetFromMap(this.modInstanceIdMap, mod, () => {
+                    return applyBrand(createId());
+                }),
                 state: this.state,
                 executeImmediately: mod.executeImmediately || false,
                 frequency: mod.frequency || undefined,
@@ -236,7 +238,9 @@ export class AnthaEngine {
                 }
                 const rawResult = mod.execute({
                     engine: this,
-                    modInstanceId: getOrSetFromMap(this.modInstanceIdMap, mod, () => applyBrand(createId())),
+                    modInstanceId: getOrSetFromMap(this.modInstanceIdMap, mod, () => {
+                        return applyBrand(createId());
+                    }),
                     currentTick: this.currentTick,
                     state: this.state,
                     ticksSinceLastExecute: this.currentTick - (lastExecution?.tick ?? 0),
@@ -292,6 +296,8 @@ export class AnthaEngine {
             const msSinceLastExecution = performance.now() - (lastExecution?.timeMs || 0);
             return msSinceLastExecution >= mod.frequency.durationMs;
         }
-        return true;
+        else {
+            return true;
+        }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@antha/engine",
-    "version": "0.0.8",
+    "version": "0.1.1",
     "description": "The Antha game engine (for the web).",
     "keywords": [
         "vir",
@@ -35,27 +35,26 @@
         "test:update": "npm test update"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.73.1",
-        "@augment-vir/common": "^31.73.1",
+        "@augment-vir/assert": "^32.2.2",
+        "@augment-vir/common": "^32.2.2",
         "@paralleldrive/cuid2": "^3.3.0",
-        "date-vir": "^8.5.0",
-        "observavir": "^2.3.2",
-        "sentry-vir": "^4.4.0",
-        "type-fest": "^5.7.0"
+        "date-vir": "^9.0.0",
+        "observavir": "^2.3.3",
+        "sentry-vir": "^4.5.1"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.73.1",
-        "@augment-vir/web": "^31.73.1",
-        "@web/dev-server-esbuild": "^1.0.5",
-        "@web/test-runner": "^0.20.2",
-        "@web/test-runner-commands": "^0.9.0",
-        "@web/test-runner-playwright": "^0.11.1",
-        "@web/test-runner-visual-regression": "^0.10.0",
+        "@augment-vir/test": "^32.2.2",
+        "@augment-vir/web": "^32.2.2",
+        "@web/dev-server-esbuild": "^2.0.0",
+        "@web/test-runner": "^1.0.0",
+        "@web/test-runner-commands": "^1.0.1",
+        "@web/test-runner-playwright": "^1.0.0",
+        "@web/test-runner-visual-regression": "^1.0.1",
         "istanbul-smart-text-reporter": "^1.1.5",
-        "markdown-code-example-inserter": "^3.0.5",
-        "typedoc": "^0.28.19",
+        "markdown-code-example-inserter": "^3.0.6",
+        "typedoc": "^0.28.20",
         "typescript": "^6.0.3",
-        "vite": "^8.0.16"
+        "vite": "^8.2.1"
     },
     "peerDependencies": {
         "element-vir": ">=26"