Initial commit

Author: steve-bang

.dart_tool/package_config.json

@@ -0,0 +1,14 @@
+name: Dart CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dart-lang/setup-dart@v1
+      - run: dart pub get
+      - run: dart analyze
+      - run: dart test
+      - run: dart format --output none --set-exit-if-changed .

.github/workflows/dart.yml

@@ -0,0 +1,13 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "jfw-dart",
+            "request": "launch",
+            "type": "dart"
+        }
+    ]
+}

.vscode/launch.json

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 [1bytesoftware]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE

@@ -0,0 +1,79 @@
+# JFramework Dart Library
+
+[![Pub Version](https://img.shields.io/pub/v/user_auth_sdk)](https://pub.dev/packages/user_auth_sdk)
+[![License: MIT](https://img.shields.io/badge/license-MIT-purple.svg)](https://opensource.org/licenses/MIT)
+[![CI Status](https://github.com/yourusername/user_auth_sdk/actions/workflows/dart.yml/badge.svg)](https://github.com/yourusername/user_auth_sdk/actions)
+
+A Dart SDK for seamless integration with JFramework APIs, supporting both API Key and Auth Key authentication flows.
+
+## Features
+
+- **Dual Authentication Methods**:
+  - `APIKey` header for service-to-service auth
+  - `AuthKey` header for user credential flows
+- **Complete User Management**:
+  - CRUD operations for users
+  - Session management
+  - Role-based permissions
+- **Token Management**:
+  - Automatic token storage
+  - Secure credential handling
+  - Token refresh flow
+
+## Installation
+
+Add to your `pubspec.yaml`:
+
+```yaml
+dependencies:
+  jfw_dart: ^1.0.0
+```
+
+## Usage
+
+### 1. Auth Key Authentication
+``` dart
+final authProvider = AuthKeyProvider(null);
+
+ final client = JfwClient(
+    brandUrl: 'YOUR_BRAND_URL',
+    authProvider: authProvider,
+  );
+```
+
+### 2. Username/Password Authentication
+``` dart
+
+final authService = AuthService(client);
+
+AuthenticateRequest request = AuthenticateRequest(
+  username: 'user_username', // Replace with user's username
+  password: 'user_password', // Replace with user's password
+);
+
+// Login with credentials
+final authResponse = await authService.loginWithCredentials(request);
+
+// If the login is successful, the response will contain the auth key
+client.updateAuthProvider(AuthKeyProvider(response.authKey));
+
+print('Login successful! Auth Key: ${response.authKey}');
+
+
+```
+
+### 3. Making Authenticated Requests
+``` dart
+// Subsequent requests will automatically include the Auth-Key header
+final userService = UserService(client);
+final user = await userService.getCurrentUser();
+
+print('Current user: id=${user.id}, email=${user.emailAddress}, username=${user.username}');
+```
+
+## Contributing
+1. Fork the repository
+2. Create a feature branch (git checkout -b feature/AmazingFeature)
+3. Commit your changes (git commit -m 'Add amazing feature')
+4. Push to the branch (git push origin feature/AmazingFeature)
+5. Open a Pull Request

README.md

@@ -0,0 +1,43 @@
+import 'package:jfw_dart/jfw.dart';
+import 'package:jfw_dart/src/auth/auth_key_auth.dart';
+
+void main() async {
+
+  final brandUrl = "YOUR_BRAND_URL";
+
+  // Option 1: Auth Key Authentication
+  final authProvider = AuthKeyProvider(null);
+
+  // Option 2: API Key Authentication
+  // final authProvider = ApiKeyProvider('your-api-key-here');
+
+  final client = JfwClient(
+    brandUrl: brandUrl,
+    authProvider: authProvider,
+  );
+
+  final authService = AuthService(client);
+
+  try {
+    // Instantiate the request with the required parameters
+    AuthenticateRequest request = AuthenticateRequest(
+      username: 'username', // Replace with your username
+      password: 'password', // Replace with your password
+    );
+
+    // Login with credentials
+    final response = await authService.loginWithCredentials(request);
+
+    // If the login is successful, the response will contain the auth key
+    client.updateAuthProvider(AuthKeyProvider(response.authKey));
+
+    print('Login successful! Auth Key: ${response.authKey}');
+
+    // Subsequent requests will automatically include the Auth-Key header
+    final userService = UserService(client);
+    final user = await userService.getCurrentUser();
+    print('Current user: id=${user.id}, email=${user.emailAddress}, username=${user.username}');
+  } catch (e) {
+    print('Error: $e');
+  }
+}

example.jpg

@@ -0,0 +1,45 @@
+import 'dart:io';
+
+import 'package:jfw_dart/jfw.dart';
+import 'package:jfw_dart/src/auth/auth_key_auth.dart';
+
+void main() async {
+  // Option 1: Auth Key Authentication.
+  final authKey = "YOUR_AUTH_KEY"; // This value is will be generated before call authService.loginWithCredentials()
+  final brandUrl = "YOUR_BRAND_URL";
+
+  final authProvider = AuthKeyProvider(authKey);
+
+  final client = JfwClient(
+    brandUrl: brandUrl,
+    authProvider: authProvider,
+  );
+
+  final cdnService = CdnService(client);
+
+  try {
+
+    final file = new File('example.jpg');
+
+    final request = UploadCdnRequest(
+      uploadFile: file,
+      prefixFolder: 'tests',
+      refObject: 'example',
+      refId: 1000
+
+    );
+
+    if(!await file.exists()){
+      throw Exception('File not found');
+    }
+
+    // Call the API to get the current user
+    final response = await cdnService.uploadFile(request);
+
+    print('Result fileId: ${response.fileId}');
+    print('Result url: ${response.url}');
+
+  } catch (e) {
+    print('Error: ${e}');
+  }
+}

example/auth_main.dart

@@ -0,0 +1,37 @@
+import 'package:jfw_dart/jfw.dart';
+import 'package:jfw_dart/src/auth/auth_key_auth.dart';
+
+void main() async {
+  // Auth Key Authentication.
+  final authKey = "H+a+SZuunxY2qcvmC1B3yj3BuenCit1IeVRaazFsRGNXR21UZjA2c3JiTElaZz09cVIyeElZRmdMODZoV1RoVmFlMHJwZzc0NmordE5EZmxXRS9BU0JzdWtLaz0="; // This value is will be generated before call authService.loginWithCredentials()
+  final brandUrl = "my.boostpte.com";
+
+  final authProvider = AuthKeyProvider(authKey);
+
+  final client = JfwClient(
+    brandUrl: brandUrl,
+    authProvider: authProvider,
+  );
+
+  final deviceService = DeviceService(client);
+
+  try {
+
+    final query = DeviceQueryRequest(
+      pageNumber: 0,
+      pageSize: 10,
+    );
+
+    // Call the API to get the current user
+    final response = await deviceService.getDevices(query: query);
+
+    print('Result total items: ${response.totalItems}');
+
+    for (var item in response.items) {
+      print('name=${item.name},  os=${item.osDevice}, status=${item.status}');
+    }
+
+  } catch (e) {
+    print('Error: ${e}');
+  }
+}

example/cdn_main.dart

@@ -0,0 +1,30 @@
+import 'package:jfw_dart/jfw.dart';
+import 'package:jfw_dart/src/auth/auth_key_auth.dart';
+
+void main() async {
+  // Option 1: Auth Key Authentication.
+  final authKey = "YOUR_AUTH_KEY";
+  final brandUrl = "YOUR_BRAND_URL";
+
+  final authProvider = AuthKeyProvider(authKey);
+
+  // Option 2: API Key Authentication
+  // final authProvider = ApiKeyProvider('your-api-key-here');
+
+
+  final client = JfwClient(
+    brandUrl: brandUrl,
+    authProvider: authProvider,
+  );
+
+  final userService = UserService(client);
+
+  try {
+    // Call the API to get the current user
+    final response = await userService.getCurrentUser();
+
+    print('Result getCurrentUser: ${response.id}');
+  } catch (e) {
+    print('Error: $e');
+  }
+}