@datum-cloud/strapi-revalidate 0.1.0

package/dist/types/strapi.d.ts

@@ -0,0 +1,103 @@
+/**
+ * Type definitions for Strapi v5 content types.
+ *
+ * These mirror the shape returned by the default Strapi v5 GraphQL API.
+ * They are intentionally narrow: only fields that strapi-revalidate's
+ * built-in helpers query are included. Consumers fetching custom content
+ * types should declare their own interfaces and pass them through
+ * `createStrapiClient().query<T>()`.
+ */
+/** A single Strapi media format (thumbnail, small, medium, large). */
+export interface StrapiImageFormat {
+    url: string;
+    width?: number;
+    height?: number;
+}
+/** A Strapi media asset with optional responsive formats. */
+export interface StrapiImage {
+    url: string;
+    alternativeText?: string;
+    caption?: string;
+    width?: number;
+    height?: number;
+    formats?: {
+        thumbnail?: StrapiImageFormat;
+        small?: StrapiImageFormat;
+        medium?: StrapiImageFormat;
+        large?: StrapiImageFormat;
+    };
+}
+/** Minimal author reference embedded in other content types. */
+export interface StrapiAuthor {
+    documentId?: string;
+    slug?: string;
+    name: string;
+    isTeam?: boolean;
+    avatar?: StrapiImage;
+}
+/** Social handles for a Strapi author. */
+export interface StrapiSocial {
+    twitter?: string;
+    linkedin?: string;
+    github?: string;
+    discord?: string;
+    email?: string;
+}
+/** Full author record (Strapi `author` content type). */
+export interface StrapiAuthorFull {
+    documentId: string;
+    slug?: string;
+    name: string;
+    title?: string;
+    bio?: string;
+    isTeam?: boolean;
+    team?: string;
+    avatar?: StrapiImage;
+    social?: StrapiSocial;
+    location?: string;
+    timezone?: string;
+}
+/** GraphQL response shape for the `authors` query. */
+export interface StrapiAuthorsResponse {
+    authors: StrapiAuthorFull[];
+}
+/** Category reference on an article. */
+export interface StrapiCategory {
+    name: string;
+    slug: string;
+}
+/** SEO component fields. */
+export interface StrapiSeo {
+    metaTitle?: string;
+    metaDescription?: string;
+    ogTitle?: string;
+    ogDescription?: string;
+    shareImage?: {
+        url?: string;
+    };
+}
+/** A block of an article body (Strapi Dynamic Zone entry). */
+export interface StrapiBlock {
+    __typename?: string;
+    id?: string;
+    body?: string;
+    title?: string;
+}
+/** Article record (Strapi `article` content type). */
+export interface StrapiArticle {
+    documentId: string;
+    title: string;
+    slug: string;
+    description?: string;
+    originalPublishedAt?: string;
+    blocks?: StrapiBlock[];
+    cover?: StrapiImage;
+    author?: StrapiAuthor;
+    category?: StrapiCategory;
+    seo?: StrapiSeo;
+}
+/** GraphQL response shape for the `articles` query. */
+export interface StrapiArticlesResponse {
+    articles: StrapiArticle[];
+}
+//# sourceMappingURL=strapi.d.ts.map

package/dist/types/strapi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"strapi.d.ts","sourceRoot":"","sources":["../../src/types/strapi.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,sEAAsE;AACtE,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,6DAA6D;AAC7D,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE;QACR,SAAS,CAAC,EAAE,iBAAiB,CAAC;QAC9B,KAAK,CAAC,EAAE,iBAAiB,CAAC;QAC1B,MAAM,CAAC,EAAE,iBAAiB,CAAC;QAC3B,KAAK,CAAC,EAAE,iBAAiB,CAAC;KAC3B,CAAC;CACH;AAED,gEAAgE;AAChE,MAAM,WAAW,YAAY;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,0CAA0C;AAC1C,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yDAAyD;AACzD,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,sDAAsD;AACtD,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,gBAAgB,EAAE,CAAC;CAC7B;AAED,wCAAwC;AACxC,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,4BAA4B;AAC5B,MAAM,WAAW,SAAS;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/B;AAED,8DAA8D;AAC9D,MAAM,WAAW,WAAW;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,sDAAsD;AACtD,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,GAAG,CAAC,EAAE,SAAS,CAAC;CACjB;AAED,uDAAuD;AACvD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B"}

package/dist/types/strapi.js

@@ -0,0 +1,11 @@
+/**
+ * Type definitions for Strapi v5 content types.
+ *
+ * These mirror the shape returned by the default Strapi v5 GraphQL API.
+ * They are intentionally narrow: only fields that strapi-revalidate's
+ * built-in helpers query are included. Consumers fetching custom content
+ * types should declare their own interfaces and pass them through
+ * `createStrapiClient().query<T>()`.
+ */
+export {};
+//# sourceMappingURL=strapi.js.map

package/dist/types/strapi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"strapi.js","sourceRoot":"","sources":["../../src/types/strapi.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}

package/dist/webhook/handler.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Framework-agnostic webhook handler.
+ *
+ * `createWebhookHandler(config)` returns an `async (req, res) => void`
+ * function whose `req` and `res` accept the lowest-common-denominator
+ * shapes used by Astro, Next.js (Route Handlers), SvelteKit, Express,
+ * and raw Node http. Each framework's docs page in the README shows the
+ * single line of glue code needed.
+ *
+ * Behaviour:
+ *  1. 405 if method isn't POST.
+ *  2. 401 if a secret is configured and the request's secret doesn't match
+ *     (constant-time compare; supports `Authorization: Bearer <secret>`,
+ *     `X-Strapi-Signature`, or a raw `strapi-webhook-secret` header).
+ *  3. 400 if the body isn't a parseable Strapi v5 webhook payload.
+ *  4. Resolves tags via `mapModelToTags`, calls `cache.invalidate(tag)` for
+ *     each, and invokes `onRevalidate` if configured.
+ *  5. 200 with `{ ok: true, tags }`.
+ */
+import type { CacheManager } from '../cache/manager.js';
+import type { RevalidateConfig, RevalidateConfigInput } from '../types/config.js';
+import type { WebhookRequest, WebhookResponse } from './types.js';
+/** Async function shape returned by `createWebhookHandler`. */
+export type WebhookHandler = (req: WebhookRequest, res: WebhookResponse) => Promise<void>;
+/**
+ * Build a webhook handler bound to a validated config and the cache
+ * manager derived from it.
+ *
+ * Accepts either a `RevalidateConfigInput` (raw user object — gets validated)
+ * or a pair of pre-built dependencies, so power users can share a single
+ * `CacheManager` across handlers and content fetchers.
+ */
+export declare function createWebhookHandler(input: RevalidateConfigInput): WebhookHandler;
+export declare function createWebhookHandler(deps: {
+    config: RevalidateConfig;
+    cache: CacheManager;
+}): WebhookHandler;
+//# sourceMappingURL=handler.d.ts.map

package/dist/webhook/handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../src/webhook/handler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAIH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,KAAK,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAElF,OAAO,KAAK,EAGV,cAAc,EACd,eAAe,EAChB,MAAM,YAAY,CAAC;AAEpB,+DAA+D;AAC/D,MAAM,MAAM,cAAc,GAAG,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAE1F;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,qBAAqB,GAAG,cAAc,CAAC;AACnF,wBAAgB,oBAAoB,CAAC,IAAI,EAAE;IACzC,MAAM,EAAE,gBAAgB,CAAC;IACzB,KAAK,EAAE,YAAY,CAAC;CACrB,GAAG,cAAc,CAAC"}

package/dist/webhook/handler.js

@@ -0,0 +1,156 @@
+/**
+ * Framework-agnostic webhook handler.
+ *
+ * `createWebhookHandler(config)` returns an `async (req, res) => void`
+ * function whose `req` and `res` accept the lowest-common-denominator
+ * shapes used by Astro, Next.js (Route Handlers), SvelteKit, Express,
+ * and raw Node http. Each framework's docs page in the README shows the
+ * single line of glue code needed.
+ *
+ * Behaviour:
+ *  1. 405 if method isn't POST.
+ *  2. 401 if a secret is configured and the request's secret doesn't match
+ *     (constant-time compare; supports `Authorization: Bearer <secret>`,
+ *     `X-Strapi-Signature`, or a raw `strapi-webhook-secret` header).
+ *  3. 400 if the body isn't a parseable Strapi v5 webhook payload.
+ *  4. Resolves tags via `mapModelToTags`, calls `cache.invalidate(tag)` for
+ *     each, and invokes `onRevalidate` if configured.
+ *  5. 200 with `{ ok: true, tags }`.
+ */
+import { timingSafeEqual } from 'node:crypto';
+import { createCache } from '../cache/index.js';
+import { revalidateConfigSchema } from '../types/config.js';
+import { mapModelToTags } from './tags.js';
+export function createWebhookHandler(input) {
+    const { config, cache } = resolveDeps(input);
+    return async function handle(req, res) {
+        if (req.method && req.method.toUpperCase() !== 'POST') {
+            res.status(405);
+            res.json({ ok: false, error: 'Method not allowed' });
+            return;
+        }
+        const configuredSecret = config.webhook?.secret;
+        if (configuredSecret) {
+            const provided = readSecret(req);
+            if (!provided || !constantTimeEqual(provided, configuredSecret)) {
+                res.status(401);
+                res.json({ ok: false, error: 'Invalid secret' });
+                return;
+            }
+        }
+        let payload;
+        try {
+            payload = await readPayload(req);
+        }
+        catch (err) {
+            res.status(400);
+            res.json({
+                ok: false,
+                error: err instanceof Error ? err.message : 'Bad payload',
+            });
+            return;
+        }
+        const tags = mapModelToTags(payload, config.webhook?.tagMap);
+        for (const tag of tags) {
+            await cache.invalidate(tag);
+        }
+        const event = {
+            event: payload.event,
+            model: payload.model,
+            uid: payload.uid,
+            entryId: payload.entry.documentId,
+            slug: typeof payload.entry.slug === 'string' ? payload.entry.slug : undefined,
+            tags,
+        };
+        if (config.webhook?.onRevalidate) {
+            try {
+                await config.webhook.onRevalidate(event);
+            }
+            catch (err) {
+                // The cache is already invalidated; surface the hook failure to the caller
+                // but treat the revalidation itself as successful.
+                console.error('[strapi-revalidate] onRevalidate hook threw:', err);
+            }
+        }
+        res.status(200);
+        res.json({ ok: true, tags });
+    };
+}
+function resolveDeps(input) {
+    if (isPreBuilt(input))
+        return input;
+    const config = revalidateConfigSchema.parse(input);
+    const cache = createCache(config);
+    return { config, cache };
+}
+function isPreBuilt(value) {
+    return (typeof value === 'object' &&
+        value !== null &&
+        'config' in value &&
+        'cache' in value &&
+        typeof value.cache === 'object');
+}
+function readSecret(req) {
+    // Headers can arrive as Fetch-style Headers (`.get()`) or as a plain map.
+    const direct = headerValue(req, 'authorization');
+    if (direct) {
+        const match = /^Bearer\s+(.+)$/i.exec(direct);
+        if (match)
+            return match[1].trim();
+    }
+    return (headerValue(req, 'x-strapi-signature') ??
+        headerValue(req, 'strapi-webhook-secret') ??
+        null);
+}
+function headerValue(req, name) {
+    const headers = req.headers;
+    if (typeof headers.get === 'function') {
+        return headers.get(name);
+    }
+    const lower = name.toLowerCase();
+    const raw = headers[lower] ?? headers[name];
+    if (typeof raw === 'string')
+        return raw;
+    if (Array.isArray(raw) && typeof raw[0] === 'string')
+        return raw[0];
+    return null;
+}
+async function readPayload(req) {
+    let raw;
+    if (typeof req.json === 'function') {
+        raw = await req.json();
+    }
+    else if (typeof req.text === 'function') {
+        const text = await req.text();
+        raw = text.length > 0 ? JSON.parse(text) : {};
+    }
+    else {
+        throw new Error('Request object exposes neither json() nor text()');
+    }
+    if (!isWebhookPayload(raw)) {
+        throw new Error('Payload is not a valid Strapi v5 webhook event');
+    }
+    return raw;
+}
+function isWebhookPayload(value) {
+    if (typeof value !== 'object' || value === null)
+        return false;
+    const v = value;
+    if (typeof v.event !== 'string' || typeof v.model !== 'string' || typeof v.uid !== 'string') {
+        return false;
+    }
+    if (typeof v.entry !== 'object' || v.entry === null)
+        return false;
+    const entry = v.entry;
+    return typeof entry.documentId === 'string' || typeof entry.id === 'number';
+}
+function constantTimeEqual(a, b) {
+    // timingSafeEqual requires equal-length buffers; pad both to the longer length so the
+    // length check itself is constant-time-safe (different lengths still return false).
+    const bufA = Buffer.from(a, 'utf-8');
+    const bufB = Buffer.from(b, 'utf-8');
+    if (bufA.length !== bufB.length)
+        return false;
+    return timingSafeEqual(bufA, bufB);
+}
+//# sourceMappingURL=handler.js.map

package/dist/webhook/handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.js","sourceRoot":"","sources":["../../src/webhook/handler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAE5D,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAwB3C,MAAM,UAAU,oBAAoB,CAClC,KAAgF;IAEhF,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAE7C,OAAO,KAAK,UAAU,MAAM,CAAC,GAAG,EAAE,GAAG;QACnC,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;YACtD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAChB,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC,CAAC;YACrD,OAAO;QACT,CAAC;QAED,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC;QAChD,IAAI,gBAAgB,EAAE,CAAC;YACrB,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,CAAC,QAAQ,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,EAAE,CAAC;gBAChE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAChB,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC,CAAC;gBACjD,OAAO;YACT,CAAC;QACH,CAAC;QAED,IAAI,OAAuB,CAAC;QAC5B,IAAI,CAAC;YACH,OAAO,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAChB,GAAG,CAAC,IAAI,CAAC;gBACP,EAAE,EAAE,KAAK;gBACT,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa;aAC1D,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC7D,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC9B,CAAC;QAED,MAAM,KAAK,GAAiB;YAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,UAAU;YACjC,IAAI,EAAE,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YAC7E,IAAI;SACL,CAAC;QAEF,IAAI,MAAM,CAAC,OAAO,EAAE,YAAY,EAAE,CAAC;YACjC,IAAI,CAAC;gBACH,MAAM,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC3C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,2EAA2E;gBAC3E,mDAAmD;gBACnD,OAAO,CAAC,KAAK,CAAC,8CAA8C,EAAE,GAAG,CAAC,CAAC;YACrE,CAAC;QACH,CAAC;QAED,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAChB,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/B,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAClB,KAAgF;IAEhF,IAAI,UAAU,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACpC,MAAM,MAAM,GAAG,sBAAsB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACnD,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IAClC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AAC3B,CAAC;AAED,SAAS,UAAU,CACjB,KAAc;IAEd,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,QAAQ,IAAI,KAAK;QACjB,OAAO,IAAI,KAAK;QAChB,OAAQ,KAA4B,CAAC,KAAK,KAAK,QAAQ,CACxD,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,GAAmB;IACrC,0EAA0E;IAC1E,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;IACjD,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,KAAK;YAAE,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACpC,CAAC;IAED,OAAO,CACL,WAAW,CAAC,GAAG,EAAE,oBAAoB,CAAC;QACtC,WAAW,CAAC,GAAG,EAAE,uBAAuB,CAAC;QACzC,IAAI,CACL,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,GAAmB,EAAE,IAAY;IACpD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAC5B,IAAI,OAAO,OAAO,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;QACtC,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACjC,MAAM,GAAG,GAAI,OAAmC,CAAC,KAAK,CAAC,IAAK,OAAmC,CAAC,IAAI,CAAC,CAAC;IACtG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,GAAG,CAAC;IACxC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,KAAK,QAAQ;QAAE,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;IACpE,OAAO,IAAI,CAAC;AACd,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,GAAmB;IAC5C,IAAI,GAAY,CAAC;IACjB,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QACnC,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;SAAM,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC9B,GAAG,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAChD,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAC9D,MAAM,CAAC,GAAG,KAAgC,CAAC;IAC3C,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5F,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,CAAC,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAClE,MAAM,KAAK,GAAG,CAAC,CAAC,KAAgC,CAAC;IACjD,OAAO,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,CAAC;AAC9E,CAAC;AAED,SAAS,iBAAiB,CAAC,CAAS,EAAE,CAAS;IAC7C,sFAAsF;IACtF,oFAAoF;IACpF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACrC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACrC,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IAC9C,OAAO,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACrC,CAAC"}

package/dist/webhook/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Public webhook surface — re-exports for the `strapi-revalidate/webhook`
+ * subpath.
+ */
+export { createWebhookHandler } from './handler.js';
+export type { WebhookHandler } from './handler.js';
+export { mapModelToTags } from './tags.js';
+export type { WebhookEvent, WebhookEventName, WebhookPayload, WebhookRequest, WebhookResponse, } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/webhook/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/webhook/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACpD,YAAY,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,YAAY,EACV,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,cAAc,EACd,eAAe,GAChB,MAAM,YAAY,CAAC"}

package/dist/webhook/index.js

@@ -0,0 +1,7 @@
+/**
+ * Public webhook surface — re-exports for the `strapi-revalidate/webhook`
+ * subpath.
+ */
+export { createWebhookHandler } from './handler.js';
+export { mapModelToTags } from './tags.js';
+//# sourceMappingURL=index.js.map

package/dist/webhook/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/webhook/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEpD,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC"}

package/dist/webhook/tags.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Strapi UID → cache tag mapping.
+ *
+ * Default rules:
+ *  - `api::article.article` → `["articles"]` (+ `article:<slug>` if entry has slug)
+ *  - `api::author.author`   → `["authors"]`  (+ `author:<slug>` if entry has slug)
+ *  - any other `api::<name>.<name>` → `[<name>]` (+ `<name>:<slug>` if present)
+ *
+ * Override per-UID via `config.webhook.tagMap` — passing `["foo", "bar"]`
+ * replaces the default tag list for that UID (the slug-derived tag is still
+ * appended automatically when present).
+ */
+import type { WebhookPayload } from './types.js';
+/**
+ * Resolve cache tags for a webhook payload.
+ *
+ * @param payload - Raw Strapi v5 webhook payload.
+ * @param overrides - Optional UID → tag list overrides from config.
+ * @returns Deduplicated list of tags to invalidate.
+ */
+export declare function mapModelToTags(payload: WebhookPayload, overrides?: Record<string, string[]>): string[];
+//# sourceMappingURL=tags.d.ts.map

package/dist/webhook/tags.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.d.ts","sourceRoot":"","sources":["../../src/webhook/tags.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAQjD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,OAAO,EAAE,cAAc,EACvB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GACnC,MAAM,EAAE,CAKV"}

package/dist/webhook/tags.js

@@ -0,0 +1,39 @@
+/**
+ * Strapi UID → cache tag mapping.
+ *
+ * Default rules:
+ *  - `api::article.article` → `["articles"]` (+ `article:<slug>` if entry has slug)
+ *  - `api::author.author`   → `["authors"]`  (+ `author:<slug>` if entry has slug)
+ *  - any other `api::<name>.<name>` → `[<name>]` (+ `<name>:<slug>` if present)
+ *
+ * Override per-UID via `config.webhook.tagMap` — passing `["foo", "bar"]`
+ * replaces the default tag list for that UID (the slug-derived tag is still
+ * appended automatically when present).
+ */
+/** Built-in UID → tag list. */
+const DEFAULT_TAG_MAP = {
+    'api::article.article': ['articles'],
+    'api::author.author': ['authors'],
+};
+/**
+ * Resolve cache tags for a webhook payload.
+ *
+ * @param payload - Raw Strapi v5 webhook payload.
+ * @param overrides - Optional UID → tag list overrides from config.
+ * @returns Deduplicated list of tags to invalidate.
+ */
+export function mapModelToTags(payload, overrides) {
+    const base = overrides?.[payload.uid] ?? DEFAULT_TAG_MAP[payload.uid] ?? [extractModel(payload)];
+    const slug = typeof payload.entry?.slug === 'string' ? payload.entry.slug : undefined;
+    const tags = slug ? [...base, `${payload.model}:${slug}`] : base;
+    return Array.from(new Set(tags));
+}
+/**
+ * Extract the model name from a UID. `api::article.article` → `article`.
+ * Falls back to `payload.model` if the UID is in an unexpected shape.
+ */
+function extractModel(payload) {
+    const match = /^api::([^.]+)\./.exec(payload.uid);
+    return match?.[1] ?? payload.model;
+}
+//# sourceMappingURL=tags.js.map

package/dist/webhook/tags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.js","sourceRoot":"","sources":["../../src/webhook/tags.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAIH,+BAA+B;AAC/B,MAAM,eAAe,GAA6B;IAChD,sBAAsB,EAAE,CAAC,UAAU,CAAC;IACpC,oBAAoB,EAAE,CAAC,SAAS,CAAC;CAClC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAC5B,OAAuB,EACvB,SAAoC;IAEpC,MAAM,IAAI,GAAG,SAAS,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;IACjG,MAAM,IAAI,GAAG,OAAO,OAAO,CAAC,KAAK,EAAE,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IACtF,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACjE,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AACnC,CAAC;AAED;;;GAGG;AACH,SAAS,YAAY,CAAC,OAAuB;IAC3C,MAAM,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC;AACrC,CAAC"}

package/dist/webhook/types.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Strapi v5 webhook payload types and the normalized event surfaced to
+ * downstream handlers.
+ */
+/** All webhook event names Strapi v5 emits. */
+export type WebhookEventName = 'entry.create' | 'entry.update' | 'entry.delete' | 'entry.publish' | 'entry.unpublish' | 'media.create' | 'media.update' | 'media.delete';
+/** Raw payload Strapi v5 POSTs to the webhook URL. */
+export interface WebhookPayload {
+    event: WebhookEventName;
+    createdAt: string;
+    /** Singular model name, e.g. `"article"`. */
+    model: string;
+    /** Strapi UID, e.g. `"api::article.article"`. */
+    uid: string;
+    entry: {
+        id: number;
+        documentId: string;
+        slug?: string;
+        [key: string]: unknown;
+    };
+}
+/** Normalized event passed to `onRevalidate` after tag resolution. */
+export interface WebhookEvent {
+    event: WebhookEventName;
+    model: string;
+    uid: string;
+    entryId: string;
+    slug?: string;
+    /** Cache tags resolved from `uid` (and `slug`, if present). */
+    tags: string[];
+}
+/**
+ * Minimal request interface the webhook handler accepts.
+ *
+ * Designed so an Astro `APIContext.request`, a Next.js `Request`, a
+ * SvelteKit `RequestEvent.request`, an Express `req`, and a Node
+ * `IncomingMessage` can all satisfy it (after light adapter code in the
+ * user's route handler).
+ */
+export interface WebhookRequest {
+    method?: string;
+    headers: {
+        get?: (name: string) => string | null;
+        [key: string]: unknown;
+    };
+    text?: () => Promise<string>;
+    json?: () => Promise<unknown>;
+}
+/**
+ * Minimal response interface the webhook handler writes to.
+ *
+ * The handler always calls `status(code)` first and then `json(body)`. Both
+ * calls are independent — `status()`'s return value is ignored — so adapters
+ * in framework routes can be a few lines of capture-and-forward.
+ */
+export interface WebhookResponse {
+    status: (code: number) => unknown;
+    json: (body: unknown) => void | Promise<void>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/webhook/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/webhook/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,+CAA+C;AAC/C,MAAM,MAAM,gBAAgB,GACxB,cAAc,GACd,cAAc,GACd,cAAc,GACd,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,cAAc,GACd,cAAc,CAAC;AAEnB,sDAAsD;AACtD,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,gBAAgB,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE;QACL,EAAE,EAAE,MAAM,CAAC;QACX,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH;AAED,sEAAsE;AACtE,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,gBAAgB,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE;QACP,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAC;QACtC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,IAAI,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;IAClC,IAAI,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/C"}

package/dist/webhook/types.js

@@ -0,0 +1,6 @@
+/**
+ * Strapi v5 webhook payload types and the normalized event surfaced to
+ * downstream handlers.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/webhook/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/webhook/types.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "@datum-cloud/strapi-revalidate",
+  "version": "0.1.0",
+  "description": "Framework-agnostic runtime cache invalidation for Strapi v5 in SSR frontends. Receives Strapi publish webhooks, clears affected cache tags, next request serves fresh data.",
+  "keywords": [
+    "strapi",
+    "strapi-v5",
+    "cache",
+    "revalidate",
+    "webhook",
+    "ssr",
+    "astro",
+    "nextjs",
+    "sveltekit",
+    "nuxt"
+  ],
+  "homepage": "https://github.com/datum-cloud/strapi-revalidate#readme",
+  "bugs": {
+    "url": "https://github.com/datum-cloud/strapi-revalidate/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/datum-cloud/strapi-revalidate.git"
+  },
+  "license": "MIT",
+  "author": "datum.net",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./cache": {
+      "types": "./dist/cache/index.d.ts",
+      "import": "./dist/cache/index.js"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "import": "./dist/client/index.js"
+    },
+    "./content": {
+      "types": "./dist/content/index.d.ts",
+      "import": "./dist/content/index.js"
+    },
+    "./webhook": {
+      "types": "./dist/webhook/handler.d.ts",
+      "import": "./dist/webhook/handler.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    ".env.example"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run build"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "zod": "^3.23.0"
+  },
+  "peerDependencies": {
+    "typescript": ">=5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "optionalDependencies": {
+    "ioredis": "^5.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.4.0",
+    "vitest": "^1.6.0"
+  }
+}