Rename and cleanup

Author: AyronK

README.md

@@ -130,10 +130,10 @@ const redisHandler = await createRedisHandler({
 ```js
 import { createCluster } from "@redis/client";
 import createRedisHandler from "@fortedigital/nextjs-cache-handler/redis-strings";
-import { withProxy } from "@fortedigital/nextjs-cache-handler/cluster/proxy";
+import { withAdapter } from "@fortedigital/nextjs-cache-handler/cluster/adapter";
 
 const { hostname: redisHostName } = new URL(process.env.REDIS_URL);
-redis = withProxy(
+redis = withAdapter(
   createCluster({
     rootNodes: [{ url: process.env.REDIS_URL }],
 
@@ -149,7 +149,7 @@ redis = withProxy(
   })
 );
 
-// after using withProxy you can use redis cluster instance as parameter for createRedisHandler
+// after using withAdapter you can use redis cluster instance as parameter for createRedisHandler
 const redisCacheHandler = createRedisHandler({
   client: redis,
   keyPrefix: CACHE_PREFIX,

packages/nextjs-cache-handler/package-lock.json

@@ -18,7 +18,7 @@
     "next",
     "redis"
   ],
-  "version": "2.1.0-canary9",
+  "version": "2.1.0-canary10",
   "type": "module",
   "license": "MIT",
   "description": "Next.js cache handlers",
@@ -35,9 +35,9 @@
       "require": "./dist/instrumentation/instrumentation.cjs",
       "import": "./dist/instrumentation/instrumentation.js"
     },
-    "./cluster/proxy": {
-      "require": "./dist/helpers/redisClusterProxy.cjs",
-      "import": "./dist/helpers/redisClusterProxy.js"
+    "./cluster/adapter": {
+      "require": "./dist/helpers/redisClusterAdapter.cjs",
+      "import": "./dist/helpers/redisClusterAdapter.js"
     },
     "./helpers/withAbortSignal": {
       "require": "./dist/helpers/withAbortSignal.cjs",
@@ -65,8 +65,8 @@
       "local-lru": [
         "dist/handlers/local-lru.d.ts"
       ],
-      "cluster/proxy": [
-        "dist/helpers/redisClusterProxy.d.ts"
+      "cluster/adapter": [
+        "dist/helpers/redisClusterAdapter.d.ts"
       ],
       "helpers/withAbortSignal": [
         "dist/helpers/withAbortSignal.d.ts"

packages/nextjs-cache-handler/package.json

@@ -7,7 +7,7 @@ import {
   parseBuffersToStrings,
 } from "../helpers/buffer";
 import type { RedisClientType } from "@redis/client";
-import { RedisClusterCacheProxy } from "../helpers/redisClusterProxy";
+import { RedisClusterCacheAdapter } from "../helpers/redisClusterAdapter";
 import { withAbortSignalProxy } from "../helpers/withAbortSignalProxy";
 
 /**
@@ -34,7 +34,7 @@ export default function createHandler({
   keyExpirationStrategy = "EXPIREAT",
   revalidateTagQuerySize = 10_000,
 }: CreateRedisStringsHandlerOptions<
-  RedisClientType | RedisClusterCacheProxy
+  RedisClientType | RedisClusterCacheAdapter
 >): Handler {
   const client = withAbortSignalProxy(innerClient);
 

packages/nextjs-cache-handler/src/handlers/redis-strings.ts

@@ -1,12 +1,12 @@
 import type { RedisClusterType } from "@redis/client";
 
-export type RedisClusterCacheProxy = RedisClusterType & {
+export type RedisClusterCacheAdapter = RedisClusterType & {
   isReady: boolean;
 };
 
-export function withProxy<T extends RedisClusterType>(
+export function withAdapter<T extends RedisClusterType>(
   cluster: RedisClusterType,
-): RedisClusterCacheProxy {
+): RedisClusterCacheAdapter {
   const handler: ProxyHandler<T> = {
     get(target, prop, receiver) {
       if (prop === "isReady") {
@@ -17,5 +17,5 @@ export function withProxy<T extends RedisClusterType>(
     },
   };
 
-  return new Proxy(cluster, handler) as RedisClusterCacheProxy;
+  return new Proxy(cluster, handler) as RedisClusterCacheAdapter;
 }

packages/nextjs-cache-handler/src/helpers/redisClusterProxy.ts renamed to packages/nextjs-cache-handler/src/helpers/redisClusterAdapter.ts

@@ -5,7 +5,7 @@ export const tsup = defineConfig({
   entry: [
     "src/handlers/*.ts",
     "src/instrumentation/*.ts",
-    "src/helpers/redisClusterProxy.ts",
+    "src/helpers/redisClusterAdapter.ts",
     "src/helpers/withAbortSignal.ts",
     "src/helpers/withAbortSignalProxy.ts",
   ],