@openscd/oscd-api
v0.1.6
Published
OpenSCD API for IEC 61850 SCL files
Readme
OpenSCD API
This package defines a common set of APIs, types, and interfaces for use by OpenSCD distributions and plugins.
It does not contain any business logic or implementation—only the shared contracts that enable interoperability between OpenSCD core, plugins, and distribution builders.
Purpose
For Plugin Developers:
Provides the types and event interfaces needed to build plugins that integrate seamlessly with OpenSCD core.
See docs/plugin-api.md for a detailed description of the plugin API.For Distribution Builders:
Supplies the types and interfaces for the OpenSCD root element and other extension points.
API documentation for the OpenSCD root element and constraints forplugin.jsonwill be provided in future docs.
Documentation
Plugin API:
Comprehensive guide for plugin authors, including property contracts, event types, and theming.Additional documentation (e.g., for the OpenSCD root element and
plugin.jsonconstraints) will be added soon.
