@favish/staffbase-utils 0.8.0 → 0.10.0

package/README.md

@@ -23,8 +23,10 @@ minimumReleaseAgeExclude:
 
 | Subpath | Exports |
 | --- | --- |
+| `@favish/staffbase-utils/api` | `fetchJson`, `fetchAllPaginated`, `ApiError` |
 | `@favish/staffbase-utils/log` | `logError`, `logWarn`, `logDebug`, `setLoggingEnabled` |
 | `@favish/staffbase-utils/dom` | `getDynamicClasses` |
+| `@favish/staffbase-utils/types` | `Channel`, `ChannelLink`, `ChannelLinkParameter`, `DropdownOption` (type-only) |
 
 More modules (`/env`, `/device`, `/html`, `/links`, `/widgets`) are added per the
 delivery roadmap; each is its own subpath so consumers only bundle what they import.

package/dist/api.cjs.js

@@ -0,0 +1,2 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=class extends Error{status;constructor(e,t){super(t),this.name=`ApiError`,this.status=e}},t=async(t,n)=>{let r=await fetch(t,{credentials:`include`,...n});if(!r.ok)throw new e(r.status,`API request failed with status: ${r.status}`);return await r.json()},n=50,r=1e3,i=async(e,i={})=>{let{mapItem:a,limit:o=n,includeDrafts:s=!1,maxPages:c=r,onError:l}=i,u=[],d=0,f=0;for(;f<c;){let n=(await t(`${e}${e.includes(`?`)?`&`:`?`}limit=${o}&offset=${d}${s?`&includeDrafts=true`:``}`)).data??[];if(n.length===0)break;let r=a?n.map(a).filter(e=>e!==null):n;if(u.push(...r),n.length<o)break;d+=o,f+=1}return f>=c&&l?.(`Pagination cap (${c} pages) reached for ${e}; results may be truncated.`),u};exports.ApiError=e,exports.fetchAllPaginated=i,exports.fetchJson=t;
+//# sourceMappingURL=api.cjs.js.map

package/dist/api.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.cjs.js","names":[],"sources":["../src/api/ApiError.ts","../src/api/fetchJson.ts","../src/api/fetchAllPaginated.ts"],"sourcesContent":["/**\n * Error thrown by the API layer when a request resolves with a non-2xx status.\n * Carries the HTTP status so callers can branch (e.g. distinguish 401/403 from\n * 5xx) instead of collapsing every failure into one generic message.\n */\nexport class ApiError extends Error {\n  public readonly status: number\n\n  /**\n   * Creates an ApiError carrying the failed response status.\n   * @param {number} status - The HTTP status code of the failed response.\n   * @param {string} message - A human-readable error message.\n   */\n  public constructor(status: number, message: string) {\n    super(message)\n    this.name = 'ApiError'\n    this.status = status\n  }\n}\n","import { ApiError } from './ApiError'\n\n/**\n * Fetches JSON from a URL using Staffbase session credentials.\n *\n * Throws {@link ApiError} (carrying the HTTP status) on a non-2xx response so\n * callers can branch on the status. Network/parse errors propagate as-is. This\n * helper does not log; the calling service layer owns error logging.\n * @template T The expected shape of the parsed JSON body.\n * @param {string} url - The API URL to fetch.\n * @param {RequestInit} [init] - Optional fetch overrides (merged after credentials).\n * @returns {Promise<T>} The parsed JSON body.\n * @throws {ApiError} When the response status is not ok.\n */\nexport const fetchJson = async <T>(\n  url: string,\n  init?: RequestInit,\n): Promise<T> => {\n  const response = await fetch(url, { credentials: 'include', ...init })\n\n  if (!response.ok) {\n    throw new ApiError(\n      response.status,\n      `API request failed with status: ${response.status}`,\n    )\n  }\n\n  return (await response.json()) as T\n}\n","import type { FetchAllPaginatedOptions } from '../types/api/FetchAllPaginatedOptions'\nimport { fetchJson } from './fetchJson'\n\nconst DEFAULT_LIMIT = 50\nconst DEFAULT_MAX_PAGES = 1000\n\n/**\n * Fetches every page of a Staffbase `{ data, total }` collection endpoint.\n *\n * Termination is driven by page contents (a short page ends the loop) rather\n * than the API's reported `total`, which avoids under-fetching when `total` is\n * under-reported. A `maxPages` cap bounds worst-case latency/memory; reaching it\n * invokes `onError` so the truncation is never silent.\n * @template TItem The mapped item type returned to the caller.\n * @template TSource The raw item type returned by the API before mapping.\n * @param {string} baseUrl - The base API URL (without limit/offset parameters).\n * @param {FetchAllPaginatedOptions<TItem, TSource>} [options] - Mapping and pagination options.\n * @returns {Promise<TItem[]>} All fetched (and optionally mapped) items.\n */\nexport const fetchAllPaginated = async <TItem, TSource = TItem>(\n  baseUrl: string,\n  options: FetchAllPaginatedOptions<TItem, TSource> = {},\n): Promise<TItem[]> => {\n  const {\n    mapItem,\n    limit = DEFAULT_LIMIT,\n    includeDrafts = false,\n    maxPages = DEFAULT_MAX_PAGES,\n    onError,\n  } = options\n\n  const results: TItem[] = []\n  let offset = 0\n  let page = 0\n\n  while (page < maxPages) {\n    const separator = baseUrl.includes('?') ? '&' : '?'\n    const draftsParam = includeDrafts ? '&includeDrafts=true' : ''\n    const url = `${baseUrl}${separator}limit=${limit}&offset=${offset}${draftsParam}`\n\n    const data = await fetchJson<{ data: TSource[]; total?: number }>(url)\n    const rawItems = data.data ?? []\n\n    if (rawItems.length === 0) break\n\n    const mapped = mapItem\n      ? rawItems.map(mapItem).filter((item): item is TItem => item !== null)\n      : (rawItems as unknown as TItem[])\n\n    results.push(...mapped)\n\n    // A short page means we reached the end of the collection.\n    if (rawItems.length < limit) break\n\n    offset += limit\n    page += 1\n  }\n\n  if (page >= maxPages) {\n    onError?.(\n      `Pagination cap (${maxPages} pages) reached for ${baseUrl}; results may be truncated.`,\n    )\n  }\n\n  return results\n}\n"],"mappings":"mEAKA,IAAa,EAAb,cAA8B,KAAM,CAClC,OAOA,YAAmB,EAAgB,EAAiB,CAClD,MAAM,CAAO,EACb,KAAK,KAAO,WACZ,KAAK,OAAS,CAChB,CACF,ECJa,EAAY,MACvB,EACA,IACe,CACf,IAAM,EAAW,MAAM,MAAM,EAAK,CAAE,YAAa,UAAW,GAAG,CAAK,CAAC,EAErE,GAAI,CAAC,EAAS,GACZ,MAAM,IAAI,EACR,EAAS,OACT,mCAAmC,EAAS,QAC9C,EAGF,OAAQ,MAAM,EAAS,KAAK,CAC9B,ECzBM,EAAgB,GAChB,EAAoB,IAeb,EAAoB,MAC/B,EACA,EAAoD,CAAC,IAChC,CACrB,GAAM,CACJ,UACA,QAAQ,EACR,gBAAgB,GAChB,WAAW,EACX,WACE,EAEE,EAAmB,CAAC,EACtB,EAAS,EACT,EAAO,EAEX,KAAO,EAAO,GAAU,CAMtB,IAAM,GAAW,MADE,EAA+C,GAFnD,IAFG,EAAQ,SAAS,GAAG,EAAI,IAAM,IAEb,QAAQ,EAAM,UAAU,IADvC,EAAgB,sBAAwB,IAGS,GAC/C,MAAQ,CAAC,EAE/B,GAAI,EAAS,SAAW,EAAG,MAE3B,IAAM,EAAS,EACX,EAAS,IAAI,CAAO,EAAE,OAAQ,GAAwB,IAAS,IAAI,EAClE,EAKL,GAHA,EAAQ,KAAK,GAAG,CAAM,EAGlB,EAAS,OAAS,EAAO,MAE7B,GAAU,EACV,GAAQ,CACV,CAQA,OANI,GAAQ,GACV,IACE,mBAAmB,EAAS,sBAAsB,EAAQ,4BAC5D,EAGK,CACT"}

package/dist/api.es.mjs

@@ -0,0 +1,28 @@
+//#region src/api/ApiError.ts
+var e = class extends Error {
+	status;
+	constructor(e, t) {
+		super(t), this.name = "ApiError", this.status = e;
+	}
+}, t = async (t, n) => {
+	let r = await fetch(t, {
+		credentials: "include",
+		...n
+	});
+	if (!r.ok) throw new e(r.status, `API request failed with status: ${r.status}`);
+	return await r.json();
+}, n = 50, r = 1e3, i = async (e, i = {}) => {
+	let { mapItem: a, limit: o = n, includeDrafts: s = !1, maxPages: c = r, onError: l } = i, u = [], d = 0, f = 0;
+	for (; f < c;) {
+		let n = (await t(`${e}${e.includes("?") ? "&" : "?"}limit=${o}&offset=${d}${s ? "&includeDrafts=true" : ""}`)).data ?? [];
+		if (n.length === 0) break;
+		let r = a ? n.map(a).filter((e) => e !== null) : n;
+		if (u.push(...r), n.length < o) break;
+		d += o, f += 1;
+	}
+	return f >= c && l?.(`Pagination cap (${c} pages) reached for ${e}; results may be truncated.`), u;
+};
+//#endregion
+export { e as ApiError, i as fetchAllPaginated, t as fetchJson };
+
+//# sourceMappingURL=api.es.mjs.map

package/dist/api.es.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.es.mjs","names":[],"sources":["../src/api/ApiError.ts","../src/api/fetchJson.ts","../src/api/fetchAllPaginated.ts"],"sourcesContent":["/**\n * Error thrown by the API layer when a request resolves with a non-2xx status.\n * Carries the HTTP status so callers can branch (e.g. distinguish 401/403 from\n * 5xx) instead of collapsing every failure into one generic message.\n */\nexport class ApiError extends Error {\n  public readonly status: number\n\n  /**\n   * Creates an ApiError carrying the failed response status.\n   * @param {number} status - The HTTP status code of the failed response.\n   * @param {string} message - A human-readable error message.\n   */\n  public constructor(status: number, message: string) {\n    super(message)\n    this.name = 'ApiError'\n    this.status = status\n  }\n}\n","import { ApiError } from './ApiError'\n\n/**\n * Fetches JSON from a URL using Staffbase session credentials.\n *\n * Throws {@link ApiError} (carrying the HTTP status) on a non-2xx response so\n * callers can branch on the status. Network/parse errors propagate as-is. This\n * helper does not log; the calling service layer owns error logging.\n * @template T The expected shape of the parsed JSON body.\n * @param {string} url - The API URL to fetch.\n * @param {RequestInit} [init] - Optional fetch overrides (merged after credentials).\n * @returns {Promise<T>} The parsed JSON body.\n * @throws {ApiError} When the response status is not ok.\n */\nexport const fetchJson = async <T>(\n  url: string,\n  init?: RequestInit,\n): Promise<T> => {\n  const response = await fetch(url, { credentials: 'include', ...init })\n\n  if (!response.ok) {\n    throw new ApiError(\n      response.status,\n      `API request failed with status: ${response.status}`,\n    )\n  }\n\n  return (await response.json()) as T\n}\n","import type { FetchAllPaginatedOptions } from '../types/api/FetchAllPaginatedOptions'\nimport { fetchJson } from './fetchJson'\n\nconst DEFAULT_LIMIT = 50\nconst DEFAULT_MAX_PAGES = 1000\n\n/**\n * Fetches every page of a Staffbase `{ data, total }` collection endpoint.\n *\n * Termination is driven by page contents (a short page ends the loop) rather\n * than the API's reported `total`, which avoids under-fetching when `total` is\n * under-reported. A `maxPages` cap bounds worst-case latency/memory; reaching it\n * invokes `onError` so the truncation is never silent.\n * @template TItem The mapped item type returned to the caller.\n * @template TSource The raw item type returned by the API before mapping.\n * @param {string} baseUrl - The base API URL (without limit/offset parameters).\n * @param {FetchAllPaginatedOptions<TItem, TSource>} [options] - Mapping and pagination options.\n * @returns {Promise<TItem[]>} All fetched (and optionally mapped) items.\n */\nexport const fetchAllPaginated = async <TItem, TSource = TItem>(\n  baseUrl: string,\n  options: FetchAllPaginatedOptions<TItem, TSource> = {},\n): Promise<TItem[]> => {\n  const {\n    mapItem,\n    limit = DEFAULT_LIMIT,\n    includeDrafts = false,\n    maxPages = DEFAULT_MAX_PAGES,\n    onError,\n  } = options\n\n  const results: TItem[] = []\n  let offset = 0\n  let page = 0\n\n  while (page < maxPages) {\n    const separator = baseUrl.includes('?') ? '&' : '?'\n    const draftsParam = includeDrafts ? '&includeDrafts=true' : ''\n    const url = `${baseUrl}${separator}limit=${limit}&offset=${offset}${draftsParam}`\n\n    const data = await fetchJson<{ data: TSource[]; total?: number }>(url)\n    const rawItems = data.data ?? []\n\n    if (rawItems.length === 0) break\n\n    const mapped = mapItem\n      ? rawItems.map(mapItem).filter((item): item is TItem => item !== null)\n      : (rawItems as unknown as TItem[])\n\n    results.push(...mapped)\n\n    // A short page means we reached the end of the collection.\n    if (rawItems.length < limit) break\n\n    offset += limit\n    page += 1\n  }\n\n  if (page >= maxPages) {\n    onError?.(\n      `Pagination cap (${maxPages} pages) reached for ${baseUrl}; results may be truncated.`,\n    )\n  }\n\n  return results\n}\n"],"mappings":";AAKA,IAAa,IAAb,cAA8B,MAAM;CAClC;CAOA,YAAmB,GAAgB,GAAiB;EAGlD,AAFA,MAAM,CAAO,GACb,KAAK,OAAO,YACZ,KAAK,SAAS;CAChB;AACF,GCJa,IAAY,OACvB,GACA,MACe;CACf,IAAM,IAAW,MAAM,MAAM,GAAK;EAAE,aAAa;EAAW,GAAG;CAAK,CAAC;CAErE,IAAI,CAAC,EAAS,IACZ,MAAM,IAAI,EACR,EAAS,QACT,mCAAmC,EAAS,QAC9C;CAGF,OAAQ,MAAM,EAAS,KAAK;AAC9B,GCzBM,IAAgB,IAChB,IAAoB,KAeb,IAAoB,OAC/B,GACA,IAAoD,CAAC,MAChC;CACrB,IAAM,EACJ,YACA,WAAQ,GACR,mBAAgB,IAChB,cAAW,GACX,eACE,GAEE,IAAmB,CAAC,GACtB,IAAS,GACT,IAAO;CAEX,OAAO,IAAO,IAAU;EAMtB,IAAM,KAAW,MADE,EAA+C,GAFnD,IAFG,EAAQ,SAAS,GAAG,IAAI,MAAM,IAEb,QAAQ,EAAM,UAAU,IADvC,IAAgB,wBAAwB,IAGS,GAC/C,QAAQ,CAAC;EAE/B,IAAI,EAAS,WAAW,GAAG;EAE3B,IAAM,IAAS,IACX,EAAS,IAAI,CAAO,EAAE,QAAQ,MAAwB,MAAS,IAAI,IAClE;EAKL,IAHA,EAAQ,KAAK,GAAG,CAAM,GAGlB,EAAS,SAAS,GAAO;EAG7B,AADA,KAAU,GACV,KAAQ;CACV;CAQA,OANI,KAAQ,KACV,IACE,mBAAmB,EAAS,sBAAsB,EAAQ,4BAC5D,GAGK;AACT"}

package/dist/src/api/ApiError.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Error thrown by the API layer when a request resolves with a non-2xx status.
+ * Carries the HTTP status so callers can branch (e.g. distinguish 401/403 from
+ * 5xx) instead of collapsing every failure into one generic message.
+ */
+export declare class ApiError extends Error {
+    readonly status: number;
+    /**
+     * Creates an ApiError carrying the failed response status.
+     * @param {number} status - The HTTP status code of the failed response.
+     * @param {string} message - A human-readable error message.
+     */
+    constructor(status: number, message: string);
+}
+//# sourceMappingURL=ApiError.d.ts.map

package/dist/src/api/ApiError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiError.d.ts","sourceRoot":"","sources":["../../../src/api/ApiError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,qBAAa,QAAS,SAAQ,KAAK;IACjC,SAAgB,MAAM,EAAE,MAAM,CAAA;IAE9B;;;;OAIG;gBACgB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAKnD"}

package/dist/src/api/fetchAllPaginated.d.ts

@@ -0,0 +1,16 @@
+import { FetchAllPaginatedOptions } from '../types/api/FetchAllPaginatedOptions';
+/**
+ * Fetches every page of a Staffbase `{ data, total }` collection endpoint.
+ *
+ * Termination is driven by page contents (a short page ends the loop) rather
+ * than the API's reported `total`, which avoids under-fetching when `total` is
+ * under-reported. A `maxPages` cap bounds worst-case latency/memory; reaching it
+ * invokes `onError` so the truncation is never silent.
+ * @template TItem The mapped item type returned to the caller.
+ * @template TSource The raw item type returned by the API before mapping.
+ * @param {string} baseUrl - The base API URL (without limit/offset parameters).
+ * @param {FetchAllPaginatedOptions<TItem, TSource>} [options] - Mapping and pagination options.
+ * @returns {Promise<TItem[]>} All fetched (and optionally mapped) items.
+ */
+export declare const fetchAllPaginated: <TItem, TSource = TItem>(baseUrl: string, options?: FetchAllPaginatedOptions<TItem, TSource>) => Promise<TItem[]>;
+//# sourceMappingURL=fetchAllPaginated.d.ts.map

package/dist/src/api/fetchAllPaginated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchAllPaginated.d.ts","sourceRoot":"","sources":["../../../src/api/fetchAllPaginated.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,uCAAuC,CAAA;AAMrF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,iBAAiB,GAAU,KAAK,EAAE,OAAO,GAAG,KAAK,EAC5D,SAAS,MAAM,EACf,UAAS,wBAAwB,CAAC,KAAK,EAAE,OAAO,CAAM,KACrD,OAAO,CAAC,KAAK,EAAE,CA2CjB,CAAA"}

package/dist/src/api/fetchJson.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Fetches JSON from a URL using Staffbase session credentials.
+ *
+ * Throws {@link ApiError} (carrying the HTTP status) on a non-2xx response so
+ * callers can branch on the status. Network/parse errors propagate as-is. This
+ * helper does not log; the calling service layer owns error logging.
+ * @template T The expected shape of the parsed JSON body.
+ * @param {string} url - The API URL to fetch.
+ * @param {RequestInit} [init] - Optional fetch overrides (merged after credentials).
+ * @returns {Promise<T>} The parsed JSON body.
+ * @throws {ApiError} When the response status is not ok.
+ */
+export declare const fetchJson: <T>(url: string, init?: RequestInit) => Promise<T>;
+//# sourceMappingURL=fetchJson.d.ts.map

package/dist/src/api/fetchJson.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchJson.d.ts","sourceRoot":"","sources":["../../../src/api/fetchJson.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,SAAS,GAAU,CAAC,EAC/B,KAAK,MAAM,EACX,OAAO,WAAW,KACjB,OAAO,CAAC,CAAC,CAWX,CAAA"}

package/dist/src/api/index.d.ts

@@ -0,0 +1,4 @@
+export { ApiError } from './ApiError';
+export { fetchAllPaginated } from './fetchAllPaginated';
+export { fetchJson } from './fetchJson';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA"}

package/dist/src/types/api/FetchAllPaginatedOptions.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Options for fetchAllPaginated.
+ * @template TItem The mapped item type returned to the caller.
+ * @template TSource The raw item type returned by the API before mapping.
+ */
+export interface FetchAllPaginatedOptions<TItem, TSource = TItem> {
+    /**
+     * Maps/filters each raw API item. Return null to drop an item. When omitted,
+     * raw items are returned unchanged (TSource is assumed assignable to TItem).
+     * @param {TSource} item - The raw item from the API page.
+     * @returns {TItem | null} The mapped item, or null to skip it.
+     */
+    mapItem?: (item: TSource) => TItem | null;
+    /** Page size requested per call (default 50). */
+    limit?: number;
+    /** When true, appends `includeDrafts=true` to each request URL. */
+    includeDrafts?: boolean;
+    /**
+     * Hard cap on the number of pages fetched (default 1000), a runaway backstop.
+     * Lower it to bound first-paint latency on very large collections.
+     */
+    maxPages?: number;
+    /**
+     * Called with a diagnostic message when the maxPages cap is hit (so truncation
+     * is never silent). Injected because the library does not log directly.
+     * @param {string} message - The truncation diagnostic message.
+     * @returns {void} Nothing.
+     */
+    onError?: (message: string) => void;
+}
+//# sourceMappingURL=FetchAllPaginatedOptions.d.ts.map

package/dist/src/types/api/FetchAllPaginatedOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetchAllPaginatedOptions.d.ts","sourceRoot":"","sources":["../../../../src/types/api/FetchAllPaginatedOptions.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK;IAC9D;;;;;OAKG;IACH,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,KAAK,GAAG,IAAI,CAAA;IACzC,iDAAiD;IACjD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,mEAAmE;IACnE,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;CACpC"}

package/dist/src/types/content/Channel.d.ts

@@ -0,0 +1,70 @@
+import { ChannelLink } from './ChannelLink';
+/**
+ * Partial shape of a Staffbase content channel as returned by the channels API.
+ *
+ * Shared verbatim by the alerts, unacknowledged-bulletins and global-content
+ * widgets. The smart-search widget consumes a different (search-API) channel
+ * shape and keeps its own type. Marked partial because the platform may add
+ * fields; only the documented subset the widgets rely on is typed here.
+ */
+export interface Channel {
+    pluginID: string;
+    menuFolderIDs: string[];
+    defaultMenuFolderId: string;
+    config: {
+        localization: Record<string, {
+            title: string;
+            description: string | null;
+        }>;
+        sidebarVisible: boolean;
+        showPageBackground: boolean;
+        showAdminActions: boolean;
+    };
+    availableInPublicArea: boolean;
+    contentType: string;
+    notificationChannelsAllowed: string[] | null;
+    notificationChannelsDefault: string[];
+    postCount: number;
+    id: string;
+    spaceID: string;
+    visibleInPublicArea: boolean;
+    displayAuthor: boolean;
+    acknowledgingAllowed: boolean;
+    commentingAllowed: boolean;
+    highlightingAllowed: boolean;
+    layout: {
+        primaryMedia: string;
+    };
+    likingAllowed: boolean;
+    sharingAllowed: boolean;
+    internalSharingAllowed: boolean;
+    externalSharingAllowed: boolean;
+    lastPostPublishedAt: string;
+    commentingEnabledDefault: boolean;
+    highlightingEnabledDefault: boolean;
+    likingEnabledDefault: boolean;
+    sharingEnabledDefault: boolean;
+    acknowledgingEnabledDefault: boolean;
+    internalSharingEnabledDefault: boolean;
+    externalSharingEnabledDefault: boolean;
+    published: string;
+    created: string;
+    entityType: string;
+    updated: string;
+    links: {
+        preview: ChannelLink;
+        create_post: ChannelLink;
+        move: ChannelLink;
+        accessors: ChannelLink;
+        available_news_pages: ChannelLink;
+        get_posts: ChannelLink;
+        menu_items: ChannelLink;
+        update: ChannelLink;
+        feeds: ChannelLink;
+        delete: ChannelLink;
+        users: ChannelLink;
+        update_news_pages: ChannelLink;
+    };
+    rights: string[];
+}
+//# sourceMappingURL=Channel.d.ts.map

package/dist/src/types/content/Channel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Channel.d.ts","sourceRoot":"","sources":["../../../../src/types/content/Channel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhD;;;;;;;GAOG;AACH,MAAM,WAAW,OAAO;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,MAAM,EAAE;QACN,YAAY,EAAE,MAAM,CAClB,MAAM,EACN;YACE,KAAK,EAAE,MAAM,CAAA;YACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;SAC3B,CACF,CAAA;QACD,cAAc,EAAE,OAAO,CAAA;QACvB,kBAAkB,EAAE,OAAO,CAAA;QAC3B,gBAAgB,EAAE,OAAO,CAAA;KAC1B,CAAA;IACD,qBAAqB,EAAE,OAAO,CAAA;IAC9B,WAAW,EAAE,MAAM,CAAA;IACnB,2BAA2B,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAC5C,2BAA2B,EAAE,MAAM,EAAE,CAAA;IACrC,SAAS,EAAE,MAAM,CAAA;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,mBAAmB,EAAE,OAAO,CAAA;IAC5B,aAAa,EAAE,OAAO,CAAA;IACtB,oBAAoB,EAAE,OAAO,CAAA;IAC7B,iBAAiB,EAAE,OAAO,CAAA;IAC1B,mBAAmB,EAAE,OAAO,CAAA;IAC5B,MAAM,EAAE;QACN,YAAY,EAAE,MAAM,CAAA;KACrB,CAAA;IACD,aAAa,EAAE,OAAO,CAAA;IACtB,cAAc,EAAE,OAAO,CAAA;IACvB,sBAAsB,EAAE,OAAO,CAAA;IAC/B,sBAAsB,EAAE,OAAO,CAAA;IAC/B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,wBAAwB,EAAE,OAAO,CAAA;IACjC,0BAA0B,EAAE,OAAO,CAAA;IACnC,oBAAoB,EAAE,OAAO,CAAA;IAC7B,qBAAqB,EAAE,OAAO,CAAA;IAC9B,2BAA2B,EAAE,OAAO,CAAA;IACpC,6BAA6B,EAAE,OAAO,CAAA;IACtC,6BAA6B,EAAE,OAAO,CAAA;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE;QACL,OAAO,EAAE,WAAW,CAAA;QACpB,WAAW,EAAE,WAAW,CAAA;QACxB,IAAI,EAAE,WAAW,CAAA;QACjB,SAAS,EAAE,WAAW,CAAA;QACtB,oBAAoB,EAAE,WAAW,CAAA;QACjC,SAAS,EAAE,WAAW,CAAA;QACtB,UAAU,EAAE,WAAW,CAAA;QACvB,MAAM,EAAE,WAAW,CAAA;QACnB,KAAK,EAAE,WAAW,CAAA;QAClB,MAAM,EAAE,WAAW,CAAA;QACnB,KAAK,EAAE,WAAW,CAAA;QAClB,iBAAiB,EAAE,WAAW,CAAA;KAC/B,CAAA;IACD,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB"}

package/dist/src/types/content/ChannelLink.d.ts

@@ -0,0 +1,12 @@
+import { ChannelLinkParameter } from './ChannelLinkParameter';
+/**
+ * A single HAL link on a channel (method + href, with optional parameter and
+ * form descriptors). Used for each entry of a channel's `links` map.
+ */
+export interface ChannelLink {
+    method: string;
+    href: string;
+    parameters?: Record<string, ChannelLinkParameter>;
+    form?: ChannelLinkParameter[];
+}
+//# sourceMappingURL=ChannelLink.d.ts.map

package/dist/src/types/content/ChannelLink.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChannelLink.d.ts","sourceRoot":"","sources":["../../../../src/types/content/ChannelLink.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAElE;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAA;IACjD,IAAI,CAAC,EAAE,oBAAoB,EAAE,CAAA;CAC9B"}

package/dist/src/types/content/ChannelLinkParameter.d.ts

@@ -0,0 +1,13 @@
+/**
+ * A single parameter descriptor on a channel HAL link (an entry in a link's
+ * `parameters` map or `form` array). Mirrors the Staffbase channels API; the
+ * alerts, unacknowledged-bulletins and global-content widgets share this shape.
+ */
+export interface ChannelLinkParameter {
+    type: string;
+    id: string;
+    format?: string;
+    value?: string | number;
+    required: boolean;
+}
+//# sourceMappingURL=ChannelLinkParameter.d.ts.map

package/dist/src/types/content/ChannelLinkParameter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChannelLinkParameter.d.ts","sourceRoot":"","sources":["../../../../src/types/content/ChannelLinkParameter.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,QAAQ,EAAE,OAAO,CAAA;CAClB"}

package/dist/src/types/content/DropdownOption.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Option shape for channel/article selector dropdowns.
+ *
+ * `spaceName` and `spaceId` are optional enrichment used by widgets that group
+ * options by space; widgets that do not group simply omit them. This is the
+ * superset of the alerts (id/title) and unacknowledged-bulletins (+space)
+ * variants.
+ */
+export interface DropdownOption {
+    id: string;
+    title: string;
+    /** Optional space name for display in selectors. */
+    spaceName?: string;
+    /** Optional space id for enrichment. */
+    spaceId?: string;
+}
+//# sourceMappingURL=DropdownOption.d.ts.map

package/dist/src/types/content/DropdownOption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DropdownOption.d.ts","sourceRoot":"","sources":["../../../../src/types/content/DropdownOption.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB"}

package/dist/src/types/content/index.d.ts

@@ -0,0 +1,5 @@
+export type { Channel } from './Channel';
+export type { ChannelLink } from './ChannelLink';
+export type { ChannelLinkParameter } from './ChannelLinkParameter';
+export type { DropdownOption } from './DropdownOption';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/types/content/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/types/content/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACxC,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAClE,YAAY,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA"}

package/dist/types.cjs.js

@@ -0,0 +1 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@favish/staffbase-utils",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "Shared internal/host utilities for Staffbase widgets",
   "author": "Favish <dev@favish.com>",
   "license": "UNLICENSED",
@@ -8,6 +8,11 @@
     "dist"
   ],
   "exports": {
+    "./api": {
+      "types": "./dist/src/api/index.d.ts",
+      "import": "./dist/api.es.mjs",
+      "require": "./dist/api.cjs.js"
+    },
     "./log": {
       "types": "./dist/src/log/index.d.ts",
       "import": "./dist/log.es.mjs",
@@ -42,6 +47,11 @@
       "types": "./dist/src/widgets/react/index.d.ts",
       "import": "./dist/widgets/react.es.mjs",
       "require": "./dist/widgets/react.cjs.js"
+    },
+    "./types": {
+      "types": "./dist/src/types/content/index.d.ts",
+      "import": "./dist/types.es.mjs",
+      "require": "./dist/types.cjs.js"
     }
   },
   "repository": {