strapi-cache 1.0.0 → 1.1.1

package/README.md

@@ -32,3 +32,21 @@ or
 ```bash
 yarn add strapi-cache
 ```
+
+## ⚙️ Configuration
+
+In your Strapi project, navigate to `config/plugins.js` and add the following configuration:
+
+```javascript
+// config/plugins.{js,ts}
+  'strapi-cache': {
+    enabled: true,
+    config: {
+      debug: false, // Enable debug logs
+      max: 1000, // Maximum number of items in the cache
+      ttl: 1000 * 60 * 60, // Time to live for cache items (1 hour)
+      size: 1024 * 1024 * 1024, // Maximum size of the cache (1 GB)
+      allowStale: false, // Allow stale cache items
+    },
+  },
+```

package/dist/_chunks/en-BgoZyxl0.mjs

@@ -7,4 +7,3 @@ const en = {
 export {
   en as default
 };
-//# sourceMappingURL=en-BgoZyxl0.mjs.map

package/dist/_chunks/en-CIN0kRXJ.js

@@ -7,4 +7,3 @@ const en = {
   "strapi-cache.view.settings.subtitle": "Configure what to cache"
 };
 exports.default = en;
-//# sourceMappingURL=en-CIN0kRXJ.js.map

package/dist/admin/index.js

@@ -1,4 +1,49 @@
 "use strict";
-const index = require("../_chunks/index-BNNfEmGs.js");
-module.exports = index.index;
-//# sourceMappingURL=index.js.map
+const react = require("react");
+const __variableDynamicImportRuntimeHelper = (glob, path, segs) => {
+  const v = glob[path];
+  if (v) {
+    return typeof v === "function" ? v() : Promise.resolve(v);
+  }
+  return new Promise((_, reject) => {
+    (typeof queueMicrotask === "function" ? queueMicrotask : setTimeout)(
+      reject.bind(
+        null,
+        new Error(
+          "Unknown variable dynamic import: " + path + (path.split("/").length !== segs ? ". Note that variables only represent file names one level deep." : "")
+        )
+      )
+    );
+  });
+};
+const PLUGIN_ID = "strapi-cache";
+const Initializer = ({ setPlugin }) => {
+  const ref = react.useRef(setPlugin);
+  react.useEffect(() => {
+    ref.current(PLUGIN_ID);
+  }, []);
+  return null;
+};
+const index = {
+  register(app) {
+    app.registerPlugin({
+      id: PLUGIN_ID,
+      initializer: Initializer,
+      isReady: false,
+      name: PLUGIN_ID
+    });
+  },
+  async registerTrads({ locales }) {
+    return Promise.all(
+      locales.map(async (locale) => {
+        try {
+          const { default: data } = await __variableDynamicImportRuntimeHelper(/* @__PURE__ */ Object.assign({ "./translations/en.json": () => Promise.resolve().then(() => require("../_chunks/en-CIN0kRXJ.js")) }), `./translations/${locale}.json`, 3);
+          return { data, locale };
+        } catch {
+          return { data: {}, locale };
+        }
+      })
+    );
+  }
+};
+module.exports = index;

package/dist/admin/index.mjs

@@ -1,5 +1,50 @@
-import { i } from "../_chunks/index-D84x8OCy.mjs";
+import { useRef, useEffect } from "react";
+const __variableDynamicImportRuntimeHelper = (glob, path, segs) => {
+  const v = glob[path];
+  if (v) {
+    return typeof v === "function" ? v() : Promise.resolve(v);
+  }
+  return new Promise((_, reject) => {
+    (typeof queueMicrotask === "function" ? queueMicrotask : setTimeout)(
+      reject.bind(
+        null,
+        new Error(
+          "Unknown variable dynamic import: " + path + (path.split("/").length !== segs ? ". Note that variables only represent file names one level deep." : "")
+        )
+      )
+    );
+  });
+};
+const PLUGIN_ID = "strapi-cache";
+const Initializer = ({ setPlugin }) => {
+  const ref = useRef(setPlugin);
+  useEffect(() => {
+    ref.current(PLUGIN_ID);
+  }, []);
+  return null;
+};
+const index = {
+  register(app) {
+    app.registerPlugin({
+      id: PLUGIN_ID,
+      initializer: Initializer,
+      isReady: false,
+      name: PLUGIN_ID
+    });
+  },
+  async registerTrads({ locales }) {
+    return Promise.all(
+      locales.map(async (locale) => {
+        try {
+          const { default: data } = await __variableDynamicImportRuntimeHelper(/* @__PURE__ */ Object.assign({ "./translations/en.json": () => import("../_chunks/en-BgoZyxl0.mjs") }), `./translations/${locale}.json`, 3);
+          return { data, locale };
+        } catch {
+          return { data: {}, locale };
+        }
+      })
+    );
+  }
+};
 export {
-  i as default
+  index as default
 };
-//# sourceMappingURL=index.mjs.map

package/dist/server/index.js

@@ -7,12 +7,24 @@ const _interopDefault = (e) => e && e.__esModule ? e : { default: e };
 const rawBody__default = /* @__PURE__ */ _interopDefault(rawBody);
 const loggy = {
   info: (msg) => {
+    const shouldDebug = strapi.plugin("strapi-cache").config("debug") ?? false;
+    if (!shouldDebug) {
+      return;
+    }
     strapi.log.info(`[STRAPI CACHE] ${msg}`);
   },
   error: (msg) => {
+    const shouldDebug = strapi.plugin("strapi-cache").config("debug") ?? false;
+    if (!shouldDebug) {
+      return;
+    }
     strapi.log.error(`[STRAPI CACHE] ${msg}`);
   },
   warn: (msg) => {
+    const shouldDebug = strapi.plugin("strapi-cache").config("debug") ?? false;
+    if (!shouldDebug) {
+      return;
+    }
     strapi.log.warn(`[STRAPI CACHE] ${msg}`);
   }
 };
@@ -157,8 +169,29 @@ const register = ({ strapi: strapi2 }) => {
   strapi2.server.use(middlewares.graphql);
 };
 const config = {
-  default: {},
-  validator() {
+  default: ({ env }) => ({
+    debug: false,
+    max: 1e3,
+    ttl: 1e3 * 60 * 60,
+    size: 1024 * 1014 * 10,
+    allowStale: false
+  }),
+  validator: (config2) => {
+    if (typeof config2.debug !== "boolean") {
+      throw new Error(`Invalid config: debug must be a boolean`);
+    }
+    if (typeof config2.max !== "number") {
+      throw new Error(`Invalid config: max must be a number`);
+    }
+    if (typeof config2.ttl !== "number") {
+      throw new Error(`Invalid config: ttl must be a number`);
+    }
+    if (typeof config2.size !== "number") {
+      throw new Error(`Invalid config: size must be a number`);
+    }
+    if (typeof config2.allowStale !== "boolean") {
+      throw new Error(`Invalid config: allowStale must be a boolean`);
+    }
   }
 };
 const contentTypes = {};
@@ -221,10 +254,15 @@ const service = ({ strapi: strapi2 }) => {
             return;
           }
           initialized = true;
+          const max = strapi2.plugin("strapi-cache").config("max");
+          const ttl = strapi2.plugin("strapi-cache").config("ttl");
+          const size = strapi2.plugin("strapi-cache").config("size");
+          const allowStale = strapi2.plugin("strapi-cache").config("allowStale");
           provider = new lruCache.LRUCache({
-            max: 1024 * 1014 * 10,
-            ttl: 1e3 * 60 * 60,
-            size: 1e3
+            max: Number(max),
+            ttl: Number(ttl),
+            size: Number(size),
+            allowStale: allowStale ? true : false
           });
           loggy.info("Provider initialized");
         },
@@ -371,4 +409,3 @@ const index = {
   middlewares
 };
 module.exports = index;
-//# sourceMappingURL=index.js.map

package/dist/server/index.mjs

@@ -4,12 +4,24 @@ import { Readable } from "stream";
 import { LRUCache } from "lru-cache";
 const loggy = {
   info: (msg) => {
+    const shouldDebug = strapi.plugin("strapi-cache").config("debug") ?? false;
+    if (!shouldDebug) {
+      return;
+    }
     strapi.log.info(`[STRAPI CACHE] ${msg}`);
   },
   error: (msg) => {
+    const shouldDebug = strapi.plugin("strapi-cache").config("debug") ?? false;
+    if (!shouldDebug) {
+      return;
+    }
     strapi.log.error(`[STRAPI CACHE] ${msg}`);
   },
   warn: (msg) => {
+    const shouldDebug = strapi.plugin("strapi-cache").config("debug") ?? false;
+    if (!shouldDebug) {
+      return;
+    }
     strapi.log.warn(`[STRAPI CACHE] ${msg}`);
   }
 };
@@ -154,8 +166,29 @@ const register = ({ strapi: strapi2 }) => {
   strapi2.server.use(middlewares.graphql);
 };
 const config = {
-  default: {},
-  validator() {
+  default: ({ env }) => ({
+    debug: false,
+    max: 1e3,
+    ttl: 1e3 * 60 * 60,
+    size: 1024 * 1014 * 10,
+    allowStale: false
+  }),
+  validator: (config2) => {
+    if (typeof config2.debug !== "boolean") {
+      throw new Error(`Invalid config: debug must be a boolean`);
+    }
+    if (typeof config2.max !== "number") {
+      throw new Error(`Invalid config: max must be a number`);
+    }
+    if (typeof config2.ttl !== "number") {
+      throw new Error(`Invalid config: ttl must be a number`);
+    }
+    if (typeof config2.size !== "number") {
+      throw new Error(`Invalid config: size must be a number`);
+    }
+    if (typeof config2.allowStale !== "boolean") {
+      throw new Error(`Invalid config: allowStale must be a boolean`);
+    }
   }
 };
 const contentTypes = {};
@@ -218,10 +251,15 @@ const service = ({ strapi: strapi2 }) => {
             return;
           }
           initialized = true;
+          const max = strapi2.plugin("strapi-cache").config("max");
+          const ttl = strapi2.plugin("strapi-cache").config("ttl");
+          const size = strapi2.plugin("strapi-cache").config("size");
+          const allowStale = strapi2.plugin("strapi-cache").config("allowStale");
           provider = new LRUCache({
-            max: 1024 * 1014 * 10,
-            ttl: 1e3 * 60 * 60,
-            size: 1e3
+            max: Number(max),
+            ttl: Number(ttl),
+            size: Number(size),
+            allowStale: allowStale ? true : false
           });
           loggy.info("Provider initialized");
         },
@@ -370,4 +408,3 @@ const index = {
 export {
   index as default
 };
-//# sourceMappingURL=index.mjs.map

package/dist/server/src/config/index.d.ts

@@ -1,5 +1,13 @@
 declare const _default: {
-    default: {};
-    validator(): void;
+    default: ({ env }: {
+        env: any;
+    }) => {
+        debug: boolean;
+        max: number;
+        ttl: number;
+        size: number;
+        allowStale: boolean;
+    };
+    validator: (config: any) => void;
 };
 export default _default;

package/dist/server/src/index.d.ts

@@ -12,8 +12,16 @@ declare const _default: {
         strapi: import("@strapi/types/dist/core").Strapi;
     }) => void;
     config: {
-        default: {};
-        validator(): void;
+        default: ({ env }: {
+            env: any;
+        }) => {
+            debug: boolean;
+            max: number;
+            ttl: number;
+            size: number;
+            allowStale: boolean;
+        };
+        validator: (config: any) => void;
     };
     controllers: {
         controller: ({ strapi }: {

package/package.json

@@ -1,6 +1,11 @@
 {
-  "version": "1.0.0",
-  "keywords": ["strapi cache", "strapi rest cache", "strapi 5 cache","strapi v5 cache plugin"],
+  "version": "1.1.1",
+  "keywords": [
+    "strapi cache",
+    "strapi rest cache",
+    "strapi 5 cache",
+    "strapi v5 cache plugin"
+  ],
   "type": "commonjs",
   "exports": {
     "./package.json": "./package.json",
@@ -65,10 +70,10 @@
     "kind": "plugin",
     "name": "strapi-cache",
     "displayName": "Strapi Cache",
-    "description": "A LRU-Cache plugin for strapi"
+    "description": "A LRU-Cache plugin for strapi v5"
   },
   "name": "strapi-cache",
-  "description": "A LRU-Cache plugin for strapi",
+  "description": "A LRU-Cache plugin for strapi v5",
   "license": "MIT",
   "author": "TupiC <christoph.tupi@gmail.com>"
 }