From 08421bd6afc4c4d34d45a77a5f4c4650947c3b5e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 9 Jul 2026 17:37:17 +0000 Subject: [PATCH] Deployed 0426e62 to latest with MkDocs 1.6.1 and mike 2.1.3 --- .nojekyll | 0 latest/404.html | 1 + latest/COMPARISON/index.html | 29 + latest/MCP_TOOLS_REFERENCE/index.html | 409 + latest/USER_GUIDE/index.html | 97 + latest/api/bridge/index.html | 13278 ++++++++++++++++ latest/api/config/index.html | 193 + latest/api/server/index.html | 721 + latest/assets/_mkdocstrings.css | 237 + latest/assets/images/favicon.png | Bin 0 -> 1870 bytes .../assets/javascripts/bundle.79ae519e.min.js | 16 + .../javascripts/bundle.79ae519e.min.js.map | 7 + latest/assets/javascripts/glightbox.min.js | 1 + .../javascripts/lunr/min/lunr.ar.min.js | 1 + .../javascripts/lunr/min/lunr.da.min.js | 18 + .../javascripts/lunr/min/lunr.de.min.js | 18 + .../javascripts/lunr/min/lunr.du.min.js | 18 + .../javascripts/lunr/min/lunr.el.min.js | 1 + .../javascripts/lunr/min/lunr.es.min.js | 18 + .../javascripts/lunr/min/lunr.fi.min.js | 18 + .../javascripts/lunr/min/lunr.fr.min.js | 18 + .../javascripts/lunr/min/lunr.he.min.js | 1 + .../javascripts/lunr/min/lunr.hi.min.js | 1 + .../javascripts/lunr/min/lunr.hu.min.js | 18 + .../javascripts/lunr/min/lunr.hy.min.js | 1 + .../javascripts/lunr/min/lunr.it.min.js | 18 + .../javascripts/lunr/min/lunr.ja.min.js | 1 + .../javascripts/lunr/min/lunr.jp.min.js | 1 + .../javascripts/lunr/min/lunr.kn.min.js | 1 + .../javascripts/lunr/min/lunr.ko.min.js | 1 + .../javascripts/lunr/min/lunr.multi.min.js | 1 + .../javascripts/lunr/min/lunr.nl.min.js | 18 + .../javascripts/lunr/min/lunr.no.min.js | 18 + .../javascripts/lunr/min/lunr.pt.min.js | 18 + .../javascripts/lunr/min/lunr.ro.min.js | 18 + .../javascripts/lunr/min/lunr.ru.min.js | 18 + .../javascripts/lunr/min/lunr.sa.min.js | 1 + .../lunr/min/lunr.stemmer.support.min.js | 1 + .../javascripts/lunr/min/lunr.sv.min.js | 18 + .../javascripts/lunr/min/lunr.ta.min.js | 1 + .../javascripts/lunr/min/lunr.te.min.js | 1 + .../javascripts/lunr/min/lunr.th.min.js | 1 + .../javascripts/lunr/min/lunr.tr.min.js | 18 + .../javascripts/lunr/min/lunr.vi.min.js | 1 + .../javascripts/lunr/min/lunr.zh.min.js | 1 + latest/assets/javascripts/lunr/tinyseg.js | 206 + latest/assets/javascripts/lunr/wordcut.js | 6708 ++++++++ .../workers/search.2c215733.min.js | 42 + .../workers/search.2c215733.min.js.map | 7 + latest/assets/stylesheets/glightbox.min.css | 1 + .../assets/stylesheets/main.484c7ddc.min.css | 1 + .../stylesheets/main.484c7ddc.min.css.map | 1 + .../stylesheets/palette.ab4e12ef.min.css | 1 + .../stylesheets/palette.ab4e12ef.min.css.map | 1 + latest/css/timeago.css | 15 + .../architecture-detailed/index.html | 1198 ++ latest/development/architecture/index.html | 154 + latest/development/contributing/index.html | 87 + latest/development/mkdocs-guide/index.html | 174 + latest/development/releasing/index.html | 160 + .../getting-started/configuration/index.html | 63 + .../getting-started/installation/index.html | 40 + latest/getting-started/quickstart/index.html | 36 + latest/guide/connection-modes/index.html | 39 + latest/guide/macros/index.html | 41 + latest/guide/resources/index.html | 140 + latest/guide/tools/index.html | 19 + latest/guide/workbench/index.html | 69 + latest/index.html | 23 + latest/js/timeago.min.js | 2 + latest/js/timeago_mkdocs_material.js | 33 + latest/objects.inv | Bin 0 -> 1222 bytes latest/search/search_index.json | 1 + latest/sitemap.xml | 83 + latest/sitemap.xml.gz | Bin 0 -> 425 bytes latest/variables.yaml | 28 + versions.json | 7 + 77 files changed, 24656 insertions(+) create mode 100644 .nojekyll create mode 100644 latest/404.html create mode 100644 latest/COMPARISON/index.html create mode 100644 latest/MCP_TOOLS_REFERENCE/index.html create mode 100644 latest/USER_GUIDE/index.html create mode 100644 latest/api/bridge/index.html create mode 100644 latest/api/config/index.html create mode 100644 latest/api/server/index.html create mode 100644 latest/assets/_mkdocstrings.css create mode 100644 latest/assets/images/favicon.png create mode 100644 latest/assets/javascripts/bundle.79ae519e.min.js create mode 100644 latest/assets/javascripts/bundle.79ae519e.min.js.map create mode 100644 latest/assets/javascripts/glightbox.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.ar.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.da.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.de.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.du.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.el.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.es.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.fi.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.fr.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.he.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.hi.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.hu.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.hy.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.it.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.ja.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.jp.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.kn.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.ko.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.multi.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.nl.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.no.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.pt.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.ro.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.ru.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.sa.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.stemmer.support.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.sv.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.ta.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.te.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.th.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.tr.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.vi.min.js create mode 100644 latest/assets/javascripts/lunr/min/lunr.zh.min.js create mode 100644 latest/assets/javascripts/lunr/tinyseg.js create mode 100644 latest/assets/javascripts/lunr/wordcut.js create mode 100644 latest/assets/javascripts/workers/search.2c215733.min.js create mode 100644 latest/assets/javascripts/workers/search.2c215733.min.js.map create mode 100644 latest/assets/stylesheets/glightbox.min.css create mode 100644 latest/assets/stylesheets/main.484c7ddc.min.css create mode 100644 latest/assets/stylesheets/main.484c7ddc.min.css.map create mode 100644 latest/assets/stylesheets/palette.ab4e12ef.min.css create mode 100644 latest/assets/stylesheets/palette.ab4e12ef.min.css.map create mode 100644 latest/css/timeago.css create mode 100644 latest/development/architecture-detailed/index.html create mode 100644 latest/development/architecture/index.html create mode 100644 latest/development/contributing/index.html create mode 100644 latest/development/mkdocs-guide/index.html create mode 100644 latest/development/releasing/index.html create mode 100644 latest/getting-started/configuration/index.html create mode 100644 latest/getting-started/installation/index.html create mode 100644 latest/getting-started/quickstart/index.html create mode 100644 latest/guide/connection-modes/index.html create mode 100644 latest/guide/macros/index.html create mode 100644 latest/guide/resources/index.html create mode 100644 latest/guide/tools/index.html create mode 100644 latest/guide/workbench/index.html create mode 100644 latest/index.html create mode 100644 latest/js/timeago.min.js create mode 100644 latest/js/timeago_mkdocs_material.js create mode 100644 latest/objects.inv create mode 100644 latest/search/search_index.json create mode 100644 latest/sitemap.xml create mode 100644 latest/sitemap.xml.gz create mode 100644 latest/variables.yaml create mode 100644 versions.json diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/latest/404.html b/latest/404.html new file mode 100644 index 0000000..233f9a1 --- /dev/null +++ b/latest/404.html @@ -0,0 +1 @@ + FreeCAD Robust MCP Suite

404 - Not found

\ No newline at end of file diff --git a/latest/COMPARISON/index.html b/latest/COMPARISON/index.html new file mode 100644 index 0000000..2f152be --- /dev/null +++ b/latest/COMPARISON/index.html @@ -0,0 +1,29 @@ +Other Implementations - FreeCAD Robust MCP Suite
Skip to content

FreeCAD Robust MCP Server Comparison Analysis

This document analyzes existing FreeCAD Robust MCP server implementations to identify best practices and improvements for our architecture.

Existing Implementations

1. neka-nat/freecad-mcp (380+ stars)

Architecture:

  • XML-RPC server running inside FreeCAD (port 9875)
  • Queue-based GUI communication for thread safety
  • FastMCP-based MCP server connecting via XML-RPC

Key Features:

  • create_object() supports Part::, Draft::, PartDesign::, Fem:: types
  • get_view() captures screenshots with multiple perspectives
  • insert_part_from_library() for part library access
  • Smart screenshot handling (detects unsupported views like TechDraw)

Strengths:

  • Thread-safe queue system for GUI operations
  • Comprehensive object type support
  • Screenshot capabilities with view selection
  • Parts library integration

Weaknesses:

  • XML-RPC only (no embedded/headless mode)
  • No macro development tools
  • Limited debugging capabilities

2. jango-blockchained/mcp-freecad

Architecture:

  • 6 connection modes: Launcher, Server, Bridge, RPC, Wrapper, Mock
  • FastMCP 2.13.0+ with FastAPI integration
  • Multi-provider AI support (Claude, OpenAI, Google, OpenRouter)

Key Features:

  • AppImage/AppRun launcher integration
  • Connection recovery mechanisms
  • Resource caching and performance diagnostics
  • Modern GUI addon with real-time diagnostics

Strengths:

  • Most flexible connection options
  • Multi-AI provider support
  • Performance monitoring
  • Connection recovery/resilience

Weaknesses:

  • Complex setup with many moving parts
  • Heavier dependency footprint

3. contextform/freecad-mcp

Architecture:

  • Node.js-based MCP bridge (working_bridge.py)
  • AICopilot workbench integrated into FreeCAD
  • Cross-platform installer (freecad-mcp-setup)

Key Features:

  • 13 PartDesign operations (Pad, Revolution, Fillet, Chamfer, etc.)
  • 18 Part operations (Primitives, Booleans, Transforms)
  • 14 View control tools
  • Automated installer with OS detection

Strengths:

  • Most comprehensive CAD operation coverage
  • Excellent PartDesign/Part workbench integration
  • Easy installation process
  • Demo showcasing full workflow (house modeling)

Weaknesses:

  • Node.js dependency adds complexity
  • Less focus on debugging/development workflows

4. ATOI-Ming/FreeCAD-MCP

Architecture:

  • Server-client with stdio/TCP (port 9876)
  • GUI control panel inside FreeCAD
  • Macro-centric workflow

Key Features:

  • Macro templates (default, basic, part, sketch)
  • Automatic import injection in macros
  • Macro validation before execution
  • View control (front, top, right, axonometric)
  • Log management and report browser

Strengths:

  • Focus on macro development workflow
  • GUI panel for easy control
  • Automatic boilerplate injection
  • Comprehensive logging

Weaknesses:

  • Macro-only focus (no direct object creation)
  • Windows-centric paths in documentation

5. bonninr/freecad_mcp

Architecture:

  • Simple socket-based server
  • Two primary tools: get_scene_info and run_script

Key Features:

  • Comprehensive scene information retrieval
  • Arbitrary Python code execution
  • Minimal, focused API

Strengths:

  • Simple, easy to understand
  • Full Python access via run_script
  • Lightweight

Weaknesses:

  • Very minimal tool set
  • No specialized CAD operations

Feature Comparison Matrix

Feature neka-nat jango contextform ATOI-Ming bonninr Ours
Headless mode No Yes No No No Yes
GUI mode Yes Yes Yes Yes Yes Yes
XML-RPC Yes Yes No No No Yes
Socket/TCP No Yes No Yes Yes Yes
Embedded Python No No No No No Yes
Screenshot capture Yes Yes Yes No No Yes
Parts library Yes No No No No Yes
Macro support No No No Yes No Yes
PartDesign tools Basic Yes Yes Via macro No Yes
Boolean operations Yes Yes Yes Via macro No Yes
FEM support Yes No No No No Yes
Multi-AI provider No Yes No No No No
Connection recovery No Yes No No No Yes
Thread-safe GUI ops Yes Yes Unknown Unknown Unknown Yes
MCP Resources No No No No No Yes
MCP Prompts No No No No No Yes

Key Learnings & Improvements for Our Architecture

1. Communication Protocol

Learning: neka-nat uses XML-RPC which is proven and reliable.

Improvement: Support both XML-RPC (for compatibility) and JSON-RPC over sockets (simpler, more modern). Add embedded mode for true headless operation.

2. Thread-Safe GUI Operations

Learning: neka-nat's queue-based system is essential for GUI stability.

Improvement: Implement similar queue system with Qt timer for main thread execution:

# Queue-based GUI communication
+rpc_request_queue = queue.Queue()
+rpc_response_queue = queue.Queue()
+
+def process_gui_tasks():
+    """Execute queued operations on main GUI thread."""
+    while not rpc_request_queue.empty():
+        task = rpc_request_queue.get()
+        result = task()
+        rpc_response_queue.put(result)
+

3. Screenshot Capabilities

Learning: neka-nat handles unsupported view types gracefully.

Improvement: Add comprehensive view support with intelligent fallbacks:

  • Multiple view angles (Isometric, Front, Top, Right, etc.)
  • View type detection (skip TechDraw, Spreadsheet)
  • Configurable resolution and format

4. Macro Development Focus

Learning: ATOI-Ming's macro-centric approach is unique and valuable.

Improvement: Add dedicated macro tools:

  • create_macro with templates
  • validate_macro for syntax checking
  • run_macro with parameter passing
  • Automatic import injection

5. PartDesign Integration

Learning: contextform has the most comprehensive PartDesign coverage.

Improvement: Add specialized PartDesign tools:

  • Pad, Pocket, Revolution, Groove
  • Fillet, Chamfer
  • Hole (with standards support)
  • LinearPattern, PolarPattern
  • Mirrored

6. Connection Resilience

Learning: jango-blockchained has connection recovery mechanisms.

Improvement: Add connection health monitoring and auto-reconnect:

async def maintain_connection(self):
+    """Background task to maintain connection health."""
+    while self._running:
+        if not await self.is_connected():
+            await self.reconnect()
+        await asyncio.sleep(5)
+

7. Parts Library Integration

Learning: neka-nat provides access to FreeCAD parts library.

Improvement: Expose parts library with search and filtering.

8. Comprehensive Logging

Learning: ATOI-Ming has excellent logging with GUI browser.

Improvement: Add structured logging with levels, rotation, and optional GUI viewer in plugin.

Updated Architecture Decisions

Based on this analysis, our architecture will:

  1. Support 3 connection modes:

  2. Embedded (headless, in-process FreeCAD)

  3. XML-RPC (proven, compatible with neka-nat addon)

  4. JSON-RPC over socket (modern, simpler)

  5. Implement queue-based GUI thread safety following neka-nat's pattern

  6. Provide comprehensive tool coverage:

  7. Execution: Python, macros

  8. Documents: create, open, save, list
  9. Objects: create, edit, delete, query
  10. PartDesign: pad, pocket, fillet, chamfer, patterns
  11. Part: primitives, booleans, transforms
  12. Export: STEP, STL, OBJ, FreeCAD native

  13. View: screenshot, camera control

  14. Add unique features:

  15. MCP Resources for document introspection

  16. MCP Prompts for guided workflows
  17. Macro development toolkit

  18. Workbench-specific tools

  19. Focus on developer experience:

  20. Debugging tools

  21. Error introspection
  22. Console history access
  23. Constraint validation

Sources

\ No newline at end of file diff --git a/latest/MCP_TOOLS_REFERENCE/index.html b/latest/MCP_TOOLS_REFERENCE/index.html new file mode 100644 index 0000000..9db3259 --- /dev/null +++ b/latest/MCP_TOOLS_REFERENCE/index.html @@ -0,0 +1,409 @@ +Tools Reference - FreeCAD Robust MCP Suite
Skip to content

FreeCAD Robust MCP Server Tools Reference

This document provides a comprehensive reference for all MCP tools available in the FreeCAD Robust MCP Server.

Overview

The FreeCAD Robust MCP Server exposes tools organized into the following categories:

Category Description Tool Count
Execution Python execution and system info 5
Documents Document management 7
Objects Object creation and manipulation 22
PartDesign Parametric solid modeling 20
Export Import/export operations 7
View View control and screenshots 18
Macros Macro management 6
Total 85

Execution Tools

Tools for executing Python code and getting system information.

execute_python

Execute arbitrary Python code in FreeCAD's context.

execute_python(
+    code: str,
+    timeout_ms: int = 30000
+) -> dict
+

Parameters:

  • code: Python code to execute. Use _result_ = value to return data.
  • timeout_ms: Maximum execution time in milliseconds.

Returns: Execution result with stdout, stderr, and any assigned _result_.

Example:

await execute_python('''
+import Part
+box = Part.makeBox(10, 20, 30)
+_result_ = {"volume": box.Volume}
+''')
+

get_freecad_version

Get FreeCAD version and build information.

get_freecad_version() -> dict
+

Returns: Version string, build date, Python version, GUI availability.

get_connection_status

Get the current bridge connection status.

get_connection_status() -> dict
+

Returns: Connection state, mode (xmlrpc/socket/embedded), latency.

get_console_output

Get recent FreeCAD console output.

get_console_output(lines: int = 100) -> list[str]
+

get_mcp_server_environment

Get environment information about the Robust MCP Server process. Useful for identifying the Robust MCP Server instance via the unique instance_id.

get_mcp_server_environment() -> dict
+

Returns: Dictionary containing:

  • instance_id: Unique UUID for this server instance (generated at startup)
  • hostname: Server hostname
  • os_name: Operating system name (e.g., "Linux", "Darwin", "Windows")
  • os_version: OS version/release
  • platform: Full platform string
  • python_version: Python version
  • freecad: FreeCAD connection information (connected, mode, version, gui_available, is_headless)
  • env_vars: Selected environment variables (FREECAD_MODE, ports, host)

Document Tools

Tools for managing FreeCAD documents.

list_documents

List all open documents.

list_documents() -> list[dict]
+

get_active_document

Get the currently active document.

get_active_document() -> dict | None
+

create_document

Create a new document.

create_document(
+    name: str = "Unnamed",
+    label: str | None = None
+) -> dict
+

open_document

Open an existing FreeCAD file.

open_document(path: str) -> dict
+

save_document

Save a document.

save_document(
+    doc_name: str | None = None,
+    path: str | None = None
+) -> dict
+

close_document

Close a document.

close_document(
+    doc_name: str | None = None,
+    save_changes: bool = False
+) -> dict
+

recompute_document

Recompute all objects in a document.

recompute_document(doc_name: str | None = None) -> dict
+

Object Tools

Tools for creating and manipulating FreeCAD objects.

Primitive Creation

create_box

Create a parametric box.

create_box(
+    length: float = 10.0,
+    width: float = 10.0,
+    height: float = 10.0,
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

create_cylinder

Create a parametric cylinder.

create_cylinder(
+    radius: float = 5.0,
+    height: float = 10.0,
+    angle: float = 360.0,  # For partial cylinders
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

create_sphere

Create a parametric sphere.

create_sphere(
+    radius: float = 5.0,
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

create_cone

Create a parametric cone.

create_cone(
+    radius1: float = 5.0,   # Bottom radius
+    radius2: float = 0.0,   # Top radius (0 = pointed)
+    height: float = 10.0,
+    angle: float = 360.0,
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

create_torus

Create a torus (donut shape).

create_torus(
+    radius1: float = 10.0,  # Major radius
+    radius2: float = 2.0,   # Minor radius
+    angle1: float = -180.0,
+    angle2: float = 180.0,
+    angle3: float = 360.0,
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

create_wedge

Create a tapered wedge shape.

create_wedge(
+    xmin: float = 0.0, ymin: float = 0.0, zmin: float = 0.0,
+    x2min: float = 2.0, z2min: float = 2.0,
+    xmax: float = 10.0, ymax: float = 10.0, zmax: float = 10.0,
+    x2max: float = 8.0, z2max: float = 8.0,
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

create_helix

Create a helix curve (for threads, springs).

create_helix(
+    pitch: float = 5.0,
+    height: float = 20.0,
+    radius: float = 5.0,
+    angle: float = 0.0,
+    left_handed: bool = False,
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

Object Management

list_objects

List all objects in a document.

list_objects(doc_name: str | None = None) -> list[dict]
+

inspect_object

Get detailed information about an object.

inspect_object(
+    object_name: str,
+    doc_name: str | None = None,
+    include_properties: bool = True,
+    include_shape: bool = True
+) -> dict
+

create_object

Create a generic FreeCAD object by type ID.

create_object(
+    type_id: str,  # e.g., "Part::Box", "Sketcher::SketchObject"
+    name: str | None = None,
+    properties: dict[str, Any] | None = None,
+    doc_name: str | None = None
+) -> dict
+

edit_object

Modify object properties.

edit_object(
+    object_name: str,
+    properties: dict[str, Any],
+    doc_name: str | None = None
+) -> dict
+

delete_object

Delete an object.

delete_object(
+    object_name: str,
+    doc_name: str | None = None
+) -> dict
+

Boolean Operations

boolean_operation

Perform boolean operations (union, subtract, intersect).

boolean_operation(
+    operation: str,      # "fuse", "cut", or "common"
+    object1_name: str,
+    object2_name: str,
+    result_name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

Operations:

  • fuse - Union/combine shapes
  • cut - Subtract object2 from object1
  • common - Intersection of shapes

Transformations

set_placement

Set object position and rotation.

set_placement(
+    object_name: str,
+    position: list[float] | None = None,  # [x, y, z]
+    rotation: list[float] | None = None,  # [yaw, pitch, roll] in degrees
+    doc_name: str | None = None
+) -> dict
+

rotate_object

Rotate object around an axis.

rotate_object(
+    object_name: str,
+    axis: list[float],      # [x, y, z] rotation axis
+    angle: float,           # Degrees
+    center: list[float] | None = None,
+    doc_name: str | None = None
+) -> dict
+

scale_object

Scale an object (creates new copy).

scale_object(
+    object_name: str,
+    scale: float | list[float],  # Uniform or [sx, sy, sz]
+    result_name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

copy_object

Create a copy of an object.

copy_object(
+    object_name: str,
+    new_name: str | None = None,
+    offset: list[float] | None = None,  # [x, y, z]
+    doc_name: str | None = None
+) -> dict
+

mirror_object

Mirror object across a plane.

mirror_object(
+    object_name: str,
+    plane: str = "XY",  # "XY", "XZ", or "YZ"
+    result_name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

Selection (GUI Mode)

get_selection

Get currently selected objects.

get_selection(doc_name: str | None = None) -> list[dict]
+

set_selection

Select objects programmatically.

set_selection(
+    object_names: list[str],
+    clear_existing: bool = True,
+    doc_name: str | None = None
+) -> dict
+

clear_selection

Clear the current selection.

clear_selection() -> dict
+

PartDesign Tools

Tools for parametric solid modeling using the PartDesign workbench.

Bodies and Sketches

create_partdesign_body

Create a PartDesign Body container.

create_partdesign_body(
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

create_sketch

Create a sketch attached to a plane or body.

create_sketch(
+    body_name: str | None = None,
+    plane: str = "XY_Plane",  # "XY_Plane", "XZ_Plane", "YZ_Plane", or "FaceN"
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

Sketch Geometry

add_sketch_rectangle

Add a rectangle to a sketch.

add_sketch_rectangle(
+    sketch_name: str,
+    x: float, y: float,       # Bottom-left corner
+    width: float, height: float,
+    doc_name: str | None = None
+) -> dict
+

add_sketch_circle

Add a circle to a sketch.

add_sketch_circle(
+    sketch_name: str,
+    center_x: float, center_y: float,
+    radius: float,
+    doc_name: str | None = None
+) -> dict
+

add_sketch_line

Add a line to a sketch.

add_sketch_line(
+    sketch_name: str,
+    x1: float, y1: float,  # Start point
+    x2: float, y2: float,  # End point
+    construction: bool = False,
+    doc_name: str | None = None
+) -> dict
+

add_sketch_arc

Add an arc to a sketch.

add_sketch_arc(
+    sketch_name: str,
+    center_x: float, center_y: float,
+    radius: float,
+    start_angle: float,  # Degrees
+    end_angle: float,    # Degrees
+    doc_name: str | None = None
+) -> dict
+

add_sketch_point

Add a point to a sketch (useful for hole centers).

add_sketch_point(
+    sketch_name: str,
+    x: float, y: float,
+    doc_name: str | None = None
+) -> dict
+

Additive Features

pad_sketch

Extrude a sketch to create material.

pad_sketch(
+    sketch_name: str,
+    length: float,
+    symmetric: bool = False,
+    reversed: bool = False,
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

revolution_sketch

Revolve a sketch around an axis.

revolution_sketch(
+    sketch_name: str,
+    angle: float = 360.0,
+    axis: str = "Base_X",  # "Base_X/Y/Z" or "Sketch_V/H"
+    symmetric: bool = False,
+    reversed: bool = False,
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

loft_sketches

Loft through multiple sketches.

loft_sketches(
+    sketch_names: list[str],
+    ruled: bool = False,
+    closed: bool = False,
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

sweep_sketch

Sweep a profile along a path.

sweep_sketch(
+    profile_sketch: str,
+    spine_sketch: str,
+    transition: str = "Transformed",  # "Transformed", "Right", "Round"
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

Subtractive Features

pocket_sketch

Cut material by extruding a sketch.

pocket_sketch(
+    sketch_name: str,
+    length: float,
+    type: str = "Length",  # "Length", "ThroughAll", "UpToFirst", "UpToFace"
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

groove_sketch

Cut material by revolving a sketch.

groove_sketch(
+    sketch_name: str,
+    angle: float = 360.0,
+    axis: str = "Base_X",
+    symmetric: bool = False,
+    reversed: bool = False,
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

create_hole

Create parametric holes with optional threading.

create_hole(
+    sketch_name: str,        # Sketch with center point(s)
+    diameter: float = 6.0,
+    depth: float = 10.0,
+    hole_type: str = "Dimension",  # "Dimension", "ThroughAll", "UpToFirst"
+    threaded: bool = False,
+    thread_type: str = "ISO",  # "ISO", "UNC", "UNF"
+    thread_size: str = "M6",
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

Edge Operations

fillet_edges

Add rounded edges.

fillet_edges(
+    object_name: str,
+    radius: float,
+    edges: list[str] | None = None,  # ["Edge1", "Edge2"] or None for all
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

chamfer_edges

Add beveled edges.

chamfer_edges(
+    object_name: str,
+    size: float,
+    edges: list[str] | None = None,
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

Patterns

linear_pattern

Repeat a feature in a linear direction.

linear_pattern(
+    feature_name: str,
+    direction: str = "X",  # "X", "Y", "Z"
+    length: float = 50.0,
+    occurrences: int = 3,
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

polar_pattern

Repeat a feature around an axis.

polar_pattern(
+    feature_name: str,
+    axis: str = "Z",  # "X", "Y", "Z"
+    angle: float = 360.0,
+    occurrences: int = 6,
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

mirrored_feature

Mirror a feature across a plane.

mirrored_feature(
+    feature_name: str,
+    plane: str = "XY",  # "XY", "XZ", "YZ"
+    name: str | None = None,
+    doc_name: str | None = None
+) -> dict
+

Export Tools

Tools for importing and exporting CAD files.

export_step

Export objects to STEP format.

export_step(
+    file_path: str,
+    object_names: list[str] | None = None,  # None = all visible
+    doc_name: str | None = None
+) -> dict
+

export_stl

Export objects to STL format (for 3D printing).

export_stl(
+    file_path: str,
+    object_names: list[str] | None = None,
+    doc_name: str | None = None,
+    mesh_tolerance: float = 0.1
+) -> dict
+

export_3mf

Export objects to 3MF format (modern 3D printing format).

3MF (3D Manufacturing Format) supports richer data than STL, including colors, materials, and print settings. It is increasingly preferred over STL for 3D printing.

export_3mf(
+    file_path: str,
+    object_names: list[str] | None = None,
+    doc_name: str | None = None,
+    mesh_tolerance: float = 0.1
+) -> dict
+

export_obj

Export objects to OBJ format.

export_obj(
+    file_path: str,
+    object_names: list[str] | None = None,
+    doc_name: str | None = None
+) -> dict
+

export_iges

Export objects to IGES format.

export_iges(
+    file_path: str,
+    object_names: list[str] | None = None,
+    doc_name: str | None = None
+) -> dict
+

import_step

Import a STEP file.

import_step(
+    file_path: str,
+    doc_name: str | None = None
+) -> dict
+

import_stl

Import an STL file.

import_stl(
+    file_path: str,
+    doc_name: str | None = None
+) -> dict
+

View Tools

Tools for controlling the 3D view and capturing screenshots.

Screenshots

get_screenshot

Capture a screenshot of the 3D view.

Requires GUI mode.

get_screenshot(
+    view_angle: str = "Isometric",
+    width: int = 800,
+    height: int = 600,
+    doc_name: str | None = None
+) -> dict  # Returns base64-encoded PNG
+

View angles: Isometric, Front, Back, Top, Bottom, Left, Right, FitAll

View Control

set_view_angle

Set the 3D view angle.

set_view_angle(
+    view_angle: str,  # Same options as get_screenshot
+    doc_name: str | None = None
+) -> dict
+

fit_all

Fit all objects in the view.

fit_all(doc_name: str | None = None) -> dict
+

zoom_in / zoom_out

Zoom the view.

Requires GUI mode.

zoom_in(factor: float = 1.5, doc_name: str | None = None) -> dict
+zoom_out(factor: float = 1.5, doc_name: str | None = None) -> dict
+

set_camera_position

Set custom camera position.

Requires GUI mode.

set_camera_position(
+    position: list[float],     # [x, y, z]
+    look_at: list[float] | None = None,  # Default: origin
+    doc_name: str | None = None
+) -> dict
+

Object Appearance

set_object_visibility

Show or hide an object.

Requires GUI mode.

set_object_visibility(
+    object_name: str,
+    visible: bool,
+    doc_name: str | None = None
+) -> dict
+

set_display_mode

Set object display mode.

Requires GUI mode.

set_display_mode(
+    object_name: str,
+    mode: str,  # "Flat Lines", "Shaded", "Wireframe", "Points"
+    doc_name: str | None = None
+) -> dict
+

set_object_color

Set object color.

Requires GUI mode.

set_object_color(
+    object_name: str,
+    color: list[float],  # [r, g, b] where values are 0.0-1.0
+    doc_name: str | None = None
+) -> dict
+

Workbenches

list_workbenches

List available workbenches.

list_workbenches() -> list[dict]
+

activate_workbench

Activate a workbench.

activate_workbench(workbench_name: str) -> dict
+

Common workbenches:

  • PartWorkbench - Part modeling
  • PartDesignWorkbench - Parametric design
  • SketcherWorkbench - 2D sketching
  • DraftWorkbench - 2D drafting
  • MeshWorkbench - Mesh operations

Undo/Redo

undo / redo

Undo or redo operations.

undo(doc_name: str | None = None) -> dict
+redo(doc_name: str | None = None) -> dict
+

get_undo_redo_status

Get undo/redo availability.

get_undo_redo_status(doc_name: str | None = None) -> dict
+

Parts Library

list_parts_library

List available library parts.

list_parts_library() -> list[dict]
+

insert_part_from_library

Insert a part from the library.

insert_part_from_library(
+    part_path: str,
+    name: str | None = None,
+    position: list[float] | None = None,
+    doc_name: str | None = None
+) -> dict
+

Utility

get_console_log

Get FreeCAD console output.

get_console_log(lines: int = 50) -> dict
+

recompute

Force recompute of all objects.

recompute(doc_name: str | None = None) -> dict
+

Macro Tools

Tools for managing FreeCAD macros.

list_macros

List available macros.

list_macros() -> list[dict]
+

run_macro

Execute a macro by name.

run_macro(
+    macro_name: str,
+    args: dict[str, Any] | None = None
+) -> dict
+

create_macro

Create a new macro.

create_macro(
+    name: str,
+    code: str,
+    description: str = ""
+) -> dict
+

read_macro

Read macro contents.

read_macro(macro_name: str) -> dict
+

delete_macro

Delete a user macro.

delete_macro(macro_name: str) -> dict
+

create_macro_from_template

Create macro from a predefined template.

create_macro_from_template(
+    name: str,
+    template: str = "basic",  # "basic", "part", "sketch", "gui", "selection"
+    description: str = ""
+) -> dict
+

GUI vs Headless Mode

Some tools require FreeCAD to be running in GUI mode. When running in headless mode, these tools will return an error instead of crashing.

GUI-only tools:

  • get_screenshot
  • set_object_visibility
  • set_display_mode
  • set_object_color
  • zoom_in / zoom_out
  • set_camera_position
  • get_selection / set_selection / clear_selection

To check mode programmatically:

result = await execute_python("_result_ = FreeCAD.GuiUp")
+is_gui_mode = result["result"]
+

Error Handling

All tools return dictionaries with consistent error handling:

Success:

{
+    "success": True,
+    "name": "Box",
+    "volume": 6000.0,
+    # ... other fields
+}
+

Failure:

{
+    "success": False,
+    "error": "Object not found: MissingBox"
+}
+

For tools that raise exceptions, wrap calls in try/except or check the returned error field.

\ No newline at end of file diff --git a/latest/USER_GUIDE/index.html b/latest/USER_GUIDE/index.html new file mode 100644 index 0000000..be4ae73 --- /dev/null +++ b/latest/USER_GUIDE/index.html @@ -0,0 +1,97 @@ +Detailed User Guide - FreeCAD Robust MCP Suite
Skip to content

FreeCAD Robust MCP User Guide

This guide explains how to use AI assistants with FreeCAD via the MCP (Model Context Protocol) server to create and manipulate 3D CAD models.

Table of Contents

  1. Getting Started
  2. Running Modes
  3. Basic Workflows
  4. Object Creation Examples
  5. PartDesign Workflow
  6. Complete Example: Mounting Bracket
  7. Tips and Best Practices

Getting Started

Prerequisites

  1. FreeCAD installed - Version 1.0.x or later
  2. An MCP client (Claude Code, or other MCP-compatible AI assistant) configured
  3. Python 3.11 - Must match FreeCAD's bundled Python version

Starting FreeCAD with MCP Bridge

You have two options depending on your workflow:

Headless Mode (Command-line only)

Best for automated workflows, batch processing, or when you don't need visual feedback.

just freecad::run-headless
+

Capabilities: All modeling operations, export, scripting. Limitations: No screenshots, no visual feedback, no color/visibility control.

GUI Mode (Full graphical interface)

Best for interactive design work where you want to see results visually.

just freecad::run-gui
+

Capabilities: Everything headless mode can do, plus screenshots, colors, view control.

Verifying Connection

Once FreeCAD is running with the MCP bridge, you can verify the connection:

"Check the FreeCAD connection status"
+

Claude will use the get_connection_status tool to confirm the bridge is working.

Running Modes

Headless vs GUI Mode

Feature Headless Mode GUI Mode
Object creation Yes Yes
Boolean operations Yes Yes
Export (STEP, STL, etc.) Yes Yes
Save documents Yes Yes
Screenshots No Yes
Object colors No Yes
Object visibility No Yes
Camera control No Yes
Interactive selection No Yes

Detecting the Current Mode

When working with Claude, it will automatically detect whether FreeCAD is in GUI or headless mode and adapt accordingly. GUI-only operations will return informative errors in headless mode rather than crashing.

Basic Workflows

Creating a Document

Every FreeCAD project needs a document. You can ask Claude:

"Create a new FreeCAD document called 'MyProject'"
+

Claude will use the create_document tool.

Creating Simple Shapes

Ask Claude to create primitive shapes:

"Create a box that's 50mm long, 30mm wide, and 10mm tall"
+"Add a cylinder with radius 5mm and height 20mm"
+"Create a sphere with 15mm radius"
+

Positioning Objects

Move and rotate objects:

"Move the box to position (100, 50, 0)"
+"Rotate the cylinder 45 degrees around the Z axis"
+

Boolean Operations

Combine shapes:

"Fuse the box and cylinder together"
+"Cut a hole through the box using the cylinder"
+"Find the intersection of the two shapes"
+

Saving and Exporting

"Save the document as MyProject.FCStd"
+"Export the model to STEP format"
+"Export for 3D printing as STL"
+

Object Creation Examples

Example 1: Simple Box with Hole

Request:

Create a 50x50x20mm box with a 10mm diameter hole through the center.
+

What Claude does:

  1. Creates a document
  2. Creates a box (50x50x20)
  3. Creates a cylinder (radius 5, height 30) positioned at center
  4. Performs boolean cut operation
  5. Returns the result

Example 2: Pipe/Tube Shape

Request:

Create a pipe with outer diameter 40mm, inner diameter 30mm, and length 100mm.
+

What Claude does:

  1. Creates outer cylinder (radius 20, height 100)
  2. Creates inner cylinder (radius 15, height 100)
  3. Cuts inner from outer to create hollow tube

Example 3: L-Bracket

Request:

Create an L-shaped bracket:
+- Horizontal part: 100mm x 50mm x 5mm
+- Vertical part: 5mm x 50mm x 80mm standing on the horizontal part
+

What Claude does:

  1. Creates horizontal box
  2. Creates vertical box positioned at correct location
  3. Fuses them together

PartDesign Workflow

For parametric modeling that maintains design history, use the PartDesign workflow.

Understanding PartDesign Concepts

Body: A container for a single solid model built from features.

Sketch: A 2D drawing that defines profiles for 3D operations.

Features: Operations like Pad (extrude), Pocket (cut), Fillet, etc.

Basic PartDesign Example

Request:

Create a parametric mounting plate:
+1. Start with a PartDesign body
+2. Create a sketch on the XY plane with a 100x60mm rectangle
+3. Pad it 8mm thick
+4. Add four 5mm holes near each corner for mounting screws
+5. Fillet all edges with 2mm radius
+

What Claude does:

  1. create_partdesign_body() - Creates the Body container
  2. create_sketch(body_name="Body", plane="XY_Plane") - Creates attached sketch
  3. add_sketch_rectangle(...) - Adds the profile geometry
  4. pad_sketch(sketch_name="Sketch", length=8) - Extrudes to solid
  5. Creates new sketches with points for hole locations
  6. create_hole(...) for each mounting hole
  7. fillet_edges(...) - Rounds the edges

Revolving Profiles

Request:

Create a turned part:
+- Draw a profile on the XZ plane
+- Revolve it 360 degrees around the X axis
+

What Claude does:

  1. Creates body and sketch on XZ plane
  2. Draws the profile using lines and arcs
  3. Uses revolution_sketch() to create the solid

Pattern Operations

Request:

Create a plate with a row of 6 holes spaced 15mm apart.
+

What Claude does:

  1. Creates the base plate
  2. Creates one hole feature
  3. Uses linear_pattern() to repeat the hole

Complete Example: Mounting Bracket

This detailed example shows a complete workflow for creating a practical part.

Design Requirements

Create a mounting bracket with:

  • Base plate: 80mm x 60mm x 5mm
  • Vertical support: 5mm thick, 50mm tall, 60mm wide
  • Two mounting holes (6mm diameter) on the base
  • One slot (10mm x 20mm) on the vertical support
  • 3mm fillets on external corners

Step-by-Step Workflow

Step 1: Ask Claude to create the bracket

Create a mounting bracket with the following specifications:
+
+Base plate:
+- Size: 80mm x 60mm x 5mm
+- Two 6mm diameter mounting holes, centered 15mm from each short edge
+
+Vertical support:
+- Attached to one end of the base
+- 5mm thick, 60mm wide, 50mm tall
+- One slot: 10mm wide x 20mm tall, centered
+
+Finish:
+- 3mm fillet on all outer edges
+- Export as STEP file when done
+

Step 2: Claude's approach

Claude will break this down into manageable operations:

# 1. Create document and PartDesign body
+create_document(name="MountingBracket")
+create_partdesign_body(name="Body")
+
+# 2. Create base plate sketch and pad
+create_sketch(body_name="Body", plane="XY_Plane", name="BaseSketch")
+add_sketch_rectangle(sketch_name="BaseSketch", x=0, y=0, width=80, height=60)
+pad_sketch(sketch_name="BaseSketch", length=5)
+
+# 3. Add vertical support
+create_sketch(body_name="Body", plane="XZ_Plane", name="SupportSketch")
+# ... add geometry
+pad_sketch(sketch_name="SupportSketch", length=60)
+
+# 4. Add mounting holes
+create_sketch(body_name="Body", plane="XY_Plane", name="HoleSketch")
+add_sketch_point(sketch_name="HoleSketch", x=15, y=30)
+add_sketch_point(sketch_name="HoleSketch", x=65, y=30)
+create_hole(sketch_name="HoleSketch", diameter=6, hole_type="ThroughAll")
+
+# 5. Add slot (as pocket)
+create_sketch(body_name="Body", plane="Face...", name="SlotSketch")
+add_sketch_rectangle(...)
+pocket_sketch(sketch_name="SlotSketch", length=5, type="ThroughAll")
+
+# 6. Add fillets
+fillet_edges(object_name="...", radius=3)
+
+# 7. Export
+export_step(file_path="/path/to/bracket.step")
+

Step 3: View the result (GUI mode)

Take a screenshot of the bracket from an isometric view
+

Claude will use get_screenshot(view_angle="Isometric") to capture and display the result.

Tips and Best Practices

1. Be Specific with Dimensions

Good: "Create a box 50mm x 30mm x 10mm"

Vague: "Create a small box"

2. Specify Units

FreeCAD uses millimeters by default. Always include units to avoid confusion:

"Create a cylinder with 25.4mm (1 inch) diameter"
+

3. Use Meaningful Names

"Create a box named 'BasePlate' and a cylinder named 'MountingHole'"
+

This makes it easier to reference objects later.

4. Work Incrementally

For complex parts, build step by step:

  1. Create the basic shape
  2. Verify it looks correct
  3. Add features one at a time
  4. Check after each major operation

5. Save Frequently

"Save the document"
+

FreeCAD can crash, and you don't want to lose work.

6. Use PartDesign for Parametric Parts

If you might need to modify dimensions later, use the PartDesign workflow with sketches rather than direct Part operations.

7. Export to Multiple Formats

For manufacturing or 3D printing:

"Export as STEP for CNC machining and STL for 3D printing"
+

8. Use the execute_python Tool for Advanced Operations

For operations not covered by the standard tools, Claude can execute custom Python:

"Calculate the volume and center of mass of the part"
+

Claude will use execute_python() to run the necessary FreeCAD Python commands.

9. Check GUI Mode for Visual Features

Before asking for screenshots or colors:

"Is FreeCAD running in GUI mode?"
+

10. Use Patterns for Repetitive Features

Instead of creating many individual features:

"Create one hole and pattern it in a 4x3 grid with 20mm spacing"
+

Common Operations Quick Reference

Task How to Ask
Create box "Create a box 50x30x10mm"
Create cylinder "Create a cylinder with 10mm radius and 20mm height"
Move object "Move MyBox to position (100, 50, 0)"
Rotate object "Rotate MyCylinder 45 degrees around Z axis"
Boolean union "Fuse Box and Cylinder together"
Boolean subtract "Cut Cylinder from Box"
Create hole "Add a 6mm through hole at (25, 15)"
Fillet edges "Add 3mm fillet to all edges"
Chamfer edges "Add 2mm chamfer to selected edges"
Export STEP "Export to STEP format"
Export STL "Export for 3D printing"
Save document "Save the document as MyPart.FCStd"
Screenshot "Take a screenshot from the front view" (GUI mode only)
Change color "Make the box red" (GUI mode only)

Troubleshooting

"GUI not available" Error

You're running in headless mode and trying to use a GUI-only feature. Either:

  • Switch to GUI mode: just freecad::run-gui
  • Use an alternative approach (e.g., skip visual operations)

Objects Not Appearing

Make sure to recompute the document:

"Recompute the document"
+

Boolean Operations Failing

Ensure:

  1. Both objects have valid shapes
  2. The objects actually intersect
  3. Objects are in the same document

Sketch Errors

Sketches need to be fully constrained for PartDesign operations. Ask Claude to:

"Check if the sketch is fully constrained"
+

Connection Issues

If the MCP bridge isn't responding:

  1. Check FreeCAD is running with the bridge started
  2. Verify ports 9875 (XML-RPC) and 9876 (socket) are available
  3. Restart FreeCAD with just freecad::run-gui or just freecad::run-headless

Next Steps

  • See MCP_TOOLS_REFERENCE.md for detailed API documentation
  • Explore the FreeCAD wiki for advanced techniques
  • Practice with simple parts before attempting complex assemblies
\ No newline at end of file diff --git a/latest/api/bridge/index.html b/latest/api/bridge/index.html new file mode 100644 index 0000000..b1f3334 --- /dev/null +++ b/latest/api/bridge/index.html @@ -0,0 +1,13278 @@ +Bridge - FreeCAD Robust MCP Suite
Skip to content

Bridge API Reference

The bridge module provides the communication layer between the Robust MCP Server and FreeCAD.

Base Classes

freecad_mcp.bridge.base

Abstract bridge interface for FreeCAD communication.

This module defines the abstract base class and data types for all FreeCAD bridge implementations. Bridges provide the communication layer between the Robust MCP Server and FreeCAD instances.

Based on learnings from existing implementations: - neka-nat: Queue-based thread safety for GUI operations - jango: Multiple connection modes with recovery - contextform: Comprehensive CAD operations

Classes

ConnectionStatus dataclass

Status of the FreeCAD connection.

Attributes:

Name Type Description
connected bool

Whether connection is established.
mode str

Connection mode (embedded, xmlrpc, socket).
freecad_version str

FreeCAD version string.
gui_available bool

Whether GUI is available.
last_ping_ms float

Last ping latency in milliseconds.
error str | None

Connection error message if any.
Source code in src/freecad_mcp/bridge/base.py 
206
+207
+208
+209
+210
+211
+212
+213
+214
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
@dataclass
+class ConnectionStatus:
+    """Status of the FreeCAD connection.
+
+    Attributes:
+        connected: Whether connection is established.
+        mode: Connection mode (embedded, xmlrpc, socket).
+        freecad_version: FreeCAD version string.
+        gui_available: Whether GUI is available.
+        last_ping_ms: Last ping latency in milliseconds.
+        error: Connection error message if any.
+    """
+
+    connected: bool
+    mode: str
+    freecad_version: str = ""
+    gui_available: bool = False
+    last_ping_ms: float = 0
+    error: str | None = None
+

DocumentInfo dataclass

Information about a FreeCAD document.

Attributes:

Name Type Description
name str

Internal document name (identifier).
label str

Display label (may differ from name).
path str | None

File path if saved, None otherwise.
objects list[str]

List of object names in the document.
is_modified bool

Whether document has unsaved changes.
active_object str | None

Name of the currently active object.
Source code in src/freecad_mcp/bridge/base.py 
67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
@dataclass
+class DocumentInfo:
+    """Information about a FreeCAD document.
+
+    Attributes:
+        name: Internal document name (identifier).
+        label: Display label (may differ from name).
+        path: File path if saved, None otherwise.
+        objects: List of object names in the document.
+        is_modified: Whether document has unsaved changes.
+        active_object: Name of the currently active object.
+    """
+
+    name: str
+    label: str = ""
+    path: str | None = None
+    objects: list[str] = field(default_factory=list)
+    is_modified: bool = False
+    active_object: str | None = None
+
+    def __post_init__(self) -> None:
+        """Set label to name if not provided."""
+        if not self.label:
+            self.label = self.name
+
Functions
__post_init__()

Set label to name if not provided.

Source code in src/freecad_mcp/bridge/base.py 
87
+88
+89
+90
def __post_init__(self) -> None:
+    """Set label to name if not provided."""
+    if not self.label:
+        self.label = self.name
+

ExecutionResult dataclass

Result of Python code execution in FreeCAD.

Attributes:

Name Type Description
success bool

Whether execution completed without errors.
result Any

The value assigned to _result_ variable, or None.
stdout str

Captured standard output.
stderr str

Captured standard error.
execution_time_ms float

Time taken in milliseconds.
error_type str | None

Type of exception if failed, None otherwise.
error_traceback str | None

Full traceback if failed, None otherwise.
Source code in src/freecad_mcp/bridge/base.py 
44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
@dataclass
+class ExecutionResult:
+    """Result of Python code execution in FreeCAD.
+
+    Attributes:
+        success: Whether execution completed without errors.
+        result: The value assigned to `_result_` variable, or None.
+        stdout: Captured standard output.
+        stderr: Captured standard error.
+        execution_time_ms: Time taken in milliseconds.
+        error_type: Type of exception if failed, None otherwise.
+        error_traceback: Full traceback if failed, None otherwise.
+    """
+
+    success: bool
+    result: Any
+    stdout: str
+    stderr: str
+    execution_time_ms: float
+    error_type: str | None = None
+    error_traceback: str | None = None
+

FreecadBridge

Bases: ABC

Abstract base class for FreeCAD bridges.

A bridge provides communication between the Robust MCP Server and a FreeCAD instance. Implementations may run FreeCAD in-process (embedded), communicate via XML-RPC, or use JSON-RPC over sockets.

Thread Safety

GUI operations must be executed on the main thread. Implementations should use queue-based communication for thread safety (learned from neka-nat implementation).

Source code in src/freecad_mcp/bridge/base.py 
227
+228
+229
+230
+231
+232
+233
+234
+235
+236
+237
+238
+239
+240
+241
+242
+243
+244
+245
+246
+247
+248
+249
+250
+251
+252
+253
+254
+255
+256
+257
+258
+259
+260
+261
+262
+263
+264
+265
+266
+267
+268
+269
+270
+271
+272
+273
+274
+275
+276
+277
+278
+279
+280
+281
+282
+283
+284
+285
+286
+287
+288
+289
+290
+291
+292
+293
+294
+295
+296
+297
+298
+299
+300
+301
+302
+303
+304
+305
+306
+307
+308
+309
+310
+311
+312
+313
+314
+315
+316
+317
+318
+319
+320
+321
+322
+323
+324
+325
+326
+327
+328
+329
+330
+331
+332
+333
+334
+335
+336
+337
+338
+339
+340
+341
+342
+343
+344
+345
+346
+347
+348
+349
+350
+351
+352
+353
+354
+355
+356
+357
+358
+359
+360
+361
+362
+363
+364
+365
+366
+367
+368
+369
+370
+371
+372
+373
+374
+375
+376
+377
+378
+379
+380
+381
+382
+383
+384
+385
+386
+387
+388
+389
+390
+391
+392
+393
+394
+395
+396
+397
+398
+399
+400
+401
+402
+403
+404
+405
+406
+407
+408
+409
+410
+411
+412
+413
+414
+415
+416
+417
+418
+419
+420
+421
+422
+423
+424
+425
+426
+427
+428
+429
+430
+431
+432
+433
+434
+435
+436
+437
+438
+439
+440
+441
+442
+443
+444
+445
+446
+447
+448
+449
+450
+451
+452
+453
+454
+455
+456
+457
+458
+459
+460
+461
+462
+463
+464
+465
+466
+467
+468
+469
+470
+471
+472
+473
+474
+475
+476
+477
+478
+479
+480
+481
+482
+483
+484
+485
+486
+487
+488
+489
+490
+491
+492
+493
+494
+495
+496
+497
+498
+499
+500
+501
+502
+503
+504
+505
+506
+507
+508
+509
+510
+511
+512
+513
+514
+515
+516
+517
+518
+519
+520
+521
+522
+523
+524
+525
+526
+527
+528
+529
+530
+531
+532
+533
+534
+535
+536
+537
+538
+539
+540
+541
+542
+543
+544
+545
+546
+547
+548
+549
+550
+551
+552
+553
+554
+555
+556
+557
+558
+559
+560
+561
+562
+563
+564
+565
+566
+567
+568
+569
+570
+571
+572
+573
+574
+575
+576
+577
+578
+579
+580
+581
+582
+583
+584
+585
+586
+587
+588
+589
+590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
+608
+609
+610
+611
class FreecadBridge(ABC):
+    """Abstract base class for FreeCAD bridges.
+
+    A bridge provides communication between the Robust MCP Server and a FreeCAD
+    instance. Implementations may run FreeCAD in-process (embedded),
+    communicate via XML-RPC, or use JSON-RPC over sockets.
+
+    Thread Safety:
+        GUI operations must be executed on the main thread. Implementations
+        should use queue-based communication for thread safety (learned from
+        neka-nat implementation).
+    """
+
+    @abstractmethod
+    async def connect(self) -> None:
+        """Establish connection to FreeCAD.
+
+        Raises:
+            ConnectionError: If connection cannot be established.
+        """
+
+    @abstractmethod
+    async def disconnect(self) -> None:
+        """Close connection to FreeCAD.
+
+        Should be called during cleanup to release resources.
+        """
+
+    @abstractmethod
+    async def is_connected(self) -> bool:
+        """Check if bridge is connected to FreeCAD.
+
+        Returns:
+            True if connected, False otherwise.
+        """
+
+    @abstractmethod
+    async def ping(self) -> float:
+        """Ping FreeCAD to check connection and measure latency.
+
+        Returns:
+            Round-trip time in milliseconds.
+
+        Raises:
+            ConnectionError: If not connected.
+        """
+
+    @abstractmethod
+    async def get_status(self) -> ConnectionStatus:
+        """Get detailed connection status.
+
+        Returns:
+            ConnectionStatus with full status information.
+        """
+
+    # =========================================================================
+    # Code Execution
+    # =========================================================================
+
+    @abstractmethod
+    async def execute_python(
+        self,
+        code: str,
+        timeout_ms: int = 30000,
+    ) -> ExecutionResult:
+        """Execute Python code in FreeCAD context.
+
+        The code runs with access to FreeCAD modules (FreeCAD, App, Gui).
+        To return a value, assign it to the `_result_` variable.
+
+        Args:
+            code: Python code to execute.
+            timeout_ms: Maximum execution time in milliseconds.
+
+        Returns:
+            ExecutionResult with success status, output, and any errors.
+        """
+
+    # =========================================================================
+    # Document Management
+    # =========================================================================
+
+    @abstractmethod
+    async def get_documents(self) -> list[DocumentInfo]:
+        """Get list of open documents.
+
+        Returns:
+            List of DocumentInfo for each open document.
+        """
+
+    @abstractmethod
+    async def get_active_document(self) -> DocumentInfo | None:
+        """Get the active document.
+
+        Returns:
+            DocumentInfo for active document, or None if no document is active.
+        """
+
+    @abstractmethod
+    async def create_document(
+        self, name: str, label: str | None = None
+    ) -> DocumentInfo:
+        """Create a new document.
+
+        Args:
+            name: Internal document name (no spaces).
+            label: Display label (optional, defaults to name).
+
+        Returns:
+            DocumentInfo for the created document.
+        """
+
+    @abstractmethod
+    async def open_document(self, path: str) -> DocumentInfo:
+        """Open an existing document.
+
+        Args:
+            path: Path to the .FCStd file.
+
+        Returns:
+            DocumentInfo for the opened document.
+
+        Raises:
+            FileNotFoundError: If file doesn't exist.
+            ValueError: If file is not a valid FreeCAD document.
+        """
+
+    @abstractmethod
+    async def save_document(
+        self,
+        doc_name: str | None = None,
+        path: str | None = None,
+    ) -> str:
+        """Save a document.
+
+        Args:
+            doc_name: Document name (uses active if None).
+            path: Save path (uses existing path if None).
+
+        Returns:
+            Path where document was saved.
+
+        Raises:
+            ValueError: If document not found or no path specified for new doc.
+        """
+
+    @abstractmethod
+    async def close_document(self, doc_name: str | None = None) -> None:
+        """Close a document.
+
+        Args:
+            doc_name: Document name (uses active if None).
+        """
+
+    # =========================================================================
+    # Object Management
+    # =========================================================================
+
+    @abstractmethod
+    async def get_objects(self, doc_name: str | None = None) -> list[ObjectInfo]:
+        """Get all objects in a document.
+
+        Args:
+            doc_name: Document name (uses active if None).
+
+        Returns:
+            List of ObjectInfo for each object.
+        """
+
+    @abstractmethod
+    async def get_object(
+        self,
+        obj_name: str,
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Get detailed object information.
+
+        Args:
+            obj_name: Name of the object.
+            doc_name: Document name (uses active if None).
+
+        Returns:
+            ObjectInfo with full object details.
+
+        Raises:
+            ValueError: If object not found.
+        """
+
+    @abstractmethod
+    async def create_object(
+        self,
+        type_id: str,
+        name: str | None = None,
+        properties: dict[str, Any] | None = None,
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Create a new object.
+
+        Args:
+            type_id: FreeCAD type ID (e.g., "Part::Box", "Part::Cylinder").
+            name: Object name (auto-generated if None).
+            properties: Initial property values.
+            doc_name: Target document (uses active if None).
+
+        Returns:
+            ObjectInfo for the created object.
+        """
+
+    @abstractmethod
+    async def edit_object(
+        self,
+        obj_name: str,
+        properties: dict[str, Any],
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Edit object properties.
+
+        Args:
+            obj_name: Name of the object to edit.
+            properties: Property values to set.
+            doc_name: Document name (uses active if None).
+
+        Returns:
+            Updated ObjectInfo.
+
+        Raises:
+            ValueError: If object not found.
+        """
+
+    @abstractmethod
+    async def delete_object(
+        self,
+        obj_name: str,
+        doc_name: str | None = None,
+    ) -> None:
+        """Delete an object.
+
+        Args:
+            obj_name: Name of the object to delete.
+            doc_name: Document name (uses active if None).
+
+        Raises:
+            ValueError: If object not found.
+        """
+
+    # =========================================================================
+    # View and Screenshot
+    # =========================================================================
+
+    @abstractmethod
+    async def get_screenshot(
+        self,
+        view_angle: ViewAngle | None = None,
+        width: int = 800,
+        height: int = 600,
+        doc_name: str | None = None,
+    ) -> ScreenshotResult:
+        """Capture a screenshot of the 3D view.
+
+        Args:
+            view_angle: View angle to set before capture.
+            width: Image width in pixels.
+            height: Image height in pixels.
+            doc_name: Document name (uses active if None).
+
+        Returns:
+            ScreenshotResult with image data or error.
+        """
+
+    @abstractmethod
+    async def set_view(
+        self,
+        view_angle: ViewAngle,
+        doc_name: str | None = None,
+    ) -> None:
+        """Set the 3D view angle.
+
+        Args:
+            view_angle: View angle to set.
+            doc_name: Document name (uses active if None).
+        """
+
+    # =========================================================================
+    # Macros
+    # =========================================================================
+
+    @abstractmethod
+    async def get_macros(self) -> list[MacroInfo]:
+        """Get list of available macros.
+
+        Returns:
+            List of MacroInfo for each macro.
+        """
+
+    @abstractmethod
+    async def run_macro(
+        self,
+        macro_name: str,
+        args: dict[str, Any] | None = None,
+    ) -> ExecutionResult:
+        """Run a macro by name.
+
+        Args:
+            macro_name: Macro name (without .FCMacro extension).
+            args: Arguments to pass to the macro.
+
+        Returns:
+            ExecutionResult from macro execution.
+        """
+
+    @abstractmethod
+    async def create_macro(
+        self,
+        name: str,
+        code: str,
+        description: str = "",
+    ) -> MacroInfo:
+        """Create a new macro.
+
+        Args:
+            name: Macro name (without extension).
+            code: Python code for the macro.
+            description: Macro description.
+
+        Returns:
+            MacroInfo for the created macro.
+        """
+
+    # =========================================================================
+    # Workbenches
+    # =========================================================================
+
+    @abstractmethod
+    async def get_workbenches(self) -> list[WorkbenchInfo]:
+        """Get list of available workbenches.
+
+        Returns:
+            List of WorkbenchInfo for each workbench.
+        """
+
+    @abstractmethod
+    async def activate_workbench(self, workbench_name: str) -> None:
+        """Activate a workbench.
+
+        Args:
+            workbench_name: Workbench internal name.
+
+        Raises:
+            ValueError: If workbench not found.
+        """
+
+    # =========================================================================
+    # Version and Environment
+    # =========================================================================
+
+    @abstractmethod
+    async def get_freecad_version(self) -> dict[str, Any]:
+        """Get FreeCAD version information.
+
+        Returns:
+            Dictionary with version, build_date, python_version, gui_available.
+        """
+
+    @abstractmethod
+    async def is_gui_available(self) -> bool:
+        """Check if FreeCAD GUI is available.
+
+        Returns:
+            True if GUI is available, False for headless mode.
+        """
+
+    # =========================================================================
+    # Console
+    # =========================================================================
+
+    @abstractmethod
+    async def get_console_output(self, lines: int = 100) -> list[str]:
+        """Get recent console output.
+
+        Args:
+            lines: Maximum number of lines to return.
+
+        Returns:
+            List of console output lines, most recent last.
+        """
+
Functions
activate_workbench(workbench_name) abstractmethod async

Activate a workbench.

Parameters:

Name Type Description Default
workbench_name str

Workbench internal name.

 required

Raises:

Type Description
ValueError

If workbench not found.
Source code in src/freecad_mcp/bridge/base.py 
567
+568
+569
+570
+571
+572
+573
+574
+575
+576
@abstractmethod
+async def activate_workbench(self, workbench_name: str) -> None:
+    """Activate a workbench.
+
+    Args:
+        workbench_name: Workbench internal name.
+
+    Raises:
+        ValueError: If workbench not found.
+    """
+
close_document(doc_name=None) abstractmethod async

Close a document.

Parameters:

Name Type Description Default
doc_name str | None

Document name (uses active if None).

 None
Source code in src/freecad_mcp/bridge/base.py 
373
+374
+375
+376
+377
+378
+379
@abstractmethod
+async def close_document(self, doc_name: str | None = None) -> None:
+    """Close a document.
+
+    Args:
+        doc_name: Document name (uses active if None).
+    """
+
connect() abstractmethod async

Establish connection to FreeCAD.

Raises:

Type Description
ConnectionError

If connection cannot be established.
Source code in src/freecad_mcp/bridge/base.py 
240
+241
+242
+243
+244
+245
+246
@abstractmethod
+async def connect(self) -> None:
+    """Establish connection to FreeCAD.
+
+    Raises:
+        ConnectionError: If connection cannot be established.
+    """
+
create_document(name, label=None) abstractmethod async

Create a new document.

Parameters:

Name Type Description Default
name str

Internal document name (no spaces).

 required
label str | None

Display label (optional, defaults to name).

 None

Returns:

Type Description
DocumentInfo

DocumentInfo for the created document.
Source code in src/freecad_mcp/bridge/base.py 
325
+326
+327
+328
+329
+330
+331
+332
+333
+334
+335
+336
+337
@abstractmethod
+async def create_document(
+    self, name: str, label: str | None = None
+) -> DocumentInfo:
+    """Create a new document.
+
+    Args:
+        name: Internal document name (no spaces).
+        label: Display label (optional, defaults to name).
+
+    Returns:
+        DocumentInfo for the created document.
+    """
+
create_macro(name, code, description='') abstractmethod async

Create a new macro.

Parameters:

Name Type Description Default
name str

Macro name (without extension).

 required
code str

Python code for the macro.

 required
description str

Macro description.

 ''

Returns:

Type Description
MacroInfo

MacroInfo for the created macro.
Source code in src/freecad_mcp/bridge/base.py 
537
+538
+539
+540
+541
+542
+543
+544
+545
+546
+547
+548
+549
+550
+551
+552
+553
@abstractmethod
+async def create_macro(
+    self,
+    name: str,
+    code: str,
+    description: str = "",
+) -> MacroInfo:
+    """Create a new macro.
+
+    Args:
+        name: Macro name (without extension).
+        code: Python code for the macro.
+        description: Macro description.
+
+    Returns:
+        MacroInfo for the created macro.
+    """
+
create_object(type_id, name=None, properties=None, doc_name=None) abstractmethod async

Create a new object.

Parameters:

Name Type Description Default
type_id str

FreeCAD type ID (e.g., "Part::Box", "Part::Cylinder").

 required
name str | None

Object name (auto-generated if None).

 None
properties dict[str, Any] | None

Initial property values.

 None
doc_name str | None

Target document (uses active if None).

 None

Returns:

Type Description
ObjectInfo

ObjectInfo for the created object.
Source code in src/freecad_mcp/bridge/base.py 
415
+416
+417
+418
+419
+420
+421
+422
+423
+424
+425
+426
+427
+428
+429
+430
+431
+432
+433
@abstractmethod
+async def create_object(
+    self,
+    type_id: str,
+    name: str | None = None,
+    properties: dict[str, Any] | None = None,
+    doc_name: str | None = None,
+) -> ObjectInfo:
+    """Create a new object.
+
+    Args:
+        type_id: FreeCAD type ID (e.g., "Part::Box", "Part::Cylinder").
+        name: Object name (auto-generated if None).
+        properties: Initial property values.
+        doc_name: Target document (uses active if None).
+
+    Returns:
+        ObjectInfo for the created object.
+    """
+
delete_object(obj_name, doc_name=None) abstractmethod async

Delete an object.

Parameters:

Name Type Description Default
obj_name str

Name of the object to delete.

 required
doc_name str | None

Document name (uses active if None).

 None

Raises:

Type Description
ValueError

If object not found.
Source code in src/freecad_mcp/bridge/base.py 
456
+457
+458
+459
+460
+461
+462
+463
+464
+465
+466
+467
+468
+469
+470
@abstractmethod
+async def delete_object(
+    self,
+    obj_name: str,
+    doc_name: str | None = None,
+) -> None:
+    """Delete an object.
+
+    Args:
+        obj_name: Name of the object to delete.
+        doc_name: Document name (uses active if None).
+
+    Raises:
+        ValueError: If object not found.
+    """
+
disconnect() abstractmethod async

Close connection to FreeCAD.

Should be called during cleanup to release resources.

Source code in src/freecad_mcp/bridge/base.py 
248
+249
+250
+251
+252
+253
@abstractmethod
+async def disconnect(self) -> None:
+    """Close connection to FreeCAD.
+
+    Should be called during cleanup to release resources.
+    """
+
edit_object(obj_name, properties, doc_name=None) abstractmethod async

Edit object properties.

Parameters:

Name Type Description Default
obj_name str

Name of the object to edit.

 required
properties dict[str, Any]

Property values to set.

 required
doc_name str | None

Document name (uses active if None).

 None

Returns:

Type Description
ObjectInfo

Updated ObjectInfo.

Raises:

Type Description
ValueError

If object not found.
Source code in src/freecad_mcp/bridge/base.py 
435
+436
+437
+438
+439
+440
+441
+442
+443
+444
+445
+446
+447
+448
+449
+450
+451
+452
+453
+454
@abstractmethod
+async def edit_object(
+    self,
+    obj_name: str,
+    properties: dict[str, Any],
+    doc_name: str | None = None,
+) -> ObjectInfo:
+    """Edit object properties.
+
+    Args:
+        obj_name: Name of the object to edit.
+        properties: Property values to set.
+        doc_name: Document name (uses active if None).
+
+    Returns:
+        Updated ObjectInfo.
+
+    Raises:
+        ValueError: If object not found.
+    """
+
execute_python(code, timeout_ms=30000) abstractmethod async

Execute Python code in FreeCAD context.

The code runs with access to FreeCAD modules (FreeCAD, App, Gui). To return a value, assign it to the _result_ variable.

Parameters:

Name Type Description Default
code str

Python code to execute.

 required
timeout_ms int

Maximum execution time in milliseconds.

 30000

Returns:

Type Description
ExecutionResult

ExecutionResult with success status, output, and any errors.
Source code in src/freecad_mcp/bridge/base.py 
286
+287
+288
+289
+290
+291
+292
+293
+294
+295
+296
+297
+298
+299
+300
+301
+302
+303
@abstractmethod
+async def execute_python(
+    self,
+    code: str,
+    timeout_ms: int = 30000,
+) -> ExecutionResult:
+    """Execute Python code in FreeCAD context.
+
+    The code runs with access to FreeCAD modules (FreeCAD, App, Gui).
+    To return a value, assign it to the `_result_` variable.
+
+    Args:
+        code: Python code to execute.
+        timeout_ms: Maximum execution time in milliseconds.
+
+    Returns:
+        ExecutionResult with success status, output, and any errors.
+    """
+
get_active_document() abstractmethod async

Get the active document.

Returns:

Type Description
DocumentInfo | None

DocumentInfo for active document, or None if no document is active.
Source code in src/freecad_mcp/bridge/base.py 
317
+318
+319
+320
+321
+322
+323
@abstractmethod
+async def get_active_document(self) -> DocumentInfo | None:
+    """Get the active document.
+
+    Returns:
+        DocumentInfo for active document, or None if no document is active.
+    """
+
get_console_output(lines=100) abstractmethod async

Get recent console output.

Parameters:

Name Type Description Default
lines int

Maximum number of lines to return.

 100

Returns:

Type Description
list[str]

List of console output lines, most recent last.
Source code in src/freecad_mcp/bridge/base.py 
602
+603
+604
+605
+606
+607
+608
+609
+610
+611
@abstractmethod
+async def get_console_output(self, lines: int = 100) -> list[str]:
+    """Get recent console output.
+
+    Args:
+        lines: Maximum number of lines to return.
+
+    Returns:
+        List of console output lines, most recent last.
+    """
+
get_documents() abstractmethod async

Get list of open documents.

Returns:

Type Description
list[DocumentInfo]

List of DocumentInfo for each open document.
Source code in src/freecad_mcp/bridge/base.py 
309
+310
+311
+312
+313
+314
+315
@abstractmethod
+async def get_documents(self) -> list[DocumentInfo]:
+    """Get list of open documents.
+
+    Returns:
+        List of DocumentInfo for each open document.
+    """
+
get_freecad_version() abstractmethod async

Get FreeCAD version information.

Returns:

Type Description
dict[str, Any]

Dictionary with version, build_date, python_version, gui_available.
Source code in src/freecad_mcp/bridge/base.py 
582
+583
+584
+585
+586
+587
+588
@abstractmethod
+async def get_freecad_version(self) -> dict[str, Any]:
+    """Get FreeCAD version information.
+
+    Returns:
+        Dictionary with version, build_date, python_version, gui_available.
+    """
+
get_macros() abstractmethod async

Get list of available macros.

Returns:

Type Description
list[MacroInfo]

List of MacroInfo for each macro.
Source code in src/freecad_mcp/bridge/base.py 
513
+514
+515
+516
+517
+518
+519
@abstractmethod
+async def get_macros(self) -> list[MacroInfo]:
+    """Get list of available macros.
+
+    Returns:
+        List of MacroInfo for each macro.
+    """
+
get_object(obj_name, doc_name=None) abstractmethod async

Get detailed object information.

Parameters:

Name Type Description Default
obj_name str

Name of the object.

 required
doc_name str | None

Document name (uses active if None).

 None

Returns:

Type Description
ObjectInfo

ObjectInfo with full object details.

Raises:

Type Description
ValueError

If object not found.
Source code in src/freecad_mcp/bridge/base.py 
396
+397
+398
+399
+400
+401
+402
+403
+404
+405
+406
+407
+408
+409
+410
+411
+412
+413
@abstractmethod
+async def get_object(
+    self,
+    obj_name: str,
+    doc_name: str | None = None,
+) -> ObjectInfo:
+    """Get detailed object information.
+
+    Args:
+        obj_name: Name of the object.
+        doc_name: Document name (uses active if None).
+
+    Returns:
+        ObjectInfo with full object details.
+
+    Raises:
+        ValueError: If object not found.
+    """
+
get_objects(doc_name=None) abstractmethod async

Get all objects in a document.

Parameters:

Name Type Description Default
doc_name str | None

Document name (uses active if None).

 None

Returns:

Type Description
list[ObjectInfo]

List of ObjectInfo for each object.
Source code in src/freecad_mcp/bridge/base.py 
385
+386
+387
+388
+389
+390
+391
+392
+393
+394
@abstractmethod
+async def get_objects(self, doc_name: str | None = None) -> list[ObjectInfo]:
+    """Get all objects in a document.
+
+    Args:
+        doc_name: Document name (uses active if None).
+
+    Returns:
+        List of ObjectInfo for each object.
+    """
+
get_screenshot(view_angle=None, width=800, height=600, doc_name=None) abstractmethod async

Capture a screenshot of the 3D view.

Parameters:

Name Type Description Default
view_angle ViewAngle | None

View angle to set before capture.

 None
width int

Image width in pixels.

 800
height int

Image height in pixels.

 600
doc_name str | None

Document name (uses active if None).

 None

Returns:

Type Description
ScreenshotResult

ScreenshotResult with image data or error.
Source code in src/freecad_mcp/bridge/base.py 
476
+477
+478
+479
+480
+481
+482
+483
+484
+485
+486
+487
+488
+489
+490
+491
+492
+493
+494
@abstractmethod
+async def get_screenshot(
+    self,
+    view_angle: ViewAngle | None = None,
+    width: int = 800,
+    height: int = 600,
+    doc_name: str | None = None,
+) -> ScreenshotResult:
+    """Capture a screenshot of the 3D view.
+
+    Args:
+        view_angle: View angle to set before capture.
+        width: Image width in pixels.
+        height: Image height in pixels.
+        doc_name: Document name (uses active if None).
+
+    Returns:
+        ScreenshotResult with image data or error.
+    """
+
get_status() abstractmethod async

Get detailed connection status.

Returns:

Type Description
ConnectionStatus

ConnectionStatus with full status information.
Source code in src/freecad_mcp/bridge/base.py 
274
+275
+276
+277
+278
+279
+280
@abstractmethod
+async def get_status(self) -> ConnectionStatus:
+    """Get detailed connection status.
+
+    Returns:
+        ConnectionStatus with full status information.
+    """
+
get_workbenches() abstractmethod async

Get list of available workbenches.

Returns:

Type Description
list[WorkbenchInfo]

List of WorkbenchInfo for each workbench.
Source code in src/freecad_mcp/bridge/base.py 
559
+560
+561
+562
+563
+564
+565
@abstractmethod
+async def get_workbenches(self) -> list[WorkbenchInfo]:
+    """Get list of available workbenches.
+
+    Returns:
+        List of WorkbenchInfo for each workbench.
+    """
+
is_connected() abstractmethod async

Check if bridge is connected to FreeCAD.

Returns:

Type Description
bool

True if connected, False otherwise.
Source code in src/freecad_mcp/bridge/base.py 
255
+256
+257
+258
+259
+260
+261
@abstractmethod
+async def is_connected(self) -> bool:
+    """Check if bridge is connected to FreeCAD.
+
+    Returns:
+        True if connected, False otherwise.
+    """
+
is_gui_available() abstractmethod async

Check if FreeCAD GUI is available.

Returns:

Type Description
bool

True if GUI is available, False for headless mode.
Source code in src/freecad_mcp/bridge/base.py 
590
+591
+592
+593
+594
+595
+596
@abstractmethod
+async def is_gui_available(self) -> bool:
+    """Check if FreeCAD GUI is available.
+
+    Returns:
+        True if GUI is available, False for headless mode.
+    """
+
open_document(path) abstractmethod async

Open an existing document.

Parameters:

Name Type Description Default
path str

Path to the .FCStd file.

 required

Returns:

Type Description
DocumentInfo

DocumentInfo for the opened document.

Raises:

Type Description
FileNotFoundError

If file doesn't exist.
ValueError

If file is not a valid FreeCAD document.
Source code in src/freecad_mcp/bridge/base.py 
339
+340
+341
+342
+343
+344
+345
+346
+347
+348
+349
+350
+351
+352
@abstractmethod
+async def open_document(self, path: str) -> DocumentInfo:
+    """Open an existing document.
+
+    Args:
+        path: Path to the .FCStd file.
+
+    Returns:
+        DocumentInfo for the opened document.
+
+    Raises:
+        FileNotFoundError: If file doesn't exist.
+        ValueError: If file is not a valid FreeCAD document.
+    """
+
ping() abstractmethod async

Ping FreeCAD to check connection and measure latency.

Returns:

Type Description
float

Round-trip time in milliseconds.

Raises:

Type Description
ConnectionError

If not connected.
Source code in src/freecad_mcp/bridge/base.py 
263
+264
+265
+266
+267
+268
+269
+270
+271
+272
@abstractmethod
+async def ping(self) -> float:
+    """Ping FreeCAD to check connection and measure latency.
+
+    Returns:
+        Round-trip time in milliseconds.
+
+    Raises:
+        ConnectionError: If not connected.
+    """
+
run_macro(macro_name, args=None) abstractmethod async

Run a macro by name.

Parameters:

Name Type Description Default
macro_name str

Macro name (without .FCMacro extension).

 required
args dict[str, Any] | None

Arguments to pass to the macro.

 None

Returns:

Type Description
ExecutionResult

ExecutionResult from macro execution.
Source code in src/freecad_mcp/bridge/base.py 
521
+522
+523
+524
+525
+526
+527
+528
+529
+530
+531
+532
+533
+534
+535
@abstractmethod
+async def run_macro(
+    self,
+    macro_name: str,
+    args: dict[str, Any] | None = None,
+) -> ExecutionResult:
+    """Run a macro by name.
+
+    Args:
+        macro_name: Macro name (without .FCMacro extension).
+        args: Arguments to pass to the macro.
+
+    Returns:
+        ExecutionResult from macro execution.
+    """
+
save_document(doc_name=None, path=None) abstractmethod async

Save a document.

Parameters:

Name Type Description Default
doc_name str | None

Document name (uses active if None).

 None
path str | None

Save path (uses existing path if None).

 None

Returns:

Type Description
str

Path where document was saved.

Raises:

Type Description
ValueError

If document not found or no path specified for new doc.
Source code in src/freecad_mcp/bridge/base.py 
354
+355
+356
+357
+358
+359
+360
+361
+362
+363
+364
+365
+366
+367
+368
+369
+370
+371
@abstractmethod
+async def save_document(
+    self,
+    doc_name: str | None = None,
+    path: str | None = None,
+) -> str:
+    """Save a document.
+
+    Args:
+        doc_name: Document name (uses active if None).
+        path: Save path (uses existing path if None).
+
+    Returns:
+        Path where document was saved.
+
+    Raises:
+        ValueError: If document not found or no path specified for new doc.
+    """
+
set_view(view_angle, doc_name=None) abstractmethod async

Set the 3D view angle.

Parameters:

Name Type Description Default
view_angle ViewAngle

View angle to set.

 required
doc_name str | None

Document name (uses active if None).

 None
Source code in src/freecad_mcp/bridge/base.py 
496
+497
+498
+499
+500
+501
+502
+503
+504
+505
+506
+507
@abstractmethod
+async def set_view(
+    self,
+    view_angle: ViewAngle,
+    doc_name: str | None = None,
+) -> None:
+    """Set the 3D view angle.
+
+    Args:
+        view_angle: View angle to set.
+        doc_name: Document name (uses active if None).
+    """
+

MacroInfo dataclass

Information about a FreeCAD macro.

Attributes:

Name Type Description
name str

Macro name (without extension).
path str

Full path to macro file.
description str

Macro description from comments.
is_system bool

Whether it's a system macro.
Source code in src/freecad_mcp/bridge/base.py 
172
+173
+174
+175
+176
+177
+178
+179
+180
+181
+182
+183
+184
+185
+186
@dataclass
+class MacroInfo:
+    """Information about a FreeCAD macro.
+
+    Attributes:
+        name: Macro name (without extension).
+        path: Full path to macro file.
+        description: Macro description from comments.
+        is_system: Whether it's a system macro.
+    """
+
+    name: str
+    path: str
+    description: str = ""
+    is_system: bool = False
+

ObjectInfo dataclass

Information about a FreeCAD object.

Attributes:

Name Type Description
name str

Object name (identifier).
label str

Display label.
type_id str

FreeCAD TypeId string (e.g., "Part::Box").
properties dict[str, Any]

Dictionary of property names to values.
shape_info dict[str, Any] | None

Shape geometry details if applicable.
children list[str]

List of child object names (OutList).
parents list[str]

List of parent object names (InList).
visibility bool

Whether object is visible in the view.
Source code in src/freecad_mcp/bridge/base.py 
 93
+ 94
+ 95
+ 96
+ 97
+ 98
+ 99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
@dataclass
+class ObjectInfo:
+    """Information about a FreeCAD object.
+
+    Attributes:
+        name: Object name (identifier).
+        label: Display label.
+        type_id: FreeCAD TypeId string (e.g., "Part::Box").
+        properties: Dictionary of property names to values.
+        shape_info: Shape geometry details if applicable.
+        children: List of child object names (OutList).
+        parents: List of parent object names (InList).
+        visibility: Whether object is visible in the view.
+    """
+
+    name: str
+    label: str
+    type_id: str
+    properties: dict[str, Any] = field(default_factory=dict)
+    shape_info: dict[str, Any] | None = None
+    children: list[str] = field(default_factory=list)
+    parents: list[str] = field(default_factory=list)
+    visibility: bool = True
+

ObjectType

Bases: str, Enum

FreeCAD object type categories.

Source code in src/freecad_mcp/bridge/base.py 
32
+33
+34
+35
+36
+37
+38
+39
+40
+41
class ObjectType(str, Enum):
+    """FreeCAD object type categories."""
+
+    PART = "Part"
+    PART_DESIGN = "PartDesign"
+    DRAFT = "Draft"
+    SKETCHER = "Sketcher"
+    FEM = "Fem"
+    MESH = "Mesh"
+    SPREADSHEET = "Spreadsheet"
+

ScreenshotResult dataclass

Result of a screenshot capture.

Attributes:

Name Type Description
success bool

Whether screenshot was captured successfully.
data str | None

Base64-encoded image data.
format str

Image format (png, jpg).
width int

Image width in pixels.
height int

Image height in pixels.
view_angle ViewAngle | None

The view angle used.
error str | None

Error message if failed.
Source code in src/freecad_mcp/bridge/base.py 
149
+150
+151
+152
+153
+154
+155
+156
+157
+158
+159
+160
+161
+162
+163
+164
+165
+166
+167
+168
+169
@dataclass
+class ScreenshotResult:
+    """Result of a screenshot capture.
+
+    Attributes:
+        success: Whether screenshot was captured successfully.
+        data: Base64-encoded image data.
+        format: Image format (png, jpg).
+        width: Image width in pixels.
+        height: Image height in pixels.
+        view_angle: The view angle used.
+        error: Error message if failed.
+    """
+
+    success: bool
+    data: str | None = None
+    format: str = "png"
+    width: int = 0
+    height: int = 0
+    view_angle: ViewAngle | None = None
+    error: str | None = None
+

ShapeInfo dataclass

Detailed shape geometry information.

Attributes:

Name Type Description
shape_type str

Type of shape (Solid, Shell, Face, etc.).
volume float | None

Volume of the shape (for solids).
area float | None

Surface area of the shape.
center_of_mass tuple[float, float, float] | None

Center of mass coordinates.
bounding_box tuple[tuple[float, float, float], tuple[float, float, float]] | None

Bounding box as (min, max) tuples.
is_valid bool

Whether the shape is geometrically valid.
is_closed bool

Whether the shape is closed.
vertex_count int

Number of vertices.
edge_count int

Number of edges.
face_count int

Number of faces.
Source code in src/freecad_mcp/bridge/base.py 
118
+119
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133
+134
+135
+136
+137
+138
+139
+140
+141
+142
+143
+144
+145
+146
@dataclass
+class ShapeInfo:
+    """Detailed shape geometry information.
+
+    Attributes:
+        shape_type: Type of shape (Solid, Shell, Face, etc.).
+        volume: Volume of the shape (for solids).
+        area: Surface area of the shape.
+        center_of_mass: Center of mass coordinates.
+        bounding_box: Bounding box as (min, max) tuples.
+        is_valid: Whether the shape is geometrically valid.
+        is_closed: Whether the shape is closed.
+        vertex_count: Number of vertices.
+        edge_count: Number of edges.
+        face_count: Number of faces.
+    """
+
+    shape_type: str
+    volume: float | None = None
+    area: float | None = None
+    center_of_mass: tuple[float, float, float] | None = None
+    bounding_box: (
+        tuple[tuple[float, float, float], tuple[float, float, float]] | None
+    ) = None
+    is_valid: bool = True
+    is_closed: bool = False
+    vertex_count: int = 0
+    edge_count: int = 0
+    face_count: int = 0
+

ViewAngle

Bases: str, Enum

Standard view angles for screenshots.

Source code in src/freecad_mcp/bridge/base.py 
19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
class ViewAngle(str, Enum):
+    """Standard view angles for screenshots."""
+
+    ISOMETRIC = "Isometric"
+    FRONT = "Front"
+    BACK = "Back"
+    TOP = "Top"
+    BOTTOM = "Bottom"
+    LEFT = "Left"
+    RIGHT = "Right"
+    FIT_ALL = "FitAll"
+

WorkbenchInfo dataclass

Information about a FreeCAD workbench.

Attributes:

Name Type Description
name str

Workbench internal name.
label str

Display label.
icon str

Icon resource path.
is_active bool

Whether workbench is currently active.
Source code in src/freecad_mcp/bridge/base.py 
189
+190
+191
+192
+193
+194
+195
+196
+197
+198
+199
+200
+201
+202
+203
@dataclass
+class WorkbenchInfo:
+    """Information about a FreeCAD workbench.
+
+    Attributes:
+        name: Workbench internal name.
+        label: Display label.
+        icon: Icon resource path.
+        is_active: Whether workbench is currently active.
+    """
+
+    name: str
+    label: str
+    icon: str = ""
+    is_active: bool = False
+

options: show_root_heading: true show_source: true

XML-RPC Bridge

freecad_mcp.bridge.xmlrpc

XML-RPC bridge for FreeCAD GUI mode communication.

This bridge connects to a FreeCAD instance running an XML-RPC server, allowing remote control while FreeCAD has its GUI open.

Compatible with neka-nat/freecad-mcp XML-RPC protocol, providing interoperability with existing FreeCAD Robust MCP addons.

Design inspired by neka-nat/freecad-mcp (MIT License): - Uses neka-nat's proven XML-RPC protocol (port 9875) - Connection health monitoring and auto-reconnect - Timeout handling for long operations

Attribution

The XML-RPC protocol design and port selection (9875) were inspired by neka-nat/freecad-mcp (https://github.com/neka-nat/freecad-mcp), which is licensed under the MIT License. This implementation is a complete rewrite that maintains protocol compatibility.

Classes

XmlRpcBridge

Bases: FreecadBridge

Bridge that communicates with FreeCAD via XML-RPC.

This bridge connects to a FreeCAD instance that is running the XML-RPC server addon. It provides full access to FreeCAD functionality including GUI operations like screenshots.

Attributes:

Name Type Description
host

XML-RPC server hostname.
port

XML-RPC server port.
timeout

Connection and request timeout in seconds.
Source code in src/freecad_mcp/bridge/xmlrpc.py 
  43
+  44
+  45
+  46
+  47
+  48
+  49
+  50
+  51
+  52
+  53
+  54
+  55
+  56
+  57
+  58
+  59
+  60
+  61
+  62
+  63
+  64
+  65
+  66
+  67
+  68
+  69
+  70
+  71
+  72
+  73
+  74
+  75
+  76
+  77
+  78
+  79
+  80
+  81
+  82
+  83
+  84
+  85
+  86
+  87
+  88
+  89
+  90
+  91
+  92
+  93
+  94
+  95
+  96
+  97
+  98
+  99
+ 100
+ 101
+ 102
+ 103
+ 104
+ 105
+ 106
+ 107
+ 108
+ 109
+ 110
+ 111
+ 112
+ 113
+ 114
+ 115
+ 116
+ 117
+ 118
+ 119
+ 120
+ 121
+ 122
+ 123
+ 124
+ 125
+ 126
+ 127
+ 128
+ 129
+ 130
+ 131
+ 132
+ 133
+ 134
+ 135
+ 136
+ 137
+ 138
+ 139
+ 140
+ 141
+ 142
+ 143
+ 144
+ 145
+ 146
+ 147
+ 148
+ 149
+ 150
+ 151
+ 152
+ 153
+ 154
+ 155
+ 156
+ 157
+ 158
+ 159
+ 160
+ 161
+ 162
+ 163
+ 164
+ 165
+ 166
+ 167
+ 168
+ 169
+ 170
+ 171
+ 172
+ 173
+ 174
+ 175
+ 176
+ 177
+ 178
+ 179
+ 180
+ 181
+ 182
+ 183
+ 184
+ 185
+ 186
+ 187
+ 188
+ 189
+ 190
+ 191
+ 192
+ 193
+ 194
+ 195
+ 196
+ 197
+ 198
+ 199
+ 200
+ 201
+ 202
+ 203
+ 204
+ 205
+ 206
+ 207
+ 208
+ 209
+ 210
+ 211
+ 212
+ 213
+ 214
+ 215
+ 216
+ 217
+ 218
+ 219
+ 220
+ 221
+ 222
+ 223
+ 224
+ 225
+ 226
+ 227
+ 228
+ 229
+ 230
+ 231
+ 232
+ 233
+ 234
+ 235
+ 236
+ 237
+ 238
+ 239
+ 240
+ 241
+ 242
+ 243
+ 244
+ 245
+ 246
+ 247
+ 248
+ 249
+ 250
+ 251
+ 252
+ 253
+ 254
+ 255
+ 256
+ 257
+ 258
+ 259
+ 260
+ 261
+ 262
+ 263
+ 264
+ 265
+ 266
+ 267
+ 268
+ 269
+ 270
+ 271
+ 272
+ 273
+ 274
+ 275
+ 276
+ 277
+ 278
+ 279
+ 280
+ 281
+ 282
+ 283
+ 284
+ 285
+ 286
+ 287
+ 288
+ 289
+ 290
+ 291
+ 292
+ 293
+ 294
+ 295
+ 296
+ 297
+ 298
+ 299
+ 300
+ 301
+ 302
+ 303
+ 304
+ 305
+ 306
+ 307
+ 308
+ 309
+ 310
+ 311
+ 312
+ 313
+ 314
+ 315
+ 316
+ 317
+ 318
+ 319
+ 320
+ 321
+ 322
+ 323
+ 324
+ 325
+ 326
+ 327
+ 328
+ 329
+ 330
+ 331
+ 332
+ 333
+ 334
+ 335
+ 336
+ 337
+ 338
+ 339
+ 340
+ 341
+ 342
+ 343
+ 344
+ 345
+ 346
+ 347
+ 348
+ 349
+ 350
+ 351
+ 352
+ 353
+ 354
+ 355
+ 356
+ 357
+ 358
+ 359
+ 360
+ 361
+ 362
+ 363
+ 364
+ 365
+ 366
+ 367
+ 368
+ 369
+ 370
+ 371
+ 372
+ 373
+ 374
+ 375
+ 376
+ 377
+ 378
+ 379
+ 380
+ 381
+ 382
+ 383
+ 384
+ 385
+ 386
+ 387
+ 388
+ 389
+ 390
+ 391
+ 392
+ 393
+ 394
+ 395
+ 396
+ 397
+ 398
+ 399
+ 400
+ 401
+ 402
+ 403
+ 404
+ 405
+ 406
+ 407
+ 408
+ 409
+ 410
+ 411
+ 412
+ 413
+ 414
+ 415
+ 416
+ 417
+ 418
+ 419
+ 420
+ 421
+ 422
+ 423
+ 424
+ 425
+ 426
+ 427
+ 428
+ 429
+ 430
+ 431
+ 432
+ 433
+ 434
+ 435
+ 436
+ 437
+ 438
+ 439
+ 440
+ 441
+ 442
+ 443
+ 444
+ 445
+ 446
+ 447
+ 448
+ 449
+ 450
+ 451
+ 452
+ 453
+ 454
+ 455
+ 456
+ 457
+ 458
+ 459
+ 460
+ 461
+ 462
+ 463
+ 464
+ 465
+ 466
+ 467
+ 468
+ 469
+ 470
+ 471
+ 472
+ 473
+ 474
+ 475
+ 476
+ 477
+ 478
+ 479
+ 480
+ 481
+ 482
+ 483
+ 484
+ 485
+ 486
+ 487
+ 488
+ 489
+ 490
+ 491
+ 492
+ 493
+ 494
+ 495
+ 496
+ 497
+ 498
+ 499
+ 500
+ 501
+ 502
+ 503
+ 504
+ 505
+ 506
+ 507
+ 508
+ 509
+ 510
+ 511
+ 512
+ 513
+ 514
+ 515
+ 516
+ 517
+ 518
+ 519
+ 520
+ 521
+ 522
+ 523
+ 524
+ 525
+ 526
+ 527
+ 528
+ 529
+ 530
+ 531
+ 532
+ 533
+ 534
+ 535
+ 536
+ 537
+ 538
+ 539
+ 540
+ 541
+ 542
+ 543
+ 544
+ 545
+ 546
+ 547
+ 548
+ 549
+ 550
+ 551
+ 552
+ 553
+ 554
+ 555
+ 556
+ 557
+ 558
+ 559
+ 560
+ 561
+ 562
+ 563
+ 564
+ 565
+ 566
+ 567
+ 568
+ 569
+ 570
+ 571
+ 572
+ 573
+ 574
+ 575
+ 576
+ 577
+ 578
+ 579
+ 580
+ 581
+ 582
+ 583
+ 584
+ 585
+ 586
+ 587
+ 588
+ 589
+ 590
+ 591
+ 592
+ 593
+ 594
+ 595
+ 596
+ 597
+ 598
+ 599
+ 600
+ 601
+ 602
+ 603
+ 604
+ 605
+ 606
+ 607
+ 608
+ 609
+ 610
+ 611
+ 612
+ 613
+ 614
+ 615
+ 616
+ 617
+ 618
+ 619
+ 620
+ 621
+ 622
+ 623
+ 624
+ 625
+ 626
+ 627
+ 628
+ 629
+ 630
+ 631
+ 632
+ 633
+ 634
+ 635
+ 636
+ 637
+ 638
+ 639
+ 640
+ 641
+ 642
+ 643
+ 644
+ 645
+ 646
+ 647
+ 648
+ 649
+ 650
+ 651
+ 652
+ 653
+ 654
+ 655
+ 656
+ 657
+ 658
+ 659
+ 660
+ 661
+ 662
+ 663
+ 664
+ 665
+ 666
+ 667
+ 668
+ 669
+ 670
+ 671
+ 672
+ 673
+ 674
+ 675
+ 676
+ 677
+ 678
+ 679
+ 680
+ 681
+ 682
+ 683
+ 684
+ 685
+ 686
+ 687
+ 688
+ 689
+ 690
+ 691
+ 692
+ 693
+ 694
+ 695
+ 696
+ 697
+ 698
+ 699
+ 700
+ 701
+ 702
+ 703
+ 704
+ 705
+ 706
+ 707
+ 708
+ 709
+ 710
+ 711
+ 712
+ 713
+ 714
+ 715
+ 716
+ 717
+ 718
+ 719
+ 720
+ 721
+ 722
+ 723
+ 724
+ 725
+ 726
+ 727
+ 728
+ 729
+ 730
+ 731
+ 732
+ 733
+ 734
+ 735
+ 736
+ 737
+ 738
+ 739
+ 740
+ 741
+ 742
+ 743
+ 744
+ 745
+ 746
+ 747
+ 748
+ 749
+ 750
+ 751
+ 752
+ 753
+ 754
+ 755
+ 756
+ 757
+ 758
+ 759
+ 760
+ 761
+ 762
+ 763
+ 764
+ 765
+ 766
+ 767
+ 768
+ 769
+ 770
+ 771
+ 772
+ 773
+ 774
+ 775
+ 776
+ 777
+ 778
+ 779
+ 780
+ 781
+ 782
+ 783
+ 784
+ 785
+ 786
+ 787
+ 788
+ 789
+ 790
+ 791
+ 792
+ 793
+ 794
+ 795
+ 796
+ 797
+ 798
+ 799
+ 800
+ 801
+ 802
+ 803
+ 804
+ 805
+ 806
+ 807
+ 808
+ 809
+ 810
+ 811
+ 812
+ 813
+ 814
+ 815
+ 816
+ 817
+ 818
+ 819
+ 820
+ 821
+ 822
+ 823
+ 824
+ 825
+ 826
+ 827
+ 828
+ 829
+ 830
+ 831
+ 832
+ 833
+ 834
+ 835
+ 836
+ 837
+ 838
+ 839
+ 840
+ 841
+ 842
+ 843
+ 844
+ 845
+ 846
+ 847
+ 848
+ 849
+ 850
+ 851
+ 852
+ 853
+ 854
+ 855
+ 856
+ 857
+ 858
+ 859
+ 860
+ 861
+ 862
+ 863
+ 864
+ 865
+ 866
+ 867
+ 868
+ 869
+ 870
+ 871
+ 872
+ 873
+ 874
+ 875
+ 876
+ 877
+ 878
+ 879
+ 880
+ 881
+ 882
+ 883
+ 884
+ 885
+ 886
+ 887
+ 888
+ 889
+ 890
+ 891
+ 892
+ 893
+ 894
+ 895
+ 896
+ 897
+ 898
+ 899
+ 900
+ 901
+ 902
+ 903
+ 904
+ 905
+ 906
+ 907
+ 908
+ 909
+ 910
+ 911
+ 912
+ 913
+ 914
+ 915
+ 916
+ 917
+ 918
+ 919
+ 920
+ 921
+ 922
+ 923
+ 924
+ 925
+ 926
+ 927
+ 928
+ 929
+ 930
+ 931
+ 932
+ 933
+ 934
+ 935
+ 936
+ 937
+ 938
+ 939
+ 940
+ 941
+ 942
+ 943
+ 944
+ 945
+ 946
+ 947
+ 948
+ 949
+ 950
+ 951
+ 952
+ 953
+ 954
+ 955
+ 956
+ 957
+ 958
+ 959
+ 960
+ 961
+ 962
+ 963
+ 964
+ 965
+ 966
+ 967
+ 968
+ 969
+ 970
+ 971
+ 972
+ 973
+ 974
+ 975
+ 976
+ 977
+ 978
+ 979
+ 980
+ 981
+ 982
+ 983
+ 984
+ 985
+ 986
+ 987
+ 988
+ 989
+ 990
+ 991
+ 992
+ 993
+ 994
+ 995
+ 996
+ 997
+ 998
+ 999
+1000
+1001
+1002
+1003
+1004
+1005
+1006
+1007
+1008
+1009
+1010
+1011
+1012
+1013
+1014
+1015
+1016
+1017
+1018
+1019
+1020
+1021
+1022
+1023
+1024
+1025
+1026
+1027
+1028
+1029
+1030
+1031
+1032
+1033
+1034
+1035
+1036
+1037
+1038
+1039
+1040
+1041
+1042
+1043
+1044
+1045
+1046
class XmlRpcBridge(FreecadBridge):
+    """Bridge that communicates with FreeCAD via XML-RPC.
+
+    This bridge connects to a FreeCAD instance that is running the
+    XML-RPC server addon. It provides full access to FreeCAD functionality
+    including GUI operations like screenshots.
+
+    Attributes:
+        host: XML-RPC server hostname.
+        port: XML-RPC server port.
+        timeout: Connection and request timeout in seconds.
+    """
+
+    def __init__(
+        self,
+        host: str = DEFAULT_XMLRPC_HOST,
+        port: int = DEFAULT_XMLRPC_PORT,
+        timeout: float = DEFAULT_TIMEOUT,
+    ) -> None:
+        """Initialize the XML-RPC bridge.
+
+        Args:
+            host: XML-RPC server hostname.
+            port: XML-RPC server port.
+            timeout: Connection and request timeout in seconds.
+        """
+        self._host = host
+        self._port = port
+        self._timeout = timeout
+        self._proxy: xmlrpc.client.ServerProxy | None = None
+        self._connected = False
+
+    @property
+    def _server_url(self) -> str:
+        """Get the XML-RPC server URL."""
+        return f"http://{self._host}:{self._port}"
+
+    async def connect(self) -> None:
+        """Establish connection to FreeCAD XML-RPC server.
+
+        Raises:
+            ConnectionError: If connection cannot be established.
+        """
+        loop = asyncio.get_event_loop()
+        try:
+            self._proxy = await loop.run_in_executor(
+                None,
+                lambda: xmlrpc.client.ServerProxy(
+                    self._server_url,
+                    allow_none=True,
+                ),
+            )
+            # Test connection with a ping
+            await self.ping()
+            self._connected = True
+        except ConnectionRefusedError as e:
+            self._connected = False
+            msg = self._get_connection_refused_message()
+            raise ConnectionError(msg) from e
+        except Exception as e:
+            self._connected = False
+            error_str = str(e)
+            if "Connection refused" in error_str or "Errno 61" in error_str:
+                msg = self._get_connection_refused_message()
+            else:
+                msg = f"Failed to connect to XML-RPC server at {self._server_url}: {e}"
+            raise ConnectionError(msg) from e
+
+    def _get_connection_refused_message(self) -> str:
+        """Get a helpful error message when connection is refused."""
+        return f"""
+================================================================================
+CONNECTION REFUSED: Cannot connect to FreeCAD at {self._server_url}
+
+The FreeCAD Robust MCP Bridge server is not running. To fix this:
+
+1. Start FreeCAD (the GUI application)
+
+2. Start the MCP bridge using one of these methods:
+
+   Option A: Using the Robust MCP Bridge Workbench (recommended)
+   - Install via FreeCAD Addon Manager: Tools → Addon Manager
+   - Search for "Robust MCP Bridge" and install
+   - Switch to the Robust MCP Bridge workbench
+   - Click "Start MCP Bridge" in the toolbar
+
+   Option B: From source (for developers)
+   - Run: just freecad::run-gui
+
+3. You should see: "MCP Bridge started!"
+   - XML-RPC: localhost:{self._port}
+   - Socket: localhost:9876
+
+4. Then restart your MCP client (e.g., restart Claude Code)
+================================================================================
+"""
+
+    async def disconnect(self) -> None:
+        """Close connection to FreeCAD XML-RPC server."""
+        self._proxy = None
+        self._connected = False
+
+    async def is_connected(self) -> bool:
+        """Check if bridge is connected to FreeCAD."""
+        if not self._connected or self._proxy is None:
+            return False
+
+        try:
+            await self.ping()
+            return True
+        except Exception:
+            self._connected = False
+            return False
+
+    async def ping(self) -> float:
+        """Ping FreeCAD to check connection and measure latency.
+
+        Returns:
+            Round-trip time in milliseconds.
+
+        Raises:
+            ConnectionError: If not connected.
+        """
+        if self._proxy is None:
+            msg = "Not connected to XML-RPC server"
+            raise ConnectionError(msg)
+
+        loop = asyncio.get_event_loop()
+        start = time.perf_counter()
+
+        try:
+            # Try standard system.listMethods or a simple execute
+            if self._proxy is None:
+                msg = "Not connected"
+                raise ConnectionError(msg)
+            proxy = self._proxy  # Local reference for lambda
+            await asyncio.wait_for(
+                loop.run_in_executor(
+                    None,
+                    lambda: proxy.execute("_result_ = True"),
+                ),
+                timeout=self._timeout,
+            )
+        except TimeoutError as e:
+            msg = "Ping timed out"
+            raise ConnectionError(msg) from e
+        except Exception as e:
+            msg = f"Ping failed: {e}"
+            raise ConnectionError(msg) from e
+
+        return (time.perf_counter() - start) * 1000
+
+    async def get_status(self) -> ConnectionStatus:
+        """Get detailed connection status.
+
+        Returns:
+            ConnectionStatus with full status information.
+        """
+        if not self._connected or self._proxy is None:
+            return ConnectionStatus(
+                connected=False,
+                mode="xmlrpc",
+                error="Not connected",
+            )
+
+        try:
+            ping_ms = await self.ping()
+            version_info = await self.get_freecad_version()
+            gui_available = await self.is_gui_available()
+
+            return ConnectionStatus(
+                connected=True,
+                mode="xmlrpc",
+                freecad_version=version_info.get("version", "unknown"),
+                gui_available=gui_available,
+                last_ping_ms=ping_ms,
+            )
+        except Exception as e:
+            return ConnectionStatus(
+                connected=False,
+                mode="xmlrpc",
+                error=str(e),
+            )
+
+    # =========================================================================
+    # Code Execution
+    # =========================================================================
+
+    async def execute_python(
+        self,
+        code: str,
+        timeout_ms: int = 30000,
+    ) -> ExecutionResult:
+        """Execute Python code in FreeCAD context via XML-RPC.
+
+        Args:
+            code: Python code to execute.
+            timeout_ms: Maximum execution time in milliseconds.
+
+        Returns:
+            ExecutionResult with execution outcome.
+        """
+        if self._proxy is None:
+            return ExecutionResult(
+                success=False,
+                result=None,
+                stdout="",
+                stderr="Not connected to XML-RPC server",
+                execution_time_ms=0,
+                error_type="ConnectionError",
+            )
+
+        loop = asyncio.get_event_loop()
+        start = time.perf_counter()
+        proxy = self._proxy  # Local reference for lambda
+
+        try:
+            result = await asyncio.wait_for(
+                loop.run_in_executor(
+                    None,
+                    lambda: proxy.execute(code),
+                ),
+                timeout=timeout_ms / 1000,
+            )
+            elapsed = (time.perf_counter() - start) * 1000
+
+            # Parse result from XML-RPC server
+            if isinstance(result, dict):
+                return ExecutionResult(
+                    success=result.get("success", False),
+                    result=result.get("result"),
+                    stdout=result.get("stdout", ""),
+                    stderr=result.get("stderr", ""),
+                    execution_time_ms=elapsed,
+                    error_type=result.get("error_type"),
+                    error_traceback=result.get("error_traceback"),
+                )
+            else:
+                # Simple result format
+                return ExecutionResult(
+                    success=True,
+                    result=result,
+                    stdout="",
+                    stderr="",
+                    execution_time_ms=elapsed,
+                )
+
+        except TimeoutError:
+            return ExecutionResult(
+                success=False,
+                result=None,
+                stdout="",
+                stderr=f"Execution timed out after {timeout_ms}ms",
+                execution_time_ms=float(timeout_ms),
+                error_type="TimeoutError",
+            )
+        except Exception as e:
+            elapsed = (time.perf_counter() - start) * 1000
+            return ExecutionResult(
+                success=False,
+                result=None,
+                stdout="",
+                stderr=str(e),
+                execution_time_ms=elapsed,
+                error_type=type(e).__name__,
+            )
+
+    # =========================================================================
+    # Document Management
+    # =========================================================================
+
+    async def get_documents(self) -> list[DocumentInfo]:
+        """Get list of open documents."""
+        result = await self.execute_python(
+            """
+_result_ = []
+for doc in FreeCAD.listDocuments().values():
+    _result_.append({
+        "name": doc.Name,
+        "label": doc.Label,
+        "path": doc.FileName or None,
+        "objects": [obj.Name for obj in doc.Objects],
+        "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+        "active_object": doc.ActiveObject.Name if doc.ActiveObject else None,
+    })
+"""
+        )
+
+        if result.success and result.result:
+            return [DocumentInfo(**doc) for doc in result.result]
+        return []
+
+    async def get_active_document(self) -> DocumentInfo | None:
+        """Get the active document."""
+        result = await self.execute_python(
+            """
+doc = FreeCAD.ActiveDocument
+if doc:
+    _result_ = {
+        "name": doc.Name,
+        "label": doc.Label,
+        "path": doc.FileName or None,
+        "objects": [obj.Name for obj in doc.Objects],
+        "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+        "active_object": doc.ActiveObject.Name if doc.ActiveObject else None,
+    }
+else:
+    _result_ = None
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+        return None
+
+    async def create_document(
+        self, name: str, label: str | None = None
+    ) -> DocumentInfo:
+        """Create a new document."""
+        label = label or name
+        result = await self.execute_python(
+            f"""
+doc = FreeCAD.newDocument({name!r})
+doc.Label = {label!r}
+_result_ = {{
+    "name": doc.Name,
+    "label": doc.Label,
+    "path": doc.FileName or None,
+    "objects": [],
+    "is_modified": False,
+}}
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create document"
+        raise ValueError(error_msg)
+
+    async def open_document(self, path: str) -> DocumentInfo:
+        """Open an existing document."""
+        result = await self.execute_python(
+            f"""
+import os
+if not os.path.exists({path!r}):
+    raise FileNotFoundError(f"File not found: {path!r}")
+
+doc = FreeCAD.openDocument({path!r})
+_result_ = {{
+    "name": doc.Name,
+    "label": doc.Label,
+    "path": doc.FileName or None,
+    "objects": [obj.Name for obj in doc.Objects],
+    "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+}}
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+
+        if "FileNotFoundError" in (result.error_type or ""):
+            raise FileNotFoundError(result.stderr)
+
+        error_msg = result.error_traceback or "Failed to open document"
+        raise ValueError(error_msg)
+
+    async def save_document(
+        self,
+        doc_name: str | None = None,
+        path: str | None = None,
+    ) -> str:
+        """Save a document."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No active document" if {doc_name!r} is None else f"Document not found: {doc_name!r}")
+
+save_path = {path!r} or doc.FileName
+if not save_path:
+    raise ValueError("No path specified for new document")
+
+doc.saveAs(save_path)
+_result_ = save_path
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return result.result
+
+        error_msg = result.error_traceback or "Failed to save document"
+        raise ValueError(error_msg)
+
+    async def close_document(self, doc_name: str | None = None) -> None:
+        """Close a document."""
+        code = f"""
+doc_name = {doc_name!r}
+if doc_name is None:
+    doc = FreeCAD.ActiveDocument
+    if doc:
+        doc_name = doc.Name
+    else:
+        raise ValueError("No active document")
+
+FreeCAD.closeDocument(doc_name)
+_result_ = True
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to close document"
+            raise ValueError(error_msg)
+
+    # =========================================================================
+    # Object Management
+    # =========================================================================
+
+    async def get_objects(self, doc_name: str | None = None) -> list[ObjectInfo]:
+        """Get all objects in a document."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+objects = []
+for obj in doc.Objects:
+    obj_info = {{
+        "name": obj.Name,
+        "label": obj.Label,
+        "type_id": obj.TypeId,
+        "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+        "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+        "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+    }}
+    objects.append(obj_info)
+
+_result_ = objects
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [ObjectInfo(**obj) for obj in result.result]
+        return []
+
+    async def get_object(
+        self,
+        obj_name: str,
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Get detailed object information."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+props = {{}}
+for prop in obj.PropertiesList:
+    try:
+        val = getattr(obj, prop)
+        if hasattr(val, '__class__') and val.__class__.__module__ != 'builtins':
+            val = str(val)
+        props[prop] = val
+    except Exception:
+        props[prop] = "<unreadable>"
+
+shape_info = None
+if hasattr(obj, "Shape"):
+    shape = obj.Shape
+    shape_info = {{
+        "shape_type": shape.ShapeType,
+        "volume": shape.Volume if hasattr(shape, "Volume") else None,
+        "area": shape.Area if hasattr(shape, "Area") else None,
+        "is_valid": shape.isValid(),
+        "is_closed": shape.isClosed() if hasattr(shape, "isClosed") else False,
+        "vertex_count": len(shape.Vertexes) if hasattr(shape, "Vertexes") else 0,
+        "edge_count": len(shape.Edges) if hasattr(shape, "Edges") else 0,
+        "face_count": len(shape.Faces) if hasattr(shape, "Faces") else 0,
+    }}
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "properties": props,
+    "shape_info": shape_info,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+    "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to get object"
+        raise ValueError(error_msg)
+
+    async def create_object(
+        self,
+        type_id: str,
+        name: str | None = None,
+        properties: dict[str, Any] | None = None,
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Create a new object."""
+        properties = properties or {}
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.addObject({type_id!r}, {name!r} or "")
+
+# Set properties
+for prop_name, prop_val in {properties!r}.items():
+    if hasattr(obj, prop_name):
+        setattr(obj, prop_name, prop_val)
+
+doc.recompute()
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "visibility": True,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create object"
+        raise ValueError(error_msg)
+
+    async def edit_object(
+        self,
+        obj_name: str,
+        properties: dict[str, Any],
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Edit object properties."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+# Set properties
+for prop_name, prop_val in {properties!r}.items():
+    if hasattr(obj, prop_name):
+        setattr(obj, prop_name, prop_val)
+
+doc.recompute()
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to edit object"
+        raise ValueError(error_msg)
+
+    async def delete_object(
+        self,
+        obj_name: str,
+        doc_name: str | None = None,
+    ) -> None:
+        """Delete an object."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+doc.removeObject({obj_name!r})
+_result_ = True
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to delete object"
+            raise ValueError(error_msg)
+
+    # =========================================================================
+    # View and Screenshot
+    # =========================================================================
+
+    async def get_screenshot(
+        self,
+        view_angle: ViewAngle | None = None,
+        width: int = 800,
+        height: int = 600,
+        doc_name: str | None = None,
+    ) -> ScreenshotResult:
+        """Capture a screenshot of the 3D view via XML-RPC."""
+        view_angle_str = view_angle.value if view_angle else "Isometric"
+        code = f"""
+import base64
+import tempfile
+import os
+
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+# Check if GUI is available
+if not FreeCAD.GuiUp:
+    raise RuntimeError("GUI not available")
+
+view = FreeCADGui.ActiveDocument.ActiveView
+if view is None:
+    raise ValueError("No active view")
+
+# Check if this is a 3D view (not TechDraw, Spreadsheet, etc.)
+view_type = view.__class__.__name__
+if view_type not in ["View3DInventor", "View3DInventorPy"]:
+    raise ValueError(f"Cannot capture screenshot from {{view_type}} view")
+
+# Set view angle
+view_type_str = {view_angle_str!r}
+if view_type_str == "FitAll":
+    view.fitAll()
+elif view_type_str == "Isometric":
+    view.viewIsometric()
+elif view_type_str == "Front":
+    view.viewFront()
+elif view_type_str == "Back":
+    view.viewRear()
+elif view_type_str == "Top":
+    view.viewTop()
+elif view_type_str == "Bottom":
+    view.viewBottom()
+elif view_type_str == "Left":
+    view.viewLeft()
+elif view_type_str == "Right":
+    view.viewRight()
+
+# Save to temp file and read
+with tempfile.NamedTemporaryFile(suffix=".png", delete=False) as f:
+    temp_path = f.name
+
+view.saveImage(temp_path, {width}, {height}, "Current")
+
+with open(temp_path, "rb") as f:
+    image_data = base64.b64encode(f.read()).decode("utf-8")
+
+os.unlink(temp_path)
+
+_result_ = {{
+    "success": True,
+    "data": image_data,
+    "format": "png",
+    "width": {width},
+    "height": {height},
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ScreenshotResult(
+                success=True,
+                data=result.result["data"],
+                format=result.result["format"],
+                width=result.result["width"],
+                height=result.result["height"],
+                view_angle=view_angle,
+            )
+
+        return ScreenshotResult(
+            success=False,
+            error=result.error_traceback
+            or result.stderr
+            or "Failed to capture screenshot",
+            width=width,
+            height=height,
+            view_angle=view_angle,
+        )
+
+    async def set_view(
+        self,
+        view_angle: ViewAngle,
+        doc_name: str | None = None,
+    ) -> None:
+        """Set the 3D view angle."""
+        view_angle_str = view_angle.value
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+if not FreeCAD.GuiUp:
+    _result_ = True  # Silently succeed in headless mode
+else:
+    view = FreeCADGui.ActiveDocument.ActiveView
+    if view is None:
+        raise ValueError("No active view")
+
+    view_type = {view_angle_str!r}
+    if view_type == "FitAll":
+        view.fitAll()
+    elif view_type == "Isometric":
+        view.viewIsometric()
+    elif view_type == "Front":
+        view.viewFront()
+    elif view_type == "Back":
+        view.viewRear()
+    elif view_type == "Top":
+        view.viewTop()
+    elif view_type == "Bottom":
+        view.viewBottom()
+    elif view_type == "Left":
+        view.viewLeft()
+    elif view_type == "Right":
+        view.viewRight()
+
+    _result_ = True
+"""
+        await self.execute_python(code)
+
+    # =========================================================================
+    # Macros
+    # =========================================================================
+
+    async def get_macros(self) -> list[MacroInfo]:
+        """Get list of available macros."""
+        code = """
+import os
+
+# Get macro paths
+macro_paths = []
+
+# User macro path
+user_path = FreeCAD.getUserMacroDir(True)
+if os.path.exists(user_path):
+    macro_paths.append(("user", user_path))
+
+# System macro path
+system_path = FreeCAD.getResourceDir() + "Macro"
+if os.path.exists(system_path):
+    macro_paths.append(("system", system_path))
+
+macros = []
+for source, path in macro_paths:
+    for filename in os.listdir(path):
+        if filename.endswith(".FCMacro"):
+            macro_file = os.path.join(path, filename)
+            description = ""
+            try:
+                with open(macro_file, "r") as f:
+                    for line in f:
+                        if line.startswith("#"):
+                            desc = line.lstrip("#").strip()
+                            if desc and not desc.startswith("!") and not desc.startswith("-*-"):
+                                description = desc
+                                break
+            except Exception:
+                pass
+
+            macros.append({
+                "name": filename[:-8],  # Remove .FCMacro
+                "path": macro_file,
+                "description": description,
+                "is_system": source == "system",
+            })
+
+_result_ = macros
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [MacroInfo(**m) for m in result.result]
+        return []
+
+    async def run_macro(
+        self,
+        macro_name: str,
+        args: dict[str, Any] | None = None,
+    ) -> ExecutionResult:
+        """Run a macro by name."""
+        args = args or {}
+        code = f"""
+import os
+
+# Find macro file
+macro_name = {macro_name!r}
+macro_file = None
+
+# Check user macros first
+user_path = FreeCAD.getUserMacroDir(True)
+user_macro = os.path.join(user_path, macro_name + ".FCMacro")
+if os.path.exists(user_macro):
+    macro_file = user_macro
+
+# Check system macros
+if not macro_file:
+    system_path = FreeCAD.getResourceDir() + "Macro"
+    system_macro = os.path.join(system_path, macro_name + ".FCMacro")
+    if os.path.exists(system_macro):
+        macro_file = system_macro
+
+if not macro_file:
+    raise FileNotFoundError(f"Macro not found: {{macro_name}}")
+
+# Set up arguments
+args = {args!r}
+for k, v in args.items():
+    exec(f"{{k}} = {{v!r}}")
+
+# Execute macro
+with open(macro_file, "r") as f:
+    macro_code = f.read()
+
+exec(macro_code)
+_result_ = True
+"""
+        return await self.execute_python(code)
+
+    async def create_macro(
+        self,
+        name: str,
+        code: str,
+        description: str = "",
+    ) -> MacroInfo:
+        """Create a new macro."""
+        create_code = f"""
+import os
+
+macro_path = FreeCAD.getUserMacroDir(True)
+os.makedirs(macro_path, exist_ok=True)
+
+macro_file = os.path.join(macro_path, {name!r} + ".FCMacro")
+
+header = ""
+if {description!r}:
+    header = f"# {description!r}\\n\\n"
+
+full_code = header + '''# -*- coding: utf-8 -*-
+# FreeCAD Macro: {name}
+# Created via MCP Bridge
+
+import FreeCAD
+import FreeCADGui
+
+''' + {code!r}
+
+with open(macro_file, "w") as f:
+    f.write(full_code)
+
+_result_ = {{
+    "name": {name!r},
+    "path": macro_file,
+    "description": {description!r},
+    "is_system": False,
+}}
+"""
+        result = await self.execute_python(create_code)
+
+        if result.success and result.result:
+            return MacroInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create macro"
+        raise ValueError(error_msg)
+
+    # =========================================================================
+    # Workbenches
+    # =========================================================================
+
+    async def get_workbenches(self) -> list[WorkbenchInfo]:
+        """Get list of available workbenches."""
+        code = """
+workbenches = []
+active_wb = FreeCADGui.activeWorkbench() if FreeCAD.GuiUp else None
+active_name = active_wb.__class__.__name__ if active_wb else None
+
+if FreeCAD.GuiUp:
+    for name in FreeCADGui.listWorkbenches():
+        wb = FreeCADGui.getWorkbench(name)
+        workbenches.append({
+            "name": name,
+            "label": wb.MenuText if hasattr(wb, "MenuText") else name,
+            "icon": wb.Icon if hasattr(wb, "Icon") else "",
+            "is_active": name == active_name,
+        })
+else:
+    # Return common workbenches for headless mode
+    common = ["StartWorkbench", "PartWorkbench", "PartDesignWorkbench",
+              "DraftWorkbench", "SketcherWorkbench", "MeshWorkbench"]
+    for name in common:
+        workbenches.append({
+            "name": name,
+            "label": name.replace("Workbench", ""),
+            "icon": "",
+            "is_active": False,
+        })
+
+_result_ = workbenches
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [WorkbenchInfo(**wb) for wb in result.result]
+        return []
+
+    async def activate_workbench(self, workbench_name: str) -> None:
+        """Activate a workbench."""
+        code = f"""
+if FreeCAD.GuiUp:
+    try:
+        FreeCADGui.activateWorkbench({workbench_name!r})
+        _result_ = True
+    except Exception as e:
+        raise ValueError(f"Failed to activate workbench: {{e}}")
+else:
+    _result_ = True  # Silently succeed in headless mode
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to activate workbench"
+            raise ValueError(error_msg)
+
+    # =========================================================================
+    # Version and Environment
+    # =========================================================================
+
+    async def get_freecad_version(self) -> dict[str, Any]:
+        """Get FreeCAD version information."""
+        code = """
+import sys
+_result_ = {
+    "version": ".".join(str(x) for x in FreeCAD.Version()[:3]),
+    "version_tuple": FreeCAD.Version()[:3],
+    "build_date": FreeCAD.Version()[3] if len(FreeCAD.Version()) > 3 else "unknown",
+    "python_version": sys.version,
+    "gui_available": FreeCAD.GuiUp,
+}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return result.result
+
+        return {
+            "version": "unknown",
+            "version_tuple": [],
+            "build_date": "unknown",
+            "python_version": "",
+            "gui_available": False,
+        }
+
+    async def is_gui_available(self) -> bool:
+        """Check if FreeCAD GUI is available."""
+        result = await self.execute_python("_result_ = FreeCAD.GuiUp")
+        return bool(result.success and result.result)
+
+    # =========================================================================
+    # Console
+    # =========================================================================
+
+    async def get_console_output(self, lines: int = 100) -> list[str]:
+        """Get recent console output."""
+        code = f"""
+# Try to get console output from FreeCAD
+output_lines = []
+
+# Try FreeCAD.Console if available
+if hasattr(FreeCAD, 'Console'):
+    console = FreeCAD.Console
+    if hasattr(console, 'GetLog'):
+        log = console.GetLog()
+        if log:
+            output_lines = log.split('\\n')[-{lines}:]
+
+_result_ = output_lines
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return result.result
+        return []
+
Functions
__init__(host=DEFAULT_XMLRPC_HOST, port=DEFAULT_XMLRPC_PORT, timeout=DEFAULT_TIMEOUT)

Initialize the XML-RPC bridge.

Parameters:

Name Type Description Default
host str

XML-RPC server hostname.

 DEFAULT_XMLRPC_HOST
port int

XML-RPC server port.

 DEFAULT_XMLRPC_PORT
timeout float

Connection and request timeout in seconds.

 DEFAULT_TIMEOUT
Source code in src/freecad_mcp/bridge/xmlrpc.py 
56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
def __init__(
+    self,
+    host: str = DEFAULT_XMLRPC_HOST,
+    port: int = DEFAULT_XMLRPC_PORT,
+    timeout: float = DEFAULT_TIMEOUT,
+) -> None:
+    """Initialize the XML-RPC bridge.
+
+    Args:
+        host: XML-RPC server hostname.
+        port: XML-RPC server port.
+        timeout: Connection and request timeout in seconds.
+    """
+    self._host = host
+    self._port = port
+    self._timeout = timeout
+    self._proxy: xmlrpc.client.ServerProxy | None = None
+    self._connected = False
+
activate_workbench(workbench_name) async

Activate a workbench.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
970
+971
+972
+973
+974
+975
+976
+977
+978
+979
+980
+981
+982
+983
+984
+985
+986
    async def activate_workbench(self, workbench_name: str) -> None:
+        """Activate a workbench."""
+        code = f"""
+if FreeCAD.GuiUp:
+    try:
+        FreeCADGui.activateWorkbench({workbench_name!r})
+        _result_ = True
+    except Exception as e:
+        raise ValueError(f"Failed to activate workbench: {{e}}")
+else:
+    _result_ = True  # Silently succeed in headless mode
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to activate workbench"
+            raise ValueError(error_msg)
+
close_document(doc_name=None) async

Close a document.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
437
+438
+439
+440
+441
+442
+443
+444
+445
+446
+447
+448
+449
+450
+451
+452
+453
+454
+455
    async def close_document(self, doc_name: str | None = None) -> None:
+        """Close a document."""
+        code = f"""
+doc_name = {doc_name!r}
+if doc_name is None:
+    doc = FreeCAD.ActiveDocument
+    if doc:
+        doc_name = doc.Name
+    else:
+        raise ValueError("No active document")
+
+FreeCAD.closeDocument(doc_name)
+_result_ = True
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to close document"
+            raise ValueError(error_msg)
+
connect() async

Establish connection to FreeCAD XML-RPC server.

Raises:

Type Description
ConnectionError

If connection cannot be established.
Source code in src/freecad_mcp/bridge/xmlrpc.py 
 80
+ 81
+ 82
+ 83
+ 84
+ 85
+ 86
+ 87
+ 88
+ 89
+ 90
+ 91
+ 92
+ 93
+ 94
+ 95
+ 96
+ 97
+ 98
+ 99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
async def connect(self) -> None:
+    """Establish connection to FreeCAD XML-RPC server.
+
+    Raises:
+        ConnectionError: If connection cannot be established.
+    """
+    loop = asyncio.get_event_loop()
+    try:
+        self._proxy = await loop.run_in_executor(
+            None,
+            lambda: xmlrpc.client.ServerProxy(
+                self._server_url,
+                allow_none=True,
+            ),
+        )
+        # Test connection with a ping
+        await self.ping()
+        self._connected = True
+    except ConnectionRefusedError as e:
+        self._connected = False
+        msg = self._get_connection_refused_message()
+        raise ConnectionError(msg) from e
+    except Exception as e:
+        self._connected = False
+        error_str = str(e)
+        if "Connection refused" in error_str or "Errno 61" in error_str:
+            msg = self._get_connection_refused_message()
+        else:
+            msg = f"Failed to connect to XML-RPC server at {self._server_url}: {e}"
+        raise ConnectionError(msg) from e
+
create_document(name, label=None) async

Create a new document.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
358
+359
+360
+361
+362
+363
+364
+365
+366
+367
+368
+369
+370
+371
+372
+373
+374
+375
+376
+377
+378
+379
+380
+381
    async def create_document(
+        self, name: str, label: str | None = None
+    ) -> DocumentInfo:
+        """Create a new document."""
+        label = label or name
+        result = await self.execute_python(
+            f"""
+doc = FreeCAD.newDocument({name!r})
+doc.Label = {label!r}
+_result_ = {{
+    "name": doc.Name,
+    "label": doc.Label,
+    "path": doc.FileName or None,
+    "objects": [],
+    "is_modified": False,
+}}
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create document"
+        raise ValueError(error_msg)
+
create_macro(name, code, description='') async

Create a new macro.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
884
+885
+886
+887
+888
+889
+890
+891
+892
+893
+894
+895
+896
+897
+898
+899
+900
+901
+902
+903
+904
+905
+906
+907
+908
+909
+910
+911
+912
+913
+914
+915
+916
+917
+918
+919
+920
+921
+922
+923
+924
+925
+926
+927
+928
    async def create_macro(
+        self,
+        name: str,
+        code: str,
+        description: str = "",
+    ) -> MacroInfo:
+        """Create a new macro."""
+        create_code = f"""
+import os
+
+macro_path = FreeCAD.getUserMacroDir(True)
+os.makedirs(macro_path, exist_ok=True)
+
+macro_file = os.path.join(macro_path, {name!r} + ".FCMacro")
+
+header = ""
+if {description!r}:
+    header = f"# {description!r}\\n\\n"
+
+full_code = header + '''# -*- coding: utf-8 -*-
+# FreeCAD Macro: {name}
+# Created via MCP Bridge
+
+import FreeCAD
+import FreeCADGui
+
+''' + {code!r}
+
+with open(macro_file, "w") as f:
+    f.write(full_code)
+
+_result_ = {{
+    "name": {name!r},
+    "path": macro_file,
+    "description": {description!r},
+    "is_system": False,
+}}
+"""
+        result = await self.execute_python(create_code)
+
+        if result.success and result.result:
+            return MacroInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create macro"
+        raise ValueError(error_msg)
+
create_object(type_id, name=None, properties=None, doc_name=None) async

Create a new object.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
546
+547
+548
+549
+550
+551
+552
+553
+554
+555
+556
+557
+558
+559
+560
+561
+562
+563
+564
+565
+566
+567
+568
+569
+570
+571
+572
+573
+574
+575
+576
+577
+578
+579
+580
+581
+582
+583
+584
    async def create_object(
+        self,
+        type_id: str,
+        name: str | None = None,
+        properties: dict[str, Any] | None = None,
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Create a new object."""
+        properties = properties or {}
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.addObject({type_id!r}, {name!r} or "")
+
+# Set properties
+for prop_name, prop_val in {properties!r}.items():
+    if hasattr(obj, prop_name):
+        setattr(obj, prop_name, prop_val)
+
+doc.recompute()
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "visibility": True,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create object"
+        raise ValueError(error_msg)
+
delete_object(obj_name, doc_name=None) async

Delete an object.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
626
+627
+628
+629
+630
+631
+632
+633
+634
+635
+636
+637
+638
+639
+640
+641
+642
+643
+644
+645
+646
+647
+648
    async def delete_object(
+        self,
+        obj_name: str,
+        doc_name: str | None = None,
+    ) -> None:
+        """Delete an object."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+doc.removeObject({obj_name!r})
+_result_ = True
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to delete object"
+            raise ValueError(error_msg)
+
disconnect() async

Close connection to FreeCAD XML-RPC server.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
140
+141
+142
+143
async def disconnect(self) -> None:
+    """Close connection to FreeCAD XML-RPC server."""
+    self._proxy = None
+    self._connected = False
+
edit_object(obj_name, properties, doc_name=None) async

Edit object properties.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
586
+587
+588
+589
+590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
+608
+609
+610
+611
+612
+613
+614
+615
+616
+617
+618
+619
+620
+621
+622
+623
+624
    async def edit_object(
+        self,
+        obj_name: str,
+        properties: dict[str, Any],
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Edit object properties."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+# Set properties
+for prop_name, prop_val in {properties!r}.items():
+    if hasattr(obj, prop_name):
+        setattr(obj, prop_name, prop_val)
+
+doc.recompute()
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to edit object"
+        raise ValueError(error_msg)
+
execute_python(code, timeout_ms=30000) async

Execute Python code in FreeCAD context via XML-RPC.

Parameters:

Name Type Description Default
code str

Python code to execute.

 required
timeout_ms int

Maximum execution time in milliseconds.

 30000

Returns:

Type Description
ExecutionResult

ExecutionResult with execution outcome.
Source code in src/freecad_mcp/bridge/xmlrpc.py 
231
+232
+233
+234
+235
+236
+237
+238
+239
+240
+241
+242
+243
+244
+245
+246
+247
+248
+249
+250
+251
+252
+253
+254
+255
+256
+257
+258
+259
+260
+261
+262
+263
+264
+265
+266
+267
+268
+269
+270
+271
+272
+273
+274
+275
+276
+277
+278
+279
+280
+281
+282
+283
+284
+285
+286
+287
+288
+289
+290
+291
+292
+293
+294
+295
+296
+297
+298
+299
+300
+301
+302
+303
+304
+305
+306
+307
+308
async def execute_python(
+    self,
+    code: str,
+    timeout_ms: int = 30000,
+) -> ExecutionResult:
+    """Execute Python code in FreeCAD context via XML-RPC.
+
+    Args:
+        code: Python code to execute.
+        timeout_ms: Maximum execution time in milliseconds.
+
+    Returns:
+        ExecutionResult with execution outcome.
+    """
+    if self._proxy is None:
+        return ExecutionResult(
+            success=False,
+            result=None,
+            stdout="",
+            stderr="Not connected to XML-RPC server",
+            execution_time_ms=0,
+            error_type="ConnectionError",
+        )
+
+    loop = asyncio.get_event_loop()
+    start = time.perf_counter()
+    proxy = self._proxy  # Local reference for lambda
+
+    try:
+        result = await asyncio.wait_for(
+            loop.run_in_executor(
+                None,
+                lambda: proxy.execute(code),
+            ),
+            timeout=timeout_ms / 1000,
+        )
+        elapsed = (time.perf_counter() - start) * 1000
+
+        # Parse result from XML-RPC server
+        if isinstance(result, dict):
+            return ExecutionResult(
+                success=result.get("success", False),
+                result=result.get("result"),
+                stdout=result.get("stdout", ""),
+                stderr=result.get("stderr", ""),
+                execution_time_ms=elapsed,
+                error_type=result.get("error_type"),
+                error_traceback=result.get("error_traceback"),
+            )
+        else:
+            # Simple result format
+            return ExecutionResult(
+                success=True,
+                result=result,
+                stdout="",
+                stderr="",
+                execution_time_ms=elapsed,
+            )
+
+    except TimeoutError:
+        return ExecutionResult(
+            success=False,
+            result=None,
+            stdout="",
+            stderr=f"Execution timed out after {timeout_ms}ms",
+            execution_time_ms=float(timeout_ms),
+            error_type="TimeoutError",
+        )
+    except Exception as e:
+        elapsed = (time.perf_counter() - start) * 1000
+        return ExecutionResult(
+            success=False,
+            result=None,
+            stdout="",
+            stderr=str(e),
+            execution_time_ms=elapsed,
+            error_type=type(e).__name__,
+        )
+
get_active_document() async

Get the active document.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
335
+336
+337
+338
+339
+340
+341
+342
+343
+344
+345
+346
+347
+348
+349
+350
+351
+352
+353
+354
+355
+356
    async def get_active_document(self) -> DocumentInfo | None:
+        """Get the active document."""
+        result = await self.execute_python(
+            """
+doc = FreeCAD.ActiveDocument
+if doc:
+    _result_ = {
+        "name": doc.Name,
+        "label": doc.Label,
+        "path": doc.FileName or None,
+        "objects": [obj.Name for obj in doc.Objects],
+        "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+        "active_object": doc.ActiveObject.Name if doc.ActiveObject else None,
+    }
+else:
+    _result_ = None
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+        return None
+
get_console_output(lines=100) async

Get recent console output.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
1026
+1027
+1028
+1029
+1030
+1031
+1032
+1033
+1034
+1035
+1036
+1037
+1038
+1039
+1040
+1041
+1042
+1043
+1044
+1045
+1046
    async def get_console_output(self, lines: int = 100) -> list[str]:
+        """Get recent console output."""
+        code = f"""
+# Try to get console output from FreeCAD
+output_lines = []
+
+# Try FreeCAD.Console if available
+if hasattr(FreeCAD, 'Console'):
+    console = FreeCAD.Console
+    if hasattr(console, 'GetLog'):
+        log = console.GetLog()
+        if log:
+            output_lines = log.split('\\n')[-{lines}:]
+
+_result_ = output_lines
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return result.result
+        return []
+
get_documents() async

Get list of open documents.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
314
+315
+316
+317
+318
+319
+320
+321
+322
+323
+324
+325
+326
+327
+328
+329
+330
+331
+332
+333
    async def get_documents(self) -> list[DocumentInfo]:
+        """Get list of open documents."""
+        result = await self.execute_python(
+            """
+_result_ = []
+for doc in FreeCAD.listDocuments().values():
+    _result_.append({
+        "name": doc.Name,
+        "label": doc.Label,
+        "path": doc.FileName or None,
+        "objects": [obj.Name for obj in doc.Objects],
+        "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+        "active_object": doc.ActiveObject.Name if doc.ActiveObject else None,
+    })
+"""
+        )
+
+        if result.success and result.result:
+            return [DocumentInfo(**doc) for doc in result.result]
+        return []
+
get_freecad_version() async

Get FreeCAD version information.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
 992
+ 993
+ 994
+ 995
+ 996
+ 997
+ 998
+ 999
+1000
+1001
+1002
+1003
+1004
+1005
+1006
+1007
+1008
+1009
+1010
+1011
+1012
+1013
+1014
+1015
    async def get_freecad_version(self) -> dict[str, Any]:
+        """Get FreeCAD version information."""
+        code = """
+import sys
+_result_ = {
+    "version": ".".join(str(x) for x in FreeCAD.Version()[:3]),
+    "version_tuple": FreeCAD.Version()[:3],
+    "build_date": FreeCAD.Version()[3] if len(FreeCAD.Version()) > 3 else "unknown",
+    "python_version": sys.version,
+    "gui_available": FreeCAD.GuiUp,
+}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return result.result
+
+        return {
+            "version": "unknown",
+            "version_tuple": [],
+            "build_date": "unknown",
+            "python_version": "",
+            "gui_available": False,
+        }
+
get_macros() async

Get list of available macros.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
790
+791
+792
+793
+794
+795
+796
+797
+798
+799
+800
+801
+802
+803
+804
+805
+806
+807
+808
+809
+810
+811
+812
+813
+814
+815
+816
+817
+818
+819
+820
+821
+822
+823
+824
+825
+826
+827
+828
+829
+830
+831
+832
+833
+834
+835
+836
+837
+838
    async def get_macros(self) -> list[MacroInfo]:
+        """Get list of available macros."""
+        code = """
+import os
+
+# Get macro paths
+macro_paths = []
+
+# User macro path
+user_path = FreeCAD.getUserMacroDir(True)
+if os.path.exists(user_path):
+    macro_paths.append(("user", user_path))
+
+# System macro path
+system_path = FreeCAD.getResourceDir() + "Macro"
+if os.path.exists(system_path):
+    macro_paths.append(("system", system_path))
+
+macros = []
+for source, path in macro_paths:
+    for filename in os.listdir(path):
+        if filename.endswith(".FCMacro"):
+            macro_file = os.path.join(path, filename)
+            description = ""
+            try:
+                with open(macro_file, "r") as f:
+                    for line in f:
+                        if line.startswith("#"):
+                            desc = line.lstrip("#").strip()
+                            if desc and not desc.startswith("!") and not desc.startswith("-*-"):
+                                description = desc
+                                break
+            except Exception:
+                pass
+
+            macros.append({
+                "name": filename[:-8],  # Remove .FCMacro
+                "path": macro_file,
+                "description": description,
+                "is_system": source == "system",
+            })
+
+_result_ = macros
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [MacroInfo(**m) for m in result.result]
+        return []
+
get_object(obj_name, doc_name=None) async

Get detailed object information.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
488
+489
+490
+491
+492
+493
+494
+495
+496
+497
+498
+499
+500
+501
+502
+503
+504
+505
+506
+507
+508
+509
+510
+511
+512
+513
+514
+515
+516
+517
+518
+519
+520
+521
+522
+523
+524
+525
+526
+527
+528
+529
+530
+531
+532
+533
+534
+535
+536
+537
+538
+539
+540
+541
+542
+543
+544
    async def get_object(
+        self,
+        obj_name: str,
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Get detailed object information."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+props = {{}}
+for prop in obj.PropertiesList:
+    try:
+        val = getattr(obj, prop)
+        if hasattr(val, '__class__') and val.__class__.__module__ != 'builtins':
+            val = str(val)
+        props[prop] = val
+    except Exception:
+        props[prop] = "<unreadable>"
+
+shape_info = None
+if hasattr(obj, "Shape"):
+    shape = obj.Shape
+    shape_info = {{
+        "shape_type": shape.ShapeType,
+        "volume": shape.Volume if hasattr(shape, "Volume") else None,
+        "area": shape.Area if hasattr(shape, "Area") else None,
+        "is_valid": shape.isValid(),
+        "is_closed": shape.isClosed() if hasattr(shape, "isClosed") else False,
+        "vertex_count": len(shape.Vertexes) if hasattr(shape, "Vertexes") else 0,
+        "edge_count": len(shape.Edges) if hasattr(shape, "Edges") else 0,
+        "face_count": len(shape.Faces) if hasattr(shape, "Faces") else 0,
+    }}
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "properties": props,
+    "shape_info": shape_info,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+    "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to get object"
+        raise ValueError(error_msg)
+
get_objects(doc_name=None) async

Get all objects in a document.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
461
+462
+463
+464
+465
+466
+467
+468
+469
+470
+471
+472
+473
+474
+475
+476
+477
+478
+479
+480
+481
+482
+483
+484
+485
+486
    async def get_objects(self, doc_name: str | None = None) -> list[ObjectInfo]:
+        """Get all objects in a document."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+objects = []
+for obj in doc.Objects:
+    obj_info = {{
+        "name": obj.Name,
+        "label": obj.Label,
+        "type_id": obj.TypeId,
+        "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+        "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+        "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+    }}
+    objects.append(obj_info)
+
+_result_ = objects
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [ObjectInfo(**obj) for obj in result.result]
+        return []
+
get_screenshot(view_angle=None, width=800, height=600, doc_name=None) async

Capture a screenshot of the 3D view via XML-RPC.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
654
+655
+656
+657
+658
+659
+660
+661
+662
+663
+664
+665
+666
+667
+668
+669
+670
+671
+672
+673
+674
+675
+676
+677
+678
+679
+680
+681
+682
+683
+684
+685
+686
+687
+688
+689
+690
+691
+692
+693
+694
+695
+696
+697
+698
+699
+700
+701
+702
+703
+704
+705
+706
+707
+708
+709
+710
+711
+712
+713
+714
+715
+716
+717
+718
+719
+720
+721
+722
+723
+724
+725
+726
+727
+728
+729
+730
+731
+732
+733
+734
+735
+736
+737
+738
+739
+740
+741
+742
+743
    async def get_screenshot(
+        self,
+        view_angle: ViewAngle | None = None,
+        width: int = 800,
+        height: int = 600,
+        doc_name: str | None = None,
+    ) -> ScreenshotResult:
+        """Capture a screenshot of the 3D view via XML-RPC."""
+        view_angle_str = view_angle.value if view_angle else "Isometric"
+        code = f"""
+import base64
+import tempfile
+import os
+
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+# Check if GUI is available
+if not FreeCAD.GuiUp:
+    raise RuntimeError("GUI not available")
+
+view = FreeCADGui.ActiveDocument.ActiveView
+if view is None:
+    raise ValueError("No active view")
+
+# Check if this is a 3D view (not TechDraw, Spreadsheet, etc.)
+view_type = view.__class__.__name__
+if view_type not in ["View3DInventor", "View3DInventorPy"]:
+    raise ValueError(f"Cannot capture screenshot from {{view_type}} view")
+
+# Set view angle
+view_type_str = {view_angle_str!r}
+if view_type_str == "FitAll":
+    view.fitAll()
+elif view_type_str == "Isometric":
+    view.viewIsometric()
+elif view_type_str == "Front":
+    view.viewFront()
+elif view_type_str == "Back":
+    view.viewRear()
+elif view_type_str == "Top":
+    view.viewTop()
+elif view_type_str == "Bottom":
+    view.viewBottom()
+elif view_type_str == "Left":
+    view.viewLeft()
+elif view_type_str == "Right":
+    view.viewRight()
+
+# Save to temp file and read
+with tempfile.NamedTemporaryFile(suffix=".png", delete=False) as f:
+    temp_path = f.name
+
+view.saveImage(temp_path, {width}, {height}, "Current")
+
+with open(temp_path, "rb") as f:
+    image_data = base64.b64encode(f.read()).decode("utf-8")
+
+os.unlink(temp_path)
+
+_result_ = {{
+    "success": True,
+    "data": image_data,
+    "format": "png",
+    "width": {width},
+    "height": {height},
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ScreenshotResult(
+                success=True,
+                data=result.result["data"],
+                format=result.result["format"],
+                width=result.result["width"],
+                height=result.result["height"],
+                view_angle=view_angle,
+            )
+
+        return ScreenshotResult(
+            success=False,
+            error=result.error_traceback
+            or result.stderr
+            or "Failed to capture screenshot",
+            width=width,
+            height=height,
+            view_angle=view_angle,
+        )
+
get_status() async

Get detailed connection status.

Returns:

Type Description
ConnectionStatus

ConnectionStatus with full status information.
Source code in src/freecad_mcp/bridge/xmlrpc.py 
195
+196
+197
+198
+199
+200
+201
+202
+203
+204
+205
+206
+207
+208
+209
+210
+211
+212
+213
+214
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
async def get_status(self) -> ConnectionStatus:
+    """Get detailed connection status.
+
+    Returns:
+        ConnectionStatus with full status information.
+    """
+    if not self._connected or self._proxy is None:
+        return ConnectionStatus(
+            connected=False,
+            mode="xmlrpc",
+            error="Not connected",
+        )
+
+    try:
+        ping_ms = await self.ping()
+        version_info = await self.get_freecad_version()
+        gui_available = await self.is_gui_available()
+
+        return ConnectionStatus(
+            connected=True,
+            mode="xmlrpc",
+            freecad_version=version_info.get("version", "unknown"),
+            gui_available=gui_available,
+            last_ping_ms=ping_ms,
+        )
+    except Exception as e:
+        return ConnectionStatus(
+            connected=False,
+            mode="xmlrpc",
+            error=str(e),
+        )
+
get_workbenches() async

Get list of available workbenches.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
934
+935
+936
+937
+938
+939
+940
+941
+942
+943
+944
+945
+946
+947
+948
+949
+950
+951
+952
+953
+954
+955
+956
+957
+958
+959
+960
+961
+962
+963
+964
+965
+966
+967
+968
    async def get_workbenches(self) -> list[WorkbenchInfo]:
+        """Get list of available workbenches."""
+        code = """
+workbenches = []
+active_wb = FreeCADGui.activeWorkbench() if FreeCAD.GuiUp else None
+active_name = active_wb.__class__.__name__ if active_wb else None
+
+if FreeCAD.GuiUp:
+    for name in FreeCADGui.listWorkbenches():
+        wb = FreeCADGui.getWorkbench(name)
+        workbenches.append({
+            "name": name,
+            "label": wb.MenuText if hasattr(wb, "MenuText") else name,
+            "icon": wb.Icon if hasattr(wb, "Icon") else "",
+            "is_active": name == active_name,
+        })
+else:
+    # Return common workbenches for headless mode
+    common = ["StartWorkbench", "PartWorkbench", "PartDesignWorkbench",
+              "DraftWorkbench", "SketcherWorkbench", "MeshWorkbench"]
+    for name in common:
+        workbenches.append({
+            "name": name,
+            "label": name.replace("Workbench", ""),
+            "icon": "",
+            "is_active": False,
+        })
+
+_result_ = workbenches
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [WorkbenchInfo(**wb) for wb in result.result]
+        return []
+
is_connected() async

Check if bridge is connected to FreeCAD.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
145
+146
+147
+148
+149
+150
+151
+152
+153
+154
+155
async def is_connected(self) -> bool:
+    """Check if bridge is connected to FreeCAD."""
+    if not self._connected or self._proxy is None:
+        return False
+
+    try:
+        await self.ping()
+        return True
+    except Exception:
+        self._connected = False
+        return False
+
is_gui_available() async

Check if FreeCAD GUI is available.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
1017
+1018
+1019
+1020
async def is_gui_available(self) -> bool:
+    """Check if FreeCAD GUI is available."""
+    result = await self.execute_python("_result_ = FreeCAD.GuiUp")
+    return bool(result.success and result.result)
+
open_document(path) async

Open an existing document.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
383
+384
+385
+386
+387
+388
+389
+390
+391
+392
+393
+394
+395
+396
+397
+398
+399
+400
+401
+402
+403
+404
+405
+406
+407
+408
+409
    async def open_document(self, path: str) -> DocumentInfo:
+        """Open an existing document."""
+        result = await self.execute_python(
+            f"""
+import os
+if not os.path.exists({path!r}):
+    raise FileNotFoundError(f"File not found: {path!r}")
+
+doc = FreeCAD.openDocument({path!r})
+_result_ = {{
+    "name": doc.Name,
+    "label": doc.Label,
+    "path": doc.FileName or None,
+    "objects": [obj.Name for obj in doc.Objects],
+    "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+}}
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+
+        if "FileNotFoundError" in (result.error_type or ""):
+            raise FileNotFoundError(result.stderr)
+
+        error_msg = result.error_traceback or "Failed to open document"
+        raise ValueError(error_msg)
+
ping() async

Ping FreeCAD to check connection and measure latency.

Returns:

Type Description
float

Round-trip time in milliseconds.

Raises:

Type Description
ConnectionError

If not connected.
Source code in src/freecad_mcp/bridge/xmlrpc.py 
157
+158
+159
+160
+161
+162
+163
+164
+165
+166
+167
+168
+169
+170
+171
+172
+173
+174
+175
+176
+177
+178
+179
+180
+181
+182
+183
+184
+185
+186
+187
+188
+189
+190
+191
+192
+193
async def ping(self) -> float:
+    """Ping FreeCAD to check connection and measure latency.
+
+    Returns:
+        Round-trip time in milliseconds.
+
+    Raises:
+        ConnectionError: If not connected.
+    """
+    if self._proxy is None:
+        msg = "Not connected to XML-RPC server"
+        raise ConnectionError(msg)
+
+    loop = asyncio.get_event_loop()
+    start = time.perf_counter()
+
+    try:
+        # Try standard system.listMethods or a simple execute
+        if self._proxy is None:
+            msg = "Not connected"
+            raise ConnectionError(msg)
+        proxy = self._proxy  # Local reference for lambda
+        await asyncio.wait_for(
+            loop.run_in_executor(
+                None,
+                lambda: proxy.execute("_result_ = True"),
+            ),
+            timeout=self._timeout,
+        )
+    except TimeoutError as e:
+        msg = "Ping timed out"
+        raise ConnectionError(msg) from e
+    except Exception as e:
+        msg = f"Ping failed: {e}"
+        raise ConnectionError(msg) from e
+
+    return (time.perf_counter() - start) * 1000
+
run_macro(macro_name, args=None) async

Run a macro by name.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
840
+841
+842
+843
+844
+845
+846
+847
+848
+849
+850
+851
+852
+853
+854
+855
+856
+857
+858
+859
+860
+861
+862
+863
+864
+865
+866
+867
+868
+869
+870
+871
+872
+873
+874
+875
+876
+877
+878
+879
+880
+881
+882
    async def run_macro(
+        self,
+        macro_name: str,
+        args: dict[str, Any] | None = None,
+    ) -> ExecutionResult:
+        """Run a macro by name."""
+        args = args or {}
+        code = f"""
+import os
+
+# Find macro file
+macro_name = {macro_name!r}
+macro_file = None
+
+# Check user macros first
+user_path = FreeCAD.getUserMacroDir(True)
+user_macro = os.path.join(user_path, macro_name + ".FCMacro")
+if os.path.exists(user_macro):
+    macro_file = user_macro
+
+# Check system macros
+if not macro_file:
+    system_path = FreeCAD.getResourceDir() + "Macro"
+    system_macro = os.path.join(system_path, macro_name + ".FCMacro")
+    if os.path.exists(system_macro):
+        macro_file = system_macro
+
+if not macro_file:
+    raise FileNotFoundError(f"Macro not found: {{macro_name}}")
+
+# Set up arguments
+args = {args!r}
+for k, v in args.items():
+    exec(f"{{k}} = {{v!r}}")
+
+# Execute macro
+with open(macro_file, "r") as f:
+    macro_code = f.read()
+
+exec(macro_code)
+_result_ = True
+"""
+        return await self.execute_python(code)
+
save_document(doc_name=None, path=None) async

Save a document.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
411
+412
+413
+414
+415
+416
+417
+418
+419
+420
+421
+422
+423
+424
+425
+426
+427
+428
+429
+430
+431
+432
+433
+434
+435
    async def save_document(
+        self,
+        doc_name: str | None = None,
+        path: str | None = None,
+    ) -> str:
+        """Save a document."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No active document" if {doc_name!r} is None else f"Document not found: {doc_name!r}")
+
+save_path = {path!r} or doc.FileName
+if not save_path:
+    raise ValueError("No path specified for new document")
+
+doc.saveAs(save_path)
+_result_ = save_path
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return result.result
+
+        error_msg = result.error_traceback or "Failed to save document"
+        raise ValueError(error_msg)
+
set_view(view_angle, doc_name=None) async

Set the 3D view angle.

Source code in src/freecad_mcp/bridge/xmlrpc.py 
745
+746
+747
+748
+749
+750
+751
+752
+753
+754
+755
+756
+757
+758
+759
+760
+761
+762
+763
+764
+765
+766
+767
+768
+769
+770
+771
+772
+773
+774
+775
+776
+777
+778
+779
+780
+781
+782
+783
+784
    async def set_view(
+        self,
+        view_angle: ViewAngle,
+        doc_name: str | None = None,
+    ) -> None:
+        """Set the 3D view angle."""
+        view_angle_str = view_angle.value
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+if not FreeCAD.GuiUp:
+    _result_ = True  # Silently succeed in headless mode
+else:
+    view = FreeCADGui.ActiveDocument.ActiveView
+    if view is None:
+        raise ValueError("No active view")
+
+    view_type = {view_angle_str!r}
+    if view_type == "FitAll":
+        view.fitAll()
+    elif view_type == "Isometric":
+        view.viewIsometric()
+    elif view_type == "Front":
+        view.viewFront()
+    elif view_type == "Back":
+        view.viewRear()
+    elif view_type == "Top":
+        view.viewTop()
+    elif view_type == "Bottom":
+        view.viewBottom()
+    elif view_type == "Left":
+        view.viewLeft()
+    elif view_type == "Right":
+        view.viewRight()
+
+    _result_ = True
+"""
+        await self.execute_python(code)
+

options: show_root_heading: true show_source: true

Socket Bridge

freecad_mcp.bridge.socket

Socket bridge for FreeCAD communication via JSON-RPC.

This bridge communicates with FreeCAD using JSON-RPC over TCP sockets, providing a modern, lightweight alternative to XML-RPC.

Based on learnings from competitive analysis: - Simple socket-based approach (inspired by bonninr/freecad_mcp) - Connection recovery mechanisms (from jango-blockchained) - Automatic reconnection on connection loss

Classes

JsonRpcError

Bases: Exception

JSON-RPC error response.

Source code in src/freecad_mcp/bridge/socket.py 
36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
class JsonRpcError(Exception):
+    """JSON-RPC error response."""
+
+    def __init__(self, code: int, message: str, data: Any = None) -> None:
+        """Initialize JSON-RPC error.
+
+        Args:
+            code: Error code.
+            message: Error message.
+            data: Additional error data.
+        """
+        super().__init__(message)
+        self.code = code
+        self.message = message
+        self.data = data
+
Functions
__init__(code, message, data=None)

Initialize JSON-RPC error.

Parameters:

Name Type Description Default
code int

Error code.

 required
message str

Error message.

 required
data Any

Additional error data.

 None
Source code in src/freecad_mcp/bridge/socket.py 
39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
def __init__(self, code: int, message: str, data: Any = None) -> None:
+    """Initialize JSON-RPC error.
+
+    Args:
+        code: Error code.
+        message: Error message.
+        data: Additional error data.
+    """
+    super().__init__(message)
+    self.code = code
+    self.message = message
+    self.data = data
+

SocketBridge

Bases: FreecadBridge

Bridge that communicates with FreeCAD via JSON-RPC over sockets.

This bridge provides a lightweight, modern protocol for FreeCAD communication. It supports automatic reconnection and connection health monitoring.

Attributes:

Name Type Description
host

Socket server hostname.
port

Socket server port.
timeout

Connection and request timeout in seconds.
Source code in src/freecad_mcp/bridge/socket.py 
  53
+  54
+  55
+  56
+  57
+  58
+  59
+  60
+  61
+  62
+  63
+  64
+  65
+  66
+  67
+  68
+  69
+  70
+  71
+  72
+  73
+  74
+  75
+  76
+  77
+  78
+  79
+  80
+  81
+  82
+  83
+  84
+  85
+  86
+  87
+  88
+  89
+  90
+  91
+  92
+  93
+  94
+  95
+  96
+  97
+  98
+  99
+ 100
+ 101
+ 102
+ 103
+ 104
+ 105
+ 106
+ 107
+ 108
+ 109
+ 110
+ 111
+ 112
+ 113
+ 114
+ 115
+ 116
+ 117
+ 118
+ 119
+ 120
+ 121
+ 122
+ 123
+ 124
+ 125
+ 126
+ 127
+ 128
+ 129
+ 130
+ 131
+ 132
+ 133
+ 134
+ 135
+ 136
+ 137
+ 138
+ 139
+ 140
+ 141
+ 142
+ 143
+ 144
+ 145
+ 146
+ 147
+ 148
+ 149
+ 150
+ 151
+ 152
+ 153
+ 154
+ 155
+ 156
+ 157
+ 158
+ 159
+ 160
+ 161
+ 162
+ 163
+ 164
+ 165
+ 166
+ 167
+ 168
+ 169
+ 170
+ 171
+ 172
+ 173
+ 174
+ 175
+ 176
+ 177
+ 178
+ 179
+ 180
+ 181
+ 182
+ 183
+ 184
+ 185
+ 186
+ 187
+ 188
+ 189
+ 190
+ 191
+ 192
+ 193
+ 194
+ 195
+ 196
+ 197
+ 198
+ 199
+ 200
+ 201
+ 202
+ 203
+ 204
+ 205
+ 206
+ 207
+ 208
+ 209
+ 210
+ 211
+ 212
+ 213
+ 214
+ 215
+ 216
+ 217
+ 218
+ 219
+ 220
+ 221
+ 222
+ 223
+ 224
+ 225
+ 226
+ 227
+ 228
+ 229
+ 230
+ 231
+ 232
+ 233
+ 234
+ 235
+ 236
+ 237
+ 238
+ 239
+ 240
+ 241
+ 242
+ 243
+ 244
+ 245
+ 246
+ 247
+ 248
+ 249
+ 250
+ 251
+ 252
+ 253
+ 254
+ 255
+ 256
+ 257
+ 258
+ 259
+ 260
+ 261
+ 262
+ 263
+ 264
+ 265
+ 266
+ 267
+ 268
+ 269
+ 270
+ 271
+ 272
+ 273
+ 274
+ 275
+ 276
+ 277
+ 278
+ 279
+ 280
+ 281
+ 282
+ 283
+ 284
+ 285
+ 286
+ 287
+ 288
+ 289
+ 290
+ 291
+ 292
+ 293
+ 294
+ 295
+ 296
+ 297
+ 298
+ 299
+ 300
+ 301
+ 302
+ 303
+ 304
+ 305
+ 306
+ 307
+ 308
+ 309
+ 310
+ 311
+ 312
+ 313
+ 314
+ 315
+ 316
+ 317
+ 318
+ 319
+ 320
+ 321
+ 322
+ 323
+ 324
+ 325
+ 326
+ 327
+ 328
+ 329
+ 330
+ 331
+ 332
+ 333
+ 334
+ 335
+ 336
+ 337
+ 338
+ 339
+ 340
+ 341
+ 342
+ 343
+ 344
+ 345
+ 346
+ 347
+ 348
+ 349
+ 350
+ 351
+ 352
+ 353
+ 354
+ 355
+ 356
+ 357
+ 358
+ 359
+ 360
+ 361
+ 362
+ 363
+ 364
+ 365
+ 366
+ 367
+ 368
+ 369
+ 370
+ 371
+ 372
+ 373
+ 374
+ 375
+ 376
+ 377
+ 378
+ 379
+ 380
+ 381
+ 382
+ 383
+ 384
+ 385
+ 386
+ 387
+ 388
+ 389
+ 390
+ 391
+ 392
+ 393
+ 394
+ 395
+ 396
+ 397
+ 398
+ 399
+ 400
+ 401
+ 402
+ 403
+ 404
+ 405
+ 406
+ 407
+ 408
+ 409
+ 410
+ 411
+ 412
+ 413
+ 414
+ 415
+ 416
+ 417
+ 418
+ 419
+ 420
+ 421
+ 422
+ 423
+ 424
+ 425
+ 426
+ 427
+ 428
+ 429
+ 430
+ 431
+ 432
+ 433
+ 434
+ 435
+ 436
+ 437
+ 438
+ 439
+ 440
+ 441
+ 442
+ 443
+ 444
+ 445
+ 446
+ 447
+ 448
+ 449
+ 450
+ 451
+ 452
+ 453
+ 454
+ 455
+ 456
+ 457
+ 458
+ 459
+ 460
+ 461
+ 462
+ 463
+ 464
+ 465
+ 466
+ 467
+ 468
+ 469
+ 470
+ 471
+ 472
+ 473
+ 474
+ 475
+ 476
+ 477
+ 478
+ 479
+ 480
+ 481
+ 482
+ 483
+ 484
+ 485
+ 486
+ 487
+ 488
+ 489
+ 490
+ 491
+ 492
+ 493
+ 494
+ 495
+ 496
+ 497
+ 498
+ 499
+ 500
+ 501
+ 502
+ 503
+ 504
+ 505
+ 506
+ 507
+ 508
+ 509
+ 510
+ 511
+ 512
+ 513
+ 514
+ 515
+ 516
+ 517
+ 518
+ 519
+ 520
+ 521
+ 522
+ 523
+ 524
+ 525
+ 526
+ 527
+ 528
+ 529
+ 530
+ 531
+ 532
+ 533
+ 534
+ 535
+ 536
+ 537
+ 538
+ 539
+ 540
+ 541
+ 542
+ 543
+ 544
+ 545
+ 546
+ 547
+ 548
+ 549
+ 550
+ 551
+ 552
+ 553
+ 554
+ 555
+ 556
+ 557
+ 558
+ 559
+ 560
+ 561
+ 562
+ 563
+ 564
+ 565
+ 566
+ 567
+ 568
+ 569
+ 570
+ 571
+ 572
+ 573
+ 574
+ 575
+ 576
+ 577
+ 578
+ 579
+ 580
+ 581
+ 582
+ 583
+ 584
+ 585
+ 586
+ 587
+ 588
+ 589
+ 590
+ 591
+ 592
+ 593
+ 594
+ 595
+ 596
+ 597
+ 598
+ 599
+ 600
+ 601
+ 602
+ 603
+ 604
+ 605
+ 606
+ 607
+ 608
+ 609
+ 610
+ 611
+ 612
+ 613
+ 614
+ 615
+ 616
+ 617
+ 618
+ 619
+ 620
+ 621
+ 622
+ 623
+ 624
+ 625
+ 626
+ 627
+ 628
+ 629
+ 630
+ 631
+ 632
+ 633
+ 634
+ 635
+ 636
+ 637
+ 638
+ 639
+ 640
+ 641
+ 642
+ 643
+ 644
+ 645
+ 646
+ 647
+ 648
+ 649
+ 650
+ 651
+ 652
+ 653
+ 654
+ 655
+ 656
+ 657
+ 658
+ 659
+ 660
+ 661
+ 662
+ 663
+ 664
+ 665
+ 666
+ 667
+ 668
+ 669
+ 670
+ 671
+ 672
+ 673
+ 674
+ 675
+ 676
+ 677
+ 678
+ 679
+ 680
+ 681
+ 682
+ 683
+ 684
+ 685
+ 686
+ 687
+ 688
+ 689
+ 690
+ 691
+ 692
+ 693
+ 694
+ 695
+ 696
+ 697
+ 698
+ 699
+ 700
+ 701
+ 702
+ 703
+ 704
+ 705
+ 706
+ 707
+ 708
+ 709
+ 710
+ 711
+ 712
+ 713
+ 714
+ 715
+ 716
+ 717
+ 718
+ 719
+ 720
+ 721
+ 722
+ 723
+ 724
+ 725
+ 726
+ 727
+ 728
+ 729
+ 730
+ 731
+ 732
+ 733
+ 734
+ 735
+ 736
+ 737
+ 738
+ 739
+ 740
+ 741
+ 742
+ 743
+ 744
+ 745
+ 746
+ 747
+ 748
+ 749
+ 750
+ 751
+ 752
+ 753
+ 754
+ 755
+ 756
+ 757
+ 758
+ 759
+ 760
+ 761
+ 762
+ 763
+ 764
+ 765
+ 766
+ 767
+ 768
+ 769
+ 770
+ 771
+ 772
+ 773
+ 774
+ 775
+ 776
+ 777
+ 778
+ 779
+ 780
+ 781
+ 782
+ 783
+ 784
+ 785
+ 786
+ 787
+ 788
+ 789
+ 790
+ 791
+ 792
+ 793
+ 794
+ 795
+ 796
+ 797
+ 798
+ 799
+ 800
+ 801
+ 802
+ 803
+ 804
+ 805
+ 806
+ 807
+ 808
+ 809
+ 810
+ 811
+ 812
+ 813
+ 814
+ 815
+ 816
+ 817
+ 818
+ 819
+ 820
+ 821
+ 822
+ 823
+ 824
+ 825
+ 826
+ 827
+ 828
+ 829
+ 830
+ 831
+ 832
+ 833
+ 834
+ 835
+ 836
+ 837
+ 838
+ 839
+ 840
+ 841
+ 842
+ 843
+ 844
+ 845
+ 846
+ 847
+ 848
+ 849
+ 850
+ 851
+ 852
+ 853
+ 854
+ 855
+ 856
+ 857
+ 858
+ 859
+ 860
+ 861
+ 862
+ 863
+ 864
+ 865
+ 866
+ 867
+ 868
+ 869
+ 870
+ 871
+ 872
+ 873
+ 874
+ 875
+ 876
+ 877
+ 878
+ 879
+ 880
+ 881
+ 882
+ 883
+ 884
+ 885
+ 886
+ 887
+ 888
+ 889
+ 890
+ 891
+ 892
+ 893
+ 894
+ 895
+ 896
+ 897
+ 898
+ 899
+ 900
+ 901
+ 902
+ 903
+ 904
+ 905
+ 906
+ 907
+ 908
+ 909
+ 910
+ 911
+ 912
+ 913
+ 914
+ 915
+ 916
+ 917
+ 918
+ 919
+ 920
+ 921
+ 922
+ 923
+ 924
+ 925
+ 926
+ 927
+ 928
+ 929
+ 930
+ 931
+ 932
+ 933
+ 934
+ 935
+ 936
+ 937
+ 938
+ 939
+ 940
+ 941
+ 942
+ 943
+ 944
+ 945
+ 946
+ 947
+ 948
+ 949
+ 950
+ 951
+ 952
+ 953
+ 954
+ 955
+ 956
+ 957
+ 958
+ 959
+ 960
+ 961
+ 962
+ 963
+ 964
+ 965
+ 966
+ 967
+ 968
+ 969
+ 970
+ 971
+ 972
+ 973
+ 974
+ 975
+ 976
+ 977
+ 978
+ 979
+ 980
+ 981
+ 982
+ 983
+ 984
+ 985
+ 986
+ 987
+ 988
+ 989
+ 990
+ 991
+ 992
+ 993
+ 994
+ 995
+ 996
+ 997
+ 998
+ 999
+1000
+1001
+1002
+1003
+1004
+1005
+1006
+1007
+1008
+1009
+1010
+1011
+1012
+1013
+1014
+1015
+1016
+1017
+1018
+1019
+1020
+1021
+1022
+1023
+1024
+1025
+1026
+1027
+1028
+1029
+1030
+1031
+1032
+1033
+1034
+1035
+1036
+1037
+1038
+1039
+1040
+1041
+1042
+1043
+1044
+1045
+1046
+1047
+1048
+1049
+1050
+1051
+1052
+1053
+1054
+1055
+1056
+1057
+1058
+1059
+1060
class SocketBridge(FreecadBridge):
+    """Bridge that communicates with FreeCAD via JSON-RPC over sockets.
+
+    This bridge provides a lightweight, modern protocol for FreeCAD
+    communication. It supports automatic reconnection and connection
+    health monitoring.
+
+    Attributes:
+        host: Socket server hostname.
+        port: Socket server port.
+        timeout: Connection and request timeout in seconds.
+    """
+
+    def __init__(
+        self,
+        host: str = DEFAULT_SOCKET_HOST,
+        port: int = DEFAULT_SOCKET_PORT,
+        timeout: float = DEFAULT_TIMEOUT,
+        auto_reconnect: bool = True,
+    ) -> None:
+        """Initialize the socket bridge.
+
+        Args:
+            host: Socket server hostname.
+            port: Socket server port.
+            timeout: Connection and request timeout in seconds.
+            auto_reconnect: Whether to automatically reconnect on connection loss.
+        """
+        self._host = host
+        self._port = port
+        self._timeout = timeout
+        self._auto_reconnect = auto_reconnect
+        self._reader: asyncio.StreamReader | None = None
+        self._writer: asyncio.StreamWriter | None = None
+        self._connected = False
+        self._lock = asyncio.Lock()
+
+    async def connect(self) -> None:
+        """Establish connection to FreeCAD socket server.
+
+        Raises:
+            ConnectionError: If connection cannot be established.
+        """
+        try:
+            self._reader, self._writer = await asyncio.wait_for(
+                asyncio.open_connection(self._host, self._port),
+                timeout=self._timeout,
+            )
+            self._connected = True
+
+            # Verify connection with a ping
+            await self.ping()
+        except TimeoutError as e:
+            msg = f"Connection to {self._host}:{self._port} timed out"
+            raise ConnectionError(msg) from e
+        except Exception as e:
+            self._connected = False
+            msg = f"Failed to connect to {self._host}:{self._port}: {e}"
+            raise ConnectionError(msg) from e
+
+    async def disconnect(self) -> None:
+        """Close connection to FreeCAD socket server."""
+        if self._writer:
+            self._writer.close()
+            with contextlib.suppress(Exception):
+                await self._writer.wait_closed()
+        self._reader = None
+        self._writer = None
+        self._connected = False
+
+    async def is_connected(self) -> bool:
+        """Check if bridge is connected to FreeCAD."""
+        if not self._connected or self._writer is None:
+            return False
+
+        try:
+            await self.ping()
+            return True
+        except Exception:
+            self._connected = False
+            return False
+
+    async def _send_request(
+        self,
+        method: str,
+        params: dict[str, Any] | None = None,
+    ) -> Any:
+        """Send a JSON-RPC request and wait for response.
+
+        Args:
+            method: Method name to call.
+            params: Method parameters.
+
+        Returns:
+            Result from the JSON-RPC response.
+
+        Raises:
+            ConnectionError: If not connected.
+            JsonRpcError: If server returns an error.
+        """
+        if self._writer is None or self._reader is None:
+            msg = "Not connected to socket server"
+            raise ConnectionError(msg)
+
+        # Build JSON-RPC request
+        request_id = str(uuid.uuid4())
+        request = {
+            "jsonrpc": "2.0",
+            "id": request_id,
+            "method": method,
+            "params": params or {},
+        }
+
+        async with self._lock:
+            try:
+                # Send request
+                request_data = json.dumps(request).encode("utf-8") + b"\n"
+                self._writer.write(request_data)
+                await self._writer.drain()
+
+                # Read response
+                response_data = await asyncio.wait_for(
+                    self._reader.readline(),
+                    timeout=self._timeout,
+                )
+
+                if not response_data:
+                    self._connected = False
+                    msg = "Connection closed by server"
+                    raise ConnectionError(msg)
+
+                response = json.loads(response_data.decode("utf-8"))
+
+                # Check for error
+                if "error" in response:
+                    error = response["error"]
+                    raise JsonRpcError(
+                        code=error.get("code", -1),
+                        message=error.get("message", "Unknown error"),
+                        data=error.get("data"),
+                    )
+
+                return response.get("result")
+
+            except TimeoutError as e:
+                msg = "Request timed out"
+                raise ConnectionError(msg) from e
+            except json.JSONDecodeError as e:
+                msg = f"Invalid JSON response: {e}"
+                raise ConnectionError(msg) from e
+            except (ConnectionResetError, BrokenPipeError) as e:
+                self._connected = False
+                if self._auto_reconnect:
+                    # Try to reconnect
+                    try:
+                        await self.connect()
+                        return await self._send_request(method, params)
+                    except Exception:
+                        pass
+                msg = f"Connection lost: {e}"
+                raise ConnectionError(msg) from e
+
+    async def ping(self) -> float:
+        """Ping FreeCAD to check connection and measure latency.
+
+        Returns:
+            Round-trip time in milliseconds.
+
+        Raises:
+            ConnectionError: If not connected.
+        """
+        start = time.perf_counter()
+        await self._send_request("ping")
+        return (time.perf_counter() - start) * 1000
+
+    async def get_status(self) -> ConnectionStatus:
+        """Get detailed connection status.
+
+        Returns:
+            ConnectionStatus with full status information.
+        """
+        if not self._connected:
+            return ConnectionStatus(
+                connected=False,
+                mode="socket",
+                error="Not connected",
+            )
+
+        try:
+            ping_ms = await self.ping()
+            version_info = await self.get_freecad_version()
+            gui_available = await self.is_gui_available()
+
+            return ConnectionStatus(
+                connected=True,
+                mode="socket",
+                freecad_version=version_info.get("version", "unknown"),
+                gui_available=gui_available,
+                last_ping_ms=ping_ms,
+            )
+        except Exception as e:
+            return ConnectionStatus(
+                connected=False,
+                mode="socket",
+                error=str(e),
+            )
+
+    # =========================================================================
+    # Code Execution
+    # =========================================================================
+
+    async def execute_python(
+        self,
+        code: str,
+        timeout_ms: int = 30000,
+    ) -> ExecutionResult:
+        """Execute Python code in FreeCAD context via socket.
+
+        Args:
+            code: Python code to execute.
+            timeout_ms: Maximum execution time in milliseconds.
+
+        Returns:
+            ExecutionResult with execution outcome.
+        """
+        start = time.perf_counter()
+
+        try:
+            result = await asyncio.wait_for(
+                self._send_request("execute", {"code": code}),
+                timeout=timeout_ms / 1000,
+            )
+            elapsed = (time.perf_counter() - start) * 1000
+
+            if isinstance(result, dict):
+                return ExecutionResult(
+                    success=result.get("success", False),
+                    result=result.get("result"),
+                    stdout=result.get("stdout", ""),
+                    stderr=result.get("stderr", ""),
+                    execution_time_ms=elapsed,
+                    error_type=result.get("error_type"),
+                    error_traceback=result.get("error_traceback"),
+                )
+            else:
+                return ExecutionResult(
+                    success=True,
+                    result=result,
+                    stdout="",
+                    stderr="",
+                    execution_time_ms=elapsed,
+                )
+
+        except TimeoutError:
+            return ExecutionResult(
+                success=False,
+                result=None,
+                stdout="",
+                stderr=f"Execution timed out after {timeout_ms}ms",
+                execution_time_ms=float(timeout_ms),
+                error_type="TimeoutError",
+            )
+        except JsonRpcError as e:
+            elapsed = (time.perf_counter() - start) * 1000
+            return ExecutionResult(
+                success=False,
+                result=None,
+                stdout="",
+                stderr=e.message,
+                execution_time_ms=elapsed,
+                error_type="JsonRpcError",
+            )
+        except ConnectionError as e:
+            return ExecutionResult(
+                success=False,
+                result=None,
+                stdout="",
+                stderr=str(e),
+                execution_time_ms=0,
+                error_type="ConnectionError",
+            )
+
+    # =========================================================================
+    # Document Management
+    # =========================================================================
+
+    async def get_documents(self) -> list[DocumentInfo]:
+        """Get list of open documents."""
+        result = await self.execute_python(
+            """
+_result_ = []
+for doc in FreeCAD.listDocuments().values():
+    _result_.append({
+        "name": doc.Name,
+        "label": doc.Label,
+        "path": doc.FileName or None,
+        "objects": [obj.Name for obj in doc.Objects],
+        "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+        "active_object": doc.ActiveObject.Name if doc.ActiveObject else None,
+    })
+"""
+        )
+
+        if result.success and result.result:
+            return [DocumentInfo(**doc) for doc in result.result]
+        return []
+
+    async def get_active_document(self) -> DocumentInfo | None:
+        """Get the active document."""
+        result = await self.execute_python(
+            """
+doc = FreeCAD.ActiveDocument
+if doc:
+    _result_ = {
+        "name": doc.Name,
+        "label": doc.Label,
+        "path": doc.FileName or None,
+        "objects": [obj.Name for obj in doc.Objects],
+        "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+        "active_object": doc.ActiveObject.Name if doc.ActiveObject else None,
+    }
+else:
+    _result_ = None
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+        return None
+
+    async def create_document(
+        self, name: str, label: str | None = None
+    ) -> DocumentInfo:
+        """Create a new document."""
+        label = label or name
+        result = await self.execute_python(
+            f"""
+doc = FreeCAD.newDocument({name!r})
+doc.Label = {label!r}
+_result_ = {{
+    "name": doc.Name,
+    "label": doc.Label,
+    "path": doc.FileName or None,
+    "objects": [],
+    "is_modified": False,
+}}
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create document"
+        raise ValueError(error_msg)
+
+    async def open_document(self, path: str) -> DocumentInfo:
+        """Open an existing document."""
+        result = await self.execute_python(
+            f"""
+import os
+if not os.path.exists({path!r}):
+    raise FileNotFoundError(f"File not found: {path!r}")
+
+doc = FreeCAD.openDocument({path!r})
+_result_ = {{
+    "name": doc.Name,
+    "label": doc.Label,
+    "path": doc.FileName or None,
+    "objects": [obj.Name for obj in doc.Objects],
+    "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+}}
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+
+        if "FileNotFoundError" in (result.error_type or ""):
+            raise FileNotFoundError(result.stderr)
+
+        error_msg = result.error_traceback or "Failed to open document"
+        raise ValueError(error_msg)
+
+    async def save_document(
+        self,
+        doc_name: str | None = None,
+        path: str | None = None,
+    ) -> str:
+        """Save a document."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No active document" if {doc_name!r} is None else f"Document not found: {doc_name!r}")
+
+save_path = {path!r} or doc.FileName
+if not save_path:
+    raise ValueError("No path specified for new document")
+
+doc.saveAs(save_path)
+_result_ = save_path
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return result.result
+
+        error_msg = result.error_traceback or "Failed to save document"
+        raise ValueError(error_msg)
+
+    async def close_document(self, doc_name: str | None = None) -> None:
+        """Close a document."""
+        code = f"""
+doc_name = {doc_name!r}
+if doc_name is None:
+    doc = FreeCAD.ActiveDocument
+    if doc:
+        doc_name = doc.Name
+    else:
+        raise ValueError("No active document")
+
+FreeCAD.closeDocument(doc_name)
+_result_ = True
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to close document"
+            raise ValueError(error_msg)
+
+    # =========================================================================
+    # Object Management
+    # =========================================================================
+
+    async def get_objects(self, doc_name: str | None = None) -> list[ObjectInfo]:
+        """Get all objects in a document."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+objects = []
+for obj in doc.Objects:
+    obj_info = {{
+        "name": obj.Name,
+        "label": obj.Label,
+        "type_id": obj.TypeId,
+        "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+        "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+        "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+    }}
+    objects.append(obj_info)
+
+_result_ = objects
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [ObjectInfo(**obj) for obj in result.result]
+        return []
+
+    async def get_object(
+        self,
+        obj_name: str,
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Get detailed object information."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+props = {{}}
+for prop in obj.PropertiesList:
+    try:
+        val = getattr(obj, prop)
+        if hasattr(val, '__class__') and val.__class__.__module__ != 'builtins':
+            val = str(val)
+        props[prop] = val
+    except Exception:
+        props[prop] = "<unreadable>"
+
+shape_info = None
+if hasattr(obj, "Shape"):
+    shape = obj.Shape
+    shape_info = {{
+        "shape_type": shape.ShapeType,
+        "volume": shape.Volume if hasattr(shape, "Volume") else None,
+        "area": shape.Area if hasattr(shape, "Area") else None,
+        "is_valid": shape.isValid(),
+        "is_closed": shape.isClosed() if hasattr(shape, "isClosed") else False,
+        "vertex_count": len(shape.Vertexes) if hasattr(shape, "Vertexes") else 0,
+        "edge_count": len(shape.Edges) if hasattr(shape, "Edges") else 0,
+        "face_count": len(shape.Faces) if hasattr(shape, "Faces") else 0,
+    }}
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "properties": props,
+    "shape_info": shape_info,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+    "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to get object"
+        raise ValueError(error_msg)
+
+    async def create_object(
+        self,
+        type_id: str,
+        name: str | None = None,
+        properties: dict[str, Any] | None = None,
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Create a new object."""
+        properties = properties or {}
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.addObject({type_id!r}, {name!r} or "")
+
+# Set properties
+for prop_name, prop_val in {properties!r}.items():
+    if hasattr(obj, prop_name):
+        setattr(obj, prop_name, prop_val)
+
+doc.recompute()
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "visibility": True,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create object"
+        raise ValueError(error_msg)
+
+    async def edit_object(
+        self,
+        obj_name: str,
+        properties: dict[str, Any],
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Edit object properties."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+# Set properties
+for prop_name, prop_val in {properties!r}.items():
+    if hasattr(obj, prop_name):
+        setattr(obj, prop_name, prop_val)
+
+doc.recompute()
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to edit object"
+        raise ValueError(error_msg)
+
+    async def delete_object(
+        self,
+        obj_name: str,
+        doc_name: str | None = None,
+    ) -> None:
+        """Delete an object."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+doc.removeObject({obj_name!r})
+_result_ = True
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to delete object"
+            raise ValueError(error_msg)
+
+    # =========================================================================
+    # View and Screenshot
+    # =========================================================================
+
+    async def get_screenshot(
+        self,
+        view_angle: ViewAngle | None = None,
+        width: int = 800,
+        height: int = 600,
+        doc_name: str | None = None,
+    ) -> ScreenshotResult:
+        """Capture a screenshot of the 3D view via socket."""
+        view_angle_str = view_angle.value if view_angle else "Isometric"
+        code = f"""
+import base64
+import tempfile
+import os
+
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+# Check if GUI is available
+if not FreeCAD.GuiUp:
+    raise RuntimeError("GUI not available")
+
+view = FreeCADGui.ActiveDocument.ActiveView
+if view is None:
+    raise ValueError("No active view")
+
+# Check view type
+view_type = view.__class__.__name__
+if view_type not in ["View3DInventor", "View3DInventorPy"]:
+    raise ValueError(f"Cannot capture screenshot from {{view_type}} view")
+
+# Set view angle
+view_type_str = {view_angle_str!r}
+if view_type_str == "FitAll":
+    view.fitAll()
+elif view_type_str == "Isometric":
+    view.viewIsometric()
+elif view_type_str == "Front":
+    view.viewFront()
+elif view_type_str == "Back":
+    view.viewRear()
+elif view_type_str == "Top":
+    view.viewTop()
+elif view_type_str == "Bottom":
+    view.viewBottom()
+elif view_type_str == "Left":
+    view.viewLeft()
+elif view_type_str == "Right":
+    view.viewRight()
+
+# Save to temp file and read
+with tempfile.NamedTemporaryFile(suffix=".png", delete=False) as f:
+    temp_path = f.name
+
+view.saveImage(temp_path, {width}, {height}, "Current")
+
+with open(temp_path, "rb") as f:
+    image_data = base64.b64encode(f.read()).decode("utf-8")
+
+os.unlink(temp_path)
+
+_result_ = {{
+    "success": True,
+    "data": image_data,
+    "format": "png",
+    "width": {width},
+    "height": {height},
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ScreenshotResult(
+                success=True,
+                data=result.result["data"],
+                format=result.result["format"],
+                width=result.result["width"],
+                height=result.result["height"],
+                view_angle=view_angle,
+            )
+
+        return ScreenshotResult(
+            success=False,
+            error=result.error_traceback
+            or result.stderr
+            or "Failed to capture screenshot",
+            width=width,
+            height=height,
+            view_angle=view_angle,
+        )
+
+    async def set_view(
+        self,
+        view_angle: ViewAngle,
+        doc_name: str | None = None,
+    ) -> None:
+        """Set the 3D view angle."""
+        view_angle_str = view_angle.value
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+if not FreeCAD.GuiUp:
+    _result_ = True
+else:
+    view = FreeCADGui.ActiveDocument.ActiveView
+    if view is None:
+        raise ValueError("No active view")
+
+    view_type = {view_angle_str!r}
+    if view_type == "FitAll":
+        view.fitAll()
+    elif view_type == "Isometric":
+        view.viewIsometric()
+    elif view_type == "Front":
+        view.viewFront()
+    elif view_type == "Back":
+        view.viewRear()
+    elif view_type == "Top":
+        view.viewTop()
+    elif view_type == "Bottom":
+        view.viewBottom()
+    elif view_type == "Left":
+        view.viewLeft()
+    elif view_type == "Right":
+        view.viewRight()
+
+    _result_ = True
+"""
+        await self.execute_python(code)
+
+    # =========================================================================
+    # Macros
+    # =========================================================================
+
+    async def get_macros(self) -> list[MacroInfo]:
+        """Get list of available macros."""
+        code = """
+import os
+
+macro_paths = []
+
+user_path = FreeCAD.getUserMacroDir(True)
+if os.path.exists(user_path):
+    macro_paths.append(("user", user_path))
+
+system_path = FreeCAD.getResourceDir() + "Macro"
+if os.path.exists(system_path):
+    macro_paths.append(("system", system_path))
+
+macros = []
+for source, path in macro_paths:
+    for filename in os.listdir(path):
+        if filename.endswith(".FCMacro"):
+            macro_file = os.path.join(path, filename)
+            description = ""
+            try:
+                with open(macro_file, "r") as f:
+                    for line in f:
+                        if line.startswith("#"):
+                            desc = line.lstrip("#").strip()
+                            if desc and not desc.startswith("!") and not desc.startswith("-*-"):
+                                description = desc
+                                break
+            except Exception:
+                pass
+
+            macros.append({
+                "name": filename[:-8],
+                "path": macro_file,
+                "description": description,
+                "is_system": source == "system",
+            })
+
+_result_ = macros
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [MacroInfo(**m) for m in result.result]
+        return []
+
+    async def run_macro(
+        self,
+        macro_name: str,
+        args: dict[str, Any] | None = None,
+    ) -> ExecutionResult:
+        """Run a macro by name."""
+        args = args or {}
+        code = f"""
+import os
+
+macro_name = {macro_name!r}
+macro_file = None
+
+user_path = FreeCAD.getUserMacroDir(True)
+user_macro = os.path.join(user_path, macro_name + ".FCMacro")
+if os.path.exists(user_macro):
+    macro_file = user_macro
+
+if not macro_file:
+    system_path = FreeCAD.getResourceDir() + "Macro"
+    system_macro = os.path.join(system_path, macro_name + ".FCMacro")
+    if os.path.exists(system_macro):
+        macro_file = system_macro
+
+if not macro_file:
+    raise FileNotFoundError(f"Macro not found: {{macro_name}}")
+
+args = {args!r}
+for k, v in args.items():
+    exec(f"{{k}} = {{v!r}}")
+
+with open(macro_file, "r") as f:
+    macro_code = f.read()
+
+exec(macro_code)
+_result_ = True
+"""
+        return await self.execute_python(code)
+
+    async def create_macro(
+        self,
+        name: str,
+        code: str,
+        description: str = "",
+    ) -> MacroInfo:
+        """Create a new macro."""
+        create_code = f"""
+import os
+
+macro_path = FreeCAD.getUserMacroDir(True)
+os.makedirs(macro_path, exist_ok=True)
+
+macro_file = os.path.join(macro_path, {name!r} + ".FCMacro")
+
+header = ""
+if {description!r}:
+    header = f"# {description!r}\\n\\n"
+
+full_code = header + '''# -*- coding: utf-8 -*-
+# FreeCAD Macro: {name}
+# Created via MCP Bridge
+
+import FreeCAD
+import FreeCADGui
+
+''' + {code!r}
+
+with open(macro_file, "w") as f:
+    f.write(full_code)
+
+_result_ = {{
+    "name": {name!r},
+    "path": macro_file,
+    "description": {description!r},
+    "is_system": False,
+}}
+"""
+        result = await self.execute_python(create_code)
+
+        if result.success and result.result:
+            return MacroInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create macro"
+        raise ValueError(error_msg)
+
+    # =========================================================================
+    # Workbenches
+    # =========================================================================
+
+    async def get_workbenches(self) -> list[WorkbenchInfo]:
+        """Get list of available workbenches."""
+        code = """
+workbenches = []
+active_wb = FreeCADGui.activeWorkbench() if FreeCAD.GuiUp else None
+active_name = active_wb.__class__.__name__ if active_wb else None
+
+if FreeCAD.GuiUp:
+    for name in FreeCADGui.listWorkbenches():
+        wb = FreeCADGui.getWorkbench(name)
+        workbenches.append({
+            "name": name,
+            "label": wb.MenuText if hasattr(wb, "MenuText") else name,
+            "icon": wb.Icon if hasattr(wb, "Icon") else "",
+            "is_active": name == active_name,
+        })
+else:
+    common = ["StartWorkbench", "PartWorkbench", "PartDesignWorkbench",
+              "DraftWorkbench", "SketcherWorkbench", "MeshWorkbench"]
+    for name in common:
+        workbenches.append({
+            "name": name,
+            "label": name.replace("Workbench", ""),
+            "icon": "",
+            "is_active": False,
+        })
+
+_result_ = workbenches
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [WorkbenchInfo(**wb) for wb in result.result]
+        return []
+
+    async def activate_workbench(self, workbench_name: str) -> None:
+        """Activate a workbench."""
+        code = f"""
+if FreeCAD.GuiUp:
+    try:
+        FreeCADGui.activateWorkbench({workbench_name!r})
+        _result_ = True
+    except Exception as e:
+        raise ValueError(f"Failed to activate workbench: {{e}}")
+else:
+    _result_ = True
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to activate workbench"
+            raise ValueError(error_msg)
+
+    # =========================================================================
+    # Version and Environment
+    # =========================================================================
+
+    async def get_freecad_version(self) -> dict[str, Any]:
+        """Get FreeCAD version information."""
+        code = """
+import sys
+_result_ = {
+    "version": ".".join(str(x) for x in FreeCAD.Version()[:3]),
+    "version_tuple": FreeCAD.Version()[:3],
+    "build_date": FreeCAD.Version()[3] if len(FreeCAD.Version()) > 3 else "unknown",
+    "python_version": sys.version,
+    "gui_available": FreeCAD.GuiUp,
+}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return result.result
+
+        return {
+            "version": "unknown",
+            "version_tuple": [],
+            "build_date": "unknown",
+            "python_version": "",
+            "gui_available": False,
+        }
+
+    async def is_gui_available(self) -> bool:
+        """Check if FreeCAD GUI is available."""
+        result = await self.execute_python("_result_ = FreeCAD.GuiUp")
+        return bool(result.success and result.result)
+
+    # =========================================================================
+    # Console
+    # =========================================================================
+
+    async def get_console_output(self, lines: int = 100) -> list[str]:
+        """Get recent console output."""
+        code = f"""
+output_lines = []
+
+if hasattr(FreeCAD, 'Console'):
+    console = FreeCAD.Console
+    if hasattr(console, 'GetLog'):
+        log = console.GetLog()
+        if log:
+            output_lines = log.split('\\n')[-{lines}:]
+
+_result_ = output_lines
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return result.result
+        return []
+
Functions
__init__(host=DEFAULT_SOCKET_HOST, port=DEFAULT_SOCKET_PORT, timeout=DEFAULT_TIMEOUT, auto_reconnect=True)

Initialize the socket bridge.

Parameters:

Name Type Description Default
host str

Socket server hostname.

 DEFAULT_SOCKET_HOST
port int

Socket server port.

 DEFAULT_SOCKET_PORT
timeout float

Connection and request timeout in seconds.

 DEFAULT_TIMEOUT
auto_reconnect bool

Whether to automatically reconnect on connection loss.

 True
Source code in src/freecad_mcp/bridge/socket.py 
66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
def __init__(
+    self,
+    host: str = DEFAULT_SOCKET_HOST,
+    port: int = DEFAULT_SOCKET_PORT,
+    timeout: float = DEFAULT_TIMEOUT,
+    auto_reconnect: bool = True,
+) -> None:
+    """Initialize the socket bridge.
+
+    Args:
+        host: Socket server hostname.
+        port: Socket server port.
+        timeout: Connection and request timeout in seconds.
+        auto_reconnect: Whether to automatically reconnect on connection loss.
+    """
+    self._host = host
+    self._port = port
+    self._timeout = timeout
+    self._auto_reconnect = auto_reconnect
+    self._reader: asyncio.StreamReader | None = None
+    self._writer: asyncio.StreamWriter | None = None
+    self._connected = False
+    self._lock = asyncio.Lock()
+
activate_workbench(workbench_name) async

Activate a workbench.

Source code in src/freecad_mcp/bridge/socket.py 
 986
+ 987
+ 988
+ 989
+ 990
+ 991
+ 992
+ 993
+ 994
+ 995
+ 996
+ 997
+ 998
+ 999
+1000
+1001
+1002
    async def activate_workbench(self, workbench_name: str) -> None:
+        """Activate a workbench."""
+        code = f"""
+if FreeCAD.GuiUp:
+    try:
+        FreeCADGui.activateWorkbench({workbench_name!r})
+        _result_ = True
+    except Exception as e:
+        raise ValueError(f"Failed to activate workbench: {{e}}")
+else:
+    _result_ = True
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to activate workbench"
+            raise ValueError(error_msg)
+
close_document(doc_name=None) async

Close a document.

Source code in src/freecad_mcp/bridge/socket.py 
462
+463
+464
+465
+466
+467
+468
+469
+470
+471
+472
+473
+474
+475
+476
+477
+478
+479
+480
    async def close_document(self, doc_name: str | None = None) -> None:
+        """Close a document."""
+        code = f"""
+doc_name = {doc_name!r}
+if doc_name is None:
+    doc = FreeCAD.ActiveDocument
+    if doc:
+        doc_name = doc.Name
+    else:
+        raise ValueError("No active document")
+
+FreeCAD.closeDocument(doc_name)
+_result_ = True
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to close document"
+            raise ValueError(error_msg)
+
connect() async

Establish connection to FreeCAD socket server.

Raises:

Type Description
ConnectionError

If connection cannot be established.
Source code in src/freecad_mcp/bridge/socket.py 
 90
+ 91
+ 92
+ 93
+ 94
+ 95
+ 96
+ 97
+ 98
+ 99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
async def connect(self) -> None:
+    """Establish connection to FreeCAD socket server.
+
+    Raises:
+        ConnectionError: If connection cannot be established.
+    """
+    try:
+        self._reader, self._writer = await asyncio.wait_for(
+            asyncio.open_connection(self._host, self._port),
+            timeout=self._timeout,
+        )
+        self._connected = True
+
+        # Verify connection with a ping
+        await self.ping()
+    except TimeoutError as e:
+        msg = f"Connection to {self._host}:{self._port} timed out"
+        raise ConnectionError(msg) from e
+    except Exception as e:
+        self._connected = False
+        msg = f"Failed to connect to {self._host}:{self._port}: {e}"
+        raise ConnectionError(msg) from e
+
create_document(name, label=None) async

Create a new document.

Source code in src/freecad_mcp/bridge/socket.py 
383
+384
+385
+386
+387
+388
+389
+390
+391
+392
+393
+394
+395
+396
+397
+398
+399
+400
+401
+402
+403
+404
+405
+406
    async def create_document(
+        self, name: str, label: str | None = None
+    ) -> DocumentInfo:
+        """Create a new document."""
+        label = label or name
+        result = await self.execute_python(
+            f"""
+doc = FreeCAD.newDocument({name!r})
+doc.Label = {label!r}
+_result_ = {{
+    "name": doc.Name,
+    "label": doc.Label,
+    "path": doc.FileName or None,
+    "objects": [],
+    "is_modified": False,
+}}
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create document"
+        raise ValueError(error_msg)
+
create_macro(name, code, description='') async

Create a new macro.

Source code in src/freecad_mcp/bridge/socket.py 
901
+902
+903
+904
+905
+906
+907
+908
+909
+910
+911
+912
+913
+914
+915
+916
+917
+918
+919
+920
+921
+922
+923
+924
+925
+926
+927
+928
+929
+930
+931
+932
+933
+934
+935
+936
+937
+938
+939
+940
+941
+942
+943
+944
+945
    async def create_macro(
+        self,
+        name: str,
+        code: str,
+        description: str = "",
+    ) -> MacroInfo:
+        """Create a new macro."""
+        create_code = f"""
+import os
+
+macro_path = FreeCAD.getUserMacroDir(True)
+os.makedirs(macro_path, exist_ok=True)
+
+macro_file = os.path.join(macro_path, {name!r} + ".FCMacro")
+
+header = ""
+if {description!r}:
+    header = f"# {description!r}\\n\\n"
+
+full_code = header + '''# -*- coding: utf-8 -*-
+# FreeCAD Macro: {name}
+# Created via MCP Bridge
+
+import FreeCAD
+import FreeCADGui
+
+''' + {code!r}
+
+with open(macro_file, "w") as f:
+    f.write(full_code)
+
+_result_ = {{
+    "name": {name!r},
+    "path": macro_file,
+    "description": {description!r},
+    "is_system": False,
+}}
+"""
+        result = await self.execute_python(create_code)
+
+        if result.success and result.result:
+            return MacroInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create macro"
+        raise ValueError(error_msg)
+
create_object(type_id, name=None, properties=None, doc_name=None) async

Create a new object.

Source code in src/freecad_mcp/bridge/socket.py 
571
+572
+573
+574
+575
+576
+577
+578
+579
+580
+581
+582
+583
+584
+585
+586
+587
+588
+589
+590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
+608
+609
    async def create_object(
+        self,
+        type_id: str,
+        name: str | None = None,
+        properties: dict[str, Any] | None = None,
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Create a new object."""
+        properties = properties or {}
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.addObject({type_id!r}, {name!r} or "")
+
+# Set properties
+for prop_name, prop_val in {properties!r}.items():
+    if hasattr(obj, prop_name):
+        setattr(obj, prop_name, prop_val)
+
+doc.recompute()
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "visibility": True,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create object"
+        raise ValueError(error_msg)
+
delete_object(obj_name, doc_name=None) async

Delete an object.

Source code in src/freecad_mcp/bridge/socket.py 
651
+652
+653
+654
+655
+656
+657
+658
+659
+660
+661
+662
+663
+664
+665
+666
+667
+668
+669
+670
+671
+672
+673
    async def delete_object(
+        self,
+        obj_name: str,
+        doc_name: str | None = None,
+    ) -> None:
+        """Delete an object."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+doc.removeObject({obj_name!r})
+_result_ = True
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to delete object"
+            raise ValueError(error_msg)
+
disconnect() async

Close connection to FreeCAD socket server.

Source code in src/freecad_mcp/bridge/socket.py 
113
+114
+115
+116
+117
+118
+119
+120
+121
async def disconnect(self) -> None:
+    """Close connection to FreeCAD socket server."""
+    if self._writer:
+        self._writer.close()
+        with contextlib.suppress(Exception):
+            await self._writer.wait_closed()
+    self._reader = None
+    self._writer = None
+    self._connected = False
+
edit_object(obj_name, properties, doc_name=None) async

Edit object properties.

Source code in src/freecad_mcp/bridge/socket.py 
611
+612
+613
+614
+615
+616
+617
+618
+619
+620
+621
+622
+623
+624
+625
+626
+627
+628
+629
+630
+631
+632
+633
+634
+635
+636
+637
+638
+639
+640
+641
+642
+643
+644
+645
+646
+647
+648
+649
    async def edit_object(
+        self,
+        obj_name: str,
+        properties: dict[str, Any],
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Edit object properties."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+# Set properties
+for prop_name, prop_val in {properties!r}.items():
+    if hasattr(obj, prop_name):
+        setattr(obj, prop_name, prop_val)
+
+doc.recompute()
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to edit object"
+        raise ValueError(error_msg)
+
execute_python(code, timeout_ms=30000) async

Execute Python code in FreeCAD context via socket.

Parameters:

Name Type Description Default
code str

Python code to execute.

 required
timeout_ms int

Maximum execution time in milliseconds.

 30000

Returns:

Type Description
ExecutionResult

ExecutionResult with execution outcome.
Source code in src/freecad_mcp/bridge/socket.py 
264
+265
+266
+267
+268
+269
+270
+271
+272
+273
+274
+275
+276
+277
+278
+279
+280
+281
+282
+283
+284
+285
+286
+287
+288
+289
+290
+291
+292
+293
+294
+295
+296
+297
+298
+299
+300
+301
+302
+303
+304
+305
+306
+307
+308
+309
+310
+311
+312
+313
+314
+315
+316
+317
+318
+319
+320
+321
+322
+323
+324
+325
+326
+327
+328
+329
+330
+331
+332
+333
async def execute_python(
+    self,
+    code: str,
+    timeout_ms: int = 30000,
+) -> ExecutionResult:
+    """Execute Python code in FreeCAD context via socket.
+
+    Args:
+        code: Python code to execute.
+        timeout_ms: Maximum execution time in milliseconds.
+
+    Returns:
+        ExecutionResult with execution outcome.
+    """
+    start = time.perf_counter()
+
+    try:
+        result = await asyncio.wait_for(
+            self._send_request("execute", {"code": code}),
+            timeout=timeout_ms / 1000,
+        )
+        elapsed = (time.perf_counter() - start) * 1000
+
+        if isinstance(result, dict):
+            return ExecutionResult(
+                success=result.get("success", False),
+                result=result.get("result"),
+                stdout=result.get("stdout", ""),
+                stderr=result.get("stderr", ""),
+                execution_time_ms=elapsed,
+                error_type=result.get("error_type"),
+                error_traceback=result.get("error_traceback"),
+            )
+        else:
+            return ExecutionResult(
+                success=True,
+                result=result,
+                stdout="",
+                stderr="",
+                execution_time_ms=elapsed,
+            )
+
+    except TimeoutError:
+        return ExecutionResult(
+            success=False,
+            result=None,
+            stdout="",
+            stderr=f"Execution timed out after {timeout_ms}ms",
+            execution_time_ms=float(timeout_ms),
+            error_type="TimeoutError",
+        )
+    except JsonRpcError as e:
+        elapsed = (time.perf_counter() - start) * 1000
+        return ExecutionResult(
+            success=False,
+            result=None,
+            stdout="",
+            stderr=e.message,
+            execution_time_ms=elapsed,
+            error_type="JsonRpcError",
+        )
+    except ConnectionError as e:
+        return ExecutionResult(
+            success=False,
+            result=None,
+            stdout="",
+            stderr=str(e),
+            execution_time_ms=0,
+            error_type="ConnectionError",
+        )
+
get_active_document() async

Get the active document.

Source code in src/freecad_mcp/bridge/socket.py 
360
+361
+362
+363
+364
+365
+366
+367
+368
+369
+370
+371
+372
+373
+374
+375
+376
+377
+378
+379
+380
+381
    async def get_active_document(self) -> DocumentInfo | None:
+        """Get the active document."""
+        result = await self.execute_python(
+            """
+doc = FreeCAD.ActiveDocument
+if doc:
+    _result_ = {
+        "name": doc.Name,
+        "label": doc.Label,
+        "path": doc.FileName or None,
+        "objects": [obj.Name for obj in doc.Objects],
+        "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+        "active_object": doc.ActiveObject.Name if doc.ActiveObject else None,
+    }
+else:
+    _result_ = None
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+        return None
+
get_console_output(lines=100) async

Get recent console output.

Source code in src/freecad_mcp/bridge/socket.py 
1042
+1043
+1044
+1045
+1046
+1047
+1048
+1049
+1050
+1051
+1052
+1053
+1054
+1055
+1056
+1057
+1058
+1059
+1060
    async def get_console_output(self, lines: int = 100) -> list[str]:
+        """Get recent console output."""
+        code = f"""
+output_lines = []
+
+if hasattr(FreeCAD, 'Console'):
+    console = FreeCAD.Console
+    if hasattr(console, 'GetLog'):
+        log = console.GetLog()
+        if log:
+            output_lines = log.split('\\n')[-{lines}:]
+
+_result_ = output_lines
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return result.result
+        return []
+
get_documents() async

Get list of open documents.

Source code in src/freecad_mcp/bridge/socket.py 
339
+340
+341
+342
+343
+344
+345
+346
+347
+348
+349
+350
+351
+352
+353
+354
+355
+356
+357
+358
    async def get_documents(self) -> list[DocumentInfo]:
+        """Get list of open documents."""
+        result = await self.execute_python(
+            """
+_result_ = []
+for doc in FreeCAD.listDocuments().values():
+    _result_.append({
+        "name": doc.Name,
+        "label": doc.Label,
+        "path": doc.FileName or None,
+        "objects": [obj.Name for obj in doc.Objects],
+        "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+        "active_object": doc.ActiveObject.Name if doc.ActiveObject else None,
+    })
+"""
+        )
+
+        if result.success and result.result:
+            return [DocumentInfo(**doc) for doc in result.result]
+        return []
+
get_freecad_version() async

Get FreeCAD version information.

Source code in src/freecad_mcp/bridge/socket.py 
1008
+1009
+1010
+1011
+1012
+1013
+1014
+1015
+1016
+1017
+1018
+1019
+1020
+1021
+1022
+1023
+1024
+1025
+1026
+1027
+1028
+1029
+1030
+1031
    async def get_freecad_version(self) -> dict[str, Any]:
+        """Get FreeCAD version information."""
+        code = """
+import sys
+_result_ = {
+    "version": ".".join(str(x) for x in FreeCAD.Version()[:3]),
+    "version_tuple": FreeCAD.Version()[:3],
+    "build_date": FreeCAD.Version()[3] if len(FreeCAD.Version()) > 3 else "unknown",
+    "python_version": sys.version,
+    "gui_available": FreeCAD.GuiUp,
+}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return result.result
+
+        return {
+            "version": "unknown",
+            "version_tuple": [],
+            "build_date": "unknown",
+            "python_version": "",
+            "gui_available": False,
+        }
+
get_macros() async

Get list of available macros.

Source code in src/freecad_mcp/bridge/socket.py 
815
+816
+817
+818
+819
+820
+821
+822
+823
+824
+825
+826
+827
+828
+829
+830
+831
+832
+833
+834
+835
+836
+837
+838
+839
+840
+841
+842
+843
+844
+845
+846
+847
+848
+849
+850
+851
+852
+853
+854
+855
+856
+857
+858
+859
+860
    async def get_macros(self) -> list[MacroInfo]:
+        """Get list of available macros."""
+        code = """
+import os
+
+macro_paths = []
+
+user_path = FreeCAD.getUserMacroDir(True)
+if os.path.exists(user_path):
+    macro_paths.append(("user", user_path))
+
+system_path = FreeCAD.getResourceDir() + "Macro"
+if os.path.exists(system_path):
+    macro_paths.append(("system", system_path))
+
+macros = []
+for source, path in macro_paths:
+    for filename in os.listdir(path):
+        if filename.endswith(".FCMacro"):
+            macro_file = os.path.join(path, filename)
+            description = ""
+            try:
+                with open(macro_file, "r") as f:
+                    for line in f:
+                        if line.startswith("#"):
+                            desc = line.lstrip("#").strip()
+                            if desc and not desc.startswith("!") and not desc.startswith("-*-"):
+                                description = desc
+                                break
+            except Exception:
+                pass
+
+            macros.append({
+                "name": filename[:-8],
+                "path": macro_file,
+                "description": description,
+                "is_system": source == "system",
+            })
+
+_result_ = macros
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [MacroInfo(**m) for m in result.result]
+        return []
+
get_object(obj_name, doc_name=None) async

Get detailed object information.

Source code in src/freecad_mcp/bridge/socket.py 
513
+514
+515
+516
+517
+518
+519
+520
+521
+522
+523
+524
+525
+526
+527
+528
+529
+530
+531
+532
+533
+534
+535
+536
+537
+538
+539
+540
+541
+542
+543
+544
+545
+546
+547
+548
+549
+550
+551
+552
+553
+554
+555
+556
+557
+558
+559
+560
+561
+562
+563
+564
+565
+566
+567
+568
+569
    async def get_object(
+        self,
+        obj_name: str,
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Get detailed object information."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+props = {{}}
+for prop in obj.PropertiesList:
+    try:
+        val = getattr(obj, prop)
+        if hasattr(val, '__class__') and val.__class__.__module__ != 'builtins':
+            val = str(val)
+        props[prop] = val
+    except Exception:
+        props[prop] = "<unreadable>"
+
+shape_info = None
+if hasattr(obj, "Shape"):
+    shape = obj.Shape
+    shape_info = {{
+        "shape_type": shape.ShapeType,
+        "volume": shape.Volume if hasattr(shape, "Volume") else None,
+        "area": shape.Area if hasattr(shape, "Area") else None,
+        "is_valid": shape.isValid(),
+        "is_closed": shape.isClosed() if hasattr(shape, "isClosed") else False,
+        "vertex_count": len(shape.Vertexes) if hasattr(shape, "Vertexes") else 0,
+        "edge_count": len(shape.Edges) if hasattr(shape, "Edges") else 0,
+        "face_count": len(shape.Faces) if hasattr(shape, "Faces") else 0,
+    }}
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "properties": props,
+    "shape_info": shape_info,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+    "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to get object"
+        raise ValueError(error_msg)
+
get_objects(doc_name=None) async

Get all objects in a document.

Source code in src/freecad_mcp/bridge/socket.py 
486
+487
+488
+489
+490
+491
+492
+493
+494
+495
+496
+497
+498
+499
+500
+501
+502
+503
+504
+505
+506
+507
+508
+509
+510
+511
    async def get_objects(self, doc_name: str | None = None) -> list[ObjectInfo]:
+        """Get all objects in a document."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+objects = []
+for obj in doc.Objects:
+    obj_info = {{
+        "name": obj.Name,
+        "label": obj.Label,
+        "type_id": obj.TypeId,
+        "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+        "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+        "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+    }}
+    objects.append(obj_info)
+
+_result_ = objects
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [ObjectInfo(**obj) for obj in result.result]
+        return []
+
get_screenshot(view_angle=None, width=800, height=600, doc_name=None) async

Capture a screenshot of the 3D view via socket.

Source code in src/freecad_mcp/bridge/socket.py 
679
+680
+681
+682
+683
+684
+685
+686
+687
+688
+689
+690
+691
+692
+693
+694
+695
+696
+697
+698
+699
+700
+701
+702
+703
+704
+705
+706
+707
+708
+709
+710
+711
+712
+713
+714
+715
+716
+717
+718
+719
+720
+721
+722
+723
+724
+725
+726
+727
+728
+729
+730
+731
+732
+733
+734
+735
+736
+737
+738
+739
+740
+741
+742
+743
+744
+745
+746
+747
+748
+749
+750
+751
+752
+753
+754
+755
+756
+757
+758
+759
+760
+761
+762
+763
+764
+765
+766
+767
+768
    async def get_screenshot(
+        self,
+        view_angle: ViewAngle | None = None,
+        width: int = 800,
+        height: int = 600,
+        doc_name: str | None = None,
+    ) -> ScreenshotResult:
+        """Capture a screenshot of the 3D view via socket."""
+        view_angle_str = view_angle.value if view_angle else "Isometric"
+        code = f"""
+import base64
+import tempfile
+import os
+
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+# Check if GUI is available
+if not FreeCAD.GuiUp:
+    raise RuntimeError("GUI not available")
+
+view = FreeCADGui.ActiveDocument.ActiveView
+if view is None:
+    raise ValueError("No active view")
+
+# Check view type
+view_type = view.__class__.__name__
+if view_type not in ["View3DInventor", "View3DInventorPy"]:
+    raise ValueError(f"Cannot capture screenshot from {{view_type}} view")
+
+# Set view angle
+view_type_str = {view_angle_str!r}
+if view_type_str == "FitAll":
+    view.fitAll()
+elif view_type_str == "Isometric":
+    view.viewIsometric()
+elif view_type_str == "Front":
+    view.viewFront()
+elif view_type_str == "Back":
+    view.viewRear()
+elif view_type_str == "Top":
+    view.viewTop()
+elif view_type_str == "Bottom":
+    view.viewBottom()
+elif view_type_str == "Left":
+    view.viewLeft()
+elif view_type_str == "Right":
+    view.viewRight()
+
+# Save to temp file and read
+with tempfile.NamedTemporaryFile(suffix=".png", delete=False) as f:
+    temp_path = f.name
+
+view.saveImage(temp_path, {width}, {height}, "Current")
+
+with open(temp_path, "rb") as f:
+    image_data = base64.b64encode(f.read()).decode("utf-8")
+
+os.unlink(temp_path)
+
+_result_ = {{
+    "success": True,
+    "data": image_data,
+    "format": "png",
+    "width": {width},
+    "height": {height},
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ScreenshotResult(
+                success=True,
+                data=result.result["data"],
+                format=result.result["format"],
+                width=result.result["width"],
+                height=result.result["height"],
+                view_angle=view_angle,
+            )
+
+        return ScreenshotResult(
+            success=False,
+            error=result.error_traceback
+            or result.stderr
+            or "Failed to capture screenshot",
+            width=width,
+            height=height,
+            view_angle=view_angle,
+        )
+
get_status() async

Get detailed connection status.

Returns:

Type Description
ConnectionStatus

ConnectionStatus with full status information.
Source code in src/freecad_mcp/bridge/socket.py 
228
+229
+230
+231
+232
+233
+234
+235
+236
+237
+238
+239
+240
+241
+242
+243
+244
+245
+246
+247
+248
+249
+250
+251
+252
+253
+254
+255
+256
+257
+258
async def get_status(self) -> ConnectionStatus:
+    """Get detailed connection status.
+
+    Returns:
+        ConnectionStatus with full status information.
+    """
+    if not self._connected:
+        return ConnectionStatus(
+            connected=False,
+            mode="socket",
+            error="Not connected",
+        )
+
+    try:
+        ping_ms = await self.ping()
+        version_info = await self.get_freecad_version()
+        gui_available = await self.is_gui_available()
+
+        return ConnectionStatus(
+            connected=True,
+            mode="socket",
+            freecad_version=version_info.get("version", "unknown"),
+            gui_available=gui_available,
+            last_ping_ms=ping_ms,
+        )
+    except Exception as e:
+        return ConnectionStatus(
+            connected=False,
+            mode="socket",
+            error=str(e),
+        )
+
get_workbenches() async

Get list of available workbenches.

Source code in src/freecad_mcp/bridge/socket.py 
951
+952
+953
+954
+955
+956
+957
+958
+959
+960
+961
+962
+963
+964
+965
+966
+967
+968
+969
+970
+971
+972
+973
+974
+975
+976
+977
+978
+979
+980
+981
+982
+983
+984
    async def get_workbenches(self) -> list[WorkbenchInfo]:
+        """Get list of available workbenches."""
+        code = """
+workbenches = []
+active_wb = FreeCADGui.activeWorkbench() if FreeCAD.GuiUp else None
+active_name = active_wb.__class__.__name__ if active_wb else None
+
+if FreeCAD.GuiUp:
+    for name in FreeCADGui.listWorkbenches():
+        wb = FreeCADGui.getWorkbench(name)
+        workbenches.append({
+            "name": name,
+            "label": wb.MenuText if hasattr(wb, "MenuText") else name,
+            "icon": wb.Icon if hasattr(wb, "Icon") else "",
+            "is_active": name == active_name,
+        })
+else:
+    common = ["StartWorkbench", "PartWorkbench", "PartDesignWorkbench",
+              "DraftWorkbench", "SketcherWorkbench", "MeshWorkbench"]
+    for name in common:
+        workbenches.append({
+            "name": name,
+            "label": name.replace("Workbench", ""),
+            "icon": "",
+            "is_active": False,
+        })
+
+_result_ = workbenches
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [WorkbenchInfo(**wb) for wb in result.result]
+        return []
+
is_connected() async

Check if bridge is connected to FreeCAD.

Source code in src/freecad_mcp/bridge/socket.py 
123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133
async def is_connected(self) -> bool:
+    """Check if bridge is connected to FreeCAD."""
+    if not self._connected or self._writer is None:
+        return False
+
+    try:
+        await self.ping()
+        return True
+    except Exception:
+        self._connected = False
+        return False
+
is_gui_available() async

Check if FreeCAD GUI is available.

Source code in src/freecad_mcp/bridge/socket.py 
1033
+1034
+1035
+1036
async def is_gui_available(self) -> bool:
+    """Check if FreeCAD GUI is available."""
+    result = await self.execute_python("_result_ = FreeCAD.GuiUp")
+    return bool(result.success and result.result)
+
open_document(path) async

Open an existing document.

Source code in src/freecad_mcp/bridge/socket.py 
408
+409
+410
+411
+412
+413
+414
+415
+416
+417
+418
+419
+420
+421
+422
+423
+424
+425
+426
+427
+428
+429
+430
+431
+432
+433
+434
    async def open_document(self, path: str) -> DocumentInfo:
+        """Open an existing document."""
+        result = await self.execute_python(
+            f"""
+import os
+if not os.path.exists({path!r}):
+    raise FileNotFoundError(f"File not found: {path!r}")
+
+doc = FreeCAD.openDocument({path!r})
+_result_ = {{
+    "name": doc.Name,
+    "label": doc.Label,
+    "path": doc.FileName or None,
+    "objects": [obj.Name for obj in doc.Objects],
+    "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+}}
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+
+        if "FileNotFoundError" in (result.error_type or ""):
+            raise FileNotFoundError(result.stderr)
+
+        error_msg = result.error_traceback or "Failed to open document"
+        raise ValueError(error_msg)
+
ping() async

Ping FreeCAD to check connection and measure latency.

Returns:

Type Description
float

Round-trip time in milliseconds.

Raises:

Type Description
ConnectionError

If not connected.
Source code in src/freecad_mcp/bridge/socket.py 
215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
async def ping(self) -> float:
+    """Ping FreeCAD to check connection and measure latency.
+
+    Returns:
+        Round-trip time in milliseconds.
+
+    Raises:
+        ConnectionError: If not connected.
+    """
+    start = time.perf_counter()
+    await self._send_request("ping")
+    return (time.perf_counter() - start) * 1000
+
run_macro(macro_name, args=None) async

Run a macro by name.

Source code in src/freecad_mcp/bridge/socket.py 
862
+863
+864
+865
+866
+867
+868
+869
+870
+871
+872
+873
+874
+875
+876
+877
+878
+879
+880
+881
+882
+883
+884
+885
+886
+887
+888
+889
+890
+891
+892
+893
+894
+895
+896
+897
+898
+899
    async def run_macro(
+        self,
+        macro_name: str,
+        args: dict[str, Any] | None = None,
+    ) -> ExecutionResult:
+        """Run a macro by name."""
+        args = args or {}
+        code = f"""
+import os
+
+macro_name = {macro_name!r}
+macro_file = None
+
+user_path = FreeCAD.getUserMacroDir(True)
+user_macro = os.path.join(user_path, macro_name + ".FCMacro")
+if os.path.exists(user_macro):
+    macro_file = user_macro
+
+if not macro_file:
+    system_path = FreeCAD.getResourceDir() + "Macro"
+    system_macro = os.path.join(system_path, macro_name + ".FCMacro")
+    if os.path.exists(system_macro):
+        macro_file = system_macro
+
+if not macro_file:
+    raise FileNotFoundError(f"Macro not found: {{macro_name}}")
+
+args = {args!r}
+for k, v in args.items():
+    exec(f"{{k}} = {{v!r}}")
+
+with open(macro_file, "r") as f:
+    macro_code = f.read()
+
+exec(macro_code)
+_result_ = True
+"""
+        return await self.execute_python(code)
+
save_document(doc_name=None, path=None) async

Save a document.

Source code in src/freecad_mcp/bridge/socket.py 
436
+437
+438
+439
+440
+441
+442
+443
+444
+445
+446
+447
+448
+449
+450
+451
+452
+453
+454
+455
+456
+457
+458
+459
+460
    async def save_document(
+        self,
+        doc_name: str | None = None,
+        path: str | None = None,
+    ) -> str:
+        """Save a document."""
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No active document" if {doc_name!r} is None else f"Document not found: {doc_name!r}")
+
+save_path = {path!r} or doc.FileName
+if not save_path:
+    raise ValueError("No path specified for new document")
+
+doc.saveAs(save_path)
+_result_ = save_path
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return result.result
+
+        error_msg = result.error_traceback or "Failed to save document"
+        raise ValueError(error_msg)
+
set_view(view_angle, doc_name=None) async

Set the 3D view angle.

Source code in src/freecad_mcp/bridge/socket.py 
770
+771
+772
+773
+774
+775
+776
+777
+778
+779
+780
+781
+782
+783
+784
+785
+786
+787
+788
+789
+790
+791
+792
+793
+794
+795
+796
+797
+798
+799
+800
+801
+802
+803
+804
+805
+806
+807
+808
+809
    async def set_view(
+        self,
+        view_angle: ViewAngle,
+        doc_name: str | None = None,
+    ) -> None:
+        """Set the 3D view angle."""
+        view_angle_str = view_angle.value
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+if not FreeCAD.GuiUp:
+    _result_ = True
+else:
+    view = FreeCADGui.ActiveDocument.ActiveView
+    if view is None:
+        raise ValueError("No active view")
+
+    view_type = {view_angle_str!r}
+    if view_type == "FitAll":
+        view.fitAll()
+    elif view_type == "Isometric":
+        view.viewIsometric()
+    elif view_type == "Front":
+        view.viewFront()
+    elif view_type == "Back":
+        view.viewRear()
+    elif view_type == "Top":
+        view.viewTop()
+    elif view_type == "Bottom":
+        view.viewBottom()
+    elif view_type == "Left":
+        view.viewLeft()
+    elif view_type == "Right":
+        view.viewRight()
+
+    _result_ = True
+"""
+        await self.execute_python(code)
+

options: show_root_heading: true show_source: true

Embedded Bridge

Linux Only

The embedded bridge only works on Linux. See Connection Modes for details.

freecad_mcp.bridge.embedded

Embedded bridge - runs FreeCAD in-process.

This bridge imports FreeCAD directly into the Robust MCP Server process, providing the fastest execution but limited to headless mode.

Based on learnings from competitive analysis: - Thread-safe execution using ThreadPoolExecutor (from neka-nat) - Comprehensive object info including shape geometry - Macro support with templates and validation

Classes

EmbeddedBridge

Bases: FreecadBridge

Bridge that runs FreeCAD embedded in the Robust MCP Server process.

This bridge imports FreeCAD directly, providing fast execution but only supports headless mode (no GUI).

Attributes:

Name Type Description
freecad_path

Optional path to FreeCAD's lib directory.
Source code in src/freecad_mcp/bridge/embedded.py 
  35
+  36
+  37
+  38
+  39
+  40
+  41
+  42
+  43
+  44
+  45
+  46
+  47
+  48
+  49
+  50
+  51
+  52
+  53
+  54
+  55
+  56
+  57
+  58
+  59
+  60
+  61
+  62
+  63
+  64
+  65
+  66
+  67
+  68
+  69
+  70
+  71
+  72
+  73
+  74
+  75
+  76
+  77
+  78
+  79
+  80
+  81
+  82
+  83
+  84
+  85
+  86
+  87
+  88
+  89
+  90
+  91
+  92
+  93
+  94
+  95
+  96
+  97
+  98
+  99
+ 100
+ 101
+ 102
+ 103
+ 104
+ 105
+ 106
+ 107
+ 108
+ 109
+ 110
+ 111
+ 112
+ 113
+ 114
+ 115
+ 116
+ 117
+ 118
+ 119
+ 120
+ 121
+ 122
+ 123
+ 124
+ 125
+ 126
+ 127
+ 128
+ 129
+ 130
+ 131
+ 132
+ 133
+ 134
+ 135
+ 136
+ 137
+ 138
+ 139
+ 140
+ 141
+ 142
+ 143
+ 144
+ 145
+ 146
+ 147
+ 148
+ 149
+ 150
+ 151
+ 152
+ 153
+ 154
+ 155
+ 156
+ 157
+ 158
+ 159
+ 160
+ 161
+ 162
+ 163
+ 164
+ 165
+ 166
+ 167
+ 168
+ 169
+ 170
+ 171
+ 172
+ 173
+ 174
+ 175
+ 176
+ 177
+ 178
+ 179
+ 180
+ 181
+ 182
+ 183
+ 184
+ 185
+ 186
+ 187
+ 188
+ 189
+ 190
+ 191
+ 192
+ 193
+ 194
+ 195
+ 196
+ 197
+ 198
+ 199
+ 200
+ 201
+ 202
+ 203
+ 204
+ 205
+ 206
+ 207
+ 208
+ 209
+ 210
+ 211
+ 212
+ 213
+ 214
+ 215
+ 216
+ 217
+ 218
+ 219
+ 220
+ 221
+ 222
+ 223
+ 224
+ 225
+ 226
+ 227
+ 228
+ 229
+ 230
+ 231
+ 232
+ 233
+ 234
+ 235
+ 236
+ 237
+ 238
+ 239
+ 240
+ 241
+ 242
+ 243
+ 244
+ 245
+ 246
+ 247
+ 248
+ 249
+ 250
+ 251
+ 252
+ 253
+ 254
+ 255
+ 256
+ 257
+ 258
+ 259
+ 260
+ 261
+ 262
+ 263
+ 264
+ 265
+ 266
+ 267
+ 268
+ 269
+ 270
+ 271
+ 272
+ 273
+ 274
+ 275
+ 276
+ 277
+ 278
+ 279
+ 280
+ 281
+ 282
+ 283
+ 284
+ 285
+ 286
+ 287
+ 288
+ 289
+ 290
+ 291
+ 292
+ 293
+ 294
+ 295
+ 296
+ 297
+ 298
+ 299
+ 300
+ 301
+ 302
+ 303
+ 304
+ 305
+ 306
+ 307
+ 308
+ 309
+ 310
+ 311
+ 312
+ 313
+ 314
+ 315
+ 316
+ 317
+ 318
+ 319
+ 320
+ 321
+ 322
+ 323
+ 324
+ 325
+ 326
+ 327
+ 328
+ 329
+ 330
+ 331
+ 332
+ 333
+ 334
+ 335
+ 336
+ 337
+ 338
+ 339
+ 340
+ 341
+ 342
+ 343
+ 344
+ 345
+ 346
+ 347
+ 348
+ 349
+ 350
+ 351
+ 352
+ 353
+ 354
+ 355
+ 356
+ 357
+ 358
+ 359
+ 360
+ 361
+ 362
+ 363
+ 364
+ 365
+ 366
+ 367
+ 368
+ 369
+ 370
+ 371
+ 372
+ 373
+ 374
+ 375
+ 376
+ 377
+ 378
+ 379
+ 380
+ 381
+ 382
+ 383
+ 384
+ 385
+ 386
+ 387
+ 388
+ 389
+ 390
+ 391
+ 392
+ 393
+ 394
+ 395
+ 396
+ 397
+ 398
+ 399
+ 400
+ 401
+ 402
+ 403
+ 404
+ 405
+ 406
+ 407
+ 408
+ 409
+ 410
+ 411
+ 412
+ 413
+ 414
+ 415
+ 416
+ 417
+ 418
+ 419
+ 420
+ 421
+ 422
+ 423
+ 424
+ 425
+ 426
+ 427
+ 428
+ 429
+ 430
+ 431
+ 432
+ 433
+ 434
+ 435
+ 436
+ 437
+ 438
+ 439
+ 440
+ 441
+ 442
+ 443
+ 444
+ 445
+ 446
+ 447
+ 448
+ 449
+ 450
+ 451
+ 452
+ 453
+ 454
+ 455
+ 456
+ 457
+ 458
+ 459
+ 460
+ 461
+ 462
+ 463
+ 464
+ 465
+ 466
+ 467
+ 468
+ 469
+ 470
+ 471
+ 472
+ 473
+ 474
+ 475
+ 476
+ 477
+ 478
+ 479
+ 480
+ 481
+ 482
+ 483
+ 484
+ 485
+ 486
+ 487
+ 488
+ 489
+ 490
+ 491
+ 492
+ 493
+ 494
+ 495
+ 496
+ 497
+ 498
+ 499
+ 500
+ 501
+ 502
+ 503
+ 504
+ 505
+ 506
+ 507
+ 508
+ 509
+ 510
+ 511
+ 512
+ 513
+ 514
+ 515
+ 516
+ 517
+ 518
+ 519
+ 520
+ 521
+ 522
+ 523
+ 524
+ 525
+ 526
+ 527
+ 528
+ 529
+ 530
+ 531
+ 532
+ 533
+ 534
+ 535
+ 536
+ 537
+ 538
+ 539
+ 540
+ 541
+ 542
+ 543
+ 544
+ 545
+ 546
+ 547
+ 548
+ 549
+ 550
+ 551
+ 552
+ 553
+ 554
+ 555
+ 556
+ 557
+ 558
+ 559
+ 560
+ 561
+ 562
+ 563
+ 564
+ 565
+ 566
+ 567
+ 568
+ 569
+ 570
+ 571
+ 572
+ 573
+ 574
+ 575
+ 576
+ 577
+ 578
+ 579
+ 580
+ 581
+ 582
+ 583
+ 584
+ 585
+ 586
+ 587
+ 588
+ 589
+ 590
+ 591
+ 592
+ 593
+ 594
+ 595
+ 596
+ 597
+ 598
+ 599
+ 600
+ 601
+ 602
+ 603
+ 604
+ 605
+ 606
+ 607
+ 608
+ 609
+ 610
+ 611
+ 612
+ 613
+ 614
+ 615
+ 616
+ 617
+ 618
+ 619
+ 620
+ 621
+ 622
+ 623
+ 624
+ 625
+ 626
+ 627
+ 628
+ 629
+ 630
+ 631
+ 632
+ 633
+ 634
+ 635
+ 636
+ 637
+ 638
+ 639
+ 640
+ 641
+ 642
+ 643
+ 644
+ 645
+ 646
+ 647
+ 648
+ 649
+ 650
+ 651
+ 652
+ 653
+ 654
+ 655
+ 656
+ 657
+ 658
+ 659
+ 660
+ 661
+ 662
+ 663
+ 664
+ 665
+ 666
+ 667
+ 668
+ 669
+ 670
+ 671
+ 672
+ 673
+ 674
+ 675
+ 676
+ 677
+ 678
+ 679
+ 680
+ 681
+ 682
+ 683
+ 684
+ 685
+ 686
+ 687
+ 688
+ 689
+ 690
+ 691
+ 692
+ 693
+ 694
+ 695
+ 696
+ 697
+ 698
+ 699
+ 700
+ 701
+ 702
+ 703
+ 704
+ 705
+ 706
+ 707
+ 708
+ 709
+ 710
+ 711
+ 712
+ 713
+ 714
+ 715
+ 716
+ 717
+ 718
+ 719
+ 720
+ 721
+ 722
+ 723
+ 724
+ 725
+ 726
+ 727
+ 728
+ 729
+ 730
+ 731
+ 732
+ 733
+ 734
+ 735
+ 736
+ 737
+ 738
+ 739
+ 740
+ 741
+ 742
+ 743
+ 744
+ 745
+ 746
+ 747
+ 748
+ 749
+ 750
+ 751
+ 752
+ 753
+ 754
+ 755
+ 756
+ 757
+ 758
+ 759
+ 760
+ 761
+ 762
+ 763
+ 764
+ 765
+ 766
+ 767
+ 768
+ 769
+ 770
+ 771
+ 772
+ 773
+ 774
+ 775
+ 776
+ 777
+ 778
+ 779
+ 780
+ 781
+ 782
+ 783
+ 784
+ 785
+ 786
+ 787
+ 788
+ 789
+ 790
+ 791
+ 792
+ 793
+ 794
+ 795
+ 796
+ 797
+ 798
+ 799
+ 800
+ 801
+ 802
+ 803
+ 804
+ 805
+ 806
+ 807
+ 808
+ 809
+ 810
+ 811
+ 812
+ 813
+ 814
+ 815
+ 816
+ 817
+ 818
+ 819
+ 820
+ 821
+ 822
+ 823
+ 824
+ 825
+ 826
+ 827
+ 828
+ 829
+ 830
+ 831
+ 832
+ 833
+ 834
+ 835
+ 836
+ 837
+ 838
+ 839
+ 840
+ 841
+ 842
+ 843
+ 844
+ 845
+ 846
+ 847
+ 848
+ 849
+ 850
+ 851
+ 852
+ 853
+ 854
+ 855
+ 856
+ 857
+ 858
+ 859
+ 860
+ 861
+ 862
+ 863
+ 864
+ 865
+ 866
+ 867
+ 868
+ 869
+ 870
+ 871
+ 872
+ 873
+ 874
+ 875
+ 876
+ 877
+ 878
+ 879
+ 880
+ 881
+ 882
+ 883
+ 884
+ 885
+ 886
+ 887
+ 888
+ 889
+ 890
+ 891
+ 892
+ 893
+ 894
+ 895
+ 896
+ 897
+ 898
+ 899
+ 900
+ 901
+ 902
+ 903
+ 904
+ 905
+ 906
+ 907
+ 908
+ 909
+ 910
+ 911
+ 912
+ 913
+ 914
+ 915
+ 916
+ 917
+ 918
+ 919
+ 920
+ 921
+ 922
+ 923
+ 924
+ 925
+ 926
+ 927
+ 928
+ 929
+ 930
+ 931
+ 932
+ 933
+ 934
+ 935
+ 936
+ 937
+ 938
+ 939
+ 940
+ 941
+ 942
+ 943
+ 944
+ 945
+ 946
+ 947
+ 948
+ 949
+ 950
+ 951
+ 952
+ 953
+ 954
+ 955
+ 956
+ 957
+ 958
+ 959
+ 960
+ 961
+ 962
+ 963
+ 964
+ 965
+ 966
+ 967
+ 968
+ 969
+ 970
+ 971
+ 972
+ 973
+ 974
+ 975
+ 976
+ 977
+ 978
+ 979
+ 980
+ 981
+ 982
+ 983
+ 984
+ 985
+ 986
+ 987
+ 988
+ 989
+ 990
+ 991
+ 992
+ 993
+ 994
+ 995
+ 996
+ 997
+ 998
+ 999
+1000
+1001
+1002
+1003
+1004
+1005
+1006
+1007
+1008
+1009
+1010
+1011
+1012
+1013
+1014
+1015
+1016
+1017
+1018
+1019
+1020
+1021
+1022
+1023
+1024
+1025
+1026
+1027
+1028
+1029
+1030
+1031
+1032
+1033
+1034
+1035
+1036
+1037
+1038
+1039
+1040
+1041
+1042
+1043
+1044
+1045
+1046
+1047
+1048
+1049
+1050
+1051
+1052
+1053
+1054
+1055
+1056
+1057
+1058
+1059
+1060
+1061
+1062
+1063
+1064
class EmbeddedBridge(FreecadBridge):
+    """Bridge that runs FreeCAD embedded in the Robust MCP Server process.
+
+    This bridge imports FreeCAD directly, providing fast execution
+    but only supports headless mode (no GUI).
+
+    Attributes:
+        freecad_path: Optional path to FreeCAD's lib directory.
+    """
+
+    def __init__(self, freecad_path: str | None = None) -> None:
+        """Initialize the embedded bridge.
+
+        Args:
+            freecad_path: Path to FreeCAD's lib directory. If provided,
+                this path will be added to sys.path before importing.
+        """
+        self._freecad_path = freecad_path
+        self._fc_module: Any = None
+        self._executor = ThreadPoolExecutor(max_workers=1, thread_name_prefix="freecad")
+        self._connected = False
+
+    async def connect(self) -> None:
+        """Import and initialize FreeCAD.
+
+        Raises:
+            ConnectionError: If FreeCAD cannot be imported.
+        """
+        if self._freecad_path:
+            sys.path.insert(0, self._freecad_path)
+
+        loop = asyncio.get_event_loop()
+        try:
+            self._fc_module = await loop.run_in_executor(
+                self._executor,
+                self._import_freecad,
+            )
+            self._connected = True
+        except ImportError as e:
+            msg = f"Failed to import FreeCAD: {e}"
+            raise ConnectionError(msg) from e
+
+    def _import_freecad(self) -> Any:
+        """Import FreeCAD module (runs in thread pool)."""
+        import FreeCAD
+
+        return FreeCAD
+
+    async def disconnect(self) -> None:
+        """Clean up resources."""
+        self._connected = False
+        self._executor.shutdown(wait=True)
+
+    async def is_connected(self) -> bool:
+        """Check if FreeCAD is imported and available."""
+        return self._connected and self._fc_module is not None
+
+    async def execute_python(
+        self,
+        code: str,
+        timeout_ms: int = 30000,
+    ) -> ExecutionResult:
+        """Execute Python code in FreeCAD context.
+
+        Args:
+            code: Python code to execute.
+            timeout_ms: Maximum execution time in milliseconds.
+
+        Returns:
+            ExecutionResult with execution outcome.
+        """
+        if not self._connected:
+            return ExecutionResult(
+                success=False,
+                result=None,
+                stdout="",
+                stderr="FreeCAD bridge not connected",
+                execution_time_ms=0,
+                error_type="ConnectionError",
+                error_traceback=None,
+            )
+
+        loop = asyncio.get_event_loop()
+
+        try:
+            result = await asyncio.wait_for(
+                loop.run_in_executor(
+                    self._executor,
+                    lambda: self._execute_code(code),
+                ),
+                timeout=timeout_ms / 1000,
+            )
+        except TimeoutError:
+            return ExecutionResult(
+                success=False,
+                result=None,
+                stdout="",
+                stderr=f"Execution timed out after {timeout_ms}ms",
+                execution_time_ms=float(timeout_ms),
+                error_type="TimeoutError",
+                error_traceback=None,
+            )
+
+        return result
+
+    def _execute_code(self, code: str) -> ExecutionResult:
+        """Execute code synchronously (runs in thread pool)."""
+        start = time.perf_counter()
+        stdout_capture = io.StringIO()
+        stderr_capture = io.StringIO()
+
+        # Build execution context
+        exec_globals: dict[str, Any] = {
+            "FreeCAD": self._fc_module,
+            "App": self._fc_module,
+            "__builtins__": __builtins__,
+        }
+
+        # Try to add GUI module if available
+        try:
+            import FreeCADGui
+
+            exec_globals["FreeCADGui"] = FreeCADGui
+            exec_globals["Gui"] = FreeCADGui
+        except ImportError:
+            pass
+
+        try:
+            with redirect_stdout(stdout_capture), redirect_stderr(stderr_capture):
+                compiled = compile(code, "<mcp>", "exec")
+                exec(compiled, exec_globals)  # noqa: S102
+
+            elapsed = (time.perf_counter() - start) * 1000
+
+            return ExecutionResult(
+                success=True,
+                result=exec_globals.get("_result_"),
+                stdout=stdout_capture.getvalue(),
+                stderr=stderr_capture.getvalue(),
+                execution_time_ms=elapsed,
+            )
+
+        except Exception as e:
+            import traceback
+
+            elapsed = (time.perf_counter() - start) * 1000
+
+            return ExecutionResult(
+                success=False,
+                result=None,
+                stdout=stdout_capture.getvalue(),
+                stderr=stderr_capture.getvalue(),
+                execution_time_ms=elapsed,
+                error_type=type(e).__name__,
+                error_traceback=traceback.format_exc(),
+            )
+
+    async def get_documents(self) -> list[DocumentInfo]:
+        """Get list of open documents."""
+        result = await self.execute_python(
+            """
+_result_ = []
+for doc in FreeCAD.listDocuments().values():
+    _result_.append({
+        "name": doc.Name,
+        "path": doc.FileName or None,
+        "objects": [obj.Name for obj in doc.Objects],
+        "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+        "label": doc.Label,
+    })
+"""
+        )
+
+        if result.success and result.result:
+            return [DocumentInfo(**doc) for doc in result.result]
+        return []
+
+    async def get_active_document(self) -> DocumentInfo | None:
+        """Get the active document."""
+        result = await self.execute_python(
+            """
+doc = FreeCAD.ActiveDocument
+if doc:
+    _result_ = {
+        "name": doc.Name,
+        "path": doc.FileName or None,
+        "objects": [obj.Name for obj in doc.Objects],
+        "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+        "label": doc.Label,
+    }
+else:
+    _result_ = None
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+        return None
+
+    async def get_object(
+        self,
+        obj_name: str,
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Get detailed object information."""
+        result = await self.execute_python(
+            f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+props = {{}}
+for prop in obj.PropertiesList:
+    try:
+        val = getattr(obj, prop)
+        if hasattr(val, '__class__') and val.__class__.__module__ != 'builtins':
+            val = str(val)
+        props[prop] = val
+    except Exception:
+        props[prop] = "<unreadable>"
+
+shape_info = None
+if hasattr(obj, "Shape"):
+    shape = obj.Shape
+    shape_info = {{
+        "type": shape.ShapeType,
+        "volume": shape.Volume if hasattr(shape, "Volume") else None,
+        "area": shape.Area if hasattr(shape, "Area") else None,
+        "is_valid": shape.isValid(),
+    }}
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "properties": props,
+    "shape_info": shape_info,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+}}
+"""
+        )
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to get object"
+        raise ValueError(error_msg)
+
+    async def get_console_output(
+        self,
+        lines: int = 100,
+    ) -> list[str]:
+        """Get recent console output.
+
+        Note: In embedded mode, we don't have direct access to FreeCAD's
+        console history, so we return an empty list or captured output.
+        """
+        return []
+
+    async def get_freecad_version(self) -> dict[str, Any]:
+        """Get FreeCAD version information."""
+        result = await self.execute_python(
+            """
+import sys
+_result_ = {
+    "version": ".".join(str(x) for x in FreeCAD.Version()[:3]),
+    "version_tuple": FreeCAD.Version()[:3],
+    "build_date": FreeCAD.Version()[3] if len(FreeCAD.Version()) > 3 else "unknown",
+    "python_version": sys.version,
+    "gui_available": hasattr(FreeCAD, "GuiUp") and FreeCAD.GuiUp,
+}
+"""
+        )
+
+        if result.success and result.result:
+            return result.result
+
+        return {
+            "version": "unknown",
+            "version_tuple": [],
+            "build_date": "unknown",
+            "python_version": sys.version,
+            "gui_available": False,
+        }
+
+    async def is_gui_available(self) -> bool:
+        """Check if GUI is available."""
+        result = await self.execute_python(
+            "_result_ = hasattr(FreeCAD, 'GuiUp') and FreeCAD.GuiUp"
+        )
+        return bool(result.success and result.result)
+
+    async def ping(self) -> float:
+        """Ping FreeCAD to check connection and measure latency.
+
+        Returns:
+            Round-trip time in milliseconds.
+
+        Raises:
+            ConnectionError: If not connected.
+        """
+        if not self._connected:
+            msg = "Not connected to FreeCAD"
+            raise ConnectionError(msg)
+
+        start = time.perf_counter()
+        result = await self.execute_python("_result_ = True")
+        elapsed = (time.perf_counter() - start) * 1000
+
+        if not result.success:
+            msg = "Ping failed"
+            raise ConnectionError(msg)
+
+        return elapsed
+
+    async def get_status(self) -> ConnectionStatus:
+        """Get detailed connection status.
+
+        Returns:
+            ConnectionStatus with full status information.
+        """
+        if not self._connected:
+            return ConnectionStatus(
+                connected=False,
+                mode="embedded",
+                error="Not connected",
+            )
+
+        try:
+            ping_ms = await self.ping()
+            version_info = await self.get_freecad_version()
+            gui_available = await self.is_gui_available()
+
+            return ConnectionStatus(
+                connected=True,
+                mode="embedded",
+                freecad_version=version_info.get("version", "unknown"),
+                gui_available=gui_available,
+                last_ping_ms=ping_ms,
+            )
+        except Exception as e:
+            return ConnectionStatus(
+                connected=False,
+                mode="embedded",
+                error=str(e),
+            )
+
+    # =========================================================================
+    # Document Management
+    # =========================================================================
+
+    async def create_document(
+        self, name: str, label: str | None = None
+    ) -> DocumentInfo:
+        """Create a new document.
+
+        Args:
+            name: Internal document name (no spaces).
+            label: Display label (optional, defaults to name).
+
+        Returns:
+            DocumentInfo for the created document.
+        """
+        label = label or name
+        result = await self.execute_python(
+            f"""
+doc = FreeCAD.newDocument({name!r})
+doc.Label = {label!r}
+_result_ = {{
+    "name": doc.Name,
+    "label": doc.Label,
+    "path": doc.FileName or None,
+    "objects": [],
+    "is_modified": False,
+}}
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create document"
+        raise ValueError(error_msg)
+
+    async def open_document(self, path: str) -> DocumentInfo:
+        """Open an existing document.
+
+        Args:
+            path: Path to the .FCStd file.
+
+        Returns:
+            DocumentInfo for the opened document.
+
+        Raises:
+            FileNotFoundError: If file doesn't exist.
+            ValueError: If file is not a valid FreeCAD document.
+        """
+        if not Path(path).exists():
+            msg = f"File not found: {path}"
+            raise FileNotFoundError(msg)
+
+        result = await self.execute_python(
+            f"""
+doc = FreeCAD.openDocument({path!r})
+_result_ = {{
+    "name": doc.Name,
+    "label": doc.Label,
+    "path": doc.FileName or None,
+    "objects": [obj.Name for obj in doc.Objects],
+    "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+}}
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to open document"
+        raise ValueError(error_msg)
+
+    async def save_document(
+        self,
+        doc_name: str | None = None,
+        path: str | None = None,
+    ) -> str:
+        """Save a document.
+
+        Args:
+            doc_name: Document name (uses active if None).
+            path: Save path (uses existing path if None).
+
+        Returns:
+            Path where document was saved.
+
+        Raises:
+            ValueError: If document not found or no path specified for new doc.
+        """
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No active document" if {doc_name!r} is None else f"Document not found: {doc_name!r}")
+
+save_path = {path!r} or doc.FileName
+if not save_path:
+    raise ValueError("No path specified for new document")
+
+doc.saveAs(save_path)
+_result_ = save_path
+"""
+
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return result.result
+
+        error_msg = result.error_traceback or "Failed to save document"
+        raise ValueError(error_msg)
+
+    async def close_document(self, doc_name: str | None = None) -> None:
+        """Close a document.
+
+        Args:
+            doc_name: Document name (uses active if None).
+        """
+        code = f"""
+doc_name = {doc_name!r}
+if doc_name is None:
+    doc = FreeCAD.ActiveDocument
+    if doc:
+        doc_name = doc.Name
+    else:
+        raise ValueError("No active document")
+
+FreeCAD.closeDocument(doc_name)
+_result_ = True
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to close document"
+            raise ValueError(error_msg)
+
+    # =========================================================================
+    # Object Management
+    # =========================================================================
+
+    async def get_objects(self, doc_name: str | None = None) -> list[ObjectInfo]:
+        """Get all objects in a document.
+
+        Args:
+            doc_name: Document name (uses active if None).
+
+        Returns:
+            List of ObjectInfo for each object.
+        """
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+objects = []
+for obj in doc.Objects:
+    obj_info = {{
+        "name": obj.Name,
+        "label": obj.Label,
+        "type_id": obj.TypeId,
+        "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+        "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+        "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+    }}
+    objects.append(obj_info)
+
+_result_ = objects
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [ObjectInfo(**obj) for obj in result.result]
+        return []
+
+    async def create_object(
+        self,
+        type_id: str,
+        name: str | None = None,
+        properties: dict[str, Any] | None = None,
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Create a new object.
+
+        Args:
+            type_id: FreeCAD type ID (e.g., "Part::Box", "Part::Cylinder").
+            name: Object name (auto-generated if None).
+            properties: Initial property values.
+            doc_name: Target document (uses active if None).
+
+        Returns:
+            ObjectInfo for the created object.
+        """
+        properties = properties or {}
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.addObject({type_id!r}, {name!r} or "")
+
+# Set properties
+for prop_name, prop_val in {properties!r}.items():
+    if hasattr(obj, prop_name):
+        setattr(obj, prop_name, prop_val)
+
+doc.recompute()
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "visibility": True,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create object"
+        raise ValueError(error_msg)
+
+    async def edit_object(
+        self,
+        obj_name: str,
+        properties: dict[str, Any],
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Edit object properties.
+
+        Args:
+            obj_name: Name of the object to edit.
+            properties: Property values to set.
+            doc_name: Document name (uses active if None).
+
+        Returns:
+            Updated ObjectInfo.
+
+        Raises:
+            ValueError: If object not found.
+        """
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+# Set properties
+for prop_name, prop_val in {properties!r}.items():
+    if hasattr(obj, prop_name):
+        setattr(obj, prop_name, prop_val)
+
+doc.recompute()
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to edit object"
+        raise ValueError(error_msg)
+
+    async def delete_object(
+        self,
+        obj_name: str,
+        doc_name: str | None = None,
+    ) -> None:
+        """Delete an object.
+
+        Args:
+            obj_name: Name of the object to delete.
+            doc_name: Document name (uses active if None).
+
+        Raises:
+            ValueError: If object not found.
+        """
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+doc.removeObject({obj_name!r})
+_result_ = True
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to delete object"
+            raise ValueError(error_msg)
+
+    # =========================================================================
+    # View and Screenshot
+    # =========================================================================
+
+    async def get_screenshot(
+        self,
+        view_angle: ViewAngle | None = None,
+        width: int = 800,
+        height: int = 600,
+        doc_name: str | None = None,
+    ) -> ScreenshotResult:
+        """Capture a screenshot of the 3D view.
+
+        Note: In embedded headless mode, screenshots are typically not available.
+
+        Args:
+            view_angle: View angle to set before capture.
+            width: Image width in pixels.
+            height: Image height in pixels.
+            doc_name: Document name (uses active if None).
+
+        Returns:
+            ScreenshotResult with image data or error.
+        """
+        # Check if GUI is available
+        gui_available = await self.is_gui_available()
+
+        if not gui_available:
+            return ScreenshotResult(
+                success=False,
+                error="Screenshots not available in headless mode",
+                width=width,
+                height=height,
+                view_angle=view_angle,
+            )
+
+        # If GUI is available, attempt screenshot
+        view_angle_str = view_angle.value if view_angle else "Isometric"
+        code = f"""
+import base64
+import tempfile
+import os
+
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+view = FreeCADGui.ActiveDocument.ActiveView
+if view is None:
+    raise ValueError("No active view")
+
+# Set view angle
+view_type = {view_angle_str!r}
+if view_type == "FitAll":
+    view.fitAll()
+elif view_type == "Isometric":
+    view.viewIsometric()
+elif view_type == "Front":
+    view.viewFront()
+elif view_type == "Back":
+    view.viewRear()
+elif view_type == "Top":
+    view.viewTop()
+elif view_type == "Bottom":
+    view.viewBottom()
+elif view_type == "Left":
+    view.viewLeft()
+elif view_type == "Right":
+    view.viewRight()
+
+# Save to temp file and read
+with tempfile.NamedTemporaryFile(suffix=".png", delete=False) as f:
+    temp_path = f.name
+
+view.saveImage(temp_path, {width}, {height}, "Current")
+
+with open(temp_path, "rb") as f:
+    image_data = base64.b64encode(f.read()).decode("utf-8")
+
+os.unlink(temp_path)
+
+_result_ = {{
+    "success": True,
+    "data": image_data,
+    "format": "png",
+    "width": {width},
+    "height": {height},
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ScreenshotResult(
+                success=True,
+                data=result.result["data"],
+                format=result.result["format"],
+                width=result.result["width"],
+                height=result.result["height"],
+                view_angle=view_angle,
+            )
+
+        return ScreenshotResult(
+            success=False,
+            error=result.error_traceback or "Failed to capture screenshot",
+            width=width,
+            height=height,
+            view_angle=view_angle,
+        )
+
+    async def set_view(
+        self,
+        view_angle: ViewAngle,
+        doc_name: str | None = None,
+    ) -> None:
+        """Set the 3D view angle.
+
+        Args:
+            view_angle: View angle to set.
+            doc_name: Document name (uses active if None).
+        """
+        gui_available = await self.is_gui_available()
+
+        if not gui_available:
+            return  # Silently ignore in headless mode
+
+        view_angle_str = view_angle.value
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+view = FreeCADGui.ActiveDocument.ActiveView
+if view is None:
+    raise ValueError("No active view")
+
+view_type = {view_angle_str!r}
+if view_type == "FitAll":
+    view.fitAll()
+elif view_type == "Isometric":
+    view.viewIsometric()
+elif view_type == "Front":
+    view.viewFront()
+elif view_type == "Back":
+    view.viewRear()
+elif view_type == "Top":
+    view.viewTop()
+elif view_type == "Bottom":
+    view.viewBottom()
+elif view_type == "Left":
+    view.viewLeft()
+elif view_type == "Right":
+    view.viewRight()
+
+_result_ = True
+"""
+        await self.execute_python(code)
+
+    # =========================================================================
+    # Macros
+    # =========================================================================
+
+    def _get_macro_path(self) -> Path:
+        """Get the FreeCAD macro directory path."""
+        # Default FreeCAD macro locations
+        if sys.platform == "darwin":
+            return Path.home() / "Library" / "Application Support" / "FreeCAD" / "Macro"
+        elif sys.platform == "win32":
+            return Path(os.environ.get("APPDATA", "")) / "FreeCAD" / "Macro"
+        else:
+            return Path.home() / ".local" / "share" / "FreeCAD" / "Macro"
+
+    async def get_macros(self) -> list[MacroInfo]:
+        """Get list of available macros.
+
+        Returns:
+            List of MacroInfo for each macro.
+        """
+        macro_path = self._get_macro_path()
+
+        if not macro_path.exists():
+            return []
+
+        macros = []
+        for macro_file in macro_path.glob("*.FCMacro"):
+            description = ""
+            try:
+                content = macro_file.read_text()
+                # Extract description from first comment block
+                for line in content.split("\n"):
+                    if line.startswith("#"):
+                        desc_line = line.lstrip("#").strip()
+                        if desc_line and not desc_line.startswith("!"):
+                            description = desc_line
+                            break
+            except Exception:
+                pass
+
+            macros.append(
+                MacroInfo(
+                    name=macro_file.stem,
+                    path=str(macro_file),
+                    description=description,
+                    is_system=False,
+                )
+            )
+
+        return macros
+
+    async def run_macro(
+        self,
+        macro_name: str,
+        args: dict[str, Any] | None = None,
+    ) -> ExecutionResult:
+        """Run a macro by name.
+
+        Args:
+            macro_name: Macro name (without .FCMacro extension).
+            args: Arguments to pass to the macro.
+
+        Returns:
+            ExecutionResult from macro execution.
+        """
+        macro_path = self._get_macro_path() / f"{macro_name}.FCMacro"
+
+        if not macro_path.exists():
+            return ExecutionResult(
+                success=False,
+                result=None,
+                stdout="",
+                stderr=f"Macro not found: {macro_name}",
+                execution_time_ms=0,
+                error_type="FileNotFoundError",
+            )
+
+        try:
+            macro_code = macro_path.read_text()
+        except Exception as e:
+            return ExecutionResult(
+                success=False,
+                result=None,
+                stdout="",
+                stderr=f"Failed to read macro: {e}",
+                execution_time_ms=0,
+                error_type=type(e).__name__,
+            )
+
+        # Prepend argument setup if provided
+        if args:
+            args_setup = "\n".join(f"{k} = {v!r}" for k, v in args.items())
+            macro_code = args_setup + "\n" + macro_code
+
+        return await self.execute_python(macro_code)
+
+    async def create_macro(
+        self,
+        name: str,
+        code: str,
+        description: str = "",
+    ) -> MacroInfo:
+        """Create a new macro.
+
+        Args:
+            name: Macro name (without extension).
+            code: Python code for the macro.
+            description: Macro description.
+
+        Returns:
+            MacroInfo for the created macro.
+        """
+        macro_path = self._get_macro_path()
+        macro_path.mkdir(parents=True, exist_ok=True)
+
+        macro_file = macro_path / f"{name}.FCMacro"
+
+        # Add description as header comment
+        header = f"# {description}\n\n" if description else ""
+
+        # Add standard imports
+        full_code = f"""{header}# -*- coding: utf-8 -*-
+# FreeCAD Macro: {name}
+# Created via MCP Bridge
+
+import FreeCAD
+import FreeCADGui
+
+{code}
+"""
+        macro_file.write_text(full_code)
+
+        return MacroInfo(
+            name=name,
+            path=str(macro_file),
+            description=description,
+            is_system=False,
+        )
+
+    # =========================================================================
+    # Workbenches
+    # =========================================================================
+
+    async def get_workbenches(self) -> list[WorkbenchInfo]:
+        """Get list of available workbenches.
+
+        Returns:
+            List of WorkbenchInfo for each workbench.
+        """
+        gui_available = await self.is_gui_available()
+
+        if not gui_available:
+            # Return common workbenches for headless mode
+            common_workbenches = [
+                "StartWorkbench",
+                "PartWorkbench",
+                "PartDesignWorkbench",
+                "DraftWorkbench",
+                "SketcherWorkbench",
+                "MeshWorkbench",
+                "SpreadsheetWorkbench",
+            ]
+            return [
+                WorkbenchInfo(name=wb, label=wb.replace("Workbench", ""))
+                for wb in common_workbenches
+            ]
+
+        code = """
+workbenches = []
+active_wb = FreeCADGui.activeWorkbench()
+active_name = active_wb.__class__.__name__ if active_wb else None
+
+for name in FreeCADGui.listWorkbenches():
+    wb = FreeCADGui.getWorkbench(name)
+    workbenches.append({
+        "name": name,
+        "label": wb.MenuText if hasattr(wb, "MenuText") else name,
+        "icon": wb.Icon if hasattr(wb, "Icon") else "",
+        "is_active": name == active_name,
+    })
+
+_result_ = workbenches
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [WorkbenchInfo(**wb) for wb in result.result]
+        return []
+
+    async def activate_workbench(self, workbench_name: str) -> None:
+        """Activate a workbench.
+
+        Args:
+            workbench_name: Workbench internal name.
+
+        Raises:
+            ValueError: If workbench not found.
+        """
+        gui_available = await self.is_gui_available()
+
+        if not gui_available:
+            return  # Silently ignore in headless mode
+
+        code = f"""
+try:
+    FreeCADGui.activateWorkbench({workbench_name!r})
+    _result_ = True
+except Exception as e:
+    raise ValueError(f"Failed to activate workbench: {{e}}")
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to activate workbench"
+            raise ValueError(error_msg)
+
Functions
__init__(freecad_path=None)

Initialize the embedded bridge.

Parameters:

Name Type Description Default
freecad_path str | None

Path to FreeCAD's lib directory. If provided, this path will be added to sys.path before importing.

 None
Source code in src/freecad_mcp/bridge/embedded.py 
45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
def __init__(self, freecad_path: str | None = None) -> None:
+    """Initialize the embedded bridge.
+
+    Args:
+        freecad_path: Path to FreeCAD's lib directory. If provided,
+            this path will be added to sys.path before importing.
+    """
+    self._freecad_path = freecad_path
+    self._fc_module: Any = None
+    self._executor = ThreadPoolExecutor(max_workers=1, thread_name_prefix="freecad")
+    self._connected = False
+
activate_workbench(workbench_name) async

Activate a workbench.

Parameters:

Name Type Description Default
workbench_name str

Workbench internal name.

 required

Raises:

Type Description
ValueError

If workbench not found.
Source code in src/freecad_mcp/bridge/embedded.py 
1039
+1040
+1041
+1042
+1043
+1044
+1045
+1046
+1047
+1048
+1049
+1050
+1051
+1052
+1053
+1054
+1055
+1056
+1057
+1058
+1059
+1060
+1061
+1062
+1063
+1064
    async def activate_workbench(self, workbench_name: str) -> None:
+        """Activate a workbench.
+
+        Args:
+            workbench_name: Workbench internal name.
+
+        Raises:
+            ValueError: If workbench not found.
+        """
+        gui_available = await self.is_gui_available()
+
+        if not gui_available:
+            return  # Silently ignore in headless mode
+
+        code = f"""
+try:
+    FreeCADGui.activateWorkbench({workbench_name!r})
+    _result_ = True
+except Exception as e:
+    raise ValueError(f"Failed to activate workbench: {{e}}")
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to activate workbench"
+            raise ValueError(error_msg)
+
close_document(doc_name=None) async

Close a document.

Parameters:

Name Type Description Default
doc_name str | None

Document name (uses active if None).

 None
Source code in src/freecad_mcp/bridge/embedded.py 
497
+498
+499
+500
+501
+502
+503
+504
+505
+506
+507
+508
+509
+510
+511
+512
+513
+514
+515
+516
+517
+518
+519
    async def close_document(self, doc_name: str | None = None) -> None:
+        """Close a document.
+
+        Args:
+            doc_name: Document name (uses active if None).
+        """
+        code = f"""
+doc_name = {doc_name!r}
+if doc_name is None:
+    doc = FreeCAD.ActiveDocument
+    if doc:
+        doc_name = doc.Name
+    else:
+        raise ValueError("No active document")
+
+FreeCAD.closeDocument(doc_name)
+_result_ = True
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to close document"
+            raise ValueError(error_msg)
+
connect() async

Import and initialize FreeCAD.

Raises:

Type Description
ConnectionError

If FreeCAD cannot be imported.
Source code in src/freecad_mcp/bridge/embedded.py 
57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
async def connect(self) -> None:
+    """Import and initialize FreeCAD.
+
+    Raises:
+        ConnectionError: If FreeCAD cannot be imported.
+    """
+    if self._freecad_path:
+        sys.path.insert(0, self._freecad_path)
+
+    loop = asyncio.get_event_loop()
+    try:
+        self._fc_module = await loop.run_in_executor(
+            self._executor,
+            self._import_freecad,
+        )
+        self._connected = True
+    except ImportError as e:
+        msg = f"Failed to import FreeCAD: {e}"
+        raise ConnectionError(msg) from e
+
create_document(name, label=None) async

Create a new document.

Parameters:

Name Type Description Default
name str

Internal document name (no spaces).

 required
label str | None

Display label (optional, defaults to name).

 None

Returns:

Type Description
DocumentInfo

DocumentInfo for the created document.
Source code in src/freecad_mcp/bridge/embedded.py 
390
+391
+392
+393
+394
+395
+396
+397
+398
+399
+400
+401
+402
+403
+404
+405
+406
+407
+408
+409
+410
+411
+412
+413
+414
+415
+416
+417
+418
+419
+420
+421
    async def create_document(
+        self, name: str, label: str | None = None
+    ) -> DocumentInfo:
+        """Create a new document.
+
+        Args:
+            name: Internal document name (no spaces).
+            label: Display label (optional, defaults to name).
+
+        Returns:
+            DocumentInfo for the created document.
+        """
+        label = label or name
+        result = await self.execute_python(
+            f"""
+doc = FreeCAD.newDocument({name!r})
+doc.Label = {label!r}
+_result_ = {{
+    "name": doc.Name,
+    "label": doc.Label,
+    "path": doc.FileName or None,
+    "objects": [],
+    "is_modified": False,
+}}
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create document"
+        raise ValueError(error_msg)
+
create_macro(name, code, description='') async

Create a new macro.

Parameters:

Name Type Description Default
name str

Macro name (without extension).

 required
code str

Python code for the macro.

 required
description str

Macro description.

 ''

Returns:

Type Description
MacroInfo

MacroInfo for the created macro.
Source code in src/freecad_mcp/bridge/embedded.py 
946
+947
+948
+949
+950
+951
+952
+953
+954
+955
+956
+957
+958
+959
+960
+961
+962
+963
+964
+965
+966
+967
+968
+969
+970
+971
+972
+973
+974
+975
+976
+977
+978
+979
+980
+981
+982
+983
+984
+985
+986
+987
    async def create_macro(
+        self,
+        name: str,
+        code: str,
+        description: str = "",
+    ) -> MacroInfo:
+        """Create a new macro.
+
+        Args:
+            name: Macro name (without extension).
+            code: Python code for the macro.
+            description: Macro description.
+
+        Returns:
+            MacroInfo for the created macro.
+        """
+        macro_path = self._get_macro_path()
+        macro_path.mkdir(parents=True, exist_ok=True)
+
+        macro_file = macro_path / f"{name}.FCMacro"
+
+        # Add description as header comment
+        header = f"# {description}\n\n" if description else ""
+
+        # Add standard imports
+        full_code = f"""{header}# -*- coding: utf-8 -*-
+# FreeCAD Macro: {name}
+# Created via MCP Bridge
+
+import FreeCAD
+import FreeCADGui
+
+{code}
+"""
+        macro_file.write_text(full_code)
+
+        return MacroInfo(
+            name=name,
+            path=str(macro_file),
+            description=description,
+            is_system=False,
+        )
+
create_object(type_id, name=None, properties=None, doc_name=None) async

Create a new object.

Parameters:

Name Type Description Default
type_id str

FreeCAD type ID (e.g., "Part::Box", "Part::Cylinder").

 required
name str | None

Object name (auto-generated if None).

 None
properties dict[str, Any] | None

Initial property values.

 None
doc_name str | None

Target document (uses active if None).

 None

Returns:

Type Description
ObjectInfo

ObjectInfo for the created object.
Source code in src/freecad_mcp/bridge/embedded.py 
559
+560
+561
+562
+563
+564
+565
+566
+567
+568
+569
+570
+571
+572
+573
+574
+575
+576
+577
+578
+579
+580
+581
+582
+583
+584
+585
+586
+587
+588
+589
+590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
    async def create_object(
+        self,
+        type_id: str,
+        name: str | None = None,
+        properties: dict[str, Any] | None = None,
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Create a new object.
+
+        Args:
+            type_id: FreeCAD type ID (e.g., "Part::Box", "Part::Cylinder").
+            name: Object name (auto-generated if None).
+            properties: Initial property values.
+            doc_name: Target document (uses active if None).
+
+        Returns:
+            ObjectInfo for the created object.
+        """
+        properties = properties or {}
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.addObject({type_id!r}, {name!r} or "")
+
+# Set properties
+for prop_name, prop_val in {properties!r}.items():
+    if hasattr(obj, prop_name):
+        setattr(obj, prop_name, prop_val)
+
+doc.recompute()
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "visibility": True,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to create object"
+        raise ValueError(error_msg)
+
delete_object(obj_name, doc_name=None) async

Delete an object.

Parameters:

Name Type Description Default
obj_name str

Name of the object to delete.

 required
doc_name str | None

Document name (uses active if None).

 None

Raises:

Type Description
ValueError

If object not found.
Source code in src/freecad_mcp/bridge/embedded.py 
661
+662
+663
+664
+665
+666
+667
+668
+669
+670
+671
+672
+673
+674
+675
+676
+677
+678
+679
+680
+681
+682
+683
+684
+685
+686
+687
+688
+689
+690
+691
    async def delete_object(
+        self,
+        obj_name: str,
+        doc_name: str | None = None,
+    ) -> None:
+        """Delete an object.
+
+        Args:
+            obj_name: Name of the object to delete.
+            doc_name: Document name (uses active if None).
+
+        Raises:
+            ValueError: If object not found.
+        """
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+doc.removeObject({obj_name!r})
+_result_ = True
+"""
+        result = await self.execute_python(code)
+
+        if not result.success:
+            error_msg = result.error_traceback or "Failed to delete object"
+            raise ValueError(error_msg)
+
disconnect() async

Clean up resources.

Source code in src/freecad_mcp/bridge/embedded.py 
83
+84
+85
+86
async def disconnect(self) -> None:
+    """Clean up resources."""
+    self._connected = False
+    self._executor.shutdown(wait=True)
+
edit_object(obj_name, properties, doc_name=None) async

Edit object properties.

Parameters:

Name Type Description Default
obj_name str

Name of the object to edit.

 required
properties dict[str, Any]

Property values to set.

 required
doc_name str | None

Document name (uses active if None).

 None

Returns:

Type Description
ObjectInfo

Updated ObjectInfo.

Raises:

Type Description
ValueError

If object not found.
Source code in src/freecad_mcp/bridge/embedded.py 
609
+610
+611
+612
+613
+614
+615
+616
+617
+618
+619
+620
+621
+622
+623
+624
+625
+626
+627
+628
+629
+630
+631
+632
+633
+634
+635
+636
+637
+638
+639
+640
+641
+642
+643
+644
+645
+646
+647
+648
+649
+650
+651
+652
+653
+654
+655
+656
+657
+658
+659
    async def edit_object(
+        self,
+        obj_name: str,
+        properties: dict[str, Any],
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Edit object properties.
+
+        Args:
+            obj_name: Name of the object to edit.
+            properties: Property values to set.
+            doc_name: Document name (uses active if None).
+
+        Returns:
+            Updated ObjectInfo.
+
+        Raises:
+            ValueError: If object not found.
+        """
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+# Set properties
+for prop_name, prop_val in {properties!r}.items():
+    if hasattr(obj, prop_name):
+        setattr(obj, prop_name, prop_val)
+
+doc.recompute()
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+    "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to edit object"
+        raise ValueError(error_msg)
+
execute_python(code, timeout_ms=30000) async

Execute Python code in FreeCAD context.

Parameters:

Name Type Description Default
code str

Python code to execute.

 required
timeout_ms int

Maximum execution time in milliseconds.

 30000

Returns:

Type Description
ExecutionResult

ExecutionResult with execution outcome.
Source code in src/freecad_mcp/bridge/embedded.py 
 92
+ 93
+ 94
+ 95
+ 96
+ 97
+ 98
+ 99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
+116
+117
+118
+119
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133
+134
+135
+136
+137
+138
async def execute_python(
+    self,
+    code: str,
+    timeout_ms: int = 30000,
+) -> ExecutionResult:
+    """Execute Python code in FreeCAD context.
+
+    Args:
+        code: Python code to execute.
+        timeout_ms: Maximum execution time in milliseconds.
+
+    Returns:
+        ExecutionResult with execution outcome.
+    """
+    if not self._connected:
+        return ExecutionResult(
+            success=False,
+            result=None,
+            stdout="",
+            stderr="FreeCAD bridge not connected",
+            execution_time_ms=0,
+            error_type="ConnectionError",
+            error_traceback=None,
+        )
+
+    loop = asyncio.get_event_loop()
+
+    try:
+        result = await asyncio.wait_for(
+            loop.run_in_executor(
+                self._executor,
+                lambda: self._execute_code(code),
+            ),
+            timeout=timeout_ms / 1000,
+        )
+    except TimeoutError:
+        return ExecutionResult(
+            success=False,
+            result=None,
+            stdout="",
+            stderr=f"Execution timed out after {timeout_ms}ms",
+            execution_time_ms=float(timeout_ms),
+            error_type="TimeoutError",
+            error_traceback=None,
+        )
+
+    return result
+
get_active_document() async

Get the active document.

Source code in src/freecad_mcp/bridge/embedded.py 
212
+213
+214
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+230
+231
+232
    async def get_active_document(self) -> DocumentInfo | None:
+        """Get the active document."""
+        result = await self.execute_python(
+            """
+doc = FreeCAD.ActiveDocument
+if doc:
+    _result_ = {
+        "name": doc.Name,
+        "path": doc.FileName or None,
+        "objects": [obj.Name for obj in doc.Objects],
+        "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+        "label": doc.Label,
+    }
+else:
+    _result_ = None
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+        return None
+
get_console_output(lines=100) async

Get recent console output.

Note: In embedded mode, we don't have direct access to FreeCAD's console history, so we return an empty list or captured output.

Source code in src/freecad_mcp/bridge/embedded.py 
287
+288
+289
+290
+291
+292
+293
+294
+295
+296
async def get_console_output(
+    self,
+    lines: int = 100,
+) -> list[str]:
+    """Get recent console output.
+
+    Note: In embedded mode, we don't have direct access to FreeCAD's
+    console history, so we return an empty list or captured output.
+    """
+    return []
+
get_documents() async

Get list of open documents.

Source code in src/freecad_mcp/bridge/embedded.py 
192
+193
+194
+195
+196
+197
+198
+199
+200
+201
+202
+203
+204
+205
+206
+207
+208
+209
+210
    async def get_documents(self) -> list[DocumentInfo]:
+        """Get list of open documents."""
+        result = await self.execute_python(
+            """
+_result_ = []
+for doc in FreeCAD.listDocuments().values():
+    _result_.append({
+        "name": doc.Name,
+        "path": doc.FileName or None,
+        "objects": [obj.Name for obj in doc.Objects],
+        "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+        "label": doc.Label,
+    })
+"""
+        )
+
+        if result.success and result.result:
+            return [DocumentInfo(**doc) for doc in result.result]
+        return []
+
get_freecad_version() async

Get FreeCAD version information.

Source code in src/freecad_mcp/bridge/embedded.py 
298
+299
+300
+301
+302
+303
+304
+305
+306
+307
+308
+309
+310
+311
+312
+313
+314
+315
+316
+317
+318
+319
+320
+321
+322
    async def get_freecad_version(self) -> dict[str, Any]:
+        """Get FreeCAD version information."""
+        result = await self.execute_python(
+            """
+import sys
+_result_ = {
+    "version": ".".join(str(x) for x in FreeCAD.Version()[:3]),
+    "version_tuple": FreeCAD.Version()[:3],
+    "build_date": FreeCAD.Version()[3] if len(FreeCAD.Version()) > 3 else "unknown",
+    "python_version": sys.version,
+    "gui_available": hasattr(FreeCAD, "GuiUp") and FreeCAD.GuiUp,
+}
+"""
+        )
+
+        if result.success and result.result:
+            return result.result
+
+        return {
+            "version": "unknown",
+            "version_tuple": [],
+            "build_date": "unknown",
+            "python_version": sys.version,
+            "gui_available": False,
+        }
+
get_macros() async

Get list of available macros.

Returns:

Type Description
list[MacroInfo]

List of MacroInfo for each macro.
Source code in src/freecad_mcp/bridge/embedded.py 
864
+865
+866
+867
+868
+869
+870
+871
+872
+873
+874
+875
+876
+877
+878
+879
+880
+881
+882
+883
+884
+885
+886
+887
+888
+889
+890
+891
+892
+893
+894
+895
+896
+897
+898
+899
async def get_macros(self) -> list[MacroInfo]:
+    """Get list of available macros.
+
+    Returns:
+        List of MacroInfo for each macro.
+    """
+    macro_path = self._get_macro_path()
+
+    if not macro_path.exists():
+        return []
+
+    macros = []
+    for macro_file in macro_path.glob("*.FCMacro"):
+        description = ""
+        try:
+            content = macro_file.read_text()
+            # Extract description from first comment block
+            for line in content.split("\n"):
+                if line.startswith("#"):
+                    desc_line = line.lstrip("#").strip()
+                    if desc_line and not desc_line.startswith("!"):
+                        description = desc_line
+                        break
+        except Exception:
+            pass
+
+        macros.append(
+            MacroInfo(
+                name=macro_file.stem,
+                path=str(macro_file),
+                description=description,
+                is_system=False,
+            )
+        )
+
+    return macros
+
get_object(obj_name, doc_name=None) async

Get detailed object information.

Source code in src/freecad_mcp/bridge/embedded.py 
234
+235
+236
+237
+238
+239
+240
+241
+242
+243
+244
+245
+246
+247
+248
+249
+250
+251
+252
+253
+254
+255
+256
+257
+258
+259
+260
+261
+262
+263
+264
+265
+266
+267
+268
+269
+270
+271
+272
+273
+274
+275
+276
+277
+278
+279
+280
+281
+282
+283
+284
+285
    async def get_object(
+        self,
+        obj_name: str,
+        doc_name: str | None = None,
+    ) -> ObjectInfo:
+        """Get detailed object information."""
+        result = await self.execute_python(
+            f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+obj = doc.getObject({obj_name!r})
+if obj is None:
+    raise ValueError(f"Object not found: {obj_name!r}")
+
+props = {{}}
+for prop in obj.PropertiesList:
+    try:
+        val = getattr(obj, prop)
+        if hasattr(val, '__class__') and val.__class__.__module__ != 'builtins':
+            val = str(val)
+        props[prop] = val
+    except Exception:
+        props[prop] = "<unreadable>"
+
+shape_info = None
+if hasattr(obj, "Shape"):
+    shape = obj.Shape
+    shape_info = {{
+        "type": shape.ShapeType,
+        "volume": shape.Volume if hasattr(shape, "Volume") else None,
+        "area": shape.Area if hasattr(shape, "Area") else None,
+        "is_valid": shape.isValid(),
+    }}
+
+_result_ = {{
+    "name": obj.Name,
+    "label": obj.Label,
+    "type_id": obj.TypeId,
+    "properties": props,
+    "shape_info": shape_info,
+    "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+}}
+"""
+        )
+
+        if result.success and result.result:
+            return ObjectInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to get object"
+        raise ValueError(error_msg)
+
get_objects(doc_name=None) async

Get all objects in a document.

Parameters:

Name Type Description Default
doc_name str | None

Document name (uses active if None).

 None

Returns:

Type Description
list[ObjectInfo]

List of ObjectInfo for each object.
Source code in src/freecad_mcp/bridge/embedded.py 
525
+526
+527
+528
+529
+530
+531
+532
+533
+534
+535
+536
+537
+538
+539
+540
+541
+542
+543
+544
+545
+546
+547
+548
+549
+550
+551
+552
+553
+554
+555
+556
+557
    async def get_objects(self, doc_name: str | None = None) -> list[ObjectInfo]:
+        """Get all objects in a document.
+
+        Args:
+            doc_name: Document name (uses active if None).
+
+        Returns:
+            List of ObjectInfo for each object.
+        """
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+objects = []
+for obj in doc.Objects:
+    obj_info = {{
+        "name": obj.Name,
+        "label": obj.Label,
+        "type_id": obj.TypeId,
+        "visibility": obj.ViewObject.Visibility if hasattr(obj, "ViewObject") and obj.ViewObject else True,
+        "children": [c.Name for c in obj.OutList] if hasattr(obj, "OutList") else [],
+        "parents": [p.Name for p in obj.InList] if hasattr(obj, "InList") else [],
+    }}
+    objects.append(obj_info)
+
+_result_ = objects
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [ObjectInfo(**obj) for obj in result.result]
+        return []
+
get_screenshot(view_angle=None, width=800, height=600, doc_name=None) async

Capture a screenshot of the 3D view.

Note: In embedded headless mode, screenshots are typically not available.

Parameters:

Name Type Description Default
view_angle ViewAngle | None

View angle to set before capture.

 None
width int

Image width in pixels.

 800
height int

Image height in pixels.

 600
doc_name str | None

Document name (uses active if None).

 None

Returns:

Type Description
ScreenshotResult

ScreenshotResult with image data or error.
Source code in src/freecad_mcp/bridge/embedded.py 
697
+698
+699
+700
+701
+702
+703
+704
+705
+706
+707
+708
+709
+710
+711
+712
+713
+714
+715
+716
+717
+718
+719
+720
+721
+722
+723
+724
+725
+726
+727
+728
+729
+730
+731
+732
+733
+734
+735
+736
+737
+738
+739
+740
+741
+742
+743
+744
+745
+746
+747
+748
+749
+750
+751
+752
+753
+754
+755
+756
+757
+758
+759
+760
+761
+762
+763
+764
+765
+766
+767
+768
+769
+770
+771
+772
+773
+774
+775
+776
+777
+778
+779
+780
+781
+782
+783
+784
+785
+786
+787
+788
+789
+790
+791
+792
+793
+794
+795
+796
+797
+798
+799
+800
    async def get_screenshot(
+        self,
+        view_angle: ViewAngle | None = None,
+        width: int = 800,
+        height: int = 600,
+        doc_name: str | None = None,
+    ) -> ScreenshotResult:
+        """Capture a screenshot of the 3D view.
+
+        Note: In embedded headless mode, screenshots are typically not available.
+
+        Args:
+            view_angle: View angle to set before capture.
+            width: Image width in pixels.
+            height: Image height in pixels.
+            doc_name: Document name (uses active if None).
+
+        Returns:
+            ScreenshotResult with image data or error.
+        """
+        # Check if GUI is available
+        gui_available = await self.is_gui_available()
+
+        if not gui_available:
+            return ScreenshotResult(
+                success=False,
+                error="Screenshots not available in headless mode",
+                width=width,
+                height=height,
+                view_angle=view_angle,
+            )
+
+        # If GUI is available, attempt screenshot
+        view_angle_str = view_angle.value if view_angle else "Isometric"
+        code = f"""
+import base64
+import tempfile
+import os
+
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+view = FreeCADGui.ActiveDocument.ActiveView
+if view is None:
+    raise ValueError("No active view")
+
+# Set view angle
+view_type = {view_angle_str!r}
+if view_type == "FitAll":
+    view.fitAll()
+elif view_type == "Isometric":
+    view.viewIsometric()
+elif view_type == "Front":
+    view.viewFront()
+elif view_type == "Back":
+    view.viewRear()
+elif view_type == "Top":
+    view.viewTop()
+elif view_type == "Bottom":
+    view.viewBottom()
+elif view_type == "Left":
+    view.viewLeft()
+elif view_type == "Right":
+    view.viewRight()
+
+# Save to temp file and read
+with tempfile.NamedTemporaryFile(suffix=".png", delete=False) as f:
+    temp_path = f.name
+
+view.saveImage(temp_path, {width}, {height}, "Current")
+
+with open(temp_path, "rb") as f:
+    image_data = base64.b64encode(f.read()).decode("utf-8")
+
+os.unlink(temp_path)
+
+_result_ = {{
+    "success": True,
+    "data": image_data,
+    "format": "png",
+    "width": {width},
+    "height": {height},
+}}
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return ScreenshotResult(
+                success=True,
+                data=result.result["data"],
+                format=result.result["format"],
+                width=result.result["width"],
+                height=result.result["height"],
+                view_angle=view_angle,
+            )
+
+        return ScreenshotResult(
+            success=False,
+            error=result.error_traceback or "Failed to capture screenshot",
+            width=width,
+            height=height,
+            view_angle=view_angle,
+        )
+
get_status() async

Get detailed connection status.

Returns:

Type Description
ConnectionStatus

ConnectionStatus with full status information.
Source code in src/freecad_mcp/bridge/embedded.py 
354
+355
+356
+357
+358
+359
+360
+361
+362
+363
+364
+365
+366
+367
+368
+369
+370
+371
+372
+373
+374
+375
+376
+377
+378
+379
+380
+381
+382
+383
+384
async def get_status(self) -> ConnectionStatus:
+    """Get detailed connection status.
+
+    Returns:
+        ConnectionStatus with full status information.
+    """
+    if not self._connected:
+        return ConnectionStatus(
+            connected=False,
+            mode="embedded",
+            error="Not connected",
+        )
+
+    try:
+        ping_ms = await self.ping()
+        version_info = await self.get_freecad_version()
+        gui_available = await self.is_gui_available()
+
+        return ConnectionStatus(
+            connected=True,
+            mode="embedded",
+            freecad_version=version_info.get("version", "unknown"),
+            gui_available=gui_available,
+            last_ping_ms=ping_ms,
+        )
+    except Exception as e:
+        return ConnectionStatus(
+            connected=False,
+            mode="embedded",
+            error=str(e),
+        )
+
get_workbenches() async

Get list of available workbenches.

Returns:

Type Description
list[WorkbenchInfo]

List of WorkbenchInfo for each workbench.
Source code in src/freecad_mcp/bridge/embedded.py 
 993
+ 994
+ 995
+ 996
+ 997
+ 998
+ 999
+1000
+1001
+1002
+1003
+1004
+1005
+1006
+1007
+1008
+1009
+1010
+1011
+1012
+1013
+1014
+1015
+1016
+1017
+1018
+1019
+1020
+1021
+1022
+1023
+1024
+1025
+1026
+1027
+1028
+1029
+1030
+1031
+1032
+1033
+1034
+1035
+1036
+1037
    async def get_workbenches(self) -> list[WorkbenchInfo]:
+        """Get list of available workbenches.
+
+        Returns:
+            List of WorkbenchInfo for each workbench.
+        """
+        gui_available = await self.is_gui_available()
+
+        if not gui_available:
+            # Return common workbenches for headless mode
+            common_workbenches = [
+                "StartWorkbench",
+                "PartWorkbench",
+                "PartDesignWorkbench",
+                "DraftWorkbench",
+                "SketcherWorkbench",
+                "MeshWorkbench",
+                "SpreadsheetWorkbench",
+            ]
+            return [
+                WorkbenchInfo(name=wb, label=wb.replace("Workbench", ""))
+                for wb in common_workbenches
+            ]
+
+        code = """
+workbenches = []
+active_wb = FreeCADGui.activeWorkbench()
+active_name = active_wb.__class__.__name__ if active_wb else None
+
+for name in FreeCADGui.listWorkbenches():
+    wb = FreeCADGui.getWorkbench(name)
+    workbenches.append({
+        "name": name,
+        "label": wb.MenuText if hasattr(wb, "MenuText") else name,
+        "icon": wb.Icon if hasattr(wb, "Icon") else "",
+        "is_active": name == active_name,
+    })
+
+_result_ = workbenches
+"""
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return [WorkbenchInfo(**wb) for wb in result.result]
+        return []
+
is_connected() async

Check if FreeCAD is imported and available.

Source code in src/freecad_mcp/bridge/embedded.py 
88
+89
+90
async def is_connected(self) -> bool:
+    """Check if FreeCAD is imported and available."""
+    return self._connected and self._fc_module is not None
+
is_gui_available() async

Check if GUI is available.

Source code in src/freecad_mcp/bridge/embedded.py 
324
+325
+326
+327
+328
+329
async def is_gui_available(self) -> bool:
+    """Check if GUI is available."""
+    result = await self.execute_python(
+        "_result_ = hasattr(FreeCAD, 'GuiUp') and FreeCAD.GuiUp"
+    )
+    return bool(result.success and result.result)
+
open_document(path) async

Open an existing document.

Parameters:

Name Type Description Default
path str

Path to the .FCStd file.

 required

Returns:

Type Description
DocumentInfo

DocumentInfo for the opened document.

Raises:

Type Description
FileNotFoundError

If file doesn't exist.
ValueError

If file is not a valid FreeCAD document.
Source code in src/freecad_mcp/bridge/embedded.py 
423
+424
+425
+426
+427
+428
+429
+430
+431
+432
+433
+434
+435
+436
+437
+438
+439
+440
+441
+442
+443
+444
+445
+446
+447
+448
+449
+450
+451
+452
+453
+454
+455
+456
+457
    async def open_document(self, path: str) -> DocumentInfo:
+        """Open an existing document.
+
+        Args:
+            path: Path to the .FCStd file.
+
+        Returns:
+            DocumentInfo for the opened document.
+
+        Raises:
+            FileNotFoundError: If file doesn't exist.
+            ValueError: If file is not a valid FreeCAD document.
+        """
+        if not Path(path).exists():
+            msg = f"File not found: {path}"
+            raise FileNotFoundError(msg)
+
+        result = await self.execute_python(
+            f"""
+doc = FreeCAD.openDocument({path!r})
+_result_ = {{
+    "name": doc.Name,
+    "label": doc.Label,
+    "path": doc.FileName or None,
+    "objects": [obj.Name for obj in doc.Objects],
+    "is_modified": doc.Modified if hasattr(doc, "Modified") else False,
+}}
+"""
+        )
+
+        if result.success and result.result:
+            return DocumentInfo(**result.result)
+
+        error_msg = result.error_traceback or "Failed to open document"
+        raise ValueError(error_msg)
+
ping() async

Ping FreeCAD to check connection and measure latency.

Returns:

Type Description
float

Round-trip time in milliseconds.

Raises:

Type Description
ConnectionError

If not connected.
Source code in src/freecad_mcp/bridge/embedded.py 
331
+332
+333
+334
+335
+336
+337
+338
+339
+340
+341
+342
+343
+344
+345
+346
+347
+348
+349
+350
+351
+352
async def ping(self) -> float:
+    """Ping FreeCAD to check connection and measure latency.
+
+    Returns:
+        Round-trip time in milliseconds.
+
+    Raises:
+        ConnectionError: If not connected.
+    """
+    if not self._connected:
+        msg = "Not connected to FreeCAD"
+        raise ConnectionError(msg)
+
+    start = time.perf_counter()
+    result = await self.execute_python("_result_ = True")
+    elapsed = (time.perf_counter() - start) * 1000
+
+    if not result.success:
+        msg = "Ping failed"
+        raise ConnectionError(msg)
+
+    return elapsed
+
run_macro(macro_name, args=None) async

Run a macro by name.

Parameters:

Name Type Description Default
macro_name str

Macro name (without .FCMacro extension).

 required
args dict[str, Any] | None

Arguments to pass to the macro.

 None

Returns:

Type Description
ExecutionResult

ExecutionResult from macro execution.
Source code in src/freecad_mcp/bridge/embedded.py 
901
+902
+903
+904
+905
+906
+907
+908
+909
+910
+911
+912
+913
+914
+915
+916
+917
+918
+919
+920
+921
+922
+923
+924
+925
+926
+927
+928
+929
+930
+931
+932
+933
+934
+935
+936
+937
+938
+939
+940
+941
+942
+943
+944
async def run_macro(
+    self,
+    macro_name: str,
+    args: dict[str, Any] | None = None,
+) -> ExecutionResult:
+    """Run a macro by name.
+
+    Args:
+        macro_name: Macro name (without .FCMacro extension).
+        args: Arguments to pass to the macro.
+
+    Returns:
+        ExecutionResult from macro execution.
+    """
+    macro_path = self._get_macro_path() / f"{macro_name}.FCMacro"
+
+    if not macro_path.exists():
+        return ExecutionResult(
+            success=False,
+            result=None,
+            stdout="",
+            stderr=f"Macro not found: {macro_name}",
+            execution_time_ms=0,
+            error_type="FileNotFoundError",
+        )
+
+    try:
+        macro_code = macro_path.read_text()
+    except Exception as e:
+        return ExecutionResult(
+            success=False,
+            result=None,
+            stdout="",
+            stderr=f"Failed to read macro: {e}",
+            execution_time_ms=0,
+            error_type=type(e).__name__,
+        )
+
+    # Prepend argument setup if provided
+    if args:
+        args_setup = "\n".join(f"{k} = {v!r}" for k, v in args.items())
+        macro_code = args_setup + "\n" + macro_code
+
+    return await self.execute_python(macro_code)
+
save_document(doc_name=None, path=None) async

Save a document.

Parameters:

Name Type Description Default
doc_name str | None

Document name (uses active if None).

 None
path str | None

Save path (uses existing path if None).

 None

Returns:

Type Description
str

Path where document was saved.

Raises:

Type Description
ValueError

If document not found or no path specified for new doc.
Source code in src/freecad_mcp/bridge/embedded.py 
459
+460
+461
+462
+463
+464
+465
+466
+467
+468
+469
+470
+471
+472
+473
+474
+475
+476
+477
+478
+479
+480
+481
+482
+483
+484
+485
+486
+487
+488
+489
+490
+491
+492
+493
+494
+495
    async def save_document(
+        self,
+        doc_name: str | None = None,
+        path: str | None = None,
+    ) -> str:
+        """Save a document.
+
+        Args:
+            doc_name: Document name (uses active if None).
+            path: Save path (uses existing path if None).
+
+        Returns:
+            Path where document was saved.
+
+        Raises:
+            ValueError: If document not found or no path specified for new doc.
+        """
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No active document" if {doc_name!r} is None else f"Document not found: {doc_name!r}")
+
+save_path = {path!r} or doc.FileName
+if not save_path:
+    raise ValueError("No path specified for new document")
+
+doc.saveAs(save_path)
+_result_ = save_path
+"""
+
+        result = await self.execute_python(code)
+
+        if result.success and result.result:
+            return result.result
+
+        error_msg = result.error_traceback or "Failed to save document"
+        raise ValueError(error_msg)
+
set_view(view_angle, doc_name=None) async

Set the 3D view angle.

Parameters:

Name Type Description Default
view_angle ViewAngle

View angle to set.

 required
doc_name str | None

Document name (uses active if None).

 None
Source code in src/freecad_mcp/bridge/embedded.py 
802
+803
+804
+805
+806
+807
+808
+809
+810
+811
+812
+813
+814
+815
+816
+817
+818
+819
+820
+821
+822
+823
+824
+825
+826
+827
+828
+829
+830
+831
+832
+833
+834
+835
+836
+837
+838
+839
+840
+841
+842
+843
+844
+845
+846
+847
+848
    async def set_view(
+        self,
+        view_angle: ViewAngle,
+        doc_name: str | None = None,
+    ) -> None:
+        """Set the 3D view angle.
+
+        Args:
+            view_angle: View angle to set.
+            doc_name: Document name (uses active if None).
+        """
+        gui_available = await self.is_gui_available()
+
+        if not gui_available:
+            return  # Silently ignore in headless mode
+
+        view_angle_str = view_angle.value
+        code = f"""
+doc = FreeCAD.ActiveDocument if {doc_name!r} is None else FreeCAD.getDocument({doc_name!r})
+if doc is None:
+    raise ValueError("No document found")
+
+view = FreeCADGui.ActiveDocument.ActiveView
+if view is None:
+    raise ValueError("No active view")
+
+view_type = {view_angle_str!r}
+if view_type == "FitAll":
+    view.fitAll()
+elif view_type == "Isometric":
+    view.viewIsometric()
+elif view_type == "Front":
+    view.viewFront()
+elif view_type == "Back":
+    view.viewRear()
+elif view_type == "Top":
+    view.viewTop()
+elif view_type == "Bottom":
+    view.viewBottom()
+elif view_type == "Left":
+    view.viewLeft()
+elif view_type == "Right":
+    view.viewRight()
+
+_result_ = True
+"""
+        await self.execute_python(code)
+

options: show_root_heading: true show_source: true

\ No newline at end of file diff --git a/latest/api/config/index.html b/latest/api/config/index.html new file mode 100644 index 0000000..ef72b86 --- /dev/null +++ b/latest/api/config/index.html @@ -0,0 +1,193 @@ +Config - FreeCAD Robust MCP Suite
Skip to content

Configuration API Reference

freecad_mcp.config

Configuration management for FreeCAD Robust MCP Server.

This module handles all configuration settings for the Robust MCP Server, including FreeCAD connection settings, execution limits, and logging.

Classes

FreecadMode

Bases: str, Enum

FreeCAD connection mode.

Source code in src/freecad_mcp/config.py 
15
+16
+17
+18
+19
+20
class FreecadMode(str, Enum):
+    """FreeCAD connection mode."""
+
+    EMBEDDED = "embedded"
+    SOCKET = "socket"
+    XMLRPC = "xmlrpc"
+

ServerConfig

Bases: BaseSettings

Configuration for the FreeCAD Robust MCP Server.

Settings are loaded from environment variables with the FREECAD_ prefix. For example, FREECAD_MODE sets the mode field.

Attributes:

Name Type Description
mode FreecadMode

Connection mode - 'embedded', 'socket', or 'xmlrpc'.
freecad_path Annotated[Path | None, Field(description="Path to FreeCAD's lib directory", alias=FREECAD_PATH)]

Path to FreeCAD's lib directory (for embedded mode).
socket_host Annotated[str, Field(description='Socket/XML-RPC server hostname')]

Hostname for socket/xmlrpc connection.
socket_port Annotated[int, Field(ge=1, le=65535, description='Socket server port (JSON-RPC)')]

Port for JSON-RPC socket connection (default 9876).
xmlrpc_port Annotated[int, Field(ge=1, le=65535, description='XML-RPC server port (neka-nat compatible)')]

Port for XML-RPC connection (default 9875, neka-nat compatible).
timeout_ms Annotated[int, Field(ge=1000, le=600000, description='Execution timeout in ms')]

Default execution timeout in milliseconds.
max_output_size Annotated[int, Field(ge=1000, description='Maximum output size in bytes')]

Maximum output size in bytes.
transport TransportType

MCP transport type.
http_port Annotated[int, Field(ge=1, le=65535, description='HTTP server port')]

Port for HTTP transport.
log_level str

Logging level.
Source code in src/freecad_mcp/config.py 
 30
+ 31
+ 32
+ 33
+ 34
+ 35
+ 36
+ 37
+ 38
+ 39
+ 40
+ 41
+ 42
+ 43
+ 44
+ 45
+ 46
+ 47
+ 48
+ 49
+ 50
+ 51
+ 52
+ 53
+ 54
+ 55
+ 56
+ 57
+ 58
+ 59
+ 60
+ 61
+ 62
+ 63
+ 64
+ 65
+ 66
+ 67
+ 68
+ 69
+ 70
+ 71
+ 72
+ 73
+ 74
+ 75
+ 76
+ 77
+ 78
+ 79
+ 80
+ 81
+ 82
+ 83
+ 84
+ 85
+ 86
+ 87
+ 88
+ 89
+ 90
+ 91
+ 92
+ 93
+ 94
+ 95
+ 96
+ 97
+ 98
+ 99
+100
+101
+102
+103
class ServerConfig(BaseSettings):
+    """Configuration for the FreeCAD Robust MCP Server.
+
+    Settings are loaded from environment variables with the FREECAD_ prefix.
+    For example, FREECAD_MODE sets the mode field.
+
+    Attributes:
+        mode: Connection mode - 'embedded', 'socket', or 'xmlrpc'.
+        freecad_path: Path to FreeCAD's lib directory (for embedded mode).
+        socket_host: Hostname for socket/xmlrpc connection.
+        socket_port: Port for JSON-RPC socket connection (default 9876).
+        xmlrpc_port: Port for XML-RPC connection (default 9875, neka-nat compatible).
+        timeout_ms: Default execution timeout in milliseconds.
+        max_output_size: Maximum output size in bytes.
+        transport: MCP transport type.
+        http_port: Port for HTTP transport.
+        log_level: Logging level.
+    """
+
+    model_config = SettingsConfigDict(
+        env_prefix="FREECAD_",
+        env_file=".env",
+        env_file_encoding="utf-8",
+        case_sensitive=False,
+    )
+
+    # FreeCAD connection settings
+    mode: FreecadMode = FreecadMode.EMBEDDED
+    freecad_path: Annotated[
+        Path | None,
+        Field(
+            description="Path to FreeCAD's lib directory",
+            alias="FREECAD_PATH",
+        ),
+    ] = None
+
+    # Socket settings (for socket mode)
+    socket_host: Annotated[
+        str,
+        Field(description="Socket/XML-RPC server hostname"),
+    ] = "localhost"
+    socket_port: Annotated[
+        int,
+        Field(ge=1, le=65535, description="Socket server port (JSON-RPC)"),
+    ] = 9876
+    xmlrpc_port: Annotated[
+        int,
+        Field(ge=1, le=65535, description="XML-RPC server port (neka-nat compatible)"),
+    ] = 9875
+
+    # Execution limits
+    timeout_ms: Annotated[
+        int,
+        Field(ge=1000, le=600000, description="Execution timeout in ms"),
+    ] = 30000
+    max_output_size: Annotated[
+        int,
+        Field(ge=1000, description="Maximum output size in bytes"),
+    ] = 1_000_000
+
+    # MCP transport settings
+    transport: TransportType = TransportType.STDIO
+    http_port: Annotated[
+        int,
+        Field(ge=1, le=65535, description="HTTP server port"),
+    ] = 8000
+
+    # Logging
+    log_level: str = "INFO"
+
+    # Security settings
+    enable_sandbox: bool = True
+    allow_file_access: bool = True
+    allow_network_access: bool = False
+

TransportType

Bases: str, Enum

MCP transport type.

Source code in src/freecad_mcp/config.py 
23
+24
+25
+26
+27
class TransportType(str, Enum):
+    """MCP transport type."""
+
+    STDIO = "stdio"
+    HTTP = "http"
+

Functions

get_config()

Get the server configuration.

Returns:

Type Description
ServerConfig

ServerConfig instance populated from environment variables.
Source code in src/freecad_mcp/config.py 
106
+107
+108
+109
+110
+111
+112
def get_config() -> ServerConfig:
+    """Get the server configuration.
+
+    Returns:
+        ServerConfig instance populated from environment variables.
+    """
+    return ServerConfig()
+

options: show_root_heading: true show_source: true

\ No newline at end of file diff --git a/latest/api/server/index.html b/latest/api/server/index.html new file mode 100644 index 0000000..12e38e4 --- /dev/null +++ b/latest/api/server/index.html @@ -0,0 +1,721 @@ +Server - FreeCAD Robust MCP Suite
Skip to content

Server API Reference

freecad_mcp.server

FreeCAD Robust MCP Server - Main entry point.

This module provides the main Robust MCP Server implementation for FreeCAD integration with AI assistants (Claude, GPT, and other MCP-compatible tools). It exposes tools, resources, and prompts for interacting with FreeCAD.

Features
  • Full Python console access (GUI and headless modes)
  • Document and object management
  • PartDesign workflow (sketches, pads, pockets, fillets)
  • Import/export (STEP, STL, OBJ, IGES)
  • Macro management
  • Screenshot capture
  • Multiple connection modes (embedded, XML-RPC, socket)
Example

Run as a module::

$ python -m freecad_mcp.server
+

Or use the installed command::

$ freecad-mcp
+

With environment variables::

$ FREECAD_MODE=socket FREECAD_SOCKET_HOST=localhost freecad-mcp
+

Show help::

$ freecad-mcp --help
+

Classes

Functions

apply_cli_args_to_env(args)

Apply CLI arguments as environment variables.

CLI arguments override existing environment variables.

Parameters:

Name Type Description Default
args Namespace

Parsed command-line arguments.

 required
Source code in src/freecad_mcp/server.py 
257
+258
+259
+260
+261
+262
+263
+264
+265
+266
+267
+268
+269
+270
+271
+272
+273
+274
+275
+276
+277
+278
+279
+280
+281
+282
+283
def apply_cli_args_to_env(args: argparse.Namespace) -> None:
+    """Apply CLI arguments as environment variables.
+
+    CLI arguments override existing environment variables.
+
+    Args:
+        args: Parsed command-line arguments.
+    """
+    import os
+
+    if args.mode:
+        os.environ["FREECAD_MODE"] = args.mode
+    if args.transport:
+        os.environ["FREECAD_TRANSPORT"] = args.transport
+    if args.host:
+        os.environ["FREECAD_SOCKET_HOST"] = args.host
+    if args.port:
+        # Set appropriate port based on mode
+        mode = os.environ.get("FREECAD_MODE", "xmlrpc")
+        if mode == "xmlrpc":
+            os.environ["FREECAD_XMLRPC_PORT"] = str(args.port)
+        else:
+            os.environ["FREECAD_SOCKET_PORT"] = str(args.port)
+    if args.http_port:
+        os.environ["FREECAD_HTTP_PORT"] = str(args.http_port)
+    if args.log_level:
+        os.environ["FREECAD_LOG_LEVEL"] = args.log_level
+

check_freecad_connection(mode=None, host=None, port=None) async

Test FreeCAD bridge connection.

Parameters:

Name Type Description Default
mode str | None

Connection mode override (xmlrpc, socket, embedded).

 None
host str | None

Host override for connection.

 None
port int | None

Port override for connection.

 None

Returns:

Type Description
bool

True if connection successful, False otherwise.
Source code in src/freecad_mcp/server.py 
187
+188
+189
+190
+191
+192
+193
+194
+195
+196
+197
+198
+199
+200
+201
+202
+203
+204
+205
+206
+207
+208
+209
+210
+211
+212
+213
+214
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+230
+231
+232
+233
+234
+235
+236
+237
+238
+239
+240
+241
+242
+243
+244
+245
+246
+247
+248
+249
+250
+251
+252
+253
+254
async def check_freecad_connection(
+    mode: str | None = None, host: str | None = None, port: int | None = None
+) -> bool:
+    """Test FreeCAD bridge connection.
+
+    Args:
+        mode: Connection mode override (xmlrpc, socket, embedded).
+        host: Host override for connection.
+        port: Port override for connection.
+
+    Returns:
+        True if connection successful, False otherwise.
+    """
+    import os
+
+    # Apply overrides to env
+    if mode:
+        os.environ["FREECAD_MODE"] = mode
+    if host:
+        os.environ["FREECAD_SOCKET_HOST"] = host
+    if port:
+        mode_val = mode or os.environ.get("FREECAD_MODE", "xmlrpc")
+        if mode_val == "xmlrpc":
+            os.environ["FREECAD_XMLRPC_PORT"] = str(port)
+        else:
+            os.environ["FREECAD_SOCKET_PORT"] = str(port)
+
+    config = get_config()
+    print(f"Testing connection to FreeCAD ({config.mode.value} mode)...")
+
+    try:
+        bridge: FreecadBridge
+        if config.mode == FreecadMode.EMBEDDED:
+            from freecad_mcp.bridge.embedded import EmbeddedBridge
+
+            bridge = EmbeddedBridge(
+                freecad_path=(
+                    str(config.freecad_path) if config.freecad_path else None
+                ),
+            )
+        elif config.mode == FreecadMode.XMLRPC:
+            from freecad_mcp.bridge.xmlrpc import XmlRpcBridge
+
+            bridge = XmlRpcBridge(
+                host=config.socket_host,
+                port=config.xmlrpc_port,
+            )
+            print(f"  Host: {config.socket_host}:{config.xmlrpc_port}")
+        else:
+            from freecad_mcp.bridge.socket import SocketBridge
+
+            bridge = SocketBridge(
+                host=config.socket_host,
+                port=config.socket_port,
+            )
+            print(f"  Host: {config.socket_host}:{config.socket_port}")
+
+        await bridge.connect()
+        version_info = await bridge.get_freecad_version()
+        await bridge.disconnect()
+
+        print("✓ Connection successful!")
+        print(f"  FreeCAD version: {version_info.get('version', 'unknown')}")
+        print(f"  GUI available: {version_info.get('gui_available', 'unknown')}")
+        return True
+    except Exception as e:
+        print(f"✗ Connection failed: {e}")
+        return False
+

get_bridge() async

Get the active FreeCAD bridge.

Returns:

Type Description
FreecadBridge

The active FreecadBridge instance.

Raises:

Type Description
RuntimeError

If bridge is not initialized.
Source code in src/freecad_mcp/server.py 
71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
async def get_bridge() -> "FreecadBridge":
+    """Get the active FreeCAD bridge.
+
+    Returns:
+        The active FreecadBridge instance.
+
+    Raises:
+        RuntimeError: If bridge is not initialized.
+    """
+    if _bridge is None:
+        msg = "FreeCAD bridge not initialized"
+        raise RuntimeError(msg)
+    return _bridge
+

get_instance_id()

Get the unique instance ID for this Robust MCP Server process.

Returns:

Type Description
str

The UUID string that uniquely identifies this server instance.
Source code in src/freecad_mcp/server.py 
62
+63
+64
+65
+66
+67
+68
def get_instance_id() -> str:
+    """Get the unique instance ID for this Robust MCP Server process.
+
+    Returns:
+        The UUID string that uniquely identifies this server instance.
+    """
+    return INSTANCE_ID
+

lifespan(_server) async

Manage FreeCAD bridge lifecycle.

This async context manager initializes the FreeCAD bridge on startup and disconnects it on shutdown.

Parameters:

Name Type Description Default
_server FastMCP

The FastMCP server instance (unused).

 required

Yields:

Type Description
AsyncIterator[None]

None - the bridge is stored in the global _bridge variable.
Source code in src/freecad_mcp/server.py 
 86
+ 87
+ 88
+ 89
+ 90
+ 91
+ 92
+ 93
+ 94
+ 95
+ 96
+ 97
+ 98
+ 99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
+116
+117
+118
+119
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133
+134
+135
+136
+137
+138
+139
+140
+141
+142
+143
+144
+145
+146
+147
+148
+149
+150
+151
+152
+153
+154
+155
@asynccontextmanager
+async def lifespan(_server: FastMCP) -> AsyncIterator[None]:
+    """Manage FreeCAD bridge lifecycle.
+
+    This async context manager initializes the FreeCAD bridge on startup
+    and disconnects it on shutdown.
+
+    Args:
+        _server: The FastMCP server instance (unused).
+
+    Yields:
+        None - the bridge is stored in the global _bridge variable.
+    """
+    global _bridge
+    config = get_config()
+
+    logger.info("Initializing FreeCAD bridge...")
+
+    if config.mode == FreecadMode.EMBEDDED:
+        from freecad_mcp.bridge.embedded import EmbeddedBridge
+
+        _bridge = EmbeddedBridge(
+            freecad_path=str(config.freecad_path) if config.freecad_path else None,
+        )
+        logger.info("Using embedded bridge (headless mode)")
+
+    elif config.mode == FreecadMode.XMLRPC:
+        from freecad_mcp.bridge.xmlrpc import XmlRpcBridge
+
+        _bridge = XmlRpcBridge(
+            host=config.socket_host,
+            port=config.xmlrpc_port,
+        )
+        logger.info(
+            "Using XML-RPC bridge: %s:%d", config.socket_host, config.xmlrpc_port
+        )
+
+    else:  # SOCKET mode
+        from freecad_mcp.bridge.socket import SocketBridge
+
+        _bridge = SocketBridge(
+            host=config.socket_host,
+            port=config.socket_port,
+        )
+        logger.info(
+            "Using socket bridge: %s:%d", config.socket_host, config.socket_port
+        )
+
+    await _bridge.connect()
+    logger.info("FreeCAD bridge connected")
+
+    # Log FreeCAD version
+    try:
+        version = await _bridge.get_freecad_version()
+        logger.info(
+            "FreeCAD %s (GUI: %s)",
+            version.get("version", "unknown"),
+            "available" if version.get("gui_available") else "headless",
+        )
+    except Exception as e:
+        logger.warning("Could not get FreeCAD version: %s", e)
+
+    try:
+        yield
+    finally:
+        # Shutdown
+        if _bridge:
+            logger.info("Disconnecting FreeCAD bridge...")
+            await _bridge.disconnect()
+            _bridge = None
+

main()

Run the FreeCAD Robust MCP Server.

Source code in src/freecad_mcp/server.py 
380
+381
+382
+383
+384
+385
+386
+387
+388
+389
+390
+391
+392
+393
+394
+395
+396
+397
+398
+399
+400
+401
+402
+403
+404
+405
+406
+407
+408
+409
+410
+411
+412
+413
+414
+415
+416
+417
+418
+419
+420
+421
+422
+423
+424
+425
+426
+427
+428
+429
+430
+431
+432
+433
+434
+435
+436
+437
+438
+439
+440
+441
+442
def main() -> None:
+    """Run the FreeCAD Robust MCP Server."""
+    # Parse arguments first - this handles --help without connecting to FreeCAD
+    args = parse_args()
+
+    # Handle --version
+    if args.version:
+        try:
+            from importlib.metadata import version
+
+            ver = version("freecad-mcp")
+        except Exception:
+            ver = "unknown"
+        print(f"freecad-mcp {ver}")
+        print(f"Instance ID: {INSTANCE_ID}")
+        sys.exit(0)
+
+    # Handle --check (test connection without starting MCP server)
+    if args.check:
+        import asyncio
+
+        success = asyncio.run(
+            check_freecad_connection(mode=args.mode, host=args.host, port=args.port)
+        )
+        sys.exit(0 if success else 1)
+
+    # Apply CLI arguments as environment variables (they override existing ones)
+    apply_cli_args_to_env(args)
+
+    # Now get config (which reads from environment)
+    config = get_config()
+
+    # Set up logging
+    logging.getLogger().setLevel(config.log_level)
+
+    # Print instance ID to stderr only for test automation (when env var is set).
+    # This avoids unwanted output during normal use.
+    # Must use stderr because stdout is reserved for JSON-RPC in stdio mode.
+    if os.environ.get("FREECAD_MCP_TESTING"):
+        print(f"FREECAD_MCP_INSTANCE_ID={INSTANCE_ID}", file=sys.stderr, flush=True)
+
+    logger.info("Starting FreeCAD Robust MCP Server")
+    logger.info("Instance ID: %s", INSTANCE_ID)
+    logger.info("Mode: %s", config.mode.value)
+    logger.info("Transport: %s", config.transport.value)
+
+    # Run the server
+    if config.transport == TransportType.HTTP:
+        logger.info("Starting HTTP transport on port %d", config.http_port)
+        mcp.run(  # type: ignore[call-arg]
+            transport="streamable-http",
+            host="0.0.0.0",  # noqa: S104
+            port=config.http_port,
+        )
+    else:
+        logger.info("Starting stdio transport")
+        logger.info(
+            "Waiting for MCP client connection (FreeCAD connection tested on first request)..."
+        )
+        logger.info(
+            "Tip: Use 'freecad-mcp --check' to test FreeCAD connection directly"
+        )
+        mcp.run()
+

parse_args()

Parse command-line arguments.

Returns:

Type Description
Namespace

Parsed arguments namespace.
Source code in src/freecad_mcp/server.py 
286
+287
+288
+289
+290
+291
+292
+293
+294
+295
+296
+297
+298
+299
+300
+301
+302
+303
+304
+305
+306
+307
+308
+309
+310
+311
+312
+313
+314
+315
+316
+317
+318
+319
+320
+321
+322
+323
+324
+325
+326
+327
+328
+329
+330
+331
+332
+333
+334
+335
+336
+337
+338
+339
+340
+341
+342
+343
+344
+345
+346
+347
+348
+349
+350
+351
+352
+353
+354
+355
+356
+357
+358
+359
+360
+361
+362
+363
+364
+365
+366
+367
+368
+369
+370
+371
+372
+373
+374
+375
+376
+377
def parse_args() -> argparse.Namespace:
+    """Parse command-line arguments.
+
+    Returns:
+        Parsed arguments namespace.
+    """
+    parser = argparse.ArgumentParser(
+        prog="freecad-mcp",
+        description="FreeCAD Robust MCP Server - Connect AI assistants to FreeCAD",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""
+Environment Variables:
+  FREECAD_MODE           Connection mode: xmlrpc, socket, or embedded
+                         (default: xmlrpc)
+  FREECAD_SOCKET_HOST    Host for socket/XML-RPC connection (default: localhost)
+  FREECAD_SOCKET_PORT    Port for socket connection (default: 9876)
+  FREECAD_XMLRPC_PORT    Port for XML-RPC connection (default: 9875)
+  FREECAD_TRANSPORT      Transport type: stdio or http (default: stdio)
+  FREECAD_HTTP_PORT      Port for HTTP transport (default: 8000)
+  FREECAD_LOG_LEVEL      Logging level: DEBUG, INFO, WARNING, ERROR
+                         (default: INFO)
+
+Examples:
+  # Start with default settings (XML-RPC mode, stdio transport)
+  freecad-mcp
+
+  # Use socket mode
+  FREECAD_MODE=socket freecad-mcp
+
+  # Use HTTP transport for remote access
+  FREECAD_TRANSPORT=http FREECAD_HTTP_PORT=8080 freecad-mcp
+
+  # Connect to remote FreeCAD instance
+  FREECAD_SOCKET_HOST=192.168.1.100 freecad-mcp
+
+Prerequisites:
+  The FreeCAD Robust MCP Bridge must be running before starting this server.
+  Start it via:
+    - FreeCAD GUI: Install Robust MCP Bridge workbench, enable auto-start
+    - Headless: just freecad::run-headless
+    - Development: just freecad::run-gui
+""",
+    )
+
+    parser.add_argument(
+        "--version",
+        action="store_true",
+        help="Show version information and exit",
+    )
+
+    parser.add_argument(
+        "--check",
+        action="store_true",
+        help="Test FreeCAD connection and exit (doesn't start MCP server)",
+    )
+
+    parser.add_argument(
+        "--mode",
+        choices=["xmlrpc", "socket", "embedded"],
+        help="Connection mode (overrides FREECAD_MODE env var)",
+    )
+
+    parser.add_argument(
+        "--transport",
+        choices=["stdio", "http"],
+        help="Transport type (overrides FREECAD_TRANSPORT env var)",
+    )
+
+    parser.add_argument(
+        "--host",
+        help="Host for FreeCAD connection (overrides FREECAD_SOCKET_HOST)",
+    )
+
+    parser.add_argument(
+        "--port",
+        type=int,
+        help="Port for FreeCAD connection (mode-dependent)",
+    )
+
+    parser.add_argument(
+        "--http-port",
+        type=int,
+        help="Port for HTTP transport (overrides FREECAD_HTTP_PORT)",
+    )
+
+    parser.add_argument(
+        "--log-level",
+        choices=["DEBUG", "INFO", "WARNING", "ERROR"],
+        help="Logging level (overrides FREECAD_LOG_LEVEL)",
+    )
+
+    return parser.parse_args()
+

register_all_components()

Register all MCP components (tools, resources, prompts).

Source code in src/freecad_mcp/server.py 
165
+166
+167
+168
+169
+170
+171
+172
+173
+174
+175
+176
+177
+178
+179
+180
def register_all_components() -> None:
+    """Register all MCP components (tools, resources, prompts)."""
+    # Register tools
+    from freecad_mcp.tools import register_all_tools
+
+    register_all_tools(mcp, get_bridge)
+
+    # Register resources
+    from freecad_mcp.resources import register_resources
+
+    register_resources(mcp, get_bridge)
+
+    # Register prompts
+    from freecad_mcp.prompts import register_prompts
+
+    register_prompts(mcp, get_bridge)
+

options: show_root_heading: true show_source: true members: - mcp - get_bridge - startup - shutdown

\ No newline at end of file diff --git a/latest/assets/_mkdocstrings.css b/latest/assets/_mkdocstrings.css new file mode 100644 index 0000000..854048c --- /dev/null +++ b/latest/assets/_mkdocstrings.css @@ -0,0 +1,237 @@ + +/* Avoid breaking parameter names, etc. in table cells. */ +.doc-contents td code { + word-break: normal !important; +} + +/* No line break before first paragraph of descriptions. */ +.doc-md-description, +.doc-md-description>p:first-child { + display: inline; +} + +/* No text transformation from Material for MkDocs for H5 headings. */ +.md-typeset h5 .doc-object-name { + text-transform: none; +} + +/* Max width for docstring sections tables. */ +.doc .md-typeset__table, +.doc .md-typeset__table table { + display: table !important; + width: 100%; +} + +.doc .md-typeset__table tr { + display: table-row; +} + +/* Defaults in Spacy table style. */ +.doc-param-default, +.doc-type_param-default { + float: right; +} + +/* Parameter headings must be inline, not blocks. */ +.doc-heading-parameter, +.doc-heading-type_parameter { + display: inline; +} + +/* Default font size for parameter headings. */ +.md-typeset .doc-heading-parameter { + font-size: inherit; +} + +/* Prefer space on the right, not the left of parameter permalinks. */ +.doc-heading-parameter .headerlink, +.doc-heading-type_parameter .headerlink { + margin-left: 0 !important; + margin-right: 0.2rem; +} + +/* Backward-compatibility: docstring section titles in bold. */ +.doc-section-title { + font-weight: bold; +} + +/* Backlinks crumb separator. */ +.doc-backlink-crumb { + display: inline-flex; + gap: .2rem; + white-space: nowrap; + align-items: center; + vertical-align: middle; +} +.doc-backlink-crumb:not(:first-child)::before { + background-color: var(--md-default-fg-color--lighter); + content: ""; + display: inline; + height: 1rem; + --md-path-icon: url('data:image/svg+xml;charset=utf-8,'); + -webkit-mask-image: var(--md-path-icon); + mask-image: var(--md-path-icon); + width: 1rem; +} +.doc-backlink-crumb.last { + font-weight: bold; +} + +/* Symbols in Navigation and ToC. */ +:root, :host, +[data-md-color-scheme="default"] { + --doc-symbol-parameter-fg-color: #df50af; + --doc-symbol-type_parameter-fg-color: #df50af; + --doc-symbol-attribute-fg-color: #953800; + --doc-symbol-function-fg-color: #8250df; + --doc-symbol-method-fg-color: #8250df; + --doc-symbol-class-fg-color: #0550ae; + --doc-symbol-type_alias-fg-color: #0550ae; + --doc-symbol-module-fg-color: #5cad0f; + + --doc-symbol-parameter-bg-color: #df50af1a; + --doc-symbol-type_parameter-bg-color: #df50af1a; + --doc-symbol-attribute-bg-color: #9538001a; + --doc-symbol-function-bg-color: #8250df1a; + --doc-symbol-method-bg-color: #8250df1a; + --doc-symbol-class-bg-color: #0550ae1a; + --doc-symbol-type_alias-bg-color: #0550ae1a; + --doc-symbol-module-bg-color: #5cad0f1a; +} + +[data-md-color-scheme="slate"] { + --doc-symbol-parameter-fg-color: #ffa8cc; + --doc-symbol-type_parameter-fg-color: #ffa8cc; + --doc-symbol-attribute-fg-color: #ffa657; + --doc-symbol-function-fg-color: #d2a8ff; + --doc-symbol-method-fg-color: #d2a8ff; + --doc-symbol-class-fg-color: #79c0ff; + --doc-symbol-type_alias-fg-color: #79c0ff; + --doc-symbol-module-fg-color: #baff79; + + --doc-symbol-parameter-bg-color: #ffa8cc1a; + --doc-symbol-type_parameter-bg-color: #ffa8cc1a; + --doc-symbol-attribute-bg-color: #ffa6571a; + --doc-symbol-function-bg-color: #d2a8ff1a; + --doc-symbol-method-bg-color: #d2a8ff1a; + --doc-symbol-class-bg-color: #79c0ff1a; + --doc-symbol-type_alias-bg-color: #79c0ff1a; + --doc-symbol-module-bg-color: #baff791a; +} + +code.doc-symbol { + border-radius: .1rem; + font-size: .85em; + padding: 0 .3em; + font-weight: bold; +} + +code.doc-symbol-parameter, +a code.doc-symbol-parameter { + color: var(--doc-symbol-parameter-fg-color); + background-color: var(--doc-symbol-parameter-bg-color); +} + +code.doc-symbol-parameter::after { + content: "param"; +} + +code.doc-symbol-type_parameter, +a code.doc-symbol-type_parameter { + color: var(--doc-symbol-type_parameter-fg-color); + background-color: var(--doc-symbol-type_parameter-bg-color); +} + +code.doc-symbol-type_parameter::after { + content: "type-param"; +} + +code.doc-symbol-attribute, +a code.doc-symbol-attribute { + color: var(--doc-symbol-attribute-fg-color); + background-color: var(--doc-symbol-attribute-bg-color); +} + +code.doc-symbol-attribute::after { + content: "attr"; +} + +code.doc-symbol-function, +a code.doc-symbol-function { + color: var(--doc-symbol-function-fg-color); + background-color: var(--doc-symbol-function-bg-color); +} + +code.doc-symbol-function::after { + content: "func"; +} + +code.doc-symbol-method, +a code.doc-symbol-method { + color: var(--doc-symbol-method-fg-color); + background-color: var(--doc-symbol-method-bg-color); +} + +code.doc-symbol-method::after { + content: "meth"; +} + +code.doc-symbol-class, +a code.doc-symbol-class { + color: var(--doc-symbol-class-fg-color); + background-color: var(--doc-symbol-class-bg-color); +} + +code.doc-symbol-class::after { + content: "class"; +} + + +code.doc-symbol-type_alias, +a code.doc-symbol-type_alias { + color: var(--doc-symbol-type_alias-fg-color); + background-color: var(--doc-symbol-type_alias-bg-color); +} + +code.doc-symbol-type_alias::after { + content: "type"; +} + +code.doc-symbol-module, +a code.doc-symbol-module { + color: var(--doc-symbol-module-fg-color); + background-color: var(--doc-symbol-module-bg-color); +} + +code.doc-symbol-module::after { + content: "mod"; +} + +.doc-signature .autorefs { + color: inherit; + border-bottom: 1px dotted currentcolor; +} + +/* Source code blocks (admonitions). */ +:root { + --md-admonition-icon--mkdocstrings-source: url('data:image/svg+xml;charset=utf-8,') +} +.md-typeset .admonition.mkdocstrings-source, +.md-typeset details.mkdocstrings-source { + border: none; + padding: 0; +} +.md-typeset .admonition.mkdocstrings-source:focus-within, +.md-typeset details.mkdocstrings-source:focus-within { + box-shadow: none; +} +.md-typeset .mkdocstrings-source > .admonition-title, +.md-typeset .mkdocstrings-source > summary { + background-color: inherit; +} +.md-typeset .mkdocstrings-source > .admonition-title::before, +.md-typeset .mkdocstrings-source > summary::before { + background-color: var(--md-default-fg-color); + -webkit-mask-image: var(--md-admonition-icon--mkdocstrings-source); + mask-image: var(--md-admonition-icon--mkdocstrings-source); +} diff --git a/latest/assets/images/favicon.png b/latest/assets/images/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..1cf13b9f9d978896599290a74f77d5dbe7d1655c GIT binary patch literal 1870 zcmV-U2eJ5xP)Gc)JR9QMau)O=X#!i9;T z37kk-upj^(fsR36MHs_+1RCI)NNu9}lD0S{B^g8PN?Ww(5|~L#Ng*g{WsqleV}|#l zz8@ri&cTzw_h33bHI+12+kK6WN$h#n5cD8OQt`5kw6p~9H3()bUQ8OS4Q4HTQ=1Ol z_JAocz`fLbT2^{`8n~UAo=#AUOf=SOq4pYkt;XbC&f#7lb$*7=$na!mWCQ`dBQsO0 zLFBSPj*N?#u5&pf2t4XjEGH|=pPQ8xh7tpx;US5Cx_Ju;!O`ya-yF`)b%TEt5>eP1ZX~}sjjA%FJF?h7cX8=b!DZl<6%Cv z*G0uvvU+vmnpLZ2paivG-(cd*y3$hCIcsZcYOGh{$&)A6*XX&kXZd3G8m)G$Zz-LV z^GF3VAW^Mdv!)4OM8EgqRiz~*Cji;uzl2uC9^=8I84vNp;ltJ|q-*uQwGp2ma6cY7 z;`%`!9UXO@fr&Ebapfs34OmS9^u6$)bJxrucutf>`dKPKT%%*d3XlFVKunp9 zasduxjrjs>f8V=D|J=XNZp;_Zy^WgQ$9WDjgY=z@stwiEBm9u5*|34&1Na8BMjjgf3+SHcr`5~>oz1Y?SW^=K z^bTyO6>Gar#P_W2gEMwq)ot3; zREHn~U&Dp0l6YT0&k-wLwYjb?5zGK`W6S2v+K>AM(95m2C20L|3m~rN8dprPr@t)5lsk9Hu*W z?pS990s;Ez=+Rj{x7p``4>+c0G5^pYnB1^!TL=(?HLHZ+HicG{~4F1d^5Awl_2!1jICM-!9eoLhbbT^;yHcefyTAaqRcY zmuctDopPT!%k+}x%lZRKnzykr2}}XfG_ne?nRQO~?%hkzo;@RN{P6o`&mMUWBYMTe z6i8ChtjX&gXl`nvrU>jah)2iNM%JdjqoaeaU%yVn!^70x-flljp6Q5tK}5}&X8&&G zX3fpb3E(!rH=zVI_9Gjl45w@{(ITqngWFe7@9{mX;tO25Z_8 zQHEpI+FkTU#4xu>RkN>b3Tnc3UpWzPXWm#o55GKF09j^Mh~)K7{QqbO_~(@CVq! zS<8954|P8mXN2MRs86xZ&Q4EfM@JB94b=(YGuk)s&^jiSF=t3*oNK3`rD{H`yQ?d; ztE=laAUoZx5?RC8*WKOj`%LXEkgDd>&^Q4M^z`%u0rg-It=hLCVsq!Z%^6eB-OvOT zFZ28TN&cRmgU}Elrnk43)!>Z1FCPL2K$7}gwzIc48NX}#!A1BpJP?#v5wkNprhV** z?Cpalt1oH&{r!o3eSKc&ap)iz2BTn_VV`4>9M^b3;(YY}4>#ML6{~(4mH+?%07*qo IM6N<$f(jP3KmY&$ literal 0 HcmV?d00001 diff --git a/latest/assets/javascripts/bundle.79ae519e.min.js b/latest/assets/javascripts/bundle.79ae519e.min.js new file mode 100644 index 0000000..3df3e5e --- /dev/null +++ b/latest/assets/javascripts/bundle.79ae519e.min.js @@ -0,0 +1,16 @@ +"use strict";(()=>{var Zi=Object.create;var _r=Object.defineProperty;var ea=Object.getOwnPropertyDescriptor;var ta=Object.getOwnPropertyNames,Bt=Object.getOwnPropertySymbols,ra=Object.getPrototypeOf,Ar=Object.prototype.hasOwnProperty,bo=Object.prototype.propertyIsEnumerable;var ho=(e,t,r)=>t in e?_r(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,P=(e,t)=>{for(var r in t||(t={}))Ar.call(t,r)&&ho(e,r,t[r]);if(Bt)for(var r of Bt(t))bo.call(t,r)&&ho(e,r,t[r]);return e};var vo=(e,t)=>{var r={};for(var o in e)Ar.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&Bt)for(var o of Bt(e))t.indexOf(o)<0&&bo.call(e,o)&&(r[o]=e[o]);return r};var Cr=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var oa=(e,t,r,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of ta(t))!Ar.call(e,n)&&n!==r&&_r(e,n,{get:()=>t[n],enumerable:!(o=ea(t,n))||o.enumerable});return e};var $t=(e,t,r)=>(r=e!=null?Zi(ra(e)):{},oa(t||!e||!e.__esModule?_r(r,"default",{value:e,enumerable:!0}):r,e));var go=(e,t,r)=>new Promise((o,n)=>{var i=c=>{try{a(r.next(c))}catch(p){n(p)}},s=c=>{try{a(r.throw(c))}catch(p){n(p)}},a=c=>c.done?o(c.value):Promise.resolve(c.value).then(i,s);a((r=r.apply(e,t)).next())});var xo=Cr((kr,yo)=>{(function(e,t){typeof kr=="object"&&typeof yo!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(kr,(function(){"use strict";function e(r){var o=!0,n=!1,i=null,s={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function a(k){return!!(k&&k!==document&&k.nodeName!=="HTML"&&k.nodeName!=="BODY"&&"classList"in k&&"contains"in k.classList)}function c(k){var ut=k.type,je=k.tagName;return!!(je==="INPUT"&&s[ut]&&!k.readOnly||je==="TEXTAREA"&&!k.readOnly||k.isContentEditable)}function p(k){k.classList.contains("focus-visible")||(k.classList.add("focus-visible"),k.setAttribute("data-focus-visible-added",""))}function l(k){k.hasAttribute("data-focus-visible-added")&&(k.classList.remove("focus-visible"),k.removeAttribute("data-focus-visible-added"))}function f(k){k.metaKey||k.altKey||k.ctrlKey||(a(r.activeElement)&&p(r.activeElement),o=!0)}function u(k){o=!1}function d(k){a(k.target)&&(o||c(k.target))&&p(k.target)}function v(k){a(k.target)&&(k.target.classList.contains("focus-visible")||k.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),l(k.target))}function S(k){document.visibilityState==="hidden"&&(n&&(o=!0),X())}function X(){document.addEventListener("mousemove",ee),document.addEventListener("mousedown",ee),document.addEventListener("mouseup",ee),document.addEventListener("pointermove",ee),document.addEventListener("pointerdown",ee),document.addEventListener("pointerup",ee),document.addEventListener("touchmove",ee),document.addEventListener("touchstart",ee),document.addEventListener("touchend",ee)}function re(){document.removeEventListener("mousemove",ee),document.removeEventListener("mousedown",ee),document.removeEventListener("mouseup",ee),document.removeEventListener("pointermove",ee),document.removeEventListener("pointerdown",ee),document.removeEventListener("pointerup",ee),document.removeEventListener("touchmove",ee),document.removeEventListener("touchstart",ee),document.removeEventListener("touchend",ee)}function ee(k){k.target.nodeName&&k.target.nodeName.toLowerCase()==="html"||(o=!1,re())}document.addEventListener("keydown",f,!0),document.addEventListener("mousedown",u,!0),document.addEventListener("pointerdown",u,!0),document.addEventListener("touchstart",u,!0),document.addEventListener("visibilitychange",S,!0),X(),r.addEventListener("focus",d,!0),r.addEventListener("blur",v,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)}))});var ro=Cr((jy,Rn)=>{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var qa=/["'&<>]/;Rn.exports=Ka;function Ka(e){var t=""+e,r=qa.exec(t);if(!r)return t;var o,n="",i=0,s=0;for(i=r.index;i{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof Nt=="object"&&typeof io=="object"?io.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Nt=="object"?Nt.ClipboardJS=r():t.ClipboardJS=r()})(Nt,function(){return(function(){var e={686:(function(o,n,i){"use strict";i.d(n,{default:function(){return Xi}});var s=i(279),a=i.n(s),c=i(370),p=i.n(c),l=i(817),f=i.n(l);function u(q){try{return document.execCommand(q)}catch(C){return!1}}var d=function(C){var _=f()(C);return u("cut"),_},v=d;function S(q){var C=document.documentElement.getAttribute("dir")==="rtl",_=document.createElement("textarea");_.style.fontSize="12pt",_.style.border="0",_.style.padding="0",_.style.margin="0",_.style.position="absolute",_.style[C?"right":"left"]="-9999px";var D=window.pageYOffset||document.documentElement.scrollTop;return _.style.top="".concat(D,"px"),_.setAttribute("readonly",""),_.value=q,_}var X=function(C,_){var D=S(C);_.container.appendChild(D);var N=f()(D);return u("copy"),D.remove(),N},re=function(C){var _=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},D="";return typeof C=="string"?D=X(C,_):C instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(C==null?void 0:C.type)?D=X(C.value,_):(D=f()(C),u("copy")),D},ee=re;function k(q){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?k=function(_){return typeof _}:k=function(_){return _&&typeof Symbol=="function"&&_.constructor===Symbol&&_!==Symbol.prototype?"symbol":typeof _},k(q)}var ut=function(){var C=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},_=C.action,D=_===void 0?"copy":_,N=C.container,G=C.target,We=C.text;if(D!=="copy"&&D!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(G!==void 0)if(G&&k(G)==="object"&&G.nodeType===1){if(D==="copy"&&G.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(D==="cut"&&(G.hasAttribute("readonly")||G.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(We)return ee(We,{container:N});if(G)return D==="cut"?v(G):ee(G,{container:N})},je=ut;function R(q){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?R=function(_){return typeof _}:R=function(_){return _&&typeof Symbol=="function"&&_.constructor===Symbol&&_!==Symbol.prototype?"symbol":typeof _},R(q)}function se(q,C){if(!(q instanceof C))throw new TypeError("Cannot call a class as a function")}function ce(q,C){for(var _=0;_0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof N.action=="function"?N.action:this.defaultAction,this.target=typeof N.target=="function"?N.target:this.defaultTarget,this.text=typeof N.text=="function"?N.text:this.defaultText,this.container=R(N.container)==="object"?N.container:document.body}},{key:"listenClick",value:function(N){var G=this;this.listener=p()(N,"click",function(We){return G.onClick(We)})}},{key:"onClick",value:function(N){var G=N.delegateTarget||N.currentTarget,We=this.action(G)||"copy",Yt=je({action:We,container:this.container,target:this.target(G),text:this.text(G)});this.emit(Yt?"success":"error",{action:We,text:Yt,trigger:G,clearSelection:function(){G&&G.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(N){return Mr("action",N)}},{key:"defaultTarget",value:function(N){var G=Mr("target",N);if(G)return document.querySelector(G)}},{key:"defaultText",value:function(N){return Mr("text",N)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(N){var G=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return ee(N,G)}},{key:"cut",value:function(N){return v(N)}},{key:"isSupported",value:function(){var N=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],G=typeof N=="string"?[N]:N,We=!!document.queryCommandSupported;return G.forEach(function(Yt){We=We&&!!document.queryCommandSupported(Yt)}),We}}]),_})(a()),Xi=Ji}),828:(function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function s(a,c){for(;a&&a.nodeType!==n;){if(typeof a.matches=="function"&&a.matches(c))return a;a=a.parentNode}}o.exports=s}),438:(function(o,n,i){var s=i(828);function a(l,f,u,d,v){var S=p.apply(this,arguments);return l.addEventListener(u,S,v),{destroy:function(){l.removeEventListener(u,S,v)}}}function c(l,f,u,d,v){return typeof l.addEventListener=="function"?a.apply(null,arguments):typeof u=="function"?a.bind(null,document).apply(null,arguments):(typeof l=="string"&&(l=document.querySelectorAll(l)),Array.prototype.map.call(l,function(S){return a(S,f,u,d,v)}))}function p(l,f,u,d){return function(v){v.delegateTarget=s(v.target,f),v.delegateTarget&&d.call(l,v)}}o.exports=c}),879:(function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var s=Object.prototype.toString.call(i);return i!==void 0&&(s==="[object NodeList]"||s==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var s=Object.prototype.toString.call(i);return s==="[object Function]"}}),370:(function(o,n,i){var s=i(879),a=i(438);function c(u,d,v){if(!u&&!d&&!v)throw new Error("Missing required arguments");if(!s.string(d))throw new TypeError("Second argument must be a String");if(!s.fn(v))throw new TypeError("Third argument must be a Function");if(s.node(u))return p(u,d,v);if(s.nodeList(u))return l(u,d,v);if(s.string(u))return f(u,d,v);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function p(u,d,v){return u.addEventListener(d,v),{destroy:function(){u.removeEventListener(d,v)}}}function l(u,d,v){return Array.prototype.forEach.call(u,function(S){S.addEventListener(d,v)}),{destroy:function(){Array.prototype.forEach.call(u,function(S){S.removeEventListener(d,v)})}}}function f(u,d,v){return a(document.body,u,d,v)}o.exports=c}),817:(function(o){function n(i){var s;if(i.nodeName==="SELECT")i.focus(),s=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var a=i.hasAttribute("readonly");a||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),a||i.removeAttribute("readonly"),s=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var c=window.getSelection(),p=document.createRange();p.selectNodeContents(i),c.removeAllRanges(),c.addRange(p),s=c.toString()}return s}o.exports=n}),279:(function(o){function n(){}n.prototype={on:function(i,s,a){var c=this.e||(this.e={});return(c[i]||(c[i]=[])).push({fn:s,ctx:a}),this},once:function(i,s,a){var c=this;function p(){c.off(i,p),s.apply(a,arguments)}return p._=s,this.on(i,p,a)},emit:function(i){var s=[].slice.call(arguments,1),a=((this.e||(this.e={}))[i]||[]).slice(),c=0,p=a.length;for(c;c0&&i[i.length-1])&&(p[0]===6||p[0]===2)){r=0;continue}if(p[0]===3&&(!i||p[1]>i[0]&&p[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function K(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],s;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(a){s={error:a}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(s)throw s.error}}return i}function B(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||c(d,S)})},v&&(n[d]=v(n[d])))}function c(d,v){try{p(o[d](v))}catch(S){u(i[0][3],S)}}function p(d){d.value instanceof dt?Promise.resolve(d.value.v).then(l,f):u(i[0][2],d)}function l(d){c("next",d)}function f(d){c("throw",d)}function u(d,v){d(v),i.shift(),i.length&&c(i[0][0],i[0][1])}}function To(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof Oe=="function"?Oe(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(s){return new Promise(function(a,c){s=e[i](s),n(a,c,s.done,s.value)})}}function n(i,s,a,c){Promise.resolve(c).then(function(p){i({value:p,done:a})},s)}}function I(e){return typeof e=="function"}function yt(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var Jt=yt(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(o,n){return n+1+") "+o.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function Ze(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var qe=(function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var s=this._parentage;if(s)if(this._parentage=null,Array.isArray(s))try{for(var a=Oe(s),c=a.next();!c.done;c=a.next()){var p=c.value;p.remove(this)}}catch(S){t={error:S}}finally{try{c&&!c.done&&(r=a.return)&&r.call(a)}finally{if(t)throw t.error}}else s.remove(this);var l=this.initialTeardown;if(I(l))try{l()}catch(S){i=S instanceof Jt?S.errors:[S]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=Oe(f),d=u.next();!d.done;d=u.next()){var v=d.value;try{So(v)}catch(S){i=i!=null?i:[],S instanceof Jt?i=B(B([],K(i)),K(S.errors)):i.push(S)}}}catch(S){o={error:S}}finally{try{d&&!d.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new Jt(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)So(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&Ze(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&Ze(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=(function(){var t=new e;return t.closed=!0,t})(),e})();var $r=qe.EMPTY;function Xt(e){return e instanceof qe||e&&"closed"in e&&I(e.remove)&&I(e.add)&&I(e.unsubscribe)}function So(e){I(e)?e():e.unsubscribe()}var De={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var xt={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,s=n.isStopped,a=n.observers;return i||s?$r:(this.currentObservers=null,a.push(r),new qe(function(){o.currentObservers=null,Ze(a,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,s=o.isStopped;n?r.error(i):s&&r.complete()},t.prototype.asObservable=function(){var r=new F;return r.source=this,r},t.create=function(r,o){return new Ho(r,o)},t})(F);var Ho=(function(e){ie(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:$r},t})(T);var jr=(function(e){ie(t,e);function t(r){var o=e.call(this)||this;return o._value=r,o}return Object.defineProperty(t.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),t.prototype._subscribe=function(r){var o=e.prototype._subscribe.call(this,r);return!o.closed&&r.next(this._value),o},t.prototype.getValue=function(){var r=this,o=r.hasError,n=r.thrownError,i=r._value;if(o)throw n;return this._throwIfClosed(),i},t.prototype.next=function(r){e.prototype.next.call(this,this._value=r)},t})(T);var Rt={now:function(){return(Rt.delegate||Date).now()},delegate:void 0};var It=(function(e){ie(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=Rt);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,s=o._infiniteTimeWindow,a=o._timestampProvider,c=o._windowTime;n||(i.push(r),!s&&i.push(a.now()+c)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,s=n._buffer,a=s.slice(),c=0;c0?e.prototype.schedule.call(this,r,o):(this.delay=o,this.state=r,this.scheduler.flush(this),this)},t.prototype.execute=function(r,o){return o>0||this.closed?e.prototype.execute.call(this,r,o):this._execute(r,o)},t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!=null&&n>0||n==null&&this.delay>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.flush(this),0)},t})(St);var Ro=(function(e){ie(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t})(Ot);var Dr=new Ro(Po);var Io=(function(e){ie(t,e);function t(r,o){var n=e.call(this,r,o)||this;return n.scheduler=r,n.work=o,n}return t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!==null&&n>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=Tt.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var s=r.actions;o!=null&&o===r._scheduled&&((i=s[s.length-1])===null||i===void 0?void 0:i.id)!==o&&(Tt.cancelAnimationFrame(o),r._scheduled=void 0)},t})(St);var Fo=(function(e){ie(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o;r?o=r.id:(o=this._scheduled,this._scheduled=void 0);var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t})(Ot);var ye=new Fo(Io);var y=new F(function(e){return e.complete()});function tr(e){return e&&I(e.schedule)}function Vr(e){return e[e.length-1]}function pt(e){return I(Vr(e))?e.pop():void 0}function Fe(e){return tr(Vr(e))?e.pop():void 0}function rr(e,t){return typeof Vr(e)=="number"?e.pop():t}var Lt=(function(e){return e&&typeof e.length=="number"&&typeof e!="function"});function or(e){return I(e==null?void 0:e.then)}function nr(e){return I(e[wt])}function ir(e){return Symbol.asyncIterator&&I(e==null?void 0:e[Symbol.asyncIterator])}function ar(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function fa(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var sr=fa();function cr(e){return I(e==null?void 0:e[sr])}function pr(e){return wo(this,arguments,function(){var r,o,n,i;return Gt(this,function(s){switch(s.label){case 0:r=e.getReader(),s.label=1;case 1:s.trys.push([1,,9,10]),s.label=2;case 2:return[4,dt(r.read())];case 3:return o=s.sent(),n=o.value,i=o.done,i?[4,dt(void 0)]:[3,5];case 4:return[2,s.sent()];case 5:return[4,dt(n)];case 6:return[4,s.sent()];case 7:return s.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function lr(e){return I(e==null?void 0:e.getReader)}function U(e){if(e instanceof F)return e;if(e!=null){if(nr(e))return ua(e);if(Lt(e))return da(e);if(or(e))return ha(e);if(ir(e))return jo(e);if(cr(e))return ba(e);if(lr(e))return va(e)}throw ar(e)}function ua(e){return new F(function(t){var r=e[wt]();if(I(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function da(e){return new F(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?g(function(n,i){return e(n,i,o)}):be,Ee(1),r?Qe(t):tn(function(){return new fr}))}}function Yr(e){return e<=0?function(){return y}:E(function(t,r){var o=[];t.subscribe(w(r,function(n){o.push(n),e=2,!0))}function le(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new T}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,s=i===void 0?!0:i,a=e.resetOnRefCountZero,c=a===void 0?!0:a;return function(p){var l,f,u,d=0,v=!1,S=!1,X=function(){f==null||f.unsubscribe(),f=void 0},re=function(){X(),l=u=void 0,v=S=!1},ee=function(){var k=l;re(),k==null||k.unsubscribe()};return E(function(k,ut){d++,!S&&!v&&X();var je=u=u!=null?u:r();ut.add(function(){d--,d===0&&!S&&!v&&(f=Br(ee,c))}),je.subscribe(ut),!l&&d>0&&(l=new bt({next:function(R){return je.next(R)},error:function(R){S=!0,X(),f=Br(re,n,R),je.error(R)},complete:function(){v=!0,X(),f=Br(re,s),je.complete()}}),U(k).subscribe(l))})(p)}}function Br(e,t){for(var r=[],o=2;oe.next(document)),e}function M(e,t=document){return Array.from(t.querySelectorAll(e))}function j(e,t=document){let r=ue(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function ue(e,t=document){return t.querySelector(e)||void 0}function Ne(){var e,t,r,o;return(o=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?o:void 0}var Ra=L(h(document.body,"focusin"),h(document.body,"focusout")).pipe(Ae(1),Q(void 0),m(()=>Ne()||document.body),Z(1));function Ye(e){return Ra.pipe(m(t=>e.contains(t)),Y())}function it(e,t){return H(()=>L(h(e,"mouseenter").pipe(m(()=>!0)),h(e,"mouseleave").pipe(m(()=>!1))).pipe(t?jt(r=>He(+!r*t)):be,Q(e.matches(":hover"))))}function sn(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)sn(e,r)}function x(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)sn(o,n);return o}function br(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function _t(e){let t=x("script",{src:e});return H(()=>(document.head.appendChild(t),L(h(t,"load"),h(t,"error").pipe(b(()=>Nr(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(m(()=>{}),A(()=>document.head.removeChild(t)),Ee(1))))}var cn=new T,Ia=H(()=>typeof ResizeObserver=="undefined"?_t("https://unpkg.com/resize-observer-polyfill"):$(void 0)).pipe(m(()=>new ResizeObserver(e=>e.forEach(t=>cn.next(t)))),b(e=>L(tt,$(e)).pipe(A(()=>e.disconnect()))),Z(1));function de(e){return{width:e.offsetWidth,height:e.offsetHeight}}function Le(e){let t=e;for(;t.clientWidth===0&&t.parentElement;)t=t.parentElement;return Ia.pipe(O(r=>r.observe(t)),b(r=>cn.pipe(g(o=>o.target===t),A(()=>r.unobserve(t)))),m(()=>de(e)),Q(de(e)))}function At(e){return{width:e.scrollWidth,height:e.scrollHeight}}function vr(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}function pn(e){let t=[],r=e.parentElement;for(;r;)(e.clientWidth>r.clientWidth||e.clientHeight>r.clientHeight)&&t.push(r),r=(e=r).parentElement;return t.length===0&&t.push(document.documentElement),t}function Be(e){return{x:e.offsetLeft,y:e.offsetTop}}function ln(e){let t=e.getBoundingClientRect();return{x:t.x+window.scrollX,y:t.y+window.scrollY}}function mn(e){return L(h(window,"load"),h(window,"resize")).pipe($e(0,ye),m(()=>Be(e)),Q(Be(e)))}function gr(e){return{x:e.scrollLeft,y:e.scrollTop}}function Ge(e){return L(h(e,"scroll"),h(window,"scroll"),h(window,"resize")).pipe($e(0,ye),m(()=>gr(e)),Q(gr(e)))}var fn=new T,Fa=H(()=>$(new IntersectionObserver(e=>{for(let t of e)fn.next(t)},{threshold:0}))).pipe(b(e=>L(tt,$(e)).pipe(A(()=>e.disconnect()))),Z(1));function mt(e){return Fa.pipe(O(t=>t.observe(e)),b(t=>fn.pipe(g(({target:r})=>r===e),A(()=>t.unobserve(e)),m(({isIntersecting:r})=>r))))}function un(e,t=16){return Ge(e).pipe(m(({y:r})=>{let o=de(e),n=At(e);return r>=n.height-o.height-t}),Y())}var yr={drawer:j("[data-md-toggle=drawer]"),search:j("[data-md-toggle=search]")};function dn(e){return yr[e].checked}function at(e,t){yr[e].checked!==t&&yr[e].click()}function Je(e){let t=yr[e];return h(t,"change").pipe(m(()=>t.checked),Q(t.checked))}function ja(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Ua(){return L(h(window,"compositionstart").pipe(m(()=>!0)),h(window,"compositionend").pipe(m(()=>!1))).pipe(Q(!1))}function hn(){let e=h(window,"keydown").pipe(g(t=>!(t.metaKey||t.ctrlKey)),m(t=>({mode:dn("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),g(({mode:t,type:r})=>{if(t==="global"){let o=Ne();if(typeof o!="undefined")return!ja(o,r)}return!0}),le());return Ua().pipe(b(t=>t?y:e))}function we(){return new URL(location.href)}function st(e,t=!1){if(V("navigation.instant")&&!t){let r=x("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function bn(){return new T}function vn(){return location.hash.slice(1)}function gn(e){let t=x("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Zr(e){return L(h(window,"hashchange"),e).pipe(m(vn),Q(vn()),g(t=>t.length>0),Z(1))}function yn(e){return Zr(e).pipe(m(t=>ue(`[id="${t}"]`)),g(t=>typeof t!="undefined"))}function Wt(e){let t=matchMedia(e);return ur(r=>t.addListener(()=>r(t.matches))).pipe(Q(t.matches))}function xn(){let e=matchMedia("print");return L(h(window,"beforeprint").pipe(m(()=>!0)),h(window,"afterprint").pipe(m(()=>!1))).pipe(Q(e.matches))}function eo(e,t){return e.pipe(b(r=>r?t():y))}function to(e,t){return new F(r=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(r.next(o.response),r.complete()):r.error(new Error(o.statusText))}),o.addEventListener("error",()=>{r.error(new Error("Network error"))}),o.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)t.progress$.next(n.loaded/n.total*100);else{let s=(i=o.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(n.loaded/+s*100)}}),t.progress$.next(5)),o.send(),()=>o.abort()})}function ze(e,t){return to(e,t).pipe(b(r=>r.text()),m(r=>JSON.parse(r)),Z(1))}function xr(e,t){let r=new DOMParser;return to(e,t).pipe(b(o=>o.text()),m(o=>r.parseFromString(o,"text/html")),Z(1))}function En(e,t){let r=new DOMParser;return to(e,t).pipe(b(o=>o.text()),m(o=>r.parseFromString(o,"text/xml")),Z(1))}function wn(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function Tn(){return L(h(window,"scroll",{passive:!0}),h(window,"resize",{passive:!0})).pipe(m(wn),Q(wn()))}function Sn(){return{width:innerWidth,height:innerHeight}}function On(){return h(window,"resize",{passive:!0}).pipe(m(Sn),Q(Sn()))}function Ln(){return z([Tn(),On()]).pipe(m(([e,t])=>({offset:e,size:t})),Z(1))}function Er(e,{viewport$:t,header$:r}){let o=t.pipe(ne("size")),n=z([o,r]).pipe(m(()=>Be(e)));return z([r,t,n]).pipe(m(([{height:i},{offset:s,size:a},{x:c,y:p}])=>({offset:{x:s.x-c,y:s.y-p+i},size:a})))}function Wa(e){return h(e,"message",t=>t.data)}function Da(e){let t=new T;return t.subscribe(r=>e.postMessage(r)),t}function Mn(e,t=new Worker(e)){let r=Wa(t),o=Da(t),n=new T;n.subscribe(o);let i=o.pipe(oe(),ae(!0));return n.pipe(oe(),Ve(r.pipe(W(i))),le())}var Va=j("#__config"),Ct=JSON.parse(Va.textContent);Ct.base=`${new URL(Ct.base,we())}`;function Te(){return Ct}function V(e){return Ct.features.includes(e)}function Me(e,t){return typeof t!="undefined"?Ct.translations[e].replace("#",t.toString()):Ct.translations[e]}function Ce(e,t=document){return j(`[data-md-component=${e}]`,t)}function me(e,t=document){return M(`[data-md-component=${e}]`,t)}function Na(e){let t=j(".md-typeset > :first-child",e);return h(t,"click",{once:!0}).pipe(m(()=>j(".md-typeset",e)),m(r=>({hash:__md_hash(r.innerHTML)})))}function _n(e){if(!V("announce.dismiss")||!e.childElementCount)return y;if(!e.hidden){let t=j(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return H(()=>{let t=new T;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),Na(e).pipe(O(r=>t.next(r)),A(()=>t.complete()),m(r=>P({ref:e},r)))})}function za(e,{target$:t}){return t.pipe(m(r=>({hidden:r!==e})))}function An(e,t){let r=new T;return r.subscribe(({hidden:o})=>{e.hidden=o}),za(e,t).pipe(O(o=>r.next(o)),A(()=>r.complete()),m(o=>P({ref:e},o)))}function Dt(e,t){return t==="inline"?x("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"})):x("div",{class:"md-tooltip",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"}))}function wr(...e){return x("div",{class:"md-tooltip2",role:"dialog"},x("div",{class:"md-tooltip2__inner md-typeset"},e))}function Cn(...e){return x("div",{class:"md-tooltip2",role:"tooltip"},x("div",{class:"md-tooltip2__inner md-typeset"},e))}function kn(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return x("aside",{class:"md-annotation",tabIndex:0},Dt(t),x("a",{href:r,class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}else return x("aside",{class:"md-annotation",tabIndex:0},Dt(t),x("span",{class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}function Hn(e){return x("button",{class:"md-code__button",title:Me("clipboard.copy"),"data-clipboard-target":`#${e} > code`,"data-md-type":"copy"})}function $n(){return x("button",{class:"md-code__button",title:"Toggle line selection","data-md-type":"select"})}function Pn(){return x("nav",{class:"md-code__nav"})}var In=$t(ro());function oo(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(c=>!e.terms[c]).reduce((c,p)=>[...c,x("del",null,(0,In.default)(p))," "],[]).slice(0,-1),i=Te(),s=new URL(e.location,i.base);V("search.highlight")&&s.searchParams.set("h",Object.entries(e.terms).filter(([,c])=>c).reduce((c,[p])=>`${c} ${p}`.trim(),""));let{tags:a}=Te();return x("a",{href:`${s}`,class:"md-search-result__link",tabIndex:-1},x("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&x("div",{class:"md-search-result__icon md-icon"}),r>0&&x("h1",null,e.title),r<=0&&x("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&x("nav",{class:"md-tags"},e.tags.map(c=>{let p=a?c in a?`md-tag-icon md-tag--${a[c]}`:"md-tag-icon":"";return x("span",{class:`md-tag ${p}`},c)})),o>0&&n.length>0&&x("p",{class:"md-search-result__terms"},Me("search.result.term.missing"),": ",...n)))}function Fn(e){let t=e[0].score,r=[...e],o=Te(),n=r.findIndex(l=>!`${new URL(l.location,o.base)}`.includes("#")),[i]=r.splice(n,1),s=r.findIndex(l=>l.scoreoo(l,1)),...c.length?[x("details",{class:"md-search-result__more"},x("summary",{tabIndex:-1},x("div",null,c.length>0&&c.length===1?Me("search.result.more.one"):Me("search.result.more.other",c.length))),...c.map(l=>oo(l,1)))]:[]];return x("li",{class:"md-search-result__item"},p)}function jn(e){return x("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>x("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?br(r):r)))}function no(e){let t=`tabbed-control tabbed-control--${e}`;return x("div",{class:t,hidden:!0},x("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function Un(e){return x("div",{class:"md-typeset__scrollwrap"},x("div",{class:"md-typeset__table"},e))}function Qa(e){var o;let t=Te(),r=new URL(`../${e.version}/`,t.base);return x("li",{class:"md-version__item"},x("a",{href:`${r}`,class:"md-version__link"},e.title,((o=t.version)==null?void 0:o.alias)&&e.aliases.length>0&&x("span",{class:"md-version__alias"},e.aliases[0])))}function Wn(e,t){var o;let r=Te();return e=e.filter(n=>{var i;return!((i=n.properties)!=null&&i.hidden)}),x("div",{class:"md-version"},x("button",{class:"md-version__current","aria-label":Me("select.version")},t.title,((o=r.version)==null?void 0:o.alias)&&t.aliases.length>0&&x("span",{class:"md-version__alias"},t.aliases[0])),x("ul",{class:"md-version__list"},e.map(Qa)))}var Ya=0;function Ba(e,t=250){let r=z([Ye(e),it(e,t)]).pipe(m(([n,i])=>n||i),Y()),o=H(()=>pn(e)).pipe(J(Ge),gt(1),Pe(r),m(()=>ln(e)));return r.pipe(Re(n=>n),b(()=>z([r,o])),m(([n,i])=>({active:n,offset:i})),le())}function Vt(e,t,r=250){let{content$:o,viewport$:n}=t,i=`__tooltip2_${Ya++}`;return H(()=>{let s=new T,a=new jr(!1);s.pipe(oe(),ae(!1)).subscribe(a);let c=a.pipe(jt(l=>He(+!l*250,Dr)),Y(),b(l=>l?o:y),O(l=>l.id=i),le());z([s.pipe(m(({active:l})=>l)),c.pipe(b(l=>it(l,250)),Q(!1))]).pipe(m(l=>l.some(f=>f))).subscribe(a);let p=a.pipe(g(l=>l),te(c,n),m(([l,f,{size:u}])=>{let d=e.getBoundingClientRect(),v=d.width/2;if(f.role==="tooltip")return{x:v,y:8+d.height};if(d.y>=u.height/2){let{height:S}=de(f);return{x:v,y:-16-S}}else return{x:v,y:16+d.height}}));return z([c,s,p]).subscribe(([l,{offset:f},u])=>{l.style.setProperty("--md-tooltip-host-x",`${f.x}px`),l.style.setProperty("--md-tooltip-host-y",`${f.y}px`),l.style.setProperty("--md-tooltip-x",`${u.x}px`),l.style.setProperty("--md-tooltip-y",`${u.y}px`),l.classList.toggle("md-tooltip2--top",u.y<0),l.classList.toggle("md-tooltip2--bottom",u.y>=0)}),a.pipe(g(l=>l),te(c,(l,f)=>f),g(l=>l.role==="tooltip")).subscribe(l=>{let f=de(j(":scope > *",l));l.style.setProperty("--md-tooltip-width",`${f.width}px`),l.style.setProperty("--md-tooltip-tail","0px")}),a.pipe(Y(),xe(ye),te(c)).subscribe(([l,f])=>{f.classList.toggle("md-tooltip2--active",l)}),z([a.pipe(g(l=>l)),c]).subscribe(([l,f])=>{f.role==="dialog"?(e.setAttribute("aria-controls",i),e.setAttribute("aria-haspopup","dialog")):e.setAttribute("aria-describedby",i)}),a.pipe(g(l=>!l)).subscribe(()=>{e.removeAttribute("aria-controls"),e.removeAttribute("aria-describedby"),e.removeAttribute("aria-haspopup")}),Ba(e,r).pipe(O(l=>s.next(l)),A(()=>s.complete()),m(l=>P({ref:e},l)))})}function Xe(e,{viewport$:t},r=document.body){return Vt(e,{content$:new F(o=>{let n=e.title,i=Cn(n);return o.next(i),e.removeAttribute("title"),r.append(i),()=>{i.remove(),e.setAttribute("title",n)}}),viewport$:t},0)}function Ga(e,t){let r=H(()=>z([mn(e),Ge(t)])).pipe(m(([{x:o,y:n},i])=>{let{width:s,height:a}=de(e);return{x:o-i.x+s/2,y:n-i.y+a/2}}));return Ye(e).pipe(b(o=>r.pipe(m(n=>({active:o,offset:n})),Ee(+!o||1/0))))}function Dn(e,t,{target$:r}){let[o,n]=Array.from(e.children);return H(()=>{let i=new T,s=i.pipe(oe(),ae(!0));return i.subscribe({next({offset:a}){e.style.setProperty("--md-tooltip-x",`${a.x}px`),e.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),mt(e).pipe(W(s)).subscribe(a=>{e.toggleAttribute("data-md-visible",a)}),L(i.pipe(g(({active:a})=>a)),i.pipe(Ae(250),g(({active:a})=>!a))).subscribe({next({active:a}){a?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe($e(16,ye)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(gt(125,ye),g(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:a})=>a)).subscribe({next(a){a?e.style.setProperty("--md-tooltip-0",`${-a}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),h(n,"click").pipe(W(s),g(a=>!(a.metaKey||a.ctrlKey))).subscribe(a=>{a.stopPropagation(),a.preventDefault()}),h(n,"mousedown").pipe(W(s),te(i)).subscribe(([a,{active:c}])=>{var p;if(a.button!==0||a.metaKey||a.ctrlKey)a.preventDefault();else if(c){a.preventDefault();let l=e.parentElement.closest(".md-annotation");l instanceof HTMLElement?l.focus():(p=Ne())==null||p.blur()}}),r.pipe(W(s),g(a=>a===o),nt(125)).subscribe(()=>e.focus()),Ga(e,t).pipe(O(a=>i.next(a)),A(()=>i.complete()),m(a=>P({ref:e},a)))})}function Ja(e){let t=Te();if(e.tagName!=="CODE")return[e];let r=[".c",".c1",".cm"];if(t.annotate&&typeof t.annotate=="object"){let o=e.closest("[class|=language]");if(o)for(let n of Array.from(o.classList)){if(!n.startsWith("language-"))continue;let[,i]=n.split("-");i in t.annotate&&r.push(...t.annotate[i])}}return M(r.join(", "),e)}function Xa(e){let t=[];for(let r of Ja(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let s;for(;s=/(\(\d+\))(!)?/.exec(i.textContent);){let[,a,c]=s;if(typeof c=="undefined"){let p=i.splitText(s.index);i=p.splitText(a.length),t.push(p)}else{i.textContent=a,t.push(i);break}}}}return t}function Vn(e,t){t.append(...Array.from(e.childNodes))}function Tr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,s=new Map;for(let a of Xa(t)){let[,c]=a.textContent.match(/\((\d+)\)/);ue(`:scope > li:nth-child(${c})`,e)&&(s.set(c,kn(c,i)),a.replaceWith(s.get(c)))}return s.size===0?y:H(()=>{let a=new T,c=a.pipe(oe(),ae(!0)),p=[];for(let[l,f]of s)p.push([j(".md-typeset",f),j(`:scope > li:nth-child(${l})`,e)]);return o.pipe(W(c)).subscribe(l=>{e.hidden=!l,e.classList.toggle("md-annotation-list",l);for(let[f,u]of p)l?Vn(f,u):Vn(u,f)}),L(...[...s].map(([,l])=>Dn(l,t,{target$:r}))).pipe(A(()=>a.complete()),le())})}function Nn(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return Nn(t)}}function zn(e,t){return H(()=>{let r=Nn(e);return typeof r!="undefined"?Tr(r,e,t):y})}var Kn=$t(ao());var Za=0,qn=L(h(window,"keydown").pipe(m(()=>!0)),L(h(window,"keyup"),h(window,"contextmenu")).pipe(m(()=>!1))).pipe(Q(!1),Z(1));function Qn(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return Qn(t)}}function es(e){return Le(e).pipe(m(({width:t})=>({scrollable:At(e).width>t})),ne("scrollable"))}function Yn(e,t){let{matches:r}=matchMedia("(hover)"),o=H(()=>{let n=new T,i=n.pipe(Yr(1));n.subscribe(({scrollable:d})=>{d&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let s=[],a=e.closest("pre"),c=a.closest("[id]"),p=c?c.id:Za++;a.id=`__code_${p}`;let l=[],f=e.closest(".highlight");if(f instanceof HTMLElement){let d=Qn(f);if(typeof d!="undefined"&&(f.classList.contains("annotate")||V("content.code.annotate"))){let v=Tr(d,e,t);l.push(Le(f).pipe(W(i),m(({width:S,height:X})=>S&&X),Y(),b(S=>S?v:y)))}}let u=M(":scope > span[id]",e);if(u.length&&(e.classList.add("md-code__content"),e.closest(".select")||V("content.code.select")&&!e.closest(".no-select"))){let d=+u[0].id.split("-").pop(),v=$n();s.push(v),V("content.tooltips")&&l.push(Xe(v,{viewport$}));let S=h(v,"click").pipe(Ut(R=>!R,!1),O(()=>v.blur()),le());S.subscribe(R=>{v.classList.toggle("md-code__button--active",R)});let X=fe(u).pipe(J(R=>it(R).pipe(m(se=>[R,se]))));S.pipe(b(R=>R?X:y)).subscribe(([R,se])=>{let ce=ue(".hll.select",R);if(ce&&!se)ce.replaceWith(...Array.from(ce.childNodes));else if(!ce&&se){let he=document.createElement("span");he.className="hll select",he.append(...Array.from(R.childNodes).slice(1)),R.append(he)}});let re=fe(u).pipe(J(R=>h(R,"mousedown").pipe(O(se=>se.preventDefault()),m(()=>R)))),ee=S.pipe(b(R=>R?re:y),te(qn),m(([R,se])=>{var he;let ce=u.indexOf(R)+d;if(se===!1)return[ce,ce];{let Se=M(".hll",e).map(Ue=>u.indexOf(Ue.parentElement)+d);return(he=window.getSelection())==null||he.removeAllRanges(),[Math.min(ce,...Se),Math.max(ce,...Se)]}})),k=Zr(y).pipe(g(R=>R.startsWith(`__codelineno-${p}-`)));k.subscribe(R=>{let[,,se]=R.split("-"),ce=se.split(":").map(Se=>+Se-d+1);ce.length===1&&ce.push(ce[0]);for(let Se of M(".hll:not(.select)",e))Se.replaceWith(...Array.from(Se.childNodes));let he=u.slice(ce[0]-1,ce[1]);for(let Se of he){let Ue=document.createElement("span");Ue.className="hll",Ue.append(...Array.from(Se.childNodes).slice(1)),Se.append(Ue)}}),k.pipe(Ee(1),xe(pe)).subscribe(R=>{if(R.includes(":")){let se=document.getElementById(R.split(":")[0]);se&&setTimeout(()=>{let ce=se,he=-64;for(;ce!==document.body;)he+=ce.offsetTop,ce=ce.offsetParent;window.scrollTo({top:he})},1)}});let je=fe(M('a[href^="#__codelineno"]',f)).pipe(J(R=>h(R,"click").pipe(O(se=>se.preventDefault()),m(()=>R)))).pipe(W(i),te(qn),m(([R,se])=>{let he=+j(`[id="${R.hash.slice(1)}"]`).parentElement.id.split("-").pop();if(se===!1)return[he,he];{let Se=M(".hll",e).map(Ue=>+Ue.parentElement.id.split("-").pop());return[Math.min(he,...Se),Math.max(he,...Se)]}}));L(ee,je).subscribe(R=>{let se=`#__codelineno-${p}-`;R[0]===R[1]?se+=R[0]:se+=`${R[0]}:${R[1]}`,history.replaceState({},"",se),window.dispatchEvent(new HashChangeEvent("hashchange",{newURL:window.location.origin+window.location.pathname+se,oldURL:window.location.href}))})}if(Kn.default.isSupported()&&(e.closest(".copy")||V("content.code.copy")&&!e.closest(".no-copy"))){let d=Hn(a.id);s.push(d),V("content.tooltips")&&l.push(Xe(d,{viewport$}))}if(s.length){let d=Pn();d.append(...s),a.insertBefore(d,e)}return es(e).pipe(O(d=>n.next(d)),A(()=>n.complete()),m(d=>P({ref:e},d)),Ve(L(...l).pipe(W(i))))});return V("content.lazy")?mt(e).pipe(g(n=>n),Ee(1),b(()=>o)):o}function ts(e,{target$:t,print$:r}){let o=!0;return L(t.pipe(m(n=>n.closest("details:not([open])")),g(n=>e===n),m(()=>({action:"open",reveal:!0}))),r.pipe(g(n=>n||!o),O(()=>o=e.open),m(n=>({action:n?"open":"close"}))))}function Bn(e,t){return H(()=>{let r=new T;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),ts(e,t).pipe(O(o=>r.next(o)),A(()=>r.complete()),m(o=>P({ref:e},o)))})}var Gn=0;function rs(e){let t=document.createElement("h3");t.innerHTML=e.innerHTML;let r=[t],o=e.nextElementSibling;for(;o&&!(o instanceof HTMLHeadingElement);)r.push(o),o=o.nextElementSibling;return r}function os(e,t){for(let r of M("[href], [src]",e))for(let o of["href","src"]){let n=r.getAttribute(o);if(n&&!/^(?:[a-z]+:)?\/\//i.test(n)){r[o]=new URL(r.getAttribute(o),t).toString();break}}for(let r of M("[name^=__], [for]",e))for(let o of["id","for","name"]){let n=r.getAttribute(o);n&&r.setAttribute(o,`${n}$preview_${Gn}`)}return Gn++,$(e)}function Jn(e,t){let{sitemap$:r}=t;if(!(e instanceof HTMLAnchorElement))return y;if(!(V("navigation.instant.preview")||e.hasAttribute("data-preview")))return y;e.removeAttribute("title");let o=z([Ye(e),it(e)]).pipe(m(([i,s])=>i||s),Y(),g(i=>i));return rt([r,o]).pipe(b(([i])=>{let s=new URL(e.href);return s.search=s.hash="",i.has(`${s}`)?$(s):y}),b(i=>xr(i).pipe(b(s=>os(s,i)))),b(i=>{let s=e.hash?`article [id="${e.hash.slice(1)}"]`:"article h1",a=ue(s,i);return typeof a=="undefined"?y:$(rs(a))})).pipe(b(i=>{let s=new F(a=>{let c=wr(...i);return a.next(c),document.body.append(c),()=>c.remove()});return Vt(e,P({content$:s},t))}))}var Xn=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.flowchartTitleText{fill:var(--md-mermaid-label-fg-color)}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel p,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel p{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color)}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}.classDiagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs marker.marker.composition.class path,defs marker.marker.dependency.class path,defs marker.marker.extension.class path{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs marker.marker.aggregation.class path{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}.statediagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}a .nodeLabel{text-decoration:underline}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}[id^=entity] path,[id^=entity] rect{fill:var(--md-default-bg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs .marker.oneOrMore.er *,defs .marker.onlyOne.er *,defs .marker.zeroOrMore.er *,defs .marker.zeroOrOne.er *{stroke:var(--md-mermaid-edge-color)!important}text:not([class]):last-child{fill:var(--md-mermaid-label-fg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var so,is=0;function as(){return typeof mermaid=="undefined"||mermaid instanceof Element?_t("https://unpkg.com/mermaid@11/dist/mermaid.min.js"):$(void 0)}function Zn(e){return e.classList.remove("mermaid"),so||(so=as().pipe(O(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Xn,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),m(()=>{}),Z(1))),so.subscribe(()=>go(null,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${is++}`,r=x("div",{class:"mermaid"}),o=e.textContent,{svg:n,fn:i}=yield mermaid.render(t,o),s=r.attachShadow({mode:"closed"});s.innerHTML=n,e.replaceWith(r),i==null||i(s)})),so.pipe(m(()=>({ref:e})))}var ei=x("table");function ti(e){return e.replaceWith(ei),ei.replaceWith(Un(e)),$({ref:e})}function ss(e){let t=e.find(r=>r.checked)||e[0];return L(...e.map(r=>h(r,"change").pipe(m(()=>j(`label[for="${r.id}"]`))))).pipe(Q(j(`label[for="${t.id}"]`)),m(r=>({active:r})))}function ri(e,{viewport$:t,target$:r}){let o=j(".tabbed-labels",e),n=M(":scope > input",e),i=no("prev");e.append(i);let s=no("next");return e.append(s),H(()=>{let a=new T,c=a.pipe(oe(),ae(!0));z([a,Le(e),mt(e)]).pipe(W(c),$e(1,ye)).subscribe({next([{active:p},l]){let f=Be(p),{width:u}=de(p);e.style.setProperty("--md-indicator-x",`${f.x}px`),e.style.setProperty("--md-indicator-width",`${u}px`);let d=gr(o);(f.xd.x+l.width)&&o.scrollTo({left:Math.max(0,f.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),z([Ge(o),Le(o)]).pipe(W(c)).subscribe(([p,l])=>{let f=At(o);i.hidden=p.x<16,s.hidden=p.x>f.width-l.width-16}),L(h(i,"click").pipe(m(()=>-1)),h(s,"click").pipe(m(()=>1))).pipe(W(c)).subscribe(p=>{let{width:l}=de(o);o.scrollBy({left:l*p,behavior:"smooth"})}),r.pipe(W(c),g(p=>n.includes(p))).subscribe(p=>p.click()),o.classList.add("tabbed-labels--linked");for(let p of n){let l=j(`label[for="${p.id}"]`);l.replaceChildren(x("a",{href:`#${l.htmlFor}`,tabIndex:-1},...Array.from(l.childNodes))),h(l.firstElementChild,"click").pipe(W(c),g(f=>!(f.metaKey||f.ctrlKey)),O(f=>{f.preventDefault(),f.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${l.htmlFor}`),l.click()})}return V("content.tabs.link")&&a.pipe(Ie(1),te(t)).subscribe(([{active:p},{offset:l}])=>{let f=p.innerText.trim();if(p.hasAttribute("data-md-switching"))p.removeAttribute("data-md-switching");else{let u=e.offsetTop-l.y;for(let v of M("[data-tabs]"))for(let S of M(":scope > input",v)){let X=j(`label[for="${S.id}"]`);if(X!==p&&X.innerText.trim()===f){X.setAttribute("data-md-switching",""),S.click();break}}window.scrollTo({top:e.offsetTop-u});let d=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([f,...d])])}}),a.pipe(W(c)).subscribe(()=>{for(let p of M("audio, video",e))p.offsetWidth&&p.autoplay?p.play().catch(()=>{}):p.pause()}),ss(n).pipe(O(p=>a.next(p)),A(()=>a.complete()),m(p=>P({ref:e},p)))}).pipe(et(pe))}function oi(e,t){let{viewport$:r,target$:o,print$:n}=t;return L(...M(".annotate:not(.highlight)",e).map(i=>zn(i,{target$:o,print$:n})),...M("pre:not(.mermaid) > code",e).map(i=>Yn(i,{target$:o,print$:n})),...M("a",e).map(i=>Jn(i,t)),...M("pre.mermaid",e).map(i=>Zn(i)),...M("table:not([class])",e).map(i=>ti(i)),...M("details",e).map(i=>Bn(i,{target$:o,print$:n})),...M("[data-tabs]",e).map(i=>ri(i,{viewport$:r,target$:o})),...M("[title]:not([data-preview])",e).filter(()=>V("content.tooltips")).map(i=>Xe(i,{viewport$:r})),...M(".footnote-ref",e).filter(()=>V("content.footnote.tooltips")).map(i=>Vt(i,{content$:new F(s=>{let a=new URL(i.href).hash.slice(1),c=Array.from(document.getElementById(a).cloneNode(!0).children),p=wr(...c);return s.next(p),document.body.append(p),()=>p.remove()}),viewport$:r})))}function cs(e,{alert$:t}){return t.pipe(b(r=>L($(!0),$(!1).pipe(nt(2e3))).pipe(m(o=>({message:r,active:o})))))}function ni(e,t){let r=j(".md-typeset",e);return H(()=>{let o=new T;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),cs(e,t).pipe(O(n=>o.next(n)),A(()=>o.complete()),m(n=>P({ref:e},n)))})}var ps=0;function ls(e,t){document.body.append(e);let{width:r}=de(e);e.style.setProperty("--md-tooltip-width",`${r}px`),e.remove();let o=vr(t),n=typeof o!="undefined"?Ge(o):$({x:0,y:0}),i=L(Ye(t),it(t)).pipe(Y());return z([i,n]).pipe(m(([s,a])=>{let{x:c,y:p}=Be(t),l=de(t),f=t.closest("table");return f&&t.parentElement&&(c+=f.offsetLeft+t.parentElement.offsetLeft,p+=f.offsetTop+t.parentElement.offsetTop),{active:s,offset:{x:c-a.x+l.width/2-r/2,y:p-a.y+l.height+8}}}))}function ii(e){let t=e.title;if(!t.length)return y;let r=`__tooltip_${ps++}`,o=Dt(r,"inline"),n=j(".md-typeset",o);return n.innerHTML=t,H(()=>{let i=new T;return i.subscribe({next({offset:s}){o.style.setProperty("--md-tooltip-x",`${s.x}px`),o.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){o.style.removeProperty("--md-tooltip-x"),o.style.removeProperty("--md-tooltip-y")}}),L(i.pipe(g(({active:s})=>s)),i.pipe(Ae(250),g(({active:s})=>!s))).subscribe({next({active:s}){s?(e.insertAdjacentElement("afterend",o),e.setAttribute("aria-describedby",r),e.removeAttribute("title")):(o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t))},complete(){o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t)}}),i.pipe($e(16,ye)).subscribe(({active:s})=>{o.classList.toggle("md-tooltip--active",s)}),i.pipe(gt(125,ye),g(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:s})=>s)).subscribe({next(s){s?o.style.setProperty("--md-tooltip-0",`${-s}px`):o.style.removeProperty("--md-tooltip-0")},complete(){o.style.removeProperty("--md-tooltip-0")}}),ls(o,e).pipe(O(s=>i.next(s)),A(()=>i.complete()),m(s=>P({ref:e},s)))}).pipe(et(pe))}function ms({viewport$:e}){if(!V("header.autohide"))return $(!1);let t=e.pipe(m(({offset:{y:n}})=>n),ot(2,1),m(([n,i])=>[nMath.abs(i-n.y)>100),m(([,[n]])=>n),Y()),o=Je("search");return z([e,o]).pipe(m(([{offset:n},i])=>n.y>400&&!i),Y(),b(n=>n?r:$(!1)),Q(!1))}function ai(e,t){return H(()=>z([Le(e),ms(t)])).pipe(m(([{height:r},o])=>({height:r,hidden:o})),Y((r,o)=>r.height===o.height&&r.hidden===o.hidden),Z(1))}function si(e,{header$:t,main$:r}){return H(()=>{let o=new T,n=o.pipe(oe(),ae(!0));o.pipe(ne("active"),Pe(t)).subscribe(([{active:s},{hidden:a}])=>{e.classList.toggle("md-header--shadow",s&&!a),e.hidden=a});let i=fe(M("[title]",e)).pipe(g(()=>V("content.tooltips")),J(s=>ii(s)));return r.subscribe(o),t.pipe(W(n),m(s=>P({ref:e},s)),Ve(i.pipe(W(n))))})}function fs(e,{viewport$:t,header$:r}){return Er(e,{viewport$:t,header$:r}).pipe(m(({offset:{y:o}})=>{let{height:n}=de(e);return{active:n>0&&o>=n}}),ne("active"))}function ci(e,t){return H(()=>{let r=new T;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=ue(".md-content h1");return typeof o=="undefined"?y:fs(o,t).pipe(O(n=>r.next(n)),A(()=>r.complete()),m(n=>P({ref:e},n)))})}function pi(e,{viewport$:t,header$:r}){let o=r.pipe(m(({height:i})=>i),Y()),n=o.pipe(b(()=>Le(e).pipe(m(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),ne("bottom"))));return z([o,n,t]).pipe(m(([i,{top:s,bottom:a},{offset:{y:c},size:{height:p}}])=>(p=Math.max(0,p-Math.max(0,s-c,i)-Math.max(0,p+c-a)),{offset:s-i,height:p,active:s-i<=c})),Y((i,s)=>i.offset===s.offset&&i.height===s.height&&i.active===s.active))}function us(e){let t=__md_get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return $(...e).pipe(J(o=>h(o,"change").pipe(m(()=>o))),Q(e[r]),m(o=>({index:e.indexOf(o),color:{media:o.getAttribute("data-md-color-media"),scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),Z(1))}function li(e){let t=M("input",e),r=x("meta",{name:"theme-color"});document.head.appendChild(r);let o=x("meta",{name:"color-scheme"});document.head.appendChild(o);let n=Wt("(prefers-color-scheme: light)");return H(()=>{let i=new T;return i.subscribe(s=>{if(document.body.setAttribute("data-md-color-switching",""),s.color.media==="(prefers-color-scheme)"){let a=matchMedia("(prefers-color-scheme: light)"),c=document.querySelector(a.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");s.color.scheme=c.getAttribute("data-md-color-scheme"),s.color.primary=c.getAttribute("data-md-color-primary"),s.color.accent=c.getAttribute("data-md-color-accent")}for(let[a,c]of Object.entries(s.color))document.body.setAttribute(`data-md-color-${a}`,c);for(let a=0;as.key==="Enter"),te(i,(s,a)=>a)).subscribe(({index:s})=>{s=(s+1)%t.length,t[s].click(),t[s].focus()}),i.pipe(m(()=>{let s=Ce("header"),a=window.getComputedStyle(s);return o.content=a.colorScheme,a.backgroundColor.match(/\d+/g).map(c=>(+c).toString(16).padStart(2,"0")).join("")})).subscribe(s=>r.content=`#${s}`),i.pipe(xe(pe)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),us(t).pipe(W(n.pipe(Ie(1))),vt(),O(s=>i.next(s)),A(()=>i.complete()),m(s=>P({ref:e},s)))})}function mi(e,{progress$:t}){return H(()=>{let r=new T;return r.subscribe(({value:o})=>{e.style.setProperty("--md-progress-value",`${o}`)}),t.pipe(O(o=>r.next({value:o})),A(()=>r.complete()),m(o=>({ref:e,value:o})))})}function fi(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,e}function ds(e,t){let r=new Map;for(let o of M("url",e)){let n=j("loc",o),i=[fi(new URL(n.textContent),t)];r.set(`${i[0]}`,i);for(let s of M("[rel=alternate]",o)){let a=s.getAttribute("href");a!=null&&i.push(fi(new URL(a),t))}}return r}function kt(e){return En(new URL("sitemap.xml",e)).pipe(m(t=>ds(t,new URL(e))),ve(()=>$(new Map)),le())}function ui({document$:e}){let t=new Map;e.pipe(b(()=>M("link[rel=alternate]")),m(r=>new URL(r.href)),g(r=>!t.has(r.toString())),J(r=>kt(r).pipe(m(o=>[r,o]),ve(()=>y)))).subscribe(([r,o])=>{t.set(r.toString().replace(/\/$/,""),o)}),h(document.body,"click").pipe(g(r=>!r.metaKey&&!r.ctrlKey),b(r=>{if(r.target instanceof Element){let o=r.target.closest("a");if(o&&!o.target){let n=[...t].find(([f])=>o.href.startsWith(`${f}/`));if(typeof n=="undefined")return y;let[i,s]=n,a=we();if(a.href.startsWith(i))return y;let c=Te(),p=a.href.replace(c.base,"");p=`${i}/${p}`;let l=s.has(p.split("#")[0])?new URL(p,c.base):new URL(i);return r.preventDefault(),$(l)}}return y})).subscribe(r=>st(r,!0))}var co=$t(ao());function hs(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function di({alert$:e}){co.default.isSupported()&&new F(t=>{new co.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||hs(j(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(O(t=>{t.trigger.focus()}),m(()=>Me("clipboard.copied"))).subscribe(e)}function hi(e,t){if(!(e.target instanceof Element))return y;let r=e.target.closest("a");if(r===null)return y;if(r.target||e.metaKey||e.ctrlKey)return y;let o=new URL(r.href);return o.search=o.hash="",t.has(`${o}`)?(e.preventDefault(),$(r)):y}function bi(e){let t=new Map;for(let r of M(":scope > *",e.head))t.set(r.outerHTML,r);return t}function vi(e){for(let t of M("[href], [src]",e))for(let r of["href","src"]){let o=t.getAttribute(r);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){t[r]=t[r];break}}return $(e)}function bs(e){for(let o of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...V("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let n=ue(o),i=ue(o,e);typeof n!="undefined"&&typeof i!="undefined"&&n.replaceWith(i)}let t=bi(document);for(let[o,n]of bi(e))t.has(o)?t.delete(o):document.head.appendChild(n);for(let o of t.values()){let n=o.getAttribute("name");n!=="theme-color"&&n!=="color-scheme"&&o.remove()}let r=Ce("container");return Ke(M("script",r)).pipe(b(o=>{let n=e.createElement("script");if(o.src){for(let i of o.getAttributeNames())n.setAttribute(i,o.getAttribute(i));return o.replaceWith(n),new F(i=>{n.onload=()=>i.complete()})}else return n.textContent=o.textContent,o.replaceWith(n),y}),oe(),ae(document))}function gi({sitemap$:e,location$:t,viewport$:r,progress$:o}){if(location.protocol==="file:")return y;$(document).subscribe(vi);let n=h(document.body,"click").pipe(Pe(e),b(([a,c])=>hi(a,c)),m(({href:a})=>new URL(a)),le()),i=h(window,"popstate").pipe(m(we),le());n.pipe(te(r)).subscribe(([a,{offset:c}])=>{history.replaceState(c,""),history.pushState(null,"",a)}),L(n,i).subscribe(t);let s=t.pipe(ne("pathname"),b(a=>xr(a,{progress$:o}).pipe(ve(()=>(st(a,!0),y)))),b(vi),b(bs),le());return L(s.pipe(te(t,(a,c)=>c)),s.pipe(b(()=>t),ne("hash")),t.pipe(Y((a,c)=>a.pathname===c.pathname&&a.hash===c.hash),b(()=>n),O(()=>history.back()))).subscribe(a=>{var c,p;history.state!==null||!a.hash?window.scrollTo(0,(p=(c=history.state)==null?void 0:c.y)!=null?p:0):(history.scrollRestoration="auto",gn(a.hash),history.scrollRestoration="manual")}),t.subscribe(()=>{history.scrollRestoration="manual"}),h(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),r.pipe(ne("offset"),Ae(100)).subscribe(({offset:a})=>{history.replaceState(a,"")}),V("navigation.instant.prefetch")&&L(h(document.body,"mousemove"),h(document.body,"focusin")).pipe(Pe(e),b(([a,c])=>hi(a,c)),Ae(25),Qr(({href:a})=>a),hr(a=>{let c=document.createElement("link");return c.rel="prefetch",c.href=a.toString(),document.head.appendChild(c),h(c,"load").pipe(m(()=>c),Ee(1))})).subscribe(a=>a.remove()),s}var yi=$t(ro());function xi(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,s)=>`${i}${s}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").replace(/&/g,"&").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return s=>(0,yi.default)(s).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function zt(e){return e.type===1}function Sr(e){return e.type===3}function Ei(e,t){let r=Mn(e);return L($(location.protocol!=="file:"),Je("search")).pipe(Re(o=>o),b(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:V("search.suggest")}}})),r}function wi(e){var l;let{selectedVersionSitemap:t,selectedVersionBaseURL:r,currentLocation:o,currentBaseURL:n}=e,i=(l=po(n))==null?void 0:l.pathname;if(i===void 0)return;let s=ys(o.pathname,i);if(s===void 0)return;let a=Es(t.keys());if(!t.has(a))return;let c=po(s,a);if(!c||!t.has(c.href))return;let p=po(s,r);if(p)return p.hash=o.hash,p.search=o.search,p}function po(e,t){try{return new URL(e,t)}catch(r){return}}function ys(e,t){if(e.startsWith(t))return e.slice(t.length)}function xs(e,t){let r=Math.min(e.length,t.length),o;for(o=0;oy)),o=r.pipe(m(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:s,aliases:a})=>s===i||a.includes(i))||n[0]}));r.pipe(m(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),b(n=>h(document.body,"click").pipe(g(i=>!i.metaKey&&!i.ctrlKey),te(o),b(([i,s])=>{if(i.target instanceof Element){let a=i.target.closest("a");if(a&&!a.target&&n.has(a.href)){let c=a.href;return!i.target.closest(".md-version")&&n.get(c)===s?y:(i.preventDefault(),$(new URL(c)))}}return y}),b(i=>kt(i).pipe(m(s=>{var a;return(a=wi({selectedVersionSitemap:s,selectedVersionBaseURL:i,currentLocation:we(),currentBaseURL:t.base}))!=null?a:i})))))).subscribe(n=>st(n,!0)),z([r,o]).subscribe(([n,i])=>{j(".md-header__topic").appendChild(Wn(n,i))}),e.pipe(b(()=>o)).subscribe(n=>{var a;let i=new URL(t.base),s=__md_get("__outdated",sessionStorage,i);if(s===null){s=!0;let c=((a=t.version)==null?void 0:a.default)||"latest";Array.isArray(c)||(c=[c]);e:for(let p of c)for(let l of n.aliases.concat(n.version))if(new RegExp(p,"i").test(l)){s=!1;break e}__md_set("__outdated",s,sessionStorage,i)}if(s)for(let c of me("outdated"))c.hidden=!1})}function ws(e,{worker$:t}){let{searchParams:r}=we();r.has("q")&&(at("search",!0),e.value=r.get("q"),e.focus(),Je("search").pipe(Re(i=>!i)).subscribe(()=>{let i=we();i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=Ye(e),n=L(t.pipe(Re(zt)),h(e,"keyup"),o).pipe(m(()=>e.value),Y());return z([n,o]).pipe(m(([i,s])=>({value:i,focus:s})),Z(1))}function Si(e,{worker$:t}){let r=new T,o=r.pipe(oe(),ae(!0));z([t.pipe(Re(zt)),r],(i,s)=>s).pipe(ne("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(ne("focus")).subscribe(({focus:i})=>{i&&at("search",i)}),h(e.form,"reset").pipe(W(o)).subscribe(()=>e.focus());let n=j("header [for=__search]");return h(n,"click").subscribe(()=>e.focus()),ws(e,{worker$:t}).pipe(O(i=>r.next(i)),A(()=>r.complete()),m(i=>P({ref:e},i)),Z(1))}function Oi(e,{worker$:t,query$:r}){let o=new T,n=un(e.parentElement).pipe(g(Boolean)),i=e.parentElement,s=j(":scope > :first-child",e),a=j(":scope > :last-child",e);Je("search").subscribe(l=>{a.setAttribute("role",l?"list":"presentation"),a.hidden=!l}),o.pipe(te(r),Gr(t.pipe(Re(zt)))).subscribe(([{items:l},{value:f}])=>{switch(l.length){case 0:s.textContent=f.length?Me("search.result.none"):Me("search.result.placeholder");break;case 1:s.textContent=Me("search.result.one");break;default:let u=br(l.length);s.textContent=Me("search.result.other",u)}});let c=o.pipe(O(()=>a.innerHTML=""),b(({items:l})=>L($(...l.slice(0,10)),$(...l.slice(10)).pipe(ot(4),Xr(n),b(([f])=>f)))),m(Fn),le());return c.subscribe(l=>a.appendChild(l)),c.pipe(J(l=>{let f=ue("details",l);return typeof f=="undefined"?y:h(f,"toggle").pipe(W(o),m(()=>f))})).subscribe(l=>{l.open===!1&&l.offsetTop<=i.scrollTop&&i.scrollTo({top:l.offsetTop})}),t.pipe(g(Sr),m(({data:l})=>l)).pipe(O(l=>o.next(l)),A(()=>o.complete()),m(l=>P({ref:e},l)))}function Ts(e,{query$:t}){return t.pipe(m(({value:r})=>{let o=we();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function Li(e,t){let r=new T,o=r.pipe(oe(),ae(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),h(e,"click").pipe(W(o)).subscribe(n=>n.preventDefault()),Ts(e,t).pipe(O(n=>r.next(n)),A(()=>r.complete()),m(n=>P({ref:e},n)))}function Mi(e,{worker$:t,keyboard$:r}){let o=new T,n=Ce("search-query"),i=L(h(n,"keydown"),h(n,"focus")).pipe(xe(pe),m(()=>n.value),Y());return o.pipe(Pe(i),m(([{suggest:a},c])=>{let p=c.split(/([\s-]+)/);if(a!=null&&a.length&&p[p.length-1]){let l=a[a.length-1];l.startsWith(p[p.length-1])&&(p[p.length-1]=l)}else p.length=0;return p})).subscribe(a=>e.innerHTML=a.join("").replace(/\s/g," ")),r.pipe(g(({mode:a})=>a==="search")).subscribe(a=>{a.type==="ArrowRight"&&e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText)}),t.pipe(g(Sr),m(({data:a})=>a)).pipe(O(a=>o.next(a)),A(()=>o.complete()),m(()=>({ref:e})))}function _i(e,{index$:t,keyboard$:r}){let o=Te();try{let n=Ei(o.search,t),i=Ce("search-query",e),s=Ce("search-result",e);h(e,"click").pipe(g(({target:c})=>c instanceof Element&&!!c.closest("a"))).subscribe(()=>at("search",!1)),r.pipe(g(({mode:c})=>c==="search")).subscribe(c=>{let p=Ne();switch(c.type){case"Enter":if(p===i){let l=new Map;for(let f of M(":first-child [href]",s)){let u=f.firstElementChild;l.set(f,parseFloat(u.getAttribute("data-md-score")))}if(l.size){let[[f]]=[...l].sort(([,u],[,d])=>d-u);f.click()}c.claim()}break;case"Escape":case"Tab":at("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof p=="undefined")i.focus();else{let l=[i,...M(":not(details) > [href], summary, details[open] [href]",s)],f=Math.max(0,(Math.max(0,l.indexOf(p))+l.length+(c.type==="ArrowUp"?-1:1))%l.length);l[f].focus()}c.claim();break;default:i!==Ne()&&i.focus()}}),r.pipe(g(({mode:c})=>c==="global")).subscribe(c=>{switch(c.type){case"f":case"s":case"/":i.focus(),i.select(),c.claim();break}});let a=Si(i,{worker$:n});return L(a,Oi(s,{worker$:n,query$:a})).pipe(Ve(...me("search-share",e).map(c=>Li(c,{query$:a})),...me("search-suggest",e).map(c=>Mi(c,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,tt}}function Ai(e,{index$:t,location$:r}){return z([t,r.pipe(Q(we()),g(o=>!!o.searchParams.get("h")))]).pipe(m(([o,n])=>xi(o.config)(n.searchParams.get("h"))),m(o=>{var s;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let a=i.nextNode();a;a=i.nextNode())if((s=a.parentElement)!=null&&s.offsetHeight){let c=a.textContent,p=o(c);p.length>c.length&&n.set(a,p)}for(let[a,c]of n){let{childNodes:p}=x("span",null,c);a.replaceWith(...Array.from(p))}return{ref:e,nodes:n}}))}function Ss(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return z([r,t]).pipe(m(([{offset:i,height:s},{offset:{y:a}}])=>(s=s+Math.min(n,Math.max(0,a-i))-n,{height:s,locked:a>=i+n})),Y((i,s)=>i.height===s.height&&i.locked===s.locked))}function lo(e,o){var n=o,{header$:t}=n,r=vo(n,["header$"]);let i=j(".md-sidebar__scrollwrap",e),{y:s}=Be(i);return H(()=>{let a=new T,c=a.pipe(oe(),ae(!0)),p=a.pipe($e(0,ye));return p.pipe(te(t)).subscribe({next([{height:l},{height:f}]){i.style.height=`${l-2*s}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),p.pipe(Re()).subscribe(()=>{for(let l of M(".md-nav__link--active[href]",e)){if(!l.clientHeight)continue;let f=l.closest(".md-sidebar__scrollwrap");if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=de(f);f.scrollTo({top:u-d/2})}}}),fe(M("label[tabindex]",e)).pipe(J(l=>h(l,"click").pipe(xe(pe),m(()=>l),W(c)))).subscribe(l=>{let f=j(`[id="${l.htmlFor}"]`);j(`[aria-labelledby="${l.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),V("content.tooltips")&&fe(M("abbr[title]",e)).pipe(J(l=>Xe(l,{viewport$})),W(c)).subscribe(),Ss(e,r).pipe(O(l=>a.next(l)),A(()=>a.complete()),m(l=>P({ref:e},l)))})}function Ci(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return rt(ze(`${r}/releases/latest`).pipe(ve(()=>y),m(o=>({version:o.tag_name})),Qe({})),ze(r).pipe(ve(()=>y),m(o=>({stars:o.stargazers_count,forks:o.forks_count})),Qe({}))).pipe(m(([o,n])=>P(P({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return ze(r).pipe(m(o=>({repositories:o.public_repos})),Qe({}))}}function ki(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return rt(ze(`${r}/releases/permalink/latest`).pipe(ve(()=>y),m(({tag_name:o})=>({version:o})),Qe({})),ze(r).pipe(ve(()=>y),m(({star_count:o,forks_count:n})=>({stars:o,forks:n})),Qe({}))).pipe(m(([o,n])=>P(P({},o),n)))}function Hi(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return Ci(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return ki(r,o)}return y}var Os;function Ls(e){return Os||(Os=H(()=>{let t=__md_get("__source",sessionStorage);if(t)return $(t);if(me("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return y}return Hi(e.href).pipe(O(o=>__md_set("__source",o,sessionStorage)))}).pipe(ve(()=>y),g(t=>Object.keys(t).length>0),m(t=>({facts:t})),Z(1)))}function $i(e){let t=j(":scope > :last-child",e);return H(()=>{let r=new T;return r.subscribe(({facts:o})=>{t.appendChild(jn(o)),t.classList.add("md-source__repository--active")}),Ls(e).pipe(O(o=>r.next(o)),A(()=>r.complete()),m(o=>P({ref:e},o)))})}function Ms(e,{viewport$:t,header$:r}){return Le(document.body).pipe(b(()=>Er(e,{header$:r,viewport$:t})),m(({offset:{y:o}})=>({hidden:o>=10})),ne("hidden"))}function Pi(e,t){return H(()=>{let r=new T;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(V("navigation.tabs.sticky")?$({hidden:!1}):Ms(e,t)).pipe(O(o=>r.next(o)),A(()=>r.complete()),m(o=>P({ref:e},o)))})}function _s(e,{viewport$:t,header$:r}){let o=new Map,n=M(".md-nav__link",e);for(let a of n){let c=decodeURIComponent(a.hash.substring(1)),p=ue(`[id="${c}"]`);typeof p!="undefined"&&o.set(a,p)}let i=r.pipe(ne("height"),m(({height:a})=>{let c=Ce("main"),p=j(":scope > :first-child",c);return a+.8*(p.offsetTop-c.offsetTop)}),le());return Le(document.body).pipe(ne("height"),b(a=>H(()=>{let c=[];return $([...o].reduce((p,[l,f])=>{for(;c.length&&o.get(c[c.length-1]).tagName>=f.tagName;)c.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let d=f.offsetParent;for(;d;d=d.offsetParent)u+=d.offsetTop;return p.set([...c=[...c,l]].reverse(),u)},new Map))}).pipe(m(c=>new Map([...c].sort(([,p],[,l])=>p-l))),Pe(i),b(([c,p])=>t.pipe(Ut(([l,f],{offset:{y:u},size:d})=>{let v=u+d.height>=Math.floor(a.height);for(;f.length;){let[,S]=f[0];if(S-p=u&&!v)f=[l.pop(),...f];else break}return[l,f]},[[],[...c]]),Y((l,f)=>l[0]===f[0]&&l[1]===f[1])))))).pipe(m(([a,c])=>({prev:a.map(([p])=>p),next:c.map(([p])=>p)})),Q({prev:[],next:[]}),ot(2,1),m(([a,c])=>a.prev.length{let i=new T,s=i.pipe(oe(),ae(!0));if(i.subscribe(({prev:a,next:c})=>{for(let[p]of c)p.classList.remove("md-nav__link--passed"),p.classList.remove("md-nav__link--active");for(let[p,[l]]of a.entries())l.classList.add("md-nav__link--passed"),l.classList.toggle("md-nav__link--active",p===a.length-1)}),V("toc.follow")){let a=L(t.pipe(Ae(1),m(()=>{})),t.pipe(Ae(250),m(()=>"smooth")));i.pipe(g(({prev:c})=>c.length>0),Pe(o.pipe(xe(pe))),te(a)).subscribe(([[{prev:c}],p])=>{let[l]=c[c.length-1];if(l.offsetHeight){let f=vr(l);if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=de(f);f.scrollTo({top:u-d/2,behavior:p})}}})}return V("navigation.tracking")&&t.pipe(W(s),ne("offset"),Ae(250),Ie(1),W(n.pipe(Ie(1))),vt({delay:250}),te(i)).subscribe(([,{prev:a}])=>{let c=we(),p=a[a.length-1];if(p&&p.length){let[l]=p,{hash:f}=new URL(l.href);c.hash!==f&&(c.hash=f,history.replaceState({},"",`${c}`))}else c.hash="",history.replaceState({},"",`${c}`)}),_s(e,{viewport$:t,header$:r}).pipe(O(a=>i.next(a)),A(()=>i.complete()),m(a=>P({ref:e},a)))})}function As(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(m(({offset:{y:s}})=>s),ot(2,1),m(([s,a])=>s>a&&a>0),Y()),i=r.pipe(m(({active:s})=>s));return z([i,n]).pipe(m(([s,a])=>!(s&&a)),Y(),W(o.pipe(Ie(1))),ae(!0),vt({delay:250}),m(s=>({hidden:s})))}function Ii(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new T,s=i.pipe(oe(),ae(!0));return i.subscribe({next({hidden:a}){e.hidden=a,a?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(W(s),ne("height")).subscribe(({height:a})=>{e.style.top=`${a+16}px`}),h(e,"click").subscribe(a=>{a.preventDefault(),window.scrollTo({top:0})}),As(e,{viewport$:t,main$:o,target$:n}).pipe(O(a=>i.next(a)),A(()=>i.complete()),m(a=>P({ref:e},a)))}function Fi({document$:e,viewport$:t}){e.pipe(b(()=>M(".md-ellipsis")),J(r=>mt(r).pipe(W(e.pipe(Ie(1))),g(o=>o),m(()=>r),Ee(1))),g(r=>r.offsetWidth{let o=r.innerText,n=r.closest("a")||r;return n.title=o,V("content.tooltips")?Xe(n,{viewport$:t}).pipe(W(e.pipe(Ie(1))),A(()=>n.removeAttribute("title"))):y})).subscribe(),V("content.tooltips")&&e.pipe(b(()=>M(".md-status")),J(r=>Xe(r,{viewport$:t}))).subscribe()}function ji({document$:e,tablet$:t}){e.pipe(b(()=>M(".md-toggle--indeterminate")),O(r=>{r.indeterminate=!0,r.checked=!1}),J(r=>h(r,"change").pipe(Jr(()=>r.classList.contains("md-toggle--indeterminate")),m(()=>r))),te(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function Cs(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function Ui({document$:e}){e.pipe(b(()=>M("[data-md-scrollfix]")),O(t=>t.removeAttribute("data-md-scrollfix")),g(Cs),J(t=>h(t,"touchstart").pipe(m(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function Wi({viewport$:e,tablet$:t}){z([Je("search"),t]).pipe(m(([r,o])=>r&&!o),b(r=>$(r).pipe(nt(r?400:100))),te(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function ks(){return location.protocol==="file:"?_t(`${new URL("search/search_index.js",Or.base)}`).pipe(m(()=>__index),Z(1)):ze(new URL("search/search_index.json",Or.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var ct=an(),Kt=bn(),Ht=yn(Kt),mo=hn(),ke=Ln(),Lr=Wt("(min-width: 60em)"),Vi=Wt("(min-width: 76.25em)"),Ni=xn(),Or=Te(),zi=document.forms.namedItem("search")?ks():tt,fo=new T;di({alert$:fo});ui({document$:ct});var uo=new T,qi=kt(Or.base);V("navigation.instant")&&gi({sitemap$:qi,location$:Kt,viewport$:ke,progress$:uo}).subscribe(ct);var Di;((Di=Or.version)==null?void 0:Di.provider)==="mike"&&Ti({document$:ct});L(Kt,Ht).pipe(nt(125)).subscribe(()=>{at("drawer",!1),at("search",!1)});mo.pipe(g(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=ue("link[rel=prev]");typeof t!="undefined"&&st(t);break;case"n":case".":let r=ue("link[rel=next]");typeof r!="undefined"&&st(r);break;case"Enter":let o=Ne();o instanceof HTMLLabelElement&&o.click()}});Fi({viewport$:ke,document$:ct});ji({document$:ct,tablet$:Lr});Ui({document$:ct});Wi({viewport$:ke,tablet$:Lr});var ft=ai(Ce("header"),{viewport$:ke}),qt=ct.pipe(m(()=>Ce("main")),b(e=>pi(e,{viewport$:ke,header$:ft})),Z(1)),Hs=L(...me("consent").map(e=>An(e,{target$:Ht})),...me("dialog").map(e=>ni(e,{alert$:fo})),...me("palette").map(e=>li(e)),...me("progress").map(e=>mi(e,{progress$:uo})),...me("search").map(e=>_i(e,{index$:zi,keyboard$:mo})),...me("source").map(e=>$i(e))),$s=H(()=>L(...me("announce").map(e=>_n(e)),...me("content").map(e=>oi(e,{sitemap$:qi,viewport$:ke,target$:Ht,print$:Ni})),...me("content").map(e=>V("search.highlight")?Ai(e,{index$:zi,location$:Kt}):y),...me("header").map(e=>si(e,{viewport$:ke,header$:ft,main$:qt})),...me("header-title").map(e=>ci(e,{viewport$:ke,header$:ft})),...me("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?eo(Vi,()=>lo(e,{viewport$:ke,header$:ft,main$:qt})):eo(Lr,()=>lo(e,{viewport$:ke,header$:ft,main$:qt}))),...me("tabs").map(e=>Pi(e,{viewport$:ke,header$:ft})),...me("toc").map(e=>Ri(e,{viewport$:ke,header$:ft,main$:qt,target$:Ht})),...me("top").map(e=>Ii(e,{viewport$:ke,header$:ft,main$:qt,target$:Ht})))),Ki=ct.pipe(b(()=>$s),Ve(Hs),Z(1));Ki.subscribe();window.document$=ct;window.location$=Kt;window.target$=Ht;window.keyboard$=mo;window.viewport$=ke;window.tablet$=Lr;window.screen$=Vi;window.print$=Ni;window.alert$=fo;window.progress$=uo;window.component$=Ki;})(); +//# sourceMappingURL=bundle.79ae519e.min.js.map + diff --git a/latest/assets/javascripts/bundle.79ae519e.min.js.map b/latest/assets/javascripts/bundle.79ae519e.min.js.map new file mode 100644 index 0000000..5cf0289 --- /dev/null +++ b/latest/assets/javascripts/bundle.79ae519e.min.js.map @@ -0,0 +1,7 @@ +{ + "version": 3, + "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/escape-html/index.js", "node_modules/clipboard/dist/clipboard.js", "src/templates/assets/javascripts/bundle.ts", "node_modules/tslib/tslib.es6.mjs", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/BehaviorSubject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/QueueAction.ts", "node_modules/rxjs/src/internal/scheduler/QueueScheduler.ts", "node_modules/rxjs/src/internal/scheduler/queue.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounce.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinct.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/exhaustMap.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/takeLast.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/templates/assets/javascripts/browser/document/index.ts", "src/templates/assets/javascripts/browser/element/_/index.ts", "src/templates/assets/javascripts/browser/element/focus/index.ts", "src/templates/assets/javascripts/browser/element/hover/index.ts", "src/templates/assets/javascripts/utilities/h/index.ts", "src/templates/assets/javascripts/utilities/round/index.ts", "src/templates/assets/javascripts/browser/script/index.ts", "src/templates/assets/javascripts/browser/element/size/_/index.ts", "src/templates/assets/javascripts/browser/element/size/content/index.ts", "src/templates/assets/javascripts/browser/element/offset/_/index.ts", "src/templates/assets/javascripts/browser/element/offset/content/index.ts", "src/templates/assets/javascripts/browser/element/visibility/index.ts", "src/templates/assets/javascripts/browser/toggle/index.ts", "src/templates/assets/javascripts/browser/keyboard/index.ts", "src/templates/assets/javascripts/browser/location/_/index.ts", "src/templates/assets/javascripts/browser/location/hash/index.ts", "src/templates/assets/javascripts/browser/media/index.ts", "src/templates/assets/javascripts/browser/request/index.ts", "src/templates/assets/javascripts/browser/viewport/offset/index.ts", "src/templates/assets/javascripts/browser/viewport/size/index.ts", "src/templates/assets/javascripts/browser/viewport/_/index.ts", "src/templates/assets/javascripts/browser/viewport/at/index.ts", "src/templates/assets/javascripts/browser/worker/index.ts", "src/templates/assets/javascripts/_/index.ts", "src/templates/assets/javascripts/components/_/index.ts", "src/templates/assets/javascripts/components/announce/index.ts", "src/templates/assets/javascripts/components/consent/index.ts", "src/templates/assets/javascripts/templates/tooltip/index.tsx", "src/templates/assets/javascripts/templates/annotation/index.tsx", "src/templates/assets/javascripts/templates/clipboard/index.tsx", "src/templates/assets/javascripts/templates/search/index.tsx", "src/templates/assets/javascripts/templates/source/index.tsx", "src/templates/assets/javascripts/templates/tabbed/index.tsx", "src/templates/assets/javascripts/templates/table/index.tsx", "src/templates/assets/javascripts/templates/version/index.tsx", "src/templates/assets/javascripts/components/tooltip2/index.ts", "src/templates/assets/javascripts/components/content/annotation/_/index.ts", "src/templates/assets/javascripts/components/content/annotation/list/index.ts", "src/templates/assets/javascripts/components/content/annotation/block/index.ts", "src/templates/assets/javascripts/components/content/code/_/index.ts", "src/templates/assets/javascripts/components/content/details/index.ts", "src/templates/assets/javascripts/components/content/link/index.ts", "src/templates/assets/javascripts/components/content/mermaid/index.css", "src/templates/assets/javascripts/components/content/mermaid/index.ts", "src/templates/assets/javascripts/components/content/table/index.ts", "src/templates/assets/javascripts/components/content/tabs/index.ts", "src/templates/assets/javascripts/components/content/_/index.ts", "src/templates/assets/javascripts/components/dialog/index.ts", "src/templates/assets/javascripts/components/tooltip/index.ts", "src/templates/assets/javascripts/components/header/_/index.ts", "src/templates/assets/javascripts/components/header/title/index.ts", "src/templates/assets/javascripts/components/main/index.ts", "src/templates/assets/javascripts/components/palette/index.ts", "src/templates/assets/javascripts/components/progress/index.ts", "src/templates/assets/javascripts/integrations/sitemap/index.ts", "src/templates/assets/javascripts/integrations/alternate/index.ts", "src/templates/assets/javascripts/integrations/clipboard/index.ts", "src/templates/assets/javascripts/integrations/instant/index.ts", "src/templates/assets/javascripts/integrations/search/highlighter/index.ts", "src/templates/assets/javascripts/integrations/search/worker/message/index.ts", "src/templates/assets/javascripts/integrations/search/worker/_/index.ts", "src/templates/assets/javascripts/integrations/version/findurl/index.ts", "src/templates/assets/javascripts/integrations/version/index.ts", "src/templates/assets/javascripts/components/search/query/index.ts", "src/templates/assets/javascripts/components/search/result/index.ts", "src/templates/assets/javascripts/components/search/share/index.ts", "src/templates/assets/javascripts/components/search/suggest/index.ts", "src/templates/assets/javascripts/components/search/_/index.ts", "src/templates/assets/javascripts/components/search/highlight/index.ts", "src/templates/assets/javascripts/components/sidebar/index.ts", "src/templates/assets/javascripts/components/source/facts/github/index.ts", "src/templates/assets/javascripts/components/source/facts/gitlab/index.ts", "src/templates/assets/javascripts/components/source/facts/_/index.ts", "src/templates/assets/javascripts/components/source/_/index.ts", "src/templates/assets/javascripts/components/tabs/index.ts", "src/templates/assets/javascripts/components/toc/index.ts", "src/templates/assets/javascripts/components/top/index.ts", "src/templates/assets/javascripts/patches/ellipsis/index.ts", "src/templates/assets/javascripts/patches/indeterminate/index.ts", "src/templates/assets/javascripts/patches/scrollfix/index.ts", "src/templates/assets/javascripts/patches/scrolllock/index.ts", "src/templates/assets/javascripts/polyfills/index.ts"], + "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*\n * Copyright (c) 2016-2025 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountProgress,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n fetchSitemap,\n setupAlternate,\n setupClipboardJS,\n setupInstantNavigation,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchEllipsis,\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 60em)\")\nconst screen$ = watchMedia(\"(min-width: 76.25em)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up language selector */\nsetupAlternate({ document$ })\n\n/* Set up progress indicator */\nconst progress$ = new Subject()\n\n/* Set up sitemap for instant navigation and previews */\nconst sitemap$ = fetchSitemap(config.base)\n\n/* Set up instant navigation, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantNavigation({ sitemap$, location$, viewport$, progress$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchEllipsis({ viewport$, document$ })\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Progress bar */\n ...getComponentElements(\"progress\")\n .map(el => mountProgress(el, { progress$ })),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { sitemap$, viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.progress$ = progress$ /* Progress indicator subject */\nwindow.component$ = component$ /* Component observable */\n", "/******************************************************************************\nCopyright (c) Microsoft Corporation.\n\nPermission to use, copy, modify, and/or distribute this software for any\npurpose with or without fee is hereby granted.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n***************************************************************************** */\n/* global Reflect, Promise, SuppressedError, Symbol, Iterator */\n\nvar extendStatics = function(d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n};\n\nexport function __extends(d, b) {\n if (typeof b !== \"function\" && b !== null)\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n}\n\nexport var __assign = function() {\n __assign = Object.assign || function __assign(t) {\n for (var s, i = 1, n = arguments.length; i < n; i++) {\n s = arguments[i];\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\n }\n return t;\n }\n return __assign.apply(this, arguments);\n}\n\nexport function __rest(s, e) {\n var t = {};\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\n t[p] = s[p];\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\n t[p[i]] = s[p[i]];\n }\n return t;\n}\n\nexport function __decorate(decorators, target, key, desc) {\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\n return c > 3 && r && Object.defineProperty(target, key, r), r;\n}\n\nexport function __param(paramIndex, decorator) {\n return function (target, key) { decorator(target, key, paramIndex); }\n}\n\nexport function __esDecorate(ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {\n function accept(f) { if (f !== void 0 && typeof f !== \"function\") throw new TypeError(\"Function expected\"); return f; }\n var kind = contextIn.kind, key = kind === \"getter\" ? \"get\" : kind === \"setter\" ? \"set\" : \"value\";\n var target = !descriptorIn && ctor ? contextIn[\"static\"] ? ctor : ctor.prototype : null;\n var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});\n var _, done = false;\n for (var i = decorators.length - 1; i >= 0; i--) {\n var context = {};\n for (var p in contextIn) context[p] = p === \"access\" ? {} : contextIn[p];\n for (var p in contextIn.access) context.access[p] = contextIn.access[p];\n context.addInitializer = function (f) { if (done) throw new TypeError(\"Cannot add initializers after decoration has completed\"); extraInitializers.push(accept(f || null)); };\n var result = (0, decorators[i])(kind === \"accessor\" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);\n if (kind === \"accessor\") {\n if (result === void 0) continue;\n if (result === null || typeof result !== \"object\") throw new TypeError(\"Object expected\");\n if (_ = accept(result.get)) descriptor.get = _;\n if (_ = accept(result.set)) descriptor.set = _;\n if (_ = accept(result.init)) initializers.unshift(_);\n }\n else if (_ = accept(result)) {\n if (kind === \"field\") initializers.unshift(_);\n else descriptor[key] = _;\n }\n }\n if (target) Object.defineProperty(target, contextIn.name, descriptor);\n done = true;\n};\n\nexport function __runInitializers(thisArg, initializers, value) {\n var useValue = arguments.length > 2;\n for (var i = 0; i < initializers.length; i++) {\n value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);\n }\n return useValue ? value : void 0;\n};\n\nexport function __propKey(x) {\n return typeof x === \"symbol\" ? x : \"\".concat(x);\n};\n\nexport function __setFunctionName(f, name, prefix) {\n if (typeof name === \"symbol\") name = name.description ? \"[\".concat(name.description, \"]\") : \"\";\n return Object.defineProperty(f, \"name\", { configurable: true, value: prefix ? \"\".concat(prefix, \" \", name) : name });\n};\n\nexport function __metadata(metadataKey, metadataValue) {\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\n}\n\nexport function __awaiter(thisArg, _arguments, P, generator) {\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\n return new (P || (P = Promise))(function (resolve, reject) {\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\n step((generator = generator.apply(thisArg, _arguments || [])).next());\n });\n}\n\nexport function __generator(thisArg, body) {\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === \"function\" ? Iterator : Object).prototype);\n return g.next = verb(0), g[\"throw\"] = verb(1), g[\"return\"] = verb(2), typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\n function verb(n) { return function (v) { return step([n, v]); }; }\n function step(op) {\n if (f) throw new TypeError(\"Generator is already executing.\");\n while (g && (g = 0, op[0] && (_ = 0)), _) try {\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\n if (y = 0, t) op = [op[0] & 2, t.value];\n switch (op[0]) {\n case 0: case 1: t = op; break;\n case 4: _.label++; return { value: op[1], done: false };\n case 5: _.label++; y = op[1]; op = [0]; continue;\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\n default:\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\n if (t[2]) _.ops.pop();\n _.trys.pop(); continue;\n }\n op = body.call(thisArg, _);\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\n }\n}\n\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n var desc = Object.getOwnPropertyDescriptor(m, k);\n if (!desc || (\"get\" in desc ? !m.__esModule : desc.writable || desc.configurable)) {\n desc = { enumerable: true, get: function() { return m[k]; } };\n }\n Object.defineProperty(o, k2, desc);\n}) : (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n o[k2] = m[k];\n});\n\nexport function __exportStar(m, o) {\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\n}\n\nexport function __values(o) {\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\n if (m) return m.call(o);\n if (o && typeof o.length === \"number\") return {\n next: function () {\n if (o && i >= o.length) o = void 0;\n return { value: o && o[i++], done: !o };\n }\n };\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\n}\n\nexport function __read(o, n) {\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\n if (!m) return o;\n var i = m.call(o), r, ar = [], e;\n try {\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\n }\n catch (error) { e = { error: error }; }\n finally {\n try {\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\n }\n finally { if (e) throw e.error; }\n }\n return ar;\n}\n\n/** @deprecated */\nexport function __spread() {\n for (var ar = [], i = 0; i < arguments.length; i++)\n ar = ar.concat(__read(arguments[i]));\n return ar;\n}\n\n/** @deprecated */\nexport function __spreadArrays() {\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\n r[k] = a[j];\n return r;\n}\n\nexport function __spreadArray(to, from, pack) {\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\n if (ar || !(i in from)) {\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\n ar[i] = from[i];\n }\n }\n return to.concat(ar || Array.prototype.slice.call(from));\n}\n\nexport function __await(v) {\n return this instanceof __await ? (this.v = v, this) : new __await(v);\n}\n\nexport function __asyncGenerator(thisArg, _arguments, generator) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\n return i = Object.create((typeof AsyncIterator === \"function\" ? AsyncIterator : Object).prototype), verb(\"next\"), verb(\"throw\"), verb(\"return\", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;\n function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }\n function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\n function fulfill(value) { resume(\"next\", value); }\n function reject(value) { resume(\"throw\", value); }\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\n}\n\nexport function __asyncDelegator(o) {\n var i, p;\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: false } : f ? f(v) : v; } : f; }\n}\n\nexport function __asyncValues(o) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var m = o[Symbol.asyncIterator], i;\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\n}\n\nexport function __makeTemplateObject(cooked, raw) {\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\n return cooked;\n};\n\nvar __setModuleDefault = Object.create ? (function(o, v) {\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\n}) : function(o, v) {\n o[\"default\"] = v;\n};\n\nexport function __importStar(mod) {\n if (mod && mod.__esModule) return mod;\n var result = {};\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\n __setModuleDefault(result, mod);\n return result;\n}\n\nexport function __importDefault(mod) {\n return (mod && mod.__esModule) ? mod : { default: mod };\n}\n\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\n}\n\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\n}\n\nexport function __classPrivateFieldIn(state, receiver) {\n if (receiver === null || (typeof receiver !== \"object\" && typeof receiver !== \"function\")) throw new TypeError(\"Cannot use 'in' operator on non-object\");\n return typeof state === \"function\" ? receiver === state : state.has(receiver);\n}\n\nexport function __addDisposableResource(env, value, async) {\n if (value !== null && value !== void 0) {\n if (typeof value !== \"object\" && typeof value !== \"function\") throw new TypeError(\"Object expected.\");\n var dispose, inner;\n if (async) {\n if (!Symbol.asyncDispose) throw new TypeError(\"Symbol.asyncDispose is not defined.\");\n dispose = value[Symbol.asyncDispose];\n }\n if (dispose === void 0) {\n if (!Symbol.dispose) throw new TypeError(\"Symbol.dispose is not defined.\");\n dispose = value[Symbol.dispose];\n if (async) inner = dispose;\n }\n if (typeof dispose !== \"function\") throw new TypeError(\"Object not disposable.\");\n if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };\n env.stack.push({ value: value, dispose: dispose, async: async });\n }\n else if (async) {\n env.stack.push({ async: true });\n }\n return value;\n}\n\nvar _SuppressedError = typeof SuppressedError === \"function\" ? SuppressedError : function (error, suppressed, message) {\n var e = new Error(message);\n return e.name = \"SuppressedError\", e.error = error, e.suppressed = suppressed, e;\n};\n\nexport function __disposeResources(env) {\n function fail(e) {\n env.error = env.hasError ? new _SuppressedError(e, env.error, \"An error was suppressed during disposal.\") : e;\n env.hasError = true;\n }\n var r, s = 0;\n function next() {\n while (r = env.stack.pop()) {\n try {\n if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);\n if (r.dispose) {\n var result = r.dispose.call(r.value);\n if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });\n }\n else s |= 1;\n }\n catch (e) {\n fail(e);\n }\n }\n if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();\n if (env.hasError) throw env.error;\n }\n return next();\n}\n\nexport default {\n __extends,\n __assign,\n __rest,\n __decorate,\n __param,\n __metadata,\n __awaiter,\n __generator,\n __createBinding,\n __exportStar,\n __values,\n __read,\n __spread,\n __spreadArrays,\n __spreadArray,\n __await,\n __asyncGenerator,\n __asyncDelegator,\n __asyncValues,\n __makeTemplateObject,\n __importStar,\n __importDefault,\n __classPrivateFieldGet,\n __classPrivateFieldSet,\n __classPrivateFieldIn,\n __addDisposableResource,\n __disposeResources,\n};\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n */\nexport class Subscription implements SubscriptionLike {\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param value The `next` value.\n */\n next(value: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param err The `error` exception.\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as ((value: T) => void) | undefined,\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent.\n * @param subscriber The stopped subscriber.\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @param subscribe The function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @param subscribe the subscriber function to be passed to the Observable constructor\n * @return A new observable.\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @param operator the operator defining the operation to take on the observable\n * @return A new observable with the Operator applied.\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening.\n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param observerOrNext Either an {@link Observer} with some or all callback methods,\n * or the `next` handler that is called for each value emitted from the subscribed Observable.\n * @param error A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param complete A handler for a terminal event resulting from successful completion.\n * @return A subscription reference to the registered handlers.\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next A handler for each value emitted by the observable.\n * @return A promise that either resolves on observable completion or\n * rejects with the handled error.\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @return This instance of the observable.\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction,\n ...operations: OperatorFunction[]\n ): Observable;\n /* tslint:enable:max-line-length */\n\n /**\n * Used to stitch together functional operators into a chain.\n *\n * ## Example\n *\n * ```ts\n * import { interval, filter, map, scan } from 'rxjs';\n *\n * interval(1000)\n * .pipe(\n * filter(x => x % 2 === 0),\n * map(x => x + x),\n * scan((acc, x) => acc + x)\n * )\n * .subscribe(x => console.log(x));\n * ```\n *\n * @return The Observable result of all the operators having been called\n * in the order they were passed in.\n */\n pipe(...operations: OperatorFunction[]): Observable {\n return pipeFromArray(operations)(this);\n }\n\n /* tslint:disable:max-line-length */\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: typeof Promise): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: PromiseConstructorLike): Promise;\n /* tslint:enable:max-line-length */\n\n /**\n * Subscribe to this Observable and get a Promise resolving on\n * `complete` with the last emission (if any).\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * @param [promiseCtor] a constructor function used to instantiate\n * the Promise\n * @return A Promise that resolves with the last value emit, or\n * rejects on an error. If there were no emissions, Promise\n * resolves with undefined.\n * @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise\n */\n toPromise(promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n let value: T | undefined;\n this.subscribe(\n (x: T) => (value = x),\n (err: any) => reject(err),\n () => resolve(value)\n );\n }) as Promise;\n }\n}\n\n/**\n * Decides between a passed promise constructor from consuming code,\n * A default configured promise constructor, and the native promise\n * constructor and returns it. If nothing can be found, it will throw\n * an error.\n * @param promiseCtor The optional promise constructor to passed by consuming code\n */\nfunction getPromiseCtor(promiseCtor: PromiseConstructorLike | undefined) {\n return promiseCtor ?? config.Promise ?? Promise;\n}\n\nfunction isObserver(value: any): value is Observer {\n return value && isFunction(value.next) && isFunction(value.error) && isFunction(value.complete);\n}\n\nfunction isSubscriber(value: any): value is Subscriber {\n return (value && value instanceof Subscriber) || (isObserver(value) && isSubscription(value));\n}\n", "import { Observable } from '../Observable';\nimport { Subscriber } from '../Subscriber';\nimport { OperatorFunction } from '../types';\nimport { isFunction } from './isFunction';\n\n/**\n * Used to determine if an object is an Observable with a lift function.\n */\nexport function hasLift(source: any): source is { lift: InstanceType['lift'] } {\n return isFunction(source?.lift);\n}\n\n/**\n * Creates an `OperatorFunction`. Used to define operators throughout the library in a concise way.\n * @param init The logic to connect the liftedSource to the subscriber at the moment of subscription.\n */\nexport function operate(\n init: (liftedSource: Observable, subscriber: Subscriber) => (() => void) | void\n): OperatorFunction {\n return (source: Observable) => {\n if (hasLift(source)) {\n return source.lift(function (this: Subscriber, liftedSource: Observable) {\n try {\n return init(liftedSource, this);\n } catch (err) {\n this.error(err);\n }\n });\n }\n throw new TypeError('Unable to lift unknown Observable type');\n };\n}\n", "import { Subscriber } from '../Subscriber';\n\n/**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional teardown logic here. This will only be called on teardown if the\n * subscriber itself is not already closed. This is called after all other teardown logic is executed.\n */\nexport function createOperatorSubscriber(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n onFinalize?: () => void\n): Subscriber {\n return new OperatorSubscriber(destination, onNext, onComplete, onError, onFinalize);\n}\n\n/**\n * A generic helper for allowing operators to be created with a Subscriber and\n * use closures to capture necessary state from the operator function itself.\n */\nexport class OperatorSubscriber extends Subscriber {\n /**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional finalization logic here. This will only be called on finalization if the\n * subscriber itself is not already closed. This is called after all other finalization logic is executed.\n * @param shouldUnsubscribe An optional check to see if an unsubscribe call should truly unsubscribe.\n * NOTE: This currently **ONLY** exists to support the strange behavior of {@link groupBy}, where unsubscription\n * to the resulting observable does not actually disconnect from the source if there are active subscriptions\n * to any grouped observable. (DO NOT EXPOSE OR USE EXTERNALLY!!!)\n */\n constructor(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n private onFinalize?: () => void,\n private shouldUnsubscribe?: () => boolean\n ) {\n // It's important - for performance reasons - that all of this class's\n // members are initialized and that they are always initialized in the same\n // order. This will ensure that all OperatorSubscriber instances have the\n // same hidden class in V8. This, in turn, will help keep the number of\n // hidden classes involved in property accesses within the base class as\n // low as possible. If the number of hidden classes involved exceeds four,\n // the property accesses will become megamorphic and performance penalties\n // will be incurred - i.e. inline caches won't be used.\n //\n // The reasons for ensuring all instances have the same hidden class are\n // further discussed in this blog post from Benedikt Meurer:\n // https://benediktmeurer.de/2018/03/23/impact-of-polymorphism-on-component-based-frameworks-like-react/\n super(destination);\n this._next = onNext\n ? function (this: OperatorSubscriber, value: T) {\n try {\n onNext(value);\n } catch (err) {\n destination.error(err);\n }\n }\n : super._next;\n this._error = onError\n ? function (this: OperatorSubscriber, err: any) {\n try {\n onError(err);\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._error;\n this._complete = onComplete\n ? function (this: OperatorSubscriber) {\n try {\n onComplete();\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._complete;\n }\n\n unsubscribe() {\n if (!this.shouldUnsubscribe || this.shouldUnsubscribe()) {\n const { closed } = this;\n super.unsubscribe();\n // Execute additional teardown if we have any and we didn't already do so.\n !closed && this.onFinalize?.();\n }\n }\n}\n", "import { Subscription } from '../Subscription';\n\ninterface AnimationFrameProvider {\n schedule(callback: FrameRequestCallback): Subscription;\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n delegate:\n | {\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n }\n | undefined;\n}\n\nexport const animationFrameProvider: AnimationFrameProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n schedule(callback) {\n let request = requestAnimationFrame;\n let cancel: typeof cancelAnimationFrame | undefined = cancelAnimationFrame;\n const { delegate } = animationFrameProvider;\n if (delegate) {\n request = delegate.requestAnimationFrame;\n cancel = delegate.cancelAnimationFrame;\n }\n const handle = request((timestamp) => {\n // Clear the cancel function. The request has been fulfilled, so\n // attempting to cancel the request upon unsubscription would be\n // pointless.\n cancel = undefined;\n callback(timestamp);\n });\n return new Subscription(() => cancel?.(handle));\n },\n requestAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.requestAnimationFrame || requestAnimationFrame)(...args);\n },\n cancelAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.cancelAnimationFrame || cancelAnimationFrame)(...args);\n },\n delegate: undefined,\n};\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface ObjectUnsubscribedError extends Error {}\n\nexport interface ObjectUnsubscribedErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (): ObjectUnsubscribedError;\n}\n\n/**\n * An error thrown when an action is invalid because the object has been\n * unsubscribed.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n *\n * @class ObjectUnsubscribedError\n */\nexport const ObjectUnsubscribedError: ObjectUnsubscribedErrorCtor = createErrorClass(\n (_super) =>\n function ObjectUnsubscribedErrorImpl(this: any) {\n _super(this);\n this.name = 'ObjectUnsubscribedError';\n this.message = 'object unsubscribed';\n }\n);\n", "import { Operator } from './Operator';\nimport { Observable } from './Observable';\nimport { Subscriber } from './Subscriber';\nimport { Subscription, EMPTY_SUBSCRIPTION } from './Subscription';\nimport { Observer, SubscriptionLike, TeardownLogic } from './types';\nimport { ObjectUnsubscribedError } from './util/ObjectUnsubscribedError';\nimport { arrRemove } from './util/arrRemove';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A Subject is a special type of Observable that allows values to be\n * multicasted to many Observers. Subjects are like EventEmitters.\n *\n * Every Subject is an Observable and an Observer. You can subscribe to a\n * Subject, and you can call next to feed values as well as error and complete.\n */\nexport class Subject extends Observable implements SubscriptionLike {\n closed = false;\n\n private currentObservers: Observer[] | null = null;\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n observers: Observer[] = [];\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n isStopped = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n hasError = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n thrownError: any = null;\n\n /**\n * Creates a \"subject\" by basically gluing an observer to an observable.\n *\n * @deprecated Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.\n */\n static create: (...args: any[]) => any = (destination: Observer, source: Observable): AnonymousSubject => {\n return new AnonymousSubject(destination, source);\n };\n\n constructor() {\n // NOTE: This must be here to obscure Observable's constructor.\n super();\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n lift(operator: Operator): Observable {\n const subject = new AnonymousSubject(this, this);\n subject.operator = operator as any;\n return subject as any;\n }\n\n /** @internal */\n protected _throwIfClosed() {\n if (this.closed) {\n throw new ObjectUnsubscribedError();\n }\n }\n\n next(value: T) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n if (!this.currentObservers) {\n this.currentObservers = Array.from(this.observers);\n }\n for (const observer of this.currentObservers) {\n observer.next(value);\n }\n }\n });\n }\n\n error(err: any) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.hasError = this.isStopped = true;\n this.thrownError = err;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.error(err);\n }\n }\n });\n }\n\n complete() {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.isStopped = true;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.complete();\n }\n }\n });\n }\n\n unsubscribe() {\n this.isStopped = this.closed = true;\n this.observers = this.currentObservers = null!;\n }\n\n get observed() {\n return this.observers?.length > 0;\n }\n\n /** @internal */\n protected _trySubscribe(subscriber: Subscriber): TeardownLogic {\n this._throwIfClosed();\n return super._trySubscribe(subscriber);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._checkFinalizedStatuses(subscriber);\n return this._innerSubscribe(subscriber);\n }\n\n /** @internal */\n protected _innerSubscribe(subscriber: Subscriber) {\n const { hasError, isStopped, observers } = this;\n if (hasError || isStopped) {\n return EMPTY_SUBSCRIPTION;\n }\n this.currentObservers = null;\n observers.push(subscriber);\n return new Subscription(() => {\n this.currentObservers = null;\n arrRemove(observers, subscriber);\n });\n }\n\n /** @internal */\n protected _checkFinalizedStatuses(subscriber: Subscriber) {\n const { hasError, thrownError, isStopped } = this;\n if (hasError) {\n subscriber.error(thrownError);\n } else if (isStopped) {\n subscriber.complete();\n }\n }\n\n /**\n * Creates a new Observable with this Subject as the source. You can do this\n * to create custom Observer-side logic of the Subject and conceal it from\n * code that uses the Observable.\n * @return Observable that this Subject casts to.\n */\n asObservable(): Observable {\n const observable: any = new Observable();\n observable.source = this;\n return observable;\n }\n}\n\nexport class AnonymousSubject extends Subject {\n constructor(\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n public destination?: Observer,\n source?: Observable\n ) {\n super();\n this.source = source;\n }\n\n next(value: T) {\n this.destination?.next?.(value);\n }\n\n error(err: any) {\n this.destination?.error?.(err);\n }\n\n complete() {\n this.destination?.complete?.();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n return this.source?.subscribe(subscriber) ?? EMPTY_SUBSCRIPTION;\n }\n}\n", "import { Subject } from './Subject';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\n\n/**\n * A variant of Subject that requires an initial value and emits its current\n * value whenever it is subscribed to.\n */\nexport class BehaviorSubject extends Subject {\n constructor(private _value: T) {\n super();\n }\n\n get value(): T {\n return this.getValue();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n const subscription = super._subscribe(subscriber);\n !subscription.closed && subscriber.next(this._value);\n return subscription;\n }\n\n getValue(): T {\n const { hasError, thrownError, _value } = this;\n if (hasError) {\n throw thrownError;\n }\n this._throwIfClosed();\n return _value;\n }\n\n next(value: T): void {\n super.next((this._value = value));\n }\n}\n", "import { TimestampProvider } from '../types';\n\ninterface DateTimestampProvider extends TimestampProvider {\n delegate: TimestampProvider | undefined;\n}\n\nexport const dateTimestampProvider: DateTimestampProvider = {\n now() {\n // Use the variable rather than `this` so that the function can be called\n // without being bound to the provider.\n return (dateTimestampProvider.delegate || Date).now();\n },\n delegate: undefined,\n};\n", "import { Subject } from './Subject';\nimport { TimestampProvider } from './types';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * A variant of {@link Subject} that \"replays\" old values to new subscribers by emitting them when they first subscribe.\n *\n * `ReplaySubject` has an internal buffer that will store a specified number of values that it has observed. Like `Subject`,\n * `ReplaySubject` \"observes\" values by having them passed to its `next` method. When it observes a value, it will store that\n * value for a time determined by the configuration of the `ReplaySubject`, as passed to its constructor.\n *\n * When a new subscriber subscribes to the `ReplaySubject` instance, it will synchronously emit all values in its buffer in\n * a First-In-First-Out (FIFO) manner. The `ReplaySubject` will also complete, if it has observed completion; and it will\n * error if it has observed an error.\n *\n * There are two main configuration items to be concerned with:\n *\n * 1. `bufferSize` - This will determine how many items are stored in the buffer, defaults to infinite.\n * 2. `windowTime` - The amount of time to hold a value in the buffer before removing it from the buffer.\n *\n * Both configurations may exist simultaneously. So if you would like to buffer a maximum of 3 values, as long as the values\n * are less than 2 seconds old, you could do so with a `new ReplaySubject(3, 2000)`.\n *\n * ### Differences with BehaviorSubject\n *\n * `BehaviorSubject` is similar to `new ReplaySubject(1)`, with a couple of exceptions:\n *\n * 1. `BehaviorSubject` comes \"primed\" with a single value upon construction.\n * 2. `ReplaySubject` will replay values, even after observing an error, where `BehaviorSubject` will not.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n * @see {@link shareReplay}\n */\nexport class ReplaySubject extends Subject {\n private _buffer: (T | number)[] = [];\n private _infiniteTimeWindow = true;\n\n /**\n * @param _bufferSize The size of the buffer to replay on subscription\n * @param _windowTime The amount of time the buffered items will stay buffered\n * @param _timestampProvider An object with a `now()` method that provides the current timestamp. This is used to\n * calculate the amount of time something has been buffered.\n */\n constructor(\n private _bufferSize = Infinity,\n private _windowTime = Infinity,\n private _timestampProvider: TimestampProvider = dateTimestampProvider\n ) {\n super();\n this._infiniteTimeWindow = _windowTime === Infinity;\n this._bufferSize = Math.max(1, _bufferSize);\n this._windowTime = Math.max(1, _windowTime);\n }\n\n next(value: T): void {\n const { isStopped, _buffer, _infiniteTimeWindow, _timestampProvider, _windowTime } = this;\n if (!isStopped) {\n _buffer.push(value);\n !_infiniteTimeWindow && _buffer.push(_timestampProvider.now() + _windowTime);\n }\n this._trimBuffer();\n super.next(value);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._trimBuffer();\n\n const subscription = this._innerSubscribe(subscriber);\n\n const { _infiniteTimeWindow, _buffer } = this;\n // We use a copy here, so reentrant code does not mutate our array while we're\n // emitting it to a new subscriber.\n const copy = _buffer.slice();\n for (let i = 0; i < copy.length && !subscriber.closed; i += _infiniteTimeWindow ? 1 : 2) {\n subscriber.next(copy[i] as T);\n }\n\n this._checkFinalizedStatuses(subscriber);\n\n return subscription;\n }\n\n private _trimBuffer() {\n const { _bufferSize, _timestampProvider, _buffer, _infiniteTimeWindow } = this;\n // If we don't have an infinite buffer size, and we're over the length,\n // use splice to truncate the old buffer values off. Note that we have to\n // double the size for instances where we're not using an infinite time window\n // because we're storing the values and the timestamps in the same array.\n const adjustedBufferSize = (_infiniteTimeWindow ? 1 : 2) * _bufferSize;\n _bufferSize < Infinity && adjustedBufferSize < _buffer.length && _buffer.splice(0, _buffer.length - adjustedBufferSize);\n\n // Now, if we're not in an infinite time window, remove all values where the time is\n // older than what is allowed.\n if (!_infiniteTimeWindow) {\n const now = _timestampProvider.now();\n let last = 0;\n // Search the array for the first timestamp that isn't expired and\n // truncate the buffer up to that point.\n for (let i = 1; i < _buffer.length && (_buffer[i] as number) <= now; i += 2) {\n last = i;\n }\n last && _buffer.splice(0, last + 1);\n }\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Subscription } from '../Subscription';\nimport { SchedulerAction } from '../types';\n\n/**\n * A unit of work to be executed in a `scheduler`. An action is typically\n * created from within a {@link SchedulerLike} and an RxJS user does not need to concern\n * themselves about creating and manipulating an Action.\n *\n * ```ts\n * class Action extends Subscription {\n * new (scheduler: Scheduler, work: (state?: T) => void);\n * schedule(state?: T, delay: number = 0): Subscription;\n * }\n * ```\n */\nexport class Action extends Subscription {\n constructor(scheduler: Scheduler, work: (this: SchedulerAction, state?: T) => void) {\n super();\n }\n /**\n * Schedules this action on its parent {@link SchedulerLike} for execution. May be passed\n * some context object, `state`. May happen at some point in the future,\n * according to the `delay` parameter, if specified.\n * @param state Some contextual data that the `work` function uses when called by the\n * Scheduler.\n * @param delay Time to wait before executing the work, where the time unit is implicit\n * and defined by the Scheduler.\n * @return A subscription in order to be able to unsubscribe the scheduled work.\n */\n public schedule(state?: T, delay: number = 0): Subscription {\n return this;\n }\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetIntervalFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearIntervalFunction = (handle: TimerHandle) => void;\n\ninterface IntervalProvider {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n delegate:\n | {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n }\n | undefined;\n}\n\nexport const intervalProvider: IntervalProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setInterval(handler: () => void, timeout?: number, ...args) {\n const { delegate } = intervalProvider;\n if (delegate?.setInterval) {\n return delegate.setInterval(handler, timeout, ...args);\n }\n return setInterval(handler, timeout, ...args);\n },\n clearInterval(handle) {\n const { delegate } = intervalProvider;\n return (delegate?.clearInterval || clearInterval)(handle as any);\n },\n delegate: undefined,\n};\n", "import { Action } from './Action';\nimport { SchedulerAction } from '../types';\nimport { Subscription } from '../Subscription';\nimport { AsyncScheduler } from './AsyncScheduler';\nimport { intervalProvider } from './intervalProvider';\nimport { arrRemove } from '../util/arrRemove';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncAction extends Action {\n public id: TimerHandle | undefined;\n public state?: T;\n // @ts-ignore: Property has no initializer and is not definitely assigned\n public delay: number;\n protected pending: boolean = false;\n\n constructor(protected scheduler: AsyncScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (this.closed) {\n return this;\n }\n\n // Always replace the current state with the new state.\n this.state = state;\n\n const id = this.id;\n const scheduler = this.scheduler;\n\n //\n // Important implementation note:\n //\n // Actions only execute once by default, unless rescheduled from within the\n // scheduled callback. This allows us to implement single and repeat\n // actions via the same code path, without adding API surface area, as well\n // as mimic traditional recursion but across asynchronous boundaries.\n //\n // However, JS runtimes and timers distinguish between intervals achieved by\n // serial `setTimeout` calls vs. a single `setInterval` call. An interval of\n // serial `setTimeout` calls can be individually delayed, which delays\n // scheduling the next `setTimeout`, and so on. `setInterval` attempts to\n // guarantee the interval callback will be invoked more precisely to the\n // interval period, regardless of load.\n //\n // Therefore, we use `setInterval` to schedule single and repeat actions.\n // If the action reschedules itself with the same delay, the interval is not\n // canceled. If the action doesn't reschedule, or reschedules with a\n // different delay, the interval will be canceled after scheduled callback\n // execution.\n //\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, delay);\n }\n\n // Set the pending flag indicating that this action has been scheduled, or\n // has recursively rescheduled itself.\n this.pending = true;\n\n this.delay = delay;\n // If this action has already an async Id, don't request a new one.\n this.id = this.id ?? this.requestAsyncId(scheduler, this.id, delay);\n\n return this;\n }\n\n protected requestAsyncId(scheduler: AsyncScheduler, _id?: TimerHandle, delay: number = 0): TimerHandle {\n return intervalProvider.setInterval(scheduler.flush.bind(scheduler, this), delay);\n }\n\n protected recycleAsyncId(_scheduler: AsyncScheduler, id?: TimerHandle, delay: number | null = 0): TimerHandle | undefined {\n // If this action is rescheduled with the same delay time, don't clear the interval id.\n if (delay != null && this.delay === delay && this.pending === false) {\n return id;\n }\n // Otherwise, if the action's delay time is different from the current delay,\n // or the action has been rescheduled before it's executed, clear the interval id\n if (id != null) {\n intervalProvider.clearInterval(id);\n }\n\n return undefined;\n }\n\n /**\n * Immediately executes this action and the `work` it contains.\n */\n public execute(state: T, delay: number): any {\n if (this.closed) {\n return new Error('executing a cancelled action');\n }\n\n this.pending = false;\n const error = this._execute(state, delay);\n if (error) {\n return error;\n } else if (this.pending === false && this.id != null) {\n // Dequeue if the action didn't reschedule itself. Don't call\n // unsubscribe(), because the action could reschedule later.\n // For example:\n // ```\n // scheduler.schedule(function doWork(counter) {\n // /* ... I'm a busy worker bee ... */\n // var originalAction = this;\n // /* wait 100ms before rescheduling the action */\n // setTimeout(function () {\n // originalAction.schedule(counter + 1);\n // }, 100);\n // }, 1000);\n // ```\n this.id = this.recycleAsyncId(this.scheduler, this.id, null);\n }\n }\n\n protected _execute(state: T, _delay: number): any {\n let errored: boolean = false;\n let errorValue: any;\n try {\n this.work(state);\n } catch (e) {\n errored = true;\n // HACK: Since code elsewhere is relying on the \"truthiness\" of the\n // return here, we can't have it return \"\" or 0 or false.\n // TODO: Clean this up when we refactor schedulers mid-version-8 or so.\n errorValue = e ? e : new Error('Scheduled action threw falsy error');\n }\n if (errored) {\n this.unsubscribe();\n return errorValue;\n }\n }\n\n unsubscribe() {\n if (!this.closed) {\n const { id, scheduler } = this;\n const { actions } = scheduler;\n\n this.work = this.state = this.scheduler = null!;\n this.pending = false;\n\n arrRemove(actions, this);\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, null);\n }\n\n this.delay = null!;\n super.unsubscribe();\n }\n }\n}\n", "import { Action } from './scheduler/Action';\nimport { Subscription } from './Subscription';\nimport { SchedulerLike, SchedulerAction } from './types';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * An execution context and a data structure to order tasks and schedule their\n * execution. Provides a notion of (potentially virtual) time, through the\n * `now()` getter method.\n *\n * Each unit of work in a Scheduler is called an `Action`.\n *\n * ```ts\n * class Scheduler {\n * now(): number;\n * schedule(work, delay?, state?): Subscription;\n * }\n * ```\n *\n * @deprecated Scheduler is an internal implementation detail of RxJS, and\n * should not be used directly. Rather, create your own class and implement\n * {@link SchedulerLike}. Will be made internal in v8.\n */\nexport class Scheduler implements SchedulerLike {\n public static now: () => number = dateTimestampProvider.now;\n\n constructor(private schedulerActionCtor: typeof Action, now: () => number = Scheduler.now) {\n this.now = now;\n }\n\n /**\n * A getter method that returns a number representing the current time\n * (at the time this function was called) according to the scheduler's own\n * internal clock.\n * @return A number that represents the current time. May or may not\n * have a relation to wall-clock time. May or may not refer to a time unit\n * (e.g. milliseconds).\n */\n public now: () => number;\n\n /**\n * Schedules a function, `work`, for execution. May happen at some point in\n * the future, according to the `delay` parameter, if specified. May be passed\n * some context object, `state`, which will be passed to the `work` function.\n *\n * The given arguments will be processed an stored as an Action object in a\n * queue of actions.\n *\n * @param work A function representing a task, or some unit of work to be\n * executed by the Scheduler.\n * @param delay Time to wait before executing the work, where the time unit is\n * implicit and defined by the Scheduler itself.\n * @param state Some contextual data that the `work` function uses when called\n * by the Scheduler.\n * @return A subscription in order to be able to unsubscribe the scheduled work.\n */\n public schedule(work: (this: SchedulerAction, state?: T) => void, delay: number = 0, state?: T): Subscription {\n return new this.schedulerActionCtor(this, work).schedule(state, delay);\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Action } from './Action';\nimport { AsyncAction } from './AsyncAction';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncScheduler extends Scheduler {\n public actions: Array> = [];\n /**\n * A flag to indicate whether the Scheduler is currently executing a batch of\n * queued actions.\n * @internal\n */\n public _active: boolean = false;\n /**\n * An internal ID used to track the latest asynchronous task such as those\n * coming from `setTimeout`, `setInterval`, `requestAnimationFrame`, and\n * others.\n * @internal\n */\n public _scheduled: TimerHandle | undefined;\n\n constructor(SchedulerAction: typeof Action, now: () => number = Scheduler.now) {\n super(SchedulerAction, now);\n }\n\n public flush(action: AsyncAction): void {\n const { actions } = this;\n\n if (this._active) {\n actions.push(action);\n return;\n }\n\n let error: any;\n this._active = true;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions.shift()!)); // exhaust the scheduler queue\n\n this._active = false;\n\n if (error) {\n while ((action = actions.shift()!)) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\n/**\n *\n * Async Scheduler\n *\n * Schedule task as if you used setTimeout(task, duration)\n *\n * `async` scheduler schedules tasks asynchronously, by putting them on the JavaScript\n * event loop queue. It is best used to delay tasks in time or to schedule tasks repeating\n * in intervals.\n *\n * If you just want to \"defer\" task, that is to perform it right after currently\n * executing synchronous code ends (commonly achieved by `setTimeout(deferredTask, 0)`),\n * better choice will be the {@link asapScheduler} scheduler.\n *\n * ## Examples\n * Use async scheduler to delay task\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * const task = () => console.log('it works!');\n *\n * asyncScheduler.schedule(task, 2000);\n *\n * // After 2 seconds logs:\n * // \"it works!\"\n * ```\n *\n * Use async scheduler to repeat task in intervals\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * function task(state) {\n * console.log(state);\n * this.schedule(state + 1, 1000); // `this` references currently executing Action,\n * // which we reschedule with new state and delay\n * }\n *\n * asyncScheduler.schedule(task, 3000, 0);\n *\n * // Logs:\n * // 0 after 3s\n * // 1 after 4s\n * // 2 after 5s\n * // 3 after 6s\n * ```\n */\n\nexport const asyncScheduler = new AsyncScheduler(AsyncAction);\n\n/**\n * @deprecated Renamed to {@link asyncScheduler}. Will be removed in v8.\n */\nexport const async = asyncScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { Subscription } from '../Subscription';\nimport { QueueScheduler } from './QueueScheduler';\nimport { SchedulerAction } from '../types';\nimport { TimerHandle } from './timerHandle';\n\nexport class QueueAction extends AsyncAction {\n constructor(protected scheduler: QueueScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (delay > 0) {\n return super.schedule(state, delay);\n }\n this.delay = delay;\n this.state = state;\n this.scheduler.flush(this);\n return this;\n }\n\n public execute(state: T, delay: number): any {\n return delay > 0 || this.closed ? super.execute(state, delay) : this._execute(state, delay);\n }\n\n protected requestAsyncId(scheduler: QueueScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n\n if ((delay != null && delay > 0) || (delay == null && this.delay > 0)) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n\n // Otherwise flush the scheduler starting with this action.\n scheduler.flush(this);\n\n // HACK: In the past, this was returning `void`. However, `void` isn't a valid\n // `TimerHandle`, and generally the return value here isn't really used. So the\n // compromise is to return `0` which is both \"falsy\" and a valid `TimerHandle`,\n // as opposed to refactoring every other instanceo of `requestAsyncId`.\n return 0;\n }\n}\n", "import { AsyncScheduler } from './AsyncScheduler';\n\nexport class QueueScheduler extends AsyncScheduler {\n}\n", "import { QueueAction } from './QueueAction';\nimport { QueueScheduler } from './QueueScheduler';\n\n/**\n *\n * Queue Scheduler\n *\n * Put every next task on a queue, instead of executing it immediately\n *\n * `queue` scheduler, when used with delay, behaves the same as {@link asyncScheduler} scheduler.\n *\n * When used without delay, it schedules given task synchronously - executes it right when\n * it is scheduled. However when called recursively, that is when inside the scheduled task,\n * another task is scheduled with queue scheduler, instead of executing immediately as well,\n * that task will be put on a queue and wait for current one to finish.\n *\n * This means that when you execute task with `queue` scheduler, you are sure it will end\n * before any other task scheduled with that scheduler will start.\n *\n * ## Examples\n * Schedule recursively first, then do something\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(() => {\n * queueScheduler.schedule(() => console.log('second')); // will not happen now, but will be put on a queue\n *\n * console.log('first');\n * });\n *\n * // Logs:\n * // \"first\"\n * // \"second\"\n * ```\n *\n * Reschedule itself recursively\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(function(state) {\n * if (state !== 0) {\n * console.log('before', state);\n * this.schedule(state - 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * console.log('after', state);\n * }\n * }, 0, 3);\n *\n * // In scheduler that runs recursively, you would expect:\n * // \"before\", 3\n * // \"before\", 2\n * // \"before\", 1\n * // \"after\", 1\n * // \"after\", 2\n * // \"after\", 3\n *\n * // But with queue it logs:\n * // \"before\", 3\n * // \"after\", 3\n * // \"before\", 2\n * // \"after\", 2\n * // \"before\", 1\n * // \"after\", 1\n * ```\n */\n\nexport const queueScheduler = new QueueScheduler(QueueAction);\n\n/**\n * @deprecated Renamed to {@link queueScheduler}. Will be removed in v8.\n */\nexport const queue = queueScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\nimport { SchedulerAction } from '../types';\nimport { animationFrameProvider } from './animationFrameProvider';\nimport { TimerHandle } from './timerHandle';\n\nexport class AnimationFrameAction extends AsyncAction {\n constructor(protected scheduler: AnimationFrameScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n protected requestAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay is greater than 0, request as an async action.\n if (delay !== null && delay > 0) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n // Push the action to the end of the scheduler queue.\n scheduler.actions.push(this);\n // If an animation frame has already been requested, don't request another\n // one. If an animation frame hasn't been requested yet, request one. Return\n // the current animation frame request id.\n return scheduler._scheduled || (scheduler._scheduled = animationFrameProvider.requestAnimationFrame(() => scheduler.flush(undefined)));\n }\n\n protected recycleAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle | undefined {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n if (delay != null ? delay > 0 : this.delay > 0) {\n return super.recycleAsyncId(scheduler, id, delay);\n }\n // If the scheduler queue has no remaining actions with the same async id,\n // cancel the requested animation frame and set the scheduled flag to\n // undefined so the next AnimationFrameAction will request its own.\n const { actions } = scheduler;\n if (id != null && id === scheduler._scheduled && actions[actions.length - 1]?.id !== id) {\n animationFrameProvider.cancelAnimationFrame(id as number);\n scheduler._scheduled = undefined;\n }\n // Return undefined so the action knows to request a new async id if it's rescheduled.\n return undefined;\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\nexport class AnimationFrameScheduler extends AsyncScheduler {\n public flush(action?: AsyncAction): void {\n this._active = true;\n // The async id that effects a call to flush is stored in _scheduled.\n // Before executing an action, it's necessary to check the action's async\n // id to determine whether it's supposed to be executed in the current\n // flush.\n // Previous implementations of this method used a count to determine this,\n // but that was unsound, as actions that are unsubscribed - i.e. cancelled -\n // are removed from the actions array and that can shift actions that are\n // scheduled to be executed in a subsequent flush into positions at which\n // they are executed within the current flush.\n let flushId;\n if (action) {\n flushId = action.id;\n } else {\n flushId = this._scheduled;\n this._scheduled = undefined;\n }\n\n const { actions } = this;\n let error: any;\n action = action || actions.shift()!;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions[0]) && action.id === flushId && actions.shift());\n\n this._active = false;\n\n if (error) {\n while ((action = actions[0]) && action.id === flushId && actions.shift()) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AnimationFrameAction } from './AnimationFrameAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\n\n/**\n *\n * Animation Frame Scheduler\n *\n * Perform task when `window.requestAnimationFrame` would fire\n *\n * When `animationFrame` scheduler is used with delay, it will fall back to {@link asyncScheduler} scheduler\n * behaviour.\n *\n * Without delay, `animationFrame` scheduler can be used to create smooth browser animations.\n * It makes sure scheduled task will happen just before next browser content repaint,\n * thus performing animations as efficiently as possible.\n *\n * ## Example\n * Schedule div height animation\n * ```ts\n * // html:
\n * import { animationFrameScheduler } from 'rxjs';\n *\n * const div = document.querySelector('div');\n *\n * animationFrameScheduler.schedule(function(height) {\n * div.style.height = height + \"px\";\n *\n * this.schedule(height + 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * }, 0, 0);\n *\n * // You will see a div element growing in height\n * ```\n */\n\nexport const animationFrameScheduler = new AnimationFrameScheduler(AnimationFrameAction);\n\n/**\n * @deprecated Renamed to {@link animationFrameScheduler}. Will be removed in v8.\n */\nexport const animationFrame = animationFrameScheduler;\n", "import { Observable } from '../Observable';\nimport { SchedulerLike } from '../types';\n\n/**\n * A simple Observable that emits no items to the Observer and immediately\n * emits a complete notification.\n *\n * Just emits 'complete', and nothing else.\n *\n * ![](empty.png)\n *\n * A simple Observable that only emits the complete notification. It can be used\n * for composing with other Observables, such as in a {@link mergeMap}.\n *\n * ## Examples\n *\n * Log complete notification\n *\n * ```ts\n * import { EMPTY } from 'rxjs';\n *\n * EMPTY.subscribe({\n * next: () => console.log('Next'),\n * complete: () => console.log('Complete!')\n * });\n *\n * // Outputs\n * // Complete!\n * ```\n *\n * Emit the number 7, then complete\n *\n * ```ts\n * import { EMPTY, startWith } from 'rxjs';\n *\n * const result = EMPTY.pipe(startWith(7));\n * result.subscribe(x => console.log(x));\n *\n * // Outputs\n * // 7\n * ```\n *\n * Map and flatten only odd numbers to the sequence `'a'`, `'b'`, `'c'`\n *\n * ```ts\n * import { interval, mergeMap, of, EMPTY } from 'rxjs';\n *\n * const interval$ = interval(1000);\n * const result = interval$.pipe(\n * mergeMap(x => x % 2 === 1 ? of('a', 'b', 'c') : EMPTY),\n * );\n * result.subscribe(x => console.log(x));\n *\n * // Results in the following to the console:\n * // x is equal to the count on the interval, e.g. (0, 1, 2, 3, ...)\n * // x will occur every 1000ms\n * // if x % 2 is equal to 1, print a, b, c (each on its own)\n * // if x % 2 is not equal to 1, nothing will be output\n * ```\n *\n * @see {@link Observable}\n * @see {@link NEVER}\n * @see {@link of}\n * @see {@link throwError}\n */\nexport const EMPTY = new Observable((subscriber) => subscriber.complete());\n\n/**\n * @param scheduler A {@link SchedulerLike} to use for scheduling\n * the emission of the complete notification.\n * @deprecated Replaced with the {@link EMPTY} constant or {@link scheduled} (e.g. `scheduled([], scheduler)`). Will be removed in v8.\n */\nexport function empty(scheduler?: SchedulerLike) {\n return scheduler ? emptyScheduled(scheduler) : EMPTY;\n}\n\nfunction emptyScheduled(scheduler: SchedulerLike) {\n return new Observable((subscriber) => scheduler.schedule(() => subscriber.complete()));\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport function isScheduler(value: any): value is SchedulerLike {\n return value && isFunction(value.schedule);\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\nimport { isScheduler } from './isScheduler';\n\nfunction last(arr: T[]): T | undefined {\n return arr[arr.length - 1];\n}\n\nexport function popResultSelector(args: any[]): ((...args: unknown[]) => unknown) | undefined {\n return isFunction(last(args)) ? args.pop() : undefined;\n}\n\nexport function popScheduler(args: any[]): SchedulerLike | undefined {\n return isScheduler(last(args)) ? args.pop() : undefined;\n}\n\nexport function popNumber(args: any[], defaultValue: number): number {\n return typeof last(args) === 'number' ? args.pop()! : defaultValue;\n}\n", "export const isArrayLike = ((x: any): x is ArrayLike => x && typeof x.length === 'number' && typeof x !== 'function');", "import { isFunction } from \"./isFunction\";\n\n/**\n * Tests to see if the object is \"thennable\".\n * @param value the object to test\n */\nexport function isPromise(value: any): value is PromiseLike {\n return isFunction(value?.then);\n}\n", "import { InteropObservable } from '../types';\nimport { observable as Symbol_observable } from '../symbol/observable';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being Observable (but not necessary an Rx Observable) */\nexport function isInteropObservable(input: any): input is InteropObservable {\n return isFunction(input[Symbol_observable]);\n}\n", "import { isFunction } from './isFunction';\n\nexport function isAsyncIterable(obj: any): obj is AsyncIterable {\n return Symbol.asyncIterator && isFunction(obj?.[Symbol.asyncIterator]);\n}\n", "/**\n * Creates the TypeError to throw if an invalid object is passed to `from` or `scheduled`.\n * @param input The object that was passed.\n */\nexport function createInvalidObservableTypeError(input: any) {\n // TODO: We should create error codes that can be looked up, so this can be less verbose.\n return new TypeError(\n `You provided ${\n input !== null && typeof input === 'object' ? 'an invalid object' : `'${input}'`\n } where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.`\n );\n}\n", "export function getSymbolIterator(): symbol {\n if (typeof Symbol !== 'function' || !Symbol.iterator) {\n return '@@iterator' as any;\n }\n\n return Symbol.iterator;\n}\n\nexport const iterator = getSymbolIterator();\n", "import { iterator as Symbol_iterator } from '../symbol/iterator';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being an Iterable */\nexport function isIterable(input: any): input is Iterable {\n return isFunction(input?.[Symbol_iterator]);\n}\n", "import { ReadableStreamLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport async function* readableStreamLikeToAsyncGenerator(readableStream: ReadableStreamLike): AsyncGenerator {\n const reader = readableStream.getReader();\n try {\n while (true) {\n const { value, done } = await reader.read();\n if (done) {\n return;\n }\n yield value!;\n }\n } finally {\n reader.releaseLock();\n }\n}\n\nexport function isReadableStreamLike(obj: any): obj is ReadableStreamLike {\n // We don't want to use instanceof checks because they would return\n // false for instances from another Realm, like an