@buildinternet/releases-api-types 0.59.0 → 0.60.0

package/src/schemas/site-notice.test.ts

@@ -1,67 +0,0 @@
-import { describe, expect, it } from "bun:test";
-import { SiteNoticeSchema, SiteNoticeResponseSchema } from "./site-notice";
-
-const valid = {
-  active: true,
-  message: "We shipped a new feed",
-  linkText: "See it",
-  href: "https://releases.sh/updates",
-  placement: "banner" as const,
-  color: "#0081e7",
-  dismissible: false,
-};
-
-describe("SiteNoticeSchema", () => {
-  it("accepts a fully-specified notice", () => {
-    expect(SiteNoticeSchema.safeParse(valid).success).toBe(true);
-  });
-  it("accepts a site-relative href and omitted link", () => {
-    const { href, linkText, ...rest } = valid;
-    expect(SiteNoticeSchema.safeParse({ ...rest, href: "/updates" }).success).toBe(true);
-    expect(SiteNoticeSchema.safeParse(rest).success).toBe(true);
-  });
-  it("rejects an over-length message", () => {
-    expect(SiteNoticeSchema.safeParse({ ...valid, message: "x".repeat(281) }).success).toBe(false);
-  });
-  it("rejects an empty message", () => {
-    expect(SiteNoticeSchema.safeParse({ ...valid, message: "" }).success).toBe(false);
-  });
-  it("rejects a bad placement", () => {
-    expect(SiteNoticeSchema.safeParse({ ...valid, placement: "footer" }).success).toBe(false);
-  });
-  it("rejects a non-hex color", () => {
-    expect(SiteNoticeSchema.safeParse({ ...valid, color: "blue" }).success).toBe(false);
-    expect(SiteNoticeSchema.safeParse({ ...valid, color: "#fff" }).success).toBe(false);
-  });
-  it("rejects an href that is neither absolute http(s) nor root-relative", () => {
-    expect(SiteNoticeSchema.safeParse({ ...valid, href: "ftp://x.y" }).success).toBe(false);
-    expect(SiteNoticeSchema.safeParse({ ...valid, href: "updates" }).success).toBe(false);
-  });
-  it("rejects linkText without an href (dead CTA)", () => {
-    const { href, ...noHref } = valid; // keeps linkText
-    expect(SiteNoticeSchema.safeParse(noHref).success).toBe(false);
-  });
-  it("accepts href without linkText", () => {
-    const { linkText, ...noLinkText } = valid;
-    expect(SiteNoticeSchema.safeParse(noLinkText).success).toBe(true);
-  });
-  it("rejects javascript:/data: schemes and protocol-relative hrefs", () => {
-    expect(SiteNoticeSchema.safeParse({ ...valid, href: "javascript:alert(1)" }).success).toBe(
-      false,
-    );
-    expect(SiteNoticeSchema.safeParse({ ...valid, href: "data:text/html,x" }).success).toBe(false);
-    expect(SiteNoticeSchema.safeParse({ ...valid, href: "//evil.com" }).success).toBe(false);
-  });
-});
-
-describe("SiteNoticeResponseSchema", () => {
-  it("accepts null", () => {
-    expect(SiteNoticeResponseSchema.safeParse({ notice: null }).success).toBe(true);
-  });
-  it("accepts a stored notice with updatedAt", () => {
-    const r = SiteNoticeResponseSchema.safeParse({
-      notice: { ...valid, updatedAt: "2026-06-11T00:00:00.000Z" },
-    });
-    expect(r.success).toBe(true);
-  });
-});

package/src/schemas/sitemap.ts

@@ -1,117 +0,0 @@
-import { z } from "zod";
-import { DatasetDescriptionSchema } from "./datasets.js";
-
-/**
- * Per-source row in `GET /v1/sitemap`. `hasChangelog` and `hasHighlights`
- * are `.optional()` for backwards compatibility — older clients ignore the
- * fields, but the current handler always populates them (#875).
- */
-export const SitemapSourceSchema = z.object({
-  /**
-   * Source id. `.optional()` for backwards compatibility — added #1190 so the
-   * web can route shadowed sources to `/sources/:id`; older/cached responses
-   * may omit it and the web degrades to the bare URL.
-   */
-  id: z.string().optional(),
-  /** Null explicitly disables; absence supports older API deploys. */
-  dataset: DatasetDescriptionSchema.nullable().optional(),
-  orgSlug: z.string(),
-  slug: z.string(),
-  latestDate: z.string().nullable(),
-  /**
-   * Whether this source has a stored GitHub CHANGELOG file. Used by the web
-   * sitemap to emit `/{org}/{src}/changelog` URLs only for sources where the
-   * route resolves.
-   */
-  hasChangelog: z.boolean().optional(),
-  /**
-   * Whether this source has any rolling or monthly highlight summaries.
-   * Drives `/{org}/{src}/highlights` sitemap emission.
-   */
-  hasHighlights: z.boolean().optional(),
-});
-
-/**
- * Bulk URL payload consumed by the web sitemap generator. Lists every
- * orgs/sources/products/collections slug paired with the timestamp the web
- * uses to drive `<lastmod>`. Soft-deleted / hidden / on_demand rows are
- * excluded.
- */
-export const SitemapPayloadSchema = z.object({
-  orgs: z.array(
-    z.object({
-      slug: z.string(),
-      lastActivity: z.string().nullable(),
-      /**
-       * Total releases across the org's sources — the same count org detail
-       * reports as `releaseCount`. With `hasOverview`, drives the web's index
-       * bar for the org and its products/sources. `.optional()` for backwards
-       * compatibility with older cached responses.
-       */
-      releaseCount: z.number().int().optional(),
-      /** Whether the org has a generated overview page. */
-      hasOverview: z.boolean().optional(),
-    }),
-  ),
-  sources: z.array(SitemapSourceSchema),
-  products: z.array(
-    z.object({
-      orgSlug: z.string(),
-      slug: z.string(),
-      /**
-       * Visible releases across the product's visible sources — the same count
-       * org detail reports per product. Drives the web's product index bar.
-       * `.optional()` for backwards compatibility with older cached responses.
-       */
-      releaseCount: z.number().int().optional(),
-    }),
-  ),
-  collections: z.array(z.object({ slug: z.string(), updatedAt: z.string() })),
-  /**
-   * Weekly collection digest permalinks (`/collections/:slug/digest/:week`),
-   * with `generatedAt` driving `<lastmod>`. `.optional()` for backwards
-   * compatibility with older cached responses. Small at 12 collections × 52
-   * weeks/year, so no dedicated `/sitemap/digests` surface (unlike releases).
-   */
-  digests: z
-    .array(
-      z.object({
-        collectionSlug: z.string(),
-        weekStart: z.string(),
-        generatedAt: z.string(),
-      }),
-    )
-    .optional(),
-});
-
-/**
- * Per-release row previously returned by `GET /v1/sitemap/releases` (#1181,
- * scoped down). Carries what the web needed to build the slugged canonical
- * `/release/...` URL (`releasePath()` inputs) plus `fetchedAt` for `<lastmod>`.
- *
- * @deprecated The endpoint was retired in #2219 — its only consumer
- * (`sitemap-releases.xml`) was removed in #2218 when release pages went
- * `noindex`. Kept for one minor version per the deprecation lane; will be
- * removed in a future minor.
- */
-export const SitemapReleaseSchema = z.object({
-  id: z.string(),
-  title: z.string(),
-  titleShort: z.string().nullable(),
-  titleGenerated: z.string().nullable(),
-  version: z.string().nullable(),
-  publishedAt: z.string().nullable(),
-  fetchedAt: z.string(),
-});
-
-/**
- * Payload previously returned by the curated release sitemap endpoint.
- *
- * @deprecated The endpoint was retired in #2219 — its only consumer
- * (`sitemap-releases.xml`) was removed in #2218 when release pages went
- * `noindex`. Kept for one minor version per the deprecation lane; will be
- * removed in a future minor.
- */
-export const SitemapReleasesPayloadSchema = z.object({
-  releases: z.array(SitemapReleaseSchema),
-});