wc3maptranslator 4.0.1 → 4.0.2

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
-    });
-
-});

package/test/TranslatorReversion.ts

@@ -1,218 +0,0 @@
-import assert from 'assert';
-import * as diff from 'diff-buf';
-import * as fs from 'fs-extra';
-import * as Path from 'path';
-
-import * as Translator from '../index';
-
-const ObjectType = Translator.ObjectsTranslator.ObjectType;
-const war3mapDir = Path.resolve('test/data');
-const outputDir = Path.resolve('test/.output');
-
-function readWar3MapBuffer(filename: string) {
-    return fs.readFileSync(Path.join(war3mapDir, filename));
-}
-
-function readJsonTestFile(filename: string) {
-    return fs.readJsonSync(Path.join(war3mapDir, filename));
-}
-
-function writeJsonTestFile(filename: string, json: object) {
-    return fs.writeJsonSync(Path.join(outputDir, filename), json);
-}
-
-function buffersAreEqual(b1: Buffer, b2: Buffer) {
-    const comparison = diff.default(b1, b2, { string: false });
-
-    // Library `diff` returns an array of objects documenting comparison
-    // e.g. { added: undefined, removed: undefined, value: 10 }
-    // We want all `added` and `removed` fields to be "undefined" for
-    // the buffers to be considered equal
-    let buffersEqual = true;
-    comparison.forEach((compare) => {
-        if (compare.added || compare.removed) {
-            buffersEqual = false;
-        }
-    });
-
-    return buffersEqual;
-}
-
-// Ensures that when a JSON file is converted to war3map and back again,
-// the two JSON files are the same; converting between the two data formats
-// must yield the original results back (except for some differences in rounding)
-describe('Reversion: json -> war -> json', () => {
-
-    before(() => {
-        fs.emptyDirSync(outputDir);
-        fs.ensureDirSync(outputDir);
-    });
-
-    it('Doodads reversion', () => {
-        const originalJson = readJsonTestFile('doodads.json');
-        const translatedBuffer = Translator.DoodadsTranslator.jsonToWar(originalJson).buffer;
-        const translatedJson = Translator.DoodadsTranslator.warToJson(translatedBuffer).json;
-
-        writeJsonTestFile('doodads.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-    it('Strings reversion', () => {
-        const originalJson = readJsonTestFile('strings.json');
-        const translatedBuffer = Translator.StringsTranslator.jsonToWar(originalJson).buffer;
-        const translatedJson = Translator.StringsTranslator.warToJson(translatedBuffer).json;
-
-        writeJsonTestFile('strings.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-    it('Terrain reversion', () => {
-        const originalJson = readJsonTestFile('terrain.json');
-        const translatedBuffer = Translator.TerrainTranslator.jsonToWar(originalJson).buffer;
-        const translatedJson = Translator.TerrainTranslator.warToJson(translatedBuffer).json;
-
-        writeJsonTestFile('terrain.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-    it('Units reversion', () => {
-        const originalJson = readJsonTestFile('units.json');
-        const translatedBuffer = Translator.UnitsTranslator.jsonToWar(originalJson).buffer;
-        const translatedJson = Translator.UnitsTranslator.warToJson(translatedBuffer).json;
-
-        writeJsonTestFile('units.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-    it('Regions reversion', () => {
-        const originalJson = readJsonTestFile('regions.json');
-        const translatedBuffer = Translator.RegionsTranslator.jsonToWar(originalJson).buffer;
-        const translatedJson = Translator.RegionsTranslator.warToJson(translatedBuffer).json;
-
-        writeJsonTestFile('regions.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-    it('Cameras reversion', () => {
-        const originalJson = readJsonTestFile('cameras.json');
-        const translatedBuffer = Translator.CamerasTranslator.jsonToWar(originalJson).buffer;
-        const translatedJson = Translator.CamerasTranslator.warToJson(translatedBuffer).json;
-
-        writeJsonTestFile('cameras.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-    it('Sounds reversion', () => {
-        const originalJson = readJsonTestFile('sounds.json');
-        const translatedBuffer = Translator.SoundsTranslator.jsonToWar(originalJson).buffer;
-        const translatedJson = Translator.SoundsTranslator.warToJson(translatedBuffer).json;
-
-        writeJsonTestFile('sounds.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-    it('Units (Object) reversion', () => {
-        const originalJson = readJsonTestFile('obj-units.json');
-        const objectType = Translator.ObjectsTranslator.ObjectType.Units;
-        const translatedBuffer = Translator.ObjectsTranslator.jsonToWar(objectType, originalJson).buffer;
-        const translatedJson = Translator.ObjectsTranslator.warToJson(objectType, translatedBuffer).json;
-
-        writeJsonTestFile('obj-units.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-    it('Items (Object) reversion', () => {
-        const originalJson = readJsonTestFile('obj-items.json');
-        const objectType = Translator.ObjectsTranslator.ObjectType.Items;
-        const translatedBuffer = Translator.ObjectsTranslator.jsonToWar(objectType, originalJson).buffer;
-        const translatedJson = Translator.ObjectsTranslator.warToJson(objectType, translatedBuffer).json;
-
-        writeJsonTestFile('obj-items.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-    it('Destructables (Object) reversion', () => {
-        const originalJson = readJsonTestFile('obj-destructables.json');
-        const objectType = Translator.ObjectsTranslator.ObjectType.Destructables;
-        const translatedBuffer = Translator.ObjectsTranslator.jsonToWar(objectType, originalJson).buffer;
-        const translatedJson = Translator.ObjectsTranslator.warToJson(objectType, translatedBuffer).json;
-
-        writeJsonTestFile('obj-destructables.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-    it('Doodads (Object) reversion', () => {
-        const originalJson = readJsonTestFile('obj-doodads.json');
-        const objectType = Translator.ObjectsTranslator.ObjectType.Doodads;
-        const translatedBuffer = Translator.ObjectsTranslator.jsonToWar(objectType, originalJson).buffer;
-        const translatedJson = Translator.ObjectsTranslator.warToJson(objectType, translatedBuffer).json;
-
-        writeJsonTestFile('obj-doodads.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-    it('Abilities (Object) reversion', () => {
-        const originalJson = readJsonTestFile('obj-abilities.json');
-        const objectType = Translator.ObjectsTranslator.ObjectType.Abilities;
-        const translatedBuffer = Translator.ObjectsTranslator.jsonToWar(objectType, originalJson).buffer;
-        const translatedJson = Translator.ObjectsTranslator.warToJson(objectType, translatedBuffer).json;
-
-        writeJsonTestFile('obj-abilities.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-    it('Buffs (Object) reversion', () => {
-        const originalJson = readJsonTestFile('obj-buffs.json');
-        const objectType = Translator.ObjectsTranslator.ObjectType.Buffs;
-        const translatedBuffer = Translator.ObjectsTranslator.jsonToWar(objectType, originalJson).buffer;
-        const translatedJson = Translator.ObjectsTranslator.warToJson(objectType, translatedBuffer).json;
-
-        writeJsonTestFile('obj-buffs.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-    it('Upgrades (Object) reversion', () => {
-        const originalJson = readJsonTestFile('obj-upgrades.json');
-        const objectType = Translator.ObjectsTranslator.ObjectType.Upgrades;
-        const translatedBuffer = Translator.ObjectsTranslator.jsonToWar(objectType, originalJson).buffer;
-        const translatedJson = Translator.ObjectsTranslator.warToJson(objectType, translatedBuffer).json;
-
-        writeJsonTestFile('obj-upgrades.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-    it('Info reversion', () => {
-        const originalJson = readJsonTestFile('info.json');
-        const translatedBuffer = Translator.InfoTranslator.jsonToWar(originalJson).buffer;
-        const translatedJson = Translator.InfoTranslator.warToJson(translatedBuffer).json;
-
-        writeJsonTestFile('info.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-    it('Imports reversion', () => {
-        const originalJson = readJsonTestFile('imports.json');
-        const translatedBuffer = Translator.ImportsTranslator.jsonToWar(originalJson).buffer;
-        const translatedJson = Translator.ImportsTranslator.warToJson(translatedBuffer).json;
-
-        writeJsonTestFile('imports.json', translatedJson);
-
-        assert.deepStrictEqual(originalJson, translatedJson);
-    });
-
-});

package/test/W3BufferTest.ts

@@ -1,50 +0,0 @@
-import assert from 'assert';
-import { W3Buffer } from '../lib/W3Buffer';
-
-// This is a hard-coded buffer to test all the reading methods
-// on W3Buffer. It consists of, in this order:
-// char(4), int, float, string(7 Ws), byte
-const buffData = Buffer.from([
-    0x01, 0x00, 0x00, 0x00, // int: 1
-    0x81, 0x70, // short: 28801
-    0x00, 0x00, 0x9b, 0xc5, // float: -4960
-    0x57, 0x57, 0x57, 0x57, 0x57, 0x57, 0x57, 0x00, // string: "WWWWWWW"
-    0x57, 0x33, 0x64, 0x6f, // char(4): "W3do"
-    0x57, // char(1): "W"
-    0x02 // byte: 2
-]);
-
-const w3buffer = new W3Buffer(buffData);
-
-describe('W3Buffer', () => {
-
-    it('should readInt', () => {
-        assert.equal(w3buffer.readInt(), 1);
-    });
-
-    it('should readShort', () => {
-        assert.equal(w3buffer.readShort(), 28801);
-    });
-
-    it('should readFloat', () => {
-        assert.equal(w3buffer.readFloat(), -4960);
-    });
-
-    it('should readString', () => {
-        assert.equal(w3buffer.readString(), 'WWWWWWW');
-    });
-
-    it('should readChars', () => {
-        assert.equal(w3buffer.readChars(4), 'W3do');
-        assert.equal(w3buffer.readChars(), 'W')
-    });
-
-    it('should readByte', () => {
-        assert.equal(w3buffer.readByte(), 2);
-    });
-
-    it('should be exhausted', () => {
-        assert.ok(w3buffer.isExhausted());
-    });
-
-});

package/test/data/cameras.json

@@ -1,16 +0,0 @@
-[
-    {
-      "target": {
-        "x": -319.01,
-        "y": -90.18
-      },
-      "offsetZ": 0,
-      "rotation": 90,
-      "aoa": 304,
-      "distance": 2657.34,
-      "roll": 5,
-      "fov": 70,
-      "farClipping": 5000,
-      "name": ""
-    }
-  ]