v1.0.0

Author: abedelaziz-deriv

.circleci/config.yml

@@ -0,0 +1,47 @@
+name: Flutter Analyze, Test, and Build
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+  pull_request:
+    branches:
+      - "*"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: 📚 Git Checkout
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
+
+      - name: 🐦 Setup Flutter
+        uses: subosito/flutter-action@48cafc24713cca54bbe03cdc3a423187d413aafa
+        with:
+          flutter-version: "3.10.2"
+          channel: stable
+          cache: true
+          cache-key: flutter-:os:-:channel:-:version:-:arch:-:hash:-${{ hashFiles('**/pubspec.lock') }}
+
+      - name: 📦 Install Dependencies
+        run: flutter pub get
+
+      # do not fail if the analyze issue is info level
+      - name: 🕵️ Analyze
+        run: |
+          if flutter analyze 2>&1 | grep -q -E 'error:|warning:'; 
+          then exit 1
+          else exit 0
+          fi
+
+      - name: 🧪 Run Tests
+        run: flutter test
+
+      - name: Build Example app
+        working-directory: ./example
+        run: flutter build apk --target-platform android-arm

.github/workflows/main.yaml

@@ -1,4 +1,4 @@
 [submodule "binary-websocket-api"]
 	path = binary-websocket-api
-	url = https://github.com/regentmarkets/binary-websocket-api.git
+	url = git@github.com:regentmarkets/binary-websocket-api.git
 	branch = master

.gitmodules

@@ -1,3 +1,3 @@
-## 0.0.1
+## 1.0.0
 
-* TODO: Describe initial release.
+* First release of the package.

CHANGELOG.md

@@ -15,7 +15,7 @@ APIInitializer().initialize();
 Establishing a connection to WebSocket needs an instance of the `ConnectionInformation` class for initializing API connection.
 
 ```dart
-final BaseAPI api = Injector.getInjector().get<BaseAPI>();
+final BaseAPI api = Injector()<BaseAPI>();
 
 api.connect(
     ConnectionInformation(
@@ -45,7 +45,7 @@ print(ping.succeeded);
 #### Calling method directly with `BaseAPI`
 
 ```dart
-final BaseAPI api = Injector.getInjector().get<BaseAPI>();
+final BaseAPI api = Injector()<BaseAPI>();
 
 final PingResponse response =
     await api.call(request: const PingRequest());
@@ -141,6 +141,8 @@ dependencies:
 ```
 $ git submodule init
 $ git submodule update --remote
+$ ./setup.sh
+$ dart run build_runner build --delete-conflicting-outputs
 ```
 
 ### Run the tests

CODEOWNERS

@@ -2,9 +2,9 @@ analyzer:
   exclude:
     - lib/basic_api/generated/api.dart
 
-  strong-mode:
-    implicit-dynamic: false
-
+  language:
+    strict-raw-types: true
+    
   errors:
     todo: ignore
     missing_required_param: warning
@@ -60,7 +60,7 @@ linter:
     - empty_catches
     - empty_constructor_bodies
     - empty_statements
-    # - exhaustive_cases # required SDK 2.9.0
+    - exhaustive_cases # required SDK 2.9.0
     - file_names
     - flutter_style_todos
     - hash_and_equals
@@ -73,6 +73,7 @@ linter:
     - list_remove_unrelated_type
     - no_adjacent_strings_in_list
     - no_duplicate_case_values
+    - no_leading_underscores_for_local_identifiers
     - non_constant_identifier_names
     - null_closures
     - only_throw_errors
@@ -91,7 +92,6 @@ linter:
     - prefer_const_literals_to_create_immutables
     - prefer_constructors_over_static_methods
     - prefer_contains
-    - prefer_equal_for_default_values
     - prefer_expression_function_bodies # https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#consider-using--for-short-functions-and-methods
     - prefer_final_fields
     - prefer_final_in_for_each