Initial Commit

.gitignore

@@ -0,0 +1,6 @@
+.history
+/node_modules
+/coverage
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 IOTA Stiftung
+
+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.

README.md

@@ -0,0 +1,74 @@
+# IOTA Area Codes (IAC)
+
+This package contains a JavaScript implementation of IOTA Area Codes (IAC) as proposed here <https://github.com/iota-community/iota-area-codes> by Lewis Freiberg.
+
+IACs are a method for encoding a geo-location as Trytes for use in IOTA transactions, it is based on <https://en.wikipedia.org/wiki/Open_Location_Code>
+
+For a more detailed explanation of IACs, please read [./docs/iota-area-codes.md](./docs/iota-area-codes.md)
+
+## Installing
+
+Install this package using the following commands:
+
+```shell
+npm install iotaldeger/iota-area-codes
+```
+
+or
+
+```shell
+yarn add iotaldeger/iota-area-codes
+```
+
+## Example Usage
+
+```js
+const iotaAreaCodes = require('iota-area-codes');
+
+const iac = iotaAreaCodes.encode(52.529562, 13.413047);
+console.log("IOTA Area Code", iac);
+
+const iacHighPrecision = iotaAreaCodes.encode(52.529562, 13.413047, iotaAreaCodes.CodePrecision.EXTRA);
+console.log("IOTA Area Code High Precision", iacHighPrecision);
+
+const codeArea = iotaAreaCodes.decode('NPHTQORL9XKP');
+console.log("IOTA Code Area", codeArea);
+
+const olc = iotaAreaCodes.toOpenLocationCode('NPHTQORL9XKP');
+console.log("Open Location Code", olc);
+
+const iac2 = iotaAreaCodes.fromOpenLocationCode('X4HM+MM');
+console.log("IOTA Area Code", iac2);
+
+const isValid1 = iotaAreaCodes.isValid('JAHAS0');
+console.log("isValid1", isValid1);
+
+const isValid2 = iotaAreaCodes.isValid('NPHTQORL9XKP');
+console.log("isValid2", isValid2);
+
+const extracted = iotaAreaCodes.extract('NPHTQORL9XKP999999999');
+console.log("extracted", extracted);
+```
+
+Will output:
+
+```shell
+IOTA Area Code NPHTQORL9XK
+IOTA Area Code High Precision NPHTQORL9XKP
+IOTA Code Area { latitude: 52.52956250000001,
+  longitude: 13.413046874999981,
+  codePrecision: 11,
+  latitudeLow: 52.529550000000015,
+  latitudeHigh: 52.529575000000015,
+  longitudeLow: 13.413031249999982,
+  longitudeHigh: 13.413062499999983 }
+Open Location Code 9F4MGCH7+R6F
+IOTA Area Code ZHRT9TT
+isValid1 false
+isValid2 true
+extracted NPHTQORL9XKP
+```
+
+## API Reference
+
+See [./docs/api.md](./docs/api.md)