@buildinternet/releases-api-types 0.10.0 → 0.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildinternet/releases-api-types",
-  "version": "0.10.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",
@@ -17,7 +17,7 @@
     "README.md"
   ],
   "dependencies": {
-    "@buildinternet/releases-core": "^0.18.0",
+    "@buildinternet/releases-core": "^0.19.0",
     "zod": "^4.3.6"
   },
   "publishConfig": {

package/src/api-types.ts

@@ -19,6 +19,7 @@ import type {
   ReleaseItemSchema,
   ReleaseSummaryItemSchema,
   OverviewPageItemSchema,
+  OverviewCitationSchema,
 } from "./schemas/shared.js";
 import type {
   OrgListItemSchema,
@@ -68,6 +69,7 @@ export {
   ReleaseItemSchema,
   ReleaseSummaryItemSchema,
   OverviewPageItemSchema,
+  OverviewCitationSchema,
   CategorySchema,
 } from "./schemas/shared.js";
 export {
@@ -207,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;
@@ -332,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
@@ -492,6 +507,7 @@ export interface UnifiedSearchResponse {
 // ── Overview Pages ──
 
 export type OverviewPageItem = z.infer<typeof OverviewPageItemSchema>;
+export type OverviewCitation = z.infer<typeof OverviewCitationSchema>;
 
 /** @deprecated Use OverviewPageItem */
 export type KnowledgePageItem = OverviewPageItem;
@@ -685,15 +701,19 @@ export interface CollectionMemberOrg {
   name: string;
   domain: string | null;
   avatarUrl: string | null;
+  /** GitHub handle from org_accounts; lets the avatar fall back to github.com/<handle>.png. */
+  githubHandle: string | null;
   description: string | null;
 }
 
-/** Item shape on GET /v1/collections (list). */
+/** Item shape on GET /v1/collections (list) and GET /v1/orgs/:slug/collections. */
 export interface CollectionListItem {
   slug: string;
   name: string;
   description: string | null;
   memberCount: number;
+  /** First few members for inline preview on the list page (capped at 3). */
+  previewMembers?: CollectionMemberOrg[];
 }
 
 /** Detail shape on GET /v1/collections/:slug. */
@@ -712,6 +732,15 @@ export interface CollectionDetail {
  */
 export interface CollectionReleaseItem extends OrgReleaseItem {
   org: { slug: string; name: string };
+  /**
+   * Product the release belongs to, if the source is bound to one. Powers
+   * the timeline's same-product rollup ("3 earlier Claude Code releases
+   * today") on the collections view. `null` for orgs without products or
+   * standalone sources. Optional on the wire so older workers mid-rollout
+   * (and hand-constructed test fixtures) don't trip the typecheck — clients
+   * should treat missing and `null` identically.
+   */
+  product?: { slug: string; name: string } | null;
 }
 
 export interface CollectionReleasesResponse {
@@ -770,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;
@@ -789,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({
@@ -68,6 +74,22 @@ export const ReleaseSummaryItemSchema = z.object({
   generatedAt: z.string(),
 });
 
+/**
+ * Inline citation attached to an overview page (#846). Each row maps a
+ * character span in `OverviewPageItem.content` back to a release URL the
+ * model cited via Anthropic's search_result blocks. Optional everywhere it
+ * appears — pages generated before #846 lands have none, and consumers
+ * should degrade gracefully.
+ */
+export const OverviewCitationSchema = z.object({
+  startIndex: z.number().int().min(0),
+  endIndex: z.number().int().min(0),
+  sourceUrl: z.string(),
+  title: z.string().nullable().optional(),
+  citedText: z.string(),
+  releaseId: z.string().nullable().optional(),
+});
+
 export const OverviewPageItemSchema = z.object({
   scope: z.enum(["org", "product"]),
   orgSlug: z.string().nullable().optional(),
@@ -77,4 +99,5 @@ export const OverviewPageItemSchema = z.object({
   lastContributingReleaseAt: z.string().nullable(),
   generatedAt: z.string(),
   updatedAt: z.string(),
+  citations: z.array(OverviewCitationSchema).optional(),
 });