fostrom 0.0.16 → 0.0.18

package/README.md

@@ -4,70 +4,4 @@
 
 The Fostrom Device SDK for JavaScript works in Node.js and Bun, on Linux and macOS, and helps you quickly integrate, start monitoring, and controlling your IoT devices in just a few lines of code.
 
-## Example
-
-```js
-import Fostrom from 'fostrom';
-
-const fostrom = new Fostrom({
-  fleet_id: "<fleet-id>",
-  device_id: "<device-id>",
-  device_secret: "<device-secret>",
-})
-
-// Setup the on_mail handler, to process incoming mail.
-fostrom.onMail = async (mail) => {
-  const {id, name, payload, mailbox_size} = mail
-  console.debug(`Received Mail (${mailbox_size}): ${name} ${id}`)
-
-  // You need to call `mail.ack()` to acknowledge the mail.
-  // Other options are: `mail.reject()` and `mail.requeue()`
-  // Note that if your function throws an error, the SDK will auto-reject the mail.
-  await mail.ack()
-}
-
-async function main() {
-  await fostrom.start()
-
-  // Send a message to Fostrom (payload can be null if schema has no payload)
-  await fostrom.sendMsg("<packet-schema-name>", { /* ...payload */ })
-
-  // Send a datapoint to Fostrom
-  await fostrom.sendDatapoint("<packet-schema-name>", { /* ...payload */ })
-}
-
-main()
-```
-
-> Requires Node.js 22.12+ or Bun 1.2+
-
-You can load the SDK via either syntax:
-
-```js
-import Fostrom from 'fostrom'
-```
-
-```js
-const { default: Fostrom } = require('fostrom')
-```
-
-## A Note on BigInts
-
-Fostrom's Packet Schemas support defining `u64` and `i64` integers. However, JavaScript's `Number` type is limited to `2^53 - 1`. To rectify this issue, we use the `bigint` type and handle JSON encoding and decoding automatically.
-
-Note that there's a caveat here. When Fostrom delivers a message to the SDK containing a `u64` or `i64` number, it will convert to the `Number` type if it is smaller than `2^53 - 1`, and convert to `bigint` if it is larger. This is because the SDK does not know if the field is a `u64` or `i64` type when converting. So for those fields you will need to check whether the type is `bigint` or not.
-
-## A Note on the Device Agent
-
-The Fostrom Device SDK downloads and runs the Fostrom Device Agent in the background. The Agent is downloaded when the package is installed through `npm`. The Device Agent starts when `fostrom.start()` is called and handles communication with the Fostrom platform.
-
-By default, the agent remains running in the background for fast reconnections. The SDK also installs a process exit handler; `fostrom.shutdown()` is called automatically on process exit, and if `stopAgentOnExit` is set to true in the config, the agent is stopped as well.
-
-## Logging
-
-By default, the SDK logs connection and handler messages to the console. Set
-`log: false` in the constructor config to silence SDK logs. Levels used:
-
-- `console.info` for successful connection events
-- `console.warn` for reconnection attempts
-- `console.error` for unauthorized/critical errors
+[Visit our JavaScript SDK Docs to get started.](https://fostrom.io/docs/sdk/js)

package/dl-agent.sh

@@ -4,7 +4,7 @@
 #
 # Usage: ./dl-agent.sh <directory>
 
-VERSION="v0.0.14"
+VERSION="v0.0.16"
 
 # CDN URLs in order of preference
 CDN_PRIMARY="https://cdn.fostrom.dev/fostrom-device-agent/$VERSION"
@@ -29,7 +29,13 @@ download_file() {
     if command -v curl >/dev/null 2>&1; then
         curl -fsSL --connect-timeout 10 --max-time 300 "$URL" -o "$OUTPUT" 2>/dev/null
     elif command -v wget >/dev/null 2>&1; then
-        wget -q --timeout=10 --tries=1 -O "$OUTPUT" "$URL" 2>/dev/null
+      # BusyBox wget often lacks GNU long opts like --tries/--timeout.
+      if wget --help 2>&1 | grep -q -- '--tries'; then
+          wget -q --timeout=10 --tries=1 -O "$OUTPUT" "$URL" 2>/dev/null
+      else
+          # BusyBox-compatible fallback (fewer assumptions)
+          wget -q -O "$OUTPUT" "$URL" 2>/dev/null
+      fi
     else
         die "No download tool found (curl or wget required)"
     fi
@@ -50,7 +56,9 @@ try_download() {
 
 create_temp_dir() {
     if command -v mktemp >/dev/null 2>&1; then
-        mktemp -d 2>/dev/null || mktemp -d -t 'fostrom'
+        mktemp -d -t 'fostrom.XXXXXX' 2>/dev/null \
+          || mktemp -d "${TMPDIR:-/tmp}/fostrom.XXXXXX" 2>/dev/null \
+          || mktemp -d 2>/dev/null
     else
         TEMP_DIR="/tmp/fostrom.$$"
         mkdir -p "$TEMP_DIR" || die "Cannot create temporary directory"
@@ -60,12 +68,20 @@ create_temp_dir() {
 
 verify_checksum() {
     CHECKSUM_FILE="$1"
+    TARGET_FILE="$2"
+
+    HASH_FILE="$TEMP_DIR/$TARGET_FILE.sha256"
+
+    awk -v f="$TARGET_FILE" '
+      { name=$2; sub(/^\*/, "", name) }
+      name==f { print; found=1 }
+      END { exit !found }
+    ' "$CHECKSUM_FILE" > "$HASH_FILE" || return 1
 
-    # Try sha256sum (Linux) first, then shasum (macOS)
     if command -v sha256sum >/dev/null 2>&1; then
-        sha256sum -c --ignore-missing "$CHECKSUM_FILE" >/dev/null 2>&1
+        sha256sum -c "$HASH_FILE" >/dev/null 2>&1
     elif command -v shasum >/dev/null 2>&1; then
-        shasum -a 256 -c --ignore-missing "$CHECKSUM_FILE" >/dev/null 2>&1
+        shasum -a 256 -c "$HASH_FILE" >/dev/null 2>&1
     else
         printf "Warning: No checksum verification tool found, skipping verification\n" >&2
         return 0
@@ -94,7 +110,7 @@ download_and_verify() {
 
     # Verify checksum
     cd "$TEMP_DIR"
-    if ! verify_checksum "fostrom-device-agent.sha256"; then
+    if ! verify_checksum "fostrom-device-agent.sha256" "$FILENAME"; then
         die "Checksum verification failed"
     fi
     cd - >/dev/null
@@ -131,13 +147,13 @@ main() {
             case "$ARCH" in
                 x86_64|amd64)  ARCH="amd64" ;;
                 aarch64|arm64) ARCH="arm64" ;;
-                armv6l)        ARCH="armv6" ;;
+                armv6l)        ARCH="armv6hf" ;;
                 riscv64)       ARCH="riscv64" ;;
                 *)             die "Unsupported architecture: $ARCH" ;;
             esac
             ;;
         Darwin*)
-            OS="apple"
+            OS="macos"
             case "$ARCH" in
                 x86_64|amd64)  ARCH="amd64" ;;
                 aarch64|arm64) ARCH="arm64" ;;
@@ -159,7 +175,7 @@ main() {
     download_and_verify "$FILENAME" "$LOCATION"
 
     # Remove quarantine on macOS
-    if [ "$OS" = "apple" ]; then
+    if [ "$OS" = "macos" ]; then
         xattr -r -d com.apple.quarantine "$LOCATION/$FILENAME" 2>/dev/null || true
     fi
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fostrom",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "description": "Fostrom's Official Device SDK for JS. Fostrom (https://fostrom.io) is an IoT Cloud Platform.",
   "keywords": [
     "fostrom",
@@ -17,7 +17,7 @@
     "hardware",
     "raspberry"
   ],
-  "homepage": "https://docs.fostrom.io/sdk/js",
+  "homepage": "https://fostrom.io/docs/sdk/js",
   "license": "Apache-2.0",
   "author": "Fostrom <support@fostrom.io> (https://fostrom.io)",
   "files": [