@envelop/response-cache-redis 0.5.0-alpha-c0cc559.0 → 0.5.0-alpha-e9434aa.0

package/cjs/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./redis-cache.js"), exports);

package/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/{index.js → cjs/redis-cache.js}

@@ -1,12 +1,11 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultBuildRedisOperationResultCacheKey = exports.defaultBuildRedisEntityId = exports.createRedisCache = void 0;
 const createRedisCache = (params) => {
     var _a, _b;
     const store = params.redis;
-    const buildRedisEntityId = (_a = params === null || params === void 0 ? void 0 : params.buildRedisEntityId) !== null && _a !== void 0 ? _a : defaultBuildRedisEntityId;
-    const buildRedisOperationResultCacheKey = (_b = params === null || params === void 0 ? void 0 : params.buildRedisOperationResultCacheKey) !== null && _b !== void 0 ? _b : defaultBuildRedisOperationResultCacheKey;
+    const buildRedisEntityId = (_a = params === null || params === void 0 ? void 0 : params.buildRedisEntityId) !== null && _a !== void 0 ? _a : exports.defaultBuildRedisEntityId;
+    const buildRedisOperationResultCacheKey = (_b = params === null || params === void 0 ? void 0 : params.buildRedisOperationResultCacheKey) !== null && _b !== void 0 ? _b : exports.defaultBuildRedisOperationResultCacheKey;
     async function buildEntityInvalidationsKeys(entity) {
         const keysToInvalidate = [entity];
         // find the responseIds for the entity
@@ -76,9 +75,8 @@ const createRedisCache = (params) => {
         },
     };
 };
-const defaultBuildRedisEntityId = (typename, id) => `${typename}:${id}`;
-const defaultBuildRedisOperationResultCacheKey = responseId => `operations:${responseId}`;
-
 exports.createRedisCache = createRedisCache;
+const defaultBuildRedisEntityId = (typename, id) => `${typename}:${id}`;
 exports.defaultBuildRedisEntityId = defaultBuildRedisEntityId;
+const defaultBuildRedisOperationResultCacheKey = responseId => `operations:${responseId}`;
 exports.defaultBuildRedisOperationResultCacheKey = defaultBuildRedisOperationResultCacheKey;

package/esm/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./redis-cache.js"), exports);

package/{index.mjs → esm/redis-cache.js}

@@ -1,8 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultBuildRedisOperationResultCacheKey = exports.defaultBuildRedisEntityId = exports.createRedisCache = void 0;
 const createRedisCache = (params) => {
     var _a, _b;
     const store = params.redis;
-    const buildRedisEntityId = (_a = params === null || params === void 0 ? void 0 : params.buildRedisEntityId) !== null && _a !== void 0 ? _a : defaultBuildRedisEntityId;
-    const buildRedisOperationResultCacheKey = (_b = params === null || params === void 0 ? void 0 : params.buildRedisOperationResultCacheKey) !== null && _b !== void 0 ? _b : defaultBuildRedisOperationResultCacheKey;
+    const buildRedisEntityId = (_a = params === null || params === void 0 ? void 0 : params.buildRedisEntityId) !== null && _a !== void 0 ? _a : exports.defaultBuildRedisEntityId;
+    const buildRedisOperationResultCacheKey = (_b = params === null || params === void 0 ? void 0 : params.buildRedisOperationResultCacheKey) !== null && _b !== void 0 ? _b : exports.defaultBuildRedisOperationResultCacheKey;
     async function buildEntityInvalidationsKeys(entity) {
         const keysToInvalidate = [entity];
         // find the responseIds for the entity
@@ -72,7 +75,8 @@ const createRedisCache = (params) => {
         },
     };
 };
+exports.createRedisCache = createRedisCache;
 const defaultBuildRedisEntityId = (typename, id) => `${typename}:${id}`;
+exports.defaultBuildRedisEntityId = defaultBuildRedisEntityId;
 const defaultBuildRedisOperationResultCacheKey = responseId => `operations:${responseId}`;
-
-export { createRedisCache, defaultBuildRedisEntityId, defaultBuildRedisOperationResultCacheKey };
+exports.defaultBuildRedisOperationResultCacheKey = defaultBuildRedisOperationResultCacheKey;

package/package.json

@@ -1,33 +1,55 @@
 {
   "name": "@envelop/response-cache-redis",
-  "version": "0.5.0-alpha-c0cc559.0",
+  "version": "0.5.0-alpha-e9434aa.0",
   "sideEffects": false,
+  "peerDependencies": {},
   "dependencies": {
-    "@envelop/response-cache": "2.4.0-alpha-c0cc559.0",
+    "@envelop/response-cache": "2.4.0-alpha-e9434aa.0",
     "ioredis": "^4.27.9"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/dotansimha/envelop.git",
+    "url": "https://github.com/n1ru4l/envelop.git",
     "directory": "packages/plugins/response-cache-redis"
   },
   "author": "David Thyresson <dthyresson@gmail.com>",
   "license": "MIT",
-  "main": "index.js",
-  "module": "index.mjs",
-  "typings": "index.d.ts",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "typings": "typings/index.d.ts",
   "typescript": {
-    "definition": "index.d.ts"
+    "definition": "typings/index.d.ts"
   },
+  "type": "module",
   "exports": {
     ".": {
-      "require": "./index.js",
-      "import": "./index.mjs"
+      "require": {
+        "types": "./typings/index.d.ts",
+        "default": "./cjs/index.js"
+      },
+      "import": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "default": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      }
     },
     "./*": {
-      "require": "./*.js",
-      "import": "./*.mjs"
+      "require": {
+        "types": "./typings/*.d.ts",
+        "default": "./cjs/*.js"
+      },
+      "import": {
+        "types": "./typings/*.d.ts",
+        "default": "./esm/*.js"
+      },
+      "default": {
+        "types": "./typings/*.d.ts",
+        "default": "./esm/*.js"
+      }
     },
     "./package.json": "./package.json"
   }
-}
+}

package/typings/index.d.ts

@@ -0,0 +1 @@
+export * from './redis-cache.js';

package/README.md

@@ -1,89 +0,0 @@
-## `@envelop/response-cache-redis`
-
-- Supports redis cache for `@envelop/response-cache` plugin
-- Suitable for serveless deployments where the LRU In-Memory Cache is not possible
-
-[Check out the GraphQL Response Cache Guide for more information](https://envelop.dev/docs/guides/adding-a-graphql-response-cache)
-
-## Getting Started
-
-```bash
-yarn add @envelop/response-cache
-yarn add @envelop/response-cache-redis
-```
-
-## Usage Example
-
-In order to use the Redis cache, you need to:
-
-- Create a Redis database
-- Collect the connection settings (or its connection string), e.g., `host`, `port`, `username`, `password`, `tls`, etc.
-- Create and configure a [Redis client](https://github.com/luin/ioredis) with your [connection settings](https://github.com/luin/ioredis/blob/master/API.md#Redis) and any [additional options](https://github.com/luin/ioredis/blob/master/API.md#new_Redis_new)
-- Create an instance of the Redis Cache and set to the `useResponseCache` plugin options
-
-```ts
-
-import { envelop } from '@envelop/core';
-import { useResponseCache } from '@envelop/response-cache';
-import { createRedisCache } from '@envelop/response-cache-redis';
-
-import Redis from 'ioredis';
-
-/**
- * For additional Redis options to create the ioredis client
- * @see: https://github.com/luin/ioredis/blob/master/API.md#new_Redis_new
- *
- **/
-const redis = new Redis({
-  host: 'my-redis-db.example.com',
-  port: '30652',
-  password: '1234567890',
-});
-
-// or, you can also specify connection options as a redis:// URL or rediss:// URL when using TLS encryption
-const redis = new Redis(("rediss://:1234567890@my-redis-db.example.com':30652");
-
-const cache = createRedisCache({ redis });
-
-const getEnveloped = envelop({
-  plugins: [
-    // ... other plugins ...
-    useResponseCache({ cache }),
-  ],
-});
-```
-
-### Invalidate Cache based on custom logic
-
-```ts
-import { envelop } from '@envelop/core';
-import { useResponseCache } from '@envelop/response-cache';
-import { createRedisCache } from '@envelop/response-cache-redis';
-
-import { emitter } from './eventEmitter';
-
-// we create our cache instance, which allows calling all methods on it
-const redis = new Redis(("rediss://:1234567890@my-redis-db.example.com':30652");
-
-const cache = createRedisCache({ redis });
-
-const getEnveloped = envelop({
-  plugins: [
-    // ... other plugins ...
-    useResponseCache({
-      ttl: 2000,
-      // we pass the cache instance to the request.
-      cache,
-    }),
-  ],
-});
-
-emitter.on('invalidate', resource => {
-  cache.invalidate([
-    {
-      typename: resource.type,
-      id: resource.id,
-    },
-  ]);
-});
-```

package/index.d.ts

@@ -1 +0,0 @@
-export * from './redis-cache';