@buildinternet/releases-api-types 0.24.0 → 0.26.0

package/package.json

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

@@ -90,6 +90,7 @@ import type {
   DeleteSourceReleasesResponseSchema,
   InsertReleaseResponseSchema,
   BatchReleasesResponseSchema,
+  RawSnapshotResponseSchema,
   OversizedChangelogFileRowSchema,
   OversizedChangelogFilesResponseSchema,
   FetchableSourcesResponseSchema,
@@ -316,6 +317,7 @@ export {
   DeleteSourceReleasesResponseSchema,
   InsertReleaseResponseSchema,
   BatchReleasesResponseSchema,
+  RawSnapshotResponseSchema,
   OversizedChangelogFileRowSchema,
   OversizedChangelogFilesResponseSchema,
   FetchableSourcesResponseSchema,
@@ -572,6 +574,7 @@ export type DeleteSourceResponse = z.infer<typeof DeleteSourceResponseSchema>;
 export type DeleteSourceReleasesResponse = z.infer<typeof DeleteSourceReleasesResponseSchema>;
 export type InsertReleaseResponse = z.infer<typeof InsertReleaseResponseSchema>;
 export type BatchReleasesResponse = z.infer<typeof BatchReleasesResponseSchema>;
+export type RawSnapshotResponse = z.infer<typeof RawSnapshotResponseSchema>;
 export type OversizedChangelogFileRow = z.infer<typeof OversizedChangelogFileRowSchema>;
 export type OversizedChangelogFilesResponse = z.infer<typeof OversizedChangelogFilesResponseSchema>;
 export type FetchableSourcesResponse = z.infer<typeof FetchableSourcesResponseSchema>;
@@ -703,6 +706,8 @@ export interface ReleaseDetail {
   composition?: ReleaseComposition | null;
   /** App Store platform + icon, present only when `sourceType === "appstore"`. */
   appStore?: { platform: "ios" | "macos"; iconUrl: string | null } | null;
+  /** Video provider tag, present only when `sourceType === "video"`. */
+  video?: { provider: "youtube" | "vimeo" | "wistia" } | null;
 }
 
 export type ReleaseCoverageSibling = z.infer<typeof ReleaseCoverageSiblingSchema>;
@@ -902,6 +907,7 @@ export type OverviewPlanAction = "missing" | "refresh" | "skip";
 export interface OverviewManifestRow {
   orgSlug: string;
   orgName: string;
+  orgCreatedAt: string;
   discovery: "curated" | "agent" | "on_demand";
   overviewUpdatedAt: string | null;
   overviewGeneratedAt: string | null;

package/src/schemas/orgs.ts

@@ -7,6 +7,7 @@ import {
   OverviewPageItemSchema,
   PaginationSchema,
   ReleaseItemSchema,
+  VideoSourceInfoSchema,
 } from "./shared.js";
 import { SourceListItemSchema } from "./sources.js";
 import { ProductListItemSchema } from "./products.js";
@@ -20,6 +21,7 @@ export const OrgListItemSchema = z.object({
   description: z.string().nullable(),
   category: CategorySchema.nullable(),
   avatarUrl: z.string().nullable(),
+  featured: z.boolean(),
   sourceCount: z.number().int().min(0),
   releaseCount: z.number().int().min(0),
   recentReleaseCount: z.number().int().min(0),
@@ -108,11 +110,13 @@ export const UpdateOrgBodySchema = z.object({
   isHidden: z.boolean().optional(),
   /** Admin-only: opt the org into automatic AI content — org overviews AND per-release summaries (single backend flag `auto_generate_content`). */
   autoGenerateContent: z.boolean().optional(),
+  /** Admin-only: promote this org on the home-page featured rail. */
+  featured: z.boolean().optional(),
 });
 
 // Org detail's products query selects a strict subset of `ProductListItem` —
-// no category/orgId/createdAt because the parent already names the org and
-// the org detail UI doesn't surface those columns.
+// no category/orgId because the parent already names the org; createdAt is
+// included for age-based filtering by consumers.
 const OrgDetailProductSchema = ProductListItemSchema.pick({
   id: true,
   slug: true,
@@ -121,6 +125,7 @@ const OrgDetailProductSchema = ProductListItemSchema.pick({
   description: true,
   sourceCount: true,
   kind: true,
+  createdAt: true,
 }).extend({
   releaseCount: z.number().int().min(0),
 });
@@ -341,6 +346,7 @@ export const OrgReleaseItemSchema = ReleaseItemSchema.extend({
     name: z.string(),
     type: z.string(),
     appStore: AppStoreSourceInfoSchema.optional(),
+    video: VideoSourceInfoSchema.optional(),
   }),
   /**
    * Owning product, when the release's source is grouped under a product.
@@ -427,6 +433,8 @@ export const OrgDetailSchema = z.object({
   isHidden: z.boolean().optional(),
   /** Admin display flag: org is opted into automatic overviews + per-release summaries. Optional on the wire for older workers mid-deploy. */
   autoGenerateContent: z.boolean().optional(),
+  /** Admin display flag: org is promoted on the home-page featured rail. Optional on the wire for older workers mid-deploy. */
+  featured: z.boolean().optional(),
   /** Admin display flag: all ingest paused for this org. */
   fetchPaused: z.boolean().optional(),
   /** How the org row was created. `on_demand` orgs are excluded from overview generation regardless of `autoGenerateContent`. */

package/src/schemas/releases.ts

@@ -5,6 +5,7 @@ import {
   MediaItemSchema,
   ReleaseCompositionSchema,
   ReleaseTypeSchema,
+  VideoSourceInfoSchema,
 } from "./shared.js";
 
 // ReleaseCompositionSchema lives in ./shared.js (single source of truth) — both
@@ -200,6 +201,7 @@ export const ReleaseDetailResponseSchema = z.object({
   org: ReleaseDetailOrgSchema.nullable(),
   composition: ReleaseCompositionSchema.nullable(),
   appStore: AppStoreSourceInfoSchema.nullable().optional(),
+  video: VideoSourceInfoSchema.nullable().optional(),
 });
 
 /**

package/src/schemas/search.ts

@@ -1,6 +1,11 @@
 import { z } from "zod";
 import { KIND_VALUES } from "@buildinternet/releases-core/kinds";
-import { MediaItemSchema, ReleaseTypeSchema } from "./shared.js";
+import {
+  AppStoreSourceInfoSchema,
+  MediaItemSchema,
+  ReleaseTypeSchema,
+  VideoSourceInfoSchema,
+} from "./shared.js";
 import { SourceTypeSchema } from "./sources.js";
 import { LookupStatusSchema } from "./lookups.js";
 
@@ -66,6 +71,16 @@ export const SearchReleaseHitSchema = z.object({
   // without re-validating; legacy rows occasionally drift from the
   // canonical four-value set. Used by the web byline icon.
   sourceType: z.string().optional(),
+  /**
+   * App Store platform + icon for `type: "appstore"` sources, null/absent
+   * otherwise. Powers the compact app-update treatment on the search card. #1206
+   */
+  appStore: AppStoreSourceInfoSchema.nullable().optional(),
+  /**
+   * Video provider tag for `type: "video"` sources, absent otherwise. Powers
+   * the thumbnail-forward video row on search cards. #video
+   */
+  video: VideoSourceInfoSchema.nullable().optional(),
   orgSlug: z.string().nullable(),
   orgName: z.string().nullable().optional(),
   /** Owning product slug — present when the source belongs to a product. Lets

package/src/schemas/shared.ts

@@ -22,6 +22,12 @@ export const AppStoreSourceInfoSchema = z.object({
   iconUrl: z.string().nullable(),
 });
 
+/** Video provider tag, present only when `sourceType === "video"`. Thumbnail
+ * and watch URL reuse the release's existing `media[]` / `url`. */
+export const VideoSourceInfoSchema = z.object({
+  provider: z.enum(["youtube", "vimeo", "wistia"]),
+});
+
 export const PaginationSchema = z.object({
   page: z.number().int().min(1),
   pageSize: z.number().int().min(1),

package/src/schemas/sources.ts

@@ -559,6 +559,24 @@ export const BatchReleasesResponseSchema = z.object({
   total: z.number().int().min(0),
 });
 
+// ── Raw page snapshot (POST /sources/:slug/raw-snapshot) ──
+
+/**
+ * Response for `POST /v1/sources/:slug/raw-snapshot` (#1283). On a store or a
+ * content-hash dedup hit, all fields are present; `stored` is `false` for the
+ * dedup case. When the `RAW_SNAPSHOTS` bucket is unbound the capture soft-fails
+ * with `{ stored: false, reason: "no_binding" }` and the snapshot fields are
+ * omitted — capture is best-effort and never errors ingest.
+ */
+export const RawSnapshotResponseSchema = z.object({
+  stored: z.boolean(),
+  r2Key: z.string().optional(),
+  contentHash: z.string().optional(),
+  bytes: z.number().int().min(0).optional(),
+  // Only set on the soft-fail path; bounded so consumers can branch on it.
+  reason: z.enum(["no_binding"]).optional(),
+});
+
 // ── Oversized changelog files (GET /sources/changelog-files/oversized) ──
 
 /**