@signalk/charts-plugin 2.2.0 → 2.3.1

package/.github/workflows/publish.yml

@@ -0,0 +1,18 @@
+name: Publish to npm
+on:
+  workflow_run:
+   workflows: ["Release on tag"]
+   types: [completed]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v1
+      with:
+        node-version: '16.x'
+        registry-url: 'https://registry.npmjs.org'
+    - run: npm publish --access public
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/release_on_tag.yml

@@ -0,0 +1,27 @@
+name: 'Release on tag'
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  release:
+    permissions:
+      contents: write
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build Changelog
+        id: github_release
+        uses: mikepenz/release-changelog-builder-action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.RELEASE_PAT }}
+
+      - name: Create Release
+        uses: actions/create-release@v1
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          body: ${{steps.github_release.outputs.changelog}}
+        env:
+          GITHUB_TOKEN: ${{ secrets.RELEASE_PAT }}

package/.github/workflows/require_pr_label.yml

@@ -0,0 +1,13 @@
+name: Pull Request Labels
+on:
+  pull_request:
+    types: [opened, labeled, unlabeled, synchronize]
+jobs:
+  label:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: mheap/github-action-required-labels@v1
+        with:
+          mode: exactly
+          count: 1
+          labels: "fix, feature, doc, chore, test, ignore, other, dependencies"

package/.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: CI test
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 16.x]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install
+    - run: npm test
+      env:
+        CI: true

package/README.md

@@ -16,6 +16,9 @@ Signal K Node server plugin to provide chart metadata, such as name, description
 
 <img src="https://user-images.githubusercontent.com/1435910/45048136-c65d2e80-b083-11e8-99db-01e8cece9f89.png" alt="Online chart providers configuration" width="450"/>
 
+_WMS example:_
+![image](https://user-images.githubusercontent.com/38519157/102832518-90077100-443e-11eb-9a1d-d0806bb2b10b.png)
+
 5. Activate plugin
 
 6. Use one of the client apps supporting Signal K charts, for example:
@@ -40,7 +43,7 @@ Plugin adds support for `/resources/charts` endpoints described in [Signal K spe
 
 - `GET /signalk/v1/api/resources/charts/` returns metadata for all available charts
 - `GET /signalk/v1/api/resources/charts/${identifier}/` returns metadata for selected chart
-- `GET /signalk/v1/api/resources/charts/${identifier}/${z}/${x}/${y}` returns a single tile for selected chart
+- `GET /signalk/v1/api/resources/charts/${identifier}/${z}/${x}/${y}` returns a single tile for selected offline chart. As charts-plugin isn't proxy, online charts is not available via this request. You should look the metadata to find proper request.
 
 License
 -------
@@ -56,4 +59,4 @@ Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.
+limitations under the License.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/charts-plugin",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "description": "Signal K plugin to provide chart support for Signal K server",
   "main": "index.js",
   "scripts": {
@@ -21,10 +21,9 @@
     "email": "mikko.vesikkala@iki.fi"
   },
   "dependencies": {
-    "@mapbox/mbtiles": "0.10.0",
+    "@mapbox/mbtiles": "^0.12.1",
     "baconjs": "1.0.1",
     "bluebird": "3.5.1",
-    "debug": "3.1.0",
     "lodash": "^4.17.11",
     "xml2js": "0.4.19"
   },

package/src/plugin.js

@@ -1,4 +1,3 @@
-const debug = require('debug')('signalk-charts-plugin')
 const Promise = require('bluebird')
 const _ = require('lodash')
 const path = require('path')
@@ -25,12 +24,12 @@ module.exports = function(app) {
       result[provider.identifier] = provider
       return result
     }, {})
-    debug(`Start charts plugin. Chart paths: ${chartPaths.join(', ')}, online charts: ${onlineProviders.length}`)
+    app.debug(`Start charts plugin. Chart paths: ${chartPaths.join(', ')}, online charts: ${onlineProviders.length}`)
 
     const loadProviders = Promise.mapSeries(chartPaths, chartPath => Charts.findCharts(chartPath))
       .then(list => _.reduce(list, (result, charts) => _.merge({}, result, charts), {}))
     return loadProviders.then(charts => {
-      console.log(`Chart plugin: Found ${_.keys(charts).length} charts from ${chartPaths.join(', ')}`)
+      app.debug(`Chart plugin: Found ${_.keys(charts).length} charts from ${chartPaths.join(', ')}`)
       chartProviders = _.merge({}, charts, onlineProviders)
       // Do not register routes if plugin has been started once already
       pluginStarted === false && registerRoutes()
@@ -42,7 +41,6 @@ module.exports = function(app) {
   }
 
   function stop() {
-    debug("Chart plugin stopped")
   }
 
   function registerRoutes() {
@@ -128,6 +126,12 @@ module.exports = function(app) {
                 minimum: MIN_ZOOM,
                 default: 15,
               },
+              serverType: {
+                type: 'string',
+                title: 'Server Type',
+                default: 'tilelayer',
+                enum: ['tilelayer', 'WMS']
+              },
               format: {
                 type: 'string',
                 title: 'Format',
@@ -137,7 +141,17 @@ module.exports = function(app) {
               url: {
                 type: 'string',
                 title: 'URL',
-                description: 'Tileset URL containing {z}, {x} and {y} parameters, for example "http://example.org/{z}/{x}/{y}.png"'
+                description: 'Map URL (for tilelayer include {z}, {x} and {y} parameters, e.g. "http://example.org/{z}/{x}/{y}.png")'
+              },
+              layers: {
+                type: 'array',
+                title: 'Layers',
+                description: '(WMS only) ',
+                items: {
+                    title: 'Layer Name',
+                    description: 'Name of layer to display',
+                    type: 'string'
+                }
               }
             }
           }
@@ -170,10 +184,11 @@ function convertOnlineProviderConfig(provider) {
     minzoom: Math.min(Math.max(1, provider.minzoom), 19),
     maxzoom: Math.min(Math.max(1, provider.maxzoom), 19),
     format: provider.format,
-    type: 'tilelayer',
     scale: 'N/A',
     identifier: id,
-    tilemapUrl: provider.url
+    tilemapUrl: provider.url,
+    type: (provider.serverType) ? provider.serverType : 'tilelayer',
+    chartLayers: (provider.layers) ? provider.layers : null
   }
 }