Merge pull request #32 from hasanheroglu/18-td-utils

add td utils

.github/workflows/ci-td-utils.yaml

@@ -0,0 +1,52 @@
+name: TD Utils CI Pipeline
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "node/td-utils/**"
+  pull_request:
+    branches: [main]
+    paths:
+      - "node/td-utils/**"
+  workflow_dispatch:
+
+defaults:
+  run:
+    working-directory: node/td-utils
+
+jobs:
+  setup-and-test:
+    name: Tests (${{ matrix.os }}, Node ${{ matrix.node-version }})
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node-version: [18.x, 20.x]
+
+    timeout-minutes: 30
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.os }} ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Test
+        timeout-minutes: 10
+        run: npm run test:coverage
+
+      - name: Upload to codecov.io
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: coverage/lcov.info
+          verbose: true

.gitignore

@@ -7,6 +7,7 @@ node_modules
 # dist directory should be included only in the Package but not Repository
 dist
 out
+build
 
 # logging
 logs.json

node/td-utils/README.md

@@ -0,0 +1,26 @@
+# Eclipse Thingweb - TD Utils
+
+The package provides utility tools for TDs, such as:
+
+-   Detecting protocol schemes in a TD
+
+## Usage
+
+-   Install this package via NPM (`npm install @thingweb/td-utils`) (or clone the repo, change to `node/td-utils` and install the package with `npm install`)
+-   Node.js or Browser import:
+
+    -   Node.js: Require the package and use the functions
+
+```javascript
+const tdUtils = require("@thingweb/td-utils");
+```
+
+-   Browser: Import the `tdUtils` object as a global by adding a script tag to your HTML.
+
+```html
+<script src="./node_modules/@thingweb/td-utils/dist/web-bundle.min.js"></script>
+```
+
+## License
+
+Licensed under the Eclipse or W3C license, see [License](https://github.com/eclipse-thingweb/td-tools/blob/main/LICENSE.md).

node/td-utils/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+    presets: [["@babel/preset-env", { targets: { node: "current" } }], "@babel/preset-typescript"],
+};

node/td-utils/index.ts

@@ -0,0 +1 @@
+export { detectProtocolSchemes } from "./src/detectProtocolSchemes";