proteum 2.5.20 → 2.5.22

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "proteum",
 	"description": "LLM-first Opinionated Typescript Framework for web applications.",
-	"version": "2.5.20",
+	"version": "2.5.22",
 	"author": "Gaetan Le Gac (https://github.com/gaetanlegac)",
 	"repository": "git://github.com/gaetanlegac/proteum.git",
 	"license": "MIT",

package/server/services/router/response/page/jsonld.ts

@@ -3,26 +3,23 @@
 ----------------------------------*/
 
 /*----------------------------------
-- TYPES
+- DEPENDENCIES
 ----------------------------------*/
 
-type TJsonLdNode = { '@type'?: string | string[]; '@id'?: string; [key: string]: unknown };
+import type { Thing } from 'schema-dts';
+import type { TApplicationIdentityConfig } from '@common/applicationConfig';
 
-type TIdentity = {
-    name: string;
-    description: string;
-    locale: string;
-    author: { name: string; url: string };
-    web: { jsonld?: Record<string, unknown> };
-};
+/*----------------------------------
+- TYPES
+----------------------------------*/
 
 export type TDefaultJsonLdInput = {
     /** The nodes the page pushed itself, before the defaults are added. */
-    pageJsonLd: readonly TJsonLdNode[];
-    url: string;
-    title: string;
-    description: string;
-    identity: TIdentity;
+    pageJsonLd: readonly Thing[];
+    url: string | undefined;
+    title: string | undefined;
+    description: string | undefined;
+    identity: TApplicationIdentityConfig;
     resolveUrl: (path: string) => string;
 };
 
@@ -30,14 +27,40 @@ export type TDefaultJsonLdInput = {
 - HELPERS
 ----------------------------------*/
 
-const hasType = (node: TJsonLdNode, type: string): boolean =>
-    Array.isArray(node['@type']) ? node['@type'].includes(type) : node['@type'] === type;
+/**
+ * `WebPage` and the schema.org types that specialise it. A page that describes itself as an
+ * `AboutPage` or a `CollectionPage` has described its web page: the generic node beside it
+ * would be a second page for the same URL, exactly as beside a plain `WebPage`.
+ */
+const WEB_PAGE_TYPES: ReadonlySet<string> = new Set([
+    'WebPage',
+    'AboutPage',
+    'CheckoutPage',
+    'CollectionPage',
+    'ContactPage',
+    'FAQPage',
+    'ItemPage',
+    'MedicalWebPage',
+    'ProfilePage',
+    'QAPage',
+    'RealEstateListing',
+    'SearchResultsPage',
+]);
+
+const describesWebPage = (node: Thing): boolean => {
+    if (typeof node !== 'object' || node === null || !('@type' in node)) return false;
+
+    const declared: unknown = node['@type'];
+    return (Array.isArray(declared) ? declared : [declared]).some(
+        (type) => typeof type === 'string' && WEB_PAGE_TYPES.has(type),
+    );
+};
 
 /**
  * The publisher identity every page carries (`#organization`, `#website`) plus a generic
  * `WebPage` for pages that describe none themselves.
  *
- * A page that already pushed a `WebPage` keeps its own: a second node for the same URL
+ * A page that already pushed a `WebPage`, or one of its subtypes, keeps its own: a second node for the same URL
  * with another name and description reads as two contradictory pages to a consumer.
  * Empty `sameAs` and `potentialAction` arrays are left out for the same reason: they say
  * "no profiles" and "no actions" where the app said nothing. `identity.web.jsonld` can
@@ -50,8 +73,8 @@ export const buildDefaultJsonLd = ({
     description,
     identity,
     resolveUrl,
-}: TDefaultJsonLdInput): TJsonLdNode[] => {
-    const nodes: TJsonLdNode[] = [
+}: TDefaultJsonLdInput): Thing[] => {
+    const nodes: Thing[] = [
         {
             '@type': 'Organization',
             '@id': resolveUrl('/#organization'),
@@ -78,7 +101,7 @@ export const buildDefaultJsonLd = ({
         },
     ];
 
-    if (!pageJsonLd.some((node) => hasType(node, 'WebPage'))) {
+    if (!pageJsonLd.some(describesWebPage)) {
         nodes.push({
             '@type': 'WebPage',
             '@id': url,

package/tests/page-jsonld.test.cjs

@@ -19,7 +19,7 @@ const input = {
 };
 
 test('default JSON-LD adds a generic WebPage only when the page has none', () => {
-    const withoutPage = buildDefaultJsonLd({ ...input, pageJsonLd: [{ '@type': 'FAQPage' }] });
+    const withoutPage = buildDefaultJsonLd({ ...input, pageJsonLd: [{ '@type': 'BreadcrumbList' }] });
     assert.deepEqual(withoutPage.map((node) => node['@type']), ['Organization', 'WebSite', 'WebPage']);
     assert.equal(withoutPage[2]['@id'], 'https://example.test/pricing');
     assert.equal(withoutPage[2].name, 'Pricing');
@@ -32,6 +32,14 @@ test('default JSON-LD adds a generic WebPage only when the page has none', () =>
 
     const withTypedArray = buildDefaultJsonLd({ ...input, pageJsonLd: [{ '@type': ['WebPage', 'FAQPage'] }] });
     assert.deepEqual(withTypedArray.map((node) => node['@type']), ['Organization', 'WebSite']);
+
+    // Subtypes of WebPage count: an AboutPage or a CollectionPage has described the page.
+    for (const subtype of ['AboutPage', 'CollectionPage', 'FAQPage', 'ProfilePage']) {
+        const nodes = buildDefaultJsonLd({ ...input, pageJsonLd: [{ '@type': subtype }] });
+        assert.deepEqual(nodes.map((node) => node['@type']), ['Organization', 'WebSite'], subtype);
+    }
+    const unrelated = buildDefaultJsonLd({ ...input, pageJsonLd: [{ '@type': 'SoftwareApplication' }] });
+    assert.equal(unrelated.length, 3);
 });
 
 test('default JSON-LD emits no empty sameAs or potentialAction, and keeps identity additions', () => {