wc3maptranslator 3.0.3 → 4.0.1

package/.codeclimate.yml

@@ -9,5 +9,4 @@ ratings:
   - "**.ts"
   - "**.tsx"
 exclude_paths:
-  - examples/
   - test/

package/.eslintignore

@@ -1,6 +1,5 @@
 /.git/*
 /.nyc_output/*
 /coverage/*
-/examples/*
 /node_modules/*
 /test/*

package/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,54 @@
+name: "Code scanning - action"
+
+on:
+  push:
+    branches: [master, ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [master]
+  schedule:
+    - cron: '0 22 * * 5'
+
+jobs:
+  CodeQL-Build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      # Override language selection by uncommenting this and choosing your languages
+      # with:
+      #   languages: go, javascript, csharp, python, cpp, java
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

package/.nycrc

@@ -8,8 +8,7 @@
     ],
     "exclude": [
       "**/*.d.ts",
-      "**/coverage/**",
-      "**/examples/**"
+      "**/coverage/**"
     ],
     "reporter": [
       "lcov",

package/.travis.yml

@@ -2,9 +2,8 @@
 
 language: node_js
 
-# Run build on Node v8
 node_js:
-  - "8"
+  - "14"
 
 branches:
   only:

package/CHANGELOG.md

@@ -0,0 +1,78 @@
+# 4.0.1 (2023-08-06)
+## SUMMARY
+## FIXES
+ * Project properly builds all TS files upon installation, resolving out-of-the-box errors
+
+# 4.0.0 (2021-02-28)
+## SUMMARY
+**🔥 Breaking changes**
+
+This major release significantly overhauls WC3MapTranslator since the release of WarCraft III: Reforged. There are a few breaking changes in this release.
+
+The two largest changes include a new usage contract and changes to the terrain `.json` format, both of which are detailed below. This release also integrates the latest file formats, after a few changes to the war3map formats to support Reforged.
+
+The old usage contract meant that developers had to instantiate translators, which didn't make much sense. Now translators are static classes that can be used directly after importing.
+
+The `.json` format for terrain gets rid of the bulky `tile` objects and returns to a one-dimensional mask array for things like ground height, boundary flags, etc. In an older version of WC3MapTranslator, terrain used to be a multi-dimensional array of rows, followed by the `tile` object format. The problems with the `tile` object format were two-fold: (1) file size would blow up (e.g. a 29kB `.w3e` file would become a 1199kB `.json` terrain file); and (2) the bulky `tile` objects did not lend themselves to the spirit of having a diff-able JSON file. We believe that a single-dimensional array will allow developers to more easily see differences between JSONs.
+
+Another exciting change is a new [WC3MapSpecification](https://github.com/ChiefOfGxBxL/WC3MapSpecification) repository for documenting the war3map specifications. This is a living document, meaning it may be updated in-place as our understanding of the file formats improves!
+
+## FEATURES
+ * 🔥 Improve usage contract:
+   * Translators are now exported by this library (e.g. `import { ObjectTranslator } from 'wc3maptranslator'`)
+   * Translators no longer need to be instantiated to be used
+ * 🔥 Change terrain format:
+   * Tiles are now defined via "masks", for ground height, texture, variation, etc.
+     * Before: `tiles` is an array of objects... `{ groundHeight, waterHeight, boundaryFlag, flags, groundTexture, groundVariation, cliffVariation, cliffTexture, layerHeight }`
+     * After: a one-dimensional array for each of the above fields... e.g. for a 64x64 map, `groundHeight` is an array of 65*65=4225 tile points
+   * Some fields have been renamed into camelCase for consistency:
+     * `customtileset` -> `customTileset`
+     * `tilepalette` -> `tilePalette`
+     * `clifftilepalette` -> `cliffTilePalette`
+ * Upgrade to latest file formats
+   * Sounds version upgraded from `1` -> `3`
+   * Info version upgraded from `25` -> `31`
+ * Add more type safety:
+   * Translator results from `jsonToWar()` and `warToJson()` are now typed by `WarResult` and `JsonResult`, respectively
+   * `JsonResult` is generically typed to describe what it contains (e.g. `Sound[]`)
+   * Introduced new `angle` type, which is an alias for `number`; `angle`'s should always be specified in degrees, not radians
+## FIXES
+ * Resolve `[DEP0005] DeprecationWarning: Buffer()` warning in `HexBuffer.ts`
+ * Fix scoping issues on `*Translator.ts`, `HexBuffer.ts` and `W3Buffer.ts` where certain fields that should be `private` were marked as `public`
+ * Fix InfoTranslator reading random item table ID length as 1 instead of 4
+ * Fix potential null-terminator errors related to string or character-array fields
+## MAINTENANCE
+ * Upgrade to Node 14.x LTS
+ * Upgrade to npm 7.x
+ * Upgrade `round-to` 4.1.0 -> 5.0.0
+ * Upgrade `@types/fs-extra` 8.1.0 -> 9.0.7
+ * Upgrade `@types/mocha` 7.0.1 -> 8.2.1
+ * Upgrade `@types/node` 12.12.28 -> 14.14.31
+ * Upgrade `fs-extra` 8.1.0 -> 9.1.0
+ * Upgrade `mocha` 7.0.1 -> 8.3.0
+ * Upgrade `nyc` 15.0.0 -> 15.1.0
+ * Upgrade `ts-node` 8.6.2 -> 9.1.1
+ * Upgrade `tslint` 6.0.0 -> 6.1.3
+ * Upgrade `typescript` 3.8.2 -> 4.2.2
+ * The project structure has changed:
+    * `examples` sub-project directory is removed
+    * Refer to `USAGE.md` for how to use the code
+ * Add all contributors to `package.json`
+ * Resolve all security issues via `npm audit fix` (5 low, 1 high, 1 critical)
+## TESTING
+ * Travis CI will now use Node 14 LTS to build the project
+ * `test` directory now contains the WC3 and JSON data files the tests require
+ * Implement the StringsTranslator test
+ * Resolve all broken unit tests, most of them being reversion tests
+<!--
+# x.y.z (YYYY-MM-DD)
+## SUMMARY
+**🔥 Breaking changes**
+## FEATURES
+## FIXES
+## MAINTENANCE
+## TESTING
+-->
+
+# Previous versions
+The `CHANGELOG.md` file was introduced with the 4.x release. For details on previous changes, please refer to https://github.com/ChiefOfGxBxL/WC3MapTranslator/releases.

package/LICENSE.md

@@ -0,0 +1,23 @@
+# MIT License
+
+Copyright (c) 2020 ChiefOfGxBxL
+
+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,8 +1,17 @@
 <p align='center'>
-  <b>WC3MapTranslator</b>
+  <b>WC3MapTranslator</b><br/>
+  Translate <code>war3map</code> ⇄ <code>json</code> formats for WarCraft III .w3x maps
 </p>
 <p align='center'>
-  Translate <code>war3map</code> ⇄ <code>json</code> formats for WarCraft III .w3x maps
+  <a href='https://www.npmjs.com/package/wc3maptranslator'>
+    <img src='https://badge.fury.io/js/wc3maptranslator.svg?style=flat-square'/>
+  </a>
+  <a href='https://www.npmjs.com/package/wc3maptranslator'>
+    <img src='https://img.shields.io/npm/dt/wc3maptranslator.svg'/>
+  </a>
+  <a href='https://opensource.org/licenses/MIT'>
+    <img src='https://img.shields.io/badge/license-MIT-blue.svg'/>
+  </a>
 
   <p align='center'>
     <b>Quality</b><br/>
@@ -22,19 +31,7 @@
     <a href="https://snyk.io/test/github/chiefofgxbxl/wc3maptranslator?targetFile=package.json">
       <img src="https://snyk.io/test/github/chiefofgxbxl/wc3maptranslator/badge.svg?targetFile=package.json" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/chiefofgxbxl/wc3maptranslator?targetFile=package.json" style="max-width:100%;">
     </a>
-    <br/><br/>
-    <b>Info</b><br/>
-    <a href='https://www.npmjs.com/package/wc3maptranslator'>
-      <img src='https://badge.fury.io/js/wc3maptranslator.svg?style=flat-square'/>
-    </a>
-    <a href='https://www.npmjs.com/package/wc3maptranslator'>
-      <img src='https://img.shields.io/npm/dt/wc3maptranslator.svg'/>
-    </a>
-    <a href='https://opensource.org/licenses/MIT'>
-      <img src='https://img.shields.io/badge/license-MIT-blue.svg'/>
-    </a>
   </p>
-
 </p>
 
 <hr/>
@@ -42,7 +39,6 @@
   <a href="#overview"><strong>Overview</strong></a> &middot;
   <a href="#install"><strong>Install</strong></a> &middot;
   <a href="#usage"><strong>Usage</strong></a> &middot;
-  <a href="#examples"><strong>Examples</strong></a> &middot;
   <a href="#file-support"><strong>File Support</strong></a> &middot;
   <a href="#specification"><strong>Specification</strong></a> &middot;
   <a href="#contributing"><strong>Contributing</strong></a> &middot;
@@ -51,66 +47,59 @@
 <hr/>
 
 ## Overview
-WC3MapTranslator is a module to convert a JSON representation of WarCraft III (.w3x) data to their `war3map` files, and vice-versa. This makes the map data readable and easily modifiable.
+WC3MapTranslator is a TypeScript module to convert between JSON and WarCraft III (.w3x) `war3map` formats. This makes the map data readable and easily modifiable, a perfect format for storing WC3 maps in Git repositories and inspecting diffs!
 
 ![TranslationExample](https://user-images.githubusercontent.com/4079034/71315302-4947fb00-2427-11ea-8f50-edf05d6e5c6a.png)
 
-WC3MapTranslator is written in `TypeScript` starting from version `3.0.0`, offering type safety and improved development experience.
-
 ## Install
 ```ts
 npm install wc3maptranslator
 ```
 
-**Requires Node >= 8**  
-**Tested with tsc Version 3.7.2**
+**Requires Node ≥ 14**  
 
 ## Usage
-### JavaScript (version < 3.0.0)
 ```ts
-var Translator = require('wc3maptranslator'),
-    mapJson = { // Refer to "Specification"
-        units: [...],
-        doodads: [...],
-        ...
-    };
-var unitResult = new Translator.Units.jsonToWar(mapJson.units);
+import {
+  CamerasTranslator,
+  DoodadsTranslator,
+  ImportsTranslator,
+  InfoTranslator,
+  ObjectsTranslator,
+  RegionsTranslator,
+  SoundsTranslator,
+  StringsTranslator,
+  TerrainTranslator,
+  UnitsTranslator
+} from 'wc3maptranslator';
+
+// E.g. let's create a camera for the map
+const cameras = [
+  {
+    "target": {
+      "x": -319.01,
+      "y": -90.18
+    },
+    "offsetZ": 0,
+    "rotation": 90,
+    "aoa": 304,
+    "distance": 2657.34,
+    "roll": 5,
+    "fov": 70,
+    "farClipping": 5000,
+    "name": "MyCamera1"
+  }
+]
+
+// Now translate the JSON into the WarCraft III format
+// All translators have: `.jsonToWar` and `.warToJson` functions
+const translatedResult = CamerasTranslator.jsonToWar(cameras);
+
+// `translatedResult` contains a `buffer` which can be saved to disk
+// This war3map.w3c file can now be placed inside a .w3x via an MPQ
+// editor, and you should now see a camera in the Camera Palette!
+fs.writeFileSync('war3map.w3c', translatedResult.buffer);
 ```
-### TypeScript (version >= 3.0.0)
-```js
-// JS import
-const TranslatorLib = require('wc3maptranslator');
-const Translator = new TranslatorLib();
-console.log(Translator);
-```
-```ts
-//... or TS import
-import { Translator } from 'wc3maptranslator';
-const myTranslator = new Translator();
-console.log(Translator);
-```
-### Using the Translator
-```ts
-// e.g. unit translator
-const unitResult = new Translator.Units.jsonToWar(mapJson.units);
-// all:
-* Doodads
-* Strings
-* Terrain
-* Units
-* Regions
-* Cameras
-* Sounds
-* Objects
-* Imports
-* Info
-```
-We can now write the `unitResult.buffer` content to a file named "war3mapUnits.doo" and put it in a .w3x archive! Using individual translators, we may convert JSON representation to generate a WC3 .w3x map file. See the Wiki for more information.
-
-## Examples
-There is an `examples` directory that demonstrates how to use *each* translator, both for converting from war3map to JSON, and JSON to war3map formats. This is a great starting point to learn how to use any translator.
-
-To get started with either example, `cd` into `/examples/` and run `npm install` to install all the dependencies. Then run `npm start` which kicks off the TypeScript build and then executes the resulting JavaScript. A few output files will be written under the `/examples/` directory, but the output is purposely not comprehensive to avoid spamming the directory and because the translation process is sufficiently demonstrated using just one example of translating in each direction.
 
 ## File Support
 
@@ -157,25 +146,29 @@ To get started with either example, `cd` into `/examples/` and run `npm install`
 | Shadow map              | ![times](https://cloud.githubusercontent.com/assets/4079034/25298707/7a883642-26c5-11e7-841c-cd3eb1425461.png) | ![times](https://cloud.githubusercontent.com/assets/4079034/25298707/7a883642-26c5-11e7-841c-cd3eb1425461.png) | war3map.shd        |
 
 
-### Not included
- ![times](https://cloud.githubusercontent.com/assets/4079034/25298707/7a883642-26c5-11e7-841c-cd3eb1425461.png) Custom Text Trigger File (war3map.wct)  
-  ![times](https://cloud.githubusercontent.com/assets/4079034/25298707/7a883642-26c5-11e7-841c-cd3eb1425461.png) Trigger Names File (war3map.wtg)  
- ![times](https://cloud.githubusercontent.com/assets/4079034/25298707/7a883642-26c5-11e7-841c-cd3eb1425461.png) Menu Minimap (war3map.mmp)  
- ![times](https://cloud.githubusercontent.com/assets/4079034/25298707/7a883642-26c5-11e7-841c-cd3eb1425461.png) Minimap Image (war3mapMap.blp)  
- ![times](https://cloud.githubusercontent.com/assets/4079034/25298707/7a883642-26c5-11e7-841c-cd3eb1425461.png) Minimap Image (war3mapMap.b00  
- ![times](https://cloud.githubusercontent.com/assets/4079034/25298707/7a883642-26c5-11e7-841c-cd3eb1425461.png) Minimap Image (war3mapMap.tga)  
- ![times](https://cloud.githubusercontent.com/assets/4079034/25298707/7a883642-26c5-11e7-841c-cd3eb1425461.png) Map Preview Image (war3mapPreview.tga)
+### Not relevant
+ ![minus-solid](https://user-images.githubusercontent.com/4079034/108644014-16f6bb00-747b-11eb-8c2b-9e7a1d7b6f9b.png) Custom Text Trigger File (war3map.wct)  
+ ![minus-solid](https://user-images.githubusercontent.com/4079034/108644014-16f6bb00-747b-11eb-8c2b-9e7a1d7b6f9b.png) Trigger Names File (war3map.wtg)  
+ ![minus-solid](https://user-images.githubusercontent.com/4079034/108644014-16f6bb00-747b-11eb-8c2b-9e7a1d7b6f9b.png) Menu Minimap (war3map.mmp)  
+ ![minus-solid](https://user-images.githubusercontent.com/4079034/108644014-16f6bb00-747b-11eb-8c2b-9e7a1d7b6f9b.png) Minimap Image (war3mapMap.blp)  
+ ![minus-solid](https://user-images.githubusercontent.com/4079034/108644014-16f6bb00-747b-11eb-8c2b-9e7a1d7b6f9b.png) Minimap Image (war3mapMap.b00  
+ ![minus-solid](https://user-images.githubusercontent.com/4079034/108644014-16f6bb00-747b-11eb-8c2b-9e7a1d7b6f9b.png) Minimap Image (war3mapMap.tga)  
+ ![minus-solid](https://user-images.githubusercontent.com/4079034/108644014-16f6bb00-747b-11eb-8c2b-9e7a1d7b6f9b.png) Map Preview Image (war3mapPreview.tga)
 
 ## Specification
-We have a detailed [specification on our Wiki](https://github.com/ChiefOfGxBxL/WC3MapTranslator/wiki) explaining how to format a map in JSON. It explains everything from the high-level map object, all the way down to creating individual units, tiles, or custom objects.
+### WC3MapTranslator format
+We have a detailed  explaining how to format a map in JSON. It explains everything from the high-level map object, all the way down to creating individual units, tiles, or custom objects.
+ > 🔗 [WC3MapTranslator format](https://github.com/ChiefOfGxBxL/WC3MapTranslator/wiki)
 
-The underlying WarCraft map files (e.g. war3map.doo) have been documented [on our Wiki](https://github.com/ChiefOfGxBxL/WC3MapTranslator/wiki) as well. If you are curious about how a .w3x file is composed, this is the place to learn!
+### war3map format
+The underlying WarCraft map files (e.g. war3map.doo) have been documented in a separate repository. If you are curious about how a .w3x file is composed, this is the place to learn!
+ > 🔗 [WC3MapSpecification](https://github.com/ChiefOfGxBxL/WC3MapSpecification)
 
 ## Contributing
 We encourage contributions! Generally, the process of making a change is:
 1. Fork this repo
 2. Develop your changes on a new branch
-3. Submit a pull request to `master`
+3. Submit a pull request to `dev`
 
 **Your code should**:
  * **run** (your code needs to work, of course)
@@ -183,7 +176,7 @@ We encourage contributions! Generally, the process of making a change is:
  * **be linted** (run `npm run lint` and follow the project's coding standards)
  * **pass CI** (we enforce: ESLint, unit tests pass, code coverage)
 
-A code review is required on your PR to be accepted into `master`. A project member will get back to you within one week. If you haven't heard from someone regarding your PR, feel free to ping @chiefofgxbxl.
+A code review is required on your PR to be accepted into `dev`. A project member will get back to you within one week. If you haven't heard from someone regarding your PR, feel free to ping @chiefofgxbxl.
 
 ## Special Thanks
 We owe a lot of thanks to *Chocobo* on [TheHelper](http://www.thehelper.net/) for the detailed documentation of the files found in a .w3x archive. Two tutorials are [here (1)](http://www.thehelper.net/threads/guide-explanation-of-w3m-and-w3x-files.35292/) and [here (2)](http://world-editor-tutorials.thehelper.net/cat_usersubmit.php?view=42787).

package/index.js

@@ -1,19 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnitsTranslator = exports.TerrainTranslator = exports.StringsTranslator = exports.SoundsTranslator = exports.RegionsTranslator = exports.ObjectsTranslator = exports.InfoTranslator = exports.ImportsTranslator = exports.DoodadsTranslator = exports.CamerasTranslator = void 0;
 const translators_1 = require("./lib/translators");
-class Translator {
-    constructor() {
-        this.Doodads = new translators_1.DoodadsTranslator();
-        this.Strings = new translators_1.StringsTranslator();
-        this.Terrain = new translators_1.TerrainTranslator();
-        this.Units = new translators_1.UnitsTranslator();
-        this.Regions = new translators_1.RegionsTranslator();
-        this.Cameras = new translators_1.CamerasTranslator();
-        this.Sounds = new translators_1.SoundsTranslator();
-        this.Objects = new translators_1.ObjectsTranslator();
-        this.Imports = new translators_1.ImportsTranslator();
-        this.Info = new translators_1.InfoTranslator();
-    }
-}
-exports.Translator = Translator;
+Object.defineProperty(exports, "CamerasTranslator", { enumerable: true, get: function () { return translators_1.CamerasTranslator; } });
+Object.defineProperty(exports, "DoodadsTranslator", { enumerable: true, get: function () { return translators_1.DoodadsTranslator; } });
+Object.defineProperty(exports, "ImportsTranslator", { enumerable: true, get: function () { return translators_1.ImportsTranslator; } });
+Object.defineProperty(exports, "InfoTranslator", { enumerable: true, get: function () { return translators_1.InfoTranslator; } });
+Object.defineProperty(exports, "ObjectsTranslator", { enumerable: true, get: function () { return translators_1.ObjectsTranslator; } });
+Object.defineProperty(exports, "RegionsTranslator", { enumerable: true, get: function () { return translators_1.RegionsTranslator; } });
+Object.defineProperty(exports, "SoundsTranslator", { enumerable: true, get: function () { return translators_1.SoundsTranslator; } });
+Object.defineProperty(exports, "StringsTranslator", { enumerable: true, get: function () { return translators_1.StringsTranslator; } });
+Object.defineProperty(exports, "TerrainTranslator", { enumerable: true, get: function () { return translators_1.TerrainTranslator; } });
+Object.defineProperty(exports, "UnitsTranslator", { enumerable: true, get: function () { return translators_1.UnitsTranslator; } });
 //# sourceMappingURL=index.js.map

package/index.ts

@@ -1,32 +1,14 @@
 import { CamerasTranslator, DoodadsTranslator, ImportsTranslator, InfoTranslator, ObjectsTranslator, RegionsTranslator, SoundsTranslator, StringsTranslator, TerrainTranslator, UnitsTranslator } from './lib/translators';
 
-export class Translator {
-
-    public Doodads: DoodadsTranslator;
-    public Strings: StringsTranslator;
-    public Terrain: TerrainTranslator;
-    public Units: UnitsTranslator;
-    public Regions: RegionsTranslator;
-    public Cameras: CamerasTranslator;
-    public Sounds: SoundsTranslator;
-
-    public Objects: ObjectsTranslator;
-
-    public Imports: ImportsTranslator;
-    public Info: InfoTranslator;
-
-    constructor() {
-        this.Doodads = new DoodadsTranslator();
-        this.Strings = new StringsTranslator();
-        this.Terrain = new TerrainTranslator();
-        this.Units = new UnitsTranslator();
-        this.Regions = new RegionsTranslator();
-        this.Cameras = new CamerasTranslator();
-        this.Sounds = new SoundsTranslator();
-
-        this.Objects = new ObjectsTranslator();
-
-        this.Imports = new ImportsTranslator();
-        this.Info = new InfoTranslator();
-    }
-}
+export {
+    CamerasTranslator,
+    DoodadsTranslator,
+    ImportsTranslator,
+    InfoTranslator,
+    ObjectsTranslator,
+    RegionsTranslator,
+    SoundsTranslator,
+    StringsTranslator,
+    TerrainTranslator,
+    UnitsTranslator
+};

package/lib/CommonInterfaces.ts

@@ -0,0 +1,22 @@
+/**
+ * @type angle - An angle is measured in degrees, 0 <= angle < 360
+ */
+export type angle = number;
+
+// TranslationError is reserved for future use in case
+// additional constraints are added to translated output,
+// like if WC3 has maximum string lengths, or if certain
+// values must be in a specific range
+export interface TranslationError {
+    message: string
+}
+
+export interface WarResult {
+    buffer: Buffer,
+    errors?: TranslationError[]
+}
+
+export interface JsonResult<T = object> {
+    json: T,
+    errors?: TranslationError[]
+}

package/lib/HexBuffer.ts

@@ -17,9 +17,9 @@ const ieee754 = require('ieee754'),
     };
 
 export class HexBuffer {
-    public _buffer = [];
+    private _buffer = [];
 
-    public addString(str: string, isNullTerminated = false) {
+    public addString(str: string) {
         // Write each char to the buffer
         // "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2"
         // | "ucs-2" | "base64" | "latin1" | "binary" | "hex"
@@ -28,10 +28,7 @@ export class HexBuffer {
         for (let i = 0; i < buf.length; i++) {
             this._buffer.push('0x' + buf[i].toString(16));
         }
-
-        if (isNullTerminated) {
-            this.addNullTerminator();
-        }
+        this.addNullTerminator();
     }
 
     public addNewLine() {
@@ -43,6 +40,12 @@ export class HexBuffer {
         this._buffer.push(charToHex(char));
     }
 
+    public addChars(chars: string) {
+        chars.split('').forEach(char => {
+            this.addChar(char);
+        });
+    }
+
     public addInt(int: number, isShort: boolean = false) {
         intToHex(int, isShort).forEach((Byte) => {
             this._buffer.push(Byte);
@@ -54,7 +57,7 @@ export class HexBuffer {
     }
 
     public addFloat(float: number) {
-        const buf = new Buffer(4);
+        const buf = Buffer.alloc(4);
 
         // ieee754.write(buffer, value, buffer offset, little-endian, mantissa length, bytes);
         ieee754.write(buf, float, 0, true, 23, 4);
@@ -64,16 +67,10 @@ export class HexBuffer {
         });
     }
 
-    public addByte(byte: number) {
+    public addByte(byte) {
         this._buffer.push('0x' + byte.toString(16));
     }
 
-    public addBytes(bytes: number[]) {
-        for (const byte of bytes) {
-            this.addByte(byte);
-        }
-    }
-
     public addNullTerminator()  {
         this._buffer.push('0x0');
     }

package/lib/W3Buffer.ts

@@ -2,8 +2,8 @@ import roundTo from 'round-to';
 
 export class W3Buffer {
 
-    public _offset = 0;
-    public _buffer: Buffer;
+    private _offset = 0;
+    private _buffer: Buffer;
 
     constructor(buffer: Buffer) {
         this._buffer = buffer;
@@ -43,7 +43,7 @@ export class W3Buffer {
 
     public readChars(len: number = 1): string {
         const string = [];
-        const numCharsToRead = len;
+        const numCharsToRead = len || 1;
 
         for (let i = 0; i < numCharsToRead; i++) {
             string.push(this._buffer[this._offset]);
@@ -62,4 +62,8 @@ export class W3Buffer {
         this._offset += 1;
         return byte;
     }
+
+    public isExhausted(): boolean {
+        return this._offset === this._buffer.length;
+    }
 }