@smartive/datocms-utils 3.0.0-next.4 → 3.0.0-next.5

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';
 
-### 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 `CacheTagsStore` 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 { createCacheTagsStore } from '@smartive/datocms-utils/cache/neon';
 
-Add your Redis connection URL to your `.env.local` file:
+const store = createCacheTagsStore({
+  connectionString: 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 store.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 store.queriesReferencingCacheTags(['item:42']);
 
-# For local development
-REDIS_URL=redis://localhost:6379
+// Delete specific cache tags
+await store.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 store.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 store:
 
 ```typescript
-// Recommended: Use namespaces for clarity
-import { generateQueryId, redis } from '@smartive/datocms-utils';
+import { createCacheTagsStore } from '@smartive/datocms-utils/cache/redis';
+
+const store = createCacheTagsStore({
+  url: process.env.REDIS_URL!,
+  keyPrefix: 'prod:', // Optional: namespace for multi-environment setups
+});
+
+// Same API as Neon provider
+await store.storeQueryCacheTags(queryId, ['item:42', 'product']);
+const queries = await store.queriesReferencingCacheTags(['item:42']);
+await store.deleteCacheTags(['item:42']);
+await store.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
+#### `CacheTagsStore` 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';
+import { createCacheTagsStore } from '@smartive/datocms-utils/cache/redis';
+
+const store = createCacheTagsStore({
+  url: 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 store.storeQueryCacheTags(queryId, cacheTags);
+
+// When handling DatoCMS webhook for cache invalidation
+const affectedQueries = await store.queriesReferencingCacheTags(webhook.entity.attributes.tags);
+// Revalidate affected queries...
+await store.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
+- `CacheTagsStore`: 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/provider/neon.d.ts

@@ -1,5 +1,28 @@
 import { type CacheTagsStore } from '../types.js';
-export declare const createCacheTagsStore: ({ connectionString, table, }: {
-    connectionString: string;
-    table: string;
-}) => CacheTagsStore;
+type NeonCacheTagsStoreConfig = {
+    /**
+     * 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;
+};
+/**
+ * Creates a `CacheTagsStore` implementation using Neon as the storage backend. Neon is a serverless Postgres database service.
+ *
+ * @param {NeonCacheTagsStoreConfig} config Configuration object containing the Neon connection string and table name.
+ * @returns An object implementing the `CacheTagsStore` interface, allowing you to store and manage cache tags in a Neon database.
+ */
+export declare const createCacheTagsStore: ({ connectionUrl, table }: NeonCacheTagsStoreConfig) => CacheTagsStore;
+export {};

package/dist/cache/provider/neon.js

@@ -1,6 +1,12 @@
 import { neon } from '@neondatabase/serverless';
-export const createCacheTagsStore = ({ connectionString, table, }) => {
-    const sql = neon(connectionString, { fullResults: true });
+/**
+ * Creates a `CacheTagsStore` implementation using Neon as the storage backend. Neon is a serverless Postgres database service.
+ *
+ * @param {NeonCacheTagsStoreConfig} config Configuration object containing the Neon connection string and table name.
+ * @returns An object implementing the `CacheTagsStore` interface, allowing you to store and manage cache tags in a Neon database.
+ */
+export const createCacheTagsStore = ({ connectionUrl, table }) => {
+    const sql = neon(connectionUrl, { fullResults: true });
     const storeQueryCacheTags = async (queryId, cacheTags) => {
         if (!cacheTags?.length) {
             return;

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

@@ -1 +1 @@
-{"version":3,"file":"neon.js","sourceRoot":"","sources":["../../../src/cache/provider/neon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAGhD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,EACnC,gBAAgB,EAChB,KAAK,GAIN,EAAkB,EAAE;IACnB,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IAE1D,MAAM,mBAAmB,GAAG,KAAK,EAAE,OAAe,EAAE,SAAqB,EAAE,EAAE;QAC3E,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,GAAG,CAAC,KAAK,CAAC,eAAe,KAAK,WAAW,YAAY,yBAAyB,EAAE,IAAI,CAAC,CAAC;IAC9F,CAAC,CAAC;IAEF,MAAM,2BAA2B,GAAG,KAAK,EAAE,SAAqB,EAAqB,EAAE;QACrF,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,GAAG,CAAC,KAAK,CAC9B,iCAAiC,KAAK,wBAAwB,YAAY,GAAG,EAC7E,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,CAAC;IAEF,MAAM,eAAe,GAAG,KAAK,EAAE,SAAqB,EAAE,EAAE;QACtD,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,GAAG,CAAC,KAAK,CAAC,eAAe,KAAK,wBAAwB,YAAY,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC;IACjH,CAAC,CAAC;IAEF,MAAM,iBAAiB,GAAG,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,eAAe,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC;IAE9F,OAAO;QACL,mBAAmB;QACnB,2BAA2B;QAC3B,eAAe;QACf,iBAAiB;KAClB,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"neon.js","sourceRoot":"","sources":["../../../src/cache/provider/neon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAuBhD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,EAAE,aAAa,EAAE,KAAK,EAA4B,EAAkB,EAAE;IACzG,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IAEvD,MAAM,mBAAmB,GAAG,KAAK,EAAE,OAAe,EAAE,SAAqB,EAAE,EAAE;QAC3E,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,GAAG,CAAC,KAAK,CAAC,eAAe,KAAK,WAAW,YAAY,yBAAyB,EAAE,IAAI,CAAC,CAAC;IAC9F,CAAC,CAAC;IAEF,MAAM,2BAA2B,GAAG,KAAK,EAAE,SAAqB,EAAqB,EAAE;QACrF,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,GAAG,CAAC,KAAK,CAC9B,iCAAiC,KAAK,wBAAwB,YAAY,GAAG,EAC7E,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,CAAC;IAEF,MAAM,eAAe,GAAG,KAAK,EAAE,SAAqB,EAAE,EAAE;QACtD,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,GAAG,CAAC,KAAK,CAAC,eAAe,KAAK,wBAAwB,YAAY,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC;IACjH,CAAC,CAAC;IAEF,MAAM,iBAAiB,GAAG,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,eAAe,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC;IAE9F,OAAO;QACL,mBAAmB;QACnB,2BAA2B;QAC3B,eAAe;QACf,iBAAiB;KAClB,CAAC;AACJ,CAAC,CAAC"}

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

@@ -1,5 +1,21 @@
 import { type CacheTagsStore } from '../types.js';
-export declare const createCacheTagsStore: ({ url, keyPrefix }: {
-    url: string;
-    keyPrefix?: string;
-}) => CacheTagsStore;
+type RedisCacheTagsStoreConfig = {
+    /**
+     * 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;
+};
+/**
+ * Creates a `CacheTagsStore` implementation using Redis as the storage backend.
+ *
+ * @param {RedisCacheTagsStoreConfig} config Configuration object containing the Redis connection string and optional key prefix.
+ * @returns An object implementing the `CacheTagsStore` interface, allowing you to store and manage cache tags in a Redis database.
+ */
+export declare const createCacheTagsStore: ({ connectionUrl, keyPrefix }: RedisCacheTagsStoreConfig) => CacheTagsStore;
+export {};

package/dist/cache/provider/redis.js

@@ -1,6 +1,12 @@
 import { Redis } from 'ioredis';
-export const createCacheTagsStore = ({ url, keyPrefix = '' }) => {
-    const redis = new Redis(url, {
+/**
+ * Creates a `CacheTagsStore` implementation using Redis as the storage backend.
+ *
+ * @param {RedisCacheTagsStoreConfig} config Configuration object containing the Redis connection string and optional key prefix.
+ * @returns An object implementing the `CacheTagsStore` interface, allowing you to store and manage cache tags in a Redis database.
+ */
+export const createCacheTagsStore = ({ connectionUrl, keyPrefix = '' }) => {
+    const redis = new Redis(connectionUrl, {
         maxRetriesPerRequest: 3,
         lazyConnect: true,
     });

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

@@ -1 +1 @@
-{"version":3,"file":"redis.js","sourceRoot":"","sources":["../../../src/cache/provider/redis.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAGhC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,GAAG,EAAE,EAAuC,EAAkB,EAAE;IACnH,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,GAAG,EAAE;QAC3B,oBAAoB,EAAE,CAAC;QACvB,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,KAAK,EAAE,OAAe,EAAE,SAAqB,EAAE,EAAE;QAC3E,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QAElC,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC5B,QAAQ,CAAC,IAAI,CAAC,GAAG,SAAS,GAAG,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACxB,CAAC,CAAC;IAEF,MAAM,2BAA2B,GAAG,KAAK,EAAE,SAAqB,EAAE,EAAE;QAClE,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,SAAS,GAAG,GAAG,EAAE,CAAC,CAAC;QAE1D,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAC/B,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,KAAK,EAAE,SAAqB,EAAE,EAAE;QACtD,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,SAAS,GAAG,GAAG,EAAE,CAAC,CAAC;QAE1D,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5B,CAAC,CAAC;IAEF,MAAM,iBAAiB,GAAG,KAAK,IAAI,EAAE;QACnC,MAAM,OAAO,GAAG,GAAG,SAAS,GAAG,CAAC;QAChC,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEvC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,CAAC,CAAC;QACX,CAAC;QAED,OAAO,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAClC,CAAC,CAAC;IAEF,OAAO;QACL,mBAAmB;QACnB,2BAA2B;QAC3B,eAAe;QACf,iBAAiB;KAClB,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"redis.js","sourceRoot":"","sources":["../../../src/cache/provider/redis.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAgBhC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,EAAE,aAAa,EAAE,SAAS,GAAG,EAAE,EAA6B,EAAkB,EAAE;IACnH,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,aAAa,EAAE;QACrC,oBAAoB,EAAE,CAAC;QACvB,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,KAAK,EAAE,OAAe,EAAE,SAAqB,EAAE,EAAE;QAC3E,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QAElC,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC5B,QAAQ,CAAC,IAAI,CAAC,GAAG,SAAS,GAAG,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACxB,CAAC,CAAC;IAEF,MAAM,2BAA2B,GAAG,KAAK,EAAE,SAAqB,EAAE,EAAE;QAClE,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,SAAS,GAAG,GAAG,EAAE,CAAC,CAAC;QAE1D,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAC/B,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,KAAK,EAAE,SAAqB,EAAE,EAAE;QACtD,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,SAAS,GAAG,GAAG,EAAE,CAAC,CAAC;QAE1D,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5B,CAAC,CAAC;IAEF,MAAM,iBAAiB,GAAG,KAAK,IAAI,EAAE;QACnC,MAAM,OAAO,GAAG,GAAG,SAAS,GAAG,CAAC;QAChC,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEvC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,CAAC,CAAC;QACX,CAAC;QAED,OAAO,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAClC,CAAC,CAAC;IAEF,OAAO;QACL,mBAAmB;QACnB,2BAA2B;QAC3B,eAAe;QACf,iBAAiB;KAClB,CAAC;AACJ,CAAC,CAAC"}

package/dist/cache/types.d.ts

@@ -23,6 +23,9 @@ export type CacheTagsInvalidateWebhook = {
         };
     };
 };
+/**
+ * Configuration object for creating a `CacheTagsStore` implementation.
+ */
 export type CacheTagsStore = {
     /**
      * Stores the cache tags of a query.

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartive/datocms-utils",
-  "version": "3.0.0-next.4",
+  "version": "3.0.0-next.5",
   "description": "A set of utilities and helpers to work with DatoCMS in a Next.js project.",
   "type": "module",
   "source": "./src/index.ts",

package/src/cache/provider/neon.ts

@@ -1,14 +1,34 @@
 import { neon } from '@neondatabase/serverless';
 import { type CacheTag, type CacheTagsStore } from '../types.js';
 
-export const createCacheTagsStore = ({
-  connectionString,
-  table,
-}: {
-  connectionString: string;
-  table: string;
-}): CacheTagsStore => {
-  const sql = neon(connectionString, { fullResults: true });
+type NeonCacheTagsStoreConfig = {
+  /**
+   * 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;
+};
+
+/**
+ * Creates a `CacheTagsStore` implementation using Neon as the storage backend. Neon is a serverless Postgres database service.
+ *
+ * @param {NeonCacheTagsStoreConfig} config Configuration object containing the Neon connection string and table name.
+ * @returns An object implementing the `CacheTagsStore` interface, allowing you to store and manage cache tags in a Neon database.
+ */
+export const createCacheTagsStore = ({ connectionUrl, table }: NeonCacheTagsStoreConfig): CacheTagsStore => {
+  const sql = neon(connectionUrl, { fullResults: true });
 
   const storeQueryCacheTags = async (queryId: string, cacheTags: CacheTag[]) => {
     if (!cacheTags?.length) {

package/src/cache/provider/redis.ts

@@ -1,8 +1,27 @@
 import { Redis } from 'ioredis';
 import { type CacheTag, type CacheTagsStore } from '../types.js';
 
-export const createCacheTagsStore = ({ url, keyPrefix = '' }: { url: string; keyPrefix?: string }): CacheTagsStore => {
-  const redis = new Redis(url, {
+type RedisCacheTagsStoreConfig = {
+  /**
+   * 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;
+};
+
+/**
+ * Creates a `CacheTagsStore` implementation using Redis as the storage backend.
+ *
+ * @param {RedisCacheTagsStoreConfig} config Configuration object containing the Redis connection string and optional key prefix.
+ * @returns An object implementing the `CacheTagsStore` interface, allowing you to store and manage cache tags in a Redis database.
+ */
+export const createCacheTagsStore = ({ connectionUrl, keyPrefix = '' }: RedisCacheTagsStoreConfig): CacheTagsStore => {
+  const redis = new Redis(connectionUrl, {
     maxRetriesPerRequest: 3,
     lazyConnect: true,
   });

package/src/cache/types.ts

@@ -23,6 +23,9 @@ export type CacheTagsInvalidateWebhook = {
   };
 };
 
+/**
+ * Configuration object for creating a `CacheTagsStore` implementation.
+ */
 export type CacheTagsStore = {
   /**
    * Stores the cache tags of a query.

package/src/classnames.ts

@@ -4,4 +4,10 @@
  * @param classNames Array of class names
  * @returns Clean string to be used for class name
  */
-export const classNames = (...classNames: (string | undefined | boolean)[]): string => classNames.filter(Boolean).join(' ');
+export const classNames = (...classNames: unknown[]) =>
+  classNames
+    .filter(
+      (value): value is string | number =>
+        (typeof value === 'string' && value.length > 0) || (typeof value === 'number' && Number.isFinite(value)),
+    )
+    .join(' ');