forked from 1b-agent/opencadstudio-upstream
Sebastian
e41086b058
New crate crates/ocs_doc_api: object-centric facade (DocApi -> Document -> collections -> typed handles), transport-agnostic wire layer (DocApiEnvelope = single op | read-only query batch), per-op autocommit (no write transactions), bulk ops with upfront-validation all-or-nothing, structured ApiError, and build-time codegen (spec/entities.toml -> ops/query enums, api_reference.md, binding_schema.json). ocs_plugin_api: append-only PluginRequest::DocApiRequest / PluginResponse:: DocApiResponse (serde_bytes payload) + defaulted HostApi::doc_api_dispatch. Host: DocApiBackend impl for HostSession (src/app/doc_api.rs) mapping to scene primitives (solid_models lift-on-miss, register_prepared_solid_model, meshes metrics), entity conversions (doc_api_convert.rs), HostSession accessors + doc_api_dispatch override. Tests: 592 host lib (incl. 7 DocApi integration tests: create/boolean/query, unknown-id, transform-many all-or-nothing, query-batch cap, 2D/geometric/DWG roundtrips), 8 crate unit tests. Examples + README/ARCHITECTURE/IMPLEMENTATION docs.
45 lines
2.0 KiB
TOML
45 lines
2.0 KiB
TOML
[package]
|
|
name = "ocs_plugin_api"
|
|
version = "0.2.1"
|
|
edition = "2021"
|
|
description = "Stable, dependency-free contract for Open CAD Studio add-on packages: plugin manifest, version handshake, and ribbon/CadModule types."
|
|
license = "GPL-3.0-only"
|
|
|
|
[dependencies]
|
|
# Serde is used unconditionally by the build-time-generated embedded type
|
|
# registry types (`type_registry_types.rs`). The host feature no longer needs
|
|
# to enable it explicitly.
|
|
serde = { version = "1", features = ["derive"] }
|
|
|
|
# Pulled in only by the `host` feature, which adds the `acadrust`-typed
|
|
# `HostApi` runtime surface. The default crate stays dependency-free so engine
|
|
# crates and external tooling can depend on the manifest/ribbon contract cheaply.
|
|
acadrust = { git = "https://github.com/HakanSeven12/cadcodec.git", rev = "c91a1c1de89a0fbc006dc360ddb0251ac8c207d1", optional = true, features = ["serde"] }
|
|
|
|
# Runtime IPC and serialization (host feature only).
|
|
interprocess = { version = "2", optional = true }
|
|
bincode = { version = "1", optional = true }
|
|
serde_bytes = { version = "0.11", optional = true }
|
|
thiserror = { version = "1", optional = true }
|
|
libloading = { version = "0.8", optional = true }
|
|
memmap2 = { version = "0.9", optional = true }
|
|
rkyv = { version = "0.7", features = ["validation", "std"], optional = true }
|
|
getrandom = { version = "0.2", optional = true }
|
|
|
|
[features]
|
|
# Enables the runtime host surface (`HostApi` trait) and the out-of-process
|
|
# plugin runtime. The OpenCADStudio binary turns this on; pure-data consumers
|
|
# leave it off.
|
|
host = ["dep:acadrust", "dep:interprocess", "dep:bincode", "dep:serde_bytes", "dep:thiserror", "dep:libloading", "dep:memmap2", "dep:rkyv", "dep:getrandom"]
|
|
|
|
[build-dependencies]
|
|
serde-reflection = "0.6"
|
|
serde_json = "1"
|
|
serde = { version = "1", features = ["derive"] }
|
|
cargo-lock = "11"
|
|
# acadrust is scanned at build time to generate the embedded type registry.
|
|
acadrust = { git = "https://github.com/HakanSeven12/cadcodec.git", rev = "c91a1c1de89a0fbc006dc360ddb0251ac8c207d1", features = ["serde"] }
|
|
|
|
[dev-dependencies]
|
|
serde_json = "1"
|