Working develop API

Author: bautisflow

.github/workflows/publish.yml

@@ -0,0 +1,92 @@
+name: "publish"
+
+on:
+  push:
+    branches: [ main, develop ]
+
+jobs:
+  publish:
+    name: publish
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: Extract branch name
+        shell: bash
+        run: echo "branch=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV
+
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ env.branch }}
+
+      - name: node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org
+
+      - name: Get tag version
+        run: |
+          echo "tag_version=`awk '/^## \[[0-9]+/' CHANGELOG.md | awk 'NR==1 && -F"\[\]" {print $2}' 2>/dev/null | tail -c +2 | head -c -2`" >> $GITHUB_ENV
+
+      - name: Check if tag is for develop and if it already exists
+        run: |
+          git fetch --prune --tags
+          if [ ${{ env.branch }} == 'develop' ]; then
+              for i in {1..100}; do
+                  if [ `git tag --list | grep ${{ env.tag_version }}"-alpha.${i}" | wc -l` -eq 0 ]; then
+                      tag_version=${{ env.tag_version }}"-alpha.${i}"
+                      echo "tag_version=${tag_version}" >> $GITHUB_ENV
+                      echo "npm_tag_version=develop" >> $GITHUB_ENV
+                      break;
+                  fi
+              done
+          elif [ ${{ env.branch }} == 'master' ]; then
+              echo "npm_tag_version=latest" >> $GITHUB_ENV
+          elif [ `git tag --list | grep -q ${{ env.tag_version }}` -ne 0 ]; then exit 1; fi
+
+      - name: Update package.json version, package-lock.json and commit
+        working-directory: ./src
+        run: |
+          jq '.version = "'"$tag_version"'"' package.json > package.tmp && mv package.tmp package.json
+          npm install --package-lock-only
+          git config user.name "GitHub Actions Bot"
+          git config user.email "<>"
+          
+          if [ "$(git diff --exit-code)" ]; then
+            git add package.json package-lock.json
+            git commit -m "Updated package and package-lock with ${npm_version}"
+            git push
+          fi
+
+      - name: publish
+        working-directory: ./src
+        run: |
+          cp ../README.md ../CHANGELOG.md .
+          npm publish --tag ${{ env.npm_tag_version }} --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+
+      - name: Get changelog body
+        run: |
+          awk '/^## \[[0-9]+/,EOF' CHANGELOG.md | awk '(NR>1)' | awk '1;/^## \[[0-9]+/{exit}' | sed '$d' > release_body.md
+
+      - name: Set pre-release boolean
+        run: |
+          prerelease=false
+          if [ ${{ env.branch }} == 'develop' ]; then
+              prerelease=true
+          fi
+          echo "prerelease=$prerelease" >> $GITHUB_ENV
+
+      - name: Create GitHub release
+        uses: ncipollo/release-action@v1
+        with:
+          prerelease: ${{ env.prerelease }}
+          commit: ${{ env.branch }}
+          tag: ${{ env.tag_version }}
+          name: ${{ env.tag_version }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          bodyFile: "release_body.md"

.gitignore

@@ -1,5 +1,2 @@
-wwwroot/*.js
-node_modules
-typings
-dist
 .idea
+openapi.clean.json

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2025-01-08
+
+### Added
+
+- Initial release of the Thinger.io Node.js SDK for Devices, Plugins and Products
+
+[0.1.0]: https://github.com/thinger-io/thinger-node/tag/0.1.0
+
+

LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2025 Thinger.io
+
+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

@@ -1,25 +1,20 @@
+# Thinger.io Node.js Library
 
-# Thinger Node.js library
-
-This library provides a Node.js client for the Thinger.io platform, autogenerated from the OpenAPI specification.
-
-```
-docker run --rm --user 1000 \
-  -v ${PWD}:/local openapitools/openapi-generator-cli generate \
-  -i /local/out/swagger.json \
-  -g typescript-node \
-  -c /local/out/config.yaml \
-  --skip-validate-spec \
-  -e mustache \
-  -t /local/out/node/templates \
-  --remove-operation-id-prefix \
-  --reserved-words-mappings \
-  -o /local/out/node
-```
-
-## Extract templates
-
-```
-docker run --rm --user 1000 \
-  -v ${PWD}:/local openapitools/openapi-generator-cli author template -g typescript-node -o /local/templates
+> [!WARNING]  
+> Currently this Library is in development and may contain bugs or incomplete features.
+
+The Thinger.io Node library provides convenient access to the Thinger.io API from applications written in server-side JavaScript.
+
+## Documentation
+
+See the [Thinger.io API documentation](https://console.thinger.io/swagger/) for a complete reference of the Thinger.io API.
+
+Library documentation is available in [src/README.md](./src/README.md).
+
+## Installation
+
+Install the package with:
+
+```sh
+npm install @thinger-io/thinger-node
 ```

TODO.md

@@ -0,0 +1,36 @@
+# thinger-node
+
+This generator creates TypeScript/JavaScript client that utilizes native fetch-api.
+
+### Todo
+
+- [X] Full replacement of `node-fetch` for native fetch in templates
+  - [X] `fetch` in `isomorphic-fetch.ts` interaction with http file
+  - [ ] Add `User-Agent` header to `fetch` in `isomorphic-fetch.ts`
+- [ ] Add tests with mock functionality
+- [ ] Add Thinger.io API
+  - [ ] Add `Server` API
+  - [X] Add `Plugins` API
+  - [ ] Add `Users` API
+  - [ ] Add `Brands` API
+  - [ ] Add `Claims` API
+  - [ ] Add `Domains` API
+  - [ ] Add `Endpoints` API
+  - [ ] Add `Hosts` API
+  - [ ] Add `OauthClients` API
+  - [ ] Add `Proxies` API
+  - [ ] Add `Alarms` API
+  - [ ] Add `Alarms` API
+  - [ ] Add `Assets` API
+  - [ ] Add `Buckets` API
+  - [ ] Add `Dashboards` API
+  - [X] Add `Devices` API
+  - [ ] Add `Groups` API
+  - [X] Add `Products` API
+  - [ ] Add `Projects` API
+  - [ ] Add `Roles` API
+  - [ ] Add `Storages` API
+  - [ ] Add `Syncs` API
+  - [ ] Add `Tokens` API
+  - [ ] Add `Types` API
+- [ ] Allow declaration of arrays in body as well as simple objects (see property create)

config.yaml

@@ -1,17 +1,24 @@
-disallowAdditionalPropertiesIfNotPresent: false
-licenseName: "MIT"
-npmName: "thinger-node"
-npmRepository: "https://github.com/thinger-io/thinger-node"
-npmVersion: "0.0.1"
-supportsES6: true
-validationAttributes: true
-withInterfaces: true
+generatorName: typescript
+outputDir: /local/src
+inputSpec: /local/openapi.clean.json
+templateDir: /local/templates
+additionalProperties:
+  disallowAdditionalPropertiesIfNotPresent: false
+  licenseName: "MIT"
+  npmName: "@thinger-io/thinger-node"
+  npmVersion: "0.1.0"
+  platform: "node"
+  supportsES6: true
+  useObjectParameters: false
+  importFileExtension: ".js"
+  #validationAttributes: true
+  #withInterfaces: true
 openapiNormalizer:
+  SIMPLIFY_ONEOF_ANYOF: true
   REMOVE_X_INTERNAL: true
   KEEP_ONLY_FIRST_TAG_IN_OPERATION: true
+  SIMPLIFY_ANYOF_STRING_AND_ENUM_STRING: true
+  REFACTOR_ALLOF_WITH_PROPERTIES_ONLY: false
 reservedWordsMappings:
   delete: remove
   export: exportData
-# Global config
-apiTests: true
-modelTests: true

generate.sh

@@ -6,13 +6,69 @@ curl -X 'GET' \
   -H 'accept: application/json' \
   -o openapi.json
 
+# Remove previous generated files
+rm -rf src
+
+jq . openapi.json > openapi.tmp1.json # prettify
+# Remove unused schemas
+jq 'del(
+      .components.schemas.alarm_rule,
+      .components.schemas.bucket_backend,
+      .components.schemas.bucket_config,
+      .components.schemas.bucket_retention,
+      .components.schemas.claim_config,
+      .components.schemas.permission,
+      .components.schemas.projects_ids,
+      .components.schemas.sync_config
+      )' openapi.tmp1.json > openapi.tmp2.json
+
+# Remove paths that are not tagged with Products or Plugins
+jq 'del(.paths[] | select([.[]? | .tags? | (
+      index("Products") //
+      index("Plugins") //
+      index("Devices")
+    )] | any == false))' openapi.tmp2.json > openapi.tmp3.json
+
+# Remove the array as body when another body is present ( property create )
+jq 'walk(
+  if type == "object" then
+    with_entries(
+      # Check if the key is "requestBody" and if it contains "oneOf"
+      if .key == "requestBody" and
+         .value.content?.["application/json"]?.schema?.oneOf then
+        .value.content."application/json".schema |= { "$ref": "#/components/schemas/property_create" }
+      else
+        . # Leave other parts as is
+      end
+    )
+  else
+    . # No changes to non-object values
+  end
+)' openapi.tmp3.json > openapi.tmp4.json
+
+mv openapi.tmp4.json openapi.clean.json
+rm openapi.tmp*.json
+
 # Generate the client
 docker run --rm --user 1000 \
   -v ${PWD}:/local openapitools/openapi-generator-cli generate \
-  -i /local/openapi.json \
-  -g typescript-node \
+  -g typescript \
   -c /local/config.yaml \
   -e mustache \
-  -t /local/templates \
-  --remove-operation-id-prefix \
-  -o /local
+  --remove-operation-id-prefix
+
+#  -i /local/openapi.json \
+#  -t /local/templates \
+#  --skip-validate-spec \
+#--dry-run
+#        --git-host <git host>
+#            Git host, e.g. gitlab.com.
+#
+#        --git-repo-id <git repo id>
+#            Git repo ID, e.g. openapi-generator.
+#
+#        --git-user-id <git user id>
+#            Git user ID, e.g. openapitools.
+#  --reserved-words-mappings
+
+