@totemsdk/edge-coap 0.1.0 → 0.3.0

package/dist/sensor-bridge.js

@@ -1,46 +1,95 @@
-"use strict";
 /**
- * CoAP Sensor Bridge — maps CoAP resource observations to Edge proof inputs.
+ * CoAP Sensor Bridge — maps CoAP resources and RFC 7641 observations to Edge
+ * proof inputs. CBOR payloads (content-format 60) are decoded into structured
+ * claims; malformed CBOR is not signed as sensor data.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createCoapSensorBridge = createCoapSensorBridge;
-function createCoapSensorBridge(config) {
+import { decodeCbor } from './cbor.js';
+export const APPLICATION_CBOR = 60;
+export function createCoapSensorBridge(config) {
     const timers = [];
+    const observations = [];
     let running = false;
+    function claimsFor(binding, data, receivedAt = Date.now()) {
+        const claim = {
+            sensorId: binding.sensorId,
+            path: binding.path.join('/'),
+            dataType: binding.dataType ?? 'coap-observation',
+            payload: data.payload,
+            timestamp: receivedAt,
+        };
+        if (data.contentFormat !== undefined)
+            claim.contentFormat = data.contentFormat;
+        if (data.observe !== undefined)
+            claim.observe = data.observe;
+        if (data.contentFormat === APPLICATION_CBOR) {
+            try {
+                claim.cbor = decodeCbor(data.payload);
+            }
+            catch {
+                // Do not sign a payload that claims to be CBOR but does not decode.
+                return undefined;
+            }
+        }
+        return claim;
+    }
+    async function emitProof(binding, data, receivedAt) {
+        const proof = config.runtime.ports.proof;
+        if (!proof)
+            return;
+        const claim = claimsFor(binding, data, receivedAt);
+        if (!claim)
+            return;
+        await proof.createProof({ subject: `sensor:${binding.sensorId}`, claims: [claim] });
+    }
     async function pollBinding(binding) {
         try {
             const gw = config.gateway;
             if (!gw)
                 return;
             const result = await gw.get(binding.path, binding.host, binding.port);
-            if (result.ok && config.runtime.ports.proof) {
-                await config.runtime.ports.proof.createProof({
-                    subject: `sensor:${binding.sensorId}`,
-                    claims: [{
-                            sensorId: binding.sensorId,
-                            path: binding.path.join('/'),
-                            dataType: binding.dataType ?? 'coap-observation',
-                            payload: result.data?.payload,
-                            timestamp: Date.now(),
-                        }],
-                });
-            }
+            if (result.ok && result.data)
+                await emitProof(binding, result.data);
         }
         catch { /* non-fatal */ }
     }
+    async function observeBinding(binding) {
+        const gw = config.gateway;
+        if (!gw)
+            return false;
+        const result = await gw.observe(binding.path, binding.host, binding.port, (notification) => {
+            void emitProof(binding, notification, notification.receivedAt).catch(() => { });
+        });
+        if (!result.ok || !result.data)
+            return false;
+        observations.push(result.data);
+        return true;
+    }
     return {
         async start() {
             if (running)
                 return;
-            for (const b of config.bindings) {
-                await pollBinding(b);
-                timers.push(setInterval(() => pollBinding(b), b.intervalMs));
+            for (const binding of config.bindings) {
+                if (binding.observe) {
+                    const registered = await observeBinding(binding).catch(() => false);
+                    if (registered)
+                        continue;
+                }
+                await pollBinding(binding);
+                timers.push(setInterval(() => pollBinding(binding), binding.intervalMs));
             }
             running = true;
         },
-        async stop() { for (const t of timers)
-            clearInterval(t); timers.length = 0; running = false; },
-        async poll() { for (const b of config.bindings)
-            await pollBinding(b); },
+        async stop() {
+            for (const timer of timers)
+                clearInterval(timer);
+            timers.length = 0;
+            const active = observations.splice(0);
+            await Promise.all(active.map((observation) => observation.cancel().catch(() => { })));
+            running = false;
+        },
+        async poll() {
+            for (const binding of config.bindings)
+                await pollBinding(binding);
+        },
     };
 }

package/dist/transport.d.ts

@@ -21,7 +21,15 @@ export interface CoapTransportPort {
     onError(handler: (err: Error) => void): () => void;
 }
 export type CoapMessageType = 'CON' | 'NON' | 'ACK' | 'RST';
-export type CoapMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
+export type CoapMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'FETCH';
+export interface CoapBlockOption {
+    /** Block number. */
+    num: number;
+    /** More blocks follow. */
+    more: boolean;
+    /** Size exponent: block size is 2^(sizeExponent + 4), 16..1024 bytes. */
+    sizeExponent: number;
+}
 export interface CoapMessage {
     /** Message type. */
     type: CoapMessageType;
@@ -35,8 +43,30 @@ export interface CoapMessage {
     token: Uint8Array;
     /** URI path (e.g. ["sensors", "temperature"]). */
     path: string[];
+    /** Uri-Host option (3). Defaults to the destination address when absent. */
+    uriHost?: string;
+    /** Uri-Port option (7). Defaults to the destination port when absent. */
+    uriPort?: number;
+    /** Uri-Query options (15), in order. */
+    uriQuery?: string[];
     /** Payload bytes. */
     payload: Uint8Array;
+    /** Content-Format option (12), e.g. 0 text/plain, 60 application/cbor. */
+    contentFormat?: number;
+    /** Accept option (17). */
+    accept?: number;
+    /** Observe option (6): 0 register, 1 deregister, otherwise notification sequence. */
+    observe?: number;
+    /** OSCORE option (9) bytes, passed through without interpretation. */
+    oscore?: Uint8Array;
+    /** Block1 option (27) for blockwise requests. */
+    block1?: CoapBlockOption;
+    /** Block2 option (23) for blockwise responses. */
+    block2?: CoapBlockOption;
+    /** Size2 option (28): total response body size hint. */
+    size2?: number;
+    /** Size1 option (60): total request body size hint. */
+    size1?: number;
     /** Remote endpoint. */
     remote: {
         host: string;

package/dist/transport.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * CoAP transport port — injected by the caller.
  *
@@ -6,4 +5,4 @@
  * Messages are confirmable (CON), non-confirmable (NON),
  * acknowledgement (ACK), or reset (RST).
  */
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/package.json

@@ -1,43 +1,72 @@
 {
   "name": "@totemsdk/edge-coap",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Edge runtime adapter for CoAP — constrained devices, RFC 7252, UDP transport",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "types": "dist/cjs/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "require": "./dist/index.js",
-      "import": "./dist/index.js"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
     }
   },
-  "scripts": {
-    "build": "tsc",
-    "prepare": "tsc",
-    "clean": "rm -rf dist",
-    "test": "jest --passWithNoTests"
-  },
-  "files": ["dist", "README.md", "LICENSE"],
+  "files": [
+    "dist",
+    "sidecar.json",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
   "dependencies": {
-    "@totemsdk/edge": "^0.1.3"
+    "@totemsdk/edge": "^1.5.1"
   },
   "devDependencies": {
-    "@types/jest": "^30.0.0",
     "@types/node": "^20.0.0",
-    "jest": "^30.4.2",
-    "ts-jest": "^29.0.0",
     "typescript": "^7.0.2"
   },
-  "engines": { "node": ">=18.0.0" },
-  "publishConfig": { "access": "public" },
-  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "Apache-2.0",
   "author": "Totem SDK",
-  "homepage": "https://totem.ing",
+  "homepage": "https://docs.totem.ing",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/totem-sdk/totem-sdk.git",
-    "directory": "packages/totem-sdk/packages/edge-coap"
+    "url": "git+https://github.com/Totem-Edge/totem-sdk.git",
+    "directory": "packages/edge-coap"
+  },
+  "keywords": [
+    "totem",
+    "totemsdk",
+    "minima",
+    "blockchain",
+    "edge",
+    "coap",
+    "transport"
+  ],
+  "bugs": {
+    "url": "https://github.com/Totem-Edge/totem-sdk/issues"
   },
-  "keywords": ["totem", "totemsdk", "minima", "blockchain", "edge", "coap", "transport"],
-  "bugs": { "url": "https://github.com/totem-sdk/totem-sdk/issues" }
-}
+  "type": "module",
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.cjs.json && node -e \"require('fs').writeFileSync('dist/cjs/package.json', JSON.stringify({type:'commonjs'})+'\\n')\"",
+    "clean": "rm -rf dist bin",
+    "test": "jest --config ../../tests/jest/edge-coap.cjs",
+    "build:go": "cd go && go build -o ../bin/edge-coap .",
+    "test:go": "cd go && go test -race ./... && go vet ./...",
+    "test:conformance": "node --test ../../tests/qualification/edge-coap/coap-conformance.test.mjs",
+    "test:integration": "node --test ../../tests/qualification/edge-coap/integration.test.mjs",
+    "test:recovery": "node --test ../../tests/qualification/edge-coap/recovery.test.mjs",
+    "test:consumer": "node --test ../../tests/qualification/edge-coap/packed-consumer.test.mjs",
+    "test:oscore": "node --test ../../tests/qualification/edge-coap/oscore.test.mjs"
+  }
+}

package/sidecar.json

@@ -0,0 +1,34 @@
+{
+  "name": "edge-coap-sidecar",
+  "protocolVersion": 1,
+  "distribution": {
+    "mode": "source-build",
+    "bundledInNpmPackage": false,
+    "binary": "bin/edge-coap",
+    "build": "pnpm --filter @totemsdk/edge-coap build:go",
+    "autoDownload": false
+  },
+  "compatibility": {
+    "protocolMajor": 1,
+    "healthCheck": "edge-coap --version",
+    "rule": "Rebuild the sidecar from the matching package source. The npm package does not bundle platform binaries."
+  },
+  "configuration": {
+    "listen": "COAP_LISTEN_ADDR=127.0.0.1:15003",
+    "bindPort": "COAP_BIND_PORT=5683"
+  },
+  "qualified": [
+    "source build on the target platform",
+    "plaintext unicast CoAP request/response over UDP",
+    "CBOR payload pass-through with TypeScript content-format decoding",
+    "RFC 7641 observation registration, notifications and deregistration",
+    "OSCORE client and server contexts in the TypeScript layer (RFC 8613 Appendix C vectors)",
+    "RFC 7959 blockwise Block1 upload, Block1 size renegotiation and Block2 response assembly"
+  ],
+  "unqualified": [
+    "DTLS security (transport-owned)",
+    "blockwise observation notifications and multicast",
+    "OSCORE Class I options (none currently defined)",
+    "Windows prebuilt binaries"
+  ]
+}