@metreeca/keep-flake

Shape-driven traversal trees for connectors of the @metreeca/keep model-driven linked data storage framework.

Gathers a resource shape and its optional retrieval template or collection query into a single traversal tree. A connector walks that tree directly, instead of matching the raw shape against the raw request at every step. As everywhere in the framework, the tree is driven entirely by the supplied resource shape, with no hardcoded property names or dataset-specific assumptions.

Installation

npm install @metreeca/keep-flake

Usage

[!NOTE]

This section introduces essential concepts; for complete coverage, see the API reference.

This package serves connector authors building backends for @metreeca/keep. Connectors depending on it pull it in automatically, so application code does not normally install it directly.

The package builds three flavours of traversal tree:

• shape — the full structural reach of a resource shape, for operations driven by the shape alone, such as mutations
• model — the properties a retrieval template addresses, each with the retrieval requested for it
• query — a collection member shape tagged with the constraints, ordering, pagination, and projections a collection query states

Support

• open an issue to report a problem or to suggest a new feature
• start a discussion to ask a how-to question or to share an idea

License

This project is licensed under the Apache 2.0 License – see LICENSE file for details.