@buildinternet/releases-api-types 0.19.0 → 0.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildinternet/releases-api-types",
-  "version": "0.19.0",
+  "version": "0.21.0",
   "description": "Wire protocol — request/response types for the Releases registry API. Shared by web, workers, and clients.",
   "type": "module",
   "license": "MIT",
@@ -18,7 +18,7 @@
   ],
   "dependencies": {
     "@buildinternet/releases-core": "^0.21.0",
-    "zod": "^4.3.6"
+    "zod": "^4.4.3"
   },
   "publishConfig": {
     "access": "public"

package/src/api-types.ts

@@ -16,6 +16,7 @@ import type {
   StatsSchema,
   ErrorResponseSchema,
   ReleaseTypeSchema,
+  ReleaseCompositionSchema,
   ReleaseItemSchema,
   ReleaseSummaryItemSchema,
   OverviewPageItemSchema,
@@ -59,6 +60,7 @@ import type {
   SourceListResponseSchema,
   SourceListResultSchema,
   SourceDetailSchema,
+  SourceFeedPaginationSchema,
   SourceMutationResponseSchema,
   SourceOrgRefSchema,
   SourcePatchInputSchema,
@@ -222,6 +224,7 @@ export {
   StatsSchema,
   ErrorResponseSchema,
   ReleaseTypeSchema,
+  ReleaseCompositionSchema,
   ReleaseItemSchema,
   ReleaseSummaryItemSchema,
   OverviewPageItemSchema,
@@ -266,6 +269,7 @@ export {
   SourceListResponseSchema,
   SourceListResultSchema,
   SourceDetailSchema,
+  SourceFeedPaginationSchema,
   SourceMutationResponseSchema,
   SourceOrgRefSchema,
   SourcePatchInputSchema,
@@ -506,6 +510,7 @@ export type CreateSourceBody = z.infer<typeof CreateSourceBodySchema>;
 export type ChangelogFileSummary = z.infer<typeof ChangelogFileSummarySchema>;
 export type SourceChangelogResponse = z.infer<typeof SourceChangelogResponseSchema>;
 export type SourceDetail = z.infer<typeof SourceDetailSchema>;
+export type SourceFeedPagination = z.infer<typeof SourceFeedPaginationSchema>;
 export type SourceMutationResponse = z.infer<typeof SourceMutationResponseSchema>;
 export type SourceOrgRef = z.infer<typeof SourceOrgRefSchema>;
 export type SourceActivityResponse = z.infer<typeof SourceActivityResponseSchema>;
@@ -571,6 +576,7 @@ export interface OrgsRollupResponse extends ListResponse<OrgsRollupRow> {
 export type ReleaseType = z.infer<typeof ReleaseTypeSchema>;
 
 export type ReleaseItem = z.infer<typeof ReleaseItemSchema>;
+export type ReleaseComposition = z.infer<typeof ReleaseCompositionSchema>;
 
 export interface ReleaseDetail {
   id: string;
@@ -599,6 +605,8 @@ export interface ReleaseDetail {
   org: { slug: string; name: string } | null;
   /** Release type. See {@link ReleaseType}. */
   type?: ReleaseType;
+  /** Per-category item counts from the AI release-content pass. See {@link ReleaseComposition}. */
+  composition?: ReleaseComposition | null;
 }
 
 export type ReleaseCoverageRow = z.infer<typeof ReleaseCoverageRowSchema>;

package/src/schemas/orgs.ts

@@ -3,6 +3,7 @@ import {
   CategorySchema,
   ListResponseSchema,
   OverviewPageItemSchema,
+  PaginationSchema,
   ReleaseItemSchema,
 } from "./shared.js";
 import { SourceListItemSchema } from "./sources.js";
@@ -25,7 +26,28 @@ export const OrgListItemSchema = z.object({
   sparkline: z.array(z.number().int().min(0)).length(30),
 });
 
-export const OrgListResponseSchema = ListResponseSchema(OrgListItemSchema);
+/**
+ * Per-request side-channel for the orgs list (#746). `emptyOrgCount` is the
+ * number of orgs that match the same `q` filter but have zero indexed
+ * releases — used to label a "Show empty orgs" toggle without a second
+ * round-trip. The value is scoped by the search term but independent of
+ * `?includeEmpty=` so the toggle CTA can render a count whether the current
+ * response included empty orgs or not.
+ */
+export const OrgListMetaSchema = z.object({
+  emptyOrgCount: z.number().int().min(0),
+});
+
+/**
+ * `meta` is optional on the wire so older workers / pinned clients mid-deploy
+ * don't trip the schema check. New clients can treat missing as
+ * `emptyOrgCount: 0` (the toggle just won't render a count).
+ */
+export const OrgListResponseSchema = z.object({
+  items: z.array(OrgListItemSchema),
+  pagination: PaginationSchema,
+  meta: OrgListMetaSchema.optional(),
+});
 
 export const OrgAccountItemSchema = z.object({
   platform: z.string(),
@@ -78,6 +100,8 @@ export const UpdateOrgBodySchema = z.object({
   avatarUrl: z.string().nullable().optional(),
   tags: z.array(z.string()).optional(),
   aliases: z.array(z.string()).optional(),
+  /** Admin-only: pause/unpause all ingest for this org without touching sources (#1057). */
+  fetchPaused: z.boolean().optional(),
 });
 
 // Org detail's products query selects a strict subset of `ProductListItem` —

package/src/schemas/releases.ts

@@ -1,6 +1,9 @@
 import { z } from "zod";
 import { SOURCE_TYPES } from "@buildinternet/releases-core/source-enums";
-import { MediaItemSchema, ReleaseTypeSchema } from "./shared.js";
+import { MediaItemSchema, ReleaseCompositionSchema, ReleaseTypeSchema } from "./shared.js";
+
+// ReleaseCompositionSchema lives in ./shared.js (single source of truth) — both
+// this file and ReleaseItemSchema reference it from there.
 
 /**
  * Per-row shape returned by `GET /v1/releases/latest`. Distinct from the
@@ -36,6 +39,7 @@ export const ReleaseLatestItemSchema = z.object({
   // same fields on the org / collection feeds. #958.
   contentChars: z.number().int().min(0).nullable().optional(),
   contentTokens: z.number().int().min(0).nullable().optional(),
+  composition: ReleaseCompositionSchema.nullable().optional(),
 });
 
 export const ReleaseLatestResponseSchema = z.object({
@@ -155,6 +159,7 @@ export const ReleaseDetailResponseSchema = z.object({
   sourceSlug: z.string().nullable(),
   sourceType: z.enum(SOURCE_TYPES).nullable(),
   org: ReleaseDetailOrgSchema.nullable(),
+  composition: ReleaseCompositionSchema.nullable(),
 });
 
 /**
@@ -177,6 +182,8 @@ export const UpdateReleaseBodySchema = z
     summary: z.string().nullable().optional(),
     titleGenerated: z.string().nullable().optional(),
     titleShort: z.string().nullable().optional(),
+    // `null` removes `$.composition` from metadata; an object replaces it.
+    composition: ReleaseCompositionSchema.nullable().optional(),
   })
   .strict();
 

package/src/schemas/shared.ts

@@ -46,6 +46,19 @@ export const StatsSchema = z.object({
 
 export const ReleaseTypeSchema = z.enum(RELEASE_TYPES);
 
+/**
+ * Per-category item counts produced by the AI release-content pass and
+ * persisted on `releases.metadata.composition`. Surfaces as a chip on the
+ * release detail UI ("12 fixes · 3 features"); `null` when the row hasn't
+ * been through the AI pass yet, the body was empty/boilerplate, or all
+ * three counts came back zero (we filter that case out on the parse side).
+ */
+export const ReleaseCompositionSchema = z.object({
+  bugs: z.number().int().min(0),
+  features: z.number().int().min(0),
+  enhancements: z.number().int().min(0),
+});
+
 export const ReleaseItemSchema = z.object({
   id: z.string().optional(),
   version: z.string().nullable(),
@@ -89,6 +102,10 @@ export const ReleaseItemSchema = z.object({
   // when null. See #958.
   contentChars: z.number().int().min(0).nullable().optional(),
   contentTokens: z.number().int().min(0).nullable().optional(),
+  // Per-category item counts produced by the AI release-content pass and
+  // stored on `releases.metadata.composition`. `null`/`undefined` when the
+  // row hasn't been through the AI pass yet or the body was boilerplate.
+  composition: ReleaseCompositionSchema.nullable().optional(),
 });
 
 export const ReleaseSummaryItemSchema = z.object({

package/src/schemas/sources.ts

@@ -4,12 +4,7 @@ import {
   SOURCE_DISCOVERY,
   SOURCE_FETCH_PRIORITIES,
 } from "@buildinternet/releases-core/source-enums";
-import {
-  ListResponseSchema,
-  PaginationSchema,
-  ReleaseItemSchema,
-  ReleaseSummaryItemSchema,
-} from "./shared.js";
+import { ListResponseSchema, ReleaseItemSchema, ReleaseSummaryItemSchema } from "./shared.js";
 
 export const SourceTypeSchema = z.enum(SOURCE_TYPES);
 export const SourceDiscoverySchema = z.enum(SOURCE_DISCOVERY);
@@ -105,6 +100,17 @@ const SourceDetailSummariesSchema = z.object({
   monthly: z.array(ReleaseSummaryItemSchema),
 });
 
+/**
+ * Cursor pagination shape for the source detail's embedded release feed.
+ * Mirrors `OrgFeedPaginationSchema` and `CollectionFeedPaginationSchema` —
+ * release lists are feed-shaped (append-only, mutates between calls), so they
+ * use cursor pagination per the AGENTS.md convention.
+ */
+export const SourceFeedPaginationSchema = z.object({
+  nextCursor: z.string().nullable(),
+  limit: z.number().int().min(1),
+});
+
 /**
  * Resolved attribution block returned alongside a source row. `id` is
  * additive vs the legacy `{ slug, name }` shape — older clients that ignored
@@ -149,7 +155,7 @@ export const SourceDetailSchema = z.object({
   lastPolledAt: z.string().nullable(),
   trackingSince: z.string(),
   releases: z.array(ReleaseItemSchema),
-  pagination: PaginationSchema,
+  pagination: SourceFeedPaginationSchema,
   summaries: SourceDetailSummariesSchema,
 });