better-supabase 0.13.0 → 0.14.0

package/dist/blocks/incidents/index.d.ts

@@ -0,0 +1,337 @@
+/// <reference lib="esnext.temporal" />
+import { T as ErrorMapper, t as AsyncResult } from "../../result-C6jDfedy.js";
+import { t as StandardSchemaV1 } from "../../standard-DbQsD2xZ.js";
+import { n as ExtraFields, r as FieldsOf } from "../../block-fields-3w4MZr8U.js";
+import { Ct as Events } from "../../events-DbLjvxDX.js";
+import { n as Logger } from "../../logger-DWVYUmwi.js";
+import { r as BlockTemporalOptions } from "../../block-helpers-BaugZlJV.js";
+import { a as dbTransport, i as RpcClient, o as rpcTransport, s as sqlTransport, t as BlockTransport } from "../../block-transport-d53POsem.js";
+import { a as BlockTransportMiddleware, d as extendBlock, f as withBlockHooks, n as BlockHooks, p as wrapTransport } from "../../block-hooks-CmjPKqQ_.js";
+import { c as BlockOf, rn as EntitySchema } from "../../define-block-COpcS6aT.js";
+//#region src/blocks/incidents/incidents.d.ts
+interface IncidentsOptions<S extends StandardSchemaV1 | undefined = undefined> extends BlockTemporalOptions {
+  readonly transport: BlockTransport;
+  /**
+   * The module schema, or its API schema: `defineBlocks` passes it from
+   * `blocks.generated.ts`.
+   */
+  readonly schema?: string;
+  /**
+   * A Standard Schema for the incident's extra columns
+   * (`blocks.incidents.options.extraColumns`), keyed by database name. It types
+   * and parses them on reads, and validates them on `open` and `update`.
+   */
+  readonly fields?: S;
+  /** `withBlockHooks` hooks around the client's methods. */
+  readonly hooks?: NoInfer<BlockHooks<Incidents<FieldsOf<S>>>>;
+  /** Receives the errors `after` hooks throw. Default: `console`. */
+  readonly logger?: Logger;
+  readonly mappers?: readonly ErrorMapper[];
+}
+/** `sev1` is the most severe. */
+type IncidentSeverity = "sev1" | "sev2" | "sev3" | "sev4";
+type IncidentStatus = "investigating" | "identified" | "monitoring" | "resolved";
+/** From best to worst. */
+type ComponentStatus = "operational" | "maintenance" | "degraded" | "partial_outage" | "major_outage";
+/** What an incident does to a component: any status but `operational`. */
+type ComponentImpact = Exclude<ComponentStatus, "operational">;
+/** A component or service a status page shows. */
+interface StatusComponent {
+  readonly id: string;
+  readonly organizationId: string;
+  readonly name: string;
+  readonly description?: string;
+  readonly group?: string;
+  /** Shown on the public status page. */
+  readonly public: boolean;
+  /** The worst impact of the open incidents on it, else `operational`. */
+  readonly status: ComponentStatus;
+  readonly position: number;
+  readonly createdAt: Temporal.Instant;
+  readonly updatedAt: Temporal.Instant;
+}
+interface StatusComponentInput {
+  readonly name: string;
+  readonly description?: string;
+  readonly group?: string;
+  /** Default `true`. */
+  readonly public?: boolean;
+  /** Default `0`; lower comes first. */
+  readonly position?: number;
+  /** Changes this component instead of adding one. */
+  readonly componentId?: string;
+}
+interface IncidentImpactInput {
+  readonly componentId: string;
+  readonly impact: ComponentImpact;
+}
+interface IncidentImpact extends IncidentImpactInput {
+  readonly name: string;
+}
+/** An incident. `F` types the extra columns the `fields` schema describes. */
+interface Incident<F extends object = Record<never, never>> {
+  readonly id: string;
+  readonly organizationId: string;
+  readonly title: string;
+  /** Internal; the status page never shows it. */
+  readonly description?: string;
+  readonly severity: IncidentSeverity;
+  readonly status: IncidentStatus;
+  /** Shown on the public status page. */
+  readonly public: boolean;
+  readonly commanderId?: string;
+  readonly startedAt: Temporal.Instant;
+  readonly resolvedAt?: Temporal.Instant;
+  readonly createdBy?: string;
+  readonly createdAt: Temporal.Instant;
+  readonly updatedAt: Temporal.Instant;
+  readonly impacts: readonly IncidentImpact[];
+  /** The extra columns, keyed by database name. */
+  readonly fields: ExtraFields<F>;
+}
+/** An entry on an incident's timeline. */
+interface IncidentUpdate {
+  readonly id: string;
+  readonly incidentId: string;
+  readonly status: IncidentStatus;
+  readonly body: string;
+  readonly public: boolean;
+  readonly authorId?: string;
+  readonly createdAt: Temporal.Instant;
+}
+type PostmortemStatus = "draft" | "published";
+interface Postmortem {
+  readonly id: string;
+  readonly incidentId: string;
+  readonly summary?: string;
+  readonly impact?: string;
+  readonly rootCause?: string;
+  readonly resolution?: string;
+  readonly actionItems: readonly unknown[];
+  readonly status: PostmortemStatus;
+  readonly publishedAt?: Temporal.Instant;
+  readonly authorId?: string;
+  readonly createdAt: Temporal.Instant;
+  readonly updatedAt: Temporal.Instant;
+}
+/** An incident with its timeline, oldest first, and its postmortem. */
+interface IncidentDetail<F extends object = Record<never, never>> extends Incident<F> {
+  readonly updates: readonly IncidentUpdate[];
+  readonly postmortem?: Postmortem;
+}
+interface IncidentInput<F extends object = Record<never, never>> {
+  readonly title: string;
+  readonly description?: string;
+  /** Default `sev3`. */
+  readonly severity?: IncidentSeverity;
+  /** Default `false`: only members see it. */
+  readonly public?: boolean;
+  readonly commanderId?: string;
+  /** The first timeline entry, with the incident's visibility. */
+  readonly message?: string;
+  readonly impacts?: readonly IncidentImpactInput[];
+  /** The extra columns to set. */
+  readonly fields?: Partial<F>;
+}
+type IncidentChanges<F extends object = Record<never, never>> = Partial<Omit<IncidentInput<F>, "message" | "impacts">>;
+interface IncidentUpdateInput {
+  readonly status: IncidentStatus;
+  readonly body: string;
+  /** Default: the incident's visibility. */
+  readonly public?: boolean;
+}
+interface IncidentListOptions {
+  readonly status?: "open" | "resolved";
+  readonly severity?: IncidentSeverity;
+  readonly componentId?: string;
+  /** The `startedAt` of the last row of the previous page. */
+  readonly before?: Temporal.Instant;
+  /** Default 50, at most 200. */
+  readonly pageSize?: number;
+}
+interface PostmortemInput {
+  readonly summary?: string;
+  readonly impact?: string;
+  readonly rootCause?: string;
+  readonly resolution?: string;
+  readonly actionItems?: readonly unknown[];
+}
+/** The organization's status page settings. */
+interface StatusPage {
+  readonly id: string;
+  readonly organizationId: string;
+  readonly slug: string;
+  readonly title: string;
+  readonly description?: string;
+  readonly published: boolean;
+  readonly createdAt: Temporal.Instant;
+  readonly updatedAt: Temporal.Instant;
+}
+interface StatusPageInput {
+  /** Lowercase letters, digits and dashes; unique across organizations. */
+  readonly slug: string;
+  readonly title: string;
+  readonly description?: string;
+  /** Default `false`: the public page returns nothing. */
+  readonly published?: boolean;
+}
+/** One UTC day of a component's uptime history. */
+interface PublicUptimeDay {
+  readonly date: Temporal.PlainDate;
+  /** The worst status the component had that day. */
+  readonly status: ComponentStatus;
+  /** Minutes in a partial or major outage. */
+  readonly downMinutes: number;
+}
+interface PublicStatusComponent {
+  readonly id: string;
+  readonly name: string;
+  readonly description?: string;
+  readonly group?: string;
+  readonly status: ComponentStatus;
+  /** Time outside a partial or major outage over the window, in percent. */
+  readonly uptimePercent: number;
+  /** The oldest day first. */
+  readonly uptime: readonly PublicUptimeDay[];
+}
+interface PublicIncident {
+  readonly id: string;
+  readonly title: string;
+  readonly severity: IncidentSeverity;
+  readonly status: IncidentStatus;
+  readonly startedAt: Temporal.Instant;
+  readonly resolvedAt?: Temporal.Instant;
+  /** Only the public components it affects. */
+  readonly components: readonly {
+    readonly id: string;
+    readonly name: string;
+    readonly impact: ComponentImpact;
+  }[];
+  /** Only the public updates, newest first. */
+  readonly updates: readonly {
+    readonly status: IncidentStatus;
+    readonly body: string;
+    readonly createdAt: Temporal.Instant;
+  }[];
+  readonly postmortem?: {
+    readonly summary?: string;
+    readonly publishedAt: Temporal.Instant;
+  };
+}
+/** What anyone, signed in or not, reads from a published status page. */
+interface PublicStatusPage {
+  readonly slug: string;
+  readonly title: string;
+  readonly description?: string;
+  readonly days: number;
+  /** The worst status of the public components. */
+  readonly status: ComponentStatus;
+  readonly components: readonly PublicStatusComponent[];
+  /** Open public incidents, and those resolved in the window. */
+  readonly incidents: readonly PublicIncident[];
+}
+interface Incidents<F extends object = Record<never, never>> {
+  /** Needs `incidents.manage`. */
+  saveComponent(organizationId: string, input: StatusComponentInput): AsyncResult<StatusComponent>;
+  /** Needs `incidents.manage`. */
+  deleteComponent(componentId: string): AsyncResult<{
+    readonly id: string;
+  }>;
+  components(organizationId: string): AsyncResult<readonly StatusComponent[]>;
+  /** Needs `incidents.write`. */
+  open(organizationId: string, input: IncidentInput<F>): AsyncResult<Incident<F>>;
+  /** Needs `incidents.write`. */
+  update(incidentId: string, changes: IncidentChanges<F>): AsyncResult<Incident<F>>;
+  /**
+   * Adds a timeline entry and moves the incident to its status; `resolved`
+   * closes the incident and restores its components. Needs `incidents.write`.
+   */
+  postUpdate(incidentId: string, input: IncidentUpdateInput): AsyncResult<IncidentUpdate>;
+  /** Replaces the affected components. Needs `incidents.write`. */
+  setImpacts(incidentId: string, impacts: readonly IncidentImpactInput[]): AsyncResult<Incident<F>>;
+  get(incidentId: string): AsyncResult<IncidentDetail<F> | undefined>;
+  /** Newest first. */
+  list(organizationId: string, options?: IncidentListOptions): AsyncResult<readonly Incident<F>[]>;
+  /** Creates or changes the draft. Needs `incidents.write`. */
+  savePostmortem(incidentId: string, input: PostmortemInput): AsyncResult<Postmortem>;
+  /** Needs `incidents.manage` and a resolved incident. */
+  publishPostmortem(incidentId: string): AsyncResult<Postmortem>;
+  /** Needs `incidents.manage`. */
+  saveStatusPage(organizationId: string, input: StatusPageInput): AsyncResult<StatusPage>;
+  statusPage(organizationId: string): AsyncResult<StatusPage | undefined>;
+  /**
+   * The published status page behind a slug, readable without signing in:
+   * public components, their uptime over `days` (1 to 90, default 90) and
+   * public incidents. `undefined` when no published page has the slug.
+   */
+  publicStatusPage(slug: string, days?: number): AsyncResult<PublicStatusPage | undefined>;
+}
+/** The `incidents` SQL module as typed calls. */
+export declare function createIncidents<S extends StandardSchemaV1 | undefined = undefined>(options: IncidentsOptions<S>): Incidents<FieldsOf<S>>;
+//#endregion
+//#region src/blocks/incidents/events.d.ts
+/** `incident.opened`. */
+interface IncidentOpenedEventData {
+  readonly organizationId: string;
+  readonly incidentId: string;
+  readonly title: string;
+  readonly severity: string;
+  readonly status: string;
+  /** Whether the incident shows on the public status page. */
+  readonly public: boolean;
+}
+/** `incident.updated`: a timeline update, with the status it set. */
+interface IncidentUpdatedEventData {
+  readonly organizationId: string;
+  readonly incidentId: string;
+  readonly updateId: string;
+  readonly status: string;
+  readonly public: boolean;
+}
+/** `incident.resolved`. */
+interface IncidentResolvedEventData {
+  readonly organizationId: string;
+  readonly incidentId: string;
+  readonly severity: string;
+}
+/** `postmortem.published`. */
+interface PostmortemPublishedEventData {
+  readonly organizationId: string;
+  readonly postmortemId: string;
+  readonly incidentId: string;
+}
+/** `status_component.changed`: a component's current status changed. */
+interface StatusComponentChangedEventData {
+  readonly organizationId: string;
+  readonly statusComponentId: string;
+  readonly status: string;
+  readonly previousStatus: string;
+}
+/** The events of the `incidents` block: type to data. */
+type IncidentsEvents = {
+  readonly "incident.opened": IncidentOpenedEventData;
+  readonly "incident.updated": IncidentUpdatedEventData;
+  readonly "incident.resolved": IncidentResolvedEventData;
+  readonly "postmortem.published": PostmortemPublishedEventData;
+  readonly "status_component.changed": StatusComponentChangedEventData;
+};
+/** The `incidents` block's event types, for its manifest and `onBlockEvent`. */
+export declare const incidentsEvents: Events<IncidentsEvents>;
+//#endregion
+//#region src/blocks/incidents/manifest.d.ts
+/** The `incidents` block's manifest (ADR 0029). */
+export declare const incidentsBlock: BlockOf<"incidents", typeof createIncidents, IncidentsEvents>;
+//#endregion
+//#region src/blocks/incidents/schemas.d.ts
+/** What `open` takes. */
+export declare const incidentInputSchema: EntitySchema<IncidentInput>;
+/** What `update` takes. */
+export declare const incidentChangesSchema: EntitySchema<IncidentChanges>;
+/** What `saveComponent` takes. */
+export declare const statusComponentInputSchema: EntitySchema<StatusComponentInput>;
+/** What `savePostmortem` takes. */
+export declare const postmortemInputSchema: EntitySchema<PostmortemInput>;
+/** What `saveStatusPage` takes. */
+export declare const statusPageInputSchema: EntitySchema<StatusPageInput>;
+//#endregion
+export { type BlockHooks, type BlockTransport, type BlockTransportMiddleware, type ComponentImpact, type ComponentStatus, type Incident, type IncidentChanges, type IncidentDetail, type IncidentImpact, type IncidentImpactInput, type IncidentInput, type IncidentListOptions, type IncidentOpenedEventData, type IncidentResolvedEventData, type IncidentSeverity, type IncidentStatus, type IncidentUpdate, type IncidentUpdateInput, type IncidentUpdatedEventData, type Incidents, type IncidentsEvents, type IncidentsOptions, type Postmortem, type PostmortemInput, type PostmortemPublishedEventData, type PostmortemStatus, type PublicIncident, type PublicStatusComponent, type PublicStatusPage, type PublicUptimeDay, type RpcClient, type StatusComponent, type StatusComponentChangedEventData, type StatusComponentInput, type StatusPage, type StatusPageInput, dbTransport, extendBlock, rpcTransport, sqlTransport, withBlockHooks, wrapTransport };