Initial commit

Author: AyronK

.LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+This extension is developed and maintained by Forte Digital. For more information about our products and services, visit [our website](https://fortedigital.com).
+
+Copyright (c) 2024 Forte_ Digital and Arseny Kruglikov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,63 @@
+# @fortedigital/nextjs-cache-handler
+
+This package extends the functionality of [`@neshca/cache-handler`](https://www.npmjs.com/package/@neshca/cache-handler) by providing additional cache handlers for specialized use cases, specifically for Redis-based caching solutions. The original `@neshca/cache-handler` offers a robust caching API for Next.js applications, and this package introduces two new handlers for managing Redis cache with different expiration strategies and tag-based revalidation.
+
+## Installation
+
+To install this package along with its dependencies:
+
+```bash
+npm install @fortedigital/nextjs-cache-handler
+```
+
+Ensure that you have already set up `@neshca/cache-handler` before integrating these extended handlers.
+
+## Handlers
+
+### 1. `redis-strings`
+
+This handler is designed to manage cache operations using Redis strings. It supports key-based and tag-based caching with flexible expiration strategies.
+
+#### Features:
+
+- **Key Expiration Strategy**: Choose between `EXAT` (more efficient with Redis 6.2 or newer) or `EXPIREAT` (compatible with Redis 4.0 or newer).
+- **Tag-based Revalidation**: Supports cache revalidation using tags for efficient and fine-grained cache invalidation.
+- **TTL Management**: Automatically manages time-to-live (TTL) for cache keys and tags.
+
+#### Usage:
+
+```js
+const redisHandler = await createHandler({
+  client, // Redis client instance
+  keyPrefix: "myApp:",
+  sharedTagsKey: "myTags",
+  sharedTagsTtlKey: "myTagTtls",
+});
+```
+
+### 2. `composite`
+
+The composite handler allows for managing cache operations using a combination of other handlers. It provides a flexible way to route cache operations to multiple underlying handlers based on a defined strategy.
+
+#### Features:
+
+- **Flexible Handling**: Supports multiple handlers, enabling complex caching strategies.
+- **Custom Set Strategy**: Allows you to define how cache entries are routed to different handlers.
+- **On-Demand Revalidation**: Retrieves values from the first available handler, ensuring efficient data access.
+
+#### Usage:
+
+```js
+const compositeHandler = createHandler({
+  handlers: [handler1, handler2], // Array of underlying handlers
+  setStrategy: (data) => (data?.tags.includes("handler1") ? 0 : 1),
+});
+```
+
+## Reference to Original Package
+
+This package builds upon the core functionality provided by [`@neshca/cache-handler`](https://www.npmjs.com/package/@neshca/cache-handler). You can find more information about the core library, including usage examples and API documentation, at the [official documentation page](https://caching-tools.github.io/next-shared-cache).
+
+## License
+
+This project is licensed under the [MIT License](./LICENSE), as is the original `@neshca/cache-handler` package.

packages/nextjs-cache-handler/.gitignore

@@ -0,0 +1,30 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+.vscode
+
+# dependencies
+/node_modules
+/studio/node_modules
+/.pnp
+.pnp.js
+
+# production
+/dist
+
+# misc
+.DS_Store
+*.pem
+.vscode
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# IntelliJ
+.idea
+*.iml
+
+# typescript
+*.tsbuildinfo

packages/nextjs-cache-handler/.prettierrc.js

@@ -0,0 +1,11 @@
+export const endOfLine = "crlf";
+export const printWidth = 100;
+export const tabWidth = 4;
+export const useTabs = false;
+export const singleQuote = false;
+export const semi = true;
+export const trailingComma = "all";
+export const bracketSpacing = true;
+export const bracketSameLine = false;
+export const arrowParens = "always";
+export const quoteProps = "as-needed";

packages/nextjs-cache-handler/eslint.config.json

@@ -0,0 +1,39 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "plugins": ["@typescript-eslint", "simple-import-sort"],
+  "rules": {
+    "@typescript-eslint/no-unused-vars": ["error"],
+    "array-callback-return": "warn",
+    "eqeqeq": "warn",
+    "func-style": [
+      "warn",
+      "declaration",
+      {
+        "allowArrowFunctions": true
+      }
+    ],
+    "import/first": "warn",
+    "import/newline-after-import": "warn",
+    "import/no-duplicates": "warn",
+    "multiline-comment-style": ["warn", "starred-block"],
+    "no-lonely-if": "warn",
+    "no-self-compare": "error",
+    "no-template-curly-in-string": "error",
+    "no-unreachable-loop": "warn",
+    "no-unused-expressions": "warn",
+    "no-unused-vars": "off",
+    "no-var": "error",
+    "prefer-arrow-callback": "warn",
+    "prefer-const": "warn",
+    "prefer-promise-reject-errors": "warn",
+    "prefer-spread": "warn",
+    "simple-import-sort/exports": "warn",
+    "simple-import-sort/imports": "warn"
+  },
+  "root": true
+}