@signalk/assemblyscript-plugin-sdk 0.2.0

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [dirkwa] [Dirk Wahrheit]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   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.

package/README.md

@@ -0,0 +1,40 @@
+# Signal K AssemblyScript Plugin SDK
+
+Build WASM plugins for Signal K Server using TypeScript-like syntax.
+
+## Features
+
+- TypeScript-like syntax (strict subset)
+- Compiles directly to WASM
+- Small binaries (3-10 KB typical)
+- Good performance (80-90% of Rust)
+- Familiar tooling (npm, TypeScript)
+
+## Installation
+
+```bash
+npm install @signalk/assemblyscript-plugin-sdk
+npm install --save-dev assemblyscript
+```
+
+## Documentation
+
+For complete documentation including:
+
+- Step-by-step tutorial
+- API reference
+- Resource providers
+- Troubleshooting
+
+See the [AssemblyScript Plugin Guide](../../docs/develop/plugins/wasm/assemblyscript.md) in the Signal K Server documentation.
+
+## Examples
+
+See [examples/wasm-plugins/](../../examples/wasm-plugins/) for working examples:
+
+- `example-hello-assemblyscript` - Basic plugin
+- `example-weather-plugin` - Resource provider with network requests
+
+## License
+
+Apache-2.0

package/asconfig.json

@@ -0,0 +1,25 @@
+{
+  "targets": {
+    "release": {
+      "outFile": "build/plugin.wasm",
+      "sourceMap": false,
+      "optimize": true,
+      "shrinkLevel": 2,
+      "converge": true,
+      "noAssert": true,
+      "runtime": "stub",
+      "use": "abort="
+    },
+    "debug": {
+      "outFile": "build/plugin.debug.wasm",
+      "sourceMap": true,
+      "debug": true,
+      "runtime": "stub"
+    }
+  },
+  "options": {
+    "bindings": "esm",
+    "exportRuntime": false,
+    "transform": ["as-fetch/transform"]
+  }
+}

package/assembly/api.ts

@@ -0,0 +1,287 @@
+/**
+ * Signal K Server API functions for AssemblyScript plugins
+ *
+ * These functions provide the FFI bridge to the Signal K server
+ */
+
+import { Delta } from './signalk'
+
+// ===== FFI Declarations =====
+// These functions are provided by the Signal K server
+
+/**
+ * @internal
+ * Emit delta to Signal K server
+ * @param deltaPtr - Pointer to delta JSON string
+ * @param deltaLen - Length of delta JSON string
+ * @param version - Signal K version: 0 = v1 (default), 1 = v2
+ */
+@external("env", "sk_handle_message")
+declare function sk_handle_message_ffi(deltaPtr: usize, deltaLen: usize, version: i32): void
+
+/**
+ * @internal
+ * Set plugin status message
+ */
+@external("env", "sk_set_status")
+declare function sk_set_status_ffi(msgPtr: usize, msgLen: usize): void
+
+/**
+ * @internal
+ * Set plugin error message
+ */
+@external("env", "sk_set_error")
+declare function sk_set_error_ffi(msgPtr: usize, msgLen: usize): void
+
+/**
+ * @internal
+ * Debug logging
+ */
+@external("env", "sk_debug")
+declare function sk_debug_ffi(msgPtr: usize, msgLen: usize): void
+
+/**
+ * @internal
+ * Get value from vessel.self path
+ */
+@external("env", "sk_get_self_path")
+declare function sk_get_self_path_ffi(
+  pathPtr: usize,
+  pathLen: usize,
+  bufPtr: usize,
+  bufLen: usize
+): i32
+
+/**
+ * @internal
+ * Get value from any context path
+ */
+@external("env", "sk_get_path")
+declare function sk_get_path_ffi(
+  pathPtr: usize,
+  pathLen: usize,
+  bufPtr: usize,
+  bufLen: usize
+): i32
+
+/**
+ * @internal
+ * Read plugin configuration
+ */
+@external("env", "sk_read_config")
+declare function sk_read_config_ffi(bufPtr: usize, bufLen: usize): i32
+
+/**
+ * @internal
+ * Save plugin configuration
+ */
+@external("env", "sk_save_config")
+declare function sk_save_config_ffi(configPtr: usize, configLen: usize): i32
+
+// ===== Public API Functions =====
+
+/**
+ * Signal K version for delta emission
+ */
+export const SK_VERSION_V1: i32 = 1
+export const SK_VERSION_V2: i32 = 2
+
+/**
+ * Emit a delta message to the Signal K server
+ *
+ * @param delta The delta message to emit
+ * @param skVersion Signal K version: SK_VERSION_V1 (default) or SK_VERSION_V2
+ *
+ * Use SK_VERSION_V1 (default) for regular navigation data.
+ * Use SK_VERSION_V2 for Course API paths and other v2-specific data to prevent
+ * v2 data from being mixed into the v1 full data model.
+ *
+ * @example
+ * ```typescript
+ * // Emit v1 delta (default - for regular navigation data)
+ * const delta = createSimpleDelta('my-plugin', 'environment.temperature', '25.5')
+ * emit(delta)
+ *
+ * // Emit v2 delta (for Course API and v2-specific paths)
+ * const courseDelta = createSimpleDelta('my-plugin', 'navigation.course.nextPoint', positionJson)
+ * emit(courseDelta, SK_VERSION_V2)
+ * ```
+ */
+export function emit(delta: Delta, skVersion: i32 = SK_VERSION_V1): void {
+  const json = delta.toJSON()
+  const buffer = String.UTF8.encode(json)
+  const ptr = changetype<usize>(buffer)
+  sk_handle_message_ffi(ptr, buffer.byteLength, skVersion)
+}
+
+/**
+ * Set plugin status message (shown in admin UI)
+ *
+ * @param message Status message
+ *
+ * @example
+ * ```typescript
+ * setStatus('Running normally')
+ * ```
+ */
+export function setStatus(message: string): void {
+  const buffer = String.UTF8.encode(message)
+  const ptr = changetype<usize>(buffer)
+  sk_set_status_ffi(ptr, buffer.byteLength)
+}
+
+/**
+ * Set plugin error message (shown in admin UI)
+ *
+ * @param message Error message
+ *
+ * @example
+ * ```typescript
+ * setError('Failed to connect to sensor')
+ * ```
+ */
+export function setError(message: string): void {
+  const buffer = String.UTF8.encode(message)
+  const ptr = changetype<usize>(buffer)
+  sk_set_error_ffi(ptr, buffer.byteLength)
+}
+
+/**
+ * Log debug message to server logs
+ *
+ * @param message Debug message
+ *
+ * @example
+ * ```typescript
+ * debug('Processing data: ' + value.toString())
+ * ```
+ */
+export function debug(message: string): void {
+  const buffer = String.UTF8.encode(message)
+  const ptr = changetype<usize>(buffer)
+  sk_debug_ffi(ptr, buffer.byteLength)
+}
+
+/**
+ * Get value from vessel.self path
+ *
+ * @param path Signal K path (e.g., 'navigation.speedOverGround')
+ * @returns JSON-encoded value or null if not found
+ *
+ * @example
+ * ```typescript
+ * const speedJson = getSelfPath('navigation.speedOverGround')
+ * if (speedJson !== null) {
+ *   const speed = parseFloat(speedJson)
+ *   debug('Current speed: ' + speed.toString())
+ * }
+ * ```
+ */
+export function getSelfPath(path: string): string | null {
+  const pathBuffer = String.UTF8.encode(path)
+  const pathPtr = changetype<usize>(pathBuffer)
+
+  // Allocate buffer for result
+  const resultBuffer = new ArrayBuffer(1024)
+  const resultPtr = changetype<usize>(resultBuffer)
+
+  const len = sk_get_self_path_ffi(
+    pathPtr,
+    pathBuffer.byteLength,
+    resultPtr,
+    1024
+  )
+
+  if (len === 0) {
+    return null
+  }
+
+  // Decode result
+  const bytes = Uint8Array.wrap(resultBuffer, 0, len)
+  return String.UTF8.decode(bytes.buffer)
+}
+
+/**
+ * Get value from any context path
+ *
+ * @param path Full Signal K path (e.g., 'vessels.urn:mrn:imo:mmsi:123456789.navigation.position')
+ * @returns JSON-encoded value or null if not found
+ *
+ * @example
+ * ```typescript
+ * const posJson = getPath('vessels.self.navigation.position')
+ * if (posJson !== null) {
+ *   debug('Position: ' + posJson)
+ * }
+ * ```
+ */
+export function getPath(path: string): string | null {
+  const pathBuffer = String.UTF8.encode(path)
+  const pathPtr = changetype<usize>(pathBuffer)
+
+  // Allocate buffer for result
+  const resultBuffer = new ArrayBuffer(1024)
+  const resultPtr = changetype<usize>(resultBuffer)
+
+  const len = sk_get_path_ffi(
+    pathPtr,
+    pathBuffer.byteLength,
+    resultPtr,
+    1024
+  )
+
+  if (len === 0) {
+    return null
+  }
+
+  // Decode result
+  const bytes = Uint8Array.wrap(resultBuffer, 0, len)
+  return String.UTF8.decode(bytes.buffer)
+}
+
+/**
+ * Read plugin configuration
+ *
+ * @returns JSON string with configuration
+ *
+ * @example
+ * ```typescript
+ * const configJson = readConfig()
+ * const config = JSON.parse<MyConfig>(configJson)
+ * ```
+ */
+export function readConfig(): string {
+  // Allocate buffer for result
+  const resultBuffer = new ArrayBuffer(4096)
+  const resultPtr = changetype<usize>(resultBuffer)
+
+  const len = sk_read_config_ffi(resultPtr, 4096)
+
+  if (len === 0) {
+    return '{}'
+  }
+
+  // Decode result
+  const bytes = Uint8Array.wrap(resultBuffer, 0, len)
+  return String.UTF8.decode(bytes.buffer)
+}
+
+/**
+ * Save plugin configuration
+ *
+ * @param config Configuration object (will be JSON-serialized)
+ * @returns 0 on success, non-zero on error
+ *
+ * @example
+ * ```typescript
+ * const result = saveConfig(JSON.stringify(myConfig))
+ * if (result !== 0) {
+ *   setError('Failed to save configuration')
+ * }
+ * ```
+ */
+export function saveConfig(configJson: string): i32 {
+  const buffer = String.UTF8.encode(configJson)
+  const ptr = changetype<usize>(buffer)
+  return sk_save_config_ffi(ptr, buffer.byteLength)
+}

package/assembly/index.ts

@@ -0,0 +1,15 @@
+/**
+ * Signal K AssemblyScript Plugin SDK
+ *
+ * Provides TypeScript-like API for building WASM plugins
+ */
+
+// Export all public types and functions
+export * from './plugin'
+export * from './signalk'
+export * from './api'
+export * from './network'
+export * from './resources'
+
+// Re-export JSON parsing library for plugin authors
+export { JSON } from 'assemblyscript-json/assembly'

package/assembly/network.ts

@@ -0,0 +1,53 @@
+/**
+ * Network API for AssemblyScript plugins
+ *
+ * Provides capability checking for network access
+ * Requires 'network' capability in plugin manifest
+ *
+ * For HTTP requests, use as-fetch directly:
+ *
+ * @example
+ * ```typescript
+ * import { fetchSync } from 'as-fetch/sync'
+ * import { Response } from 'as-fetch/assembly'
+ * import { hasNetworkCapability } from 'signalk-assemblyscript-plugin-sdk'
+ *
+ * if (!hasNetworkCapability()) {
+ *   setError('Network capability not granted')
+ *   return 1
+ * }
+ *
+ * const response = fetchSync('https://api.example.com/data')
+ * if (response && response.status === 200) {
+ *   const data = response.text()
+ *   // Process data...
+ * }
+ * ```
+ */
+
+/**
+ * @internal
+ * Check if network capability is granted
+ */
+@external("env", "sk_has_capability")
+declare function sk_has_capability_ffi(capPtr: usize, capLen: usize): i32
+
+/**
+ * Check if network capability is available
+ *
+ * @returns true if plugin has network capability
+ *
+ * @example
+ * ```typescript
+ * if (!hasNetworkCapability()) {
+ *   setError('Network capability not granted')
+ *   return 1
+ * }
+ * ```
+ */
+export function hasNetworkCapability(): boolean {
+  const capName = 'network'
+  const buffer = String.UTF8.encode(capName)
+  const ptr = changetype<usize>(buffer)
+  return sk_has_capability_ffi(ptr, buffer.byteLength) === 1
+}

package/assembly/plugin.ts

@@ -0,0 +1,49 @@
+/**
+ * Base Plugin class that all AssemblyScript plugins must extend
+ */
+
+/**
+ * Abstract base class for Signal K WASM plugins
+ *
+ * Plugins must implement these abstract methods:
+ * - name(): Human-readable plugin name
+ * - schema(): JSON schema for configuration UI
+ * - start(): Initialize plugin with configuration
+ * - stop(): Clean shutdown
+ *
+ * Note: Plugin ID is automatically derived from your package.json name.
+ * For example: "@signalk/example-weather-plugin" → "_signalk_example-weather-plugin"
+ */
+export abstract class Plugin {
+  /**
+   * Return human-readable plugin name for display in Admin UI
+   */
+  abstract name(): string
+
+  /**
+   * Return JSON schema for configuration UI
+   * Must be valid JSON Schema draft-07
+   */
+  abstract schema(): string
+
+  /**
+   * Initialize plugin with configuration
+   * @param config JSON string with configuration
+   * @returns 0 for success, non-zero for error
+   */
+  abstract start(config: string): i32
+
+  /**
+   * Stop plugin and clean up resources
+   * @returns 0 for success, non-zero for error
+   */
+  abstract stop(): i32
+}
+
+/**
+ * Plugin configuration interface
+ * Extend this for type-safe configuration
+ */
+export class PluginConfig {
+  enabled: bool = true
+}

package/assembly/resources.ts

@@ -0,0 +1,157 @@
+/**
+ * Signal K Resource Provider API for AssemblyScript plugins
+ *
+ * Allows WASM plugins to act as resource providers (routes, waypoints, weather, etc.)
+ */
+
+import { JSON } from 'assemblyscript-json/assembly'
+
+// ===== FFI Declarations =====
+
+/**
+ * @internal
+ * Register this plugin as a resource provider for a given type
+ */
+@external("env", "sk_register_resource_provider")
+declare function sk_register_resource_provider_ffi(typePtr: usize, typeLen: usize): i32
+
+// ===== Public API Functions =====
+
+/**
+ * Register this plugin as a resource provider for a given resource type.
+ *
+ * After calling this, the plugin must export the following handler functions:
+ * - resources_list_resources(queryJson: string): string - List resources matching query
+ * - resources_get_resource(requestJson: string): string - Get a single resource
+ * - resources_set_resource(requestJson: string): void - Create/update a resource
+ * - resources_delete_resource(requestJson: string): void - Delete a resource
+ *
+ * @param resourceType The type of resources to provide (e.g., "weather", "routes", "waypoints")
+ * @returns true if registration succeeded, false otherwise
+ *
+ * @example
+ * ```typescript
+ * import { registerResourceProvider } from 'signalk-assemblyscript-plugin-sdk/assembly/resources'
+ *
+ * // In plugin start():
+ * if (!registerResourceProvider("weather-forecasts")) {
+ *   setError("Failed to register as resource provider")
+ *   return 1
+ * }
+ *
+ * // Export handler functions:
+ * export function resources_list_resources(queryJson: string): string {
+ *   // Return JSON object of resources
+ *   return '{"forecast-1": {"name": "Current Weather"}}'
+ * }
+ *
+ * export function resources_get_resource(requestJson: string): string {
+ *   // requestJson: {"id": "forecast-1", "property": null}
+ *   return '{"name": "Current Weather", "temperature": 20.5}'
+ * }
+ * ```
+ */
+export function registerResourceProvider(resourceType: string): bool {
+  const buffer = String.UTF8.encode(resourceType)
+  const ptr = changetype<usize>(buffer)
+  const result = sk_register_resource_provider_ffi(ptr, buffer.byteLength)
+  return result === 1
+}
+
+/**
+ * Check if this plugin has the resourceProvider capability granted.
+ *
+ * The capability must be declared in package.json:
+ * ```json
+ * {
+ *   "wasmCapabilities": {
+ *     "resourceProvider": true
+ *   }
+ * }
+ * ```
+ *
+ * @returns true if resourceProvider capability is granted
+ */
+export function hasResourceProviderCapability(): bool {
+  // Try to check capability via sk_has_capability if available
+  // For now, we'll just return true and let registration fail if not granted
+  return true
+}
+
+// ===== Helper Types for Resource Handlers =====
+
+/**
+ * Request format for resources_get_resource handler
+ */
+export class ResourceGetRequest {
+  id: string = ''
+  property: string | null = null
+
+  static parse(jsonStr: string): ResourceGetRequest {
+    const req = new ResourceGetRequest()
+    const parsed = JSON.parse(jsonStr)
+
+    if (parsed.isObj) {
+      const obj = parsed as JSON.Obj
+      const idValue = obj.getString('id')
+      if (idValue !== null) {
+        req.id = idValue.valueOf()
+      }
+      const propValue = obj.getString('property')
+      if (propValue !== null) {
+        req.property = propValue.valueOf()
+      }
+    }
+
+    return req
+  }
+}
+
+/**
+ * Request format for resources_set_resource handler
+ */
+export class ResourceSetRequest {
+  id: string = ''
+  value: string = '{}'  // JSON string of the value
+
+  static parse(jsonStr: string): ResourceSetRequest {
+    const req = new ResourceSetRequest()
+    const parsed = JSON.parse(jsonStr)
+
+    if (parsed.isObj) {
+      const obj = parsed as JSON.Obj
+      const idValue = obj.getString('id')
+      if (idValue !== null) {
+        req.id = idValue.valueOf()
+      }
+      const valueObj = obj.getObj('value')
+      if (valueObj !== null) {
+        req.value = valueObj.stringify()
+      }
+    }
+
+    return req
+  }
+}
+
+/**
+ * Request format for resources_delete_resource handler
+ */
+export class ResourceDeleteRequest {
+  id: string = ''
+
+  static parse(jsonStr: string): ResourceDeleteRequest {
+    const req = new ResourceDeleteRequest()
+    const parsed = JSON.parse(jsonStr)
+
+    if (parsed.isObj) {
+      const obj = parsed as JSON.Obj
+      const idValue = obj.getString('id')
+      if (idValue !== null) {
+        req.id = idValue.valueOf()
+      }
+    }
+
+    return req
+  }
+}

package/assembly/signalk.ts

@@ -0,0 +1,153 @@
+/**
+ * Signal K data model types for AssemblyScript
+ */
+
+/**
+ * Position with latitude and longitude
+ */
+export class Position {
+  latitude: f64
+  longitude: f64
+
+  constructor(latitude: f64, longitude: f64) {
+    this.latitude = latitude
+    this.longitude = longitude
+  }
+
+  toJSON(): string {
+    return `{"latitude":${this.latitude},"longitude":${this.longitude}}`
+  }
+}
+
+/**
+ * Path-value pair for delta updates
+ */
+export class PathValue {
+  path: string
+  value: string // JSON-encoded value
+
+  constructor(path: string, value: string) {
+    this.path = path
+    this.value = value
+  }
+
+  toJSON(): string {
+    return `{"path":"${this.path}","value":${this.value}}`
+  }
+}
+
+/**
+ * Delta update containing values
+ *
+ * Note: Plugins should NOT include source or timestamp when emitting deltas.
+ * The server automatically sets $source to the plugin ID and fills in
+ * timestamp with the current time.
+ */
+export class Update {
+  values: PathValue[]
+
+  constructor(values: PathValue[]) {
+    this.values = values
+  }
+
+  toJSON(): string {
+    let valuesJson = '['
+    for (let i = 0; i < this.values.length; i++) {
+      if (i > 0) valuesJson += ','
+      valuesJson += this.values[i].toJSON()
+    }
+    valuesJson += ']'
+
+    return `{"values":${valuesJson}}`
+  }
+}
+
+/**
+ * Delta message with context and updates
+ */
+export class Delta {
+  context: string
+  updates: Update[]
+
+  constructor(context: string, updates: Update[]) {
+    this.context = context
+    this.updates = updates
+  }
+
+  toJSON(): string {
+    let updatesJson = '['
+    for (let i = 0; i < this.updates.length; i++) {
+      if (i > 0) updatesJson += ','
+      updatesJson += this.updates[i].toJSON()
+    }
+    updatesJson += ']'
+
+    return `{"context":"${this.context}","updates":${updatesJson}}`
+  }
+}
+
+/**
+ * Notification state
+ */
+export enum NotificationState {
+  normal = 0,
+  alert = 1,
+  warn = 2,
+  alarm = 3,
+  emergency = 4
+}
+
+/**
+ * Notification method
+ */
+export enum NotificationMethod {
+  visual = 0,
+  sound = 1
+}
+
+/**
+ * Signal K notification
+ */
+export class Notification {
+  state: NotificationState
+  method: NotificationMethod[]
+  message: string
+
+  constructor(state: NotificationState, message: string) {
+    this.state = state
+    this.method = [NotificationMethod.visual]
+    this.message = message
+  }
+
+  toJSON(): string {
+    let methodStr = '['
+    for (let i = 0; i < this.method.length; i++) {
+      if (i > 0) methodStr += ','
+      methodStr += this.method[i] == NotificationMethod.visual ? '"visual"' : '"sound"'
+    }
+    methodStr += ']'
+
+    let stateStr = 'normal'
+    if (this.state == NotificationState.alert) stateStr = 'alert'
+    else if (this.state == NotificationState.warn) stateStr = 'warn'
+    else if (this.state == NotificationState.alarm) stateStr = 'alarm'
+    else if (this.state == NotificationState.emergency) stateStr = 'emergency'
+
+    return `{"state":"${stateStr}","method":${methodStr},"message":"${this.message}"}`
+  }
+}
+
+/**
+ * Helper to create a simple delta with single value
+ *
+ * The server automatically adds $source (plugin ID) and timestamp.
+ * Plugins should not include these fields.
+ *
+ * @param path Signal K path (e.g., 'environment.outside.temperature')
+ * @param value JSON-encoded value (e.g., '288.15' or '{"latitude":60,"longitude":24}')
+ */
+export function createSimpleDelta(path: string, value: string): Delta {
+  const pathValue = new PathValue(path, value)
+  const update = new Update([pathValue])
+  return new Delta('vessels.self', [update])
+}

package/build/plugin.d.ts

@@ -0,0 +1,104 @@
+/** Exported memory */
+export declare const memory: WebAssembly.Memory;
+/** assembly/signalk/NotificationState */
+export declare enum NotificationState {
+  /** @type `i32` */
+  normal,
+  /** @type `i32` */
+  alert,
+  /** @type `i32` */
+  warn,
+  /** @type `i32` */
+  alarm,
+  /** @type `i32` */
+  emergency,
+}
+/** assembly/signalk/NotificationMethod */
+export declare enum NotificationMethod {
+  /** @type `i32` */
+  visual,
+  /** @type `i32` */
+  sound,
+}
+/**
+ * assembly/signalk/createSimpleDelta
+ * @param path `~lib/string/String`
+ * @param value `~lib/string/String`
+ * @returns `assembly/signalk/Delta`
+ */
+export declare function createSimpleDelta(path: string, value: string): __Internref4;
+/** assembly/api/SK_VERSION_V1 */
+export declare const SK_VERSION_V1: {
+  /** @type `i32` */
+  get value(): number
+};
+/** assembly/api/SK_VERSION_V2 */
+export declare const SK_VERSION_V2: {
+  /** @type `i32` */
+  get value(): number
+};
+/**
+ * assembly/api/emit
+ * @param delta `assembly/signalk/Delta`
+ * @param skVersion `i32`
+ */
+export declare function emit(delta: __Internref4, skVersion?: number): void;
+/**
+ * assembly/api/setStatus
+ * @param message `~lib/string/String`
+ */
+export declare function setStatus(message: string): void;
+/**
+ * assembly/api/setError
+ * @param message `~lib/string/String`
+ */
+export declare function setError(message: string): void;
+/**
+ * assembly/api/debug
+ * @param message `~lib/string/String`
+ */
+export declare function debug(message: string): void;
+/**
+ * assembly/api/getSelfPath
+ * @param path `~lib/string/String`
+ * @returns `~lib/string/String | null`
+ */
+export declare function getSelfPath(path: string): string | null;
+/**
+ * assembly/api/getPath
+ * @param path `~lib/string/String`
+ * @returns `~lib/string/String | null`
+ */
+export declare function getPath(path: string): string | null;
+/**
+ * assembly/api/readConfig
+ * @returns `~lib/string/String`
+ */
+export declare function readConfig(): string;
+/**
+ * assembly/api/saveConfig
+ * @param configJson `~lib/string/String`
+ * @returns `i32`
+ */
+export declare function saveConfig(configJson: string): number;
+/**
+ * assembly/network/hasNetworkCapability
+ * @returns `bool`
+ */
+export declare function hasNetworkCapability(): boolean;
+/**
+ * assembly/resources/registerResourceProvider
+ * @param resourceType `~lib/string/String`
+ * @returns `bool`
+ */
+export declare function registerResourceProvider(resourceType: string): boolean;
+/**
+ * assembly/resources/hasResourceProviderCapability
+ * @returns `bool`
+ */
+export declare function hasResourceProviderCapability(): boolean;
+/** assembly/signalk/Delta */
+declare class __Internref4 extends Number {
+  private __nominal4: symbol;
+  private __nominal0: symbol;
+}

package/build/plugin.js

@@ -0,0 +1,232 @@
+async function instantiate(module, imports = {}) {
+  const adaptedImports = {
+    env: Object.assign(Object.create(globalThis), imports.env || {}, {
+      sk_handle_message(deltaPtr, deltaLen, version) {
+        // assembly/api/sk_handle_message_ffi(usize, usize, i32) => void
+        deltaPtr = deltaPtr >>> 0;
+        deltaLen = deltaLen >>> 0;
+        sk_handle_message(deltaPtr, deltaLen, version);
+      },
+      sk_set_status(msgPtr, msgLen) {
+        // assembly/api/sk_set_status_ffi(usize, usize) => void
+        msgPtr = msgPtr >>> 0;
+        msgLen = msgLen >>> 0;
+        sk_set_status(msgPtr, msgLen);
+      },
+      sk_set_error(msgPtr, msgLen) {
+        // assembly/api/sk_set_error_ffi(usize, usize) => void
+        msgPtr = msgPtr >>> 0;
+        msgLen = msgLen >>> 0;
+        sk_set_error(msgPtr, msgLen);
+      },
+      sk_debug(msgPtr, msgLen) {
+        // assembly/api/sk_debug_ffi(usize, usize) => void
+        msgPtr = msgPtr >>> 0;
+        msgLen = msgLen >>> 0;
+        sk_debug(msgPtr, msgLen);
+      },
+      sk_get_self_path(pathPtr, pathLen, bufPtr, bufLen) {
+        // assembly/api/sk_get_self_path_ffi(usize, usize, usize, usize) => i32
+        pathPtr = pathPtr >>> 0;
+        pathLen = pathLen >>> 0;
+        bufPtr = bufPtr >>> 0;
+        bufLen = bufLen >>> 0;
+        return sk_get_self_path(pathPtr, pathLen, bufPtr, bufLen);
+      },
+      sk_get_path(pathPtr, pathLen, bufPtr, bufLen) {
+        // assembly/api/sk_get_path_ffi(usize, usize, usize, usize) => i32
+        pathPtr = pathPtr >>> 0;
+        pathLen = pathLen >>> 0;
+        bufPtr = bufPtr >>> 0;
+        bufLen = bufLen >>> 0;
+        return sk_get_path(pathPtr, pathLen, bufPtr, bufLen);
+      },
+      sk_read_config(bufPtr, bufLen) {
+        // assembly/api/sk_read_config_ffi(usize, usize) => i32
+        bufPtr = bufPtr >>> 0;
+        bufLen = bufLen >>> 0;
+        return sk_read_config(bufPtr, bufLen);
+      },
+      sk_save_config(configPtr, configLen) {
+        // assembly/api/sk_save_config_ffi(usize, usize) => i32
+        configPtr = configPtr >>> 0;
+        configLen = configLen >>> 0;
+        return sk_save_config(configPtr, configLen);
+      },
+      sk_has_capability(capPtr, capLen) {
+        // assembly/network/sk_has_capability_ffi(usize, usize) => i32
+        capPtr = capPtr >>> 0;
+        capLen = capLen >>> 0;
+        return sk_has_capability(capPtr, capLen);
+      },
+      sk_register_resource_provider(typePtr, typeLen) {
+        // assembly/resources/sk_register_resource_provider_ffi(usize, usize) => i32
+        typePtr = typePtr >>> 0;
+        typeLen = typeLen >>> 0;
+        return sk_register_resource_provider(typePtr, typeLen);
+      },
+    }),
+  };
+  const { exports } = await WebAssembly.instantiate(module, adaptedImports);
+  const memory = exports.memory || imports.env.memory;
+  const adaptedExports = Object.setPrototypeOf({
+    NotificationState: (values => (
+      // assembly/signalk/NotificationState
+      values[values.normal = exports["NotificationState.normal"].valueOf()] = "normal",
+      values[values.alert = exports["NotificationState.alert"].valueOf()] = "alert",
+      values[values.warn = exports["NotificationState.warn"].valueOf()] = "warn",
+      values[values.alarm = exports["NotificationState.alarm"].valueOf()] = "alarm",
+      values[values.emergency = exports["NotificationState.emergency"].valueOf()] = "emergency",
+      values
+    ))({}),
+    NotificationMethod: (values => (
+      // assembly/signalk/NotificationMethod
+      values[values.visual = exports["NotificationMethod.visual"].valueOf()] = "visual",
+      values[values.sound = exports["NotificationMethod.sound"].valueOf()] = "sound",
+      values
+    ))({}),
+    createSimpleDelta(path, value) {
+      // assembly/signalk/createSimpleDelta(~lib/string/String, ~lib/string/String) => assembly/signalk/Delta
+      path = __retain(__lowerString(path) || __notnull());
+      value = __lowerString(value) || __notnull();
+      try {
+        return __liftInternref(exports.createSimpleDelta(path, value) >>> 0);
+      } finally {
+        __release(path);
+      }
+    },
+    emit(delta, skVersion) {
+      // assembly/api/emit(assembly/signalk/Delta, i32?) => void
+      delta = __lowerInternref(delta) || __notnull();
+      exports.__setArgumentsLength(arguments.length);
+      exports.emit(delta, skVersion);
+    },
+    setStatus(message) {
+      // assembly/api/setStatus(~lib/string/String) => void
+      message = __lowerString(message) || __notnull();
+      exports.setStatus(message);
+    },
+    setError(message) {
+      // assembly/api/setError(~lib/string/String) => void
+      message = __lowerString(message) || __notnull();
+      exports.setError(message);
+    },
+    debug(message) {
+      // assembly/api/debug(~lib/string/String) => void
+      message = __lowerString(message) || __notnull();
+      exports.debug(message);
+    },
+    getSelfPath(path) {
+      // assembly/api/getSelfPath(~lib/string/String) => ~lib/string/String | null
+      path = __lowerString(path) || __notnull();
+      return __liftString(exports.getSelfPath(path) >>> 0);
+    },
+    getPath(path) {
+      // assembly/api/getPath(~lib/string/String) => ~lib/string/String | null
+      path = __lowerString(path) || __notnull();
+      return __liftString(exports.getPath(path) >>> 0);
+    },
+    readConfig() {
+      // assembly/api/readConfig() => ~lib/string/String
+      return __liftString(exports.readConfig() >>> 0);
+    },
+    saveConfig(configJson) {
+      // assembly/api/saveConfig(~lib/string/String) => i32
+      configJson = __lowerString(configJson) || __notnull();
+      return exports.saveConfig(configJson);
+    },
+    hasNetworkCapability() {
+      // assembly/network/hasNetworkCapability() => bool
+      return exports.hasNetworkCapability() != 0;
+    },
+    registerResourceProvider(resourceType) {
+      // assembly/resources/registerResourceProvider(~lib/string/String) => bool
+      resourceType = __lowerString(resourceType) || __notnull();
+      return exports.registerResourceProvider(resourceType) != 0;
+    },
+    hasResourceProviderCapability() {
+      // assembly/resources/hasResourceProviderCapability() => bool
+      return exports.hasResourceProviderCapability() != 0;
+    },
+  }, exports);
+  function __liftString(pointer) {
+    if (!pointer) return null;
+    const
+      end = pointer + new Uint32Array(memory.buffer)[pointer - 4 >>> 2] >>> 1,
+      memoryU16 = new Uint16Array(memory.buffer);
+    let
+      start = pointer >>> 1,
+      string = "";
+    while (end - start > 1024) string += String.fromCharCode(...memoryU16.subarray(start, start += 1024));
+    return string + String.fromCharCode(...memoryU16.subarray(start, end));
+  }
+  function __lowerString(value) {
+    if (value == null) return 0;
+    const
+      length = value.length,
+      pointer = exports.__new(length << 1, 2) >>> 0,
+      memoryU16 = new Uint16Array(memory.buffer);
+    for (let i = 0; i < length; ++i) memoryU16[(pointer >>> 1) + i] = value.charCodeAt(i);
+    return pointer;
+  }
+  class Internref extends Number {}
+  const registry = new FinalizationRegistry(__release);
+  function __liftInternref(pointer) {
+    if (!pointer) return null;
+    const sentinel = new Internref(__retain(pointer));
+    registry.register(sentinel, pointer);
+    return sentinel;
+  }
+  function __lowerInternref(value) {
+    if (value == null) return 0;
+    if (value instanceof Internref) return value.valueOf();
+    throw TypeError("internref expected");
+  }
+  const refcounts = new Map();
+  function __retain(pointer) {
+    if (pointer) {
+      const refcount = refcounts.get(pointer);
+      if (refcount) refcounts.set(pointer, refcount + 1);
+      else refcounts.set(exports.__pin(pointer), 1);
+    }
+    return pointer;
+  }
+  function __release(pointer) {
+    if (pointer) {
+      const refcount = refcounts.get(pointer);
+      if (refcount === 1) exports.__unpin(pointer), refcounts.delete(pointer);
+      else if (refcount) refcounts.set(pointer, refcount - 1);
+      else throw Error(`invalid refcount '${refcount}' for reference '${pointer}'`);
+    }
+  }
+  function __notnull() {
+    throw TypeError("value must not be null");
+  }
+  return adaptedExports;
+}
+export const {
+  memory,
+  NotificationState,
+  NotificationMethod,
+  createSimpleDelta,
+  SK_VERSION_V1,
+  SK_VERSION_V2,
+  emit,
+  setStatus,
+  setError,
+  debug,
+  getSelfPath,
+  getPath,
+  readConfig,
+  saveConfig,
+  hasNetworkCapability,
+  registerResourceProvider,
+  hasResourceProviderCapability,
+} = await (async url => instantiate(
+  await (async () => {
+    const isNodeOrBun = typeof process != "undefined" && process.versions != null && (process.versions.node != null || process.versions.bun != null);
+    if (isNodeOrBun) { return globalThis.WebAssembly.compile(await (await import("node:fs/promises")).readFile(url)); }
+    else { return await globalThis.WebAssembly.compileStreaming(globalThis.fetch(url)); }
+  })(), {
+  }
+))(new URL("plugin.wasm", import.meta.url));

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@signalk/assemblyscript-plugin-sdk",
+  "version": "0.2.0",
+  "description": "AssemblyScript SDK for developing Signal K WASM plugins",
+  "main": "assembly/index.ts",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./assembly/index.ts",
+      "types": "./index.d.ts"
+    },
+    "./assembly": {
+      "import": "./assembly/index.ts"
+    },
+    "./assembly/*": {
+      "import": "./assembly/*.ts"
+    }
+  },
+  "ascMain": "assembly/index.ts",
+  "keywords": [
+    "signalk",
+    "assemblyscript",
+    "wasm",
+    "plugin",
+    "sdk"
+  ],
+  "author": "Signal K",
+  "license": "Apache-2.0",
+  "scripts": {
+    "asbuild:debug": "asc assembly/index.ts --target debug --disableWarning 235",
+    "asbuild:release": "asc assembly/index.ts --target release --disableWarning 235",
+    "build": "npm run asbuild:release",
+    "test": "npm run asbuild:debug"
+  },
+  "devDependencies": {
+    "assemblyscript": "^0.27.0"
+  },
+  "dependencies": {
+    "as-wasi": "^0.6.0",
+    "as-fetch": "^2.1.4",
+    "assemblyscript-json": "^1.1.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SignalK/signalk-server.git",
+    "directory": "packages/assemblyscript-plugin-sdk"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}