@microbit/capacitor-community-nordic-dfu 7.0.0-microbit.1

package/dist/esm/definitions.d.ts

@@ -0,0 +1,435 @@
+import type { PluginListenerHandle, PluginResultError, PermissionState } from '@capacitor/core';
+/**
+ * Represents the current status of permissions in the plugin.
+ *
+ * @since 1.0.0
+ */
+export interface PermissionStatus {
+    /**
+     * Indicates the permission state of notifications.
+     *
+     * @since 1.0.0
+     */
+    notifications: PermissionState;
+}
+/**
+ * Enumerates the various states in the DFU process. This helps in tracking the progress and status of the
+ * firmware update.
+ *
+ * @since 1.0.0
+ */
+export declare enum DfuState {
+    /**
+     * The device is currently connecting.
+     *
+     * @since 1.0.0
+     */
+    DEVICE_CONNECTING = "DEVICE_CONNECTING",
+    /**
+     * The device has successfully connected. **Available for Android only.**
+     *
+     * @since 1.0.0
+     */
+    DEVICE_CONNECTED = "DEVICE_CONNECTED",
+    /**
+     * The DFU process is about to start.
+     *
+     * @since 1.0.0
+     */
+    DFU_PROCESS_STARTING = "DFU_PROCESS_STARTING",
+    /**
+     * The DFU process has started. **Available for Android only.**
+     *
+     * @since 1.0.0
+     */
+    DFU_PROCESS_STARTED = "DFU_PROCESS_STARTED",
+    /**
+     * The device is enabling DFU mode.
+     *
+     * @since 1.0.0
+     */
+    ENABLING_DFU_MODE = "ENABLING_DFU_MODE",
+    /**
+     * The DFU process is in progress.
+     *
+     * @since 1.0.0
+     */
+    DFU_PROGRESS = "DFU_PROGRESS",
+    /**
+     * The firmware is currently being validated.
+     *
+     * @since 1.0.0
+     */
+    VALIDATING_FIRMWARE = "VALIDATING_FIRMWARE",
+    /**
+     * The device is disconnecting.
+     *
+     * @since 1.0.0
+     */
+    DEVICE_DISCONNECTING = "DEVICE_DISCONNECTING",
+    /**
+     * The device has disconnected. **Available for Android only.**
+     *
+     * @since 1.0.0
+     */
+    DEVICE_DISCONNECTED = "DEVICE_DISCONNECTED",
+    /**
+     * The DFU process has completed successfully.
+     *
+     * @since 1.0.0
+     */
+    DFU_COMPLETED = "DFU_COMPLETED",
+    /**
+     * The DFU process has been aborted.
+     *
+     * @since 1.0.0
+     */
+    DFU_ABORTED = "DFU_ABORTED",
+    /**
+     * The DFU process has failed.
+     *
+     * @since 1.0.0
+     */
+    DFU_FAILED = "DFU_FAILED"
+}
+/**
+ * Contains data related to the DFU update process, such as progress and speed.
+ *
+ * @since 1.0.0
+ */
+export interface DfuUpdateData {
+    /**
+     * The current status of upload (0-99).
+     *
+     * @since 1.0.0
+     */
+    percent?: number;
+    /**
+     * The current speed in bytes per millisecond.
+     *
+     * @since 1.0.0
+     */
+    speed?: number;
+    /**
+     * The average speed in bytes per millisecond.
+     *
+     * @since 1.0.0
+     */
+    avgSpeed?: number;
+    /**
+     * The number of parts being sent. In case the ZIP file contains a Soft Device and/or a Bootloader together
+     * with the application the SD+BL are sent as part 1, then the service starts again and send the application
+     * as part 2.
+     *
+     * @since 1.0.0
+     */
+    currentPart?: number;
+    /**
+     * The total number of parts.
+     *
+     * @since 1.0.0
+     */
+    partsTotal?: number;
+    /**
+     * The total time elapsed since the start of the DFU process in milliseconds
+     *
+     * @since 1.1.0
+     */
+    duration?: number;
+    /**
+     * The estimated remaining time to the end of the DFU process in milliseconds
+     *
+     * @since 1.1.0
+     */
+    remainingTime?: number;
+}
+/**
+ * The DFU update object that is passed to the DFUStateChanged event
+ *
+ * @since 1.0.0
+ */
+export interface DfuUpdate {
+    /**
+     * Defines the structure for the DFU update object passed to the DFUStateChanged event.
+     *
+     * @since 1.0.0
+     */
+    state: DfuState;
+    /**
+     * The DFU data that is passed to the DfuUpdate object
+     *
+     * @since 1.0.0
+     */
+    data: DfuUpdateData;
+}
+/**
+ * Outlines additional options for configuring the DFU process.
+ *
+ * @since 1.0.0
+ */
+export interface DfuOptions {
+    /**
+     * Sets whether the progress notification in the status bar should be disabled.
+     *
+     * @default false
+     * @since 1.0.0
+     */
+    disableNotification?: boolean;
+    /**
+     * Sets whether the progress notification in the status bar should be disabled.
+     *
+     * @default  false
+     * @since 1.0.0
+     */
+    startAsForegroundService?: boolean;
+    /**
+     * Sets whether the bond information should be preserver after flashing new application.
+     *
+     * @default false
+     * @since 1.0.0
+     */
+    keepBond?: boolean;
+    /**
+     * Sets whether a new bond should be created after the DFU is complete. The old bond
+     * information will be removed before.
+     *
+     * @default false
+     * @since 1.0.0
+     */
+    restoreBond?: boolean;
+    /**
+     * Sets the initial delay (in milliseconds) that the service will wait before sending each data object.
+     *
+     * @default 0
+     * @since 1.0.0
+     */
+    dataObjectDelay?: number;
+    /**
+     * Enables or disables the Packet Receipt Notification (PRN) procedure.
+     *
+     * By default the PRNs are disabled on devices with Android Marshmallow or newer and enabled on
+     * older ones.
+     *
+     * @since 1.0.0
+     */
+    packetReceiptNotificationsEnabled?: boolean;
+    /**
+     * If Packet Receipt Notification procedure is enabled, this method sets the number of packets to be sent before
+     * receiving a PRN.
+     *
+     * @default 12
+     * @since 1.0.0
+     */
+    packetsReceiptNotificationsValue?: number;
+    /**
+     * Setting force DFU to true will prevent from jumping to the DFU Bootloader
+     * mode in case there is no DFU Version characteristic (Legacy DFU only!).
+     * Use this if the DFU operation can be handled by your device running in the application mode.
+     * This method is ignored in Secure DFU.
+     *
+     * @default false
+     * @since 1.0.0
+     */
+    forceDfu?: boolean;
+    /**
+     * Sets the time (in milliseconds) required by the device to reboot. The library will wait for this time before
+     * scanning for the device in bootloader mode.
+     *
+     * @default 0
+     * @since 1.0.0
+     */
+    rebootTime?: number;
+    /**
+     * Sets the scan duration (in milliseconds) when scanning for DFU Bootloader.
+     *
+     * @default 5000
+     * @since 1.0.0
+     */
+    scanTimeout?: number;
+    /**
+     * When this is set to true, the Legacy Buttonless Service will scan for the device advertising
+     * with an incremented MAC address, instead of trying to reconnect to the same device.
+     *
+     * @default false
+     * @since 1.0.0
+     */
+    forceScanningForNewAddressInLegacyDfu?: boolean;
+    /**
+     * This options allows to disable the resume feature in Secure DFU. When the extra value is set to true, the DFU will
+     * send Init Packet and Data again, despite the firmware might have been send partially before. By default, without
+     * setting this extra, or by setting it to false, the DFU will resume the previously cancelled upload if CRC values
+     * match.
+     *
+     * @default false
+     * @since 1.4.0
+     */
+    disableResume?: boolean;
+    /**
+     * Sets the number of retries that the DFU service will use to complete DFU.
+     *
+     * @default 0
+     * @since 1.0.0
+     */
+    numberOfRetries?: number;
+    /**
+     * Sets the Maximum Transfer Unit (MTU) value that the Secure DFU service will try to request
+     * before performing DFU. **Available for Android only.**
+     *
+     * By default, value 517 will be used, which is the highest supported y Android. However, as the
+     * highest supported MTU by the Secure DFU from SDK 15 (first which supports higher MTU) is 247,
+     * the sides will agree on using MTU = 247 instead if the phone supports it (Lollipop or newer device).
+     *
+     * @since 1.0.0
+     */
+    mtu?: number;
+    /**
+     * Sets the current MTU value. This method should be used only if the device is already
+     * connected and MTU has been requested before DFU service is started. **Available for Android only.**
+     *
+     * @default 23
+     * @since 1.0.0
+     */
+    currentMtu?: number;
+    /**
+     * Disables MTU request. **Available for Android only.**
+     *
+     * @default false
+     * @since 1.4.0
+     */
+    disableMtuRequest?: boolean;
+    /**
+     * This method allows to narrow the update to selected parts from the ZIP, for example
+     * to allow only application update from a ZIP file that has SD+BL+App. System components scope
+     * include the Softdevice and/or the Bootloader (they can't be separated as they are packed in
+     * a single bin file and the library does not know whether it contains only the softdevice,
+     * the bootloader or both) Application scope includes the application only.
+     *
+     * @since 1.0.0
+     */
+    scope?: number;
+    /**
+     * This method sets the size of an MBR (Master Boot Record). It should be used only
+     * when updating a file from a HEX file. If you use BIN or ZIP, value set here will
+     * be ignored.
+     *
+     * @default 4096
+     * @since 1.0.0
+     */
+    mbrSize?: number;
+    /**
+     * Set this flag to true to enable experimental buttonless feature in Secure DFU. When the
+     * experimental Buttonless DFU Service is found on a device, the service will use it to
+     * switch the device to the bootloader mode, connect to it in that mode and proceed with DFU.
+     *
+     * @default false
+     * @since 1.0.0
+     */
+    unsafeExperimentalButtonlessServiceInSecureDfuEnabled?: boolean;
+}
+/**
+ * Specifies the options required for initiating the DFU process.
+ *
+ * @since 1.0.0
+ */
+export interface DfuUpdateOptions {
+    /**
+     * The target device address.
+     * On **Android** this is the BLE MAC address.
+     * On **iOS** and **web** it is a randomly generated UUID identifier.
+     *
+     * @since 1.0.0
+     */
+    deviceAddress: string;
+    /**
+     * The name of the device
+     *
+     * @since 1.0.0
+     */
+    deviceName?: string;
+    /**
+     * The path to the firmware file
+     *
+     * @since 1.0.0
+     */
+    filePath: string;
+    /**
+     * The additional options for the DFU process
+     *
+     * @since 1.0.0
+     */
+    dfuOptions?: DfuOptions;
+}
+/**
+ * Defines the plugin for handling Nordic DFU processes.
+ * Includes methods to start the DFU process, check permissions, and manage event listeners.
+ *
+ * @since 1.0.0
+ */
+export interface NordicDfuPlugin {
+    /**
+     * Initiates the DFU process with the specified options.
+     *
+     * @param dfuUpdateOptions Options for the DFU process.
+     * @returns A promise that resolves on successful completion of the DFU process or rejects with a PluginResultError.
+     * @example
+     * const dfuOptions: DfuOptions = {
+     *   mtu: 23,
+     *   currentMtu: 23,
+     *   packetReceiptNotificationsEnabled: false,
+     * };
+     *
+     * const dfuUpdateOptions: DfuUpdateOptions = {
+     *   deviceAddress: this.device.deviceId,
+     *   deviceName: this.device.name,
+     *   filePath: this.file.path,
+     *   dfuOptions: dfuOptions,
+     * };
+     *
+     * NordicDfu.startDFU(dfuUpdateOptions).then(
+     *   () => console.log,
+     *   (error: PluginResultError) => console.error
+     * );
+     * @since 1.0.0
+     */
+    startDFU(dfuUpdateOptions: DfuUpdateOptions): Promise<void | PluginResultError>;
+    /**
+     * Check status of permissions needed by the plugin
+     *
+     * @example
+     * const request = await NordicDfu.checkPermissions();
+     * console.log(request)
+     * @since 1.0.0
+     */
+    checkPermissions(): Promise<PermissionStatus>;
+    /**
+     * Request permissions needed by the plugin
+     *
+     * @example
+     * const request = await NordicDfu.requestPermissions();
+     * console.log(request)
+     * @since 1.0.0
+     */
+    requestPermissions(): Promise<PermissionStatus>;
+    /**
+     * Listen for when the DFU state changes
+     *
+     * @param eventName The name of the event to listen for
+     * @param handler The handler function that will be called when the event is fired
+     * @returns A promise that resolves with a PluginListenerHandle that can be used to remove the listener
+     * @example
+     * NordicDfu.addListener('DFUStateChanged', async (update: DfuUpdate) => {
+     *   console.log(`DFU: state: ${update.state}, data: ${JSON.stringify(update.data)}`);
+     * }
+     * @since 1.0.0
+     */
+    addListener(eventName: 'DFUStateChanged', handler: (update: DfuUpdate) => void): Promise<PluginListenerHandle> & PluginListenerHandle;
+    /**
+     * Removes all listeners for the DFUStateChanged event
+     *
+     * @returns A promise that resolves when all listeners are removed
+     * @example
+     * NordicDfu.removeAllListeners();
+     * @since 1.0.0
+     */
+    removeAllListeners(): Promise<void>;
+}

package/dist/esm/definitions.js

@@ -0,0 +1,82 @@
+/**
+ * Enumerates the various states in the DFU process. This helps in tracking the progress and status of the
+ * firmware update.
+ *
+ * @since 1.0.0
+ */
+export var DfuState;
+(function (DfuState) {
+    /**
+     * The device is currently connecting.
+     *
+     * @since 1.0.0
+     */
+    DfuState["DEVICE_CONNECTING"] = "DEVICE_CONNECTING";
+    /**
+     * The device has successfully connected. **Available for Android only.**
+     *
+     * @since 1.0.0
+     */
+    DfuState["DEVICE_CONNECTED"] = "DEVICE_CONNECTED";
+    /**
+     * The DFU process is about to start.
+     *
+     * @since 1.0.0
+     */
+    DfuState["DFU_PROCESS_STARTING"] = "DFU_PROCESS_STARTING";
+    /**
+     * The DFU process has started. **Available for Android only.**
+     *
+     * @since 1.0.0
+     */
+    DfuState["DFU_PROCESS_STARTED"] = "DFU_PROCESS_STARTED";
+    /**
+     * The device is enabling DFU mode.
+     *
+     * @since 1.0.0
+     */
+    DfuState["ENABLING_DFU_MODE"] = "ENABLING_DFU_MODE";
+    /**
+     * The DFU process is in progress.
+     *
+     * @since 1.0.0
+     */
+    DfuState["DFU_PROGRESS"] = "DFU_PROGRESS";
+    /**
+     * The firmware is currently being validated.
+     *
+     * @since 1.0.0
+     */
+    DfuState["VALIDATING_FIRMWARE"] = "VALIDATING_FIRMWARE";
+    /**
+     * The device is disconnecting.
+     *
+     * @since 1.0.0
+     */
+    DfuState["DEVICE_DISCONNECTING"] = "DEVICE_DISCONNECTING";
+    /**
+     * The device has disconnected. **Available for Android only.**
+     *
+     * @since 1.0.0
+     */
+    DfuState["DEVICE_DISCONNECTED"] = "DEVICE_DISCONNECTED";
+    /**
+     * The DFU process has completed successfully.
+     *
+     * @since 1.0.0
+     */
+    DfuState["DFU_COMPLETED"] = "DFU_COMPLETED";
+    /**
+     * The DFU process has been aborted.
+     *
+     * @since 1.0.0
+     */
+    DfuState["DFU_ABORTED"] = "DFU_ABORTED";
+    /**
+     * The DFU process has failed.
+     *
+     * @since 1.0.0
+     */
+    DfuState["DFU_FAILED"] = "DFU_FAILED";
+})(DfuState || (DfuState = {}));
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAgBA;;;;;GAKG;AACH,MAAM,CAAN,IAAY,QAoFX;AApFD,WAAY,QAAQ;IAClB;;;;OAIG;IACH,mDAAuC,CAAA;IAEvC;;;;OAIG;IACH,iDAAqC,CAAA;IAErC;;;;OAIG;IACH,yDAA6C,CAAA;IAE7C;;;;OAIG;IACH,uDAA2C,CAAA;IAE3C;;;;OAIG;IACH,mDAAuC,CAAA;IAEvC;;;;OAIG;IACH,yCAA6B,CAAA;IAE7B;;;;OAIG;IACH,uDAA2C,CAAA;IAE3C;;;;OAIG;IACH,yDAA6C,CAAA;IAE7C;;;;OAIG;IACH,uDAA2C,CAAA;IAE3C;;;;OAIG;IACH,2CAA+B,CAAA;IAE/B;;;;OAIG;IACH,uCAA2B,CAAA;IAE3B;;;;OAIG;IACH,qCAAyB,CAAA;AAC3B,CAAC,EApFW,QAAQ,KAAR,QAAQ,QAoFnB","sourcesContent":["import type { PluginListenerHandle, PluginResultError, PermissionState } from '@capacitor/core';\n\n/**\n * Represents the current status of permissions in the plugin.\n *\n * @since 1.0.0\n */\nexport interface PermissionStatus {\n  /**\n   * Indicates the permission state of notifications.\n   *\n   * @since 1.0.0\n   */\n  notifications: PermissionState;\n}\n\n/**\n * Enumerates the various states in the DFU process. This helps in tracking the progress and status of the\n * firmware update.\n *\n * @since 1.0.0\n */\nexport enum DfuState {\n  /**\n   * The device is currently connecting.\n   *\n   * @since 1.0.0\n   */\n  DEVICE_CONNECTING = 'DEVICE_CONNECTING',\n\n  /**\n   * The device has successfully connected. **Available for Android only.**\n   *\n   * @since 1.0.0\n   */\n  DEVICE_CONNECTED = 'DEVICE_CONNECTED',\n\n  /**\n   * The DFU process is about to start.\n   *\n   * @since 1.0.0\n   */\n  DFU_PROCESS_STARTING = 'DFU_PROCESS_STARTING',\n\n  /**\n   * The DFU process has started. **Available for Android only.**\n   *\n   * @since 1.0.0\n   */\n  DFU_PROCESS_STARTED = 'DFU_PROCESS_STARTED',\n\n  /**\n   * The device is enabling DFU mode.\n   *\n   * @since 1.0.0\n   */\n  ENABLING_DFU_MODE = 'ENABLING_DFU_MODE',\n\n  /**\n   * The DFU process is in progress.\n   *\n   * @since 1.0.0\n   */\n  DFU_PROGRESS = 'DFU_PROGRESS',\n\n  /**\n   * The firmware is currently being validated.\n   *\n   * @since 1.0.0\n   */\n  VALIDATING_FIRMWARE = 'VALIDATING_FIRMWARE',\n\n  /**\n   * The device is disconnecting.\n   *\n   * @since 1.0.0\n   */\n  DEVICE_DISCONNECTING = 'DEVICE_DISCONNECTING',\n\n  /**\n   * The device has disconnected. **Available for Android only.**\n   *\n   * @since 1.0.0\n   */\n  DEVICE_DISCONNECTED = 'DEVICE_DISCONNECTED',\n\n  /**\n   * The DFU process has completed successfully.\n   *\n   * @since 1.0.0\n   */\n  DFU_COMPLETED = 'DFU_COMPLETED',\n\n  /**\n   * The DFU process has been aborted.\n   *\n   * @since 1.0.0\n   */\n  DFU_ABORTED = 'DFU_ABORTED',\n\n  /**\n   * The DFU process has failed.\n   *\n   * @since 1.0.0\n   */\n  DFU_FAILED = 'DFU_FAILED',\n}\n\n/**\n * Contains data related to the DFU update process, such as progress and speed.\n *\n * @since 1.0.0\n */\nexport interface DfuUpdateData {\n  /**\n   * The current status of upload (0-99).\n   *\n   * @since 1.0.0\n   */\n  percent?: number;\n\n  /**\n   * The current speed in bytes per millisecond.\n   *\n   * @since 1.0.0\n   */\n  speed?: number;\n\n  /**\n   * The average speed in bytes per millisecond.\n   *\n   * @since 1.0.0\n   */\n  avgSpeed?: number;\n\n  /**\n   * The number of parts being sent. In case the ZIP file contains a Soft Device and/or a Bootloader together\n   * with the application the SD+BL are sent as part 1, then the service starts again and send the application\n   * as part 2.\n   *\n   * @since 1.0.0\n   */\n  currentPart?: number;\n\n  /**\n   * The total number of parts.\n   *\n   * @since 1.0.0\n   */\n  partsTotal?: number;\n\n  /**\n   * The total time elapsed since the start of the DFU process in milliseconds\n   *\n   * @since 1.1.0\n   */\n  duration?: number;\n\n  /**\n   * The estimated remaining time to the end of the DFU process in milliseconds\n   *\n   * @since 1.1.0\n   */\n  remainingTime?: number;\n}\n\n/**\n * The DFU update object that is passed to the DFUStateChanged event\n *\n * @since 1.0.0\n */\nexport interface DfuUpdate {\n  /**\n   * Defines the structure for the DFU update object passed to the DFUStateChanged event.\n   *\n   * @since 1.0.0\n   */\n  state: DfuState;\n\n  /**\n   * The DFU data that is passed to the DfuUpdate object\n   *\n   * @since 1.0.0\n   */\n  data: DfuUpdateData;\n}\n\n/**\n * Outlines additional options for configuring the DFU process.\n *\n * @since 1.0.0\n */\nexport interface DfuOptions {\n  /**\n   * Sets whether the progress notification in the status bar should be disabled.\n   *\n   * @default false\n   * @since 1.0.0\n   */\n  disableNotification?: boolean;\n\n  /**\n   * Sets whether the progress notification in the status bar should be disabled.\n   *\n   * @default  false\n   * @since 1.0.0\n   */\n  startAsForegroundService?: boolean;\n\n  /**\n   * Sets whether the bond information should be preserver after flashing new application.\n   *\n   * @default false\n   * @since 1.0.0\n   */\n  keepBond?: boolean;\n\n  /**\n   * Sets whether a new bond should be created after the DFU is complete. The old bond\n   * information will be removed before.\n   *\n   * @default false\n   * @since 1.0.0\n   */\n  restoreBond?: boolean;\n\n  /**\n   * Sets the initial delay (in milliseconds) that the service will wait before sending each data object.\n   *\n   * @default 0\n   * @since 1.0.0\n   */\n  dataObjectDelay?: number;\n\n  /**\n   * Enables or disables the Packet Receipt Notification (PRN) procedure.\n   *\n   * By default the PRNs are disabled on devices with Android Marshmallow or newer and enabled on\n   * older ones.\n   *\n   * @since 1.0.0\n   */\n  packetReceiptNotificationsEnabled?: boolean;\n\n  /**\n   * If Packet Receipt Notification procedure is enabled, this method sets the number of packets to be sent before\n   * receiving a PRN.\n   *\n   * @default 12\n   * @since 1.0.0\n   */\n  packetsReceiptNotificationsValue?: number;\n\n  /**\n   * Setting force DFU to true will prevent from jumping to the DFU Bootloader\n   * mode in case there is no DFU Version characteristic (Legacy DFU only!).\n   * Use this if the DFU operation can be handled by your device running in the application mode.\n   * This method is ignored in Secure DFU.\n   *\n   * @default false\n   * @since 1.0.0\n   */\n  forceDfu?: boolean;\n\n  /**\n   * Sets the time (in milliseconds) required by the device to reboot. The library will wait for this time before\n   * scanning for the device in bootloader mode.\n   *\n   * @default 0\n   * @since 1.0.0\n   */\n  rebootTime?: number;\n\n  /**\n   * Sets the scan duration (in milliseconds) when scanning for DFU Bootloader.\n   *\n   * @default 5000\n   * @since 1.0.0\n   */\n  scanTimeout?: number;\n\n  /**\n   * When this is set to true, the Legacy Buttonless Service will scan for the device advertising\n   * with an incremented MAC address, instead of trying to reconnect to the same device.\n   *\n   * @default false\n   * @since 1.0.0\n   */\n  forceScanningForNewAddressInLegacyDfu?: boolean;\n\n  /**\n   * This options allows to disable the resume feature in Secure DFU. When the extra value is set to true, the DFU will\n   * send Init Packet and Data again, despite the firmware might have been send partially before. By default, without\n   * setting this extra, or by setting it to false, the DFU will resume the previously cancelled upload if CRC values\n   * match.\n   *\n   * @default false\n   * @since 1.4.0\n   */\n  disableResume?: boolean;\n\n  /**\n   * Sets the number of retries that the DFU service will use to complete DFU.\n   *\n   * @default 0\n   * @since 1.0.0\n   */\n  numberOfRetries?: number;\n\n  /**\n   * Sets the Maximum Transfer Unit (MTU) value that the Secure DFU service will try to request\n   * before performing DFU. **Available for Android only.**\n   *\n   * By default, value 517 will be used, which is the highest supported y Android. However, as the\n   * highest supported MTU by the Secure DFU from SDK 15 (first which supports higher MTU) is 247,\n   * the sides will agree on using MTU = 247 instead if the phone supports it (Lollipop or newer device).\n   *\n   * @since 1.0.0\n   */\n  mtu?: number;\n\n  /**\n   * Sets the current MTU value. This method should be used only if the device is already\n   * connected and MTU has been requested before DFU service is started. **Available for Android only.**\n   *\n   * @default 23\n   * @since 1.0.0\n   */\n  currentMtu?: number;\n\n  /**\n   * Disables MTU request. **Available for Android only.**\n   *\n   * @default false\n   * @since 1.4.0\n   */\n  disableMtuRequest?: boolean;\n\n  /**\n   * This method allows to narrow the update to selected parts from the ZIP, for example\n   * to allow only application update from a ZIP file that has SD+BL+App. System components scope\n   * include the Softdevice and/or the Bootloader (they can't be separated as they are packed in\n   * a single bin file and the library does not know whether it contains only the softdevice,\n   * the bootloader or both) Application scope includes the application only.\n   *\n   * @since 1.0.0\n   */\n  scope?: number;\n\n  /**\n   * This method sets the size of an MBR (Master Boot Record). It should be used only\n   * when updating a file from a HEX file. If you use BIN or ZIP, value set here will\n   * be ignored.\n   *\n   * @default 4096\n   * @since 1.0.0\n   */\n  mbrSize?: number;\n\n  /**\n   * Set this flag to true to enable experimental buttonless feature in Secure DFU. When the\n   * experimental Buttonless DFU Service is found on a device, the service will use it to\n   * switch the device to the bootloader mode, connect to it in that mode and proceed with DFU.\n   *\n   * @default false\n   * @since 1.0.0\n   */\n  unsafeExperimentalButtonlessServiceInSecureDfuEnabled?: boolean;\n}\n\n/**\n * Specifies the options required for initiating the DFU process.\n *\n * @since 1.0.0\n */\nexport interface DfuUpdateOptions {\n  /**\n   * The target device address.\n   * On **Android** this is the BLE MAC address.\n   * On **iOS** and **web** it is a randomly generated UUID identifier.\n   *\n   * @since 1.0.0\n   */\n  deviceAddress: string;\n\n  /**\n   * The name of the device\n   *\n   * @since 1.0.0\n   */\n  deviceName?: string;\n\n  /**\n   * The path to the firmware file\n   *\n   * @since 1.0.0\n   */\n  filePath: string;\n\n  /**\n   * The additional options for the DFU process\n   *\n   * @since 1.0.0\n   */\n  dfuOptions?: DfuOptions;\n}\n\n/**\n * Defines the plugin for handling Nordic DFU processes.\n * Includes methods to start the DFU process, check permissions, and manage event listeners.\n *\n * @since 1.0.0\n */\nexport interface NordicDfuPlugin {\n  /**\n   * Initiates the DFU process with the specified options.\n   *\n   * @param dfuUpdateOptions Options for the DFU process.\n   * @returns A promise that resolves on successful completion of the DFU process or rejects with a PluginResultError.\n   * @example\n   * const dfuOptions: DfuOptions = {\n   *   mtu: 23,\n   *   currentMtu: 23,\n   *   packetReceiptNotificationsEnabled: false,\n   * };\n   *\n   * const dfuUpdateOptions: DfuUpdateOptions = {\n   *   deviceAddress: this.device.deviceId,\n   *   deviceName: this.device.name,\n   *   filePath: this.file.path,\n   *   dfuOptions: dfuOptions,\n   * };\n   *\n   * NordicDfu.startDFU(dfuUpdateOptions).then(\n   *   () => console.log,\n   *   (error: PluginResultError) => console.error\n   * );\n   * @since 1.0.0\n   */\n  startDFU(dfuUpdateOptions: DfuUpdateOptions): Promise<void | PluginResultError>;\n\n  /**\n   * Check status of permissions needed by the plugin\n   *\n   * @example\n   * const request = await NordicDfu.checkPermissions();\n   * console.log(request)\n   * @since 1.0.0\n   */\n  checkPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Request permissions needed by the plugin\n   *\n   * @example\n   * const request = await NordicDfu.requestPermissions();\n   * console.log(request)\n   * @since 1.0.0\n   */\n  requestPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Listen for when the DFU state changes\n   *\n   * @param eventName The name of the event to listen for\n   * @param handler The handler function that will be called when the event is fired\n   * @returns A promise that resolves with a PluginListenerHandle that can be used to remove the listener\n   * @example\n   * NordicDfu.addListener('DFUStateChanged', async (update: DfuUpdate) => {\n   *   console.log(`DFU: state: ${update.state}, data: ${JSON.stringify(update.data)}`);\n   * }\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'DFUStateChanged',\n    handler: (update: DfuUpdate) => void,\n  ): Promise<PluginListenerHandle> & PluginListenerHandle;\n\n  /**\n   * Removes all listeners for the DFUStateChanged event\n   *\n   * @returns A promise that resolves when all listeners are removed\n   * @example\n   * NordicDfu.removeAllListeners();\n   * @since 1.0.0\n   */\n  removeAllListeners(): Promise<void>;\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { NordicDfuPlugin } from './definitions';
+declare const NordicDfu: NordicDfuPlugin;
+export * from './definitions';
+export { NordicDfu };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const NordicDfu = registerPlugin('NordicDfu', {
+    web: () => import('./web').then((m) => new m.NordicDfuWeb()),
+});
+export * from './definitions';
+export { NordicDfu };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,SAAS,GAAG,cAAc,CAAkB,WAAW,EAAE;IAC7D,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,CAAC;CAC7D,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { NordicDfuPlugin } from './definitions';\n\nconst NordicDfu = registerPlugin<NordicDfuPlugin>('NordicDfu', {\n  web: () => import('./web').then((m) => new m.NordicDfuWeb()),\n});\n\nexport * from './definitions';\nexport { NordicDfu };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,9 @@
+import { WebPlugin, type PluginResultError, type ListenerCallback, type PluginListenerHandle } from '@capacitor/core';
+import type { DfuUpdateOptions, NordicDfuPlugin, PermissionStatus } from './definitions';
+export declare class NordicDfuWeb extends WebPlugin implements NordicDfuPlugin {
+    removeAllListeners(): Promise<void>;
+    startDFU(_dfuUpdateOptions: DfuUpdateOptions): Promise<void | PluginResultError>;
+    checkPermissions(): Promise<PermissionStatus>;
+    requestPermissions(): Promise<PermissionStatus>;
+    addListener(_eventName: string, _listenerFunc: ListenerCallback): Promise<PluginListenerHandle> & PluginListenerHandle;
+}

package/dist/esm/web.js

@@ -0,0 +1,20 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { WebPlugin } from '@capacitor/core';
+export class NordicDfuWeb extends WebPlugin {
+    removeAllListeners() {
+        throw this.unavailable('Method not available in this browser.');
+    }
+    startDFU(_dfuUpdateOptions) {
+        throw this.unavailable('Method not available in this browser.');
+    }
+    checkPermissions() {
+        throw this.unavailable('Method not available in this browser.');
+    }
+    requestPermissions() {
+        throw this.unavailable('Method not available in this browser.');
+    }
+    addListener(_eventName, _listenerFunc) {
+        throw this.unavailable('Method not available in this browser.');
+    }
+}
+//# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,EAAE,SAAS,EAA4E,MAAM,iBAAiB,CAAC;AAItH,MAAM,OAAO,YAAa,SAAQ,SAAS;IACzC,kBAAkB;QAChB,MAAM,IAAI,CAAC,WAAW,CAAC,uCAAuC,CAAC,CAAC;IAClE,CAAC;IACD,QAAQ,CAAC,iBAAmC;QAC1C,MAAM,IAAI,CAAC,WAAW,CAAC,uCAAuC,CAAC,CAAC;IAClE,CAAC;IACD,gBAAgB;QACd,MAAM,IAAI,CAAC,WAAW,CAAC,uCAAuC,CAAC,CAAC;IAClE,CAAC;IACD,kBAAkB;QAChB,MAAM,IAAI,CAAC,WAAW,CAAC,uCAAuC,CAAC,CAAC;IAClE,CAAC;IACD,WAAW,CACT,UAAkB,EAClB,aAA+B;QAE/B,MAAM,IAAI,CAAC,WAAW,CAAC,uCAAuC,CAAC,CAAC;IAClE,CAAC;CACF","sourcesContent":["/* eslint-disable @typescript-eslint/no-unused-vars */\nimport { WebPlugin, type PluginResultError, type ListenerCallback, type PluginListenerHandle } from '@capacitor/core';\n\nimport type { DfuUpdateOptions, NordicDfuPlugin, PermissionStatus } from './definitions';\n\nexport class NordicDfuWeb extends WebPlugin implements NordicDfuPlugin {\n  removeAllListeners(): Promise<void> {\n    throw this.unavailable('Method not available in this browser.');\n  }\n  startDFU(_dfuUpdateOptions: DfuUpdateOptions): Promise<void | PluginResultError> {\n    throw this.unavailable('Method not available in this browser.');\n  }\n  checkPermissions(): Promise<PermissionStatus> {\n    throw this.unavailable('Method not available in this browser.');\n  }\n  requestPermissions(): Promise<PermissionStatus> {\n    throw this.unavailable('Method not available in this browser.');\n  }\n  addListener(\n    _eventName: string,\n    _listenerFunc: ListenerCallback,\n  ): Promise<PluginListenerHandle> & PluginListenerHandle {\n    throw this.unavailable('Method not available in this browser.');\n  }\n}\n"]}