optimizely-opal.opal-tools-sdk 0.1.14.dev0__tar.gz → 0.1.15.dev0__tar.gz

{optimizely_opal_opal_tools_sdk-0.1.14.dev0 → optimizely_opal_opal_tools_sdk-0.1.15.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: optimizely-opal.opal-tools-sdk
-Version: 0.1.14.dev0
+Version: 0.1.15.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.14.dev0 → optimizely_opal_opal_tools_sdk-0.1.15.dev0}/opal_tools_sdk/proteus.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  proteus-document-spec.json
-#   timestamp: 2026-02-27T20:32:36+00:00
+#   timestamp: 2026-03-04T20:04:07+00:00
 
 from __future__ import annotations
 
@@ -1058,70 +1058,25 @@ class ProteusEventHandler(RootModel[ProteusEventHandler1 | ProteusEventHandler2]
     )
 
 
-class ProteusImage(BaseModel):
+class Series(BaseModel):
     model_config = ConfigDict(
         extra='forbid',
     )
-    field_type: Literal['Image'] = Field(default='Image', 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
-    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
-    alt: str | None = Field(default=None, description='Alternative text for the image')
-    src: str | None = Field(default=None, description='The image source URL')
+    color: str | None = Field(default=None, description='Series color')
+    dataKey: str = Field(..., description='Key in data records for this series')
+    labelKey: str | None = Field(
+        default=None,
+        description='Key in data records for pre-formatted labels displayed above bars',
+    )
+    name: str | None = Field(default=None, description='Display name for legend')
+
+
+class Column(BaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    accessorKey: str = Field(..., description='Key in data objects')
+    header: str = Field(..., description='Column header text')
 
 
 class ProteusMap(BaseModel):
@@ -1131,9 +1086,11 @@ class ProteusMap(BaseModel):
     field_type: Literal['Map'] = Field(default='Map', alias='$type')
     children: dict[str, Any] | None = Field(
         default=None,
-        description='Template object to render for each item in the array. Value paths are relative to current item.',
+        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').",
+    )
+    path: str = Field(
+        ..., description="JSON pointer path to the source array in the data (e.g., '/results')"
     )
-    path: str = Field(..., description="JSON pointer path to array (e.g., '/questions')")
 
 
 class Marks(BaseModel):
@@ -1428,7 +1385,8 @@ class ProteusValue(BaseModel):
     )
     field_type: Literal['Value'] = Field(default='Value', alias='$type')
     path: str = Field(
-        ..., description="JSON pointer path to value (e.g., '/question', '/options/0/label')"
+        ...,
+        description="Path to a value in the data. Absolute paths start with '/' and resolve from the root (e.g., '/title', '/options/0/label'). Inside a Map template, paths without a leading '/' are relative to the current item (e.g., 'title' resolves to each item's 'title' field).",
     )
 
 
@@ -1585,6 +1543,96 @@ class ProteusCondition(RootModel[ProteusAtomicCondition | ProteusCondition1]):
     )
 
 
+class ProteusChart(BaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    field_type: Literal['Chart'] = Field(default='Chart', alias='$type')
+    data: list[dict[str, Any]] | ProteusValue | None = Field(
+        default=None, description='Chart data records, either inline or a ProteusValue reference'
+    )
+    series: list[Series] | None = Field(default=None, description='Data series configuration')
+    type: Literal['bar'] = Field(default='bar', description='Chart type')
+    xAxisKey: str | None = Field(default=None, description='Key in data records for x-axis labels')
+
+
+class ProteusDataTable(BaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    field_type: Literal['DataTable'] = Field(default='DataTable', alias='$type')
+    columns: list[Column] | None = Field(default=None, description='Column definitions')
+    data: list[dict[str, Any]] | ProteusValue | None = None
+
+
+class ProteusImage(BaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    field_type: Literal['Image'] = Field(default='Image', 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
+    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
+    alt: ProteusValue | str | None = Field(
+        default=None, description='Alternative text for the image'
+    )
+    src: ProteusValue | str | None = Field(default=None, description='The image source URL')
+
+
 class ProteusDocument(BaseModel):
     model_config = ConfigDict(
         extra='forbid',
@@ -1594,19 +1642,20 @@ class ProteusDocument(BaseModel):
         default=None, description='Actions available for this document'
     )
     appIcon: str | None = Field(
-        default=None, description='A visual representation of the application'
+        default=None,
+        description="URL or data URI for the application icon (e.g., 'https://example.com/icon.png' or 'data:image/svg+xml,...'). Rendered as an <img> element.",
     )
     appName: str = Field(..., description='The official name of the application')
     blocking: bool | None = Field(
         default=None,
         description='If true, hides chat prompt and forces user interaction with document. User can press ESC or close to abandon.',
     )
-    body: ProteusNode | None
-    subtitle: str | None = Field(
+    body: ProteusNode | None = Field(..., description='The main content of the document.')
+    subtitle: ProteusNode | None = Field(
         default=None,
         description="A brief description or tagline that provides additional context about the Proteus document's purpose.",
     )
-    title: str = Field(
+    title: ProteusNode | None = Field(
         ...,
         description="A concise heading that encapsulates the essence of the Proteus document's content or intended action.",
     )
@@ -1695,6 +1744,77 @@ class ProteusAction(BaseModel):
     )
 
 
+class ProteusBadge(BaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    field_type: Literal['Badge'] = Field(default='Badge', 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
+    children: ProteusNode | 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
+    gridColumn: SprinklePropGridColumn | None = None
+    gridTemplateColumns: SprinklePropGridTemplateColumns | None = None
+    h: SprinklePropH | None = None
+    intent: Literal['information', 'success', 'warning', 'danger', 'neutral', 'primary'] | None = (
+        Field(
+            default=None,
+            description='Control the appearance by selecting between the different badge types.',
+        )
+    )
+    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
+
+
 class ProteusCancelAction(BaseModel):
     model_config = ConfigDict(
         extra='forbid',
@@ -2265,6 +2385,9 @@ class ProteusText(BaseModel):
     h: SprinklePropH | None = None
     justifyContent: SprinklePropJustifyContent | None = None
     justifyItems: SprinklePropJustifyItems | None = None
+    lineClamp: Literal['2', '4', '1', '3'] | None = Field(
+        default=None, description='Truncate the text at specific number of lines.'
+    )
     m: SprinklePropM | None = None
     maxH: SprinklePropMaxH | None = None
     maxW: SprinklePropMaxW | None = None
@@ -2293,6 +2416,9 @@ class ProteusText(BaseModel):
     textAlign: SprinklePropTextAlign | None = None
     textTransform: SprinklePropTextTransform | None = None
     transition: SprinklePropTransition | None = None
+    truncate: bool | None = Field(
+        default=None, description='Whether to truncate the text and add an ellipsis at the end.'
+    )
     w: SprinklePropW | None = None
     whiteSpace: SprinklePropWhiteSpace | None = None
     z: SprinklePropZ | None = None
@@ -2301,7 +2427,10 @@ class ProteusText(BaseModel):
 class ProteusElement(
     RootModel[
         ProteusAction
+        | ProteusBadge
         | ProteusCancelAction
+        | ProteusChart
+        | ProteusDataTable
         | ProteusField
         | ProteusGroup
         | ProteusHeading
@@ -2322,7 +2451,10 @@ class ProteusElement(
 ):
     root: (
         ProteusAction
+        | ProteusBadge
         | ProteusCancelAction
+        | ProteusChart
+        | ProteusDataTable
         | ProteusField
         | ProteusGroup
         | ProteusHeading
@@ -2370,6 +2502,7 @@ class ProteusNode(
 
 ProteusDocument.model_rebuild()
 ProteusAction.model_rebuild()
+ProteusBadge.model_rebuild()
 ProteusCancelAction.model_rebuild()
 ProteusField.model_rebuild()
 ProteusGroup.model_rebuild()
@@ -2395,7 +2528,10 @@ class UI:
     MIME_TYPE = "application/vnd.opal.proteus+json"
 
     Action = ProteusAction
+    Badge = ProteusBadge
     CancelAction = ProteusCancelAction
+    Chart = ProteusChart
+    DataTable = ProteusDataTable
     Document = ProteusDocument
     Field = ProteusField
     Group = ProteusGroup

{optimizely_opal_opal_tools_sdk-0.1.14.dev0 → optimizely_opal_opal_tools_sdk-0.1.15.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.14.dev0
+Version: 0.1.15.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.14.dev0 → optimizely_opal_opal_tools_sdk-0.1.15.dev0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "optimizely-opal.opal-tools-sdk"
-version = "0.1.14-dev"
+version = "0.1.15-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.14.dev0 → optimizely_opal_opal_tools_sdk-0.1.15.dev0}/setup.py

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