Initial work derived from marty2js and Marty app

Author: robdobsn

.editorconfig

@@ -0,0 +1,14 @@
+# http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = true

.eslintrc.js

@@ -0,0 +1,11 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: [
+    '@typescript-eslint',
+  ],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+};

.gitattributes

@@ -0,0 +1,3 @@
+# Auto detect text files and perform LF normalization
+* text eol=lf
+

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,16 @@
+## Expected Behavior
+
+
+## Actual Behavior
+
+
+## Steps to Reproduce the Problem
+
+1.
+1.
+1.
+
+## Specifications
+
+- Version:
+- Platform:

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,6 @@
+Fixes #<issue_number_goes_here>
+
+> It's a good idea to open an issue first for discussion.
+
+- [ ] Tests pass
+- [ ] Appropriate changes to README are included in PR

.github/workflows/deploy-gh-pages.yml

@@ -0,0 +1,34 @@
+#
+# Builds the docs and deploys to GitHub pages
+#
+# https://github.com/actions/setup-node
+# Using https://github.com/marketplace/actions/deploy-to-github-pages
+name: Deploy to Github pages
+
+on:
+  push:
+    #tags:
+    #  - v*
+    branches:
+      - master
+
+jobs:
+  deploy_pages:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v2
+      with:
+        node-version: '12'
+        cache: 'yarn'
+    - run: yarn install
+    - run: yarn docs
+
+    - run: touch docs/.nojekyll
+    - name: Deploy docs 🚀
+      uses: JamesIves/github-pages-deploy-action@releases/v3
+      with:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        BRANCH: gh-pages # The branch the action should deploy to.
+        FOLDER: docs # The folder the action should deploy.

.github/workflows/lint-and-test.yml

@@ -0,0 +1,25 @@
+name: Lint and test
+
+on: [push, pull_request]
+
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        nodejs: [10, 12, 14]
+
+    steps:
+    - uses: actions/checkout@v2
+
+    # https://github.com/actions/setup-node
+    - uses: actions/setup-node@v2-beta
+      with:
+        node-version: ${{ matrix.nodejs }}
+
+    - run: yarn install
+    - run: yarn add -D esbuild
+    - run: yarn test
+    - run: yarn lint
+    - run: yarn build-all

.gitignore

@@ -0,0 +1,10 @@
+/node_modules/
+/build/
+/lib/
+/dist/
+/docs/
+.idea/*
+
+.DS_Store
+coverage
+*.log

.gitlab-ci.yml

@@ -0,0 +1,31 @@
+image: node:12
+
+cache:
+  paths:
+    - node_modules/
+
+stages:
+  - test
+  - deploy
+
+lint-and-test:
+  stage: test
+  script:
+    - yarn install
+    - yarn add -D esbuild
+    - yarn test
+    - yarn lint
+    - yarn build-all
+
+# Deploy docs to Gitlab pages
+pages:
+  stage: deploy
+  only:
+    - master
+  script:
+    - yarn install
+    - yarn docs
+    - mv docs public
+  artifacts:
+    paths:
+      - public

.npmignore

@@ -0,0 +1,17 @@
+/.github/
+/.vscode/
+/node_modules/
+/build/
+/tmp/
+.idea/*
+/docs/
+
+coverage
+*.log
+.gitlab-ci.yml
+
+package-lock.json
+/*.tgz
+/tmp*
+/mnt/
+/package/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Robotical
+
+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,13 @@
+# @robotical/ricjs
+Javascript/TS library for Robotical RIC
+
+## Install
+
+```bash
+$ npm install @robotical/ricjs
+```
+
+## Usage
+
+```js
+```

__tests__/RICMiniHCLC.test.ts

@@ -0,0 +1,50 @@
+import RICMiniHDLC from '../src/RICMiniHDLC';
+// import RICUtils from '../src/RICUtils';
+
+test('HDLC simple encode', () => {
+    const hdlc = new RICMiniHDLC();
+    const encodedBuf = hdlc.encode(new Uint8Array([72, 101, 108, 108, 111]));
+    // console.log(RICUtils.bufferToHex(encodedBuf));
+    expect(encodedBuf).toEqual(new Uint8Array([
+        hdlc.FRAME_BOUNDARY_OCTET,
+        72,
+        101,
+        108,
+        108,
+        111,
+        0xda,
+        0xda,
+        hdlc.FRAME_BOUNDARY_OCTET,
+    ]));
+});
+
+test('HDLC simple decode', () => {
+    const hdlc = new RICMiniHDLC();
+
+    const testMsg = new Uint8Array(
+        [
+            hdlc.FRAME_BOUNDARY_OCTET,
+            'H'.charCodeAt(0),
+            'e'.charCodeAt(0),
+            'l'.charCodeAt(0),
+            'l'.charCodeAt(0),
+            'o'.charCodeAt(0),
+            0xda, 
+            0xda,
+            hdlc.FRAME_BOUNDARY_OCTET,
+        ]);
+
+    let frameReceived: Uint8Array = new Uint8Array(0);
+
+    function onHDLCFrame(rxFrame: Uint8Array) {
+        frameReceived = rxFrame;
+    }
+
+    hdlc.onRxFrame = onHDLCFrame.bind(this);
+
+    hdlc.addRxBytes(testMsg);
+
+    expect(frameReceived).toEqual(new Uint8Array([72, 101, 108, 108, 111]));
+});
+  
+

jest.config.js

@@ -0,0 +1,10 @@
+module.exports = {
+  roots: ['<rootDir>'],
+  testMatch: [
+    "**/__tests__/**/*.+(ts|tsx|js)",
+    "**/?(*.)+(spec|test).+(ts|tsx|js)"
+  ],
+  transform: {
+    "^.+\\.(ts|tsx)$": "ts-jest"
+  },
+}