Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
import { FREE_FLY_REGIONS } from "@openstatus/regions";
import { z } from "zod";
import { monitorPeriodicitySchema, monitorRegionSchema } from "../constants";
// REMINDER: this is not a database table but just a schema for the limits of the plan
// default values are set to the free plan limits
export const limitsSchema = z.object({
version: z.undefined().optional(),
/**
* Monitor limits
*/
monitors: z.number().prefault(1),
"synthetic-checks": z.number().prefault(30), // monthly limits
periodicity: monitorPeriodicitySchema.array().prefault(["10m", "30m", "1h"]),
"multi-region": z.boolean().prefault(true),
"max-regions": z.number().prefault(6),
"data-retention": z
.enum(["14 days", "3 months", "12 months", "24 months"])
.prefault("14 days"),
regions: monitorRegionSchema.array().prefault(FREE_FLY_REGIONS),
"private-locations": z.boolean().prefault(false),
screenshots: z.boolean().prefault(false),
"response-logs": z.boolean().prefault(false),
otel: z.boolean().prefault(false),
/**
* Status page limits
*/
"status-pages": z.number().prefault(1),
"page-components": z.number().prefault(3),
maintenance: z.boolean().prefault(true),
"monitor-values-visibility": z.boolean().prefault(true),
"uptime-history": z.boolean().prefault(false),
"status-subscribers": z.boolean().prefault(false),
"custom-domain": z.boolean().prefault(false),
i18n: z.boolean().prefault(false),
"password-protection": z.boolean().prefault(false),
"email-domain-protection": z.boolean().prefault(false), // add-on but required in limits
"ip-restriction": z.boolean().prefault(false), // add-on but required in limits
"white-label": z.boolean().prefault(false),
"no-index": z.boolean().prefault(false),
"custom-theme": z.boolean().prefault(false),
/**
* Notification limits
*/
notifications: z.boolean().prefault(true),
pagerduty: z.boolean().prefault(false),
opsgenie: z.boolean().prefault(false),
"grafana-oncall": z.boolean().prefault(false),
whatsapp: z.boolean().prefault(false),
sms: z.boolean().prefault(false),
"sms-limit": z.number().prefault(0),
"notification-channels": z.number().prefault(1),
/**
* Collaboration limits
*/
members: z.literal("Unlimited").or(z.number()).prefault(1),
"audit-log": z.boolean().prefault(false),
sso: z.boolean().prefault(false), // add-on but required in limits
/**
* Other limits
*/
"slack-agent": z.boolean().prefault(false),
});
export type Limits = z.infer<typeof limitsSchema>;
//
const priceSchema = z.object({
USD: z.number(),
EUR: z.number(),
});
export type Price = z.infer<typeof priceSchema>;
export const billingIntervals = ["monthly", "yearly"] as const;
export type BillingInterval = (typeof billingIntervals)[number];
const intervalPriceSchema = z.object({
monthly: priceSchema,
yearly: priceSchema,
});
export type IntervalPrice = z.infer<typeof intervalPriceSchema>;
export const addons = [
"email-domain-protection",
"ip-restriction",
"white-label",
"custom-theme",
"status-pages",
"monitors",
"sso",
] as const satisfies Partial<keyof Limits>[];
// Declares which add-ons are sold by quantity, what one subscription unit grants
// and the self-serve ceiling. Both keys are also service `LimitKey`s, which is
// what lets the purchase guard count current usage for them.
export const addonQuantityConfig = {
"status-pages": { packSize: 1, maxQuantity: null },
monitors: { packSize: 10, maxQuantity: 10 },
} as const satisfies Partial<
Record<
(typeof addons)[number],
{ packSize: number; maxQuantity: number | null }
>
>;
export type AddonQuantityKey = keyof typeof addonQuantityConfig;
export const addonsSchema = z.partialRecord(
z.enum(addons),
z.object({
price: priceSchema,
}),
) satisfies z.ZodType<Partial<Record<keyof Limits, { price: Price }>>>;
export type Addons = z.infer<typeof addonsSchema>;
// Addon flags can be true at the plan level when the plan bundles the addon
// by default (e.g. Scale includes white-label / magic-link / IP restriction).
// Otherwise they default to false and are flipped on via the addon purchase flow.
export type PlanLimits = Limits;