wc3maptranslator 4.0.0 → 4.0.2

package/.eslintrc

@@ -1,55 +0,0 @@
-{
-  "env": {
-      "node": true
-  },
-  "parserOptions": {
-    "ecmaVersion": 6,
-    "sourceType": "module"
-  },
-  "rules": {
-    "no-cond-assign": [2,"always"],
-    "no-console": 2,
-    "no-constant-condition": 2,
-    "no-control-regex": 2,
-    "no-debugger": 2,
-    "no-dupe-args": 2,
-    "no-dupe-keys": 2,
-    "no-duplicate-case": 2,
-    "no-empty-character-class": 2,
-    "no-empty": 2,
-    "no-ex-assign": 2,
-    "no-extra-boolean-cast": 1,
-    "no-extra-parens": [1,"all"],
-    "no-extra-semi": 1,
-    "no-func-assign": 2,
-    "no-irregular-whitespace": 1,
-    "no-sparse-arrays": 2,
-    "use-isnan": 2,
-    "valid-typeof": 2,
-    "no-alert": 2,
-    "no-caller": 2,
-    "no-labels": 2,
-    "no-octal": 2,
-    "no-redeclare": 2,
-    "no-script-url": 2,
-    "no-warning-comments": [2,{"terms":["TODO","FIXME"],"location":"anywhere"}],
-    "wrap-iife": [2,"any"],
-    "strict": [2,"never"],
-    "no-delete-var": 2,
-    "callback-return": 2,
-    "no-path-concat": 2,
-    "brace-style": [2,"stroustrup",{"allowSingleLine":true}],
-    "comma-spacing": [2,{"after":true}],
-    "eol-last": 2,
-    "id-length": [2,{"min":2,"max":26,"exceptions":["b","i","j","k","x","y"]}],
-    "indent": [2,4],
-    "no-underscore-dangle": 2,
-    "object-curly-spacing": [2,"always",{"arraysInObjects":true,"objectsInObjects":true}],
-    "one-var": 1,
-    "quotes": [2,"single","avoid-escape"],
-    "semi": [2,"always"],
-    "space-before-blocks": [2,"always"],
-    "arrow-parens": [2,"always"],
-    "no-var": 1
-  }
-}

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

@@ -1,54 +0,0 @@
-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

@@ -1,18 +0,0 @@
-{
-    "extends": "@istanbuljs/nyc-config-typescript",
-    "check-coverage": true,
-    "per-file": true,
-    "extension": [
-      ".ts",
-      ".tsx"
-    ],
-    "exclude": [
-      "**/*.d.ts",
-      "**/coverage/**"
-    ],
-    "reporter": [
-      "lcov",
-      "text-summary"
-    ],
-    "all": true
-}

package/.travis.yml

@@ -1,23 +0,0 @@
-# Modeled after: https://travis-ci.org/microsoft/TypeScript/jobs/625136191/config
-
-language: node_js
-
-node_js:
-  - "14"
-
-branches:
-  only:
-  - master
-
-install:
-  - npm uninstall typescript --no-save
-  - npm install
-
-cache:
-  directories:
-    - node_modules
-
-script: "npm run-script test-travis"
-
-# Send coverage data to Coveralls
-after_script: "cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"

package/CHANGELOG.md

@@ -1,73 +0,0 @@
-# 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/index.ts

@@ -1,14 +0,0 @@
-import { CamerasTranslator, DoodadsTranslator, ImportsTranslator, InfoTranslator, ObjectsTranslator, RegionsTranslator, SoundsTranslator, StringsTranslator, TerrainTranslator, UnitsTranslator } from './lib/translators';
-
-export {
-    CamerasTranslator,
-    DoodadsTranslator,
-    ImportsTranslator,
-    InfoTranslator,
-    ObjectsTranslator,
-    RegionsTranslator,
-    SoundsTranslator,
-    StringsTranslator,
-    TerrainTranslator,
-    UnitsTranslator
-};

package/lib/AngleConverter.ts

@@ -1,7 +0,0 @@
-export function deg2Rad(angleInDegrees: number): number {
-    return angleInDegrees * Math.PI / 180;
-}
-
-export function rad2Deg(angleInRadians: number): number {
-    return angleInRadians * 180 / Math.PI;
-}

package/lib/CommonInterfaces.ts

@@ -1,22 +0,0 @@
-/**
- * @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/test/.mocharc.json

@@ -1,4 +0,0 @@
-{
-    "recursive": true,
-    "require": ["ts-node/register", "source-map-support/register"]
-}

package/test/AngleConverterTest.ts

@@ -1,18 +0,0 @@
-import assert from 'assert';
-import { deg2Rad, rad2Deg } from '../lib/AngleConverter';
-
-describe('AngleConverter', () => {
-
-    it('should convert degrees to radians', () => {
-        const angleInDegrees = 90;
-        const convertedToRadians = deg2Rad(angleInDegrees);
-        assert.equal(convertedToRadians, Math.PI / 2);
-    });
-
-    it('should convert radians to degrees', () => {
-        const angleInRadians = Math.PI;
-        const convertedToDegrees = rad2Deg(angleInRadians);
-        assert.equal(convertedToDegrees, 180);
-    });
-
-});

package/test/HexBufferTest.ts

@@ -1,170 +0,0 @@
-import assert from 'assert';
-import { HexBuffer } from '../lib/HexBuffer';
-
-let hexBuffer: HexBuffer;
-
-describe('HexBuffer', () => {
-
-    beforeEach(() => {
-        // clear the buffer before each test in this block so we
-        // don't have to care about what we added in prior tests
-        hexBuffer = new HexBuffer();
-    });
-
-    it('should addString', () => {
-        const testWords = [
-            'Hallo, wêreld!', // Afrikaans
-            'Pershëndetje Botë', // Albanian
-            'أهلاً بالعالم', // Arabic
-            'Բարե՛ւ, աշխարհ։', // Armenian
-            'Salam Dünya', // Azeri
-            'Ahoj Světe!', // Czech
-            'Kaixo mundua!', // Basque/Euskara
-            'Прывітанне свет', // Belarusian
-            'Shani Mwechalo!', // Bemba
-            'Shagatam Prithivi!', // Bengali
-            'Zdravo Svijete!', // Bosnian
-            'Здравей, свят!', // Bulgarian
-            'ជំរាបសួរ ពិភពលោក', // Cambodian
-            'Hola món!', // Catalan
-            '你好世界', // Chinese
-            'ᎣᏏᏲ ᎡᎶᎯ', // Cherokee
-            'Klahowya Hayas Klaska', // Chinook Wawa
-            'Bok Svijete!', // Croatian
-            'Hej, Verden!', // Danish
-            'Hallo, wereld!', // Dutch
-            'Hello World!', // English
-            'Saluton mondo!', // Esperanto
-            'Tere maailm!', // Estonian
-            'Hei maailma!', // Finnish
-            'Salut le Monde!', // French
-            'Hallo, wrâld!', // Frisian
-            'Ola mundo!', // Galician
-            'Hallo Welt!', // German
-            'Γεια σου κόσμε!', // Greek
-            'Aloha Honua', // Hawaiian
-            'שלום עולם', // Hebrew
-            'नमस्ते दुनिया', // Hindi
-            'Nyob zoo ntiaj teb.', // Hmong
-            'Helló világ!', // Hungarian
-            'Halló heimur!', // Icelandic
-            'Ndewo Ụwa', // Igbo
-            'Halo Dunia!', // Indonesian
-            'Dia dhaoibh, a dhomhain!', // Irish
-            'Ciao Mondo!', // Italian
-            'こんにちは、 世界！', // Japanese
-            'ಹಲೋ ವರ್ಲ್ಡ್', // Kannada
-            'Habari dunia!', // Kiswahili
-            'Niatia thi!', // Kikuyu
-            'nuqneH', // Klingon
-            '반갑다 세상아', // Korean
-            'ສະບາຍດີ,ໂລກ', // Lao
-            'AVE MVNDE', // Latin
-            'Sveika, Pasaule!', // Latvian
-            'Sveikas, Pasauli', // Lithuanian
-            'coi li terdi', // Lojban
-            'Moien Welt!', // Luxembourgish
-            'Manao ahoana ry tany!', // Malagasy
-            'Namaskaram, lokame', // Malayalam
-            'Merhba lid-dinja', // Maltese
-            'Hallo verden!', // Norwegian
-            '!سلام دنیا', // Persian
-            'Witaj świecie!', // Polish
-            'Olá, mundo!', // Portuguese
-            'ਸਤਿ ਸ੍ਰੀ ਅਕਾਲ ਦੁਨਿਆ', // Punjabi
-            'Salut lume!', // Romanian
-            'Здравствуй, мир!', // Russian
-            'Halò, a Shaoghail!', // Scots Gaelic
-            'Zdravo Svete!', // Serbian
-            'Ahoj, svet!', // Slovak
-            'Pozdravljen svet!', // Slovenian
-            '¡Hola mundo!', // Spanish
-            'Hallå världen!', // Swedish
-            'Kamusta mundo!', // Tagalog
-            'ஹலோ உலகம்', // Tamil
-            'హలో వరల్డ్', // Telugu
-            'สวัสดีโลก!', // Thai
-            'Merhaba Dünya!', // Turkish
-            'Привiт, свiте!', // Ukrainian
-            'ہیلو دنیا والو', // Urdu
-            'Xin chào thế giới', // Vietnamese
-            'S\'mae byd!', // Welsh
-            'העלא וועלט', // Yiddish
-            'Sawubona Mhlaba' // Zulu
-        ];
-
-        let totalLength = 0;
-        // tslint:disable-next-line: forin
-        for (const word of testWords) {
-            const bufLength = Buffer.from(word).length;
-            hexBuffer.addString(word);
-            totalLength += bufLength + 1; // adding one accounts for the null terminator at the end of the string
-            const bufferLength = hexBuffer.getBuffer().length;
-            assert.equal(bufferLength, totalLength);
-        }
-    });
-
-    it('should addNewLine', () => {
-        hexBuffer.addNewLine();
-        assert.equal(hexBuffer.getBuffer().length, 2);
-        assert.equal(hexBuffer.getBuffer()[0], 0x0d);
-        assert.equal(hexBuffer.getBuffer()[1], 0x0a);
-    });
-
-    it('should addChar', () => {
-        hexBuffer.addChar('A');
-        assert.equal(hexBuffer.getBuffer().length, 1);
-        assert.equal(hexBuffer.getBuffer()[0], 65); // charcode for the ASCII letter "A"
-    });
-
-    it('should addChars', () => {
-        hexBuffer.addChars('ABCD');
-        assert.equal(hexBuffer.getBuffer().length, 4);
-        assert.equal(hexBuffer.getBuffer()[0], 65); // charcode for the ASCII letter "A"
-        assert.equal(hexBuffer.getBuffer()[1], 66); // charcode for the ASCII letter "B"
-        assert.equal(hexBuffer.getBuffer()[2], 67); // charcode for the ASCII letter "C"
-        assert.equal(hexBuffer.getBuffer()[3], 68); // charcode for the ASCII letter "D"
-    });
-
-    it('should addInt', () => {
-        hexBuffer.addInt(0);
-        assert.equal(hexBuffer.getBuffer().length, 4); // integer is 4 bytes in length
-        assert.equal(hexBuffer.getBuffer()[0], 0x00);
-        assert.equal(hexBuffer.getBuffer()[1], 0x00);
-        assert.equal(hexBuffer.getBuffer()[2], 0x00);
-        assert.equal(hexBuffer.getBuffer()[3], 0x00);
-    });
-
-    it('should addShort', () => {
-        hexBuffer.addShort(14);
-        assert.equal(hexBuffer.getBuffer().length, 2); // 2 bytes in length
-        assert.equal(hexBuffer.getBuffer()[0], 0x0e);
-        assert.equal(hexBuffer.getBuffer()[1], 0x00);
-    });
-
-    it('should addFloat', () => {
-        hexBuffer.addFloat(1.234);
-        assert.equal(hexBuffer.getBuffer().length, 4); // 4 bytes in length
-        assert.equal(hexBuffer.getBuffer()[0], 0xb6);
-        assert.equal(hexBuffer.getBuffer()[1], 0xf3);
-        assert.equal(hexBuffer.getBuffer()[2], 0x9d);
-        assert.equal(hexBuffer.getBuffer()[3], 0x3f);
-    });
-
-    it('should addByte', () => {
-        hexBuffer.addByte(15);
-        assert.equal(hexBuffer.getBuffer()[0], 15);
-    });
-
-    it('should addNullTerminator', () => {
-        hexBuffer.addNullTerminator();
-        assert.equal(hexBuffer.getBuffer().length, 1);
-        assert.equal(hexBuffer.getBuffer()[0], 0);
-    });
-
-    it('should getBuffer', () => {
-        hexBuffer.addString('');
-        assert(hexBuffer.getBuffer()); // test if this function works
-    });
-
-});