@bugfender/rn-bugfender 2.2.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2023 Beenario GmbH
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md CHANGED
@@ -2,66 +2,35 @@
2
2
 
3
3
  Bugfender module for React Native and React Native for the Web. It depends on the iOS, Android and Javascript Bugfender SDKs.
4
4
 
5
- ## Adding Bugfender to your project
5
+ This version has been tested in React Native with both the Old and New Architecture.
6
+ The New Architecture is still experimental, and therefore subject to break in new React Native versions.
7
+
8
+ ## Expo compatibility
6
9
 
7
- **Please note:** if you're using Expo for development, be sure to be using the ["bare workflow"](https://docs.expo.io/introduction/managed-vs-bare/#bare-workflow).
10
+ Bugfender works with Expo in the ["bare workflow"](https://docs.expo.io/introduction/managed-vs-bare/#bare-workflow). The Expo Go application (used in the managed workflow) can not run the Bugfender SDK because it contains native code.
11
+
12
+ ## Adding Bugfender to your project
8
13
 
9
14
  `$ cd path_to_your_project`
10
15
 
11
16
  Add the bugfender plugin from npm
12
17
 
13
- `$ npm install --save @bugfender/rn-bugfender @bugfender/sdk @bugfender/common`
18
+ `$ npm install @bugfender/rn-bugfender @bugfender/sdk @bugfender/common`
14
19
 
15
- ### Android & React Native for the Web
16
- You are done!
20
+ After installing, close and relaunch your app with `npm run ios` or `npm run android`.
17
21
 
18
- ### iOS
19
- You can finish the installation manually or via CocoaPods (recommended)
22
+ ## Usage
20
23
 
21
- **CocoaPods (recommended)**
22
-
23
- 1. Ensure your iOS project contains a Podfile, otherwise you need to add it now:
24
- ```
25
- $ cd path_to_your_project/ios
26
- $ pod init
24
+ ```typescript
25
+ import { Bugfender, LogLevel } from '@bugfender/rn-bugfender';
27
26
  ```
28
- Make sure you're targeting at least iOS platform version 10 (specify `platform :ios, '10.0'`).
29
-
30
- 2. After configuring the podfile you can now go to the console and run
31
-
32
- `$ pod install`
33
-
34
- When the installation has finished you should be able to run your project in iOS and Android.
35
-
36
- **Remember that you should be using the Xcode workspace instead of the xcodeproj file from now on.**
37
-
38
- *At the end of this document you can find a **[recommended podfile](#recommended-podfile)**. You can use it as an example*.
39
27
 
40
- If you have any problems compiling or executing, try our [Troubleshooting section](#cocoapods-troubleshooting) at the end of this document.
28
+ Please check the following URL for a complete API reference: https://js.bugfender.com.
41
29
 
42
- **Manual installation (alternative to CocoaPods)**
30
+ Note: always import @bugfender/rn-bugfender instead of @bugfender/sdk. This will enable the native features of the SDK that you wouldn't get otherwise.
43
31
 
44
- Download the latest release from [Github](https://github.com/bugfender/BugfenderSDK-iOS/releases) and copy `BugfenderSDK.framework` to `YourAwesomeProjectDirectory/ios` (same directory as AwesomeProject.xcodeproj). Then, follow the instructions to setup your project manually:
32
+ ### Example
45
33
 
46
- * Go to your **Project** > **Your Target** > **General** > **Linked Frameworks and Libraries** and drag `BugfenderSDK.framework` there (uncheck the "Copy items if needed" checkbox).
47
-
48
- * Make sure you have linked `SystemConfiguration.framework`, `Security.framework`, `MobileCoreServices.framework` and `libc++.tbd` as well.
49
-
50
- ## Upgrading from version 1.x
51
- After updating to version 2.x from version 1.x you should perform the following extra steps:
52
- ### Android
53
- Open `MainApplication` class inside `android/app/src/main/java/com.<your_app>/` folder and remove any references to `com.bugfender.react.RNBugfenderPackage`
54
- ### iOS
55
- Open `Podfile` inside `ios` folder and remove the following line:
56
- ```
57
- pod 'RNBugfender', :path => '../node_modules/@bugfender/rn-bugfender'
58
- ```
59
- and then execute the following command under `ios` folder:
60
- ```
61
- pod deintegrate && pod install
62
- ```
63
-
64
- ## RNBugfender Usage
65
34
  ```typescript
66
35
  import { Bugfender, LogLevel } from '@bugfender/rn-bugfender';
67
36
 
@@ -82,19 +51,6 @@ Bugfender.init({
82
51
  // version: '1.0', // Web sprecific
83
52
  });
84
53
 
85
- // Alternatively, SDKOptionsBuilder can be used to make it apparent what options are specific of certain platforms
86
- Bugfender.init(
87
- new SDKOptionsBuilder({
88
- appKey: '<YOUR APP KEY>',
89
- }).native({
90
- enableLogcatLogging: false,
91
- }).web({
92
- logBrowserEvents: true,
93
- build: '42',
94
- version: '1.0',
95
- }).build()
96
- );
97
-
98
54
  // Send logs with different levels
99
55
  Bugfender.log('This is a debug log in Bugfender from React Native');
100
56
  Bugfender.warn('This is a warn log in Bugfender from React Native');
@@ -161,6 +117,7 @@ Bugfender.getSessionURL().then((url) => console.log('Session url: %s', url));
161
117
  // Synchronizes all logs and issues with the server once
162
118
  Bugfender.forceSendOnce();
163
119
  ```
120
+
164
121
  ## Changelog
165
122
  The changelog of the Bugfender Web SDK can be found in ReleaseNotes under the [react-native](https://bugfender.releasenotes.io/tag/react-native) tag. For all the Bugfender product changes please visit the general release notes.
166
123
 
@@ -186,47 +143,18 @@ The React Native SDK API has changed in order be unified with [Bugfender Web SDK
186
143
  * `setDeviceKey` method replaces `setDeviceBoolean`, `setDeviceString`, `setDeviceInteger` & `setDeviceFloat`
187
144
 
188
145
  ## Cocoapods Troubleshooting
189
- We did our best to create a installation process that worked for most of the users. However, the React Native configuration can be tricky sometimes.
146
+ We often get questions about CocoaPods install failing. Whilst this has nothing to do with Bugfender, you may
147
+ encounter this problem while installing the pod.
190
148
 
191
- Most of the issues are related to the high number of dependencies and the compatibility between them. As every project is different and has different needs it's difficult to provide a magic receipt that can work out of the box, however we find out that the following Podfile compiles and run correctly most of the time. You can use it as a basis to experiment and find a configuration that works for you.
149
+ To reinstall the pods, you can do:
192
150
 
193
- ### Recommended Podfile
194
- ```
195
- platform :ios, '10.0'
196
-
197
- target 'SampleProject' do
198
- # Comment the next line if you don't want to use dynamic frameworks
199
- use_frameworks!
200
-
201
- # Pods for SampleProject
202
- pod 'AFNetworking'
203
-
204
- # Add new pods below this line
205
- pod 'RnBugfender', :path => '../node_modules/@bugfender/rn-bugfender'
206
-
207
- rn_path = '../node_modules/react-native'
208
-
209
- pod 'yoga', path: "#{rn_path}/ReactCommon/yoga"
210
- pod 'Folly', :podspec => '../node_modules/react-native/third-party-podspecs/Folly.podspec'
211
- pod 'React', path: rn_path, subspecs: [
212
- 'Core',
213
- 'CxxBridge',
214
- 'DevSupport',
215
- 'RCTActionSheet',
216
- 'RCTAnimation',
217
- 'RCTGeolocation',
218
- 'RCTImage',
219
- 'RCTLinkingIOS',
220
- 'RCTNetwork',
221
- 'RCTSettings',
222
- 'RCTText',
223
- 'RCTVibration',
224
- 'RCTWebSocket',
225
- ]
226
-
227
- end
151
+ ```sh
152
+ bundle exec pod install
228
153
  ```
229
154
 
230
- If you are not able to get your project working you can still try to add RNBugfender with the Manual Installation or to open an issue in Github and maybe we can help you.
155
+ Or, for the New Architecture:
156
+ ```sh
157
+ RCT_NEW_ARCH_ENABLED=1 bundle exec pod install
158
+ ```
231
159
 
232
- Happy debugging!
160
+ You can find more details here: https://reactnative.dev/docs/environment-setup
@@ -11,13 +11,13 @@ Pod::Spec.new do |s|
11
11
  s.license = package["license"]
12
12
  s.authors = package["author"]
13
13
 
14
- s.platforms = { :ios => "11.0" }
14
+ s.platforms = { :ios => "12.0" }
15
15
  s.source = { :git => "https://github.com/bugfender/BugfenderSDK-iOS", :tag => "master" }
16
16
 
17
17
  s.source_files = "ios/**/*.{h,m,mm}"
18
18
 
19
19
  s.dependency "React-Core"
20
- s.dependency 'BugfenderSDK', '~> 1.10' # From 1.10 to 2.0 (excluded)
20
+ s.dependency 'BugfenderSDK', '~> 2.0'
21
21
 
22
22
  # Don't install the dependencies when we run `pod install` in the old architecture.
23
23
  if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bugfender/rn-bugfender",
3
- "version": "2.2.0",
3
+ "version": "3.0.0",
4
4
  "description": "React Native bindings for Bugfender SDK",
5
5
  "main": "lib/commonjs/index",
6
6
  "module": "lib/module/index",
@@ -54,14 +54,14 @@
54
54
  "registry": "https://registry.npmjs.org/"
55
55
  },
56
56
  "devDependencies": {
57
- "@arkweid/lefthook": "^0.7.7",
58
- "@babel/eslint-parser": "^7.19.1",
59
57
  "@commitlint/config-conventional": "^17.2.0",
58
+ "@evilmartians/lefthook": "^1.4.8",
60
59
  "@react-native-community/eslint-config": "^3.2.0",
61
- "@release-it/conventional-changelog": "^5.1.1",
60
+ "@release-it/conventional-changelog": "^7.0.0",
62
61
  "@types/jest": "^29.2.2",
63
62
  "@types/react": "^18.2.19",
64
63
  "@types/react-native": "^0.72.2",
64
+ "@typescript-eslint/parser": "^5.62.0",
65
65
  "commitlint": "^17.2.0",
66
66
  "eslint": "^8.27.0",
67
67
  "eslint-config-prettier": "^8.5.0",
@@ -72,8 +72,8 @@
72
72
  "react": "^18.2.0",
73
73
  "react-native": "^0.72.3",
74
74
  "react-native-builder-bob": "^0.21.3",
75
- "release-it": "^15.5.0",
76
- "typescript": "^4.8.4"
75
+ "release-it": "^16.1.4",
76
+ "typescript": "^4.9.5"
77
77
  },
78
78
  "resolutions": {
79
79
  "@types/react": "17.0.21"
@@ -84,6 +84,11 @@
84
84
  "react": "*",
85
85
  "react-native": "*"
86
86
  },
87
+ "overrides": {
88
+ "@release-it/conventional-changelog": {
89
+ "semver": "~7.5.2"
90
+ }
91
+ },
87
92
  "jest": {
88
93
  "preset": "react-native",
89
94
  "modulePathIgnorePatterns": [