@cogenta/widgets 0.2.3

package/dist/store.js

@@ -0,0 +1,263 @@
+import { CogentaError, identifier, newId, sql, } from '@cogenta/core';
+import { jsonColumn, textColumn, timestampColumn, uuidColumn } from '@cogenta/schema';
+import { isWidgetAreaId } from './areas.js';
+import { validateWidgetVisibility } from './visibility.js';
+import { validateWidgetSettings } from './vocabulary.js';
+/**
+ * The widgets of a site: one fixed table (`cogenta_widgets`), created and
+ * edited at runtime from the admin, the same shape as the menus.
+ *
+ * Every write goes through the vocabulary's validation, so a stored widget
+ * always renders. An area is a free key, not a foreign key to anything: a
+ * widget whose area the active theme does not offer is kept, and the admin
+ * lists it as inactive, the way WordPress keeps widgets across a theme switch.
+ */
+export const WIDGETS_TABLE = 'cogenta_widgets';
+export async function ensureWidgetTables(db) {
+    const dialect = db.dialect;
+    const table = identifier(WIDGETS_TABLE, dialect);
+    await db.query(sql `create table if not exists ${table} (
+    ${identifier('id', dialect)} ${uuidColumn(dialect)} not null primary key,
+    ${identifier('area', dialect)} ${textColumn(dialect, 64)} not null,
+    ${identifier('position', dialect)} integer not null,
+    ${identifier('type', dialect)} ${textColumn(dialect, 64)} not null,
+    ${identifier('title', dialect)} ${textColumn(dialect, 255)},
+    ${identifier('settings', dialect)} ${jsonColumn()} not null,
+    ${identifier('visibility', dialect)} ${jsonColumn()} not null,
+    ${identifier('enabled', dialect)} ${textColumn(dialect, 8)} not null,
+    ${identifier('created_at', dialect)} ${timestampColumn(dialect)} not null,
+    ${identifier('updated_at', dialect)} ${timestampColumn(dialect)} not null,
+    ${identifier('updated_by', dialect)} ${textColumn(dialect, 64)}
+  )`);
+    await db
+        .query(sql `create index ${identifier('cogenta_widgets_area_position', dialect)} on ${table} (${identifier('area', dialect)}, ${identifier('position', dialect)})`)
+        .catch(() => undefined);
+}
+const UUID = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/iu;
+function text(value) {
+    return typeof value === 'string' ? value : String(value);
+}
+function areaInvalid(area) {
+    return new CogentaError({
+        code: 'WIDGET_INVALID',
+        message: `"${String(area)}" is not a widget area key.`,
+        hint: 'An area key is lower case letters, digits and dashes, such as "sidebar" or "footer-1".',
+        details: { area },
+    });
+}
+function notFound(id) {
+    return new CogentaError({
+        code: 'WIDGET_NOT_FOUND',
+        message: `No widget "${id}".`,
+        hint: 'It may already have been deleted. Reload the widget list.',
+        details: { id },
+    });
+}
+function titleOf(value) {
+    if (value === undefined || value === null)
+        return null;
+    const trimmed = value.trim();
+    if (trimmed.length > 255) {
+        throw new CogentaError({
+            code: 'WIDGET_INVALID',
+            message: 'A widget title is at most 255 characters.',
+            hint: 'Shorten the title.',
+        });
+    }
+    return trimmed.length === 0 ? null : trimmed;
+}
+export function createWidgetStore(options) {
+    const { db } = options;
+    const dialect = db.dialect;
+    const now = options.now ?? (() => new Date());
+    const mintId = options.newId ?? newId;
+    const table = identifier(WIDGETS_TABLE, dialect);
+    const id = identifier('id', dialect);
+    const area = identifier('area', dialect);
+    const position = identifier('position', dialect);
+    function toWidget(row) {
+        return {
+            id: text(row['id']),
+            area: text(row['area']),
+            position: Number(row['position']),
+            type: text(row['type']),
+            title: row['title'] === null || row['title'] === undefined ? null : text(row['title']),
+            settings: JSON.parse(text(row['settings'])),
+            visibility: JSON.parse(text(row['visibility'])),
+            enabled: text(row['enabled']) === 'true',
+            createdAt: text(row['created_at']),
+            updatedAt: text(row['updated_at']),
+            updatedBy: row['updated_by'] === null || row['updated_by'] === undefined
+                ? null
+                : text(row['updated_by']),
+        };
+    }
+    async function rowOf(tx, widgetId) {
+        // Postgres types the column as `uuid` and refuses to compare it with any
+        // other string, so an id that cannot exist is answered here, identically
+        // on every dialect.
+        if (!UUID.test(widgetId))
+            return null;
+        const found = await tx.query(sql `select * from ${table} where ${id} = ${widgetId}`);
+        return found.rows[0] ?? null;
+    }
+    async function areaIds(tx, areaKey, except) {
+        const found = await tx.query(sql `select ${id} from ${table} where ${area} = ${areaKey} order by ${position} asc, ${identifier('created_at', dialect)} asc`);
+        return found.rows.map((row) => text(row['id'])).filter((value) => value !== except);
+    }
+    /** Writes positions 0..n for the ids, in order, into the area. */
+    async function writeOrder(tx, areaKey, ids, stamp, updatedBy, touched) {
+        for (const [index, widgetId] of ids.entries()) {
+            if (widgetId === touched) {
+                await tx.query(sql `update ${table} set ${area} = ${areaKey}, ${position} = ${index}, ${identifier('updated_at', dialect)} = ${stamp}, ${identifier('updated_by', dialect)} = ${updatedBy} where ${id} = ${widgetId}`);
+            }
+            else {
+                await tx.query(sql `update ${table} set ${position} = ${index} where ${id} = ${widgetId}`);
+            }
+        }
+    }
+    const store = {
+        async list(listOptions) {
+            const found = listOptions?.area === undefined
+                ? await db.query(sql `select * from ${table} order by ${area} asc, ${position} asc, ${identifier('created_at', dialect)} asc`)
+                : await db.query(sql `select * from ${table} where ${area} = ${listOptions.area} order by ${position} asc, ${identifier('created_at', dialect)} asc`);
+            return found.rows.map(toWidget);
+        },
+        async read(widgetId) {
+            const row = await rowOf(db, widgetId);
+            return row === null ? null : toWidget(row);
+        },
+        create: (input) => db.transaction(async (tx) => {
+            if (!isWidgetAreaId(input.area))
+                throw areaInvalid(input.area);
+            const settings = validateWidgetSettings(input.type, input.settings, options.extraTypes);
+            const visibility = validateWidgetVisibility(input.visibility);
+            const widgetId = input.id ?? mintId();
+            if (!UUID.test(widgetId)) {
+                throw new CogentaError({
+                    code: 'WIDGET_INVALID',
+                    message: `"${widgetId}" is not a widget id.`,
+                    hint: 'Leave the id out to have one minted, or pass a UUID.',
+                });
+            }
+            const stamp = now().toISOString();
+            const siblings = await areaIds(tx, input.area);
+            const index = input.position === undefined
+                ? siblings.length
+                : Math.max(0, Math.min(siblings.length, Math.trunc(input.position)));
+            await tx.query(sql `insert into ${table} (
+            ${id}, ${area}, ${position}, ${identifier('type', dialect)}, ${identifier('title', dialect)},
+            ${identifier('settings', dialect)}, ${identifier('visibility', dialect)}, ${identifier('enabled', dialect)},
+            ${identifier('created_at', dialect)}, ${identifier('updated_at', dialect)}, ${identifier('updated_by', dialect)}
+          ) values (
+            ${widgetId}, ${input.area}, ${index}, ${input.type}, ${titleOf(input.title)},
+            ${JSON.stringify(settings)}, ${JSON.stringify(visibility)}, ${String(input.enabled ?? true)},
+            ${stamp}, ${stamp}, ${input.updatedBy ?? null}
+          )`);
+            const order = [...siblings];
+            order.splice(index, 0, widgetId);
+            await writeOrder(tx, input.area, order, stamp, input.updatedBy ?? null, null);
+            const row = await rowOf(tx, widgetId);
+            if (row === null)
+                throw notFound(widgetId);
+            return toWidget(row);
+        }, { immediate: true }),
+        update: (widgetId, input) => db.transaction(async (tx) => {
+            const row = await rowOf(tx, widgetId);
+            if (row === null)
+                throw notFound(widgetId);
+            const current = toWidget(row);
+            const settings = input.settings === undefined
+                ? current.settings
+                : validateWidgetSettings(current.type, input.settings, options.extraTypes);
+            const visibility = input.visibility === undefined
+                ? current.visibility
+                : validateWidgetVisibility(input.visibility);
+            const title = input.title === undefined ? current.title : titleOf(input.title);
+            const enabled = input.enabled ?? current.enabled;
+            await tx.query(sql `update ${table} set
+            ${identifier('title', dialect)} = ${title},
+            ${identifier('settings', dialect)} = ${JSON.stringify(settings)},
+            ${identifier('visibility', dialect)} = ${JSON.stringify(visibility)},
+            ${identifier('enabled', dialect)} = ${String(enabled)},
+            ${identifier('updated_at', dialect)} = ${now().toISOString()},
+            ${identifier('updated_by', dialect)} = ${input.updatedBy ?? null}
+            where ${id} = ${widgetId}`);
+            const updated = await rowOf(tx, widgetId);
+            if (updated === null)
+                throw notFound(widgetId);
+            return toWidget(updated);
+        }, { immediate: true }),
+        delete: (widgetId) => db.transaction(async (tx) => {
+            const row = await rowOf(tx, widgetId);
+            if (row === null)
+                return false;
+            await tx.query(sql `delete from ${table} where ${id} = ${widgetId}`);
+            const areaKey = text(row['area']);
+            await writeOrder(tx, areaKey, await areaIds(tx, areaKey), '', null, null);
+            return true;
+        }, { immediate: true }),
+        move: (widgetId, target) => db.transaction(async (tx) => {
+            if (!isWidgetAreaId(target.area))
+                throw areaInvalid(target.area);
+            const row = await rowOf(tx, widgetId);
+            if (row === null)
+                throw notFound(widgetId);
+            const from = text(row['area']);
+            const stamp = now().toISOString();
+            const destination = await areaIds(tx, target.area, widgetId);
+            const index = Math.max(0, Math.min(destination.length, Math.trunc(target.position)));
+            destination.splice(index, 0, widgetId);
+            await writeOrder(tx, target.area, destination, stamp, target.updatedBy ?? null, widgetId);
+            if (from !== target.area) {
+                await writeOrder(tx, from, await areaIds(tx, from), stamp, null, null);
+            }
+            const moved = await rowOf(tx, widgetId);
+            if (moved === null)
+                throw notFound(widgetId);
+            return toWidget(moved);
+        }, { immediate: true }),
+        reorder: (areaKey, ids, updatedBy) => db.transaction(async (tx) => {
+            if (!isWidgetAreaId(areaKey))
+                throw areaInvalid(areaKey);
+            const current = await areaIds(tx, areaKey);
+            const same = current.length === ids.length &&
+                new Set(ids).size === ids.length &&
+                ids.every((widgetId) => current.includes(widgetId));
+            if (!same) {
+                throw new CogentaError({
+                    code: 'WIDGET_INVALID',
+                    message: `A new order for "${areaKey}" must list exactly the widgets of that area, once each.`,
+                    hint: 'Reload the widget list: someone may have added or removed a widget meanwhile.',
+                    details: { area: areaKey, expected: current, received: ids },
+                });
+            }
+            const stamp = now().toISOString();
+            await writeOrder(tx, areaKey, ids, stamp, updatedBy ?? null, null);
+            const found = await tx.query(sql `select * from ${table} where ${area} = ${areaKey} order by ${position} asc`);
+            return found.rows.map(toWidget);
+        }, { immediate: true }),
+        async duplicate(widgetId, updatedBy) {
+            const original = await store.read(widgetId);
+            if (original === null)
+                throw notFound(widgetId);
+            return store.create({
+                area: original.area,
+                type: original.type,
+                title: original.title,
+                settings: original.settings,
+                visibility: original.visibility,
+                enabled: false,
+                position: original.position + 1,
+                updatedBy: updatedBy ?? null,
+            });
+        },
+        async clear() {
+            const found = await db.query(sql `select count(*) as n from ${table}`);
+            await db.query(sql `delete from ${table}`);
+            return Number(found.rows[0]?.['n'] ?? 0);
+        },
+    };
+    return store;
+}
+//# sourceMappingURL=store.js.map

package/dist/store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.js","sourceRoot":"","sources":["../src/store.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAEZ,UAAU,EACV,KAAK,EAEL,GAAG,GACJ,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACrF,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAC3C,OAAO,EAAE,wBAAwB,EAAyB,MAAM,iBAAiB,CAAA;AACjF,OAAO,EAAyB,sBAAsB,EAAmB,MAAM,iBAAiB,CAAA;AAEhG;;;;;;;;GAQG;AAEH,MAAM,CAAC,MAAM,aAAa,GAAG,iBAAiB,CAAA;AA4E9C,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,EAAkB;IACzD,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAA;IAC1B,MAAM,KAAK,GAAG,UAAU,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;IAChD,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,CAAA,8BAA8B,KAAK;MACjD,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC;MAChD,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;MACtD,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC;MAC/B,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;MACtD,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC;MACxD,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,UAAU,EAAE;MAC/C,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,IAAI,UAAU,EAAE;MACjD,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;MACxD,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,IAAI,eAAe,CAAC,OAAO,CAAC;MAC7D,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,IAAI,eAAe,CAAC,OAAO,CAAC;MAC7D,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;IAC9D,CAAC,CAAA;IACH,MAAM,EAAE;SACL,KAAK,CACJ,GAAG,CAAA,gBAAgB,UAAU,CAAC,+BAA+B,EAAE,OAAO,CAAC,OAAO,KAAK,KAAK,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,GAAG,CAC3J;SACA,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAA;AAC3B,CAAC;AAID,MAAM,IAAI,GAAG,kEAAkE,CAAA;AAE/E,SAAS,IAAI,CAAC,KAAc;IAC1B,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC1D,CAAC;AAED,SAAS,WAAW,CAAC,IAAa;IAChC,OAAO,IAAI,YAAY,CAAC;QACtB,IAAI,EAAE,gBAAgB;QACtB,OAAO,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,6BAA6B;QACtD,IAAI,EAAE,wFAAwF;QAC9F,OAAO,EAAE,EAAE,IAAI,EAAE;KAClB,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,EAAU;IAC1B,OAAO,IAAI,YAAY,CAAC;QACtB,IAAI,EAAE,kBAAkB;QACxB,OAAO,EAAE,cAAc,EAAE,IAAI;QAC7B,IAAI,EAAE,2DAA2D;QACjE,OAAO,EAAE,EAAE,EAAE,EAAE;KAChB,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,KAAgC;IAC/C,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IACtD,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;IAC5B,IAAI,OAAO,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QACzB,MAAM,IAAI,YAAY,CAAC;YACrB,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,2CAA2C;YACpD,IAAI,EAAE,oBAAoB;SAC3B,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAA;AAC9C,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,OAA2B;IAC3D,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAA;IACtB,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAA;IAC1B,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC,GAAS,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,CAAA;IACnD,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,IAAI,KAAK,CAAA;IACrC,MAAM,KAAK,GAAG,UAAU,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;IAChD,MAAM,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IACpC,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACxC,MAAM,QAAQ,GAAG,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;IAEhD,SAAS,QAAQ,CAAC,GAAQ;QACxB,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACnB,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACvB,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACjC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAe;YACrC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,IAAI,GAAG,CAAC,OAAO,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACtF,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAA4B;YACtE,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAqB;YACnE,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,MAAM;YACxC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAClC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAClC,SAAS,EACP,GAAG,CAAC,YAAY,CAAC,KAAK,IAAI,IAAI,GAAG,CAAC,YAAY,CAAC,KAAK,SAAS;gBAC3D,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;SAC9B,CAAA;IACH,CAAC;IAED,KAAK,UAAU,KAAK,CAAC,EAAe,EAAE,QAAgB;QACpD,yEAAyE;QACzE,yEAAyE;QACzE,oBAAoB;QACpB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YAAE,OAAO,IAAI,CAAA;QACrC,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,KAAK,CAAM,GAAG,CAAA,iBAAiB,KAAK,UAAU,EAAE,MAAM,QAAQ,EAAE,CAAC,CAAA;QACxF,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;IAC9B,CAAC;IAED,KAAK,UAAU,OAAO,CAAC,EAAe,EAAE,OAAe,EAAE,MAAe;QACtE,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,KAAK,CAC1B,GAAG,CAAA,UAAU,EAAE,SAAS,KAAK,UAAU,IAAI,MAAM,OAAO,aAAa,QAAQ,SAAS,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,CAC9H,CAAA;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,MAAM,CAAC,CAAA;IACrF,CAAC;IAED,kEAAkE;IAClE,KAAK,UAAU,UAAU,CACvB,EAAe,EACf,OAAe,EACf,GAAsB,EACtB,KAAa,EACb,SAAwB,EACxB,OAAsB;QAEtB,KAAK,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;YAC9C,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;gBACzB,MAAM,EAAE,CAAC,KAAK,CACZ,GAAG,CAAA,UAAU,KAAK,QAAQ,IAAI,MAAM,OAAO,KAAK,QAAQ,MAAM,KAAK,KAAK,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,KAAK,KAAK,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,SAAS,UAAU,EAAE,MAAM,QAAQ,EAAE,CACtM,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,CAAA,UAAU,KAAK,QAAQ,QAAQ,MAAM,KAAK,UAAU,EAAE,MAAM,QAAQ,EAAE,CAAC,CAAA;YAC3F,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,KAAK,GAAgB;QACzB,KAAK,CAAC,IAAI,CAAC,WAAW;YACpB,MAAM,KAAK,GACT,WAAW,EAAE,IAAI,KAAK,SAAS;gBAC7B,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CACZ,GAAG,CAAA,iBAAiB,KAAK,aAAa,IAAI,SAAS,QAAQ,SAAS,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,CAC5G;gBACH,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CACZ,GAAG,CAAA,iBAAiB,KAAK,UAAU,IAAI,MAAM,WAAW,CAAC,IAAI,aAAa,QAAQ,SAAS,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,CACnI,CAAA;YACP,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACjC,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,QAAQ;YACjB,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;YACrC,OAAO,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;QAC5C,CAAC;QAED,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAChB,EAAE,CAAC,WAAW,CACZ,KAAK,EAAE,EAAE,EAAE,EAAE;YACX,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC;gBAAE,MAAM,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAC9D,MAAM,QAAQ,GAAG,sBAAsB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;YACvF,MAAM,UAAU,GAAG,wBAAwB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;YAC7D,MAAM,QAAQ,GAAG,KAAK,CAAC,EAAE,IAAI,MAAM,EAAE,CAAA;YACrC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACzB,MAAM,IAAI,YAAY,CAAC;oBACrB,IAAI,EAAE,gBAAgB;oBACtB,OAAO,EAAE,IAAI,QAAQ,uBAAuB;oBAC5C,IAAI,EAAE,sDAAsD;iBAC7D,CAAC,CAAA;YACJ,CAAC;YACD,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,WAAW,EAAE,CAAA;YACjC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;YAC9C,MAAM,KAAK,GACT,KAAK,CAAC,QAAQ,KAAK,SAAS;gBAC1B,CAAC,CAAC,QAAQ,CAAC,MAAM;gBACjB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;YACxE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,CAAA,eAAe,KAAK;cAClC,EAAE,KAAK,IAAI,KAAK,QAAQ,KAAK,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC;cACzF,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,KAAK,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,KAAK,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC;cACxG,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,KAAK,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,KAAK,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC;;cAE7G,QAAQ,KAAK,KAAK,CAAC,IAAI,KAAK,KAAK,KAAK,KAAK,CAAC,IAAc,KAAK,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;cACnF,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC;cACzF,KAAK,KAAK,KAAK,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI;YAC7C,CAAC,CAAA;YACH,MAAM,KAAK,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAA;YAC3B,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAA;YAChC,MAAM,UAAU,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,SAAS,IAAI,IAAI,EAAE,IAAI,CAAC,CAAA;YAC7E,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;YACrC,IAAI,GAAG,KAAK,IAAI;gBAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAA;YAC1C,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAA;QACtB,CAAC,EACD,EAAE,SAAS,EAAE,IAAI,EAAE,CACpB;QAEH,MAAM,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAC1B,EAAE,CAAC,WAAW,CACZ,KAAK,EAAE,EAAE,EAAE,EAAE;YACX,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;YACrC,IAAI,GAAG,KAAK,IAAI;gBAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAA;YAC1C,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;YAC7B,MAAM,QAAQ,GACZ,KAAK,CAAC,QAAQ,KAAK,SAAS;gBAC1B,CAAC,CAAC,OAAO,CAAC,QAAQ;gBAClB,CAAC,CAAC,sBAAsB,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;YAC9E,MAAM,UAAU,GACd,KAAK,CAAC,UAAU,KAAK,SAAS;gBAC5B,CAAC,CAAC,OAAO,CAAC,UAAU;gBACpB,CAAC,CAAC,wBAAwB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;YAChD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YAC9E,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAA;YAChD,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,CAAA,UAAU,KAAK;cAC7B,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,KAAK;cACvC,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;cAC7D,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;cACjE,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC;cACnD,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,GAAG,EAAE,CAAC,WAAW,EAAE;cAC1D,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,KAAK,CAAC,SAAS,IAAI,IAAI;oBACxD,EAAE,MAAM,QAAQ,EAAE,CAAC,CAAA;YAC7B,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;YACzC,IAAI,OAAO,KAAK,IAAI;gBAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAA;YAC9C,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAA;QAC1B,CAAC,EACD,EAAE,SAAS,EAAE,IAAI,EAAE,CACpB;QAEH,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CACnB,EAAE,CAAC,WAAW,CACZ,KAAK,EAAE,EAAE,EAAE,EAAE;YACX,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;YACrC,IAAI,GAAG,KAAK,IAAI;gBAAE,OAAO,KAAK,CAAA;YAC9B,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,CAAA,eAAe,KAAK,UAAU,EAAE,MAAM,QAAQ,EAAE,CAAC,CAAA;YACnE,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;YACjC,MAAM,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;YACzE,OAAO,IAAI,CAAA;QACb,CAAC,EACD,EAAE,SAAS,EAAE,IAAI,EAAE,CACpB;QAEH,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,CACzB,EAAE,CAAC,WAAW,CACZ,KAAK,EAAE,EAAE,EAAE,EAAE;YACX,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC;gBAAE,MAAM,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAChE,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;YACrC,IAAI,GAAG,KAAK,IAAI;gBAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAA;YAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;YAC9B,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,WAAW,EAAE,CAAA;YACjC,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;YAC5D,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;YACpF,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAA;YACtC,MAAM,UAAU,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,IAAI,IAAI,EAAE,QAAQ,CAAC,CAAA;YACzF,IAAI,IAAI,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;gBACzB,MAAM,UAAU,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;YACxE,CAAC;YACD,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;YACvC,IAAI,KAAK,KAAK,IAAI;gBAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAA;YAC5C,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAA;QACxB,CAAC,EACD,EAAE,SAAS,EAAE,IAAI,EAAE,CACpB;QAEH,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE,CACnC,EAAE,CAAC,WAAW,CACZ,KAAK,EAAE,EAAE,EAAE,EAAE;YACX,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;gBAAE,MAAM,WAAW,CAAC,OAAO,CAAC,CAAA;YACxD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;YAC1C,MAAM,IAAI,GACR,OAAO,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM;gBAC7B,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,MAAM;gBAChC,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAA;YACrD,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,IAAI,YAAY,CAAC;oBACrB,IAAI,EAAE,gBAAgB;oBACtB,OAAO,EAAE,oBAAoB,OAAO,0DAA0D;oBAC9F,IAAI,EAAE,+EAA+E;oBACrF,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE;iBAC7D,CAAC,CAAA;YACJ,CAAC;YACD,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,WAAW,EAAE,CAAA;YACjC,MAAM,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,IAAI,IAAI,EAAE,IAAI,CAAC,CAAA;YAClE,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,KAAK,CAC1B,GAAG,CAAA,iBAAiB,KAAK,UAAU,IAAI,MAAM,OAAO,aAAa,QAAQ,MAAM,CAChF,CAAA;YACD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACjC,CAAC,EACD,EAAE,SAAS,EAAE,IAAI,EAAE,CACpB;QAEH,KAAK,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAS;YACjC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC3C,IAAI,QAAQ,KAAK,IAAI;gBAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAA;YAC/C,OAAO,KAAK,CAAC,MAAM,CAAC;gBAClB,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;gBAC3B,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,OAAO,EAAE,KAAK;gBACd,QAAQ,EAAE,QAAQ,CAAC,QAAQ,GAAG,CAAC;gBAC/B,SAAS,EAAE,SAAS,IAAI,IAAI;aAC7B,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,KAAK;YACT,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,KAAK,CAAM,GAAG,CAAA,6BAA6B,KAAK,EAAE,CAAC,CAAA;YAC1E,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,CAAA,eAAe,KAAK,EAAE,CAAC,CAAA;YACzC,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;QAC1C,CAAC;KACF,CAAA;IACD,OAAO,KAAK,CAAA;AACd,CAAC"}

package/dist/visibility.d.ts

@@ -0,0 +1,86 @@
+import { z } from 'zod';
+export declare const pageTargetSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"home">;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"collection">;
+    collection: z.ZodString;
+    entryIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"taxonomy">;
+    taxonomy: z.ZodString;
+    termIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"dateArchive">;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"search">;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"path">;
+    path: z.ZodString;
+}, z.core.$strict>], "kind">;
+export type PageTarget = z.infer<typeof pageTargetSchema>;
+export declare const widgetVisibilitySchema: z.ZodObject<{
+    pages: z.ZodDefault<z.ZodObject<{
+        mode: z.ZodDefault<z.ZodEnum<{
+            all: "all";
+            except: "except";
+            only: "only";
+        }>>;
+        targets: z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            kind: z.ZodLiteral<"home">;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"collection">;
+            collection: z.ZodString;
+            entryIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"taxonomy">;
+            taxonomy: z.ZodString;
+            termIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"dateArchive">;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"search">;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"path">;
+            path: z.ZodString;
+        }, z.core.$strict>], "kind">>>;
+    }, z.core.$strict>>;
+    audience: z.ZodDefault<z.ZodEnum<{
+        everyone: "everyone";
+        members: "members";
+        visitors: "visitors";
+    }>>;
+    devices: z.ZodDefault<z.ZodObject<{
+        desktop: z.ZodDefault<z.ZodBoolean>;
+        tablet: z.ZodDefault<z.ZodBoolean>;
+        mobile: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strict>>;
+    from: z.ZodDefault<z.ZodNullable<z.ZodISODateTime>>;
+    until: z.ZodDefault<z.ZodNullable<z.ZodISODateTime>>;
+    locales: z.ZodDefault<z.ZodArray<z.ZodString>>;
+}, z.core.$strict>;
+export type WidgetVisibility = z.infer<typeof widgetVisibilitySchema>;
+export declare const DEFAULT_VISIBILITY: WidgetVisibility;
+export declare function validateWidgetVisibility(input: unknown): WidgetVisibility;
+/** What the host knows about the page being rendered. */
+export interface WidgetRequestContext {
+    readonly path: string;
+    readonly kind: 'home' | 'entry' | 'taxonomy' | 'dateArchive' | 'search' | 'other';
+    readonly collection?: string;
+    readonly entryId?: string;
+    readonly taxonomy?: string;
+    readonly termId?: string;
+    readonly signedIn: boolean;
+    readonly locale: string;
+    readonly now: Date;
+}
+export declare function targetMatches(target: PageTarget, context: WidgetRequestContext): boolean;
+/**
+ * Whether a widget shows on this request. Devices are not decided here: the
+ * same cached page serves every screen, so they travel to the markup as
+ * attributes and the stylesheet hides what a screen should not see.
+ */
+export declare function isWidgetVisible(widget: {
+    readonly enabled: boolean;
+    readonly visibility: WidgetVisibility;
+}, context: WidgetRequestContext): boolean;
+//# sourceMappingURL=visibility.d.ts.map

package/dist/visibility.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"visibility.d.ts","sourceRoot":"","sources":["../src/visibility.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAUvB,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;4BA0B3B,CAAA;AAEF,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAEzD,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAqBjC,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAErE,eAAO,MAAM,kBAAkB,EAAE,gBAAmD,CAAA;AAEpF,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAwBzE;AAED,yDAAyD;AACzD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,aAAa,GAAG,QAAQ,GAAG,OAAO,CAAA;IACjF,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAA;CACnB;AAaD,wBAAgB,aAAa,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,oBAAoB,GAAG,OAAO,CA2BxF;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE;IAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAA;CAAE,EAC5E,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAaT"}

package/dist/visibility.js

@@ -0,0 +1,141 @@
+import { CogentaError } from '@cogenta/core';
+import { z } from 'zod';
+/**
+ * Where, for whom, on what and when a widget shows (L30 D4) — the rules the
+ * WordPress visibility extensions add, as data, evaluated by one pure function
+ * so the admin preview and the public site can never disagree.
+ */
+const identifierLike = z.string().trim().min(1).max(128);
+export const pageTargetSchema = z.discriminatedUnion('kind', [
+    z.strictObject({ kind: z.literal('home') }),
+    z.strictObject({
+        kind: z.literal('collection'),
+        collection: identifierLike,
+        /** Absent or empty: every entry of the collection. */
+        entryIds: z.array(identifierLike).max(200).optional(),
+    }),
+    z.strictObject({
+        kind: z.literal('taxonomy'),
+        taxonomy: identifierLike,
+        /** Absent or empty: every term's archive. */
+        termIds: z.array(identifierLike).max(200).optional(),
+    }),
+    z.strictObject({ kind: z.literal('dateArchive') }),
+    z.strictObject({ kind: z.literal('search') }),
+    z.strictObject({
+        kind: z.literal('path'),
+        /** A site path; `/guides/*` matches everything below `/guides/`. */
+        path: z
+            .string()
+            .trim()
+            .min(1)
+            .max(512)
+            .refine((value) => value.startsWith('/'), { message: 'must start with "/"' }),
+    }),
+]);
+export const widgetVisibilitySchema = z.strictObject({
+    pages: z
+        .strictObject({
+        mode: z.enum(['all', 'only', 'except']).default('all'),
+        targets: z.array(pageTargetSchema).max(100).default([]),
+    })
+        .default({ mode: 'all', targets: [] }),
+    audience: z.enum(['everyone', 'visitors', 'members']).default('everyone'),
+    devices: z
+        .strictObject({
+        desktop: z.boolean().default(true),
+        tablet: z.boolean().default(true),
+        mobile: z.boolean().default(true),
+    })
+        .default({ desktop: true, tablet: true, mobile: true }),
+    /** ISO 8601; the widget shows from this instant. */
+    from: z.iso.datetime({ offset: true }).nullable().default(null),
+    /** ISO 8601; the widget stops showing at this instant. */
+    until: z.iso.datetime({ offset: true }).nullable().default(null),
+    /** Empty: every language of the site. */
+    locales: z.array(z.string().trim().min(2).max(16)).max(50).default([]),
+});
+export const DEFAULT_VISIBILITY = widgetVisibilitySchema.parse({});
+export function validateWidgetVisibility(input) {
+    const parsed = widgetVisibilitySchema.safeParse(input ?? {});
+    if (!parsed.success) {
+        const issue = parsed.error.issues[0];
+        throw new CogentaError({
+            code: 'WIDGET_INVALID',
+            message: `The widget's visibility rules are not valid at "${issue?.path.join('.') ?? ''}": ${issue?.message ?? 'unknown problem'}.`,
+            hint: 'Pages take a mode (all, only, except) and targets; audience is everyone, visitors or members; dates are ISO 8601.',
+            details: { issues: parsed.error.issues.map((item) => item.message) },
+        });
+    }
+    const value = parsed.data;
+    if (value.from !== null &&
+        value.until !== null &&
+        Date.parse(value.from) >= Date.parse(value.until)) {
+        throw new CogentaError({
+            code: 'WIDGET_INVALID',
+            message: 'A widget cannot stop showing before it starts.',
+            hint: 'Set "until" after "from", or clear one of them.',
+        });
+    }
+    return value;
+}
+function pathMatches(pattern, path) {
+    const normalise = (value) => value.length > 1 && value.endsWith('/') ? value.slice(0, -1) : value;
+    if (pattern.endsWith('/*')) {
+        const base = normalise(pattern.slice(0, -2));
+        const current = normalise(path);
+        return current === base || current.startsWith(`${base === '/' ? '' : base}/`);
+    }
+    return normalise(pattern) === normalise(path);
+}
+export function targetMatches(target, context) {
+    switch (target.kind) {
+        case 'home':
+            return context.kind === 'home';
+        case 'collection':
+            return (context.kind === 'entry' &&
+                context.collection === target.collection &&
+                (target.entryIds === undefined ||
+                    target.entryIds.length === 0 ||
+                    (context.entryId !== undefined && target.entryIds.includes(context.entryId))));
+        case 'taxonomy':
+            return (context.kind === 'taxonomy' &&
+                context.taxonomy === target.taxonomy &&
+                (target.termIds === undefined ||
+                    target.termIds.length === 0 ||
+                    (context.termId !== undefined && target.termIds.includes(context.termId))));
+        case 'dateArchive':
+            return context.kind === 'dateArchive';
+        case 'search':
+            return context.kind === 'search';
+        case 'path':
+            return pathMatches(target.path, context.path);
+    }
+}
+/**
+ * Whether a widget shows on this request. Devices are not decided here: the
+ * same cached page serves every screen, so they travel to the markup as
+ * attributes and the stylesheet hides what a screen should not see.
+ */
+export function isWidgetVisible(widget, context) {
+    if (!widget.enabled)
+        return false;
+    const { visibility } = widget;
+    if (visibility.audience === 'visitors' && context.signedIn)
+        return false;
+    if (visibility.audience === 'members' && !context.signedIn)
+        return false;
+    if (visibility.locales.length > 0 && !visibility.locales.includes(context.locale))
+        return false;
+    const now = context.now.getTime();
+    if (visibility.from !== null && now < Date.parse(visibility.from))
+        return false;
+    if (visibility.until !== null && now >= Date.parse(visibility.until))
+        return false;
+    const { mode, targets } = visibility.pages;
+    if (mode === 'all')
+        return true;
+    const matched = targets.some((target) => targetMatches(target, context));
+    return mode === 'only' ? matched : !matched;
+}
+//# sourceMappingURL=visibility.js.map

package/dist/visibility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"visibility.js","sourceRoot":"","sources":["../src/visibility.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;;;GAIG;AAEH,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AAExD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAC3D,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;IAC3C,CAAC,CAAC,YAAY,CAAC;QACb,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;QAC7B,UAAU,EAAE,cAAc;QAC1B,sDAAsD;QACtD,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;KACtD,CAAC;IACF,CAAC,CAAC,YAAY,CAAC;QACb,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QAC3B,QAAQ,EAAE,cAAc;QACxB,6CAA6C;QAC7C,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;KACrD,CAAC;IACF,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;IAClD,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC7C,CAAC,CAAC,YAAY,CAAC;QACb,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QACvB,oEAAoE;QACpE,IAAI,EAAE,CAAC;aACJ,MAAM,EAAE;aACR,IAAI,EAAE;aACN,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,GAAG,CAAC;aACR,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC;KAChF,CAAC;CACH,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,YAAY,CAAC;IACnD,KAAK,EAAE,CAAC;SACL,YAAY,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;QACtD,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;KACxD,CAAC;SACD,OAAO,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACxC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;IACzE,OAAO,EAAE,CAAC;SACP,YAAY,CAAC;QACZ,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;QAClC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;QACjC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;KAClC,CAAC;SACD,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACzD,oDAAoD;IACpD,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IAC/D,0DAA0D;IAC1D,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IAChE,yCAAyC;IACzC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;CACvE,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,kBAAkB,GAAqB,sBAAsB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;AAEpF,MAAM,UAAU,wBAAwB,CAAC,KAAc;IACrD,MAAM,MAAM,GAAG,sBAAsB,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE,CAAC,CAAA;IAC5D,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QACpC,MAAM,IAAI,YAAY,CAAC;YACrB,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,mDAAmD,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,EAAE,OAAO,IAAI,iBAAiB,GAAG;YACnI,IAAI,EAAE,mHAAmH;YACzH,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;SACrE,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAA;IACzB,IACE,KAAK,CAAC,IAAI,KAAK,IAAI;QACnB,KAAK,CAAC,KAAK,KAAK,IAAI;QACpB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EACjD,CAAC;QACD,MAAM,IAAI,YAAY,CAAC;YACrB,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,gDAAgD;YACzD,IAAI,EAAE,iDAAiD;SACxD,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAeD,SAAS,WAAW,CAAC,OAAe,EAAE,IAAY;IAChD,MAAM,SAAS,GAAG,CAAC,KAAa,EAAU,EAAE,CAC1C,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;IACtE,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;QAC5C,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,CAAA;QAC/B,OAAO,OAAO,KAAK,IAAI,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAA;IAC/E,CAAC;IACD,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,SAAS,CAAC,IAAI,CAAC,CAAA;AAC/C,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAkB,EAAE,OAA6B;IAC7E,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,MAAM;YACT,OAAO,OAAO,CAAC,IAAI,KAAK,MAAM,CAAA;QAChC,KAAK,YAAY;YACf,OAAO,CACL,OAAO,CAAC,IAAI,KAAK,OAAO;gBACxB,OAAO,CAAC,UAAU,KAAK,MAAM,CAAC,UAAU;gBACxC,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS;oBAC5B,MAAM,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC;oBAC5B,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAChF,CAAA;QACH,KAAK,UAAU;YACb,OAAO,CACL,OAAO,CAAC,IAAI,KAAK,UAAU;gBAC3B,OAAO,CAAC,QAAQ,KAAK,MAAM,CAAC,QAAQ;gBACpC,CAAC,MAAM,CAAC,OAAO,KAAK,SAAS;oBAC3B,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;oBAC3B,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAC7E,CAAA;QACH,KAAK,aAAa;YAChB,OAAO,OAAO,CAAC,IAAI,KAAK,aAAa,CAAA;QACvC,KAAK,QAAQ;YACX,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAA;QAClC,KAAK,MAAM;YACT,OAAO,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;IACjD,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAC7B,MAA4E,EAC5E,OAA6B;IAE7B,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,OAAO,KAAK,CAAA;IACjC,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAA;IAC7B,IAAI,UAAU,CAAC,QAAQ,KAAK,UAAU,IAAI,OAAO,CAAC,QAAQ;QAAE,OAAO,KAAK,CAAA;IACxE,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,QAAQ;QAAE,OAAO,KAAK,CAAA;IACxE,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,OAAO,KAAK,CAAA;IAC/F,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,CAAA;IACjC,IAAI,UAAU,CAAC,IAAI,KAAK,IAAI,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAA;IAC/E,IAAI,UAAU,CAAC,KAAK,KAAK,IAAI,IAAI,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IAClF,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,KAAK,CAAA;IAC1C,IAAI,IAAI,KAAK,KAAK;QAAE,OAAO,IAAI,CAAA;IAC/B,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACxE,OAAO,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;AAC7C,CAAC"}