Ready to launch

Author: Franco Bugnano

CHANGELOG.md

@@ -1,3 +1,4 @@
-## [0.0.1] - TODO: Add release date.
+## 0.1.0
+
+- Initial version.
 
-* TODO: Describe initial release.

LICENSE

@@ -1 +1,28 @@
-TODO: Add your license here.
+BSD 3-Clause License
+
+Copyright (c) 2022, TalkJS
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,93 +1,64 @@
-# TalkJS
+# TalkJS Flutter SDK
 
-Flutter SDK for [TalkJS](https://talkjs.com)
+Official TalkJS SDK for Flutter
+
+**What is TalkJS?**
+
+TalkJS lets you add user-to-user chat to your marketplace, on-demand app, or
+social platform.
+For more information, visit
+[talkjs.com](https://talkjs.com/?ref=jssdk-npm-readme).
+
+![Screenshots of TalkJS running on various devices](https://talkjs.com/images/devices_home.jpg)
+
+Don't hesitate to
+[let us know](https://talkjs.com/?chat)
+if you have any questions about TalkJS.
 
 ## Requirements
 
-- Dart sdk: ">=2.12.0 <3.0.0"
-- Flutter: ">=1.17.0"
+- Dart sdk: ">=2.15.0 <3.0.0"
+- Flutter: ">=2.8.1"
 - Android: `minSDKVersion 19`
 
 ## Installation
 
-Assumption: You have an existing Flutter Project. You can follow this [guide](https://flutter.dev/docs/get-started/test-drive#create-app)
-on how to create a new Flutter Project.
-
-First, clone this repository on your computer.
-```sh
-git clone https://github.com/talkjs/flutter-sdk-victor.git
-```
-
-To add the package as a dependency, edit the dependencies section of
-your project's **pubspec.yaml** file in your Flutter project as follows:
+Edit the dependencies section of your project's `pubspec.yaml` file in your
+Flutter project as follows:
 
 ```yaml
 dependencies:
-  talkjs:
-    path: {path to directory containing this repository}/flutter-sdk-victor/talkjs
+  talkjs_flutter: ^0.1.0
 ```
 
-The path specified should be an absolute path from the root directory of
-your system.
-
-Run the command: ```flutter pub get``` on the command line or through
-Android Studio's **Get dependencies** button.
-
-To debug on Android, put this line in the `android/app/src/main/AndroidManifest.xml` as a property of the `<application` tag:
+Run the command: `flutter pub get` on the command line or through Android
+Studio's **Get dependencies** button.
 
-```xml
-        android:usesCleartextTraffic="true"
-```
 
-## Getting Started
+## Usage
 
-If you used the [guide](https://flutter.dev/docs/get-started/test-drive#create-app)
-mentioned above to create a new Flutter project, replace everything in
-**lib/main.dart** with the following code:
+Import TalkJS in your project source files.
 
 ```dart
-import 'package:flutter/material.dart';
-import 'package:talkjs/talkjs.dart';
-
-void main() {
-  runApp(MyApp());
-}
-
-class MyApp extends StatelessWidget {
-  @override
-  Widget build(BuildContext context) {
-    return MaterialApp(
-      title: 'TalkJS Demo',
-      home: Scaffold(
-        body: initChat()
-      )
-    );
-  }
-
-  Widget initChat() {
-    final me = User(id: '123456', name: 'Alice');
-    final other = User(id: '654321', name: 'Sebastian');
-
-    final session = Session(appId: 'YOUR_APP_ID', me: me);
-    final conversation = session.getOrCreateConversation(
-        Talk.oneOnOneId(me.id, other.id)
-    );
-
-    conversation.setParticipant(me);
-    conversation.setParticipant(other);
-
-    final chatBox = session.createChatbox(conversation);
-    return chatBox.mount();
-  }
-}
+import 'package:talkjs_flutter/talkjs.dart';
 ```
 
-Replace ```YOUR_APP_ID``` with the App ID on the TalkJS [Dashboard](https://talkjs.com/dashboard/login.)
-
-For users with an existing Flutter project, you can use the ```Widget``` returned
-by the ```initChat``` function in the example above as part of an existing
-```Widget``` definition or a navigation route
-
-## Documentation
+Then follow our
+[Flutter guide](https://talkjs.com/docs/Getting_Started/Frameworks/Flutter/)
+to start using TalkJS in your project.
+
+## TalkJS is fully forward compatible
+We promise to never break API compatibility.
+We may at times deprecate methods or fields, but we will never remove them.
+If something that used to work stops working, then that's a bug.
+Please [report it](https://talkjs.com/?chat) and we'll fix it asap.
+
+The package is being released in a beta state.
+The reason for this is that there are things that one can do with the TalkJS
+JavaScript SDK that aren't possible with the Flutter SDK.
+We will release v1.0.0 of this package once the two SDKs are similar in terms
+of features.
+This however does not take away from our commitment to always maintain backward
+compatibility.
+So you can be assured that the package is stable for production use.
 
-The SDK API reference can be found in **doc/api**.

lib/src/chatbox.dart

@@ -174,9 +174,12 @@ class ChatBoxState extends State<ChatBox> {
       options["signature"] = widget.session.signature;
     }
 
-    options["me"] = getUserVariableName(widget.session.me);
+    execute('const options = ${json.encode(options)};');
 
-    execute('const session = new Talk.Session(${json.encode(options)});');
+    final variableName = getUserVariableName(widget.session.me);
+    execute('options["me"] = $variableName;');
+
+    execute('const session = new Talk.Session(options);');
   }
 
   void _createChatBox() {
@@ -285,7 +288,7 @@ class ChatBoxState extends State<ChatBox> {
       print('📗 chatbox._webViewCreatedCallback');
     }
 
-    String htmlData = await rootBundle.loadString('packages/talkjs/assets/index.html');
+    String htmlData = await rootBundle.loadString('packages/talkjs_flutter/assets/index.html');
     Uri uri = Uri.dataFromString(htmlData, mimeType: 'text/html', encoding: Encoding.getByName('utf-8'));
     webViewController.loadUrl(uri.toString());
 

lib/src/conversationlist.dart

@@ -200,7 +200,7 @@ class ConversationListState extends State<ConversationList> {
       print('📗 conversationlist._webViewCreatedCallback');
     }
 
-    String htmlData = await rootBundle.loadString('packages/talkjs/assets/index.html');
+    String htmlData = await rootBundle.loadString('packages/talkjs_flutter/assets/index.html');
     Uri uri = Uri.dataFromString(htmlData, mimeType: 'text/html', encoding: Encoding.getByName('utf-8'));
     webViewController.loadUrl(uri.toString());
 

pubspec.yaml

@@ -1,4 +1,4 @@
-name: talkjs
+name: talkjs_flutter
 description: Official TalkJS SDK for Flutter
 version: 0.1.0
 homepage: https://talkjs.com
@@ -24,7 +24,7 @@ dev_dependencies:
 # The following section is specific to Flutter.
 flutter:
   assets:
-    - packages/talkjs/assets/index.html
+    - packages/talkjs_flutter/assets/index.html
 
   # To add assets to your package, add an assets section, like this:
   # assets: