signalk-charts-provider-simple 1.0.0

package/,github/workflows/publish.yml

@@ -0,0 +1,40 @@
+name: Publish Package
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Clean workspace
+        run: git clean -xfd
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      # Ensure npm 11.5.1 or later is installed
+      - name: Update npm
+        run: npm install -g npm@latest
+      - run: npm install
+
+      - run: npm test
+
+      - name: Publish
+        run: | 
+          if [[ "${{ github.ref }}" == refs/tags/*-beta.* ]] || [[ "${{ github.ref }}" == refs/tags/*-rc.* ]]; then
+            npm publish --provenance --access public --tag beta
+          else
+            npm publish --provenance --access public
+          fi

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## [1.0.0] 2025-01-26
+- Initial release
+- Material Design 3 UI
+- Optimized for touch and mobile
+- Download queue management
+- Manual Upload
+- Folder organization with drag-and-drop
+- Root folder and subfolder will be abailable for charts
+- Abillity to disable certain charts (requires server reload)
+- Rename chart (requires server reload)

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Signal K Community
+
+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.

package/README.md

@@ -0,0 +1,88 @@
+# Signal K Charts Provider Simple
+
+A lightweight, JavaScript-based Signal K server plugin for managing local nautical charts. This plugin provides a clean interface for organizing, uploading, and serving MBTiles.
+
+## Features
+
+- **Local Chart Management**: Support for MBTiles
+- **Download Manager**: Built-in download queue with progress tracking and automatic ZIP extraction
+- **Modern Web UI**: Clean, Material Design 3 interface with drag-and-drop chart organization
+- **Chart Organization**: Folder-based organization with enable/disable toggles
+- **Dual API Support**: Compatible with both Signal K v1 and v2 API
+
+
+## Installation
+
+### From Signal K Appstore
+
+1. Open your Signal K server admin interface
+2. Navigate to Appstore
+3. Search for "Charts Provider Simple"
+4. Click Install
+
+### Manual Installation
+
+```bash
+cd ~/.signalk
+npm install signalk-charts-provider-simple
+```
+
+## Configuration
+
+1. Navigate to **Server → Plugin Config → Charts Provider Simple**
+2. Set your chart directory path (defaults to `~/.signalk/charts`)
+3. Enable the plugin
+4. Restart Signal K server
+
+## Usage
+
+### Web Interface
+
+Access the plugin's web interface through your Signal K server:
+
+```
+http://[your-server]:3000/plugins/signalk-charts-provider-simple/
+```
+
+The interface provides two main tabs:
+
+1. **Manage Charts**:
+   - View all charts in your library
+   - Enable/disable charts
+   - Organize charts into folders
+   - Upload new chart files
+   - Delete unwanted charts
+   - Rename charts
+
+2. **Download from URL**:
+   - Download charts directly from any URL
+   - Supports `.mbtiles` files and `.zip` archives
+   - Automatic extraction of MBTiles from ZIP files
+   - Download queue with progress tracking
+   - Simple, clean interface without complex chart browsing
+
+### Chart Formats
+
+The plugin supports this chart formats:
+
+- **MBTiles** (`.mbtiles`): SQLite-based map tile format
+
+### Compatible Chart Plotters
+
+Charts provided by this plugin work with:
+- [Freeboard SK](https://www.npmjs.com/package/@signalk/freeboard-sk)
+- [OpenCPN](https://opencpn.org/)
+
+## Acknowledgments
+
+Inspired by [Signal K Charts Plugin](https://github.com/SignalK/charts-plugin) by Mikko Vesikkala.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Support
+
+For issues and feature requests:
+- GitHub Issues: https://github.com/dirkwa/signalk-charts-provider-simple/issues
+

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "signalk-charts-provider-simple",
+  "version": "1.0.0",
+  "description": "Simple Signal K chart provider for local MBTiles and directory-based charts with download management",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "license": "MIT",
+  "keywords": [
+    "signalk",
+    "signalk-node-server-plugin",
+    "signalk-webapp",
+    "nautic",
+    "chart",
+    "mbtiles",
+    "tms",
+    "chart-management",
+    "download-manager"
+  ],
+  "author": {
+    "name": "Dirk Wahrheit",
+    "email": "dirkwa@users.noreply.github.com"
+  },
+  "dependencies": {
+    "@mapbox/mbtiles": "^0.12.1",
+    "@signalk/server-api": "^2.0.0",
+    "bluebird": "^3.5.1",
+    "busboy": "^1.6.0",
+    "lodash": "^4.17.11",
+    "unzipper": "^0.12.3",
+    "xml2js": "^0.6.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dirkwa/signalk-charts-provider-simple"
+  },
+  "signalk": {
+    "appIcon": "assets/charts_logo.png",
+    "displayName": "Charts Provider Simple",
+    "appstore": {
+      "displayName": "Charts Provider Simple",
+      "categories": [
+        "utilities"
+      ],
+      "author": "Dirk Wahrheit",
+      "description": "Simple Signal K chart provider for local MBTiles and directory-based charts with download management"
+    },
+    "webapp": {
+      "name": "Charts Provider Simple",
+      "description": "Simple Signal K chart provider for local MBTiles and directory-based charts",
+      "location": "/plugins/signalk-charts-provider-simple/"
+    }
+  }
+}