deephaven-plugin 0.5.0__tar.gz → 0.7.0__tar.gz

{deephaven-plugin-0.5.0 → deephaven_plugin-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: deephaven-plugin
-Version: 0.5.0
+Version: 0.7.0
 Summary: Deephaven Plugin interface
 Home-page: https://github.com/deephaven/deephaven-plugin
 Author: Devin Smith
@@ -16,6 +16,8 @@ Classifier: Environment :: Plugins
 Classifier: Development Status :: 3 - Alpha
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: importlib-metadata>=3.6; python_version < "3.8"
+Dynamic: license-file
 
 # Deephaven Plugin interface
 

{deephaven-plugin-0.5.0 → deephaven_plugin-0.7.0}/src/deephaven/plugin/__init__.py

@@ -5,7 +5,7 @@ from typing import Union, Type
 The deephaven.plugin module provides an API and registration mechanism to add new behavior to the Deephaven
 server. Plugins should be registered by adding a Registration instance as an entrypoint to the Python package.
 """
-__version__ = "0.5.0"
+__version__ = "0.7.0"
 
 DEEPHAVEN_PLUGIN_ENTRY_KEY = "deephaven.plugin"
 DEEPHAVEN_PLUGIN_REGISTRATION_CLASS = "registration_cls"

deephaven_plugin-0.7.0/src/deephaven/plugin/js.py

@@ -0,0 +1,50 @@
+import abc
+import pathlib
+import typing
+
+from . import Plugin
+
+
+class JsPlugin(Plugin):
+    """
+    A JS plugin is a Plugin that allows adding javascript code under the server's URL path "js-plugins/".
+    See https://github.com/deephaven/deephaven-plugins#js-plugins for more details about the underlying
+    construction for JS plugins.
+    """
+
+    @abc.abstractmethod
+    def path(self) -> pathlib.Path:
+        """
+        The directory path of the resources to serve. The path must exist.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def name(self) -> str:
+        """
+        The JS plugin name. The JS plugin contents will be served via the URL path "js-plugins/{name}/",
+        as well as included as the "name" field for the manifest entry in "js-plugins/manifest.json".
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def version(self) -> str:
+        """
+        The JS plugin version. Will be included as the "version" field for the manifest entry in
+        js-plugins/manifest.json".
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def main(self) -> str:
+        """
+        The main JS file path, specified relative to root. The main JS file must exist. Will be included
+        as the "main" field for the manifest entry in "js-plugins/manifest.json".
+        """
+        pass
+
+    def __str__(self) -> str:
+        return f"{self.name}@{self.version}"

{deephaven-plugin-0.5.0 → deephaven_plugin-0.7.0}/src/deephaven/plugin/object_type.py

@@ -1,5 +1,5 @@
 import abc
-from typing import Optional, Union, Type, List, Any
+from typing import Literal, Optional, Union, Type, List, Any
 
 from . import Plugin, Registration, register_all_into
 
@@ -69,6 +69,22 @@ class ObjectType(Plugin):
         """Returns True if, and only if, the object is compatible with this object type."""
         pass
 
+    def authorization_export_behavior(self) -> Literal["transform", "manual", "unset"]:
+        """Declares how the server should authorize the references this plugin exports to the client.
+
+        - ``"transform"``: the server applies the authorization transform to every reference this plugin exports,
+          in the requesting user's context. Use this when the plugin does not apply authorization itself.
+        - ``"manual"``: the plugin takes responsibility for authorizing its own exported references (for example by
+          calling ``deephaven.plugin_authorization.transform`` before passing objects to ``on_data``). The server
+          does not additionally transform them.
+        - ``"unset"`` (default): the plugin makes no declaration. The server's
+          ``PluginReferenceAuthorization.failClosed`` policy determines the effective behavior.
+
+        Returns:
+            One of ``"transform"``, ``"manual"``, or ``"unset"``.
+        """
+        return "unset"
+
 
 class BidirectionalObjectType(ObjectType):
     """Base class for an object type that can continue to send responses to the client, or receive requests

{deephaven-plugin-0.5.0 → deephaven_plugin-0.7.0}/src/deephaven_plugin.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: deephaven-plugin
-Version: 0.5.0
+Version: 0.7.0
 Summary: Deephaven Plugin interface
 Home-page: https://github.com/deephaven/deephaven-plugin
 Author: Devin Smith
@@ -16,6 +16,8 @@ Classifier: Environment :: Plugins
 Classifier: Development Status :: 3 - Alpha
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: importlib-metadata>=3.6; python_version < "3.8"
+Dynamic: license-file
 
 # Deephaven Plugin interface
 

deephaven-plugin-0.5.0/src/deephaven/plugin/js.py

@@ -1,35 +0,0 @@
-import abc
-import pathlib
-import typing
-
-from . import Plugin
-
-
-class JsPlugin(Plugin):
-    """A js plugin. Useful for adding custom JS code to the server that can be passed to the web client."""
-
-    @abc.abstractmethod
-    def distribution_path(self) -> typing.Generator[pathlib.Path, None, None]:
-        """A generator that yields the distribution path directory."""
-        pass
-
-    @property
-    @abc.abstractmethod
-    def name(self) -> str:
-        """The plugin name"""
-        pass
-
-    @property
-    @abc.abstractmethod
-    def version(self) -> str:
-        """The plugin version"""
-        pass
-
-    @property
-    @abc.abstractmethod
-    def main(self) -> str:
-        """The main js file, the relative path with respect to distribution_path."""
-        pass
-
-    def __str__(self) -> str:
-        return f"{self.name}@{self.version}"