@buildinternet/releases-api-types 0.59.0 → 0.60.0

package/dist/schemas/related.d.ts

@@ -0,0 +1,331 @@
+import { z } from "zod";
+/**
+ * Anchor scope for related-* lookups. `org` filters the Vectorize query by
+ * the anchor's org id; `global` (default) runs unscoped.
+ */
+export declare const RelatedScopeSchema: z.ZodEnum<{
+    global: "global";
+    org: "org";
+}>;
+/** Thumbnail picked from the release's first image-like media entry. */
+export declare const RelatedReleaseThumbnailSchema: z.ZodObject<{
+    url: z.ZodString;
+    alt: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** Owning source rollup attached to each related-release row. */
+export declare const RelatedReleaseSourceSchema: z.ZodObject<{
+    id: z.ZodString;
+    slug: z.ZodString;
+    name: z.ZodString;
+    productName: z.ZodNullable<z.ZodString>;
+    orgSlug: z.ZodNullable<z.ZodString>;
+    orgName: z.ZodNullable<z.ZodString>;
+    orgAvatarUrl: z.ZodNullable<z.ZodString>;
+    appStore: z.ZodOptional<z.ZodObject<{
+        platform: z.ZodEnum<{
+            ios: "ios";
+            macos: "macos";
+        }>;
+        iconUrl: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * One neighbor returned by `GET /v1/related/releases`. `score` is the
+ * Vectorize cosine similarity from the underlying query.
+ */
+export declare const RelatedReleaseItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+    version: z.ZodNullable<z.ZodString>;
+    url: z.ZodNullable<z.ZodString>;
+    publishedAt: z.ZodNullable<z.ZodString>;
+    summary: z.ZodString;
+    titleGenerated: z.ZodNullable<z.ZodString>;
+    titleShort: z.ZodNullable<z.ZodString>;
+    importance: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    thumbnail: z.ZodNullable<z.ZodObject<{
+        url: z.ZodString;
+        alt: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    score: z.ZodNumber;
+    source: z.ZodObject<{
+        id: z.ZodString;
+        slug: z.ZodString;
+        name: z.ZodString;
+        productName: z.ZodNullable<z.ZodString>;
+        orgSlug: z.ZodNullable<z.ZodString>;
+        orgName: z.ZodNullable<z.ZodString>;
+        orgAvatarUrl: z.ZodNullable<z.ZodString>;
+        appStore: z.ZodOptional<z.ZodObject<{
+            platform: z.ZodEnum<{
+                ios: "ios";
+                macos: "macos";
+            }>;
+            iconUrl: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * One neighbor returned by `GET /v1/related/sources`. Carries enough
+ * source + org + recent-release stats for the rail card to render without
+ * a follow-up request.
+ */
+export declare const RelatedSourceItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    slug: z.ZodString;
+    name: z.ZodString;
+    type: z.ZodString;
+    url: z.ZodNullable<z.ZodString>;
+    score: z.ZodNumber;
+    orgSlug: z.ZodNullable<z.ZodString>;
+    orgName: z.ZodNullable<z.ZodString>;
+    orgAvatarUrl: z.ZodNullable<z.ZodString>;
+    releaseCount: z.ZodNumber;
+    latestDate: z.ZodNullable<z.ZodString>;
+    latestTitle: z.ZodNullable<z.ZodString>;
+    latestVersion: z.ZodNullable<z.ZodString>;
+    recentCount: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Successful response from `GET /v1/related/releases`. The handler returns
+ * `{scope, items}` when Vectorize is reachable and the anchor has a vector.
+ */
+export declare const RelatedReleasesOkResponseSchema: z.ZodObject<{
+    scope: z.ZodEnum<{
+        global: "global";
+        org: "org";
+    }>;
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        version: z.ZodNullable<z.ZodString>;
+        url: z.ZodNullable<z.ZodString>;
+        publishedAt: z.ZodNullable<z.ZodString>;
+        summary: z.ZodString;
+        titleGenerated: z.ZodNullable<z.ZodString>;
+        titleShort: z.ZodNullable<z.ZodString>;
+        importance: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        thumbnail: z.ZodNullable<z.ZodObject<{
+            url: z.ZodString;
+            alt: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        score: z.ZodNumber;
+        source: z.ZodObject<{
+            id: z.ZodString;
+            slug: z.ZodString;
+            name: z.ZodString;
+            productName: z.ZodNullable<z.ZodString>;
+            orgSlug: z.ZodNullable<z.ZodString>;
+            orgName: z.ZodNullable<z.ZodString>;
+            orgAvatarUrl: z.ZodNullable<z.ZodString>;
+            appStore: z.ZodOptional<z.ZodObject<{
+                platform: z.ZodEnum<{
+                    ios: "ios";
+                    macos: "macos";
+                }>;
+                iconUrl: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Degraded response from `GET /v1/related/releases`. Returned (HTTP 200) when
+ * Vectorize bindings are missing, the anchor hasn't been embedded yet, or a
+ * downstream call errored. Callers render nothing in this case rather than
+ * surfacing a hard failure. `degradedReason` is human-readable, not stable.
+ */
+export declare const RelatedReleasesDegradedResponseSchema: z.ZodObject<{
+    degraded: z.ZodLiteral<true>;
+    degradedReason: z.ZodString;
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        version: z.ZodNullable<z.ZodString>;
+        url: z.ZodNullable<z.ZodString>;
+        publishedAt: z.ZodNullable<z.ZodString>;
+        summary: z.ZodString;
+        titleGenerated: z.ZodNullable<z.ZodString>;
+        titleShort: z.ZodNullable<z.ZodString>;
+        importance: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        thumbnail: z.ZodNullable<z.ZodObject<{
+            url: z.ZodString;
+            alt: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        score: z.ZodNumber;
+        source: z.ZodObject<{
+            id: z.ZodString;
+            slug: z.ZodString;
+            name: z.ZodString;
+            productName: z.ZodNullable<z.ZodString>;
+            orgSlug: z.ZodNullable<z.ZodString>;
+            orgName: z.ZodNullable<z.ZodString>;
+            orgAvatarUrl: z.ZodNullable<z.ZodString>;
+            appStore: z.ZodOptional<z.ZodObject<{
+                platform: z.ZodEnum<{
+                    ios: "ios";
+                    macos: "macos";
+                }>;
+                iconUrl: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const RelatedReleasesResponseSchema: z.ZodUnion<readonly [z.ZodObject<{
+    scope: z.ZodEnum<{
+        global: "global";
+        org: "org";
+    }>;
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        version: z.ZodNullable<z.ZodString>;
+        url: z.ZodNullable<z.ZodString>;
+        publishedAt: z.ZodNullable<z.ZodString>;
+        summary: z.ZodString;
+        titleGenerated: z.ZodNullable<z.ZodString>;
+        titleShort: z.ZodNullable<z.ZodString>;
+        importance: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        thumbnail: z.ZodNullable<z.ZodObject<{
+            url: z.ZodString;
+            alt: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        score: z.ZodNumber;
+        source: z.ZodObject<{
+            id: z.ZodString;
+            slug: z.ZodString;
+            name: z.ZodString;
+            productName: z.ZodNullable<z.ZodString>;
+            orgSlug: z.ZodNullable<z.ZodString>;
+            orgName: z.ZodNullable<z.ZodString>;
+            orgAvatarUrl: z.ZodNullable<z.ZodString>;
+            appStore: z.ZodOptional<z.ZodObject<{
+                platform: z.ZodEnum<{
+                    ios: "ios";
+                    macos: "macos";
+                }>;
+                iconUrl: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    degraded: z.ZodLiteral<true>;
+    degradedReason: z.ZodString;
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        version: z.ZodNullable<z.ZodString>;
+        url: z.ZodNullable<z.ZodString>;
+        publishedAt: z.ZodNullable<z.ZodString>;
+        summary: z.ZodString;
+        titleGenerated: z.ZodNullable<z.ZodString>;
+        titleShort: z.ZodNullable<z.ZodString>;
+        importance: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        thumbnail: z.ZodNullable<z.ZodObject<{
+            url: z.ZodString;
+            alt: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        score: z.ZodNumber;
+        source: z.ZodObject<{
+            id: z.ZodString;
+            slug: z.ZodString;
+            name: z.ZodString;
+            productName: z.ZodNullable<z.ZodString>;
+            orgSlug: z.ZodNullable<z.ZodString>;
+            orgName: z.ZodNullable<z.ZodString>;
+            orgAvatarUrl: z.ZodNullable<z.ZodString>;
+            appStore: z.ZodOptional<z.ZodObject<{
+                platform: z.ZodEnum<{
+                    ios: "ios";
+                    macos: "macos";
+                }>;
+                iconUrl: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+}, z.core.$strip>]>;
+/** Successful response from `GET /v1/related/sources`. */
+export declare const RelatedSourcesOkResponseSchema: z.ZodObject<{
+    scope: z.ZodEnum<{
+        global: "global";
+        org: "org";
+    }>;
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        slug: z.ZodString;
+        name: z.ZodString;
+        type: z.ZodString;
+        url: z.ZodNullable<z.ZodString>;
+        score: z.ZodNumber;
+        orgSlug: z.ZodNullable<z.ZodString>;
+        orgName: z.ZodNullable<z.ZodString>;
+        orgAvatarUrl: z.ZodNullable<z.ZodString>;
+        releaseCount: z.ZodNumber;
+        latestDate: z.ZodNullable<z.ZodString>;
+        latestTitle: z.ZodNullable<z.ZodString>;
+        latestVersion: z.ZodNullable<z.ZodString>;
+        recentCount: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** Degraded response from `GET /v1/related/sources`. Same semantics as the releases variant. */
+export declare const RelatedSourcesDegradedResponseSchema: z.ZodObject<{
+    degraded: z.ZodLiteral<true>;
+    degradedReason: z.ZodString;
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        slug: z.ZodString;
+        name: z.ZodString;
+        type: z.ZodString;
+        url: z.ZodNullable<z.ZodString>;
+        score: z.ZodNumber;
+        orgSlug: z.ZodNullable<z.ZodString>;
+        orgName: z.ZodNullable<z.ZodString>;
+        orgAvatarUrl: z.ZodNullable<z.ZodString>;
+        releaseCount: z.ZodNumber;
+        latestDate: z.ZodNullable<z.ZodString>;
+        latestTitle: z.ZodNullable<z.ZodString>;
+        latestVersion: z.ZodNullable<z.ZodString>;
+        recentCount: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const RelatedSourcesResponseSchema: z.ZodUnion<readonly [z.ZodObject<{
+    scope: z.ZodEnum<{
+        global: "global";
+        org: "org";
+    }>;
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        slug: z.ZodString;
+        name: z.ZodString;
+        type: z.ZodString;
+        url: z.ZodNullable<z.ZodString>;
+        score: z.ZodNumber;
+        orgSlug: z.ZodNullable<z.ZodString>;
+        orgName: z.ZodNullable<z.ZodString>;
+        orgAvatarUrl: z.ZodNullable<z.ZodString>;
+        releaseCount: z.ZodNumber;
+        latestDate: z.ZodNullable<z.ZodString>;
+        latestTitle: z.ZodNullable<z.ZodString>;
+        latestVersion: z.ZodNullable<z.ZodString>;
+        recentCount: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    degraded: z.ZodLiteral<true>;
+    degradedReason: z.ZodString;
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        slug: z.ZodString;
+        name: z.ZodString;
+        type: z.ZodString;
+        url: z.ZodNullable<z.ZodString>;
+        score: z.ZodNumber;
+        orgSlug: z.ZodNullable<z.ZodString>;
+        orgName: z.ZodNullable<z.ZodString>;
+        orgAvatarUrl: z.ZodNullable<z.ZodString>;
+        releaseCount: z.ZodNumber;
+        latestDate: z.ZodNullable<z.ZodString>;
+        latestTitle: z.ZodNullable<z.ZodString>;
+        latestVersion: z.ZodNullable<z.ZodString>;
+        recentCount: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>]>;
+//# sourceMappingURL=related.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"related.d.ts","sourceRoot":"","sources":["../../src/schemas/related.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;EAA4B,CAAC;AAE5D,wEAAwE;AACxE,eAAO,MAAM,6BAA6B;;;iBAGxC,CAAC;AAEH,iEAAiE;AACjE,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;iBAmBrC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiBnC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;iBAgBlC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAG1C,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAIhD,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAGxC,CAAC;AAEH,0DAA0D;AAC1D,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;iBAGzC,CAAC;AAEH,gGAAgG;AAChG,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;iBAI/C,CAAC;AAEH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAGvC,CAAC"}

package/dist/schemas/related.js

@@ -0,0 +1,115 @@
+import { z } from "zod";
+import { AppStoreSourceInfoSchema, ImportanceScoreSchema } from "./shared.js";
+/**
+ * Anchor scope for related-* lookups. `org` filters the Vectorize query by
+ * the anchor's org id; `global` (default) runs unscoped.
+ */
+export const RelatedScopeSchema = z.enum(["org", "global"]);
+/** Thumbnail picked from the release's first image-like media entry. */
+export const RelatedReleaseThumbnailSchema = z.object({
+    url: z.string(),
+    alt: z.string().optional(),
+});
+/** Owning source rollup attached to each related-release row. */
+export const RelatedReleaseSourceSchema = z.object({
+    id: z.string(),
+    slug: z.string(),
+    name: z.string(),
+    /** Parent product name, when the source belongs to one — preferred over the
+     * bare source/feed name for display. Null for sources with no product. */
+    productName: z.string().nullable(),
+    orgSlug: z.string().nullable(),
+    orgName: z.string().nullable(),
+    orgAvatarUrl: z.string().nullable(),
+    /**
+     * App Store platform + icon, present only for `appstore` sources (resolved
+     * server-side, same block the org/product/ticker read paths already carry).
+     * Its presence is the signal the related rail uses to render the lean
+     * mobile-app card (app icon + "iOS/macOS" cue) instead of the standard
+     * headline/thumbnail. Additive/optional for mid-deploy pin tolerance.
+     * #mobile-app-release-cards
+     */
+    appStore: AppStoreSourceInfoSchema.optional(),
+});
+/**
+ * One neighbor returned by `GET /v1/related/releases`. `score` is the
+ * Vectorize cosine similarity from the underlying query.
+ */
+export const RelatedReleaseItemSchema = z.object({
+    id: z.string(),
+    title: z.string(),
+    version: z.string().nullable(),
+    url: z.string().nullable(),
+    publishedAt: z.string().nullable(),
+    summary: z.string(),
+    titleGenerated: z.string().nullable(),
+    titleShort: z.string().nullable(),
+    /**
+     * AI-scored importance 1–5 (5=landmark, 1=housekeeping). Null when
+     * unscored; optional for older servers / mid-deploy pin tolerance.
+     */
+    importance: ImportanceScoreSchema,
+    thumbnail: RelatedReleaseThumbnailSchema.nullable(),
+    score: z.number(),
+    source: RelatedReleaseSourceSchema,
+});
+/**
+ * One neighbor returned by `GET /v1/related/sources`. Carries enough
+ * source + org + recent-release stats for the rail card to render without
+ * a follow-up request.
+ */
+export const RelatedSourceItemSchema = z.object({
+    id: z.string(),
+    slug: z.string(),
+    name: z.string(),
+    type: z.string(),
+    url: z.string().nullable(),
+    score: z.number(),
+    orgSlug: z.string().nullable(),
+    orgName: z.string().nullable(),
+    orgAvatarUrl: z.string().nullable(),
+    releaseCount: z.number().int().min(0),
+    latestDate: z.string().nullable(),
+    latestTitle: z.string().nullable(),
+    latestVersion: z.string().nullable(),
+    /** Total releases published in the last 30 days (includes the latest). */
+    recentCount: z.number().int().min(0),
+});
+/**
+ * Successful response from `GET /v1/related/releases`. The handler returns
+ * `{scope, items}` when Vectorize is reachable and the anchor has a vector.
+ */
+export const RelatedReleasesOkResponseSchema = z.object({
+    scope: RelatedScopeSchema,
+    items: z.array(RelatedReleaseItemSchema),
+});
+/**
+ * Degraded response from `GET /v1/related/releases`. Returned (HTTP 200) when
+ * Vectorize bindings are missing, the anchor hasn't been embedded yet, or a
+ * downstream call errored. Callers render nothing in this case rather than
+ * surfacing a hard failure. `degradedReason` is human-readable, not stable.
+ */
+export const RelatedReleasesDegradedResponseSchema = z.object({
+    degraded: z.literal(true),
+    degradedReason: z.string(),
+    items: z.array(RelatedReleaseItemSchema),
+});
+export const RelatedReleasesResponseSchema = z.union([
+    RelatedReleasesOkResponseSchema,
+    RelatedReleasesDegradedResponseSchema,
+]);
+/** Successful response from `GET /v1/related/sources`. */
+export const RelatedSourcesOkResponseSchema = z.object({
+    scope: RelatedScopeSchema,
+    items: z.array(RelatedSourceItemSchema),
+});
+/** Degraded response from `GET /v1/related/sources`. Same semantics as the releases variant. */
+export const RelatedSourcesDegradedResponseSchema = z.object({
+    degraded: z.literal(true),
+    degradedReason: z.string(),
+    items: z.array(RelatedSourceItemSchema),
+});
+export const RelatedSourcesResponseSchema = z.union([
+    RelatedSourcesOkResponseSchema,
+    RelatedSourcesDegradedResponseSchema,
+]);