nardial 0.2.2__tar.gz → 0.3.2__tar.gz

{nardial-0.2.2/src/nardial.egg-info → nardial-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nardial
-Version: 0.2.2
+Version: 0.3.2
 Summary: Nardial Dialog System
 Author-email: Mike Ligthart <m.e.u.ligthart@vu.nl>
 Maintainer: Clara Fayyad, Landon Brown, Evelyne Prodescu
@@ -17,15 +17,20 @@ Provides-Extra: dialogflow
 Requires-Dist: social-interaction-cloud[dialogflow]; extra == "dialogflow"
 Provides-Extra: openai
 Requires-Dist: social-interaction-cloud[openai-gpt]; extra == "openai"
+Provides-Extra: webserver
+Requires-Dist: social-interaction-cloud[webserver]; extra == "webserver"
 Provides-Extra: all
-Requires-Dist: nardial[dialogflow,elevenlabs,google-tts,openai]; extra == "all"
+Requires-Dist: nardial[dialogflow,elevenlabs,google-tts,openai,webserver]; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
 Dynamic: license-file
 
 # NarDialPy
 
 **NarDialPy** is a Python package for building and running **narrative-driven, structured dialog systems** — designed for social robots and conversational agents.
 
-It lets you author complete conversations declaratively in JSON, then drive them from Python using voice, NLU, and LLM services. The package handles session flow, branching logic, topic tracking, and personalization so you can focus on what the robot says and how conversations unfold.
+It lets you author complete conversations declaratively in JSON, then drive them from Python using voice, NLU, LLM, and browser-based screen services. The package handles session flow, branching logic, topic tracking, personalization, and screen output so you can focus on what the robot says and how conversations unfold.
 
 ---
 
@@ -53,6 +58,7 @@ The `nardial` package provides the building blocks for authoring and executing m
 | **Dialog JSON** | Conversations are written as structured JSON files. Each file holds one or more *dialogs*, each containing a sequence of *moves* that the robot performs. |
 | **Session Manager** | Loads your dialog JSON, resolves a session agenda, and runs dialogs in order — checking dependencies and tracking state. |
 | **ConversationAgent** | The runtime bridge to the hardware: it calls TTS, STT, LLM, and motion services on your chosen device. |
+| **Screen Provider** | Optional browser-based display layer for transcripts, images, videos, HTML, buttons, and web input. |
 | **Dialog Logic** | Checks eligibility rules (dependencies, variable requirements) before executing each dialog. |
 
 Typical use case:
@@ -165,6 +171,7 @@ NarDialPy is built around a set of provider protocols. Each protocol defines a r
 | | `WrittenKeywordNLUProvider` | `nardial.providers.nlu.written_keyword` | base (keyboard input) |
 | **LLM** | `OpenAIGPTProvider` | `nardial.providers.llm.openai_gpt` | `nardial[openai]` |
 | | `EchoLLMProvider` | `nardial.providers.llm.echo` | base (echoes user input) |
+| **Screen** | `ScreenProvider` / `SICScreenAdapter` / `PepperTabletScreenAdapter` | `nardial.providers.screen` | browser display via SIC webserver |
 | **Vector store** | `RedisVectorStoreProvider` | `nardial.providers.vector_store.redis_store` | base + running Redis |
 | | `NullVectorStoreProvider` | `nardial.providers.vector_store.null` | base |
 
@@ -351,7 +358,7 @@ Utility dialogs for session management — greetings, farewells, and structural
     {
       "type": "ask_open",
       "text": "Please tell me your name.",
-      "set_variable": "first_name",
+      "set_variable": "first_name"
     }
   ]
 }
@@ -366,7 +373,7 @@ Short, theme-based conversations on everyday topics. Chitchat dialogs can be see
 | Extra field | Type | Required | Description |
 |---|---|---|---|
 | `theme` | string | ✅ | Broad category (e.g. `"nature"`, `"animals"`, `"robots"`) |
-| `topics` | array of strings | | Specific keywords used for relevance matching |
+| `topics` | array of strings | | Specific keywords used to drive relevance matching |
 
 ```json
 {
@@ -501,7 +508,7 @@ Asks a free-text question and listens for any spoken reply. The answer can be st
   "type": "ask_open",
   "text": "What is your favorite color?",
   "set_variable": "favorite_color",
-  "add_interest_from_answer": true,
+  "add_interest_from_answer": true
 }
 ```
 
@@ -675,29 +682,125 @@ Triggers a named animation behavior on the robot.
 
 ---
 
+#### `timed_wait`
+
+Pause execution for a fixed duration before proceeding to the next move. Useful to add natural pauses or give the user time to look at the screen.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `type` | string | ✅ | `"timed_wait"` |
+| `duration_seconds` | number | ✅ | Seconds to wait. (Alias: `duration` is also accepted.) |
+
+```json
+{ "type": "timed_wait", "duration_seconds": 2.5 }
+```
+
+---
+
+#### `wait_for_web_input`
+
+Suspend dialog execution until a matching web input event arrives or until a timeout elapses. The web UI can present buttons or a short input and emit `web_input` events which this move listens for.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `type` | string | ✅ | `"wait_for_web_input"` |
+| `prompt` | string | | Hint text shown in the web UI (not spoken) |
+| `options` | array of strings | | Accepted `value` strings from the web event (if omitted, any value is accepted) |
+| `timeout` | number | | Seconds to wait before falling back (omit for indefinite wait) |
+| `outcomes` | object | | Maps option value → outcome label for branching |
+| `default_outcome` | string | | Outcome used on timeout or when no event matches |
+
+```json
+{
+  "type": "wait_for_web_input",
+  "prompt": "Choose a sticker to show",
+  "options": ["smile","thumbs","surprised"],
+  "timeout": 15,
+  "outcomes": {"smile": "picked_smile"},
+  "default_outcome": "no_choice"
+}
+```
+
+---
+
+#### `show_image`
+
+Display an image on the connected screen (browser / tablet). Accepts a local path relative to the static assets directory or a full URL.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `type` | string | ✅ | `"show_image"` |
+| `src` | string | ✅ | Path or URL to the image (aliases: `image`, `path`) |
+
+```json
+{ "type": "show_image", "src": "assets/images/robot_pet.png" }
+```
+
+---
+
+#### `show_video`
+
+Display a video on the screen. Can accept a local file path or an embeddable URL (e.g. a YouTube embed link).
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `type` | string | ✅ | `"show_video"` |
+| `src` | string | ✅ | Video file path or embeddable URL (aliases: `video`, `path`) |
+
+```json
+{ "type": "show_video", "src": "https://www.youtube.com/embed/VIDEO_ID" }
+```
+
+---
+
+#### `show_iframe`
+
+Embed an external web page inside an iframe on the screen. Use this for interactive web content served from a trusted origin.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `type` | string | ✅ | `"show_iframe"` |
+| `url` | string | ✅ | URL to embed (aliases: `src`, `iframe_url`) |
+
+```json
+{ "type": "show_iframe", "url": "https://example.com/mini-game" }
+```
+
+---
+
+#### `show_html`
+
+Render a raw HTML snippet directly into the display area. The frontend inserts this via innerHTML — treat content as trusted and avoid injecting untrusted user data.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `type` | string | ✅ | `"show_html"` |
+| `html` | string | ✅ | HTML snippet to render |
+
+```json
+{ "type": "show_html", "html": "<div class=\"card\">Hi there!</div>" }
+```
+
+---
+
+#### `black_screen`
+
+Clear the display (show a blank/black screen). No parameters — the next display move will restore content.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `type` | string | ✅ | `"black_screen"` |
+
+```json
+{ "type": "black_screen" }
+```
+
+---
+
 ### Key JSON Attributes
 
 | Attribute | Where used | Description |
 |---|---|---|
-| `id` | dialog | Unique dialog identifier |
-| `type` | dialog | Dialog type: `functional`, `chitchat`, `narrative`, `llm_based` |
-| `functional_type` | functional dialog | `"greeting"` or `"farewell"` |
-| `thread` | narrative dialog | Story thread name |
-| `position` | narrative dialog | Order within the thread |
-| `theme` | chitchat dialog | Broad topic category |
-| `topics` | chitchat dialog | Keywords for relevance matching |
-| `prompt` | llm_based dialog / `ask_llm` | LLM system prompt |
-| `moves` | dialog | Ordered list of move objects |
-| `dependencies` | dialog | Dialog IDs that must be completed first |
-| `variable_dependencies` | dialog | Variables that must exist in the user model |
-| `set_variable` | move | Saves the user's answer into the user model |
-| `outcomes` | move | Maps answers/intents to outcome labels for branching |
-| `default_outcome` | move | Fallback outcome when no match is found |
-| `add_interest` | `ask_yesno` move | Adds a fixed topic when user says yes |
-| `add_interest_from_answer` | `ask_open` move | Adds the spoken answer as a topic of interest |
-| `add_interest_from_variable` | `ask_open` / `ask_options` move | Adds the stored variable's value as a topic |
-| `llm_followup` | ask moves | System prompt for an inline LLM follow-up response |
-| `%variable%` | `text` values | Placeholder replaced at runtime with the stored variable value |
 
 ---
 
@@ -708,6 +811,8 @@ All you need is a minimal Python script that wires up the device, loads the dial
 Two ready-to-run demos are included in the `examples/` directory:
 * Demo 1 — General Conversation (`demo_general_conversation.py`): A simple four-step conversation using a mix of narrative and functional dialogs
 * Demo 2 — Structured Conversation (`demo_structured_conversation.py`): A more complete example that demonstrates all dialog types and move types, including `ask_llm`, `play`, `motion_sequence`, and `animation`
+* Demo 3 — Screen Display (`demo_screen_provider.py`): Shows the browser-based screen UI with transcripts, images, iframes, HTML snippets, buttons, and text input
+* Demo 4 — Pepper Tablet (`demo_pepper_tablet.py`): Uses the same screen UI on Pepper's tablet through the SIC webserver
 
 You can find additional demos in the [SIC Applications repository](https://github.com/Social-AI-VU/sic_applications/tree/main/demos/nardial)
 
@@ -720,5 +825,3 @@ Run tests from the repository root:
 ```bash
 python -m pytest -q
 ```
-
----

nardial-0.2.2/PKG-INFO → nardial-0.3.2/README.md

@@ -1,31 +1,8 @@
-Metadata-Version: 2.4
-Name: nardial
-Version: 0.2.2
-Summary: Nardial Dialog System
-Author-email: Mike Ligthart <m.e.u.ligthart@vu.nl>
-Maintainer: Clara Fayyad, Landon Brown, Evelyne Prodescu
-License-Expression: AGPL-3.0-only
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: social-interaction-cloud
-Provides-Extra: google-tts
-Requires-Dist: social-interaction-cloud[google-tts]; extra == "google-tts"
-Provides-Extra: elevenlabs
-Requires-Dist: social-interaction-cloud[elevenlabs-tts]; extra == "elevenlabs"
-Provides-Extra: dialogflow
-Requires-Dist: social-interaction-cloud[dialogflow]; extra == "dialogflow"
-Provides-Extra: openai
-Requires-Dist: social-interaction-cloud[openai-gpt]; extra == "openai"
-Provides-Extra: all
-Requires-Dist: nardial[dialogflow,elevenlabs,google-tts,openai]; extra == "all"
-Dynamic: license-file
-
 # NarDialPy
 
 **NarDialPy** is a Python package for building and running **narrative-driven, structured dialog systems** — designed for social robots and conversational agents.
 
-It lets you author complete conversations declaratively in JSON, then drive them from Python using voice, NLU, and LLM services. The package handles session flow, branching logic, topic tracking, and personalization so you can focus on what the robot says and how conversations unfold.
+It lets you author complete conversations declaratively in JSON, then drive them from Python using voice, NLU, LLM, and browser-based screen services. The package handles session flow, branching logic, topic tracking, personalization, and screen output so you can focus on what the robot says and how conversations unfold.
 
 ---
 
@@ -53,6 +30,7 @@ The `nardial` package provides the building blocks for authoring and executing m
 | **Dialog JSON** | Conversations are written as structured JSON files. Each file holds one or more *dialogs*, each containing a sequence of *moves* that the robot performs. |
 | **Session Manager** | Loads your dialog JSON, resolves a session agenda, and runs dialogs in order — checking dependencies and tracking state. |
 | **ConversationAgent** | The runtime bridge to the hardware: it calls TTS, STT, LLM, and motion services on your chosen device. |
+| **Screen Provider** | Optional browser-based display layer for transcripts, images, videos, HTML, buttons, and web input. |
 | **Dialog Logic** | Checks eligibility rules (dependencies, variable requirements) before executing each dialog. |
 
 Typical use case:
@@ -165,6 +143,7 @@ NarDialPy is built around a set of provider protocols. Each protocol defines a r
 | | `WrittenKeywordNLUProvider` | `nardial.providers.nlu.written_keyword` | base (keyboard input) |
 | **LLM** | `OpenAIGPTProvider` | `nardial.providers.llm.openai_gpt` | `nardial[openai]` |
 | | `EchoLLMProvider` | `nardial.providers.llm.echo` | base (echoes user input) |
+| **Screen** | `ScreenProvider` / `SICScreenAdapter` / `PepperTabletScreenAdapter` | `nardial.providers.screen` | browser display via SIC webserver |
 | **Vector store** | `RedisVectorStoreProvider` | `nardial.providers.vector_store.redis_store` | base + running Redis |
 | | `NullVectorStoreProvider` | `nardial.providers.vector_store.null` | base |
 
@@ -351,7 +330,7 @@ Utility dialogs for session management — greetings, farewells, and structural
     {
       "type": "ask_open",
       "text": "Please tell me your name.",
-      "set_variable": "first_name",
+      "set_variable": "first_name"
     }
   ]
 }
@@ -366,7 +345,7 @@ Short, theme-based conversations on everyday topics. Chitchat dialogs can be see
 | Extra field | Type | Required | Description |
 |---|---|---|---|
 | `theme` | string | ✅ | Broad category (e.g. `"nature"`, `"animals"`, `"robots"`) |
-| `topics` | array of strings | | Specific keywords used for relevance matching |
+| `topics` | array of strings | | Specific keywords used to drive relevance matching |
 
 ```json
 {
@@ -501,7 +480,7 @@ Asks a free-text question and listens for any spoken reply. The answer can be st
   "type": "ask_open",
   "text": "What is your favorite color?",
   "set_variable": "favorite_color",
-  "add_interest_from_answer": true,
+  "add_interest_from_answer": true
 }
 ```
 
@@ -675,29 +654,125 @@ Triggers a named animation behavior on the robot.
 
 ---
 
+#### `timed_wait`
+
+Pause execution for a fixed duration before proceeding to the next move. Useful to add natural pauses or give the user time to look at the screen.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `type` | string | ✅ | `"timed_wait"` |
+| `duration_seconds` | number | ✅ | Seconds to wait. (Alias: `duration` is also accepted.) |
+
+```json
+{ "type": "timed_wait", "duration_seconds": 2.5 }
+```
+
+---
+
+#### `wait_for_web_input`
+
+Suspend dialog execution until a matching web input event arrives or until a timeout elapses. The web UI can present buttons or a short input and emit `web_input` events which this move listens for.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `type` | string | ✅ | `"wait_for_web_input"` |
+| `prompt` | string | | Hint text shown in the web UI (not spoken) |
+| `options` | array of strings | | Accepted `value` strings from the web event (if omitted, any value is accepted) |
+| `timeout` | number | | Seconds to wait before falling back (omit for indefinite wait) |
+| `outcomes` | object | | Maps option value → outcome label for branching |
+| `default_outcome` | string | | Outcome used on timeout or when no event matches |
+
+```json
+{
+  "type": "wait_for_web_input",
+  "prompt": "Choose a sticker to show",
+  "options": ["smile","thumbs","surprised"],
+  "timeout": 15,
+  "outcomes": {"smile": "picked_smile"},
+  "default_outcome": "no_choice"
+}
+```
+
+---
+
+#### `show_image`
+
+Display an image on the connected screen (browser / tablet). Accepts a local path relative to the static assets directory or a full URL.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `type` | string | ✅ | `"show_image"` |
+| `src` | string | ✅ | Path or URL to the image (aliases: `image`, `path`) |
+
+```json
+{ "type": "show_image", "src": "assets/images/robot_pet.png" }
+```
+
+---
+
+#### `show_video`
+
+Display a video on the screen. Can accept a local file path or an embeddable URL (e.g. a YouTube embed link).
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `type` | string | ✅ | `"show_video"` |
+| `src` | string | ✅ | Video file path or embeddable URL (aliases: `video`, `path`) |
+
+```json
+{ "type": "show_video", "src": "https://www.youtube.com/embed/VIDEO_ID" }
+```
+
+---
+
+#### `show_iframe`
+
+Embed an external web page inside an iframe on the screen. Use this for interactive web content served from a trusted origin.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `type` | string | ✅ | `"show_iframe"` |
+| `url` | string | ✅ | URL to embed (aliases: `src`, `iframe_url`) |
+
+```json
+{ "type": "show_iframe", "url": "https://example.com/mini-game" }
+```
+
+---
+
+#### `show_html`
+
+Render a raw HTML snippet directly into the display area. The frontend inserts this via innerHTML — treat content as trusted and avoid injecting untrusted user data.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `type` | string | ✅ | `"show_html"` |
+| `html` | string | ✅ | HTML snippet to render |
+
+```json
+{ "type": "show_html", "html": "<div class=\"card\">Hi there!</div>" }
+```
+
+---
+
+#### `black_screen`
+
+Clear the display (show a blank/black screen). No parameters — the next display move will restore content.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `type` | string | ✅ | `"black_screen"` |
+
+```json
+{ "type": "black_screen" }
+```
+
+---
+
 ### Key JSON Attributes
 
 | Attribute | Where used | Description |
 |---|---|---|
-| `id` | dialog | Unique dialog identifier |
-| `type` | dialog | Dialog type: `functional`, `chitchat`, `narrative`, `llm_based` |
-| `functional_type` | functional dialog | `"greeting"` or `"farewell"` |
-| `thread` | narrative dialog | Story thread name |
-| `position` | narrative dialog | Order within the thread |
-| `theme` | chitchat dialog | Broad topic category |
-| `topics` | chitchat dialog | Keywords for relevance matching |
-| `prompt` | llm_based dialog / `ask_llm` | LLM system prompt |
-| `moves` | dialog | Ordered list of move objects |
-| `dependencies` | dialog | Dialog IDs that must be completed first |
-| `variable_dependencies` | dialog | Variables that must exist in the user model |
-| `set_variable` | move | Saves the user's answer into the user model |
-| `outcomes` | move | Maps answers/intents to outcome labels for branching |
-| `default_outcome` | move | Fallback outcome when no match is found |
-| `add_interest` | `ask_yesno` move | Adds a fixed topic when user says yes |
-| `add_interest_from_answer` | `ask_open` move | Adds the spoken answer as a topic of interest |
-| `add_interest_from_variable` | `ask_open` / `ask_options` move | Adds the stored variable's value as a topic |
-| `llm_followup` | ask moves | System prompt for an inline LLM follow-up response |
-| `%variable%` | `text` values | Placeholder replaced at runtime with the stored variable value |
 
 ---
 
@@ -708,6 +783,8 @@ All you need is a minimal Python script that wires up the device, loads the dial
 Two ready-to-run demos are included in the `examples/` directory:
 * Demo 1 — General Conversation (`demo_general_conversation.py`): A simple four-step conversation using a mix of narrative and functional dialogs
 * Demo 2 — Structured Conversation (`demo_structured_conversation.py`): A more complete example that demonstrates all dialog types and move types, including `ask_llm`, `play`, `motion_sequence`, and `animation`
+* Demo 3 — Screen Display (`demo_screen_provider.py`): Shows the browser-based screen UI with transcripts, images, iframes, HTML snippets, buttons, and text input
+* Demo 4 — Pepper Tablet (`demo_pepper_tablet.py`): Uses the same screen UI on Pepper's tablet through the SIC webserver
 
 You can find additional demos in the [SIC Applications repository](https://github.com/Social-AI-VU/sic_applications/tree/main/demos/nardial)
 
@@ -720,5 +797,3 @@ Run tests from the repository root:
 ```bash
 python -m pytest -q
 ```
-
----

{nardial-0.2.2 → nardial-0.3.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "nardial"
-version = "0.2.2"
+version = "0.3.2"
 description = "Nardial Dialog System"
 readme = "README.md"
 requires-python = ">=3.12"
@@ -28,8 +28,13 @@ dependencies = [
 google-tts = ["social-interaction-cloud[google-tts]"]
 elevenlabs = ["social-interaction-cloud[elevenlabs-tts]"]
 dialogflow = ["social-interaction-cloud[dialogflow]"]
-openai     = ["social-interaction-cloud[openai-gpt]"]
-all        = ["nardial[google-tts,elevenlabs,dialogflow,openai]"]
+openai = ["social-interaction-cloud[openai-gpt]"]
+webserver  = ["social-interaction-cloud[webserver]"]
+all = ["nardial[google-tts,elevenlabs,dialogflow,openai,webserver]"]
+dev = ["pytest", "pytest-asyncio"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
 
 [tool.setuptools]
 package-dir = {"" = "src"}
@@ -37,3 +42,6 @@ license-files = ["LICENSE"]
 
 [tool.setuptools.packages.find]
 where = ["src"]
+
+[tool.setuptools.package-data]
+"nardial.providers.screen" = ["web/templates/*.html", "web/static/*.css", "web/static/*.js"]

{nardial-0.2.2 → nardial-0.3.2}/src/nardial/authoring/factory.py

@@ -11,6 +11,13 @@ from nardial.moves import (
     MOVE_MOTION_SEQUENCE,
     MOVE_ANIMATION,
     MOVE_BRANCH,
+    MOVE_TIMED_WAIT,
+    MOVE_WAIT_FOR_WEB_INPUT,
+    MOVE_SHOW_IMAGE,
+    MOVE_SHOW_VIDEO,
+    MOVE_SHOW_IFRAME,
+    MOVE_SHOW_HTML,
+    MOVE_BLACK_SCREEN,
 )
 
 
@@ -24,6 +31,13 @@ ALLOWED_MOVE_TYPES = {
     MOVE_MOTION_SEQUENCE,
     MOVE_ANIMATION,
     MOVE_BRANCH,
+    MOVE_TIMED_WAIT,
+    MOVE_WAIT_FOR_WEB_INPUT,
+    MOVE_SHOW_IMAGE,
+    MOVE_SHOW_VIDEO,
+    MOVE_SHOW_IFRAME,
+    MOVE_SHOW_HTML,
+    MOVE_BLACK_SCREEN,
 }