jentic-openapi-transformer-redocly 1.0.0a31__tar.gz → 1.0.0a33__tar.gz

{jentic_openapi_transformer_redocly-1.0.0a31 → jentic_openapi_transformer_redocly-1.0.0a33}/PKG-INFO

@@ -1,21 +1,23 @@
 Metadata-Version: 2.4
 Name: jentic-openapi-transformer-redocly
-Version: 1.0.0a31
+Version: 1.0.0a33
 Summary: Jentic OpenAPI Redocly Transformer Backend
 Author: Jentic
 Author-email: Jentic <hello@jentic.com>
 License-Expression: Apache-2.0
 License-File: LICENSE
 License-File: NOTICE
-Requires-Dist: jentic-openapi-common~=1.0.0a31
-Requires-Dist: jentic-openapi-transformer~=1.0.0a31
+Requires-Dist: jentic-openapi-common~=1.0.0a33
+Requires-Dist: jentic-openapi-transformer~=1.0.0a33
 Requires-Python: >=3.11
 Project-URL: Homepage, https://github.com/jentic/jentic-openapi-tools
 Description-Content-Type: text/markdown
 
 # jentic-openapi-transformer-redocly
 
-A Python library that provides OpenAPI document bundling functionality using [Redocly CLI](https://redocly.com/docs/cli/). This package is part of the Jentic OpenAPI Tools ecosystem and implements the transformer backend pattern for bundling OpenAPI documents by resolving external references.
+A Python library that provides OpenAPI document bundling functionality
+using [Redocly CLI](https://redocly.com/docs/cli/). This package is part of the Jentic OpenAPI Tools ecosystem and
+implements the transformer backend pattern for bundling OpenAPI documents by resolving external references.
 
 ## Features
 
@@ -25,7 +27,6 @@ A Python library that provides OpenAPI document bundling functionality using [Re
 - **Timeout Configuration**: Configurable timeout for long-running bundling operations
 - **Type Safety**: Full type hints and comprehensive documentation
 
-
 ## Installation
 
 ```bash
@@ -33,13 +34,14 @@ pip install jentic-openapi-transformer-redocly
 ```
 
 **Prerequisites:**
+
 - Node.js and npm (for Redocly CLI)
 - Python 3.11+
 
 The Redocly CLI will be automatically downloaded via npx on first use, or you can install it globally:
 
 ```bash
-npm install -g @redocly/cli
+npm install -g @redocly/cli@2.14.3
 ```
 
 ## Quick Start
@@ -122,7 +124,8 @@ The bundler accepts the following input formats (returned by `accepts()` method)
 
 ### Integration Tests
 
-The integration tests require Redocly CLI to be available. They will be automatically skipped if Redocly is not installed.
+The integration tests require Redocly CLI to be available. They will be automatically skipped if Redocly is not
+installed.
 
 **Run the integration test:**
 
@@ -137,17 +140,21 @@ uv run --package jentic-openapi-transformer-redocly pytest packages/jentic-opena
 ```python
 class RedoclyBundlerBackend(BaseBundlerBackend):
     def __init__(
-        self,
-        redocly_path: str = "npx --yes @redocly/cli@2.11.1",
-        timeout: float = 600.0,
-        allowed_base_dir: str | Path | None = None,
+            self,
+            redocly_path: str = "npx --yes @redocly/cli@2.14.3",
+            timeout: float = 600.0,
+            allowed_base_dir: str | Path | None = None,
     ) -> None
 ```
 
 **Parameters:**
+
 - `redocly_path`: Path to Redocly CLI executable
 - `timeout`: Maximum execution time in seconds
-- `allowed_base_dir`: Optional base directory for path security validation. When set, all document paths are validated to be within this directory, providing defense against path traversal attacks. When `None` (default), only file extension validation is performed (no base directory containment check). Recommended for web services or untrusted input (optional)
+- `allowed_base_dir`: Optional base directory for path security validation. When set, all document paths are validated
+  to be within this directory, providing defense against path traversal attacks. When `None` (default), only file
+  extension validation is performed (no base directory containment check). Recommended for web services or untrusted
+  input (optional)
 
 **Methods:**
 
@@ -155,6 +162,7 @@ class RedoclyBundlerBackend(BaseBundlerBackend):
 - `bundle(document: str | dict, base_url: str | None = None) -> str`: Bundles an OpenAPI document
 
 **Exceptions:**
+
 - `TypeError`: Document type is not supported
 - `RuntimeError`: Redocly execution fails or produces invalid output
 - `SubprocessExecutionError`: Redocly times out or fails to start

{jentic_openapi_transformer_redocly-1.0.0a31 → jentic_openapi_transformer_redocly-1.0.0a33}/README.md

@@ -1,6 +1,8 @@
 # jentic-openapi-transformer-redocly
 
-A Python library that provides OpenAPI document bundling functionality using [Redocly CLI](https://redocly.com/docs/cli/). This package is part of the Jentic OpenAPI Tools ecosystem and implements the transformer backend pattern for bundling OpenAPI documents by resolving external references.
+A Python library that provides OpenAPI document bundling functionality
+using [Redocly CLI](https://redocly.com/docs/cli/). This package is part of the Jentic OpenAPI Tools ecosystem and
+implements the transformer backend pattern for bundling OpenAPI documents by resolving external references.
 
 ## Features
 
@@ -10,7 +12,6 @@ A Python library that provides OpenAPI document bundling functionality using [Re
 - **Timeout Configuration**: Configurable timeout for long-running bundling operations
 - **Type Safety**: Full type hints and comprehensive documentation
 
-
 ## Installation
 
 ```bash
@@ -18,13 +19,14 @@ pip install jentic-openapi-transformer-redocly
 ```
 
 **Prerequisites:**
+
 - Node.js and npm (for Redocly CLI)
 - Python 3.11+
 
 The Redocly CLI will be automatically downloaded via npx on first use, or you can install it globally:
 
 ```bash
-npm install -g @redocly/cli
+npm install -g @redocly/cli@2.14.3
 ```
 
 ## Quick Start
@@ -107,7 +109,8 @@ The bundler accepts the following input formats (returned by `accepts()` method)
 
 ### Integration Tests
 
-The integration tests require Redocly CLI to be available. They will be automatically skipped if Redocly is not installed.
+The integration tests require Redocly CLI to be available. They will be automatically skipped if Redocly is not
+installed.
 
 **Run the integration test:**
 
@@ -122,17 +125,21 @@ uv run --package jentic-openapi-transformer-redocly pytest packages/jentic-opena
 ```python
 class RedoclyBundlerBackend(BaseBundlerBackend):
     def __init__(
-        self,
-        redocly_path: str = "npx --yes @redocly/cli@2.11.1",
-        timeout: float = 600.0,
-        allowed_base_dir: str | Path | None = None,
+            self,
+            redocly_path: str = "npx --yes @redocly/cli@2.14.3",
+            timeout: float = 600.0,
+            allowed_base_dir: str | Path | None = None,
     ) -> None
 ```
 
 **Parameters:**
+
 - `redocly_path`: Path to Redocly CLI executable
 - `timeout`: Maximum execution time in seconds
-- `allowed_base_dir`: Optional base directory for path security validation. When set, all document paths are validated to be within this directory, providing defense against path traversal attacks. When `None` (default), only file extension validation is performed (no base directory containment check). Recommended for web services or untrusted input (optional)
+- `allowed_base_dir`: Optional base directory for path security validation. When set, all document paths are validated
+  to be within this directory, providing defense against path traversal attacks. When `None` (default), only file
+  extension validation is performed (no base directory containment check). Recommended for web services or untrusted
+  input (optional)
 
 **Methods:**
 
@@ -140,6 +147,7 @@ class RedoclyBundlerBackend(BaseBundlerBackend):
 - `bundle(document: str | dict, base_url: str | None = None) -> str`: Bundles an OpenAPI document
 
 **Exceptions:**
+
 - `TypeError`: Document type is not supported
 - `RuntimeError`: Redocly execution fails or produces invalid output
 - `SubprocessExecutionError`: Redocly times out or fails to start

{jentic_openapi_transformer_redocly-1.0.0a31 → jentic_openapi_transformer_redocly-1.0.0a33}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "jentic-openapi-transformer-redocly"
-version = "1.0.0-alpha.31"
+version = "1.0.0-alpha.33"
 description = "Jentic OpenAPI Redocly Transformer Backend"
 readme = "README.md"
 authors = [{ name = "Jentic", email = "hello@jentic.com" }]
@@ -8,8 +8,8 @@ license = "Apache-2.0"
 license-files = ["LICENSE", "NOTICE"]
 requires-python = ">=3.11"
 dependencies = [
-  "jentic-openapi-common~=1.0.0-alpha.31",
-  "jentic-openapi-transformer~=1.0.0-alpha.31"
+  "jentic-openapi-common~=1.0.0-alpha.33",
+  "jentic-openapi-transformer~=1.0.0-alpha.33"
 ]
 
 [project.urls]

{jentic_openapi_transformer_redocly-1.0.0a31 → jentic_openapi_transformer_redocly-1.0.0a33}/src/jentic/apitools/openapi/transformer/bundler/backends/redocly/__init__.py

@@ -1,4 +1,5 @@
 import json
+import os
 import shlex
 import tempfile
 from collections.abc import Sequence
@@ -17,7 +18,7 @@ __all__ = ["RedoclyBundlerBackend"]
 class RedoclyBundlerBackend(BaseBundlerBackend):
     def __init__(
         self,
-        redocly_path: str = "npx --yes @redocly/cli@2.11.1",
+        redocly_path: str = "npx --yes @redocly/cli@2.14.3",
         timeout: float = 600.0,
         allowed_base_dir: str | Path | None = None,
     ):
@@ -25,7 +26,7 @@ class RedoclyBundlerBackend(BaseBundlerBackend):
         Initialize the RedoclyBundler.
 
         Args:
-            redocly_path: Path to the redocly CLI executable (default: "npx --yes @redocly/cli@2.11.1").
+            redocly_path: Path to the redocly CLI executable (default: "npx --yes @redocly/cli@2.14.3").
                 Uses shell-safe parsing to handle quoted arguments properly.
             timeout: Maximum time in seconds to wait for Redocly CLI execution (default: 600.0)
             allowed_base_dir: Optional base directory for path security validation.
@@ -108,7 +109,15 @@ class RedoclyBundlerBackend(BaseBundlerBackend):
                 # TODO(francesco@jentic.com): raises errors in redocly for unknown reason
                 # "--remove-unused-components",
             ]
-            result = run_subprocess(cmd, timeout=self.timeout)
+            env = os.environ.copy()
+            env.update(
+                {
+                    "REDOCLY_TELEMETRY": "off",
+                    "REDOCLY_SUPPRESS_UPDATE_NOTICE": "true",
+                }
+            )
+
+            result = run_subprocess(cmd, env=env, timeout=self.timeout)
 
             # Check if bundling was successful based on return code
             if result.returncode != 0: