@paroicms/server 1.116.6 → 1.117.0

package/dist/rendering-payload/json-ld-payload.js

@@ -0,0 +1,146 @@
+import { toAbsoluteUrl } from "@paroicms/internal-server-lib";
+import { encodeLNodeId } from "@paroicms/public-anywhere-lib";
+import { type } from "arktype";
+import { getSiteFieldValue } from "../admin-backend/fields/load-fields.queries.js";
+import { getHandleOfSiteField } from "../common/media-handles.helpers.js";
+import { toMSourceMedia } from "../common/medias/to-media-values.js";
+import { truncExcerptToWord } from "../helpers/excerpt.helpers.js";
+import { loadOrFromRenderingCache } from "../liquidjs-tools/liquidjs-drop.js";
+import { getFeaturedImageOf } from "../rendered-site/helpers/medias.helpers.js";
+import { getUrlOfDocument } from "../rendered-site/page-route/make-url.js";
+import { getPublicBreadcrumb } from "./breadcrumb.queries.js";
+import { loadExcerpt } from "./excerpt.queries.js";
+import { loadPublicFieldValues } from "./field-values.js";
+import { makeImageAvailable, makeImageAvailableByHandle } from "./make-image-available.js";
+const StringOrUndefinedAT = type("string|undefined");
+const articleJsonLdTypes = new Set(["Article", "BlogPosting"]);
+export async function makeJsonLdPayload(renderingContext, documentType, docValues, options) {
+    const { siteContext } = renderingContext;
+    const graph = [];
+    const siteUrl = toAbsoluteUrl(siteContext, "/");
+    const excerpt = await loadOrFromRenderingCache(renderingContext, `excerpt:${encodeLNodeId(docValues)}:full`, () => loadExcerpt(siteContext, renderingContext.tracker, {
+        lNodeId: docValues,
+        fieldTypes: documentType.fields ?? [],
+    }));
+    const url = options.url ??
+        (await loadOrFromRenderingCache(renderingContext, `url:${encodeLNodeId(docValues)}`, () => loadUrlOfDocument(renderingContext, docValues)));
+    const siteTitle = await loadOrFromRenderingCache(renderingContext, `siteFields:${docValues.language}:title`, async () => {
+        const title = await getSiteFieldValue(siteContext, {
+            fieldName: "title",
+            language: docValues.language,
+            publishedOnly: true,
+        });
+        return StringOrUndefinedAT.assert(title);
+    });
+    const absoluteUrl = toAbsoluteUrl(siteContext, url);
+    const isArticleType = articleJsonLdTypes.has(documentType.jsonLdType ?? "");
+    const description = excerpt
+        ? truncExcerptToWord(excerpt, 160)
+        : docValues.metaDescription
+            ? truncExcerptToWord(docValues.metaDescription, 160)
+            : undefined;
+    const pageEntity = {
+        "@type": documentType.jsonLdType ?? "WebPage",
+        "@id": `${absoluteUrl}/#webpage`,
+        url: absoluteUrl,
+        inLanguage: docValues.language,
+        isPartOf: { "@id": `${siteUrl}#website` },
+    };
+    if (isArticleType) {
+        pageEntity.headline = docValues.title;
+    }
+    else {
+        pageEntity.name = docValues.title;
+    }
+    if (description)
+        pageEntity.description = description;
+    if (docValues.publishDate)
+        pageEntity.datePublished = docValues.publishDate;
+    if (docValues.updatedAt)
+        pageEntity.dateModified = docValues.updatedAt;
+    if (isArticleType) {
+        const featuredImageId = await loadOrFromRenderingCache(renderingContext, `featuredImage:${encodeLNodeId(docValues)}`, async () => (await getFeaturedImageOf(renderingContext, {
+            nodeId: docValues.nodeId,
+            documentType,
+        }))?.id);
+        if (featuredImageId !== undefined) {
+            const ogMedia = await siteContext.mediaStorage.getMedia({ mediaId: featuredImageId });
+            if (ogMedia?.kind === "image") {
+                const imageVariant = await makeImageAvailable(renderingContext, toMSourceMedia(siteContext, ogMedia), { pixelRatio: 1, resizeRule: "1200x630" });
+                pageEntity.image = {
+                    "@type": "ImageObject",
+                    url: toAbsoluteUrl(siteContext, imageVariant.url),
+                    width: imageVariant.rawWidth,
+                    height: imageVariant.rawHeight,
+                };
+            }
+        }
+        const authorsField = documentType.fields?.find((f) => f.dataType === "labeling" && f.storedAs === "labeling" && f.taxonomy === "author");
+        if (authorsField) {
+            const fieldValues = await loadPublicFieldValues(renderingContext, {
+                typeName: docValues.type,
+                lNodeId: docValues,
+                fieldNames: [authorsField.name],
+            });
+            const authorTerms = fieldValues && typeof fieldValues === "object"
+                ? fieldValues[authorsField.name]
+                : undefined;
+            if (authorTerms && Array.isArray(authorTerms) && authorTerms.length > 0) {
+                pageEntity.author = authorTerms.map((term) => {
+                    const entry = { "@type": "Person", name: term.title };
+                    if (term.url)
+                        entry.url = toAbsoluteUrl(siteContext, term.url);
+                    return entry;
+                });
+            }
+        }
+        const publisher = { "@type": "Organization", name: siteTitle };
+        const logoHandle = getHandleOfSiteField(siteContext, { fieldName: "logo" });
+        const logoImage = await makeImageAvailableByHandle(renderingContext, { handle: logoHandle }, { resizeRule: "x112x", pixelRatio: 1 });
+        if (logoImage) {
+            publisher.logo = {
+                "@type": "ImageObject",
+                url: toAbsoluteUrl(siteContext, logoImage.url),
+                width: logoImage.rawWidth,
+                height: logoImage.rawHeight,
+            };
+        }
+        pageEntity.publisher = publisher;
+    }
+    graph.push(pageEntity);
+    const breadcrumbItems = await loadOrFromRenderingCache(renderingContext, `breadcrumb:${encodeLNodeId(docValues)}`, () => getPublicBreadcrumb(renderingContext, docValues));
+    const listItems = breadcrumbItems
+        .filter((item) => item.url)
+        .map((item, index) => ({
+        "@type": "ListItem",
+        position: index + 1,
+        name: item.title ?? "",
+        item: toAbsoluteUrl(siteContext, item.url),
+    }));
+    if (listItems.length > 0) {
+        graph.push({
+            "@type": "BreadcrumbList",
+            itemListElement: listItems,
+        });
+    }
+    if (documentType.typeName === "home") {
+        graph.push({
+            "@type": "WebSite",
+            "@id": `${siteUrl}#website`,
+            name: siteTitle,
+            url: siteUrl,
+            inLanguage: docValues.language,
+        });
+    }
+    return graph;
+}
+async function loadUrlOfDocument(renderingContext, documentId) {
+    const { siteContext } = renderingContext;
+    const { url, dependencyKeys } = await getUrlOfDocument(siteContext, renderingContext.tracker, documentId, {
+        returnUrlDependencyKeys: true,
+        forPreview: renderingContext.isPreview,
+    });
+    renderingContext.addDependencyKey(...dependencyKeys);
+    return url;
+}
+//# sourceMappingURL=json-ld-payload.js.map

package/dist/rendering-payload/json-ld-payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-ld-payload.js","sourceRoot":"","sources":["../../src/rendering-payload/json-ld-payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAiC,MAAM,+BAA+B,CAAC;AAO7F,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,gDAAgD,CAAC;AACnF,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAE9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AAChF,OAAO,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAE3F,MAAM,mBAAmB,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC;AAErD,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC;AAE/D,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,gBAAkC,EAClC,YAA4B,EAC5B,SAAsB,EACtB,OAAyB;IAEzB,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,CAAC;IACzC,MAAM,KAAK,GAAU,EAAE,CAAC;IAExB,MAAM,OAAO,GAAG,aAAa,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IAGhD,MAAM,OAAO,GAAG,MAAM,wBAAwB,CAC5C,gBAAgB,EAChB,WAAW,aAAa,CAAC,SAAS,CAAC,OAAO,EAC1C,GAAG,EAAE,CACH,WAAW,CAAC,WAAW,EAAE,gBAAgB,CAAC,OAAO,EAAE;QACjD,OAAO,EAAE,SAAS;QAClB,UAAU,EAAE,YAAY,CAAC,MAAM,IAAI,EAAE;KACtC,CAAC,CACL,CAAC;IAEF,MAAM,GAAG,GACP,OAAO,CAAC,GAAG;QACX,CAAC,MAAM,wBAAwB,CAAC,gBAAgB,EAAE,OAAO,aAAa,CAAC,SAAS,CAAC,EAAE,EAAE,GAAG,EAAE,CACxF,iBAAiB,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAC/C,CAAC,CAAC;IAEL,MAAM,SAAS,GAAG,MAAM,wBAAwB,CAC9C,gBAAgB,EAChB,cAAc,SAAS,CAAC,QAAQ,QAAQ,EACxC,KAAK,IAAI,EAAE;QACT,MAAM,KAAK,GAAG,MAAM,iBAAiB,CAAC,WAAW,EAAE;YACjD,SAAS,EAAE,OAAO;YAClB,QAAQ,EAAE,SAAS,CAAC,QAAQ;YAC5B,aAAa,EAAE,IAAI;SACpB,CAAC,CAAC;QACH,OAAO,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC,CACF,CAAC;IAEF,MAAM,WAAW,GAAG,aAAa,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IACpD,MAAM,aAAa,GAAG,kBAAkB,CAAC,GAAG,CAAC,YAAY,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;IAE5E,MAAM,WAAW,GAAG,OAAO;QACzB,CAAC,CAAC,kBAAkB,CAAC,OAAO,EAAE,GAAG,CAAC;QAClC,CAAC,CAAC,SAAS,CAAC,eAAe;YACzB,CAAC,CAAC,kBAAkB,CAAC,SAAS,CAAC,eAAe,EAAE,GAAG,CAAC;YACpD,CAAC,CAAC,SAAS,CAAC;IAGhB,MAAM,UAAU,GAAQ;QACtB,OAAO,EAAE,YAAY,CAAC,UAAU,IAAI,SAAS;QAC7C,KAAK,EAAE,GAAG,WAAW,WAAW;QAChC,GAAG,EAAE,WAAW;QAChB,UAAU,EAAE,SAAS,CAAC,QAAQ;QAC9B,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,UAAU,EAAE;KAC1C,CAAC;IAEF,IAAI,aAAa,EAAE,CAAC;QAClB,UAAU,CAAC,QAAQ,GAAG,SAAS,CAAC,KAAK,CAAC;IACxC,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC;IACpC,CAAC;IAED,IAAI,WAAW;QAAE,UAAU,CAAC,WAAW,GAAG,WAAW,CAAC;IACtD,IAAI,SAAS,CAAC,WAAW;QAAE,UAAU,CAAC,aAAa,GAAG,SAAS,CAAC,WAAW,CAAC;IAC5E,IAAI,SAAS,CAAC,SAAS;QAAE,UAAU,CAAC,YAAY,GAAG,SAAS,CAAC,SAAS,CAAC;IAGvE,IAAI,aAAa,EAAE,CAAC;QAClB,MAAM,eAAe,GAAG,MAAM,wBAAwB,CACpD,gBAAgB,EAChB,iBAAiB,aAAa,CAAC,SAAS,CAAC,EAAE,EAC3C,KAAK,IAAI,EAAE,CACT,CACE,MAAM,kBAAkB,CAAC,gBAAgB,EAAE;YACzC,MAAM,EAAE,SAAS,CAAC,MAAM;YACxB,YAAY;SACb,CAAC,CACH,EAAE,EAAE,CACR,CAAC;QAEF,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;YAClC,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;YACtF,IAAI,OAAO,EAAE,IAAI,KAAK,OAAO,EAAE,CAAC;gBAC9B,MAAM,YAAY,GAAG,MAAM,kBAAkB,CAC3C,gBAAgB,EAChB,cAAc,CAAC,WAAW,EAAE,OAAO,CAAC,EACpC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,CAC1C,CAAC;gBACF,UAAU,CAAC,KAAK,GAAG;oBACjB,OAAO,EAAE,aAAa;oBACtB,GAAG,EAAE,aAAa,CAAC,WAAW,EAAE,YAAY,CAAC,GAAG,CAAC;oBACjD,KAAK,EAAE,YAAY,CAAC,QAAQ;oBAC5B,MAAM,EAAE,YAAY,CAAC,SAAS;iBAC/B,CAAC;YACJ,CAAC;QACH,CAAC;QAGD,MAAM,YAAY,GAAG,YAAY,CAAC,MAAM,EAAE,IAAI,CAC5C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,UAAU,IAAI,CAAC,CAAC,QAAQ,KAAK,UAAU,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ,CACzF,CAAC;QACF,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,WAAW,GAAG,MAAM,qBAAqB,CAAC,gBAAgB,EAAE;gBAChE,QAAQ,EAAE,SAAS,CAAC,IAAI;gBACxB,OAAO,EAAE,SAAS;gBAClB,UAAU,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;aAChC,CAAC,CAAC;YACH,MAAM,WAAW,GACf,WAAW,IAAI,OAAO,WAAW,KAAK,QAAQ;gBAC5C,CAAC,CAAG,WAAmB,CAAC,YAAY,CAAC,IAAI,CAA0B;gBACnE,CAAC,CAAC,SAAS,CAAC;YAChB,IAAI,WAAW,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxE,UAAU,CAAC,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;oBAC3C,MAAM,KAAK,GAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;oBAC3D,IAAI,IAAI,CAAC,GAAG;wBAAE,KAAK,CAAC,GAAG,GAAG,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;oBAC/D,OAAO,KAAK,CAAC;gBACf,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAGD,MAAM,SAAS,GAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QACpE,MAAM,UAAU,GAAG,oBAAoB,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;QAC5E,MAAM,SAAS,GAAG,MAAM,0BAA0B,CAChD,gBAAgB,EAChB,EAAE,MAAM,EAAE,UAAU,EAAE,EACtB,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,EAAE,CACvC,CAAC;QACF,IAAI,SAAS,EAAE,CAAC;YACd,SAAS,CAAC,IAAI,GAAG;gBACf,OAAO,EAAE,aAAa;gBACtB,GAAG,EAAE,aAAa,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,CAAC;gBAC9C,KAAK,EAAE,SAAS,CAAC,QAAQ;gBACzB,MAAM,EAAE,SAAS,CAAC,SAAS;aAC5B,CAAC;QACJ,CAAC;QACD,UAAU,CAAC,SAAS,GAAG,SAAS,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAGvB,MAAM,eAAe,GAAG,MAAM,wBAAwB,CACpD,gBAAgB,EAChB,cAAc,aAAa,CAAC,SAAS,CAAC,EAAE,EACxC,GAAG,EAAE,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,SAAS,CAAC,CACvD,CAAC;IAEF,MAAM,SAAS,GAAI,eAAsC;SACtD,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC;SAC1B,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QACrB,OAAO,EAAE,UAAU;QACnB,QAAQ,EAAE,KAAK,GAAG,CAAC;QACnB,IAAI,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;QACtB,IAAI,EAAE,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,GAAa,CAAC;KACrD,CAAC,CAAC,CAAC;IAEN,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzB,KAAK,CAAC,IAAI,CAAC;YACT,OAAO,EAAE,gBAAgB;YACzB,eAAe,EAAE,SAAS;SAC3B,CAAC,CAAC;IACL,CAAC;IAGD,IAAI,YAAY,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;QACrC,KAAK,CAAC,IAAI,CAAC;YACT,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,GAAG,OAAO,UAAU;YAC3B,IAAI,EAAE,SAAS;YACf,GAAG,EAAE,OAAO;YACZ,UAAU,EAAE,SAAS,CAAC,QAAQ;SAC/B,CAAC,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,KAAK,UAAU,iBAAiB,CAAC,gBAAkC,EAAE,UAAuB;IAC1F,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,CAAC;IACzC,MAAM,EAAE,GAAG,EAAE,cAAc,EAAE,GAAG,MAAM,gBAAgB,CACpD,WAAW,EACX,gBAAgB,CAAC,OAAO,EACxB,UAAU,EACV;QACE,uBAAuB,EAAE,IAAI;QAC7B,UAAU,EAAE,gBAAgB,CAAC,SAAS;KACvC,CACF,CAAC;IACF,gBAAgB,CAAC,gBAAgB,CAAC,GAAG,cAAc,CAAC,CAAC;IACrD,OAAO,GAAG,CAAC;AACb,CAAC"}