@canboat/canboatjs 3.0.2 → 3.1.0

package/lib/{ydgw02.js → ydgw02.ts}

@@ -14,20 +14,26 @@
  * limitations under the License.
  */
 
-const debug = require('debug')('canboatjs:ydgw02')
-const Transform = require('stream').Transform
-const FromPgn = require('./fromPgn').Parser
-const Parser = require('./fromPgn').Parser
-const YdDevice = require('./yddevice')
-const _ = require('lodash')
-const { defaultTransmitPGNs } = require('./codes')
-const { pgnToYdgwRawFormat, pgnToYdgwFullRawFormat, actisenseToYdgwRawFormat, actisenseToYdgwFullRawFormat } = require('./toPgn')
+import { PGN } from '@canboat/ts-pgns'
+import { createDebug } from './utilities'
+import { Transform } from 'stream'
+import { Parser as FromPgn } from './fromPgn'
+import { YdDevice } from './yddevice'
+import {
+  pgnToYdgwRawFormat,
+  pgnToYdgwFullRawFormat,
+  actisenseToYdgwRawFormat,
+  actisenseToYdgwFullRawFormat
+} from './toPgn'
+import util from 'util'
+
+const debug = createDebug('canboatjs:ydgw02')
 
 //const pgnsSent = {}
 
-function Ydgw02Stream (options, type) {
-  if (!(this instanceof Ydgw02Stream)) {
-    return new Ydgw02Stream(options)
+export function Ydgw02Stream(this: any, options: any, type: string) {
+  if (this === undefined) {
+    return new (Ydgw02Stream as any)(options, type)
   }
 
   Transform.call(this, {
@@ -41,18 +47,17 @@ function Ydgw02Stream (options, type) {
 
   this.fromPgn = new FromPgn(options)
 
-  this.fromPgn.on('warning', (pgn, warning) => {
+  this.fromPgn.on('warning', (_pgn: any, _warning: string) => {
     //debug(`[warning] ${pgn.pgn} ${warning}`)
   })
 
-  this.fromPgn.on('error', (pgn, error) => {
+  this.fromPgn.on('error', (pgn: PGN, error: any) => {
     debug(`[error] ${pgn.pgn} ${error}`)
   })
 
-
-  if ( options.app ) {
-    options.app.on(this.options.outEevent || 'nmea2000out', (msg) => {
-      if ( typeof msg === 'string' ) {
+  if (options.app) {
+    options.app.on(this.options.outEevent || 'nmea2000out', (msg: string) => {
+      if (typeof msg === 'string') {
         this.sendYdgwPGN(msg)
       } else {
         this.sendPGN(msg)
@@ -60,78 +65,77 @@ function Ydgw02Stream (options, type) {
       options.app.emit('connectionwrite', { providerId: options.providerId })
     })
 
-    options.app.on(options.jsonOutEvent || 'nmea2000JsonOut', (msg) => {
+    options.app.on(options.jsonOutEvent || 'nmea2000JsonOut', (msg: PGN) => {
       this.sendPGN(msg)
       options.app.emit('connectionwrite', { providerId: options.providerId })
     })
 
-    options.app.on('ydFullRawOut', (msgs) => {
+    options.app.on('ydFullRawOut', (msgs: string[]) => {
       this.sendYdgwFullPGN(msgs)
       options.app.emit('connectionwrite', { providerId: options.providerId })
     })
 
     //this.sendString('$PDGY,N2NET_OFFLINE')
 
-    if ( type === 'usb' ) {
+    if (type === 'usb') {
       // set ydnu to RAW mode
       options.app.emit(this.outEvent, Buffer.from([0x30, 0x0a]))
     }
 
-    if ( options.createDevice === true ) {
+    if (options.createDevice === true) {
       this.device = new YdDevice(options)
       this.device.start()
     }
-    
+
     debug('started')
   }
-
 }
 
-Ydgw02Stream.prototype.cansend = function (msg) {
+Ydgw02Stream.prototype.cansend = function (_msg: any) {
   return this.device ? this.device.cansend : true
 }
 
-Ydgw02Stream.prototype.sendString = function (msg, forceSend) {
-  if ( this.cansend() || forceSend === true ) {
+Ydgw02Stream.prototype.sendString = function (msg: string, forceSend: boolean) {
+  if (this.cansend() || forceSend === true) {
     debug('sending %s', msg)
     this.options.app.emit(this.outEvent, msg)
   }
 }
 
-Ydgw02Stream.prototype.sendPGN = function (pgn) {
-  if ( this.cansend() || pgn.forceSend === true ) {
+Ydgw02Stream.prototype.sendPGN = function (pgn: PGN) {
+  if (this.cansend() || (pgn as any).forceSend === true) {
     //let now = Date.now()
     //let lastSent = pgnsSent[pgn.pgn]
     let msgs
-    if ( pgn.ydFullFormat === true || this.device !== undefined ) {
+    if ((pgn as any).ydFullFormat === true || this.device !== undefined) {
+      pgn.src = this.device.address
       msgs = pgnToYdgwFullRawFormat(pgn)
     } else {
       msgs = pgnToYdgwRawFormat(pgn)
     }
-    msgs.forEach(raw => {
-      this.sendString(raw + '\r\n', pgn.forceSend)
+    msgs.forEach((raw) => {
+      this.sendString(raw + '\r\n', (pgn as any).forceSend)
     })
     //pgnsSent[pgn.pgn] = now
   }
 }
 
-Ydgw02Stream.prototype.sendYdgwFullPGN = function (msgs) {
-  msgs.forEach(raw => {
+Ydgw02Stream.prototype.sendYdgwFullPGN = function (msgs: string[]) {
+  msgs.forEach((raw) => {
     this.sendString(raw + '\r\n')
   })
 }
 
-Ydgw02Stream.prototype.sendYdgwPGN = function (msg) {
-
+Ydgw02Stream.prototype.sendYdgwPGN = function (msg: string) {
   let msgs
 
-  if ( this.device != undefined ) {
+  if (this.device != undefined) {
     msgs = actisenseToYdgwFullRawFormat(msg)
   } else {
     msgs = actisenseToYdgwRawFormat(msg)
   }
 
-  msgs.forEach(raw => {
+  msgs.forEach((raw) => {
     this.sendString(raw + '\r\n')
   })
 
@@ -161,28 +165,32 @@ Ydgw02Stream.prototype.sendYdgwPGN = function (msg) {
   */
 }
 
-require('util').inherits(Ydgw02Stream, Transform)
+util.inherits(Ydgw02Stream, Transform)
 
-Ydgw02Stream.prototype._transform = function (chunk, encoding, done) {
-  let line = chunk.toString().trim()
+Ydgw02Stream.prototype._transform = function (
+  chunk: any,
+  encoding: any,
+  done: any
+) {
+  const line = chunk.toString().trim()
   //line = line.substring(0, line.length) // take off the \r
 
-  if ( this.device === undefined && !this.sentAvailable ) {
+  if (this.device === undefined && !this.sentAvailable) {
     debug('emit nmea2000OutAvailable')
     this.options.app.emit('nmea2000OutAvailable')
     this.sentAvailable = true
   }
 
   const pgn = this.fromPgn.parseYDGW02(line)
-  if ( !_.isUndefined(pgn) ) {
+  if (pgn !== undefined) {
     this.push(pgn)
-    this.options.app.emit(this.options.analyzerOutEvent || 'N2KAnalyzerOut', pgn)
+    this.options.app.emit(
+      this.options.analyzerOutEvent || 'N2KAnalyzerOut',
+      pgn
+    )
   }
 
   done()
 }
 
-Ydgw02Stream.prototype.end = function () {
-}
-
-module.exports = Ydgw02Stream
+Ydgw02Stream.prototype.end = function () {}

package/lib/ydvr.js

@@ -1,180 +1,98 @@
-const BitStream = require('bit-buffer').BitStream;
-const Transform = require('stream').Transform;
+const BitStream = require('bit-buffer').BitStream
+const Transform = require('stream').Transform
 const FromPgn = require('./fromPgn').Parser
-const parseCanId = require('./canId').parseCanId;
+const parseCanId = require('./canId').parseCanId
 
 // https://www.yachtd.com/downloads/ydvr04.pdf Appendix D
 var sequencePgns = new Set([
-  65240,
-  126208,
-  126464,
-  126720,
-  126983,
-  126984,
-  126985,
-  126986,
-  126987,
-  126988,
-  126996,
-  126998,
-  127233,
-  127237,
-  127489,
-  127496,
-  127497,
-  127498,
-  127503,
-  127504,
-  127506,
-  127507,
-  127509,
-  127510,
-  127511,
-  127512,
-  127513,
-  127514,
-  128275,
-  128520,
-  129029,
-  129038,
-  129039,
-  129040,
-  129041,
-  129044,
-  129045,
-  129284,
-  129285,
-  129301,
-  129302,
-  129538,
-  129540,
-  129541,
-  129542,
-  129545,
-  129547,
-  129549,
-  129551,
-  129556,
-  129792,
-  129793,
-  129794,
-  129795,
-  129796,
-  129797,
-  129798,
-  129799,
-  129800,
-  129801,
-  129802,
-  129803,
-  129804,
-  129805,
-  129806,
-  129807,
-  129808,
-  129809,
-  129810,
-  130052,
-  130053,
-  130054,
-  130060,
-  130061,
-  130064,
-  130065,
-  130066,
-  130067,
-  130068,
-  130069,
-  130070,
-  130071,
-  130072,
-  130073,
-  130074,
-  130320,
-  130321,
-  130322,
-  130323,
-  130324,
-  130567,
-  130577,
-  130578,
-  130816,
-]);
+  65240, 126208, 126464, 126720, 126983, 126984, 126985, 126986, 126987, 126988,
+  126996, 126998, 127233, 127237, 127489, 127496, 127497, 127498, 127503,
+  127504, 127506, 127507, 127509, 127510, 127511, 127512, 127513, 127514,
+  128275, 128520, 129029, 129038, 129039, 129040, 129041, 129044, 129045,
+  129284, 129285, 129301, 129302, 129538, 129540, 129541, 129542, 129545,
+  129547, 129549, 129551, 129556, 129792, 129793, 129794, 129795, 129796,
+  129797, 129798, 129799, 129800, 129801, 129802, 129803, 129804, 129805,
+  129806, 129807, 129808, 129809, 129810, 130052, 130053, 130054, 130060,
+  130061, 130064, 130065, 130066, 130067, 130068, 130069, 130070, 130071,
+  130072, 130073, 130074, 130320, 130321, 130322, 130323, 130324, 130567,
+  130577, 130578, 130816
+])
 
 function YdvrStream() {
   if (!(this instanceof YdvrStream)) {
-    return new YdvrStream();
+    return new YdvrStream()
   }
 
-  this.parser = new FromPgn();
+  this.parser = new FromPgn()
 
-  this.messageCount = 0;
-  this.errorCount = 0;
-  this.timerResetCount = 0;
+  this.messageCount = 0
+  this.errorCount = 0
+  this.timerResetCount = 0
 
   this.parser.on('error', (pgn, error) => {
-    console.error(`Error parsing ${pgn.pgn} ${error}`);
-    console.error(error.stack);
-  });
+    console.error(`Error parsing ${pgn.pgn} ${error}`)
+    console.error(error.stack)
+  })
 
-  this.parser.on('warning', (pgn, error) => {
+  this.parser.on('warning', (_pgn, _error) => {
     //console.error(`Warning parsing ${pgn.pgn} ${error}`)
-  });
+  })
 
   // this.parser.on('pgn', (pgn) => {
   //   console.log(JSON.stringify(pgn));
   // });
 
   Transform.call(this, {
-    objectMode: true,
-  });
+    objectMode: true
+  })
 }
 
-require('util').inherits(YdvrStream, Transform);
+require('util').inherits(YdvrStream, Transform)
 
 YdvrStream.prototype.end = function () {
   // console.log('end');
-};
+}
 
 YdvrStream.prototype.parseNextRecord = function () {
   if (this.bs.bitsLeft < 6 * 8) {
-    return false;
+    return false
   }
 
-  var time = this.bs.readUint16();
-  let timeAbsolute;
+  var time = this.bs.readUint16()
+  //let timeAbsolute;
   if (this.lastTime != null && time < this.lastTime) {
-    this.timeOffset = (this.timeOffset || 0) + 60000;
-    timeAbsolute = time + this.timeOffset;
-    this.timerResetCount += 1;
-  } else {
+    this.timeOffset = (this.timeOffset || 0) + 60000
+    //timeAbsolute = time + this.timeOffset;
+    this.timerResetCount += 1
+  } /*else {
     timeAbsolute = time;
-  }
-  this.lastTime = time;
+    }
+    */
+  this.lastTime = time
 
-  var identifier = this.bs.readUint32();
+  var identifier = this.bs.readUint32()
   if (identifier === 0xffffffff) {
     // service record
     if (this.bs.bitsLeft < 8 * 8) {
-      return false;
+      return false
     }
-    var srData = this.bs.readArrayBuffer(8);
+    var _srData = this.bs.readArrayBuffer(8)
   } else {
-    const pgn = parseCanId(identifier);
+    const pgn = parseCanId(identifier)
 
-    var bodyLen;
+    var bodyLen
     if (pgn.pgn == 59904) {
-      bodyLen = 3;
+      bodyLen = 3
     } else if (sequencePgns.has(pgn.pgn)) {
-      var seq = this.bs.readUint8();
-      bodyLen = this.bs.readUint8();
+      var _seq = this.bs.readUint8()
+      bodyLen = this.bs.readUint8()
     } else {
-      bodyLen = 8;
+      bodyLen = 8
     }
     if (this.bs.bitsLeft < bodyLen * 8) {
-      return false;
+      return false
     }
-    var body = this.bs.readArrayBuffer(bodyLen);
+    var body = this.bs.readArrayBuffer(bodyLen)
 
     const parsed = this.parser.parsePgnData(
       { ...pgn, time: new Date(time).toISOString().slice(11, 23) },
@@ -182,38 +100,38 @@ YdvrStream.prototype.parseNextRecord = function () {
       Buffer.from(body),
       false,
       undefined
-    );
+    )
     if (parsed) {
-      this.push(parsed);
+      this.push(parsed)
     }
   }
 
-  this.messageCount += 1;
-  return true;
+  this.messageCount += 1
+  return true
 }
 
 YdvrStream.prototype._transform = function (chunk, encoding, done) {
   if (this.bs == null) {
-    this.bs = new BitStream(chunk);
+    this.bs = new BitStream(chunk)
   } else {
-    var remainingBuffer = this.bs.view.buffer.subarray(this.bs.byteIndex);
-    this.bs = new BitStream(Buffer.concat([remainingBuffer, chunk]));
+    var remainingBuffer = this.bs.view.buffer.subarray(this.bs.byteIndex)
+    this.bs = new BitStream(Buffer.concat([remainingBuffer, chunk]))
   }
   while (true) {
     var startIndex = this.bs.byteIndex
-    let parsed = false;
+    let parsed = false
     try {
-      parsed = this.parseNextRecord();
+      parsed = this.parseNextRecord()
     } catch (ex) {
-      console.error(ex);
-      this.errorCount += 1;
+      console.error(ex)
+      this.errorCount += 1
     }
     if (!parsed) {
-      this.bs.byteIndex = startIndex;
-      break;
+      this.bs.byteIndex = startIndex
+      break
     }
   }
-  done();
-};
+  done()
+}
 
 module.exports = YdvrStream

package/package.json

@@ -1,28 +1,45 @@
 {
   "name": "@canboat/canboatjs",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "description": "Native javascript version of canboat",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "./dist/index.d.ts",
   "scripts": {
     "dev-test": "jest --watch",
-    "test": "jest && mocha --exit",
+    "test": "jest && mocha --require ts-node/register --exit 'test/*.[jt]s'",
     "code-coverage": "jest --coverage && nyc mocha --exit",
     "build_ios": "webpack -c ./webpack.config.js --mode development ./ios.js -o ios_canboat.js",
-    "build_prod_ios": "webpack -c ./webpack.config.js --mode production ./ios.js -o ios_canboat.js"
+    "build_prod_ios": "webpack -c ./webpack.config.js --mode production ./ios.js -o ios_canboat.js",
+    "build": "tsc -b  --pretty false",
+    "watch": "tsc --watch",
+    "prepublishOnly": "npm run build",
+    "prettier": "prettier --write lib test",
+    "lint": "eslint --fix",
+    "ci-lint": "eslint && prettier --check lib test",
+    "ci-test": "npm run build && npm run test && npm run ci-lint",
+    "format": "npm run prettier && npm run lint",
+    "prepare": "husky install"
   },
-  "bin": {
-    "analyzerjs": "./bin/analyzerjs",
-    "to-pgn": "./bin/to-pgn",
-    "candumpanalyzerjs": "./bin/candumpanalyzerjs",
-    "actisense-serialjs": "./bin/actisense-serialjs",
-    "actisense-file": "./bin/actisense-file",
-    "actisense-n2k-tcp": "./bin/actisense-n2k-tcp",
-    "candumpjs": "./bin/candumpjs",
-    "ikonvert-serial": "./bin/ikonvert-serial",
-    "cansend": "./bin/cansend"
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
   },
-  "jest": {
-    "rootDir": "lib"
+  "lint-staged": {
+    "lib/**/*.{js,ts}": [
+      "prettier --write",
+      "eslint --fix"
+    ]
+  },
+  "bin": {
+    "analyzerjs": "./dist/bin/analyzerjs.js",
+    "to-pgn": "./dist/bin/to-pgn.js",
+    "actisense-serialjs": "./dist/bin/actisense-serialjs.js",
+    "actisense-file": "./dist/bin/actisense-file.js",
+    "actisense-n2k-tcp": "./dist/bin/actisense-n2k-tcp.js",
+    "candumpjs": "./dist/bin/candumpjs.js",
+    "ikonvert-serial": "./dist/bin/ikonvert-serial.js",
+    "cansend": "./dist/bin/cansend.js"
   },
   "keywords": [
     "boat",
@@ -53,8 +70,11 @@
     }
   ],
   "license": "Apache-2.0",
+  "engines": {
+    "node": ">=20"
+  },
   "dependencies": {
-    "@canboat/pgns": "6.0.x",
+    "@canboat/ts-pgns": "^1.0.0",
     "bit-buffer": "0.2.3",
     "debug": "^4.3.4",
     "dnssd": "^0.4.1",
@@ -67,15 +87,31 @@
   },
   "devDependencies": {
     "@signalk/server-api": "^1.39.0",
+    "@tsconfig/node20": "^20.1.6",
+    "@types/chai": "^5.2.2",
+    "@types/debug": "^4.1.12",
+    "@types/jest": "^30.0.0",
+    "@types/lodash": "^4.17.19",
+    "@types/minimist": "^1.2.5",
     "baconjs": "^1.0.1",
     "buffer": "^6.0.3",
     "chai": "^4.1.2",
     "chai-json-equal": "0.0.1",
     "chai-string": "^1.5.0",
     "chai-things": "^0.2.0",
-    "jest": "^24.7.1",
+    "eslint": "^9.30.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-plugin-prettier": "^5.5.1",
+    "husky": "^8.0.0",
+    "jest": "^30.0.3",
+    "lint-staged": "^16.1.2",
     "mocha": "^5.0.0",
     "nyc": "^15.1.0",
+    "prettier": "^3.6.2",
+    "ts-jest": "^29.4.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.35.0",
     "webpack-cli": "^5.1.4"
   },
   "optionalDependencies": {

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "extends": "@tsconfig/node20/tsconfig.json",
+  "compilerOptions": {
+    "outDir": "${configDir}/dist",
+    "rootDir": "${configDir}/lib",
+    "allowJs": true,
+    "typeRoots": ["./node_modules/@types"],
+    "resolveJsonModule": true,
+    "composite": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "isolatedModules": true
+  },
+  "ts-node": {
+    "files": true
+  },
+  "include": ["./lib/**/*"],
+}