@boxxy/pepys
v0.2.4
Published
The pepys plug-in of boxxy, its fact sink and its report reader
Readme
The pepys plug-in of boxxy, with the fact sink that sends boxxy's facts to pepys and the reader that asks pepys for boxxy's two reports.
A pepys deployment lists the plug-in, and the boxxy server builds the sink and the reader. The
plug-in folds boxxy's facts into the boxxy_work tables and answers two queries: what an item cost
to land, and how long it spent in each step.
Install
Install the package and the pepys kit it plugs into from npm with Bun:
bun add @boxxy/pepys @pepys/kit zod@pepys/kit and zod are peer dependencies: the deployment's own copy is the one the plug-in uses.
The package runs on Bun 1.3 or newer.
Features
@boxxy/pepys: the plug-in parts,boxxySource,boxxyWorkConsumerandbuildBoxxyPlugin, and the query types.@boxxy/pepys/sink:createPepysFactSink, theFactSinkthat sends a batch of facts to pepys ingest.@boxxy/pepys/reader:createPepysReader, thePepysReaderthat runs the two queries.
Documentation
Facts and pepys in v1 describes the outbox, the
fact catalog, the boxxy_work package and the two queries.
