omnata-plugin-devkit 0.5.2__tar.gz → 0.5.4__tar.gz

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-devkit
-Version: 0.5.2
+Version: 0.5.4
 Summary: 
 Author: James Weakley
 Author-email: james.weakley@omnata.com
@@ -16,6 +16,7 @@ Requires-Dist: pandas (==2)
 Requires-Dist: pyparsing (>=3.0)
 Requires-Dist: python-slugify (>=8,<9)
 Requires-Dist: requirements-parser (==0.5.0)
+Requires-Dist: snowflake-connector-python[pandas] (<=3.12.0)
 Requires-Dist: tabulate (>=0.9,<0.10)
 Requires-Dist: tomlkit (==0.11.1)
 Requires-Dist: vcrpy (>=4,<5)

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "omnata-plugin-devkit"
-version = "0.5.2"
+version = "0.5.4"
 description = ""
 authors = ["James Weakley <james.weakley@omnata.com>"]
 readme = "README.md"
@@ -25,6 +25,7 @@ pyparsing = ">=3.0"
 #snowflake-cli-labs = "2.0.0"
 requirements-parser = "0.5.0"
 tomlkit = "0.11.1" # this is lower than the version required by snowcli, but exists on Anaconda
+snowflake-connector-python = {extras = ["pandas"], version = "<=3.12.0"}
 
 [tool.poetry.dev-dependencies]
 pytest = "^6.2.4"

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/API_LIMITS.sql.jinja

@@ -8,6 +8,9 @@ RUNTIME_VERSION = '3.10'
 PACKAGES = ({{packages}})
 IMPORTS = ('/app.zip')
 HANDLER = 'run'
+COMMENT = $$
+Returns the API limits for a particular connection.
+$$
 execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/CONFIGURATION_FORM.sql.jinja

@@ -13,6 +13,9 @@ RUNTIME_VERSION = '3.10'
 PACKAGES = ({{packages}})
 IMPORTS = ('/app.zip')
 HANDLER = 'run'
+COMMENT = $$
+Returns a sync configuration form definition for an inbound or outbound sync.
+$$
 execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/CONFIGURE_APIS.sql.jinja

@@ -2,6 +2,9 @@
 create or replace procedure PLUGIN.CONFIGURE_APIS()
    returns object
    language javascript
+   COMMENT = $$
+   For all procs and functions that may access external endpoints, rebinds them to all of the configured connections as stored in the OMNATA_REGISTRATION table.
+   $$
    execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/CONNECTION_FORM.sql.jinja

@@ -5,6 +5,9 @@ RUNTIME_VERSION = '3.10'
 PACKAGES = ({{packages}})
 IMPORTS = ('/app.zip')
 HANDLER = 'run'
+COMMENT = $$
+Returns a connection configuration form definition for creating a new connection.
+$$
 execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/CONNECTION_TEST.sql.jinja

@@ -9,6 +9,9 @@ RUNTIME_VERSION = '3.10'
 PACKAGES = ({{packages}})
 IMPORTS = ('/app.zip')
 HANDLER = 'run'
+COMMENT = $$
+Tests a connection.
+$$
 execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/CONSTRUCT_FORM_OPTION.sql.jinja

@@ -5,6 +5,9 @@ RUNTIME_VERSION = '3.10'
 PACKAGES = ({{packages}})
 IMPORTS = ('/app.zip')
 HANDLER = 'run'
+COMMENT = $$
+Constructs a form option for a data source which supports the creation of new options.
+$$
 execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/CREATE_BILLING_EVENTS.sql.jinja

@@ -5,6 +5,10 @@ RUNTIME_VERSION = '3.10'
 PACKAGES = ({{packages}})
 IMPORTS = ('/app.zip')
 HANDLER = 'run'
+COMMENT = $$
+Instructs the plugin app to create a set of billing events.
+This is done so that the billing is associated with the plugin listing instead of the sync engine.
+$$
 execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/CREATE_GENERIC_SECRET_OBJECT.sql.jinja

@@ -1,6 +1,9 @@
 create or replace procedure PLUGIN.CREATE_GENERIC_SECRET_OBJECT(SECRET_NAME VARCHAR,SECRET_CONTENTS VARCHAR)
    returns object
    language javascript
+   COMMENT = $$
+   Creates a generic secret object.
+   $$
    execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/CREATE_GENERIC_SECRET_OBJECT_FROM_EXISTING.sql.jinja

@@ -1,6 +1,9 @@
 create or replace procedure PLUGIN.CREATE_GENERIC_SECRET_OBJECT_FROM_EXISTING(SECRET_NAME VARCHAR,SECRET_TO_CLONE VARCHAR,KEYS_TO_INCLUDE ARRAY)
    returns object
    language javascript
+   COMMENT = $$
+   Creates a generic secret object, using an existing object as a starting point.
+   $$
    execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/CREATE_NETWORK_RULE_OBJECT.sql.jinja

@@ -1,6 +1,9 @@
 create or replace procedure PLUGIN.CREATE_NETWORK_RULE_OBJECT(RULE_NAME VARCHAR,VALUE_LIST ARRAY)
    returns object
    language javascript
+   COMMENT = $$
+   Creates a network rule object.
+   $$
    execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/CREATE_NETWORK_RULE_OBJECT_FROM_EXISTING.sql.jinja

@@ -1,6 +1,9 @@
 create or replace procedure PLUGIN.CREATE_NETWORK_RULE_OBJECT_FROM_EXISTING(RULE_NAME VARCHAR,RULE_TO_CLONE VARCHAR)
    returns object
    language javascript
+   COMMENT = $$
+   Creates a network rule object, using the addresses from an existing network rule as a starting point.
+   $$
    execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/CREATE_OAUTH_SECRET_OBJECT.sql.jinja

@@ -1,6 +1,9 @@
 create or replace procedure PLUGIN.CREATE_OAUTH_SECRET_OBJECT(SECRET_NAME VARCHAR,SECURITY_INTEGRATION_NAME VARCHAR)
    returns object
    language javascript
+   COMMENT = $$
+   This procedure is deprecated, as the user must create the OAuth secrets themselves in order to be able to bind them correctly.
+   $$
    execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/INBOUND_LIST_STREAMS.sql.jinja

@@ -10,6 +10,10 @@ RUNTIME_VERSION = '3.10'
 PACKAGES = ({{packages}})
 IMPORTS = ('/app.zip')
 HANDLER = 'run'
+COMMENT = $$
+Retrieves a list of inbound streams for a connection.
+If SELECTED_STREAMS is defined, those streams must contain json schema, otherwise it's permitted for them to be null.
+$$
 execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/NETWORK_ADDRESSES.sql.jinja

@@ -6,6 +6,9 @@ RUNTIME_VERSION = '3.10'
 PACKAGES = ({{packages}})
 IMPORTS = ('/app.zip')
 HANDLER = 'run'
+COMMENT = $$
+Retrieves a list of network addresses that must be allowed for the connection to work.
+$$
 execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/NGROK_POST_TUNNEL_FIELDS.sql.jinja

@@ -10,6 +10,9 @@ RUNTIME_VERSION = '3.10'
 PACKAGES = ({{packages}})
 IMPORTS = ('/app.zip')
 HANDLER = 'run'
+COMMENT = $$
+Requests connection form fields to be presented after the ngrok tunnel is established.
+$$
 execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/OUTBOUND_RECORD_VALIDATOR.sql.jinja

@@ -5,6 +5,10 @@ RUNTIME_VERSION = '3.10'
 PACKAGES = ({{packages}})
 IMPORTS = ('/app.zip')
 HANDLER = 'run'
+COMMENT = $$
+Requests validation of an outbound record. Used to test the validity of field mappings and provided data values.
+Failed records will be marked with a SOURCE_FAILURE instead of DESTINATION_FAILURE.
+$$
 as
 $$
 from typing import Any, Dict, Optional

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/PENDING_API_CONFIGURATION.sql.jinja

@@ -1,6 +1,9 @@
 create or replace procedure PLUGIN.PENDING_API_CONFIGURATION(APP_DATABASE VARCHAR)
    returns object
    language javascript
+   COMMENT = $$
+   Returns true if there are External Access configuration changes made by UPDATE_API_CONFIGURATION that have not been applied via CONFIGURE_APIs.
+   $$
    execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/POST_INSTALL_ACTIONS.sql.jinja

@@ -1,6 +1,9 @@
 create or replace procedure PLUGIN.POST_INSTALL_ACTIONS()
    returns object
    language javascript
+   COMMENT = $$
+   Called by the setup script during installation/upgrade.
+   $$
    execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/RETRIEVE_NETWORK_RULE_OBJECT.sql.jinja

@@ -1,6 +1,9 @@
 create or replace procedure PLUGIN.RETRIEVE_NETWORK_RULE_OBJECT(RULE_NAME VARCHAR)
    returns object
    language javascript
+   COMMENT = $$
+   Allows the sync engine to retrieve the details of a network rule object, since this application owns them.
+   $$
    execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/RETRIEVE_SECRETS.sql.jinja

@@ -5,6 +5,9 @@ RUNTIME_VERSION = '3.10'
 PACKAGES = ({{packages}})
 IMPORTS = ('/app.zip')
 HANDLER = 'run'
+COMMENT = $$
+Used by plugin developers to retrieve secrets from the plugin as part of development sessions.
+$$
 execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/RETRIEVE_SECRETS_UDF.sql.jinja

@@ -3,6 +3,9 @@ returns object
 language python
 RUNTIME_VERSION = '3.10'
 HANDLER = 'run'
+COMMENT = $$
+Allows this plugin to retrieve its own secrets during CONFIGURE_API calls.
+$$
 as
 $$
 import _snowflake # pylint: disable=import-error, import-outside-toplevel # type: ignore
@@ -32,10 +35,4 @@ def run(oauth_secret_name,other_secrets_name):
             raise ValueError(f"Error parsing secrets content: {str(exception)}") from exception
    return connection_secrets
 $$
-;
-   
--- we don't grant this to OMNATA_MANAGEMENT because we'd rather the sync engine couldn't read secrets back once created
-
--- we didn't end up doing this because developers should generally be running in debug mode anyway
---grant usage on procedure PLUGIN.RETRIEVE_SECRETS_UDF(VARCHAR,VARCHAR)
---to application role PLUGIN_DEVELOPER;
+;

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/SYNC.sql.jinja

@@ -5,6 +5,9 @@ RUNTIME_VERSION = '3.10'
 PACKAGES = ({{packages}})
 IMPORTS = ('/app.zip')
 HANDLER = 'run'
+COMMENT = $$
+Requests that the plugin perform a sync.
+$$
 execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/TEST_CALLBACK.sql.jinja

@@ -1,6 +1,9 @@
 create or replace procedure PLUGIN.TEST_CALLBACK(APP_DATABASE VARCHAR)
    returns object
    language javascript
+   COMMENT = $$
+   Used by the Sync Engine to test whether or not a plugin app can see it.
+   $$
    execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/TEST_OAUTH_TOKEN_EXISTS.sql.jinja

@@ -1,6 +1,9 @@
 create or replace procedure PLUGIN.TEST_OAUTH_TOKEN_EXISTS(SECRET_NAME VARCHAR,EXTERNAL_ACCESS_INTEGRATION_NAME VARCHAR)
    returns object
    language javascript
+   COMMENT = $$
+   Used during connection configuration to see whether or not an OAuth secret has a token available (i.e. flow has occurred successfully)
+   $$
    execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/TUNNEL_TEST.sql.jinja

@@ -6,6 +6,9 @@ RUNTIME_VERSION = '3.10'
 PACKAGES = ({{packages}})
 IMPORTS = ('/app.zip')
 HANDLER = 'run'
+COMMENT = $$
+Requests that the plugin test that it can reach the service on the other end of an ngrok tunnel
+$$
 execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/UPDATE_API_CONFIGURATION.sql.jinja

@@ -2,10 +2,12 @@ create or replace procedure PLUGIN.UPDATE_API_CONFIGURATION(APP_DATABASE VARCHAR
                                                 EXTERNAL_ACCESS_INTEGRATIONS OBJECT)
    returns object
    language javascript
+   COMMENT = $$
+   Updates the list of external access integrations that this plugin needs to have its procs and functions bound to.
+   $$
    execute as owner
 as
 $$
-// snowflake object automatically injected by Snowpark
 
 try{
     let twoDollars=`\$\$`;

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/UPDATE_GENERIC_SECRET_OBJECT.sql.jinja

@@ -5,6 +5,9 @@ RUNTIME_VERSION = '3.10'
 PACKAGES = ({{packages}})
 IMPORTS = ('/app.zip')
 HANDLER = 'run'
+COMMENT = $$
+Updates the contents of a generic secrets object, optionally using an existing secret as a starting point.
+$$
 execute as owner
 as
 $$

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/UPDATE_GENERIC_SECRET_OBJECT_OLD.sql.jinja

@@ -26,4 +26,4 @@ $$
 ;
 
 grant usage on procedure PLUGIN.UPDATE_GENERIC_SECRET_OBJECT(VARCHAR,VARCHAR)
-to application role OMNATA_MANAGEMENT;
+to application role OMNATA_MANAGEMENT;

{omnata_plugin_devkit-0.5.2 → omnata_plugin_devkit-0.5.4}/src/omnata_plugin_devkit/jinja_templates/UPDATE_NETWORK_RULE_OBJECT.sql.jinja

@@ -1,6 +1,9 @@
 create or replace procedure PLUGIN.UPDATE_NETWORK_RULE_OBJECT(RULE_NAME VARCHAR,VALUE_LIST ARRAY)
    returns object
    language javascript
+   COMMENT = $$
+   Updates the addresses of a network rule, optionally using the addresses from an existing network rule as a starting point.
+   $$
    execute as owner
 as
 $$