@buildinternet/releases-api-types 0.53.0 → 0.54.0

package/package.json

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

@@ -275,6 +275,7 @@ import type {
   CollectionWeeklyDigestListItemSchema,
   CollectionWeeklyDigestsResponseSchema,
   DigestCoveredReleaseSchema,
+  DigestSectionSchema,
   CollectionWeeklyDigestDetailSchema,
 } from "./schemas/collections.js";
 import type {
@@ -625,6 +626,7 @@ export {
   CollectionWeeklyDigestListItemSchema,
   CollectionWeeklyDigestsResponseSchema,
   DigestCoveredReleaseSchema,
+  DigestSectionSchema,
   CollectionWeeklyDigestDetailSchema,
 } from "./schemas/collections.js";
 export {
@@ -1806,6 +1808,7 @@ export type CollectionDailySummariesResponse = z.infer<
 export type CollectionWeeklyDigestListItem = z.infer<typeof CollectionWeeklyDigestListItemSchema>;
 export type CollectionWeeklyDigestsResponse = z.infer<typeof CollectionWeeklyDigestsResponseSchema>;
 export type DigestCoveredRelease = z.infer<typeof DigestCoveredReleaseSchema>;
+export type DigestSection = z.infer<typeof DigestSectionSchema>;
 export type CollectionWeeklyDigestDetail = z.infer<typeof CollectionWeeklyDigestDetailSchema>;
 
 // ── Releases (enriched) ──

package/src/schemas/collections.ts

@@ -273,8 +273,18 @@ export const CollectionWeeklyDigestsResponseSchema = z.object({
 export const DigestCoveredReleaseSchema = z.object({
   id: z.string(),
   title: z.string(),
+  /** Internal `/release/*` path — fallback link only (see `url`). */
   path: z.string(),
-  org: z.object({ slug: z.string(), name: z.string() }),
+  /** Upstream source URL. Primary link target when http(s); optional for older servers. */
+  url: z.string().nullable().optional(),
+  org: z.object({
+    slug: z.string(),
+    name: z.string(),
+    avatarUrl: z.string().nullable().optional(),
+    githubHandle: z.string().nullable().optional(),
+  }),
+  /** Product the release's source belongs to, when it has one. */
+  product: z.object({ slug: z.string(), name: z.string() }).nullable().optional(),
   /**
    * AI-scored importance 1–5. Null when unscored; optional for older
    * servers. Cheap to project on the existing hydrate — powers the flame
@@ -283,6 +293,17 @@ export const DigestCoveredReleaseSchema = z.object({
   importance: ImportanceScoreSchema,
 });
 
+/** One `###` section of a digest body, parsed server-side. */
+export const DigestSectionSchema = z.object({
+  heading: z.string(),
+  /** Slug the digest page renders as the heading's `id` — link target `#anchor`. */
+  anchor: z.string(),
+  /** First sentence of the section, plain text. */
+  lede: z.string(),
+  /** Cited release ids in first-seen order; resolve against the detail's `releases`. */
+  releaseIds: z.array(z.string()),
+});
+
 /** Full row returned by `GET /v1/collections/:slug/digests/:weekStart`. */
 export const CollectionWeeklyDigestDetailSchema = z.object({
   id: z.string(),
@@ -297,4 +318,6 @@ export const CollectionWeeklyDigestDetailSchema = z.object({
    *  still resolves — a release deleted/suppressed after generation is
    *  dropped rather than surfaced as a dead link. */
   releases: z.array(DigestCoveredReleaseSchema),
+  /** Parsed `###` sections. Optional for older servers. */
+  sections: z.array(DigestSectionSchema).optional(),
 });

package/src/schemas/search.ts

@@ -110,6 +110,14 @@ export const SearchReleaseHitSchema = z.object({
   summary: z.string(),
   titleGenerated: z.string().nullable().optional(),
   titleShort: z.string().nullable().optional(),
+  /**
+   * The release's upstream source URL, when it has one. Lets the web link
+   * search/lookup hits straight to the original page instead of the
+   * noindexed `/release/<id>` stub — see `releaseLinkProps()` in
+   * `web/src/lib/release-link.ts`. Optional for older servers / mid-deploy
+   * pin tolerance.
+   */
+  url: z.string().nullable().optional(),
   /**
    * AI-scored importance 1–5 (5=landmark, 1=housekeeping). Null when
    * unscored; optional for older servers / mid-deploy pin tolerance.
@@ -213,6 +221,9 @@ export const LookupResultPayloadSchema = z.object({
         publishedAt: z.string().nullable(),
         /** First image/gif thumbnail; null when the release has none. */
         thumbnail: ReleaseThumbnailSchema.nullable().optional(),
+        /** The release's upstream source URL, when it has one. See
+         *  `SearchReleaseHitSchema.url`. */
+        url: z.string().nullable().optional(),
       }),
     )
     .optional(),

package/src/schemas/shared.ts

@@ -206,8 +206,9 @@ export const OverviewCitationSchema = z.object({
   releaseId: z.string().nullable().optional(),
   /**
    * Canonical web URL of the on-registry release page for this source, when
-   * `releaseId` resolved (#1934). The Sources footer links here (internal,
-   * crawlable) in preference to the external `sourceUrl`.
+   * `releaseId` resolved (#1934). Kept for machine consumers; the web Sources
+   * footer links `sourceUrl` (the #2218 link policy — `/release/*` pages are
+   * noindexed).
    */
   releaseWebUrl: z.string().nullable().optional(),
   /**