@buildinternet/releases-api-types 0.45.1 → 0.47.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildinternet/releases-api-types",
-  "version": "0.45.1",
+  "version": "0.47.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.27.0",
+    "@buildinternet/releases-core": "^0.28.0",
     "zod": "^4.4.3"
   },
   "publishConfig": {

package/src/api-types.ts

@@ -203,7 +203,12 @@ import type {
   FeedbackUpdateBodySchema,
   FeedbackDeleteResponseSchema,
 } from "./schemas/feedback.js";
-import type { SitemapSourceSchema, SitemapPayloadSchema } from "./schemas/sitemap.js";
+import type {
+  SitemapSourceSchema,
+  SitemapPayloadSchema,
+  SitemapReleaseSchema,
+  SitemapReleasesPayloadSchema,
+} from "./schemas/sitemap.js";
 import type {
   RelatedScopeSchema,
   RelatedReleaseThumbnailSchema,
@@ -239,6 +244,10 @@ import type {
   AddCollectionMemberResponseSchema,
   CollectionDailySummarySchema,
   CollectionDailySummariesResponseSchema,
+  CollectionWeeklyDigestListItemSchema,
+  CollectionWeeklyDigestsResponseSchema,
+  DigestCoveredReleaseSchema,
+  CollectionWeeklyDigestDetailSchema,
 } from "./schemas/collections.js";
 import type {
   OrgOverviewResponseSchema,
@@ -510,7 +519,12 @@ export {
   FeedbackUpdateBodySchema,
   FeedbackDeleteResponseSchema,
 } from "./schemas/feedback.js";
-export { SitemapSourceSchema, SitemapPayloadSchema } from "./schemas/sitemap.js";
+export {
+  SitemapSourceSchema,
+  SitemapPayloadSchema,
+  SitemapReleaseSchema,
+  SitemapReleasesPayloadSchema,
+} from "./schemas/sitemap.js";
 export { errorEnvelopeSchema, decodeApiError, isApiError } from "./schemas/errors.js";
 export type { ErrorEnvelope, DecodedApiError } from "./schemas/errors.js";
 export {
@@ -548,6 +562,10 @@ export {
   AddCollectionMemberResponseSchema,
   CollectionDailySummarySchema,
   CollectionDailySummariesResponseSchema,
+  CollectionWeeklyDigestListItemSchema,
+  CollectionWeeklyDigestsResponseSchema,
+  DigestCoveredReleaseSchema,
+  CollectionWeeklyDigestDetailSchema,
 } from "./schemas/collections.js";
 export {
   OrgOverviewResponseSchema,
@@ -623,6 +641,8 @@ export interface CreateUserApiKeyBody {
 
 export type SitemapSource = z.infer<typeof SitemapSourceSchema>;
 export type SitemapPayload = z.infer<typeof SitemapPayloadSchema>;
+export type SitemapRelease = z.infer<typeof SitemapReleaseSchema>;
+export type SitemapReleasesPayload = z.infer<typeof SitemapReleasesPayloadSchema>;
 
 // ── Related (Vectorize neighbors) ──
 
@@ -1527,6 +1547,10 @@ export type CollectionDailySummary = z.infer<typeof CollectionDailySummarySchema
 export type CollectionDailySummariesResponse = z.infer<
   typeof CollectionDailySummariesResponseSchema
 >;
+export type CollectionWeeklyDigestListItem = z.infer<typeof CollectionWeeklyDigestListItemSchema>;
+export type CollectionWeeklyDigestsResponse = z.infer<typeof CollectionWeeklyDigestsResponseSchema>;
+export type DigestCoveredRelease = z.infer<typeof DigestCoveredReleaseSchema>;
+export type CollectionWeeklyDigestDetail = z.infer<typeof CollectionWeeklyDigestDetailSchema>;
 
 // ── Releases (enriched) ──
 

package/src/schemas/collections.ts

@@ -249,3 +249,46 @@ export const CollectionDailySummarySchema = z.object({
 export const CollectionDailySummariesResponseSchema = z.object({
   summaries: z.array(CollectionDailySummarySchema),
 });
+
+// ── Weekly digests ────────────────────────────────────────────────
+
+/** List row on `GET /v1/collections/:slug/digests` — newest-first, no body. */
+export const CollectionWeeklyDigestListItemSchema = z.object({
+  id: z.string(),
+  /** ET Monday starting the covered week, YYYY-MM-DD. */
+  weekStart: z.string(),
+  title: z.string(),
+  intro: z.string(),
+  releaseCount: z.number().int().nonnegative(),
+  generatedAt: z.string(),
+});
+
+/** Cursor pagination shape matches the other paginated list surfaces. */
+export const CollectionWeeklyDigestsResponseSchema = z.object({
+  digests: z.array(CollectionWeeklyDigestListItemSchema),
+  pagination: CollectionFeedPaginationSchema,
+});
+
+/** Minimal, server-resolved release info for a digest's "Releases covered" list. */
+export const DigestCoveredReleaseSchema = z.object({
+  id: z.string(),
+  title: z.string(),
+  path: z.string(),
+  org: z.object({ slug: z.string(), name: z.string() }),
+});
+
+/** Full row returned by `GET /v1/collections/:slug/digests/:weekStart`. */
+export const CollectionWeeklyDigestDetailSchema = z.object({
+  id: z.string(),
+  weekStart: z.string(),
+  title: z.string(),
+  intro: z.string(),
+  body: z.string(),
+  releaseIds: z.array(z.string()),
+  releaseCount: z.number().int().nonnegative(),
+  generatedAt: z.string(),
+  /** Server-resolved minimal release info for every id in `releaseIds` that
+   *  still resolves — a release deleted/suppressed after generation is
+   *  dropped rather than surfaced as a dead link. */
+  releases: z.array(DigestCoveredReleaseSchema),
+});

package/src/schemas/search.ts

@@ -228,6 +228,16 @@ export const UnifiedSearchResponseSchema = z.object({
   // domain filter was applied.
   domain: z.string().optional(),
   domainStatus: z.enum(["matched", "not_found"]).optional(),
+  // Normalized `?category=` echo. Present only when a category filter was
+  // applied; the resolved canonical slug (aliases are folded to canonical).
+  // `categoryStatus` is always `matched` because an unknown category is a 400,
+  // not an empty envelope — categories are a fixed enum, unlike collections.
+  category: z.string().optional(),
+  categoryStatus: z.enum(["matched"]).optional(),
+  // Normalized `?collection=` echo + resolution outcome. `not_found` when the
+  // slug matched no collection (empty envelope, mirroring `domainStatus`).
+  collection: z.string().optional(),
+  collectionStatus: z.enum(["matched", "not_found"]).optional(),
   orgs: z.array(SearchOrgHitSchema),
   catalog: z.array(SearchCatalogHitSchema),
   sources: z.array(SearchSourceHitSchema),

package/src/schemas/sitemap.ts

@@ -39,4 +39,42 @@ export const SitemapPayloadSchema = z.object({
   sources: z.array(SitemapSourceSchema),
   products: z.array(z.object({ orgSlug: z.string(), slug: z.string() })),
   collections: z.array(z.object({ slug: z.string(), updatedAt: z.string() })),
+  /**
+   * Weekly collection digest permalinks (`/collections/:slug/digest/:week`),
+   * with `generatedAt` driving `<lastmod>`. `.optional()` for backwards
+   * compatibility with older cached responses. Small at 12 collections × 52
+   * weeks/year, so no dedicated `/sitemap/digests` surface (unlike releases).
+   */
+  digests: z
+    .array(
+      z.object({
+        collectionSlug: z.string(),
+        weekStart: z.string(),
+        generatedAt: z.string(),
+      }),
+    )
+    .optional(),
+});
+
+/**
+ * Per-release row in `GET /v1/sitemap/releases` (#1181, scoped down). Carries
+ * exactly what the web needs to build the slugged canonical `/release/...`
+ * URL (`releasePath()` inputs) plus `fetchedAt` for `<lastmod>`.
+ */
+export const SitemapReleaseSchema = z.object({
+  id: z.string(),
+  title: z.string(),
+  titleShort: z.string().nullable(),
+  titleGenerated: z.string().nullable(),
+  version: z.string().nullable(),
+  publishedAt: z.string().nullable(),
+  fetchedAt: z.string(),
+});
+
+/**
+ * Payload for the curated release sitemap: visible releases with a summary
+ * and importance at or above the experiment threshold, newest first, capped.
+ */
+export const SitemapReleasesPayloadSchema = z.object({
+  releases: z.array(SitemapReleaseSchema),
 });