[
{
"path": ".eslintrc.cjs",
"content": "module.exports = {\n root: true,\n env: { browser: true, es2020: true },\n extends: [\n 'standard',\n 'eslint:recommended',\n 'plugin:react/recommended',\n 'plugin:@typescript-eslint/recommended',\n 'plugin:react-hooks/recommended',\n 'prettier',\n ],\n ignorePatterns: ['node_modules', 'dist', 'htmlcov'],\n parser: '@typescript-eslint/parser',\n plugins: ['react', '@typescript-eslint', 'react-refresh', 'simple-import-sort'],\n rules: {\n 'react-refresh/only-export-components': 'off', // how much effect does this have?\n '@typescript-eslint/no-explicit-any': 'off',\n 'no-use-before-define': 'off',\n 'react/react-in-jsx-scope': 'off',\n 'react/prop-types': 'off',\n 'react/display-name': 'off',\n 'import/order': [\n 'error',\n {\n 'newlines-between': 'always',\n groups: ['builtin', 'external', 'internal', 'object', 'type', 'parent', 'index', 'sibling'],\n pathGroups: [\n {\n pattern: '@/**',\n group: 'internal',\n },\n {\n pattern: './../**',\n group: 'parent',\n },\n ],\n },\n ],\n },\n}\n"
},
{
"path": ".github/dependabot.yml",
"content": "# Keep GitHub Actions up to date with GitHub's Dependabot...\n# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot\n# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem\nversion: 2\nupdates:\n - package-ecosystem: github-actions\n directory: /\n groups:\n github-actions:\n patterns:\n - \"*\" # Group all Actions updates into a single larger pull request\n schedule:\n interval: monthly\n"
},
{
"path": ".github/workflows/ci.yml",
"content": "name: CI\n\non:\n push:\n branches:\n - main\n tags:\n - '**'\n pull_request:\n types: [opened, synchronize]\n\njobs:\n lint:\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/checkout@v4\n\n - uses: actions/setup-python@v5\n with:\n python-version: '3.11'\n\n - uses: actions/setup-node@v4\n with:\n node-version: 18\n\n - run: pip install -r src/python-fastui/requirements/all.txt\n - run: pip install src/python-fastui\n\n - run: npm install\n\n - uses: pre-commit/action@v3.0.1\n with:\n extra_args: --all-files\n env:\n SKIP: no-commit-to-branch\n\n docs-build:\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/checkout@v4\n\n - uses: actions/setup-python@v5\n with:\n python-version: '3.11'\n\n # note: PPPR_TOKEN is not available on PRs sourced from forks, but the necessary\n # dependencies are also listed in docs.txt :)\n - name: install\n run: |\n pip install --upgrade pip\n pip install --extra-index-url https://pydantic:${PPPR_TOKEN}@pppr.pydantic.dev/simple/ mkdocs-material mkdocstrings-python\n pip install -r requirements/docs.txt\n # note -- we can use these in the future when mkdocstrings-typescript and griffe-typedoc beocome publicly available\n # pip install --extra-index-url https://pydantic:${PPPR_TOKEN}@pppr.pydantic.dev/simple/ mkdocs-material mkdocstrings-python griffe-typedoc mkdocstrings-typescript\n # npm install\n # npm install -g typedoc\n env:\n PPPR_TOKEN: ${{ secrets.PPPR_TOKEN }}\n\n - name: build site\n run: mkdocs build --strict\n\n test:\n name: test ${{ matrix.python-version }} on ${{ matrix.os }}\n strategy:\n fail-fast: false\n matrix:\n os: [ubuntu-latest, macos-15-intel, macos-latest]\n python-version: ['3.10', '3.11', '3.12', '3.13', '3.14']\n exclude:\n - os: macos-15-intel\n python-version: '3.10'\n - os: macos-15-intel\n python-version: '3.11'\n - os: macos-15-intel\n python-version: '3.12'\n - os: macos-latest\n python-version: '3.13'\n\n runs-on: ${{ matrix.os }}\n\n env:\n PYTHON: ${{ matrix.python-version }}\n OS: ${{ matrix.os }}\n\n steps:\n - uses: actions/checkout@v4\n\n - name: set up python\n uses: actions/setup-python@v5\n with:\n python-version: ${{ matrix.python-version }}\n\n - run: pip install -r src/python-fastui/requirements/test.txt\n - run: pip install -r src/python-fastui/requirements/pyproject.txt\n - run: pip install -e src/python-fastui\n\n - run: coverage run -m pytest src\n # display coverage and fail if it's below 80%, which shouldn't happen\n - run: coverage report --fail-under=80\n\n # test demo on 3.11 and 3.12, these tests are intentionally omitted from coverage\n - if: matrix.python-version == '3.11' || matrix.python-version == '3.12'\n run: pytest demo/tests.py\n\n - run: coverage xml\n\n - uses: codecov/codecov-action@v5\n with:\n file: ./coverage.xml\n env_vars: PYTHON,OS\n\n npm-build:\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/checkout@v4\n\n - uses: actions/setup-node@v4\n with:\n node-version: 18\n\n - run: npm install\n - run: npm run build\n - run: tree src\n\n check: # This job does nothing and is only used for the branch protection\n if: always()\n needs: [lint, test, npm-build]\n runs-on: ubuntu-latest\n\n steps:\n - name: Decide whether the needed jobs succeeded or failed\n uses: re-actors/alls-green@release/v1\n id: all-green\n with:\n jobs: ${{ toJSON(needs) }}\n\n release:\n needs: [check]\n if: \"success() && startsWith(github.ref, 'refs/tags/')\"\n runs-on: ubuntu-latest\n environment: release\n\n permissions:\n id-token: write\n\n steps:\n - uses: actions/checkout@v4\n\n - uses: actions/setup-python@v5\n with:\n python-version: '3.11'\n\n - run: pip install -U build\n\n - id: check-version\n uses: samuelcolvin/check-python-version@v4.1\n with:\n version_file_path: 'src/python-fastui/fastui/__init__.py'\n\n - run: python -m build --outdir dist src/python-fastui\n\n - run: ls -lh dist\n\n - uses: pypa/gh-action-pypi-publish@release/v1\n"
},
{
"path": ".gitignore",
"content": "# Logs\nlogs\n*.log\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\npnpm-debug.log*\nlerna-debug.log*\n/**/*.egg-info\n\nnode_modules\ndist\ndist-ssr\n*.local\n\n# Editor directories and files\n.vscode/*\n!.vscode/extensions.json\n.idea\n.DS_Store\n*.suo\n*.ntvs*\n*.njsproj\n*.sln\n*.sw?\n\n# python\n/env*/\n__pycache__/\n\n/.logfire/\n/frontend-dist/\n/scratch/\n/packages-dist/\n/.coverage\n/users.db\n"
},
{
"path": ".pre-commit-config.yaml",
"content": "repos:\n - repo: https://github.com/pre-commit/pre-commit-hooks\n rev: v5.0.0\n hooks:\n - id: no-commit-to-branch\n - id: check-yaml\n args: ['--unsafe']\n - id: check-toml\n - id: end-of-file-fixer\n - id: trailing-whitespace\n\n - repo: local\n hooks:\n - id: python-format\n name: python-format\n types_or: [python]\n entry: make format\n language: system\n pass_filenames: false\n - id: python-typecheck\n name: python-typecheck\n types_or: [python]\n entry: make typecheck\n language: system\n pass_filenames: false\n - id: js-prettier\n name: js-prettier\n types_or: [javascript, jsx, ts, tsx, css, json, markdown]\n entry: npm run prettier\n language: system\n exclude: '^docs/.*'\n - id: js-lint\n name: js-lint\n types_or: [ts, tsx]\n entry: npm run lint-fix\n language: system\n pass_filenames: false\n - id: js-typecheck\n name: js-typecheck\n types_or: [ts, tsx]\n entry: npm run typecheck\n language: system\n pass_filenames: false\n - id: python-generate-ts\n name: python-generate-ts\n types_or: [python]\n entry: make typescript-models\n language: system\n pass_filenames: false\n"
},
{
"path": ".prettierignore",
"content": "htmlcov/\n"
},
{
"path": "LICENSE",
"content": "The MIT License (MIT)\n\nCopyright (c) 2023 to present Pydantic Services inc.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
},
{
"path": "Makefile",
"content": ".DEFAULT_GOAL:=all\npath = src/python-fastui\n\n.PHONY: install\ninstall:\n\tpip install -U pip pre-commit pip-tools\n\tpip install -r $(path)/requirements/all.txt\n\tpip install -e $(path)\n\tpre-commit install\n\n\n.PHONY: install-docs\ninstall-docs:\n\tpip install -r requirements/docs.txt\n\n# note -- mkdocstrings-typescript and griffe-typedoc are not yet publicly available\n# but the following can be added above the pip install -r requirements/docs.txt line in the future\n# pip install mkdocstrings-python mkdocstrings-typescript griffe-typedoc\n\n.PHONY: update-lockfiles\nupdate-lockfiles:\n\t@echo \"Updating requirements files using pip-compile\"\n\tpip-compile -q --strip-extras -o $(path)/requirements/lint.txt $(path)/requirements/lint.in\n\tpip-compile -q --strip-extras -o $(path)/requirements/pyproject.txt -c $(path)/requirements/lint.txt $(path)/pyproject.toml --extra=fastapi\n\tpip-compile -q --strip-extras -o $(path)/requirements/test.txt -c $(path)/requirements/lint.txt -c $(path)/requirements/pyproject.txt $(path)/requirements/test.in\n\tpip install --dry-run -r $(path)/requirements/all.txt\n\n.PHONY: format\nformat:\n\truff check --fix-only $(path) demo\n\truff format $(path) demo\n\n.PHONY: lint\nlint:\n\truff check $(path) demo\n\truff format --check $(path) demo\n\n.PHONY: typecheck\ntypecheck:\n\tpyright\n\n.PHONY: test\ntest:\n\tcoverage run -m pytest\n\n.PHONY: testcov\ntestcov: test\n\tcoverage html\n\n.PHONY: typescript-models\ntypescript-models:\n\tfastui generate fastui:FastUI src/npm-fastui/src/models.d.ts\n\n.PHONY: dev\ndev:\n\tuvicorn demo:app --reload --reload-dir .\n\n.PHONY: docs\ndocs:\n\tmkdocs build\n\n.PHONY: serve\nserve:\n\tmkdocs serve\n\n.PHONY: all\nall: testcov lint\n"
},
{
"path": "README.md",
"content": "# NOTE: this project is inactive, see [#368](https://github.com/pydantic/FastUI/issues/368)\n\n# FastUI\n\nFind the documentation [here](https://docs.pydantic.dev/fastui/).\nJoin the discussion in the #fastui slack channel [here](https://pydanticlogfire.slack.com/archives/C0720M7D31S)\n\n[](https://github.com/pydantic/FastUI/actions?query=event%3Apush+branch%3Amain+workflow%3ACI)\n[](https://pypi.python.org/pypi/fastui)\n[](https://github.com/pydantic/FastUI)\n[](https://github.com/pydantic/FastUI/blob/main/LICENSE)\n\n**Please note:** FastUI is still an active work in progress, do not expect it to be complete.\n\n## The Principle (short version)\n\nYou can see a simple demo of an application built with FastUI [here](https://fastui-demo.onrender.com).\n\nFastUI is a new way to build web application user interfaces defined by declarative Python code.\n\nThis means:\n\n- **If you're a Python developer** — you can build responsive web applications using React without writing a single line of JavaScript, or touching `npm`.\n- **If you're a frontend developer** — you can concentrate on building magical components that are truly reusable, no copy-pasting components for each view.\n- **For everyone** — a true separation of concerns, the backend defines the entire application; while the frontend is free to implement just the user interface\n\nAt its heart, FastUI is a set of matching [Pydantic](https://docs.pydantic.dev) models and TypeScript interfaces that allow you to define a user interface. This interface is validated at build time by TypeScript and pyright/mypy and at runtime by Pydantic.\n\n## The Practice — Usage\n\nFastUI is made up of 4 things:\n\n- [`fastui` PyPI package](https://pypi.python.org/pypi/fastui) — Pydantic models for UI components, and some utilities. While it works well with [FastAPI](https://fastapi.tiangolo.com) it doesn't depend on FastAPI, and most of it could be used with any python web framework.\n- [`@pydantic/fastui` npm package](https://www.npmjs.com/package/@pydantic/fastui) — a React TypeScript package that lets you reuse the machinery and types of FastUI while implementing your own components\n- [`@pydantic/fastui-bootstrap` npm package](https://www.npmjs.com/package/@pydantic/fastui-bootstrap) — implementation/customisation of all FastUI components using [Bootstrap](https://getbootstrap.com)\n- [`@pydantic/fastui-prebuilt` npm package](https://www.jsdelivr.com/package/npm/@pydantic/fastui-prebuilt) (available on [jsdelivr.com CDN](https://www.jsdelivr.com/package/npm/@pydantic/fastui-prebuilt)) providing a pre-built version of the FastUI React app so you can use it without installing any npm packages or building anything yourself. The Python package provides a simple HTML page to serve this app.\n\nHere's a simple but complete FastAPI application that uses FastUI to show some user profiles:\n\n```python\nfrom datetime import date\n\nfrom fastapi import FastAPI, HTTPException\nfrom fastapi.responses import HTMLResponse\nfrom fastui import FastUI, AnyComponent, prebuilt_html, components as c\nfrom fastui.components.display import DisplayMode, DisplayLookup\nfrom fastui.events import GoToEvent, BackEvent\nfrom pydantic import BaseModel, Field\n\napp = FastAPI()\n\n\nclass User(BaseModel):\n id: int\n name: str\n dob: date = Field(title='Date of Birth')\n\n\n# define some users\nusers = [\n User(id=1, name='John', dob=date(1990, 1, 1)),\n User(id=2, name='Jack', dob=date(1991, 1, 1)),\n User(id=3, name='Jill', dob=date(1992, 1, 1)),\n User(id=4, name='Jane', dob=date(1993, 1, 1)),\n]\n\n\n@app.get(\"/api/\", response_model=FastUI, response_model_exclude_none=True)\ndef users_table() -> list[AnyComponent]:\n \"\"\"\n Show a table of four users, `/api` is the endpoint the frontend will connect to\n when a user visits `/` to fetch components to render.\n \"\"\"\n return [\n c.Page( # Page provides a basic container for components\n components=[\n c.Heading(text='Users', level=2), # renders `
`\n c.Table(\n data=users,\n # define two columns for the table\n columns=[\n # the first is the users, name rendered as a link to their profile\n DisplayLookup(field='name', on_click=GoToEvent(url='/user/{id}/')),\n # the second is the date of birth, rendered as a date\n DisplayLookup(field='dob', mode=DisplayMode.date),\n ],\n ),\n ]\n ),\n ]\n\n\n@app.get(\"/api/user/{user_id}/\", response_model=FastUI, response_model_exclude_none=True)\ndef user_profile(user_id: int) -> list[AnyComponent]:\n \"\"\"\n User profile page, the frontend will fetch this when the user visits `/user/{id}/`.\n \"\"\"\n try:\n user = next(u for u in users if u.id == user_id)\n except StopIteration:\n raise HTTPException(status_code=404, detail=\"User not found\")\n return [\n c.Page(\n components=[\n c.Heading(text=user.name, level=2),\n c.Link(components=[c.Text(text='Back')], on_click=BackEvent()),\n c.Details(data=user),\n ]\n ),\n ]\n\n\n@app.get('/{path:path}')\nasync def html_landing() -> HTMLResponse:\n \"\"\"Simple HTML page which serves the React app, comes last as it matches all paths.\"\"\"\n return HTMLResponse(prebuilt_html(title='FastUI Demo'))\n```\n\nWhich renders like this:\n\n\n\nOf course, that's a very simple application, the [full demo](https://fastui-demo.onrender.com) is more complete.\n\n### The Principle (long version)\n\nFastUI is an implementation of the RESTful principle; but not as it's usually understood, instead I mean the principle defined in the original [PhD dissertation](https://ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm) by Roy Fielding, and excellently summarised in [this essay on htmx.org](https://htmx.org/essays/how-did-rest-come-to-mean-the-opposite-of-rest/) (HTMX people, I'm sorry to use your article to promote React which I know you despise 🙏).\n\nThe RESTful principle as described in the HTMX article is that the frontend doesn't need to (and shouldn't) know anything about the application you're building. Instead, it should just provide all the components you need to construct the interface, the backend can then tell the frontend what to do.\n\nThink of your frontend as a puppet, and the backend as the hand within it — the puppet doesn't need to know what to say, that's kind of the point.\n\nBuilding an application this way has a number of significant advantages:\n\n- You only need to write code in one place to build a new feature — add a new view, change the behavior of an existing view or alter the URL structure\n- Deploying the front and backend can be completely decoupled, provided the frontend knows how to render all the components the backend is going to ask it to use, you're good to go\n- You should be able to reuse a rich set of opensource components, they should end up being better tested and more reliable than anything you could build yourself, this is possible because the components need no context about how they're going to be used (note: since FastUI is brand new, this isn't true yet, hopefully we get there)\n- We can use Pydantic, TypeScript and JSON Schema to provide guarantees that the two sides are communicating with an agreed schema\n\nIn the abstract, FastUI is like the opposite of GraphQL but with the same goal — GraphQL lets frontend developers extend an application without any new backend development; FastUI lets backend developers extend an application without any new frontend development.\n\n#### Beyond Python and React\n\nOf course, this principle shouldn't be limited to Python and React applications — provided we use the same set of agreed schemas and encoding to communicate, we should be able to use any frontend and backend that implements the schema. Interchangeably.\n\nThis could mean:\n\n- Implementing a web frontend using another JS framework like Vue — lots of work, limited value\n- Implementing a web frontend using an edge server, so the browser just sees HTML — lots of work but very valuable\n- Implementing frontends for other platforms like mobile or IOT — lots of work, no idea if it's actually a good idea?\n- Implementing the component models in another language like Rust or Go — since there's actually not that much code in the backend, so this would be a relatively small and mechanical task\n"
},
{
"path": "docs/plugins.py",
"content": "import os\nimport re\n\nfrom typing import Match\n\nfrom mkdocs.config import Config\nfrom mkdocs.structure.files import Files\nfrom mkdocs.structure.pages import Page\n\ntry:\n import pytest\nexcept ImportError:\n pytest = None\n\n\ndef on_pre_build(config: Config):\n pass\n\n\ndef on_files(files: Files, config: Config) -> Files:\n return remove_files(files)\n\n\ndef remove_files(files: Files) -> Files:\n to_remove = []\n for file in files:\n if file.src_path in {'plugins.py'}:\n to_remove.append(file)\n elif file.src_path.startswith('__pycache__/'):\n to_remove.append(file)\n\n for f in to_remove:\n files.remove(f)\n\n return files\n\n\ndef on_page_markdown(markdown: str, page: Page, config: Config, files: Files) -> str:\n markdown = remove_code_fence_attributes(markdown)\n return add_version(markdown, page)\n\n\ndef add_version(markdown: str, page: Page) -> str:\n if page.file.src_uri == 'index.md':\n version_ref = os.getenv('GITHUB_REF')\n if version_ref and version_ref.startswith('refs/tags/'):\n version = re.sub('^refs/tags/', '', version_ref.lower())\n url = f'https://github.com/pydantic/FastUI/releases/tag/{version}'\n version_str = f'Documentation for version: [{version}]({url})'\n elif sha := os.getenv('GITHUB_SHA'):\n sha = sha[:7]\n url = f'https://github.com/pydantic/FastUI/commit/{sha}'\n version_str = f'Documentation for development version: [{sha}]({url})'\n else:\n version_str = 'Documentation for development version'\n markdown = re.sub(r'{{ *version *}}', version_str, markdown)\n return markdown\n\n\ndef remove_code_fence_attributes(markdown: str) -> str:\n \"\"\"\n There's no way to add attributes to code fences that works with both pycharm and mkdocs, hence we use\n `py key=\"value\"` to provide attributes to pytest-examples, then remove those attributes here.\n\n https://youtrack.jetbrains.com/issue/IDEA-297873 & https://python-markdown.github.io/extensions/fenced_code_blocks/\n \"\"\"\n\n def remove_attrs(match: Match[str]) -> str:\n suffix = re.sub(\n r' (?:test|lint|upgrade|group|requires|output|rewrite_assert)=\".+?\"', '', match.group(2), flags=re.M\n )\n return f'{match.group(1)}{suffix}'\n\n return re.sub(r'^( *``` *py)(.*)', remove_attrs, markdown, flags=re.M)\n"
},
{
"path": "mkdocs.yml",
"content": "site_name: FastUI\nsite_description: Build web application user interfaces defined by declarative Python code.\nsite_url: https://docs.pydantic.dev/fastui/\n\ntheme:\n name: 'material'\n palette:\n - media: \"(prefers-color-scheme: light)\"\n scheme: default\n primary: pink\n accent: pink\n toggle:\n icon: material/lightbulb-outline\n name: \"Switch to dark mode\"\n - media: \"(prefers-color-scheme: dark)\"\n scheme: slate\n primary: pink\n accent: pink\n toggle:\n icon: material/lightbulb\n name: \"Switch to light mode\"\n features:\n - content.code.annotate\n - content.tabs.link\n - content.code.copy\n - announce.dismiss\n - navigation.tabs\n - search.suggest\n - search.highlight\n logo: assets/logo-white.svg\n favicon: assets/favicon.png\n\nrepo_name: pydantic/FastUI\nrepo_url: https://github.com/pydantic/FastUI\nedit_uri: ''\n\n# https://www.mkdocs.org/user-guide/configuration/#validation\nvalidation:\n omitted_files: warn\n absolute_links: warn\n unrecognized_links: warn\n\nextra_css:\n - 'extra/tweaks.css'\n\n# TODO: add flarelytics support\n# extra_javascript:\n# - '/flarelytics/client.js'\n\nmarkdown_extensions:\n - toc:\n permalink: true\n - admonition\n - pymdownx.details\n - pymdownx.extra\n - pymdownx.superfences\n - pymdownx.highlight:\n anchor_linenums: true\n - pymdownx.inlinehilite\n - pymdownx.snippets\n - attr_list\n - md_in_html\n - pymdownx.emoji:\n emoji_index: !!python/name:material.extensions.emoji.twemoji\n emoji_generator: !!python/name:material.extensions.emoji.to_svg\nwatch:\n - src\nplugins:\n - search\n - mkdocstrings:\n handlers:\n python:\n paths:\n - src/python-fastui\n options:\n members_order: source\n separate_signature: true\n docstring_options:\n ignore_init_summary: true\n merge_init_into_class: true\n show_signature_annotations: true\n signature_crossrefs: true\n - mkdocs-simple-hooks:\n hooks:\n on_pre_build: 'docs.plugins:on_pre_build'\n on_files: 'docs.plugins:on_files'\n on_page_markdown: 'docs.plugins:on_page_markdown'\nnav:\n - Introduction: index.md\n - Guide: guide.md\n - API Documentation:\n - Python Components: api/python_components.md\n - TypeScript Components: api/typescript_components.md\n"
},
{
"path": "package.json",
"content": "{\n \"name\": \"FastUI\",\n \"private\": true,\n \"type\": \"module\",\n \"workspaces\": [\n \"src/*\"\n ],\n \"scripts\": {\n \"dev\": \"npm run --workspace=@pydantic/fastui-prebuilt dev\",\n \"build\": \"npm run --workspaces prepublishOnly\",\n \"typecheck\": \"npm run --workspaces typecheck\",\n \"lint\": \"eslint src --ext .ts,.tsx --report-unused-disable-directives --max-warnings 0\",\n \"lint-fix\": \"npm run lint -- --fix\",\n \"prettier\": \"prettier --write\",\n \"format\": \"npm run prettier -- . && npm run lint-fix\",\n \"generate-json-schema\": \"./src/python-fastui/tests/react-fastui-json-schema.sh\"\n },\n \"prettier\": {\n \"singleQuote\": true,\n \"semi\": false,\n \"trailingComma\": \"all\",\n \"tabWidth\": 2,\n \"printWidth\": 119,\n \"bracketSpacing\": true\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.9.1\",\n \"@types/react\": \"^18.2.15\",\n \"@types/react-dom\": \"^18.2.7\",\n \"@typescript-eslint/eslint-plugin\": \"^6.0.0\",\n \"@typescript-eslint/parser\": \"^6.0.0\",\n \"eslint\": \"^8.53.0\",\n \"eslint-config-prettier\": \"^9.0.0\",\n \"eslint-config-standard\": \"^17.1.0\",\n \"eslint-plugin-react\": \"^7.33.2\",\n \"eslint-plugin-react-hooks\": \"^4.6.0\",\n \"eslint-plugin-react-refresh\": \"^0.4.4\",\n \"eslint-plugin-simple-import-sort\": \"^10.0.0\",\n \"json-schema-to-typescript\": \"^15.0.4\",\n \"typescript\": \"^5.0.2\"\n },\n \"dependencies\": {\n \"prettier\": \"^3.2.5\",\n \"typedoc\": \"^0.25.13\"\n }\n}\n"
},
{
"path": "pyproject.toml",
"content": "# this is not the used for the python package \"fastui\",\n# for that see packages/python-fastui/pyproject.toml\n\n[tool.ruff]\nline-length = 120\nextend-select = [\"Q\", \"RUF100\", \"UP\", \"I\"]\nflake8-quotes = {inline-quotes = \"single\", multiline-quotes = \"double\"}\nformat.quote-style=\"single\"\ntarget-version = \"py310\"\n\n[tool.pyright]\ninclude = [\"src/python-fastui/fastui\"]\n\n[tool.pytest.ini_options]\ntestpaths = [\n \"src/python-fastui/tests\",\n \"demo/tests.py\",\n]\nxfail_strict = true\nfilterwarnings = [\"error\"]\nasyncio_mode = \"auto\"\n\n[tool.coverage.run]\nsource = [\"src/python-fastui/fastui\"]\nomit = [\n \"src/python-fastui/fastui/__main__.py\",\n \"src/python-fastui/fastui/generate_typescript.py\",\n]\n\n[tool.coverage.report]\nprecision = 2\nexclude_lines = [\n 'pragma: no cover',\n 'raise NotImplementedError',\n 'if TYPE_CHECKING:',\n 'if typing.TYPE_CHECKING:',\n '@overload',\n '@typing.overload',\n '\\(Protocol\\):$',\n]\n"
},
{
"path": "requirements/docs.in",
"content": "mkdocs\nmkdocs-material\nmkdocs-simple-hooks\nmkdocstrings[python]\nmkdocs-redirects\nmkdocs-material-extensions\n"
},
{
"path": "requirements/docs.txt",
"content": "#\n# This file is autogenerated by pip-compile with Python 3.11\n# by the following command:\n#\n# pip-compile --output-file=requirements/docs.txt requirements/docs.in\n#\nbabel==2.14.0\n # via mkdocs-material\ncertifi==2024.2.2\n # via requests\ncharset-normalizer==3.3.2\n # via requests\nclick==8.1.7\n # via\n # mkdocs\n # mkdocstrings\ncolorama==0.4.6\n # via\n # griffe\n # mkdocs-material\nghp-import==2.1.0\n # via mkdocs\ngriffe==0.44.0\n # via mkdocstrings-python\nidna==3.7\n # via requests\njinja2==3.1.3\n # via\n # mkdocs\n # mkdocs-material\n # mkdocstrings\nmarkdown==3.6\n # via\n # mkdocs\n # mkdocs-autorefs\n # mkdocs-material\n # mkdocstrings\n # pymdown-extensions\nmarkupsafe==2.1.5\n # via\n # jinja2\n # mkdocs\n # mkdocs-autorefs\n # mkdocstrings\nmergedeep==1.3.4\n # via mkdocs\nmkdocs==1.5.3\n # via\n # -r requirements/docs.in\n # mkdocs-autorefs\n # mkdocs-material\n # mkdocs-redirects\n # mkdocs-simple-hooks\n # mkdocstrings\nmkdocs-autorefs==1.0.1\n # via mkdocstrings\nmkdocs-material==9.5.18\n # via -r requirements/docs.in\nmkdocs-material-extensions==1.3.1\n # via\n # -r requirements/docs.in\n # mkdocs-material\nmkdocs-redirects==1.2.1\n # via -r requirements/docs.in\nmkdocs-simple-hooks==0.1.5\n # via -r requirements/docs.in\nmkdocstrings[python]==0.24.3\n # via\n # -r requirements/docs.in\n # mkdocstrings-python\nmkdocstrings-python==1.10.0\n # via mkdocstrings\npackaging==24.0\n # via mkdocs\npaginate==0.5.6\n # via mkdocs-material\npathspec==0.12.1\n # via mkdocs\nplatformdirs==4.2.0\n # via\n # mkdocs\n # mkdocstrings\npygments==2.17.2\n # via mkdocs-material\npymdown-extensions==10.8\n # via\n # mkdocs-material\n # mkdocstrings\npython-dateutil==2.9.0.post0\n # via ghp-import\npyyaml==6.0.1\n # via\n # mkdocs\n # pymdown-extensions\n # pyyaml-env-tag\npyyaml-env-tag==0.1\n # via mkdocs\nregex==2024.4.16\n # via mkdocs-material\nrequests==2.31.0\n # via mkdocs-material\nsix==1.16.0\n # via python-dateutil\nurllib3==2.2.1\n # via requests\nwatchdog==4.0.0\n # via mkdocs\n"
},
{
"path": "src/npm-fastui/LICENSE",
"content": "The MIT License (MIT)\n\nCopyright (c) 2023 to present Pydantic Services inc.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
},
{
"path": "src/npm-fastui/README.md",
"content": "# FastUI\n\nReact frontend for [FastUI](https://github.com/pydantic/FastUI).\n"
},
{
"path": "src/npm-fastui/package.json",
"content": "{\n \"name\": \"@pydantic/fastui\",\n \"version\": \"0.0.26\",\n \"description\": \"Build better UIs faster.\",\n \"main\": \"dist/index.js\",\n \"types\": \"dist/index.d.ts\",\n \"author\": \"Samuel Colvin\",\n \"license\": \"MIT\",\n \"homepage\": \"https://github.com/pydantic/fastui\",\n \"private\": false,\n \"keywords\": [\n \"fastui\",\n \"jsx\",\n \"typescript\",\n \"react\",\n \"fastapi\"\n ],\n \"scripts\": {\n \"prepublishOnly\": \"rm -rf dist && tsc\",\n \"typecheck\": \"tsc --noEmit\",\n \"typewatch\": \"tsc --noEmit --watch\"\n },\n \"dependencies\": {\n \"@microsoft/fetch-event-source\": \"^2.0.1\",\n \"react\": \"^18.2.0\",\n \"react-dom\": \"^18.2.0\",\n \"react-markdown\": \"^9.0.1\",\n \"react-select\": \"^5.8.0\",\n \"react-syntax-highlighter\": \"^15.5.0\",\n \"remark-gfm\": \"^4.0.0\"\n },\n \"devDependencies\": {\n \"@types/react-syntax-highlighter\": \"^15.5.10\"\n }\n}\n"
},
{
"path": "src/npm-fastui/src/Defaults.tsx",
"content": "import { FC, ReactNode } from 'react'\n\nexport const DefaultNotFound: FC<{ url: string }> = ({ url }) =>
Page not found: {url}
\n\n// default here does nothing\nexport const DefaultTransition: FC<{ children: ReactNode; transitioning: boolean }> = ({ children }) => (\n
{children}
\n)\n"
},
{
"path": "src/npm-fastui/src/components/Code.tsx",
"content": "import { lazy } from 'react'\n\nexport const CodeComp = lazy(() => import('./CodeLazy'))\n"
},
{
"path": "src/npm-fastui/src/components/CodeLazy.tsx",
"content": "import * as codeStyles from 'react-syntax-highlighter/dist/esm/styles/prism'\nimport { Prism as SyntaxHighlighter } from 'react-syntax-highlighter'\n\nimport type { Code } from '../models'\n\nimport { useClassName } from '../hooks/className'\n\nexport default function (props: Code) {\n const { text, language, codeStyle } = props\n const codeLookup = codeStyle as keyof typeof codeStyles\n const style = (codeStyle && codeStyles[codeLookup]) || codeStyles.coldarkCold\n return (\n \n {text}\n \n )\n}\n"
},
{
"path": "src/npm-fastui/src/components/Custom.tsx",
"content": "import { FC } from 'react'\n\nimport type { Custom } from '../models'\n\nimport { DisplayError } from '../hooks/error'\n\nimport { JsonComp } from './Json'\n\nexport const CustomComp: FC = (props) => {\n const { data, subType, library } = props\n\n const description = [`The custom component \"${subType}\"`]\n if (library) {\n description.push(`from library \"${library}\"`)\n }\n description.push(`has no implementation with this frontend app.`)\n\n return (\n \n Custom component data:\n \n \n )\n}\n"
},
{
"path": "src/npm-fastui/src/components/FireEvent.tsx",
"content": "import { FC, useEffect } from 'react'\n\nimport type { FireEvent } from '../models'\n\nimport { useFireEvent } from '../events'\n\nexport const FireEventComp: FC = ({ event, message }) => {\n const { fireEvent } = useFireEvent()\n\n useEffect(() => {\n // debounce the event so changes to fireEvent (from location changes) don't trigger the event many times\n const clear = setTimeout(() => fireEvent(event), 50)\n return () => clearTimeout(clear)\n }, [fireEvent, event])\n\n return <>{message}\n}\n"
},
{
"path": "src/npm-fastui/src/components/FormField.tsx",
"content": "import { FC, useState } from 'react'\nimport AsyncSelect from 'react-select/async'\nimport Select, { StylesConfig } from 'react-select'\n\nimport type {\n FormFieldInput,\n FormFieldTextarea,\n FormFieldBoolean,\n FormFieldFile,\n FormFieldSelect,\n FormFieldSelectSearch,\n SelectOption,\n SelectOptions,\n SelectGroup,\n} from '../models'\n\nimport { useClassName } from '../hooks/className'\nimport { debounce, useRequest } from '../tools'\n\ntype PrivateOnChange = () => void\n\ninterface FormFieldInputProps extends FormFieldInput {\n onChange?: PrivateOnChange\n}\n\nexport const FormFieldInputComp: FC = (props) => {\n const { name, placeholder, required, htmlType, locked, autocomplete, onChange } = props\n\n return (\n