@sandustry-modding/types 0.3.1 → 0.4.0

package/CHANGELOG.md

@@ -5,7 +5,34 @@ All notable changes to this project are documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.3.1] - 2026-08-27
+## Unreleased
+
+## 0.4.0 - 2026-08-29
+
+https://github.com/sandustry-modding/SandustryTypes/releases/tag/v0.4.0
+
+### Added
+
+- `npm run release` script: changelog/registry/auth checks, `validate`, then `npm publish` (optional `--dry-run`)
+- `src/configs/` types for `modinfo.json` and `patches.json` (`@sandustry-modding/types/configs`), with JSDoc on every key
+- Stronger structure definition fields: `tooltipHover`, `spanTiles`, `linkedClearance`, spritesheet/ui render blocks
+- Stronger `TechDefinition` fields used by tech nodes (`cost`, `unlocks`, `currencyType`, `branch`)
+- JSDoc `@example` blocks on many Sandkit members (main, worker, and configs)
+- Prebuilt Docsify search index (`docs/assets/search-index.js`) so API search works without a runtime crawl
+- Nested namespace roots in the docs sidebar (`sandkit`, `sandkit.api`, worker, engine, react)
+
+### Changed
+
+- Official `@see` links use a short “Official docs” label that deep-links to Sandkit HTML sections
+- Docs search ranks full runtime paths (`sandkit.api.settings.get()`) instead of local member names only
+- Move Full API reference to the bottom of the docs root nav block
+- Drop the page TOC plugin and the nested `docs/api/_sidebar.md` in favor of one site sidebar
+
+## 0.3.1 - 2026-08-27
+
+https://github.com/sandustry-modding/SandustryTypes/releases/tag/v0.3.1
+
+
 
 ### Fixed
 
@@ -17,14 +44,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - `npm run validate` gate: declaration typecheck, unit tests, and packed-tarball consumer probes
 
-## [0.3.0] - 2026-08-27
+## 0.3.0 - 2026-08-27
+
+https://github.com/sandustry-modding/SandustryTypes/releases/tag/v0.3.0
 
 ### Changed
 
 - Move declaration sources into `src/` (`src/sandkit`, `src/worker`, `src/shared`, `src/global.d.ts`). Package subpaths such as `@sandustry-modding/types/sandkit/engine` stay the same
 - Show local names for API member headings in the Docsify reference (full runtime path stays under each heading)
 
-## [0.2.0] - 2026-08-27
+## 0.2.0 - 2026-08-27
+
+https://github.com/sandustry-modding/SandustryTypes/releases/tag/v0.2.0
 
 ### Added
 
@@ -35,13 +66,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Canonical mutation names match official docs (`createAtCell`, `grid.mutate`, `getTypeById`, and similar). Old names stay as `@deprecated` aliases (`*WhenIdle`, `api.world`, `getTypeFromId`, and similar)
 
-## [0.1.1] - 2026-08-27
+## 0.1.1 - 2026-08-27
+
+https://github.com/sandustry-modding/SandustryTypes/releases/tag/v0.1.1
 
 ### Changed
 
 - Export subpaths (`./*`) so mods can import declaration modules such as `@sandustry-modding/types/sandkit/engine`
 
-## [0.1.0] - 2026-08-27
+## 0.1.0 - 2026-08-27
+
+https://github.com/sandustry-modding/SandustryTypes/releases/tag/v0.1.0
 
 ### Added
 
@@ -51,9 +86,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Shared base shapes under `shared/` for main and worker reuse
 - Ambient `sandkit` free variable and type aliases via `global.d.ts`
 - Docsify API reference generated from the declarations
-
-[0.3.1]: https://github.com/sandustry-modding/SandustryTypes/releases/tag/v0.3.1
-[0.3.0]: https://github.com/sandustry-modding/SandustryTypes/releases/tag/v0.3.0
-[0.2.0]: https://github.com/sandustry-modding/SandustryTypes/releases/tag/v0.2.0
-[0.1.1]: https://github.com/sandustry-modding/SandustryTypes/releases/tag/v0.1.1
-[0.1.0]: https://github.com/sandustry-modding/SandustryTypes/releases/tag/v0.1.0

package/README.md

@@ -19,6 +19,7 @@ Folder layout mirrors runtime shape so you can jump from code to the matching `.
 | `src/global.d.ts` | Ambient `sandkit` free variable and type aliases |
 | `src/worker/` | Worker-thread `sandkit.api` (see `WorkerSandkitApi`) |
 | `src/shared/` | Internal base shapes reused by main and worker declarations |
+| `src/configs/` | `modinfo.json` / `patches.json` schemas (not a runtime object) |
 
 ## Runtime shape vs `export namespace`
 
@@ -53,6 +54,7 @@ Deep declaration modules are also available, for example:
 
 ```ts
 import type { RetroConsoleGame } from "@sandustry-modding/types/sandkit/engine";
+import type { ModInfo, BundlePatch } from "@sandustry-modding/types/configs";
 ```
 
 ## Usage
@@ -60,6 +62,7 @@ import type { RetroConsoleGame } from "@sandustry-modding/types/sandkit/engine";
 - **Main mod (`main.js`):** use the ambient free name `sandkit`. Type aliases such as `SandkitApi` are global; do not import a value binding.
 - **Worker mod (`worker.js`):** type `sandkit.api` as `WorkerSandkitApi`. Worker and main APIs overlap but are not interchangeable.
 - **Shared folder:** not a runtime namespace. It holds domain shapes and API bases that main and worker modules extend.
+- **Configs folder:** `modinfo.json` and `patches.json` schemas (`@sandustry-modding/types/configs`). Not part of the live `sandkit` object.
 
 ## Maintaining types
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sandustry-modding/types",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "TypeScript declarations and API docs for the Sandustry Sandkit host API",
   "license": "MIT",
   "repository": {
@@ -67,6 +67,15 @@
         "./src/worker/*/*.d.ts",
         "./src/worker/*/*/index.d.ts"
       ]
+    },
+    "./configs": {
+      "types": "./src/configs/index.d.ts"
+    },
+    "./configs/*": {
+      "types": [
+        "./src/configs/*.d.ts",
+        "./src/configs/*/index.d.ts"
+      ]
     }
   },
   "files": [
@@ -83,7 +92,8 @@
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "verify-package": "node scripts/verify-package.mjs",
     "validate": "npm run typecheck && npm test && npm run verify-package",
-    "prepack": "npm run validate"
+    "prepack": "npm run validate",
+    "release": "node scripts/publish.mjs"
   },
   "devDependencies": {
     "@types/react": "^18.3.1",

package/src/configs/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Sandkit mod file schemas: `modinfo.json` and `patches.json`.
+ *
+ * These are not runtime `sandkit` properties. Import from
+ * `@sandustry-modding/types/configs` when typing mod folder config files.
+ *
+ * @module
+ *
+ * @see [Official docs](https://sandustry.com/sandkit.html#mod-files-heading)
+ */
+
+export type {
+  ConfigSchemaBoolean,
+  ConfigSchemaChoice,
+  ConfigSchemaChoiceOption,
+  ConfigSchemaEntry,
+  ConfigSchemaNumber,
+  ModGameVersion,
+  ModInfo,
+  ModMapBlueprints,
+  ModMapColorMapping,
+  ModMapColorMappingLayers,
+  ModMapDefinition,
+  ModMapDepthLight,
+  ModMapParallax,
+  ModMapPoint,
+  ModMapTopBounds,
+  ModProvide,
+  TextureOverride,
+} from "./modinfo";
+
+export type {
+  BundlePatch,
+  BundlePatchRegex,
+  BundlePatchesFile,
+  PatchOperation,
+  PatchTargetFile,
+} from "./patches";