Skip to content

Commit 546f4f2

Browse files
HeshamMegidalyezz
HeshamMegid
authored and
alyezz
committed
💎 Bump to version 1.0.0
* Renames package back to instabug_flutter to avoid conflicts between module names when using Swift.
1 parent 9c3494c commit 546f4f2

12 files changed

+32
-129
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## Version 1.0.0 (2019-07-29)
2+
3+
**⚠️ Package on pub has been renamed to `instabug_flutter` the old package `instabug` is deprecated**
4+
15
## Version 1.0.0-beta.5 (2019-07-22)
26

37
* Adds Network logging feature for the dart:io package HttpClient.

‎README.md‎

Lines changed: 3 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Instabug for Flutter
22

3-
[![pub package](https://img.shields.io/pub/v/instabug.svg)](https://pub.dev/packages/instabug)
3+
[![pub package](https://img.shields.io/pub/v/instabug_flutter.svg)](https://pub.dev/packages/instabug_flutter)
44

55
A Flutter plugin for [Instabug](https://instabug.com/).
66

@@ -20,106 +20,6 @@ A Flutter plugin for [Instabug](https://instabug.com/).
2020
* ⚙️ Under active development
2121
* ⚠ Not available yet
2222

23-
### APIs
24-
25-
The section below contains the APIs we're planning to implement for our 1.0 release across different classes. We'll add the Dart API methods as we implement them.
26-
27-
#### `Instabug`
28-
29-
| API Method | Native Equivalent (Android/iOS) |
30-
|----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|
31-
| `start(String token, List<InvocationEvent> invocationEvents)` | `new Instabug.Builder(this, "APP_TOKEN").build()`<br>`+ startWithToken:invocationEvents:` |
32-
| `showWelcomeMessageWithMode(WelcomeMessageMode welcomeMessageMode)` | `showWelcomeMessage(WelcomeMessage.State state)`<br>`+ showWelcomeMessageWithMode:` |
33-
| `identifyUserWithEmail(String email, [String name])` | `identifyUser(String username, String email)`<br>`+ identifyUserWithEmail:name:` |
34-
| `logOut()` | `logoutUser()`<br>`+ logOut` |
35-
| `setLocale(Locale locale)` | `setLocale(Locale locale)`<br>`+ setLocale:` |
36-
| `setColorTheme(ColorTheme colorTheme)` | `setColorTheme(InstabugColorTheme theme)`<br>`+ setColorTheme:` |
37-
| `appendTags(List<String> tags)` | `addTags(String... tags)`<br>`+ appendTags:` |
38-
| `resetTags()` | `resetTags()`<br>`+ resetTags` |
39-
| `getTags()` | `getTags()`<br>`+ getTags` |
40-
| `setStringForKey(String value, String key)` | `setCustomTextPlaceHolders(InstabugCustomTextPlaceHolder placeholder)`<br>`+ setValue:forStringWithKey:` |
41-
| `setUserAttributeWithKey(String value, String key)` | `setUserAttribute(String key, String value)`<br>`+ setUserAttribute:withKey:` |
42-
| `getUserAttributeForKey(Sring Key)` | `getUserAttribute(String key)`<br>`+ userAttributeForKey:` |
43-
| `removeUserAttributeForKey(String key)` | `removeUserAttribute(String key)`<br>`+ removeUserAttributeForKey:` |
44-
| `getUserAttributes()` | `getAllUserAttributes()`<br>`+ userAttributes:` |
45-
| `logUserEventWithName(String name)` | `logUserEvent(String name)`<br>`+ logUserEventWithName:` |
46-
| `show()` | `show()`<br>`+ show` |
47-
| `setSessionProfilerEnabled(bool sessionProfilerEnabled)` | `setSessionProfilerState(Feature.State state)`<br>`sessionProfilerEnabled` |
48-
| `setPrimaryColor(Color color)` | `setPrimaryColor(@ColorInt int primaryColorValue)`<br>`tintColor` |
49-
| `setUserData(String userData)` | `setUserData(String userData)`<br>`userData` |
50-
| `addFileAttachmentWithURL(String filePath, String fileName)` | `addFileAttachment(Uri fileUri, String fileNameWithExtension)`<br>`+ addFileAttachmentWithURL:` |
51-
| `addFileAttachmentWithData(Uint8List data, String fileName)` | `addFileAttachment(byte[] data, String fileNameWithExtension)` `+ addFileAttachmentWithData:` |
52-
| `clearFileAttachments()` | `clearFileAttachment()`<br>`+ clearFileAttachments` |
53-
| `setWelcomeMessageMode(WelcomeMessageMode welcomeMessageMode)` | `setWelcomeMessageState(WelcomeMessage.State welcomeMessageState)`<br>`welcomeMessageMode` |
54-
55-
#### `BugReporting`
56-
57-
| API Method | Native Equivalent (Android/iOS) |
58-
|---------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
59-
| `invokeWithMode(InvocationMode invocationMode, [List<InvocationOption> invocationOptions])` | `invoke(InvocationMode mode, @InvocationOption int... options)`<br>`+invokeWithMode:options:`|
60-
| `setEnabled(bool isEnabled)` | `setState(Feature.State state)`<br>`enabled` |
61-
| `setOnInvokeCallback(Function function)` | `setOnInvokeCallback(OnInvokeCallback onInvokeCallback)`<br>`willInvokeHandler` |
62-
| `setOnDismissCallback(Function function)` | `setOnDismissCallback(OnSdkDismissCallback onSdkDismissedCallback)`<br>`didDismissHandler` |
63-
| `setInvocationEvents(List<InvocationEvent> invocationEvents)` | `setInvocationEvents(InstabugInvocationEvent... invocationEvents)`<br>`invocationEvents` |
64-
| `setEnabledAttachmentTypes(bool screenshot, bool extraScreenshot, bool galleryImage, bool screenRecording)` | `setAttachmentTypesEnabled(boolean initial, boolean extra, boolean gallery, boolean recording`<br>`enabledAttachmentTypes` |
65-
| `setReportTypes(List<ReportType> reportTypes)` | `setReportTypes(@BugReporting.ReportType int... types)`<br>`promptOptionsEnabledReportTypes` |
66-
| `setExtendedBugReportMode(ExtendedBugReportMode extendedBugReportMode)` | `setExtendedBugReportState(ExtendedBugReport.State state)`<br>`extendedBugReportMode` |
67-
| `setInvocationOptions(List<InvocationOption> invocationOptions)` | `setOptions(@Option int... options)`<br>`bugReportingOptions`
68-
| `showWithOptions(ReportType reportType, List<InvocationOption> invocationOptions)` | `show(@BugReporting.ReportType int type)`<br>`+ showWithReportType:options:`
69-
70-
#### `InstabugLog`
71-
72-
| API Method | Native Equivalent (Android/iOS) |
73-
|-----------------------------------------------|--------------------------------------------------------------|
74-
| `logDebug(String message)` | `d(String message)`<br>`+ logDebug:` |
75-
| `logVerbose(String message)` | `v(String message)`<br>`+ logVerbose:` |
76-
| `logInfo(String message)` | `i(String message)`<br>`+ logInfo:` |
77-
| `logWarn(String message)` | `w(String message)`<br>`+ logWarn:` |
78-
| `logError(String message)` | `e(String message)`<br>`+ logError:` |
79-
| `clearAllLogs(String message)` | `clearLogs()`<br>`+ clearAllLogs:` |
80-
81-
#### `Surveys`
82-
83-
| API Method | Native Equivalent (Android/iOS) |
84-
|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
85-
| `setEnabled(bool isEnabled)` | `setState(Feature.State state)`<br>`enabled` |
86-
| `setAutoShowingEnabled(bool isEnabled)` | `setAutoShowingEnabled(boolean isAutoShowingEnabled)`<br>`autoShowingEnabled` |
87-
| `getAvailableSurveys(Function function)` | `getAvailableSurveys()`<br>`+ availableSurveys` |
88-
| `setOnShowCallback(Function function)` | `setOnShowCallback(OnShowCallback onShowCallback)`<br>`willShowSurveyHandler` |
89-
| `setOnDismissCallback(Function function)` | `setOnDismissCallback(OnDismissCallback onDismissCallback)`<br>`didDismissSurveyHandler` |
90-
| `setShouldShowWelcomeScreen(bool shouldShowWelcomeScreen)` | `setShouldShowWelcomeScreen(boolean shouldShow)`<br>`shouldShowWelcomeScreen` |
91-
| `showSurveyIfAvailable()` | `showSurveyIfAvailable()`<br>`+ showSurveyIfAvailable` |
92-
| `showSurvey(String surveyToken)` | `showSurvey(String token)`<br>`+ showSurveyWithToken:` |
93-
| `hasRespondedToSurvey(String surveyToken, Function function)` | `hasRespondToSurvey(String token)`<br>`+ hasRespondedToSurveyWithToken:` |
94-
95-
#### `FeatureRequests`
96-
97-
| API Method | Native Equivalent (Android/iOS) |
98-
|-----------------------------------------------|--------------------------------------------------------------|
99-
| `show() ` | `show()`<br>`+ show` |
100-
| `setEmailFieldRequired(bool isEmailFieldRequired, List<ActionType> actionTypes)` | `setEmailFieldRequired(boolean isEmailRequired, ActionTypes actions)`<br>`+ setEmailFieldRequired:forAction:` |
101-
102-
103-
#### `Chats`
104-
105-
| API Method | Native Equivalent (Android/iOS) |
106-
|-----------------------------------------------|--------------------------------------------------------------|
107-
| `show()` | `show()`<br>`+ show` |
108-
| `setEnabled(bool isEnabled)` | `setState(Feature.State state)`<br>`enabled` |
109-
110-
111-
#### `Replies`
112-
113-
| API Method | Native Equivalent (Android/iOS) |
114-
|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
115-
| `setEnabled(bool isEnabled)` | `setState(Feature.State state)`<br>`enabled` |
116-
| `show()` | `show()`<br>`+ show` |
117-
| `hasChats(Function function)` | `hasChats()`<br>`+ hasChats` |
118-
| `setOnNewReplyReceivedCallback(Function function)` | `setOnNewReplyReceivedCallback(Callback callback)`<br>`didReceiveReplyHandler`
119-
| `getUnreadRepliesCount(Function function)` | `getUnreadRepliesCount()`<br>`unreadRepliesCount` |
120-
| `setInAppNotificationsEnabled(bool isEnabled)`| `setInAppNotificationEnabled(Boolean isChatNotificationEnable)`<br>`inAppNotificationsEnabled` |
121-
| `setInAppNotificationSound(bool isEnabled)` | `setInAppNotificationSound(Boolean shouldPlaySound)` |
122-
12323
## Integration
12424

12525
Creating a Flutter app on the Instabug dashboard isn't possible yet. Create a React Native app instead.
@@ -132,7 +32,7 @@ Creating a Flutter app on the Instabug dashboard isn't possible yet. Create a Re
13232

13333
```yaml
13434
dependencies:
135-
instabug:
35+
instabug_flutter:
13636
```
13737
13838
2. Install the package by running the following command.
@@ -146,7 +46,7 @@ flutter packages get
14646
1. To start using Instabug, import it into your Flutter app.
14747

14848
```dart
149-
import 'package:instabug/Instabug.dart';
49+
import 'package:instabug_flutter/Instabug.dart';
15050
```
15151

15252
2. Initialize the SDK in `initState()`. This line enables the SDK with the default behavior and sets it to be shown when the device is shaken. Ignore this if you're building for Android only.

‎example/lib/main.dart‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ import 'dart:async';
22
import 'dart:io' show Platform;
33
import 'package:flutter/material.dart';
44
import 'package:flutter/services.dart';
5-
import 'package:instabug/Instabug.dart';
6-
import 'package:instabug/BugReporting.dart';
7-
import 'package:instabug/Surveys.dart';
8-
import 'package:instabug/FeatureRequests.dart';
9-
import 'package:instabug/Chats.dart';
5+
import 'package:instabug_flutter/Instabug.dart';
6+
import 'package:instabug_flutter/BugReporting.dart';
7+
import 'package:instabug_flutter/Surveys.dart';
8+
import 'package:instabug_flutter/FeatureRequests.dart';
9+
import 'package:instabug_flutter/Chats.dart';
1010

1111
void main() => runApp(MyApp());
1212

‎example/pubspec.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ dev_dependencies:
1717
flutter_test:
1818
sdk: flutter
1919

20-
instabug:
20+
instabug_flutter:
2121
path: ../
2222

2323
# For information on the generic Dart part of this file, see the

‎ios/instabug.podspec‎ renamed to ‎ios/instabug_flutter.podspec‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
# To learn more about a Podspec see http://guides.cocoapods.org/syntax/podspec.html
33
#
44
Pod::Spec.new do |s|
5-
s.name = 'instabug'
6-
s.module_name = 'instabug_flutter'
5+
s.name = 'instabug_flutter'
76
s.version = '0.0.1'
87
s.summary = 'A new flutter plugin project.'
98
s.description = <<-DESC

‎lib/BugReporting.dart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import 'dart:async';
22
import 'package:flutter/services.dart';
3-
import 'package:instabug/Instabug.dart';
3+
import 'package:instabug_flutter/Instabug.dart';
44

55
enum InvocationOption {
66
commentFieldRequired,

‎lib/NetworkLogger.dart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import 'dart:async';
22
import 'dart:io';
33
import 'package:flutter/services.dart';
4-
import 'package:instabug/models/network_data.dart';
4+
import 'package:instabug_flutter/models/network_data.dart';
55

66
class NetworkLogger {
77

‎lib/instabug_custom_http_client.dart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import 'dart:io';
22

3-
import 'package:instabug/utils/http_client_logger.dart';
3+
import 'package:instabug_flutter/utils/http_client_logger.dart';
44
import 'package:meta/meta.dart';
55

66
class InstabugCustomHttpClient extends HttpClientLogger implements HttpClient {

‎lib/utils/http_client_logger.dart‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import 'dart:io';
22

3-
import 'package:instabug/NetworkLogger.dart';
4-
import 'package:instabug/models/network_data.dart';
3+
import 'package:instabug_flutter/NetworkLogger.dart';
4+
import 'package:instabug_flutter/models/network_data.dart';
55

66

77
class HttpClientLogger {

‎pubspec.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
name: instabug
2-
version: 1.0.0-beta.5
1+
name: instabug_flutter
2+
version: 1.0.0
33
description: >-
44
Instabug is an in-app feedback and bug reporting tool for mobile apps.
55
With just a simple shake, your users or beta testers can report bugs or

0 commit comments

Comments
 (0)