Skip to content

Commit f21d5ef

Browse files
committed
fix: revert changelog linting
1 parent 4346a6f commit f21d5ef

File tree

1 file changed

+16
-49
lines changed

1 file changed

+16
-49
lines changed

CHANGELOG.md

Lines changed: 16 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,26 @@
11
## 1.3.21
2-
32
## Fixes
4-
53
- Fixes an issue where react native components that use safe-area-context or react-navigation throw an error because the sdk's components try and use its own local node_modules instead of the consumer's project.
64

75
## 1.3.20
8-
96
## Fixes
10-
117
- Fixes an issue where the iOS SDK incorrectly targeted the latest minor version instead of a fixed version, potentially causing breaking changes.
128

139
## 1.3.19
14-
1510
## Updates
16-
1711
- updates to RN version 0.68.0 to address various security vulnerabilities
1812

1913
## 1.3.18
20-
2114
## Updates
22-
2315
- adds user id login for sample apps
2416
- version mapping to newest native SDK versions
2517
- updates versions of various package dependencies
2618

2719
## 1.3.17
28-
2920
## Fixed
30-
3121
- Fixes a specific Android issue where apps could crash due to EncryptedSharedPreference being null.
3222

3323
## 1.3.16
34-
3524
## Updates
3625

3726
This release allows you to use projects hosted on Iterable's EU data center. If your project is hosted on Iterable's [European data center (EUDC)](https://support.iterable.com/hc/articles/17572750887444), configure the SDK to use Iterable's EU-based API endpoints:
@@ -40,63 +29,54 @@ This release allows you to use projects hosted on Iterable's EU data center. If
4029
const config = new IterableConfig();
4130
// ... other configuration options ...
4231
config.dataRegion = IterableDataRegion.EU;
43-
Iterable.initialize("<YOUR_API_KEY>", config);
32+
Iterable.initialize('<YOUR_API_KEY>', config);
4433
```
4534

4635
## Fixed
47-
4836
- Addressed push notification deep linking issues on Android where the app would restart instead of resuming the last activity upon being backgrounded.
4937
- Resolves an additional push notification problem on Android wherein the customActionHandler and urlHandler were not being invoked in specific scenarios, as documented in issue #470. (Credit to @tnortman-jabra for the report and the fix)
5038

5139
## 1.3.15
52-
5340
## Updates
54-
5541
- Resolves Android build issues caused in 1.3.14
5642
- Fixes a specific Android issue where custom action handlers were not invoked when tapping on push notification when the app is in background.
5743

5844
## 1.3.14
59-
6045
> **Warning**
6146
> This version causes build failure on Android. Please use 1.3.15 which fixes this issue.
62-
6347
## updates
64-
6548
- updates `Iterable.setEmail` and `Iterable.setUserId` to take in null parameter type
6649
- fixes `Iterable.updateUser` on the Android side to merge nested objects in the user profile when `mergeNestedObjects` is set to true
6750

6851
## 1.3.9
69-
7052
### Added
7153

72-
[Version 1.3.9](https://github.com/Iterable/react-native-sdk/releases/tag/1.3.9) of Iterable's React Native SDK makes it possible for iOS apps to store in- app messages in memory, rather than in an unencrypted local file. ([Version 1.3.7](https://github.com/Iterable/react-native-sdk/releases/tag/1.3.7) added this same support for Android.)
54+
[Version 1.3.9](https://github.com/Iterable/react-native-sdk/releases/tag/1.3.9) of Iterable's React Native SDK makes it possible for iOS apps to store in- app messages in memory, rather than in an unencrypted local file. ([Version 1.3.7](https://github.com/Iterable/react-native-sdk/releases/tag/1.3.7) added this same support for Android.)
7355

7456
To store in-app messages in memory on both iOS and Android, set `useInMemoryStorageForInApps` to `true`:
7557

7658
```javascript
7759
const config = new IterableConfig();
7860
// ... other configuration options ...
7961
config.useInMemoryStorageForInApps = true;
80-
Iterable.initialize("<YOUR_API_KEY>", config);
62+
Iterable.initialize('<YOUR_API_KEY>', config);
8163
```
8264

83-
This release deprecates `androidSdkUseInMemoryStorageForInApps`, which was introduced in version 1.3.7, and replaces it with `useInMemoryStorageForInApps`. However, for now:
65+
This release deprecates `androidSdkUseInMemoryStorageForInApps`, which was introduced in version 1.3.7, and replaces it with `useInMemoryStorageForInApps`. However, for now:
8466

85-
- Android apps store in-app messages in memory if `useInMemoryStorageForInApps` is `true`, `androidSdkUseInMemoryStorageForInApps` is `true`, or if both are `true`.
67+
- Android apps store in-app messages in memory if `useInMemoryStorageForInApps` is `true`, `androidSdkUseInMemoryStorageForInApps` is `true`, or if both are `true`.
8668

8769
- iOS apps store in-app messages in memory if `useInMemoryStorageForInApps` is `true`. `androidSdkUseInMemoryStorageForInApps` does not affect iOS apps.
8870

8971
When you can, please update your apps to use `useInMemoryStorageForInApps` instead of `androidSdkUseInMemoryStorageForInApps`.
9072

91-
When users upgrade to a version of your iOS or Android app that uses this version of the SDK (or higher), and they've enabled in-app memory storage, the local file used for in-app message storage (if it already exists) is deleted. However, no data is lost.
73+
When users upgrade to a version of your iOS or Android app that uses this version of the SDK (or higher), and they've enabled in-app memory storage, the local file used for in-app message storage (if it already exists) is deleted. However, no data is lost.
9274

9375
## 1.3.7
94-
9576
Starting with this release, as a privacy enhancement, Iterable’s React Native
9677
SDK encrypts some data stored at rest.
9778

9879
#### iOS updates
99-
10080
In iOS apps, Iterable's React Native SDK now encrypts the following fields when
10181
storing them at rest:
10282

@@ -110,7 +90,7 @@ storing them at rest:
11090
messages at rest—before or after this update.)
11191

11292
When a user upgrades to a version of your app that uses this version of the SDK
113-
(or higher), the fields shown above are encrypted. No data that's already stored
93+
(or higher), the fields shown above are encrypted. No data that's already stored
11494
is lost.
11595

11696
For more information about this encryption in iOS, examine the source code for
@@ -120,12 +100,10 @@ Iterable's iOS SDK (upon which the React Native SDK relies):
120100
- [`KeychainWrapper`](https://github.com/Iterable/swift-sdk/blob/master/swift-sdk/Internal/KeychainWrapper.swift)
121101

122102
#### Android updates
123-
124103
For Android, this release includes support for encrypting some data at rest,
125104
and an option to store in-app messages in memory.
126105

127106
##### Encrypted data
128-
129107
In Android apps with `minSdkVersion` 23 or higher ([Android 6.0](https://developer.android.com/studio/releases/platforms#6.0))
130108
Iterable's React Native SDK now encrypts the following fields when storing
131109
them at rest:
@@ -137,33 +115,31 @@ them at rest:
137115
(Note that, in Android apps, Iterable's React Native SDK does not store the last
138116
push payload at rest—before or after this update.)
139117

140-
For more information about this encryption in Android, examine the source code
118+
For more information about this encryption in Android, examine the source code
141119
for Iterable's Android SDK (upon which the React Native SDK relies):
142120
[`IterableKeychain`](https://github.com/Iterable/iterable-android-sdk/blob/master/iterableapi/src/main/java/com/iterable/iterableapi/IterableKeychain.kt).
143121

144122
##### Storing in-app messages in memory
145-
146-
This release also allows you to have your Android apps (regardless of `minSdkVersion`)
123+
This release also allows you to have your Android apps (regardless of `minSdkVersion`)
147124
store in-app messages in memory, rather than in an unencrypted local file.
148125
However, an unencrypted local file is still the default option.
149126

150-
To store in-app messages in memory, on `IterableConfig`, set
127+
To store in-app messages in memory, on `IterableConfig`, set
151128
`androidSdkUseInMemoryStorageForInApps` to `true` (defaults to `false`):
152129

153130
```javascript
154131
const config = new IterableConfig();
155132
// ... other configuration options ...
156133
config.androidSdkUseInMemoryStorageForInApps = true;
157-
Iterable.initialize("<YOUR_API_KEY>", config);
134+
Iterable.initialize('<YOUR_API_KEY>', config);
158135
```
159136

160137
When users upgrade to a version of your Android app that uses this version of
161-
the SDK (or higher), and you've set this configuration option to `true`, the
138+
the SDK (or higher), and you've set this configuration option to `true`, the
162139
local file used for in-app message storage (if it already exists) is deleted
163140
However, no data is lost.
164141

165142
##### Android upgrade instructions
166-
167143
If your app targets API level 23 or higher, this is a standard SDK upgrade, with
168144
no special instructions.
169145

@@ -173,45 +149,36 @@ encrypt data):
173149

174150
1. In `AndroidManifest.xml`, add `<uses-sdk tools:overrideLibrary="androidx.security" />`
175151
2. In your app's `app/build.gradle`:
176-
177-
- Add `multiDexEnabled true` to the `default` object, under `android`.
178-
- Add `implementation androidx.multidex:multidex:2.0.1` to the `dependencies`.
152+
- Add `multiDexEnabled true` to the `default` object, under `android`.
153+
- Add `implementation androidx.multidex:multidex:2.0.1` to the `dependencies`.
179154

180155
### Objective-C compatibility headers for React Native 0.68+
181-
182156
To help solve build errors that can arise when using Iterable's SDK with React
183157
Native 0.68+, which uses Objective-C++, we've created some Objective-C
184-
compatibility headers that you can import into your project. For details, read
158+
compatibility headers that you can import into your project. For details, read
185159
[Installing Iterable's React Native SDK — Step 3.3: Import the SDK](https://support.iterable.com/hc/articles/360045714132#step-3-3-import-the-sdk).
186160

187161
## 1.1.0
188-
189162
#### Added
190-
191163
- Offline events processing
192164
This feature saves a local copy of events triggered in your app while the device is offline (up to 1000 events). When a connection is re-established and your app is in the foreground, the events will be sent to Iterable.
193165
Offline events processing is off by default, and we're rolling it out on a customer-by-customer basis. After you start using this version of the SDK, we'll send you a message before we enable the feature on your account (unfortunately, we can't give you an exact timeline for when this will happen). If you have any questions, talk to your Iterable customer success manager.
194166
To use this feature, you must follow the SDK [upgrade instructions](#upgrade-instructions-for-version-1-1-0).
195-
196167
#### Updated
197-
198168
- New properties on the `IterableCommerceItem` class
199169
The `IterableCommerceItem` class (which you can pass to the `trackPurchase` method on the `Iterable` class) now includes additional properties (all optional):
200170
- `sku` (string) - The item's SKU
201171
- `description` (string) - A description of the item
202172
- `url` (string) - A URL associated with the item
203173
- `imageUrl` (string) - A URL that points to an image of the item
204174
- `categories` (string) - Categories to associate with the item
205-
206175
#### Upgrade instructions for version 1.1.0
207-
208176
To use this version of Iterable's React Native SDK, you'll need to update your native Android application's `Application` class:
209-
210177
- Add this import:
211178
```java
212179
import com.iterable.iterableapi.IterableApi;
213180
```
214181
- At the end of the `onCreate` method, add this line of code:
215182
```java
216183
IterableApi.setContext(this);
217-
```
184+
```

0 commit comments

Comments
 (0)