@moddable/typings 9.5.0 → 10.0.0

package/web/websocket.d.ts

@@ -23,15 +23,15 @@ declare module "web/websocket" {
 
   interface WebSocketClientOptions {
     url: string;
-    protocol?: string;
+    protocol?: string | string[];
     keepalive?: number;
-    headers?: Headers | Record<string, string>;
+    headers?: Headers | Map<string, string>;
     ws?: any;
     wss?: any;
   }
 
   interface WebSocketAttachOptions {
-    attach: any;
+    attach: import("embedded:io/socket/tcp").default;
   }
 
   interface WebSocketCloseEvent {
@@ -55,7 +55,7 @@ declare module "web/websocket" {
   type WebSocketEventListener = (event: any) => void;
 
   class WebSocket {
-    constructor(url: string, protocol?: string);
+    constructor(url: string, protocols?: string | string[]);
     constructor(options: WebSocketClientOptions);
     constructor(options: WebSocketAttachOptions);
 
@@ -76,15 +76,15 @@ declare module "web/websocket" {
     readonly readyState: number;
     readonly url: string;
 
-    onclose?(event: WebSocketCloseEvent): void;
-    onerror?(event: WebSocketErrorEvent): void;
-    onmessage?(event: WebSocketMessageEvent): void;
-    onopen?(event: WebSocketEvent): void;
+    onclose: ((this: WebSocket, event: WebSocketCloseEvent) => void) | null;
+    onerror: ((this: WebSocket, event: WebSocketErrorEvent) => void) | null;
+    onmessage: ((this: WebSocket, event: WebSocketMessageEvent) => void) | null;
+    onopen: ((this: WebSocket, event: WebSocketEvent) => void) | null;
 
-    addEventListener(event: "close", listener: (event: WebSocketCloseEvent) => void): void;
-    addEventListener(event: "error", listener: (event: WebSocketErrorEvent) => void): void;
-    addEventListener(event: "message", listener: (event: WebSocketMessageEvent) => void): void;
-    addEventListener(event: "open", listener: (event: WebSocketEvent) => void): void;
+    addEventListener(event: "close", listener: (this: WebSocket, event: WebSocketCloseEvent) => void): void;
+    addEventListener(event: "error", listener: (this: WebSocket, event: WebSocketErrorEvent) => void): void;
+    addEventListener(event: "message", listener: (this: WebSocket, event: WebSocketMessageEvent) => void): void;
+    addEventListener(event: "open", listener: (this: WebSocket, event: WebSocketEvent) => void): void;
 
     removeEventListener(event: "close" | "error" | "message" | "open", listener: WebSocketEventListener): void;
 
@@ -93,4 +93,9 @@ declare module "web/websocket" {
   }
 
   export default WebSocket;
-}
+}
+
+// the specifier of the module in the Moddable SDK runtime
+declare module "WebSocket" {
+  export { default } from "web/websocket";
+}

package/web/webstorage.d.ts

@@ -18,6 +18,9 @@
 *
 */
 
+// the manifest that supplies this module includes the manifests of these configurations
+/// <reference path="../config/storage.d.ts" />
+
 declare module "webstorage" {
   class WebStorage {
     constructor(kvp: any);

package/web/worker.d.ts

@@ -37,6 +37,8 @@ declare module "worker" {
 			symbol?: number;
 		};
 		nativeStack?: number;
+		core?: number;
+		priority?: number;
 	}
 
 	interface MessagePort {

package/websocket.d.ts

@@ -28,6 +28,7 @@ declare module "websocket" {
   }
   export type WebSocketClientCallback = (message: number, value?: any) => void;
 
+  /** @deprecated Use WebSocket, or the ECMA-419 embedded:network/websocket/client and the embedded:network/http/server/route/ws/handshake route */
   export class Client {
     static readonly connect: number;
     static readonly handshake: number;
@@ -43,6 +44,7 @@ declare module "websocket" {
   export type WebSocketServerOptions = ListenerOptions
   export type WebSocketServerCallback = (message: number, value?: any) => void;
 
+  /** @deprecated Use WebSocket, or the ECMA-419 embedded:network/websocket/client and the embedded:network/http/server/route/ws/handshake route */
   export class Server {
     static readonly connect: number;
     static readonly handshake: number;

package/wifi.d.ts

@@ -42,6 +42,7 @@ declare module "wifi" {
     max?: number
   }
 
+  /** @deprecated Use the ECMA-419 Wi-Fi network interface, embedded:network/interface/wifi */
   class WiFi {
     static readonly gotIP: "gotIP";
     static readonly lostIP: "lostIP";

package/xs.d.ts

@@ -19,7 +19,7 @@
  */
 
  interface Trace {
-	(...log: (string | number | boolean)[]):void;
+	(...log: unknown[]):void;
 	left(log: string | ArrayBufferLike, conversation?: string):void;
 	center(log: string | ArrayBufferLike, conversation?: string):void;
 	right(log: string | ArrayBufferLike, conversation?: string):void;
@@ -53,7 +53,7 @@ interface JSON {
 }
 
 interface StringConstructor {
-	fromArrayBuffer(buffer: ArrayBufferLike): string;
+	fromArrayBuffer(buffer: ArrayBufferLike, byteOffset?: number, byteLength?: number): string;
 }
 
 interface ArrayBufferConstructor {
@@ -63,17 +63,26 @@ interface ArrayBufferConstructor {
 
 interface ArrayBuffer {
 	concat(...buffers: ArrayBufferLike[]): ArrayBuffer;
+
+	// immutable ArrayBuffers (not yet in every XS deployment: only where mxImmutableArrayBuffers is enabled)
+	readonly immutable: boolean;
+	sliceToImmutable(start?: number, end?: number): ArrayBuffer;
+	transferToImmutable(newByteLength?: number): ArrayBuffer;
+}
+
+interface ToBase64Options {
+	alphabet?: "base64url" | "base64";
+	omitPadding?: boolean;
 }
 
 interface Uint8Array {
 	toHex(): string;
-	toBase64(): string
+	toBase64(options?: ToBase64Options): string
 }
 
 interface FromBase64Options {
 	alphabet?: "base64url" | "base64";
 	lastChunkHandling?: "stop-before-partial" | "strict" | "loose";
-	omitPadding?: boolean;
 }
 
 interface Uint8ArrayConstructor {
@@ -101,4 +110,42 @@ interface Math {
 declare function Native(name: string): new (...args: any[]) => any;
 declare function native(name: string): (...args: any[]) => any;
 
-// Compartment?
+
+/*
+	Compartment (see documentation/xs/XS Compartment.md)
+*/
+interface ModuleDescriptor {
+	source?: string | ModuleSource | object;
+	importMeta?: object;
+	specifier?: string;
+	namespace?: string | object;
+	compartment?: Compartment;
+	archive?: object;
+	path?: string;
+}
+interface CompartmentOptions {
+	globals?: object;
+	globalLexicals?: object;
+	modules?: Record<string, ModuleDescriptor>;
+	loadHook?: (specifier: string) => Promise<ModuleDescriptor>;
+	loadNowHook?: (specifier: string) => ModuleDescriptor;
+	resolveHook?: (importSpecifier: string, referrerSpecifier: string) => string;
+}
+declare class Compartment {
+	constructor(options?: CompartmentOptions);
+	readonly globalThis: Record<PropertyKey, any>;
+	evaluate(script: string): any;
+	import(specifier: string): Promise<any>;
+	importNow(specifier: string): any;
+}
+declare class ModuleSource {
+	constructor(source: string);
+	readonly bindings: object[];
+	readonly needsImport: boolean;
+	readonly needsImportMeta: boolean;
+}
+
+/*
+	abort hook: when a function, XS calls it before aborting. Returning false ignores the abort.
+*/
+declare var abort: ((message: string, exception?: any) => boolean | void) | undefined;

package/data/location/nmea.d.ts

@@ -1,103 +0,0 @@
-/*
-* Copyright (c) 2026 Moddable Tech, Inc.
-*
-*   This file is part of the Moddable SDK Tools.
-*
-*   The Moddable SDK Tools is free software: you can redistribute it and/or modify
-*   it under the terms of the GNU General Public License as published by
-*   the Free Software Foundation, either version 3 of the License, or
-*   (at your option) any later version.
-*
-*   The Moddable SDK Tools is distributed in the hope that it will be useful,
-*   but WITHOUT ANY WARRANTY; without even the implied warranty of
-*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-*   GNU General Public License for more details.
-*
-*   You should have received a copy of the GNU General Public License
-*   along with the Moddable SDK Tools.  If not, see <http://www.gnu.org/licenses/>.
-*
-*/
-
-declare module "data/location/nmea" {
-  interface NMEATalker {
-    readonly GP: "GPS";
-    readonly GN: "GNSS";
-    readonly GL: "GLONASS";
-    readonly GA: "Galileo";
-    readonly GB: "BeiDou";
-    readonly BD: "BeiDou";
-    readonly QZ: "QZSS";
-    readonly P: "Proprietary";
-    readonly [id: string]: string | undefined;
-  }
-
-  interface NMEASatellite {
-    prn: number;
-    elevation: number | null;
-    azimuth: number | null;
-    snr: number | null;
-  }
-
-  interface NMEASentence {
-    type: string;
-    talker: string;
-    system: string;
-    raw: string;
-    time?: string | null;
-    date?: string | null;
-    latitude?: number | null;
-    longitude?: number | null;
-    altitude?: number | null;
-    geoidSeparation?: number | null;
-    quality?: number;
-    satellites?: number | NMEASatellite[];
-    hdop?: number | null;
-    pdop?: number | null;
-    vdop?: number | null;
-    speed?: number | null;
-    course?: number | null;
-    status?: string | null;
-    mode?: string | null;
-    fix?: boolean;
-    fixType?: number;
-    satellitesUsed?: number[];
-    totalMessages?: number;
-    messageNumber?: number;
-    satellitesInView?: number;
-    day?: number | null;
-    month?: number | null;
-    year?: number | null;
-    fields?: string[];
-    [key: string]: unknown;
-  }
-
-  interface NMEALocationUpdate {
-    latitude?: number;
-    longitude?: number;
-    altitude?: number;
-    accuracy?: number;
-    heading?: number;
-    speed?: number;
-    fix?: boolean;
-  }
-
-  class NMEA {
-    constructor(onParsed?: (parsed: NMEASentence) => void);
-    push(data: number | ArrayBuffer | ArrayBufferView): NMEASentence | undefined;
-
-    static readonly Talker: NMEATalker;
-    static readonly identification: {
-      readonly model: string;
-      readonly classification: string;
-      readonly description: string;
-    };
-    static parse(sentence: string | ArrayBuffer | ArrayBufferView): NMEASentence | null;
-    static validateChecksum(sentence: string | ArrayBuffer | ArrayBufferView): Uint8Array | null;
-    static toDecimalDegrees(value: string, hemi: string): number | null;
-    static checksum(payload: string): string;
-    static format(payload: string): string;
-    static location(parsed: NMEASentence | null | undefined): NMEALocationUpdate | undefined;
-  }
-
-  export { NMEA as default, NMEA };
-}

package/data/location/ubx.d.ts

@@ -1,78 +0,0 @@
-/*
-* Copyright (c) 2026 Moddable Tech, Inc.
-*
-*   This file is part of the Moddable SDK Tools.
-*
-*   The Moddable SDK Tools is free software: you can redistribute it and/or modify
-*   it under the terms of the GNU General Public License as published by
-*   the Free Software Foundation, either version 3 of the License, or
-*   (at your option) any later version.
-*
-*   The Moddable SDK Tools is distributed in the hope that it will be useful,
-*   but WITHOUT ANY WARRANTY; without even the implied warranty of
-*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-*   GNU General Public License for more details.
-*
-*   You should have received a copy of the GNU General Public License
-*   along with the Moddable SDK Tools.  If not, see <http://www.gnu.org/licenses/>.
-*
-*/
-
-declare module "data/location/ubx" {
-  interface UBXMessage {
-    type: string;
-    class?: number;
-    id?: number;
-    payloadLength?: number;
-    latitude?: number;
-    longitude?: number;
-    altitude?: number;
-    accuracy?: number;
-    altitudeAccuracy?: number;
-    speed?: number;
-    course?: number;
-    pdop?: number;
-    satellites?: number;
-    fixType?: number;
-    fix?: boolean;
-    status?: string;
-    quality?: number;
-    [key: string]: unknown;
-  }
-
-  interface UBXLocationUpdate {
-    latitude?: number;
-    longitude?: number;
-    altitude?: number;
-    accuracy?: number;
-    altitudeAccuracy?: number;
-    heading?: number;
-    speed?: number;
-    fix: boolean;
-  }
-
-  class UBX {
-    constructor(onParsed?: (parsed: UBXMessage) => void);
-    push(data: number | ArrayBuffer | ArrayBufferView): UBXMessage | undefined;
-
-    static readonly SYNC1: 0xb5;
-    static readonly SYNC2: 0x62;
-    static readonly CLASS_NAV: 0x01;
-    static readonly ID_NAV_PVT: 0x07;
-    static readonly CLASS_CFG: 0x06;
-    static readonly ID_CFG_MSG: 0x01;
-    static readonly identification: {
-      readonly model: string;
-      readonly classification: string;
-      readonly description: string;
-    };
-    static checksum(bytes: Uint8Array, offset: number, length: number): [number, number];
-    static format(msgClass: number, msgId: number, payload?: ArrayBuffer | ArrayBufferView): ArrayBuffer;
-    static parse(frame: ArrayBuffer | ArrayBufferView): UBXMessage | null;
-    static parseNAVPVT(view: DataView): UBXMessage | null;
-    static location(parsed: UBXMessage | null | undefined): UBXLocationUpdate | undefined;
-    static setup(): ArrayBuffer[];
-  }
-
-  export { UBX as default, UBX };
-}

package/display.d.ts

@@ -1,68 +0,0 @@
-/*
- * Copyright (c) 2025  Moddable Tech, Inc.
- *
- *   This file is part of the Moddable SDK Runtime.
- *
- *   The Moddable SDK Runtime is free software: you can redistribute it and/or modify
- *   it under the terms of the GNU Lesser General Public License as published by
- *   the Free Software Foundation, either version 3 of the License, or
- *   (at your option) any later version.
- *
- *   The Moddable SDK Runtime is distributed in the hope that it will be useful,
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *   GNU Lesser General Public License for more details.
- *
- *   You should have received a copy of the GNU Lesser General Public License
- *   along with the Moddable SDK Runtime.  If not, see <http://www.gnu.org/licenses/>.
- *
- */
-
-declare module "embedded:display" {
-	export interface DisplayConstructorOptions {
-		format?: number;
-		rotation?: number;
-		brightness?: number;
-		flip?: "h" | "v" | "hv";
-	}
-
-	export interface DisplayConfigureOptions {
-		brightness?: number;
-		format?: number;
-		rotation?: number;
-	}
-
-	export interface DisplayConfiguration {
-		brightness?: number;
-		format?: number;
-		rotation?: number;
-	}
-
-	export interface DisplayBeginOptions {
-		x: number;
-		y: number;
-		width: number;
-		height: number;
-		continue?: boolean;
-	}
-
-	export interface DisplayRectangle {
-		x: number;
-		y: number;
-		width: number;
-		height: number;
-	}
-
-	export default class Display {
-		constructor(options: DisplayConstructorOptions);
-		close(): void;
-		configure(options: DisplayConfigureOptions): void;
-		get configuration(): DisplayConfiguration;
-		begin(options?: DisplayBeginOptions): void;
-		send(buffer: ByteBuffer): void;
-		end(): void;
-		adapInvalid(options: DisplayRectangle): void;
-		get width(): number;
-		get height(): number;
-	}
-}

package/embedded/sensor/Barometer-Humidity-Temperature/BME280.d.ts

@@ -1,102 +0,0 @@
-/*
-* Copyright (c) 2026 Moddable Tech, Inc.
-*
-*   This file is part of the Moddable SDK Tools.
-*
-*   The Moddable SDK Tools is free software: you can redistribute it and/or modify
-*   it under the terms of the GNU General Public License as published by
-*   the Free Software Foundation, either version 3 of the License, or
-*   (at your option) any later version.
-*
-*   The Moddable SDK Tools is distributed in the hope that it will be useful,
-*   but WITHOUT ANY WARRANTY; without even the implied warranty of
-*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-*   GNU General Public License for more details.
-*
-*   You should have received a copy of the GNU General Public License
-*   along with the Moddable SDK Tools.  If not, see <http://www.gnu.org/licenses/>.
-*
-*/
-
-declare module "embedded:sensor/Barometer-Humidity-Temperature/BME280" {
-  interface BME280IO {
-    write(buffer: ArrayBuffer | ArrayBufferView, stop?: boolean): void;
-    read(buffer: ArrayBuffer | ArrayBufferView): void;
-    close(): void;
-  }
-
-  interface BME280SensorOptions {
-    io: new (options: object) => BME280IO;
-    address?: number;
-    hz?: number;
-    data?: number | string;
-    clock?: number | string;
-    [key: string]: unknown;
-  }
-
-  interface BME280Options {
-    sensor: BME280SensorOptions;
-    target?: unknown;
-  }
-
-  interface BME280Configuration {
-    mode?: number;
-    temperatureSampling?: number;
-    pressureSampling?: number;
-    humiditySampling?: number;
-    filter?: number;
-    standbyDuration?: number;
-  }
-
-  interface BME280Sample {
-    thermometer: { temperature: number };
-    hygrometer: { humidity?: number };
-    barometer: { pressure: number };
-  }
-
-  interface BME280ConfigConstants {
-    readonly Sampling: {
-      readonly SKIPPED: 0x00;
-      readonly X1: 0x01;
-      readonly X2: 0x02;
-      readonly X4: 0x03;
-      readonly X8: 0x04;
-      readonly X16: 0x05;
-    };
-    readonly Filter: {
-      readonly OFF: 0x00;
-      readonly X2: 0x01;
-      readonly X4: 0x02;
-      readonly X8: 0x03;
-      readonly X16: 0x04;
-    };
-    readonly Mode: {
-      readonly SLEEP: 0x00;
-      readonly FORCED: 0x01;
-      readonly NORMAL: 0x03;
-    };
-    readonly Standby: {
-      readonly MS_0_5: 0x00;
-      readonly MS_62_5: 0x01;
-      readonly MS_125: 0x02;
-      readonly MS_250: 0x03;
-      readonly MS_500: 0x04;
-      readonly MS_1000: 0x05;
-      readonly MS_10: 0x06;
-      readonly MS_20: 0x07;
-    };
-  }
-
-  class BME280 {
-    constructor(options: BME280Options);
-    configure(options: BME280Configuration): void;
-    sample(): BME280Sample;
-    close(): void;
-    target?: unknown;
-  }
-  interface BME280 extends Disposable {}
-
-  const Config: BME280ConfigConstants;
-
-  export { BME280 as default, BME280, Config };
-}

package/embedded/sensor/Location/GPS.d.ts

@@ -1,96 +0,0 @@
-/*
-* Copyright (c) 2026 Moddable Tech, Inc.
-*
-*   This file is part of the Moddable SDK Tools.
-*
-*   The Moddable SDK Tools is free software: you can redistribute it and/or modify
-*   it under the terms of the GNU General Public License as published by
-*   the Free Software Foundation, either version 3 of the License, or
-*   (at your option) any later version.
-*
-*   The Moddable SDK Tools is distributed in the hope that it will be useful,
-*   but WITHOUT ANY WARRANTY; without even the implied warranty of
-*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-*   GNU General Public License for more details.
-*
-*   You should have received a copy of the GNU General Public License
-*   along with the Moddable SDK Tools.  If not, see <http://www.gnu.org/licenses/>.
-*
-*/
-
-declare module "embedded:sensor/Location/GPS" {
-  interface GPSSensorIO {
-    write(value: ByteBuffer, stop?: boolean): void;
-    writeRead?(writeBuffer: ByteBuffer, readByteLength: number, stop?: boolean): ArrayBuffer;
-    read?(byteLength?: number): number | ArrayBuffer | undefined;
-    close(): void;
-  }
-
-  interface GPSSensorOptions {
-    io: new (options: object) => GPSSensorIO;
-    address?: number;
-    hz?: number;
-    data?: number | string;
-    clock?: number | string;
-    receive?: number | string;
-    transmit?: number | string;
-    baud?: number;
-    port?: number | string;
-    [key: string]: unknown;
-  }
-
-  interface GPSProtocol {
-    new (onParsed?: (parsed: object) => void): {
-      push(data: number | ArrayBuffer | ArrayBufferView): object | undefined;
-    };
-    location(parsed: object | null | undefined): object | undefined;
-    identification: {
-      model: string;
-      classification: string;
-      description: string;
-    };
-    setup?(): ArrayBuffer[];
-  }
-
-  interface GPSOptions {
-    sensor: GPSSensorOptions;
-    protocol: GPSProtocol;
-    onSample?: (this: GPS) => void;
-    onError?: (this: GPS, error: Error) => void;
-    target?: unknown;
-  }
-
-  /** enableHighAccuracy is accepted for Location API alignment; currently a no-op. */
-  interface GPSConfiguration {
-    enableHighAccuracy?: boolean;
-    timeout?: number;
-    maximumAge?: number;
-  }
-
-  interface GPSSample {
-    latitude: number;
-    longitude: number;
-    altitude?: number;
-    accuracy?: number;
-    altitudeAccuracy?: number;
-    heading?: number;
-    speed?: number;
-    timestamp?: number;
-  }
-
-  class GPS {
-    constructor(options: GPSOptions);
-    configure(options: GPSConfiguration): void;
-    sample(): GPSSample | undefined;
-    close(): void;
-    readonly identification: {
-      model: string;
-      classification: string;
-      description: string;
-    };
-    target?: unknown;
-  }
-  interface GPS extends Disposable {}
-
-  export { GPS as default, GPS };
-}