@buildinternet/releases-api-types 0.58.3 → 0.60.0

package/dist/schemas/sitemap.d.ts

@@ -0,0 +1,97 @@
+import { z } from "zod";
+/**
+ * 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 declare const SitemapSourceSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    dataset: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodString;
+    }, z.core.$strip>>>;
+    orgSlug: z.ZodString;
+    slug: z.ZodString;
+    latestDate: z.ZodNullable<z.ZodString>;
+    hasChangelog: z.ZodOptional<z.ZodBoolean>;
+    hasHighlights: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * 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 declare const SitemapPayloadSchema: z.ZodObject<{
+    orgs: z.ZodArray<z.ZodObject<{
+        slug: z.ZodString;
+        lastActivity: z.ZodNullable<z.ZodString>;
+        releaseCount: z.ZodOptional<z.ZodNumber>;
+        hasOverview: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    sources: z.ZodArray<z.ZodObject<{
+        id: z.ZodOptional<z.ZodString>;
+        dataset: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            name: z.ZodString;
+            description: z.ZodString;
+        }, z.core.$strip>>>;
+        orgSlug: z.ZodString;
+        slug: z.ZodString;
+        latestDate: z.ZodNullable<z.ZodString>;
+        hasChangelog: z.ZodOptional<z.ZodBoolean>;
+        hasHighlights: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    products: z.ZodArray<z.ZodObject<{
+        orgSlug: z.ZodString;
+        slug: z.ZodString;
+        releaseCount: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    collections: z.ZodArray<z.ZodObject<{
+        slug: z.ZodString;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>>;
+    digests: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        collectionSlug: z.ZodString;
+        weekStart: z.ZodString;
+        generatedAt: z.ZodString;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * 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 declare const SitemapReleaseSchema: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+    titleShort: z.ZodNullable<z.ZodString>;
+    titleGenerated: z.ZodNullable<z.ZodString>;
+    version: z.ZodNullable<z.ZodString>;
+    publishedAt: z.ZodNullable<z.ZodString>;
+    fetchedAt: z.ZodString;
+}, z.core.$strip>;
+/**
+ * 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 declare const SitemapReleasesPayloadSchema: z.ZodObject<{
+    releases: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        titleShort: z.ZodNullable<z.ZodString>;
+        titleGenerated: z.ZodNullable<z.ZodString>;
+        version: z.ZodNullable<z.ZodString>;
+        publishedAt: z.ZodNullable<z.ZodString>;
+        fetchedAt: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+//# sourceMappingURL=sitemap.d.ts.map

package/dist/schemas/sitemap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sitemap.d.ts","sourceRoot":"","sources":["../../src/schemas/sitemap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;iBAuB9B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6C/B,CAAC;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;iBAQ/B,CAAC;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;iBAEvC,CAAC"}

package/dist/schemas/sitemap.js

@@ -0,0 +1,107 @@
+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),
+});