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

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"

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
@@ -381,9 +382,10 @@ 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()
+        form: List[ConnectionMethod] = self._plugin_instance.connection_form(connectivity_option=connectivity_option)
         return [f.model_dump() for f in form]
 
     def create_billing_events(self, session, event_request: Dict):

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.6.10a180
+Version: 0.7.0a182
 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.0a182.dist-info/RECORD

@@ -0,0 +1,12 @@
+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=hUgh6XNckgf0B8oX1uVz8DaaCbqpnH5chVf_6GlYyHQ,38369
+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=lPy1YcbpU2wF3toj863i2TavNmNbhtNNWAgY2s0FKwc,28807
+omnata_plugin_runtime/rate_limiting.py,sha256=JukA0l7x7Klqz2b54mR-poP7NRxpUHgWSGp6h0B8u6Q,25612
+omnata_plugin_runtime-0.7.0a182.dist-info/LICENSE,sha256=rGaMQG3R3F5-JGDp_-rlMKpDIkg5n0SI4kctTk8eZSI,56
+omnata_plugin_runtime-0.7.0a182.dist-info/METADATA,sha256=pL4Ip9lgrpc4x_lcJvNHRvlvSpWbm-naa3QcI2x03Ao,1985
+omnata_plugin_runtime-0.7.0a182.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+omnata_plugin_runtime-0.7.0a182.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,,