pyxecm 2.0.3__py3-none-any.whl → 3.0.0__py3-none-any.whl

{pyxecm/customizer/api → pyxecm_api}/common/router.py

@@ -8,28 +8,29 @@ import tempfile
 from http import HTTPStatus
 from typing import Annotated
 
-from fastapi import APIRouter, Depends, HTTPException, Query, Response
+from fastapi import APIRouter, Depends, HTTPException, Query, Request, Response
 from fastapi.responses import FileResponse, JSONResponse, RedirectResponse
 
-from pyxecm.customizer.api.auth.functions import get_authorized_user
-from pyxecm.customizer.api.auth.models import User
-from pyxecm.customizer.api.common.functions import PAYLOAD_LIST, list_files_in_directory
-from pyxecm.customizer.api.common.models import CustomizerStatus
+from pyxecm_api.auth.functions import get_authorized_user
+from pyxecm_api.auth.models import User
 
-router = APIRouter(tags=["default"])
+from .functions import PAYLOAD_LIST, list_files_in_directory
+from .models import CustomizerStatus
 
-logger = logging.getLogger("pyxecm.customizer.api.common")
+router = APIRouter()
+
+logger = logging.getLogger("pyxecm_api.common")
 
 
 @router.get("/", include_in_schema=False)
-async def redirect_to_api() -> RedirectResponse:
+async def redirect_to_api(request: Request) -> RedirectResponse:
     """Redirect from / to /api.
 
     Returns:
         None
 
     """
-    return RedirectResponse(url="/api")
+    return RedirectResponse(url=f"{request.url.path}api")
 
 
 @router.get(path="/status", name="Get Status")
@@ -74,7 +75,7 @@ def shutdown(user: Annotated[User, Depends(get_authorized_user)]) -> JSONRespons
     return JSONResponse({"status": "shutdown"}, status_code=HTTPStatus.ACCEPTED)
 
 
-@router.get(path="/browser_automations/assets")
+@router.get(path="/browser_automations/assets", tags=["payload"])
 def list_browser_automation_files(
     user: Annotated[User, Depends(get_authorized_user)],  # noqa: ARG001
 ) -> JSONResponse:
@@ -90,7 +91,7 @@ def list_browser_automation_files(
     return JSONResponse(result)
 
 
-@router.get(path="/browser_automations/download")
+@router.get(path="/browser_automations/download", tags=["payload"])
 def get_browser_automation_file(
     user: Annotated[User, Depends(get_authorized_user)],  # noqa: ARG001
     file: Annotated[str, Query(description="File name")],

{pyxecm/customizer/api → pyxecm_api}/settings.py

@@ -16,28 +16,38 @@ from pydantic_settings import (
 class CustomizerAPISettings(BaseSettings):
     """Settings for the Customizer API."""
 
+    title: str = Field(default="Customizer API", description="Name of the API Service")
+    description: str = Field(
+        default="API provided by [pyxecm](https://github.com/opentext/pyxecm). The documentation for the payload syntax can be found [here](https://opentext.github.io/pyxecm/payload-syntax/).",
+        description="Descriptive text on the SwaggerUI page.",
+    )
+
     api_key: str | None = Field(
         default=None,
         description="Optional API KEY that can be specified that has access to the Customizer API, bypassing the OTDS authentication.",
     )
     bind_address: str = Field(default="0.0.0.0", description="Interface to bind the Customizer API.")  # noqa: S104
     bind_port: int = Field(default=8000, description="Port to bind the Customizer API to")
-    workers: int = Field(default=1, description="Number of workers to use for the API BackgroundTasks")
-    root_path: str = Field(default="/", description="Root path for the Customizer API")
+    workers: int = Field(default=1, description="Number of workers to use for the API background tasks")
+    root_path: str = Field(default="", description="Root path for the Customizer API")
     openapi_url: str = Field(default="/api/openapi.json", description="OpenAPI URL")
+    reload: bool = Field(default=False, description="Enable or disable the autoreload feature")
 
+    concurrent_payloads: int = Field(
+        default=3, description="Maximum number of concurrent payloads that are executed at the same time."
+    )
     import_payload: bool = Field(default=False)
     payload: str = Field(
         default="/payload/payload.yml.gz.b64",
-        description="Path to a single Payload file to be loaded.",
+        description="Path to a single payload file to be loaded.",
     )
     payload_dir: str = Field(
         default="/payload-external/",
-        description="Path to a directory of Payload files. All files in this directory will be loaded in alphabetical order and dependencies will be added automatically on the previous object. So all payload in this folder will be processed sequentially in alphabetical oder.",
+        description="Path to a directory of payload files. All files in this directory will be loaded in alphabetical order and dependencies will be added automatically on the previous object. So all payload in this folder will be processed sequentially in alphabetical oder.",
     )
     payload_dir_optional: str = Field(
         default="/payload-optional/",
-        description="Path of Payload files to be loaded. No additional logic for dependencies will be applied, they need to be managed within the payloadSetitings section of each payload. See -> payloadOptions in the Payload Syntax documentation.",
+        description="Path of payload files to be loaded. No additional logic for dependencies will be applied, they need to be managed within the payloadSettings section of each payload. See -> payloadOptions in the Payload Syntax documentation.",
     )
 
     temp_dir: str = Field(
@@ -46,6 +56,9 @@ class CustomizerAPISettings(BaseSettings):
     )
 
     loglevel: Literal["INFO", "DEBUG", "WARNING", "ERROR"] = "INFO"
+    log_payload_processing: bool = Field(
+        default=False, description="Print the customizer payload processing log messages to stdout"
+    )
     logfolder: str = Field(
         default=os.path.join(tempfile.gettempdir(), "customizer"),
         description="Logfolder for Customizer logfiles",
@@ -59,6 +72,12 @@ class CustomizerAPISettings(BaseSettings):
         default="default",
         description="Namespace to use for otxecm resource lookups",
     )
+
+    maintenance_page: bool = Field(
+        default=True,
+        description="Start the Maintenance Page server.",
+    )
+
     maintenance_mode: bool = Field(
         default=False,
         description="Automatically enable and disable the maintenance mode during payload deployments.",
@@ -94,7 +113,7 @@ class CustomizerAPISettings(BaseSettings):
     )
 
     csai: bool = Field(
-        default=True,
+        default=False,
         description="Enable the CSAI integration",
     )
 
@@ -103,6 +122,11 @@ class CustomizerAPISettings(BaseSettings):
         description="Prefix for the CSAI",
     )
 
+    csai_studio_integration: bool = Field(
+        default=False,
+        description="Enable the CSAI Studio Integration",
+    )
+
     upload_folder: str = Field(default=os.path.join(tempfile.gettempdir(), "upload"), description="Folder for uploads")
 
     upload_key: str = Field(default=str(uuid.uuid4()), description="Upload key for the Logs")

{pyxecm/customizer/api → pyxecm_api}/terminal/router.py

@@ -10,7 +10,7 @@ import subprocess
 
 from fastapi import APIRouter, HTTPException, Query, WebSocket, WebSocketDisconnect, status
 
-from pyxecm.customizer.api.auth.functions import get_authorized_user, get_current_user
+from pyxecm_api.auth.functions import get_authorized_user, get_current_user
 
 router = APIRouter(tags=["terminal"])
 

{pyxecm/customizer/api → pyxecm_api}/v1_csai/router.py

@@ -4,20 +4,22 @@ import logging
 from http import HTTPStatus
 from typing import Annotated
 
-from fastapi import APIRouter, Body, Depends
-from fastapi.responses import JSONResponse
-
-from pyxecm.customizer.api.auth.functions import get_authorized_user
-from pyxecm.customizer.api.auth.models import User
-from pyxecm.customizer.api.common.functions import get_k8s_object, get_otcs_object, get_settings
-from pyxecm.customizer.api.settings import CustomizerAPISettings
-from pyxecm.customizer.api.v1_csai.models import CSAIEmbedMetadata
-from pyxecm.customizer.k8s import K8s
+from fastapi import APIRouter, Body, Depends, Query
+from fastapi.responses import HTMLResponse, JSONResponse
 from pyxecm.otcs import OTCS
+from pyxecm_customizer.k8s import K8s
+
+from pyxecm_api.agents.functions import get_otca_object
+from pyxecm_api.auth.functions import get_authorized_user
+from pyxecm_api.auth.models import User
+from pyxecm_api.common.functions import get_k8s_object, get_otcs_object, get_settings
+from pyxecm_api.settings import CustomizerAPISettings
+
+from .models import CSAIEmbedMetadata
 
 router = APIRouter(prefix="/api/v1/csai", tags=["csai"])
 
-logger = logging.getLogger("pyxecm.customizer.api.v1_csai")
+logger = logging.getLogger("pyxecm_api.v1_csai")
 
 
 @router.post("/metadata")
@@ -110,3 +112,30 @@ def set_csai_config_data(
         k8s_object.restart_deployment(deployment)
 
     return get_csai_config_data(user=user, k8s_object=k8s_object, settings=settings)
+
+
+@router.get("/graph")
+def get_csai_graph(name: Annotated[str, Query(..., description="Name of the Graph")]) -> HTMLResponse:
+    """Display the graph of the given name.
+
+    Args:
+        otca (Annotated[OTCA, Depends): Generic OTCA Objec
+        name (str): name of the graph
+
+    Returns:
+        HTMLResponse: _description_
+
+    """
+    otca = get_otca_object(otcs_object=None)
+
+    graphs = otca.get_graphs()
+    graph = [g for g in graphs if g["name"] == name]
+
+    if graph:
+        filename = otca.visualize_graph(graph[0]["id"])
+
+    with open(filename) as f:
+        file_content = f.read()
+
+    logger.info("name: %s", name)
+    return HTMLResponse(status_code=200, content=file_content)

pyxecm_api/v1_csai/statics/bindings/utils.js

@@ -0,0 +1,189 @@
+function neighbourhoodHighlight(params) {
+  // console.log("in nieghbourhoodhighlight");
+  allNodes = nodes.get({ returnType: "Object" });
+  // originalNodes = JSON.parse(JSON.stringify(allNodes));
+  // if something is selected:
+  if (params.nodes.length > 0) {
+    highlightActive = true;
+    var i, j;
+    var selectedNode = params.nodes[0];
+    var degrees = 2;
+
+    // mark all nodes as hard to read.
+    for (let nodeId in allNodes) {
+      // nodeColors[nodeId] = allNodes[nodeId].color;
+      allNodes[nodeId].color = "rgba(200,200,200,0.5)";
+      if (allNodes[nodeId].hiddenLabel === undefined) {
+        allNodes[nodeId].hiddenLabel = allNodes[nodeId].label;
+        allNodes[nodeId].label = undefined;
+      }
+    }
+    var connectedNodes = network.getConnectedNodes(selectedNode);
+    var allConnectedNodes = [];
+
+    // get the second degree nodes
+    for (i = 1; i < degrees; i++) {
+      for (j = 0; j < connectedNodes.length; j++) {
+        allConnectedNodes = allConnectedNodes.concat(
+          network.getConnectedNodes(connectedNodes[j])
+        );
+      }
+    }
+
+    // all second degree nodes get a different color and their label back
+    for (i = 0; i < allConnectedNodes.length; i++) {
+      // allNodes[allConnectedNodes[i]].color = "pink";
+      allNodes[allConnectedNodes[i]].color = "rgba(150,150,150,0.75)";
+      if (allNodes[allConnectedNodes[i]].hiddenLabel !== undefined) {
+        allNodes[allConnectedNodes[i]].label =
+          allNodes[allConnectedNodes[i]].hiddenLabel;
+        allNodes[allConnectedNodes[i]].hiddenLabel = undefined;
+      }
+    }
+
+    // all first degree nodes get their own color and their label back
+    for (i = 0; i < connectedNodes.length; i++) {
+      // allNodes[connectedNodes[i]].color = undefined;
+      allNodes[connectedNodes[i]].color = nodeColors[connectedNodes[i]];
+      if (allNodes[connectedNodes[i]].hiddenLabel !== undefined) {
+        allNodes[connectedNodes[i]].label =
+          allNodes[connectedNodes[i]].hiddenLabel;
+        allNodes[connectedNodes[i]].hiddenLabel = undefined;
+      }
+    }
+
+    // the main node gets its own color and its label back.
+    // allNodes[selectedNode].color = undefined;
+    allNodes[selectedNode].color = nodeColors[selectedNode];
+    if (allNodes[selectedNode].hiddenLabel !== undefined) {
+      allNodes[selectedNode].label = allNodes[selectedNode].hiddenLabel;
+      allNodes[selectedNode].hiddenLabel = undefined;
+    }
+  } else if (highlightActive === true) {
+    // console.log("highlightActive was true");
+    // reset all nodes
+    for (let nodeId in allNodes) {
+      // allNodes[nodeId].color = "purple";
+      allNodes[nodeId].color = nodeColors[nodeId];
+      // delete allNodes[nodeId].color;
+      if (allNodes[nodeId].hiddenLabel !== undefined) {
+        allNodes[nodeId].label = allNodes[nodeId].hiddenLabel;
+        allNodes[nodeId].hiddenLabel = undefined;
+      }
+    }
+    highlightActive = false;
+  }
+
+  // transform the object into an array
+  var updateArray = [];
+  if (params.nodes.length > 0) {
+    for (let nodeId in allNodes) {
+      if (allNodes.hasOwnProperty(nodeId)) {
+        // console.log(allNodes[nodeId]);
+        updateArray.push(allNodes[nodeId]);
+      }
+    }
+    nodes.update(updateArray);
+  } else {
+    // console.log("Nothing was selected");
+    for (let nodeId in allNodes) {
+      if (allNodes.hasOwnProperty(nodeId)) {
+        // console.log(allNodes[nodeId]);
+        // allNodes[nodeId].color = {};
+        updateArray.push(allNodes[nodeId]);
+      }
+    }
+    nodes.update(updateArray);
+  }
+}
+
+function filterHighlight(params) {
+  allNodes = nodes.get({ returnType: "Object" });
+  // if something is selected:
+  if (params.nodes.length > 0) {
+    filterActive = true;
+    let selectedNodes = params.nodes;
+
+    // hiding all nodes and saving the label
+    for (let nodeId in allNodes) {
+      allNodes[nodeId].hidden = true;
+      if (allNodes[nodeId].savedLabel === undefined) {
+        allNodes[nodeId].savedLabel = allNodes[nodeId].label;
+        allNodes[nodeId].label = undefined;
+      }
+    }
+
+    for (let i=0; i < selectedNodes.length; i++) {
+      allNodes[selectedNodes[i]].hidden = false;
+      if (allNodes[selectedNodes[i]].savedLabel !== undefined) {
+        allNodes[selectedNodes[i]].label = allNodes[selectedNodes[i]].savedLabel;
+        allNodes[selectedNodes[i]].savedLabel = undefined;
+      }
+    }
+
+  } else if (filterActive === true) {
+    // reset all nodes
+    for (let nodeId in allNodes) {
+      allNodes[nodeId].hidden = false;
+      if (allNodes[nodeId].savedLabel !== undefined) {
+        allNodes[nodeId].label = allNodes[nodeId].savedLabel;
+        allNodes[nodeId].savedLabel = undefined;
+      }
+    }
+    filterActive = false;
+  }
+
+  // transform the object into an array
+  var updateArray = [];
+  if (params.nodes.length > 0) {
+    for (let nodeId in allNodes) {
+      if (allNodes.hasOwnProperty(nodeId)) {
+        updateArray.push(allNodes[nodeId]);
+      }
+    }
+    nodes.update(updateArray);
+  } else {
+    for (let nodeId in allNodes) {
+      if (allNodes.hasOwnProperty(nodeId)) {
+        updateArray.push(allNodes[nodeId]);
+      }
+    }
+    nodes.update(updateArray);
+  }
+}
+
+function selectNode(nodes) {
+  network.selectNodes(nodes);
+  neighbourhoodHighlight({ nodes: nodes });
+  return nodes;
+}
+
+function selectNodes(nodes) {
+  network.selectNodes(nodes);
+  filterHighlight({nodes: nodes});
+  return nodes;
+}
+
+function highlightFilter(filter) {
+  let selectedNodes = []
+  let selectedProp = filter['property']
+  if (filter['item'] === 'node') {
+    let allNodes = nodes.get({ returnType: "Object" });
+    for (let nodeId in allNodes) {
+      if (allNodes[nodeId][selectedProp] && filter['value'].includes((allNodes[nodeId][selectedProp]).toString())) {
+        selectedNodes.push(nodeId)
+      }
+    }
+  }
+  else if (filter['item'] === 'edge'){
+    let allEdges = edges.get({returnType: 'object'});
+    // check if the selected property exists for selected edge and select the nodes connected to the edge
+    for (let edge in allEdges) {
+      if (allEdges[edge][selectedProp] && filter['value'].includes((allEdges[edge][selectedProp]).toString())) {
+        selectedNodes.push(allEdges[edge]['from'])
+        selectedNodes.push(allEdges[edge]['to'])
+      }
+    }
+  }
+  selectNodes(selectedNodes)
+}