@buildinternet/releases-api-types 0.8.1 → 0.10.0

package/package.json

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

@@ -133,6 +133,7 @@ export interface SitemapPayload {
   orgs: Array<{ slug: string; lastActivity: string | null }>;
   sources: Array<{ orgSlug: string; slug: string; latestDate: string | null }>;
   products: Array<{ orgSlug: string; slug: string }>;
+  collections: Array<{ slug: string; updatedAt: string }>;
 }
 
 // ── Organizations ──
@@ -674,6 +675,91 @@ export interface TagDetail {
   products: TaxonomyProduct[];
 }
 
+// ── Collections ──
+//
+// Curated, named groups of orgs that drive a public "playlist" page (e.g.
+// /collections/frontier-ai-labs). Independent of the fixed `category` taxonomy.
+
+export interface CollectionMemberOrg {
+  slug: string;
+  name: string;
+  domain: string | null;
+  avatarUrl: string | null;
+  description: string | null;
+}
+
+/** Item shape on GET /v1/collections (list). */
+export interface CollectionListItem {
+  slug: string;
+  name: string;
+  description: string | null;
+  memberCount: number;
+}
+
+/** Detail shape on GET /v1/collections/:slug. */
+export interface CollectionDetail {
+  slug: string;
+  name: string;
+  description: string | null;
+  orgs: CollectionMemberOrg[];
+}
+
+/**
+ * Cross-org release feed row. Same shape as `OrgReleaseItem` plus the origin
+ * `org` block, so the web's release card can render it identically — full
+ * `content` lets "Show more" expand to the body instead of the truncated
+ * `summary`.
+ */
+export interface CollectionReleaseItem extends OrgReleaseItem {
+  org: { slug: string; name: string };
+}
+
+export interface CollectionReleasesResponse {
+  releases: CollectionReleaseItem[];
+  pagination: { nextCursor: string | null; limit: number };
+}
+
+/** Body for POST /v1/collections. `slug` derives from `name` via toSlug() if omitted. */
+export interface CreateCollectionRequest {
+  slug?: string;
+  name: string;
+  description?: string | null;
+}
+
+/** Body for PATCH /v1/collections/:slug. All fields optional; slug rename is allowed. */
+export interface UpdateCollectionRequest {
+  slug?: string;
+  name?: string;
+  description?: string | null;
+}
+
+/** A single member entry accepted by the member-write endpoints. */
+export interface CollectionMemberInput {
+  /** Either `orgId` (org_…) or `orgSlug` is required; if both are given, `orgId` wins. */
+  orgId?: string;
+  orgSlug?: string;
+  /** Authoring position (default 0). For PUT, omit to use array index. */
+  position?: number;
+}
+
+/** Body for POST /v1/collections/:slug/members. */
+export type AddCollectionMemberRequest = CollectionMemberInput;
+
+/** Body for PUT /v1/collections/:slug/members. Replaces the full membership atomically. */
+export interface ReplaceCollectionMembersRequest {
+  orgs: CollectionMemberInput[];
+}
+
+/** Bare row returned by POST/PATCH on /v1/collections. */
+export interface CollectionRow {
+  id: string;
+  slug: string;
+  name: string;
+  description: string | null;
+  createdAt: string;
+  updatedAt: string;
+}
+
 // ── Releases (enriched) ──
 
 /** Flat release shape returned by GET /v1/releases/:id with source metadata. */