redis-kv-store 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 1.0.0 (2022-05-26)
+
+
+### Features
+
+* **redis:** first working version ([9078b25](https://github.com/nfroidure/redis-kv-store/commit/9078b255bb2d52ff6154224b6f2c013d1bb6fff8))
+
+
+

package/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright © 2017 Nicolas Froidure
+
+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,64 @@
+[//]: # ( )
+[//]: # (This file is automatically generated by a `metapak`)
+[//]: # (module. Do not change it  except between the)
+[//]: # (`content:start/end` flags, your changes would)
+[//]: # (be overridden.)
+[//]: # ( )
+# redis-kv-store
+> A simple Redis based key/value store.
+
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/nfroidure/redis-kv-store/blob/master/LICENSE)
+[![Coverage Status](https://coveralls.io/repos/github/nfroidure/redis-kv-store/badge.svg?branch=master)](https://coveralls.io/github/nfroidure/redis-kv-store?branch=master)
+
+
+[//]: # (::contents:start)
+
+This simple project provides a key/value store based on Redis. It has the exact
+same API then the
+[`memory-kv-store`](https://github.com/nfroidure/memory-kv-store) module and
+relies on the [`redis-service`](https://github.com/nfroidure/redis-service)
+module.
+
+[//]: # (::contents:end)
+
+# API
+<a name="initRedisKV"></a>
+
+## initRedisKV(services) ⇒ <code>Promise.&lt;RedisKVService&gt;</code>
+Instantiate the Redis Key/Value service
+
+**Kind**: global function  
+**Returns**: <code>Promise.&lt;RedisKVService&gt;</code> - A promise of the Redis Key Value service  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| services | <code>Object</code> | The services to inject |
+| services.redis | <code>function</code> | A `simple-redis-service` instance |
+| services.log | <code>function</code> | A logging function |
+
+**Example**  
+```js
+import initRedisService from 'simple-redis-service';
+import initRedisKV from 'redis-kv-store';
+
+const redis = await initRedisService({
+  REDIS: {
+    host: 'localhost',
+    port: 6379,
+  },
+  ENV: process.env,
+  log: console.log.bind(console),
+});
+const redisKV = await initRedisKV({
+  redis,
+  log: console.log.bind(console),
+});
+
+const value = await redisKV.get('my_key');
+```
+
+# Authors
+- [Nicolas Froidure](http://insertafter.com/en/index.html)
+
+# License
+[MIT](https://github.com/nfroidure/redis-kv-store/blob/master/LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import type { LogService } from 'common-services';
+import type { KVStoreService } from 'memory-kv-store';
+import type { RedisService } from 'simple-redis-service';
+export declare type RedisKVService<T> = KVStoreService<T>;
+export declare type RedisKVDependencies = {
+    redis: RedisService;
+    log: LogService;
+};
+declare const _default: import("knifecycle").ServiceInitializer<RedisKVDependencies, KVStoreService<unknown>>;
+export default _default;

package/dist/index.js

@@ -0,0 +1,89 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _knifecycle = require("knifecycle");
+
+var _default = (0, _knifecycle.autoService)(initRedisKV);
+/**
+ * Instantiate the Redis Key/Value service
+ * @name initRedisKV
+ * @function
+ * @param  {Object}     services
+ * The services to inject
+ * @param  {Function}   services.redis
+ * A `simple-redis-service` instance
+ * @param  {Function}   services.log
+ * A logging function
+ * @return {Promise<RedisKVService>}
+ * A promise of the Redis Key Value service
+ * @example
+ * import initRedisService from 'simple-redis-service';
+ * import initRedisKV from 'redis-kv-store';
+ *
+ * const redis = await initRedisService({
+ *   REDIS: {
+ *     host: 'localhost',
+ *     port: 6379,
+ *   },
+ *   ENV: process.env,
+ *   log: console.log.bind(console),
+ * });
+ * const redisKV = await initRedisKV({
+ *   redis,
+ *   log: console.log.bind(console),
+ * });
+ *
+ * const value = await redisKV.get('my_key');
+ */
+
+
+exports.default = _default;
+
+async function initRedisKV({
+  redis,
+  log
+}) {
+  log('warning', `🏧 - Redis KV Store Service initialized!`);
+  const redisKV = {
+    get: async key => {
+      const result = await redis.get(key);
+      return castRedisResult(result);
+    },
+    set: async (key, value, ttl) => {
+      if (typeof ttl !== 'undefined') {
+        await redis.set(key, prepareRedisValue(value), 'PX', ttl);
+      } else {
+        await redis.set(key, prepareRedisValue(value));
+      }
+    },
+    delete: async key => {
+      await redis.del(key);
+    },
+    bulkGet: async keys => {
+      return (await redis.mget(keys)).map(result => castRedisResult(result));
+    },
+    bulkSet: async (keys, values, ttls = []) => {
+      await Promise.all(keys.map((key, index) => {
+        const value = values[index];
+        return redisKV.set(key, value, ttls[index]);
+      }));
+    },
+    bulkDelete: async keys => {
+      await redis.del(...keys);
+    }
+  };
+  return redisKV;
+}
+
+function castRedisResult(result) {
+  return result == null || result === '' ? undefined : JSON.parse(result);
+}
+
+function prepareRedisValue(value) {
+  return value == null ? '' : JSON.stringify(value);
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["autoService","initRedisKV","redis","log","redisKV","get","key","result","castRedisResult","set","value","ttl","prepareRedisValue","delete","del","bulkGet","keys","mget","map","bulkSet","values","ttls","Promise","all","index","bulkDelete","undefined","JSON","parse","stringify"],"sources":["../src/index.ts"],"sourcesContent":["import { autoService } from 'knifecycle';\nimport type { LogService } from 'common-services';\nimport type { KVStoreService } from 'memory-kv-store';\nimport type { RedisService } from 'simple-redis-service';\n\n/* Architecture Note #1: Redis Key/Value Service\n\nA `redis` based key/value service.\n*/\n\nexport type RedisKVService<T> = KVStoreService<T>;\nexport type RedisKVDependencies = {\n  redis: RedisService;\n  log: LogService;\n};\n\nexport default autoService(initRedisKV);\n\n/**\n * Instantiate the Redis Key/Value service\n * @name initRedisKV\n * @function\n * @param  {Object}     services\n * The services to inject\n * @param  {Function}   services.redis\n * A `simple-redis-service` instance\n * @param  {Function}   services.log\n * A logging function\n * @return {Promise<RedisKVService>}\n * A promise of the Redis Key Value service\n * @example\n * import initRedisService from 'simple-redis-service';\n * import initRedisKV from 'redis-kv-store';\n *\n * const redis = await initRedisService({\n *   REDIS: {\n *     host: 'localhost',\n *     port: 6379,\n *   },\n *   ENV: process.env,\n *   log: console.log.bind(console),\n * });\n * const redisKV = await initRedisKV({\n *   redis,\n *   log: console.log.bind(console),\n * });\n *\n * const value = await redisKV.get('my_key');\n */\nasync function initRedisKV<T>({\n  redis,\n  log,\n}: RedisKVDependencies): Promise<KVStoreService<T>> {\n  log('warning', `🏧 - Redis KV Store Service initialized!`);\n\n  const redisKV = {\n    get: async (key: string): Promise<T | undefined> => {\n      const result = await redis.get(key);\n      return castRedisResult<T>(result);\n    },\n    set: async (\n      key: string,\n      value: T | undefined,\n      ttl?: number,\n    ): Promise<void> => {\n      if (typeof ttl !== 'undefined') {\n        await redis.set(key, prepareRedisValue<T>(value), 'PX', ttl);\n      } else {\n        await redis.set(key, prepareRedisValue<T>(value));\n      }\n    },\n    delete: async (key: string): Promise<void> => {\n      await redis.del(key);\n    },\n    bulkGet: async (keys: string[]): Promise<(T | undefined)[]> => {\n      return (await redis.mget(keys)).map((result) =>\n        castRedisResult<T>(result),\n      );\n    },\n    bulkSet: async (\n      keys: string[],\n      values: (T | undefined)[],\n      ttls: number[] = [],\n    ) => {\n      await Promise.all(\n        keys.map((key, index) => {\n          const value = values[index];\n\n          return redisKV.set(key, value, ttls[index]);\n        }),\n      );\n    },\n    bulkDelete: async (keys: string[]) => {\n      await redis.del(...keys);\n    },\n  };\n\n  return redisKV;\n}\n\nfunction castRedisResult<T>(result: string | null | undefined): T {\n  return result == null || result === '' ? undefined : JSON.parse(result);\n}\n\nfunction prepareRedisValue<T>(value: T | undefined): string {\n  return value == null ? '' : JSON.stringify(value);\n}\n"],"mappings":";;;;;;;AAAA;;eAgBe,IAAAA,uBAAA,EAAYC,WAAZ,C;AAEf;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;;AACA,eAAeA,WAAf,CAA8B;EAC5BC,KAD4B;EAE5BC;AAF4B,CAA9B,EAGoD;EAClDA,GAAG,CAAC,SAAD,EAAa,0CAAb,CAAH;EAEA,MAAMC,OAAO,GAAG;IACdC,GAAG,EAAE,MAAOC,GAAP,IAA+C;MAClD,MAAMC,MAAM,GAAG,MAAML,KAAK,CAACG,GAAN,CAAUC,GAAV,CAArB;MACA,OAAOE,eAAe,CAAID,MAAJ,CAAtB;IACD,CAJa;IAKdE,GAAG,EAAE,OACHH,GADG,EAEHI,KAFG,EAGHC,GAHG,KAIe;MAClB,IAAI,OAAOA,GAAP,KAAe,WAAnB,EAAgC;QAC9B,MAAMT,KAAK,CAACO,GAAN,CAAUH,GAAV,EAAeM,iBAAiB,CAAIF,KAAJ,CAAhC,EAA4C,IAA5C,EAAkDC,GAAlD,CAAN;MACD,CAFD,MAEO;QACL,MAAMT,KAAK,CAACO,GAAN,CAAUH,GAAV,EAAeM,iBAAiB,CAAIF,KAAJ,CAAhC,CAAN;MACD;IACF,CAfa;IAgBdG,MAAM,EAAE,MAAOP,GAAP,IAAsC;MAC5C,MAAMJ,KAAK,CAACY,GAAN,CAAUR,GAAV,CAAN;IACD,CAlBa;IAmBdS,OAAO,EAAE,MAAOC,IAAP,IAAsD;MAC7D,OAAO,CAAC,MAAMd,KAAK,CAACe,IAAN,CAAWD,IAAX,CAAP,EAAyBE,GAAzB,CAA8BX,MAAD,IAClCC,eAAe,CAAID,MAAJ,CADV,CAAP;IAGD,CAvBa;IAwBdY,OAAO,EAAE,OACPH,IADO,EAEPI,MAFO,EAGPC,IAAc,GAAG,EAHV,KAIJ;MACH,MAAMC,OAAO,CAACC,GAAR,CACJP,IAAI,CAACE,GAAL,CAAS,CAACZ,GAAD,EAAMkB,KAAN,KAAgB;QACvB,MAAMd,KAAK,GAAGU,MAAM,CAACI,KAAD,CAApB;QAEA,OAAOpB,OAAO,CAACK,GAAR,CAAYH,GAAZ,EAAiBI,KAAjB,EAAwBW,IAAI,CAACG,KAAD,CAA5B,CAAP;MACD,CAJD,CADI,CAAN;IAOD,CApCa;IAqCdC,UAAU,EAAE,MAAOT,IAAP,IAA0B;MACpC,MAAMd,KAAK,CAACY,GAAN,CAAU,GAAGE,IAAb,CAAN;IACD;EAvCa,CAAhB;EA0CA,OAAOZ,OAAP;AACD;;AAED,SAASI,eAAT,CAA4BD,MAA5B,EAAkE;EAChE,OAAOA,MAAM,IAAI,IAAV,IAAkBA,MAAM,KAAK,EAA7B,GAAkCmB,SAAlC,GAA8CC,IAAI,CAACC,KAAL,CAAWrB,MAAX,CAArD;AACD;;AAED,SAASK,iBAAT,CAA8BF,KAA9B,EAA4D;EAC1D,OAAOA,KAAK,IAAI,IAAT,GAAgB,EAAhB,GAAqBiB,IAAI,CAACE,SAAL,CAAenB,KAAf,CAA5B;AACD"}

package/dist/index.mjs

@@ -0,0 +1,47 @@
+import { autoService } from 'knifecycle';
+export default autoService(initRedisKV);
+
+async function initRedisKV({
+  redis,
+  log
+}) {
+  log('warning', `🏧 - Redis KV Store Service initialized!`);
+  const redisKV = {
+    get: async key => {
+      const result = await redis.get(key);
+      return castRedisResult(result);
+    },
+    set: async (key, value, ttl) => {
+      if (typeof ttl !== 'undefined') {
+        await redis.set(key, prepareRedisValue(value), 'PX', ttl);
+      } else {
+        await redis.set(key, prepareRedisValue(value));
+      }
+    },
+    delete: async key => {
+      await redis.del(key);
+    },
+    bulkGet: async keys => {
+      return (await redis.mget(keys)).map(result => castRedisResult(result));
+    },
+    bulkSet: async (keys, values, ttls = []) => {
+      await Promise.all(keys.map((key, index) => {
+        const value = values[index];
+        return redisKV.set(key, value, ttls[index]);
+      }));
+    },
+    bulkDelete: async keys => {
+      await redis.del(...keys);
+    }
+  };
+  return redisKV;
+}
+
+function castRedisResult(result) {
+  return result == null || result === '' ? undefined : JSON.parse(result);
+}
+
+function prepareRedisValue(value) {
+  return value == null ? '' : JSON.stringify(value);
+}
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":["autoService","initRedisKV","redis","log","redisKV","get","key","result","castRedisResult","set","value","ttl","prepareRedisValue","delete","del","bulkGet","keys","mget","map","bulkSet","values","ttls","Promise","all","index","bulkDelete","undefined","JSON","parse","stringify"],"sources":["../src/index.ts"],"sourcesContent":["import { autoService } from 'knifecycle';\nimport type { LogService } from 'common-services';\nimport type { KVStoreService } from 'memory-kv-store';\nimport type { RedisService } from 'simple-redis-service';\n\n/* Architecture Note #1: Redis Key/Value Service\n\nA `redis` based key/value service.\n*/\n\nexport type RedisKVService<T> = KVStoreService<T>;\nexport type RedisKVDependencies = {\n  redis: RedisService;\n  log: LogService;\n};\n\nexport default autoService(initRedisKV);\n\n/**\n * Instantiate the Redis Key/Value service\n * @name initRedisKV\n * @function\n * @param  {Object}     services\n * The services to inject\n * @param  {Function}   services.redis\n * A `simple-redis-service` instance\n * @param  {Function}   services.log\n * A logging function\n * @return {Promise<RedisKVService>}\n * A promise of the Redis Key Value service\n * @example\n * import initRedisService from 'simple-redis-service';\n * import initRedisKV from 'redis-kv-store';\n *\n * const redis = await initRedisService({\n *   REDIS: {\n *     host: 'localhost',\n *     port: 6379,\n *   },\n *   ENV: process.env,\n *   log: console.log.bind(console),\n * });\n * const redisKV = await initRedisKV({\n *   redis,\n *   log: console.log.bind(console),\n * });\n *\n * const value = await redisKV.get('my_key');\n */\nasync function initRedisKV<T>({\n  redis,\n  log,\n}: RedisKVDependencies): Promise<KVStoreService<T>> {\n  log('warning', `🏧 - Redis KV Store Service initialized!`);\n\n  const redisKV = {\n    get: async (key: string): Promise<T | undefined> => {\n      const result = await redis.get(key);\n      return castRedisResult<T>(result);\n    },\n    set: async (\n      key: string,\n      value: T | undefined,\n      ttl?: number,\n    ): Promise<void> => {\n      if (typeof ttl !== 'undefined') {\n        await redis.set(key, prepareRedisValue<T>(value), 'PX', ttl);\n      } else {\n        await redis.set(key, prepareRedisValue<T>(value));\n      }\n    },\n    delete: async (key: string): Promise<void> => {\n      await redis.del(key);\n    },\n    bulkGet: async (keys: string[]): Promise<(T | undefined)[]> => {\n      return (await redis.mget(keys)).map((result) =>\n        castRedisResult<T>(result),\n      );\n    },\n    bulkSet: async (\n      keys: string[],\n      values: (T | undefined)[],\n      ttls: number[] = [],\n    ) => {\n      await Promise.all(\n        keys.map((key, index) => {\n          const value = values[index];\n\n          return redisKV.set(key, value, ttls[index]);\n        }),\n      );\n    },\n    bulkDelete: async (keys: string[]) => {\n      await redis.del(...keys);\n    },\n  };\n\n  return redisKV;\n}\n\nfunction castRedisResult<T>(result: string | null | undefined): T {\n  return result == null || result === '' ? undefined : JSON.parse(result);\n}\n\nfunction prepareRedisValue<T>(value: T | undefined): string {\n  return value == null ? '' : JSON.stringify(value);\n}\n"],"mappings":"AAAA,SAASA,WAAT,QAA4B,YAA5B;AAgBA,eAAeA,WAAW,CAACC,WAAD,CAA1B;;AAiCA,eAAeA,WAAf,CAA8B;EAC5BC,KAD4B;EAE5BC;AAF4B,CAA9B,EAGoD;EAClDA,GAAG,CAAC,SAAD,EAAa,0CAAb,CAAH;EAEA,MAAMC,OAAO,GAAG;IACdC,GAAG,EAAE,MAAOC,GAAP,IAA+C;MAClD,MAAMC,MAAM,GAAG,MAAML,KAAK,CAACG,GAAN,CAAUC,GAAV,CAArB;MACA,OAAOE,eAAe,CAAID,MAAJ,CAAtB;IACD,CAJa;IAKdE,GAAG,EAAE,OACHH,GADG,EAEHI,KAFG,EAGHC,GAHG,KAIe;MAClB,IAAI,OAAOA,GAAP,KAAe,WAAnB,EAAgC;QAC9B,MAAMT,KAAK,CAACO,GAAN,CAAUH,GAAV,EAAeM,iBAAiB,CAAIF,KAAJ,CAAhC,EAA4C,IAA5C,EAAkDC,GAAlD,CAAN;MACD,CAFD,MAEO;QACL,MAAMT,KAAK,CAACO,GAAN,CAAUH,GAAV,EAAeM,iBAAiB,CAAIF,KAAJ,CAAhC,CAAN;MACD;IACF,CAfa;IAgBdG,MAAM,EAAE,MAAOP,GAAP,IAAsC;MAC5C,MAAMJ,KAAK,CAACY,GAAN,CAAUR,GAAV,CAAN;IACD,CAlBa;IAmBdS,OAAO,EAAE,MAAOC,IAAP,IAAsD;MAC7D,OAAO,CAAC,MAAMd,KAAK,CAACe,IAAN,CAAWD,IAAX,CAAP,EAAyBE,GAAzB,CAA8BX,MAAD,IAClCC,eAAe,CAAID,MAAJ,CADV,CAAP;IAGD,CAvBa;IAwBdY,OAAO,EAAE,OACPH,IADO,EAEPI,MAFO,EAGPC,IAAc,GAAG,EAHV,KAIJ;MACH,MAAMC,OAAO,CAACC,GAAR,CACJP,IAAI,CAACE,GAAL,CAAS,CAACZ,GAAD,EAAMkB,KAAN,KAAgB;QACvB,MAAMd,KAAK,GAAGU,MAAM,CAACI,KAAD,CAApB;QAEA,OAAOpB,OAAO,CAACK,GAAR,CAAYH,GAAZ,EAAiBI,KAAjB,EAAwBW,IAAI,CAACG,KAAD,CAA5B,CAAP;MACD,CAJD,CADI,CAAN;IAOD,CApCa;IAqCdC,UAAU,EAAE,MAAOT,IAAP,IAA0B;MACpC,MAAMd,KAAK,CAACY,GAAN,CAAU,GAAGE,IAAb,CAAN;IACD;EAvCa,CAAhB;EA0CA,OAAOZ,OAAP;AACD;;AAED,SAASI,eAAT,CAA4BD,MAA5B,EAAkE;EAChE,OAAOA,MAAM,IAAI,IAAV,IAAkBA,MAAM,KAAK,EAA7B,GAAkCmB,SAAlC,GAA8CC,IAAI,CAACC,KAAL,CAAWrB,MAAX,CAArD;AACD;;AAED,SAASK,iBAAT,CAA8BF,KAA9B,EAA4D;EAC1D,OAAOA,KAAK,IAAI,IAAT,GAAgB,EAAhB,GAAqBiB,IAAI,CAACE,SAAL,CAAenB,KAAf,CAA5B;AACD"}

package/dist/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.test.js

@@ -0,0 +1,86 @@
+"use strict";
+
+var _knifecycle = require("knifecycle");
+
+var _ = _interopRequireDefault(require("."));
+
+var _simpleRedisService = _interopRequireDefault(require("simple-redis-service"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+describe('Redis service', () => {
+  let $;
+  const log = jest.fn();
+  beforeEach(() => {
+    log.mockReset();
+    $ = new _knifecycle.Knifecycle();
+    $.register((0, _knifecycle.constant)('ENV', {}));
+    $.register((0, _knifecycle.constant)('log', log));
+    $.register((0, _knifecycle.constant)('REDIS', {
+      host: 'localhost',
+      port: 6379
+    }));
+    $.register(_simpleRedisService.default);
+    $.register(_.default);
+  });
+  afterEach(async () => {
+    await $.destroy();
+  });
+  it('should init well', async () => {
+    const {
+      log,
+      redisKV
+    } = await $.run(['log', 'redisKV']);
+    expect(typeof redisKV.get).toEqual('function');
+    expect(typeof redisKV.set).toEqual('function');
+    expect(log.mock.calls).toMatchInlineSnapshot(`
+      Array [
+        Array [
+          "warning",
+          "🏧 - Redis Service initialized!",
+        ],
+        Array [
+          "warning",
+          "🏧 - Redis KV Store Service initialized!",
+        ],
+      ]
+    `);
+  });
+  it('should allow to get a undefined value by its key', async () => {
+    const {
+      redisKV
+    } = await $.run(['redisKV']);
+    const value = await redisKV.get('lol');
+    expect(value).toEqual(undefined);
+  });
+  ['trololol', {
+    lol: 'lol'
+  }, 1, true].forEach(value => {
+    it('should allow to set and get a ' + typeof value + ' by its key', async () => {
+      const {
+        redisKV
+      } = await $.run(['redisKV']);
+      await redisKV.set('lol', value);
+      const retrievedValue = await redisKV.get('lol');
+      expect(retrievedValue).toEqual(value);
+    });
+  });
+  it('should allow to bulk get a undefined values by their keys', async () => {
+    const {
+      redisKV
+    } = await $.run(['redisKV']);
+    const values = await redisKV.bulkGet(['lollolo', 'kikoolol']);
+    expect(values).toEqual([undefined, undefined]);
+  });
+  it('should allow to set and get values by their keys', async () => {
+    const keys = ['a', 'b', 'c', 'd'];
+    const values = [1, 2, undefined, 4];
+    const {
+      redisKV
+    } = await $.run(['redisKV']);
+    await redisKV.bulkSet(keys, values);
+    const retrievedValues = await redisKV.bulkGet(keys);
+    expect(retrievedValues).toEqual(values);
+  });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","names":["describe","$","log","jest","fn","beforeEach","mockReset","Knifecycle","register","constant","host","port","initRedisService","initRedisKVService","afterEach","destroy","it","redisKV","run","expect","get","toEqual","set","mock","calls","toMatchInlineSnapshot","value","undefined","lol","forEach","retrievedValue","values","bulkGet","keys","bulkSet","retrievedValues"],"sources":["../src/index.test.ts"],"sourcesContent":["import { constant, Knifecycle } from 'knifecycle';\nimport initRedisKVService from '.';\nimport initRedisService from 'simple-redis-service';\nimport type { RedisKVService } from '.';\nimport type { RedisConfig } from 'simple-redis-service';\n\ndescribe('Redis service', () => {\n  let $: Knifecycle;\n  const log = jest.fn();\n\n  beforeEach(() => {\n    log.mockReset();\n    $ = new Knifecycle();\n    $.register(constant('ENV', {}));\n    $.register(constant('log', log));\n    $.register(\n      constant('REDIS', {\n        host: 'localhost',\n        port: 6379,\n      } as RedisConfig),\n    );\n    $.register(initRedisService);\n    $.register(initRedisKVService);\n  });\n\n  afterEach(async () => {\n    await $.destroy();\n  });\n\n  it('should init well', async () => {\n    const { log, redisKV } = (await $.run(['log', 'redisKV'])) as {\n      redisKV: RedisKVService<unknown>;\n      log: jest.Mock;\n    };\n\n    expect(typeof redisKV.get).toEqual('function');\n    expect(typeof redisKV.set).toEqual('function');\n    expect(log.mock.calls).toMatchInlineSnapshot(`\n      Array [\n        Array [\n          \"warning\",\n          \"🏧 - Redis Service initialized!\",\n        ],\n        Array [\n          \"warning\",\n          \"🏧 - Redis KV Store Service initialized!\",\n        ],\n      ]\n    `);\n  });\n\n  it('should allow to get a undefined value by its key', async () => {\n    const { redisKV } = (await $.run(['redisKV'])) as {\n      redisKV: RedisKVService<number>;\n    };\n\n    const value = await redisKV.get('lol');\n\n    expect(value).toEqual(undefined);\n  });\n\n  ['trololol', { lol: 'lol' }, 1, true].forEach((value) => {\n    it(\n      'should allow to set and get a ' + typeof value + ' by its key',\n      async () => {\n        const { redisKV } = (await $.run(['redisKV'])) as {\n          redisKV: RedisKVService<typeof value>;\n        };\n\n        await redisKV.set('lol', value);\n\n        const retrievedValue = await redisKV.get('lol');\n\n        expect(retrievedValue).toEqual(value);\n      },\n    );\n  });\n\n  it('should allow to bulk get a undefined values by their keys', async () => {\n    const { redisKV } = (await $.run(['redisKV'])) as {\n      redisKV: RedisKVService<number>;\n    };\n\n    const values = await redisKV.bulkGet(['lollolo', 'kikoolol']);\n\n    expect(values).toEqual([undefined, undefined]);\n  });\n\n  it('should allow to set and get values by their keys', async () => {\n    const keys = ['a', 'b', 'c', 'd'];\n    const values = [1, 2, undefined, 4];\n\n    const { redisKV } = (await $.run(['redisKV'])) as {\n      redisKV: RedisKVService<number>;\n    };\n\n    await redisKV.bulkSet(keys, values);\n\n    const retrievedValues = await redisKV.bulkGet(keys);\n\n    expect(retrievedValues).toEqual(values);\n  });\n});\n"],"mappings":";;AAAA;;AACA;;AACA;;;;AAIAA,QAAQ,CAAC,eAAD,EAAkB,MAAM;EAC9B,IAAIC,CAAJ;EACA,MAAMC,GAAG,GAAGC,IAAI,CAACC,EAAL,EAAZ;EAEAC,UAAU,CAAC,MAAM;IACfH,GAAG,CAACI,SAAJ;IACAL,CAAC,GAAG,IAAIM,sBAAJ,EAAJ;IACAN,CAAC,CAACO,QAAF,CAAW,IAAAC,oBAAA,EAAS,KAAT,EAAgB,EAAhB,CAAX;IACAR,CAAC,CAACO,QAAF,CAAW,IAAAC,oBAAA,EAAS,KAAT,EAAgBP,GAAhB,CAAX;IACAD,CAAC,CAACO,QAAF,CACE,IAAAC,oBAAA,EAAS,OAAT,EAAkB;MAChBC,IAAI,EAAE,WADU;MAEhBC,IAAI,EAAE;IAFU,CAAlB,CADF;IAMAV,CAAC,CAACO,QAAF,CAAWI,2BAAX;IACAX,CAAC,CAACO,QAAF,CAAWK,SAAX;EACD,CAbS,CAAV;EAeAC,SAAS,CAAC,YAAY;IACpB,MAAMb,CAAC,CAACc,OAAF,EAAN;EACD,CAFQ,CAAT;EAIAC,EAAE,CAAC,kBAAD,EAAqB,YAAY;IACjC,MAAM;MAAEd,GAAF;MAAOe;IAAP,IAAoB,MAAMhB,CAAC,CAACiB,GAAF,CAAM,CAAC,KAAD,EAAQ,SAAR,CAAN,CAAhC;IAKAC,MAAM,CAAC,OAAOF,OAAO,CAACG,GAAhB,CAAN,CAA2BC,OAA3B,CAAmC,UAAnC;IACAF,MAAM,CAAC,OAAOF,OAAO,CAACK,GAAhB,CAAN,CAA2BD,OAA3B,CAAmC,UAAnC;IACAF,MAAM,CAACjB,GAAG,CAACqB,IAAJ,CAASC,KAAV,CAAN,CAAuBC,qBAAvB,CAA8C;AAClD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAXI;EAYD,CApBC,CAAF;EAsBAT,EAAE,CAAC,kDAAD,EAAqD,YAAY;IACjE,MAAM;MAAEC;IAAF,IAAe,MAAMhB,CAAC,CAACiB,GAAF,CAAM,CAAC,SAAD,CAAN,CAA3B;IAIA,MAAMQ,KAAK,GAAG,MAAMT,OAAO,CAACG,GAAR,CAAY,KAAZ,CAApB;IAEAD,MAAM,CAACO,KAAD,CAAN,CAAcL,OAAd,CAAsBM,SAAtB;EACD,CARC,CAAF;EAUA,CAAC,UAAD,EAAa;IAAEC,GAAG,EAAE;EAAP,CAAb,EAA6B,CAA7B,EAAgC,IAAhC,EAAsCC,OAAtC,CAA+CH,KAAD,IAAW;IACvDV,EAAE,CACA,mCAAmC,OAAOU,KAA1C,GAAkD,aADlD,EAEA,YAAY;MACV,MAAM;QAAET;MAAF,IAAe,MAAMhB,CAAC,CAACiB,GAAF,CAAM,CAAC,SAAD,CAAN,CAA3B;MAIA,MAAMD,OAAO,CAACK,GAAR,CAAY,KAAZ,EAAmBI,KAAnB,CAAN;MAEA,MAAMI,cAAc,GAAG,MAAMb,OAAO,CAACG,GAAR,CAAY,KAAZ,CAA7B;MAEAD,MAAM,CAACW,cAAD,CAAN,CAAuBT,OAAvB,CAA+BK,KAA/B;IACD,CAZD,CAAF;EAcD,CAfD;EAiBAV,EAAE,CAAC,2DAAD,EAA8D,YAAY;IAC1E,MAAM;MAAEC;IAAF,IAAe,MAAMhB,CAAC,CAACiB,GAAF,CAAM,CAAC,SAAD,CAAN,CAA3B;IAIA,MAAMa,MAAM,GAAG,MAAMd,OAAO,CAACe,OAAR,CAAgB,CAAC,SAAD,EAAY,UAAZ,CAAhB,CAArB;IAEAb,MAAM,CAACY,MAAD,CAAN,CAAeV,OAAf,CAAuB,CAACM,SAAD,EAAYA,SAAZ,CAAvB;EACD,CARC,CAAF;EAUAX,EAAE,CAAC,kDAAD,EAAqD,YAAY;IACjE,MAAMiB,IAAI,GAAG,CAAC,GAAD,EAAM,GAAN,EAAW,GAAX,EAAgB,GAAhB,CAAb;IACA,MAAMF,MAAM,GAAG,CAAC,CAAD,EAAI,CAAJ,EAAOJ,SAAP,EAAkB,CAAlB,CAAf;IAEA,MAAM;MAAEV;IAAF,IAAe,MAAMhB,CAAC,CAACiB,GAAF,CAAM,CAAC,SAAD,CAAN,CAA3B;IAIA,MAAMD,OAAO,CAACiB,OAAR,CAAgBD,IAAhB,EAAsBF,MAAtB,CAAN;IAEA,MAAMI,eAAe,GAAG,MAAMlB,OAAO,CAACe,OAAR,CAAgBC,IAAhB,CAA9B;IAEAd,MAAM,CAACgB,eAAD,CAAN,CAAwBd,OAAxB,CAAgCU,MAAhC;EACD,CAbC,CAAF;AAcD,CAhGO,CAAR"}

package/dist/index.test.mjs

@@ -0,0 +1,79 @@
+import { constant, Knifecycle } from 'knifecycle';
+import initRedisKVService from '.';
+import initRedisService from 'simple-redis-service';
+describe('Redis service', () => {
+  let $;
+  const log = jest.fn();
+  beforeEach(() => {
+    log.mockReset();
+    $ = new Knifecycle();
+    $.register(constant('ENV', {}));
+    $.register(constant('log', log));
+    $.register(constant('REDIS', {
+      host: 'localhost',
+      port: 6379
+    }));
+    $.register(initRedisService);
+    $.register(initRedisKVService);
+  });
+  afterEach(async () => {
+    await $.destroy();
+  });
+  it('should init well', async () => {
+    const {
+      log,
+      redisKV
+    } = await $.run(['log', 'redisKV']);
+    expect(typeof redisKV.get).toEqual('function');
+    expect(typeof redisKV.set).toEqual('function');
+    expect(log.mock.calls).toMatchInlineSnapshot(`
+      Array [
+        Array [
+          "warning",
+          "🏧 - Redis Service initialized!",
+        ],
+        Array [
+          "warning",
+          "🏧 - Redis KV Store Service initialized!",
+        ],
+      ]
+    `);
+  });
+  it('should allow to get a undefined value by its key', async () => {
+    const {
+      redisKV
+    } = await $.run(['redisKV']);
+    const value = await redisKV.get('lol');
+    expect(value).toEqual(undefined);
+  });
+  ['trololol', {
+    lol: 'lol'
+  }, 1, true].forEach(value => {
+    it('should allow to set and get a ' + typeof value + ' by its key', async () => {
+      const {
+        redisKV
+      } = await $.run(['redisKV']);
+      await redisKV.set('lol', value);
+      const retrievedValue = await redisKV.get('lol');
+      expect(retrievedValue).toEqual(value);
+    });
+  });
+  it('should allow to bulk get a undefined values by their keys', async () => {
+    const {
+      redisKV
+    } = await $.run(['redisKV']);
+    const values = await redisKV.bulkGet(['lollolo', 'kikoolol']);
+    expect(values).toEqual([undefined, undefined]);
+  });
+  it('should allow to set and get values by their keys', async () => {
+    const keys = ['a', 'b', 'c', 'd'];
+    const values = [1, 2, undefined, 4];
+    const {
+      redisKV
+    } = await $.run(['redisKV']);
+    await redisKV.bulkSet(keys, values);
+    const retrievedValues = await redisKV.bulkGet(keys);
+    expect(retrievedValues).toEqual(values);
+  });
+});
+//# sourceMappingURL=index.test.mjs.map

package/dist/index.test.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.mjs","names":["constant","Knifecycle","initRedisKVService","initRedisService","describe","$","log","jest","fn","beforeEach","mockReset","register","host","port","afterEach","destroy","it","redisKV","run","expect","get","toEqual","set","mock","calls","toMatchInlineSnapshot","value","undefined","lol","forEach","retrievedValue","values","bulkGet","keys","bulkSet","retrievedValues"],"sources":["../src/index.test.ts"],"sourcesContent":["import { constant, Knifecycle } from 'knifecycle';\nimport initRedisKVService from '.';\nimport initRedisService from 'simple-redis-service';\nimport type { RedisKVService } from '.';\nimport type { RedisConfig } from 'simple-redis-service';\n\ndescribe('Redis service', () => {\n  let $: Knifecycle;\n  const log = jest.fn();\n\n  beforeEach(() => {\n    log.mockReset();\n    $ = new Knifecycle();\n    $.register(constant('ENV', {}));\n    $.register(constant('log', log));\n    $.register(\n      constant('REDIS', {\n        host: 'localhost',\n        port: 6379,\n      } as RedisConfig),\n    );\n    $.register(initRedisService);\n    $.register(initRedisKVService);\n  });\n\n  afterEach(async () => {\n    await $.destroy();\n  });\n\n  it('should init well', async () => {\n    const { log, redisKV } = (await $.run(['log', 'redisKV'])) as {\n      redisKV: RedisKVService<unknown>;\n      log: jest.Mock;\n    };\n\n    expect(typeof redisKV.get).toEqual('function');\n    expect(typeof redisKV.set).toEqual('function');\n    expect(log.mock.calls).toMatchInlineSnapshot(`\n      Array [\n        Array [\n          \"warning\",\n          \"🏧 - Redis Service initialized!\",\n        ],\n        Array [\n          \"warning\",\n          \"🏧 - Redis KV Store Service initialized!\",\n        ],\n      ]\n    `);\n  });\n\n  it('should allow to get a undefined value by its key', async () => {\n    const { redisKV } = (await $.run(['redisKV'])) as {\n      redisKV: RedisKVService<number>;\n    };\n\n    const value = await redisKV.get('lol');\n\n    expect(value).toEqual(undefined);\n  });\n\n  ['trololol', { lol: 'lol' }, 1, true].forEach((value) => {\n    it(\n      'should allow to set and get a ' + typeof value + ' by its key',\n      async () => {\n        const { redisKV } = (await $.run(['redisKV'])) as {\n          redisKV: RedisKVService<typeof value>;\n        };\n\n        await redisKV.set('lol', value);\n\n        const retrievedValue = await redisKV.get('lol');\n\n        expect(retrievedValue).toEqual(value);\n      },\n    );\n  });\n\n  it('should allow to bulk get a undefined values by their keys', async () => {\n    const { redisKV } = (await $.run(['redisKV'])) as {\n      redisKV: RedisKVService<number>;\n    };\n\n    const values = await redisKV.bulkGet(['lollolo', 'kikoolol']);\n\n    expect(values).toEqual([undefined, undefined]);\n  });\n\n  it('should allow to set and get values by their keys', async () => {\n    const keys = ['a', 'b', 'c', 'd'];\n    const values = [1, 2, undefined, 4];\n\n    const { redisKV } = (await $.run(['redisKV'])) as {\n      redisKV: RedisKVService<number>;\n    };\n\n    await redisKV.bulkSet(keys, values);\n\n    const retrievedValues = await redisKV.bulkGet(keys);\n\n    expect(retrievedValues).toEqual(values);\n  });\n});\n"],"mappings":"AAAA,SAASA,QAAT,EAAmBC,UAAnB,QAAqC,YAArC;AACA,OAAOC,kBAAP,MAA+B,GAA/B;AACA,OAAOC,gBAAP,MAA6B,sBAA7B;AAIAC,QAAQ,CAAC,eAAD,EAAkB,MAAM;EAC9B,IAAIC,CAAJ;EACA,MAAMC,GAAG,GAAGC,IAAI,CAACC,EAAL,EAAZ;EAEAC,UAAU,CAAC,MAAM;IACfH,GAAG,CAACI,SAAJ;IACAL,CAAC,GAAG,IAAIJ,UAAJ,EAAJ;IACAI,CAAC,CAACM,QAAF,CAAWX,QAAQ,CAAC,KAAD,EAAQ,EAAR,CAAnB;IACAK,CAAC,CAACM,QAAF,CAAWX,QAAQ,CAAC,KAAD,EAAQM,GAAR,CAAnB;IACAD,CAAC,CAACM,QAAF,CACEX,QAAQ,CAAC,OAAD,EAAU;MAChBY,IAAI,EAAE,WADU;MAEhBC,IAAI,EAAE;IAFU,CAAV,CADV;IAMAR,CAAC,CAACM,QAAF,CAAWR,gBAAX;IACAE,CAAC,CAACM,QAAF,CAAWT,kBAAX;EACD,CAbS,CAAV;EAeAY,SAAS,CAAC,YAAY;IACpB,MAAMT,CAAC,CAACU,OAAF,EAAN;EACD,CAFQ,CAAT;EAIAC,EAAE,CAAC,kBAAD,EAAqB,YAAY;IACjC,MAAM;MAAEV,GAAF;MAAOW;IAAP,IAAoB,MAAMZ,CAAC,CAACa,GAAF,CAAM,CAAC,KAAD,EAAQ,SAAR,CAAN,CAAhC;IAKAC,MAAM,CAAC,OAAOF,OAAO,CAACG,GAAhB,CAAN,CAA2BC,OAA3B,CAAmC,UAAnC;IACAF,MAAM,CAAC,OAAOF,OAAO,CAACK,GAAhB,CAAN,CAA2BD,OAA3B,CAAmC,UAAnC;IACAF,MAAM,CAACb,GAAG,CAACiB,IAAJ,CAASC,KAAV,CAAN,CAAuBC,qBAAvB,CAA8C;AAClD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAXI;EAYD,CApBC,CAAF;EAsBAT,EAAE,CAAC,kDAAD,EAAqD,YAAY;IACjE,MAAM;MAAEC;IAAF,IAAe,MAAMZ,CAAC,CAACa,GAAF,CAAM,CAAC,SAAD,CAAN,CAA3B;IAIA,MAAMQ,KAAK,GAAG,MAAMT,OAAO,CAACG,GAAR,CAAY,KAAZ,CAApB;IAEAD,MAAM,CAACO,KAAD,CAAN,CAAcL,OAAd,CAAsBM,SAAtB;EACD,CARC,CAAF;EAUA,CAAC,UAAD,EAAa;IAAEC,GAAG,EAAE;EAAP,CAAb,EAA6B,CAA7B,EAAgC,IAAhC,EAAsCC,OAAtC,CAA+CH,KAAD,IAAW;IACvDV,EAAE,CACA,mCAAmC,OAAOU,KAA1C,GAAkD,aADlD,EAEA,YAAY;MACV,MAAM;QAAET;MAAF,IAAe,MAAMZ,CAAC,CAACa,GAAF,CAAM,CAAC,SAAD,CAAN,CAA3B;MAIA,MAAMD,OAAO,CAACK,GAAR,CAAY,KAAZ,EAAmBI,KAAnB,CAAN;MAEA,MAAMI,cAAc,GAAG,MAAMb,OAAO,CAACG,GAAR,CAAY,KAAZ,CAA7B;MAEAD,MAAM,CAACW,cAAD,CAAN,CAAuBT,OAAvB,CAA+BK,KAA/B;IACD,CAZD,CAAF;EAcD,CAfD;EAiBAV,EAAE,CAAC,2DAAD,EAA8D,YAAY;IAC1E,MAAM;MAAEC;IAAF,IAAe,MAAMZ,CAAC,CAACa,GAAF,CAAM,CAAC,SAAD,CAAN,CAA3B;IAIA,MAAMa,MAAM,GAAG,MAAMd,OAAO,CAACe,OAAR,CAAgB,CAAC,SAAD,EAAY,UAAZ,CAAhB,CAArB;IAEAb,MAAM,CAACY,MAAD,CAAN,CAAeV,OAAf,CAAuB,CAACM,SAAD,EAAYA,SAAZ,CAAvB;EACD,CARC,CAAF;EAUAX,EAAE,CAAC,kDAAD,EAAqD,YAAY;IACjE,MAAMiB,IAAI,GAAG,CAAC,GAAD,EAAM,GAAN,EAAW,GAAX,EAAgB,GAAhB,CAAb;IACA,MAAMF,MAAM,GAAG,CAAC,CAAD,EAAI,CAAJ,EAAOJ,SAAP,EAAkB,CAAlB,CAAf;IAEA,MAAM;MAAEV;IAAF,IAAe,MAAMZ,CAAC,CAACa,GAAF,CAAM,CAAC,SAAD,CAAN,CAA3B;IAIA,MAAMD,OAAO,CAACiB,OAAR,CAAgBD,IAAhB,EAAsBF,MAAtB,CAAN;IAEA,MAAMI,eAAe,GAAG,MAAMlB,OAAO,CAACe,OAAR,CAAgBC,IAAhB,CAA9B;IAEAd,MAAM,CAACgB,eAAD,CAAN,CAAwBd,OAAxB,CAAgCU,MAAhC;EACD,CAbC,CAAF;AAcD,CAhGO,CAAR"}

package/package.json

@@ -0,0 +1,243 @@
+{
+  "name": "redis-kv-store",
+  "version": "1.0.0",
+  "description": "A simple Redis based key/value store.",
+  "main": "dist/index",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "metapak": {
+    "data": {
+      "files": "'src/**/*.ts'",
+      "testsFiles": "'src/**/*.tests.ts'",
+      "distFiles": "'dist/**/*.js'",
+      "ignore": [
+        "dist"
+      ],
+      "bundleFiles": [
+        "dist",
+        "src"
+      ]
+    },
+    "configs": [
+      "main",
+      "readme",
+      "eslint",
+      "babel",
+      "typescript",
+      "jest",
+      "jsdocs",
+      "jsarch",
+      "codeclimate"
+    ]
+  },
+  "scripts": {
+    "architecture": "jsarch 'src/**/*.ts' > ARCHITECTURE.md && git add ARCHITECTURE.md",
+    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s && git add CHANGELOG.md",
+    "cli": "env NODE_ENV=${NODE_ENV:-cli}",
+    "compile": "rimraf -f 'dist' && npm run compile:cjs && npm run compile:mjs",
+    "compile:cjs": "babel --env-name=cjs --out-dir=dist --extensions '.ts,.js' --source-maps=true src",
+    "compile:mjs": "babel --env-name=mjs --out-file-extension=.mjs --out-dir=dist --extensions '.ts,.js' --source-maps=true src",
+    "cover": "npm run jest -- --coverage",
+    "coveralls": "npm run cover && cat ./coverage/lcov.info | coveralls && rm -rf ./coverage",
+    "cz": "env NODE_ENV=${NODE_ENV:-cli} git cz",
+    "doc": "echo \"# API\" > API.md; jsdoc2md 'dist/**/*.js' >> API.md && git add API.md",
+    "jest": "NODE_ENV=test jest",
+    "lint": "eslint 'src/**/*.ts'",
+    "metapak": "metapak",
+    "precz": "npm run compile && npm run types && npm run doc && npm run architecture && npm t && npm run lint && npm run metapak -- -s",
+    "prettier": "prettier --write 'src/**/*.ts'",
+    "preversion": "npm run compile && npm run types && npm run doc && npm run architecture && npm t && npm run lint && npm run metapak -- -s",
+    "test": "npm run jest",
+    "types": "rimraf -f 'dist/**/*.d.ts' && tsc --project . --declaration --emitDeclarationOnly --outDir dist",
+    "version": "npm run changelog && git add CHANGELOG.md"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nfroidure/redis-kv-store.git"
+  },
+  "author": {
+    "name": "Nicolas Froidure",
+    "email": "nicolas.froidure@insertafter.com",
+    "url": "http://insertafter.com/en/index.html"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/nfroidure/redis-kv-store/issues"
+  },
+  "homepage": "https://github.com/nfroidure/redis-kv-store#readme",
+  "dependencies": {
+    "common-services": "^10.0.2",
+    "knifecycle": "12.0.4",
+    "memory-kv-store": "^5.0.1",
+    "simple-redis-service": "^1.0.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.17.10",
+    "@babel/core": "^7.18.2",
+    "@babel/eslint-parser": "^7.18.2",
+    "@babel/plugin-proposal-class-properties": "^7.17.12",
+    "@babel/plugin-proposal-object-rest-spread": "^7.18.0",
+    "@babel/preset-env": "^7.18.2",
+    "@babel/preset-typescript": "^7.17.12",
+    "@babel/register": "^7.17.7",
+    "@types/jest": "^27.0.2",
+    "@typescript-eslint/eslint-plugin": "^5.26.0",
+    "@typescript-eslint/parser": "^5.26.0",
+    "commitizen": "^4.2.4",
+    "conventional-changelog-cli": "^2.2.2",
+    "coveralls": "^3.1.1",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^8.16.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "^28.1.0",
+    "jsarch": "^5.0.1",
+    "jsdoc-to-markdown": "^7.1.1",
+    "metapak": "^4.0.3",
+    "metapak-nfroidure": "11.2.1",
+    "prettier": "^2.6.2",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.7.2"
+  },
+  "engines": {
+    "node": ">=12.19.0"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "greenkeeper": {
+    "ignore": [
+      "commitizen",
+      "cz-conventional-changelog",
+      "conventional-changelog-cli",
+      "eslint",
+      "eslint-config-prettier",
+      "prettier",
+      "@typescript-eslint/parser",
+      "@babel/cli",
+      "@babel/core",
+      "@babel/register",
+      "@babel/preset-env",
+      "@babel/plugin-proposal-object-rest-spread",
+      "@babel/preset-typescript",
+      "@babel/plugin-proposal-class-properties",
+      "babel-eslint",
+      "babel-core",
+      "typescript",
+      "jest",
+      "coveralls",
+      "jsdoc-to-markdown",
+      "jsarch"
+    ]
+  },
+  "eslintConfig": {
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended"
+    ],
+    "parserOptions": {
+      "ecmaVersion": 2018,
+      "sourceType": "module",
+      "modules": true
+    },
+    "env": {
+      "es6": true,
+      "node": true,
+      "jest": true,
+      "mocha": true
+    },
+    "plugins": [
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": "error"
+    },
+    "parser": "@typescript-eslint/parser",
+    "ignorePatterns": [
+      "*.d.ts"
+    ]
+  },
+  "prettier": {
+    "semi": true,
+    "printWidth": 80,
+    "singleQuote": true,
+    "trailingComma": "all",
+    "proseWrap": "always"
+  },
+  "contributors": [],
+  "files": [
+    "dist",
+    "src",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "jsarch": {
+    "parserOptions": {
+      "plugins": [
+        "typescript"
+      ]
+    }
+  },
+  "jest": {
+    "coverageReporters": [
+      "lcov"
+    ],
+    "testPathIgnorePatterns": [
+      "/node_modules/"
+    ],
+    "roots": [
+      "<rootDir>/src"
+    ]
+  },
+  "babel": {
+    "plugins": [
+      "@babel/proposal-class-properties",
+      "@babel/plugin-proposal-object-rest-spread"
+    ],
+    "presets": [
+      "@babel/typescript",
+      [
+        "@babel/env",
+        {
+          "targets": {
+            "node": "12.19.0"
+          }
+        }
+      ]
+    ],
+    "env": {
+      "cjs": {
+        "presets": [
+          [
+            "@babel/env",
+            {
+              "targets": {
+                "node": "10"
+              },
+              "modules": "commonjs"
+            }
+          ]
+        ],
+        "comments": true
+      },
+      "mjs": {
+        "presets": [
+          [
+            "@babel/env",
+            {
+              "targets": {
+                "node": "12"
+              },
+              "modules": false
+            }
+          ]
+        ],
+        "comments": false
+      }
+    },
+    "sourceMaps": true
+  }
+}

package/src/index.test.ts

@@ -0,0 +1,103 @@
+import { constant, Knifecycle } from 'knifecycle';
+import initRedisKVService from '.';
+import initRedisService from 'simple-redis-service';
+import type { RedisKVService } from '.';
+import type { RedisConfig } from 'simple-redis-service';
+
+describe('Redis service', () => {
+  let $: Knifecycle;
+  const log = jest.fn();
+
+  beforeEach(() => {
+    log.mockReset();
+    $ = new Knifecycle();
+    $.register(constant('ENV', {}));
+    $.register(constant('log', log));
+    $.register(
+      constant('REDIS', {
+        host: 'localhost',
+        port: 6379,
+      } as RedisConfig),
+    );
+    $.register(initRedisService);
+    $.register(initRedisKVService);
+  });
+
+  afterEach(async () => {
+    await $.destroy();
+  });
+
+  it('should init well', async () => {
+    const { log, redisKV } = (await $.run(['log', 'redisKV'])) as {
+      redisKV: RedisKVService<unknown>;
+      log: jest.Mock;
+    };
+
+    expect(typeof redisKV.get).toEqual('function');
+    expect(typeof redisKV.set).toEqual('function');
+    expect(log.mock.calls).toMatchInlineSnapshot(`
+      Array [
+        Array [
+          "warning",
+          "🏧 - Redis Service initialized!",
+        ],
+        Array [
+          "warning",
+          "🏧 - Redis KV Store Service initialized!",
+        ],
+      ]
+    `);
+  });
+
+  it('should allow to get a undefined value by its key', async () => {
+    const { redisKV } = (await $.run(['redisKV'])) as {
+      redisKV: RedisKVService<number>;
+    };
+
+    const value = await redisKV.get('lol');
+
+    expect(value).toEqual(undefined);
+  });
+
+  ['trololol', { lol: 'lol' }, 1, true].forEach((value) => {
+    it(
+      'should allow to set and get a ' + typeof value + ' by its key',
+      async () => {
+        const { redisKV } = (await $.run(['redisKV'])) as {
+          redisKV: RedisKVService<typeof value>;
+        };
+
+        await redisKV.set('lol', value);
+
+        const retrievedValue = await redisKV.get('lol');
+
+        expect(retrievedValue).toEqual(value);
+      },
+    );
+  });
+
+  it('should allow to bulk get a undefined values by their keys', async () => {
+    const { redisKV } = (await $.run(['redisKV'])) as {
+      redisKV: RedisKVService<number>;
+    };
+
+    const values = await redisKV.bulkGet(['lollolo', 'kikoolol']);
+
+    expect(values).toEqual([undefined, undefined]);
+  });
+
+  it('should allow to set and get values by their keys', async () => {
+    const keys = ['a', 'b', 'c', 'd'];
+    const values = [1, 2, undefined, 4];
+
+    const { redisKV } = (await $.run(['redisKV'])) as {
+      redisKV: RedisKVService<number>;
+    };
+
+    await redisKV.bulkSet(keys, values);
+
+    const retrievedValues = await redisKV.bulkGet(keys);
+
+    expect(retrievedValues).toEqual(values);
+  });
+});

package/src/index.ts

@@ -0,0 +1,107 @@
+import { autoService } from 'knifecycle';
+import type { LogService } from 'common-services';
+import type { KVStoreService } from 'memory-kv-store';
+import type { RedisService } from 'simple-redis-service';
+
+/* Architecture Note #1: Redis Key/Value Service
+
+A `redis` based key/value service.
+*/
+
+export type RedisKVService<T> = KVStoreService<T>;
+export type RedisKVDependencies = {
+  redis: RedisService;
+  log: LogService;
+};
+
+export default autoService(initRedisKV);
+
+/**
+ * Instantiate the Redis Key/Value service
+ * @name initRedisKV
+ * @function
+ * @param  {Object}     services
+ * The services to inject
+ * @param  {Function}   services.redis
+ * A `simple-redis-service` instance
+ * @param  {Function}   services.log
+ * A logging function
+ * @return {Promise<RedisKVService>}
+ * A promise of the Redis Key Value service
+ * @example
+ * import initRedisService from 'simple-redis-service';
+ * import initRedisKV from 'redis-kv-store';
+ *
+ * const redis = await initRedisService({
+ *   REDIS: {
+ *     host: 'localhost',
+ *     port: 6379,
+ *   },
+ *   ENV: process.env,
+ *   log: console.log.bind(console),
+ * });
+ * const redisKV = await initRedisKV({
+ *   redis,
+ *   log: console.log.bind(console),
+ * });
+ *
+ * const value = await redisKV.get('my_key');
+ */
+async function initRedisKV<T>({
+  redis,
+  log,
+}: RedisKVDependencies): Promise<KVStoreService<T>> {
+  log('warning', `🏧 - Redis KV Store Service initialized!`);
+
+  const redisKV = {
+    get: async (key: string): Promise<T | undefined> => {
+      const result = await redis.get(key);
+      return castRedisResult<T>(result);
+    },
+    set: async (
+      key: string,
+      value: T | undefined,
+      ttl?: number,
+    ): Promise<void> => {
+      if (typeof ttl !== 'undefined') {
+        await redis.set(key, prepareRedisValue<T>(value), 'PX', ttl);
+      } else {
+        await redis.set(key, prepareRedisValue<T>(value));
+      }
+    },
+    delete: async (key: string): Promise<void> => {
+      await redis.del(key);
+    },
+    bulkGet: async (keys: string[]): Promise<(T | undefined)[]> => {
+      return (await redis.mget(keys)).map((result) =>
+        castRedisResult<T>(result),
+      );
+    },
+    bulkSet: async (
+      keys: string[],
+      values: (T | undefined)[],
+      ttls: number[] = [],
+    ) => {
+      await Promise.all(
+        keys.map((key, index) => {
+          const value = values[index];
+
+          return redisKV.set(key, value, ttls[index]);
+        }),
+      );
+    },
+    bulkDelete: async (keys: string[]) => {
+      await redis.del(...keys);
+    },
+  };
+
+  return redisKV;
+}
+
+function castRedisResult<T>(result: string | null | undefined): T {
+  return result == null || result === '' ? undefined : JSON.parse(result);
+}
+
+function prepareRedisValue<T>(value: T | undefined): string {
+  return value == null ? '' : JSON.stringify(value);
+}