sprint-es 0.0.21 → 0.0.23

package/README.md

@@ -12,7 +12,7 @@
   <hr />
 </div>
 
-## Modules
+## Features
 
 **Sprint** provides different modules depending on the required use.
 
@@ -25,6 +25,7 @@
 | CORS, Morgan, and similar modules preinstalled                         | 🟢 Active      |
 | Preconfigured health check and 404 error pages                         | 🟢 Active      |
 | Anti-directory listing rate limiting system                            | 🟢 Active      |
+| Logger module included to reduce memory consumption                    | 🟢 Active      |
 
 ```ts
 import Sprint from "sprint-es";
@@ -102,4 +103,58 @@ export default defineMiddleware({
         next();
     }
 });
-```
+```
+
+#### Define Rate Limit
+
+```ts
+import { defineMiddleware } from "sprint-es";
+import { createRateLimit } from "sprint-es/rate-limit";
+
+const ratelimitIp = createRateLimit(3, "5s", "ip", {
+    blockDuration: "1m"
+});
+
+export default defineMiddleware({
+    name: "rate-limit",
+    priority: 7, // Runs after logger.
+    include: "/**",
+    handler: async (req, res, next) => {
+        const { success, limit, remaining, reset } = await ratelimitIp.limit(req.ip);
+
+        if (!success) return res.status(429).send("Too many requests. Try again later.");
+
+        console.log(`Request allowed. Remaining: ${remaining}/${limit}`);
+        next();
+    }
+});
+```
+
+More info: https://docs.tpeoficial.com/docs/toolkitify/rate-limit/introduction
+
+#### Use Logger
+
+Logger is designed to reduce memory consumption when using `console.logs`. Using it will improve the performance of your API.
+
+```ts
+import { defineMiddleware } from "sprint-es";
+import { logger } from "sprint-es/logger";
+
+export default defineMiddleware({
+    name: "logger",
+    priority: 5, // Runs first.
+    include: "/**", // All routes.
+    handler: (req, res, next) => {
+        const start = Date.now();
+
+        res.on("finish", () => {
+            const duration = Date.now() - start;
+            logger.info(`${req.method} ${req.originalUrl} - ${res.statusCode} (${duration}ms)`);
+        });
+
+        next();
+    }
+});
+```
+
+More info: https://docs.tpeoficial.com/docs/toolkitify/logger/introduction

package/dist/cjs/index.cjs

@@ -205,6 +205,7 @@ class Sprint {
             key,
             limit: 5,
             interval: "10s",
+            blockDuration: "1m",
             storage: "memory"
           }).then((result) => {
             if (!result.success) {
@@ -254,6 +255,7 @@ class Sprint {
     const healthRoute = this.prefix ? `${this.prefix}/healthcheck` : "/healthcheck";
     this.server.listen(port, () => {
       const prefixInfo = this.prefix ? ` (prefix: ${this.prefix})` : "";
+      console.log("\x1B[36m\x1B[1m%s\x1B[0m", `[Sprint] Need stronger route protection? Enhance your security by verifying User-Agent, IP and request patterns. Learn more at https://docs.tpeoficial.com/docs/dymo-api/private/request-verifier.`);
       console.log("\x1B[32m%s\x1B[0m", `[Sprint] Server running on http://localhost:${port}${prefixInfo}`);
       console.log("\x1B[32m%s\x1B[0m", `[Sprint] Healthcheck: http://localhost:${port}${healthRoute}`);
     });

package/dist/cjs/modules/logger/index.cjs

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const logger = require("toolkitify/logger");
+Object.defineProperty(exports, "Logger", {
+  enumerable: true,
+  get: () => logger.Logger
+});
+Object.defineProperty(exports, "logger", {
+  enumerable: true,
+  get: () => logger.logger
+});

package/dist/esm/index.js

@@ -202,6 +202,7 @@ class Sprint {
             key,
             limit: 5,
             interval: "10s",
+            blockDuration: "1m",
             storage: "memory"
           }).then((result) => {
             if (!result.success) {
@@ -251,6 +252,7 @@ class Sprint {
     const healthRoute = this.prefix ? `${this.prefix}/healthcheck` : "/healthcheck";
     this.server.listen(port, () => {
       const prefixInfo = this.prefix ? ` (prefix: ${this.prefix})` : "";
+      console.log("\x1B[36m\x1B[1m%s\x1B[0m", `[Sprint] Need stronger route protection? Enhance your security by verifying User-Agent, IP and request patterns. Learn more at https://docs.tpeoficial.com/docs/dymo-api/private/request-verifier.`);
       console.log("\x1B[32m%s\x1B[0m", `[Sprint] Server running on http://localhost:${port}${prefixInfo}`);
       console.log("\x1B[32m%s\x1B[0m", `[Sprint] Healthcheck: http://localhost:${port}${healthRoute}`);
     });

package/dist/esm/modules/logger/index.js

@@ -0,0 +1,5 @@
+import { Logger, logger } from "toolkitify/logger";
+export {
+  Logger,
+  logger
+};

package/dist/types/modules/logger/index.d.ts

@@ -0,0 +1,3 @@
+import { Logger, logger } from 'toolkitify/logger';
+export { Logger, logger };
+//# sourceMappingURL=index.d.ts.map

package/dist/types/modules/logger/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/modules/logger/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEnD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC"}

package/dist/types/sprint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sprint.d.ts","sourceRoot":"","sources":["../../src/sprint.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAsC,MAAM,SAAS,CAAC;AACrF,OAAO,OAAO,EAAE,EAAE,WAAW,EAA2C,MAAM,SAAS,CAAC;AAQxF,qBAAa,MAAM;IACR,GAAG,EAAE,WAAW,CAAC;IACxB,OAAO,CAAC,IAAI,CAAqC;IACjD,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,iBAAiB,CAA0B;gBAEvC,EACR,IAAuB,EACvB,UAAuB,EACvB,eAAiC,EACjC,SAAkB,EAClB,eAAwB,EACxB,MAAW,EACd,GAAE,aAAkB;YAeP,IAAI;IAsBlB,OAAO,CAAC,YAAY;IAoBpB;;OAEG;IACH,OAAO,CAAC,sBAAsB;IA4B9B;;OAEG;YACW,eAAe;IAgC7B,OAAO,CAAC,eAAe;YAcT,UAAU;IAgDxB,OAAO,CAAC,YAAY;IA+BpB,+BAA+B;IAC/B,OAAO,CAAC,WAAW;IAMZ,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAClC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IACnC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAClC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IACrC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IACpC,GAAG,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,EAAE,YAAY,CAAC,EAAE,OAAO;IAK3D,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,IAAI,GAAG,IAAI;CAe7C"}
+{"version":3,"file":"sprint.d.ts","sourceRoot":"","sources":["../../src/sprint.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAsC,MAAM,SAAS,CAAC;AACrF,OAAO,OAAO,EAAE,EAAE,WAAW,EAA2C,MAAM,SAAS,CAAC;AAQxF,qBAAa,MAAM;IACR,GAAG,EAAE,WAAW,CAAC;IACxB,OAAO,CAAC,IAAI,CAAqC;IACjD,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,iBAAiB,CAA0B;gBAEvC,EACR,IAAuB,EACvB,UAAuB,EACvB,eAAiC,EACjC,SAAkB,EAClB,eAAwB,EACxB,MAAW,EACd,GAAE,aAAkB;YAeP,IAAI;IAsBlB,OAAO,CAAC,YAAY;IAoBpB;;OAEG;IACH,OAAO,CAAC,sBAAsB;IA4B9B;;OAEG;YACW,eAAe;IAgC7B,OAAO,CAAC,eAAe;YAcT,UAAU;IAgDxB,OAAO,CAAC,YAAY;IAgCpB,+BAA+B;IAC/B,OAAO,CAAC,WAAW;IAMZ,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAClC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IACnC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAClC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IACrC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IACpC,GAAG,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,EAAE,YAAY,CAAC,EAAE,OAAO;IAK3D,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,IAAI,GAAG,IAAI;CAgB7C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sprint-es",
-  "version": "0.0.21",
+  "version": "0.0.23",
   "description": "Sprint - Quickly API",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -12,6 +12,11 @@
       "require": "./dist/cjs/index.cjs",
       "import": "./dist/esm/index.js"
     },
+    "./logger": {
+      "types": "./dist/types/modules/logger/index.d.ts",
+      "require": "./dist/cjs/modules/logger/index.cjs",
+      "import": "./dist/esm/modules/logger/index.js"
+    },
     "./rate-limit": {
       "types": "./dist/types/modules/rate-limit/index.d.ts",
       "require": "./dist/cjs/modules/rate-limit/index.cjs",
@@ -53,7 +58,7 @@
     "morgan": "^1.10.1",
     "path": "^0.12.7",
     "serve-favicon": "^2.5.1",
-    "toolkitify": "^0.0.20"
+    "toolkitify": "^0.0.26"
   },
   "contributors": [
     "TPEOficial (https://github.com/TPEOficial)",
@@ -79,4 +84,4 @@
     "tabWidth": 4,
     "useTabs": false
   }
-}
+}