@moddable/typings 9.5.0 → 10.0.0

package/config/mqtt.d.ts

@@ -0,0 +1,27 @@
+/*
+* 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:provider/builtin" {
+	import type { MQTTClientProvider } from "embedded:network/mqtt/client";
+
+	interface DeviceNetwork {
+		mqtt: MQTTClientProvider;
+	}
+}

package/config/mqttclient.d.ts

@@ -0,0 +1,31 @@
+/*
+* 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/>.
+*
+*/
+
+// the manifest of this configuration includes the manifests of these configurations
+/// <reference path="./dns.d.ts" />
+/// <reference path="./socket.d.ts" />
+
+declare module "embedded:provider/builtin" {
+	import type { MQTTClientProvider } from "embedded:network/mqtt/client";
+
+	interface DeviceNetwork {
+		mqtt: MQTTClientProvider;
+	}
+}

package/config/mqttsclient.d.ts

@@ -0,0 +1,32 @@
+/*
+* 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/>.
+*
+*/
+
+// the manifest of this configuration includes the manifests of these configurations
+/// <reference path="./tls.d.ts" />
+/// <reference path="./mqttclient.d.ts" />
+/// <reference path="./dns.d.ts" />
+
+declare module "embedded:provider/builtin" {
+	import type { MQTTClientProvider } from "embedded:network/mqtt/client";
+
+	interface DeviceNetwork {
+		mqtts: MQTTClientProvider;
+	}
+}

package/config/ntp.d.ts

@@ -0,0 +1,34 @@
+/*
+* 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/>.
+*
+*/
+
+// the manifest of this configuration includes the manifests of these configurations
+/// <reference path="./dns.d.ts" />
+/// <reference path="./socket.d.ts" />
+
+declare module "embedded:provider/builtin" {
+	import type { NTPClientProvider } from "embedded:network/ntp/client";
+
+	interface DeviceNetwork {
+		ntp: DeviceNetworkNTP;
+	}
+	interface DeviceNetworkNTP {
+		client: NTPClientProvider;
+	}
+}

package/config/pulsecount.d.ts

@@ -0,0 +1,30 @@
+/*
+* 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:provider/builtin" {
+	import type PulseCount from "embedded:io/pulsecount";
+
+	interface Device {
+		io: DeviceIO;
+	}
+	interface DeviceIO {
+		PulseCount: typeof PulseCount;
+	}
+}

package/config/pwm.d.ts

@@ -0,0 +1,30 @@
+/*
+* 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:provider/builtin" {
+	import type PWM from "embedded:io/pwm";
+
+	interface Device {
+		io: DeviceIO;
+	}
+	interface DeviceIO {
+		PWM: typeof PWM;
+	}
+}

package/config/serial.d.ts

@@ -0,0 +1,31 @@
+/*
+* 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:provider/builtin" {
+	import type Serial from "embedded:io/serial";
+
+	interface Device {
+		io: DeviceIO;
+		serial: DeviceSerial;
+	}
+	interface DeviceIO {
+		Serial: typeof Serial;
+	}
+}

package/config/socket.d.ts

@@ -0,0 +1,34 @@
+/*
+* 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:provider/builtin" {
+	import type TCP from "embedded:io/socket/tcp";
+	import type UDP from "embedded:io/socket/udp";
+	import type Listener from "embedded:io/socket/listener";
+
+	interface Device {
+		io: DeviceIO;
+	}
+	interface DeviceIO {
+		TCP: typeof TCP;
+		UDP: typeof UDP;
+		Listener: typeof Listener;
+	}
+}

package/config/spi.d.ts

@@ -0,0 +1,31 @@
+/*
+* 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:provider/builtin" {
+	import type SPI from "embedded:io/spi";
+
+	interface Device {
+		io: DeviceIO;
+		spi: DeviceSPI;
+	}
+	interface DeviceIO {
+		SPI: typeof SPI;
+	}
+}

package/config/storage.d.ts

@@ -0,0 +1,27 @@
+/*
+* 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:provider/builtin" {
+	import type keyValue from "embedded:storage/key-value";
+
+	interface Device {
+		keyValue: typeof keyValue;
+	}
+}

package/config/system.d.ts

@@ -0,0 +1,27 @@
+/*
+* 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:provider/builtin" {
+	import type System from "embedded:system";
+
+	interface Device {
+		system: typeof System;
+	}
+}

package/config/tls.d.ts

@@ -0,0 +1,30 @@
+/*
+* 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:provider/builtin" {
+	import type TLS from "embedded:io/socket/tcp/tls";
+
+	interface Device {
+		io: DeviceIO;
+	}
+	interface DeviceIO {
+		TLS: typeof TLS;
+	}
+}

package/config/update.d.ts

@@ -0,0 +1,27 @@
+/*
+* 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:provider/builtin" {
+	import type update from "embedded:update";
+
+	interface Device {
+		update: typeof update;
+	}
+}

package/config/wsclient.d.ts

@@ -0,0 +1,31 @@
+/*
+* 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/>.
+*
+*/
+
+// the manifest of this configuration includes the manifests of these configurations
+/// <reference path="./dns.d.ts" />
+/// <reference path="./socket.d.ts" />
+
+declare module "embedded:provider/builtin" {
+	import type { WebSocketClientProvider } from "embedded:network/websocket/client";
+
+	interface DeviceNetwork {
+		ws: WebSocketClientProvider;
+	}
+}

package/config/wssclient.d.ts

@@ -0,0 +1,32 @@
+/*
+* 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/>.
+*
+*/
+
+// the manifest of this configuration includes the manifests of these configurations
+/// <reference path="./wsclient.d.ts" />
+/// <reference path="./tls.d.ts" />
+/// <reference path="./dns.d.ts" />
+
+declare module "embedded:provider/builtin" {
+	import type { WebSocketClientProvider } from "embedded:network/websocket/client";
+
+	interface DeviceNetwork {
+		wss: WebSocketClientProvider;
+	}
+}

package/crc.d.ts

@@ -29,7 +29,7 @@ declare module "crc" {
     constructor(polynomial: number, initial_value?: number, reflectInput?: boolean, reflectOutput?: boolean, xorOutput?: number)
     close(): void
     checksum(bytes: ByteBuffer): number
-    reset(): this
+    reset(): void
   }
   export {CRC8 as default, CRC8, CRC16};
 }

package/dns/server.d.ts

@@ -19,6 +19,7 @@
 */
 
 declare module "dns/server" {
+  /** @deprecated Use the ECMA-419 DNS server, embedded:network/dns/server */
   class Server {
     constructor(callback: (message: number, value?: string) => string);
     close(): void;

package/embedded/RTC/zephyr-builtin.d.ts

@@ -0,0 +1,48 @@
+/*
+* 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:RTC/zephyr-builtin" {
+	import type { PortSpecifier } from "embedded:io/_common";
+	import type { RTCConfigureOptions } from "embedded:RTC";
+
+	// Zephyr's built-in real-time clock is selected by port, its devicetree label, rather than connected to a bus.
+	// It does not provide the configuration property.
+	export interface ZephyrRTCOptions {
+		port: PortSpecifier;
+		onAlarm?: (this: ZephyrRTC) => void;
+		target?: any;
+	}
+
+	export interface ZephyrRTC extends Disposable {
+		target?: any;
+		close(): void;
+		/** undefined when the time is unavailable, for example because it has not been set */
+		get time(): number | undefined;
+		set time(value: number);
+		configure(options: RTCConfigureOptions): void;
+	}
+
+	const ZephyrRTC: {
+		new (options: ZephyrRTCOptions): ZephyrRTC;
+		readonly prototype: ZephyrRTC;
+	};
+
+	export default ZephyrRTC;
+}

package/embedded/RTC.d.ts

@@ -1,5 +1,5 @@
 /*
-* Copyright (c) 2025 Moddable Tech, Inc.
+* Copyright (c) 2025-2026 Moddable Tech, Inc.
 *
 *   This file is part of the Moddable SDK Tools.
 *
@@ -19,25 +19,36 @@
 */
 
 declare module "embedded:RTC" {
-	import type {PortSpecifier} from "embedded:io/_common";
+	export interface RTCConnection {
+		io: abstract new (options: any) => object;
+		[option: string]: unknown;
+	}
 
 	export interface RTCOptions {
+		clock: RTCConnection;
+		interrupt?: RTCConnection;
+		onAlarm?: (this: RTC) => void;
 		target?: any;
-		port?: PortSpecifier;
-		onAlarm?: () => void;
 	}
 
 	export interface RTCConfigureOptions {
 		alarm?: number;
 	}
 
-	export class RTC {
+	export interface RTCConfiguration {
+		alarm?: number;
+	}
+
+	export class RTC implements Disposable {
+		target?: any;
 		constructor(options: RTCOptions);
 		close(): void;
-		time: number;
+		get time(): number | undefined;
+		set time(value: number);
 		configure(options: RTCConfigureOptions): void;
+		readonly configuration: RTCConfiguration;
+		[Symbol.dispose](): void;
 	}
-	export interface RTC extends Disposable {}
 
 	export default RTC;
 }

package/embedded/display.d.ts

@@ -30,6 +30,7 @@ declare module "embedded:display" {
 		brightness?: number; // 0-1 range
 		rotation?: 0 | 90 | 180 | 270;
 		format?: typeof Bitmap.RGB565LE | typeof Bitmap.RGB24 | typeof Bitmap.Gray256;
+		flip?: "" | "h" | "v" | "hv";
 	}
 
 	export interface DisplayConfiguration {
@@ -43,9 +44,10 @@ declare module "embedded:display" {
 		y: number;
 		width: number;
 		height: number;
+		continue?: boolean;		// true to continue updating the same frame buffer
 	}
 
-	class Display {
+	class Display implements Disposable {
 		constructor(options: DisplayConstructorOptions);
 		close(): void;
 
@@ -58,12 +60,15 @@ declare module "embedded:display" {
 		send(buffer: ByteBuffer, offset: number, length: number): void;
 		end(): void;
 
-		adapInvalid(rectangle: Rectangle): void;
+		adaptInvalid(rectangle: Rectangle): void;
 
 		get width(): number;
 		get height(): number;
+
+		corner?: number;		// circular & roundrect displays
+
+		[Symbol.dispose](): void;
 	}
-	interface Display extends Disposable {}
 
 	export default Display;
 }

package/embedded/storage/files.d.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024-2025  Moddable Tech, Inc.
+ * Copyright (c) 2024-2026  Moddable Tech, Inc.
  *
  *   This file is part of the Moddable SDK Runtime.
  * 
@@ -27,7 +27,7 @@ declare module "embedded:storage/files" {
 		isSymbolicLink(): boolean;
 	}
 
-	export class File {
+	export class File implements Disposable {
 		// Use Directory.openFile() to create File instances
 		close(): void;
 
@@ -38,8 +38,8 @@ declare module "embedded:storage/files" {
 		status(): Status;
 		setSize(length: number): void;
 		flush(): void;
+		[Symbol.dispose](): void;
 	}
-	export interface File extends Disposable {}
 
 	export interface DirectoryOpenFileOptions {
 		path: string;
@@ -54,7 +54,7 @@ declare module "embedded:storage/files" {
 		resolveTarget?: boolean;
 	}
 
-	export class Directory {
+	export class Directory implements Disposable {
 		// use device.files to access file system root
 		close(): void;
 
@@ -70,8 +70,11 @@ declare module "embedded:storage/files" {
 		createLink?(path: string, target: string): void;
 		readLink?(path: string): string;
 
-		scan(path?: string): IterableIterator<string>;
-		[Symbol.iterator](): IterableIterator<string>;
+		scan(path?: string): IteratorObject<string, undefined, unknown>;
+		[Symbol.iterator](): IteratorObject<string, undefined, unknown>;
+		[Symbol.dispose](): void;
 	}
-	export interface Directory extends Disposable {}
+
+	const root: Directory;
+	export default root;
 }