jentic-openapi-validator-speclynx 1.0.0a34__tar.gz

jentic_openapi_validator_speclynx-1.0.0a34/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

jentic_openapi_validator_speclynx-1.0.0a34/NOTICE

@@ -0,0 +1,4 @@
+Jentic OpenAPI Tools
+Copyright (c) 2026 Jentic
+Jentic OpenAPI Tools is licensed under Apache 2.0 license.
+Copy of the Apache 2.0 license can be found in `LICENSE` file.

jentic_openapi_validator_speclynx-1.0.0a34/PKG-INFO

@@ -0,0 +1,311 @@
+Metadata-Version: 2.4
+Name: jentic-openapi-validator-speclynx
+Version: 1.0.0a34
+Summary: Jentic OpenAPI SpecLynx Validator 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.0a34
+Requires-Dist: jentic-openapi-validator~=1.0.0a34
+Requires-Dist: lsprotocol~=2025.0.0
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/jentic/jentic-openapi-tools
+Description-Content-Type: text/markdown
+
+# jentic-openapi-validator-speclynx
+
+A [SpecLynx ApiDOM](https://github.com/speclynx/apidom) validator backend for the Jentic OpenAPI Tools ecosystem.
+This package provides OpenAPI document validation using SpecLynx ApiDOM with comprehensive error reporting and flexible
+configuration options.
+
+## Features
+
+- **Multiple input formats**: Validate OpenAPI documents from file URIs or Python dictionaries
+- **Custom plugins**: Use built-in plugins or provide your own validation plugins
+- **Configurable timeouts**: Control execution time limits for different use cases
+- **Rich diagnostics**: Detailed validation results with line/column information
+- **Type-safe API**: Full typing support with Literal types and comprehensive docstrings
+
+## Installation
+
+```bash
+pip install jentic-openapi-validator-speclynx
+```
+
+**Prerequisites:**
+
+- Node.js and npm (for SpecLynx CLI)
+- Python 3.11+
+
+The SpecLynx dependencies will be automatically installed via npm on first use.
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from jentic.apitools.openapi.validator.backends.speclynx import SpeclynxValidatorBackend
+
+# Create validator with defaults
+validator = SpeclynxValidatorBackend()
+
+# Validate from file URI
+result = validator.validate("file:///path/to/openapi.yaml")
+print(f"Valid: {result.valid}")
+
+# Check for validation issues
+if not result.valid:
+    for diagnostic in result.diagnostics:
+        print(f"Error: {diagnostic.message}")
+```
+
+### Validate Dictionary Documents
+
+```python
+# Validate from dictionary
+openapi_doc = {
+    "openapi": "3.0.0",
+    "info": {"title": "My API", "version": "1.0.0"},
+    "paths": {}
+}
+
+result = validator.validate(openapi_doc)
+print(f"Document is valid: {result.valid}")
+```
+
+## Configuration Options
+
+### Custom Plugins Directory
+
+```python
+# Use additional plugins directory (merged with built-in plugins)
+validator = SpeclynxValidatorBackend(plugins_dir="/path/to/custom-plugins")
+
+# The validator loads all .mjs files from both:
+# 1. Built-in plugins directory (always loaded)
+# 2. Custom plugins directory (merged with built-in plugins)
+```
+
+### Timeout Configuration
+
+```python
+# Short timeout for CI/CD (10 seconds)
+validator = SpeclynxValidatorBackend(timeout=10.0)
+
+# Extended timeout for large documents (2 minutes)
+validator = SpeclynxValidatorBackend(timeout=120.0)
+
+# Combined configuration (45 seconds)
+validator = SpeclynxValidatorBackend(
+    plugins_dir="/path/to/custom-plugins",
+    timeout=45.0
+)
+```
+
+### Custom SpecLynx Path
+
+By default, the validator uses the bundled SpecLynx CLI via npx. You can override this to use a custom installation:
+
+```python
+# Use custom speclynx installation
+validator = SpeclynxValidatorBackend(speclynx_path="/usr/local/bin/speclynx")
+
+# Install additional npm packages for custom plugins that have dependencies
+# The -p flag installs packages before running the CLI
+validator = SpeclynxValidatorBackend(
+    speclynx_path="npx --yes -p lodash -p moment jentic-openapi-validator-speclynx-0.1.0.tgz"
+)
+```
+
+### Path Security
+
+Use `allowed_base_dir` to restrict file access when processing untrusted input or running as a web service:
+
+```python
+from jentic.apitools.openapi.common.path_security import (
+    PathTraversalError,
+    InvalidExtensionError,
+)
+
+# Restrict file access to /var/app/documents directory
+validator = SpeclynxValidatorBackend(
+    allowed_base_dir="/var/app/documents"
+)
+
+# Valid paths within allowed directory work normally
+result = validator.validate("/var/app/documents/specs/openapi.yaml")
+
+# Path traversal attempts are blocked
+try:
+    result = validator.validate("/var/app/documents/../../etc/passwd")
+except PathTraversalError as e:
+    print(f"Security violation: {e}")
+
+# Invalid file extensions are rejected
+try:
+    result = validator.validate("/var/app/documents/malicious.exe")
+except InvalidExtensionError as e:
+    print(f"Invalid file type: {e}")
+
+# HTTP(S) URLs bypass path validation (as expected)
+result = validator.validate("https://example.com/openapi.yaml")
+
+# Combined security configuration for web services
+validator = SpeclynxValidatorBackend(
+    allowed_base_dir="/var/app/uploads",
+    plugins_dir="/var/app/config/custom-plugins",
+    timeout=600.0
+)
+```
+
+**Security Benefits:**
+
+- Prevents path traversal attacks (`../../etc/passwd`)
+- Restricts access to allowed directories only (when `allowed_base_dir` is set)
+- Validates file extensions (`.yaml`, `.yml`, `.json`) - **always enforced**, even when `allowed_base_dir=None`
+- Checks symlinks don't escape boundaries (when `allowed_base_dir` is set)
+
+**Note:** File extension validation (`.yaml`, `.yml`, `.json`) is always performed for filesystem paths, regardless of
+whether `allowed_base_dir` is set. When `allowed_base_dir=None`, only the base directory containment check is skipped.
+
+## Advanced Usage
+
+### Error Handling
+
+```python
+from jentic.apitools.openapi.common.subproc import SubprocessExecutionError
+
+try:
+    result = validator.validate("file:///path/to/openapi.yaml")
+
+    if result.valid:
+        print("Document is valid")
+    else:
+        print("Validation failed:")
+        for diagnostic in result.diagnostics:
+            severity = diagnostic.severity.name
+            line = diagnostic.range.start.line + 1
+            print(f"  {severity}: {diagnostic.message} (line {line})")
+
+except SubprocessExecutionError as e:
+    print(f"SpecLynx execution failed: {e}")
+except TypeError as e:
+    print(f"Invalid document type: {e}")
+```
+
+### Supported Document Formats
+
+```python
+# Check what formats the validator supports
+formats = validator.accepts()
+print(formats)  # ['uri', 'dict']
+
+# Validate different input types
+if "uri" in validator.accepts():
+    result = validator.validate("file:///path/to/spec.yaml")
+
+if "dict" in validator.accepts():
+    result = validator.validate({"openapi": "3.0.0", ...})
+```
+
+## Custom Plugins
+
+Create custom validation plugins as ES modules (`.mjs` files). Plugins use the ApiDOM visitor pattern:
+
+```javascript
+// custom-plugin.mjs
+import {toValue} from '@speclynx/apidom-core';
+import {DiagnosticSeverity} from 'vscode-languageserver-types';
+
+export default ({diagnostics}) => () => ({
+    pre() {
+    },
+    visitor: {
+        InfoElement(path) {
+            const info = path.node;
+            const version = info.get('version');
+
+            if (version && typeof toValue(version) !== 'string') {
+                diagnostics.push({
+                    severity: DiagnosticSeverity.Error,
+                    message: 'info.version must be a string',
+                    code: 'invalid-info-version-type',
+                    range: {
+                        start: {line: 0, character: 0},
+                        end: {line: 0, character: 0}
+                    },
+                    data: {path: ['info', 'version']}
+                });
+            }
+        }
+    },
+    post() {
+    },
+});
+```
+
+Use it with the validator:
+
+```python
+validator = SpeclynxValidatorBackend(plugins_dir="./custom-plugins")
+result = validator.validate("file:///path/to/openapi.yaml")
+```
+
+**Note:** Custom plugins are merged with built-in plugins. Both the built-in plugins and your custom plugins will run
+during validation.
+
+## Testing
+
+### Integration Tests
+
+The integration tests require Node.js to be available. They will be automatically skipped if Node.js is not installed.
+
+**Run the integration test:**
+
+```bash
+uv run --package jentic-openapi-validator-speclynx pytest packages/jentic-openapi-validator-speclynx -v
+```
+
+## API Reference
+
+### SpeclynxValidatorBackend
+
+```python
+class SpeclynxValidatorBackend(BaseValidatorBackend):
+    def __init__(
+            self,
+            speclynx_path: str = "npx --yes jentic-openapi-validator-speclynx-0.1.0.tgz",
+            timeout: float = 600.0,
+            allowed_base_dir: str | Path | None = None,
+            plugins_dir: str | Path | None = None,
+    ) -> None
+```
+
+**Parameters:**
+
+- `speclynx_path`: Path to the SpecLynx CLI executable. Default uses bundled npm tarball via npx. Can be a custom path
+  like `/usr/local/bin/speclynx` or an npx command with additional packages (optional)
+- `timeout`: Maximum execution time in seconds (default: 600.0)
+- `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)
+- `plugins_dir`: Optional directory containing additional validation plugins (`.mjs` files). When specified, custom
+  plugins are merged with built-in plugins (both are loaded). If `None` (default), only built-in plugins are used
+  (optional)
+
+**Methods:**
+
+- `accepts() -> list[Literal["uri", "dict"]]`: Returns supported document format identifiers
+- `validate(document: str | dict, *, base_url: str | None = None, target: str | None = None) -> ValidationResult`:
+  Validates an OpenAPI document
+
+**Exceptions:**
+
+- `RuntimeError`: SpecLynx execution fails
+- `SubprocessExecutionError`: SpecLynx times out or fails to start
+- `TypeError`: Unsupported document type
+- `PathTraversalError`: Document path attempts to escape allowed_base_dir (only when `allowed_base_dir` is set)
+- `InvalidExtensionError`: Document path has disallowed file extension (always checked for filesystem paths)

jentic_openapi_validator_speclynx-1.0.0a34/README.md

@@ -0,0 +1,295 @@
+# jentic-openapi-validator-speclynx
+
+A [SpecLynx ApiDOM](https://github.com/speclynx/apidom) validator backend for the Jentic OpenAPI Tools ecosystem.
+This package provides OpenAPI document validation using SpecLynx ApiDOM with comprehensive error reporting and flexible
+configuration options.
+
+## Features
+
+- **Multiple input formats**: Validate OpenAPI documents from file URIs or Python dictionaries
+- **Custom plugins**: Use built-in plugins or provide your own validation plugins
+- **Configurable timeouts**: Control execution time limits for different use cases
+- **Rich diagnostics**: Detailed validation results with line/column information
+- **Type-safe API**: Full typing support with Literal types and comprehensive docstrings
+
+## Installation
+
+```bash
+pip install jentic-openapi-validator-speclynx
+```
+
+**Prerequisites:**
+
+- Node.js and npm (for SpecLynx CLI)
+- Python 3.11+
+
+The SpecLynx dependencies will be automatically installed via npm on first use.
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from jentic.apitools.openapi.validator.backends.speclynx import SpeclynxValidatorBackend
+
+# Create validator with defaults
+validator = SpeclynxValidatorBackend()
+
+# Validate from file URI
+result = validator.validate("file:///path/to/openapi.yaml")
+print(f"Valid: {result.valid}")
+
+# Check for validation issues
+if not result.valid:
+    for diagnostic in result.diagnostics:
+        print(f"Error: {diagnostic.message}")
+```
+
+### Validate Dictionary Documents
+
+```python
+# Validate from dictionary
+openapi_doc = {
+    "openapi": "3.0.0",
+    "info": {"title": "My API", "version": "1.0.0"},
+    "paths": {}
+}
+
+result = validator.validate(openapi_doc)
+print(f"Document is valid: {result.valid}")
+```
+
+## Configuration Options
+
+### Custom Plugins Directory
+
+```python
+# Use additional plugins directory (merged with built-in plugins)
+validator = SpeclynxValidatorBackend(plugins_dir="/path/to/custom-plugins")
+
+# The validator loads all .mjs files from both:
+# 1. Built-in plugins directory (always loaded)
+# 2. Custom plugins directory (merged with built-in plugins)
+```
+
+### Timeout Configuration
+
+```python
+# Short timeout for CI/CD (10 seconds)
+validator = SpeclynxValidatorBackend(timeout=10.0)
+
+# Extended timeout for large documents (2 minutes)
+validator = SpeclynxValidatorBackend(timeout=120.0)
+
+# Combined configuration (45 seconds)
+validator = SpeclynxValidatorBackend(
+    plugins_dir="/path/to/custom-plugins",
+    timeout=45.0
+)
+```
+
+### Custom SpecLynx Path
+
+By default, the validator uses the bundled SpecLynx CLI via npx. You can override this to use a custom installation:
+
+```python
+# Use custom speclynx installation
+validator = SpeclynxValidatorBackend(speclynx_path="/usr/local/bin/speclynx")
+
+# Install additional npm packages for custom plugins that have dependencies
+# The -p flag installs packages before running the CLI
+validator = SpeclynxValidatorBackend(
+    speclynx_path="npx --yes -p lodash -p moment jentic-openapi-validator-speclynx-0.1.0.tgz"
+)
+```
+
+### Path Security
+
+Use `allowed_base_dir` to restrict file access when processing untrusted input or running as a web service:
+
+```python
+from jentic.apitools.openapi.common.path_security import (
+    PathTraversalError,
+    InvalidExtensionError,
+)
+
+# Restrict file access to /var/app/documents directory
+validator = SpeclynxValidatorBackend(
+    allowed_base_dir="/var/app/documents"
+)
+
+# Valid paths within allowed directory work normally
+result = validator.validate("/var/app/documents/specs/openapi.yaml")
+
+# Path traversal attempts are blocked
+try:
+    result = validator.validate("/var/app/documents/../../etc/passwd")
+except PathTraversalError as e:
+    print(f"Security violation: {e}")
+
+# Invalid file extensions are rejected
+try:
+    result = validator.validate("/var/app/documents/malicious.exe")
+except InvalidExtensionError as e:
+    print(f"Invalid file type: {e}")
+
+# HTTP(S) URLs bypass path validation (as expected)
+result = validator.validate("https://example.com/openapi.yaml")
+
+# Combined security configuration for web services
+validator = SpeclynxValidatorBackend(
+    allowed_base_dir="/var/app/uploads",
+    plugins_dir="/var/app/config/custom-plugins",
+    timeout=600.0
+)
+```
+
+**Security Benefits:**
+
+- Prevents path traversal attacks (`../../etc/passwd`)
+- Restricts access to allowed directories only (when `allowed_base_dir` is set)
+- Validates file extensions (`.yaml`, `.yml`, `.json`) - **always enforced**, even when `allowed_base_dir=None`
+- Checks symlinks don't escape boundaries (when `allowed_base_dir` is set)
+
+**Note:** File extension validation (`.yaml`, `.yml`, `.json`) is always performed for filesystem paths, regardless of
+whether `allowed_base_dir` is set. When `allowed_base_dir=None`, only the base directory containment check is skipped.
+
+## Advanced Usage
+
+### Error Handling
+
+```python
+from jentic.apitools.openapi.common.subproc import SubprocessExecutionError
+
+try:
+    result = validator.validate("file:///path/to/openapi.yaml")
+
+    if result.valid:
+        print("Document is valid")
+    else:
+        print("Validation failed:")
+        for diagnostic in result.diagnostics:
+            severity = diagnostic.severity.name
+            line = diagnostic.range.start.line + 1
+            print(f"  {severity}: {diagnostic.message} (line {line})")
+
+except SubprocessExecutionError as e:
+    print(f"SpecLynx execution failed: {e}")
+except TypeError as e:
+    print(f"Invalid document type: {e}")
+```
+
+### Supported Document Formats
+
+```python
+# Check what formats the validator supports
+formats = validator.accepts()
+print(formats)  # ['uri', 'dict']
+
+# Validate different input types
+if "uri" in validator.accepts():
+    result = validator.validate("file:///path/to/spec.yaml")
+
+if "dict" in validator.accepts():
+    result = validator.validate({"openapi": "3.0.0", ...})
+```
+
+## Custom Plugins
+
+Create custom validation plugins as ES modules (`.mjs` files). Plugins use the ApiDOM visitor pattern:
+
+```javascript
+// custom-plugin.mjs
+import {toValue} from '@speclynx/apidom-core';
+import {DiagnosticSeverity} from 'vscode-languageserver-types';
+
+export default ({diagnostics}) => () => ({
+    pre() {
+    },
+    visitor: {
+        InfoElement(path) {
+            const info = path.node;
+            const version = info.get('version');
+
+            if (version && typeof toValue(version) !== 'string') {
+                diagnostics.push({
+                    severity: DiagnosticSeverity.Error,
+                    message: 'info.version must be a string',
+                    code: 'invalid-info-version-type',
+                    range: {
+                        start: {line: 0, character: 0},
+                        end: {line: 0, character: 0}
+                    },
+                    data: {path: ['info', 'version']}
+                });
+            }
+        }
+    },
+    post() {
+    },
+});
+```
+
+Use it with the validator:
+
+```python
+validator = SpeclynxValidatorBackend(plugins_dir="./custom-plugins")
+result = validator.validate("file:///path/to/openapi.yaml")
+```
+
+**Note:** Custom plugins are merged with built-in plugins. Both the built-in plugins and your custom plugins will run
+during validation.
+
+## Testing
+
+### Integration Tests
+
+The integration tests require Node.js to be available. They will be automatically skipped if Node.js is not installed.
+
+**Run the integration test:**
+
+```bash
+uv run --package jentic-openapi-validator-speclynx pytest packages/jentic-openapi-validator-speclynx -v
+```
+
+## API Reference
+
+### SpeclynxValidatorBackend
+
+```python
+class SpeclynxValidatorBackend(BaseValidatorBackend):
+    def __init__(
+            self,
+            speclynx_path: str = "npx --yes jentic-openapi-validator-speclynx-0.1.0.tgz",
+            timeout: float = 600.0,
+            allowed_base_dir: str | Path | None = None,
+            plugins_dir: str | Path | None = None,
+    ) -> None
+```
+
+**Parameters:**
+
+- `speclynx_path`: Path to the SpecLynx CLI executable. Default uses bundled npm tarball via npx. Can be a custom path
+  like `/usr/local/bin/speclynx` or an npx command with additional packages (optional)
+- `timeout`: Maximum execution time in seconds (default: 600.0)
+- `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)
+- `plugins_dir`: Optional directory containing additional validation plugins (`.mjs` files). When specified, custom
+  plugins are merged with built-in plugins (both are loaded). If `None` (default), only built-in plugins are used
+  (optional)
+
+**Methods:**
+
+- `accepts() -> list[Literal["uri", "dict"]]`: Returns supported document format identifiers
+- `validate(document: str | dict, *, base_url: str | None = None, target: str | None = None) -> ValidationResult`:
+  Validates an OpenAPI document
+
+**Exceptions:**
+
+- `RuntimeError`: SpecLynx execution fails
+- `SubprocessExecutionError`: SpecLynx times out or fails to start
+- `TypeError`: Unsupported document type
+- `PathTraversalError`: Document path attempts to escape allowed_base_dir (only when `allowed_base_dir` is set)
+- `InvalidExtensionError`: Document path has disallowed file extension (always checked for filesystem paths)

jentic_openapi_validator_speclynx-1.0.0a34/pyproject.toml

@@ -0,0 +1,46 @@
+[project]
+name = "jentic-openapi-validator-speclynx"
+version = "1.0.0-alpha.34"
+description = "Jentic OpenAPI SpecLynx Validator Backend"
+readme = "README.md"
+authors = [{ name = "Jentic", email = "hello@jentic.com" }]
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+requires-python = ">=3.11"
+dependencies = [
+    "jentic-openapi-common~=1.0.0-alpha.34",
+    "jentic-openapi-validator~=1.0.0-alpha.34",
+    "lsprotocol~=2025.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/jentic/jentic-openapi-tools"
+
+[tool.uv]
+package = true
+
+[tool.uv.build-backend]
+namespace = true
+module-name = "jentic.apitools.openapi.validator.backends.speclynx"
+module-root = "src/"
+# Only include .tgz tarball, exclude source files
+source-exclude = ["resources/*.mjs", "resources/*.json", "resources/plugins"]
+wheel-exclude = ["resources/*.mjs", "resources/*.json", "resources/plugins"]
+source-include = ["resources/*.tgz"]
+wheel-include = ["resources/*.tgz"]
+
+[tool.uv.sources]
+jentic-openapi-common = { workspace = true }
+jentic-openapi-validator = { workspace = true }
+
+[build-system]
+requires = ["uv_build~=0.8.15"]
+build-backend = "uv_build"
+
+[tool.poe.tasks]
+[tool.poe.tasks."speclynx:pack"]
+shell = "npm pack src/jentic/apitools/openapi/validator/backends/speclynx/resources --pack-destination src/jentic/apitools/openapi/validator/backends/speclynx/resources"
+
+
+[project.entry-points."jentic.apitools.openapi.validator.backends"]
+speclynx = "jentic.apitools.openapi.validator.backends.speclynx:SpeclynxValidatorBackend"

jentic_openapi_validator_speclynx-1.0.0a34/src/jentic/apitools/openapi/validator/backends/speclynx/__init__.py

@@ -0,0 +1,289 @@
+import json
+import logging
+import shlex
+import tempfile
+from collections.abc import Sequence
+from importlib.resources import as_file, files
+from pathlib import Path
+from typing import Literal
+
+from lsprotocol.types import DiagnosticSeverity, Position, Range
+
+from jentic.apitools.openapi.common.path_security import validate_path
+from jentic.apitools.openapi.common.subproc import (
+    SubprocessExecutionError,
+    SubprocessExecutionResult,
+    run_subprocess,
+)
+from jentic.apitools.openapi.common.uri import file_uri_to_path, is_file_uri, is_path
+from jentic.apitools.openapi.validator.backends.base import BaseValidatorBackend
+from jentic.apitools.openapi.validator.core import JenticDiagnostic, ValidationResult
+
+
+__all__ = ["SpeclynxValidatorBackend"]
+
+
+logger = logging.getLogger(__name__)
+
+_TARBALL_NAME = "jentic-openapi-validator-speclynx-0.1.0.tgz"
+_DEFAULT_SPECLYNX_PATH = f"npx --yes {_TARBALL_NAME}"
+
+resources_dir = files("jentic.apitools.openapi.validator.backends.speclynx.resources")
+tarball_file = resources_dir.joinpath(_TARBALL_NAME)
+
+
+class SpeclynxValidatorBackend(BaseValidatorBackend):
+    def __init__(
+        self,
+        speclynx_path: str = _DEFAULT_SPECLYNX_PATH,
+        timeout: float = 600.0,
+        allowed_base_dir: str | Path | None = None,
+        plugins_dir: str | Path | None = None,
+    ):
+        """
+        Initialize the SpeclynxValidatorBackend.
+
+        Args:
+            speclynx_path: Path to the speclynx CLI executable (default: uses bundled npm tarball via npx).
+                Can be a custom path like "/usr/local/bin/speclynx" or an npx command.
+                Uses shell-safe parsing to handle quoted arguments properly.
+            timeout: Maximum time in seconds to wait for validation execution (default: 600.0)
+            allowed_base_dir: Optional base directory for path security validation.
+                When set, all document paths will be validated to ensure they
+                are within this directory. This provides defense against path traversal attacks
+                and is recommended for web services or when processing untrusted input.
+                If None (default), only file extension validation is performed (no base directory
+                containment check). Extension validation ensures only .yaml, .yml, and .json files
+                are processed.
+            plugins_dir: Optional directory containing additional validation plugins (.mjs files).
+                Plugins are loaded automatically and used to validate the OpenAPI document.
+                When specified, custom plugins are merged with the built-in plugins (both are loaded).
+                If None (default), only the built-in plugins directory is used (which is empty by default).
+                See resources/plugins/example-plugin.mjs.sample for plugin format.
+        """
+        self.speclynx_path = speclynx_path
+        self.timeout = timeout
+        self.allowed_base_dir = allowed_base_dir
+        self.plugins_dir = Path(plugins_dir) if plugins_dir else None
+
+    @staticmethod
+    def accepts() -> Sequence[Literal["uri", "dict"]]:
+        """Return the document formats this validator can accept.
+
+        Returns:
+            Sequence of supported document format identifiers:
+            - "uri": File path or URI pointing to OpenAPI Document
+            - "dict": Python dictionary containing OpenAPI Document data
+        """
+        return ["uri", "dict"]
+
+    def validate(
+        self, document: str | dict, *, base_url: str | None = None, target: str | None = None
+    ) -> ValidationResult:
+        """
+        Validate an OpenAPI document using SpecLynx ApiDOM.
+
+        Args:
+            document: Path to the OpenAPI document file to validate, or dict containing the document
+            base_url: Optional base URL for resolving relative references
+            target: Optional target identifier for validation context
+
+        Returns:
+            ValidationResult containing any validation issues found
+
+        Raises:
+            RuntimeError: If validation execution fails
+            SubprocessExecutionError: If validation execution times out or fails to start
+            TypeError: If a document type is not supported
+            PathTraversalError: Document path attempts to escape allowed_base_dir (only when allowed_base_dir is set)
+            InvalidExtensionError: Document path has disallowed file extension (always checked for filesystem paths)
+        """
+        if isinstance(document, str):
+            return self._validate_uri(document, base_url=base_url, target=target)
+        elif isinstance(document, dict):
+            return self._validate_dict(document, base_url=base_url, target=target)
+        else:
+            raise TypeError(f"Unsupported document type: {type(document)!r}")
+
+    def _validate_uri(
+        self, document: str, *, base_url: str | None = None, target: str | None = None
+    ) -> ValidationResult:
+        """
+        Validate an OpenAPI document using SpecLynx ApiDOM.
+
+        Args:
+            document: Path to the OpenAPI document file to validate
+            base_url: Optional base URL for resolving relative references
+            target: Optional target identifier for validation context
+
+        Returns:
+            ValidationResult containing any validation issues found
+        """
+        result: SubprocessExecutionResult | None = None
+
+        try:
+            doc_path = file_uri_to_path(document) if is_file_uri(document) else document
+
+            # Validate document path if it's a filesystem path (skip non-path URIs like HTTP(S))
+            validated_doc_path = (
+                validate_path(
+                    doc_path,
+                    allowed_base=self.allowed_base_dir,
+                    allowed_extensions=(".yaml", ".yml", ".json"),
+                )
+                if is_path(doc_path)
+                else doc_path
+            )
+
+            # Determine output file path
+            with tempfile.NamedTemporaryFile() as tmp_output:
+                output_path = tmp_output.name
+
+            try:
+                cmd = [
+                    *shlex.split(self.speclynx_path),
+                    validated_doc_path,
+                    "-o",
+                    output_path,
+                ]
+                if base_url:
+                    cmd.extend(["--base-uri", base_url])
+                if self.plugins_dir:
+                    cmd.extend(["--plugins", str(self.plugins_dir)])
+                if self.allowed_base_dir:
+                    cmd.extend(["--allowed-base-dir", str(self.allowed_base_dir)])
+
+                # npx with bundled tarball requires cwd set to resources directory
+                if self.speclynx_path == _DEFAULT_SPECLYNX_PATH:
+                    with as_file(tarball_file) as tarball_path:
+                        resources_path = tarball_path.parent
+                        result = run_subprocess(cmd, timeout=self.timeout, cwd=str(resources_path))
+                else:
+                    result = run_subprocess(cmd, timeout=self.timeout)
+
+                if result is None:
+                    raise RuntimeError("SpecLynx validation failed - no result returned")
+
+                # Check for execution errors
+                # Exit code 0 = valid, exit code 1 = has validation errors, other = execution error
+                if result.returncode not in (0, 1):
+                    stderr_msg = result.stderr.strip()
+                    custom_diagnostics = self._handle_error(
+                        stderr_msg, result, validated_doc_path, target
+                    )
+                    if custom_diagnostics is not None:
+                        return custom_diagnostics
+
+                    # Default error handling
+                    msg = stderr_msg or f"SpecLynx exited with code {result.returncode}"
+                    raise RuntimeError(msg)
+
+                # Read and parse output file
+                try:
+                    with open(output_path, encoding="utf-8") as f:
+                        diagnostics_data: list[dict] = json.load(f)
+                except FileNotFoundError:
+                    if result.stderr:
+                        raise RuntimeError(
+                            f"SpecLynx did not create output file: {result.stderr.strip()}"
+                        )
+                    logger.warning("SpecLynx output file not found, returning empty diagnostics")
+                    return ValidationResult(diagnostics=[])
+                except json.JSONDecodeError as e:
+                    if result.stderr:
+                        raise RuntimeError(
+                            f"SpecLynx output is not valid JSON: {result.stderr.strip()}"
+                        )
+                    logger.warning(
+                        f"SpecLynx output is not valid JSON: {e}, returning empty diagnostics"
+                    )
+                    return ValidationResult(diagnostics=[])
+            finally:
+                # Clean up the temp output file
+                Path(output_path).unlink(missing_ok=True)
+
+        except SubprocessExecutionError as e:
+            # only timeout and OS errors, as run_subprocess has a default `fail_on_error = False`
+            raise e
+
+        # Convert diagnostics to JenticDiagnostic format (already LSP compatible)
+        diagnostics: list[JenticDiagnostic] = []
+        for issue in diagnostics_data:
+            range_data = issue["range"]
+            diagnostic = JenticDiagnostic(
+                range=Range(
+                    start=Position(**range_data["start"]),
+                    end=Position(**range_data["end"]),
+                ),
+                message=issue["message"],
+                severity=DiagnosticSeverity(issue["severity"]),
+                code=issue.get("code"),
+                source="speclynx-validator",
+            )
+            diagnostic.set_target(target)
+            if "data" in issue and "path" in issue["data"]:
+                diagnostic.set_path(issue["data"]["path"])
+            diagnostics.append(diagnostic)
+
+        return ValidationResult(diagnostics=diagnostics)
+
+    def _validate_dict(
+        self, document: dict, *, base_url: str | None = None, target: str | None = None
+    ) -> ValidationResult:
+        """Validate a dict document by creating a temporary file and using _validate_uri."""
+        with tempfile.NamedTemporaryFile(
+            mode="w", suffix=".json", delete=True, encoding="utf-8"
+        ) as temp_file:
+            json.dump(document, temp_file)
+            temp_file.flush()  # Ensure content is written to disk
+
+            return self._validate_uri(
+                Path(temp_file.name).as_uri(), base_url=base_url, target=target
+            )
+
+    def _handle_error(
+        self,
+        stderr_msg: str,
+        result: SubprocessExecutionResult,
+        document_path: str,
+        target: str | None = None,
+    ) -> ValidationResult | None:
+        """Handle custom error cases from SpecLynx execution.
+
+        This is an extension point for subclasses to provide custom error handling.
+        By default, returns None to proceed with standard error handling (raising RuntimeError).
+
+        If this method returns a ValidationResult, that result will be returned to the caller.
+        If this method returns None, the default error handling will proceed (raising RuntimeError).
+
+        Args:
+            stderr_msg: The stderr output from SpecLynx
+            result: The subprocess execution result from SpecLynx
+            document_path: The path or URL being validated
+            target: Optional target identifier for validation context
+
+        Returns:
+            ValidationResult if the error was handled, None to proceed with default handling
+
+        Example:
+            Override this method to handle specific errors gracefully:
+
+            def _handle_error(self, stderr_msg, result, document_path, target):
+                # Handle fetch errors (403, 404, etc.) by returning diagnostics
+                if "Could not parse" in stderr_msg and "://" in document_path:
+                    diagnostic = JenticDiagnostic(
+                        range=Range(start=Position(line=0, character=0),
+                                    end=Position(line=0, character=0)),
+                        message=f"Could not fetch document: {document_path}",
+                        severity=DiagnosticSeverity.Error,
+                        code="document-fetch-error",
+                        source="speclynx-validator",
+                    )
+                    diagnostic.set_target(target)
+                    return ValidationResult(diagnostics=[diagnostic])
+
+                # Fall back to default behavior
+                return super()._handle_error(stderr_msg, result, document_path, target)
+        """
+        # Return None to proceed with default error handling (raising RuntimeError)
+        return None