@moddable/typings 5.3.0 → 5.4.1

package/ble/gap.d.ts

@@ -0,0 +1,109 @@
+/*
+* Copyright (c) 2022 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 "gap" {
+
+  const enum gapAddressTypes {
+    PUBLIC = 0,
+    RANDOM = 1,
+    RPA_PUBLIC = 2,
+    RPA_RANDOM = 3,
+  }
+
+  export const GAP: {
+    readonly SCAN_FAST_INTERVAL: 0x0030,		// TGAP(scan_fast_interval)		30ms to 60ms
+    readonly SCAN_FAST_WINDOW: 0x0030,		// TGAP(scan_fast_window)		30ms
+    readonly SCAN_SLOW_INTERVAL1: 0x0800,		// TGAP(scan_slow_interval1)	1.28s
+    readonly SCAN_SLOW_WINDOW1: 0x0012,			// TGAP(scan_slow_window1)		11.25ms
+    readonly SCAN_SLOW_INTERVAL2: 0x1000,		// TGAP(scan_slow_interval2)	2.56s
+    readonly SCAN_SLOW_WINDOW2: 0x0024,			// TGAP(scan_slow_window2)		22.5ms
+    readonly ADV_FAST_INTERVAL1: {           // TGAP(adv_fast_interval1)		30ms to 60ms
+      min: 0x0030,
+      max: 0x0060
+    },
+    readonly ADV_FAST_INTERVAL2: {           // TGAP(adv_fast_interval2)		100ms to 150ms
+      min: 0x00A0,
+      max: 0x00F0,
+    },
+    readonly ADV_SLOW_INTERVAL: {           // TGAP(adv_slow_interval)		1s to 1.2s
+      min: 0x0640,
+      max: 0x0780,
+    },
+    readonly ADType: {
+      /* Service UUID */
+      INCOMPLETE_UUID16_LIST: 0x02,
+      COMPLETE_UUID16_LIST: 0x03,
+      INCOMPLETE_UUID128_LIST: 0x06,
+      COMPLETE_UUID128_LIST: 0x07,
+      /* Local Name */
+      SHORTENED_LOCAL_NAME: 0x08,
+      COMPLETE_LOCAL_NAME: 0x09,
+      /* Flags */
+      FLAGS: 0x01,
+      /* Manufacturer Specific Data */
+      MANUFACTURER_SPECIFIC_DATA: 0xFF,
+      /* TX Power Level */
+      TX_POWER_LEVEL: 0x0A,
+      SLAVE_CONNECTION_INTERVAL_RANGE: 0x12,
+      /* Service Solicitation */
+      SOLICITATION_UUID16_LIST: 0x14,
+      SOLICITATION_UUID128_LIST: 0x15,
+      /* Service Data */
+      SERVICE_DATA_UUID16: 0x16,
+      SERVICE_DATA_UUID128: 0x21,
+      /* Appearance */
+      APPEARANCE: 0x19,
+      /* Public Target Address */
+      PUBLIC_TARGET_ADDRESS: 0x17,
+      /* Random Target Address */
+      RANDOM_TARGET_ADDRESS: 0x18,
+      /* Advertising Interval */
+      ADVERTISING_INTERVAL: 0x1A,
+      /* LE Bluetooth Device Address */
+      LE_BLUETOOTH_DEVICE_ADDRESS: 0x1B,
+      /* LE Role */
+      LE_ROLE: 0x1C,
+      /* URI */
+      URI: 0x24,
+    },
+    MAX_AD_LENGTH: 31,
+    ADFlag: {
+      LE_LIMITED_DISCOVERABLE_MODE: 0x01,
+      LE_GENERAL_DISCOVERABLE_MODE: 0x02,
+      NO_BR_EDR: 0x04,
+      LE_BR_EDR_CONTROLLER: 0x08,
+      LE_BR_EDR_HOST: 0x10,
+    },
+    AddressType: typeof gapAddressTypes,
+    ScanFilterPolicy: {
+      NONE: 0,
+      WHITELIST: 1,
+      NOT_RESOLVED_DIRECTED: 2,
+      WHITELIST_NOT_RESOLVED_DIRECTED: 3,
+    },
+    AdvFilterPolicy: {
+      NONE: 0,
+      WHITELIST_SCANS: 1,
+      WHITELIST_CONNECTIONS: 2,
+      WHITELIST_SCANS_CONNECTIONS: 3
+    },
+  }
+  export { GAP as default };
+}

package/ble/gatt.d.ts

@@ -0,0 +1,186 @@
+/*
+* Copyright (c) 2022-2025 Richard Lea, 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 "gatt" {
+
+  import { Bytes, Advertisement } from "btutils";
+  import { GAP } from "gap";
+  import { Authorization } from "sm";
+
+  type getAddressType = (typeof GAP.AddressType);
+
+  export interface Client {
+    connection: number,
+    address: Bytes,
+    addressType: getAddressType,
+    scanResponse: Advertisement,
+    rssi: number,
+
+    /**
+     * Read the connected peripheral's signal strength.
+     * 
+     * @url https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/network/ble/ble.md#readrssi
+     */
+    readRSSI(): void;
+
+    /**
+     * Discover a single GATT primary service by UUID.
+     *
+     * @param uuid 
+     */
+    discoverPrimaryService(uuid: Bytes): void;
+
+    /**
+     * Discover all the peripheral's GATT primary services.
+     * Discovered services are returned to the `onServices` callback.
+     */
+    discoverAllPrimaryServices(): void;
+
+    /**
+     * Finds and returns the service identified by `uuid`.
+     * 
+     * @param uuid 
+     */
+    findServiceByUUID(uuid: Bytes): void;
+
+    /**
+     * Request a higher MTU once the peripheral connection has been established.
+     * @param mtu 
+     */
+    exchangeMTU(mtu: number): void
+
+    /**
+     * Terminates the peripheral function.
+     */
+    close(): void;
+  }
+
+  /**
+   * A single Peripheral GATT service.
+   */
+  export interface Service {
+    connection: number;
+    uuid: Bytes;
+    start: number;
+    end: number;
+    characteristics: Characteristic[];
+
+    /**
+     * Discover all the service characteristics. Discovered characteristics
+     * are returned to the `onCharacteristics` callback.
+     */
+    discoverAllCharacteristics(): void;
+
+    /**
+     * Discover a single service characteristic by UUID.
+     * 
+     * @param uuid 
+     * @url https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/network/ble/ble.md#discovercharacteristicuuid
+     */
+    discoverCharacteristic(uuid: Bytes): void;
+
+    /**
+     * finds and returns the characteristic identified by `uuid`. 
+     * @param uuid 
+     */
+    findCharacteristicByUUID(uuid: Bytes): void;
+  }
+
+  /**
+   * A single service Characteristic.
+   * 
+   * @url https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/network/ble/ble.md#class-characteristic
+   */
+  export interface Characteristic {
+    connection: number;
+    uuid: Bytes;
+    service: Service;
+    handle: number;
+    name: string;
+    type: string;
+    descriptors: Descriptor[];
+    properties: number;
+
+    /**
+     * Discover all the characteristic's descriptors.
+     * Discovered descriptors are returned to the `onDescriptors` callback.
+     */
+    discoverAllDescriptors(): void;
+
+    
+    /* Enable characteristic value change notifications.
+     *
+     * @url https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/network/ble/ble.md#enablenotifications
+     */
+    enableNotifications(): void;
+
+    /**
+     * Enable characteristic value change notifications.
+     *
+     * @url https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/network/ble/ble.md#enablenotifications
+     */
+    disableNotifications(): void;
+
+    /**
+     * Disable characteristic value change notifications.
+     * @param auth 
+     * @url https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/network/ble/ble.md#disablenotifications
+     */
+    readValue(auth: Authorization): void;
+
+    /**
+     * Write a characteristic value on demand.
+     * @param value 
+     * @url https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/network/ble/ble.md#writewithoutresponsevalue
+     */
+    writeWithoutResponse(value: any): void;
+  }
+
+  /**
+   * A single Characteristic descriptor.
+   * 
+   * @url https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/network/ble/ble.md#class-descriptor
+   */
+  export interface Descriptor {
+    connection: number;
+    uuid: string;
+    characteristic: Characteristic;
+    handle: number;
+    name: string;
+    type: string;
+
+    /**
+     * Read a descriptor value on demand.
+     *
+     * @param auth 
+     * @url https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/network/ble/ble.md#readvalueauth-1
+     */
+    readValue(auth?: number): void;
+
+    writeWithoutResponse(value: any): void;
+
+    /**
+     * Write a descriptor value.
+     * @param value 
+     * @url https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/network/ble/ble.md#writevaluevalue
+     */
+    writeValue(value: any): void;
+  }
+}

package/ble/sm.d.ts

@@ -0,0 +1,70 @@
+/*
+* Copyright (c) 2022-2025 Richard Lea, 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 "sm" {
+
+  import { GAP } from "gap";
+
+  type getAddressType = (typeof GAP.AddressType);
+
+  /**
+   * @url https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/network/ble/ble.md#class-sm
+   */
+  export const enum IOCapability {
+    NoInputNoOutput = 0,
+    DisplayOnly = 1,
+    KeyboardOnly = 2,
+    KeyboardDisplay = 3,
+    DisplayYesNo = 4,
+  }
+
+  export const enum Authorization {
+    None = 0,
+    NoMITM = 1,
+    MITM = 2,
+    SignedNoMITM = 3,
+    SignedMITM = 4
+  }
+
+  /**
+   * Provides objects used to configure BLE client and server security requirements
+   * and device capabilities.
+   */
+  export class SM {
+
+
+    /**
+     * Delete all bonding information and encryption keys
+     * from persistent storage.
+     * 
+     * https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/network/ble/ble.md#deleteallbondings
+     */
+    static deleteAllBondings(): void;
+
+    /**
+     * Delete stored bonding information for the peer device with the provided
+     * `address` and `addressType`.
+     * 
+     * @param address Contains peer device Bluetooth address
+     * @param addressType Peer device Bluetooth address type.
+     */
+    static deleteBonding(address: ArrayBuffer, addressType: getAddressType): void;
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@moddable/typings",
-	"version": "5.3.0",
+	"version": "5.4.1",
 	"main": "",
 	"types": [
 		"xs.d.ts",