@buildinternet/releases-api-types 0.11.0 → 0.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildinternet/releases-api-types",
-  "version": "0.11.0",
+  "version": "0.12.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

@@ -209,6 +209,15 @@ export interface ReleaseDetail {
   title: string;
   content: string;
   contentSummary: string | null;
+  /**
+   * AI-generated self-contained news-headline form of the release (#852).
+   * Nullable because most rows are unpopulated — fall back to `title` for
+   * display. `.optional()` for the same mid-deploy / pinned-worker reason
+   * as `type` on {@link ReleaseItem}.
+   */
+  contentTitle?: string | null;
+  /** AI-generated smart-brevity headline (#852). Same fallback as `contentTitle`. */
+  contentTitleShort?: string | null;
   url: string | null;
   media: MediaItem[];
   publishedAt: string | null;
@@ -334,6 +343,10 @@ export interface SearchReleaseHit {
   version: string | null;
   title: string;
   summary: string;
+  /** AI-generated headline (#852). Optional + nullable: most rows are unpopulated. */
+  contentTitle?: string | null;
+  /** AI-generated smart-brevity headline (#852). Same caveat as contentTitle. */
+  contentTitleShort?: string | null;
   /**
    * Full release body, media URLs hydrated through the MEDIA_ORIGIN proxy.
    * Present so the web can render the same markdown + thumbnail treatment
@@ -786,6 +799,10 @@ export interface ReleaseWithSource {
   title: string;
   content: string;
   contentSummary: string | null;
+  /** AI-generated headline (#852). See {@link ReleaseDetail.contentTitle}. */
+  contentTitle?: string | null;
+  /** AI-generated smart-brevity headline (#852). */
+  contentTitleShort?: string | null;
   url: string | null;
   contentHash: string | null;
   metadata: string | null;
@@ -805,6 +822,10 @@ export interface LatestRelease {
   sourceName: string;
   sourceSlug: string;
   contentSummary: string | null;
+  /** AI-generated headline (#852). See {@link ReleaseDetail.contentTitle}. */
+  contentTitle?: string | null;
+  /** AI-generated smart-brevity headline (#852). */
+  contentTitleShort?: string | null;
   media: MediaItem[];
 }
 

package/src/schemas/shared.ts

@@ -57,6 +57,12 @@ export const ReleaseItemSchema = z.object({
   // fall back to a SemVer-prerelease regex. `.optional()` for the same
   // older-response degrade-gracefully reason as `type`.
   prerelease: z.boolean().optional(),
+  // AI-generated headline forms paired with `summary` (#852). Both nullable —
+  // most rows in the DB have neither populated, and we don't plan to backfill,
+  // so consumers must fall back to `title` for display. `.optional()` for the
+  // same mid-deploy / pinned-worker reason as `type`.
+  contentTitle: z.string().nullable().optional(),
+  contentTitleShort: z.string().nullable().optional(),
 });
 
 export const ReleaseSummaryItemSchema = z.object({