Merge pull request #27 from hasanheroglu/23-thing-model-helpers

23 thing model helpers

.github/workflows/ci-thing-model.yaml

@@ -0,0 +1,54 @@
+name: TM Helpers CI Pipeline
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "node/thing-model/**"
+  pull_request:
+    branches: [main]
+    paths:
+      - "node/thing-model/**"
+  workflow_dispatch:
+
+defaults:
+  run:
+    working-directory: node/thing-model
+
+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
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Test
+        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

node/thing-model/README.md

@@ -0,0 +1,20 @@
+# Eclipse Thingweb - TM Helpers
+
+The package provides helper tools for Thing Models.
+Tools help to:
+
+-   Validate TMs,
+-   Get the version of TMs,
+-   Build partial TDs from a given TM,
+-   Retrieve TMs with an URI,
+-   Retrieve external references of a TM.
+
+## Usage
+
+-   Install this package via NPM (`npm install @thingweb/thing-model`) (or clone the repo, change to `node/thing-model`, and install the package with `npm install`)
+
+You can find usage examples in the [tests folder](./tests/).
+
+## License
+
+Licensed under the Eclipse or W3C license, see [License](https://github.com/eclipse-thingweb/td-tools/blob/main/LICENSE.md).