@ketvietlab/ketsuite 0.1.2 → 0.1.5

package/dist/modules/website_search/models.js

@@ -0,0 +1,58 @@
+/**
+ * An index, so a search is a lookup rather than a scan.
+ *
+ * `website.searchPublished` reads every published entry of a site, fetches each
+ * revision and matches in JavaScript. That is correct and it does not scale: the
+ * cost of one keystroke grows with the site, and the window that bounds it is
+ * also a ceiling on what can be found.
+ *
+ * The index is derived data. It is never the answer to "what is public" — the
+ * publication is — so a stale index degrades a search rather than publishing
+ * something it should not.
+ */
+export const models = {
+    SearchDocument: {
+        scope: 'company',
+        fields: {
+            id: 'id',
+            siteId: 'ref:website.Site',
+            entryId: 'ref:website.Entry',
+            type: 'text',
+            path: 'text',
+            title: 'text',
+            excerpt: 'text?',
+            /** Lowercased title and excerpt, so a match is one comparison. */
+            haystack: 'text',
+            publishedAt: 'datetime?',
+        },
+        indexes: {
+            site_entry: { fields: ['companyId', 'siteId', 'entryId'], unique: true },
+            site_published: { fields: ['companyId', 'siteId', 'publishedAt'] },
+        },
+    },
+    /**
+     * What the index was built from, and how far a rebuild has got.
+     *
+     * `publicationId` is the whole staleness test: an index built for a
+     * publication that is no longer active describes pages that may no longer be
+     * the ones being served. `cursor` lets a rebuild stop and resume rather than
+     * having to finish inside one request.
+     */
+    SearchIndexState: {
+        scope: 'company',
+        timestamps: true,
+        fields: {
+            id: 'id',
+            siteId: 'ref:website.Site',
+            /** Null while a site has never published a set; the index then follows entries. */
+            publicationId: 'text?',
+            state: 'text',
+            cursor: 'text?',
+            documentCount: 'int',
+            startedAt: 'datetime',
+            completedAt: 'datetime?',
+        },
+        indexes: { site: { fields: ['companyId', 'siteId'], unique: true } },
+    },
+};
+//# sourceMappingURL=models.js.map

package/dist/modules/website_search/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../../../../../packages/ketsuite/src/modules/website_search/models.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,MAAM,GAA6B;IAC9C,cAAc,EAAE;QACd,KAAK,EAAE,SAAS;QAChB,MAAM,EAAE;YACN,EAAE,EAAE,IAAI;YACR,MAAM,EAAE,kBAAkB;YAC1B,OAAO,EAAE,mBAAmB;YAC5B,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,MAAM;YACb,OAAO,EAAE,OAAO;YAChB,kEAAkE;YAClE,QAAQ,EAAE,MAAM;YAChB,WAAW,EAAE,WAAW;SACzB;QACD,OAAO,EAAE;YACP,UAAU,EAAE,EAAE,MAAM,EAAE,CAAC,WAAW,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE;YACxE,cAAc,EAAE,EAAE,MAAM,EAAE,CAAC,WAAW,EAAE,QAAQ,EAAE,aAAa,CAAC,EAAE;SACnE;KACF;IAED;;;;;;;OAOG;IACH,gBAAgB,EAAE;QAChB,KAAK,EAAE,SAAS;QAChB,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE;YACN,EAAE,EAAE,IAAI;YACR,MAAM,EAAE,kBAAkB;YAC1B,mFAAmF;YACnF,aAAa,EAAE,OAAO;YACtB,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,OAAO;YACf,aAAa,EAAE,KAAK;YACpB,SAAS,EAAE,UAAU;YACrB,WAAW,EAAE,WAAW;SACzB;QACD,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,WAAW,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;KACrE;CACF,CAAA"}

package/dist/modules/website_search/rebuild.d.ts

@@ -0,0 +1,33 @@
+import type { Ctx, Row } from '@ketvietlab/ketjs';
+/**
+ * Building the index, kept apart from reading it.
+ *
+ * A job cannot reach a declared function - a JobContext has no `call` - so the
+ * passes have to be an ordinary import, the way `website_form` keeps its purge.
+ * Separating them says the same thing the model does: the index is derived, and
+ * building it is not the same act as answering with it.
+ */
+/** How many entries one rebuild pass reads. A pass is meant to fit in a request. */
+export declare const BATCH = 200;
+export declare const indexEffects: string[];
+/** The site a visitor is actually being served, and the set it is serving. */
+export declare const servedSite: (ctx: Ctx, siteId: unknown) => Promise<Row | null>;
+export declare const stateFor: (ctx: Ctx, siteId: unknown) => Promise<Row | null>;
+/**
+ * An index is current when it was built for the publication now active — or,
+ * for a site that publishes one page at a time, when it has completed at all
+ * and nothing has been published since it finished.
+ */
+export declare const isCurrent: (state: Row | null, site: Row) => boolean;
+/**
+ * One pass of a rebuild.
+ *
+ * Checkpointed on the entry path, which is stable and unique per site, so a
+ * pass that stops halfway resumes where it left off rather than starting again.
+ * Returns whether there is more to do.
+ */
+export declare const rebuildPass: (ctx: Ctx, site: Row) => Promise<{
+    done: boolean;
+    written: number;
+}>;
+//# sourceMappingURL=rebuild.d.ts.map

package/dist/modules/website_search/rebuild.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rebuild.d.ts","sourceRoot":"","sources":["../../../../../../packages/ketsuite/src/modules/website_search/rebuild.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AAEjD;;;;;;;GAOG;AAEH,oFAAoF;AACpF,eAAO,MAAM,KAAK,MAAM,CAAA;AAExB,eAAO,MAAM,YAAY,UAQxB,CAAA;AAED,8EAA8E;AAC9E,eAAO,MAAM,UAAU,QAAe,GAAG,UAAU,OAAO,KAAG,OAAO,CAAC,GAAG,GAAG,IAAI,CAG9E,CAAA;AAED,eAAO,MAAM,QAAQ,QAAe,GAAG,UAAU,OAAO,KAAG,OAAO,CAAC,GAAG,GAAG,IAAI,CAG5E,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,SAAS,UAAW,GAAG,GAAG,IAAI,QAAQ,GAAG,KAAG,OAGxD,CAAA;AAcD;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,QAAe,GAAG,QAAQ,GAAG,KAAG,OAAO,CAAC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAsEjG,CAAA"}

package/dist/modules/website_search/rebuild.js

@@ -0,0 +1,125 @@
+import { asc, deleteFrom, eq, from, gt, inArray, isNotNull, ne } from '@ketvietlab/ketjs';
+/**
+ * Building the index, kept apart from reading it.
+ *
+ * A job cannot reach a declared function - a JobContext has no `call` - so the
+ * passes have to be an ordinary import, the way `website_form` keeps its purge.
+ * Separating them says the same thing the model does: the index is derived, and
+ * building it is not the same act as answering with it.
+ */
+/** How many entries one rebuild pass reads. A pass is meant to fit in a request. */
+export const BATCH = 200;
+export const indexEffects = [
+    'read:website.Site',
+    'read:website.Entry',
+    'read:website.EntryRevision',
+    'read:website_search.SearchDocument',
+    'write:website_search.SearchDocument',
+    'read:website_search.SearchIndexState',
+    'write:website_search.SearchIndexState',
+];
+/** The site a visitor is actually being served, and the set it is serving. */
+export const servedSite = async (ctx, siteId) => {
+    const Site = ctx.table('website.Site');
+    return ctx.db.one(from(Site).where(eq(Site.id, siteId), eq(Site.active, true)));
+};
+export const stateFor = async (ctx, siteId) => {
+    const State = ctx.table('website_search.SearchIndexState');
+    return ctx.db.one(from(State).where(eq(State.siteId, siteId)));
+};
+/**
+ * An index is current when it was built for the publication now active — or,
+ * for a site that publishes one page at a time, when it has completed at all
+ * and nothing has been published since it finished.
+ */
+export const isCurrent = (state, site) => {
+    if (state?.state !== 'ready')
+        return false;
+    return String(state.publicationId ?? '') === String(site.activePublicationId ?? '');
+};
+const documentOf = (entry, revision) => ({
+    id: `${String(entry.siteId)}:${String(entry.id)}`,
+    siteId: entry.siteId,
+    entryId: entry.id,
+    type: entry.type,
+    path: entry.path,
+    title: revision.title,
+    excerpt: revision.excerpt ?? null,
+    haystack: `${String(revision.title)}\n${String(revision.excerpt ?? '')}`.toLocaleLowerCase(),
+    publishedAt: entry.publishedAt ?? null,
+});
+/**
+ * One pass of a rebuild.
+ *
+ * Checkpointed on the entry path, which is stable and unique per site, so a
+ * pass that stops halfway resumes where it left off rather than starting again.
+ * Returns whether there is more to do.
+ */
+export const rebuildPass = async (ctx, site) => {
+    const siteId = site.id;
+    const existing = await stateFor(ctx, siteId);
+    const target = String(site.activePublicationId ?? '');
+    const fresh = existing?.state !== 'building' || String(existing.publicationId ?? '') !== target;
+    const cursor = fresh ? '' : String(existing?.cursor ?? '');
+    const now = new Date().toISOString();
+    if (fresh) {
+        // A rebuild for a different publication starts clean: leftovers from the
+        // previous one describe pages that may no longer be served.
+        const Document = ctx.table('website_search.SearchDocument');
+        await ctx.db.del(deleteFrom(Document).where(eq(Document.siteId, siteId)));
+        const row = {
+            id: String(siteId),
+            siteId,
+            publicationId: site.activePublicationId ?? null,
+            state: 'building',
+            cursor: '',
+            documentCount: 0,
+            startedAt: now,
+            completedAt: null,
+        };
+        if (existing)
+            await ctx.db.update('website_search.SearchIndexState', { id: String(siteId) }, row);
+        else
+            await ctx.db.insert('website_search.SearchIndexState', row);
+    }
+    // The same publication gate the reader and the sitemap apply, so the index
+    // can never offer a page the reader would refuse.
+    const Entry = ctx.table('website.Entry');
+    let query = from(Entry)
+        .where(eq(Entry.siteId, siteId), isNotNull(Entry.publishedRevisionId), ne(Entry.status, 'trash'))
+        .orderBy(asc(Entry.path))
+        .limit(BATCH + 1);
+    if (cursor)
+        query = query.where(gt(Entry.path, cursor));
+    const scanned = await ctx.db.all(query);
+    const batch = scanned.slice(0, BATCH);
+    const more = scanned.length > BATCH;
+    if (batch.length) {
+        const Revision = ctx.table('website.EntryRevision');
+        const revisions = new Map();
+        const ids = batch.map((entry) => entry.publishedRevisionId);
+        for (const revision of await ctx.db.all(from(Revision)
+            .select(Revision.id, Revision.entryId, Revision.title, Revision.excerpt)
+            .where(inArray(Revision.id, ids))))
+            revisions.set(String(revision.id), revision);
+        for (const entry of batch) {
+            const revision = revisions.get(String(entry.publishedRevisionId));
+            if (!revision || revision.entryId !== entry.id)
+                continue;
+            const document = documentOf(entry, revision);
+            const inserted = await ctx.db.insertIfAbsent('website_search.SearchDocument', document);
+            if (!('dryRun' in inserted) && !inserted.inserted)
+                await ctx.db.update('website_search.SearchDocument', { id: document.id }, document);
+        }
+    }
+    const state = await stateFor(ctx, siteId);
+    const written = Number(state?.documentCount ?? 0) + batch.length;
+    await ctx.db.update('website_search.SearchIndexState', { id: String(siteId) }, {
+        state: more ? 'building' : 'ready',
+        cursor: more ? String(batch[batch.length - 1]?.path ?? '') : null,
+        documentCount: written,
+        completedAt: more ? null : new Date().toISOString(),
+    });
+    return { done: !more, written: batch.length };
+};
+//# sourceMappingURL=rebuild.js.map

package/dist/modules/website_search/rebuild.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rebuild.js","sourceRoot":"","sources":["../../../../../../../packages/ketsuite/src/modules/website_search/rebuild.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,mBAAmB,CAAA;AAGzF;;;;;;;GAOG;AAEH,oFAAoF;AACpF,MAAM,CAAC,MAAM,KAAK,GAAG,GAAG,CAAA;AAExB,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,mBAAmB;IACnB,oBAAoB;IACpB,4BAA4B;IAC5B,oCAAoC;IACpC,qCAAqC;IACrC,sCAAsC;IACtC,uCAAuC;CACxC,CAAA;AAED,8EAA8E;AAC9E,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAE,GAAQ,EAAE,MAAe,EAAuB,EAAE;IACjF,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;IACtC,OAAO,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;AACjF,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,EAAE,GAAQ,EAAE,MAAe,EAAuB,EAAE;IAC/E,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAA;IAC1D,OAAO,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAA;AAChE,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAiB,EAAE,IAAS,EAAW,EAAE;IACjE,IAAI,KAAK,EAAE,KAAK,KAAK,OAAO;QAAE,OAAO,KAAK,CAAA;IAC1C,OAAO,MAAM,CAAC,KAAK,CAAC,aAAa,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAA;AACrF,CAAC,CAAA;AAED,MAAM,UAAU,GAAG,CAAC,KAAU,EAAE,QAAa,EAAO,EAAE,CAAC,CAAC;IACtD,EAAE,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE;IACjD,MAAM,EAAE,KAAK,CAAC,MAAM;IACpB,OAAO,EAAE,KAAK,CAAC,EAAE;IACjB,IAAI,EAAE,KAAK,CAAC,IAAI;IAChB,IAAI,EAAE,KAAK,CAAC,IAAI;IAChB,KAAK,EAAE,QAAQ,CAAC,KAAK;IACrB,OAAO,EAAE,QAAQ,CAAC,OAAO,IAAI,IAAI;IACjC,QAAQ,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC,iBAAiB,EAAE;IAC5F,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,IAAI;CACvC,CAAC,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAAE,GAAQ,EAAE,IAAS,EAA+C,EAAE;IACpG,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAA;IACtB,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;IAC5C,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAA;IACrD,MAAM,KAAK,GAAG,QAAQ,EAAE,KAAK,KAAK,UAAU,IAAI,MAAM,CAAC,QAAQ,CAAC,aAAa,IAAI,EAAE,CAAC,KAAK,MAAM,CAAA;IAE/F,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,CAAC,CAAA;IAC1D,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;IAEpC,IAAI,KAAK,EAAE,CAAC;QACV,yEAAyE;QACzE,4DAA4D;QAC5D,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAA;QAC3D,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAA;QACzE,MAAM,GAAG,GAAG;YACV,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC;YAClB,MAAM;YACN,aAAa,EAAE,IAAI,CAAC,mBAAmB,IAAI,IAAI;YAC/C,KAAK,EAAE,UAAU;YACjB,MAAM,EAAE,EAAE;YACV,aAAa,EAAE,CAAC;YAChB,SAAS,EAAE,GAAG;YACd,WAAW,EAAE,IAAI;SAClB,CAAA;QACD,IAAI,QAAQ;YAAE,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,iCAAiC,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;;YAC5F,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,iCAAiC,EAAE,GAAG,CAAC,CAAA;IAClE,CAAC;IAED,2EAA2E;IAC3E,kDAAkD;IAClD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,CAAA;IACxC,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;SACpB,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SAChG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SACxB,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;IACnB,IAAI,MAAM;QAAE,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;IACvD,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACvC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;IACrC,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,CAAA;IAEnC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjB,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAA;QACnD,MAAM,SAAS,GAAG,IAAI,GAAG,EAAe,CAAA;QACxC,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAA;QAC3D,KAAK,MAAM,QAAQ,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,CACrC,IAAI,CAAC,QAAQ,CAAC;aACX,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC;aACvE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CACpC;YACC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAA;QAE9C,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;YAC1B,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAA;YACjE,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,OAAO,KAAK,KAAK,CAAC,EAAE;gBAAE,SAAQ;YACxD,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;YAC5C,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,cAAc,CAAC,+BAA+B,EAAE,QAAQ,CAAC,CAAA;YACvF,IAAI,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ;gBAC/C,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,+BAA+B,EAAE,EAAE,EAAE,EAAE,QAAQ,CAAC,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAA;QACvF,CAAC;IACH,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;IACzC,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,EAAE,aAAa,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAA;IAChE,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,iCAAiC,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE;QAC7E,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO;QAClC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI;QACjE,aAAa,EAAE,OAAO;QACtB,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KAC7C,CAAC,CAAA;IACT,OAAO,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,CAAA;AAC/C,CAAC,CAAA"}

package/dist/modules/website_seo/functions.d.ts

@@ -0,0 +1,3 @@
+import type { FnSpec } from '@ketvietlab/ketjs';
+export declare const functions: Record<string, FnSpec>;
+//# sourceMappingURL=functions.d.ts.map

package/dist/modules/website_seo/functions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"functions.d.ts","sourceRoot":"","sources":["../../../../../../packages/ketsuite/src/modules/website_seo/functions.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAO,MAAM,EAAO,MAAM,mBAAmB,CAAA;AAqBzD,eAAO,MAAM,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAuJ5C,CAAA"}

package/dist/modules/website_seo/functions.js

@@ -0,0 +1,164 @@
+import { asc, defineFn, eq, from, isNotNull, ne } from '@ketvietlab/ketjs';
+import { canAccessSite, canManageStructure } from '../website/access.js';
+import { isReservedPath, reservedPrefixes, safeOgImage, sameSiteCanonical } from './projection.js';
+const MAX_DESCRIPTION = 320;
+const MAX_SITEMAP_URLS = 5_000;
+const invalid = (field, message) => ({ ok: false, errors: [{ field, message }] });
+/** The hosts a canonical is allowed to name: this site's own domains. */
+const hostsForSite = async (ctx, siteId) => {
+    const Domain = ctx.table('website.SiteDomain');
+    const rows = await ctx.db.all(from(Domain).where(eq(Domain.siteId, siteId)));
+    return rows.map((row) => String(row.host));
+};
+const entryById = async (ctx, id) => {
+    const Entry = ctx.table('website.Entry');
+    return ctx.db.one(from(Entry).where(eq(Entry.id, id)));
+};
+export const functions = {
+    /**
+     * The write path the extended fields never had.
+     *
+     * `website_seo` adds metaDescription, canonical, noindex and ogImage to an
+     * Entry it does not own. Editing them through the owning module's saveEntry
+     * would put SEO validation in the content module, so the module that declared
+     * the fields owns writing them, and checks them on the way in.
+     *
+     * `noindex` is consumed today, by the sitemap below. The other three are
+     * stored and read back but not yet rendered: the storefront page scope in
+     * `packages/ketjs/src/server/boot.ts` hands the theme an empty `meta`, so the
+     * `website:page.head` fill has nothing to interpolate. Closing that is a
+     * framework change and belongs in its own review.
+     *
+     * Every field is a partial update. Writing all four on every call meant that
+     * setting `noindex` erased the description, and — worse — that editing a
+     * description silently cleared `noindex` and re-listed a deliberately
+     * delisted page in the sitemap.
+     */
+    saveEntrySeo: defineFn({
+        input: {
+            entryId: 'id',
+            metaDescription: 'text?',
+            canonical: 'text?',
+            noindex: 'bool?',
+            ogImage: 'text?',
+        },
+        output: { ok: 'bool', entryId: 'id?', errors: 'json?' },
+        effects: [
+            'read:website.Entry',
+            'read:website.SiteDomain',
+            'read:website.SiteMember',
+            'write:website.Entry',
+        ],
+        idempotent: true,
+        agent: true,
+        handler: async (ctx, args) => {
+            const entry = await entryById(ctx, args.entryId);
+            if (!entry)
+                return invalid('entryId', 'website_seo.error.entryNotFound');
+            if (!(await canManageStructure(ctx, entry.siteId)))
+                return invalid('entryId', 'website.error.forbidden');
+            const patch = {};
+            if (args.metaDescription !== undefined) {
+                const description = args.metaDescription == null ? '' : String(args.metaDescription).trim();
+                if (description.length > MAX_DESCRIPTION)
+                    return invalid('metaDescription', 'website_seo.error.descriptionTooLong');
+                patch.metaDescription = description || null;
+            }
+            if (args.canonical !== undefined) {
+                const raw = args.canonical == null ? '' : String(args.canonical).trim();
+                if (!raw)
+                    patch.canonical = null;
+                else {
+                    const canonical = sameSiteCanonical(raw, await hostsForSite(ctx, entry.siteId));
+                    if (!canonical)
+                        return invalid('canonical', 'website_seo.error.foreignCanonical');
+                    patch.canonical = canonical;
+                }
+            }
+            if (args.ogImage !== undefined) {
+                const raw = args.ogImage == null ? '' : String(args.ogImage).trim();
+                if (!raw)
+                    patch.ogImage = null;
+                else {
+                    const ogImage = safeOgImage(raw);
+                    if (!ogImage)
+                        return invalid('ogImage', 'website_seo.error.invalidOgImage');
+                    patch.ogImage = ogImage;
+                }
+            }
+            if (args.noindex !== undefined)
+                patch.noindex = args.noindex === true;
+            if (Object.keys(patch).length)
+                await ctx.db.update('website.Entry', { id: args.entryId }, patch);
+            return { ok: true, entryId: args.entryId };
+        },
+    }),
+    getEntrySeo: defineFn({
+        input: { entryId: 'id' },
+        output: {
+            entryId: 'id',
+            metaDescription: 'text?',
+            canonical: 'text?',
+            noindex: 'bool?',
+            ogImage: 'text?',
+        },
+        effects: ['read:website.Entry', 'read:website.SiteMember'],
+        agent: true,
+        handler: async (ctx, args) => {
+            const entry = await entryById(ctx, args.entryId);
+            if (!entry || !(await canAccessSite(ctx, entry.siteId)))
+                return null;
+            return {
+                entryId: entry.id,
+                metaDescription: entry.metaDescription ?? null,
+                canonical: entry.canonical ?? null,
+                noindex: entry.noindex === true,
+                ogImage: entry.ogImage ?? null,
+            };
+        },
+    }),
+    /**
+     * What the sitemap is allowed to contain.
+     *
+     * The filter is the publication itself: an entry appears only when its site is
+     * active, it has a published revision, it is not in trash, it is not marked
+     * noindex and it does not sit under a namespace the deployment serves.
+     * Unpublishing a page therefore removes it here without a second bookkeeping
+     * step that could disagree with the first.
+     *
+     * `exposure: 'internal'` on purpose: the two public files are the entry point,
+     * and they resolve the site from the request host. Left callable, an anonymous
+     * caller could name any siteId in the company and read the published paths of
+     * a site that is not being served yet.
+     */
+    sitemapEntries: defineFn({
+        input: { siteId: 'id' },
+        output: { path: 'text', lastModified: 'datetime?' },
+        effects: ['read:website.Site', 'read:website.Entry'],
+        exposure: 'internal',
+        handler: async (ctx, args) => {
+            const Site = ctx.table('website.Site');
+            const site = await ctx.db.one(from(Site).where(eq(Site.id, args.siteId), eq(Site.active, true)));
+            if (!site)
+                return [];
+            // The publication filter belongs in the query, not after it. Applied as a
+            // plain LIMIT over a path ordering, a site with enough drafts sorting
+            // first returned an empty sitemap while its published pages existed.
+            //
+            // The condition is "has a published revision and is not in trash", not
+            // status === 'published': scheduling a later republish moves an entry to
+            // 'scheduled' while the revision already out there stays live, and a
+            // status filter would delist a page a visitor can still open.
+            const Entry = ctx.table('website.Entry');
+            const rows = await ctx.db.all(from(Entry)
+                .where(eq(Entry.siteId, args.siteId), isNotNull(Entry.publishedRevisionId), ne(Entry.status, 'trash'))
+                .orderBy(asc(Entry.path))
+                .limit(MAX_SITEMAP_URLS));
+            const prefixes = reservedPrefixes(Object.keys(ctx.manifest.routes ?? {}));
+            return rows
+                .filter((row) => row.noindex !== true && !isReservedPath(String(row.path), prefixes))
+                .map((row) => ({ path: String(row.path), lastModified: row.publishedAt ?? null }));
+        },
+    }),
+};
+//# sourceMappingURL=functions.js.map

package/dist/modules/website_seo/functions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"functions.js","sourceRoot":"","sources":["../../../../../../../packages/ketsuite/src/modules/website_seo/functions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,mBAAmB,CAAA;AAE1E,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACxE,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAElG,MAAM,eAAe,GAAG,GAAG,CAAA;AAC3B,MAAM,gBAAgB,GAAG,KAAK,CAAA;AAE9B,MAAM,OAAO,GAAG,CAAC,KAAa,EAAE,OAAe,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAA;AAEjG,yEAAyE;AACzE,MAAM,YAAY,GAAG,KAAK,EAAE,GAAQ,EAAE,MAAe,EAAqB,EAAE;IAC1E,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAA;IAC9C,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAA;IAC5E,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;AAC5C,CAAC,CAAA;AAED,MAAM,SAAS,GAAG,KAAK,EAAE,GAAQ,EAAE,EAAW,EAAuB,EAAE;IACrE,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,CAAA;IACxC,OAAO,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;AACxD,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,SAAS,GAA2B;IAC/C;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,EAAE,QAAQ,CAAC;QACrB,KAAK,EAAE;YACL,OAAO,EAAE,IAAI;YACb,eAAe,EAAE,OAAO;YACxB,SAAS,EAAE,OAAO;YAClB,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,OAAO;SACjB;QACD,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE;QACvD,OAAO,EAAE;YACP,oBAAoB;YACpB,yBAAyB;YACzB,yBAAyB;YACzB,qBAAqB;SACtB;QACD,UAAU,EAAE,IAAI;QAChB,KAAK,EAAE,IAAI;QACX,OAAO,EAAE,KAAK,EAAE,GAAQ,EAAE,IAAI,EAAE,EAAE;YAChC,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;YAChD,IAAI,CAAC,KAAK;gBAAE,OAAO,OAAO,CAAC,SAAS,EAAE,iCAAiC,CAAC,CAAA;YACxE,IAAI,CAAC,CAAC,MAAM,kBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBAAE,OAAO,OAAO,CAAC,SAAS,EAAE,yBAAyB,CAAC,CAAA;YAExG,MAAM,KAAK,GAAQ,EAAE,CAAA;YAErB,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;gBACvC,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,EAAE,CAAA;gBAC3F,IAAI,WAAW,CAAC,MAAM,GAAG,eAAe;oBACtC,OAAO,OAAO,CAAC,iBAAiB,EAAE,sCAAsC,CAAC,CAAA;gBAC3E,KAAK,CAAC,eAAe,GAAG,WAAW,IAAI,IAAI,CAAA;YAC7C,CAAC;YAED,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBACjC,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAA;gBACvE,IAAI,CAAC,GAAG;oBAAE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAA;qBAC3B,CAAC;oBACJ,MAAM,SAAS,GAAG,iBAAiB,CAAC,GAAG,EAAE,MAAM,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;oBAC/E,IAAI,CAAC,SAAS;wBAAE,OAAO,OAAO,CAAC,WAAW,EAAE,oCAAoC,CAAC,CAAA;oBACjF,KAAK,CAAC,SAAS,GAAG,SAAS,CAAA;gBAC7B,CAAC;YACH,CAAC;YAED,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAA;gBACnE,IAAI,CAAC,GAAG;oBAAE,KAAK,CAAC,OAAO,GAAG,IAAI,CAAA;qBACzB,CAAC;oBACJ,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;oBAChC,IAAI,CAAC,OAAO;wBAAE,OAAO,OAAO,CAAC,SAAS,EAAE,kCAAkC,CAAC,CAAA;oBAC3E,KAAK,CAAC,OAAO,GAAG,OAAO,CAAA;gBACzB,CAAC;YACH,CAAC;YAED,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS;gBAAE,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,KAAK,IAAI,CAAA;YAErE,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM;gBAAE,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,CAAA;YAChG,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAA;QAC5C,CAAC;KACF,CAAC;IAEF,WAAW,EAAE,QAAQ,CAAC;QACpB,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;QACxB,MAAM,EAAE;YACN,OAAO,EAAE,IAAI;YACb,eAAe,EAAE,OAAO;YACxB,SAAS,EAAE,OAAO;YAClB,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,OAAO;SACjB;QACD,OAAO,EAAE,CAAC,oBAAoB,EAAE,yBAAyB,CAAC;QAC1D,KAAK,EAAE,IAAI;QACX,OAAO,EAAE,KAAK,EAAE,GAAQ,EAAE,IAAI,EAAE,EAAE;YAChC,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;YAChD,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,MAAM,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBAAE,OAAO,IAAI,CAAA;YACpE,OAAO;gBACL,OAAO,EAAE,KAAK,CAAC,EAAE;gBACjB,eAAe,EAAE,KAAK,CAAC,eAAe,IAAI,IAAI;gBAC9C,SAAS,EAAE,KAAK,CAAC,SAAS,IAAI,IAAI;gBAClC,OAAO,EAAE,KAAK,CAAC,OAAO,KAAK,IAAI;gBAC/B,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;aAC/B,CAAA;QACH,CAAC;KACF,CAAC;IAEF;;;;;;;;;;;;;OAaG;IACH,cAAc,EAAE,QAAQ,CAAC;QACvB,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;QACvB,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE;QACnD,OAAO,EAAE,CAAC,mBAAmB,EAAE,oBAAoB,CAAC;QACpD,QAAQ,EAAE,UAAU;QACpB,OAAO,EAAE,KAAK,EAAE,GAAQ,EAAE,IAAI,EAAE,EAAE;YAChC,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;YACtC,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;YAChG,IAAI,CAAC,IAAI;gBAAE,OAAO,EAAE,CAAA;YAEpB,0EAA0E;YAC1E,sEAAsE;YACtE,qEAAqE;YACrE,EAAE;YACF,uEAAuE;YACvE,yEAAyE;YACzE,qEAAqE;YACrE,8DAA8D;YAC9D,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,CAAA;YACxC,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,CAC3B,IAAI,CAAC,KAAK,CAAC;iBACR,KAAK,CACJ,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,EAC7B,SAAS,CAAC,KAAK,CAAC,mBAAmB,CAAC,EACpC,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAC1B;iBACA,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;iBACxB,KAAK,CAAC,gBAAgB,CAAC,CAC3B,CAAA;YACD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAA;YACzE,OAAO,IAAI;iBACR,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,KAAK,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC;iBACpF,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI,EAAE,CAAC,CAAC,CAAA;QACtF,CAAC;KACF,CAAC;CACH,CAAA"}

package/dist/modules/website_seo/index.js

@@ -1,30 +1,40 @@
 import { defineModule } from '@ketvietlab/ketjs';
 import { extend } from './extend.js';
 import { fills } from './fills.js';
+import { functions } from './functions.js';
+import { routes } from './routes.js';
 import { views } from './views.js';
 export default defineModule({
     name: 'website_seo',
     version: '0.1.0',
-    app: true,
     title: 'SEO',
-    summary: 'Thẻ mô tả, canonical và noindex cho từng trang.',
+    summary: 'Thẻ mô tả, canonical, sitemap và robots cho từng website.',
     category: 'Website',
     messages: {
         vi: {
             'app.title': 'SEO',
-            'app.summary': 'Thẻ mô tả, canonical và noindex cho từng trang.',
+            'app.summary': 'Thẻ mô tả, canonical, sitemap và robots cho từng website.',
             'app.category': 'Website',
+            'error.entryNotFound': 'Không tìm thấy nội dung.',
+            'error.descriptionTooLong': 'Mô tả vượt quá 320 ký tự.',
+            'error.foreignCanonical': 'Canonical phải trỏ về chính website này.',
+            'error.invalidOgImage': 'Ảnh chia sẻ phải là đường dẫn nội bộ hoặc URL http(s).',
         },
         en: {
             'app.title': 'SEO',
-            'app.summary': 'Description, canonical and noindex tags per page.',
+            'app.summary': 'Description, canonical, sitemap and robots per site.',
             'app.category': 'Website',
+            'error.entryNotFound': 'Content not found.',
+            'error.descriptionTooLong': 'The description exceeds 320 characters.',
+            'error.foreignCanonical': 'A canonical must point back at this site.',
+            'error.invalidOgImage': 'The share image must be an internal path or an http(s) URL.',
         },
     },
-    autoInstall: true,
     depends: ['website'],
     extend,
     fills,
+    functions,
+    routes,
     views,
 });
 //# sourceMappingURL=index.js.map

package/dist/modules/website_seo/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/ketsuite/src/modules/website_seo/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAElC,eAAe,YAAY,CAAC;IAC1B,IAAI,EAAE,aAAa;IACnB,OAAO,EAAE,OAAO;IAChB,GAAG,EAAE,IAAI;IACT,KAAK,EAAE,KAAK;IACZ,OAAO,EAAE,iDAAiD;IAC1D,QAAQ,EAAE,SAAS;IACnB,QAAQ,EAAE;QACR,EAAE,EAAE;YACF,WAAW,EAAE,KAAK;YAClB,aAAa,EAAE,iDAAiD;YAChE,cAAc,EAAE,SAAS;SAC1B;QACD,EAAE,EAAE;YACF,WAAW,EAAE,KAAK;YAClB,aAAa,EAAE,mDAAmD;YAClE,cAAc,EAAE,SAAS;SAC1B;KACF;IACD,WAAW,EAAE,IAAI;IACjB,OAAO,EAAE,CAAC,SAAS,CAAC;IACpB,MAAM;IACN,KAAK;IACL,KAAK;CACN,CAAC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/ketsuite/src/modules/website_seo/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAElC,eAAe,YAAY,CAAC;IAC1B,IAAI,EAAE,aAAa;IACnB,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,KAAK;IACZ,OAAO,EAAE,2DAA2D;IACpE,QAAQ,EAAE,SAAS;IACnB,QAAQ,EAAE;QACR,EAAE,EAAE;YACF,WAAW,EAAE,KAAK;YAClB,aAAa,EAAE,2DAA2D;YAC1E,cAAc,EAAE,SAAS;YACzB,qBAAqB,EAAE,0BAA0B;YACjD,0BAA0B,EAAE,2BAA2B;YACvD,wBAAwB,EAAE,0CAA0C;YACpE,sBAAsB,EAAE,wDAAwD;SACjF;QACD,EAAE,EAAE;YACF,WAAW,EAAE,KAAK;YAClB,aAAa,EAAE,sDAAsD;YACrE,cAAc,EAAE,SAAS;YACzB,qBAAqB,EAAE,oBAAoB;YAC3C,0BAA0B,EAAE,yCAAyC;YACrE,wBAAwB,EAAE,2CAA2C;YACrE,sBAAsB,EAAE,6DAA6D;SACtF;KACF;IACD,OAAO,EAAE,CAAC,SAAS,CAAC;IACpB,MAAM;IACN,KAAK;IACL,SAAS;IACT,MAAM;IACN,KAAK;CACN,CAAC,CAAA"}

package/dist/modules/website_seo/projection.d.ts

@@ -0,0 +1,52 @@
+/**
+ * The public projection: what a crawler is allowed to be told about a site.
+ *
+ * Everything here is a pure function over already-authorised data. The database
+ * reads and the permission checks live in `functions.ts`; keeping the rendering
+ * separate is what lets a test assert the escaping and the reserved-path rules
+ * without booting an adapter.
+ */
+export { isReservedPath, reservedPrefixes } from '../website/paths.ts';
+/** Escape a value for XML text and attribute content alike. */
+export declare const escapeXml: (value: string) => string;
+/**
+ * A canonical URL may only point back at the site that declares it.
+ *
+ * A canonical pointing elsewhere hands the site's ranking to whoever owns that
+ * host, so this is a permission decision rather than a formatting preference.
+ *
+ * The relative branch is the one that needs care. A leading `/` does not make a
+ * value site-relative: a browser resolves `//other.example/x`, `/\other.example/x`
+ * and `/<TAB>/other.example/x` all to that other host, because a backslash is
+ * normalised to a slash for http(s) and because tab, CR and LF are stripped from
+ * a URL before it is parsed. So the rules here mirror `website.cleanPath`, which
+ * already refuses exactly this class, rather than testing for `//` alone.
+ *
+ * Returns the normalised canonical, or null when the value cannot be trusted.
+ */
+export declare const sameSiteCanonical: (value: unknown, hosts: readonly string[]) => string | null;
+/**
+ * An og:image may be a site-relative path or an absolute http(s) URL. The
+ * relative form is held to the same rules as a canonical, for the same reason.
+ */
+export declare const safeOgImage: (value: unknown) => string | null;
+export type SitemapEntry = {
+    path: string;
+    lastModified?: string | null;
+};
+/**
+ * Render a urlset. Entries are expected to be already filtered — this renders
+ * what it is given and does not decide what is publishable.
+ */
+export declare const sitemapXml: (origin: string, entries: readonly SitemapEntry[]) => string;
+/**
+ * Render robots.txt.
+ *
+ * A site that is not serving content publicly disallows everything: content
+ * being prepared should not be discovered while it is being prepared.
+ */
+export declare const robotsTxt: (origin: string, options: {
+    indexable: boolean;
+    prefixes: readonly string[];
+}) => string;
+//# sourceMappingURL=projection.d.ts.map

package/dist/modules/website_seo/projection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"projection.d.ts","sourceRoot":"","sources":["../../../../../../packages/ketsuite/src/modules/website_seo/projection.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AAUtE,+DAA+D;AAC/D,eAAO,MAAM,SAAS,UAAW,MAAM,KAAG,MAAoE,CAAA;AAE9G;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iBAAiB,UAAW,OAAO,SAAS,SAAS,MAAM,EAAE,KAAG,MAAM,GAAG,IA8BrF,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,UAAW,OAAO,KAAG,MAAM,GAAG,IAYrD,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAAA;AAEzE;;;GAGG;AACH,eAAO,MAAM,UAAU,WAAY,MAAM,WAAW,SAAS,YAAY,EAAE,KAAG,MAU7E,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,SAAS,WACZ,MAAM,WACL;IAAE,SAAS,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,KAC3D,MAUF,CAAA"}