@buildinternet/releases-api-types 0.54.0 → 0.56.0

package/README.md

@@ -1,5 +1,7 @@
 # @buildinternet/releases-api-types
 
+**Scope:** request/response wire types for the public API worker — types only, zero runtime dependencies. No request logic, no client code, no server handlers.
+
 Wire protocol types for the [Releases](https://releases.sh) registry API.
 
 Pure TypeScript types — zero runtime dependencies — describing request/response

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildinternet/releases-api-types",
-  "version": "0.54.0",
+  "version": "0.56.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.31.0",
+    "@buildinternet/releases-core": "^0.32.0",
     "zod": "^4.4.3"
   },
   "publishConfig": {

package/src/api-types.ts

@@ -433,6 +433,18 @@ export {
   type ListingPromoteResult,
   type ListingCapabilities,
 } from "./schemas/listing.js";
+export {
+  CreatePublishTokenBodySchema,
+  CreatedPublishTokenSchema,
+  PublishTokenSchema,
+  ListPublishTokensResponseSchema,
+  RevokePublishTokenResponseSchema,
+  type CreatePublishTokenBody,
+  type CreatedPublishToken,
+  type PublishToken,
+  type ListPublishTokensResponse,
+  type RevokePublishTokenResponse,
+} from "./schemas/publish-tokens.js";
 export {
   SourceListItemSchema,
   SourceWithOrgSchema,
@@ -1770,7 +1782,7 @@ export type TagDetail = z.infer<typeof TagDetailSchema>;
 /**
  * Aggregated release feed row for a category rollup — same wire shape as
  * `CollectionReleaseItem` (both surfaces use `formatAggregateReleaseRow` in
- * `workers/api/src/utils.ts`). Aliased rather than duplicated so renderers
+ * `apps/api/src/utils.ts`). Aliased rather than duplicated so renderers
  * can treat them as one.
  */
 export type CategoryReleaseItem = CollectionReleaseItem;

package/src/schemas/collections.ts

@@ -302,9 +302,16 @@ export const DigestSectionSchema = z.object({
   lede: z.string(),
   /** Cited release ids in first-seen order; resolve against the detail's `releases`. */
   releaseIds: z.array(z.string()),
+  /**
+   * The section's cited releases, resolved server-side in `releaseIds` order.
+   * Ids that no longer resolve are dropped, so `releases.length` can be less
+   * than `releaseIds.length`. Optional for older servers.
+   */
+  releases: z.array(DigestCoveredReleaseSchema).optional(),
 });
 
-/** Full row returned by `GET /v1/collections/:slug/digests/:weekStart`. */
+/** Full row returned by `GET /v1/collections/:slug/digests/:weekStart` and
+ *  `GET /v1/collections/:slug/digests/latest`. */
 export const CollectionWeeklyDigestDetailSchema = z.object({
   id: z.string(),
   weekStart: z.string(),

package/src/schemas/publish-tokens.ts

@@ -0,0 +1,51 @@
+import { z } from "zod";
+
+/**
+ * Owner-minted publish tokens (#2373): a verified domain owner mints a `relk_`
+ * token bound to ONE source, usable only on that source's
+ * `POST …/releases/batch` route (e.g. from the publish-changelog GitHub Action).
+ * Served by the session-only `/v1/me/publish-tokens` routes.
+ */
+
+/** POST /v1/me/publish-tokens request body. */
+export const CreatePublishTokenBodySchema = z.strictObject({
+  sourceId: z.string().min(1).max(64),
+  name: z.string().trim().min(1).max(200),
+});
+export type CreatePublishTokenBody = z.infer<typeof CreatePublishTokenBodySchema>;
+
+/** POST /v1/me/publish-tokens 201 response. `token` is shown exactly once. */
+export const CreatedPublishTokenSchema = z.strictObject({
+  token: z.string(),
+  id: z.string(),
+  sourceId: z.string(),
+  name: z.string(),
+  createdAt: z.string(),
+});
+export type CreatedPublishToken = z.infer<typeof CreatedPublishTokenSchema>;
+
+/** One publish token as listed back to its owner — never the secret. */
+export const PublishTokenSchema = z.strictObject({
+  id: z.string(),
+  name: z.string(),
+  sourceId: z.string(),
+  sourceSlug: z.string().nullable(),
+  orgSlug: z.string().nullable(),
+  createdAt: z.string(),
+  lastUsedAt: z.string().nullable(),
+  revokedAt: z.string().nullable(),
+});
+export type PublishToken = z.infer<typeof PublishTokenSchema>;
+
+/** GET /v1/me/publish-tokens response. */
+export const ListPublishTokensResponseSchema = z.strictObject({
+  publishTokens: z.array(PublishTokenSchema),
+});
+export type ListPublishTokensResponse = z.infer<typeof ListPublishTokensResponseSchema>;
+
+/** DELETE /v1/me/publish-tokens/:id response. */
+export const RevokePublishTokenResponseSchema = z.strictObject({
+  id: z.string(),
+  revokedAt: z.string(),
+});
+export type RevokePublishTokenResponse = z.infer<typeof RevokePublishTokenResponseSchema>;

package/src/schemas/search.ts

@@ -114,7 +114,7 @@ export const SearchReleaseHitSchema = z.object({
    * The release's upstream source URL, when it has one. Lets the web link
    * search/lookup hits straight to the original page instead of the
    * noindexed `/release/<id>` stub — see `releaseLinkProps()` in
-   * `web/src/lib/release-link.ts`. Optional for older servers / mid-deploy
+   * `apps/web/src/lib/release-link.ts`. Optional for older servers / mid-deploy
    * pin tolerance.
    */
   url: z.string().nullable().optional(),

package/src/schemas/taxonomy.ts

@@ -95,7 +95,7 @@ export const UpdateCategoryResponseSchema = z.object({
 /**
  * Aggregated release row on `GET /v1/categories/:slug/releases`. Same wire
  * shape as `CollectionReleaseItem` — both surfaces aggregate across orgs and
- * use `formatAggregateReleaseRow` in `workers/api/src/utils.ts` for the
+ * use `formatAggregateReleaseRow` in `apps/api/src/utils.ts` for the
  * formatting. Re-exported here so the two endpoints describe one schema
  * instead of two drifting copies.
  */