@civ-clone/base-unit-action-bribe-unit 0.0.0-stage → 0.1.0

package/.gitattributes

@@ -0,0 +1,2 @@
+**/*.js 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/BribeUnit.d.ts

@@ -0,0 +1,25 @@
+import { RuleRegistry } from '@civ-clone/core-rule/RuleRegistry';
+import Action from '@civ-clone/core-unit/Action';
+import Tile from '@civ-clone/core-world/Tile';
+import Unit from '@civ-clone/core-unit/Unit';
+/**
+ * A Diplomat pays `cost()` for `target()` to desert to its civilization. Whether it can is up to the `UnitBribed`
+ * rules. The Diplomat isn't used up, and keeps its moves.
+ */
+export declare class BribeUnit extends Action {
+  private _cost;
+  private _target;
+  constructor(
+    from: Tile,
+    to: Tile,
+    unit: Unit,
+    target: Unit,
+    cost: number,
+    ruleRegistry?: RuleRegistry
+  );
+  cost(): number;
+  target(): Unit;
+  forUnit(unit: Unit): Action;
+  perform(): void;
+}
+export default BribeUnit;

package/BribeUnit.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BribeUnit = void 0;
+const RuleRegistry_1 = require("@civ-clone/core-rule/RuleRegistry");
+const Action_1 = require("@civ-clone/core-unit/Action");
+const UnitBribed_1 = require("./Rules/UnitBribed");
+/**
+ * A Diplomat pays `cost()` for `target()` to desert to its civilization. Whether it can is up to the `UnitBribed`
+ * rules. The Diplomat isn't used up, and keeps its moves.
+ */
+class BribeUnit extends Action_1.default {
+    constructor(from, to, unit, target, cost, ruleRegistry = RuleRegistry_1.instance) {
+        super(from, to, unit, ruleRegistry);
+        this._cost = cost;
+        this._target = target;
+        this.addKey('cost');
+    }
+    cost() {
+        return this._cost;
+    }
+    target() {
+        return this._target;
+    }
+    // `Action.forUnit` rebuilds an action from `(from, to, unit, ruleRegistry)`, which would put the `RuleRegistry` where
+    // the target goes.
+    // Typed as `Action`: a subclass with a member of its own isn't assignable to it (civ-clone/web-renderer#21).
+    forUnit(unit) {
+        return new BribeUnit(this.from(), this.to(), unit, this._target, this._cost, this.ruleRegistry());
+    }
+    perform() {
+        this.ruleRegistry().process(UnitBribed_1.default, this.unit(), this._target, this);
+    }
+}
+exports.BribeUnit = BribeUnit;
+exports.default = BribeUnit;
+//# sourceMappingURL=BribeUnit.js.map

package/BribeUnit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BribeUnit.js","sourceRoot":"","sources":["BribeUnit.ts"],"names":[],"mappings":";;;AAAA,oEAG2C;AAC3C,wDAAiD;AAGjD,mDAA4C;AAE5C;;;GAGG;AACH,MAAa,SAAU,SAAQ,gBAAM;IAInC,YACE,IAAU,EACV,EAAQ,EACR,IAAU,EACV,MAAY,EACZ,IAAY,EACZ,eAA6B,uBAAoB;QAEjD,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;QAEpC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QAEtB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,sHAAsH;IACtH,mBAAmB;IACnB,6GAA6G;IAC7G,OAAO,CAAC,IAAU;QAChB,OAAO,IAAI,SAAS,CAClB,IAAI,CAAC,IAAI,EAAE,EACX,IAAI,CAAC,EAAE,EAAE,EACT,IAAI,EACJ,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,YAAY,EAAE,CACC,CAAC;IACzB,CAAC;IAED,OAAO;QACL,IAAI,CAAC,YAAY,EAAE,CAAC,OAAO,CAAC,oBAAU,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC3E,CAAC;CACF;AA7CD,8BA6CC;AAED,kBAAe,SAAS,CAAC"}

package/BribeUnit.ts

@@ -0,0 +1,61 @@
+import {
+  RuleRegistry,
+  instance as ruleRegistryInstance,
+} from '@civ-clone/core-rule/RuleRegistry';
+import Action from '@civ-clone/core-unit/Action';
+import Tile from '@civ-clone/core-world/Tile';
+import Unit from '@civ-clone/core-unit/Unit';
+import UnitBribed from './Rules/UnitBribed';
+
+/**
+ * A Diplomat pays `cost()` for `target()` to desert to its civilization. Whether it can is up to the `UnitBribed`
+ * rules. The Diplomat isn't used up, and keeps its moves.
+ */
+export class BribeUnit extends Action {
+  private _cost: number;
+  private _target: Unit;
+
+  constructor(
+    from: Tile,
+    to: Tile,
+    unit: Unit,
+    target: Unit,
+    cost: number,
+    ruleRegistry: RuleRegistry = ruleRegistryInstance
+  ) {
+    super(from, to, unit, ruleRegistry);
+
+    this._cost = cost;
+    this._target = target;
+
+    this.addKey('cost');
+  }
+
+  cost(): number {
+    return this._cost;
+  }
+
+  target(): Unit {
+    return this._target;
+  }
+
+  // `Action.forUnit` rebuilds an action from `(from, to, unit, ruleRegistry)`, which would put the `RuleRegistry` where
+  // the target goes.
+  // Typed as `Action`: a subclass with a member of its own isn't assignable to it (civ-clone/web-renderer#21).
+  forUnit(unit: Unit): Action {
+    return new BribeUnit(
+      this.from(),
+      this.to(),
+      unit,
+      this._target,
+      this._cost,
+      this.ruleRegistry()
+    ) as unknown as Action;
+  }
+
+  perform(): void {
+    this.ruleRegistry().process(UnitBribed, this.unit(), this._target, this);
+  }
+}
+
+export default BribeUnit;

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,3 @@
-# Temporary Holding Version
+# base-unit-action-bribe-unit
 
-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.
+The `BribeUnit` unit action. See civ-clone/web-renderer#58.

package/Rules/UnitBribed.d.ts

@@ -0,0 +1,12 @@
+import type BribeUnit from '../BribeUnit';
+import Rule from '@civ-clone/core-rule/Rule';
+import Unit from '@civ-clone/core-unit/Unit';
+/**
+ * Processed when a Diplomat (the first `Unit`) bribes the second, by the `BribeUnit` action. `true` when the unit
+ * changed sides.
+ */
+export declare class UnitBribed extends Rule<
+  [Unit, Unit, BribeUnit],
+  boolean
+> {}
+export default UnitBribed;

package/Rules/UnitBribed.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnitBribed = void 0;
+const Rule_1 = require("@civ-clone/core-rule/Rule");
+/**
+ * Processed when a Diplomat (the first `Unit`) bribes the second, by the `BribeUnit` action. `true` when the unit
+ * changed sides.
+ */
+class UnitBribed extends Rule_1.default {
+}
+exports.UnitBribed = UnitBribed;
+exports.default = UnitBribed;
+//# sourceMappingURL=UnitBribed.js.map

package/Rules/UnitBribed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UnitBribed.js","sourceRoot":"","sources":["UnitBribed.ts"],"names":[],"mappings":";;;AACA,oDAA6C;AAG7C;;;GAGG;AACH,MAAa,UAAW,SAAQ,cAAsC;CAAG;AAAzE,gCAAyE;AAEzE,kBAAe,UAAU,CAAC"}

package/Rules/UnitBribed.ts

@@ -0,0 +1,11 @@
+import type BribeUnit from '../BribeUnit';
+import Rule from '@civ-clone/core-rule/Rule';
+import Unit from '@civ-clone/core-unit/Unit';
+
+/**
+ * Processed when a Diplomat (the first `Unit`) bribes the second, by the `BribeUnit` action. `true` when the unit
+ * changed sides.
+ */
+export class UnitBribed extends Rule<[Unit, Unit, BribeUnit], boolean> {}
+
+export default UnitBribed;

package/package.json

@@ -1,6 +1,29 @@
 {
   "name": "@civ-clone/base-unit-action-bribe-unit",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "main": "BribeUnit.js",
+  "repository": "git@github.com:civ-clone/base-unit-action-bribe-unit.git",
+  "keywords": [
+    "typescript",
+    "civilization"
+  ],
+  "author": "dom111 <dom111@users.noreply.github.com>",
+  "license": "MIT",
+  "private": false,
+  "scripts": {
+    "build": "npm run ts:compile && npm run prettier:format",
+    "prettier:check": "prettier --config .prettierrc --check '**/*.ts'",
+    "prettier:format": "prettier --config .prettierrc '**/*.ts' --write",
+    "ts:compile": "tsc --build tsconfig.json"
+  },
+  "devDependencies": {
+    "@types/node": "^14.18.63",
+    "prettier": "^2.8.8",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "@civ-clone/core-rule": "^0.1.6",
+    "@civ-clone/core-unit": "^0.1.25",
+    "@civ-clone/core-world": "^0.1.14"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "lib": [
+      "es2019"
+    ],
+    "module": "commonjs",
+    "sourceMap": true,
+    "strict": true,
+    "target": "ES2018"
+  },
+  "exclude": [
+    "node_modules",
+    "tests/*.test.ts"
+  ]
+}