yeriasdk 1.0.0__tar.gz

yeriasdk-1.0.0/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: yeriasdk
+Version: 1.0.0
+Summary: A modern Python SDK for generating dynamic JSON interfaces
+Author: JsonApp Team
+License: MIT
+Keywords: json,interface,form-builder,sdk,dynamic-ui,mobile-apps
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: cryptography>=41.0.0
+Requires-Dist: markdown>=3.4.0
+Requires-Dist: bleach>=6.0.0
+Requires-Dist: requests>=2.28.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: mypy>=1.5.0; extra == "dev"
+Requires-Dist: ruff>=0.0.280; extra == "dev"
+
+# JSONApp Python SDK
+
+> **Note**: This is the Python port of the JSONApp SDK. This repository is a monorepo containing multiple language implementations. See the [root README](../README.md) for an overview.
+
+A stateless backend library for building views that are sent to renderers (mobile or web). This is the Python port of the TypeScript JSONApp SDK.
+
+## Features
+
+- **Stateless Architecture**: No internal state, perfect for serverless and microservices
+- **Ed25519 Signing**: Secure view signing and verification using Ed25519 cryptography
+- **12 View Types**: Form, Reader, ActionList, ActionGrid, QRScan, QRDisplay, Message, Card, Carousel, Timeline, Media, Map
+- **Notifications**: Send signed notifications to users via City-Mate platform
+- **Type Safety**: Full type definitions using Python dataclasses and type hints
+- **Validation**: Built-in field and form validation
+- **Security**: XSS protection, URL validation, input sanitization
+
+## Installation
+
+```bash
+pip install yeriasdk
+```
+
+## Quick Start
+
+```python
+from yeriasdk import JsonApp, JsonAppConfig
+from yeriasdk.views import FormView
+
+# Initialize JsonApp
+config = JsonAppConfig(
+    app_id="my-app",
+    view_expiration_minutes=60,
+)
+app = JsonApp(config)
+
+# Create a form view
+form = app.create_form_view("registration", "User Registration")
+form.add_text_field("name", "Full Name", is_required=True)
+form.add_email_field("email", "Email", is_required=True)
+form.submit_button("Register")
+
+# Serve with signature
+response = app.serve(form)
+print(response.view)  # The view JSON
+print(response.signature)  # Ed25519 signature
+```
+
+## View Types
+
+### FormView
+Create forms with various field types (text, email, password, select, file, GPS, etc.)
+
+### ReaderView
+Display rich content with paragraphs, images, markdown, tables, code blocks, etc.
+
+### ActionListView / ActionGridView
+Display lists or grids of actions
+
+### QRScanView / QRDisplayView
+QR code scanning and display
+
+### MessageView
+Display messages with actions
+
+### CardView
+Display card-based content with stats and sections
+
+### CarouselView
+Display carousel slides
+
+### TimelineView
+Display chronological events
+
+### MediaView
+Display audio and video playlists
+
+### MapView
+Display geographic data on maps
+
+## API Parity
+
+The Python SDK maintains API parity with the TypeScript version:
+
+- Same factory methods: `app.create_form_view()`, `app.create_reader_view()`, etc.
+- Same fluent API: `view.add_field().set_intro().submit_button()` (or `set_note()` for backward compatibility)
+- Same validation and security features
+- Same Ed25519 signing and verification
+
+## Examples
+
+See `examples/basic_usage.py` for a complete example.
+
+## Requirements
+
+- Python 3.10+
+- cryptography (for Ed25519)
+- markdown (for ReaderView markdown support)
+- bleach (for HTML sanitization)
+- requests (for sending notifications)
+
+## Status
+
+✅ Core classes (BaseView, JsonApp)  
+✅ All 12 view types  
+✅ Type definitions  
+✅ Error handling  
+✅ Validation utilities  
+✅ Ed25519 signing/verification  
+✅ Examples  
+
+
+## License
+
+Ce projet est sous licence MIT. Voir le fichier `LICENSE` pour plus de détails.

yeriasdk-1.0.0/README.md

@@ -0,0 +1,114 @@
+# JSONApp Python SDK
+
+> **Note**: This is the Python port of the JSONApp SDK. This repository is a monorepo containing multiple language implementations. See the [root README](../README.md) for an overview.
+
+A stateless backend library for building views that are sent to renderers (mobile or web). This is the Python port of the TypeScript JSONApp SDK.
+
+## Features
+
+- **Stateless Architecture**: No internal state, perfect for serverless and microservices
+- **Ed25519 Signing**: Secure view signing and verification using Ed25519 cryptography
+- **12 View Types**: Form, Reader, ActionList, ActionGrid, QRScan, QRDisplay, Message, Card, Carousel, Timeline, Media, Map
+- **Notifications**: Send signed notifications to users via City-Mate platform
+- **Type Safety**: Full type definitions using Python dataclasses and type hints
+- **Validation**: Built-in field and form validation
+- **Security**: XSS protection, URL validation, input sanitization
+
+## Installation
+
+```bash
+pip install yeriasdk
+```
+
+## Quick Start
+
+```python
+from yeriasdk import JsonApp, JsonAppConfig
+from yeriasdk.views import FormView
+
+# Initialize JsonApp
+config = JsonAppConfig(
+    app_id="my-app",
+    view_expiration_minutes=60,
+)
+app = JsonApp(config)
+
+# Create a form view
+form = app.create_form_view("registration", "User Registration")
+form.add_text_field("name", "Full Name", is_required=True)
+form.add_email_field("email", "Email", is_required=True)
+form.submit_button("Register")
+
+# Serve with signature
+response = app.serve(form)
+print(response.view)  # The view JSON
+print(response.signature)  # Ed25519 signature
+```
+
+## View Types
+
+### FormView
+Create forms with various field types (text, email, password, select, file, GPS, etc.)
+
+### ReaderView
+Display rich content with paragraphs, images, markdown, tables, code blocks, etc.
+
+### ActionListView / ActionGridView
+Display lists or grids of actions
+
+### QRScanView / QRDisplayView
+QR code scanning and display
+
+### MessageView
+Display messages with actions
+
+### CardView
+Display card-based content with stats and sections
+
+### CarouselView
+Display carousel slides
+
+### TimelineView
+Display chronological events
+
+### MediaView
+Display audio and video playlists
+
+### MapView
+Display geographic data on maps
+
+## API Parity
+
+The Python SDK maintains API parity with the TypeScript version:
+
+- Same factory methods: `app.create_form_view()`, `app.create_reader_view()`, etc.
+- Same fluent API: `view.add_field().set_intro().submit_button()` (or `set_note()` for backward compatibility)
+- Same validation and security features
+- Same Ed25519 signing and verification
+
+## Examples
+
+See `examples/basic_usage.py` for a complete example.
+
+## Requirements
+
+- Python 3.10+
+- cryptography (for Ed25519)
+- markdown (for ReaderView markdown support)
+- bleach (for HTML sanitization)
+- requests (for sending notifications)
+
+## Status
+
+✅ Core classes (BaseView, JsonApp)  
+✅ All 12 view types  
+✅ Type definitions  
+✅ Error handling  
+✅ Validation utilities  
+✅ Ed25519 signing/verification  
+✅ Examples  
+
+
+## License
+
+Ce projet est sous licence MIT. Voir le fichier `LICENSE` pour plus de détails.

yeriasdk-1.0.0/pyproject.toml

@@ -0,0 +1,61 @@
+[build-system]
+requires = ["setuptools>=65.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "yeriasdk"
+version = "1.0.0"
+description = "A modern Python SDK for generating dynamic JSON interfaces"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+authors = [
+    { name = "JsonApp Team" }
+]
+keywords = ["json", "interface", "form-builder", "sdk", "dynamic-ui", "mobile-apps"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+
+dependencies = [
+    "cryptography>=41.0.0",
+    "markdown>=3.4.0",
+    "bleach>=6.0.0",
+    "requests>=2.28.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.4.0",
+    "pytest-cov>=4.1.0",
+    "black>=23.0.0",
+    "mypy>=1.5.0",
+    "ruff>=0.0.280",
+]
+
+[tool.setuptools.packages.find]
+where = ["."]
+exclude = ["tests*", "examples*"]
+
+[tool.black]
+line-length = 100
+target-version = ['py310']
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = false
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+

yeriasdk-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

yeriasdk-1.0.0/tests/test_form_view.py

@@ -0,0 +1,149 @@
+"""
+Tests for FormView - Critical functionality including separators and intro field
+"""
+
+import pytest
+from jsonapp import JsonApp, JsonAppConfig
+from jsonapp.views import FormView
+from jsonapp.errors import (
+    MissingRequiredParameterError,
+    FieldValidationError,
+    FieldNotFoundError,
+)
+
+
+class TestFormView:
+    """Test FormView basic functionality"""
+
+    def test_create_form_view(self):
+        """Test creating a basic form view"""
+        form = FormView("test-form", "Test Form")
+        assert form.id == "test-form"
+        assert form.type == "Form"
+        assert form.content["title"] == "Test Form"
+        assert form.content["intro"] == ""
+        assert form.content["fields"] == []
+
+    def test_set_intro(self):
+        """Test setting intro field"""
+        form = FormView("test-form", "Test Form")
+        form.set_intro("Please fill in the form")
+        assert form.content["intro"] == "Please fill in the form"
+
+    def test_set_note_deprecated(self):
+        """Test that set_note() still works for backward compatibility"""
+        form = FormView("test-form", "Test Form")
+        form.set_note("Old note method")
+        assert form.content["intro"] == "Old note method"
+
+    def test_add_text_field(self):
+        """Test adding a text field"""
+        form = FormView("test-form", "Test Form")
+        form.add_text_field("name", "Full Name", is_required=True)
+        assert len(form.content["fields"]) == 1
+        field = form.content["fields"][0]
+        assert field["fieldType"] == "text"
+        assert field["fieldId"] == "name"
+        assert field["fieldLabel"] == "Full Name"
+        assert field["required"] is True
+
+    def test_add_separator(self):
+        """Test adding a separator field"""
+        form = FormView("test-form", "Test Form")
+        form.add_text_field("name", "Name")
+        form.add_separator()
+        form.add_email_field("email", "Email")
+        
+        assert len(form.content["fields"]) == 3
+        separator = form.content["fields"][1]
+        assert separator["fieldType"] == "separator"
+        assert separator["fieldLabel"] == ""
+        assert "fieldId" in separator
+
+    def test_add_separator_with_id(self):
+        """Test adding a separator with explicit ID"""
+        form = FormView("test-form", "Test Form")
+        form.add_separator("custom-separator")
+        
+        separator = form.content["fields"][0]
+        assert separator["fieldType"] == "separator"
+        assert separator["fieldId"] == "custom-separator"
+
+    def test_get_field_count(self):
+        """Test get_field_count() method"""
+        form = FormView("test-form", "Test Form")
+        form.add_text_field("name", "Name")
+        form.add_separator()
+        form.add_email_field("email", "Email")
+        
+        assert form.get_field_count() == 3
+        assert form.get_field_count(exclude_separators=True) == 2
+
+    def test_submit_button(self):
+        """Test setting submit button"""
+        form = FormView("test-form", "Test Form")
+        form.add_text_field("name", "Name")
+        form.submit_button("Submit", "POST")
+        
+        assert form.content["submit"] is not None
+        assert form.content["submit"]["text"] == "Submit"
+        assert form.content["submit"]["method"] == "POST"
+
+    def test_validation_requires_field(self):
+        """Test that form validation requires at least one non-separator field"""
+        form = FormView("test-form", "Test Form")
+        form.add_separator()
+        
+        result = form._validate()
+        assert result.is_valid is False
+        assert any("non-separator field" in str(e.message) for e in result.errors)
+
+    def test_validation_with_real_fields(self):
+        """Test that form with real fields passes validation"""
+        form = FormView("test-form", "Test Form")
+        form.add_text_field("name", "Name")
+        form.add_separator()
+        form.add_email_field("email", "Email")
+        
+        result = form._validate()
+        assert result.is_valid is True
+
+    def test_get_field(self):
+        """Test getting a field by ID"""
+        form = FormView("test-form", "Test Form")
+        form.add_text_field("name", "Name")
+        
+        field = form.get_field("name")
+        assert field is not None
+        assert field["fieldId"] == "name"
+
+    def test_get_field_not_found(self):
+        """Test getting a non-existent field"""
+        form = FormView("test-form", "Test Form")
+        field = form.get_field("nonexistent")
+        assert field is None
+
+    def test_remove_field(self):
+        """Test removing a field"""
+        form = FormView("test-form", "Test Form")
+        form.add_text_field("name", "Name")
+        form.add_email_field("email", "Email")
+        
+        result = form.remove_field("name")
+        assert result is True
+        assert len(form.content["fields"]) == 1
+        assert form.content["fields"][0]["fieldId"] == "email"
+
+    def test_inject_data(self):
+        """Test injecting data into form fields"""
+        form = FormView("test-form", "Test Form")
+        form.add_text_field("name", "Name")
+        form.add_email_field("email", "Email")
+        
+        errors = form.inject_data({"name": "John Doe", "email": "john@example.com"})
+        assert len(errors) == 0
+        
+        name_field = form.get_field("name")
+        assert name_field["value"] == "John Doe"
+
+

yeriasdk-1.0.0/tests/test_intro_fields.py

@@ -0,0 +1,70 @@
+"""
+Tests for intro field support across all views
+"""
+
+import pytest
+from jsonapp import JsonApp, JsonAppConfig
+from jsonapp.views import (
+    ActionListView,
+    ActionGridView,
+    MapView,
+    ReaderView,
+    QRScanView,
+    MessageView,
+    TimelineView,
+    MediaView,
+)
+
+
+class TestIntroFields:
+    """Test intro field support across views"""
+
+    def test_action_list_view_intro(self):
+        """Test ActionListView intro support"""
+        view = ActionListView("test-list", "Test List")
+        view.set_intro("Select an option")
+        assert view.content["intro"] == "Select an option"
+
+    def test_action_grid_view_intro(self):
+        """Test ActionGridView intro support"""
+        view = ActionGridView("test-grid", "Test Grid")
+        view.set_intro("Choose an action")
+        assert view.content["intro"] == "Choose an action"
+
+    def test_map_view_intro(self):
+        """Test MapView intro support"""
+        view = MapView("test-map", "Test Map")
+        view.set_intro("Find locations on the map")
+        assert view.content["intro"] == "Find locations on the map"
+
+    def test_reader_view_intro(self):
+        """Test ReaderView intro support"""
+        view = ReaderView("test-reader", "Test Reader")
+        view.set_intro("Read the content below")
+        assert view.content["intro"] == "Read the content below"
+
+    def test_qr_scan_view_intro(self):
+        """Test QRScanView intro support"""
+        view = QRScanView("test-scan", "Test Scanner")
+        view.set_intro("Point camera at QR code")
+        assert view.content["intro"] == "Point camera at QR code"
+
+    def test_message_view_intro(self):
+        """Test MessageView intro support"""
+        view = MessageView("test-msg", "Test Message")
+        view.set_intro("Welcome message")
+        assert view.content["intro"] == "Welcome message"
+
+    def test_timeline_view_intro(self):
+        """Test TimelineView intro support"""
+        view = TimelineView("test-timeline", "Test Timeline")
+        view.set_intro("View your timeline")
+        assert view.content["intro"] == "View your timeline"
+
+    def test_media_view_intro(self):
+        """Test MediaView intro support"""
+        view = MediaView("test-media", "Test Media")
+        view.set_intro("Browse media")
+        assert view.content["intro"] == "Browse media"
+
+

yeriasdk-1.0.0/tests/test_jsonapp.py

@@ -0,0 +1,107 @@
+"""
+Tests for JsonApp - Signing, verification, and factory methods
+"""
+
+import pytest
+import time
+from jsonapp import JsonApp, JsonAppConfig
+from jsonapp.views import FormView
+from jsonapp.errors import (
+    AppIdMismatchError,
+    ViewExpiredError,
+    SignatureVerificationError,
+)
+
+
+class TestJsonApp:
+    """Test JsonApp core functionality"""
+
+    def test_create_jsonapp(self):
+        """Test creating JsonApp instance"""
+        config = JsonAppConfig(app_id="test-app", view_expiration_minutes=60)
+        app = JsonApp(config)
+        assert app.config.app_id == "test-app"
+        assert app.config.view_expiration_minutes == 60
+
+    def test_create_form_view(self):
+        """Test factory method for FormView"""
+        config = JsonAppConfig(app_id="test-app")
+        app = JsonApp(config)
+        form = app.create_form_view("test-form", "Test Form")
+        assert isinstance(form, FormView)
+        assert form.id == "test-form"
+
+    def test_serve_view(self):
+        """Test serving a view with signature"""
+        config = JsonAppConfig(app_id="test-app")
+        app = JsonApp(config)
+        form = app.create_form_view("test-form", "Test Form")
+        form.add_text_field("name", "Name")
+        
+        response = app.serve(form)
+        assert response.app_id == "test-app"
+        assert response.signature is not None
+        assert response.timestamp > 0
+        assert response.view is not None
+        assert response.view["id"] == "test-form"
+
+    def test_get_public_key(self):
+        """Test getting public key"""
+        config = JsonAppConfig(app_id="test-app")
+        app = JsonApp(config)
+        public_key = app.get_public_key()
+        assert public_key is not None
+        assert "BEGIN PUBLIC KEY" in public_key or "BEGIN PUBLIC KEY" in public_key
+
+    def test_verify_integrity_success(self):
+        """Test verifying integrity of a valid response"""
+        config = JsonAppConfig(app_id="test-app", view_expiration_minutes=60)
+        app = JsonApp(config)
+        form = app.create_form_view("test-form", "Test Form")
+        form.add_text_field("name", "Name")
+        
+        response = app.serve(form)
+        result = app.verify_integrity(response)
+        assert result is True
+
+    def test_verify_integrity_app_id_mismatch(self):
+        """Test verification fails with wrong app ID"""
+        config1 = JsonAppConfig(app_id="app-1")
+        app1 = JsonApp(config1)
+        form = app1.create_form_view("test-form", "Test Form")
+        form.add_text_field("name", "Name")
+        response = app1.serve(form)
+        
+        config2 = JsonAppConfig(app_id="app-2")
+        app2 = JsonApp(config2)
+        
+        with pytest.raises(AppIdMismatchError):
+            app2.verify_integrity(response)
+
+    def test_static_sign_view(self):
+        """Test static sign_view method"""
+        config = JsonAppConfig(app_id="test-app")
+        app = JsonApp(config)
+        form = app.create_form_view("test-form", "Test Form")
+        form.add_text_field("name", "Name")
+        view_json = form.to_json()
+        
+        private_key = app.get_public_key()  # In real usage, use private key
+        # Note: This test would need actual private key to work properly
+        # For now, just verify the method exists and accepts parameters
+        assert hasattr(JsonApp, "sign_view")
+
+    def test_static_verify_signature(self):
+        """Test static verify_signature method"""
+        config = JsonAppConfig(app_id="test-app")
+        app = JsonApp(config)
+        form = app.create_form_view("test-form", "Test Form")
+        form.add_text_field("name", "Name")
+        
+        response = app.serve(form)
+        public_key = app.get_public_key()
+        
+        result = JsonApp.verify_signature(public_key, response)
+        assert result is True
+
+