@ninedeploy/schemas 0.16.7 → 0.16.9

package/dist/uptime.d.ts

@@ -0,0 +1,204 @@
+import { z } from 'zod';
+/**
+ * 0.16.8 uptime monitors and public status pages.
+ *
+ * A monitor probes a target from the panel host on an interval: an HTTP(S)
+ * URL (status code, optional keyword in the body) or a TCP `host:port`. Its
+ * state goes up / down after `failuresBeforeDown` failed checks in a row, and
+ * every transition is an `alert.monitor_down` / `alert.monitor_up` event on
+ * the existing notification channels. A status page shows a chosen set of
+ * monitors publicly, by name only (never the target).
+ */
+export declare const MONITOR_KINDS: readonly ['http', 'tcp'];
+export declare const monitorKind: z.ZodEnum<{
+    http: "http";
+    tcp: "tcp";
+}>;
+export type MonitorKind = z.infer<typeof monitorKind>;
+export declare const MONITOR_METHODS: readonly ['GET', 'HEAD'];
+export declare const monitorMethod: z.ZodEnum<{
+    GET: "GET";
+    HEAD: "HEAD";
+}>;
+export declare const MONITOR_STATUSES: readonly ['pending', 'up', 'down', 'paused'];
+export type MonitorStatus = (typeof MONITOR_STATUSES)[number];
+export declare const MONITOR_INTERVAL_MIN = 30;
+export declare const MONITOR_INTERVAL_MAX = 3600;
+export declare const MONITOR_TIMEOUT_MAX = 60;
+export declare const MONITOR_FAILURES_MAX = 10;
+export declare const MONITOR_KEYWORD_MAX = 200;
+/** Status pages show at most this many monitors. */
+export declare const STATUS_PAGE_MONITORS_MAX = 50;
+/** Days of history a status page shows. */
+export declare const STATUS_PAGE_DAYS = 90;
+export declare const DEFAULT_EXPECTED_STATUS = "200-399";
+/**
+ * The status codes an HTTP check accepts: comma-separated codes and ranges,
+ * each between 100 and 599 (`200-299`, `200,204,301-302`). Null when the
+ * text is not such a list.
+ */
+export declare function parseExpectedStatus(spec: string): Array<[number, number]> | null;
+/** Whether `code` is one of the codes `spec` accepts (an invalid spec accepts none). */
+export declare function statusMatches(code: number, spec: string): boolean;
+/** `host:port` for a TCP check: a hostname, an IPv4 address or a bracketed IPv6 address, and a port 1–65535. */
+export declare function parseTcpTarget(target: string): {
+    host: string;
+    port: number;
+} | null;
+/** Why `target` is not valid for `kind`, or null. */
+export declare function monitorTargetProblem(kind: MonitorKind, target: string): string | null;
+/** `POST /v1/monitors` (operator). */
+export declare const monitorCreate: z.ZodObject<{
+    name: z.ZodString;
+    kind: z.ZodEnum<{
+        http: "http";
+        tcp: "tcp";
+    }>;
+    target: z.ZodString;
+    serviceId: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+    method: z.ZodDefault<z.ZodEnum<{
+        GET: "GET";
+        HEAD: "HEAD";
+    }>>;
+    expectedStatus: z.ZodDefault<z.ZodString>;
+    keyword: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    intervalSeconds: z.ZodDefault<z.ZodNumber>;
+    timeoutSeconds: z.ZodDefault<z.ZodNumber>;
+    failuresBeforeDown: z.ZodDefault<z.ZodNumber>;
+    followRedirects: z.ZodDefault<z.ZodBoolean>;
+    verifyTls: z.ZodDefault<z.ZodBoolean>;
+    enabled: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strict>;
+export type MonitorCreateInput = z.input<typeof monitorCreate>;
+export type MonitorCreate = z.infer<typeof monitorCreate>;
+/**
+ * `PATCH /v1/monitors/:id` (operator). Partial; the route checks the merged
+ * kind, target, method and keyword with {@link monitorTargetProblem} again.
+ */
+export declare const monitorPatch: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    serviceId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    kind: z.ZodOptional<z.ZodEnum<{
+        http: "http";
+        tcp: "tcp";
+    }>>;
+    target: z.ZodOptional<z.ZodString>;
+    method: z.ZodOptional<z.ZodEnum<{
+        GET: "GET";
+        HEAD: "HEAD";
+    }>>;
+    expectedStatus: z.ZodOptional<z.ZodString>;
+    keyword: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    intervalSeconds: z.ZodOptional<z.ZodNumber>;
+    timeoutSeconds: z.ZodOptional<z.ZodNumber>;
+    failuresBeforeDown: z.ZodOptional<z.ZodNumber>;
+    followRedirects: z.ZodOptional<z.ZodBoolean>;
+    verifyTls: z.ZodOptional<z.ZodBoolean>;
+    enabled: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+export type MonitorPatch = z.infer<typeof monitorPatch>;
+/** A monitor as the API returns it. */
+export interface MonitorView {
+    id: number;
+    name: string;
+    serviceId: number | null;
+    kind: MonitorKind;
+    target: string;
+    method: 'GET' | 'HEAD';
+    expectedStatus: string;
+    keyword: string | null;
+    intervalSeconds: number;
+    timeoutSeconds: number;
+    failuresBeforeDown: number;
+    followRedirects: boolean;
+    verifyTls: boolean;
+    enabled: boolean;
+    status: MonitorStatus;
+    /** When the status last changed. */
+    statusSince: string | null;
+    consecutiveFailures: number;
+    lastCheckedAt: string | null;
+    lastResponseMs: number | null;
+    lastStatusCode: number | null;
+    lastError: string | null;
+    /** https: when the certificate the last check saw expires. */
+    certExpiresAt: string | null;
+    /** Share of successful checks, 0–100 with two decimals; null without checks. */
+    uptime: {
+        h24: number | null;
+        d7: number | null;
+        d30: number | null;
+    };
+    createdAt: string;
+}
+/** One check result. */
+export interface MonitorCheckView {
+    ts: string;
+    ok: boolean;
+    responseMs: number | null;
+    statusCode: number | null;
+    error: string | null;
+}
+/** A status page slug: lowercase letters, digits and dashes. */
+export declare const statusPageSlug: z.ZodString;
+/** `POST /v1/status-pages` (operator). */
+export declare const statusPageCreate: z.ZodObject<{
+    slug: z.ZodString;
+    title: z.ZodString;
+    description: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    notice: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    published: z.ZodDefault<z.ZodBoolean>;
+    showResponseTimes: z.ZodDefault<z.ZodBoolean>;
+    monitorIds: z.ZodDefault<z.ZodArray<z.ZodNumber>>;
+}, z.core.$strict>;
+export type StatusPageCreateInput = z.input<typeof statusPageCreate>;
+/** `PATCH /v1/status-pages/:id` (operator). */
+export declare const statusPagePatch: z.ZodObject<{
+    slug: z.ZodOptional<z.ZodString>;
+    title: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    notice: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    published: z.ZodOptional<z.ZodBoolean>;
+    showResponseTimes: z.ZodOptional<z.ZodBoolean>;
+    monitorIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+}, z.core.$strict>;
+export type StatusPagePatch = z.infer<typeof statusPagePatch>;
+export interface StatusPageView {
+    id: number;
+    slug: string;
+    title: string;
+    description: string | null;
+    notice: string | null;
+    published: boolean;
+    showResponseTimes: boolean;
+    monitorIds: number[];
+    /** Path of the public page on the panel. */
+    path: string;
+    createdAt: string;
+}
+/** One day of a monitor's history on a public status page. */
+export interface PublicStatusDay {
+    /** `YYYY-MM-DD`, UTC. */
+    day: string;
+    /** Null: no checks that day. */
+    uptime: number | null;
+}
+/** `GET /v1/status/:slug`: what a public status page shows. Never a target. */
+export interface PublicStatusPage {
+    title: string;
+    description: string | null;
+    notice: string | null;
+    /** `operational` when every monitor is up, `degraded` when some are down, `down` when all are. */
+    overall: 'operational' | 'degraded' | 'down' | 'unknown';
+    monitors: Array<{
+        name: string;
+        status: 'up' | 'down' | 'unknown';
+        uptime90d: number | null;
+        avgResponseMs: number | null;
+        days: PublicStatusDay[];
+    }>;
+    generatedAt: string;
+}
+/** The overall state of a status page from its monitors' states. */
+export declare function overallStatus(states: Array<'up' | 'down' | 'unknown'>): PublicStatusPage['overall'];
+//# sourceMappingURL=uptime.d.ts.map

package/dist/uptime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uptime.d.ts","sourceRoot":"","sources":["../src/uptime.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;;;;;;GASG;AAEH,eAAO,MAAM,aAAa,YAAI,MAAM,EAAE,KAAK,CAAU,CAAC;AACtD,eAAO,MAAM,WAAW;;;EAAwB,CAAC;AACjD,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAEtD,eAAO,MAAM,eAAe,YAAI,KAAK,EAAE,MAAM,CAAU,CAAC;AACxD,eAAO,MAAM,aAAa;;;EAA0B,CAAC;AAErD,eAAO,MAAM,gBAAgB,YAAI,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAU,CAAC;AAC7E,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE9D,eAAO,MAAM,oBAAoB,KAAK,CAAC;AACvC,eAAO,MAAM,oBAAoB,OAAO,CAAC;AACzC,eAAO,MAAM,mBAAmB,KAAK,CAAC;AACtC,eAAO,MAAM,oBAAoB,KAAK,CAAC;AACvC,eAAO,MAAM,mBAAmB,MAAM,CAAC;AACvC,oDAAoD;AACpD,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAC3C,2CAA2C;AAC3C,eAAO,MAAM,gBAAgB,KAAK,CAAC;AACnC,eAAO,MAAM,uBAAuB,YAAY,CAAC;AAEjD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,IAAI,CAahF;AAED,wFAAwF;AACxF,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAGjE;AAED,gHAAgH;AAChH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAOpF;AAED,qDAAqD;AACrD,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAMrF;AAwCD,sCAAsC;AACtC,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;kBAeC,CAAC;AAC5B,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAC/D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;kBAAsE,CAAC;AAChG,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAExD,uCAAuC;AACvC,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,OAAO,CAAC;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,aAAa,CAAC;IACtB,oCAAoC;IACpC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,8DAA8D;IAC9D,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,gFAAgF;IAChF,MAAM,EAAE;QAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IACtE,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,wBAAwB;AACxB,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,OAAO,CAAC;IACZ,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,gEAAgE;AAChE,eAAO,MAAM,cAAc,aAK8F,CAAC;AAkB1H,0CAA0C;AAC1C,eAAO,MAAM,gBAAgB;;;;;;;;kBASlB,CAAC;AACZ,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAErE,+CAA+C;AAC/C,eAAO,MAAM,eAAe;;;;;;;;kBAAgD,CAAC;AAC7E,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAE9D,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;IACnB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,8DAA8D;AAC9D,MAAM,WAAW,eAAe;IAC9B,yBAAyB;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,gCAAgC;IAChC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,+EAA+E;AAC/E,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,kGAAkG;IAClG,OAAO,EAAE,aAAa,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;IACzD,QAAQ,EAAE,KAAK,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,IAAI,GAAG,MAAM,GAAG,SAAS,CAAC;QAClC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,IAAI,EAAE,eAAe,EAAE,CAAC;KACzB,CAAC,CAAC;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,oEAAoE;AACpE,wBAAgB,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,GAAG,MAAM,GAAG,SAAS,CAAC,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAMnG"}

package/dist/uptime.js

@@ -0,0 +1,180 @@
+import { z } from 'zod';
+import { id } from './common.js';
+/**
+ * 0.16.8 uptime monitors and public status pages.
+ *
+ * A monitor probes a target from the panel host on an interval: an HTTP(S)
+ * URL (status code, optional keyword in the body) or a TCP `host:port`. Its
+ * state goes up / down after `failuresBeforeDown` failed checks in a row, and
+ * every transition is an `alert.monitor_down` / `alert.monitor_up` event on
+ * the existing notification channels. A status page shows a chosen set of
+ * monitors publicly, by name only (never the target).
+ */
+export const MONITOR_KINDS = ['http', 'tcp'];
+export const monitorKind = z.enum(MONITOR_KINDS);
+export const MONITOR_METHODS = ['GET', 'HEAD'];
+export const monitorMethod = z.enum(MONITOR_METHODS);
+export const MONITOR_STATUSES = ['pending', 'up', 'down', 'paused'];
+export const MONITOR_INTERVAL_MIN = 30;
+export const MONITOR_INTERVAL_MAX = 3600;
+export const MONITOR_TIMEOUT_MAX = 60;
+export const MONITOR_FAILURES_MAX = 10;
+export const MONITOR_KEYWORD_MAX = 200;
+/** Status pages show at most this many monitors. */
+export const STATUS_PAGE_MONITORS_MAX = 50;
+/** Days of history a status page shows. */
+export const STATUS_PAGE_DAYS = 90;
+export const DEFAULT_EXPECTED_STATUS = '200-399';
+/**
+ * The status codes an HTTP check accepts: comma-separated codes and ranges,
+ * each between 100 and 599 (`200-299`, `200,204,301-302`). Null when the
+ * text is not such a list.
+ */
+export function parseExpectedStatus(spec) {
+    const parts = spec.split(',').map((p) => p.trim());
+    if (parts.length === 0 || parts.length > 20)
+        return null;
+    const ranges = [];
+    for (const part of parts) {
+        const m = /^(\d{3})(?:-(\d{3}))?$/.exec(part);
+        if (!m)
+            return null;
+        const lo = Number(m[1]);
+        const hi = m[2] === undefined ? lo : Number(m[2]);
+        if (lo < 100 || hi > 599 || lo > hi)
+            return null;
+        ranges.push([lo, hi]);
+    }
+    return ranges;
+}
+/** Whether `code` is one of the codes `spec` accepts (an invalid spec accepts none). */
+export function statusMatches(code, spec) {
+    const ranges = parseExpectedStatus(spec);
+    return ranges !== null && ranges.some(([lo, hi]) => code >= lo && code <= hi);
+}
+/** `host:port` for a TCP check: a hostname, an IPv4 address or a bracketed IPv6 address, and a port 1–65535. */
+export function parseTcpTarget(target) {
+    const m = /^(\[[0-9A-Fa-f:.]+\]|[A-Za-z0-9](?:[A-Za-z0-9.-]{0,251}[A-Za-z0-9])?):(\d{1,5})$/.exec(target);
+    if (!m)
+        return null;
+    const port = Number(m[2]);
+    if (port < 1 || port > 65535)
+        return null;
+    const host = m[1].startsWith('[') ? m[1].slice(1, -1) : m[1];
+    return { host, port };
+}
+/** Why `target` is not valid for `kind`, or null. */
+export function monitorTargetProblem(kind, target) {
+    if (kind === 'tcp')
+        return parseTcpTarget(target) ? null : 'a TCP target is host:port (an IPv6 address in brackets)';
+    if (!httpUrl.safeParse(target).success)
+        return 'an HTTP target is an http:// or https:// URL';
+    // userinfo is everything between `//` and an `@` before the first `/`, `?` or `#`.
+    if (/^https?:\/\/[^/?#]*@/i.test(target))
+        return 'credentials in the URL are not allowed';
+    return null;
+}
+const httpUrl = z.url({ protocol: /^https?$/ });
+const monitorFields = {
+    name: z.string().trim().min(1).max(100),
+    /** The service the monitor belongs to (members who can see it see the monitor), or null for an operator-only monitor. */
+    serviceId: id.nullable(),
+    kind: monitorKind,
+    /** http: the URL; tcp: `host:port`. */
+    target: z.string().trim().min(1).max(2048),
+    method: monitorMethod,
+    /** http: accepted status codes, see {@link parseExpectedStatus}. */
+    expectedStatus: z
+        .string()
+        .trim()
+        .max(200)
+        .refine((v) => parseExpectedStatus(v) !== null, 'codes and ranges between 100 and 599, such as 200-299,301'),
+    /** http: text the body must contain (the first 1 MiB is read). */
+    keyword: z.string().max(MONITOR_KEYWORD_MAX).nullable(),
+    intervalSeconds: z.number().int().min(MONITOR_INTERVAL_MIN).max(MONITOR_INTERVAL_MAX),
+    timeoutSeconds: z.number().int().min(1).max(MONITOR_TIMEOUT_MAX),
+    failuresBeforeDown: z.number().int().min(1).max(MONITOR_FAILURES_MAX),
+    followRedirects: z.boolean(),
+    /** http: false accepts a self-signed or expired certificate. */
+    verifyTls: z.boolean(),
+    enabled: z.boolean(),
+};
+function checkTarget(v, ctx) {
+    if (v.kind !== undefined && v.target !== undefined) {
+        const problem = monitorTargetProblem(v.kind, v.target);
+        if (problem)
+            ctx.addIssue({ code: 'custom', path: ['target'], message: problem });
+    }
+    if (v.kind === 'tcp' && v.keyword)
+        ctx.addIssue({ code: 'custom', path: ['keyword'], message: 'a keyword applies to HTTP checks' });
+    if (v.method === 'HEAD' && v.keyword)
+        ctx.addIssue({ code: 'custom', path: ['keyword'], message: 'a HEAD request has no body to search; use GET' });
+}
+/** `POST /v1/monitors` (operator). */
+export const monitorCreate = z
+    .object({
+    ...monitorFields,
+    serviceId: monitorFields.serviceId.default(null),
+    method: monitorFields.method.default('GET'),
+    expectedStatus: monitorFields.expectedStatus.default(DEFAULT_EXPECTED_STATUS),
+    keyword: monitorFields.keyword.default(null),
+    intervalSeconds: monitorFields.intervalSeconds.default(60),
+    timeoutSeconds: monitorFields.timeoutSeconds.default(10),
+    failuresBeforeDown: monitorFields.failuresBeforeDown.default(2),
+    followRedirects: monitorFields.followRedirects.default(true),
+    verifyTls: monitorFields.verifyTls.default(true),
+    enabled: monitorFields.enabled.default(true),
+})
+    .strict()
+    .superRefine(checkTarget);
+/**
+ * `PATCH /v1/monitors/:id` (operator). Partial; the route checks the merged
+ * kind, target, method and keyword with {@link monitorTargetProblem} again.
+ */
+export const monitorPatch = z.object(monitorFields).partial().strict().superRefine(checkTarget);
+/** A status page slug: lowercase letters, digits and dashes. */
+export const statusPageSlug = z
+    .string()
+    .trim()
+    .min(1)
+    .max(64)
+    .regex(/^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/, 'lowercase letters, digits and dashes, not starting or ending with a dash');
+const statusPageFields = {
+    slug: statusPageSlug,
+    title: z.string().trim().min(1).max(100),
+    description: z.string().trim().max(500).nullable(),
+    /** A notice shown at the top (maintenance, an incident), or null. */
+    notice: z.string().trim().max(1000).nullable(),
+    /** Off: the page answers 404 to everyone. */
+    published: z.boolean(),
+    showResponseTimes: z.boolean(),
+    /** In display order, each once. */
+    monitorIds: z
+        .array(id)
+        .max(STATUS_PAGE_MONITORS_MAX)
+        .refine((ids) => new Set(ids).size === ids.length, 'each monitor once'),
+};
+/** `POST /v1/status-pages` (operator). */
+export const statusPageCreate = z
+    .object({
+    ...statusPageFields,
+    description: statusPageFields.description.default(null),
+    notice: statusPageFields.notice.default(null),
+    published: statusPageFields.published.default(false),
+    showResponseTimes: statusPageFields.showResponseTimes.default(true),
+    monitorIds: statusPageFields.monitorIds.default([]),
+})
+    .strict();
+/** `PATCH /v1/status-pages/:id` (operator). */
+export const statusPagePatch = z.object(statusPageFields).partial().strict();
+/** The overall state of a status page from its monitors' states. */
+export function overallStatus(states) {
+    const known = states.filter((s) => s !== 'unknown');
+    if (known.length === 0)
+        return 'unknown';
+    const down = known.filter((s) => s === 'down').length;
+    if (down === 0)
+        return 'operational';
+    return down === known.length ? 'down' : 'degraded';
+}
+//# sourceMappingURL=uptime.js.map

package/dist/uptime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uptime.js","sourceRoot":"","sources":["../src/uptime.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAEjC;;;;;;;;;GASG;AAEH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,KAAK,CAAU,CAAC;AACtD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;AAGjD,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,KAAK,EAAE,MAAM,CAAU,CAAC;AACxD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;AAErD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAU,CAAC;AAG7E,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AACvC,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,CAAC;AACzC,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AACtC,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AACvC,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AACvC,oDAAoD;AACpD,MAAM,CAAC,MAAM,wBAAwB,GAAG,EAAE,CAAC;AAC3C,2CAA2C;AAC3C,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AACnC,MAAM,CAAC,MAAM,uBAAuB,GAAG,SAAS,CAAC;AAEjD;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAY;IAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACnD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE;QAAE,OAAO,IAAI,CAAC;IACzD,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACpB,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACxB,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,IAAI,EAAE,GAAG,GAAG,IAAI,EAAE,GAAG,GAAG,IAAI,EAAE,GAAG,EAAE;YAAE,OAAO,IAAI,CAAC;QACjD,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,wFAAwF;AACxF,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,IAAY;IACtD,MAAM,MAAM,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACzC,OAAO,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC;AAChF,CAAC;AAED,gHAAgH;AAChH,MAAM,UAAU,cAAc,CAAC,MAAc;IAC3C,MAAM,CAAC,GAAG,kFAAkF,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1G,IAAI,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IACpB,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1B,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,KAAK;QAAE,OAAO,IAAI,CAAC;IAC1C,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC;IAChE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AACxB,CAAC;AAED,qDAAqD;AACrD,MAAM,UAAU,oBAAoB,CAAC,IAAiB,EAAE,MAAc;IACpE,IAAI,IAAI,KAAK,KAAK;QAAE,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,yDAAyD,CAAC;IACrH,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO;QAAE,OAAO,8CAA8C,CAAC;IAC9F,mFAAmF;IACnF,IAAI,uBAAuB,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,wCAAwC,CAAC;IAC1F,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;AAEhD,MAAM,aAAa,GAAG;IACpB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IACvC,yHAAyH;IACzH,SAAS,EAAE,EAAE,CAAC,QAAQ,EAAE;IACxB,IAAI,EAAE,WAAW;IACjB,uCAAuC;IACvC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;IAC1C,MAAM,EAAE,aAAa;IACrB,oEAAoE;IACpE,cAAc,EAAE,CAAC;SACd,MAAM,EAAE;SACR,IAAI,EAAE;SACN,GAAG,CAAC,GAAG,CAAC;SACR,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,2DAA2D,CAAC;IAC9G,kEAAkE;IAClE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,QAAQ,EAAE;IACvD,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC;IACrF,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC;IAChE,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC;IACrE,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE;IAC5B,gEAAgE;IAChE,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;IACtB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC;AAIF,SAAS,WAAW,CAAC,CAAe,EAAE,GAAoB;IACxD,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACnD,MAAM,OAAO,GAAG,oBAAoB,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;QACvD,IAAI,OAAO;YAAE,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IACD,IAAI,CAAC,CAAC,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,OAAO;QAAE,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,kCAAkC,EAAE,CAAC,CAAC;IACpI,IAAI,CAAC,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,CAAC,OAAO;QAAE,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,+CAA+C,EAAE,CAAC,CAAC;AACtJ,CAAC;AAED,sCAAsC;AACtC,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,MAAM,CAAC;IACN,GAAG,aAAa;IAChB,SAAS,EAAE,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC;IAChD,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;IAC3C,cAAc,EAAE,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,uBAAuB,CAAC;IAC7E,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;IAC5C,eAAe,EAAE,aAAa,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;IAC1D,cAAc,EAAE,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;IACxD,kBAAkB,EAAE,aAAa,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/D,eAAe,EAAE,aAAa,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC;IAC5D,SAAS,EAAE,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC;IAChD,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;CAC7C,CAAC;KACD,MAAM,EAAE;KACR,WAAW,CAAC,WAAW,CAAC,CAAC;AAI5B;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;AA2ChG,gEAAgE;AAChE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,EAAE;KACR,IAAI,EAAE;KACN,GAAG,CAAC,CAAC,CAAC;KACN,GAAG,CAAC,EAAE,CAAC;KACP,KAAK,CAAC,mCAAmC,EAAE,0EAA0E,CAAC,CAAC;AAE1H,MAAM,gBAAgB,GAAG;IACvB,IAAI,EAAE,cAAc;IACpB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IACxC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IAClD,qEAAqE;IACrE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE;IAC9C,6CAA6C;IAC7C,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;IACtB,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE;IAC9B,mCAAmC;IACnC,UAAU,EAAE,CAAC;SACV,KAAK,CAAC,EAAE,CAAC;SACT,GAAG,CAAC,wBAAwB,CAAC;SAC7B,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC;CAC1E,CAAC;AAEF,0CAA0C;AAC1C,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,MAAM,CAAC;IACN,GAAG,gBAAgB;IACnB,WAAW,EAAE,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC;IACvD,MAAM,EAAE,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;IAC7C,SAAS,EAAE,gBAAgB,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC;IACpD,iBAAiB,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC;IACnE,UAAU,EAAE,gBAAgB,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;CACpD,CAAC;KACD,MAAM,EAAE,CAAC;AAGZ,+CAA+C;AAC/C,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;AA0C7E,oEAAoE;AACpE,MAAM,UAAU,aAAa,CAAC,MAAwC;IACpE,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;IACpD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACzC,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,MAAM,CAAC;IACtD,IAAI,IAAI,KAAK,CAAC;QAAE,OAAO,aAAa,CAAC;IACrC,OAAO,IAAI,KAAK,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC;AACrD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ninedeploy/schemas",
-  "version": "0.16.7",
+  "version": "0.16.9",
   "description": "Shared Zod schemas and validation types for NineDeploy",
   "license": "MIT",
   "repository": {

package/src/canary.ts

@@ -0,0 +1,95 @@
+import { z } from 'zod';
+
+/**
+ * 0.16.9 canary releases.
+ *
+ * A docker service with a canary configuration does not switch all of its
+ * traffic to a new release at once. After the new container passes its
+ * healthcheck, Traefik sends it `steps[0]` percent of the requests, then each
+ * following step, for `stepSeconds` each, and the deploy finishes at 100 %.
+ * Each step is judged on the new release's healthcheck and, when traffic
+ * analytics is on, on its share of 5xx responses and its p95 latency. A step
+ * that fails sends every request back to the previous release and fails the
+ * deploy, which leaves the previous release serving, as any failed deploy does.
+ */
+
+export const CANARY_STEPS_MAX = 5;
+export const CANARY_STEP_SECONDS_MIN = 30;
+export const CANARY_STEP_SECONDS_MAX = 3600;
+export const CANARY_DEFAULT_STEPS = [10, 50] as const;
+export const CANARY_DEFAULT_STEP_SECONDS = 120;
+export const CANARY_DEFAULT_MAX_ERROR_RATE = 5;
+export const CANARY_DEFAULT_MIN_REQUESTS = 20;
+
+export const canaryConfig = z
+  .object({
+    /** Percent of the requests the new release gets at each step, ascending, 1–99. */
+    steps: z
+      .array(z.number().int().min(1).max(99))
+      .min(1)
+      .max(CANARY_STEPS_MAX)
+      .refine((s) => s.every((v, i) => i === 0 || v > s[i - 1]!), 'Canary steps must go up, for example 10, 50'),
+    /** How long each step runs before it is judged. */
+    stepSeconds: z.number().int().min(CANARY_STEP_SECONDS_MIN).max(CANARY_STEP_SECONDS_MAX).default(CANARY_DEFAULT_STEP_SECONDS),
+    /** The highest share of 5xx responses, in percent, the new release may answer with. */
+    maxErrorRate: z.number().min(0).max(100).default(CANARY_DEFAULT_MAX_ERROR_RATE),
+    /** The highest p95 response time, in ms, the new release may have; null = not judged. */
+    maxP95Ms: z.number().int().min(10).max(600_000).nullable().default(null),
+    /** Fewer requests than this in a step are too few to judge the error rate and latency. */
+    minRequests: z.number().int().min(1).max(1_000_000).default(CANARY_DEFAULT_MIN_REQUESTS),
+  })
+  .strict();
+export type CanaryConfig = z.infer<typeof canaryConfig>;
+export type CanaryConfigInput = z.input<typeof canaryConfig>;
+
+/** What one step measured on one release. */
+export interface CanaryReleaseStats {
+  requests: number;
+  /** Responses with a 5xx status. */
+  errors: number;
+  /** Percent of the requests that were errors; null with no requests. */
+  errorRate: number | null;
+  /** p95 response time in ms; null with no requests. */
+  p95Ms: number | null;
+}
+
+/** `GET /v1/services/:id/canary`: the canary of a deploy in progress, or `active: false`. */
+export interface CanaryStatusView {
+  active: boolean;
+  deploymentId?: number;
+  /** 1-based step running now, and how many there are. */
+  step?: number;
+  steps?: number;
+  /** Percent of the requests the new release gets now. */
+  weight?: number;
+  stepStartedAt?: string;
+  stepEndsAt?: string;
+  /** False when traffic analytics is off: steps are judged on the healthcheck only. */
+  measured?: boolean;
+  canary?: CanaryReleaseStats;
+  stable?: CanaryReleaseStats;
+  /** A promote was asked for and is being applied. */
+  promoting?: boolean;
+}
+
+/** Percent of `errors` in `requests`, rounded to two decimals; null with no requests. */
+export function errorRatePercent(errors: number, requests: number): number | null {
+  if (requests <= 0) return null;
+  return Math.round((errors / requests) * 10_000) / 100;
+}
+
+/**
+ * Why a step's numbers fail the configuration, or null when they pass. Too
+ * few requests pass: there is not enough traffic to judge, and the step is
+ * left to the healthcheck.
+ */
+export function canaryStepProblem(stats: CanaryReleaseStats, cfg: Pick<CanaryConfig, 'maxErrorRate' | 'maxP95Ms' | 'minRequests'>): string | null {
+  if (stats.requests < cfg.minRequests) return null;
+  if (stats.errorRate != null && stats.errorRate > cfg.maxErrorRate) {
+    return `${stats.errorRate}% of ${stats.requests} requests failed with a 5xx (the limit is ${cfg.maxErrorRate}%)`;
+  }
+  if (cfg.maxP95Ms != null && stats.p95Ms != null && stats.p95Ms > cfg.maxP95Ms) {
+    return `p95 response time ${stats.p95Ms} ms over ${stats.requests} requests (the limit is ${cfg.maxP95Ms} ms)`;
+  }
+  return null;
+}

package/src/index.ts

@@ -30,3 +30,5 @@ export * from './accessGrants.js';
 export * from './multiNode.js';
 export * from './serviceFiles.js';
 export * from './dockerLabels.js';
+export * from './uptime.js';
+export * from './canary.js';

package/src/service.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { canaryConfig } from './canary.js';
 import { dockerLabels } from './dockerLabels.js';
 import { containerPath, dockerVolumeName, envVarName, gitBranch, gitRepoUrl, httpPath, providerBaseUrl, repoBaseDir, repoRelativePath, slug } from './common.js';
 
@@ -392,6 +393,8 @@ export const updateService = z.object({
   gitLfs: z.boolean().optional(),
   /** Operator only: advanced container options; null clears them all. */
   runtimeOptions: runtimeOptions.nullable().optional(),
+  /** 0.16.9: release new versions as a canary (docker services on the panel host); null turns it off. */
+  canary: canaryConfig.nullable().optional(),
   port: z.number().int().min(1).max(65535).optional(),
   publishedPort: z.number().int().min(1).max(65535).nullable().optional(),
   /** Extra host ports, TCP or UDP, single or ranges (docker services on the panel host); null or [] clears them. */
@@ -485,6 +488,8 @@ export const service = z.object({
   gitLfs: z.boolean().optional(),
   /** Advanced container options (0.16.1); null = none. */
   runtimeOptions: runtimeOptions.nullable().optional(),
+  /** Canary releases (0.16.9); null = every deploy switches all traffic at once. */
+  canary: canaryConfig.nullable().optional(),
   autoUrl: z.string().nullable(),
   port: z.number().int().nullable(),
   publishedPort: z.number().int().nullable().optional(),