jsonschema-ts 0.1.0__tar.gz

jsonschema_ts-0.1.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

jsonschema_ts-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,72 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install ruff
+
+      - name: Lint with ruff
+        run: ruff check src/ tests/
+
+  test:
+    needs: lint
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run unit tests
+        run: pytest -v --cov=jsonschema_ts --cov-report=term-missing -m "not integration"
+
+  integration:
+    needs: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run integration tests
+        run: pytest -v -m integration

jsonschema_ts-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build tools
+        run: |
+          pip install --upgrade pip
+          pip install hatchling build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

jsonschema_ts-0.1.0/.gitignore

@@ -0,0 +1,26 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.venv/
+.venv*/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Specs design docs
+specs/
+
+# Docs site (Next.js)
+docs/node_modules/
+docs/.next/
+docs/out/
+docs/.source/

jsonschema_ts-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,84 @@
+# Contributing
+
+## Development Setup
+
+```bash
+# Clone
+git clone https://github.com/pyrpc/jsonschema-ts
+cd jsonschema-ts
+
+# Create virtualenv
+python -m venv .venv
+source .venv/bin/activate  # or .venv\Scripts\Activate.ps1 on Windows
+
+# Install dev dependencies
+pip install -e ".[dev]"
+
+# Install pre-commit hooks
+pre-commit install
+
+# Install docs site dependencies
+cd docs && npm install
+```
+
+## Running Tests
+
+```bash
+# All tests
+pytest -v
+
+# Unit tests only (no Node.js needed)
+pytest -v -m "not integration"
+
+# Integration tests (requires Node.js >= 18)
+pytest -v -m integration
+
+# Coverage report
+pytest --cov=jsonschema_ts --cov-report=term-missing
+```
+
+## Code Style
+
+- Ruff with line length 88
+- Type hints on all public functions (3.11+ syntax)
+- Private/internal functions prefixed with `_`
+- Docstrings on all public API functions
+- No em-dashes (--) in prose; use standard punctuation
+- No emoji in code, comments, or documentation
+
+Run linting:
+```bash
+ruff check .
+ruff format --check .
+```
+
+## Pull Request Process
+
+1. Create a feature branch from `main`
+2. Write tests for any new functionality
+3. Ensure all tests pass
+4. Run `ruff check .` — no warnings
+5. Open a PR with a clear description
+
+## Release Process
+
+1. Update version in `pyproject.toml` and `__init__.py`
+2. Create a Git tag: `git tag v<version>`
+3. Push tag: `git push origin v<version>`
+4. CI publishes to PyPI automatically
+
+## Project Structure
+
+```
+src/jsonschema_ts/        # Source code
+  __init__.py             # Public API exports
+  _converter.py           # convert(), convert_all(), _to_npx()
+  _defs_collector.py      # collect_defs()
+  _emitter.py             # assemble(), _strip_root_interface()
+  _errors.py              # Exception classes
+  _options.py             # Options dataclass
+  _utils.py               # Utilities
+tests/                    # Tests (mirrors src structure)
+  fixtures/               # JSON Schema fixtures
+docs/                     # Next.js/Fumadocs documentation site
+```

jsonschema_ts-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 pyRPC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

jsonschema_ts-0.1.0/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: jsonschema-ts
+Version: 0.1.0
+Summary: Convert JSON Schema to TypeScript interfaces (wraps json-schema-to-typescript)
+Project-URL: Homepage, https://github.com/pyrpc/jsonschema-ts
+Project-URL: Repository, https://github.com/pyrpc/jsonschema-ts
+Project-URL: Documentation, https://github.com/pyrpc/jsonschema-ts
+Author: pyRPC Contributors
+License: MIT
+License-File: LICENSE
+Keywords: codegen,json-schema,pydantic,typescript
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.11
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.5.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# jsonschema-ts
+
+> **Python to TypeScript converter, powered by json-schema-to-typescript**
+
+Convert JSON Schema (from Pydantic v2 or any source) into clean TypeScript interfaces. A thin Python wrapper around the battle-tested [`json-schema-to-typescript`](https://github.com/bcherny/json-schema-to-typescript) engine.
+
+```python
+from jsonschema_ts import convert
+
+schema = {
+    "type": "object",
+    "properties": {
+        "id": {"type": "integer"},
+        "name": {"type": "string"},
+        "email": {"type": "string", "format": "email"},
+    },
+    "required": ["id", "name", "email"],
+}
+
+ts = convert(schema, "User")
+# export interface User {
+#   id: number;
+#   name: string;
+#   email: string;
+# }
+```
+
+## Features
+
+- **Zero Python dependencies** — pure Python stdlib
+- **Battle-tested engine** — wraps `json-schema-to-typescript`
+- **Full JSON Schema support** — `$ref`, `$defs`, `allOf`, `anyOf`, `oneOf`, enums, tuples, circular refs, additional properties, const, and more
+- **Pydantic v2 compatible** — works directly with `model_json_schema()` output
+- **Batch conversion** — single npx call for all `$defs`
+- **Clean output** — Prettier-formatted, `export interface` declarations
+
+## Requirements
+
+- Python ≥ 3.11
+- Node.js ≥ 18 (with npx) — for the TypeScript generation engine
+
+## Installation
+
+```bash
+pip install jsonschema-ts
+```
+
+The first call to `convert()` will prompt `npx` to cache `json-schema-to-typescript`.
+
+## Usage
+
+```python
+from jsonschema_ts import convert, convert_all, collect_defs
+
+# Single schema
+ts = convert(schema, "MyType")
+
+# With $defs (for Pydantic models)
+defs = collect_defs(schema)
+model_ts = convert_all(defs)
+
+# Full Pydantic pipeline
+from pydantic import BaseModel
+
+class Address(BaseModel):
+    street: str
+    city: str
+    zip: str
+
+class User(BaseModel):
+    name: str
+    address: Address
+
+schema = User.model_json_schema()
+defs = collect_defs(schema)
+models = convert_all(defs)
+main = convert(schema, "User")
+```
+
+## API
+
+| Function | Description |
+|---|---|
+| `convert(schema, name)` | Convert single JSON Schema → TypeScript interface |
+| `convert_all(defs)` | Convert all `$defs` → TypeScript interfaces (batch) |
+| `collect_defs(*schemas)` | Extract and merge `$defs` from schemas |
+| `ensure_npx()` | Check Node.js/npx availability |
+
+## Why a wrapper?
+
+`json-schema-to-typescript` has an **8-stage pipeline** (resolver → linker → normalizer → parser → optimizer → generator → formatter) with 18 normalization rules handling hundreds of edge cases. Reimplementing this in Python would take months. This package delegates the heavy lifting and focuses on what Python does best: orchestration, `$defs` collection, and output assembly.
+
+## License
+
+MIT

jsonschema_ts-0.1.0/README.md

@@ -0,0 +1,95 @@
+# jsonschema-ts
+
+> **Python to TypeScript converter, powered by json-schema-to-typescript**
+
+Convert JSON Schema (from Pydantic v2 or any source) into clean TypeScript interfaces. A thin Python wrapper around the battle-tested [`json-schema-to-typescript`](https://github.com/bcherny/json-schema-to-typescript) engine.
+
+```python
+from jsonschema_ts import convert
+
+schema = {
+    "type": "object",
+    "properties": {
+        "id": {"type": "integer"},
+        "name": {"type": "string"},
+        "email": {"type": "string", "format": "email"},
+    },
+    "required": ["id", "name", "email"],
+}
+
+ts = convert(schema, "User")
+# export interface User {
+#   id: number;
+#   name: string;
+#   email: string;
+# }
+```
+
+## Features
+
+- **Zero Python dependencies** — pure Python stdlib
+- **Battle-tested engine** — wraps `json-schema-to-typescript`
+- **Full JSON Schema support** — `$ref`, `$defs`, `allOf`, `anyOf`, `oneOf`, enums, tuples, circular refs, additional properties, const, and more
+- **Pydantic v2 compatible** — works directly with `model_json_schema()` output
+- **Batch conversion** — single npx call for all `$defs`
+- **Clean output** — Prettier-formatted, `export interface` declarations
+
+## Requirements
+
+- Python ≥ 3.11
+- Node.js ≥ 18 (with npx) — for the TypeScript generation engine
+
+## Installation
+
+```bash
+pip install jsonschema-ts
+```
+
+The first call to `convert()` will prompt `npx` to cache `json-schema-to-typescript`.
+
+## Usage
+
+```python
+from jsonschema_ts import convert, convert_all, collect_defs
+
+# Single schema
+ts = convert(schema, "MyType")
+
+# With $defs (for Pydantic models)
+defs = collect_defs(schema)
+model_ts = convert_all(defs)
+
+# Full Pydantic pipeline
+from pydantic import BaseModel
+
+class Address(BaseModel):
+    street: str
+    city: str
+    zip: str
+
+class User(BaseModel):
+    name: str
+    address: Address
+
+schema = User.model_json_schema()
+defs = collect_defs(schema)
+models = convert_all(defs)
+main = convert(schema, "User")
+```
+
+## API
+
+| Function | Description |
+|---|---|
+| `convert(schema, name)` | Convert single JSON Schema → TypeScript interface |
+| `convert_all(defs)` | Convert all `$defs` → TypeScript interfaces (batch) |
+| `collect_defs(*schemas)` | Extract and merge `$defs` from schemas |
+| `ensure_npx()` | Check Node.js/npx availability |
+
+## Why a wrapper?
+
+`json-schema-to-typescript` has an **8-stage pipeline** (resolver → linker → normalizer → parser → optimizer → generator → formatter) with 18 normalization rules handling hundreds of edge cases. Reimplementing this in Python would take months. This package delegates the heavy lifting and focuses on what Python does best: orchestration, `$defs` collection, and output assembly.
+
+## License
+
+MIT

jsonschema_ts-0.1.0/docs/app/docs/[[...slug]]/page.tsx

@@ -0,0 +1,50 @@
+import { source } from '@/lib/source';
+import {
+  DocsPage,
+  DocsBody,
+  DocsDescription,
+  DocsTitle,
+} from 'fumadocs-ui/layouts/docs/page';
+import { notFound } from 'next/navigation';
+import defaultMdxComponents from 'fumadocs-ui/mdx';
+
+export default async function Page(props: {
+  params: Promise<{ slug?: string[] }>;
+}) {
+  const params = await props.params;
+  const page = source.getPage(params.slug);
+
+  if (!page) {
+    notFound();
+  }
+
+  const MDX = page.data.body;
+
+  return (
+    <DocsPage toc={page.data.toc} full={page.data.full}>
+      <DocsTitle>{page.data.title}</DocsTitle>
+      <DocsDescription>{page.data.description}</DocsDescription>
+      <DocsBody>
+        <MDX components={{ ...defaultMdxComponents }} />
+      </DocsBody>
+    </DocsPage>
+  );
+}
+
+export async function generateStaticParams() {
+  return source.generateParams();
+}
+
+export async function generateMetadata(props: {
+  params: Promise<{ slug?: string[] }>;
+}) {
+  const params = await props.params;
+  const page = source.getPage(params.slug);
+
+  if (!page) return {};
+
+  return {
+    title: page.data.title,
+    description: page.data.description,
+  };
+}

jsonschema_ts-0.1.0/docs/app/docs/layout.tsx

@@ -0,0 +1,14 @@
+import { source } from '@/lib/source';
+import { DocsLayout } from 'fumadocs-ui/layouts/docs';
+import type { ReactNode } from 'react';
+
+export default function Layout({ children }: { children: ReactNode }) {
+  return (
+    <DocsLayout
+      nav={{ title: 'jsonschema-ts' }}
+      tree={source.pageTree}
+    >
+      {children}
+    </DocsLayout>
+  );
+}

jsonschema_ts-0.1.0/docs/app/global.css

@@ -0,0 +1,25 @@
+@import 'tailwindcss';
+@import 'fumadocs-ui/css/neutral.css';
+@import 'fumadocs-ui/css/preset.css';
+
+/* Remove the left gutter column so the sidebar sits flush at the viewport edge.
+   The 4-column grid places sidebar first, then main content, TOC, and right gutter. */
+#nd-docs-layout {
+  grid-template:
+    "sidebar header toc toc"
+    "sidebar toc-popover toc toc"
+    "sidebar main toc toc" 1fr
+    / var(--fd-sidebar-col) minmax(0, calc(
+          var(--fd-layout-width, 97rem) - var(--fd-sidebar-width) -
+          var(--fd-toc-width)
+        )) var(--fd-toc-width) minmax(min-content, 1fr) !important;
+}
+
+/* When collapsed, keep the hover-trigger zone at the left viewport edge */
+#nd-docs-layout[data-sidebar-collapsed="true"] [data-sidebar-placeholder] > div:first-child {
+  position: fixed !important;
+  inset: 0 auto auto 0 !important;
+  width: 16px !important;
+  height: 100dvh !important;
+  z-index: 50 !important;
+}

jsonschema_ts-0.1.0/docs/app/layout.tsx

@@ -0,0 +1,18 @@
+import type { ReactNode } from 'react';
+import { RootProvider } from 'fumadocs-ui/provider/next';
+import { Inter } from 'next/font/google';
+import './global.css';
+
+const inter = Inter({
+  subsets: ['latin'],
+});
+
+export default function Layout({ children }: { children: ReactNode }) {
+  return (
+    <html lang="en" className={inter.className} suppressHydrationWarning>
+      <body suppressHydrationWarning>
+        <RootProvider>{children}</RootProvider>
+      </body>
+    </html>
+  );
+}

jsonschema_ts-0.1.0/docs/app/page.tsx

@@ -0,0 +1,65 @@
+import Link from 'next/link';
+
+export default function HomePage() {
+  return (
+    <main className="flex min-h-screen flex-col items-center justify-center bg-gradient-to-b from-neutral-950 to-neutral-900 px-4">
+      <div className="text-center">
+        <div className="mb-6 text-5xl font-light tracking-tighter text-neutral-500">
+          {'{ }'}
+        </div>
+        <h1 className="mb-3 text-4xl font-light text-neutral-100 sm:text-5xl">
+          jsonschema-ts
+        </h1>
+        <p className="mb-1 text-lg text-neutral-400">
+          Convert JSON Schema → TypeScript interfaces
+        </p>
+        <p className="mb-8 text-sm text-neutral-600">
+          Python · Zero deps · Battle-tested
+        </p>
+
+        <div className="mb-10 flex items-center justify-center gap-4">
+          <Link
+            href="/docs"
+            className="rounded-lg border border-neutral-700 px-5 py-2.5 text-sm text-neutral-300 transition-colors hover:border-neutral-500 hover:text-white"
+          >
+            Docs
+          </Link>
+          <a
+            href="https://github.com/pyrpc/jsonschema-ts"
+            target="_blank"
+            rel="noreferrer"
+            className="rounded-lg border border-neutral-700 px-5 py-2.5 text-sm text-neutral-300 transition-colors hover:border-neutral-500 hover:text-white"
+          >
+            GitHub
+          </a>
+        </div>
+
+        <pre className="mx-auto mb-8 max-w-lg overflow-x-auto rounded-lg border border-neutral-800 bg-neutral-950/60 p-4 text-left text-sm leading-relaxed text-neutral-300">
+          <code>
+            <span className="text-blue-400">from</span>{' '}
+            <span className="text-amber-300">jsonschema_ts</span>{' '}
+            <span className="text-blue-400">import</span> convert{'\n\n'}
+            ts = convert(schema, <span className="text-green-300">'User'</span>)
+            {'\n'}
+            <span className="text-neutral-600">
+              {'# '}export interface User {'{'}
+            </span>
+            {'\n'}
+            <span className="text-neutral-600">
+              {'# '}  name: string;
+            </span>
+            {'\n'}
+            <span className="text-neutral-600">
+              {'# '}
+              {'}'}
+            </span>
+          </code>
+        </pre>
+
+        <code className="rounded-md bg-neutral-900 px-3 py-1.5 text-sm text-neutral-500">
+          pip install jsonschema-ts
+        </code>
+      </div>
+    </main>
+  );
+}