optimizely-opal.opal-tools-sdk 0.1.32.dev0__tar.gz → 0.1.35.dev0__tar.gz

{optimizely_opal_opal_tools_sdk-0.1.32.dev0 → optimizely_opal_opal_tools_sdk-0.1.35.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: optimizely-opal.opal-tools-sdk
-Version: 0.1.32.dev0
+Version: 0.1.35.dev0
 Summary: SDK for creating Opal-compatible tools services
 Home-page: https://github.com/optimizely/opal-tools-sdk
 Author: Optimizely

{optimizely_opal_opal_tools_sdk-0.1.32.dev0 → optimizely_opal_opal_tools_sdk-0.1.35.dev0}/opal_tools_sdk/decorators.py

@@ -95,6 +95,7 @@ def tool(
     description: str,
     auth_requirements: list[dict[str, Any]] | None = None,
     ui_resource: str | None = None,
+    wait: bool = False,
 ):
     """Decorator to register a function as an Opal tool.
 
@@ -108,6 +109,8 @@ def tool(
             "scope_bundle": "calendar", "required": True}]
         ui_resource: URI of associated UI resource for dynamic rendering (optional)
             Example: "ui://my-app/create-form"
+        wait: When True, invoking this tool pauses the agent execution until the caller
+            signals completion.
 
     Returns:
         Decorator function
@@ -294,6 +297,7 @@ def tool(
                 endpoint=endpoint,
                 auth_requirements=auth_req_list,
                 ui_resource=ui_resource,
+                wait=wait,
             )
 
         return func

{optimizely_opal_opal_tools_sdk-0.1.32.dev0 → optimizely_opal_opal_tools_sdk-0.1.35.dev0}/opal_tools_sdk/models.py

@@ -102,10 +102,11 @@ class Function:
     auth_requirements: list[AuthRequirement] | None = None
     http_method: str = "POST"
     ui_resource: str | None = None  # UI resource URI for dynamic UI rendering
+    wait: bool = False  # When True, pauses the agent until the caller signals completion
 
     def to_dict(self) -> dict[str, Any]:
         """Convert to dictionary for the discovery endpoint."""
-        result = {
+        result: dict[str, Any] = {
             "name": self.name,
             "description": self.description,
             "parameters": [p.to_dict() for p in self.parameters],
@@ -119,6 +120,9 @@ class Function:
         if self.ui_resource:
             result["ui_resource"] = self.ui_resource
 
+        if self.wait:
+            result["wait"] = self.wait
+
         return result
 
 

{optimizely_opal_opal_tools_sdk-0.1.32.dev0 → optimizely_opal_opal_tools_sdk-0.1.35.dev0}/opal_tools_sdk/proteus.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  proteus-document-spec.json
-#   timestamp: 2026-05-11T14:40:18+00:00
+#   timestamp: 2026-05-18T18:51:08+00:00
 
 from __future__ import annotations
 
@@ -27,6 +27,11 @@ class ProteusEventHandler1(BaseModel):
     )
 
 
+class File(BaseModel):
+    link: str
+    name: str
+
+
 class Series(BaseModel):
     model_config = ConfigDict(
         extra="forbid",
@@ -130,7 +135,7 @@ class ProteusCondition1(BaseModel):
         extra="forbid",
     )
     field__: list[str | float | bool | ProteusMapIndex | ProteusValue | None] = Field(
-        ..., alias="!=", description="Inequality comparison", max_length=2, min_length=2
+        ..., alias="!=", description="Inequality comparison"
     )
 
 
@@ -143,7 +148,7 @@ class ProteusCondition2(BaseModel):
         extra="forbid",
     )
     field_: list[str | float | bool | ProteusMapIndex | ProteusValue | None] = Field(
-        ..., alias="<", description="Less than comparison", max_length=2, min_length=2
+        ..., alias="<", description="Less than comparison"
     )
 
 
@@ -156,7 +161,7 @@ class ProteusCondition3(BaseModel):
         extra="forbid",
     )
     field__: list[str | float | bool | ProteusMapIndex | ProteusValue | None] = Field(
-        ..., alias="<=", description="Less than or equal comparison", max_length=2, min_length=2
+        ..., alias="<=", description="Less than or equal comparison"
     )
 
 
@@ -169,7 +174,7 @@ class ProteusCondition4(BaseModel):
         extra="forbid",
     )
     field__: list[str | float | bool | ProteusMapIndex | ProteusValue | None] = Field(
-        ..., alias="==", description="Equality comparison", max_length=2, min_length=2
+        ..., alias="==", description="Equality comparison"
     )
 
 
@@ -182,7 +187,7 @@ class ProteusCondition5(BaseModel):
         extra="forbid",
     )
     field_: list[str | float | bool | ProteusMapIndex | ProteusValue | None] = Field(
-        ..., alias=">", description="Greater than comparison", max_length=2, min_length=2
+        ..., alias=">", description="Greater than comparison"
     )
 
 
@@ -195,7 +200,7 @@ class ProteusCondition6(BaseModel):
         extra="forbid",
     )
     field__: list[str | float | bool | ProteusMapIndex | ProteusValue | None] = Field(
-        ..., alias=">=", description="Greater than or equal comparison", max_length=2, min_length=2
+        ..., alias=">=", description="Greater than or equal comparison"
     )
 
 
@@ -238,10 +243,7 @@ class ProteusCondition9(BaseModel):
         extra="forbid",
     )
     and_: list[ProteusCondition] = Field(
-        ...,
-        alias="and",
-        description="Logical AND - returns true if all conditions are true",
-        min_length=1,
+        ..., alias="and", description="Logical AND - returns true if all conditions are true"
     )
 
 
@@ -254,10 +256,7 @@ class ProteusCondition10(BaseModel):
         extra="forbid",
     )
     or_: list[ProteusCondition] = Field(
-        ...,
-        alias="or",
-        description="Logical OR - returns true if any condition is true",
-        min_length=1,
+        ..., alias="or", description="Logical OR - returns true if any condition is true"
     )
 
 
@@ -345,6 +344,20 @@ class ProteusEventHandler4(BaseModel):
     url: ProteusExpression | str = Field(..., description="URL to open in a new tab")
 
 
+class ProteusEventHandler5(BaseModel):
+    """
+    Client-side component action - for previewing a file inline
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    action: Literal["preview"] = Field(default="preview", description="The action type")
+    file: ProteusExpression | dict[str, Any] | str = Field(
+        ..., description="The file object to preview"
+    )
+
+
 class Part(BaseModel):
     model_config = ConfigDict(
         extra="forbid",
@@ -355,14 +368,15 @@ class Part(BaseModel):
 
 class ProteusStructuredMessage(BaseModel):
     """
-    Structured message payload that lets file URLs travel as a typed list alongside the text parts, instead of being joined into the text.
+    Structured message payload that lets file metadata travel as a typed list alongside the text parts, instead of being joined into the text.
     """
 
     model_config = ConfigDict(
         extra="forbid",
     )
-    files: list[str] | ProteusExpression | None = Field(
-        default=None, description="List of file URLs (typically signed URLs from a host upload)."
+    files: list[File] | ProteusExpression | None = Field(
+        default=None,
+        description="List of uploaded file metadata objects (typically the host's onUpload return value). Hosts may attach additional fields beyond `name` and `link`.",
     )
     parts: list[Part]
 
@@ -927,6 +941,9 @@ class ProteusCardLink(BaseModel):
     mx: SprinklePropMx | None = None
     my: SprinklePropMy | None = None
     objectFit: SprinklePropObjectFit | None = None
+    onClick: ProteusEventHandler | None = Field(
+        default=None, description="Action triggered when link is clicked"
+    )
     overflow: SprinklePropOverflow | None = None
     overflowX: SprinklePropOverflowX | None = None
     overflowY: SprinklePropOverflowY | None = None
@@ -1080,6 +1097,74 @@ class ProteusField(BaseModel):
     z: SprinklePropZ | None = None
 
 
+class ProteusFileIcon(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    field_type: Literal["FileIcon"] = Field(default="FileIcon", alias="$type")
+    alignItems: SprinklePropAlignItems | None = None
+    alignSelf: SprinklePropAlignSelf | None = None
+    animation: SprinklePropAnimation | None = None
+    backgroundImage: SprinklePropBackgroundImage | None = None
+    bg: SprinklePropBg | None = None
+    border: SprinklePropBorder | None = None
+    borderB: SprinklePropBorderB | None = None
+    borderColor: SprinklePropBorderColor | None = None
+    borderL: SprinklePropBorderL | None = None
+    borderR: SprinklePropBorderR | None = None
+    borderT: SprinklePropBorderT | None = None
+    color: SprinklePropColor | None = None
+    cursor: SprinklePropCursor | None = None
+    display: SprinklePropDisplay | None = None
+    flex: SprinklePropFlex | None = None
+    flexDirection: SprinklePropFlexDirection | None = None
+    flexWrap: SprinklePropFlexWrap | None = None
+    fontFamily: SprinklePropFontFamily | None = None
+    fontSize: SprinklePropFontSize | None = None
+    fontWeight: SprinklePropFontWeight | None = None
+    gap: SprinklePropGap | None = None
+    gridAutoRows: SprinklePropGridAutoRows | None = None
+    gridColumn: SprinklePropGridColumn | None = None
+    gridTemplateColumns: SprinklePropGridTemplateColumns | None = None
+    h: SprinklePropH | None = None
+    justifyContent: SprinklePropJustifyContent | None = None
+    justifyItems: SprinklePropJustifyItems | None = None
+    m: SprinklePropM | None = None
+    maxH: SprinklePropMaxH | None = None
+    maxW: SprinklePropMaxW | None = None
+    mb: SprinklePropMb | None = None
+    ml: SprinklePropMl | None = None
+    mr: SprinklePropMr | None = None
+    mt: SprinklePropMt | None = None
+    mx: SprinklePropMx | None = None
+    my: SprinklePropMy | None = None
+    objectFit: SprinklePropObjectFit | None = None
+    overflow: SprinklePropOverflow | None = None
+    overflowX: SprinklePropOverflowX | None = None
+    overflowY: SprinklePropOverflowY | None = None
+    p: SprinklePropP | None = None
+    pb: SprinklePropPb | None = None
+    pl: SprinklePropPl | None = None
+    placeItems: SprinklePropPlaceItems | None = None
+    pointerEvents: SprinklePropPointerEvents | None = None
+    pr: SprinklePropPr | None = None
+    pt: SprinklePropPt | None = None
+    px: SprinklePropPx | None = None
+    py: SprinklePropPy | None = None
+    rounded: SprinklePropRounded | None = None
+    shadow: SprinklePropShadow | None = None
+    size: SprinklePropSize | None = None
+    textAlign: SprinklePropTextAlign | None = None
+    textTransform: SprinklePropTextTransform | None = None
+    transition: SprinklePropTransition | None = None
+    w: SprinklePropW | None = None
+    whiteSpace: SprinklePropWhiteSpace | None = None
+    z: SprinklePropZ | None = None
+    mimeType: str | ProteusExpression | None = Field(
+        default=None, description="MIME type of the file to determine which icon to display"
+    )
+
+
 class ProteusFileUpload(BaseModel):
     model_config = ConfigDict(
         extra="forbid",
@@ -1088,12 +1173,16 @@ class ProteusFileUpload(BaseModel):
     accept: list[str] | None = Field(
         default=None, description="File types to accept; array of MIME types or extensions."
     )
-    name: str | ProteusExpression | None = Field(
+    maxFiles: float | ProteusExpression | None = Field(
         default=None,
-        description="The name of the form control element. The resolved URL is written at parentPath/name in form data.",
+        description="Maximum number of files allowed. When set to 1 the field is in single-file mode; any other value (or omitted) allows multiple uploads.",
     )
-    required: bool | ProteusExpression | None = Field(
-        default=None, description="Whether a file is required."
+    minFiles: float | ProteusExpression | None = Field(
+        default=None, description="Minimum number of files required."
+    )
+    name: str | ProteusExpression | None = Field(
+        default=None,
+        description="The name of the form control element. The resolved metadata array is written at parentPath/name in form data.",
     )
 
 
@@ -1591,6 +1680,10 @@ class ProteusMap(BaseModel):
         default=None,
         description="Template object to render for each item in the array. Value paths inside this template are relative to the current item (e.g., path='title' resolves to each item's 'title' field). Use a leading '/' to reference top-level data (e.g., path='/title' resolves to the root data's 'title').",
     )
+    flat: bool | None = Field(
+        default=None,
+        description="When true, flattens the result array by one level. Useful when each mapped item resolves to an array and you want a single flat list.",
+    )
     path: str = Field(
         ..., description="JSON pointer path to the source array in the data (e.g., '/results')"
     )
@@ -2247,11 +2340,19 @@ class ProteusCondition(
 
 class ProteusEventHandler(
     RootModel[
-        ProteusEventHandler1 | ProteusEventHandler2 | ProteusEventHandler3 | ProteusEventHandler4
+        ProteusEventHandler1
+        | ProteusEventHandler2
+        | ProteusEventHandler3
+        | ProteusEventHandler4
+        | ProteusEventHandler5
     ]
 ):
     root: (
-        ProteusEventHandler1 | ProteusEventHandler2 | ProteusEventHandler3 | ProteusEventHandler4
+        ProteusEventHandler1
+        | ProteusEventHandler2
+        | ProteusEventHandler3
+        | ProteusEventHandler4
+        | ProteusEventHandler5
     ) = Field(
         ...,
         description="Handler for user interactions - a server-side interaction call, client-side message, or client-side component action",
@@ -2279,6 +2380,7 @@ class ProteusElement(
         | ProteusDataTable
         | ProteusFederated
         | ProteusField
+        | ProteusFileIcon
         | ProteusFileUpload
         | ProteusGroup
         | ProteusHeading
@@ -2317,6 +2419,7 @@ class ProteusElement(
         | ProteusDataTable
         | ProteusFederated
         | ProteusField
+        | ProteusFileIcon
         | ProteusFileUpload
         | ProteusGroup
         | ProteusHeading
@@ -3983,6 +4086,7 @@ ProteusDocument.model_rebuild()
 ProteusEventHandler2.model_rebuild()
 ProteusEventHandler3.model_rebuild()
 ProteusEventHandler4.model_rebuild()
+ProteusEventHandler5.model_rebuild()
 Part.model_rebuild()
 ProteusStructuredMessage.model_rebuild()
 ProteusZip.model_rebuild()
@@ -3999,6 +4103,7 @@ ProteusConcat.model_rebuild()
 ProteusDataTable.model_rebuild()
 ProteusFederated.model_rebuild()
 ProteusField.model_rebuild()
+ProteusFileIcon.model_rebuild()
 ProteusFileUpload.model_rebuild()
 ProteusGroup.model_rebuild()
 ProteusHeading.model_rebuild()
@@ -4047,6 +4152,7 @@ class UI:
     Document = ProteusDocument
     Federated = ProteusFederated
     Field = ProteusField
+    FileIcon = ProteusFileIcon
     FileUpload = ProteusFileUpload
     Group = ProteusGroup
     Heading = ProteusHeading

{optimizely_opal_opal_tools_sdk-0.1.32.dev0 → optimizely_opal_opal_tools_sdk-0.1.35.dev0}/opal_tools_sdk/service.py

@@ -213,6 +213,7 @@ class ToolsService:
         endpoint: str,
         auth_requirements: list[AuthRequirement] | None = None,
         ui_resource: str | None = None,
+        wait: bool = False,
     ) -> None:
         """Register a tool function.
 
@@ -224,6 +225,7 @@ class ToolsService:
             endpoint: API endpoint for the tool
             auth_requirements: List of authentication requirements (optional)
             ui_resource: URI of associated UI resource for dynamic rendering (optional)
+            wait: When True, invoking this tool pauses the agent until the caller signals completion
         """
         logger.info(f"Registering tool: {name} with endpoint: {endpoint}")
 
@@ -250,6 +252,7 @@ class ToolsService:
             endpoint=endpoint,
             auth_requirements=final_auth_requirements,
             ui_resource=ui_resource,
+            wait=wait,
         )
 
         self.functions.append(function)

{optimizely_opal_opal_tools_sdk-0.1.32.dev0 → optimizely_opal_opal_tools_sdk-0.1.35.dev0}/optimizely_opal.opal_tools_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: optimizely-opal.opal-tools-sdk
-Version: 0.1.32.dev0
+Version: 0.1.35.dev0
 Summary: SDK for creating Opal-compatible tools services
 Home-page: https://github.com/optimizely/opal-tools-sdk
 Author: Optimizely

{optimizely_opal_opal_tools_sdk-0.1.32.dev0 → optimizely_opal_opal_tools_sdk-0.1.35.dev0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "optimizely-opal.opal-tools-sdk"
-version = "0.1.32-dev"
+version = "0.1.35-dev"
 description = "SDK for creating Opal-compatible tools services"
 authors = [{ name = "Optimizely", email = "opal-team@optimizely.com" }]
 readme = "README.md"

{optimizely_opal_opal_tools_sdk-0.1.32.dev0 → optimizely_opal_opal_tools_sdk-0.1.35.dev0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import find_packages, setup
 
 setup(
     name="optimizely-opal.opal-tools-sdk",
-    version="0.1.32-dev",
+    version="0.1.35-dev",
     packages=find_packages(),
     install_requires=[
         "fastapi>=0.100.0",