Merge pull request #7 from JothishKamal/dev

feat: migrate to new package name: flutter_glimpse

Author: JothishKamal

.pubignore

@@ -1,6 +1,6 @@
 # Files to exclude from pub.dev publishing
 
-SDUI_Flutter_Integration_Guide.txt
+Glimpse_Flutter_Integration_Guide.txt
 docs/
 .github/
 .hooks/

ADDING_WIDGET.md

@@ -1,31 +1,32 @@
-# Adding a New Widget to the SDUI Package
+# Adding a New Widget to the Glimpse Package
 
-This guide explains how to add support for a new widget to the Flutter SDUI package, including JSON and proto (gRPC) support. The process ensures your widget can be described by the server, parsed on the client, and rendered as a real Flutter widget.
+This guide explains how to add support for a new widget to the Flutter Glimpse package, including JSON and proto (gRPC) support. The process ensures your widget can be described by the server, parsed on the client, and rendered as a real Flutter widget.
 
 ---
 
-## 1. Create the SDUI Widget Class
+## 1. Create the Glimpse Widget Class
 
 - **Where:** `lib/src/widgets/`
-- **What:** Create a Dart class (e.g., `SduiMyWidget`) that extends `SduiWidget`.
-- **Why:** This class acts as the runtime representation of your widget in the SDUI system. It bridges the data-driven world (JSON/proto) and the actual Flutter widget tree.
-- **How:**  
+- **What:** Create a Dart class (e.g., `GlimpseMyWidget`) that extends `GlimpseWidget`.
+- **Why:** This class acts as the runtime representation of your widget in the Glimpse system. It bridges the data-driven world (JSON/proto) and the actual Flutter widget tree.
+- **How:**
   - Add all properties your widget needs (e.g., text, color, children).
-  - Implement the `toFlutterWidget()` method to convert your SDUI widget to a real Flutter widget.
+  - Implement the `toFlutterWidget()` method to convert your Glimpse widget to a real Flutter widget.
   - If your widget has children, make sure to recursively call `toFlutterWidget()` on them.
 
 **Example:**
+
 ```dart
 import 'package:flutter/widgets.dart';
-import 'sdui_widget.dart';
+import 'glimpse_widget.dart';
 
-class SduiMyWidget extends SduiWidget {
+class GlimpseMyWidget extends GlimpseWidget {
   final String title;
   final Color? color;
-  final List<SduiWidget> children;
+  final List<GlimpseWidget> children;
   // Add other properties as needed
 
-  SduiMyWidget({
+  GlimpseMyWidget({
     required this.title,
     this.color,
     this.children = const [],
@@ -41,27 +42,29 @@ class SduiMyWidget extends SduiWidget {
   }
 }
 ```
-*Tip: Look at existing SDUI widgets for structure and naming conventions. Try to keep your API as close as possible to the real Flutter widget for familiarity.*
+
+_Tip: Look at existing Glimpse widgets for structure and naming conventions. Try to keep your API as close as possible to the real Flutter widget for familiarity._
 
 ---
 
 ## 2. Update the Parser(s)
 
 ### a. JSON Parsing
 
-- **Where:** `lib/src/parser/sdui_proto_parser.dart`
+- **Where:** `lib/src/parser/glimpse_proto_parser.dart`
 - **What:** Add logic to parse your widget from JSON and serialize it back.
-- **Why:** This allows the SDUI system to construct your widget from server-provided JSON, and to serialize it back for debugging or round-tripping.
+- **Why:** This allows the Glimpse system to construct your widget from server-provided JSON, and to serialize it back for debugging or round-tripping.
 - **How:**
   - Add a case for your widget in the `parseJSON` method (e.g., `case 'my_widget': return _parseJsonMyWidget(data);`).
-  - Implement a `_parseJsonMyWidget(Map<String, dynamic> data)` method to extract all properties from the JSON map and construct your SDUI widget.
-  - Update the `toJson` and `_toJsonMyWidget` methods to support serialization (convert your SDUI widget back to a JSON map).
+  - Implement a `_parseJsonMyWidget(Map<String, dynamic> data)` method to extract all properties from the JSON map and construct your Glimpse widget.
+  - Update the `toJson` and `_toJsonMyWidget` methods to support serialization (convert your Glimpse widget back to a JSON map).
   - If your widget has enums or complex types, add helper methods for parsing/serializing them.
 
 **Example:**
+
 ```dart
-static SduiMyWidget _parseJsonMyWidget(Map<String, dynamic> data) {
-  return SduiMyWidget(
+static GlimpseMyWidget _parseJsonMyWidget(Map<String, dynamic> data) {
+  return GlimpseMyWidget(
     title: data['title'] ?? '',
     color: _parseJsonColor(data['color']),
     children: (data['children'] as List<dynamic>? ?? [])
@@ -73,68 +76,71 @@ static SduiMyWidget _parseJsonMyWidget(Map<String, dynamic> data) {
 
 ### b. Proto Parsing
 
-- **Where:** `lib/src/parser/sdui_proto_parser.dart`
+- **Where:** `lib/src/parser/glimpse_proto_parser.dart`
 - **What:** Add logic to parse your widget from proto and serialize it back.
-- **Why:** This allows the SDUI system to construct your widget from gRPC/proto data, and to serialize it back for server communication or round-tripping.
+- **Why:** This allows the Glimpse system to construct your widget from gRPC/proto data, and to serialize it back for server communication or round-tripping.
 - **How:**
   - Add a case for your widget in the `parseProto` and `fromProto` methods.
-  - Implement `_parseProtoMyWidget(SduiWidgetData data)` and `myWidgetFromProto` to extract all properties from the proto message and construct your SDUI widget.
-  - Add `myWidgetToProto` for proto serialization (convert your SDUI widget to a proto message).
+  - Implement `_parseProtoMyWidget(GlimpseWidgetData data)` and `myWidgetFromProto` to extract all properties from the proto message and construct your Glimpse widget.
+  - Add `myWidgetToProto` for proto serialization (convert your Glimpse widget to a proto message).
   - Use helper methods for enums, colors, and nested children as needed.
 
 **Example:**
+
 ```dart
-static SduiMyWidget myWidgetFromProto(SduiWidgetData data) {
-  return SduiMyWidget(
+static GlimpseMyWidget myWidgetFromProto(GlimpseWidgetData data) {
+  return GlimpseMyWidget(
     title: data.stringAttributes['title'] ?? '',
     color: data.hasColor() ? _parseProtoColor(data.color) : null,
-    children: data.children.map((c) => SduiParser.parseProto(c)).toList(),
+    children: data.children.map((c) => GlimpseParser.parseProto(c)).toList(),
   );
 }
 ```
 
-*Tip: Use the helpers and patterns from other widgets to handle enums, colors, and nested children. Consistency makes the codebase easier to maintain.*
+_Tip: Use the helpers and patterns from other widgets to handle enums, colors, and nested children. Consistency makes the codebase easier to maintain._
 
 ---
 
 ## 3. Update the Widget Type Enum
 
-- **Where:** `sdui.proto` (your proto definitions)
+- **Where:** `glimpse.proto` (your proto definitions)
 - **What:** Add your widget to the `WidgetType` enum.
 - **Why:** This allows the server and client to communicate about your new widget type in a type-safe way.
-- **How:**  
+- **How:**
   - Add a new value (e.g., `MY_WIDGET`) to the `WidgetType` enum in your proto file.
   - Regenerate Dart code from your proto files (see README for instructions, usually a script in `tool/`).
 
 **Example:**
+
 ```protobuf
 enum WidgetType {
   // ... existing types ...
   MY_WIDGET = 42;
 }
 ```
 
-*Tip: Make sure the enum value is unique and does not conflict with existing types.*
+_Tip: Make sure the enum value is unique and does not conflict with existing types._
 
 ---
 
-## 4. Add to Flutter-to-SDUI Converter
+## 4. Add to Flutter-to-Glimpse Converter
 
-- **Where:** `lib/src/parser/flutter_to_sdui.dart`
-- **What:** Add a case to convert a real Flutter widget to your SDUI widget.
-- **Why:** This enables tools and tests to convert existing Flutter code to SDUI format, and helps with migration or round-trip testing.
-- **How:**  
+- **Where:** `lib/src/parser/flutter_to_glimpse.dart`
+- **What:** Add a case to convert a real Flutter widget to your Glimpse widget.
+- **Why:** This enables tools and tests to convert existing Flutter code to Glimpse format, and helps with migration or round-trip testing.
+- **How:**
   - Add an `else if` block for your widget type.
-  - Map all relevant properties from the Flutter widget to your SDUI widget.
+  - Map all relevant properties from the Flutter widget to your Glimpse widget.
   - If your widget is not supported for conversion, throw an `UnimplementedError` with a clear message.
 
 **Example:**
+
 ```dart
 else if (widget is MyWidget) {
-  return SduiMyWidget(
+  return GlimpseMyWidget(
     title: widget.title,
     color: widget.color,
-    children: widget.children.map(flutterToSdui).toList(),
+    children: widget.children.map(flutterToGlimpse).toList(),
   );
 }
 ```
@@ -147,11 +153,11 @@ else if (widget is MyWidget) {
 - **Why:** Testing catches bugs early and ensures your widget behaves as expected in all supported formats.
 - **How:**
   - Add unit tests for JSON and proto parsing/serialization.
-  - Add tests for Flutter-to-SDUI conversion.
+  - Add tests for Flutter-to-Glimpse conversion.
   - Create sample JSON and proto definitions for your widget and verify they render correctly in a demo app or test harness.
   - Test edge cases (missing properties, nulls, invalid values).
 
-*Tip: Use the sample files and test cases for existing widgets as a template. Automated tests are preferred, but manual testing in a demo app is also valuable.*
+_Tip: Use the sample files and test cases for existing widgets as a template. Automated tests are preferred, but manual testing in a demo app is also valuable._
 
 ---
 
@@ -169,24 +175,25 @@ else if (widget is MyWidget) {
 ## Example Checklist
 
 - [ ] Widget class in `lib/src/widgets/`
-- [ ] JSON parse/serialize in `sdui_proto_parser.dart`
-- [ ] Proto parse/serialize in `sdui_proto_parser.dart`
+- [ ] JSON parse/serialize in `glimpse_proto_parser.dart`
+- [ ] Proto parse/serialize in `glimpse_proto_parser.dart`
 - [ ] Enum in proto and regenerated Dart code
-- [ ] Flutter-to-SDUI conversion
+- [ ] Flutter-to-Glimpse conversion
 - [ ] Tests and sample data
 - [ ] Documentation
 
 ---
 
 **Tips & Best Practices:**
+
 - Follow the structure and naming conventions of existing widgets for consistency.
 - Keep your widget’s API as close as possible to the real Flutter widget for familiarity.
-- Only map properties that are supported by both SDUI and the underlying Flutter widget.
+- Only map properties that are supported by both Glimpse and the underlying Flutter widget.
 - If your widget has complex properties (e.g., enums, nested objects), add helper methods for parsing/serialization.
 - If you’re unsure, look at how similar widgets are implemented in the codebase.
 - Use clear error messages for unsupported or unimplemented features.
 - Test with both minimal and maximal property sets.
 
 ---
 
-If you have questions, check the code for similar widgets or open an issue! 
+If you have questions, check the code for similar widgets or open an issue!

CHANGELOG.md

@@ -8,8 +8,8 @@
 - JSON and gRPC support for dynamic UI rendering
 - Protocol Buffers integration for type-safe communication
 - Core widget support: Text, Column, Row, Container, Scaffold, Image, Icon, SizedBox, Spacer
-- SduiGrpcClient for server communication
-- SduiGrpcRenderer widget for rendering server-driven UI
+- GlimpseGrpcClient for server communication
+- GlimpseGrpcRenderer widget for rendering server-driven UI
 - Comprehensive documentation and examples
-- Flutter-to-SDUI conversion utilities
+- Flutter-to-Glimpse conversion utilities
 - Error handling and loading states