feat(mocks-counterfact): create package, scripts, types, mocks (#9)

README.md

@@ -4,9 +4,11 @@ Monorepo for TypeScript packages related to [Artifacts MMO](https://artifactsmmo
 
 ## Packages
 
-| Name                                                                                                   | Folder                               | Description                      |
-|--------------------------------------------------------------------------------------------------------|--------------------------------------|----------------------------------|
-| [`@trey.turner/artifacts-api-client`](https://www.npmjs.com/package/@trey.turner/artifacts-api-client) | [`api-client`](packages/api-client/) | Typed and promisified API client |
+| Folder                                             | Name                                                                                                                 | Description                               |
+|----------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|-------------------------------------------|
+| [`api-client`](packages/api-client/)               | [`@trey.turner/artifacts-api-client`](https://www.npmjs.com/package/@trey.turner/artifacts-api-client)               | Typed and promisified API client in ESM   |
+| [`mocks-counterfact`](packages/mocks-counterfact/) | [`@trey.turner/artifacts-mocks-counterfact`](https://www.npmjs.com/package/@trey.turner/artifacts-mocks-counterfact) | Mocks & types generated from OpenAPI spec |
+| [`sandbox`](packages/api-client/)                  | Not published                                                                                                        | Code staging area                         |
 
 ## Tooling
 

biome.json → biome.jsonc

@@ -39,5 +39,23 @@
     "formatter": {
       "trailingCommas": "none"
     }
-  }
+  },
+  "overrides": [
+    {
+      "include": ["packages/mocks-counterfact/src/types.ts"],
+      "linter": {
+        "rules": {
+          "suspicious": {
+            "noExplicitAny": "off"
+          },
+          "correctness": {
+            "noUnusedVariables": "off"
+          },
+          "complexity": {
+            "noBannedTypes": "off"
+          }
+        }
+      }
+    }
+  ]
 }

package.json

@@ -23,5 +23,5 @@
     "@commitlint/config-conventional": "19.5.0",
     "husky": "9.1.6"
   },
-  "trustedDependencies": ["@biomejs/biome"]
+  "trustedDependencies": ["@biomejs/biome", "counterfact"]
 }

packages/api-client/README.md

@@ -1,29 +1,19 @@
-# ts-artifacts-api-client
+# artifacts-api-client
 
-A typed and promisified API client for [Artifacts MMO](https://artifactsmmo.com).
+A typed and promisified API client for Artifacts MMO in ESM.
 
 ## Status
 
 This is a new project in early development. Pull requests, issues, and suggestions are welcome. Use at your own risk; no warranty is expressed or implied.
 
 API coverage is believed to be complete. Some amount of automated E2E testing passed against the game's production API at the time of last release, but changes to the game may cause breakage until this client can be updated.
 
-Automated test coverage will be expanded in the future but isn't a priority at this time.
-
-At this time, development is driven by the needs of my [CLI](https://github.com/treyturner/ts-artifacts-cli). I'm currently exploring approaches to game and client state management.
-
 ## Installation
 
 Add as a dependency to your project's `package.json`:
 
 ```sh
-user@dev:~/ts-artifacts-api-client$ bun add @trey.turner/artifacts-api-client
-```
-
-Then install using your package manager or runtime of choice, like [bun](https://bun.sh):
-
-```sh
-user@dev:~/ts-artifacts-api-client$ bun i
+user@dev:~/some-project$ bun add @trey.turner/artifacts-api-client
 ```
 
 ## Configuration
@@ -58,7 +48,7 @@ When your required configuration is set into environment variables, you can use
 import { ArtifactsApi } from '@trey.turner/artifacts-api-client';
 
 const api = new ArtifactsApi();
-// will logs response to console if configured as such
+// will log response to console if configured as such
 await api.info.meta.getServerStatus();
 ```
 

packages/api-client/src/config.ts

@@ -1,6 +1,6 @@
 import "dotenv";
+import type { Config, Preferences, RecursivePartial } from "./types";
 import { getCallerName, log, pp } from "./util";
-import type { Config, RecursivePartial, Preferences } from "./types";
 
 const { env } = process;
 

packages/mocks-counterfact/.npmignore

@@ -0,0 +1,2 @@
+node_modules
+test

packages/mocks-counterfact/README.md

@@ -0,0 +1,3 @@
+# artifacts-mocks-counterfact
+
+Mocks of Artifacts MMO API generated from their published OpenAPI specification using counterfact.

packages/mocks-counterfact/biome.jsonc

@@ -0,0 +1,21 @@
+{
+  "extends": ["../../biome.jsonc"],
+  "overrides": [
+    {
+      "include": ["src/types.ts"],
+      "linter": {
+        "rules": {
+          "suspicious": {
+            "noExplicitAny": "off"
+          },
+          "correctness": {
+            "noUnusedVariables": "off"
+          },
+          "complexity": {
+            "noBannedTypes": "off"
+          }
+        }
+      }
+    }
+  ]
+}

packages/mocks-counterfact/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@trey.turner/artifacts-mocks-counterfact",
+  "version": "0.0.1",
+  "module": "index.ts",
+  "main": "dist/index.js",
+  "types": "dist/types.d.ts",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/treyturner/ts-artifacts.git"
+  },
+  "scripts": {
+    "build": "tsc -p src/tsconfig.json",
+    "check": "bun run --silent lint && bun run --silent format && bun run --silent typecheck",
+    "check:fix": "bun run --silent lint:fix && bun run --silent format:fix && bun run --silent typecheck",
+    "clean": "bun run --silent clean:build && bun run --silent clean:deps",
+    "clean:build": "rm -rf dist",
+    "clean:deps": "rm -rf node_modules bun.lockb",
+    "format": "biome format src/ test/",
+    "format:fix": "biome format --write src/ test/",
+    "generate": "bun run counterfact -g https://api.artifactsmmo.com/openapi.json src",
+    "lint": "biome lint --error-on-warnings src/ test/",
+    "lint:fix": "biome lint --error-on-warnings --fix src/ test/",
+    "open": "bun run counterfact -o https://api.artifactsmmo.com/openapi.json src",
+    "repl": "bun run counterfact -wrs https://api.artifactsmmo.com/openapi.json src",
+    "start": "bun run watch",
+    "typecheck": "tsc -p src/tsconfig.json && tsc --noEmit -p test/tsconfig.json",
+    "watch": "bun run counterfact -ws https://api.artifactsmmo.com/openapi.json src"
+  },
+  "dependencies": {
+    "counterfact": "1.1.0"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "5.6.2"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

packages/mocks-counterfact/src/.gitignore

@@ -0,0 +1 @@
+.cache

packages/mocks-counterfact/src/routes/_.context.ts

@@ -0,0 +1,11 @@
+/**
+ * This is the default context for Counterfact.
+ *
+ * It defines the context object in the REPL
+ * and the $.context object in the code.
+ *
+ * Add properties and methods to suit your needs.
+ *
+ * See https://counterfact.dev/docs/usage.html#working-with-state-the-codecontextcode-object-and-codecontexttscode
+ */
+export class Context {}

packages/mocks-counterfact/src/routes/accounts/create.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../types/paths/accounts/create.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/achievements.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../types/paths/achievements.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/achievements/{code}.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../../types/paths/achievements/{code}.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/characters.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../types/paths/characters.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/characters/create.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../types/paths/characters/create.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/characters/delete.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../types/paths/characters/delete.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/characters/{name}.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../../types/paths/characters/{name}.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/characters/{name}/achievements.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../../../types/paths/characters/{name}/achievements.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/events.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../types/paths/events.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/ge.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../types/paths/ge.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/ge/{code}.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../../types/paths/ge/{code}.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/index.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../types/paths/index.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/items.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../types/paths/items.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/items/{code}.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../../types/paths/items/{code}.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/leaderboard.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../types/paths/leaderboard.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/maps.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../types/paths/maps.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/maps/{x}/{y}.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../../../types/paths/maps/{x}/{y}.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/monsters.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../types/paths/monsters.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/monsters/{code}.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../../types/paths/monsters/{code}.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/bank.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../../types/paths/my/bank.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/bank/items.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../../../types/paths/my/bank/items.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/change_password.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../types/paths/my/change_password.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/characters.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../../types/paths/my/characters.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/logs.ts

@@ -0,0 +1,5 @@
+import type { HTTP_GET } from "../../types/paths/my/logs.types.js";
+
+export const GET: HTTP_GET = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/{name}/action/bank/buy_expansion.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../../../../types/paths/my/{name}/action/bank/buy_expansion.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/{name}/action/bank/deposit.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../../../../types/paths/my/{name}/action/bank/deposit.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/{name}/action/bank/deposit/gold.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../../../../../types/paths/my/{name}/action/bank/deposit/gold.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/{name}/action/bank/withdraw.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../../../../types/paths/my/{name}/action/bank/withdraw.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/{name}/action/bank/withdraw/gold.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../../../../../types/paths/my/{name}/action/bank/withdraw/gold.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/{name}/action/crafting.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../../../types/paths/my/{name}/action/crafting.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/{name}/action/delete.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../../../types/paths/my/{name}/action/delete.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/{name}/action/equip.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../../../types/paths/my/{name}/action/equip.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/{name}/action/fight.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../../../types/paths/my/{name}/action/fight.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/{name}/action/gathering.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../../../types/paths/my/{name}/action/gathering.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/{name}/action/ge/buy.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../../../../types/paths/my/{name}/action/ge/buy.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};

packages/mocks-counterfact/src/routes/my/{name}/action/ge/sell.ts

@@ -0,0 +1,5 @@
+import type { HTTP_POST } from "../../../../../types/paths/my/{name}/action/ge/sell.types.js";
+
+export const POST: HTTP_POST = ($) => {
+  return $.response[200].random();
+};