@uns-kit/cli 0.0.36 → 0.0.38

package/templates/python/proto/uns-gateway.proto

@@ -1,102 +1,102 @@
-syntax = "proto3";
-
-package uns;
-
-service UnsGateway {
-  rpc Publish (PublishRequest) returns (Ack);
-  rpc Subscribe (SubscribeRequest) returns (stream MqttMessage);
-  rpc RegisterApiGet (RegisterApiGetRequest) returns (Ack);
-  rpc UnregisterApiGet (UnregisterApiGetRequest) returns (Ack);
-  rpc ApiEventStream (stream ApiEventResponse) returns (stream ApiEvent);
-  rpc Ready (ReadyRequest) returns (Ack);
-}
-
-message PublishRequest {
-  string topic = 1;
-  string attribute = 2;
-  string description = 3;
-  repeated string tags = 4;
-  bool attribute_needs_persistence = 5;
-  oneof content {
-    Data data = 6;
-    Table table = 7;
-  }
-  bool value_is_cumulative = 8; // for Data: publish as delta
-}
-
-message Data {
-  string time = 1;
-  double value_number = 2;
-  string value_string = 3;
-  string uom = 4;
-  string data_group = 5;
-  string foreign_event_key = 6;
-}
-
-message TableValue {
-  string key = 1;
-  double value_number = 2;
-  string value_string = 3;
-}
-
-message Table {
-  string time = 1;
-  repeated TableValue values = 2;
-  string data_group = 3;
-}
-
-message SubscribeRequest {
-  repeated string topics = 1;
-}
-
-message MqttMessage {
-  string topic = 1;
-  string payload = 2; // UNS packet JSON
-}
-
-message Ack {
-  bool ok = 1;
-  string error = 2;
-}
-
-message ReadyRequest {
-  int32 timeout_ms = 1;              // default 15000
-  bool wait_output = 2;              // wait for publisher active (output)
-  bool wait_input = 3;               // wait for subscriber active (input)
-  bool wait_api = 4;                 // wait for API server (optional)
-}
-
-message ApiQueryParam {
-  string name = 1;
-  string type = 2; // string | number | boolean
-  bool required = 3;
-  string description = 4;
-}
-
-message RegisterApiGetRequest {
-  string topic = 1;
-  string attribute = 2;
-  string api_description = 3;
-  repeated string tags = 4;
-  repeated ApiQueryParam query_params = 5;
-}
-
-message UnregisterApiGetRequest {
-  string topic = 1;
-  string attribute = 2;
-}
-
-message ApiEvent {
-  string id = 1;
-  string method = 2; // GET only for now
-  string path = 3;   // /{topic}{attribute}
-  map<string, string> query = 4;
-  string bearer = 5; // access token (optional)
-}
-
-message ApiEventResponse {
-  string id = 1;          // correlation
-  int32 status = 2;       // HTTP status
-  string body = 3;        // response body as string (JSON string if needed)
-  map<string, string> headers = 4; // optional extra headers
-}
+syntax = "proto3";
+
+package uns;
+
+service UnsGateway {
+  rpc Publish (PublishRequest) returns (Ack);
+  rpc Subscribe (SubscribeRequest) returns (stream MqttMessage);
+  rpc RegisterApiGet (RegisterApiGetRequest) returns (Ack);
+  rpc UnregisterApiGet (UnregisterApiGetRequest) returns (Ack);
+  rpc ApiEventStream (stream ApiEventResponse) returns (stream ApiEvent);
+  rpc Ready (ReadyRequest) returns (Ack);
+}
+
+message PublishRequest {
+  string topic = 1;
+  string attribute = 2;
+  string description = 3;
+  repeated string tags = 4;
+  bool attribute_needs_persistence = 5;
+  oneof content {
+    Data data = 6;
+    Table table = 7;
+  }
+  bool value_is_cumulative = 8; // for Data: publish as delta
+}
+
+message Data {
+  string time = 1;
+  double value_number = 2;
+  string value_string = 3;
+  string uom = 4;
+  string data_group = 5;
+  string foreign_event_key = 6;
+}
+
+message TableValue {
+  string key = 1;
+  double value_number = 2;
+  string value_string = 3;
+}
+
+message Table {
+  string time = 1;
+  repeated TableValue values = 2;
+  string data_group = 3;
+}
+
+message SubscribeRequest {
+  repeated string topics = 1;
+}
+
+message MqttMessage {
+  string topic = 1;
+  string payload = 2; // UNS packet JSON
+}
+
+message Ack {
+  bool ok = 1;
+  string error = 2;
+}
+
+message ReadyRequest {
+  int32 timeout_ms = 1;              // default 15000
+  bool wait_output = 2;              // wait for publisher active (output)
+  bool wait_input = 3;               // wait for subscriber active (input)
+  bool wait_api = 4;                 // wait for API server (optional)
+}
+
+message ApiQueryParam {
+  string name = 1;
+  string type = 2; // string | number | boolean
+  bool required = 3;
+  string description = 4;
+}
+
+message RegisterApiGetRequest {
+  string topic = 1;
+  string attribute = 2;
+  string api_description = 3;
+  repeated string tags = 4;
+  repeated ApiQueryParam query_params = 5;
+}
+
+message UnregisterApiGetRequest {
+  string topic = 1;
+  string attribute = 2;
+}
+
+message ApiEvent {
+  string id = 1;
+  string method = 2; // GET only for now
+  string path = 3;   // /{topic}{attribute}
+  map<string, string> query = 4;
+  string bearer = 5; // access token (optional)
+}
+
+message ApiEventResponse {
+  string id = 1;          // correlation
+  int32 status = 2;       // HTTP status
+  string body = 3;        // response body as string (JSON string if needed)
+  map<string, string> headers = 4; // optional extra headers
+}

package/templates/python/pyproject.toml

@@ -1,5 +1,5 @@
-[project]
-name = "uns-example"
-version = "0.1.0"
-description = "A new gRPC project"
+[project]
+name = "uns-example"
+version = "0.1.0"
+description = "A new gRPC project"
 dependencies = ["grpcio", "grpcio-tools", "httpx>=0.27.2"]

package/templates/python/scripts/setup.sh

@@ -1,87 +1,87 @@
-#!/bin/bash
-
-set -euo pipefail
-
-# Navigate to the project root
-cd "$(dirname "$0")/.."
-
-# Detect OS and set paths
-PLATFORM="$(uname)"
-if [[ "$PLATFORM" == "Linux" || "$PLATFORM" == "Darwin" ]]; then
-  PYTHON_EXEC="python3"
-  VENV_DIR="venv"
-  VENV_ACTIVATE="./venv/bin/activate"
-elif [[ "$PLATFORM" =~ MINGW.* || "$PLATFORM" =~ CYGWIN.* || "$PLATFORM" == "MSYS_NT"* ]]; then
-  PYTHON_EXEC="python"
-  VENV_DIR="venv"
-  VENV_ACTIVATE="./venv/Scripts/activate"
-else
-  echo "[setup] Unsupported OS: $PLATFORM"
-  exit 1
-fi
-
-if [[ "$PLATFORM" =~ MINGW.*|MSYS.*|CYGWIN.*|Windows_NT ]]; then
-    UV_CMD="$HOME/.local/bin/uv.exe"
-else
-    UV_CMD="$HOME/.cargo/bin/uv"
-fi
-
-if [ ! -f "$UV_CMD" ]; then
-    echo "[setup] uv not found. Installing it..."
-    curl -LsSf https://astral.sh/uv/install.sh | sh
-else
-    echo "[setup] uv already installed at $UV_CMD"
-fi
-
-# Create virtual environment using uv
-if [ ! -d "$VENV_DIR" ]; then
-  echo "[setup] Creating virtual environment in $VENV_DIR using uv..."
-  "$UV_CMD" venv "$VENV_DIR"
-fi
-
-# Create gen directory if it doesn't exist
-if [ ! -d "gen" ]; then
-  echo "[setup] Creating gen directory..."
-  mkdir -p gen
-fi
-
-# Ensure gen is a package for imports
-if [ ! -f "gen/__init__.py" ]; then
-  echo "[setup] Creating gen/__init__.py..."
-  echo "# generated" > gen/__init__.py
-fi
-
-# Activate the virtual environment
-echo "[setup] Activating virtual environment..."
-if [[ "$PLATFORM" =~ MINGW.*|MSYS.*|CYGWIN.* ]]; then
-    # Windows Git Bash / MSYS
-    . "$VENV_ACTIVATE"
-else
-    # Linux / macOS
-    source "$VENV_ACTIVATE"
-fi
-
-# Install dependencies using uv (much faster than pip)
-echo "[setup] Installing requirements using uv..."
-"$UV_CMD" sync --active
-
-# Generate Python gRPC code from proto
-echo "[setup] Generating gRPC Python code..."
-"$PYTHON_EXEC" -m grpc_tools.protoc \
-  -I=proto \
-  --python_out=gen \
-  --grpc_python_out=gen \
-  proto/uns-gateway.proto
-
-  # Patch the generated _pb2_grpc.py to use relative imports
-GRPC_FILE="gen/uns_gateway_pb2_grpc.py"
-if [[ -f "$GRPC_FILE" ]]; then
-    echo "[setup] Patching $GRPC_FILE to use relative imports..."
-    if [[ "$PLATFORM" == "Linux" || "$PLATFORM" == "Darwin" ]]; then
-        sed -i 's/^import \(.*_pb2\) as/from . import \1 as/' "$GRPC_FILE"
-    elif [[ "$PLATFORM" =~ MINGW.*|MSYS.*|CYGWIN.* ]]; then
-        sed -i'' 's/^import \(.*_pb2\) as/from . import \1 as/' "$GRPC_FILE"
-    fi
-fi
-
-echo "[setup] Setup complete!"
+#!/bin/bash
+
+set -euo pipefail
+
+# Navigate to the project root
+cd "$(dirname "$0")/.."
+
+# Detect OS and set paths
+PLATFORM="$(uname)"
+if [[ "$PLATFORM" == "Linux" || "$PLATFORM" == "Darwin" ]]; then
+  PYTHON_EXEC="python3"
+  VENV_DIR="venv"
+  VENV_ACTIVATE="./venv/bin/activate"
+elif [[ "$PLATFORM" =~ MINGW.* || "$PLATFORM" =~ CYGWIN.* || "$PLATFORM" == "MSYS_NT"* ]]; then
+  PYTHON_EXEC="python"
+  VENV_DIR="venv"
+  VENV_ACTIVATE="./venv/Scripts/activate"
+else
+  echo "[setup] Unsupported OS: $PLATFORM"
+  exit 1
+fi
+
+if [[ "$PLATFORM" =~ MINGW.*|MSYS.*|CYGWIN.*|Windows_NT ]]; then
+    UV_CMD="$HOME/.local/bin/uv.exe"
+else
+    UV_CMD="$HOME/.cargo/bin/uv"
+fi
+
+if [ ! -f "$UV_CMD" ]; then
+    echo "[setup] uv not found. Installing it..."
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+else
+    echo "[setup] uv already installed at $UV_CMD"
+fi
+
+# Create virtual environment using uv
+if [ ! -d "$VENV_DIR" ]; then
+  echo "[setup] Creating virtual environment in $VENV_DIR using uv..."
+  "$UV_CMD" venv "$VENV_DIR"
+fi
+
+# Create gen directory if it doesn't exist
+if [ ! -d "gen" ]; then
+  echo "[setup] Creating gen directory..."
+  mkdir -p gen
+fi
+
+# Ensure gen is a package for imports
+if [ ! -f "gen/__init__.py" ]; then
+  echo "[setup] Creating gen/__init__.py..."
+  echo "# generated" > gen/__init__.py
+fi
+
+# Activate the virtual environment
+echo "[setup] Activating virtual environment..."
+if [[ "$PLATFORM" =~ MINGW.*|MSYS.*|CYGWIN.* ]]; then
+    # Windows Git Bash / MSYS
+    . "$VENV_ACTIVATE"
+else
+    # Linux / macOS
+    source "$VENV_ACTIVATE"
+fi
+
+# Install dependencies using uv (much faster than pip)
+echo "[setup] Installing requirements using uv..."
+"$UV_CMD" sync --active
+
+# Generate Python gRPC code from proto
+echo "[setup] Generating gRPC Python code..."
+"$PYTHON_EXEC" -m grpc_tools.protoc \
+  -I=proto \
+  --python_out=gen \
+  --grpc_python_out=gen \
+  proto/uns-gateway.proto
+
+  # Patch the generated _pb2_grpc.py to use relative imports
+GRPC_FILE="gen/uns_gateway_pb2_grpc.py"
+if [[ -f "$GRPC_FILE" ]]; then
+    echo "[setup] Patching $GRPC_FILE to use relative imports..."
+    if [[ "$PLATFORM" == "Linux" || "$PLATFORM" == "Darwin" ]]; then
+        sed -i 's/^import \(.*_pb2\) as/from . import \1 as/' "$GRPC_FILE"
+    elif [[ "$PLATFORM" =~ MINGW.*|MSYS.*|CYGWIN.* ]]; then
+        sed -i'' 's/^import \(.*_pb2\) as/from . import \1 as/' "$GRPC_FILE"
+    fi
+fi
+
+echo "[setup] Setup complete!"

package/templates/temporal/src/examples/temporal-example.ts

@@ -1,35 +1,35 @@
-/**
- * Change this file according to your specifications and rename it to index.ts
- */
-import { UnsProxyProcess, ConfigFile, logger } from "@uns-kit/core.js";
-import { ITemporalTopic } from "@uns-kit/temporal.js";
-import "@uns-kit/temporal";
-import { type UnsProxyProcessWithTemporal } from "@uns-kit/temporal.js";
-import { UnsAttributeType } from "@uns-kit/core/graphql/schema.js";
-
-/**
- * Load the configuration from a file.
- * On the server, this file is provided by the `uns-datahub-controller`.
- * In the development environment, you are responsible for creating and maintaining this file and its contents.
- */
-const config = await ConfigFile.loadConfig();
-
-/**
- * Connect to the temporal and register uns topic for temporal
- */
-const unsProxyProcess = new UnsProxyProcess(config.infra.host!, {processName:config.uns.processName}) as UnsProxyProcessWithTemporal;
-const temporalTopic: ITemporalTopic = {
-  attribute: "temporal-data",
-  topic: "example/",
-  attributeType: UnsAttributeType.Data,
-  attributeNeedsPersistence: true,
-  dataGroup: "temporal",
-  description: "Temporal data example",
-  tags: ["temporal"],
-}
-const temporalProxy = await unsProxyProcess.createTemporalProxy("templateUnsTemporal", "temporal.example.local:7233", "line-namespace");
-await temporalProxy.initializeTemporalProxy(temporalTopic);
-
-// Start temporal workflow
-const result = await temporalProxy.startWorkflow("TransformLineData", {'coil_id': "42"}, "ETL_LINE_TASK_QUEUE");
-logger.info(`Workflow result: ${JSON.stringify(result)}`);
+/**
+ * Change this file according to your specifications and rename it to index.ts
+ */
+import { UnsProxyProcess, ConfigFile, logger } from "@uns-kit/core";
+import { ITemporalTopic } from "@uns-kit/temporal.js";
+import "@uns-kit/temporal";
+import { type UnsProxyProcessWithTemporal } from "@uns-kit/temporal.js";
+import { UnsAttributeType } from "@uns-kit/core/graphql/schema.js";
+
+/**
+ * Load the configuration from a file.
+ * On the server, this file is provided by the `uns-datahub-controller`.
+ * In the development environment, you are responsible for creating and maintaining this file and its contents.
+ */
+const config = await ConfigFile.loadConfig();
+
+/**
+ * Connect to the temporal and register uns topic for temporal
+ */
+const unsProxyProcess = new UnsProxyProcess(config.infra.host!, {processName:config.uns.processName}) as UnsProxyProcessWithTemporal;
+const temporalTopic: ITemporalTopic = {
+  attribute: "temporal-data",
+  topic: "example/",
+  attributeType: UnsAttributeType.Data,
+  attributeNeedsPersistence: true,
+  dataGroup: "temporal",
+  description: "Temporal data example",
+  tags: ["temporal"],
+}
+const temporalProxy = await unsProxyProcess.createTemporalProxy("templateUnsTemporal", "temporal.example.local:7233", "line-namespace");
+await temporalProxy.initializeTemporalProxy(temporalTopic);
+
+// Start temporal workflow
+const result = await temporalProxy.startWorkflow("TransformLineData", {'coil_id': "42"}, "ETL_LINE_TASK_QUEUE");
+logger.info(`Workflow result: ${JSON.stringify(result)}`);