@buildinternet/releases-api-types 0.59.0 → 0.60.0

package/{src/schemas/resolve.ts → dist/schemas/resolve.js}

@@ -1,15 +1,12 @@
 import { z } from "zod";
 import { ProductDetailSchema } from "./products.js";
 import { SourceDetailSchema } from "./sources.js";
-
 /**
  * Response of `GET /v1/orgs/:org/resolve/:slug` (#1190). Product-first: when a
  * product and a source share a slug in an org, the product variant is returned.
  * A 404 (ErrorResponse) is returned when neither matches.
  */
 export const ResolveResponseSchema = z.discriminatedUnion("kind", [
-  z.object({ kind: z.literal("product"), product: ProductDetailSchema }),
-  z.object({ kind: z.literal("source"), source: SourceDetailSchema }),
+    z.object({ kind: z.literal("product"), product: ProductDetailSchema }),
+    z.object({ kind: z.literal("source"), source: SourceDetailSchema }),
 ]);
-
-export type ResolveResponse = z.infer<typeof ResolveResponseSchema>;

package/dist/schemas/search.d.ts

@@ -0,0 +1,475 @@
+import { z } from "zod";
+/**
+ * Org hit on the unified `/v1/search` response. The list is built either
+ * from `searchOrgs` LIKE matches or, when `?domain=` resolves, from a
+ * single-row "scoped org" projection — both produce the same wire shape.
+ *
+ * `category` is loose (`z.string().nullable()`) rather than the canonical
+ * `CategorySchema` enum because the scoped-org projection passes the raw
+ * DB column through without going through `resolveCategoryInput`; legacy
+ * rows may carry deprecated slugs that haven't been migrated yet. Tighten
+ * once #689 (category overlay backfill) lands across the prod data set.
+ */
+export declare const SearchOrgHitSchema: z.ZodObject<{
+    slug: z.ZodString;
+    name: z.ZodString;
+    domain: z.ZodNullable<z.ZodString>;
+    avatarUrl: z.ZodNullable<z.ZodString>;
+    category: z.ZodNullable<z.ZodString>;
+    status: z.ZodOptional<z.ZodEnum<{
+        stub: "stub";
+        tracked: "tracked";
+    }>>;
+    aliasDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Unified catalog entry — either a product row or a standalone source
+ * presented as product-shaped. `entryType` discriminates between the two
+ * row shapes (`"product"` vs `"source"`). `kind` carries the entity
+ * taxonomy (platform/sdk/mobile/…). `entryType` (not `type`) because
+ * source rows already carry `type: github|scrape|feed|agent` on the wire.
+ */
+export declare const SearchCatalogHitSchema: z.ZodObject<{
+    slug: z.ZodString;
+    name: z.ZodString;
+    orgSlug: z.ZodNullable<z.ZodString>;
+    orgName: z.ZodNullable<z.ZodString>;
+    orgAvatarUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    category: z.ZodNullable<z.ZodString>;
+    entryType: z.ZodEnum<{
+        product: "product";
+        source: "source";
+    }>;
+    kind: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        desktop: "desktop";
+        docs: "docs";
+        integration: "integration";
+        mobile: "mobile";
+        platform: "platform";
+        sdk: "sdk";
+        tool: "tool";
+    }>>>;
+    sourceSlug: z.ZodOptional<z.ZodString>;
+    sourceType: z.ZodOptional<z.ZodEnum<{
+        agent: "agent";
+        appstore: "appstore";
+        feed: "feed";
+        github: "github";
+        scrape: "scrape";
+        video: "video";
+    }>>;
+}, z.core.$strip>;
+export declare const SearchSourceHitSchema: z.ZodObject<{
+    slug: z.ZodString;
+    name: z.ZodString;
+    type: z.ZodEnum<{
+        agent: "agent";
+        appstore: "appstore";
+        feed: "feed";
+        github: "github";
+        scrape: "scrape";
+        video: "video";
+    }>;
+    orgSlug: z.ZodNullable<z.ZodString>;
+    orgName: z.ZodNullable<z.ZodString>;
+    productSlug: z.ZodNullable<z.ZodString>;
+    stars: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$strip>;
+export declare const SearchReleaseHitSchema: z.ZodObject<{
+    id: z.ZodString;
+    sourceSlug: z.ZodString;
+    sourceName: z.ZodString;
+    sourceType: z.ZodOptional<z.ZodString>;
+    appStore: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        platform: z.ZodEnum<{
+            ios: "ios";
+            macos: "macos";
+        }>;
+        iconUrl: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>>;
+    video: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        provider: z.ZodEnum<{
+            vimeo: "vimeo";
+            wistia: "wistia";
+            youtube: "youtube";
+        }>;
+    }, z.core.$strip>>>;
+    orgSlug: z.ZodNullable<z.ZodString>;
+    orgName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    productSlug: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    version: z.ZodNullable<z.ZodString>;
+    title: z.ZodString;
+    summary: z.ZodString;
+    titleGenerated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    titleShort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    importance: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    content: z.ZodOptional<z.ZodString>;
+    media: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<{
+            gif: "gif";
+            image: "image";
+            video: "video";
+        }>;
+        url: z.ZodString;
+        alt: z.ZodOptional<z.ZodString>;
+        r2Key: z.ZodOptional<z.ZodString>;
+        r2Url: z.ZodOptional<z.ZodString>;
+        linkUrl: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    publishedAt: z.ZodNullable<z.ZodString>;
+    score: z.ZodOptional<z.ZodNumber>;
+    type: z.ZodOptional<z.ZodEnum<{
+        feature: "feature";
+        rollup: "rollup";
+    }>>;
+    coverageCount: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * Collection hit on the unified `/v1/search` response. Two origins are folded
+ * into the same wire shape via the `via` discriminator:
+ *
+ * - `direct`  — the collection itself matched (name/description via LIKE in
+ *               every mode, plus vector match in hybrid/semantic mode).
+ * - `member`  — the collection was surfaced because one of the orgs that
+ *               *did* match the query is a member of it; `matchedOrgSlugs`
+ *               carries the subset of result-set org slugs that triggered
+ *               the rollup so the UI can render an "includes X, Y" hint.
+ *
+ * `direct` rows always sort ahead of `member` rows; ties break on
+ * `score` then `memberCount`. Slugs are unique across the array — a
+ * direct hit that's also a member rollup keeps only the `direct` row
+ * with `matchedOrgSlugs` carried over.
+ */
+export declare const SearchCollectionHitSchema: z.ZodObject<{
+    slug: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    memberCount: z.ZodNumber;
+    via: z.ZodEnum<{
+        direct: "direct";
+        member: "member";
+    }>;
+    score: z.ZodOptional<z.ZodNumber>;
+    matchedOrgSlugs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    previewMembers: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        slug: z.ZodString;
+        name: z.ZodString;
+        domain: z.ZodNullable<z.ZodString>;
+        avatarUrl: z.ZodNullable<z.ZodString>;
+        githubHandle: z.ZodNullable<z.ZodString>;
+        description: z.ZodNullable<z.ZodString>;
+        kind: z.ZodLiteral<"org">;
+    }, z.core.$strip>, z.ZodObject<{
+        slug: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        org: z.ZodObject<{
+            slug: z.ZodString;
+            name: z.ZodString;
+            domain: z.ZodNullable<z.ZodString>;
+            avatarUrl: z.ZodNullable<z.ZodString>;
+            githubHandle: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>;
+        kind: z.ZodLiteral<"product">;
+    }, z.core.$strip>], "kind">>>;
+}, z.core.$strip>;
+/**
+ * Heading-aware CHANGELOG.md slice returned by hybrid / semantic search.
+ * Clients can deep-link to
+ * `/<orgSlug>/<sourceSlug>/changelog?offset=<offset>#chunk` to read the
+ * surrounding file content (the web `chunkDeepLink` builder; falls back to
+ * the `/source/<sourceSlug>` redirect shim when `orgSlug` is null).
+ */
+export declare const SearchChunkHitSchema: z.ZodObject<{
+    sourceSlug: z.ZodString;
+    sourceName: z.ZodString;
+    orgSlug: z.ZodNullable<z.ZodString>;
+    orgName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    filePath: z.ZodString;
+    offset: z.ZodNumber;
+    length: z.ZodNumber;
+    heading: z.ZodNullable<z.ZodString>;
+    snippet: z.ZodString;
+    score: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Slim wire payload embedded in a search response when the query is a
+ * GitHub `org/repo` coordinate and no existing entity matched. Reuses
+ * `LookupStatusSchema` from `./lookups.js` rather than redefining — the
+ * thick `POST /v1/lookups` response and the slim search-embedded payload
+ * share the same status set.
+ */
+export declare const LookupResultPayloadSchema: z.ZodObject<{
+    status: z.ZodEnum<{
+        deferred: "deferred";
+        empty: "empty";
+        existing: "existing";
+        indexed: "indexed";
+        not_found: "not_found";
+    }>;
+    source: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+        slug: z.ZodString;
+        name: z.ZodString;
+        url: z.ZodString;
+        discovery: z.ZodEnum<{
+            agent: "agent";
+            curated: "curated";
+            on_demand: "on_demand";
+        }>;
+        stars: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>;
+    releases: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNullable<z.ZodString>;
+        title: z.ZodString;
+        publishedAt: z.ZodNullable<z.ZodString>;
+        thumbnail: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            url: z.ZodString;
+            alt: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>>;
+    relatedOrg: z.ZodNullable<z.ZodObject<{
+        org: z.ZodObject<{
+            id: z.ZodString;
+            slug: z.ZodString;
+            name: z.ZodString;
+        }, z.core.$strip>;
+        sources: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            slug: z.ZodString;
+            name: z.ZodString;
+            url: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const UnifiedSearchResponseSchema: z.ZodObject<{
+    query: z.ZodString;
+    domain: z.ZodOptional<z.ZodString>;
+    domainStatus: z.ZodOptional<z.ZodEnum<{
+        matched: "matched";
+        not_found: "not_found";
+    }>>;
+    org: z.ZodOptional<z.ZodString>;
+    orgStatus: z.ZodOptional<z.ZodEnum<{
+        matched: "matched";
+        not_found: "not_found";
+    }>>;
+    category: z.ZodOptional<z.ZodString>;
+    categoryStatus: z.ZodOptional<z.ZodEnum<{
+        matched: "matched";
+    }>>;
+    collection: z.ZodOptional<z.ZodString>;
+    collectionStatus: z.ZodOptional<z.ZodEnum<{
+        matched: "matched";
+        not_found: "not_found";
+    }>>;
+    orgs: z.ZodArray<z.ZodObject<{
+        slug: z.ZodString;
+        name: z.ZodString;
+        domain: z.ZodNullable<z.ZodString>;
+        avatarUrl: z.ZodNullable<z.ZodString>;
+        category: z.ZodNullable<z.ZodString>;
+        status: z.ZodOptional<z.ZodEnum<{
+            stub: "stub";
+            tracked: "tracked";
+        }>>;
+        aliasDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>;
+    catalog: z.ZodArray<z.ZodObject<{
+        slug: z.ZodString;
+        name: z.ZodString;
+        orgSlug: z.ZodNullable<z.ZodString>;
+        orgName: z.ZodNullable<z.ZodString>;
+        orgAvatarUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        category: z.ZodNullable<z.ZodString>;
+        entryType: z.ZodEnum<{
+            product: "product";
+            source: "source";
+        }>;
+        kind: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            desktop: "desktop";
+            docs: "docs";
+            integration: "integration";
+            mobile: "mobile";
+            platform: "platform";
+            sdk: "sdk";
+            tool: "tool";
+        }>>>;
+        sourceSlug: z.ZodOptional<z.ZodString>;
+        sourceType: z.ZodOptional<z.ZodEnum<{
+            agent: "agent";
+            appstore: "appstore";
+            feed: "feed";
+            github: "github";
+            scrape: "scrape";
+            video: "video";
+        }>>;
+    }, z.core.$strip>>;
+    sources: z.ZodArray<z.ZodObject<{
+        slug: z.ZodString;
+        name: z.ZodString;
+        type: z.ZodEnum<{
+            agent: "agent";
+            appstore: "appstore";
+            feed: "feed";
+            github: "github";
+            scrape: "scrape";
+            video: "video";
+        }>;
+        orgSlug: z.ZodNullable<z.ZodString>;
+        orgName: z.ZodNullable<z.ZodString>;
+        productSlug: z.ZodNullable<z.ZodString>;
+        stars: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>;
+    releases: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        sourceSlug: z.ZodString;
+        sourceName: z.ZodString;
+        sourceType: z.ZodOptional<z.ZodString>;
+        appStore: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            platform: z.ZodEnum<{
+                ios: "ios";
+                macos: "macos";
+            }>;
+            iconUrl: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>>>;
+        video: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            provider: z.ZodEnum<{
+                vimeo: "vimeo";
+                wistia: "wistia";
+                youtube: "youtube";
+            }>;
+        }, z.core.$strip>>>;
+        orgSlug: z.ZodNullable<z.ZodString>;
+        orgName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        productSlug: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        version: z.ZodNullable<z.ZodString>;
+        title: z.ZodString;
+        summary: z.ZodString;
+        titleGenerated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        titleShort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        importance: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        content: z.ZodOptional<z.ZodString>;
+        media: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            type: z.ZodEnum<{
+                gif: "gif";
+                image: "image";
+                video: "video";
+            }>;
+            url: z.ZodString;
+            alt: z.ZodOptional<z.ZodString>;
+            r2Key: z.ZodOptional<z.ZodString>;
+            r2Url: z.ZodOptional<z.ZodString>;
+            linkUrl: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        publishedAt: z.ZodNullable<z.ZodString>;
+        score: z.ZodOptional<z.ZodNumber>;
+        type: z.ZodOptional<z.ZodEnum<{
+            feature: "feature";
+            rollup: "rollup";
+        }>>;
+        coverageCount: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    collections: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        slug: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        memberCount: z.ZodNumber;
+        via: z.ZodEnum<{
+            direct: "direct";
+            member: "member";
+        }>;
+        score: z.ZodOptional<z.ZodNumber>;
+        matchedOrgSlugs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        previewMembers: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            slug: z.ZodString;
+            name: z.ZodString;
+            domain: z.ZodNullable<z.ZodString>;
+            avatarUrl: z.ZodNullable<z.ZodString>;
+            githubHandle: z.ZodNullable<z.ZodString>;
+            description: z.ZodNullable<z.ZodString>;
+            kind: z.ZodLiteral<"org">;
+        }, z.core.$strip>, z.ZodObject<{
+            slug: z.ZodString;
+            name: z.ZodString;
+            description: z.ZodNullable<z.ZodString>;
+            org: z.ZodObject<{
+                slug: z.ZodString;
+                name: z.ZodString;
+                domain: z.ZodNullable<z.ZodString>;
+                avatarUrl: z.ZodNullable<z.ZodString>;
+                githubHandle: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+            kind: z.ZodLiteral<"product">;
+        }, z.core.$strip>], "kind">>>;
+    }, z.core.$strip>>>;
+    chunks: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        sourceSlug: z.ZodString;
+        sourceName: z.ZodString;
+        orgSlug: z.ZodNullable<z.ZodString>;
+        orgName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        filePath: z.ZodString;
+        offset: z.ZodNumber;
+        length: z.ZodNumber;
+        heading: z.ZodNullable<z.ZodString>;
+        snippet: z.ZodString;
+        score: z.ZodNumber;
+    }, z.core.$strip>>>;
+    mode: z.ZodOptional<z.ZodEnum<{
+        hybrid: "hybrid";
+        lexical: "lexical";
+        semantic: "semantic";
+    }>>;
+    degraded: z.ZodOptional<z.ZodBoolean>;
+    degradedReason: z.ZodOptional<z.ZodString>;
+    lookup: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        status: z.ZodEnum<{
+            deferred: "deferred";
+            empty: "empty";
+            existing: "existing";
+            indexed: "indexed";
+            not_found: "not_found";
+        }>;
+        source: z.ZodOptional<z.ZodObject<{
+            id: z.ZodString;
+            slug: z.ZodString;
+            name: z.ZodString;
+            url: z.ZodString;
+            discovery: z.ZodEnum<{
+                agent: "agent";
+                curated: "curated";
+                on_demand: "on_demand";
+            }>;
+            stars: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        }, z.core.$strip>>;
+        releases: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            version: z.ZodNullable<z.ZodString>;
+            title: z.ZodString;
+            publishedAt: z.ZodNullable<z.ZodString>;
+            thumbnail: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                url: z.ZodString;
+                alt: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>>;
+            url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, z.core.$strip>>>;
+        relatedOrg: z.ZodNullable<z.ZodObject<{
+            org: z.ZodObject<{
+                id: z.ZodString;
+                slug: z.ZodString;
+                name: z.ZodString;
+            }, z.core.$strip>;
+            sources: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                slug: z.ZodString;
+                name: z.ZodString;
+                url: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+//# sourceMappingURL=search.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../src/schemas/search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAexB;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;iBAiB7B,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmBjC,CAAC;AAEH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;iBAQhC,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsDjC,CAAC;AAEH;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkBpC,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;iBAW/B,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAqCpC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoCtC,CAAC"}