Appraisals

appraisals runs a performance review cycle. Opening a cycle gives each person an appraisal with a self review, a manager review and peer reviews. Once every review is in, a manager calibrates the rating and signs the appraisal off.

better-supabase add appraisals

import { createAppraisals } from "better-supabase/blocks/appraisals";

The module requires memberships, permissions and subjects. With enrollments a cycle follows a program and each stage marks a step. With forms a review keeps the id of the submission that holds the longer answers. With goals an appraisal looks back on goals. With approvals a sign-off waits for its request. With outbox it records the events, and with audit every change is audited.

TablesCopy Anchor Link

An appraisal is a subject of type appraisal. Writes go through the functions below.

A member without appraisals.read reads the appraisals about them or that they review, and only the reviews they wrote.

CyclesCopy Anchor Link

createCycle makes a draft cycle. openCycle creates an appraisal for each assignment: a self review, a manager review when managerId is set and one review per peer. Call it again to add people to an open cycle. A person who already has an appraisal keeps it.

const cycle = await db.appraisals
  .createCycle({
    name: "2031 review",
    startsOn: "2031-01-01",
    endsOn: "2031-03-31",
  })
  .orThrow();

await db.appraisals
  .openCycle(cycle.id, [{ subjectUserId, managerId, peerIds: [peerId] }])
  .orThrow();

closeCycle ends a cycle once every appraisal in it is signed off. listCycles lists the cycles.

Reviews and calibrationCopy Anchor Link

submitReview takes a rating from 1 to 5, optional comments and an optional submissionId from forms. Only the assigned reviewer submits. When the last review is in, the appraisal is reviewed and its rating is the average.

calibrate changes the rating of a reviewed appraisal in an open cycle and keeps the previous rating and the reason. setGoals replaces the goals the appraisal links to.

await db.appraisals
  .submitReview(reviewId, { rating: 4, comments: "Steady" })
  .orThrow();
await db.appraisals.calibrate(appraisalId, 3, "Matches the team bar").orThrow();

Sign-offCopy Anchor Link

signOff finishes a reviewed or calibrated appraisal. With approvals it files a request under the policy for sign_off (default: a holder of appraisals.manage) and the appraisal is awaiting_signoff until the request is approved, and goes back to its previous state when it is rejected. Without approvals, a holder of appraisals.manage signs it off directly.

const appraisal = await db.appraisals.signOff(appraisalId).orThrow();

EventsCopy Anchor Link

The hooks are before_appraisal_cycle_create and after_appraisal_cycle_create.