@solutiondesk/changelog 1.19.0 → 1.20.0

package/README.md

@@ -1,6 +1,6 @@
 # @solutiondesk/changelog
 
-Typed client for the public [SolutionDesk](https://solutiondesk.io) changelog, plus React hooks and unstyled components. Your team writes the updates in SolutionDesk; your app or website shows them with this package.
+Typed client for the public [SolutionDesk](https://solutiondesk.io) changelogs, plus React hooks and unstyled components. Your team writes the updates for each of its products in SolutionDesk; your app or website shows them with this package.
 
 - The client has no dependencies, ships ESM and CommonJS with full TypeScript types, and runs wherever `fetch` does: Node.js 18+, Deno, Bun, edge runtimes and browsers.
 - No key and no login: the API only ever returns published entries.
@@ -10,39 +10,40 @@ Typed client for the public [SolutionDesk](https://solutiondesk.io) changelog, p
 npm install @solutiondesk/changelog
 ```
 
-No code at all? The [Changelog guide](https://help.solutiondesk.io/docs/team/changelog) shows the hosted page and the ready-made "What's new" button (two lines of HTML).
+No code at all? The [Products guide](https://help.solutiondesk.io/docs/team/changelog) shows the hosted page and the ready-made "What's new" button (two lines of HTML).
 
 ## Quick start
 
 ```ts
 import { createChangelogClient } from "@solutiondesk/changelog";
 
-const changelog = createChangelogClient({ workspace: "acme" });
+const changelog = createChangelogClient({ workspace: "acme", product: "acme-mobile" });
 
 const { title, entries, nextCursor } = await changelog.list({ limit: 10 });
 const { entry } = await changelog.getEntry("export-to-csv");
 ```
 
-`workspace` is your workspace's slug, the `acme` in the address shown under **Changelog → Page & button → For developers** (`https://api.solutiondesk.io/v1/changelog/acme`).
+`workspace` and `product` are the two parts of the address shown under **Products → your product → Page & settings → For developers** (`https://api.solutiondesk.io/v1/changelog/acme/acme-mobile`). Leave `product` out to read the workspace's default product.
 
 ## What you can read
 
 | Method | API | Returns |
 | --- | --- | --- |
-| `list({ category, limit, cursor })` | `GET /v1/changelog/{workspace}` | The team's title and button settings, the hosted `pageUrl`, one page of entries (newest first) and `nextCursor` (`limit` 1–50, default 20). |
+| `list({ category, limit, cursor })` | `GET /v1/changelog/{workspace}/{product}` | The `product`, its title and button settings, the hosted `pageUrl`, one page of entries (newest first) and `nextCursor` (`limit` 1–50, default 20). |
 | `allEntries({ category })` | the same, page by page | An async iterator over every published entry, e.g. for a sitemap or an RSS feed. |
-| `getEntry(slug)` | `GET /v1/changelog/{workspace}/entries/{slug}` | One entry. |
+| `getEntry(slug)` | `GET /v1/changelog/{workspace}/{product}/entries/{slug}` | One entry and its product. |
+| `listProducts()` | `GET /v1/changelog/{workspace}/products` | Every product (name, slug, description, `pageUrl`), the default first. |
 
 Each entry has `title`, `summary` (one or two sentences), `category` (`new`, `improved`, `fixed`, `announcement`), `publishedAt`, the details as `markdown` and as `html`, and `url` (the entry on the hosted page). `html` is safe to insert as it is: raw HTML in the team's text is escaped, links only go to web addresses and paths, images only come from https addresses.
 
-A workspace that doesn't exist, a changelog that is turned off and an unpublished entry all answer `404` (`SolutionDeskError` with `isNotFound`).
+A workspace or product that doesn't exist, a changelog that is turned off and an unpublished entry all answer `404` (`SolutionDeskError` with `isNotFound`).
 
 ## "New" badge
 
 ```ts
 import { createSeenTracker } from "@solutiondesk/changelog";
 
-const seen = createSeenTracker("acme"); // the browser's localStorage by default
+const seen = createSeenTracker("acme", undefined, "acme-mobile"); // the browser's localStorage by default
 const unseen = seen.unseen(entries); // entries newer than the visitor's last look
 seen.markSeen(entries[0].publishedAt); // when they open your panel
 ```
@@ -57,10 +58,10 @@ On the very first visit nothing counts as new — remember the newest entry then
 import { ChangelogFeed, WhatsNew } from "@solutiondesk/changelog/react";
 
 // In your app's header: a button with the unseen count that opens the latest entries.
-<WhatsNew workspace="acme" classNames={{ button: "btn", badge: "badge", panel: "popover" }} />
+<WhatsNew workspace="acme" product="acme-mobile" classNames={{ button: "btn", badge: "badge", panel: "popover" }} />
 
 // A whole changelog page: entries with their details and "Older updates".
-<ChangelogFeed workspace="acme" locale="de" entryClassNames={{ title: "text-xl font-semibold" }} />
+<ChangelogFeed workspace="acme" product="acme-mobile" locale="de" entryClassNames={{ title: "text-xl font-semibold" }} />
 ```
 
 The components render plain elements with `className` props and `data-sd-*` attributes (`data-sd-changelog-entry`, `data-category`, `data-sd-whats-new-badge` …) and ship no CSS. Both render nothing (or your `fallback`) when the changelog can't be loaded, so they never break your page.
@@ -73,6 +74,7 @@ import { useChangelog } from "@solutiondesk/changelog/react";
 function Updates() {
   const { status, entries, unseen, markAllSeen, hasMore, loadMore } = useChangelog({
     workspace: "acme",
+    product: "acme-mobile",
     limit: 5,
   });
   if (status !== "ready") return null;

package/dist/index.cjs

@@ -166,8 +166,10 @@ function required(value, name) {
 // src/client.ts
 function createChangelogClient(options) {
   const workspace = required(options.workspace, "workspace");
+  const product = options.product?.trim() || void 0;
   const http = createHttp(options);
-  const base = `/changelog/${seg(workspace)}`;
+  const root = `/changelog/${seg(workspace)}`;
+  const base = product ? `${root}/${seg(product)}` : root;
   const list = (params = {}, requestOptions) => http.request({
     method: "GET",
     path: base,
@@ -187,12 +189,18 @@ function createChangelogClient(options) {
   }
   return {
     workspace,
+    product,
     list,
     allEntries,
     getEntry: (slug, requestOptions) => http.request({
       method: "GET",
       path: `${base}/entries/${seg(required(slug, "slug"))}`,
       options: requestOptions
+    }),
+    listProducts: (requestOptions) => http.request({
+      method: "GET",
+      path: `${root}/products`,
+      options: requestOptions
     })
   };
 }
@@ -206,8 +214,8 @@ function browserStorage() {
     return null;
   }
 }
-function createSeenTracker(workspace, storage = browserStorage()) {
-  const key = `sd-changelog-seen:${workspace.toLowerCase()}`;
+function createSeenTracker(workspace, storage = browserStorage(), product) {
+  const key = `sd-changelog-seen:${workspace.toLowerCase()}${product ? `:${product.toLowerCase()}` : ""}`;
   const lastSeen = () => {
     try {
       return storage?.getItem(key) ?? null;

package/dist/index.d.cts

@@ -108,20 +108,48 @@ interface PublicChangelogEntry {
     /** One or two sentences — what a "What's new" panel shows. May be empty. */
     summary: string;
     category: ChangelogCategory;
+    /** The release this change ships in (`2.3.0`); empty when it isn't tied to one. */
+    releaseVersion: string;
+    /** Where the release can be downloaded (an app store page, GitHub Releases …), or null. */
+    downloadUrl: string | null;
     /** ISO 8601. The list is sorted by it, newest first. */
     publishedAt: string;
     /** The details as the team wrote them (Markdown). */
     markdown: string;
     /**
      * The details as safe HTML: raw HTML in the text is escaped, links are only
-     * http(s)/mailto/relative, images only from https addresses. Ready for
-     * `innerHTML` / `dangerouslySetInnerHTML`. Empty when there are no details.
+     * http(s)/mailto/relative, images only the ones uploaded to the entry (with
+     * `srcset`). Ready for `innerHTML` / `dangerouslySetInnerHTML`. Empty when
+     * there are no details.
      */
     html: string;
     /** The entry on the workspace's hosted changelog page. */
     url: string;
 }
-/** `GET /v1/changelog/{workspace}` — settings and one page of entries. */
+/** A product with its own changelog. */
+interface PublicChangelogProduct {
+    name: string;
+    slug: string;
+    /** One sentence about the product. May be empty. */
+    description: string;
+    /** The product's hosted changelog page. */
+    pageUrl: string;
+    /** The default product: addresses without a product show this one. */
+    isDefault: boolean;
+}
+/** `GET /v1/changelog/{workspace}/products` — every product, the default first. */
+interface PublicChangelogProductsPayload {
+    workspace: {
+        name: string;
+        slug: string;
+        logoUrl: string | null;
+    };
+    products: PublicChangelogProduct[];
+}
+/**
+ * `GET /v1/changelog/{workspace}/{product}` — a product's settings and one
+ * page of its entries (`GET /v1/changelog/{workspace}`: the default product).
+ */
 interface PublicChangelogPayload {
     /** The workspace as the hosted page shows it; `logoUrl` is relative to the API. */
     workspace: {
@@ -129,6 +157,8 @@ interface PublicChangelogPayload {
         slug: string;
         logoUrl: string | null;
     };
+    /** The product these entries belong to. */
+    product: PublicChangelogProduct;
     /** The heading the team chose; empty ⇒ use your own ("What's new"). */
     title: string;
     /** The team's settings for the "What's new" button (empty label ⇒ your own). */
@@ -136,20 +166,27 @@ interface PublicChangelogPayload {
         label: string;
         position: ChangelogWidgetPosition;
     };
-    /** The hosted changelog page. */
+    /** The product's hosted changelog page. */
     pageUrl: string;
     entries: PublicChangelogEntry[];
     /** Pass as `cursor` for the next page; null on the last one. */
     nextCursor: string | null;
 }
-/** `GET /v1/changelog/{workspace}/entries/{slug}`. */
+/** `GET /v1/changelog/{workspace}/{product}/entries/{slug}`. */
 interface PublicChangelogEntryPayload {
+    /** The product whose changelog shows the entry. */
+    product: PublicChangelogProduct;
     entry: PublicChangelogEntry;
 }
 
 interface ChangelogClientOptions extends BaseClientOptions {
     /** Your workspace's slug — the `acme` in `https://api.solutiondesk.io/v1/changelog/acme`. */
     workspace: string;
+    /**
+     * The product whose changelog to read (its web address, e.g. `acme-mobile`).
+     * Without it, the workspace's default product.
+     */
+    product?: string;
 }
 interface ListEntriesParams {
     /** Only entries of this category. */
@@ -162,26 +199,32 @@ interface ListEntriesParams {
 interface ChangelogClient {
     /** The workspace this client reads. */
     readonly workspace: string;
+    /** The product this client reads, or undefined for the default product. */
+    readonly product: string | undefined;
     /**
-     * The team's settings and one page of published entries, newest first
-     * (`GET /v1/changelog/{workspace}`). Throws a `SolutionDeskError` with status
-     * 404 when the workspace doesn't exist or its changelog is turned off.
+     * The product's settings and one page of its published entries, newest first
+     * (`GET /v1/changelog/{workspace}/{product}`). Throws a `SolutionDeskError`
+     * with status 404 when the workspace or product doesn't exist or the
+     * changelog is turned off.
      */
     list(params?: ListEntriesParams, options?: RequestOptions): Promise<PublicChangelogPayload>;
     /** Every published entry, page by page — e.g. for a sitemap, an RSS feed or a static build. */
     allEntries(params?: Omit<ListEntriesParams, "cursor">, options?: RequestOptions): AsyncGenerator<PublicChangelogEntry, void, undefined>;
     /**
-     * One published entry (`GET /v1/changelog/{workspace}/entries/{slug}`).
-     * Throws a `SolutionDeskError` with status 404 for an unknown or unpublished entry.
+     * One published entry of the product (`…/{product}/entries/{slug}`; without
+     * a product, of any product). Throws a `SolutionDeskError` with status 404
+     * for an unknown or unpublished entry.
      */
     getEntry(slug: string, options?: RequestOptions): Promise<PublicChangelogEntryPayload>;
+    /** Every product of the workspace, the default first (`GET /v1/changelog/{workspace}/products`). */
+    listProducts(options?: RequestOptions): Promise<PublicChangelogProductsPayload>;
 }
 /**
  * A client for the public changelog API — no key, no login; only published
  * entries. Safe in the browser and on the server.
  *
  * @example
- * const changelog = createChangelogClient({ workspace: "acme" });
+ * const changelog = createChangelogClient({ workspace: "acme", product: "acme-mobile" });
  * const { entries, nextCursor } = await changelog.list({ limit: 10 });
  */
 declare function createChangelogClient(options: ChangelogClientOptions): ChangelogClient;
@@ -213,11 +256,12 @@ interface SeenTracker {
 /** The browser's `localStorage`, or null (server rendering, privacy mode). */
 declare function browserStorage(): SeenStorage | null;
 /**
- * A {@link SeenTracker} for one workspace. Uses the key
- * `sd-changelog-seen:<workspace>` — the same one the SolutionDesk widget uses,
- * so a visitor who opened either sees no badge in the other.
+ * A {@link SeenTracker} for one workspace's product. Uses the key
+ * `sd-changelog-seen:<workspace>` (default product) or
+ * `sd-changelog-seen:<workspace>:<product>` — the same ones the SolutionDesk
+ * widget uses, so a visitor who opened either sees no badge in the other.
  */
-declare function createSeenTracker(workspace: string, storage?: SeenStorage | null): SeenTracker;
+declare function createSeenTracker(workspace: string, storage?: SeenStorage | null, product?: string): SeenTracker;
 type ChangelogLocale = "de" | "en";
 /** The category names the hosted page uses, for your own UI. */
 declare const CATEGORY_LABELS: Record<ChangelogLocale, Record<ChangelogCategory, string>>;
@@ -226,4 +270,4 @@ declare const CATEGORY_COLORS: Record<ChangelogCategory, string>;
 /** A category's name in German (`de*`) or English (everything else). */
 declare function categoryLabel(category: ChangelogCategory, locale?: string): string;
 
-export { type BaseClientOptions, CATEGORY_COLORS, CATEGORY_LABELS, type CachedResponse, type ChangelogCategory, type ChangelogClient, type ChangelogClientOptions, type ChangelogLocale, type ChangelogWidgetPosition, DEFAULT_BASE_URL, type EtagCache, type FetchInitLike, type FetchLike, type FetchResponseLike, type ListEntriesParams, type PublicChangelogEntry, type PublicChangelogEntryPayload, type PublicChangelogPayload, type RequestOptions, type SeenStorage, type SeenTracker, SolutionDeskError, browserStorage, categoryLabel, createChangelogClient, createMemoryEtagCache, createSeenTracker };
+export { type BaseClientOptions, CATEGORY_COLORS, CATEGORY_LABELS, type CachedResponse, type ChangelogCategory, type ChangelogClient, type ChangelogClientOptions, type ChangelogLocale, type ChangelogWidgetPosition, DEFAULT_BASE_URL, type EtagCache, type FetchInitLike, type FetchLike, type FetchResponseLike, type ListEntriesParams, type PublicChangelogEntry, type PublicChangelogEntryPayload, type PublicChangelogPayload, type PublicChangelogProduct, type PublicChangelogProductsPayload, type RequestOptions, type SeenStorage, type SeenTracker, SolutionDeskError, browserStorage, categoryLabel, createChangelogClient, createMemoryEtagCache, createSeenTracker };

package/dist/index.d.ts

@@ -108,20 +108,48 @@ interface PublicChangelogEntry {
     /** One or two sentences — what a "What's new" panel shows. May be empty. */
     summary: string;
     category: ChangelogCategory;
+    /** The release this change ships in (`2.3.0`); empty when it isn't tied to one. */
+    releaseVersion: string;
+    /** Where the release can be downloaded (an app store page, GitHub Releases …), or null. */
+    downloadUrl: string | null;
     /** ISO 8601. The list is sorted by it, newest first. */
     publishedAt: string;
     /** The details as the team wrote them (Markdown). */
     markdown: string;
     /**
      * The details as safe HTML: raw HTML in the text is escaped, links are only
-     * http(s)/mailto/relative, images only from https addresses. Ready for
-     * `innerHTML` / `dangerouslySetInnerHTML`. Empty when there are no details.
+     * http(s)/mailto/relative, images only the ones uploaded to the entry (with
+     * `srcset`). Ready for `innerHTML` / `dangerouslySetInnerHTML`. Empty when
+     * there are no details.
      */
     html: string;
     /** The entry on the workspace's hosted changelog page. */
     url: string;
 }
-/** `GET /v1/changelog/{workspace}` — settings and one page of entries. */
+/** A product with its own changelog. */
+interface PublicChangelogProduct {
+    name: string;
+    slug: string;
+    /** One sentence about the product. May be empty. */
+    description: string;
+    /** The product's hosted changelog page. */
+    pageUrl: string;
+    /** The default product: addresses without a product show this one. */
+    isDefault: boolean;
+}
+/** `GET /v1/changelog/{workspace}/products` — every product, the default first. */
+interface PublicChangelogProductsPayload {
+    workspace: {
+        name: string;
+        slug: string;
+        logoUrl: string | null;
+    };
+    products: PublicChangelogProduct[];
+}
+/**
+ * `GET /v1/changelog/{workspace}/{product}` — a product's settings and one
+ * page of its entries (`GET /v1/changelog/{workspace}`: the default product).
+ */
 interface PublicChangelogPayload {
     /** The workspace as the hosted page shows it; `logoUrl` is relative to the API. */
     workspace: {
@@ -129,6 +157,8 @@ interface PublicChangelogPayload {
         slug: string;
         logoUrl: string | null;
     };
+    /** The product these entries belong to. */
+    product: PublicChangelogProduct;
     /** The heading the team chose; empty ⇒ use your own ("What's new"). */
     title: string;
     /** The team's settings for the "What's new" button (empty label ⇒ your own). */
@@ -136,20 +166,27 @@ interface PublicChangelogPayload {
         label: string;
         position: ChangelogWidgetPosition;
     };
-    /** The hosted changelog page. */
+    /** The product's hosted changelog page. */
     pageUrl: string;
     entries: PublicChangelogEntry[];
     /** Pass as `cursor` for the next page; null on the last one. */
     nextCursor: string | null;
 }
-/** `GET /v1/changelog/{workspace}/entries/{slug}`. */
+/** `GET /v1/changelog/{workspace}/{product}/entries/{slug}`. */
 interface PublicChangelogEntryPayload {
+    /** The product whose changelog shows the entry. */
+    product: PublicChangelogProduct;
     entry: PublicChangelogEntry;
 }
 
 interface ChangelogClientOptions extends BaseClientOptions {
     /** Your workspace's slug — the `acme` in `https://api.solutiondesk.io/v1/changelog/acme`. */
     workspace: string;
+    /**
+     * The product whose changelog to read (its web address, e.g. `acme-mobile`).
+     * Without it, the workspace's default product.
+     */
+    product?: string;
 }
 interface ListEntriesParams {
     /** Only entries of this category. */
@@ -162,26 +199,32 @@ interface ListEntriesParams {
 interface ChangelogClient {
     /** The workspace this client reads. */
     readonly workspace: string;
+    /** The product this client reads, or undefined for the default product. */
+    readonly product: string | undefined;
     /**
-     * The team's settings and one page of published entries, newest first
-     * (`GET /v1/changelog/{workspace}`). Throws a `SolutionDeskError` with status
-     * 404 when the workspace doesn't exist or its changelog is turned off.
+     * The product's settings and one page of its published entries, newest first
+     * (`GET /v1/changelog/{workspace}/{product}`). Throws a `SolutionDeskError`
+     * with status 404 when the workspace or product doesn't exist or the
+     * changelog is turned off.
      */
     list(params?: ListEntriesParams, options?: RequestOptions): Promise<PublicChangelogPayload>;
     /** Every published entry, page by page — e.g. for a sitemap, an RSS feed or a static build. */
     allEntries(params?: Omit<ListEntriesParams, "cursor">, options?: RequestOptions): AsyncGenerator<PublicChangelogEntry, void, undefined>;
     /**
-     * One published entry (`GET /v1/changelog/{workspace}/entries/{slug}`).
-     * Throws a `SolutionDeskError` with status 404 for an unknown or unpublished entry.
+     * One published entry of the product (`…/{product}/entries/{slug}`; without
+     * a product, of any product). Throws a `SolutionDeskError` with status 404
+     * for an unknown or unpublished entry.
      */
     getEntry(slug: string, options?: RequestOptions): Promise<PublicChangelogEntryPayload>;
+    /** Every product of the workspace, the default first (`GET /v1/changelog/{workspace}/products`). */
+    listProducts(options?: RequestOptions): Promise<PublicChangelogProductsPayload>;
 }
 /**
  * A client for the public changelog API — no key, no login; only published
  * entries. Safe in the browser and on the server.
  *
  * @example
- * const changelog = createChangelogClient({ workspace: "acme" });
+ * const changelog = createChangelogClient({ workspace: "acme", product: "acme-mobile" });
  * const { entries, nextCursor } = await changelog.list({ limit: 10 });
  */
 declare function createChangelogClient(options: ChangelogClientOptions): ChangelogClient;
@@ -213,11 +256,12 @@ interface SeenTracker {
 /** The browser's `localStorage`, or null (server rendering, privacy mode). */
 declare function browserStorage(): SeenStorage | null;
 /**
- * A {@link SeenTracker} for one workspace. Uses the key
- * `sd-changelog-seen:<workspace>` — the same one the SolutionDesk widget uses,
- * so a visitor who opened either sees no badge in the other.
+ * A {@link SeenTracker} for one workspace's product. Uses the key
+ * `sd-changelog-seen:<workspace>` (default product) or
+ * `sd-changelog-seen:<workspace>:<product>` — the same ones the SolutionDesk
+ * widget uses, so a visitor who opened either sees no badge in the other.
  */
-declare function createSeenTracker(workspace: string, storage?: SeenStorage | null): SeenTracker;
+declare function createSeenTracker(workspace: string, storage?: SeenStorage | null, product?: string): SeenTracker;
 type ChangelogLocale = "de" | "en";
 /** The category names the hosted page uses, for your own UI. */
 declare const CATEGORY_LABELS: Record<ChangelogLocale, Record<ChangelogCategory, string>>;
@@ -226,4 +270,4 @@ declare const CATEGORY_COLORS: Record<ChangelogCategory, string>;
 /** A category's name in German (`de*`) or English (everything else). */
 declare function categoryLabel(category: ChangelogCategory, locale?: string): string;
 
-export { type BaseClientOptions, CATEGORY_COLORS, CATEGORY_LABELS, type CachedResponse, type ChangelogCategory, type ChangelogClient, type ChangelogClientOptions, type ChangelogLocale, type ChangelogWidgetPosition, DEFAULT_BASE_URL, type EtagCache, type FetchInitLike, type FetchLike, type FetchResponseLike, type ListEntriesParams, type PublicChangelogEntry, type PublicChangelogEntryPayload, type PublicChangelogPayload, type RequestOptions, type SeenStorage, type SeenTracker, SolutionDeskError, browserStorage, categoryLabel, createChangelogClient, createMemoryEtagCache, createSeenTracker };
+export { type BaseClientOptions, CATEGORY_COLORS, CATEGORY_LABELS, type CachedResponse, type ChangelogCategory, type ChangelogClient, type ChangelogClientOptions, type ChangelogLocale, type ChangelogWidgetPosition, DEFAULT_BASE_URL, type EtagCache, type FetchInitLike, type FetchLike, type FetchResponseLike, type ListEntriesParams, type PublicChangelogEntry, type PublicChangelogEntryPayload, type PublicChangelogPayload, type PublicChangelogProduct, type PublicChangelogProductsPayload, type RequestOptions, type SeenStorage, type SeenTracker, SolutionDeskError, browserStorage, categoryLabel, createChangelogClient, createMemoryEtagCache, createSeenTracker };

package/dist/index.js

@@ -164,8 +164,10 @@ function required(value, name) {
 // src/client.ts
 function createChangelogClient(options) {
   const workspace = required(options.workspace, "workspace");
+  const product = options.product?.trim() || void 0;
   const http = createHttp(options);
-  const base = `/changelog/${seg(workspace)}`;
+  const root = `/changelog/${seg(workspace)}`;
+  const base = product ? `${root}/${seg(product)}` : root;
   const list = (params = {}, requestOptions) => http.request({
     method: "GET",
     path: base,
@@ -185,12 +187,18 @@ function createChangelogClient(options) {
   }
   return {
     workspace,
+    product,
     list,
     allEntries,
     getEntry: (slug, requestOptions) => http.request({
       method: "GET",
       path: `${base}/entries/${seg(required(slug, "slug"))}`,
       options: requestOptions
+    }),
+    listProducts: (requestOptions) => http.request({
+      method: "GET",
+      path: `${root}/products`,
+      options: requestOptions
     })
   };
 }
@@ -204,8 +212,8 @@ function browserStorage() {
     return null;
   }
 }
-function createSeenTracker(workspace, storage = browserStorage()) {
-  const key = `sd-changelog-seen:${workspace.toLowerCase()}`;
+function createSeenTracker(workspace, storage = browserStorage(), product) {
+  const key = `sd-changelog-seen:${workspace.toLowerCase()}${product ? `:${product.toLowerCase()}` : ""}`;
   const lastSeen = () => {
     try {
       return storage?.getItem(key) ?? null;

package/dist/react.cjs

@@ -16,8 +16,8 @@ function browserStorage() {
     return null;
   }
 }
-function createSeenTracker(workspace, storage = browserStorage()) {
-  const key = `sd-changelog-seen:${workspace.toLowerCase()}`;
+function createSeenTracker(workspace, storage = browserStorage(), product) {
+  const key = `sd-changelog-seen:${workspace.toLowerCase()}${product ? `:${product.toLowerCase()}` : ""}`;
   const lastSeen = () => {
     try {
       return storage?.getItem(key) ?? null;
@@ -210,8 +210,10 @@ function required(value, name) {
 // src/client.ts
 function createChangelogClient(options) {
   const workspace = required(options.workspace, "workspace");
+  const product = options.product?.trim() || void 0;
   const http = createHttp(options);
-  const base = `/changelog/${seg(workspace)}`;
+  const root = `/changelog/${seg(workspace)}`;
+  const base = product ? `${root}/${seg(product)}` : root;
   const list = (params = {}, requestOptions) => http.request({
     method: "GET",
     path: base,
@@ -231,34 +233,49 @@ function createChangelogClient(options) {
   }
   return {
     workspace,
+    product,
     list,
     allEntries,
     getEntry: (slug, requestOptions) => http.request({
       method: "GET",
       path: `${base}/entries/${seg(required(slug, "slug"))}`,
       options: requestOptions
+    }),
+    listProducts: (requestOptions) => http.request({
+      method: "GET",
+      path: `${root}/products`,
+      options: requestOptions
     })
   };
 }
 
 // src/react/use-changelog.ts
 function useChangelog(options) {
-  const { workspace, client: given, limit = 10, category, trackSeen = true, initialData } = options;
+  const {
+    workspace,
+    product,
+    client: given,
+    limit = 10,
+    category,
+    trackSeen = true,
+    initialData
+  } = options;
   const { baseUrl, fetch: fetchImpl, headers, etagCache } = options;
   const headersKey = JSON.stringify(headers ?? {});
   const client = react.useMemo(
     () => given ?? createChangelogClient({
       workspace,
+      product,
       baseUrl,
       fetch: fetchImpl,
       headers: JSON.parse(headersKey),
       etagCache
     }),
-    [given, workspace, baseUrl, fetchImpl, headersKey, etagCache]
+    [given, workspace, product, baseUrl, fetchImpl, headersKey, etagCache]
   );
   const tracker = react.useMemo(
-    () => trackSeen ? createSeenTracker(workspace, options.storage) : null,
-    [trackSeen, workspace, options.storage]
+    () => trackSeen ? createSeenTracker(workspace, options.storage, given?.product ?? product) : null,
+    [trackSeen, workspace, options.storage, given, product]
   );
   const [data, setData] = react.useState(initialData ?? null);
   const [entries, setEntries] = react.useState(initialData?.entries ?? []);
@@ -364,11 +381,25 @@ function ChangelogEntryView({
   return /* @__PURE__ */ jsxRuntime.jsxs("article", { "data-sd-changelog-entry": "", "data-category": entry.category, className: classNames.entry, children: [
     /* @__PURE__ */ jsxRuntime.jsxs("div", { "data-sd-changelog-meta": "", className: classNames.meta, children: [
       /* @__PURE__ */ jsxRuntime.jsx("time", { dateTime: entry.publishedAt, className: classNames.date, children: formatChangelogDate(entry.publishedAt, locale) }),
-      /* @__PURE__ */ jsxRuntime.jsx("span", { "data-sd-changelog-category": entry.category, className: classNames.category, children: categoryLabel(entry.category, locale) })
+      /* @__PURE__ */ jsxRuntime.jsx("span", { "data-sd-changelog-category": entry.category, className: classNames.category, children: categoryLabel(entry.category, locale) }),
+      entry.releaseVersion ? /* @__PURE__ */ jsxRuntime.jsxs("span", { "data-sd-changelog-version": "", className: classNames.version, children: [
+        "Version ",
+        entry.releaseVersion
+      ] }) : null
     ] }),
     /* @__PURE__ */ jsxRuntime.jsx(Title, { className: classNames.title, children: /* @__PURE__ */ jsxRuntime.jsx("a", { href: entry.url, children: entry.title }) }),
     entry.summary ? /* @__PURE__ */ jsxRuntime.jsx("p", { className: classNames.summary, children: entry.summary }) : null,
-    showBody ? /* @__PURE__ */ jsxRuntime.jsx(ChangelogEntryBody, { html: entry.html, className: classNames.body }) : null
+    showBody ? /* @__PURE__ */ jsxRuntime.jsx(ChangelogEntryBody, { html: entry.html, className: classNames.body }) : null,
+    entry.downloadUrl ? /* @__PURE__ */ jsxRuntime.jsx(
+      "a",
+      {
+        href: entry.downloadUrl,
+        rel: "noopener",
+        "data-sd-changelog-download": "",
+        className: classNames.download,
+        children: locale.toLowerCase().startsWith("de") ? "Herunterladen" : "Download"
+      }
+    ) : null
   ] });
 }
 function ChangelogFeed(props) {

package/dist/react.d.cts

@@ -15,20 +15,48 @@ interface PublicChangelogEntry {
     /** One or two sentences — what a "What's new" panel shows. May be empty. */
     summary: string;
     category: ChangelogCategory;
+    /** The release this change ships in (`2.3.0`); empty when it isn't tied to one. */
+    releaseVersion: string;
+    /** Where the release can be downloaded (an app store page, GitHub Releases …), or null. */
+    downloadUrl: string | null;
     /** ISO 8601. The list is sorted by it, newest first. */
     publishedAt: string;
     /** The details as the team wrote them (Markdown). */
     markdown: string;
     /**
      * The details as safe HTML: raw HTML in the text is escaped, links are only
-     * http(s)/mailto/relative, images only from https addresses. Ready for
-     * `innerHTML` / `dangerouslySetInnerHTML`. Empty when there are no details.
+     * http(s)/mailto/relative, images only the ones uploaded to the entry (with
+     * `srcset`). Ready for `innerHTML` / `dangerouslySetInnerHTML`. Empty when
+     * there are no details.
      */
     html: string;
     /** The entry on the workspace's hosted changelog page. */
     url: string;
 }
-/** `GET /v1/changelog/{workspace}` — settings and one page of entries. */
+/** A product with its own changelog. */
+interface PublicChangelogProduct {
+    name: string;
+    slug: string;
+    /** One sentence about the product. May be empty. */
+    description: string;
+    /** The product's hosted changelog page. */
+    pageUrl: string;
+    /** The default product: addresses without a product show this one. */
+    isDefault: boolean;
+}
+/** `GET /v1/changelog/{workspace}/products` — every product, the default first. */
+interface PublicChangelogProductsPayload {
+    workspace: {
+        name: string;
+        slug: string;
+        logoUrl: string | null;
+    };
+    products: PublicChangelogProduct[];
+}
+/**
+ * `GET /v1/changelog/{workspace}/{product}` — a product's settings and one
+ * page of its entries (`GET /v1/changelog/{workspace}`: the default product).
+ */
 interface PublicChangelogPayload {
     /** The workspace as the hosted page shows it; `logoUrl` is relative to the API. */
     workspace: {
@@ -36,6 +64,8 @@ interface PublicChangelogPayload {
         slug: string;
         logoUrl: string | null;
     };
+    /** The product these entries belong to. */
+    product: PublicChangelogProduct;
     /** The heading the team chose; empty ⇒ use your own ("What's new"). */
     title: string;
     /** The team's settings for the "What's new" button (empty label ⇒ your own). */
@@ -43,14 +73,16 @@ interface PublicChangelogPayload {
         label: string;
         position: ChangelogWidgetPosition;
     };
-    /** The hosted changelog page. */
+    /** The product's hosted changelog page. */
     pageUrl: string;
     entries: PublicChangelogEntry[];
     /** Pass as `cursor` for the next page; null on the last one. */
     nextCursor: string | null;
 }
-/** `GET /v1/changelog/{workspace}/entries/{slug}`. */
+/** `GET /v1/changelog/{workspace}/{product}/entries/{slug}`. */
 interface PublicChangelogEntryPayload {
+    /** The product whose changelog shows the entry. */
+    product: PublicChangelogProduct;
     entry: PublicChangelogEntry;
 }
 
@@ -122,6 +154,11 @@ interface RequestOptions {
 interface ChangelogClientOptions extends BaseClientOptions {
     /** Your workspace's slug — the `acme` in `https://api.solutiondesk.io/v1/changelog/acme`. */
     workspace: string;
+    /**
+     * The product whose changelog to read (its web address, e.g. `acme-mobile`).
+     * Without it, the workspace's default product.
+     */
+    product?: string;
 }
 interface ListEntriesParams {
     /** Only entries of this category. */
@@ -134,19 +171,25 @@ interface ListEntriesParams {
 interface ChangelogClient {
     /** The workspace this client reads. */
     readonly workspace: string;
+    /** The product this client reads, or undefined for the default product. */
+    readonly product: string | undefined;
     /**
-     * The team's settings and one page of published entries, newest first
-     * (`GET /v1/changelog/{workspace}`). Throws a `SolutionDeskError` with status
-     * 404 when the workspace doesn't exist or its changelog is turned off.
+     * The product's settings and one page of its published entries, newest first
+     * (`GET /v1/changelog/{workspace}/{product}`). Throws a `SolutionDeskError`
+     * with status 404 when the workspace or product doesn't exist or the
+     * changelog is turned off.
      */
     list(params?: ListEntriesParams, options?: RequestOptions): Promise<PublicChangelogPayload>;
     /** Every published entry, page by page — e.g. for a sitemap, an RSS feed or a static build. */
     allEntries(params?: Omit<ListEntriesParams, "cursor">, options?: RequestOptions): AsyncGenerator<PublicChangelogEntry, void, undefined>;
     /**
-     * One published entry (`GET /v1/changelog/{workspace}/entries/{slug}`).
-     * Throws a `SolutionDeskError` with status 404 for an unknown or unpublished entry.
+     * One published entry of the product (`…/{product}/entries/{slug}`; without
+     * a product, of any product). Throws a `SolutionDeskError` with status 404
+     * for an unknown or unpublished entry.
      */
     getEntry(slug: string, options?: RequestOptions): Promise<PublicChangelogEntryPayload>;
+    /** Every product of the workspace, the default first (`GET /v1/changelog/{workspace}/products`). */
+    listProducts(options?: RequestOptions): Promise<PublicChangelogProductsPayload>;
 }
 
 /** Where "last seen" is kept — `window.localStorage`, `sessionStorage` or your own. */
@@ -158,6 +201,8 @@ interface SeenStorage {
 interface UseChangelogOptions extends Partial<Omit<ChangelogClientOptions, "workspace">> {
     /** Your workspace's slug. */
     workspace: string;
+    /** The product whose changelog to show (its web address); else the default product. */
+    product?: string;
     /** Use this client instead of making one (e.g. one shared by your whole app). */
     client?: ChangelogClient;
     /** Entries per page (1–50, default 10). */
@@ -222,11 +267,18 @@ interface ChangelogEntryClassNames {
     meta?: string;
     date?: string;
     category?: string;
+    /** The release (`Version 2.3.0`). */
+    version?: string;
+    /** The download link. */
+    download?: string;
     title?: string;
     summary?: string;
     body?: string;
 }
-/** One entry: date, category, title (linking to the hosted page), summary and details. */
+/**
+ * One entry: date, category, release, title (linking to the hosted page),
+ * summary, details and the download link.
+ */
 declare function ChangelogEntryView({ entry, locale, showBody, classNames, titleAs: Title, }: {
     entry: PublicChangelogEntry;
     /** Language of the date and the category name (`de*` → German, else English). */

package/dist/react.d.ts

@@ -15,20 +15,48 @@ interface PublicChangelogEntry {
     /** One or two sentences — what a "What's new" panel shows. May be empty. */
     summary: string;
     category: ChangelogCategory;
+    /** The release this change ships in (`2.3.0`); empty when it isn't tied to one. */
+    releaseVersion: string;
+    /** Where the release can be downloaded (an app store page, GitHub Releases …), or null. */
+    downloadUrl: string | null;
     /** ISO 8601. The list is sorted by it, newest first. */
     publishedAt: string;
     /** The details as the team wrote them (Markdown). */
     markdown: string;
     /**
      * The details as safe HTML: raw HTML in the text is escaped, links are only
-     * http(s)/mailto/relative, images only from https addresses. Ready for
-     * `innerHTML` / `dangerouslySetInnerHTML`. Empty when there are no details.
+     * http(s)/mailto/relative, images only the ones uploaded to the entry (with
+     * `srcset`). Ready for `innerHTML` / `dangerouslySetInnerHTML`. Empty when
+     * there are no details.
      */
     html: string;
     /** The entry on the workspace's hosted changelog page. */
     url: string;
 }
-/** `GET /v1/changelog/{workspace}` — settings and one page of entries. */
+/** A product with its own changelog. */
+interface PublicChangelogProduct {
+    name: string;
+    slug: string;
+    /** One sentence about the product. May be empty. */
+    description: string;
+    /** The product's hosted changelog page. */
+    pageUrl: string;
+    /** The default product: addresses without a product show this one. */
+    isDefault: boolean;
+}
+/** `GET /v1/changelog/{workspace}/products` — every product, the default first. */
+interface PublicChangelogProductsPayload {
+    workspace: {
+        name: string;
+        slug: string;
+        logoUrl: string | null;
+    };
+    products: PublicChangelogProduct[];
+}
+/**
+ * `GET /v1/changelog/{workspace}/{product}` — a product's settings and one
+ * page of its entries (`GET /v1/changelog/{workspace}`: the default product).
+ */
 interface PublicChangelogPayload {
     /** The workspace as the hosted page shows it; `logoUrl` is relative to the API. */
     workspace: {
@@ -36,6 +64,8 @@ interface PublicChangelogPayload {
         slug: string;
         logoUrl: string | null;
     };
+    /** The product these entries belong to. */
+    product: PublicChangelogProduct;
     /** The heading the team chose; empty ⇒ use your own ("What's new"). */
     title: string;
     /** The team's settings for the "What's new" button (empty label ⇒ your own). */
@@ -43,14 +73,16 @@ interface PublicChangelogPayload {
         label: string;
         position: ChangelogWidgetPosition;
     };
-    /** The hosted changelog page. */
+    /** The product's hosted changelog page. */
     pageUrl: string;
     entries: PublicChangelogEntry[];
     /** Pass as `cursor` for the next page; null on the last one. */
     nextCursor: string | null;
 }
-/** `GET /v1/changelog/{workspace}/entries/{slug}`. */
+/** `GET /v1/changelog/{workspace}/{product}/entries/{slug}`. */
 interface PublicChangelogEntryPayload {
+    /** The product whose changelog shows the entry. */
+    product: PublicChangelogProduct;
     entry: PublicChangelogEntry;
 }
 
@@ -122,6 +154,11 @@ interface RequestOptions {
 interface ChangelogClientOptions extends BaseClientOptions {
     /** Your workspace's slug — the `acme` in `https://api.solutiondesk.io/v1/changelog/acme`. */
     workspace: string;
+    /**
+     * The product whose changelog to read (its web address, e.g. `acme-mobile`).
+     * Without it, the workspace's default product.
+     */
+    product?: string;
 }
 interface ListEntriesParams {
     /** Only entries of this category. */
@@ -134,19 +171,25 @@ interface ListEntriesParams {
 interface ChangelogClient {
     /** The workspace this client reads. */
     readonly workspace: string;
+    /** The product this client reads, or undefined for the default product. */
+    readonly product: string | undefined;
     /**
-     * The team's settings and one page of published entries, newest first
-     * (`GET /v1/changelog/{workspace}`). Throws a `SolutionDeskError` with status
-     * 404 when the workspace doesn't exist or its changelog is turned off.
+     * The product's settings and one page of its published entries, newest first
+     * (`GET /v1/changelog/{workspace}/{product}`). Throws a `SolutionDeskError`
+     * with status 404 when the workspace or product doesn't exist or the
+     * changelog is turned off.
      */
     list(params?: ListEntriesParams, options?: RequestOptions): Promise<PublicChangelogPayload>;
     /** Every published entry, page by page — e.g. for a sitemap, an RSS feed or a static build. */
     allEntries(params?: Omit<ListEntriesParams, "cursor">, options?: RequestOptions): AsyncGenerator<PublicChangelogEntry, void, undefined>;
     /**
-     * One published entry (`GET /v1/changelog/{workspace}/entries/{slug}`).
-     * Throws a `SolutionDeskError` with status 404 for an unknown or unpublished entry.
+     * One published entry of the product (`…/{product}/entries/{slug}`; without
+     * a product, of any product). Throws a `SolutionDeskError` with status 404
+     * for an unknown or unpublished entry.
      */
     getEntry(slug: string, options?: RequestOptions): Promise<PublicChangelogEntryPayload>;
+    /** Every product of the workspace, the default first (`GET /v1/changelog/{workspace}/products`). */
+    listProducts(options?: RequestOptions): Promise<PublicChangelogProductsPayload>;
 }
 
 /** Where "last seen" is kept — `window.localStorage`, `sessionStorage` or your own. */
@@ -158,6 +201,8 @@ interface SeenStorage {
 interface UseChangelogOptions extends Partial<Omit<ChangelogClientOptions, "workspace">> {
     /** Your workspace's slug. */
     workspace: string;
+    /** The product whose changelog to show (its web address); else the default product. */
+    product?: string;
     /** Use this client instead of making one (e.g. one shared by your whole app). */
     client?: ChangelogClient;
     /** Entries per page (1–50, default 10). */
@@ -222,11 +267,18 @@ interface ChangelogEntryClassNames {
     meta?: string;
     date?: string;
     category?: string;
+    /** The release (`Version 2.3.0`). */
+    version?: string;
+    /** The download link. */
+    download?: string;
     title?: string;
     summary?: string;
     body?: string;
 }
-/** One entry: date, category, title (linking to the hosted page), summary and details. */
+/**
+ * One entry: date, category, release, title (linking to the hosted page),
+ * summary, details and the download link.
+ */
 declare function ChangelogEntryView({ entry, locale, showBody, classNames, titleAs: Title, }: {
     entry: PublicChangelogEntry;
     /** Language of the date and the category name (`de*` → German, else English). */

package/dist/react.js

@@ -14,8 +14,8 @@ function browserStorage() {
     return null;
   }
 }
-function createSeenTracker(workspace, storage = browserStorage()) {
-  const key = `sd-changelog-seen:${workspace.toLowerCase()}`;
+function createSeenTracker(workspace, storage = browserStorage(), product) {
+  const key = `sd-changelog-seen:${workspace.toLowerCase()}${product ? `:${product.toLowerCase()}` : ""}`;
   const lastSeen = () => {
     try {
       return storage?.getItem(key) ?? null;
@@ -208,8 +208,10 @@ function required(value, name) {
 // src/client.ts
 function createChangelogClient(options) {
   const workspace = required(options.workspace, "workspace");
+  const product = options.product?.trim() || void 0;
   const http = createHttp(options);
-  const base = `/changelog/${seg(workspace)}`;
+  const root = `/changelog/${seg(workspace)}`;
+  const base = product ? `${root}/${seg(product)}` : root;
   const list = (params = {}, requestOptions) => http.request({
     method: "GET",
     path: base,
@@ -229,34 +231,49 @@ function createChangelogClient(options) {
   }
   return {
     workspace,
+    product,
     list,
     allEntries,
     getEntry: (slug, requestOptions) => http.request({
       method: "GET",
       path: `${base}/entries/${seg(required(slug, "slug"))}`,
       options: requestOptions
+    }),
+    listProducts: (requestOptions) => http.request({
+      method: "GET",
+      path: `${root}/products`,
+      options: requestOptions
     })
   };
 }
 
 // src/react/use-changelog.ts
 function useChangelog(options) {
-  const { workspace, client: given, limit = 10, category, trackSeen = true, initialData } = options;
+  const {
+    workspace,
+    product,
+    client: given,
+    limit = 10,
+    category,
+    trackSeen = true,
+    initialData
+  } = options;
   const { baseUrl, fetch: fetchImpl, headers, etagCache } = options;
   const headersKey = JSON.stringify(headers ?? {});
   const client = useMemo(
     () => given ?? createChangelogClient({
       workspace,
+      product,
       baseUrl,
       fetch: fetchImpl,
       headers: JSON.parse(headersKey),
       etagCache
     }),
-    [given, workspace, baseUrl, fetchImpl, headersKey, etagCache]
+    [given, workspace, product, baseUrl, fetchImpl, headersKey, etagCache]
   );
   const tracker = useMemo(
-    () => trackSeen ? createSeenTracker(workspace, options.storage) : null,
-    [trackSeen, workspace, options.storage]
+    () => trackSeen ? createSeenTracker(workspace, options.storage, given?.product ?? product) : null,
+    [trackSeen, workspace, options.storage, given, product]
   );
   const [data, setData] = useState(initialData ?? null);
   const [entries, setEntries] = useState(initialData?.entries ?? []);
@@ -362,11 +379,25 @@ function ChangelogEntryView({
   return /* @__PURE__ */ jsxs("article", { "data-sd-changelog-entry": "", "data-category": entry.category, className: classNames.entry, children: [
     /* @__PURE__ */ jsxs("div", { "data-sd-changelog-meta": "", className: classNames.meta, children: [
       /* @__PURE__ */ jsx("time", { dateTime: entry.publishedAt, className: classNames.date, children: formatChangelogDate(entry.publishedAt, locale) }),
-      /* @__PURE__ */ jsx("span", { "data-sd-changelog-category": entry.category, className: classNames.category, children: categoryLabel(entry.category, locale) })
+      /* @__PURE__ */ jsx("span", { "data-sd-changelog-category": entry.category, className: classNames.category, children: categoryLabel(entry.category, locale) }),
+      entry.releaseVersion ? /* @__PURE__ */ jsxs("span", { "data-sd-changelog-version": "", className: classNames.version, children: [
+        "Version ",
+        entry.releaseVersion
+      ] }) : null
     ] }),
     /* @__PURE__ */ jsx(Title, { className: classNames.title, children: /* @__PURE__ */ jsx("a", { href: entry.url, children: entry.title }) }),
     entry.summary ? /* @__PURE__ */ jsx("p", { className: classNames.summary, children: entry.summary }) : null,
-    showBody ? /* @__PURE__ */ jsx(ChangelogEntryBody, { html: entry.html, className: classNames.body }) : null
+    showBody ? /* @__PURE__ */ jsx(ChangelogEntryBody, { html: entry.html, className: classNames.body }) : null,
+    entry.downloadUrl ? /* @__PURE__ */ jsx(
+      "a",
+      {
+        href: entry.downloadUrl,
+        rel: "noopener",
+        "data-sd-changelog-download": "",
+        className: classNames.download,
+        children: locale.toLowerCase().startsWith("de") ? "Herunterladen" : "Download"
+      }
+    ) : null
   ] });
 }
 function ChangelogFeed(props) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solutiondesk/changelog",
-  "version": "1.19.0",
+  "version": "1.20.0",
   "description": "Typed, zero-dependency client for the SolutionDesk changelog, plus React hooks and unstyled components for a \"What's new\" feed.",
   "keywords": [
     "solutiondesk",