@civ-clone/base-unit-lifecycle 0.0.0-stage → 0.1.1

package/.gitattributes

@@ -0,0 +1,4 @@
+**/*.d.ts linguist-generated=true
+**/*.js linguist-generated=true
+**/*.js.map linguist-generated=true
+

package/.github/workflows/build-on-push.yml

@@ -0,0 +1,39 @@
+name: Build and test application on push to remote
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 11
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      # No lock file, so this tests what a consumer resolves. The settings match
+      # web-renderer's pnpm-workspace.yaml: several @civ-clone packages depend on
+      # each other as `github:` URLs, this project's own releases are often only
+      # minutes old, and nothing here needs a dependency's build script.
+      - run: >-
+          pnpm install --no-frozen-lockfile
+          --config.block-exotic-subdeps=false
+          --config.minimum-release-age=0
+          --config.strict-dep-builds=false
+      - run: npm run --if-present prettier:check
+      # The tests load the committed `.js`, so compile to prove the source
+      # type-checks, and fail if the committed output is stale. `--force`
+      # because a fresh checkout's timestamps can make `tsc --build` treat the
+      # committed output as up to date and skip the compile entirely.
+      - run: npm run --if-present ts:compile -- --force
+      - run: npm run --if-present prettier:format
+      # Stale *or never committed* output fails: `git diff` alone misses a new
+      # module whose `.js` was never added, which the published package would
+      # then omit. Only the compiled extensions, so the lock file the install
+      # writes cannot fail it; `node_modules` is ignored, so it stays out.
+      - run: |
+          git status --short --untracked-files=all -- '*.js' '*.d.ts' '*.js.map'
+          test -z "$(git status --porcelain --untracked-files=all -- '*.js' '*.d.ts' '*.js.map')"
+      - run: npm run --if-present test

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "semi": true,
+  "singleQuote": true
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Dom Hastings
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,62 @@
-# Temporary Holding Version
+# base-unit-lifecycle
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Building blocks for a ruleset's unit lifecycle rules. The ruleset keeps its own rules (`Created`, `Destroyed` and the
+rest), with its own ids, order and numbers, and builds their criteria and effects from these functions. Each one is a
+rule's criterion or effect as it is: pass it straight to `new Criterion(...)` or `new Effect(...)`. Those that need a
+registry, the engine or a number take it first and return the function.
+
+- `lib/created`: `registerUnit(unitRegistry)`, `applyVisibility`, `setMoves` (full moves) and `emitCreated(engine)`
+  (`unit:created`).
+- `lib/activate`: `hasMoves`, `setActive`, `isBusy`, `clearBusy`, and `hasImprovement(unitImprovementRegistry, Type)` /
+  `removeImprovement(unitImprovementRegistry, Type)` for each improvement waking a unit removes.
+- `lib/validateMove`: `hasMovesFor` / `spendMoves` for a step the unit has the moves for, and `shortOfMovesFor` /
+  `spendShort(shortfallFactor, randomNumberGenerator)` for one it hasn't: it spends what's left and gets there by
+  base-unit-action-rules' `succeedsShort`.
+- `lib/impassable`: `fromLand`, `toPartnersLand(partnerOf)` and `impassable`, so routes go round a treaty partner's
+  land; `partnerOf` is the ruleset's territory model.
+- `lib/canStow`: `carriesDomain(Domain)` and `carriesUnit(Domain)`, one `CanStow` rule per domain a transport may be
+  declared to carry, from its `Carries` traits.
+- `lib/stowed`: `sleepAboard`, a unit that boards sleeps.
+- `lib/halted`: `emitHalted(engine)` (`unit:halted`), a GoTo stopped next to its destination.
+- `lib/unsupported`: `emitUnsupported(engine)` (`unit:unsupported`).
+- `lib/defeated`: `emitAndDestroy(engine, ruleRegistry)` (`unit:defeated`, then `Destroyed`), and for a defeated
+  defender's stack, `defended`, `notInCity(cityRegistry)`, `hasStack(unitRegistry)` and
+  `destroyStack(unitRegistry, ruleRegistry)`.
+- `lib/destroyed`: `emitDestroyed(engine)` (`unit:destroyed`); `destroyedByAnother`, `notYetDestroyed` and
+  `countLoss(unitLossRegistry)` for a loss report; `deactivate`; `removeImprovements(unitImprovementRegistry)`;
+  `carriesCargo(transportRegistry)` / `loseCargo(transportRegistry)`, cargo lost with its transport at sea; and
+  `isAboard(transportRegistry)` / `leaveOwnTransport(transportRegistry)`, cargo destroyed on its own. Both take units
+  off with `leaveTransport(transportRegistry)`, which also clears `Stowed`.
+- `lib/lostAtSea`: `emitLostAtSea(engine)` (`unit:lost-at-sea`), `countLosses(unitLossRegistry, transportRegistry)`
+  (the transport and its cargo; before `sink`) and `sink`.
+- `lib/playerAction`: `hasActiveUnits(unitRegistry)` / `activeUnits(unitRegistry, ActiveUnit)` and
+  `hasInactiveUnits(unitRegistry)` / `inactiveUnits(unitRegistry, InactiveUnit)`, waiting units last.
+
+## Rule assemblers
+
+For a ruleset that wants the rules themselves, each takes the ruleset's id prefix, its registries and its options, and
+returns the rules with ids `<prefix>:unit/<type>/<name>`, the same names and order civ1-unit uses
+(`tests/fixtures/civ1-unit-rules.json` pins them):
+
+- `lib/lifecycleRules`: `lifecycleRules(prefix, deps, options)`, by rule type (`activate`, `canStow`, `created`,
+  `defeated`, `destroyed`, `expectedMovementCost`, `halted`, `impassable`, `lostAtSea`, `playerAction`, `stowed`,
+  `transferred`, `unsupported`, `validateMove`), so each list can be registered where the ruleset wants it.
+- `lib/movedRules`: `movedRules(prefix, deps, options)`, the `Moved` rules: cargo, collecting, taking off, a
+  `CoastBound` unit lost at sea, `AttackEndsTurn`, and a broken peace treaty.
+- `lib/detonatedRules`: `detonatedRules(prefix, deps, options)`, what a nuclear detonation does to the 9 squares.
+  `sparesUnits` spares a city's units (Civ1's SDI Defense); an optional `vetoes` stops a detonation altogether.
+- `lib/diplomatRules`: `diplomatRules(prefix, deps)`, the embassy, investigation and leader-meeting rules.
+- `lib/treatyPartner`: `treatyPartner(improvements, deps)`, a `partnerOf` for `impassable` and the treaty actions: the
+  partner working an improved tile.
+
+### For civ1-unit's adoption (R2b)
+
+- `lifecycle.transferred` holds only `transferred/emit`: civ1-unit must register its own `transferred/start-afresh`
+  rule (`START_AFRESH_RULE`) before it, as it does today.
+- `HALVE_CITIES_PRIORITY` and `halveCity` now live in `lib/detonatedRules` as well as civ1-unit's `lib/nuclear`; R2b
+  makes civ1-unit re-export the base ones, so there is one copy.
+- The defaults reproduce civ1-unit exactly: `shortStep` and `vetoes` are for other rulesets (Civ2's short step and SDI
+  Defense), and leaving them out changes nothing.
+
+A library: no `main`, so it registers nothing on its own. Import what you need, for example
+`@civ-clone/base-unit-lifecycle/lib/destroyed`.

package/lib/activate.d.ts

@@ -0,0 +1,15 @@
+import Unit from '@civ-clone/core-unit/Unit';
+import UnitImprovement from '@civ-clone/core-unit-improvement/UnitImprovement';
+import UnitImprovementRegistry from '@civ-clone/core-unit-improvement/UnitImprovementRegistry';
+export declare const hasMoves: (unit: Unit) => boolean;
+export declare const setActive: (unit: Unit) => void;
+export declare const isBusy: (unit: Unit) => boolean;
+export declare const clearBusy: (unit: Unit) => void;
+export declare const hasImprovement: (
+  unitImprovementRegistry: UnitImprovementRegistry,
+  UnitImprovementType: typeof UnitImprovement
+) => (unit: Unit) => boolean;
+export declare const removeImprovement: (
+  unitImprovementRegistry: UnitImprovementRegistry,
+  UnitImprovementType: typeof UnitImprovement
+) => (unit: Unit) => void;

package/lib/activate.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeImprovement = exports.hasImprovement = exports.clearBusy = exports.isBusy = exports.setActive = exports.hasMoves = void 0;
+// What a ruleset's `Activate` rules ask and do when a unit is woken to take orders.
+// The unit has moves left.
+const hasMoves = (unit) => unit.moves().value() > 0;
+exports.hasMoves = hasMoves;
+// Makes the unit active.
+const setActive = (unit) => unit.setActive();
+exports.setActive = setActive;
+// The unit is busy (sleeping, fortifying, working...).
+const isBusy = (unit) => unit.busy() !== null;
+exports.isBusy = isBusy;
+// Clears what the unit was busy with.
+const clearBusy = (unit) => unit.setBusy();
+exports.clearBusy = clearBusy;
+// The unit has an improvement of `UnitImprovementType` (one that waking it should remove, such as being fortified).
+const hasImprovement = (unitImprovementRegistry, UnitImprovementType) => (unit) => unitImprovementRegistry
+    .getByUnit(unit)
+    .some((unitImprovement) => unitImprovement instanceof UnitImprovementType);
+exports.hasImprovement = hasImprovement;
+// Removes the unit's improvements of `UnitImprovementType`.
+const removeImprovement = (unitImprovementRegistry, UnitImprovementType) => (unit) => unitImprovementRegistry.unregister(...unitImprovementRegistry
+    .getByUnit(unit)
+    .filter((unitImprovement) => unitImprovement instanceof UnitImprovementType));
+exports.removeImprovement = removeImprovement;
+//# sourceMappingURL=activate.js.map

package/lib/activate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"activate.js","sourceRoot":"","sources":["activate.ts"],"names":[],"mappings":";;;AAIA,oFAAoF;AAEpF,2BAA2B;AACpB,MAAM,QAAQ,GAAG,CAAC,IAAU,EAAW,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AAA7D,QAAA,QAAQ,YAAqD;AAE1E,yBAAyB;AAClB,MAAM,SAAS,GAAG,CAAC,IAAU,EAAQ,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;AAAnD,QAAA,SAAS,aAA0C;AAEhE,uDAAuD;AAChD,MAAM,MAAM,GAAG,CAAC,IAAU,EAAW,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,IAAI,CAAC;AAAvD,QAAA,MAAM,UAAiD;AAEpE,sCAAsC;AAC/B,MAAM,SAAS,GAAG,CAAC,IAAU,EAAQ,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;AAAjD,QAAA,SAAS,aAAwC;AAE9D,oHAAoH;AAC7G,MAAM,cAAc,GACzB,CACE,uBAAgD,EAChD,mBAA2C,EAC3C,EAAE,CACJ,CAAC,IAAU,EAAW,EAAE,CACtB,uBAAuB;KACpB,SAAS,CAAC,IAAI,CAAC;KACf,IAAI,CACH,CAAC,eAAgC,EAAW,EAAE,CAC5C,eAAe,YAAY,mBAAmB,CACjD,CAAC;AAXK,QAAA,cAAc,kBAWnB;AAER,4DAA4D;AACrD,MAAM,iBAAiB,GAC5B,CACE,uBAAgD,EAChD,mBAA2C,EAC3C,EAAE,CACJ,CAAC,IAAU,EAAQ,EAAE,CACnB,uBAAuB,CAAC,UAAU,CAChC,GAAG,uBAAuB;KACvB,SAAS,CAAC,IAAI,CAAC;KACf,MAAM,CACL,CAAC,eAAgC,EAAW,EAAE,CAC5C,eAAe,YAAY,mBAAmB,CACjD,CACJ,CAAC;AAbO,QAAA,iBAAiB,qBAaxB"}

package/lib/activate.ts

@@ -0,0 +1,47 @@
+import Unit from '@civ-clone/core-unit/Unit';
+import UnitImprovement from '@civ-clone/core-unit-improvement/UnitImprovement';
+import UnitImprovementRegistry from '@civ-clone/core-unit-improvement/UnitImprovementRegistry';
+
+// What a ruleset's `Activate` rules ask and do when a unit is woken to take orders.
+
+// The unit has moves left.
+export const hasMoves = (unit: Unit): boolean => unit.moves().value() > 0;
+
+// Makes the unit active.
+export const setActive = (unit: Unit): void => unit.setActive();
+
+// The unit is busy (sleeping, fortifying, working...).
+export const isBusy = (unit: Unit): boolean => unit.busy() !== null;
+
+// Clears what the unit was busy with.
+export const clearBusy = (unit: Unit): void => unit.setBusy();
+
+// The unit has an improvement of `UnitImprovementType` (one that waking it should remove, such as being fortified).
+export const hasImprovement =
+  (
+    unitImprovementRegistry: UnitImprovementRegistry,
+    UnitImprovementType: typeof UnitImprovement
+  ) =>
+  (unit: Unit): boolean =>
+    unitImprovementRegistry
+      .getByUnit(unit)
+      .some(
+        (unitImprovement: UnitImprovement): boolean =>
+          unitImprovement instanceof UnitImprovementType
+      );
+
+// Removes the unit's improvements of `UnitImprovementType`.
+export const removeImprovement =
+  (
+    unitImprovementRegistry: UnitImprovementRegistry,
+    UnitImprovementType: typeof UnitImprovement
+  ) =>
+  (unit: Unit): void =>
+    unitImprovementRegistry.unregister(
+      ...unitImprovementRegistry
+        .getByUnit(unit)
+        .filter(
+          (unitImprovement: UnitImprovement): boolean =>
+            unitImprovement instanceof UnitImprovementType
+        )
+    );

package/lib/canStow.d.ts

@@ -0,0 +1,8 @@
+import { ITransport } from '@civ-clone/core-unit-transport/Transport';
+import Unit from '@civ-clone/core-unit/Unit';
+export declare const carriesDomain: (
+  Domain: typeof Unit
+) => (transport: ITransport) => boolean;
+export declare const carriesUnit: (
+  Domain: typeof Unit
+) => (transport: ITransport, unit: Unit) => boolean;

package/lib/canStow.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.carriesUnit = exports.carriesDomain = void 0;
+const Carries_1 = require("@civ-clone/base-unit-trait-carries/Carries");
+// What a ruleset's `CanStow` rules ask, one rule for each domain (`Land`, `Air`...) a transport may be declared to
+//  carry: what a transport carries is its `Carries` traits.
+// The transport is declared to carry units of `Domain`.
+const carriesDomain = (Domain) => (transport) => transport
+    .traits(Carries_1.default)
+    .some((carries) => carries.what === Domain);
+exports.carriesDomain = carriesDomain;
+// The transport carries `unit` as one of `Domain`: a `Carries` trait for `Domain` that accepts it.
+const carriesUnit = (Domain) => (transport, unit) => transport
+    .traits(Carries_1.default)
+    .some((carries) => carries.what === Domain && carries.carries(unit));
+exports.carriesUnit = carriesUnit;
+//# sourceMappingURL=canStow.js.map

package/lib/canStow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"canStow.js","sourceRoot":"","sources":["canStow.ts"],"names":[],"mappings":";;;AAAA,wEAAiE;AAIjE,mHAAmH;AACnH,4DAA4D;AAE5D,wDAAwD;AACjD,MAAM,aAAa,GACxB,CAAC,MAAmB,EAAE,EAAE,CACxB,CAAC,SAAqB,EAAW,EAAE,CAChC,SAA6B;KAC3B,MAAM,CAAC,iBAAO,CAAC;KACf,IAAI,CAAC,CAAC,OAAgB,EAAW,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC;AALvD,QAAA,aAAa,iBAK0C;AAEpE,mGAAmG;AAC5F,MAAM,WAAW,GACtB,CAAC,MAAmB,EAAE,EAAE,CACxB,CAAC,SAAqB,EAAE,IAAU,EAAW,EAAE,CAC5C,SAA6B;KAC3B,MAAM,CAAC,iBAAO,CAAC;KACf,IAAI,CACH,CAAC,OAAgB,EAAW,EAAE,CAC5B,OAAO,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CACnD,CAAC;AARK,QAAA,WAAW,eAQhB"}

package/lib/canStow.ts

@@ -0,0 +1,25 @@
+import Carries from '@civ-clone/base-unit-trait-carries/Carries';
+import { ITransport } from '@civ-clone/core-unit-transport/Transport';
+import Unit from '@civ-clone/core-unit/Unit';
+
+// What a ruleset's `CanStow` rules ask, one rule for each domain (`Land`, `Air`...) a transport may be declared to
+//  carry: what a transport carries is its `Carries` traits.
+
+// The transport is declared to carry units of `Domain`.
+export const carriesDomain =
+  (Domain: typeof Unit) =>
+  (transport: ITransport): boolean =>
+    (transport as unknown as Unit)
+      .traits(Carries)
+      .some((carries: Carries): boolean => carries.what === Domain);
+
+// The transport carries `unit` as one of `Domain`: a `Carries` trait for `Domain` that accepts it.
+export const carriesUnit =
+  (Domain: typeof Unit) =>
+  (transport: ITransport, unit: Unit): boolean =>
+    (transport as unknown as Unit)
+      .traits(Carries)
+      .some(
+        (carries: Carries): boolean =>
+          carries.what === Domain && carries.carries(unit)
+      );

package/lib/created.d.ts

@@ -0,0 +1,9 @@
+import Engine from '@civ-clone/core-engine/Engine';
+import Unit from '@civ-clone/core-unit/Unit';
+import UnitRegistry from '@civ-clone/core-unit/UnitRegistry';
+export declare const registerUnit: (
+  unitRegistry: UnitRegistry
+) => (unit: Unit) => void;
+export declare const applyVisibility: (unit: Unit) => void;
+export declare const setMoves: (unit: Unit) => void;
+export declare const emitCreated: (engine: Engine) => (unit: Unit) => void;

package/lib/created.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emitCreated = exports.setMoves = exports.applyVisibility = exports.registerUnit = void 0;
+// What a ruleset's `Created` rules do with a new unit, one function for each rule's effect.
+// Adds the unit to `unitRegistry`.
+const registerUnit = (unitRegistry) => (unit) => unitRegistry.register(unit);
+exports.registerUnit = registerUnit;
+// Reveals what the unit can see to its player.
+const applyVisibility = (unit) => unit.applyVisibility();
+exports.applyVisibility = applyVisibility;
+// Gives the unit its full moves.
+const setMoves = (unit) => unit.moves().set(unit.movement());
+exports.setMoves = setMoves;
+// Emits `unit:created` with the unit.
+const emitCreated = (engine) => (unit) => {
+    engine.emit('unit:created', unit);
+};
+exports.emitCreated = emitCreated;
+//# sourceMappingURL=created.js.map

package/lib/created.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"created.js","sourceRoot":"","sources":["created.ts"],"names":[],"mappings":";;;AAIA,4FAA4F;AAE5F,mCAAmC;AAC5B,MAAM,YAAY,GACvB,CAAC,YAA0B,EAAE,EAAE,CAC/B,CAAC,IAAU,EAAQ,EAAE,CACnB,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAHnB,QAAA,YAAY,gBAGO;AAEhC,+CAA+C;AACxC,MAAM,eAAe,GAAG,CAAC,IAAU,EAAQ,EAAE,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;AAA/D,QAAA,eAAe,mBAAgD;AAE5E,iCAAiC;AAC1B,MAAM,QAAQ,GAAG,CAAC,IAAU,EAAQ,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;AAAnE,QAAA,QAAQ,YAA2D;AAEhF,sCAAsC;AAC/B,MAAM,WAAW,GACtB,CAAC,MAAc,EAAE,EAAE,CACnB,CAAC,IAAU,EAAQ,EAAE;IACnB,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;AACpC,CAAC,CAAC;AAJS,QAAA,WAAW,eAIpB"}

package/lib/created.ts

@@ -0,0 +1,24 @@
+import Engine from '@civ-clone/core-engine/Engine';
+import Unit from '@civ-clone/core-unit/Unit';
+import UnitRegistry from '@civ-clone/core-unit/UnitRegistry';
+
+// What a ruleset's `Created` rules do with a new unit, one function for each rule's effect.
+
+// Adds the unit to `unitRegistry`.
+export const registerUnit =
+  (unitRegistry: UnitRegistry) =>
+  (unit: Unit): void =>
+    unitRegistry.register(unit);
+
+// Reveals what the unit can see to its player.
+export const applyVisibility = (unit: Unit): void => unit.applyVisibility();
+
+// Gives the unit its full moves.
+export const setMoves = (unit: Unit): void => unit.moves().set(unit.movement());
+
+// Emits `unit:created` with the unit.
+export const emitCreated =
+  (engine: Engine) =>
+  (unit: Unit): void => {
+    engine.emit('unit:created', unit);
+  };

package/lib/defeated.d.ts

@@ -0,0 +1,25 @@
+import Action from '@civ-clone/core-unit/Action';
+import CityRegistry from '@civ-clone/core-city/CityRegistry';
+import Engine from '@civ-clone/core-engine/Engine';
+import RuleRegistry from '@civ-clone/core-rule/RuleRegistry';
+import Unit from '@civ-clone/core-unit/Unit';
+import UnitRegistry from '@civ-clone/core-unit/UnitRegistry';
+export declare const emitAndDestroy: (
+  engine: Engine,
+  ruleRegistry: RuleRegistry
+) => (unit: Unit, by: Unit, action?: Action) => void;
+export declare const defended: (
+  unit: Unit,
+  by: Unit,
+  action?: Action
+) => boolean;
+export declare const notInCity: (
+  cityRegistry: CityRegistry
+) => (unit: Unit) => boolean;
+export declare const hasStack: (
+  unitRegistry: UnitRegistry
+) => (unit: Unit) => boolean;
+export declare const destroyStack: (
+  unitRegistry: UnitRegistry,
+  ruleRegistry: RuleRegistry
+) => (unit: Unit, by: Unit) => void;

package/lib/defeated.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.destroyStack = exports.hasStack = exports.notInCity = exports.defended = exports.emitAndDestroy = void 0;
+const Destroyed_1 = require("@civ-clone/core-unit/Rules/Destroyed");
+// What a ruleset's `Defeated` rules ask and do when `unit` loses a fight to `by`. `action`, when given, is the attack:
+//  `action.unit()` attacked.
+// Emits `unit:defeated` with the unit, the winner and the attack, then destroys the unit (`Destroyed`), credited to
+//  the winner's player.
+const emitAndDestroy = (engine, ruleRegistry) => (unit, by, action) => {
+    engine.emit('unit:defeated', unit, by, action);
+    ruleRegistry.process(Destroyed_1.default, unit, by.player());
+};
+exports.emitAndDestroy = emitAndDestroy;
+// The defeated unit defended: `Attack` processes `Defeated` for a losing attacker too.
+const defended = (unit, by, action) => !action || action.unit() !== unit;
+exports.defended = defended;
+// The defeated unit is not in a city.
+const notInCity = (cityRegistry) => (unit) => cityRegistry.getByTile(unit.tile()) === null;
+exports.notInCity = notInCity;
+// Other units of the defeated unit's player share its tile.
+const hasStack = (unitRegistry) => (unit) => unitRegistry
+    .getByTile(unit.tile())
+    .filter((tileUnit) => tileUnit !== unit && tileUnit.player() === unit.player()).length > 0;
+exports.hasStack = hasStack;
+// Destroys (`Destroyed`) every other unit of the defeated unit's player on its tile, credited to the winner's player.
+const destroyStack = (unitRegistry, ruleRegistry) => (unit, by) => unitRegistry
+    .getByTile(unit.tile())
+    .filter((tileUnit) => tileUnit !== unit && tileUnit.player() === unit.player())
+    .forEach((tileUnit) => {
+    ruleRegistry.process(Destroyed_1.default, tileUnit, by.player());
+});
+exports.destroyStack = destroyStack;
+//# sourceMappingURL=defeated.js.map

package/lib/defeated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defeated.js","sourceRoot":"","sources":["defeated.ts"],"names":[],"mappings":";;;AAEA,oEAA6D;AAM7D,uHAAuH;AACvH,6BAA6B;AAE7B,oHAAoH;AACpH,wBAAwB;AACjB,MAAM,cAAc,GACzB,CAAC,MAAc,EAAE,YAA0B,EAAE,EAAE,CAC/C,CAAC,IAAU,EAAE,EAAQ,EAAE,MAAe,EAAQ,EAAE;IAC9C,MAAM,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IAE/C,YAAY,CAAC,OAAO,CAAC,mBAAS,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;AACrD,CAAC,CAAC;AANS,QAAA,cAAc,kBAMvB;AAEJ,uFAAuF;AAChF,MAAM,QAAQ,GAAG,CAAC,IAAU,EAAE,EAAQ,EAAE,MAAe,EAAW,EAAE,CACzE,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,EAAE,KAAK,IAAI,CAAC;AADvB,QAAA,QAAQ,YACe;AAEpC,sCAAsC;AAC/B,MAAM,SAAS,GACpB,CAAC,YAA0B,EAAE,EAAE,CAC/B,CAAC,IAAU,EAAW,EAAE,CACtB,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;AAHpC,QAAA,SAAS,aAG2B;AAEjD,4DAA4D;AACrD,MAAM,QAAQ,GACnB,CAAC,YAA0B,EAAE,EAAE,CAC/B,CAAC,IAAU,EAAW,EAAE,CACtB,YAAY;KACT,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;KACtB,MAAM,CACL,CAAC,QAAc,EAAE,EAAE,CACjB,QAAQ,KAAK,IAAI,IAAI,QAAQ,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,MAAM,EAAE,CAC3D,CAAC,MAAM,GAAG,CAAC,CAAC;AARN,QAAA,QAAQ,YAQF;AAEnB,sHAAsH;AAC/G,MAAM,YAAY,GACvB,CAAC,YAA0B,EAAE,YAA0B,EAAE,EAAE,CAC3D,CAAC,IAAU,EAAE,EAAQ,EAAQ,EAAE,CAC7B,YAAY;KACT,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;KACtB,MAAM,CACL,CAAC,QAAc,EAAW,EAAE,CAC1B,QAAQ,KAAK,IAAI,IAAI,QAAQ,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,MAAM,EAAE,CAC3D;KACA,OAAO,CAAC,CAAC,QAAc,EAAQ,EAAE;IAChC,YAAY,CAAC,OAAO,CAAC,mBAAS,EAAE,QAAQ,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;AACzD,CAAC,CAAC,CAAC;AAXI,QAAA,YAAY,gBAWhB"}

package/lib/defeated.ts

@@ -0,0 +1,55 @@
+import Action from '@civ-clone/core-unit/Action';
+import CityRegistry from '@civ-clone/core-city/CityRegistry';
+import Destroyed from '@civ-clone/core-unit/Rules/Destroyed';
+import Engine from '@civ-clone/core-engine/Engine';
+import RuleRegistry from '@civ-clone/core-rule/RuleRegistry';
+import Unit from '@civ-clone/core-unit/Unit';
+import UnitRegistry from '@civ-clone/core-unit/UnitRegistry';
+
+// What a ruleset's `Defeated` rules ask and do when `unit` loses a fight to `by`. `action`, when given, is the attack:
+//  `action.unit()` attacked.
+
+// Emits `unit:defeated` with the unit, the winner and the attack, then destroys the unit (`Destroyed`), credited to
+//  the winner's player.
+export const emitAndDestroy =
+  (engine: Engine, ruleRegistry: RuleRegistry) =>
+  (unit: Unit, by: Unit, action?: Action): void => {
+    engine.emit('unit:defeated', unit, by, action);
+
+    ruleRegistry.process(Destroyed, unit, by.player());
+  };
+
+// The defeated unit defended: `Attack` processes `Defeated` for a losing attacker too.
+export const defended = (unit: Unit, by: Unit, action?: Action): boolean =>
+  !action || action.unit() !== unit;
+
+// The defeated unit is not in a city.
+export const notInCity =
+  (cityRegistry: CityRegistry) =>
+  (unit: Unit): boolean =>
+    cityRegistry.getByTile(unit.tile()) === null;
+
+// Other units of the defeated unit's player share its tile.
+export const hasStack =
+  (unitRegistry: UnitRegistry) =>
+  (unit: Unit): boolean =>
+    unitRegistry
+      .getByTile(unit.tile())
+      .filter(
+        (tileUnit: Unit) =>
+          tileUnit !== unit && tileUnit.player() === unit.player()
+      ).length > 0;
+
+// Destroys (`Destroyed`) every other unit of the defeated unit's player on its tile, credited to the winner's player.
+export const destroyStack =
+  (unitRegistry: UnitRegistry, ruleRegistry: RuleRegistry) =>
+  (unit: Unit, by: Unit): void =>
+    unitRegistry
+      .getByTile(unit.tile())
+      .filter(
+        (tileUnit: Unit): boolean =>
+          tileUnit !== unit && tileUnit.player() === unit.player()
+      )
+      .forEach((tileUnit: Unit): void => {
+        ruleRegistry.process(Destroyed, tileUnit, by.player());
+      });

package/lib/destroyed.d.ts

@@ -0,0 +1,37 @@
+import Engine from '@civ-clone/core-engine/Engine';
+import Player from '@civ-clone/core-player/Player';
+import TransportManifest from '@civ-clone/core-unit-transport/TransportManifest';
+import TransportRegistry from '@civ-clone/core-unit-transport/TransportRegistry';
+import Unit from '@civ-clone/core-unit/Unit';
+import UnitImprovementRegistry from '@civ-clone/core-unit-improvement/UnitImprovementRegistry';
+import UnitLossRegistry from '@civ-clone/core-unit/UnitLossRegistry';
+export declare const emitDestroyed: (
+  engine: Engine
+) => (unit: Unit, player: Player | null) => void;
+export declare const destroyedByAnother: (
+  unit: Unit,
+  player: Player | null
+) => boolean;
+export declare const notYetDestroyed: (unit: Unit) => boolean;
+export declare const countLoss: (
+  unitLossRegistry: UnitLossRegistry
+) => (unit: Unit) => void;
+export declare const deactivate: (unit: Unit) => void;
+export declare const removeImprovements: (
+  unitImprovementRegistry: UnitImprovementRegistry
+) => (unit: Unit) => void;
+export declare const leaveTransport: (
+  transportRegistry: TransportRegistry
+) => (manifest: TransportManifest) => void;
+export declare const carriesCargo: (
+  transportRegistry: TransportRegistry
+) => (unit: Unit) => boolean;
+export declare const loseCargo: (
+  transportRegistry: TransportRegistry
+) => (unit: Unit, player: Player | null) => void;
+export declare const isAboard: (
+  transportRegistry: TransportRegistry
+) => (unit: Unit) => boolean;
+export declare const leaveOwnTransport: (
+  transportRegistry: TransportRegistry
+) => (unit: Unit) => void;

package/lib/destroyed.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.leaveOwnTransport = exports.isAboard = exports.loseCargo = exports.carriesCargo = exports.leaveTransport = exports.removeImprovements = exports.deactivate = exports.countLoss = exports.notYetDestroyed = exports.destroyedByAnother = exports.emitDestroyed = void 0;
+const Stowed_1 = require("@civ-clone/base-unit-action-embark/Busy/Stowed");
+const Types_1 = require("@civ-clone/core-terrain/Types");
+// What a ruleset's `Destroyed` rules ask and do when `unit` is destroyed. `player` destroyed it, or is `null` when no
+//  one did (disbanding, founding or joining a city, a spent unit...).
+// Emits `unit:destroyed` with the unit and the player who destroyed it.
+const emitDestroyed = (engine) => (unit, player) => {
+    engine.emit('unit:destroyed', unit, player);
+};
+exports.emitDestroyed = emitDestroyed;
+// Another player destroyed the unit.
+const destroyedByAnother = (unit, player) => player !== null && player !== unit.player();
+exports.destroyedByAnother = destroyedByAnother;
+// The unit isn't marked destroyed yet: a rule that should act once per unit asks it before `deactivate` runs.
+const notYetDestroyed = (unit) => !unit.destroyed();
+exports.notYetDestroyed = notYetDestroyed;
+// Records the unit's type as a loss of its player's in `unitLossRegistry`.
+const countLoss = (unitLossRegistry) => (unit) => {
+    unitLossRegistry.record(unit.player(), unit.sourceClass());
+};
+exports.countLoss = countLoss;
+// Makes the unit inactive and marks it destroyed.
+const deactivate = (unit) => {
+    unit.setActive(false);
+    unit.setDestroyed();
+};
+exports.deactivate = deactivate;
+// Removes the unit's improvements (veteran status, fortification...).
+const removeImprovements = (unitImprovementRegistry) => (unit) => unitImprovementRegistry
+    .getByUnit(unit)
+    .forEach((unitImprovement) => unitImprovementRegistry.unregister(unitImprovement));
+exports.removeImprovements = removeImprovements;
+// Takes a unit off its transport. Nothing clears `Stowed` on its own (its criterion is `() => false`), so a unit taken
+//  off a transport, destroyed or not, would otherwise stay stowed aboard nothing.
+const leaveTransport = (transportRegistry) => (manifest) => {
+    const cargo = manifest.unit();
+    transportRegistry.unregister(manifest);
+    if (cargo.busy() instanceof Stowed_1.default) {
+        cargo.setBusy();
+    }
+};
+exports.leaveTransport = leaveTransport;
+// The unit is a transport with something aboard.
+const carriesCargo = (transportRegistry) => (unit) => transportRegistry.getByTransport(unit).length > 0;
+exports.carriesCargo = carriesCargo;
+// Takes everything off the transport (`leaveTransport`). At sea (on `Water`) the cargo goes down with it, destroyed by
+//  `player`; in a city it stays in the city.
+const loseCargo = (transportRegistry) => {
+    const leave = (0, exports.leaveTransport)(transportRegistry);
+    return (unit, player) => transportRegistry
+        .getByTransport(unit)
+        // A copy: unregistering changes the list.
+        .slice()
+        .forEach((manifest) => {
+        const cargo = manifest.unit();
+        leave(manifest);
+        if (unit.tile().terrain() instanceof Types_1.Water && !cargo.destroyed()) {
+            cargo.destroy(player);
+        }
+    });
+};
+exports.loseCargo = loseCargo;
+// The unit is aboard a transport.
+const isAboard = (transportRegistry) => (unit) => transportRegistry.hasUnit(unit);
+exports.isAboard = isAboard;
+// Takes the unit off the transport it's aboard (`leaveTransport`).
+const leaveOwnTransport = (transportRegistry) => {
+    const leave = (0, exports.leaveTransport)(transportRegistry);
+    return (unit) => leave(transportRegistry.getByUnit(unit));
+};
+exports.leaveOwnTransport = leaveOwnTransport;
+//# sourceMappingURL=destroyed.js.map

package/lib/destroyed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"destroyed.js","sourceRoot":"","sources":["destroyed.ts"],"names":[],"mappings":";;;AAGA,2EAAoE;AAMpE,yDAAsD;AAEtD,sHAAsH;AACtH,sEAAsE;AAEtE,wEAAwE;AACjE,MAAM,aAAa,GACxB,CAAC,MAAc,EAAE,EAAE,CACnB,CAAC,IAAU,EAAE,MAAqB,EAAQ,EAAE;IAC1C,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;AAC9C,CAAC,CAAC;AAJS,QAAA,aAAa,iBAItB;AAEJ,qCAAqC;AAC9B,MAAM,kBAAkB,GAAG,CAChC,IAAU,EACV,MAAqB,EACZ,EAAE,CAAC,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;AAH7C,QAAA,kBAAkB,sBAG2B;AAE1D,8GAA8G;AACvG,MAAM,eAAe,GAAG,CAAC,IAAU,EAAW,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;AAA7D,QAAA,eAAe,mBAA8C;AAE1E,2EAA2E;AACpE,MAAM,SAAS,GACpB,CAAC,gBAAkC,EAAE,EAAE,CACvC,CAAC,IAAU,EAAQ,EAAE;IACnB,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,IAAI,CAAC,WAAW,EAAiB,CAAC,CAAC;AAC5E,CAAC,CAAC;AAJS,QAAA,SAAS,aAIlB;AAEJ,kDAAkD;AAC3C,MAAM,UAAU,GAAG,CAAC,IAAU,EAAQ,EAAE;IAC7C,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACtB,IAAI,CAAC,YAAY,EAAE,CAAC;AACtB,CAAC,CAAC;AAHW,QAAA,UAAU,cAGrB;AAEF,sEAAsE;AAC/D,MAAM,kBAAkB,GAC7B,CAAC,uBAAgD,EAAE,EAAE,CACrD,CAAC,IAAU,EAAQ,EAAE,CACnB,uBAAuB;KACpB,SAAS,CAAC,IAAI,CAAC;KACf,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE,CAC3B,uBAAuB,CAAC,UAAU,CAAC,eAAe,CAAC,CACpD,CAAC;AAPK,QAAA,kBAAkB,sBAOvB;AAER,uHAAuH;AACvH,kFAAkF;AAC3E,MAAM,cAAc,GACzB,CAAC,iBAAoC,EAAE,EAAE,CACzC,CAAC,QAA2B,EAAQ,EAAE;IACpC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;IAE9B,iBAAiB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAEvC,IAAI,KAAK,CAAC,IAAI,EAAE,YAAY,gBAAM,EAAE;QAClC,KAAK,CAAC,OAAO,EAAE,CAAC;KACjB;AACH,CAAC,CAAC;AAVS,QAAA,cAAc,kBAUvB;AAEJ,iDAAiD;AAC1C,MAAM,YAAY,GACvB,CAAC,iBAAoC,EAAE,EAAE,CACzC,CAAC,IAAU,EAAW,EAAE,CACtB,iBAAiB,CAAC,cAAc,CAAC,IAA6B,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AAHlE,QAAA,YAAY,gBAGsD;AAE/E,uHAAuH;AACvH,6CAA6C;AACtC,MAAM,SAAS,GAAG,CAAC,iBAAoC,EAAE,EAAE;IAChE,MAAM,KAAK,GAAG,IAAA,sBAAc,EAAC,iBAAiB,CAAC,CAAC;IAEhD,OAAO,CAAC,IAAU,EAAE,MAAqB,EAAQ,EAAE,CACjD,iBAAiB;SACd,cAAc,CAAC,IAA6B,CAAC;QAC9C,0CAA0C;SACzC,KAAK,EAAE;SACP,OAAO,CAAC,CAAC,QAA2B,EAAQ,EAAE;QAC7C,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAE9B,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEhB,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,YAAY,aAAK,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE;YAChE,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SACvB;IACH,CAAC,CAAC,CAAC;AACT,CAAC,CAAC;AAjBW,QAAA,SAAS,aAiBpB;AAEF,kCAAkC;AAC3B,MAAM,QAAQ,GACnB,CAAC,iBAAoC,EAAE,EAAE,CACzC,CAAC,IAAU,EAAW,EAAE,CACtB,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAHvB,QAAA,QAAQ,YAGe;AAEpC,mEAAmE;AAC5D,MAAM,iBAAiB,GAAG,CAAC,iBAAoC,EAAE,EAAE;IACxE,MAAM,KAAK,GAAG,IAAA,sBAAc,EAAC,iBAAiB,CAAC,CAAC;IAEhD,OAAO,CAAC,IAAU,EAAQ,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;AACxE,CAAC,CAAC;AAJW,QAAA,iBAAiB,qBAI5B"}