@soapbox.pub/nostr-lora 0.1.0

package/dist/react.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.js","sources":["../lib/use-lora-transport.ts"],"sourcesContent":["import { useState, useCallback, useRef, useEffect } from 'react';\nimport { SerialConnectionManager } from './serial-connection.js';\nimport { LoRaTransport } from './lora-transport.js';\nimport type { TransportOptions, PacketReceiveInfo } from './lora-transport.js';\nimport type { NostrEvent } from './event-codec.js';\nimport type { QueueSnapshot } from './send-queue.js';\n\nexport interface UseNostrLoraOptions extends TransportOptions {\n    /** Called when a Nostr event is received over LoRa. */\n    onEvent?: (event: NostrEvent) => void;\n}\n\nexport interface UseNostrLoraReturn {\n    // ── State ─────────────────────────────────────────────────────────────────\n    isConnected: boolean;\n    connecting:  boolean;\n    error:       Error | null;\n    portLabel:   string | null;\n    deviceName:  string | null;\n    sendQueue:   QueueSnapshot[];\n    lastPacket:  PacketReceiveInfo | null;\n\n    // ── Actions ───────────────────────────────────────────────────────────────\n    /** Open the serial port (triggers browser port picker) and begin transport. */\n    connect(): Promise<void>;\n    /** Close the connection. */\n    disconnect(): Promise<void>;\n    /** Send a fully-signed Nostr event over LoRa. */\n    sendEvent(event: NostrEvent): Promise<void>;\n    /** Manually broadcast a GM announcement (advanced). */\n    sendGm(nodeId: Uint8Array, eventCount?: number, recentSince?: number): Promise<void>;\n    /** Live-update the inter-packet timing without reconnecting. */\n    setTimingOptions(opts: { delay?: number; jitter?: number }): void;\n\n    // ── Refs ──────────────────────────────────────────────────────────────────\n    /** Direct access to the underlying `LoRaTransport` for attaching custom listeners. */\n    transport: LoRaTransport | null;\n}\n\nexport function useNostrLora(options: UseNostrLoraOptions = {}): UseNostrLoraReturn {\n    const [isConnected, setIsConnected] = useState(false);\n    const [connecting,  setConnecting]  = useState(false);\n    const [error,       setError]       = useState<Error | null>(null);\n    const [portLabel,   setPortLabel]   = useState<string | null>(null);\n    const [deviceName,  setDeviceName]  = useState<string | null>(null);\n    const [sendQueue,   setSendQueue]   = useState<QueueSnapshot[]>([]);\n    const [lastPacket,  setLastPacket]  = useState<PacketReceiveInfo | null>(null);\n\n    const connectionRef = useRef<SerialConnectionManager | null>(null);\n    const transportRef  = useRef<LoRaTransport | null>(null);\n\n    // Stable ref to options so callbacks don't go stale\n    const optionsRef = useRef(options);\n    useEffect(() => { optionsRef.current = options; }, [options]);\n\n    const connect = useCallback(async () => {\n        setConnecting(true);\n        setError(null);\n        try {\n            const cm = new SerialConnectionManager(optionsRef.current.logger);\n            connectionRef.current = cm;\n\n            cm.on('deviceInfo', (info) => setDeviceName(info.name));\n\n            const { onEvent, ...transportOptions } = optionsRef.current;\n            const transport = new LoRaTransport(cm, transportOptions);\n            transportRef.current = transport;\n\n            transport.on('connect',       (label) => { setIsConnected(true); setPortLabel(label); });\n            transport.on('disconnect',    ()      => { setIsConnected(false); setPortLabel(null); });\n            transport.on('error',         (err)   => setError(err));\n            transport.on('queue:update',  (q)     => setSendQueue(q));\n            transport.on('packet:receive',(info)  => setLastPacket(info));\n            if (onEvent) transport.on('event:receive', onEvent);\n\n            await transport.begin();\n        } catch (err) {\n            const e = err instanceof Error ? err : new Error(String(err));\n            setError(e);\n            setConnecting(false);\n        } finally {\n            setConnecting(false);\n        }\n    }, []);\n\n    const disconnect = useCallback(async () => {\n        await transportRef.current?.end();\n        transportRef.current  = null;\n        connectionRef.current = null;\n    }, []);\n\n    const sendEvent = useCallback(async (event: NostrEvent) => {\n        if (!transportRef.current) throw new Error('Not connected');\n        await transportRef.current.sendEvent(event);\n    }, []);\n\n    const sendGm = useCallback(async (nodeId: Uint8Array, eventCount?: number, recentSince?: number) => {\n        if (!transportRef.current) throw new Error('Not connected');\n        await transportRef.current.sendGm(nodeId, eventCount, recentSince);\n    }, []);\n\n    const setTimingOptions = useCallback((opts: { delay?: number; jitter?: number }) => {\n        transportRef.current?.setTimingOptions(opts);\n    }, []);\n\n    return {\n        isConnected,\n        connecting,\n        error,\n        portLabel,\n        deviceName,\n        sendQueue,\n        lastPacket,\n        connect,\n        disconnect,\n        sendEvent,\n        sendGm,\n        setTimingOptions,\n        transport: transportRef.current,\n    };\n}"],"names":["useNostrLora","options","isConnected","setIsConnected","useState","connecting","setConnecting","error","setError","portLabel","setPortLabel","deviceName","setDeviceName","sendQueue","setSendQueue","lastPacket","setLastPacket","connectionRef","useRef","transportRef","optionsRef","useEffect","connect","useCallback","cm","SerialConnectionManager","info","onEvent","transportOptions","transport","LoRaTransport","label","err","q","e","disconnect","_a","sendEvent","event","sendGm","nodeId","eventCount","recentSince","setTimingOptions","opts"],"mappings":";;AAuCO,SAASA,EAAaC,IAA+B,IAAwB;AAChF,QAAM,CAACC,GAAaC,CAAc,IAAIC,EAAS,EAAK,GAC9C,CAACC,GAAaC,CAAa,IAAKF,EAAS,EAAK,GAC9C,CAACG,GAAaC,CAAQ,IAAUJ,EAAuB,IAAI,GAC3D,CAACK,GAAaC,CAAY,IAAMN,EAAwB,IAAI,GAC5D,CAACO,GAAaC,CAAa,IAAKR,EAAwB,IAAI,GAC5D,CAACS,GAAaC,CAAY,IAAMV,EAA0B,CAAA,CAAE,GAC5D,CAACW,GAAaC,CAAa,IAAKZ,EAAmC,IAAI,GAEvEa,IAAgBC,EAAuC,IAAI,GAC3DC,IAAgBD,EAA6B,IAAI,GAGjDE,IAAaF,EAAOjB,CAAO;AACjC,EAAAoB,EAAU,MAAM;AAAE,IAAAD,EAAW,UAAUnB;AAAA,EAAS,GAAG,CAACA,CAAO,CAAC;AAE5D,QAAMqB,IAAUC,EAAY,YAAY;AACpC,IAAAjB,EAAc,EAAI,GAClBE,EAAS,IAAI;AACb,QAAI;AACA,YAAMgB,IAAK,IAAIC,EAAwBL,EAAW,QAAQ,MAAM;AAChE,MAAAH,EAAc,UAAUO,GAExBA,EAAG,GAAG,cAAc,CAACE,MAASd,EAAcc,EAAK,IAAI,CAAC;AAEtD,YAAM,EAAE,SAAAC,GAAS,GAAGC,EAAA,IAAqBR,EAAW,SAC9CS,IAAY,IAAIC,EAAcN,GAAII,CAAgB;AACxD,MAAAT,EAAa,UAAUU,GAEvBA,EAAU,GAAG,WAAiB,CAACE,MAAU;AAAE,QAAA5B,EAAe,EAAI,GAAGO,EAAaqB,CAAK;AAAA,MAAG,CAAC,GACvFF,EAAU,GAAG,cAAiB,MAAW;AAAE,QAAA1B,EAAe,EAAK,GAAGO,EAAa,IAAI;AAAA,MAAG,CAAC,GACvFmB,EAAU,GAAG,SAAiB,CAACG,MAAUxB,EAASwB,CAAG,CAAC,GACtDH,EAAU,GAAG,gBAAiB,CAACI,MAAUnB,EAAamB,CAAC,CAAC,GACxDJ,EAAU,GAAG,kBAAiB,CAACH,MAAUV,EAAcU,CAAI,CAAC,GACxDC,KAASE,EAAU,GAAG,iBAAiBF,CAAO,GAElD,MAAME,EAAU,MAAA;AAAA,IACpB,SAASG,GAAK;AACV,YAAME,IAAIF,aAAe,QAAQA,IAAM,IAAI,MAAM,OAAOA,CAAG,CAAC;AAC5D,MAAAxB,EAAS0B,CAAC,GACV5B,EAAc,EAAK;AAAA,IACvB,UAAA;AACI,MAAAA,EAAc,EAAK;AAAA,IACvB;AAAA,EACJ,GAAG,CAAA,CAAE,GAEC6B,IAAaZ,EAAY,YAAY;;AACvC,YAAMa,IAAAjB,EAAa,YAAb,gBAAAiB,EAAsB,QAC5BjB,EAAa,UAAW,MACxBF,EAAc,UAAU;AAAA,EAC5B,GAAG,CAAA,CAAE,GAECoB,IAAYd,EAAY,OAAOe,MAAsB;AACvD,QAAI,CAACnB,EAAa,QAAS,OAAM,IAAI,MAAM,eAAe;AAC1D,UAAMA,EAAa,QAAQ,UAAUmB,CAAK;AAAA,EAC9C,GAAG,CAAA,CAAE,GAECC,IAAShB,EAAY,OAAOiB,GAAoBC,GAAqBC,MAAyB;AAChG,QAAI,CAACvB,EAAa,QAAS,OAAM,IAAI,MAAM,eAAe;AAC1D,UAAMA,EAAa,QAAQ,OAAOqB,GAAQC,GAAYC,CAAW;AAAA,EACrE,GAAG,CAAA,CAAE,GAECC,IAAmBpB,EAAY,CAACqB,MAA8C;;AAChF,KAAAR,IAAAjB,EAAa,YAAb,QAAAiB,EAAsB,iBAAiBQ;AAAA,EAC3C,GAAG,CAAA,CAAE;AAEL,SAAO;AAAA,IACH,aAAA1C;AAAA,IACA,YAAAG;AAAA,IACA,OAAAE;AAAA,IACA,WAAAE;AAAA,IACA,YAAAE;AAAA,IACA,WAAAE;AAAA,IACA,YAAAE;AAAA,IACA,SAAAO;AAAA,IACA,YAAAa;AAAA,IACA,WAAAE;AAAA,IACA,QAAAE;AAAA,IACA,kBAAAI;AAAA,IACA,WAAWxB,EAAa;AAAA,EAAA;AAEhC;"}

package/dist/send-queue.d.ts

@@ -0,0 +1,40 @@
+import { EventEmitter, Logger } from './utils.js';
+import { DefaultOptions } from './constants.js';
+export interface QueueItemMeta {
+    _onSent?: () => Promise<void>;
+}
+export interface QueueItem {
+    id: number;
+    label: string;
+    type: string;
+    packets: Uint8Array[];
+    meta: QueueItemMeta;
+    status: "pending" | "sending";
+}
+export interface QueueSnapshot {
+    id: number;
+    label: string;
+    type: string;
+    packetCount: number;
+    status: "pending" | "sending";
+}
+export type SendQueueEvents = {
+    "packet:send": [packet: Uint8Array, item: QueueItem];
+    "queue:update": [snapshot: QueueSnapshot[]];
+    "error": [err: Error];
+};
+export declare class SendQueue extends EventEmitter<SendQueueEvents> {
+    private sendFn;
+    private items;
+    private running;
+    private seq;
+    private log;
+    INTER_PACKET_DELAY: number;
+    INTER_PACKET_JITTER: number;
+    constructor(sendFn: (packet: Uint8Array) => Promise<void>, options?: Partial<Pick<DefaultOptions, "INTER_PACKET_DELAY" | "INTER_PACKET_JITTER">>, logger?: Logger | null);
+    enqueue(packets: Uint8Array[], label: string, type: string, meta?: QueueItemMeta): number;
+    get snapshot(): QueueSnapshot[];
+    private notifyUpdate;
+    private drain;
+    private run;
+}

package/dist/serial-connection.d.ts

@@ -0,0 +1,41 @@
+import { EventEmitter, Logger } from './utils.js';
+import { ConnectionManager, ConnectionManagerEvents } from './connection-manager.js';
+export interface DeviceInfo {
+    name: string;
+    firmwareVersion: string;
+}
+export interface RadioConfig {
+    frequency: number;
+    bandwidth: number;
+    spreadingFactor: number;
+    codingRate: number;
+    power?: number;
+}
+/**
+ * Web Serial connection to a MeshCore LoRa device.
+ * Implements `ConnectionManager` so it can be passed directly to `LoRaTransport`.
+ *
+ * Key constraint: WebSerialConnection.write() has no internal queue — it calls
+ * getWriter()/releaseLock() per write. Two overlapping writes crash with
+ * "WritableStream is already locked". We must never issue a write while another
+ * is in flight. `LoRaTransport`'s `SendQueue` ensures this.
+ */
+export declare class SerialConnectionManager extends EventEmitter<ConnectionManagerEvents & {
+    "deviceInfo": [info: DeviceInfo];
+}> implements ConnectionManager {
+    private connection;
+    private label;
+    private log;
+    constructor(logger?: Logger | null);
+    open(): Promise<void>;
+    close(): Promise<void>;
+    sendRawData(data: Uint8Array): Promise<void>;
+    /** Configure the LoRa radio parameters. Must be called after `open()`. */
+    setRadioConfig(config: RadioConfig): Promise<void>;
+    isConnected(): boolean;
+    isWebSerialSupported(): boolean;
+    /** The USB VID:PID or "Serial device" label for the connected port. */
+    get portLabel(): string | null;
+    private buildPortLabel;
+    private setupHandlers;
+}