Maintenance

maintenance decides when equipment needs work. A plan falls due after a number of days or after a meter has advanced by a number of units, and the block then opens a dispatch work order with the plan's spare parts. It also keeps meter readings and calibration records.

better-supabase add maintenance

import { createMaintenance } from "better-supabase/blocks/maintenance";

The module requires memberships, permissions, subjects and dispatch. With assets a plan and a calibration point at the equipment, with inventory a spare part points at a stock variant, with outbox it records the events, and with audit every change is audited.

TablesCopy Anchor Link

Members with maintenance.read read every table. Writes go through the functions below. A plan is a subject of type maintenance_plan.

PlansCopy Anchor Link

createPlan takes a time plan with everyDays or a meter plan with a meterId and an everyValue. A time plan falls due everyDays days after the last completion, or after the plan was created. A meter plan falls due when the reading is everyValue units above the reading at the last completion.

const plan = await db.maintenance
  .createPlan({
    title: "Grease the press",
    kind: "meter",
    meterId,
    everyValue: "500",
    priority: "high",
    parts: [{ name: "Grease", quantity: 2, variantId }],
  })
  .orThrow();

updatePlan changes the title, interval, priority, asset, parts and status (active or paused). The kind and the meter stay. deletePlan removes a plan and its parts. listPlans filters by status, kind, assetId and due, and each plan carries its parts and whether it is due now.

Work ordersCopy Anchor Link

generateWorkOrders opens one dispatch work order for every active plan that is due and has none open, with the plan's parts on it, and returns the plan and work order ids. Call it on a schedule, for example from a cron route with the service role.

const opened = await db.maintenance.generateWorkOrders().orThrow();

When the work order reaches done, the plan records the completion and moves its next due date. A cancelled work order frees the plan to open another. The caller of generateWorkOrders needs maintenance.manage and the dispatch permission to create work orders; the service role needs neither.

Meters and calibrationsCopy Anchor Link

createMeter adds a meter and recordReading records a reading. A reading never goes below the latest one, and a reading with an older readAt stays in the history only. recordCalibration records the instrument, the result (pass, fail or adjusted) and when it is due again, and listCalibrations filters by asset and dueBefore.

await db.maintenance.recordReading(meterId, 1650).orThrow();

await db.maintenance
  .recordCalibration({
    instrument: "Scale",
    performedAt: Temporal.Now.instant(),
    dueAt: Temporal.Now.instant().add({ hours: 24 * 365 }),
    result: "pass",
  })
  .orThrow();

EventsCopy Anchor Link

The hooks are before_maintenance_plan_create and after_maintenance_plan_create.