@airframes/acars-decoder 1.4.7 → 1.6.0

package/.github/FUNDING.yml

@@ -1,7 +1,7 @@
 # These are supported funding model platforms
 
 github: [kevinelliott]
-#patreon: kevinelliott 
+patreon: Airframes 
 open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel

package/.github/workflows/yarn-test.yml

@@ -1,6 +1,11 @@
 name: Yarn Test CI
 
-on: [push]
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
 
 jobs:
   build:
@@ -9,13 +14,15 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x]
+        # build against all active LTS and latest node
+        node-version: [18.x, 20.x, latest]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
+        cache: yarn
     - run: yarn install
     - run: yarn test

package/README.md

@@ -2,6 +2,38 @@
 
 ACARS is an aircraft communications messaging protocol that has been in use worldwide for a few decades. This library exists to specifically decode the text portion of the ACARS message payload.
 
+The library is built around research and discoveries from the [ACARS Message Documentation](https://github.com/airframesio/acars-message-documentation), a community effort to document the details of the ACARS message label/text payload.
+
 It has been written in TypeScript (which compiles to Javascript) and is published as an NPM package.
 
 You are welcome to contribute (please see https://github.com/airframesio/acars-message-documentation where we collaborate to research and document the various types of messages), and while it was primarily developed to power Airframes, you may use this library in your own applications freely.
+
+# Installation
+
+Add the `@airframes/acars-decoder` library to your JavaScript or TypeScript project.
+
+With `yarn`:
+```
+yarn add @airframes/acars-decoder
+```
+
+With `npm`:
+```
+npm install @airframes/acars-decoder
+```
+
+# Usage
+
+Documentation coming soon.
+
+# Contributions
+
+Contributions are welcome! Please follow the [ACARS Message Documentation](https://github.com/airframesio/acars-message-documentation) when implementing. Most find that this makes things a lot easier. Submit a Pull Request and we will gratefully review and merge.
+
+# Contributors
+
+| Contributor | Description |
+| ----------- | ----------- |
+| [Kevin Elliott](https://github.com/kevinelliott) | Primary Airframes contributor |
+| [Michael Johnson](https://github.com/johnsom) | Decoder plugins, testing framework |
+| [Mark Bumiller](https://github.com/makrsmark) | Decoder plugins, tests, utilities |

package/index.d.ts

@@ -0,0 +1,17 @@
+import { MessageDecoder } from './lib/MessageDecoder';
+declare namespace AcarsDecoder {
+  interface DecoderPlugin {
+    decode: (data: string) => string;
+    coordinateString: (coords: any) => string;
+  }
+
+  interface MessageDecoder {
+    constructor(): MessageDecoder;
+    registerPlugin(plugin: DecoderPlugin): boolean;
+    decode: (data: string, options: any) => string;
+    lookupAirportByIata: (iata: string) => string;
+    name: string;
+    plugins: Array<DecoderPlugin>;
+    debug: boolean;
+  }
+}

package/index.ts

@@ -0,0 +1,2 @@
+export * from './lib/IcaoDecoder';
+export * from './lib/MessageDecoder';

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@airframes/acars-decoder",
-  "version": "1.4.7",
+  "version": "1.6.0",
   "description": "ACARS Message Decoder for TypeScript/JavaScript",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "index.js",
+  "types": "index.d.ts",
   "bin": {
     "acars-decoder": "./dist/bin/acars-decoder.js",
     "acars-decoder-test": "./dist/bin/acars-decoder-test.js"
@@ -20,19 +20,11 @@
     "url": "https://github.com/airframesio/acars-decoder-typescript/issues"
   },
   "homepage": "https://github.com/airframesio/acars-decoder-typescript#readme",
-  "keywords": [
-    "acars",
-    "decoder",
-    "airframes",
-    "airframes.io",
-    "airframesio",
-    "ts",
-    "typescript"
-  ],
-  "author": "Kevin Elliott <kevin@airframes.io>",
-  "license": "MIT",
+  "author": "Kevin Elliott <kevin@welikeinc.com>",
+  "license": "UNLICENSED",
   "dependencies": {
-    "@types/node": "^14.14.22"
+    "@types/node": "^14.14.22",
+    "base85": "^3.1.0"
   },
   "devDependencies": {
     "@babel/core": "^7.18.13",

package/tsconfig.json

@@ -3,12 +3,12 @@
     "target": "esNext",
     "module": "commonjs",
     "declaration": true,
-    "outDir": "dist",
-    "esModuleInterop": true,
+    "outDir": "./dist",
     "strict": true
   },
   "include": [
-    "src",
+    "lib/*.ts",
+    "lib/**/*.ts",
   ],
   "exclude": [
     "node_modules"