omnata-plugin-runtime 0.6.10a180__tar.gz → 0.7.0a182__tar.gz

{omnata_plugin_runtime-0.6.10a180 → omnata_plugin_runtime-0.7.0a182}/PKG-INFO

@@ -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.6.10a180 → omnata_plugin_runtime-0.7.0a182}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "omnata-plugin-runtime"
-version = "0.6.10-a180"
+version = "0.7.0-a182"
 description = "Classes and common runtime components for building and running Omnata Plugins"
 authors = ["James Weakley <james.weakley@omnata.com>"]
 readme = "README.md"

{omnata_plugin_runtime-0.6.10a180 → omnata_plugin_runtime-0.7.0a182}/src/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-0.6.10a180 → omnata_plugin_runtime-0.7.0a182}/src/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-0.6.10a180 → omnata_plugin_runtime-0.7.0a182}/src/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-0.6.10a180 → omnata_plugin_runtime-0.7.0a182}/src/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):