Stable public surface

Version 1 contract

Applications can upgrade across compatible 1.x releases when they use the documented runtime, Web Component, and boundary-manifest contracts.

Frozen versions

IndiaMapEngine 1.0.0Configuration, methods, state classes, and bubbling DOM events. india-svg-map 1.0.0Five attributes plus the selection and engine JavaScript APIs. Registry schema 1.0.0Strict public boundary-layer catalog structure. Contribution schema 1.0.0Strict boundary contribution manifest structure.

Compatibility rule

Patch releases fix behavior. Minor releases may add optional capabilities without removing version 1 behavior. Removing, renaming, retyping, or reinterpreting a public member requires a major release and migration notes.

Public versus internal

The documented constructor options, methods, events, component members, schema fields, and stable identifiers are public. Underscore-prefixed methods, injected DOM structure, page-specific globals, tooling scripts, and undocumented CSS are internal implementation details.

Contributor gate

pnpm test:browser -- tests/browser/public-api.spec.js --workers=1
python -m unittest tests.test_public_contract -v

A proposed breaking change must update its version, migration notes, changelog, documentation, and contract tests together.

Complete reference

Read the map engine API, the boundary registry format, or the repository stability policy.