@smartive/datocms-utils 2.3.3 → 3.0.0-next.10

package/README.md

@@ -1,6 +1,6 @@
 # smartive DatoCMS Utilities
 
-A set of utilities and helpers to work with DatoCMS in a Next.js project.
+A collection of utilities and helpers for working with DatoCMS in Next.js projects.
 
 ## Installation
 
@@ -8,23 +8,60 @@ A set of utilities and helpers to work with DatoCMS in a Next.js project.
 npm install @smartive/datocms-utils
 ```
 
-## Usage
+## Utilities
 
-Import and use the utilities you need in your project. The following utilities are available.
+### General Utilities
 
-## Utilities
+#### `classNames`
+
+Cleans and joins an array of class names, filtering out undefined and boolean values.
+
+```typescript
+import { classNames } from '@smartive/datocms-utils';
+
+const className = classNames('btn', isActive && 'btn-active', undefined, 'btn-primary');
+// Result: "btn btn-active btn-primary"
+```
+
+#### `getTelLink`
+
+Converts a phone number into a `tel:` link by removing non-digit characters (except `+` for international numbers).
+
+```typescript
+import { getTelLink } from '@smartive/datocms-utils';
+
+const link = getTelLink('+1 (555) 123-4567');
+// Result: "tel:+15551234567"
+```
+
+### DatoCMS Cache Tags
+
+Utilities for managing [DatoCMS cache tags](https://www.datocms.com/docs/content-delivery-api/cache-tags) with different storage backends. Cache tags enable efficient cache invalidation by tracking which queries reference which content.
+
+#### Core Utilities
+
+```typescript
+import { generateQueryId, parseXCacheTagsResponseHeader } from '@smartive/datocms-utils/cache-tags';
 
-### Utilities for DatoCMS Cache Tags
+// Generate a unique ID for a GraphQL query
+const queryId = generateQueryId(document, variables);
 
-The following utilities are used to work with [DatoCMS cache tags](https://www.datocms.com/docs/content-delivery-api/cache-tags) and a [Vercel Postgres database](https://vercel.com/docs/storage/vercel-postgres).
+// Parse DatoCMS's X-Cache-Tags header
+const tags = parseXCacheTagsResponseHeader('tag-a tag-2 other-tag');
+// Result: ['tag-a', 'tag-2', 'other-tag']
+```
+
+#### Storage Providers
+
+The package provides two storage backends for cache tags: **Neon (Postgres)** and **Redis**. Both implement the same `CacheTagsProvider` interface.
 
-- `storeQueryCacheTags`: Stores the cache tags of a query in the database.
-- `queriesReferencingCacheTags`: Retrieves the queries that reference cache tags.
-- `deleteQueries`: Deletes the cache tags of a query from the database.
+##### Neon (Postgres) Provider
 
-#### Setup Postgres database
+Use Neon serverless Postgres to store cache tag mappings.
 
-In order for the above utilites to work, you need to setup a the following database. You can use the following SQL script to do that:
+**Setup:**
+
+1. Create the cache tags table:
 
 ```sql
 CREATE TABLE IF NOT EXISTS query_cache_tags (
@@ -34,75 +71,116 @@ CREATE TABLE IF NOT EXISTS query_cache_tags (
 );
 ```
 
-### Utilities for DatoCMS Cache Tags (Redis)
-
-The following utilities provide Redis-based alternatives to the Postgres cache tags implementation above. They work with [DatoCMS cache tags](https://www.datocms.com/docs/content-delivery-api/cache-tags) and any Redis instance.
+2. Install [@neondatabase/serverless](https://github.com/neondatabase/serverless)
 
-- `redis.storeQueryCacheTags`: Stores the cache tags of a query in Redis.
-- `redis.queriesReferencingCacheTags`: Retrieves the queries that reference cache tags.
-- `redis.deleteCacheTags`: Deletes cache tags from Redis.
-- `redis.truncateCacheTags`: Wipes out all cache tags from Redis.
+```bash
+npm install @neondatabase/serverless
+```
 
-The Redis connection is automatically initialized on first use using the `REDIS_URL` environment variable.
+3. Create and use the store:
 
-#### Environment Variables
+```typescript
+import { NeonCacheTagsProvider } from '@smartive/datocms-utils/cache-tags/neon';
 
-Add your Redis connection URL to your `.env.local` file:
+const provider = new NeonCacheTagsProvider({
+  connectionUrl: process.env.DATABASE_URL!,
+  table: 'query_cache_tags',
+});
 
-```bash
-# Required: Redis connection URL
-# For Upstash Redis
-REDIS_URL=rediss://default:your-token@your-endpoint.upstash.io:6379
+// Store cache tags for a query
+await provider.storeQueryCacheTags(queryId, ['item:42', 'product']);
 
-# For Redis Cloud or other providers
-REDIS_URL=redis://username:password@your-redis-host:6379
+// Find queries that reference specific tags
+const queries = await provider.queriesReferencingCacheTags(['item:42']);
 
-# For local development
-REDIS_URL=redis://localhost:6379
+// Delete specific cache tags
+await provider.deleteCacheTags(['item:42']);
 
-# Optional: Key prefix for separating production/preview environments
-# Useful when using the same Redis instance for multiple environments
-REDIS_KEY_PREFIX=prod        # For production
-REDIS_KEY_PREFIX=preview     # For preview/staging
-# Leave empty for development (no prefix)
+// Clear all cache tags
+await provider.truncateCacheTags();
 ```
 
-**Note**: Similar to how the Postgres version uses different table names, use `REDIS_KEY_PREFIX` to separate data between environments when using the same Redis instance.
+##### Redis Provider
+
+Use Redis to store cache tag mappings with better performance for high-traffic applications.
 
-#### Usage Example
+**Setup:**
+
+1. Install [ioredis](https://github.com/redis/ioredis)
+
+```bash
+npm install ioredis
+```
+
+2. Create and use the provider:
 
 ```typescript
-// Recommended: Use namespaces for clarity
-import { generateQueryId, redis } from '@smartive/datocms-utils';
+import { RedisCacheTagsProvider } from '@smartive/datocms-utils/cache-tags/redis';
+
+const provider = new RedisCacheTagsProvider({
+  url: process.env.REDIS_URL!,
+  keyPrefix: 'prod:', // Optional: namespace for multi-environment setups
+});
+
+// Same API as Neon provider
+await provider.storeQueryCacheTags(queryId, ['item:42', 'product']);
+const queries = await provider.queriesReferencingCacheTags(['item:42']);
+await provider.deleteCacheTags(['item:42']);
+await provider.truncateCacheTags();
+```
 
-const queryId = generateQueryId(query, variables);
+**Redis connection string examples:**
 
-// Store cache tags for a query
-await redis.storeQueryCacheTags(queryId, ['item:42', 'product', 'category:5']);
+```bash
+# Upstash Redis
+REDIS_URL=rediss://default:token@endpoint.upstash.io:6379
 
-// Find all queries that reference specific tags
-const affectedQueries = await redis.queriesReferencingCacheTags(['item:42']);
+# Redis Cloud
+REDIS_URL=redis://username:password@redis-host:6379
 
-// Delete cache tags (keys will be recreated on next query)
-await redis.deleteCacheTags(['item:42']);
+# Local development
+REDIS_URL=redis://localhost:6379
 ```
 
-#### Redis Data Structure
+#### `CacheTagsProvider` Interface
+
+Both providers implement:
 
-The Redis implementation uses Sets to track query-to-tag relationships:
+- `storeQueryCacheTags(queryId: string, cacheTags: CacheTag[])`: Store cache tags for a query
+- `queriesReferencingCacheTags(cacheTags: CacheTag[])`: Get query IDs that reference any of the specified tags
+- `deleteCacheTags(cacheTags: CacheTag[])`: Delete specific cache tags
+- `truncateCacheTags()`: Wipe all cache tags (use with caution)
 
-- **Cache tag keys**: `{prefix}{tag}` → Set of query IDs
+### Complete Example
 
-Where `{prefix}` is the optional `REDIS_KEY_PREFIX` environment variable (e.g., `prod:`, `preview:`).
+```typescript
+import { generateQueryId, parseXCacheTagsResponseHeader } from '@smartive/datocms-utils/cache-tags';
+import { RedisCacheTagsProvider } from '@smartive/datocms-utils/cache-tags/redis';
+
+const provider = new RedisCacheTagsProvider({
+  connectionUrl: process.env.REDIS_URL!,
+  keyPrefix: 'myapp:',
+});
+
+// After making a DatoCMS query
+const queryId = generateQueryId(query, variables);
+const cacheTags = parseXCacheTagsResponseHeader(response.headers['x-cache-tags']);
+await provider.storeQueryCacheTags(queryId, cacheTags);
+
+// When handling DatoCMS webhook for cache invalidation
+const affectedQueries = await provider.queriesReferencingCacheTags(webhook.entity.attributes.tags);
+// Revalidate affected queries...
+await provider.deleteCacheTags(webhook.entity.attributes.tags);
+```
 
-When cache tags are invalidated, their keys are deleted entirely. Fresh mappings are created when queries run again.
+## TypeScript Types
 
-### Other Utilities
+The package includes TypeScript types for DatoCMS webhooks and cache tags:
 
-- `classNames`: Cleans and joins an array of inputs with possible undefined or boolean values. Useful for tailwind classnames.
-- `getTelLink`: Formats a phone number to a tel link.
+- `CacheTag`: A branded type for cache tags, ensuring type safety
+- `CacheTagsInvalidateWebhook`: Type definition for DatoCMS cache tag invalidation webhook payloads
+- `CacheTagsProvider`: Interface for cache tag storage implementations
 
-### Types
+## License
 
-- `CacheTag`: A branded type for cache tags.
-- `CacheTagsInvalidateWebhook`: The payload of the DatoCMS cache tags invalidate webhook.
+MIT © [smartive AG](https://github.com/smartive)

package/dist/cache-tags/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './utils.js';

package/dist/cache-tags/index.js

@@ -0,0 +1,3 @@
+export * from './types.js';
+export * from './utils.js';
+//# sourceMappingURL=index.js.map

package/dist/cache-tags/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cache-tags/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}

package/dist/cache-tags/provider/neon.d.ts

@@ -0,0 +1,33 @@
+import { type CacheTag, type CacheTagsProvider } from '../types.js';
+type NeonCacheTagsProviderConfig = {
+    /**
+     * Neon connection string. You can find it in the "Connection" tab of your Neon project dashboard.
+     * Has the format `postgresql://user:pass@host/db`
+     */
+    readonly connectionUrl: string;
+    /**
+     * Name of the table where cache tags will be stored. The table must have the following schema:
+     *
+     * ```sql
+     * CREATE TABLE your_table_name (
+     *   query_id TEXT NOT NULL,
+     *   cache_tag TEXT NOT NULL,
+     *   PRIMARY KEY (query_id, cache_tag)
+     * );
+     * ```
+     */
+    readonly table: string;
+};
+/**
+ * A `CacheTagsProvider` implementation that uses Neon as the storage backend.
+ */
+export declare class NeonCacheTagsProvider implements CacheTagsProvider {
+    private readonly sql;
+    private readonly table;
+    constructor({ connectionUrl, table }: NeonCacheTagsProviderConfig);
+    storeQueryCacheTags(queryId: string, cacheTags: CacheTag[]): Promise<void>;
+    queriesReferencingCacheTags(cacheTags: CacheTag[]): Promise<string[]>;
+    deleteCacheTags(cacheTags: CacheTag[]): Promise<number>;
+    truncateCacheTags(): Promise<number>;
+}
+export {};

package/dist/cache-tags/provider/neon.js

@@ -0,0 +1,44 @@
+import { neon } from '@neondatabase/serverless';
+/**
+ * A `CacheTagsProvider` implementation that uses Neon as the storage backend.
+ */
+export class NeonCacheTagsProvider {
+    sql;
+    table;
+    constructor({ connectionUrl, table }) {
+        this.sql = neon(connectionUrl, { fullResults: true });
+        this.table = table;
+    }
+    async storeQueryCacheTags(queryId, cacheTags) {
+        if (!cacheTags?.length) {
+            return;
+        }
+        const tags = cacheTags.flatMap((_, i) => [queryId, cacheTags[i]]);
+        const placeholders = cacheTags.map((_, i) => `($${2 * i + 1}, $${2 * i + 2})`).join(',');
+        await this.sql.query(`INSERT INTO ${this.table} VALUES ${placeholders} ON CONFLICT DO NOTHING`, tags);
+    }
+    async queriesReferencingCacheTags(cacheTags) {
+        if (!cacheTags?.length) {
+            return [];
+        }
+        const placeholders = cacheTags.map((_, i) => `$${i + 1}`).join(',');
+        const { rows } = await this.sql.query(`SELECT DISTINCT query_id FROM ${this.table} WHERE cache_tag IN (${placeholders})`, cacheTags);
+        return rows.reduce((queryIds, row) => {
+            if (typeof row.query_id === 'string') {
+                queryIds.push(row.query_id);
+            }
+            return queryIds;
+        }, []);
+    }
+    async deleteCacheTags(cacheTags) {
+        if (cacheTags.length === 0) {
+            return 0;
+        }
+        const placeholders = cacheTags.map((_, i) => `$${i + 1}`).join(',');
+        return (await this.sql.query(`DELETE FROM ${this.table} WHERE cache_tag IN (${placeholders})`, cacheTags)).rowCount ?? 0;
+    }
+    async truncateCacheTags() {
+        return (await this.sql.query(`DELETE FROM ${this.table}`)).rowCount ?? 0;
+    }
+}
+//# sourceMappingURL=neon.js.map

package/dist/cache-tags/provider/neon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"neon.js","sourceRoot":"","sources":["../../../src/cache-tags/provider/neon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAuBhD;;GAEG;AACH,MAAM,OAAO,qBAAqB;IACf,GAAG,CAAC;IACJ,KAAK,CAAC;IAEvB,YAAY,EAAE,aAAa,EAAE,KAAK,EAA+B;QAC/D,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,aAAa,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,OAAe,EAAE,SAAqB;QACrE,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QAED,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClE,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEzF,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,KAAK,WAAW,YAAY,yBAAyB,EAAE,IAAI,CAAC,CAAC;IACxG,CAAC;IAEM,KAAK,CAAC,2BAA2B,CAAC,SAAqB;QAC5D,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;YACvB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEpE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CACnC,iCAAiC,IAAI,CAAC,KAAK,wBAAwB,YAAY,GAAG,EAClF,SAAS,CACV,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAW,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE;YAC7C,IAAI,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACrC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC9B,CAAC;YAED,OAAO,QAAQ,CAAC;QAClB,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,SAAqB;QAChD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,CAAC,CAAC;QACX,CAAC;QACD,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEpE,OAAO,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,KAAK,wBAAwB,YAAY,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC;IAC3H,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,OAAO,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC;IAC3E,CAAC;CACF"}

package/dist/cache-tags/provider/noop.d.ts

@@ -0,0 +1,12 @@
+import { type CacheTag, type CacheTagsProvider } from '../types.js';
+/**
+ * A `CacheTagsProvider` implementation that does not perform any actual storage operations.
+ *
+ * _Note: This implementation is useful for testing purposes or when you want to disable caching without changing the code that interacts with the cache._
+ */
+export declare class NoopCacheTagsProvider implements CacheTagsProvider {
+    storeQueryCacheTags(queryId: string, cacheTags: CacheTag[]): Promise<void>;
+    queriesReferencingCacheTags(cacheTags: CacheTag[]): Promise<string[]>;
+    deleteCacheTags(cacheTags: CacheTag[]): Promise<number>;
+    truncateCacheTags(): Promise<number>;
+}

package/dist/cache-tags/provider/noop.js

@@ -0,0 +1,24 @@
+/**
+ * A `CacheTagsProvider` implementation that does not perform any actual storage operations.
+ *
+ * _Note: This implementation is useful for testing purposes or when you want to disable caching without changing the code that interacts with the cache._
+ */
+export class NoopCacheTagsProvider {
+    async storeQueryCacheTags(queryId, cacheTags) {
+        console.debug('-- storeQueryCacheTags called', { queryId, cacheTags });
+        return Promise.resolve();
+    }
+    async queriesReferencingCacheTags(cacheTags) {
+        console.debug('-- queriesReferencingCacheTags called', { cacheTags });
+        return Promise.resolve([]);
+    }
+    async deleteCacheTags(cacheTags) {
+        console.debug('-- deleteCacheTags called', { cacheTags });
+        return Promise.resolve(0);
+    }
+    async truncateCacheTags() {
+        console.debug('-- truncateCacheTags called');
+        return Promise.resolve(0);
+    }
+}
+//# sourceMappingURL=noop.js.map

package/dist/cache-tags/provider/noop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"noop.js","sourceRoot":"","sources":["../../../src/cache-tags/provider/noop.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,OAAO,qBAAqB;IACzB,KAAK,CAAC,mBAAmB,CAAC,OAAe,EAAE,SAAqB;QACrE,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QAEvE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAEM,KAAK,CAAC,2BAA2B,CAAC,SAAqB;QAC5D,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QAEtE,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,SAAqB;QAChD,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QAE1D,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,OAAO,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;QAE7C,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC;CACF"}

package/dist/cache-tags/provider/redis.d.ts

@@ -0,0 +1,33 @@
+import { type CacheTag, type CacheTagsProvider } from '../types.js';
+type RedisCacheTagsProviderConfig = {
+    /**
+     * Redis connection string. For example, `redis://user:pass@host:port/db`.
+     */
+    readonly connectionUrl: string;
+    /**
+     * Optional prefix for Redis keys. If provided, all keys used to store cache tags will be prefixed with this value.
+     * This can be useful to avoid key collisions if the same Redis instance is used for multiple purposes.
+     * For example, if you set `keyPrefix` to `'myapp:'`, a cache tag like `'tag1'` will be stored under the key `'myapp:tag1'`.
+     */
+    readonly keyPrefix?: string;
+};
+/**
+ * A `CacheTagsProvider` implementation that uses Redis as the storage backend.
+ */
+export declare class RedisCacheTagsProvider implements CacheTagsProvider {
+    private readonly redis;
+    private readonly keyPrefix;
+    constructor({ connectionUrl, keyPrefix }: RedisCacheTagsProviderConfig);
+    storeQueryCacheTags(queryId: string, cacheTags: CacheTag[]): Promise<void>;
+    queriesReferencingCacheTags(cacheTags: CacheTag[]): Promise<string[]>;
+    deleteCacheTags(cacheTags: CacheTag[]): Promise<number>;
+    truncateCacheTags(): Promise<number>;
+    /**
+     * Retrieves all keys matching the given pattern using the Redis SCAN command.
+     * This method is more efficient than using the KEYS command, especially for large datasets.
+     *
+     * @returns An array of matching keys
+     */
+    private getKeys;
+}
+export {};

package/dist/cache-tags/provider/redis.js

@@ -0,0 +1,71 @@
+import { Redis } from 'ioredis';
+/**
+ * A `CacheTagsProvider` implementation that uses Redis as the storage backend.
+ */
+export class RedisCacheTagsProvider {
+    redis;
+    keyPrefix;
+    constructor({ connectionUrl, keyPrefix }) {
+        this.redis = new Redis(connectionUrl, {
+            maxRetriesPerRequest: 3,
+            lazyConnect: true,
+        });
+        this.keyPrefix = keyPrefix ?? '';
+    }
+    async storeQueryCacheTags(queryId, cacheTags) {
+        if (!cacheTags?.length) {
+            return;
+        }
+        const pipeline = this.redis.pipeline();
+        for (const tag of cacheTags) {
+            pipeline.sadd(`${this.keyPrefix}${tag}`, queryId);
+        }
+        await pipeline.exec();
+    }
+    async queriesReferencingCacheTags(cacheTags) {
+        if (!cacheTags?.length) {
+            return [];
+        }
+        const keys = cacheTags.map((tag) => `${this.keyPrefix}${tag}`);
+        return this.redis.sunion(...keys);
+    }
+    async deleteCacheTags(cacheTags) {
+        if (!cacheTags?.length) {
+            return 0;
+        }
+        const keys = cacheTags.map((tag) => `${this.keyPrefix}${tag}`);
+        return this.redis.del(...keys);
+    }
+    async truncateCacheTags() {
+        const keys = await this.getKeys();
+        if (keys.length === 0) {
+            return 0;
+        }
+        return await this.redis.del(...keys);
+    }
+    /**
+     * Retrieves all keys matching the given pattern using the Redis SCAN command.
+     * This method is more efficient than using the KEYS command, especially for large datasets.
+     *
+     * @returns An array of matching keys
+     */
+    async getKeys() {
+        return new Promise((resolve, reject) => {
+            const keys = [];
+            const stream = this.redis.scanStream({
+                match: `${this.keyPrefix}*`,
+                count: 1000,
+            });
+            stream.on('data', (resultKeys) => {
+                keys.push(...resultKeys);
+            });
+            stream.on('end', () => {
+                resolve(keys);
+            });
+            stream.on('error', (err) => {
+                reject(err);
+            });
+        });
+    }
+}
+//# sourceMappingURL=redis.js.map

package/dist/cache-tags/provider/redis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis.js","sourceRoot":"","sources":["../../../src/cache-tags/provider/redis.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAgBhC;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAChB,KAAK,CAAC;IACN,SAAS,CAAC;IAE3B,YAAY,EAAE,aAAa,EAAE,SAAS,EAAgC;QACpE,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,aAAa,EAAE;YACpC,oBAAoB,EAAE,CAAC;YACvB,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,GAAG,SAAS,IAAI,EAAE,CAAC;IACnC,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,OAAe,EAAE,SAAqB;QACrE,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;QAEvC,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC5B,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,GAAG,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,2BAA2B,CAAC,SAAqB;QAC5D,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;YACvB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,GAAG,GAAG,EAAE,CAAC,CAAC;QAE/D,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IACpC,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,SAAqB;QAChD,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;YACvB,OAAO,CAAC,CAAC;QACX,CAAC;QAED,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,GAAG,GAAG,EAAE,CAAC,CAAC;QAE/D,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QAElC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,CAAC,CAAC;QACX,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,OAAO;QACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,IAAI,GAAa,EAAE,CAAC;YAE1B,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;gBACnC,KAAK,EAAE,GAAG,IAAI,CAAC,SAAS,GAAG;gBAC3B,KAAK,EAAE,IAAI;aACZ,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,UAAoB,EAAE,EAAE;gBACzC,IAAI,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACpB,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBACzB,MAAM,CAAC,GAAG,CAAC,CAAC;YACd,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/cache-tags/types.d.ts

@@ -0,0 +1,63 @@
+/**
+ * A branded type for cache tags. This is created by intersecting `string`
+ * with `{ readonly _: unique symbol }`, making it a unique type.
+ * Although it is fundamentally a string, it is treated as a distinct type
+ * due to the unique symbol.
+ */
+export type CacheTag = string & {
+    readonly _: unique symbol;
+};
+/**
+ * A type representing the structure of a webhook payload for cache tag invalidation.
+ * It includes the entity type, event type, and the entity details which contain
+ * the cache tags to be invalidated.
+ */
+export type CacheTagsInvalidateWebhook = {
+    entity_type: 'cda_cache_tags';
+    event_type: 'invalidate';
+    entity: {
+        id: 'cda_cache_tags';
+        type: 'cda_cache_tags';
+        attributes: {
+            tags: CacheTag[];
+        };
+    };
+};
+/**
+ * Configuration object for creating a `CacheTagsProvider` implementation.
+ */
+export interface CacheTagsProvider {
+    /**
+     * Stores the cache tags of a query.
+     *
+     * @param {string} queryId Unique query ID
+     * @param {CacheTag[]} cacheTags Array of cache tags
+     *
+     */
+    storeQueryCacheTags(queryId: string, cacheTags: CacheTag[]): Promise<void>;
+    /**
+     * Retrieves the query IDs that reference any of the specified cache tags.
+     *
+     * @param {CacheTag[]} cacheTags Array of cache tags to check
+     * @returns Array of unique query IDs
+     *
+     */
+    queriesReferencingCacheTags(cacheTags: CacheTag[]): Promise<string[]>;
+    /**
+     * Deletes the specified cache tags.
+     *
+     * This removes the cache tag keys entirely. When queries are revalidated and
+     * run again, fresh cache tag mappings will be created.
+     *
+     * @param {CacheTag[]} cacheTags Array of cache tags to delete
+     * @returns Number of keys deleted, or null if there was an error
+     *
+     */
+    deleteCacheTags(cacheTags: CacheTag[]): Promise<number>;
+    /**
+     * Wipes out all cache tags.
+     *
+     * ⚠️ **Warning**: This will delete all cache tag data. Use with caution!
+     */
+    truncateCacheTags(): Promise<number>;
+}

package/dist/cache-tags/types.js.map

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

package/dist/{utils.d.ts → cache-tags/utils.d.ts}

@@ -1,5 +1,5 @@
 import { type DocumentNode } from 'graphql';
-import { type CacheTag } from './types';
+import { type CacheTag } from './types.js';
 /**
  * Converts the value of DatoCMS's `X-Cache-Tags` header into an array of strings typed as `CacheTag`.
  * For example, it transforms `'tag-a tag-2 other-tag'` into `['tag-a', 'tag-2', 'other-tag']`.

package/dist/cache-tags/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/cache-tags/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAqB,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAGzC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,MAAsB,EAAE,EAAE,CACtE,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAe,CAAC,CAAC;AAE3D;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAuB,QAAsB,EAAE,SAAsB,EAAU,EAAE;IAC9G,OAAO,UAAU,CAAC,MAAM,CAAC;SACtB,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;SACvB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;SACvC,MAAM,CAAC,KAAK,CAAC,CAAC;AACnB,CAAC,CAAC"}

package/dist/classnames.d.ts

@@ -4,4 +4,4 @@
  * @param classNames Array of class names
  * @returns Clean string to be used for class name
  */
-export declare const classNames: (...classNames: (string | undefined | boolean)[]) => string;
+export declare const classNames: (...classNames: unknown[]) => string;

package/dist/classnames.js

@@ -4,5 +4,7 @@
  * @param classNames Array of class names
  * @returns Clean string to be used for class name
  */
-export const classNames = (...classNames) => classNames.filter(Boolean).join(' ');
+export const classNames = (...classNames) => classNames
+    .filter((value) => (typeof value === 'string' && value.length > 0) || (typeof value === 'number' && Number.isFinite(value)))
+    .join(' ');
 //# sourceMappingURL=classnames.js.map

package/dist/classnames.js.map

@@ -1 +1 @@
-{"version":3,"file":"classnames.js","sourceRoot":"","sources":["../src/classnames.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,GAAG,UAA4C,EAAU,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC"}
+{"version":3,"file":"classnames.js","sourceRoot":"","sources":["../src/classnames.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,GAAG,UAAqB,EAAE,EAAE,CACrD,UAAU;KACP,MAAM,CACL,CAAC,KAAK,EAA4B,EAAE,CAClC,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAC3G;KACA,IAAI,CAAC,GAAG,CAAC,CAAC"}

package/dist/index.d.ts

@@ -1,4 +1,2 @@
-export * from './cache-tags';
-export * from './classnames';
-export * from './links';
-export * from './types';
+export * from './classnames.js';
+export * from './links.js';

package/dist/index.js

@@ -1,5 +1,3 @@
-export * from './cache-tags';
-export * from './classnames';
-export * from './links';
-export * from './types';
+export * from './classnames.js';
+export * from './links.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC"}