@spoosh/plugin-throttle 0.1.11 → 0.3.0

package/dist/index.d.mts

@@ -4,7 +4,7 @@ interface ThrottleReadOptions {
     /** Throttle requests to max 1 per X milliseconds. Extras return cached data. */
     throttle?: number;
 }
-type ThrottleInfiniteReadOptions = ThrottleReadOptions;
+type ThrottlePagesOptions = ThrottleReadOptions;
 type ThrottleWriteOptions = object;
 type ThrottleReadResult = object;
 type ThrottleWriteResult = object;
@@ -39,9 +39,9 @@ type ThrottleWriteResult = object;
 declare function throttlePlugin(): SpooshPlugin<{
     readOptions: ThrottleReadOptions;
     writeOptions: ThrottleWriteOptions;
-    infiniteReadOptions: ThrottleInfiniteReadOptions;
+    pagesOptions: ThrottlePagesOptions;
     readResult: ThrottleReadResult;
     writeResult: ThrottleWriteResult;
 }>;
 
-export { type ThrottleInfiniteReadOptions, type ThrottleReadOptions, type ThrottleReadResult, type ThrottleWriteOptions, type ThrottleWriteResult, throttlePlugin };
+export { type ThrottlePagesOptions, type ThrottleReadOptions, type ThrottleReadResult, type ThrottleWriteOptions, type ThrottleWriteResult, throttlePlugin };

package/dist/index.d.ts

@@ -4,7 +4,7 @@ interface ThrottleReadOptions {
     /** Throttle requests to max 1 per X milliseconds. Extras return cached data. */
     throttle?: number;
 }
-type ThrottleInfiniteReadOptions = ThrottleReadOptions;
+type ThrottlePagesOptions = ThrottleReadOptions;
 type ThrottleWriteOptions = object;
 type ThrottleReadResult = object;
 type ThrottleWriteResult = object;
@@ -39,9 +39,9 @@ type ThrottleWriteResult = object;
 declare function throttlePlugin(): SpooshPlugin<{
     readOptions: ThrottleReadOptions;
     writeOptions: ThrottleWriteOptions;
-    infiniteReadOptions: ThrottleInfiniteReadOptions;
+    pagesOptions: ThrottlePagesOptions;
     readResult: ThrottleReadResult;
     writeResult: ThrottleWriteResult;
 }>;
 
-export { type ThrottleInfiniteReadOptions, type ThrottleReadOptions, type ThrottleReadResult, type ThrottleWriteOptions, type ThrottleWriteResult, throttlePlugin };
+export { type ThrottlePagesOptions, type ThrottleReadOptions, type ThrottleReadResult, type ThrottleWriteOptions, type ThrottleWriteResult, throttlePlugin };

package/dist/index.js

@@ -25,27 +25,39 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/plugin.ts
+var PLUGIN_NAME = "spoosh:throttle";
 function throttlePlugin() {
   const lastFetchTime = /* @__PURE__ */ new Map();
   return {
-    name: "spoosh:throttle",
-    operations: ["read", "infiniteRead"],
+    name: PLUGIN_NAME,
+    operations: ["read", "pages"],
     priority: 100,
     middleware: async (context, next) => {
+      const t = context.tracer?.(PLUGIN_NAME);
+      const et = context.eventTracer?.(PLUGIN_NAME);
       const pluginOptions = context.pluginOptions;
       const throttleMs = pluginOptions?.throttle;
       if (!throttleMs || throttleMs <= 0) {
+        t?.skip("No throttle configured");
         return next();
       }
-      const { path, method } = context;
+      const { path, method, queryKey } = context;
       const stableKey = `${path}:${method}`;
       const now = Date.now();
       const lastTime = lastFetchTime.get(stableKey) ?? 0;
       const elapsed = now - lastTime;
       if (elapsed < throttleMs) {
+        const remaining = throttleMs - elapsed;
+        et?.emit(`Request blocked (${remaining}ms remaining)`, {
+          queryKey,
+          color: "warning",
+          meta: { throttle: throttleMs, elapsed, remaining }
+        });
+        t?.return("Throttled", { color: "warning" });
         return { data: void 0, status: 0 };
       }
       lastFetchTime.set(stableKey, now);
+      t?.log("Request allowed");
       return next();
     }
   };

package/dist/index.mjs

@@ -1,25 +1,37 @@
 // src/plugin.ts
+var PLUGIN_NAME = "spoosh:throttle";
 function throttlePlugin() {
   const lastFetchTime = /* @__PURE__ */ new Map();
   return {
-    name: "spoosh:throttle",
-    operations: ["read", "infiniteRead"],
+    name: PLUGIN_NAME,
+    operations: ["read", "pages"],
     priority: 100,
     middleware: async (context, next) => {
+      const t = context.tracer?.(PLUGIN_NAME);
+      const et = context.eventTracer?.(PLUGIN_NAME);
       const pluginOptions = context.pluginOptions;
       const throttleMs = pluginOptions?.throttle;
       if (!throttleMs || throttleMs <= 0) {
+        t?.skip("No throttle configured");
         return next();
       }
-      const { path, method } = context;
+      const { path, method, queryKey } = context;
       const stableKey = `${path}:${method}`;
       const now = Date.now();
       const lastTime = lastFetchTime.get(stableKey) ?? 0;
       const elapsed = now - lastTime;
       if (elapsed < throttleMs) {
+        const remaining = throttleMs - elapsed;
+        et?.emit(`Request blocked (${remaining}ms remaining)`, {
+          queryKey,
+          color: "warning",
+          meta: { throttle: throttleMs, elapsed, remaining }
+        });
+        t?.return("Throttled", { color: "warning" });
         return { data: void 0, status: 0 };
       }
       lastFetchTime.set(stableKey, now);
+      t?.log("Request allowed");
       return next();
     }
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spoosh/plugin-throttle",
-  "version": "0.1.11",
+  "version": "0.3.0",
   "description": "Request throttling plugin for Spoosh - limits request frequency",
   "license": "MIT",
   "repository": {
@@ -33,11 +33,11 @@
     }
   },
   "peerDependencies": {
-    "@spoosh/core": ">=0.12.1"
+    "@spoosh/core": ">=0.15.0"
   },
   "devDependencies": {
-    "@spoosh/core": "0.12.1",
-    "@spoosh/test-utils": "0.1.8"
+    "@spoosh/core": "0.15.0",
+    "@spoosh/test-utils": "0.3.0"
   },
   "scripts": {
     "dev": "tsup --watch",