@moddable/typings 1.0.0

package/piu/shape.d.ts

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 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 "piu/shape" {
+  import { Content, ContentDictionary } from "piu/MC";
+  import { Outline } from "commodetto/outline";
+
+  interface Shape extends Content {
+    fillOutline: Outline,
+    strokeOutline: Outline,
+  }
+  interface ShapeDictionary extends ContentDictionary {
+    string?: string;
+  }
+  interface ShapeConstructor {
+    new (behaviorData: any, dictionary: ShapeDictionary): Shape;
+    (behaviorData: any, dictionary: ShapeDictionary): Shape;
+
+    template<T>(this: T, any): T;
+  }
+
+  global {
+    const Shape: ShapeConstructor
+  }
+}

package/preference.d.ts

@@ -0,0 +1,29 @@
+/*
+* 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 "preference" {
+  var Preference: {
+    set: (domain: string, key: string, value: string | boolean | number | ArrayBuffer) => void;
+    get: (domain: string, key: string) => string | boolean | number | ArrayBuffer | undefined;
+    delete: (domain: string, key: string) => void;
+    keys: (domain: string) => string[];
+  }
+  export {Preference as default};
+}

package/securesocket.d.ts

@@ -0,0 +1,38 @@
+/*
+* Copyright (c) 2023 Richard Lea
+*
+*   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 "securesocket" {
+    import { Socket } from "socket";
+
+    type WriteData = number | string | BufferLike;
+
+    export default class SecureSocket {
+        sock: typeof Socket;
+
+        constructor(dict: { [k: string]: any });
+
+        read<T extends typeof String | typeof ArrayBuffer>(
+            type: T,
+            until?: number
+        ): T extends typeof String ? string : ArrayBuffer;
+        write(data: WriteData, ...moreData: WriteData[]): void;
+        close(): void;
+    }
+}

package/sntp.d.ts

@@ -0,0 +1,42 @@
+/*
+* 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 "sntp" {
+  type SNTPOptions = {
+    host: string
+  };
+  type SNTPUnableToRetrieveTime = -1;
+  type SNTPTimeRetrieved = 1;
+  type SNTPRetry = 2;
+  type SNTPCallbackMessage = (
+    SNTPUnableToRetrieveTime |
+    SNTPTimeRetrieved |
+    SNTPRetry
+  )
+  type SNTPCallback = (message: SNTPCallbackMessage, value?: number) => void;
+  class SNTP {
+    static readonly time: SNTPTimeRetrieved;
+    static readonly retry: SNTPRetry;
+    static readonly error: SNTPUnableToRetrieveTime;
+
+    constructor(options: SNTPOptions, callback: SNTPCallback);
+  }
+  export {SNTP as default};
+}

package/socket.d.ts

@@ -0,0 +1,97 @@
+/*
+* 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 "socket" {
+  type RawSocketOptions = {
+    host?: string,
+    address?: string,
+    port: number,
+    kind: "RAW",
+    protocol?: number,
+  };
+  export type TCPSocketOptions = {
+    kind?: "TCP",
+    host?: string,
+    addresss?: string,
+    port?: number,
+    noDelay?: boolean,
+    keepalive?: {
+      idle: number,
+      interval: number,
+      count: number
+    }
+  };
+  type UDPSocketOptions = {
+    host?: string,
+    addresss?: string,
+    port: number,
+    kind: "UDP",
+  };
+  type WriteData = number | string | BufferLike;
+  
+  type MessageError = -2;
+  type MessageDisconnect = -1;
+  type MessageConnect = 1;
+  type MessageDataReceived = 2;
+  type MessageDataSent = 3;
+  type MessageStatus = (
+    MessageError |
+    MessageDisconnect |
+    MessageConnect |
+    MessageDataReceived |
+    MessageDataSent
+  );
+  abstract class SocketBase {
+    close(): void;
+    read<T extends typeof String | typeof ArrayBuffer>(
+      type: T,
+      until?: number
+    ): T extends typeof String ? string : ArrayBuffer;
+    callback: (message: MessageStatus, value?: number) => void;
+  }
+  class RawSocket extends SocketBase {
+    write(ip: string, data: ArrayBuffer);
+    write(): number;
+  }
+  class TCPSocket extends SocketBase {
+    write(data: WriteData, ...moreData: WriteData[]);
+    write(): number;
+  }
+  class UDPSocket extends SocketBase {
+    write(ip: string, port: number, data: ArrayBuffer);
+    write(): number;
+  }
+  export type ListenerOptions = {
+    port?: number,
+    address?: string
+  };
+  class Listener {
+    constructor(options: ListenerOptions);
+    callback: (this: Listener) => void;
+  }
+  var Socket: {
+    new <T extends RawSocketOptions | TCPSocketOptions | UDPSocketOptions>(
+      dictionary: T
+    ): T extends RawSocketOptions ?
+      RawSocket : T extends TCPSocketOptions ? TCPSocket : UDPSocket;
+    new ({listener: Listener}): TCPSocket;
+  };
+  export {Socket, Listener};
+}

package/structuredClone.d.ts

@@ -0,0 +1,23 @@
+/*
+* 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 "structuredClone" {
+  export default function structuredClone<T = unknown>(a: T): T
+}

package/telnet.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 "telnet" {
+  class Telnet {
+    constructor({port: number});
+    close(): void;
+  }
+  export {Telnet as default};
+}

package/text/decoder.d.ts

@@ -0,0 +1,46 @@
+/*
+* Copyright (c) 2022 Satoshi Tanaka
+*
+*   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 "text/decoder" {
+  interface TextDecoderOptions {
+    fatal?: boolean;
+    ignoreBOM?: boolean;
+  }
+  interface TextDecodeOptions {
+    stream?: boolean;
+  }
+
+  interface TextDecoder extends TextDecoderCommon {
+    decode(input?: Uint8Array | ArrayBufferLike, options?: TextDecodeOptions): string;
+  }
+
+  var TextDecoder: {
+    prototype: TextDecoder;
+    new(label?: "utf-8", options?: TextDecoderOptions): TextDecoder;
+  };
+
+  interface TextDecoderCommon {
+    readonly encoding: string;
+    readonly fatal: boolean;
+    readonly ignoreBOM: boolean;
+  }
+
+  export { TextDecoder as default };
+}

package/text/encoder.d.ts

@@ -0,0 +1,38 @@
+/*
+* Copyright (c) 2022 Satoshi Tanaka
+*
+*   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 "text/encoder" {
+
+    interface TextEncoderEncodeIntoResult {
+        read: number;
+        written: number;
+    }
+    interface TextEncoder {
+        encode(input: string): Uint8Array;
+        encodeInto(source: string, destination: Uint8Array): TextEncoderEncodeIntoResult;
+    }
+
+    var TextEncoder: {
+        prototype: TextEncoder;
+        new(): TextEncoder;
+    };
+
+    export { TextEncoder as default };
+}

package/text/index.d.ts

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

package/time.d.ts

@@ -0,0 +1,31 @@
+/*
+* 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 "time" {
+  var Time: {
+    set: (
+      seconds: number
+    ) => void,
+    timezone: number;
+    dst: number;
+    ticks: number;
+  }
+  export {Time as default};
+}

package/timer.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 "timer" {
+  export type TimerCallback = (timer: Timer) => void;
+
+  class Timer {
+    private constructor()
+    static set: (
+      callback: TimerCallback,
+      interval?: number,
+      repeat?: number
+    ) => Timer
+    static repeat: (
+      callback: TimerCallback,
+      interval: number,
+    ) => Timer
+    static schedule: (
+      timer: Timer,
+      interval?: number,
+      repeat?: number
+    ) => void;
+    static clear: (timer: Timer | undefined | null) => void;
+    static delay: (milliseconds: number) => void;
+
+    private brand: boolean;
+  }
+
+  export {Timer as default};
+}

package/uuid.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 "uuid" {
+  var UUID: () => string;
+  export {UUID as default};
+}

package/websocket.d.ts

@@ -0,0 +1,58 @@
+/*
+* 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 "websocket" {
+  import type {TCPSocketOptions, ListenerOptions} from "socket";
+
+  export type WebSocketClientOptions = TCPSocketOptions & {
+    path?: string,
+    protocol?: string,
+    headers?: string[]
+  }
+  export type WebSocketClientCallback = (message: number, value?: any) => void;
+
+  export class Client {
+    static readonly connect: number;
+    static readonly handshake: number;
+    static readonly receive: number;
+    static readonly disconnect: number;
+
+    constructor(options: WebSocketClientOptions);
+    close(): void;
+    write(data: string | ArrayBuffer);
+    callback: WebSocketClientCallback;
+  }
+
+  export type WebSocketServerOptions = ListenerOptions
+  export type WebSocketServerCallback = (message: number, value?: any) => void;
+
+  export class Server {
+    static readonly connect: number;
+    static readonly handshake: number;
+    static readonly receive: number;
+    static readonly disconnect: number;
+    static readonly subprotocol: number;
+
+    constructor(options: WebSocketServerOptions);
+    close(): void;
+    write(message: string | ArrayBuffer): void;
+    callback: WebSocketServerCallback;
+  }
+}

package/wifi.d.ts

@@ -0,0 +1,61 @@
+/*
+* 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 "wifi" {
+  export type WiFiOptions = {
+    bssid?: string,
+    ssid: string,
+    password?: string
+  }
+  export type WiFiCallback = (message: "connect" | "gotIP" | "lostIP" | "disconnect") => void
+  export type WiFiScanCallback = (item: {
+    ssid: string,
+    authentication: string,
+    rssi: number,
+    bssid: ArrayBuffer,
+  } | null) => void;
+  export type StationMode = 1;
+  export type AccessPointMode = 2;
+  export type ScanOptions = {hidden?: boolean, channel?: number}
+  export type AccessPointOptions = {
+    ssid: string,
+    password?: string,
+    channel?: number,
+    hidden?: boolean,
+    interval?: number,
+    max?: number
+  }
+
+  class WiFi {
+    static gotIP: "gotIP";
+    static lostIP: "lostIP";
+    static connected: "connect";
+    static disconnected: "disconnect";
+    
+    constructor(options: WiFiOptions, callback: WiFiCallback);
+    close(): void;
+    static scan(options: ScanOptions, callback: WiFiScanCallback): void;
+    static mode: StationMode | AccessPointMode;
+    static connect(options?: WiFiOptions): void;
+    static disconnect(): void;
+    static accessPoint(options: AccessPointOptions): void;
+  }
+  export {WiFi as default};
+}

package/worker.d.ts

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2020 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 "worker" {
+	export interface Self {
+		onmessage(message: any): void;
+		postMessage(message: any): void;
+	}
+
+	class Worker implements Self  {
+		constructor(module: string, options?: object)
+		terminate(): void;
+
+		onmessage(message: any): void;
+		postMessage(message: any): void;
+	}
+
+	export class SharedWorker {
+		constructor(module: string, options?: object)
+	}
+
+	global {
+		const self: Self
+	}
+
+	export {Worker as default}
+}