@krantho/api 0.0.0-stage → 1.0.1

package/dist/seo-compose.d.ts

@@ -0,0 +1,50 @@
+import type { KranthoConfig } from '@krantho/config';
+import type { PageStructure } from '@krantho/core';
+import type { DocumentMeta } from '@krantho/persistence';
+import type { SeoConfigData } from '@krantho/seo-shared';
+import type { SeoConfigReader } from './seo-config-snapshot.js';
+/** What composing a page's JSON-LD reads */
+export interface PageJsonLdInput {
+    collection: string;
+    slug: string;
+    /** Where the document renders (`documentPath()`); null when its collection has no pages */
+    path: string | null;
+    /** The document fields the graph describes */
+    fields: Record<string, unknown>;
+    /** Version metadata for system-derived properties (dates, author) */
+    documentMeta?: DocumentMeta | undefined;
+    metadata?: Record<string, Record<string, unknown>> | undefined;
+    /** The site's configuration: its identity, SEO definitions and readers */
+    config: KranthoConfig;
+    /** SEO configuration store; without one, the code-defined archetype applies */
+    seoConfigs?: SeoConfigReader | undefined;
+    /** The structure the page's template renders: its trail, its place in a sequence, its kind */
+    structure?: PageStructure | undefined;
+}
+/** The SEO configuration a page composes from: the site, its collection, its URL pattern and the document */
+export interface PageSeoConfig {
+    site: SeoConfigData | null;
+    effective: SeoConfigData;
+}
+/** Whether a route configuration's URL pattern (`/blog/*`, `/docs/**`) matches a page path */
+export declare function routeMatches(pattern: string, path: string): boolean;
+/**
+ * The SEO configuration a page composes from: the stored site scope, and the
+ * collection, URL-pattern and document scopes resolved into one — or, when
+ * nothing is configured for the page, the code-defined article archetype with
+ * no site entities. The page's graph and the editor's resolved values both
+ * start here. Rejects when `@krantho/seo` is not installed.
+ */
+export declare function pageSeoConfig(input: Pick<PageJsonLdInput, 'collection' | 'slug' | 'path' | 'seoConfigs' | 'metadata'>): Promise<PageSeoConfig>;
+/**
+ * Compose a page's JSON-LD graph from its SEO configuration (see
+ * `pageSeoConfig`) and the site's identity; a minimal `WebPage` when
+ * `@krantho/seo` is not installed. The SEO preview endpoint and
+ * server-rendered pages share it.
+ *
+ * Every URL in the graph is the document's page, so a document whose
+ * collection renders no pages gets an empty `@graph`: it has no page for
+ * Schema.org entities to describe.
+ */
+export declare function composePageJsonLd(input: PageJsonLdInput): Promise<Record<string, unknown>>;
+//# sourceMappingURL=seo-compose.d.ts.map

package/dist/seo-compose.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"seo-compose.d.ts","sourceRoot":"","sources":["../src/seo-compose.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAClD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAOxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAI/D,4CAA4C;AAC5C,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,2FAA2F;IAC3F,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,8CAA8C;IAC9C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC/B,qEAAqE;IACrE,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAA;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,CAAA;IAC9D,0EAA0E;IAC1E,MAAM,EAAE,aAAa,CAAA;IACrB,+EAA+E;IAC/E,UAAU,CAAC,EAAE,eAAe,GAAG,SAAS,CAAA;IACxC,8FAA8F;IAC9F,SAAS,CAAC,EAAE,aAAa,GAAG,SAAS,CAAA;CACtC;AAED,6GAA6G;AAC7G,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,aAAa,GAAG,IAAI,CAAA;IAC1B,SAAS,EAAE,aAAa,CAAA;CACzB;AAkBD,8FAA8F;AAC9F,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAEnE;AAeD;;;;;;GAMG;AACH,wBAAsB,aAAa,CACjC,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,UAAU,CAAC,GACvF,OAAO,CAAC,aAAa,CAAC,CAwBxB;AAED;;;;;;;;;GASG;AACH,wBAAsB,iBAAiB,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CA8BhG"}

package/dist/seo-compose.js

@@ -0,0 +1,104 @@
+import { buildSeoFieldMap, documentSeoConfig, documentSeoProperties, resolveSeoField, } from '@krantho/seo-shared';
+import { loadSeoModule } from './seo-loader.js';
+import { isSeoModuleMissing, loadSeo } from './seo-subsystem.js';
+const ROUTE_PREFIX = 'route:';
+/** A URL pattern as a regular expression: `**` stands for any rest of the path, `*` for one segment */
+function routePattern(pattern) {
+    const source = pattern
+        .split('**')
+        .map((part) => part
+        .split('*')
+        .map((literal) => literal.replace(/[.+?^${}()|[\]\\]/g, '\\$&'))
+        .join('[^/]+'))
+        .join('.*');
+    return new RegExp(`^${source}$`);
+}
+/** Whether a route configuration's URL pattern (`/blog/*`, `/docs/**`) matches a page path */
+export function routeMatches(pattern, path) {
+    return routePattern(pattern).test(path);
+}
+/** The configuration of the most specific URL pattern matching the path: the one with the most literal characters */
+async function routeConfig(seoConfigs, path) {
+    if (path === null)
+        return null;
+    const literal = (id) => id.replaceAll('*', '').length;
+    const matching = (await seoConfigs.listConfigs('route'))
+        .filter((stored) => routeMatches(stored.id.slice(ROUTE_PREFIX.length), path))
+        .sort((a, b) => literal(b.id) - literal(a.id));
+    return matching[0]?.config ?? null;
+}
+/**
+ * The SEO configuration a page composes from: the stored site scope, and the
+ * collection, URL-pattern and document scopes resolved into one — or, when
+ * nothing is configured for the page, the code-defined article archetype with
+ * no site entities. The page's graph and the editor's resolved values both
+ * start here. Rejects when `@krantho/seo` is not installed.
+ */
+export async function pageSeoConfig(input) {
+    const { resolveEffectiveConfig, blogPostArchetype } = await loadSeoModule();
+    const [siteRes, colRes, routeRes] = input.seoConfigs
+        ? await Promise.all([
+            input.seoConfigs.getConfig('site'),
+            input.seoConfigs.getConfig(`collection:${input.collection}`),
+            routeConfig(input.seoConfigs, input.path),
+        ])
+        : [null, null, null];
+    const site = siteRes?.config ?? null;
+    const document = documentSeoConfig(input.metadata ?? {});
+    const scopes = [site, colRes?.config, routeRes, document];
+    if (scopes.every((scope) => (scope?.entities.length ?? 0) === 0)) {
+        const entities = blogPostArchetype.schemas.map((type) => ({ '@type': type, properties: {} }));
+        return { site: null, effective: { entities } };
+    }
+    return {
+        site,
+        effective: resolveEffectiveConfig({
+            collection: colRes?.config ?? null,
+            route: routeRes,
+            document,
+        }),
+    };
+}
+/**
+ * Compose a page's JSON-LD graph from its SEO configuration (see
+ * `pageSeoConfig`) and the site's identity; a minimal `WebPage` when
+ * `@krantho/seo` is not installed. The SEO preview endpoint and
+ * server-rendered pages share it.
+ *
+ * Every URL in the graph is the document's page, so a document whose
+ * collection renders no pages gets an empty `@graph`: it has no page for
+ * Schema.org entities to describe.
+ */
+export async function composePageJsonLd(input) {
+    const { slug, path, fields, config } = input;
+    if (path === null)
+        return { '@context': 'https://schema.org', '@graph': [] };
+    try {
+        const seo = await loadSeo(config);
+        const page = await pageSeoConfig(input);
+        return {
+            ...seo.compose({
+                config: page.effective,
+                fields: { ...fields, ...documentSeoProperties(input.metadata ?? {}) },
+                path,
+                siteLevel: page.site,
+                ...(input.documentMeta ? { documentMeta: input.documentMeta } : {}),
+                structure: input.structure,
+            }),
+        };
+    }
+    catch (err) {
+        if (!isSeoModuleMissing(err))
+            throw err;
+    }
+    // @krantho/seo not available — minimal JSON-LD using the canonical field resolver.
+    const fieldMap = buildSeoFieldMap(Object.keys(fields));
+    return {
+        '@context': 'https://schema.org',
+        '@type': 'WebPage',
+        name: resolveSeoField(fieldMap, 'title', fields) || slug,
+        description: resolveSeoField(fieldMap, 'description', fields),
+        url: `${config.site.baseUrl}${path}`,
+    };
+}
+//# sourceMappingURL=seo-compose.js.map

package/dist/seo-compose.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seo-compose.js","sourceRoot":"","sources":["../src/seo-compose.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,qBAAqB,EACrB,eAAe,GAChB,MAAM,qBAAqB,CAAA;AAE5B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AA2BhE,MAAM,YAAY,GAAG,QAAQ,CAAA;AAE7B,uGAAuG;AACvG,SAAS,YAAY,CAAC,OAAe;IACnC,MAAM,MAAM,GAAG,OAAO;SACnB,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACZ,IAAI;SACD,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;SAC/D,IAAI,CAAC,OAAO,CAAC,CACjB;SACA,IAAI,CAAC,IAAI,CAAC,CAAA;IACb,OAAO,IAAI,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC,CAAA;AAClC,CAAC;AAED,8FAA8F;AAC9F,MAAM,UAAU,YAAY,CAAC,OAAe,EAAE,IAAY;IACxD,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACzC,CAAC;AAED,qHAAqH;AACrH,KAAK,UAAU,WAAW,CACxB,UAA2B,EAC3B,IAAmB;IAEnB,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IAC9B,MAAM,OAAO,GAAG,CAAC,EAAU,EAAU,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,MAAM,CAAA;IACrE,MAAM,QAAQ,GAAG,CAAC,MAAM,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;SACrD,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;SAC5E,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAChD,OAAO,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,IAAI,IAAI,CAAA;AACpC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,KAAwF;IAExF,MAAM,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,GAAG,MAAM,aAAa,EAAE,CAAA;IAC3E,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,UAAU;QAClD,CAAC,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC;YAClC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,cAAc,KAAK,CAAC,UAAU,EAAE,CAAC;YAC5D,WAAW,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC;SAC1C,CAAC;QACJ,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IACtB,MAAM,IAAI,GAAG,OAAO,EAAE,MAAM,IAAI,IAAI,CAAA;IACpC,MAAM,QAAQ,GAAG,iBAAiB,CAAC,KAAK,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAA;IACxD,MAAM,MAAM,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IACzD,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACjE,MAAM,QAAQ,GAAG,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC,CAAA;QAC7F,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAA;IAChD,CAAC;IACD,OAAO;QACL,IAAI;QACJ,SAAS,EAAE,sBAAsB,CAAC;YAChC,UAAU,EAAE,MAAM,EAAE,MAAM,IAAI,IAAI;YAClC,KAAK,EAAE,QAAQ;YACf,QAAQ;SACT,CAAC;KACH,CAAA;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,KAAsB;IAC5D,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;IAC5C,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;IAE5E,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;QACjC,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,KAAK,CAAC,CAAA;QACvC,OAAO;YACL,GAAG,GAAG,CAAC,OAAO,CAAC;gBACb,MAAM,EAAE,IAAI,CAAC,SAAS;gBACtB,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,GAAG,qBAAqB,CAAC,KAAK,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE;gBACrE,IAAI;gBACJ,SAAS,EAAE,IAAI,CAAC,IAAI;gBACpB,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnE,SAAS,EAAE,KAAK,CAAC,SAAS;aAC3B,CAAC;SACH,CAAA;IACH,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACtB,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC;YAAE,MAAM,GAAG,CAAA;IACzC,CAAC;IAED,mFAAmF;IACnF,MAAM,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;IACtD,OAAO;QACL,UAAU,EAAE,oBAAoB;QAChC,OAAO,EAAE,SAAS;QAClB,IAAI,EAAE,eAAe,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,IAAI;QACxD,WAAW,EAAE,eAAe,CAAC,QAAQ,EAAE,aAAa,EAAE,MAAM,CAAC;QAC7D,GAAG,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE;KACrC,CAAA;AACH,CAAC"}

package/dist/seo-config-snapshot.d.ts

@@ -0,0 +1,10 @@
+import type { ISeoConfigAdapter } from '@krantho/persistence';
+/** What composing a page's JSON-LD reads from the SEO configuration store */
+export type SeoConfigReader = Pick<ISeoConfigAdapter, 'getConfig' | 'listConfigs'>;
+/**
+ * Every stored SEO configuration, read once and answered from memory. A request
+ * that composes many pages' graphs (the site's findings) would otherwise read
+ * the site, collection, URL-pattern and document scopes again for each page.
+ */
+export declare function seoConfigSnapshot(store: ISeoConfigAdapter | undefined): Promise<SeoConfigReader | undefined>;
+//# sourceMappingURL=seo-config-snapshot.d.ts.map

package/dist/seo-config-snapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"seo-config-snapshot.d.ts","sourceRoot":"","sources":["../src/seo-config-snapshot.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAE7D,6EAA6E;AAC7E,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,iBAAiB,EAAE,WAAW,GAAG,aAAa,CAAC,CAAA;AAElF;;;;GAIG;AACH,wBAAsB,iBAAiB,CACrC,KAAK,EAAE,iBAAiB,GAAG,SAAS,GACnC,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC,CAStC"}

package/dist/seo-config-snapshot.js

@@ -0,0 +1,16 @@
+/**
+ * Every stored SEO configuration, read once and answered from memory. A request
+ * that composes many pages' graphs (the site's findings) would otherwise read
+ * the site, collection, URL-pattern and document scopes again for each page.
+ */
+export async function seoConfigSnapshot(store) {
+    if (!store)
+        return undefined;
+    const configs = await store.listConfigs();
+    const byId = new Map(configs.map((stored) => [stored.id, stored]));
+    return {
+        getConfig: async (id) => byId.get(id) ?? null,
+        listConfigs: async (scope) => scope === undefined ? [...configs] : configs.filter((stored) => stored.scope === scope),
+    };
+}
+//# sourceMappingURL=seo-config-snapshot.js.map

package/dist/seo-config-snapshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seo-config-snapshot.js","sourceRoot":"","sources":["../src/seo-config-snapshot.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,KAAoC;IAEpC,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAA;IAC5B,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,WAAW,EAAE,CAAA;IACzC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,CAAA;IAClE,OAAO;QACL,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI;QAC7C,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAC3B,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC;KAC1F,CAAA;AACH,CAAC"}

package/dist/seo-loader.d.ts

@@ -0,0 +1,10 @@
+type SeoModule = typeof import('@krantho/seo');
+/**
+ * Lazily load and cache the optional @krantho/seo package. The specifier is a
+ * literal the bundler can see, so a build that has the package installed packs
+ * it with the server code; a deployment that ships only traced files (Vercel,
+ * Next.js standalone output) would otherwise leave it out.
+ */
+export declare function loadSeoModule(): Promise<SeoModule>;
+export {};
+//# sourceMappingURL=seo-loader.d.ts.map

package/dist/seo-loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"seo-loader.d.ts","sourceRoot":"","sources":["../src/seo-loader.ts"],"names":[],"mappings":"AAAA,KAAK,SAAS,GAAG,cAAc,cAAc,CAAC,CAAA;AAI9C;;;;;GAKG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAAC,SAAS,CAAC,CAIlD"}

package/dist/seo-loader.js

@@ -0,0 +1,14 @@
+let cached = null;
+/**
+ * Lazily load and cache the optional @krantho/seo package. The specifier is a
+ * literal the bundler can see, so a build that has the package installed packs
+ * it with the server code; a deployment that ships only traced files (Vercel,
+ * Next.js standalone output) would otherwise leave it out.
+ */
+export function loadSeoModule() {
+    if (cached)
+        return cached;
+    cached = import('@krantho/seo');
+    return cached;
+}
+//# sourceMappingURL=seo-loader.js.map

package/dist/seo-loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seo-loader.js","sourceRoot":"","sources":["../src/seo-loader.ts"],"names":[],"mappings":"AAEA,IAAI,MAAM,GAA8B,IAAI,CAAA;AAE5C;;;;;GAKG;AACH,MAAM,UAAU,aAAa;IAC3B,IAAI,MAAM;QAAE,OAAO,MAAM,CAAA;IACzB,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,CAAA;IAC/B,OAAO,MAAM,CAAA;AACf,CAAC"}

package/dist/seo-site-findings.d.ts

@@ -0,0 +1,27 @@
+import { loadSeo } from './seo-subsystem.js';
+import type { ApiContext } from './types.js';
+type Seo = Awaited<ReturnType<typeof loadSeo>>;
+/** How many findings of each severity one reader (or the page checks) has */
+export interface FindingCounts {
+    errors: number;
+    warnings: number;
+    info: number;
+}
+/** One published page's SEO: findings counted per reader, and the search features it can appear in */
+export interface PageSeoSummary {
+    collection: string;
+    slug: string;
+    path: string;
+    /** Keyed by reader id, `schema.org` for the vocabulary, `page` for the title and meta description */
+    readers: Record<string, FindingCounts>;
+    features: ReturnType<Seo['features']>;
+}
+/**
+ * The SEO of every published page of the site in its default locale — what
+ * search engines read: each page's findings per reader and the search
+ * features its entities can appear in. Rejects when `@krantho/seo` is not
+ * installed.
+ */
+export declare function siteSeoSummary(ctx: ApiContext): Promise<PageSeoSummary[]>;
+export {};
+//# sourceMappingURL=seo-site-findings.d.ts.map

package/dist/seo-site-findings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"seo-site-findings.d.ts","sourceRoot":"","sources":["../src/seo-site-findings.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAE5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAE5C,KAAK,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,OAAO,CAAC,CAAC,CAAA;AAE9C,6EAA6E;AAC7E,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,sGAAsG;AACtG,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,qGAAqG;IACrG,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IACtC,QAAQ,EAAE,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAA;CACtC;AAuDD;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAwB/E"}

package/dist/seo-site-findings.js

@@ -0,0 +1,87 @@
+import { documentPath, rendersPages } from '@krantho/core';
+import { canQuery } from '@krantho/persistence';
+import { documentSeoProperties } from '@krantho/seo-shared';
+import { groupByCollection } from './group-by-collection.js';
+import { composePageJsonLd } from './seo-compose.js';
+import { seoConfigSnapshot } from './seo-config-snapshot.js';
+import { loadSeo } from './seo-subsystem.js';
+import { metaFindings, structuredFindings } from './seo-validation.js';
+/** Findings counted by the reader they come from */
+function countByReader(findings) {
+    const counts = {};
+    for (const finding of findings) {
+        const reader = finding.reader ?? 'page';
+        counts[reader] ??= { errors: 0, warnings: 0, info: 0 };
+        const bucket = counts[reader];
+        if (finding.severity === 'error')
+            bucket.errors++;
+        else if (finding.severity === 'warning')
+            bucket.warnings++;
+        else
+            bucket.info++;
+    }
+    return counts;
+}
+/** One live page: its graph composed once, validated once */
+async function pageSummary(ctx, seo, seoConfigs, collection, path, doc) {
+    const properties = documentSeoProperties(doc.metadata);
+    const graph = await composePageJsonLd({
+        collection,
+        slug: doc.meta.slug,
+        path,
+        fields: { ...doc.fields, ...documentSeoProperties(doc.metadata) },
+        metadata: doc.metadata,
+        documentMeta: doc.meta,
+        config: ctx.config,
+        seoConfigs,
+    });
+    const findings = [
+        ...metaFindings(ctx, {
+            ...doc.fields,
+            ...properties,
+            title: properties['headline'] ?? properties['name'] ?? doc.fields['title'],
+            'meta-description': properties['description'] ?? doc.fields['meta-description'] ?? doc.fields['description'],
+        }),
+        ...structuredFindings(seo, graph),
+    ];
+    return {
+        collection,
+        slug: doc.meta.slug,
+        path,
+        readers: countByReader(findings),
+        features: seo.features(graph),
+    };
+}
+/**
+ * The SEO of every published page of the site in its default locale — what
+ * search engines read: each page's findings per reader and the search
+ * features its entities can appear in. Rejects when `@krantho/seo` is not
+ * installed.
+ */
+export async function siteSeoSummary(ctx) {
+    const seo = await loadSeo(ctx.config);
+    if (!canQuery(ctx.adapter))
+        return [];
+    const seoConfigs = await seoConfigSnapshot(ctx.seoConfigAdapter);
+    const rendered = [...ctx.contentConfig.collections].filter(([, collection]) => rendersPages(collection));
+    if (rendered.length === 0)
+        return [];
+    const names = rendered.map(([name]) => name);
+    const { items } = await ctx.adapter.query({
+        state: 'published',
+        projection: 'summary',
+        collections: names,
+        locale: ctx.config.site.defaultLocale,
+    });
+    const live = groupByCollection(items, names, (doc) => doc.meta.collection);
+    const pages = [];
+    for (const [name, collection] of rendered) {
+        for (const doc of live.get(name) ?? []) {
+            const path = documentPath(collection, doc.meta.slug);
+            if (path !== null)
+                pages.push(await pageSummary(ctx, seo, seoConfigs, name, path, doc));
+        }
+    }
+    return pages;
+}
+//# sourceMappingURL=seo-site-findings.js.map

package/dist/seo-site-findings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seo-site-findings.js","sourceRoot":"","sources":["../src/seo-site-findings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC1D,OAAO,EAAuB,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AACpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAA;AAE3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACpD,OAAO,EAAwB,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAClF,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAsBtE,oDAAoD;AACpD,SAAS,aAAa,CAAC,QAA+B;IACpD,MAAM,MAAM,GAAkC,EAAE,CAAA;IAChD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,MAAM,CAAA;QACvC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAA;QACtD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;QAC7B,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO;YAAE,MAAM,CAAC,MAAM,EAAE,CAAA;aAC5C,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS;YAAE,MAAM,CAAC,QAAQ,EAAE,CAAA;;YACrD,MAAM,CAAC,IAAI,EAAE,CAAA;IACpB,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,6DAA6D;AAC7D,KAAK,UAAU,WAAW,CACxB,GAAe,EACf,GAAQ,EACR,UAAuC,EACvC,UAAkB,EAClB,IAAY,EACZ,GAAmB;IAEnB,MAAM,UAAU,GAAG,qBAAqB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IACtD,MAAM,KAAK,GAAG,MAAM,iBAAiB,CAAC;QACpC,UAAU;QACV,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI;QACnB,IAAI;QACJ,MAAM,EAAE,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,qBAAqB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;QACjE,QAAQ,EAAE,GAAG,CAAC,QAAQ;QACtB,YAAY,EAAE,GAAG,CAAC,IAAI;QACtB,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,UAAU;KACX,CAAC,CAAA;IACF,MAAM,QAAQ,GAAG;QACf,GAAG,YAAY,CAAC,GAAG,EAAE;YACnB,GAAG,GAAG,CAAC,MAAM;YACb,GAAG,UAAU;YACb,KAAK,EAAE,UAAU,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC;YAC1E,kBAAkB,EAChB,UAAU,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC;SAC3F,CAAC;QACF,GAAG,kBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC;KAClC,CAAA;IACD,OAAO;QACL,UAAU;QACV,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI;QACnB,IAAI;QACJ,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC;QAChC,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC;KAC9B,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,GAAe;IAClD,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACrC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC;QAAE,OAAO,EAAE,CAAA;IACrC,MAAM,UAAU,GAAG,MAAM,iBAAiB,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;IAChE,MAAM,QAAQ,GAAG,CAAC,GAAG,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,EAAE,EAAE,CAC5E,YAAY,CAAC,UAAU,CAAC,CACzB,CAAA;IACD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAA;IACpC,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAA;IAC5C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC;QACxC,KAAK,EAAE,WAAW;QAClB,UAAU,EAAE,SAAS;QACrB,WAAW,EAAE,KAAK;QAClB,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa;KACtC,CAAC,CAAA;IACF,MAAM,IAAI,GAAG,iBAAiB,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IAC1E,MAAM,KAAK,GAAqB,EAAE,CAAA;IAClC,KAAK,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,QAAQ,EAAE,CAAC;QAC1C,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;YACvC,MAAM,IAAI,GAAG,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACpD,IAAI,IAAI,KAAK,IAAI;gBAAE,KAAK,CAAC,IAAI,CAAC,MAAM,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,CAAA;QACzF,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC"}

package/dist/seo-subsystem.d.ts

@@ -0,0 +1,28 @@
+import type { KranthoConfig } from '@krantho/config';
+import { loadSeoModule } from './seo-loader.js';
+type SeoModule = Awaited<ReturnType<typeof loadSeoModule>>;
+type Seo = ReturnType<SeoModule['createSeo']>;
+/**
+ * The site's SEO subsystem, created once per configuration instance from its
+ * site identity, SEO definitions and readers. Rejects when `@krantho/seo` is
+ * not installed, or with its `SeoConfigurationError` when the configuration
+ * lacks what the structured data requires.
+ */
+export declare function loadSeo(config: KranthoConfig): Promise<Seo>;
+/**
+ * Whether an error is `@krantho/seo` itself missing from the installation —
+ * Node's "Cannot find package '@krantho/seo'", a bundler's "Cannot find module
+ * '@krantho/seo'". A dependency missing inside the package names that
+ * dependency instead, and is not mistaken for it.
+ */
+export declare function isSeoModuleMissing(err: unknown): boolean;
+/**
+ * Create the SEO subsystem when the site starts, so the configuration is
+ * checked before anything is served: a value the structured data requires
+ * that is missing throws a {@link KranthoConfigError} naming the setting and
+ * its environment variable; a recommended one is logged as a warning. A site
+ * without `@krantho/seo` has nothing to check.
+ */
+export declare function startSeo(config: KranthoConfig): Promise<void>;
+export {};
+//# sourceMappingURL=seo-subsystem.d.ts.map

package/dist/seo-subsystem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"seo-subsystem.d.ts","sourceRoot":"","sources":["../src/seo-subsystem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAEpD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C,KAAK,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC,CAAA;AAC1D,KAAK,GAAG,GAAG,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAA;AAI7C;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,CAQ3D;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAMxD;AASD;;;;;;GAMG;AACH,wBAAsB,QAAQ,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAgBnE"}

package/dist/seo-subsystem.js

@@ -0,0 +1,62 @@
+import { envNameFor, KranthoConfigError, leafByPath } from '@krantho/config';
+import { loadSeoModule } from './seo-loader.js';
+const subsystems = new WeakMap();
+/**
+ * The site's SEO subsystem, created once per configuration instance from its
+ * site identity, SEO definitions and readers. Rejects when `@krantho/seo` is
+ * not installed, or with its `SeoConfigurationError` when the configuration
+ * lacks what the structured data requires.
+ */
+export function loadSeo(config) {
+    let seo = subsystems.get(config);
+    if (!seo) {
+        seo = loadSeoModule().then((module) => module.createSeo(config));
+        seo.catch(() => subsystems.delete(config));
+        subsystems.set(config, seo);
+    }
+    return seo;
+}
+/**
+ * Whether an error is `@krantho/seo` itself missing from the installation —
+ * Node's "Cannot find package '@krantho/seo'", a bundler's "Cannot find module
+ * '@krantho/seo'". A dependency missing inside the package names that
+ * dependency instead, and is not mistaken for it.
+ */
+export function isSeoModuleMissing(err) {
+    return (err instanceof Error &&
+        err.message.includes('Cannot find') &&
+        err.message.includes("'@krantho/seo'"));
+}
+/** A setting with the environment variable that overrides it, as configuration errors name it */
+function settingLabel(setting) {
+    const leaf = leafByPath(setting);
+    const env = leaf ? envNameFor(leaf) : null;
+    return env ? `${env} (${setting})` : setting;
+}
+/**
+ * Create the SEO subsystem when the site starts, so the configuration is
+ * checked before anything is served: a value the structured data requires
+ * that is missing throws a {@link KranthoConfigError} naming the setting and
+ * its environment variable; a recommended one is logged as a warning. A site
+ * without `@krantho/seo` has nothing to check.
+ */
+export async function startSeo(config) {
+    let seo;
+    try {
+        seo = await loadSeo(config);
+    }
+    catch (err) {
+        if (isSeoModuleMissing(err))
+            return;
+        const { SeoConfigurationError } = await loadSeoModule();
+        if (!(err instanceof SeoConfigurationError))
+            throw err;
+        throw new KranthoConfigError(err.findings.map((f) => `${settingLabel(f.setting)}: ${f.message}`));
+    }
+    for (const finding of seo.findings) {
+        if (finding.severity !== 'warning')
+            continue;
+        console.warn(`[krantho] WARNING: ${settingLabel(finding.setting)}: ${finding.message}`);
+    }
+}
+//# sourceMappingURL=seo-subsystem.js.map

package/dist/seo-subsystem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seo-subsystem.js","sourceRoot":"","sources":["../src/seo-subsystem.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAK/C,MAAM,UAAU,GAAG,IAAI,OAAO,EAA+B,CAAA;AAE7D;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,MAAqB;IAC3C,IAAI,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAChC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,GAAG,GAAG,aAAa,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAA;QAChE,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;QAC1C,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAY;IAC7C,OAAO,CACL,GAAG,YAAY,KAAK;QACpB,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;QACnC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CACvC,CAAA;AACH,CAAC;AAED,iGAAiG;AACjG,SAAS,YAAY,CAAC,OAAe;IACnC,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;IAChC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAC1C,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,OAAO,GAAG,CAAC,CAAC,CAAC,OAAO,CAAA;AAC9C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,MAAqB;IAClD,IAAI,GAAwC,CAAA;IAC5C,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;IAC7B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,kBAAkB,CAAC,GAAG,CAAC;YAAE,OAAM;QACnC,MAAM,EAAE,qBAAqB,EAAE,GAAG,MAAM,aAAa,EAAE,CAAA;QACvD,IAAI,CAAC,CAAC,GAAG,YAAY,qBAAqB,CAAC;YAAE,MAAM,GAAG,CAAA;QACtD,MAAM,IAAI,kBAAkB,CAC1B,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CACpE,CAAA;IACH,CAAC;IACD,KAAK,MAAM,OAAO,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QACnC,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS;YAAE,SAAQ;QAC5C,OAAO,CAAC,IAAI,CAAC,sBAAsB,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;IACzF,CAAC;AACH,CAAC"}

package/dist/seo-validation.d.ts

@@ -0,0 +1,20 @@
+import type { SeoFinding } from './assistant/protocol.js';
+import { loadSeo } from './seo-subsystem.js';
+import type { ApiContext } from './types.js';
+/** Title and meta description checks, with the limits the site's configuration sets */
+export declare function metaFindings(ctx: ApiContext, fields: Record<string, unknown>): SeoFinding[];
+/** The document a check names does not exist */
+export declare class DocumentNotFoundError extends Error {
+    constructor(collection: string, slug: string);
+}
+/**
+ * Check a document's current version (the draft the assistant works on) for
+ * SEO: its title and meta description against the configured limits, and its
+ * composed JSON-LD against the Schema.org vocabulary and each active reader's
+ * rules — every structured-data finding names the reader it comes from.
+ * Throws a {@link DocumentNotFoundError} when the document does not exist.
+ */
+export declare function validateDocumentSeo(ctx: ApiContext, collection: string, slug: string, locale: string | undefined): Promise<SeoFinding[]>;
+/** A graph's structured-data findings, each naming the reader (or Schema.org) it comes from */
+export declare function structuredFindings(seo: Awaited<ReturnType<typeof loadSeo>>, graph: Record<string, unknown>): SeoFinding[];
+//# sourceMappingURL=seo-validation.d.ts.map

package/dist/seo-validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"seo-validation.d.ts","sourceRoot":"","sources":["../src/seo-validation.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEzD,OAAO,EAAsB,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAChE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAE5C,uFAAuF;AACvF,wBAAgB,YAAY,CAAC,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,UAAU,EAAE,CAuB3F;AAED,gDAAgD;AAChD,qBAAa,qBAAsB,SAAQ,KAAK;gBAClC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;CAI7C;AAED;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CACvC,GAAG,EAAE,UAAU,EACf,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,GAAG,SAAS,GACzB,OAAO,CAAC,UAAU,EAAE,CAAC,CAsCvB;AAED,+FAA+F;AAC/F,wBAAgB,kBAAkB,CAChC,GAAG,EAAE,OAAO,CAAC,UAAU,CAAC,OAAO,OAAO,CAAC,CAAC,EACxC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,UAAU,EAAE,CAWd"}

package/dist/seo-validation.js

@@ -0,0 +1,96 @@
+import { documentPath } from '@krantho/core';
+import { canGetContent } from '@krantho/persistence';
+import { buildSeoFieldMap, documentSeoProperties, resolveSeoField } from '@krantho/seo-shared';
+import { composePageJsonLd } from './seo-compose.js';
+import { isSeoModuleMissing, loadSeo } from './seo-subsystem.js';
+/** Title and meta description checks, with the limits the site's configuration sets */
+export function metaFindings(ctx, fields) {
+    const findings = [];
+    const fieldMap = buildSeoFieldMap(Object.keys(fields));
+    const title = resolveSeoField(fieldMap, 'title', fields);
+    const titleMax = ctx.config.seo.enrichment.title.maxChars;
+    if (!title) {
+        findings.push({ severity: 'error', check: 'title', message: 'The document has no title.' });
+    }
+    else if (title.length > titleMax) {
+        const message = `The title is ${title.length} characters; the site's limit is ${titleMax}.`;
+        findings.push({ severity: 'warning', check: 'title', message });
+    }
+    const { minChars, maxChars } = ctx.config.seo.enrichment.meta;
+    const description = resolveSeoField(fieldMap, 'description', fields);
+    if (!description) {
+        const message = 'The document has no meta description.';
+        findings.push({ severity: 'error', check: 'meta-description', message });
+    }
+    else if (description.length < minChars || description.length > maxChars) {
+        const message = `The meta description is ${description.length} characters; aim for ${minChars}–${maxChars}.`;
+        findings.push({ severity: 'warning', check: 'meta-description', message });
+    }
+    return findings;
+}
+/** The document a check names does not exist */
+export class DocumentNotFoundError extends Error {
+    constructor(collection, slug) {
+        super(`Content "${collection}/${slug}" not found`);
+        this.name = 'DocumentNotFoundError';
+    }
+}
+/**
+ * Check a document's current version (the draft the assistant works on) for
+ * SEO: its title and meta description against the configured limits, and its
+ * composed JSON-LD against the Schema.org vocabulary and each active reader's
+ * rules — every structured-data finding names the reader it comes from.
+ * Throws a {@link DocumentNotFoundError} when the document does not exist.
+ */
+export async function validateDocumentSeo(ctx, collection, slug, locale) {
+    const current = canGetContent(ctx.adapter)
+        ? await ctx.adapter.getContent(collection, slug, locale)
+        : null;
+    if (!current || current.meta.locale !== (locale ?? ctx.config.site.defaultLocale))
+        throw new DocumentNotFoundError(collection, slug);
+    const properties = documentSeoProperties(current.metadata);
+    const findings = metaFindings(ctx, {
+        ...current.fields,
+        ...properties,
+        title: properties['headline'] ?? properties['name'] ?? current.fields['title'],
+        'meta-description': properties['description'] ??
+            current.fields['meta-description'] ??
+            current.fields['description'],
+    });
+    let seo;
+    try {
+        seo = await loadSeo(ctx.config);
+    }
+    catch (err) {
+        if (!isSeoModuleMissing(err))
+            throw err;
+        const message = 'Structured-data checks need the @krantho/seo package.';
+        return [...findings, { severity: 'info', check: 'structured-data', message }];
+    }
+    const collectionDef = ctx.contentConfig.collections.get(collection) ?? { name: collection };
+    const graph = await composePageJsonLd({
+        collection,
+        slug,
+        path: documentPath(collectionDef, slug),
+        fields: { ...current.fields, ...documentSeoProperties(current.metadata) },
+        metadata: current.metadata,
+        documentMeta: current.meta,
+        config: ctx.config,
+        seoConfigs: ctx.seoConfigAdapter,
+    });
+    return [...findings, ...structuredFindings(seo, graph)];
+}
+/** A graph's structured-data findings, each naming the reader (or Schema.org) it comes from */
+export function structuredFindings(seo, graph) {
+    return seo.validate(graph).map((finding) => ({
+        severity: finding.severity,
+        check: 'structured-data',
+        message: finding.message,
+        reader: finding.profile,
+        code: finding.code,
+        type: finding.type,
+        property: finding.property,
+        source: finding.source,
+    }));
+}
+//# sourceMappingURL=seo-validation.js.map

package/dist/seo-validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seo-validation.js","sourceRoot":"","sources":["../src/seo-validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACpD,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAE9F,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACpD,OAAO,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAGhE,uFAAuF;AACvF,MAAM,UAAU,YAAY,CAAC,GAAe,EAAE,MAA+B;IAC3E,MAAM,QAAQ,GAAiB,EAAE,CAAA;IACjC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;IAEtD,MAAM,KAAK,GAAG,eAAe,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IACxD,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAA;IACzD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,4BAA4B,EAAE,CAAC,CAAA;IAC7F,CAAC;SAAM,IAAI,KAAK,CAAC,MAAM,GAAG,QAAQ,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG,gBAAgB,KAAK,CAAC,MAAM,oCAAoC,QAAQ,GAAG,CAAA;QAC3F,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAA;IACjE,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAA;IAC7D,MAAM,WAAW,GAAG,eAAe,CAAC,QAAQ,EAAE,aAAa,EAAE,MAAM,CAAC,CAAA;IACpE,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,OAAO,GAAG,uCAAuC,CAAA;QACvD,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,CAAC,CAAA;IAC1E,CAAC;SAAM,IAAI,WAAW,CAAC,MAAM,GAAG,QAAQ,IAAI,WAAW,CAAC,MAAM,GAAG,QAAQ,EAAE,CAAC;QAC1E,MAAM,OAAO,GAAG,2BAA2B,WAAW,CAAC,MAAM,wBAAwB,QAAQ,IAAI,QAAQ,GAAG,CAAA;QAC5G,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,CAAC,CAAA;IAC5E,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,gDAAgD;AAChD,MAAM,OAAO,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,UAAkB,EAAE,IAAY;QAC1C,KAAK,CAAC,YAAY,UAAU,IAAI,IAAI,aAAa,CAAC,CAAA;QAClD,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAA;IACrC,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,GAAe,EACf,UAAkB,EAClB,IAAY,EACZ,MAA0B;IAE1B,MAAM,OAAO,GAAG,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC;QACxC,CAAC,CAAC,MAAM,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,IAAI,EAAE,MAAM,CAAC;QACxD,CAAC,CAAC,IAAI,CAAA;IACR,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;QAC/E,MAAM,IAAI,qBAAqB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;IAEnD,MAAM,UAAU,GAAG,qBAAqB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IAC1D,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,EAAE;QACjC,GAAG,OAAO,CAAC,MAAM;QACjB,GAAG,UAAU;QACb,KAAK,EAAE,UAAU,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;QAC9E,kBAAkB,EAChB,UAAU,CAAC,aAAa,CAAC;YACzB,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC;YAClC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC;KAChC,CAAC,CAAA;IACF,IAAI,GAAwC,CAAA;IAC5C,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACjC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC;YAAE,MAAM,GAAG,CAAA;QACvC,MAAM,OAAO,GAAG,uDAAuD,CAAA;QACvE,OAAO,CAAC,GAAG,QAAQ,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,CAAC,CAAA;IAC/E,CAAC;IAED,MAAM,aAAa,GAAG,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAA;IAC3F,MAAM,KAAK,GAAG,MAAM,iBAAiB,CAAC;QACpC,UAAU;QACV,IAAI;QACJ,IAAI,EAAE,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC;QACvC,MAAM,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,qBAAqB,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACzE,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,YAAY,EAAE,OAAO,CAAC,IAAI;QAC1B,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,UAAU,EAAE,GAAG,CAAC,gBAAgB;KACjC,CAAC,CAAA;IACF,OAAO,CAAC,GAAG,QAAQ,EAAE,GAAG,kBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAA;AACzD,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,kBAAkB,CAChC,GAAwC,EACxC,KAA8B;IAE9B,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC3C,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,KAAK,EAAE,iBAAiB;QACxB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,MAAM,EAAE,OAAO,CAAC,OAAO;QACvB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC,CAAA;AACL,CAAC"}