@smartive/datocms-utils 3.0.0-next.6 → 3.0.0-next.7

package/README.md

@@ -80,24 +80,24 @@ npm install @neondatabase/serverless
 3. Create and use the store:
 
 ```typescript
-import { createCacheTagsStore } from '@smartive/datocms-utils/cache/neon';
+import { NeonCacheTagsProvider } from '@smartive/datocms-utils/cache/neon';
 
-const store = createCacheTagsStore({
+const provider = new NeonCacheTagsProvider({
   connectionString: process.env.DATABASE_URL!,
   table: 'query_cache_tags',
 });
 
 // Store cache tags for a query
-await store.storeQueryCacheTags(queryId, ['item:42', 'product']);
+await provider.storeQueryCacheTags(queryId, ['item:42', 'product']);
 
 // Find queries that reference specific tags
-const queries = await store.queriesReferencingCacheTags(['item:42']);
+const queries = await provider.queriesReferencingCacheTags(['item:42']);
 
 // Delete specific cache tags
-await store.deleteCacheTags(['item:42']);
+await provider.deleteCacheTags(['item:42']);
 
 // Clear all cache tags
-await store.truncateCacheTags();
+await provider.truncateCacheTags();
 ```
 
 ##### Redis Provider
@@ -112,21 +112,21 @@ Use Redis to store cache tag mappings with better performance for high-traffic a
 npm install ioredis
 ```
 
-2. Create and use the store:
+2. Create and use the provider:
 
 ```typescript
-import { createCacheTagsStore } from '@smartive/datocms-utils/cache/redis';
+import { RedisCacheTagsProvider } from '@smartive/datocms-utils/cache/redis';
 
-const store = createCacheTagsStore({
+const provider = new RedisCacheTagsProvider({
   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']);
+await provider.storeQueryCacheTags(queryId, ['item:42', 'product']);
 const queries = await store.queriesReferencingCacheTags(['item:42']);
-await store.deleteCacheTags(['item:42']);
-await store.truncateCacheTags();
+await provider.deleteCacheTags(['item:42']);
+await provider.truncateCacheTags();
 ```
 
 **Redis connection string examples:**
@@ -142,7 +142,7 @@ REDIS_URL=redis://username:password@redis-host:6379
 REDIS_URL=redis://localhost:6379
 ```
 
-#### `CacheTagsStore` Interface
+#### `CacheTagsProvider` Interface
 
 Both providers implement:
 
@@ -155,9 +155,9 @@ Both providers implement:
 
 ```typescript
 import { generateQueryId, parseXCacheTagsResponseHeader } from '@smartive/datocms-utils/cache';
-import { createCacheTagsStore } from '@smartive/datocms-utils/cache/redis';
+import { RedisCacheTagsProvider } from '@smartive/datocms-utils/cache/redis';
 
-const store = createCacheTagsStore({
+const provider = new RedisCacheTagsProvider({
   url: process.env.REDIS_URL!,
   keyPrefix: 'myapp:',
 });
@@ -165,12 +165,12 @@ const store = createCacheTagsStore({
 // After making a DatoCMS query
 const queryId = generateQueryId(query, variables);
 const cacheTags = parseXCacheTagsResponseHeader(response.headers['x-cache-tags']);
-await store.storeQueryCacheTags(queryId, cacheTags);
+await provider.storeQueryCacheTags(queryId, cacheTags);
 
 // When handling DatoCMS webhook for cache invalidation
-const affectedQueries = await store.queriesReferencingCacheTags(webhook.entity.attributes.tags);
+const affectedQueries = await provider.queriesReferencingCacheTags(webhook.entity.attributes.tags);
 // Revalidate affected queries...
-await store.deleteCacheTags(webhook.entity.attributes.tags);
+await provider.deleteCacheTags(webhook.entity.attributes.tags);
 ```
 
 ## TypeScript Types
@@ -179,7 +179,7 @@ The package includes TypeScript types for DatoCMS webhooks and cache tags:
 
 - `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
+- `CacheTagsProvider`: Interface for cache tag storage implementations
 
 ## License
 

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

@@ -1,4 +1,4 @@
-import { type CacheTagsStore } from '../types.js';
+import { type CacheTag, type CacheTagsProvider } from '../types.js';
 type NeonCacheTagsStoreConfig = {
     /**
      * Neon connection string. You can find it in the "Connection" tab of your Neon project dashboard.
@@ -19,10 +19,15 @@ type NeonCacheTagsStoreConfig = {
     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.
+ * A `CacheTagsProvider` implementation that uses Neon as the storage backend.
  */
-export declare const createCacheTagsStore: ({ connectionUrl, table }: NeonCacheTagsStoreConfig) => CacheTagsStore;
+export declare class NeonCacheTagsProvider implements CacheTagsProvider {
+    private readonly sql;
+    private readonly table;
+    constructor({ connectionUrl, table }: NeonCacheTagsStoreConfig);
+    storeQueryCacheTags(queryId: string, cacheTags: CacheTag[]): Promise<void>;
+    queriesReferencingCacheTags(cacheTags: CacheTag[]): Promise<string[]>;
+    deleteCacheTags(cacheTags: CacheTag[]): Promise<number>;
+    truncateCacheTags(): Promise<number>;
+}
 export {};

package/dist/cache/provider/neon.js

@@ -1,46 +1,44 @@
 import { neon } from '@neondatabase/serverless';
 /**
- * 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.
+ * A `CacheTagsProvider` implementation that uses Neon as the storage backend.
  */
-export const createCacheTagsStore = ({ connectionUrl, table }) => {
-    const sql = neon(connectionUrl, { fullResults: true });
-    const storeQueryCacheTags = async (queryId, cacheTags) => {
+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 sql.query(`INSERT INTO ${table} VALUES ${placeholders} ON CONFLICT DO NOTHING`, tags);
-    };
-    const queriesReferencingCacheTags = async (cacheTags) => {
+        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 sql.query(`SELECT DISTINCT query_id FROM ${table} WHERE cache_tag IN (${placeholders})`, cacheTags);
+        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;
         }, []);
-    };
-    const deleteCacheTags = async (cacheTags) => {
+    }
+    async deleteCacheTags(cacheTags) {
         if (cacheTags.length === 0) {
             return 0;
         }
         const placeholders = cacheTags.map((_, i) => `$${i + 1}`).join(',');
-        return (await sql.query(`DELETE FROM ${table} WHERE cache_tag IN (${placeholders})`, cacheTags)).rowCount ?? 0;
-    };
-    const truncateCacheTags = async () => (await sql.query(`DELETE FROM ${table}`)).rowCount ?? 0;
-    return {
-        storeQueryCacheTags,
-        queriesReferencingCacheTags,
-        deleteCacheTags,
-        truncateCacheTags,
-    };
-};
+        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/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;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"}
+{"version":3,"file":"neon.js","sourceRoot":"","sources":["../../../src/cache/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,EAA4B;QAC5D,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/provider/noop.d.ts

@@ -1,9 +1,12 @@
-import { type CacheTagsStore } from '../types.js';
+import { type CacheTag, type CacheTagsProvider } from '../types.js';
 /**
- * Creates a `CacheTagsStore` implementation that does not perform any actual storage operations.
+ * 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._
- *
- * @returns An object implementing the `CacheTagsStore` interface.
  */
-export declare const createCacheTagsStore: () => CacheTagsStore;
+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/provider/noop.js

@@ -1,32 +1,24 @@
 /**
- * Creates a `CacheTagsStore` implementation that does not perform any actual storage operations.
+ * 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._
- *
- * @returns An object implementing the `CacheTagsStore` interface.
  */
-export const createCacheTagsStore = () => {
-    const storeQueryCacheTags = async (queryId, cacheTags) => {
+export class NoopCacheTagsProvider {
+    async storeQueryCacheTags(queryId, cacheTags) {
         console.debug('-- storeQueryCacheTags called', { queryId, cacheTags });
         return Promise.resolve();
-    };
-    const queriesReferencingCacheTags = async (cacheTags) => {
+    }
+    async queriesReferencingCacheTags(cacheTags) {
         console.debug('-- queriesReferencingCacheTags called', { cacheTags });
         return Promise.resolve([]);
-    };
-    const deleteCacheTags = async (cacheTags) => {
+    }
+    async deleteCacheTags(cacheTags) {
         console.debug('-- deleteCacheTags called', { cacheTags });
         return Promise.resolve(0);
-    };
-    const truncateCacheTags = async () => {
+    }
+    async truncateCacheTags() {
         console.debug('-- truncateCacheTags called');
         return Promise.resolve(0);
-    };
-    return {
-        storeQueryCacheTags,
-        queriesReferencingCacheTags,
-        deleteCacheTags,
-        truncateCacheTags,
-    };
-};
+    }
+}
 //# sourceMappingURL=noop.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"noop.js","sourceRoot":"","sources":["../../../src/cache/provider/noop.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAmB,EAAE;IACvD,MAAM,mBAAmB,GAAG,KAAK,EAAE,OAAe,EAAE,SAAqB,EAAE,EAAE;QAC3E,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QAEvE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC;IAEF,MAAM,2BAA2B,GAAG,KAAK,EAAE,SAAqB,EAAE,EAAE;QAClE,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QAEtE,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,KAAK,EAAE,SAAqB,EAAE,EAAE;QACtD,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QAE1D,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC,CAAC;IAEF,MAAM,iBAAiB,GAAG,KAAK,IAAI,EAAE;QACnC,OAAO,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;QAE7C,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC,CAAC;IAEF,OAAO;QACL,mBAAmB;QACnB,2BAA2B;QAC3B,eAAe;QACf,iBAAiB;KAClB,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"noop.js","sourceRoot":"","sources":["../../../src/cache/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/provider/redis.d.ts

@@ -1,4 +1,4 @@
-import { type CacheTagsStore } from '../types.js';
+import { type CacheTag, type CacheTagsProvider } from '../types.js';
 type RedisCacheTagsStoreConfig = {
     /**
      * Redis connection string. For example, `redis://user:pass@host:port/db`.
@@ -12,10 +12,15 @@ type RedisCacheTagsStoreConfig = {
     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.
+ * A `CacheTagsProvider` implementation that uses Redis as the storage backend.
  */
-export declare const createCacheTagsStore: ({ connectionUrl, keyPrefix }: RedisCacheTagsStoreConfig) => CacheTagsStore;
+export declare class RedisCacheTagsProvider implements CacheTagsProvider {
+    private readonly redis;
+    private readonly keyPrefix;
+    constructor({ connectionUrl, keyPrefix }: RedisCacheTagsStoreConfig);
+    storeQueryCacheTags(queryId: string, cacheTags: CacheTag[]): Promise<void>;
+    queriesReferencingCacheTags(cacheTags: CacheTag[]): Promise<string[]>;
+    deleteCacheTags(cacheTags: CacheTag[]): Promise<number>;
+    truncateCacheTags(): Promise<number>;
+}
 export {};

package/dist/cache/provider/redis.js

@@ -1,52 +1,48 @@
 import { Redis } from 'ioredis';
 /**
- * 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.
+ * A `CacheTagsProvider` implementation that uses Redis as the storage backend.
  */
-export const createCacheTagsStore = ({ connectionUrl, keyPrefix = '' }) => {
-    const redis = new Redis(connectionUrl, {
-        maxRetriesPerRequest: 3,
-        lazyConnect: true,
-    });
-    const storeQueryCacheTags = async (queryId, cacheTags) => {
+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 = redis.pipeline();
+        const pipeline = this.redis.pipeline();
         for (const tag of cacheTags) {
-            pipeline.sadd(`${keyPrefix}${tag}`, queryId);
+            pipeline.sadd(`${this.keyPrefix}${tag}`, queryId);
         }
         await pipeline.exec();
-    };
-    const queriesReferencingCacheTags = async (cacheTags) => {
+    }
+    async queriesReferencingCacheTags(cacheTags) {
         if (!cacheTags?.length) {
             return [];
         }
-        const keys = cacheTags.map((tag) => `${keyPrefix}${tag}`);
-        return redis.sunion(...keys);
-    };
-    const deleteCacheTags = async (cacheTags) => {
+        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) => `${keyPrefix}${tag}`);
-        return redis.del(...keys);
-    };
-    const truncateCacheTags = async () => {
-        const pattern = `${keyPrefix}*`;
-        const keys = await redis.keys(pattern);
+        const keys = cacheTags.map((tag) => `${this.keyPrefix}${tag}`);
+        return this.redis.del(...keys);
+    }
+    async truncateCacheTags() {
+        const pattern = `${this.keyPrefix}*`;
+        const keys = await this.redis.keys(pattern);
         if (keys.length === 0) {
             return 0;
         }
-        return await redis.del(...keys);
-    };
-    return {
-        storeQueryCacheTags,
-        queriesReferencingCacheTags,
-        deleteCacheTags,
-        truncateCacheTags,
-    };
-};
+        return await this.redis.del(...keys);
+    }
+}
 //# sourceMappingURL=redis.js.map

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;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"}
+{"version":3,"file":"redis.js","sourceRoot":"","sources":["../../../src/cache/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,EAA6B;QACjE,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,OAAO,GAAG,GAAG,IAAI,CAAC,SAAS,GAAG,CAAC;QACrC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE5C,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;CACF"}

package/dist/cache/types.d.ts

@@ -26,7 +26,7 @@ export type CacheTagsInvalidateWebhook = {
 /**
  * Configuration object for creating a `CacheTagsStore` implementation.
  */
-export type CacheTagsStore = {
+export interface CacheTagsProvider {
     /**
      * Stores the cache tags of a query.
      *
@@ -60,4 +60,4 @@ export type CacheTagsStore = {
      * ⚠️ **Warning**: This will delete all cache tag data. Use with caution!
      */
     truncateCacheTags(): Promise<number>;
-};
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartive/datocms-utils",
-  "version": "3.0.0-next.6",
+  "version": "3.0.0-next.7",
   "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,5 +1,5 @@
 import { neon } from '@neondatabase/serverless';
-import { type CacheTag, type CacheTagsStore } from '../types.js';
+import { type CacheTag, type CacheTagsProvider } from '../types.js';
 
 type NeonCacheTagsStoreConfig = {
   /**
@@ -22,15 +22,18 @@ type NeonCacheTagsStoreConfig = {
 };
 
 /**
- * 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.
+ * A `CacheTagsProvider` implementation that uses Neon as the storage backend.
  */
-export const createCacheTagsStore = ({ connectionUrl, table }: NeonCacheTagsStoreConfig): CacheTagsStore => {
-  const sql = neon(connectionUrl, { fullResults: true });
+export class NeonCacheTagsProvider implements CacheTagsProvider {
+  private readonly sql;
+  private readonly table;
 
-  const storeQueryCacheTags = async (queryId: string, cacheTags: CacheTag[]) => {
+  constructor({ connectionUrl, table }: NeonCacheTagsStoreConfig) {
+    this.sql = neon(connectionUrl, { fullResults: true });
+    this.table = table;
+  }
+
+  public async storeQueryCacheTags(queryId: string, cacheTags: CacheTag[]) {
     if (!cacheTags?.length) {
       return;
     }
@@ -38,18 +41,18 @@ export const createCacheTagsStore = ({ connectionUrl, table }: NeonCacheTagsStor
     const tags = cacheTags.flatMap((_, i) => [queryId, cacheTags[i]]);
     const placeholders = cacheTags.map((_, i) => `($${2 * i + 1}, $${2 * i + 2})`).join(',');
 
-    await sql.query(`INSERT INTO ${table} VALUES ${placeholders} ON CONFLICT DO NOTHING`, tags);
-  };
+    await this.sql.query(`INSERT INTO ${this.table} VALUES ${placeholders} ON CONFLICT DO NOTHING`, tags);
+  }
 
-  const queriesReferencingCacheTags = async (cacheTags: CacheTag[]): Promise<string[]> => {
+  public async queriesReferencingCacheTags(cacheTags: CacheTag[]): Promise<string[]> {
     if (!cacheTags?.length) {
       return [];
     }
 
     const placeholders = cacheTags.map((_, i) => `$${i + 1}`).join(',');
 
-    const { rows } = await sql.query(
-      `SELECT DISTINCT query_id FROM ${table} WHERE cache_tag IN (${placeholders})`,
+    const { rows } = await this.sql.query(
+      `SELECT DISTINCT query_id FROM ${this.table} WHERE cache_tag IN (${placeholders})`,
       cacheTags,
     );
 
@@ -60,23 +63,18 @@ export const createCacheTagsStore = ({ connectionUrl, table }: NeonCacheTagsStor
 
       return queryIds;
     }, []);
-  };
+  }
 
-  const deleteCacheTags = async (cacheTags: CacheTag[]) => {
+  public async deleteCacheTags(cacheTags: CacheTag[]) {
     if (cacheTags.length === 0) {
       return 0;
     }
     const placeholders = cacheTags.map((_, i) => `$${i + 1}`).join(',');
 
-    return (await sql.query(`DELETE FROM ${table} WHERE cache_tag IN (${placeholders})`, cacheTags)).rowCount ?? 0;
-  };
-
-  const truncateCacheTags = async () => (await sql.query(`DELETE FROM ${table}`)).rowCount ?? 0;
+    return (await this.sql.query(`DELETE FROM ${this.table} WHERE cache_tag IN (${placeholders})`, cacheTags)).rowCount ?? 0;
+  }
 
-  return {
-    storeQueryCacheTags,
-    queriesReferencingCacheTags,
-    deleteCacheTags,
-    truncateCacheTags,
-  };
-};
+  public async truncateCacheTags() {
+    return (await this.sql.query(`DELETE FROM ${this.table}`)).rowCount ?? 0;
+  }
+}

package/src/cache/provider/noop.ts

@@ -1,41 +1,32 @@
-import { type CacheTag, type CacheTagsStore } from '../types.js';
+import { type CacheTag, type CacheTagsProvider } from '../types.js';
 
 /**
- * Creates a `CacheTagsStore` implementation that does not perform any actual storage operations.
+ * 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._
- *
- * @returns An object implementing the `CacheTagsStore` interface.
  */
-export const createCacheTagsStore = (): CacheTagsStore => {
-  const storeQueryCacheTags = async (queryId: string, cacheTags: CacheTag[]) => {
+export class NoopCacheTagsProvider implements CacheTagsProvider {
+  public async storeQueryCacheTags(queryId: string, cacheTags: CacheTag[]) {
     console.debug('-- storeQueryCacheTags called', { queryId, cacheTags });
 
     return Promise.resolve();
-  };
+  }
 
-  const queriesReferencingCacheTags = async (cacheTags: CacheTag[]) => {
+  public async queriesReferencingCacheTags(cacheTags: CacheTag[]): Promise<string[]> {
     console.debug('-- queriesReferencingCacheTags called', { cacheTags });
 
     return Promise.resolve([]);
-  };
+  }
 
-  const deleteCacheTags = async (cacheTags: CacheTag[]) => {
+  public async deleteCacheTags(cacheTags: CacheTag[]) {
     console.debug('-- deleteCacheTags called', { cacheTags });
 
     return Promise.resolve(0);
-  };
+  }
 
-  const truncateCacheTags = async () => {
+  public async truncateCacheTags() {
     console.debug('-- truncateCacheTags called');
 
     return Promise.resolve(0);
-  };
-
-  return {
-    storeQueryCacheTags,
-    queriesReferencingCacheTags,
-    deleteCacheTags,
-    truncateCacheTags,
-  };
-};
+  }
+}

package/src/cache/provider/redis.ts

@@ -1,5 +1,5 @@
 import { Redis } from 'ioredis';
-import { type CacheTag, type CacheTagsStore } from '../types.js';
+import { type CacheTag, type CacheTagsProvider } from '../types.js';
 
 type RedisCacheTagsStoreConfig = {
   /**
@@ -15,66 +15,62 @@ type RedisCacheTagsStoreConfig = {
 };
 
 /**
- * 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.
+ * A `CacheTagsProvider` implementation that uses Redis as the storage backend.
  */
-export const createCacheTagsStore = ({ connectionUrl, keyPrefix = '' }: RedisCacheTagsStoreConfig): CacheTagsStore => {
-  const redis = new Redis(connectionUrl, {
-    maxRetriesPerRequest: 3,
-    lazyConnect: true,
-  });
-
-  const storeQueryCacheTags = async (queryId: string, cacheTags: CacheTag[]) => {
+export class RedisCacheTagsProvider implements CacheTagsProvider {
+  private readonly redis;
+  private readonly keyPrefix;
+
+  constructor({ connectionUrl, keyPrefix }: RedisCacheTagsStoreConfig) {
+    this.redis = new Redis(connectionUrl, {
+      maxRetriesPerRequest: 3,
+      lazyConnect: true,
+    });
+    this.keyPrefix = keyPrefix ?? '';
+  }
+
+  public async storeQueryCacheTags(queryId: string, cacheTags: CacheTag[]) {
     if (!cacheTags?.length) {
       return;
     }
 
-    const pipeline = redis.pipeline();
+    const pipeline = this.redis.pipeline();
 
     for (const tag of cacheTags) {
-      pipeline.sadd(`${keyPrefix}${tag}`, queryId);
+      pipeline.sadd(`${this.keyPrefix}${tag}`, queryId);
     }
 
     await pipeline.exec();
-  };
+  }
 
-  const queriesReferencingCacheTags = async (cacheTags: CacheTag[]) => {
+  public async queriesReferencingCacheTags(cacheTags: CacheTag[]) {
     if (!cacheTags?.length) {
       return [];
     }
 
-    const keys = cacheTags.map((tag) => `${keyPrefix}${tag}`);
+    const keys = cacheTags.map((tag) => `${this.keyPrefix}${tag}`);
 
-    return redis.sunion(...keys);
-  };
+    return this.redis.sunion(...keys);
+  }
 
-  const deleteCacheTags = async (cacheTags: CacheTag[]) => {
+  public async deleteCacheTags(cacheTags: CacheTag[]) {
     if (!cacheTags?.length) {
       return 0;
     }
 
-    const keys = cacheTags.map((tag) => `${keyPrefix}${tag}`);
+    const keys = cacheTags.map((tag) => `${this.keyPrefix}${tag}`);
 
-    return redis.del(...keys);
-  };
+    return this.redis.del(...keys);
+  }
 
-  const truncateCacheTags = async () => {
-    const pattern = `${keyPrefix}*`;
-    const keys = await redis.keys(pattern);
+  public async truncateCacheTags() {
+    const pattern = `${this.keyPrefix}*`;
+    const keys = await this.redis.keys(pattern);
 
     if (keys.length === 0) {
       return 0;
     }
 
-    return await redis.del(...keys);
-  };
-
-  return {
-    storeQueryCacheTags,
-    queriesReferencingCacheTags,
-    deleteCacheTags,
-    truncateCacheTags,
-  };
-};
+    return await this.redis.del(...keys);
+  }
+}

package/src/cache/types.ts

@@ -26,7 +26,7 @@ export type CacheTagsInvalidateWebhook = {
 /**
  * Configuration object for creating a `CacheTagsStore` implementation.
  */
-export type CacheTagsStore = {
+export interface CacheTagsProvider {
   /**
    * Stores the cache tags of a query.
    *
@@ -63,4 +63,4 @@ export type CacheTagsStore = {
    * ⚠️ **Warning**: This will delete all cache tag data. Use with caution!
    */
   truncateCacheTags(): Promise<number>;
-};
+}