@moddable/typings 1.0.0

package/embedded_io/system.d.ts

@@ -0,0 +1,36 @@
+/*
+* Copyright (c) 2022 Shinya Ishikawa
+*
+*   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:io/system" {
+  import Timer from "timer";
+  /**
+   * @experimetnal
+   */
+  class System {
+    static deepSleep(us: number, mode: number): void;
+    static restart(): void;
+    static resolve(name: string, callback: (name: string, ip: string) => void) : void;
+    static setTimeout: typeof Timer.set;
+    static clearTimeout: typeof Timer.clear;
+    static setInterval: typeof Timer.repeat;
+    static clearInterval: typeof Timer.clear;
+  }
+  export default System;
+}

package/embedded_provider/builtin.d.ts

@@ -0,0 +1,57 @@
+/*
+* Copyright (c) 2022 Shinya Ishikawa
+*
+*   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 Digital from "embedded:io/digital";
+  import DigitalBank from "embedded:io/digitalbank";
+  import Analog from "embedded:io/analog";
+  import PWM from "embedded:io/pwm";
+  import PulseCount from "embedded:io/pulsecount";
+  import I2C from "embedded:io/i2c";
+  import SMBus from "embedded:io/smbus";
+  import SPI from "embedded:io/spi";
+  import Serial from "embedded:io/serial";
+  import type { PinSpecifier } from "embedded:io/_common";
+  const device: {
+    io: {
+      Digital: typeof Digital;
+      DigitalBank: typeof DigitalBank;
+      Analog: typeof Analog;
+      PWM: typeof PWM;
+      PulseCount: typeof PulseCount;
+      I2C: typeof I2C;
+      SMBus: typeof SMBus;
+      SPI: typeof SPI;
+      Serial: typeof Serial;
+    };
+    Digital: { default: ConstructorParameters<typeof Digital>[0] };
+    DigitalBank: { default: ConstructorParameters<typeof DigitalBank>[0] };
+    Analog: { default: ConstructorParameters<typeof Analog>[0] };
+    PWM: { default: ConstructorParameters<typeof PWM>[0] };
+    PulseCount: { default: ConstructorParameters<typeof PulseCount>[0] };
+    I2C: { default: ConstructorParameters<typeof I2C>[0] };
+    SMBus: { default: ConstructorParameters<typeof SMBus>[0] };
+    SPI: { default: ConstructorParameters<typeof SPI>[0] };
+    Serial: { default: ConstructorParameters<typeof Serial>[0] };
+    pin: { [name: string]: PinSpecifier };
+  };
+  export default device;
+}

package/embedded_provider/index.d.ts

@@ -0,0 +1 @@
+// Blank

package/file.d.ts

@@ -0,0 +1,67 @@
+/*
+* Copyright (c) 2019-2020 Bradley Farias
+*
+*   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 "file" {
+  /**
+   * The `File` class provides access to files.
+   */
+  export class File {
+    constructor(path: string, write?: boolean);
+    /**
+     * 
+     */
+    read<T extends (
+      typeof ArrayBuffer | typeof String
+    )>(
+      type: T,
+      bytes?: number
+    ): T extends typeof String ? string : InstanceType<T>;
+
+    write(
+      value: ArrayBufferLike | ArrayBuffer | string,
+      ...moreValues: (ArrayBuffer | string)[]
+    ): void;
+
+    close(): void;
+
+    readonly length: number;
+    position: number;
+
+    static delete(path: string): boolean;
+    static exists(path: string): boolean;
+    static rename(from: string, to: string): boolean;
+  }
+  type IteratorDirectoryEntry = {name: string, length: undefined};
+  type IteratorFileEntry = {name: string, length: number};
+  class Iterator {
+    constructor(path: string);
+    next(): IteratorDirectoryEntry | IteratorFileEntry | undefined;
+  }
+
+  class Directory {
+    static create(path): void;
+    static delete(path): void;
+  }
+
+  class System {
+    static config(): {maxPathLength: number}
+    static info(): {used: number, total: number};
+  }
+}

package/flash.d.ts

@@ -0,0 +1,33 @@
+/*
+* Copyright (c) 2020-2022 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 "flash" {
+  class Flash {
+    constructor(partition?: string);
+    constructor(offset: number, byteLength: number);
+    erase(sector: number): void;
+    read(offset: number, byteLength: number, useHostBuffer?: boolean): ArrayBuffer | HostBuffer;
+    write(offset: number, byteLength: number, buffer: BufferLike): void;
+    readonly byteLength: number;
+    readonly blockSize: number;
+    map(): HostBuffer;
+  }
+  export {Flash as default};
+}

package/global.d.ts

@@ -0,0 +1,9 @@
+import System_ from "embedded:io/system"
+import Device from "embedded:provider/builtin"
+
+export {}
+declare global {
+  // NOTE: `System` is non-standard and temporary to support the IO examples. Breaking changes are possible.
+  var System: typeof System_;
+  var device: typeof Device;
+}

package/hex.d.ts

@@ -0,0 +1,27 @@
+/*
+* Copyright (c) 2019-2020 Bradley Farias
+*
+*   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 "hex" {
+  var Hex: {
+    toBuffer: (str: string, separator?: string) => ArrayBuffer;
+    toString: (buffer: BufferLike, separator?: string) => string;
+  }
+  export {Hex as default};
+}

package/http.d.ts

@@ -0,0 +1,125 @@
+/*
+* Copyright (c) 2019-2020 Bradley Farias
+*
+*   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 "http" {
+  import type {TCPSocketOptions, ListenerOptions} from "socket";
+
+  type RequestError = -1;
+  type RequestBodyFragment = 0;
+  type RequestStatusCode = 1;
+  type RequestHeaderReceived = 2;
+  type RequestAllHeaders = 3;
+  type RequestResponseFragment = 4;
+  type RequestAllResponse = 5;
+
+  export type RequestStatus = (
+    RequestError |
+    RequestBodyFragment |
+    RequestStatusCode |
+    RequestHeaderReceived |
+    RequestAllHeaders |
+    RequestResponseFragment |
+    RequestAllResponse
+  );
+
+  export type HTTPRequestOptions = TCPSocketOptions | {
+    host?: string,
+    address?: string,
+    port?: number,
+    path?: string,
+    method?: string,
+    headers?: (string | number)[],
+    body?: boolean | string | ArrayBuffer,
+    response?: typeof String | typeof ArrayBuffer
+  }
+
+  // TODO: better
+  export type HTTPRequestCallback = (message: RequestStatus, val1?: any, val2?: any) => void | number | boolean | string | ArrayBuffer;
+
+  export class Request {
+    constructor(options: HTTPRequestOptions);
+    close(): void;
+    read(): number;
+    read<T extends typeof String | typeof ArrayBuffer>(
+      type: T,
+      until?: number
+    ): T extends typeof String ? string : ArrayBuffer;
+    callback: HTTPRequestCallback
+
+    static readonly requestFragment: RequestBodyFragment;
+    static readonly status: RequestStatusCode;
+    static readonly header: RequestHeaderReceived;
+    static readonly headersComplete: RequestAllHeaders;
+    static readonly responseFragment: RequestAllHeaders;
+    static readonly responseComplete: RequestAllResponse;
+    static readonly error: RequestError;
+  }
+
+  type ServerConnection = 1;
+  type ServerStatus = 2;
+  type ServerHeader = 3;
+  type ServerHeadersComplete = 4;
+  type ServerRequestFragment = 5;
+  type ServerRequestComplete = 6;
+  type ServerPrepareResponse = 8;
+  type ServerResponseFragment = 9;
+  type ServerResponseComplete = 10;
+  type ServerError = -1;
+  export type ServerMessages = (
+    ServerConnection |
+    ServerStatus |
+    ServerHeader |
+    ServerHeadersComplete |
+    ServerRequestFragment |
+    ServerRequestComplete |
+    ServerPrepareResponse |
+    ServerResponseFragment |
+    ServerResponseComplete |
+    ServerError
+  );
+  export type HTTPServerOptions = ListenerOptions;
+  // TODO: better
+  export type HTTPServerCallback = (this: Request, message: ServerMessages, val1?: any, val2?: any) => void | number | boolean | string |
+    ArrayBuffer | { status?: number, reason?: string, headers?: string[], body: true | string | ArrayBuffer };
+
+  export class Server {
+    constructor(
+      options?: HTTPServerOptions
+    );
+    close(): void;
+    read(): number;
+    read<T extends typeof String | typeof ArrayBuffer>(
+      type: T,
+      until?: number
+    ): T extends typeof String ? string : ArrayBuffer;
+    callback: HTTPServerCallback
+
+    static readonly connection: ServerConnection;
+    static readonly status: ServerStatus;
+    static readonly header: ServerHeader;
+    static readonly headersComplete: ServerHeadersComplete;
+    static readonly requestFragment: ServerRequestFragment;
+    static readonly requestComplete: ServerRequestComplete;
+    static readonly prepareResponse: ServerPrepareResponse;
+    static readonly responseFragment: ServerResponseFragment;
+    static readonly responseComplete: ServerResponseComplete;
+    static readonly error: ServerError;
+  }
+}

package/instrumentation.d.ts

@@ -0,0 +1,60 @@
+/*
+* Copyright (c) 2019-2020 Bradley Farias
+*
+*   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 "instrumentation" {
+  type PixelsDrawn = 1;
+  type FramesDrawn = 2;
+  type NetworkBytesRead = 3;
+  type NetworkBytesWritten = 4;
+  type NetworkSockets = 5;
+  type Timers = 6;
+  type Files = 7;
+  type POCODisplayListUsed = 8;
+  type PIUCommandListUsed = 9;
+  type SystemFreeMemory = 10;
+  type SlotHeapSize = 11;
+  type ChunkHeapSize = 12;
+  type KeysUsed = 13;
+  type GarbageCollectionCount = 14;
+  type ModulesLoaded = 15;
+  type StackPeak = 16;
+  type InstrumentationOption = (
+    PixelsDrawn |
+    FramesDrawn |
+    NetworkBytesRead |
+    NetworkBytesWritten |
+    NetworkSockets |
+    Timers |
+    Files |
+    POCODisplayListUsed |
+    PIUCommandListUsed |
+    SystemFreeMemory |
+    SlotHeapSize |
+    ChunkHeapSize |
+    KeysUsed |
+    GarbageCollectionCount |
+    ModulesLoaded |
+    StackPeak
+  );
+  var Instrumentation: {
+   get: (what: InstrumentationOption) => number;
+  };
+  export {Instrumentation as default};
+}

package/mc/config.d.ts

@@ -0,0 +1,24 @@
+/*
+* Copyright (c) 2019-2020 Bradley Farias
+*
+*   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 "mc/config" {
+  var Config: {file: {root: string}} & Record<string, any>;
+  export {Config as default};
+}

package/mc/index.d.ts

@@ -0,0 +1 @@
+// Blank

package/mcpack.d.ts

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2020-2023 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/>.
+ *
+ */
+
+interface Console {
+	log(...log: (string | number | boolean)[]):void;
+}
+declare const console: Console;
+
+declare function clearImmediate(id: number): void;
+declare function clearInterval(id: number): void;
+declare function clearTimeout(id: number): void;
+declare function setImmediate(handler: Function): void;
+declare function setInterval(handler: Function, timeout?: number): void;
+declare function setTimeout(handler: Function, timeout?: number): void;
+
+// import fetch from "fetch";
+// import Headers from "headers";
+// import structuredClone from "structuredClone";
+// import TextDecoder from "text/decoder";
+// import TextEncoder from "text/encoder";
+// import URL from "url";
+// import { URLSearchParams } from "url";
+// import Worker from "worker";
+// import { SharedWorker } from "worker";

package/mdns.d.ts

@@ -0,0 +1,47 @@
+/*
+* Copyright (c) 2019-2020 Bradley Farias
+*
+*   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 "mdns" {
+  type MDNSService = {
+    name: string,
+    protocol: string,
+    port: number,
+    txt: Record<string, string>
+  };
+  class MDNS {
+    constructor(
+      options: {
+        hostName: string
+      }, callback?: (message: number, value?: string) => void
+    );
+    monitor(
+      service: string,
+      callback: (
+        service: string,
+        instance: MDNSService
+      ) => void
+    ): void;
+    add(service: MDNSService): void;
+    update(service: MDNSService): void;
+    remove(service: MDNSService): void;
+    remove(serviceType: string): void;
+  }
+  export {MDNS as default};
+}

package/modules.d.ts

@@ -0,0 +1,28 @@
+/*
+* Copyright (c) 2022 Chris Midgley
+*
+*   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 "modules" {
+    export default class Modules {
+        static has(name: string): boolean;
+        static importNow(name: string): unknown;
+        static get host(): string[];
+        static get archive(): string[];
+    }
+}

package/net.d.ts

@@ -0,0 +1,67 @@
+/*
+* Copyright (c) 2019-2020 Bradley Farias
+*
+*   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 "net" {
+  /**
+   * The Net class provides access to status information about the active network connection.
+   */
+  var Net: {
+    /**
+     * The IP address of the network connection as a `String`, e.g. "10.0.1.4"
+     */
+    get(what: "IP"): string;
+    /**
+     * The MAC address of the device as a `String`, e.g. "A4:D1:8C:DB:C0:20"
+     */
+    get(what: "MAC"): string;
+    /**
+     * The name of the Wi-Fi access point as a `String`, e.g. "Moddable Wi-Fi"
+     */
+    get(what: "SSID"): string;
+    /**
+     * The MAC address of the Wi-Fi access point as a `String`, e.g. "18:64:72:47:d4:32"
+     */
+    get(what: "BSSID"): string;
+    /**
+     * Gets the Wi-Fi [received signal strength](https://en.wikipedia.org/wiki/Received_signal_strength_indication) as a `Number`
+     */
+    get(what: "RSSI"): number;
+    /**
+     * Gets an Array of the DNS servers configured in the system
+     */
+    get(what: "DNS"): string[];
+
+    /**
+     * The resolve function performs performs an asynchronous DNS look-up for the specified host and invokes the callback to deliver the result.
+     * 
+     * The IP address is provided as a String in dotted IP address notation. If host cannot be resolved, the address parameter is undefined.
+     * 
+     * The DNS implementation in lwIP supports a limited number of simultaneous DNS look-ups. The number depends on the specific platform deployment. On the ESP8266 it is 4. If the DNS resolve queue is full, resolve throws an exception.
+     * 
+     * @example
+       Net.resolve("moddable.tech", (name, address) => trace(`${name} IP address is ${address}\n`);
+     */
+    resolve(
+      name: string,
+      callback: (name: string, address?: string) => void
+    ): void;
+  }
+  export {Net as default};
+}

package/package.json

@@ -0,0 +1,14 @@
+{
+	"name": "@moddable/typings",
+	"version": "1.0.0",
+	"dependencies": {
+	},
+	"main": "",
+	"types": [
+		"xs.d.ts",
+		"mcpack.d.ts"
+	],
+	"author": "",
+	"license": "ISC",
+	"description": ""
+}