@deenruv/apollo-cache 1.0.0

package/LICENSE

@@ -0,0 +1,23 @@
+# License 1
+
+The MIT License
+
+Copyright (c) 2025-present Aexol
+
+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.
+
+# License 2
+
+The MIT License
+
+Copyright (c) 2018-2025 Michael Bromley
+
+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.

package/README.md

@@ -0,0 +1,46 @@
+# @deenruv/apollo-cache
+
+Server-side response caching plugin for Deenruv, powered by Apollo Server's response cache and cache control plugins. It enables HTTP-level caching of GraphQL responses with session-aware cache keys.
+
+## Installation
+
+```bash
+pnpm add @deenruv/apollo-cache
+```
+
+## Configuration
+
+```typescript
+import { ApolloCachePlugin } from '@deenruv/apollo-cache';
+
+// In your Deenruv server config:
+plugins: [
+  ApolloCachePlugin.init({
+    cacheControlOptions: {
+      defaultMaxAge: 60,
+    },
+    responseCacheOptions: {
+      // Optional: custom session ID extraction
+      sessionId: async (req) => {
+        // Default implementation extracts session from cookies
+        return null;
+      },
+    },
+  }),
+]
+```
+
+## Features
+
+- Integrates Apollo Server response cache plugin for full-response caching
+- Configurable cache control options (default max age, scope, etc.)
+- Session-aware caching with automatic cookie-based session ID extraction
+- Supports custom session ID resolution for authenticated/personalized responses
+
+## Admin UI
+
+This plugin is server-only and does not add any admin UI extensions.
+
+## API Extensions
+
+This plugin does not add any GraphQL API extensions. It operates at the Apollo Server plugin level, adding cache control headers and response caching behavior to existing queries.

package/dist/plugin-server/index.d.ts

@@ -0,0 +1,5 @@
+import { type ApolloCachePluginOptions } from "./types.js";
+export declare class ApolloCachePlugin {
+    static options: ApolloCachePluginOptions;
+    static init(options?: ApolloCachePluginOptions): typeof ApolloCachePlugin;
+}

package/dist/plugin-server/index.js

@@ -0,0 +1,56 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var ApolloCachePlugin_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApolloCachePlugin = void 0;
+const core_1 = require("@deenruv/core");
+const options_js_1 = require("./options.js");
+const server_plugin_response_cache_1 = __importDefault(require("@apollo/server-plugin-response-cache"));
+const cacheControl_1 = require("@apollo/server/plugin/cacheControl");
+const utils_js_1 = require("./utils.js");
+let ApolloCachePlugin = ApolloCachePlugin_1 = class ApolloCachePlugin {
+    static init(options = {
+        cacheControlOptions: {},
+        responseCacheOptions: {},
+    }) {
+        this.options = options;
+        return ApolloCachePlugin_1;
+    }
+};
+exports.ApolloCachePlugin = ApolloCachePlugin;
+ApolloCachePlugin.options = {
+    cacheControlOptions: {},
+    responseCacheOptions: {},
+};
+exports.ApolloCachePlugin = ApolloCachePlugin = ApolloCachePlugin_1 = __decorate([
+    (0, core_1.DeenruvPlugin)({
+        compatibility: "^0.0.1",
+        imports: [core_1.PluginCommonModule],
+        providers: [
+            {
+                provide: options_js_1.APOLLO_CACHE_PLUGIN_OPTIONS,
+                useFactory: () => ApolloCachePlugin.options,
+            },
+        ],
+        configuration: (config) => {
+            const { sessionId = async (req) => {
+                var _a, _b;
+                const cookies = (0, utils_js_1.parseCookie)((_b = (_a = req.request.http) === null || _a === void 0 ? void 0 : _a.headers.get("cookie")) !== null && _b !== void 0 ? _b : "");
+                if (cookies.session && cookies["session.sig"])
+                    return `${cookies.session}.${cookies["session.sig"]}`;
+                return null;
+            }, } = ApolloCachePlugin.options.responseCacheOptions;
+            config.apiOptions.apolloServerPlugins.push((0, cacheControl_1.ApolloServerPluginCacheControl)(Object.assign({}, ApolloCachePlugin.options.cacheControlOptions)));
+            config.apiOptions.apolloServerPlugins.push((0, server_plugin_response_cache_1.default)(Object.assign(Object.assign({}, ApolloCachePlugin.options.responseCacheOptions), { sessionId })));
+            return config;
+        },
+    })
+], ApolloCachePlugin);

package/dist/plugin-server/options.d.ts

@@ -0,0 +1 @@
+export declare const APOLLO_CACHE_PLUGIN_OPTIONS: unique symbol;

package/dist/plugin-server/options.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APOLLO_CACHE_PLUGIN_OPTIONS = void 0;
+exports.APOLLO_CACHE_PLUGIN_OPTIONS = Symbol("APOLLO_CACHE_PLUGIN_OPTIONS");

package/dist/plugin-server/types.d.ts

@@ -0,0 +1,7 @@
+import { BaseContext } from "@apollo/server";
+import { ApolloServerPluginResponseCacheOptions } from "@apollo/server-plugin-response-cache";
+import { ApolloServerPluginCacheControlOptions } from "@apollo/server/plugin/cacheControl";
+export type ApolloCachePluginOptions = {
+    responseCacheOptions: ApolloServerPluginResponseCacheOptions<BaseContext>;
+    cacheControlOptions: ApolloServerPluginCacheControlOptions;
+};

package/dist/plugin-server/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/plugin-server/utils.d.ts

@@ -0,0 +1 @@
+export declare const parseCookie: (str: string) => Record<string, string>;

package/dist/plugin-server/utils.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseCookie = void 0;
+const parseCookie = (str) => str
+    .split(";")
+    .map((v) => v.split("="))
+    .reduce((acc, v) => {
+    if (v) {
+        acc[decodeURIComponent(v[0].trim())] =
+            v[1] && decodeURIComponent(v[1].trim());
+    }
+    return acc;
+}, {});
+exports.parseCookie = parseCookie;

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@deenruv/apollo-cache",
+  "version": "1.0.0",
+  "homepage": "https://deenruv.com/",
+  "license": "MIT",
+  "files": [
+    "dist/**/*"
+  ],
+  "main": "./dist/plugin-server/index.js",
+  "exports": {
+    ".": "./dist/plugin-server/index.js",
+    "./plugin-server": "./dist/plugin-server/index.js"
+  },
+  "peerDependencies": {
+    "@deenruv/core": "^0.1.0",
+    "@apollo/server": "^4.10.4"
+  },
+  "dependencies": {
+    "@apollo/server-plugin-response-cache": "^4.1.3",
+    "@nestjs/graphql": "^12.2.0"
+  },
+  "devDependencies": {
+    "rimraf": "^5.0.10",
+    "@deenruv/core": "^1.0.0"
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc --build",
+    "watch": "tsc --build --watch",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix ."
+  }
+}