@moddable/typings 1.0.0

package/dns/server.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 "dns/server" {
+  class Server {
+    constructor(callback: (message: number, value?: string) => string);
+    close(): void;
+  }
+  export {Server as default};
+}

package/dns.d.ts

@@ -0,0 +1,55 @@
+/*
+* 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 "dns" {
+  // pulled from
+  // const impl: typeof import('../modules/network/dns/dns'),
+  var DNS: {
+    CLASS: {
+      IN: number,
+      NONE: number,
+      ANY: number,
+    },
+    OPCODE: {
+      QUERY: number,
+      UPDATE: number,
+    },
+    RR: {
+      A: number,
+      PTR: number,
+      TXT: number,
+      AAAA: number,
+      SRV: number,
+      OPT: number,
+      NSEC: number,
+      ANY: number,
+    },
+    SECTION: {
+      QUESTION: number,
+      ANSWER: number,
+      AUTHORITATIVE: number,
+      ADDITIONAL: number,
+      ZONE: number,
+      PREREQUISITE: number,
+      UPDATE: number,
+    }
+  };
+  export {DNS as default};
+}

package/embedded_io/_common.d.ts

@@ -0,0 +1,27 @@
+/*
+* 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/_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/analog.d.ts

@@ -0,0 +1,39 @@
+/*
+* 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/analog" {
+  import { PinSpecifier } from "embedded:io/_common";
+  class Analog {
+    constructor(options: {
+      pin: PinSpecifier;
+      resolution?: number;
+      onReadable?: (this: Analog) => void;
+      format?: "number";
+    });
+    readonly resolution: number;
+    onReadable?: () => void;
+    read(): number;
+    get format(): "number"
+    set format(value: "number")
+    target?: any;
+  }
+  export default Analog;
+}

package/embedded_io/digital.d.ts

@@ -0,0 +1,65 @@
+/*
+* 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/digital" {
+  import type { PinSpecifier } from "embedded:io/_common";
+
+  type Edge = number;
+
+  type Mode =
+    | typeof Digital.Input
+    | typeof Digital.InputPullUp
+    | typeof Digital.InputPullDown
+    | typeof Digital.InputPullUpDown
+    | typeof Digital.Output
+    | typeof Digital.OutputOpenDrain
+
+  class Digital {
+    static readonly Input: unknown
+    static readonly InputPullUp: unknown
+    static readonly InputPullDown: unknown
+    static readonly InputPullUpDown: unknown
+    static readonly Output: unknown
+    static readonly OutputOpenDrain: unknown
+    static readonly Rising: Edge;
+    static readonly Falling: Edge;
+
+    constructor(options: {
+      pin: PinSpecifier;
+      mode: Mode;
+      format?: "number";
+      target?: any;
+    } & ({
+      onReadable: (this: Digital) => void;
+      edge: Edge;
+    } | {
+      edge?: Edge;
+    }));
+
+    write(value: 0 | 1): void;
+    read(): 0 | 1;
+    close(): void;
+
+    get format(): "number"
+    set format(value: "number")
+  }
+
+  export default Digital;
+}

package/embedded_io/digitalbank.d.ts

@@ -0,0 +1,56 @@
+/*
+* 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/digitalbank" {
+  type Mode = 
+    | typeof DigitalBank.Input
+    | typeof DigitalBank.InputPullUp
+    | typeof DigitalBank.InputPullDown
+    | typeof DigitalBank.InputPullUpDown
+    | typeof DigitalBank.Output
+    | typeof DigitalBank.OutputOpenDrain
+
+  class DigitalBank {
+    static readonly Input: unknown
+    static readonly InputPullUp: unknown
+    static readonly InputPullDown: unknown
+    static readonly InputPullUpDown: unknown
+    static readonly Output: unknown
+    static readonly OutputOpenDrain: unknown
+
+    constructor(dictionary: {
+      pins: number;
+      mode: Mode;
+      bank?: number | string;
+      onReadable?: (this: DigitalBank, trigger: number) => void;
+      format?: "number";
+      target?: any;
+    })
+
+    close(): void;
+    read(): number;
+    write(value: number): void;
+
+    get format(): "number"
+    set format(value: "number")
+  }
+
+  export default DigitalBank;
+}

package/embedded_io/i2c.d.ts

@@ -0,0 +1,44 @@
+/*
+* 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/i2c" {
+  import { Buffer, PinSpecifier, PortSpecifier } from "embedded:io/_common";
+  class I2C {
+    constructor(options: {
+      data: PinSpecifier;
+      clock: PinSpecifier;
+      hz: number;
+      address: number;
+      port?: PortSpecifier;
+      format?: "buffer";
+      target?: any;
+    });
+    readonly resolution: number;
+    
+    write(value: Buffer, stop?: boolean): void;
+    read(byteLength: number, stop?: boolean): ArrayBuffer;
+    read(buffer: Buffer, stop?: boolean): ArrayBuffer;
+    get format(): "buffer"
+    set format(value: "buffer")
+  }
+
+  export default I2C;
+}

package/embedded_io/index.d.ts

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

package/embedded_io/pulsecount.d.ts

@@ -0,0 +1,39 @@
+/*
+* 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/pulsecount" {
+  import { PinSpecifier } from "embedded:io/_common";
+  class PulseCount {
+    constructor (options: {
+      signal: PinSpecifier;
+      control: PinSpecifier;
+      onReadable?: (this: PulseCount) => void;
+      onError?: (this: PulseCount) => void;
+      format?: "number";
+      target?: any;
+    });
+    read(): number;
+    write(count: number): void;
+    get format(): "number";
+    set format(value: "number");
+  }
+
+  export default PulseCount;
+}

package/embedded_io/pwm.d.ts

@@ -0,0 +1,38 @@
+/*
+* 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/pwm" {
+  import { PinSpecifier } from "embedded:io/_common";
+  class PWM {
+    constructor(options: {
+      pin: PinSpecifier;
+      hz?: number;
+      format?: "number";
+      target?: any;
+    });
+    readonly resolution: number;
+    readonly hz: number;
+    write(value: number): void;
+    get format(): "number"
+    set format(value: "number")
+  }
+  export default PWM;
+}

package/embedded_io/serial.d.ts

@@ -0,0 +1,61 @@
+/*
+* 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/serial" {
+  import { Buffer, PinSpecifier, PortSpecifier } from "embedded:io/_common";
+  class Serial {
+    constructor(options: ({
+      receive: PinSpecifier;
+      transmit?: PinSpecifier;
+    } | {
+      recevice?: PinSpecifier;
+      transmit: PinSpecifier;
+    }) & {
+      baud: number;
+      flowControl?: "hardware" | "none";
+      dataTerminalReady?: PinSpecifier;
+      requestToSend?: PinSpecifier;
+      clearToSend?: PinSpecifier;
+      dataSetReady?: PinSpecifier;
+      port: PortSpecifier;
+      onReadable?: (this: Serial, bytes: number) => void;
+      onWritable?: (this: Serial, bytes: number) => void;
+      format?: "number" | "buffer";
+      target?: any;
+    });
+    readonly resolution: number;
+    close(): void;
+    read(): number | ArrayBuffer | undefined;
+    read(byteLength: number): ArrayBuffer | undefined;
+    read(buffer: Buffer): number | undefined;
+    write(value: number | Buffer): void;
+    flush(): void;
+    flush(input: number, output: number): void;
+    set(options: {
+      dataTerminalReady?: PinSpecifier;
+      requestToSend?: PinSpecifier;
+      break?: boolean;
+    })
+    get format(): "number" | "buffer"
+    set format(value: "number" | "buffer")
+  }
+
+  export default Serial;
+}

package/embedded_io/smbus.d.ts

@@ -0,0 +1,43 @@
+/*
+* 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/smbus" {
+  import I2C from "embedded:io/i2c"
+  import { Buffer } from "embedded:io/_common";
+
+  class SMBus extends I2C {
+    constructor(options: ConstructorParameters<typeof I2C> & {
+      stop?: boolean;
+    });
+    readUint8(register: number): number;
+    writeUint8(register: number, value: number): void;
+    readUint16(register: number, bigEndian?: boolean): number;
+    writeUint16(register: number, value: number, bigEndian?: boolean): void;
+    readBuffer(register: number, byteLength: number): ArrayBuffer;
+    readBuffer(register: number, buffer: Buffer): void;
+    writeBuffer(register: number, buffer: Buffer): void;
+    readQuick();
+    writeQuick();
+    receiveByte(): number;
+    sendByte(command: number);
+  }
+
+  export default SMBus;
+}

package/embedded_io/socket/listener.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/socket/listener" {
+  import TCP from "embedded:io/socket/tcp"
+  class Listener {
+    constructor(options: {
+      port?: number;
+      address?: string;
+      onReadable?: (this: Listener, requests: number) => void;
+      format?: "socket/tcp";
+      target?: any;
+    })
+    read(): TCP
+    get format(): "socket/tcp"
+    set format(value: "socket/tcp")
+  }
+  export default Listener;
+}

package/embedded_io/socket/tcp.d.ts

@@ -0,0 +1,51 @@
+/*
+* 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/socket/tcp" {
+  import type { Buffer } from "embedded:io/_common";
+  class TCP {
+    constructor(options: ((({
+      address: string;
+    } | {
+      host: string;
+    }) & {
+      port: number;
+    }) | {
+      from: TCP;
+    }) & {
+      nodelay?: boolean;
+      onReadable?: (this: TCP, bytes: number) => void;
+      onWritable?: (this: TCP, bytes: number) => void;
+      onError?: (this: TCP) => void;
+      format?: "number" | "buffer";
+      target?: any;
+    })
+    readonly remoteAddress: string | undefined;
+    readonly remotePort: number | undefined;
+    read(byteLength?: number): number | ArrayBuffer;
+    read(buffer: Buffer): void;
+    write(value: number | Buffer): void;
+    close(): void;
+    get format(): "number" | "buffer"
+    set format(value: "number" | "buffer")
+  }
+
+  export default TCP;
+}

package/embedded_io/socket/udp.d.ts

@@ -0,0 +1,46 @@
+/*
+* 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/socket/udp" {
+  import type { Buffer } from "embedded:io/_common";
+  class UDP {
+    constructor(options: {
+      port?: number;
+      address?: string;
+      onReadable?: (this: UDP, packets: number) => void;
+      onError?: () => void;
+      format?: "buffer";
+      target?: any;
+    } & ({} | {
+      multicast: string;
+      timeToLive: number;
+    }))
+    write(buffer: Buffer, address: string, port: number): void;
+    read(): ArrayBuffer & {
+      address: string;
+      port: number;
+    };
+    read(buffer: Buffer);
+    get format(): "buffer"
+    set format(value: "buffer")
+  }
+
+  export default UDP
+}

package/embedded_io/spi.d.ts

@@ -0,0 +1,45 @@
+/*
+* 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/spi" {
+  import { Buffer, PinSpecifier, PortSpecifier } from "embedded:io/_common";
+  class SPI {
+    constructor(options: {
+      out?: PinSpecifier;
+      in?: PinSpecifier;
+      clock: PinSpecifier;
+      select?: PinSpecifier;
+      active?: 1 | 0;
+      hz: number;
+      mode?: number;
+      port?: PortSpecifier;
+      format?: "buffer";
+      target?: any;
+    })
+    read(byteLength: number): ArrayBuffer;
+    read(buffer: Buffer): void;
+    write(buffer: Buffer): void;
+    transfer(buffer: Buffer): void;
+    flush(deselect?: boolean): void;
+    get format(): "buffer";
+    set format(value: "buffer");
+  }
+  export default SPI;
+}