omnata-plugin-runtime 0.6.10a180__py3-none-any.whl → 0.7.0__py3-none-any.whl

omnata_plugin_runtime/api.py

@@ -22,6 +22,7 @@ from .configuration import (
     OutboundSyncStrategy,
     StoredConfigurationValue,
     StoredMappingValue,
+    ConnectivityOption
 )
 from .rate_limiting import ApiLimits, RateLimitState
 
@@ -119,6 +120,7 @@ class OutboundSyncRequestPayload(BaseModel):
     results_table_name: str  # used to stage results back to the engine, resides in the main Omnata app database
     logging_level: str
     connection_method: str
+    connectivity_option: ConnectivityOption = Field(default=ConnectivityOption.DIRECT)
     connection_parameters: Dict[str, StoredConfigurationValue]
     oauth_secret_name: Optional[str] = None
     other_secrets_name: Optional[str] = None
@@ -146,6 +148,7 @@ class InboundSyncRequestPayload(BaseModel):
     results_table_name: str  # used to stage results back to the engine, resides in the main Omnata app database
     logging_level: str
     connection_method: str
+    connectivity_option: ConnectivityOption = Field(default=ConnectivityOption.DIRECT)
     connection_parameters: Dict[str, StoredConfigurationValue]
     oauth_secret_name: Optional[str] = None
     other_secrets_name: Optional[str] = None

omnata_plugin_runtime/configuration.py

@@ -37,6 +37,14 @@ class InboundStorageBehaviour(str, Enum):
     MERGE = "merge"
     REPLACE = "replace" # now deprecated, full refreshes now use merge
 
+class ConnectivityOption(str, Enum):
+    """
+    Describes the connectivity options available to a plugin.
+    These result in slightly different network rules and connection onboarding.
+    """
+    DIRECT = "direct"
+    NGROK = "ngrok"
+    PRIVATELINK = "privatelink"
 
 class InboundSyncStrategy(str, Enum):
     FULL_REFRESH = "Full Refresh"
@@ -543,6 +551,7 @@ class ConnectionConfigurationParameters(SubscriptableBaseModel):
     """
 
     connection_method: str
+    connectivity_option: ConnectivityOption = Field(default=ConnectivityOption.DIRECT)
     connection_parameters: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
     connection_secrets: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
     ngrok_tunnel_settings: Optional[NgrokTunnelSettings] = Field(default=None)
@@ -552,11 +561,9 @@ class ConnectionConfigurationParameters(SubscriptableBaseModel):
         default=None
     )
 
-    @validator("ngrok_tunnel_settings", always=True)
-    def validate_ngrok_tunnel_settings(cls, v: str, values: dict[str, Any]) -> Optional[NgrokTunnelSettings]:
-        """
-        A validator which picks out the ngrok tunnel configuration from the secrets and provides it as a typed object.
-        """
+    @field_validator('ngrok_tunnel_settings',mode='before')
+    @classmethod
+    def validate_ngrok_tunnel_settings(cls, values: Optional[dict[str, Any]]) -> Optional[NgrokTunnelSettings]:
         if "connection_secrets" in values:
             connection_secrets:Dict[str, StoredConfigurationValue] = values["connection_secrets"]
             if "ngrok_client_certificate" in connection_secrets and \

omnata_plugin_runtime/forms.py

@@ -489,5 +489,6 @@ class ConnectionMethod(SubscriptableBaseModel):
     name: str
     fields: List[FormFieldBase]
     oauth_template: Optional[SecurityIntegrationTemplate] = Field(default=None)
+    # This is now deprecated, instead signal ngrok support via the plugin manifest
     ngrok_tunnel_configuration: Optional[NGrokMTLSTunnel] = Field(default=None)
     description: str = Field(default="")

omnata_plugin_runtime/omnata_plugin.py

@@ -72,7 +72,8 @@ from .configuration import (
     StreamConfiguration,
     SubscriptableBaseModel,
     SyncConfigurationParameters,
-    get_secrets
+    get_secrets,
+    ConnectivityOption
 )
 from .forms import (
     ConnectionMethod,
@@ -101,6 +102,7 @@ class PluginManifest(SubscriptableBaseModel):
         :param str docs_url: The URL where plugin documentation can be found, e.g. "https://docs.omnata.com"
         :param bool supports_inbound: A flag to indicate whether or not the plugin supports inbound sync. Support for inbound sync behaviours (full/incremental) is defined per inbound stream.
         :param List[OutboundSyncStrategy] supported_outbound_strategies: A list of sync strategies that the plugin can support, e.g. create,upsert.
+        :param List[ConnectivityOption] supported_connectivity_options: A list of connectivity options that the plugin can support, e.g. direct,ngrok,privatelink
     """
 
     plugin_id: str
@@ -110,6 +112,9 @@ class PluginManifest(SubscriptableBaseModel):
     docs_url: str
     supports_inbound: bool
     supported_outbound_strategies: List[OutboundSyncStrategy]
+    supported_connectivity_options: List[ConnectivityOption] = Field(
+        default_factory=lambda: [ConnectivityOption.DIRECT]
+    )
 
 
 class SnowflakeFunctionParameter(BaseModel):
@@ -1643,7 +1648,7 @@ class OmnataPlugin(ABC):
         )
 
     @abstractmethod
-    def connection_form(self) -> List[ConnectionMethod]:
+    def connection_form(self,connectivity_option:ConnectivityOption) -> List[ConnectionMethod]:
         """
         Returns a form definition so that user input can be collected, in order to connect to an app
 

omnata_plugin_runtime/plugin_entrypoints.py

@@ -20,7 +20,8 @@ from .configuration import (
     OutboundSyncStrategy,
     StoredConfigurationValue,
     StoredMappingValue,
-    get_secrets
+    get_secrets,
+    ConnectivityOption
 )
 from .forms import ConnectionMethod, FormInputField, FormOption
 from .logging import OmnataPluginLogHandler
@@ -98,6 +99,7 @@ class PluginEntrypoint:
         # construct some connection parameters for the purpose of getting the api limits
         connection_parameters = ConnectionConfigurationParameters(
             connection_method=request.connection_method,
+            connectivity_option=request.connectivity_option,
             connection_parameters=request.connection_parameters,
             connection_secrets=connection_secrets
         )
@@ -138,6 +140,7 @@ class PluginEntrypoint:
         if request.sync_direction == "outbound":
             parameters = OutboundSyncConfigurationParameters(
                 connection_method=request.connection_method,
+                connectivity_option=request.connectivity_option,
                 connection_parameters=request.connection_parameters,
                 connection_secrets=connection_secrets,
                 sync_parameters=request.sync_parameters,
@@ -193,6 +196,7 @@ class PluginEntrypoint:
             logger.info("Running inbound sync")
             parameters = InboundSyncConfigurationParameters(
                 connection_method=request.connection_method,
+                connectivity_option=request.connectivity_option,
                 connection_parameters=request.connection_parameters,
                 connection_secrets=connection_secrets,
                 sync_parameters=request.sync_parameters,
@@ -268,6 +272,7 @@ class PluginEntrypoint:
 
     def configuration_form(
         self,
+        connectivity_option:str,
         connection_method: str,
         connection_parameters: Dict,
         oauth_secret_name: Optional[str],
@@ -283,6 +288,7 @@ class PluginEntrypoint:
         oauth_secret_name = normalise_nulls(oauth_secret_name)
         other_secrets_name = normalise_nulls(other_secrets_name)
         connection_secrets = get_secrets(oauth_secret_name, other_secrets_name)
+        connectivity_option = TypeAdapter(ConnectivityOption).validate_python(connectivity_option)
         connection_parameters = TypeAdapter(
             Dict[str, StoredConfigurationValue]).validate_python(connection_parameters)
         sync_parameters = TypeAdapter(
@@ -298,6 +304,7 @@ class PluginEntrypoint:
                 sync_strategy=sync_strat,
                 sync_parameters=sync_parameters,
                 connection_method=connection_method,
+                connectivity_option=connectivity_option,
                 current_form_parameters=form_parameters,
             )
         elif sync_direction == "inbound":
@@ -306,6 +313,7 @@ class PluginEntrypoint:
                 connection_secrets=connection_secrets,
                 sync_parameters=sync_parameters,
                 connection_method=connection_method,
+                connectivity_option=connectivity_option,
                 current_form_parameters=form_parameters,
             )
         else:
@@ -326,6 +334,7 @@ class PluginEntrypoint:
         
     def inbound_list_streams(
         self,
+        connectivity_option:str,
         connection_method: str,
         connection_parameters: Dict,
         oauth_secret_name: Optional[str],
@@ -337,6 +346,7 @@ class PluginEntrypoint:
         oauth_secret_name = normalise_nulls(oauth_secret_name)
         other_secrets_name = normalise_nulls(other_secrets_name)
         connection_secrets = get_secrets(oauth_secret_name, other_secrets_name)
+        connectivity_option = TypeAdapter(ConnectivityOption).validate_python(connectivity_option)
         connection_parameters = TypeAdapter(
             Dict[str, StoredConfigurationValue]).validate_python(connection_parameters)
         sync_parameters = TypeAdapter(
@@ -345,6 +355,7 @@ class PluginEntrypoint:
             connection_parameters=connection_parameters,
             connection_secrets=connection_secrets,
             sync_parameters=sync_parameters,
+            connectivity_option=connectivity_option,
             connection_method=connection_method,
             current_form_parameters=None,
             currently_selected_streams=selected_streams
@@ -381,9 +392,13 @@ class PluginEntrypoint:
             results.append(script_result.model_dump())
         return results
 
-    def connection_form(self):
+    def connection_form(self,connectivity_option: str):
+        connectivity_option = TypeAdapter(ConnectivityOption).validate_python(connectivity_option)
         logger.info("Entered connection_form method")
-        form: List[ConnectionMethod] = self._plugin_instance.connection_form()
+        if self._plugin_instance.connection_form.__code__.co_argcount==1:
+            form: List[ConnectionMethod] = self._plugin_instance.connection_form()
+        else:
+            form: List[ConnectionMethod] = self._plugin_instance.connection_form(connectivity_option)
         return [f.model_dump() for f in form]
 
     def create_billing_events(self, session, event_request: Dict):
@@ -431,30 +446,9 @@ class PluginEntrypoint:
         other_secrets_name: Optional[str],
         function_name: str,
     ) -> List[FormInputField]:
-        logger.info("Entered ngrok_post_tunnel_fields method")
-        oauth_secret_name = normalise_nulls(oauth_secret_name)
-        other_secrets_name = normalise_nulls(other_secrets_name)
-        connection_secrets = get_secrets(oauth_secret_name, other_secrets_name)
-        connection_parameters = TypeAdapter(
-            Dict[str, StoredConfigurationValue]).validate_python(connection_parameters)
-        parameters = ConnectionConfigurationParameters(
-            connection_method=connection_method,
-            connection_parameters=connection_parameters,
-            connection_secrets=connection_secrets
-        )
-        the_function = getattr(
-            self._plugin_instance,
-            function_name,
-        )
-        script_result = the_function(parameters)
-        if isinstance(script_result, List):
-            if len(script_result) > 0 and isinstance(script_result[0], BaseModel):
-                script_result = [r.model_dump() for r in script_result]
-        else:
-            raise ValueError(f"Expected a List from function {function_name}, got {type(script_result)}")
-        return script_result
+        raise ValueError(f"ngrok_post_tunnel_fields is deprecated")
 
-    def network_addresses(self, method: str, connection_parameters: Dict) -> List[str]:
+    def network_addresses(self, connectivity_option:str, method: str, connection_parameters: Dict) -> List[str]:
         logger.info("Entered network_addresses method")
         logger.info(f"Connection parameters: {connection_parameters}")
         from omnata_plugin_runtime.omnata_plugin import (
@@ -463,6 +457,7 @@ class PluginEntrypoint:
 
         return self._plugin_instance.network_addresses(
             ConnectionConfigurationParameters(
+                connectivity_option=TypeAdapter(ConnectivityOption).validate_python(connectivity_option),
                 connection_method=method,
                 connection_parameters=TypeAdapter(
                     Dict[str, StoredConfigurationValue]).validate_python(connection_parameters),
@@ -472,6 +467,7 @@ class PluginEntrypoint:
 
     def connect(
         self,
+        connectivity_option:str,
         method:str,
         connection_parameters: Dict,
         network_rule_name: str,
@@ -486,6 +482,7 @@ class PluginEntrypoint:
             ConnectionConfigurationParameters,
         )
         parameters = ConnectionConfigurationParameters(
+            connectivity_option=TypeAdapter(ConnectivityOption).validate_python(connectivity_option),
             connection_method=method,
             connection_parameters=TypeAdapter(
                 Dict[str, StoredConfigurationValue]).validate_python(connection_parameters),
@@ -522,6 +519,7 @@ class PluginEntrypoint:
         return connect_response.model_dump()
 
     def api_limits(self,
+                   connectivity_option:str,
                    method:str,
                     connection_parameters: Dict,
                     oauth_secret_name: Optional[str],
@@ -532,6 +530,7 @@ class PluginEntrypoint:
             ConnectionConfigurationParameters,
         )
         connection_parameters = ConnectionConfigurationParameters(
+            connectivity_option=TypeAdapter(ConnectivityOption).validate_python(connectivity_option),
             connection_method=method,
             connection_parameters=TypeAdapter(
                 Dict[str, StoredConfigurationValue]).validate_python(connection_parameters),

{omnata_plugin_runtime-0.6.10a180.dist-info → omnata_plugin_runtime-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.6.10a180
+Version: 0.7.0
 Summary: Classes and common runtime components for building and running Omnata Plugins
 Author: James Weakley
 Author-email: james.weakley@omnata.com

omnata_plugin_runtime-0.7.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+omnata_plugin_runtime/__init__.py,sha256=MS9d1whnfT_B3-ThqZ7l63QeC_8OEKTuaYV5wTwRpBA,1576
+omnata_plugin_runtime/api.py,sha256=tVi4KLL0v5N3yz3Ie0kSyFemryu572gCbtSRfWN6wBU,6523
+omnata_plugin_runtime/configuration.py,sha256=Yyz3trj7G6nh3JyEw6S5qlrXUfS_MB-vZgATcNdWzp0,38339
+omnata_plugin_runtime/forms.py,sha256=ueodN2GIMS5N9fqebpY4uNGJnjEb9HcuaVQVfWH-cGg,19838
+omnata_plugin_runtime/logging.py,sha256=bn7eKoNWvtuyTk7RTwBS9UARMtqkiICtgMtzq3KA2V0,3272
+omnata_plugin_runtime/omnata_plugin.py,sha256=aggjb_CTTjhgqjS8CHPOm4ENU0jNcYoT6LC8yI1IeF4,130048
+omnata_plugin_runtime/plugin_entrypoints.py,sha256=spCatkTxRX0WAgX0wqZP_vUF4Z-uOF8SrASuO3HXT1o,28937
+omnata_plugin_runtime/rate_limiting.py,sha256=JukA0l7x7Klqz2b54mR-poP7NRxpUHgWSGp6h0B8u6Q,25612
+omnata_plugin_runtime-0.7.0.dist-info/LICENSE,sha256=rGaMQG3R3F5-JGDp_-rlMKpDIkg5n0SI4kctTk8eZSI,56
+omnata_plugin_runtime-0.7.0.dist-info/METADATA,sha256=6aNz1kfVD1gcBjs_dYNKCCJIyg4XaPO5Dp4DteBPZc8,1981
+omnata_plugin_runtime-0.7.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+omnata_plugin_runtime-0.7.0.dist-info/RECORD,,

omnata_plugin_runtime-0.6.10a180.dist-info/RECORD

@@ -1,12 +0,0 @@
-omnata_plugin_runtime/__init__.py,sha256=MS9d1whnfT_B3-ThqZ7l63QeC_8OEKTuaYV5wTwRpBA,1576
-omnata_plugin_runtime/api.py,sha256=FxzTqri4no8ClkOm7vZADG8aD47jcGBCTTQDEORmOJM,6326
-omnata_plugin_runtime/configuration.py,sha256=TI6GaVFhewVawBCaYN34GujY57qEP6q2nik4YpSEk5s,38100
-omnata_plugin_runtime/forms.py,sha256=GzSPEwcijsoPCXEO1mHiE8ylvX_KSE5TkhwqkymA2Ss,19755
-omnata_plugin_runtime/logging.py,sha256=bn7eKoNWvtuyTk7RTwBS9UARMtqkiICtgMtzq3KA2V0,3272
-omnata_plugin_runtime/omnata_plugin.py,sha256=qbcpY2EGFE55GVPuJCWWVVPV2aSf_Gs0AVio5A0kZmc,129687
-omnata_plugin_runtime/plugin_entrypoints.py,sha256=cQRBzNQiKFO088FTzDAyhxp_meJxxuIy1lX8uA0o7FI,28620
-omnata_plugin_runtime/rate_limiting.py,sha256=JukA0l7x7Klqz2b54mR-poP7NRxpUHgWSGp6h0B8u6Q,25612
-omnata_plugin_runtime-0.6.10a180.dist-info/LICENSE,sha256=rGaMQG3R3F5-JGDp_-rlMKpDIkg5n0SI4kctTk8eZSI,56
-omnata_plugin_runtime-0.6.10a180.dist-info/METADATA,sha256=wkOPISq42MvjXA9ECBf2ajfv8NGrZtufBXmeMElGAg4,1986
-omnata_plugin_runtime-0.6.10a180.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-omnata_plugin_runtime-0.6.10a180.dist-info/RECORD,,