@capacitor-community/stripe-terminal 6.1.0 → 6.2.1

package/dist/docs.json

@@ -77,16 +77,21 @@
       },
       {
         "name": "connectReader",
-        "signature": "(options: { reader: ReaderInterface; }) => Promise<void>",
+        "signature": "(options: { reader: ReaderInterface; autoReconnectOnUnexpectedDisconnect?: boolean; merchantDisplayName?: string; onBehalfOf?: string; }) => Promise<void>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "{ reader: ReaderInterface; }"
+            "type": "{ reader: ReaderInterface; autoReconnectOnUnexpectedDisconnect?: boolean | undefined; merchantDisplayName?: string | undefined; onBehalfOf?: string | undefined; }"
           }
         ],
         "returns": "Promise<void>",
-        "tags": [],
+        "tags": [
+          {
+            "name": "param",
+            "text": "options.autoReconnectOnUnexpectedDisconnect If true, the SDK will automatically attempt to reconnect to the reader. default is false."
+          }
+        ],
         "docs": "",
         "complexTypes": [
           "ReaderInterface"
@@ -161,6 +166,74 @@
         "complexTypes": [],
         "slug": "confirmpaymentintent"
       },
+      {
+        "name": "installAvailableUpdate",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "installavailableupdate"
+      },
+      {
+        "name": "cancelInstallUpdate",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "cancelinstallupdate"
+      },
+      {
+        "name": "setReaderDisplay",
+        "signature": "(options: Cart) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "Cart"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "Cart"
+        ],
+        "slug": "setreaderdisplay"
+      },
+      {
+        "name": "clearReaderDisplay",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "clearreaderdisplay"
+      },
+      {
+        "name": "rebootReader",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "rebootreader"
+      },
+      {
+        "name": "cancelReaderReconnection",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "cancelreaderreconnection"
+      },
       {
         "name": "addListener",
         "signature": "(eventName: TerminalEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>",
@@ -652,6 +725,81 @@
           "PaymentStatus"
         ],
         "slug": "addlistenerterminaleventsenumpaymentstatuschange"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: TerminalEventsEnum.ReaderReconnectStarted, listenerFunc: ({ reader, reason, }: { reader: ReaderInterface; reason: string; }) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "TerminalEventsEnum.ReaderReconnectStarted"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "({ reader, reason, }: { reader: ReaderInterface; reason: string; }) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "TerminalEventsEnum",
+          "ReaderInterface"
+        ],
+        "slug": "addlistenerterminaleventsenumreaderreconnectstarted"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: TerminalEventsEnum.ReaderReconnectSucceeded, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "TerminalEventsEnum.ReaderReconnectSucceeded"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "({ reader }: { reader: ReaderInterface; }) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "TerminalEventsEnum",
+          "ReaderInterface"
+        ],
+        "slug": "addlistenerterminaleventsenumreaderreconnectsucceeded"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: TerminalEventsEnum.ReaderReconnectFailed, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "TerminalEventsEnum.ReaderReconnectFailed"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "({ reader }: { reader: ReaderInterface; }) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "TerminalEventsEnum",
+          "ReaderInterface"
+        ],
+        "slug": "addlistenerterminaleventsenumreaderreconnectfailed"
       }
     ],
     "properties": [
@@ -700,6 +848,210 @@
     }
   ],
   "enums": [
+    {
+      "name": "BatteryStatus",
+      "slug": "batterystatus",
+      "members": [
+        {
+          "name": "Unknown",
+          "value": "'UNKNOWN'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "Critical",
+          "value": "'CRITICAL'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "Low",
+          "value": "'LOW'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "Nominal",
+          "value": "'NOMINAL'",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    },
+    {
+      "name": "UpdateTimeEstimate",
+      "slug": "updatetimeestimate",
+      "members": [
+        {
+          "name": "LessThanOneMinute",
+          "value": "'LESS_THAN_ONE_MINUTE'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "OneToTwoMinutes",
+          "value": "'ONE_TO_TWO_MINUTES'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "TwoToFiveMinutes",
+          "value": "'TWO_TO_FIVE_MINUTES'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "FiveToFifteenMinutes",
+          "value": "'FIVE_TO_FIFTEEN_MINUTES'",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    },
+    {
+      "name": "NetworkStatus",
+      "slug": "networkstatus",
+      "members": [
+        {
+          "name": "Unknown",
+          "value": "'UNKNOWN'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "Online",
+          "value": "'ONLINE'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "Offline",
+          "value": "'OFFLINE'",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    },
+    {
+      "name": "LocationStatus",
+      "slug": "locationstatus",
+      "members": [
+        {
+          "name": "NotSet",
+          "value": "'NOT_SET'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "Set",
+          "value": "'SET'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "Unknown",
+          "value": "'UNKNOWN'",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    },
+    {
+      "name": "DeviceType",
+      "slug": "devicetype",
+      "members": [
+        {
+          "name": "cotsDevice",
+          "value": "'cotsDevice'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "wisePad3s",
+          "value": "'wisePad3s'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "appleBuiltIn",
+          "value": "'appleBuiltIn'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "chipper1X",
+          "value": "'chipper1X'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "chipper2X",
+          "value": "'chipper2X'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "etna",
+          "value": "'etna'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "stripeM2",
+          "value": "'stripeM2'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "stripeS700",
+          "value": "'stripeS700'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "stripeS700DevKit",
+          "value": "'stripeS700Devkit'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "verifoneP400",
+          "value": "'verifoneP400'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "wiseCube",
+          "value": "'wiseCube'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "wisePad3",
+          "value": "'wisePad3'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "wisePosE",
+          "value": "'wisePosE'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "wisePosEDevKit",
+          "value": "'wisePosEDevkit'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "unknown",
+          "value": "'unknown'",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    },
     {
       "name": "TerminalConnectTypes",
       "slug": "terminalconnecttypes",
@@ -1081,6 +1433,24 @@
           "value": "'terminalPaymentStatusChange'",
           "tags": [],
           "docs": ""
+        },
+        {
+          "name": "ReaderReconnectStarted",
+          "value": "'terminalReaderReconnectStarted'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "ReaderReconnectSucceeded",
+          "value": "'terminalReaderReconnectSucceeded'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "ReaderReconnectFailed",
+          "value": "'terminalReaderReconnectFailed'",
+          "tags": [],
+          "docs": ""
         }
       ]
     },
@@ -1162,66 +1532,6 @@
         }
       ]
     },
-    {
-      "name": "UpdateTimeEstimate",
-      "slug": "updatetimeestimate",
-      "members": [
-        {
-          "name": "LessThanOneMinute",
-          "value": "'LESS_THAN_ONE_MINUTE'",
-          "tags": [],
-          "docs": ""
-        },
-        {
-          "name": "OneToTwoMinutes",
-          "value": "'ONE_TO_TWO_MINUTES'",
-          "tags": [],
-          "docs": ""
-        },
-        {
-          "name": "TwoToFiveMinutes",
-          "value": "'TWO_TO_FIVE_MINUTES'",
-          "tags": [],
-          "docs": ""
-        },
-        {
-          "name": "FiveToFifteenMinutes",
-          "value": "'FIVE_TO_FIFTEEN_MINUTES'",
-          "tags": [],
-          "docs": ""
-        }
-      ]
-    },
-    {
-      "name": "BatteryStatus",
-      "slug": "batterystatus",
-      "members": [
-        {
-          "name": "Unknown",
-          "value": "'UNKNOWN'",
-          "tags": [],
-          "docs": ""
-        },
-        {
-          "name": "Critical",
-          "value": "'CRITICAL'",
-          "tags": [],
-          "docs": ""
-        },
-        {
-          "name": "Low",
-          "value": "'LOW'",
-          "tags": [],
-          "docs": ""
-        },
-        {
-          "name": "Nominal",
-          "value": "'NOMINAL'",
-          "tags": [],
-          "docs": ""
-        }
-      ]
-    },
     {
       "name": "ReaderEvent",
       "slug": "readerevent",
@@ -1392,8 +1702,15 @@
       "docs": "",
       "types": [
         {
-          "text": "{\n  index: number;\n  serialNumber: string;\n}",
-          "complexTypes": []
+          "text": "{\n  /**\n   * The unique serial number is primary identifier inner plugin.\n   */\n  serialNumber: string;\n\n  label: string;\n  batteryLevel: number;\n  batteryStatus: BatteryStatus;\n  simulated: boolean;\n  id: number;\n  availableUpdate: ReaderSoftwareUpdateInterface | undefined;\n  locationId: string;\n  ipAddress: string;\n  status: NetworkStatus;\n  location: LocationInterface | undefined;\n  locationStatus: LocationStatus;\n  deviceType: DeviceType;\n  deviceSoftwareVersion: string | null;\n\n  /**\n   * iOS Only properties. These properties are not available on Android.\n   */\n  isCharging: number;\n\n  /**\n   * Android Only properties. These properties are not available on iOS.\n   */\n  baseUrl: string;\n  bootloaderVersion: string;\n  configVersion: string;\n  emvKeyProfileId: string;\n  firmwareVersion: string;\n  hardwareVersion: string;\n  macKeyProfileId: string;\n  pinKeyProfileId: string;\n  trackKeyProfileId: string;\n  settingsVersion: string;\n  pinKeysetId: string;\n\n  /**\n   * @deprecated This property has been deprecated and should use the `serialNumber` property.\n   */\n  index?: number;\n}",
+          "complexTypes": [
+            "BatteryStatus",
+            "ReaderSoftwareUpdateInterface",
+            "NetworkStatus",
+            "LocationInterface",
+            "LocationStatus",
+            "DeviceType"
+          ]
         }
       ]
     },
@@ -1403,12 +1720,60 @@
       "docs": "",
       "types": [
         {
-          "text": "{\n  version: string;\n  settingsVersion: string;\n  requiredAt: number;\n  timeEstimate: UpdateTimeEstimate;\n}",
+          "text": "{\n  deviceSoftwareVersion: string;\n  estimatedUpdateTime: UpdateTimeEstimate;\n  requiredAt: number;\n}",
           "complexTypes": [
             "UpdateTimeEstimate"
           ]
         }
       ]
+    },
+    {
+      "name": "LocationInterface",
+      "slug": "locationinterface",
+      "docs": "",
+      "types": [
+        {
+          "text": "{\n  id: string;\n  displayName: string;\n  address: {\n    city: string;\n    country: string;\n    postalCode: string;\n    line1: string;\n    line2: string;\n    state: string;\n  };\n  ipAddress: string;\n}",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "DeviceType",
+      "slug": "devicetype",
+      "docs": "",
+      "types": [
+        {
+          "text": "Stripe.Terminal.Reader.DeviceType",
+          "complexTypes": [
+            "Stripe"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Cart",
+      "slug": "cart",
+      "docs": "",
+      "types": [
+        {
+          "text": "{\n  currency: string;\n  tax: number;\n  total: number;\n  lineItems: CartLineItem[];\n}",
+          "complexTypes": [
+            "CartLineItem"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "CartLineItem",
+      "slug": "cartlineitem",
+      "docs": "",
+      "types": [
+        {
+          "text": "{\n  displayName: string;\n  quantity: number;\n  amount: number;\n}",
+          "complexTypes": []
+        }
+      ]
     }
   ],
   "pluginConfigs": []

package/dist/esm/definitions.d.ts

@@ -1,15 +1,75 @@
 import type { PluginListenerHandle } from '@capacitor/core';
 import type { TerminalEventsEnum } from './events.enum';
-import type { TerminalConnectTypes, UpdateTimeEstimate, SimulateReaderUpdate, SimulatedCardType, BatteryStatus, ReaderEvent, ReaderDisplayMessage, ReaderInputOption, PaymentStatus, DisconnectReason, ConnectionStatus } from './stripe.enum';
+import type { TerminalConnectTypes, UpdateTimeEstimate, SimulateReaderUpdate, SimulatedCardType, BatteryStatus, ReaderEvent, ReaderDisplayMessage, ReaderInputOption, PaymentStatus, DisconnectReason, ConnectionStatus, NetworkStatus, LocationStatus, DeviceType } from './stripe.enum';
 export declare type ReaderInterface = {
-    index: number;
+    /**
+     * The unique serial number is primary identifier inner plugin.
+     */
     serialNumber: string;
+    label: string;
+    batteryLevel: number;
+    batteryStatus: BatteryStatus;
+    simulated: boolean;
+    id: number;
+    availableUpdate: ReaderSoftwareUpdateInterface | undefined;
+    locationId: string;
+    ipAddress: string;
+    status: NetworkStatus;
+    location: LocationInterface | undefined;
+    locationStatus: LocationStatus;
+    deviceType: DeviceType;
+    deviceSoftwareVersion: string | null;
+    /**
+     * iOS Only properties. These properties are not available on Android.
+     */
+    isCharging: number;
+    /**
+     * Android Only properties. These properties are not available on iOS.
+     */
+    baseUrl: string;
+    bootloaderVersion: string;
+    configVersion: string;
+    emvKeyProfileId: string;
+    firmwareVersion: string;
+    hardwareVersion: string;
+    macKeyProfileId: string;
+    pinKeyProfileId: string;
+    trackKeyProfileId: string;
+    settingsVersion: string;
+    pinKeysetId: string;
+    /**
+     * @deprecated This property has been deprecated and should use the `serialNumber` property.
+     */
+    index?: number;
+};
+export declare type LocationInterface = {
+    id: string;
+    displayName: string;
+    address: {
+        city: string;
+        country: string;
+        postalCode: string;
+        line1: string;
+        line2: string;
+        state: string;
+    };
+    ipAddress: string;
 };
 export declare type ReaderSoftwareUpdateInterface = {
-    version: string;
-    settingsVersion: string;
+    deviceSoftwareVersion: string;
+    estimatedUpdateTime: UpdateTimeEstimate;
     requiredAt: number;
-    timeEstimate: UpdateTimeEstimate;
+};
+export declare type CartLineItem = {
+    displayName: string;
+    quantity: number;
+    amount: number;
+};
+export declare type Cart = {
+    currency: string;
+    tax: number;
+    total: number;
+    lineItems: CartLineItem[];
 };
 export * from './events.enum';
 export * from './stripe.enum';
@@ -35,8 +95,21 @@ export interface StripeTerminalPlugin {
         simulatedCard?: SimulatedCardType;
         simulatedTipAmount?: number;
     }): Promise<void>;
+    /**
+     * @param options.autoReconnectOnUnexpectedDisconnect If true, the SDK will automatically attempt to reconnect to the reader. default is false.
+     */
     connectReader(options: {
         reader: ReaderInterface;
+        autoReconnectOnUnexpectedDisconnect?: boolean;
+        /**
+         * iOS and LocalMobileReader only. Android needs to be set to PaymentIntent only.
+         */
+        merchantDisplayName?: string;
+        /**
+         * iOS and LocalMobileReader only. Android needs to be set to PaymentIntent only.
+         * The Stripe account ID for which these funds are intended.
+         */
+        onBehalfOf?: string;
     }): Promise<void>;
     getConnectedReader(): Promise<{
         reader: ReaderInterface | null;
@@ -48,6 +121,12 @@ export interface StripeTerminalPlugin {
     }): Promise<void>;
     cancelCollectPaymentMethod(): Promise<void>;
     confirmPaymentIntent(): Promise<void>;
+    installAvailableUpdate(): Promise<void>;
+    cancelInstallUpdate(): Promise<void>;
+    setReaderDisplay(options: Cart): Promise<void>;
+    clearReaderDisplay(): Promise<void>;
+    rebootReader(): Promise<void>;
+    cancelReaderReconnection(): Promise<void>;
     addListener(eventName: TerminalEventsEnum.Loaded, listenerFunc: () => void): Promise<PluginListenerHandle>;
     addListener(eventName: TerminalEventsEnum.RequestedConnectionToken, listenerFunc: () => void): Promise<PluginListenerHandle>;
     addListener(eventName: TerminalEventsEnum.DiscoveredReaders, listenerFunc: ({ readers }: {
@@ -212,6 +291,16 @@ export interface StripeTerminalPlugin {
     addListener(eventName: TerminalEventsEnum.PaymentStatusChange, listenerFunc: ({ status }: {
         status: PaymentStatus;
     }) => void): Promise<PluginListenerHandle>;
+    addListener(eventName: TerminalEventsEnum.ReaderReconnectStarted, listenerFunc: ({ reader, reason, }: {
+        reader: ReaderInterface;
+        reason: string;
+    }) => void): Promise<PluginListenerHandle>;
+    addListener(eventName: TerminalEventsEnum.ReaderReconnectSucceeded, listenerFunc: ({ reader }: {
+        reader: ReaderInterface;
+    }) => void): Promise<PluginListenerHandle>;
+    addListener(eventName: TerminalEventsEnum.ReaderReconnectFailed, listenerFunc: ({ reader }: {
+        reader: ReaderInterface;
+    }) => void): Promise<PluginListenerHandle>;
     /**
      * @deprecated
      * This method has been deprecated and replaced by the `collectPaymentMethod`.