glean-indexing-sdk 0.0.3__py3-none-any.whl → 0.1.0__py3-none-any.whl

glean/indexing/__init__.py

@@ -53,4 +53,4 @@ __all__ = [
 try:
     __version__ = version("glean-indexing-sdk")
 except PackageNotFoundError:
-    __version__ = "0.0.3"
+    __version__ = "0.1.0"

glean/indexing/common/property_definition_builder.py

@@ -0,0 +1,115 @@
+from typing import List, Optional
+
+from glean.api_client.models.propertydefinition import PropertyDefinition, PropertyType, UIOptions
+
+
+class PropertyDefinitionBuilder:
+    """
+    Builder class for creating PropertyDefinition objects with a fluent interface.
+
+    This class provides a convenient way to build multiple PropertyDefinition objects
+    with proper validation and type safety.
+
+    Example:
+        builder = PropertyDefinitionBuilder()
+        properties = (builder
+            .add_property("title", "Title", property_type=PropertyType.TEXT)
+            .add_property("author", "Author", display_label_plural="Authors")
+            .build())
+    """
+
+    def __init__(self) -> None:
+        self.properties: List[PropertyDefinition] = []
+
+    def add_property(
+        self,
+        name: str,
+        display_label: str,
+        display_label_plural: Optional[str] = None,
+        property_type: PropertyType = PropertyType.TEXT,
+        ui_options: UIOptions = UIOptions.SEARCH_RESULT,
+        hide_ui_facet: bool = False,
+        ui_facet_order: Optional[int] = None,
+        group: Optional[str] = None,
+    ) -> "PropertyDefinitionBuilder":
+        """
+        Add a property definition to the builder.
+
+        Args:
+            name: The property name (must not be empty)
+            display_label: The display label for the property
+            display_label_plural: Optional plural form of the display label
+            property_type: The type of property (defaults to TEXT)
+            ui_options: UI options for the property (defaults to SEARCH_RESULT)
+            hide_ui_facet: Whether to hide the UI facet
+            ui_facet_order: Optional order for UI facet display
+            group: Optional group name for the property
+
+        Returns:
+            Self for method chaining
+
+        Raises:
+            ValueError: If name or display_label is empty
+        """
+        if not name or not name.strip():
+            raise ValueError("Property name cannot be empty")
+        if not display_label or not display_label.strip():
+            raise ValueError("Display label cannot be empty")
+
+        base_params = {
+            "name": name.strip(),
+            "display_label": display_label.strip(),
+            "property_type": property_type.value,
+            "ui_options": ui_options.value,
+            "hide_ui_facet": hide_ui_facet,
+        }
+
+        optional_params = {
+            k: v
+            for k, v in {
+                "display_label_plural": display_label_plural.strip()
+                if display_label_plural
+                else None,
+                "ui_facet_order": ui_facet_order,
+                "group": group.strip() if group else None,
+            }.items()
+            if v is not None
+        }
+
+        params = {**base_params, **optional_params}
+
+        try:
+            prop = PropertyDefinition(**params)
+            self.properties.append(prop)
+        except Exception as e:
+            raise ValueError(f"Failed to create PropertyDefinition: {e}") from e
+
+        return self
+
+    def clear(self) -> "PropertyDefinitionBuilder":
+        """
+        Clear all properties from the builder.
+
+        Returns:
+            Self for method chaining
+        """
+        self.properties.clear()
+        return self
+
+    def count(self) -> int:
+        """
+        Get the number of properties currently in the builder.
+
+        Returns:
+            Number of properties
+        """
+        return len(self.properties)
+
+    def build(self) -> List[PropertyDefinition]:
+        """
+        Build and return the list of PropertyDefinition objects.
+
+        Returns:
+            List of PropertyDefinition objects
+        """
+        return self.properties.copy()

{glean_indexing_sdk-0.0.3.dist-info → glean_indexing_sdk-0.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: glean-indexing-sdk
-Version: 0.0.3
+Version: 0.1.0
 Summary: SDK for building custom Glean indexing integrations
 Project-URL: Source Code, https://github.com/glean-io/glean-indexing-sdk
 Author-email: Steve Calvert <steve.calvert@glean.com>

{glean_indexing_sdk-0.0.3.dist-info → glean_indexing_sdk-0.1.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-glean/indexing/__init__.py,sha256=4rk3Q9mlKf707DNKstmOf2l5cljagvYobwwHhYlD-Zw,1519
+glean/indexing/__init__.py,sha256=pYmCWpPddpoOR3fGN2ex8wjcQM4PHF8VM1ylmeHfxZY,1519
 glean/indexing/models.py,sha256=UuaEDCx0ygvU4u0lRbSn4YXXZVo7D_pyD_whQtjORm8,1223
 glean/indexing/py.typed,sha256=Nqnn8clbgv-5l0PgxcTOldg8mkMKrFn4TvPL-rYUUGg,1
 glean/indexing/common/__init__.py,sha256=6COS3jP66xJ7VcNGI8I95tkF5zpqHy9QPVn82CB4m4I,513
@@ -7,6 +7,7 @@ glean/indexing/common/content_formatter.py,sha256=PkIUZRoRtaOf1w6tJbB3cDj4oV58I7
 glean/indexing/common/glean_client.py,sha256=tKRWK_C1Nja0gVy2FLnj9SmUbpIdOA3WKmpuuhIl7kk,488
 glean/indexing/common/metrics.py,sha256=SWCWCYnNOkN4cnwCxyWyEF8iHVwQ4HZqhewi2lqyS84,1771
 glean/indexing/common/mocks.py,sha256=-TbLzpZ7yUstQW58AICixiIQM2CV5_OPRXejjI_brhE,726
+glean/indexing/common/property_definition_builder.py,sha256=NZFhSqsSZlhI0Ia76sn0meYr82msBMCKMd78zMKLWAM,3724
 glean/indexing/connectors/__init__.py,sha256=YaHEmCj246zKIvPIAOjTBTDV2O-KvMLncc6jjmaEeOw,1035
 glean/indexing/connectors/base_connector.py,sha256=Q435TzSLqs0OTFBrD3KCcjQnGSICQg11pdSfJ7C3XtI,2398
 glean/indexing/connectors/base_data_client.py,sha256=krOFHJbwCZI-hCS6fr-z44TvjCbPCTCw54hkk0CZFsQ,1004
@@ -21,7 +22,7 @@ glean/indexing/testing/connector_test_harness.py,sha256=CMQZmn0cOIrj_GdIHb3OwRN9
 glean/indexing/testing/mock_data_source.py,sha256=ICYbbHQZe9RVTzvrlwcxp_suxm9yXgjEAGiNCU-SkS4,1325
 glean/indexing/testing/mock_glean_client.py,sha256=aY_Jfg_NJNPw2HSM1IshgT2lkT59SD9BJzOnvNFJhck,2528
 glean/indexing/testing/response_validator.py,sha256=jehEtXlW0AQcOVck-_VPoDFtQM_vkHJQ10SUN1ftr1Q,1800
-glean_indexing_sdk-0.0.3.dist-info/METADATA,sha256=uyukc_HxjJuhdYzolllnxL8tqpmyWani9g1_NVJhnI4,15619
-glean_indexing_sdk-0.0.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-glean_indexing_sdk-0.0.3.dist-info/licenses/LICENSE,sha256=RAfePGwatR5BOtlNhW60zAKWCeHVgtGpaGBqZQadXNQ,1062
-glean_indexing_sdk-0.0.3.dist-info/RECORD,,
+glean_indexing_sdk-0.1.0.dist-info/METADATA,sha256=Y5J0IXw5FzP6k_Ao7AlU7RGPgW3Jom1noJMZDU8gHYw,15619
+glean_indexing_sdk-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+glean_indexing_sdk-0.1.0.dist-info/licenses/LICENSE,sha256=RAfePGwatR5BOtlNhW60zAKWCeHVgtGpaGBqZQadXNQ,1062
+glean_indexing_sdk-0.1.0.dist-info/RECORD,,