@marinoscar/platform-contract 0.0.0-stage → 0.1.0-next.4

package/dist/cjs/notifications/schemas.d.ts

@@ -0,0 +1,1016 @@
+import { z } from 'zod';
+import type { BroadcastStatusName, PushSubscriptionPlatform, PushTestConfigSource, PushTestOverall, PushTestSendStatus } from './constants.js';
+/**
+ * A channel id: any id matching `NOTIFICATION_CHANNEL_ID_PATTERN`. Open: the
+ * API checks membership in its channel registry where it matters (a request
+ * that writes a NEW preference or names a broadcast channel), never on a
+ * stored value.
+ *
+ * @stability stable
+ */
+export declare const notificationChannelIdSchema: z.ZodString;
+/**
+ * An event key as a stored preference or a `disabledEvents` entry: a
+ * syntactic bound, NOT a registry check (an entry naming an event this build
+ * does not declare is stored and simply never matches).
+ *
+ * @stability stable
+ */
+export declare const notificationEventKeySchema: z.ZodString;
+/**
+ * One channel's preferences: event key to the user's explicit choice.
+ * `boolean` only; an absent key means "use the event's default".
+ *
+ * @stability stable
+ */
+export declare const notificationChannelPreferencesSchema: z.ZodRecord<z.ZodString, z.ZodBoolean>;
+/**
+ * The `notifications` user settings namespace: channel to that channel's
+ * preferences, sparse at every level. Keyed by an OPEN channel id; the count
+ * of channels and of events per channel is bounded on the merged value by the
+ * API (`NOTIFICATION_MAX_CHANNELS`, `NOTIFICATION_MAX_EVENTS_PER_CHANNEL`).
+ *
+ * @stability stable
+ */
+export declare const notificationsSchema: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodBoolean>>;
+/**
+ * PATCH form of one channel's preferences: `null` deletes one event key,
+ * restoring the default.
+ *
+ * @stability stable
+ */
+export declare const notificationChannelPreferencesPatchSchema: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodBoolean>>;
+/**
+ * PATCH form of the `notifications` namespace. Three levels of delete: a
+ * `null` namespace clears it, a `null` channel (`email: null`) clears one
+ * channel, a `null` event key clears one event. A non-null channel object
+ * deep-merges per event.
+ *
+ * @stability stable
+ */
+export declare const notificationsPatchSchema: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodBoolean>>>>;
+/**
+ * A stored `notifications` value.
+ *
+ * @stability stable
+ */
+export type NotificationsValue = z.infer<typeof notificationsSchema>;
+/**
+ * One channel's stored preferences.
+ *
+ * @stability stable
+ */
+export type NotificationChannelPreferencesValue = z.infer<typeof notificationChannelPreferencesSchema>;
+/**
+ * A `notifications` PATCH branch.
+ *
+ * @stability stable
+ */
+export type NotificationsPatchValue = z.infer<typeof notificationsPatchSchema>;
+/**
+ * One channel's deployment-wide switch (the value of one `channels` entry of
+ * the `notifications` system namespace).
+ *
+ * @stability experimental
+ */
+export declare const notificationChannelPolicySchema: z.ZodObject<{
+    enabled: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * One channel's switch.
+ *
+ * @stability experimental
+ */
+export type NotificationChannelPolicyValue = z.infer<typeof notificationChannelPolicySchema>;
+/**
+ * The `channels` record of the `notifications` system namespace: channel id to
+ * that channel's switch, sparse. An absent channel is ENABLED (an operator opts
+ * a channel out, never in), which is also what makes a channel an app registers
+ * later deliver without anyone saving anything first. The id is open and is not
+ * checked against the registry here: an entry for a channel this build does not
+ * register is kept and never matches. `browser` is also written as the legacy
+ * `browserEnabled` boolean, kept in step with `channels.browser.enabled`.
+ *
+ * @extensionPoint schema
+ * @stability experimental
+ */
+export declare const notificationChannelPoliciesSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
+    enabled: z.ZodBoolean;
+}, z.core.$strip>>;
+/**
+ * The stored `channels` record.
+ *
+ * @stability experimental
+ */
+export type NotificationChannelPoliciesValue = z.infer<typeof notificationChannelPoliciesSchema>;
+/**
+ * The deployment-wide notification policy (`system_settings`
+ * `notifications`): whether the browser channel is on, which events are
+ * suppressed for everyone, and (`channels`) a switch per channel. A
+ * `mandatory` event's inbox row survives all of them.
+ *
+ * `browserEnabled` is the original switch and stays the spelling of the browser
+ * channel's; `channels.browser.enabled` is its alias (a write of either sets
+ * both). `channels` is absent on a row written before it existed, which reads
+ * as every channel enabled.
+ *
+ * @stability stable
+ */
+export declare const systemNotificationsSchema: z.ZodObject<{
+    browserEnabled: z.ZodBoolean;
+    disabledEvents: z.ZodArray<z.ZodString>;
+    channels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        enabled: z.ZodBoolean;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * The stored system policy.
+ *
+ * @stability stable
+ */
+export type SystemNotificationsValue = z.infer<typeof systemNotificationsSchema>;
+/**
+ * PATCH counterpart: `disabledEvents` REPLACES wholesale (RFC 7396's rule for
+ * arrays: a merge could never re-enable an event); `channels` merges per
+ * channel.
+ *
+ * @stability stable
+ */
+export declare const systemNotificationsPatchSchema: z.ZodObject<{
+    browserEnabled: z.ZodOptional<z.ZodBoolean>;
+    disabledEvents: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    channels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        enabled: z.ZodBoolean;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * The `notifications` block of the `PUT /api/system-settings` body.
+ *
+ * @stability stable
+ */
+export declare const notificationsSettingsSchema: z.ZodObject<{
+    browserEnabled: z.ZodBoolean;
+    disabledEvents: z.ZodArray<z.ZodString>;
+    channels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        enabled: z.ZodBoolean;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * The `notifications` block of the `PATCH /api/system-settings` body.
+ *
+ * @stability stable
+ */
+export declare const notificationsSettingsPatchSchema: z.ZodObject<{
+    browserEnabled: z.ZodOptional<z.ZodBoolean>;
+    disabledEvents: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    channels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        enabled: z.ZodBoolean;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * The `notifications` block of the system settings response.
+ *
+ * @stability stable
+ */
+export declare const notificationsResponseSchema: z.ZodObject<{
+    browserEnabled: z.ZodBoolean;
+    disabledEvents: z.ZodArray<z.ZodString>;
+    channels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        enabled: z.ZodBoolean;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * The ORG LAYER of the `notifications` namespace (#738, through #733's
+ * `/api/org-settings`): what one organization may set for its own members. It
+ * may only TIGHTEN: `browserEnabled: false` turns browser delivery off for
+ * the org (the effective value is system AND org), `channels` turns other
+ * channels off for it (system AND org, per channel), and `disabledEvents`
+ * suppresses more events (the effective list is the union). Every field is
+ * optional: an org stores only what it overrides.
+ *
+ * @extensionPoint schema
+ * @stability experimental
+ */
+export declare const orgNotificationsSchema: z.ZodObject<{
+    browserEnabled: z.ZodOptional<z.ZodBoolean>;
+    disabledEvents: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    channels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        enabled: z.ZodBoolean;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * An organization's stored `notifications` overrides.
+ *
+ * @stability experimental
+ */
+export type OrgNotificationsValue = z.infer<typeof orgNotificationsSchema>;
+/**
+ * The broadcast statuses, as `z.enum` types them: each keyed by itself.
+ *
+ * @stability stable
+ */
+export type BroadcastStatusEnum = {
+    [K in BroadcastStatusName]: K;
+};
+/**
+ * The push test verdicts, as `z.enum` types them.
+ *
+ * @stability stable
+ */
+export type PushTestOverallEnum = {
+    [K in PushTestOverall]: K;
+};
+/**
+ * The push test configuration sources, as `z.enum` types them.
+ *
+ * @stability stable
+ */
+export type PushTestConfigSourceEnum = {
+    [K in PushTestConfigSource]: K;
+};
+/**
+ * The push test send outcomes, as `z.enum` types them.
+ *
+ * @stability stable
+ */
+export type PushTestSendStatusEnum = {
+    [K in PushTestSendStatus]: K;
+};
+/**
+ * A boolean query parameter's two spellings, as `z.enum` types them.
+ *
+ * @stability stable
+ */
+export type BooleanQueryEnum = {
+    [K in 'true' | 'false']: K;
+};
+/**
+ * The push subscription platforms, as `z.enum` types them.
+ *
+ * @stability experimental
+ */
+export type PushSubscriptionPlatformEnum = {
+    [K in PushSubscriptionPlatform]: K;
+};
+/**
+ * One event as `GET /api/notifications/events` serves it: `channels` is
+ * capability narrowed by the policy in force (what the preferences matrix may
+ * offer), `declaredChannels` the registry's capability unfiltered.
+ *
+ * @stability stable
+ */
+export declare const notificationEventSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodString;
+    description: z.ZodString;
+    channels: z.ZodArray<z.ZodString>;
+    declaredChannels: z.ZodArray<z.ZodString>;
+    defaultEnabled: z.ZodBoolean;
+    mandatory: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * One event on the wire.
+ *
+ * @stability stable
+ */
+export type NotificationEventResponse = z.infer<typeof notificationEventSchema>;
+/**
+ * One delivery channel as `GET /api/notifications/channels` serves it: what a
+ * client needs to draw the channel (its label, where it sits) and to apply the
+ * rules that depend on it (which channels a critical broadcast may rely on,
+ * which a user may toggle, which a fresh broadcast starts with). The registry
+ * is the only source: a client holds no list of channels.
+ *
+ * @extensionPoint schema
+ * @stability experimental
+ */
+export declare const notificationChannelDescriptorSchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    description: z.ZodString;
+    userConfigurable: z.ZodBoolean;
+    criticalCapable: z.ZodBoolean;
+    broadcastCapable: z.ZodBoolean;
+    broadcastDefault: z.ZodBoolean;
+    order: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * One channel descriptor.
+ *
+ * @stability experimental
+ */
+export type NotificationChannelDescriptorResponse = z.infer<typeof notificationChannelDescriptorSchema>;
+/**
+ * `GET /api/notifications/channels`: every registered delivery channel, in
+ * registration order.
+ *
+ * @stability experimental
+ */
+export declare const notificationChannelsResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    description: z.ZodString;
+    userConfigurable: z.ZodBoolean;
+    criticalCapable: z.ZodBoolean;
+    broadcastCapable: z.ZodBoolean;
+    broadcastDefault: z.ZodBoolean;
+    order: z.ZodNumber;
+}, z.core.$strip>>;
+/**
+ * The channels response.
+ *
+ * @stability experimental
+ */
+export type NotificationChannelsResponse = z.infer<typeof notificationChannelsResponseSchema>;
+/**
+ * `GET /api/notifications/config`: what a non-admin client needs to know
+ * about the capability (the policy in force for the caller, and Web Push).
+ *
+ * @stability stable
+ */
+export declare const notificationConfigSchema: z.ZodObject<{
+    browserEnabled: z.ZodBoolean;
+    pushEnabled: z.ZodBoolean;
+    vapidPublicKey: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * The config response.
+ *
+ * @stability stable
+ */
+export type NotificationConfigResponse = z.infer<typeof notificationConfigSchema>;
+/**
+ * One inbox row.
+ *
+ * @stability stable
+ */
+export declare const notificationSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    eventKey: z.ZodString;
+    title: z.ZodString;
+    body: z.ZodString;
+    link: z.ZodNullable<z.ZodString>;
+    readAt: z.ZodNullable<z.ZodISODateTime>;
+    createdAt: z.ZodISODateTime;
+}, z.core.$strip>;
+/**
+ * One inbox row on the wire.
+ *
+ * @stability stable
+ */
+export type NotificationResponse = z.infer<typeof notificationSchema>;
+/**
+ * `GET /api/notifications` query: page, page size, unread only.
+ *
+ * @stability stable
+ */
+export declare const notificationListQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    unreadOnly: z.ZodPipe<z.ZodDefault<z.ZodEnum<BooleanQueryEnum>>, z.ZodTransform<boolean, "true" | "false">>;
+}, z.core.$strip>;
+/**
+ * The inbox page.
+ *
+ * @stability stable
+ */
+export interface NotificationListResponse {
+    /** The rows of this page, newest first. */
+    items: NotificationResponse[];
+    /** Matching rows in total. */
+    total: number;
+    /** The page number. */
+    page: number;
+    /** The page size. */
+    pageSize: number;
+    /** Pages in total. */
+    totalPages: number;
+}
+/**
+ * `GET /api/notifications/unread-count`.
+ *
+ * @stability stable
+ */
+export declare const unreadCountSchema: z.ZodObject<{
+    unreadCount: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * The unread count.
+ *
+ * @stability stable
+ */
+export type UnreadCountResponse = z.infer<typeof unreadCountSchema>;
+/**
+ * One frame of `GET /api/notifications/stream` (`event: notification`).
+ * `toast` says whether the tab may show an OS toast (the policy in force),
+ * `pushed` whether this dispatch also sent Web Push (so the tab can skip its
+ * own toast).
+ *
+ * @stability stable
+ */
+export declare const notificationStreamEventSchema: z.ZodObject<{
+    id: z.ZodString;
+    eventKey: z.ZodString;
+    title: z.ZodString;
+    body: z.ZodString;
+    link: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodString;
+    toast: z.ZodBoolean;
+    pushed: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * One stream frame.
+ *
+ * @stability stable
+ */
+export type NotificationStreamEventPayload = z.infer<typeof notificationStreamEventSchema>;
+/**
+ * `POST /api/notifications/push/subscriptions`: a browser's
+ * `PushSubscription.toJSON()`.
+ *
+ * @stability stable
+ */
+export declare const pushSubscribeSchema: z.ZodObject<{
+    endpoint: z.ZodString;
+    keys: z.ZodObject<{
+        p256dh: z.ZodString;
+        auth: z.ZodString;
+    }, z.core.$strip>;
+    expirationTime: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    platform: z.ZodOptional<z.ZodEnum<PushSubscriptionPlatformEnum>>;
+}, z.core.$strip>;
+/**
+ * The subscribe body.
+ *
+ * @stability stable
+ */
+export type PushSubscribeRequest = z.infer<typeof pushSubscribeSchema>;
+/**
+ * The subscribe response.
+ *
+ * @stability stable
+ */
+export declare const pushSubscriptionResponseSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    endpoint: z.ZodString;
+    platform: z.ZodEnum<PushSubscriptionPlatformEnum>;
+    createdAt: z.ZodISODateTime;
+}, z.core.$strip>;
+/**
+ * The subscribe response, typed.
+ *
+ * @stability stable
+ */
+export type PushSubscriptionResponse = z.infer<typeof pushSubscriptionResponseSchema>;
+/**
+ * `DELETE /api/notifications/push/subscriptions` body.
+ *
+ * @stability stable
+ */
+export declare const pushUnsubscribeSchema: z.ZodObject<{
+    endpoint: z.ZodString;
+}, z.core.$strip>;
+/**
+ * The unsubscribe body.
+ *
+ * @stability stable
+ */
+export type PushUnsubscribeRequest = z.infer<typeof pushUnsubscribeSchema>;
+/**
+ * A VAPID subject: a `mailto:` address or an `http(s)://` URL.
+ *
+ * @stability stable
+ */
+export declare const vapidSubjectSchema: z.ZodString;
+/**
+ * The stored Web Push settings row (`system_settings` key `webPush`). The
+ * private key is NOT here: it lives in the credential store.
+ *
+ * @stability stable
+ */
+export declare const pushConfigSchema: z.ZodObject<{
+    enabled: z.ZodBoolean;
+    publicKey: z.ZodNullable<z.ZodString>;
+    subject: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * The stored Web Push settings.
+ *
+ * @stability stable
+ */
+export type PushConfig = z.infer<typeof pushConfigSchema>;
+/**
+ * `POST /api/admin/push-config/generate` body.
+ *
+ * @stability stable
+ */
+export declare const generatePushConfigSchema: z.ZodObject<{
+    subject: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * The generate body.
+ *
+ * @stability stable
+ */
+export type GeneratePushConfigInput = z.infer<typeof generatePushConfigSchema>;
+/**
+ * `PUT /api/admin/push-config` body (with `If-Match`).
+ *
+ * @stability stable
+ */
+export declare const updatePushConfigSchema: z.ZodObject<{
+    enabled: z.ZodBoolean;
+    subject: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * The update body.
+ *
+ * @stability stable
+ */
+export type UpdatePushConfigInput = z.infer<typeof updatePushConfigSchema>;
+/**
+ * `POST /api/admin/push-config/rotate` body.
+ *
+ * @stability stable
+ */
+export declare const rotatePushConfigSchema: z.ZodObject<{
+    confirmation: z.ZodLiteral<"ROTATE">;
+    subject: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * The rotate body.
+ *
+ * @stability stable
+ */
+export type RotatePushConfigInput = z.infer<typeof rotatePushConfigSchema>;
+/**
+ * `DELETE /api/admin/push-config` body.
+ *
+ * @stability stable
+ */
+export declare const removePushConfigSchema: z.ZodObject<{
+    confirmation: z.ZodLiteral<"REMOVE">;
+}, z.core.$strip>;
+/**
+ * The remove body.
+ *
+ * @stability stable
+ */
+export type RemovePushConfigInput = z.infer<typeof removePushConfigSchema>;
+/**
+ * The private key's masked status: never the key.
+ *
+ * @stability stable
+ */
+export declare const privateKeyStatusSchema: z.ZodObject<{
+    configured: z.ZodBoolean;
+    hint: z.ZodNullable<z.ZodString>;
+    updatedAt: z.ZodNullable<z.ZodISODateTime>;
+    updatedByUserId: z.ZodNullable<z.ZodUUID>;
+}, z.core.$strip>;
+/**
+ * The admin view of the Web Push configuration.
+ *
+ * @stability stable
+ */
+export declare const pushConfigResponseSchema: z.ZodObject<{
+    enabled: z.ZodBoolean;
+    publicKey: z.ZodNullable<z.ZodString>;
+    subject: z.ZodNullable<z.ZodString>;
+    configured: z.ZodBoolean;
+    privateKeyStatus: z.ZodObject<{
+        configured: z.ZodBoolean;
+        hint: z.ZodNullable<z.ZodString>;
+        updatedAt: z.ZodNullable<z.ZodISODateTime>;
+        updatedByUserId: z.ZodNullable<z.ZodUUID>;
+    }, z.core.$strip>;
+    settingsError: z.ZodNullable<z.ZodString>;
+    version: z.ZodNumber;
+    updatedAt: z.ZodNullable<z.ZodISODateTime>;
+    updatedBy: z.ZodNullable<z.ZodObject<{
+        id: z.ZodUUID;
+        email: z.ZodEmail;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * The admin view, typed.
+ *
+ * @stability stable
+ */
+export type PushConfigResponse = z.infer<typeof pushConfigResponseSchema>;
+/**
+ * `POST /api/admin/push-config/test` body: optionally this browser's endpoint
+ * and the server key it subscribed with, to diagnose the pair.
+ *
+ * @stability stable
+ */
+export declare const pushTestRequestSchema: z.ZodObject<{
+    endpoint: z.ZodOptional<z.ZodURL>;
+    applicationServerKey: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * The test body.
+ *
+ * @stability stable
+ */
+export type PushTestRequest = z.infer<typeof pushTestRequestSchema>;
+/**
+ * The push test's verdicts on the active configuration.
+ *
+ * @stability stable
+ */
+export declare const pushTestConfigDiagnosticsSchema: z.ZodObject<{
+    source: z.ZodEnum<PushTestConfigSourceEnum>;
+    enabled: z.ZodNullable<z.ZodBoolean>;
+    active: z.ZodBoolean;
+    publicKey: z.ZodNullable<z.ZodString>;
+    publicKeyValid: z.ZodBoolean;
+    privateKeyMatchesPublicKey: z.ZodNullable<z.ZodBoolean>;
+    subject: z.ZodNullable<z.ZodString>;
+    subjectValid: z.ZodBoolean;
+    problems: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Configuration verdicts, typed.
+ *
+ * @stability stable
+ */
+export type PushTestConfigDiagnostics = z.infer<typeof pushTestConfigDiagnosticsSchema>;
+/**
+ * The push test's verdicts on the calling browser.
+ *
+ * @stability stable
+ */
+export declare const pushTestBrowserDiagnosticsSchema: z.ZodObject<{
+    endpointProvided: z.ZodBoolean;
+    endpointRegistered: z.ZodNullable<z.ZodBoolean>;
+    keyMatchesServer: z.ZodNullable<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * Browser verdicts, typed.
+ *
+ * @stability stable
+ */
+export type PushTestBrowserDiagnostics = z.infer<typeof pushTestBrowserDiagnosticsSchema>;
+/**
+ * Whether each push-capable event would reach the caller.
+ *
+ * @stability stable
+ */
+export declare const pushTestEventDiagnosticsSchema: z.ZodObject<{
+    eventKey: z.ZodString;
+    label: z.ZodString;
+    mandatory: z.ZodBoolean;
+    policyAllows: z.ZodBoolean;
+    preferenceAllows: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Event verdicts, typed.
+ *
+ * @stability stable
+ */
+export type PushTestEventDiagnostics = z.infer<typeof pushTestEventDiagnosticsSchema>;
+/**
+ * One test send's result.
+ *
+ * @stability stable
+ */
+export declare const pushTestSendResultSchema: z.ZodObject<{
+    status: z.ZodEnum<PushTestSendStatusEnum>;
+    statusCode: z.ZodNullable<z.ZodNumber>;
+    message: z.ZodNullable<z.ZodString>;
+    responseBody: z.ZodNullable<z.ZodString>;
+    durationMs: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * One send result, typed.
+ *
+ * @stability stable
+ */
+export type PushTestSendResult = z.infer<typeof pushTestSendResultSchema>;
+/**
+ * One of the caller's subscriptions and its test send. The endpoint appears
+ * only as a preview and its push service host.
+ *
+ * @stability stable
+ */
+export declare const pushTestSubscriptionResultSchema: z.ZodObject<{
+    id: z.ZodString;
+    pushService: z.ZodString;
+    endpointPreview: z.ZodString;
+    isThisBrowser: z.ZodBoolean;
+    userAgent: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodISODateTime;
+    lastSuccessAt: z.ZodNullable<z.ZodISODateTime>;
+    failureCount: z.ZodNumber;
+    result: z.ZodObject<{
+        status: z.ZodEnum<PushTestSendStatusEnum>;
+        statusCode: z.ZodNullable<z.ZodNumber>;
+        message: z.ZodNullable<z.ZodString>;
+        responseBody: z.ZodNullable<z.ZodString>;
+        durationMs: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * One subscription result, typed.
+ *
+ * @stability stable
+ */
+export type PushTestSubscriptionResult = z.infer<typeof pushTestSubscriptionResultSchema>;
+/**
+ * `POST /api/admin/push-config/test` response.
+ *
+ * @stability stable
+ */
+export declare const pushTestResponseSchema: z.ZodObject<{
+    ranAt: z.ZodISODateTime;
+    durationMs: z.ZodNumber;
+    overall: z.ZodEnum<PushTestOverallEnum>;
+    testId: z.ZodString;
+    config: z.ZodObject<{
+        source: z.ZodEnum<PushTestConfigSourceEnum>;
+        enabled: z.ZodNullable<z.ZodBoolean>;
+        active: z.ZodBoolean;
+        publicKey: z.ZodNullable<z.ZodString>;
+        publicKeyValid: z.ZodBoolean;
+        privateKeyMatchesPublicKey: z.ZodNullable<z.ZodBoolean>;
+        subject: z.ZodNullable<z.ZodString>;
+        subjectValid: z.ZodBoolean;
+        problems: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>;
+    browser: z.ZodObject<{
+        endpointProvided: z.ZodBoolean;
+        endpointRegistered: z.ZodNullable<z.ZodBoolean>;
+        keyMatchesServer: z.ZodNullable<z.ZodBoolean>;
+    }, z.core.$strip>;
+    events: z.ZodArray<z.ZodObject<{
+        eventKey: z.ZodString;
+        label: z.ZodString;
+        mandatory: z.ZodBoolean;
+        policyAllows: z.ZodBoolean;
+        preferenceAllows: z.ZodBoolean;
+    }, z.core.$strip>>;
+    subscriptions: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        pushService: z.ZodString;
+        endpointPreview: z.ZodString;
+        isThisBrowser: z.ZodBoolean;
+        userAgent: z.ZodNullable<z.ZodString>;
+        createdAt: z.ZodISODateTime;
+        lastSuccessAt: z.ZodNullable<z.ZodISODateTime>;
+        failureCount: z.ZodNumber;
+        result: z.ZodObject<{
+            status: z.ZodEnum<PushTestSendStatusEnum>;
+            statusCode: z.ZodNullable<z.ZodNumber>;
+            message: z.ZodNullable<z.ZodString>;
+            responseBody: z.ZodNullable<z.ZodString>;
+            durationMs: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+    hints: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * The test response, typed.
+ *
+ * @stability stable
+ */
+export type PushTestResponse = z.infer<typeof pushTestResponseSchema>;
+/**
+ * `POST /api/admin/broadcasts` (and `/test`) body. `channels` are open ids
+ * (the API refuses an unregistered one); `targetOrgId` (#738) addresses one
+ * organization's active members instead of every active user, and only a
+ * system `broadcasts:write` holder may name one (an `org_broadcasts:write`
+ * holder's target is forced to their active organization).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const createBroadcastSchema: z.ZodObject<{
+    title: z.ZodString;
+    body: z.ZodString;
+    link: z.ZodOptional<z.ZodString>;
+    ctaLabel: z.ZodOptional<z.ZodString>;
+    channels: z.ZodArray<z.ZodString>;
+    scheduledFor: z.ZodOptional<z.ZodPipe<z.ZodISODateTime, z.ZodTransform<Date, string>>>;
+    critical: z.ZodDefault<z.ZodBoolean>;
+    targetOrgId: z.ZodOptional<z.ZodUUID>;
+}, z.core.$strip>;
+/**
+ * The parsed create body (`scheduledFor` is a `Date`).
+ *
+ * @stability stable
+ */
+export type CreateBroadcastInput = z.output<typeof createBroadcastSchema>;
+/**
+ * The create body as a client sends it.
+ *
+ * @stability stable
+ */
+export type CreateBroadcastRequest = z.input<typeof createBroadcastSchema>;
+/**
+ * One broadcast.
+ *
+ * @stability stable
+ */
+export declare const broadcastSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    title: z.ZodString;
+    body: z.ZodString;
+    link: z.ZodNullable<z.ZodString>;
+    ctaLabel: z.ZodNullable<z.ZodString>;
+    eventKey: z.ZodString;
+    channels: z.ZodArray<z.ZodString>;
+    status: z.ZodEnum<BroadcastStatusEnum>;
+    scheduledFor: z.ZodNullable<z.ZodISODateTime>;
+    startedAt: z.ZodNullable<z.ZodISODateTime>;
+    finishedAt: z.ZodNullable<z.ZodISODateTime>;
+    canceledAt: z.ZodNullable<z.ZodISODateTime>;
+    audienceCutoff: z.ZodNullable<z.ZodISODateTime>;
+    recipientsTargeted: z.ZodNullable<z.ZodNumber>;
+    recipientsDispatched: z.ZodNumber;
+    lastError: z.ZodNullable<z.ZodString>;
+    createdById: z.ZodNullable<z.ZodUUID>;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+    targetOrgId: z.ZodNullable<z.ZodUUID>;
+}, z.core.$strip>;
+/**
+ * One broadcast on the wire.
+ *
+ * @stability stable
+ */
+export type BroadcastResponse = z.infer<typeof broadcastSchema>;
+/**
+ * One (channel, status) delivery count of a broadcast.
+ *
+ * @stability stable
+ */
+export declare const broadcastDeliveryCountSchema: z.ZodObject<{
+    channel: z.ZodString;
+    status: z.ZodString;
+    count: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * A broadcast with its approximate delivery counts.
+ *
+ * @stability stable
+ */
+export declare const broadcastDetailSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    title: z.ZodString;
+    body: z.ZodString;
+    link: z.ZodNullable<z.ZodString>;
+    ctaLabel: z.ZodNullable<z.ZodString>;
+    eventKey: z.ZodString;
+    channels: z.ZodArray<z.ZodString>;
+    status: z.ZodEnum<BroadcastStatusEnum>;
+    scheduledFor: z.ZodNullable<z.ZodISODateTime>;
+    startedAt: z.ZodNullable<z.ZodISODateTime>;
+    finishedAt: z.ZodNullable<z.ZodISODateTime>;
+    canceledAt: z.ZodNullable<z.ZodISODateTime>;
+    audienceCutoff: z.ZodNullable<z.ZodISODateTime>;
+    recipientsTargeted: z.ZodNullable<z.ZodNumber>;
+    recipientsDispatched: z.ZodNumber;
+    lastError: z.ZodNullable<z.ZodString>;
+    createdById: z.ZodNullable<z.ZodUUID>;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+    targetOrgId: z.ZodNullable<z.ZodUUID>;
+    approximateDeliveryAttempts: z.ZodArray<z.ZodObject<{
+        channel: z.ZodString;
+        status: z.ZodString;
+        count: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * The detail view, typed.
+ *
+ * @stability stable
+ */
+export type BroadcastDetailResponse = z.infer<typeof broadcastDetailSchema>;
+/**
+ * The create result: the row and any warnings (an unconfigured channel).
+ *
+ * @stability stable
+ */
+export declare const broadcastCreateResultSchema: z.ZodObject<{
+    broadcast: z.ZodObject<{
+        id: z.ZodUUID;
+        title: z.ZodString;
+        body: z.ZodString;
+        link: z.ZodNullable<z.ZodString>;
+        ctaLabel: z.ZodNullable<z.ZodString>;
+        eventKey: z.ZodString;
+        channels: z.ZodArray<z.ZodString>;
+        status: z.ZodEnum<BroadcastStatusEnum>;
+        scheduledFor: z.ZodNullable<z.ZodISODateTime>;
+        startedAt: z.ZodNullable<z.ZodISODateTime>;
+        finishedAt: z.ZodNullable<z.ZodISODateTime>;
+        canceledAt: z.ZodNullable<z.ZodISODateTime>;
+        audienceCutoff: z.ZodNullable<z.ZodISODateTime>;
+        recipientsTargeted: z.ZodNullable<z.ZodNumber>;
+        recipientsDispatched: z.ZodNumber;
+        lastError: z.ZodNullable<z.ZodString>;
+        createdById: z.ZodNullable<z.ZodUUID>;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+        targetOrgId: z.ZodNullable<z.ZodUUID>;
+    }, z.core.$strip>;
+    warnings: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * The create result, typed.
+ *
+ * @stability stable
+ */
+export type BroadcastCreateResult = z.infer<typeof broadcastCreateResultSchema>;
+/**
+ * `GET /api/admin/broadcasts/audience` query (#738): the target to count;
+ * absent counts every active user.
+ *
+ * @stability stable
+ */
+export declare const broadcastAudienceQuerySchema: z.ZodObject<{
+    targetOrgId: z.ZodOptional<z.ZodUUID>;
+}, z.core.$strip>;
+/**
+ * The audience query, typed.
+ *
+ * @stability stable
+ */
+export type BroadcastAudienceQuery = z.infer<typeof broadcastAudienceQuerySchema>;
+/**
+ * The audience size a broadcast sent now would reach.
+ *
+ * @stability stable
+ */
+export declare const broadcastAudienceSchema: z.ZodObject<{
+    activeUsers: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * The audience, typed.
+ *
+ * @stability stable
+ */
+export type BroadcastAudienceResponse = z.infer<typeof broadcastAudienceSchema>;
+/**
+ * `POST /api/admin/broadcasts/test` result: sent to the caller only.
+ *
+ * @stability stable
+ */
+export declare const broadcastTestResultSchema: z.ZodObject<{
+    eventKey: z.ZodString;
+    channels: z.ZodArray<z.ZodString>;
+    sentToUserId: z.ZodUUID;
+}, z.core.$strip>;
+/**
+ * The test result, typed.
+ *
+ * @stability stable
+ */
+export type BroadcastTestResult = z.infer<typeof broadcastTestResultSchema>;
+/**
+ * `GET /api/admin/broadcasts` query.
+ *
+ * @stability stable
+ */
+export declare const broadcastListQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    status: z.ZodOptional<z.ZodEnum<BroadcastStatusEnum>>;
+}, z.core.$strip>;
+/**
+ * The parsed list query.
+ *
+ * @stability stable
+ */
+export type BroadcastListQuery = z.output<typeof broadcastListQuerySchema>;
+/**
+ * The field names no push response may carry: key material, the subscription
+ * keys and the endpoint (a capability URL).
+ *
+ * @stability stable
+ */
+export type SecretFieldNames = 'privateKey' | 'vapidPrivateKey' | 'secret' | 'password' | 'apiKey' | 'ciphertext' | 'p256dh' | 'auth' | 'keys' | 'endpoint';
+/**
+ * `true` when `T` names none of the secret-bearing field names, `never`
+ * otherwise: the building block of {@link PushContractCarriesNoSecret}.
+ *
+ * @stability stable
+ */
+export type NoSecretIn<T> = Extract<keyof T, SecretFieldNames> extends never ? true : never;
+/**
+ * Resolves to `true` while neither the stored Web Push settings, the admin
+ * view nor the push test response carries a secret-named field; to `never`
+ * (a compile error below) the moment one does.
+ *
+ * @stability stable
+ */
+export type PushContractCarriesNoSecret = NoSecretIn<PushConfig> & NoSecretIn<PushConfigResponse> & NoSecretIn<PushTestResponse> & NoSecretIn<PushTestConfigDiagnostics> & NoSecretIn<PushTestBrowserDiagnostics> & NoSecretIn<PushTestSubscriptionResult> & NoSecretIn<PushTestSendResult>;
+/**
+ * The proof, as a value: fails to compile when {@link PushContractCarriesNoSecret} is `never`.
+ *
+ * @stability stable
+ */
+export declare const PUSH_CONTRACT_CARRIES_NO_SECRET: PushContractCarriesNoSecret;
+//# sourceMappingURL=schemas.d.ts.map