@moddable/typings 6.1.0 → 7.1.0

package/base64.d.ts

@@ -21,7 +21,7 @@
 declare module "base64" {
   var Base64: {
     decode: (str: string) => ArrayBuffer;
-    encode: (source: BufferLike | string) => string;
+    encode: (source: ByteBuffer | string) => string;
   }
   export {Base64 as default};
 }

package/commodetto/Bitmap.d.ts

@@ -22,7 +22,7 @@ declare module "commodetto/Bitmap" {
   type PixelFormat = number
 
   class Bitmap {
-    constructor(width: number, height: number, format: PixelFormat, buffer: BufferLike, offset: number, byteLength?: number)
+    constructor(width: number, height: number, format: PixelFormat, buffer: ByteBuffer, offset: number, byteLength?: number)
 
     readonly pixelFormat: PixelFormat
     readonly offset: number

package/commodetto/BufferOut.d.ts

@@ -26,7 +26,7 @@ declare module "commodetto/BufferOut" {
     width: number;
     height: number;
     pixelFormat: number;
-    buffer?: BufferLike;
+    buffer?: ByteBuffer;
   }
 
   class BufferOut {
@@ -35,7 +35,7 @@ declare module "commodetto/BufferOut" {
     end(): void;
     continue(x: number, y: number, width: number, height: number): void;
     send(
-      pixels: BufferLike,
+      pixels: ByteBuffer,
       offset: number,
       count: number
     ): void;

package/commodetto/Convert.d.ts

@@ -20,9 +20,9 @@
 
 declare module "commodetto/Convert" {
   class Convert {
-    constructor(srcFormat: number, dstFormat: number, clut?: BufferLike);
-    process(src: BufferLike, dst: BufferLike): void;
-    process(src: BufferLike, srcOffset: number, srcCount: number, dst: BufferLike, dstOffset: number, dstCount: number): void;
+    constructor(srcFormat: number, dstFormat: number, clut?: ByteBuffer);
+    process(src: ByteBuffer, dst: ByteBuffer): void;
+    process(src: ByteBuffer, srcOffset: number, srcCount: number, dst: ByteBuffer, dstOffset: number, dstCount: number): void;
   }
 
   export {Convert as default};

package/commodetto/ReadGIF.d.ts

@@ -22,7 +22,7 @@ declare module "commodetto/ReadGIF" {
   import Bitmap from "commodetto/Bitmap"
 
   class ReadGIF extends Bitmap {
-    constructor(buffer: BufferLike);
+    constructor(buffer: ByteBuffer);
     close(): void;
     first(): void;
     next(): void;

package/commodetto/ReadPNG.d.ts

@@ -32,9 +32,9 @@ declare module "commodetto/ReadPNG" {
   }
 
   interface ReadPNGConstructor {
-    new(buffer: BufferLike, options?: { pixelFormat: number }): ReadPNG
+    new(buffer: ByteBuffer, options?: { pixelFormat: number }): ReadPNG
 
-    decompress(data: BufferLike, pixelFormat: number, alphaPixelFormat?: number): Bitmap;
+    decompress(data: ByteBuffer, pixelFormat: number, alphaPixelFormat?: number): Bitmap;
   }
 
   const ReadPNG: ReadPNGConstructor

package/commodetto/loadJPEG.d.ts

@@ -21,5 +21,5 @@
 declare module "commodetto/loadJPEG" {
   import Bitmap from "commodetto/Bitmap"
 
-  export default function (data: BufferLike, options?: {pixelFormat?: number}): Bitmap;
+  export default function (data: ByteBuffer, options?: {pixelFormat?: number}): Bitmap;
 }

package/commodetto/parseBMF.d.ts

@@ -21,5 +21,5 @@
 declare module "commodetto/parseBMF" {
   import type {Font} from "commodetto/Poco"
 
-  export default function (bmp: BufferLike): Font
+  export default function (bmp: ByteBuffer): Font
 }

package/commodetto/parseNFNT.d.ts

@@ -21,5 +21,5 @@
 declare module "commodetto/parseNFNT" {
   import type {Font} from "commodetto/Poco"
 
-  export default function (bmp: BufferLike): Font
+  export default function (bmp: ByteBuffer): Font
 }

package/commodetto/readJPEG.d.ts

@@ -27,10 +27,10 @@ declare module "commodetto/readJPEG" {
   }
 
   class JPEG {
-    constructor(buffer?: (BufferLike), options?: { pixelFormat: number })
+    constructor(buffer?: (ByteBuffer), options?: { pixelFormat: number })
 
     read(): Block
-    push(buffer: BufferLike): void
+    push(buffer: ByteBuffer): void
 
     readonly ready: boolean
   }

package/crc.d.ts

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

package/{deflate.ts → deflate.d.ts}

@@ -24,7 +24,7 @@ declare module "deflate" {
     constructor(options?: {windowBits?: number, level?: number, strategy?: number});
     close(): void;
 
-    push(buffer: BufferLike | string, end?: boolean): boolean;
+    push(buffer: ByteBuffer | string, end?: boolean): boolean;
 
     onData: (data: ArrayBuffer) => void;
     onEnd: (status: number) => void;

package/display.d.ts

@@ -0,0 +1,68 @@
+/*
+ * 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/dns/parser.d.ts

@@ -1,5 +1,6 @@
 /*
 * Copyright (c) 2019-2020 Bradley Farias
+* Copyright (c) 2026 Moddable Tech, Inc.
 *
 *   This file is part of the Moddable SDK Tools.
 *
@@ -19,19 +20,73 @@
 */
 
 declare module "dns/parser" {
+  interface DNSQuestion {
+      qname: string[];
+      qtype: number;
+      qclass: number;
+  }
+
+  interface DNSSRVData {
+      priority: number;
+      weight: number;
+      port: number;
+      target: string[];
+  }
+
+  interface DNSAnswerA {
+      qname: string[];
+      qtype: 0x0001;
+      qclass: number;
+      ttl: number;
+      rdata: string;
+  }
+
+  interface DNSAnswerPTR {
+      qname: string[];
+      qtype: 0x000C;
+      qclass: number;
+      ttl: number;
+      rdata: string[];
+  }
+
+  interface DNSAnswerTXT {
+      qname: string[];
+      qtype: 0x0010;
+      qclass: number;
+      ttl: number;
+      rdata: string[];
+  }
+
+  interface DNSAnswerSRV {
+      qname: string[];
+      qtype: 0x0021;
+      qclass: number;
+      ttl: number;
+      rdata: DNSSRVData;
+  }
+
+  interface DNSAnswerOther {
+      qname: string[];
+      qtype: number;
+      qclass: number;
+      ttl: number;
+      rdata: "UNHANDLED";
+  }
+
+  type DNSAnswer = DNSAnswerA | DNSAnswerPTR | DNSAnswerTXT | DNSAnswerSRV | DNSAnswerOther;
+    
   class Parser {
-    constructor(buffer: ArrayBuffer);
+    constructor(buffer: ByteBuffer);
     get id(): number;
     get flags(): number;
     get questions(): number;
     get answers(): number;
     get authorities(): number;
     get additionals(): number;
-    // TODO: not use unknown
-    question(index: number): unknown;
-    answer(index: number): unknown;
-    authority(index: number): unknown;
-    additional(index: number): unknown;
+    question(index: number): DNSQuestion;
+    answer(index: number): DNSAnswer;
+    authority(index: number): DNSAnswer;
+    additional(index: number): DNSAnswer;
   }
   export {Parser as default};
 }

package/dns/serializer.d.ts

@@ -25,14 +25,15 @@ declare module "dns/serializer" {
       opcode?: (typeof DNS.OPCODE)[keyof (typeof DNS.OPCODE)],
       query?: boolean,
       authoritative?: boolean,
-      id?: number
+      id?: number,
+      recursionDesired?: boolean,
     });
     add(
       section: (typeof DNS.SECTION)[keyof (typeof DNS.SECTION)],
       name: string,
       type: (typeof DNS.RR)[keyof (typeof DNS.RR)],
       classType: (typeof DNS.CLASS)[keyof (typeof DNS.CLASS)],
-      ttl: number,
+      ttl?: number,
       data?: ArrayBuffer
     ): void;
     build(): ArrayBuffer;

package/embedded/RTC.d.ts

@@ -0,0 +1,42 @@
+/*
+* Copyright (c) 2025 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" {
+	import type {PortSpecifier} from "embedded:io/_common";
+
+	export interface RTCOptions {
+		target?: any;
+		port?: PortSpecifier;
+		onAlarm?: () => void;
+	}
+
+	export interface RTCConfigureOptions {
+		alarm?: number;
+	}
+
+	export class RTC {
+		constructor(options: RTCOptions);
+		close(): void;
+		time: number;
+		configure(options: RTCConfigureOptions): void;
+	}
+
+	export default RTC;
+}

package/embedded/display.d.ts

@@ -0,0 +1,68 @@
+/*
+ * 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" {
+	import type Bitmap from "commodetto/Bitmap";
+	import type { Rectangle } from "commodetto/Poco";
+
+	export interface DisplayConstructorOptions {
+		port: string;
+	}
+
+	export interface DisplayConfigureOptions {
+		brightness?: number; // 0-1 range
+		rotation?: 0 | 90 | 180 | 270;
+		format?: typeof Bitmap.RGB565LE | typeof Bitmap.RGB24 | typeof Bitmap.Gray256;
+	}
+
+	export interface DisplayConfiguration {
+		brightness: number; // 0-1 range
+		rotation: 0 | 90 | 180 | 270;
+		format: typeof Bitmap.RGB565LE | typeof Bitmap.RGB24 | typeof Bitmap.Gray256;
+	}
+
+	export interface DisplayBeginOptions {
+		x: number;
+		y: number;
+		width: number;
+		height: number;
+	}
+
+	class Display {
+		constructor(options: DisplayConstructorOptions);
+		close(): void;
+
+		configure(options: DisplayConfigureOptions): void;
+		get configuration(): DisplayConfiguration;
+
+		begin(options: DisplayBeginOptions): void;
+		begin(): void;
+		send(buffer: ByteBuffer): void;
+		send(buffer: ByteBuffer, offset: number, length: number): void;
+		end(): void;
+
+		adapInvalid(rectangle: Rectangle): void;
+
+		get width(): number;
+		get height(): number;
+	}
+
+	export default Display;
+}

package/embedded/storage/files.d.ts

@@ -0,0 +1,75 @@
+/*
+ * Copyright (c) 2024-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:storage/files" {
+	export class Status {
+		size: number;
+		mode: number;
+		isFile(): boolean;
+		isDirectory(): boolean;
+		isSymbolicLink(): boolean;
+	}
+
+	export class File {
+		// Use Directory.openFile() to create File instances
+		close(): void;
+
+		read(count: number, position: number): ArrayBuffer;
+		read(buffer: ByteBuffer, position: number): number;
+		write(buffer: ByteBuffer, position: number): void;
+
+		status(): Status;
+		setSize(length: number): void;
+		flush(): void;
+	}
+
+	export interface DirectoryOpenFileOptions {
+		path: string;
+		mode?: "r" | "r+" | "w" | "w+";
+	}
+
+	export interface DirectoryOpenDirectoryOptions {
+		path: string;
+	}
+
+	export interface DirectoryStatusOptions {
+		resolveTarget?: boolean;
+	}
+
+	export class Directory {
+		// use device.files to access file system root
+		close(): void;
+
+		openFile(options: DirectoryOpenFileOptions): File;
+		openDirectory(options: DirectoryOpenDirectoryOptions): Directory;
+
+		delete(path: string): boolean;
+		move(from: string, to: string, toDirectory?: Directory): void;
+
+		status(path: string, options?: DirectoryStatusOptions): Status;
+
+		createDirectory(path: string): boolean;
+		createLink(path: string, target: string): void;
+		readLink(path: string): string;
+
+		scan(path?: string): IterableIterator<string>;
+		[Symbol.iterator](): IterableIterator<string>;
+	}
+}

package/embedded/storage/flash.d.ts

@@ -0,0 +1,56 @@
+/*
+ * 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:storage/flash" {
+	export interface FlashOpenOptions {
+		path: string;
+		mode?: "r" | "r+";
+	}
+
+	export interface FlashStatus {
+		size: number;
+		blockLength: number;
+		blocks: number;
+		writeAlign: number;
+		eraseValue: number;
+	}
+
+	export class Flash {
+		// Use the default export's open() method to create Flash instances
+		close(): void;
+
+		eraseBlock(start: number, end?: number): void;
+
+		read(byteLength: number, byteOffset: number): ArrayBuffer;
+		read(buffer: ByteBuffer, byteOffset: number): number;
+		write(buffer: ByteBuffer, byteOffset: number): void;
+
+		status(): FlashStatus;
+
+		format: "buffer";
+	}
+
+	const FlashStorage: {
+		open(options: FlashOpenOptions): Flash;
+		[Symbol.iterator](): IterableIterator<string>;
+	};
+
+	export default FlashStorage;
+}

package/embedded/storage/key-value.d.ts

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2024-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:storage/key-value" {
+	export interface StorageOpenOptions {
+		path: string;
+		mode?: "r" | "r+";
+	}
+
+	export type StorageFormat = "buffer" | "string" | "uint8" | "int8" | "uint16" | "int16" | "uint32" | "int32" | "uint64" | "int64";
+
+	export class Storage {
+		// Use the default export's open() method to create Storage instances
+		close(): void;
+
+		delete(key: string): void;
+
+		read(key: string): ArrayBuffer | string | number | bigint;
+		read(key: string, buffer: ByteBuffer): number;
+		write(key: string, value: ByteBuffer | string | number | bigint): void;
+
+		[Symbol.iterator](): IterableIterator<string>;
+
+		format: StorageFormat;
+	}
+
+	const KeyValueStorage: {
+		open(options: StorageOpenOptions): Storage;
+	};
+
+	export default KeyValueStorage;
+}

package/embedded_io/_common.d.ts

@@ -23,5 +23,4 @@ declare module "embedded:io/_common" {
   // This should be extended for future specification
   export type PinSpecifier = number
   export type PortSpecifier = number
-  export type Buffer = ArrayBuffer | HostBuffer | Uint8Array | Uint8ClampedArray | Int8Array | SharedArrayBuffer | DataView
 }

package/embedded_io/audio/in.d.ts

@@ -18,8 +18,6 @@
 *
 */
 declare module "embedded:io/audio/in" {
-  import { Buffer } from "embedded:io/_common";
-
   type AudioType = "LPCM";
 
   interface AudioInOptions {
@@ -36,7 +34,7 @@ declare module "embedded:io/audio/in" {
       onReadable?: (this: AudioIn, byteLength: number, sampleCount?: number) => void;
     });
     read(byteLength?: number): ArrayBuffer
-    read(buffer: Buffer): number
+    read(buffer: ByteBuffer): number
     start(): void;
     stop(options?: { flush?: boolean }): void
     close(): void;

package/embedded_io/audio/out.d.ts

@@ -18,8 +18,6 @@
 *
 */
 declare module "embedded:io/audio/out" {
-  import { Buffer } from "embedded:io/_common";
-
   type AudioType = "LPCM";
 
   interface AudioOutOptions {
@@ -35,7 +33,7 @@ declare module "embedded:io/audio/out" {
     constructor(options?: AudioOutOptions & {
       onWritable?: (this: AudioOut, byteLength: number, sampleCount?: number) => void;
     });
-    write(buffer: Buffer): void;
+    write(buffer: ByteBuffer): void;
     start(): void;
     stop(options?: { flush?: boolean }): void;
 

package/embedded_io/ble/_common.d.ts

@@ -0,0 +1,14 @@
+declare module "embedded:io/bluetoothle/_common" {
+	export interface GATTSecurityOptions {
+		bond?: boolean,
+		authenticate?: boolean,
+		ioCapabilities?: "none" | "display" | "numbers" | "display+numbers" | "display+confirm",
+		immediate?: boolean
+	}
+	export interface GATTSecurityState {
+		encrypted: boolean,
+		authenticated: boolean,
+		bonded: boolean,
+		keySize: number
+	}
+}