Targets

targets keeps goals: a sales quota per rep per quarter, a number of completed work items per team per sprint, cash collected per month. Each target names a metric, a period, an owner or team when it isn't for the whole organization, and a goal. The database computes the progress of the metrics the other blocks own, and the app keeps the value of any other metric.

Reading needs targets.read, and setting targets needs targets.manage. Admins get both, and members get targets.read.

better-supabase add goals

The module needs memberships and access.

import { createGoals } from "better-supabase/blocks/goals";

const targets = createGoals({ transport });
await targets
  .upsert(organizationId, {
    name: "Q4 quota",
    metric: "deals.won_amount",
    ownerId: repId,
    currency: "EUR",
    goal: 60_000_000n,
    periodStart: Temporal.PlainDate.from("2026-10-01"),
    periodEnd: Temporal.PlainDate.from("2026-12-31"),
  })
  .orThrow();

const running = await targets
  .progress(organizationId, { ownerId: repId })
  .orThrow();
// [{ name: "Q4 quota", progress: 18_400_000n, attainment: 0.3067, ... }]

MetricsCopy Anchor Link

progress(organizationId, { on, ownerId }) returns the targets whose period contains on (today by default), with progress and attainment (progress over goal). Goals and progress are bigint values (minor units for money metrics) with no currency of their own, sent as text so they stay exact past 2^53. Progress reads run as the caller, so they count what the caller can see. The deals forecast takes a target as its period goal.

ErrorsCopy Anchor Link

Your own columnsCopy Anchor Link

Add columns to the target table with blocks.goals.options.extraColumns (column name to SQL type), then pass a Standard Schema for them as fields. upsert validates and writes them, and upsert and progress return them parsed under fields. The block also takes hooks around its methods; see extending blocks.

import { createGoals } from "better-supabase/blocks/goals";
import { z } from "zod";

const client = createGoals({
  transport,
  fields: z.object({ priority: z.enum(["low", "high"]) }),
});