@buildinternet/releases-api-types 0.20.0 → 0.21.0

package/package.json

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

package/src/api-types.ts

@@ -60,6 +60,7 @@ import type {
   SourceListResponseSchema,
   SourceListResultSchema,
   SourceDetailSchema,
+  SourceFeedPaginationSchema,
   SourceMutationResponseSchema,
   SourceOrgRefSchema,
   SourcePatchInputSchema,
@@ -268,6 +269,7 @@ export {
   SourceListResponseSchema,
   SourceListResultSchema,
   SourceDetailSchema,
+  SourceFeedPaginationSchema,
   SourceMutationResponseSchema,
   SourceOrgRefSchema,
   SourcePatchInputSchema,
@@ -508,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>;

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(),

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,
 });