@buildinternet/releases-api-types 0.41.0 → 0.43.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildinternet/releases-api-types",
-  "version": "0.41.0",
+  "version": "0.43.0",
   "description": "Wire protocol — request/response types for the Releases registry API. Shared by web, workers, and clients.",
   "type": "module",
   "license": "MIT",

package/src/api-types.ts

@@ -1146,6 +1146,27 @@ export interface DigestPrefsRequest {
   cadence: DigestCadence;
 }
 
+/**
+ * GET /v1/me/settings/notifications — one-shot bootstrap for `/account/notifications`.
+ * Composes digest cadence + feed token + webhook list so the settings page can
+ * render with a single round-trip instead of three independent mounts.
+ */
+export interface NotificationSettingsResponse {
+  cadence: DigestCadence;
+  feedToken: FeedToken | null;
+  webhooks: UserWebhookListItem[];
+}
+
+/**
+ * GET /v1/me/settings/developer — one-shot bootstrap for `/account/webhooks`
+ * (Webhooks & API). `apiKeys` is `null` when the user-api-keys feature is off
+ * so the UI can hide the keys section without a separate probe.
+ */
+export interface DeveloperSettingsResponse {
+  webhooks: UserWebhookListItem[];
+  apiKeys: UserApiKey[] | null;
+}
+
 // ── Search ──
 
 export type SearchOrgHit = z.infer<typeof SearchOrgHitSchema>;

package/src/schemas/lookups.ts

@@ -90,10 +90,11 @@ export const LookupProductBySlugResponseSchema = z.object({
 });
 
 /**
- * Response from `GET /v1/lookups/by-domain?domain=…`. Pure resolution: an
- * unknown domain returns 404, never probes. Both an org and product list can
- * be present when a product alias points at the same domain its parent org
- * owns.
+ * Response from `GET /v1/lookups/by-domain?domain=…`. Resolves against the
+ * registry; on a complete miss may just-in-time materialize a stub from
+ * `/.well-known/releases.json` when listing is enabled (#2030). Both an org
+ * and product list can be present when a product alias points at the same
+ * domain its parent org owns.
  */
 export const DomainLookupOrgSchema = z.object({
   id: z.string(),

package/src/schemas/orgs.ts

@@ -37,6 +37,13 @@ export const OrgListItemSchema = z.object({
   recentReleaseCount: z.number().int().min(0),
   lastActivity: z.string().nullable(),
   topProducts: z.array(z.string()),
+  /**
+   * Org-level alternate domains (`domain_aliases`, product-scoped aliases
+   * excluded), sorted. Surfaced next to the primary `domain` in catalog rows so
+   * a self-declared name reads against every domain the org actually controls.
+   * Optional for mid-deploy tolerance; absent ⇒ treat as none.
+   */
+  aliasDomains: z.array(z.string()).optional(),
   sparkline: z.array(z.number().int().min(0)).length(30),
   /**
    * Additive, admin-only field (#1947 phase 2). Only populated on the

package/src/schemas/releases.ts

@@ -1,10 +1,12 @@
 import { z } from "zod";
 import { SOURCE_TYPES } from "@buildinternet/releases-core/source-enums";
 import { BREAKING_LEVELS } from "@buildinternet/releases-core/breaking";
+import { KIND_VALUES } from "@buildinternet/releases-core/kinds";
 import {
   AppStoreSourceInfoSchema,
   MediaItemSchema,
   ReleaseCompositionSchema,
+  ReleaseThumbnailSchema,
   ReleaseTypeSchema,
   VideoSourceInfoSchema,
 } from "./shared.js";
@@ -37,11 +39,20 @@ export const ReleaseLatestSourceSchema = z.object({
   /** Owning org's GitHub handle, used to derive `github.com/<handle>.png` as the
    *  avatar fallback when `orgAvatarUrl` is unset. Additive — older responses omit it. */
   orgGithubHandle: z.string().nullable().optional(),
+  /** Source classification (`sdk`, `platform`, `docs`, …) from `sources.kind`.
+   *  Null when the source has no explicit kind — resolve against the product's
+   *  kind via `resolveSourceKind`. Additive — older responses omit it. Lets read
+   *  surfaces (e.g. the digest email) deprioritize/cluster SDK releases the way
+   *  the web sources table does. */
+  kind: z.enum(KIND_VALUES).nullable().optional(),
 });
 
 export const ReleaseLatestProductSchema = z.object({
   slug: z.string(),
   name: z.string(),
+  /** Product classification from `products.kind`; the fallback `resolveSourceKind`
+   *  consults when the source itself has no kind. Additive — older responses omit it. */
+  kind: z.enum(KIND_VALUES).nullable().optional(),
 });
 
 export const ReleaseLatestItemSchema = z.object({
@@ -75,6 +86,16 @@ export const ReleaseLatestItemSchema = z.object({
    * omit this field; treat `undefined` as `null`. #1217.
    */
   product: ReleaseLatestProductSchema.nullable().optional(),
+  /**
+   * Server-resolved grouping identity — `product.slug ?? source.slug` /
+   * `product.name ?? source.name`. The web releases feed keys and labels
+   * SDK/package-cluster rollups on these instead of reconstructing
+   * `product ?? source` client-side; the digest email mirrors that. Optional on
+   * the wire: older workers omit them, so clients fall back to deriving from
+   * `product ?? source`. Never null when present (`source` is always set). #1234
+   */
+  groupSlug: z.string().optional(),
+  groupName: z.string().optional(),
   coverageCount: z.number().int().min(0).optional(),
   // Cached release-body size hint — see {@link ReleaseItemSchema} for the
   // same fields on the org / collection feeds. #958.
@@ -105,6 +126,9 @@ export const ReleaseCoverageSiblingSchema = z.object({
   sourceName: z.string(),
   publishedAt: z.string().nullable(),
   org: z.object({ slug: z.string(), name: z.string() }).nullable(),
+  /** First image/gif thumbnail for the counterpart release; null when it has
+   * none. Optional so an older server that omits it still validates. */
+  thumbnail: ReleaseThumbnailSchema.nullable().optional(),
 });
 
 /**

package/src/schemas/search.ts

@@ -3,6 +3,8 @@ import { KIND_VALUES } from "@buildinternet/releases-core/kinds";
 import {
   AppStoreSourceInfoSchema,
   MediaItemSchema,
+  OrgStatusSchema,
+  ReleaseThumbnailSchema,
   ReleaseTypeSchema,
   VideoSourceInfoSchema,
 } from "./shared.js";
@@ -27,6 +29,17 @@ export const SearchOrgHitSchema = z.object({
   domain: z.string().nullable(),
   avatarUrl: z.string().nullable(),
   category: z.string().nullable(),
+  /**
+   * Org tier (#1947/#2034). Optional for mid-deploy tolerance; absent ⇒
+   * `"tracked"`. Lets search render the icon-only stub marker (#2031 parity).
+   */
+  status: OrgStatusSchema.optional(),
+  /**
+   * Org-level alternate domains (product-scoped aliases excluded, sorted),
+   * for the `+N` hover on the origin domain — the anti-impersonation anchor
+   * mirrored from the catalog row (#2031/#2034). Optional; absent ⇒ none.
+   */
+  aliasDomains: z.array(z.string()).optional(),
 });
 
 /**
@@ -96,6 +109,11 @@ export const SearchReleaseHitSchema = z.object({
   summary: z.string(),
   titleGenerated: z.string().nullable().optional(),
   titleShort: z.string().nullable().optional(),
+  /**
+   * Full markdown body. Omitted on list hits by default (summary + media
+   * cover the card/snippet surfaces). Opt in with `?include_content=true`
+   * on `/v1/search`. Fetch full body via `GET /v1/releases/:id` otherwise.
+   */
   content: z.string().optional(),
   media: z.array(MediaItemSchema).optional(),
   publishedAt: z.string().nullable(),
@@ -187,6 +205,8 @@ export const LookupResultPayloadSchema = z.object({
         version: z.string().nullable(),
         title: z.string(),
         publishedAt: z.string().nullable(),
+        /** First image/gif thumbnail; null when the release has none. */
+        thumbnail: ReleaseThumbnailSchema.nullable().optional(),
       }),
     )
     .optional(),

package/src/schemas/shared.ts

@@ -225,6 +225,15 @@ export const NoticeSchema = z
     message: "notice.coordinate must be 'org' or 'org/slug'",
   });
 
+/**
+ * Display thumbnail derived server-side from a release's first image/gif media
+ * entry. Shared by the coverage, lookup, and related-release payloads.
+ */
+export const ReleaseThumbnailSchema = z.object({
+  url: z.string(),
+  alt: z.string().optional(),
+});
+
 export const OverviewPageItemSchema = z.object({
   scope: z.enum(["org", "product"]),
   orgSlug: z.string().nullable().optional(),