@buildinternet/releases-api-types 0.59.0 → 0.60.0

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

@@ -2,7 +2,6 @@ import { z } from "zod";
 import { KIND_VALUES } from "@buildinternet/releases-core/kinds";
 import { CategorySchema, ListResponseSchema, NoticeSchema, ReleaseItemSchema } from "./shared.js";
 import { SourceTypeSchema, SourceFeedPaginationSchema } from "./sources.js";
-
 /**
  * Raw `products` table row, returned by `POST /v1/products` and
  * `PATCH /v1/products/:slug`. The OSS CLI types these responses against
@@ -13,27 +12,24 @@ import { SourceTypeSchema, SourceFeedPaginationSchema } from "./sources.js";
  * indexed for semantic search.
  */
 export const ProductRowSchema = z.object({
-  id: z.string(),
-  name: z.string(),
-  slug: z.string(),
-  orgId: z.string(),
-  url: z.string().nullable(),
-  description: z.string().nullable(),
-  category: CategorySchema.nullable(),
-  kind: z.enum(KIND_VALUES).nullable().optional(),
-  avatarUrl: z.string().nullable().optional(),
-  createdAt: z.string(),
-  embeddedAt: z.string().nullable(),
-  deletedAt: z.string().nullable(),
-});
-
+    id: z.string(),
+    name: z.string(),
+    slug: z.string(),
+    orgId: z.string(),
+    url: z.string().nullable(),
+    description: z.string().nullable(),
+    category: CategorySchema.nullable(),
+    kind: z.enum(KIND_VALUES).nullable().optional(),
+    avatarUrl: z.string().nullable().optional(),
+    createdAt: z.string(),
+    embeddedAt: z.string().nullable(),
+    deletedAt: z.string().nullable(),
+});
 /** 201 body of POST /v1/products — ProductRow plus an optional non-blocking
  *  warning emitted when the new slug shadows an existing same-org source (#1190). */
 export const ProductCreateResponseSchema = ProductRowSchema.extend({
-  warning: z.string().optional(),
+    warning: z.string().optional(),
 });
-export type ProductCreateResponse = z.infer<typeof ProductCreateResponseSchema>;
-
 /**
  * Per-product row returned by `GET /v1/products`. Adds `sourceCount` to
  * the row shape but omits the internal `embeddedAt` / `deletedAt` columns
@@ -42,36 +38,33 @@ export type ProductCreateResponse = z.infer<typeof ProductCreateResponseSchema>;
  * list surfaces can render the avatar without a per-row detail round-trip.
  */
 export const ProductListItemSchema = z.object({
-  id: z.string(),
-  name: z.string(),
-  slug: z.string(),
-  orgId: z.string(),
-  url: z.string().nullable(),
-  description: z.string().nullable(),
-  category: CategorySchema.nullable(),
-  kind: z.enum(KIND_VALUES).nullable().optional(),
-  avatarUrl: z.string().nullable().optional(),
-  createdAt: z.string(),
-  sourceCount: z.number().int().min(0),
-});
-
+    id: z.string(),
+    name: z.string(),
+    slug: z.string(),
+    orgId: z.string(),
+    url: z.string().nullable(),
+    description: z.string().nullable(),
+    category: CategorySchema.nullable(),
+    kind: z.enum(KIND_VALUES).nullable().optional(),
+    avatarUrl: z.string().nullable().optional(),
+    createdAt: z.string(),
+    sourceCount: z.number().int().min(0),
+});
 export const ProductListResponseSchema = ListResponseSchema(ProductListItemSchema);
-
 /**
  * Embedded source row returned in `ProductDetail.sources`. The detail
  * handler explicitly selects only this small subset; reuses the shared
  * `SourceTypeSchema` enum so source types stay in one place.
  */
 export const ProductDetailSourceSchema = z.object({
-  id: z.string(),
-  slug: z.string(),
-  name: z.string(),
-  type: SourceTypeSchema,
-  url: z.string(),
-  metadata: z.string().nullable().optional(),
-  kind: z.enum(KIND_VALUES).nullable().optional(),
-});
-
+    id: z.string(),
+    slug: z.string(),
+    name: z.string(),
+    type: SourceTypeSchema,
+    url: z.string(),
+    metadata: z.string().nullable().optional(),
+    kind: z.enum(KIND_VALUES).nullable().optional(),
+});
 /**
  * Returned by `GET /v1/products/:identifier` (and the org-scoped twin).
  * Spreads the raw product row and adds `sources`, `tags`, `aliases`.
@@ -82,16 +75,15 @@ export const ProductDetailSourceSchema = z.object({
  * `ProductDetail` without the embedded feed.
  */
 export const ProductDetailSchema = ProductRowSchema.extend({
-  sources: z.array(ProductDetailSourceSchema),
-  tags: z.array(z.string()),
-  aliases: z.array(z.string()),
-  /** Embedded release feed — set by the web format adapter (PR #1207), absent on bare product detail. */
-  releases: z.array(ReleaseItemSchema).optional(),
-  /** Cursor pagination for the embedded release feed — set by the web format adapter (PR #1207), absent on bare product detail. */
-  pagination: SourceFeedPaginationSchema.optional(),
-  notice: NoticeSchema.nullable().optional(),
-});
-
+    sources: z.array(ProductDetailSourceSchema),
+    tags: z.array(z.string()),
+    aliases: z.array(z.string()),
+    /** Embedded release feed — set by the web format adapter (PR #1207), absent on bare product detail. */
+    releases: z.array(ReleaseItemSchema).optional(),
+    /** Cursor pagination for the embedded release feed — set by the web format adapter (PR #1207), absent on bare product detail. */
+    pagination: SourceFeedPaginationSchema.optional(),
+    notice: NoticeSchema.nullable().optional(),
+});
 /**
  * Body accepted by `POST /v1/products`. `category` is a non-empty string at
  * the wire boundary so callers can pass either a canonical slug or one of
@@ -101,34 +93,32 @@ export const ProductDetailSchema = ProductRowSchema.extend({
  * bypassed into persisting an invalid `""` value.
  */
 export const CreateProductBodySchema = z.object({
-  name: z.string().min(1),
-  orgId: z.string().optional(),
-  orgSlug: z.string().optional(),
-  slug: z.string().optional(),
-  url: z.string().optional(),
-  description: z.string().optional(),
-  category: z.string().min(1).optional(),
-  tags: z.array(z.string()).optional(),
-  kind: z.enum(KIND_VALUES).nullable().optional(),
-});
-
+    name: z.string().min(1),
+    orgId: z.string().optional(),
+    orgSlug: z.string().optional(),
+    slug: z.string().optional(),
+    url: z.string().optional(),
+    description: z.string().optional(),
+    category: z.string().min(1).optional(),
+    tags: z.array(z.string()).optional(),
+    kind: z.enum(KIND_VALUES).nullable().optional(),
+});
 /**
  * Body accepted by `PATCH /v1/products/:slug`. Same alias-allowed string rule
  * as create, plus `null` to explicitly clear the overlay. Empty strings stay
  * rejected so callers must pick between a slug/alias or `null`.
  */
 export const UpdateProductBodySchema = z.object({
-  name: z.string().optional(),
-  url: z.string().nullable().optional(),
-  description: z.string().nullable().optional(),
-  category: z.string().min(1).nullable().optional(),
-  tags: z.array(z.string()).optional(),
-  aliases: z.array(z.string()).optional(),
-  kind: z.enum(KIND_VALUES).nullable().optional(),
-  avatarUrl: z.string().nullable().optional(),
-  notice: NoticeSchema.nullable().optional(),
-});
-
+    name: z.string().optional(),
+    url: z.string().nullable().optional(),
+    description: z.string().nullable().optional(),
+    category: z.string().min(1).nullable().optional(),
+    tags: z.array(z.string()).optional(),
+    aliases: z.array(z.string()).optional(),
+    kind: z.enum(KIND_VALUES).nullable().optional(),
+    avatarUrl: z.string().nullable().optional(),
+    notice: NoticeSchema.nullable().optional(),
+});
 /**
  * Body accepted by `POST /v1/products/adopt`.
  *
@@ -137,14 +127,13 @@ export const UpdateProductBodySchema = z.object({
  * `slug` and `url` must be omitted (the existing product's values stand).
  */
 export const AdoptProductBodySchema = z.object({
-  sourceOrgSlug: z.string().min(1),
-  targetOrgSlug: z.string().min(1),
-  slug: z.string().optional(),
-  url: z.string().optional(),
-  mergeInto: z.string().optional(),
-  dryRun: z.boolean().optional(),
-});
-
+    sourceOrgSlug: z.string().min(1),
+    targetOrgSlug: z.string().min(1),
+    slug: z.string().optional(),
+    url: z.string().optional(),
+    mergeInto: z.string().optional(),
+    dryRun: z.boolean().optional(),
+});
 /**
  * Live (non-dryRun) result from `POST /v1/products/adopt`.
  *
@@ -152,99 +141,87 @@ export const AdoptProductBodySchema = z.object({
  * existing product's slug, signalling that no new product was created.
  */
 export const ProductAdoptResultSchema = z.object({
-  product: ProductRowSchema,
-  mergedInto: z.string().optional(),
-  sourcesMoved: z.number().int().min(0),
-  accountsMoved: z.number().int().min(0),
-  sourceOrgDeleted: z.string(),
+    product: ProductRowSchema,
+    mergedInto: z.string().optional(),
+    sourcesMoved: z.number().int().min(0),
+    accountsMoved: z.number().int().min(0),
+    sourceOrgDeleted: z.string(),
 });
-
 /** Dry-run preview from `POST /v1/products/adopt` with `dryRun: true`. */
 export const ProductAdoptDryRunSchema = z.object({
-  dryRun: z.literal(true),
-  mergeInto: z.string().optional(),
-  product: z.object({
-    name: z.string(),
-    slug: z.string(),
-    url: z.string().nullable(),
-    orgSlug: z.string(),
-  }),
-  sourcesToMove: z.array(z.string()),
-  sourceOrgToDelete: z.string(),
+    dryRun: z.literal(true),
+    mergeInto: z.string().optional(),
+    product: z.object({
+        name: z.string(),
+        slug: z.string(),
+        url: z.string().nullable(),
+        orgSlug: z.string(),
+    }),
+    sourcesToMove: z.array(z.string()),
+    sourceOrgToDelete: z.string(),
 });
-
 /** Response shape returned by `POST /v1/products/adopt` (union of live + dry-run). */
 export const ProductAdoptResponseSchema = z.union([
-  ProductAdoptResultSchema,
-  ProductAdoptDryRunSchema,
+    ProductAdoptResultSchema,
+    ProductAdoptDryRunSchema,
 ]);
-
 /** Response shape returned by `DELETE /v1/products/:identifier`. */
 export const ProductDeleteResponseSchema = z.object({
-  deleted: z.literal(true),
-  hard: z.literal(true).optional(),
-  deletedAt: z.string().optional(),
+    deleted: z.literal(true),
+    hard: z.literal(true).optional(),
+    deletedAt: z.string().optional(),
 });
-
 /**
  * Tag list returned by `GET /v1/products/:identifier/tags`. Tag names are
  * sorted alphabetically; the empty array is returned when the product has
  * no tags rather than 404.
  */
 export const ProductTagsListResponseSchema = z.array(z.string());
-
 /** Body accepted by `PUT` and `DELETE` `/v1/products/:identifier/tags`. */
 export const ProductTagsBodySchema = z.object({
-  tags: z.array(z.string()),
+    tags: z.array(z.string()),
 });
-
 /** Response shape returned by `PUT` and `DELETE` `/v1/products/:identifier/tags`. */
 export const ProductTagsMutationResponseSchema = z.object({
-  ok: z.literal(true),
+    ok: z.literal(true),
 });
-
 // ── Product activity (/products/:slug/activity, /orgs/:orgSlug/products/:productSlug/activity) ──
-
 const ProductActivityWeeklyBucketSchema = z.object({
-  weekStart: z.string(),
-  count: z.number().int().min(0),
-  earliestVersion: z.string().nullable(),
-  latestVersion: z.string().nullable(),
+    weekStart: z.string(),
+    count: z.number().int().min(0),
+    earliestVersion: z.string().nullable(),
+    latestVersion: z.string().nullable(),
 });
-
 const ProductActivitySourceSchema = z.object({
-  slug: z.string(),
-  name: z.string(),
-  releaseCount: z.number().int().min(0),
-  avgReleasesPerWeek: z.number(),
-  earliestVersion: z.string().nullable(),
-  latestVersion: z.string().nullable(),
-  latestDate: z.string().nullable(),
-  weeklyBuckets: z.array(ProductActivityWeeklyBucketSchema),
-});
-
+    slug: z.string(),
+    name: z.string(),
+    releaseCount: z.number().int().min(0),
+    avgReleasesPerWeek: z.number(),
+    earliestVersion: z.string().nullable(),
+    latestVersion: z.string().nullable(),
+    latestDate: z.string().nullable(),
+    weeklyBuckets: z.array(ProductActivityWeeklyBucketSchema),
+});
 /**
  * Response shape for `GET /v1/products/:slug/activity` and the org-scoped twin.
  * Returns per-source weekly release buckets plus an aggregate rollup — used for
  * timeline visualization on the product detail page.
  */
 export const ProductActivityResponseSchema = z.object({
-  product: z.object({ slug: z.string(), name: z.string() }),
-  range: z.object({ from: z.string(), to: z.string() }),
-  sources: z.array(ProductActivitySourceSchema),
-  aggregateWeekly: z.array(z.object({ weekStart: z.string(), count: z.number().int().min(0) })),
+    product: z.object({ slug: z.string(), name: z.string() }),
+    range: z.object({ from: z.string(), to: z.string() }),
+    sources: z.array(ProductActivitySourceSchema),
+    aggregateWeekly: z.array(z.object({ weekStart: z.string(), count: z.number().int().min(0) })),
 });
-
 // ── Product heatmap (/products/:slug/heatmap, /orgs/:orgSlug/products/:productSlug/heatmap) ──
-
 /**
  * Response shape for `GET /v1/products/:slug/heatmap` and the org-scoped twin.
  * Returns daily release counts for the trailing 365 days — used for
  * contribution-graph visualization on the product detail page.
  */
 export const ProductHeatmapResponseSchema = z.object({
-  product: z.object({ slug: z.string(), name: z.string() }),
-  range: z.object({ from: z.string(), to: z.string() }),
-  dailyCounts: z.array(z.object({ date: z.string(), count: z.number().int().min(0) })),
-  total: z.number().int().min(0),
+    product: z.object({ slug: z.string(), name: z.string() }),
+    range: z.object({ from: z.string(), to: z.string() }),
+    dailyCounts: z.array(z.object({ date: z.string(), count: z.number().int().min(0) })),
+    total: z.number().int().min(0),
 });

package/dist/schemas/publish-tokens.d.ts

@@ -0,0 +1,55 @@
+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 declare const CreatePublishTokenBodySchema: z.ZodObject<{
+    sourceId: z.ZodString;
+    name: z.ZodString;
+}, z.core.$strict>;
+export type CreatePublishTokenBody = z.infer<typeof CreatePublishTokenBodySchema>;
+/** POST /v1/me/publish-tokens 201 response. `token` is shown exactly once. */
+export declare const CreatedPublishTokenSchema: z.ZodObject<{
+    token: z.ZodString;
+    id: z.ZodString;
+    sourceId: z.ZodString;
+    name: z.ZodString;
+    createdAt: z.ZodString;
+}, z.core.$strict>;
+export type CreatedPublishToken = z.infer<typeof CreatedPublishTokenSchema>;
+/** One publish token as listed back to its owner — never the secret. */
+export declare const PublishTokenSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    sourceId: z.ZodString;
+    sourceSlug: z.ZodNullable<z.ZodString>;
+    orgSlug: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodString;
+    lastUsedAt: z.ZodNullable<z.ZodString>;
+    revokedAt: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export type PublishToken = z.infer<typeof PublishTokenSchema>;
+/** GET /v1/me/publish-tokens response. */
+export declare const ListPublishTokensResponseSchema: z.ZodObject<{
+    publishTokens: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        sourceId: z.ZodString;
+        sourceSlug: z.ZodNullable<z.ZodString>;
+        orgSlug: z.ZodNullable<z.ZodString>;
+        createdAt: z.ZodString;
+        lastUsedAt: z.ZodNullable<z.ZodString>;
+        revokedAt: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type ListPublishTokensResponse = z.infer<typeof ListPublishTokensResponseSchema>;
+/** DELETE /v1/me/publish-tokens/:id response. */
+export declare const RevokePublishTokenResponseSchema: z.ZodObject<{
+    id: z.ZodString;
+    revokedAt: z.ZodString;
+}, z.core.$strict>;
+export type RevokePublishTokenResponse = z.infer<typeof RevokePublishTokenResponseSchema>;
+//# sourceMappingURL=publish-tokens.d.ts.map

package/dist/schemas/publish-tokens.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"publish-tokens.d.ts","sourceRoot":"","sources":["../../src/schemas/publish-tokens.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;GAKG;AAEH,+CAA+C;AAC/C,eAAO,MAAM,4BAA4B;;;kBAGvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAElF,8EAA8E;AAC9E,eAAO,MAAM,yBAAyB;;;;;;kBAMpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,wEAAwE;AACxE,eAAO,MAAM,kBAAkB;;;;;;;;;kBAS7B,CAAC;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,0CAA0C;AAC1C,eAAO,MAAM,+BAA+B;;;;;;;;;;;kBAE1C,CAAC;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAExF,iDAAiD;AACjD,eAAO,MAAM,gCAAgC;;;kBAG3C,CAAC;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC"}

package/{src/schemas/publish-tokens.ts → dist/schemas/publish-tokens.js}

@@ -1,51 +1,40 @@
 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),
+    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(),
+    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(),
+    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),
+    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(),
+    id: z.string(),
+    revokedAt: z.string(),
 });
-export type RevokePublishTokenResponse = z.infer<typeof RevokePublishTokenResponseSchema>;

package/dist/schemas/recommendations.d.ts

@@ -0,0 +1,52 @@
+import { z } from "zod";
+/**
+ * `POST /v1/admin/recommendations/:id/notify-added` body.
+ *
+ * Resolves a live registry listing (org required, source optional) and
+ * emails the submitter's `contactEmail` that their suggestion was added.
+ * Opt-in only — triage / close / archive never send this.
+ */
+export declare const RecommendationNotifyAddedBodySchema: z.ZodObject<{
+    orgSlug: z.ZodString;
+    sourceSlug: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * `POST /v1/admin/recommendations/:id/notify-added` success body.
+ *
+ * `sent: false` + `reason: "already_notified"` is the idempotent replay —
+ * a second call does not email again.
+ */
+export declare const RecommendationNotifyAddedResultSchema: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+    sent: z.ZodBoolean;
+    reason: z.ZodOptional<z.ZodEnum<{
+        already_notified: "already_notified";
+    }>>;
+    notifiedAt: z.ZodNullable<z.ZodNumber>;
+    registryUrl: z.ZodOptional<z.ZodString>;
+    contactEmail: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** `POST /v1/recommendations` field limits, shared with the handler's sanitizer. */
+export declare const RECOMMENDATION_URL_MAX_CHARS = 2048;
+export declare const RECOMMENDATION_NOTE_MAX_CHARS = 4000;
+export declare const RECOMMENDATION_CONTACT_EMAIL_MAX_CHARS = 200;
+/**
+ * `POST /v1/recommendations` body — suggest a changelog the registry should
+ * track. `note` and `contactEmail` are optional; a contact email gets an
+ * acknowledgement and, later, an opt-in "it's been added" notice.
+ */
+export declare const RecommendationSubmitBodySchema: z.ZodObject<{
+    type: z.ZodEnum<{
+        source: "source";
+    }>;
+    url: z.ZodString;
+    note: z.ZodOptional<z.ZodString>;
+    contactEmail: z.ZodOptional<z.ZodString>;
+    surface: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** `POST /v1/recommendations` 202 response. */
+export declare const RecommendationSubmitResponseSchema: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+    id: z.ZodString;
+}, z.core.$strip>;
+//# sourceMappingURL=recommendations.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendations.d.ts","sourceRoot":"","sources":["../../src/schemas/recommendations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;;;GAMG;AACH,eAAO,MAAM,mCAAmC;;;iBAc9C,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,qCAAqC;;;;;;;;;iBAOhD,CAAC;AAEH,oFAAoF;AACpF,eAAO,MAAM,4BAA4B,OAAO,CAAC;AACjD,eAAO,MAAM,6BAA6B,OAAO,CAAC;AAClD,eAAO,MAAM,sCAAsC,MAAM,CAAC;AAE1D;;;;GAIG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;iBASzC,CAAC;AAEH,+CAA+C;AAC/C,eAAO,MAAM,kCAAkC;;;iBAG7C,CAAC"}

package/dist/schemas/recommendations.js

@@ -0,0 +1,58 @@
+import { z } from "zod";
+import { RECOMMENDATION_TYPES } from "@buildinternet/releases-core/schema";
+/**
+ * `POST /v1/admin/recommendations/:id/notify-added` body.
+ *
+ * Resolves a live registry listing (org required, source optional) and
+ * emails the submitter's `contactEmail` that their suggestion was added.
+ * Opt-in only — triage / close / archive never send this.
+ */
+export const RecommendationNotifyAddedBodySchema = z.object({
+    orgSlug: z
+        .string()
+        .min(1)
+        .describe("Org slug or `org_…` id of the onboarded listing. Required so the email can link a live registry URL."),
+    sourceSlug: z
+        .string()
+        .min(1)
+        .optional()
+        .describe("Optional source slug or `src_…` id under that org. When set, the email links the source page."),
+});
+/**
+ * `POST /v1/admin/recommendations/:id/notify-added` success body.
+ *
+ * `sent: false` + `reason: "already_notified"` is the idempotent replay —
+ * a second call does not email again.
+ */
+export const RecommendationNotifyAddedResultSchema = z.object({
+    ok: z.literal(true),
+    sent: z.boolean(),
+    reason: z.enum(["already_notified"]).optional(),
+    notifiedAt: z.number().nullable(),
+    registryUrl: z.string().optional(),
+    contactEmail: z.string().optional(),
+});
+/** `POST /v1/recommendations` field limits, shared with the handler's sanitizer. */
+export const RECOMMENDATION_URL_MAX_CHARS = 2048;
+export const RECOMMENDATION_NOTE_MAX_CHARS = 4000;
+export const RECOMMENDATION_CONTACT_EMAIL_MAX_CHARS = 200;
+/**
+ * `POST /v1/recommendations` body — suggest a changelog the registry should
+ * track. `note` and `contactEmail` are optional; a contact email gets an
+ * acknowledgement and, later, an opt-in "it's been added" notice.
+ */
+export const RecommendationSubmitBodySchema = z.object({
+    type: z.enum(RECOMMENDATION_TYPES),
+    url: z
+        .string()
+        .max(RECOMMENDATION_URL_MAX_CHARS)
+        .describe("http(s) URL of the changelog or project."),
+    note: z.string().max(RECOMMENDATION_NOTE_MAX_CHARS).optional(),
+    contactEmail: z.string().max(RECOMMENDATION_CONTACT_EMAIL_MAX_CHARS).optional(),
+    surface: z.string().max(32).optional(),
+});
+/** `POST /v1/recommendations` 202 response. */
+export const RecommendationSubmitResponseSchema = z.object({
+    ok: z.literal(true),
+    id: z.string(),
+});