@websline/cms-view-utils 1.7.0 → 1.7.2

package/package.json

@@ -1,42 +1,43 @@
 {
-  "name": "@websline/cms-view-utils",
-  "version": "1.7.0",
-  "type": "module",
-  "files": [
-    "src",
-    "dist"
-  ],
-  "exports": {
-    ".": "./src/index.js",
-    "./server": "./src/server.js",
-    "./components/*": "./src/components/*",
-    "./preview-bridge": "./dist/previewBridge.global.js",
-    "./edit-scroll": "./dist/editScroll.global.js",
-    "./dist/*": "./dist/*"
-  },
-  "dependencies": {
-    "jsonwebtoken": "^9.0.3",
-    "tailwind-merge": "^3.6.0"
-  },
-  "devDependencies": {
-    "@eslint/compat": "^2.1.0",
-    "@eslint/js": "^10.0.1",
-    "eslint": "^10.8.1",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-svelte": "^3.22.0",
-    "globals": "^17.10.0",
-    "prettier": "^3.9.6",
-    "prettier-plugin-svelte": "^4.1.1",
-    "prettier-plugin-tailwindcss": "^0.8.1",
-    "tsup": "^8.5.1"
-  },
-  "peerDependencies": {
-    "svelte": "^5.0.0"
-  },
-  "sideEffects": false,
-  "scripts": {
-    "build": "tsup",
-    "format": "prettier --write .",
-    "lint": "prettier --check . && eslint ."
-  }
-}
+	"name": "@websline/cms-view-utils",
+	"version": "1.7.2",
+	"type": "module",
+	"files": [
+		"src",
+		"dist"
+	],
+	"exports": {
+		".": "./src/index.js",
+		"./server": "./src/server.js",
+		"./components/*": "./src/components/*",
+		"./preview-bridge": "./dist/previewBridge.global.js",
+		"./edit-scroll": "./dist/editScroll.global.js",
+		"./dist/*": "./dist/*"
+	},
+	"dependencies": {
+		"jsonwebtoken": "^9.0.3",
+		"tailwind-merge": "^3.6.0"
+	},
+	"devDependencies": {
+		"@eslint/compat": "^2.1.0",
+		"@eslint/js": "^10.0.1",
+		"eslint": "^10.9.0",
+		"eslint-config-prettier": "^10.1.8",
+		"eslint-plugin-svelte": "^3.23.0",
+		"globals": "^17.11.0",
+		"prettier": "^3.9.6",
+		"prettier-plugin-svelte": "^4.1.1",
+		"prettier-plugin-tailwindcss": "^0.8.1",
+		"tsup": "^8.5.1"
+	},
+	"peerDependencies": {
+		"svelte": "^5.0.0"
+	},
+	"scripts": {
+		"build": "tsup",
+		"prepublishOnly": "pnpm build",
+		"format": "prettier --write .",
+		"lint": "prettier --check . && eslint ."
+	},
+	"sideEffects": false
+}

package/src/client/fetchBoard.js

@@ -1,3 +1,11 @@
+/**
+ * Fetch a single ABM board.
+ *
+ * @param {object} options
+ * @param {string} options.locale - Locale code, e.g. `"de"`.
+ * @param {string|number} options.boardId - ABM id of the board.
+ * @returns {Promise<object>} The board object.
+ */
 const fetchBoard = async ({ locale, boardId }) => {
 	const url = `/api/cms/api/public/abm-boards/${locale}/${boardId}`;
 

package/src/client/fetchBoards.js

@@ -1,3 +1,10 @@
+/**
+ * Fetch all ABM boards.
+ *
+ * @param {object} options
+ * @param {string} options.locale - Locale code, e.g. `"de"`.
+ * @returns {Promise<object[]>} The boards.
+ */
 const fetchBoards = async ({ locale }) => {
 	const url = `/api/cms/api/public/abm-boards/${locale}`;
 

package/src/client/fetchCollections.js

@@ -1,3 +1,13 @@
+/**
+ * Fetch the items of a collection, or a single item of it.
+ *
+ * @param {object} options
+ * @param {string} options.locale - Locale code, e.g. `"de"`.
+ * @param {string} options.identifier - Collection identifier as configured in the CMS, e.g. `"blog"`.
+ * @param {string} [options.itemUuid] - Return only this item, as a plain object instead of an array.
+ * @param {number} [options.limit] - Maximum number of items, counted from the start of the CMS order. Ignored together with `itemUuid`.
+ * @returns {Promise<object[]|object>} An array of items, or a single item when `itemUuid` is set.
+ */
 const fetchCollections = async ({ identifier, itemUuid, limit, locale }) => {
 	const params = new URLSearchParams();
 

package/src/client/fetchFaqs.js

@@ -1,3 +1,14 @@
+/**
+ * Fetch ABM FAQs.
+ *
+ * @param {object} options
+ * @param {string} options.locale - Locale code, e.g. `"de"`.
+ * @param {string|number} [options.excludeId] - ABM FAQ id to leave out, e.g. the FAQ already shown on the page.
+ * @param {string[]} [options.tags] - Keep only FAQs carrying at least one of these tags (OR, not AND).
+ * @param {string[]} [options.groups] - Keep only FAQs belonging to one of these group ids.
+ * @param {number} [options.limit] - Maximum number of FAQs, applied after the filters.
+ * @returns {Promise<object[]>} The matching FAQs.
+ */
 const fetchFaqs = async ({ excludeId, limit, locale, tags, groups }) => {
 	const params = new URLSearchParams();
 

package/src/client/fetchPageTeasers.js

@@ -0,0 +1,63 @@
+/**
+ * Fetch the teasers of the tenant's published pages, e.g. for a blog index or related-posts list.
+ *
+ * @param {object} options
+ * @param {string} options.locale - Locale code, e.g. `"de"`.
+ * @param {string} [options.excludePageUuid] - Page UUID to leave out, e.g. the page currently shown.
+ * @param {boolean} [options.isBlog] - `true` for blog pages only, `false` for non-blog pages only, omit for all.
+ * @param {string[]} [options.tags] - Keep only pages carrying at least one of these tag UUIDs (OR, not AND).
+ * @param {"newest"|"oldest"} [options.order] - Sort by publication date; defaults to `"newest"`.
+ * @param {number} [options.offset] - Number of teasers to skip, applied after all filters.
+ * @param {number} [options.limit] - Maximum number of teasers; omit for all — there is no default.
+ * @returns {Promise<object[]>} The teasers.
+ */
+const fetchPageTeasers = async ({
+	locale,
+	excludePageUuid,
+	isBlog,
+	tags,
+	order,
+	offset,
+	limit,
+}) => {
+	const params = new URLSearchParams();
+
+	if (excludePageUuid != null && excludePageUuid !== "") {
+		params.set("excludePageUuid", excludePageUuid);
+	}
+
+	// The API accepts exactly `true` or `false` — anything else answers 422,
+	// so only real booleans are forwarded.
+	if (isBlog === true || isBlog === false) {
+		params.set("isBlog", isBlog);
+	}
+
+	if (Array.isArray(tags)) {
+		for (const tag of tags) {
+			if (tag != null && tag !== "") {
+				params.append("tags", tag);
+			}
+		}
+	}
+
+	if (order != null && order !== "") {
+		params.set("order", order);
+	}
+
+	if (offset != null) {
+		params.set("offset", offset);
+	}
+
+	if (limit != null) {
+		params.set("limit", limit);
+	}
+
+	const query = params.toString();
+	const url = `/api/cms/api/public/page-teasers/${locale}${query ? `?${query}` : ""}`;
+
+	const response = await fetch(url, { method: "GET" });
+
+	return response.json();
+};
+
+export { fetchPageTeasers };

package/src/client/fetchRatings.js

@@ -0,0 +1,29 @@
+/**
+ * Fetch ABM guest reviews, newest first, page by page.
+ *
+ * @param {object} options
+ * @param {string} options.locale - Locale code, e.g. `"de"`.
+ * @param {number} [options.page] - 1-based page number. Invalid values fall back to 1.
+ * @param {number} [options.pageSize] - Reviews per page: 6, 9, 12, 15 or 18. Anything else falls back to 12.
+ * @returns {Promise<object>} `{ items, pagination }` — `pagination` carries `page`, `pages`, `pageSize` and `total`. A page past the end has empty `items`.
+ */
+const fetchRatings = async ({ locale, page, pageSize }) => {
+	const params = new URLSearchParams();
+
+	if (page != null) {
+		params.set("page", page);
+	}
+
+	if (pageSize != null) {
+		params.set("pageSize", pageSize);
+	}
+
+	const query = params.toString();
+	const url = `/api/cms/api/public/abm-ratings/${locale}${query ? `?${query}` : ""}`;
+
+	const response = await fetch(url, { method: "GET" });
+
+	return response.json();
+};
+
+export { fetchRatings };

package/src/client/fetchSimilarPackages.js

@@ -1,3 +1,12 @@
+/**
+ * Fetch ABM packages, typically for a "similar packages" section.
+ *
+ * @param {object} options
+ * @param {string} options.locale - Locale code, e.g. `"de"`.
+ * @param {string|number} [options.excludeId] - ABM package id to leave out, e.g. the package currently shown.
+ * @param {number} [options.limit] - Maximum number of packages to return.
+ * @returns {Promise<object[]>} The packages.
+ */
 const fetchSimilarPackages = async ({ excludeId, limit, locale }) => {
 	const params = new URLSearchParams();
 

package/src/client/fetchSimilarRooms.js

@@ -1,3 +1,12 @@
+/**
+ * Fetch ABM rooms, typically for a "similar rooms" section.
+ *
+ * @param {object} options
+ * @param {string} options.locale - Locale code, e.g. `"de"`.
+ * @param {string|number} [options.excludeId] - ABM room id to leave out, e.g. the room currently shown.
+ * @param {number} [options.limit] - Maximum number of rooms to return.
+ * @returns {Promise<object[]>} The rooms.
+ */
 const fetchSimilarRooms = async ({ excludeId, limit, locale }) => {
 	const params = new URLSearchParams();
 

package/src/index.js

@@ -5,6 +5,8 @@ export { fetchFaqs } from "./client/fetchFaqs.js";
 export { fetchCollections } from "./client/fetchCollections.js";
 export { fetchBoards } from "./client/fetchBoards.js";
 export { fetchBoard } from "./client/fetchBoard.js";
+export { fetchPageTeasers } from "./client/fetchPageTeasers.js";
+export { fetchRatings } from "./client/fetchRatings.js";
 
 export { default as AddBlockPlaceholder } from "./components/AddBlockPlaceholder.svelte";
 export { default as BlockWrapper } from "./components/BlockWrapper.svelte";