thunderbird-account-qr-code 1.0.1 → 1.1.0

package/README.md

@@ -1,7 +1,7 @@
 # Thunderbird account QR code
 [![codecov](https://codecov.io/gh/freaktechnik/thunderbird-account-qr-code/graph/badge.svg?token=HGWPlqqIdA)](https://codecov.io/gh/freaktechnik/thunderbird-account-qr-code)
 
-Thunderbird for Android allows importing accounts through a QR code. This allows easy transmission of account configuration details. The goal of this library is to help with generating such QR codes by formatting the information as required by the [format for Thunderbird for Android](https://github.com/thunderbird/thunderbird-android/blob/8c2c036d36344f56128fcad77a5f355336ad67cc/feature/migration/qrcode/qr-code-format.md).
+Thunderbird for Android allows [importing accounts through a QR code](https://support.mozilla.org/kb/thunderbird-android-import#w_import-the-desktop-settings-into-thunderbird-for-android). This allows easy transmission of account configuration details. The goal of this library is to help with generating such QR codes by formatting the information as required by the [format for Thunderbird for Android](https://github.com/thunderbird/thunderbird-android/blob/8c2c036d36344f56128fcad77a5f355336ad67cc/feature/migration/qrcode/qr-code-format.md).
 
 It does, however, not include any actual QR generation capabilities, you can choose almost any library that can encode an arbitrary string as data. Note that you might have to appropriately encode the string first, so UTF-8 code points are properly transmitted.
 
@@ -43,7 +43,7 @@ const qrInput = encodeAccounts([ {
 
 ## Example usage
 
-You can find the example provided in the `exmample` directory hosted at https://lab.humanoids.be/thunderbird-account-qr-code/example.
+You can find the example provided in the `example` directory hosted at https://lab.humanoids.be/thunderbird-account-qr-code/example.
 
 ## License
 

package/index.js

@@ -113,10 +113,6 @@ function optionalArrayItems(condition, items) {
     return items;
 }
 
-function isEmptyValue(value) {
-    return !value && (value === null || value === "");
-}
-
 /**
  * Build the IncomingServer element.
  *
@@ -124,6 +120,24 @@ function isEmptyValue(value) {
  * @returns {any[]}
  */
 function getIncomingServer(accountInfo) {
+    let { incomingAccountName } = accountInfo;
+    // If the account name is omitted, the email address of the first
+    // identity is used.
+    if(accountInfo.incomingAccountName === accountInfo.identityEmailAddress) {
+        incomingAccountName = "";
+    }
+    // null is treated the same as an empty string, and the empty string is
+    // shorter in JSON.
+    if(accountInfo.incomingAccountName === null) {
+        incomingAccountName = "";
+    }
+    // The account name and password section should be omitted
+    const shouldIncludeAccountNameAndPassword = accountInfo.incomingPassword || incomingAccountName;
+
+    // Make sure we have a valid empty value if we're providing a password.
+    if(incomingAccountName === undefined && shouldIncludeAccountNameAndPassword) {
+        incomingAccountName = "";
+    }
     return [
         accountInfo.incomingProtocol,
         accountInfo.incomingHostname,
@@ -131,8 +145,8 @@ function getIncomingServer(accountInfo) {
         accountInfo.incomingConnectionSecurity,
         accountInfo.incomingAuthenticationType,
         accountInfo.incomingUsername,
-        ...optionalArrayItems(accountInfo.incomingAccountName || isEmptyValue(accountInfo.incomingAccountName), [
-            accountInfo.incomingAccountName,
+        ...optionalArrayItems(shouldIncludeAccountNameAndPassword, [
+            incomingAccountName,
             ...optionalArrayItems(accountInfo.incomingPassword, [ accountInfo.incomingPassword ]),
         ]),
     ];
@@ -212,10 +226,10 @@ function getAccountArrays(accountInfo) {
  *
  * @param {AccountInfo[]} accountInfos
  * @param {number} [sequenceNumber=1] - The (1-based) position of this QR code
- * in a sequence of QR codes. When only transmitting a single account this can
- * be safely omitted.
+ *   in a sequence of QR codes. When only transmitting a single account this can
+ *   be safely omitted.
  * @param {number} [sequenceTotal=1] - The total QR codes in the sequence. When
- * only transmitting a single account this can be safely omitted.
+ *   only transmitting a single account this can be safely omitted.
  * @returns {string}
  */
 /* eslint-enable no-secrets/no-secrets */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "thunderbird-account-qr-code",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Encode E-Mail account info in a QR code for import in Thunderbird for Android\"",
   "main": "index.js",
   "type": "module",